unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
blob c6cb5655e2d65cbf3ed9c754ad71178cd7685811 7085 bytes (raw)
name: lisp/erc/erc-imenu.el 	 # note: path name is non-authoritative(*)

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
;;; erc-imenu.el --- Imenu support for ERC  -*- lexical-binding: t; -*-

;; Copyright (C) 2001-2024 Free Software Foundation, Inc.

;; Author: Mario Lang <mlang@delysid.org>
;; Maintainer: Amin Bandali <bandali@gnu.org>, F. Jason Park <jp@neverwas.me>
;; Keywords: comm
;; URL: https://www.emacswiki.org/emacs/ErcImenu

;; This file is part of GNU Emacs.

;; GNU Emacs 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.

;; GNU Emacs 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 GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.

;;; Commentary:

;; This file contains code related to Ibuffer and ERC.  Totally alpha,
;; needs work.  Usage:  Type / C-e C-h when in Ibuffer-mode to see new
;; limiting commands

;;; Code:

;;; Commentary:

;; This package defines the function `erc-create-imenu-index'.  ERC
;; uses this for `imenu-create-index-function', and autoloads it.
;; Therefore, nothing needs to be done to use this package.

;;; Code:

(require 'erc)
(require 'imenu)

(defgroup erc-imenu nil
  "Imenu integration for ERC."
  :group 'erc)

(defun erc-unfill-notice ()
  "Return text from point to a computed end as a string unfilled.
Don't rely on this function, read it first!"
  (let ((str (buffer-substring
	      (save-excursion
		(re-search-forward (regexp-quote erc-notice-prefix)))
	      (progn
		(while (save-excursion
			 (forward-line 1)
			 (looking-at "    "))
		  (forward-line 1))
		(end-of-line) (point))))
	(inhibit-read-only t))
    (with-temp-buffer
      (insert str)
      (goto-char (point-min))
      (while (re-search-forward "\n +" nil t)
	(replace-match " "))
      (buffer-substring (point-min) (point-max)))))

;;;###autoload
(defun erc-create-imenu-index ()
  (let ((index-alist '())
	(notice-alist '())
	(join-alist '())
	(left-alist '())
	(quit-alist '())
	(message-alist '())
	(mode-change-alist '())
	(topic-change-alist '())
	) ;; prev-pos
    (goto-char (point-max))
    (while (if (bolp)
	       (> (forward-line -1)
		  -1)
	     (progn (forward-line 0)
		    t))
      (save-match-data
	(when (looking-at (concat (regexp-quote erc-notice-prefix)
				  "\\(.+\\)$"))
	  (let ((notice-text  ;; Ugly hack, but seems to work.
		 (save-excursion (erc-unfill-notice)))
		(pos (point)))
	    (push (cons notice-text pos) notice-alist)
	    (or
	     (when (string-match "^\\(.*\\) has joined channel" notice-text)
	       (push (cons (match-string 1 notice-text) pos) join-alist))
	     (when (string-match "^\\(.+\\) has left channel" notice-text)
	       (push (cons (match-string 1 notice-text) pos) left-alist))
	     (when (string-match "^\\(.+\\) has quit\\(.*\\)$" notice-text)
	       (push (cons (concat (match-string 1 notice-text)
				   (match-string 2 notice-text))
			   (point))
		     quit-alist))
	     (when (string-match
		    "^\\(\\S-+\\) (.+) has changed mode for \\S-+ to \\(.*\\)$"
		    notice-text)
	       (push (cons (concat (match-string 1 notice-text) ": "
				   (match-string 2 notice-text))
			   (point))
		     mode-change-alist))
	     (when (string-match
		    "^\\(\\S-+\\) (.+) has set the topic for \\S-+: \\(.*\\)$"
		    notice-text)
	       (push (cons (concat (match-string 1 notice-text) ": "
				   (match-string 2 notice-text))
			   pos)
		     topic-change-alist)))))
	(when (looking-at "<\\(\\S-+\\)> \\(.+\\)$")
	  (let ((from (match-string 1))
		(message-text (match-string 2)))
	    (push (cons (concat from ": " message-text) (point))
		  message-alist)))))
    (and notice-alist (push (cons "notices" notice-alist) index-alist))
    (and join-alist (push (cons "joined" join-alist) index-alist))
    (and left-alist (push (cons "parted" left-alist) index-alist))
    (and quit-alist (push (cons "quit" quit-alist) index-alist))
    (and mode-change-alist (push (cons "mode-change" mode-change-alist)
				 index-alist))
    (and message-alist (push (cons "messages" message-alist) index-alist))
    (and topic-change-alist (push (cons "topic-change" topic-change-alist)
				  index-alist))
    index-alist))

(defvar-local erc-imenu--create-index-function nil
  "Previous local value of `imenu-create-index-function', if any.")

;;;###autoload(autoload 'erc-imenu-mode "erc-imenu" nil t)
(define-erc-module imenu nil
  "Simple Imenu integration for ERC."
  ((add-hook 'erc-mode-hook #'erc-imenu-setup)
   (add-hook 'which-function-mode-hook #'erc-imenu--disable-which-func)
   (unless erc--updating-modules-p (erc-buffer-do #'erc-imenu-setup)))
  ((remove-hook 'erc-mode-hook #'erc-imenu-setup)
   (remove-hook 'which-function-mode-hook #'erc-imenu--disable-which-func)
   (erc-buffer-do #'erc-imenu-setup)))

(defun erc-imenu-setup ()
  "Set up or tear down Imenu integration."
  (if erc-imenu-mode
      (progn
        (when (and (local-variable-p 'imenu-create-index-function)
                   imenu-create-index-function)
          (setq erc-imenu--create-index-function imenu-create-index-function))
        (setq imenu-create-index-function #'erc-create-imenu-index)
        (when (boundp 'which-func-mode)
          (setq which-func-mode nil)))
    (when erc-imenu--create-index-function
      (setq imenu-create-index-function erc-imenu--create-index-function))
    (kill-local-variable 'erc-imenu--create-index-function)
    (kill-local-variable 'which-func-mode)))

(defun erc-imenu--disable-which-func ()
  "Silence `which-function-mode' in ERC buffers."
  (defvar which-func-mode)
  (erc-with-all-buffers-of-server nil nil
    (setq which-func-mode nil)))

;;;###autoload
(defun erc-imenu-add-devel-patterns ()
  "Tell `imenu' about ERC-defined macros."
  ;; This currently produces results like "ERC response FOO BAR".  I'd
  ;; obviously be nicer to end up with "erc-response-FOO" and
  ;; "erc-response-BAR", possibly as separate items.  Likewise for
  ;; modules: "erc-foo-mode" instead of "ERC module foo".
  (cl-pushnew `("ERC response"
                ,(rx bol (* (syntax whitespace))
                     "(define-erc-response-handler (" (group (+ nonl)) ")")
                1)
              lisp-imenu-generic-expression
              :test #'equal)
  (cl-pushnew `("ERC module"
                ,(rx bol (* (syntax whitespace))
                     ;; Lisp-mode-symbol.
                     "(define-erc-module " (group (+ (| (syntax word)
                                                        (syntax symbol)
                                                        (: "\\" nonl)))))
                1)
              lisp-imenu-generic-expression
              :test #'equal))

(provide 'erc-imenu)

;;; erc-imenu.el ends here
;;
;; Local Variables:
;; generated-autoload-file: "erc-loaddefs.el"
;; End:

debug log:

solving c6cb5655e2d ...
found c6cb5655e2d in https://yhetil.org/emacs-bugs/87seqlhgot.fsf__30205.4567424179$1734488736$gmane$org@neverwas.me/
found 68c7895e2dd in https://yhetil.org/emacs-bugs/87seqlhgot.fsf__30205.4567424179$1734488736$gmane$org@neverwas.me/
found 4c9cbfc1580 in https://git.savannah.gnu.org/cgit/emacs.git
preparing index
index prepared:
100644 4c9cbfc15807dda565b2d4ceceae61368c4aa123	lisp/erc/erc-imenu.el

applying [1/2] https://yhetil.org/emacs-bugs/87seqlhgot.fsf__30205.4567424179$1734488736$gmane$org@neverwas.me/
diff --git a/lisp/erc/erc-imenu.el b/lisp/erc/erc-imenu.el
index 4c9cbfc1580..68c7895e2dd 100644


applying [2/2] https://yhetil.org/emacs-bugs/87seqlhgot.fsf__30205.4567424179$1734488736$gmane$org@neverwas.me/
diff --git a/lisp/erc/erc-imenu.el b/lisp/erc/erc-imenu.el
index 68c7895e2dd..c6cb5655e2d 100644

Checking patch lisp/erc/erc-imenu.el...
Applied patch lisp/erc/erc-imenu.el cleanly.
Checking patch lisp/erc/erc-imenu.el...
Applied patch lisp/erc/erc-imenu.el cleanly.

index at:
100644 c6cb5655e2d65cbf3ed9c754ad71178cd7685811	lisp/erc/erc-imenu.el

(*) Git path names are given by the tree(s) the blob belongs to.
    Blobs themselves have no identifier aside from the hash of its contents.^

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.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).