| blob | 7b7d5f555d5fd62ac4c298734afe4c7a70f89ce8 |
1 ;;; org-table.el --- The table editor for Org-mode
3 ;; Copyright (C) 2004-2015 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 "Non-nil means relative formula references may cross hlines.
335 Here are the allowed values:
337 nil Relative references may not cross hlines. They will reference the
338 field next to the hline instead. Coming from below, the reference
339 will be to the field below the hline. Coming from above, it will be
340 to the field above.
341 t Relative references may cross hlines.
342 error An attempt to cross a hline will throw an error.
344 It is probably good to never set this variable to nil, for the sake of
345 portability of tables."
353 "Non-nil means that evaluation of a field formula can add new
354 columns if an out-of-bounds field is being set."
361 (const :tag "Setting an out-of-bounds field adds columns as needed, but issues a warning message" warn)
365 "Options concerning table import and export in Org-mode."
370 "Default export parameters for `org-table-export'.
371 These can be overridden for a specific table by setting the
372 TABLE_EXPORT_FORMAT property. See the manual section on orgtbl
373 radio tables for the different export transformations and
374 available parameters."
379 "Max lines that `org-table-convert-region' will attempt to process.
381 The function can be slow on larger regions; this safety feature
382 prevents it from hanging emacs."
422 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
423 ;; 1 2 3 4 5
434 "Is this a table line colgroup information?"
438 line)
440 nil
447 "Is this a table line with only alignment/width cookies?"
460 s))))
468 ;;;###autoload
470 "Use the table.el package to insert a new table.
471 If there is already a table at point, convert between Org-mode tables
472 and table.el tables."
485 ;;;###autoload
487 "Convert region to table, or create an empty table.
488 If there is an active region, convert it to a table, using the function
489 `org-table-convert-region'. See the documentation of that function
490 to learn how the prefix argument is interpreted to determine the field
491 separator.
492 If there is no such region, create an empty table with `org-table-create'."
498 ;;;###autoload
500 "Query for a size and insert a table skeleton.
520 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
524 ;; Insert a hline after the first row.
531 ;;;###autoload
533 "Convert region to a table.
534 The region goes from BEG0 to END0, but these borders will be moved
535 slightly, to make sure a beginning of line in the first line is included.
537 SEPARATOR specifies the field separator in the lines. It can have the
538 following values:
540 '(4) Use the comma as a field separator
541 '(16) Use a TAB as field separator
542 '(64) Prompt for a regular expression as field separator
543 integer When a number, use that many spaces as field separator
544 regexp When a regular expression, use it to match the separator
545 nil When nil, the command tries to be smart and figure out the
546 separator in the following way:
547 - when each line contains a TAB, assume TAB-separated material
548 - when each line contains a comma, assume CSV material
549 - else, assume one or more SPACE characters as separator."
553 re)
555 (user-error "Region is longer than `org-table-convert-region-max-lines' (%s) lines; not converting"
556 org-table-convert-region-max-lines)
565 ;; Get the right field separator
576 ;; parse the csv stuff
601 ;;;###autoload
603 "Import FILE as a table.
604 The file is assumed to be tab-separated. Such files can be produced by most
605 spreadsheet and database applications. If no tabs (at least one per line)
606 are found, lines will be split on whitespace into fields."
615 ;;;###autoload
617 "Export table to a file, with configurable format.
618 Such a file can be imported into usual spreadsheet programs.
620 FILE can be the output file name. If not given, it will be taken
621 from a TABLE_EXPORT_FILE property in the current entry or higher
622 up in the hierarchy, or the user will be prompted for a file
623 name. FORMAT can be an export format, of the same kind as it
624 used when `orgtbl-mode' sends a table in a different format.
626 The command suggests a format depending on TABLE_EXPORT_FORMAT,
627 whether it is set locally or up in the hierarchy, then on the
628 extension of the given file name, and finally on the variable
629 `org-table-export-default-format'."
662 formats)))
663 org-table-export-default-format)
689 "Marker at the beginning of the table last aligned.
692 "Marker at the end of the table last aligned.
695 "List of flags for flushright alignment, from the last re-alignment.
698 "List of max width of fields in each column.
701 "Non-nil means debug table formulas.
713 ;;;###autoload
715 "Align the table at point by aligning all vertical bars."
718 ;; Limits of table
721 ;; Current cursor position
727 column
729 rfmt hfmt
737 emptystrings links dates emph raise narrow
738 falign falign1 fmax f1 f2 len c e space)
741 ;; Check if we have links or dates
753 ;; Make sure the link properties are right
755 ;; Make sure the date properties are right
760 ;; Check if we are narrowing any columns
763 org-format-transports-properties-p
768 ;; Get the rows
771 ;; Store the indentation of the first line
774 ;; Mark the hlines by setting the corresponding element to nil
775 ;; At the same time, we remove trailing space.
778 nil
781 l)))
782 lines))
783 ;; Get the data fields by splitting the lines.
788 ;; How many fields in the longest line?
795 ;; A list of empty strings to fill any short rows on output
797 ;; Check for special formatting.
801 ;; Check if there is an explicit width specified
811 ;; Find fields that are wider than fmax, and shorten them
817 'help-echo
826 f2)
830 f1)
836 xx)))))
837 ;; Get the maximum width for each column
839 lengths)
840 ;; Get the fraction of numbers, to decide about alignment of the column
846 nil
853 ;; Store the alignment of this table, for later editing of single fields
855 org-table-last-column-widths lengths)
857 ;; With invisible characters, `format' does not get the field width right
858 ;; So we need to make these fields wide by hand.
876 ;; Compute the formats needed for output of the table
889 hfmt))
893 ;; Replace the old one
900 ;; Try to move to the old location
909 ))
911 ;;;###autoload
913 "Find the beginning of the table and return its position.
914 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
918 ;;;###autoload
920 "Find the end of the table and return its position.
921 With argument TABLE-TYPE, go to the end of a table.el-type table."
931 ;;;###autoload
933 "Justify the current field, text to left, number to right.
934 Optional argument NEW may specify text to replace the current field content."
943 ;; This is not the same table, force a full re-align
949 l f n o e)
975 ;;;###autoload
977 "Go to the next field in the current table, creating new lines as needed.
978 Before doing so, re-align the table if necessary."
983 org-table-may-need-update)
994 org-table-tab-jumps-over-hlines
1005 ;;;###autoload
1007 "Go to the previous field in the table.
1008 Before doing so, re-align the table if necessary."
1013 org-table-may-need-update)
1028 "Move to the beginning of the current table field.
1029 If already at or before the beginning, move to the beginning of the
1030 previous field.
1031 With numeric argument N, move N-1 fields backward first."
1044 "Move to the end of the current table field.
1045 If already at or after the end, move to the end of the next table field.
1046 With numeric argument N, move N-1 fields forward first."
1059 ;;;###autoload
1061 "Go to the next row (same column) in the current table.
1062 Before doing so, re-align the table if necessary."
1070 org-table-may-need-update)
1083 ;;;###autoload
1085 "Copy the value of the current field one row below.
1087 If the field at the cursor is empty, copy the content of the
1088 nearest non-empty field above. With argument N, use the Nth
1089 non-empty field.
1091 If the current field is not empty, it is copied down to the next
1092 row, and the cursor is moved with it. Therefore, repeating this
1093 command causes the column to be filled row-by-row.
1095 If the variable `org-table-copy-increment' is non-nil and the
1096 field is an integer or a timestamp, it will be incremented while
1097 copying. By default, increment by the difference between the
1098 value in the current field and the one in the field above. To
1099 increment using a fixed integer, set `org-table-copy-increment'
1100 to a number. In the case of a timestamp, increment by days."
1112 txt txt-up inc)
1120 beg t))
1130 beg t))
1137 ;; Above field was not empty, go down to the next row
1170 "Is point inside a table data field?
1171 I.e. not on a hline or before the first or after the last column?
1172 This actually throws an error, so it aborts the current command."
1178 nil
1180 t))
1186 "Get the field in table line LINE, column COLUMN.
1187 If LINE is larger than the number of data lines in the table, the function
1188 returns nil. However, if COLUMN is too large, we will simply return an
1189 empty string.
1190 If LINE is nil, use the current line.
1191 If COLUMN is nil, use the current column."
1198 "Put VALUE into line LINE, column COLUMN.
1199 When ALIGN is set, also realign the table."
1208 "Return the index of the current data line."
1215 cnt))
1218 "Go to the Nth data line in the current table.
1219 Return t when the line exists, nil if it does not exist."
1226 ;;;###autoload
1228 "Blank the current table field or active region."
1245 "Return the value of the field in column N of current row.
1246 N defaults to current field.
1247 If REPLACE is a string, replace field with this value. The return value
1248 is always the old value."
1257 t t))
1259 val)
1262 ;;;###autoload
1264 "Show info about the current field, and highlight any reference at point."
1273 org-table-named-field-locations)))
1293 dline col
1295 dline col ref1
1297 ;; FIXME: formula info not correct if special table line
1307 "Find out which column we are in."
1317 cnt)))
1319 ;;;###autoload
1321 "Find out what table data line we are in.
1322 Only data lines count for this."
1334 cnt)))
1336 ;;;###autoload
1338 "Move the cursor to the Nth column in the current table line.
1339 With optional argument ON-DELIM, stop with point before the left delimiter
1340 of the field.
1341 If there are less than N fields, just go to after the last delimiter.
1342 However, when FORCE is non-nil, create new columns if necessary."
1352 t)))))
1359 ;;;###autoload
1361 "Insert a new column into the table."
1369 ;; Current cursor position
1375 nil
1389 "Find a data line in the current table, which is needed for column commands."
1392 t
1403 t
1408 "Turn a buffer line number into a data line number.
1409 If there is no data line in this line, return nil.
1410 If there is no matching dline (most likely te reference was a hline), the
1411 first dline below it is used. When ABOVE is non-nil, the one above is used."
1414 i)
1427 nil))
1429 ;;;###autoload
1431 "Delete a column from the table."
1440 ;; Current cursor position
1446 nil
1462 ;;;###autoload
1464 "Move column to the right."
1467 ;;;###autoload
1469 "Move column to the left."
1473 ;;;###autoload
1475 "Move the current column to the right. With arg LEFT, move to the left."
1485 ;; Current cursor position
1495 nil
1513 ;;;###autoload
1515 "Move table row down."
1518 ;;;###autoload
1520 "Move table row up."
1524 ;;;###autoload
1526 "Move the current table line down. With arg UP, move it up."
1535 txt hline2p)
1558 ;;;###autoload
1560 "Insert a new row above the current line into the table.
1561 With prefix ARG, insert below the current line."
1567 ;; Fix the first field if necessary
1580 ;;;###autoload
1582 "Insert a horizontal-line below the current line into the table.
1583 With prefix ABOVE, insert above the current line."
1604 ;;;###autoload
1606 "Insert a hline and move to the row below that line."
1620 In particular, this does handle wide and invisible characters."
1622 ;; It's a hline, just map the characters
1628 t t s)))
1629 s))
1631 ;;;###autoload
1633 "Delete the current row or horizontal line from the table."
1647 ;;;###autoload
1649 "Sort table lines according to the column at point.
1651 The position of point indicates the column to be used for
1652 sorting, and the range of lines is the range between the nearest
1653 horizontal separator lines, or the entire table of no such lines
1654 exist. If point is before the first column, you will be prompted
1655 for the sorting column. If there is an active region, the mark
1656 specifies the first line and the sorting column, while point
1657 should be in the last line to be included into the sorting.
1659 The command then prompts for the sorting type which can be
1660 alphabetically, numerically, or by time (as given in a time stamp
1661 in the field, or as a HH:MM value). Sorting in reverse order is
1662 also possible.
1664 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1666 If SORTING-TYPE is specified when this function is called from a Lisp
1667 program, no prompting will take place. SORTING-TYPE must be a character,
1668 any of (?a ?A ?n ?N ?t ?T ?f ?F) where the capital letters indicate that
1669 sorting should be done in reverse order.
1671 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
1672 a function to be called to extract the key. It must return either
1673 a string or a number that should serve as the sorting key for that
1674 row. It will then use COMPARE-FUNC to compare entries. If GETKEY-FUNC
1675 is specified interactively, the comparison will be either a string or
1676 numeric compare based on the type of the first key in the table."
1681 beg end bcol ecol tend tbeg column lns pos)
1726 x))
1741 (defun org-table--do-sort (table what &optional with-case sorting-type getkey-func compare-func)
1742 "Sort TABLE of WHAT according to SORTING-TYPE.
1743 The user will be prompted for the SORTING-TYPE if the call to this
1744 function does not specify it.
1745 WHAT is only for the prompt, to indicate what is being sorted.
1746 The sorting key will be extracted from the car of the elements of
1747 the table. If WITH-CASE is non-nil, the sorting will be case-sensitive.
1749 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
1750 a function to be called to extract the key. It must return either
1751 a string or a number that should serve as the sorting key for that
1752 row. It will then use COMPARE-FUNC to compare entries. If GETKEY-FUNC
1753 is specified interactively, the comparison will be either a string or
1754 numeric compare based on the type of the first key in the table."
1757 "Sort %s: [a]lphabetic, [n]umeric, [t]ime, [f]unc. A/N/T/F means reversed:"
1758 what)
1761 ;; Define the appropriate functions
1784 "Sort using function: "
1789 tempfun))
1800 table)
1803 ;;;###autoload
1805 "Copy region in table to the clipboard and blank all relevant fields.
1806 If there is no active region, use just the field at point."
1812 ;;;###autoload
1814 "Copy rectangular region in table to clipboard.
1815 A special clipboard is used which can only be accessed
1816 with `org-table-paste-rectangle'."
1820 current-prefix-arg))
1822 region cols
1848 org-table-clip))
1850 ;;;###autoload
1852 "Paste a rectangular region into a table.
1853 The upper right corner ends up in the current field. All involved fields
1854 will be overwritten. If the rectangle does not fit into the present table,
1855 the table is enlarged as needed. The process ignores horizontal separator
1856 lines."
1866 c cols field)
1881 ;;;###autoload
1883 "Convert from `org-mode' table to table.el and back.
1884 Obviously, this only works within limits. When an Org-mode table is
1885 converted to table.el, all horizontal separator lines get lost, because
1886 table.el uses these as cell boundaries and has no notion of horizontal lines.
1887 A table.el table can be converted to an Org-mode table only if it does not
1888 do row or column spanning. Multiline cells will become multiple cells.
1889 Beware, Org-mode does not test if the table can be successfully converted - it
1890 blindly applies a recipe that works for simple tables."
1894 ;; convert to Org-mode table
1903 ;; convert to table.el table
1906 ;; first, get rid of all horizontal lines
1910 ;; insert a hline before first
1914 ;; insert a hline after each line
1919 ;; replace "+" at beginning and ending of hlines
1928 "Transpose Org table at point and eliminate hlines.
1929 So a table like
1931 | 1 | 2 | 4 | 5 |
1932 |---+---+---+---|
1933 | a | b | c | d |
1934 | e | f | g | h |
1936 will be transposed as
1938 | 1 | a | e |
1939 | 2 | b | f |
1940 | 4 | c | g |
1941 | 5 | d | h |
1943 Note that horizontal lines disappear."
1955 table)))
1969 ;;;###autoload
1971 "Wrap several fields in a column like a paragraph.
1972 This is useful if you'd like to spread the contents of a field over several
1973 lines, in order to keep the table compact.
1975 If there is an active region, and both point and mark are in the same column,
1976 the text in the column is wrapped to minimum width for the given number of
1977 lines. Generally, this makes the table more compact. A prefix ARG may be
1979 formats the selected text to two lines. If the region was longer than two
1980 lines, the remaining lines remain empty. A negative prefix argument reduces
1981 the current number of lines by that amount. The wrapped text is pasted back
1982 into the table. If you formatted it to more lines than it was before, fields
1983 further down in the table get overwritten - so you might need to make space in
1984 the table first.
1986 If there is no region, the current field is split at the cursor position and
1987 the text fragment to the right of the cursor is prepended to the field one
1988 line down.
1990 If there is no region, but you specify a prefix ARG, the current field gets
1991 blank, and the content is appended to the field above."
1995 ;; There is a region: fill as a paragraph
1999 nlines)
2006 arg)
2010 nil nlines)))
2014 ;; No region, split the current field at point
2018 ;; combine with field above
2028 ;; split field
2040 ;;;###autoload
2042 "Edit table field in a different window.
2043 This is mainly useful for fields that contain hidden parts.
2045 it can be edited in place."
2054 display t intangible t))
2067 p)
2083 intangible t))
2091 "Finish editing a table data field.
2092 Remove all newline characters, insert the result into the table, realign
2093 the table and kill the editing buffer."
2097 text)
2114 "Minor mode to make the table field editor window follow the cursor.
2115 When this mode is active, the field editor window will always show the
2116 current field. The mode exits automatically when the cursor leaves the
2117 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
2118 nil " TblFollow" nil
2134 ;; We have left the table, exit the follow mode
2144 ;;;###autoload
2146 "Sum numbers in region of current table column.
2147 The result will be displayed in the echo area, and will be available
2150 If there is an active region, it is interpreted as a rectangle and all
2151 numbers in that rectangle will be summed. If there is no active
2152 region and point is located in a table column, sum all numbers in that
2153 column.
2155 If at least one number looks like a time HH:MM or HH:MM:SS, all other
2156 numbers are assumed to be times as well (in decimal hours) and the
2157 numbers are added as such.
2159 If NLAST is a number, only the NLAST fields will actually be summed."
2186 items1)))
2193 s diff)
2201 sres))))
2224 "Return the formula active for the current field.
2225 Assumes that specials are in place.
2226 If KEY is given, return the key to this formula.
2230 org-table-named-field-locations)))
2244 "Read a formula from the minibuffer, offer stored formula as default.
2245 When NAMED is non-nil, look for a named equation."
2249 org-table-named-field-locations)))
2256 name
2257 ref)
2267 stored)
2269 equation)
2276 scol))
2278 'org-table-formula-history
2279 )))))
2280 mustsave)
2282 ;; remove formula
2289 ;; We set the column equation, delete the named one.
2291 mustsave t))
2297 eq))
2300 "Store the list of formulas below the current table."
2307 ;; don't overwrite TBLFM, we might use text properties to store stuff
2323 ;; Fake a high number to make sure this is sorted at the end.
2330 a)
2340 "Compare two formulas for sorting."
2345 ;;;###autoload
2347 "Return an alist with the stored formulas directly after current table."
2356 (when (string-match "\\`\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*[^ \t]\\)" string)
2375 "Modify the equations after the table structure has been edited.
2377 For all numbers larger than LIMIT, shift them by DELTA."
2389 s n a)
2395 "Change makes TBLFM term %s invalid, use undo to recover"
2411 "Get the column names and local parameters for this table."
2414 names name fields fields1 field cnt
2415 c v l line col types dlines hlines last-dline)
2417 org-table-local-parameters nil
2418 org-table-named-field-locations nil
2419 org-table-current-begin-line nil
2420 org-table-current-begin-pos nil
2421 org-table-current-line-types nil
2440 org-table-local-parameters))))
2456 ;; Analyse the line types
2460 l org-table-current-begin-line)
2477 al al2)
2487 ;;;###autoload
2490 If yes, store the formula and apply it."
2491 ;; We already know we are in a table. Get field will only return a formula
2492 ;; when appropriate. It might return a separator line, but no problem.
2495 named eq)
2506 "List of commands triggering the recalculation of a line.
2518 ;;;###autoload
2520 "Rotate the recalculation mark in the first column.
2521 If in any row, the first field is not consistent with a mark,
2522 insert a new column for the markers.
2523 When there is an active region, change all the lines in the region,
2524 after prompting for the marking character.
2525 After each change, a message will be displayed indicating the meaning
2526 of the new mark."
2541 epos new)
2548 newchar))
2580 ;;;###autoload
2582 "Recompute the current line if marked for it, and if we haven't just done it."
2602 org-tbl-calc-modes)
2604 ;;;###autoload
2606 suppress-align suppress-const
2607 suppress-store suppress-analysis)
2608 "Replace the table field value at the cursor by the result of a calculation.
2610 This function makes use of Dave Gillespie's Calc package, in my view the
2611 most exciting program ever written for GNU Emacs. So you need to have Calc
2612 installed in order to use this function.
2614 In a table, this command replaces the value in the current field with the
2616 formula, by storing it in a special line below the table. When called
2617 with a `C-u' prefix, the current field must be a named field, and the
2618 formula is installed as valid in only this specific field.
2620 When called with two `C-u' prefixes, insert the active equation
2621 for the field back into the current field, so that it can be
2623 to check the referenced fields.
2625 When called, the command first prompts for a formula, which is read in
2626 the minibuffer. Previously entered formulas are available through the
2627 history list, and the last used formula is offered as a default.
2628 These stored formulas are adapted correctly when moving, inserting, or
2629 deleting columns with the corresponding commands.
2631 The formula can be any algebraic expression understood by the Calc package.
2632 For details, see the Org-mode manual.
2634 This function can also be called from Lisp programs and offers
2635 additional arguments: EQUATION can be the formula to apply. If this
2636 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2637 used to speed-up recursive calls by by-passing unnecessary aligns.
2638 SUPPRESS-CONST suppresses the interpretation of constants in the
2639 formula, assuming that this has been done already outside the function.
2640 SUPPRESS-STORE means the formula should not be stored, either because
2641 it is already stored, or because it is a modified equation that should
2642 not overwrite the stored one."
2658 equation
2664 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2665 duration duration-output-format)
2666 ;; Parse the format string. Since we have a lot of modes, this is
2667 ;; a lot of work. However, I think calc still uses most of the time.
2680 'calc-float-format
2683 n))))
2687 duration-output-format nil
2691 duration-output-format org-table-duration-custom-format
2692 numbers t
2715 ;; replace fields with duration values if relevant
2719 fields)))
2725 x))
2726 fields)))
2732 ;; Insert row and column number of formula result field
2743 t t form)))
2745 ;; Check for old vertical references
2747 ;; Insert remote references
2760 rmtrng))
2761 keep-empty numbers lispp))
2762 t t form)))
2763 ;; Insert complex ranges
2771 ;; possibly handle durations
2776 formrg)
2777 keep-empty numbers lispp)))
2782 ;; Insert simple ranges, i.e. included in the current row.
2785 form)
2795 keep-empty numbers lispp))
2796 t t form)))
2798 ;; Insert the references to fields in same row
2805 x keep-empty numbers lispp)))
2823 ;; Use <...> time-stamps so that Calc can handle them
2826 ;; I18n-ize local time-stamps by setting (system-time-locale "C")
2837 form
2844 duration-output-format)
2845 ev)))
2850 Orig: %s
2851 $xyz-> %s
2852 @r$c-> %s
2884 prop value)))
2887 "Get a calc vector from a column, according to descriptor DESC.
2888 Optional arguments TBEG and COL can give the beginning of the table and
2889 the current column, to avoid unnecessary parsing.
2891 HIGHLIGHT means just highlight the range.
2893 When CORNERS-ONLY is set, only return the corners of the range as
2894 a list (line1 column1 line2 column2) where line1 and line2 are line numbers
2895 in the buffer and column1 and column2 are table column numbers."
2902 beg end c1 c2 r1 r2 rangep tmp)
2919 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2926 ;; just one field
2933 ;; A range, return a vector
2934 ;; First sort the numbers to get a regular rectangle
2938 ;; Only return the corners of the range
2940 ;; Copy the range values into a list
2954 ;; return string representation of calc vector
2959 "Analyze descriptor DESC and retrieve the corresponding line number.
2960 The cursor is currently in line CLINE, the table begins in line BLINE,
2961 and TABLE is a vector with line types."
2969 ;; 1 2 3 4 5 6
2989 nil hn cline desc)))
2992 rel on cline desc)))
2996 "FIXME: Needs more documentation."
3009 nil))
3010 t)))
3014 desc cline))
3015 ;; The last hline doesn't exist. Instead, point to last row
3016 ;; in table.
3025 "Convert list ELEMENTS to something appropriate to insert into formula.
3026 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
3027 NUMBERS indicates that everything should be converted to numbers.
3028 LISPP non-nil means to return something appropriate for a Lisp
3029 list, 'literal is for the format specifier L."
3030 ;; Calc nan (not a number) is used for the conversion of the empty
3031 ;; field to a reference for several reasons: (i) It is accepted in a
3032 ;; Calc formula (e. g. "" or "()" would result in a Calc error).
3033 ;; (ii) In a single field (not in range) it can be distinguished
3034 ;; from "(nan)" which is the reference made from a single field
3035 ;; containing "nan".
3037 ;; field reference
3040 elements
3042 ""
3051 ;; range reference
3056 elements))))
3062 x
3070 x)
3072 elements
3076 "If there has been more than one second since T1, display message.
3077 ARGS are passed as arguments to the `message' function. Returns
3078 current time if a message is printed, otherwise returns T1. If
3079 T1 is nil, always messages."
3083 curtime)
3084 t1)))
3086 ;;;###autoload
3088 "Recalculate the current table line by applying all stored formulas.
3089 With prefix arg ALL, do this for all lines in the table.
3090 With the prefix argument ALL is `(16)' \
3092 it is the symbol `iterate', recompute the table until it no longer changes.
3093 If NOALIGN is not nil, do not re-align the table after the computations
3094 are done. This is typically used internally to save time, if it is
3095 known that the table will be realigned a little later anyway."
3112 seen-fields lhs1
3114 ;; Insert constants in all formulas
3134 eqlist))
3135 ;; Split the equation list
3141 ;; Expand ranges in lhs of formulas
3144 ;; Get the correct line range to process
3150 ;; This is a table with marked lines, compute selected lines
3152 ;; Move forward to the first non-header line
3162 ;; First find the named fields, and mark them untouchable.
3163 ;; Also check if several field/range formulas try to set the same field.
3182 name)))
3195 ;; Now evaluate the column formulas, but skip fields covered
3196 ;; by field formulas
3200 ;; Unprotected line, recalculate
3204 log-last-time
3216 ;; Now evaluate the field formulas
3236 t))
3251 log-first-time
3255 ;; back to initial position
3264 ;;;###autoload
3266 "Recalculate the table until it does not change anymore.
3267 The maximum number of iterations is 10, but you can choose a different value
3268 with the prefix ARG."
3273 thistbl)
3287 ;;;###autoload
3289 "Recalculate all tables in the current buffer."
3296 ;;;###autoload
3298 "Iterate all tables in the buffer, to converge inter-table dependencies."
3303 c1)
3319 "Apply the #+TBLFM in the line at point to the table."
3326 ;; Insert a temporary formula at right after the table
3331 ;; Recalculate the table.
3336 ;; Delete the formula inserted temporarily.
3342 "Find the beginning of the TBLFM lines and return its position.
3343 Return nil when the beginning of TBLFM line was not found."
3350 "Expand list of formulas.
3351 If some of the RHS in the formulas are ranges or a row reference, expand
3352 them to individual field equations for each field."
3358 ;; This just refers to one fixed field
3361 ;; This just refers to one fixed named field
3383 "Replace @<, @>, $<, $> with first/last row/column of the table.
3384 So @< and $< will always be replaced with @1 and $1, respectively.
3385 The advantage of these special markers are that structure editing of
3386 the table will not change them, while @1 and $1 will be modified
3387 when a line/row is swapped out of that privileged position. So for
3388 formulas that use a range of rows or columns, it may often be better
3390 borders of the table using the @< @> $< $> makers."
3393 s start)
3398 org-table-current-ncol)
3402 len
3409 s)
3412 "Replace $const with values in string F."
3417 org-table-column-name-regexp
3420 org-table-column-names))))
3421 f t t)))
3422 ;; Parameters and constants.
3426 new start))
3429 ;; When a duration is expected, convert value on the fly.
3435 v)))))
3442 "Find the value for a parameter or constant in a formula.
3443 Parameters get priority."
3474 map))
3481 "--"
3484 "--"
3485 "Shift Reference at Point"
3490 "-"
3491 "Change Test Row for Column Formulas"
3494 "--"
3499 org-table-overlay-coordinates)]
3500 "--"
3506 ;;;###autoload
3508 "Edit the formulas of the current table in a separate buffer."
3510 (when (save-excursion (beginning-of-line 1) (let ((case-fold-search t)) (looking-at "[ \t]*#\\+TBLFM")))
3524 entry s type title)
3527 ;; Keep global-font-lock-mode from turning on font-lock-mode
3568 "Convert a formula from internal to user representation."
3571 s))
3574 "Convert a formula from user to internal representation."
3577 s))
3580 "Convert spreadsheet references from A7 to @7$28.
3581 Works for single references, but also for entire formulas and even the
3582 full TBLFM line."
3584 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3587 ;; format match, just advance
3592 ;; 3.e5 or something like this.
3595 ;; (member (match-string 1 s)
3596 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3597 )
3598 ;; function name, just advance
3608 t t s)))))
3609 s))
3612 "Convert spreadsheet references from to @7$28 to AB7.
3613 Works for single references, but also for entire formulas and even the
3614 full TBLFM line."
3621 t t s)))
3626 t nil s)))
3627 s)
3630 "Convert a base 26 number represented by letters into an integer.
3631 For example: AB -> 28."
3637 n))
3640 "Convert an integer into a base 26 number represented by letters.
3641 For example: 28 -> AB."
3646 s))
3649 "Convert a time string into numerical duration in seconds.
3650 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3651 If S is a string representing a number, keep this number."
3653 s
3676 "Convert a number of seconds to a time string.
3677 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3678 minutes or seconds."
3693 "Convert all references in this buffer, using FUNCTION."
3703 "Convert all references in the buffer from B3 to @3$2 and back."
3713 "Shift the reference at point one row/hline up."
3717 "Shift the reference at point one row/hline down."
3721 "Shift the reference at point one field to the left."
3725 "Shift the reference at point one field to the right."
3736 ;; A B3-like reference
3742 ;; An internal reference
3748 "Re-match the group N, and replace it with the shifted reference."
3753 t t)))
3756 "Shift a reference part REF.
3757 If DECR is set, decrease the references row/column, else increase.
3758 If HLINE is set, this may be a hline reference, it certainly is not
3759 a translation reference."
3788 "Toggle the display of coordinates in the referenced table."
3797 "Parse the buffer for formula definitions and install them.
3798 With prefix ARG, apply the new formulas to the table."
3808 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3809 nil t)
3833 "Abort editing formulas, without installing the changes."
3844 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3885 "Show the location/value of the $ expression at point."
3894 var name e what match dest)
3899 "$1.."
3982 ;; column number
4010 org-table-fedit-scroll-down))))
4022 "Make sure the cursor is in a dataline in a table."
4031 p1 p2)))
4036 "Move cursor one line up in the window showing the table."
4041 "Move cursor one line down in the window showing the table."
4046 "Move the cursor in the window showing the table.
4047 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
4072 "Add a new overlay."
4078 "Highlight rectangular region in a table."
4082 l1 c1 l2 c2 tmp)
4106 "Remove the rectangle overlays."
4117 "Add overlays to the table at point, to show row/column coordinates."
4145 ;;;###autoload
4147 "Toggle the display of Row/Column numbers in tables."
4158 ;;;###autoload
4160 "Toggle the formula debugger in tables."
4166 ;;; The orgtbl minor mode
4168 ;; Define a minor mode which can be used in other modes in order to
4169 ;; integrate the org-mode table editor.
4171 ;; This is really a hack, because the org-mode table editor uses several
4172 ;; keys which normally belong to the major mode, for example the TAB and
4173 ;; RET keys. Here is how it works: The minor mode defines all the keys
4174 ;; necessary to operate the table editor, but wraps the commands into a
4175 ;; function which tests if the cursor is currently inside a table. If that
4176 ;; is the case, the table editor command is executed. However, when any of
4177 ;; those keys is used outside a table, the function uses `key-binding' to
4178 ;; look up if the key has an associated command in another currently active
4179 ;; keymap (minor modes, major mode, global), and executes that command.
4180 ;; There might be problems if any of the keys used by the table editor is
4181 ;; otherwise used as a prefix key.
4183 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
4184 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
4185 ;; addresses this by checking explicitly for both bindings.
4187 ;; The optimized version (see variable `orgtbl-optimized') takes over
4188 ;; all keys which are bound to `self-insert-command' in the *global map*.
4189 ;; Some modes bind other commands to simple characters, for example
4190 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
4191 ;; active, this binding is ignored inside tables and replaced with a
4192 ;; modified self-insert.
4210 ;; Install it as a minor mode.
4214 ;;;###autoload
4216 "The `org-mode' table editor as a minor mode for use in other modes."
4221 ;; Exit without error, in case some hook functions calls this
4222 ;; by accident in org-mode.
4226 ;; Make sure we are first in minor-mode-map-alist
4228 ;; FIXME: maybe it should use emulation-mode-map-alists?
4235 auto-fill-inhibit-regexp)
4239 auto-fill-inhibit-regexp)
4240 orgtbl-line-start-regexp))
4258 "Remove all properties related to narrow-column invisibility."
4271 "Create a function for binding in the table minor mode.
4272 FUN is the command to call inside a table. N is used to create a unique
4273 command name. KEYS are keys that should be checked in for a command
4274 to execute outside of tables."
4280 "Outside of tables, run the binding of `"
4292 keys)
4296 "Error when there is no default binding for a table key."
4301 "Setup orgtbl keymaps."
4332 elt key fun cmd)
4340 ;; Special treatment needed for TAB and RET
4360 [(tab)] "\C-i")))
4362 (org-defkey orgtbl-mode-map [backtab]
4364 [backtab] [S-iso-lefttab] [(shift tab)]
4365 [(tab)] "\C-i"))
4367 (org-defkey orgtbl-mode-map "\M-\C-m"
4368 (orgtbl-make-binding 'org-table-wrap-region 105
4369 "\M-\C-m" [(meta return)]))
4370 (org-defkey orgtbl-mode-map [(meta return)]
4371 (orgtbl-make-binding 'org-table-wrap-region 106
4372 [(meta return)] "\M-\C-m"))
4374 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4375 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4377 (when orgtbl-optimized
4378 ;; If the user wants maximum table support, we need to hijack
4379 ;; some standard editing functions
4380 (org-remap orgtbl-mode-map
4381 'self-insert-command 'orgtbl-self-insert-command
4382 'delete-char 'org-delete-char
4383 'delete-backward-char 'org-delete-backward-char)
4384 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4385 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4386 '("OrgTbl"
4387 ["Create or convert" org-table-create-or-convert-from-region
4388 :active (not (org-at-table-p)) :keys "C-c |" ]
4389 "--"
4390 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4391 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4392 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4393 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4394 "--"
4395 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4396 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4397 ["Copy Field from Above"
4398 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4399 "--"
4400 ("Column"
4401 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4402 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4403 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4404 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4405 ("Row"
4406 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4407 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4408 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4409 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4410 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4411 "--"
4412 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4413 ("Rectangle"
4414 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4415 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4416 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4417 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4418 "--"
4419 ("Radio tables"
4420 ["Insert table template" orgtbl-insert-radio-table
4421 (assq major-mode orgtbl-radio-table-templates)]
4422 ["Comment/uncomment table" orgtbl-toggle-comment t])
4423 "--"
4424 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4425 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4426 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4427 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4428 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4429 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4430 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4431 ["Sum Column/Rectangle" org-table-sum
4432 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4433 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4434 ["Debug Formulas"
4435 org-table-toggle-formula-debugger :active (org-at-table-p)
4436 :keys "C-c {"
4437 :style toggle :selected org-table-formula-debug]
4438 ["Show Col/Row Numbers"
4439 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4440 :keys "C-c }"
4441 :style toggle :selected org-table-overlay-coordinates]
4442 "--"
4443 ("Plot"
4446 t))
4448 (defun orgtbl-ctrl-c-ctrl-c (arg)
4449 "If the cursor is inside a table, realign the table.
4450 If it is a table to be sent away to a receiver, do it.
4451 With prefix arg, also recompute table."
4452 (interactive "P")
4453 (let ((case-fold-search t) (pos (point)) action)
4454 (save-excursion
4455 (beginning-of-line 1)
4456 (setq action (cond
4460 (cond
4461 ((integerp action)
4462 (goto-char action)
4463 (org-table-maybe-eval-formula)
4464 (if arg
4465 (call-interactively 'org-table-recalculate)
4466 (org-table-maybe-recalculate-line))
4467 (call-interactively 'org-table-align)
4468 (when (orgtbl-send-table 'maybe)
4469 (run-hooks 'orgtbl-after-send-table-hook)))
4470 ((eq action 'recalc)
4471 (save-excursion
4472 (beginning-of-line 1)
4474 (if (org-at-table-p)
4475 (org-call-with-arg 'org-table-recalculate t))))
4476 (t (let (orgtbl-mode)
4477 (call-interactively (key-binding "\C-c\C-c")))))))
4479 (defun orgtbl-create-or-convert-from-region (arg)
4480 "Create table or convert region to table, if no conflicting binding.
4481 This installs the table binding `C-c |', but only if there is no
4482 conflicting binding to this key outside orgtbl-mode."
4483 (interactive "P")
4484 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4485 (if cmd
4486 (call-interactively cmd)
4487 (call-interactively 'org-table-create-or-convert-from-region))))
4489 (defun orgtbl-tab (arg)
4490 "Justification and field motion for `orgtbl-mode'."
4491 (interactive "P")
4492 (if arg (org-table-edit-field t)
4493 (org-table-justify-field-maybe)
4494 (org-table-next-field)))
4496 (defun orgtbl-ret ()
4497 "Justification and field motion for `orgtbl-mode'."
4498 (interactive)
4499 (if (bobp)
4500 (newline)
4501 (org-table-justify-field-maybe)
4502 (org-table-next-row)))
4504 (defun orgtbl-self-insert-command (N)
4505 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4506 If the cursor is in a table looking at whitespace, the whitespace is
4507 overwritten, and the table is not marked as requiring realignment."
4508 (interactive "p")
4509 (if (and (org-at-table-p)
4510 (or
4511 (and org-table-auto-blank-field
4512 (member last-command
4513 '(orgtbl-hijacker-command-100
4514 orgtbl-hijacker-command-101
4515 orgtbl-hijacker-command-102
4516 orgtbl-hijacker-command-103
4517 orgtbl-hijacker-command-104
4518 orgtbl-hijacker-command-105
4519 yas/expand))
4520 (org-table-blank-field))
4521 t)
4522 (eq N 1)
4524 (let (org-table-may-need-update)
4525 (goto-char (1- (match-end 0)))
4526 (org-delete-backward-char 1)
4527 (goto-char (match-beginning 0))
4528 (self-insert-command N))
4529 (setq org-table-may-need-update t)
4530 (let* (orgtbl-mode
4531 a
4532 (cmd (or (key-binding
4533 (or (and (listp function-key-map)
4534 (setq a (assoc last-input-event function-key-map))
4535 (cdr a))
4536 (vector last-input-event)))
4537 'self-insert-command)))
4538 (call-interactively cmd)
4539 (if (and org-self-insert-cluster-for-undo
4540 (eq cmd 'self-insert-command))
4541 (if (not (eq last-command 'orgtbl-self-insert-command))
4542 (setq org-self-insert-command-undo-counter 1)
4543 (if (>= org-self-insert-command-undo-counter 20)
4544 (setq org-self-insert-command-undo-counter 1)
4545 (and (> org-self-insert-command-undo-counter 0)
4546 buffer-undo-list
4547 (not (cadr buffer-undo-list)) ; remove nil entry
4548 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4549 (setq org-self-insert-command-undo-counter
4550 (1+ org-self-insert-command-undo-counter))))))))
4553 "Regular expression matching exponentials as produced by calc.")
4555 (defun orgtbl-gather-send-defs ()
4556 "Gather a plist of :name, :transform, :params for each destination before
4557 a radio table."
4558 (save-excursion
4559 (goto-char (org-table-begin))
4560 (let (rtn)
4561 (beginning-of-line 0)
4562 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4563 (let ((name (org-no-properties (match-string 1)))
4564 (transform (intern (match-string 2)))
4565 (params (if (match-end 3)
4566 (read (concat "(" (match-string 3) ")")))))
4567 (push (list :name name :transform transform :params params)
4568 rtn)
4569 (beginning-of-line 0)))
4570 rtn)))
4572 (defun orgtbl-send-replace-tbl (name txt)
4573 "Find and replace table NAME with TXT."
4574 (save-excursion
4575 (goto-char (point-min))
4576 (unless (re-search-forward
4578 (user-error "Don't know where to insert translated table"))
4579 (let ((beg (line-beginning-position 2)))
4580 (unless (re-search-forward
4581 (concat "END +RECEIVE +ORGTBL +" name) nil t)
4582 (user-error "Cannot find end of insertion region"))
4583 (beginning-of-line)
4584 (delete-region beg (point)))
4587 ;;;###autoload
4588 (defun org-table-to-lisp (&optional txt)
4589 "Convert the table at point to a Lisp structure.
4590 The structure will be a list. Each item is either the symbol `hline'
4591 for a horizontal separator line, or a list of field values as strings.
4592 The table is taken from the parameter TXT, or from the buffer at point."
4593 (unless (or txt (org-at-table-p)) (user-error "No table at point"))
4594 (let ((txt (or txt
4595 (buffer-substring-no-properties (org-table-begin)
4596 (org-table-end)))))
4597 (mapcar (lambda (x)
4598 (if (string-match org-table-hline-regexp x) 'hline
4602 (defun orgtbl-send-table (&optional maybe)
4603 "Send a transformed version of table at point to the receiver position.
4604 With argument MAYBE, fail quietly if no transformation is defined
4605 for this table."
4606 (interactive)
4607 (catch 'exit
4608 (unless (org-at-table-p) (user-error "Not at a table"))
4609 ;; when non-interactive, we assume align has just happened.
4610 (when (org-called-interactively-p 'any) (org-table-align))
4611 (let ((dests (orgtbl-gather-send-defs))
4612 (table (org-table-to-lisp
4613 (buffer-substring-no-properties (org-table-begin)
4614 (org-table-end))))
4615 (ntbl 0))
4616 (unless dests
4617 (if maybe (throw 'exit nil)
4618 (user-error "Don't know how to transform this table")))
4619 (dolist (dest dests)
4620 (let ((name (plist-get dest :name))
4621 (transform (plist-get dest :transform))
4622 (params (plist-get dest :params)))
4623 (unless (fboundp transform)
4624 (user-error "No such transformation function %s" transform))
4625 (orgtbl-send-replace-tbl name (funcall transform table params)))
4626 (incf ntbl))
4627 (message "Table converted and installed at %d receiver location%s"
4628 ntbl (if (> ntbl 1) "s" ""))
4629 (and (> ntbl 0) ntbl))))
4631 (defun org-remove-by-index (list indices &optional i0)
4632 "Remove the elements in LIST with indices in INDICES.
4633 First element has index 0, or I0 if given."
4634 (if (not indices)
4635 list
4636 (if (integerp indices) (setq indices (list indices)))
4637 (setq i0 (1- (or i0 0)))
4638 (delq :rm (mapcar (lambda (x)
4639 (setq i0 (1+ i0))
4640 (if (memq i0 indices) :rm x))
4641 list))))
4643 (defun orgtbl-toggle-comment ()
4644 "Comment or uncomment the orgtbl at point."
4645 (interactive)
4646 (let* ((case-fold-search t)
4647 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4648 (re2 (concat "^" orgtbl-line-start-regexp))
4649 (commented (save-excursion (beginning-of-line 1)
4650 (cond ((looking-at re1) t)
4651 ((looking-at re2) nil)
4652 (t (user-error "Not at an org table")))))
4653 (re (if commented re1 re2))
4654 beg end)
4655 (save-excursion
4656 (beginning-of-line 1)
4657 (while (looking-at re) (beginning-of-line 0))
4658 (beginning-of-line 2)
4659 (setq beg (point))
4660 (while (looking-at re) (beginning-of-line 2))
4661 (setq end (point)))
4662 (comment-region beg end (if commented '(4) nil))))
4664 (defun orgtbl-insert-radio-table ()
4665 "Insert a radio table template appropriate for this major mode."
4666 (interactive)
4667 (let* ((e (assq major-mode orgtbl-radio-table-templates))
4668 (txt (nth 1 e))
4669 name pos)
4670 (unless e (user-error "No radio table setup defined for %s" major-mode))
4671 (setq name (read-string "Table name: "))
4672 (while (string-match "%n" txt)
4673 (setq txt (replace-match name t t txt)))
4675 (setq pos (point))
4676 (insert txt)
4677 (goto-char pos)))
4679 ;;;###autoload
4680 (defun orgtbl-to-generic (table params)
4681 "Convert the orgtbl-mode TABLE to some other format.
4683 This generic routine can be used for many standard cases.
4685 TABLE is a list, each entry either the symbol `hline' for
4686 a horizontal separator line, or a list of fields for that
4687 line. PARAMS is a property list of parameters that can
4688 influence the conversion.
4690 Valid parameters are:
4692 :backend, :raw
4694 Export back-end used as a basis to transcode elements of the
4695 table, when no specific parameter applies to it. It is also
4696 used to translate cells contents. You can prevent this by
4697 setting :raw property to a non-nil value.
4699 :splice
4701 When non-nil, only convert rows, not the table itself. This is
4702 equivalent to setting to the empty string both :tstart
4703 and :tend, which see.
4705 :skip
4707 When set to an integer N, skip the first N lines of the table.
4708 Horizontal separation lines do count for this parameter!
4710 :skipcols
4712 List of columns that should be skipped. If the table has
4713 a column with calculation marks, that column is automatically
4714 discarded beforehand.
4716 :hline
4718 String to be inserted on horizontal separation lines. May be
4719 nil to ignore these lines altogether.
4721 :sep
4723 Separator between two fields, as a string.
4725 Each in the following group may be either a string or a function
4726 of no arguments returning a string:
4728 :tstart, :tend
4730 Strings to start and end the table. Ignored when :splice is t.
4732 :lstart, :lend
4734 Strings to start and end a new table line.
4736 :llstart, :llend
4738 Strings to start and end the last table line. Default,
4739 respectively, to :lstart and :lend.
4741 Each in the following group may be a string or a function of one
4742 argument (either the cells in the current row, as a list of
4743 strings, or the current cell) returning a string:
4745 :lfmt
4747 Format string for an entire row, with enough %s to capture all
4748 fields. When non-nil, :lstart, :lend, and :sep are ignored.
4750 :llfmt
4752 Format for the entire last line, defaults to :lfmt.
4754 :fmt
4756 A format to be used to wrap the field, should contain %s for
4757 the original field value. For example, to wrap everything in
4759 a property list with column numbers and format strings, or
4760 functions, e.g.,
4764 :hlstart :hllstart :hlend :hllend :hsep :hlfmt :hllfmt :hfmt
4766 Same as above, specific for the header lines in the table.
4767 All lines before the first hline are treated as header. If
4768 any of these is not present, the data line value is used.
4770 This may be either a string or a function of two arguments:
4772 :efmt
4774 Use this format to print numbers with exponential. The format
4775 should have %s twice for inserting mantissa and exponent, for
4777 list with column numbers and format strings or functions.
4778 :fmt will still be applied after :efmt."
4779 (let ((backend (plist-get params :backend))
4780 ;; Disable user-defined export filters and hooks.
4781 (org-export-filters-alist nil)
4782 (org-export-before-parsing-hook nil)
4783 (org-export-before-processing-hook nil))
4784 (when (and backend (symbolp backend) (not (org-export-get-backend backend)))
4785 (user-error "Unknown :backend value"))
4786 (when (or (not backend) (plist-get params :raw)) (require 'ox-org))
4787 (org-trim
4788 (org-export-string-as
4789 ;; Return TABLE as Org syntax. Tolerate non-string cells.
4790 (with-output-to-string
4791 (dolist (e table)
4793 ((consp e)
4794 (princ "| ") (dolist (c e) (princ c) (princ " |"))
4796 ;; Build a custom back-end according to PARAMS. Before defining
4797 ;; a translator, check if there is anything to do. When there
4798 ;; isn't, let BACKEND handle the element.
4799 (org-export-create-backend
4800 :parent (or backend 'org)
4801 :filters
4802 '((:filter-parse-tree
4803 ;; Handle :skip parameter.
4804 (lambda (tree backend info)
4805 (let ((skip (plist-get info :skip)))
4806 (when skip
4807 (unless (wholenump skip) (user-error "Wrong :skip value"))
4808 (let ((n 0))
4809 (org-element-map tree 'table-row
4810 (lambda (row)
4811 (if (>= n skip) t
4812 (org-element-extract-element row)
4813 (incf n)
4814 nil))
4815 info t))
4816 tree)))
4817 ;; Handle :skipcols parameter.
4818 (lambda (tree backend info)
4819 (let ((skipcols (plist-get info :skipcols)))
4820 (when skipcols
4821 (unless (consp skipcols) (user-error "Wrong :skipcols value"))
4822 (org-element-map tree 'table
4823 (lambda (table)
4824 (let ((specialp
4825 (org-export-table-has-special-column-p table)))
4826 (dolist (row (org-element-contents table))
4827 (when (eq (org-element-property :type row) 'standard)
4828 (let ((c 1))
4829 (dolist (cell (nthcdr (if specialp 1 0)
4830 (org-element-contents row)))
4831 (when (memq c skipcols)
4832 (org-element-extract-element cell))
4833 (incf c)))))))
4834 info)
4835 tree)))))
4836 :transcoders
4837 `((table . ,(org-table--to-generic-table params))
4838 (table-row . ,(org-table--to-generic-row params))
4839 (table-cell . ,(org-table--to-generic-cell params))
4840 ;; Section. Return contents to avoid garbage around table.
4841 (section . (lambda (s c i) c))))
4842 'body-only (org-combine-plists params '(:with-tables t))))))
4844 (defun org-table--generic-apply (value name &optional with-cons &rest args)
4845 (cond ((null value) nil)
4846 ((functionp value) `(funcall ',value ,@args))
4847 ((stringp value)
4848 (cond ((consp (car args)) `(apply #'format ,value ,@args))
4849 (args `(format ,value ,@args))
4850 (t value)))
4851 ((and with-cons (consp value))
4852 `(let ((val (cadr (memq column ',value))))
4853 (cond ((null val) contents)
4854 ((stringp val) (format val ,@args))
4855 ((functionp val) (funcall val ,@args))
4856 (t (user-error "Wrong %s value" ,name)))))
4857 (t (user-error "Wrong %s value" name))))
4859 (defun org-table--to-generic-table (params)
4860 "Return custom table transcoder according to PARAMS.
4861 PARAMS is a plist. See `orgtbl-to-generic' for more
4862 information."
4863 (let ((backend (plist-get params :backend))
4864 (splice (plist-get params :splice))
4865 (tstart (plist-get params :tstart))
4866 (tend (plist-get params :tend)))
4867 `(lambda (table contents info)
4868 (concat
4869 ,(and tstart (not splice)
4871 ,(if (or (not backend) tstart tend splice) 'contents
4872 `(org-export-with-backend ',backend table contents info))
4873 ,(org-table--generic-apply (and (not splice) tend) ":tend")))))
4875 (defun org-table--to-generic-row (params)
4876 "Return custom table row transcoder according to PARAMS.
4877 PARAMS is a plist. See `orgtbl-to-generic' for more
4878 information."
4879 (let* ((backend (plist-get params :backend))
4880 (lstart (plist-get params :lstart))
4881 (llstart (plist-get params :llstart))
4882 (hlstart (plist-get params :hlstart))
4883 (hllstart (plist-get params :hllstart))
4884 (lend (plist-get params :lend))
4885 (llend (plist-get params :llend))
4886 (hlend (plist-get params :hlend))
4887 (hllend (plist-get params :hllend))
4888 (lfmt (plist-get params :lfmt))
4889 (llfmt (plist-get params :llfmt))
4890 (hlfmt (plist-get params :hlfmt))
4891 (hllfmt (plist-get params :hllfmt)))
4892 `(lambda (row contents info)
4893 (if (eq (org-element-property :type row) 'rule)
4894 ,(cond
4895 ((plist-member params :hline)
4896 (org-table--generic-apply (plist-get params :hline) ":hline"))
4897 (backend `(org-export-with-backend ',backend row nil info)))
4898 (let ((headerp (org-export-table-row-in-header-p row info))
4899 (lastp (not (org-export-get-next-element row info)))
4900 (last-header-p (org-export-table-row-ends-header-p row info)))
4901 (when contents
4902 ;; Check if we can apply `:lfmt', `:llfmt', `:hlfmt', or
4903 ;; `:hllfmt' to CONTENTS. Otherwise, fallback on
4904 ;; `:lstart', `:lend' and their relatives.
4905 ,(let ((cells
4906 '(org-element-map row 'table-cell
4907 (lambda (cell)
4908 ;; Export all cells, without separators.
4909 ;;
4910 ;; Use `org-export-data-with-backend'
4911 ;; instead of `org-export-data' to eschew
4912 ;; cached values, which
4913 ;; ignore :orgtbl-ignore-sep parameter.
4914 (org-export-data-with-backend
4915 cell
4916 (plist-get info :back-end)
4917 (org-combine-plists info '(:orgtbl-ignore-sep t))))
4918 info)))
4919 `(cond
4920 ,(and hllfmt
4921 `(last-header-p ,(org-table--generic-apply
4922 hllfmt ":hllfmt" nil cells)))
4923 ,(and hlfmt
4924 `(headerp ,(org-table--generic-apply
4925 hlfmt ":hlfmt" nil cells)))
4926 ,(and llfmt
4927 `(lastp ,(org-table--generic-apply
4928 llfmt ":llfmt" nil cells)))
4929 (t
4930 ,(if lfmt (org-table--generic-apply lfmt ":lfmt" nil cells)
4931 `(concat
4932 (cond
4933 ,(and
4934 (or hllstart hllend)
4935 `(last-header-p
4936 (concat
4937 ,(org-table--generic-apply hllstart ":hllstart")
4938 contents
4939 ,(org-table--generic-apply hllend ":hllend"))))
4940 ,(and
4941 (or hlstart hlend)
4942 `(headerp
4943 (concat
4944 ,(org-table--generic-apply hlstart ":hlstart")
4945 contents
4946 ,(org-table--generic-apply hlend ":hlend"))))
4947 ,(and
4948 (or llstart llend)
4949 `(lastp
4950 (concat
4951 ,(org-table--generic-apply llstart ":llstart")
4952 contents
4953 ,(org-table--generic-apply llend ":llend"))))
4954 (t
4955 ,(cond
4956 ((or lstart lend)
4957 `(concat
4958 ,(org-table--generic-apply lstart ":lstart")
4959 contents
4960 ,(org-table--generic-apply lend ":lend")))
4961 (backend
4962 `(org-export-with-backend
4963 ',backend row contents info))
4964 (t 'contents)))))))))))))))
4966 (defun org-table--to-generic-cell (params)
4967 "Return custom table cell transcoder according to PARAMS.
4968 PARAMS is a plist. See `orgtbl-to-generic' for more
4969 information."
4970 (let* ((backend (plist-get params :backend))
4971 (efmt (plist-get params :efmt))
4972 (fmt (plist-get params :fmt))
4973 (hfmt (plist-get params :hfmt))
4974 (sep (plist-get params :sep))
4975 (hsep (plist-get params :hsep)))
4976 `(lambda (cell contents info)
4977 (let ((headerp (org-export-table-row-in-header-p
4978 (org-export-get-parent-element cell) info))
4979 (column (1+ (cdr (org-export-table-cell-address cell info)))))
4980 ;; Make sure that contents are exported as Org data when :raw
4981 ;; parameter is non-nil.
4982 ,(when (and backend (plist-get params :raw))
4983 `(setq contents
4984 ;; Since we don't know what are the pseudo object
4985 ;; types defined in backend, we cannot pass them to
4986 ;; `org-element-interpret-data'. As a consequence,
4987 ;; they will be treated as pseudo elements, and
4988 ;; will have newlines appended instead of spaces.
4989 ;; Therefore, we must make sure :post-blank value
4990 ;; is really turned into spaces.
4991 (replace-regexp-in-string
4993 (org-trim
4994 (org-element-interpret-data
4995 (org-element-contents cell))))))
4996 (when contents
4997 ;; Check if we can apply `:efmt' on CONTENTS.
4998 ,(when efmt
4999 `(when (string-match orgtbl-exp-regexp contents)
5000 (let ((mantissa (match-string 1 contents))
5001 (exponent (match-string 2 contents)))
5002 (setq contents ,(org-table--generic-apply
5003 efmt ":efmt" t 'mantissa 'exponent)))))
5004 ;; Check if we can apply FMT (or HFMT) on CONTENTS.
5005 (cond
5006 ,(and hfmt `(headerp (setq contents ,(org-table--generic-apply
5007 hfmt ":hfmt" t 'contents))))
5008 ,(and fmt `(t (setq contents ,(org-table--generic-apply
5009 fmt ":fmt" t 'contents))))))
5010 ;; If a separator is provided, use it instead of BACKEND's.
5011 ;; Separators are ignored when LFMT (or equivalent) is
5012 ;; provided.
5013 ,(cond
5014 ((or hsep sep)
5015 `(if (or ,(and (not sep) '(not headerp))
5016 (plist-get info :orgtbl-ignore-sep)
5017 (not (org-export-get-next-element cell info)))
5018 ,(if (not backend) 'contents
5019 `(org-export-with-backend ',backend cell contents info))
5020 (concat contents
5021 ,(if (and sep hsep) `(if headerp ,hsep ,sep)
5022 (or hsep sep)))))
5023 (backend `(org-export-with-backend ',backend cell contents info))
5024 (t 'contents))))))
5026 ;;;###autoload
5027 (defun orgtbl-to-tsv (table params)
5028 "Convert the orgtbl-mode table to TAB separated material."
5031 ;;;###autoload
5032 (defun orgtbl-to-csv (table params)
5033 "Convert the orgtbl-mode table to CSV material.
5034 This does take care of the proper quoting of fields with comma or quotes."
5035 (orgtbl-to-generic table
5036 (org-combine-plists '(:sep "," :fmt org-quote-csv-field)
5037 params)))
5039 ;;;###autoload
5040 (defun orgtbl-to-latex (table params)
5041 "Convert the orgtbl-mode TABLE to LaTeX.
5043 TABLE is a list, each entry either the symbol `hline' for
5044 a horizontal separator line, or a list of fields for that line.
5045 PARAMS is a property list of parameters that can influence the
5046 conversion. All parameters from `orgtbl-to-generic' are
5047 supported. It is also possible to use the following ones:
5049 :booktabs
5053 :environment
5055 Specify environment to use, as a string. If you use
5057 as a string, to get proper continuation strings."
5058 (require 'ox-latex)
5059 (orgtbl-to-generic
5060 table
5061 (org-combine-plists
5062 ;; Provide sane default values.
5063 (list :backend 'latex
5064 :latex-default-table-mode 'table
5065 :latex-tables-centered nil
5066 :latex-tables-booktabs (plist-get params :booktabs)
5067 :latex-table-scientific-notation nil
5068 :latex-default-table-environment
5069 (or (plist-get params :environment) "tabular"))
5070 params)))
5072 ;;;###autoload
5073 (defun orgtbl-to-html (table params)
5074 "Convert the orgtbl-mode TABLE to HTML.
5076 TABLE is a list, each entry either the symbol `hline' for
5077 a horizontal separator line, or a list of fields for that line.
5078 PARAMS is a property list of parameters that can influence the
5079 conversion. All parameters from `orgtbl-to-generic' are
5080 supported. It is also possible to use the following one:
5082 :attributes
5084 Attributes and values, as a plist, which will be used in
5085 <table> tag."
5086 (require 'ox-html)
5087 (orgtbl-to-generic
5088 table
5089 (org-combine-plists
5090 ;; Provide sane default values.
5091 (list :backend 'html
5092 :html-table-data-tags '("<td%s>" . "</td>")
5093 :html-table-use-header-tags-for-first-column nil
5094 :html-table-align-individual-fields t
5095 :html-table-row-tags '("<tr>" . "</tr>")
5096 :html-table-attributes
5097 (if (plist-member params :attributes)
5098 (plist-get params :attributes)
5099 '(:border "2" :cellspacing "0" :cellpadding "6" :rules "groups"
5100 :frame "hsides")))
5101 params)))
5103 ;;;###autoload
5104 (defun orgtbl-to-texinfo (table params)
5105 "Convert the orgtbl-mode TABLE to Texinfo.
5107 TABLE is a list, each entry either the symbol `hline' for
5108 a horizontal separator line, or a list of fields for that line.
5109 PARAMS is a property list of parameters that can influence the
5110 conversion. All parameters from `orgtbl-to-generic' are
5111 supported. It is also possible to use the following one:
5113 :columns
5115 Column widths, as a string. When providing column fractions,
5117 (require 'ox-texinfo)
5118 (let ((output
5119 (orgtbl-to-generic
5120 table
5121 (org-combine-plists
5122 (list :backend 'texinfo
5123 :texinfo-tables-verbatim nil
5124 :texinfo-table-scientific-notation nil)
5125 params)))
5126 (columns (let ((w (plist-get params :columns)))
5127 (cond ((not w) nil)
5129 (t (concat "@columnfractions " w))))))
5130 (if (not columns) output
5131 (replace-regexp-in-string
5134 ;;;###autoload
5135 (defun orgtbl-to-orgtbl (table params)
5136 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
5138 TABLE is a list, each entry either the symbol `hline' for
5139 a horizontal separator line, or a list of fields for that line.
5140 PARAMS is a property list of parameters that can influence the
5141 conversion. All parameters from `orgtbl-to-generic' are
5142 supported.
5144 Useful when slicing one table into many. The :hline, :sep,
5145 :lstart, and :lend provide orgtbl framing. :tstart and :tend can
5146 be set to provide ORGTBL directives for the generated table."
5147 (require 'ox-org)
5148 (orgtbl-to-generic table (org-combine-plists params (list :backend 'org))))
5150 (defun orgtbl-to-table.el (table params)
5151 "Convert the orgtbl-mode TABLE into a table.el table.
5152 TABLE is a list, each entry either the symbol `hline' for
5153 a horizontal separator line, or a list of fields for that line.
5154 PARAMS is a property list of parameters that can influence the
5155 conversion. All parameters from `orgtbl-to-generic' are
5156 supported."
5157 (with-temp-buffer
5158 (insert (orgtbl-to-orgtbl table params))
5159 (org-table-align)
5160 (replace-regexp-in-string
5161 "-|" "-+"
5162 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
5164 (defun orgtbl-to-unicode (table params)
5165 "Convert the orgtbl-mode TABLE into a table with unicode characters.
5167 TABLE is a list, each entry either the symbol `hline' for
5168 a horizontal separator line, or a list of fields for that line.
5169 PARAMS is a property list of parameters that can influence the
5170 conversion. All parameters from `orgtbl-to-generic' are
5171 supported. It is also possible to use the following ones:
5173 :ascii-art
5176 the table. You can download it here:
5177 http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el.
5179 :narrow
5181 When non-nil, narrow columns width than provided width cookie,
5183 (require 'ox-ascii)
5184 (orgtbl-to-generic
5185 table
5186 (org-combine-plists
5187 (list :backend 'ascii
5188 :ascii-charset 'utf-8
5189 :ascii-table-widen-columns (not (plist-get params :narrow))
5190 :ascii-table-use-ascii-art (plist-get params :ascii-art))
5191 params)))
5193 ;; Put the cursor in a column containing numerical values
5194 ;; of an Org-Mode table,
5195 ;; type C-c " a
5196 ;; A new column is added with a bar plot.
5197 ;; When the table is refreshed (C-u C-c *),
5198 ;; the plot is updated to reflect the new values.
5200 (defun orgtbl-ascii-draw (value min max &optional width characters)
5201 "Draw an ascii bar in a table.
5202 VALUE is a the value to plot, the width of the bar to draw. A
5203 value equal to MIN will be displayed as empty (zero width bar).
5204 A value equal to MAX will draw a bar filling all the WIDTH.
5205 WIDTH is the expected width in characters of the column.
5206 CHARACTERS is a string that will compose the bar, with shades of
5207 grey from pure white to pure black. It defaults to a 10
5208 characters string of regular ascii characters."
5209 (let* ((characters (or characters " .:;c!lhVHW"))
5210 (width (or width 12))
5211 (value (if (numberp value) value (string-to-number value)))
5212 (value (* (/ (- (+ value 0.0) min) (- max min)) width)))
5213 (cond
5214 ((< value 0) "too small")
5215 ((> value width) "too large")
5216 (t
5217 (let ((len (1- (length characters))))
5218 (concat
5219 (make-string (floor value) (elt characters len))
5220 (string (elt characters
5221 (floor (* (- value (floor value)) len))))))))))
5223 ;;;###autoload
5224 (defun orgtbl-ascii-plot (&optional ask)
5225 "Draw an ascii bar plot in a column.
5226 With cursor in a column containing numerical values, this
5227 function will draw a plot in a new column.
5228 ASK, if given, is a numeric prefix to override the default 12
5229 characters width of the plot. ASK may also be the
5231 (interactive "P")
5232 (let ((col (org-table-current-column))
5233 (min 1e999) ; 1e999 will be converted to infinity
5234 (max -1e999) ; which is the desired result
5235 (table (org-table-to-lisp))
5236 (length
5237 (cond ((consp ask)
5238 (read-number "Length of column " 12))
5239 ((numberp ask) ask)
5240 (t 12))))
5241 ;; Skip any hline a the top of table.
5242 (while (eq (car table) 'hline) (setq table (cdr table)))
5243 ;; Skip table header if any.
5244 (dolist (x (or (cdr (memq 'hline table)) table))
5245 (when (consp x)
5246 (setq x (nth (1- col) x))
5247 (when (string-match
5249 x)
5250 (setq x (string-to-number x))
5251 (when (> min x) (setq min x))
5252 (when (< max x) (setq max x)))))
5253 (org-table-insert-column)
5254 (org-table-move-column-right)
5255 (org-table-store-formulas
5256 (cons
5257 (cons
5258 (number-to-string (1+ col))
5259 (format "'(%s $%s %s %s %s)"
5260 "orgtbl-ascii-draw" col min max length))
5261 (org-table-get-stored-formulas)))
5262 (org-table-recalculate t)))
5264 ;; Example of extension: unicode characters
5265 ;; Here are two examples of different styles.
5267 ;; Unicode block characters are used to give a smooth effect.
5268 ;; See http://en.wikipedia.org/wiki/Block_Elements
5269 ;; Use one of those drawing functions
5270 ;; - orgtbl-ascii-draw (the default ascii)
5271 ;; - orgtbl-uc-draw-grid (unicode with a grid effect)
5272 ;; - orgtbl-uc-draw-cont (smooth unicode)
5274 ;; This is best viewed with the "DejaVu Sans Mono" font
5275 ;; (use M-x set-default-font).
5277 (defun orgtbl-uc-draw-grid (value min max &optional width)
5278 "Draw a bar in a table using block unicode characters.
5279 It is a variant of orgtbl-ascii-draw with Unicode block
5280 characters, for a smooth display. Bars appear as grids (to the
5281 extent the font allows)."
5282 ;; http://en.wikipedia.org/wiki/Block_Elements
5283 ;; best viewed with the "DejaVu Sans Mono" font.
5284 (orgtbl-ascii-draw value min max width
5287 (defun orgtbl-uc-draw-cont (value min max &optional width)
5288 "Draw a bar in a table using block unicode characters.
5289 It is a variant of orgtbl-ascii-draw with Unicode block
5290 characters, for a smooth display. Bars are solid (to the extent
5291 the font allows)."
5292 (orgtbl-ascii-draw value min max width
5295 (defun org-table-get-remote-range (name-or-id form)
5296 "Get a field value or a list of values in a range from table at ID.
5298 NAME-OR-ID may be the name of a table in the current file as set
5300 will then be used. Alternatively, it may be an ID referring to
5301 any entry, also in a different file. In this case, the first
5302 table in that entry will be referenced.
5306 The return value is either a single string for a single field, or a
5307 list of the fields in the rectangle."
5308 (save-match-data
5309 (let ((case-fold-search t) (id-loc nil)
5310 ;; Protect a bunch of variables from being overwritten
5311 ;; by the context of the remote table
5312 org-table-column-names org-table-column-name-regexp
5313 org-table-local-parameters org-table-named-field-locations
5314 org-table-current-line-types org-table-current-begin-line
5315 org-table-current-begin-pos org-table-dlines
5316 org-table-current-ncol
5317 org-table-hlines org-table-last-alignment
5318 org-table-last-column-widths org-table-last-alignment
5319 org-table-last-column-widths tbeg
5320 buffer loc)
5321 (setq form (org-table-convert-refs-to-rc form))
5322 (save-excursion
5323 (save-restriction
5324 (widen)
5325 (save-excursion
5326 (goto-char (point-min))
5327 (if (re-search-forward
5330 nil t)
5331 (setq buffer (current-buffer) loc (match-beginning 0))
5332 (setq id-loc (org-id-find name-or-id 'marker))
5333 (unless (and id-loc (markerp id-loc))
5335 (setq buffer (marker-buffer id-loc)
5336 loc (marker-position id-loc))
5337 (move-marker id-loc nil)))
5338 (with-current-buffer buffer
5339 (save-excursion
5340 (save-restriction
5341 (widen)
5342 (goto-char loc)
5343 (forward-char 1)
5345 (not (match-beginning 1)))
5346 (user-error "Cannot find a table at NAME or ID %s" name-or-id))
5347 (setq tbeg (point-at-bol))
5348 (org-table-get-specials)
5349 (setq form (org-table-formula-substitute-names
5350 (org-table-formula-handle-first/last-rc form)))
5351 (if (and (string-match org-table-range-regexp form)
5352 (> (length (match-string 0 form)) 1))
5353 (save-match-data
5354 (org-table-get-range (match-string 0 form) tbeg 1))
5355 form)))))))))
5357 (defun org-table-remote-reference-indirection (form)
5358 "Return formula with table remote references substituted by indirection.
5360 This indirection works only with the format @ROW$COLUMN. The
5362 distinguished from a plain table name or ID."
5363 (let ((start 0))
5364 (while (string-match (concat
5365 ;; Same as in `org-table-eval-formula'.
5367 ;; Allow "$1", "@<", "$-1", "@<<$1" etc.
5369 ;; Same as in `org-table-eval-formula'.
5371 form
5372 start)
5373 ;; The position of the character as far as possible to the right
5374 ;; that will not be replaced and particularly not be shifted by
5375 ;; `replace-match'.
5376 (setq start (match-beginning 1))
5377 ;; Substitute the remote reference with the value found in the
5378 ;; field.
5379 (setq form
5380 (replace-match
5381 (save-match-data
5382 (org-table-get-range (org-table-formula-handle-first/last-rc
5383 (match-string 1 form))))
5384 t t form 1))))
5385 form)
5387 (defmacro org-define-lookup-function (mode)
5388 (let ((mode-str (symbol-name mode))
5389 (first-p (equal mode 'first))
5390 (all-p (equal mode 'all)))
5391 (let ((plural-str (if all-p "s" "")))
5392 `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
5393 ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
5394 If R-LIST is nil, return matching element%s of S-LIST.
5395 If PREDICATE is not nil, use it instead of `equal' to match VAL.
5396 Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
5397 This function is generated by a call to the macro `org-define-lookup-function'."
5398 mode-str plural-str plural-str plural-str)
5399 (let ,(let ((lvars '((p (or predicate 'equal))
5400 (sl s-list)
5401 (rl (or r-list s-list))
5402 (ret nil))))
5403 (if first-p (add-to-list 'lvars '(match-p nil)))
5404 lvars)
5405 (while ,(if first-p '(and (not match-p) sl) 'sl)
5406 (progn
5407 (if (funcall p val (car sl))
5408 (progn
5409 ,(if first-p '(setq match-p t))
5410 (let ((rval (car rl)))
5411 (setq ret ,(if all-p '(append ret (list rval)) 'rval)))))
5412 (setq sl (cdr sl) rl (cdr rl))))
5413 ret)))))
5415 (org-define-lookup-function first)
5416 (org-define-lookup-function last)
5417 (org-define-lookup-function all)
5419 (provide 'org-table)
5421 ;; Local variables:
5422 ;; generated-autoload-file: "org-loaddefs.el"
5423 ;; End:
5425 ;;; org-table.el ends here