| blob | 0388f70849cf15fe74eff2eaac3f8806e586213d |
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."
1068 org-table-may-need-update)
1081 ;;;###autoload
1083 "Copy the value of the current field one row below.
1085 If the field at the cursor is empty, copy the content of the
1086 nearest non-empty field above. With argument N, use the Nth
1087 non-empty field.
1089 If the current field is not empty, it is copied down to the next
1090 row, and the cursor is moved with it. Therefore, repeating this
1091 command causes the column to be filled row-by-row.
1093 If the variable `org-table-copy-increment' is non-nil and the
1094 field is an integer or a timestamp, it will be incremented while
1095 copying. By default, increment by the difference between the
1096 value in the current field and the one in the field above. To
1097 increment using a fixed integer, set `org-table-copy-increment'
1098 to a number. In the case of a timestamp, increment by days."
1110 txt txt-up inc)
1118 beg t))
1128 beg t))
1135 ;; Above field was not empty, go down to the next row
1168 "Is point inside a table data field?
1169 I.e. not on a hline or before the first or after the last column?
1170 This actually throws an error, so it aborts the current command."
1182 "Get the field in table line LINE, column COLUMN.
1183 If LINE is larger than the number of data lines in the table, the function
1184 returns nil. However, if COLUMN is too large, we will simply return an
1185 empty string.
1186 If LINE is nil, use the current line.
1187 If COLUMN is nil, use the current column."
1194 "Put VALUE into line LINE, column COLUMN.
1195 When ALIGN is set, also realign the table."
1204 "Return the index of the current data line."
1211 cnt))
1214 "Go to the Nth data line in the current table.
1215 Return t when the line exists, nil if it does not exist."
1222 ;;;###autoload
1224 "Blank the current table field or active region."
1241 "Return the value of the field in column N of current row.
1242 N defaults to current column. If REPLACE is a string, replace
1243 field with this value. The return value is always the old
1244 value."
1248 ;; Before first column or after last one.
1249 ""
1254 ;; Since we are going to remove any hidden field, do not rely
1255 ;; on `org-table--hidden-field' as it could be GC'ed before
1256 ;; second check.
1265 val)))
1267 ;;;###autoload
1269 "Show info about the current field, and highlight any reference at point."
1279 col)
1280 org-table-named-field-locations)))
1290 ;; Prioritize field formulas over column formulas.
1299 dline col
1301 dline col ref1
1303 ;; FIXME: formula info not correct if special table line
1310 ""
1316 "Find out which column we are in."
1322 column)))
1325 "Find out what table data line we are in.
1326 Only data lines count for this."
1334 c)))
1336 ;;;###autoload
1338 "Move the cursor to the Nth column in the current table line.
1339 With optional argument ON-DELIM, stop with point before the left delimiter
1340 of the field.
1341 If there are less than N fields, just go to after the last delimiter.
1342 However, when FORCE is non-nil, create new columns if necessary."
1352 t)))))
1359 ;;;###autoload
1361 "Insert a new column into the table."
1376 ;; Add missing vertical bar at the end of the row.
1383 ;; Shift appropriately stored shrunk column numbers, then hide the
1384 ;; columns again.
1386 shrunk-columns)
1387 beg end)
1389 ;; Fix TBLFM formulas, if desirable.
1396 "Find a data line in the current table, which is needed for column commands."
1399 t
1410 t
1415 "Turn a buffer line number into a data line number.
1417 If there is no data line in this line, return nil.
1419 If there is no matching dline (most likely the reference was
1420 a hline), the first dline below it is used. When ABOVE is
1421 non-nil, the one above is used."
1426 nil)
1437 ;;;###autoload
1439 "Delete a column from the table."
1453 nil
1460 ;; Shift appropriately stored shrunk column numbers, then hide the
1461 ;; columns again.
1463 shrunk-columns)
1464 beg end)
1466 ;; Fix TBLFM formulas, if desirable.
1474 ;;;###autoload
1476 "Move column to the right."
1480 ;;;###autoload
1482 "Move column to the left."
1486 ;;;###autoload
1488 "Move the current column to the right. With arg LEFT, move to the left."
1516 ;; Shift appropriately stored shrunk column numbers, then shrink
1517 ;; the columns again.
1525 shrunk-columns)
1526 beg end)
1528 ;; Fix TBLFM formulas, if desirable.
1539 ;;;###autoload
1541 "Move table row down."
1545 ;;;###autoload
1547 "Move table row up."
1551 ;;;###autoload
1553 "Move the current table line down. With arg UP, move it up."
1562 hline2p)
1589 ;;;###autoload
1591 "Insert a new row above the current line into the table.
1592 With prefix ARG, insert below the current line."
1598 ;; Fix the first field if necessary
1602 ;; Buffer may not end of a newline character, so ensure
1603 ;; (beginning-of-line 2) moves point to a new line.
1614 ;;;###autoload
1616 "Insert a horizontal-line below the current line into the table.
1617 With prefix ABOVE, insert above the current line."
1638 ;;;###autoload
1640 "Insert a hline and move to the row below that line."
1654 In particular, this does handle wide and invisible characters."
1656 ;; It's a hline, just map the characters
1662 t t s)))
1663 s))
1665 ;;;###autoload
1667 "Delete the current row or horizontal line from the table."
1683 ;;;###autoload
1686 "Sort table lines according to the column at point.
1688 The position of point indicates the column to be used for
1689 sorting, and the range of lines is the range between the nearest
1690 horizontal separator lines, or the entire table of no such lines
1691 exist. If point is before the first column, you will be prompted
1692 for the sorting column. If there is an active region, the mark
1693 specifies the first line and the sorting column, while point
1694 should be in the last line to be included into the sorting.
1696 The command then prompts for the sorting type which can be
1697 alphabetically, numerically, or by time (as given in a time stamp
1698 in the field, or as a HH:MM value). Sorting in reverse order is
1699 also possible.
1701 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1703 If SORTING-TYPE is specified when this function is called from a Lisp
1704 program, no prompting will take place. SORTING-TYPE must be a character,
1705 any of (?a ?A ?n ?N ?t ?T ?f ?F) where the capital letters indicate that
1706 sorting should be done in reverse order.
1708 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
1709 a function to be called to extract the key. It must return a value
1710 that is compatible with COMPARE-FUNC, the function used to compare
1711 entries.
1713 A non-nil value for INTERACTIVE? is used to signal that this
1714 function is being called interactively."
1717 ;; Point must be either within a field or before a data line.
1722 ;; Set appropriate case sensitivity and column used for sorting.
1735 ;; Narrow buffer to appropriate sorting area.
1746 start))
1749 end)))
1750 ;; Determine arguments for `sort-subr'. Also record original
1751 ;; position. `org-table-save-field' cannot help here since
1752 ;; sorting is too much destructive.
1758 ;; Function to be called on the contents of the field
1759 ;; used for sorting in the current row.
1786 "Function for comparing keys (empty for default \
1787 `sort-subr' predicate): "
1797 #'end-of-line
1801 nil
1802 predicate)
1803 ;; Hide all columns but the one being sorted.
1805 ;; Move back to initial field.
1809 ;;;###autoload
1811 "Copy region in table to the clipboard and blank all relevant fields.
1812 If there is no active region, use just the field at point."
1818 ;;;###autoload
1820 "Copy rectangular region in table to clipboard.
1821 A special clipboard is used which can only be accessed
1822 with `org-table-paste-rectangle'."
1826 current-prefix-arg))
1831 region)
1843 ;; Collect every cell between COLUMN-START and COLUMN-END.
1853 ;;;###autoload
1855 "Paste a rectangular region into a table.
1856 The upper right corner ends up in the current field. All involved fields
1857 will be overwritten. If the rectangle does not fit into the present table,
1858 the table is enlarged as needed. The process ignores horizontal separator
1859 lines."
1869 ;; If we left the table, create a new row.
1881 ;;;###autoload
1883 "Convert from `org-mode' table to table.el and back.
1884 Obviously, this only works within limits. When an Org table is converted
1885 to table.el, all horizontal separator lines get lost, because table.el uses
1886 these as cell boundaries and has no notion of horizontal lines. A table.el
1887 table can be converted to an Org table only if it does not do row or column
1888 spanning. Multiline cells will become multiple cells. Beware, Org mode
1889 does not test if the table can be successfully converted - it blindly
1890 applies a recipe that works for simple tables."
1894 ;; convert to Org table
1903 ;; convert to table.el table
1906 ;; first, get rid of all horizontal lines
1910 ;; insert a hline before first
1914 ;; insert a hline after each line
1919 ;; replace "+" at beginning and ending of hlines
1928 "Transpose Org table at point and eliminate hlines.
1929 So a table like
1931 | 1 | 2 | 4 | 5 |
1932 |---+---+---+---|
1933 | a | b | c | d |
1934 | e | f | g | h |
1936 will be transposed as
1938 | 1 | a | e |
1939 | 2 | b | f |
1940 | 4 | c | g |
1941 | 5 | d | h |
1943 Note that horizontal lines disappear."
1955 table)))
1969 ;;;###autoload
1971 "Wrap several fields in a column like a paragraph.
1972 This is useful if you'd like to spread the contents of a field over several
1973 lines, in order to keep the table compact.
1975 If there is an active region, and both point and mark are in the same column,
1976 the text in the column is wrapped to minimum width for the given number of
1977 lines. Generally, this makes the table more compact. A prefix ARG may be
1978 used to change the number of desired lines. For example, \
1980 formats the selected text to two lines. If the region was longer than two
1981 lines, the remaining lines remain empty. A negative prefix argument reduces
1982 the current number of lines by that amount. The wrapped text is pasted back
1983 into the table. If you formatted it to more lines than it was before, fields
1984 further down in the table get overwritten - so you might need to make space in
1985 the table first.
1987 If there is no region, the current field is split at the cursor position and
1988 the text fragment to the right of the cursor is prepended to the field one
1989 line down.
1991 If there is no region, but you specify a prefix ARG, the current field gets
1992 blank, and the content is appended to the field above."
1996 ;; There is a region: fill as a paragraph.
2007 nil
2008 nlines))))
2011 ;; No region, split the current field at point.
2036 ;;;###autoload
2038 "Edit table field in a different window.
2039 This is mainly useful for fields that contain hidden parts.
2042 visible so that it can be edited in place.
2045 toggle `org-table-follow-field-mode'."
2067 p)
2089 "Finish editing a table data field.
2090 Remove all newline characters, insert the result into the table, realign
2091 the table and kill the editing buffer."
2095 text)
2112 "Minor mode to make the table field editor window follow the cursor.
2113 When this mode is active, the field editor window will always show the
2114 current field. The mode exits automatically when the cursor leaves the
2115 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
2116 nil " TblFollow" nil
2132 ;; We have left the table, exit the follow mode
2142 ;;;###autoload
2144 "Sum numbers in region of current table column.
2145 The result will be displayed in the echo area, and will be available
2148 If there is an active region, it is interpreted as a rectangle and all
2149 numbers in that rectangle will be summed. If there is no active
2150 region and point is located in a table column, sum all numbers in that
2151 column.
2153 If at least one number looks like a time HH:MM or HH:MM:SS, all other
2154 numbers are assumed to be times as well (in decimal hours) and the
2155 numbers are added as such.
2157 If NLAST is a number, only the NLAST fields will actually be summed."
2184 items1)))
2191 s diff)
2198 sres))))
2221 "Return the formula active for the current field.
2223 Assumes that table is already analyzed. If KEY is given, return
2224 the key to this formula. Otherwise return the formula preceded
2233 org-table-named-field-locations)))
2247 "Read a formula from the minibuffer, offer stored formula as default.
2248 When NAMED is non-nil, look for a named equation."
2253 org-table-named-field-locations)))
2266 stored)
2268 equation)
2274 scol))
2276 'org-table-formula-history
2277 )))))
2278 mustsave)
2280 ;; remove formula
2287 ;; We set the column equation, delete the named one.
2289 mustsave t))
2295 eq))
2298 "Store the list of formulas below the current table.
2299 If optional argument LOCATION is a buffer position, insert it at
2300 LOCATION instead."
2308 ;; Don't overwrite TBLFM, we might use text properties to
2309 ;; store stuff.
2323 ;; Fake a high number to make sure this is sorted at the end.
2330 a)
2340 "Compare two formulas for sorting."
2345 ;;;###autoload
2347 "Return an alist with the stored formulas directly after current table.
2348 By default, only return active formulas, i.e., formulas located
2349 on the first line after the table. However, if optional argument
2350 LOCATION is a buffer position, consider the formulas there."
2359 eq-alist seen)
2363 string)
2368 ;; Is it a column reference?
2370 ;; Since named columns are not possible in
2371 ;; LHS, assume this is a named field.
2379 "Double definition `%s=' in TBLFM line, please fix by hand"
2380 lhs)
2385 "Double definition `%s=' in TBLFM line, please fix by hand"
2386 lhs)))))))))))
2389 "Modify the equations after the table structure has been edited.
2391 For all numbers larger than LIMIT, shift them by DELTA."
2403 s n a)
2409 "Change makes TBLFM term %s invalid, use undo to recover"
2424 ;;;###autoload
2427 If yes, store the formula and apply it."
2428 ;; We already know we are in a table. Get field will only return a formula
2429 ;; when appropriate. It might return a separator line, but no problem.
2432 named eq)
2440 "List of commands triggering the recalculation of a line.
2452 ;;;###autoload
2454 "Rotate the recalculation mark in the first column.
2455 If in any row, the first field is not consistent with a mark,
2456 insert a new column for the markers.
2457 When there is an active region, change all the lines in the region,
2458 after prompting for the marking character.
2459 After each change, a message will be displayed indicating the meaning
2460 of the new mark."
2476 newchar))
2484 newchar))
2502 ;; Rotate mark in first row.
2504 ;; Rotate marks in additional rows if a region is active.
2512 ;; Only align if rotation actually changed lines' length.
2522 ;;;###autoload
2524 "Analyze table at point and store results.
2526 This function sets up the following dynamically scoped variables:
2528 `org-table-column-name-regexp',
2529 `org-table-column-names',
2530 `org-table-current-begin-pos',
2531 `org-table-current-line-types',
2532 `org-table-current-ncol',
2533 `org-table-dlines',
2534 `org-table-hlines',
2535 `org-table-local-parameters',
2536 `org-table-named-field-locations'."
2541 ;; Extract column names.
2554 ;; Extract local parameters.
2562 org-table-local-parameters)))))
2563 ;; Update named fields locations. We minimize `count-lines'
2564 ;; processing by storing last known number of lines in LAST.
2586 field))
2589 org-table-named-field-locations))))))))))
2590 ;; Re-use existing markers when possible.
2594 ;; Analyze the line types.
2605 ;; Get the number of columns from the first data line in table.
2613 al al2)
2627 "Move point to a specific field in the current table.
2629 REF is either the name of a field its absolute reference, as
2630 a string. No column is created unless CREATE-COLUMN-P is
2631 non-nil. If it is a function, it is called with the column
2632 number as its argument as is used as a predicate to know if the
2633 column can be created.
2635 This function assumes the table is already analyzed (i.e., using
2636 `org-table-analyze')."
2651 create-column-p)))
2657 ;;;###autoload
2659 "Recompute the current line if marked for it, and if we haven't just done it."
2679 org-tbl-calc-modes)
2681 ;;;###autoload
2683 suppress-align suppress-const
2684 suppress-store suppress-analysis)
2685 "Replace the table field value at the cursor by the result of a calculation.
2687 In a table, this command replaces the value in the current field with the
2689 formula, by storing it in a special line below the table. When called
2691 field formula.
2694 insert the active equation for the field
2695 back into the current field, so that it can be edited there. This is \
2696 useful
2698 check the referenced fields.
2700 When called, the command first prompts for a formula, which is read in
2701 the minibuffer. Previously entered formulas are available through the
2702 history list, and the last used formula is offered as a default.
2703 These stored formulas are adapted correctly when moving, inserting, or
2704 deleting columns with the corresponding commands.
2706 The formula can be any algebraic expression understood by the Calc package.
2707 For details, see the Org mode manual.
2709 This function can also be called from Lisp programs and offers
2710 additional arguments: EQUATION can be the formula to apply. If this
2711 argument is given, the user will not be prompted.
2713 SUPPRESS-ALIGN is used to speed-up recursive calls by by-passing
2714 unnecessary aligns.
2716 SUPPRESS-CONST suppresses the interpretation of constants in the
2717 formula, assuming that this has been done already outside the
2718 function.
2720 SUPPRESS-STORE means the formula should not be stored, either
2721 because it is already stored, or because it is a modified
2722 equation that should not overwrite the stored one.
2724 SUPPRESS-ANALYSIS prevents analyzing the table and checking
2725 location of point."
2741 equation
2747 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2748 duration duration-output-format)
2749 ;; Parse the format string. Since we have a lot of modes, this is
2750 ;; a lot of work. However, I think calc still uses most of the time.
2763 'calc-float-format
2766 n))))
2771 duration-output-format
2800 ;; replace fields with duration values if relevant
2804 fields)))
2810 x))
2811 fields)))
2817 ;; Insert row and column number of formula result field
2828 t t form)))
2830 ;; Check for old vertical references
2832 ;; Insert remote references
2845 rmtrng))
2846 keep-empty numbers lispp))
2847 t t form)))
2848 ;; Insert complex ranges
2858 ;; possibly handle durations
2863 formrg)
2864 keep-empty numbers lispp)))
2869 ;; Insert simple ranges, i.e. included in the current row.
2872 form)
2883 keep-empty numbers lispp))
2884 t t form)))
2886 ;; Insert the references to fields in same row
2893 x keep-empty numbers lispp)))
2910 ;; Use <...> time-stamps so that Calc can handle them.
2913 ;; Internationalize local time-stamps by setting locale to
2914 ;; "C".
2917 org-ts-regexp
2925 form t t))
2928 form
2935 duration-output-format)
2936 ev)))
2941 Orig: %s
2942 $xyz-> %s
2943 @r$c-> %s
2966 ;; Replace any active time stamp in the result with
2967 ;; an inactive one. Dates in tables are likely
2968 ;; piece of regular data, not meant to appear in the
2969 ;; agenda.
2982 prop value)))
2985 "Get a calc vector from a column, according to descriptor DESC.
2987 Optional arguments TBEG and COL can give the beginning of the table and
2988 the current column, to avoid unnecessary parsing.
2990 HIGHLIGHT means just highlight the range.
2992 When CORNERS-ONLY is set, only return the corners of the range as
2993 a list (line1 column1 line2 column2) where line1 and line2 are
2994 line numbers relative to beginning of table, or TBEG, and column1
2995 and column2 are table column numbers."
2998 desc))
3009 thisline)))
3014 thisline)))
3026 ;; Just one field.
3033 ;; A range, return a vector. First sort the numbers to get
3034 ;; a regular rectangle.
3040 ;; Copy the range values into a list.
3055 ;; Return string representation of calc vector.
3061 "Return relative line number corresponding to descriptor DESC.
3062 The cursor is currently in relative line number CLINE."
3067 ;; 1 2 3 4 5 6
3068 desc))
3090 cline)))
3093 "Return relative line of Nth row with type TYPE.
3094 Search starts from relative line I. When BACKWARDS in non-nil,
3095 look before I. When RELATIVE is non-nil, the reference is
3096 relative. DESC is the original descriptor that started the
3097 search, as a string."
3105 ;; We are going to cross a hline. Check if this is
3106 ;; an authorized move.
3117 ;; The last hline doesn't exist. Instead, point to last row
3118 ;; in table.
3127 "Convert list ELEMENTS to something appropriate to insert into formula.
3128 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
3129 NUMBERS indicates that everything should be converted to numbers.
3130 LISPP non-nil means to return something appropriate for a Lisp
3131 list, `literal' is for the format specifier L."
3132 ;; Calc nan (not a number) is used for the conversion of the empty
3133 ;; field to a reference for several reasons: (i) It is accepted in a
3134 ;; Calc formula (e. g. "" or "()" would result in a Calc error).
3135 ;; (ii) In a single field (not in range) it can be distinguished
3136 ;; from "(nan)" which is the reference made from a single field
3137 ;; containing "nan".
3139 ;; field reference
3142 elements
3144 ""
3153 ;; range reference
3158 elements))))
3164 x
3172 x)
3174 elements
3178 "If there has been more than one second since T1, display message.
3179 ARGS are passed as arguments to the `message' function. Returns
3180 current time if a message is printed, otherwise returns T1. If
3181 T1 is nil, always messages."
3185 curtime)
3186 t1)))
3188 ;;;###autoload
3190 "Recalculate the current table line by applying all stored formulas.
3192 With prefix arg ALL, do this for all lines in the table.
3195 if ALL is the symbol `iterate',
3196 recompute the table until it no longer changes.
3198 If NOALIGN is not nil, do not re-align the table after the computations
3199 are done. This is typically used internally to save time, if it is
3200 known that the table will be realigned a little later anyway."
3215 beg end eqlcol eqlfield)
3216 ;; Insert constants in all formulas.
3219 ;; Expand equations, then split the equation list between
3220 ;; column formulas and field formulas.
3232 old-lhs)))
3235 existing formula for column %s"
3236 old-lhs
3237 new))
3238 new))
3244 ;; Expand ranges in lhs of formulas
3246 ;; Get the correct line range to process.
3253 ;; This is a table with marked lines, compute selected
3254 ;; lines.
3256 ;; Move forward to the first non-header line.
3261 ;; Just leave BEG at the start of the table.
3266 ;; Mark named fields untouchable. Also check if several
3267 ;; field/range formulas try to set the same field.
3271 seen-fields)
3282 ;; Turn field coordinates associated to NAME
3283 ;; into an absolute reference.
3287 name)))
3290 reference))
3295 ;; Evaluate the column formulas, but skip fields covered by
3296 ;; field formulas.
3300 ;; Unprotected line, recalculate.
3305 log-last-time
3318 ;; Evaluate the field formulas.
3327 reference
3328 ;; Possibly create a new column, as long as
3329 ;; `org-table-formula-create-columns' allows it.
3341 t))
3346 ;; Clean up markers and internal text property.
3357 ;;;###autoload
3359 "Recalculate the table until it does not change anymore.
3360 The maximum number of iterations is 10, but you can choose a different value
3361 with the prefix ARG."
3366 thistbl)
3380 ;;;###autoload
3382 "Recalculate all tables in the current buffer."
3387 ;; Reason for separate `org-table-align': When repeating
3388 ;; (org-table-recalculate t) `org-table-may-need-update' gets in
3389 ;; the way.
3392 t)))
3394 ;;;###autoload
3396 "Iterate all tables in the buffer, to converge inter-table dependencies."
3401 c1)
3417 "Apply the #+TBLFM in the line at point to the table."
3424 ;; Insert a temporary formula at right after the table
3429 ;; Recalculate the table.
3434 ;; Delete the formula inserted temporarily.
3440 "Find the beginning of the TBLFM lines and return its position.
3441 Return nil when the beginning of TBLFM line was not found."
3448 "Expand list of formulas.
3449 If some of the RHS in the formulas are ranges or a row reference,
3450 expand them to individual field equations for each field. This
3451 function assumes the table is already analyzed (i.e., using
3452 `org-table-analyze')."
3459 ;; This just refers to one fixed field.
3462 ;; This just refers to one fixed named field.
3465 ;; Column formulas are treated specially and are not
3466 ;; expanded.
3471 rhs)
3472 res)))
3484 rhs)
3485 res))))))))))
3488 "Replace @<, @>, $<, $> with first/last row/column of the table.
3489 So @< and $< will always be replaced with @1 and $1, respectively.
3490 The advantage of these special markers are that structure editing of
3491 the table will not change them, while @1 and $1 will be modified
3492 when a line/row is swapped out of that privileged position. So for
3493 formulas that use a range of rows or columns, it may often be better
3495 borders of the table using the @< @> $< $> makers."
3498 s start)
3503 org-table-current-ncol)
3507 len
3514 s)
3517 "Replace $const with values in string F."
3522 org-table-column-name-regexp
3525 org-table-column-names))))
3526 f t t)))
3527 ;; Parameters and constants.
3531 new start))
3534 ;; When a duration is expected, convert value on the fly.
3540 v)))))
3547 "Find the value for a parameter or constant in a formula.
3548 Parameters get priority."
3579 map))
3586 "--"
3589 "--"
3590 "Shift Reference at Point"
3595 "-"
3596 "Change Test Row for Column Formulas"
3599 "--"
3604 org-table-overlay-coordinates)]
3605 "--"
3613 ;;;###autoload
3615 "Edit the formulas of the current table in a separate buffer."
3621 ;; Move point within the table before analyzing it.
3637 ;; Keep global-font-lock-mode from turning on font-lock-mode
3682 "Convert a formula from internal to user representation."
3685 s))
3688 "Convert a formula from user to internal representation."
3691 s))
3694 "Convert spreadsheet references from A7 to @7$28.
3695 Works for single references, but also for entire formulas and even the
3696 full TBLFM line."
3698 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3701 ;; format match, just advance
3706 ;; 3.e5 or something like this.
3709 ;; (member (match-string 1 s)
3710 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3711 )
3712 ;; function name, just advance
3722 t t s)))))
3723 s))
3726 "Convert spreadsheet references from to @7$28 to AB7.
3727 Works for single references, but also for entire formulas and even the
3728 full TBLFM line."
3735 t t s)))
3740 t nil s)))
3741 s)
3744 "Convert a base 26 number represented by letters into an integer.
3745 For example: AB -> 28."
3751 n))
3754 "Convert an integer into a base 26 number represented by letters.
3755 For example: 28 -> AB."
3760 s))
3763 "Convert a time string into numerical duration in seconds.
3764 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3765 If S is a string representing a number, keep this number."
3767 s
3790 "Convert a number of seconds to a time string.
3791 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3792 minutes or seconds."
3804 ;; Ignore seconds
3808 secs0)
3813 secs0)))))
3817 \f
3818 ;;; Columns shrinking
3821 "Non-nil if current field is narrowed.
3822 When non-nil, return the overlay narrowing the field."
3825 o))
3829 "List currently shrunk columns in table at point."
3831 ;; We really check shrunk columns in current row only. It could
3832 ;; be wrong if all rows do not contain the same number of columns
3833 ;; (i.e. the table is not properly aligned). As a consequence,
3834 ;; some columns may not be shrunk again upon aligning the table.
3835 ;;
3836 ;; For example, in the following table, cursor is on first row and
3837 ;; "<>" indicates a shrunk column.
3838 ;;
3839 ;; | |
3840 ;; | | <> |
3841 ;;
3842 ;; Aligning table from the first row will not shrink again the
3843 ;; second row, which was not visible initially.
3844 ;;
3845 ;; However, fixing it requires to check every row, which may be
3846 ;; slow on large tables. Moreover, the hindrance of this
3847 ;; pathological case is very limited.
3860 "Shrink a table field to a specified width.
3862 WIDTH is an integer representing the number of characters to
3863 display, in addition to `org-table-shrunk-column-indicator'. START
3864 and END are, respectively, the beginning and ending positions of
3865 the field. CONTENTS is its trimmed contents, as a string, or
3866 `hline' for table rules.
3868 Real field is hidden under an overlay. The latter has the
3869 following properties:
3871 `org-overlay-type'
3873 Set to `table-column-hide'. Used to identify overlays
3874 responsible for the task.
3876 `org-table-column-overlays'
3878 It is a list with the pattern (siblings . COLUMN-OVERLAYS)
3879 where COLUMN-OVERLAYS is the list of all overlays hiding the
3880 same column.
3882 Whenever the text behind or next to the overlay is modified, all
3883 the overlays in the column are deleted, effectively displaying
3884 the column again.
3886 Return overlay used to hide the field."
3893 org-table-shrunk-column-indicator))
3895 ;; Remove invisible parts from links in CONTENTS. Since
3896 ;; shrinking could happen before first fontification
3897 ;; (e.g., using a #+STARTUP keyword), this cannot be done
3898 ;; using text properties.
3902 ;; Expand field.
3904 contents
3906 org-table-shrunk-column-indicator)
3907 ;; Truncate field.
3910 org-table-shrunk-column-indicator))))))
3913 ;; Removing one overlay removes all other overlays
3914 ;; in the same column.
3923 ;; Make sure overlays stays on top of table coordinates
3924 ;; overlays. See `org-table-overlay-coordinates'.
3927 o)))
3930 "Read column selection select as a list of numbers.
3932 SELECT is a string containing column ranges, separated by white
3933 space characters, see `org-table-hide-column' for details. MAX
3934 is the maximum column number.
3936 Return value is a sorted list of numbers. Ignore any number
3937 outside of the [1;MAX] range."
3954 max))))
3957 #'<)))
3960 "Shrink COLUMNS in an Org table.
3961 COLUMNS is a sorted list of column numbers. BEG and END are,
3962 respectively, the beginning position and the end position of the
3963 table."
3974 ;; Move to COLUMN.
3979 ;; Extract boundaries and contents from current field.
3980 ;; Also set the column's width if we encounter a width
3981 ;; cookie for the first time.
3995 ;; Link overlay to the other overlays in the same column.
4002 ;;;###autoload
4004 "Shrink or expand current column in an Org table.
4006 If a width cookie specifies a width W for the column, the first
4007 W visible characters are displayed. Otherwise, the column is
4008 shrunk to a single character.
4010 When point is before the first column or after the last one, ask
4011 for the columns to shrink or expand, as a list of ranges.
4012 A column range can be one of the following patterns:
4014 N column N only
4015 N-M every column between N and M (both inclusive)
4016 N- every column between N (inclusive) and the last column
4017 -M every column between the first one and M (inclusive)
4018 - every column
4020 When optional argument ARG is a string, use it as white space
4021 separated list of column ranges.
4024 `org-table-shrink', i.e.,
4025 shrink columns with a width cookie and expand the others.
4028 prefix, expand all columns."
4034 ;; Compute an upper bound for the number of columns.
4035 ;; Nonexistent columns are ignored anyway.
4040 (`nil
4044 ;; Point is either before first column or past last
4045 ;; one. Ask for columns to operate on.
4048 max-columns)
4049 ;; Find current column, even when on a hline.
4066 ;; Move before overlay if point is under it.
4070 ;;;###autoload
4072 "Shrink all columns with a width cookie in the table at point.
4074 Columns without a width cookie are expanded.
4076 Optional arguments BEGIN and END, when non-nil, specify the
4077 beginning and end position of the current table."
4090 ;; Make sure invisible characters in the table are at the right
4091 ;; place since column widths take them into account.
4095 ;;;###autoload
4097 "Expand all columns in the table at point.
4098 Optional arguments BEGIN and END, when non-nil, specify the
4099 beginning and end position of the current table."
4108 \f
4109 ;;; Formula editing
4112 "Convert all references in this buffer, using FUNCTION."
4123 "Convert all references in the buffer from B3 to @3$2 and back."
4133 "Shift the reference at point one row/hline up."
4137 "Shift the reference at point one row/hline down."
4141 "Shift the reference at point one field to the left."
4145 "Shift the reference at point one field to the right."
4156 ;; A B3-like reference
4162 ;; An internal reference
4168 "Re-match the group N, and replace it with the shifted reference."
4173 t t)))
4176 "Shift a reference part REF.
4177 If DECR is set, decrease the references row/column, else increase.
4178 If HLINE is set, this may be a hline reference, it certainly is not
4179 a translation reference."
4208 "Toggle the display of coordinates in the referenced table."
4217 "Parse the buffer for formula definitions and install them.
4218 With prefix ARG, apply the new formulas to the table."
4227 eql)
4230 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
4231 nil t)
4252 "Abort editing formulas, without installing the changes."
4263 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
4304 "Show the location/value of the $ expression at point.
4305 When LOCAL is non-nil, show references for the table at point."
4315 var name e what match dest)
4319 "$1.."
4371 dest)
4397 ;; Column number.
4423 org-table-fedit-scroll-down))))
4435 "Make sure the cursor is in a dataline in a table."
4444 p1 p2)))
4449 "Move cursor one line up in the window showing the table."
4454 "Move cursor one line down in the window showing the table."
4459 "Move the cursor in the window showing the table.
4460 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
4485 "Add a new overlay."
4491 "Highlight rectangular region in a table.
4492 When buffer positions BEG and END are provided, use them to
4493 delimit the region to highlight. Otherwise, refer to point. Use
4494 FACE, when non-nil, for the highlight."
4526 "Remove the rectangle overlays."
4536 "Add overlays to the table at point, to show row/column coordinates."
4564 ;;;###autoload
4566 "Toggle the display of Row/Column numbers in tables."
4577 ;;;###autoload
4579 "Toggle the formula debugger in tables."
4585 ;;; The orgtbl minor mode
4587 ;; Define a minor mode which can be used in other modes in order to
4588 ;; integrate the Org table editor.
4590 ;; This is really a hack, because the Org table editor uses several
4591 ;; keys which normally belong to the major mode, for example the TAB
4592 ;; and RET keys. Here is how it works: The minor mode defines all the
4593 ;; keys necessary to operate the table editor, but wraps the commands
4594 ;; into a function which tests if the cursor is currently inside
4595 ;; a table. If that is the case, the table editor command is
4596 ;; executed. However, when any of those keys is used outside a table,
4597 ;; the function uses `key-binding' to look up if the key has an
4598 ;; associated command in another currently active keymap (minor modes,
4599 ;; major mode, global), and executes that command. There might be
4600 ;; problems if any of the keys used by the table editor is otherwise
4601 ;; used as a prefix key.
4603 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
4604 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
4605 ;; addresses this by checking explicitly for both bindings.
4607 ;; The optimized version (see variable `orgtbl-optimized') takes over
4608 ;; all keys which are bound to `self-insert-command' in the *global map*.
4609 ;; Some modes bind other commands to simple characters, for example
4610 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
4611 ;; active, this binding is ignored inside tables and replaced with a
4612 ;; modified self-insert.
4630 ;; Install it as a minor mode.
4634 ;;;###autoload
4636 "The `org-mode' table editor as a minor mode for use in other modes."
4641 ;; Exit without error, in case some hook functions calls this
4642 ;; by accident in org-mode.
4646 ;; Make sure we are first in minor-mode-map-alist
4648 ;; FIXME: maybe it should use emulation-mode-map-alists?
4655 auto-fill-inhibit-regexp)
4659 auto-fill-inhibit-regexp)
4660 orgtbl-line-start-regexp))
4675 "Create a function for binding in the table minor mode.
4676 FUN is the command to call inside a table. N is used to create a unique
4677 command name. KEYS are keys that should be checked in for a command
4678 to execute outside of tables."
4684 "Outside of tables, run the binding of `"
4696 keys)
4700 "Error when there is no default binding for a table key."
4705 "Setup orgtbl keymaps."
4736 elt key fun cmd)
4744 ;; Special treatment needed for TAB, RET and DEL
4757 (orgtbl-make-binding 'org-delete-backward-char 109
4763 [(tab)] "\C-i"))
4765 (org-defkey orgtbl-mode-map [backtab]
4767 [backtab] [S-iso-lefttab] [(shift tab)]
4768 [(tab)] "\C-i"))
4770 (org-defkey orgtbl-mode-map "\M-\C-m"
4771 (orgtbl-make-binding 'org-table-wrap-region 105
4772 "\M-\C-m" [(meta return)]))
4773 (org-defkey orgtbl-mode-map [(meta return)]
4774 (orgtbl-make-binding 'org-table-wrap-region 106
4775 [(meta return)] "\M-\C-m"))
4777 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4778 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4780 (when orgtbl-optimized
4781 ;; If the user wants maximum table support, we need to hijack
4782 ;; some standard editing functions
4783 (org-remap orgtbl-mode-map
4784 'self-insert-command 'orgtbl-self-insert-command
4785 'delete-char 'org-delete-char
4786 'delete-backward-char 'org-delete-backward-char)
4787 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4788 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4789 '("OrgTbl"
4790 ["Create or convert" org-table-create-or-convert-from-region
4791 :active (not (org-at-table-p)) :keys "C-c |" ]
4792 "--"
4793 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4794 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4795 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4796 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4797 "--"
4798 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4799 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4800 ["Copy Field from Above"
4801 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4802 "--"
4803 ("Column"
4804 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4805 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4806 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4807 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4808 ("Row"
4809 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4810 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4811 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4812 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4813 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4814 "--"
4815 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4816 ("Rectangle"
4817 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4818 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4819 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4820 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4821 "--"
4822 ("Radio tables"
4823 ["Insert table template" orgtbl-insert-radio-table
4824 (cl-assoc-if #'derived-mode-p orgtbl-radio-table-templates)]
4825 ["Comment/uncomment table" orgtbl-toggle-comment t])
4826 "--"
4827 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4828 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4829 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4830 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4831 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4832 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4833 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4834 ["Sum Column/Rectangle" org-table-sum
4835 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4836 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4837 ["Debug Formulas"
4838 org-table-toggle-formula-debugger :active (org-at-table-p)
4839 :keys "C-c {"
4840 :style toggle :selected org-table-formula-debug]
4841 ["Show Col/Row Numbers"
4842 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4843 :keys "C-c }"
4844 :style toggle :selected org-table-overlay-coordinates]
4845 "--"
4846 ("Plot"
4849 t))
4851 (defun orgtbl-ctrl-c-ctrl-c (arg)
4852 "If the cursor is inside a table, realign the table.
4853 If it is a table to be sent away to a receiver, do it.
4854 With prefix arg, also recompute table."
4855 (interactive "P")
4856 (let ((case-fold-search t) (pos (point)) action)
4857 (save-excursion
4858 (beginning-of-line 1)
4859 (setq action (cond
4863 (cond
4864 ((integerp action)
4865 (goto-char action)
4866 (org-table-maybe-eval-formula)
4867 (if arg
4868 (call-interactively 'org-table-recalculate)
4869 (org-table-maybe-recalculate-line))
4870 (call-interactively 'org-table-align)
4871 (when (orgtbl-send-table 'maybe)
4872 (run-hooks 'orgtbl-after-send-table-hook)))
4873 ((eq action 'recalc)
4874 (save-excursion
4875 (beginning-of-line 1)
4877 (if (org-at-table-p)
4878 (org-call-with-arg 'org-table-recalculate t))))
4879 (t (let (orgtbl-mode)
4880 (call-interactively (key-binding "\C-c\C-c")))))))
4882 (defun orgtbl-create-or-convert-from-region (_arg)
4883 "Create table or convert region to table, if no conflicting binding.
4884 This installs the table binding `C-c |', but only if there is no
4885 conflicting binding to this key outside orgtbl-mode."
4886 (interactive "P")
4887 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4888 (if cmd
4889 (call-interactively cmd)
4890 (call-interactively 'org-table-create-or-convert-from-region))))
4892 (defun orgtbl-tab (arg)
4893 "Justification and field motion for `orgtbl-mode'."
4894 (interactive "P")
4895 (if arg (org-table-edit-field t)
4896 (org-table-justify-field-maybe)
4897 (org-table-next-field)))
4899 (defun orgtbl-ret ()
4900 "Justification and field motion for `orgtbl-mode'."
4901 (interactive)
4902 (if (bobp)
4903 (newline)
4904 (org-table-justify-field-maybe)
4905 (org-table-next-row)))
4907 (defun orgtbl-self-insert-command (N)
4908 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4909 If the cursor is in a table looking at whitespace, the whitespace is
4910 overwritten, and the table is not marked as requiring realignment."
4911 (interactive "p")
4912 (if (and (org-at-table-p)
4913 (or
4914 (and org-table-auto-blank-field
4915 (member last-command
4916 '(orgtbl-hijacker-command-100
4917 orgtbl-hijacker-command-101
4918 orgtbl-hijacker-command-102
4919 orgtbl-hijacker-command-103
4920 orgtbl-hijacker-command-104
4921 orgtbl-hijacker-command-105
4922 yas/expand))
4923 (org-table-blank-field))
4924 t)
4925 (eq N 1)
4927 (let (org-table-may-need-update)
4928 (delete-region (match-beginning 1) (match-end 1))
4929 (self-insert-command N))
4930 (setq org-table-may-need-update t)
4931 (let* (orgtbl-mode
4932 a
4933 (cmd (or (key-binding
4934 (or (and (listp function-key-map)
4935 (setq a (assoc last-input-event function-key-map))
4936 (cdr a))
4937 (vector last-input-event)))
4938 'self-insert-command)))
4939 (call-interactively cmd)
4940 (if (and org-self-insert-cluster-for-undo
4941 (eq cmd 'self-insert-command))
4942 (if (not (eq last-command 'orgtbl-self-insert-command))
4943 (setq org-self-insert-command-undo-counter 1)
4944 (if (>= org-self-insert-command-undo-counter 20)
4945 (setq org-self-insert-command-undo-counter 1)
4946 (and (> org-self-insert-command-undo-counter 0)
4947 buffer-undo-list
4948 (not (cadr buffer-undo-list)) ; remove nil entry
4949 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4950 (setq org-self-insert-command-undo-counter
4951 (1+ org-self-insert-command-undo-counter))))))))
4953 ;;;###autoload
4955 "Regular expression matching exponentials as produced by calc.")
4957 (defun orgtbl-gather-send-defs ()
4958 "Gather a plist of :name, :transform, :params for each destination before
4959 a radio table."
4960 (save-excursion
4961 (goto-char (org-table-begin))
4962 (let (rtn)
4963 (beginning-of-line 0)
4964 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4965 (let ((name (org-no-properties (match-string 1)))
4966 (transform (intern (match-string 2)))
4967 (params (if (match-end 3)
4968 (read (concat "(" (match-string 3) ")")))))
4969 (push (list :name name :transform transform :params params)
4970 rtn)
4971 (beginning-of-line 0)))
4972 rtn)))
4974 (defun orgtbl-send-replace-tbl (name text)
4975 "Find and replace table NAME with TEXT."
4976 (save-excursion
4977 (goto-char (point-min))
4978 (let* ((location-flag nil)
4979 (name (regexp-quote name))
4982 (while (re-search-forward begin-re nil t)
4983 (unless location-flag (setq location-flag t))
4984 (let ((beg (line-beginning-position 2)))
4985 (unless (re-search-forward end-re nil t)
4986 (user-error "Cannot find end of receiver location at %d" beg))
4987 (beginning-of-line)
4988 (delete-region beg (point))
4990 (unless location-flag
4991 (user-error "No valid receiver location found in the buffer")))))
4993 ;;;###autoload
4994 (defun org-table-to-lisp (&optional txt)
4995 "Convert the table at point to a Lisp structure.
4996 The structure will be a list. Each item is either the symbol `hline'
4997 for a horizontal separator line, or a list of field values as strings.
4998 The table is taken from the parameter TXT, or from the buffer at point."
4999 (unless (or txt (org-at-table-p)) (user-error "No table at point"))
5000 (let ((txt (or txt
5001 (buffer-substring-no-properties (org-table-begin)
5002 (org-table-end)))))
5003 (mapcar (lambda (x)
5004 (if (string-match org-table-hline-regexp x) 'hline
5008 (defun orgtbl-send-table (&optional maybe)
5009 "Send a transformed version of table at point to the receiver position.
5010 With argument MAYBE, fail quietly if no transformation is defined
5011 for this table."
5012 (interactive)
5013 (catch 'exit
5014 (unless (org-at-table-p) (user-error "Not at a table"))
5015 ;; when non-interactive, we assume align has just happened.
5016 (when (called-interactively-p 'any) (org-table-align))
5017 (let ((dests (orgtbl-gather-send-defs))
5018 (table (org-table-to-lisp
5019 (buffer-substring-no-properties (org-table-begin)
5020 (org-table-end))))
5021 (ntbl 0))
5022 (unless dests
5023 (if maybe (throw 'exit nil)
5024 (user-error "Don't know how to transform this table")))
5025 (dolist (dest dests)
5026 (let ((name (plist-get dest :name))
5027 (transform (plist-get dest :transform))
5028 (params (plist-get dest :params)))
5029 (unless (fboundp transform)
5030 (user-error "No such transformation function %s" transform))
5031 (orgtbl-send-replace-tbl name (funcall transform table params)))
5032 (cl-incf ntbl))
5033 (message "Table converted and installed at %d receiver location%s"
5034 ntbl (if (> ntbl 1) "s" ""))
5035 (and (> ntbl 0) ntbl))))
5037 (defun org-remove-by-index (list indices &optional i0)
5038 "Remove the elements in LIST with indices in INDICES.
5039 First element has index 0, or I0 if given."
5040 (if (not indices)
5041 list
5042 (if (integerp indices) (setq indices (list indices)))
5043 (setq i0 (1- (or i0 0)))
5044 (delq :rm (mapcar (lambda (x)
5045 (setq i0 (1+ i0))
5046 (if (memq i0 indices) :rm x))
5047 list))))
5049 (defun orgtbl-toggle-comment ()
5050 "Comment or uncomment the orgtbl at point."
5051 (interactive)
5052 (let* ((case-fold-search t)
5053 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
5054 (re2 (concat "^" orgtbl-line-start-regexp))
5055 (commented (save-excursion (beginning-of-line 1)
5056 (cond ((looking-at re1) t)
5057 ((looking-at re2) nil)
5058 (t (user-error "Not at an org table")))))
5059 (re (if commented re1 re2))
5060 beg end)
5061 (save-excursion
5062 (beginning-of-line 1)
5063 (while (looking-at re) (beginning-of-line 0))
5064 (beginning-of-line 2)
5065 (setq beg (point))
5066 (while (looking-at re) (beginning-of-line 2))
5067 (setq end (point)))
5068 (comment-region beg end (if commented '(4) nil))))
5070 (defun orgtbl-insert-radio-table ()
5071 "Insert a radio table template appropriate for this major mode."
5072 (interactive)
5073 (let* ((e (cl-assoc-if #'derived-mode-p orgtbl-radio-table-templates))
5074 (txt (nth 1 e))
5075 name pos)
5076 (unless e (user-error "No radio table setup defined for %s" major-mode))
5077 (setq name (read-string "Table name: "))
5078 (while (string-match "%n" txt)
5079 (setq txt (replace-match name t t txt)))
5081 (setq pos (point))
5082 (insert txt)
5083 (goto-char pos)))
5085 ;;;###autoload
5086 (defun orgtbl-to-generic (table params)
5087 "Convert the orgtbl-mode TABLE to some other format.
5089 This generic routine can be used for many standard cases.
5091 TABLE is a list, each entry either the symbol `hline' for
5092 a horizontal separator line, or a list of fields for that
5093 line. PARAMS is a property list of parameters that can
5094 influence the conversion.
5096 Valid parameters are:
5098 :backend, :raw
5100 Export back-end used as a basis to transcode elements of the
5101 table, when no specific parameter applies to it. It is also
5102 used to translate cells contents. You can prevent this by
5103 setting :raw property to a non-nil value.
5105 :splice
5107 When non-nil, only convert rows, not the table itself. This is
5108 equivalent to setting to the empty string both :tstart
5109 and :tend, which see.
5111 :skip
5113 When set to an integer N, skip the first N lines of the table.
5114 Horizontal separation lines do count for this parameter!
5116 :skipcols
5118 List of columns that should be skipped. If the table has
5119 a column with calculation marks, that column is automatically
5120 discarded beforehand.
5122 :hline
5124 String to be inserted on horizontal separation lines. May be
5125 nil to ignore these lines altogether.
5127 :sep
5129 Separator between two fields, as a string.
5131 Each in the following group may be either a string or a function
5132 of no arguments returning a string:
5134 :tstart, :tend
5136 Strings to start and end the table. Ignored when :splice is t.
5138 :lstart, :lend
5140 Strings to start and end a new table line.
5142 :llstart, :llend
5144 Strings to start and end the last table line. Default,
5145 respectively, to :lstart and :lend.
5147 Each in the following group may be a string or a function of one
5148 argument (either the cells in the current row, as a list of
5149 strings, or the current cell) returning a string:
5151 :lfmt
5153 Format string for an entire row, with enough %s to capture all
5154 fields. When non-nil, :lstart, :lend, and :sep are ignored.
5156 :llfmt
5158 Format for the entire last line, defaults to :lfmt.
5160 :fmt
5162 A format to be used to wrap the field, should contain %s for
5163 the original field value. For example, to wrap everything in
5165 a property list with column numbers and format strings, or
5166 functions, e.g.,
5170 :hlstart :hllstart :hlend :hllend :hsep :hlfmt :hllfmt :hfmt
5172 Same as above, specific for the header lines in the table.
5173 All lines before the first hline are treated as header. If
5174 any of these is not present, the data line value is used.
5176 This may be either a string or a function of two arguments:
5178 :efmt
5180 Use this format to print numbers with exponential. The format
5181 should have %s twice for inserting mantissa and exponent, for
5183 list with column numbers and format strings or functions.
5184 :fmt will still be applied after :efmt."
5185 ;; Make sure `org-export-create-backend' is available.
5186 (require 'ox)
5187 (let* ((backend (plist-get params :backend))
5188 (custom-backend
5189 ;; Build a custom back-end according to PARAMS. Before
5190 ;; defining a translator, check if there is anything to do.
5191 ;; When there isn't, let BACKEND handle the element.
5192 (org-export-create-backend
5193 :parent (or backend 'org)
5194 :transcoders
5195 `((table . ,(org-table--to-generic-table params))
5196 (table-row . ,(org-table--to-generic-row params))
5197 (table-cell . ,(org-table--to-generic-cell params))
5198 ;; Macros are not going to be expanded. However, no
5199 ;; regular back-end has a transcoder for them. We
5200 ;; provide one so they are not ignored, but displayed
5201 ;; as-is instead.
5202 (macro . (lambda (m c i) (org-element-macro-interpreter m nil))))))
5203 data info)
5204 ;; Store TABLE as Org syntax in DATA. Tolerate non-string cells.
5205 ;; Initialize communication channel in INFO.
5206 (with-temp-buffer
5207 (let ((org-inhibit-startup t)) (org-mode))
5208 (let ((standard-output (current-buffer))
5209 (org-element-use-cache nil))
5210 (dolist (e table)
5212 ((consp e)
5213 (princ "| ") (dolist (c e) (princ c) (princ " |"))
5215 ;; Add back-end specific filters, but not user-defined ones. In
5216 ;; particular, make sure to call parse-tree filters on the
5217 ;; table.
5218 (setq info
5219 (let ((org-export-filters-alist nil))
5220 (org-export-install-filters
5221 (org-combine-plists
5222 (org-export-get-environment backend nil params)
5223 `(:back-end ,(org-export-get-backend backend))))))
5224 (setq data
5225 (org-export-filter-apply-functions
5226 (plist-get info :filter-parse-tree)
5227 (org-element-map (org-element-parse-buffer) 'table
5228 #'identity nil t)
5229 info)))
5230 (when (and backend (symbolp backend) (not (org-export-get-backend backend)))
5231 (user-error "Unknown :backend value"))
5232 (when (or (not backend) (plist-get info :raw)) (require 'ox-org))
5233 ;; Handle :skip parameter.
5234 (let ((skip (plist-get info :skip)))
5235 (when skip
5236 (unless (wholenump skip) (user-error "Wrong :skip value"))
5237 (let ((n 0))
5238 (org-element-map data 'table-row
5239 (lambda (row)
5240 (if (>= n skip) t
5241 (org-element-extract-element row)
5242 (cl-incf n)
5243 nil))
5244 nil t))))
5245 ;; Handle :skipcols parameter.
5246 (let ((skipcols (plist-get info :skipcols)))
5247 (when skipcols
5248 (unless (consp skipcols) (user-error "Wrong :skipcols value"))
5249 (org-element-map data 'table
5250 (lambda (table)
5251 (let ((specialp (org-export-table-has-special-column-p table)))
5252 (dolist (row (org-element-contents table))
5253 (when (eq (org-element-property :type row) 'standard)
5254 (let ((c 1))
5255 (dolist (cell (nthcdr (if specialp 1 0)
5256 (org-element-contents row)))
5257 (when (memq c skipcols)
5258 (org-element-extract-element cell))
5259 (cl-incf c))))))))))
5260 ;; Since we are going to export using a low-level mechanism,
5261 ;; ignore special column and special rows manually.
5262 (let ((special? (org-export-table-has-special-column-p data))
5263 ignore)
5264 (org-element-map data (if special? '(table-cell table-row) 'table-row)
5265 (lambda (datum)
5266 (when (if (eq (org-element-type datum) 'table-row)
5267 (org-export-table-row-is-special-p datum nil)
5268 (org-export-first-sibling-p datum nil))
5269 (push datum ignore))))
5270 (setq info (plist-put info :ignore-list ignore)))
5271 ;; We use a low-level mechanism to export DATA so as to skip all
5272 ;; usual pre-processing and post-processing, i.e., hooks, Babel
5273 ;; code evaluation, include keywords and macro expansion. Only
5274 ;; back-end specific filters are retained.
5275 (let ((output (org-export-data-with-backend data custom-backend info)))
5276 ;; Remove final newline.
5277 (if (org-string-nw-p output) (substring-no-properties output 0 -1) ""))))
5279 (defun org-table--generic-apply (value name &optional with-cons &rest args)
5280 (cond ((null value) nil)
5281 ((functionp value) `(funcall ',value ,@args))
5282 ((stringp value)
5283 (cond ((consp (car args)) `(apply #'format ,value ,@args))
5284 (args `(format ,value ,@args))
5285 (t value)))
5286 ((and with-cons (consp value))
5287 `(let ((val (cadr (memq column ',value))))
5288 (cond ((null val) contents)
5289 ((stringp val) (format val ,@args))
5290 ((functionp val) (funcall val ,@args))
5291 (t (user-error "Wrong %s value" ,name)))))
5292 (t (user-error "Wrong %s value" name))))
5294 (defun org-table--to-generic-table (params)
5295 "Return custom table transcoder according to PARAMS.
5296 PARAMS is a plist. See `orgtbl-to-generic' for more
5297 information."
5298 (let ((backend (plist-get params :backend))
5299 (splice (plist-get params :splice))
5300 (tstart (plist-get params :tstart))
5301 (tend (plist-get params :tend)))
5302 `(lambda (table contents info)
5303 (concat
5304 ,(and tstart (not splice)
5306 ,(if (or (not backend) tstart tend splice) 'contents
5307 `(org-export-with-backend ',backend table contents info))
5308 ,(org-table--generic-apply (and (not splice) tend) ":tend")))))
5310 (defun org-table--to-generic-row (params)
5311 "Return custom table row transcoder according to PARAMS.
5312 PARAMS is a plist. See `orgtbl-to-generic' for more
5313 information."
5314 (let* ((backend (plist-get params :backend))
5315 (lstart (plist-get params :lstart))
5316 (llstart (plist-get params :llstart))
5317 (hlstart (plist-get params :hlstart))
5318 (hllstart (plist-get params :hllstart))
5319 (lend (plist-get params :lend))
5320 (llend (plist-get params :llend))
5321 (hlend (plist-get params :hlend))
5322 (hllend (plist-get params :hllend))
5323 (lfmt (plist-get params :lfmt))
5324 (llfmt (plist-get params :llfmt))
5325 (hlfmt (plist-get params :hlfmt))
5326 (hllfmt (plist-get params :hllfmt)))
5327 `(lambda (row contents info)
5328 (if (eq (org-element-property :type row) 'rule)
5329 ,(cond
5330 ((plist-member params :hline)
5331 (org-table--generic-apply (plist-get params :hline) ":hline"))
5332 (backend `(org-export-with-backend ',backend row nil info)))
5333 (let ((headerp ,(and (or hlfmt hlstart hlend)
5334 '(org-export-table-row-in-header-p row info)))
5335 (last-header-p
5336 ,(and (or hllfmt hllstart hllend)
5337 '(org-export-table-row-ends-header-p row info)))
5338 (lastp (not (org-export-get-next-element row info))))
5339 (when contents
5340 ;; Check if we can apply `:lfmt', `:llfmt', `:hlfmt', or
5341 ;; `:hllfmt' to CONTENTS. Otherwise, fallback on
5342 ;; `:lstart', `:lend' and their relatives.
5343 ,(let ((cells
5344 '(org-element-map row 'table-cell
5345 (lambda (cell)
5346 ;; Export all cells, without separators.
5347 ;;
5348 ;; Use `org-export-data-with-backend'
5349 ;; instead of `org-export-data' to eschew
5350 ;; cached values, which
5351 ;; ignore :orgtbl-ignore-sep parameter.
5352 (org-export-data-with-backend
5353 cell
5354 (plist-get info :back-end)
5355 (org-combine-plists info '(:orgtbl-ignore-sep t))))
5356 info)))
5357 `(cond
5358 ,(and hllfmt
5359 `(last-header-p ,(org-table--generic-apply
5360 hllfmt ":hllfmt" nil cells)))
5361 ,(and hlfmt
5362 `(headerp ,(org-table--generic-apply
5363 hlfmt ":hlfmt" nil cells)))
5364 ,(and llfmt
5365 `(lastp ,(org-table--generic-apply
5366 llfmt ":llfmt" nil cells)))
5367 (t
5368 ,(if lfmt (org-table--generic-apply lfmt ":lfmt" nil cells)
5369 `(concat
5370 (cond
5371 ,(and
5372 (or hllstart hllend)
5373 `(last-header-p
5374 (concat
5375 ,(org-table--generic-apply hllstart ":hllstart")
5376 contents
5377 ,(org-table--generic-apply hllend ":hllend"))))
5378 ,(and
5379 (or hlstart hlend)
5380 `(headerp
5381 (concat
5382 ,(org-table--generic-apply hlstart ":hlstart")
5383 contents
5384 ,(org-table--generic-apply hlend ":hlend"))))
5385 ,(and
5386 (or llstart llend)
5387 `(lastp
5388 (concat
5389 ,(org-table--generic-apply llstart ":llstart")
5390 contents
5391 ,(org-table--generic-apply llend ":llend"))))
5392 (t
5393 ,(cond
5394 ((or lstart lend)
5395 `(concat
5396 ,(org-table--generic-apply lstart ":lstart")
5397 contents
5398 ,(org-table--generic-apply lend ":lend")))
5399 (backend
5400 `(org-export-with-backend
5401 ',backend row contents info))
5402 (t 'contents)))))))))))))))
5404 (defun org-table--to-generic-cell (params)
5405 "Return custom table cell transcoder according to PARAMS.
5406 PARAMS is a plist. See `orgtbl-to-generic' for more
5407 information."
5408 (let* ((backend (plist-get params :backend))
5409 (efmt (plist-get params :efmt))
5410 (fmt (plist-get params :fmt))
5411 (hfmt (plist-get params :hfmt))
5412 (sep (plist-get params :sep))
5413 (hsep (plist-get params :hsep)))
5414 `(lambda (cell contents info)
5415 ;; Make sure that contents are exported as Org data when :raw
5416 ;; parameter is non-nil.
5417 ,(when (and backend (plist-get params :raw))
5418 `(setq contents
5419 ;; Since we don't know what are the pseudo object
5420 ;; types defined in backend, we cannot pass them to
5421 ;; `org-element-interpret-data'. As a consequence,
5422 ;; they will be treated as pseudo elements, and will
5423 ;; have newlines appended instead of spaces.
5424 ;; Therefore, we must make sure :post-blank value is
5425 ;; really turned into spaces.
5426 (replace-regexp-in-string
5428 (org-trim
5429 (org-element-interpret-data
5430 (org-element-contents cell))))))
5432 (let ((headerp ,(and (or hfmt hsep)
5433 '(org-export-table-row-in-header-p
5434 (org-export-get-parent-element cell) info)))
5435 (column
5436 ;; Call costly `org-export-table-cell-address' only if
5437 ;; absolutely necessary, i.e., if one
5438 ;; of :fmt :efmt :hfmt has a "plist type" value.
5439 ,(and (cl-some (lambda (v) (integerp (car-safe v)))
5440 (list efmt hfmt fmt))
5441 '(1+ (cdr (org-export-table-cell-address cell info))))))
5442 (when contents
5443 ;; Check if we can apply `:efmt' on CONTENTS.
5444 ,(when efmt
5445 `(when (string-match orgtbl-exp-regexp contents)
5446 (let ((mantissa (match-string 1 contents))
5447 (exponent (match-string 2 contents)))
5448 (setq contents ,(org-table--generic-apply
5449 efmt ":efmt" t 'mantissa 'exponent)))))
5450 ;; Check if we can apply FMT (or HFMT) on CONTENTS.
5451 (cond
5452 ,(and hfmt `(headerp (setq contents ,(org-table--generic-apply
5453 hfmt ":hfmt" t 'contents))))
5454 ,(and fmt `(t (setq contents ,(org-table--generic-apply
5455 fmt ":fmt" t 'contents))))))
5456 ;; If a separator is provided, use it instead of BACKEND's.
5457 ;; Separators are ignored when LFMT (or equivalent) is
5458 ;; provided.
5459 ,(cond
5460 ((or hsep sep)
5461 `(if (or ,(and (not sep) '(not headerp))
5462 (plist-get info :orgtbl-ignore-sep)
5463 (not (org-export-get-next-element cell info)))
5464 ,(if (not backend) 'contents
5465 `(org-export-with-backend ',backend cell contents info))
5466 (concat contents
5467 ,(if (and sep hsep) `(if headerp ,hsep ,sep)
5468 (or hsep sep)))))
5469 (backend `(org-export-with-backend ',backend cell contents info))
5470 (t 'contents))))))
5472 ;;;###autoload
5473 (defun orgtbl-to-tsv (table params)
5474 "Convert the orgtbl-mode table to TAB separated material."
5477 ;;;###autoload
5478 (defun orgtbl-to-csv (table params)
5479 "Convert the orgtbl-mode table to CSV material.
5480 This does take care of the proper quoting of fields with comma or quotes."
5481 (orgtbl-to-generic table
5482 (org-combine-plists '(:sep "," :fmt org-quote-csv-field)
5483 params)))
5485 ;;;###autoload
5486 (defun orgtbl-to-latex (table params)
5487 "Convert the orgtbl-mode TABLE to LaTeX.
5489 TABLE is a list, each entry either the symbol `hline' for
5490 a horizontal separator line, or a list of fields for that line.
5491 PARAMS is a property list of parameters that can influence the
5492 conversion. All parameters from `orgtbl-to-generic' are
5493 supported. It is also possible to use the following ones:
5495 :booktabs
5499 :environment
5501 Specify environment to use, as a string. If you use
5503 as a string, to get proper continuation strings."
5504 (require 'ox-latex)
5505 (orgtbl-to-generic
5506 table
5507 (org-combine-plists
5508 ;; Provide sane default values.
5509 (list :backend 'latex
5510 :latex-default-table-mode 'table
5511 :latex-tables-centered nil
5512 :latex-tables-booktabs (plist-get params :booktabs)
5513 :latex-table-scientific-notation nil
5514 :latex-default-table-environment
5515 (or (plist-get params :environment) "tabular"))
5516 params)))
5518 ;;;###autoload
5519 (defun orgtbl-to-html (table params)
5520 "Convert the orgtbl-mode TABLE to HTML.
5522 TABLE is a list, each entry either the symbol `hline' for
5523 a horizontal separator line, or a list of fields for that line.
5524 PARAMS is a property list of parameters that can influence the
5525 conversion. All parameters from `orgtbl-to-generic' are
5526 supported. It is also possible to use the following one:
5528 :attributes
5530 Attributes and values, as a plist, which will be used in
5531 <table> tag."
5532 (require 'ox-html)
5533 (orgtbl-to-generic
5534 table
5535 (org-combine-plists
5536 ;; Provide sane default values.
5537 (list :backend 'html
5538 :html-table-data-tags '("<td%s>" . "</td>")
5539 :html-table-use-header-tags-for-first-column nil
5540 :html-table-align-individual-fields t
5541 :html-table-row-tags '("<tr>" . "</tr>")
5542 :html-table-attributes
5543 (if (plist-member params :attributes)
5544 (plist-get params :attributes)
5545 '(:border "2" :cellspacing "0" :cellpadding "6" :rules "groups"
5546 :frame "hsides")))
5547 params)))
5549 ;;;###autoload
5550 (defun orgtbl-to-texinfo (table params)
5551 "Convert the orgtbl-mode TABLE to Texinfo.
5553 TABLE is a list, each entry either the symbol `hline' for
5554 a horizontal separator line, or a list of fields for that line.
5555 PARAMS is a property list of parameters that can influence the
5556 conversion. All parameters from `orgtbl-to-generic' are
5557 supported. It is also possible to use the following one:
5559 :columns
5561 Column widths, as a string. When providing column fractions,
5563 (require 'ox-texinfo)
5564 (let ((output
5565 (orgtbl-to-generic
5566 table
5567 (org-combine-plists
5568 (list :backend 'texinfo
5569 :texinfo-tables-verbatim nil
5570 :texinfo-table-scientific-notation nil)
5571 params)))
5572 (columns (let ((w (plist-get params :columns)))
5573 (cond ((not w) nil)
5575 (t (concat "@columnfractions " w))))))
5576 (if (not columns) output
5577 (replace-regexp-in-string
5580 ;;;###autoload
5581 (defun orgtbl-to-orgtbl (table params)
5582 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
5584 TABLE is a list, each entry either the symbol `hline' for
5585 a horizontal separator line, or a list of fields for that line.
5586 PARAMS is a property list of parameters that can influence the
5587 conversion. All parameters from `orgtbl-to-generic' are
5588 supported.
5590 Useful when slicing one table into many. The :hline, :sep,
5591 :lstart, and :lend provide orgtbl framing. :tstart and :tend can
5592 be set to provide ORGTBL directives for the generated table."
5593 (require 'ox-org)
5594 (orgtbl-to-generic table (org-combine-plists params (list :backend 'org))))
5596 (defun orgtbl-to-table.el (table params)
5597 "Convert the orgtbl-mode TABLE into a table.el table.
5598 TABLE is a list, each entry either the symbol `hline' for
5599 a horizontal separator line, or a list of fields for that line.
5600 PARAMS is a property list of parameters that can influence the
5601 conversion. All parameters from `orgtbl-to-generic' are
5602 supported."
5603 (with-temp-buffer
5604 (insert (orgtbl-to-orgtbl table params))
5605 (org-table-align)
5606 (replace-regexp-in-string
5607 "-|" "-+"
5608 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
5610 (defun orgtbl-to-unicode (table params)
5611 "Convert the orgtbl-mode TABLE into a table with unicode characters.
5613 TABLE is a list, each entry either the symbol `hline' for
5614 a horizontal separator line, or a list of fields for that line.
5615 PARAMS is a property list of parameters that can influence the
5616 conversion. All parameters from `orgtbl-to-generic' are
5617 supported. It is also possible to use the following ones:
5619 :ascii-art
5622 the table. You can download it here:
5623 http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el.
5625 :narrow
5627 When non-nil, narrow columns width than provided width cookie,
5629 (require 'ox-ascii)
5630 (orgtbl-to-generic
5631 table
5632 (org-combine-plists
5633 (list :backend 'ascii
5634 :ascii-charset 'utf-8
5635 :ascii-table-widen-columns (not (plist-get params :narrow))
5636 :ascii-table-use-ascii-art (plist-get params :ascii-art))
5637 params)))
5639 ;; Put the cursor in a column containing numerical values
5640 ;; of an Org table,
5641 ;; type C-c " a
5642 ;; A new column is added with a bar plot.
5643 ;; When the table is refreshed (C-u C-c *),
5644 ;; the plot is updated to reflect the new values.
5646 (defun orgtbl-ascii-draw (value min max &optional width characters)
5647 "Draw an ascii bar in a table.
5648 VALUE is the value to plot, it determines the width of the bar to draw.
5649 MIN is the value that will be displayed as empty (zero width bar).
5650 MAX is the value that will draw a bar filling all the WIDTH.
5651 WIDTH is the span in characters from MIN to MAX.
5652 CHARACTERS is a string that will compose the bar, with shades of grey
5653 from pure white to pure black. It defaults to a 10 characters string
5654 of regular ascii characters."
5655 (let* ((width (ceiling (or width 12)))
5656 (characters (or characters " .:;c!lhVHW"))
5657 (len (1- (length characters)))
5658 (value (float (if (numberp value)
5659 value (string-to-number value))))
5660 (relative (/ (- value min) (- max min)))
5661 (steps (round (* relative width len))))
5662 (cond ((< steps 0) "too small")
5663 ((> steps (* width len)) "too large")
5664 (t (let* ((int-division (/ steps len))
5665 (remainder (- steps (* int-division len))))
5666 (concat (make-string int-division (elt characters len))
5667 (string (elt characters remainder))))))))
5669 ;;;###autoload
5670 (defun orgtbl-ascii-plot (&optional ask)
5671 "Draw an ASCII bar plot in a column.
5673 With cursor in a column containing numerical values, this function
5674 will draw a plot in a new column.
5676 ASK, if given, is a numeric prefix to override the default 12
5678 prefix,
5679 which will prompt for the width."
5680 (interactive "P")
5681 (let ((col (org-table-current-column))
5682 (min 1e999) ; 1e999 will be converted to infinity
5683 (max -1e999) ; which is the desired result
5684 (table (org-table-to-lisp))
5685 (length
5686 (cond ((consp ask)
5687 (read-number "Length of column " 12))
5688 ((numberp ask) ask)
5689 (t 12))))
5690 ;; Skip any hline a the top of table.
5691 (while (eq (car table) 'hline) (setq table (cdr table)))
5692 ;; Skip table header if any.
5693 (dolist (x (or (cdr (memq 'hline table)) table))
5694 (when (consp x)
5695 (setq x (nth (1- col) x))
5696 (when (string-match
5698 x)
5699 (setq x (string-to-number x))
5700 (when (> min x) (setq min x))
5701 (when (< max x) (setq max x)))))
5702 (org-table-insert-column)
5703 (org-table-move-column-right)
5704 (org-table-store-formulas
5705 (cons
5706 (cons
5707 (concat "$" (number-to-string (1+ col)))
5708 (format "'(%s $%s %s %s %s)"
5709 "orgtbl-ascii-draw" col min max length))
5710 (org-table-get-stored-formulas)))
5711 (org-table-recalculate t)))
5713 ;; Example of extension: unicode characters
5714 ;; Here are two examples of different styles.
5716 ;; Unicode block characters are used to give a smooth effect.
5717 ;; See http://en.wikipedia.org/wiki/Block_Elements
5718 ;; Use one of those drawing functions
5719 ;; - orgtbl-ascii-draw (the default ascii)
5720 ;; - orgtbl-uc-draw-grid (unicode with a grid effect)
5721 ;; - orgtbl-uc-draw-cont (smooth unicode)
5723 ;; This is best viewed with the "DejaVu Sans Mono" font
5724 ;; (use M-x set-default-font).
5726 (defun orgtbl-uc-draw-grid (value min max &optional width)
5727 "Draw a bar in a table using block unicode characters.
5728 It is a variant of orgtbl-ascii-draw with Unicode block
5729 characters, for a smooth display. Bars appear as grids (to the
5730 extent the font allows)."
5731 ;; http://en.wikipedia.org/wiki/Block_Elements
5732 ;; best viewed with the "DejaVu Sans Mono" font.
5733 (orgtbl-ascii-draw value min max width
5736 (defun orgtbl-uc-draw-cont (value min max &optional width)
5737 "Draw a bar in a table using block unicode characters.
5738 It is a variant of orgtbl-ascii-draw with Unicode block
5739 characters, for a smooth display. Bars are solid (to the extent
5740 the font allows)."
5741 (orgtbl-ascii-draw value min max width
5744 (defun org-table-get-remote-range (name-or-id form)
5745 "Get a field value or a list of values in a range from table at ID.
5747 NAME-OR-ID may be the name of a table in the current file as set
5749 will then be used. Alternatively, it may be an ID referring to
5750 any entry, also in a different file. In this case, the first
5751 table in that entry will be referenced.
5755 The return value is either a single string for a single field, or a
5756 list of the fields in the rectangle."
5757 (save-match-data
5758 (let ((case-fold-search t) (id-loc nil)
5759 ;; Protect a bunch of variables from being overwritten by
5760 ;; the context of the remote table.
5761 org-table-column-names org-table-column-name-regexp
5762 org-table-local-parameters org-table-named-field-locations
5763 org-table-current-line-types
5764 org-table-current-begin-pos org-table-dlines
5765 org-table-current-ncol
5766 org-table-hlines
5767 org-table-last-column-widths
5768 org-table-last-alignment
5769 buffer loc)
5770 (setq form (org-table-convert-refs-to-rc form))
5771 (org-with-wide-buffer
5772 (goto-char (point-min))
5773 (if (re-search-forward
5776 nil t)
5777 (setq buffer (current-buffer) loc (match-beginning 0))
5778 (setq id-loc (org-id-find name-or-id 'marker))
5779 (unless (and id-loc (markerp id-loc))
5781 (setq buffer (marker-buffer id-loc)
5782 loc (marker-position id-loc))
5783 (move-marker id-loc nil))
5784 (with-current-buffer buffer
5785 (org-with-wide-buffer
5786 (goto-char loc)
5787 (forward-char 1)
5789 (not (match-beginning 1)))
5790 (user-error "Cannot find a table at NAME or ID %s" name-or-id))
5791 (org-table-analyze)
5792 (setq form (org-table-formula-substitute-names
5793 (org-table-formula-handle-first/last-rc form)))
5794 (if (and (string-match org-table-range-regexp form)
5795 (> (length (match-string 0 form)) 1))
5796 (org-table-get-range
5797 (match-string 0 form) org-table-current-begin-pos 1)
5798 form)))))))
5800 (defun org-table-remote-reference-indirection (form)
5801 "Return formula with table remote references substituted by indirection.
5803 This indirection works only with the format @ROW$COLUMN. The
5805 distinguished from a plain table name or ID."
5806 (let ((regexp
5807 ;; Same as in `org-table-eval-formula'.
5809 ;; Allow "$1", "@<", "$-1", "@<<$1" etc.
5812 (replace-regexp-in-string
5813 regexp
5814 (lambda (m)
5815 (save-match-data
5816 (let ((eq (org-table-formula-handle-first/last-rc (match-string 1 m))))
5817 (org-table-get-range
5819 (concat "@0" eq)
5820 eq)))))
5821 form t t 1)))
5823 (defmacro org-define-lookup-function (mode)
5824 (let ((mode-str (symbol-name mode))
5825 (first-p (eq mode 'first))
5826 (all-p (eq mode 'all)))
5827 (let ((plural-str (if all-p "s" "")))
5828 `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
5829 ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
5830 If R-LIST is nil, return matching element%s of S-LIST.
5831 If PREDICATE is not nil, use it instead of `equal' to match VAL.
5832 Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
5833 This function is generated by a call to the macro `org-define-lookup-function'."
5834 mode-str plural-str plural-str plural-str)
5835 (let ,(let ((lvars '((p (or predicate 'equal))
5836 (sl s-list)
5837 (rl (or r-list s-list))
5838 (ret nil))))
5839 (if first-p (cons '(match-p nil) lvars) lvars))
5840 (while ,(if first-p '(and (not match-p) sl) 'sl)
5841 (when (funcall p val (car sl))
5842 ,(when first-p '(setq match-p t))
5843 (let ((rval (car rl)))
5844 (setq ret ,(if all-p '(append ret (list rval)) 'rval))))
5845 (setq sl (cdr sl) rl (cdr rl)))
5846 ret)))))
5848 (org-define-lookup-function first)
5849 (org-define-lookup-function last)
5850 (org-define-lookup-function all)
5852 (provide 'org-table)
5854 ;; Local variables:
5855 ;; generated-autoload-file: "org-loaddefs.el"
5856 ;; End:
5858 ;;; org-table.el ends here