| blob | c5a3aca390a144dedcc16eb027083a5c8399bb5d |
1 ;;; org-table.el --- The table editor for Org-mode
3 ;; Copyright (C) 2004-2013 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:
50 "Hook for functions attaching to `C-c C-c', if the table is sent.
51 This can be used to add additional functionality after the table is sent
52 to the receiver position, otherwise, if table is not sent, the functions
58 "Non-nil means use the optimized table editor version for `orgtbl-mode'.
59 In the optimized version, the table editor takes over all simple keys that
60 normally just insert a character. In tables, the characters are inserted
61 in a way to minimize disturbing the table structure (i.e. in overwrite mode
62 for empty fields). Outside tables, the correct binding of the keys is
63 restored.
65 The default for this option is t if the optimized version is also used in
66 Org-mode. See the variable `org-enable-table-editor' for details. Changing
67 this variable requires a restart of Emacs to become effective."
73 % END RECEIVE ORGTBL %n
75 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
76 | | |
79 @c END RECEIVE ORGTBL %n
80 @ignore
81 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
82 | | |
85 <!-- END RECEIVE ORGTBL %n -->
86 <!--
87 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
88 | | |
91 #+ END RECEIVE ORGTBL %n
93 #+ORGTBL: SEND %n orgtbl-to-orgtbl :splice nil :skip 0
94 | | |
96 "Templates for radio tables in different major modes.
97 All occurrences of %n in a template will be replaced with the name of the
98 table, obtained by prompting the user."
105 "Settings for tables in Org-mode."
110 "The default size for newly created tables, Columns x Rows."
115 "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%:]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$"
116 "Regular expression for recognizing numbers in table columns.
117 If a table column contains mostly numbers, it will be aligned to the
118 right. If not, it will be aligned to the left.
120 The default value of this option is a regular expression which allows
121 anything which looks remotely like a number as used in scientific
122 context. For example, all of the following will be considered a
123 number:
124 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
126 Other options offered by the customize interface are more restrictive."
140 "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
141 (const :tag "Very General Number-Like, including hex and Calc radix, allows comma as decimal mark"
142 "^\\([<>]?[-+^.,0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
146 "Fraction of numbers in a column required to make the column align right.
147 In a column all non-white fields are considered. If at least
148 this fraction of fields is matched by `org-table-number-regexp',
149 alignment to the right border applies."
154 "Behavior of tables during editing in Org-mode."
159 "Non-nil means automatically re-align table when pressing TAB or RETURN.
161 removal/insertion."
166 "Non-nil means automatically blank table field when starting to type into it.
167 This only happens when typing immediately after a field motion
168 command (TAB, S-TAB or RET).
169 Only relevant when `org-enable-table-editor' is equal to `optimized'."
174 "Non-nil means automatically exit the follow mode.
175 When nil, the follow mode will stay on and be active in any table
176 the cursor enters. Since the table follow filed mode messes with the
177 window configuration, it is not recommended to set this variable to nil,
178 except maybe locally in a special file that has mostly tables with long
179 fields."
185 "Whether the user should confirm when Org fixes formulas."
193 'safe-local-variable
197 "Non-nil means tab in the last column of a table with jump over a hline.
198 If a horizontal separator line is following the current line,
199 `org-table-next-field' can either create a new row before that line, or jump
200 over the line. When this option is nil, a new line will be created before
201 this line."
206 "Options concerning tables in Org-mode."
211 "Should org-mode work with table references like B3 instead of @3$2?
212 Possible values are:
213 nil never use them
214 from accept as input, do not present for editing
215 t accept as input and present for editing"
230 calc-angle-mode deg
231 calc-prefer-frac nil
232 calc-symbolic-mode nil
234 calc-display-working-message t
235 )
236 "List with Calc mode settings for use in `calc-eval' for table formulas.
237 The list must contain alternating symbols (Calc modes variables and values).
238 Don't remove any of the default settings, just change the values. Org-mode
239 relies on the variables to be present in the list."
244 "Format for the output of calc computations like $1+$2;t.
245 The default value is 'hours, and will output the results as a
246 number of hours. Other allowed values are 'seconds, 'minutes and
247 'days, and the output will be a fraction of seconds, minutes or
248 days."
257 "Format for fields which contain the result of a formula.
259 characters. Beware that modifying the display can prevent the
260 field from being used in another formula."
266 "Non-nil means TAB and RET evaluate a formula in current table field.
267 If the current field starts with an equal sign, it is assumed to be a formula
268 which should be evaluated as described in the manual and in the documentation
269 string of the command `org-table-eval-formula'. This feature requires the
270 Emacs calc package.
271 When this variable is nil, formula calculation is only available through
277 "Non-nil means interpret constants in formulas in tables.
278 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
279 by the value given in `org-table-formula-constants', or by a value obtained
280 from the `constants.el' package."
285 "Alist with constant names and values, for use in table formulas.
286 The car of each element is a name of a constant, without the `$' before it.
287 The cdr is the value as a string. For example, if you'd like to use the
288 speed of light in a formula, you would configure
292 and then use it in an equation like `$1*$c'.
294 Constants can also be defined on a per-file basis using a line like
296 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
303 "Non-nil means lines marked with |#| or |*| will be recomputed automatically.
304 Automatically means when TAB or RET or C-c C-c are pressed in the line."
309 "OBSOLETE VARIABLE, please see `org-table-relative-ref-may-cross-hline'."
314 "Non-nil means relative formula references may cross hlines.
315 Here are the allowed values:
317 nil Relative references may not cross hlines. They will reference the
318 field next to the hline instead. Coming from below, the reference
319 will be to the field below the hline. Coming from above, it will be
320 to the field above.
321 t Relative references may cross hlines.
322 error An attempt to cross a hline will throw an error.
324 It is probably good to never set this variable to nil, for the sake of
325 portability of tables."
333 "Options concerning table import and export in Org-mode."
338 "Default export parameters for `org-table-export'.
339 These can be overridden for a specific table by setting the
340 TABLE_EXPORT_FORMAT property. See the manual section on orgtbl
341 radio tables for the different export transformations and
342 available parameters."
380 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
381 ;; 1 2 3 4 5
392 "Is this a table line colgroup information?"
396 line)
398 nil
405 "Is this a table line with only alignment/width cookies?"
418 s))))
424 "Check if the table has a marking column.
425 If yes remove the column and the special lines."
434 x)))
435 lines))
436 ;; No special marking column
444 ;; This line contains colgroup info, extract it
445 ;; and then discard the line
452 nil)
454 ;; This line contains formatting cookies, discard it
455 nil)
457 lines)))
458 ;; there is a special marking column
465 ;; This line contains colgroup info, extract it
466 ;; and then discard the line
473 nil)
475 ;; This line contains formatting cookies, discard it
476 nil)
478 ;; ignore this line
479 nil)
482 ;; remove the first column
484 lines))))
490 ;;;###autoload
492 "Use the table.el package to insert a new table.
493 If there is already a table at point, convert between Org-mode tables
494 and table.el tables."
507 ;;;###autoload
509 "Convert region to table, or create an empty table.
510 If there is an active region, convert it to a table, using the function
511 `org-table-convert-region'. See the documentation of that function
512 to learn how the prefix argument is interpreted to determine the field
513 separator.
514 If there is no such region, create an empty table with `org-table-create'."
520 ;;;###autoload
522 "Query for a size and insert a table skeleton.
542 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
546 ;; Insert a hline after the first row.
553 ;;;###autoload
555 "Convert region to a table.
556 The region goes from BEG0 to END0, but these borders will be moved
557 slightly, to make sure a beginning of line in the first line is included.
559 SEPARATOR specifies the field separator in the lines. It can have the
560 following values:
562 '(4) Use the comma as a field separator
563 '(16) Use a TAB as field separator
564 integer When a number, use that many spaces as field separator
565 nil When nil, the command tries to be smart and figure out the
566 separator in the following way:
567 - when each line contains a TAB, assume TAB-separated material
568 - when each line contains a comma, assume CSV material
569 - else, assume one or more SPACE characters as separator."
573 re)
580 ;; Get the right field separator
591 ;; parse the csv stuff
614 ;;;###autoload
616 "Import FILE as a table.
617 The file is assumed to be tab-separated. Such files can be produced by most
618 spreadsheet and database applications. If no tabs (at least one per line)
619 are found, lines will be split on whitespace into fields."
630 ;;;###autoload
632 "Export table to a file, with configurable format.
633 Such a file can be imported into usual spreadsheet programs.
635 FILE can be the output file name. If not given, it will be taken
636 from a TABLE_EXPORT_FILE property in the current entry or higher
637 up in the hierarchy, or the user will be prompted for a file
638 name. FORMAT can be an export format, of the same kind as it
639 used when `orgtbl-mode' sends a table in a different format.
641 The command suggests a format depending on TABLE_EXPORT_FORMAT,
642 whether it is set locally or up in the hierarchy, then on the
643 extension of the given file name, and finally on the variable
644 `org-table-export-default-format'."
658 buf deffmt-readable fileext)
674 org-table-export-default-format))
692 'hline
695 skipcols i0)))
696 lines))
700 skipcols i0))
703 skipcols i0)))
720 "Marker at the beginning of the table last aligned.
723 "Marker at the end of the table last aligned.
726 "List of flags for flushright alignment, from the last re-alignment.
729 "List of max width of fields in each column.
732 "Non-nil means debug table formulas.
744 ;;;###autoload
746 "Align the table at point by aligning all vertical bars."
749 ;; Limits of table
752 ;; Current cursor position
758 column
760 rfmt hfmt
768 emptystrings links dates emph raise narrow
769 falign falign1 fmax f1 len c e space)
772 ;; Check if we have links or dates
784 ;; Make sure the link properties are right
786 ;; Make sure the date properties are right
791 ;; Check if we are narrowing any columns
794 org-format-transports-properties-p
799 ;; Get the rows
802 ;; Store the indentation of the first line
805 ;; Mark the hlines by setting the corresponding element to nil
806 ;; At the same time, we remove trailing space.
809 nil
812 l)))
813 lines))
814 ;; Get the data fields by splitting the lines.
819 ;; How many fields in the longest line?
826 ;; A list of empty strings to fill any short rows on output
828 ;; Check for special formatting.
832 ;; Check if there is an explicit width specified
842 ;; Find fields that are wider than fmax, and shorten them
848 'help-echo
849 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
857 xx)))))
858 ;; Get the maximum width for each column
860 lengths)
861 ;; Get the fraction of numbers, to decide about alignment of the column
867 nil
874 ;; Store the alignment of this table, for later editing of single fields
876 org-table-last-column-widths lengths)
878 ;; With invisible characters, `format' does not get the field width right
879 ;; So we need to make these fields wide by hand.
897 ;; Compute the formats needed for output of the table
910 hfmt))
914 ;; Replace the old one
921 ;; Try to move to the old location
930 ))
933 "Find the beginning of the table and return its position.
934 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
938 org-table-border-regexp)
939 nil t))
946 "Find the end of the table and return its position.
947 With argument TABLE-TYPE, go to the end of a table.el-type table."
951 org-table-border-regexp)
952 nil t))
957 ;;;###autoload
959 "Justify the current field, text to left, number to right.
960 Optional argument NEW may specify text to replace the current field content."
969 ;; This is not the same table, force a full re-align
975 l f n o e)
998 ;;;###autoload
1000 "Go to the next field in the current table, creating new lines as needed.
1001 Before doing so, re-align the table if necessary."
1006 org-table-may-need-update)
1017 org-table-tab-jumps-over-hlines
1028 ;;;###autoload
1030 "Go to the previous field in the table.
1031 Before doing so, re-align the table if necessary."
1036 org-table-may-need-update)
1051 "Move to the end of the current table field.
1052 If already at or after the end, move to the end of the next table field.
1053 With numeric argument N, move N-1 fields forward first."
1066 "Move to the beginning of the current table field.
1067 If already at or before the beginning, move to the beginning of the
1068 previous field.
1069 With numeric argument N, move N-1 fields backward first."
1082 ;;;###autoload
1084 "Go to the next row (same column) in the current table.
1085 Before doing so, re-align the table if necessary."
1093 org-table-may-need-update)
1106 ;;;###autoload
1108 "Copy a field down in the current column.
1109 If the field at the cursor is empty, copy into it the content of
1110 the nearest non-empty field above. With argument N, use the Nth
1111 non-empty field. If the current field is not empty, it is copied
1112 down to the next row, and the cursor is moved with it.
1113 Therefore, repeating this command causes the column to be filled
1114 row-by-row.
1115 If the variable `org-table-copy-increment' is non-nil and the
1116 field is an integer or a timestamp, it will be incremented while
1117 copying. In the case of a timestamp, increment by one day."
1125 txt)
1137 beg t))
1160 "Is point inside a table data field?
1161 I.e. not on a hline or before the first or after the last column?
1162 This actually throws an error, so it aborts the current command."
1168 nil
1170 t))
1176 "Get the field in table line LINE, column COLUMN.
1177 If LINE is larger than the number of data lines in the table, the function
1178 returns nil. However, if COLUMN is too large, we will simply return an
1179 empty string.
1180 If LINE is nil, use the current line.
1181 If column is nil, use the current column."
1188 "Put VALUE into line LINE, column COLUMN.
1189 When ALIGN is set, also realign the table."
1198 "Return the index of the current data line."
1205 cnt))
1208 "Go to the Nth data line in the current table.
1209 Return t when the line exists, nil if it does not exist."
1217 "Blank the current table field or active region."
1234 "Return the value of the field in column N of current row.
1235 N defaults to current field.
1236 If REPLACE is a string, replace field with this value. The return value
1237 is always the old value."
1246 t t))
1248 val)
1251 ;;;###autoload
1253 "Show info about the current field, and highlight any reference at point."
1261 org-table-named-field-locations)))
1281 dline col
1283 dline col ref1
1285 ;; FIXME: formula info not correct if special table line
1295 "Find out which column we are in."
1305 cnt)))
1307 ;;;###autoload
1309 "Find out what table data line we are in.
1310 Only data lines count for this."
1322 cnt)))
1324 ;;;###autoload
1326 "Move the cursor to the Nth column in the current table line.
1327 With optional argument ON-DELIM, stop with point before the left delimiter
1328 of the field.
1329 If there are less than N fields, just go to after the last delimiter.
1330 However, when FORCE is non-nil, create new columns if necessary."
1340 t)))))
1347 ;;;###autoload
1349 "Insert a new column into the table."
1357 ;; Current cursor position
1363 nil
1377 "Find a data line in the current table, which is needed for column commands."
1380 t
1391 t
1396 "Turn a buffer line number into a data line number.
1397 If there is no data line in this line, return nil.
1398 If there is no matching dline (most likely te reference was a hline), the
1399 first dline below it is used. When ABOVE is non-nil, the one above is used."
1402 i)
1415 nil))
1417 ;;;###autoload
1419 "Delete a column from the table."
1428 ;; Current cursor position
1434 nil
1450 ;;;###autoload
1452 "Move column to the right."
1455 ;;;###autoload
1457 "Move column to the left."
1461 ;;;###autoload
1463 "Move the current column to the right. With arg LEFT, move to the left."
1473 ;; Current cursor position
1483 nil
1501 ;;;###autoload
1503 "Move table row down."
1506 ;;;###autoload
1508 "Move table row up."
1512 ;;;###autoload
1514 "Move the current table line down. With arg UP, move it up."
1523 txt hline2p)
1546 ;;;###autoload
1548 "Insert a new row above the current line into the table.
1549 With prefix ARG, insert below the current line."
1555 ;; Fix the first field if necessary
1568 ;;;###autoload
1570 "Insert a horizontal-line below the current line into the table.
1571 With prefix ABOVE, insert above the current line."
1592 ;;;###autoload
1594 "Insert a hline and move to the row below that line."
1608 In particular, this does handle wide and invisible characters."
1610 ;; It's a hline, just map the characters
1616 t t s)))
1617 s))
1619 ;;;###autoload
1621 "Delete the current row or horizontal line from the table."
1635 ;;;###autoload
1637 "Sort table lines according to the column at point.
1639 The position of point indicates the column to be used for
1640 sorting, and the range of lines is the range between the nearest
1641 horizontal separator lines, or the entire table of no such lines
1642 exist. If point is before the first column, you will be prompted
1643 for the sorting column. If there is an active region, the mark
1644 specifies the first line and the sorting column, while point
1645 should be in the last line to be included into the sorting.
1647 The command then prompts for the sorting type which can be
1648 alphabetically, numerically, or by time (as given in a time stamp
1649 in the field). Sorting in reverse order is 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 orgmode 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 disappeared."
1870 table)))
1877 ;;;###autoload
1879 "Wrap several fields in a column like a paragraph.
1880 This is useful if you'd like to spread the contents of a field over several
1881 lines, in order to keep the table compact.
1883 If there is an active region, and both point and mark are in the same column,
1884 the text in the column is wrapped to minimum width for the given number of
1885 lines. Generally, this makes the table more compact. A prefix ARG may be
1887 formats the selected text to two lines. If the region was longer than two
1888 lines, the remaining lines remain empty. A negative prefix argument reduces
1889 the current number of lines by that amount. The wrapped text is pasted back
1890 into the table. If you formatted it to more lines than it was before, fields
1891 further down in the table get overwritten - so you might need to make space in
1892 the table first.
1894 If there is no region, the current field is split at the cursor position and
1895 the text fragment to the right of the cursor is prepended to the field one
1896 line down.
1898 If there is no region, but you specify a prefix ARG, the current field gets
1899 blank, and the content is appended to the field above."
1903 ;; There is a region: fill as a paragraph
1907 nlines)
1914 arg)
1918 nil nlines)))
1922 ;; No region, split the current field at point
1926 ;; combine with field above
1936 ;; split field
1948 ;;;###autoload
1950 "Edit table field in a different window.
1951 This is mainly useful for fields that contain hidden parts.
1953 it can be edited in place."
1962 display t intangible t))
1975 p)
1991 intangible t))
1999 "Finish editing a table data field.
2000 Remove all newline characters, insert the result into the table, realign
2001 the table and kill the editing buffer."
2005 text)
2022 "Minor mode to make the table field editor window follow the cursor.
2023 When this mode is active, the field editor window will always show the
2024 current field. The mode exits automatically when the cursor leaves the
2025 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
2026 nil " TblFollow" nil
2042 ;; We have left the table, exit the follow mode
2052 ;;;###autoload
2054 "Sum numbers in region of current table column.
2055 The result will be displayed in the echo area, and will be available
2058 If there is an active region, it is interpreted as a rectangle and all
2059 numbers in that rectangle will be summed. If there is no active
2060 region and point is located in a table column, sum all numbers in that
2061 column.
2063 If at least one number looks like a time HH:MM or HH:MM:SS, all other
2064 numbers are assumed to be times as well (in decimal hours) and the
2065 numbers are added as such.
2067 If NLAST is a number, only the NLAST fields will actually be summed."
2094 items1)))
2101 s diff)
2109 sres))))
2132 "Return the formula active for the current field.
2133 Assumes that specials are in place.
2134 If KEY is given, return the key to this formula.
2138 org-table-named-field-locations)))
2152 "Read a formula from the minibuffer, offer stored formula as default.
2153 When NAMED is non-nil, look for a named equation."
2157 org-table-named-field-locations)))
2164 name
2165 ref)
2175 stored)
2177 equation)
2184 scol))
2186 'org-table-formula-history
2187 )))))
2188 mustsave)
2190 ;; remove formula
2197 ;; We set the column equation, delete the named one.
2199 mustsave t))
2205 eq))
2208 "Store the list of formulas below the current table."
2215 ;; don't overwrite TBLFM, we might use text properties to store stuff
2231 ;; Fake a high number to make sure this is sorted at the end.
2238 a)
2248 "Compare two formulas for sorting."
2253 ;;;###autoload
2255 "Return an alist with the stored formulas directly after current table."
2264 (when (string-match "\\`\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*[^ \t]\\)" string)
2283 "Modify the equations after the table structure has been edited.
2285 For all numbers larger than LIMIT, shift them by DELTA."
2297 s n a)
2317 "Get the column names and local parameters for this table."
2320 names name fields fields1 field cnt
2321 c v l line col types dlines hlines last-dline)
2323 org-table-local-parameters nil
2324 org-table-named-field-locations nil
2325 org-table-current-begin-line nil
2326 org-table-current-begin-pos nil
2327 org-table-current-line-types nil
2346 org-table-local-parameters))))
2362 ;; Analyse the line types
2366 l org-table-current-begin-line)
2383 al al2)
2393 ;;;###autoload
2396 If yes, store the formula and apply it."
2397 ;; We already know we are in a table. Get field will only return a formula
2398 ;; when appropriate. It might return a separator line, but no problem.
2401 named eq)
2412 "List of commands triggering the recalculation of a line.
2424 ;;;###autoload
2426 "Rotate the recalculation mark in the first column.
2427 If in any row, the first field is not consistent with a mark,
2428 insert a new column for the markers.
2429 When there is an active region, change all the lines in the region,
2430 after prompting for the marking character.
2431 After each change, a message will be displayed indicating the meaning
2432 of the new mark."
2447 epos new)
2454 newchar))
2486 ;;;###autoload
2488 "Recompute the current line if marked for it, and if we haven't just done it."
2508 org-tbl-calc-modes)
2510 ;;;###autoload
2512 suppress-align suppress-const
2513 suppress-store suppress-analysis)
2514 "Replace the table field value at the cursor by the result of a calculation.
2516 This function makes use of Dave Gillespie's Calc package, in my view the
2517 most exciting program ever written for GNU Emacs. So you need to have Calc
2518 installed in order to use this function.
2520 In a table, this command replaces the value in the current field with the
2522 formula, by storing it in a special line below the table. When called
2523 with a `C-u' prefix, the current field must be a named field, and the
2524 formula is installed as valid in only this specific field.
2526 When called with two `C-u' prefixes, insert the active equation
2527 for the field back into the current field, so that it can be
2529 to check the referenced fields.
2531 When called, the command first prompts for a formula, which is read in
2532 the minibuffer. Previously entered formulas are available through the
2533 history list, and the last used formula is offered as a default.
2534 These stored formulas are adapted correctly when moving, inserting, or
2535 deleting columns with the corresponding commands.
2537 The formula can be any algebraic expression understood by the Calc package.
2538 For details, see the Org-mode manual.
2540 This function can also be called from Lisp programs and offers
2541 additional arguments: EQUATION can be the formula to apply. If this
2542 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2543 used to speed-up recursive calls by by-passing unnecessary aligns.
2544 SUPPRESS-CONST suppresses the interpretation of constants in the
2545 formula, assuming that this has been done already outside the function.
2546 SUPPRESS-STORE means the formula should not be stored, either because
2547 it is already stored, or because it is a modified equation that should
2548 not overwrite the stored one."
2564 equation
2570 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2571 duration duration-output-format)
2572 ;; Parse the format string. Since we have a lot of modes, this is
2573 ;; a lot of work. However, I think calc still uses most of the time.
2586 'calc-float-format
2589 n))))
2593 duration-output-format nil
2597 duration-output-format org-table-duration-custom-format
2598 numbers t
2621 ;; replace fields with duration values if relevant
2625 fields)))
2631 x))
2632 fields)))
2638 ;; Insert row and column number of formula result field
2649 t t form)))
2651 ;; Check for old vertical references
2653 ;; Insert remote references
2665 rmtrng))
2666 keep-empty numbers lispp))
2667 t t form)))
2668 ;; Insert complex ranges
2676 ;; possibly handle durations
2681 formrg)
2682 keep-empty numbers lispp)))
2687 ;; Insert simple ranges
2696 keep-empty numbers lispp))
2697 t t form)))
2699 ;; Insert the references to fields in same row
2709 x keep-empty numbers lispp))
2710 t t form)))
2722 ;; Use <...> time-stamps so that Calc can handle them
2724 ;; I18n-ize local time-stamps by setting (system-time-locale "C")
2735 form
2742 duration-output-format)
2743 ev)))
2748 Orig: %s
2749 $xyz-> %s
2750 @r$c-> %s
2782 prop value)))
2785 "Get a calc vector from a column, according to descriptor DESC.
2786 Optional arguments TBEG and COL can give the beginning of the table and
2787 the current column, to avoid unnecessary parsing.
2789 HIGHLIGHT means just highlight the range.
2791 When CORNERS-ONLY is set, only return the corners of the range as
2792 a list (line1 column1 line2 column2) where line1 and line2 are line numbers
2793 in the buffer and column1 and column2 are table column numbers."
2800 beg end c1 c2 r1 r2 rangep tmp)
2817 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2824 ;; just one field
2831 ;; A range, return a vector
2832 ;; First sort the numbers to get a regular rectangle
2836 ;; Only return the corners of the range
2838 ;; Copy the range values into a list
2852 ;; return string representation of calc vector
2857 "Analyze descriptor DESC and retrieve the corresponding line number.
2858 The cursor is currently in line CLINE, the table begins in line BLINE,
2859 and TABLE is a vector with line types."
2867 ;; 1 2 3 4 5 6
2887 nil hn cline desc)))
2890 rel on cline desc)))
2894 "FIXME: Needs more documentation."
2907 nil))
2908 t)))
2912 desc cline)
2913 i)))
2918 s))
2921 "Convert list ELEMENTS to something appropriate to insert into formula.
2922 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2923 NUMBERS indicates that everything should be converted to numbers.
2924 LISPP non-nil means to return something appropriate for a Lisp
2925 list, 'literal is for the format specifier L."
2926 ;; Calc nan (not a number) is used for the conversion of the empty
2927 ;; field to a reference for several reasons: (i) It is accepted in a
2928 ;; Calc formula (e. g. "" or "()" would result in a Calc error).
2929 ;; (ii) In a single field (not in range) it can be distinguished
2930 ;; from "(nan)" which is the reference made from a single field
2931 ;; containing "nan".
2933 ;; field reference
2936 elements
2938 ""
2947 ;; range reference
2952 elements))))
2958 x
2966 x)
2968 elements
2971 ;;;###autoload
2973 "Set `org-table-formula-constants-local' in the current buffer."
2989 ;;;###autoload
2991 "Recalculate the current table line by applying all stored formulas.
2992 With prefix arg ALL, do this for all lines in the table.
2993 With the prefix argument ALL is `(16)' \
2995 it is the symbol `iterate', recompute the table until it no longer changes.
2996 If NOALIGN is not nil, do not re-align the table after the computations
2997 are done. This is typically used internally to save time, if it is
2998 known that the table will be realigned a little later anyway."
3013 seen-fields lhs1
3015 ;; Insert constants in all formulas
3031 eqlist))
3032 ;; Split the equation list
3038 ;; Expand ranges in lhs of formulas
3041 ;; Get the correct line range to process
3047 ;; This is a table with marked lines, compute selected lines
3049 ;; Move forward to the first non-header line
3060 ;; First find the named fields, and mark them untouchable.
3061 ;; Also check if several field/range formulas try to set the same field.
3080 name)))
3090 ;; Now evaluate the column formulas, but skip fields covered by
3091 ;; field formulas
3095 ;; Unprotected line, recalculate
3107 ;; Now evaluate the field formulas
3121 ;; back to initial position
3128 ;;;###autoload
3130 "Recalculate the table until it does not change anymore.
3131 The maximum number of iterations is 10, but you can choose a different value
3132 with the prefix ARG."
3137 thistbl)
3151 ;;;###autoload
3153 "Recalculate all tables in the current buffer."
3160 ;;;###autoload
3162 "Iterate all tables in the buffer, to converge inter-table dependencies."
3167 c1)
3183 "Apply the #+TBLFM in the line at point to the table."
3189 s e)
3191 ;; Insert a temporary formula at right after the table
3196 ;; Recalculate the table
3202 ;; delete the formula inserted temporarily
3206 "Find the beginning of the TBLFM lines and return its position.
3207 Return nil when the beginning of TBLFM line was not found."
3211 org-table-TBLFM-begin-regexp
3212 nil t))
3216 "Expand list of formulas.
3217 If some of the RHS in the formulas are ranges or a row reference, expand
3218 them to individual field equations for each field."
3224 ;; This just refers to one fixed field
3227 ;; This just refers to one fixed named field
3249 "Replace @<, @>, $<, $> with first/last row/column of the table.
3250 So @< and $< will always be replaced with @1 and $1, respectively.
3251 The advantage of these special markers are that structure editing of
3252 the table will not change them, while @1 and $1 will be modified
3253 when a line/row is swapped out of that privileged position. So for
3254 formulas that use a range of rows or columns, it may often be better
3256 borders of the table using the @< @> $< $> makers."
3259 s start)
3264 org-table-current-ncol)
3268 len
3275 s)
3278 "Replace $const with values in string F."
3280 ;; First, check for column names
3285 ;; Parameters and constants
3287 (while (setq start (string-match "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)" f start))
3297 f))
3300 "Find the value for a parameter or constant in a formula.
3301 Parameters get priority."
3332 map))
3339 "--"
3342 "--"
3343 "Shift Reference at Point"
3348 "-"
3349 "Change Test Row for Column Formulas"
3352 "--"
3357 org-table-overlay-coordinates)]
3358 "--"
3364 ;;;###autoload
3366 "Edit the formulas of the current table in a separate buffer."
3368 (when (save-excursion (beginning-of-line 1) (let ((case-fold-search t)) (looking-at "[ \t]*#\\+TBLFM")))
3382 entry s type title)
3385 ;; Keep global-font-lock-mode from turning on font-lock-mode
3426 "Convert a formula from internal to user representation."
3429 s))
3432 "Convert a formula from user to internal representation."
3435 s))
3438 "Convert spreadsheet references from A7 to @7$28.
3439 Works for single references, but also for entire formulas and even the
3440 full TBLFM line."
3442 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3445 ;; format match, just advance
3450 ;; 3.e5 or something like this.
3453 ;; (member (match-string 1 s)
3454 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3455 )
3456 ;; function name, just advance
3466 t t s)))))
3467 s))
3470 "Convert spreadsheet references from to @7$28 to AB7.
3471 Works for single references, but also for entire formulas and even the
3472 full TBLFM line."
3479 t t s)))
3484 t nil s)))
3485 s)
3488 "Convert a base 26 number represented by letters into an integer.
3489 For example: AB -> 28."
3495 n))
3498 "Convert an integer into a base 26 number represented by letters.
3499 For example: 28 -> AB."
3504 s))
3507 "Convert a time string into numerical duration in seconds.
3508 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3509 If S is a string representing a number, keep this number."
3511 s
3534 "Convert a number of seconds to a time string.
3535 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3536 minutes or seconds."
3551 "Convert all references in this buffer, using FUNCTION."
3561 "Convert all references in the buffer from B3 to @3$2 and back."
3571 "Shift the reference at point one row/hline up."
3575 "Shift the reference at point one row/hline down."
3579 "Shift the reference at point one field to the left."
3583 "Shift the reference at point one field to the right."
3594 ;; A B3-like reference
3600 ;; An internal reference
3606 "Re-match the group N, and replace it with the shifted reference."
3611 t t)))
3614 "Shift a reference part REF.
3615 If DECR is set, decrease the references row/column, else increase.
3616 If HLINE is set, this may be a hline reference, it certainly is not
3617 a translation reference."
3646 "Toggle the display of coordinates in the referenced table."
3655 "Parse the buffer for formula definitions and install them.
3656 With prefix ARG, apply the new formulas to the table."
3666 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3667 nil t)
3691 "Abort editing formulas, without installing the changes."
3702 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3743 "Show the location/value of the $ expression at point."
3752 var name e what match dest)
3757 "$1.."
3840 ;; column number
3868 org-table-fedit-scroll-down))))
3879 "Make sure the cursor is in a dataline in a table."
3888 p1 p2)))
3893 "Move cursor one line up in the window showing the table."
3898 "Move cursor one line down in the window showing the table."
3903 "Move the cursor in the window showing the table.
3904 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
3929 "Add a new overlay."
3935 "Highlight rectangular region in a table."
3939 l1 c1 l2 c2 tmp)
3963 "Remove the rectangle overlays."
3974 "Add overlays to the table at point, to show row/column coordinates."
4002 ;;;###autoload
4004 "Toggle the display of Row/Column numbers in tables."
4015 ;;;###autoload
4017 "Toggle the formula debugger in tables."
4023 ;;; The orgtbl minor mode
4025 ;; Define a minor mode which can be used in other modes in order to
4026 ;; integrate the org-mode table editor.
4028 ;; This is really a hack, because the org-mode table editor uses several
4029 ;; keys which normally belong to the major mode, for example the TAB and
4030 ;; RET keys. Here is how it works: The minor mode defines all the keys
4031 ;; necessary to operate the table editor, but wraps the commands into a
4032 ;; function which tests if the cursor is currently inside a table. If that
4033 ;; is the case, the table editor command is executed. However, when any of
4034 ;; those keys is used outside a table, the function uses `key-binding' to
4035 ;; look up if the key has an associated command in another currently active
4036 ;; keymap (minor modes, major mode, global), and executes that command.
4037 ;; There might be problems if any of the keys used by the table editor is
4038 ;; otherwise used as a prefix key.
4040 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
4041 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
4042 ;; addresses this by checking explicitly for both bindings.
4044 ;; The optimized version (see variable `orgtbl-optimized') takes over
4045 ;; all keys which are bound to `self-insert-command' in the *global map*.
4046 ;; Some modes bind other commands to simple characters, for example
4047 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
4048 ;; active, this binding is ignored inside tables and replaced with a
4049 ;; modified self-insert.
4067 ;; Install it as a minor mode.
4071 ;;;###autoload
4073 "The `org-mode' table editor as a minor mode for use in other modes."
4078 ;; Exit without error, in case some hook functions calls this
4079 ;; by accident in org-mode.
4083 ;; Make sure we are first in minor-mode-map-alist
4085 ;; FIXME: maybe it should use emulation-mode-map-alists?
4092 auto-fill-inhibit-regexp)
4096 auto-fill-inhibit-regexp)
4097 orgtbl-line-start-regexp))
4115 "Remove all properties related to narrow-column invisibility."
4128 "Create a function for binding in the table minor mode.
4129 FUN is the command to call inside a table. N is used to create a unique
4130 command name. KEYS are keys that should be checked in for a command
4131 to execute outside of tables."
4137 "Outside of tables, run the binding of `"
4149 keys)
4153 "Error when there is no default binding for a table key."
4158 "Setup orgtbl keymaps."
4189 elt key fun cmd)
4197 ;; Special treatment needed for TAB and RET
4217 [(tab)] "\C-i")))
4219 (org-defkey orgtbl-mode-map [backtab]
4221 [backtab] [S-iso-lefttab] [(shift tab)]
4222 [(tab)] "\C-i"))
4224 (org-defkey orgtbl-mode-map "\M-\C-m"
4225 (orgtbl-make-binding 'org-table-wrap-region 105
4226 "\M-\C-m" [(meta return)]))
4227 (org-defkey orgtbl-mode-map [(meta return)]
4228 (orgtbl-make-binding 'org-table-wrap-region 106
4229 [(meta return)] "\M-\C-m"))
4231 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4232 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4234 (when orgtbl-optimized
4235 ;; If the user wants maximum table support, we need to hijack
4236 ;; some standard editing functions
4237 (org-remap orgtbl-mode-map
4238 'self-insert-command 'orgtbl-self-insert-command
4239 'delete-char 'org-delete-char
4240 'delete-backward-char 'org-delete-backward-char)
4241 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4242 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4243 '("OrgTbl"
4244 ["Create or convert" org-table-create-or-convert-from-region
4245 :active (not (org-at-table-p)) :keys "C-c |" ]
4246 "--"
4247 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4248 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4249 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4250 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4251 "--"
4252 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4253 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4254 ["Copy Field from Above"
4255 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4256 "--"
4257 ("Column"
4258 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4259 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4260 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4261 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4262 ("Row"
4263 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4264 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4265 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4266 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4267 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4268 "--"
4269 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4270 ("Rectangle"
4271 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4272 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4273 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4274 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4275 "--"
4276 ("Radio tables"
4277 ["Insert table template" orgtbl-insert-radio-table
4278 (assq major-mode orgtbl-radio-table-templates)]
4279 ["Comment/uncomment table" orgtbl-toggle-comment t])
4280 "--"
4281 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4282 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4283 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4284 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4285 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4286 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4287 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4288 ["Sum Column/Rectangle" org-table-sum
4289 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4290 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4291 ["Debug Formulas"
4292 org-table-toggle-formula-debugger :active (org-at-table-p)
4293 :keys "C-c {"
4294 :style toggle :selected org-table-formula-debug]
4295 ["Show Col/Row Numbers"
4296 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4297 :keys "C-c }"
4298 :style toggle :selected org-table-overlay-coordinates]
4299 ))
4300 t))
4302 (defun orgtbl-ctrl-c-ctrl-c (arg)
4303 "If the cursor is inside a table, realign the table.
4304 If it is a table to be sent away to a receiver, do it.
4305 With prefix arg, also recompute table."
4306 (interactive "P")
4307 (let ((case-fold-search t) (pos (point)) action)
4308 (save-excursion
4309 (beginning-of-line 1)
4310 (setq action (cond
4314 (cond
4315 ((integerp action)
4316 (goto-char action)
4317 (org-table-maybe-eval-formula)
4318 (if arg
4319 (call-interactively 'org-table-recalculate)
4320 (org-table-maybe-recalculate-line))
4321 (call-interactively 'org-table-align)
4322 (when (orgtbl-send-table 'maybe)
4323 (run-hooks 'orgtbl-after-send-table-hook)))
4324 ((eq action 'recalc)
4325 (org-table-set-constants)
4326 (save-excursion
4327 (beginning-of-line 1)
4329 (if (org-at-table-p)
4330 (org-call-with-arg 'org-table-recalculate t))))
4331 (t (let (orgtbl-mode)
4332 (call-interactively (key-binding "\C-c\C-c")))))))
4334 (defun orgtbl-create-or-convert-from-region (arg)
4335 "Create table or convert region to table, if no conflicting binding.
4336 This installs the table binding `C-c |', but only if there is no
4337 conflicting binding to this key outside orgtbl-mode."
4338 (interactive "P")
4339 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4340 (if cmd
4341 (call-interactively cmd)
4342 (call-interactively 'org-table-create-or-convert-from-region))))
4344 (defun orgtbl-tab (arg)
4345 "Justification and field motion for `orgtbl-mode'."
4346 (interactive "P")
4347 (if arg (org-table-edit-field t)
4348 (org-table-justify-field-maybe)
4349 (org-table-next-field)))
4351 (defun orgtbl-ret ()
4352 "Justification and field motion for `orgtbl-mode'."
4353 (interactive)
4354 (if (bobp)
4355 (newline)
4356 (org-table-justify-field-maybe)
4357 (org-table-next-row)))
4359 (defun orgtbl-self-insert-command (N)
4360 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4361 If the cursor is in a table looking at whitespace, the whitespace is
4362 overwritten, and the table is not marked as requiring realignment."
4363 (interactive "p")
4364 (if (and (org-at-table-p)
4365 (or
4366 (and org-table-auto-blank-field
4367 (member last-command
4368 '(orgtbl-hijacker-command-100
4369 orgtbl-hijacker-command-101
4370 orgtbl-hijacker-command-102
4371 orgtbl-hijacker-command-103
4372 orgtbl-hijacker-command-104
4373 orgtbl-hijacker-command-105
4374 yas/expand))
4375 (org-table-blank-field))
4376 t)
4377 (eq N 1)
4379 (let (org-table-may-need-update)
4380 (goto-char (1- (match-end 0)))
4381 (org-delete-backward-char 1)
4382 (goto-char (match-beginning 0))
4383 (self-insert-command N))
4384 (setq org-table-may-need-update t)
4385 (let* (orgtbl-mode
4386 a
4387 (cmd (or (key-binding
4388 (or (and (listp function-key-map)
4389 (setq a (assoc last-input-event function-key-map))
4390 (cdr a))
4391 (vector last-input-event)))
4392 'self-insert-command)))
4393 (call-interactively cmd)
4394 (if (and org-self-insert-cluster-for-undo
4395 (eq cmd 'self-insert-command))
4396 (if (not (eq last-command 'orgtbl-self-insert-command))
4397 (setq org-self-insert-command-undo-counter 1)
4398 (if (>= org-self-insert-command-undo-counter 20)
4399 (setq org-self-insert-command-undo-counter 1)
4400 (and (> org-self-insert-command-undo-counter 0)
4401 buffer-undo-list
4402 (not (cadr buffer-undo-list)) ; remove nil entry
4403 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4404 (setq org-self-insert-command-undo-counter
4405 (1+ org-self-insert-command-undo-counter))))))))
4408 "Regular expression matching exponentials as produced by calc.")
4410 (defun orgtbl-export (table target)
4411 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
4413 org-table-last-alignment org-table-last-column-widths
4414 maxcol column)
4415 (if (not (fboundp func))
4416 (user-error "Cannot export orgtbl table to %s" target))
4417 (setq lines (org-table-clean-before-export lines))
4418 (setq table
4419 (mapcar
4420 (lambda (x)
4421 (if (string-match org-table-hline-regexp x)
4422 'hline
4424 lines))
4425 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
4426 table)))
4427 (loop for i from (1- maxcol) downto 0 do
4428 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
4429 (setq column (delq nil column))
4430 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
4431 (push (> (/ (apply '+ (mapcar (lambda (x) (if (string-match org-table-number-regexp x) 1 0)) column)) maxcol) org-table-number-fraction) org-table-last-alignment))
4432 (funcall func table nil)))
4434 (defun orgtbl-gather-send-defs ()
4435 "Gather a plist of :name, :transform, :params for each destination before
4436 a radio table."
4437 (save-excursion
4438 (goto-char (org-table-begin))
4439 (let (rtn)
4440 (beginning-of-line 0)
4441 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4442 (let ((name (org-no-properties (match-string 1)))
4443 (transform (intern (match-string 2)))
4444 (params (if (match-end 3)
4445 (read (concat "(" (match-string 3) ")")))))
4446 (push (list :name name :transform transform :params params)
4447 rtn)
4448 (beginning-of-line 0)))
4449 rtn)))
4451 (defun orgtbl-send-replace-tbl (name txt)
4452 "Find and replace table NAME with TXT."
4453 (save-excursion
4454 (goto-char (point-min))
4455 (unless (re-search-forward
4457 (user-error "Don't know where to insert translated table"))
4458 (goto-char (match-beginning 0))
4459 (beginning-of-line 2)
4460 (save-excursion
4461 (let ((beg (point)))
4462 (unless (re-search-forward
4463 (concat "END RECEIVE ORGTBL +" name) nil t)
4464 (user-error "Cannot find end of insertion region"))
4465 (beginning-of-line 1)
4466 (delete-region beg (point))))
4469 ;;;###autoload
4470 (defun org-table-to-lisp (&optional txt)
4471 "Convert the table at point to a Lisp structure.
4472 The structure will be a list. Each item is either the symbol `hline'
4473 for a horizontal separator line, or a list of field values as strings.
4474 The table is taken from the parameter TXT, or from the buffer at point."
4475 (unless txt
4476 (unless (org-at-table-p)
4477 (user-error "No table at point")))
4478 (let* ((txt (or txt
4479 (buffer-substring-no-properties (org-table-begin)
4480 (org-table-end))))
4483 (mapcar
4484 (lambda (x)
4485 (if (string-match org-table-hline-regexp x)
4486 'hline
4488 lines)))
4490 (defun orgtbl-send-table (&optional maybe)
4491 "Send a transformed version of this table to the receiver position.
4492 With argument MAYBE, fail quietly if no transformation is defined for
4493 this table."
4494 (interactive)
4495 (catch 'exit
4496 (unless (org-at-table-p) (user-error "Not at a table"))
4497 ;; when non-interactive, we assume align has just happened.
4498 (when (org-called-interactively-p 'any) (org-table-align))
4499 (let ((dests (orgtbl-gather-send-defs))
4500 (txt (buffer-substring-no-properties (org-table-begin)
4501 (org-table-end)))
4502 (ntbl 0))
4503 (unless dests (if maybe (throw 'exit nil)
4504 (user-error "Don't know how to transform this table")))
4505 (dolist (dest dests)
4506 (let* ((name (plist-get dest :name))
4507 (transform (plist-get dest :transform))
4508 (params (plist-get dest :params))
4509 (skip (plist-get params :skip))
4510 (skipcols (plist-get params :skipcols))
4511 (no-escape (plist-get params :no-escape))
4512 beg
4513 (lines (org-table-clean-before-export
4514 (nthcdr (or skip 0)
4516 (i0 (if org-table-clean-did-remove-column 2 1))
4517 (lines (if no-escape lines
4518 (mapcar (lambda(l) (replace-regexp-in-string
4520 (table (mapcar
4521 (lambda (x)
4522 (if (string-match org-table-hline-regexp x)
4523 'hline
4524 (org-remove-by-index
4526 skipcols i0)))
4527 lines))
4528 (fun (if (= i0 2) 'cdr 'identity))
4529 (org-table-last-alignment
4530 (org-remove-by-index (funcall fun org-table-last-alignment)
4531 skipcols i0))
4532 (org-table-last-column-widths
4533 (org-remove-by-index (funcall fun org-table-last-column-widths)
4534 skipcols i0))
4535 (txt (if (fboundp transform)
4536 (funcall transform table params)
4537 (user-error "No such transformation function %s" transform))))
4538 (orgtbl-send-replace-tbl name txt))
4539 (setq ntbl (1+ ntbl)))
4540 (message "Table converted and installed at %d receiver location%s"
4541 ntbl (if (> ntbl 1) "s" ""))
4542 (if (> ntbl 0)
4543 ntbl
4544 nil))))
4546 (defun org-remove-by-index (list indices &optional i0)
4547 "Remove the elements in LIST with indices in INDICES.
4548 First element has index 0, or I0 if given."
4549 (if (not indices)
4550 list
4551 (if (integerp indices) (setq indices (list indices)))
4552 (setq i0 (1- (or i0 0)))
4553 (delq :rm (mapcar (lambda (x)
4554 (setq i0 (1+ i0))
4555 (if (memq i0 indices) :rm x))
4556 list))))
4558 (defun orgtbl-toggle-comment ()
4559 "Comment or uncomment the orgtbl at point."
4560 (interactive)
4561 (let* ((case-fold-search t)
4562 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4563 (re2 (concat "^" orgtbl-line-start-regexp))
4564 (commented (save-excursion (beginning-of-line 1)
4565 (cond ((looking-at re1) t)
4566 ((looking-at re2) nil)
4567 (t (user-error "Not at an org table")))))
4568 (re (if commented re1 re2))
4569 beg end)
4570 (save-excursion
4571 (beginning-of-line 1)
4572 (while (looking-at re) (beginning-of-line 0))
4573 (beginning-of-line 2)
4574 (setq beg (point))
4575 (while (looking-at re) (beginning-of-line 2))
4576 (setq end (point)))
4577 (comment-region beg end (if commented '(4) nil))))
4579 (defun orgtbl-insert-radio-table ()
4580 "Insert a radio table template appropriate for this major mode."
4581 (interactive)
4582 (let* ((e (assq major-mode orgtbl-radio-table-templates))
4583 (txt (nth 1 e))
4584 name pos)
4585 (unless e (user-error "No radio table setup defined for %s" major-mode))
4586 (setq name (read-string "Table name: "))
4587 (while (string-match "%n" txt)
4588 (setq txt (replace-match name t t txt)))
4590 (setq pos (point))
4591 (insert txt)
4592 (goto-char pos)))
4594 ;; Dynamically bound input and output for table formatting.
4595 (defvar *orgtbl-table* nil
4596 "Carries the current table through formatting routines.")
4597 (defvar *orgtbl-rtn* nil
4598 "Formatting routines push the output lines here.")
4599 ;; Formatting parameters for the current table section.
4600 (defvar *orgtbl-hline* nil "Text used for horizontal lines.")
4601 (defvar *orgtbl-sep* nil "Text used as a column separator.")
4602 (defvar *orgtbl-default-fmt* nil "Default format for each entry.")
4603 (defvar *orgtbl-fmt* nil "Format for each entry.")
4604 (defvar *orgtbl-efmt* nil "Format for numbers.")
4605 (defvar *orgtbl-lfmt* nil "Format for an entire line, overrides fmt.")
4606 (defvar *orgtbl-llfmt* nil "Specializes lfmt for the last row.")
4607 (defvar *orgtbl-lstart* nil "Text starting a row.")
4608 (defvar *orgtbl-llstart* nil "Specializes lstart for the last row.")
4609 (defvar *orgtbl-lend* nil "Text ending a row.")
4610 (defvar *orgtbl-llend* nil "Specializes lend for the last row.")
4612 (defsubst orgtbl-get-fmt (fmt i)
4613 "Retrieve the format from FMT corresponding to the Ith column."
4614 (if (and (not (functionp fmt)) (consp fmt))
4615 (plist-get fmt i)
4616 fmt))
4618 (defsubst orgtbl-apply-fmt (fmt &rest args)
4619 "Apply format FMT to arguments ARGS.
4620 When FMT is nil, return the first argument from ARGS."
4621 (cond ((functionp fmt) (apply fmt args))
4622 (fmt (apply 'format fmt args))
4623 (args (car args))
4624 (t args)))
4626 (defsubst orgtbl-eval-str (str)
4627 "If STR is a function, evaluate it with no arguments."
4628 (if (functionp str)
4629 (funcall str)
4630 str))
4632 (defun orgtbl-format-line (line)
4633 "Format LINE as a table row."
4634 (if (eq line 'hline) (if *orgtbl-hline* (push *orgtbl-hline* *orgtbl-rtn*))
4635 (let* ((i 0)
4636 (line
4637 (mapcar
4638 (lambda (f)
4639 (setq i (1+ i))
4640 (let* ((efmt (orgtbl-get-fmt *orgtbl-efmt* i))
4641 (f (if (and efmt (string-match orgtbl-exp-regexp f))
4642 (orgtbl-apply-fmt efmt (match-string 1 f)
4643 (match-string 2 f))
4644 f)))
4645 (orgtbl-apply-fmt (or (orgtbl-get-fmt *orgtbl-fmt* i)
4646 *orgtbl-default-fmt*)
4647 f)))
4648 line)))
4649 (push (if *orgtbl-lfmt*
4650 (apply #'orgtbl-apply-fmt *orgtbl-lfmt* line)
4651 (concat (orgtbl-eval-str *orgtbl-lstart*)
4652 (mapconcat 'identity line *orgtbl-sep*)
4653 (orgtbl-eval-str *orgtbl-lend*)))
4654 *orgtbl-rtn*))))
4656 (defun orgtbl-format-section (section-stopper)
4657 "Format lines until the first occurrence of SECTION-STOPPER."
4658 (let (prevline)
4659 (progn
4660 (while (not (eq (car *orgtbl-table*) section-stopper))
4661 (if prevline (orgtbl-format-line prevline))
4662 (setq prevline (pop *orgtbl-table*)))
4663 (if prevline (let ((*orgtbl-lstart* *orgtbl-llstart*)
4664 (*orgtbl-lend* *orgtbl-llend*)
4665 (*orgtbl-lfmt* *orgtbl-llfmt*))
4666 (orgtbl-format-line prevline))))))
4668 ;;;###autoload
4669 (defun orgtbl-to-generic (table params &optional backend)
4670 "Convert the orgtbl-mode TABLE to some other format.
4671 This generic routine can be used for many standard cases.
4672 TABLE is a list, each entry either the symbol `hline' for a horizontal
4673 separator line, or a list of fields for that line.
4674 PARAMS is a property list of parameters that can influence the conversion.
4675 A third optional argument BACKEND can be used to convert the content of
4676 the cells using a specific export back-end.
4678 For the generic converter, some parameters are obligatory: you need to
4679 specify either :lfmt, or all of (:lstart :lend :sep).
4681 Valid parameters are:
4683 :splice When set to t, return only table body lines, don't wrap
4684 them into :tstart and :tend. Default is nil. When :splice
4685 is non-nil, this also means that the exporter should not look
4686 for and interpret header and footer sections.
4688 :hline String to be inserted on horizontal separation lines.
4689 May be nil to ignore hlines.
4691 :sep Separator between two fields
4692 :remove-nil-lines Do not include lines that evaluate to nil.
4694 Each in the following group may be either a string or a function
4695 of no arguments returning a string:
4697 :tstart String to start the table. Ignored when :splice is t.
4698 :tend String to end the table. Ignored when :splice is t.
4699 :lstart String to start a new table line.
4700 :llstart String to start the last table line, defaults to :lstart.
4701 :lend String to end a table line
4702 :llend String to end the last table line, defaults to :lend.
4704 Each in the following group may be a string, a function of one
4705 argument (the field or line) returning a string, or a plist
4706 mapping columns to either of the above:
4708 :lfmt Format for entire line, with enough %s to capture all fields.
4709 If this is present, :lstart, :lend, and :sep are ignored.
4710 :llfmt Format for the entire last line, defaults to :lfmt.
4711 :fmt A format to be used to wrap the field, should contain
4712 %s for the original field value. For example, to wrap
4714 This may also be a property list with column numbers and
4716 :hlstart :hllstart :hlend :hllend :hlsep :hlfmt :hllfmt :hfmt
4717 Same as above, specific for the header lines in the table.
4718 All lines before the first hline are treated as header.
4719 If any of these is not present, the data line value is used.
4721 This may be either a string or a function of two arguments:
4723 :efmt Use this format to print numbers with exponentials.
4724 The format should have %s twice for inserting mantissa
4726 may also be a property list with column numbers and
4727 formats. :fmt will still be applied after :efmt.
4729 In addition to this, the parameters :skip and :skipcols are always handled
4730 directly by `orgtbl-send-table'. See manual."
4731 (let* ((splicep (plist-get params :splice))
4732 (hline (plist-get params :hline))
4733 (skipheadrule (plist-get params :skipheadrule))
4734 (remove-nil-linesp (plist-get params :remove-nil-lines))
4735 (remove-newlines (plist-get params :remove-newlines))
4736 (*orgtbl-hline* hline)
4737 (*orgtbl-table* table)
4738 (*orgtbl-sep* (plist-get params :sep))
4739 (*orgtbl-efmt* (plist-get params :efmt))
4740 (*orgtbl-lstart* (plist-get params :lstart))
4741 (*orgtbl-llstart* (or (plist-get params :llstart) *orgtbl-lstart*))
4742 (*orgtbl-lend* (plist-get params :lend))
4743 (*orgtbl-llend* (or (plist-get params :llend) *orgtbl-lend*))
4744 (*orgtbl-lfmt* (plist-get params :lfmt))
4745 (*orgtbl-llfmt* (or (plist-get params :llfmt) *orgtbl-lfmt*))
4746 (*orgtbl-fmt* (plist-get params :fmt))
4747 *orgtbl-rtn*)
4748 ;; Convert cells content to backend BACKEND
4749 (when backend
4750 (setq *orgtbl-table*
4751 (mapcar
4752 (lambda(r)
4753 (if (listp r)
4754 (mapcar
4755 (lambda (c)
4756 (org-trim (org-export-string-as c backend t '(:with-tables t))))
4757 r)
4758 r))
4759 *orgtbl-table*)))
4760 ;; Put header
4761 (unless splicep
4762 (when (plist-member params :tstart)
4763 (let ((tstart (orgtbl-eval-str (plist-get params :tstart))))
4764 (if tstart (push tstart *orgtbl-rtn*)))))
4765 ;; If we have a heading, format it and handle the trailing hline.
4766 (if (and (not splicep)
4767 (or (consp (car *orgtbl-table*))
4768 (consp (nth 1 *orgtbl-table*)))
4769 (memq 'hline (cdr *orgtbl-table*)))
4770 (progn
4771 (when (eq 'hline (car *orgtbl-table*))
4772 ;; There is a hline before the first data line
4773 (and hline (push hline *orgtbl-rtn*))
4774 (pop *orgtbl-table*))
4775 (let* ((*orgtbl-lstart* (or (plist-get params :hlstart)
4776 *orgtbl-lstart*))
4777 (*orgtbl-llstart* (or (plist-get params :hllstart)
4778 *orgtbl-llstart*))
4779 (*orgtbl-lend* (or (plist-get params :hlend) *orgtbl-lend*))
4780 (*orgtbl-llend* (or (plist-get params :hllend)
4781 (plist-get params :hlend) *orgtbl-llend*))
4782 (*orgtbl-lfmt* (or (plist-get params :hlfmt) *orgtbl-lfmt*))
4783 (*orgtbl-llfmt* (or (plist-get params :hllfmt)
4784 (plist-get params :hlfmt) *orgtbl-llfmt*))
4785 (*orgtbl-sep* (or (plist-get params :hlsep) *orgtbl-sep*))
4786 (*orgtbl-fmt* (or (plist-get params :hfmt) *orgtbl-fmt*)))
4787 (orgtbl-format-section 'hline))
4788 (if (and hline (not skipheadrule)) (push hline *orgtbl-rtn*))
4789 (pop *orgtbl-table*)))
4790 ;; Now format the main section.
4791 (orgtbl-format-section nil)
4792 (unless splicep
4793 (when (plist-member params :tend)
4794 (let ((tend (orgtbl-eval-str (plist-get params :tend))))
4795 (if tend (push tend *orgtbl-rtn*)))))
4796 (mapconcat (if remove-newlines
4797 (lambda (tend)
4799 'identity)
4800 (nreverse (if remove-nil-linesp
4801 (remq nil *orgtbl-rtn*)
4804 ;;;###autoload
4805 (defun orgtbl-to-tsv (table params)
4806 "Convert the orgtbl-mode table to TAB separated material."
4808 ;;;###autoload
4809 (defun orgtbl-to-csv (table params)
4810 "Convert the orgtbl-mode table to CSV material.
4811 This does take care of the proper quoting of fields with comma or quotes."
4812 (orgtbl-to-generic table (org-combine-plists
4813 '(:sep "," :fmt org-quote-csv-field)
4814 params)))
4816 ;;;###autoload
4817 (defun orgtbl-to-latex (table params)
4818 "Convert the orgtbl-mode TABLE to LaTeX.
4819 TABLE is a list, each entry either the symbol `hline' for a horizontal
4820 separator line, or a list of fields for that line.
4821 PARAMS is a property list of parameters that can influence the conversion.
4822 Supports all parameters from `orgtbl-to-generic'. Most important for
4823 LaTeX are:
4825 :splice When set to t, return only table body lines, don't wrap
4826 them into a tabular environment. Default is nil.
4828 :fmt A format to be used to wrap the field, should contain %s for the
4829 original field value. For example, to wrap everything in dollars,
4832 The format may also be a function that formats its one argument.
4834 :efmt Format for transforming numbers with exponentials. The format
4835 should have %s twice for inserting mantissa and exponent, for
4837 This may also be a property list with column numbers and formats.
4838 The format may also be a function that formats its two arguments.
4840 :llend If you find too much space below the last line of a table,
4843 The general parameters :skip and :skipcols have already been applied when
4844 this function is called."
4845 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
4846 org-table-last-alignment ""))
4847 (params2
4848 (list
4853 (require 'ox-latex)
4854 (orgtbl-to-generic table (org-combine-plists params2 params) 'latex)))
4856 ;;;###autoload
4857 (defun orgtbl-to-html (table params)
4858 "Convert the orgtbl-mode TABLE to HTML.
4859 TABLE is a list, each entry either the symbol `hline' for a horizontal
4860 separator line, or a list of fields for that line.
4861 PARAMS is a property list of parameters that can influence the conversion.
4862 Currently this function recognizes the following parameters:
4864 :splice When set to t, return only table body lines, don't wrap
4865 them into a <table> environment. Default is nil.
4867 The general parameters :skip and :skipcols have already been applied when
4868 this function is called. The function does *not* use `orgtbl-to-generic',
4869 so you cannot specify parameters for it."
4870 (require 'ox-html)
4871 (let ((output (org-export-string-as
4872 (orgtbl-to-orgtbl table nil) 'html t '(:with-tables t))))
4873 (if (not (plist-get params :splice)) output
4874 (org-trim
4875 (replace-regexp-in-string
4879 ;;;###autoload
4880 (defun orgtbl-to-texinfo (table params)
4881 "Convert the orgtbl-mode TABLE to TeXInfo.
4882 TABLE is a list, each entry either the symbol `hline' for a horizontal
4883 separator line, or a list of fields for that line.
4884 PARAMS is a property list of parameters that can influence the conversion.
4885 Supports all parameters from `orgtbl-to-generic'. Most important for
4886 TeXInfo are:
4888 :splice nil/t When set to t, return only table body lines, don't wrap
4889 them into a multitable environment. Default is nil.
4891 :fmt fmt A format to be used to wrap the field, should contain
4892 %s for the original field value. For example, to wrap
4894 This may also be a property list with column numbers and
4896 Each format also may be a function that formats its one
4897 argument.
4900 are computed automatically from the width of the columns
4901 under org-mode.
4903 The general parameters :skip and :skipcols have already been applied when
4904 this function is called."
4905 (let* ((total (float (apply '+ org-table-last-column-widths)))
4906 (colfrac (or (plist-get params :cf)
4907 (mapconcat
4908 (lambda (x) (format "%.3f" (/ (float x) total)))
4909 org-table-last-column-widths " ")))
4910 (params2
4911 (list
4912 :tstart (concat "@multitable @columnfractions " colfrac)
4913 :tend "@end multitable"
4914 :lstart "@item " :lend "" :sep " @tab "
4915 :hlstart "@headitem ")))
4916 (require 'ox-texinfo)
4917 (orgtbl-to-generic table (org-combine-plists params2 params) 'texinfo)))
4919 ;;;###autoload
4920 (defun orgtbl-to-orgtbl (table params)
4921 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
4922 Useful when slicing one table into many. The :hline, :sep,
4923 :lstart, and :lend provide orgtbl framing. The default nil :tstart
4924 and :tend suppress strings without splicing; they can be set to
4925 provide ORGTBL directives for the generated table."
4926 (let* ((params2
4927 (list
4928 :remove-newlines t
4929 :tstart nil :tend nil
4930 :hline "|---"
4931 :sep " | "
4932 :lstart "| "
4933 :lend " |"))
4934 (params (org-combine-plists params2 params)))
4935 (with-temp-buffer
4936 (insert (orgtbl-to-generic table params))
4937 (goto-char (point-min))
4938 (while (re-search-forward org-table-hline-regexp nil t)
4939 (org-table-align))
4940 (buffer-substring 1 (buffer-size)))))
4942 (defun orgtbl-to-table.el (table params)
4943 "Convert the orgtbl-mode TABLE into a table.el table."
4944 (with-temp-buffer
4945 (insert (orgtbl-to-orgtbl table params))
4946 (org-table-align)
4947 (replace-regexp-in-string
4948 "-|" "-+"
4949 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
4951 (defun orgtbl-to-unicode (table params)
4952 "Convert the orgtbl-mode TABLE into a table with unicode characters.
4953 You need the ascii-art-to-unicode.el package for this. You can download
4954 it here: http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el."
4955 (with-temp-buffer
4956 (insert (orgtbl-to-table.el table params))
4957 (goto-char (point-min))
4958 (if (or (featurep 'ascii-art-to-unicode)
4959 (require 'ascii-art-to-unicode nil t))
4960 (aa2u)
4961 (unless (delq nil (mapcar (lambda (l) (string-match "aa2u" (car l))) org-stored-links))
4962 (push '("http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el"
4963 "Link to ascii-art-to-unicode.el") org-stored-links))
4964 (user-error "Please download ascii-art-to-unicode.el (use C-c C-l to insert the link to it)"))
4965 (buffer-string)))
4967 (defun org-table-get-remote-range (name-or-id form)
4968 "Get a field value or a list of values in a range from table at ID.
4970 NAME-OR-ID may be the name of a table in the current file as set
4972 will then be used. Alternatively, it may be an ID referring to
4973 any entry, also in a different file. In this case, the first
4974 table in that entry will be referenced.
4978 The return value is either a single string for a single field, or a
4979 list of the fields in the rectangle."
4980 (save-match-data
4981 (let ((case-fold-search t) (id-loc nil)
4982 ;; Protect a bunch of variables from being overwritten
4983 ;; by the context of the remote table
4984 org-table-column-names org-table-column-name-regexp
4985 org-table-local-parameters org-table-named-field-locations
4986 org-table-current-line-types org-table-current-begin-line
4987 org-table-current-begin-pos org-table-dlines
4988 org-table-current-ncol
4989 org-table-hlines org-table-last-alignment
4990 org-table-last-column-widths org-table-last-alignment
4991 org-table-last-column-widths tbeg
4992 buffer loc)
4993 (setq form (org-table-convert-refs-to-rc form))
4994 (save-excursion
4995 (save-restriction
4996 (widen)
4997 (save-excursion
4998 (goto-char (point-min))
4999 (if (re-search-forward
5002 nil t)
5003 (setq buffer (current-buffer) loc (match-beginning 0))
5004 (setq id-loc (org-id-find name-or-id 'marker))
5005 (unless (and id-loc (markerp id-loc))
5007 (setq buffer (marker-buffer id-loc)
5008 loc (marker-position id-loc))
5009 (move-marker id-loc nil)))
5010 (with-current-buffer buffer
5011 (save-excursion
5012 (save-restriction
5013 (widen)
5014 (goto-char loc)
5015 (forward-char 1)
5017 (not (match-beginning 1)))
5018 (user-error "Cannot find a table at NAME or ID %s" name-or-id))
5019 (setq tbeg (point-at-bol))
5020 (org-table-get-specials)
5021 (setq form (org-table-formula-substitute-names
5022 (org-table-formula-handle-first/last-rc form)))
5023 (if (and (string-match org-table-range-regexp form)
5024 (> (length (match-string 0 form)) 1))
5025 (save-match-data
5026 (org-table-get-range (match-string 0 form) tbeg 1))
5027 form)))))))))
5029 (defmacro org-define-lookup-function (mode)
5030 (let ((mode-str (symbol-name mode))
5031 (first-p (equal mode 'first))
5032 (all-p (equal mode 'all)))
5033 (let ((plural-str (if all-p "s" "")))
5034 `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
5035 ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
5036 If R-LIST is nil, return matching element%s of S-LIST.
5037 If PREDICATE is not nil, use it instead of `equal' to match VAL.
5038 Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
5039 This function is generated by a call to the macro `org-define-lookup-function'."
5040 mode-str plural-str plural-str plural-str)
5041 (let ,(let ((lvars '((p (or predicate 'equal))
5042 (sl s-list)
5043 (rl (or r-list s-list))
5044 (ret nil))))
5045 (if first-p (add-to-list 'lvars '(match-p nil)))
5046 lvars)
5047 (while ,(if first-p '(and (not match-p) sl) 'sl)
5048 (progn
5049 (if (funcall p val (car sl))
5050 (progn
5051 ,(if first-p '(setq match-p t))
5052 (let ((rval (car rl)))
5053 (setq ret ,(if all-p '(append ret (list rval)) 'rval)))))
5054 (setq sl (cdr sl) rl (cdr rl))))
5055 ret)))))
5057 (org-define-lookup-function first)
5058 (org-define-lookup-function last)
5059 (org-define-lookup-function all)
5061 (provide 'org-table)
5063 ;; Local variables:
5064 ;; generated-autoload-file: "org-loaddefs.el"
5065 ;; End:
5067 ;;; org-table.el ends here