| blob | 8eb38ef680a1086393a4481b9b9843a7ff1e719e |
1 ;;; org-table.el --- The Table Editor for Org -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2004-2018 Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: https://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 <https://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:
77 "Hook for functions attaching to `C-c C-c', if the table is sent.
78 This can be used to add additional functionality after the table is sent
79 to the receiver position, otherwise, if table is not sent, the functions
85 "Non-nil means use the optimized table editor version for `orgtbl-mode'.
87 In the optimized version, the table editor takes over all simple keys that
88 normally just insert a character. In tables, the characters are inserted
89 in a way to minimize disturbing the table structure (i.e. in overwrite mode
90 for empty fields). Outside tables, the correct binding of the keys is
91 restored.
93 Changing this variable requires a restart of Emacs to become
94 effective."
100 % END RECEIVE ORGTBL %n
102 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
103 | | |
106 @c END RECEIVE ORGTBL %n
107 @ignore
108 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
109 | | |
112 <!-- END RECEIVE ORGTBL %n -->
113 <!--
114 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
115 | | |
118 #+ END RECEIVE ORGTBL %n
120 #+ORGTBL: SEND %n orgtbl-to-orgtbl :splice nil :skip 0
121 | | |
123 "Templates for radio tables in different major modes.
124 Each template must define lines that will be treated as a comment and that
127 insertion of the template. The transformed table will later be inserted
128 between these lines.
130 The template should also contain a minimal table in a multiline comment.
131 If multiline comments are not possible in the buffer language,
132 you can pack it into a string that will not be used when the code
133 is compiled or executed. Above the table will you need a line with
135 convert the table into a data structure useful in the
136 language of the buffer. Check the manual for the section on
138 the Info node `(org)Tables in arbitrary syntax'.
140 All occurrences of %n in a template will be replaced with the name of the
141 table, obtained by prompting the user."
148 "Settings for tables in Org mode."
153 "The default size for newly created tables, Columns x Rows."
158 "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%:]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$"
159 "Regular expression for recognizing numbers in table columns.
160 If a table column contains mostly numbers, it will be aligned to the
161 right. If not, it will be aligned to the left.
163 The default value of this option is a regular expression which allows
164 anything which looks remotely like a number as used in scientific
165 context. For example, all of the following will be considered a
166 number:
167 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
169 Other options offered by the customize interface are more restrictive."
183 "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
184 (const :tag "Very General Number-Like, including hex and Calc radix, allows comma as decimal mark"
185 "^\\([<>]?[-+^.,0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
189 "Fraction of numbers in a column required to make the column align right.
190 In a column all non-white fields are considered. If at least
191 this fraction of fields is matched by `org-table-number-regexp',
192 alignment to the right border applies."
197 "Behavior of tables during editing in Org mode."
202 "Non-nil means automatically re-align table when pressing TAB or RETURN.
204 removal/insertion."
209 "Non-nil means automatically blank table field when starting to type into it.
210 This only happens when typing immediately after a field motion
211 command (TAB, S-TAB or RET)."
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."
236 "Non-nil means tab in the last column of a table with jump over a hline.
237 If a horizontal separator line is following the current line,
238 `org-table-next-field' can either create a new row before that line, or jump
239 over the line. When this option is nil, a new line will be created before
240 this line."
245 "Options concerning tables in Org mode."
250 "Non-nil means using table references like B3 instead of @3$2.
251 Possible values are:
252 nil never use them
253 from accept as input, do not present for editing
254 t accept as input and present for editing"
262 "Non-nil means increment when copying current field with \
275 calc-angle-mode deg
276 calc-prefer-frac nil
277 calc-symbolic-mode nil
279 calc-display-working-message t
280 )
281 "List with Calc mode settings for use in `calc-eval' for table formulas.
282 The list must contain alternating symbols (Calc modes variables and values).
283 Don't remove any of the default settings, just change the values. Org mode
284 relies on the variables to be present in the list."
289 "Format for the output of calc computations like $1+$2;t.
290 The default value is `hours', and will output the results as a
291 number of hours. Other allowed values are `seconds', `minutes' and
292 `days', and the output will be a fraction of seconds, minutes or
293 days. `hh:mm' selects to use hours and minutes, ignoring seconds.
294 The `U' flag in a table formula will select this specific format for
295 a single formula."
305 "Non-nil means hours in table duration computations should be zero-padded.
306 So this is about 08:32:34 versus 8:33:34."
314 "Format for fields which contain the result of a formula.
316 characters. Beware that modifying the display can prevent the
317 field from being used in another formula."
323 "Non-nil means TAB and RET evaluate a formula in current table field.
324 If the current field starts with an equal sign, it is assumed to be a formula
325 which should be evaluated as described in the manual and in the documentation
326 string of the command `org-table-eval-formula'. This feature requires the
327 Emacs calc package.
328 When this variable is nil, formula calculation is only available through
334 "Non-nil means interpret constants in formulas in tables.
335 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
336 by the value given in `org-table-formula-constants', or by a value obtained
337 from the `constants.el' package."
342 "Alist with constant names and values, for use in table formulas.
343 The car of each element is a name of a constant, without the `$' before it.
344 The cdr is the value as a string. For example, if you'd like to use the
345 speed of light in a formula, you would configure
349 and then use it in an equation like `$1*$c'.
351 Constants can also be defined on a per-file basis using a line like
353 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
360 "Non-nil means lines marked with |#| or |*| will be recomputed automatically.
363 are pressed in the line."
368 "Non-nil means relative formula references may cross hlines.
369 Here are the allowed values:
371 nil Relative references may not cross hlines. They will reference the
372 field next to the hline instead. Coming from below, the reference
373 will be to the field below the hline. Coming from above, it will be
374 to the field above.
375 t Relative references may cross hlines.
376 error An attempt to cross a hline will throw an error.
378 It is probably good to never set this variable to nil, for the sake of
379 portability of tables."
387 "Non-nil means evaluation of formula can add new columns.
388 When non-nil, evaluating an out-of-bounds field can insert as
389 many columns as needed. When set to `warn', issue a warning when
390 doing so. When set to `prompt', ask user before creating a new
391 column. Otherwise, throw an error."
402 "Options concerning table import and export in Org mode."
407 "Default export parameters for `org-table-export'.
408 These can be overridden for a specific table by setting the
409 TABLE_EXPORT_FORMAT property. See the manual section on orgtbl
410 radio tables for the different export transformations and
411 available parameters."
416 "Max lines that `org-table-convert-region' will attempt to process.
418 The function can be slow on larger regions; this safety feature
419 prevents it from hanging emacs."
426 "String to be displayed in a shrunk column."
450 "Alist with column names, derived from the `!' line.
454 "Regular expression matching the current column names.
458 "Alist with parameter names, derived from the `$' line.
462 "Alist with locations of named fields.
463 Associations follow the pattern (NAME LINE COLUMN) where
464 NAME is the name of the field as a string,
465 LINE is the number of lines from the beginning of the table,
466 COLUMN is the column of the field, as an integer.
470 "Table row types in current table.
474 "Current table begin position, as a marker.
478 "Number of columns in current table.
482 "Vector of data line line numbers in the current table.
483 Line numbers are counted from the beginning of the table. This
487 "Vector of hline line numbers in the current table.
488 Line numbers are counted from the beginning of the table. This
492 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
493 ;; 1 2 3 4 5
509 "Space used around fields when aligning the table.
510 This space serves as a segment separator for the purposes of the
514 "Save current field; execute BODY; restore field.
515 Field is restored even in case of abnormal exit."
526 ;;; See org-macs.el for the definition of org-table-with-shrunk-field,
527 ;;; including the reason why it is defined there and not here.
530 "Expand all columns before executing BODY, then shrink them again."
543 ;;;###autoload
545 "Use the table.el package to insert a new table.
546 If there is already a table at point, convert between Org tables
547 and table.el tables."
560 ;;;###autoload
562 "Convert region to table, or create an empty table.
563 If there is an active region, convert it to a table, using the function
564 `org-table-convert-region'. See the documentation of that function
565 to learn how the prefix argument is interpreted to determine the field
566 separator.
567 If there is no such region, create an empty table with `org-table-create'."
573 ;;;###autoload
575 "Query for a size and insert a table skeleton.
595 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
599 ;; Insert a hline after the first row.
605 ;;;###autoload
607 "Convert region to a table.
609 The region goes from BEG0 to END0, but these borders will be moved
610 slightly, to make sure a beginning of line in the first line is included.
612 SEPARATOR specifies the field separator in the lines. It can have the
613 following values:
615 (4) Use the comma as a field separator
616 (16) Use a TAB as field separator
617 (64) Prompt for a regular expression as field separator
618 integer When a number, use that many spaces, or a TAB, as field separator
619 regexp When a regular expression, use it to match the separator
620 nil When nil, the command tries to be smart and figure out the
621 separator in the following way:
622 - when each line contains a TAB, assume TAB-separated material
623 - when each line contains a comma, assume CSV material
624 - else, assume one or more SPACE characters as separator."
628 re)
630 (user-error "Region is longer than `org-table-convert-region-max-lines' (%s) lines; not converting"
631 org-table-convert-region-max-lines)
640 ;; Get the right field separator
651 ;; parse the csv stuff
676 ;;;###autoload
678 "Import FILE as a table.
680 The command tries to be smart and figure out the separator in the
681 following way:
683 - when each line contains a TAB, assume TAB-separated material
684 - when each line contains a comma, assume CSV material
685 - else, assume one or more SPACE characters as separator.
687 When non-nil, SEPARATOR specifies the field separator in the
688 lines. It can have the following values:
690 (4) Use the comma as a field separator
691 (16) Use a TAB as field separator
692 (64) Prompt for a regular expression as field separator
693 integer When a number, use that many spaces, or a TAB, as field separator
694 regexp When a regular expression, use it to match the separator."
703 ;;;###autoload
705 "Export table to a file, with configurable format.
706 Such a file can be imported into usual spreadsheet programs.
708 FILE can be the output file name. If not given, it will be taken
709 from a TABLE_EXPORT_FILE property in the current entry or higher
710 up in the hierarchy, or the user will be prompted for a file
711 name. FORMAT can be an export format, of the same kind as it
712 used when `orgtbl-mode' sends a table in a different format.
714 The command suggests a format depending on TABLE_EXPORT_FORMAT,
715 whether it is set locally or up in the hierarchy, then on the
716 extension of the given file name, and finally on the variable
717 `org-table-export-default-format'."
750 formats)))
751 org-table-export-default-format)
777 "Marker at the beginning of the table last aligned.
780 "Marker at the end of the table last aligned.
783 "List of flags for flushright alignment, from the last re-alignment.
786 "List of max width of fields in each column.
789 "Non-nil means debug table formulas.
797 "Format FIELD according to column WIDTH and alignement ALIGN.
807 prefix
808 field
809 suffix
810 org-table-separator-space)))
812 ;;;###autoload
814 "Align the table at point by aligning all vertical bars."
819 ;; Make sure invisible characters in the table are at the right
820 ;; place since column widths take them into account.
827 ;; Table's rows as lists of fields. Rules are replaced
828 ;; by nil. Trailing spaces are removed.
834 ;; Compute number of columns. If the table contains no
835 ;; field, create a default table and bail out.
843 ;; Compute alignment and width for each column.
865 alignments)))
868 ;; Store alignment of this table, for later editing of single
869 ;; fields.
872 ;; Build new table rows. Only replace rows that actually
873 ;; changed.
878 indent
881 widths
890 cells
891 widths
892 alignments)
902 ;;;###autoload
904 "Find the beginning of the table and return its position.
905 With a non-nil optional argument TABLE-TYPE, return the beginning
906 of a table.el-type table. This function assumes point is on
907 a table."
915 ;;;###autoload
917 "Find the end of the table and return its position.
918 With a non-nil optional argument TABLE-TYPE, return the end of
919 a table.el-type table. This function assumes point is on
920 a table."
928 ;; When the line right after the table is the last line in
929 ;; the buffer with trailing spaces but no final newline
930 ;; character, be sure to catch the correct ending at its
931 ;; beginning. In any other case, ending is expected to be
932 ;; at point max.
937 ;;;###autoload
939 "Justify the current field, text to left, number to right.
940 Optional argument NEW may specify text to replace the current field content."
949 ;; This is not the same table, force a full re-align.
952 ;; Realign the current field, based on previous full realign.
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)
1041 "Move to the beginning of the current table field.
1042 If already at or before the beginning, move to the beginning of the
1043 previous field.
1044 With numeric argument N, move N-1 fields backward first."
1057 "Move to the end of the current table field.
1058 If already at or after the end, move to the end of the next table field.
1059 With numeric argument N, move N-1 fields forward first."
1072 ;;;###autoload
1074 "Go to the next row (same column) in the current table.
1075 Before doing so, re-align the table if necessary."
1080 org-table-may-need-update)
1092 ;;;###autoload
1094 "Copy the value of the current field one row below.
1096 If the field at the cursor is empty, copy the content of the
1097 nearest non-empty field above. With argument N, use the Nth
1098 non-empty field.
1100 If the current field is not empty, it is copied down to the next
1101 row, and the cursor is moved with it. Therefore, repeating this
1102 command causes the column to be filled row-by-row.
1104 If the variable `org-table-copy-increment' is non-nil and the
1105 field is an integer or a timestamp, it will be incremented while
1106 copying. By default, increment by the difference between the
1107 value in the current field and the one in the field above. To
1108 increment using a fixed integer, set `org-table-copy-increment'
1109 to a number. In the case of a timestamp, increment by days."
1121 txt txt-up inc)
1129 beg t))
1139 beg t))
1146 ;; Above field was not empty, go down to the next row. Skip
1147 ;; alignment since we do it at the end of the process anyway.
1180 "Non-nil when point is inside a table data field.
1181 Raise an error otherwise, unless NOERROR is non-nil. In that
1182 case, return nil if point is not inside a data field. When
1183 optional argument ASSUME-TABLE is non-nil, assume point is within
1184 a table."
1196 "Get the field in table line LINE, column COLUMN.
1197 If LINE is larger than the number of data lines in the table, the function
1198 returns nil. However, if COLUMN is too large, we will simply return an
1199 empty string.
1200 If LINE is nil, use the current line.
1201 If COLUMN is nil, use the current column."
1208 "Put VALUE into line LINE, column COLUMN.
1209 When ALIGN is set, also realign the table."
1218 "Return the index of the current data line."
1225 cnt))
1228 "Go to the Nth data line in the current table.
1229 Return t when the line exists, nil if it does not exist."
1236 ;;;###autoload
1238 "Blank the current table field or active region."
1255 "Return the value of the field in column N of current row.
1256 N defaults to current column. If REPLACE is a string, replace
1257 field with this value. The return value is always the old
1258 value."
1262 ;; Before first column or after last one.
1263 ""
1271 val)))
1273 ;;;###autoload
1275 "Show info about the current field, and highlight any reference at point."
1285 col)
1286 org-table-named-field-locations)))
1296 ;; Prioritize field formulas over column formulas.
1305 dline col
1307 dline col ref1
1309 ;; FIXME: formula info not correct if special table line
1316 ""
1322 "Return current column number."
1331 column)))))
1334 "Find out what table data line we are in.
1335 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."
1385 ;; Add missing vertical bar at the end of the row.
1392 ;; Shift appropriately stored shrunk column numbers, then hide the
1393 ;; columns again.
1395 shrunk-columns)
1396 beg end)
1398 ;; Fix TBLFM formulas, if desirable.
1405 "Find a data line in the current table, which is needed for column commands.
1406 This function assumes point is in a table. Raise an error when
1407 there is no data row below."
1417 t)))
1420 "Turn a buffer line number into a data line number.
1422 If there is no data line in this line, return nil.
1424 If there is no matching dline (most likely the reference was
1425 a hline), the first dline below it is used. When ABOVE is
1426 non-nil, the one above is used."
1431 nil)
1445 ;;;###autoload
1447 "Delete a column from the table."
1461 nil
1468 ;; Shift appropriately stored shrunk column numbers, then hide the
1469 ;; columns again.
1471 shrunk-columns)
1472 beg end)
1474 ;; Fix TBLFM formulas, if desirable.
1482 ;;;###autoload
1484 "Move column to the right."
1488 ;;;###autoload
1490 "Move column to the left."
1494 ;;;###autoload
1496 "Move the current column to the right. With arg LEFT, move to the left."
1524 ;; Shift appropriately stored shrunk column numbers, then shrink
1525 ;; the columns again.
1533 shrunk-columns)
1534 beg end)
1536 ;; Fix TBLFM formulas, if desirable.
1547 ;;;###autoload
1549 "Move table row down."
1553 ;;;###autoload
1555 "Move table row up."
1559 ;;;###autoload
1561 "Move the current table line down. With arg UP, move it up."
1570 hline2p)
1597 ;;;###autoload
1599 "Insert a new row above the current line into the table.
1600 With prefix ARG, insert below the current line."
1606 ;; Fix the first field if necessary
1610 ;; Buffer may not end of a newline character, so ensure
1611 ;; (beginning-of-line 2) moves point to a new line.
1622 ;;;###autoload
1624 "Insert a horizontal-line below the current line into the table.
1625 With prefix ABOVE, insert above the current line."
1646 ;;;###autoload
1648 "Insert a hline and move to the row below that line."
1662 In particular, this does handle wide and invisible characters."
1664 ;; It's a hline, just map the characters
1670 t t s)))
1671 s))
1673 ;;;###autoload
1675 "Delete the current row or horizontal line from the table."
1691 ;;;###autoload
1694 "Sort table lines according to the column at point.
1696 The position of point indicates the column to be used for
1697 sorting, and the range of lines is the range between the nearest
1698 horizontal separator lines, or the entire table of no such lines
1699 exist. If point is before the first column, you will be prompted
1700 for the sorting column. If there is an active region, the mark
1701 specifies the first line and the sorting column, while point
1702 should be in the last line to be included into the sorting.
1704 The command then prompts for the sorting type which can be
1705 alphabetically, numerically, or by time (as given in a time stamp
1706 in the field, or as a HH:MM value). Sorting in reverse order is
1707 also possible.
1709 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive
1710 if the locale allows for it.
1712 If SORTING-TYPE is specified when this function is called from a Lisp
1713 program, no prompting will take place. SORTING-TYPE must be a character,
1714 any of (?a ?A ?n ?N ?t ?T ?f ?F) where the capital letters indicate that
1715 sorting should be done in reverse order.
1717 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
1718 a function to be called to extract the key. It must return a value
1719 that is compatible with COMPARE-FUNC, the function used to compare
1720 entries.
1722 A non-nil value for INTERACTIVE? is used to signal that this
1723 function is being called interactively."
1726 ;; Point must be either within a field or before a data line.
1731 ;; Set appropriate case sensitivity and column used for sorting.
1744 ;; Narrow buffer to appropriate sorting area.
1755 start))
1758 end)))
1759 ;; Determine arguments for `sort-subr'. Also record original
1760 ;; position. `org-table-save-field' cannot help here since
1761 ;; sorting is too much destructive.
1766 ;; Function to be called on the contents of the field
1767 ;; used for sorting in the current row.
1795 "Function for comparing keys (empty for default \
1796 `sort-subr' predicate): "
1806 #'end-of-line
1810 nil
1811 predicate)
1812 ;; Hide all columns but the one being sorted.
1814 ;; Move back to initial field.
1818 ;;;###autoload
1820 "Copy region in table to the clipboard and blank all relevant fields.
1821 If there is no active region, use just the field at point."
1827 ;;;###autoload
1829 "Copy rectangular region in table to clipboard.
1830 A special clipboard is used which can only be accessed with
1831 `org-table-paste-rectangle'. Return the region copied, as a list
1832 of lists of fields."
1836 current-prefix-arg))
1841 region)
1853 ;; Collect every cell between COLUMN-START and COLUMN-END.
1865 ;;;###autoload
1867 "Paste a rectangular region into a table.
1868 The upper right corner ends up in the current field. All involved fields
1869 will be overwritten. If the rectangle does not fit into the present table,
1870 the table is enlarged as needed. The process ignores horizontal separator
1871 lines."
1881 ;; If we left the table, create a new row.
1893 ;;;###autoload
1895 "Convert from `org-mode' table to table.el and back.
1896 Obviously, this only works within limits. When an Org table is converted
1897 to table.el, all horizontal separator lines get lost, because table.el uses
1898 these as cell boundaries and has no notion of horizontal lines. A table.el
1899 table can be converted to an Org table only if it does not do row or column
1900 spanning. Multiline cells will become multiple cells. Beware, Org mode
1901 does not test if the table can be successfully converted - it blindly
1902 applies a recipe that works for simple tables."
1906 ;; convert to Org 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
1990 used to change the number of desired lines. For example, \
1992 formats the selected text to two lines. If the region was longer than two
1993 lines, the remaining lines remain empty. A negative prefix argument reduces
1994 the current number of lines by that amount. The wrapped text is pasted back
1995 into the table. If you formatted it to more lines than it was before, fields
1996 further down in the table get overwritten - so you might need to make space in
1997 the table first.
1999 If there is no region, the current field is split at the cursor position and
2000 the text fragment to the right of the cursor is prepended to the field one
2001 line down.
2003 If there is no region, but you specify a prefix ARG, the current field gets
2004 blank, and the content is appended to the field above."
2008 ;; There is a region: fill as a paragraph.
2019 nil
2020 nlines))))
2023 ;; No region, split the current field at point.
2048 ;;;###autoload
2050 "Edit table field in a different window.
2051 This is mainly useful for fields that contain hidden parts.
2054 visible so that it can be edited in place.
2057 toggle `org-table-follow-field-mode'."
2079 p)
2101 "Finish editing a table data field.
2102 Remove all newline characters, insert the result into the table, realign
2103 the table and kill the editing buffer."
2107 text)
2124 "Minor mode to make the table field editor window follow the cursor.
2125 When this mode is active, the field editor window will always show the
2126 current field. The mode exits automatically when the cursor leaves the
2127 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
2128 nil " TblFollow" nil
2144 ;; We have left the table, exit the follow mode
2154 ;;;###autoload
2156 "Sum numbers in region of current table column.
2157 The result will be displayed in the echo area, and will be available
2160 If there is an active region, it is interpreted as a rectangle and all
2161 numbers in that rectangle will be summed. If there is no active
2162 region and point is located in a table column, sum all numbers in that
2163 column.
2165 If at least one number looks like a time HH:MM or HH:MM:SS, all other
2166 numbers are assumed to be times as well (in decimal hours) and the
2167 numbers are added as such.
2169 If NLAST is a number, only the NLAST fields will actually be summed."
2196 items1)))
2203 s diff)
2210 sres))))
2233 "Return the formula active for the current field.
2235 Assumes that table is already analyzed. If KEY is given, return
2236 the key to this formula. Otherwise return the formula preceded
2245 org-table-named-field-locations)))
2259 "Read a formula from the minibuffer, offer stored formula as default.
2260 When NAMED is non-nil, look for a named equation."
2265 org-table-named-field-locations)))
2278 stored)
2287 mustsave)
2289 ;; Remove formula.
2296 ;; We set the column equation, delete the named one.
2298 mustsave t))
2304 eq))
2307 "Store the list of formulas below the current table.
2308 If optional argument LOCATION is a buffer position, insert it at
2309 LOCATION instead."
2317 ;; Don't overwrite TBLFM, we might use text properties to
2318 ;; store stuff.
2332 ;; Fake a high number to make sure this is sorted at the end.
2339 a)
2349 "Compare two formulas for sorting."
2354 ;;;###autoload
2356 "Return an alist with the stored formulas directly after current table.
2357 By default, only return active formulas, i.e., formulas located
2358 on the first line after the table. However, if optional argument
2359 LOCATION is a buffer position, consider the formulas there."
2368 eq-alist seen)
2372 string)
2377 ;; Is it a column reference?
2379 ;; Since named columns are not possible in
2380 ;; LHS, assume this is a named field.
2388 "Double definition `%s=' in TBLFM line, please fix by hand"
2389 lhs)
2394 "Double definition `%s=' in TBLFM line, please fix by hand"
2395 lhs)))))))))))
2398 "Modify the equations after the table structure has been edited.
2400 For all numbers larger than LIMIT, shift them by DELTA."
2412 s n a)
2418 "Change makes TBLFM term %s invalid, use undo to recover"
2433 ;;;###autoload
2436 If yes, store the formula and apply it."
2437 ;; We already know we are in a table. Get field will only return a formula
2438 ;; when appropriate. It might return a separator line, but no problem.
2441 named eq)
2449 "List of commands triggering the recalculation of a line.
2461 ;;;###autoload
2463 "Rotate the recalculation mark in the first column.
2464 If in any row, the first field is not consistent with a mark,
2465 insert a new column for the markers.
2466 When there is an active region, change all the lines in the region,
2467 after prompting for the marking character.
2468 After each change, a message will be displayed indicating the meaning
2469 of the new mark."
2485 newchar))
2493 newchar))
2511 ;; Rotate mark in first row.
2513 ;; Rotate marks in additional rows if a region is active.
2521 ;; Only align if rotation actually changed lines' length.
2531 ;;;###autoload
2533 "Analyze table at point and store results.
2535 This function sets up the following dynamically scoped variables:
2537 `org-table-column-name-regexp',
2538 `org-table-column-names',
2539 `org-table-current-begin-pos',
2540 `org-table-current-line-types',
2541 `org-table-current-ncol',
2542 `org-table-dlines',
2543 `org-table-hlines',
2544 `org-table-local-parameters',
2545 `org-table-named-field-locations'."
2550 ;; Extract column names.
2563 ;; Extract local parameters.
2571 org-table-local-parameters)))))
2572 ;; Update named fields locations. We minimize `count-lines'
2573 ;; processing by storing last known number of lines in LAST.
2595 field))
2598 org-table-named-field-locations))))))))))
2599 ;; Re-use existing markers when possible.
2603 ;; Analyze the line types.
2614 ;; Get the number of columns from the first data line in table.
2622 al al2)
2636 "Move point to a specific field in the current table.
2638 REF is either the name of a field its absolute reference, as
2639 a string. No column is created unless CREATE-COLUMN-P is
2640 non-nil. If it is a function, it is called with the column
2641 number as its argument as is used as a predicate to know if the
2642 column can be created.
2644 This function assumes the table is already analyzed (i.e., using
2645 `org-table-analyze')."
2660 create-column-p)))
2666 ;;;###autoload
2668 "Recompute the current line if marked for it, and if we haven't just done it."
2688 org-tbl-calc-modes)
2690 ;;;###autoload
2692 suppress-align suppress-const
2693 suppress-store suppress-analysis)
2694 "Replace the table field value at the cursor by the result of a calculation.
2696 In a table, this command replaces the value in the current field with the
2698 formula, by storing it in a special line below the table. When called
2700 field formula.
2703 insert the active equation for the field
2704 back into the current field, so that it can be edited there. This is \
2705 useful
2707 check the referenced fields.
2709 When called, the command first prompts for a formula, which is read in
2710 the minibuffer. Previously entered formulas are available through the
2711 history list, and the last used formula is offered as a default.
2712 These stored formulas are adapted correctly when moving, inserting, or
2713 deleting columns with the corresponding commands.
2715 The formula can be any algebraic expression understood by the Calc package.
2716 For details, see the Org mode manual.
2718 This function can also be called from Lisp programs and offers
2719 additional arguments: EQUATION can be the formula to apply. If this
2720 argument is given, the user will not be prompted.
2722 SUPPRESS-ALIGN is used to speed-up recursive calls by by-passing
2723 unnecessary aligns.
2725 SUPPRESS-CONST suppresses the interpretation of constants in the
2726 formula, assuming that this has been done already outside the
2727 function.
2729 SUPPRESS-STORE means the formula should not be stored, either
2730 because it is already stored, or because it is a modified
2731 equation that should not overwrite the stored one.
2733 SUPPRESS-ANALYSIS prevents analyzing the table and checking
2734 location of point."
2750 equation
2756 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2757 duration duration-output-format)
2758 ;; Parse the format string. Since we have a lot of modes, this is
2759 ;; a lot of work. However, I think calc still uses most of the time.
2772 'calc-float-format
2775 n))))
2780 duration-output-format
2809 ;; replace fields with duration values if relevant
2813 fields)))
2819 x))
2820 fields)))
2826 ;; Insert row and column number of formula result field
2837 t t form)))
2839 ;; Check for old vertical references
2841 ;; Insert remote references
2854 rmtrng))
2855 keep-empty numbers lispp))
2856 t t form)))
2857 ;; Insert complex ranges
2867 ;; possibly handle durations
2872 formrg)
2873 keep-empty numbers lispp)))
2878 ;; Insert simple ranges, i.e. included in the current row.
2881 form)
2892 keep-empty numbers lispp))
2893 t t form)))
2895 ;; Insert the references to fields in same row
2902 x keep-empty numbers lispp)))
2919 ;; Use <...> time-stamps so that Calc can handle them.
2922 ;; Internationalize local time-stamps by setting locale to
2923 ;; "C".
2926 org-ts-regexp
2934 form t t))
2937 form
2944 duration-output-format)
2945 ev)))
2950 Orig: %s
2951 $xyz-> %s
2952 @r$c-> %s
2975 ;; Replace any active time stamp in the result with
2976 ;; an inactive one. Dates in tables are likely
2977 ;; piece of regular data, not meant to appear in the
2978 ;; agenda.
2991 prop value)))
2994 "Get a calc vector from a column, according to descriptor DESC.
2996 Optional arguments TBEG and COL can give the beginning of the table and
2997 the current column, to avoid unnecessary parsing.
2999 HIGHLIGHT means just highlight the range.
3001 When CORNERS-ONLY is set, only return the corners of the range as
3002 a list (line1 column1 line2 column2) where line1 and line2 are
3003 line numbers relative to beginning of table, or TBEG, and column1
3004 and column2 are table column numbers."
3007 desc))
3018 thisline)))
3023 thisline)))
3035 ;; Just one field.
3042 ;; A range, return a vector. First sort the numbers to get
3043 ;; a regular rectangle.
3049 ;; Copy the range values into a list.
3064 ;; Return string representation of calc vector.
3070 "Return relative line number corresponding to descriptor DESC.
3071 The cursor is currently in relative line number CLINE."
3076 ;; 1 2 3 4 5 6
3077 desc))
3099 cline)))
3102 "Return relative line of Nth row with type TYPE.
3103 Search starts from relative line I. When BACKWARDS in non-nil,
3104 look before I. When RELATIVE is non-nil, the reference is
3105 relative. DESC is the original descriptor that started the
3106 search, as a string."
3114 ;; We are going to cross a hline. Check if this is
3115 ;; an authorized move.
3126 ;; The last hline doesn't exist. Instead, point to last row
3127 ;; in table.
3136 "Convert list ELEMENTS to something appropriate to insert into formula.
3137 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
3138 NUMBERS indicates that everything should be converted to numbers.
3139 LISPP non-nil means to return something appropriate for a Lisp
3140 list, `literal' is for the format specifier L."
3141 ;; Calc nan (not a number) is used for the conversion of the empty
3142 ;; field to a reference for several reasons: (i) It is accepted in a
3143 ;; Calc formula (e. g. "" or "()" would result in a Calc error).
3144 ;; (ii) In a single field (not in range) it can be distinguished
3145 ;; from "(nan)" which is the reference made from a single field
3146 ;; containing "nan".
3148 ;; field reference
3151 elements
3153 ""
3162 ;; range reference
3167 elements))))
3173 x
3181 x)
3183 elements
3187 "If there has been more than one second since T1, display message.
3188 ARGS are passed as arguments to the `message' function. Returns
3189 current time if a message is printed, otherwise returns T1. If
3190 T1 is nil, always messages."
3194 curtime)
3195 t1)))
3197 ;;;###autoload
3199 "Recalculate the current table line by applying all stored formulas.
3201 With prefix arg ALL, do this for all lines in the table.
3204 if ALL is the symbol `iterate',
3205 recompute the table until it no longer changes.
3207 If NOALIGN is not nil, do not re-align the table after the computations
3208 are done. This is typically used internally to save time, if it is
3209 known that the table will be realigned a little later anyway."
3224 beg end eqlcol eqlfield)
3225 ;; Insert constants in all formulas.
3228 ;; Expand equations, then split the equation list between
3229 ;; column formulas and field formulas.
3241 old-lhs)))
3244 existing formula for column %s"
3245 old-lhs
3246 new))
3247 new))
3253 ;; Expand ranges in lhs of formulas
3255 ;; Get the correct line range to process.
3262 ;; This is a table with marked lines, compute selected
3263 ;; lines.
3265 ;; Move forward to the first non-header line.
3270 ;; Just leave BEG at the start of the table.
3275 ;; Mark named fields untouchable. Also check if several
3276 ;; field/range formulas try to set the same field.
3280 seen-fields)
3291 ;; Turn field coordinates associated to NAME
3292 ;; into an absolute reference.
3296 name)))
3299 reference))
3304 ;; Evaluate the column formulas, but skip fields covered by
3305 ;; field formulas.
3309 ;; Unprotected line, recalculate.
3314 log-last-time
3327 ;; Evaluate the field formulas.
3336 reference
3337 ;; Possibly create a new column, as long as
3338 ;; `org-table-formula-create-columns' allows it.
3350 t))
3357 ;; Clean up markers and internal text property.
3368 ;;;###autoload
3370 "Recalculate the table until it does not change anymore.
3371 The maximum number of iterations is 10, but you can choose a different value
3372 with the prefix ARG."
3377 thistbl)
3391 ;;;###autoload
3393 "Recalculate all tables in the current buffer."
3398 ;; Reason for separate `org-table-align': When repeating
3399 ;; (org-table-recalculate t) `org-table-may-need-update' gets in
3400 ;; the way.
3403 t)))
3405 ;;;###autoload
3407 "Iterate all tables in the buffer, to converge inter-table dependencies."
3412 c1)
3428 "Apply the #+TBLFM in the line at point to the table."
3435 ;; Insert a temporary formula at right after the table
3440 ;; Recalculate the table.
3445 ;; Delete the formula inserted temporarily.
3451 "Find the beginning of the TBLFM lines and return its position.
3452 Return nil when the beginning of TBLFM line was not found."
3459 "Expand list of formulas.
3460 If some of the RHS in the formulas are ranges or a row reference,
3461 expand them to individual field equations for each field. This
3462 function assumes the table is already analyzed (i.e., using
3463 `org-table-analyze')."
3470 ;; This just refers to one fixed field.
3473 ;; This just refers to one fixed named field.
3476 ;; Column formulas are treated specially and are not
3477 ;; expanded.
3482 rhs)
3483 res)))
3495 rhs)
3496 res))))))))))
3499 "Replace @<, @>, $<, $> with first/last row/column of the table.
3500 So @< and $< will always be replaced with @1 and $1, respectively.
3501 The advantage of these special markers are that structure editing of
3502 the table will not change them, while @1 and $1 will be modified
3503 when a line/row is swapped out of that privileged position. So for
3504 formulas that use a range of rows or columns, it may often be better
3506 borders of the table using the @< @> $< $> makers."
3509 s start)
3514 org-table-current-ncol)
3518 len
3525 s)
3528 "Replace $const with values in string F."
3533 org-table-column-name-regexp
3536 org-table-column-names))))
3537 f t t)))
3538 ;; Parameters and constants.
3542 new start))
3545 ;; When a duration is expected, convert value on the fly.
3551 v)))))
3558 "Find the value for a parameter or constant in a formula.
3559 Parameters get priority."
3590 map))
3597 "--"
3600 "--"
3601 "Shift Reference at Point"
3606 "-"
3607 "Change Test Row for Column Formulas"
3610 "--"
3615 org-table-overlay-coordinates)]
3616 "--"
3624 ;;;###autoload
3626 "Edit the formulas of the current table in a separate buffer."
3632 ;; Move point within the table before analyzing it.
3648 ;; Keep global-font-lock-mode from turning on font-lock-mode
3693 "Convert a formula from internal to user representation."
3696 s))
3699 "Convert a formula from user to internal representation."
3702 s))
3705 "Convert spreadsheet references from A7 to @7$28.
3706 Works for single references, but also for entire formulas and even the
3707 full TBLFM line."
3709 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3712 ;; format match, just advance
3717 ;; 3.e5 or something like this.
3720 ;; (member (match-string 1 s)
3721 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3722 )
3723 ;; function name, just advance
3733 t t s)))))
3734 s))
3737 "Convert spreadsheet references from to @7$28 to AB7.
3738 Works for single references, but also for entire formulas and even the
3739 full TBLFM line."
3746 t t s)))
3751 t nil s)))
3752 s)
3755 "Convert a base 26 number represented by letters into an integer.
3756 For example: AB -> 28."
3762 n))
3765 "Convert an integer into a base 26 number represented by letters.
3766 For example: 28 -> AB."
3771 s))
3774 "Convert a time string into numerical duration in seconds.
3775 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3776 If S is a string representing a number, keep this number."
3778 s
3801 "Convert a number of seconds to a time string.
3802 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3803 minutes or seconds."
3815 ;; Ignore seconds
3819 secs0)
3824 secs0)))))
3828 \f
3829 ;;; Columns shrinking
3832 "Non-nil if current field is narrowed.
3833 When non-nil, return the overlay narrowing the field."
3836 o))
3844 "List currently shrunk columns in table at point."
3846 ;; We really check shrunk columns in current row only. It could
3847 ;; be wrong if all rows do not contain the same number of columns
3848 ;; (i.e. the table is not properly aligned). As a consequence,
3849 ;; some columns may not be shrunk again upon aligning the table.
3850 ;;
3851 ;; For example, in the following table, cursor is on first row and
3852 ;; "<>" indicates a shrunk column.
3853 ;;
3854 ;; | |
3855 ;; | | <> |
3856 ;;
3857 ;; Aligning table from the first row will not shrink again the
3858 ;; second row, which was not visible initially.
3859 ;;
3860 ;; However, fixing it requires to check every row, which may be
3861 ;; slow on large tables. Moreover, the hindrance of this
3862 ;; pathological case is very limited.
3875 "Create an overlay to shrink text between START and END.
3877 Use string DISPLAY instead of the real text between the two
3878 buffer positions. FIELD is the real contents of the field, as
3879 a string, or nil. It is meant to be displayed upon moving the
3880 mouse onto the overlay.
3882 Return the overlay."
3885 ;; Removing one overlay removes all other overlays in the
3886 ;; same column.
3895 ;; Make sure overlays stays on top of table coordinates overlays.
3896 ;; See `org-table-overlay-coordinates'.
3899 o))
3902 "Shrink a table field to a specified width.
3904 WIDTH is an integer representing the number of characters to
3905 display, in addition to `org-table-shrunk-column-indicator'. START
3906 and END are, respectively, the beginning and ending positions of
3907 the field. CONTENTS is its trimmed contents, as a string, or
3908 `hline' for table rules.
3910 Real field is hidden under one or two overlays. They have the
3911 following properties:
3913 `org-overlay-type'
3915 Set to `table-column-hide'. Used to identify overlays
3916 responsible for shrinking columns in a table.
3918 `org-table-column-overlays'
3920 It is a list with the pattern (siblings . COLUMN-OVERLAYS)
3921 where COLUMN-OVERLAYS is the list of all overlays hiding the
3922 same column.
3924 Whenever the text behind or next to the overlay is modified, all
3925 the overlays in the column are deleted, effectively displaying
3926 the column again.
3928 Return a list of overlays hiding the field, or nil if field is
3929 already hidden."
3935 start end org-table-shrunk-column-indicator
3939 start end
3941 org-table-shrunk-column-indicator)
3944 ;; If the field is not empty, consider using two overlays: one for
3945 ;; the blanks at the beginning of the field, and another one at
3946 ;; the end of the field. The former ensures a shrunk field is
3947 ;; always displayed with a single white space character in front
3948 ;; of it -- e.g., so that even right-aligned fields appear to the
3949 ;; left -- and the latter cuts the field at WIDTH visible
3950 ;; characters.
3961 ;; Field is too short. Extend its size by adding
3962 ;; white space characters to the right overlay.
3965 org-table-shrunk-column-indicator)
3966 contents)
3967 ;; Find cut location so that WIDTH characters are visible.
3981 upper))
3982 end org-table-shrunk-column-indicator contents)))))
3986 "Read column selection select as a list of numbers.
3988 SELECT is a string containing column ranges, separated by white
3989 space characters, see `org-table-hide-column' for details. MAX
3990 is the maximum column number.
3992 Return value is a sorted list of numbers. Ignore any number
3993 outside of the [1;MAX] range."
4010 max))))
4013 #'<)))
4016 "Shrink COLUMNS in a table.
4017 COLUMNS is a sorted list of column numbers. BEG and END are,
4018 respectively, the beginning position and the end position of the
4019 table."
4030 ;; Move to COLUMN.
4035 ;; Extract boundaries and contents from current field.
4036 ;; Also set the column's width if we encounter a width
4037 ;; cookie for the first time.
4051 ;; Link overlays for current field to the other overlays in the
4052 ;; same column.
4059 ;;;###autoload
4061 "Shrink or expand current column in an Org table.
4063 If a width cookie specifies a width W for the column, the first
4064 W visible characters are displayed. Otherwise, the column is
4065 shrunk to a single character.
4067 When point is before the first column or after the last one, ask
4068 for the columns to shrink or expand, as a list of ranges.
4069 A column range can be one of the following patterns:
4071 N column N only
4072 N-M every column between N and M (both inclusive)
4073 N- every column between N (inclusive) and the last column
4074 -M every column between the first one and M (inclusive)
4075 - every column
4077 When optional argument ARG is a string, use it as white space
4078 separated list of column ranges.
4081 `org-table-shrink', i.e.,
4082 shrink columns with a width cookie and expand the others.
4085 prefix, expand all columns."
4090 ;; Compute an upper bound for the number of columns.
4091 ;; Nonexistent columns are ignored anyway.
4096 (`nil
4100 ;; Point is either before first column or past last
4101 ;; one. Ask for columns to operate on.
4104 max-columns)
4117 ;;;###autoload
4119 "Shrink all columns with a width cookie in the table at point.
4121 Columns without a width cookie are expanded.
4123 Optional arguments BEGIN and END, when non-nil, specify the
4124 beginning and end position of the current table."
4137 ;; Make sure invisible characters in the table are at the right
4138 ;; place since column widths take them into account.
4142 ;;;###autoload
4144 "Expand all columns in the table at point.
4145 Optional arguments BEGIN and END, when non-nil, specify the
4146 beginning and end position of the current table."
4155 \f
4156 ;;; Formula editing
4159 "Convert all references in this buffer, using FUNCTION."
4170 "Convert all references in the buffer from B3 to @3$2 and back."
4180 "Shift the reference at point one row/hline up."
4184 "Shift the reference at point one row/hline down."
4188 "Shift the reference at point one field to the left."
4192 "Shift the reference at point one field to the right."
4203 ;; A B3-like reference
4209 ;; An internal reference
4215 "Re-match the group N, and replace it with the shifted reference."
4220 t t)))
4223 "Shift a reference part REF.
4224 If DECR is set, decrease the references row/column, else increase.
4225 If HLINE is set, this may be a hline reference, it certainly is not
4226 a translation reference."
4255 "Toggle the display of coordinates in the referenced table."
4264 "Parse the buffer for formula definitions and install them.
4265 With prefix ARG, apply the new formulas to the table."
4274 eql)
4277 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
4278 nil t)
4299 "Abort editing formulas, without installing the changes."
4310 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
4351 "Show the location/value of the $ expression at point.
4352 When LOCAL is non-nil, show references for the table at point."
4362 var name e what match dest)
4366 "$1.."
4418 dest)
4444 ;; Column number.
4470 org-table-fedit-scroll-down))))
4482 "Move point to the closest data line in a table.
4483 Raise an error if the table contains no data line. Preserve
4484 column when moving point."
4492 p1
4493 p2)))
4499 "Move cursor one line up in the window showing the table."
4504 "Move cursor one line down in the window showing the table."
4509 "Move the cursor in the window showing the table.
4510 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
4535 "Add a new overlay."
4541 "Highlight rectangular region in a table.
4542 When buffer positions BEG and END are provided, use them to
4543 delimit the region to highlight. Otherwise, refer to point. Use
4544 FACE, when non-nil, for the highlight."
4576 "Remove the rectangle overlays."
4586 "Add overlays to the table at point, to show row/column coordinates."
4614 ;;;###autoload
4616 "Toggle the display of Row/Column numbers in tables."
4627 ;;;###autoload
4629 "Toggle the formula debugger in tables."
4635 ;;; The orgtbl minor mode
4637 ;; Define a minor mode which can be used in other modes in order to
4638 ;; integrate the Org table editor.
4640 ;; This is really a hack, because the Org table editor uses several
4641 ;; keys which normally belong to the major mode, for example the TAB
4642 ;; and RET keys. Here is how it works: The minor mode defines all the
4643 ;; keys necessary to operate the table editor, but wraps the commands
4644 ;; into a function which tests if the cursor is currently inside
4645 ;; a table. If that is the case, the table editor command is
4646 ;; executed. However, when any of those keys is used outside a table,
4647 ;; the function uses `key-binding' to look up if the key has an
4648 ;; associated command in another currently active keymap (minor modes,
4649 ;; major mode, global), and executes that command. There might be
4650 ;; problems if any of the keys used by the table editor is otherwise
4651 ;; used as a prefix key.
4653 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
4654 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
4655 ;; addresses this by checking explicitly for both bindings.
4657 ;; The optimized version (see variable `orgtbl-optimized') takes over
4658 ;; all keys which are bound to `self-insert-command' in the *global map*.
4659 ;; Some modes bind other commands to simple characters, for example
4660 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
4661 ;; active, this binding is ignored inside tables and replaced with a
4662 ;; modified self-insert.
4680 ;; Install it as a minor mode.
4684 ;;;###autoload
4686 "The Org mode table editor as a minor mode for use in other modes."
4691 ;; Exit without error, in case some hook functions calls this by
4692 ;; accident in Org mode.
4696 ;; Make sure we are first in minor-mode-map-alist
4698 ;; FIXME: maybe it should use emulation-mode-map-alists?
4705 auto-fill-inhibit-regexp)
4709 auto-fill-inhibit-regexp)
4710 orgtbl-line-start-regexp))
4725 "Create a function for binding in the table minor mode.
4726 FUN is the command to call inside a table. N is used to create a unique
4727 command name. KEYS are keys that should be checked in for a command
4728 to execute outside of tables."
4734 "Outside of tables, run the binding of `"
4746 keys)
4750 "Error when there is no default binding for a table key."
4755 "Setup orgtbl keymaps."
4786 elt key fun cmd)
4794 ;; Special treatment needed for TAB, RET and DEL
4807 (orgtbl-make-binding 'org-delete-backward-char 109
4813 [(tab)] "\C-i"))
4815 (org-defkey orgtbl-mode-map [backtab]
4817 [backtab] [S-iso-lefttab] [(shift tab)]
4818 [(tab)] "\C-i"))
4820 (org-defkey orgtbl-mode-map "\M-\C-m"
4821 (orgtbl-make-binding 'org-table-wrap-region 105
4822 "\M-\C-m" [(meta return)]))
4823 (org-defkey orgtbl-mode-map [(meta return)]
4824 (orgtbl-make-binding 'org-table-wrap-region 106
4825 [(meta return)] "\M-\C-m"))
4827 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4828 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4830 (when orgtbl-optimized
4831 ;; If the user wants maximum table support, we need to hijack
4832 ;; some standard editing functions
4833 (org-remap orgtbl-mode-map
4834 'self-insert-command 'orgtbl-self-insert-command
4835 'delete-char 'org-delete-char
4836 'delete-backward-char 'org-delete-backward-char)
4837 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4838 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4839 '("OrgTbl"
4840 ["Create or convert" org-table-create-or-convert-from-region
4841 :active (not (org-at-table-p)) :keys "C-c |" ]
4842 "--"
4843 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4844 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4845 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4846 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4847 "--"
4848 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4849 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4850 ["Copy Field from Above"
4851 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4852 "--"
4853 ("Column"
4854 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4855 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4856 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4857 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4858 ("Row"
4859 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4860 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4861 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4862 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4863 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4864 "--"
4865 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4866 ("Rectangle"
4867 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4868 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4869 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4870 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4871 "--"
4872 ("Radio tables"
4873 ["Insert table template" orgtbl-insert-radio-table
4874 (cl-assoc-if #'derived-mode-p orgtbl-radio-table-templates)]
4875 ["Comment/uncomment table" orgtbl-toggle-comment t])
4876 "--"
4877 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4878 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4879 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4880 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4881 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4882 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4883 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4884 ["Sum Column/Rectangle" org-table-sum
4885 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4886 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4887 ["Debug Formulas"
4888 org-table-toggle-formula-debugger :active (org-at-table-p)
4889 :keys "C-c {"
4890 :style toggle :selected org-table-formula-debug]
4891 ["Show Col/Row Numbers"
4892 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4893 :keys "C-c }"
4894 :style toggle :selected org-table-overlay-coordinates]
4895 "--"
4896 ("Plot"
4899 t))
4901 (defun orgtbl-ctrl-c-ctrl-c (arg)
4902 "If the cursor is inside a table, realign the table.
4903 If it is a table to be sent away to a receiver, do it.
4904 With prefix arg, also recompute table."
4905 (interactive "P")
4906 (let ((case-fold-search t) (pos (point)) action)
4907 (save-excursion
4908 (beginning-of-line 1)
4909 (setq action (cond
4913 (cond
4914 ((integerp action)
4915 (goto-char action)
4916 (org-table-maybe-eval-formula)
4917 (if arg
4918 (call-interactively 'org-table-recalculate)
4919 (org-table-maybe-recalculate-line))
4920 (call-interactively 'org-table-align)
4921 (when (orgtbl-send-table 'maybe)
4922 (run-hooks 'orgtbl-after-send-table-hook)))
4923 ((eq action 'recalc)
4924 (save-excursion
4925 (beginning-of-line 1)
4927 (if (org-at-table-p)
4928 (org-call-with-arg 'org-table-recalculate t))))
4929 (t (let (orgtbl-mode)
4930 (call-interactively (key-binding "\C-c\C-c")))))))
4932 (defun orgtbl-create-or-convert-from-region (_arg)
4933 "Create table or convert region to table, if no conflicting binding.
4934 This installs the table binding `C-c |', but only if there is no
4935 conflicting binding to this key outside orgtbl-mode."
4936 (interactive "P")
4937 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4938 (if cmd
4939 (call-interactively cmd)
4940 (call-interactively 'org-table-create-or-convert-from-region))))
4942 (defun orgtbl-tab (arg)
4943 "Justification and field motion for `orgtbl-mode'."
4944 (interactive "P")
4945 (if arg (org-table-edit-field t)
4946 (org-table-justify-field-maybe)
4947 (org-table-next-field)))
4949 (defun orgtbl-ret ()
4950 "Justification and field motion for `orgtbl-mode'."
4951 (interactive)
4952 (if (bobp)
4953 (newline)
4954 (org-table-justify-field-maybe)
4955 (org-table-next-row)))
4957 (defun orgtbl-self-insert-command (N)
4958 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4959 If the cursor is in a table looking at whitespace, the whitespace is
4960 overwritten, and the table is not marked as requiring realignment."
4961 (interactive "p")
4962 (if (and (org-at-table-p)
4963 (or
4964 (and org-table-auto-blank-field
4965 (member last-command
4966 '(orgtbl-hijacker-command-100
4967 orgtbl-hijacker-command-101
4968 orgtbl-hijacker-command-102
4969 orgtbl-hijacker-command-103
4970 orgtbl-hijacker-command-104
4971 orgtbl-hijacker-command-105
4972 yas/expand))
4973 (org-table-blank-field))
4974 t)
4975 (eq N 1)
4977 (let (org-table-may-need-update)
4978 (delete-region (match-beginning 1) (match-end 1))
4979 (self-insert-command N))
4980 (setq org-table-may-need-update t)
4981 (let* (orgtbl-mode
4982 a
4983 (cmd (or (key-binding
4984 (or (and (listp function-key-map)
4985 (setq a (assoc last-input-event function-key-map))
4986 (cdr a))
4987 (vector last-input-event)))
4988 'self-insert-command)))
4989 (call-interactively cmd)
4990 (if (and org-self-insert-cluster-for-undo
4991 (eq cmd 'self-insert-command))
4992 (if (not (eq last-command 'orgtbl-self-insert-command))
4993 (setq org-self-insert-command-undo-counter 1)
4994 (if (>= org-self-insert-command-undo-counter 20)
4995 (setq org-self-insert-command-undo-counter 1)
4996 (and (> org-self-insert-command-undo-counter 0)
4997 buffer-undo-list
4998 (not (cadr buffer-undo-list)) ; remove nil entry
4999 (setcdr buffer-undo-list (cddr buffer-undo-list)))
5000 (setq org-self-insert-command-undo-counter
5001 (1+ org-self-insert-command-undo-counter))))))))
5003 ;;;###autoload
5005 "Regular expression matching exponentials as produced by calc.")
5007 (defun orgtbl-gather-send-defs ()
5008 "Gather a plist of :name, :transform, :params for each destination before
5009 a radio table."
5010 (save-excursion
5011 (goto-char (org-table-begin))
5012 (let (rtn)
5013 (beginning-of-line 0)
5014 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
5015 (let ((name (org-no-properties (match-string 1)))
5016 (transform (intern (match-string 2)))
5017 (params (if (match-end 3)
5018 (read (concat "(" (match-string 3) ")")))))
5019 (push (list :name name :transform transform :params params)
5020 rtn)
5021 (beginning-of-line 0)))
5022 rtn)))
5024 (defun orgtbl-send-replace-tbl (name text)
5025 "Find and replace table NAME with TEXT."
5026 (save-excursion
5027 (goto-char (point-min))
5028 (let* ((location-flag nil)
5029 (name (regexp-quote name))
5032 (while (re-search-forward begin-re nil t)
5033 (unless location-flag (setq location-flag t))
5034 (let ((beg (line-beginning-position 2)))
5035 (unless (re-search-forward end-re nil t)
5036 (user-error "Cannot find end of receiver location at %d" beg))
5037 (beginning-of-line)
5038 (delete-region beg (point))
5040 (unless location-flag
5041 (user-error "No valid receiver location found in the buffer")))))
5043 ;;;###autoload
5044 (defun org-table-to-lisp (&optional txt)
5045 "Convert the table at point to a Lisp structure.
5046 The structure will be a list. Each item is either the symbol `hline'
5047 for a horizontal separator line, or a list of field values as strings.
5048 The table is taken from the parameter TXT, or from the buffer at point."
5049 (unless (or txt (org-at-table-p)) (user-error "No table at point"))
5050 (let ((txt (or txt
5051 (buffer-substring-no-properties (org-table-begin)
5052 (org-table-end)))))
5053 (mapcar (lambda (x)
5054 (if (string-match org-table-hline-regexp x) 'hline
5058 (defun orgtbl-send-table (&optional maybe)
5059 "Send a transformed version of table at point to the receiver position.
5060 With argument MAYBE, fail quietly if no transformation is defined
5061 for this table."
5062 (interactive)
5063 (catch 'exit
5064 (unless (org-at-table-p) (user-error "Not at a table"))
5065 ;; when non-interactive, we assume align has just happened.
5066 (when (called-interactively-p 'any) (org-table-align))
5067 (let ((dests (orgtbl-gather-send-defs))
5068 (table (org-table-to-lisp
5069 (buffer-substring-no-properties (org-table-begin)
5070 (org-table-end))))
5071 (ntbl 0))
5072 (unless dests
5073 (if maybe (throw 'exit nil)
5074 (user-error "Don't know how to transform this table")))
5075 (dolist (dest dests)
5076 (let ((name (plist-get dest :name))
5077 (transform (plist-get dest :transform))
5078 (params (plist-get dest :params)))
5079 (unless (fboundp transform)
5080 (user-error "No such transformation function %s" transform))
5081 (orgtbl-send-replace-tbl name (funcall transform table params)))
5082 (cl-incf ntbl))
5083 (message "Table converted and installed at %d receiver location%s"
5084 ntbl (if (> ntbl 1) "s" ""))
5085 (and (> ntbl 0) ntbl))))
5087 (defun org-remove-by-index (list indices &optional i0)
5088 "Remove the elements in LIST with indices in INDICES.
5089 First element has index 0, or I0 if given."
5090 (if (not indices)
5091 list
5092 (if (integerp indices) (setq indices (list indices)))
5093 (setq i0 (1- (or i0 0)))
5094 (delq :rm (mapcar (lambda (x)
5095 (setq i0 (1+ i0))
5096 (if (memq i0 indices) :rm x))
5097 list))))
5099 (defun orgtbl-toggle-comment ()
5100 "Comment or uncomment the orgtbl at point."
5101 (interactive)
5102 (let* ((case-fold-search t)
5103 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
5104 (re2 (concat "^" orgtbl-line-start-regexp))
5105 (commented (save-excursion (beginning-of-line 1)
5106 (cond ((looking-at re1) t)
5107 ((looking-at re2) nil)
5108 (t (user-error "Not at an org table")))))
5109 (re (if commented re1 re2))
5110 beg end)
5111 (save-excursion
5112 (beginning-of-line 1)
5113 (while (looking-at re) (beginning-of-line 0))
5114 (beginning-of-line 2)
5115 (setq beg (point))
5116 (while (looking-at re) (beginning-of-line 2))
5117 (setq end (point)))
5118 (comment-region beg end (if commented '(4) nil))))
5120 (defun orgtbl-insert-radio-table ()
5121 "Insert a radio table template appropriate for this major mode."
5122 (interactive)
5123 (let* ((e (cl-assoc-if #'derived-mode-p orgtbl-radio-table-templates))
5124 (txt (nth 1 e))
5125 name pos)
5126 (unless e (user-error "No radio table setup defined for %s" major-mode))
5127 (setq name (read-string "Table name: "))
5128 (while (string-match "%n" txt)
5129 (setq txt (replace-match name t t txt)))
5131 (setq pos (point))
5132 (insert txt)
5133 (goto-char pos)))
5135 ;;;###autoload
5136 (defun orgtbl-to-generic (table params)
5137 "Convert the orgtbl-mode TABLE to some other format.
5139 This generic routine can be used for many standard cases.
5141 TABLE is a list, each entry either the symbol `hline' for
5142 a horizontal separator line, or a list of fields for that
5143 line. PARAMS is a property list of parameters that can
5144 influence the conversion.
5146 Valid parameters are:
5148 :backend, :raw
5150 Export back-end used as a basis to transcode elements of the
5151 table, when no specific parameter applies to it. It is also
5152 used to translate cells contents. You can prevent this by
5153 setting :raw property to a non-nil value.
5155 :splice
5157 When non-nil, only convert rows, not the table itself. This is
5158 equivalent to setting to the empty string both :tstart
5159 and :tend, which see.
5161 :skip
5163 When set to an integer N, skip the first N lines of the table.
5164 Horizontal separation lines do count for this parameter!
5166 :skipcols
5168 List of columns that should be skipped. If the table has
5169 a column with calculation marks, that column is automatically
5170 discarded beforehand.
5172 :hline
5174 String to be inserted on horizontal separation lines. May be
5175 nil to ignore these lines altogether.
5177 :sep
5179 Separator between two fields, as a string.
5181 Each in the following group may be either a string or a function
5182 of no arguments returning a string:
5184 :tstart, :tend
5186 Strings to start and end the table. Ignored when :splice is t.
5188 :lstart, :lend
5190 Strings to start and end a new table line.
5192 :llstart, :llend
5194 Strings to start and end the last table line. Default,
5195 respectively, to :lstart and :lend.
5197 Each in the following group may be a string or a function of one
5198 argument (either the cells in the current row, as a list of
5199 strings, or the current cell) returning a string:
5201 :lfmt
5203 Format string for an entire row, with enough %s to capture all
5204 fields. When non-nil, :lstart, :lend, and :sep are ignored.
5206 :llfmt
5208 Format for the entire last line, defaults to :lfmt.
5210 :fmt
5212 A format to be used to wrap the field, should contain %s for
5213 the original field value. For example, to wrap everything in
5215 a property list with column numbers and format strings, or
5216 functions, e.g.,
5220 :hlstart :hllstart :hlend :hllend :hsep :hlfmt :hllfmt :hfmt
5222 Same as above, specific for the header lines in the table.
5223 All lines before the first hline are treated as header. If
5224 any of these is not present, the data line value is used.
5226 This may be either a string or a function of two arguments:
5228 :efmt
5230 Use this format to print numbers with exponential. The format
5231 should have %s twice for inserting mantissa and exponent, for
5233 list with column numbers and format strings or functions.
5234 :fmt will still be applied after :efmt."
5235 ;; Make sure `org-export-create-backend' is available.
5236 (require 'ox)
5237 (let* ((backend (plist-get params :backend))
5238 (custom-backend
5239 ;; Build a custom back-end according to PARAMS. Before
5240 ;; defining a translator, check if there is anything to do.
5241 ;; When there isn't, let BACKEND handle the element.
5242 (org-export-create-backend
5243 :parent (or backend 'org)
5244 :transcoders
5245 `((table . ,(org-table--to-generic-table params))
5246 (table-row . ,(org-table--to-generic-row params))
5247 (table-cell . ,(org-table--to-generic-cell params))
5248 ;; Macros are not going to be expanded. However, no
5249 ;; regular back-end has a transcoder for them. We
5250 ;; provide one so they are not ignored, but displayed
5251 ;; as-is instead.
5252 (macro . (lambda (m c i) (org-element-macro-interpreter m nil))))))
5253 data info)
5254 ;; Store TABLE as Org syntax in DATA. Tolerate non-string cells.
5255 ;; Initialize communication channel in INFO.
5256 (with-temp-buffer
5257 (let ((org-inhibit-startup t)) (org-mode))
5258 (let ((standard-output (current-buffer))
5259 (org-element-use-cache nil))
5260 (dolist (e table)
5262 ((consp e)
5263 (princ "| ") (dolist (c e) (princ c) (princ " |"))
5265 ;; Add back-end specific filters, but not user-defined ones. In
5266 ;; particular, make sure to call parse-tree filters on the
5267 ;; table.
5268 (setq info
5269 (let ((org-export-filters-alist nil))
5270 (org-export-install-filters
5271 (org-combine-plists
5272 (org-export-get-environment backend nil params)
5273 `(:back-end ,(org-export-get-backend backend))))))
5274 (setq data
5275 (org-export-filter-apply-functions
5276 (plist-get info :filter-parse-tree)
5277 (org-element-map (org-element-parse-buffer) 'table
5278 #'identity nil t)
5279 info)))
5280 (when (and backend (symbolp backend) (not (org-export-get-backend backend)))
5281 (user-error "Unknown :backend value"))
5282 (when (or (not backend) (plist-get info :raw)) (require 'ox-org))
5283 ;; Handle :skip parameter.
5284 (let ((skip (plist-get info :skip)))
5285 (when skip
5286 (unless (wholenump skip) (user-error "Wrong :skip value"))
5287 (let ((n 0))
5288 (org-element-map data 'table-row
5289 (lambda (row)
5290 (if (>= n skip) t
5291 (org-element-extract-element row)
5292 (cl-incf n)
5293 nil))
5294 nil t))))
5295 ;; Handle :skipcols parameter.
5296 (let ((skipcols (plist-get info :skipcols)))
5297 (when skipcols
5298 (unless (consp skipcols) (user-error "Wrong :skipcols value"))
5299 (org-element-map data 'table
5300 (lambda (table)
5301 (let ((specialp (org-export-table-has-special-column-p table)))
5302 (dolist (row (org-element-contents table))
5303 (when (eq (org-element-property :type row) 'standard)
5304 (let ((c 1))
5305 (dolist (cell (nthcdr (if specialp 1 0)
5306 (org-element-contents row)))
5307 (when (memq c skipcols)
5308 (org-element-extract-element cell))
5309 (cl-incf c))))))))))
5310 ;; Since we are going to export using a low-level mechanism,
5311 ;; ignore special column and special rows manually.
5312 (let ((special? (org-export-table-has-special-column-p data))
5313 ignore)
5314 (org-element-map data (if special? '(table-cell table-row) 'table-row)
5315 (lambda (datum)
5316 (when (if (eq (org-element-type datum) 'table-row)
5317 (org-export-table-row-is-special-p datum nil)
5318 (org-export-first-sibling-p datum nil))
5319 (push datum ignore))))
5320 (setq info (plist-put info :ignore-list ignore)))
5321 ;; We use a low-level mechanism to export DATA so as to skip all
5322 ;; usual pre-processing and post-processing, i.e., hooks, Babel
5323 ;; code evaluation, include keywords and macro expansion. Only
5324 ;; back-end specific filters are retained.
5325 (let ((output (org-export-data-with-backend data custom-backend info)))
5326 ;; Remove final newline.
5327 (if (org-string-nw-p output) (substring-no-properties output 0 -1) ""))))
5329 (defun org-table--generic-apply (value name &optional with-cons &rest args)
5330 (cond ((null value) nil)
5331 ((functionp value) `(funcall ',value ,@args))
5332 ((stringp value)
5333 (cond ((consp (car args)) `(apply #'format ,value ,@args))
5334 (args `(format ,value ,@args))
5335 (t value)))
5336 ((and with-cons (consp value))
5337 `(let ((val (cadr (memq column ',value))))
5338 (cond ((null val) contents)
5339 ((stringp val) (format val ,@args))
5340 ((functionp val) (funcall val ,@args))
5341 (t (user-error "Wrong %s value" ,name)))))
5342 (t (user-error "Wrong %s value" name))))
5344 (defun org-table--to-generic-table (params)
5345 "Return custom table transcoder according to PARAMS.
5346 PARAMS is a plist. See `orgtbl-to-generic' for more
5347 information."
5348 (let ((backend (plist-get params :backend))
5349 (splice (plist-get params :splice))
5350 (tstart (plist-get params :tstart))
5351 (tend (plist-get params :tend)))
5352 `(lambda (table contents info)
5353 (concat
5354 ,(and tstart (not splice)
5356 ,(if (or (not backend) tstart tend splice) 'contents
5357 `(org-export-with-backend ',backend table contents info))
5358 ,(org-table--generic-apply (and (not splice) tend) ":tend")))))
5360 (defun org-table--to-generic-row (params)
5361 "Return custom table row transcoder according to PARAMS.
5362 PARAMS is a plist. See `orgtbl-to-generic' for more
5363 information."
5364 (let* ((backend (plist-get params :backend))
5365 (lstart (plist-get params :lstart))
5366 (llstart (plist-get params :llstart))
5367 (hlstart (plist-get params :hlstart))
5368 (hllstart (plist-get params :hllstart))
5369 (lend (plist-get params :lend))
5370 (llend (plist-get params :llend))
5371 (hlend (plist-get params :hlend))
5372 (hllend (plist-get params :hllend))
5373 (lfmt (plist-get params :lfmt))
5374 (llfmt (plist-get params :llfmt))
5375 (hlfmt (plist-get params :hlfmt))
5376 (hllfmt (plist-get params :hllfmt)))
5377 `(lambda (row contents info)
5378 (if (eq (org-element-property :type row) 'rule)
5379 ,(cond
5380 ((plist-member params :hline)
5381 (org-table--generic-apply (plist-get params :hline) ":hline"))
5382 (backend `(org-export-with-backend ',backend row nil info)))
5383 (let ((headerp ,(and (or hlfmt hlstart hlend)
5384 '(org-export-table-row-in-header-p row info)))
5385 (last-header-p
5386 ,(and (or hllfmt hllstart hllend)
5387 '(org-export-table-row-ends-header-p row info)))
5388 (lastp (not (org-export-get-next-element row info))))
5389 (when contents
5390 ;; Check if we can apply `:lfmt', `:llfmt', `:hlfmt', or
5391 ;; `:hllfmt' to CONTENTS. Otherwise, fallback on
5392 ;; `:lstart', `:lend' and their relatives.
5393 ,(let ((cells
5394 '(org-element-map row 'table-cell
5395 (lambda (cell)
5396 ;; Export all cells, without separators.
5397 ;;
5398 ;; Use `org-export-data-with-backend'
5399 ;; instead of `org-export-data' to eschew
5400 ;; cached values, which
5401 ;; ignore :orgtbl-ignore-sep parameter.
5402 (org-export-data-with-backend
5403 cell
5404 (plist-get info :back-end)
5405 (org-combine-plists info '(:orgtbl-ignore-sep t))))
5406 info)))
5407 `(cond
5408 ,(and hllfmt
5409 `(last-header-p ,(org-table--generic-apply
5410 hllfmt ":hllfmt" nil cells)))
5411 ,(and hlfmt
5412 `(headerp ,(org-table--generic-apply
5413 hlfmt ":hlfmt" nil cells)))
5414 ,(and llfmt
5415 `(lastp ,(org-table--generic-apply
5416 llfmt ":llfmt" nil cells)))
5417 (t
5418 ,(if lfmt (org-table--generic-apply lfmt ":lfmt" nil cells)
5419 `(concat
5420 (cond
5421 ,(and
5422 (or hllstart hllend)
5423 `(last-header-p
5424 (concat
5425 ,(org-table--generic-apply hllstart ":hllstart")
5426 contents
5427 ,(org-table--generic-apply hllend ":hllend"))))
5428 ,(and
5429 (or hlstart hlend)
5430 `(headerp
5431 (concat
5432 ,(org-table--generic-apply hlstart ":hlstart")
5433 contents
5434 ,(org-table--generic-apply hlend ":hlend"))))
5435 ,(and
5436 (or llstart llend)
5437 `(lastp
5438 (concat
5439 ,(org-table--generic-apply llstart ":llstart")
5440 contents
5441 ,(org-table--generic-apply llend ":llend"))))
5442 (t
5443 ,(cond
5444 ((or lstart lend)
5445 `(concat
5446 ,(org-table--generic-apply lstart ":lstart")
5447 contents
5448 ,(org-table--generic-apply lend ":lend")))
5449 (backend
5450 `(org-export-with-backend
5451 ',backend row contents info))
5452 (t 'contents)))))))))))))))
5454 (defun org-table--to-generic-cell (params)
5455 "Return custom table cell transcoder according to PARAMS.
5456 PARAMS is a plist. See `orgtbl-to-generic' for more
5457 information."
5458 (let* ((backend (plist-get params :backend))
5459 (efmt (plist-get params :efmt))
5460 (fmt (plist-get params :fmt))
5461 (hfmt (plist-get params :hfmt))
5462 (sep (plist-get params :sep))
5463 (hsep (plist-get params :hsep)))
5464 `(lambda (cell contents info)
5465 ;; Make sure that contents are exported as Org data when :raw
5466 ;; parameter is non-nil.
5467 ,(when (and backend (plist-get params :raw))
5468 `(setq contents
5469 ;; Since we don't know what are the pseudo object
5470 ;; types defined in backend, we cannot pass them to
5471 ;; `org-element-interpret-data'. As a consequence,
5472 ;; they will be treated as pseudo elements, and will
5473 ;; have newlines appended instead of spaces.
5474 ;; Therefore, we must make sure :post-blank value is
5475 ;; really turned into spaces.
5476 (replace-regexp-in-string
5478 (org-trim
5479 (org-element-interpret-data
5480 (org-element-contents cell))))))
5482 (let ((headerp ,(and (or hfmt hsep)
5483 '(org-export-table-row-in-header-p
5484 (org-export-get-parent-element cell) info)))
5485 (column
5486 ;; Call costly `org-export-table-cell-address' only if
5487 ;; absolutely necessary, i.e., if one
5488 ;; of :fmt :efmt :hfmt has a "plist type" value.
5489 ,(and (cl-some (lambda (v) (integerp (car-safe v)))
5490 (list efmt hfmt fmt))
5491 '(1+ (cdr (org-export-table-cell-address cell info))))))
5492 (when contents
5493 ;; Check if we can apply `:efmt' on CONTENTS.
5494 ,(when efmt
5495 `(when (string-match orgtbl-exp-regexp contents)
5496 (let ((mantissa (match-string 1 contents))
5497 (exponent (match-string 2 contents)))
5498 (setq contents ,(org-table--generic-apply
5499 efmt ":efmt" t 'mantissa 'exponent)))))
5500 ;; Check if we can apply FMT (or HFMT) on CONTENTS.
5501 (cond
5502 ,(and hfmt `(headerp (setq contents ,(org-table--generic-apply
5503 hfmt ":hfmt" t 'contents))))
5504 ,(and fmt `(t (setq contents ,(org-table--generic-apply
5505 fmt ":fmt" t 'contents))))))
5506 ;; If a separator is provided, use it instead of BACKEND's.
5507 ;; Separators are ignored when LFMT (or equivalent) is
5508 ;; provided.
5509 ,(cond
5510 ((or hsep sep)
5511 `(if (or ,(and (not sep) '(not headerp))
5512 (plist-get info :orgtbl-ignore-sep)
5513 (not (org-export-get-next-element cell info)))
5514 ,(if (not backend) 'contents
5515 `(org-export-with-backend ',backend cell contents info))
5516 (concat contents
5517 ,(if (and sep hsep) `(if headerp ,hsep ,sep)
5518 (or hsep sep)))))
5519 (backend `(org-export-with-backend ',backend cell contents info))
5520 (t 'contents))))))
5522 ;;;###autoload
5523 (defun orgtbl-to-tsv (table params)
5524 "Convert the orgtbl-mode table to TAB separated material."
5527 ;;;###autoload
5528 (defun orgtbl-to-csv (table params)
5529 "Convert the orgtbl-mode table to CSV material.
5530 This does take care of the proper quoting of fields with comma or quotes."
5531 (orgtbl-to-generic table
5532 (org-combine-plists '(:sep "," :fmt org-quote-csv-field)
5533 params)))
5535 ;;;###autoload
5536 (defun orgtbl-to-latex (table params)
5537 "Convert the orgtbl-mode TABLE to LaTeX.
5539 TABLE is a list, each entry either the symbol `hline' for
5540 a horizontal separator line, or a list of fields for that line.
5541 PARAMS is a property list of parameters that can influence the
5542 conversion. All parameters from `orgtbl-to-generic' are
5543 supported. It is also possible to use the following ones:
5545 :booktabs
5549 :environment
5551 Specify environment to use, as a string. If you use
5553 as a string, to get proper continuation strings."
5554 (require 'ox-latex)
5555 (orgtbl-to-generic
5556 table
5557 (org-combine-plists
5558 ;; Provide sane default values.
5559 (list :backend 'latex
5560 :latex-default-table-mode 'table
5561 :latex-tables-centered nil
5562 :latex-tables-booktabs (plist-get params :booktabs)
5563 :latex-table-scientific-notation nil
5564 :latex-default-table-environment
5565 (or (plist-get params :environment) "tabular"))
5566 params)))
5568 ;;;###autoload
5569 (defun orgtbl-to-html (table params)
5570 "Convert the orgtbl-mode TABLE to HTML.
5572 TABLE is a list, each entry either the symbol `hline' for
5573 a horizontal separator line, or a list of fields for that line.
5574 PARAMS is a property list of parameters that can influence the
5575 conversion. All parameters from `orgtbl-to-generic' are
5576 supported. It is also possible to use the following one:
5578 :attributes
5580 Attributes and values, as a plist, which will be used in
5581 <table> tag."
5582 (require 'ox-html)
5583 (orgtbl-to-generic
5584 table
5585 (org-combine-plists
5586 ;; Provide sane default values.
5587 (list :backend 'html
5588 :html-table-data-tags '("<td%s>" . "</td>")
5589 :html-table-use-header-tags-for-first-column nil
5590 :html-table-align-individual-fields t
5591 :html-table-row-tags '("<tr>" . "</tr>")
5592 :html-table-attributes
5593 (if (plist-member params :attributes)
5594 (plist-get params :attributes)
5595 '(:border "2" :cellspacing "0" :cellpadding "6" :rules "groups"
5596 :frame "hsides")))
5597 params)))
5599 ;;;###autoload
5600 (defun orgtbl-to-texinfo (table params)
5601 "Convert the orgtbl-mode TABLE to Texinfo.
5603 TABLE is a list, each entry either the symbol `hline' for
5604 a horizontal separator line, or a list of fields for that line.
5605 PARAMS is a property list of parameters that can influence the
5606 conversion. All parameters from `orgtbl-to-generic' are
5607 supported. It is also possible to use the following one:
5609 :columns
5611 Column widths, as a string. When providing column fractions,
5613 (require 'ox-texinfo)
5614 (let ((output
5615 (orgtbl-to-generic
5616 table
5617 (org-combine-plists
5618 (list :backend 'texinfo
5619 :texinfo-tables-verbatim nil
5620 :texinfo-table-scientific-notation nil)
5621 params)))
5622 (columns (let ((w (plist-get params :columns)))
5623 (cond ((not w) nil)
5625 (t (concat "@columnfractions " w))))))
5626 (if (not columns) output
5627 (replace-regexp-in-string
5630 ;;;###autoload
5631 (defun orgtbl-to-orgtbl (table params)
5632 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
5634 TABLE is a list, each entry either the symbol `hline' for
5635 a horizontal separator line, or a list of fields for that line.
5636 PARAMS is a property list of parameters that can influence the
5637 conversion. All parameters from `orgtbl-to-generic' are
5638 supported.
5640 Useful when slicing one table into many. The :hline, :sep,
5641 :lstart, and :lend provide orgtbl framing. :tstart and :tend can
5642 be set to provide ORGTBL directives for the generated table."
5643 (require 'ox-org)
5644 (orgtbl-to-generic table (org-combine-plists params (list :backend 'org))))
5646 (defun orgtbl-to-table.el (table params)
5647 "Convert the orgtbl-mode TABLE into a table.el table.
5648 TABLE is a list, each entry either the symbol `hline' for
5649 a horizontal separator line, or a list of fields for that line.
5650 PARAMS is a property list of parameters that can influence the
5651 conversion. All parameters from `orgtbl-to-generic' are
5652 supported."
5653 (with-temp-buffer
5654 (insert (orgtbl-to-orgtbl table params))
5655 (org-table-align)
5656 (replace-regexp-in-string
5657 "-|" "-+"
5658 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
5660 (defun orgtbl-to-unicode (table params)
5661 "Convert the orgtbl-mode TABLE into a table with unicode characters.
5663 TABLE is a list, each entry either the symbol `hline' for
5664 a horizontal separator line, or a list of fields for that line.
5665 PARAMS is a property list of parameters that can influence the
5666 conversion. All parameters from `orgtbl-to-generic' are
5667 supported. It is also possible to use the following ones:
5669 :ascii-art
5672 the table. You can download it here:
5673 http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el.
5675 :narrow
5677 When non-nil, narrow columns width than provided width cookie,
5679 (require 'ox-ascii)
5680 (orgtbl-to-generic
5681 table
5682 (org-combine-plists
5683 (list :backend 'ascii
5684 :ascii-charset 'utf-8
5685 :ascii-table-widen-columns (not (plist-get params :narrow))
5686 :ascii-table-use-ascii-art (plist-get params :ascii-art))
5687 params)))
5689 ;; Put the cursor in a column containing numerical values
5690 ;; of an Org table,
5691 ;; type C-c " a
5692 ;; A new column is added with a bar plot.
5693 ;; When the table is refreshed (C-u C-c *),
5694 ;; the plot is updated to reflect the new values.
5696 (defun orgtbl-ascii-draw (value min max &optional width characters)
5697 "Draw an ascii bar in a table.
5698 VALUE is the value to plot, it determines the width of the bar to draw.
5699 MIN is the value that will be displayed as empty (zero width bar).
5700 MAX is the value that will draw a bar filling all the WIDTH.
5701 WIDTH is the span in characters from MIN to MAX.
5702 CHARACTERS is a string that will compose the bar, with shades of grey
5703 from pure white to pure black. It defaults to a 10 characters string
5704 of regular ascii characters."
5705 (let* ((width (ceiling (or width 12)))
5706 (characters (or characters " .:;c!lhVHW"))
5707 (len (1- (length characters)))
5708 (value (float (if (numberp value)
5709 value (string-to-number value))))
5710 (relative (/ (- value min) (- max min)))
5711 (steps (round (* relative width len))))
5712 (cond ((< steps 0) "too small")
5713 ((> steps (* width len)) "too large")
5714 (t (let* ((int-division (/ steps len))
5715 (remainder (- steps (* int-division len))))
5716 (concat (make-string int-division (elt characters len))
5717 (string (elt characters remainder))))))))
5719 ;;;###autoload
5720 (defun orgtbl-ascii-plot (&optional ask)
5721 "Draw an ASCII bar plot in a column.
5723 With cursor in a column containing numerical values, this function
5724 will draw a plot in a new column.
5726 ASK, if given, is a numeric prefix to override the default 12
5728 prefix,
5729 which will prompt for the width."
5730 (interactive "P")
5731 (let ((col (org-table-current-column))
5732 (min 1e999) ; 1e999 will be converted to infinity
5733 (max -1e999) ; which is the desired result
5734 (table (org-table-to-lisp))
5735 (length
5736 (cond ((consp ask)
5737 (read-number "Length of column " 12))
5738 ((numberp ask) ask)
5739 (t 12))))
5740 ;; Skip any hline a the top of table.
5741 (while (eq (car table) 'hline) (setq table (cdr table)))
5742 ;; Skip table header if any.
5743 (dolist (x (or (cdr (memq 'hline table)) table))
5744 (when (consp x)
5745 (setq x (nth (1- col) x))
5746 (when (string-match
5748 x)
5749 (setq x (string-to-number x))
5750 (when (> min x) (setq min x))
5751 (when (< max x) (setq max x)))))
5752 (org-table-insert-column)
5753 (org-table-move-column-right)
5754 (org-table-store-formulas
5755 (cons
5756 (cons
5757 (concat "$" (number-to-string (1+ col)))
5758 (format "'(%s $%s %s %s %s)"
5759 "orgtbl-ascii-draw" col min max length))
5760 (org-table-get-stored-formulas)))
5761 (org-table-recalculate t)))
5763 ;; Example of extension: unicode characters
5764 ;; Here are two examples of different styles.
5766 ;; Unicode block characters are used to give a smooth effect.
5767 ;; See http://en.wikipedia.org/wiki/Block_Elements
5768 ;; Use one of those drawing functions
5769 ;; - orgtbl-ascii-draw (the default ascii)
5770 ;; - orgtbl-uc-draw-grid (unicode with a grid effect)
5771 ;; - orgtbl-uc-draw-cont (smooth unicode)
5773 ;; This is best viewed with the "DejaVu Sans Mono" font
5774 ;; (use M-x set-frame-font).
5776 (defun orgtbl-uc-draw-grid (value min max &optional width)
5777 "Draw a bar in a table using block unicode characters.
5778 It is a variant of orgtbl-ascii-draw with Unicode block
5779 characters, for a smooth display. Bars appear as grids (to the
5780 extent the font allows)."
5781 ;; http://en.wikipedia.org/wiki/Block_Elements
5782 ;; best viewed with the "DejaVu Sans Mono" font.
5783 (orgtbl-ascii-draw value min max width
5786 (defun orgtbl-uc-draw-cont (value min max &optional width)
5787 "Draw a bar in a table using block unicode characters.
5788 It is a variant of orgtbl-ascii-draw with Unicode block
5789 characters, for a smooth display. Bars are solid (to the extent
5790 the font allows)."
5791 (orgtbl-ascii-draw value min max width
5794 (defun org-table-get-remote-range (name-or-id form)
5795 "Get a field value or a list of values in a range from table at ID.
5797 NAME-OR-ID may be the name of a table in the current file as set
5799 will then be used. Alternatively, it may be an ID referring to
5800 any entry, also in a different file. In this case, the first
5801 table in that entry will be referenced.
5805 The return value is either a single string for a single field, or a
5806 list of the fields in the rectangle."
5807 (save-match-data
5808 (let ((case-fold-search t) (id-loc nil)
5809 ;; Protect a bunch of variables from being overwritten by
5810 ;; the context of the remote table.
5811 org-table-column-names org-table-column-name-regexp
5812 org-table-local-parameters org-table-named-field-locations
5813 org-table-current-line-types
5814 org-table-current-begin-pos org-table-dlines
5815 org-table-current-ncol
5816 org-table-hlines
5817 org-table-last-column-widths
5818 org-table-last-alignment
5819 buffer loc)
5820 (setq form (org-table-convert-refs-to-rc form))
5821 (org-with-wide-buffer
5822 (goto-char (point-min))
5823 (if (re-search-forward
5826 nil t)
5827 (setq buffer (current-buffer) loc (match-beginning 0))
5828 (setq id-loc (org-id-find name-or-id 'marker))
5829 (unless (and id-loc (markerp id-loc))
5831 (setq buffer (marker-buffer id-loc)
5832 loc (marker-position id-loc))
5833 (move-marker id-loc nil))
5834 (with-current-buffer buffer
5835 (org-with-wide-buffer
5836 (goto-char loc)
5837 (forward-char 1)
5839 (not (match-beginning 1)))
5840 (user-error "Cannot find a table at NAME or ID %s" name-or-id))
5841 (org-table-analyze)
5842 (setq form (org-table-formula-substitute-names
5843 (org-table-formula-handle-first/last-rc form)))
5844 (if (and (string-match org-table-range-regexp form)
5845 (> (length (match-string 0 form)) 1))
5846 (org-table-get-range
5847 (match-string 0 form) org-table-current-begin-pos 1)
5848 form)))))))
5850 (defun org-table-remote-reference-indirection (form)
5851 "Return formula with table remote references substituted by indirection.
5853 This indirection works only with the format @ROW$COLUMN. The
5855 distinguished from a plain table name or ID."
5856 (let ((regexp
5857 ;; Same as in `org-table-eval-formula'.
5859 ;; Allow "$1", "@<", "$-1", "@<<$1" etc.
5862 (replace-regexp-in-string
5863 regexp
5864 (lambda (m)
5865 (save-match-data
5866 (let ((eq (org-table-formula-handle-first/last-rc (match-string 1 m))))
5867 (org-table-get-range
5869 (concat "@0" eq)
5870 eq)))))
5871 form t t 1)))
5873 (defmacro org-define-lookup-function (mode)
5874 (let ((mode-str (symbol-name mode))
5875 (first-p (eq mode 'first))
5876 (all-p (eq mode 'all)))
5877 (let ((plural-str (if all-p "s" "")))
5878 `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
5879 ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
5880 If R-LIST is nil, return matching element%s of S-LIST.
5881 If PREDICATE is not nil, use it instead of `equal' to match VAL.
5882 Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
5883 This function is generated by a call to the macro `org-define-lookup-function'."
5884 mode-str plural-str plural-str plural-str)
5885 (let ,(let ((lvars '((p (or predicate 'equal))
5886 (sl s-list)
5887 (rl (or r-list s-list))
5888 (ret nil))))
5889 (if first-p (cons '(match-p nil) lvars) lvars))
5890 (while ,(if first-p '(and (not match-p) sl) 'sl)
5891 (when (funcall p val (car sl))
5892 ,(when first-p '(setq match-p t))
5893 (let ((rval (car rl)))
5894 (setq ret ,(if all-p '(append ret (list rval)) 'rval))))
5895 (setq sl (cdr sl) rl (cdr rl)))
5896 ret)))))
5898 (org-define-lookup-function first)
5899 (org-define-lookup-function last)
5900 (org-define-lookup-function all)
5902 (provide 'org-table)
5904 ;; Local variables:
5905 ;; generated-autoload-file: "org-loaddefs.el"
5906 ;; End:
5908 ;;; org-table.el ends here