| blob | 1f7a69e16e7bb511b4eac7b0b6c6960cffad59c8 |
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
508 "Save current field; execute BODY; restore field.
509 Field is restored even in case of abnormal exit."
521 "Expand all columns before executing BODY, then shrink them again."
534 ;;;###autoload
536 "Use the table.el package to insert a new table.
537 If there is already a table at point, convert between Org tables
538 and table.el tables."
551 ;;;###autoload
553 "Convert region to table, or create an empty table.
554 If there is an active region, convert it to a table, using the function
555 `org-table-convert-region'. See the documentation of that function
556 to learn how the prefix argument is interpreted to determine the field
557 separator.
558 If there is no such region, create an empty table with `org-table-create'."
564 ;;;###autoload
566 "Query for a size and insert a table skeleton.
586 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
590 ;; Insert a hline after the first row.
597 ;;;###autoload
599 "Convert region to a table.
601 The region goes from BEG0 to END0, but these borders will be moved
602 slightly, to make sure a beginning of line in the first line is included.
604 SEPARATOR specifies the field separator in the lines. It can have the
605 following values:
607 (4) Use the comma as a field separator
608 (16) Use a TAB as field separator
609 (64) Prompt for a regular expression as field separator
610 integer When a number, use that many spaces, or a TAB, as field separator
611 regexp When a regular expression, use it to match the separator
612 nil When nil, the command tries to be smart and figure out the
613 separator in the following way:
614 - when each line contains a TAB, assume TAB-separated material
615 - when each line contains a comma, assume CSV material
616 - else, assume one or more SPACE characters as separator."
620 re)
622 (user-error "Region is longer than `org-table-convert-region-max-lines' (%s) lines; not converting"
623 org-table-convert-region-max-lines)
632 ;; Get the right field separator
643 ;; parse the csv stuff
668 ;;;###autoload
670 "Import FILE as a table.
671 The file is assumed to be tab-separated. Such files can be produced by most
672 spreadsheet and database applications. If no tabs (at least one per line)
673 are found, lines will be split on whitespace into fields."
682 ;;;###autoload
684 "Export table to a file, with configurable format.
685 Such a file can be imported into usual spreadsheet programs.
687 FILE can be the output file name. If not given, it will be taken
688 from a TABLE_EXPORT_FILE property in the current entry or higher
689 up in the hierarchy, or the user will be prompted for a file
690 name. FORMAT can be an export format, of the same kind as it
691 used when `orgtbl-mode' sends a table in a different format.
693 The command suggests a format depending on TABLE_EXPORT_FORMAT,
694 whether it is set locally or up in the hierarchy, then on the
695 extension of the given file name, and finally on the variable
696 `org-table-export-default-format'."
729 formats)))
730 org-table-export-default-format)
756 "Marker at the beginning of the table last aligned.
759 "Marker at the end of the table last aligned.
762 "List of flags for flushright alignment, from the last re-alignment.
765 "List of max width of fields in each column.
768 "Non-nil means debug table formulas.
776 "Format FIELD according to column WIDTH and alignement ALIGN.
787 ;;;###autoload
789 "Align the table at point by aligning all vertical bars."
794 ;; Make sure invisible characters in the table are at the right
795 ;; place since column widths take them into account.
805 end t)))
806 ;; Table's rows as lists of fields. Rules are replaced
807 ;; by nil. Trailing spaces are removed.
813 ;; Compute number of columns. If the table contains no
814 ;; field, create a default table and bail out.
822 ;; Compute alignment and width for each column.
825 fields))
827 ;; Store the maximum width for the column.
829 ;; If there is no alignment cookie get the fraction of
830 ;; numbers among non-empty cells to decide about alignment
831 ;; of the column.
839 column)))
850 alignments)))
853 ;; Store alignment of this table, for later editing of single
854 ;; fields.
857 ;; Build new table rows. Only replace rows that actually
858 ;; changed.
863 indent
866 widths
875 cells
876 widths
877 alignments)
887 ;;;###autoload
889 "Find the beginning of the table and return its position.
890 With a non-nil optional argument TABLE-TYPE, return the beginning
891 of a table.el-type table. This function assumes point is on
892 a table."
900 ;;;###autoload
902 "Find the end of the table and return its position.
903 With a non-nil optional argument TABLE-TYPE, return the end of
904 a table.el-type table. This function assumes point is on
905 a table."
913 ;; When the line right after the table is the last line in
914 ;; the buffer with trailing spaces but no final newline
915 ;; character, be sure to catch the correct ending at its
916 ;; beginning. In any other case, ending is expected to be
917 ;; at point max.
922 ;;;###autoload
924 "Justify the current field, text to left, number to right.
925 Optional argument NEW may specify text to replace the current field content."
934 ;; This is not the same table, force a full re-align.
937 ;; Realign the current field, based on previous full realign.
970 ;;;###autoload
972 "Go to the next field in the current table, creating new lines as needed.
973 Before doing so, re-align the table if necessary."
978 org-table-may-need-update)
989 org-table-tab-jumps-over-hlines
1000 ;;;###autoload
1002 "Go to the previous field in the table.
1003 Before doing so, re-align the table if necessary."
1008 org-table-may-need-update)
1026 "Move to the beginning of the current table field.
1027 If already at or before the beginning, move to the beginning of the
1028 previous field.
1029 With numeric argument N, move N-1 fields backward first."
1042 "Move to the end of the current table field.
1043 If already at or after the end, move to the end of the next table field.
1044 With numeric argument N, move N-1 fields forward first."
1057 ;;;###autoload
1059 "Go to the next row (same column) in the current table.
1060 Before doing so, re-align the table if necessary."
1065 org-table-may-need-update)
1077 ;;;###autoload
1079 "Copy the value of the current field one row below.
1081 If the field at the cursor is empty, copy the content of the
1082 nearest non-empty field above. With argument N, use the Nth
1083 non-empty field.
1085 If the current field is not empty, it is copied down to the next
1086 row, and the cursor is moved with it. Therefore, repeating this
1087 command causes the column to be filled row-by-row.
1089 If the variable `org-table-copy-increment' is non-nil and the
1090 field is an integer or a timestamp, it will be incremented while
1091 copying. By default, increment by the difference between the
1092 value in the current field and the one in the field above. To
1093 increment using a fixed integer, set `org-table-copy-increment'
1094 to a number. In the case of a timestamp, increment by days."
1106 txt txt-up inc)
1114 beg t))
1124 beg t))
1131 ;; Above field was not empty, go down to the next row
1164 "Is point inside a table data field?
1165 I.e. not on a hline or before the first or after the last column?
1166 This actually throws an error, so it aborts the current command."
1178 "Get the field in table line LINE, column COLUMN.
1179 If LINE is larger than the number of data lines in the table, the function
1180 returns nil. However, if COLUMN is too large, we will simply return an
1181 empty string.
1182 If LINE is nil, use the current line.
1183 If COLUMN is nil, use the current column."
1190 "Put VALUE into line LINE, column COLUMN.
1191 When ALIGN is set, also realign the table."
1200 "Return the index of the current data line."
1207 cnt))
1210 "Go to the Nth data line in the current table.
1211 Return t when the line exists, nil if it does not exist."
1218 ;;;###autoload
1220 "Blank the current table field or active region."
1237 "Return the value of the field in column N of current row.
1238 N defaults to current column. If REPLACE is a string, replace
1239 field with this value. The return value is always the old
1240 value."
1244 ;; Before first column or after last one.
1245 ""
1250 ;; Since we are going to remove any hidden field, do not rely
1251 ;; on `org-table--hidden-field' as it could be GC'ed before
1252 ;; second check.
1261 val)))
1263 ;;;###autoload
1265 "Show info about the current field, and highlight any reference at point."
1275 col)
1276 org-table-named-field-locations)))
1286 ;; Prioritize field formulas over column formulas.
1295 dline col
1297 dline col ref1
1299 ;; FIXME: formula info not correct if special table line
1306 ""
1312 "Find out which column we are in."
1318 column)))
1321 "Find out what table data line we are in.
1322 Only data lines count for this."
1330 c)))
1332 ;;;###autoload
1334 "Move the cursor to the Nth column in the current table line.
1335 With optional argument ON-DELIM, stop with point before the left delimiter
1336 of the field.
1337 If there are less than N fields, just go to after the last delimiter.
1338 However, when FORCE is non-nil, create new columns if necessary."
1348 t)))))
1355 ;;;###autoload
1357 "Insert a new column into the table."
1372 ;; Add missing vertical bar at the end of the row.
1379 ;; Shift appropriately stored shrunk column numbers, then hide the
1380 ;; columns again.
1382 shrunk-columns)
1383 beg end)
1385 ;; Fix TBLFM formulas, if desirable.
1392 "Find a data line in the current table, which is needed for column commands."
1395 t
1406 t
1411 "Turn a buffer line number into a data line number.
1413 If there is no data line in this line, return nil.
1415 If there is no matching dline (most likely the reference was
1416 a hline), the first dline below it is used. When ABOVE is
1417 non-nil, the one above is used."
1422 nil)
1433 ;;;###autoload
1435 "Delete a column from the table."
1449 nil
1456 ;; Shift appropriately stored shrunk column numbers, then hide the
1457 ;; columns again.
1459 shrunk-columns)
1460 beg end)
1462 ;; Fix TBLFM formulas, if desirable.
1470 ;;;###autoload
1472 "Move column to the right."
1476 ;;;###autoload
1478 "Move column to the left."
1482 ;;;###autoload
1484 "Move the current column to the right. With arg LEFT, move to the left."
1512 ;; Shift appropriately stored shrunk column numbers, then shrink
1513 ;; the columns again.
1521 shrunk-columns)
1522 beg end)
1524 ;; Fix TBLFM formulas, if desirable.
1535 ;;;###autoload
1537 "Move table row down."
1541 ;;;###autoload
1543 "Move table row up."
1547 ;;;###autoload
1549 "Move the current table line down. With arg UP, move it up."
1558 hline2p)
1585 ;;;###autoload
1587 "Insert a new row above the current line into the table.
1588 With prefix ARG, insert below the current line."
1594 ;; Fix the first field if necessary
1598 ;; Buffer may not end of a newline character, so ensure
1599 ;; (beginning-of-line 2) moves point to a new line.
1610 ;;;###autoload
1612 "Insert a horizontal-line below the current line into the table.
1613 With prefix ABOVE, insert above the current line."
1634 ;;;###autoload
1636 "Insert a hline and move to the row below that line."
1650 In particular, this does handle wide and invisible characters."
1652 ;; It's a hline, just map the characters
1658 t t s)))
1659 s))
1661 ;;;###autoload
1663 "Delete the current row or horizontal line from the table."
1679 ;;;###autoload
1682 "Sort table lines according to the column at point.
1684 The position of point indicates the column to be used for
1685 sorting, and the range of lines is the range between the nearest
1686 horizontal separator lines, or the entire table of no such lines
1687 exist. If point is before the first column, you will be prompted
1688 for the sorting column. If there is an active region, the mark
1689 specifies the first line and the sorting column, while point
1690 should be in the last line to be included into the sorting.
1692 The command then prompts for the sorting type which can be
1693 alphabetically, numerically, or by time (as given in a time stamp
1694 in the field, or as a HH:MM value). Sorting in reverse order is
1695 also possible.
1697 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1699 If SORTING-TYPE is specified when this function is called from a Lisp
1700 program, no prompting will take place. SORTING-TYPE must be a character,
1701 any of (?a ?A ?n ?N ?t ?T ?f ?F) where the capital letters indicate that
1702 sorting should be done in reverse order.
1704 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
1705 a function to be called to extract the key. It must return a value
1706 that is compatible with COMPARE-FUNC, the function used to compare
1707 entries.
1709 A non-nil value for INTERACTIVE? is used to signal that this
1710 function is being called interactively."
1713 ;; Point must be either within a field or before a data line.
1718 ;; Set appropriate case sensitivity and column used for sorting.
1731 ;; Narrow buffer to appropriate sorting area.
1742 start))
1745 end)))
1746 ;; Determine arguments for `sort-subr'. Also record original
1747 ;; position. `org-table-save-field' cannot help here since
1748 ;; sorting is too much destructive.
1754 ;; Function to be called on the contents of the field
1755 ;; used for sorting in the current row.
1782 "Function for comparing keys (empty for default \
1783 `sort-subr' predicate): "
1793 #'end-of-line
1797 nil
1798 predicate)
1799 ;; Hide all columns but the one being sorted.
1801 ;; Move back to initial field.
1805 ;;;###autoload
1807 "Copy region in table to the clipboard and blank all relevant fields.
1808 If there is no active region, use just the field at point."
1814 ;;;###autoload
1816 "Copy rectangular region in table to clipboard.
1817 A special clipboard is used which can only be accessed
1818 with `org-table-paste-rectangle'."
1822 current-prefix-arg))
1827 region)
1839 ;; Collect every cell between COLUMN-START and COLUMN-END.
1849 ;;;###autoload
1851 "Paste a rectangular region into a table.
1852 The upper right corner ends up in the current field. All involved fields
1853 will be overwritten. If the rectangle does not fit into the present table,
1854 the table is enlarged as needed. The process ignores horizontal separator
1855 lines."
1865 ;; If we left the table, create a new row.
1877 ;;;###autoload
1879 "Convert from `org-mode' table to table.el and back.
1880 Obviously, this only works within limits. When an Org table is converted
1881 to table.el, all horizontal separator lines get lost, because table.el uses
1882 these as cell boundaries and has no notion of horizontal lines. A table.el
1883 table can be converted to an Org table only if it does not do row or column
1884 spanning. Multiline cells will become multiple cells. Beware, Org mode
1885 does not test if the table can be successfully converted - it blindly
1886 applies a recipe that works for simple tables."
1890 ;; convert to Org table
1899 ;; convert to table.el table
1902 ;; first, get rid of all horizontal lines
1906 ;; insert a hline before first
1910 ;; insert a hline after each line
1915 ;; replace "+" at beginning and ending of hlines
1924 "Transpose Org table at point and eliminate hlines.
1925 So a table like
1927 | 1 | 2 | 4 | 5 |
1928 |---+---+---+---|
1929 | a | b | c | d |
1930 | e | f | g | h |
1932 will be transposed as
1934 | 1 | a | e |
1935 | 2 | b | f |
1936 | 4 | c | g |
1937 | 5 | d | h |
1939 Note that horizontal lines disappear."
1951 table)))
1965 ;;;###autoload
1967 "Wrap several fields in a column like a paragraph.
1968 This is useful if you'd like to spread the contents of a field over several
1969 lines, in order to keep the table compact.
1971 If there is an active region, and both point and mark are in the same column,
1972 the text in the column is wrapped to minimum width for the given number of
1973 lines. Generally, this makes the table more compact. A prefix ARG may be
1974 used to change the number of desired lines. For example, \
1976 formats the selected text to two lines. If the region was longer than two
1977 lines, the remaining lines remain empty. A negative prefix argument reduces
1978 the current number of lines by that amount. The wrapped text is pasted back
1979 into the table. If you formatted it to more lines than it was before, fields
1980 further down in the table get overwritten - so you might need to make space in
1981 the table first.
1983 If there is no region, the current field is split at the cursor position and
1984 the text fragment to the right of the cursor is prepended to the field one
1985 line down.
1987 If there is no region, but you specify a prefix ARG, the current field gets
1988 blank, and the content is appended to the field above."
1992 ;; There is a region: fill as a paragraph.
2003 nil
2004 nlines))))
2007 ;; No region, split the current field at point.
2032 ;;;###autoload
2034 "Edit table field in a different window.
2035 This is mainly useful for fields that contain hidden parts.
2038 visible so that it can be edited in place.
2041 toggle `org-table-follow-field-mode'."
2063 p)
2085 "Finish editing a table data field.
2086 Remove all newline characters, insert the result into the table, realign
2087 the table and kill the editing buffer."
2091 text)
2108 "Minor mode to make the table field editor window follow the cursor.
2109 When this mode is active, the field editor window will always show the
2110 current field. The mode exits automatically when the cursor leaves the
2111 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
2112 nil " TblFollow" nil
2128 ;; We have left the table, exit the follow mode
2138 ;;;###autoload
2140 "Sum numbers in region of current table column.
2141 The result will be displayed in the echo area, and will be available
2144 If there is an active region, it is interpreted as a rectangle and all
2145 numbers in that rectangle will be summed. If there is no active
2146 region and point is located in a table column, sum all numbers in that
2147 column.
2149 If at least one number looks like a time HH:MM or HH:MM:SS, all other
2150 numbers are assumed to be times as well (in decimal hours) and the
2151 numbers are added as such.
2153 If NLAST is a number, only the NLAST fields will actually be summed."
2180 items1)))
2187 s diff)
2194 sres))))
2217 "Return the formula active for the current field.
2219 Assumes that table is already analyzed. If KEY is given, return
2220 the key to this formula. Otherwise return the formula preceded
2229 org-table-named-field-locations)))
2243 "Read a formula from the minibuffer, offer stored formula as default.
2244 When NAMED is non-nil, look for a named equation."
2249 org-table-named-field-locations)))
2262 stored)
2264 equation)
2270 scol))
2272 'org-table-formula-history
2273 )))))
2274 mustsave)
2276 ;; remove formula
2283 ;; We set the column equation, delete the named one.
2285 mustsave t))
2291 eq))
2294 "Store the list of formulas below the current table.
2295 If optional argument LOCATION is a buffer position, insert it at
2296 LOCATION instead."
2304 ;; Don't overwrite TBLFM, we might use text properties to
2305 ;; store stuff.
2319 ;; Fake a high number to make sure this is sorted at the end.
2326 a)
2336 "Compare two formulas for sorting."
2341 ;;;###autoload
2343 "Return an alist with the stored formulas directly after current table.
2344 By default, only return active formulas, i.e., formulas located
2345 on the first line after the table. However, if optional argument
2346 LOCATION is a buffer position, consider the formulas there."
2355 eq-alist seen)
2359 string)
2364 ;; Is it a column reference?
2366 ;; Since named columns are not possible in
2367 ;; LHS, assume this is a named field.
2375 "Double definition `%s=' in TBLFM line, please fix by hand"
2376 lhs)
2381 "Double definition `%s=' in TBLFM line, please fix by hand"
2382 lhs)))))))))))
2385 "Modify the equations after the table structure has been edited.
2387 For all numbers larger than LIMIT, shift them by DELTA."
2399 s n a)
2405 "Change makes TBLFM term %s invalid, use undo to recover"
2420 ;;;###autoload
2423 If yes, store the formula and apply it."
2424 ;; We already know we are in a table. Get field will only return a formula
2425 ;; when appropriate. It might return a separator line, but no problem.
2428 named eq)
2436 "List of commands triggering the recalculation of a line.
2448 ;;;###autoload
2450 "Rotate the recalculation mark in the first column.
2451 If in any row, the first field is not consistent with a mark,
2452 insert a new column for the markers.
2453 When there is an active region, change all the lines in the region,
2454 after prompting for the marking character.
2455 After each change, a message will be displayed indicating the meaning
2456 of the new mark."
2472 newchar))
2480 newchar))
2498 ;; Rotate mark in first row.
2500 ;; Rotate marks in additional rows if a region is active.
2508 ;; Only align if rotation actually changed lines' length.
2518 ;;;###autoload
2520 "Analyze table at point and store results.
2522 This function sets up the following dynamically scoped variables:
2524 `org-table-column-name-regexp',
2525 `org-table-column-names',
2526 `org-table-current-begin-pos',
2527 `org-table-current-line-types',
2528 `org-table-current-ncol',
2529 `org-table-dlines',
2530 `org-table-hlines',
2531 `org-table-local-parameters',
2532 `org-table-named-field-locations'."
2537 ;; Extract column names.
2550 ;; Extract local parameters.
2558 org-table-local-parameters)))))
2559 ;; Update named fields locations. We minimize `count-lines'
2560 ;; processing by storing last known number of lines in LAST.
2582 field))
2585 org-table-named-field-locations))))))))))
2586 ;; Re-use existing markers when possible.
2590 ;; Analyze the line types.
2601 ;; Get the number of columns from the first data line in table.
2609 al al2)
2623 "Move point to a specific field in the current table.
2625 REF is either the name of a field its absolute reference, as
2626 a string. No column is created unless CREATE-COLUMN-P is
2627 non-nil. If it is a function, it is called with the column
2628 number as its argument as is used as a predicate to know if the
2629 column can be created.
2631 This function assumes the table is already analyzed (i.e., using
2632 `org-table-analyze')."
2647 create-column-p)))
2653 ;;;###autoload
2655 "Recompute the current line if marked for it, and if we haven't just done it."
2675 org-tbl-calc-modes)
2677 ;;;###autoload
2679 suppress-align suppress-const
2680 suppress-store suppress-analysis)
2681 "Replace the table field value at the cursor by the result of a calculation.
2683 In a table, this command replaces the value in the current field with the
2685 formula, by storing it in a special line below the table. When called
2687 field formula.
2690 insert the active equation for the field
2691 back into the current field, so that it can be edited there. This is \
2692 useful
2694 check the referenced fields.
2696 When called, the command first prompts for a formula, which is read in
2697 the minibuffer. Previously entered formulas are available through the
2698 history list, and the last used formula is offered as a default.
2699 These stored formulas are adapted correctly when moving, inserting, or
2700 deleting columns with the corresponding commands.
2702 The formula can be any algebraic expression understood by the Calc package.
2703 For details, see the Org mode manual.
2705 This function can also be called from Lisp programs and offers
2706 additional arguments: EQUATION can be the formula to apply. If this
2707 argument is given, the user will not be prompted.
2709 SUPPRESS-ALIGN is used to speed-up recursive calls by by-passing
2710 unnecessary aligns.
2712 SUPPRESS-CONST suppresses the interpretation of constants in the
2713 formula, assuming that this has been done already outside the
2714 function.
2716 SUPPRESS-STORE means the formula should not be stored, either
2717 because it is already stored, or because it is a modified
2718 equation that should not overwrite the stored one.
2720 SUPPRESS-ANALYSIS prevents analyzing the table and checking
2721 location of point."
2737 equation
2743 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2744 duration duration-output-format)
2745 ;; Parse the format string. Since we have a lot of modes, this is
2746 ;; a lot of work. However, I think calc still uses most of the time.
2759 'calc-float-format
2762 n))))
2767 duration-output-format
2796 ;; replace fields with duration values if relevant
2800 fields)))
2806 x))
2807 fields)))
2813 ;; Insert row and column number of formula result field
2824 t t form)))
2826 ;; Check for old vertical references
2828 ;; Insert remote references
2841 rmtrng))
2842 keep-empty numbers lispp))
2843 t t form)))
2844 ;; Insert complex ranges
2854 ;; possibly handle durations
2859 formrg)
2860 keep-empty numbers lispp)))
2865 ;; Insert simple ranges, i.e. included in the current row.
2868 form)
2879 keep-empty numbers lispp))
2880 t t form)))
2882 ;; Insert the references to fields in same row
2889 x keep-empty numbers lispp)))
2906 ;; Use <...> time-stamps so that Calc can handle them.
2909 ;; Internationalize local time-stamps by setting locale to
2910 ;; "C".
2913 org-ts-regexp
2921 form t t))
2924 form
2931 duration-output-format)
2932 ev)))
2937 Orig: %s
2938 $xyz-> %s
2939 @r$c-> %s
2962 ;; Replace any active time stamp in the result with
2963 ;; an inactive one. Dates in tables are likely
2964 ;; piece of regular data, not meant to appear in the
2965 ;; agenda.
2978 prop value)))
2981 "Get a calc vector from a column, according to descriptor DESC.
2983 Optional arguments TBEG and COL can give the beginning of the table and
2984 the current column, to avoid unnecessary parsing.
2986 HIGHLIGHT means just highlight the range.
2988 When CORNERS-ONLY is set, only return the corners of the range as
2989 a list (line1 column1 line2 column2) where line1 and line2 are
2990 line numbers relative to beginning of table, or TBEG, and column1
2991 and column2 are table column numbers."
2994 desc))
3005 thisline)))
3010 thisline)))
3022 ;; Just one field.
3029 ;; A range, return a vector. First sort the numbers to get
3030 ;; a regular rectangle.
3036 ;; Copy the range values into a list.
3051 ;; Return string representation of calc vector.
3057 "Return relative line number corresponding to descriptor DESC.
3058 The cursor is currently in relative line number CLINE."
3063 ;; 1 2 3 4 5 6
3064 desc))
3086 cline)))
3089 "Return relative line of Nth row with type TYPE.
3090 Search starts from relative line I. When BACKWARDS in non-nil,
3091 look before I. When RELATIVE is non-nil, the reference is
3092 relative. DESC is the original descriptor that started the
3093 search, as a string."
3101 ;; We are going to cross a hline. Check if this is
3102 ;; an authorized move.
3113 ;; The last hline doesn't exist. Instead, point to last row
3114 ;; in table.
3123 "Convert list ELEMENTS to something appropriate to insert into formula.
3124 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
3125 NUMBERS indicates that everything should be converted to numbers.
3126 LISPP non-nil means to return something appropriate for a Lisp
3127 list, `literal' is for the format specifier L."
3128 ;; Calc nan (not a number) is used for the conversion of the empty
3129 ;; field to a reference for several reasons: (i) It is accepted in a
3130 ;; Calc formula (e. g. "" or "()" would result in a Calc error).
3131 ;; (ii) In a single field (not in range) it can be distinguished
3132 ;; from "(nan)" which is the reference made from a single field
3133 ;; containing "nan".
3135 ;; field reference
3138 elements
3140 ""
3149 ;; range reference
3154 elements))))
3160 x
3168 x)
3170 elements
3174 "If there has been more than one second since T1, display message.
3175 ARGS are passed as arguments to the `message' function. Returns
3176 current time if a message is printed, otherwise returns T1. If
3177 T1 is nil, always messages."
3181 curtime)
3182 t1)))
3184 ;;;###autoload
3186 "Recalculate the current table line by applying all stored formulas.
3188 With prefix arg ALL, do this for all lines in the table.
3191 if ALL is the symbol `iterate',
3192 recompute the table until it no longer changes.
3194 If NOALIGN is not nil, do not re-align the table after the computations
3195 are done. This is typically used internally to save time, if it is
3196 known that the table will be realigned a little later anyway."
3211 beg end eqlcol eqlfield)
3212 ;; Insert constants in all formulas.
3215 ;; Expand equations, then split the equation list between
3216 ;; column formulas and field formulas.
3228 old-lhs)))
3231 existing formula for column %s"
3232 old-lhs
3233 new))
3234 new))
3240 ;; Expand ranges in lhs of formulas
3242 ;; Get the correct line range to process.
3249 ;; This is a table with marked lines, compute selected
3250 ;; lines.
3252 ;; Move forward to the first non-header line.
3257 ;; Just leave BEG at the start of the table.
3262 ;; Mark named fields untouchable. Also check if several
3263 ;; field/range formulas try to set the same field.
3267 seen-fields)
3278 ;; Turn field coordinates associated to NAME
3279 ;; into an absolute reference.
3283 name)))
3286 reference))
3291 ;; Evaluate the column formulas, but skip fields covered by
3292 ;; field formulas.
3296 ;; Unprotected line, recalculate.
3301 log-last-time
3314 ;; Evaluate the field formulas.
3323 reference
3324 ;; Possibly create a new column, as long as
3325 ;; `org-table-formula-create-columns' allows it.
3337 t))
3342 ;; Clean up markers and internal text property.
3353 ;;;###autoload
3355 "Recalculate the table until it does not change anymore.
3356 The maximum number of iterations is 10, but you can choose a different value
3357 with the prefix ARG."
3362 thistbl)
3376 ;;;###autoload
3378 "Recalculate all tables in the current buffer."
3383 ;; Reason for separate `org-table-align': When repeating
3384 ;; (org-table-recalculate t) `org-table-may-need-update' gets in
3385 ;; the way.
3388 t)))
3390 ;;;###autoload
3392 "Iterate all tables in the buffer, to converge inter-table dependencies."
3397 c1)
3413 "Apply the #+TBLFM in the line at point to the table."
3420 ;; Insert a temporary formula at right after the table
3425 ;; Recalculate the table.
3430 ;; Delete the formula inserted temporarily.
3436 "Find the beginning of the TBLFM lines and return its position.
3437 Return nil when the beginning of TBLFM line was not found."
3444 "Expand list of formulas.
3445 If some of the RHS in the formulas are ranges or a row reference,
3446 expand them to individual field equations for each field. This
3447 function assumes the table is already analyzed (i.e., using
3448 `org-table-analyze')."
3455 ;; This just refers to one fixed field.
3458 ;; This just refers to one fixed named field.
3461 ;; Column formulas are treated specially and are not
3462 ;; expanded.
3467 rhs)
3468 res)))
3480 rhs)
3481 res))))))))))
3484 "Replace @<, @>, $<, $> with first/last row/column of the table.
3485 So @< and $< will always be replaced with @1 and $1, respectively.
3486 The advantage of these special markers are that structure editing of
3487 the table will not change them, while @1 and $1 will be modified
3488 when a line/row is swapped out of that privileged position. So for
3489 formulas that use a range of rows or columns, it may often be better
3491 borders of the table using the @< @> $< $> makers."
3494 s start)
3499 org-table-current-ncol)
3503 len
3510 s)
3513 "Replace $const with values in string F."
3518 org-table-column-name-regexp
3521 org-table-column-names))))
3522 f t t)))
3523 ;; Parameters and constants.
3527 new start))
3530 ;; When a duration is expected, convert value on the fly.
3536 v)))))
3543 "Find the value for a parameter or constant in a formula.
3544 Parameters get priority."
3575 map))
3582 "--"
3585 "--"
3586 "Shift Reference at Point"
3591 "-"
3592 "Change Test Row for Column Formulas"
3595 "--"
3600 org-table-overlay-coordinates)]
3601 "--"
3609 ;;;###autoload
3611 "Edit the formulas of the current table in a separate buffer."
3617 ;; Move point within the table before analyzing it.
3633 ;; Keep global-font-lock-mode from turning on font-lock-mode
3678 "Convert a formula from internal to user representation."
3681 s))
3684 "Convert a formula from user to internal representation."
3687 s))
3690 "Convert spreadsheet references from A7 to @7$28.
3691 Works for single references, but also for entire formulas and even the
3692 full TBLFM line."
3694 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3697 ;; format match, just advance
3702 ;; 3.e5 or something like this.
3705 ;; (member (match-string 1 s)
3706 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3707 )
3708 ;; function name, just advance
3718 t t s)))))
3719 s))
3722 "Convert spreadsheet references from to @7$28 to AB7.
3723 Works for single references, but also for entire formulas and even the
3724 full TBLFM line."
3731 t t s)))
3736 t nil s)))
3737 s)
3740 "Convert a base 26 number represented by letters into an integer.
3741 For example: AB -> 28."
3747 n))
3750 "Convert an integer into a base 26 number represented by letters.
3751 For example: 28 -> AB."
3756 s))
3759 "Convert a time string into numerical duration in seconds.
3760 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3761 If S is a string representing a number, keep this number."
3763 s
3786 "Convert a number of seconds to a time string.
3787 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3788 minutes or seconds."
3800 ;; Ignore seconds
3804 secs0)
3809 secs0)))))
3813 \f
3814 ;;; Columns shrinking
3817 "Non-nil if current field is narrowed.
3818 When non-nil, return the overlay narrowing the field."
3821 o))
3825 "List currently shrunk columns in table at point."
3827 ;; We really check shrunk columns in current row only. It could
3828 ;; be wrong if all rows do not contain the same number of columns
3829 ;; (i.e. the table is not properly aligned). As a consequence,
3830 ;; some columns may not be shrunk again upon aligning the table.
3831 ;;
3832 ;; For example, in the following table, cursor is on first row and
3833 ;; "<>" indicates a shrunk column.
3834 ;;
3835 ;; | |
3836 ;; | | <> |
3837 ;;
3838 ;; Aligning table from the first row will not shrink again the
3839 ;; second row, which was not visible initially.
3840 ;;
3841 ;; However, fixing it requires to check every row, which may be
3842 ;; slow on large tables. Moreover, the hindrance of this
3843 ;; pathological case is very limited.
3856 "Shrink a table field to a specified width.
3858 WIDTH is an integer representing the number of characters to
3859 display, in addition to `org-table-shrunk-column-indicator'. START
3860 and END are, respectively, the beginning and ending positions of
3861 the field. CONTENTS is its trimmed contents, as a string, or
3862 `hline' for table rules.
3864 Real field is hidden under an overlay. The latter has the
3865 following properties:
3867 `org-overlay-type'
3869 Set to `table-column-hide'. Used to identify overlays
3870 responsible for the task.
3872 `org-table-column-overlays'
3874 It is a list with the pattern (siblings . COLUMN-OVERLAYS)
3875 where COLUMN-OVERLAYS is the list of all overlays hiding the
3876 same column.
3878 Whenever the text behind or next to the overlay is modified, all
3879 the overlays in the column are deleted, effectively displaying
3880 the column again.
3882 Return overlay used to hide the field."
3889 org-table-shrunk-column-indicator))
3891 ;; Remove invisible parts from links in CONTENTS. Since
3892 ;; shrinking could happen before first fontification
3893 ;; (e.g., using a #+STARTUP keyword), this cannot be done
3894 ;; using text properties.
3898 ;; Expand field.
3900 contents
3902 org-table-shrunk-column-indicator)
3903 ;; Truncate field.
3906 org-table-shrunk-column-indicator))))))
3909 ;; Removing one overlay removes all other overlays
3910 ;; in the same column.
3919 ;; Make sure overlays stays on top of table coordinates
3920 ;; overlays. See `org-table-overlay-coordinates'.
3923 o)))
3926 "Read column selection select as a list of numbers.
3928 SELECT is a string containing column ranges, separated by white
3929 space characters, see `org-table-hide-column' for details. MAX
3930 is the maximum column number.
3932 Return value is a sorted list of numbers. Ignore any number
3933 outside of the [1;MAX] range."
3950 max))))
3953 #'<)))
3956 "Shrink COLUMNS in an Org table.
3957 COLUMNS is a sorted list of column numbers. BEG and END are,
3958 respectively, the beginning position and the end position of the
3959 table."
3970 ;; Move to COLUMN.
3975 ;; Extract boundaries and contents from current field.
3976 ;; Also set the column's width if we encounter a width
3977 ;; cookie for the first time.
3991 ;; Link overlay to the other overlays in the same column.
3998 ;;;###autoload
4000 "Shrink or expand current column in an Org table.
4002 If a width cookie specifies a width W for the column, the first
4003 W visible characters are displayed. Otherwise, the column is
4004 shrunk to a single character.
4006 When point is before the first column or after the last one, ask
4007 for the columns to shrink or expand, as a list of ranges.
4008 A column range can be one of the following patterns:
4010 N column N only
4011 N-M every column between N and M (both inclusive)
4012 N- every column between N (inclusive) and the last column
4013 -M every column between the first one and M (inclusive)
4014 - every column
4016 When optional argument ARG is a string, use it as white space
4017 separated list of column ranges.
4020 `org-table-shrink', i.e.,
4021 shrink columns with a width cookie and expand the others.
4024 prefix, expand all columns."
4030 ;; Compute an upper bound for the number of columns.
4031 ;; Nonexistent columns are ignored anyway.
4036 (`nil
4040 ;; Point is either before first column or past last
4041 ;; one. Ask for columns to operate on.
4044 max-columns)
4045 ;; Find current column, even when on a hline.
4062 ;; Move before overlay if point is under it.
4066 ;;;###autoload
4068 "Shrink all columns with a width cookie in the table at point.
4070 Columns without a width cookie are expanded.
4072 Optional arguments BEGIN and END, when non-nil, specify the
4073 beginning and end position of the current table."
4086 ;; Make sure invisible characters in the table are at the right
4087 ;; place since column widths take them into account.
4091 ;;;###autoload
4093 "Expand all columns in the table at point.
4094 Optional arguments BEGIN and END, when non-nil, specify the
4095 beginning and end position of the current table."
4104 \f
4105 ;;; Formula editing
4108 "Convert all references in this buffer, using FUNCTION."
4119 "Convert all references in the buffer from B3 to @3$2 and back."
4129 "Shift the reference at point one row/hline up."
4133 "Shift the reference at point one row/hline down."
4137 "Shift the reference at point one field to the left."
4141 "Shift the reference at point one field to the right."
4152 ;; A B3-like reference
4158 ;; An internal reference
4164 "Re-match the group N, and replace it with the shifted reference."
4169 t t)))
4172 "Shift a reference part REF.
4173 If DECR is set, decrease the references row/column, else increase.
4174 If HLINE is set, this may be a hline reference, it certainly is not
4175 a translation reference."
4204 "Toggle the display of coordinates in the referenced table."
4213 "Parse the buffer for formula definitions and install them.
4214 With prefix ARG, apply the new formulas to the table."
4223 eql)
4226 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
4227 nil t)
4248 "Abort editing formulas, without installing the changes."
4259 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
4300 "Show the location/value of the $ expression at point.
4301 When LOCAL is non-nil, show references for the table at point."
4311 var name e what match dest)
4315 "$1.."
4367 dest)
4393 ;; Column number.
4419 org-table-fedit-scroll-down))))
4431 "Make sure the cursor is in a dataline in a table."
4440 p1 p2)))
4445 "Move cursor one line up in the window showing the table."
4450 "Move cursor one line down in the window showing the table."
4455 "Move the cursor in the window showing the table.
4456 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
4481 "Add a new overlay."
4487 "Highlight rectangular region in a table.
4488 When buffer positions BEG and END are provided, use them to
4489 delimit the region to highlight. Otherwise, refer to point. Use
4490 FACE, when non-nil, for the highlight."
4522 "Remove the rectangle overlays."
4532 "Add overlays to the table at point, to show row/column coordinates."
4560 ;;;###autoload
4562 "Toggle the display of Row/Column numbers in tables."
4573 ;;;###autoload
4575 "Toggle the formula debugger in tables."
4581 ;;; The orgtbl minor mode
4583 ;; Define a minor mode which can be used in other modes in order to
4584 ;; integrate the Org table editor.
4586 ;; This is really a hack, because the Org table editor uses several
4587 ;; keys which normally belong to the major mode, for example the TAB
4588 ;; and RET keys. Here is how it works: The minor mode defines all the
4589 ;; keys necessary to operate the table editor, but wraps the commands
4590 ;; into a function which tests if the cursor is currently inside
4591 ;; a table. If that is the case, the table editor command is
4592 ;; executed. However, when any of those keys is used outside a table,
4593 ;; the function uses `key-binding' to look up if the key has an
4594 ;; associated command in another currently active keymap (minor modes,
4595 ;; major mode, global), and executes that command. There might be
4596 ;; problems if any of the keys used by the table editor is otherwise
4597 ;; used as a prefix key.
4599 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
4600 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
4601 ;; addresses this by checking explicitly for both bindings.
4603 ;; The optimized version (see variable `orgtbl-optimized') takes over
4604 ;; all keys which are bound to `self-insert-command' in the *global map*.
4605 ;; Some modes bind other commands to simple characters, for example
4606 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
4607 ;; active, this binding is ignored inside tables and replaced with a
4608 ;; modified self-insert.
4626 ;; Install it as a minor mode.
4630 ;;;###autoload
4632 "The `org-mode' table editor as a minor mode for use in other modes."
4637 ;; Exit without error, in case some hook functions calls this
4638 ;; by accident in org-mode.
4642 ;; Make sure we are first in minor-mode-map-alist
4644 ;; FIXME: maybe it should use emulation-mode-map-alists?
4651 auto-fill-inhibit-regexp)
4655 auto-fill-inhibit-regexp)
4656 orgtbl-line-start-regexp))
4671 "Create a function for binding in the table minor mode.
4672 FUN is the command to call inside a table. N is used to create a unique
4673 command name. KEYS are keys that should be checked in for a command
4674 to execute outside of tables."
4680 "Outside of tables, run the binding of `"
4692 keys)
4696 "Error when there is no default binding for a table key."
4701 "Setup orgtbl keymaps."
4732 elt key fun cmd)
4740 ;; Special treatment needed for TAB, RET and DEL
4753 (orgtbl-make-binding 'org-delete-backward-char 109
4759 [(tab)] "\C-i"))
4761 (org-defkey orgtbl-mode-map [backtab]
4763 [backtab] [S-iso-lefttab] [(shift tab)]
4764 [(tab)] "\C-i"))
4766 (org-defkey orgtbl-mode-map "\M-\C-m"
4767 (orgtbl-make-binding 'org-table-wrap-region 105
4768 "\M-\C-m" [(meta return)]))
4769 (org-defkey orgtbl-mode-map [(meta return)]
4770 (orgtbl-make-binding 'org-table-wrap-region 106
4771 [(meta return)] "\M-\C-m"))
4773 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4774 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4776 (when orgtbl-optimized
4777 ;; If the user wants maximum table support, we need to hijack
4778 ;; some standard editing functions
4779 (org-remap orgtbl-mode-map
4780 'self-insert-command 'orgtbl-self-insert-command
4781 'delete-char 'org-delete-char
4782 'delete-backward-char 'org-delete-backward-char)
4783 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4784 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4785 '("OrgTbl"
4786 ["Create or convert" org-table-create-or-convert-from-region
4787 :active (not (org-at-table-p)) :keys "C-c |" ]
4788 "--"
4789 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4790 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4791 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4792 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4793 "--"
4794 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4795 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4796 ["Copy Field from Above"
4797 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4798 "--"
4799 ("Column"
4800 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4801 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4802 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4803 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4804 ("Row"
4805 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4806 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4807 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4808 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4809 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4810 "--"
4811 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4812 ("Rectangle"
4813 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4814 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4815 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4816 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4817 "--"
4818 ("Radio tables"
4819 ["Insert table template" orgtbl-insert-radio-table
4820 (cl-assoc-if #'derived-mode-p orgtbl-radio-table-templates)]
4821 ["Comment/uncomment table" orgtbl-toggle-comment t])
4822 "--"
4823 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4824 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4825 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4826 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4827 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4828 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4829 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4830 ["Sum Column/Rectangle" org-table-sum
4831 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4832 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4833 ["Debug Formulas"
4834 org-table-toggle-formula-debugger :active (org-at-table-p)
4835 :keys "C-c {"
4836 :style toggle :selected org-table-formula-debug]
4837 ["Show Col/Row Numbers"
4838 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4839 :keys "C-c }"
4840 :style toggle :selected org-table-overlay-coordinates]
4841 "--"
4842 ("Plot"
4845 t))
4847 (defun orgtbl-ctrl-c-ctrl-c (arg)
4848 "If the cursor is inside a table, realign the table.
4849 If it is a table to be sent away to a receiver, do it.
4850 With prefix arg, also recompute table."
4851 (interactive "P")
4852 (let ((case-fold-search t) (pos (point)) action)
4853 (save-excursion
4854 (beginning-of-line 1)
4855 (setq action (cond
4859 (cond
4860 ((integerp action)
4861 (goto-char action)
4862 (org-table-maybe-eval-formula)
4863 (if arg
4864 (call-interactively 'org-table-recalculate)
4865 (org-table-maybe-recalculate-line))
4866 (call-interactively 'org-table-align)
4867 (when (orgtbl-send-table 'maybe)
4868 (run-hooks 'orgtbl-after-send-table-hook)))
4869 ((eq action 'recalc)
4870 (save-excursion
4871 (beginning-of-line 1)
4873 (if (org-at-table-p)
4874 (org-call-with-arg 'org-table-recalculate t))))
4875 (t (let (orgtbl-mode)
4876 (call-interactively (key-binding "\C-c\C-c")))))))
4878 (defun orgtbl-create-or-convert-from-region (_arg)
4879 "Create table or convert region to table, if no conflicting binding.
4880 This installs the table binding `C-c |', but only if there is no
4881 conflicting binding to this key outside orgtbl-mode."
4882 (interactive "P")
4883 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4884 (if cmd
4885 (call-interactively cmd)
4886 (call-interactively 'org-table-create-or-convert-from-region))))
4888 (defun orgtbl-tab (arg)
4889 "Justification and field motion for `orgtbl-mode'."
4890 (interactive "P")
4891 (if arg (org-table-edit-field t)
4892 (org-table-justify-field-maybe)
4893 (org-table-next-field)))
4895 (defun orgtbl-ret ()
4896 "Justification and field motion for `orgtbl-mode'."
4897 (interactive)
4898 (if (bobp)
4899 (newline)
4900 (org-table-justify-field-maybe)
4901 (org-table-next-row)))
4903 (defun orgtbl-self-insert-command (N)
4904 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4905 If the cursor is in a table looking at whitespace, the whitespace is
4906 overwritten, and the table is not marked as requiring realignment."
4907 (interactive "p")
4908 (if (and (org-at-table-p)
4909 (or
4910 (and org-table-auto-blank-field
4911 (member last-command
4912 '(orgtbl-hijacker-command-100
4913 orgtbl-hijacker-command-101
4914 orgtbl-hijacker-command-102
4915 orgtbl-hijacker-command-103
4916 orgtbl-hijacker-command-104
4917 orgtbl-hijacker-command-105
4918 yas/expand))
4919 (org-table-blank-field))
4920 t)
4921 (eq N 1)
4923 (let (org-table-may-need-update)
4924 (delete-region (match-beginning 1) (match-end 1))
4925 (self-insert-command N))
4926 (setq org-table-may-need-update t)
4927 (let* (orgtbl-mode
4928 a
4929 (cmd (or (key-binding
4930 (or (and (listp function-key-map)
4931 (setq a (assoc last-input-event function-key-map))
4932 (cdr a))
4933 (vector last-input-event)))
4934 'self-insert-command)))
4935 (call-interactively cmd)
4936 (if (and org-self-insert-cluster-for-undo
4937 (eq cmd 'self-insert-command))
4938 (if (not (eq last-command 'orgtbl-self-insert-command))
4939 (setq org-self-insert-command-undo-counter 1)
4940 (if (>= org-self-insert-command-undo-counter 20)
4941 (setq org-self-insert-command-undo-counter 1)
4942 (and (> org-self-insert-command-undo-counter 0)
4943 buffer-undo-list
4944 (not (cadr buffer-undo-list)) ; remove nil entry
4945 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4946 (setq org-self-insert-command-undo-counter
4947 (1+ org-self-insert-command-undo-counter))))))))
4949 ;;;###autoload
4951 "Regular expression matching exponentials as produced by calc.")
4953 (defun orgtbl-gather-send-defs ()
4954 "Gather a plist of :name, :transform, :params for each destination before
4955 a radio table."
4956 (save-excursion
4957 (goto-char (org-table-begin))
4958 (let (rtn)
4959 (beginning-of-line 0)
4960 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4961 (let ((name (org-no-properties (match-string 1)))
4962 (transform (intern (match-string 2)))
4963 (params (if (match-end 3)
4964 (read (concat "(" (match-string 3) ")")))))
4965 (push (list :name name :transform transform :params params)
4966 rtn)
4967 (beginning-of-line 0)))
4968 rtn)))
4970 (defun orgtbl-send-replace-tbl (name text)
4971 "Find and replace table NAME with TEXT."
4972 (save-excursion
4973 (goto-char (point-min))
4974 (let* ((location-flag nil)
4975 (name (regexp-quote name))
4978 (while (re-search-forward begin-re nil t)
4979 (unless location-flag (setq location-flag t))
4980 (let ((beg (line-beginning-position 2)))
4981 (unless (re-search-forward end-re nil t)
4982 (user-error "Cannot find end of receiver location at %d" beg))
4983 (beginning-of-line)
4984 (delete-region beg (point))
4986 (unless location-flag
4987 (user-error "No valid receiver location found in the buffer")))))
4989 ;;;###autoload
4990 (defun org-table-to-lisp (&optional txt)
4991 "Convert the table at point to a Lisp structure.
4992 The structure will be a list. Each item is either the symbol `hline'
4993 for a horizontal separator line, or a list of field values as strings.
4994 The table is taken from the parameter TXT, or from the buffer at point."
4995 (unless (or txt (org-at-table-p)) (user-error "No table at point"))
4996 (let ((txt (or txt
4997 (buffer-substring-no-properties (org-table-begin)
4998 (org-table-end)))))
4999 (mapcar (lambda (x)
5000 (if (string-match org-table-hline-regexp x) 'hline
5004 (defun orgtbl-send-table (&optional maybe)
5005 "Send a transformed version of table at point to the receiver position.
5006 With argument MAYBE, fail quietly if no transformation is defined
5007 for this table."
5008 (interactive)
5009 (catch 'exit
5010 (unless (org-at-table-p) (user-error "Not at a table"))
5011 ;; when non-interactive, we assume align has just happened.
5012 (when (called-interactively-p 'any) (org-table-align))
5013 (let ((dests (orgtbl-gather-send-defs))
5014 (table (org-table-to-lisp
5015 (buffer-substring-no-properties (org-table-begin)
5016 (org-table-end))))
5017 (ntbl 0))
5018 (unless dests
5019 (if maybe (throw 'exit nil)
5020 (user-error "Don't know how to transform this table")))
5021 (dolist (dest dests)
5022 (let ((name (plist-get dest :name))
5023 (transform (plist-get dest :transform))
5024 (params (plist-get dest :params)))
5025 (unless (fboundp transform)
5026 (user-error "No such transformation function %s" transform))
5027 (orgtbl-send-replace-tbl name (funcall transform table params)))
5028 (cl-incf ntbl))
5029 (message "Table converted and installed at %d receiver location%s"
5030 ntbl (if (> ntbl 1) "s" ""))
5031 (and (> ntbl 0) ntbl))))
5033 (defun org-remove-by-index (list indices &optional i0)
5034 "Remove the elements in LIST with indices in INDICES.
5035 First element has index 0, or I0 if given."
5036 (if (not indices)
5037 list
5038 (if (integerp indices) (setq indices (list indices)))
5039 (setq i0 (1- (or i0 0)))
5040 (delq :rm (mapcar (lambda (x)
5041 (setq i0 (1+ i0))
5042 (if (memq i0 indices) :rm x))
5043 list))))
5045 (defun orgtbl-toggle-comment ()
5046 "Comment or uncomment the orgtbl at point."
5047 (interactive)
5048 (let* ((case-fold-search t)
5049 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
5050 (re2 (concat "^" orgtbl-line-start-regexp))
5051 (commented (save-excursion (beginning-of-line 1)
5052 (cond ((looking-at re1) t)
5053 ((looking-at re2) nil)
5054 (t (user-error "Not at an org table")))))
5055 (re (if commented re1 re2))
5056 beg end)
5057 (save-excursion
5058 (beginning-of-line 1)
5059 (while (looking-at re) (beginning-of-line 0))
5060 (beginning-of-line 2)
5061 (setq beg (point))
5062 (while (looking-at re) (beginning-of-line 2))
5063 (setq end (point)))
5064 (comment-region beg end (if commented '(4) nil))))
5066 (defun orgtbl-insert-radio-table ()
5067 "Insert a radio table template appropriate for this major mode."
5068 (interactive)
5069 (let* ((e (cl-assoc-if #'derived-mode-p orgtbl-radio-table-templates))
5070 (txt (nth 1 e))
5071 name pos)
5072 (unless e (user-error "No radio table setup defined for %s" major-mode))
5073 (setq name (read-string "Table name: "))
5074 (while (string-match "%n" txt)
5075 (setq txt (replace-match name t t txt)))
5077 (setq pos (point))
5078 (insert txt)
5079 (goto-char pos)))
5081 ;;;###autoload
5082 (defun orgtbl-to-generic (table params)
5083 "Convert the orgtbl-mode TABLE to some other format.
5085 This generic routine can be used for many standard cases.
5087 TABLE is a list, each entry either the symbol `hline' for
5088 a horizontal separator line, or a list of fields for that
5089 line. PARAMS is a property list of parameters that can
5090 influence the conversion.
5092 Valid parameters are:
5094 :backend, :raw
5096 Export back-end used as a basis to transcode elements of the
5097 table, when no specific parameter applies to it. It is also
5098 used to translate cells contents. You can prevent this by
5099 setting :raw property to a non-nil value.
5101 :splice
5103 When non-nil, only convert rows, not the table itself. This is
5104 equivalent to setting to the empty string both :tstart
5105 and :tend, which see.
5107 :skip
5109 When set to an integer N, skip the first N lines of the table.
5110 Horizontal separation lines do count for this parameter!
5112 :skipcols
5114 List of columns that should be skipped. If the table has
5115 a column with calculation marks, that column is automatically
5116 discarded beforehand.
5118 :hline
5120 String to be inserted on horizontal separation lines. May be
5121 nil to ignore these lines altogether.
5123 :sep
5125 Separator between two fields, as a string.
5127 Each in the following group may be either a string or a function
5128 of no arguments returning a string:
5130 :tstart, :tend
5132 Strings to start and end the table. Ignored when :splice is t.
5134 :lstart, :lend
5136 Strings to start and end a new table line.
5138 :llstart, :llend
5140 Strings to start and end the last table line. Default,
5141 respectively, to :lstart and :lend.
5143 Each in the following group may be a string or a function of one
5144 argument (either the cells in the current row, as a list of
5145 strings, or the current cell) returning a string:
5147 :lfmt
5149 Format string for an entire row, with enough %s to capture all
5150 fields. When non-nil, :lstart, :lend, and :sep are ignored.
5152 :llfmt
5154 Format for the entire last line, defaults to :lfmt.
5156 :fmt
5158 A format to be used to wrap the field, should contain %s for
5159 the original field value. For example, to wrap everything in
5161 a property list with column numbers and format strings, or
5162 functions, e.g.,
5166 :hlstart :hllstart :hlend :hllend :hsep :hlfmt :hllfmt :hfmt
5168 Same as above, specific for the header lines in the table.
5169 All lines before the first hline are treated as header. If
5170 any of these is not present, the data line value is used.
5172 This may be either a string or a function of two arguments:
5174 :efmt
5176 Use this format to print numbers with exponential. The format
5177 should have %s twice for inserting mantissa and exponent, for
5179 list with column numbers and format strings or functions.
5180 :fmt will still be applied after :efmt."
5181 ;; Make sure `org-export-create-backend' is available.
5182 (require 'ox)
5183 (let* ((backend (plist-get params :backend))
5184 (custom-backend
5185 ;; Build a custom back-end according to PARAMS. Before
5186 ;; defining a translator, check if there is anything to do.
5187 ;; When there isn't, let BACKEND handle the element.
5188 (org-export-create-backend
5189 :parent (or backend 'org)
5190 :transcoders
5191 `((table . ,(org-table--to-generic-table params))
5192 (table-row . ,(org-table--to-generic-row params))
5193 (table-cell . ,(org-table--to-generic-cell params))
5194 ;; Macros are not going to be expanded. However, no
5195 ;; regular back-end has a transcoder for them. We
5196 ;; provide one so they are not ignored, but displayed
5197 ;; as-is instead.
5198 (macro . (lambda (m c i) (org-element-macro-interpreter m nil))))))
5199 data info)
5200 ;; Store TABLE as Org syntax in DATA. Tolerate non-string cells.
5201 ;; Initialize communication channel in INFO.
5202 (with-temp-buffer
5203 (let ((org-inhibit-startup t)) (org-mode))
5204 (let ((standard-output (current-buffer))
5205 (org-element-use-cache nil))
5206 (dolist (e table)
5208 ((consp e)
5209 (princ "| ") (dolist (c e) (princ c) (princ " |"))
5211 ;; Add back-end specific filters, but not user-defined ones. In
5212 ;; particular, make sure to call parse-tree filters on the
5213 ;; table.
5214 (setq info
5215 (let ((org-export-filters-alist nil))
5216 (org-export-install-filters
5217 (org-combine-plists
5218 (org-export-get-environment backend nil params)
5219 `(:back-end ,(org-export-get-backend backend))))))
5220 (setq data
5221 (org-export-filter-apply-functions
5222 (plist-get info :filter-parse-tree)
5223 (org-element-map (org-element-parse-buffer) 'table
5224 #'identity nil t)
5225 info)))
5226 (when (and backend (symbolp backend) (not (org-export-get-backend backend)))
5227 (user-error "Unknown :backend value"))
5228 (when (or (not backend) (plist-get info :raw)) (require 'ox-org))
5229 ;; Handle :skip parameter.
5230 (let ((skip (plist-get info :skip)))
5231 (when skip
5232 (unless (wholenump skip) (user-error "Wrong :skip value"))
5233 (let ((n 0))
5234 (org-element-map data 'table-row
5235 (lambda (row)
5236 (if (>= n skip) t
5237 (org-element-extract-element row)
5238 (cl-incf n)
5239 nil))
5240 nil t))))
5241 ;; Handle :skipcols parameter.
5242 (let ((skipcols (plist-get info :skipcols)))
5243 (when skipcols
5244 (unless (consp skipcols) (user-error "Wrong :skipcols value"))
5245 (org-element-map data 'table
5246 (lambda (table)
5247 (let ((specialp (org-export-table-has-special-column-p table)))
5248 (dolist (row (org-element-contents table))
5249 (when (eq (org-element-property :type row) 'standard)
5250 (let ((c 1))
5251 (dolist (cell (nthcdr (if specialp 1 0)
5252 (org-element-contents row)))
5253 (when (memq c skipcols)
5254 (org-element-extract-element cell))
5255 (cl-incf c))))))))))
5256 ;; Since we are going to export using a low-level mechanism,
5257 ;; ignore special column and special rows manually.
5258 (let ((special? (org-export-table-has-special-column-p data))
5259 ignore)
5260 (org-element-map data (if special? '(table-cell table-row) 'table-row)
5261 (lambda (datum)
5262 (when (if (eq (org-element-type datum) 'table-row)
5263 (org-export-table-row-is-special-p datum nil)
5264 (org-export-first-sibling-p datum nil))
5265 (push datum ignore))))
5266 (setq info (plist-put info :ignore-list ignore)))
5267 ;; We use a low-level mechanism to export DATA so as to skip all
5268 ;; usual pre-processing and post-processing, i.e., hooks, Babel
5269 ;; code evaluation, include keywords and macro expansion. Only
5270 ;; back-end specific filters are retained.
5271 (let ((output (org-export-data-with-backend data custom-backend info)))
5272 ;; Remove final newline.
5273 (if (org-string-nw-p output) (substring-no-properties output 0 -1) ""))))
5275 (defun org-table--generic-apply (value name &optional with-cons &rest args)
5276 (cond ((null value) nil)
5277 ((functionp value) `(funcall ',value ,@args))
5278 ((stringp value)
5279 (cond ((consp (car args)) `(apply #'format ,value ,@args))
5280 (args `(format ,value ,@args))
5281 (t value)))
5282 ((and with-cons (consp value))
5283 `(let ((val (cadr (memq column ',value))))
5284 (cond ((null val) contents)
5285 ((stringp val) (format val ,@args))
5286 ((functionp val) (funcall val ,@args))
5287 (t (user-error "Wrong %s value" ,name)))))
5288 (t (user-error "Wrong %s value" name))))
5290 (defun org-table--to-generic-table (params)
5291 "Return custom table transcoder according to PARAMS.
5292 PARAMS is a plist. See `orgtbl-to-generic' for more
5293 information."
5294 (let ((backend (plist-get params :backend))
5295 (splice (plist-get params :splice))
5296 (tstart (plist-get params :tstart))
5297 (tend (plist-get params :tend)))
5298 `(lambda (table contents info)
5299 (concat
5300 ,(and tstart (not splice)
5302 ,(if (or (not backend) tstart tend splice) 'contents
5303 `(org-export-with-backend ',backend table contents info))
5304 ,(org-table--generic-apply (and (not splice) tend) ":tend")))))
5306 (defun org-table--to-generic-row (params)
5307 "Return custom table row transcoder according to PARAMS.
5308 PARAMS is a plist. See `orgtbl-to-generic' for more
5309 information."
5310 (let* ((backend (plist-get params :backend))
5311 (lstart (plist-get params :lstart))
5312 (llstart (plist-get params :llstart))
5313 (hlstart (plist-get params :hlstart))
5314 (hllstart (plist-get params :hllstart))
5315 (lend (plist-get params :lend))
5316 (llend (plist-get params :llend))
5317 (hlend (plist-get params :hlend))
5318 (hllend (plist-get params :hllend))
5319 (lfmt (plist-get params :lfmt))
5320 (llfmt (plist-get params :llfmt))
5321 (hlfmt (plist-get params :hlfmt))
5322 (hllfmt (plist-get params :hllfmt)))
5323 `(lambda (row contents info)
5324 (if (eq (org-element-property :type row) 'rule)
5325 ,(cond
5326 ((plist-member params :hline)
5327 (org-table--generic-apply (plist-get params :hline) ":hline"))
5328 (backend `(org-export-with-backend ',backend row nil info)))
5329 (let ((headerp ,(and (or hlfmt hlstart hlend)
5330 '(org-export-table-row-in-header-p row info)))
5331 (last-header-p
5332 ,(and (or hllfmt hllstart hllend)
5333 '(org-export-table-row-ends-header-p row info)))
5334 (lastp (not (org-export-get-next-element row info))))
5335 (when contents
5336 ;; Check if we can apply `:lfmt', `:llfmt', `:hlfmt', or
5337 ;; `:hllfmt' to CONTENTS. Otherwise, fallback on
5338 ;; `:lstart', `:lend' and their relatives.
5339 ,(let ((cells
5340 '(org-element-map row 'table-cell
5341 (lambda (cell)
5342 ;; Export all cells, without separators.
5343 ;;
5344 ;; Use `org-export-data-with-backend'
5345 ;; instead of `org-export-data' to eschew
5346 ;; cached values, which
5347 ;; ignore :orgtbl-ignore-sep parameter.
5348 (org-export-data-with-backend
5349 cell
5350 (plist-get info :back-end)
5351 (org-combine-plists info '(:orgtbl-ignore-sep t))))
5352 info)))
5353 `(cond
5354 ,(and hllfmt
5355 `(last-header-p ,(org-table--generic-apply
5356 hllfmt ":hllfmt" nil cells)))
5357 ,(and hlfmt
5358 `(headerp ,(org-table--generic-apply
5359 hlfmt ":hlfmt" nil cells)))
5360 ,(and llfmt
5361 `(lastp ,(org-table--generic-apply
5362 llfmt ":llfmt" nil cells)))
5363 (t
5364 ,(if lfmt (org-table--generic-apply lfmt ":lfmt" nil cells)
5365 `(concat
5366 (cond
5367 ,(and
5368 (or hllstart hllend)
5369 `(last-header-p
5370 (concat
5371 ,(org-table--generic-apply hllstart ":hllstart")
5372 contents
5373 ,(org-table--generic-apply hllend ":hllend"))))
5374 ,(and
5375 (or hlstart hlend)
5376 `(headerp
5377 (concat
5378 ,(org-table--generic-apply hlstart ":hlstart")
5379 contents
5380 ,(org-table--generic-apply hlend ":hlend"))))
5381 ,(and
5382 (or llstart llend)
5383 `(lastp
5384 (concat
5385 ,(org-table--generic-apply llstart ":llstart")
5386 contents
5387 ,(org-table--generic-apply llend ":llend"))))
5388 (t
5389 ,(cond
5390 ((or lstart lend)
5391 `(concat
5392 ,(org-table--generic-apply lstart ":lstart")
5393 contents
5394 ,(org-table--generic-apply lend ":lend")))
5395 (backend
5396 `(org-export-with-backend
5397 ',backend row contents info))
5398 (t 'contents)))))))))))))))
5400 (defun org-table--to-generic-cell (params)
5401 "Return custom table cell transcoder according to PARAMS.
5402 PARAMS is a plist. See `orgtbl-to-generic' for more
5403 information."
5404 (let* ((backend (plist-get params :backend))
5405 (efmt (plist-get params :efmt))
5406 (fmt (plist-get params :fmt))
5407 (hfmt (plist-get params :hfmt))
5408 (sep (plist-get params :sep))
5409 (hsep (plist-get params :hsep)))
5410 `(lambda (cell contents info)
5411 ;; Make sure that contents are exported as Org data when :raw
5412 ;; parameter is non-nil.
5413 ,(when (and backend (plist-get params :raw))
5414 `(setq contents
5415 ;; Since we don't know what are the pseudo object
5416 ;; types defined in backend, we cannot pass them to
5417 ;; `org-element-interpret-data'. As a consequence,
5418 ;; they will be treated as pseudo elements, and will
5419 ;; have newlines appended instead of spaces.
5420 ;; Therefore, we must make sure :post-blank value is
5421 ;; really turned into spaces.
5422 (replace-regexp-in-string
5424 (org-trim
5425 (org-element-interpret-data
5426 (org-element-contents cell))))))
5428 (let ((headerp ,(and (or hfmt hsep)
5429 '(org-export-table-row-in-header-p
5430 (org-export-get-parent-element cell) info)))
5431 (column
5432 ;; Call costly `org-export-table-cell-address' only if
5433 ;; absolutely necessary, i.e., if one
5434 ;; of :fmt :efmt :hfmt has a "plist type" value.
5435 ,(and (cl-some (lambda (v) (integerp (car-safe v)))
5436 (list efmt hfmt fmt))
5437 '(1+ (cdr (org-export-table-cell-address cell info))))))
5438 (when contents
5439 ;; Check if we can apply `:efmt' on CONTENTS.
5440 ,(when efmt
5441 `(when (string-match orgtbl-exp-regexp contents)
5442 (let ((mantissa (match-string 1 contents))
5443 (exponent (match-string 2 contents)))
5444 (setq contents ,(org-table--generic-apply
5445 efmt ":efmt" t 'mantissa 'exponent)))))
5446 ;; Check if we can apply FMT (or HFMT) on CONTENTS.
5447 (cond
5448 ,(and hfmt `(headerp (setq contents ,(org-table--generic-apply
5449 hfmt ":hfmt" t 'contents))))
5450 ,(and fmt `(t (setq contents ,(org-table--generic-apply
5451 fmt ":fmt" t 'contents))))))
5452 ;; If a separator is provided, use it instead of BACKEND's.
5453 ;; Separators are ignored when LFMT (or equivalent) is
5454 ;; provided.
5455 ,(cond
5456 ((or hsep sep)
5457 `(if (or ,(and (not sep) '(not headerp))
5458 (plist-get info :orgtbl-ignore-sep)
5459 (not (org-export-get-next-element cell info)))
5460 ,(if (not backend) 'contents
5461 `(org-export-with-backend ',backend cell contents info))
5462 (concat contents
5463 ,(if (and sep hsep) `(if headerp ,hsep ,sep)
5464 (or hsep sep)))))
5465 (backend `(org-export-with-backend ',backend cell contents info))
5466 (t 'contents))))))
5468 ;;;###autoload
5469 (defun orgtbl-to-tsv (table params)
5470 "Convert the orgtbl-mode table to TAB separated material."
5473 ;;;###autoload
5474 (defun orgtbl-to-csv (table params)
5475 "Convert the orgtbl-mode table to CSV material.
5476 This does take care of the proper quoting of fields with comma or quotes."
5477 (orgtbl-to-generic table
5478 (org-combine-plists '(:sep "," :fmt org-quote-csv-field)
5479 params)))
5481 ;;;###autoload
5482 (defun orgtbl-to-latex (table params)
5483 "Convert the orgtbl-mode TABLE to LaTeX.
5485 TABLE is a list, each entry either the symbol `hline' for
5486 a horizontal separator line, or a list of fields for that line.
5487 PARAMS is a property list of parameters that can influence the
5488 conversion. All parameters from `orgtbl-to-generic' are
5489 supported. It is also possible to use the following ones:
5491 :booktabs
5495 :environment
5497 Specify environment to use, as a string. If you use
5499 as a string, to get proper continuation strings."
5500 (require 'ox-latex)
5501 (orgtbl-to-generic
5502 table
5503 (org-combine-plists
5504 ;; Provide sane default values.
5505 (list :backend 'latex
5506 :latex-default-table-mode 'table
5507 :latex-tables-centered nil
5508 :latex-tables-booktabs (plist-get params :booktabs)
5509 :latex-table-scientific-notation nil
5510 :latex-default-table-environment
5511 (or (plist-get params :environment) "tabular"))
5512 params)))
5514 ;;;###autoload
5515 (defun orgtbl-to-html (table params)
5516 "Convert the orgtbl-mode TABLE to HTML.
5518 TABLE is a list, each entry either the symbol `hline' for
5519 a horizontal separator line, or a list of fields for that line.
5520 PARAMS is a property list of parameters that can influence the
5521 conversion. All parameters from `orgtbl-to-generic' are
5522 supported. It is also possible to use the following one:
5524 :attributes
5526 Attributes and values, as a plist, which will be used in
5527 <table> tag."
5528 (require 'ox-html)
5529 (orgtbl-to-generic
5530 table
5531 (org-combine-plists
5532 ;; Provide sane default values.
5533 (list :backend 'html
5534 :html-table-data-tags '("<td%s>" . "</td>")
5535 :html-table-use-header-tags-for-first-column nil
5536 :html-table-align-individual-fields t
5537 :html-table-row-tags '("<tr>" . "</tr>")
5538 :html-table-attributes
5539 (if (plist-member params :attributes)
5540 (plist-get params :attributes)
5541 '(:border "2" :cellspacing "0" :cellpadding "6" :rules "groups"
5542 :frame "hsides")))
5543 params)))
5545 ;;;###autoload
5546 (defun orgtbl-to-texinfo (table params)
5547 "Convert the orgtbl-mode TABLE to Texinfo.
5549 TABLE is a list, each entry either the symbol `hline' for
5550 a horizontal separator line, or a list of fields for that line.
5551 PARAMS is a property list of parameters that can influence the
5552 conversion. All parameters from `orgtbl-to-generic' are
5553 supported. It is also possible to use the following one:
5555 :columns
5557 Column widths, as a string. When providing column fractions,
5559 (require 'ox-texinfo)
5560 (let ((output
5561 (orgtbl-to-generic
5562 table
5563 (org-combine-plists
5564 (list :backend 'texinfo
5565 :texinfo-tables-verbatim nil
5566 :texinfo-table-scientific-notation nil)
5567 params)))
5568 (columns (let ((w (plist-get params :columns)))
5569 (cond ((not w) nil)
5571 (t (concat "@columnfractions " w))))))
5572 (if (not columns) output
5573 (replace-regexp-in-string
5576 ;;;###autoload
5577 (defun orgtbl-to-orgtbl (table params)
5578 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
5580 TABLE is a list, each entry either the symbol `hline' for
5581 a horizontal separator line, or a list of fields for that line.
5582 PARAMS is a property list of parameters that can influence the
5583 conversion. All parameters from `orgtbl-to-generic' are
5584 supported.
5586 Useful when slicing one table into many. The :hline, :sep,
5587 :lstart, and :lend provide orgtbl framing. :tstart and :tend can
5588 be set to provide ORGTBL directives for the generated table."
5589 (require 'ox-org)
5590 (orgtbl-to-generic table (org-combine-plists params (list :backend 'org))))
5592 (defun orgtbl-to-table.el (table params)
5593 "Convert the orgtbl-mode TABLE into a table.el table.
5594 TABLE is a list, each entry either the symbol `hline' for
5595 a horizontal separator line, or a list of fields for that line.
5596 PARAMS is a property list of parameters that can influence the
5597 conversion. All parameters from `orgtbl-to-generic' are
5598 supported."
5599 (with-temp-buffer
5600 (insert (orgtbl-to-orgtbl table params))
5601 (org-table-align)
5602 (replace-regexp-in-string
5603 "-|" "-+"
5604 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
5606 (defun orgtbl-to-unicode (table params)
5607 "Convert the orgtbl-mode TABLE into a table with unicode characters.
5609 TABLE is a list, each entry either the symbol `hline' for
5610 a horizontal separator line, or a list of fields for that line.
5611 PARAMS is a property list of parameters that can influence the
5612 conversion. All parameters from `orgtbl-to-generic' are
5613 supported. It is also possible to use the following ones:
5615 :ascii-art
5618 the table. You can download it here:
5619 http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el.
5621 :narrow
5623 When non-nil, narrow columns width than provided width cookie,
5625 (require 'ox-ascii)
5626 (orgtbl-to-generic
5627 table
5628 (org-combine-plists
5629 (list :backend 'ascii
5630 :ascii-charset 'utf-8
5631 :ascii-table-widen-columns (not (plist-get params :narrow))
5632 :ascii-table-use-ascii-art (plist-get params :ascii-art))
5633 params)))
5635 ;; Put the cursor in a column containing numerical values
5636 ;; of an Org table,
5637 ;; type C-c " a
5638 ;; A new column is added with a bar plot.
5639 ;; When the table is refreshed (C-u C-c *),
5640 ;; the plot is updated to reflect the new values.
5642 (defun orgtbl-ascii-draw (value min max &optional width characters)
5643 "Draw an ascii bar in a table.
5644 VALUE is the value to plot, it determines the width of the bar to draw.
5645 MIN is the value that will be displayed as empty (zero width bar).
5646 MAX is the value that will draw a bar filling all the WIDTH.
5647 WIDTH is the span in characters from MIN to MAX.
5648 CHARACTERS is a string that will compose the bar, with shades of grey
5649 from pure white to pure black. It defaults to a 10 characters string
5650 of regular ascii characters."
5651 (let* ((width (ceiling (or width 12)))
5652 (characters (or characters " .:;c!lhVHW"))
5653 (len (1- (length characters)))
5654 (value (float (if (numberp value)
5655 value (string-to-number value))))
5656 (relative (/ (- value min) (- max min)))
5657 (steps (round (* relative width len))))
5658 (cond ((< steps 0) "too small")
5659 ((> steps (* width len)) "too large")
5660 (t (let* ((int-division (/ steps len))
5661 (remainder (- steps (* int-division len))))
5662 (concat (make-string int-division (elt characters len))
5663 (string (elt characters remainder))))))))
5665 ;;;###autoload
5666 (defun orgtbl-ascii-plot (&optional ask)
5667 "Draw an ASCII bar plot in a column.
5669 With cursor in a column containing numerical values, this function
5670 will draw a plot in a new column.
5672 ASK, if given, is a numeric prefix to override the default 12
5674 prefix,
5675 which will prompt for the width."
5676 (interactive "P")
5677 (let ((col (org-table-current-column))
5678 (min 1e999) ; 1e999 will be converted to infinity
5679 (max -1e999) ; which is the desired result
5680 (table (org-table-to-lisp))
5681 (length
5682 (cond ((consp ask)
5683 (read-number "Length of column " 12))
5684 ((numberp ask) ask)
5685 (t 12))))
5686 ;; Skip any hline a the top of table.
5687 (while (eq (car table) 'hline) (setq table (cdr table)))
5688 ;; Skip table header if any.
5689 (dolist (x (or (cdr (memq 'hline table)) table))
5690 (when (consp x)
5691 (setq x (nth (1- col) x))
5692 (when (string-match
5694 x)
5695 (setq x (string-to-number x))
5696 (when (> min x) (setq min x))
5697 (when (< max x) (setq max x)))))
5698 (org-table-insert-column)
5699 (org-table-move-column-right)
5700 (org-table-store-formulas
5701 (cons
5702 (cons
5703 (concat "$" (number-to-string (1+ col)))
5704 (format "'(%s $%s %s %s %s)"
5705 "orgtbl-ascii-draw" col min max length))
5706 (org-table-get-stored-formulas)))
5707 (org-table-recalculate t)))
5709 ;; Example of extension: unicode characters
5710 ;; Here are two examples of different styles.
5712 ;; Unicode block characters are used to give a smooth effect.
5713 ;; See http://en.wikipedia.org/wiki/Block_Elements
5714 ;; Use one of those drawing functions
5715 ;; - orgtbl-ascii-draw (the default ascii)
5716 ;; - orgtbl-uc-draw-grid (unicode with a grid effect)
5717 ;; - orgtbl-uc-draw-cont (smooth unicode)
5719 ;; This is best viewed with the "DejaVu Sans Mono" font
5720 ;; (use M-x set-default-font).
5722 (defun orgtbl-uc-draw-grid (value min max &optional width)
5723 "Draw a bar in a table using block unicode characters.
5724 It is a variant of orgtbl-ascii-draw with Unicode block
5725 characters, for a smooth display. Bars appear as grids (to the
5726 extent the font allows)."
5727 ;; http://en.wikipedia.org/wiki/Block_Elements
5728 ;; best viewed with the "DejaVu Sans Mono" font.
5729 (orgtbl-ascii-draw value min max width
5732 (defun orgtbl-uc-draw-cont (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 are solid (to the extent
5736 the font allows)."
5737 (orgtbl-ascii-draw value min max width
5740 (defun org-table-get-remote-range (name-or-id form)
5741 "Get a field value or a list of values in a range from table at ID.
5743 NAME-OR-ID may be the name of a table in the current file as set
5745 will then be used. Alternatively, it may be an ID referring to
5746 any entry, also in a different file. In this case, the first
5747 table in that entry will be referenced.
5751 The return value is either a single string for a single field, or a
5752 list of the fields in the rectangle."
5753 (save-match-data
5754 (let ((case-fold-search t) (id-loc nil)
5755 ;; Protect a bunch of variables from being overwritten by
5756 ;; the context of the remote table.
5757 org-table-column-names org-table-column-name-regexp
5758 org-table-local-parameters org-table-named-field-locations
5759 org-table-current-line-types
5760 org-table-current-begin-pos org-table-dlines
5761 org-table-current-ncol
5762 org-table-hlines
5763 org-table-last-column-widths
5764 org-table-last-alignment
5765 buffer loc)
5766 (setq form (org-table-convert-refs-to-rc form))
5767 (org-with-wide-buffer
5768 (goto-char (point-min))
5769 (if (re-search-forward
5772 nil t)
5773 (setq buffer (current-buffer) loc (match-beginning 0))
5774 (setq id-loc (org-id-find name-or-id 'marker))
5775 (unless (and id-loc (markerp id-loc))
5777 (setq buffer (marker-buffer id-loc)
5778 loc (marker-position id-loc))
5779 (move-marker id-loc nil))
5780 (with-current-buffer buffer
5781 (org-with-wide-buffer
5782 (goto-char loc)
5783 (forward-char 1)
5785 (not (match-beginning 1)))
5786 (user-error "Cannot find a table at NAME or ID %s" name-or-id))
5787 (org-table-analyze)
5788 (setq form (org-table-formula-substitute-names
5789 (org-table-formula-handle-first/last-rc form)))
5790 (if (and (string-match org-table-range-regexp form)
5791 (> (length (match-string 0 form)) 1))
5792 (org-table-get-range
5793 (match-string 0 form) org-table-current-begin-pos 1)
5794 form)))))))
5796 (defun org-table-remote-reference-indirection (form)
5797 "Return formula with table remote references substituted by indirection.
5799 This indirection works only with the format @ROW$COLUMN. The
5801 distinguished from a plain table name or ID."
5802 (let ((regexp
5803 ;; Same as in `org-table-eval-formula'.
5805 ;; Allow "$1", "@<", "$-1", "@<<$1" etc.
5808 (replace-regexp-in-string
5809 regexp
5810 (lambda (m)
5811 (save-match-data
5812 (let ((eq (org-table-formula-handle-first/last-rc (match-string 1 m))))
5813 (org-table-get-range
5815 (concat "@0" eq)
5816 eq)))))
5817 form t t 1)))
5819 (defmacro org-define-lookup-function (mode)
5820 (let ((mode-str (symbol-name mode))
5821 (first-p (eq mode 'first))
5822 (all-p (eq mode 'all)))
5823 (let ((plural-str (if all-p "s" "")))
5824 `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
5825 ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
5826 If R-LIST is nil, return matching element%s of S-LIST.
5827 If PREDICATE is not nil, use it instead of `equal' to match VAL.
5828 Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
5829 This function is generated by a call to the macro `org-define-lookup-function'."
5830 mode-str plural-str plural-str plural-str)
5831 (let ,(let ((lvars '((p (or predicate 'equal))
5832 (sl s-list)
5833 (rl (or r-list s-list))
5834 (ret nil))))
5835 (if first-p (cons '(match-p nil) lvars) lvars))
5836 (while ,(if first-p '(and (not match-p) sl) 'sl)
5837 (when (funcall p val (car sl))
5838 ,(when first-p '(setq match-p t))
5839 (let ((rval (car rl)))
5840 (setq ret ,(if all-p '(append ret (list rval)) 'rval))))
5841 (setq sl (cdr sl) rl (cdr rl)))
5842 ret)))))
5844 (org-define-lookup-function first)
5845 (org-define-lookup-function last)
5846 (org-define-lookup-function all)
5848 (provide 'org-table)
5850 ;; Local variables:
5851 ;; generated-autoload-file: "org-loaddefs.el"
5852 ;; End:
5854 ;;; org-table.el ends here