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 (defconst gnome-c-snippet-guess-name-functions
44 '(gnome-c-snippet--guess-name-from-header-buffer
45 gnome-c-snippet--guess-name-from-declaration
46 gnome-c-snippet--guess-name-from-file-name))
48 (defcustom gnome-c-snippet-align-arglist t
49 "Whether to align argument list of the inserted snippet"
51 :group 'gnome-c-style)
53 (make-variable-buffer-local 'gnome-c-snippet-align-arglist)
55 (defun gnome-c-snippet--find-declaration ()
58 (goto-char (point-min))
59 (when (re-search-forward
60 "^G_DECLARE_\\(?:FINAL\\|DERIVABLE\\)_TYPE\\s-*("
62 (setq beg (match-beginning 0))
63 (goto-char (match-end 0))
73 (defun gnome-c-snippet--extract-names-from-declaration (beg end)
75 (narrow-to-region beg end)
76 (goto-char (point-min))
78 (c-forward-syntactic-ws)
79 (let ((capitalized-package-class
80 (buffer-substring-no-properties (point)
83 (c-backward-syntactic-ws)
85 uppercased-package uppercased-class
86 capitalized-package capitalized-class capitalized-parent)
87 (c-forward-syntactic-ws)
89 (setq uppercased-package (split-string
90 (buffer-substring (point)
93 (c-backward-syntactic-ws)
96 (c-forward-syntactic-ws)
98 (setq uppercased-class (split-string
99 (buffer-substring (point)
102 (c-backward-syntactic-ws)
105 (c-forward-syntactic-ws)
107 (setq capitalized-parent (gnome-c-snippet--parse-name
108 (buffer-substring (point)
111 (c-backward-syntactic-ws)
115 (dolist (uppercased uppercased-package)
116 (let* ((length (length uppercased))
118 (substring capitalized-package-class
119 index (+ index length))))
120 (unless (equal (upcase capitalized) uppercased)
122 (push capitalized capitalized-package)
123 (setq index (+ index length))))
124 (dolist (uppercased uppercased-class)
125 (let* ((length (length uppercased))
127 (substring capitalized-package-class
128 index (+ index length))))
129 (unless (equal (upcase capitalized) uppercased)
131 (push capitalized capitalized-class)
132 (setq index (+ index length))))))
133 (list (nreverse capitalized-package)
134 (nreverse capitalized-class)
135 capitalized-parent))))
137 (defun gnome-c-snippet--find-header-buffer ()
138 (pcase (file-name-extension buffer-file-name)
142 (let ((header-file-name
143 (concat (file-name-sans-extension buffer-file-name) ".h")))
146 (with-current-buffer buffer
147 (equal buffer-file-name header-file-name)))
150 (defun gnome-c-snippet--guess-name-from-header-buffer (symbol)
151 (let ((header-buffer (gnome-c-snippet--find-header-buffer)))
153 (with-current-buffer header-buffer
154 (symbol-value (intern (format "gnome-c-snippet-%S" symbol)))))))
156 (defun gnome-c-snippet--guess-name-from-declaration (symbol)
157 (when (memq symbol '(package class parent-package parent-class))
158 (let ((header-buffer (gnome-c-snippet--find-header-buffer)))
160 (with-current-buffer header-buffer
161 (let ((region (gnome-c-snippet--find-declaration))
165 (apply #'gnome-c-snippet--extract-names-from-declaration
169 (`package (car names))
170 (`class (nth 1 names))
171 (`parent-package (list (car (nth 2 names))))
172 (`parent-class (cdr (nth 2 names))))))))))))
174 (defun gnome-c-snippet--guess-name-from-file-name (symbol)
175 (when (memq symbol '(package class))
176 (let ((filename (file-name-sans-extension
177 (file-name-nondirectory buffer-file-name))))
178 (when (string-match-p "-" filename)
179 (let ((names (split-string filename "-")))
181 (`package (list (upcase-initials (car names))))
182 (`class (mapcar #'upcase-initials (cdr names)))))))))
184 (defun gnome-c-snippet--parse-name (name)
187 (insert (upcase-initials name))
188 (goto-char (point-min))
190 ;; Skip characters not recognized by subword-mode.
191 (if (looking-at "[^[:lower:][:upper:][:digit:]]+")
192 (goto-char (match-end 0)))
193 (push (buffer-substring (point) (progn (subword-forward 1)
198 (defun gnome-c-snippet--read-name (prompt symbol &optional default)
199 (when (or current-prefix-arg
200 (not (symbol-value symbol)))
202 (gnome-c-snippet--parse-name
204 (or (if (symbol-value symbol)
205 (gnome-c-snippet--format-Package
206 (symbol-value symbol)))
208 (symbol-value symbol))
210 (defun gnome-c-snippet--read-package-and-class (parent)
211 (append (list (gnome-c-snippet--read-name
212 "Package (CamelCase): "
213 'gnome-c-snippet-package
214 (gnome-c-snippet--format-Package
215 (run-hook-with-args-until-success
216 'gnome-c-snippet-guess-name-functions
218 (gnome-c-snippet--read-name
219 "Class (CamelCase): "
220 'gnome-c-snippet-class
221 (gnome-c-snippet--format-Class
222 (run-hook-with-args-until-success
223 'gnome-c-snippet-guess-name-functions
226 (list (gnome-c-snippet--read-name
227 "Parent package (CamelCase): "
228 'gnome-c-snippet-parent-package
229 (gnome-c-snippet--format-Package
230 (run-hook-with-args-until-success
231 'gnome-c-snippet-guess-name-functions
233 (gnome-c-snippet--read-name
234 "Parent class (CamelCase): "
235 'gnome-c-snippet-parent-class
236 (gnome-c-snippet--format-Class
237 (run-hook-with-args-until-success
238 'gnome-c-snippet-guess-name-functions
241 (defun gnome-c-snippet--read-package-and-interface (parent)
242 (list (gnome-c-snippet--read-name
243 "Package (CamelCase): "
244 'gnome-c-snippet-package
245 (gnome-c-snippet--format-Package
246 (run-hook-with-args-until-success
247 'gnome-c-snippet-guess-name-functions
249 (gnome-c-snippet--read-name
250 "Interface (CamelCase): "
251 'gnome-c-snippet-class
252 (gnome-c-snippet--format-Class
253 (run-hook-with-args-until-success
254 'gnome-c-snippet-guess-name-functions
257 (list (gnome-c-snippet--read-name
258 "Parent package (CamelCase): "
259 'gnome-c-snippet-parent-package
260 (gnome-c-snippet--format-Package
261 (run-hook-with-args-until-success
262 'gnome-c-snippet-guess-name-functions
264 (gnome-c-snippet--read-name
265 "Parent class (CamelCase): "
266 'gnome-c-snippet-parent-class
267 (gnome-c-snippet--format-Class
268 (run-hook-with-args-until-success
269 'gnome-c-snippet-guess-name-functions
272 (defun gnome-c-snippet--format-PACKAGE (package)
273 (mapconcat #'upcase package "_"))
274 (defalias 'gnome-c-snippet--format-CLASS 'gnome-c-snippet--format-PACKAGE)
276 (defun gnome-c-snippet--format-PACKAGE_CLASS (package class)
277 (concat (gnome-c-snippet--format-PACKAGE package)
279 (gnome-c-snippet--format-CLASS class)))
281 (defun gnome-c-snippet--format-package (package)
282 (mapconcat #'downcase package "_"))
283 (defalias 'gnome-c-snippet--format-class 'gnome-c-snippet--format-package)
285 (defun gnome-c-snippet--format-package_class (package class)
286 (concat (gnome-c-snippet--format-package package)
288 (gnome-c-snippet--format-class class)))
290 (defun gnome-c-snippet--format-Package (package)
291 (mapconcat #'identity package ""))
292 (defalias 'gnome-c-snippet--format-Class 'gnome-c-snippet--format-Package)
294 (defun gnome-c-snippet--format-PackageClass (package class)
295 (concat (gnome-c-snippet--format-Package package)
296 (gnome-c-snippet--format-Class class)))
299 (defun gnome-c-snippet-insert-package_class (package class)
300 "Insert the class name before the current point."
301 (interactive (gnome-c-snippet--read-package-and-class nil))
302 (insert (gnome-c-snippet--format-package_class package class)))
305 (defun gnome-c-snippet-insert-PACKAGE_CLASS (package class)
306 "Insert the class name before the current point."
307 (interactive (gnome-c-snippet--read-package-and-class nil))
308 (insert (gnome-c-snippet--format-PACKAGE_CLASS package class)))
311 (defun gnome-c-snippet-insert-PackageClass (package class)
312 "Insert the class name (in CamelCase) before the current point."
313 (interactive (gnome-c-snippet--read-package-and-class nil))
314 (insert (gnome-c-snippet--format-PackageClass package class)))
316 (defun gnome-c-snippet-insert-interface-declaration (package iface
317 parent-package parent-class)
318 "Insert interface declaration for PACKAGE and IFACE"
319 (interactive (gnome-c-snippet--read-package-and-interface t))
321 #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 ())
322 G_DECLARE_INTERFACE (" (gnome-c-snippet--format-PackageClass package iface) ", "
323 (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) ")
326 (defun gnome-c-snippet--insert-class-declaration (package
332 #define " (gnome-c-snippet--format-PACKAGE package) "_TYPE_" (gnome-c-snippet--format-CLASS class) " (" (gnome-c-snippet--format-package_class package class) "_get_type ())
333 G_DECLARE_" (if derivable "DERIVABLE" "FINAL") "_TYPE (" (gnome-c-snippet--format-PackageClass package class) ", "
334 (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) ")
337 (defun gnome-c-snippet-insert-final-class-declaration (package
341 "Insert final class declaration for PACKAGE and CLASS."
342 (interactive (gnome-c-snippet--read-package-and-class t))
343 (gnome-c-snippet--insert-class-declaration package
349 (defun gnome-c-snippet-insert-derivable-class-declaration (package
353 "Insert derivable class declaration for PACKAGE and CLASS."
354 (interactive (gnome-c-snippet--read-package-and-class t))
355 (gnome-c-snippet--insert-class-declaration package
361 (defun gnome-c-snippet-insert-interface-definition (package
365 "Insert class definition for PACKAGE and CLASS."
366 (interactive (gnome-c-snippet--read-package-and-interface t))
369 " (gnome-c-snippet--format-package_class package iface) "_default_init (" (gnome-c-snippet--format-PackageClass package iface) "Interface *iface) {
372 G_DEFINE_INTERFACE (" (gnome-c-snippet--format-PackageClass package iface) ", "
373 (gnome-c-snippet--format-package_class package iface) ", " (gnome-c-snippet--format-PACKAGE parent-package) "_TYPE_" (gnome-c-snippet--format-CLASS parent-class) ")
376 (defun gnome-c-snippet--insert-class-definition (package
382 G_DEFINE_" (if abstract "ABSTRACT_" "") "TYPE (" (gnome-c-snippet--format-PackageClass package class) ", "
383 (gnome-c-snippet--format-package_class package class) ", " (gnome-c-snippet--format-PACKAGE parent-package) "_TYPE_" (gnome-c-snippet--format-CLASS parent-class) ")
386 " (gnome-c-snippet--format-package_class package class) "_class_init (" (gnome-c-snippet--format-PackageClass package class) "Class *klass)
391 " (gnome-c-snippet--format-package_class package class) "_init (" (gnome-c-snippet--format-PackageClass package class) " *self)
396 (defun gnome-c-snippet-insert-class-definition (package
400 "Insert class definition for PACKAGE and CLASS."
401 (interactive (gnome-c-snippet--read-package-and-class t))
402 (gnome-c-snippet--insert-class-definition package
408 (defun gnome-c-snippet-insert-abstract-class-definition (package
412 "Insert abstract class definition for PACKAGE and CLASS."
413 (interactive (gnome-c-snippet--read-package-and-class t))
414 (gnome-c-snippet--insert-class-definition package
420 (defun gnome-c-snippet-insert-constructor (package class)
421 "Insert 'constructor' vfunc of GObjectClass for PACKAGE and CLASS."
422 (interactive (gnome-c-snippet--read-package-and-class nil))
423 (let (arglist-start body-start)
426 " (gnome-c-snippet--format-package_class package class) "_constructor (")
427 (setq arglist-start (point-marker))
428 (insert "GType *object,
429 guint n_construct_properties,
430 GObjectConstructParam *construct_properties)\n")
431 (setq body-start (point-marker))
432 (if gnome-c-snippet-align-arglist
434 (goto-char arglist-start)
435 (gnome-c-align-arglist-at-point))
436 (indent-region arglist-start (point)))
437 (goto-char body-start)
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)->constructor (type, n_construct_properties, construct_properties);
445 (indent-region body-start (point))))
447 (defun gnome-c-snippet-insert-set_property (package class)
448 "Insert 'set_property' vfunc of GObjectClass for PACKAGE and CLASS."
449 (interactive (gnome-c-snippet--read-package-and-class nil))
450 (let (arglist-start body-start)
453 " (gnome-c-snippet--format-package_class package class) "_set_property (")
454 (setq arglist-start (point-marker))
455 (insert "GObject *object,
458 GParamSpec *pspec)\n")
459 (setq body-start (point-marker))
460 (if gnome-c-snippet-align-arglist
462 (goto-char arglist-start)
463 (gnome-c-align-arglist-at-point))
464 (indent-region arglist-start (point)))
465 (goto-char body-start)
467 " (gnome-c-snippet--format-PackageClass package class) " *self = "
468 (gnome-c-snippet--format-PACKAGE_CLASS package class) " (object);
473 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
478 (indent-region body-start (point))))
480 (defun gnome-c-snippet-insert-get_property (package class)
481 "Insert 'get_property' vfunc of GObjectClass for PACKAGE and CLASS."
482 (interactive (gnome-c-snippet--read-package-and-class nil))
483 (let (arglist-start body-start)
486 " (gnome-c-snippet--format-package_class package class) "_get_property (")
487 (setq arglist-start (point-marker))
488 (insert "GObject *object,
491 GParamSpec *pspec)\n")
492 (setq body-start (point-marker))
493 (if gnome-c-snippet-align-arglist
495 (goto-char arglist-start)
496 (gnome-c-align-arglist-at-point))
497 (indent-region arglist-start (point)))
498 (goto-char body-start)
500 " (gnome-c-snippet--format-PackageClass package class) " *self = "
501 (gnome-c-snippet--format-PACKAGE_CLASS package class) " (object);
506 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
511 (indent-region body-start (point))))
513 (defun gnome-c-snippet-insert-dispose (package class)
514 "Insert 'dispose' vfunc of GObjectClass for PACKAGE and CLASS."
515 (interactive (gnome-c-snippet--read-package-and-class nil))
519 " (gnome-c-snippet--format-package_class package class) "_dispose (GObject *object)\n")
520 (setq body-start (point-marker))
522 " (gnome-c-snippet--format-PackageClass package class) " *self = "
523 (gnome-c-snippet--format-PACKAGE_CLASS package class) " (object);
525 G_OBJECT_CLASS (" (gnome-c-snippet--format-package_class package class) "_parent_class)->dispose (object);
528 (indent-region body-start (point))))
530 (defun gnome-c-snippet-insert-finalize (package class)
531 "Insert 'finalize' vfunc of GObjectClass for PACKAGE and CLASS."
532 (interactive (gnome-c-snippet--read-package-and-class nil))
536 " (gnome-c-snippet--format-package_class package class) "_finalize (GObject *object)\n")
537 (setq body-start (point-marker))
539 " (gnome-c-snippet--format-PackageClass package class) " *self = "
540 (gnome-c-snippet--format-PACKAGE_CLASS package class) " (object);
542 G_OBJECT_CLASS (" (gnome-c-snippet--format-package_class package class) "_parent_class)->finalize (object);
545 (indent-region body-start (point))))
547 (defun gnome-c-snippet-insert-dispatch_properties_changed (package class)
548 "Insert 'dispatch_properties_changed vfunc of GObjectClass for
550 (interactive (gnome-c-snippet--read-package-and-class nil))
551 (let (arglist-start body-start)
554 " (gnome-c-snippet--format-package_class package class) "_dispatch_properties_changed (")
555 (setq arglist-start (point-marker))
556 (insert "GObject *object,
558 GParamSpec **pspecs)\n")
559 (setq body-start (point-marker))
560 (if gnome-c-snippet-align-arglist
562 (goto-char arglist-start)
563 (gnome-c-align-arglist-at-point))
564 (indent-region arglist-start (point)))
565 (goto-char body-start)
567 " (gnome-c-snippet--format-PackageClass package class) " *self = "
568 (gnome-c-snippet--format-PACKAGE_CLASS package class) " (object);
570 G_OBJECT_CLASS (" (gnome-c-snippet--format-package_class package class) "_parent_class)->dispatch_properties_changed (object, n_pspecs, pspecs);
573 (indent-region body-start (point))))
575 (defun gnome-c-snippet-insert-notify (package class)
576 "Insert 'notify' vfunc of GObjectClass for PACKAGE and CLASS."
577 (interactive (gnome-c-snippet--read-package-and-class nil))
578 (let (arglist-start body-start)
581 " (gnome-c-snippet--format-package_class package class) "_notify (")
582 (setq arglist-start (point-marker))
583 (insert "GObject *object,
584 GParamSpec *pspec)\n")
585 (setq body-start (point-marker))
586 (if gnome-c-snippet-align-arglist
588 (goto-char arglist-start)
589 (gnome-c-align-arglist-at-point))
590 (indent-region arglist-start (point)))
592 " (gnome-c-snippet--format-PackageClass package class) " *self = "
593 (gnome-c-snippet--format-PACKAGE_CLASS package class) " (object);
595 G_OBJECT_CLASS (" (gnome-c-snippet--format-package_class package class) "_parent_class)->notify (object, pspec);
598 (indent-region body-start (point))))
600 (defun gnome-c-snippet-insert-constructed (package class)
601 "Insert 'constructed' vfunc of GObjectClass for PACKAGE and CLASS."
602 (interactive (gnome-c-snippet--read-package-and-class nil))
606 " (gnome-c-snippet--format-package_class package class) "_constructed (GObject *object)\n")
607 (setq body-start (point-marker))
609 " (gnome-c-snippet--format-PackageClass package class) " *self = "
610 (gnome-c-snippet--format-PACKAGE_CLASS package class) " (object);
612 G_OBJECT_CLASS (" (gnome-c-snippet--format-package_class package class) "_parent_class)->constructed (object);
615 (indent-region body-start (point))))
617 (defun gnome-c-snippet-insert-class-init (package class)
618 "Insert '_class_init' function for PACKAGE and CLASS."
619 (interactive (gnome-c-snippet--read-package-and-class nil))
622 " (gnome-c-snippet--format-package_class package class) "_class_init (" (gnome-c-snippet--format-PackageClass package class) "Class *klass)\n")
627 (defun gnome-c-snippet-insert-init (package class)
628 "Insert '_init' function for PACKAGE and CLASS."
629 (interactive (gnome-c-snippet--read-package-and-class nil))
632 " (gnome-c-snippet--format-package_class package class) "_init (" (gnome-c-snippet--format-PackageClass package class) " *self)\n")
637 (defvar gnome-c-snippet-snippet-commands
638 '(("G_DECLARE_INTERFACE" . gnome-c-snippet-insert-interface-declaration)
639 ("G_DECLARE_FINAL_TYPE" . gnome-c-snippet-insert-final-class-declaration)
640 ("G_DECLARE_DERIVABLE_TYPE" .
641 gnome-c-snippet-insert-derivable-class-declaration)
642 ("G_DEFINE_INTERFACE" . gnome-c-snippet-insert-interface-definition)
643 ("G_DEFINE_TYPE" . gnome-c-snippet-insert-class-definition)
644 ("G_DEFINE_ABSTRACT_TYPE" .
645 gnome-c-snippet-insert-abstract-class-definition)
646 ("GObjectClass.constructor" . gnome-c-snippet-insert-constructor)
647 ("GObjectClass.set_property" . gnome-c-snippet-insert-set_property)
648 ("GObjectClass.get_property" . gnome-c-snippet-insert-get_property)
649 ("GObjectClass.dispose" . gnome-c-snippet-insert-dispose)
650 ("GObjectClass.finalize" . gnome-c-snippet-insert-finalize)
651 ("GObjectClass.dispatch_properties_changed" .
652 gnome-c-snippet-insert-dispatch_properties_changed)
653 ("GObjectClass.notify" . gnome-c-snippet-insert-notify)
654 ("GObjectClass.constructed" . gnome-c-snippet-insert-constructed)
655 ("_class_init" . gnome-c-snippet-insert-class-init)
656 ("_init" . gnome-c-snippet-insert-init)))
659 (defun gnome-c-snippet-insert (snippet)
661 (list (completing-read "Snippet: " gnome-c-snippet-snippet-commands nil t)))
662 (let ((entry (assoc snippet gnome-c-snippet-snippet-commands)))
664 (error "Unknown snippet: %s" snippet))
665 (call-interactively (cdr entry))))
667 (provide 'gnome-c-snippet)
669 ;;; gnome-c-snippet.el ends here