1 ;;; semantic/symref/filter.el --- Filter symbol reference hits for accuracy.
3 ;; Copyright (C) 2009, 2010, 2011, 2012 Free Software Foundation, Inc.
5 ;; Author: Eric M. Ludlam <eric@siege-engine.com>
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software: you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation, either version 3 of the License, or
12 ;; (at your option) any later version.
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;; Filter symbol reference hits for accuracy.
26 ;; Most symbol referencing tools, such as find/grep only find matching
27 ;; strings, but cannot determine the difference between an actual use,
28 ;; and something else with a similar name, or even a string in a comment.
30 ;; This file provides utilities for filtering down to accurate matches
31 ;; starting at a basic filter level that doesn't use symref, up to filters
32 ;; across symref results.
37 (require 'semantic
/analyze
)
38 (declare-function srecode-active-template-region
"srecode/fields")
39 (declare-function srecode-delete
"srecode/fields")
40 (declare-function srecode-field
"srecode/fields")
41 (declare-function srecode-template-inserted-region
"srecode/fields")
42 (declare-function srecode-overlaid-activate
"srecode/fields")
43 (declare-function semantic-idle-summary-useful-context-p
"semantic/idle")
47 (defun semantic-symref-filter-hit (target &optional position
)
48 "Determine if the tag TARGET is used at POSITION in the current buffer.
49 Return non-nil for a match."
50 (semantic-analyze-current-symbol
51 (lambda (start end prefix
)
52 (let ((tag (car (nreverse prefix
))))
53 (and (semantic-tag-p tag
)
54 (semantic-equivalent-tag-p target tag
))))
57 ;;; IN-BUFFER FILTERING
59 ;; The following does filtering in-buffer only, and not against
60 ;; a symref results object.
62 (defun semantic-symref-hits-in-region (target hookfcn start end
)
63 "Find all occurrences of the symbol TARGET that match TARGET the tag.
64 For each match, call HOOKFCN.
65 HOOKFCN takes three arguments that match
66 `semantic-analyze-current-symbol's use of HOOKFCN.
69 Search occurs in the current buffer between START and END."
70 (require 'semantic
/idle
)
73 (let* ((str (semantic-tag-name target
))
74 (case-fold-search semantic-case-fold
)
75 (regexp (concat "\\<" (regexp-quote str
) "\\>")))
76 (while (re-search-forward regexp end t
)
77 (when (semantic-idle-summary-useful-context-p)
78 (semantic-analyze-current-symbol
79 (lambda (start end prefix
)
80 (let ((tag (car (nreverse prefix
))))
81 ;; check for semantic match on the text match.
82 (when (and (semantic-tag-p tag
)
83 (semantic-equivalent-tag-p target tag
))
85 (funcall hookfcn start end prefix
)))))
88 (defun semantic-symref-rename-local-variable ()
89 "Fancy way to rename the local variable under point.
90 Depends on the SRecode Field editing API."
92 ;; Do the replacement as needed.
93 (let* ((ctxt (semantic-analyze-current-context))
94 (target (car (reverse (oref ctxt prefix
))))
95 (tag (semantic-current-tag))
98 (when (or (not target
)
99 (not (semantic-tag-with-position-p target
)))
100 (error "Cannot identify symbol under point"))
102 (when (not (semantic-tag-of-class-p target
'variable
))
103 (error "Can only rename variables"))
105 (when (or (< (semantic-tag-start target
) (semantic-tag-start tag
))
106 (> (semantic-tag-end target
) (semantic-tag-end tag
)))
107 (error "Can only rename variables declared in %s"
108 (semantic-tag-name tag
)))
110 ;; I think we're good for this example. Give it a go through
111 ;; our fancy interface from SRecode.
112 (require 'srecode
/fields
)
114 ;; Make sure there is nothing active.
115 (let ((ar (srecode-active-template-region)))
116 (when ar
(srecode-delete ar
)))
118 (let ((srecode-field-archive nil
)
121 (semantic-symref-hits-in-region
122 target
(lambda (start end prefix
)
123 ;; For every valid hit, create one field.
124 (srecode-field "LOCAL" :name
"LOCAL" :start start
:end end
))
125 (semantic-tag-start tag
) (semantic-tag-end tag
))
127 ;; Now that the fields are setup, create the region.
128 (setq region
(srecode-template-inserted-region
129 "REGION" :start
(semantic-tag-start tag
)
130 :end
(semantic-tag-end tag
)))
132 ;; Activate the region.
133 (srecode-overlaid-activate region
)
138 (provide 'semantic
/symref
/filter
)
140 ;; arch-tag: 14b9e795-02bf-408b-b375-c3f8ff6a4e38
141 ;;; semantic/symref/filter.el ends here