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
|
;;; generate-lisp-file.el --- utility functions for generated files -*- lexical-binding: t -*-
;; Copyright (C) 2022 Free Software Foundation, Inc.
;; Keywords: maint
;; Package: emacs
;; This file is part of GNU Emacs.
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;;; Code:
(eval-when-compile (require 'cl-lib))
(cl-defun generate-lisp-file-heading (file generator
&key title commentary (code t))
"Insert a standard header for FILE created by GENERATOR.
This header will specify that this is a generated file that
should not be edited.
If `standard-output' is bound to a buffer, insert in that buffer.
If no, insert at point in the current buffer.
TITLE (if any) will be used in the first line.
COMMENTARY (if given) will be inserted as a comment.
If CODE is non-nil (which is the default), a Code: line is
inserted."
(with-current-buffer (if (bufferp standard-output)
standard-output
(current-buffer))
(insert ";;; " (file-name-nondirectory file)
" --- "
(or title "automatically generated")
" (do not edit) "
" -*- lexical-binding: t -*-\n"
(format ";; Generated by the `%s' function.\n\n" generator)
";; This file is part of GNU Emacs.\n\n")
(when commentary
(insert ";;; Commentary:\n\n")
(let ((start (point))
(fill-prefix ";; "))
(insert ";; " commentary)
(fill-region start (point))))
(ensure-empty-lines 1)
(when code
(insert ";;; Code:\n\n"))))
(cl-defun generate-lisp-file-trailer (file &key version inhibit-provide
(coding 'utf-8-emacs-unix) autoloads
compile provide)
"Insert a standard trailer for FILE.
By default, this trailer inhibits version control, byte
compilation, updating autoloads, and uses a `utf-8-emacs-unix'
coding system. These can be inhibited by providing non-nil
values to the VERSION, NO-PROVIDE, AUTOLOADS and COMPILE
keyword arguments.
CODING defaults to `utf-8-emacs-unix'. Use a nil value to
inhibit generating this setting, or a coding system value to use
that.
If PROVIDE is non-nil, use that in the `provide' statement
instead of using FILE as the basis.
If `standard-output' is bound to a buffer, insert in that buffer.
If no, insert at point in the current buffer."
(with-current-buffer (if (bufferp standard-output)
standard-output
(current-buffer))
(ensure-empty-lines 1)
(unless inhibit-provide
(insert (format "(provide '%s)\n\n"
(or provide
(file-name-sans-extension
(file-name-nondirectory file))))))
;; Some of the strings below are chopped into bits to inhibit
;; automatic scanning tools from thinking that they are actual
;; directives.
(insert ";; Local " "Variables:\n")
(unless version
(insert ";; version-control: never\n"))
(unless compile
(insert ";; no-byte-" "compile: t\n")) ;; #$ is byte-compiled into nil.
(unless autoloads
(insert ";; no-update-autoloads: t\n"))
(when coding
(insert (format ";; coding: %s\n"
(if (eq coding t)
'utf-8-emacs-unix
coding))))
(insert
";; End:\n\n"
";;; " (file-name-nondirectory file) " ends here\n")))
(provide 'generate-lisp-file)
;;; generate-lisp-file.el ends here
|
