-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathflex-compile-make.el
232 lines (201 loc) · 8.67 KB
/
flex-compile-make.el
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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
;;; flex-compile-make.el --- Compile functions -*- lexical-binding: t; -*-
;; Copyright (C) 2015 - 2023 Paul Landes
;; Author: Paul Landes
;; Maintainer: Paul Landes
;; Keywords: make compile flexible processes
;; URL: https://github.com/plandes/flex-compile
;; Package-Requires: ((emacs "26.1"))
;; Package-Version: 0
;; This file is not part of GNU Emacs.
;; This program 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 2, or (at your option)
;; any later version.
;; This program 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 this program; if not, write to the Free Software
;; Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
;;; Commentary:
;; Implementation compiler for make(files).
;; Not customizing `compilation-always-kill' to t will result in windows
;; disappearing on a compilation interruption.
;;; Code:
(require 'cl-lib)
(require 'dash)
(require 'compile)
(require 'choice-program-complete)
(require 'flex-compile-manage)
;;; make file compiler
(defclass make-flex-compiler (single-buffer-flex-compiler
conf-file-flex-compiler)
((target :initarg :target
:initform nil
:type (or null string)
:documentation "The make file target to satisfy.")
(run-target :initarg :run-target
:initform nil
:type (or null string)
:documentation "\
The target used to run or test as the secondary compilation functionality."))
;; see `flex-compiler::config-persistent-doc'
:method-invocation-order :c3
:documentation "\
This compiler invokes make as an asynchronous process in a
buffer. The first target, `run' target, and `clean' target are
invoked respectfully with *compile*, *run* and *clean* Emacs
commands (see [usage](#usage)).
This is a special compiler in it's configuration. Instead of
setting properties, the default configuration mechanism is to set
the make target instead. If you want to set a flex compiler
property, use `\\C-u 0 \\C-u'.
When setting the configuration file the target property is unset.")
(cl-defmethod initialize-instance ((this make-flex-compiler) &optional slots)
"Initialize THIS instance using SLOTS as initial values."
(let* ((fn #'(lambda (this compiler &rest slots)
(ignore slots)
(flex-compiler-makefile-read compiler this)))
(props (list (config-eval-prop :object-name 'target
:prompt "Target"
:func fn
:prop-entry this
:input-type 'last
:order 1)
(config-eval-prop :object-name 'run-target
:prompt "Run target"
:func fn
:prop-entry this
:input-type 'last
:order 2))))
(setq slots (plist-put slots :object-name "make")
slots (plist-put slots :description "Make")
slots (plist-put slots :validate-modes '(makefile-gmake-mode))
slots (plist-put slots :buffer-name "compilation")
slots (plist-put slots :kill-buffer-clean nil)
slots (plist-put slots
:props (append (plist-get slots :props) props))))
(cl-call-next-method this slots))
(defun flex-compiler-make-compiler-handle-finish (buffer status)
"Notify the make flex compiler instance of completion of the make compile.
The `flex-compiler-make-compiler-finish' is called with STATUS.
BUFFER, ignored."
(if (and (stringp status)
(string-match "^exited abnormally with code \\([0-9]+\\)" status))
(setq status (string-to-number (match-string 1 status))))
(if (and (stringp status)
(equal "finished" (string-trim status)))
(setq status 0))
(flex-compiler-make-compiler-finish (flex-compiler-by-name "make") status))
(cl-defmethod flex-compiler-load-libraries ((this make-flex-compiler))
"Load library `compile' for THIS compiler."
(ignore this)
(require 'compile)
(add-hook 'compilation-finish-functions
'flex-compiler-make-compiler-handle-finish))
(cl-defmethod flex-compiler-make-compiler-finish ((this make-flex-compiler)
status)
"Display the compliation buffer based on 0 a STATUS for THIS compiler.
The compilation buffer is displayed when an error is detected, and the
corresponding compiler display mode property `buffer-new-mode'
`buffer-exists-mode' are set to `only-on-error'."
(with-slots (buffer-new-mode buffer-exists-mode last-displayed-context) this
(let* ((buf (cdr (assq 'buffer last-displayed-context)))
(display-mode (-> (cdr (assq 'newp last-displayed-context))
(if 'new 'exists)
(assq (flex-compiler-display-modes this))
cdr))
(pop-buffer (and (eq 'only-if-error display-mode)
(null (get-buffer-window buf))
(not (eq status 0)))))
(when pop-buffer
(message "Compilation error with status: %S" status)
(display-buffer buf)))))
(cl-defmethod flex-compiler-run-make ((this make-flex-compiler)
&optional target)
"Invoke a make compilation in an async inferior buffer for THIS compiler.
TARGET is the make file target to run/satisfy.
This is done by creating a command with `make' found in the executable path."
(let* ((makefile (slot-value this 'config-file))
(dir (file-name-directory makefile))
(dir-switch (if dir (format "-C %s" dir)))
(command (concat "make -k " dir-switch " -f "
(file-name-nondirectory makefile)
(if target " ") target)))
(setenv "EMACS" "emacs")
;; ignore annoying 'A compilation process is running; kill it? (yes or no)'
;; in latex override code eliminated in favor of `compilation-always-kill'
(message "Compile command: %s" command)
(compile command)))
(cl-defmethod flex-compiler-makefile-targets ((this make-flex-compiler))
"Return all targets supported by the set makefile on THIS compiler."
(let* ((makefile (slot-value this 'config-file))
(dir (file-name-directory makefile))
targets)
(with-temp-buffer
(insert (shell-command-to-string (format "make -prRn -C %s" dir)))
(goto-char (point-min))
(while (re-search-forward "^\\([a-zA-Z0-9-]+\\):" nil t)
(setq targets
(->> (match-string 1)
substring-no-properties
list
(append targets)))))
(->> targets
(cl-remove-if #'(lambda (elt)
(member elt '("run" "clean")))))))
(cl-defmethod flex-compiler-makefile-read ((this make-flex-compiler) prop)
"Read target used invoke a make compilation using THIS compiler.
PROP is the `config-eval-prop' instance used to configure the run target.
See the class's `initialize-instance', which is how this method is gets
invoked."
(config-prop-entry-set-required this)
(let* ((none "<none>")
(targets (append (flex-compiler-makefile-targets this) (list none)))
(history (slot-value prop 'history))
(init (or (->> history
symbol-value
delete-dups
(-filter (lambda (elt) (not (equal none elt))))
cl-second)
none)))
(->> (choice-program-complete
(format "Target or %s for none" none)
targets t nil nil history init nil nil t)
(funcall #'(lambda (elt)
(if (equal none elt) nil elt))))))
(cl-defmethod config-prop-set ((this make-flex-compiler) prop val)
"Set property PROP to VAL on THIS compiler.
This resets the target when changing the file."
(when (eq (config-prop-name prop) 'config-file)
(setf (slot-value this 'target) nil))
(cl-call-next-method this prop val))
(cl-defmethod config-prop-entry-configure ((this make-flex-compiler)
config-options)
"Special behavior when configuring THIS compiler.
CONFIG-OPTIONS:
- when -1 (using \\[universal-argument] with 0) prompt for the target
- when nil short cut to setting the make target"
(->> (cond ((eq config-options -1) nil) ; unversal arg with 0
;; shortcut to setting the make target
((null config-options) '(prop-name target))
(t config-options))
(cl-call-next-method this)))
(cl-defmethod flex-compiler-start-buffer ((this make-flex-compiler)
start-type)
"Return a new buffer for THIS compiler with a processing compilation.
See the `single-buffer-flex-compiler' implementation of
`flex-compiler-start-buffer' for more information and START-TYPE."
(with-slots (target run-target start-directory) this
(let ((default-directory start-directory))
(cl-case start-type
(compile (flex-compiler-run-make this target))
(run (flex-compiler-run-make this (or run-target "run")))
(clean (flex-compiler-run-make this "clean"))
(clean-all (flex-compiler-run-make this "cleanall"))))))
;; register the compiler
(flex-compile-manager-register flex-compile-manage-inst (make-flex-compiler))
(provide 'flex-compile-make)
;;; flex-compile-make.el ends here