plugins/project-buffer-occur.el

   1 ;;; project-buffer-occur.el --- Occur functionality for Project Mode
   2 ;;
   3 ;; Author:      Cedric Lallain <kandjar76@hotmail.com>
   4 ;; Version:     1.1
   5 ;; Keywords:    occur project buffer makefile filesystem management
   6 ;; Description: Occur Functionality for Project-Buffer-Mode
   7 ;; Tested with: GNU Emacs 22.x and GNU Emacs 23.x
   8 ;;
   9 ;; This file is *NOT* part of GNU Emacs.
  10 ;;
  11 ;;    This program 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 2 of the License, or
  14 ;;    (at your option) any later version.
  15 ;;
  16 ;;    This program 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.
  20 ;;
  21 ;;    You should have received a copy of the GNU General Public License
  22 ;;    along with this program; if not, write to the Free Software
  23 ;;    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  24 ;;
  25
  26 ;;; Summary:
  27 ;;
  28
  29 ;; This is an extension for project-buffer-mode.
  30 ;;
  31 ;; Provide a 'occur' like functionality for project-buffer-mode.
  32 ;;
  33
  34
  35 ;;; Commentary:
  36 ;;
  37
  38 ;; HOW TO USE IT:
  39 ;;
  40 ;; Call the command `project-buffer-occur' in a project-buffer-mode buffer.
  41 ;;
  42 ;; The research will occur in all marked files; or in all files
  43 ;; belonging to the current project if there are no files.  Using the
  44 ;; prefix argument, the research will be done in all files.
  45 ;;
  46 ;;
  47 ;; TO INSTALL IT:
  48 ;;
  49 ;; Put the following lines in your .emacs:
  50 ;;
  51 ;; (eval-after-load "project-buffer-mode"
  52 ;;  '(progn
  53 ;;    (require 'project-buffer-occur)
  54 ;;    (define-key project-buffer-mode-map [(control ?f)] 'project-buffer-occur)))
  55 ;;
  56 ;;
  57 ;; KEY BINDINGS:
  58 ;;
  59 ;; <RET> - goto-occurence
  60 ;;  o    - goto-occurence other window
  61 ;;  v    - display occurrence
  62 ;;  n    - next occurence / prev search occurrence
  63 ;;  p    - prev occurence / next search occurrence
  64 ;;  M-n  - go to next file
  65 ;;  M-p  - go to prev file
  66 ;;  C-n  - go to next occurrence and display it
  67 ;;  C-p  - go to the previous occurrence and display it
  68 ;;  r    - rename buffer
  69 ;;  g    - refresh the research
  70 ;;  d    - delete the current line
  71 ;;  q    - quit-window
  72 ;;  ?    - show brief help
  73
  74
  75 ;;; History:
  76 ;;
  77 ;; v1.0: First official release.
  78 ;; v1.1: Fix bug:
  79 ;;       - (goto-char (point-min)) was not working.
  80 ;;       - file-name weren't attached properly to the occurrences
  81 ;;       - non-existing files were stopping the research / they are now skipped.
  82 ;;
  83
  84
  85 (require 'project-buffer-mode)
  86
  87
  88
  89 ;;; Code:
  90
  91
  92 (defgroup project-buffer-occur nil
  93   "An occur mode for project-buffer.")
  94
  95
  96
  97 ;;
  98 ;;  Global configuration variable:
  99 ;;
 100
 101
 102 (defvar project-buffer-occur-context-size 32
 103   "Size of the context stored for each occurrence; to help retrieving the data after modification.")
 104
 105
 106 (defface project-buffer-occur-file-line
 107   '((((class color) (background light)) (:foreground "blue"))
 108     (((class color) (background dark)) (:foreground "yellow")))
 109   "Project buffer occur face used to highlight file line."
 110   :group 'project-buffer-occur)
 111
 112
 113 (defface project-buffer-occur-line-number
 114   '((((class color) (background light)) (:foreground "red"))
 115     (((class color) (background dark)) (:foreground "cyan")))
 116   "Project buffer occur face used to highlight line number."
 117   :group 'project-buffer-occur)
 118
 119
 120 (defface project-buffer-occur-odd-matching-line
 121   '((((class color) (background light)) (:foreground "black"))
 122     (((class color) (background dark)) (:foreground "white")))
 123   "Project buffer occur face used to highlight odd matching line."
 124   :group 'project-buffer-occur)
 125
 126
 127 (defface project-buffer-occur-even-matching-line
 128   '((((class color) (background light)) (:foreground "gray60"))
 129     (((class color) (background dark)) (:foreground "gray")))
 130   "Project buffer occur face used to highlight even matching line."
 131   :group 'project-buffer-occur)
 132
 133
 134 (defface project-buffer-occur-highlight-matching-string
 135   '((((class color) (background light)) (:background "yellow"))
 136     (((class color) (background dark)) (:background "yellow")))
 137   "Project buffer occur face used to highlight the matching string."
 138   :group 'project-buffer-occur)
 139
 140
 141 (defcustom project-buffer-occur-mode-hook nil
 142   "Post `project-buffer-occur-mode' initialization hook."
 143   :type 'hook
 144   :group 'project-buffer-occur)
 145
 146
 147
 148 ;;
 149 ;;  Local variables:
 150 ;;
 151
 152
 153 (defvar project-buffer-occur-saved-project-buffer nil)
 154 (defvar project-buffer-occur-saved-regexp nil)
 155
 156
 157
 158 ;;
 159 ;;  Key Bindings:
 160 ;;
 161
 162
 163 ;; Define the key mapping for the spu mode:
 164 (defvar project-buffer-occur-map
 165   (let ((project-buffer-occur-map (make-keymap)))
 166     (define-key project-buffer-occur-map [return] 'project-buffer-occur-goto-occurrence)
 167     (define-key project-buffer-occur-map [?o] 'project-buffer-occur-goto-occurrence-other-window)
 168     (define-key project-buffer-occur-map [?v] 'project-buffer-occur-view-occurrence)
 169     (define-key project-buffer-occur-map [?n] 'project-buffer-occur-next-occurrence)
 170     (define-key project-buffer-occur-map [?p] 'project-buffer-occur-previous-occurrence)
 171     (define-key project-buffer-occur-map [(meta ?n)] 'project-buffer-occur-next-file)
 172     (define-key project-buffer-occur-map [(meta ?p)] 'project-buffer-occur-previous-file)
 173     (define-key project-buffer-occur-map [(control ?n)] 'project-buffer-occur-view-next-occurrence)
 174     (define-key project-buffer-occur-map [(control ?p)] 'project-buffer-occur-view-previous-occurrence)
 175     (define-key project-buffer-occur-map [?d] 'project-buffer-occur-delete-line)
 176     (define-key project-buffer-occur-map [?q] 'quit-window)
 177     (define-key project-buffer-occur-map [?r] 'project-buffer-occur-rename-buffer)
 178     (define-key project-buffer-occur-map [?g] 'project-buffer-occur-refresh)
 179     (define-key project-buffer-occur-map [??] 'project-buffer-occur-help)
 180     (define-key project-buffer-occur-map [mouse-2] 'project-buffer-occur-mouse-find-file)
 181     project-buffer-occur-map))
 182
 183
 184 ;;
 185 ;;  Functions:
 186 ;;
 187
 188
 189 (defun project-buffer-occur-clear-overlays()
 190   "Clear the project-buffer-occur overlays from the current buffer."
 191   (let ((ovl-lists (overlay-lists)))
 192     (mapcar (lambda (overlay)
 193               (when (overlay-get overlay 'project-buffer-occur-tag)
 194                 (delete-overlay overlay)))
 195             (and ovl-lists
 196                  (append (car ovl-lists) (cdr ovl-lists))))))
 197
 198
 199 (defun project-buffer-occur-get-and-clear-occur-buffer()
 200   "Retrieve the occur buffer and returns it.
 201 If the buffer exists; the buffer is cleared.  If the buffer
 202 doesn't exist, a new buffer is created and initialized with
 203 project-buffer-occur-major-mode."
 204   (let ((buffer (get-buffer-create "*Project-Buffer-Occur*")))
 205     (with-current-buffer buffer
 206       (let ((inhibit-read-only t))
 207         (project-buffer-occur-clear-overlays)
 208         (erase-buffer))
 209       (project-buffer-occur-mode))
 210     buffer))
 211
 212
 213 (defun project-buffer-occur-add-occurrence(file occurrence occurrence-num regexp)
 214   "Add an OCCURRENCE from FILE in the buffer.
 215
 216 FILE should be the file in which the occurrence has been found,
 217 OCCURRENCE is a list of (#line matching-line before-string after-string).
 218 OCCURRENCE-NUM represents the OCCURENCE-NUM'th occurrence found in FILE"
 219
 220   (let ((occ-line-num   (car occurrence))
 221         (occ-line-str   (nth 1 occurrence))
 222         (occ-before-str (nth 2 occurrence))
 223         (occ-after-str  (nth 3 occurrence))
 224         (start-pos      (point))
 225         (cur-line       (line-number-at-pos (point))))
 226     (insert (propertize (format "%8i:" occ-line-num)
 227                         'follow-link t
 228                         'mouse-face 'highlight
 229                         'face 'project-buffer-occur-line-number))
 230     (insert " ")
 231     (insert (propertize occ-line-str
 232                         'follow-link t
 233                         'mouse-face 'highlight
 234                         'face (if (oddp occurrence-num)
 235                                   'project-buffer-occur-odd-matching-line
 236                                   'project-buffer-occur-even-matching-line)))
 237     (when (not (= (point) (point-at-bol)))
 238       (insert "\n"))
 239
 240     ;; Highlight matching string:
 241     (goto-char start-pos)
 242     (forward-char 10) ; skip the line number
 243     (while (re-search-forward regexp nil t)
 244       (let ((overlay (make-overlay (match-beginning 0) (match-end 0))))
 245         (overlay-put overlay 'face 'project-buffer-occur-highlight-matching-string)
 246         (overlay-put overlay 'project-buffer-occur-tag t)
 247         ))
 248
 249     ;; Fix the indentation:
 250     (goto-char (point-max))
 251     (forward-line -1)
 252     (while (not (= cur-line (line-number-at-pos (point))))
 253       (goto-char (point-at-bol))
 254       (insert (propertize (make-string 10 32)
 255                           'follow-link t
 256                           'mouse-face 'highlight))
 257       (forward-line -1))
 258
 259     ;; Data overlay:
 260     (let ((overlay (make-overlay start-pos (point-max))))
 261       (overlay-put overlay 'project-buffer-occur-tag t)
 262       (overlay-put overlay 'project-buffer-occur-context (list file occurrence regexp)))
 263     (goto-char (point-max))))
 264
 265
 266 (defun project-buffer-occur-collect-occurrences(regexp)
 267   "Create a list of occurrences by searching REGEXP in the current buffer.
 268
 269 The return value is a list of ( line# matching-line before-string
 270 after-string ).  This function doesn't save the position and
 271 assume the position will be saved and restored by the caller if
 272 required."
 273   (goto-char (point-min))
 274   (save-match-data
 275     (let (occurrences
 276           next-start
 277           occ-beg
 278           occ-end
 279           occ-bol
 280           occ-eol
 281           occ-line-num
 282           occ-line-str
 283           occ-before-str
 284           occ-after-str)
 285       (setq next-start (re-search-forward regexp nil t))
 286       (while next-start
 287         ;; Collect the data for this occcurrence:
 288         ;;  consider using: jit-lock-fontify-now! To get colors on the line...
 289         (setq occ-beg (match-beginning 0))
 290         (setq occ-end (match-end 0))
 291         (goto-char occ-beg)
 292         (setq occ-bol (point-at-bol))
 293         (setq occ-line-num (line-number-at-pos))
 294         (goto-char occ-end)
 295         (setq occ-eol (point-at-eol))
 296         (setq occ-line-str (buffer-substring-no-properties occ-bol occ-eol))
 297         (setq occ-after-str (and (>= (- (point-max) occ-eol) project-buffer-occur-context-size)
 298                                  (buffer-substring-no-properties occ-eol (+ occ-eol project-buffer-occur-context-size))))
 299         (setq occ-before-str (and (>= (- occ-bol (point-min)) project-buffer-occur-context-size)
 300                                   (buffer-substring-no-properties (- occ-bol project-buffer-occur-context-size) occ-bol)))
 301         ;; Add the occurrence to the list unless it occurs on the same line.
 302         (unless (eq occ-line-num (car (car occurrences)))
 303           (setq occurrences (cons (list occ-line-num occ-line-str occ-before-str occ-after-str)
 304                                   occurrences)))
 305         ;; Carry on:
 306         (goto-char next-start)
 307         (setq next-start (re-search-forward regexp nil t)))
 308       (reverse occurrences))))
 309
 310
 311 (defun project-buffer-occur-research(project-file-name file-path project-name regexp occur-buffer)
 312   "Research REGEXP in FILE-PATH and fill OCCUR-BUFFER with the
 313 different occurences found.
 314 PROJECT-FILE-NAME and PROJECT-NAME are ignored."
 315   (let (occurrences)
 316     (message "Project '%s' -- Searching in '%s'" project-name file-path)
 317     ;; Collect all occurrences in this file:
 318     (let ((file-buf (get-file-buffer file-path)))
 319       (if file-buf
 320           (with-current-buffer file-buf
 321             (save-excursion
 322               (setq occurrences (project-buffer-occur-collect-occurrences regexp))))
 323           (when (file-exists-p file-path)
 324             (with-temp-buffer
 325               (insert-file-contents file-path)
 326               (setq occurrences (project-buffer-occur-collect-occurrences regexp))))))
 327
 328     ;; Then populate the occurr buffer with it:
 329     (when occurrences
 330       (with-current-buffer occur-buffer
 331         (let ((inhibit-read-only t))
 332           (goto-char (point-max))
 333           (let ((start-pos (point)))
 334                 (insert (propertize (format "%i occurrence%s found in %s/%s"
 335                                             (length occurrences)
 336                                             (if (= 1 (length occurrences)) "" "s")
 337                                             project-name
 338                                             project-file-name)
 339                                     'follow-link t
 340                                     'mouse-face 'highlight
 341                                     'face 'project-buffer-occur-file-line))
 342                 (let ((overlay (make-overlay start-pos (point))))
 343                   (overlay-put overlay 'project-buffer-occur-tag t)
 344                   (overlay-put overlay 'project-buffer-occur-context (list file-path nil regexp))))
 345           (insert "\n")
 346           (let ((occ-count 1))
 347             (while occurrences
 348               (let ((occurrence (pop occurrences)))
 349                 (project-buffer-occur-add-occurrence file-path occurrence occ-count regexp)
 350                 (setq occ-count (1+ occ-count))))))))))
 351
 352
 353 (defun project-buffer-occur-mode()
 354   "Major mode for output from `project-buffer-occur'
 355
 356 Commands:
 357 \\{project-buffer-mode-map}"
 358   (kill-all-local-variables)
 359   (use-local-map project-buffer-occur-map)
 360   ;;
 361   (setq major-mode 'project-buffer-occur-mode)
 362   (setq mode-name "pbm-occur")
 363   ;;
 364   (make-local-variable 'project-buffer-occur-saved-project-buffer)
 365   (make-local-variable 'project-buffer-occur-saved-regexp)
 366   ;;
 367   (setq buffer-read-only t)
 368   (setq buffer-undo-list t) ; disable undo recording
 369   (run-mode-hooks 'project-buffer-occur-mode-hook))
 370
 371
 372 (defun project-buffer-occur-goto-file(file &optional other-window)
 373   "Go to the selected files."
 374   (if other-window
 375       (find-file-other-window file)
 376       (find-file file)))
 377
 378
 379 (defun project-buffer-occur-highlight-current(regexp start end)
 380   "Highlight all occurrences of REGEXP between START adn END points"
 381   (let (ovl-list)
 382     (unwind-protect
 383         (save-match-data
 384           (save-excursion
 385             (goto-char start)
 386             (while (re-search-forward regexp end t)
 387               (let ((overlay (make-overlay (match-beginning 0) (match-end 0))))
 388                 (overlay-put overlay 'face 'project-buffer-occur-highlight-matching-string)
 389                 (overlay-put overlay 'project-buffer-occur-tag t)
 390                 (setq ovl-list (cons overlay ovl-list)))))
 391           (sit-for 10))
 392       (mapcar (lambda (overlay)
 393                 (delete-overlay overlay))
 394               ovl-list))))
 395
 396
 397 (defun project-buffer-occur-goto-matching-string(file line matching-line before-string after-string regexp &optional other-window)
 398   "Go to an occurrence."
 399   (let* ((buffer (find-file-noselect file))
 400         (window (get-buffer-window buffer)))
 401     (if window
 402         (progn (select-window window)
 403                (set-buffer buffer))
 404         (if other-window
 405             (switch-to-buffer-other-window buffer)
 406             (switch-to-buffer buffer)))
 407     (save-restriction
 408       (widen)
 409       (goto-char (point-min))
 410       (forward-line (1- line)))
 411
 412     ;;
 413     (let ((cur-pt (point))
 414           (end-pt (+ (point) (length matching-line) 1))
 415           aft-pt
 416           bef-pt
 417           found)
 418       (when (and after-string (search-forward after-string nil t))
 419         (setq aft-pt (match-beginning 0))
 420         (goto-char aft-pt))
 421       (when (and before-string (search-backward before-string nil t))
 422         (setq bef-pt (match-end 0))
 423         (goto-char bef-pt))
 424
 425       (cond
 426        ((and aft-pt bef-pt)
 427         (if (search-forward matching-line aft-pt t)
 428             (progn (goto-char (match-beginning 0))
 429                    (goto-char (point-at-bol)))
 430             (if (re-search-forward regexp aft-pt t)
 431                 (progn (goto-char (match-beginning 0))
 432                        (goto-char (point-at-bol)))
 433                 (goto-char cur-pt))))
 434        (aft-pt
 435         (goto-char cur-pt)
 436         (if (search-forward matching-line aft-pt t)
 437             (progn (goto-char (match-beginning 0))
 438                    (goto-char (point-at-bol)))
 439             (if (re-search-forward regexp aft-pt t)
 440                 (progn (goto-char (match-beginning 0))
 441                        (goto-char (point-at-bol)))
 442                 (goto-char cur-pt))))
 443        (bef-pt
 444         (if (search-forward matching-line end-pt t)
 445             (progn (goto-char (match-beginning 0))
 446                    (goto-char (point-at-bol)))
 447             (if (re-search-forward regexp end-pt t)
 448                 (progn (goto-char (match-beginning 0))
 449                        (goto-char (point-at-bol)))
 450                 (goto-char cur-pt))))
 451        (t
 452         (goto-char cur-pt)
 453         (if (search-forward matching-line end-pt t)
 454             (progn (goto-char (match-beginning 0))
 455                    (goto-char (point-at-bol)))
 456             (if (re-search-forward regexp end-pt t)
 457                 (progn (goto-char (match-beginning 0))
 458                        (goto-char (point-at-bol)))
 459                 (if (search-forward matching-line nil t)
 460                     (progn (goto-char (match-beginning 0))
 461                            (goto-char (point-at-bol)))
 462                     (if (search-backward matching-line nil t)
 463                         (progn (goto-char (match-beginning 0))
 464                                (goto-char (point-at-bol)))
 465                         (goto-char cur-pt))))))))))
 466
 467
 468 (defun project-buffer-occur-goto-occurrence-at-pos(pos other-window)
 469   "Go to the occurence found at POS."
 470   (let (context)
 471     ;; Check if there is a context at that line:
 472     (mapcar (lambda (overlay) (when (overlay-get overlay 'project-buffer-occur-context)
 473                                 (setq context (overlay-get overlay 'project-buffer-occur-context))))
 474             (overlays-at pos))
 475     (unless context
 476       (error "No occurrence on this line"))
 477     (let ((file-name (car context))
 478           (occurrence (nth 1 context))
 479           (regexp (nth 2 context)))
 480       (if occurrence
 481           (let ((occ-line-num   (car occurrence))
 482                 (occ-line-str   (nth 1 occurrence))
 483                 (occ-before-str (nth 2 occurrence))
 484                 (occ-after-str  (nth 3 occurrence)))
 485             (project-buffer-occur-goto-matching-string file-name occ-line-num occ-line-str occ-before-str occ-after-str regexp other-window)
 486             (project-buffer-occur-highlight-current regexp (point) (+ (point) (length occ-line-str))))
 487           (project-buffer-occur-goto-file file-name other-window)))))
 488
 489
 490 (defun project-buffer-occur-delete-line()
 491   "Delete the current occurrence line from this buffer."
 492   (interactive)
 493   (goto-char (point-at-bol))
 494   (let ((start (point))
 495         end
 496         (inhibit-read-only t))
 497     (if (looking-at "^[0-9]+ occurrence")
 498         (progn (project-buffer-occur-next-file)
 499                (setq end (if (eq start (point)) (point-max) (point)))
 500                (delete-region start end))
 501         (progn (forward-line 1)
 502                (setq end (point))
 503                (save-excursion
 504                  (save-match-data
 505                    (project-buffer-occur-previous-file)
 506                    (looking-at "^[0-9]+")
 507                    (let ((num (string-to-int (buffer-substring-no-properties (match-beginning 0) (match-end 0)))))
 508                      (if (= num 1)
 509                          (setq start (point))
 510                          (progn (delete-region (match-beginning 0) (match-end 0))
 511                                 (insert (propertize (format "%i" (1- num))
 512                                                     'follow-link t
 513                                                     'mouse-face 'highlight
 514                                                     'face 'project-buffer-occur-file-line)))))))
 515                (delete-region start end)))))
 516
 517
 518 ;;
 519 ;;  Interactive commands:
 520 ;;
 521
 522
 523 (defun project-buffer-occur-mouse-find-file(event)
 524   "Goto the selected occurrence."
 525   (interactive "e")
 526   (set-buffer (window-buffer (posn-window (event-end event))))
 527   (project-buffer-occur-goto-occurrence-at-pos (posn-point (event-end event)) t))
 528
 529
 530 (defun project-buffer-occur-goto-occurrence()
 531   "Goto the selected occurrence."
 532   (interactive)
 533   (project-buffer-occur-goto-occurrence-at-pos (point) nil))
 534
 535
 536 (defun project-buffer-occur-goto-occurrence-other-window()
 537   "Goto the selected occurrence in another window."
 538   (interactive)
 539   (project-buffer-occur-goto-occurrence-at-pos (point) t))
 540
 541
 542 (defun project-buffer-occur-view-occurrence()
 543   "View the selected occurrence without leaving the project-buffer."
 544   (interactive)
 545   (let ((buffer (current-buffer)))
 546     (project-buffer-occur-goto-occurrence-at-pos (point) t)
 547     (let ((window (get-buffer-window buffer)))
 548       (when window
 549         (select-window window)))))
 550
 551
 552 (defun project-buffer-occur-next-occurrence()
 553   "Go to the next occurrence."
 554   (interactive)
 555   (forward-line 1)
 556   (goto-char (point-at-bol))
 557   (while (and (not (eobp))
 558               (looking-at "^[0-9]+ occurrence"))
 559     (forward-line 1)))
 560
 561
 562 (defun project-buffer-occur-previous-occurrence()
 563   "Go to the next occurrence."
 564   (interactive)
 565   (forward-line -1)
 566   (goto-char (point-at-bol))
 567   (while (and (not (bobp))
 568               (looking-at "^[0-9]+ occurrence"))
 569     (forward-line -1))
 570   (if (and (bobp)
 571            (looking-at "^[0-9]+ occurrence"))
 572       (project-buffer-occur-next)))
 573
 574
 575 (defun project-buffer-occur-next-file()
 576   "Go to the next file."
 577   (interactive)
 578   (let ((current (point)))
 579     (forward-line 1)
 580     (goto-char (point-at-bol))
 581     (while (and (not (eobp))
 582                 (not (looking-at "^[0-9]+ occurrence")))
 583       (forward-line 1))
 584     (unless (looking-at "^[0-9]+ occurrence")
 585       (goto-char current))))
 586
 587
 588 (defun project-buffer-occur-previous-file()
 589   "Go to the next file."
 590   (interactive)
 591   (let ((current (point)))
 592     (forward-line -1)
 593     (goto-char (point-at-bol))
 594     (while (and (not (eobp))
 595                 (not (looking-at "^[0-9]+ occurrence")))
 596       (forward-line -1))
 597     (unless (looking-at "^[0-9]+ occurrence")
 598       (goto-char current))))
 599
 600
 601 (defun project-buffer-occur-view-next-occurrence()
 602   "Go to the next occurrence and view it."
 603   (interactive)
 604   (project-buffer-occur-next-occurrence)
 605   (project-buffer-occur-view-occurrence))
 606
 607
 608 (defun project-buffer-occur-view-previous-occurrence()
 609   "Go to the next occurrence."
 610   (interactive)
 611   (project-buffer-occur-previous-occurrence)
 612   (project-buffer-occur-view-occurrence))
 613
 614
 615 (defun project-buffer-occur-help ()
 616   "Display help for `project-buffer-occur' mode."
 617   (interactive)
 618   (describe-function 'project-buffer-occur-mode))
 619
 620
 621 (defun project-buffer-occur-rename-buffer()
 622   "Rename the buffer; make its name uniq."
 623   (interactive)
 624   (let ((new-name (format "*Project-Buffer-Occur:%s*" project-buffer-occur-saved-project-buffer)))
 625     (rename-buffer new-name t)))
 626
 627
 628 (defun project-buffer-occur-refresh()
 629   "Refresh the buffer."
 630   (interactive)
 631   (let ((inhibit-read-only t))
 632     (project-buffer-occur-clear-overlays)
 633     (erase-buffer)
 634     (let ((regexp       (nth 0 project-buffer-occur-saved-regexp))
 635           (all-files    (nth 1 project-buffer-occur-saved-regexp))
 636           (project      (nth 2 project-buffer-occur-saved-regexp))
 637           (occur-buffer (current-buffer)))
 638       ;; Fill the occur buffer with all occurrences:
 639       (save-excursion
 640         (set-buffer project-buffer-occur-saved-project-buffer)
 641         (if all-files
 642             (project-buffer-apply-to-each-file 'project-buffer-occur-research regexp occur-buffer)
 643             (unless (project-buffer-apply-to-marked-files 'project-buffer-occur-research regexp occur-buffer)
 644               (project-buffer-apply-to-project-files project 'project-buffer-occur-research regexp occur-buffer)))))))
 645
 646
 647
 648 ;;
 649 ;;  Entry command:
 650 ;;
 651
 652
 653 (defun project-buffer-occur(regexp all-files)
 654   "Search REGEXP in the project files; if ALL-FILES is t the
 655 research will occur in all project's files; if ALL-FILES is
 656 false, the research will occur in all marked files unless there
 657 are none in which case it will occur in all files of the current
 658 project (current project is determined by the cursor position)."
 659   (interactive
 660    (list (project-buffer-read-regexp (format "List lines matching regexp%s: " (if current-prefix-arg " [all files]" "")))
 661          current-prefix-arg))
 662   (unless project-buffer-status (error "Not in project-buffer buffer"))
 663   (unless (and regexp (not (string-equal regexp "")))
 664     (error "Invalid regexp"))
 665   ;; Generate an occur buffer:
 666   (let ((pb-buffer (current-buffer)))
 667     (let ((occur-buffer (project-buffer-occur-get-and-clear-occur-buffer))
 668           (project-name (project-buffer-get-current-project-name))
 669           (project-directory default-directory))
 670       ;; Set the local variable:
 671       (with-current-buffer occur-buffer
 672         (cd project-directory)
 673         (setq project-buffer-occur-saved-project-buffer pb-buffer)
 674         (setq project-buffer-occur-saved-regexp (list regexp all-files project-name)))
 675       ;; Fill the occur buffer with all occurrences:
 676       (if all-files
 677           (project-buffer-apply-to-each-file 'project-buffer-occur-research regexp occur-buffer)
 678           (unless (project-buffer-apply-to-marked-files 'project-buffer-occur-research regexp occur-buffer)
 679             (project-buffer-apply-to-project-files project-name
 680                                                    'project-buffer-occur-research regexp occur-buffer)))
 681       (with-current-buffer occur-buffer
 682         (goto-char (point-min)))
 683       (display-buffer occur-buffer)
 684       (message "Done.")
 685 )))
 686
 687
 688 ;;
 689
 690 (provide 'project-buffer-occur)
 691
 692 ;;; project-buffer-occur.el ends here