1 ;;; gnome-c-snippet.el --- GNOME-style code generation -*- lexical-binding: t; -*-
2 ;; Copyright (C) 2016 Free Software Foundation, Inc.
4 ;; Author: Daiki Ueno <ueno@gnu.org>
5 ;; Keywords: GNOME, C, coding style
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 ;; FIXME: The snippets defined here could be rewritten in yasnippet
28 (require 'gnome-c-align)
31 (defvar gnome-c-snippet-package nil)
32 (make-variable-buffer-local 'gnome-c-snippet-package)
34 (defvar gnome-c-snippet-class nil)
35 (make-variable-buffer-local 'gnome-c-snippet-class)
37 (defvar gnome-c-snippet-parent-package nil)
38 (make-variable-buffer-local 'gnome-c-snippet-parent-package)
40 (defvar gnome-c-snippet-parent-class nil)
41 (make-variable-buffer-local 'gnome-c-snippet-parent-class)
43 (defcustom gnome-c-snippet-align-arglist t
44 "Whether to align argument list of the inserted snippet"
46 :group 'gnome-c-style)
48 (make-variable-buffer-local 'gnome-c-snippet-align-arglist)
50 (defun gnome-c-snippet--parse-name (name)
53 (insert (upcase-initials name))
54 (goto-char (point-min))
56 ;; Skip characters not recognized by subword-mode.
57 (if (looking-at "[^[:lower:][:upper:][:digit:]]+")
58 (goto-char (match-end 0)))
59 (push (buffer-substring (point) (progn (subword-forward 1)
64 (defun gnome-c-snippet--read-package-and-class (package-prompt
68 (when (or current-prefix-arg
69 (not (and (symbol-value package-symbol)
70 (symbol-value class-symbol))))
72 (gnome-c-snippet--parse-name
73 (read-string (or package-prompt
74 "Package (CamelCase): ")
75 (if (symbol-value package-symbol)
76 (gnome-c-snippet--format-Package
77 (symbol-value package-symbol))))))
79 (gnome-c-snippet--parse-name
80 (read-string (or class-prompt
81 "Class (CamelCase): ")
82 (if (symbol-value class-symbol)
83 (gnome-c-snippet--format-Class
84 (symbol-value class-symbol)))))))
85 (list (symbol-value package-symbol) (symbol-value class-symbol)))
87 (defun gnome-c-snippet--format-PACKAGE (package)
88 (mapconcat #'upcase package "_"))
89 (defalias 'gnome-c-snippet--format-CLASS 'gnome-c-snippet--format-PACKAGE)
91 (defun gnome-c-snippet--format-PACKAGE_CLASS (package class)
92 (concat (gnome-c-snippet--format-PACKAGE package)
94 (gnome-c-snippet--format-CLASS class)))
96 (defun gnome-c-snippet--format-package (package)
97 (mapconcat #'downcase package "_"))
98 (defalias 'gnome-c-snippet--format-class 'gnome-c-snippet--format-package)
100 (defun gnome-c-snippet--format-package_class (package class)
101 (concat (gnome-c-snippet--format-package package)
103 (gnome-c-snippet--format-class class)))
105 (defun gnome-c-snippet--format-Package (package)
106 (mapconcat #'identity package ""))
107 (defalias 'gnome-c-snippet--format-Class 'gnome-c-snippet--format-Package)
109 (defun gnome-c-snippet--format-PackageClass (package class)
110 (concat (gnome-c-snippet--format-Package package)
111 (gnome-c-snippet--format-Class class)))
114 (defun gnome-c-snippet-insert-package_class (package class)
115 "Insert the class name before the current point."
116 (interactive (gnome-c-snippet--read-package-and-class
118 'gnome-c-snippet-package
119 'gnome-c-snippet-class))
120 (insert (gnome-c-snippet--format-package_class package class)))
123 (defun gnome-c-snippet-insert-PACKAGE_CLASS (package class)
124 "Insert the class name before the current point."
125 (interactive (gnome-c-snippet--read-package-and-class
127 'gnome-c-snippet-package
128 'gnome-c-snippet-class))
129 (insert (gnome-c-snippet--format-PACKAGE_CLASS package class)))
132 (defun gnome-c-snippet-insert-PackageClass (package class)
133 "Insert the class name (in CamelCase) before the current point."
134 (interactive (gnome-c-snippet--read-package-and-class
136 'gnome-c-snippet-package
137 'gnome-c-snippet-class))
138 (insert (gnome-c-snippet--format-PackageClass package class)))
140 (defun gnome-c-snippet-insert-interface-declaration (package iface
141 parent-package parent-class)
142 "Insert interface declaration for PACKAGE and IFACE"
144 (append (gnome-c-snippet--read-package-and-class
146 "Interface (CamelCase): "
147 'gnome-c-snippet-package
148 'gnome-c-snippet-class)
149 (gnome-c-snippet--read-package-and-class
150 "Parent package (CamelCase): "
151 "Parent class (CamelCase): "
152 'gnome-c-snippet-parent-package
153 'gnome-c-snippet-parent-class)))
155 #define " (gnome-c-snippet--format-PACKAGE package) "_TYPE_" (gnome-c-snippet--format-CLASS iface) " (" (gnome-c-snippet--format-package package) "_" (gnome-c-snippet--format-class iface) "_get_type ())
156 G_DECLARE_INTERFACE (" (gnome-c-snippet--format-PackageClass package iface) ", "
157 (gnome-c-snippet--format-package_class package iface) ", " (gnome-c-snippet--format-PACKAGE package) ", " (gnome-c-snippet--format-CLASS iface) ", " (gnome-c-snippet--format-PackageClass parent-package parent-class) ")
160 (defun gnome-c-snippet--insert-class-declaration (package
166 #define " (gnome-c-snippet--format-PACKAGE package) "_TYPE_" (gnome-c-snippet--format-CLASS class) " (" (gnome-c-snippet--format-package_class package class) "_get_type ())
167 G_DECLARE_" (if derivable "DERIVABLE" "FINAL") "_TYPE (" (gnome-c-snippet--format-PackageClass package class) ", "
168 (gnome-c-snippet--format-package_class package class) ", " (gnome-c-snippet--format-PACKAGE package) ", " (gnome-c-snippet--format-CLASS class) ", " (gnome-c-snippet--format-PackageClass parent-package parent-class) ")
171 (defun gnome-c-snippet-insert-final-class-declaration (package
175 "Insert final class declaration for PACKAGE and CLASS."
177 (append (gnome-c-snippet--read-package-and-class
179 'gnome-c-snippet-package
180 'gnome-c-snippet-class)
181 (gnome-c-snippet--read-package-and-class
182 "Parent package (CamelCase): "
183 "Parent class (CamelCase): "
184 'gnome-c-snippet-parent-package
185 'gnome-c-snippet-parent-class)))
186 (gnome-c-snippet--insert-class-declaration package
192 (defun gnome-c-snippet-insert-derivable-class-declaration (package
196 "Insert derivable class declaration for PACKAGE and CLASS."
198 (append (gnome-c-snippet--read-package-and-class
200 'gnome-c-snippet-package
201 'gnome-c-snippet-class)
202 (gnome-c-snippet--read-package-and-class
203 "Parent package (CamelCase): "
204 "Parent class (CamelCase): "
205 'gnome-c-snippet-parent-package
206 'gnome-c-snippet-parent-class)))
207 (gnome-c-snippet--insert-class-declaration package
213 (defun gnome-c-snippet-insert-interface-definition (package
217 "Insert class definition for PACKAGE and CLASS."
219 (append (gnome-c-snippet--read-package-and-class
221 "Interface (CamelCase): "
222 'gnome-c-snippet-package
223 'gnome-c-snippet-class)
224 (gnome-c-snippet--read-package-and-class
225 "Parent package (CamelCase): "
226 "Parent class (CamelCase): "
227 'gnome-c-snippet-parent-package
228 'gnome-c-snippet-parent-class)))
231 " (gnome-c-snippet--format-package_class package iface) "_default_init (" (gnome-c-snippet--format-PackageClass package iface) "Interface *iface) {
234 G_DEFINE_INTERFACE (" (gnome-c-snippet--format-PackageClass package iface) ", "
235 (gnome-c-snippet--format-package_class package iface) ", " (gnome-c-snippet--format-PACKAGE parent-package) "_TYPE_" (gnome-c-snippet--format-CLASS parent-class) ")
238 (defun gnome-c-snippet--insert-class-definition (package
244 G_DEFINE_" (if abstract "ABSTRACT_" "") "TYPE (" (gnome-c-snippet--format-PackageClass package class) ", "
245 (gnome-c-snippet--format-package_class package class) ", " (gnome-c-snippet--format-PACKAGE parent-package) "_TYPE_" (gnome-c-snippet--format-CLASS parent-class) ")
248 " (gnome-c-snippet--format-package_class package class) "_class_init (" (gnome-c-snippet--format-PackageClass package class) "Class *klass)
253 " (gnome-c-snippet--format-package_class package class) "_init (" (gnome-c-snippet--format-PackageClass package class) " *self)
258 (defun gnome-c-snippet-insert-class-definition (package
262 "Insert class definition for PACKAGE and CLASS."
264 (append (gnome-c-snippet--read-package-and-class
266 'gnome-c-snippet-package
267 'gnome-c-snippet-class)
268 (gnome-c-snippet--read-package-and-class
269 "Parent package (CamelCase): "
270 "Parent class (CamelCase): "
271 'gnome-c-snippet-parent-package
272 'gnome-c-snippet-parent-class)))
273 (gnome-c-snippet--insert-class-definition package
279 (defun gnome-c-snippet-insert-abstract-class-definition (package
283 "Insert abstract class definition for PACKAGE and CLASS."
285 (append (gnome-c-snippet--read-package-and-class
287 'gnome-c-snippet-package
288 'gnome-c-snippet-class)
289 (gnome-c-snippet--read-package-and-class
290 "Parent package (CamelCase): "
291 "Parent class (CamelCase): "
292 'gnome-c-snippet-parent-package
293 'gnome-c-snippet-parent-class)))
294 (gnome-c-snippet--insert-class-definition package
300 (defun gnome-c-snippet-insert-constructor (package class)
301 "Insert 'constructor' vfunc of GObjectClass for PACKAGE and CLASS."
303 (gnome-c-snippet--read-package-and-class
305 'gnome-c-snippet-package
306 'gnome-c-snippet-class))
307 (let (arglist-start body-start)
310 " (gnome-c-snippet--format-package_class package class) "_constructor (")
311 (setq arglist-start (point-marker))
312 (insert "GType *object,
313 guint n_construct_properties,
314 GObjectConstructParam *construct_properties)\n")
315 (setq body-start (point-marker))
316 (if gnome-c-snippet-align-arglist
318 (goto-char arglist-start)
319 (gnome-c-align-arglist-at-point))
320 (indent-region arglist-start (point)))
321 (goto-char body-start)
323 " (gnome-c-snippet--format-PackageClass package class) " *self = "
324 (gnome-c-snippet--format-PACKAGE_CLASS package class) " (object);
326 G_OBJECT_CLASS (" (gnome-c-snippet--format-package_class package class) "_parent_class)->constructor (type, n_construct_properties, construct_properties);
329 (indent-region body-start (point))))
331 (defun gnome-c-snippet-insert-set_property (package class)
332 "Insert 'set_property' vfunc of GObjectClass for PACKAGE and CLASS."
334 (gnome-c-snippet--read-package-and-class
336 'gnome-c-snippet-package
337 'gnome-c-snippet-class))
338 (let (arglist-start body-start)
341 " (gnome-c-snippet--format-package_class package class) "_set_property (")
342 (setq arglist-start (point-marker))
343 (insert "GObject *object,
346 GParamSpec *pspec)\n")
347 (setq body-start (point-marker))
348 (if gnome-c-snippet-align-arglist
350 (goto-char arglist-start)
351 (gnome-c-align-arglist-at-point))
352 (indent-region arglist-start (point)))
353 (goto-char body-start)
355 " (gnome-c-snippet--format-PackageClass package class) " *self = "
356 (gnome-c-snippet--format-PACKAGE_CLASS package class) " (object);
361 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
366 (indent-region body-start (point))))
368 (defun gnome-c-snippet-insert-get_property (package class)
369 "Insert 'get_property' vfunc of GObjectClass for PACKAGE and CLASS."
371 (gnome-c-snippet--read-package-and-class
373 'gnome-c-snippet-package
374 'gnome-c-snippet-class))
375 (let (arglist-start body-start)
378 " (gnome-c-snippet--format-package_class package class) "_get_property (")
379 (setq arglist-start (point-marker))
380 (insert "GObject *object,
383 GParamSpec *pspec)\n")
384 (setq body-start (point-marker))
385 (if gnome-c-snippet-align-arglist
387 (goto-char arglist-start)
388 (gnome-c-align-arglist-at-point))
389 (indent-region arglist-start (point)))
390 (goto-char body-start)
392 " (gnome-c-snippet--format-PackageClass package class) " *self = "
393 (gnome-c-snippet--format-PACKAGE_CLASS package class) " (object);
398 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
403 (indent-region body-start (point))))
405 (defun gnome-c-snippet-insert-dispose (package class)
406 "Insert 'dispose' vfunc of GObjectClass for PACKAGE and CLASS."
408 (gnome-c-snippet--read-package-and-class
410 'gnome-c-snippet-package
411 'gnome-c-snippet-class))
415 " (gnome-c-snippet--format-package_class package class) "_dispose (GObject *object)\n")
416 (setq body-start (point-marker))
418 " (gnome-c-snippet--format-PackageClass package class) " *self = "
419 (gnome-c-snippet--format-PACKAGE_CLASS package class) " (object);
421 G_OBJECT_CLASS (" (gnome-c-snippet--format-package_class package class) "_parent_class)->dispose (object);
424 (indent-region body-start (point))))
426 (defun gnome-c-snippet-insert-finalize (package class)
427 "Insert 'finalize' vfunc of GObjectClass for PACKAGE and CLASS."
429 (gnome-c-snippet--read-package-and-class
431 'gnome-c-snippet-package
432 'gnome-c-snippet-class))
436 " (gnome-c-snippet--format-package_class package class) "_finalize (GObject *object)\n")
437 (setq body-start (point-marker))
439 " (gnome-c-snippet--format-PackageClass package class) " *self = "
440 (gnome-c-snippet--format-PACKAGE_CLASS package class) " (object);
442 G_OBJECT_CLASS (" (gnome-c-snippet--format-package_class package class) "_parent_class)->finalize (object);
445 (indent-region body-start (point))))
447 (defun gnome-c-snippet-insert-dispatch_properties_changed (package class)
448 "Insert 'dispatch_properties_changed vfunc of GObjectClass for
451 (gnome-c-snippet--read-package-and-class
453 'gnome-c-snippet-package
454 'gnome-c-snippet-class))
455 (let (arglist-start body-start)
458 " (gnome-c-snippet--format-package_class package class) "_dispatch_properties_changed (")
459 (setq arglist-start (point-marker))
460 (insert "GObject *object,
462 GParamSpec **pspecs)\n")
463 (setq body-start (point-marker))
464 (if gnome-c-snippet-align-arglist
466 (goto-char arglist-start)
467 (gnome-c-align-arglist-at-point))
468 (indent-region arglist-start (point)))
469 (goto-char body-start)
471 " (gnome-c-snippet--format-PackageClass package class) " *self = "
472 (gnome-c-snippet--format-PACKAGE_CLASS package class) " (object);
474 G_OBJECT_CLASS (" (gnome-c-snippet--format-package_class package class) "_parent_class)->dispatch_properties_changed (object, n_pspecs, pspecs);
477 (indent-region body-start (point))))
479 (defun gnome-c-snippet-insert-notify (package class)
480 "Insert 'notify' vfunc of GObjectClass for PACKAGE and CLASS."
482 (gnome-c-snippet--read-package-and-class
484 'gnome-c-snippet-package
485 'gnome-c-snippet-class))
486 (let (arglist-start body-start)
489 " (gnome-c-snippet--format-package_class package class) "_notify (")
490 (setq arglist-start (point-marker))
491 (insert "GObject *object,
492 GParamSpec *pspec)\n")
493 (setq body-start (point-marker))
494 (if gnome-c-snippet-align-arglist
496 (goto-char arglist-start)
497 (gnome-c-align-arglist-at-point))
498 (indent-region arglist-start (point)))
500 " (gnome-c-snippet--format-PackageClass package class) " *self = "
501 (gnome-c-snippet--format-PACKAGE_CLASS package class) " (object);
503 G_OBJECT_CLASS (" (gnome-c-snippet--format-package_class package class) "_parent_class)->notify (object, pspec);
506 (indent-region body-start (point))))
508 (defun gnome-c-snippet-insert-constructed (package class)
509 "Insert 'constructed' vfunc of GObjectClass for PACKAGE and CLASS."
511 (gnome-c-snippet--read-package-and-class
513 'gnome-c-snippet-package
514 'gnome-c-snippet-class))
518 " (gnome-c-snippet--format-package_class package class) "_constructed (GObject *object)\n")
519 (setq body-start (point-marker))
521 " (gnome-c-snippet--format-PackageClass package class) " *self = "
522 (gnome-c-snippet--format-PACKAGE_CLASS package class) " (object);
524 G_OBJECT_CLASS (" (gnome-c-snippet--format-package_class package class) "_parent_class)->constructed (object);
527 (indent-region body-start (point))))
529 (defvar gnome-c-snippet-snippet-commands
530 '(("G_DECLARE_INTERFACE" . gnome-c-snippet-insert-interface-declaration)
531 ("G_DECLARE_FINAL_TYPE" . gnome-c-snippet-insert-final-class-declaration)
532 ("G_DECLARE_DERIVABLE_TYPE" .
533 gnome-c-snippet-insert-derivable-class-declaration)
534 ("G_DEFINE_INTERFACE" . gnome-c-snippet-insert-interface-definition)
535 ("G_DEFINE_TYPE" . gnome-c-snippet-insert-class-definition)
536 ("G_DEFINE_ABSTRACT_TYPE" .
537 gnome-c-snippet-insert-abstract-class-definition)
538 ("GObjectClass.constructor" . gnome-c-snippet-insert-constructor)
539 ("GObjectClass.set_property" . gnome-c-snippet-insert-set_property)
540 ("GObjectClass.get_property" . gnome-c-snippet-insert-get_property)
541 ("GObjectClass.dispose" . gnome-c-snippet-insert-dispose)
542 ("GObjectClass.finalize" . gnome-c-snippet-insert-finalize)
543 ("GObjectClass.dispatch_properties_changed" .
544 gnome-c-snippet-insert-dispatch_properties_changed)
545 ("GObjectClass.notify" . gnome-c-snippet-insert-notify)
546 ("GObjectClass.constructed" . gnome-c-snippet-insert-constructed)))
549 (defun gnome-c-snippet-insert (snippet)
551 (list (completing-read "Snippet: " gnome-c-snippet-snippet-commands nil t)))
552 (let ((entry (assoc snippet gnome-c-snippet-snippet-commands)))
554 (error "Unknown snippet: %s" snippet))
555 (call-interactively (cdr entry))))
557 (provide 'gnome-c-snippet)
559 ;;; gnome-c-snippet.el ends here