org-table: Field formulas can now create columns as needed

* org-table.el (org-table-formula-create-columns): New variable.
(org-table-recalculate): Use the new org-table-formula-make-new-cols
customization to control whether org creates new columns when
a formula explicitly targets them.
This commit is contained in:
Dima Kogan 2014-09-30 22:36:21 -07:00 committed by Nicolas Goaziou
parent c5016d55b6
commit 1c1f91811d
3 changed files with 94 additions and 3 deletions

View File

@ -90,6 +90,12 @@ docstrings (including ~orgtbl-to-generic~) for details.
*** Non-floating minted listings in Latex export
It is not possible to specify =#+attr_latex: :float nil= in conjunction with
source blocks exported by the minted package.
*** Field formulas can now create columns as needed
Previously, evaluating formulas that referenced out-of-bounds columns
would throw an error. A new variable
~org-table-formula-create-columns~ was added to adjust this
behavior. It is now possible to silently add new columns, to do so
with a warning or to explicitly ask the user each time.
** Miscellaneous
*** File names in links accept are now compatible with URI syntax
Absolute file names can now start with =///= in addition to =/=. E.g.,

View File

@ -354,6 +354,18 @@ portability of tables."
(const :tag "Stick to hline" nil)
(const :tag "Error on attempt to cross" error)))
(defcustom org-table-formula-create-columns nil
"Non-nil means that evaluation of a field formula can add new
columns if an out-of-bounds field is being set."
:group 'org-table-calculation
:version "24.5"
:package-version '(Org . "8.3")
:type '(choice
(const :tag "Setting an out-of-bounds field generates an error (default)" nil)
(const :tag "Setting an out-of-bounds field silently adds columns as needed" t)
(const :tag "Setting an out-of-bounds field adds columns as needed, but issues a warning message" warn)
(const :tag "When setting an out-of-bounds field, the user is prompted" prompt)))
(defgroup org-table-import-export nil
"Options concerning table import and export in Org-mode."
:tag "Org Table Import Export"
@ -3125,9 +3137,26 @@ known that the table will be realigned a little later anyway."
(while (setq eq (pop eqlname1))
(message "Re-applying formula to field: %s" (car eq))
(org-goto-line (nth 1 eq))
(org-table-goto-column (nth 2 eq))
(org-table-eval-formula nil (nth 3 eq) 'noalign 'nocst
'nostore 'noanalysis))
(let ((column-target (nth 2 eq)))
(when (> column-target 1000)
(user-error "Formula column target too large"))
(let* ((column-count (progn (end-of-line)
(1- (org-table-current-column))))
(create-new-column
(and (> column-target column-count)
(or (eq org-table-formula-create-columns t)
(and
(eq org-table-formula-create-columns 'warn)
(progn
(org-display-warning "Out-of-bounds formula added columns")
t))
(and
(eq org-table-formula-create-columns 'prompt)
(yes-or-no-p "Out-of-bounds formula. Add columns?"))))))
(org-table-goto-column column-target nil create-new-column))
(org-table-eval-formula nil (nth 3 eq) 'noalign 'nocst
'nostore 'noanalysis)))
(org-goto-line thisline)
(org-table-goto-column thiscol)

View File

@ -1554,6 +1554,62 @@ See also `test-org-table/copy-field'."
(progn (search-forward "# END RECEIVE ORGTBL table")
(match-beginning 0)))))))
(ert-deftest test-org-table/field-formula-outside-table ()
"If `org-table-formula-create-columns' is nil, then a formula
that references an out-of-bounds column should do nothing. If it
is t, then new columns should be added as needed"
(let ((org-table-formula-create-columns nil))
;; need condition-case to trap the out-of-bounds user-error
(condition-case
nil
(org-test-table-target-expect
"
| 2 |
| 4 |
| 8 |
"
"
| 2 |
| 4 |
| 8 |
"
1
"#+TBLFM: @1$2=5")
('user-error t)))
(let ((org-table-formula-create-columns t))
;; make sure field formulas work
(org-test-table-target-expect
"
| 2 |
| 4 |
| 8 |
"
"
| 2 | 5 |
| 4 | |
| 8 | |
"
1
"#+TBLFM: @1$2=5")
;; and make sure column formulas work too
(org-test-table-target-expect
"
| 2 |
| 4 |
| 8 |
"
"
| 2 | | 15 |
| 4 | | 15 |
| 8 | | 15 |
"
1
"#+TBLFM: $3=15")))
(provide 'test-org-table)