| blob | e451350224cb321c0d91c38dbdca12558b30a809 |
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."
445 "Alist with column names, derived from the `!' line.
449 "Regular expression matching the current column names.
453 "Alist with parameter names, derived from the `$' line.
457 "Alist with locations of named fields.
458 Associations follow the pattern (NAME LINE COLUMN) where
459 NAME is the name of the field as a string,
460 LINE is the number of lines from the beginning of the table,
461 COLUMN is the column of the field, as an integer.
465 "Table row types in current table.
469 "Current table begin position, as a marker.
473 "Number of columns in current table.
477 "Vector of data line line numbers in the current table.
478 Line numbers are counted from the beginning of the table. This
482 "Vector of hline line numbers in the current table.
483 Line numbers are counted from the beginning of the table. This
487 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
488 ;; 1 2 3 4 5
503 "Save current field; execute BODY; restore field.
504 Field is restored even in case of abnormal exit."
515 ;;;###autoload
517 "Use the table.el package to insert a new table.
518 If there is already a table at point, convert between Org tables
519 and table.el tables."
532 ;;;###autoload
534 "Convert region to table, or create an empty table.
535 If there is an active region, convert it to a table, using the function
536 `org-table-convert-region'. See the documentation of that function
537 to learn how the prefix argument is interpreted to determine the field
538 separator.
539 If there is no such region, create an empty table with `org-table-create'."
545 ;;;###autoload
547 "Query for a size and insert a table skeleton.
567 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
571 ;; Insert a hline after the first row.
578 ;;;###autoload
580 "Convert region to a table.
582 The region goes from BEG0 to END0, but these borders will be moved
583 slightly, to make sure a beginning of line in the first line is included.
585 SEPARATOR specifies the field separator in the lines. It can have the
586 following values:
588 (4) Use the comma as a field separator
589 (16) Use a TAB as field separator
590 (64) Prompt for a regular expression as field separator
591 integer When a number, use that many spaces, or a TAB, as field separator
592 regexp When a regular expression, use it to match the separator
593 nil When nil, the command tries to be smart and figure out the
594 separator in the following way:
595 - when each line contains a TAB, assume TAB-separated material
596 - when each line contains a comma, assume CSV material
597 - else, assume one or more SPACE characters as separator."
601 re)
603 (user-error "Region is longer than `org-table-convert-region-max-lines' (%s) lines; not converting"
604 org-table-convert-region-max-lines)
613 ;; Get the right field separator
624 ;; parse the csv stuff
649 ;;;###autoload
651 "Import FILE as a table.
653 The command tries to be smart and figure out the separator in the
654 following way:
656 - when each line contains a TAB, assume TAB-separated material
657 - when each line contains a comma, assume CSV material
658 - else, assume one or more SPACE characters as separator.
660 When non-nil, SEPARATOR specifies the field separator in the
661 lines. It can have the following values:
663 (4) Use the comma as a field separator
664 (16) Use a TAB as field separator
665 (64) Prompt for a regular expression as field separator
666 integer When a number, use that many spaces, or a TAB, as field separator
667 regexp When a regular expression, use it to match the separator."
676 ;;;###autoload
678 "Export table to a file, with configurable format.
679 Such a file can be imported into usual spreadsheet programs.
681 FILE can be the output file name. If not given, it will be taken
682 from a TABLE_EXPORT_FILE property in the current entry or higher
683 up in the hierarchy, or the user will be prompted for a file
684 name. FORMAT can be an export format, of the same kind as it
685 used when `orgtbl-mode' sends a table in a different format.
687 The command suggests a format depending on TABLE_EXPORT_FORMAT,
688 whether it is set locally or up in the hierarchy, then on the
689 extension of the given file name, and finally on the variable
690 `org-table-export-default-format'."
723 formats)))
724 org-table-export-default-format)
750 "Marker at the beginning of the table last aligned.
753 "Marker at the end of the table last aligned.
756 "List of flags for flushright alignment, from the last re-alignment.
759 "List of max width of fields in each column.
762 "Non-nil means debug table formulas.
772 ;;;###autoload
774 "Align the table at point by aligning all vertical bars."
779 ;; Make sure invisible characters in the table are at the right
780 ;; place since column widths take them into account.
786 ;; Table's rows. Separators are replaced by nil. Trailing
787 ;; spaces are also removed.
793 l)))
795 ;; Get the data fields by splitting the lines.
798 ;; Compute number of fields in the longest line. If the
799 ;; table contains no field, create a default table.
804 ;; A list of empty strings to fill any short rows on output.
806 lengths typenums)
807 ;; Check for special formatting.
810 fmax falign)
811 ;; Look for an explicit width or alignment.
824 ;; Find fields that are wider than FMAX, and shorten them.
829 'help-echo
837 fmax)))
851 f2
853 x))))))
854 ;; Get the maximum width for each column
856 lengths)
857 ;; Get the fraction of numbers among non-empty cells to
858 ;; decide about alignment of the column.
867 1
873 ;; Store alignment of this table, for later editing of single
874 ;; fields.
877 ;; With invisible characters, `format' does not get the field
878 ;; width right So we need to make these fields wide by hand.
879 ;; Invisible characters may be introduced by fontified links,
880 ;; emphasis, macros or sub/superscripts.
898 ;; Compute the formats needed for output of the table.
907 ;; Replace modified lines only. Check not only contents, but
908 ;; also columns' width.
912 hfmt))
934 ;;;###autoload
936 "Find the beginning of the table and return its position.
937 With a non-nil optional argument TABLE-TYPE, return the beginning
938 of a table.el-type table. This function assumes point is on
939 a table."
947 ;;;###autoload
949 "Find the end of the table and return its position.
950 With a non-nil optional argument TABLE-TYPE, return the end of
951 a table.el-type table. This function assumes point is on
952 a table."
960 ;; When the line right after the table is the last line in
961 ;; the buffer with trailing spaces but no final newline
962 ;; character, be sure to catch the correct ending at its
963 ;; beginning. In any other case, ending is expected to be
964 ;; at point max.
969 ;;;###autoload
971 "Justify the current field, text to left, number to right.
972 Optional argument NEW may specify text to replace the current field content."
981 ;; This is not the same table, force a full re-align.
984 ;; Realign the current field, based on previous full realign.
997 len
1012 ;;;###autoload
1014 "Go to the next field in the current table, creating new lines as needed.
1015 Before doing so, re-align the table if necessary."
1020 org-table-may-need-update)
1031 org-table-tab-jumps-over-hlines
1042 ;;;###autoload
1044 "Go to the previous field in the table.
1045 Before doing so, re-align the table if necessary."
1050 org-table-may-need-update)
1068 "Move to the beginning of the current table field.
1069 If already at or before the beginning, move to the beginning of the
1070 previous field.
1071 With numeric argument N, move N-1 fields backward first."
1084 "Move to the end of the current table field.
1085 If already at or after the end, move to the end of the next table field.
1086 With numeric argument N, move N-1 fields forward first."
1099 ;;;###autoload
1101 "Go to the next row (same column) in the current table.
1102 Before doing so, re-align the table if necessary."
1107 org-table-may-need-update)
1119 ;;;###autoload
1121 "Copy the value of the current field one row below.
1123 If the field at the cursor is empty, copy the content of the
1124 nearest non-empty field above. With argument N, use the Nth
1125 non-empty field.
1127 If the current field is not empty, it is copied down to the next
1128 row, and the cursor is moved with it. Therefore, repeating this
1129 command causes the column to be filled row-by-row.
1131 If the variable `org-table-copy-increment' is non-nil and the
1132 field is an integer or a timestamp, it will be incremented while
1133 copying. By default, increment by the difference between the
1134 value in the current field and the one in the field above. To
1135 increment using a fixed integer, set `org-table-copy-increment'
1136 to a number. In the case of a timestamp, increment by days."
1148 txt txt-up inc)
1156 beg t))
1166 beg t))
1173 ;; Above field was not empty, go down to the next row
1206 "Is point inside a table data field?
1207 I.e. not on a hline or before the first or after the last column?
1208 This actually throws an error, so it aborts the current command."
1220 "Get the field in table line LINE, column COLUMN.
1221 If LINE is larger than the number of data lines in the table, the function
1222 returns nil. However, if COLUMN is too large, we will simply return an
1223 empty string.
1224 If LINE is nil, use the current line.
1225 If COLUMN is nil, use the current column."
1232 "Put VALUE into line LINE, column COLUMN.
1233 When ALIGN is set, also realign the table."
1242 "Return the index of the current data line."
1249 cnt))
1252 "Go to the Nth data line in the current table.
1253 Return t when the line exists, nil if it does not exist."
1260 ;;;###autoload
1262 "Blank the current table field or active region."
1279 "Return the value of the field in column N of current row.
1280 N defaults to current column. If REPLACE is a string, replace
1281 field with this value. The return value is always the old
1282 value."
1286 ;; Before first column or after last one.
1287 ""
1294 val)))
1296 ;;;###autoload
1298 "Show info about the current field, and highlight any reference at point."
1308 col)
1309 org-table-named-field-locations)))
1319 ;; Prioritize field formulas over column formulas.
1328 dline col
1330 dline col ref1
1332 ;; FIXME: formula info not correct if special table line
1339 ""
1345 "Find out which column we are in."
1351 column)))
1354 "Find out what table data line we are in.
1355 Only data lines count for this."
1363 c)))
1365 ;;;###autoload
1367 "Move the cursor to the Nth column in the current table line.
1368 With optional argument ON-DELIM, stop with point before the left delimiter
1369 of the field.
1370 If there are less than N fields, just go to after the last delimiter.
1371 However, when FORCE is non-nil, create new columns if necessary."
1381 t)))))
1388 ;;;###autoload
1390 "Insert a new column into the table."
1412 "Find a data line in the current table, which is needed for column commands."
1415 t
1426 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."
1467 nil
1482 ;;;###autoload
1484 "Move column to the right."
1487 ;;;###autoload
1489 "Move column to the left."
1493 ;;;###autoload
1495 "Move the current column to the right. With arg LEFT, move to the left."
1531 ;;;###autoload
1533 "Move table row down."
1536 ;;;###autoload
1538 "Move table row up."
1542 ;;;###autoload
1544 "Move the current table line down. With arg UP, move it up."
1553 hline2p)
1579 ;;;###autoload
1581 "Insert a new row above the current line into the table.
1582 With prefix ARG, insert below the current line."
1587 ;; Fix the first field if necessary
1591 ;; Buffer may not end of a newline character, so ensure
1592 ;; (beginning-of-line 2) moves point to a new line.
1603 ;;;###autoload
1605 "Insert a horizontal-line below the current line into the table.
1606 With prefix ABOVE, insert above the current line."
1627 ;;;###autoload
1629 "Insert a hline and move to the row below that line."
1643 In particular, this does handle wide and invisible characters."
1645 ;; It's a hline, just map the characters
1651 t t s)))
1652 s))
1654 ;;;###autoload
1656 "Delete the current row or horizontal line from the table."
1672 ;;;###autoload
1675 "Sort table lines according to the column at point.
1677 The position of point indicates the column to be used for
1678 sorting, and the range of lines is the range between the nearest
1679 horizontal separator lines, or the entire table of no such lines
1680 exist. If point is before the first column, you will be prompted
1681 for the sorting column. If there is an active region, the mark
1682 specifies the first line and the sorting column, while point
1683 should be in the last line to be included into the sorting.
1685 The command then prompts for the sorting type which can be
1686 alphabetically, numerically, or by time (as given in a time stamp
1687 in the field, or as a HH:MM value). Sorting in reverse order is
1688 also possible.
1690 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1692 If SORTING-TYPE is specified when this function is called from a Lisp
1693 program, no prompting will take place. SORTING-TYPE must be a character,
1694 any of (?a ?A ?n ?N ?t ?T ?f ?F) where the capital letters indicate that
1695 sorting should be done in reverse order.
1697 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
1698 a function to be called to extract the key. It must return a value
1699 that is compatible with COMPARE-FUNC, the function used to compare
1700 entries.
1702 A non-nil value for INTERACTIVE? is used to signal that this
1703 function is being called interactively."
1706 ;; Point must be either within a field or before a data line.
1711 ;; Set appropriate case sensitivity and column used for sorting.
1722 ;; Narrow buffer to appropriate sorting area.
1735 start))
1738 end))))
1739 ;; Determine arguments for `sort-subr'. Also record original
1740 ;; position. `org-table-save-field' cannot help here since
1741 ;; sorting is too much destructive.
1747 ;; Function to be called on the contents of the field
1748 ;; used for sorting in the current row.
1785 #'end-of-line
1789 nil
1790 predicate)
1791 ;; Move back to initial field.
1795 ;;;###autoload
1797 "Copy region in table to the clipboard and blank all relevant fields.
1798 If there is no active region, use just the field at point."
1804 ;;;###autoload
1806 "Copy rectangular region in table to clipboard.
1807 A special clipboard is used which can only be accessed
1808 with `org-table-paste-rectangle'."
1812 current-prefix-arg))
1817 region)
1829 ;; Collect every cell between COLUMN-START and COLUMN-END.
1839 ;;;###autoload
1841 "Paste a rectangular region into a table.
1842 The upper right corner ends up in the current field. All involved fields
1843 will be overwritten. If the rectangle does not fit into the present table,
1844 the table is enlarged as needed. The process ignores horizontal separator
1845 lines."
1855 ;; If we left the table, create a new row.
1867 ;;;###autoload
1869 "Convert from `org-mode' table to table.el and back.
1870 Obviously, this only works within limits. When an Org table is converted
1871 to table.el, all horizontal separator lines get lost, because table.el uses
1872 these as cell boundaries and has no notion of horizontal lines. A table.el
1873 table can be converted to an Org table only if it does not do row or column
1874 spanning. Multiline cells will become multiple cells. Beware, Org mode
1875 does not test if the table can be successfully converted - it blindly
1876 applies a recipe that works for simple tables."
1880 ;; convert to Org table
1889 ;; convert to table.el table
1892 ;; first, get rid of all horizontal lines
1896 ;; insert a hline before first
1900 ;; insert a hline after each line
1905 ;; replace "+" at beginning and ending of hlines
1914 "Transpose Org table at point and eliminate hlines.
1915 So a table like
1917 | 1 | 2 | 4 | 5 |
1918 |---+---+---+---|
1919 | a | b | c | d |
1920 | e | f | g | h |
1922 will be transposed as
1924 | 1 | a | e |
1925 | 2 | b | f |
1926 | 4 | c | g |
1927 | 5 | d | h |
1929 Note that horizontal lines disappear."
1941 table)))
1955 ;;;###autoload
1957 "Wrap several fields in a column like a paragraph.
1958 This is useful if you'd like to spread the contents of a field over several
1959 lines, in order to keep the table compact.
1961 If there is an active region, and both point and mark are in the same column,
1962 the text in the column is wrapped to minimum width for the given number of
1963 lines. Generally, this makes the table more compact. A prefix ARG may be
1964 used to change the number of desired lines. For example, \
1966 formats the selected text to two lines. If the region was longer than two
1967 lines, the remaining lines remain empty. A negative prefix argument reduces
1968 the current number of lines by that amount. The wrapped text is pasted back
1969 into the table. If you formatted it to more lines than it was before, fields
1970 further down in the table get overwritten - so you might need to make space in
1971 the table first.
1973 If there is no region, the current field is split at the cursor position and
1974 the text fragment to the right of the cursor is prepended to the field one
1975 line down.
1977 If there is no region, but you specify a prefix ARG, the current field gets
1978 blank, and the content is appended to the field above."
1982 ;; There is a region: fill as a paragraph.
1993 nil
1994 nlines))))
1997 ;; No region, split the current field at point.
2022 ;;;###autoload
2024 "Edit table field in a different window.
2025 This is mainly useful for fields that contain hidden parts.
2028 visible so that it can be edited in place.
2031 toggle `org-table-follow-field-mode'."
2041 display t intangible t))
2054 p)
2070 intangible t))
2078 "Finish editing a table data field.
2079 Remove all newline characters, insert the result into the table, realign
2080 the table and kill the editing buffer."
2084 text)
2101 "Minor mode to make the table field editor window follow the cursor.
2102 When this mode is active, the field editor window will always show the
2103 current field. The mode exits automatically when the cursor leaves the
2104 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
2105 nil " TblFollow" nil
2121 ;; We have left the table, exit the follow mode
2131 ;;;###autoload
2133 "Sum numbers in region of current table column.
2134 The result will be displayed in the echo area, and will be available
2137 If there is an active region, it is interpreted as a rectangle and all
2138 numbers in that rectangle will be summed. If there is no active
2139 region and point is located in a table column, sum all numbers in that
2140 column.
2142 If at least one number looks like a time HH:MM or HH:MM:SS, all other
2143 numbers are assumed to be times as well (in decimal hours) and the
2144 numbers are added as such.
2146 If NLAST is a number, only the NLAST fields will actually be summed."
2173 items1)))
2180 s diff)
2187 sres))))
2210 "Return the formula active for the current field.
2212 Assumes that table is already analyzed. If KEY is given, return
2213 the key to this formula. Otherwise return the formula preceded
2222 org-table-named-field-locations)))
2236 "Read a formula from the minibuffer, offer stored formula as default.
2237 When NAMED is non-nil, look for a named equation."
2242 org-table-named-field-locations)))
2255 stored)
2257 equation)
2263 scol))
2265 'org-table-formula-history
2266 )))))
2267 mustsave)
2269 ;; remove formula
2276 ;; We set the column equation, delete the named one.
2278 mustsave t))
2284 eq))
2287 "Store the list of formulas below the current table.
2288 If optional argument LOCATION is a buffer position, insert it at
2289 LOCATION instead."
2297 ;; Don't overwrite TBLFM, we might use text properties to
2298 ;; store stuff.
2312 ;; Fake a high number to make sure this is sorted at the end.
2319 a)
2329 "Compare two formulas for sorting."
2334 ;;;###autoload
2336 "Return an alist with the stored formulas directly after current table.
2337 By default, only return active formulas, i.e., formulas located
2338 on the first line after the table. However, if optional argument
2339 LOCATION is a buffer position, consider the formulas there."
2348 eq-alist seen)
2352 string)
2357 ;; Is it a column reference?
2359 ;; Since named columns are not possible in
2360 ;; LHS, assume this is a named field.
2368 "Double definition `%s=' in TBLFM line, please fix by hand"
2369 lhs)
2374 "Double definition `%s=' in TBLFM line, please fix by hand"
2375 lhs)))))))))))
2378 "Modify the equations after the table structure has been edited.
2380 For all numbers larger than LIMIT, shift them by DELTA."
2392 s n a)
2398 "Change makes TBLFM term %s invalid, use undo to recover"
2413 ;;;###autoload
2416 If yes, store the formula and apply it."
2417 ;; We already know we are in a table. Get field will only return a formula
2418 ;; when appropriate. It might return a separator line, but no problem.
2421 named eq)
2429 "List of commands triggering the recalculation of a line.
2441 ;;;###autoload
2443 "Rotate the recalculation mark in the first column.
2444 If in any row, the first field is not consistent with a mark,
2445 insert a new column for the markers.
2446 When there is an active region, change all the lines in the region,
2447 after prompting for the marking character.
2448 After each change, a message will be displayed indicating the meaning
2449 of the new mark."
2465 newchar))
2473 newchar))
2491 ;; Rotate mark in first row.
2493 ;; Rotate marks in additional rows if a region is active.
2501 ;; Only align if rotation actually changed lines' length.
2511 ;;;###autoload
2513 "Analyze table at point and store results.
2515 This function sets up the following dynamically scoped variables:
2517 `org-table-column-name-regexp',
2518 `org-table-column-names',
2519 `org-table-current-begin-pos',
2520 `org-table-current-line-types',
2521 `org-table-current-ncol',
2522 `org-table-dlines',
2523 `org-table-hlines',
2524 `org-table-local-parameters',
2525 `org-table-named-field-locations'."
2530 ;; Extract column names.
2543 ;; Extract local parameters.
2551 org-table-local-parameters)))))
2552 ;; Update named fields locations. We minimize `count-lines'
2553 ;; processing by storing last known number of lines in LAST.
2575 field))
2578 org-table-named-field-locations))))))))))
2579 ;; Re-use existing markers when possible.
2583 ;; Analyze the line types.
2594 ;; Get the number of columns from the first data line in table.
2602 al al2)
2616 "Move point to a specific field in the current table.
2618 REF is either the name of a field its absolute reference, as
2619 a string. No column is created unless CREATE-COLUMN-P is
2620 non-nil. If it is a function, it is called with the column
2621 number as its argument as is used as a predicate to know if the
2622 column can be created.
2624 This function assumes the table is already analyzed (i.e., using
2625 `org-table-analyze')."
2640 create-column-p)))
2646 ;;;###autoload
2648 "Recompute the current line if marked for it, and if we haven't just done it."
2668 org-tbl-calc-modes)
2670 ;;;###autoload
2672 suppress-align suppress-const
2673 suppress-store suppress-analysis)
2674 "Replace the table field value at the cursor by the result of a calculation.
2676 In a table, this command replaces the value in the current field with the
2678 formula, by storing it in a special line below the table. When called
2680 field formula.
2683 insert the active equation for the field
2684 back into the current field, so that it can be edited there. This is \
2685 useful
2687 check the referenced fields.
2689 When called, the command first prompts for a formula, which is read in
2690 the minibuffer. Previously entered formulas are available through the
2691 history list, and the last used formula is offered as a default.
2692 These stored formulas are adapted correctly when moving, inserting, or
2693 deleting columns with the corresponding commands.
2695 The formula can be any algebraic expression understood by the Calc package.
2696 For details, see the Org mode manual.
2698 This function can also be called from Lisp programs and offers
2699 additional arguments: EQUATION can be the formula to apply. If this
2700 argument is given, the user will not be prompted.
2702 SUPPRESS-ALIGN is used to speed-up recursive calls by by-passing
2703 unnecessary aligns.
2705 SUPPRESS-CONST suppresses the interpretation of constants in the
2706 formula, assuming that this has been done already outside the
2707 function.
2709 SUPPRESS-STORE means the formula should not be stored, either
2710 because it is already stored, or because it is a modified
2711 equation that should not overwrite the stored one.
2713 SUPPRESS-ANALYSIS prevents analyzing the table and checking
2714 location of point."
2730 equation
2736 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2737 duration duration-output-format)
2738 ;; Parse the format string. Since we have a lot of modes, this is
2739 ;; a lot of work. However, I think calc still uses most of the time.
2752 'calc-float-format
2755 n))))
2760 duration-output-format
2789 ;; replace fields with duration values if relevant
2793 fields)))
2799 x))
2800 fields)))
2806 ;; Insert row and column number of formula result field
2817 t t form)))
2819 ;; Check for old vertical references
2821 ;; Insert remote references
2834 rmtrng))
2835 keep-empty numbers lispp))
2836 t t form)))
2837 ;; Insert complex ranges
2847 ;; possibly handle durations
2852 formrg)
2853 keep-empty numbers lispp)))
2858 ;; Insert simple ranges, i.e. included in the current row.
2861 form)
2872 keep-empty numbers lispp))
2873 t t form)))
2875 ;; Insert the references to fields in same row
2882 x keep-empty numbers lispp)))
2899 ;; Use <...> time-stamps so that Calc can handle them.
2902 ;; Internationalize local time-stamps by setting locale to
2903 ;; "C".
2906 org-ts-regexp
2914 form t t))
2917 form
2924 duration-output-format)
2925 ev)))
2930 Orig: %s
2931 $xyz-> %s
2932 @r$c-> %s
2955 ;; Replace any active time stamp in the result with
2956 ;; an inactive one. Dates in tables are likely
2957 ;; piece of regular data, not meant to appear in the
2958 ;; agenda.
2971 prop value)))
2974 "Get a calc vector from a column, according to descriptor DESC.
2976 Optional arguments TBEG and COL can give the beginning of the table and
2977 the current column, to avoid unnecessary parsing.
2979 HIGHLIGHT means just highlight the range.
2981 When CORNERS-ONLY is set, only return the corners of the range as
2982 a list (line1 column1 line2 column2) where line1 and line2 are
2983 line numbers relative to beginning of table, or TBEG, and column1
2984 and column2 are table column numbers."
2987 desc))
2998 thisline)))
3003 thisline)))
3015 ;; Just one field.
3022 ;; A range, return a vector. First sort the numbers to get
3023 ;; a regular rectangle.
3029 ;; Copy the range values into a list.
3044 ;; Return string representation of calc vector.
3050 "Return relative line number corresponding to descriptor DESC.
3051 The cursor is currently in relative line number CLINE."
3056 ;; 1 2 3 4 5 6
3057 desc))
3079 cline)))
3082 "Return relative line of Nth row with type TYPE.
3083 Search starts from relative line I. When BACKWARDS in non-nil,
3084 look before I. When RELATIVE is non-nil, the reference is
3085 relative. DESC is the original descriptor that started the
3086 search, as a string."
3094 ;; We are going to cross a hline. Check if this is
3095 ;; an authorized move.
3106 ;; The last hline doesn't exist. Instead, point to last row
3107 ;; in table.
3116 "Convert list ELEMENTS to something appropriate to insert into formula.
3117 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
3118 NUMBERS indicates that everything should be converted to numbers.
3119 LISPP non-nil means to return something appropriate for a Lisp
3120 list, `literal' is for the format specifier L."
3121 ;; Calc nan (not a number) is used for the conversion of the empty
3122 ;; field to a reference for several reasons: (i) It is accepted in a
3123 ;; Calc formula (e. g. "" or "()" would result in a Calc error).
3124 ;; (ii) In a single field (not in range) it can be distinguished
3125 ;; from "(nan)" which is the reference made from a single field
3126 ;; containing "nan".
3128 ;; field reference
3131 elements
3133 ""
3142 ;; range reference
3147 elements))))
3153 x
3161 x)
3163 elements
3167 "If there has been more than one second since T1, display message.
3168 ARGS are passed as arguments to the `message' function. Returns
3169 current time if a message is printed, otherwise returns T1. If
3170 T1 is nil, always messages."
3174 curtime)
3175 t1)))
3177 ;;;###autoload
3179 "Recalculate the current table line by applying all stored formulas.
3181 With prefix arg ALL, do this for all lines in the table.
3184 if ALL is the symbol `iterate',
3185 recompute the table until it no longer changes.
3187 If NOALIGN is not nil, do not re-align the table after the computations
3188 are done. This is typically used internally to save time, if it is
3189 known that the table will be realigned a little later anyway."
3204 beg end eqlcol eqlfield)
3205 ;; Insert constants in all formulas.
3208 ;; Expand equations, then split the equation list between
3209 ;; column formulas and field formulas.
3221 old-lhs)))
3224 existing formula for column %s"
3225 old-lhs
3226 new))
3227 new))
3233 ;; Expand ranges in lhs of formulas
3235 ;; Get the correct line range to process.
3242 ;; This is a table with marked lines, compute selected
3243 ;; lines.
3245 ;; Move forward to the first non-header line.
3250 ;; Just leave BEG at the start of the table.
3255 ;; Mark named fields untouchable. Also check if several
3256 ;; field/range formulas try to set the same field.
3260 seen-fields)
3271 ;; Turn field coordinates associated to NAME
3272 ;; into an absolute reference.
3276 name)))
3279 reference))
3284 ;; Evaluate the column formulas, but skip fields covered by
3285 ;; field formulas.
3289 ;; Unprotected line, recalculate.
3294 log-last-time
3307 ;; Evaluate the field formulas.
3316 reference
3317 ;; Possibly create a new column, as long as
3318 ;; `org-table-formula-create-columns' allows it.
3330 t))
3337 ;; Clean up markers and internal text property.
3348 ;;;###autoload
3350 "Recalculate the table until it does not change anymore.
3351 The maximum number of iterations is 10, but you can choose a different value
3352 with the prefix ARG."
3357 thistbl)
3371 ;;;###autoload
3373 "Recalculate all tables in the current buffer."
3378 ;; Reason for separate `org-table-align': When repeating
3379 ;; (org-table-recalculate t) `org-table-may-need-update' gets in
3380 ;; the way.
3383 t)))
3385 ;;;###autoload
3387 "Iterate all tables in the buffer, to converge inter-table dependencies."
3392 c1)
3408 "Apply the #+TBLFM in the line at point to the table."
3415 ;; Insert a temporary formula at right after the table
3420 ;; Recalculate the table.
3425 ;; Delete the formula inserted temporarily.
3431 "Find the beginning of the TBLFM lines and return its position.
3432 Return nil when the beginning of TBLFM line was not found."
3439 "Expand list of formulas.
3440 If some of the RHS in the formulas are ranges or a row reference,
3441 expand them to individual field equations for each field. This
3442 function assumes the table is already analyzed (i.e., using
3443 `org-table-analyze')."
3450 ;; This just refers to one fixed field.
3453 ;; This just refers to one fixed named field.
3456 ;; Column formulas are treated specially and are not
3457 ;; expanded.
3462 rhs)
3463 res)))
3475 rhs)
3476 res))))))))))
3479 "Replace @<, @>, $<, $> with first/last row/column of the table.
3480 So @< and $< will always be replaced with @1 and $1, respectively.
3481 The advantage of these special markers are that structure editing of
3482 the table will not change them, while @1 and $1 will be modified
3483 when a line/row is swapped out of that privileged position. So for
3484 formulas that use a range of rows or columns, it may often be better
3486 borders of the table using the @< @> $< $> makers."
3489 s start)
3494 org-table-current-ncol)
3498 len
3505 s)
3508 "Replace $const with values in string F."
3513 org-table-column-name-regexp
3516 org-table-column-names))))
3517 f t t)))
3518 ;; Parameters and constants.
3522 new start))
3525 ;; When a duration is expected, convert value on the fly.
3531 v)))))
3538 "Find the value for a parameter or constant in a formula.
3539 Parameters get priority."
3570 map))
3577 "--"
3580 "--"
3581 "Shift Reference at Point"
3586 "-"
3587 "Change Test Row for Column Formulas"
3590 "--"
3595 org-table-overlay-coordinates)]
3596 "--"
3604 ;;;###autoload
3606 "Edit the formulas of the current table in a separate buffer."
3612 ;; Move point within the table before analyzing it.
3628 ;; Keep global-font-lock-mode from turning on font-lock-mode
3673 "Convert a formula from internal to user representation."
3676 s))
3679 "Convert a formula from user to internal representation."
3682 s))
3685 "Convert spreadsheet references from A7 to @7$28.
3686 Works for single references, but also for entire formulas and even the
3687 full TBLFM line."
3689 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3692 ;; format match, just advance
3697 ;; 3.e5 or something like this.
3700 ;; (member (match-string 1 s)
3701 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3702 )
3703 ;; function name, just advance
3713 t t s)))))
3714 s))
3717 "Convert spreadsheet references from to @7$28 to AB7.
3718 Works for single references, but also for entire formulas and even the
3719 full TBLFM line."
3726 t t s)))
3731 t nil s)))
3732 s)
3735 "Convert a base 26 number represented by letters into an integer.
3736 For example: AB -> 28."
3742 n))
3745 "Convert an integer into a base 26 number represented by letters.
3746 For example: 28 -> AB."
3751 s))
3754 "Convert a time string into numerical duration in seconds.
3755 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3756 If S is a string representing a number, keep this number."
3758 s
3781 "Convert a number of seconds to a time string.
3782 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3783 minutes or seconds."
3795 ;; Ignore seconds
3799 secs0)
3804 secs0)))))
3808 "Convert all references in this buffer, using FUNCTION."
3819 "Convert all references in the buffer from B3 to @3$2 and back."
3829 "Shift the reference at point one row/hline up."
3833 "Shift the reference at point one row/hline down."
3837 "Shift the reference at point one field to the left."
3841 "Shift the reference at point one field to the right."
3852 ;; A B3-like reference
3858 ;; An internal reference
3864 "Re-match the group N, and replace it with the shifted reference."
3869 t t)))
3872 "Shift a reference part REF.
3873 If DECR is set, decrease the references row/column, else increase.
3874 If HLINE is set, this may be a hline reference, it certainly is not
3875 a translation reference."
3904 "Toggle the display of coordinates in the referenced table."
3913 "Parse the buffer for formula definitions and install them.
3914 With prefix ARG, apply the new formulas to the table."
3923 eql)
3926 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3927 nil t)
3948 "Abort editing formulas, without installing the changes."
3959 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
4000 "Show the location/value of the $ expression at point.
4001 When LOCAL is non-nil, show references for the table at point."
4011 var name e what match dest)
4015 "$1.."
4067 dest)
4093 ;; Column number.
4119 org-table-fedit-scroll-down))))
4131 "Make sure the cursor is in a dataline in a table."
4140 p1 p2)))
4145 "Move cursor one line up in the window showing the table."
4150 "Move cursor one line down in the window showing the table."
4155 "Move the cursor in the window showing the table.
4156 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
4181 "Add a new overlay."
4187 "Highlight rectangular region in a table.
4188 When buffer positions BEG and END are provided, use them to
4189 delimit the region to highlight. Otherwise, refer to point. Use
4190 FACE, when non-nil, for the highlight."
4222 "Remove the rectangle overlays."
4232 "Add overlays to the table at point, to show row/column coordinates."
4260 ;;;###autoload
4262 "Toggle the display of Row/Column numbers in tables."
4273 ;;;###autoload
4275 "Toggle the formula debugger in tables."
4281 ;;; The orgtbl minor mode
4283 ;; Define a minor mode which can be used in other modes in order to
4284 ;; integrate the Org table editor.
4286 ;; This is really a hack, because the Org table editor uses several
4287 ;; keys which normally belong to the major mode, for example the TAB
4288 ;; and RET keys. Here is how it works: The minor mode defines all the
4289 ;; keys necessary to operate the table editor, but wraps the commands
4290 ;; into a function which tests if the cursor is currently inside
4291 ;; a table. If that is the case, the table editor command is
4292 ;; executed. However, when any of those keys is used outside a table,
4293 ;; the function uses `key-binding' to look up if the key has an
4294 ;; associated command in another currently active keymap (minor modes,
4295 ;; major mode, global), and executes that command. There might be
4296 ;; problems if any of the keys used by the table editor is otherwise
4297 ;; used as a prefix key.
4299 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
4300 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
4301 ;; addresses this by checking explicitly for both bindings.
4303 ;; The optimized version (see variable `orgtbl-optimized') takes over
4304 ;; all keys which are bound to `self-insert-command' in the *global map*.
4305 ;; Some modes bind other commands to simple characters, for example
4306 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
4307 ;; active, this binding is ignored inside tables and replaced with a
4308 ;; modified self-insert.
4326 ;; Install it as a minor mode.
4330 ;;;###autoload
4332 "The Org mode table editor as a minor mode for use in other modes."
4337 ;; Exit without error, in case some hook functions calls this by
4338 ;; accident in Org mode.
4342 ;; Make sure we are first in minor-mode-map-alist
4344 ;; FIXME: maybe it should use emulation-mode-map-alists?
4351 auto-fill-inhibit-regexp)
4355 auto-fill-inhibit-regexp)
4356 orgtbl-line-start-regexp))
4374 "Remove all properties related to narrow-column invisibility."
4387 "Create a function for binding in the table minor mode.
4388 FUN is the command to call inside a table. N is used to create a unique
4389 command name. KEYS are keys that should be checked in for a command
4390 to execute outside of tables."
4396 "Outside of tables, run the binding of `"
4408 keys)
4412 "Error when there is no default binding for a table key."
4417 "Setup orgtbl keymaps."
4448 elt key fun cmd)
4456 ;; Special treatment needed for TAB, RET and DEL
4469 (orgtbl-make-binding 'org-delete-backward-char 109
4475 [(tab)] "\C-i"))
4477 (org-defkey orgtbl-mode-map [backtab]
4479 [backtab] [S-iso-lefttab] [(shift tab)]
4480 [(tab)] "\C-i"))
4482 (org-defkey orgtbl-mode-map "\M-\C-m"
4483 (orgtbl-make-binding 'org-table-wrap-region 105
4484 "\M-\C-m" [(meta return)]))
4485 (org-defkey orgtbl-mode-map [(meta return)]
4486 (orgtbl-make-binding 'org-table-wrap-region 106
4487 [(meta return)] "\M-\C-m"))
4489 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4490 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4492 (when orgtbl-optimized
4493 ;; If the user wants maximum table support, we need to hijack
4494 ;; some standard editing functions
4495 (org-remap orgtbl-mode-map
4496 'self-insert-command 'orgtbl-self-insert-command
4497 'delete-char 'org-delete-char
4498 'delete-backward-char 'org-delete-backward-char)
4499 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4500 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4501 '("OrgTbl"
4502 ["Create or convert" org-table-create-or-convert-from-region
4503 :active (not (org-at-table-p)) :keys "C-c |" ]
4504 "--"
4505 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4506 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4507 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4508 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4509 "--"
4510 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4511 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4512 ["Copy Field from Above"
4513 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4514 "--"
4515 ("Column"
4516 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4517 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4518 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4519 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4520 ("Row"
4521 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4522 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4523 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4524 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4525 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4526 "--"
4527 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4528 ("Rectangle"
4529 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4530 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4531 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4532 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4533 "--"
4534 ("Radio tables"
4535 ["Insert table template" orgtbl-insert-radio-table
4536 (cl-assoc-if #'derived-mode-p orgtbl-radio-table-templates)]
4537 ["Comment/uncomment table" orgtbl-toggle-comment t])
4538 "--"
4539 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4540 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4541 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4542 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4543 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4544 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4545 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4546 ["Sum Column/Rectangle" org-table-sum
4547 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4548 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4549 ["Debug Formulas"
4550 org-table-toggle-formula-debugger :active (org-at-table-p)
4551 :keys "C-c {"
4552 :style toggle :selected org-table-formula-debug]
4553 ["Show Col/Row Numbers"
4554 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4555 :keys "C-c }"
4556 :style toggle :selected org-table-overlay-coordinates]
4557 "--"
4558 ("Plot"
4561 t))
4563 (defun orgtbl-ctrl-c-ctrl-c (arg)
4564 "If the cursor is inside a table, realign the table.
4565 If it is a table to be sent away to a receiver, do it.
4566 With prefix arg, also recompute table."
4567 (interactive "P")
4568 (let ((case-fold-search t) (pos (point)) action)
4569 (save-excursion
4570 (beginning-of-line 1)
4571 (setq action (cond
4575 (cond
4576 ((integerp action)
4577 (goto-char action)
4578 (org-table-maybe-eval-formula)
4579 (if arg
4580 (call-interactively 'org-table-recalculate)
4581 (org-table-maybe-recalculate-line))
4582 (call-interactively 'org-table-align)
4583 (when (orgtbl-send-table 'maybe)
4584 (run-hooks 'orgtbl-after-send-table-hook)))
4585 ((eq action 'recalc)
4586 (save-excursion
4587 (beginning-of-line 1)
4589 (if (org-at-table-p)
4590 (org-call-with-arg 'org-table-recalculate t))))
4591 (t (let (orgtbl-mode)
4592 (call-interactively (key-binding "\C-c\C-c")))))))
4594 (defun orgtbl-create-or-convert-from-region (_arg)
4595 "Create table or convert region to table, if no conflicting binding.
4596 This installs the table binding `C-c |', but only if there is no
4597 conflicting binding to this key outside orgtbl-mode."
4598 (interactive "P")
4599 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4600 (if cmd
4601 (call-interactively cmd)
4602 (call-interactively 'org-table-create-or-convert-from-region))))
4604 (defun orgtbl-tab (arg)
4605 "Justification and field motion for `orgtbl-mode'."
4606 (interactive "P")
4607 (if arg (org-table-edit-field t)
4608 (org-table-justify-field-maybe)
4609 (org-table-next-field)))
4611 (defun orgtbl-ret ()
4612 "Justification and field motion for `orgtbl-mode'."
4613 (interactive)
4614 (if (bobp)
4615 (newline)
4616 (org-table-justify-field-maybe)
4617 (org-table-next-row)))
4619 (defun orgtbl-self-insert-command (N)
4620 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4621 If the cursor is in a table looking at whitespace, the whitespace is
4622 overwritten, and the table is not marked as requiring realignment."
4623 (interactive "p")
4624 (if (and (org-at-table-p)
4625 (or
4626 (and org-table-auto-blank-field
4627 (member last-command
4628 '(orgtbl-hijacker-command-100
4629 orgtbl-hijacker-command-101
4630 orgtbl-hijacker-command-102
4631 orgtbl-hijacker-command-103
4632 orgtbl-hijacker-command-104
4633 orgtbl-hijacker-command-105
4634 yas/expand))
4635 (org-table-blank-field))
4636 t)
4637 (eq N 1)
4639 (let (org-table-may-need-update)
4640 (delete-region (match-beginning 1) (match-end 1))
4641 (self-insert-command N))
4642 (setq org-table-may-need-update t)
4643 (let* (orgtbl-mode
4644 a
4645 (cmd (or (key-binding
4646 (or (and (listp function-key-map)
4647 (setq a (assoc last-input-event function-key-map))
4648 (cdr a))
4649 (vector last-input-event)))
4650 'self-insert-command)))
4651 (call-interactively cmd)
4652 (if (and org-self-insert-cluster-for-undo
4653 (eq cmd 'self-insert-command))
4654 (if (not (eq last-command 'orgtbl-self-insert-command))
4655 (setq org-self-insert-command-undo-counter 1)
4656 (if (>= org-self-insert-command-undo-counter 20)
4657 (setq org-self-insert-command-undo-counter 1)
4658 (and (> org-self-insert-command-undo-counter 0)
4659 buffer-undo-list
4660 (not (cadr buffer-undo-list)) ; remove nil entry
4661 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4662 (setq org-self-insert-command-undo-counter
4663 (1+ org-self-insert-command-undo-counter))))))))
4665 ;;;###autoload
4667 "Regular expression matching exponentials as produced by calc.")
4669 (defun orgtbl-gather-send-defs ()
4670 "Gather a plist of :name, :transform, :params for each destination before
4671 a radio table."
4672 (save-excursion
4673 (goto-char (org-table-begin))
4674 (let (rtn)
4675 (beginning-of-line 0)
4676 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4677 (let ((name (org-no-properties (match-string 1)))
4678 (transform (intern (match-string 2)))
4679 (params (if (match-end 3)
4680 (read (concat "(" (match-string 3) ")")))))
4681 (push (list :name name :transform transform :params params)
4682 rtn)
4683 (beginning-of-line 0)))
4684 rtn)))
4686 (defun orgtbl-send-replace-tbl (name text)
4687 "Find and replace table NAME with TEXT."
4688 (save-excursion
4689 (goto-char (point-min))
4690 (let* ((location-flag nil)
4691 (name (regexp-quote name))
4694 (while (re-search-forward begin-re nil t)
4695 (unless location-flag (setq location-flag t))
4696 (let ((beg (line-beginning-position 2)))
4697 (unless (re-search-forward end-re nil t)
4698 (user-error "Cannot find end of receiver location at %d" beg))
4699 (beginning-of-line)
4700 (delete-region beg (point))
4702 (unless location-flag
4703 (user-error "No valid receiver location found in the buffer")))))
4705 ;;;###autoload
4706 (defun org-table-to-lisp (&optional txt)
4707 "Convert the table at point to a Lisp structure.
4708 The structure will be a list. Each item is either the symbol `hline'
4709 for a horizontal separator line, or a list of field values as strings.
4710 The table is taken from the parameter TXT, or from the buffer at point."
4711 (unless (or txt (org-at-table-p)) (user-error "No table at point"))
4712 (let ((txt (or txt
4713 (buffer-substring-no-properties (org-table-begin)
4714 (org-table-end)))))
4715 (mapcar (lambda (x)
4716 (if (string-match org-table-hline-regexp x) 'hline
4720 (defun orgtbl-send-table (&optional maybe)
4721 "Send a transformed version of table at point to the receiver position.
4722 With argument MAYBE, fail quietly if no transformation is defined
4723 for this table."
4724 (interactive)
4725 (catch 'exit
4726 (unless (org-at-table-p) (user-error "Not at a table"))
4727 ;; when non-interactive, we assume align has just happened.
4728 (when (called-interactively-p 'any) (org-table-align))
4729 (let ((dests (orgtbl-gather-send-defs))
4730 (table (org-table-to-lisp
4731 (buffer-substring-no-properties (org-table-begin)
4732 (org-table-end))))
4733 (ntbl 0))
4734 (unless dests
4735 (if maybe (throw 'exit nil)
4736 (user-error "Don't know how to transform this table")))
4737 (dolist (dest dests)
4738 (let ((name (plist-get dest :name))
4739 (transform (plist-get dest :transform))
4740 (params (plist-get dest :params)))
4741 (unless (fboundp transform)
4742 (user-error "No such transformation function %s" transform))
4743 (orgtbl-send-replace-tbl name (funcall transform table params)))
4744 (cl-incf ntbl))
4745 (message "Table converted and installed at %d receiver location%s"
4746 ntbl (if (> ntbl 1) "s" ""))
4747 (and (> ntbl 0) ntbl))))
4749 (defun org-remove-by-index (list indices &optional i0)
4750 "Remove the elements in LIST with indices in INDICES.
4751 First element has index 0, or I0 if given."
4752 (if (not indices)
4753 list
4754 (if (integerp indices) (setq indices (list indices)))
4755 (setq i0 (1- (or i0 0)))
4756 (delq :rm (mapcar (lambda (x)
4757 (setq i0 (1+ i0))
4758 (if (memq i0 indices) :rm x))
4759 list))))
4761 (defun orgtbl-toggle-comment ()
4762 "Comment or uncomment the orgtbl at point."
4763 (interactive)
4764 (let* ((case-fold-search t)
4765 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4766 (re2 (concat "^" orgtbl-line-start-regexp))
4767 (commented (save-excursion (beginning-of-line 1)
4768 (cond ((looking-at re1) t)
4769 ((looking-at re2) nil)
4770 (t (user-error "Not at an org table")))))
4771 (re (if commented re1 re2))
4772 beg end)
4773 (save-excursion
4774 (beginning-of-line 1)
4775 (while (looking-at re) (beginning-of-line 0))
4776 (beginning-of-line 2)
4777 (setq beg (point))
4778 (while (looking-at re) (beginning-of-line 2))
4779 (setq end (point)))
4780 (comment-region beg end (if commented '(4) nil))))
4782 (defun orgtbl-insert-radio-table ()
4783 "Insert a radio table template appropriate for this major mode."
4784 (interactive)
4785 (let* ((e (cl-assoc-if #'derived-mode-p orgtbl-radio-table-templates))
4786 (txt (nth 1 e))
4787 name pos)
4788 (unless e (user-error "No radio table setup defined for %s" major-mode))
4789 (setq name (read-string "Table name: "))
4790 (while (string-match "%n" txt)
4791 (setq txt (replace-match name t t txt)))
4793 (setq pos (point))
4794 (insert txt)
4795 (goto-char pos)))
4797 ;;;###autoload
4798 (defun orgtbl-to-generic (table params)
4799 "Convert the orgtbl-mode TABLE to some other format.
4801 This generic routine can be used for many standard cases.
4803 TABLE is a list, each entry either the symbol `hline' for
4804 a horizontal separator line, or a list of fields for that
4805 line. PARAMS is a property list of parameters that can
4806 influence the conversion.
4808 Valid parameters are:
4810 :backend, :raw
4812 Export back-end used as a basis to transcode elements of the
4813 table, when no specific parameter applies to it. It is also
4814 used to translate cells contents. You can prevent this by
4815 setting :raw property to a non-nil value.
4817 :splice
4819 When non-nil, only convert rows, not the table itself. This is
4820 equivalent to setting to the empty string both :tstart
4821 and :tend, which see.
4823 :skip
4825 When set to an integer N, skip the first N lines of the table.
4826 Horizontal separation lines do count for this parameter!
4828 :skipcols
4830 List of columns that should be skipped. If the table has
4831 a column with calculation marks, that column is automatically
4832 discarded beforehand.
4834 :hline
4836 String to be inserted on horizontal separation lines. May be
4837 nil to ignore these lines altogether.
4839 :sep
4841 Separator between two fields, as a string.
4843 Each in the following group may be either a string or a function
4844 of no arguments returning a string:
4846 :tstart, :tend
4848 Strings to start and end the table. Ignored when :splice is t.
4850 :lstart, :lend
4852 Strings to start and end a new table line.
4854 :llstart, :llend
4856 Strings to start and end the last table line. Default,
4857 respectively, to :lstart and :lend.
4859 Each in the following group may be a string or a function of one
4860 argument (either the cells in the current row, as a list of
4861 strings, or the current cell) returning a string:
4863 :lfmt
4865 Format string for an entire row, with enough %s to capture all
4866 fields. When non-nil, :lstart, :lend, and :sep are ignored.
4868 :llfmt
4870 Format for the entire last line, defaults to :lfmt.
4872 :fmt
4874 A format to be used to wrap the field, should contain %s for
4875 the original field value. For example, to wrap everything in
4877 a property list with column numbers and format strings, or
4878 functions, e.g.,
4882 :hlstart :hllstart :hlend :hllend :hsep :hlfmt :hllfmt :hfmt
4884 Same as above, specific for the header lines in the table.
4885 All lines before the first hline are treated as header. If
4886 any of these is not present, the data line value is used.
4888 This may be either a string or a function of two arguments:
4890 :efmt
4892 Use this format to print numbers with exponential. The format
4893 should have %s twice for inserting mantissa and exponent, for
4895 list with column numbers and format strings or functions.
4896 :fmt will still be applied after :efmt."
4897 ;; Make sure `org-export-create-backend' is available.
4898 (require 'ox)
4899 (let* ((backend (plist-get params :backend))
4900 (custom-backend
4901 ;; Build a custom back-end according to PARAMS. Before
4902 ;; defining a translator, check if there is anything to do.
4903 ;; When there isn't, let BACKEND handle the element.
4904 (org-export-create-backend
4905 :parent (or backend 'org)
4906 :transcoders
4907 `((table . ,(org-table--to-generic-table params))
4908 (table-row . ,(org-table--to-generic-row params))
4909 (table-cell . ,(org-table--to-generic-cell params))
4910 ;; Macros are not going to be expanded. However, no
4911 ;; regular back-end has a transcoder for them. We
4912 ;; provide one so they are not ignored, but displayed
4913 ;; as-is instead.
4914 (macro . (lambda (m c i) (org-element-macro-interpreter m nil))))))
4915 data info)
4916 ;; Store TABLE as Org syntax in DATA. Tolerate non-string cells.
4917 ;; Initialize communication channel in INFO.
4918 (with-temp-buffer
4919 (let ((org-inhibit-startup t)) (org-mode))
4920 (let ((standard-output (current-buffer))
4921 (org-element-use-cache nil))
4922 (dolist (e table)
4924 ((consp e)
4925 (princ "| ") (dolist (c e) (princ c) (princ " |"))
4927 ;; Add back-end specific filters, but not user-defined ones. In
4928 ;; particular, make sure to call parse-tree filters on the
4929 ;; table.
4930 (setq info
4931 (let ((org-export-filters-alist nil))
4932 (org-export-install-filters
4933 (org-combine-plists
4934 (org-export-get-environment backend nil params)
4935 `(:back-end ,(org-export-get-backend backend))))))
4936 (setq data
4937 (org-export-filter-apply-functions
4938 (plist-get info :filter-parse-tree)
4939 (org-element-map (org-element-parse-buffer) 'table
4940 #'identity nil t)
4941 info)))
4942 (when (and backend (symbolp backend) (not (org-export-get-backend backend)))
4943 (user-error "Unknown :backend value"))
4944 (when (or (not backend) (plist-get info :raw)) (require 'ox-org))
4945 ;; Handle :skip parameter.
4946 (let ((skip (plist-get info :skip)))
4947 (when skip
4948 (unless (wholenump skip) (user-error "Wrong :skip value"))
4949 (let ((n 0))
4950 (org-element-map data 'table-row
4951 (lambda (row)
4952 (if (>= n skip) t
4953 (org-element-extract-element row)
4954 (cl-incf n)
4955 nil))
4956 nil t))))
4957 ;; Handle :skipcols parameter.
4958 (let ((skipcols (plist-get info :skipcols)))
4959 (when skipcols
4960 (unless (consp skipcols) (user-error "Wrong :skipcols value"))
4961 (org-element-map data 'table
4962 (lambda (table)
4963 (let ((specialp (org-export-table-has-special-column-p table)))
4964 (dolist (row (org-element-contents table))
4965 (when (eq (org-element-property :type row) 'standard)
4966 (let ((c 1))
4967 (dolist (cell (nthcdr (if specialp 1 0)
4968 (org-element-contents row)))
4969 (when (memq c skipcols)
4970 (org-element-extract-element cell))
4971 (cl-incf c))))))))))
4972 ;; Since we are going to export using a low-level mechanism,
4973 ;; ignore special column and special rows manually.
4974 (let ((special? (org-export-table-has-special-column-p data))
4975 ignore)
4976 (org-element-map data (if special? '(table-cell table-row) 'table-row)
4977 (lambda (datum)
4978 (when (if (eq (org-element-type datum) 'table-row)
4979 (org-export-table-row-is-special-p datum nil)
4980 (org-export-first-sibling-p datum nil))
4981 (push datum ignore))))
4982 (setq info (plist-put info :ignore-list ignore)))
4983 ;; We use a low-level mechanism to export DATA so as to skip all
4984 ;; usual pre-processing and post-processing, i.e., hooks, Babel
4985 ;; code evaluation, include keywords and macro expansion. Only
4986 ;; back-end specific filters are retained.
4987 (let ((output (org-export-data-with-backend data custom-backend info)))
4988 ;; Remove final newline.
4989 (if (org-string-nw-p output) (substring-no-properties output 0 -1) ""))))
4991 (defun org-table--generic-apply (value name &optional with-cons &rest args)
4992 (cond ((null value) nil)
4993 ((functionp value) `(funcall ',value ,@args))
4994 ((stringp value)
4995 (cond ((consp (car args)) `(apply #'format ,value ,@args))
4996 (args `(format ,value ,@args))
4997 (t value)))
4998 ((and with-cons (consp value))
4999 `(let ((val (cadr (memq column ',value))))
5000 (cond ((null val) contents)
5001 ((stringp val) (format val ,@args))
5002 ((functionp val) (funcall val ,@args))
5003 (t (user-error "Wrong %s value" ,name)))))
5004 (t (user-error "Wrong %s value" name))))
5006 (defun org-table--to-generic-table (params)
5007 "Return custom table transcoder according to PARAMS.
5008 PARAMS is a plist. See `orgtbl-to-generic' for more
5009 information."
5010 (let ((backend (plist-get params :backend))
5011 (splice (plist-get params :splice))
5012 (tstart (plist-get params :tstart))
5013 (tend (plist-get params :tend)))
5014 `(lambda (table contents info)
5015 (concat
5016 ,(and tstart (not splice)
5018 ,(if (or (not backend) tstart tend splice) 'contents
5019 `(org-export-with-backend ',backend table contents info))
5020 ,(org-table--generic-apply (and (not splice) tend) ":tend")))))
5022 (defun org-table--to-generic-row (params)
5023 "Return custom table row transcoder according to PARAMS.
5024 PARAMS is a plist. See `orgtbl-to-generic' for more
5025 information."
5026 (let* ((backend (plist-get params :backend))
5027 (lstart (plist-get params :lstart))
5028 (llstart (plist-get params :llstart))
5029 (hlstart (plist-get params :hlstart))
5030 (hllstart (plist-get params :hllstart))
5031 (lend (plist-get params :lend))
5032 (llend (plist-get params :llend))
5033 (hlend (plist-get params :hlend))
5034 (hllend (plist-get params :hllend))
5035 (lfmt (plist-get params :lfmt))
5036 (llfmt (plist-get params :llfmt))
5037 (hlfmt (plist-get params :hlfmt))
5038 (hllfmt (plist-get params :hllfmt)))
5039 `(lambda (row contents info)
5040 (if (eq (org-element-property :type row) 'rule)
5041 ,(cond
5042 ((plist-member params :hline)
5043 (org-table--generic-apply (plist-get params :hline) ":hline"))
5044 (backend `(org-export-with-backend ',backend row nil info)))
5045 (let ((headerp ,(and (or hlfmt hlstart hlend)
5046 '(org-export-table-row-in-header-p row info)))
5047 (last-header-p
5048 ,(and (or hllfmt hllstart hllend)
5049 '(org-export-table-row-ends-header-p row info)))
5050 (lastp (not (org-export-get-next-element row info))))
5051 (when contents
5052 ;; Check if we can apply `:lfmt', `:llfmt', `:hlfmt', or
5053 ;; `:hllfmt' to CONTENTS. Otherwise, fallback on
5054 ;; `:lstart', `:lend' and their relatives.
5055 ,(let ((cells
5056 '(org-element-map row 'table-cell
5057 (lambda (cell)
5058 ;; Export all cells, without separators.
5059 ;;
5060 ;; Use `org-export-data-with-backend'
5061 ;; instead of `org-export-data' to eschew
5062 ;; cached values, which
5063 ;; ignore :orgtbl-ignore-sep parameter.
5064 (org-export-data-with-backend
5065 cell
5066 (plist-get info :back-end)
5067 (org-combine-plists info '(:orgtbl-ignore-sep t))))
5068 info)))
5069 `(cond
5070 ,(and hllfmt
5071 `(last-header-p ,(org-table--generic-apply
5072 hllfmt ":hllfmt" nil cells)))
5073 ,(and hlfmt
5074 `(headerp ,(org-table--generic-apply
5075 hlfmt ":hlfmt" nil cells)))
5076 ,(and llfmt
5077 `(lastp ,(org-table--generic-apply
5078 llfmt ":llfmt" nil cells)))
5079 (t
5080 ,(if lfmt (org-table--generic-apply lfmt ":lfmt" nil cells)
5081 `(concat
5082 (cond
5083 ,(and
5084 (or hllstart hllend)
5085 `(last-header-p
5086 (concat
5087 ,(org-table--generic-apply hllstart ":hllstart")
5088 contents
5089 ,(org-table--generic-apply hllend ":hllend"))))
5090 ,(and
5091 (or hlstart hlend)
5092 `(headerp
5093 (concat
5094 ,(org-table--generic-apply hlstart ":hlstart")
5095 contents
5096 ,(org-table--generic-apply hlend ":hlend"))))
5097 ,(and
5098 (or llstart llend)
5099 `(lastp
5100 (concat
5101 ,(org-table--generic-apply llstart ":llstart")
5102 contents
5103 ,(org-table--generic-apply llend ":llend"))))
5104 (t
5105 ,(cond
5106 ((or lstart lend)
5107 `(concat
5108 ,(org-table--generic-apply lstart ":lstart")
5109 contents
5110 ,(org-table--generic-apply lend ":lend")))
5111 (backend
5112 `(org-export-with-backend
5113 ',backend row contents info))
5114 (t 'contents)))))))))))))))
5116 (defun org-table--to-generic-cell (params)
5117 "Return custom table cell transcoder according to PARAMS.
5118 PARAMS is a plist. See `orgtbl-to-generic' for more
5119 information."
5120 (let* ((backend (plist-get params :backend))
5121 (efmt (plist-get params :efmt))
5122 (fmt (plist-get params :fmt))
5123 (hfmt (plist-get params :hfmt))
5124 (sep (plist-get params :sep))
5125 (hsep (plist-get params :hsep)))
5126 `(lambda (cell contents info)
5127 ;; Make sure that contents are exported as Org data when :raw
5128 ;; parameter is non-nil.
5129 ,(when (and backend (plist-get params :raw))
5130 `(setq contents
5131 ;; Since we don't know what are the pseudo object
5132 ;; types defined in backend, we cannot pass them to
5133 ;; `org-element-interpret-data'. As a consequence,
5134 ;; they will be treated as pseudo elements, and will
5135 ;; have newlines appended instead of spaces.
5136 ;; Therefore, we must make sure :post-blank value is
5137 ;; really turned into spaces.
5138 (replace-regexp-in-string
5140 (org-trim
5141 (org-element-interpret-data
5142 (org-element-contents cell))))))
5144 (let ((headerp ,(and (or hfmt hsep)
5145 '(org-export-table-row-in-header-p
5146 (org-export-get-parent-element cell) info)))
5147 (column
5148 ;; Call costly `org-export-table-cell-address' only if
5149 ;; absolutely necessary, i.e., if one
5150 ;; of :fmt :efmt :hfmt has a "plist type" value.
5151 ,(and (cl-some (lambda (v) (integerp (car-safe v)))
5152 (list efmt hfmt fmt))
5153 '(1+ (cdr (org-export-table-cell-address cell info))))))
5154 (when contents
5155 ;; Check if we can apply `:efmt' on CONTENTS.
5156 ,(when efmt
5157 `(when (string-match orgtbl-exp-regexp contents)
5158 (let ((mantissa (match-string 1 contents))
5159 (exponent (match-string 2 contents)))
5160 (setq contents ,(org-table--generic-apply
5161 efmt ":efmt" t 'mantissa 'exponent)))))
5162 ;; Check if we can apply FMT (or HFMT) on CONTENTS.
5163 (cond
5164 ,(and hfmt `(headerp (setq contents ,(org-table--generic-apply
5165 hfmt ":hfmt" t 'contents))))
5166 ,(and fmt `(t (setq contents ,(org-table--generic-apply
5167 fmt ":fmt" t 'contents))))))
5168 ;; If a separator is provided, use it instead of BACKEND's.
5169 ;; Separators are ignored when LFMT (or equivalent) is
5170 ;; provided.
5171 ,(cond
5172 ((or hsep sep)
5173 `(if (or ,(and (not sep) '(not headerp))
5174 (plist-get info :orgtbl-ignore-sep)
5175 (not (org-export-get-next-element cell info)))
5176 ,(if (not backend) 'contents
5177 `(org-export-with-backend ',backend cell contents info))
5178 (concat contents
5179 ,(if (and sep hsep) `(if headerp ,hsep ,sep)
5180 (or hsep sep)))))
5181 (backend `(org-export-with-backend ',backend cell contents info))
5182 (t 'contents))))))
5184 ;;;###autoload
5185 (defun orgtbl-to-tsv (table params)
5186 "Convert the orgtbl-mode table to TAB separated material."
5189 ;;;###autoload
5190 (defun orgtbl-to-csv (table params)
5191 "Convert the orgtbl-mode table to CSV material.
5192 This does take care of the proper quoting of fields with comma or quotes."
5193 (orgtbl-to-generic table
5194 (org-combine-plists '(:sep "," :fmt org-quote-csv-field)
5195 params)))
5197 ;;;###autoload
5198 (defun orgtbl-to-latex (table params)
5199 "Convert the orgtbl-mode TABLE to LaTeX.
5201 TABLE is a list, each entry either the symbol `hline' for
5202 a horizontal separator line, or a list of fields for that line.
5203 PARAMS is a property list of parameters that can influence the
5204 conversion. All parameters from `orgtbl-to-generic' are
5205 supported. It is also possible to use the following ones:
5207 :booktabs
5211 :environment
5213 Specify environment to use, as a string. If you use
5215 as a string, to get proper continuation strings."
5216 (require 'ox-latex)
5217 (orgtbl-to-generic
5218 table
5219 (org-combine-plists
5220 ;; Provide sane default values.
5221 (list :backend 'latex
5222 :latex-default-table-mode 'table
5223 :latex-tables-centered nil
5224 :latex-tables-booktabs (plist-get params :booktabs)
5225 :latex-table-scientific-notation nil
5226 :latex-default-table-environment
5227 (or (plist-get params :environment) "tabular"))
5228 params)))
5230 ;;;###autoload
5231 (defun orgtbl-to-html (table params)
5232 "Convert the orgtbl-mode TABLE to HTML.
5234 TABLE is a list, each entry either the symbol `hline' for
5235 a horizontal separator line, or a list of fields for that line.
5236 PARAMS is a property list of parameters that can influence the
5237 conversion. All parameters from `orgtbl-to-generic' are
5238 supported. It is also possible to use the following one:
5240 :attributes
5242 Attributes and values, as a plist, which will be used in
5243 <table> tag."
5244 (require 'ox-html)
5245 (orgtbl-to-generic
5246 table
5247 (org-combine-plists
5248 ;; Provide sane default values.
5249 (list :backend 'html
5250 :html-table-data-tags '("<td%s>" . "</td>")
5251 :html-table-use-header-tags-for-first-column nil
5252 :html-table-align-individual-fields t
5253 :html-table-row-tags '("<tr>" . "</tr>")
5254 :html-table-attributes
5255 (if (plist-member params :attributes)
5256 (plist-get params :attributes)
5257 '(:border "2" :cellspacing "0" :cellpadding "6" :rules "groups"
5258 :frame "hsides")))
5259 params)))
5261 ;;;###autoload
5262 (defun orgtbl-to-texinfo (table params)
5263 "Convert the orgtbl-mode TABLE to Texinfo.
5265 TABLE is a list, each entry either the symbol `hline' for
5266 a horizontal separator line, or a list of fields for that line.
5267 PARAMS is a property list of parameters that can influence the
5268 conversion. All parameters from `orgtbl-to-generic' are
5269 supported. It is also possible to use the following one:
5271 :columns
5273 Column widths, as a string. When providing column fractions,
5275 (require 'ox-texinfo)
5276 (let ((output
5277 (orgtbl-to-generic
5278 table
5279 (org-combine-plists
5280 (list :backend 'texinfo
5281 :texinfo-tables-verbatim nil
5282 :texinfo-table-scientific-notation nil)
5283 params)))
5284 (columns (let ((w (plist-get params :columns)))
5285 (cond ((not w) nil)
5287 (t (concat "@columnfractions " w))))))
5288 (if (not columns) output
5289 (replace-regexp-in-string
5292 ;;;###autoload
5293 (defun orgtbl-to-orgtbl (table params)
5294 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
5296 TABLE is a list, each entry either the symbol `hline' for
5297 a horizontal separator line, or a list of fields for that line.
5298 PARAMS is a property list of parameters that can influence the
5299 conversion. All parameters from `orgtbl-to-generic' are
5300 supported.
5302 Useful when slicing one table into many. The :hline, :sep,
5303 :lstart, and :lend provide orgtbl framing. :tstart and :tend can
5304 be set to provide ORGTBL directives for the generated table."
5305 (require 'ox-org)
5306 (orgtbl-to-generic table (org-combine-plists params (list :backend 'org))))
5308 (defun orgtbl-to-table.el (table params)
5309 "Convert the orgtbl-mode TABLE into a table.el table.
5310 TABLE is a list, each entry either the symbol `hline' for
5311 a horizontal separator line, or a list of fields for that line.
5312 PARAMS is a property list of parameters that can influence the
5313 conversion. All parameters from `orgtbl-to-generic' are
5314 supported."
5315 (with-temp-buffer
5316 (insert (orgtbl-to-orgtbl table params))
5317 (org-table-align)
5318 (replace-regexp-in-string
5319 "-|" "-+"
5320 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
5322 (defun orgtbl-to-unicode (table params)
5323 "Convert the orgtbl-mode TABLE into a table with unicode characters.
5325 TABLE is a list, each entry either the symbol `hline' for
5326 a horizontal separator line, or a list of fields for that line.
5327 PARAMS is a property list of parameters that can influence the
5328 conversion. All parameters from `orgtbl-to-generic' are
5329 supported. It is also possible to use the following ones:
5331 :ascii-art
5334 the table. You can download it here:
5335 http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el.
5337 :narrow
5339 When non-nil, narrow columns width than provided width cookie,
5341 (require 'ox-ascii)
5342 (orgtbl-to-generic
5343 table
5344 (org-combine-plists
5345 (list :backend 'ascii
5346 :ascii-charset 'utf-8
5347 :ascii-table-widen-columns (not (plist-get params :narrow))
5348 :ascii-table-use-ascii-art (plist-get params :ascii-art))
5349 params)))
5351 ;; Put the cursor in a column containing numerical values
5352 ;; of an Org table,
5353 ;; type C-c " a
5354 ;; A new column is added with a bar plot.
5355 ;; When the table is refreshed (C-u C-c *),
5356 ;; the plot is updated to reflect the new values.
5358 (defun orgtbl-ascii-draw (value min max &optional width characters)
5359 "Draw an ascii bar in a table.
5360 VALUE is the value to plot, it determines the width of the bar to draw.
5361 MIN is the value that will be displayed as empty (zero width bar).
5362 MAX is the value that will draw a bar filling all the WIDTH.
5363 WIDTH is the span in characters from MIN to MAX.
5364 CHARACTERS is a string that will compose the bar, with shades of grey
5365 from pure white to pure black. It defaults to a 10 characters string
5366 of regular ascii characters."
5367 (let* ((width (ceiling (or width 12)))
5368 (characters (or characters " .:;c!lhVHW"))
5369 (len (1- (length characters)))
5370 (value (float (if (numberp value)
5371 value (string-to-number value))))
5372 (relative (/ (- value min) (- max min)))
5373 (steps (round (* relative width len))))
5374 (cond ((< steps 0) "too small")
5375 ((> steps (* width len)) "too large")
5376 (t (let* ((int-division (/ steps len))
5377 (remainder (- steps (* int-division len))))
5378 (concat (make-string int-division (elt characters len))
5379 (string (elt characters remainder))))))))
5381 ;;;###autoload
5382 (defun orgtbl-ascii-plot (&optional ask)
5383 "Draw an ASCII bar plot in a column.
5385 With cursor in a column containing numerical values, this function
5386 will draw a plot in a new column.
5388 ASK, if given, is a numeric prefix to override the default 12
5390 prefix,
5391 which will prompt for the width."
5392 (interactive "P")
5393 (let ((col (org-table-current-column))
5394 (min 1e999) ; 1e999 will be converted to infinity
5395 (max -1e999) ; which is the desired result
5396 (table (org-table-to-lisp))
5397 (length
5398 (cond ((consp ask)
5399 (read-number "Length of column " 12))
5400 ((numberp ask) ask)
5401 (t 12))))
5402 ;; Skip any hline a the top of table.
5403 (while (eq (car table) 'hline) (setq table (cdr table)))
5404 ;; Skip table header if any.
5405 (dolist (x (or (cdr (memq 'hline table)) table))
5406 (when (consp x)
5407 (setq x (nth (1- col) x))
5408 (when (string-match
5410 x)
5411 (setq x (string-to-number x))
5412 (when (> min x) (setq min x))
5413 (when (< max x) (setq max x)))))
5414 (org-table-insert-column)
5415 (org-table-move-column-right)
5416 (org-table-store-formulas
5417 (cons
5418 (cons
5419 (concat "$" (number-to-string (1+ col)))
5420 (format "'(%s $%s %s %s %s)"
5421 "orgtbl-ascii-draw" col min max length))
5422 (org-table-get-stored-formulas)))
5423 (org-table-recalculate t)))
5425 ;; Example of extension: unicode characters
5426 ;; Here are two examples of different styles.
5428 ;; Unicode block characters are used to give a smooth effect.
5429 ;; See http://en.wikipedia.org/wiki/Block_Elements
5430 ;; Use one of those drawing functions
5431 ;; - orgtbl-ascii-draw (the default ascii)
5432 ;; - orgtbl-uc-draw-grid (unicode with a grid effect)
5433 ;; - orgtbl-uc-draw-cont (smooth unicode)
5435 ;; This is best viewed with the "DejaVu Sans Mono" font
5436 ;; (use M-x set-frame-font).
5438 (defun orgtbl-uc-draw-grid (value min max &optional width)
5439 "Draw a bar in a table using block unicode characters.
5440 It is a variant of orgtbl-ascii-draw with Unicode block
5441 characters, for a smooth display. Bars appear as grids (to the
5442 extent the font allows)."
5443 ;; http://en.wikipedia.org/wiki/Block_Elements
5444 ;; best viewed with the "DejaVu Sans Mono" font.
5445 (orgtbl-ascii-draw value min max width
5448 (defun orgtbl-uc-draw-cont (value min max &optional width)
5449 "Draw a bar in a table using block unicode characters.
5450 It is a variant of orgtbl-ascii-draw with Unicode block
5451 characters, for a smooth display. Bars are solid (to the extent
5452 the font allows)."
5453 (orgtbl-ascii-draw value min max width
5456 (defun org-table-get-remote-range (name-or-id form)
5457 "Get a field value or a list of values in a range from table at ID.
5459 NAME-OR-ID may be the name of a table in the current file as set
5461 will then be used. Alternatively, it may be an ID referring to
5462 any entry, also in a different file. In this case, the first
5463 table in that entry will be referenced.
5467 The return value is either a single string for a single field, or a
5468 list of the fields in the rectangle."
5469 (save-match-data
5470 (let ((case-fold-search t) (id-loc nil)
5471 ;; Protect a bunch of variables from being overwritten by
5472 ;; the context of the remote table.
5473 org-table-column-names org-table-column-name-regexp
5474 org-table-local-parameters org-table-named-field-locations
5475 org-table-current-line-types
5476 org-table-current-begin-pos org-table-dlines
5477 org-table-current-ncol
5478 org-table-hlines org-table-last-alignment
5479 org-table-last-column-widths org-table-last-alignment
5480 org-table-last-column-widths
5481 buffer loc)
5482 (setq form (org-table-convert-refs-to-rc form))
5483 (org-with-wide-buffer
5484 (goto-char (point-min))
5485 (if (re-search-forward
5488 nil t)
5489 (setq buffer (current-buffer) loc (match-beginning 0))
5490 (setq id-loc (org-id-find name-or-id 'marker))
5491 (unless (and id-loc (markerp id-loc))
5493 (setq buffer (marker-buffer id-loc)
5494 loc (marker-position id-loc))
5495 (move-marker id-loc nil))
5496 (with-current-buffer buffer
5497 (org-with-wide-buffer
5498 (goto-char loc)
5499 (forward-char 1)
5501 (not (match-beginning 1)))
5502 (user-error "Cannot find a table at NAME or ID %s" name-or-id))
5503 (org-table-analyze)
5504 (setq form (org-table-formula-substitute-names
5505 (org-table-formula-handle-first/last-rc form)))
5506 (if (and (string-match org-table-range-regexp form)
5507 (> (length (match-string 0 form)) 1))
5508 (org-table-get-range
5509 (match-string 0 form) org-table-current-begin-pos 1)
5510 form)))))))
5512 (defun org-table-remote-reference-indirection (form)
5513 "Return formula with table remote references substituted by indirection.
5515 This indirection works only with the format @ROW$COLUMN. The
5517 distinguished from a plain table name or ID."
5518 (let ((regexp
5519 ;; Same as in `org-table-eval-formula'.
5521 ;; Allow "$1", "@<", "$-1", "@<<$1" etc.
5524 (replace-regexp-in-string
5525 regexp
5526 (lambda (m)
5527 (save-match-data
5528 (let ((eq (org-table-formula-handle-first/last-rc (match-string 1 m))))
5529 (org-table-get-range
5531 (concat "@0" eq)
5532 eq)))))
5533 form t t 1)))
5535 (defmacro org-define-lookup-function (mode)
5536 (let ((mode-str (symbol-name mode))
5537 (first-p (eq mode 'first))
5538 (all-p (eq mode 'all)))
5539 (let ((plural-str (if all-p "s" "")))
5540 `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
5541 ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
5542 If R-LIST is nil, return matching element%s of S-LIST.
5543 If PREDICATE is not nil, use it instead of `equal' to match VAL.
5544 Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
5545 This function is generated by a call to the macro `org-define-lookup-function'."
5546 mode-str plural-str plural-str plural-str)
5547 (let ,(let ((lvars '((p (or predicate 'equal))
5548 (sl s-list)
5549 (rl (or r-list s-list))
5550 (ret nil))))
5551 (if first-p (cons '(match-p nil) lvars) lvars))
5552 (while ,(if first-p '(and (not match-p) sl) 'sl)
5553 (when (funcall p val (car sl))
5554 ,(when first-p '(setq match-p t))
5555 (let ((rval (car rl)))
5556 (setq ret ,(if all-p '(append ret (list rval)) 'rval))))
5557 (setq sl (cdr sl) rl (cdr rl)))
5558 ret)))))
5560 (org-define-lookup-function first)
5561 (org-define-lookup-function last)
5562 (org-define-lookup-function all)
5564 (provide 'org-table)
5566 ;; Local variables:
5567 ;; generated-autoload-file: "org-loaddefs.el"
5568 ;; End:
5570 ;;; org-table.el ends here