| blob | 87060feb0dfd2c523549540f721b4fa263d4efaa |
1 ;;; org-table.el --- The Table Editor for Org -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2004-2018 Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: https://orgmode.org
8 ;;
9 ;; This file is part of GNU Emacs.
10 ;;
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
23 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
24 ;;
25 ;;; Commentary:
27 ;; This file contains the table editor and spreadsheet for Org mode.
29 ;; Watch out: Here we are talking about two different kind of tables.
30 ;; Most of the code is for the tables created with the Org mode table editor.
31 ;; Sometimes, we talk about tables created and edited with the table.el
32 ;; Emacs package. We call the former org-type tables, and the latter
33 ;; table.el-type tables.
35 ;;; Code:
77 "Hook for functions attaching to `C-c C-c', if the table is sent.
78 This can be used to add additional functionality after the table is sent
79 to the receiver position, otherwise, if table is not sent, the functions
85 "Non-nil means use the optimized table editor version for `orgtbl-mode'.
87 In the optimized version, the table editor takes over all simple keys that
88 normally just insert a character. In tables, the characters are inserted
89 in a way to minimize disturbing the table structure (i.e. in overwrite mode
90 for empty fields). Outside tables, the correct binding of the keys is
91 restored.
93 Changing this variable requires a restart of Emacs to become
94 effective."
100 % END RECEIVE ORGTBL %n
102 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
103 | | |
106 @c END RECEIVE ORGTBL %n
107 @ignore
108 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
109 | | |
112 <!-- END RECEIVE ORGTBL %n -->
113 <!--
114 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
115 | | |
118 #+ END RECEIVE ORGTBL %n
120 #+ORGTBL: SEND %n orgtbl-to-orgtbl :splice nil :skip 0
121 | | |
123 "Templates for radio tables in different major modes.
124 Each template must define lines that will be treated as a comment and that
127 insertion of the template. The transformed table will later be inserted
128 between these lines.
130 The template should also contain a minimal table in a multiline comment.
131 If multiline comments are not possible in the buffer language,
132 you can pack it into a string that will not be used when the code
133 is compiled or executed. Above the table will you need a line with
135 convert the table into a data structure useful in the
136 language of the buffer. Check the manual for the section on
138 the Info node `(org)Tables in arbitrary syntax'.
140 All occurrences of %n in a template will be replaced with the name of the
141 table, obtained by prompting the user."
148 "Settings for tables in Org mode."
153 "The default size for newly created tables, Columns x Rows."
158 "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%:]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$"
159 "Regular expression for recognizing numbers in table columns.
160 If a table column contains mostly numbers, it will be aligned to the
161 right. If not, it will be aligned to the left.
163 The default value of this option is a regular expression which allows
164 anything which looks remotely like a number as used in scientific
165 context. For example, all of the following will be considered a
166 number:
167 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
169 Other options offered by the customize interface are more restrictive."
183 "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
184 (const :tag "Very General Number-Like, including hex and Calc radix, allows comma as decimal mark"
185 "^\\([<>]?[-+^.,0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
189 "Fraction of numbers in a column required to make the column align right.
190 In a column all non-white fields are considered. If at least
191 this fraction of fields is matched by `org-table-number-regexp',
192 alignment to the right border applies."
197 "Behavior of tables during editing in Org mode."
202 "Non-nil means automatically re-align table when pressing TAB or RETURN.
204 removal/insertion."
209 "Non-nil means automatically blank table field when starting to type into it.
210 This only happens when typing immediately after a field motion
211 command (TAB, S-TAB or RET)."
216 "Non-nil means automatically exit the follow mode.
217 When nil, the follow mode will stay on and be active in any table
218 the cursor enters. Since the table follow filed mode messes with the
219 window configuration, it is not recommended to set this variable to nil,
220 except maybe locally in a special file that has mostly tables with long
221 fields."
227 "Whether the user should confirm when Org fixes formulas."
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 evaluation of formula can add new columns.
391 When non-nil, evaluating an out-of-bounds field can insert as
392 many columns as needed. When set to `warn', issue a warning when
393 doing so. When set to `prompt', ask user before creating a new
394 column. Otherwise, throw an error."
405 "Options concerning table import and export in Org mode."
410 "Default export parameters for `org-table-export'.
411 These can be overridden for a specific table by setting the
412 TABLE_EXPORT_FORMAT property. See the manual section on orgtbl
413 radio tables for the different export transformations and
414 available parameters."
419 "Max lines that `org-table-convert-region' will attempt to process.
421 The function can be slow on larger regions; this safety feature
422 prevents it from hanging emacs."
429 "String to be displayed in a shrunk column."
453 "Alist with column names, derived from the `!' line.
457 "Regular expression matching the current column names.
461 "Alist with parameter names, derived from the `$' line.
465 "Alist with locations of named fields.
466 Associations follow the pattern (NAME LINE COLUMN) where
467 NAME is the name of the field as a string,
468 LINE is the number of lines from the beginning of the table,
469 COLUMN is the column of the field, as an integer.
473 "Table row types in current table.
477 "Current table begin position, as a marker.
481 "Number of columns in current table.
485 "Vector of data line line numbers in the current table.
486 Line numbers are counted from the beginning of the table. This
490 "Vector of hline line numbers in the current table.
491 Line numbers are counted from the beginning of the table. This
495 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
496 ;; 1 2 3 4 5
512 "Space used around fields when aligning the table.
513 This space serves as a segment separator for the purposes of the
517 "Save current field; execute BODY; restore field.
518 Field is restored even in case of abnormal exit."
530 "Save field shrunk state, execute BODY and restore state."
541 "Expand all columns before executing BODY, then shrink them again."
554 ;;;###autoload
556 "Use the table.el package to insert a new table.
557 If there is already a table at point, convert between Org tables
558 and table.el tables."
571 ;;;###autoload
573 "Convert region to table, or create an empty table.
574 If there is an active region, convert it to a table, using the function
575 `org-table-convert-region'. See the documentation of that function
576 to learn how the prefix argument is interpreted to determine the field
577 separator.
578 If there is no such region, create an empty table with `org-table-create'."
584 ;;;###autoload
586 "Query for a size and insert a table skeleton.
606 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
610 ;; Insert a hline after the first row.
617 ;;;###autoload
619 "Convert region to a table.
621 The region goes from BEG0 to END0, but these borders will be moved
622 slightly, to make sure a beginning of line in the first line is included.
624 SEPARATOR specifies the field separator in the lines. It can have the
625 following values:
627 (4) Use the comma as a field separator
628 (16) Use a TAB as field separator
629 (64) Prompt for a regular expression as field separator
630 integer When a number, use that many spaces, or a TAB, as field separator
631 regexp When a regular expression, use it to match the separator
632 nil When nil, the command tries to be smart and figure out the
633 separator in the following way:
634 - when each line contains a TAB, assume TAB-separated material
635 - when each line contains a comma, assume CSV material
636 - else, assume one or more SPACE characters as separator."
640 re)
642 (user-error "Region is longer than `org-table-convert-region-max-lines' (%s) lines; not converting"
643 org-table-convert-region-max-lines)
652 ;; Get the right field separator
663 ;; parse the csv stuff
688 ;;;###autoload
690 "Import FILE as a table.
692 The command tries to be smart and figure out the separator in the
693 following way:
695 - when each line contains a TAB, assume TAB-separated material
696 - when each line contains a comma, assume CSV material
697 - else, assume one or more SPACE characters as separator.
699 When non-nil, SEPARATOR specifies the field separator in the
700 lines. It can have the following values:
702 (4) Use the comma as a field separator
703 (16) Use a TAB as field separator
704 (64) Prompt for a regular expression as field separator
705 integer When a number, use that many spaces, or a TAB, as field separator
706 regexp When a regular expression, use it to match the separator."
715 ;;;###autoload
717 "Export table to a file, with configurable format.
718 Such a file can be imported into usual spreadsheet programs.
720 FILE can be the output file name. If not given, it will be taken
721 from a TABLE_EXPORT_FILE property in the current entry or higher
722 up in the hierarchy, or the user will be prompted for a file
723 name. FORMAT can be an export format, of the same kind as it
724 used when `orgtbl-mode' sends a table in a different format.
726 The command suggests a format depending on TABLE_EXPORT_FORMAT,
727 whether it is set locally or up in the hierarchy, then on the
728 extension of the given file name, and finally on the variable
729 `org-table-export-default-format'."
762 formats)))
763 org-table-export-default-format)
789 "Marker at the beginning of the table last aligned.
792 "Marker at the end of the table last aligned.
795 "List of flags for flushright alignment, from the last re-alignment.
798 "List of max width of fields in each column.
801 "Non-nil means debug table formulas.
809 "Format FIELD according to column WIDTH and alignement ALIGN.
819 prefix
820 field
821 suffix
822 org-table-separator-space)))
824 ;;;###autoload
826 "Align the table at point by aligning all vertical bars."
831 ;; Make sure invisible characters in the table are at the right
832 ;; place since column widths take them into account.
839 ;; Table's rows as lists of fields. Rules are replaced
840 ;; by nil. Trailing spaces are removed.
846 ;; Compute number of columns. If the table contains no
847 ;; field, create a default table and bail out.
855 ;; Compute alignment and width for each column.
877 alignments)))
880 ;; Store alignment of this table, for later editing of single
881 ;; fields.
884 ;; Build new table rows. Only replace rows that actually
885 ;; changed.
890 indent
893 widths
902 cells
903 widths
904 alignments)
914 ;;;###autoload
916 "Find the beginning of the table and return its position.
917 With a non-nil optional argument TABLE-TYPE, return the beginning
918 of a table.el-type table. This function assumes point is on
919 a table."
927 ;;;###autoload
929 "Find the end of the table and return its position.
930 With a non-nil optional argument TABLE-TYPE, return the end of
931 a table.el-type table. This function assumes point is on
932 a table."
940 ;; When the line right after the table is the last line in
941 ;; the buffer with trailing spaces but no final newline
942 ;; character, be sure to catch the correct ending at its
943 ;; beginning. In any other case, ending is expected to be
944 ;; at point max.
949 ;;;###autoload
951 "Justify the current field, text to left, number to right.
952 Optional argument NEW may specify text to replace the current field content."
961 ;; This is not the same table, force a full re-align.
964 ;; Realign the current field, based on previous full realign.
997 ;;;###autoload
999 "Go to the next field in the current table, creating new lines as needed.
1000 Before doing so, re-align the table if necessary."
1005 org-table-may-need-update)
1016 org-table-tab-jumps-over-hlines
1027 ;;;###autoload
1029 "Go to the previous field in the table.
1030 Before doing so, re-align the table if necessary."
1035 org-table-may-need-update)
1053 "Move to the beginning of the current table field.
1054 If already at or before the beginning, move to the beginning of the
1055 previous field.
1056 With numeric argument N, move N-1 fields backward first."
1069 "Move to the end of the current table field.
1070 If already at or after the end, move to the end of the next table field.
1071 With numeric argument N, move N-1 fields forward first."
1084 ;;;###autoload
1086 "Go to the next row (same column) in the current table.
1087 Before doing so, re-align the table if necessary."
1092 org-table-may-need-update)
1104 ;;;###autoload
1106 "Copy the value of the current field one row below.
1108 If the field at the cursor is empty, copy the content of the
1109 nearest non-empty field above. With argument N, use the Nth
1110 non-empty field.
1112 If the current field is not empty, it is copied down to the next
1113 row, and the cursor is moved with it. Therefore, repeating this
1114 command causes the column to be filled row-by-row.
1116 If the variable `org-table-copy-increment' is non-nil and the
1117 field is an integer or a timestamp, it will be incremented while
1118 copying. By default, increment by the difference between the
1119 value in the current field and the one in the field above. To
1120 increment using a fixed integer, set `org-table-copy-increment'
1121 to a number. In the case of a timestamp, increment by days."
1133 txt txt-up inc)
1141 beg t))
1151 beg t))
1158 ;; Above field was not empty, go down to the next row
1191 "Non-nil when point is inside a table data field.
1192 Raise an error otherwise, unless NOERROR is non-nil. In that
1193 case, return nil if point is not inside a data field. When
1194 optional argument ASSUME-TABLE is non-nil, assume point is within
1195 a table."
1207 "Get the field in table line LINE, column COLUMN.
1208 If LINE is larger than the number of data lines in the table, the function
1209 returns nil. However, if COLUMN is too large, we will simply return an
1210 empty string.
1211 If LINE is nil, use the current line.
1212 If COLUMN is nil, use the current column."
1219 "Put VALUE into line LINE, column COLUMN.
1220 When ALIGN is set, also realign the table."
1229 "Return the index of the current data line."
1236 cnt))
1239 "Go to the Nth data line in the current table.
1240 Return t when the line exists, nil if it does not exist."
1247 ;;;###autoload
1249 "Blank the current table field or active region."
1266 "Return the value of the field in column N of current row.
1267 N defaults to current column. If REPLACE is a string, replace
1268 field with this value. The return value is always the old
1269 value."
1273 ;; Before first column or after last one.
1274 ""
1282 val)))
1284 ;;;###autoload
1286 "Show info about the current field, and highlight any reference at point."
1296 col)
1297 org-table-named-field-locations)))
1307 ;; Prioritize field formulas over column formulas.
1316 dline col
1318 dline col ref1
1320 ;; FIXME: formula info not correct if special table line
1327 ""
1333 "Return current column number."
1342 column)))))
1345 "Find out what table data line we are in.
1346 Only data lines count for this."
1354 c)))
1356 ;;;###autoload
1358 "Move the cursor to the Nth column in the current table line.
1359 With optional argument ON-DELIM, stop with point before the left delimiter
1360 of the field.
1361 If there are less than N fields, just go to after the last delimiter.
1362 However, when FORCE is non-nil, create new columns if necessary."
1372 t)))))
1379 ;;;###autoload
1381 "Insert a new column into the table."
1396 ;; Add missing vertical bar at the end of the row.
1403 ;; Shift appropriately stored shrunk column numbers, then hide the
1404 ;; columns again.
1406 shrunk-columns)
1407 beg end)
1409 ;; Fix TBLFM formulas, if desirable.
1416 "Find a data line in the current table, which is needed for column commands.
1417 This function assumes point is in a table. Raise an error when
1418 there is no data row below."
1428 t)))
1431 "Turn a buffer line number into a data line number.
1433 If there is no data line in this line, return nil.
1435 If there is no matching dline (most likely the reference was
1436 a hline), the first dline below it is used. When ABOVE is
1437 non-nil, the one above is used."
1442 nil)
1453 ;;;###autoload
1455 "Delete a column from the table."
1469 nil
1476 ;; Shift appropriately stored shrunk column numbers, then hide the
1477 ;; columns again.
1479 shrunk-columns)
1480 beg end)
1482 ;; Fix TBLFM formulas, if desirable.
1490 ;;;###autoload
1492 "Move column to the right."
1496 ;;;###autoload
1498 "Move column to the left."
1502 ;;;###autoload
1504 "Move the current column to the right. With arg LEFT, move to the left."
1532 ;; Shift appropriately stored shrunk column numbers, then shrink
1533 ;; the columns again.
1541 shrunk-columns)
1542 beg end)
1544 ;; Fix TBLFM formulas, if desirable.
1555 ;;;###autoload
1557 "Move table row down."
1561 ;;;###autoload
1563 "Move table row up."
1567 ;;;###autoload
1569 "Move the current table line down. With arg UP, move it up."
1578 hline2p)
1605 ;;;###autoload
1607 "Insert a new row above the current line into the table.
1608 With prefix ARG, insert below the current line."
1614 ;; Fix the first field if necessary
1618 ;; Buffer may not end of a newline character, so ensure
1619 ;; (beginning-of-line 2) moves point to a new line.
1630 ;;;###autoload
1632 "Insert a horizontal-line below the current line into the table.
1633 With prefix ABOVE, insert above the current line."
1654 ;;;###autoload
1656 "Insert a hline and move to the row below that line."
1670 In particular, this does handle wide and invisible characters."
1672 ;; It's a hline, just map the characters
1678 t t s)))
1679 s))
1681 ;;;###autoload
1683 "Delete the current row or horizontal line from the table."
1699 ;;;###autoload
1702 "Sort table lines according to the column at point.
1704 The position of point indicates the column to be used for
1705 sorting, and the range of lines is the range between the nearest
1706 horizontal separator lines, or the entire table of no such lines
1707 exist. If point is before the first column, you will be prompted
1708 for the sorting column. If there is an active region, the mark
1709 specifies the first line and the sorting column, while point
1710 should be in the last line to be included into the sorting.
1712 The command then prompts for the sorting type which can be
1713 alphabetically, numerically, or by time (as given in a time stamp
1714 in the field, or as a HH:MM value). Sorting in reverse order is
1715 also possible.
1717 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive
1718 if the locale allows for it.
1720 If SORTING-TYPE is specified when this function is called from a Lisp
1721 program, no prompting will take place. SORTING-TYPE must be a character,
1722 any of (?a ?A ?n ?N ?t ?T ?f ?F) where the capital letters indicate that
1723 sorting should be done in reverse order.
1725 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
1726 a function to be called to extract the key. It must return a value
1727 that is compatible with COMPARE-FUNC, the function used to compare
1728 entries.
1730 A non-nil value for INTERACTIVE? is used to signal that this
1731 function is being called interactively."
1734 ;; Point must be either within a field or before a data line.
1739 ;; Set appropriate case sensitivity and column used for sorting.
1752 ;; Narrow buffer to appropriate sorting area.
1763 start))
1766 end)))
1767 ;; Determine arguments for `sort-subr'. Also record original
1768 ;; position. `org-table-save-field' cannot help here since
1769 ;; sorting is too much destructive.
1774 ;; Function to be called on the contents of the field
1775 ;; used for sorting in the current row.
1803 "Function for comparing keys (empty for default \
1804 `sort-subr' predicate): "
1814 #'end-of-line
1818 nil
1819 predicate)
1820 ;; Hide all columns but the one being sorted.
1822 ;; Move back to initial field.
1826 ;;;###autoload
1828 "Copy region in table to the clipboard and blank all relevant fields.
1829 If there is no active region, use just the field at point."
1835 ;;;###autoload
1837 "Copy rectangular region in table to clipboard.
1838 A special clipboard is used which can only be accessed
1839 with `org-table-paste-rectangle'."
1843 current-prefix-arg))
1848 region)
1860 ;; Collect every cell between COLUMN-START and COLUMN-END.
1870 ;;;###autoload
1872 "Paste a rectangular region into a table.
1873 The upper right corner ends up in the current field. All involved fields
1874 will be overwritten. If the rectangle does not fit into the present table,
1875 the table is enlarged as needed. The process ignores horizontal separator
1876 lines."
1886 ;; If we left the table, create a new row.
1898 ;;;###autoload
1900 "Convert from `org-mode' table to table.el and back.
1901 Obviously, this only works within limits. When an Org table is converted
1902 to table.el, all horizontal separator lines get lost, because table.el uses
1903 these as cell boundaries and has no notion of horizontal lines. A table.el
1904 table can be converted to an Org table only if it does not do row or column
1905 spanning. Multiline cells will become multiple cells. Beware, Org mode
1906 does not test if the table can be successfully converted - it blindly
1907 applies a recipe that works for simple tables."
1911 ;; convert to Org table
1920 ;; convert to table.el table
1923 ;; first, get rid of all horizontal lines
1927 ;; insert a hline before first
1931 ;; insert a hline after each line
1936 ;; replace "+" at beginning and ending of hlines
1945 "Transpose Org table at point and eliminate hlines.
1946 So a table like
1948 | 1 | 2 | 4 | 5 |
1949 |---+---+---+---|
1950 | a | b | c | d |
1951 | e | f | g | h |
1953 will be transposed as
1955 | 1 | a | e |
1956 | 2 | b | f |
1957 | 4 | c | g |
1958 | 5 | d | h |
1960 Note that horizontal lines disappear."
1972 table)))
1986 ;;;###autoload
1988 "Wrap several fields in a column like a paragraph.
1989 This is useful if you'd like to spread the contents of a field over several
1990 lines, in order to keep the table compact.
1992 If there is an active region, and both point and mark are in the same column,
1993 the text in the column is wrapped to minimum width for the given number of
1994 lines. Generally, this makes the table more compact. A prefix ARG may be
1995 used to change the number of desired lines. For example, \
1997 formats the selected text to two lines. If the region was longer than two
1998 lines, the remaining lines remain empty. A negative prefix argument reduces
1999 the current number of lines by that amount. The wrapped text is pasted back
2000 into the table. If you formatted it to more lines than it was before, fields
2001 further down in the table get overwritten - so you might need to make space in
2002 the table first.
2004 If there is no region, the current field is split at the cursor position and
2005 the text fragment to the right of the cursor is prepended to the field one
2006 line down.
2008 If there is no region, but you specify a prefix ARG, the current field gets
2009 blank, and the content is appended to the field above."
2013 ;; There is a region: fill as a paragraph.
2024 nil
2025 nlines))))
2028 ;; No region, split the current field at point.
2053 ;;;###autoload
2055 "Edit table field in a different window.
2056 This is mainly useful for fields that contain hidden parts.
2059 visible so that it can be edited in place.
2062 toggle `org-table-follow-field-mode'."
2084 p)
2106 "Finish editing a table data field.
2107 Remove all newline characters, insert the result into the table, realign
2108 the table and kill the editing buffer."
2112 text)
2129 "Minor mode to make the table field editor window follow the cursor.
2130 When this mode is active, the field editor window will always show the
2131 current field. The mode exits automatically when the cursor leaves the
2132 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
2133 nil " TblFollow" nil
2149 ;; We have left the table, exit the follow mode
2159 ;;;###autoload
2161 "Sum numbers in region of current table column.
2162 The result will be displayed in the echo area, and will be available
2165 If there is an active region, it is interpreted as a rectangle and all
2166 numbers in that rectangle will be summed. If there is no active
2167 region and point is located in a table column, sum all numbers in that
2168 column.
2170 If at least one number looks like a time HH:MM or HH:MM:SS, all other
2171 numbers are assumed to be times as well (in decimal hours) and the
2172 numbers are added as such.
2174 If NLAST is a number, only the NLAST fields will actually be summed."
2201 items1)))
2208 s diff)
2215 sres))))
2238 "Return the formula active for the current field.
2240 Assumes that table is already analyzed. If KEY is given, return
2241 the key to this formula. Otherwise return the formula preceded
2250 org-table-named-field-locations)))
2264 "Read a formula from the minibuffer, offer stored formula as default.
2265 When NAMED is non-nil, look for a named equation."
2270 org-table-named-field-locations)))
2283 stored)
2285 equation)
2291 scol))
2293 'org-table-formula-history
2294 )))))
2295 mustsave)
2297 ;; remove formula
2304 ;; We set the column equation, delete the named one.
2306 mustsave t))
2312 eq))
2315 "Store the list of formulas below the current table.
2316 If optional argument LOCATION is a buffer position, insert it at
2317 LOCATION instead."
2325 ;; Don't overwrite TBLFM, we might use text properties to
2326 ;; store stuff.
2340 ;; Fake a high number to make sure this is sorted at the end.
2347 a)
2357 "Compare two formulas for sorting."
2362 ;;;###autoload
2364 "Return an alist with the stored formulas directly after current table.
2365 By default, only return active formulas, i.e., formulas located
2366 on the first line after the table. However, if optional argument
2367 LOCATION is a buffer position, consider the formulas there."
2376 eq-alist seen)
2380 string)
2385 ;; Is it a column reference?
2387 ;; Since named columns are not possible in
2388 ;; LHS, assume this is a named field.
2396 "Double definition `%s=' in TBLFM line, please fix by hand"
2397 lhs)
2402 "Double definition `%s=' in TBLFM line, please fix by hand"
2403 lhs)))))))))))
2406 "Modify the equations after the table structure has been edited.
2408 For all numbers larger than LIMIT, shift them by DELTA."
2420 s n a)
2426 "Change makes TBLFM term %s invalid, use undo to recover"
2441 ;;;###autoload
2444 If yes, store the formula and apply it."
2445 ;; We already know we are in a table. Get field will only return a formula
2446 ;; when appropriate. It might return a separator line, but no problem.
2449 named eq)
2457 "List of commands triggering the recalculation of a line.
2469 ;;;###autoload
2471 "Rotate the recalculation mark in the first column.
2472 If in any row, the first field is not consistent with a mark,
2473 insert a new column for the markers.
2474 When there is an active region, change all the lines in the region,
2475 after prompting for the marking character.
2476 After each change, a message will be displayed indicating the meaning
2477 of the new mark."
2493 newchar))
2501 newchar))
2519 ;; Rotate mark in first row.
2521 ;; Rotate marks in additional rows if a region is active.
2529 ;; Only align if rotation actually changed lines' length.
2539 ;;;###autoload
2541 "Analyze table at point and store results.
2543 This function sets up the following dynamically scoped variables:
2545 `org-table-column-name-regexp',
2546 `org-table-column-names',
2547 `org-table-current-begin-pos',
2548 `org-table-current-line-types',
2549 `org-table-current-ncol',
2550 `org-table-dlines',
2551 `org-table-hlines',
2552 `org-table-local-parameters',
2553 `org-table-named-field-locations'."
2558 ;; Extract column names.
2571 ;; Extract local parameters.
2579 org-table-local-parameters)))))
2580 ;; Update named fields locations. We minimize `count-lines'
2581 ;; processing by storing last known number of lines in LAST.
2603 field))
2606 org-table-named-field-locations))))))))))
2607 ;; Re-use existing markers when possible.
2611 ;; Analyze the line types.
2622 ;; Get the number of columns from the first data line in table.
2630 al al2)
2644 "Move point to a specific field in the current table.
2646 REF is either the name of a field its absolute reference, as
2647 a string. No column is created unless CREATE-COLUMN-P is
2648 non-nil. If it is a function, it is called with the column
2649 number as its argument as is used as a predicate to know if the
2650 column can be created.
2652 This function assumes the table is already analyzed (i.e., using
2653 `org-table-analyze')."
2668 create-column-p)))
2674 ;;;###autoload
2676 "Recompute the current line if marked for it, and if we haven't just done it."
2696 org-tbl-calc-modes)
2698 ;;;###autoload
2700 suppress-align suppress-const
2701 suppress-store suppress-analysis)
2702 "Replace the table field value at the cursor by the result of a calculation.
2704 In a table, this command replaces the value in the current field with the
2706 formula, by storing it in a special line below the table. When called
2708 field formula.
2711 insert the active equation for the field
2712 back into the current field, so that it can be edited there. This is \
2713 useful
2715 check the referenced fields.
2717 When called, the command first prompts for a formula, which is read in
2718 the minibuffer. Previously entered formulas are available through the
2719 history list, and the last used formula is offered as a default.
2720 These stored formulas are adapted correctly when moving, inserting, or
2721 deleting columns with the corresponding commands.
2723 The formula can be any algebraic expression understood by the Calc package.
2724 For details, see the Org mode manual.
2726 This function can also be called from Lisp programs and offers
2727 additional arguments: EQUATION can be the formula to apply. If this
2728 argument is given, the user will not be prompted.
2730 SUPPRESS-ALIGN is used to speed-up recursive calls by by-passing
2731 unnecessary aligns.
2733 SUPPRESS-CONST suppresses the interpretation of constants in the
2734 formula, assuming that this has been done already outside the
2735 function.
2737 SUPPRESS-STORE means the formula should not be stored, either
2738 because it is already stored, or because it is a modified
2739 equation that should not overwrite the stored one.
2741 SUPPRESS-ANALYSIS prevents analyzing the table and checking
2742 location of point."
2758 equation
2764 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2765 duration duration-output-format)
2766 ;; Parse the format string. Since we have a lot of modes, this is
2767 ;; a lot of work. However, I think calc still uses most of the time.
2780 'calc-float-format
2783 n))))
2788 duration-output-format
2817 ;; replace fields with duration values if relevant
2821 fields)))
2827 x))
2828 fields)))
2834 ;; Insert row and column number of formula result field
2845 t t form)))
2847 ;; Check for old vertical references
2849 ;; Insert remote references
2862 rmtrng))
2863 keep-empty numbers lispp))
2864 t t form)))
2865 ;; Insert complex ranges
2875 ;; possibly handle durations
2880 formrg)
2881 keep-empty numbers lispp)))
2886 ;; Insert simple ranges, i.e. included in the current row.
2889 form)
2900 keep-empty numbers lispp))
2901 t t form)))
2903 ;; Insert the references to fields in same row
2910 x keep-empty numbers lispp)))
2927 ;; Use <...> time-stamps so that Calc can handle them.
2930 ;; Internationalize local time-stamps by setting locale to
2931 ;; "C".
2934 org-ts-regexp
2942 form t t))
2945 form
2952 duration-output-format)
2953 ev)))
2958 Orig: %s
2959 $xyz-> %s
2960 @r$c-> %s
2983 ;; Replace any active time stamp in the result with
2984 ;; an inactive one. Dates in tables are likely
2985 ;; piece of regular data, not meant to appear in the
2986 ;; agenda.
2999 prop value)))
3002 "Get a calc vector from a column, according to descriptor DESC.
3004 Optional arguments TBEG and COL can give the beginning of the table and
3005 the current column, to avoid unnecessary parsing.
3007 HIGHLIGHT means just highlight the range.
3009 When CORNERS-ONLY is set, only return the corners of the range as
3010 a list (line1 column1 line2 column2) where line1 and line2 are
3011 line numbers relative to beginning of table, or TBEG, and column1
3012 and column2 are table column numbers."
3015 desc))
3026 thisline)))
3031 thisline)))
3043 ;; Just one field.
3050 ;; A range, return a vector. First sort the numbers to get
3051 ;; a regular rectangle.
3057 ;; Copy the range values into a list.
3072 ;; Return string representation of calc vector.
3078 "Return relative line number corresponding to descriptor DESC.
3079 The cursor is currently in relative line number CLINE."
3084 ;; 1 2 3 4 5 6
3085 desc))
3107 cline)))
3110 "Return relative line of Nth row with type TYPE.
3111 Search starts from relative line I. When BACKWARDS in non-nil,
3112 look before I. When RELATIVE is non-nil, the reference is
3113 relative. DESC is the original descriptor that started the
3114 search, as a string."
3122 ;; We are going to cross a hline. Check if this is
3123 ;; an authorized move.
3134 ;; The last hline doesn't exist. Instead, point to last row
3135 ;; in table.
3144 "Convert list ELEMENTS to something appropriate to insert into formula.
3145 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
3146 NUMBERS indicates that everything should be converted to numbers.
3147 LISPP non-nil means to return something appropriate for a Lisp
3148 list, `literal' is for the format specifier L."
3149 ;; Calc nan (not a number) is used for the conversion of the empty
3150 ;; field to a reference for several reasons: (i) It is accepted in a
3151 ;; Calc formula (e. g. "" or "()" would result in a Calc error).
3152 ;; (ii) In a single field (not in range) it can be distinguished
3153 ;; from "(nan)" which is the reference made from a single field
3154 ;; containing "nan".
3156 ;; field reference
3159 elements
3161 ""
3170 ;; range reference
3175 elements))))
3181 x
3189 x)
3191 elements
3195 "If there has been more than one second since T1, display message.
3196 ARGS are passed as arguments to the `message' function. Returns
3197 current time if a message is printed, otherwise returns T1. If
3198 T1 is nil, always messages."
3202 curtime)
3203 t1)))
3205 ;;;###autoload
3207 "Recalculate the current table line by applying all stored formulas.
3209 With prefix arg ALL, do this for all lines in the table.
3212 if ALL is the symbol `iterate',
3213 recompute the table until it no longer changes.
3215 If NOALIGN is not nil, do not re-align the table after the computations
3216 are done. This is typically used internally to save time, if it is
3217 known that the table will be realigned a little later anyway."
3232 beg end eqlcol eqlfield)
3233 ;; Insert constants in all formulas.
3236 ;; Expand equations, then split the equation list between
3237 ;; column formulas and field formulas.
3249 old-lhs)))
3252 existing formula for column %s"
3253 old-lhs
3254 new))
3255 new))
3261 ;; Expand ranges in lhs of formulas
3263 ;; Get the correct line range to process.
3270 ;; This is a table with marked lines, compute selected
3271 ;; lines.
3273 ;; Move forward to the first non-header line.
3278 ;; Just leave BEG at the start of the table.
3283 ;; Mark named fields untouchable. Also check if several
3284 ;; field/range formulas try to set the same field.
3288 seen-fields)
3299 ;; Turn field coordinates associated to NAME
3300 ;; into an absolute reference.
3304 name)))
3307 reference))
3312 ;; Evaluate the column formulas, but skip fields covered by
3313 ;; field formulas.
3317 ;; Unprotected line, recalculate.
3322 log-last-time
3335 ;; Evaluate the field formulas.
3344 reference
3345 ;; Possibly create a new column, as long as
3346 ;; `org-table-formula-create-columns' allows it.
3358 t))
3365 ;; Clean up markers and internal text property.
3376 ;;;###autoload
3378 "Recalculate the table until it does not change anymore.
3379 The maximum number of iterations is 10, but you can choose a different value
3380 with the prefix ARG."
3385 thistbl)
3399 ;;;###autoload
3401 "Recalculate all tables in the current buffer."
3406 ;; Reason for separate `org-table-align': When repeating
3407 ;; (org-table-recalculate t) `org-table-may-need-update' gets in
3408 ;; the way.
3411 t)))
3413 ;;;###autoload
3415 "Iterate all tables in the buffer, to converge inter-table dependencies."
3420 c1)
3436 "Apply the #+TBLFM in the line at point to the table."
3443 ;; Insert a temporary formula at right after the table
3448 ;; Recalculate the table.
3453 ;; Delete the formula inserted temporarily.
3459 "Find the beginning of the TBLFM lines and return its position.
3460 Return nil when the beginning of TBLFM line was not found."
3467 "Expand list of formulas.
3468 If some of the RHS in the formulas are ranges or a row reference,
3469 expand them to individual field equations for each field. This
3470 function assumes the table is already analyzed (i.e., using
3471 `org-table-analyze')."
3478 ;; This just refers to one fixed field.
3481 ;; This just refers to one fixed named field.
3484 ;; Column formulas are treated specially and are not
3485 ;; expanded.
3490 rhs)
3491 res)))
3503 rhs)
3504 res))))))))))
3507 "Replace @<, @>, $<, $> with first/last row/column of the table.
3508 So @< and $< will always be replaced with @1 and $1, respectively.
3509 The advantage of these special markers are that structure editing of
3510 the table will not change them, while @1 and $1 will be modified
3511 when a line/row is swapped out of that privileged position. So for
3512 formulas that use a range of rows or columns, it may often be better
3514 borders of the table using the @< @> $< $> makers."
3517 s start)
3522 org-table-current-ncol)
3526 len
3533 s)
3536 "Replace $const with values in string F."
3541 org-table-column-name-regexp
3544 org-table-column-names))))
3545 f t t)))
3546 ;; Parameters and constants.
3550 new start))
3553 ;; When a duration is expected, convert value on the fly.
3559 v)))))
3566 "Find the value for a parameter or constant in a formula.
3567 Parameters get priority."
3598 map))
3605 "--"
3608 "--"
3609 "Shift Reference at Point"
3614 "-"
3615 "Change Test Row for Column Formulas"
3618 "--"
3623 org-table-overlay-coordinates)]
3624 "--"
3632 ;;;###autoload
3634 "Edit the formulas of the current table in a separate buffer."
3640 ;; Move point within the table before analyzing it.
3656 ;; Keep global-font-lock-mode from turning on font-lock-mode
3701 "Convert a formula from internal to user representation."
3704 s))
3707 "Convert a formula from user to internal representation."
3710 s))
3713 "Convert spreadsheet references from A7 to @7$28.
3714 Works for single references, but also for entire formulas and even the
3715 full TBLFM line."
3717 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3720 ;; format match, just advance
3725 ;; 3.e5 or something like this.
3728 ;; (member (match-string 1 s)
3729 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3730 )
3731 ;; function name, just advance
3741 t t s)))))
3742 s))
3745 "Convert spreadsheet references from to @7$28 to AB7.
3746 Works for single references, but also for entire formulas and even the
3747 full TBLFM line."
3754 t t s)))
3759 t nil s)))
3760 s)
3763 "Convert a base 26 number represented by letters into an integer.
3764 For example: AB -> 28."
3770 n))
3773 "Convert an integer into a base 26 number represented by letters.
3774 For example: 28 -> AB."
3779 s))
3782 "Convert a time string into numerical duration in seconds.
3783 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3784 If S is a string representing a number, keep this number."
3786 s
3809 "Convert a number of seconds to a time string.
3810 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3811 minutes or seconds."
3823 ;; Ignore seconds
3827 secs0)
3832 secs0)))))
3836 \f
3837 ;;; Columns shrinking
3840 "Non-nil if current field is narrowed.
3841 When non-nil, return the overlay narrowing the field."
3844 o))
3852 "List currently shrunk columns in table at point."
3854 ;; We really check shrunk columns in current row only. It could
3855 ;; be wrong if all rows do not contain the same number of columns
3856 ;; (i.e. the table is not properly aligned). As a consequence,
3857 ;; some columns may not be shrunk again upon aligning the table.
3858 ;;
3859 ;; For example, in the following table, cursor is on first row and
3860 ;; "<>" indicates a shrunk column.
3861 ;;
3862 ;; | |
3863 ;; | | <> |
3864 ;;
3865 ;; Aligning table from the first row will not shrink again the
3866 ;; second row, which was not visible initially.
3867 ;;
3868 ;; However, fixing it requires to check every row, which may be
3869 ;; slow on large tables. Moreover, the hindrance of this
3870 ;; pathological case is very limited.
3883 "Create an overlay to shrink text between START and END.
3885 Use string DISPLAY instead of the real text between the two
3886 buffer positions. FIELD is the real contents of the field, as
3887 a string, or nil. It is meant to be displayed upon moving the
3888 mouse onto the overlay.
3890 Return the overlay."
3893 ;; Removing one overlay removes all other overlays in the
3894 ;; same column.
3903 ;; Make sure overlays stays on top of table coordinates overlays.
3904 ;; See `org-table-overlay-coordinates'.
3907 o))
3910 "Shrink a table field to a specified width.
3912 WIDTH is an integer representing the number of characters to
3913 display, in addition to `org-table-shrunk-column-indicator'. START
3914 and END are, respectively, the beginning and ending positions of
3915 the field. CONTENTS is its trimmed contents, as a string, or
3916 `hline' for table rules.
3918 Real field is hidden under one or two overlays. They have the
3919 following properties:
3921 `org-overlay-type'
3923 Set to `table-column-hide'. Used to identify overlays
3924 responsible for shrinking columns in a table.
3926 `org-table-column-overlays'
3928 It is a list with the pattern (siblings . COLUMN-OVERLAYS)
3929 where COLUMN-OVERLAYS is the list of all overlays hiding the
3930 same column.
3932 Whenever the text behind or next to the overlay is modified, all
3933 the overlays in the column are deleted, effectively displaying
3934 the column again.
3936 Return a list of overlays hiding the field, or nil if field is
3937 already hidden."
3943 start end org-table-shrunk-column-indicator
3947 start end
3949 org-table-shrunk-column-indicator)
3952 ;; If the field is not empty, consider using two overlays: one for
3953 ;; the blanks at the beginning of the field, and another one at
3954 ;; the end of the field. The former ensures a shrunk field is
3955 ;; always displayed with a single white space character in front
3956 ;; of it -- e.g., so that even right-aligned fields appear to the
3957 ;; left -- and the latter cuts the field at WIDTH visible
3958 ;; characters.
3969 ;; Field is too short. Extend its size by adding
3970 ;; white space characters to the right overlay.
3973 org-table-shrunk-column-indicator)
3974 contents)
3975 ;; Find cut location so that WIDTH characters are visible.
3989 upper))
3990 end org-table-shrunk-column-indicator contents)))))
3994 "Read column selection select as a list of numbers.
3996 SELECT is a string containing column ranges, separated by white
3997 space characters, see `org-table-hide-column' for details. MAX
3998 is the maximum column number.
4000 Return value is a sorted list of numbers. Ignore any number
4001 outside of the [1;MAX] range."
4018 max))))
4021 #'<)))
4024 "Shrink COLUMNS in a table.
4025 COLUMNS is a sorted list of column numbers. BEG and END are,
4026 respectively, the beginning position and the end position of the
4027 table."
4038 ;; Move to COLUMN.
4043 ;; Extract boundaries and contents from current field.
4044 ;; Also set the column's width if we encounter a width
4045 ;; cookie for the first time.
4059 ;; Link overlays for current field to the other overlays in the
4060 ;; same column.
4067 ;;;###autoload
4069 "Shrink or expand current column in an Org table.
4071 If a width cookie specifies a width W for the column, the first
4072 W visible characters are displayed. Otherwise, the column is
4073 shrunk to a single character.
4075 When point is before the first column or after the last one, ask
4076 for the columns to shrink or expand, as a list of ranges.
4077 A column range can be one of the following patterns:
4079 N column N only
4080 N-M every column between N and M (both inclusive)
4081 N- every column between N (inclusive) and the last column
4082 -M every column between the first one and M (inclusive)
4083 - every column
4085 When optional argument ARG is a string, use it as white space
4086 separated list of column ranges.
4089 `org-table-shrink', i.e.,
4090 shrink columns with a width cookie and expand the others.
4093 prefix, expand all columns."
4098 ;; Compute an upper bound for the number of columns.
4099 ;; Nonexistent columns are ignored anyway.
4104 (`nil
4108 ;; Point is either before first column or past last
4109 ;; one. Ask for columns to operate on.
4112 max-columns)
4125 ;;;###autoload
4127 "Shrink all columns with a width cookie in the table at point.
4129 Columns without a width cookie are expanded.
4131 Optional arguments BEGIN and END, when non-nil, specify the
4132 beginning and end position of the current table."
4145 ;; Make sure invisible characters in the table are at the right
4146 ;; place since column widths take them into account.
4150 ;;;###autoload
4152 "Expand all columns in the table at point.
4153 Optional arguments BEGIN and END, when non-nil, specify the
4154 beginning and end position of the current table."
4163 \f
4164 ;;; Formula editing
4167 "Convert all references in this buffer, using FUNCTION."
4178 "Convert all references in the buffer from B3 to @3$2 and back."
4188 "Shift the reference at point one row/hline up."
4192 "Shift the reference at point one row/hline down."
4196 "Shift the reference at point one field to the left."
4200 "Shift the reference at point one field to the right."
4211 ;; A B3-like reference
4217 ;; An internal reference
4223 "Re-match the group N, and replace it with the shifted reference."
4228 t t)))
4231 "Shift a reference part REF.
4232 If DECR is set, decrease the references row/column, else increase.
4233 If HLINE is set, this may be a hline reference, it certainly is not
4234 a translation reference."
4263 "Toggle the display of coordinates in the referenced table."
4272 "Parse the buffer for formula definitions and install them.
4273 With prefix ARG, apply the new formulas to the table."
4282 eql)
4285 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
4286 nil t)
4307 "Abort editing formulas, without installing the changes."
4318 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
4359 "Show the location/value of the $ expression at point.
4360 When LOCAL is non-nil, show references for the table at point."
4370 var name e what match dest)
4374 "$1.."
4426 dest)
4452 ;; Column number.
4478 org-table-fedit-scroll-down))))
4490 "Move point to the closest data line in a table.
4491 Raise an error if the table contains no data line. Preserve
4492 column when moving point."
4500 p1
4501 p2)))
4507 "Move cursor one line up in the window showing the table."
4512 "Move cursor one line down in the window showing the table."
4517 "Move the cursor in the window showing the table.
4518 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
4543 "Add a new overlay."
4549 "Highlight rectangular region in a table.
4550 When buffer positions BEG and END are provided, use them to
4551 delimit the region to highlight. Otherwise, refer to point. Use
4552 FACE, when non-nil, for the highlight."
4584 "Remove the rectangle overlays."
4594 "Add overlays to the table at point, to show row/column coordinates."
4622 ;;;###autoload
4624 "Toggle the display of Row/Column numbers in tables."
4635 ;;;###autoload
4637 "Toggle the formula debugger in tables."
4643 ;;; The orgtbl minor mode
4645 ;; Define a minor mode which can be used in other modes in order to
4646 ;; integrate the Org table editor.
4648 ;; This is really a hack, because the Org table editor uses several
4649 ;; keys which normally belong to the major mode, for example the TAB
4650 ;; and RET keys. Here is how it works: The minor mode defines all the
4651 ;; keys necessary to operate the table editor, but wraps the commands
4652 ;; into a function which tests if the cursor is currently inside
4653 ;; a table. If that is the case, the table editor command is
4654 ;; executed. However, when any of those keys is used outside a table,
4655 ;; the function uses `key-binding' to look up if the key has an
4656 ;; associated command in another currently active keymap (minor modes,
4657 ;; major mode, global), and executes that command. There might be
4658 ;; problems if any of the keys used by the table editor is otherwise
4659 ;; used as a prefix key.
4661 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
4662 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
4663 ;; addresses this by checking explicitly for both bindings.
4665 ;; The optimized version (see variable `orgtbl-optimized') takes over
4666 ;; all keys which are bound to `self-insert-command' in the *global map*.
4667 ;; Some modes bind other commands to simple characters, for example
4668 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
4669 ;; active, this binding is ignored inside tables and replaced with a
4670 ;; modified self-insert.
4688 ;; Install it as a minor mode.
4692 ;;;###autoload
4694 "The Org mode table editor as a minor mode for use in other modes."
4699 ;; Exit without error, in case some hook functions calls this by
4700 ;; accident in Org mode.
4704 ;; Make sure we are first in minor-mode-map-alist
4706 ;; FIXME: maybe it should use emulation-mode-map-alists?
4713 auto-fill-inhibit-regexp)
4717 auto-fill-inhibit-regexp)
4718 orgtbl-line-start-regexp))
4733 "Create a function for binding in the table minor mode.
4734 FUN is the command to call inside a table. N is used to create a unique
4735 command name. KEYS are keys that should be checked in for a command
4736 to execute outside of tables."
4742 "Outside of tables, run the binding of `"
4754 keys)
4758 "Error when there is no default binding for a table key."
4763 "Setup orgtbl keymaps."
4794 elt key fun cmd)
4802 ;; Special treatment needed for TAB, RET and DEL
4815 (orgtbl-make-binding 'org-delete-backward-char 109
4821 [(tab)] "\C-i"))
4823 (org-defkey orgtbl-mode-map [backtab]
4825 [backtab] [S-iso-lefttab] [(shift tab)]
4826 [(tab)] "\C-i"))
4828 (org-defkey orgtbl-mode-map "\M-\C-m"
4829 (orgtbl-make-binding 'org-table-wrap-region 105
4830 "\M-\C-m" [(meta return)]))
4831 (org-defkey orgtbl-mode-map [(meta return)]
4832 (orgtbl-make-binding 'org-table-wrap-region 106
4833 [(meta return)] "\M-\C-m"))
4835 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4836 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4838 (when orgtbl-optimized
4839 ;; If the user wants maximum table support, we need to hijack
4840 ;; some standard editing functions
4841 (org-remap orgtbl-mode-map
4842 'self-insert-command 'orgtbl-self-insert-command
4843 'delete-char 'org-delete-char
4844 'delete-backward-char 'org-delete-backward-char)
4845 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4846 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4847 '("OrgTbl"
4848 ["Create or convert" org-table-create-or-convert-from-region
4849 :active (not (org-at-table-p)) :keys "C-c |" ]
4850 "--"
4851 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4852 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4853 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4854 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4855 "--"
4856 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4857 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4858 ["Copy Field from Above"
4859 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4860 "--"
4861 ("Column"
4862 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4863 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4864 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4865 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4866 ("Row"
4867 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4868 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4869 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4870 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4871 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4872 "--"
4873 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4874 ("Rectangle"
4875 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4876 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4877 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4878 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4879 "--"
4880 ("Radio tables"
4881 ["Insert table template" orgtbl-insert-radio-table
4882 (cl-assoc-if #'derived-mode-p orgtbl-radio-table-templates)]
4883 ["Comment/uncomment table" orgtbl-toggle-comment t])
4884 "--"
4885 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4886 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4887 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4888 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4889 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4890 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4891 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4892 ["Sum Column/Rectangle" org-table-sum
4893 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4894 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4895 ["Debug Formulas"
4896 org-table-toggle-formula-debugger :active (org-at-table-p)
4897 :keys "C-c {"
4898 :style toggle :selected org-table-formula-debug]
4899 ["Show Col/Row Numbers"
4900 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4901 :keys "C-c }"
4902 :style toggle :selected org-table-overlay-coordinates]
4903 "--"
4904 ("Plot"
4907 t))
4909 (defun orgtbl-ctrl-c-ctrl-c (arg)
4910 "If the cursor is inside a table, realign the table.
4911 If it is a table to be sent away to a receiver, do it.
4912 With prefix arg, also recompute table."
4913 (interactive "P")
4914 (let ((case-fold-search t) (pos (point)) action)
4915 (save-excursion
4916 (beginning-of-line 1)
4917 (setq action (cond
4921 (cond
4922 ((integerp action)
4923 (goto-char action)
4924 (org-table-maybe-eval-formula)
4925 (if arg
4926 (call-interactively 'org-table-recalculate)
4927 (org-table-maybe-recalculate-line))
4928 (call-interactively 'org-table-align)
4929 (when (orgtbl-send-table 'maybe)
4930 (run-hooks 'orgtbl-after-send-table-hook)))
4931 ((eq action 'recalc)
4932 (save-excursion
4933 (beginning-of-line 1)
4935 (if (org-at-table-p)
4936 (org-call-with-arg 'org-table-recalculate t))))
4937 (t (let (orgtbl-mode)
4938 (call-interactively (key-binding "\C-c\C-c")))))))
4940 (defun orgtbl-create-or-convert-from-region (_arg)
4941 "Create table or convert region to table, if no conflicting binding.
4942 This installs the table binding `C-c |', but only if there is no
4943 conflicting binding to this key outside orgtbl-mode."
4944 (interactive "P")
4945 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4946 (if cmd
4947 (call-interactively cmd)
4948 (call-interactively 'org-table-create-or-convert-from-region))))
4950 (defun orgtbl-tab (arg)
4951 "Justification and field motion for `orgtbl-mode'."
4952 (interactive "P")
4953 (if arg (org-table-edit-field t)
4954 (org-table-justify-field-maybe)
4955 (org-table-next-field)))
4957 (defun orgtbl-ret ()
4958 "Justification and field motion for `orgtbl-mode'."
4959 (interactive)
4960 (if (bobp)
4961 (newline)
4962 (org-table-justify-field-maybe)
4963 (org-table-next-row)))
4965 (defun orgtbl-self-insert-command (N)
4966 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4967 If the cursor is in a table looking at whitespace, the whitespace is
4968 overwritten, and the table is not marked as requiring realignment."
4969 (interactive "p")
4970 (if (and (org-at-table-p)
4971 (or
4972 (and org-table-auto-blank-field
4973 (member last-command
4974 '(orgtbl-hijacker-command-100
4975 orgtbl-hijacker-command-101
4976 orgtbl-hijacker-command-102
4977 orgtbl-hijacker-command-103
4978 orgtbl-hijacker-command-104
4979 orgtbl-hijacker-command-105
4980 yas/expand))
4981 (org-table-blank-field))
4982 t)
4983 (eq N 1)
4985 (let (org-table-may-need-update)
4986 (delete-region (match-beginning 1) (match-end 1))
4987 (self-insert-command N))
4988 (setq org-table-may-need-update t)
4989 (let* (orgtbl-mode
4990 a
4991 (cmd (or (key-binding
4992 (or (and (listp function-key-map)
4993 (setq a (assoc last-input-event function-key-map))
4994 (cdr a))
4995 (vector last-input-event)))
4996 'self-insert-command)))
4997 (call-interactively cmd)
4998 (if (and org-self-insert-cluster-for-undo
4999 (eq cmd 'self-insert-command))
5000 (if (not (eq last-command 'orgtbl-self-insert-command))
5001 (setq org-self-insert-command-undo-counter 1)
5002 (if (>= org-self-insert-command-undo-counter 20)
5003 (setq org-self-insert-command-undo-counter 1)
5004 (and (> org-self-insert-command-undo-counter 0)
5005 buffer-undo-list
5006 (not (cadr buffer-undo-list)) ; remove nil entry
5007 (setcdr buffer-undo-list (cddr buffer-undo-list)))
5008 (setq org-self-insert-command-undo-counter
5009 (1+ org-self-insert-command-undo-counter))))))))
5011 ;;;###autoload
5013 "Regular expression matching exponentials as produced by calc.")
5015 (defun orgtbl-gather-send-defs ()
5016 "Gather a plist of :name, :transform, :params for each destination before
5017 a radio table."
5018 (save-excursion
5019 (goto-char (org-table-begin))
5020 (let (rtn)
5021 (beginning-of-line 0)
5022 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
5023 (let ((name (org-no-properties (match-string 1)))
5024 (transform (intern (match-string 2)))
5025 (params (if (match-end 3)
5026 (read (concat "(" (match-string 3) ")")))))
5027 (push (list :name name :transform transform :params params)
5028 rtn)
5029 (beginning-of-line 0)))
5030 rtn)))
5032 (defun orgtbl-send-replace-tbl (name text)
5033 "Find and replace table NAME with TEXT."
5034 (save-excursion
5035 (goto-char (point-min))
5036 (let* ((location-flag nil)
5037 (name (regexp-quote name))
5040 (while (re-search-forward begin-re nil t)
5041 (unless location-flag (setq location-flag t))
5042 (let ((beg (line-beginning-position 2)))
5043 (unless (re-search-forward end-re nil t)
5044 (user-error "Cannot find end of receiver location at %d" beg))
5045 (beginning-of-line)
5046 (delete-region beg (point))
5048 (unless location-flag
5049 (user-error "No valid receiver location found in the buffer")))))
5051 ;;;###autoload
5052 (defun org-table-to-lisp (&optional txt)
5053 "Convert the table at point to a Lisp structure.
5054 The structure will be a list. Each item is either the symbol `hline'
5055 for a horizontal separator line, or a list of field values as strings.
5056 The table is taken from the parameter TXT, or from the buffer at point."
5057 (unless (or txt (org-at-table-p)) (user-error "No table at point"))
5058 (let ((txt (or txt
5059 (buffer-substring-no-properties (org-table-begin)
5060 (org-table-end)))))
5061 (mapcar (lambda (x)
5062 (if (string-match org-table-hline-regexp x) 'hline
5066 (defun orgtbl-send-table (&optional maybe)
5067 "Send a transformed version of table at point to the receiver position.
5068 With argument MAYBE, fail quietly if no transformation is defined
5069 for this table."
5070 (interactive)
5071 (catch 'exit
5072 (unless (org-at-table-p) (user-error "Not at a table"))
5073 ;; when non-interactive, we assume align has just happened.
5074 (when (called-interactively-p 'any) (org-table-align))
5075 (let ((dests (orgtbl-gather-send-defs))
5076 (table (org-table-to-lisp
5077 (buffer-substring-no-properties (org-table-begin)
5078 (org-table-end))))
5079 (ntbl 0))
5080 (unless dests
5081 (if maybe (throw 'exit nil)
5082 (user-error "Don't know how to transform this table")))
5083 (dolist (dest dests)
5084 (let ((name (plist-get dest :name))
5085 (transform (plist-get dest :transform))
5086 (params (plist-get dest :params)))
5087 (unless (fboundp transform)
5088 (user-error "No such transformation function %s" transform))
5089 (orgtbl-send-replace-tbl name (funcall transform table params)))
5090 (cl-incf ntbl))
5091 (message "Table converted and installed at %d receiver location%s"
5092 ntbl (if (> ntbl 1) "s" ""))
5093 (and (> ntbl 0) ntbl))))
5095 (defun org-remove-by-index (list indices &optional i0)
5096 "Remove the elements in LIST with indices in INDICES.
5097 First element has index 0, or I0 if given."
5098 (if (not indices)
5099 list
5100 (if (integerp indices) (setq indices (list indices)))
5101 (setq i0 (1- (or i0 0)))
5102 (delq :rm (mapcar (lambda (x)
5103 (setq i0 (1+ i0))
5104 (if (memq i0 indices) :rm x))
5105 list))))
5107 (defun orgtbl-toggle-comment ()
5108 "Comment or uncomment the orgtbl at point."
5109 (interactive)
5110 (let* ((case-fold-search t)
5111 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
5112 (re2 (concat "^" orgtbl-line-start-regexp))
5113 (commented (save-excursion (beginning-of-line 1)
5114 (cond ((looking-at re1) t)
5115 ((looking-at re2) nil)
5116 (t (user-error "Not at an org table")))))
5117 (re (if commented re1 re2))
5118 beg end)
5119 (save-excursion
5120 (beginning-of-line 1)
5121 (while (looking-at re) (beginning-of-line 0))
5122 (beginning-of-line 2)
5123 (setq beg (point))
5124 (while (looking-at re) (beginning-of-line 2))
5125 (setq end (point)))
5126 (comment-region beg end (if commented '(4) nil))))
5128 (defun orgtbl-insert-radio-table ()
5129 "Insert a radio table template appropriate for this major mode."
5130 (interactive)
5131 (let* ((e (cl-assoc-if #'derived-mode-p orgtbl-radio-table-templates))
5132 (txt (nth 1 e))
5133 name pos)
5134 (unless e (user-error "No radio table setup defined for %s" major-mode))
5135 (setq name (read-string "Table name: "))
5136 (while (string-match "%n" txt)
5137 (setq txt (replace-match name t t txt)))
5139 (setq pos (point))
5140 (insert txt)
5141 (goto-char pos)))
5143 ;;;###autoload
5144 (defun orgtbl-to-generic (table params)
5145 "Convert the orgtbl-mode TABLE to some other format.
5147 This generic routine can be used for many standard cases.
5149 TABLE is a list, each entry either the symbol `hline' for
5150 a horizontal separator line, or a list of fields for that
5151 line. PARAMS is a property list of parameters that can
5152 influence the conversion.
5154 Valid parameters are:
5156 :backend, :raw
5158 Export back-end used as a basis to transcode elements of the
5159 table, when no specific parameter applies to it. It is also
5160 used to translate cells contents. You can prevent this by
5161 setting :raw property to a non-nil value.
5163 :splice
5165 When non-nil, only convert rows, not the table itself. This is
5166 equivalent to setting to the empty string both :tstart
5167 and :tend, which see.
5169 :skip
5171 When set to an integer N, skip the first N lines of the table.
5172 Horizontal separation lines do count for this parameter!
5174 :skipcols
5176 List of columns that should be skipped. If the table has
5177 a column with calculation marks, that column is automatically
5178 discarded beforehand.
5180 :hline
5182 String to be inserted on horizontal separation lines. May be
5183 nil to ignore these lines altogether.
5185 :sep
5187 Separator between two fields, as a string.
5189 Each in the following group may be either a string or a function
5190 of no arguments returning a string:
5192 :tstart, :tend
5194 Strings to start and end the table. Ignored when :splice is t.
5196 :lstart, :lend
5198 Strings to start and end a new table line.
5200 :llstart, :llend
5202 Strings to start and end the last table line. Default,
5203 respectively, to :lstart and :lend.
5205 Each in the following group may be a string or a function of one
5206 argument (either the cells in the current row, as a list of
5207 strings, or the current cell) returning a string:
5209 :lfmt
5211 Format string for an entire row, with enough %s to capture all
5212 fields. When non-nil, :lstart, :lend, and :sep are ignored.
5214 :llfmt
5216 Format for the entire last line, defaults to :lfmt.
5218 :fmt
5220 A format to be used to wrap the field, should contain %s for
5221 the original field value. For example, to wrap everything in
5223 a property list with column numbers and format strings, or
5224 functions, e.g.,
5228 :hlstart :hllstart :hlend :hllend :hsep :hlfmt :hllfmt :hfmt
5230 Same as above, specific for the header lines in the table.
5231 All lines before the first hline are treated as header. If
5232 any of these is not present, the data line value is used.
5234 This may be either a string or a function of two arguments:
5236 :efmt
5238 Use this format to print numbers with exponential. The format
5239 should have %s twice for inserting mantissa and exponent, for
5241 list with column numbers and format strings or functions.
5242 :fmt will still be applied after :efmt."
5243 ;; Make sure `org-export-create-backend' is available.
5244 (require 'ox)
5245 (let* ((backend (plist-get params :backend))
5246 (custom-backend
5247 ;; Build a custom back-end according to PARAMS. Before
5248 ;; defining a translator, check if there is anything to do.
5249 ;; When there isn't, let BACKEND handle the element.
5250 (org-export-create-backend
5251 :parent (or backend 'org)
5252 :transcoders
5253 `((table . ,(org-table--to-generic-table params))
5254 (table-row . ,(org-table--to-generic-row params))
5255 (table-cell . ,(org-table--to-generic-cell params))
5256 ;; Macros are not going to be expanded. However, no
5257 ;; regular back-end has a transcoder for them. We
5258 ;; provide one so they are not ignored, but displayed
5259 ;; as-is instead.
5260 (macro . (lambda (m c i) (org-element-macro-interpreter m nil))))))
5261 data info)
5262 ;; Store TABLE as Org syntax in DATA. Tolerate non-string cells.
5263 ;; Initialize communication channel in INFO.
5264 (with-temp-buffer
5265 (let ((org-inhibit-startup t)) (org-mode))
5266 (let ((standard-output (current-buffer))
5267 (org-element-use-cache nil))
5268 (dolist (e table)
5270 ((consp e)
5271 (princ "| ") (dolist (c e) (princ c) (princ " |"))
5273 ;; Add back-end specific filters, but not user-defined ones. In
5274 ;; particular, make sure to call parse-tree filters on the
5275 ;; table.
5276 (setq info
5277 (let ((org-export-filters-alist nil))
5278 (org-export-install-filters
5279 (org-combine-plists
5280 (org-export-get-environment backend nil params)
5281 `(:back-end ,(org-export-get-backend backend))))))
5282 (setq data
5283 (org-export-filter-apply-functions
5284 (plist-get info :filter-parse-tree)
5285 (org-element-map (org-element-parse-buffer) 'table
5286 #'identity nil t)
5287 info)))
5288 (when (and backend (symbolp backend) (not (org-export-get-backend backend)))
5289 (user-error "Unknown :backend value"))
5290 (when (or (not backend) (plist-get info :raw)) (require 'ox-org))
5291 ;; Handle :skip parameter.
5292 (let ((skip (plist-get info :skip)))
5293 (when skip
5294 (unless (wholenump skip) (user-error "Wrong :skip value"))
5295 (let ((n 0))
5296 (org-element-map data 'table-row
5297 (lambda (row)
5298 (if (>= n skip) t
5299 (org-element-extract-element row)
5300 (cl-incf n)
5301 nil))
5302 nil t))))
5303 ;; Handle :skipcols parameter.
5304 (let ((skipcols (plist-get info :skipcols)))
5305 (when skipcols
5306 (unless (consp skipcols) (user-error "Wrong :skipcols value"))
5307 (org-element-map data 'table
5308 (lambda (table)
5309 (let ((specialp (org-export-table-has-special-column-p table)))
5310 (dolist (row (org-element-contents table))
5311 (when (eq (org-element-property :type row) 'standard)
5312 (let ((c 1))
5313 (dolist (cell (nthcdr (if specialp 1 0)
5314 (org-element-contents row)))
5315 (when (memq c skipcols)
5316 (org-element-extract-element cell))
5317 (cl-incf c))))))))))
5318 ;; Since we are going to export using a low-level mechanism,
5319 ;; ignore special column and special rows manually.
5320 (let ((special? (org-export-table-has-special-column-p data))
5321 ignore)
5322 (org-element-map data (if special? '(table-cell table-row) 'table-row)
5323 (lambda (datum)
5324 (when (if (eq (org-element-type datum) 'table-row)
5325 (org-export-table-row-is-special-p datum nil)
5326 (org-export-first-sibling-p datum nil))
5327 (push datum ignore))))
5328 (setq info (plist-put info :ignore-list ignore)))
5329 ;; We use a low-level mechanism to export DATA so as to skip all
5330 ;; usual pre-processing and post-processing, i.e., hooks, Babel
5331 ;; code evaluation, include keywords and macro expansion. Only
5332 ;; back-end specific filters are retained.
5333 (let ((output (org-export-data-with-backend data custom-backend info)))
5334 ;; Remove final newline.
5335 (if (org-string-nw-p output) (substring-no-properties output 0 -1) ""))))
5337 (defun org-table--generic-apply (value name &optional with-cons &rest args)
5338 (cond ((null value) nil)
5339 ((functionp value) `(funcall ',value ,@args))
5340 ((stringp value)
5341 (cond ((consp (car args)) `(apply #'format ,value ,@args))
5342 (args `(format ,value ,@args))
5343 (t value)))
5344 ((and with-cons (consp value))
5345 `(let ((val (cadr (memq column ',value))))
5346 (cond ((null val) contents)
5347 ((stringp val) (format val ,@args))
5348 ((functionp val) (funcall val ,@args))
5349 (t (user-error "Wrong %s value" ,name)))))
5350 (t (user-error "Wrong %s value" name))))
5352 (defun org-table--to-generic-table (params)
5353 "Return custom table transcoder according to PARAMS.
5354 PARAMS is a plist. See `orgtbl-to-generic' for more
5355 information."
5356 (let ((backend (plist-get params :backend))
5357 (splice (plist-get params :splice))
5358 (tstart (plist-get params :tstart))
5359 (tend (plist-get params :tend)))
5360 `(lambda (table contents info)
5361 (concat
5362 ,(and tstart (not splice)
5364 ,(if (or (not backend) tstart tend splice) 'contents
5365 `(org-export-with-backend ',backend table contents info))
5366 ,(org-table--generic-apply (and (not splice) tend) ":tend")))))
5368 (defun org-table--to-generic-row (params)
5369 "Return custom table row transcoder according to PARAMS.
5370 PARAMS is a plist. See `orgtbl-to-generic' for more
5371 information."
5372 (let* ((backend (plist-get params :backend))
5373 (lstart (plist-get params :lstart))
5374 (llstart (plist-get params :llstart))
5375 (hlstart (plist-get params :hlstart))
5376 (hllstart (plist-get params :hllstart))
5377 (lend (plist-get params :lend))
5378 (llend (plist-get params :llend))
5379 (hlend (plist-get params :hlend))
5380 (hllend (plist-get params :hllend))
5381 (lfmt (plist-get params :lfmt))
5382 (llfmt (plist-get params :llfmt))
5383 (hlfmt (plist-get params :hlfmt))
5384 (hllfmt (plist-get params :hllfmt)))
5385 `(lambda (row contents info)
5386 (if (eq (org-element-property :type row) 'rule)
5387 ,(cond
5388 ((plist-member params :hline)
5389 (org-table--generic-apply (plist-get params :hline) ":hline"))
5390 (backend `(org-export-with-backend ',backend row nil info)))
5391 (let ((headerp ,(and (or hlfmt hlstart hlend)
5392 '(org-export-table-row-in-header-p row info)))
5393 (last-header-p
5394 ,(and (or hllfmt hllstart hllend)
5395 '(org-export-table-row-ends-header-p row info)))
5396 (lastp (not (org-export-get-next-element row info))))
5397 (when contents
5398 ;; Check if we can apply `:lfmt', `:llfmt', `:hlfmt', or
5399 ;; `:hllfmt' to CONTENTS. Otherwise, fallback on
5400 ;; `:lstart', `:lend' and their relatives.
5401 ,(let ((cells
5402 '(org-element-map row 'table-cell
5403 (lambda (cell)
5404 ;; Export all cells, without separators.
5405 ;;
5406 ;; Use `org-export-data-with-backend'
5407 ;; instead of `org-export-data' to eschew
5408 ;; cached values, which
5409 ;; ignore :orgtbl-ignore-sep parameter.
5410 (org-export-data-with-backend
5411 cell
5412 (plist-get info :back-end)
5413 (org-combine-plists info '(:orgtbl-ignore-sep t))))
5414 info)))
5415 `(cond
5416 ,(and hllfmt
5417 `(last-header-p ,(org-table--generic-apply
5418 hllfmt ":hllfmt" nil cells)))
5419 ,(and hlfmt
5420 `(headerp ,(org-table--generic-apply
5421 hlfmt ":hlfmt" nil cells)))
5422 ,(and llfmt
5423 `(lastp ,(org-table--generic-apply
5424 llfmt ":llfmt" nil cells)))
5425 (t
5426 ,(if lfmt (org-table--generic-apply lfmt ":lfmt" nil cells)
5427 `(concat
5428 (cond
5429 ,(and
5430 (or hllstart hllend)
5431 `(last-header-p
5432 (concat
5433 ,(org-table--generic-apply hllstart ":hllstart")
5434 contents
5435 ,(org-table--generic-apply hllend ":hllend"))))
5436 ,(and
5437 (or hlstart hlend)
5438 `(headerp
5439 (concat
5440 ,(org-table--generic-apply hlstart ":hlstart")
5441 contents
5442 ,(org-table--generic-apply hlend ":hlend"))))
5443 ,(and
5444 (or llstart llend)
5445 `(lastp
5446 (concat
5447 ,(org-table--generic-apply llstart ":llstart")
5448 contents
5449 ,(org-table--generic-apply llend ":llend"))))
5450 (t
5451 ,(cond
5452 ((or lstart lend)
5453 `(concat
5454 ,(org-table--generic-apply lstart ":lstart")
5455 contents
5456 ,(org-table--generic-apply lend ":lend")))
5457 (backend
5458 `(org-export-with-backend
5459 ',backend row contents info))
5460 (t 'contents)))))))))))))))
5462 (defun org-table--to-generic-cell (params)
5463 "Return custom table cell transcoder according to PARAMS.
5464 PARAMS is a plist. See `orgtbl-to-generic' for more
5465 information."
5466 (let* ((backend (plist-get params :backend))
5467 (efmt (plist-get params :efmt))
5468 (fmt (plist-get params :fmt))
5469 (hfmt (plist-get params :hfmt))
5470 (sep (plist-get params :sep))
5471 (hsep (plist-get params :hsep)))
5472 `(lambda (cell contents info)
5473 ;; Make sure that contents are exported as Org data when :raw
5474 ;; parameter is non-nil.
5475 ,(when (and backend (plist-get params :raw))
5476 `(setq contents
5477 ;; Since we don't know what are the pseudo object
5478 ;; types defined in backend, we cannot pass them to
5479 ;; `org-element-interpret-data'. As a consequence,
5480 ;; they will be treated as pseudo elements, and will
5481 ;; have newlines appended instead of spaces.
5482 ;; Therefore, we must make sure :post-blank value is
5483 ;; really turned into spaces.
5484 (replace-regexp-in-string
5486 (org-trim
5487 (org-element-interpret-data
5488 (org-element-contents cell))))))
5490 (let ((headerp ,(and (or hfmt hsep)
5491 '(org-export-table-row-in-header-p
5492 (org-export-get-parent-element cell) info)))
5493 (column
5494 ;; Call costly `org-export-table-cell-address' only if
5495 ;; absolutely necessary, i.e., if one
5496 ;; of :fmt :efmt :hfmt has a "plist type" value.
5497 ,(and (cl-some (lambda (v) (integerp (car-safe v)))
5498 (list efmt hfmt fmt))
5499 '(1+ (cdr (org-export-table-cell-address cell info))))))
5500 (when contents
5501 ;; Check if we can apply `:efmt' on CONTENTS.
5502 ,(when efmt
5503 `(when (string-match orgtbl-exp-regexp contents)
5504 (let ((mantissa (match-string 1 contents))
5505 (exponent (match-string 2 contents)))
5506 (setq contents ,(org-table--generic-apply
5507 efmt ":efmt" t 'mantissa 'exponent)))))
5508 ;; Check if we can apply FMT (or HFMT) on CONTENTS.
5509 (cond
5510 ,(and hfmt `(headerp (setq contents ,(org-table--generic-apply
5511 hfmt ":hfmt" t 'contents))))
5512 ,(and fmt `(t (setq contents ,(org-table--generic-apply
5513 fmt ":fmt" t 'contents))))))
5514 ;; If a separator is provided, use it instead of BACKEND's.
5515 ;; Separators are ignored when LFMT (or equivalent) is
5516 ;; provided.
5517 ,(cond
5518 ((or hsep sep)
5519 `(if (or ,(and (not sep) '(not headerp))
5520 (plist-get info :orgtbl-ignore-sep)
5521 (not (org-export-get-next-element cell info)))
5522 ,(if (not backend) 'contents
5523 `(org-export-with-backend ',backend cell contents info))
5524 (concat contents
5525 ,(if (and sep hsep) `(if headerp ,hsep ,sep)
5526 (or hsep sep)))))
5527 (backend `(org-export-with-backend ',backend cell contents info))
5528 (t 'contents))))))
5530 ;;;###autoload
5531 (defun orgtbl-to-tsv (table params)
5532 "Convert the orgtbl-mode table to TAB separated material."
5535 ;;;###autoload
5536 (defun orgtbl-to-csv (table params)
5537 "Convert the orgtbl-mode table to CSV material.
5538 This does take care of the proper quoting of fields with comma or quotes."
5539 (orgtbl-to-generic table
5540 (org-combine-plists '(:sep "," :fmt org-quote-csv-field)
5541 params)))
5543 ;;;###autoload
5544 (defun orgtbl-to-latex (table params)
5545 "Convert the orgtbl-mode TABLE to LaTeX.
5547 TABLE is a list, each entry either the symbol `hline' for
5548 a horizontal separator line, or a list of fields for that line.
5549 PARAMS is a property list of parameters that can influence the
5550 conversion. All parameters from `orgtbl-to-generic' are
5551 supported. It is also possible to use the following ones:
5553 :booktabs
5557 :environment
5559 Specify environment to use, as a string. If you use
5561 as a string, to get proper continuation strings."
5562 (require 'ox-latex)
5563 (orgtbl-to-generic
5564 table
5565 (org-combine-plists
5566 ;; Provide sane default values.
5567 (list :backend 'latex
5568 :latex-default-table-mode 'table
5569 :latex-tables-centered nil
5570 :latex-tables-booktabs (plist-get params :booktabs)
5571 :latex-table-scientific-notation nil
5572 :latex-default-table-environment
5573 (or (plist-get params :environment) "tabular"))
5574 params)))
5576 ;;;###autoload
5577 (defun orgtbl-to-html (table params)
5578 "Convert the orgtbl-mode TABLE to HTML.
5580 TABLE is a list, each entry either the symbol `hline' for
5581 a horizontal separator line, or a list of fields for that line.
5582 PARAMS is a property list of parameters that can influence the
5583 conversion. All parameters from `orgtbl-to-generic' are
5584 supported. It is also possible to use the following one:
5586 :attributes
5588 Attributes and values, as a plist, which will be used in
5589 <table> tag."
5590 (require 'ox-html)
5591 (orgtbl-to-generic
5592 table
5593 (org-combine-plists
5594 ;; Provide sane default values.
5595 (list :backend 'html
5596 :html-table-data-tags '("<td%s>" . "</td>")
5597 :html-table-use-header-tags-for-first-column nil
5598 :html-table-align-individual-fields t
5599 :html-table-row-tags '("<tr>" . "</tr>")
5600 :html-table-attributes
5601 (if (plist-member params :attributes)
5602 (plist-get params :attributes)
5603 '(:border "2" :cellspacing "0" :cellpadding "6" :rules "groups"
5604 :frame "hsides")))
5605 params)))
5607 ;;;###autoload
5608 (defun orgtbl-to-texinfo (table params)
5609 "Convert the orgtbl-mode TABLE to Texinfo.
5611 TABLE is a list, each entry either the symbol `hline' for
5612 a horizontal separator line, or a list of fields for that line.
5613 PARAMS is a property list of parameters that can influence the
5614 conversion. All parameters from `orgtbl-to-generic' are
5615 supported. It is also possible to use the following one:
5617 :columns
5619 Column widths, as a string. When providing column fractions,
5621 (require 'ox-texinfo)
5622 (let ((output
5623 (orgtbl-to-generic
5624 table
5625 (org-combine-plists
5626 (list :backend 'texinfo
5627 :texinfo-tables-verbatim nil
5628 :texinfo-table-scientific-notation nil)
5629 params)))
5630 (columns (let ((w (plist-get params :columns)))
5631 (cond ((not w) nil)
5633 (t (concat "@columnfractions " w))))))
5634 (if (not columns) output
5635 (replace-regexp-in-string
5638 ;;;###autoload
5639 (defun orgtbl-to-orgtbl (table params)
5640 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
5642 TABLE is a list, each entry either the symbol `hline' for
5643 a horizontal separator line, or a list of fields for that line.
5644 PARAMS is a property list of parameters that can influence the
5645 conversion. All parameters from `orgtbl-to-generic' are
5646 supported.
5648 Useful when slicing one table into many. The :hline, :sep,
5649 :lstart, and :lend provide orgtbl framing. :tstart and :tend can
5650 be set to provide ORGTBL directives for the generated table."
5651 (require 'ox-org)
5652 (orgtbl-to-generic table (org-combine-plists params (list :backend 'org))))
5654 (defun orgtbl-to-table.el (table params)
5655 "Convert the orgtbl-mode TABLE into a table.el table.
5656 TABLE is a list, each entry either the symbol `hline' for
5657 a horizontal separator line, or a list of fields for that line.
5658 PARAMS is a property list of parameters that can influence the
5659 conversion. All parameters from `orgtbl-to-generic' are
5660 supported."
5661 (with-temp-buffer
5662 (insert (orgtbl-to-orgtbl table params))
5663 (org-table-align)
5664 (replace-regexp-in-string
5665 "-|" "-+"
5666 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
5668 (defun orgtbl-to-unicode (table params)
5669 "Convert the orgtbl-mode TABLE into a table with unicode characters.
5671 TABLE is a list, each entry either the symbol `hline' for
5672 a horizontal separator line, or a list of fields for that line.
5673 PARAMS is a property list of parameters that can influence the
5674 conversion. All parameters from `orgtbl-to-generic' are
5675 supported. It is also possible to use the following ones:
5677 :ascii-art
5680 the table. You can download it here:
5681 http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el.
5683 :narrow
5685 When non-nil, narrow columns width than provided width cookie,
5687 (require 'ox-ascii)
5688 (orgtbl-to-generic
5689 table
5690 (org-combine-plists
5691 (list :backend 'ascii
5692 :ascii-charset 'utf-8
5693 :ascii-table-widen-columns (not (plist-get params :narrow))
5694 :ascii-table-use-ascii-art (plist-get params :ascii-art))
5695 params)))
5697 ;; Put the cursor in a column containing numerical values
5698 ;; of an Org table,
5699 ;; type C-c " a
5700 ;; A new column is added with a bar plot.
5701 ;; When the table is refreshed (C-u C-c *),
5702 ;; the plot is updated to reflect the new values.
5704 (defun orgtbl-ascii-draw (value min max &optional width characters)
5705 "Draw an ascii bar in a table.
5706 VALUE is the value to plot, it determines the width of the bar to draw.
5707 MIN is the value that will be displayed as empty (zero width bar).
5708 MAX is the value that will draw a bar filling all the WIDTH.
5709 WIDTH is the span in characters from MIN to MAX.
5710 CHARACTERS is a string that will compose the bar, with shades of grey
5711 from pure white to pure black. It defaults to a 10 characters string
5712 of regular ascii characters."
5713 (let* ((width (ceiling (or width 12)))
5714 (characters (or characters " .:;c!lhVHW"))
5715 (len (1- (length characters)))
5716 (value (float (if (numberp value)
5717 value (string-to-number value))))
5718 (relative (/ (- value min) (- max min)))
5719 (steps (round (* relative width len))))
5720 (cond ((< steps 0) "too small")
5721 ((> steps (* width len)) "too large")
5722 (t (let* ((int-division (/ steps len))
5723 (remainder (- steps (* int-division len))))
5724 (concat (make-string int-division (elt characters len))
5725 (string (elt characters remainder))))))))
5727 ;;;###autoload
5728 (defun orgtbl-ascii-plot (&optional ask)
5729 "Draw an ASCII bar plot in a column.
5731 With cursor in a column containing numerical values, this function
5732 will draw a plot in a new column.
5734 ASK, if given, is a numeric prefix to override the default 12
5736 prefix,
5737 which will prompt for the width."
5738 (interactive "P")
5739 (let ((col (org-table-current-column))
5740 (min 1e999) ; 1e999 will be converted to infinity
5741 (max -1e999) ; which is the desired result
5742 (table (org-table-to-lisp))
5743 (length
5744 (cond ((consp ask)
5745 (read-number "Length of column " 12))
5746 ((numberp ask) ask)
5747 (t 12))))
5748 ;; Skip any hline a the top of table.
5749 (while (eq (car table) 'hline) (setq table (cdr table)))
5750 ;; Skip table header if any.
5751 (dolist (x (or (cdr (memq 'hline table)) table))
5752 (when (consp x)
5753 (setq x (nth (1- col) x))
5754 (when (string-match
5756 x)
5757 (setq x (string-to-number x))
5758 (when (> min x) (setq min x))
5759 (when (< max x) (setq max x)))))
5760 (org-table-insert-column)
5761 (org-table-move-column-right)
5762 (org-table-store-formulas
5763 (cons
5764 (cons
5765 (concat "$" (number-to-string (1+ col)))
5766 (format "'(%s $%s %s %s %s)"
5767 "orgtbl-ascii-draw" col min max length))
5768 (org-table-get-stored-formulas)))
5769 (org-table-recalculate t)))
5771 ;; Example of extension: unicode characters
5772 ;; Here are two examples of different styles.
5774 ;; Unicode block characters are used to give a smooth effect.
5775 ;; See http://en.wikipedia.org/wiki/Block_Elements
5776 ;; Use one of those drawing functions
5777 ;; - orgtbl-ascii-draw (the default ascii)
5778 ;; - orgtbl-uc-draw-grid (unicode with a grid effect)
5779 ;; - orgtbl-uc-draw-cont (smooth unicode)
5781 ;; This is best viewed with the "DejaVu Sans Mono" font
5782 ;; (use M-x set-frame-font).
5784 (defun orgtbl-uc-draw-grid (value min max &optional width)
5785 "Draw a bar in a table using block unicode characters.
5786 It is a variant of orgtbl-ascii-draw with Unicode block
5787 characters, for a smooth display. Bars appear as grids (to the
5788 extent the font allows)."
5789 ;; http://en.wikipedia.org/wiki/Block_Elements
5790 ;; best viewed with the "DejaVu Sans Mono" font.
5791 (orgtbl-ascii-draw value min max width
5794 (defun orgtbl-uc-draw-cont (value min max &optional width)
5795 "Draw a bar in a table using block unicode characters.
5796 It is a variant of orgtbl-ascii-draw with Unicode block
5797 characters, for a smooth display. Bars are solid (to the extent
5798 the font allows)."
5799 (orgtbl-ascii-draw value min max width
5802 (defun org-table-get-remote-range (name-or-id form)
5803 "Get a field value or a list of values in a range from table at ID.
5805 NAME-OR-ID may be the name of a table in the current file as set
5807 will then be used. Alternatively, it may be an ID referring to
5808 any entry, also in a different file. In this case, the first
5809 table in that entry will be referenced.
5813 The return value is either a single string for a single field, or a
5814 list of the fields in the rectangle."
5815 (save-match-data
5816 (let ((case-fold-search t) (id-loc nil)
5817 ;; Protect a bunch of variables from being overwritten by
5818 ;; the context of the remote table.
5819 org-table-column-names org-table-column-name-regexp
5820 org-table-local-parameters org-table-named-field-locations
5821 org-table-current-line-types
5822 org-table-current-begin-pos org-table-dlines
5823 org-table-current-ncol
5824 org-table-hlines
5825 org-table-last-column-widths
5826 org-table-last-alignment
5827 buffer loc)
5828 (setq form (org-table-convert-refs-to-rc form))
5829 (org-with-wide-buffer
5830 (goto-char (point-min))
5831 (if (re-search-forward
5834 nil t)
5835 (setq buffer (current-buffer) loc (match-beginning 0))
5836 (setq id-loc (org-id-find name-or-id 'marker))
5837 (unless (and id-loc (markerp id-loc))
5839 (setq buffer (marker-buffer id-loc)
5840 loc (marker-position id-loc))
5841 (move-marker id-loc nil))
5842 (with-current-buffer buffer
5843 (org-with-wide-buffer
5844 (goto-char loc)
5845 (forward-char 1)
5847 (not (match-beginning 1)))
5848 (user-error "Cannot find a table at NAME or ID %s" name-or-id))
5849 (org-table-analyze)
5850 (setq form (org-table-formula-substitute-names
5851 (org-table-formula-handle-first/last-rc form)))
5852 (if (and (string-match org-table-range-regexp form)
5853 (> (length (match-string 0 form)) 1))
5854 (org-table-get-range
5855 (match-string 0 form) org-table-current-begin-pos 1)
5856 form)))))))
5858 (defun org-table-remote-reference-indirection (form)
5859 "Return formula with table remote references substituted by indirection.
5861 This indirection works only with the format @ROW$COLUMN. The
5863 distinguished from a plain table name or ID."
5864 (let ((regexp
5865 ;; Same as in `org-table-eval-formula'.
5867 ;; Allow "$1", "@<", "$-1", "@<<$1" etc.
5870 (replace-regexp-in-string
5871 regexp
5872 (lambda (m)
5873 (save-match-data
5874 (let ((eq (org-table-formula-handle-first/last-rc (match-string 1 m))))
5875 (org-table-get-range
5877 (concat "@0" eq)
5878 eq)))))
5879 form t t 1)))
5881 (defmacro org-define-lookup-function (mode)
5882 (let ((mode-str (symbol-name mode))
5883 (first-p (eq mode 'first))
5884 (all-p (eq mode 'all)))
5885 (let ((plural-str (if all-p "s" "")))
5886 `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
5887 ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
5888 If R-LIST is nil, return matching element%s of S-LIST.
5889 If PREDICATE is not nil, use it instead of `equal' to match VAL.
5890 Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
5891 This function is generated by a call to the macro `org-define-lookup-function'."
5892 mode-str plural-str plural-str plural-str)
5893 (let ,(let ((lvars '((p (or predicate 'equal))
5894 (sl s-list)
5895 (rl (or r-list s-list))
5896 (ret nil))))
5897 (if first-p (cons '(match-p nil) lvars) lvars))
5898 (while ,(if first-p '(and (not match-p) sl) 'sl)
5899 (when (funcall p val (car sl))
5900 ,(when first-p '(setq match-p t))
5901 (let ((rval (car rl)))
5902 (setq ret ,(if all-p '(append ret (list rval)) 'rval))))
5903 (setq sl (cdr sl) rl (cdr rl)))
5904 ret)))))
5906 (org-define-lookup-function first)
5907 (org-define-lookup-function last)
5908 (org-define-lookup-function all)
5910 (provide 'org-table)
5912 ;; Local variables:
5913 ;; generated-autoload-file: "org-loaddefs.el"
5914 ;; End:
5916 ;;; org-table.el ends here