-
Notifications
You must be signed in to change notification settings - Fork 36
/
flymake.el
2171 lines (1875 loc) · 90.6 KB
/
flymake.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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
;;; flymake.el --- a universal on-the-fly syntax checker
;; Copyright (C) 2003-2012 Free Software Foundation, Inc.
;; Author: Pavel Kobyakov <pk_at_work@yahoo.com>
;; Maintainer: Sam Graham <libflymake-emacs BLAHBLAH illusori.co.uk>
;; Jen-Chieh Shen <jcs090218@gmail.com>
;; Version: 0.4.16
;; Keywords: c languages tools
;; 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:
;;
;; Flymake is a minor Emacs mode performing on-the-fly syntax
;; checks using the external syntax check tool (for C/C++ this
;; is usually the compiler)
;;; Bugs/todo:
;; - Only uses "Makefile", not "makefile" or "GNUmakefile"
;; (from http://bugs.debian.org/337339).
;;; Code:
(require 'cc-defs)
(eval-when-compile (require 'cl))
(eval-when-compile (require 'tramp))
(if (featurep 'xemacs) (require 'overlay))
(defvar flymake-is-running nil
"If t, flymake syntax check process is running for the current buffer.")
(make-variable-buffer-local 'flymake-is-running)
(defvar flymake-buffers 0
"Refcount of number of buffers in Flymake mode, when zero the last-change timer is disabled.")
(defvar flymake-timer nil
"Timer for starting syntax check.")
(defvar flymake-last-change-time nil
"Time of last buffer change.")
(make-variable-buffer-local 'flymake-last-change-time)
(defvar flymake-check-start-time nil
"Time at which syntax check was started.")
(make-variable-buffer-local 'flymake-check-start-time)
(defvar flymake-check-was-interrupted nil
"Non-nil if syntax check was killed by `flymake-compile'.")
(make-variable-buffer-local 'flymake-check-was-interrupted)
(defvar flymake-check-should-restart nil
"Non-nil if syntax check should restart after terminating.")
(make-variable-buffer-local 'flymake-check-should-restart)
(defvar flymake-err-info nil
"Sorted list of line numbers and lists of err info in the form (file, err-text).")
(make-variable-buffer-local 'flymake-err-info)
(defvar flymake-new-err-info nil
"Same as `flymake-err-info', effective when a syntax check is in progress.")
(make-variable-buffer-local 'flymake-new-err-info)
(defcustom flymake-start-syntax-check-on-find-file t
"Start syntax check on find file."
:group 'flymake
:type 'boolean)
(defcustom flymake-run-in-place t
"If nil, flymake will run on copies in `temporary-file-directory' rather
than the same directory as the original file.
If the file makes use of relative include paths it's quite possible that
setting this to nil will cause compilation errors. On the other hand, leaving
it set to t will trigger any automated file creation detection that is
watching your project directory. YMMV.
When editing a remote file via Tramp, this flag also has the side-effect of
determining whether the syntax check is run in the same place as the original
file (and thus on the remote machine), or in the same place as
`temporary-file-directory' (usually the local machine)."
:group 'flymake
:type 'boolean)
;;;###autoload
(define-minor-mode flymake-mode
"Toggle on-the-fly syntax checking.
With a prefix argument ARG, enable the mode if ARG is positive,
and disable it otherwise. If called from Lisp, enable the mode
if ARG is omitted or nil."
:group 'flymake :lighter flymake-mode-line
(cond
;; Turning the mode ON.
(flymake-mode
(cond
((not buffer-file-name)
(message "Flymake unable to run without a buffer file name"))
((not (flymake-can-syntax-check-file buffer-file-name))
(flymake-log 2 "flymake cannot check syntax in buffer %s" (buffer-name)))
(t
(setq flymake-buffers (1+ flymake-buffers))
(add-hook 'after-change-functions 'flymake-after-change-function nil t)
(add-hook 'after-save-hook 'flymake-after-save-hook nil t)
(add-hook 'kill-buffer-hook 'flymake-kill-buffer-hook nil t)
;;+(add-hook 'find-file-hook 'flymake-find-file-hook)
(flymake-report-status "" "")
(when (and (> flymake-buffers 0)
(not flymake-timer))
(setq flymake-timer (run-at-time nil 1 'flymake-on-timer-event)))
(when (and flymake-start-syntax-check-on-find-file
;; Since we write temp files in current dir, there's no point
;; trying if the directory is read-only (bug#8954).
(or (not flymake-run-in-place)
(file-writable-p (file-name-directory buffer-file-name)))
(file-readable-p (file-name-directory buffer-file-name)))
(with-demoted-errors
(flymake-start-syntax-check))))))
;; Turning the mode OFF.
(t
(remove-hook 'after-change-functions 'flymake-after-change-function t)
(remove-hook 'after-save-hook 'flymake-after-save-hook t)
(remove-hook 'kill-buffer-hook 'flymake-kill-buffer-hook t)
;;+(remove-hook 'find-file-hook (function flymake-find-file-hook) t)
(flymake-delete-own-overlays)
(setq flymake-buffers (1- flymake-buffers))
(when (and (<= flymake-buffers 0)
flymake-timer)
(cancel-timer flymake-timer)
(setq flymake-timer nil))
(setq flymake-is-running nil))))
;;;; [[ cross-emacs compatibility routines
(defsubst flymake-makehash (&optional test)
(if (fboundp 'make-hash-table)
(if test (make-hash-table :test test) (make-hash-table))
(with-no-warnings
(makehash test))))
(defalias 'flymake-float-time
(if (fboundp 'float-time)
'float-time
(if (featurep 'xemacs)
(lambda ()
(multiple-value-bind (s0 s1 s2) (values-list (current-time))
(+ (* (float (ash 1 16)) s0) (float s1) (* 0.0000001 s2)))))))
(defalias 'flymake-replace-regexp-in-string
(if (eval-when-compile (fboundp 'replace-regexp-in-string))
'replace-regexp-in-string
(lambda (regexp rep str)
(replace-in-string str regexp rep))))
(defalias 'flymake-split-string
(if (condition-case nil (equal (split-string " bc " " " t) '("bc"))
(error nil))
(lambda (str pattern) (split-string str pattern t))
(lambda (str pattern)
"Split STR into a list of substrings bounded by PATTERN.
Zero-length substrings at the beginning and end of the list are omitted."
(let ((split (split-string str pattern)))
(while (equal (car split) "") (setq split (cdr split)))
(setq split (nreverse split))
(while (equal (car split) "") (setq split (cdr split)))
(nreverse split)))))
(defalias 'flymake-get-temp-dir
(if (fboundp 'temp-directory)
'temp-directory
(lambda () temporary-file-directory)))
(defun flymake-posn-at-point-as-event (&optional position window dx dy)
"Return pixel position of top left corner of glyph at POSITION,
relative to top left corner of WINDOW, as a mouse-1 click
event (identical to the event that would be triggered by clicking
mouse button 1 at the top left corner of the glyph).
POSITION and WINDOW default to the position of point in the
selected window.
DX and DY specify optional offsets from the top left of the glyph."
(unless window (setq window (selected-window)))
(unless position (setq position (window-point window)))
(unless dx (setq dx 0))
(unless dy (setq dy 0))
(let* ((pos (posn-at-point position window))
(x-y (posn-x-y pos))
(edges (window-inside-pixel-edges window))
(win-x-y (window-pixel-edges window)))
;; adjust for window edges
(setcar (nthcdr 2 pos)
(cons (+ (car x-y) (car edges) (- (car win-x-y)) dx)
(+ (cdr x-y) (cadr edges) (- (cadr win-x-y)) dy)))
(list 'mouse-1 pos)))
(defun flymake-popup-menu (menu-data)
"Pop up the flymake menu at point, using the data MENU-DATA.
POS is a list of the form ((X Y) WINDOW), where X and Y are
pixels positions from the top left corner of WINDOW's frame.
MENU-DATA is a list of error and warning messages returned by
`flymake-make-err-menu-data'."
(if (featurep 'xemacs)
(let* ((pos (flymake-get-point-pixel-pos))
(x-pos (nth 0 pos))
(y-pos (nth 1 pos))
(fake-event-props '(button 1 x 1 y 1)))
(setq fake-event-props (plist-put fake-event-props 'x x-pos))
(setq fake-event-props (plist-put fake-event-props 'y y-pos))
(popup-menu (flymake-make-xemacs-menu menu-data)
(make-event 'button-press fake-event-props)))
(x-popup-menu (if (eval-when-compile (fboundp 'posn-at-point))
(flymake-posn-at-point-as-event)
(list (flymake-get-point-pixel-pos) (selected-window)))
(flymake-make-emacs-menu menu-data))))
(defun flymake-make-emacs-menu (menu-data)
"Return a menu specifier using MENU-DATA.
MENU-DATA is a list of error and warning messages returned by
`flymake-make-err-menu-data'.
See `x-popup-menu' for the menu specifier format."
(let* ((menu-title (nth 0 menu-data))
(menu-items (nth 1 menu-data))
(menu-commands (mapcar (lambda (foo)
(cons (nth 0 foo) (nth 1 foo)))
menu-items)))
(list menu-title (cons "" menu-commands))))
;; xemacs
(when (featurep 'xemacs)
(defun flymake-nop ())
(defun flymake-make-xemacs-menu (menu-data)
"Return a menu specifier using MENU-DATA."
(let* ((menu-title (nth 0 menu-data)) (menu-items (nth 1 menu-data))
(menu-commands nil))
(setq menu-commands (mapcar (lambda (foo)
(vector (nth 0 foo) (or (nth 1 foo) '(flymake-nop)) t))
menu-items))
(cons menu-title menu-commands))))
(unless (eval-when-compile (fboundp 'posn-at-point))
(defun flymake-current-row ()
"Return current row number in current frame."
(if (fboundp 'window-edges)
(+ (car (cdr (window-edges))) (count-lines (window-start) (point)))
(count-lines (window-start) (point))))
(defun flymake-selected-frame ()
(if (fboundp 'window-edges)
(selected-frame)
(selected-window)))
(defun flymake-get-point-pixel-pos ()
"Return point position in pixels: (x, y)."
(let ((mouse-pos (mouse-position))
(pixel-pos nil)
(ret nil))
(if (car (cdr mouse-pos))
(progn
(set-mouse-position (flymake-selected-frame) (current-column) (flymake-current-row))
(setq pixel-pos (mouse-pixel-position))
(set-mouse-position (car mouse-pos) (car (cdr mouse-pos)) (cdr (cdr mouse-pos)))
(setq ret (list (car (cdr pixel-pos)) (cdr (cdr pixel-pos)))))
(progn
(setq ret '(0 0))))
(flymake-log 3 "mouse pos is %s" ret)
ret))
) ;; End of (unless (fboundp 'posn-at-point)
;;;; ]]
(defcustom flymake-log-level -1
"Logging level, only messages with level lower or equal will be logged.
-1 = NONE, 0 = ERROR, 1 = WARNING, 2 = INFO, 3 = DEBUG
See `flymake-log-file-name' if you want to control where the log is created."
:group 'flymake
:type 'integer)
;; Yes, this is an awful default.
(defcustom flymake-log-file-name "~/flymake.log"
"Where to put the flymake log if logging is enabled.
See `flymake-log-level' if you want to control what is logged."
:group 'flymake
:type 'string)
(defun flymake-enquote-log-string (string)
"Prepends > on each line of STRING."
(concat "\n > " (flymake-replace-regexp-in-string "\n" "\n > " string t t)))
(defun flymake-log (level text &rest args)
"Log a message at level LEVEL.
If LEVEL is higher than `flymake-log-level', the message is
ignored. Otherwise, it is printed using `message'.
TEXT is a format control string, and the remaining arguments ARGS
are the string substitutions (see `format')."
(if (<= level flymake-log-level)
(let* ((msg (apply 'format text args))
;; Surely there's a better way to do this?
(time (current-time))
(timestamp (concat (format-time-string "%Y-%m-%d %T" time)
"."
(format "%06d" (third time)))))
(message "%s" msg)
(make-directory (file-name-directory flymake-log-file-name) 1)
(write-region (concat "[" timestamp "] " msg "\n") nil flymake-log-file-name t 566))))
(defun flymake-ins-after (list pos val)
"Insert VAL into LIST after position POS."
(let ((tmp (copy-sequence list))) ; (???)
(setcdr (nthcdr pos tmp) (cons val (nthcdr (1+ pos) tmp)))
tmp))
(defun flymake-set-at (list pos val)
"Set VAL at position POS in LIST."
(let ((tmp (copy-sequence list))) ; (???)
(setcar (nthcdr pos tmp) val)
tmp))
(defvar flymake-processes nil
"List of currently active flymake processes.")
(defvar flymake-output-residual nil)
(make-variable-buffer-local 'flymake-output-residual)
(defgroup flymake nil
"A universal on-the-fly syntax checker."
:version "23.1"
:group 'tools)
(defcustom flymake-allowed-file-name-masks
'(("\\.\\(?:c\\(?:pp\\|xx\\|\\+\\+\\)?\\|CC\\)\\'" flymake-simple-make-init)
("\\.xml\\'" flymake-xml-init)
("\\.html?\\'" flymake-xml-init)
("\\.cs\\'" flymake-simple-make-init)
("\\.p[ml]\\'" flymake-perl-init)
("\\.php[345]?\\'" flymake-php-init)
("\\.js\\'" flymake-javascript-init)
("\\.css\\'" flymake-css-init)
("\\.h\\'" flymake-master-make-header-init flymake-master-cleanup)
("\\.java\\'" flymake-simple-make-java-init flymake-simple-java-cleanup)
("[0-9]+\\.tex\\'" flymake-master-tex-init flymake-master-cleanup)
("\\.tex\\'" flymake-simple-tex-init)
("\\.idl\\'" flymake-simple-make-init)
("\\.spec\\'" flymake-specfile-init)
("\\.po\\'" flymake-pofile-init)
;; ("\\.cpp\\'" 1)
;; ("\\.java\\'" 3)
;; ("\\.h\\'" 2 ("\\.cpp\\'" "\\.c\\'")
;; ("[ \t]*#[ \t]*include[ \t]*\"\\([\w0-9/\\_\.]*[/\\]*\\)\\(%s\\)\"" 1 2))
;; ("\\.idl\\'" 1)
;; ("\\.odl\\'" 1)
;; ("[0-9]+\\.tex\\'" 2 ("\\.tex\\'")
;; ("[ \t]*\\input[ \t]*{\\(.*\\)\\(%s\\)}" 1 2 ))
;; ("\\.tex\\'" 1)
)
"Files syntax checking is allowed for."
:group 'flymake
:type '(repeat (string symbol symbol symbol)))
(defun flymake-get-file-name-mode-and-masks (file-name)
"Return the corresponding entry from `flymake-allowed-file-name-masks'."
(unless (stringp file-name)
(error "Invalid file-name"))
(let ((fnm flymake-allowed-file-name-masks)
(mode-and-masks nil))
(while (and (not mode-and-masks) fnm)
(if (string-match (car (car fnm)) file-name)
(setq mode-and-masks (cdr (car fnm))))
(setq fnm (cdr fnm)))
(flymake-log 3 "file %s, init=%s" file-name (car mode-and-masks))
mode-and-masks))
(defun flymake-can-syntax-check-file (file-name)
"Determine whether we can syntax check FILE-NAME.
Return nil if we cannot, non-nil if we can."
(if (flymake-get-init-function file-name) t nil))
(defun flymake-get-init-function (file-name)
"Return init function to be used for the file."
(let* ((init-f (nth 0 (flymake-get-file-name-mode-and-masks file-name))))
;;(flymake-log 0 "calling %s" init-f)
;;(funcall init-f (current-buffer))
init-f))
(defun flymake-get-cleanup-function (file-name)
"Return cleanup function to be used for the file."
(or (nth 1 (flymake-get-file-name-mode-and-masks file-name))
'flymake-simple-cleanup))
(defun flymake-get-real-file-name-function (file-name)
(or (nth 2 (flymake-get-file-name-mode-and-masks file-name))
'flymake-get-real-file-name))
(defvar flymake-find-buildfile-cache (flymake-makehash 'equal))
(defun flymake-get-buildfile-from-cache (dir-name)
(gethash dir-name flymake-find-buildfile-cache))
(defun flymake-add-buildfile-to-cache (dir-name buildfile)
(puthash dir-name buildfile flymake-find-buildfile-cache))
(defun flymake-clear-buildfile-cache ()
(clrhash flymake-find-buildfile-cache))
(defun flymake-find-buildfile (buildfile-name source-dir-name)
"Find buildfile starting from current directory.
Buildfile includes Makefile, build.xml etc.
Return its file name if found, or nil if not found."
(or (flymake-get-buildfile-from-cache source-dir-name)
(let* ((file (locate-dominating-file source-dir-name buildfile-name)))
(if file
(let* ((file (file-truename file)))
(flymake-log 3 "found buildfile at %s" file)
(flymake-add-buildfile-to-cache source-dir-name file)
file)
(progn
(flymake-log 3 "buildfile for %s not found" source-dir-name)
nil)))))
(defun flymake-fix-file-name (name)
"Replace all occurrences of '\' with '/'."
(when name
(setq name (expand-file-name name))
(setq name (abbreviate-file-name name))
(setq name (directory-file-name name))
name))
(defun flymake-same-files (file-name-one file-name-two)
"Check if FILE-NAME-ONE and FILE-NAME-TWO point to same file.
Return t if so, nil if not."
(equal (flymake-fix-file-name file-name-one)
(flymake-fix-file-name file-name-two)))
(defcustom flymake-master-file-dirs '("." "./src" "./UnitTest")
"Dirs where to look for master files."
:group 'flymake
:type '(repeat (string)))
(defcustom flymake-master-file-count-limit 32
"Max number of master files to check."
:group 'flymake
:type 'integer)
;; This is bound dynamically to pass a parameter to a sort predicate below
(defvar flymake-included-file-name)
(defun flymake-find-possible-master-files (file-name master-file-dirs masks)
"Find (by name and location) all possible master files.
Master files include .cpp and .c for .h. Files are searched for
starting from the .h directory and max max-level parent dirs.
File contents are not checked."
(let* ((dirs master-file-dirs)
(files nil)
(done nil))
(while (and (not done) dirs)
(let* ((dir (expand-file-name (car dirs) (file-name-directory file-name)))
(masks masks))
(while (and (file-exists-p dir) (not done) masks)
(let* ((mask (car masks))
(dir-files (directory-files dir t mask)))
(flymake-log 3 "dir %s, %d file(s) for mask %s"
dir (length dir-files) mask)
(while (and (not done) dir-files)
(when (not (file-directory-p (car dir-files)))
(setq files (cons (car dir-files) files))
(when (>= (length files) flymake-master-file-count-limit)
(flymake-log 3 "master file count limit (%d) reached" flymake-master-file-count-limit)
(setq done t)))
(setq dir-files (cdr dir-files))))
(setq masks (cdr masks))))
(setq dirs (cdr dirs)))
(when files
(let ((flymake-included-file-name (file-name-nondirectory file-name)))
(setq files (sort files 'flymake-master-file-compare))))
(flymake-log 3 "found %d possible master file(s)" (length files))
files))
(defun flymake-master-file-compare (file-one file-two)
"Compare two files specified by FILE-ONE and FILE-TWO.
This function is used in sort to move most possible file names
to the beginning of the list (File.h -> File.cpp moved to top)."
(and (equal (file-name-sans-extension flymake-included-file-name)
(file-name-sans-extension (file-name-nondirectory file-one)))
(not (equal file-one file-two))))
(defcustom flymake-check-file-limit 8192
"Max number of chars to look at when checking possible master file.
Nil means search the entire file."
:group 'flymake
:type '(choice (const :tag "No limit" nil)
(integer :tag "Characters")))
(defun flymake-check-patch-master-file-buffer
(master-file-temp-buffer
master-file-name patched-master-file-name
source-file-name patched-source-file-name
include-dirs regexp)
"Check if MASTER-FILE-NAME is a master file for SOURCE-FILE-NAME.
If yes, patch a copy of MASTER-FILE-NAME to include PATCHED-SOURCE-FILE-NAME
instead of SOURCE-FILE-NAME.
For example, foo.cpp is a master file if it includes foo.h.
Whether a buffer for MATER-FILE-NAME exists, use it as a source
instead of reading master file from disk."
(let* ((source-file-nondir (file-name-nondirectory source-file-name))
(source-file-extension (file-name-extension source-file-nondir))
(source-file-nonext (file-name-sans-extension source-file-nondir))
(found nil)
(inc-name nil)
(search-limit flymake-check-file-limit))
(setq regexp
(format regexp ; "[ \t]*#[ \t]*include[ \t]*\"\\(.*%s\\)\""
;; Hack for tex files, where \include often excludes .tex.
;; Maybe this is safe generally.
(if (and (> (length source-file-extension) 1)
(string-equal source-file-extension "tex"))
(format "%s\\(?:\\.%s\\)?"
(regexp-quote source-file-nonext)
(regexp-quote source-file-extension))
(regexp-quote source-file-nondir))))
(unwind-protect
(with-current-buffer master-file-temp-buffer
(when (or (not search-limit)
(> search-limit (point-max)))
(setq search-limit (point-max)))
(flymake-log 3 "checking %s against regexp %s"
master-file-name regexp)
(goto-char (point-min))
(while (and (< (point) search-limit)
(re-search-forward regexp search-limit t))
(let ((match-beg (match-beginning 1))
(match-end (match-end 1)))
(flymake-log 3 "found possible match for %s" source-file-nondir)
(setq inc-name (match-string 1))
(and (> (length source-file-extension) 1)
(string-equal source-file-extension "tex")
(not (string-match (format "\\.%s\\'" source-file-extension)
inc-name))
(setq inc-name (concat inc-name "." source-file-extension)))
(when (eq t (compare-strings
source-file-nondir nil nil
inc-name (- (length inc-name)
(length source-file-nondir)) nil))
(flymake-log 3 "inc-name=%s" inc-name)
(when (flymake-check-include source-file-name inc-name
include-dirs)
(setq found t)
;; replace-match is not used here as it fails in
;; XEmacs with 'last match not a buffer' error as
;; check-includes calls replace-in-string
(flymake-replace-region
match-beg match-end
(file-name-nondirectory patched-source-file-name))))
(forward-line 1)))
(when found
(flymake-save-buffer-in-file patched-master-file-name)))
;;+(flymake-log 3 "killing buffer %s"
;; (buffer-name master-file-temp-buffer))
(kill-buffer master-file-temp-buffer))
;;+(flymake-log 3 "check-patch master file %s: %s" master-file-name found)
(when found
(flymake-log 2 "found master file %s" master-file-name))
found))
(defun flymake-replace-region (beg end rep)
"Replace text in BUFFER in region (BEG END) with REP."
(save-excursion
(goto-char end)
;; Insert before deleting, so as to better preserve markers's positions.
(insert rep)
(delete-region beg end)))
(defun flymake-read-file-to-temp-buffer (file-name)
"Insert contents of FILE-NAME into newly created temp buffer."
(let* ((temp-buffer (get-buffer-create (generate-new-buffer-name (concat "flymake:" (file-name-nondirectory file-name))))))
(with-current-buffer temp-buffer
(insert-file-contents file-name))
temp-buffer))
(defun flymake-copy-buffer-to-temp-buffer (buffer)
"Copy contents of BUFFER into newly created temp buffer."
(with-current-buffer
(get-buffer-create (generate-new-buffer-name
(concat "flymake:" (buffer-name buffer))))
(insert-buffer-substring buffer)
(current-buffer)))
(defun flymake-check-include (source-file-name inc-name include-dirs)
"Check if SOURCE-FILE-NAME can be found in include path.
Return t if it can be found via include path using INC-NAME."
(if (file-name-absolute-p inc-name)
(flymake-same-files source-file-name inc-name)
(while (and include-dirs
(not (flymake-same-files
source-file-name
(concat (file-name-directory source-file-name)
"/" (car include-dirs)
"/" inc-name))))
(setq include-dirs (cdr include-dirs)))
include-dirs))
(defun flymake-find-buffer-for-file (file-name)
"Check if there exists a buffer visiting FILE-NAME.
Return t if so, nil if not."
(let ((buffer-name (get-file-buffer file-name)))
(if buffer-name
(get-buffer buffer-name))))
(defun flymake-create-master-file (source-file-name patched-source-file-name get-incl-dirs-f create-temp-f masks include-regexp)
"Save SOURCE-FILE-NAME with a different name.
Find master file, patch and save it."
(let* ((possible-master-files (flymake-find-possible-master-files source-file-name flymake-master-file-dirs masks))
(master-file-count (length possible-master-files))
(idx 0)
(temp-buffer nil)
(master-file-name nil)
(patched-master-file-name nil)
(found nil))
(while (and (not found) (< idx master-file-count))
(setq master-file-name (nth idx possible-master-files))
(setq patched-master-file-name (funcall create-temp-f master-file-name "flymake_master"))
(if (flymake-find-buffer-for-file master-file-name)
(setq temp-buffer (flymake-copy-buffer-to-temp-buffer (flymake-find-buffer-for-file master-file-name)))
(setq temp-buffer (flymake-read-file-to-temp-buffer master-file-name)))
(setq found
(flymake-check-patch-master-file-buffer
temp-buffer
master-file-name
patched-master-file-name
source-file-name
patched-source-file-name
(funcall get-incl-dirs-f (file-name-directory master-file-name))
include-regexp))
(setq idx (1+ idx)))
(if found
(list master-file-name patched-master-file-name)
(progn
(flymake-log 3 "none of %d master file(s) checked includes %s" master-file-count
(file-name-nondirectory source-file-name))
nil))))
(defun flymake-save-buffer-in-file (file-name)
(make-directory (file-name-directory file-name) 1)
(write-region nil nil file-name nil 566)
(flymake-log 3 "saved buffer %s in file %s" (buffer-name) file-name))
(defun flymake-save-string-to-file (file-name data)
"Save string DATA to file FILE-NAME."
(write-region data nil file-name nil 566))
(defun flymake-read-file-to-string (file-name)
"Read contents of file FILE-NAME and return as a string."
(with-temp-buffer
(insert-file-contents file-name)
(buffer-substring (point-min) (point-max))))
(defun flymake-process-filter (process output)
"Parse OUTPUT and highlight error lines.
It's flymake process filter."
(let ((source-buffer (process-buffer process)))
(flymake-log 3 "received %d byte(s) of output from process %d"
(length output) (process-id process))
(when (buffer-live-p source-buffer)
(with-current-buffer source-buffer
(flymake-parse-output-and-residual output)))))
(defun flymake-process-sentinel (process _event)
"Sentinel for syntax check buffers."
(when (memq (process-status process) '(signal exit))
(let* ((exit-status (process-exit-status process))
(command (process-command process))
(source-buffer (process-buffer process))
(tramp-verbose -1)
(cleanup-f (flymake-get-cleanup-function (buffer-file-name source-buffer))))
(flymake-log 2 "process %d exited with code %d"
(process-id process) exit-status)
(condition-case err
(progn
(flymake-log 3 "cleaning up using %s" cleanup-f)
(when (buffer-live-p source-buffer)
(with-current-buffer source-buffer
(funcall cleanup-f)))
(delete-process process)
(setq flymake-processes (delq process flymake-processes))
(when (buffer-live-p source-buffer)
(with-current-buffer source-buffer
(flymake-parse-residual)
(flymake-post-syntax-check exit-status command)
(setq flymake-is-running nil)
(when flymake-check-should-restart
(flymake-log 2 "restarting syntax check")
(flymake-start-syntax-check)))))
(error
(let ((err-str (format "Error in process sentinel for buffer %s: %s"
source-buffer (error-message-string err))))
(flymake-log 0 err-str)
(with-current-buffer source-buffer
(setq flymake-is-running nil))))))
(flymake-run-next-queued-syntax-check)))
(defcustom flymake-after-syntax-check-hook '()
"Hook run each time Flymake completes a syntax check and updates its list of errors."
:type 'hook
:group 'flymake)
(defun flymake-post-syntax-check (exit-status command)
(setq flymake-err-info flymake-new-err-info)
(setq flymake-new-err-info nil)
(setq flymake-err-info
(flymake-fix-line-numbers
flymake-err-info 1 (flymake-count-lines)))
(flymake-delete-own-overlays)
(flymake-highlight-err-lines flymake-err-info)
(let (err-count warn-count info-count)
(setq err-count (flymake-get-err-count flymake-err-info "e"))
(setq warn-count (flymake-get-err-count flymake-err-info "w"))
(setq info-count (flymake-get-err-count flymake-err-info "i"))
(flymake-log 2 "%s: %d error(s), %d warning(s), %d info in %.2f second(s)"
(buffer-name) err-count warn-count info-count
(- (flymake-float-time) flymake-check-start-time))
(setq flymake-check-start-time nil)
(if (and (equal 0 err-count) (equal 0 warn-count) (equal 0 info-count))
(if (equal 0 exit-status)
(flymake-report-status "" "") ; PASSED
(if (not flymake-check-was-interrupted)
(flymake-report-fatal-status "CFGERR"
(format "Configuration error has occurred while running %s" command))
(flymake-report-status nil ""))) ; "STOPPED"
(flymake-report-status (format "%d/%d/%d" err-count warn-count info-count) "")))
(run-hooks 'flymake-after-syntax-check-hook))
(defun flymake-parse-output-and-residual (output)
"Split OUTPUT into lines, merge in residual if necessary."
(flymake-log 3 "received process output: %s" (flymake-enquote-log-string output))
(let* ((buffer-residual flymake-output-residual)
(total-output (if buffer-residual (concat buffer-residual output) output))
(lines-and-residual (flymake-split-output total-output))
(lines (nth 0 lines-and-residual))
(new-residual (nth 1 lines-and-residual)))
(setq flymake-output-residual new-residual)
(setq flymake-new-err-info
(flymake-parse-err-lines
flymake-new-err-info lines))))
(defun flymake-parse-residual ()
"Parse residual if it's non empty."
(when flymake-output-residual
(setq flymake-new-err-info
(flymake-parse-err-lines
flymake-new-err-info
(list flymake-output-residual)))
(setq flymake-output-residual nil)))
(defun flymake-er-make-er (line-no line-err-info-list)
(list line-no line-err-info-list))
(defun flymake-er-get-line (err-info)
(nth 0 err-info))
(defun flymake-er-get-line-err-info-list (err-info)
(nth 1 err-info))
(defstruct (flymake-ler
(:constructor nil)
(:constructor flymake-ler-make-ler (file line type text &optional full-file)))
file line type text full-file)
(defun flymake-ler-set-file (line-err-info file)
(flymake-ler-make-ler file
(flymake-ler-line line-err-info)
(flymake-ler-type line-err-info)
(flymake-ler-text line-err-info)
(flymake-ler-full-file line-err-info)))
(defun flymake-ler-set-full-file (line-err-info full-file)
(flymake-ler-make-ler (flymake-ler-file line-err-info)
(flymake-ler-line line-err-info)
(flymake-ler-type line-err-info)
(flymake-ler-text line-err-info)
full-file))
(defun flymake-ler-set-line (line-err-info line)
(flymake-ler-make-ler (flymake-ler-file line-err-info)
line
(flymake-ler-type line-err-info)
(flymake-ler-text line-err-info)
(flymake-ler-full-file line-err-info)))
(defun flymake-get-line-err-count (line-err-info-list type)
"Return number of errors of specified TYPE.
Value of TYPE is either \"e\", \"w\" or \"i\"."
(let* ((idx 0)
(count (length line-err-info-list))
(err-count 0))
(while (< idx count)
(when (equal type (flymake-ler-type (nth idx line-err-info-list)))
(setq err-count (1+ err-count)))
(setq idx (1+ idx)))
err-count))
(defun flymake-get-err-count (err-info-list type)
"Return number of errors of specified TYPE for ERR-INFO-LIST."
(let* ((idx 0)
(count (length err-info-list))
(err-count 0))
(while (< idx count)
(setq err-count (+ err-count (flymake-get-line-err-count (nth 1 (nth idx err-info-list)) type)))
(setq idx (1+ idx)))
err-count))
(defun flymake-fix-line-numbers (err-info-list min-line max-line)
"Replace line numbers with fixed value.
If line-numbers is less than MIN-LINE, set line numbers to MIN-LINE.
If line numbers is greater than MAX-LINE, set line numbers to MAX-LINE.
The reason for this fix is because some compilers might report
line number outside the file being compiled."
(let* ((count (length err-info-list))
(err-info nil)
(line 0))
(while (> count 0)
(setq err-info (nth (1- count) err-info-list))
(setq line (flymake-er-get-line err-info))
(when (or (< line min-line) (> line max-line))
(setq line (if (< line min-line) min-line max-line))
(setq err-info-list (flymake-set-at err-info-list (1- count)
(flymake-er-make-er line
(flymake-er-get-line-err-info-list err-info)))))
(setq count (1- count))))
err-info-list)
(defun flymake-highlight-err-lines (err-info-list)
"Highlight error lines in BUFFER using info from ERR-INFO-LIST."
(save-excursion
(dolist (err err-info-list)
(flymake-highlight-line (car err) (nth 1 err)))))
(defun flymake-overlay-p (ov)
"Determine whether overlay OV was created by flymake."
(and (overlayp ov) (overlay-get ov 'flymake-overlay)))
(defun flymake-make-overlay (beg end tooltip-text face mouse-face)
"Allocate a flymake overlay in range BEG and END."
(when (not (flymake-region-has-flymake-overlays beg end))
(let ((ov (make-overlay beg end nil t t)))
(overlay-put ov 'face face)
(overlay-put ov 'mouse-face mouse-face)
(overlay-put ov 'help-echo tooltip-text)
(overlay-put ov 'flymake-overlay t)
(overlay-put ov 'priority 100)
;;+(flymake-log 3 "created overlay %s" ov)
ov)
(flymake-log 3 "created an overlay at (%d-%d) with face %s" beg end face)))
(defun flymake-delete-own-overlays ()
"Delete all flymake overlays in BUFFER."
(dolist (ol (overlays-in (point-min) (point-max)))
(when (flymake-overlay-p ol)
(delete-overlay ol)
;;+(flymake-log 3 "deleted overlay %s" ol)
)))
(defun flymake-region-has-flymake-overlays (beg end)
"Check if region specified by BEG and END has overlay.
Return t if it has at least one flymake overlay, nil if no overlay."
(let ((ov (overlays-in beg end))
(has-flymake-overlays nil))
(while (consp ov)
(when (flymake-overlay-p (car ov))
(setq has-flymake-overlays t))
(setq ov (cdr ov)))
has-flymake-overlays))
(defface flymake-errline
'((((class color) (background dark)) (:background "Firebrick4"))
(((class color) (background light)) (:background "LightPink"))
(t (:bold t)))
"Face used for marking error lines."
:group 'flymake)
(defface flymake-warnline
'((((class color) (background dark)) (:background "DarkBlue"))
(((class color) (background light)) (:background "LightBlue2"))
(t (:bold t)))
"Face used for marking warning lines."
:group 'flymake)
(defface flymake-infoline
'((((class color) (background dark)) (:background "DarkGreen"))
(((class color) (background light)) (:background "LightGreen"))
(t (:bold t)))
"Face used for marking info lines."
:group 'flymake)
(defcustom flymake-number-of-errors-to-display 1
"Number of flymake errors to display in the tooltip if there are more than one.
If set to nil, all errors for the line will be displayed."
:group 'flymake
:type '(choice integer (const nil)))
(defun flymake-highlight-line (line-no line-err-info-list)
"Highlight line LINE-NO in current buffer.
Perhaps use text from LINE-ERR-INFO-LIST to enhance highlighting."
(goto-char (point-min))
(forward-line (1- line-no))
(when (and flymake-number-of-errors-to-display
(> (length line-err-info-list) flymake-number-of-errors-to-display))
(setq line-err-info-list (butlast line-err-info-list (- (length line-err-info-list) flymake-number-of-errors-to-display))))
(let* ((line-beg (point-at-bol))
(line-end (point-at-eol))
(beg line-beg)
(end line-end)
(tooltip-text (mapconcat 'flymake-ler-text line-err-info-list "\n"))
(face nil))
(goto-char line-beg)
(while (looking-at "[ \t]")
(forward-char))
(setq beg (point))
(goto-char line-end)
(while (and (looking-at "[ \t\r\n]") (> (point) 1))
(backward-char))
(setq end (1+ (point)))
(when (<= end beg)
(setq beg line-beg)
(setq end line-end))
(when (= end beg)
(goto-char end)
(forward-line)
(setq end (point)))
(if (> (flymake-get-line-err-count line-err-info-list "e") 0)
(setq face 'flymake-errline)
(if (> (flymake-get-line-err-count line-err-info-list "w") 0)
(setq face 'flymake-warnline)
(setq face 'flymake-infoline)))
(flymake-make-overlay beg end tooltip-text face nil)))
(defun flymake-parse-err-lines (err-info-list lines)
"Parse err LINES, store info in ERR-INFO-LIST."
(let* ((count (length lines))
(idx 0)
(line-err-info nil)
(real-file-name nil)
(source-file-name buffer-file-name)
(get-real-file-name-f (flymake-get-real-file-name-function source-file-name)))
(while (< idx count)
(setq line-err-info (flymake-parse-line (nth idx lines)))
(when line-err-info
(setq real-file-name (funcall get-real-file-name-f
(flymake-ler-file line-err-info)))
(setq line-err-info (flymake-ler-set-full-file line-err-info real-file-name))
(when (flymake-same-files real-file-name source-file-name)
(setq line-err-info (flymake-ler-set-file line-err-info nil))
(setq err-info-list (flymake-add-err-info err-info-list line-err-info))))