| blob | 4ad643f645d18e0727ef969b160512d56f129529 |
1 ;;; org-table.el --- The Table Editor for Org -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2004-2017 Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
8 ;;
9 ;; This file is part of GNU Emacs.
10 ;;
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <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 http://orgmode.org/manual/Tables-in-arbitrary-syntax.html#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."
235 'safe-local-variable
239 "Non-nil means tab in the last column of a table with jump over a hline.
240 If a horizontal separator line is following the current line,
241 `org-table-next-field' can either create a new row before that line, or jump
242 over the line. When this option is nil, a new line will be created before
243 this line."
248 "Options concerning tables in Org mode."
253 "Non-nil means using table references like B3 instead of @3$2.
254 Possible values are:
255 nil never use them
256 from accept as input, do not present for editing
257 t accept as input and present for editing"
265 "Non-nil means increment when copying current field with \
278 calc-angle-mode deg
279 calc-prefer-frac nil
280 calc-symbolic-mode nil
282 calc-display-working-message t
283 )
284 "List with Calc mode settings for use in `calc-eval' for table formulas.
285 The list must contain alternating symbols (Calc modes variables and values).
286 Don't remove any of the default settings, just change the values. Org mode
287 relies on the variables to be present in the list."
292 "Format for the output of calc computations like $1+$2;t.
293 The default value is `hours', and will output the results as a
294 number of hours. Other allowed values are `seconds', `minutes' and
295 `days', and the output will be a fraction of seconds, minutes or
296 days. `hh:mm' selects to use hours and minutes, ignoring seconds.
297 The `U' flag in a table formula will select this specific format for
298 a single formula."
308 "Non-nil means hours in table duration computations should be zero-padded.
309 So this is about 08:32:34 versus 8:33:34."
317 "Format for fields which contain the result of a formula.
319 characters. Beware that modifying the display can prevent the
320 field from being used in another formula."
326 "Non-nil means TAB and RET evaluate a formula in current table field.
327 If the current field starts with an equal sign, it is assumed to be a formula
328 which should be evaluated as described in the manual and in the documentation
329 string of the command `org-table-eval-formula'. This feature requires the
330 Emacs calc package.
331 When this variable is nil, formula calculation is only available through
337 "Non-nil means interpret constants in formulas in tables.
338 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
339 by the value given in `org-table-formula-constants', or by a value obtained
340 from the `constants.el' package."
345 "Alist with constant names and values, for use in table formulas.
346 The car of each element is a name of a constant, without the `$' before it.
347 The cdr is the value as a string. For example, if you'd like to use the
348 speed of light in a formula, you would configure
352 and then use it in an equation like `$1*$c'.
354 Constants can also be defined on a per-file basis using a line like
356 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
363 "Non-nil means lines marked with |#| or |*| will be recomputed automatically.
366 are pressed in the line."
371 "Non-nil means relative formula references may cross hlines.
372 Here are the allowed values:
374 nil Relative references may not cross hlines. They will reference the
375 field next to the hline instead. Coming from below, the reference
376 will be to the field below the hline. Coming from above, it will be
377 to the field above.
378 t Relative references may cross hlines.
379 error An attempt to cross a hline will throw an error.
381 It is probably good to never set this variable to nil, for the sake of
382 portability of tables."
390 "Non-nil means that evaluation of a field formula can add new
391 columns if an out-of-bounds field is being set."
398 (const :tag "Setting an out-of-bounds field adds columns as needed, but issues a warning message" warn)
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."
527 "Expand all columns before executing BODY, then shrink them again."
540 ;;;###autoload
542 "Use the table.el package to insert a new table.
543 If there is already a table at point, convert between Org tables
544 and table.el tables."
557 ;;;###autoload
559 "Convert region to table, or create an empty table.
560 If there is an active region, convert it to a table, using the function
561 `org-table-convert-region'. See the documentation of that function
562 to learn how the prefix argument is interpreted to determine the field
563 separator.
564 If there is no such region, create an empty table with `org-table-create'."
570 ;;;###autoload
572 "Query for a size and insert a table skeleton.
592 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
596 ;; Insert a hline after the first row.
603 ;;;###autoload
605 "Convert region to a table.
607 The region goes from BEG0 to END0, but these borders will be moved
608 slightly, to make sure a beginning of line in the first line is included.
610 SEPARATOR specifies the field separator in the lines. It can have the
611 following values:
613 (4) Use the comma as a field separator
614 (16) Use a TAB as field separator
615 (64) Prompt for a regular expression as field separator
616 integer When a number, use that many spaces, or a TAB, as field separator
617 regexp When a regular expression, use it to match the separator
618 nil When nil, the command tries to be smart and figure out the
619 separator in the following way:
620 - when each line contains a TAB, assume TAB-separated material
621 - when each line contains a comma, assume CSV material
622 - else, assume one or more SPACE characters as separator."
626 re)
628 (user-error "Region is longer than `org-table-convert-region-max-lines' (%s) lines; not converting"
629 org-table-convert-region-max-lines)
638 ;; Get the right field separator
649 ;; parse the csv stuff
674 ;;;###autoload
676 "Import FILE as a table.
677 The file is assumed to be tab-separated. Such files can be produced by most
678 spreadsheet and database applications. If no tabs (at least one per line)
679 are found, lines will be split on whitespace into fields."
688 ;;;###autoload
690 "Export table to a file, with configurable format.
691 Such a file can be imported into usual spreadsheet programs.
693 FILE can be the output file name. If not given, it will be taken
694 from a TABLE_EXPORT_FILE property in the current entry or higher
695 up in the hierarchy, or the user will be prompted for a file
696 name. FORMAT can be an export format, of the same kind as it
697 used when `orgtbl-mode' sends a table in a different format.
699 The command suggests a format depending on TABLE_EXPORT_FORMAT,
700 whether it is set locally or up in the hierarchy, then on the
701 extension of the given file name, and finally on the variable
702 `org-table-export-default-format'."
735 formats)))
736 org-table-export-default-format)
762 "Marker at the beginning of the table last aligned.
765 "Marker at the end of the table last aligned.
768 "List of flags for flushright alignment, from the last re-alignment.
771 "List of max width of fields in each column.
774 "Non-nil means debug table formulas.
782 "Format FIELD according to column WIDTH and alignement ALIGN.
792 prefix
793 field
794 suffix
795 org-table-separator-space)))
797 ;;;###autoload
799 "Align the table at point by aligning all vertical bars."
804 ;; Make sure invisible characters in the table are at the right
805 ;; place since column widths take them into account.
815 end t)))
816 ;; Table's rows as lists of fields. Rules are replaced
817 ;; by nil. Trailing spaces are removed.
823 ;; Compute number of columns. If the table contains no
824 ;; field, create a default table and bail out.
832 ;; Compute alignment and width for each column.
835 fields))
837 ;; Store the maximum width for the column.
839 ;; If there is no alignment cookie get the fraction of
840 ;; numbers among non-empty cells to decide about alignment
841 ;; of the column.
849 column)))
860 alignments)))
863 ;; Store alignment of this table, for later editing of single
864 ;; fields.
867 ;; Build new table rows. Only replace rows that actually
868 ;; changed.
873 indent
876 widths
885 cells
886 widths
887 alignments)
897 ;;;###autoload
899 "Find the beginning of the table and return its position.
900 With a non-nil optional argument TABLE-TYPE, return the beginning
901 of a table.el-type table. This function assumes point is on
902 a table."
910 ;;;###autoload
912 "Find the end of the table and return its position.
913 With a non-nil optional argument TABLE-TYPE, return the end of
914 a table.el-type table. This function assumes point is on
915 a table."
923 ;; When the line right after the table is the last line in
924 ;; the buffer with trailing spaces but no final newline
925 ;; character, be sure to catch the correct ending at its
926 ;; beginning. In any other case, ending is expected to be
927 ;; at point max.
932 ;;;###autoload
934 "Justify the current field, text to left, number to right.
935 Optional argument NEW may specify text to replace the current field content."
944 ;; This is not the same table, force a full re-align.
947 ;; Realign the current field, based on previous full realign.
980 ;;;###autoload
982 "Go to the next field in the current table, creating new lines as needed.
983 Before doing so, re-align the table if necessary."
988 org-table-may-need-update)
999 org-table-tab-jumps-over-hlines
1010 ;;;###autoload
1012 "Go to the previous field in the table.
1013 Before doing so, re-align the table if necessary."
1018 org-table-may-need-update)
1036 "Move to the beginning of the current table field.
1037 If already at or before the beginning, move to the beginning of the
1038 previous field.
1039 With numeric argument N, move N-1 fields backward first."
1052 "Move to the end of the current table field.
1053 If already at or after the end, move to the end of the next table field.
1054 With numeric argument N, move N-1 fields forward first."
1067 ;;;###autoload
1069 "Go to the next row (same column) in the current table.
1070 Before doing so, re-align the table if necessary."
1075 org-table-may-need-update)
1087 ;;;###autoload
1089 "Copy the value of the current field one row below.
1091 If the field at the cursor is empty, copy the content of the
1092 nearest non-empty field above. With argument N, use the Nth
1093 non-empty field.
1095 If the current field is not empty, it is copied down to the next
1096 row, and the cursor is moved with it. Therefore, repeating this
1097 command causes the column to be filled row-by-row.
1099 If the variable `org-table-copy-increment' is non-nil and the
1100 field is an integer or a timestamp, it will be incremented while
1101 copying. By default, increment by the difference between the
1102 value in the current field and the one in the field above. To
1103 increment using a fixed integer, set `org-table-copy-increment'
1104 to a number. In the case of a timestamp, increment by days."
1116 txt txt-up inc)
1124 beg t))
1134 beg t))
1141 ;; Above field was not empty, go down to the next row
1174 "Is point inside a table data field?
1175 I.e. not on a hline or before the first or after the last column?
1176 This actually throws an error, so it aborts the current command."
1188 "Get the field in table line LINE, column COLUMN.
1189 If LINE is larger than the number of data lines in the table, the function
1190 returns nil. However, if COLUMN is too large, we will simply return an
1191 empty string.
1192 If LINE is nil, use the current line.
1193 If COLUMN is nil, use the current column."
1200 "Put VALUE into line LINE, column COLUMN.
1201 When ALIGN is set, also realign the table."
1210 "Return the index of the current data line."
1217 cnt))
1220 "Go to the Nth data line in the current table.
1221 Return t when the line exists, nil if it does not exist."
1228 ;;;###autoload
1230 "Blank the current table field or active region."
1247 "Return the value of the field in column N of current row.
1248 N defaults to current column. If REPLACE is a string, replace
1249 field with this value. The return value is always the old
1250 value."
1254 ;; Before first column or after last one.
1255 ""
1260 ;; Since we are going to remove any hidden field, do not rely
1261 ;; on `org-table--hidden-field' as it could be GC'ed before
1262 ;; second check.
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 "Find out which column we are in."
1328 column)))
1331 "Find out what table data line we are in.
1332 Only data lines count for this."
1340 c)))
1342 ;;;###autoload
1344 "Move the cursor to the Nth column in the current table line.
1345 With optional argument ON-DELIM, stop with point before the left delimiter
1346 of the field.
1347 If there are less than N fields, just go to after the last delimiter.
1348 However, when FORCE is non-nil, create new columns if necessary."
1358 t)))))
1365 ;;;###autoload
1367 "Insert a new column into the table."
1382 ;; Add missing vertical bar at the end of the row.
1389 ;; Shift appropriately stored shrunk column numbers, then hide the
1390 ;; columns again.
1392 shrunk-columns)
1393 beg end)
1395 ;; Fix TBLFM formulas, if desirable.
1402 "Find a data line in the current table, which is needed for column commands."
1405 t
1416 t
1421 "Turn a buffer line number into a data line number.
1423 If there is no data line in this line, return nil.
1425 If there is no matching dline (most likely the reference was
1426 a hline), the first dline below it is used. When ABOVE is
1427 non-nil, the one above is used."
1432 nil)
1443 ;;;###autoload
1445 "Delete a column from the table."
1459 nil
1466 ;; Shift appropriately stored shrunk column numbers, then hide the
1467 ;; columns again.
1469 shrunk-columns)
1470 beg end)
1472 ;; Fix TBLFM formulas, if desirable.
1480 ;;;###autoload
1482 "Move column to the right."
1486 ;;;###autoload
1488 "Move column to the left."
1492 ;;;###autoload
1494 "Move the current column to the right. With arg LEFT, move to the left."
1522 ;; Shift appropriately stored shrunk column numbers, then shrink
1523 ;; the columns again.
1531 shrunk-columns)
1532 beg end)
1534 ;; Fix TBLFM formulas, if desirable.
1545 ;;;###autoload
1547 "Move table row down."
1551 ;;;###autoload
1553 "Move table row up."
1557 ;;;###autoload
1559 "Move the current table line down. With arg UP, move it up."
1568 hline2p)
1595 ;;;###autoload
1597 "Insert a new row above the current line into the table.
1598 With prefix ARG, insert below the current line."
1604 ;; Fix the first field if necessary
1608 ;; Buffer may not end of a newline character, so ensure
1609 ;; (beginning-of-line 2) moves point to a new line.
1620 ;;;###autoload
1622 "Insert a horizontal-line below the current line into the table.
1623 With prefix ABOVE, insert above the current line."
1644 ;;;###autoload
1646 "Insert a hline and move to the row below that line."
1660 In particular, this does handle wide and invisible characters."
1662 ;; It's a hline, just map the characters
1668 t t s)))
1669 s))
1671 ;;;###autoload
1673 "Delete the current row or horizontal line from the table."
1689 ;;;###autoload
1692 "Sort table lines according to the column at point.
1694 The position of point indicates the column to be used for
1695 sorting, and the range of lines is the range between the nearest
1696 horizontal separator lines, or the entire table of no such lines
1697 exist. If point is before the first column, you will be prompted
1698 for the sorting column. If there is an active region, the mark
1699 specifies the first line and the sorting column, while point
1700 should be in the last line to be included into the sorting.
1702 The command then prompts for the sorting type which can be
1703 alphabetically, numerically, or by time (as given in a time stamp
1704 in the field, or as a HH:MM value). Sorting in reverse order is
1705 also possible.
1707 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1709 If SORTING-TYPE is specified when this function is called from a Lisp
1710 program, no prompting will take place. SORTING-TYPE must be a character,
1711 any of (?a ?A ?n ?N ?t ?T ?f ?F) where the capital letters indicate that
1712 sorting should be done in reverse order.
1714 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
1715 a function to be called to extract the key. It must return a value
1716 that is compatible with COMPARE-FUNC, the function used to compare
1717 entries.
1719 A non-nil value for INTERACTIVE? is used to signal that this
1720 function is being called interactively."
1723 ;; Point must be either within a field or before a data line.
1728 ;; Set appropriate case sensitivity and column used for sorting.
1741 ;; Narrow buffer to appropriate sorting area.
1752 start))
1755 end)))
1756 ;; Determine arguments for `sort-subr'. Also record original
1757 ;; position. `org-table-save-field' cannot help here since
1758 ;; sorting is too much destructive.
1764 ;; Function to be called on the contents of the field
1765 ;; used for sorting in the current row.
1792 "Function for comparing keys (empty for default \
1793 `sort-subr' predicate): "
1803 #'end-of-line
1807 nil
1808 predicate)
1809 ;; Hide all columns but the one being sorted.
1811 ;; Move back to initial field.
1815 ;;;###autoload
1817 "Copy region in table to the clipboard and blank all relevant fields.
1818 If there is no active region, use just the field at point."
1824 ;;;###autoload
1826 "Copy rectangular region in table to clipboard.
1827 A special clipboard is used which can only be accessed
1828 with `org-table-paste-rectangle'."
1832 current-prefix-arg))
1837 region)
1849 ;; Collect every cell between COLUMN-START and COLUMN-END.
1859 ;;;###autoload
1861 "Paste a rectangular region into a table.
1862 The upper right corner ends up in the current field. All involved fields
1863 will be overwritten. If the rectangle does not fit into the present table,
1864 the table is enlarged as needed. The process ignores horizontal separator
1865 lines."
1875 ;; If we left the table, create a new row.
1887 ;;;###autoload
1889 "Convert from `org-mode' table to table.el and back.
1890 Obviously, this only works within limits. When an Org table is converted
1891 to table.el, all horizontal separator lines get lost, because table.el uses
1892 these as cell boundaries and has no notion of horizontal lines. A table.el
1893 table can be converted to an Org table only if it does not do row or column
1894 spanning. Multiline cells will become multiple cells. Beware, Org mode
1895 does not test if the table can be successfully converted - it blindly
1896 applies a recipe that works for simple tables."
1900 ;; convert to Org table
1909 ;; convert to table.el table
1912 ;; first, get rid of all horizontal lines
1916 ;; insert a hline before first
1920 ;; insert a hline after each line
1925 ;; replace "+" at beginning and ending of hlines
1934 "Transpose Org table at point and eliminate hlines.
1935 So a table like
1937 | 1 | 2 | 4 | 5 |
1938 |---+---+---+---|
1939 | a | b | c | d |
1940 | e | f | g | h |
1942 will be transposed as
1944 | 1 | a | e |
1945 | 2 | b | f |
1946 | 4 | c | g |
1947 | 5 | d | h |
1949 Note that horizontal lines disappear."
1961 table)))
1975 ;;;###autoload
1977 "Wrap several fields in a column like a paragraph.
1978 This is useful if you'd like to spread the contents of a field over several
1979 lines, in order to keep the table compact.
1981 If there is an active region, and both point and mark are in the same column,
1982 the text in the column is wrapped to minimum width for the given number of
1983 lines. Generally, this makes the table more compact. A prefix ARG may be
1984 used to change the number of desired lines. For example, \
1986 formats the selected text to two lines. If the region was longer than two
1987 lines, the remaining lines remain empty. A negative prefix argument reduces
1988 the current number of lines by that amount. The wrapped text is pasted back
1989 into the table. If you formatted it to more lines than it was before, fields
1990 further down in the table get overwritten - so you might need to make space in
1991 the table first.
1993 If there is no region, the current field is split at the cursor position and
1994 the text fragment to the right of the cursor is prepended to the field one
1995 line down.
1997 If there is no region, but you specify a prefix ARG, the current field gets
1998 blank, and the content is appended to the field above."
2002 ;; There is a region: fill as a paragraph.
2013 nil
2014 nlines))))
2017 ;; No region, split the current field at point.
2042 ;;;###autoload
2044 "Edit table field in a different window.
2045 This is mainly useful for fields that contain hidden parts.
2048 visible so that it can be edited in place.
2051 toggle `org-table-follow-field-mode'."
2073 p)
2095 "Finish editing a table data field.
2096 Remove all newline characters, insert the result into the table, realign
2097 the table and kill the editing buffer."
2101 text)
2118 "Minor mode to make the table field editor window follow the cursor.
2119 When this mode is active, the field editor window will always show the
2120 current field. The mode exits automatically when the cursor leaves the
2121 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
2122 nil " TblFollow" nil
2138 ;; We have left the table, exit the follow mode
2148 ;;;###autoload
2150 "Sum numbers in region of current table column.
2151 The result will be displayed in the echo area, and will be available
2154 If there is an active region, it is interpreted as a rectangle and all
2155 numbers in that rectangle will be summed. If there is no active
2156 region and point is located in a table column, sum all numbers in that
2157 column.
2159 If at least one number looks like a time HH:MM or HH:MM:SS, all other
2160 numbers are assumed to be times as well (in decimal hours) and the
2161 numbers are added as such.
2163 If NLAST is a number, only the NLAST fields will actually be summed."
2190 items1)))
2197 s diff)
2204 sres))))
2227 "Return the formula active for the current field.
2229 Assumes that table is already analyzed. If KEY is given, return
2230 the key to this formula. Otherwise return the formula preceded
2239 org-table-named-field-locations)))
2253 "Read a formula from the minibuffer, offer stored formula as default.
2254 When NAMED is non-nil, look for a named equation."
2259 org-table-named-field-locations)))
2272 stored)
2274 equation)
2280 scol))
2282 'org-table-formula-history
2283 )))))
2284 mustsave)
2286 ;; remove formula
2293 ;; We set the column equation, delete the named one.
2295 mustsave t))
2301 eq))
2304 "Store the list of formulas below the current table.
2305 If optional argument LOCATION is a buffer position, insert it at
2306 LOCATION instead."
2314 ;; Don't overwrite TBLFM, we might use text properties to
2315 ;; store stuff.
2329 ;; Fake a high number to make sure this is sorted at the end.
2336 a)
2346 "Compare two formulas for sorting."
2351 ;;;###autoload
2353 "Return an alist with the stored formulas directly after current table.
2354 By default, only return active formulas, i.e., formulas located
2355 on the first line after the table. However, if optional argument
2356 LOCATION is a buffer position, consider the formulas there."
2365 eq-alist seen)
2369 string)
2374 ;; Is it a column reference?
2376 ;; Since named columns are not possible in
2377 ;; LHS, assume this is a named field.
2385 "Double definition `%s=' in TBLFM line, please fix by hand"
2386 lhs)
2391 "Double definition `%s=' in TBLFM line, please fix by hand"
2392 lhs)))))))))))
2395 "Modify the equations after the table structure has been edited.
2397 For all numbers larger than LIMIT, shift them by DELTA."
2409 s n a)
2415 "Change makes TBLFM term %s invalid, use undo to recover"
2430 ;;;###autoload
2433 If yes, store the formula and apply it."
2434 ;; We already know we are in a table. Get field will only return a formula
2435 ;; when appropriate. It might return a separator line, but no problem.
2438 named eq)
2446 "List of commands triggering the recalculation of a line.
2458 ;;;###autoload
2460 "Rotate the recalculation mark in the first column.
2461 If in any row, the first field is not consistent with a mark,
2462 insert a new column for the markers.
2463 When there is an active region, change all the lines in the region,
2464 after prompting for the marking character.
2465 After each change, a message will be displayed indicating the meaning
2466 of the new mark."
2482 newchar))
2490 newchar))
2508 ;; Rotate mark in first row.
2510 ;; Rotate marks in additional rows if a region is active.
2518 ;; Only align if rotation actually changed lines' length.
2528 ;;;###autoload
2530 "Analyze table at point and store results.
2532 This function sets up the following dynamically scoped variables:
2534 `org-table-column-name-regexp',
2535 `org-table-column-names',
2536 `org-table-current-begin-pos',
2537 `org-table-current-line-types',
2538 `org-table-current-ncol',
2539 `org-table-dlines',
2540 `org-table-hlines',
2541 `org-table-local-parameters',
2542 `org-table-named-field-locations'."
2547 ;; Extract column names.
2560 ;; Extract local parameters.
2568 org-table-local-parameters)))))
2569 ;; Update named fields locations. We minimize `count-lines'
2570 ;; processing by storing last known number of lines in LAST.
2592 field))
2595 org-table-named-field-locations))))))))))
2596 ;; Re-use existing markers when possible.
2600 ;; Analyze the line types.
2611 ;; Get the number of columns from the first data line in table.
2619 al al2)
2633 "Move point to a specific field in the current table.
2635 REF is either the name of a field its absolute reference, as
2636 a string. No column is created unless CREATE-COLUMN-P is
2637 non-nil. If it is a function, it is called with the column
2638 number as its argument as is used as a predicate to know if the
2639 column can be created.
2641 This function assumes the table is already analyzed (i.e., using
2642 `org-table-analyze')."
2657 create-column-p)))
2663 ;;;###autoload
2665 "Recompute the current line if marked for it, and if we haven't just done it."
2685 org-tbl-calc-modes)
2687 ;;;###autoload
2689 suppress-align suppress-const
2690 suppress-store suppress-analysis)
2691 "Replace the table field value at the cursor by the result of a calculation.
2693 In a table, this command replaces the value in the current field with the
2695 formula, by storing it in a special line below the table. When called
2697 field formula.
2700 insert the active equation for the field
2701 back into the current field, so that it can be edited there. This is \
2702 useful
2704 check the referenced fields.
2706 When called, the command first prompts for a formula, which is read in
2707 the minibuffer. Previously entered formulas are available through the
2708 history list, and the last used formula is offered as a default.
2709 These stored formulas are adapted correctly when moving, inserting, or
2710 deleting columns with the corresponding commands.
2712 The formula can be any algebraic expression understood by the Calc package.
2713 For details, see the Org mode manual.
2715 This function can also be called from Lisp programs and offers
2716 additional arguments: EQUATION can be the formula to apply. If this
2717 argument is given, the user will not be prompted.
2719 SUPPRESS-ALIGN is used to speed-up recursive calls by by-passing
2720 unnecessary aligns.
2722 SUPPRESS-CONST suppresses the interpretation of constants in the
2723 formula, assuming that this has been done already outside the
2724 function.
2726 SUPPRESS-STORE means the formula should not be stored, either
2727 because it is already stored, or because it is a modified
2728 equation that should not overwrite the stored one.
2730 SUPPRESS-ANALYSIS prevents analyzing the table and checking
2731 location of point."
2747 equation
2753 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2754 duration duration-output-format)
2755 ;; Parse the format string. Since we have a lot of modes, this is
2756 ;; a lot of work. However, I think calc still uses most of the time.
2769 'calc-float-format
2772 n))))
2777 duration-output-format
2806 ;; replace fields with duration values if relevant
2810 fields)))
2816 x))
2817 fields)))
2823 ;; Insert row and column number of formula result field
2834 t t form)))
2836 ;; Check for old vertical references
2838 ;; Insert remote references
2851 rmtrng))
2852 keep-empty numbers lispp))
2853 t t form)))
2854 ;; Insert complex ranges
2864 ;; possibly handle durations
2869 formrg)
2870 keep-empty numbers lispp)))
2875 ;; Insert simple ranges, i.e. included in the current row.
2878 form)
2889 keep-empty numbers lispp))
2890 t t form)))
2892 ;; Insert the references to fields in same row
2899 x keep-empty numbers lispp)))
2916 ;; Use <...> time-stamps so that Calc can handle them.
2919 ;; Internationalize local time-stamps by setting locale to
2920 ;; "C".
2923 org-ts-regexp
2931 form t t))
2934 form
2941 duration-output-format)
2942 ev)))
2947 Orig: %s
2948 $xyz-> %s
2949 @r$c-> %s
2972 ;; Replace any active time stamp in the result with
2973 ;; an inactive one. Dates in tables are likely
2974 ;; piece of regular data, not meant to appear in the
2975 ;; agenda.
2988 prop value)))
2991 "Get a calc vector from a column, according to descriptor DESC.
2993 Optional arguments TBEG and COL can give the beginning of the table and
2994 the current column, to avoid unnecessary parsing.
2996 HIGHLIGHT means just highlight the range.
2998 When CORNERS-ONLY is set, only return the corners of the range as
2999 a list (line1 column1 line2 column2) where line1 and line2 are
3000 line numbers relative to beginning of table, or TBEG, and column1
3001 and column2 are table column numbers."
3004 desc))
3015 thisline)))
3020 thisline)))
3032 ;; Just one field.
3039 ;; A range, return a vector. First sort the numbers to get
3040 ;; a regular rectangle.
3046 ;; Copy the range values into a list.
3061 ;; Return string representation of calc vector.
3067 "Return relative line number corresponding to descriptor DESC.
3068 The cursor is currently in relative line number CLINE."
3073 ;; 1 2 3 4 5 6
3074 desc))
3096 cline)))
3099 "Return relative line of Nth row with type TYPE.
3100 Search starts from relative line I. When BACKWARDS in non-nil,
3101 look before I. When RELATIVE is non-nil, the reference is
3102 relative. DESC is the original descriptor that started the
3103 search, as a string."
3111 ;; We are going to cross a hline. Check if this is
3112 ;; an authorized move.
3123 ;; The last hline doesn't exist. Instead, point to last row
3124 ;; in table.
3133 "Convert list ELEMENTS to something appropriate to insert into formula.
3134 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
3135 NUMBERS indicates that everything should be converted to numbers.
3136 LISPP non-nil means to return something appropriate for a Lisp
3137 list, `literal' is for the format specifier L."
3138 ;; Calc nan (not a number) is used for the conversion of the empty
3139 ;; field to a reference for several reasons: (i) It is accepted in a
3140 ;; Calc formula (e. g. "" or "()" would result in a Calc error).
3141 ;; (ii) In a single field (not in range) it can be distinguished
3142 ;; from "(nan)" which is the reference made from a single field
3143 ;; containing "nan".
3145 ;; field reference
3148 elements
3150 ""
3159 ;; range reference
3164 elements))))
3170 x
3178 x)
3180 elements
3184 "If there has been more than one second since T1, display message.
3185 ARGS are passed as arguments to the `message' function. Returns
3186 current time if a message is printed, otherwise returns T1. If
3187 T1 is nil, always messages."
3191 curtime)
3192 t1)))
3194 ;;;###autoload
3196 "Recalculate the current table line by applying all stored formulas.
3198 With prefix arg ALL, do this for all lines in the table.
3201 if ALL is the symbol `iterate',
3202 recompute the table until it no longer changes.
3204 If NOALIGN is not nil, do not re-align the table after the computations
3205 are done. This is typically used internally to save time, if it is
3206 known that the table will be realigned a little later anyway."
3221 beg end eqlcol eqlfield)
3222 ;; Insert constants in all formulas.
3225 ;; Expand equations, then split the equation list between
3226 ;; column formulas and field formulas.
3238 old-lhs)))
3241 existing formula for column %s"
3242 old-lhs
3243 new))
3244 new))
3250 ;; Expand ranges in lhs of formulas
3252 ;; Get the correct line range to process.
3259 ;; This is a table with marked lines, compute selected
3260 ;; lines.
3262 ;; Move forward to the first non-header line.
3267 ;; Just leave BEG at the start of the table.
3272 ;; Mark named fields untouchable. Also check if several
3273 ;; field/range formulas try to set the same field.
3277 seen-fields)
3288 ;; Turn field coordinates associated to NAME
3289 ;; into an absolute reference.
3293 name)))
3296 reference))
3301 ;; Evaluate the column formulas, but skip fields covered by
3302 ;; field formulas.
3306 ;; Unprotected line, recalculate.
3311 log-last-time
3324 ;; Evaluate the field formulas.
3333 reference
3334 ;; Possibly create a new column, as long as
3335 ;; `org-table-formula-create-columns' allows it.
3347 t))
3352 ;; Clean up markers and internal text property.
3363 ;;;###autoload
3365 "Recalculate the table until it does not change anymore.
3366 The maximum number of iterations is 10, but you can choose a different value
3367 with the prefix ARG."
3372 thistbl)
3386 ;;;###autoload
3388 "Recalculate all tables in the current buffer."
3393 ;; Reason for separate `org-table-align': When repeating
3394 ;; (org-table-recalculate t) `org-table-may-need-update' gets in
3395 ;; the way.
3398 t)))
3400 ;;;###autoload
3402 "Iterate all tables in the buffer, to converge inter-table dependencies."
3407 c1)
3423 "Apply the #+TBLFM in the line at point to the table."
3430 ;; Insert a temporary formula at right after the table
3435 ;; Recalculate the table.
3440 ;; Delete the formula inserted temporarily.
3446 "Find the beginning of the TBLFM lines and return its position.
3447 Return nil when the beginning of TBLFM line was not found."
3454 "Expand list of formulas.
3455 If some of the RHS in the formulas are ranges or a row reference,
3456 expand them to individual field equations for each field. This
3457 function assumes the table is already analyzed (i.e., using
3458 `org-table-analyze')."
3465 ;; This just refers to one fixed field.
3468 ;; This just refers to one fixed named field.
3471 ;; Column formulas are treated specially and are not
3472 ;; expanded.
3477 rhs)
3478 res)))
3490 rhs)
3491 res))))))))))
3494 "Replace @<, @>, $<, $> with first/last row/column of the table.
3495 So @< and $< will always be replaced with @1 and $1, respectively.
3496 The advantage of these special markers are that structure editing of
3497 the table will not change them, while @1 and $1 will be modified
3498 when a line/row is swapped out of that privileged position. So for
3499 formulas that use a range of rows or columns, it may often be better
3501 borders of the table using the @< @> $< $> makers."
3504 s start)
3509 org-table-current-ncol)
3513 len
3520 s)
3523 "Replace $const with values in string F."
3528 org-table-column-name-regexp
3531 org-table-column-names))))
3532 f t t)))
3533 ;; Parameters and constants.
3537 new start))
3540 ;; When a duration is expected, convert value on the fly.
3546 v)))))
3553 "Find the value for a parameter or constant in a formula.
3554 Parameters get priority."
3585 map))
3592 "--"
3595 "--"
3596 "Shift Reference at Point"
3601 "-"
3602 "Change Test Row for Column Formulas"
3605 "--"
3610 org-table-overlay-coordinates)]
3611 "--"
3619 ;;;###autoload
3621 "Edit the formulas of the current table in a separate buffer."
3627 ;; Move point within the table before analyzing it.
3643 ;; Keep global-font-lock-mode from turning on font-lock-mode
3688 "Convert a formula from internal to user representation."
3691 s))
3694 "Convert a formula from user to internal representation."
3697 s))
3700 "Convert spreadsheet references from A7 to @7$28.
3701 Works for single references, but also for entire formulas and even the
3702 full TBLFM line."
3704 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3707 ;; format match, just advance
3712 ;; 3.e5 or something like this.
3715 ;; (member (match-string 1 s)
3716 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3717 )
3718 ;; function name, just advance
3728 t t s)))))
3729 s))
3732 "Convert spreadsheet references from to @7$28 to AB7.
3733 Works for single references, but also for entire formulas and even the
3734 full TBLFM line."
3741 t t s)))
3746 t nil s)))
3747 s)
3750 "Convert a base 26 number represented by letters into an integer.
3751 For example: AB -> 28."
3757 n))
3760 "Convert an integer into a base 26 number represented by letters.
3761 For example: 28 -> AB."
3766 s))
3769 "Convert a time string into numerical duration in seconds.
3770 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3771 If S is a string representing a number, keep this number."
3773 s
3796 "Convert a number of seconds to a time string.
3797 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3798 minutes or seconds."
3810 ;; Ignore seconds
3814 secs0)
3819 secs0)))))
3823 \f
3824 ;;; Columns shrinking
3827 "Non-nil if current field is narrowed.
3828 When non-nil, return the overlay narrowing the field."
3831 o))
3835 "List currently shrunk columns in table at point."
3837 ;; We really check shrunk columns in current row only. It could
3838 ;; be wrong if all rows do not contain the same number of columns
3839 ;; (i.e. the table is not properly aligned). As a consequence,
3840 ;; some columns may not be shrunk again upon aligning the table.
3841 ;;
3842 ;; For example, in the following table, cursor is on first row and
3843 ;; "<>" indicates a shrunk column.
3844 ;;
3845 ;; | |
3846 ;; | | <> |
3847 ;;
3848 ;; Aligning table from the first row will not shrink again the
3849 ;; second row, which was not visible initially.
3850 ;;
3851 ;; However, fixing it requires to check every row, which may be
3852 ;; slow on large tables. Moreover, the hindrance of this
3853 ;; pathological case is very limited.
3866 "Shrink a table field to a specified width.
3868 WIDTH is an integer representing the number of characters to
3869 display, in addition to `org-table-shrunk-column-indicator'. START
3870 and END are, respectively, the beginning and ending positions of
3871 the field. CONTENTS is its trimmed contents, as a string, or
3872 `hline' for table rules.
3874 Real field is hidden under an overlay. The latter has the
3875 following properties:
3877 `org-overlay-type'
3879 Set to `table-column-hide'. Used to identify overlays
3880 responsible for the task.
3882 `org-table-column-overlays'
3884 It is a list with the pattern (siblings . COLUMN-OVERLAYS)
3885 where COLUMN-OVERLAYS is the list of all overlays hiding the
3886 same column.
3888 Whenever the text behind or next to the overlay is modified, all
3889 the overlays in the column are deleted, effectively displaying
3890 the column again.
3892 Return overlay used to hide the field."
3899 org-table-shrunk-column-indicator))
3901 ;; Remove invisible parts from links in CONTENTS. Since
3902 ;; shrinking could happen before first fontification
3903 ;; (e.g., using a #+STARTUP keyword), this cannot be done
3904 ;; using text properties.
3908 ;; Expand field.
3910 contents
3912 org-table-shrunk-column-indicator)
3913 ;; Truncate field.
3916 org-table-shrunk-column-indicator))))))
3919 ;; Removing one overlay removes all other overlays
3920 ;; in the same column.
3929 ;; Make sure overlays stays on top of table coordinates
3930 ;; overlays. See `org-table-overlay-coordinates'.
3933 o)))
3936 "Read column selection select as a list of numbers.
3938 SELECT is a string containing column ranges, separated by white
3939 space characters, see `org-table-hide-column' for details. MAX
3940 is the maximum column number.
3942 Return value is a sorted list of numbers. Ignore any number
3943 outside of the [1;MAX] range."
3960 max))))
3963 #'<)))
3966 "Shrink COLUMNS in an Org table.
3967 COLUMNS is a sorted list of column numbers. BEG and END are,
3968 respectively, the beginning position and the end position of the
3969 table."
3980 ;; Move to COLUMN.
3985 ;; Extract boundaries and contents from current field.
3986 ;; Also set the column's width if we encounter a width
3987 ;; cookie for the first time.
4001 ;; Link overlay to the other overlays in the same column.
4008 ;;;###autoload
4010 "Shrink or expand current column in an Org table.
4012 If a width cookie specifies a width W for the column, the first
4013 W visible characters are displayed. Otherwise, the column is
4014 shrunk to a single character.
4016 When point is before the first column or after the last one, ask
4017 for the columns to shrink or expand, as a list of ranges.
4018 A column range can be one of the following patterns:
4020 N column N only
4021 N-M every column between N and M (both inclusive)
4022 N- every column between N (inclusive) and the last column
4023 -M every column between the first one and M (inclusive)
4024 - every column
4026 When optional argument ARG is a string, use it as white space
4027 separated list of column ranges.
4030 `org-table-shrink', i.e.,
4031 shrink columns with a width cookie and expand the others.
4034 prefix, expand all columns."
4040 ;; Compute an upper bound for the number of columns.
4041 ;; Nonexistent columns are ignored anyway.
4046 (`nil
4050 ;; Point is either before first column or past last
4051 ;; one. Ask for columns to operate on.
4054 max-columns)
4055 ;; Find current column, even when on a hline.
4072 ;; Move before overlay if point is under it.
4076 ;;;###autoload
4078 "Shrink all columns with a width cookie in the table at point.
4080 Columns without a width cookie are expanded.
4082 Optional arguments BEGIN and END, when non-nil, specify the
4083 beginning and end position of the current table."
4096 ;; Make sure invisible characters in the table are at the right
4097 ;; place since column widths take them into account.
4101 ;;;###autoload
4103 "Expand all columns in the table at point.
4104 Optional arguments BEGIN and END, when non-nil, specify the
4105 beginning and end position of the current table."
4114 \f
4115 ;;; Formula editing
4118 "Convert all references in this buffer, using FUNCTION."
4129 "Convert all references in the buffer from B3 to @3$2 and back."
4139 "Shift the reference at point one row/hline up."
4143 "Shift the reference at point one row/hline down."
4147 "Shift the reference at point one field to the left."
4151 "Shift the reference at point one field to the right."
4162 ;; A B3-like reference
4168 ;; An internal reference
4174 "Re-match the group N, and replace it with the shifted reference."
4179 t t)))
4182 "Shift a reference part REF.
4183 If DECR is set, decrease the references row/column, else increase.
4184 If HLINE is set, this may be a hline reference, it certainly is not
4185 a translation reference."
4214 "Toggle the display of coordinates in the referenced table."
4223 "Parse the buffer for formula definitions and install them.
4224 With prefix ARG, apply the new formulas to the table."
4233 eql)
4236 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
4237 nil t)
4258 "Abort editing formulas, without installing the changes."
4269 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
4310 "Show the location/value of the $ expression at point.
4311 When LOCAL is non-nil, show references for the table at point."
4321 var name e what match dest)
4325 "$1.."
4377 dest)
4403 ;; Column number.
4429 org-table-fedit-scroll-down))))
4441 "Make sure the cursor is in a dataline in a table."
4450 p1 p2)))
4455 "Move cursor one line up in the window showing the table."
4460 "Move cursor one line down in the window showing the table."
4465 "Move the cursor in the window showing the table.
4466 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
4491 "Add a new overlay."
4497 "Highlight rectangular region in a table.
4498 When buffer positions BEG and END are provided, use them to
4499 delimit the region to highlight. Otherwise, refer to point. Use
4500 FACE, when non-nil, for the highlight."
4532 "Remove the rectangle overlays."
4542 "Add overlays to the table at point, to show row/column coordinates."
4570 ;;;###autoload
4572 "Toggle the display of Row/Column numbers in tables."
4583 ;;;###autoload
4585 "Toggle the formula debugger in tables."
4591 ;;; The orgtbl minor mode
4593 ;; Define a minor mode which can be used in other modes in order to
4594 ;; integrate the Org table editor.
4596 ;; This is really a hack, because the Org table editor uses several
4597 ;; keys which normally belong to the major mode, for example the TAB
4598 ;; and RET keys. Here is how it works: The minor mode defines all the
4599 ;; keys necessary to operate the table editor, but wraps the commands
4600 ;; into a function which tests if the cursor is currently inside
4601 ;; a table. If that is the case, the table editor command is
4602 ;; executed. However, when any of those keys is used outside a table,
4603 ;; the function uses `key-binding' to look up if the key has an
4604 ;; associated command in another currently active keymap (minor modes,
4605 ;; major mode, global), and executes that command. There might be
4606 ;; problems if any of the keys used by the table editor is otherwise
4607 ;; used as a prefix key.
4609 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
4610 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
4611 ;; addresses this by checking explicitly for both bindings.
4613 ;; The optimized version (see variable `orgtbl-optimized') takes over
4614 ;; all keys which are bound to `self-insert-command' in the *global map*.
4615 ;; Some modes bind other commands to simple characters, for example
4616 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
4617 ;; active, this binding is ignored inside tables and replaced with a
4618 ;; modified self-insert.
4636 ;; Install it as a minor mode.
4640 ;;;###autoload
4642 "The `org-mode' table editor as a minor mode for use in other modes."
4647 ;; Exit without error, in case some hook functions calls this
4648 ;; by accident in org-mode.
4652 ;; Make sure we are first in minor-mode-map-alist
4654 ;; FIXME: maybe it should use emulation-mode-map-alists?
4661 auto-fill-inhibit-regexp)
4665 auto-fill-inhibit-regexp)
4666 orgtbl-line-start-regexp))
4681 "Create a function for binding in the table minor mode.
4682 FUN is the command to call inside a table. N is used to create a unique
4683 command name. KEYS are keys that should be checked in for a command
4684 to execute outside of tables."
4690 "Outside of tables, run the binding of `"
4702 keys)
4706 "Error when there is no default binding for a table key."
4711 "Setup orgtbl keymaps."
4742 elt key fun cmd)
4750 ;; Special treatment needed for TAB, RET and DEL
4763 (orgtbl-make-binding 'org-delete-backward-char 109
4769 [(tab)] "\C-i"))
4771 (org-defkey orgtbl-mode-map [backtab]
4773 [backtab] [S-iso-lefttab] [(shift tab)]
4774 [(tab)] "\C-i"))
4776 (org-defkey orgtbl-mode-map "\M-\C-m"
4777 (orgtbl-make-binding 'org-table-wrap-region 105
4778 "\M-\C-m" [(meta return)]))
4779 (org-defkey orgtbl-mode-map [(meta return)]
4780 (orgtbl-make-binding 'org-table-wrap-region 106
4781 [(meta return)] "\M-\C-m"))
4783 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4784 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4786 (when orgtbl-optimized
4787 ;; If the user wants maximum table support, we need to hijack
4788 ;; some standard editing functions
4789 (org-remap orgtbl-mode-map
4790 'self-insert-command 'orgtbl-self-insert-command
4791 'delete-char 'org-delete-char
4792 'delete-backward-char 'org-delete-backward-char)
4793 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4794 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4795 '("OrgTbl"
4796 ["Create or convert" org-table-create-or-convert-from-region
4797 :active (not (org-at-table-p)) :keys "C-c |" ]
4798 "--"
4799 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4800 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4801 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4802 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4803 "--"
4804 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4805 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4806 ["Copy Field from Above"
4807 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4808 "--"
4809 ("Column"
4810 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4811 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4812 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4813 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4814 ("Row"
4815 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4816 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4817 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4818 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4819 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4820 "--"
4821 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4822 ("Rectangle"
4823 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4824 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4825 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4826 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4827 "--"
4828 ("Radio tables"
4829 ["Insert table template" orgtbl-insert-radio-table
4830 (cl-assoc-if #'derived-mode-p orgtbl-radio-table-templates)]
4831 ["Comment/uncomment table" orgtbl-toggle-comment t])
4832 "--"
4833 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4834 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4835 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4836 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4837 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4838 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4839 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4840 ["Sum Column/Rectangle" org-table-sum
4841 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4842 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4843 ["Debug Formulas"
4844 org-table-toggle-formula-debugger :active (org-at-table-p)
4845 :keys "C-c {"
4846 :style toggle :selected org-table-formula-debug]
4847 ["Show Col/Row Numbers"
4848 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4849 :keys "C-c }"
4850 :style toggle :selected org-table-overlay-coordinates]
4851 "--"
4852 ("Plot"
4855 t))
4857 (defun orgtbl-ctrl-c-ctrl-c (arg)
4858 "If the cursor is inside a table, realign the table.
4859 If it is a table to be sent away to a receiver, do it.
4860 With prefix arg, also recompute table."
4861 (interactive "P")
4862 (let ((case-fold-search t) (pos (point)) action)
4863 (save-excursion
4864 (beginning-of-line 1)
4865 (setq action (cond
4869 (cond
4870 ((integerp action)
4871 (goto-char action)
4872 (org-table-maybe-eval-formula)
4873 (if arg
4874 (call-interactively 'org-table-recalculate)
4875 (org-table-maybe-recalculate-line))
4876 (call-interactively 'org-table-align)
4877 (when (orgtbl-send-table 'maybe)
4878 (run-hooks 'orgtbl-after-send-table-hook)))
4879 ((eq action 'recalc)
4880 (save-excursion
4881 (beginning-of-line 1)
4883 (if (org-at-table-p)
4884 (org-call-with-arg 'org-table-recalculate t))))
4885 (t (let (orgtbl-mode)
4886 (call-interactively (key-binding "\C-c\C-c")))))))
4888 (defun orgtbl-create-or-convert-from-region (_arg)
4889 "Create table or convert region to table, if no conflicting binding.
4890 This installs the table binding `C-c |', but only if there is no
4891 conflicting binding to this key outside orgtbl-mode."
4892 (interactive "P")
4893 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4894 (if cmd
4895 (call-interactively cmd)
4896 (call-interactively 'org-table-create-or-convert-from-region))))
4898 (defun orgtbl-tab (arg)
4899 "Justification and field motion for `orgtbl-mode'."
4900 (interactive "P")
4901 (if arg (org-table-edit-field t)
4902 (org-table-justify-field-maybe)
4903 (org-table-next-field)))
4905 (defun orgtbl-ret ()
4906 "Justification and field motion for `orgtbl-mode'."
4907 (interactive)
4908 (if (bobp)
4909 (newline)
4910 (org-table-justify-field-maybe)
4911 (org-table-next-row)))
4913 (defun orgtbl-self-insert-command (N)
4914 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4915 If the cursor is in a table looking at whitespace, the whitespace is
4916 overwritten, and the table is not marked as requiring realignment."
4917 (interactive "p")
4918 (if (and (org-at-table-p)
4919 (or
4920 (and org-table-auto-blank-field
4921 (member last-command
4922 '(orgtbl-hijacker-command-100
4923 orgtbl-hijacker-command-101
4924 orgtbl-hijacker-command-102
4925 orgtbl-hijacker-command-103
4926 orgtbl-hijacker-command-104
4927 orgtbl-hijacker-command-105
4928 yas/expand))
4929 (org-table-blank-field))
4930 t)
4931 (eq N 1)
4933 (let (org-table-may-need-update)
4934 (delete-region (match-beginning 1) (match-end 1))
4935 (self-insert-command N))
4936 (setq org-table-may-need-update t)
4937 (let* (orgtbl-mode
4938 a
4939 (cmd (or (key-binding
4940 (or (and (listp function-key-map)
4941 (setq a (assoc last-input-event function-key-map))
4942 (cdr a))
4943 (vector last-input-event)))
4944 'self-insert-command)))
4945 (call-interactively cmd)
4946 (if (and org-self-insert-cluster-for-undo
4947 (eq cmd 'self-insert-command))
4948 (if (not (eq last-command 'orgtbl-self-insert-command))
4949 (setq org-self-insert-command-undo-counter 1)
4950 (if (>= org-self-insert-command-undo-counter 20)
4951 (setq org-self-insert-command-undo-counter 1)
4952 (and (> org-self-insert-command-undo-counter 0)
4953 buffer-undo-list
4954 (not (cadr buffer-undo-list)) ; remove nil entry
4955 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4956 (setq org-self-insert-command-undo-counter
4957 (1+ org-self-insert-command-undo-counter))))))))
4959 ;;;###autoload
4961 "Regular expression matching exponentials as produced by calc.")
4963 (defun orgtbl-gather-send-defs ()
4964 "Gather a plist of :name, :transform, :params for each destination before
4965 a radio table."
4966 (save-excursion
4967 (goto-char (org-table-begin))
4968 (let (rtn)
4969 (beginning-of-line 0)
4970 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4971 (let ((name (org-no-properties (match-string 1)))
4972 (transform (intern (match-string 2)))
4973 (params (if (match-end 3)
4974 (read (concat "(" (match-string 3) ")")))))
4975 (push (list :name name :transform transform :params params)
4976 rtn)
4977 (beginning-of-line 0)))
4978 rtn)))
4980 (defun orgtbl-send-replace-tbl (name text)
4981 "Find and replace table NAME with TEXT."
4982 (save-excursion
4983 (goto-char (point-min))
4984 (let* ((location-flag nil)
4985 (name (regexp-quote name))
4988 (while (re-search-forward begin-re nil t)
4989 (unless location-flag (setq location-flag t))
4990 (let ((beg (line-beginning-position 2)))
4991 (unless (re-search-forward end-re nil t)
4992 (user-error "Cannot find end of receiver location at %d" beg))
4993 (beginning-of-line)
4994 (delete-region beg (point))
4996 (unless location-flag
4997 (user-error "No valid receiver location found in the buffer")))))
4999 ;;;###autoload
5000 (defun org-table-to-lisp (&optional txt)
5001 "Convert the table at point to a Lisp structure.
5002 The structure will be a list. Each item is either the symbol `hline'
5003 for a horizontal separator line, or a list of field values as strings.
5004 The table is taken from the parameter TXT, or from the buffer at point."
5005 (unless (or txt (org-at-table-p)) (user-error "No table at point"))
5006 (let ((txt (or txt
5007 (buffer-substring-no-properties (org-table-begin)
5008 (org-table-end)))))
5009 (mapcar (lambda (x)
5010 (if (string-match org-table-hline-regexp x) 'hline
5014 (defun orgtbl-send-table (&optional maybe)
5015 "Send a transformed version of table at point to the receiver position.
5016 With argument MAYBE, fail quietly if no transformation is defined
5017 for this table."
5018 (interactive)
5019 (catch 'exit
5020 (unless (org-at-table-p) (user-error "Not at a table"))
5021 ;; when non-interactive, we assume align has just happened.
5022 (when (called-interactively-p 'any) (org-table-align))
5023 (let ((dests (orgtbl-gather-send-defs))
5024 (table (org-table-to-lisp
5025 (buffer-substring-no-properties (org-table-begin)
5026 (org-table-end))))
5027 (ntbl 0))
5028 (unless dests
5029 (if maybe (throw 'exit nil)
5030 (user-error "Don't know how to transform this table")))
5031 (dolist (dest dests)
5032 (let ((name (plist-get dest :name))
5033 (transform (plist-get dest :transform))
5034 (params (plist-get dest :params)))
5035 (unless (fboundp transform)
5036 (user-error "No such transformation function %s" transform))
5037 (orgtbl-send-replace-tbl name (funcall transform table params)))
5038 (cl-incf ntbl))
5039 (message "Table converted and installed at %d receiver location%s"
5040 ntbl (if (> ntbl 1) "s" ""))
5041 (and (> ntbl 0) ntbl))))
5043 (defun org-remove-by-index (list indices &optional i0)
5044 "Remove the elements in LIST with indices in INDICES.
5045 First element has index 0, or I0 if given."
5046 (if (not indices)
5047 list
5048 (if (integerp indices) (setq indices (list indices)))
5049 (setq i0 (1- (or i0 0)))
5050 (delq :rm (mapcar (lambda (x)
5051 (setq i0 (1+ i0))
5052 (if (memq i0 indices) :rm x))
5053 list))))
5055 (defun orgtbl-toggle-comment ()
5056 "Comment or uncomment the orgtbl at point."
5057 (interactive)
5058 (let* ((case-fold-search t)
5059 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
5060 (re2 (concat "^" orgtbl-line-start-regexp))
5061 (commented (save-excursion (beginning-of-line 1)
5062 (cond ((looking-at re1) t)
5063 ((looking-at re2) nil)
5064 (t (user-error "Not at an org table")))))
5065 (re (if commented re1 re2))
5066 beg end)
5067 (save-excursion
5068 (beginning-of-line 1)
5069 (while (looking-at re) (beginning-of-line 0))
5070 (beginning-of-line 2)
5071 (setq beg (point))
5072 (while (looking-at re) (beginning-of-line 2))
5073 (setq end (point)))
5074 (comment-region beg end (if commented '(4) nil))))
5076 (defun orgtbl-insert-radio-table ()
5077 "Insert a radio table template appropriate for this major mode."
5078 (interactive)
5079 (let* ((e (cl-assoc-if #'derived-mode-p orgtbl-radio-table-templates))
5080 (txt (nth 1 e))
5081 name pos)
5082 (unless e (user-error "No radio table setup defined for %s" major-mode))
5083 (setq name (read-string "Table name: "))
5084 (while (string-match "%n" txt)
5085 (setq txt (replace-match name t t txt)))
5087 (setq pos (point))
5088 (insert txt)
5089 (goto-char pos)))
5091 ;;;###autoload
5092 (defun orgtbl-to-generic (table params)
5093 "Convert the orgtbl-mode TABLE to some other format.
5095 This generic routine can be used for many standard cases.
5097 TABLE is a list, each entry either the symbol `hline' for
5098 a horizontal separator line, or a list of fields for that
5099 line. PARAMS is a property list of parameters that can
5100 influence the conversion.
5102 Valid parameters are:
5104 :backend, :raw
5106 Export back-end used as a basis to transcode elements of the
5107 table, when no specific parameter applies to it. It is also
5108 used to translate cells contents. You can prevent this by
5109 setting :raw property to a non-nil value.
5111 :splice
5113 When non-nil, only convert rows, not the table itself. This is
5114 equivalent to setting to the empty string both :tstart
5115 and :tend, which see.
5117 :skip
5119 When set to an integer N, skip the first N lines of the table.
5120 Horizontal separation lines do count for this parameter!
5122 :skipcols
5124 List of columns that should be skipped. If the table has
5125 a column with calculation marks, that column is automatically
5126 discarded beforehand.
5128 :hline
5130 String to be inserted on horizontal separation lines. May be
5131 nil to ignore these lines altogether.
5133 :sep
5135 Separator between two fields, as a string.
5137 Each in the following group may be either a string or a function
5138 of no arguments returning a string:
5140 :tstart, :tend
5142 Strings to start and end the table. Ignored when :splice is t.
5144 :lstart, :lend
5146 Strings to start and end a new table line.
5148 :llstart, :llend
5150 Strings to start and end the last table line. Default,
5151 respectively, to :lstart and :lend.
5153 Each in the following group may be a string or a function of one
5154 argument (either the cells in the current row, as a list of
5155 strings, or the current cell) returning a string:
5157 :lfmt
5159 Format string for an entire row, with enough %s to capture all
5160 fields. When non-nil, :lstart, :lend, and :sep are ignored.
5162 :llfmt
5164 Format for the entire last line, defaults to :lfmt.
5166 :fmt
5168 A format to be used to wrap the field, should contain %s for
5169 the original field value. For example, to wrap everything in
5171 a property list with column numbers and format strings, or
5172 functions, e.g.,
5176 :hlstart :hllstart :hlend :hllend :hsep :hlfmt :hllfmt :hfmt
5178 Same as above, specific for the header lines in the table.
5179 All lines before the first hline are treated as header. If
5180 any of these is not present, the data line value is used.
5182 This may be either a string or a function of two arguments:
5184 :efmt
5186 Use this format to print numbers with exponential. The format
5187 should have %s twice for inserting mantissa and exponent, for
5189 list with column numbers and format strings or functions.
5190 :fmt will still be applied after :efmt."
5191 ;; Make sure `org-export-create-backend' is available.
5192 (require 'ox)
5193 (let* ((backend (plist-get params :backend))
5194 (custom-backend
5195 ;; Build a custom back-end according to PARAMS. Before
5196 ;; defining a translator, check if there is anything to do.
5197 ;; When there isn't, let BACKEND handle the element.
5198 (org-export-create-backend
5199 :parent (or backend 'org)
5200 :transcoders
5201 `((table . ,(org-table--to-generic-table params))
5202 (table-row . ,(org-table--to-generic-row params))
5203 (table-cell . ,(org-table--to-generic-cell params))
5204 ;; Macros are not going to be expanded. However, no
5205 ;; regular back-end has a transcoder for them. We
5206 ;; provide one so they are not ignored, but displayed
5207 ;; as-is instead.
5208 (macro . (lambda (m c i) (org-element-macro-interpreter m nil))))))
5209 data info)
5210 ;; Store TABLE as Org syntax in DATA. Tolerate non-string cells.
5211 ;; Initialize communication channel in INFO.
5212 (with-temp-buffer
5213 (let ((org-inhibit-startup t)) (org-mode))
5214 (let ((standard-output (current-buffer))
5215 (org-element-use-cache nil))
5216 (dolist (e table)
5218 ((consp e)
5219 (princ "| ") (dolist (c e) (princ c) (princ " |"))
5221 ;; Add back-end specific filters, but not user-defined ones. In
5222 ;; particular, make sure to call parse-tree filters on the
5223 ;; table.
5224 (setq info
5225 (let ((org-export-filters-alist nil))
5226 (org-export-install-filters
5227 (org-combine-plists
5228 (org-export-get-environment backend nil params)
5229 `(:back-end ,(org-export-get-backend backend))))))
5230 (setq data
5231 (org-export-filter-apply-functions
5232 (plist-get info :filter-parse-tree)
5233 (org-element-map (org-element-parse-buffer) 'table
5234 #'identity nil t)
5235 info)))
5236 (when (and backend (symbolp backend) (not (org-export-get-backend backend)))
5237 (user-error "Unknown :backend value"))
5238 (when (or (not backend) (plist-get info :raw)) (require 'ox-org))
5239 ;; Handle :skip parameter.
5240 (let ((skip (plist-get info :skip)))
5241 (when skip
5242 (unless (wholenump skip) (user-error "Wrong :skip value"))
5243 (let ((n 0))
5244 (org-element-map data 'table-row
5245 (lambda (row)
5246 (if (>= n skip) t
5247 (org-element-extract-element row)
5248 (cl-incf n)
5249 nil))
5250 nil t))))
5251 ;; Handle :skipcols parameter.
5252 (let ((skipcols (plist-get info :skipcols)))
5253 (when skipcols
5254 (unless (consp skipcols) (user-error "Wrong :skipcols value"))
5255 (org-element-map data 'table
5256 (lambda (table)
5257 (let ((specialp (org-export-table-has-special-column-p table)))
5258 (dolist (row (org-element-contents table))
5259 (when (eq (org-element-property :type row) 'standard)
5260 (let ((c 1))
5261 (dolist (cell (nthcdr (if specialp 1 0)
5262 (org-element-contents row)))
5263 (when (memq c skipcols)
5264 (org-element-extract-element cell))
5265 (cl-incf c))))))))))
5266 ;; Since we are going to export using a low-level mechanism,
5267 ;; ignore special column and special rows manually.
5268 (let ((special? (org-export-table-has-special-column-p data))
5269 ignore)
5270 (org-element-map data (if special? '(table-cell table-row) 'table-row)
5271 (lambda (datum)
5272 (when (if (eq (org-element-type datum) 'table-row)
5273 (org-export-table-row-is-special-p datum nil)
5274 (org-export-first-sibling-p datum nil))
5275 (push datum ignore))))
5276 (setq info (plist-put info :ignore-list ignore)))
5277 ;; We use a low-level mechanism to export DATA so as to skip all
5278 ;; usual pre-processing and post-processing, i.e., hooks, Babel
5279 ;; code evaluation, include keywords and macro expansion. Only
5280 ;; back-end specific filters are retained.
5281 (let ((output (org-export-data-with-backend data custom-backend info)))
5282 ;; Remove final newline.
5283 (if (org-string-nw-p output) (substring-no-properties output 0 -1) ""))))
5285 (defun org-table--generic-apply (value name &optional with-cons &rest args)
5286 (cond ((null value) nil)
5287 ((functionp value) `(funcall ',value ,@args))
5288 ((stringp value)
5289 (cond ((consp (car args)) `(apply #'format ,value ,@args))
5290 (args `(format ,value ,@args))
5291 (t value)))
5292 ((and with-cons (consp value))
5293 `(let ((val (cadr (memq column ',value))))
5294 (cond ((null val) contents)
5295 ((stringp val) (format val ,@args))
5296 ((functionp val) (funcall val ,@args))
5297 (t (user-error "Wrong %s value" ,name)))))
5298 (t (user-error "Wrong %s value" name))))
5300 (defun org-table--to-generic-table (params)
5301 "Return custom table transcoder according to PARAMS.
5302 PARAMS is a plist. See `orgtbl-to-generic' for more
5303 information."
5304 (let ((backend (plist-get params :backend))
5305 (splice (plist-get params :splice))
5306 (tstart (plist-get params :tstart))
5307 (tend (plist-get params :tend)))
5308 `(lambda (table contents info)
5309 (concat
5310 ,(and tstart (not splice)
5312 ,(if (or (not backend) tstart tend splice) 'contents
5313 `(org-export-with-backend ',backend table contents info))
5314 ,(org-table--generic-apply (and (not splice) tend) ":tend")))))
5316 (defun org-table--to-generic-row (params)
5317 "Return custom table row transcoder according to PARAMS.
5318 PARAMS is a plist. See `orgtbl-to-generic' for more
5319 information."
5320 (let* ((backend (plist-get params :backend))
5321 (lstart (plist-get params :lstart))
5322 (llstart (plist-get params :llstart))
5323 (hlstart (plist-get params :hlstart))
5324 (hllstart (plist-get params :hllstart))
5325 (lend (plist-get params :lend))
5326 (llend (plist-get params :llend))
5327 (hlend (plist-get params :hlend))
5328 (hllend (plist-get params :hllend))
5329 (lfmt (plist-get params :lfmt))
5330 (llfmt (plist-get params :llfmt))
5331 (hlfmt (plist-get params :hlfmt))
5332 (hllfmt (plist-get params :hllfmt)))
5333 `(lambda (row contents info)
5334 (if (eq (org-element-property :type row) 'rule)
5335 ,(cond
5336 ((plist-member params :hline)
5337 (org-table--generic-apply (plist-get params :hline) ":hline"))
5338 (backend `(org-export-with-backend ',backend row nil info)))
5339 (let ((headerp ,(and (or hlfmt hlstart hlend)
5340 '(org-export-table-row-in-header-p row info)))
5341 (last-header-p
5342 ,(and (or hllfmt hllstart hllend)
5343 '(org-export-table-row-ends-header-p row info)))
5344 (lastp (not (org-export-get-next-element row info))))
5345 (when contents
5346 ;; Check if we can apply `:lfmt', `:llfmt', `:hlfmt', or
5347 ;; `:hllfmt' to CONTENTS. Otherwise, fallback on
5348 ;; `:lstart', `:lend' and their relatives.
5349 ,(let ((cells
5350 '(org-element-map row 'table-cell
5351 (lambda (cell)
5352 ;; Export all cells, without separators.
5353 ;;
5354 ;; Use `org-export-data-with-backend'
5355 ;; instead of `org-export-data' to eschew
5356 ;; cached values, which
5357 ;; ignore :orgtbl-ignore-sep parameter.
5358 (org-export-data-with-backend
5359 cell
5360 (plist-get info :back-end)
5361 (org-combine-plists info '(:orgtbl-ignore-sep t))))
5362 info)))
5363 `(cond
5364 ,(and hllfmt
5365 `(last-header-p ,(org-table--generic-apply
5366 hllfmt ":hllfmt" nil cells)))
5367 ,(and hlfmt
5368 `(headerp ,(org-table--generic-apply
5369 hlfmt ":hlfmt" nil cells)))
5370 ,(and llfmt
5371 `(lastp ,(org-table--generic-apply
5372 llfmt ":llfmt" nil cells)))
5373 (t
5374 ,(if lfmt (org-table--generic-apply lfmt ":lfmt" nil cells)
5375 `(concat
5376 (cond
5377 ,(and
5378 (or hllstart hllend)
5379 `(last-header-p
5380 (concat
5381 ,(org-table--generic-apply hllstart ":hllstart")
5382 contents
5383 ,(org-table--generic-apply hllend ":hllend"))))
5384 ,(and
5385 (or hlstart hlend)
5386 `(headerp
5387 (concat
5388 ,(org-table--generic-apply hlstart ":hlstart")
5389 contents
5390 ,(org-table--generic-apply hlend ":hlend"))))
5391 ,(and
5392 (or llstart llend)
5393 `(lastp
5394 (concat
5395 ,(org-table--generic-apply llstart ":llstart")
5396 contents
5397 ,(org-table--generic-apply llend ":llend"))))
5398 (t
5399 ,(cond
5400 ((or lstart lend)
5401 `(concat
5402 ,(org-table--generic-apply lstart ":lstart")
5403 contents
5404 ,(org-table--generic-apply lend ":lend")))
5405 (backend
5406 `(org-export-with-backend
5407 ',backend row contents info))
5408 (t 'contents)))))))))))))))
5410 (defun org-table--to-generic-cell (params)
5411 "Return custom table cell transcoder according to PARAMS.
5412 PARAMS is a plist. See `orgtbl-to-generic' for more
5413 information."
5414 (let* ((backend (plist-get params :backend))
5415 (efmt (plist-get params :efmt))
5416 (fmt (plist-get params :fmt))
5417 (hfmt (plist-get params :hfmt))
5418 (sep (plist-get params :sep))
5419 (hsep (plist-get params :hsep)))
5420 `(lambda (cell contents info)
5421 ;; Make sure that contents are exported as Org data when :raw
5422 ;; parameter is non-nil.
5423 ,(when (and backend (plist-get params :raw))
5424 `(setq contents
5425 ;; Since we don't know what are the pseudo object
5426 ;; types defined in backend, we cannot pass them to
5427 ;; `org-element-interpret-data'. As a consequence,
5428 ;; they will be treated as pseudo elements, and will
5429 ;; have newlines appended instead of spaces.
5430 ;; Therefore, we must make sure :post-blank value is
5431 ;; really turned into spaces.
5432 (replace-regexp-in-string
5434 (org-trim
5435 (org-element-interpret-data
5436 (org-element-contents cell))))))
5438 (let ((headerp ,(and (or hfmt hsep)
5439 '(org-export-table-row-in-header-p
5440 (org-export-get-parent-element cell) info)))
5441 (column
5442 ;; Call costly `org-export-table-cell-address' only if
5443 ;; absolutely necessary, i.e., if one
5444 ;; of :fmt :efmt :hfmt has a "plist type" value.
5445 ,(and (cl-some (lambda (v) (integerp (car-safe v)))
5446 (list efmt hfmt fmt))
5447 '(1+ (cdr (org-export-table-cell-address cell info))))))
5448 (when contents
5449 ;; Check if we can apply `:efmt' on CONTENTS.
5450 ,(when efmt
5451 `(when (string-match orgtbl-exp-regexp contents)
5452 (let ((mantissa (match-string 1 contents))
5453 (exponent (match-string 2 contents)))
5454 (setq contents ,(org-table--generic-apply
5455 efmt ":efmt" t 'mantissa 'exponent)))))
5456 ;; Check if we can apply FMT (or HFMT) on CONTENTS.
5457 (cond
5458 ,(and hfmt `(headerp (setq contents ,(org-table--generic-apply
5459 hfmt ":hfmt" t 'contents))))
5460 ,(and fmt `(t (setq contents ,(org-table--generic-apply
5461 fmt ":fmt" t 'contents))))))
5462 ;; If a separator is provided, use it instead of BACKEND's.
5463 ;; Separators are ignored when LFMT (or equivalent) is
5464 ;; provided.
5465 ,(cond
5466 ((or hsep sep)
5467 `(if (or ,(and (not sep) '(not headerp))
5468 (plist-get info :orgtbl-ignore-sep)
5469 (not (org-export-get-next-element cell info)))
5470 ,(if (not backend) 'contents
5471 `(org-export-with-backend ',backend cell contents info))
5472 (concat contents
5473 ,(if (and sep hsep) `(if headerp ,hsep ,sep)
5474 (or hsep sep)))))
5475 (backend `(org-export-with-backend ',backend cell contents info))
5476 (t 'contents))))))
5478 ;;;###autoload
5479 (defun orgtbl-to-tsv (table params)
5480 "Convert the orgtbl-mode table to TAB separated material."
5483 ;;;###autoload
5484 (defun orgtbl-to-csv (table params)
5485 "Convert the orgtbl-mode table to CSV material.
5486 This does take care of the proper quoting of fields with comma or quotes."
5487 (orgtbl-to-generic table
5488 (org-combine-plists '(:sep "," :fmt org-quote-csv-field)
5489 params)))
5491 ;;;###autoload
5492 (defun orgtbl-to-latex (table params)
5493 "Convert the orgtbl-mode TABLE to LaTeX.
5495 TABLE is a list, each entry either the symbol `hline' for
5496 a horizontal separator line, or a list of fields for that line.
5497 PARAMS is a property list of parameters that can influence the
5498 conversion. All parameters from `orgtbl-to-generic' are
5499 supported. It is also possible to use the following ones:
5501 :booktabs
5505 :environment
5507 Specify environment to use, as a string. If you use
5509 as a string, to get proper continuation strings."
5510 (require 'ox-latex)
5511 (orgtbl-to-generic
5512 table
5513 (org-combine-plists
5514 ;; Provide sane default values.
5515 (list :backend 'latex
5516 :latex-default-table-mode 'table
5517 :latex-tables-centered nil
5518 :latex-tables-booktabs (plist-get params :booktabs)
5519 :latex-table-scientific-notation nil
5520 :latex-default-table-environment
5521 (or (plist-get params :environment) "tabular"))
5522 params)))
5524 ;;;###autoload
5525 (defun orgtbl-to-html (table params)
5526 "Convert the orgtbl-mode TABLE to HTML.
5528 TABLE is a list, each entry either the symbol `hline' for
5529 a horizontal separator line, or a list of fields for that line.
5530 PARAMS is a property list of parameters that can influence the
5531 conversion. All parameters from `orgtbl-to-generic' are
5532 supported. It is also possible to use the following one:
5534 :attributes
5536 Attributes and values, as a plist, which will be used in
5537 <table> tag."
5538 (require 'ox-html)
5539 (orgtbl-to-generic
5540 table
5541 (org-combine-plists
5542 ;; Provide sane default values.
5543 (list :backend 'html
5544 :html-table-data-tags '("<td%s>" . "</td>")
5545 :html-table-use-header-tags-for-first-column nil
5546 :html-table-align-individual-fields t
5547 :html-table-row-tags '("<tr>" . "</tr>")
5548 :html-table-attributes
5549 (if (plist-member params :attributes)
5550 (plist-get params :attributes)
5551 '(:border "2" :cellspacing "0" :cellpadding "6" :rules "groups"
5552 :frame "hsides")))
5553 params)))
5555 ;;;###autoload
5556 (defun orgtbl-to-texinfo (table params)
5557 "Convert the orgtbl-mode TABLE to Texinfo.
5559 TABLE is a list, each entry either the symbol `hline' for
5560 a horizontal separator line, or a list of fields for that line.
5561 PARAMS is a property list of parameters that can influence the
5562 conversion. All parameters from `orgtbl-to-generic' are
5563 supported. It is also possible to use the following one:
5565 :columns
5567 Column widths, as a string. When providing column fractions,
5569 (require 'ox-texinfo)
5570 (let ((output
5571 (orgtbl-to-generic
5572 table
5573 (org-combine-plists
5574 (list :backend 'texinfo
5575 :texinfo-tables-verbatim nil
5576 :texinfo-table-scientific-notation nil)
5577 params)))
5578 (columns (let ((w (plist-get params :columns)))
5579 (cond ((not w) nil)
5581 (t (concat "@columnfractions " w))))))
5582 (if (not columns) output
5583 (replace-regexp-in-string
5586 ;;;###autoload
5587 (defun orgtbl-to-orgtbl (table params)
5588 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
5590 TABLE is a list, each entry either the symbol `hline' for
5591 a horizontal separator line, or a list of fields for that line.
5592 PARAMS is a property list of parameters that can influence the
5593 conversion. All parameters from `orgtbl-to-generic' are
5594 supported.
5596 Useful when slicing one table into many. The :hline, :sep,
5597 :lstart, and :lend provide orgtbl framing. :tstart and :tend can
5598 be set to provide ORGTBL directives for the generated table."
5599 (require 'ox-org)
5600 (orgtbl-to-generic table (org-combine-plists params (list :backend 'org))))
5602 (defun orgtbl-to-table.el (table params)
5603 "Convert the orgtbl-mode TABLE into a table.el table.
5604 TABLE is a list, each entry either the symbol `hline' for
5605 a horizontal separator line, or a list of fields for that line.
5606 PARAMS is a property list of parameters that can influence the
5607 conversion. All parameters from `orgtbl-to-generic' are
5608 supported."
5609 (with-temp-buffer
5610 (insert (orgtbl-to-orgtbl table params))
5611 (org-table-align)
5612 (replace-regexp-in-string
5613 "-|" "-+"
5614 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
5616 (defun orgtbl-to-unicode (table params)
5617 "Convert the orgtbl-mode TABLE into a table with unicode characters.
5619 TABLE is a list, each entry either the symbol `hline' for
5620 a horizontal separator line, or a list of fields for that line.
5621 PARAMS is a property list of parameters that can influence the
5622 conversion. All parameters from `orgtbl-to-generic' are
5623 supported. It is also possible to use the following ones:
5625 :ascii-art
5628 the table. You can download it here:
5629 http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el.
5631 :narrow
5633 When non-nil, narrow columns width than provided width cookie,
5635 (require 'ox-ascii)
5636 (orgtbl-to-generic
5637 table
5638 (org-combine-plists
5639 (list :backend 'ascii
5640 :ascii-charset 'utf-8
5641 :ascii-table-widen-columns (not (plist-get params :narrow))
5642 :ascii-table-use-ascii-art (plist-get params :ascii-art))
5643 params)))
5645 ;; Put the cursor in a column containing numerical values
5646 ;; of an Org table,
5647 ;; type C-c " a
5648 ;; A new column is added with a bar plot.
5649 ;; When the table is refreshed (C-u C-c *),
5650 ;; the plot is updated to reflect the new values.
5652 (defun orgtbl-ascii-draw (value min max &optional width characters)
5653 "Draw an ascii bar in a table.
5654 VALUE is the value to plot, it determines the width of the bar to draw.
5655 MIN is the value that will be displayed as empty (zero width bar).
5656 MAX is the value that will draw a bar filling all the WIDTH.
5657 WIDTH is the span in characters from MIN to MAX.
5658 CHARACTERS is a string that will compose the bar, with shades of grey
5659 from pure white to pure black. It defaults to a 10 characters string
5660 of regular ascii characters."
5661 (let* ((width (ceiling (or width 12)))
5662 (characters (or characters " .:;c!lhVHW"))
5663 (len (1- (length characters)))
5664 (value (float (if (numberp value)
5665 value (string-to-number value))))
5666 (relative (/ (- value min) (- max min)))
5667 (steps (round (* relative width len))))
5668 (cond ((< steps 0) "too small")
5669 ((> steps (* width len)) "too large")
5670 (t (let* ((int-division (/ steps len))
5671 (remainder (- steps (* int-division len))))
5672 (concat (make-string int-division (elt characters len))
5673 (string (elt characters remainder))))))))
5675 ;;;###autoload
5676 (defun orgtbl-ascii-plot (&optional ask)
5677 "Draw an ASCII bar plot in a column.
5679 With cursor in a column containing numerical values, this function
5680 will draw a plot in a new column.
5682 ASK, if given, is a numeric prefix to override the default 12
5684 prefix,
5685 which will prompt for the width."
5686 (interactive "P")
5687 (let ((col (org-table-current-column))
5688 (min 1e999) ; 1e999 will be converted to infinity
5689 (max -1e999) ; which is the desired result
5690 (table (org-table-to-lisp))
5691 (length
5692 (cond ((consp ask)
5693 (read-number "Length of column " 12))
5694 ((numberp ask) ask)
5695 (t 12))))
5696 ;; Skip any hline a the top of table.
5697 (while (eq (car table) 'hline) (setq table (cdr table)))
5698 ;; Skip table header if any.
5699 (dolist (x (or (cdr (memq 'hline table)) table))
5700 (when (consp x)
5701 (setq x (nth (1- col) x))
5702 (when (string-match
5704 x)
5705 (setq x (string-to-number x))
5706 (when (> min x) (setq min x))
5707 (when (< max x) (setq max x)))))
5708 (org-table-insert-column)
5709 (org-table-move-column-right)
5710 (org-table-store-formulas
5711 (cons
5712 (cons
5713 (concat "$" (number-to-string (1+ col)))
5714 (format "'(%s $%s %s %s %s)"
5715 "orgtbl-ascii-draw" col min max length))
5716 (org-table-get-stored-formulas)))
5717 (org-table-recalculate t)))
5719 ;; Example of extension: unicode characters
5720 ;; Here are two examples of different styles.
5722 ;; Unicode block characters are used to give a smooth effect.
5723 ;; See http://en.wikipedia.org/wiki/Block_Elements
5724 ;; Use one of those drawing functions
5725 ;; - orgtbl-ascii-draw (the default ascii)
5726 ;; - orgtbl-uc-draw-grid (unicode with a grid effect)
5727 ;; - orgtbl-uc-draw-cont (smooth unicode)
5729 ;; This is best viewed with the "DejaVu Sans Mono" font
5730 ;; (use M-x set-default-font).
5732 (defun orgtbl-uc-draw-grid (value min max &optional width)
5733 "Draw a bar in a table using block unicode characters.
5734 It is a variant of orgtbl-ascii-draw with Unicode block
5735 characters, for a smooth display. Bars appear as grids (to the
5736 extent the font allows)."
5737 ;; http://en.wikipedia.org/wiki/Block_Elements
5738 ;; best viewed with the "DejaVu Sans Mono" font.
5739 (orgtbl-ascii-draw value min max width
5742 (defun orgtbl-uc-draw-cont (value min max &optional width)
5743 "Draw a bar in a table using block unicode characters.
5744 It is a variant of orgtbl-ascii-draw with Unicode block
5745 characters, for a smooth display. Bars are solid (to the extent
5746 the font allows)."
5747 (orgtbl-ascii-draw value min max width
5750 (defun org-table-get-remote-range (name-or-id form)
5751 "Get a field value or a list of values in a range from table at ID.
5753 NAME-OR-ID may be the name of a table in the current file as set
5755 will then be used. Alternatively, it may be an ID referring to
5756 any entry, also in a different file. In this case, the first
5757 table in that entry will be referenced.
5761 The return value is either a single string for a single field, or a
5762 list of the fields in the rectangle."
5763 (save-match-data
5764 (let ((case-fold-search t) (id-loc nil)
5765 ;; Protect a bunch of variables from being overwritten by
5766 ;; the context of the remote table.
5767 org-table-column-names org-table-column-name-regexp
5768 org-table-local-parameters org-table-named-field-locations
5769 org-table-current-line-types
5770 org-table-current-begin-pos org-table-dlines
5771 org-table-current-ncol
5772 org-table-hlines
5773 org-table-last-column-widths
5774 org-table-last-alignment
5775 buffer loc)
5776 (setq form (org-table-convert-refs-to-rc form))
5777 (org-with-wide-buffer
5778 (goto-char (point-min))
5779 (if (re-search-forward
5782 nil t)
5783 (setq buffer (current-buffer) loc (match-beginning 0))
5784 (setq id-loc (org-id-find name-or-id 'marker))
5785 (unless (and id-loc (markerp id-loc))
5787 (setq buffer (marker-buffer id-loc)
5788 loc (marker-position id-loc))
5789 (move-marker id-loc nil))
5790 (with-current-buffer buffer
5791 (org-with-wide-buffer
5792 (goto-char loc)
5793 (forward-char 1)
5795 (not (match-beginning 1)))
5796 (user-error "Cannot find a table at NAME or ID %s" name-or-id))
5797 (org-table-analyze)
5798 (setq form (org-table-formula-substitute-names
5799 (org-table-formula-handle-first/last-rc form)))
5800 (if (and (string-match org-table-range-regexp form)
5801 (> (length (match-string 0 form)) 1))
5802 (org-table-get-range
5803 (match-string 0 form) org-table-current-begin-pos 1)
5804 form)))))))
5806 (defun org-table-remote-reference-indirection (form)
5807 "Return formula with table remote references substituted by indirection.
5809 This indirection works only with the format @ROW$COLUMN. The
5811 distinguished from a plain table name or ID."
5812 (let ((regexp
5813 ;; Same as in `org-table-eval-formula'.
5815 ;; Allow "$1", "@<", "$-1", "@<<$1" etc.
5818 (replace-regexp-in-string
5819 regexp
5820 (lambda (m)
5821 (save-match-data
5822 (let ((eq (org-table-formula-handle-first/last-rc (match-string 1 m))))
5823 (org-table-get-range
5825 (concat "@0" eq)
5826 eq)))))
5827 form t t 1)))
5829 (defmacro org-define-lookup-function (mode)
5830 (let ((mode-str (symbol-name mode))
5831 (first-p (eq mode 'first))
5832 (all-p (eq mode 'all)))
5833 (let ((plural-str (if all-p "s" "")))
5834 `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
5835 ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
5836 If R-LIST is nil, return matching element%s of S-LIST.
5837 If PREDICATE is not nil, use it instead of `equal' to match VAL.
5838 Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
5839 This function is generated by a call to the macro `org-define-lookup-function'."
5840 mode-str plural-str plural-str plural-str)
5841 (let ,(let ((lvars '((p (or predicate 'equal))
5842 (sl s-list)
5843 (rl (or r-list s-list))
5844 (ret nil))))
5845 (if first-p (cons '(match-p nil) lvars) lvars))
5846 (while ,(if first-p '(and (not match-p) sl) 'sl)
5847 (when (funcall p val (car sl))
5848 ,(when first-p '(setq match-p t))
5849 (let ((rval (car rl)))
5850 (setq ret ,(if all-p '(append ret (list rval)) 'rval))))
5851 (setq sl (cdr sl) rl (cdr rl)))
5852 ret)))))
5854 (org-define-lookup-function first)
5855 (org-define-lookup-function last)
5856 (org-define-lookup-function all)
5858 (provide 'org-table)
5860 ;; Local variables:
5861 ;; generated-autoload-file: "org-loaddefs.el"
5862 ;; End:
5864 ;;; org-table.el ends here