[elpa] 01/07: For #70: New navigation command to move to start file

[Leo Liu]

leoliu pushed a commit to branch master
in repository elpa.

commit 24fdf7ecd721f117976f2310a2db02dea4e33d85
Author: Leo Liu <address@hidden>
Date:   Thu Oct 2 10:36:27 2014 +0800

    For #70: New navigation command to move to start file
---
 README.rst |   10 +++++++++-
 ggtags.el  |   43 +++++++++++++++++++++++++++++++++++--------
 2 files changed, 44 insertions(+), 9 deletions(-)

diff --git a/README.rst b/README.rst
index fc0b9bb..909a113 100644
--- a/README.rst
+++ b/README.rst
@@ -194,6 +194,10 @@ turned on to facilitate locating the right match.
 
    Move to previous file.
 
+``M-=``
+
+   Move to the file where navigation session starts
+
 ``M-<``
 
    Move to the first match.
@@ -304,12 +308,16 @@ Integration with other packages
 NEWS
 ~~~~
 
+(devel) 0.8.7
++++++++++++++
+
+#. New navigation command ``ggtags-navigation-start-file``.
+
 [2014-09-12 Fri] 0.8.6
 ++++++++++++++++++++++
 
 #. ``ggtags-show-definition`` shows definition with font locking.
 
-
 [2014-06-22 Sun] 0.8.5
 ++++++++++++++++++++++
 
diff --git a/ggtags.el b/ggtags.el
index 4ba68ab..4ea03f2 100644
--- a/ggtags.el
+++ b/ggtags.el
@@ -3,7 +3,7 @@
 ;; Copyright (C) 2013-2014  Free Software Foundation, Inc.
 
 ;; Author: Leo Liu <address@hidden>
-;; Version: 0.8.6
+;; Version: 0.8.7
 ;; Keywords: tools, convenience
 ;; Created: 2013-01-29
 ;; URL: https://github.com/leoliu/ggtags
@@ -827,6 +827,7 @@ Do nothing if GTAGS exceeds the oversize limit unless 
FORCE."
 ;; Can be three values: nil, t and a marker; t means start marker has
 ;; been saved in the tag ring.
 (defvar ggtags-global-start-marker nil)
+(defvar ggtags-global-start-file nil)
 (defvar ggtags-tag-ring-index nil)
 (defvar ggtags-global-search-history nil)
 
@@ -846,6 +847,8 @@ Do nothing if GTAGS exceeds the oversize limit unless 
FORCE."
          (env ggtags-process-environment))
     (unless (markerp ggtags-global-start-marker)
       (setq ggtags-global-start-marker (point-marker)))
+    ;; Record the file name for `ggtags-navigation-start-file'.
+    (setq ggtags-global-start-file buffer-file-name)
     (setq ggtags-auto-jump-to-match-target
           (nth 4 (assoc (ggtags-global-search-id command default-directory)
                         ggtags-global-search-history)))
@@ -1001,6 +1004,20 @@ When called interactively with a prefix, ask for the 
directory."
 
 (defvar ggtags-navigation-mode)
 
+(defun ggtags-foreach-file (fn)
+  "Invoke FN with each file found.
+FN is invoked while *ggtags-global* buffer is current."
+  (ggtags-ensure-global-buffer
+    (save-excursion
+      (goto-char (point-min))
+      (while (with-demoted-errors "compilation-next-error: %S"
+               (compilation-next-error 1 'file)
+               t)
+        (funcall fn (caar
+                     (compilation--loc->file-struct
+                      (compilation--message->loc
+                       (get-text-property (point) 'compilation-message)))))))))
+
 (defun ggtags-query-replace (from to &optional delimited)
   "Query replace FROM with TO on files in the Global buffer.
 If not in navigation mode, do a grep on FROM first.
@@ -1020,13 +1037,8 @@ Global and Emacs."
               (ggtags-with-temp-message "Waiting for Grep to finish..."
                 (while (get-buffer-process (current-buffer))
                   (sit-for 0.2)))
-              (goto-char (point-min))
-              (while (ignore-errors (compilation-next-file 1) t)
-                (let ((m (get-text-property (point) 'compilation-message)))
-                  (push (expand-file-name
-                         (caar (compilation--loc->file-struct
-                                (compilation--message->loc m))))
-                        files))))
+              (ggtags-foreach-file
+               (lambda (file) (push (expand-file-name file) files))))
             (ggtags-navigation-mode -1)
             (nreverse files))))
     (tags-query-replace from to delimited file-form)))
@@ -1627,6 +1639,7 @@ commands `next-error' and `previous-error'.
     (define-key map "\M-p" 'previous-error)
     (define-key map "\M-}" 'ggtags-navigation-next-file)
     (define-key map "\M-{" 'ggtags-navigation-previous-file)
+    (define-key map "\M-=" 'ggtags-navigation-start-file)
     (define-key map "\M->" 'ggtags-navigation-last-error)
     (define-key map "\M-<" 'first-error)
     ;; Note: shadows `isearch-forward-regexp' but it can still be
@@ -1736,6 +1749,20 @@ commands `next-error' and `previous-error'.
   (interactive "p")
   (ggtags-navigation-next-file (- n)))
 
+(defun ggtags-navigation-start-file ()
+  "Move to the file where navigation session starts."
+  (interactive)
+  (let ((start-file (or ggtags-global-start-file
+                        (user-error "Cannot decide start file"))))
+    (ggtags-ensure-global-buffer
+      (pcase (cl-block nil
+               (ggtags-foreach-file
+                (lambda (file)
+                  (when (file-equal-p file start-file)
+                    (cl-return (point))))))
+        (`nil (user-error "No matches for `%s'" start-file))
+        (n (goto-char n) (compile-goto-error))))))
+
 (defun ggtags-navigation-last-error ()
   (interactive)
   (ggtags-ensure-global-buffer