blob: 3e1d75084f75c99a2f8444f074cad0597cffe10d (
plain)
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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
|
;;;; Add to your ~/.emacs the following lines:
;;;;
;;;; (load-path "/full/path/to/this/file")
;;;; (require 'cvc-devel)
;;;;
;;;; If you want to modify the key binding for inserting the comment,
;;;; add also something like this:
;;;;
;;;; (setq cvc-devel-comment-key "\M-/")
;;;;
(defvar cvc-devel-comment-key "\C-c\C-h"
"The hot key binding to insert an appropriate comment in C++ header
in CVC code")
(require 'cc-mode)
(add-to-list 'c++-mode-hook
'(lambda ()
(local-set-key cvc-devel-comment-key
'insert-comment-template)))
(defun insert-comment-template ()
"Insert a comment template into C++ file in the CVC style. The
comment is different depending on where it is inserted. For example,
inserting it in the empty file will produce a file comment, a class
comment will be inserted before a class definition, and so on."
(interactive)
; Check for macro
(cond
((catch 'not-macro
(progn
(set-mark (point))
(cond ((not (search-forward "#define" nil t))
(throw 'not-macro t)))
(beginning-of-line)
(cond ((not (= (mark) (point)))
(progn
(goto-char (mark))
(throw 'not-macro t))))
; It's a macro: insert the comment template
(forward-char 7)
(re-search-forward "[^ ]")
(backward-char)
(set-mark (point))
(re-search-forward " \\|(\\|^")
(backward-char)
(copy-region-as-kill (mark) (point))
(beginning-of-line)
(insert-string
"/*****************************************************************************/
/*!
*\\def ")
(yank)
(insert-string "
*
* Author: ")
(insert-string (user-full-name))
(insert-string "
*
* Created: ")
(insert-string (current-time-string))
(insert-string "
*
*
*/
/*****************************************************************************/
")
(forward-line -3)
(search-forward "* ")
()
)
)
(cond
((catch 'not-function
(progn
(set-mark (point))
(cond ((not (search-forward "(" nil t))
(throw 'not-function t)))
(beginning-of-line)
(cond ((not (= (mark) (point)))
(progn
(goto-char (mark))
(throw 'not-function t))))
; It's a function: insert the comment template
(search-forward "(")
(re-search-backward "[^ ] *(")
(forward-char)
(set-mark (point))
(re-search-backward " \\|^.")
(re-search-forward "[^ ]")
(backward-char)
(copy-region-as-kill (mark) (point))
(beginning-of-line)
(insert-string
"/*****************************************************************************/
/*!
* Function: ")
(yank)
(insert-string "
*
* Author: ")
(insert-string (user-full-name))
(insert-string "
*
* Created: ")
(insert-string (current-time-string))
(insert-string "
*
*
*/
/*****************************************************************************/
")
(forward-line -3)
(search-forward "* ")
()
)
)
(cond
((catch 'not-class
(progn
(set-mark (point))
(cond ((not (search-forward "class" nil t))
(throw 'not-class t)))
(beginning-of-line)
(cond ((not (= (mark) (point)))
(progn
(goto-char (mark))
(throw 'not-class t))))
; It's a class definition: insert the comment template
(forward-char 5)
(re-search-forward "[^ ]")
(backward-char)
(set-mark (point))
(re-search-forward "^\\| \\|{")
(backward-char)
(copy-region-as-kill (mark) (point))
(beginning-of-line)
(insert-string
"/*****************************************************************************/
/*!
*\\class ")
(yank)
(insert-string "
*\\brief ")
(yank)
(insert-string "
*
* Author: ")
(insert-string (user-full-name))
(insert-string "
*
* Created: ")
(insert-string (current-time-string))
(insert-string "
*
*
*/
/*****************************************************************************/
")
(forward-line -4)
(search-forward "* ")
()
)
)
(cond
((catch 'not-bof
(progn
(set-mark (point))
(beginning-of-buffer)
(cond ((not (= (mark) (point)))
(progn
(goto-char (mark))
(throw 'not-bof t))))
; At beginning of file: insert beginning of file comment
(insert-string
"/*****************************************************************************/
/*!
*\\file ")
(insert-string (file-name-nondirectory (buffer-file-name)))
(insert-string "
*\\brief
*
* Author: ")
(insert-string (user-full-name))
(insert-string "
*
* Created: ")
(insert-string (current-time-string))
(insert-string "
*/
/*****************************************************************************/
")
(forward-line -7)
(search-forward "brief ")
()
)
)
; Insert default comment template
(insert-string
"/*****************************************************************************/
/*
*
*/
/*****************************************************************************/
")
(forward-line -3)
(search-forward "* ")
)
)
)
)
)
)
)
)
)
(provide 'cvc-devel)
|
