| blob | fe9efca073b72c3ef5c34c85b43ee2da08c0ac75 |
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 <http://www.gnu.org/licenses/>.
23 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
24 ;;
25 ;;; Commentary:
27 ;; This file contains the table editor and spreadsheet for Org mode.
29 ;; Watch out: Here we are talking about two different kind of tables.
30 ;; Most of the code is for the tables created with the Org mode table editor.
31 ;; Sometimes, we talk about tables created and edited with the table.el
32 ;; Emacs package. We call the former org-type tables, and the latter
33 ;; table.el-type tables.
35 ;;; Code:
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.
775 ;;;###autoload
777 "Align the table at point by aligning all vertical bars."
782 ;; Make sure invisible characters in the table are at the right
783 ;; place since column widths take them into account.
793 end t)))
794 ;; Table's rows. Rules are replaced by nil. Trailing
795 ;; spaces are removed.
799 l))
801 ;; List of lists of data fields.
804 ;; Compute number of fields in the longest line. If the
805 ;; table contains no field, create a default table.
810 ;; A list of empty strings to fill any short rows on output.
812 lengths typenums)
813 ;; Compute alignment and width for each column.
816 fields))
821 cell)
823 column))))
824 ;; Get the maximum width for each column.
826 lengths)
827 ;; If there is no alignment cookie, get the fraction of
828 ;; numbers among non-empty cells to decide about alignment
829 ;; of the column.
838 1
844 ;; Store alignment of this table, for later editing of single
845 ;; fields.
848 ;; With invisible characters, `format' does not get the field
849 ;; width right So we need to make these fields wide by hand.
850 ;; Invisible characters may be introduced by fontified links,
851 ;; emphasis, macros or sub/superscripts.
869 ;; Compute the formats needed for output of the table.
878 ;; Replace modified lines only.
882 hfmt))
892 ;;;###autoload
894 "Find the beginning of the table and return its position.
895 With a non-nil optional argument TABLE-TYPE, return the beginning
896 of a table.el-type table. This function assumes point is on
897 a table."
905 ;;;###autoload
907 "Find the end of the table and return its position.
908 With a non-nil optional argument TABLE-TYPE, return the end of
909 a table.el-type table. This function assumes point is on
910 a table."
918 ;; When the line right after the table is the last line in
919 ;; the buffer with trailing spaces but no final newline
920 ;; character, be sure to catch the correct ending at its
921 ;; beginning. In any other case, ending is expected to be
922 ;; at point max.
927 ;;;###autoload
929 "Justify the current field, text to left, number to right.
930 Optional argument NEW may specify text to replace the current field content."
939 ;; This is not the same table, force a full re-align.
942 ;; Realign the current field, based on previous full realign.
955 len
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."
1378 ;; Shift appropriately stored shrunk column numbers, then hide the
1379 ;; columns again.
1381 shrunk-columns)
1382 beg end)
1384 ;; Fix TBLFM formulas, if desirable.
1391 "Find a data line in the current table, which is needed for column commands."
1394 t
1405 t
1410 "Turn a buffer line number into a data line number.
1412 If there is no data line in this line, return nil.
1414 If there is no matching dline (most likely the reference was
1415 a hline), the first dline below it is used. When ABOVE is
1416 non-nil, the one above is used."
1421 nil)
1432 ;;;###autoload
1434 "Delete a column from the table."
1448 nil
1455 ;; Shift appropriately stored shrunk column numbers, then hide the
1456 ;; columns again.
1458 shrunk-columns)
1459 beg end)
1461 ;; Fix TBLFM formulas, if desirable.
1469 ;;;###autoload
1471 "Move column to the right."
1475 ;;;###autoload
1477 "Move column to the left."
1481 ;;;###autoload
1483 "Move the current column to the right. With arg LEFT, move to the left."
1511 ;; Shift appropriately stored shrunk column numbers, then shrink
1512 ;; the columns again.
1520 shrunk-columns)
1521 beg end)
1523 ;; Fix TBLFM formulas, if desirable.
1534 ;;;###autoload
1536 "Move table row down."
1540 ;;;###autoload
1542 "Move table row up."
1546 ;;;###autoload
1548 "Move the current table line down. With arg UP, move it up."
1557 hline2p)
1584 ;;;###autoload
1586 "Insert a new row above the current line into the table.
1587 With prefix ARG, insert below the current line."
1593 ;; Fix the first field if necessary
1597 ;; Buffer may not end of a newline character, so ensure
1598 ;; (beginning-of-line 2) moves point to a new line.
1609 ;;;###autoload
1611 "Insert a horizontal-line below the current line into the table.
1612 With prefix ABOVE, insert above the current line."
1633 ;;;###autoload
1635 "Insert a hline and move to the row below that line."
1649 In particular, this does handle wide and invisible characters."
1651 ;; It's a hline, just map the characters
1657 t t s)))
1658 s))
1660 ;;;###autoload
1662 "Delete the current row or horizontal line from the table."
1676 ;;;###autoload
1679 "Sort table lines according to the column at point.
1681 The position of point indicates the column to be used for
1682 sorting, and the range of lines is the range between the nearest
1683 horizontal separator lines, or the entire table of no such lines
1684 exist. If point is before the first column, you will be prompted
1685 for the sorting column. If there is an active region, the mark
1686 specifies the first line and the sorting column, while point
1687 should be in the last line to be included into the sorting.
1689 The command then prompts for the sorting type which can be
1690 alphabetically, numerically, or by time (as given in a time stamp
1691 in the field, or as a HH:MM value). Sorting in reverse order is
1692 also possible.
1694 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1696 If SORTING-TYPE is specified when this function is called from a Lisp
1697 program, no prompting will take place. SORTING-TYPE must be a character,
1698 any of (?a ?A ?n ?N ?t ?T ?f ?F) where the capital letters indicate that
1699 sorting should be done in reverse order.
1701 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
1702 a function to be called to extract the key. It must return a value
1703 that is compatible with COMPARE-FUNC, the function used to compare
1704 entries.
1706 A non-nil value for INTERACTIVE? is used to signal that this
1707 function is being called interactively."
1710 ;; Point must be either within a field or before a data line.
1715 ;; Set appropriate case sensitivity and column used for sorting.
1728 ;; Narrow buffer to appropriate sorting area.
1739 start))
1742 end)))
1743 ;; Determine arguments for `sort-subr'. Also record original
1744 ;; position. `org-table-save-field' cannot help here since
1745 ;; sorting is too much destructive.
1751 ;; Function to be called on the contents of the field
1752 ;; used for sorting in the current row.
1779 "Function for comparing keys (empty for default \
1780 `sort-subr' predicate): "
1790 #'end-of-line
1794 nil
1795 predicate)
1796 ;; Hide all columns but the one being sorted.
1798 ;; Move back to initial field.
1802 ;;;###autoload
1804 "Copy region in table to the clipboard and blank all relevant fields.
1805 If there is no active region, use just the field at point."
1811 ;;;###autoload
1813 "Copy rectangular region in table to clipboard.
1814 A special clipboard is used which can only be accessed
1815 with `org-table-paste-rectangle'."
1819 current-prefix-arg))
1824 region)
1836 ;; Collect every cell between COLUMN-START and COLUMN-END.
1846 ;;;###autoload
1848 "Paste a rectangular region into a table.
1849 The upper right corner ends up in the current field. All involved fields
1850 will be overwritten. If the rectangle does not fit into the present table,
1851 the table is enlarged as needed. The process ignores horizontal separator
1852 lines."
1862 ;; If we left the table, create a new row.
1874 ;;;###autoload
1876 "Convert from `org-mode' table to table.el and back.
1877 Obviously, this only works within limits. When an Org table is converted
1878 to table.el, all horizontal separator lines get lost, because table.el uses
1879 these as cell boundaries and has no notion of horizontal lines. A table.el
1880 table can be converted to an Org table only if it does not do row or column
1881 spanning. Multiline cells will become multiple cells. Beware, Org mode
1882 does not test if the table can be successfully converted - it blindly
1883 applies a recipe that works for simple tables."
1887 ;; convert to Org table
1896 ;; convert to table.el table
1899 ;; first, get rid of all horizontal lines
1903 ;; insert a hline before first
1907 ;; insert a hline after each line
1912 ;; replace "+" at beginning and ending of hlines
1921 "Transpose Org table at point and eliminate hlines.
1922 So a table like
1924 | 1 | 2 | 4 | 5 |
1925 |---+---+---+---|
1926 | a | b | c | d |
1927 | e | f | g | h |
1929 will be transposed as
1931 | 1 | a | e |
1932 | 2 | b | f |
1933 | 4 | c | g |
1934 | 5 | d | h |
1936 Note that horizontal lines disappear."
1948 table)))
1962 ;;;###autoload
1964 "Wrap several fields in a column like a paragraph.
1965 This is useful if you'd like to spread the contents of a field over several
1966 lines, in order to keep the table compact.
1968 If there is an active region, and both point and mark are in the same column,
1969 the text in the column is wrapped to minimum width for the given number of
1970 lines. Generally, this makes the table more compact. A prefix ARG may be
1971 used to change the number of desired lines. For example, \
1973 formats the selected text to two lines. If the region was longer than two
1974 lines, the remaining lines remain empty. A negative prefix argument reduces
1975 the current number of lines by that amount. The wrapped text is pasted back
1976 into the table. If you formatted it to more lines than it was before, fields
1977 further down in the table get overwritten - so you might need to make space in
1978 the table first.
1980 If there is no region, the current field is split at the cursor position and
1981 the text fragment to the right of the cursor is prepended to the field one
1982 line down.
1984 If there is no region, but you specify a prefix ARG, the current field gets
1985 blank, and the content is appended to the field above."
1989 ;; There is a region: fill as a paragraph.
2000 nil
2001 nlines))))
2004 ;; No region, split the current field at point.
2029 ;;;###autoload
2031 "Edit table field in a different window.
2032 This is mainly useful for fields that contain hidden parts.
2035 visible so that it can be edited in place.
2038 toggle `org-table-follow-field-mode'."
2060 p)
2082 "Finish editing a table data field.
2083 Remove all newline characters, insert the result into the table, realign
2084 the table and kill the editing buffer."
2088 text)
2105 "Minor mode to make the table field editor window follow the cursor.
2106 When this mode is active, the field editor window will always show the
2107 current field. The mode exits automatically when the cursor leaves the
2108 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
2109 nil " TblFollow" nil
2125 ;; We have left the table, exit the follow mode
2135 ;;;###autoload
2137 "Sum numbers in region of current table column.
2138 The result will be displayed in the echo area, and will be available
2141 If there is an active region, it is interpreted as a rectangle and all
2142 numbers in that rectangle will be summed. If there is no active
2143 region and point is located in a table column, sum all numbers in that
2144 column.
2146 If at least one number looks like a time HH:MM or HH:MM:SS, all other
2147 numbers are assumed to be times as well (in decimal hours) and the
2148 numbers are added as such.
2150 If NLAST is a number, only the NLAST fields will actually be summed."
2177 items1)))
2184 s diff)
2191 sres))))
2214 "Return the formula active for the current field.
2216 Assumes that table is already analyzed. If KEY is given, return
2217 the key to this formula. Otherwise return the formula preceded
2226 org-table-named-field-locations)))
2240 "Read a formula from the minibuffer, offer stored formula as default.
2241 When NAMED is non-nil, look for a named equation."
2246 org-table-named-field-locations)))
2259 stored)
2261 equation)
2267 scol))
2269 'org-table-formula-history
2270 )))))
2271 mustsave)
2273 ;; remove formula
2280 ;; We set the column equation, delete the named one.
2282 mustsave t))
2288 eq))
2291 "Store the list of formulas below the current table.
2292 If optional argument LOCATION is a buffer position, insert it at
2293 LOCATION instead."
2301 ;; Don't overwrite TBLFM, we might use text properties to
2302 ;; store stuff.
2316 ;; Fake a high number to make sure this is sorted at the end.
2323 a)
2333 "Compare two formulas for sorting."
2338 ;;;###autoload
2340 "Return an alist with the stored formulas directly after current table.
2341 By default, only return active formulas, i.e., formulas located
2342 on the first line after the table. However, if optional argument
2343 LOCATION is a buffer position, consider the formulas there."
2352 eq-alist seen)
2356 string)
2361 ;; Is it a column reference?
2363 ;; Since named columns are not possible in
2364 ;; LHS, assume this is a named field.
2372 "Double definition `%s=' in TBLFM line, please fix by hand"
2373 lhs)
2378 "Double definition `%s=' in TBLFM line, please fix by hand"
2379 lhs)))))))))))
2382 "Modify the equations after the table structure has been edited.
2384 For all numbers larger than LIMIT, shift them by DELTA."
2396 s n a)
2402 "Change makes TBLFM term %s invalid, use undo to recover"
2417 ;;;###autoload
2420 If yes, store the formula and apply it."
2421 ;; We already know we are in a table. Get field will only return a formula
2422 ;; when appropriate. It might return a separator line, but no problem.
2425 named eq)
2433 "List of commands triggering the recalculation of a line.
2445 ;;;###autoload
2447 "Rotate the recalculation mark in the first column.
2448 If in any row, the first field is not consistent with a mark,
2449 insert a new column for the markers.
2450 When there is an active region, change all the lines in the region,
2451 after prompting for the marking character.
2452 After each change, a message will be displayed indicating the meaning
2453 of the new mark."
2469 newchar))
2477 newchar))
2495 ;; Rotate mark in first row.
2497 ;; Rotate marks in additional rows if a region is active.
2505 ;; Only align if rotation actually changed lines' length.
2515 ;;;###autoload
2517 "Analyze table at point and store results.
2519 This function sets up the following dynamically scoped variables:
2521 `org-table-column-name-regexp',
2522 `org-table-column-names',
2523 `org-table-current-begin-pos',
2524 `org-table-current-line-types',
2525 `org-table-current-ncol',
2526 `org-table-dlines',
2527 `org-table-hlines',
2528 `org-table-local-parameters',
2529 `org-table-named-field-locations'."
2534 ;; Extract column names.
2547 ;; Extract local parameters.
2555 org-table-local-parameters)))))
2556 ;; Update named fields locations. We minimize `count-lines'
2557 ;; processing by storing last known number of lines in LAST.
2579 field))
2582 org-table-named-field-locations))))))))))
2583 ;; Re-use existing markers when possible.
2587 ;; Analyze the line types.
2598 ;; Get the number of columns from the first data line in table.
2606 al al2)
2620 "Move point to a specific field in the current table.
2622 REF is either the name of a field its absolute reference, as
2623 a string. No column is created unless CREATE-COLUMN-P is
2624 non-nil. If it is a function, it is called with the column
2625 number as its argument as is used as a predicate to know if the
2626 column can be created.
2628 This function assumes the table is already analyzed (i.e., using
2629 `org-table-analyze')."
2644 create-column-p)))
2650 ;;;###autoload
2652 "Recompute the current line if marked for it, and if we haven't just done it."
2672 org-tbl-calc-modes)
2674 ;;;###autoload
2676 suppress-align suppress-const
2677 suppress-store suppress-analysis)
2678 "Replace the table field value at the cursor by the result of a calculation.
2680 In a table, this command replaces the value in the current field with the
2682 formula, by storing it in a special line below the table. When called
2684 field formula.
2687 insert the active equation for the field
2688 back into the current field, so that it can be edited there. This is \
2689 useful
2691 check the referenced fields.
2693 When called, the command first prompts for a formula, which is read in
2694 the minibuffer. Previously entered formulas are available through the
2695 history list, and the last used formula is offered as a default.
2696 These stored formulas are adapted correctly when moving, inserting, or
2697 deleting columns with the corresponding commands.
2699 The formula can be any algebraic expression understood by the Calc package.
2700 For details, see the Org mode manual.
2702 This function can also be called from Lisp programs and offers
2703 additional arguments: EQUATION can be the formula to apply. If this
2704 argument is given, the user will not be prompted.
2706 SUPPRESS-ALIGN is used to speed-up recursive calls by by-passing
2707 unnecessary aligns.
2709 SUPPRESS-CONST suppresses the interpretation of constants in the
2710 formula, assuming that this has been done already outside the
2711 function.
2713 SUPPRESS-STORE means the formula should not be stored, either
2714 because it is already stored, or because it is a modified
2715 equation that should not overwrite the stored one.
2717 SUPPRESS-ANALYSIS prevents analyzing the table and checking
2718 location of point."
2734 equation
2740 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2741 duration duration-output-format)
2742 ;; Parse the format string. Since we have a lot of modes, this is
2743 ;; a lot of work. However, I think calc still uses most of the time.
2756 'calc-float-format
2759 n))))
2764 duration-output-format
2793 ;; replace fields with duration values if relevant
2797 fields)))
2803 x))
2804 fields)))
2810 ;; Insert row and column number of formula result field
2821 t t form)))
2823 ;; Check for old vertical references
2825 ;; Insert remote references
2838 rmtrng))
2839 keep-empty numbers lispp))
2840 t t form)))
2841 ;; Insert complex ranges
2851 ;; possibly handle durations
2856 formrg)
2857 keep-empty numbers lispp)))
2862 ;; Insert simple ranges, i.e. included in the current row.
2865 form)
2876 keep-empty numbers lispp))
2877 t t form)))
2879 ;; Insert the references to fields in same row
2886 x keep-empty numbers lispp)))
2903 ;; Use <...> time-stamps so that Calc can handle them.
2906 ;; Internationalize local time-stamps by setting locale to
2907 ;; "C".
2910 org-ts-regexp
2918 form t t))
2921 form
2928 duration-output-format)
2929 ev)))
2934 Orig: %s
2935 $xyz-> %s
2936 @r$c-> %s
2959 ;; Replace any active time stamp in the result with
2960 ;; an inactive one. Dates in tables are likely
2961 ;; piece of regular data, not meant to appear in the
2962 ;; agenda.
2975 prop value)))
2978 "Get a calc vector from a column, according to descriptor DESC.
2980 Optional arguments TBEG and COL can give the beginning of the table and
2981 the current column, to avoid unnecessary parsing.
2983 HIGHLIGHT means just highlight the range.
2985 When CORNERS-ONLY is set, only return the corners of the range as
2986 a list (line1 column1 line2 column2) where line1 and line2 are
2987 line numbers relative to beginning of table, or TBEG, and column1
2988 and column2 are table column numbers."
2991 desc))
3002 thisline)))
3007 thisline)))
3019 ;; Just one field.
3026 ;; A range, return a vector. First sort the numbers to get
3027 ;; a regular rectangle.
3033 ;; Copy the range values into a list.
3048 ;; Return string representation of calc vector.
3054 "Return relative line number corresponding to descriptor DESC.
3055 The cursor is currently in relative line number CLINE."
3060 ;; 1 2 3 4 5 6
3061 desc))
3083 cline)))
3086 "Return relative line of Nth row with type TYPE.
3087 Search starts from relative line I. When BACKWARDS in non-nil,
3088 look before I. When RELATIVE is non-nil, the reference is
3089 relative. DESC is the original descriptor that started the
3090 search, as a string."
3098 ;; We are going to cross a hline. Check if this is
3099 ;; an authorized move.
3110 ;; The last hline doesn't exist. Instead, point to last row
3111 ;; in table.
3120 "Convert list ELEMENTS to something appropriate to insert into formula.
3121 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
3122 NUMBERS indicates that everything should be converted to numbers.
3123 LISPP non-nil means to return something appropriate for a Lisp
3124 list, `literal' is for the format specifier L."
3125 ;; Calc nan (not a number) is used for the conversion of the empty
3126 ;; field to a reference for several reasons: (i) It is accepted in a
3127 ;; Calc formula (e. g. "" or "()" would result in a Calc error).
3128 ;; (ii) In a single field (not in range) it can be distinguished
3129 ;; from "(nan)" which is the reference made from a single field
3130 ;; containing "nan".
3132 ;; field reference
3135 elements
3137 ""
3146 ;; range reference
3151 elements))))
3157 x
3165 x)
3167 elements
3171 "If there has been more than one second since T1, display message.
3172 ARGS are passed as arguments to the `message' function. Returns
3173 current time if a message is printed, otherwise returns T1. If
3174 T1 is nil, always messages."
3178 curtime)
3179 t1)))
3181 ;;;###autoload
3183 "Recalculate the current table line by applying all stored formulas.
3185 With prefix arg ALL, do this for all lines in the table.
3188 if ALL is the symbol `iterate',
3189 recompute the table until it no longer changes.
3191 If NOALIGN is not nil, do not re-align the table after the computations
3192 are done. This is typically used internally to save time, if it is
3193 known that the table will be realigned a little later anyway."
3208 beg end eqlcol eqlfield)
3209 ;; Insert constants in all formulas.
3212 ;; Expand equations, then split the equation list between
3213 ;; column formulas and field formulas.
3225 old-lhs)))
3228 existing formula for column %s"
3229 old-lhs
3230 new))
3231 new))
3237 ;; Expand ranges in lhs of formulas
3239 ;; Get the correct line range to process.
3246 ;; This is a table with marked lines, compute selected
3247 ;; lines.
3249 ;; Move forward to the first non-header line.
3254 ;; Just leave BEG at the start of the table.
3259 ;; Mark named fields untouchable. Also check if several
3260 ;; field/range formulas try to set the same field.
3264 seen-fields)
3275 ;; Turn field coordinates associated to NAME
3276 ;; into an absolute reference.
3280 name)))
3283 reference))
3288 ;; Evaluate the column formulas, but skip fields covered by
3289 ;; field formulas.
3293 ;; Unprotected line, recalculate.
3298 log-last-time
3311 ;; Evaluate the field formulas.
3320 reference
3321 ;; Possibly create a new column, as long as
3322 ;; `org-table-formula-create-columns' allows it.
3334 t))
3339 ;; Clean up markers and internal text property.
3350 ;;;###autoload
3352 "Recalculate the table until it does not change anymore.
3353 The maximum number of iterations is 10, but you can choose a different value
3354 with the prefix ARG."
3359 thistbl)
3373 ;;;###autoload
3375 "Recalculate all tables in the current buffer."
3380 ;; Reason for separate `org-table-align': When repeating
3381 ;; (org-table-recalculate t) `org-table-may-need-update' gets in
3382 ;; the way.
3385 t)))
3387 ;;;###autoload
3389 "Iterate all tables in the buffer, to converge inter-table dependencies."
3394 c1)
3410 "Apply the #+TBLFM in the line at point to the table."
3417 ;; Insert a temporary formula at right after the table
3422 ;; Recalculate the table.
3427 ;; Delete the formula inserted temporarily.
3433 "Find the beginning of the TBLFM lines and return its position.
3434 Return nil when the beginning of TBLFM line was not found."
3441 "Expand list of formulas.
3442 If some of the RHS in the formulas are ranges or a row reference,
3443 expand them to individual field equations for each field. This
3444 function assumes the table is already analyzed (i.e., using
3445 `org-table-analyze')."
3452 ;; This just refers to one fixed field.
3455 ;; This just refers to one fixed named field.
3458 ;; Column formulas are treated specially and are not
3459 ;; expanded.
3464 rhs)
3465 res)))
3477 rhs)
3478 res))))))))))
3481 "Replace @<, @>, $<, $> with first/last row/column of the table.
3482 So @< and $< will always be replaced with @1 and $1, respectively.
3483 The advantage of these special markers are that structure editing of
3484 the table will not change them, while @1 and $1 will be modified
3485 when a line/row is swapped out of that privileged position. So for
3486 formulas that use a range of rows or columns, it may often be better
3488 borders of the table using the @< @> $< $> makers."
3491 s start)
3496 org-table-current-ncol)
3500 len
3507 s)
3510 "Replace $const with values in string F."
3515 org-table-column-name-regexp
3518 org-table-column-names))))
3519 f t t)))
3520 ;; Parameters and constants.
3524 new start))
3527 ;; When a duration is expected, convert value on the fly.
3533 v)))))
3540 "Find the value for a parameter or constant in a formula.
3541 Parameters get priority."
3572 map))
3579 "--"
3582 "--"
3583 "Shift Reference at Point"
3588 "-"
3589 "Change Test Row for Column Formulas"
3592 "--"
3597 org-table-overlay-coordinates)]
3598 "--"
3606 ;;;###autoload
3608 "Edit the formulas of the current table in a separate buffer."
3614 ;; Move point within the table before analyzing it.
3630 ;; Keep global-font-lock-mode from turning on font-lock-mode
3675 "Convert a formula from internal to user representation."
3678 s))
3681 "Convert a formula from user to internal representation."
3684 s))
3687 "Convert spreadsheet references from A7 to @7$28.
3688 Works for single references, but also for entire formulas and even the
3689 full TBLFM line."
3691 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3694 ;; format match, just advance
3699 ;; 3.e5 or something like this.
3702 ;; (member (match-string 1 s)
3703 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3704 )
3705 ;; function name, just advance
3715 t t s)))))
3716 s))
3719 "Convert spreadsheet references from to @7$28 to AB7.
3720 Works for single references, but also for entire formulas and even the
3721 full TBLFM line."
3728 t t s)))
3733 t nil s)))
3734 s)
3737 "Convert a base 26 number represented by letters into an integer.
3738 For example: AB -> 28."
3744 n))
3747 "Convert an integer into a base 26 number represented by letters.
3748 For example: 28 -> AB."
3753 s))
3756 "Convert a time string into numerical duration in seconds.
3757 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3758 If S is a string representing a number, keep this number."
3760 s
3783 "Convert a number of seconds to a time string.
3784 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3785 minutes or seconds."
3797 ;; Ignore seconds
3801 secs0)
3806 secs0)))))
3810 \f
3811 ;;; Columns shrinking
3814 "Non-nil if current field is narrowed.
3815 When non-nil, return the overlay narrowing the field."
3818 o))
3822 "List currently shrunk columns in table at point."
3824 ;; We really check shrunk columns in current row only. It could
3825 ;; be wrong if all rows do not contain the same number of columns
3826 ;; (i.e. the table is not properly aligned). As a consequence,
3827 ;; some columns may not be shrunk again upon aligning the table.
3828 ;;
3829 ;; For example, in the following table, cursor is on first row and
3830 ;; "<>" indicates a shrunk column.
3831 ;;
3832 ;; | |
3833 ;; | | <> |
3834 ;;
3835 ;; Aligning table from the first row will not shrink again the
3836 ;; second row, which was not visible initially.
3837 ;;
3838 ;; However, fixing it requires to check every row, which may be
3839 ;; slow on large tables. Moreover, the hindrance of this
3840 ;; pathological case is very limited.
3853 "Shrink a table field to a specified width.
3855 WIDTH is an integer representing the number of characters to
3856 display, in addition to `org-table-shrunk-column-indicator'. START
3857 and END are, respectively, the beginning and ending positions of
3858 the field. CONTENTS is its trimmed contents, as a string, or
3859 `hline' for table rules.
3861 Real field is hidden under an overlay. The latter has the
3862 following properties:
3864 `org-overlay-type'
3866 Set to `table-column-hide'. Used to identify overlays
3867 responsible for the task.
3869 `org-table-column-overlays'
3871 It is a list with the pattern (siblings . COLUMN-OVERLAYS)
3872 where COLUMN-OVERLAYS is the list of all overlays hiding the
3873 same column.
3875 Whenever the text behind or next to the overlay is modified, all
3876 the overlays in the column are deleted, effectively displaying
3877 the column again.
3879 Return overlay used to hide the field."
3886 org-table-shrunk-column-indicator))
3888 ;; Remove invisible parts from links in CONTENTS. Since
3889 ;; shrinking could happen before first fontification
3890 ;; (e.g., using a #+STARTUP keyword), this cannot be done
3891 ;; using text properties.
3895 ;; Expand field.
3897 contents
3899 org-table-shrunk-column-indicator)
3900 ;; Truncate field.
3903 org-table-shrunk-column-indicator))))))
3906 ;; Removing one overlay removes all other overlays
3907 ;; in the same column.
3916 ;; Make sure overlays stays on top of table coordinates
3917 ;; overlays. See `org-table-overlay-coordinates'.
3920 o)))
3923 "Read column selection select as a list of numbers.
3925 SELECT is a string containing column ranges, separated by white
3926 space characters, see `org-table-hide-column' for details. MAX
3927 is the maximum column number.
3929 Return value is a sorted list of numbers. Ignore any number
3930 outside of the [1;MAX] range."
3947 max))))
3950 #'<)))
3953 "Shrink COLUMNS in an Org table.
3954 COLUMNS is a sorted list of column numbers. BEG and END are,
3955 respectively, the beginning position and the end position of the
3956 table."
3967 ;; Move to COLUMN.
3972 ;; Extract boundaries and contents from current field.
3973 ;; Also set the column's width if we encounter a width
3974 ;; cookie for the first time.
3988 ;; Link overlay to the other overlays in the same column.
3996 "Expand all columns in an Org table.
3997 BEG and END are, respectively, the beginning position and the end
3998 position of the table."
4001 ;;;###autoload
4003 "Shrink or expand current column in an Org table.
4005 If a width cookie specifies a width W for the column, the first
4006 W visible characters are displayed. Otherwise, the column is
4007 shrunk to a single character.
4009 When optional argument ARG is a string, use it as white space
4010 separated list of column ranges. A column range can be one of
4011 the following patterns:
4013 N column N only
4014 N-M every column between N and M (both inclusive)
4015 N- every column between N (inclusive) and the last column
4016 -M every column between the first one and M (inclusive)
4017 - every column
4020 range specification.
4023 prefix, expand all columns."
4030 ;; Point is either before first column or past last one.
4035 ;; Compute an upper bound for the number of columns.
4036 ;; Nonexistent columns are ignored anyway.
4040 (`nil
4041 ;; Find current column, even when on a hline.
4054 max-columns))
4060 ;; Move before overlay if point is under it.
4064 ;;;###autoload
4066 "Shrink all columns with a width cookie in the table at point.
4067 Columns without a width cookie are expanded."
4080 ;; Make sure invisible characters in the table are at the right
4081 ;; place since column widths take them into account.
4086 \f
4087 ;;; Formula editing
4090 "Convert all references in this buffer, using FUNCTION."
4101 "Convert all references in the buffer from B3 to @3$2 and back."
4111 "Shift the reference at point one row/hline up."
4115 "Shift the reference at point one row/hline down."
4119 "Shift the reference at point one field to the left."
4123 "Shift the reference at point one field to the right."
4134 ;; A B3-like reference
4140 ;; An internal reference
4146 "Re-match the group N, and replace it with the shifted reference."
4151 t t)))
4154 "Shift a reference part REF.
4155 If DECR is set, decrease the references row/column, else increase.
4156 If HLINE is set, this may be a hline reference, it certainly is not
4157 a translation reference."
4186 "Toggle the display of coordinates in the referenced table."
4195 "Parse the buffer for formula definitions and install them.
4196 With prefix ARG, apply the new formulas to the table."
4205 eql)
4208 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
4209 nil t)
4230 "Abort editing formulas, without installing the changes."
4241 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
4282 "Show the location/value of the $ expression at point.
4283 When LOCAL is non-nil, show references for the table at point."
4293 var name e what match dest)
4297 "$1.."
4349 dest)
4375 ;; Column number.
4401 org-table-fedit-scroll-down))))
4413 "Make sure the cursor is in a dataline in a table."
4422 p1 p2)))
4427 "Move cursor one line up in the window showing the table."
4432 "Move cursor one line down in the window showing the table."
4437 "Move the cursor in the window showing the table.
4438 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
4463 "Add a new overlay."
4469 "Highlight rectangular region in a table.
4470 When buffer positions BEG and END are provided, use them to
4471 delimit the region to highlight. Otherwise, refer to point. Use
4472 FACE, when non-nil, for the highlight."
4504 "Remove the rectangle overlays."
4514 "Add overlays to the table at point, to show row/column coordinates."
4542 ;;;###autoload
4544 "Toggle the display of Row/Column numbers in tables."
4555 ;;;###autoload
4557 "Toggle the formula debugger in tables."
4563 ;;; The orgtbl minor mode
4565 ;; Define a minor mode which can be used in other modes in order to
4566 ;; integrate the Org table editor.
4568 ;; This is really a hack, because the Org table editor uses several
4569 ;; keys which normally belong to the major mode, for example the TAB
4570 ;; and RET keys. Here is how it works: The minor mode defines all the
4571 ;; keys necessary to operate the table editor, but wraps the commands
4572 ;; into a function which tests if the cursor is currently inside
4573 ;; a table. If that is the case, the table editor command is
4574 ;; executed. However, when any of those keys is used outside a table,
4575 ;; the function uses `key-binding' to look up if the key has an
4576 ;; associated command in another currently active keymap (minor modes,
4577 ;; major mode, global), and executes that command. There might be
4578 ;; problems if any of the keys used by the table editor is otherwise
4579 ;; used as a prefix key.
4581 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
4582 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
4583 ;; addresses this by checking explicitly for both bindings.
4585 ;; The optimized version (see variable `orgtbl-optimized') takes over
4586 ;; all keys which are bound to `self-insert-command' in the *global map*.
4587 ;; Some modes bind other commands to simple characters, for example
4588 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
4589 ;; active, this binding is ignored inside tables and replaced with a
4590 ;; modified self-insert.
4608 ;; Install it as a minor mode.
4612 ;;;###autoload
4614 "The `org-mode' table editor as a minor mode for use in other modes."
4619 ;; Exit without error, in case some hook functions calls this
4620 ;; by accident in org-mode.
4624 ;; Make sure we are first in minor-mode-map-alist
4626 ;; FIXME: maybe it should use emulation-mode-map-alists?
4633 auto-fill-inhibit-regexp)
4637 auto-fill-inhibit-regexp)
4638 orgtbl-line-start-regexp))
4653 "Create a function for binding in the table minor mode.
4654 FUN is the command to call inside a table. N is used to create a unique
4655 command name. KEYS are keys that should be checked in for a command
4656 to execute outside of tables."
4662 "Outside of tables, run the binding of `"
4674 keys)
4678 "Error when there is no default binding for a table key."
4683 "Setup orgtbl keymaps."
4714 elt key fun cmd)
4722 ;; Special treatment needed for TAB, RET and DEL
4735 (orgtbl-make-binding 'org-delete-backward-char 109
4741 [(tab)] "\C-i"))
4743 (org-defkey orgtbl-mode-map [backtab]
4745 [backtab] [S-iso-lefttab] [(shift tab)]
4746 [(tab)] "\C-i"))
4748 (org-defkey orgtbl-mode-map "\M-\C-m"
4749 (orgtbl-make-binding 'org-table-wrap-region 105
4750 "\M-\C-m" [(meta return)]))
4751 (org-defkey orgtbl-mode-map [(meta return)]
4752 (orgtbl-make-binding 'org-table-wrap-region 106
4753 [(meta return)] "\M-\C-m"))
4755 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4756 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4758 (when orgtbl-optimized
4759 ;; If the user wants maximum table support, we need to hijack
4760 ;; some standard editing functions
4761 (org-remap orgtbl-mode-map
4762 'self-insert-command 'orgtbl-self-insert-command
4763 'delete-char 'org-delete-char
4764 'delete-backward-char 'org-delete-backward-char)
4765 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4766 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4767 '("OrgTbl"
4768 ["Create or convert" org-table-create-or-convert-from-region
4769 :active (not (org-at-table-p)) :keys "C-c |" ]
4770 "--"
4771 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4772 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4773 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4774 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4775 "--"
4776 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4777 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4778 ["Copy Field from Above"
4779 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4780 "--"
4781 ("Column"
4782 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4783 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4784 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4785 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4786 ("Row"
4787 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4788 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4789 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4790 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4791 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4792 "--"
4793 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4794 ("Rectangle"
4795 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4796 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4797 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4798 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4799 "--"
4800 ("Radio tables"
4801 ["Insert table template" orgtbl-insert-radio-table
4802 (cl-assoc-if #'derived-mode-p orgtbl-radio-table-templates)]
4803 ["Comment/uncomment table" orgtbl-toggle-comment t])
4804 "--"
4805 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4806 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4807 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4808 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4809 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4810 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4811 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4812 ["Sum Column/Rectangle" org-table-sum
4813 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4814 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4815 ["Debug Formulas"
4816 org-table-toggle-formula-debugger :active (org-at-table-p)
4817 :keys "C-c {"
4818 :style toggle :selected org-table-formula-debug]
4819 ["Show Col/Row Numbers"
4820 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4821 :keys "C-c }"
4822 :style toggle :selected org-table-overlay-coordinates]
4823 "--"
4824 ("Plot"
4827 t))
4829 (defun orgtbl-ctrl-c-ctrl-c (arg)
4830 "If the cursor is inside a table, realign the table.
4831 If it is a table to be sent away to a receiver, do it.
4832 With prefix arg, also recompute table."
4833 (interactive "P")
4834 (let ((case-fold-search t) (pos (point)) action)
4835 (save-excursion
4836 (beginning-of-line 1)
4837 (setq action (cond
4841 (cond
4842 ((integerp action)
4843 (goto-char action)
4844 (org-table-maybe-eval-formula)
4845 (if arg
4846 (call-interactively 'org-table-recalculate)
4847 (org-table-maybe-recalculate-line))
4848 (call-interactively 'org-table-align)
4849 (when (orgtbl-send-table 'maybe)
4850 (run-hooks 'orgtbl-after-send-table-hook)))
4851 ((eq action 'recalc)
4852 (save-excursion
4853 (beginning-of-line 1)
4855 (if (org-at-table-p)
4856 (org-call-with-arg 'org-table-recalculate t))))
4857 (t (let (orgtbl-mode)
4858 (call-interactively (key-binding "\C-c\C-c")))))))
4860 (defun orgtbl-create-or-convert-from-region (_arg)
4861 "Create table or convert region to table, if no conflicting binding.
4862 This installs the table binding `C-c |', but only if there is no
4863 conflicting binding to this key outside orgtbl-mode."
4864 (interactive "P")
4865 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4866 (if cmd
4867 (call-interactively cmd)
4868 (call-interactively 'org-table-create-or-convert-from-region))))
4870 (defun orgtbl-tab (arg)
4871 "Justification and field motion for `orgtbl-mode'."
4872 (interactive "P")
4873 (if arg (org-table-edit-field t)
4874 (org-table-justify-field-maybe)
4875 (org-table-next-field)))
4877 (defun orgtbl-ret ()
4878 "Justification and field motion for `orgtbl-mode'."
4879 (interactive)
4880 (if (bobp)
4881 (newline)
4882 (org-table-justify-field-maybe)
4883 (org-table-next-row)))
4885 (defun orgtbl-self-insert-command (N)
4886 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4887 If the cursor is in a table looking at whitespace, the whitespace is
4888 overwritten, and the table is not marked as requiring realignment."
4889 (interactive "p")
4890 (if (and (org-at-table-p)
4891 (or
4892 (and org-table-auto-blank-field
4893 (member last-command
4894 '(orgtbl-hijacker-command-100
4895 orgtbl-hijacker-command-101
4896 orgtbl-hijacker-command-102
4897 orgtbl-hijacker-command-103
4898 orgtbl-hijacker-command-104
4899 orgtbl-hijacker-command-105
4900 yas/expand))
4901 (org-table-blank-field))
4902 t)
4903 (eq N 1)
4905 (let (org-table-may-need-update)
4906 (delete-region (match-beginning 1) (match-end 1))
4907 (self-insert-command N))
4908 (setq org-table-may-need-update t)
4909 (let* (orgtbl-mode
4910 a
4911 (cmd (or (key-binding
4912 (or (and (listp function-key-map)
4913 (setq a (assoc last-input-event function-key-map))
4914 (cdr a))
4915 (vector last-input-event)))
4916 'self-insert-command)))
4917 (call-interactively cmd)
4918 (if (and org-self-insert-cluster-for-undo
4919 (eq cmd 'self-insert-command))
4920 (if (not (eq last-command 'orgtbl-self-insert-command))
4921 (setq org-self-insert-command-undo-counter 1)
4922 (if (>= org-self-insert-command-undo-counter 20)
4923 (setq org-self-insert-command-undo-counter 1)
4924 (and (> org-self-insert-command-undo-counter 0)
4925 buffer-undo-list
4926 (not (cadr buffer-undo-list)) ; remove nil entry
4927 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4928 (setq org-self-insert-command-undo-counter
4929 (1+ org-self-insert-command-undo-counter))))))))
4931 ;;;###autoload
4933 "Regular expression matching exponentials as produced by calc.")
4935 (defun orgtbl-gather-send-defs ()
4936 "Gather a plist of :name, :transform, :params for each destination before
4937 a radio table."
4938 (save-excursion
4939 (goto-char (org-table-begin))
4940 (let (rtn)
4941 (beginning-of-line 0)
4942 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4943 (let ((name (org-no-properties (match-string 1)))
4944 (transform (intern (match-string 2)))
4945 (params (if (match-end 3)
4946 (read (concat "(" (match-string 3) ")")))))
4947 (push (list :name name :transform transform :params params)
4948 rtn)
4949 (beginning-of-line 0)))
4950 rtn)))
4952 (defun orgtbl-send-replace-tbl (name text)
4953 "Find and replace table NAME with TEXT."
4954 (save-excursion
4955 (goto-char (point-min))
4956 (let* ((location-flag nil)
4957 (name (regexp-quote name))
4960 (while (re-search-forward begin-re nil t)
4961 (unless location-flag (setq location-flag t))
4962 (let ((beg (line-beginning-position 2)))
4963 (unless (re-search-forward end-re nil t)
4964 (user-error "Cannot find end of receiver location at %d" beg))
4965 (beginning-of-line)
4966 (delete-region beg (point))
4968 (unless location-flag
4969 (user-error "No valid receiver location found in the buffer")))))
4971 ;;;###autoload
4972 (defun org-table-to-lisp (&optional txt)
4973 "Convert the table at point to a Lisp structure.
4974 The structure will be a list. Each item is either the symbol `hline'
4975 for a horizontal separator line, or a list of field values as strings.
4976 The table is taken from the parameter TXT, or from the buffer at point."
4977 (unless (or txt (org-at-table-p)) (user-error "No table at point"))
4978 (let ((txt (or txt
4979 (buffer-substring-no-properties (org-table-begin)
4980 (org-table-end)))))
4981 (mapcar (lambda (x)
4982 (if (string-match org-table-hline-regexp x) 'hline
4986 (defun orgtbl-send-table (&optional maybe)
4987 "Send a transformed version of table at point to the receiver position.
4988 With argument MAYBE, fail quietly if no transformation is defined
4989 for this table."
4990 (interactive)
4991 (catch 'exit
4992 (unless (org-at-table-p) (user-error "Not at a table"))
4993 ;; when non-interactive, we assume align has just happened.
4994 (when (called-interactively-p 'any) (org-table-align))
4995 (let ((dests (orgtbl-gather-send-defs))
4996 (table (org-table-to-lisp
4997 (buffer-substring-no-properties (org-table-begin)
4998 (org-table-end))))
4999 (ntbl 0))
5000 (unless dests
5001 (if maybe (throw 'exit nil)
5002 (user-error "Don't know how to transform this table")))
5003 (dolist (dest dests)
5004 (let ((name (plist-get dest :name))
5005 (transform (plist-get dest :transform))
5006 (params (plist-get dest :params)))
5007 (unless (fboundp transform)
5008 (user-error "No such transformation function %s" transform))
5009 (orgtbl-send-replace-tbl name (funcall transform table params)))
5010 (cl-incf ntbl))
5011 (message "Table converted and installed at %d receiver location%s"
5012 ntbl (if (> ntbl 1) "s" ""))
5013 (and (> ntbl 0) ntbl))))
5015 (defun org-remove-by-index (list indices &optional i0)
5016 "Remove the elements in LIST with indices in INDICES.
5017 First element has index 0, or I0 if given."
5018 (if (not indices)
5019 list
5020 (if (integerp indices) (setq indices (list indices)))
5021 (setq i0 (1- (or i0 0)))
5022 (delq :rm (mapcar (lambda (x)
5023 (setq i0 (1+ i0))
5024 (if (memq i0 indices) :rm x))
5025 list))))
5027 (defun orgtbl-toggle-comment ()
5028 "Comment or uncomment the orgtbl at point."
5029 (interactive)
5030 (let* ((case-fold-search t)
5031 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
5032 (re2 (concat "^" orgtbl-line-start-regexp))
5033 (commented (save-excursion (beginning-of-line 1)
5034 (cond ((looking-at re1) t)
5035 ((looking-at re2) nil)
5036 (t (user-error "Not at an org table")))))
5037 (re (if commented re1 re2))
5038 beg end)
5039 (save-excursion
5040 (beginning-of-line 1)
5041 (while (looking-at re) (beginning-of-line 0))
5042 (beginning-of-line 2)
5043 (setq beg (point))
5044 (while (looking-at re) (beginning-of-line 2))
5045 (setq end (point)))
5046 (comment-region beg end (if commented '(4) nil))))
5048 (defun orgtbl-insert-radio-table ()
5049 "Insert a radio table template appropriate for this major mode."
5050 (interactive)
5051 (let* ((e (cl-assoc-if #'derived-mode-p orgtbl-radio-table-templates))
5052 (txt (nth 1 e))
5053 name pos)
5054 (unless e (user-error "No radio table setup defined for %s" major-mode))
5055 (setq name (read-string "Table name: "))
5056 (while (string-match "%n" txt)
5057 (setq txt (replace-match name t t txt)))
5059 (setq pos (point))
5060 (insert txt)
5061 (goto-char pos)))
5063 ;;;###autoload
5064 (defun orgtbl-to-generic (table params)
5065 "Convert the orgtbl-mode TABLE to some other format.
5067 This generic routine can be used for many standard cases.
5069 TABLE is a list, each entry either the symbol `hline' for
5070 a horizontal separator line, or a list of fields for that
5071 line. PARAMS is a property list of parameters that can
5072 influence the conversion.
5074 Valid parameters are:
5076 :backend, :raw
5078 Export back-end used as a basis to transcode elements of the
5079 table, when no specific parameter applies to it. It is also
5080 used to translate cells contents. You can prevent this by
5081 setting :raw property to a non-nil value.
5083 :splice
5085 When non-nil, only convert rows, not the table itself. This is
5086 equivalent to setting to the empty string both :tstart
5087 and :tend, which see.
5089 :skip
5091 When set to an integer N, skip the first N lines of the table.
5092 Horizontal separation lines do count for this parameter!
5094 :skipcols
5096 List of columns that should be skipped. If the table has
5097 a column with calculation marks, that column is automatically
5098 discarded beforehand.
5100 :hline
5102 String to be inserted on horizontal separation lines. May be
5103 nil to ignore these lines altogether.
5105 :sep
5107 Separator between two fields, as a string.
5109 Each in the following group may be either a string or a function
5110 of no arguments returning a string:
5112 :tstart, :tend
5114 Strings to start and end the table. Ignored when :splice is t.
5116 :lstart, :lend
5118 Strings to start and end a new table line.
5120 :llstart, :llend
5122 Strings to start and end the last table line. Default,
5123 respectively, to :lstart and :lend.
5125 Each in the following group may be a string or a function of one
5126 argument (either the cells in the current row, as a list of
5127 strings, or the current cell) returning a string:
5129 :lfmt
5131 Format string for an entire row, with enough %s to capture all
5132 fields. When non-nil, :lstart, :lend, and :sep are ignored.
5134 :llfmt
5136 Format for the entire last line, defaults to :lfmt.
5138 :fmt
5140 A format to be used to wrap the field, should contain %s for
5141 the original field value. For example, to wrap everything in
5143 a property list with column numbers and format strings, or
5144 functions, e.g.,
5148 :hlstart :hllstart :hlend :hllend :hsep :hlfmt :hllfmt :hfmt
5150 Same as above, specific for the header lines in the table.
5151 All lines before the first hline are treated as header. If
5152 any of these is not present, the data line value is used.
5154 This may be either a string or a function of two arguments:
5156 :efmt
5158 Use this format to print numbers with exponential. The format
5159 should have %s twice for inserting mantissa and exponent, for
5161 list with column numbers and format strings or functions.
5162 :fmt will still be applied after :efmt."
5163 ;; Make sure `org-export-create-backend' is available.
5164 (require 'ox)
5165 (let* ((backend (plist-get params :backend))
5166 (custom-backend
5167 ;; Build a custom back-end according to PARAMS. Before
5168 ;; defining a translator, check if there is anything to do.
5169 ;; When there isn't, let BACKEND handle the element.
5170 (org-export-create-backend
5171 :parent (or backend 'org)
5172 :transcoders
5173 `((table . ,(org-table--to-generic-table params))
5174 (table-row . ,(org-table--to-generic-row params))
5175 (table-cell . ,(org-table--to-generic-cell params))
5176 ;; Macros are not going to be expanded. However, no
5177 ;; regular back-end has a transcoder for them. We
5178 ;; provide one so they are not ignored, but displayed
5179 ;; as-is instead.
5180 (macro . (lambda (m c i) (org-element-macro-interpreter m nil))))))
5181 data info)
5182 ;; Store TABLE as Org syntax in DATA. Tolerate non-string cells.
5183 ;; Initialize communication channel in INFO.
5184 (with-temp-buffer
5185 (let ((org-inhibit-startup t)) (org-mode))
5186 (let ((standard-output (current-buffer))
5187 (org-element-use-cache nil))
5188 (dolist (e table)
5190 ((consp e)
5191 (princ "| ") (dolist (c e) (princ c) (princ " |"))
5193 ;; Add back-end specific filters, but not user-defined ones. In
5194 ;; particular, make sure to call parse-tree filters on the
5195 ;; table.
5196 (setq info
5197 (let ((org-export-filters-alist nil))
5198 (org-export-install-filters
5199 (org-combine-plists
5200 (org-export-get-environment backend nil params)
5201 `(:back-end ,(org-export-get-backend backend))))))
5202 (setq data
5203 (org-export-filter-apply-functions
5204 (plist-get info :filter-parse-tree)
5205 (org-element-map (org-element-parse-buffer) 'table
5206 #'identity nil t)
5207 info)))
5208 (when (and backend (symbolp backend) (not (org-export-get-backend backend)))
5209 (user-error "Unknown :backend value"))
5210 (when (or (not backend) (plist-get info :raw)) (require 'ox-org))
5211 ;; Handle :skip parameter.
5212 (let ((skip (plist-get info :skip)))
5213 (when skip
5214 (unless (wholenump skip) (user-error "Wrong :skip value"))
5215 (let ((n 0))
5216 (org-element-map data 'table-row
5217 (lambda (row)
5218 (if (>= n skip) t
5219 (org-element-extract-element row)
5220 (cl-incf n)
5221 nil))
5222 nil t))))
5223 ;; Handle :skipcols parameter.
5224 (let ((skipcols (plist-get info :skipcols)))
5225 (when skipcols
5226 (unless (consp skipcols) (user-error "Wrong :skipcols value"))
5227 (org-element-map data 'table
5228 (lambda (table)
5229 (let ((specialp (org-export-table-has-special-column-p table)))
5230 (dolist (row (org-element-contents table))
5231 (when (eq (org-element-property :type row) 'standard)
5232 (let ((c 1))
5233 (dolist (cell (nthcdr (if specialp 1 0)
5234 (org-element-contents row)))
5235 (when (memq c skipcols)
5236 (org-element-extract-element cell))
5237 (cl-incf c))))))))))
5238 ;; Since we are going to export using a low-level mechanism,
5239 ;; ignore special column and special rows manually.
5240 (let ((special? (org-export-table-has-special-column-p data))
5241 ignore)
5242 (org-element-map data (if special? '(table-cell table-row) 'table-row)
5243 (lambda (datum)
5244 (when (if (eq (org-element-type datum) 'table-row)
5245 (org-export-table-row-is-special-p datum nil)
5246 (org-export-first-sibling-p datum nil))
5247 (push datum ignore))))
5248 (setq info (plist-put info :ignore-list ignore)))
5249 ;; We use a low-level mechanism to export DATA so as to skip all
5250 ;; usual pre-processing and post-processing, i.e., hooks, Babel
5251 ;; code evaluation, include keywords and macro expansion. Only
5252 ;; back-end specific filters are retained.
5253 (let ((output (org-export-data-with-backend data custom-backend info)))
5254 ;; Remove final newline.
5255 (if (org-string-nw-p output) (substring-no-properties output 0 -1) ""))))
5257 (defun org-table--generic-apply (value name &optional with-cons &rest args)
5258 (cond ((null value) nil)
5259 ((functionp value) `(funcall ',value ,@args))
5260 ((stringp value)
5261 (cond ((consp (car args)) `(apply #'format ,value ,@args))
5262 (args `(format ,value ,@args))
5263 (t value)))
5264 ((and with-cons (consp value))
5265 `(let ((val (cadr (memq column ',value))))
5266 (cond ((null val) contents)
5267 ((stringp val) (format val ,@args))
5268 ((functionp val) (funcall val ,@args))
5269 (t (user-error "Wrong %s value" ,name)))))
5270 (t (user-error "Wrong %s value" name))))
5272 (defun org-table--to-generic-table (params)
5273 "Return custom table transcoder according to PARAMS.
5274 PARAMS is a plist. See `orgtbl-to-generic' for more
5275 information."
5276 (let ((backend (plist-get params :backend))
5277 (splice (plist-get params :splice))
5278 (tstart (plist-get params :tstart))
5279 (tend (plist-get params :tend)))
5280 `(lambda (table contents info)
5281 (concat
5282 ,(and tstart (not splice)
5284 ,(if (or (not backend) tstart tend splice) 'contents
5285 `(org-export-with-backend ',backend table contents info))
5286 ,(org-table--generic-apply (and (not splice) tend) ":tend")))))
5288 (defun org-table--to-generic-row (params)
5289 "Return custom table row transcoder according to PARAMS.
5290 PARAMS is a plist. See `orgtbl-to-generic' for more
5291 information."
5292 (let* ((backend (plist-get params :backend))
5293 (lstart (plist-get params :lstart))
5294 (llstart (plist-get params :llstart))
5295 (hlstart (plist-get params :hlstart))
5296 (hllstart (plist-get params :hllstart))
5297 (lend (plist-get params :lend))
5298 (llend (plist-get params :llend))
5299 (hlend (plist-get params :hlend))
5300 (hllend (plist-get params :hllend))
5301 (lfmt (plist-get params :lfmt))
5302 (llfmt (plist-get params :llfmt))
5303 (hlfmt (plist-get params :hlfmt))
5304 (hllfmt (plist-get params :hllfmt)))
5305 `(lambda (row contents info)
5306 (if (eq (org-element-property :type row) 'rule)
5307 ,(cond
5308 ((plist-member params :hline)
5309 (org-table--generic-apply (plist-get params :hline) ":hline"))
5310 (backend `(org-export-with-backend ',backend row nil info)))
5311 (let ((headerp ,(and (or hlfmt hlstart hlend)
5312 '(org-export-table-row-in-header-p row info)))
5313 (last-header-p
5314 ,(and (or hllfmt hllstart hllend)
5315 '(org-export-table-row-ends-header-p row info)))
5316 (lastp (not (org-export-get-next-element row info))))
5317 (when contents
5318 ;; Check if we can apply `:lfmt', `:llfmt', `:hlfmt', or
5319 ;; `:hllfmt' to CONTENTS. Otherwise, fallback on
5320 ;; `:lstart', `:lend' and their relatives.
5321 ,(let ((cells
5322 '(org-element-map row 'table-cell
5323 (lambda (cell)
5324 ;; Export all cells, without separators.
5325 ;;
5326 ;; Use `org-export-data-with-backend'
5327 ;; instead of `org-export-data' to eschew
5328 ;; cached values, which
5329 ;; ignore :orgtbl-ignore-sep parameter.
5330 (org-export-data-with-backend
5331 cell
5332 (plist-get info :back-end)
5333 (org-combine-plists info '(:orgtbl-ignore-sep t))))
5334 info)))
5335 `(cond
5336 ,(and hllfmt
5337 `(last-header-p ,(org-table--generic-apply
5338 hllfmt ":hllfmt" nil cells)))
5339 ,(and hlfmt
5340 `(headerp ,(org-table--generic-apply
5341 hlfmt ":hlfmt" nil cells)))
5342 ,(and llfmt
5343 `(lastp ,(org-table--generic-apply
5344 llfmt ":llfmt" nil cells)))
5345 (t
5346 ,(if lfmt (org-table--generic-apply lfmt ":lfmt" nil cells)
5347 `(concat
5348 (cond
5349 ,(and
5350 (or hllstart hllend)
5351 `(last-header-p
5352 (concat
5353 ,(org-table--generic-apply hllstart ":hllstart")
5354 contents
5355 ,(org-table--generic-apply hllend ":hllend"))))
5356 ,(and
5357 (or hlstart hlend)
5358 `(headerp
5359 (concat
5360 ,(org-table--generic-apply hlstart ":hlstart")
5361 contents
5362 ,(org-table--generic-apply hlend ":hlend"))))
5363 ,(and
5364 (or llstart llend)
5365 `(lastp
5366 (concat
5367 ,(org-table--generic-apply llstart ":llstart")
5368 contents
5369 ,(org-table--generic-apply llend ":llend"))))
5370 (t
5371 ,(cond
5372 ((or lstart lend)
5373 `(concat
5374 ,(org-table--generic-apply lstart ":lstart")
5375 contents
5376 ,(org-table--generic-apply lend ":lend")))
5377 (backend
5378 `(org-export-with-backend
5379 ',backend row contents info))
5380 (t 'contents)))))))))))))))
5382 (defun org-table--to-generic-cell (params)
5383 "Return custom table cell transcoder according to PARAMS.
5384 PARAMS is a plist. See `orgtbl-to-generic' for more
5385 information."
5386 (let* ((backend (plist-get params :backend))
5387 (efmt (plist-get params :efmt))
5388 (fmt (plist-get params :fmt))
5389 (hfmt (plist-get params :hfmt))
5390 (sep (plist-get params :sep))
5391 (hsep (plist-get params :hsep)))
5392 `(lambda (cell contents info)
5393 ;; Make sure that contents are exported as Org data when :raw
5394 ;; parameter is non-nil.
5395 ,(when (and backend (plist-get params :raw))
5396 `(setq contents
5397 ;; Since we don't know what are the pseudo object
5398 ;; types defined in backend, we cannot pass them to
5399 ;; `org-element-interpret-data'. As a consequence,
5400 ;; they will be treated as pseudo elements, and will
5401 ;; have newlines appended instead of spaces.
5402 ;; Therefore, we must make sure :post-blank value is
5403 ;; really turned into spaces.
5404 (replace-regexp-in-string
5406 (org-trim
5407 (org-element-interpret-data
5408 (org-element-contents cell))))))
5410 (let ((headerp ,(and (or hfmt hsep)
5411 '(org-export-table-row-in-header-p
5412 (org-export-get-parent-element cell) info)))
5413 (column
5414 ;; Call costly `org-export-table-cell-address' only if
5415 ;; absolutely necessary, i.e., if one
5416 ;; of :fmt :efmt :hmft has a "plist type" value.
5417 ,(and (cl-some (lambda (v) (integerp (car-safe v)))
5418 (list efmt hfmt fmt))
5419 '(1+ (cdr (org-export-table-cell-address cell info))))))
5420 (when contents
5421 ;; Check if we can apply `:efmt' on CONTENTS.
5422 ,(when efmt
5423 `(when (string-match orgtbl-exp-regexp contents)
5424 (let ((mantissa (match-string 1 contents))
5425 (exponent (match-string 2 contents)))
5426 (setq contents ,(org-table--generic-apply
5427 efmt ":efmt" t 'mantissa 'exponent)))))
5428 ;; Check if we can apply FMT (or HFMT) on CONTENTS.
5429 (cond
5430 ,(and hfmt `(headerp (setq contents ,(org-table--generic-apply
5431 hfmt ":hfmt" t 'contents))))
5432 ,(and fmt `(t (setq contents ,(org-table--generic-apply
5433 fmt ":fmt" t 'contents))))))
5434 ;; If a separator is provided, use it instead of BACKEND's.
5435 ;; Separators are ignored when LFMT (or equivalent) is
5436 ;; provided.
5437 ,(cond
5438 ((or hsep sep)
5439 `(if (or ,(and (not sep) '(not headerp))
5440 (plist-get info :orgtbl-ignore-sep)
5441 (not (org-export-get-next-element cell info)))
5442 ,(if (not backend) 'contents
5443 `(org-export-with-backend ',backend cell contents info))
5444 (concat contents
5445 ,(if (and sep hsep) `(if headerp ,hsep ,sep)
5446 (or hsep sep)))))
5447 (backend `(org-export-with-backend ',backend cell contents info))
5448 (t 'contents))))))
5450 ;;;###autoload
5451 (defun orgtbl-to-tsv (table params)
5452 "Convert the orgtbl-mode table to TAB separated material."
5455 ;;;###autoload
5456 (defun orgtbl-to-csv (table params)
5457 "Convert the orgtbl-mode table to CSV material.
5458 This does take care of the proper quoting of fields with comma or quotes."
5459 (orgtbl-to-generic table
5460 (org-combine-plists '(:sep "," :fmt org-quote-csv-field)
5461 params)))
5463 ;;;###autoload
5464 (defun orgtbl-to-latex (table params)
5465 "Convert the orgtbl-mode TABLE to LaTeX.
5467 TABLE is a list, each entry either the symbol `hline' for
5468 a horizontal separator line, or a list of fields for that line.
5469 PARAMS is a property list of parameters that can influence the
5470 conversion. All parameters from `orgtbl-to-generic' are
5471 supported. It is also possible to use the following ones:
5473 :booktabs
5477 :environment
5479 Specify environment to use, as a string. If you use
5481 as a string, to get proper continuation strings."
5482 (require 'ox-latex)
5483 (orgtbl-to-generic
5484 table
5485 (org-combine-plists
5486 ;; Provide sane default values.
5487 (list :backend 'latex
5488 :latex-default-table-mode 'table
5489 :latex-tables-centered nil
5490 :latex-tables-booktabs (plist-get params :booktabs)
5491 :latex-table-scientific-notation nil
5492 :latex-default-table-environment
5493 (or (plist-get params :environment) "tabular"))
5494 params)))
5496 ;;;###autoload
5497 (defun orgtbl-to-html (table params)
5498 "Convert the orgtbl-mode TABLE to HTML.
5500 TABLE is a list, each entry either the symbol `hline' for
5501 a horizontal separator line, or a list of fields for that line.
5502 PARAMS is a property list of parameters that can influence the
5503 conversion. All parameters from `orgtbl-to-generic' are
5504 supported. It is also possible to use the following one:
5506 :attributes
5508 Attributes and values, as a plist, which will be used in
5509 <table> tag."
5510 (require 'ox-html)
5511 (orgtbl-to-generic
5512 table
5513 (org-combine-plists
5514 ;; Provide sane default values.
5515 (list :backend 'html
5516 :html-table-data-tags '("<td%s>" . "</td>")
5517 :html-table-use-header-tags-for-first-column nil
5518 :html-table-align-individual-fields t
5519 :html-table-row-tags '("<tr>" . "</tr>")
5520 :html-table-attributes
5521 (if (plist-member params :attributes)
5522 (plist-get params :attributes)
5523 '(:border "2" :cellspacing "0" :cellpadding "6" :rules "groups"
5524 :frame "hsides")))
5525 params)))
5527 ;;;###autoload
5528 (defun orgtbl-to-texinfo (table params)
5529 "Convert the orgtbl-mode TABLE to Texinfo.
5531 TABLE is a list, each entry either the symbol `hline' for
5532 a horizontal separator line, or a list of fields for that line.
5533 PARAMS is a property list of parameters that can influence the
5534 conversion. All parameters from `orgtbl-to-generic' are
5535 supported. It is also possible to use the following one:
5537 :columns
5539 Column widths, as a string. When providing column fractions,
5541 (require 'ox-texinfo)
5542 (let ((output
5543 (orgtbl-to-generic
5544 table
5545 (org-combine-plists
5546 (list :backend 'texinfo
5547 :texinfo-tables-verbatim nil
5548 :texinfo-table-scientific-notation nil)
5549 params)))
5550 (columns (let ((w (plist-get params :columns)))
5551 (cond ((not w) nil)
5553 (t (concat "@columnfractions " w))))))
5554 (if (not columns) output
5555 (replace-regexp-in-string
5558 ;;;###autoload
5559 (defun orgtbl-to-orgtbl (table params)
5560 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
5562 TABLE is a list, each entry either the symbol `hline' for
5563 a horizontal separator line, or a list of fields for that line.
5564 PARAMS is a property list of parameters that can influence the
5565 conversion. All parameters from `orgtbl-to-generic' are
5566 supported.
5568 Useful when slicing one table into many. The :hline, :sep,
5569 :lstart, and :lend provide orgtbl framing. :tstart and :tend can
5570 be set to provide ORGTBL directives for the generated table."
5571 (require 'ox-org)
5572 (orgtbl-to-generic table (org-combine-plists params (list :backend 'org))))
5574 (defun orgtbl-to-table.el (table params)
5575 "Convert the orgtbl-mode TABLE into a table.el table.
5576 TABLE is a list, each entry either the symbol `hline' for
5577 a horizontal separator line, or a list of fields for that line.
5578 PARAMS is a property list of parameters that can influence the
5579 conversion. All parameters from `orgtbl-to-generic' are
5580 supported."
5581 (with-temp-buffer
5582 (insert (orgtbl-to-orgtbl table params))
5583 (org-table-align)
5584 (replace-regexp-in-string
5585 "-|" "-+"
5586 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
5588 (defun orgtbl-to-unicode (table params)
5589 "Convert the orgtbl-mode TABLE into a table with unicode characters.
5591 TABLE is a list, each entry either the symbol `hline' for
5592 a horizontal separator line, or a list of fields for that line.
5593 PARAMS is a property list of parameters that can influence the
5594 conversion. All parameters from `orgtbl-to-generic' are
5595 supported. It is also possible to use the following ones:
5597 :ascii-art
5600 the table. You can download it here:
5601 http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el.
5603 :narrow
5605 When non-nil, narrow columns width than provided width cookie,
5607 (require 'ox-ascii)
5608 (orgtbl-to-generic
5609 table
5610 (org-combine-plists
5611 (list :backend 'ascii
5612 :ascii-charset 'utf-8
5613 :ascii-table-widen-columns (not (plist-get params :narrow))
5614 :ascii-table-use-ascii-art (plist-get params :ascii-art))
5615 params)))
5617 ;; Put the cursor in a column containing numerical values
5618 ;; of an Org table,
5619 ;; type C-c " a
5620 ;; A new column is added with a bar plot.
5621 ;; When the table is refreshed (C-u C-c *),
5622 ;; the plot is updated to reflect the new values.
5624 (defun orgtbl-ascii-draw (value min max &optional width characters)
5625 "Draw an ascii bar in a table.
5626 VALUE is the value to plot, it determines the width of the bar to draw.
5627 MIN is the value that will be displayed as empty (zero width bar).
5628 MAX is the value that will draw a bar filling all the WIDTH.
5629 WIDTH is the span in characters from MIN to MAX.
5630 CHARACTERS is a string that will compose the bar, with shades of grey
5631 from pure white to pure black. It defaults to a 10 characters string
5632 of regular ascii characters."
5633 (let* ((width (ceiling (or width 12)))
5634 (characters (or characters " .:;c!lhVHW"))
5635 (len (1- (length characters)))
5636 (value (float (if (numberp value)
5637 value (string-to-number value))))
5638 (relative (/ (- value min) (- max min)))
5639 (steps (round (* relative width len))))
5640 (cond ((< steps 0) "too small")
5641 ((> steps (* width len)) "too large")
5642 (t (let* ((int-division (/ steps len))
5643 (remainder (- steps (* int-division len))))
5644 (concat (make-string int-division (elt characters len))
5645 (string (elt characters remainder))))))))
5647 ;;;###autoload
5648 (defun orgtbl-ascii-plot (&optional ask)
5649 "Draw an ASCII bar plot in a column.
5651 With cursor in a column containing numerical values, this function
5652 will draw a plot in a new column.
5654 ASK, if given, is a numeric prefix to override the default 12
5656 prefix,
5657 which will prompt for the width."
5658 (interactive "P")
5659 (let ((col (org-table-current-column))
5660 (min 1e999) ; 1e999 will be converted to infinity
5661 (max -1e999) ; which is the desired result
5662 (table (org-table-to-lisp))
5663 (length
5664 (cond ((consp ask)
5665 (read-number "Length of column " 12))
5666 ((numberp ask) ask)
5667 (t 12))))
5668 ;; Skip any hline a the top of table.
5669 (while (eq (car table) 'hline) (setq table (cdr table)))
5670 ;; Skip table header if any.
5671 (dolist (x (or (cdr (memq 'hline table)) table))
5672 (when (consp x)
5673 (setq x (nth (1- col) x))
5674 (when (string-match
5676 x)
5677 (setq x (string-to-number x))
5678 (when (> min x) (setq min x))
5679 (when (< max x) (setq max x)))))
5680 (org-table-insert-column)
5681 (org-table-move-column-right)
5682 (org-table-store-formulas
5683 (cons
5684 (cons
5685 (concat "$" (number-to-string (1+ col)))
5686 (format "'(%s $%s %s %s %s)"
5687 "orgtbl-ascii-draw" col min max length))
5688 (org-table-get-stored-formulas)))
5689 (org-table-recalculate t)))
5691 ;; Example of extension: unicode characters
5692 ;; Here are two examples of different styles.
5694 ;; Unicode block characters are used to give a smooth effect.
5695 ;; See http://en.wikipedia.org/wiki/Block_Elements
5696 ;; Use one of those drawing functions
5697 ;; - orgtbl-ascii-draw (the default ascii)
5698 ;; - orgtbl-uc-draw-grid (unicode with a grid effect)
5699 ;; - orgtbl-uc-draw-cont (smooth unicode)
5701 ;; This is best viewed with the "DejaVu Sans Mono" font
5702 ;; (use M-x set-default-font).
5704 (defun orgtbl-uc-draw-grid (value min max &optional width)
5705 "Draw a bar in a table using block unicode characters.
5706 It is a variant of orgtbl-ascii-draw with Unicode block
5707 characters, for a smooth display. Bars appear as grids (to the
5708 extent the font allows)."
5709 ;; http://en.wikipedia.org/wiki/Block_Elements
5710 ;; best viewed with the "DejaVu Sans Mono" font.
5711 (orgtbl-ascii-draw value min max width
5714 (defun orgtbl-uc-draw-cont (value min max &optional width)
5715 "Draw a bar in a table using block unicode characters.
5716 It is a variant of orgtbl-ascii-draw with Unicode block
5717 characters, for a smooth display. Bars are solid (to the extent
5718 the font allows)."
5719 (orgtbl-ascii-draw value min max width
5722 (defun org-table-get-remote-range (name-or-id form)
5723 "Get a field value or a list of values in a range from table at ID.
5725 NAME-OR-ID may be the name of a table in the current file as set
5727 will then be used. Alternatively, it may be an ID referring to
5728 any entry, also in a different file. In this case, the first
5729 table in that entry will be referenced.
5733 The return value is either a single string for a single field, or a
5734 list of the fields in the rectangle."
5735 (save-match-data
5736 (let ((case-fold-search t) (id-loc nil)
5737 ;; Protect a bunch of variables from being overwritten by
5738 ;; the context of the remote table.
5739 org-table-column-names org-table-column-name-regexp
5740 org-table-local-parameters org-table-named-field-locations
5741 org-table-current-line-types
5742 org-table-current-begin-pos org-table-dlines
5743 org-table-current-ncol
5744 org-table-hlines org-table-last-alignment
5745 org-table-last-column-widths org-table-last-alignment
5746 org-table-last-column-widths
5747 buffer loc)
5748 (setq form (org-table-convert-refs-to-rc form))
5749 (org-with-wide-buffer
5750 (goto-char (point-min))
5751 (if (re-search-forward
5754 nil t)
5755 (setq buffer (current-buffer) loc (match-beginning 0))
5756 (setq id-loc (org-id-find name-or-id 'marker))
5757 (unless (and id-loc (markerp id-loc))
5759 (setq buffer (marker-buffer id-loc)
5760 loc (marker-position id-loc))
5761 (move-marker id-loc nil))
5762 (with-current-buffer buffer
5763 (org-with-wide-buffer
5764 (goto-char loc)
5765 (forward-char 1)
5767 (not (match-beginning 1)))
5768 (user-error "Cannot find a table at NAME or ID %s" name-or-id))
5769 (org-table-analyze)
5770 (setq form (org-table-formula-substitute-names
5771 (org-table-formula-handle-first/last-rc form)))
5772 (if (and (string-match org-table-range-regexp form)
5773 (> (length (match-string 0 form)) 1))
5774 (org-table-get-range
5775 (match-string 0 form) org-table-current-begin-pos 1)
5776 form)))))))
5778 (defun org-table-remote-reference-indirection (form)
5779 "Return formula with table remote references substituted by indirection.
5781 This indirection works only with the format @ROW$COLUMN. The
5783 distinguished from a plain table name or ID."
5784 (let ((regexp
5785 ;; Same as in `org-table-eval-formula'.
5787 ;; Allow "$1", "@<", "$-1", "@<<$1" etc.
5790 (replace-regexp-in-string
5791 regexp
5792 (lambda (m)
5793 (save-match-data
5794 (let ((eq (org-table-formula-handle-first/last-rc (match-string 1 m))))
5795 (org-table-get-range
5797 (concat "@0" eq)
5798 eq)))))
5799 form t t 1)))
5801 (defmacro org-define-lookup-function (mode)
5802 (let ((mode-str (symbol-name mode))
5803 (first-p (eq mode 'first))
5804 (all-p (eq mode 'all)))
5805 (let ((plural-str (if all-p "s" "")))
5806 `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
5807 ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
5808 If R-LIST is nil, return matching element%s of S-LIST.
5809 If PREDICATE is not nil, use it instead of `equal' to match VAL.
5810 Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
5811 This function is generated by a call to the macro `org-define-lookup-function'."
5812 mode-str plural-str plural-str plural-str)
5813 (let ,(let ((lvars '((p (or predicate 'equal))
5814 (sl s-list)
5815 (rl (or r-list s-list))
5816 (ret nil))))
5817 (if first-p (cons '(match-p nil) lvars) lvars))
5818 (while ,(if first-p '(and (not match-p) sl) 'sl)
5819 (when (funcall p val (car sl))
5820 ,(when first-p '(setq match-p t))
5821 (let ((rval (car rl)))
5822 (setq ret ,(if all-p '(append ret (list rval)) 'rval))))
5823 (setq sl (cdr sl) rl (cdr rl)))
5824 ret)))))
5826 (org-define-lookup-function first)
5827 (org-define-lookup-function last)
5828 (org-define-lookup-function all)
5830 (provide 'org-table)
5832 ;; Local variables:
5833 ;; generated-autoload-file: "org-loaddefs.el"
5834 ;; End:
5836 ;;; org-table.el ends here