| blob | 547f933bea28e98cd1b8640da8ce653c196608f9 |
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:
52 "Hook for functions attaching to `C-c C-c', if the table is sent.
53 This can be used to add additional functionality after the table is sent
54 to the receiver position, otherwise, if table is not sent, the functions
60 "Non-nil means use the optimized table editor version for `orgtbl-mode'.
61 In the optimized version, the table editor takes over all simple keys that
62 normally just insert a character. In tables, the characters are inserted
63 in a way to minimize disturbing the table structure (i.e. in overwrite mode
64 for empty fields). Outside tables, the correct binding of the keys is
65 restored.
67 The default for this option is t if the optimized version is also used in
68 Org-mode. See the variable `org-enable-table-editor' for details. Changing
69 this variable requires a restart of Emacs to become effective."
75 % END RECEIVE ORGTBL %n
77 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
78 | | |
81 @c END RECEIVE ORGTBL %n
82 @ignore
83 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
84 | | |
87 <!-- END RECEIVE ORGTBL %n -->
88 <!--
89 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
90 | | |
93 #+ END RECEIVE ORGTBL %n
95 #+ORGTBL: SEND %n orgtbl-to-orgtbl :splice nil :skip 0
96 | | |
98 "Templates for radio tables in different major modes.
99 Each template must define lines that will be treated as a comment and that
102 insertion of the template. The transformed table will later be inserted
103 between these lines.
105 The template should also contain a minimal table in a multiline comment.
106 If multiline comments are not possible in the buffer language,
107 you can pack it into a string that will not be used when the code
108 is compiled or executed. Above the table will you need a line with
110 convert the table into a data structure useful in the
111 language of the buffer. Check the manual for the section on
113 http://orgmode.org/manual/Tables-in-arbitrary-syntax.html#Tables-in-arbitrary-syntax
115 All occurrences of %n in a template will be replaced with the name of the
116 table, obtained by prompting the user."
123 "Settings for tables in Org-mode."
128 "The default size for newly created tables, Columns x Rows."
133 "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%:]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$"
134 "Regular expression for recognizing numbers in table columns.
135 If a table column contains mostly numbers, it will be aligned to the
136 right. If not, it will be aligned to the left.
138 The default value of this option is a regular expression which allows
139 anything which looks remotely like a number as used in scientific
140 context. For example, all of the following will be considered a
141 number:
142 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
144 Other options offered by the customize interface are more restrictive."
158 "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
159 (const :tag "Very General Number-Like, including hex and Calc radix, allows comma as decimal mark"
160 "^\\([<>]?[-+^.,0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
164 "Fraction of numbers in a column required to make the column align right.
165 In a column all non-white fields are considered. If at least
166 this fraction of fields is matched by `org-table-number-regexp',
167 alignment to the right border applies."
172 "Behavior of tables during editing in Org-mode."
177 "Non-nil means automatically re-align table when pressing TAB or RETURN.
179 removal/insertion."
184 "Non-nil means automatically blank table field when starting to type into it.
185 This only happens when typing immediately after a field motion
186 command (TAB, S-TAB or RET).
187 Only relevant when `org-enable-table-editor' is equal to `optimized'."
192 "Non-nil means automatically exit the follow mode.
193 When nil, the follow mode will stay on and be active in any table
194 the cursor enters. Since the table follow filed mode messes with the
195 window configuration, it is not recommended to set this variable to nil,
196 except maybe locally in a special file that has mostly tables with long
197 fields."
203 "Whether the user should confirm when Org fixes formulas."
211 'safe-local-variable
215 "Non-nil means tab in the last column of a table with jump over a hline.
216 If a horizontal separator line is following the current line,
217 `org-table-next-field' can either create a new row before that line, or jump
218 over the line. When this option is nil, a new line will be created before
219 this line."
224 "Options concerning tables in Org-mode."
229 "Should org-mode work with table references like B3 instead of @3$2?
230 Possible values are:
231 nil never use them
232 from accept as input, do not present for editing
233 t accept as input and present for editing"
253 calc-angle-mode deg
254 calc-prefer-frac nil
255 calc-symbolic-mode nil
257 calc-display-working-message t
258 )
259 "List with Calc mode settings for use in `calc-eval' for table formulas.
260 The list must contain alternating symbols (Calc modes variables and values).
261 Don't remove any of the default settings, just change the values. Org-mode
262 relies on the variables to be present in the list."
267 "Format for the output of calc computations like $1+$2;t.
268 The default value is 'hours, and will output the results as a
269 number of hours. Other allowed values are 'seconds, 'minutes and
270 'days, and the output will be a fraction of seconds, minutes or
271 days."
280 "Format for fields which contain the result of a formula.
282 characters. Beware that modifying the display can prevent the
283 field from being used in another formula."
289 "Non-nil means TAB and RET evaluate a formula in current table field.
290 If the current field starts with an equal sign, it is assumed to be a formula
291 which should be evaluated as described in the manual and in the documentation
292 string of the command `org-table-eval-formula'. This feature requires the
293 Emacs calc package.
294 When this variable is nil, formula calculation is only available through
300 "Non-nil means interpret constants in formulas in tables.
301 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
302 by the value given in `org-table-formula-constants', or by a value obtained
303 from the `constants.el' package."
308 "Alist with constant names and values, for use in table formulas.
309 The car of each element is a name of a constant, without the `$' before it.
310 The cdr is the value as a string. For example, if you'd like to use the
311 speed of light in a formula, you would configure
315 and then use it in an equation like `$1*$c'.
317 Constants can also be defined on a per-file basis using a line like
319 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
326 "Non-nil means lines marked with |#| or |*| will be recomputed automatically.
327 Automatically means when TAB or RET or C-c C-c are pressed in the line."
332 "OBSOLETE VARIABLE, please see `org-table-relative-ref-may-cross-hline'."
337 "Non-nil means relative formula references may cross hlines.
338 Here are the allowed values:
340 nil Relative references may not cross hlines. They will reference the
341 field next to the hline instead. Coming from below, the reference
342 will be to the field below the hline. Coming from above, it will be
343 to the field above.
344 t Relative references may cross hlines.
345 error An attempt to cross a hline will throw an error.
347 It is probably good to never set this variable to nil, for the sake of
348 portability of tables."
356 "Options concerning table import and export in Org-mode."
361 "Default export parameters for `org-table-export'.
362 These can be overridden for a specific table by setting the
363 TABLE_EXPORT_FORMAT property. See the manual section on orgtbl
364 radio tables for the different export transformations and
365 available parameters."
403 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
404 ;; 1 2 3 4 5
415 "Is this a table line colgroup information?"
419 line)
421 nil
428 "Is this a table line with only alignment/width cookies?"
441 s))))
447 "Check if the table has a marking column.
448 If yes remove the column and the special lines."
461 lines))))
470 nil)
474 ;; remove the first column
477 lines))))
483 ;;;###autoload
485 "Use the table.el package to insert a new table.
486 If there is already a table at point, convert between Org-mode tables
487 and table.el tables."
500 ;;;###autoload
502 "Convert region to table, or create an empty table.
503 If there is an active region, convert it to a table, using the function
504 `org-table-convert-region'. See the documentation of that function
505 to learn how the prefix argument is interpreted to determine the field
506 separator.
507 If there is no such region, create an empty table with `org-table-create'."
513 ;;;###autoload
515 "Query for a size and insert a table skeleton.
535 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
539 ;; Insert a hline after the first row.
546 ;;;###autoload
548 "Convert region to a table.
549 The region goes from BEG0 to END0, but these borders will be moved
550 slightly, to make sure a beginning of line in the first line is included.
552 SEPARATOR specifies the field separator in the lines. It can have the
553 following values:
555 '(4) Use the comma as a field separator
556 '(16) Use a TAB as field separator
557 '(64) Prompt for a regular expression as field separator
558 integer When a number, use that many spaces as field separator
559 regexp When a regular expression, use it to match the separator
560 nil When nil, the command tries to be smart and figure out the
561 separator in the following way:
562 - when each line contains a TAB, assume TAB-separated material
563 - when each line contains a comma, assume CSV material
564 - else, assume one or more SPACE characters as separator."
568 re)
577 ;; Get the right field separator
588 ;; parse the csv stuff
613 ;;;###autoload
615 "Import FILE as a table.
616 The file is assumed to be tab-separated. Such files can be produced by most
617 spreadsheet and database applications. If no tabs (at least one per line)
618 are found, lines will be split on whitespace into fields."
629 ;;;###autoload
631 "Export table to a file, with configurable format.
632 Such a file can be imported into usual spreadsheet programs.
634 FILE can be the output file name. If not given, it will be taken
635 from a TABLE_EXPORT_FILE property in the current entry or higher
636 up in the hierarchy, or the user will be prompted for a file
637 name. FORMAT can be an export format, of the same kind as it
638 used when `orgtbl-mode' sends a table in a different format.
640 The command suggests a format depending on TABLE_EXPORT_FORMAT,
641 whether it is set locally or up in the hierarchy, then on the
642 extension of the given file name, and finally on the variable
643 `org-table-export-default-format'."
657 buf deffmt-readable fileext)
673 org-table-export-default-format))
691 'hline
694 skipcols i0)))
695 lines))
699 skipcols i0))
702 skipcols i0)))
719 "Marker at the beginning of the table last aligned.
722 "Marker at the end of the table last aligned.
725 "List of flags for flushright alignment, from the last re-alignment.
728 "List of max width of fields in each column.
731 "Non-nil means debug table formulas.
743 ;;;###autoload
745 "Align the table at point by aligning all vertical bars."
748 ;; Limits of table
751 ;; Current cursor position
757 column
759 rfmt hfmt
767 emptystrings links dates emph raise narrow
768 falign falign1 fmax f1 f2 len c e space)
771 ;; Check if we have links or dates
783 ;; Make sure the link properties are right
785 ;; Make sure the date properties are right
790 ;; Check if we are narrowing any columns
793 org-format-transports-properties-p
798 ;; Get the rows
801 ;; Store the indentation of the first line
804 ;; Mark the hlines by setting the corresponding element to nil
805 ;; At the same time, we remove trailing space.
808 nil
811 l)))
812 lines))
813 ;; Get the data fields by splitting the lines.
818 ;; How many fields in the longest line?
825 ;; A list of empty strings to fill any short rows on output
827 ;; Check for special formatting.
831 ;; Check if there is an explicit width specified
841 ;; Find fields that are wider than fmax, and shorten them
847 'help-echo
856 f2)
860 f1)
866 xx)))))
867 ;; Get the maximum width for each column
869 lengths)
870 ;; Get the fraction of numbers, to decide about alignment of the column
876 nil
883 ;; Store the alignment of this table, for later editing of single fields
885 org-table-last-column-widths lengths)
887 ;; With invisible characters, `format' does not get the field width right
888 ;; So we need to make these fields wide by hand.
906 ;; Compute the formats needed for output of the table
919 hfmt))
923 ;; Replace the old one
930 ;; Try to move to the old location
939 ))
941 ;;;###autoload
943 "Find the beginning of the table and return its position.
944 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
948 org-table-border-regexp)
949 nil t))
955 ;;;###autoload
957 "Find the end of the table and return its position.
958 With argument TABLE-TYPE, go to the end of a table.el-type table."
962 org-table-border-regexp)
963 nil t))
968 ;;;###autoload
970 "Justify the current field, text to left, number to right.
971 Optional argument NEW may specify text to replace the current field content."
980 ;; This is not the same table, force a full re-align
986 l f n o e)
1012 ;;;###autoload
1014 "Go to the next field in the current table, creating new lines as needed.
1015 Before doing so, re-align the table if necessary."
1020 org-table-may-need-update)
1031 org-table-tab-jumps-over-hlines
1042 ;;;###autoload
1044 "Go to the previous field in the table.
1045 Before doing so, re-align the table if necessary."
1050 org-table-may-need-update)
1065 "Move to the end of the current table field.
1066 If already at or after the end, move to the end of the next table field.
1067 With numeric argument N, move N-1 fields forward first."
1080 "Move to the beginning of the current table field.
1081 If already at or before the beginning, move to the beginning of the
1082 previous field.
1083 With numeric argument N, move N-1 fields backward first."
1096 ;;;###autoload
1098 "Go to the next row (same column) in the current table.
1099 Before doing so, re-align the table if necessary."
1107 org-table-may-need-update)
1120 ;;;###autoload
1122 "Copy the value of the current field one row below.
1124 If the field at the cursor is empty, copy the content of the
1125 nearest non-empty field above. With argument N, use the Nth
1126 non-empty field.
1128 If the current field is not empty, it is copied down to the next
1129 row, and the cursor is moved with it. Therefore, repeating this
1130 command causes the column to be filled row-by-row.
1132 If the variable `org-table-copy-increment' is non-nil and the
1133 field is an integer or a timestamp, it will be incremented while
1134 copying. By default, increment by the difference between the
1135 value in the current field and the one in the field above. To
1136 increment using a fixed integer, set `org-table-copy-increment'
1137 to a number. In the case of a timestamp, increment by days."
1149 txt txt-up inc)
1157 beg t))
1167 beg t))
1174 ;; Above field was not empty, go down to the next row
1207 "Is point inside a table data field?
1208 I.e. not on a hline or before the first or after the last column?
1209 This actually throws an error, so it aborts the current command."
1215 nil
1217 t))
1223 "Get the field in table line LINE, column COLUMN.
1224 If LINE is larger than the number of data lines in the table, the function
1225 returns nil. However, if COLUMN is too large, we will simply return an
1226 empty string.
1227 If LINE is nil, use the current line.
1228 If column is nil, use the current column."
1235 "Put VALUE into line LINE, column COLUMN.
1236 When ALIGN is set, also realign the table."
1245 "Return the index of the current data line."
1252 cnt))
1255 "Go to the Nth data line in the current table.
1256 Return t when the line exists, nil if it does not exist."
1263 ;;;###autoload
1265 "Blank the current table field or active region."
1282 "Return the value of the field in column N of current row.
1283 N defaults to current field.
1284 If REPLACE is a string, replace field with this value. The return value
1285 is always the old value."
1294 t t))
1296 val)
1299 ;;;###autoload
1301 "Show info about the current field, and highlight any reference at point."
1310 org-table-named-field-locations)))
1330 dline col
1332 dline col ref1
1334 ;; FIXME: formula info not correct if special table line
1344 "Find out which column we are in."
1354 cnt)))
1356 ;;;###autoload
1358 "Find out what table data line we are in.
1359 Only data lines count for this."
1371 cnt)))
1373 ;;;###autoload
1375 "Move the cursor to the Nth column in the current table line.
1376 With optional argument ON-DELIM, stop with point before the left delimiter
1377 of the field.
1378 If there are less than N fields, just go to after the last delimiter.
1379 However, when FORCE is non-nil, create new columns if necessary."
1389 t)))))
1396 ;;;###autoload
1398 "Insert a new column into the table."
1406 ;; Current cursor position
1412 nil
1426 "Find a data line in the current table, which is needed for column commands."
1429 t
1440 t
1445 "Turn a buffer line number into a data line number.
1446 If there is no data line in this line, return nil.
1447 If there is no matching dline (most likely te reference was a hline), the
1448 first dline below it is used. When ABOVE is non-nil, the one above is used."
1451 i)
1464 nil))
1466 ;;;###autoload
1468 "Delete a column from the table."
1477 ;; Current cursor position
1483 nil
1499 ;;;###autoload
1501 "Move column to the right."
1504 ;;;###autoload
1506 "Move column to the left."
1510 ;;;###autoload
1512 "Move the current column to the right. With arg LEFT, move to the left."
1522 ;; Current cursor position
1532 nil
1550 ;;;###autoload
1552 "Move table row down."
1555 ;;;###autoload
1557 "Move table row up."
1561 ;;;###autoload
1563 "Move the current table line down. With arg UP, move it up."
1572 txt hline2p)
1595 ;;;###autoload
1597 "Insert a new row above the current line into the table.
1598 With prefix ARG, insert below the current line."
1604 ;; Fix the first field if necessary
1617 ;;;###autoload
1619 "Insert a horizontal-line below the current line into the table.
1620 With prefix ABOVE, insert above the current line."
1641 ;;;###autoload
1643 "Insert a hline and move to the row below that line."
1657 In particular, this does handle wide and invisible characters."
1659 ;; It's a hline, just map the characters
1665 t t s)))
1666 s))
1668 ;;;###autoload
1670 "Delete the current row or horizontal line from the table."
1684 ;;;###autoload
1686 "Sort table lines according to the column at point.
1688 The position of point indicates the column to be used for
1689 sorting, and the range of lines is the range between the nearest
1690 horizontal separator lines, or the entire table of no such lines
1691 exist. If point is before the first column, you will be prompted
1692 for the sorting column. If there is an active region, the mark
1693 specifies the first line and the sorting column, while point
1694 should be in the last line to be included into the sorting.
1696 The command then prompts for the sorting type which can be
1697 alphabetically, numerically, or by time (as given in a time stamp
1698 in the field, or as a HH:MM value). Sorting in reverse order is
1699 also possible.
1701 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1703 If SORTING-TYPE is specified when this function is called from a Lisp
1704 program, no prompting will take place. SORTING-TYPE must be a character,
1705 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
1706 should be done in reverse order."
1711 beg end bcol ecol tend tbeg column lns pos)
1756 x))
1770 ;;;###autoload
1772 "Copy region in table to the clipboard and blank all relevant fields.
1773 If there is no active region, use just the field at point."
1779 ;;;###autoload
1781 "Copy rectangular region in table to clipboard.
1782 A special clipboard is used which can only be accessed
1783 with `org-table-paste-rectangle'."
1787 current-prefix-arg))
1789 region cols
1815 org-table-clip))
1817 ;;;###autoload
1819 "Paste a rectangular region into a table.
1820 The upper right corner ends up in the current field. All involved fields
1821 will be overwritten. If the rectangle does not fit into the present table,
1822 the table is enlarged as needed. The process ignores horizontal separator
1823 lines."
1833 c cols field)
1848 ;;;###autoload
1850 "Convert from `org-mode' table to table.el and back.
1851 Obviously, this only works within limits. When an Org-mode table is
1852 converted to table.el, all horizontal separator lines get lost, because
1853 table.el uses these as cell boundaries and has no notion of horizontal lines.
1854 A table.el table can be converted to an Org-mode table only if it does not
1855 do row or column spanning. Multiline cells will become multiple cells.
1856 Beware, Org-mode does not test if the table can be successfully converted - it
1857 blindly applies a recipe that works for simple tables."
1861 ;; convert to Org-mode table
1870 ;; convert to table.el table
1873 ;; first, get rid of all horizontal lines
1877 ;; insert a hline before first
1881 ;; insert a hline after each line
1886 ;; replace "+" at beginning and ending of hlines
1895 "Transpose Org table at point and eliminate hlines.
1896 So a table like
1898 | 1 | 2 | 4 | 5 |
1899 |---+---+---+---|
1900 | a | b | c | d |
1901 | e | f | g | h |
1903 will be transposed as
1905 | 1 | a | e |
1906 | 2 | b | f |
1907 | 4 | c | g |
1908 | 5 | d | h |
1910 Note that horizontal lines disappear."
1922 table)))
1936 ;;;###autoload
1938 "Wrap several fields in a column like a paragraph.
1939 This is useful if you'd like to spread the contents of a field over several
1940 lines, in order to keep the table compact.
1942 If there is an active region, and both point and mark are in the same column,
1943 the text in the column is wrapped to minimum width for the given number of
1944 lines. Generally, this makes the table more compact. A prefix ARG may be
1946 formats the selected text to two lines. If the region was longer than two
1947 lines, the remaining lines remain empty. A negative prefix argument reduces
1948 the current number of lines by that amount. The wrapped text is pasted back
1949 into the table. If you formatted it to more lines than it was before, fields
1950 further down in the table get overwritten - so you might need to make space in
1951 the table first.
1953 If there is no region, the current field is split at the cursor position and
1954 the text fragment to the right of the cursor is prepended to the field one
1955 line down.
1957 If there is no region, but you specify a prefix ARG, the current field gets
1958 blank, and the content is appended to the field above."
1962 ;; There is a region: fill as a paragraph
1966 nlines)
1973 arg)
1977 nil nlines)))
1981 ;; No region, split the current field at point
1985 ;; combine with field above
1995 ;; split field
2007 ;;;###autoload
2009 "Edit table field in a different window.
2010 This is mainly useful for fields that contain hidden parts.
2012 it can be edited in place."
2021 display t intangible t))
2034 p)
2050 intangible t))
2058 "Finish editing a table data field.
2059 Remove all newline characters, insert the result into the table, realign
2060 the table and kill the editing buffer."
2064 text)
2081 "Minor mode to make the table field editor window follow the cursor.
2082 When this mode is active, the field editor window will always show the
2083 current field. The mode exits automatically when the cursor leaves the
2084 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
2085 nil " TblFollow" nil
2101 ;; We have left the table, exit the follow mode
2111 ;;;###autoload
2113 "Sum numbers in region of current table column.
2114 The result will be displayed in the echo area, and will be available
2117 If there is an active region, it is interpreted as a rectangle and all
2118 numbers in that rectangle will be summed. If there is no active
2119 region and point is located in a table column, sum all numbers in that
2120 column.
2122 If at least one number looks like a time HH:MM or HH:MM:SS, all other
2123 numbers are assumed to be times as well (in decimal hours) and the
2124 numbers are added as such.
2126 If NLAST is a number, only the NLAST fields will actually be summed."
2153 items1)))
2160 s diff)
2168 sres))))
2191 "Return the formula active for the current field.
2192 Assumes that specials are in place.
2193 If KEY is given, return the key to this formula.
2197 org-table-named-field-locations)))
2211 "Read a formula from the minibuffer, offer stored formula as default.
2212 When NAMED is non-nil, look for a named equation."
2216 org-table-named-field-locations)))
2223 name
2224 ref)
2234 stored)
2236 equation)
2243 scol))
2245 'org-table-formula-history
2246 )))))
2247 mustsave)
2249 ;; remove formula
2256 ;; We set the column equation, delete the named one.
2258 mustsave t))
2264 eq))
2267 "Store the list of formulas below the current table."
2274 ;; don't overwrite TBLFM, we might use text properties to store stuff
2290 ;; Fake a high number to make sure this is sorted at the end.
2297 a)
2307 "Compare two formulas for sorting."
2312 ;;;###autoload
2314 "Return an alist with the stored formulas directly after current table."
2323 (when (string-match "\\`\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*[^ \t]\\)" string)
2342 "Modify the equations after the table structure has been edited.
2344 For all numbers larger than LIMIT, shift them by DELTA."
2356 s n a)
2362 "Change makes TBLFM term %s invalid, use undo to recover"
2378 "Get the column names and local parameters for this table."
2381 names name fields fields1 field cnt
2382 c v l line col types dlines hlines last-dline)
2384 org-table-local-parameters nil
2385 org-table-named-field-locations nil
2386 org-table-current-begin-line nil
2387 org-table-current-begin-pos nil
2388 org-table-current-line-types nil
2407 org-table-local-parameters))))
2423 ;; Analyse the line types
2427 l org-table-current-begin-line)
2444 al al2)
2454 ;;;###autoload
2457 If yes, store the formula and apply it."
2458 ;; We already know we are in a table. Get field will only return a formula
2459 ;; when appropriate. It might return a separator line, but no problem.
2462 named eq)
2473 "List of commands triggering the recalculation of a line.
2485 ;;;###autoload
2487 "Rotate the recalculation mark in the first column.
2488 If in any row, the first field is not consistent with a mark,
2489 insert a new column for the markers.
2490 When there is an active region, change all the lines in the region,
2491 after prompting for the marking character.
2492 After each change, a message will be displayed indicating the meaning
2493 of the new mark."
2508 epos new)
2515 newchar))
2547 ;;;###autoload
2549 "Recompute the current line if marked for it, and if we haven't just done it."
2569 org-tbl-calc-modes)
2571 ;;;###autoload
2573 suppress-align suppress-const
2574 suppress-store suppress-analysis)
2575 "Replace the table field value at the cursor by the result of a calculation.
2577 This function makes use of Dave Gillespie's Calc package, in my view the
2578 most exciting program ever written for GNU Emacs. So you need to have Calc
2579 installed in order to use this function.
2581 In a table, this command replaces the value in the current field with the
2583 formula, by storing it in a special line below the table. When called
2584 with a `C-u' prefix, the current field must be a named field, and the
2585 formula is installed as valid in only this specific field.
2587 When called with two `C-u' prefixes, insert the active equation
2588 for the field back into the current field, so that it can be
2590 to check the referenced fields.
2592 When called, the command first prompts for a formula, which is read in
2593 the minibuffer. Previously entered formulas are available through the
2594 history list, and the last used formula is offered as a default.
2595 These stored formulas are adapted correctly when moving, inserting, or
2596 deleting columns with the corresponding commands.
2598 The formula can be any algebraic expression understood by the Calc package.
2599 For details, see the Org-mode manual.
2601 This function can also be called from Lisp programs and offers
2602 additional arguments: EQUATION can be the formula to apply. If this
2603 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2604 used to speed-up recursive calls by by-passing unnecessary aligns.
2605 SUPPRESS-CONST suppresses the interpretation of constants in the
2606 formula, assuming that this has been done already outside the function.
2607 SUPPRESS-STORE means the formula should not be stored, either because
2608 it is already stored, or because it is a modified equation that should
2609 not overwrite the stored one."
2625 equation
2631 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2632 duration duration-output-format)
2633 ;; Parse the format string. Since we have a lot of modes, this is
2634 ;; a lot of work. However, I think calc still uses most of the time.
2647 'calc-float-format
2650 n))))
2654 duration-output-format nil
2658 duration-output-format org-table-duration-custom-format
2659 numbers t
2682 ;; replace fields with duration values if relevant
2686 fields)))
2692 x))
2693 fields)))
2699 ;; Insert row and column number of formula result field
2710 t t form)))
2712 ;; Check for old vertical references
2714 ;; Insert remote references
2727 rmtrng))
2728 keep-empty numbers lispp))
2729 t t form)))
2730 ;; Insert complex ranges
2738 ;; possibly handle durations
2743 formrg)
2744 keep-empty numbers lispp)))
2749 ;; Insert simple ranges
2758 keep-empty numbers lispp))
2759 t t form)))
2761 ;; Insert the references to fields in same row
2768 x keep-empty numbers lispp)))
2786 ;; Use <...> time-stamps so that Calc can handle them
2789 ;; I18n-ize local time-stamps by setting (system-time-locale "C")
2800 form
2807 duration-output-format)
2808 ev)))
2813 Orig: %s
2814 $xyz-> %s
2815 @r$c-> %s
2847 prop value)))
2850 "Get a calc vector from a column, according to descriptor DESC.
2851 Optional arguments TBEG and COL can give the beginning of the table and
2852 the current column, to avoid unnecessary parsing.
2854 HIGHLIGHT means just highlight the range.
2856 When CORNERS-ONLY is set, only return the corners of the range as
2857 a list (line1 column1 line2 column2) where line1 and line2 are line numbers
2858 in the buffer and column1 and column2 are table column numbers."
2865 beg end c1 c2 r1 r2 rangep tmp)
2882 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2889 ;; just one field
2896 ;; A range, return a vector
2897 ;; First sort the numbers to get a regular rectangle
2901 ;; Only return the corners of the range
2903 ;; Copy the range values into a list
2917 ;; return string representation of calc vector
2922 "Analyze descriptor DESC and retrieve the corresponding line number.
2923 The cursor is currently in line CLINE, the table begins in line BLINE,
2924 and TABLE is a vector with line types."
2932 ;; 1 2 3 4 5 6
2952 nil hn cline desc)))
2955 rel on cline desc)))
2959 "FIXME: Needs more documentation."
2972 nil))
2973 t)))
2977 desc cline)
2978 i)))
2983 s))
2986 "Convert list ELEMENTS to something appropriate to insert into formula.
2987 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2988 NUMBERS indicates that everything should be converted to numbers.
2989 LISPP non-nil means to return something appropriate for a Lisp
2990 list, 'literal is for the format specifier L."
2991 ;; Calc nan (not a number) is used for the conversion of the empty
2992 ;; field to a reference for several reasons: (i) It is accepted in a
2993 ;; Calc formula (e. g. "" or "()" would result in a Calc error).
2994 ;; (ii) In a single field (not in range) it can be distinguished
2995 ;; from "(nan)" which is the reference made from a single field
2996 ;; containing "nan".
2998 ;; field reference
3001 elements
3003 ""
3012 ;; range reference
3017 elements))))
3023 x
3031 x)
3033 elements
3036 ;;;###autoload
3038 "Set `org-table-formula-constants-local' in the current buffer."
3054 ;;;###autoload
3056 "Recalculate the current table line by applying all stored formulas.
3057 With prefix arg ALL, do this for all lines in the table.
3058 With the prefix argument ALL is `(16)' \
3060 it is the symbol `iterate', recompute the table until it no longer changes.
3061 If NOALIGN is not nil, do not re-align the table after the computations
3062 are done. This is typically used internally to save time, if it is
3063 known that the table will be realigned a little later anyway."
3078 seen-fields lhs1
3080 ;; Insert constants in all formulas
3098 eqlist))
3099 ;; Split the equation list
3105 ;; Expand ranges in lhs of formulas
3108 ;; Get the correct line range to process
3114 ;; This is a table with marked lines, compute selected lines
3116 ;; Move forward to the first non-header line
3127 ;; First find the named fields, and mark them untouchable.
3128 ;; Also check if several field/range formulas try to set the same field.
3147 name)))
3157 ;; Now evaluate the column formulas, but skip fields covered by
3158 ;; field formulas
3162 ;; Unprotected line, recalculate
3174 ;; Now evaluate the field formulas
3188 ;; back to initial position
3195 ;;;###autoload
3197 "Recalculate the table until it does not change anymore.
3198 The maximum number of iterations is 10, but you can choose a different value
3199 with the prefix ARG."
3204 thistbl)
3218 ;;;###autoload
3220 "Recalculate all tables in the current buffer."
3227 ;;;###autoload
3229 "Iterate all tables in the buffer, to converge inter-table dependencies."
3234 c1)
3250 "Apply the #+TBLFM in the line at point to the table."
3256 s e)
3258 ;; Insert a temporary formula at right after the table
3263 ;; Recalculate the table
3269 ;; delete the formula inserted temporarily
3273 "Find the beginning of the TBLFM lines and return its position.
3274 Return nil when the beginning of TBLFM line was not found."
3278 org-table-TBLFM-begin-regexp
3279 nil t))
3283 "Expand list of formulas.
3284 If some of the RHS in the formulas are ranges or a row reference, expand
3285 them to individual field equations for each field."
3291 ;; This just refers to one fixed field
3294 ;; This just refers to one fixed named field
3316 "Replace @<, @>, $<, $> with first/last row/column of the table.
3317 So @< and $< will always be replaced with @1 and $1, respectively.
3318 The advantage of these special markers are that structure editing of
3319 the table will not change them, while @1 and $1 will be modified
3320 when a line/row is swapped out of that privileged position. So for
3321 formulas that use a range of rows or columns, it may often be better
3323 borders of the table using the @< @> $< $> makers."
3326 s start)
3331 org-table-current-ncol)
3335 len
3342 s)
3345 "Replace $const with values in string F."
3347 ;; First, check for column names
3352 ;; Parameters and constants
3354 (while (setq start (string-match "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)" f start))
3364 f))
3367 "Find the value for a parameter or constant in a formula.
3368 Parameters get priority."
3399 map))
3406 "--"
3409 "--"
3410 "Shift Reference at Point"
3415 "-"
3416 "Change Test Row for Column Formulas"
3419 "--"
3424 org-table-overlay-coordinates)]
3425 "--"
3431 ;;;###autoload
3433 "Edit the formulas of the current table in a separate buffer."
3435 (when (save-excursion (beginning-of-line 1) (let ((case-fold-search t)) (looking-at "[ \t]*#\\+TBLFM")))
3449 entry s type title)
3452 ;; Keep global-font-lock-mode from turning on font-lock-mode
3493 "Convert a formula from internal to user representation."
3496 s))
3499 "Convert a formula from user to internal representation."
3502 s))
3505 "Convert spreadsheet references from A7 to @7$28.
3506 Works for single references, but also for entire formulas and even the
3507 full TBLFM line."
3509 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3512 ;; format match, just advance
3517 ;; 3.e5 or something like this.
3520 ;; (member (match-string 1 s)
3521 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3522 )
3523 ;; function name, just advance
3533 t t s)))))
3534 s))
3537 "Convert spreadsheet references from to @7$28 to AB7.
3538 Works for single references, but also for entire formulas and even the
3539 full TBLFM line."
3546 t t s)))
3551 t nil s)))
3552 s)
3555 "Convert a base 26 number represented by letters into an integer.
3556 For example: AB -> 28."
3562 n))
3565 "Convert an integer into a base 26 number represented by letters.
3566 For example: 28 -> AB."
3571 s))
3574 "Convert a time string into numerical duration in seconds.
3575 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3576 If S is a string representing a number, keep this number."
3578 s
3601 "Convert a number of seconds to a time string.
3602 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3603 minutes or seconds."
3618 "Convert all references in this buffer, using FUNCTION."
3628 "Convert all references in the buffer from B3 to @3$2 and back."
3638 "Shift the reference at point one row/hline up."
3642 "Shift the reference at point one row/hline down."
3646 "Shift the reference at point one field to the left."
3650 "Shift the reference at point one field to the right."
3661 ;; A B3-like reference
3667 ;; An internal reference
3673 "Re-match the group N, and replace it with the shifted reference."
3678 t t)))
3681 "Shift a reference part REF.
3682 If DECR is set, decrease the references row/column, else increase.
3683 If HLINE is set, this may be a hline reference, it certainly is not
3684 a translation reference."
3713 "Toggle the display of coordinates in the referenced table."
3722 "Parse the buffer for formula definitions and install them.
3723 With prefix ARG, apply the new formulas to the table."
3733 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3734 nil t)
3758 "Abort editing formulas, without installing the changes."
3769 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3810 "Show the location/value of the $ expression at point."
3819 var name e what match dest)
3824 "$1.."
3907 ;; column number
3935 org-table-fedit-scroll-down))))
3947 "Make sure the cursor is in a dataline in a table."
3956 p1 p2)))
3961 "Move cursor one line up in the window showing the table."
3966 "Move cursor one line down in the window showing the table."
3971 "Move the cursor in the window showing the table.
3972 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
3997 "Add a new overlay."
4003 "Highlight rectangular region in a table."
4007 l1 c1 l2 c2 tmp)
4031 "Remove the rectangle overlays."
4042 "Add overlays to the table at point, to show row/column coordinates."
4070 ;;;###autoload
4072 "Toggle the display of Row/Column numbers in tables."
4083 ;;;###autoload
4085 "Toggle the formula debugger in tables."
4091 ;;; The orgtbl minor mode
4093 ;; Define a minor mode which can be used in other modes in order to
4094 ;; integrate the org-mode table editor.
4096 ;; This is really a hack, because the org-mode table editor uses several
4097 ;; keys which normally belong to the major mode, for example the TAB and
4098 ;; RET keys. Here is how it works: The minor mode defines all the keys
4099 ;; necessary to operate the table editor, but wraps the commands into a
4100 ;; function which tests if the cursor is currently inside a table. If that
4101 ;; is the case, the table editor command is executed. However, when any of
4102 ;; those keys is used outside a table, the function uses `key-binding' to
4103 ;; look up if the key has an associated command in another currently active
4104 ;; keymap (minor modes, major mode, global), and executes that command.
4105 ;; There might be problems if any of the keys used by the table editor is
4106 ;; otherwise used as a prefix key.
4108 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
4109 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
4110 ;; addresses this by checking explicitly for both bindings.
4112 ;; The optimized version (see variable `orgtbl-optimized') takes over
4113 ;; all keys which are bound to `self-insert-command' in the *global map*.
4114 ;; Some modes bind other commands to simple characters, for example
4115 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
4116 ;; active, this binding is ignored inside tables and replaced with a
4117 ;; modified self-insert.
4135 ;; Install it as a minor mode.
4139 ;;;###autoload
4141 "The `org-mode' table editor as a minor mode for use in other modes."
4146 ;; Exit without error, in case some hook functions calls this
4147 ;; by accident in org-mode.
4151 ;; Make sure we are first in minor-mode-map-alist
4153 ;; FIXME: maybe it should use emulation-mode-map-alists?
4160 auto-fill-inhibit-regexp)
4164 auto-fill-inhibit-regexp)
4165 orgtbl-line-start-regexp))
4183 "Remove all properties related to narrow-column invisibility."
4196 "Create a function for binding in the table minor mode.
4197 FUN is the command to call inside a table. N is used to create a unique
4198 command name. KEYS are keys that should be checked in for a command
4199 to execute outside of tables."
4205 "Outside of tables, run the binding of `"
4217 keys)
4221 "Error when there is no default binding for a table key."
4226 "Setup orgtbl keymaps."
4257 elt key fun cmd)
4265 ;; Special treatment needed for TAB and RET
4285 [(tab)] "\C-i")))
4287 (org-defkey orgtbl-mode-map [backtab]
4289 [backtab] [S-iso-lefttab] [(shift tab)]
4290 [(tab)] "\C-i"))
4292 (org-defkey orgtbl-mode-map "\M-\C-m"
4293 (orgtbl-make-binding 'org-table-wrap-region 105
4294 "\M-\C-m" [(meta return)]))
4295 (org-defkey orgtbl-mode-map [(meta return)]
4296 (orgtbl-make-binding 'org-table-wrap-region 106
4297 [(meta return)] "\M-\C-m"))
4299 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4300 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4302 (when orgtbl-optimized
4303 ;; If the user wants maximum table support, we need to hijack
4304 ;; some standard editing functions
4305 (org-remap orgtbl-mode-map
4306 'self-insert-command 'orgtbl-self-insert-command
4307 'delete-char 'org-delete-char
4308 'delete-backward-char 'org-delete-backward-char)
4309 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4310 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4311 '("OrgTbl"
4312 ["Create or convert" org-table-create-or-convert-from-region
4313 :active (not (org-at-table-p)) :keys "C-c |" ]
4314 "--"
4315 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4316 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4317 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4318 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4319 "--"
4320 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4321 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4322 ["Copy Field from Above"
4323 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4324 "--"
4325 ("Column"
4326 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4327 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4328 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4329 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"]
4330 ["Ascii plot" orgtbl-ascii-plot :active (org-at-table-p) :keys "C-c p"])
4331 ("Row"
4332 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4333 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4334 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4335 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4336 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4337 "--"
4338 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4339 ("Rectangle"
4340 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4341 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4342 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4343 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4344 "--"
4345 ("Radio tables"
4346 ["Insert table template" orgtbl-insert-radio-table
4347 (assq major-mode orgtbl-radio-table-templates)]
4348 ["Comment/uncomment table" orgtbl-toggle-comment t])
4349 "--"
4350 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4351 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4352 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4353 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4354 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4355 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4356 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4357 ["Sum Column/Rectangle" org-table-sum
4358 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4359 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4360 ["Debug Formulas"
4361 org-table-toggle-formula-debugger :active (org-at-table-p)
4362 :keys "C-c {"
4363 :style toggle :selected org-table-formula-debug]
4364 ["Show Col/Row Numbers"
4365 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4366 :keys "C-c }"
4367 :style toggle :selected org-table-overlay-coordinates]
4368 ))
4369 t))
4371 (defun orgtbl-ctrl-c-ctrl-c (arg)
4372 "If the cursor is inside a table, realign the table.
4373 If it is a table to be sent away to a receiver, do it.
4374 With prefix arg, also recompute table."
4375 (interactive "P")
4376 (let ((case-fold-search t) (pos (point)) action)
4377 (save-excursion
4378 (beginning-of-line 1)
4379 (setq action (cond
4383 (cond
4384 ((integerp action)
4385 (goto-char action)
4386 (org-table-maybe-eval-formula)
4387 (if arg
4388 (call-interactively 'org-table-recalculate)
4389 (org-table-maybe-recalculate-line))
4390 (call-interactively 'org-table-align)
4391 (when (orgtbl-send-table 'maybe)
4392 (run-hooks 'orgtbl-after-send-table-hook)))
4393 ((eq action 'recalc)
4394 (org-table-set-constants)
4395 (save-excursion
4396 (beginning-of-line 1)
4398 (if (org-at-table-p)
4399 (org-call-with-arg 'org-table-recalculate t))))
4400 (t (let (orgtbl-mode)
4401 (call-interactively (key-binding "\C-c\C-c")))))))
4403 (defun orgtbl-create-or-convert-from-region (arg)
4404 "Create table or convert region to table, if no conflicting binding.
4405 This installs the table binding `C-c |', but only if there is no
4406 conflicting binding to this key outside orgtbl-mode."
4407 (interactive "P")
4408 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4409 (if cmd
4410 (call-interactively cmd)
4411 (call-interactively 'org-table-create-or-convert-from-region))))
4413 (defun orgtbl-tab (arg)
4414 "Justification and field motion for `orgtbl-mode'."
4415 (interactive "P")
4416 (if arg (org-table-edit-field t)
4417 (org-table-justify-field-maybe)
4418 (org-table-next-field)))
4420 (defun orgtbl-ret ()
4421 "Justification and field motion for `orgtbl-mode'."
4422 (interactive)
4423 (if (bobp)
4424 (newline)
4425 (org-table-justify-field-maybe)
4426 (org-table-next-row)))
4428 (defun orgtbl-self-insert-command (N)
4429 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4430 If the cursor is in a table looking at whitespace, the whitespace is
4431 overwritten, and the table is not marked as requiring realignment."
4432 (interactive "p")
4433 (if (and (org-at-table-p)
4434 (or
4435 (and org-table-auto-blank-field
4436 (member last-command
4437 '(orgtbl-hijacker-command-100
4438 orgtbl-hijacker-command-101
4439 orgtbl-hijacker-command-102
4440 orgtbl-hijacker-command-103
4441 orgtbl-hijacker-command-104
4442 orgtbl-hijacker-command-105
4443 yas/expand))
4444 (org-table-blank-field))
4445 t)
4446 (eq N 1)
4448 (let (org-table-may-need-update)
4449 (goto-char (1- (match-end 0)))
4450 (org-delete-backward-char 1)
4451 (goto-char (match-beginning 0))
4452 (self-insert-command N))
4453 (setq org-table-may-need-update t)
4454 (let* (orgtbl-mode
4455 a
4456 (cmd (or (key-binding
4457 (or (and (listp function-key-map)
4458 (setq a (assoc last-input-event function-key-map))
4459 (cdr a))
4460 (vector last-input-event)))
4461 'self-insert-command)))
4462 (call-interactively cmd)
4463 (if (and org-self-insert-cluster-for-undo
4464 (eq cmd 'self-insert-command))
4465 (if (not (eq last-command 'orgtbl-self-insert-command))
4466 (setq org-self-insert-command-undo-counter 1)
4467 (if (>= org-self-insert-command-undo-counter 20)
4468 (setq org-self-insert-command-undo-counter 1)
4469 (and (> org-self-insert-command-undo-counter 0)
4470 buffer-undo-list
4471 (not (cadr buffer-undo-list)) ; remove nil entry
4472 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4473 (setq org-self-insert-command-undo-counter
4474 (1+ org-self-insert-command-undo-counter))))))))
4477 "Regular expression matching exponentials as produced by calc.")
4479 (defun orgtbl-gather-send-defs ()
4480 "Gather a plist of :name, :transform, :params for each destination before
4481 a radio table."
4482 (save-excursion
4483 (goto-char (org-table-begin))
4484 (let (rtn)
4485 (beginning-of-line 0)
4486 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4487 (let ((name (org-no-properties (match-string 1)))
4488 (transform (intern (match-string 2)))
4489 (params (if (match-end 3)
4490 (read (concat "(" (match-string 3) ")")))))
4491 (push (list :name name :transform transform :params params)
4492 rtn)
4493 (beginning-of-line 0)))
4494 rtn)))
4496 (defun orgtbl-send-replace-tbl (name txt)
4497 "Find and replace table NAME with TXT."
4498 (save-excursion
4499 (goto-char (point-min))
4500 (unless (re-search-forward
4502 (user-error "Don't know where to insert translated table"))
4503 (goto-char (match-beginning 0))
4504 (beginning-of-line 2)
4505 (save-excursion
4506 (let ((beg (point)))
4507 (unless (re-search-forward
4508 (concat "END +RECEIVE +ORGTBL +" name) nil t)
4509 (user-error "Cannot find end of insertion region"))
4510 (beginning-of-line 1)
4511 (delete-region beg (point))))
4514 ;;;###autoload
4515 (defun org-table-to-lisp (&optional txt)
4516 "Convert the table at point to a Lisp structure.
4517 The structure will be a list. Each item is either the symbol `hline'
4518 for a horizontal separator line, or a list of field values as strings.
4519 The table is taken from the parameter TXT, or from the buffer at point."
4520 (unless txt
4521 (unless (org-at-table-p)
4522 (user-error "No table at point")))
4523 (let* ((txt (or txt
4524 (buffer-substring-no-properties (org-table-begin)
4525 (org-table-end))))
4528 (mapcar
4529 (lambda (x)
4530 (if (string-match org-table-hline-regexp x)
4531 'hline
4533 lines)))
4535 (defun orgtbl-send-table (&optional maybe)
4536 "Send a transformed version of this table to the receiver position.
4537 With argument MAYBE, fail quietly if no transformation is defined for
4538 this table."
4539 (interactive)
4540 (catch 'exit
4541 (unless (org-at-table-p) (user-error "Not at a table"))
4542 ;; when non-interactive, we assume align has just happened.
4543 (when (org-called-interactively-p 'any) (org-table-align))
4544 (let ((dests (orgtbl-gather-send-defs))
4545 (txt (buffer-substring-no-properties (org-table-begin)
4546 (org-table-end)))
4547 (ntbl 0))
4548 (unless dests (if maybe (throw 'exit nil)
4549 (user-error "Don't know how to transform this table")))
4550 (dolist (dest dests)
4551 (let* ((name (plist-get dest :name))
4552 (transform (plist-get dest :transform))
4553 (params (plist-get dest :params))
4554 (skip (plist-get params :skip))
4555 (skipcols (plist-get params :skipcols))
4556 (no-escape (plist-get params :no-escape))
4557 beg
4558 (lines (org-table-clean-before-export
4559 (nthcdr (or skip 0)
4561 (i0 (if org-table-clean-did-remove-column 2 1))
4562 (lines (if no-escape lines
4563 (mapcar (lambda(l) (replace-regexp-in-string
4565 (table (mapcar
4566 (lambda (x)
4567 (if (string-match org-table-hline-regexp x)
4568 'hline
4569 (org-remove-by-index
4571 skipcols i0)))
4572 lines))
4573 (fun (if (= i0 2) 'cdr 'identity))
4574 (org-table-last-alignment
4575 (org-remove-by-index (funcall fun org-table-last-alignment)
4576 skipcols i0))
4577 (org-table-last-column-widths
4578 (org-remove-by-index (funcall fun org-table-last-column-widths)
4579 skipcols i0))
4580 (txt (if (fboundp transform)
4581 (funcall transform table params)
4582 (user-error "No such transformation function %s" transform))))
4583 (orgtbl-send-replace-tbl name txt))
4584 (setq ntbl (1+ ntbl)))
4585 (message "Table converted and installed at %d receiver location%s"
4586 ntbl (if (> ntbl 1) "s" ""))
4587 (if (> ntbl 0)
4588 ntbl
4589 nil))))
4591 (defun org-remove-by-index (list indices &optional i0)
4592 "Remove the elements in LIST with indices in INDICES.
4593 First element has index 0, or I0 if given."
4594 (if (not indices)
4595 list
4596 (if (integerp indices) (setq indices (list indices)))
4597 (setq i0 (1- (or i0 0)))
4598 (delq :rm (mapcar (lambda (x)
4599 (setq i0 (1+ i0))
4600 (if (memq i0 indices) :rm x))
4601 list))))
4603 (defun orgtbl-toggle-comment ()
4604 "Comment or uncomment the orgtbl at point."
4605 (interactive)
4606 (let* ((case-fold-search t)
4607 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4608 (re2 (concat "^" orgtbl-line-start-regexp))
4609 (commented (save-excursion (beginning-of-line 1)
4610 (cond ((looking-at re1) t)
4611 ((looking-at re2) nil)
4612 (t (user-error "Not at an org table")))))
4613 (re (if commented re1 re2))
4614 beg end)
4615 (save-excursion
4616 (beginning-of-line 1)
4617 (while (looking-at re) (beginning-of-line 0))
4618 (beginning-of-line 2)
4619 (setq beg (point))
4620 (while (looking-at re) (beginning-of-line 2))
4621 (setq end (point)))
4622 (comment-region beg end (if commented '(4) nil))))
4624 (defun orgtbl-insert-radio-table ()
4625 "Insert a radio table template appropriate for this major mode."
4626 (interactive)
4627 (let* ((e (assq major-mode orgtbl-radio-table-templates))
4628 (txt (nth 1 e))
4629 name pos)
4630 (unless e (user-error "No radio table setup defined for %s" major-mode))
4631 (setq name (read-string "Table name: "))
4632 (while (string-match "%n" txt)
4633 (setq txt (replace-match name t t txt)))
4635 (setq pos (point))
4636 (insert txt)
4637 (goto-char pos)))
4639 ;; Dynamically bound input and output for table formatting.
4640 (defvar *orgtbl-table* nil
4641 "Carries the current table through formatting routines.")
4642 (defvar *orgtbl-rtn* nil
4643 "Formatting routines push the output lines here.")
4644 ;; Formatting parameters for the current table section.
4645 (defvar *orgtbl-hline* nil "Text used for horizontal lines.")
4646 (defvar *orgtbl-sep* nil "Text used as a column separator.")
4647 (defvar *orgtbl-default-fmt* nil "Default format for each entry.")
4648 (defvar *orgtbl-fmt* nil "Format for each entry.")
4649 (defvar *orgtbl-efmt* nil "Format for numbers.")
4650 (defvar *orgtbl-lfmt* nil "Format for an entire line, overrides fmt.")
4651 (defvar *orgtbl-llfmt* nil "Specializes lfmt for the last row.")
4652 (defvar *orgtbl-lstart* nil "Text starting a row.")
4653 (defvar *orgtbl-llstart* nil "Specializes lstart for the last row.")
4654 (defvar *orgtbl-lend* nil "Text ending a row.")
4655 (defvar *orgtbl-llend* nil "Specializes lend for the last row.")
4657 (defsubst orgtbl-get-fmt (fmt i)
4658 "Retrieve the format from FMT corresponding to the Ith column."
4659 (if (and (not (functionp fmt)) (consp fmt))
4660 (plist-get fmt i)
4661 fmt))
4663 (defsubst orgtbl-apply-fmt (fmt &rest args)
4664 "Apply format FMT to arguments ARGS.
4665 When FMT is nil, return the first argument from ARGS."
4666 (cond ((functionp fmt) (apply fmt args))
4667 (fmt (apply 'format fmt args))
4668 (args (car args))
4669 (t args)))
4671 (defsubst orgtbl-eval-str (str)
4672 "If STR is a function, evaluate it with no arguments."
4673 (if (functionp str)
4674 (funcall str)
4675 str))
4677 (defun orgtbl-format-line (line)
4678 "Format LINE as a table row."
4679 (if (eq line 'hline) (if *orgtbl-hline* (push *orgtbl-hline* *orgtbl-rtn*))
4680 (let* ((i 0)
4681 (line
4682 (mapcar
4683 (lambda (f)
4684 (setq i (1+ i))
4685 (let* ((efmt (orgtbl-get-fmt *orgtbl-efmt* i))
4686 (f (if (and efmt (string-match orgtbl-exp-regexp f))
4687 (orgtbl-apply-fmt efmt (match-string 1 f)
4688 (match-string 2 f))
4689 f)))
4690 (orgtbl-apply-fmt (or (orgtbl-get-fmt *orgtbl-fmt* i)
4691 *orgtbl-default-fmt*)
4692 f)))
4693 line)))
4694 (push (if *orgtbl-lfmt*
4695 (apply #'orgtbl-apply-fmt *orgtbl-lfmt* line)
4696 (concat (orgtbl-eval-str *orgtbl-lstart*)
4697 (mapconcat 'identity line *orgtbl-sep*)
4698 (orgtbl-eval-str *orgtbl-lend*)))
4699 *orgtbl-rtn*))))
4701 (defun orgtbl-format-section (section-stopper)
4702 "Format lines until the first occurrence of SECTION-STOPPER."
4703 (let (prevline)
4704 (progn
4705 (while (not (eq (car *orgtbl-table*) section-stopper))
4706 (if prevline (orgtbl-format-line prevline))
4707 (setq prevline (pop *orgtbl-table*)))
4708 (if prevline (let ((*orgtbl-lstart* *orgtbl-llstart*)
4709 (*orgtbl-lend* *orgtbl-llend*)
4710 (*orgtbl-lfmt* *orgtbl-llfmt*))
4711 (orgtbl-format-line prevline))))))
4713 ;;;###autoload
4714 (defun orgtbl-to-generic (table params &optional backend)
4715 "Convert the orgtbl-mode TABLE to some other format.
4716 This generic routine can be used for many standard cases.
4717 TABLE is a list, each entry either the symbol `hline' for a horizontal
4718 separator line, or a list of fields for that line.
4719 PARAMS is a property list of parameters that can influence the conversion.
4720 A third optional argument BACKEND can be used to convert the content of
4721 the cells using a specific export back-end.
4723 For the generic converter, some parameters are obligatory: you need to
4724 specify either :lfmt, or all of (:lstart :lend :sep).
4726 Valid parameters are:
4728 :splice When set to t, return only table body lines, don't wrap
4729 them into :tstart and :tend. Default is nil. When :splice
4730 is non-nil, this also means that the exporter should not look
4731 for and interpret header and footer sections.
4733 :hline String to be inserted on horizontal separation lines.
4734 May be nil to ignore hlines.
4736 :sep Separator between two fields
4737 :remove-nil-lines Do not include lines that evaluate to nil.
4739 Each in the following group may be either a string or a function
4740 of no arguments returning a string:
4742 :tstart String to start the table. Ignored when :splice is t.
4743 :tend String to end the table. Ignored when :splice is t.
4744 :lstart String to start a new table line.
4745 :llstart String to start the last table line, defaults to :lstart.
4746 :lend String to end a table line
4747 :llend String to end the last table line, defaults to :lend.
4749 Each in the following group may be a string, a function of one
4750 argument (the field or line) returning a string, or a plist
4751 mapping columns to either of the above:
4753 :lfmt Format for entire line, with enough %s to capture all fields.
4754 If this is present, :lstart, :lend, and :sep are ignored.
4755 :llfmt Format for the entire last line, defaults to :lfmt.
4756 :fmt A format to be used to wrap the field, should contain
4757 %s for the original field value. For example, to wrap
4759 This may also be a property list with column numbers and
4761 :hlstart :hllstart :hlend :hllend :hlsep :hlfmt :hllfmt :hfmt
4762 Same as above, specific for the header lines in the table.
4763 All lines before the first hline are treated as header.
4764 If any of these is not present, the data line value is used.
4766 This may be either a string or a function of two arguments:
4768 :efmt Use this format to print numbers with exponentials.
4769 The format should have %s twice for inserting mantissa
4771 may also be a property list with column numbers and
4772 formats. :fmt will still be applied after :efmt.
4774 In addition to this, the parameters :skip and :skipcols are always handled
4775 directly by `orgtbl-send-table'. See manual."
4776 (let* ((splicep (plist-get params :splice))
4777 (hline (plist-get params :hline))
4778 (skipheadrule (plist-get params :skipheadrule))
4779 (remove-nil-linesp (plist-get params :remove-nil-lines))
4780 (remove-newlines (plist-get params :remove-newlines))
4781 (*orgtbl-hline* hline)
4782 (*orgtbl-table* table)
4783 (*orgtbl-sep* (plist-get params :sep))
4784 (*orgtbl-efmt* (plist-get params :efmt))
4785 (*orgtbl-lstart* (plist-get params :lstart))
4786 (*orgtbl-llstart* (or (plist-get params :llstart) *orgtbl-lstart*))
4787 (*orgtbl-lend* (plist-get params :lend))
4788 (*orgtbl-llend* (or (plist-get params :llend) *orgtbl-lend*))
4789 (*orgtbl-lfmt* (plist-get params :lfmt))
4790 (*orgtbl-llfmt* (or (plist-get params :llfmt) *orgtbl-lfmt*))
4791 (*orgtbl-fmt* (plist-get params :fmt))
4792 *orgtbl-rtn*)
4793 ;; Convert cells content to backend BACKEND
4794 (when backend
4795 (setq *orgtbl-table*
4796 (mapcar
4797 (lambda(r)
4798 (if (listp r)
4799 (mapcar
4800 (lambda (c)
4801 (org-trim (org-export-string-as c backend t '(:with-tables t))))
4802 r)
4803 r))
4804 *orgtbl-table*)))
4805 ;; Put header
4806 (unless splicep
4807 (when (plist-member params :tstart)
4808 (let ((tstart (orgtbl-eval-str (plist-get params :tstart))))
4809 (if tstart (push tstart *orgtbl-rtn*)))))
4810 ;; If we have a heading, format it and handle the trailing hline.
4811 (if (and (not splicep)
4812 (or (consp (car *orgtbl-table*))
4813 (consp (nth 1 *orgtbl-table*)))
4814 (memq 'hline (cdr *orgtbl-table*)))
4815 (progn
4816 (when (eq 'hline (car *orgtbl-table*))
4817 ;; There is a hline before the first data line
4818 (and hline (push hline *orgtbl-rtn*))
4819 (pop *orgtbl-table*))
4820 (let* ((*orgtbl-lstart* (or (plist-get params :hlstart)
4821 *orgtbl-lstart*))
4822 (*orgtbl-llstart* (or (plist-get params :hllstart)
4823 *orgtbl-llstart*))
4824 (*orgtbl-lend* (or (plist-get params :hlend) *orgtbl-lend*))
4825 (*orgtbl-llend* (or (plist-get params :hllend)
4826 (plist-get params :hlend) *orgtbl-llend*))
4827 (*orgtbl-lfmt* (or (plist-get params :hlfmt) *orgtbl-lfmt*))
4828 (*orgtbl-llfmt* (or (plist-get params :hllfmt)
4829 (plist-get params :hlfmt) *orgtbl-llfmt*))
4830 (*orgtbl-sep* (or (plist-get params :hlsep) *orgtbl-sep*))
4831 (*orgtbl-fmt* (or (plist-get params :hfmt) *orgtbl-fmt*)))
4832 (orgtbl-format-section 'hline))
4833 (if (and hline (not skipheadrule)) (push hline *orgtbl-rtn*))
4834 (pop *orgtbl-table*)))
4835 ;; Now format the main section.
4836 (orgtbl-format-section nil)
4837 (unless splicep
4838 (when (plist-member params :tend)
4839 (let ((tend (orgtbl-eval-str (plist-get params :tend))))
4840 (if tend (push tend *orgtbl-rtn*)))))
4841 (mapconcat (if remove-newlines
4842 (lambda (tend)
4844 'identity)
4845 (nreverse (if remove-nil-linesp
4846 (remq nil *orgtbl-rtn*)
4849 ;;;###autoload
4850 (defun orgtbl-to-tsv (table params)
4851 "Convert the orgtbl-mode table to TAB separated material."
4853 ;;;###autoload
4854 (defun orgtbl-to-csv (table params)
4855 "Convert the orgtbl-mode table to CSV material.
4856 This does take care of the proper quoting of fields with comma or quotes."
4857 (orgtbl-to-generic table (org-combine-plists
4858 '(:sep "," :fmt org-quote-csv-field)
4859 params)))
4861 ;;;###autoload
4862 (defun orgtbl-to-latex (table params)
4863 "Convert the orgtbl-mode TABLE to LaTeX.
4864 TABLE is a list, each entry either the symbol `hline' for a horizontal
4865 separator line, or a list of fields for that line.
4866 PARAMS is a property list of parameters that can influence the conversion.
4867 Supports all parameters from `orgtbl-to-generic'. Most important for
4868 LaTeX are:
4870 :splice When set to t, return only table body lines, don't wrap
4871 them into a tabular environment. Default is nil.
4873 :fmt A format to be used to wrap the field, should contain %s for the
4874 original field value. For example, to wrap everything in dollars,
4877 The format may also be a function that formats its one argument.
4879 :efmt Format for transforming numbers with exponentials. The format
4880 should have %s twice for inserting mantissa and exponent, for
4882 This may also be a property list with column numbers and formats.
4883 The format may also be a function that formats its two arguments.
4885 :llend If you find too much space below the last line of a table,
4888 The general parameters :skip and :skipcols have already been applied when
4889 this function is called."
4890 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
4891 org-table-last-alignment ""))
4892 (params2
4893 (list
4898 (require 'ox-latex)
4899 (orgtbl-to-generic table (org-combine-plists params2 params) 'latex)))
4901 ;;;###autoload
4902 (defun orgtbl-to-html (table params)
4903 "Convert the orgtbl-mode TABLE to HTML.
4904 TABLE is a list, each entry either the symbol `hline' for a horizontal
4905 separator line, or a list of fields for that line.
4906 PARAMS is a property list of parameters that can influence the conversion.
4907 Currently this function recognizes the following parameters:
4909 :splice When set to t, return only table body lines, don't wrap
4910 them into a <table> environment. Default is nil.
4912 The general parameters :skip and :skipcols have already been applied when
4913 this function is called. The function does *not* use `orgtbl-to-generic',
4914 so you cannot specify parameters for it."
4915 (require 'ox-html)
4916 (let ((output (org-export-string-as
4917 (orgtbl-to-orgtbl table nil) 'html t '(:with-tables t))))
4918 (if (not (plist-get params :splice)) output
4919 (org-trim
4920 (replace-regexp-in-string
4924 ;;;###autoload
4925 (defun orgtbl-to-texinfo (table params)
4926 "Convert the orgtbl-mode TABLE to TeXInfo.
4927 TABLE is a list, each entry either the symbol `hline' for a horizontal
4928 separator line, or a list of fields for that line.
4929 PARAMS is a property list of parameters that can influence the conversion.
4930 Supports all parameters from `orgtbl-to-generic'. Most important for
4931 TeXInfo are:
4933 :splice nil/t When set to t, return only table body lines, don't wrap
4934 them into a multitable environment. Default is nil.
4936 :fmt fmt A format to be used to wrap the field, should contain
4937 %s for the original field value. For example, to wrap
4939 This may also be a property list with column numbers and
4941 Each format also may be a function that formats its one
4942 argument.
4945 are computed automatically from the width of the columns
4946 under org-mode.
4948 The general parameters :skip and :skipcols have already been applied when
4949 this function is called."
4950 (let* ((total (float (apply '+ org-table-last-column-widths)))
4951 (colfrac (or (plist-get params :cf)
4952 (mapconcat
4953 (lambda (x) (format "%.3f" (/ (float x) total)))
4954 org-table-last-column-widths " ")))
4955 (params2
4956 (list
4957 :tstart (concat "@multitable @columnfractions " colfrac)
4958 :tend "@end multitable"
4959 :lstart "@item " :lend "" :sep " @tab "
4960 :hlstart "@headitem ")))
4961 (require 'ox-texinfo)
4962 (orgtbl-to-generic table (org-combine-plists params2 params) 'texinfo)))
4964 ;;;###autoload
4965 (defun orgtbl-to-orgtbl (table params)
4966 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
4967 Useful when slicing one table into many. The :hline, :sep,
4968 :lstart, and :lend provide orgtbl framing. The default nil :tstart
4969 and :tend suppress strings without splicing; they can be set to
4970 provide ORGTBL directives for the generated table."
4971 (let* ((params2
4972 (list
4973 :remove-newlines t
4974 :tstart nil :tend nil
4975 :hline "|---"
4976 :sep " | "
4977 :lstart "| "
4978 :lend " |"))
4979 (params (org-combine-plists params2 params)))
4980 (with-temp-buffer
4981 (insert (orgtbl-to-generic table params))
4982 (goto-char (point-min))
4983 (while (re-search-forward org-table-hline-regexp nil t)
4984 (org-table-align))
4985 (buffer-substring 1 (buffer-size)))))
4987 (defun orgtbl-to-table.el (table params)
4988 "Convert the orgtbl-mode TABLE into a table.el table."
4989 (with-temp-buffer
4990 (insert (orgtbl-to-orgtbl table params))
4991 (org-table-align)
4992 (replace-regexp-in-string
4993 "-|" "-+"
4994 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
4996 (defun orgtbl-to-unicode (table params)
4997 "Convert the orgtbl-mode TABLE into a table with unicode characters.
4998 You need the ascii-art-to-unicode.el package for this. You can download
4999 it here: http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el."
5000 (with-temp-buffer
5001 (insert (orgtbl-to-table.el table params))
5002 (goto-char (point-min))
5003 (if (or (featurep 'ascii-art-to-unicode)
5004 (require 'ascii-art-to-unicode nil t))
5005 (aa2u)
5006 (unless (delq nil (mapcar (lambda (l) (string-match "aa2u" (car l))) org-stored-links))
5007 (push '("http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el"
5008 "Link to ascii-art-to-unicode.el") org-stored-links))
5009 (user-error "Please download ascii-art-to-unicode.el (use C-c C-l to insert the link to it)"))
5010 (buffer-string)))
5012 ;; Put the cursor in a column containing numerical values
5013 ;; of an Org-Mode table,
5014 ;; type C-c p
5015 ;; A new column is added with a bar plot.
5016 ;; When the table is refreshed (C-u C-c *),
5017 ;; the plot is updated to reflect the new values.
5019 (defun orgtbl-ascii-draw (value min max &optional width characters)
5020 "Draw an ascii bar in a table.
5021 VALUE is a the value to plot, the width of the bar to draw. A
5022 value equal to MIN will be displayed as empty (zero width bar).
5023 A value equal to MAX will draw a bar filling all the WIDTH.
5024 WIDTH is the expected width in characters of the column.
5025 CHARACTERS is a string that will compose the bar, with shades of
5026 grey from pure white to pure black. It defaults to a 10
5027 characters string of regular ascii characters."
5028 (let* ((characters (or characters " .:;c!lhVHW"))
5029 (width (or width 12))
5030 (value (if (numberp value) value (string-to-number value)))
5031 (value (* (/ (- (+ value 0.0) min) (- max min)) width)))
5032 (cond
5033 ((< value 0) "too small")
5034 ((> value width) "too large")
5035 (t
5036 (let ((len (1- (length characters))))
5037 (concat
5038 (make-string (floor value) (elt characters len))
5039 (string (elt characters
5040 (floor (* (- value (floor value)) len))))))))))
5042 ;;;###autoload
5043 (defun orgtbl-ascii-plot (&optional ask)
5044 "Draw an ascii bar plot in a column.
5045 With cursor in a column containing numerical values, this
5046 function will draw a plot in a new column.
5047 ASK, if given, is a numeric prefix to override the default 12
5048 characters width of the plot. ASK may also be the
5050 (interactive "P")
5051 (let ((col (org-table-current-column))
5052 (min 1e999) ; 1e999 will be converted to infinity
5053 (max -1e999) ; which is the desired result
5054 (table (org-table-to-lisp))
5055 (length
5056 (cond ((consp ask)
5057 (read-number "Length of column " 12))
5058 ((numberp ask) ask)
5059 (t 12))))
5060 ;; Skip any hline a the top of table.
5061 (while (eq (car table) 'hline) (setq table (cdr table)))
5062 ;; Skip table header if any.
5063 (dolist (x (or (cdr (memq 'hline table)) table))
5064 (when (consp x)
5065 (setq x (nth (1- col) x))
5066 (when (string-match
5068 x)
5069 (setq x (string-to-number x))
5070 (when (> min x) (setq min x))
5071 (when (< max x) (setq max x)))))
5072 (org-table-insert-column)
5073 (org-table-move-column-right)
5074 (org-table-store-formulas
5075 (cons
5076 (cons
5077 (number-to-string (1+ col))
5078 (format "'(%s $%s %s %s %s)"
5079 "orgtbl-ascii-draw" col min max length))
5080 (org-table-get-stored-formulas)))
5081 (org-table-recalculate t)))
5083 ;; Example of extension: unicode characters
5084 ;; Here are two examples of different styles.
5086 ;; Unicode block characters are used to give a smooth effect.
5087 ;; See http://en.wikipedia.org/wiki/Block_Elements
5088 ;; Use one of those drawing functions
5089 ;; - orgtbl-ascii-draw (the default ascii)
5090 ;; - orgtbl-uc-draw-grid (unicode with a grid effect)
5091 ;; - orgtbl-uc-draw-cont (smooth unicode)
5093 ;; This is best viewed with the "DejaVu Sans Mono" font
5094 ;; (use M-x set-default-font).
5096 (defun orgtbl-uc-draw-grid (value min max &optional width)
5097 "Draw a bar in a table using block unicode characters.
5098 It is a variant of orgtbl-ascii-draw with Unicode block
5099 characters, for a smooth display. Bars appear as grids (to the
5100 extent the font allows)."
5101 ;; http://en.wikipedia.org/wiki/Block_Elements
5102 ;; best viewed with the "DejaVu Sans Mono" font.
5103 (orgtbl-ascii-draw value min max width
5106 (defun orgtbl-uc-draw-cont (value min max &optional width)
5107 "Draw a bar in a table using block unicode characters.
5108 It is a variant of orgtbl-ascii-draw with Unicode block
5109 characters, for a smooth display. Bars are solid (to the extent
5110 the font allows)."
5111 (orgtbl-ascii-draw value min max width
5114 (defun org-table-get-remote-range (name-or-id form)
5115 "Get a field value or a list of values in a range from table at ID.
5117 NAME-OR-ID may be the name of a table in the current file as set
5119 will then be used. Alternatively, it may be an ID referring to
5120 any entry, also in a different file. In this case, the first
5121 table in that entry will be referenced.
5125 The return value is either a single string for a single field, or a
5126 list of the fields in the rectangle."
5127 (save-match-data
5128 (let ((case-fold-search t) (id-loc nil)
5129 ;; Protect a bunch of variables from being overwritten
5130 ;; by the context of the remote table
5131 org-table-column-names org-table-column-name-regexp
5132 org-table-local-parameters org-table-named-field-locations
5133 org-table-current-line-types org-table-current-begin-line
5134 org-table-current-begin-pos org-table-dlines
5135 org-table-current-ncol
5136 org-table-hlines org-table-last-alignment
5137 org-table-last-column-widths org-table-last-alignment
5138 org-table-last-column-widths tbeg
5139 buffer loc)
5140 (setq form (org-table-convert-refs-to-rc form))
5141 (save-excursion
5142 (save-restriction
5143 (widen)
5144 (save-excursion
5145 (goto-char (point-min))
5146 (if (re-search-forward
5149 nil t)
5150 (setq buffer (current-buffer) loc (match-beginning 0))
5151 (setq id-loc (org-id-find name-or-id 'marker))
5152 (unless (and id-loc (markerp id-loc))
5154 (setq buffer (marker-buffer id-loc)
5155 loc (marker-position id-loc))
5156 (move-marker id-loc nil)))
5157 (with-current-buffer buffer
5158 (save-excursion
5159 (save-restriction
5160 (widen)
5161 (goto-char loc)
5162 (forward-char 1)
5164 (not (match-beginning 1)))
5165 (user-error "Cannot find a table at NAME or ID %s" name-or-id))
5166 (setq tbeg (point-at-bol))
5167 (org-table-get-specials)
5168 (setq form (org-table-formula-substitute-names
5169 (org-table-formula-handle-first/last-rc form)))
5170 (if (and (string-match org-table-range-regexp form)
5171 (> (length (match-string 0 form)) 1))
5172 (save-match-data
5173 (org-table-get-range (match-string 0 form) tbeg 1))
5174 form)))))))))
5176 (defun org-table-remote-reference-indirection (form)
5177 "Return formula with table remote references substituted by indirection.
5179 This indirection works only with the format @ROW$COLUMN. The
5181 distinguished from a plain table name or ID."
5182 (let ((start 0))
5183 (while (string-match (concat
5184 ;; Same as in `org-table-eval-formula'.
5186 ;; Allow "$1", "@<", "$-1", "@<<$1" etc.
5188 ;; Same as in `org-table-eval-formula'.
5190 form
5191 start)
5192 ;; The position of the character as far as possible to the right
5193 ;; that will not be replaced and particularly not be shifted by
5194 ;; `replace-match'.
5195 (setq start (match-beginning 1))
5196 ;; Substitute the remote reference with the value found in the
5197 ;; field.
5198 (setq form
5199 (replace-match
5200 (save-match-data
5201 (org-table-get-range (org-table-formula-handle-first/last-rc
5202 (match-string 1 form))))
5203 t t form 1))))
5204 form)
5206 (defmacro org-define-lookup-function (mode)
5207 (let ((mode-str (symbol-name mode))
5208 (first-p (equal mode 'first))
5209 (all-p (equal mode 'all)))
5210 (let ((plural-str (if all-p "s" "")))
5211 `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
5212 ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
5213 If R-LIST is nil, return matching element%s of S-LIST.
5214 If PREDICATE is not nil, use it instead of `equal' to match VAL.
5215 Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
5216 This function is generated by a call to the macro `org-define-lookup-function'."
5217 mode-str plural-str plural-str plural-str)
5218 (let ,(let ((lvars '((p (or predicate 'equal))
5219 (sl s-list)
5220 (rl (or r-list s-list))
5221 (ret nil))))
5222 (if first-p (add-to-list 'lvars '(match-p nil)))
5223 lvars)
5224 (while ,(if first-p '(and (not match-p) sl) 'sl)
5225 (progn
5226 (if (funcall p val (car sl))
5227 (progn
5228 ,(if first-p '(setq match-p t))
5229 (let ((rval (car rl)))
5230 (setq ret ,(if all-p '(append ret (list rval)) 'rval)))))
5231 (setq sl (cdr sl) rl (cdr rl))))
5232 ret)))))
5234 (org-define-lookup-function first)
5235 (org-define-lookup-function last)
5236 (org-define-lookup-function all)
5238 (provide 'org-table)
5240 ;; Local variables:
5241 ;; generated-autoload-file: "org-loaddefs.el"
5242 ;; End:
5244 ;;; org-table.el ends here