1 ;;; srecode/cpp.el --- C++ specific handlers for Semantic Recoder
3 ;; Copyright (C) 2007, 2009-2012 Free Software Foundation, Inc.
5 ;; Author: Eric M. Ludlam <eric@siege-engine.com>
6 ;; Jan Moringen <scymtym@users.sourceforge.net>
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;; Supply some C++ specific dictionary fillers and helpers
30 (require 'srecode
/dictionary
)
31 (require 'srecode
/semantic
)
32 (require 'semantic
/tag
)
37 (defgroup srecode-cpp nil
38 "C++-specific Semantic Recoder settings."
41 (defcustom srecode-cpp-namespaces
43 "List expansion candidates for the :using-namespaces argument.
44 A dictionary entry of the named PREFIX_NAMESPACE with the value
45 NAMESPACE:: is created for each namespace unless the current
46 buffer contains a using NAMESPACE; statement "
48 :type
'(repeat string
))
50 ;;; :cpp ARGUMENT HANDLING
52 ;; When a :cpp argument is required, fill the dictionary with
53 ;; information about the current C++ file.
55 ;; Error if not in a C++ mode.
58 (defun srecode-semantic-handle-:cpp
(dict)
59 "Add macros into the dictionary DICT based on the current c++ file.
61 FILENAME_SYMBOL - filename converted into a C compat symbol.
62 HEADER - Shown section if in a header file."
63 ;; A symbol representing
64 (let ((fsym (file-name-nondirectory (buffer-file-name)))
67 ;; Are we in a header file?
68 (if (string-match "\\.\\(h\\|hh\\|hpp\\|h\\+\\+\\)$" fsym
)
69 (srecode-dictionary-show-section dict
"HEADER")
70 (srecode-dictionary-show-section dict
"NOTHEADER"))
72 ;; Strip out bad characters
73 (while (string-match "\\.\\| " fsym
)
74 (setq fsym
(replace-match "_" t t fsym
)))
75 (srecode-dictionary-set-value dict
"FILENAME_SYMBOL" fsym
)
79 (defun srecode-semantic-handle-:using-namespaces
(dict)
80 "Add macros into the dictionary DICT based on used namespaces.
82 PREFIX_NAMESPACE - for each NAMESPACE in `srecode-cpp-namespaces'."
83 (let ((tags (semantic-find-tags-by-class
84 'using
(semantic-fetch-tags))))
85 (dolist (name srecode-cpp-namespaces
)
86 (let ((variable (format "PREFIX_%s" (upcase name
)))
87 (prefix (format "%s::" name
)))
88 (srecode-dictionary-set-value dict variable prefix
)
90 (when (and (eq (semantic-tag-get-attribute tag
:kind
)
92 (string= (semantic-tag-name tag
) name
))
93 (srecode-dictionary-set-value dict variable
""))))))
96 (define-mode-local-override srecode-semantic-apply-tag-to-dict
97 c
++-mode
(tag-wrapper dict
)
98 "Apply C++ specific features from TAG-WRAPPER into DICT.
99 Calls `srecode-semantic-apply-tag-to-dict-default' first. Adds
100 special behavior for tag of classes include, using and function."
102 ;; Use default implementation to fill in the basic properties.
103 (srecode-semantic-apply-tag-to-dict-default tag-wrapper dict
)
105 ;; Pull out the tag for the individual pieces.
106 (let* ((tag (oref tag-wrapper
:prime
))
107 (class (semantic-tag-class tag
)))
109 ;; Add additional information based on the class of the tag.
115 ;; For include tags, we have to discriminate between system-wide
116 ;; and local includes.
117 (if (semantic-tag-include-system-p tag
)
118 (srecode-dictionary-show-section dict
"SYSTEM")
119 (srecode-dictionary-show-section dict
"LOCAL")))
125 ;; Insert the subject (a tag) of the include statement as VALUE
126 ;; entry into the dictionary.
127 (let ((value-tag (semantic-tag-get-attribute tag
:value
))
128 (value-dict (srecode-dictionary-add-section-dictionary
130 (srecode-semantic-apply-tag-to-dict
131 (srecode-semantic-tag (semantic-tag-name value-tag
)
135 ;; Discriminate using statements referring to namespaces and
137 (when (eq (semantic-tag-get-attribute tag
:kind
) 'namespace
)
138 (srecode-dictionary-show-section dict
"NAMESPACE")))
143 ((eq class
'function
)
144 ;; @todo It would be nice to distinguish member functions from
145 ;; free functions and only apply the const and pure modifiers,
146 ;; when they make sense. My best bet would be
147 ;; (semantic-tag-function-parent tag), but it is not there, when
148 ;; the function is defined in the scope of a class.
150 (templates (semantic-tag-get-attribute tag
:template
))
151 (modifiers (semantic-tag-modifiers tag
)))
153 ;; Add modifiers into the dictionary
154 (dolist (modifier modifiers
)
155 (let ((modifier-dict (srecode-dictionary-add-section-dictionary
157 (srecode-dictionary-set-value modifier-dict
"NAME" modifier
)))
159 ;; Add templates into child dictionaries.
160 (srecode-cpp-apply-templates dict templates
)
162 ;; When the function is a member function, it can have
163 ;; additional modifiers.
166 ;; For member functions, constness is called
167 ;; 'methodconst-flag'.
168 (when (semantic-tag-get-attribute tag
:methodconst-flag
)
169 (srecode-dictionary-show-section dict
"CONST"))
171 ;; If the member function is pure virtual, add a dictionary
173 (when (semantic-tag-get-attribute tag
:pure-virtual-flag
)
174 (srecode-dictionary-show-section dict
"PURE"))
181 ;; For classes, add template parameters.
182 (when (or (semantic-tag-of-type-p tag
"class")
183 (semantic-tag-of-type-p tag
"struct"))
185 ;; Add templates into child dictionaries.
186 (let ((templates (semantic-tag-get-attribute tag
:template
)))
187 (srecode-cpp-apply-templates dict templates
))))
195 (defun srecode-cpp-apply-templates (dict templates
)
196 "Add section dictionaries for TEMPLATES to DICT."
198 (let ((templates-dict (srecode-dictionary-add-section-dictionary
200 (dolist (template templates
)
201 (let ((template-dict (srecode-dictionary-add-section-dictionary
202 templates-dict
"ARGS")))
203 (srecode-semantic-apply-tag-to-dict
204 (srecode-semantic-tag (semantic-tag-name template
)
209 (provide 'srecode
/cpp
)
212 ;; generated-autoload-file: "loaddefs.el"
213 ;; generated-autoload-load-name: "srecode/cpp"
216 ;;; srecode/cpp.el ends here