emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Alexey Lebedeff <binarin@gmail.com>
To: emacs-orgmode@gnu.org
Subject: [PATCH] Fix property name completion
Date: Mon, 17 Aug 2015 12:13:05 +0300	[thread overview]
Message-ID: <CADOt_n8T90uqexy5QW3Hte_9nY9nuvLQNE3r+JDZvYaMEgXu8g@mail.gmail.com> (raw)


[-- Attachment #1.1: Type: text/plain, Size: 253 bytes --]

Hi all,

When property name completion is being performed, it means that we are
inside malformed property drawer that will become valid only after
successful completion. In this case in makes no sense to perform
interactive drawer repair.

Best,
Alexey

[-- Attachment #1.2: Type: text/html, Size: 374 bytes --]

[-- Attachment #2: 0001-Fix-property-name-completion.patch --]
[-- Type: text/x-patch, Size: 5866 bytes --]

From 926fe940f04cd94cdc0b06e50a485e65d35e903a Mon Sep 17 00:00:00 2001
From: Alexey Lebedeff <binarin@gmail.com>
Date: Mon, 17 Aug 2015 12:04:43 +0300
Subject: [PATCH] Fix property name completion

* lisp/org-pcomplete.el (pcomplete/org-mode/prop): Add
  `ignore-malformed' argument in call to `org-buffer-property-keys'

* lisp/org.el (org-buffer-property-keys): Add support for new argument
  `ignore-malformed'.

* testing/lisp/test-org-pcomplete.el: Add new file for testing
  `pcomplete' integration.

* testing/lisp/test-org.el (test-org/buffer-property-keys): Test
  behaviour of `org-buffer-property-keys' with new `ignore-malformed'
  argument.

When property name completion is being performed, it means that we are
inside malformed property drawer that will become valid only after
successful completion. In this case in makes no sense to perform
interactive drawer repair.

TINYCHANGE
---
 lisp/org-pcomplete.el              |  2 +-
 lisp/org.el                        | 10 ++++++---
 testing/lisp/test-org-pcomplete.el | 44 ++++++++++++++++++++++++++++++++++++++
 testing/lisp/test-org.el           |  8 ++++++-
 4 files changed, 59 insertions(+), 5 deletions(-)
 create mode 100644 testing/lisp/test-org-pcomplete.el

diff --git a/lisp/org-pcomplete.el b/lisp/org-pcomplete.el
index 05683fe..7706725 100644
--- a/lisp/org-pcomplete.el
+++ b/lisp/org-pcomplete.el
@@ -357,7 +357,7 @@ This needs more work, to handle headings with lots of spaces in them."
 	     (concat x ": "))
 	   (let ((lst (pcomplete-uniqify-list
 		       (copy-sequence
-			(org-buffer-property-keys nil t t)))))
+			(org-buffer-property-keys nil t t t)))))
 	     (dolist (prop (org-entry-properties))
 	       (setq lst (delete (car prop) lst)))
 	     lst))
diff --git a/lisp/org.el b/lisp/org.el
index 9336183..b018f72 100755
--- a/lisp/org.el
+++ b/lisp/org.el
@@ -16128,7 +16128,7 @@ decreases scheduled or deadline date by one day."
 	  (org-indent-line)))))
     (run-hook-with-args 'org-property-changed-functions property value)))
 
-(defun org-buffer-property-keys (&optional specials defaults columns)
+(defun org-buffer-property-keys (&optional specials defaults columns ignore-malformed)
   "Get all property keys in the current buffer.
 
 When SPECIALS is non-nil, also list the special properties that
@@ -16139,7 +16139,10 @@ special meaning internally: ARCHIVE, CATEGORY, SUMMARY,
 DESCRIPTION, LOCATION, and LOGGING and others.
 
 When COLUMNS in non-nil, also include property names given in
-COLUMN formats in the current buffer."
+COLUMN formats in the current buffer.
+
+When IGNORE-MALFORMED is non-nil, malformed drawer repair will not be
+automatically performed, such drawers will be silently ignored."
   (let ((case-fold-search t)
 	(props (append
 		(and specials org-special-properties)
@@ -16151,7 +16154,8 @@ COLUMN formats in the current buffer."
        (let ((range (org-get-property-block)))
 	 (catch 'skip
 	   (unless range
-	     (when (and (not (org-before-first-heading-p))
+	     (when (and (not ignore-malformed)
+			(not (org-before-first-heading-p))
 			(y-or-n-p (format "Malformed drawer at %d, repair?"
 					  (line-beginning-position))))
 	       (org-get-property-block nil t))
diff --git a/testing/lisp/test-org-pcomplete.el b/testing/lisp/test-org-pcomplete.el
new file mode 100644
index 0000000..fa463a2
--- /dev/null
+++ b/testing/lisp/test-org-pcomplete.el
@@ -0,0 +1,44 @@
+;;; test-org-pcomplete.el --- test pcomplete integration
+
+;; Copyright (C) 2015  Alexey Lebedeff
+;; Authors: Alexey Lebedeff
+
+;; This file is not part of GNU Emacs.
+
+;; This program is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+
+;; This program is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;; GNU General Public License for more details.
+
+;; You should have received a copy of the GNU General Public License
+;; along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+;;; Comments:
+
+\f
+
+;;; Code:
+
+(ert-deftest test-org-pcomplete/prop ()
+  "Test property completion behaviour in an Org buffer"
+
+  ;; Drawer where we are currently completing property name is
+  ;; malformed in any case, it'll become valid only after successful
+  ;; completion. We expect that this completion process will finish
+  ;; successfully, and there will be no interactive drawer repair
+  ;; attempts.
+  (should
+   (equal
+    "* a\n:PROPERTIES:\n:pname: \n:END:\n* b\n:PROPERTIES:\n:pname: pvalue\n:END:\n"
+    (org-test-with-temp-text "* a\n:PROPERTIES:\n:pna<point>\n:END:\n* b\n:PROPERTIES:\n:pname: pvalue\n:END:\n"
+      (flet ((y-or-n-p (prompt) (error "Should not be called")))
+	(pcomplete))
+      (buffer-string)))))
+
+(provide 'test-org-pcomplete)
+;;; test-org-pcomplete.el ends here
diff --git a/testing/lisp/test-org.el b/testing/lisp/test-org.el
index 5b80c48..9eee75b 100644
--- a/testing/lisp/test-org.el
+++ b/testing/lisp/test-org.el
@@ -3151,7 +3151,13 @@ Paragraph<point>"
    (equal '("A" "B" "COLUMNS")
 	  (org-test-with-temp-text
 	      "* H\n:PROPERTIES:\n:COLUMNS: %25ITEM %A %20B\n:END:"
-	    (org-buffer-property-keys nil nil t)))))
+	    (org-buffer-property-keys nil nil t))))
+  ;; With non-nil IGNORE-MALFORMED malformed property drawers are silently ignored.
+  (should
+   (equal '("A")
+	  (org-test-with-temp-text
+	      "* a\n:PROPERTIES:\n:A: 1\n:END:\n* b\n:PROPERTIES:\nsome junk here\n:END:\n"
+	    (org-buffer-property-keys nil nil nil t)))))
 
 (ert-deftest test-org/property-values ()
   "Test `org-property-values' specifications."
-- 
2.5.0


             reply	other threads:[~2015-08-17  9:13 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-08-17  9:13 Alexey Lebedeff [this message]
2015-08-18 15:46 ` [PATCH] Fix property name completion Bastien
2015-12-29 10:20   ` Alexey Lebedeff
2015-12-29 10:35     ` Bastien Guerry
2015-12-29 20:56     ` Nicolas Goaziou

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=CADOt_n8T90uqexy5QW3Hte_9nY9nuvLQNE3r+JDZvYaMEgXu8g@mail.gmail.com \
    --to=binarin@gmail.com \
    --cc=emacs-orgmode@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).