| blob | 91f53ab6107a891196d5e8290f6f204c59de7936 |
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."
417 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
418 ;; 1 2 3 4 5
429 "Is this a table line colgroup information?"
433 line)
435 nil
442 "Is this a table line with only alignment/width cookies?"
455 s))))
463 ;;;###autoload
465 "Use the table.el package to insert a new table.
466 If there is already a table at point, convert between Org-mode tables
467 and table.el tables."
480 ;;;###autoload
482 "Convert region to table, or create an empty table.
483 If there is an active region, convert it to a table, using the function
484 `org-table-convert-region'. See the documentation of that function
485 to learn how the prefix argument is interpreted to determine the field
486 separator.
487 If there is no such region, create an empty table with `org-table-create'."
493 ;;;###autoload
495 "Query for a size and insert a table skeleton.
515 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
519 ;; Insert a hline after the first row.
526 ;;;###autoload
528 "Convert region to a table.
529 The region goes from BEG0 to END0, but these borders will be moved
530 slightly, to make sure a beginning of line in the first line is included.
532 SEPARATOR specifies the field separator in the lines. It can have the
533 following values:
535 '(4) Use the comma as a field separator
536 '(16) Use a TAB as field separator
537 '(64) Prompt for a regular expression as field separator
538 integer When a number, use that many spaces as field separator
539 regexp When a regular expression, use it to match the separator
540 nil When nil, the command tries to be smart and figure out the
541 separator in the following way:
542 - when each line contains a TAB, assume TAB-separated material
543 - when each line contains a comma, assume CSV material
544 - else, assume one or more SPACE characters as separator."
548 re)
557 ;; Get the right field separator
568 ;; parse the csv stuff
593 ;;;###autoload
595 "Import FILE as a table.
596 The file is assumed to be tab-separated. Such files can be produced by most
597 spreadsheet and database applications. If no tabs (at least one per line)
598 are found, lines will be split on whitespace into fields."
607 ;;;###autoload
609 "Export table to a file, with configurable format.
610 Such a file can be imported into usual spreadsheet programs.
612 FILE can be the output file name. If not given, it will be taken
613 from a TABLE_EXPORT_FILE property in the current entry or higher
614 up in the hierarchy, or the user will be prompted for a file
615 name. FORMAT can be an export format, of the same kind as it
616 used when `orgtbl-mode' sends a table in a different format.
618 The command suggests a format depending on TABLE_EXPORT_FORMAT,
619 whether it is set locally or up in the hierarchy, then on the
620 extension of the given file name, and finally on the variable
621 `org-table-export-default-format'."
654 formats)))
655 org-table-export-default-format)
681 "Marker at the beginning of the table last aligned.
684 "Marker at the end of the table last aligned.
687 "List of flags for flushright alignment, from the last re-alignment.
690 "List of max width of fields in each column.
693 "Non-nil means debug table formulas.
705 ;;;###autoload
707 "Align the table at point by aligning all vertical bars."
710 ;; Limits of table
713 ;; Current cursor position
719 column
721 rfmt hfmt
729 emptystrings links dates emph raise narrow
730 falign falign1 fmax f1 f2 len c e space)
733 ;; Check if we have links or dates
745 ;; Make sure the link properties are right
747 ;; Make sure the date properties are right
752 ;; Check if we are narrowing any columns
755 org-format-transports-properties-p
760 ;; Get the rows
763 ;; Store the indentation of the first line
766 ;; Mark the hlines by setting the corresponding element to nil
767 ;; At the same time, we remove trailing space.
770 nil
773 l)))
774 lines))
775 ;; Get the data fields by splitting the lines.
780 ;; How many fields in the longest line?
787 ;; A list of empty strings to fill any short rows on output
789 ;; Check for special formatting.
793 ;; Check if there is an explicit width specified
803 ;; Find fields that are wider than fmax, and shorten them
809 'help-echo
818 f2)
822 f1)
828 xx)))))
829 ;; Get the maximum width for each column
831 lengths)
832 ;; Get the fraction of numbers, to decide about alignment of the column
838 nil
845 ;; Store the alignment of this table, for later editing of single fields
847 org-table-last-column-widths lengths)
849 ;; With invisible characters, `format' does not get the field width right
850 ;; So we need to make these fields wide by hand.
868 ;; Compute the formats needed for output of the table
881 hfmt))
885 ;; Replace the old one
892 ;; Try to move to the old location
901 ))
903 ;;;###autoload
905 "Find the beginning of the table and return its position.
906 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
910 org-table-border-regexp)
911 nil t))
917 ;;;###autoload
919 "Find the end of the table and return its position.
920 With argument TABLE-TYPE, go to the end of a table.el-type table."
924 org-table-border-regexp)
925 nil t))
930 ;;;###autoload
932 "Justify the current field, text to left, number to right.
933 Optional argument NEW may specify text to replace the current field content."
942 ;; This is not the same table, force a full re-align
948 l f n o e)
974 ;;;###autoload
976 "Go to the next field in the current table, creating new lines as needed.
977 Before doing so, re-align the table if necessary."
982 org-table-may-need-update)
993 org-table-tab-jumps-over-hlines
1004 ;;;###autoload
1006 "Go to the previous field in the table.
1007 Before doing so, re-align the table if necessary."
1012 org-table-may-need-update)
1027 "Move to the end of the current table field.
1028 If already at or after the end, move to the end of the next table field.
1029 With numeric argument N, move N-1 fields forward first."
1042 "Move to the beginning of the current table field.
1043 If already at or before the beginning, move to the beginning of the
1044 previous field.
1045 With numeric argument N, move N-1 fields backward first."
1058 ;;;###autoload
1060 "Go to the next row (same column) in the current table.
1061 Before doing so, re-align the table if necessary."
1069 org-table-may-need-update)
1082 ;;;###autoload
1084 "Copy the value of the current field one row below.
1086 If the field at the cursor is empty, copy the content of the
1087 nearest non-empty field above. With argument N, use the Nth
1088 non-empty field.
1090 If the current field is not empty, it is copied down to the next
1091 row, and the cursor is moved with it. Therefore, repeating this
1092 command causes the column to be filled row-by-row.
1094 If the variable `org-table-copy-increment' is non-nil and the
1095 field is an integer or a timestamp, it will be incremented while
1096 copying. By default, increment by the difference between the
1097 value in the current field and the one in the field above. To
1098 increment using a fixed integer, set `org-table-copy-increment'
1099 to a number. In the case of a timestamp, increment by days."
1111 txt txt-up inc)
1119 beg t))
1129 beg t))
1136 ;; Above field was not empty, go down to the next row
1169 "Is point inside a table data field?
1170 I.e. not on a hline or before the first or after the last column?
1171 This actually throws an error, so it aborts the current command."
1177 nil
1179 t))
1185 "Get the field in table line LINE, column COLUMN.
1186 If LINE is larger than the number of data lines in the table, the function
1187 returns nil. However, if COLUMN is too large, we will simply return an
1188 empty string.
1189 If LINE is nil, use the current line.
1190 If COLUMN is nil, use the current column."
1197 "Put VALUE into line LINE, column COLUMN.
1198 When ALIGN is set, also realign the table."
1207 "Return the index of the current data line."
1214 cnt))
1217 "Go to the Nth data line in the current table.
1218 Return t when the line exists, nil if it does not exist."
1225 ;;;###autoload
1227 "Blank the current table field or active region."
1244 "Return the value of the field in column N of current row.
1245 N defaults to current field.
1246 If REPLACE is a string, replace field with this value. The return value
1247 is always the old value."
1256 t t))
1258 val)
1261 ;;;###autoload
1263 "Show info about the current field, and highlight any reference at point."
1272 org-table-named-field-locations)))
1292 dline col
1294 dline col ref1
1296 ;; FIXME: formula info not correct if special table line
1306 "Find out which column we are in."
1316 cnt)))
1318 ;;;###autoload
1320 "Find out what table data line we are in.
1321 Only data lines count for this."
1333 cnt)))
1335 ;;;###autoload
1337 "Move the cursor to the Nth column in the current table line.
1338 With optional argument ON-DELIM, stop with point before the left delimiter
1339 of the field.
1340 If there are less than N fields, just go to after the last delimiter.
1341 However, when FORCE is non-nil, create new columns if necessary."
1351 t)))))
1358 ;;;###autoload
1360 "Insert a new column into the table."
1368 ;; Current cursor position
1374 nil
1388 "Find a data line in the current table, which is needed for column commands."
1391 t
1402 t
1407 "Turn a buffer line number into a data line number.
1408 If there is no data line in this line, return nil.
1409 If there is no matching dline (most likely te reference was a hline), the
1410 first dline below it is used. When ABOVE is non-nil, the one above is used."
1413 i)
1426 nil))
1428 ;;;###autoload
1430 "Delete a column from the table."
1439 ;; Current cursor position
1445 nil
1461 ;;;###autoload
1463 "Move column to the right."
1466 ;;;###autoload
1468 "Move column to the left."
1472 ;;;###autoload
1474 "Move the current column to the right. With arg LEFT, move to the left."
1484 ;; Current cursor position
1494 nil
1512 ;;;###autoload
1514 "Move table row down."
1517 ;;;###autoload
1519 "Move table row up."
1523 ;;;###autoload
1525 "Move the current table line down. With arg UP, move it up."
1534 txt hline2p)
1557 ;;;###autoload
1559 "Insert a new row above the current line into the table.
1560 With prefix ARG, insert below the current line."
1566 ;; Fix the first field if necessary
1579 ;;;###autoload
1581 "Insert a horizontal-line below the current line into the table.
1582 With prefix ABOVE, insert above the current line."
1603 ;;;###autoload
1605 "Insert a hline and move to the row below that line."
1619 In particular, this does handle wide and invisible characters."
1621 ;; It's a hline, just map the characters
1627 t t s)))
1628 s))
1630 ;;;###autoload
1632 "Delete the current row or horizontal line from the table."
1646 ;;;###autoload
1648 "Sort table lines according to the column at point.
1650 The position of point indicates the column to be used for
1651 sorting, and the range of lines is the range between the nearest
1652 horizontal separator lines, or the entire table of no such lines
1653 exist. If point is before the first column, you will be prompted
1654 for the sorting column. If there is an active region, the mark
1655 specifies the first line and the sorting column, while point
1656 should be in the last line to be included into the sorting.
1658 The command then prompts for the sorting type which can be
1659 alphabetically, numerically, or by time (as given in a time stamp
1660 in the field, or as a HH:MM value). Sorting in reverse order is
1661 also possible.
1663 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1665 If SORTING-TYPE is specified when this function is called from a Lisp
1666 program, no prompting will take place. SORTING-TYPE must be a character,
1667 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
1668 should be done in reverse order."
1673 beg end bcol ecol tend tbeg column lns pos)
1718 x))
1732 ;;;###autoload
1734 "Copy region in table to the clipboard and blank all relevant fields.
1735 If there is no active region, use just the field at point."
1741 ;;;###autoload
1743 "Copy rectangular region in table to clipboard.
1744 A special clipboard is used which can only be accessed
1745 with `org-table-paste-rectangle'."
1749 current-prefix-arg))
1751 region cols
1777 org-table-clip))
1779 ;;;###autoload
1781 "Paste a rectangular region into a table.
1782 The upper right corner ends up in the current field. All involved fields
1783 will be overwritten. If the rectangle does not fit into the present table,
1784 the table is enlarged as needed. The process ignores horizontal separator
1785 lines."
1795 c cols field)
1810 ;;;###autoload
1812 "Convert from `org-mode' table to table.el and back.
1813 Obviously, this only works within limits. When an Org-mode table is
1814 converted to table.el, all horizontal separator lines get lost, because
1815 table.el uses these as cell boundaries and has no notion of horizontal lines.
1816 A table.el table can be converted to an Org-mode table only if it does not
1817 do row or column spanning. Multiline cells will become multiple cells.
1818 Beware, Org-mode does not test if the table can be successfully converted - it
1819 blindly applies a recipe that works for simple tables."
1823 ;; convert to Org-mode table
1832 ;; convert to table.el table
1835 ;; first, get rid of all horizontal lines
1839 ;; insert a hline before first
1843 ;; insert a hline after each line
1848 ;; replace "+" at beginning and ending of hlines
1857 "Transpose Org table at point and eliminate hlines.
1858 So a table like
1860 | 1 | 2 | 4 | 5 |
1861 |---+---+---+---|
1862 | a | b | c | d |
1863 | e | f | g | h |
1865 will be transposed as
1867 | 1 | a | e |
1868 | 2 | b | f |
1869 | 4 | c | g |
1870 | 5 | d | h |
1872 Note that horizontal lines disappear."
1884 table)))
1898 ;;;###autoload
1900 "Wrap several fields in a column like a paragraph.
1901 This is useful if you'd like to spread the contents of a field over several
1902 lines, in order to keep the table compact.
1904 If there is an active region, and both point and mark are in the same column,
1905 the text in the column is wrapped to minimum width for the given number of
1906 lines. Generally, this makes the table more compact. A prefix ARG may be
1908 formats the selected text to two lines. If the region was longer than two
1909 lines, the remaining lines remain empty. A negative prefix argument reduces
1910 the current number of lines by that amount. The wrapped text is pasted back
1911 into the table. If you formatted it to more lines than it was before, fields
1912 further down in the table get overwritten - so you might need to make space in
1913 the table first.
1915 If there is no region, the current field is split at the cursor position and
1916 the text fragment to the right of the cursor is prepended to the field one
1917 line down.
1919 If there is no region, but you specify a prefix ARG, the current field gets
1920 blank, and the content is appended to the field above."
1924 ;; There is a region: fill as a paragraph
1928 nlines)
1935 arg)
1939 nil nlines)))
1943 ;; No region, split the current field at point
1947 ;; combine with field above
1957 ;; split field
1969 ;;;###autoload
1971 "Edit table field in a different window.
1972 This is mainly useful for fields that contain hidden parts.
1974 it can be edited in place."
1983 display t intangible t))
1996 p)
2012 intangible t))
2020 "Finish editing a table data field.
2021 Remove all newline characters, insert the result into the table, realign
2022 the table and kill the editing buffer."
2026 text)
2043 "Minor mode to make the table field editor window follow the cursor.
2044 When this mode is active, the field editor window will always show the
2045 current field. The mode exits automatically when the cursor leaves the
2046 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
2047 nil " TblFollow" nil
2063 ;; We have left the table, exit the follow mode
2073 ;;;###autoload
2075 "Sum numbers in region of current table column.
2076 The result will be displayed in the echo area, and will be available
2079 If there is an active region, it is interpreted as a rectangle and all
2080 numbers in that rectangle will be summed. If there is no active
2081 region and point is located in a table column, sum all numbers in that
2082 column.
2084 If at least one number looks like a time HH:MM or HH:MM:SS, all other
2085 numbers are assumed to be times as well (in decimal hours) and the
2086 numbers are added as such.
2088 If NLAST is a number, only the NLAST fields will actually be summed."
2115 items1)))
2122 s diff)
2130 sres))))
2153 "Return the formula active for the current field.
2154 Assumes that specials are in place.
2155 If KEY is given, return the key to this formula.
2159 org-table-named-field-locations)))
2173 "Read a formula from the minibuffer, offer stored formula as default.
2174 When NAMED is non-nil, look for a named equation."
2178 org-table-named-field-locations)))
2185 name
2186 ref)
2196 stored)
2198 equation)
2205 scol))
2207 'org-table-formula-history
2208 )))))
2209 mustsave)
2211 ;; remove formula
2218 ;; We set the column equation, delete the named one.
2220 mustsave t))
2226 eq))
2229 "Store the list of formulas below the current table."
2236 ;; don't overwrite TBLFM, we might use text properties to store stuff
2252 ;; Fake a high number to make sure this is sorted at the end.
2259 a)
2269 "Compare two formulas for sorting."
2274 ;;;###autoload
2276 "Return an alist with the stored formulas directly after current table."
2285 (when (string-match "\\`\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*[^ \t]\\)" string)
2304 "Modify the equations after the table structure has been edited.
2306 For all numbers larger than LIMIT, shift them by DELTA."
2318 s n a)
2324 "Change makes TBLFM term %s invalid, use undo to recover"
2340 "Get the column names and local parameters for this table."
2343 names name fields fields1 field cnt
2344 c v l line col types dlines hlines last-dline)
2346 org-table-local-parameters nil
2347 org-table-named-field-locations nil
2348 org-table-current-begin-line nil
2349 org-table-current-begin-pos nil
2350 org-table-current-line-types nil
2369 org-table-local-parameters))))
2385 ;; Analyse the line types
2389 l org-table-current-begin-line)
2406 al al2)
2416 ;;;###autoload
2419 If yes, store the formula and apply it."
2420 ;; We already know we are in a table. Get field will only return a formula
2421 ;; when appropriate. It might return a separator line, but no problem.
2424 named eq)
2435 "List of commands triggering the recalculation of a line.
2447 ;;;###autoload
2449 "Rotate the recalculation mark in the first column.
2450 If in any row, the first field is not consistent with a mark,
2451 insert a new column for the markers.
2452 When there is an active region, change all the lines in the region,
2453 after prompting for the marking character.
2454 After each change, a message will be displayed indicating the meaning
2455 of the new mark."
2470 epos new)
2477 newchar))
2509 ;;;###autoload
2511 "Recompute the current line if marked for it, and if we haven't just done it."
2531 org-tbl-calc-modes)
2533 ;;;###autoload
2535 suppress-align suppress-const
2536 suppress-store suppress-analysis)
2537 "Replace the table field value at the cursor by the result of a calculation.
2539 This function makes use of Dave Gillespie's Calc package, in my view the
2540 most exciting program ever written for GNU Emacs. So you need to have Calc
2541 installed in order to use this function.
2543 In a table, this command replaces the value in the current field with the
2545 formula, by storing it in a special line below the table. When called
2546 with a `C-u' prefix, the current field must be a named field, and the
2547 formula is installed as valid in only this specific field.
2549 When called with two `C-u' prefixes, insert the active equation
2550 for the field back into the current field, so that it can be
2552 to check the referenced fields.
2554 When called, the command first prompts for a formula, which is read in
2555 the minibuffer. Previously entered formulas are available through the
2556 history list, and the last used formula is offered as a default.
2557 These stored formulas are adapted correctly when moving, inserting, or
2558 deleting columns with the corresponding commands.
2560 The formula can be any algebraic expression understood by the Calc package.
2561 For details, see the Org-mode manual.
2563 This function can also be called from Lisp programs and offers
2564 additional arguments: EQUATION can be the formula to apply. If this
2565 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2566 used to speed-up recursive calls by by-passing unnecessary aligns.
2567 SUPPRESS-CONST suppresses the interpretation of constants in the
2568 formula, assuming that this has been done already outside the function.
2569 SUPPRESS-STORE means the formula should not be stored, either because
2570 it is already stored, or because it is a modified equation that should
2571 not overwrite the stored one."
2587 equation
2593 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2594 duration duration-output-format)
2595 ;; Parse the format string. Since we have a lot of modes, this is
2596 ;; a lot of work. However, I think calc still uses most of the time.
2609 'calc-float-format
2612 n))))
2616 duration-output-format nil
2620 duration-output-format org-table-duration-custom-format
2621 numbers t
2644 ;; replace fields with duration values if relevant
2648 fields)))
2654 x))
2655 fields)))
2661 ;; Insert row and column number of formula result field
2672 t t form)))
2674 ;; Check for old vertical references
2676 ;; Insert remote references
2689 rmtrng))
2690 keep-empty numbers lispp))
2691 t t form)))
2692 ;; Insert complex ranges
2700 ;; possibly handle durations
2705 formrg)
2706 keep-empty numbers lispp)))
2711 ;; Insert simple ranges
2720 keep-empty numbers lispp))
2721 t t form)))
2723 ;; Insert the references to fields in same row
2730 x keep-empty numbers lispp)))
2748 ;; Use <...> time-stamps so that Calc can handle them
2751 ;; I18n-ize local time-stamps by setting (system-time-locale "C")
2762 form
2769 duration-output-format)
2770 ev)))
2775 Orig: %s
2776 $xyz-> %s
2777 @r$c-> %s
2809 prop value)))
2812 "Get a calc vector from a column, according to descriptor DESC.
2813 Optional arguments TBEG and COL can give the beginning of the table and
2814 the current column, to avoid unnecessary parsing.
2816 HIGHLIGHT means just highlight the range.
2818 When CORNERS-ONLY is set, only return the corners of the range as
2819 a list (line1 column1 line2 column2) where line1 and line2 are line numbers
2820 in the buffer and column1 and column2 are table column numbers."
2827 beg end c1 c2 r1 r2 rangep tmp)
2844 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2851 ;; just one field
2858 ;; A range, return a vector
2859 ;; First sort the numbers to get a regular rectangle
2863 ;; Only return the corners of the range
2865 ;; Copy the range values into a list
2879 ;; return string representation of calc vector
2884 "Analyze descriptor DESC and retrieve the corresponding line number.
2885 The cursor is currently in line CLINE, the table begins in line BLINE,
2886 and TABLE is a vector with line types."
2894 ;; 1 2 3 4 5 6
2914 nil hn cline desc)))
2917 rel on cline desc)))
2921 "FIXME: Needs more documentation."
2934 nil))
2935 t)))
2939 desc cline)
2940 i)))
2947 "Convert list ELEMENTS to something appropriate to insert into formula.
2948 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2949 NUMBERS indicates that everything should be converted to numbers.
2950 LISPP non-nil means to return something appropriate for a Lisp
2951 list, 'literal is for the format specifier L."
2952 ;; Calc nan (not a number) is used for the conversion of the empty
2953 ;; field to a reference for several reasons: (i) It is accepted in a
2954 ;; Calc formula (e. g. "" or "()" would result in a Calc error).
2955 ;; (ii) In a single field (not in range) it can be distinguished
2956 ;; from "(nan)" which is the reference made from a single field
2957 ;; containing "nan".
2959 ;; field reference
2962 elements
2964 ""
2973 ;; range reference
2978 elements))))
2984 x
2992 x)
2994 elements
2997 ;;;###autoload
2999 "Recalculate the current table line by applying all stored formulas.
3000 With prefix arg ALL, do this for all lines in the table.
3001 With the prefix argument ALL is `(16)' \
3003 it is the symbol `iterate', recompute the table until it no longer changes.
3004 If NOALIGN is not nil, do not re-align the table after the computations
3005 are done. This is typically used internally to save time, if it is
3006 known that the table will be realigned a little later anyway."
3021 seen-fields lhs1
3023 ;; Insert constants in all formulas
3041 eqlist))
3042 ;; Split the equation list
3048 ;; Expand ranges in lhs of formulas
3051 ;; Get the correct line range to process
3057 ;; This is a table with marked lines, compute selected lines
3059 ;; Move forward to the first non-header line
3070 ;; First find the named fields, and mark them untouchable.
3071 ;; Also check if several field/range formulas try to set the same field.
3090 name)))
3100 ;; Now evaluate the column formulas, but skip fields covered by
3101 ;; field formulas
3105 ;; Unprotected line, recalculate
3117 ;; Now evaluate the field formulas
3133 t))
3148 ;; back to initial position
3155 ;;;###autoload
3157 "Recalculate the table until it does not change anymore.
3158 The maximum number of iterations is 10, but you can choose a different value
3159 with the prefix ARG."
3164 thistbl)
3178 ;;;###autoload
3180 "Recalculate all tables in the current buffer."
3187 ;;;###autoload
3189 "Iterate all tables in the buffer, to converge inter-table dependencies."
3194 c1)
3210 "Apply the #+TBLFM in the line at point to the table."
3216 s e)
3218 ;; Insert a temporary formula at right after the table
3223 ;; Recalculate the table
3229 ;; delete the formula inserted temporarily
3233 "Find the beginning of the TBLFM lines and return its position.
3234 Return nil when the beginning of TBLFM line was not found."
3238 org-table-TBLFM-begin-regexp
3239 nil t))
3243 "Expand list of formulas.
3244 If some of the RHS in the formulas are ranges or a row reference, expand
3245 them to individual field equations for each field."
3251 ;; This just refers to one fixed field
3254 ;; This just refers to one fixed named field
3276 "Replace @<, @>, $<, $> with first/last row/column of the table.
3277 So @< and $< will always be replaced with @1 and $1, respectively.
3278 The advantage of these special markers are that structure editing of
3279 the table will not change them, while @1 and $1 will be modified
3280 when a line/row is swapped out of that privileged position. So for
3281 formulas that use a range of rows or columns, it may often be better
3283 borders of the table using the @< @> $< $> makers."
3286 s start)
3291 org-table-current-ncol)
3295 len
3302 s)
3305 "Replace $const with values in string F."
3307 ;; First, check for column names
3312 ;; Parameters and constants
3314 (while (setq start (string-match "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)" f start))
3324 f))
3327 "Find the value for a parameter or constant in a formula.
3328 Parameters get priority."
3359 map))
3366 "--"
3369 "--"
3370 "Shift Reference at Point"
3375 "-"
3376 "Change Test Row for Column Formulas"
3379 "--"
3384 org-table-overlay-coordinates)]
3385 "--"
3391 ;;;###autoload
3393 "Edit the formulas of the current table in a separate buffer."
3395 (when (save-excursion (beginning-of-line 1) (let ((case-fold-search t)) (looking-at "[ \t]*#\\+TBLFM")))
3409 entry s type title)
3412 ;; Keep global-font-lock-mode from turning on font-lock-mode
3453 "Convert a formula from internal to user representation."
3456 s))
3459 "Convert a formula from user to internal representation."
3462 s))
3465 "Convert spreadsheet references from A7 to @7$28.
3466 Works for single references, but also for entire formulas and even the
3467 full TBLFM line."
3469 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3472 ;; format match, just advance
3477 ;; 3.e5 or something like this.
3480 ;; (member (match-string 1 s)
3481 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3482 )
3483 ;; function name, just advance
3493 t t s)))))
3494 s))
3497 "Convert spreadsheet references from to @7$28 to AB7.
3498 Works for single references, but also for entire formulas and even the
3499 full TBLFM line."
3506 t t s)))
3511 t nil s)))
3512 s)
3515 "Convert a base 26 number represented by letters into an integer.
3516 For example: AB -> 28."
3522 n))
3525 "Convert an integer into a base 26 number represented by letters.
3526 For example: 28 -> AB."
3531 s))
3534 "Convert a time string into numerical duration in seconds.
3535 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3536 If S is a string representing a number, keep this number."
3538 s
3561 "Convert a number of seconds to a time string.
3562 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3563 minutes or seconds."
3578 "Convert all references in this buffer, using FUNCTION."
3588 "Convert all references in the buffer from B3 to @3$2 and back."
3598 "Shift the reference at point one row/hline up."
3602 "Shift the reference at point one row/hline down."
3606 "Shift the reference at point one field to the left."
3610 "Shift the reference at point one field to the right."
3621 ;; A B3-like reference
3627 ;; An internal reference
3633 "Re-match the group N, and replace it with the shifted reference."
3638 t t)))
3641 "Shift a reference part REF.
3642 If DECR is set, decrease the references row/column, else increase.
3643 If HLINE is set, this may be a hline reference, it certainly is not
3644 a translation reference."
3673 "Toggle the display of coordinates in the referenced table."
3682 "Parse the buffer for formula definitions and install them.
3683 With prefix ARG, apply the new formulas to the table."
3693 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3694 nil t)
3718 "Abort editing formulas, without installing the changes."
3729 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3770 "Show the location/value of the $ expression at point."
3779 var name e what match dest)
3784 "$1.."
3867 ;; column number
3895 org-table-fedit-scroll-down))))
3907 "Make sure the cursor is in a dataline in a table."
3916 p1 p2)))
3921 "Move cursor one line up in the window showing the table."
3926 "Move cursor one line down in the window showing the table."
3931 "Move the cursor in the window showing the table.
3932 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
3957 "Add a new overlay."
3963 "Highlight rectangular region in a table."
3967 l1 c1 l2 c2 tmp)
3991 "Remove the rectangle overlays."
4002 "Add overlays to the table at point, to show row/column coordinates."
4030 ;;;###autoload
4032 "Toggle the display of Row/Column numbers in tables."
4043 ;;;###autoload
4045 "Toggle the formula debugger in tables."
4051 ;;; The orgtbl minor mode
4053 ;; Define a minor mode which can be used in other modes in order to
4054 ;; integrate the org-mode table editor.
4056 ;; This is really a hack, because the org-mode table editor uses several
4057 ;; keys which normally belong to the major mode, for example the TAB and
4058 ;; RET keys. Here is how it works: The minor mode defines all the keys
4059 ;; necessary to operate the table editor, but wraps the commands into a
4060 ;; function which tests if the cursor is currently inside a table. If that
4061 ;; is the case, the table editor command is executed. However, when any of
4062 ;; those keys is used outside a table, the function uses `key-binding' to
4063 ;; look up if the key has an associated command in another currently active
4064 ;; keymap (minor modes, major mode, global), and executes that command.
4065 ;; There might be problems if any of the keys used by the table editor is
4066 ;; otherwise used as a prefix key.
4068 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
4069 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
4070 ;; addresses this by checking explicitly for both bindings.
4072 ;; The optimized version (see variable `orgtbl-optimized') takes over
4073 ;; all keys which are bound to `self-insert-command' in the *global map*.
4074 ;; Some modes bind other commands to simple characters, for example
4075 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
4076 ;; active, this binding is ignored inside tables and replaced with a
4077 ;; modified self-insert.
4095 ;; Install it as a minor mode.
4099 ;;;###autoload
4101 "The `org-mode' table editor as a minor mode for use in other modes."
4106 ;; Exit without error, in case some hook functions calls this
4107 ;; by accident in org-mode.
4111 ;; Make sure we are first in minor-mode-map-alist
4113 ;; FIXME: maybe it should use emulation-mode-map-alists?
4120 auto-fill-inhibit-regexp)
4124 auto-fill-inhibit-regexp)
4125 orgtbl-line-start-regexp))
4143 "Remove all properties related to narrow-column invisibility."
4156 "Create a function for binding in the table minor mode.
4157 FUN is the command to call inside a table. N is used to create a unique
4158 command name. KEYS are keys that should be checked in for a command
4159 to execute outside of tables."
4165 "Outside of tables, run the binding of `"
4177 keys)
4181 "Error when there is no default binding for a table key."
4186 "Setup orgtbl keymaps."
4217 elt key fun cmd)
4225 ;; Special treatment needed for TAB and RET
4245 [(tab)] "\C-i")))
4247 (org-defkey orgtbl-mode-map [backtab]
4249 [backtab] [S-iso-lefttab] [(shift tab)]
4250 [(tab)] "\C-i"))
4252 (org-defkey orgtbl-mode-map "\M-\C-m"
4253 (orgtbl-make-binding 'org-table-wrap-region 105
4254 "\M-\C-m" [(meta return)]))
4255 (org-defkey orgtbl-mode-map [(meta return)]
4256 (orgtbl-make-binding 'org-table-wrap-region 106
4257 [(meta return)] "\M-\C-m"))
4259 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4260 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4262 (when orgtbl-optimized
4263 ;; If the user wants maximum table support, we need to hijack
4264 ;; some standard editing functions
4265 (org-remap orgtbl-mode-map
4266 'self-insert-command 'orgtbl-self-insert-command
4267 'delete-char 'org-delete-char
4268 'delete-backward-char 'org-delete-backward-char)
4269 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4270 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4271 '("OrgTbl"
4272 ["Create or convert" org-table-create-or-convert-from-region
4273 :active (not (org-at-table-p)) :keys "C-c |" ]
4274 "--"
4275 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4276 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4277 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4278 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4279 "--"
4280 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4281 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4282 ["Copy Field from Above"
4283 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4284 "--"
4285 ("Column"
4286 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4287 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4288 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4289 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4290 ("Row"
4291 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4292 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4293 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4294 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4295 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4296 "--"
4297 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4298 ("Rectangle"
4299 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4300 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4301 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4302 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4303 "--"
4304 ("Radio tables"
4305 ["Insert table template" orgtbl-insert-radio-table
4306 (assq major-mode orgtbl-radio-table-templates)]
4307 ["Comment/uncomment table" orgtbl-toggle-comment t])
4308 "--"
4309 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4310 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4311 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4312 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4313 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4314 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4315 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4316 ["Sum Column/Rectangle" org-table-sum
4317 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4318 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4319 ["Debug Formulas"
4320 org-table-toggle-formula-debugger :active (org-at-table-p)
4321 :keys "C-c {"
4322 :style toggle :selected org-table-formula-debug]
4323 ["Show Col/Row Numbers"
4324 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4325 :keys "C-c }"
4326 :style toggle :selected org-table-overlay-coordinates]
4327 "--"
4328 ("Plot"
4331 t))
4333 (defun orgtbl-ctrl-c-ctrl-c (arg)
4334 "If the cursor is inside a table, realign the table.
4335 If it is a table to be sent away to a receiver, do it.
4336 With prefix arg, also recompute table."
4337 (interactive "P")
4338 (let ((case-fold-search t) (pos (point)) action)
4339 (save-excursion
4340 (beginning-of-line 1)
4341 (setq action (cond
4345 (cond
4346 ((integerp action)
4347 (goto-char action)
4348 (org-table-maybe-eval-formula)
4349 (if arg
4350 (call-interactively 'org-table-recalculate)
4351 (org-table-maybe-recalculate-line))
4352 (call-interactively 'org-table-align)
4353 (when (orgtbl-send-table 'maybe)
4354 (run-hooks 'orgtbl-after-send-table-hook)))
4355 ((eq action 'recalc)
4356 (save-excursion
4357 (beginning-of-line 1)
4359 (if (org-at-table-p)
4360 (org-call-with-arg 'org-table-recalculate t))))
4361 (t (let (orgtbl-mode)
4362 (call-interactively (key-binding "\C-c\C-c")))))))
4364 (defun orgtbl-create-or-convert-from-region (arg)
4365 "Create table or convert region to table, if no conflicting binding.
4366 This installs the table binding `C-c |', but only if there is no
4367 conflicting binding to this key outside orgtbl-mode."
4368 (interactive "P")
4369 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4370 (if cmd
4371 (call-interactively cmd)
4372 (call-interactively 'org-table-create-or-convert-from-region))))
4374 (defun orgtbl-tab (arg)
4375 "Justification and field motion for `orgtbl-mode'."
4376 (interactive "P")
4377 (if arg (org-table-edit-field t)
4378 (org-table-justify-field-maybe)
4379 (org-table-next-field)))
4381 (defun orgtbl-ret ()
4382 "Justification and field motion for `orgtbl-mode'."
4383 (interactive)
4384 (if (bobp)
4385 (newline)
4386 (org-table-justify-field-maybe)
4387 (org-table-next-row)))
4389 (defun orgtbl-self-insert-command (N)
4390 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4391 If the cursor is in a table looking at whitespace, the whitespace is
4392 overwritten, and the table is not marked as requiring realignment."
4393 (interactive "p")
4394 (if (and (org-at-table-p)
4395 (or
4396 (and org-table-auto-blank-field
4397 (member last-command
4398 '(orgtbl-hijacker-command-100
4399 orgtbl-hijacker-command-101
4400 orgtbl-hijacker-command-102
4401 orgtbl-hijacker-command-103
4402 orgtbl-hijacker-command-104
4403 orgtbl-hijacker-command-105
4404 yas/expand))
4405 (org-table-blank-field))
4406 t)
4407 (eq N 1)
4409 (let (org-table-may-need-update)
4410 (goto-char (1- (match-end 0)))
4411 (org-delete-backward-char 1)
4412 (goto-char (match-beginning 0))
4413 (self-insert-command N))
4414 (setq org-table-may-need-update t)
4415 (let* (orgtbl-mode
4416 a
4417 (cmd (or (key-binding
4418 (or (and (listp function-key-map)
4419 (setq a (assoc last-input-event function-key-map))
4420 (cdr a))
4421 (vector last-input-event)))
4422 'self-insert-command)))
4423 (call-interactively cmd)
4424 (if (and org-self-insert-cluster-for-undo
4425 (eq cmd 'self-insert-command))
4426 (if (not (eq last-command 'orgtbl-self-insert-command))
4427 (setq org-self-insert-command-undo-counter 1)
4428 (if (>= org-self-insert-command-undo-counter 20)
4429 (setq org-self-insert-command-undo-counter 1)
4430 (and (> org-self-insert-command-undo-counter 0)
4431 buffer-undo-list
4432 (not (cadr buffer-undo-list)) ; remove nil entry
4433 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4434 (setq org-self-insert-command-undo-counter
4435 (1+ org-self-insert-command-undo-counter))))))))
4438 "Regular expression matching exponentials as produced by calc.")
4440 (defun orgtbl-gather-send-defs ()
4441 "Gather a plist of :name, :transform, :params for each destination before
4442 a radio table."
4443 (save-excursion
4444 (goto-char (org-table-begin))
4445 (let (rtn)
4446 (beginning-of-line 0)
4447 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4448 (let ((name (org-no-properties (match-string 1)))
4449 (transform (intern (match-string 2)))
4450 (params (if (match-end 3)
4451 (read (concat "(" (match-string 3) ")")))))
4452 (push (list :name name :transform transform :params params)
4453 rtn)
4454 (beginning-of-line 0)))
4455 rtn)))
4457 (defun orgtbl-send-replace-tbl (name txt)
4458 "Find and replace table NAME with TXT."
4459 (save-excursion
4460 (goto-char (point-min))
4461 (unless (re-search-forward
4463 (user-error "Don't know where to insert translated table"))
4464 (let ((beg (line-beginning-position 2)))
4465 (unless (re-search-forward
4466 (concat "END +RECEIVE +ORGTBL +" name) nil t)
4467 (user-error "Cannot find end of insertion region"))
4468 (beginning-of-line)
4469 (delete-region beg (point)))
4472 ;;;###autoload
4473 (defun org-table-to-lisp (&optional txt)
4474 "Convert the table at point to a Lisp structure.
4475 The structure will be a list. Each item is either the symbol `hline'
4476 for a horizontal separator line, or a list of field values as strings.
4477 The table is taken from the parameter TXT, or from the buffer at point."
4478 (unless (or txt (org-at-table-p)) (user-error "No table at point"))
4479 (let ((txt (or txt
4480 (buffer-substring-no-properties (org-table-begin)
4481 (org-table-end)))))
4482 (mapcar (lambda (x)
4483 (if (string-match org-table-hline-regexp x) 'hline
4487 (defun orgtbl-send-table (&optional maybe)
4488 "Send a transformed version of table at point to the receiver position.
4489 With argument MAYBE, fail quietly if no transformation is defined
4490 for this table."
4491 (interactive)
4492 (catch 'exit
4493 (unless (org-at-table-p) (user-error "Not at a table"))
4494 ;; when non-interactive, we assume align has just happened.
4495 (when (org-called-interactively-p 'any) (org-table-align))
4496 (let ((dests (orgtbl-gather-send-defs))
4497 (table (org-table-to-lisp
4498 (buffer-substring-no-properties (org-table-begin)
4499 (org-table-end))))
4500 (ntbl 0))
4501 (unless dests
4502 (if maybe (throw 'exit nil)
4503 (user-error "Don't know how to transform this table")))
4504 (dolist (dest dests)
4505 (let ((name (plist-get dest :name))
4506 (transform (plist-get dest :transform))
4507 (params (plist-get dest :params)))
4508 (unless (fboundp transform)
4509 (user-error "No such transformation function %s" transform))
4510 (orgtbl-send-replace-tbl name (funcall transform table params)))
4511 (incf ntbl))
4512 (message "Table converted and installed at %d receiver location%s"
4513 ntbl (if (> ntbl 1) "s" ""))
4514 (and (> ntbl 0) ntbl))))
4516 (defun org-remove-by-index (list indices &optional i0)
4517 "Remove the elements in LIST with indices in INDICES.
4518 First element has index 0, or I0 if given."
4519 (if (not indices)
4520 list
4521 (if (integerp indices) (setq indices (list indices)))
4522 (setq i0 (1- (or i0 0)))
4523 (delq :rm (mapcar (lambda (x)
4524 (setq i0 (1+ i0))
4525 (if (memq i0 indices) :rm x))
4526 list))))
4528 (defun orgtbl-toggle-comment ()
4529 "Comment or uncomment the orgtbl at point."
4530 (interactive)
4531 (let* ((case-fold-search t)
4532 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4533 (re2 (concat "^" orgtbl-line-start-regexp))
4534 (commented (save-excursion (beginning-of-line 1)
4535 (cond ((looking-at re1) t)
4536 ((looking-at re2) nil)
4537 (t (user-error "Not at an org table")))))
4538 (re (if commented re1 re2))
4539 beg end)
4540 (save-excursion
4541 (beginning-of-line 1)
4542 (while (looking-at re) (beginning-of-line 0))
4543 (beginning-of-line 2)
4544 (setq beg (point))
4545 (while (looking-at re) (beginning-of-line 2))
4546 (setq end (point)))
4547 (comment-region beg end (if commented '(4) nil))))
4549 (defun orgtbl-insert-radio-table ()
4550 "Insert a radio table template appropriate for this major mode."
4551 (interactive)
4552 (let* ((e (assq major-mode orgtbl-radio-table-templates))
4553 (txt (nth 1 e))
4554 name pos)
4555 (unless e (user-error "No radio table setup defined for %s" major-mode))
4556 (setq name (read-string "Table name: "))
4557 (while (string-match "%n" txt)
4558 (setq txt (replace-match name t t txt)))
4560 (setq pos (point))
4561 (insert txt)
4562 (goto-char pos)))
4564 ;;;###autoload
4565 (defun orgtbl-to-generic (table params)
4566 "Convert the orgtbl-mode TABLE to some other format.
4568 This generic routine can be used for many standard cases.
4570 TABLE is a list, each entry either the symbol `hline' for
4571 a horizontal separator line, or a list of fields for that
4572 line. PARAMS is a property list of parameters that can
4573 influence the conversion.
4575 Valid parameters are:
4577 :backend, :raw
4579 Export back-end used as a basis to transcode elements of the
4580 table, when no specific parameter applies to it. It is also
4581 used to translate cells contents. You can prevent this by
4582 setting :raw property to a non-nil value.
4584 :splice
4586 When non-nil, only convert rows, not the table itself. This is
4587 equivalent to setting to the empty string both :tstart
4588 and :tend, which see.
4590 :skip
4592 When set to an integer N, skip the first N lines of the table.
4593 Horizontal separation lines do count for this parameter!
4595 :skipcols
4597 List of columns that should be skipped. If the table has
4598 a column with calculation marks, that column is automatically
4599 discarded beforehand.
4601 :hline
4603 String to be inserted on horizontal separation lines. May be
4604 nil to ignore these lines altogether.
4606 :sep
4608 Separator between two fields, as a string.
4610 Each in the following group may be either a string or a function
4611 of no arguments returning a string:
4613 :tstart, :tend
4615 Strings to start and end the table. Ignored when :splice is t.
4617 :lstart, :lend
4619 Strings to start and end a new table line.
4621 :llstart, :llend
4623 Strings to start and end the last table line. Default,
4624 respectively, to :lstart and :lend.
4626 Each in the following group may be a string or a function of one
4627 argument (either the cells in the current row, as a list of
4628 strings, or the current cell) returning a string:
4630 :lfmt
4632 Format string for an entire row, with enough %s to capture all
4633 fields. When non-nil, :lstart, :lend, and :sep are ignored.
4635 :llfmt
4637 Format for the entire last line, defaults to :lfmt.
4639 :fmt
4641 A format to be used to wrap the field, should contain %s for
4642 the original field value. For example, to wrap everything in
4644 a property list with column numbers and format strings, or
4645 functions, e.g.,
4649 :hlstart :hllstart :hlend :hllend :hsep :hlfmt :hllfmt :hfmt
4651 Same as above, specific for the header lines in the table.
4652 All lines before the first hline are treated as header. If
4653 any of these is not present, the data line value is used.
4655 This may be either a string or a function of two arguments:
4657 :efmt
4659 Use this format to print numbers with exponential. The format
4660 should have %s twice for inserting mantissa and exponent, for
4662 list with column numbers and format strings or functions.
4663 :fmt will still be applied after :efmt."
4664 (let ((backend (plist-get params :backend)))
4665 (when (and backend (symbolp backend) (not (org-export-get-backend backend)))
4666 (user-error "Unknown :backend value"))
4667 (when (or (not backend) (plist-get params :raw)) (require 'ox-org))
4668 (org-trim
4669 (org-export-string-as
4670 ;; Return TABLE as Org syntax. Tolerate non-string cells.
4671 (with-output-to-string
4672 (dolist (e table)
4674 ((consp e)
4675 (princ "| ") (dolist (c e) (princ c) (princ " |"))
4677 ;; Build a custom back-end according to PARAMS. Before defining
4678 ;; a translator, check if there is anything to do. When there
4679 ;; isn't, let BACKEND handle the element.
4680 (org-export-create-backend
4681 :parent (or backend 'org)
4682 :filters
4683 '((:filter-parse-tree
4684 ;; Handle :skip parameter.
4685 (lambda (tree backend info)
4686 (let ((skip (plist-get info :skip)))
4687 (when skip
4688 (unless (wholenump skip) (user-error "Wrong :skip value"))
4689 (let ((n 0))
4690 (org-element-map tree 'table-row
4691 (lambda (row)
4692 (if (>= n skip) t
4693 (org-element-extract-element row)
4694 (incf n)
4695 nil))
4696 info t))
4697 tree)))
4698 ;; Handle :skipcols parameter.
4699 (lambda (tree backend info)
4700 (let ((skipcols (plist-get info :skipcols)))
4701 (when skipcols
4702 (unless (consp skipcols) (user-error "Wrong :skipcols value"))
4703 (org-element-map tree 'table
4704 (lambda (table)
4705 (let ((specialp
4706 (org-export-table-has-special-column-p table)))
4707 (dolist (row (org-element-contents table))
4708 (when (eq (org-element-property :type row) 'standard)
4709 (let ((c 1))
4710 (dolist (cell (nthcdr (if specialp 1 0)
4711 (org-element-contents row)))
4712 (when (memq c skipcols)
4713 (org-element-extract-element cell))
4714 (incf c)))))))
4715 info)
4716 tree)))))
4717 :transcoders
4718 `((table . ,(org-table--to-generic-table params))
4719 (table-row . ,(org-table--to-generic-row params))
4720 (table-cell . ,(org-table--to-generic-cell params))
4721 ;; Section. Return contents to avoid garbage around table.
4722 (section . (lambda (s c i) c))))
4723 'body-only (org-combine-plists params '(:with-tables t))))))
4725 (defun org-table--generic-apply (value name &optional with-cons &rest args)
4726 (cond ((null value) nil)
4727 ((functionp value) `(funcall ',value ,@args))
4728 ((stringp value)
4729 (cond ((consp (car args)) `(apply #'format ,value ,@args))
4730 (args `(format ,value ,@args))
4731 (t value)))
4732 ((and with-cons (consp value))
4733 `(let ((val (cadr (memq column ',value))))
4734 (cond ((null val) contents)
4735 ((stringp val) (format val ,@args))
4736 ((functionp val) (funcall val ,@args))
4737 (t (user-error "Wrong %s value" ,name)))))
4738 (t (user-error "Wrong %s value" name))))
4740 (defun org-table--to-generic-table (params)
4741 "Return custom table transcoder according to PARAMS.
4742 PARAMS is a plist. See `orgtbl-to-generic' for more
4743 information."
4744 (let ((backend (plist-get params :backend))
4745 (splice (plist-get params :splice))
4746 (tstart (plist-get params :tstart))
4747 (tend (plist-get params :tend)))
4748 `(lambda (table contents info)
4749 (concat
4750 ,(and tstart (not splice)
4752 ,(if (or (not backend) tstart tend splice) 'contents
4753 `(org-export-with-backend ',backend table contents info))
4754 ,(org-table--generic-apply (and (not splice) tend) ":tend")))))
4756 (defun org-table--to-generic-row (params)
4757 "Return custom table row transcoder according to PARAMS.
4758 PARAMS is a plist. See `orgtbl-to-generic' for more
4759 information."
4760 (let* ((backend (plist-get params :backend))
4761 (lstart (plist-get params :lstart))
4762 (llstart (plist-get params :llstart))
4763 (hlstart (plist-get params :hlstart))
4764 (hllstart (plist-get params :hllstart))
4765 (lend (plist-get params :lend))
4766 (llend (plist-get params :llend))
4767 (hlend (plist-get params :hlend))
4768 (hllend (plist-get params :hllend))
4769 (lfmt (plist-get params :lfmt))
4770 (llfmt (plist-get params :llfmt))
4771 (hlfmt (plist-get params :hlfmt))
4772 (hllfmt (plist-get params :hllfmt)))
4773 `(lambda (row contents info)
4774 (if (eq (org-element-property :type row) 'rule)
4775 ,(cond
4776 ((plist-member params :hline)
4777 (org-table--generic-apply (plist-get params :hline) ":hline"))
4778 (backend `(org-export-with-backend ',backend row nil info)))
4779 (let ((headerp (org-export-table-row-in-header-p row info))
4780 (lastp (not (org-export-get-next-element row info)))
4781 (last-header-p (org-export-table-row-ends-header-p row info)))
4782 (when contents
4783 ;; Check if we can apply `:lfmt', `:llfmt', `:hlfmt', or
4784 ;; `:hllfmt' to CONTENTS. Otherwise, fallback on
4785 ;; `:lstart', `:lend' and their relatives.
4786 ,(let ((cells
4787 '(org-element-map row 'table-cell
4788 (lambda (cell)
4789 ;; Export all cells, without separators.
4790 ;;
4791 ;; Use `org-export-data-with-backend'
4792 ;; instead of `org-export-data' to eschew
4793 ;; cached values, which
4794 ;; ignore :orgtbl-ignore-sep parameter.
4795 (org-export-data-with-backend
4796 cell
4797 (plist-get info :back-end)
4798 (org-combine-plists info '(:orgtbl-ignore-sep t))))
4799 info)))
4800 `(cond
4801 ,(and hllfmt
4802 `(last-header-p ,(org-table--generic-apply
4803 hllfmt ":hllfmt" nil cells)))
4804 ,(and hlfmt
4805 `(headerp ,(org-table--generic-apply
4806 hlfmt ":hlfmt" nil cells)))
4807 ,(and llfmt
4808 `(lastp ,(org-table--generic-apply
4809 llfmt ":llfmt" nil cells)))
4810 (t
4811 ,(if lfmt (org-table--generic-apply lfmt ":lfmt" nil cells)
4812 `(concat
4813 (cond
4814 ,(and
4815 (or hllstart hllend)
4816 `(last-header-p
4817 (concat
4818 ,(org-table--generic-apply hllstart ":hllstart")
4819 contents
4820 ,(org-table--generic-apply hllend ":hllend"))))
4821 ,(and
4822 (or hlstart hlend)
4823 `(headerp
4824 (concat
4825 ,(org-table--generic-apply hlstart ":hlstart")
4826 contents
4827 ,(org-table--generic-apply hlend ":hlend"))))
4828 ,(and
4829 (or llstart llend)
4830 `(lastp
4831 (concat
4832 ,(org-table--generic-apply llstart ":llstart")
4833 contents
4834 ,(org-table--generic-apply llend ":llend"))))
4835 (t
4836 ,(cond
4837 ((or lstart lend)
4838 `(concat
4839 ,(org-table--generic-apply lstart ":lstart")
4840 contents
4841 ,(org-table--generic-apply lend ":lend")))
4842 (backend
4843 `(org-export-with-backend
4844 ',backend row contents info))
4845 (t 'contents)))))))))))))))
4847 (defun org-table--to-generic-cell (params)
4848 "Return custom table cell transcoder according to PARAMS.
4849 PARAMS is a plist. See `orgtbl-to-generic' for more
4850 information."
4851 (let* ((backend (plist-get params :backend))
4852 (efmt (plist-get params :efmt))
4853 (fmt (plist-get params :fmt))
4854 (hfmt (plist-get params :hfmt))
4855 (sep (plist-get params :sep))
4856 (hsep (plist-get params :hsep)))
4857 `(lambda (cell contents info)
4858 (let ((headerp (org-export-table-row-in-header-p
4859 (org-export-get-parent-element cell) info))
4860 (column (1+ (cdr (org-export-table-cell-address cell info)))))
4861 ;; Make sure that contents are exported as Org data when :raw
4862 ;; parameter is non-nil.
4863 ,(when (and backend (plist-get params :raw))
4864 `(setq contents
4865 ;; Since we don't know what are the pseudo object
4866 ;; types defined in backend, we cannot pass them to
4867 ;; `org-element-interpret-data'. As a consequence,
4868 ;; they will be treated as pseudo elements, and
4869 ;; will have newlines appended instead of spaces.
4870 ;; Therefore, we must make sure :post-blank value
4871 ;; is really turned into spaces.
4872 (replace-regexp-in-string
4874 (org-trim
4875 (org-element-interpret-data
4876 (org-element-contents cell))))))
4877 (when contents
4878 ;; Check if we can apply `:efmt' on CONTENTS.
4879 ,(when efmt
4880 `(when (string-match orgtbl-exp-regexp contents)
4881 (let ((mantissa (match-string 1 contents))
4882 (exponent (match-string 2 contents)))
4883 (setq contents ,(org-table--generic-apply
4884 efmt ":efmt" t 'mantissa 'exponent)))))
4885 ;; Check if we can apply FMT (or HFMT) on CONTENTS.
4886 (cond
4887 ,(and hfmt `(headerp (setq contents ,(org-table--generic-apply
4888 hfmt ":hfmt" t 'contents))))
4889 ,(and fmt `(t (setq contents ,(org-table--generic-apply
4890 fmt ":fmt" t 'contents))))))
4891 ;; If a separator is provided, use it instead of BACKEND's.
4892 ;; Separators are ignored when LFMT (or equivalent) is
4893 ;; provided.
4894 ,(cond
4895 ((or hsep sep)
4896 `(if (or ,(and (not sep) '(not headerp))
4897 (plist-get info :orgtbl-ignore-sep)
4898 (not (org-export-get-next-element cell info)))
4899 ,(if (not backend) 'contents
4900 `(org-export-with-backend ',backend cell contents info))
4901 (concat contents
4902 ,(if (and sep hsep) `(if headerp ,hsep ,sep)
4903 (or hsep sep)))))
4904 (backend `(org-export-with-backend ',backend cell contents info))
4905 (t 'contents))))))
4907 ;;;###autoload
4908 (defun orgtbl-to-tsv (table params)
4909 "Convert the orgtbl-mode table to TAB separated material."
4912 ;;;###autoload
4913 (defun orgtbl-to-csv (table params)
4914 "Convert the orgtbl-mode table to CSV material.
4915 This does take care of the proper quoting of fields with comma or quotes."
4916 (orgtbl-to-generic table
4917 (org-combine-plists '(:sep "," :fmt org-quote-csv-field)
4918 params)))
4920 ;;;###autoload
4921 (defun orgtbl-to-latex (table params)
4922 "Convert the orgtbl-mode TABLE to LaTeX.
4924 TABLE is a list, each entry either the symbol `hline' for
4925 a horizontal separator line, or a list of fields for that line.
4926 PARAMS is a property list of parameters that can influence the
4927 conversion. All parameters from `orgtbl-to-generic' are
4928 supported. It is also possible to use the following ones:
4930 :booktabs
4934 :environment
4936 Specify environment to use, as a string. If you use
4938 as a string, to get proper continuation strings."
4939 (require 'ox-latex)
4940 (orgtbl-to-generic
4941 table
4942 (org-combine-plists
4943 ;; Provide sane default values.
4944 (list :backend 'latex
4945 :latex-default-table-mode 'table
4946 :latex-tables-centered nil
4947 :latex-tables-booktabs (plist-get params :booktabs)
4948 :latex-table-scientific-notation nil
4949 :latex-default-table-environment
4950 (or (plist-get params :environment) "tabular"))
4951 params)))
4953 ;;;###autoload
4954 (defun orgtbl-to-html (table params)
4955 "Convert the orgtbl-mode TABLE to HTML.
4957 TABLE is a list, each entry either the symbol `hline' for
4958 a horizontal separator line, or a list of fields for that line.
4959 PARAMS is a property list of parameters that can influence the
4960 conversion. All parameters from `orgtbl-to-generic' are
4961 supported. It is also possible to use the following one:
4963 :attributes
4965 Attributes and values, as a plist, which will be used in
4966 <table> tag."
4967 (require 'ox-html)
4968 (orgtbl-to-generic
4969 table
4970 (org-combine-plists
4971 ;; Provide sane default values.
4972 (list :backend 'html
4973 :html-table-data-tags '("<td%s>" . "</td>")
4974 :html-table-use-header-tags-for-first-column nil
4975 :html-table-align-individual-fields t
4976 :html-table-row-tags '("<tr>" . "</tr>")
4977 :html-table-attributes
4978 (if (plist-member params :attributes)
4979 (plist-get params :attributes)
4980 '(:border "2" :cellspacing "0" :cellpadding "6" :rules "groups"
4981 :frame "hsides")))
4982 params)))
4984 ;;;###autoload
4985 (defun orgtbl-to-texinfo (table params)
4986 "Convert the orgtbl-mode TABLE to Texinfo.
4988 TABLE is a list, each entry either the symbol `hline' for
4989 a horizontal separator line, or a list of fields for that line.
4990 PARAMS is a property list of parameters that can influence the
4991 conversion. All parameters from `orgtbl-to-generic' are
4992 supported. It is also possible to use the following one:
4994 :columns
4996 Column widths, as a string. When providing column fractions,
4998 (require 'ox-texinfo)
4999 (let ((output
5000 (orgtbl-to-generic
5001 table
5002 (org-combine-plists
5003 (list :backend 'texinfo
5004 :texinfo-tables-verbatim nil
5005 :texinfo-table-scientific-notation nil)
5006 params)))
5007 (columns (let ((w (plist-get params :columns)))
5008 (cond ((not w) nil)
5010 (t (concat "@columnfractions " w))))))
5011 (if (not columns) output
5012 (replace-regexp-in-string
5015 ;;;###autoload
5016 (defun orgtbl-to-orgtbl (table params)
5017 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
5019 TABLE is a list, each entry either the symbol `hline' for
5020 a horizontal separator line, or a list of fields for that line.
5021 PARAMS is a property list of parameters that can influence the
5022 conversion. All parameters from `orgtbl-to-generic' are
5023 supported.
5025 Useful when slicing one table into many. The :hline, :sep,
5026 :lstart, and :lend provide orgtbl framing. :tstart and :tend can
5027 be set to provide ORGTBL directives for the generated table."
5028 (require 'ox-org)
5029 (orgtbl-to-generic table (org-combine-plists params (list :backend 'org))))
5031 (defun orgtbl-to-table.el (table params)
5032 "Convert the orgtbl-mode TABLE into a table.el table.
5033 TABLE is a list, each entry either the symbol `hline' for
5034 a horizontal separator line, or a list of fields for that line.
5035 PARAMS is a property list of parameters that can influence the
5036 conversion. All parameters from `orgtbl-to-generic' are
5037 supported."
5038 (with-temp-buffer
5039 (insert (orgtbl-to-orgtbl table params))
5040 (org-table-align)
5041 (replace-regexp-in-string
5042 "-|" "-+"
5043 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
5045 (defun orgtbl-to-unicode (table params)
5046 "Convert the orgtbl-mode TABLE into a table with unicode characters.
5048 TABLE is a list, each entry either the symbol `hline' for
5049 a horizontal separator line, or a list of fields for that line.
5050 PARAMS is a property list of parameters that can influence the
5051 conversion. All parameters from `orgtbl-to-generic' are
5052 supported. It is also possible to use the following ones:
5054 :ascii-art
5057 the table. You can download it here:
5058 http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el.
5060 :narrow
5062 When non-nil, narrow columns width than provided width cookie,
5064 (require 'ox-ascii)
5065 (orgtbl-to-generic
5066 table
5067 (org-combine-plists
5068 (list :backend 'ascii
5069 :ascii-charset 'utf-8
5070 :ascii-table-keep-all-vertical-lines (plist-get params :)
5071 :ascii-table-widen-columns (not (plist-get params :narrow))
5072 :ascii-table-use-ascii-art (plist-get params :ascii-art))
5073 params)))
5075 ;; Put the cursor in a column containing numerical values
5076 ;; of an Org-Mode table,
5077 ;; type C-c " a
5078 ;; A new column is added with a bar plot.
5079 ;; When the table is refreshed (C-u C-c *),
5080 ;; the plot is updated to reflect the new values.
5082 (defun orgtbl-ascii-draw (value min max &optional width characters)
5083 "Draw an ascii bar in a table.
5084 VALUE is a the value to plot, the width of the bar to draw. A
5085 value equal to MIN will be displayed as empty (zero width bar).
5086 A value equal to MAX will draw a bar filling all the WIDTH.
5087 WIDTH is the expected width in characters of the column.
5088 CHARACTERS is a string that will compose the bar, with shades of
5089 grey from pure white to pure black. It defaults to a 10
5090 characters string of regular ascii characters."
5091 (let* ((characters (or characters " .:;c!lhVHW"))
5092 (width (or width 12))
5093 (value (if (numberp value) value (string-to-number value)))
5094 (value (* (/ (- (+ value 0.0) min) (- max min)) width)))
5095 (cond
5096 ((< value 0) "too small")
5097 ((> value width) "too large")
5098 (t
5099 (let ((len (1- (length characters))))
5100 (concat
5101 (make-string (floor value) (elt characters len))
5102 (string (elt characters
5103 (floor (* (- value (floor value)) len))))))))))
5105 ;;;###autoload
5106 (defun orgtbl-ascii-plot (&optional ask)
5107 "Draw an ascii bar plot in a column.
5108 With cursor in a column containing numerical values, this
5109 function will draw a plot in a new column.
5110 ASK, if given, is a numeric prefix to override the default 12
5111 characters width of the plot. ASK may also be the
5113 (interactive "P")
5114 (let ((col (org-table-current-column))
5115 (min 1e999) ; 1e999 will be converted to infinity
5116 (max -1e999) ; which is the desired result
5117 (table (org-table-to-lisp))
5118 (length
5119 (cond ((consp ask)
5120 (read-number "Length of column " 12))
5121 ((numberp ask) ask)
5122 (t 12))))
5123 ;; Skip any hline a the top of table.
5124 (while (eq (car table) 'hline) (setq table (cdr table)))
5125 ;; Skip table header if any.
5126 (dolist (x (or (cdr (memq 'hline table)) table))
5127 (when (consp x)
5128 (setq x (nth (1- col) x))
5129 (when (string-match
5131 x)
5132 (setq x (string-to-number x))
5133 (when (> min x) (setq min x))
5134 (when (< max x) (setq max x)))))
5135 (org-table-insert-column)
5136 (org-table-move-column-right)
5137 (org-table-store-formulas
5138 (cons
5139 (cons
5140 (number-to-string (1+ col))
5141 (format "'(%s $%s %s %s %s)"
5142 "orgtbl-ascii-draw" col min max length))
5143 (org-table-get-stored-formulas)))
5144 (org-table-recalculate t)))
5146 ;; Example of extension: unicode characters
5147 ;; Here are two examples of different styles.
5149 ;; Unicode block characters are used to give a smooth effect.
5150 ;; See http://en.wikipedia.org/wiki/Block_Elements
5151 ;; Use one of those drawing functions
5152 ;; - orgtbl-ascii-draw (the default ascii)
5153 ;; - orgtbl-uc-draw-grid (unicode with a grid effect)
5154 ;; - orgtbl-uc-draw-cont (smooth unicode)
5156 ;; This is best viewed with the "DejaVu Sans Mono" font
5157 ;; (use M-x set-default-font).
5159 (defun orgtbl-uc-draw-grid (value min max &optional width)
5160 "Draw a bar in a table using block unicode characters.
5161 It is a variant of orgtbl-ascii-draw with Unicode block
5162 characters, for a smooth display. Bars appear as grids (to the
5163 extent the font allows)."
5164 ;; http://en.wikipedia.org/wiki/Block_Elements
5165 ;; best viewed with the "DejaVu Sans Mono" font.
5166 (orgtbl-ascii-draw value min max width
5169 (defun orgtbl-uc-draw-cont (value min max &optional width)
5170 "Draw a bar in a table using block unicode characters.
5171 It is a variant of orgtbl-ascii-draw with Unicode block
5172 characters, for a smooth display. Bars are solid (to the extent
5173 the font allows)."
5174 (orgtbl-ascii-draw value min max width
5177 (defun org-table-get-remote-range (name-or-id form)
5178 "Get a field value or a list of values in a range from table at ID.
5180 NAME-OR-ID may be the name of a table in the current file as set
5182 will then be used. Alternatively, it may be an ID referring to
5183 any entry, also in a different file. In this case, the first
5184 table in that entry will be referenced.
5188 The return value is either a single string for a single field, or a
5189 list of the fields in the rectangle."
5190 (save-match-data
5191 (let ((case-fold-search t) (id-loc nil)
5192 ;; Protect a bunch of variables from being overwritten
5193 ;; by the context of the remote table
5194 org-table-column-names org-table-column-name-regexp
5195 org-table-local-parameters org-table-named-field-locations
5196 org-table-current-line-types org-table-current-begin-line
5197 org-table-current-begin-pos org-table-dlines
5198 org-table-current-ncol
5199 org-table-hlines org-table-last-alignment
5200 org-table-last-column-widths org-table-last-alignment
5201 org-table-last-column-widths tbeg
5202 buffer loc)
5203 (setq form (org-table-convert-refs-to-rc form))
5204 (save-excursion
5205 (save-restriction
5206 (widen)
5207 (save-excursion
5208 (goto-char (point-min))
5209 (if (re-search-forward
5212 nil t)
5213 (setq buffer (current-buffer) loc (match-beginning 0))
5214 (setq id-loc (org-id-find name-or-id 'marker))
5215 (unless (and id-loc (markerp id-loc))
5217 (setq buffer (marker-buffer id-loc)
5218 loc (marker-position id-loc))
5219 (move-marker id-loc nil)))
5220 (with-current-buffer buffer
5221 (save-excursion
5222 (save-restriction
5223 (widen)
5224 (goto-char loc)
5225 (forward-char 1)
5227 (not (match-beginning 1)))
5228 (user-error "Cannot find a table at NAME or ID %s" name-or-id))
5229 (setq tbeg (point-at-bol))
5230 (org-table-get-specials)
5231 (setq form (org-table-formula-substitute-names
5232 (org-table-formula-handle-first/last-rc form)))
5233 (if (and (string-match org-table-range-regexp form)
5234 (> (length (match-string 0 form)) 1))
5235 (save-match-data
5236 (org-table-get-range (match-string 0 form) tbeg 1))
5237 form)))))))))
5239 (defun org-table-remote-reference-indirection (form)
5240 "Return formula with table remote references substituted by indirection.
5242 This indirection works only with the format @ROW$COLUMN. The
5244 distinguished from a plain table name or ID."
5245 (let ((start 0))
5246 (while (string-match (concat
5247 ;; Same as in `org-table-eval-formula'.
5249 ;; Allow "$1", "@<", "$-1", "@<<$1" etc.
5251 ;; Same as in `org-table-eval-formula'.
5253 form
5254 start)
5255 ;; The position of the character as far as possible to the right
5256 ;; that will not be replaced and particularly not be shifted by
5257 ;; `replace-match'.
5258 (setq start (match-beginning 1))
5259 ;; Substitute the remote reference with the value found in the
5260 ;; field.
5261 (setq form
5262 (replace-match
5263 (save-match-data
5264 (org-table-get-range (org-table-formula-handle-first/last-rc
5265 (match-string 1 form))))
5266 t t form 1))))
5267 form)
5269 (defmacro org-define-lookup-function (mode)
5270 (let ((mode-str (symbol-name mode))
5271 (first-p (equal mode 'first))
5272 (all-p (equal mode 'all)))
5273 (let ((plural-str (if all-p "s" "")))
5274 `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
5275 ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
5276 If R-LIST is nil, return matching element%s of S-LIST.
5277 If PREDICATE is not nil, use it instead of `equal' to match VAL.
5278 Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
5279 This function is generated by a call to the macro `org-define-lookup-function'."
5280 mode-str plural-str plural-str plural-str)
5281 (let ,(let ((lvars '((p (or predicate 'equal))
5282 (sl s-list)
5283 (rl (or r-list s-list))
5284 (ret nil))))
5285 (if first-p (add-to-list 'lvars '(match-p nil)))
5286 lvars)
5287 (while ,(if first-p '(and (not match-p) sl) 'sl)
5288 (progn
5289 (if (funcall p val (car sl))
5290 (progn
5291 ,(if first-p '(setq match-p t))
5292 (let ((rval (car rl)))
5293 (setq ret ,(if all-p '(append ret (list rval)) 'rval)))))
5294 (setq sl (cdr sl) rl (cdr rl))))
5295 ret)))))
5297 (org-define-lookup-function first)
5298 (org-define-lookup-function last)
5299 (org-define-lookup-function all)
5301 (provide 'org-table)
5303 ;; Local variables:
5304 ;; generated-autoload-file: "org-loaddefs.el"
5305 ;; End:
5307 ;;; org-table.el ends here