| blob | 22a32223f357e7e21356b172e6b6e7f277d40a6f |
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
56 "Non-nil means use the optimized table editor version for `orgtbl-mode'.
57 In the optimized version, the table editor takes over all simple keys that
58 normally just insert a character. In tables, the characters are inserted
59 in a way to minimize disturbing the table structure (i.e. in overwrite mode
60 for empty fields). Outside tables, the correct binding of the keys is
61 restored.
63 The default for this option is t if the optimized version is also used in
64 Org-mode. See the variable `org-enable-table-editor' for details. Changing
65 this variable requires a restart of Emacs to become effective."
71 % END RECEIVE ORGTBL %n
73 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
74 | | |
77 @c END RECEIVE ORGTBL %n
78 @ignore
79 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
80 | | |
83 <!-- END RECEIVE ORGTBL %n -->
84 <!--
85 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
86 | | |
89 #+ END RECEIVE ORGTBL %n
91 #+ORGTBL: SEND %n orgtbl-to-orgtbl :splice nil :skip 0
92 | | |
94 "Templates for radio tables in different major modes.
95 All occurrences of %n in a template will be replaced with the name of the
96 table, obtained by prompting the user."
103 "Settings for tables in Org-mode."
108 "The default size for newly created tables, Columns x Rows."
113 "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%:]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$"
114 "Regular expression for recognizing numbers in table columns.
115 If a table column contains mostly numbers, it will be aligned to the
116 right. If not, it will be aligned to the left.
118 The default value of this option is a regular expression which allows
119 anything which looks remotely like a number as used in scientific
120 context. For example, all of the following will be considered a
121 number:
122 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
124 Other options offered by the customize interface are more restrictive."
138 "^\\([<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
139 (const :tag "Very General Number-Like, including hex and Calc radix, allows comma as decimal mark"
140 "^\\([<>]?[-+^.,0-9]*[0-9][-+^.0-9eEdDx()%]*\\|[<>]?[-+]?0[xX][0-9a-fA-F.]+\\|[<>]?[-+]?[0-9]+#[0-9a-zA-Z.]+\\|nan\\|[-+u]?inf\\)$")
144 "Fraction of numbers in a column required to make the column align right.
145 In a column all non-white fields are considered. If at least
146 this fraction of fields is matched by `org-table-number-regexp',
147 alignment to the right border applies."
152 "Behavior of tables during editing in Org-mode."
157 "Non-nil means automatically re-align table when pressing TAB or RETURN.
159 removal/insertion."
164 "Non-nil means automatically blank table field when starting to type into it.
165 This only happens when typing immediately after a field motion
166 command (TAB, S-TAB or RET).
167 Only relevant when `org-enable-table-editor' is equal to `optimized'."
172 "Non-nil means automatically exit the follow mode.
173 When nil, the follow mode will stay on and be active in any table
174 the cursor enters. Since the table follow filed mode messes with the
175 window configuration, it is not recommended to set this variable to nil,
176 except maybe locally in a special file that has mostly tables with long
177 fields."
183 "Whether the user should confirm when Org fixes formulas."
191 'safe-local-variable
195 "Non-nil means tab in the last column of a table with jump over a hline.
196 If a horizontal separator line is following the current line,
197 `org-table-next-field' can either create a new row before that line, or jump
198 over the line. When this option is nil, a new line will be created before
199 this line."
204 "Options concerning tables in Org-mode."
209 "Should org-mode work with table references like B3 instead of @3$2?
210 Possible values are:
211 nil never use them
212 from accept as input, do not present for editing
213 t accept as input and present for editing"
228 calc-angle-mode deg
229 calc-prefer-frac nil
230 calc-symbolic-mode nil
232 calc-display-working-message t
233 )
234 "List with Calc mode settings for use in `calc-eval' for table formulas.
235 The list must contain alternating symbols (Calc modes variables and values).
236 Don't remove any of the default settings, just change the values. Org-mode
237 relies on the variables to be present in the list."
242 "Format for the output of calc computations like $1+$2;t.
243 The default value is 'hours, and will output the results as a
244 number of hours. Other allowed values are 'seconds, 'minutes and
245 'days, and the output will be a fraction of seconds, minutes or
246 days."
255 "Format for fields which contain the result of a formula.
257 characters. Beware that modifying the display can prevent the
258 field from being used in another formula."
264 "Non-nil means TAB and RET evaluate a formula in current table field.
265 If the current field starts with an equal sign, it is assumed to be a formula
266 which should be evaluated as described in the manual and in the documentation
267 string of the command `org-table-eval-formula'. This feature requires the
268 Emacs calc package.
269 When this variable is nil, formula calculation is only available through
275 "Non-nil means interpret constants in formulas in tables.
276 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
277 by the value given in `org-table-formula-constants', or by a value obtained
278 from the `constants.el' package."
283 "Alist with constant names and values, for use in table formulas.
284 The car of each element is a name of a constant, without the `$' before it.
285 The cdr is the value as a string. For example, if you'd like to use the
286 speed of light in a formula, you would configure
290 and then use it in an equation like `$1*$c'.
292 Constants can also be defined on a per-file basis using a line like
294 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
301 "Non-nil means lines marked with |#| or |*| will be recomputed automatically.
302 Automatically means when TAB or RET or C-c C-c are pressed in the line."
307 "OBSOLETE VARIABLE, please see `org-table-relative-ref-may-cross-hline'."
312 "Non-nil means relative formula references may cross hlines.
313 Here are the allowed values:
315 nil Relative references may not cross hlines. They will reference the
316 field next to the hline instead. Coming from below, the reference
317 will be to the field below the hline. Coming from above, it will be
318 to the field above.
319 t Relative references may cross hlines.
320 error An attempt to cross a hline will throw an error.
322 It is probably good to never set this variable to nil, for the sake of
323 portability of tables."
331 "Options concerning table import and export in Org-mode."
336 "Default export parameters for `org-table-export'.
337 These can be overridden for a specific table by setting the
338 TABLE_EXPORT_FORMAT property. See the manual section on orgtbl
339 radio tables for the different export transformations and
340 available parameters."
378 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
379 ;; 1 2 3 4 5
390 "Is this a table line colgroup information?"
394 line)
396 nil
403 "Is this a table line with only alignment/width cookies?"
416 s))))
422 "Check if the table has a marking column.
423 If yes remove the column and the special lines."
432 x)))
433 lines))
434 ;; No special marking column
442 ;; This line contains colgroup info, extract it
443 ;; and then discard the line
450 nil)
452 ;; This line contains formatting cookies, discard it
453 nil)
455 lines)))
456 ;; there is a special marking column
463 ;; This line contains colgroup info, extract it
464 ;; and then discard the line
471 nil)
473 ;; This line contains formatting cookies, discard it
474 nil)
476 ;; ignore this line
477 nil)
480 ;; remove the first column
482 lines))))
488 ;;;###autoload
490 "Use the table.el package to insert a new table.
491 If there is already a table at point, convert between Org-mode tables
492 and table.el tables."
505 ;;;###autoload
507 "Convert region to table, or create an empty table.
508 If there is an active region, convert it to a table, using the function
509 `org-table-convert-region'. See the documentation of that function
510 to learn how the prefix argument is interpreted to determine the field
511 separator.
512 If there is no such region, create an empty table with `org-table-create'."
518 ;;;###autoload
520 "Query for a size and insert a table skeleton.
540 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
544 ;; Insert a hline after the first row.
551 ;;;###autoload
553 "Convert region to a table.
554 The region goes from BEG0 to END0, but these borders will be moved
555 slightly, to make sure a beginning of line in the first line is included.
557 SEPARATOR specifies the field separator in the lines. It can have the
558 following values:
560 '(4) Use the comma as a field separator
561 '(16) Use a TAB as field separator
562 integer When a number, use that many spaces as field separator
563 nil When nil, the command tries to be smart and figure out the
564 separator in the following way:
565 - when each line contains a TAB, assume TAB-separated material
566 - when each line contains a comma, assume CSV material
567 - else, assume one or more SPACE characters as separator."
571 re)
578 ;; Get the right field separator
589 ;; parse the csv stuff
612 ;;;###autoload
614 "Import FILE as a table.
615 The file is assumed to be tab-separated. Such files can be produced by most
616 spreadsheet and database applications. If no tabs (at least one per line)
617 are found, lines will be split on whitespace into fields."
628 ;;;###autoload
630 "Export table to a file, with configurable format.
631 Such a file can be imported into usual spreadsheet programs.
633 FILE can be the output file name. If not given, it will be taken
634 from a TABLE_EXPORT_FILE property in the current entry or higher
635 up in the hierarchy, or the user will be prompted for a file
636 name. FORMAT can be an export format, of the same kind as it
637 used when `orgtbl-mode' sends a table in a different format.
639 The command suggests a format depending on TABLE_EXPORT_FORMAT,
640 whether it is set locally or up in the hierarchy, then on the
641 extension of the given file name, and finally on the variable
642 `org-table-export-default-format'."
656 buf deffmt-readable fileext)
672 org-table-export-default-format))
690 'hline
693 skipcols i0)))
694 lines))
698 skipcols i0))
701 skipcols i0)))
718 "Marker at the beginning of the table last aligned.
721 "Marker at the end of the table last aligned.
724 "List of flags for flushright alignment, from the last re-alignment.
727 "List of max width of fields in each column.
730 "Non-nil means debug table formulas.
742 ;;;###autoload
744 "Align the table at point by aligning all vertical bars."
747 ;; Limits of table
750 ;; Current cursor position
756 column
758 rfmt hfmt
766 emptystrings links dates emph raise narrow
767 falign falign1 fmax f1 len c e space)
770 ;; Check if we have links or dates
782 ;; Make sure the link properties are right
784 ;; Make sure the date properties are right
789 ;; Check if we are narrowing any columns
792 org-format-transports-properties-p
797 ;; Get the rows
800 ;; Store the indentation of the first line
803 ;; Mark the hlines by setting the corresponding element to nil
804 ;; At the same time, we remove trailing space.
807 nil
810 l)))
811 lines))
812 ;; Get the data fields by splitting the lines.
817 ;; How many fields in the longest line?
824 ;; A list of empty strings to fill any short rows on output
826 ;; Check for special formatting.
830 ;; Check if there is an explicit width specified
840 ;; Find fields that are wider than fmax, and shorten them
846 'help-echo
847 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
855 xx)))))
856 ;; Get the maximum width for each column
858 lengths)
859 ;; Get the fraction of numbers, to decide about alignment of the column
865 nil
872 ;; Store the alignment of this table, for later editing of single fields
874 org-table-last-column-widths lengths)
876 ;; With invisible characters, `format' does not get the field width right
877 ;; So we need to make these fields wide by hand.
895 ;; Compute the formats needed for output of the table
908 hfmt))
912 ;; Replace the old one
919 ;; Try to move to the old location
928 ))
931 "Find the beginning of the table and return its position.
932 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
936 org-table-border-regexp)
937 nil t))
944 "Find the end of the table and return its position.
945 With argument TABLE-TYPE, go to the end of a table.el-type table."
949 org-table-border-regexp)
950 nil t))
955 ;;;###autoload
957 "Justify the current field, text to left, number to right.
958 Optional argument NEW may specify text to replace the current field content."
967 ;; This is not the same table, force a full re-align
973 l f n o e)
996 ;;;###autoload
998 "Go to the next field in the current table, creating new lines as needed.
999 Before doing so, re-align the table if necessary."
1004 org-table-may-need-update)
1015 org-table-tab-jumps-over-hlines
1026 ;;;###autoload
1028 "Go to the previous field in the table.
1029 Before doing so, re-align the table if necessary."
1034 org-table-may-need-update)
1049 "Move to the end of the current table field.
1050 If already at or after the end, move to the end of the next table field.
1051 With numeric argument N, move N-1 fields forward first."
1064 "Move to the beginning of the current table field.
1065 If already at or before the beginning, move to the beginning of the
1066 previous field.
1067 With numeric argument N, move N-1 fields backward first."
1080 ;;;###autoload
1082 "Go to the next row (same column) in the current table.
1083 Before doing so, re-align the table if necessary."
1091 org-table-may-need-update)
1104 ;;;###autoload
1106 "Copy a field down in the current column.
1107 If the field at the cursor is empty, copy into it the content of
1108 the nearest non-empty field above. With argument N, use the Nth
1109 non-empty field. If the current field is not empty, it is copied
1110 down to the next row, and the cursor is moved with it.
1111 Therefore, repeating this command causes the column to be filled
1112 row-by-row.
1113 If the variable `org-table-copy-increment' is non-nil and the
1114 field is an integer or a timestamp, it will be incremented while
1115 copying. In the case of a timestamp, increment by one day."
1123 txt)
1135 beg t))
1158 "Is point inside a table data field?
1159 I.e. not on a hline or before the first or after the last column?
1160 This actually throws an error, so it aborts the current command."
1166 nil
1168 t))
1174 "Get the field in table line LINE, column COLUMN.
1175 If LINE is larger than the number of data lines in the table, the function
1176 returns nil. However, if COLUMN is too large, we will simply return an
1177 empty string.
1178 If LINE is nil, use the current line.
1179 If column is nil, use the current column."
1186 "Put VALUE into line LINE, column COLUMN.
1187 When ALIGN is set, also realign the table."
1196 "Return the index of the current data line."
1203 cnt))
1206 "Go to the Nth data line in the current table.
1207 Return t when the line exists, nil if it does not exist."
1215 "Blank the current table field or active region."
1232 "Return the value of the field in column N of current row.
1233 N defaults to current field.
1234 If REPLACE is a string, replace field with this value. The return value
1235 is always the old value."
1244 t t))
1246 val)
1249 ;;;###autoload
1251 "Show info about the current field, and highlight any reference at point."
1259 org-table-named-field-locations)))
1279 dline col
1281 dline col ref1
1283 ;; FIXME: formula info not correct if special table line
1293 "Find out which column we are in."
1303 cnt)))
1305 ;;;###autoload
1307 "Find out what table data line we are in.
1308 Only data lines count for this."
1320 cnt)))
1322 ;;;###autoload
1324 "Move the cursor to the Nth column in the current table line.
1325 With optional argument ON-DELIM, stop with point before the left delimiter
1326 of the field.
1327 If there are less than N fields, just go to after the last delimiter.
1328 However, when FORCE is non-nil, create new columns if necessary."
1338 t)))))
1345 ;;;###autoload
1347 "Insert a new column into the table."
1355 ;; Current cursor position
1361 nil
1375 "Find a data line in the current table, which is needed for column commands."
1378 t
1389 t
1394 "Turn a buffer line number into a data line number.
1395 If there is no data line in this line, return nil.
1396 If there is no matching dline (most likely te reference was a hline), the
1397 first dline below it is used. When ABOVE is non-nil, the one above is used."
1400 i)
1413 nil))
1415 ;;;###autoload
1417 "Delete a column from the table."
1426 ;; Current cursor position
1432 nil
1448 ;;;###autoload
1450 "Move column to the right."
1453 ;;;###autoload
1455 "Move column to the left."
1459 ;;;###autoload
1461 "Move the current column to the right. With arg LEFT, move to the left."
1471 ;; Current cursor position
1481 nil
1499 ;;;###autoload
1501 "Move table row down."
1504 ;;;###autoload
1506 "Move table row up."
1510 ;;;###autoload
1512 "Move the current table line down. With arg UP, move it up."
1521 txt hline2p)
1544 ;;;###autoload
1546 "Insert a new row above the current line into the table.
1547 With prefix ARG, insert below the current line."
1553 ;; Fix the first field if necessary
1566 ;;;###autoload
1568 "Insert a horizontal-line below the current line into the table.
1569 With prefix ABOVE, insert above the current line."
1590 ;;;###autoload
1592 "Insert a hline and move to the row below that line."
1606 In particular, this does handle wide and invisible characters."
1608 ;; It's a hline, just map the characters
1614 t t s)))
1615 s))
1617 ;;;###autoload
1619 "Delete the current row or horizontal line from the table."
1633 ;;;###autoload
1635 "Sort table lines according to the column at point.
1637 The position of point indicates the column to be used for
1638 sorting, and the range of lines is the range between the nearest
1639 horizontal separator lines, or the entire table of no such lines
1640 exist. If point is before the first column, you will be prompted
1641 for the sorting column. If there is an active region, the mark
1642 specifies the first line and the sorting column, while point
1643 should be in the last line to be included into the sorting.
1645 The command then prompts for the sorting type which can be
1646 alphabetically, numerically, or by time (as given in a time stamp
1647 in the field). Sorting in reverse order is also possible.
1649 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
1651 If SORTING-TYPE is specified when this function is called from a Lisp
1652 program, no prompting will take place. SORTING-TYPE must be a character,
1653 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
1654 should be done in reverse order."
1659 beg end bcol ecol tend tbeg column lns pos)
1704 x))
1718 ;;;###autoload
1720 "Copy region in table to the clipboard and blank all relevant fields.
1721 If there is no active region, use just the field at point."
1727 ;;;###autoload
1729 "Copy rectangular region in table to clipboard.
1730 A special clipboard is used which can only be accessed
1731 with `org-table-paste-rectangle'."
1735 current-prefix-arg))
1737 region cols
1763 org-table-clip))
1765 ;;;###autoload
1767 "Paste a rectangular region into a table.
1768 The upper right corner ends up in the current field. All involved fields
1769 will be overwritten. If the rectangle does not fit into the present table,
1770 the table is enlarged as needed. The process ignores horizontal separator
1771 lines."
1781 c cols field)
1796 ;;;###autoload
1798 "Convert from `org-mode' table to table.el and back.
1799 Obviously, this only works within limits. When an Org-mode table is
1800 converted to table.el, all horizontal separator lines get lost, because
1801 table.el uses these as cell boundaries and has no notion of horizontal lines.
1802 A table.el table can be converted to an Org-mode table only if it does not
1803 do row or column spanning. Multiline cells will become multiple cells.
1804 Beware, Org-mode does not test if the table can be successfully converted - it
1805 blindly applies a recipe that works for simple tables."
1809 ;; convert to Org-mode table
1818 ;; convert to table.el table
1821 ;; first, get rid of all horizontal lines
1825 ;; insert a hline before first
1829 ;; insert a hline after each line
1834 ;; replace "+" at beginning and ending of hlines
1843 "Transpose orgmode table at point and eliminate hlines.
1844 So a table like
1846 | 1 | 2 | 4 | 5 |
1847 |---+---+---+---|
1848 | a | b | c | d |
1849 | e | f | g | h |
1851 will be transposed as
1853 | 1 | a | e |
1854 | 2 | b | f |
1855 | 4 | c | g |
1856 | 5 | d | h |
1858 Note that horizontal lines disappeared."
1862 ;; remove 'hline from list
1870 ;;;###autoload
1872 "Wrap several fields in a column like a paragraph.
1873 This is useful if you'd like to spread the contents of a field over several
1874 lines, in order to keep the table compact.
1876 If there is an active region, and both point and mark are in the same column,
1877 the text in the column is wrapped to minimum width for the given number of
1878 lines. Generally, this makes the table more compact. A prefix ARG may be
1880 formats the selected text to two lines. If the region was longer than two
1881 lines, the remaining lines remain empty. A negative prefix argument reduces
1882 the current number of lines by that amount. The wrapped text is pasted back
1883 into the table. If you formatted it to more lines than it was before, fields
1884 further down in the table get overwritten - so you might need to make space in
1885 the table first.
1887 If there is no region, the current field is split at the cursor position and
1888 the text fragment to the right of the cursor is prepended to the field one
1889 line down.
1891 If there is no region, but you specify a prefix ARG, the current field gets
1892 blank, and the content is appended to the field above."
1896 ;; There is a region: fill as a paragraph
1900 nlines)
1907 arg)
1911 nil nlines)))
1915 ;; No region, split the current field at point
1919 ;; combine with field above
1929 ;; split field
1941 ;;;###autoload
1943 "Edit table field in a different window.
1944 This is mainly useful for fields that contain hidden parts.
1946 it can be edited in place."
1955 display t intangible t))
1968 p)
1984 intangible t))
1992 "Finish editing a table data field.
1993 Remove all newline characters, insert the result into the table, realign
1994 the table and kill the editing buffer."
1998 text)
2015 "Minor mode to make the table field editor window follow the cursor.
2016 When this mode is active, the field editor window will always show the
2017 current field. The mode exits automatically when the cursor leaves the
2018 table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
2019 nil " TblFollow" nil
2035 ;; We have left the table, exit the follow mode
2045 ;;;###autoload
2047 "Sum numbers in region of current table column.
2048 The result will be displayed in the echo area, and will be available
2051 If there is an active region, it is interpreted as a rectangle and all
2052 numbers in that rectangle will be summed. If there is no active
2053 region and point is located in a table column, sum all numbers in that
2054 column.
2056 If at least one number looks like a time HH:MM or HH:MM:SS, all other
2057 numbers are assumed to be times as well (in decimal hours) and the
2058 numbers are added as such.
2060 If NLAST is a number, only the NLAST fields will actually be summed."
2087 items1)))
2094 s diff)
2102 sres))))
2125 "Return the formula active for the current field.
2126 Assumes that specials are in place.
2127 If KEY is given, return the key to this formula.
2131 org-table-named-field-locations)))
2145 "Read a formula from the minibuffer, offer stored formula as default.
2146 When NAMED is non-nil, look for a named equation."
2150 org-table-named-field-locations)))
2157 name
2158 ref)
2168 stored)
2170 equation)
2177 scol))
2179 'org-table-formula-history
2180 )))))
2181 mustsave)
2183 ;; remove formula
2190 ;; We set the column equation, delete the named one.
2192 mustsave t))
2198 eq))
2201 "Store the list of formulas below the current table."
2208 ;; don't overwrite TBLFM, we might use text properties to store stuff
2224 ;; Fake a high number to make sure this is sorted at the end.
2231 a)
2241 "Compare two formulas for sorting."
2246 ;;;###autoload
2248 "Return an alist with the stored formulas directly after current table."
2257 (when (string-match "\\`\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*[^ \t]\\)" string)
2276 "Modify the equations after the table structure has been edited.
2278 For all numbers larger than LIMIT, shift them by DELTA."
2290 s n a)
2310 "Get the column names and local parameters for this table."
2313 names name fields fields1 field cnt
2314 c v l line col types dlines hlines last-dline)
2316 org-table-local-parameters nil
2317 org-table-named-field-locations nil
2318 org-table-current-begin-line nil
2319 org-table-current-begin-pos nil
2320 org-table-current-line-types nil
2339 org-table-local-parameters))))
2355 ;; Analyse the line types
2359 l org-table-current-begin-line)
2376 al al2)
2386 ;;;###autoload
2389 If yes, store the formula and apply it."
2390 ;; We already know we are in a table. Get field will only return a formula
2391 ;; when appropriate. It might return a separator line, but no problem.
2394 named eq)
2405 "List of commands triggering the recalculation of a line.
2417 ;;;###autoload
2419 "Rotate the recalculation mark in the first column.
2420 If in any row, the first field is not consistent with a mark,
2421 insert a new column for the markers.
2422 When there is an active region, change all the lines in the region,
2423 after prompting for the marking character.
2424 After each change, a message will be displayed indicating the meaning
2425 of the new mark."
2440 epos new)
2447 newchar))
2479 ;;;###autoload
2481 "Recompute the current line if marked for it, and if we haven't just done it."
2501 org-tbl-calc-modes)
2503 ;;;###autoload
2505 suppress-align suppress-const
2506 suppress-store suppress-analysis)
2507 "Replace the table field value at the cursor by the result of a calculation.
2509 This function makes use of Dave Gillespie's Calc package, in my view the
2510 most exciting program ever written for GNU Emacs. So you need to have Calc
2511 installed in order to use this function.
2513 In a table, this command replaces the value in the current field with the
2515 formula, by storing it in a special line below the table. When called
2516 with a `C-u' prefix, the current field must be a named field, and the
2517 formula is installed as valid in only this specific field.
2519 When called with two `C-u' prefixes, insert the active equation
2520 for the field back into the current field, so that it can be
2522 to check the referenced fields.
2524 When called, the command first prompts for a formula, which is read in
2525 the minibuffer. Previously entered formulas are available through the
2526 history list, and the last used formula is offered as a default.
2527 These stored formulas are adapted correctly when moving, inserting, or
2528 deleting columns with the corresponding commands.
2530 The formula can be any algebraic expression understood by the Calc package.
2531 For details, see the Org-mode manual.
2533 This function can also be called from Lisp programs and offers
2534 additional arguments: EQUATION can be the formula to apply. If this
2535 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
2536 used to speed-up recursive calls by by-passing unnecessary aligns.
2537 SUPPRESS-CONST suppresses the interpretation of constants in the
2538 formula, assuming that this has been done already outside the function.
2539 SUPPRESS-STORE means the formula should not be stored, either because
2540 it is already stored, or because it is a modified equation that should
2541 not overwrite the stored one."
2557 equation
2563 n form form0 formrpl formrg bw fmt x ev orig c lispp literal
2564 duration duration-output-format)
2565 ;; Parse the format string. Since we have a lot of modes, this is
2566 ;; a lot of work. However, I think calc still uses most of the time.
2579 'calc-float-format
2582 n))))
2586 duration-output-format nil
2590 duration-output-format org-table-duration-custom-format
2591 numbers t
2614 ;; replace fields with duration values if relevant
2618 fields)))
2624 x))
2625 fields)))
2631 ;; Insert row and column number of formula result field
2642 t t form)))
2644 ;; Check for old vertical references
2646 ;; Insert remote references
2658 rmtrng))
2659 keep-empty numbers lispp))
2660 t t form)))
2661 ;; Insert complex ranges
2669 ;; possibly handle durations
2674 formrg)
2675 keep-empty numbers lispp)))
2680 ;; Insert simple ranges
2689 keep-empty numbers lispp))
2690 t t form)))
2692 ;; Insert the references to fields in same row
2702 x keep-empty numbers lispp))
2703 t t form)))
2715 ;; Use <...> time-stamps so that Calc can handle them
2717 ;; I18n-ize local time-stamps by setting (system-time-locale "C")
2728 form
2735 duration-output-format)
2736 ev)))
2741 Orig: %s
2742 $xyz-> %s
2743 @r$c-> %s
2775 prop value)))
2778 "Get a calc vector from a column, according to descriptor DESC.
2779 Optional arguments TBEG and COL can give the beginning of the table and
2780 the current column, to avoid unnecessary parsing.
2782 HIGHLIGHT means just highlight the range.
2784 When CORNERS-ONLY is set, only return the corners of the range as
2785 a list (line1 column1 line2 column2) where line1 and line2 are line numbers
2786 in the buffer and column1 and column2 are table column numbers."
2793 beg end c1 c2 r1 r2 rangep tmp)
2810 ; (setq r2 (or r2 r1) c2 (or c2 c1))
2817 ;; just one field
2824 ;; A range, return a vector
2825 ;; First sort the numbers to get a regular rectangle
2829 ;; Only return the corners of the range
2831 ;; Copy the range values into a list
2845 ;; return string representation of calc vector
2850 "Analyze descriptor DESC and retrieve the corresponding line number.
2851 The cursor is currently in line CLINE, the table begins in line BLINE,
2852 and TABLE is a vector with line types."
2860 ;; 1 2 3 4 5 6
2880 nil hn cline desc)))
2883 rel on cline desc)))
2887 "FIXME: Needs more documentation."
2900 nil))
2901 t)))
2905 desc cline)
2906 i)))
2911 s))
2914 "Convert list ELEMENTS to something appropriate to insert into formula.
2915 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
2916 NUMBERS indicates that everything should be converted to numbers.
2917 LISPP non-nil means to return something appropriate for a Lisp
2918 list, 'literal is for the format specifier L."
2919 ;; Calc nan (not a number) is used for the conversion of the empty
2920 ;; field to a reference for several reasons: (i) It is accepted in a
2921 ;; Calc formula (e. g. "" or "()" would result in a Calc error).
2922 ;; (ii) In a single field (not in range) it can be distinguished
2923 ;; from "(nan)" which is the reference made from a single field
2924 ;; containing "nan".
2926 ;; field reference
2929 elements
2937 ;; range reference
2942 elements))))
2948 x
2956 x)
2958 elements
2961 ;;;###autoload
2963 "Recalculate the current table line by applying all stored formulas.
2964 With prefix arg ALL, do this for all lines in the table.
2965 With the prefix argument ALL is `(16)' \
2967 it is the symbol `iterate', recompute the table until it no longer changes.
2968 If NOALIGN is not nil, do not re-align the table after the computations
2969 are done. This is typically used internally to save time, if it is
2970 known that the table will be realigned a little later anyway."
2985 seen-fields lhs1
2987 ;; Insert constants in all formulas
3003 eqlist))
3004 ;; Split the equation list
3010 ;; Expand ranges in lhs of formulas
3013 ;; Get the correct line range to process
3019 ;; This is a table with marked lines, compute selected lines
3021 ;; Move forward to the first non-header line
3032 ;; First find the named fields, and mark them untouchable.
3033 ;; Also check if several field/range formulas try to set the same field.
3052 name)))
3062 ;; Now evaluate the column formulas, but skip fields covered by
3063 ;; field formulas
3067 ;; Unprotected line, recalculate
3079 ;; Now evaluate the field formulas
3093 ;; back to initial position
3100 ;;;###autoload
3102 "Recalculate the table until it does not change anymore.
3103 The maximum number of iterations is 10, but you can choose a different value
3104 with the prefix ARG."
3109 thistbl)
3123 ;;;###autoload
3125 "Recalculate all tables in the current buffer."
3132 ;;;###autoload
3134 "Iterate all tables in the buffer, to converge inter-table dependencies."
3139 c1)
3155 "Expand list of formulas.
3156 If some of the RHS in the formulas are ranges or a row reference, expand
3157 them to individual field equations for each field."
3163 ;; This just refers to one fixed field
3166 ;; This just refers to one fixed named field
3188 "Replace @<, @>, $<, $> with first/last row/column of the table.
3189 So @< and $< will always be replaced with @1 and $1, respectively.
3190 The advantage of these special markers are that structure editing of
3191 the table will not change them, while @1 and $1 will be modified
3192 when a line/row is swapped out of that privileged position. So for
3193 formulas that use a range of rows or columns, it may often be better
3195 borders of the table using the @< @> $< $> makers."
3198 s start)
3203 org-table-current-ncol)
3207 len
3214 s)
3217 "Replace $const with values in string F."
3219 ;; First, check for column names
3224 ;; Parameters and constants
3226 (while (setq start (string-match "\\$\\([a-zA-Z][_a-zA-Z0-9]*\\)\\|\\(\\<remote([^)]*)\\)" f start))
3236 f))
3239 "Find the value for a parameter or constant in a formula.
3240 Parameters get priority."
3271 map))
3278 "--"
3281 "--"
3282 "Shift Reference at Point"
3287 "-"
3288 "Change Test Row for Column Formulas"
3291 "--"
3296 org-table-overlay-coordinates)]
3297 "--"
3303 ;;;###autoload
3305 "Edit the formulas of the current table in a separate buffer."
3307 (when (save-excursion (beginning-of-line 1) (let ((case-fold-search t)) (looking-at "[ \t]*#\\+TBLFM")))
3321 entry s type title)
3324 ;; Keep global-font-lock-mode from turning on font-lock-mode
3365 "Convert a formula from internal to user representation."
3368 s))
3371 "Convert a formula from user to internal representation."
3374 s))
3377 "Convert spreadsheet references from A7 to @7$28.
3378 Works for single references, but also for entire formulas and even the
3379 full TBLFM line."
3381 (while (string-match "\\<\\([a-zA-Z]+\\)\\([0-9]+\\>\\|&\\)\\|\\(;[^\r\n:]+\\|\\<remote([^,)]*)\\)" s start)
3384 ;; format match, just advance
3389 ;; 3.e5 or something like this.
3392 ;; (member (match-string 1 s)
3393 ;; '("arctan" "exp" "expm" "lnp" "log" "stir"))
3394 )
3395 ;; function name, just advance
3405 t t s)))))
3406 s))
3409 "Convert spreadsheet references from to @7$28 to AB7.
3410 Works for single references, but also for entire formulas and even the
3411 full TBLFM line."
3418 t t s)))
3423 t nil s)))
3424 s)
3427 "Convert a base 26 number represented by letters into an integer.
3428 For example: AB -> 28."
3434 n))
3437 "Convert an integer into a base 26 number represented by letters.
3438 For example: 28 -> AB."
3443 s))
3446 "Convert a time string into numerical duration in seconds.
3447 S can be a string matching either -?HH:MM:SS or -?HH:MM.
3448 If S is a string representing a number, keep this number."
3450 s
3473 "Convert a number of seconds to a time string.
3474 If OUTPUT-FORMAT is non-nil, return a number of days, hours,
3475 minutes or seconds."
3490 "Convert all references in this buffer, using FUNCTION."
3500 "Convert all references in the buffer from B3 to @3$2 and back."
3510 "Shift the reference at point one row/hline up."
3514 "Shift the reference at point one row/hline down."
3518 "Shift the reference at point one field to the left."
3522 "Shift the reference at point one field to the right."
3533 ;; A B3-like reference
3539 ;; An internal reference
3545 "Re-match the group N, and replace it with the shifted reference."
3550 t t)))
3553 "Shift a reference part REF.
3554 If DECR is set, decrease the references row/column, else increase.
3555 If HLINE is set, this may be a hline reference, it certainly is not
3556 a translation reference."
3585 "Toggle the display of coordinates in the referenced table."
3594 "Parse the buffer for formula definitions and install them.
3595 With prefix ARG, apply the new formulas to the table."
3605 "^\\(@[-+I<>0-9.$@]+\\|@?[0-9]+\\|\\$\\([a-zA-Z0-9]+\\|[<>]+\\)\\) *= *\\(.*\\(\n[ \t]+.*$\\)*\\)"
3606 nil t)
3630 "Abort editing formulas, without installing the changes."
3641 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
3682 "Show the location/value of the $ expression at point."
3691 var name e what match dest)
3696 "$1.."
3779 ;; column number
3807 org-table-fedit-scroll-down))))
3818 "Make sure the cursor is in a dataline in a table."
3827 p1 p2)))
3832 "Move cursor one line up in the window showing the table."
3837 "Move cursor one line down in the window showing the table."
3842 "Move the cursor in the window showing the table.
3843 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
3868 "Add a new overlay."
3874 "Highlight rectangular region in a table."
3878 l1 c1 l2 c2 tmp)
3902 "Remove the rectangle overlays."
3913 "Add overlays to the table at point, to show row/column coordinates."
3941 ;;;###autoload
3943 "Toggle the display of Row/Column numbers in tables."
3954 ;;;###autoload
3956 "Toggle the formula debugger in tables."
3962 ;;; The orgtbl minor mode
3964 ;; Define a minor mode which can be used in other modes in order to
3965 ;; integrate the org-mode table editor.
3967 ;; This is really a hack, because the org-mode table editor uses several
3968 ;; keys which normally belong to the major mode, for example the TAB and
3969 ;; RET keys. Here is how it works: The minor mode defines all the keys
3970 ;; necessary to operate the table editor, but wraps the commands into a
3971 ;; function which tests if the cursor is currently inside a table. If that
3972 ;; is the case, the table editor command is executed. However, when any of
3973 ;; those keys is used outside a table, the function uses `key-binding' to
3974 ;; look up if the key has an associated command in another currently active
3975 ;; keymap (minor modes, major mode, global), and executes that command.
3976 ;; There might be problems if any of the keys used by the table editor is
3977 ;; otherwise used as a prefix key.
3979 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
3980 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
3981 ;; addresses this by checking explicitly for both bindings.
3983 ;; The optimized version (see variable `orgtbl-optimized') takes over
3984 ;; all keys which are bound to `self-insert-command' in the *global map*.
3985 ;; Some modes bind other commands to simple characters, for example
3986 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
3987 ;; active, this binding is ignored inside tables and replaced with a
3988 ;; modified self-insert.
4006 ;; Install it as a minor mode.
4010 ;;;###autoload
4012 "The `org-mode' table editor as a minor mode for use in other modes."
4017 ;; Exit without error, in case some hook functions calls this
4018 ;; by accident in org-mode.
4022 ;; Make sure we are first in minor-mode-map-alist
4024 ;; FIXME: maybe it should use emulation-mode-map-alists?
4031 auto-fill-inhibit-regexp)
4035 auto-fill-inhibit-regexp)
4036 orgtbl-line-start-regexp))
4054 "Remove all properties related to narrow-column invisibility."
4067 "Create a function for binding in the table minor mode.
4068 FUN is the command to call inside a table. N is used to create a unique
4069 command name. KEYS are keys that should be checked in for a command
4070 to execute outside of tables."
4076 "Outside of tables, run the binding of `"
4088 keys)
4092 "Error when there is no default binding for a table key."
4097 "Setup orgtbl keymaps."
4128 elt key fun cmd)
4136 ;; Special treatment needed for TAB and RET
4156 [(tab)] "\C-i")))
4158 (org-defkey orgtbl-mode-map [backtab]
4160 [backtab] [S-iso-lefttab] [(shift tab)]
4161 [(tab)] "\C-i"))
4163 (org-defkey orgtbl-mode-map "\M-\C-m"
4164 (orgtbl-make-binding 'org-table-wrap-region 105
4165 "\M-\C-m" [(meta return)]))
4166 (org-defkey orgtbl-mode-map [(meta return)]
4167 (orgtbl-make-binding 'org-table-wrap-region 106
4168 [(meta return)] "\M-\C-m"))
4170 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
4171 (org-defkey orgtbl-mode-map "\C-c|" 'orgtbl-create-or-convert-from-region)
4173 (when orgtbl-optimized
4174 ;; If the user wants maximum table support, we need to hijack
4175 ;; some standard editing functions
4176 (org-remap orgtbl-mode-map
4177 'self-insert-command 'orgtbl-self-insert-command
4178 'delete-char 'org-delete-char
4179 'delete-backward-char 'org-delete-backward-char)
4180 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
4181 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
4182 '("OrgTbl"
4183 ["Create or convert" org-table-create-or-convert-from-region
4184 :active (not (org-at-table-p)) :keys "C-c |" ]
4185 "--"
4186 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
4187 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
4188 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
4189 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
4190 "--"
4191 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
4192 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
4193 ["Copy Field from Above"
4194 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
4195 "--"
4196 ("Column"
4197 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
4198 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
4199 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
4200 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
4201 ("Row"
4202 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
4203 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
4204 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
4205 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
4206 ["Sort lines in region" org-table-sort-lines :active (org-at-table-p) :keys "C-c ^"]
4207 "--"
4208 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
4209 ("Rectangle"
4210 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
4211 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
4212 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
4213 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
4214 "--"
4215 ("Radio tables"
4216 ["Insert table template" orgtbl-insert-radio-table
4217 (assq major-mode orgtbl-radio-table-templates)]
4218 ["Comment/uncomment table" orgtbl-toggle-comment t])
4219 "--"
4220 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
4221 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
4222 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
4223 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
4224 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
4225 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
4226 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
4227 ["Sum Column/Rectangle" org-table-sum
4228 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
4229 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
4230 ["Debug Formulas"
4231 org-table-toggle-formula-debugger :active (org-at-table-p)
4232 :keys "C-c {"
4233 :style toggle :selected org-table-formula-debug]
4234 ["Show Col/Row Numbers"
4235 org-table-toggle-coordinate-overlays :active (org-at-table-p)
4236 :keys "C-c }"
4237 :style toggle :selected org-table-overlay-coordinates]
4238 ))
4239 t))
4241 (defun orgtbl-ctrl-c-ctrl-c (arg)
4242 "If the cursor is inside a table, realign the table.
4243 If it is a table to be sent away to a receiver, do it.
4244 With prefix arg, also recompute table."
4245 (interactive "P")
4246 (let ((case-fold-search t) (pos (point)) action consts-str consts cst const-str)
4247 (save-excursion
4248 (beginning-of-line 1)
4249 (setq action (cond
4253 (cond
4254 ((integerp action)
4255 (goto-char action)
4256 (org-table-maybe-eval-formula)
4257 (if arg
4258 (call-interactively 'org-table-recalculate)
4259 (org-table-maybe-recalculate-line))
4260 (call-interactively 'org-table-align)
4261 (when (orgtbl-send-table 'maybe)
4262 (run-hooks 'orgtbl-after-send-table-hook)))
4263 ((eq action 'recalc)
4264 (save-excursion
4265 (goto-char (point-min))
4267 (setq const-str (substring-no-properties (match-string 1)))
4269 (when consts
4270 (let (e)
4271 (while (setq e (pop consts))
4273 (push (cons (match-string 1 e) (match-string 2 e)) cst)))
4274 (setq org-table-formula-constants-local cst)))))
4275 (save-excursion
4276 (beginning-of-line 1)
4278 (if (org-at-table-p)
4279 (org-call-with-arg 'org-table-recalculate t))))
4280 (t (let (orgtbl-mode)
4281 (call-interactively (key-binding "\C-c\C-c")))))))
4283 (defun orgtbl-create-or-convert-from-region (arg)
4284 "Create table or convert region to table, if no conflicting binding.
4285 This installs the table binding `C-c |', but only if there is no
4286 conflicting binding to this key outside orgtbl-mode."
4287 (interactive "P")
4288 (let* (orgtbl-mode (cmd (key-binding "\C-c|")))
4289 (if cmd
4290 (call-interactively cmd)
4291 (call-interactively 'org-table-create-or-convert-from-region))))
4293 (defun orgtbl-tab (arg)
4294 "Justification and field motion for `orgtbl-mode'."
4295 (interactive "P")
4296 (if arg (org-table-edit-field t)
4297 (org-table-justify-field-maybe)
4298 (org-table-next-field)))
4300 (defun orgtbl-ret ()
4301 "Justification and field motion for `orgtbl-mode'."
4302 (interactive)
4303 (if (bobp)
4304 (newline)
4305 (org-table-justify-field-maybe)
4306 (org-table-next-row)))
4308 (defun orgtbl-self-insert-command (N)
4309 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
4310 If the cursor is in a table looking at whitespace, the whitespace is
4311 overwritten, and the table is not marked as requiring realignment."
4312 (interactive "p")
4313 (if (and (org-at-table-p)
4314 (or
4315 (and org-table-auto-blank-field
4316 (member last-command
4317 '(orgtbl-hijacker-command-100
4318 orgtbl-hijacker-command-101
4319 orgtbl-hijacker-command-102
4320 orgtbl-hijacker-command-103
4321 orgtbl-hijacker-command-104
4322 orgtbl-hijacker-command-105
4323 yas/expand))
4324 (org-table-blank-field))
4325 t)
4326 (eq N 1)
4328 (let (org-table-may-need-update)
4329 (goto-char (1- (match-end 0)))
4330 (org-delete-backward-char 1)
4331 (goto-char (match-beginning 0))
4332 (self-insert-command N))
4333 (setq org-table-may-need-update t)
4334 (let* (orgtbl-mode
4335 a
4336 (cmd (or (key-binding
4337 (or (and (listp function-key-map)
4338 (setq a (assoc last-input-event function-key-map))
4339 (cdr a))
4340 (vector last-input-event)))
4341 'self-insert-command)))
4342 (call-interactively cmd)
4343 (if (and org-self-insert-cluster-for-undo
4344 (eq cmd 'self-insert-command))
4345 (if (not (eq last-command 'orgtbl-self-insert-command))
4346 (setq org-self-insert-command-undo-counter 1)
4347 (if (>= org-self-insert-command-undo-counter 20)
4348 (setq org-self-insert-command-undo-counter 1)
4349 (and (> org-self-insert-command-undo-counter 0)
4350 buffer-undo-list
4351 (not (cadr buffer-undo-list)) ; remove nil entry
4352 (setcdr buffer-undo-list (cddr buffer-undo-list)))
4353 (setq org-self-insert-command-undo-counter
4354 (1+ org-self-insert-command-undo-counter))))))))
4357 "Regular expression matching exponentials as produced by calc.")
4359 (defun orgtbl-export (table target)
4360 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
4362 org-table-last-alignment org-table-last-column-widths
4363 maxcol column)
4364 (if (not (fboundp func))
4365 (error "Cannot export orgtbl table to %s" target))
4366 (setq lines (org-table-clean-before-export lines))
4367 (setq table
4368 (mapcar
4369 (lambda (x)
4370 (if (string-match org-table-hline-regexp x)
4371 'hline
4373 lines))
4374 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
4375 table)))
4376 (loop for i from (1- maxcol) downto 0 do
4377 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
4378 (setq column (delq nil column))
4379 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
4380 (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))
4381 (funcall func table nil)))
4383 (defun orgtbl-gather-send-defs ()
4384 "Gather a plist of :name, :transform, :params for each destination before
4385 a radio table."
4386 (save-excursion
4387 (goto-char (org-table-begin))
4388 (let (rtn)
4389 (beginning-of-line 0)
4390 (while (looking-at "[ \t]*#\\+ORGTBL[: \t][ \t]*SEND[ \t]+\\([^ \t\r\n]+\\)[ \t]+\\([^ \t\r\n]+\\)\\([ \t]+.*\\)?")
4391 (let ((name (org-no-properties (match-string 1)))
4392 (transform (intern (match-string 2)))
4393 (params (if (match-end 3)
4394 (read (concat "(" (match-string 3) ")")))))
4395 (push (list :name name :transform transform :params params)
4396 rtn)
4397 (beginning-of-line 0)))
4398 rtn)))
4400 (defun orgtbl-send-replace-tbl (name txt)
4401 "Find and replace table NAME with TXT."
4402 (save-excursion
4403 (goto-char (point-min))
4404 (unless (re-search-forward
4406 (error "Don't know where to insert translated table"))
4407 (goto-char (match-beginning 0))
4408 (beginning-of-line 2)
4409 (save-excursion
4410 (let ((beg (point)))
4411 (unless (re-search-forward
4412 (concat "END RECEIVE ORGTBL +" name) nil t)
4413 (error "Cannot find end of insertion region"))
4414 (beginning-of-line 1)
4415 (delete-region beg (point))))
4418 ;;;###autoload
4419 (defun org-table-to-lisp (&optional txt)
4420 "Convert the table at point to a Lisp structure.
4421 The structure will be a list. Each item is either the symbol `hline'
4422 for a horizontal separator line, or a list of field values as strings.
4423 The table is taken from the parameter TXT, or from the buffer at point."
4424 (unless txt
4425 (unless (org-at-table-p)
4426 (error "No table at point")))
4427 (let* ((txt (or txt
4428 (buffer-substring-no-properties (org-table-begin)
4429 (org-table-end))))
4432 (mapcar
4433 (lambda (x)
4434 (if (string-match org-table-hline-regexp x)
4435 'hline
4437 lines)))
4439 (defun orgtbl-send-table (&optional maybe)
4440 "Send a transformed version of this table to the receiver position.
4441 With argument MAYBE, fail quietly if no transformation is defined for
4442 this table."
4443 (interactive)
4444 (catch 'exit
4445 (unless (org-at-table-p) (error "Not at a table"))
4446 ;; when non-interactive, we assume align has just happened.
4447 (when (org-called-interactively-p 'any) (org-table-align))
4448 (let ((dests (orgtbl-gather-send-defs))
4449 (txt (buffer-substring-no-properties (org-table-begin)
4450 (org-table-end)))
4451 (ntbl 0))
4452 (unless dests (if maybe (throw 'exit nil)
4453 (error "Don't know how to transform this table")))
4454 (dolist (dest dests)
4455 (let* ((name (plist-get dest :name))
4456 (transform (plist-get dest :transform))
4457 (params (plist-get dest :params))
4458 (skip (plist-get params :skip))
4459 (skipcols (plist-get params :skipcols))
4460 (no-escape (plist-get params :no-escape))
4461 beg
4462 (lines (org-table-clean-before-export
4463 (nthcdr (or skip 0)
4465 (i0 (if org-table-clean-did-remove-column 2 1))
4466 (lines (if no-escape lines
4467 (mapcar (lambda(l) (replace-regexp-in-string
4469 (table (mapcar
4470 (lambda (x)
4471 (if (string-match org-table-hline-regexp x)
4472 'hline
4473 (org-remove-by-index
4475 skipcols i0)))
4476 lines))
4477 (fun (if (= i0 2) 'cdr 'identity))
4478 (org-table-last-alignment
4479 (org-remove-by-index (funcall fun org-table-last-alignment)
4480 skipcols i0))
4481 (org-table-last-column-widths
4482 (org-remove-by-index (funcall fun org-table-last-column-widths)
4483 skipcols i0))
4484 (txt (if (fboundp transform)
4485 (funcall transform table params)
4486 (error "No such transformation function %s" transform))))
4487 (orgtbl-send-replace-tbl name txt))
4488 (setq ntbl (1+ ntbl)))
4489 (message "Table converted and installed at %d receiver location%s"
4490 ntbl (if (> ntbl 1) "s" ""))
4491 (if (> ntbl 0)
4492 ntbl
4493 nil))))
4495 (defun org-remove-by-index (list indices &optional i0)
4496 "Remove the elements in LIST with indices in INDICES.
4497 First element has index 0, or I0 if given."
4498 (if (not indices)
4499 list
4500 (if (integerp indices) (setq indices (list indices)))
4501 (setq i0 (1- (or i0 0)))
4502 (delq :rm (mapcar (lambda (x)
4503 (setq i0 (1+ i0))
4504 (if (memq i0 indices) :rm x))
4505 list))))
4507 (defun orgtbl-toggle-comment ()
4508 "Comment or uncomment the orgtbl at point."
4509 (interactive)
4510 (let* ((case-fold-search t)
4511 (re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
4512 (re2 (concat "^" orgtbl-line-start-regexp))
4513 (commented (save-excursion (beginning-of-line 1)
4514 (cond ((looking-at re1) t)
4515 ((looking-at re2) nil)
4516 (t (error "Not at an org table")))))
4517 (re (if commented re1 re2))
4518 beg end)
4519 (save-excursion
4520 (beginning-of-line 1)
4521 (while (looking-at re) (beginning-of-line 0))
4522 (beginning-of-line 2)
4523 (setq beg (point))
4524 (while (looking-at re) (beginning-of-line 2))
4525 (setq end (point)))
4526 (comment-region beg end (if commented '(4) nil))))
4528 (defun orgtbl-insert-radio-table ()
4529 "Insert a radio table template appropriate for this major mode."
4530 (interactive)
4531 (let* ((e (assq major-mode orgtbl-radio-table-templates))
4532 (txt (nth 1 e))
4533 name pos)
4534 (unless e (error "No radio table setup defined for %s" major-mode))
4535 (setq name (read-string "Table name: "))
4536 (while (string-match "%n" txt)
4537 (setq txt (replace-match name t t txt)))
4539 (setq pos (point))
4540 (insert txt)
4541 (goto-char pos)))
4543 ;; Dynamically bound input and output for table formatting.
4544 (defvar *orgtbl-table* nil
4545 "Carries the current table through formatting routines.")
4546 (defvar *orgtbl-rtn* nil
4547 "Formatting routines push the output lines here.")
4548 ;; Formatting parameters for the current table section.
4549 (defvar *orgtbl-hline* nil "Text used for horizontal lines.")
4550 (defvar *orgtbl-sep* nil "Text used as a column separator.")
4551 (defvar *orgtbl-default-fmt* nil "Default format for each entry.")
4552 (defvar *orgtbl-fmt* nil "Format for each entry.")
4553 (defvar *orgtbl-efmt* nil "Format for numbers.")
4554 (defvar *orgtbl-lfmt* nil "Format for an entire line, overrides fmt.")
4555 (defvar *orgtbl-llfmt* nil "Specializes lfmt for the last row.")
4556 (defvar *orgtbl-lstart* nil "Text starting a row.")
4557 (defvar *orgtbl-llstart* nil "Specializes lstart for the last row.")
4558 (defvar *orgtbl-lend* nil "Text ending a row.")
4559 (defvar *orgtbl-llend* nil "Specializes lend for the last row.")
4561 (defsubst orgtbl-get-fmt (fmt i)
4562 "Retrieve the format from FMT corresponding to the Ith column."
4563 (if (and (not (functionp fmt)) (consp fmt))
4564 (plist-get fmt i)
4565 fmt))
4567 (defsubst orgtbl-apply-fmt (fmt &rest args)
4568 "Apply format FMT to the arguments. NIL FMTs return the first argument."
4569 (cond ((functionp fmt) (apply fmt args))
4570 (fmt (apply 'format fmt args))
4571 (args (car args))
4572 (t args)))
4574 (defsubst orgtbl-eval-str (str)
4575 "If STR is a function, evaluate it with no arguments."
4576 (if (functionp str)
4577 (funcall str)
4578 str))
4580 (defun orgtbl-format-line (line)
4581 "Format LINE as a table row."
4582 (if (eq line 'hline) (if *orgtbl-hline* (push *orgtbl-hline* *orgtbl-rtn*))
4583 (let* ((i 0)
4584 (line
4585 (mapcar
4586 (lambda (f)
4587 (setq i (1+ i))
4588 (let* ((efmt (orgtbl-get-fmt *orgtbl-efmt* i))
4589 (f (if (and efmt (string-match orgtbl-exp-regexp f))
4590 (orgtbl-apply-fmt efmt (match-string 1 f)
4591 (match-string 2 f))
4592 f)))
4593 (orgtbl-apply-fmt (or (orgtbl-get-fmt *orgtbl-fmt* i)
4594 *orgtbl-default-fmt*)
4595 f)))
4596 line)))
4597 (push (if *orgtbl-lfmt*
4598 (orgtbl-apply-fmt *orgtbl-lfmt* line)
4599 (concat (orgtbl-eval-str *orgtbl-lstart*)
4600 (mapconcat 'identity line *orgtbl-sep*)
4601 (orgtbl-eval-str *orgtbl-lend*)))
4602 *orgtbl-rtn*))))
4604 (defun orgtbl-format-section (section-stopper)
4605 "Format lines until the first occurrence of SECTION-STOPPER."
4606 (let (prevline)
4607 (progn
4608 (while (not (eq (car *orgtbl-table*) section-stopper))
4609 (if prevline (orgtbl-format-line prevline))
4610 (setq prevline (pop *orgtbl-table*)))
4611 (if prevline (let ((*orgtbl-lstart* *orgtbl-llstart*)
4612 (*orgtbl-lend* *orgtbl-llend*)
4613 (*orgtbl-lfmt* *orgtbl-llfmt*))
4614 (orgtbl-format-line prevline))))))
4616 ;;;###autoload
4617 (defun orgtbl-to-generic (table params)
4618 "Convert the orgtbl-mode TABLE to some other format.
4619 This generic routine can be used for many standard cases.
4620 TABLE is a list, each entry either the symbol `hline' for a horizontal
4621 separator line, or a list of fields for that line.
4622 PARAMS is a property list of parameters that can influence the conversion.
4623 For the generic converter, some parameters are obligatory: you need to
4624 specify either :lfmt, or all of (:lstart :lend :sep).
4626 Valid parameters are:
4628 :splice When set to t, return only table body lines, don't wrap
4629 them into :tstart and :tend. Default is nil. When :splice
4630 is non-nil, this also means that the exporter should not look
4631 for and interpret header and footer sections.
4633 :hline String to be inserted on horizontal separation lines.
4634 May be nil to ignore hlines.
4636 :sep Separator between two fields
4637 :remove-nil-lines Do not include lines that evaluate to nil.
4639 Each in the following group may be either a string or a function
4640 of no arguments returning a string:
4642 :tstart String to start the table. Ignored when :splice is t.
4643 :tend String to end the table. Ignored when :splice is t.
4644 :lstart String to start a new table line.
4645 :llstart String to start the last table line, defaults to :lstart.
4646 :lend String to end a table line
4647 :llend String to end the last table line, defaults to :lend.
4649 Each in the following group may be a string, a function of one
4650 argument (the field or line) returning a string, or a plist
4651 mapping columns to either of the above:
4653 :lfmt Format for entire line, with enough %s to capture all fields.
4654 If this is present, :lstart, :lend, and :sep are ignored.
4655 :llfmt Format for the entire last line, defaults to :lfmt.
4656 :fmt A format to be used to wrap the field, should contain
4657 %s for the original field value. For example, to wrap
4659 This may also be a property list with column numbers and
4661 :hlstart :hllstart :hlend :hllend :hlsep :hlfmt :hllfmt :hfmt
4662 Same as above, specific for the header lines in the table.
4663 All lines before the first hline are treated as header.
4664 If any of these is not present, the data line value is used.
4666 This may be either a string or a function of two arguments:
4668 :efmt Use this format to print numbers with exponentials.
4669 The format should have %s twice for inserting mantissa
4671 may also be a property list with column numbers and
4672 formats. :fmt will still be applied after :efmt.
4674 In addition to this, the parameters :skip and :skipcols are always handled
4675 directly by `orgtbl-send-table'. See manual."
4676 (let* ((splicep (plist-get params :splice))
4677 (hline (plist-get params :hline))
4678 (skipheadrule (plist-get params :skipheadrule))
4679 (remove-nil-linesp (plist-get params :remove-nil-lines))
4680 (remove-newlines (plist-get params :remove-newlines))
4681 (*orgtbl-hline* hline)
4682 (*orgtbl-table* table)
4683 (*orgtbl-sep* (plist-get params :sep))
4684 (*orgtbl-efmt* (plist-get params :efmt))
4685 (*orgtbl-lstart* (plist-get params :lstart))
4686 (*orgtbl-llstart* (or (plist-get params :llstart) *orgtbl-lstart*))
4687 (*orgtbl-lend* (plist-get params :lend))
4688 (*orgtbl-llend* (or (plist-get params :llend) *orgtbl-lend*))
4689 (*orgtbl-lfmt* (plist-get params :lfmt))
4690 (*orgtbl-llfmt* (or (plist-get params :llfmt) *orgtbl-lfmt*))
4691 (*orgtbl-fmt* (plist-get params :fmt))
4692 *orgtbl-rtn*)
4694 ;; Put header
4695 (unless splicep
4696 (when (plist-member params :tstart)
4697 (let ((tstart (orgtbl-eval-str (plist-get params :tstart))))
4698 (if tstart (push tstart *orgtbl-rtn*)))))
4700 ;; Do we have a heading section? If so, format it and handle the
4701 ;; trailing hline.
4702 (if (and (not splicep)
4703 (or (consp (car *orgtbl-table*))
4704 (consp (nth 1 *orgtbl-table*)))
4705 (memq 'hline (cdr *orgtbl-table*)))
4706 (progn
4707 (when (eq 'hline (car *orgtbl-table*))
4708 ;; there is a hline before the first data line
4709 (and hline (push hline *orgtbl-rtn*))
4710 (pop *orgtbl-table*))
4711 (let* ((*orgtbl-lstart* (or (plist-get params :hlstart)
4712 *orgtbl-lstart*))
4713 (*orgtbl-llstart* (or (plist-get params :hllstart)
4714 *orgtbl-llstart*))
4715 (*orgtbl-lend* (or (plist-get params :hlend) *orgtbl-lend*))
4716 (*orgtbl-llend* (or (plist-get params :hllend)
4717 (plist-get params :hlend) *orgtbl-llend*))
4718 (*orgtbl-lfmt* (or (plist-get params :hlfmt) *orgtbl-lfmt*))
4719 (*orgtbl-llfmt* (or (plist-get params :hllfmt)
4720 (plist-get params :hlfmt) *orgtbl-llfmt*))
4721 (*orgtbl-sep* (or (plist-get params :hlsep) *orgtbl-sep*))
4722 (*orgtbl-fmt* (or (plist-get params :hfmt) *orgtbl-fmt*)))
4723 (orgtbl-format-section 'hline))
4724 (if (and hline (not skipheadrule)) (push hline *orgtbl-rtn*))
4725 (pop *orgtbl-table*)))
4727 ;; Now format the main section.
4728 (orgtbl-format-section nil)
4730 (unless splicep
4731 (when (plist-member params :tend)
4732 (let ((tend (orgtbl-eval-str (plist-get params :tend))))
4733 (if tend (push tend *orgtbl-rtn*)))))
4735 (mapconcat (if remove-newlines
4736 (lambda (tend)
4738 'identity)
4739 (nreverse (if remove-nil-linesp
4740 (remq nil *orgtbl-rtn*)
4743 ;;;###autoload
4744 (defun orgtbl-to-tsv (table params)
4745 "Convert the orgtbl-mode table to TAB separated material."
4747 ;;;###autoload
4748 (defun orgtbl-to-csv (table params)
4749 "Convert the orgtbl-mode table to CSV material.
4750 This does take care of the proper quoting of fields with comma or quotes."
4751 (orgtbl-to-generic table (org-combine-plists
4752 '(:sep "," :fmt org-quote-csv-field)
4753 params)))
4755 ;;;###autoload
4756 (defun orgtbl-to-latex (table params)
4757 "Convert the orgtbl-mode TABLE to LaTeX.
4758 TABLE is a list, each entry either the symbol `hline' for a horizontal
4759 separator line, or a list of fields for that line.
4760 PARAMS is a property list of parameters that can influence the conversion.
4761 Supports all parameters from `orgtbl-to-generic'. Most important for
4762 LaTeX are:
4764 :splice When set to t, return only table body lines, don't wrap
4765 them into a tabular environment. Default is nil.
4767 :fmt A format to be used to wrap the field, should contain %s for the
4768 original field value. For example, to wrap everything in dollars,
4771 The format may also be a function that formats its one argument.
4773 :efmt Format for transforming numbers with exponentials. The format
4774 should have %s twice for inserting mantissa and exponent, for
4776 This may also be a property list with column numbers and formats.
4777 The format may also be a function that formats its two arguments.
4779 :llend If you find too much space below the last line of a table,
4782 The general parameters :skip and :skipcols have already been applied when
4783 this function is called."
4784 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
4785 org-table-last-alignment ""))
4786 (params2
4787 (list
4792 (orgtbl-to-generic table (org-combine-plists params2 params))))
4794 ;;;###autoload
4795 (defun orgtbl-to-html (table params)
4796 "Convert the orgtbl-mode TABLE to HTML.
4797 TABLE is a list, each entry either the symbol `hline' for a horizontal
4798 separator line, or a list of fields for that line.
4799 PARAMS is a property list of parameters that can influence the conversion.
4800 Currently this function recognizes the following parameters:
4802 :splice When set to t, return only table body lines, don't wrap
4803 them into a <table> environment. Default is nil.
4805 The general parameters :skip and :skipcols have already been applied when
4806 this function is called. The function does *not* use `orgtbl-to-generic',
4807 so you cannot specify parameters for it."
4808 (require 'ox-html)
4809 (let ((output (org-export-string-as
4810 (orgtbl-to-orgtbl table nil) 'html t '(:with-tables t))))
4811 (if (not (plist-get params :splice)) output
4812 (org-trim
4813 (replace-regexp-in-string
4817 ;;;###autoload
4818 (defun orgtbl-to-texinfo (table params)
4819 "Convert the orgtbl-mode TABLE to TeXInfo.
4820 TABLE is a list, each entry either the symbol `hline' for a horizontal
4821 separator line, or a list of fields for that line.
4822 PARAMS is a property list of parameters that can influence the conversion.
4823 Supports all parameters from `orgtbl-to-generic'. Most important for
4824 TeXInfo are:
4826 :splice nil/t When set to t, return only table body lines, don't wrap
4827 them into a multitable environment. Default is nil.
4829 :fmt fmt A format to be used to wrap the field, should contain
4830 %s for the original field value. For example, to wrap
4832 This may also be a property list with column numbers and
4834 Each format also may be a function that formats its one
4835 argument.
4838 are computed automatically from the width of the columns
4839 under org-mode.
4841 The general parameters :skip and :skipcols have already been applied when
4842 this function is called."
4843 (let* ((total (float (apply '+ org-table-last-column-widths)))
4844 (colfrac (or (plist-get params :cf)
4845 (mapconcat
4846 (lambda (x) (format "%.3f" (/ (float x) total)))
4847 org-table-last-column-widths " ")))
4848 (params2
4849 (list
4850 :tstart (concat "@multitable @columnfractions " colfrac)
4851 :tend "@end multitable"
4852 :lstart "@item " :lend "" :sep " @tab "
4853 :hlstart "@headitem ")))
4854 (orgtbl-to-generic table (org-combine-plists params2 params))))
4856 ;;;###autoload
4857 (defun orgtbl-to-orgtbl (table params)
4858 "Convert the orgtbl-mode TABLE into another orgtbl-mode table.
4859 Useful when slicing one table into many. The :hline, :sep,
4860 :lstart, and :lend provide orgtbl framing. The default nil :tstart
4861 and :tend suppress strings without splicing; they can be set to
4862 provide ORGTBL directives for the generated table."
4863 (let* ((params2
4864 (list
4865 :remove-newlines t
4866 :tstart nil :tend nil
4867 :hline "|---"
4868 :sep " | "
4869 :lstart "| "
4870 :lend " |"))
4871 (params (org-combine-plists params2 params)))
4872 (with-temp-buffer
4873 (insert (orgtbl-to-generic table params))
4874 (goto-char (point-min))
4875 (while (re-search-forward org-table-hline-regexp nil t)
4876 (org-table-align))
4877 (buffer-substring 1 (buffer-size)))))
4879 (defun orgtbl-to-table.el (table params)
4880 "Convert the orgtbl-mode TABLE into a table.el table."
4881 (with-temp-buffer
4882 (insert (orgtbl-to-orgtbl table params))
4883 (org-table-align)
4884 (replace-regexp-in-string
4885 "-|" "-+"
4886 (replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
4888 (defun orgtbl-to-unicode (table params)
4889 "Convert the orgtbl-mode TABLE into a table with unicode characters.
4890 You need the ascii-art-to-unicode.el package for this. You can download
4891 it here: http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el."
4892 (with-temp-buffer
4893 (insert (orgtbl-to-table.el table params))
4894 (goto-char (point-min))
4895 (if (or (featurep 'ascii-art-to-unicode)
4896 (require 'ascii-art-to-unicode nil t))
4897 (aa2u)
4898 (unless (delq nil (mapcar (lambda (l) (string-match "aa2u" (car l))) org-stored-links))
4899 (push '("http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el"
4900 "Link to ascii-art-to-unicode.el") org-stored-links))
4901 (error "Please download ascii-art-to-unicode.el (use C-c C-l to insert the link to it)"))
4902 (buffer-string)))
4904 (defun org-table-get-remote-range (name-or-id form)
4905 "Get a field value or a list of values in a range from table at ID.
4907 NAME-OR-ID may be the name of a table in the current file as set by
4909 will then be used. Alternatively, it may be an ID referring to
4910 any entry, also in a different file. In this case, the first table
4911 in that entry will be referenced.
4915 The return value is either a single string for a single field, or a
4916 list of the fields in the rectangle ."
4917 (save-match-data
4918 (let ((case-fold-search t) (id-loc nil)
4919 ;; Protect a bunch of variables from being overwritten
4920 ;; by the context of the remote table
4921 org-table-column-names org-table-column-name-regexp
4922 org-table-local-parameters org-table-named-field-locations
4923 org-table-current-line-types org-table-current-begin-line
4924 org-table-current-begin-pos org-table-dlines
4925 org-table-current-ncol
4926 org-table-hlines org-table-last-alignment
4927 org-table-last-column-widths org-table-last-alignment
4928 org-table-last-column-widths tbeg
4929 buffer loc)
4930 (setq form (org-table-convert-refs-to-rc form))
4931 (save-excursion
4932 (save-restriction
4933 (widen)
4934 (save-excursion
4935 (goto-char (point-min))
4936 (if (re-search-forward
4938 nil t)
4939 (setq buffer (current-buffer) loc (match-beginning 0))
4940 (setq id-loc (org-id-find name-or-id 'marker))
4941 (unless (and id-loc (markerp id-loc))
4943 (setq buffer (marker-buffer id-loc)
4944 loc (marker-position id-loc))
4945 (move-marker id-loc nil)))
4946 (with-current-buffer buffer
4947 (save-excursion
4948 (save-restriction
4949 (widen)
4950 (goto-char loc)
4951 (forward-char 1)
4953 (not (match-beginning 1)))
4954 (error "Cannot find a table at NAME or ID %s" name-or-id))
4955 (setq tbeg (point-at-bol))
4956 (org-table-get-specials)
4957 (setq form (org-table-formula-substitute-names
4958 (org-table-formula-handle-first/last-rc form)))
4959 (if (and (string-match org-table-range-regexp form)
4960 (> (length (match-string 0 form)) 1))
4961 (save-match-data
4962 (org-table-get-range (match-string 0 form) tbeg 1))
4963 form)))))))))
4965 (defmacro org-define-lookup-function (mode)
4966 (let ((mode-str (symbol-name mode))
4967 (first-p (equal mode 'first))
4968 (all-p (equal mode 'all)))
4969 (let ((plural-str (if all-p "s" "")))
4970 `(defun ,(intern (format "org-lookup-%s" mode-str)) (val s-list r-list &optional predicate)
4971 ,(format "Find %s occurrence%s of VAL in S-LIST; return corresponding element%s of R-LIST.
4972 If R-LIST is nil, return matching element%s of S-LIST.
4973 If PREDICATE is not nil, use it instead of `equal' to match VAL.
4974 Matching is done by (PREDICATE VAL S), where S is an element of S-LIST.
4975 This function is generated by a call to the macro `org-define-lookup-function'."
4976 mode-str plural-str plural-str plural-str)
4977 (let ,(let ((lvars '((p (or predicate 'equal))
4978 (sl s-list)
4979 (rl (or r-list s-list))
4980 (ret nil))))
4981 (if first-p (add-to-list 'lvars '(match-p nil)))
4982 lvars)
4983 (while ,(if first-p '(and (not match-p) sl) 'sl)
4984 (progn
4985 (if (funcall p val (car sl))
4986 (progn
4987 ,(if first-p '(setq match-p t))
4988 (let ((rval (car rl)))
4989 (setq ret ,(if all-p '(append ret (list rval)) 'rval)))))
4990 (setq sl (cdr sl) rl (cdr rl))))
4991 ret)))))
4993 (org-define-lookup-function first)
4994 (org-define-lookup-function last)
4995 (org-define-lookup-function all)
4997 (provide 'org-table)
4999 ;; Local variables:
5000 ;; generated-autoload-file: "org-loaddefs.el"
5001 ;; End:
5003 ;;; org-table.el ends here