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)
33 (declare-function subword-forward "subword.el" (&optional arg))
35 (defvar gnome-c-snippet-package nil)
36 (make-variable-buffer-local 'gnome-c-snippet-package)
38 (defvar gnome-c-snippet-class nil)
39 (make-variable-buffer-local 'gnome-c-snippet-class)
41 (defvar gnome-c-snippet-parent-package nil)
42 (make-variable-buffer-local 'gnome-c-snippet-parent-package)
44 (defvar gnome-c-snippet-parent-class nil)
45 (make-variable-buffer-local 'gnome-c-snippet-parent-class)
47 (defcustom gnome-c-snippet-align-arglist t
48 "Whether to align argument list of the inserted snippet"
50 :group 'gnome-c-style)
52 (make-variable-buffer-local 'gnome-c-snippet-align-arglist)
54 (defun gnome-c-snippet--parse-name (name)
59 (goto-char (point-min))
61 ;; Skip characters not recognized by subword-mode.
62 (if (looking-at "[^[:lower:][:upper:][:digit:]]+")
63 (goto-char (match-end 0)))
64 (push (buffer-substring (point) (progn (subword-forward 1)
69 (defun gnome-c-snippet--read-package-and-class (package-prompt
73 (when (or current-prefix-arg
74 (not (and (symbol-value package-symbol)
75 (symbol-value class-symbol))))
77 (gnome-c-snippet--parse-name
78 (read-string (or package-prompt
79 "Package (CamelCase): ")
80 (if (symbol-value package-symbol)
81 (gnome-c-snippet--format-Package
82 (symbol-value package-symbol))))))
84 (gnome-c-snippet--parse-name
85 (read-string (or class-prompt
86 "Class (CamelCase): ")
87 (if (symbol-value class-symbol)
88 (gnome-c-snippet--format-Class
89 (symbol-value class-symbol)))))))
90 (list (symbol-value package-symbol) (symbol-value class-symbol)))
92 (defun gnome-c-snippet--format-PACKAGE (package)
93 (mapconcat #'upcase package "_"))
94 (defalias 'gnome-c-snippet--format-CLASS 'gnome-c-snippet--format-PACKAGE)
96 (defun gnome-c-snippet--format-PACKAGE_CLASS (package class)
97 (concat (gnome-c-snippet--format-PACKAGE package)
99 (gnome-c-snippet--format-CLASS class)))
101 (defun gnome-c-snippet--format-package (package)
102 (mapconcat #'downcase package "_"))
103 (defalias 'gnome-c-snippet--format-class 'gnome-c-snippet--format-package)
105 (defun gnome-c-snippet--format-package_class (package class)
106 (concat (gnome-c-snippet--format-package package)
108 (gnome-c-snippet--format-class class)))
110 (defun gnome-c-snippet--format-Package (package)
111 (mapconcat #'identity package ""))
112 (defalias 'gnome-c-snippet--format-Class 'gnome-c-snippet--format-Package)
114 (defun gnome-c-snippet--format-PackageClass (package class)
115 (concat (gnome-c-snippet--format-Package package)
116 (gnome-c-snippet--format-Class class)))
119 (defun gnome-c-snippet-insert-package_class (package class)
120 "Insert the class name before the current point."
121 (interactive (gnome-c-snippet--read-package-and-class
123 'gnome-c-snippet-package
124 'gnome-c-snippet-class))
125 (insert (gnome-c-snippet--format-package_class package class)))
128 (defun gnome-c-snippet-insert-PACKAGE_CLASS (package class)
129 "Insert the class name before the current point."
130 (interactive (gnome-c-snippet--read-package-and-class
132 'gnome-c-snippet-package
133 'gnome-c-snippet-class))
134 (insert (gnome-c-snippet--format-PACKAGE_CLASS package class)))
137 (defun gnome-c-snippet-insert-PackageClass (package class)
138 "Insert the class name (in CamelCase) before the current point."
139 (interactive (gnome-c-snippet--read-package-and-class
141 'gnome-c-snippet-package
142 'gnome-c-snippet-class))
143 (insert (gnome-c-snippet--format-PackageClass package class)))
145 (defun gnome-c-snippet-insert-interface-declaration (package iface
146 parent-package parent-class)
147 "Insert interface declaration for PACKAGE and IFACE"
149 (append (gnome-c-snippet--read-package-and-class
151 "Interface (CamelCase): "
152 'gnome-c-snippet-package
153 'gnome-c-snippet-class)
154 (gnome-c-snippet--read-package-and-class
155 "Parent package (CamelCase): "
156 "Parent class (CamelCase): "
157 'gnome-c-snippet-parent-package
158 'gnome-c-snippet-parent-class)))
160 #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 ())
161 G_DECLARE_INTERFACE (" (gnome-c-snippet--format-PackageClass package iface) ", "
162 (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) ")
165 (defun gnome-c-snippet--insert-class-declaration (package
171 #define " (gnome-c-snippet--format-PACKAGE package) "_TYPE_" (gnome-c-snippet--format-CLASS class) " (" (gnome-c-snippet--format-package_class package class) "_get_type ())
172 G_DECLARE_" (if derivable "DERIVABLE" "FINAL") "_TYPE (" (gnome-c-snippet--format-PackageClass package class) ", "
173 (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) ")
176 (defun gnome-c-snippet-insert-final-class-declaration (package
180 "Insert final class declaration for PACKAGE and CLASS."
182 (append (gnome-c-snippet--read-package-and-class
184 'gnome-c-snippet-package
185 'gnome-c-snippet-class)
186 (gnome-c-snippet--read-package-and-class
187 "Parent package (CamelCase): "
188 "Parent class (CamelCase): "
189 'gnome-c-snippet-parent-package
190 'gnome-c-snippet-parent-class)))
191 (gnome-c-snippet--insert-class-declaration package
197 (defun gnome-c-snippet-insert-derivable-class-declaration (package
201 "Insert derivable class declaration for PACKAGE and CLASS."
203 (append (gnome-c-snippet--read-package-and-class
205 'gnome-c-snippet-package
206 'gnome-c-snippet-class)
207 (gnome-c-snippet--read-package-and-class
208 "Parent package (CamelCase): "
209 "Parent class (CamelCase): "
210 'gnome-c-snippet-parent-package
211 'gnome-c-snippet-parent-class)))
212 (gnome-c-snippet--insert-class-declaration package
218 (defun gnome-c-snippet-insert-interface-definition (package
222 "Insert class definition for PACKAGE and CLASS."
224 (append (gnome-c-snippet--read-package-and-class
226 "Interface (CamelCase): "
227 'gnome-c-snippet-package
228 'gnome-c-snippet-class)
229 (gnome-c-snippet--read-package-and-class
230 "Parent package (CamelCase): "
231 "Parent class (CamelCase): "
232 'gnome-c-snippet-parent-package
233 'gnome-c-snippet-parent-class)))
236 " (gnome-c-snippet--format-package_class package iface) "_default_init (" (gnome-c-snippet--format-PackageClass package iface) "Interface *iface) {
239 G_DEFINE_INTERFACE (" (gnome-c-snippet--format-PackageClass package iface) ", "
240 (gnome-c-snippet--format-package_class package iface) ", " (gnome-c-snippet--format-PACKAGE parent-package) "_TYPE_" (gnome-c-snippet--format-CLASS parent-class) ")
243 (defun gnome-c-snippet--insert-class-definition (package
249 G_DEFINE_" (if abstract "ABSTRACT_" "") "TYPE (" (gnome-c-snippet--format-PackageClass package class) ", "
250 (gnome-c-snippet--format-package_class package class) ", " (gnome-c-snippet--format-PACKAGE parent-package) "_TYPE_" (gnome-c-snippet--format-CLASS parent-class) ")
253 " (gnome-c-snippet--format-package_class package class) "_class_init (" (gnome-c-snippet--format-PackageClass package class) "Class *klass)
258 " (gnome-c-snippet--format-package_class package class) "_init (" (gnome-c-snippet--format-PackageClass package class) " *self)
263 (defun gnome-c-snippet-insert-class-definition (package
267 "Insert class definition for PACKAGE and CLASS."
269 (append (gnome-c-snippet--read-package-and-class
271 'gnome-c-snippet-package
272 'gnome-c-snippet-class)
273 (gnome-c-snippet--read-package-and-class
274 "Parent package (CamelCase): "
275 "Parent class (CamelCase): "
276 'gnome-c-snippet-parent-package
277 'gnome-c-snippet-parent-class)))
278 (gnome-c-snippet--insert-class-definition package
284 (defun gnome-c-snippet-insert-abstract-class-definition (package
288 "Insert abstract class definition for PACKAGE and CLASS."
290 (append (gnome-c-snippet--read-package-and-class
292 'gnome-c-snippet-package
293 'gnome-c-snippet-class)
294 (gnome-c-snippet--read-package-and-class
295 "Parent package (CamelCase): "
296 "Parent class (CamelCase): "
297 'gnome-c-snippet-parent-package
298 'gnome-c-snippet-parent-class)))
299 (gnome-c-snippet--insert-class-definition package
305 (defun gnome-c-snippet-insert-constructor (package class)
306 "Insert 'constructor' vfunc of GObjectClass for PACKAGE and CLASS."
308 (gnome-c-snippet--read-package-and-class
310 'gnome-c-snippet-package
311 'gnome-c-snippet-class))
312 (let (arglist-start body-start)
315 " (gnome-c-snippet--format-package_class package class) "_constructor (")
316 (setq arglist-start (point-marker))
317 (insert "GType *object,
318 guint n_construct_properties,
319 GObjectConstructParam *construct_properties)\n")
320 (setq body-start (point-marker))
321 (if gnome-c-snippet-align-arglist
323 (goto-char arglist-start)
324 (gnome-c-align-arglist-at-point))
325 (indent-region arglist-start (point)))
326 (goto-char body-start)
328 " (gnome-c-snippet--format-PackageClass package class) " *self = "
329 (gnome-c-snippet--format-PACKAGE_CLASS package class) " (object);
331 G_OBJECT_CLASS (" (gnome-c-snippet--format-package_class package class) "_parent_class)->constructed (type, n_construct_properties, construct_properties);
334 (indent-region body-start (point))))
336 (defun gnome-c-snippet-insert-set_property (package class)
337 "Insert 'set_property' vfunc of GObjectClass for PACKAGE and CLASS."
339 (gnome-c-snippet--read-package-and-class
341 'gnome-c-snippet-package
342 'gnome-c-snippet-class))
343 (let (arglist-start body-start)
346 " (gnome-c-snippet--format-package_class package class) "_set_property (")
347 (setq arglist-start (point-marker))
348 (insert "GObject *object,
351 GParamSpec *pspec)\n")
352 (setq body-start (point-marker))
353 (if gnome-c-snippet-align-arglist
355 (goto-char arglist-start)
356 (gnome-c-align-arglist-at-point))
357 (indent-region arglist-start (point)))
358 (goto-char body-start)
360 " (gnome-c-snippet--format-PackageClass package class) " *self = "
361 (gnome-c-snippet--format-PACKAGE_CLASS package class) " (object);
366 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
371 (indent-region body-start (point))))
373 (defun gnome-c-snippet-insert-get_property (package class)
374 "Insert 'get_property' vfunc of GObjectClass for PACKAGE and CLASS."
376 (gnome-c-snippet--read-package-and-class
378 'gnome-c-snippet-package
379 'gnome-c-snippet-class))
380 (let (arglist-start body-start)
383 " (gnome-c-snippet--format-package_class package class) "_get_property (")
384 (setq arglist-start (point-marker))
385 (insert "GObject *object,
388 GParamSpec *pspec)\n")
389 (setq body-start (point-marker))
390 (if gnome-c-snippet-align-arglist
392 (goto-char arglist-start)
393 (gnome-c-align-arglist-at-point))
394 (indent-region arglist-start (point)))
395 (goto-char body-start)
397 " (gnome-c-snippet--format-PackageClass package class) " *self = "
398 (gnome-c-snippet--format-PACKAGE_CLASS package class) " (object);
403 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
408 (indent-region body-start (point))))
410 (defun gnome-c-snippet-insert-dispose (package class)
411 "Insert 'dispose' vfunc of GObjectClass for PACKAGE and CLASS."
413 (gnome-c-snippet--read-package-and-class
415 'gnome-c-snippet-package
416 'gnome-c-snippet-class))
420 " (gnome-c-snippet--format-package_class package class) "_dispose (GObject *object)\n")
421 (setq body-start (point-marker))
423 " (gnome-c-snippet--format-PackageClass package class) " *self = "
424 (gnome-c-snippet--format-PACKAGE_CLASS package class) " (object);
426 G_OBJECT_CLASS (" (gnome-c-snippet--format-package_class package class) "_parent_class)->dispose (object);
429 (indent-region body-start (point))))
431 (defun gnome-c-snippet-insert-finalize (package class)
432 "Insert 'finalize' vfunc of GObjectClass for PACKAGE and CLASS."
434 (gnome-c-snippet--read-package-and-class
436 'gnome-c-snippet-package
437 'gnome-c-snippet-class))
441 " (gnome-c-snippet--format-package_class package class) "_finalize (GObject *object)\n")
442 (setq body-start (point-marker))
444 " (gnome-c-snippet--format-PackageClass package class) " *self = "
445 (gnome-c-snippet--format-PACKAGE_CLASS package class) " (object);
447 G_OBJECT_CLASS (" (gnome-c-snippet--format-package_class package class) "_parent_class)->finalize (object);
450 (indent-region body-start (point))))
452 (defun gnome-c-snippet-insert-dispatch_properties_changed (package class)
453 "Insert 'dispatch_properties_changed vfunc of GObjectClass for
456 (gnome-c-snippet--read-package-and-class
458 'gnome-c-snippet-package
459 'gnome-c-snippet-class))
460 (let (arglist-start body-start)
463 " (gnome-c-snippet--format-package_class package class) "_dispatch_properties_changed (")
464 (setq arglist-start (point-marker))
465 (insert "GObject *object,
467 GParamSpec **pspecs)\n")
468 (setq body-start (point-marker))
469 (if gnome-c-snippet-align-arglist
471 (goto-char arglist-start)
472 (gnome-c-align-arglist-at-point))
473 (indent-region arglist-start (point)))
474 (goto-char body-start)
476 " (gnome-c-snippet--format-PackageClass package class) " *self = "
477 (gnome-c-snippet--format-PACKAGE_CLASS package class) " (object);
479 G_OBJECT_CLASS (" (gnome-c-snippet--format-package_class package class) "_parent_class)->dispatch_properties_changed (object, n_pspecs, pspecs);
482 (indent-region body-start (point))))
484 (defun gnome-c-snippet-insert-notify (package class)
485 "Insert 'notify' vfunc of GObjectClass for PACKAGE and CLASS."
487 (gnome-c-snippet--read-package-and-class
489 'gnome-c-snippet-package
490 'gnome-c-snippet-class))
491 (let (arglist-start body-start)
494 " (gnome-c-snippet--format-package_class package class) "_notify (")
495 (setq arglist-start (point-marker))
496 (insert "GObject *object,
497 GParamSpec *pspec)\n")
498 (setq body-start (point-marker))
499 (if gnome-c-snippet-align-arglist
501 (goto-char arglist-start)
502 (gnome-c-align-arglist-at-point))
503 (indent-region arglist-start (point)))
505 " (gnome-c-snippet--format-PackageClass package class) " *self = "
506 (gnome-c-snippet--format-PACKAGE_CLASS package class) " (object);
508 G_OBJECT_CLASS (" (gnome-c-snippet--format-package_class package class) "_parent_class)->notify (object, pspec);
511 (indent-region body-start (point))))
513 (defun gnome-c-snippet-insert-constructed (package class)
514 "Insert 'constructed' vfunc of GObjectClass for PACKAGE and CLASS."
516 (gnome-c-snippet--read-package-and-class
518 'gnome-c-snippet-package
519 'gnome-c-snippet-class))
523 " (gnome-c-snippet--format-package_class package class) "_constructed (GObject *object)\n")
524 (setq body-start (point-marker))
526 " (gnome-c-snippet--format-PackageClass package class) " *self = "
527 (gnome-c-snippet--format-PACKAGE_CLASS package class) " (object);
529 G_OBJECT_CLASS (" (gnome-c-snippet--format-package_class package class) "_parent_class)->constructed (object);
532 (indent-region body-start (point))))
534 (defvar gnome-c-snippet-snippet-commands
535 '(("G_DECLARE_INTERFACE" . gnome-c-snippet-insert-interface-declaration)
536 ("G_DECLARE_FINAL_TYPE" . gnome-c-snippet-insert-final-class-declaration)
537 ("G_DECLARE_DERIVABLE_TYPE" .
538 gnome-c-snippet-insert-derivable-class-declaration)
539 ("G_DEFINE_INTERFACE" . gnome-c-snippet-insert-interface-definition)
540 ("G_DEFINE_TYPE" . gnome-c-snippet-insert-class-definition)
541 ("G_DEFINE_ABSTRACT_TYPE" .
542 gnome-c-snippet-insert-abstract-class-definition)
543 ("GObjectClass.constructor" . gnome-c-snippet-insert-constructor)
544 ("GObjectClass.set_property" . gnome-c-snippet-insert-set_property)
545 ("GObjectClass.get_property" . gnome-c-snippet-insert-get_property)
546 ("GObjectClass.dispose" . gnome-c-snippet-insert-dispose)
547 ("GObjectClass.finalize" . gnome-c-snippet-insert-finalize)
548 ("GObjectClass.dispatch_properties_changed" .
549 gnome-c-snippet-insert-dispatch_properties_changed)
550 ("GObjectClass.notify" . gnome-c-snippet-insert-notify)
551 ("GObjectClass.contructed" . gnome-c-snippet-insert-constructed)))
554 (defun gnome-c-snippet-insert (snippet)
556 (list (completing-read "Snippet: " gnome-c-snippet-snippet-commands nil t)))
557 (let ((entry (assoc snippet gnome-c-snippet-snippet-commands)))
559 (error "Unknown snippet: %s" snippet))
560 (call-interactively (cdr entry))))
562 (provide 'gnome-c-snippet)
564 ;;; gnome-c-snippet.el ends here