summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDima Kogan <dima@secretsauce.net>2014-09-30 22:36:21 -0700
committerNicolas Goaziou <mail@nicolasgoaziou.fr>2014-10-12 11:11:57 +0200
commit1c1f91811d0348c4948ab59abb007bdf9dce78e9 (patch)
tree86b25f6d2b47211c8d27fd14e877f2c70cb965f4
parentc5016d55b6425c1e19f7f951958c0a47decddacf (diff)
downloadorg-mode-1c1f91811d0348c4948ab59abb007bdf9dce78e9.tar.gz
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.
-rw-r--r--etc/ORG-NEWS6
-rw-r--r--lisp/org-table.el35
-rw-r--r--testing/lisp/test-org-table.el56
3 files changed, 94 insertions, 3 deletions
diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS
index 1af54ad..0a5af68 100644
--- a/etc/ORG-NEWS
+++ b/etc/ORG-NEWS
@@ -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.,
diff --git a/lisp/org-table.el b/lisp/org-table.el
index d8b9235..6aeae4d 100644
--- a/lisp/org-table.el
+++ b/lisp/org-table.el
@@ -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)
diff --git a/testing/lisp/test-org-table.el b/testing/lisp/test-org-table.el
index 7d1ce14..e617989 100644
--- a/testing/lisp/test-org-table.el
+++ b/testing/lisp/test-org-table.el
@@ -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)