| blob | 7607ead2b48de05da7c7bfa1b59e8f583ca65db2 |
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 "Options concerning table import and export in Org-mode."
363 "Default export parameters for `org-table-export'.
364 These can be overridden for a specific table by setting the
365 TABLE_EXPORT_FORMAT property. See the manual section on orgtbl
366 radio tables for the different export transformations and
367 available parameters."
405 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
406 ;; 1 2 3 4 5
417 "Is this a table line colgroup information?"
421 line)
423 nil
430 "Is this a table line with only alignment/width cookies?"
443 s))))
451 ;;;###autoload
453 "Use the table.el package to insert a new table.
454 If there is already a table at point, convert between Org-mode tables
455 and table.el tables."
468 ;;;###autoload
470 "Convert region to table, or create an empty table.
471 If there is an active region, convert it to a table, using the function
472 `org-table-convert-region'. See the documentation of that function
473 to learn how the prefix argument is interpreted to determine the field
474 separator.
475 If there is no such region, create an empty table with `org-table-create'."
481 ;;;###autoload
483 "Query for a size and insert a table skeleton.
503 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
507 ;; Insert a hline after the first row.
514 ;;;###autoload
516 "Convert region to a table.
517 The region goes from BEG0 to END0, but these borders will be moved
518 slightly, to make sure a beginning of line in the first line is included.
520 SEPARATOR specifies the field separator in the lines. It can have the
521 following values:
523 '(4) Use the comma as a field separator
524 '(16) Use a TAB as field separator
525 '(64) Prompt for a regular expression as field separator
526 integer When a number, use that many spaces as field separator
527 regexp When a regular expression, use it to match the separator
528 nil When nil, the command tries to be smart and figure out the
529 separator in the following way:
530 - when each line contains a TAB, assume TAB-separated material
531 - when each line contains a comma, assume CSV material
532 - else, assume one or more SPACE characters as separator."
536 re)
545 ;; Get the right field separator
556 ;; parse the csv stuff
581 ;;;###autoload
583 "Import FILE as a table.
584 The file is assumed to be tab-separated. Such files can be produced by most
585 spreadsheet and database applications. If no tabs (at least one per line)
586 are found, lines will be split on whitespace into fields."
595 ;;;###autoload
597 "Export table to a file, with configurable format.
598 Such a file can be imported into usual spreadsheet programs.
600 FILE can be the output file name. If not given, it will be taken
601 from a TABLE_EXPORT_FILE property in the current entry or higher
602 up in the hierarchy, or the user will be prompted for a file
603 name. FORMAT can be an export format, of the same kind as it
604 used when `orgtbl-mode' sends a table in a different format.
606 The command suggests a format depending on TABLE_EXPORT_FORMAT,
607 whether it is set locally or up in the hierarchy, then on the
608 extension of the given file name, and finally on the variable
609 `org-table-export-default-format'."
642 formats)))
643 org-table-export-default-format)
669 "Marker at the beginning of the table last aligned.
672 "Marker at the end of the table last aligned.
675 "List of flags for flushright alignment, from the last re-alignment.
678 "List of max width of fields in each column.
681 "Non-nil means debug table formulas.
693 ;;;###autoload
695 "Align the table at point by aligning all vertical bars."
698 ;; Limits of table
701 ;; Current cursor position
707 column
709 rfmt hfmt
717 emptystrings links dates emph raise narrow
718 falign falign1 fmax f1 f2 len c e space)
721 ;; Check if we have links or dates
733 ;; Make sure the link properties are right
735 ;; Make sure the date properties are right
740 ;; Check if we are narrowing any columns
743 org-format-transports-properties-p
748 ;; Get the rows
751 ;; Store the indentation of the first line
754 ;; Mark the hlines by setting the corresponding element to nil
755 ;; At the same time, we remove trailing space.
758 nil
761 l)))
762 lines))
763 ;; Get the data fields by splitting the lines.
768 ;; How many fields in the longest line?
775 ;; A list of empty strings to fill any short rows on output
777 ;; Check for special formatting.
781 ;; Check if there is an explicit width specified
791 ;; Find fields that are wider than fmax, and shorten them
797 'help-echo
806 f2)
810 f1)
816 xx)))))
817 ;; Get the maximum width for each column
819 lengths)
820 ;; Get the fraction of numbers, to decide about alignment of the column
826 nil
833 ;; Store the alignment of this table, for later editing of single fields
835 org-table-last-column-widths lengths)
837 ;; With invisible characters, `format' does not get the field width right
838 ;; So we need to make these fields wide by hand.
856 ;; Compute the formats needed for output of the table
869 hfmt))
873 ;; Replace the old one
880 ;; Try to move to the old location
889 ))
891 ;;;###autoload
893 "Find the beginning of the table and return its position.
894 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
898 org-table-border-regexp)
899 nil t))
905 ;;;###autoload
907 "Find the end of the table and return its position.
908 With argument TABLE-TYPE, go to the end of a table.el-type table."
912 org-table-border-regexp)
913 nil t))
918 ;;;###autoload
920 "Justify the current field, text to left, number to right.
921 Optional argument NEW may specify text to replace the current field content."
930 ;; This is not the same table, force a full re-align
936 l f n o e)
962 ;;;###autoload
964 "Go to the next field in the current table, creating new lines as needed.
965 Before doing so, re-align the table if necessary."
970 org-table-may-need-update)
981 org-table-tab-jumps-over-hlines
992 ;;;###autoload
994 "Go to the previous field in the table.
995 Before doing so, re-align the table if necessary."
1000 org-table-may-need-update)
1015 "Move to the end of the current table field.
1016 If already at or after the end, move to the end of the next table field.
1017 With numeric argument N, move N-1 fields forward first."
1030 "Move to the beginning of the current table field.
1031 If already at or before the beginning, move to the beginning of the
1032 previous field.
1033 With numeric argument N, move N-1 fields backward first."
1046 ;;;###autoload
1048 "Go to the next row (same column) in the current table.
1049 Before doing so, re-align the table if necessary."
1057 org-table-may-need-update)
1070 ;;;###autoload
1072 "Copy the value of the current field one row below.
1074 If the field at the cursor is empty, copy the content of the
1075 nearest non-empty field above. With argument N, use the Nth
1076 non-empty field.
1078 If the current field is not empty, it is copied down to the next
1079 row, and the cursor is moved with it. Therefore, repeating this
1080 command causes the column to be filled row-by-row.
1082 If the variable `org-table-copy-increment' is non-nil and the
1083 field is an integer or a timestamp, it will be incremented while
1084 copying. By default, increment by the difference between the
1085 value in the current field and the one in the field above. To
1086 increment using a fixed integer, set `org-table-copy-increment'
1087 to a number. In the case of a timestamp, increment by days."
1099 txt txt-up inc)
1107 beg t))
1117 beg t))
1124 ;; Above field was not empty, go down to the next row
1157 "Is point inside a table data field?
1158 I.e. not on a hline or before the first or after the last column?
1159 This actually throws an error, so it aborts the current command."
1165 nil
1167 t))
1173 "Get the field in table line LINE, column COLUMN.
1174 If LINE is larger than the number of data lines in the table, the function
1175 returns nil. However, if COLUMN is too large, we will simply return an
1176 empty string.
1177 If LINE is nil, use the current line.
1178 If COLUMN is nil, use the current column."
1185 "Put VALUE into line LINE, column COLUMN.
1186 When ALIGN is set, also realign the table."
1195 "Return the index of the current data line."
1202 cnt))
1205 "Go to the Nth data line in the current table.
1206 Return t when the line exists, nil if it does not exist."
1213 ;;;###autoload
1215 "Blank the current table field or active region."
1232 "Return the value of the field in column N of current row.
1233 N defaults to current field.
1234 If REPLACE is a string, replace field with this value. The return value
1235 is always the old value."
1244 t t))
1246 val)
1249 ;;;###autoload
1251 "Show info about the current field, and highlight any reference at point."
1260 org-table-named-field-locations)))
1280 dline col
1282 dline col ref1
1284 ;; FIXME: formula info not correct if special table line
1294 "Find out which column we are in."
1304 cnt)))
1306 ;;;###autoload
1308 "Find out what table data line we are in.
1309 Only data lines count for this."
1321 cnt)))
1323 ;;;###autoload
1325 "Move the cursor to the Nth column in the current table line.
1326 With optional argument ON-DELIM, stop with point before the left delimiter
1327 of the field.
1328 If there are less than N fields, just go to after the last delimiter.
1329 However, when FORCE is non-nil, create new columns if necessary."
1339 t)))))
1346 ;;;###autoload
1348 "Insert a new column into the table."
1356 ;; Current cursor position
1362 nil
1376 "Find a data line in the current table, which is needed for column commands."
1379 t
1390 t
1395 "Turn a buffer line number into a data line number.
1396 If there is no data line in this line, return nil.
1397 If there is no matching dline (most likely te reference was a hline), the
1398 first dline below it is used. When ABOVE is non-nil, the one above is used."
1401 i)
1414 nil))
1416 ;;;###autoload
1418 "Delete a column from the table."
1427 ;; Current cursor position
1433 nil
1449 ;;;###autoload
1451 "Move column to the right."
1454 ;;;###autoload
1456 "Move column to the left."
1460 ;;;###autoload
1462 "Move the current column to the right. With arg LEFT, move to the left."
1472 ;; Current cursor position
1482 nil
1500 ;;;###autoload
1502 "Move table row down."
1505 ;;;###autoload
1507 "Move table row up."
1511 ;;;###autoload
1513 "Move the current table line down. With arg UP, move it up."
1522 txt hline2p)
1545 ;;;###autoload
1547 "Insert a new row above the current line into the table.
1548 With prefix ARG, insert below the current line."
1554 ;; Fix the first field if necessary
1567 ;;;###autoload
1569 "Insert a horizontal-line below the current line into the table.
1570 With prefix ABOVE, insert above the current line."
1591 ;;;###autoload
1593 "Insert a hline and move to the row below that line."
1607 In particular, this does handle wide and invisible characters."
1609 ;; It's a hline, just map the characters
1615 t t s)))
1616 s))
1618 ;;;###autoload
1620 "Delete the current row or horizontal line from the table."
1634 ;;;###autoload
1636 "Sort table lines according to the column at point.
1638 The position of point indicates the column to be used for
1639 sorting, and the range of lines is the range between the nearest
1640 horizontal separator lines, or the entire table of no such lines
1641 exist. If point is before the first column, you will be prompted
1642 for the sorting column. If there is an active region, the mark
1643 specifies the first line and the sorting column, while point
1644 should be in the last line to be included into the sorting.
1646 The command then prompts for the sorting type which can be
1647 alphabetically, numerically, or by time (as given in a time stamp
1648 in the field, or as a HH:MM value). Sorting in reverse order is
1649 also possible.
1651 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1653 If SORTING-TYPE is specified when this function is called from a Lisp
1654 program, no prompting will take place. SORTING-TYPE must be a character,
1655 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
1656 should be done in reverse order."
1661 beg end bcol ecol tend tbeg column lns pos)
1706 x))
1720 ;;;###autoload
1722 "Copy region in table to the clipboard and blank all relevant fields.
1723 If there is no active region, use just the field at point."
1729 ;;;###autoload
1731 "Copy rectangular region in table to clipboard.
1732 A special clipboard is used which can only be accessed
1733 with `org-table-paste-rectangle'."
1737 current-prefix-arg))
1739 region cols
1765 org-table-clip))
1767 ;;;###autoload
1769 "Paste a rectangular region into a table.
1770 The upper right corner ends up in the current field. All involved fields
1771 will be overwritten. If the rectangle does not fit into the present table,
1772 the table is enlarged as needed. The process ignores horizontal separator
1773 lines."
1783 c cols field)
1798 ;;;###autoload
1800 "Convert from `org-mode' table to table.el and back.
1801 Obviously, this only works within limits. When an Org-mode table is
1802 converted to table.el, all horizontal separator lines get lost, because
1803 table.el uses these as cell boundaries and has no notion of horizontal lines.
1804 A table.el table can be converted to an Org-mode table only if it does not
1805 do row or column spanning. Multiline cells will become multiple cells.
1806 Beware, Org-mode does not test if the table can be successfully converted - it
1807 blindly applies a recipe that works for simple tables."
1811 ;; convert to Org-mode table
1820 ;; convert to table.el table
1823 ;; first, get rid of all horizontal lines
1827 ;; insert a hline before first
1831 ;; insert a hline after each line
1836 ;; replace "+" at beginning and ending of hlines
1845 "Transpose Org table at point and eliminate hlines.
1846 So a table like
1848 | 1 | 2 | 4 | 5 |
1849 |---+---+---+---|
1850 | a | b | c | d |
1851 | e | f | g | h |
1853 will be transposed as
1855 | 1 | a | e |
1856 | 2 | b | f |
1857 | 4 | c | g |
1858 | 5 | d | h |
1860 Note that horizontal lines disappear."
1872 table)))
1886 ;;;###autoload
1888 "Wrap several fields in a column like a paragraph.
1889 This is useful if you'd like to spread the contents of a field over several
1890 lines, in order to keep the table compact.
1892 If there is an active region, and both point and mark are in the same column,
1893 the text in the column is wrapped to minimum width for the given number of
1894 lines. Generally, this makes the table more compact. A prefix ARG may be
1896 formats the selected text to two lines. If the region was longer than two
1897 lines, the remaining lines remain empty. A negative prefix argument reduces
1898 the current number of lines by that amount. The wrapped text is pasted back
1899 into the table. If you formatted it to more lines than it was before, fields
1900 further down in the table get overwritten - so you might need to make space in
1901 the table first.
1903 If there is no region, the current field is split at the cursor position and
1904 the text fragment to the right of the cursor is prepended to the field one
1905 line down.
1907 If there is no region, but you specify a prefix ARG, the current field gets
1908 blank, and the content is appended to the field above."
1912 ;; There is a region: fill as a paragraph
1916 nlines)
1923 arg)
1927 nil nlines)))
1931 ;; No region, split the current field at point
1935 ;; combine with field above
1945 ;; split field
1957 ;;;###autoload
1959 "Edit table field in a different window.
1960 This is mainly useful for fields that contain hidden parts.
1962 it can be edited in place."
1971 display t intangible t))
1984 p)
2000 intangible t))
2008 "Finish editing a table data field.
2009 Remove all newline characters, insert the result into the table, realign
2010 the table and kill the editing buffer."
2014 text)
2031 "Minor mode to make the table field editor window follow the cursor.
2032 When this mode is active, the field editor window will always show the
2033 current field. The mode exits automatically when the cursor leaves the
2034 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
2035 nil " TblFollow" nil
2051 ;; We have left the table, exit the follow mode
2061 ;;;###autoload
2063 "Sum numbers in region of current table column.
2064 The result will be displayed in the echo area, and will be available
2067 If there is an active region, it is interpreted as a rectangle and all
2068 numbers in that rectangle will be summed. If there is no active
2069 region and point is located in a table column, sum all numbers in that
2070 column.
2072 If at least one number looks like a time HH:MM or HH:MM:SS, all other
2073 numbers are assumed to be times as well (in decimal hours) and the
2074 numbers are added as such.
2076 If NLAST is a number, only the NLAST fields will actually be summed."
2103 items1)))
2110 s diff)
2118 sres))))
2141 "Return the formula active for the current field.
2142 Assumes that specials are in place.
2143 If KEY is given, return the key to this formula.
2147 org-table-named-field-locations)))
2161 "Read a formula from the minibuffer, offer stored formula as default.
2162 When NAMED is non-nil, look for a named equation."
2166 org-table-named-field-locations)))
2173 name
2174 ref)
2184 stored)
2186 equation)
2193 scol))
2195 'org-table-formula-history
2196 )))))
2197 mustsave)
2199 ;; remove formula
2206 ;; We set the column equation, delete the named one.
2208 mustsave t))
2214 eq))
2217 "Store the list of formulas below the current table."
2224 ;; don't overwrite TBLFM, we might use text properties to store stuff
2240 ;; Fake a high number to make sure this is sorted at the end.
2247 a)
2257 "Compare two formulas for sorting."
2262 ;;;###autoload
2264 "Return an alist with the stored formulas directly after current table."
2273 (when (string-match "\\`\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*[^ \t]\\)" string)
2292 "Modify the equations after the table structure has been edited.
2294 For all numbers larger than LIMIT, shift them by DELTA."
2306 s n a)
2312 "Change makes TBLFM term %s invalid, use undo to recover"
2328 "Get the column names and local parameters for this table."
2331 names name fields fields1 field cnt
2332 c v l line col types dlines hlines last-dline)
2334 org-table-local-parameters nil
2335 org-table-named-field-locations nil
2336 org-table-current-begin-line nil
2337 org-table-current-begin-pos nil
2338 org-table-current-line-types nil
2357 org-table-local-parameters))))
2373 ;; Analyse the line types
2377 l org-table-current-begin-line)
2394 al al2)
2404 ;;;###autoload
2407 If yes, store the formula and apply it."
2408 ;; We already know we are in a table. Get field will only return a formula
2409 ;; when appropriate. It might return a separator line, but no problem.
2412 named eq)
2423 "List of commands triggering the recalculation of a line.
2435 ;;;###autoload
2437 "Rotate the recalculation mark in the first column.
2438 If in any row, the first field is not consistent with a mark,
2439 insert a new column for the markers.
2440 When there is an active region, change all the lines in the region,
2441 after prompting for the marking character.
2442 After each change, a message will be displayed indicating the meaning
2443 of the new mark."
2458 epos new)
2465 newchar))
2497 ;;;###autoload
2499 "Recompute the current line if marked for it, and if we haven't just done it."
2519 org-tbl-calc-modes)
2521 ;;;###autoload
2523 suppress-align suppress-const
2524 suppress-store suppress-analysis)
2525 "Replace the table field value at the cursor by the result of a calculation.
2527 This function makes use of Dave Gillespie's Calc package, in my view the
2528 most exciting program ever written for GNU Emacs. So you need to have Calc
2529 installed in order to use this function.
2531 In a table, this command replaces the value in the current field with the
2533 formula, by storing it in a special line below the table. When called
2534 with a `C-u' prefix, the current field must be a named field, and the
2535 formula is installed as valid in only this specific field.
2537 When called with two `C-u' prefixes, insert the active equation
2538 for the field back into the current field, so that it can be
2540 to check the referenced fields.
2542 When called, the command first prompts for a formula, which is read in
2543 the minibuffer. Previously entered formulas are available through the
2544 history list, and the last used formula is offered as a default.
2545 These stored formulas are adapted correctly when moving, inserting, or
2546 deleting columns with the corresponding commands.
2548 The formula can be any algebraic expression understood by the Calc package.
2549 For details, see the Org-mode manual.
2551 This function can also be called from Lisp programs and offers
2552 additional arguments: EQUATION can be the formula to apply. If this
2553 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2554 used to speed-up recursive calls by by-passing unnecessary aligns.
2555 SUPPRESS-CONST suppresses the interpretation of constants in the
2556 formula, assuming that this has been done already outside the function.
2557 SUPPRESS-STORE means the formula should not be stored, either because
2558 it is already stored, or because it is a modified equation that should
2559 not overwrite the stored one."
2575 equation
2581 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2582 duration duration-output-format)
2583 ;; Parse the format string. Since we have a lot of modes, this is
2584 ;; a lot of work. However, I think calc still uses most of the time.
2597 'calc-float-format
2600 n))))
2604 duration-output-format nil
2608 duration-output-format org-table-duration-custom-format
2609 numbers t
2632 ;; replace fields with duration values if relevant
2636 fields)))
2642 x))
2643 fields)))
2649 ;; Insert row and column number of formula result field
2660 t t form)))
2662 ;; Check for old vertical references
2664 ;; Insert remote references
2677 rmtrng))
2678 keep-empty numbers lispp))
2679 t t form)))
2680 ;; Insert complex ranges
2688 ;; possibly handle durations
2693 formrg)
2694 keep-empty numbers lispp)))
2699 ;; Insert simple ranges
2708 keep-empty numbers lispp))
2709 t t form)))
2711 ;; Insert the references to fields in same row
2718 x keep-empty numbers lispp)))
2736 ;; Use <...> time-stamps so that Calc can handle them
2739 ;; I18n-ize local time-stamps by setting (system-time-locale "C")
2750 form
2757 duration-output-format)
2758 ev)))
2763 Orig: %s
2764 $xyz-> %s
2765 @r$c-> %s
2797 prop value)))
2800 "Get a calc vector from a column, according to descriptor DESC.
2801 Optional arguments TBEG and COL can give the beginning of the table and
2802 the current column, to avoid unnecessary parsing.
2804 HIGHLIGHT means just highlight the range.
2806 When CORNERS-ONLY is set, only return the corners of the range as
2807 a list (line1 column1 line2 column2) where line1 and line2 are line numbers
2808 in the buffer and column1 and column2 are table column numbers."
2815 beg end c1 c2 r1 r2 rangep tmp)
2832 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2839 ;; just one field
2846 ;; A range, return a vector
2847 ;; First sort the numbers to get a regular rectangle
2851 ;; Only return the corners of the range
2853 ;; Copy the range values into a list
2867 ;; return string representation of calc vector
2872 "Analyze descriptor DESC and retrieve the corresponding line number.
2873 The cursor is currently in line CLINE, the table begins in line BLINE,
2874 and TABLE is a vector with line types."
2882 ;; 1 2 3 4 5 6
2902 nil hn cline desc)))
2905 rel on cline desc)))
2909 "FIXME: Needs more documentation."
2922 nil))
2923 t)))
2927 desc cline)
2928 i)))
2933 s))
2936 "Convert list ELEMENTS to something appropriate to insert into formula.
2937 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2938 NUMBERS indicates that everything should be converted to numbers.
2939 LISPP non-nil means to return something appropriate for a Lisp
2940 list, 'literal is for the format specifier L."
2941 ;; Calc nan (not a number) is used for the conversion of the empty
2942 ;; field to a reference for several reasons: (i) It is accepted in a
2943 ;; Calc formula (e. g. "" or "()" would result in a Calc error).
2944 ;; (ii) In a single field (not in range) it can be distinguished
2945 ;; from "(nan)" which is the reference made from a single field
2946 ;; containing "nan".
2948 ;; field reference
2951 elements
2953 ""
2962 ;; range reference
2967 elements))))
2973 x
2981 x)
2983 elements
2986 ;;;###autoload
2988 "Set `org-table-formula-constants-local' in the current buffer."
3004 ;;;###autoload
3006 "Recalculate the current table line by applying all stored formulas.
3007 With prefix arg ALL, do this for all lines in the table.
3008 With the prefix argument ALL is `(16)' \
3010 it is the symbol `iterate', recompute the table until it no longer changes.
3011 If NOALIGN is not nil, do not re-align the table after the computations
3012 are done. This is typically used internally to save time, if it is
3013 known that the table will be realigned a little later anyway."
3028 seen-fields lhs1
3030 ;; Insert constants in all formulas
3048 eqlist))
3049 ;; Split the equation list
3055 ;; Expand ranges in lhs of formulas
3058 ;; Get the correct line range to process
3064 ;; This is a table with marked lines, compute selected lines
3066 ;; Move forward to the first non-header line
3077 ;; First find the named fields, and mark them untouchable.
3078 ;; Also check if several field/range formulas try to set the same field.
3097 name)))
3107 ;; Now evaluate the column formulas, but skip fields covered by
3108 ;; field formulas
3112 ;; Unprotected line, recalculate
3124 ;; Now evaluate the field formulas
3138 ;; back to initial position
3145 ;;;###autoload
3147 "Recalculate the table until it does not change anymore.
3148 The maximum number of iterations is 10, but you can choose a different value
3149 with the prefix ARG."
3154 thistbl)
3168 ;;;###autoload
3170 "Recalculate all tables in the current buffer."
3177 ;;;###autoload
3179 "Iterate all tables in the buffer, to converge inter-table dependencies."
3184 c1)
3200 "Apply the #+TBLFM in the line at point to the table."
3206 s e)
3208 ;; Insert a temporary formula at right after the table
3213 ;; Recalculate the table
3219 ;; delete the formula inserted temporarily
3223 "Find the beginning of the TBLFM lines and return its position.
3224 Return nil when the beginning of TBLFM line was not found."
3228 org-table-TBLFM-begin-regexp
3229 nil t))
3233 "Expand list of formulas.
3234 If some of the RHS in the formulas are ranges or a row reference, expand
3235 them to individual field equations for each field."
3241 ;; This just refers to one fixed field
3244 ;; This just refers to one fixed named field
3266 "Replace @<, @>, $<, $> with first/last row/column of the table.
3267 So @< and $< will always be replaced with @1 and $1, respectively.
3268 The advantage of these special markers are that structure editing of
3269 the table will not change them, while @1 and $1 will be modified
3270 when a line/row is swapped out of that privileged position. So for
3271 formulas that use a range of rows or columns, it may often be better
3273 borders of the table using the @< @> $< $> makers."
3276 s start)
3281 org-table-current-ncol)
3285 len
3292 s)
3295 "Replace $const with values in string F."
3297 ;; First, check for column names
3302 ;; Parameters and constants
3304 (while (setq start (string-match "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)" f start))
3314 f))
3317 "Find the value for a parameter or constant in a formula.
3318 Parameters get priority."
3349 map))
3356 "--"
3359 "--"
3360 "Shift Reference at Point"
3365 "-"
3366 "Change Test Row for Column Formulas"
3369 "--"
3374 org-table-overlay-coordinates)]
3375 "--"
3381 ;;;###autoload
3383 "Edit the formulas of the current table in a separate buffer."
3385 (when (save-excursion (beginning-of-line 1) (let ((case-fold-search t)) (looking-at "[ \t]*#\\+TBLFM")))
3399 entry s type title)
3402 ;; Keep global-font-lock-mode from turning on font-lock-mode
3443 "Convert a formula from internal to user representation."
3446 s))
3449 "Convert a formula from user to internal representation."
3452 s))
3455 "Convert spreadsheet references from A7 to @7$28.
3456 Works for single references, but also for entire formulas and even the
3457 full TBLFM line."
3459 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3462 ;; format match, just advance
3467 ;; 3.e5 or something like this.
3470 ;; (member (match-string 1 s)
3471 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3472 )
3473 ;; function name, just advance
3483 t t s)))))
3484 s))
3487 "Convert spreadsheet references from to @7$28 to AB7.
3488 Works for single references, but also for entire formulas and even the
3489 full TBLFM line."
3496 t t s)))
3501 t nil s)))
3502 s)
3505 "Convert a base 26 number represented by letters into an integer.
3506 For example: AB -> 28."
3512 n))
3515 "Convert an integer into a base 26 number represented by letters.
3516 For example: 28 -> AB."
3521 s))
3524 "Convert a time string into numerical duration in seconds.
3525 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3526 If S is a string representing a number, keep this number."
3528 s
3551 "Convert a number of seconds to a time string.
3552 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3553 minutes or seconds."
3568 "Convert all references in this buffer, using FUNCTION."
3578 "Convert all references in the buffer from B3 to @3$2 and back."
3588 "Shift the reference at point one row/hline up."
3592 "Shift the reference at point one row/hline down."
3596 "Shift the reference at point one field to the left."
3600 "Shift the reference at point one field to the right."
3611 ;; A B3-like reference
3617 ;; An internal reference
3623 "Re-match the group N, and replace it with the shifted reference."
3628 t t)))
3631 "Shift a reference part REF.
3632 If DECR is set, decrease the references row/column, else increase.
3633 If HLINE is set, this may be a hline reference, it certainly is not
3634 a translation reference."
3663 "Toggle the display of coordinates in the referenced table."
3672 "Parse the buffer for formula definitions and install them.
3673 With prefix ARG, apply the new formulas to the table."
3683 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3684 nil t)
3708 "Abort editing formulas, without installing the changes."
3719 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3760 "Show the location/value of the $ expression at point."
3769 var name e what match dest)
3774 "$1.."
3857 ;; column number
3885 org-table-fedit-scroll-down))))
3897 "Make sure the cursor is in a dataline in a table."
3906 p1 p2)))
3911 "Move cursor one line up in the window showing the table."
3916 "Move cursor one line down in the window showing the table."
3921 "Move the cursor in the window showing the table.
3922 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
3947 "Add a new overlay."
3953 "Highlight rectangular region in a table."
3957 l1 c1 l2 c2 tmp)
3981 "Remove the rectangle overlays."
3992 "Add overlays to the table at point, to show row/column coordinates."
4020 ;;;###autoload
4022 "Toggle the display of Row/Column numbers in tables."
4033 ;;;###autoload
4035 "Toggle the formula debugger in tables."
4041 ;;; The orgtbl minor mode
4043 ;; Define a minor mode which can be used in other modes in order to
4044 ;; integrate the org-mode table editor.
4046 ;; This is really a hack, because the org-mode table editor uses several
4047 ;; keys which normally belong to the major mode, for example the TAB and
4048 ;; RET keys. Here is how it works: The minor mode defines all the keys
4049 ;; necessary to operate the table editor, but wraps the commands into a
4050 ;; function which tests if the cursor is currently inside a table. If that
4051 ;; is the case, the table editor command is executed. However, when any of
4052 ;; those keys is used outside a table, the function uses `key-binding' to
4053 ;; look up if the key has an associated command in another currently active
4054 ;; keymap (minor modes, major mode, global), and executes that command.
4055 ;; There might be problems if any of the keys used by the table editor is
4056 ;; otherwise used as a prefix key.
4058 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
4059 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
4060 ;; addresses this by checking explicitly for both bindings.
4062 ;; The optimized version (see variable `orgtbl-optimized') takes over
4063 ;; all keys which are bound to `self-insert-command' in the *global map*.
4064 ;; Some modes bind other commands to simple characters, for example
4065 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
4066 ;; active, this binding is ignored inside tables and replaced with a
4067 ;; modified self-insert.
4085 ;; Install it as a minor mode.
4089 ;;;###autoload
4091 "The `org-mode' table editor as a minor mode for use in other modes."
4096 ;; Exit without error, in case some hook functions calls this
4097 ;; by accident in org-mode.
4101 ;; Make sure we are first in minor-mode-map-alist
4103 ;; FIXME: maybe it should use emulation-mode-map-alists?
4110 auto-fill-inhibit-regexp)
4114 auto-fill-inhibit-regexp)
4115 orgtbl-line-start-regexp))
4133 "Remove all properties related to narrow-column invisibility."
4146 "Create a function for binding in the table minor mode.
4147 FUN is the command to call inside a table. N is used to create a unique
4148 command name. KEYS are keys that should be checked in for a command
4149 to execute outside of tables."
4155 "Outside of tables, run the binding of `"
4167 keys)
4171 "Error when there is no default binding for a table key."
4176 "Setup orgtbl keymaps."
4207 elt key fun cmd)
4215 ;; Special treatment needed for TAB and RET
4235 [(tab)] "\C-i")))
4237 (org-defkey orgtbl-mode-map [backtab]
4239 [backtab] [S-iso-lefttab] [(shift tab)]
4240 [(tab)] "\C-i"))
4242 (org-defkey orgtbl-mode-map "\M-\C-m"
4243 (orgtbl-make-binding 'org-table-wrap-region 105
4244 "\M-\C-m" [(meta return)]))
4245 (org-defkey orgtbl-mode-map [(meta return)]
4246 (orgtbl-make-binding 'org-table-wrap-region 106
4247 [(meta return)] "\M-\C-m"))
4249 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4250 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4252 (when orgtbl-optimized
4253 ;; If the user wants maximum table support, we need to hijack
4254 ;; some standard editing functions
4255 (org-remap orgtbl-mode-map
4256 'self-insert-command 'orgtbl-self-insert-command
4257 'delete-char 'org-delete-char
4258 'delete-backward-char 'org-delete-backward-char)
4259 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4260 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4261 '("OrgTbl"
4262 ["Create or convert" org-table-create-or-convert-from-region
4263 :active (not (org-at-table-p)) :keys "C-c |" ]
4264 "--"
4265 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4266 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4267 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4268 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4269 "--"
4270 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4271 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4272 ["Copy Field from Above"
4273 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4274 "--"
4275 ("Column"
4276 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4277 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4278 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4279 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"]
4280 ["Ascii plot" orgtbl-ascii-plot :active (org-at-table-p) :keys "C-c p"])
4281 ("Row"
4282 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4283 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4284 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4285 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4286 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4287 "--"
4288 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4289 ("Rectangle"
4290 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4291 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4292 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4293 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4294 "--"
4295 ("Radio tables"
4296 ["Insert table template" orgtbl-insert-radio-table
4297 (assq major-mode orgtbl-radio-table-templates)]
4298 ["Comment/uncomment table" orgtbl-toggle-comment t])
4299 "--"
4300 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4301 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4302 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4303 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4304 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4305 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4306 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4307 ["Sum Column/Rectangle" org-table-sum
4308 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4309 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4310 ["Debug Formulas"
4311 org-table-toggle-formula-debugger :active (org-at-table-p)
4312 :keys "C-c {"
4313 :style toggle :selected org-table-formula-debug]
4314 ["Show Col/Row Numbers"
4315 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4316 :keys "C-c }"
4317 :style toggle :selected org-table-overlay-coordinates]
4318 ))
4319 t))
4321 (defun orgtbl-ctrl-c-ctrl-c (arg)
4322 "If the cursor is inside a table, realign the table.
4323 If it is a table to be sent away to a receiver, do it.
4324 With prefix arg, also recompute table."
4325 (interactive "P")
4326 (let ((case-fold-search t) (pos (point)) action)
4327 (save-excursion
4328 (beginning-of-line 1)
4329 (setq action (cond
4333 (cond
4334 ((integerp action)
4335 (goto-char action)
4336 (org-table-maybe-eval-formula)
4337 (if arg
4338 (call-interactively 'org-table-recalculate)
4339 (org-table-maybe-recalculate-line))
4340 (call-interactively 'org-table-align)
4341 (when (orgtbl-send-table 'maybe)
4342 (run-hooks 'orgtbl-after-send-table-hook)))
4343 ((eq action 'recalc)
4344 (org-table-set-constants)
4345 (save-excursion
4346 (beginning-of-line 1)
4348 (if (org-at-table-p)
4349 (org-call-with-arg 'org-table-recalculate t))))
4350 (t (let (orgtbl-mode)
4351 (call-interactively (key-binding "\C-c\C-c")))))))
4353 (defun orgtbl-create-or-convert-from-region (arg)
4354 "Create table or convert region to table, if no conflicting binding.
4355 This installs the table binding `C-c |', but only if there is no
4356 conflicting binding to this key outside orgtbl-mode."
4357 (interactive "P")
4358 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4359 (if cmd
4360 (call-interactively cmd)
4361 (call-interactively 'org-table-create-or-convert-from-region))))
4363 (defun orgtbl-tab (arg)
4364 "Justification and field motion for `orgtbl-mode'."
4365 (interactive "P")
4366 (if arg (org-table-edit-field t)
4367 (org-table-justify-field-maybe)
4368 (org-table-next-field)))
4370 (defun orgtbl-ret ()
4371 "Justification and field motion for `orgtbl-mode'."
4372 (interactive)
4373 (if (bobp)
4374 (newline)
4375 (org-table-justify-field-maybe)
4376 (org-table-next-row)))
4378 (defun orgtbl-self-insert-command (N)
4379 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4380 If the cursor is in a table looking at whitespace, the whitespace is
4381 overwritten, and the table is not marked as requiring realignment."
4382 (interactive "p")
4383 (if (and (org-at-table-p)
4384 (or
4385 (and org-table-auto-blank-field
4386 (member last-command
4387 '(orgtbl-hijacker-command-100
4388 orgtbl-hijacker-command-101
4389 orgtbl-hijacker-command-102
4390 orgtbl-hijacker-command-103
4391 orgtbl-hijacker-command-104
4392 orgtbl-hijacker-command-105
4393 yas/expand))
4394 (org-table-blank-field))
4395 t)
4396 (eq N 1)
4398 (let (org-table-may-need-update)
4399 (goto-char (1- (match-end 0)))
4400 (org-delete-backward-char 1)
4401 (goto-char (match-beginning 0))
4402 (self-insert-command N))
4403 (setq org-table-may-need-update t)
4404 (let* (orgtbl-mode
4405 a
4406 (cmd (or (key-binding
4407 (or (and (listp function-key-map)
4408 (setq a (assoc last-input-event function-key-map))
4409 (cdr a))
4410 (vector last-input-event)))
4411 'self-insert-command)))
4412 (call-interactively cmd)
4413 (if (and org-self-insert-cluster-for-undo
4414 (eq cmd 'self-insert-command))
4415 (if (not (eq last-command 'orgtbl-self-insert-command))
4416 (setq org-self-insert-command-undo-counter 1)
4417 (if (>= org-self-insert-command-undo-counter 20)
4418 (setq org-self-insert-command-undo-counter 1)
4419 (and (> org-self-insert-command-undo-counter 0)
4420 buffer-undo-list
4421 (not (cadr buffer-undo-list)) ; remove nil entry
4422 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4423 (setq org-self-insert-command-undo-counter
4424 (1+ org-self-insert-command-undo-counter))))))))
4427 "Regular expression matching exponentials as produced by calc.")
4429 (defun orgtbl-gather-send-defs ()
4430 "Gather a plist of :name, :transform, :params for each destination before
4431 a radio table."
4432 (save-excursion
4433 (goto-char (org-table-begin))
4434 (let (rtn)
4435 (beginning-of-line 0)
4436 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4437 (let ((name (org-no-properties (match-string 1)))
4438 (transform (intern (match-string 2)))
4439 (params (if (match-end 3)
4440 (read (concat "(" (match-string 3) ")")))))
4441 (push (list :name name :transform transform :params params)
4442 rtn)
4443 (beginning-of-line 0)))
4444 rtn)))
4446 (defun orgtbl-send-replace-tbl (name txt)
4447 "Find and replace table NAME with TXT."
4448 (save-excursion
4449 (goto-char (point-min))
4450 (unless (re-search-forward
4452 (user-error "Don't know where to insert translated table"))
4453 (let ((beg (line-beginning-position 2)))
4454 (unless (re-search-forward
4455 (concat "END +RECEIVE +ORGTBL +" name) nil t)
4456 (user-error "Cannot find end of insertion region"))
4457 (beginning-of-line)
4458 (delete-region beg (point)))
4461 ;;;###autoload
4462 (defun org-table-to-lisp (&optional txt)
4463 "Convert the table at point to a Lisp structure.
4464 The structure will be a list. Each item is either the symbol `hline'
4465 for a horizontal separator line, or a list of field values as strings.
4466 The table is taken from the parameter TXT, or from the buffer at point."
4467 (unless (or txt (org-at-table-p)) (user-error "No table at point"))
4468 (let ((txt (or txt
4469 (buffer-substring-no-properties (org-table-begin)
4470 (org-table-end)))))
4471 (mapcar (lambda (x)
4472 (if (string-match org-table-hline-regexp x) 'hline
4476 (defun orgtbl-send-table (&optional maybe)
4477 "Send a transformed version of table at point to the receiver position.
4478 With argument MAYBE, fail quietly if no transformation is defined
4479 for this table."
4480 (interactive)
4481 (catch 'exit
4482 (unless (org-at-table-p) (user-error "Not at a table"))
4483 ;; when non-interactive, we assume align has just happened.
4484 (when (org-called-interactively-p 'any) (org-table-align))
4485 (let ((dests (orgtbl-gather-send-defs))
4486 (table (org-table-to-lisp
4487 (buffer-substring-no-properties (org-table-begin)
4488 (org-table-end))))
4489 (ntbl 0))
4490 (unless dests
4491 (if maybe (throw 'exit nil)
4492 (user-error "Don't know how to transform this table")))
4493 (dolist (dest dests)
4494 (let ((name (plist-get dest :name))
4495 (transform (plist-get dest :transform))
4496 (params (plist-get dest :params)))
4497 (unless (fboundp transform)
4498 (user-error "No such transformation function %s" transform))
4499 (orgtbl-send-replace-tbl name (funcall transform table params)))
4500 (incf ntbl))
4501 (message "Table converted and installed at %d receiver location%s"
4502 ntbl (if (> ntbl 1) "s" ""))
4503 (and (> ntbl 0) ntbl))))
4505 (defun org-remove-by-index (list indices &optional i0)
4506 "Remove the elements in LIST with indices in INDICES.
4507 First element has index 0, or I0 if given."
4508 (if (not indices)
4509 list
4510 (if (integerp indices) (setq indices (list indices)))
4511 (setq i0 (1- (or i0 0)))
4512 (delq :rm (mapcar (lambda (x)
4513 (setq i0 (1+ i0))
4514 (if (memq i0 indices) :rm x))
4515 list))))
4517 (defun orgtbl-toggle-comment ()
4518 "Comment or uncomment the orgtbl at point."
4519 (interactive)
4520 (let* ((case-fold-search t)
4521 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4522 (re2 (concat "^" orgtbl-line-start-regexp))
4523 (commented (save-excursion (beginning-of-line 1)
4524 (cond ((looking-at re1) t)
4525 ((looking-at re2) nil)
4526 (t (user-error "Not at an org table")))))
4527 (re (if commented re1 re2))
4528 beg end)
4529 (save-excursion
4530 (beginning-of-line 1)
4531 (while (looking-at re) (beginning-of-line 0))
4532 (beginning-of-line 2)
4533 (setq beg (point))
4534 (while (looking-at re) (beginning-of-line 2))
4535 (setq end (point)))
4536 (comment-region beg end (if commented '(4) nil))))
4538 (defun orgtbl-insert-radio-table ()
4539 "Insert a radio table template appropriate for this major mode."
4540 (interactive)
4541 (let* ((e (assq major-mode orgtbl-radio-table-templates))
4542 (txt (nth 1 e))
4543 name pos)
4544 (unless e (user-error "No radio table setup defined for %s" major-mode))
4545 (setq name (read-string "Table name: "))
4546 (while (string-match "%n" txt)
4547 (setq txt (replace-match name t t txt)))
4549 (setq pos (point))
4550 (insert txt)
4551 (goto-char pos)))
4553 ;;;###autoload
4554 (defun orgtbl-to-generic (table params)
4555 "Convert the orgtbl-mode TABLE to some other format.
4557 This generic routine can be used for many standard cases.
4559 TABLE is a list, each entry either the symbol `hline' for
4560 a horizontal separator line, or a list of fields for that
4561 line. PARAMS is a property list of parameters that can
4562 influence the conversion.
4564 Valid parameters are:
4566 :backend, :raw
4568 Export back-end used as a basis to transcode elements of the
4569 table, when no specific parameter applies to it. It is also
4570 used to translate cells contents. You can prevent this by
4571 setting :raw property to a non-nil value.
4573 :splice
4575 When non-nil, only convert rows, not the table itself. This is
4576 equivalent to setting to the empty string both :tstart
4577 and :tend, which see.
4579 :skip
4581 When set to an integer N, skip the first N lines of the table.
4582 Horizontal separation lines do count for this parameter!
4584 :skipcols
4586 List of columns that should be skipped. If the table has
4587 a column with calculation marks, that column is automatically
4588 discarded beforehand.
4590 :hline
4592 String to be inserted on horizontal separation lines. May be
4593 nil to ignore these lines altogether.
4595 :sep
4597 Separator between two fields, as a string.
4599 Each in the following group may be either a string or a function
4600 of no arguments returning a string:
4602 :tstart, :tend
4604 Strings to start and end the table. Ignored when :splice is t.
4606 :lstart, :lend
4608 Strings to start and end a new table line.
4610 :llstart, :llend
4612 Strings to start and end the last table line. Default,
4613 respectively, to :lstart and :lend.
4615 Each in the following group may be a string or a function of one
4616 argument (either the cells in the current row, as a list of
4617 strings, or the current cell) returning a string:
4619 :lfmt
4621 Format string for an entire row, with enough %s to capture all
4622 fields. When non-nil, :lstart, :lend, and :sep are ignored.
4624 :llfmt
4626 Format for the entire last line, defaults to :lfmt.
4628 :fmt
4630 A format to be used to wrap the field, should contain %s for
4631 the original field value. For example, to wrap everything in
4633 a property list with column numbers and format strings, or
4634 functions, e.g.,
4638 :hlstart :hllstart :hlend :hllend :hsep :hlfmt :hllfmt :hfmt
4640 Same as above, specific for the header lines in the table.
4641 All lines before the first hline are treated as header. If
4642 any of these is not present, the data line value is used.
4644 This may be either a string or a function of two arguments:
4646 :efmt
4648 Use this format to print numbers with exponential. The format
4649 should have %s twice for inserting mantissa and exponent, for
4651 list with column numbers and format strings or functions.
4652 :fmt will still be applied after :efmt."
4653 (let ((backend (plist-get params :backend)))
4654 (when (and backend (symbolp backend) (not (org-export-get-backend backend)))
4655 (user-error "Unknown :backend value"))
4656 (when (or (not backend) (plist-get params :raw)) (require 'ox-org))
4657 (org-trim
4658 (org-export-string-as
4659 ;; Return TABLE as Org syntax. Tolerate non-string cells.
4660 (with-output-to-string
4661 (dolist (e table)
4663 ((consp e)
4664 (princ "| ") (dolist (c e) (princ c) (princ " |"))
4666 ;; Build a custom back-end according to PARAMS. Before defining
4667 ;; a translator, check if there is anything to do. When there
4668 ;; isn't, let BACKEND handle the element.
4669 (org-export-create-backend
4670 :parent (or backend 'org)
4671 :filters
4672 '((:filter-parse-tree
4673 ;; Handle :skip parameter.
4674 (lambda (tree backend info)
4675 (let ((skip (plist-get info :skip)))
4676 (when skip
4677 (unless (wholenump skip) (user-error "Wrong :skip value"))
4678 (let ((n 0))
4679 (org-element-map tree 'table-row
4680 (lambda (row)
4681 (if (>= n skip) t
4682 (org-element-extract-element row)
4683 (incf n)
4684 nil))
4685 info t))
4686 tree)))
4687 ;; Handle :skipcols parameter.
4688 (lambda (tree backend info)
4689 (let ((skipcols (plist-get info :skipcols)))
4690 (when skipcols
4691 (unless (consp skipcols) (user-error "Wrong :skipcols value"))
4692 (org-element-map tree 'table
4693 (lambda (table)
4694 (let ((specialp
4695 (org-export-table-has-special-column-p table)))
4696 (dolist (row (org-element-contents table))
4697 (when (eq (org-element-property :type row) 'standard)
4698 (let ((c 1))
4699 (dolist (cell (nthcdr (if specialp 1 0)
4700 (org-element-contents row)))
4701 (when (memq c skipcols)
4702 (org-element-extract-element cell))
4703 (incf c)))))))
4704 info)
4705 tree)))))
4706 :transcoders
4707 `((table . ,(org-table--to-generic-table params))
4708 (table-row . ,(org-table--to-generic-row params))
4709 (table-cell . ,(org-table--to-generic-cell params))
4710 ;; Section. Return contents to avoid garbage around table.
4711 (section . (lambda (s c i) c))))
4712 'body-only (org-combine-plists params '(:with-tables t))))))
4714 (defun org-table--generic-apply (value name &optional with-cons &rest args)
4715 (cond ((null value) nil)
4716 ((functionp value) `(funcall ',value ,@args))
4717 ((stringp value)
4718 (cond ((consp (car args)) `(apply #'format ,value ,@args))
4719 (args `(format ,value ,@args))
4720 (t value)))
4721 ((and with-cons (consp value))
4722 `(let ((val (cadr (memq column ',value))))
4723 (cond ((null val) contents)
4724 ((stringp val) (format val ,@args))
4725 ((functionp val) (funcall val ,@args))
4726 (t (user-error "Wrong %s value" ,name)))))
4727 (t (user-error "Wrong %s value" name))))
4729 (defun org-table--to-generic-table (params)
4730 "Return custom table transcoder according to PARAMS.
4731 PARAMS is a plist. See `orgtbl-to-generic' for more
4732 information."
4733 (let ((backend (plist-get params :backend))
4734 (splice (plist-get params :splice))
4735 (tstart (plist-get params :tstart))
4736 (tend (plist-get params :tend)))
4737 `(lambda (table contents info)
4738 (concat
4739 ,(and tstart (not splice)
4741 ,(if (or (not backend) tstart tend splice) 'contents
4742 `(org-export-with-backend ',backend table contents info))
4743 ,(org-table--generic-apply (and (not splice) tend) ":tend")))))
4745 (defun org-table--to-generic-row (params)
4746 "Return custom table row transcoder according to PARAMS.
4747 PARAMS is a plist. See `orgtbl-to-generic' for more
4748 information."
4749 (let* ((backend (plist-get params :backend))
4750 (lstart (plist-get params :lstart))
4751 (llstart (plist-get params :llstart))
4752 (hlstart (plist-get params :hlstart))
4753 (hllstart (plist-get params :hllstart))
4754 (lend (plist-get params :lend))
4755 (llend (plist-get params :llend))
4756 (hlend (plist-get params :hlend))
4757 (hllend (plist-get params :hllend))
4758 (lfmt (plist-get params :lfmt))
4759 (llfmt (plist-get params :llfmt))
4760 (hlfmt (plist-get params :hlfmt))
4761 (hllfmt (plist-get params :hllfmt)))
4762 `(lambda (row contents info)
4763 (if (eq (org-element-property :type row) 'rule)
4764 ,(cond
4765 ((plist-member params :hline)
4766 (org-table--generic-apply (plist-get params :hline) ":hline"))
4767 (backend `(org-export-with-backend ',backend row nil info)))
4768 (let ((headerp (org-export-table-row-in-header-p row info))
4769 (lastp (not (org-export-get-next-element row info)))
4770 (last-header-p (org-export-table-row-ends-header-p row info)))
4771 (when contents
4772 ;; Check if we can apply `:lfmt', `:llfmt', `:hlfmt', or
4773 ;; `:hllfmt' to CONTENTS. Otherwise, fallback on
4774 ;; `:lstart', `:lend' and their relatives.
4775 ,(let ((cells
4776 '(org-element-map row 'table-cell
4777 (lambda (cell)
4778 ;; Export all cells, without separators.
4779 ;;
4780 ;; Use `org-export-data-with-backend'
4781 ;; instead of `org-export-data' to eschew
4782 ;; cached values, which
4783 ;; ignore :orgtbl-ignore-sep parameter.
4784 (org-export-data-with-backend
4785 cell
4786 (plist-get info :back-end)
4787 (org-combine-plists info '(:orgtbl-ignore-sep t))))
4788 info)))
4789 `(cond
4790 ,(and hllfmt
4791 `(last-header-p ,(org-table--generic-apply
4792 hllfmt ":hllfmt" nil cells)))
4793 ,(and hlfmt
4794 `(headerp ,(org-table--generic-apply
4795 hlfmt ":hlfmt" nil cells)))
4796 ,(and llfmt
4797 `(lastp ,(org-table--generic-apply
4798 llfmt ":llfmt" nil cells)))
4799 (t
4800 ,(if lfmt (org-table--generic-apply lfmt ":lfmt" nil cells)
4801 `(concat
4802 (cond
4803 ,(and
4804 (or hllstart hllend)
4805 `(last-header-p
4806 (concat
4807 ,(org-table--generic-apply hllstart ":hllstart")
4808 contents
4809 ,(org-table--generic-apply hllend ":hllend"))))
4810 ,(and
4811 (or hlstart hlend)
4812 `(headerp
4813 (concat
4814 ,(org-table--generic-apply hlstart ":hlstart")
4815 contents
4816 ,(org-table--generic-apply hlend ":hlend"))))
4817 ,(and
4818 (or llstart llend)
4819 `(lastp
4820 (concat
4821 ,(org-table--generic-apply llstart ":llstart")
4822 contents
4823 ,(org-table--generic-apply llend ":llend"))))
4824 (t
4825 ,(cond
4826 ((or lstart lend)
4827 `(concat
4828 ,(org-table--generic-apply lstart ":lstart")
4829 contents
4830 ,(org-table--generic-apply lend ":lend")))
4831 (backend
4832 `(org-export-with-backend
4833 ',backend row contents info))
4834 (t 'contents)))))))))))))))
4836 (defun org-table--to-generic-cell (params)
4837 "Return custom table cell transcoder according to PARAMS.
4838 PARAMS is a plist. See `orgtbl-to-generic' for more
4839 information."
4840 (let* ((backend (plist-get params :backend))
4841 (efmt (plist-get params :efmt))
4842 (fmt (plist-get params :fmt))
4843 (hfmt (plist-get params :hfmt))
4844 (sep (plist-get params :sep))
4845 (hsep (plist-get params :hsep)))
4846 `(lambda (cell contents info)
4847 (let ((headerp (org-export-table-row-in-header-p
4848 (org-export-get-parent-element cell) info))
4849 (column (1+ (cdr (org-export-table-cell-address cell info)))))
4850 ;; Make sure that contents are exported as Org data when :raw
4851 ;; parameter is non-nil.
4852 ,(when (and backend (plist-get params :raw))
4853 `(setq contents (org-export-data-with-backend
4854 (org-element-contents cell) 'org info)))
4855 (when contents
4856 ;; Check if we can apply `:efmt' on CONTENTS.
4857 ,(when efmt
4858 `(when (string-match orgtbl-exp-regexp contents)
4859 (let ((mantissa (match-string 1 contents))
4860 (exponent (match-string 2 contents)))
4861 (setq contents ,(org-table--generic-apply
4862 efmt ":efmt" t 'mantissa 'exponent)))))
4863 ;; Check if we can apply FMT (or HFMT) on CONTENTS.
4864 (cond
4865 ,(and hfmt `(headerp (setq contents ,(org-table--generic-apply
4866 hfmt ":hfmt" t 'contents))))
4867 ,(and fmt `(t (setq contents ,(org-table--generic-apply
4868 fmt ":hfmt" t 'contents))))))
4869 ;; If a separator is provided, use it instead of BACKEND's.
4870 ;; Separators are ignored when LFMT (or equivalent) is
4871 ;; provided.
4872 ,(cond
4873 ((or hsep sep)
4874 `(if (or ,(and (not sep) '(not headerp))
4875 (plist-get info :orgtbl-ignore-sep)
4876 (not (org-export-get-next-element cell info)))
4877 ,(if (not backend) 'contents
4878 `(org-export-with-backend ',backend cell contents info))
4879 (concat contents
4880 ,(if (and sep hsep) `(if headerp ,hsep ,sep)
4881 (or hsep sep)))))
4882 (backend `(org-export-with-backend ',backend cell contents info))
4883 (t 'contents))))))
4885 ;;;###autoload
4886 (defun orgtbl-to-tsv (table params)
4887 "Convert the orgtbl-mode table to TAB separated material."
4890 ;;;###autoload
4891 (defun orgtbl-to-csv (table params)
4892 "Convert the orgtbl-mode table to CSV material.
4893 This does take care of the proper quoting of fields with comma or quotes."
4894 (orgtbl-to-generic table
4895 (org-combine-plists '(:sep "," :fmt org-quote-csv-field)
4896 params)))
4898 ;;;###autoload
4899 (defun orgtbl-to-latex (table params)
4900 "Convert the orgtbl-mode TABLE to LaTeX.
4902 TABLE is a list, each entry either the symbol `hline' for
4903 a horizontal separator line, or a list of fields for that line.
4904 PARAMS is a property list of parameters that can influence the
4905 conversion. All parameters from `orgtbl-to-generic' are
4906 supported. It is also possible to use the following ones:
4908 :booktabs
4912 :environment
4914 Specify environment to use, as a string. If you use
4916 as a string, to get proper continuation strings."
4917 (require 'ox-latex)
4918 (orgtbl-to-generic
4919 table
4920 (org-combine-plists
4921 ;; Provide sane default values.
4922 (list :backend 'latex
4923 :latex-default-table-mode 'table
4924 :latex-tables-centered nil
4925 :latex-tables-booktabs (plist-get params :booktabs)
4926 :latex-table-scientific-notation nil
4927 :latex-default-table-environment
4928 (or (plist-get params :environment) "tabular"))
4929 params)))
4931 ;;;###autoload
4932 (defun orgtbl-to-html (table params)
4933 "Convert the orgtbl-mode TABLE to HTML.
4935 TABLE is a list, each entry either the symbol `hline' for
4936 a horizontal separator line, or a list of fields for that line.
4937 PARAMS is a property list of parameters that can influence the
4938 conversion. All parameters from `orgtbl-to-generic' are
4939 supported. It is also possible to use the following one:
4941 :attributes
4943 Attributes and values, as a plist, which will be used in
4944 <table> tag."
4945 (require 'ox-html)
4946 (orgtbl-to-generic
4947 table
4948 (org-combine-plists
4949 ;; Provide sane default values.
4950 (list :backend 'html
4951 :html-table-data-tags '("<td%s>" . "</td>")
4952 :html-table-use-header-tags-for-first-column nil
4953 :html-table-align-individual-fields t
4954 :html-table-row-tags '("<tr>" . "</tr>")
4955 :html-table-attributes
4956 (if (plist-member params :attributes)
4957 (plist-get params :attributes)
4958 '(:border "2" :cellspacing "0" :cellpadding "6" :rules "groups"
4959 :frame "hsides")))
4960 params)))
4962 ;;;###autoload
4963 (defun orgtbl-to-texinfo (table params)
4964 "Convert the orgtbl-mode TABLE to Texinfo.
4966 TABLE is a list, each entry either the symbol `hline' for
4967 a horizontal separator line, or a list of fields for that line.
4968 PARAMS is a property list of parameters that can influence the
4969 conversion. All parameters from `orgtbl-to-generic' are
4970 supported. It is also possible to use the following one:
4972 :columns
4974 Column widths, as a string. When providing column fractions,
4976 (require 'ox-texinfo)
4977 (let ((output
4978 (orgtbl-to-generic
4979 table
4980 (org-combine-plists
4981 (list :backend 'texinfo
4982 :texinfo-tables-verbatim nil
4983 :texinfo-table-scientific-notation nil)
4984 params)))
4985 (columns (let ((w (plist-get params :columns)))
4986 (cond ((not w) nil)
4988 (t (concat "@columnfractions " w))))))
4989 (if (not columns) output
4990 (replace-regexp-in-string
4993 ;;;###autoload
4994 (defun orgtbl-to-orgtbl (table params)
4995 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
4997 TABLE is a list, each entry either the symbol `hline' for
4998 a horizontal separator line, or a list of fields for that line.
4999 PARAMS is a property list of parameters that can influence the
5000 conversion. All parameters from `orgtbl-to-generic' are
5001 supported.
5003 Useful when slicing one table into many. The :hline, :sep,
5004 :lstart, and :lend provide orgtbl framing. :tstart and :tend can
5005 be set to provide ORGTBL directives for the generated table."
5006 (require 'ox-org)
5007 (orgtbl-to-generic table (org-combine-plists (list :backend 'org))))
5009 (defun orgtbl-to-table.el (table params)
5010 "Convert the orgtbl-mode TABLE into a table.el table.
5011 TABLE is a list, each entry either the symbol `hline' for
5012 a horizontal separator line, or a list of fields for that line.
5013 PARAMS is a property list of parameters that can influence the
5014 conversion. All parameters from `orgtbl-to-generic' are
5015 supported."
5016 (with-temp-buffer
5017 (insert (orgtbl-to-orgtbl table params))
5018 (org-table-align)
5019 (replace-regexp-in-string
5020 "-|" "-+"
5021 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
5023 (defun orgtbl-to-unicode (table params)
5024 "Convert the orgtbl-mode TABLE into a table with unicode characters.
5026 TABLE is a list, each entry either the symbol `hline' for
5027 a horizontal separator line, or a list of fields for that line.
5028 PARAMS is a property list of parameters that can influence the
5029 conversion. All parameters from `orgtbl-to-generic' are
5030 supported. It is also possible to use the following ones:
5032 :ascii-art
5035 the table. You can download it here:
5036 http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el.
5038 :narrow
5040 When non-nil, narrow columns width than provided width cookie,
5042 (require 'ox-ascii)
5043 (orgtbl-to-generic
5044 table
5045 (org-combine-plists
5046 (list :backend 'ascii
5047 :ascii-charset 'utf-8
5048 :ascii-table-keep-all-vertical-lines (plist-get params :)
5049 :ascii-table-widen-columns (not (plist-get params :narrow))
5050 :ascii-table-use-ascii-art (plist-get params :ascii-art))
5051 params)))
5053 ;; Put the cursor in a column containing numerical values
5054 ;; of an Org-Mode table,
5055 ;; type C-c p
5056 ;; A new column is added with a bar plot.
5057 ;; When the table is refreshed (C-u C-c *),
5058 ;; the plot is updated to reflect the new values.
5060 (defun orgtbl-ascii-draw (value min max &optional width characters)
5061 "Draw an ascii bar in a table.
5062 VALUE is a the value to plot, the width of the bar to draw. A
5063 value equal to MIN will be displayed as empty (zero width bar).
5064 A value equal to MAX will draw a bar filling all the WIDTH.
5065 WIDTH is the expected width in characters of the column.
5066 CHARACTERS is a string that will compose the bar, with shades of
5067 grey from pure white to pure black. It defaults to a 10
5068 characters string of regular ascii characters."
5069 (let* ((characters (or characters " .:;c!lhVHW"))
5070 (width (or width 12))
5071 (value (if (numberp value) value (string-to-number value)))
5072 (value (* (/ (- (+ value 0.0) min) (- max min)) width)))
5073 (cond
5074 ((< value 0) "too small")
5075 ((> value width) "too large")
5076 (t
5077 (let ((len (1- (length characters))))
5078 (concat
5079 (make-string (floor value) (elt characters len))
5080 (string (elt characters
5081 (floor (* (- value (floor value)) len))))))))))
5083 ;;;###autoload
5084 (defun orgtbl-ascii-plot (&optional ask)
5085 "Draw an ascii bar plot in a column.
5086 With cursor in a column containing numerical values, this
5087 function will draw a plot in a new column.
5088 ASK, if given, is a numeric prefix to override the default 12
5089 characters width of the plot. ASK may also be the
5091 (interactive "P")
5092 (let ((col (org-table-current-column))
5093 (min 1e999) ; 1e999 will be converted to infinity
5094 (max -1e999) ; which is the desired result
5095 (table (org-table-to-lisp))
5096 (length
5097 (cond ((consp ask)
5098 (read-number "Length of column " 12))
5099 ((numberp ask) ask)
5100 (t 12))))
5101 ;; Skip any hline a the top of table.
5102 (while (eq (car table) 'hline) (setq table (cdr table)))
5103 ;; Skip table header if any.
5104 (dolist (x (or (cdr (memq 'hline table)) table))
5105 (when (consp x)
5106 (setq x (nth (1- col) x))
5107 (when (string-match
5109 x)
5110 (setq x (string-to-number x))
5111 (when (> min x) (setq min x))
5112 (when (< max x) (setq max x)))))
5113 (org-table-insert-column)
5114 (org-table-move-column-right)
5115 (org-table-store-formulas
5116 (cons
5117 (cons
5118 (number-to-string (1+ col))
5119 (format "'(%s $%s %s %s %s)"
5120 "orgtbl-ascii-draw" col min max length))
5121 (org-table-get-stored-formulas)))
5122 (org-table-recalculate t)))
5124 ;; Example of extension: unicode characters
5125 ;; Here are two examples of different styles.
5127 ;; Unicode block characters are used to give a smooth effect.
5128 ;; See http://en.wikipedia.org/wiki/Block_Elements
5129 ;; Use one of those drawing functions
5130 ;; - orgtbl-ascii-draw (the default ascii)
5131 ;; - orgtbl-uc-draw-grid (unicode with a grid effect)
5132 ;; - orgtbl-uc-draw-cont (smooth unicode)
5134 ;; This is best viewed with the "DejaVu Sans Mono" font
5135 ;; (use M-x set-default-font).
5137 (defun orgtbl-uc-draw-grid (value min max &optional width)
5138 "Draw a bar in a table using block unicode characters.
5139 It is a variant of orgtbl-ascii-draw with Unicode block
5140 characters, for a smooth display. Bars appear as grids (to the
5141 extent the font allows)."
5142 ;; http://en.wikipedia.org/wiki/Block_Elements
5143 ;; best viewed with the "DejaVu Sans Mono" font.
5144 (orgtbl-ascii-draw value min max width
5147 (defun orgtbl-uc-draw-cont (value min max &optional width)
5148 "Draw a bar in a table using block unicode characters.
5149 It is a variant of orgtbl-ascii-draw with Unicode block
5150 characters, for a smooth display. Bars are solid (to the extent
5151 the font allows)."
5152 (orgtbl-ascii-draw value min max width
5155 (defun org-table-get-remote-range (name-or-id form)
5156 "Get a field value or a list of values in a range from table at ID.
5158 NAME-OR-ID may be the name of a table in the current file as set
5160 will then be used. Alternatively, it may be an ID referring to
5161 any entry, also in a different file. In this case, the first
5162 table in that entry will be referenced.
5166 The return value is either a single string for a single field, or a
5167 list of the fields in the rectangle."
5168 (save-match-data
5169 (let ((case-fold-search t) (id-loc nil)
5170 ;; Protect a bunch of variables from being overwritten
5171 ;; by the context of the remote table
5172 org-table-column-names org-table-column-name-regexp
5173 org-table-local-parameters org-table-named-field-locations
5174 org-table-current-line-types org-table-current-begin-line
5175 org-table-current-begin-pos org-table-dlines
5176 org-table-current-ncol
5177 org-table-hlines org-table-last-alignment
5178 org-table-last-column-widths org-table-last-alignment
5179 org-table-last-column-widths tbeg
5180 buffer loc)
5181 (setq form (org-table-convert-refs-to-rc form))
5182 (save-excursion
5183 (save-restriction
5184 (widen)
5185 (save-excursion
5186 (goto-char (point-min))
5187 (if (re-search-forward
5190 nil t)
5191 (setq buffer (current-buffer) loc (match-beginning 0))
5192 (setq id-loc (org-id-find name-or-id 'marker))
5193 (unless (and id-loc (markerp id-loc))
5195 (setq buffer (marker-buffer id-loc)
5196 loc (marker-position id-loc))
5197 (move-marker id-loc nil)))
5198 (with-current-buffer buffer
5199 (save-excursion
5200 (save-restriction
5201 (widen)
5202 (goto-char loc)
5203 (forward-char 1)
5205 (not (match-beginning 1)))
5206 (user-error "Cannot find a table at NAME or ID %s" name-or-id))
5207 (setq tbeg (point-at-bol))
5208 (org-table-get-specials)
5209 (setq form (org-table-formula-substitute-names
5210 (org-table-formula-handle-first/last-rc form)))
5211 (if (and (string-match org-table-range-regexp form)
5212 (> (length (match-string 0 form)) 1))
5213 (save-match-data
5214 (org-table-get-range (match-string 0 form) tbeg 1))
5215 form)))))))))
5217 (defun org-table-remote-reference-indirection (form)
5218 "Return formula with table remote references substituted by indirection.
5220 This indirection works only with the format @ROW$COLUMN. The
5222 distinguished from a plain table name or ID."
5223 (let ((start 0))
5224 (while (string-match (concat
5225 ;; Same as in `org-table-eval-formula'.
5227 ;; Allow "$1", "@<", "$-1", "@<<$1" etc.
5229 ;; Same as in `org-table-eval-formula'.
5231 form
5232 start)
5233 ;; The position of the character as far as possible to the right
5234 ;; that will not be replaced and particularly not be shifted by
5235 ;; `replace-match'.
5236 (setq start (match-beginning 1))
5237 ;; Substitute the remote reference with the value found in the
5238 ;; field.
5239 (setq form
5240 (replace-match
5241 (save-match-data
5242 (org-table-get-range (org-table-formula-handle-first/last-rc
5243 (match-string 1 form))))
5244 t t form 1))))
5245 form)
5247 (defmacro org-define-lookup-function (mode)
5248 (let ((mode-str (symbol-name mode))
5249 (first-p (equal mode 'first))
5250 (all-p (equal mode 'all)))
5251 (let ((plural-str (if all-p "s" "")))
5252 `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
5253 ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
5254 If R-LIST is nil, return matching element%s of S-LIST.
5255 If PREDICATE is not nil, use it instead of `equal' to match VAL.
5256 Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
5257 This function is generated by a call to the macro `org-define-lookup-function'."
5258 mode-str plural-str plural-str plural-str)
5259 (let ,(let ((lvars '((p (or predicate 'equal))
5260 (sl s-list)
5261 (rl (or r-list s-list))
5262 (ret nil))))
5263 (if first-p (add-to-list 'lvars '(match-p nil)))
5264 lvars)
5265 (while ,(if first-p '(and (not match-p) sl) 'sl)
5266 (progn
5267 (if (funcall p val (car sl))
5268 (progn
5269 ,(if first-p '(setq match-p t))
5270 (let ((rval (car rl)))
5271 (setq ret ,(if all-p '(append ret (list rval)) 'rval)))))
5272 (setq sl (cdr sl) rl (cdr rl))))
5273 ret)))))
5275 (org-define-lookup-function first)
5276 (org-define-lookup-function last)
5277 (org-define-lookup-function all)
5279 (provide 'org-table)
5281 ;; Local variables:
5282 ;; generated-autoload-file: "org-loaddefs.el"
5283 ;; End:
5285 ;;; org-table.el ends here