| blob | fa59113e260f746ef0e5ed6465a6a236a2ea2488 |
1 ;;; org-table.el --- The table editor for Org-mode
3 ;; Copyright (C) 2004-2014 Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
8 ;;
9 ;; This file is part of GNU Emacs.
10 ;;
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
24 ;;
25 ;;; Commentary:
27 ;; This file contains the table editor and spreadsheet for Org-mode.
29 ;; Watch out: Here we are talking about two different kind of tables.
30 ;; Most of the code is for the tables created with the Org-mode table editor.
31 ;; Sometimes, we talk about tables created and edited with the table.el
32 ;; Emacs package. We call the former org-type tables, and the latter
33 ;; table.el-type tables.
35 ;;; Code:
54 "Hook for functions attaching to `C-c C-c', if the table is sent.
55 This can be used to add additional functionality after the table is sent
56 to the receiver position, otherwise, if table is not sent, the functions
62 "Non-nil means use the optimized table editor version for `orgtbl-mode'.
63 In the optimized version, the table editor takes over all simple keys that
64 normally just insert a character. In tables, the characters are inserted
65 in a way to minimize disturbing the table structure (i.e. in overwrite mode
66 for empty fields). Outside tables, the correct binding of the keys is
67 restored.
69 The default for this option is t if the optimized version is also used in
70 Org-mode. See the variable `org-enable-table-editor' for details. Changing
71 this variable requires a restart of Emacs to become effective."
77 % END RECEIVE ORGTBL %n
79 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
80 | | |
83 @c END RECEIVE ORGTBL %n
84 @ignore
85 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
86 | | |
89 <!-- END RECEIVE ORGTBL %n -->
90 <!--
91 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
92 | | |
95 #+ END RECEIVE ORGTBL %n
97 #+ORGTBL: SEND %n orgtbl-to-orgtbl :splice nil :skip 0
98 | | |
100 "Templates for radio tables in different major modes.
101 Each template must define lines that will be treated as a comment and that
104 insertion of the template. The transformed table will later be inserted
105 between these lines.
107 The template should also contain a minimal table in a multiline comment.
108 If multiline comments are not possible in the buffer language,
109 you can pack it into a string that will not be used when the code
110 is compiled or executed. Above the table will you need a line with
112 convert the table into a data structure useful in the
113 language of the buffer. Check the manual for the section on
115 http://orgmode.org/manual/Tables-in-arbitrary-syntax.html#Tables-in-arbitrary-syntax
117 All occurrences of %n in a template will be replaced with the name of the
118 table, obtained by prompting the user."
125 "Settings for tables in Org-mode."
130 "The default size for newly created tables, Columns x Rows."
135 "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%:]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$"
136 "Regular expression for recognizing numbers in table columns.
137 If a table column contains mostly numbers, it will be aligned to the
138 right. If not, it will be aligned to the left.
140 The default value of this option is a regular expression which allows
141 anything which looks remotely like a number as used in scientific
142 context. For example, all of the following will be considered a
143 number:
144 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
146 Other options offered by the customize interface are more restrictive."
160 "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
161 (const :tag "Very General Number-Like, including hex and Calc radix, allows comma as decimal mark"
162 "^\\([<>]?[-+^.,0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
166 "Fraction of numbers in a column required to make the column align right.
167 In a column all non-white fields are considered. If at least
168 this fraction of fields is matched by `org-table-number-regexp',
169 alignment to the right border applies."
174 "Behavior of tables during editing in Org-mode."
179 "Non-nil means automatically re-align table when pressing TAB or RETURN.
181 removal/insertion."
186 "Non-nil means automatically blank table field when starting to type into it.
187 This only happens when typing immediately after a field motion
188 command (TAB, S-TAB or RET).
189 Only relevant when `org-enable-table-editor' is equal to `optimized'."
194 "Non-nil means automatically exit the follow mode.
195 When nil, the follow mode will stay on and be active in any table
196 the cursor enters. Since the table follow filed mode messes with the
197 window configuration, it is not recommended to set this variable to nil,
198 except maybe locally in a special file that has mostly tables with long
199 fields."
205 "Whether the user should confirm when Org fixes formulas."
213 'safe-local-variable
217 "Non-nil means tab in the last column of a table with jump over a hline.
218 If a horizontal separator line is following the current line,
219 `org-table-next-field' can either create a new row before that line, or jump
220 over the line. When this option is nil, a new line will be created before
221 this line."
226 "Options concerning tables in Org-mode."
231 "Should org-mode work with table references like B3 instead of @3$2?
232 Possible values are:
233 nil never use them
234 from accept as input, do not present for editing
235 t accept as input and present for editing"
255 calc-angle-mode deg
256 calc-prefer-frac nil
257 calc-symbolic-mode nil
259 calc-display-working-message t
260 )
261 "List with Calc mode settings for use in `calc-eval' for table formulas.
262 The list must contain alternating symbols (Calc modes variables and values).
263 Don't remove any of the default settings, just change the values. Org-mode
264 relies on the variables to be present in the list."
269 "Format for the output of calc computations like $1+$2;t.
270 The default value is 'hours, and will output the results as a
271 number of hours. Other allowed values are 'seconds, 'minutes and
272 'days, and the output will be a fraction of seconds, minutes or
273 days."
282 "Format for fields which contain the result of a formula.
284 characters. Beware that modifying the display can prevent the
285 field from being used in another formula."
291 "Non-nil means TAB and RET evaluate a formula in current table field.
292 If the current field starts with an equal sign, it is assumed to be a formula
293 which should be evaluated as described in the manual and in the documentation
294 string of the command `org-table-eval-formula'. This feature requires the
295 Emacs calc package.
296 When this variable is nil, formula calculation is only available through
302 "Non-nil means interpret constants in formulas in tables.
303 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
304 by the value given in `org-table-formula-constants', or by a value obtained
305 from the `constants.el' package."
310 "Alist with constant names and values, for use in table formulas.
311 The car of each element is a name of a constant, without the `$' before it.
312 The cdr is the value as a string. For example, if you'd like to use the
313 speed of light in a formula, you would configure
317 and then use it in an equation like `$1*$c'.
319 Constants can also be defined on a per-file basis using a line like
321 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
328 "Non-nil means lines marked with |#| or |*| will be recomputed automatically.
329 Automatically means when TAB or RET or C-c C-c are pressed in the line."
334 "OBSOLETE VARIABLE, please see `org-table-relative-ref-may-cross-hline'."
339 "Non-nil means relative formula references may cross hlines.
340 Here are the allowed values:
342 nil Relative references may not cross hlines. They will reference the
343 field next to the hline instead. Coming from below, the reference
344 will be to the field below the hline. Coming from above, it will be
345 to the field above.
346 t Relative references may cross hlines.
347 error An attempt to cross a hline will throw an error.
349 It is probably good to never set this variable to nil, for the sake of
350 portability of tables."
358 "Non-nil means that evaluation of a field formula can add new
359 columns if an out-of-bounds field is being set."
366 (const :tag "Setting an out-of-bounds field adds columns as needed, but issues a warning message" warn)
370 "Options concerning table import and export in Org-mode."
375 "Default export parameters for `org-table-export'.
376 These can be overridden for a specific table by setting the
377 TABLE_EXPORT_FORMAT property. See the manual section on orgtbl
378 radio tables for the different export transformations and
379 available parameters."
384 "Max lines that `org-table-convert-region' will attempt to process.
386 The function can be slow on larger regions; this safety feature
387 prevents it from hanging emacs."
427 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
428 ;; 1 2 3 4 5
439 "Is this a table line colgroup information?"
443 line)
445 nil
452 "Is this a table line with only alignment/width cookies?"
465 s))))
473 ;;;###autoload
475 "Use the table.el package to insert a new table.
476 If there is already a table at point, convert between Org-mode tables
477 and table.el tables."
490 ;;;###autoload
492 "Convert region to table, or create an empty table.
493 If there is an active region, convert it to a table, using the function
494 `org-table-convert-region'. See the documentation of that function
495 to learn how the prefix argument is interpreted to determine the field
496 separator.
497 If there is no such region, create an empty table with `org-table-create'."
503 ;;;###autoload
505 "Query for a size and insert a table skeleton.
525 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
529 ;; Insert a hline after the first row.
536 ;;;###autoload
538 "Convert region to a table.
539 The region goes from BEG0 to END0, but these borders will be moved
540 slightly, to make sure a beginning of line in the first line is included.
542 SEPARATOR specifies the field separator in the lines. It can have the
543 following values:
545 '(4) Use the comma as a field separator
546 '(16) Use a TAB as field separator
547 '(64) Prompt for a regular expression as field separator
548 integer When a number, use that many spaces as field separator
549 regexp When a regular expression, use it to match the separator
550 nil When nil, the command tries to be smart and figure out the
551 separator in the following way:
552 - when each line contains a TAB, assume TAB-separated material
553 - when each line contains a comma, assume CSV material
554 - else, assume one or more SPACE characters as separator."
558 re)
560 (user-error "Region is longer than `org-table-convert-region-max-lines' (%s) lines; not converting"
561 org-table-convert-region-max-lines)
570 ;; Get the right field separator
581 ;; parse the csv stuff
606 ;;;###autoload
608 "Import FILE as a table.
609 The file is assumed to be tab-separated. Such files can be produced by most
610 spreadsheet and database applications. If no tabs (at least one per line)
611 are found, lines will be split on whitespace into fields."
620 ;;;###autoload
622 "Export table to a file, with configurable format.
623 Such a file can be imported into usual spreadsheet programs.
625 FILE can be the output file name. If not given, it will be taken
626 from a TABLE_EXPORT_FILE property in the current entry or higher
627 up in the hierarchy, or the user will be prompted for a file
628 name. FORMAT can be an export format, of the same kind as it
629 used when `orgtbl-mode' sends a table in a different format.
631 The command suggests a format depending on TABLE_EXPORT_FORMAT,
632 whether it is set locally or up in the hierarchy, then on the
633 extension of the given file name, and finally on the variable
634 `org-table-export-default-format'."
667 formats)))
668 org-table-export-default-format)
694 "Marker at the beginning of the table last aligned.
697 "Marker at the end of the table last aligned.
700 "List of flags for flushright alignment, from the last re-alignment.
703 "List of max width of fields in each column.
706 "Non-nil means debug table formulas.
718 ;;;###autoload
720 "Align the table at point by aligning all vertical bars."
723 ;; Limits of table
726 ;; Current cursor position
732 column
734 rfmt hfmt
742 emptystrings links dates emph raise narrow
743 falign falign1 fmax f1 f2 len c e space)
746 ;; Check if we have links or dates
758 ;; Make sure the link properties are right
760 ;; Make sure the date properties are right
765 ;; Check if we are narrowing any columns
768 org-format-transports-properties-p
773 ;; Get the rows
776 ;; Store the indentation of the first line
779 ;; Mark the hlines by setting the corresponding element to nil
780 ;; At the same time, we remove trailing space.
783 nil
786 l)))
787 lines))
788 ;; Get the data fields by splitting the lines.
793 ;; How many fields in the longest line?
800 ;; A list of empty strings to fill any short rows on output
802 ;; Check for special formatting.
806 ;; Check if there is an explicit width specified
816 ;; Find fields that are wider than fmax, and shorten them
822 'help-echo
831 f2)
835 f1)
841 xx)))))
842 ;; Get the maximum width for each column
844 lengths)
845 ;; Get the fraction of numbers, to decide about alignment of the column
851 nil
858 ;; Store the alignment of this table, for later editing of single fields
860 org-table-last-column-widths lengths)
862 ;; With invisible characters, `format' does not get the field width right
863 ;; So we need to make these fields wide by hand.
881 ;; Compute the formats needed for output of the table
894 hfmt))
898 ;; Replace the old one
905 ;; Try to move to the old location
914 ))
916 ;;;###autoload
918 "Find the beginning of the table and return its position.
919 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
923 org-table-border-regexp)
924 nil t))
930 ;;;###autoload
932 "Find the end of the table and return its position.
933 With argument TABLE-TYPE, go to the end of a table.el-type table."
937 org-table-border-regexp)
938 nil t))
943 ;;;###autoload
945 "Justify the current field, text to left, number to right.
946 Optional argument NEW may specify text to replace the current field content."
955 ;; This is not the same table, force a full re-align
961 l f n o e)
987 ;;;###autoload
989 "Go to the next field in the current table, creating new lines as needed.
990 Before doing so, re-align the table if necessary."
995 org-table-may-need-update)
1006 org-table-tab-jumps-over-hlines
1017 ;;;###autoload
1019 "Go to the previous field in the table.
1020 Before doing so, re-align the table if necessary."
1025 org-table-may-need-update)
1040 "Move to the end of the current table field.
1041 If already at or after the end, move to the end of the next table field.
1042 With numeric argument N, move N-1 fields forward first."
1055 "Move to the beginning of the current table field.
1056 If already at or before the beginning, move to the beginning of the
1057 previous field.
1058 With numeric argument N, move N-1 fields backward first."
1071 ;;;###autoload
1073 "Go to the next row (same column) in the current table.
1074 Before doing so, re-align the table if necessary."
1082 org-table-may-need-update)
1095 ;;;###autoload
1097 "Copy the value of the current field one row below.
1099 If the field at the cursor is empty, copy the content of the
1100 nearest non-empty field above. With argument N, use the Nth
1101 non-empty field.
1103 If the current field is not empty, it is copied down to the next
1104 row, and the cursor is moved with it. Therefore, repeating this
1105 command causes the column to be filled row-by-row.
1107 If the variable `org-table-copy-increment' is non-nil and the
1108 field is an integer or a timestamp, it will be incremented while
1109 copying. By default, increment by the difference between the
1110 value in the current field and the one in the field above. To
1111 increment using a fixed integer, set `org-table-copy-increment'
1112 to a number. In the case of a timestamp, increment by days."
1124 txt txt-up inc)
1132 beg t))
1142 beg t))
1149 ;; Above field was not empty, go down to the next row
1182 "Is point inside a table data field?
1183 I.e. not on a hline or before the first or after the last column?
1184 This actually throws an error, so it aborts the current command."
1190 nil
1192 t))
1198 "Get the field in table line LINE, column COLUMN.
1199 If LINE is larger than the number of data lines in the table, the function
1200 returns nil. However, if COLUMN is too large, we will simply return an
1201 empty string.
1202 If LINE is nil, use the current line.
1203 If COLUMN is nil, use the current column."
1210 "Put VALUE into line LINE, column COLUMN.
1211 When ALIGN is set, also realign the table."
1220 "Return the index of the current data line."
1227 cnt))
1230 "Go to the Nth data line in the current table.
1231 Return t when the line exists, nil if it does not exist."
1238 ;;;###autoload
1240 "Blank the current table field or active region."
1257 "Return the value of the field in column N of current row.
1258 N defaults to current field.
1259 If REPLACE is a string, replace field with this value. The return value
1260 is always the old value."
1269 t t))
1271 val)
1274 ;;;###autoload
1276 "Show info about the current field, and highlight any reference at point."
1285 org-table-named-field-locations)))
1305 dline col
1307 dline col ref1
1309 ;; FIXME: formula info not correct if special table line
1319 "Find out which column we are in."
1329 cnt)))
1331 ;;;###autoload
1333 "Find out what table data line we are in.
1334 Only data lines count for this."
1346 cnt)))
1348 ;;;###autoload
1350 "Move the cursor to the Nth column in the current table line.
1351 With optional argument ON-DELIM, stop with point before the left delimiter
1352 of the field.
1353 If there are less than N fields, just go to after the last delimiter.
1354 However, when FORCE is non-nil, create new columns if necessary."
1364 t)))))
1371 ;;;###autoload
1373 "Insert a new column into the table."
1381 ;; Current cursor position
1387 nil
1401 "Find a data line in the current table, which is needed for column commands."
1404 t
1415 t
1420 "Turn a buffer line number into a data line number.
1421 If there is no data line in this line, return nil.
1422 If there is no matching dline (most likely te reference was a hline), the
1423 first dline below it is used. When ABOVE is non-nil, the one above is used."
1426 i)
1439 nil))
1441 ;;;###autoload
1443 "Delete a column from the table."
1452 ;; Current cursor position
1458 nil
1474 ;;;###autoload
1476 "Move column to the right."
1479 ;;;###autoload
1481 "Move column to the left."
1485 ;;;###autoload
1487 "Move the current column to the right. With arg LEFT, move to the left."
1497 ;; Current cursor position
1507 nil
1525 ;;;###autoload
1527 "Move table row down."
1530 ;;;###autoload
1532 "Move table row up."
1536 ;;;###autoload
1538 "Move the current table line down. With arg UP, move it up."
1547 txt hline2p)
1570 ;;;###autoload
1572 "Insert a new row above the current line into the table.
1573 With prefix ARG, insert below the current line."
1579 ;; Fix the first field if necessary
1592 ;;;###autoload
1594 "Insert a horizontal-line below the current line into the table.
1595 With prefix ABOVE, insert above the current line."
1616 ;;;###autoload
1618 "Insert a hline and move to the row below that line."
1632 In particular, this does handle wide and invisible characters."
1634 ;; It's a hline, just map the characters
1640 t t s)))
1641 s))
1643 ;;;###autoload
1645 "Delete the current row or horizontal line from the table."
1659 ;;;###autoload
1661 "Sort table lines according to the column at point.
1663 The position of point indicates the column to be used for
1664 sorting, and the range of lines is the range between the nearest
1665 horizontal separator lines, or the entire table of no such lines
1666 exist. If point is before the first column, you will be prompted
1667 for the sorting column. If there is an active region, the mark
1668 specifies the first line and the sorting column, while point
1669 should be in the last line to be included into the sorting.
1671 The command then prompts for the sorting type which can be
1672 alphabetically, numerically, or by time (as given in a time stamp
1673 in the field, or as a HH:MM value). Sorting in reverse order is
1674 also possible.
1676 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1678 If SORTING-TYPE is specified when this function is called from a Lisp
1679 program, no prompting will take place. SORTING-TYPE must be a character,
1680 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
1681 should be done in reverse order."
1686 beg end bcol ecol tend tbeg column lns pos)
1731 x))
1745 ;;;###autoload
1747 "Copy region in table to the clipboard and blank all relevant fields.
1748 If there is no active region, use just the field at point."
1754 ;;;###autoload
1756 "Copy rectangular region in table to clipboard.
1757 A special clipboard is used which can only be accessed
1758 with `org-table-paste-rectangle'."
1762 current-prefix-arg))
1764 region cols
1790 org-table-clip))
1792 ;;;###autoload
1794 "Paste a rectangular region into a table.
1795 The upper right corner ends up in the current field. All involved fields
1796 will be overwritten. If the rectangle does not fit into the present table,
1797 the table is enlarged as needed. The process ignores horizontal separator
1798 lines."
1808 c cols field)
1823 ;;;###autoload
1825 "Convert from `org-mode' table to table.el and back.
1826 Obviously, this only works within limits. When an Org-mode table is
1827 converted to table.el, all horizontal separator lines get lost, because
1828 table.el uses these as cell boundaries and has no notion of horizontal lines.
1829 A table.el table can be converted to an Org-mode table only if it does not
1830 do row or column spanning. Multiline cells will become multiple cells.
1831 Beware, Org-mode does not test if the table can be successfully converted - it
1832 blindly applies a recipe that works for simple tables."
1836 ;; convert to Org-mode table
1845 ;; convert to table.el table
1848 ;; first, get rid of all horizontal lines
1852 ;; insert a hline before first
1856 ;; insert a hline after each line
1861 ;; replace "+" at beginning and ending of hlines
1870 "Transpose Org table at point and eliminate hlines.
1871 So a table like
1873 | 1 | 2 | 4 | 5 |
1874 |---+---+---+---|
1875 | a | b | c | d |
1876 | e | f | g | h |
1878 will be transposed as
1880 | 1 | a | e |
1881 | 2 | b | f |
1882 | 4 | c | g |
1883 | 5 | d | h |
1885 Note that horizontal lines disappear."
1897 table)))
1911 ;;;###autoload
1913 "Wrap several fields in a column like a paragraph.
1914 This is useful if you'd like to spread the contents of a field over several
1915 lines, in order to keep the table compact.
1917 If there is an active region, and both point and mark are in the same column,
1918 the text in the column is wrapped to minimum width for the given number of
1919 lines. Generally, this makes the table more compact. A prefix ARG may be
1921 formats the selected text to two lines. If the region was longer than two
1922 lines, the remaining lines remain empty. A negative prefix argument reduces
1923 the current number of lines by that amount. The wrapped text is pasted back
1924 into the table. If you formatted it to more lines than it was before, fields
1925 further down in the table get overwritten - so you might need to make space in
1926 the table first.
1928 If there is no region, the current field is split at the cursor position and
1929 the text fragment to the right of the cursor is prepended to the field one
1930 line down.
1932 If there is no region, but you specify a prefix ARG, the current field gets
1933 blank, and the content is appended to the field above."
1937 ;; There is a region: fill as a paragraph
1941 nlines)
1948 arg)
1952 nil nlines)))
1956 ;; No region, split the current field at point
1960 ;; combine with field above
1970 ;; split field
1982 ;;;###autoload
1984 "Edit table field in a different window.
1985 This is mainly useful for fields that contain hidden parts.
1987 it can be edited in place."
1996 display t intangible t))
2009 p)
2025 intangible t))
2033 "Finish editing a table data field.
2034 Remove all newline characters, insert the result into the table, realign
2035 the table and kill the editing buffer."
2039 text)
2056 "Minor mode to make the table field editor window follow the cursor.
2057 When this mode is active, the field editor window will always show the
2058 current field. The mode exits automatically when the cursor leaves the
2059 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
2060 nil " TblFollow" nil
2076 ;; We have left the table, exit the follow mode
2086 ;;;###autoload
2088 "Sum numbers in region of current table column.
2089 The result will be displayed in the echo area, and will be available
2092 If there is an active region, it is interpreted as a rectangle and all
2093 numbers in that rectangle will be summed. If there is no active
2094 region and point is located in a table column, sum all numbers in that
2095 column.
2097 If at least one number looks like a time HH:MM or HH:MM:SS, all other
2098 numbers are assumed to be times as well (in decimal hours) and the
2099 numbers are added as such.
2101 If NLAST is a number, only the NLAST fields will actually be summed."
2128 items1)))
2135 s diff)
2143 sres))))
2166 "Return the formula active for the current field.
2167 Assumes that specials are in place.
2168 If KEY is given, return the key to this formula.
2172 org-table-named-field-locations)))
2186 "Read a formula from the minibuffer, offer stored formula as default.
2187 When NAMED is non-nil, look for a named equation."
2191 org-table-named-field-locations)))
2198 name
2199 ref)
2209 stored)
2211 equation)
2218 scol))
2220 'org-table-formula-history
2221 )))))
2222 mustsave)
2224 ;; remove formula
2231 ;; We set the column equation, delete the named one.
2233 mustsave t))
2239 eq))
2242 "Store the list of formulas below the current table."
2249 ;; don't overwrite TBLFM, we might use text properties to store stuff
2265 ;; Fake a high number to make sure this is sorted at the end.
2272 a)
2282 "Compare two formulas for sorting."
2287 ;;;###autoload
2289 "Return an alist with the stored formulas directly after current table."
2298 (when (string-match "\\`\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*[^ \t]\\)" string)
2317 "Modify the equations after the table structure has been edited.
2319 For all numbers larger than LIMIT, shift them by DELTA."
2331 s n a)
2337 "Change makes TBLFM term %s invalid, use undo to recover"
2353 "Get the column names and local parameters for this table."
2356 names name fields fields1 field cnt
2357 c v l line col types dlines hlines last-dline)
2359 org-table-local-parameters nil
2360 org-table-named-field-locations nil
2361 org-table-current-begin-line nil
2362 org-table-current-begin-pos nil
2363 org-table-current-line-types nil
2382 org-table-local-parameters))))
2398 ;; Analyse the line types
2402 l org-table-current-begin-line)
2419 al al2)
2429 ;;;###autoload
2432 If yes, store the formula and apply it."
2433 ;; We already know we are in a table. Get field will only return a formula
2434 ;; when appropriate. It might return a separator line, but no problem.
2437 named eq)
2448 "List of commands triggering the recalculation of a line.
2460 ;;;###autoload
2462 "Rotate the recalculation mark in the first column.
2463 If in any row, the first field is not consistent with a mark,
2464 insert a new column for the markers.
2465 When there is an active region, change all the lines in the region,
2466 after prompting for the marking character.
2467 After each change, a message will be displayed indicating the meaning
2468 of the new mark."
2483 epos new)
2490 newchar))
2522 ;;;###autoload
2524 "Recompute the current line if marked for it, and if we haven't just done it."
2544 org-tbl-calc-modes)
2546 ;;;###autoload
2548 suppress-align suppress-const
2549 suppress-store suppress-analysis)
2550 "Replace the table field value at the cursor by the result of a calculation.
2552 This function makes use of Dave Gillespie's Calc package, in my view the
2553 most exciting program ever written for GNU Emacs. So you need to have Calc
2554 installed in order to use this function.
2556 In a table, this command replaces the value in the current field with the
2558 formula, by storing it in a special line below the table. When called
2559 with a `C-u' prefix, the current field must be a named field, and the
2560 formula is installed as valid in only this specific field.
2562 When called with two `C-u' prefixes, insert the active equation
2563 for the field back into the current field, so that it can be
2565 to check the referenced fields.
2567 When called, the command first prompts for a formula, which is read in
2568 the minibuffer. Previously entered formulas are available through the
2569 history list, and the last used formula is offered as a default.
2570 These stored formulas are adapted correctly when moving, inserting, or
2571 deleting columns with the corresponding commands.
2573 The formula can be any algebraic expression understood by the Calc package.
2574 For details, see the Org-mode manual.
2576 This function can also be called from Lisp programs and offers
2577 additional arguments: EQUATION can be the formula to apply. If this
2578 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2579 used to speed-up recursive calls by by-passing unnecessary aligns.
2580 SUPPRESS-CONST suppresses the interpretation of constants in the
2581 formula, assuming that this has been done already outside the function.
2582 SUPPRESS-STORE means the formula should not be stored, either because
2583 it is already stored, or because it is a modified equation that should
2584 not overwrite the stored one."
2600 equation
2606 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2607 duration duration-output-format)
2608 ;; Parse the format string. Since we have a lot of modes, this is
2609 ;; a lot of work. However, I think calc still uses most of the time.
2622 'calc-float-format
2625 n))))
2629 duration-output-format nil
2633 duration-output-format org-table-duration-custom-format
2634 numbers t
2657 ;; replace fields with duration values if relevant
2661 fields)))
2667 x))
2668 fields)))
2674 ;; Insert row and column number of formula result field
2685 t t form)))
2687 ;; Check for old vertical references
2689 ;; Insert remote references
2702 rmtrng))
2703 keep-empty numbers lispp))
2704 t t form)))
2705 ;; Insert complex ranges
2713 ;; possibly handle durations
2718 formrg)
2719 keep-empty numbers lispp)))
2724 ;; Insert simple ranges
2733 keep-empty numbers lispp))
2734 t t form)))
2736 ;; Insert the references to fields in same row
2743 x keep-empty numbers lispp)))
2761 ;; Use <...> time-stamps so that Calc can handle them
2764 ;; I18n-ize local time-stamps by setting (system-time-locale "C")
2775 form
2782 duration-output-format)
2783 ev)))
2788 Orig: %s
2789 $xyz-> %s
2790 @r$c-> %s
2822 prop value)))
2825 "Get a calc vector from a column, according to descriptor DESC.
2826 Optional arguments TBEG and COL can give the beginning of the table and
2827 the current column, to avoid unnecessary parsing.
2829 HIGHLIGHT means just highlight the range.
2831 When CORNERS-ONLY is set, only return the corners of the range as
2832 a list (line1 column1 line2 column2) where line1 and line2 are line numbers
2833 in the buffer and column1 and column2 are table column numbers."
2840 beg end c1 c2 r1 r2 rangep tmp)
2857 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2864 ;; just one field
2871 ;; A range, return a vector
2872 ;; First sort the numbers to get a regular rectangle
2876 ;; Only return the corners of the range
2878 ;; Copy the range values into a list
2892 ;; return string representation of calc vector
2897 "Analyze descriptor DESC and retrieve the corresponding line number.
2898 The cursor is currently in line CLINE, the table begins in line BLINE,
2899 and TABLE is a vector with line types."
2907 ;; 1 2 3 4 5 6
2927 nil hn cline desc)))
2930 rel on cline desc)))
2934 "FIXME: Needs more documentation."
2947 nil))
2948 t)))
2952 desc cline)
2953 i)))
2960 "Convert list ELEMENTS to something appropriate to insert into formula.
2961 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2962 NUMBERS indicates that everything should be converted to numbers.
2963 LISPP non-nil means to return something appropriate for a Lisp
2964 list, 'literal is for the format specifier L."
2965 ;; Calc nan (not a number) is used for the conversion of the empty
2966 ;; field to a reference for several reasons: (i) It is accepted in a
2967 ;; Calc formula (e. g. "" or "()" would result in a Calc error).
2968 ;; (ii) In a single field (not in range) it can be distinguished
2969 ;; from "(nan)" which is the reference made from a single field
2970 ;; containing "nan".
2972 ;; field reference
2975 elements
2977 ""
2986 ;; range reference
2991 elements))))
2997 x
3005 x)
3007 elements
3011 "If there has been more than one second since T1, display message.
3012 ARGS are passed as arguments to the `message' function. Returns
3013 current time if a message is printed, otherwise returns T1. If
3014 T1 is nil, always messages."
3018 curtime)
3019 t1)))
3021 ;;;###autoload
3023 "Recalculate the current table line by applying all stored formulas.
3024 With prefix arg ALL, do this for all lines in the table.
3025 With the prefix argument ALL is `(16)' \
3027 it is the symbol `iterate', recompute the table until it no longer changes.
3028 If NOALIGN is not nil, do not re-align the table after the computations
3029 are done. This is typically used internally to save time, if it is
3030 known that the table will be realigned a little later anyway."
3047 seen-fields lhs1
3049 ;; Insert constants in all formulas
3069 eqlist))
3070 ;; Split the equation list
3076 ;; Expand ranges in lhs of formulas
3079 ;; Get the correct line range to process
3085 ;; This is a table with marked lines, compute selected lines
3087 ;; Move forward to the first non-header line
3097 ;; First find the named fields, and mark them untouchable.
3098 ;; Also check if several field/range formulas try to set the same field.
3117 name)))
3130 ;; Now evaluate the column formulas, but skip fields covered
3131 ;; by field formulas
3135 ;; Unprotected line, recalculate
3139 log-last-time
3151 ;; Now evaluate the field formulas
3171 t))
3186 log-first-time
3190 ;; back to initial position
3199 ;;;###autoload
3201 "Recalculate the table until it does not change anymore.
3202 The maximum number of iterations is 10, but you can choose a different value
3203 with the prefix ARG."
3208 thistbl)
3222 ;;;###autoload
3224 "Recalculate all tables in the current buffer."
3231 ;;;###autoload
3233 "Iterate all tables in the buffer, to converge inter-table dependencies."
3238 c1)
3254 "Apply the #+TBLFM in the line at point to the table."
3260 s e)
3262 ;; Insert a temporary formula at right after the table
3267 ;; Recalculate the table
3273 ;; delete the formula inserted temporarily
3277 "Find the beginning of the TBLFM lines and return its position.
3278 Return nil when the beginning of TBLFM line was not found."
3282 org-table-TBLFM-begin-regexp
3283 nil t))
3287 "Expand list of formulas.
3288 If some of the RHS in the formulas are ranges or a row reference, expand
3289 them to individual field equations for each field."
3295 ;; This just refers to one fixed field
3298 ;; This just refers to one fixed named field
3320 "Replace @<, @>, $<, $> with first/last row/column of the table.
3321 So @< and $< will always be replaced with @1 and $1, respectively.
3322 The advantage of these special markers are that structure editing of
3323 the table will not change them, while @1 and $1 will be modified
3324 when a line/row is swapped out of that privileged position. So for
3325 formulas that use a range of rows or columns, it may often be better
3327 borders of the table using the @< @> $< $> makers."
3330 s start)
3335 org-table-current-ncol)
3339 len
3346 s)
3349 "Replace $const with values in string F."
3351 ;; First, check for column names
3356 ;; Parameters and constants
3358 (while (setq start (string-match "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)" f start))
3368 f))
3371 "Find the value for a parameter or constant in a formula.
3372 Parameters get priority."
3403 map))
3410 "--"
3413 "--"
3414 "Shift Reference at Point"
3419 "-"
3420 "Change Test Row for Column Formulas"
3423 "--"
3428 org-table-overlay-coordinates)]
3429 "--"
3435 ;;;###autoload
3437 "Edit the formulas of the current table in a separate buffer."
3439 (when (save-excursion (beginning-of-line 1) (let ((case-fold-search t)) (looking-at "[ \t]*#\\+TBLFM")))
3453 entry s type title)
3456 ;; Keep global-font-lock-mode from turning on font-lock-mode
3497 "Convert a formula from internal to user representation."
3500 s))
3503 "Convert a formula from user to internal representation."
3506 s))
3509 "Convert spreadsheet references from A7 to @7$28.
3510 Works for single references, but also for entire formulas and even the
3511 full TBLFM line."
3513 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3516 ;; format match, just advance
3521 ;; 3.e5 or something like this.
3524 ;; (member (match-string 1 s)
3525 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3526 )
3527 ;; function name, just advance
3537 t t s)))))
3538 s))
3541 "Convert spreadsheet references from to @7$28 to AB7.
3542 Works for single references, but also for entire formulas and even the
3543 full TBLFM line."
3550 t t s)))
3555 t nil s)))
3556 s)
3559 "Convert a base 26 number represented by letters into an integer.
3560 For example: AB -> 28."
3566 n))
3569 "Convert an integer into a base 26 number represented by letters.
3570 For example: 28 -> AB."
3575 s))
3578 "Convert a time string into numerical duration in seconds.
3579 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3580 If S is a string representing a number, keep this number."
3582 s
3605 "Convert a number of seconds to a time string.
3606 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3607 minutes or seconds."
3622 "Convert all references in this buffer, using FUNCTION."
3632 "Convert all references in the buffer from B3 to @3$2 and back."
3642 "Shift the reference at point one row/hline up."
3646 "Shift the reference at point one row/hline down."
3650 "Shift the reference at point one field to the left."
3654 "Shift the reference at point one field to the right."
3665 ;; A B3-like reference
3671 ;; An internal reference
3677 "Re-match the group N, and replace it with the shifted reference."
3682 t t)))
3685 "Shift a reference part REF.
3686 If DECR is set, decrease the references row/column, else increase.
3687 If HLINE is set, this may be a hline reference, it certainly is not
3688 a translation reference."
3717 "Toggle the display of coordinates in the referenced table."
3726 "Parse the buffer for formula definitions and install them.
3727 With prefix ARG, apply the new formulas to the table."
3737 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3738 nil t)
3762 "Abort editing formulas, without installing the changes."
3773 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3814 "Show the location/value of the $ expression at point."
3823 var name e what match dest)
3828 "$1.."
3911 ;; column number
3939 org-table-fedit-scroll-down))))
3951 "Make sure the cursor is in a dataline in a table."
3960 p1 p2)))
3965 "Move cursor one line up in the window showing the table."
3970 "Move cursor one line down in the window showing the table."
3975 "Move the cursor in the window showing the table.
3976 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
4001 "Add a new overlay."
4007 "Highlight rectangular region in a table."
4011 l1 c1 l2 c2 tmp)
4035 "Remove the rectangle overlays."
4046 "Add overlays to the table at point, to show row/column coordinates."
4074 ;;;###autoload
4076 "Toggle the display of Row/Column numbers in tables."
4087 ;;;###autoload
4089 "Toggle the formula debugger in tables."
4095 ;;; The orgtbl minor mode
4097 ;; Define a minor mode which can be used in other modes in order to
4098 ;; integrate the org-mode table editor.
4100 ;; This is really a hack, because the org-mode table editor uses several
4101 ;; keys which normally belong to the major mode, for example the TAB and
4102 ;; RET keys. Here is how it works: The minor mode defines all the keys
4103 ;; necessary to operate the table editor, but wraps the commands into a
4104 ;; function which tests if the cursor is currently inside a table. If that
4105 ;; is the case, the table editor command is executed. However, when any of
4106 ;; those keys is used outside a table, the function uses `key-binding' to
4107 ;; look up if the key has an associated command in another currently active
4108 ;; keymap (minor modes, major mode, global), and executes that command.
4109 ;; There might be problems if any of the keys used by the table editor is
4110 ;; otherwise used as a prefix key.
4112 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
4113 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
4114 ;; addresses this by checking explicitly for both bindings.
4116 ;; The optimized version (see variable `orgtbl-optimized') takes over
4117 ;; all keys which are bound to `self-insert-command' in the *global map*.
4118 ;; Some modes bind other commands to simple characters, for example
4119 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
4120 ;; active, this binding is ignored inside tables and replaced with a
4121 ;; modified self-insert.
4139 ;; Install it as a minor mode.
4143 ;;;###autoload
4145 "The `org-mode' table editor as a minor mode for use in other modes."
4150 ;; Exit without error, in case some hook functions calls this
4151 ;; by accident in org-mode.
4155 ;; Make sure we are first in minor-mode-map-alist
4157 ;; FIXME: maybe it should use emulation-mode-map-alists?
4164 auto-fill-inhibit-regexp)
4168 auto-fill-inhibit-regexp)
4169 orgtbl-line-start-regexp))
4187 "Remove all properties related to narrow-column invisibility."
4200 "Create a function for binding in the table minor mode.
4201 FUN is the command to call inside a table. N is used to create a unique
4202 command name. KEYS are keys that should be checked in for a command
4203 to execute outside of tables."
4209 "Outside of tables, run the binding of `"
4221 keys)
4225 "Error when there is no default binding for a table key."
4230 "Setup orgtbl keymaps."
4261 elt key fun cmd)
4269 ;; Special treatment needed for TAB and RET
4289 [(tab)] "\C-i")))
4291 (org-defkey orgtbl-mode-map [backtab]
4293 [backtab] [S-iso-lefttab] [(shift tab)]
4294 [(tab)] "\C-i"))
4296 (org-defkey orgtbl-mode-map "\M-\C-m"
4297 (orgtbl-make-binding 'org-table-wrap-region 105
4298 "\M-\C-m" [(meta return)]))
4299 (org-defkey orgtbl-mode-map [(meta return)]
4300 (orgtbl-make-binding 'org-table-wrap-region 106
4301 [(meta return)] "\M-\C-m"))
4303 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4304 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4306 (when orgtbl-optimized
4307 ;; If the user wants maximum table support, we need to hijack
4308 ;; some standard editing functions
4309 (org-remap orgtbl-mode-map
4310 'self-insert-command 'orgtbl-self-insert-command
4311 'delete-char 'org-delete-char
4312 'delete-backward-char 'org-delete-backward-char)
4313 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4314 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4315 '("OrgTbl"
4316 ["Create or convert" org-table-create-or-convert-from-region
4317 :active (not (org-at-table-p)) :keys "C-c |" ]
4318 "--"
4319 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4320 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4321 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4322 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4323 "--"
4324 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4325 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4326 ["Copy Field from Above"
4327 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4328 "--"
4329 ("Column"
4330 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4331 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4332 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4333 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4334 ("Row"
4335 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4336 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4337 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4338 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4339 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4340 "--"
4341 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4342 ("Rectangle"
4343 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4344 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4345 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4346 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4347 "--"
4348 ("Radio tables"
4349 ["Insert table template" orgtbl-insert-radio-table
4350 (assq major-mode orgtbl-radio-table-templates)]
4351 ["Comment/uncomment table" orgtbl-toggle-comment t])
4352 "--"
4353 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4354 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4355 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4356 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4357 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4358 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4359 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4360 ["Sum Column/Rectangle" org-table-sum
4361 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4362 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4363 ["Debug Formulas"
4364 org-table-toggle-formula-debugger :active (org-at-table-p)
4365 :keys "C-c {"
4366 :style toggle :selected org-table-formula-debug]
4367 ["Show Col/Row Numbers"
4368 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4369 :keys "C-c }"
4370 :style toggle :selected org-table-overlay-coordinates]
4371 "--"
4372 ("Plot"
4375 t))
4377 (defun orgtbl-ctrl-c-ctrl-c (arg)
4378 "If the cursor is inside a table, realign the table.
4379 If it is a table to be sent away to a receiver, do it.
4380 With prefix arg, also recompute table."
4381 (interactive "P")
4382 (let ((case-fold-search t) (pos (point)) action)
4383 (save-excursion
4384 (beginning-of-line 1)
4385 (setq action (cond
4389 (cond
4390 ((integerp action)
4391 (goto-char action)
4392 (org-table-maybe-eval-formula)
4393 (if arg
4394 (call-interactively 'org-table-recalculate)
4395 (org-table-maybe-recalculate-line))
4396 (call-interactively 'org-table-align)
4397 (when (orgtbl-send-table 'maybe)
4398 (run-hooks 'orgtbl-after-send-table-hook)))
4399 ((eq action 'recalc)
4400 (save-excursion
4401 (beginning-of-line 1)
4403 (if (org-at-table-p)
4404 (org-call-with-arg 'org-table-recalculate t))))
4405 (t (let (orgtbl-mode)
4406 (call-interactively (key-binding "\C-c\C-c")))))))
4408 (defun orgtbl-create-or-convert-from-region (arg)
4409 "Create table or convert region to table, if no conflicting binding.
4410 This installs the table binding `C-c |', but only if there is no
4411 conflicting binding to this key outside orgtbl-mode."
4412 (interactive "P")
4413 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4414 (if cmd
4415 (call-interactively cmd)
4416 (call-interactively 'org-table-create-or-convert-from-region))))
4418 (defun orgtbl-tab (arg)
4419 "Justification and field motion for `orgtbl-mode'."
4420 (interactive "P")
4421 (if arg (org-table-edit-field t)
4422 (org-table-justify-field-maybe)
4423 (org-table-next-field)))
4425 (defun orgtbl-ret ()
4426 "Justification and field motion for `orgtbl-mode'."
4427 (interactive)
4428 (if (bobp)
4429 (newline)
4430 (org-table-justify-field-maybe)
4431 (org-table-next-row)))
4433 (defun orgtbl-self-insert-command (N)
4434 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4435 If the cursor is in a table looking at whitespace, the whitespace is
4436 overwritten, and the table is not marked as requiring realignment."
4437 (interactive "p")
4438 (if (and (org-at-table-p)
4439 (or
4440 (and org-table-auto-blank-field
4441 (member last-command
4442 '(orgtbl-hijacker-command-100
4443 orgtbl-hijacker-command-101
4444 orgtbl-hijacker-command-102
4445 orgtbl-hijacker-command-103
4446 orgtbl-hijacker-command-104
4447 orgtbl-hijacker-command-105
4448 yas/expand))
4449 (org-table-blank-field))
4450 t)
4451 (eq N 1)
4453 (let (org-table-may-need-update)
4454 (goto-char (1- (match-end 0)))
4455 (org-delete-backward-char 1)
4456 (goto-char (match-beginning 0))
4457 (self-insert-command N))
4458 (setq org-table-may-need-update t)
4459 (let* (orgtbl-mode
4460 a
4461 (cmd (or (key-binding
4462 (or (and (listp function-key-map)
4463 (setq a (assoc last-input-event function-key-map))
4464 (cdr a))
4465 (vector last-input-event)))
4466 'self-insert-command)))
4467 (call-interactively cmd)
4468 (if (and org-self-insert-cluster-for-undo
4469 (eq cmd 'self-insert-command))
4470 (if (not (eq last-command 'orgtbl-self-insert-command))
4471 (setq org-self-insert-command-undo-counter 1)
4472 (if (>= org-self-insert-command-undo-counter 20)
4473 (setq org-self-insert-command-undo-counter 1)
4474 (and (> org-self-insert-command-undo-counter 0)
4475 buffer-undo-list
4476 (not (cadr buffer-undo-list)) ; remove nil entry
4477 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4478 (setq org-self-insert-command-undo-counter
4479 (1+ org-self-insert-command-undo-counter))))))))
4482 "Regular expression matching exponentials as produced by calc.")
4484 (defun orgtbl-gather-send-defs ()
4485 "Gather a plist of :name, :transform, :params for each destination before
4486 a radio table."
4487 (save-excursion
4488 (goto-char (org-table-begin))
4489 (let (rtn)
4490 (beginning-of-line 0)
4491 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4492 (let ((name (org-no-properties (match-string 1)))
4493 (transform (intern (match-string 2)))
4494 (params (if (match-end 3)
4495 (read (concat "(" (match-string 3) ")")))))
4496 (push (list :name name :transform transform :params params)
4497 rtn)
4498 (beginning-of-line 0)))
4499 rtn)))
4501 (defun orgtbl-send-replace-tbl (name txt)
4502 "Find and replace table NAME with TXT."
4503 (save-excursion
4504 (goto-char (point-min))
4505 (unless (re-search-forward
4507 (user-error "Don't know where to insert translated table"))
4508 (let ((beg (line-beginning-position 2)))
4509 (unless (re-search-forward
4510 (concat "END +RECEIVE +ORGTBL +" name) nil t)
4511 (user-error "Cannot find end of insertion region"))
4512 (beginning-of-line)
4513 (delete-region beg (point)))
4516 ;;;###autoload
4517 (defun org-table-to-lisp (&optional txt)
4518 "Convert the table at point to a Lisp structure.
4519 The structure will be a list. Each item is either the symbol `hline'
4520 for a horizontal separator line, or a list of field values as strings.
4521 The table is taken from the parameter TXT, or from the buffer at point."
4522 (unless (or txt (org-at-table-p)) (user-error "No table at point"))
4523 (let ((txt (or txt
4524 (buffer-substring-no-properties (org-table-begin)
4525 (org-table-end)))))
4526 (mapcar (lambda (x)
4527 (if (string-match org-table-hline-regexp x) 'hline
4531 (defun orgtbl-send-table (&optional maybe)
4532 "Send a transformed version of table at point to the receiver position.
4533 With argument MAYBE, fail quietly if no transformation is defined
4534 for this table."
4535 (interactive)
4536 (catch 'exit
4537 (unless (org-at-table-p) (user-error "Not at a table"))
4538 ;; when non-interactive, we assume align has just happened.
4539 (when (org-called-interactively-p 'any) (org-table-align))
4540 (let ((dests (orgtbl-gather-send-defs))
4541 (table (org-table-to-lisp
4542 (buffer-substring-no-properties (org-table-begin)
4543 (org-table-end))))
4544 (ntbl 0))
4545 (unless dests
4546 (if maybe (throw 'exit nil)
4547 (user-error "Don't know how to transform this table")))
4548 (dolist (dest dests)
4549 (let ((name (plist-get dest :name))
4550 (transform (plist-get dest :transform))
4551 (params (plist-get dest :params)))
4552 (unless (fboundp transform)
4553 (user-error "No such transformation function %s" transform))
4554 (orgtbl-send-replace-tbl name (funcall transform table params)))
4555 (incf ntbl))
4556 (message "Table converted and installed at %d receiver location%s"
4557 ntbl (if (> ntbl 1) "s" ""))
4558 (and (> ntbl 0) ntbl))))
4560 (defun org-remove-by-index (list indices &optional i0)
4561 "Remove the elements in LIST with indices in INDICES.
4562 First element has index 0, or I0 if given."
4563 (if (not indices)
4564 list
4565 (if (integerp indices) (setq indices (list indices)))
4566 (setq i0 (1- (or i0 0)))
4567 (delq :rm (mapcar (lambda (x)
4568 (setq i0 (1+ i0))
4569 (if (memq i0 indices) :rm x))
4570 list))))
4572 (defun orgtbl-toggle-comment ()
4573 "Comment or uncomment the orgtbl at point."
4574 (interactive)
4575 (let* ((case-fold-search t)
4576 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4577 (re2 (concat "^" orgtbl-line-start-regexp))
4578 (commented (save-excursion (beginning-of-line 1)
4579 (cond ((looking-at re1) t)
4580 ((looking-at re2) nil)
4581 (t (user-error "Not at an org table")))))
4582 (re (if commented re1 re2))
4583 beg end)
4584 (save-excursion
4585 (beginning-of-line 1)
4586 (while (looking-at re) (beginning-of-line 0))
4587 (beginning-of-line 2)
4588 (setq beg (point))
4589 (while (looking-at re) (beginning-of-line 2))
4590 (setq end (point)))
4591 (comment-region beg end (if commented '(4) nil))))
4593 (defun orgtbl-insert-radio-table ()
4594 "Insert a radio table template appropriate for this major mode."
4595 (interactive)
4596 (let* ((e (assq major-mode orgtbl-radio-table-templates))
4597 (txt (nth 1 e))
4598 name pos)
4599 (unless e (user-error "No radio table setup defined for %s" major-mode))
4600 (setq name (read-string "Table name: "))
4601 (while (string-match "%n" txt)
4602 (setq txt (replace-match name t t txt)))
4604 (setq pos (point))
4605 (insert txt)
4606 (goto-char pos)))
4608 ;;;###autoload
4609 (defun orgtbl-to-generic (table params)
4610 "Convert the orgtbl-mode TABLE to some other format.
4612 This generic routine can be used for many standard cases.
4614 TABLE is a list, each entry either the symbol `hline' for
4615 a horizontal separator line, or a list of fields for that
4616 line. PARAMS is a property list of parameters that can
4617 influence the conversion.
4619 Valid parameters are:
4621 :backend, :raw
4623 Export back-end used as a basis to transcode elements of the
4624 table, when no specific parameter applies to it. It is also
4625 used to translate cells contents. You can prevent this by
4626 setting :raw property to a non-nil value.
4628 :splice
4630 When non-nil, only convert rows, not the table itself. This is
4631 equivalent to setting to the empty string both :tstart
4632 and :tend, which see.
4634 :skip
4636 When set to an integer N, skip the first N lines of the table.
4637 Horizontal separation lines do count for this parameter!
4639 :skipcols
4641 List of columns that should be skipped. If the table has
4642 a column with calculation marks, that column is automatically
4643 discarded beforehand.
4645 :hline
4647 String to be inserted on horizontal separation lines. May be
4648 nil to ignore these lines altogether.
4650 :sep
4652 Separator between two fields, as a string.
4654 Each in the following group may be either a string or a function
4655 of no arguments returning a string:
4657 :tstart, :tend
4659 Strings to start and end the table. Ignored when :splice is t.
4661 :lstart, :lend
4663 Strings to start and end a new table line.
4665 :llstart, :llend
4667 Strings to start and end the last table line. Default,
4668 respectively, to :lstart and :lend.
4670 Each in the following group may be a string or a function of one
4671 argument (either the cells in the current row, as a list of
4672 strings, or the current cell) returning a string:
4674 :lfmt
4676 Format string for an entire row, with enough %s to capture all
4677 fields. When non-nil, :lstart, :lend, and :sep are ignored.
4679 :llfmt
4681 Format for the entire last line, defaults to :lfmt.
4683 :fmt
4685 A format to be used to wrap the field, should contain %s for
4686 the original field value. For example, to wrap everything in
4688 a property list with column numbers and format strings, or
4689 functions, e.g.,
4693 :hlstart :hllstart :hlend :hllend :hsep :hlfmt :hllfmt :hfmt
4695 Same as above, specific for the header lines in the table.
4696 All lines before the first hline are treated as header. If
4697 any of these is not present, the data line value is used.
4699 This may be either a string or a function of two arguments:
4701 :efmt
4703 Use this format to print numbers with exponential. The format
4704 should have %s twice for inserting mantissa and exponent, for
4706 list with column numbers and format strings or functions.
4707 :fmt will still be applied after :efmt."
4708 (let ((backend (plist-get params :backend)))
4709 (when (and backend (symbolp backend) (not (org-export-get-backend backend)))
4710 (user-error "Unknown :backend value"))
4711 (when (or (not backend) (plist-get params :raw)) (require 'ox-org))
4712 (org-trim
4713 (org-export-string-as
4714 ;; Return TABLE as Org syntax. Tolerate non-string cells.
4715 (with-output-to-string
4716 (dolist (e table)
4718 ((consp e)
4719 (princ "| ") (dolist (c e) (princ c) (princ " |"))
4721 ;; Build a custom back-end according to PARAMS. Before defining
4722 ;; a translator, check if there is anything to do. When there
4723 ;; isn't, let BACKEND handle the element.
4724 (org-export-create-backend
4725 :parent (or backend 'org)
4726 :filters
4727 '((:filter-parse-tree
4728 ;; Handle :skip parameter.
4729 (lambda (tree backend info)
4730 (let ((skip (plist-get info :skip)))
4731 (when skip
4732 (unless (wholenump skip) (user-error "Wrong :skip value"))
4733 (let ((n 0))
4734 (org-element-map tree 'table-row
4735 (lambda (row)
4736 (if (>= n skip) t
4737 (org-element-extract-element row)
4738 (incf n)
4739 nil))
4740 info t))
4741 tree)))
4742 ;; Handle :skipcols parameter.
4743 (lambda (tree backend info)
4744 (let ((skipcols (plist-get info :skipcols)))
4745 (when skipcols
4746 (unless (consp skipcols) (user-error "Wrong :skipcols value"))
4747 (org-element-map tree 'table
4748 (lambda (table)
4749 (let ((specialp
4750 (org-export-table-has-special-column-p table)))
4751 (dolist (row (org-element-contents table))
4752 (when (eq (org-element-property :type row) 'standard)
4753 (let ((c 1))
4754 (dolist (cell (nthcdr (if specialp 1 0)
4755 (org-element-contents row)))
4756 (when (memq c skipcols)
4757 (org-element-extract-element cell))
4758 (incf c)))))))
4759 info)
4760 tree)))))
4761 :transcoders
4762 `((table . ,(org-table--to-generic-table params))
4763 (table-row . ,(org-table--to-generic-row params))
4764 (table-cell . ,(org-table--to-generic-cell params))
4765 ;; Section. Return contents to avoid garbage around table.
4766 (section . (lambda (s c i) c))))
4767 'body-only (org-combine-plists params '(:with-tables t))))))
4769 (defun org-table--generic-apply (value name &optional with-cons &rest args)
4770 (cond ((null value) nil)
4771 ((functionp value) `(funcall ',value ,@args))
4772 ((stringp value)
4773 (cond ((consp (car args)) `(apply #'format ,value ,@args))
4774 (args `(format ,value ,@args))
4775 (t value)))
4776 ((and with-cons (consp value))
4777 `(let ((val (cadr (memq column ',value))))
4778 (cond ((null val) contents)
4779 ((stringp val) (format val ,@args))
4780 ((functionp val) (funcall val ,@args))
4781 (t (user-error "Wrong %s value" ,name)))))
4782 (t (user-error "Wrong %s value" name))))
4784 (defun org-table--to-generic-table (params)
4785 "Return custom table transcoder according to PARAMS.
4786 PARAMS is a plist. See `orgtbl-to-generic' for more
4787 information."
4788 (let ((backend (plist-get params :backend))
4789 (splice (plist-get params :splice))
4790 (tstart (plist-get params :tstart))
4791 (tend (plist-get params :tend)))
4792 `(lambda (table contents info)
4793 (concat
4794 ,(and tstart (not splice)
4796 ,(if (or (not backend) tstart tend splice) 'contents
4797 `(org-export-with-backend ',backend table contents info))
4798 ,(org-table--generic-apply (and (not splice) tend) ":tend")))))
4800 (defun org-table--to-generic-row (params)
4801 "Return custom table row transcoder according to PARAMS.
4802 PARAMS is a plist. See `orgtbl-to-generic' for more
4803 information."
4804 (let* ((backend (plist-get params :backend))
4805 (lstart (plist-get params :lstart))
4806 (llstart (plist-get params :llstart))
4807 (hlstart (plist-get params :hlstart))
4808 (hllstart (plist-get params :hllstart))
4809 (lend (plist-get params :lend))
4810 (llend (plist-get params :llend))
4811 (hlend (plist-get params :hlend))
4812 (hllend (plist-get params :hllend))
4813 (lfmt (plist-get params :lfmt))
4814 (llfmt (plist-get params :llfmt))
4815 (hlfmt (plist-get params :hlfmt))
4816 (hllfmt (plist-get params :hllfmt)))
4817 `(lambda (row contents info)
4818 (if (eq (org-element-property :type row) 'rule)
4819 ,(cond
4820 ((plist-member params :hline)
4821 (org-table--generic-apply (plist-get params :hline) ":hline"))
4822 (backend `(org-export-with-backend ',backend row nil info)))
4823 (let ((headerp (org-export-table-row-in-header-p row info))
4824 (lastp (not (org-export-get-next-element row info)))
4825 (last-header-p (org-export-table-row-ends-header-p row info)))
4826 (when contents
4827 ;; Check if we can apply `:lfmt', `:llfmt', `:hlfmt', or
4828 ;; `:hllfmt' to CONTENTS. Otherwise, fallback on
4829 ;; `:lstart', `:lend' and their relatives.
4830 ,(let ((cells
4831 '(org-element-map row 'table-cell
4832 (lambda (cell)
4833 ;; Export all cells, without separators.
4834 ;;
4835 ;; Use `org-export-data-with-backend'
4836 ;; instead of `org-export-data' to eschew
4837 ;; cached values, which
4838 ;; ignore :orgtbl-ignore-sep parameter.
4839 (org-export-data-with-backend
4840 cell
4841 (plist-get info :back-end)
4842 (org-combine-plists info '(:orgtbl-ignore-sep t))))
4843 info)))
4844 `(cond
4845 ,(and hllfmt
4846 `(last-header-p ,(org-table--generic-apply
4847 hllfmt ":hllfmt" nil cells)))
4848 ,(and hlfmt
4849 `(headerp ,(org-table--generic-apply
4850 hlfmt ":hlfmt" nil cells)))
4851 ,(and llfmt
4852 `(lastp ,(org-table--generic-apply
4853 llfmt ":llfmt" nil cells)))
4854 (t
4855 ,(if lfmt (org-table--generic-apply lfmt ":lfmt" nil cells)
4856 `(concat
4857 (cond
4858 ,(and
4859 (or hllstart hllend)
4860 `(last-header-p
4861 (concat
4862 ,(org-table--generic-apply hllstart ":hllstart")
4863 contents
4864 ,(org-table--generic-apply hllend ":hllend"))))
4865 ,(and
4866 (or hlstart hlend)
4867 `(headerp
4868 (concat
4869 ,(org-table--generic-apply hlstart ":hlstart")
4870 contents
4871 ,(org-table--generic-apply hlend ":hlend"))))
4872 ,(and
4873 (or llstart llend)
4874 `(lastp
4875 (concat
4876 ,(org-table--generic-apply llstart ":llstart")
4877 contents
4878 ,(org-table--generic-apply llend ":llend"))))
4879 (t
4880 ,(cond
4881 ((or lstart lend)
4882 `(concat
4883 ,(org-table--generic-apply lstart ":lstart")
4884 contents
4885 ,(org-table--generic-apply lend ":lend")))
4886 (backend
4887 `(org-export-with-backend
4888 ',backend row contents info))
4889 (t 'contents)))))))))))))))
4891 (defun org-table--to-generic-cell (params)
4892 "Return custom table cell transcoder according to PARAMS.
4893 PARAMS is a plist. See `orgtbl-to-generic' for more
4894 information."
4895 (let* ((backend (plist-get params :backend))
4896 (efmt (plist-get params :efmt))
4897 (fmt (plist-get params :fmt))
4898 (hfmt (plist-get params :hfmt))
4899 (sep (plist-get params :sep))
4900 (hsep (plist-get params :hsep)))
4901 `(lambda (cell contents info)
4902 (let ((headerp (org-export-table-row-in-header-p
4903 (org-export-get-parent-element cell) info))
4904 (column (1+ (cdr (org-export-table-cell-address cell info)))))
4905 ;; Make sure that contents are exported as Org data when :raw
4906 ;; parameter is non-nil.
4907 ,(when (and backend (plist-get params :raw))
4908 `(setq contents
4909 ;; Since we don't know what are the pseudo object
4910 ;; types defined in backend, we cannot pass them to
4911 ;; `org-element-interpret-data'. As a consequence,
4912 ;; they will be treated as pseudo elements, and
4913 ;; will have newlines appended instead of spaces.
4914 ;; Therefore, we must make sure :post-blank value
4915 ;; is really turned into spaces.
4916 (replace-regexp-in-string
4918 (org-trim
4919 (org-element-interpret-data
4920 (org-element-contents cell))))))
4921 (when contents
4922 ;; Check if we can apply `:efmt' on CONTENTS.
4923 ,(when efmt
4924 `(when (string-match orgtbl-exp-regexp contents)
4925 (let ((mantissa (match-string 1 contents))
4926 (exponent (match-string 2 contents)))
4927 (setq contents ,(org-table--generic-apply
4928 efmt ":efmt" t 'mantissa 'exponent)))))
4929 ;; Check if we can apply FMT (or HFMT) on CONTENTS.
4930 (cond
4931 ,(and hfmt `(headerp (setq contents ,(org-table--generic-apply
4932 hfmt ":hfmt" t 'contents))))
4933 ,(and fmt `(t (setq contents ,(org-table--generic-apply
4934 fmt ":fmt" t 'contents))))))
4935 ;; If a separator is provided, use it instead of BACKEND's.
4936 ;; Separators are ignored when LFMT (or equivalent) is
4937 ;; provided.
4938 ,(cond
4939 ((or hsep sep)
4940 `(if (or ,(and (not sep) '(not headerp))
4941 (plist-get info :orgtbl-ignore-sep)
4942 (not (org-export-get-next-element cell info)))
4943 ,(if (not backend) 'contents
4944 `(org-export-with-backend ',backend cell contents info))
4945 (concat contents
4946 ,(if (and sep hsep) `(if headerp ,hsep ,sep)
4947 (or hsep sep)))))
4948 (backend `(org-export-with-backend ',backend cell contents info))
4949 (t 'contents))))))
4951 ;;;###autoload
4952 (defun orgtbl-to-tsv (table params)
4953 "Convert the orgtbl-mode table to TAB separated material."
4956 ;;;###autoload
4957 (defun orgtbl-to-csv (table params)
4958 "Convert the orgtbl-mode table to CSV material.
4959 This does take care of the proper quoting of fields with comma or quotes."
4960 (orgtbl-to-generic table
4961 (org-combine-plists '(:sep "," :fmt org-quote-csv-field)
4962 params)))
4964 ;;;###autoload
4965 (defun orgtbl-to-latex (table params)
4966 "Convert the orgtbl-mode TABLE to LaTeX.
4968 TABLE is a list, each entry either the symbol `hline' for
4969 a horizontal separator line, or a list of fields for that line.
4970 PARAMS is a property list of parameters that can influence the
4971 conversion. All parameters from `orgtbl-to-generic' are
4972 supported. It is also possible to use the following ones:
4974 :booktabs
4978 :environment
4980 Specify environment to use, as a string. If you use
4982 as a string, to get proper continuation strings."
4983 (require 'ox-latex)
4984 (orgtbl-to-generic
4985 table
4986 (org-combine-plists
4987 ;; Provide sane default values.
4988 (list :backend 'latex
4989 :latex-default-table-mode 'table
4990 :latex-tables-centered nil
4991 :latex-tables-booktabs (plist-get params :booktabs)
4992 :latex-table-scientific-notation nil
4993 :latex-default-table-environment
4994 (or (plist-get params :environment) "tabular"))
4995 params)))
4997 ;;;###autoload
4998 (defun orgtbl-to-html (table params)
4999 "Convert the orgtbl-mode TABLE to HTML.
5001 TABLE is a list, each entry either the symbol `hline' for
5002 a horizontal separator line, or a list of fields for that line.
5003 PARAMS is a property list of parameters that can influence the
5004 conversion. All parameters from `orgtbl-to-generic' are
5005 supported. It is also possible to use the following one:
5007 :attributes
5009 Attributes and values, as a plist, which will be used in
5010 <table> tag."
5011 (require 'ox-html)
5012 (orgtbl-to-generic
5013 table
5014 (org-combine-plists
5015 ;; Provide sane default values.
5016 (list :backend 'html
5017 :html-table-data-tags '("<td%s>" . "</td>")
5018 :html-table-use-header-tags-for-first-column nil
5019 :html-table-align-individual-fields t
5020 :html-table-row-tags '("<tr>" . "</tr>")
5021 :html-table-attributes
5022 (if (plist-member params :attributes)
5023 (plist-get params :attributes)
5024 '(:border "2" :cellspacing "0" :cellpadding "6" :rules "groups"
5025 :frame "hsides")))
5026 params)))
5028 ;;;###autoload
5029 (defun orgtbl-to-texinfo (table params)
5030 "Convert the orgtbl-mode TABLE to Texinfo.
5032 TABLE is a list, each entry either the symbol `hline' for
5033 a horizontal separator line, or a list of fields for that line.
5034 PARAMS is a property list of parameters that can influence the
5035 conversion. All parameters from `orgtbl-to-generic' are
5036 supported. It is also possible to use the following one:
5038 :columns
5040 Column widths, as a string. When providing column fractions,
5042 (require 'ox-texinfo)
5043 (let ((output
5044 (orgtbl-to-generic
5045 table
5046 (org-combine-plists
5047 (list :backend 'texinfo
5048 :texinfo-tables-verbatim nil
5049 :texinfo-table-scientific-notation nil)
5050 params)))
5051 (columns (let ((w (plist-get params :columns)))
5052 (cond ((not w) nil)
5054 (t (concat "@columnfractions " w))))))
5055 (if (not columns) output
5056 (replace-regexp-in-string
5059 ;;;###autoload
5060 (defun orgtbl-to-orgtbl (table params)
5061 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
5063 TABLE is a list, each entry either the symbol `hline' for
5064 a horizontal separator line, or a list of fields for that line.
5065 PARAMS is a property list of parameters that can influence the
5066 conversion. All parameters from `orgtbl-to-generic' are
5067 supported.
5069 Useful when slicing one table into many. The :hline, :sep,
5070 :lstart, and :lend provide orgtbl framing. :tstart and :tend can
5071 be set to provide ORGTBL directives for the generated table."
5072 (require 'ox-org)
5073 (orgtbl-to-generic table (org-combine-plists params (list :backend 'org))))
5075 (defun orgtbl-to-table.el (table params)
5076 "Convert the orgtbl-mode TABLE into a table.el table.
5077 TABLE is a list, each entry either the symbol `hline' for
5078 a horizontal separator line, or a list of fields for that line.
5079 PARAMS is a property list of parameters that can influence the
5080 conversion. All parameters from `orgtbl-to-generic' are
5081 supported."
5082 (with-temp-buffer
5083 (insert (orgtbl-to-orgtbl table params))
5084 (org-table-align)
5085 (replace-regexp-in-string
5086 "-|" "-+"
5087 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
5089 (defun orgtbl-to-unicode (table params)
5090 "Convert the orgtbl-mode TABLE into a table with unicode characters.
5092 TABLE is a list, each entry either the symbol `hline' for
5093 a horizontal separator line, or a list of fields for that line.
5094 PARAMS is a property list of parameters that can influence the
5095 conversion. All parameters from `orgtbl-to-generic' are
5096 supported. It is also possible to use the following ones:
5098 :ascii-art
5101 the table. You can download it here:
5102 http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el.
5104 :narrow
5106 When non-nil, narrow columns width than provided width cookie,
5108 (require 'ox-ascii)
5109 (orgtbl-to-generic
5110 table
5111 (org-combine-plists
5112 (list :backend 'ascii
5113 :ascii-charset 'utf-8
5114 :ascii-table-keep-all-vertical-lines (plist-get params :)
5115 :ascii-table-widen-columns (not (plist-get params :narrow))
5116 :ascii-table-use-ascii-art (plist-get params :ascii-art))
5117 params)))
5119 ;; Put the cursor in a column containing numerical values
5120 ;; of an Org-Mode table,
5121 ;; type C-c " a
5122 ;; A new column is added with a bar plot.
5123 ;; When the table is refreshed (C-u C-c *),
5124 ;; the plot is updated to reflect the new values.
5126 (defun orgtbl-ascii-draw (value min max &optional width characters)
5127 "Draw an ascii bar in a table.
5128 VALUE is a the value to plot, the width of the bar to draw. A
5129 value equal to MIN will be displayed as empty (zero width bar).
5130 A value equal to MAX will draw a bar filling all the WIDTH.
5131 WIDTH is the expected width in characters of the column.
5132 CHARACTERS is a string that will compose the bar, with shades of
5133 grey from pure white to pure black. It defaults to a 10
5134 characters string of regular ascii characters."
5135 (let* ((characters (or characters " .:;c!lhVHW"))
5136 (width (or width 12))
5137 (value (if (numberp value) value (string-to-number value)))
5138 (value (* (/ (- (+ value 0.0) min) (- max min)) width)))
5139 (cond
5140 ((< value 0) "too small")
5141 ((> value width) "too large")
5142 (t
5143 (let ((len (1- (length characters))))
5144 (concat
5145 (make-string (floor value) (elt characters len))
5146 (string (elt characters
5147 (floor (* (- value (floor value)) len))))))))))
5149 ;;;###autoload
5150 (defun orgtbl-ascii-plot (&optional ask)
5151 "Draw an ascii bar plot in a column.
5152 With cursor in a column containing numerical values, this
5153 function will draw a plot in a new column.
5154 ASK, if given, is a numeric prefix to override the default 12
5155 characters width of the plot. ASK may also be the
5157 (interactive "P")
5158 (let ((col (org-table-current-column))
5159 (min 1e999) ; 1e999 will be converted to infinity
5160 (max -1e999) ; which is the desired result
5161 (table (org-table-to-lisp))
5162 (length
5163 (cond ((consp ask)
5164 (read-number "Length of column " 12))
5165 ((numberp ask) ask)
5166 (t 12))))
5167 ;; Skip any hline a the top of table.
5168 (while (eq (car table) 'hline) (setq table (cdr table)))
5169 ;; Skip table header if any.
5170 (dolist (x (or (cdr (memq 'hline table)) table))
5171 (when (consp x)
5172 (setq x (nth (1- col) x))
5173 (when (string-match
5175 x)
5176 (setq x (string-to-number x))
5177 (when (> min x) (setq min x))
5178 (when (< max x) (setq max x)))))
5179 (org-table-insert-column)
5180 (org-table-move-column-right)
5181 (org-table-store-formulas
5182 (cons
5183 (cons
5184 (number-to-string (1+ col))
5185 (format "'(%s $%s %s %s %s)"
5186 "orgtbl-ascii-draw" col min max length))
5187 (org-table-get-stored-formulas)))
5188 (org-table-recalculate t)))
5190 ;; Example of extension: unicode characters
5191 ;; Here are two examples of different styles.
5193 ;; Unicode block characters are used to give a smooth effect.
5194 ;; See http://en.wikipedia.org/wiki/Block_Elements
5195 ;; Use one of those drawing functions
5196 ;; - orgtbl-ascii-draw (the default ascii)
5197 ;; - orgtbl-uc-draw-grid (unicode with a grid effect)
5198 ;; - orgtbl-uc-draw-cont (smooth unicode)
5200 ;; This is best viewed with the "DejaVu Sans Mono" font
5201 ;; (use M-x set-default-font).
5203 (defun orgtbl-uc-draw-grid (value min max &optional width)
5204 "Draw a bar in a table using block unicode characters.
5205 It is a variant of orgtbl-ascii-draw with Unicode block
5206 characters, for a smooth display. Bars appear as grids (to the
5207 extent the font allows)."
5208 ;; http://en.wikipedia.org/wiki/Block_Elements
5209 ;; best viewed with the "DejaVu Sans Mono" font.
5210 (orgtbl-ascii-draw value min max width
5213 (defun orgtbl-uc-draw-cont (value min max &optional width)
5214 "Draw a bar in a table using block unicode characters.
5215 It is a variant of orgtbl-ascii-draw with Unicode block
5216 characters, for a smooth display. Bars are solid (to the extent
5217 the font allows)."
5218 (orgtbl-ascii-draw value min max width
5221 (defun org-table-get-remote-range (name-or-id form)
5222 "Get a field value or a list of values in a range from table at ID.
5224 NAME-OR-ID may be the name of a table in the current file as set
5226 will then be used. Alternatively, it may be an ID referring to
5227 any entry, also in a different file. In this case, the first
5228 table in that entry will be referenced.
5232 The return value is either a single string for a single field, or a
5233 list of the fields in the rectangle."
5234 (save-match-data
5235 (let ((case-fold-search t) (id-loc nil)
5236 ;; Protect a bunch of variables from being overwritten
5237 ;; by the context of the remote table
5238 org-table-column-names org-table-column-name-regexp
5239 org-table-local-parameters org-table-named-field-locations
5240 org-table-current-line-types org-table-current-begin-line
5241 org-table-current-begin-pos org-table-dlines
5242 org-table-current-ncol
5243 org-table-hlines org-table-last-alignment
5244 org-table-last-column-widths org-table-last-alignment
5245 org-table-last-column-widths tbeg
5246 buffer loc)
5247 (setq form (org-table-convert-refs-to-rc form))
5248 (save-excursion
5249 (save-restriction
5250 (widen)
5251 (save-excursion
5252 (goto-char (point-min))
5253 (if (re-search-forward
5256 nil t)
5257 (setq buffer (current-buffer) loc (match-beginning 0))
5258 (setq id-loc (org-id-find name-or-id 'marker))
5259 (unless (and id-loc (markerp id-loc))
5261 (setq buffer (marker-buffer id-loc)
5262 loc (marker-position id-loc))
5263 (move-marker id-loc nil)))
5264 (with-current-buffer buffer
5265 (save-excursion
5266 (save-restriction
5267 (widen)
5268 (goto-char loc)
5269 (forward-char 1)
5271 (not (match-beginning 1)))
5272 (user-error "Cannot find a table at NAME or ID %s" name-or-id))
5273 (setq tbeg (point-at-bol))
5274 (org-table-get-specials)
5275 (setq form (org-table-formula-substitute-names
5276 (org-table-formula-handle-first/last-rc form)))
5277 (if (and (string-match org-table-range-regexp form)
5278 (> (length (match-string 0 form)) 1))
5279 (save-match-data
5280 (org-table-get-range (match-string 0 form) tbeg 1))
5281 form)))))))))
5283 (defun org-table-remote-reference-indirection (form)
5284 "Return formula with table remote references substituted by indirection.
5286 This indirection works only with the format @ROW$COLUMN. The
5288 distinguished from a plain table name or ID."
5289 (let ((start 0))
5290 (while (string-match (concat
5291 ;; Same as in `org-table-eval-formula'.
5293 ;; Allow "$1", "@<", "$-1", "@<<$1" etc.
5295 ;; Same as in `org-table-eval-formula'.
5297 form
5298 start)
5299 ;; The position of the character as far as possible to the right
5300 ;; that will not be replaced and particularly not be shifted by
5301 ;; `replace-match'.
5302 (setq start (match-beginning 1))
5303 ;; Substitute the remote reference with the value found in the
5304 ;; field.
5305 (setq form
5306 (replace-match
5307 (save-match-data
5308 (org-table-get-range (org-table-formula-handle-first/last-rc
5309 (match-string 1 form))))
5310 t t form 1))))
5311 form)
5313 (defmacro org-define-lookup-function (mode)
5314 (let ((mode-str (symbol-name mode))
5315 (first-p (equal mode 'first))
5316 (all-p (equal mode 'all)))
5317 (let ((plural-str (if all-p "s" "")))
5318 `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
5319 ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
5320 If R-LIST is nil, return matching element%s of S-LIST.
5321 If PREDICATE is not nil, use it instead of `equal' to match VAL.
5322 Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
5323 This function is generated by a call to the macro `org-define-lookup-function'."
5324 mode-str plural-str plural-str plural-str)
5325 (let ,(let ((lvars '((p (or predicate 'equal))
5326 (sl s-list)
5327 (rl (or r-list s-list))
5328 (ret nil))))
5329 (if first-p (add-to-list 'lvars '(match-p nil)))
5330 lvars)
5331 (while ,(if first-p '(and (not match-p) sl) 'sl)
5332 (progn
5333 (if (funcall p val (car sl))
5334 (progn
5335 ,(if first-p '(setq match-p t))
5336 (let ((rval (car rl)))
5337 (setq ret ,(if all-p '(append ret (list rval)) 'rval)))))
5338 (setq sl (cdr sl) rl (cdr rl))))
5339 ret)))))
5341 (org-define-lookup-function first)
5342 (org-define-lookup-function last)
5343 (org-define-lookup-function all)
5345 (provide 'org-table)
5347 ;; Local variables:
5348 ;; generated-autoload-file: "org-loaddefs.el"
5349 ;; End:
5351 ;;; org-table.el ends here