-
Notifications
You must be signed in to change notification settings - Fork 119
/
Copy pathphp-mode.el
1656 lines (1425 loc) · 62.7 KB
/
php-mode.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
;;; php-mode.el --- Major mode for editing PHP code
;; Copyright (C) 2018-2019 Friends of Emacs-PHP development
;; Copyright (C) 1999, 2000, 2001, 2003, 2004 Turadg Aleahmad
;; 2008 Aaron S. Hawley
;; 2011, 2012, 2013, 2014, 2015, 2016, 2017 Eric James Michael Ritz
;; Author: Eric James Michael Ritz
;; Maintainer: USAMI Kenta <[email protected]>
;; URL: https://github.com/emacs-php/php-mode
;; Keywords: languages php
;; Version: 1.21.4
;; Package-Requires: ((emacs "24.3"))
;; License: GPL-3.0-or-later
(defconst php-mode-version-number "1.21.4"
"PHP Mode version number.")
(defconst php-mode-modified "2019-05-29"
"PHP Mode build date.")
;; 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 3 of the License, 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, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;; PHP Mode is a major mode for editing PHP script. It's an extension
;; of CC mode; thus it inherits all C mode's navigation functionality.
;; But it colors according to the PHP syntax and indents according to the
;; PSR-2 coding guidelines. It also includes a couple handy IDE-type
;; features such as documentation search and a source and class browser.
;; Please read the manual for setting items compatible with CC Mode.
;; https://www.gnu.org/software/emacs/manual/html_mono/ccmode.html
;; This mode is designed for PHP scripts consisting of a single <?php block.
;; We recommend the introduction of Web Mode for HTML and Blade templates combined with PHP.
;; http://web-mode.org/
;; Modern PHP Mode can be set on a project basis by .dir-locals.el.
;; Please read php-project.el for details of directory local variables.
;; If you are using a package manager, you do not need (require 'php-mode) in
;; your ~/.emacs.d/init.el. Read the README for installation instructions.
;; https://github.com/emacs-php/php-mode
;;; Code:
(require 'php)
(require 'php-face)
(require 'cc-mode)
(require 'cc-langs)
(eval-when-compile
(require 'cc-fonts))
;; Boilerplate from other `cc-mode' derived modes. See
;; http://cc-mode.sourceforge.net/derived-mode-ex.el for details on how this all
;; fits together.
(eval-and-compile
(c-add-language 'php-mode 'java-mode))
(require 'font-lock)
(require 'add-log)
(require 'custom)
(require 'etags)
(require 'speedbar)
(require 'imenu)
(require 'nadvice nil t)
(require 'cl-lib)
(require 'mode-local)
(require 'php-project)
(eval-when-compile
(require 'regexp-opt)
(defvar c-vsemi-status-unknown-p)
(defvar syntax-propertize-via-font-lock))
;; Work around emacs bug#18845, cc-mode expects cl to be loaded
;; while php-mode only uses cl-lib (without compatibility aliases)
(eval-and-compile
(when (and (= emacs-major-version 24) (>= emacs-minor-version 4))
(require 'cl)))
;; Work around https://github.com/emacs-php/php-mode/issues/310.
;;
;; In emacs 24.4 and 24.5, lines after functions with a return type
;; are incorrectly analyzed as member-init-cont.
;;
;; Before emacs 24.4, c member initializers are not supported this
;; way. Starting from emacs 25.1, cc-mode only detects member
;; initializers when the major mode is c++-mode.
(eval-and-compile
(if (and (= emacs-major-version 24) (or (= emacs-minor-version 4)
(= emacs-minor-version 5)))
(defun c-back-over-member-initializers ()
;; Override of cc-engine.el, cc-mode in emacs 24.4 and 24.5 are too
;; optimistic in recognizing c member initializers. Since we don't
;; need it in php-mode, just return nil.
nil)))
(autoload 'php-mode-debug "php-mode-debug"
"Display informations useful for debugging PHP Mode." t)
;; Local variables
;;;###autoload
(defgroup php-mode nil
"Major mode for editing PHP code."
:tag "PHP Mode"
:prefix "php-mode-"
:group 'languages
:group 'php
:link '(url-link :tag "Official Site" "https://github.com/emacs-php/php-mode")
:link '(url-link :tag "PHP Mode Wiki" "https://github.com/emacs-php/php-mode/wiki"))
(define-obsolete-variable-alias 'php-default-face 'php-mode-default-face "1.20.0")
(defcustom php-mode-default-face 'default
"Default face in `php-mode' buffers."
:group 'php-mode
:tag "PHP Mode Default Face"
:type 'face)
(define-obsolete-variable-alias 'php-speedbar-config 'php-mode-speedbar-config "1.20.0")
(defcustom php-mode-speedbar-config t
"When set to true automatically configures Speedbar to observe PHP files.
Ignores php-file patterns option; fixed to expression \"\\.\\(inc\\|php[s345]?\\)\""
:group 'php-mode
:tag "PHP Mode Speedbar Config"
:type 'boolean
:set (lambda (sym val)
(set-default sym val)
(when val
(speedbar-add-supported-extension
"\\.\\(inc\\|php[s345]?\\|phtml\\)"))))
(defcustom php-mode-speedbar-open nil
"Normally `php-mode' starts with the speedbar closed.
Turning this on will open it whenever `php-mode' is loaded."
:group 'php-mode
:tag "PHP Mode Speedbar Open"
:type 'boolean
:set (lambda (sym val)
(set-default sym val)
(when val
(speedbar 1))))
(define-obsolete-variable-alias 'php-template-compatibility 'php-mode-template-compatibility "1.20.0")
(defcustom php-mode-template-compatibility t
"Should detect presence of html tags."
:group 'php-mode
:tag "PHP Mode Template Compatibility"
:type 'boolean)
(defun php-mode-extra-constants-create-regexp (kwds)
"Create regexp for the list of extra constant keywords KWDS."
(concat "[^_$]?\\<\\("
(regexp-opt
(append kwds
(when (boundp 'web-mode-extra-php-constants) web-mode-extra-php-constants)))
"\\)\\>[^_]?"))
(defun php-mode-extra-constants-set (sym value)
"Apply the list of extra constant keywords `VALUE'.
This function is called when the custom variable php-extra-constants
is updated. The web-mode-extra-constants list is appended to the list
of constants when set."
;; remove old keywords
(when (boundp 'php-extra-constants)
(font-lock-remove-keywords
'php-mode `((,(php-mode-extra-constants-create-regexp php-extra-constants) 1 'php-constant))))
;; add new keywords
(when value
(font-lock-add-keywords
'php-mode `((,(php-mode-extra-constants-create-regexp value) 1 'php-constant))))
(set sym value))
(define-obsolete-variable-alias 'php-lineup-cascaded-calls 'php-mode-lineup-cascaded-calls "1.20.0")
(defcustom php-mode-lineup-cascaded-calls nil
"Indent chained method calls to the previous line."
:group 'php-mode
:tag "PHP Mode Lineup Cascaded Calls"
:type 'boolean)
(defcustom php-mode-page-delimiter
(eval-when-compile (rx symbol-start (or "namespace" "function" "class" "trait" "interface") symbol-end))
"Regexp describing line-beginnings that PHP declaration statements."
:group 'php-mode
:tag "PHP Mode Page Delimiter"
:type 'regexp)
(define-obsolete-variable-alias 'php-extra-constants 'php-mode-extra-constants "1.20.0")
(defcustom php-mode-extra-constants '()
"A list of additional strings to treat as PHP constants."
:group 'php-mode
:tag "PHP Mode Extra Constants"
:type '(repeat string)
:set 'php-mode-extra-constants-set)
(define-obsolete-variable-alias 'php-do-not-use-semantic-imenu 'php-mode-do-not-use-semantic-imenu "1.20.0")
(defcustom php-mode-do-not-use-semantic-imenu t
"Customize `imenu-create-index-function' for `php-mode'.
If using function `semantic-mode' `imenu-create-index-function' will be
set to `semantic-create-imenu-index' due to `c-mode' being its
parent. Set this variable to t if you want to use
`imenu-default-create-index-function' even with `semantic-mode'
enabled."
:group 'php-mode
:tag "PHP Mode Do Not Use Semantic Imenu"
:type 'boolean)
(defcustom php-completion-file ""
"Path to the file which contains the function names known to PHP."
:type 'string)
(defcustom php-manual-path ""
"Path to the directory which contains the PHP manual."
:type 'string)
;;;###autoload
(if (version< emacs-version "24.4")
(dolist (i '("php" "php5" "php7"))
(add-to-list 'interpreter-mode-alist (cons i 'php-mode)))
(add-to-list 'interpreter-mode-alist
;; Match php, php-3, php5, php7, php5.5, php-7.0.1, etc.
(cons "php\\(?:-?[3457]\\(?:\\.[0-9]+\\)*\\)?" 'php-mode)))
(defcustom php-mode-hook nil
"List of functions to be executed on entry to `php-mode'."
:group 'php-mode
:tag "PHP Mode Hook"
:type 'hook)
(defcustom php-mode-pear-hook nil
"Hook called when a PHP PEAR file is opened with `php-mode'."
:group 'php-mode
:tag "PHP Mode Pear Hook"
:type 'hook)
(defcustom php-mode-drupal-hook nil
"Hook called when a Drupal file is opened with `php-mode'."
:group 'php-mode
:tag "PHP Mode Drupal Hook"
:type 'hook)
(defcustom php-mode-wordpress-hook nil
"Hook called when a WordPress file is opened with `php-mode'."
:group 'php-mode
:tag "PHP Mode WordPress Hook"
:type 'hook)
(defcustom php-mode-symfony2-hook nil
"Hook called when a Symfony2 file is opened with `php-mode'."
:group 'php-mode
:tag "PHP Mode Symfony2 Hook"
:type 'hook)
(defcustom php-mode-psr2-hook nil
"Hook called when a PSR-2 file is opened with `php-mode'."
:group 'php-mode
:tag "PHP Mode PSR-2 Hook"
:type 'hook)
(defcustom php-mode-force-pear nil
"Normally PEAR coding rules are enforced only when the filename contains \"PEAR.\"
Turning this on will force PEAR rules on all PHP files."
:group 'php-mode
:tag "PHP Mode Force Pear"
:type 'boolean)
(defcustom php-mode-warn-if-mumamo-off t
"Warn once per buffer if you try to indent a buffer without
mumamo-mode turned on. Detects if there are any HTML tags in the
buffer before warning, but this is is not very smart; e.g. if you
have any tags inside a PHP string, it will be fooled."
:group 'php-mode
:tag "PHP Mode Warn If MuMaMo Off"
:type '(choice (const :tag "Warn" t) (const "Don't warn" nil)))
(defcustom php-mode-coding-style 'pear
"Select default coding style to use with php-mode.
This variable can take one of the following symbol values:
`Default' - use a reasonable default style for PHP.
`PEAR' - use coding styles preferred for PEAR code and modules.
`Drupal' - use coding styles preferred for working with Drupal projects.
`WordPress' - use coding styles preferred for working with WordPress projects.
`Symfony2' - use coding styles preferred for working with Symfony2 projects.
`PSR-2' - use coding styles preferred for working with projects using PSR-2 standards."
:group 'php-mode
:tag "PHP Mode Coding Style"
:type '(choice (const :tag "Default" default)
(const :tag "PEAR" pear)
(const :tag "Drupal" drupal)
(const :tag "WordPress" wordpress)
(const :tag "Symfony2" symfony2)
(const :tag "PSR-2" psr2))
:initialize 'custom-initialize-default)
;; Since this function has a bad influence on the environment of many users,
;; temporarily disable it
(defcustom php-mode-enable-project-coding-style nil
"When set to true override php-mode-coding-style by php-project-coding-style.
If you want to suppress styles from being overwritten by directory / file
local variables, set NIL."
:group 'php-mode
:tag "PHP Mode Enable Project Coding Style"
:type 'boolean)
(defcustom php-mode-enable-backup-style-variables t
"When set to `T', back up values set by hook and buffer local variables.
This function may interfere with other hooks and other behaviors.
In that case set to `NIL'."
:group 'php-mode
:tag "PHP Mode Enable Backup Style Variables"
:type 'boolean)
(define-obsolete-variable-alias 'php-mode-disable-parent-mode-hooks 'php-mode-disable-c-mode-hook "1.21.0")
(defcustom php-mode-disable-c-mode-hook t
"When set to `T', do not run hooks of parent modes (`java-mode', `c-mode')."
:group 'php-mode
:tag "PHP Mode Disable C Mode Hook"
:type 'boolean
:group 'php-mode)
(defun php-mode-version ()
"Display string describing the version of PHP Mode."
(interactive)
(funcall
(if (called-interactively-p 'interactive) #'message #'format)
"PHP Mode %s of %s" php-mode-version-number php-mode-modified))
;;;###autoload
(define-obsolete-variable-alias 'php-available-project-root-files 'php-project-available-root-files "1.19.0")
(defvar php-mode-map
(let ((map (make-sparse-keymap "PHP Mode")))
;; Remove menu item for c-mode
(define-key map [menu-bar C] nil)
;; (define-key map [menu-bar php complete-function]
;; '("Complete function name" . php-complete-function))
;; (define-key map [menu-bar php browse-manual]
;; '("Browse manual" . php-browse-manual))
;; (define-key map [menu-bar php search-documentation]
;; '("Search documentation" . php-search-documentation))
;; By default PHP Mode binds C-M-h to c-mark-function, which it
;; inherits from cc-mode. But there are situations where
;; c-mark-function fails to properly mark a function. For
;; example, if we use c-mark-function within a method definition
;; then the region will expand beyond the method and into the
;; class definition itself.
;;
;; Changing the default to mark-defun provides behavior that users
;; are more likely to expect.
(define-key map (kbd "C-M-h") 'mark-defun)
;; Many packages based on cc-mode provide the 'C-c C-w' binding
;; to toggle Subword Mode. See the page
;;
;; https://www.gnu.org/software/emacs/manual/html_node/ccmode/Subword-Movement.html
;;
;; for more information about Subword mode.
(define-key map (kbd "C-c C-w") 'subword-mode)
;; We inherit c-beginning-of-defun and c-end-of-defun from CC Mode
;; but we have two replacement functions specifically for PHP. We
;; remap the commands themselves and not their default
;; key-bindings so that our PHP-specific versions will work even
;; if the user has reconfigured their keys, e.g. if they rebind
;; c-end-of-defun to something other than C-M-e.
(define-key map [remap c-beginning-of-defun] 'php-beginning-of-defun)
(define-key map [remap c-end-of-defun] 'php-end-of-defun)
(define-key map [remap c-set-style] 'php-set-style)
(define-key map [(control c) (control f)] 'php-search-documentation)
(define-key map [(meta tab)] 'php-complete-function)
(define-key map [(control c) (control m)] 'php-browse-manual)
(define-key map [(control .)] 'php-show-arglist)
(define-key map [(control c) (control r)] 'php-send-region)
;; Use the Emacs standard indentation binding. This may upset c-mode
;; which does not follow this at the moment, but I see no better
;; choice.
(define-key map [tab] 'indent-for-tab-command)
map)
"Keymap for `php-mode'.")
(c-lang-defconst c-mode-menu
php (append '(["Complete function name" php-complete-function t]
["Browse manual" php-browse-manual t]
["Search documentation" php-search-documentation t]
["----" t])
(c-lang-const c-mode-menu)))
(c-lang-defconst c-at-vsemi-p-fn
php 'php-c-at-vsemi-p)
(c-lang-defconst c-vsemi-status-unknown-p-fn
php 'php-c-vsemi-status-unknown-p)
(c-lang-defconst c-get-state-before-change-functions
php nil)
(c-lang-defconst c-before-font-lock-functions
php (c-get-lang-constant 'c-before-font-lock-functions nil t))
;; Make php-mode recognize opening tags as preprocessor macro's.
;;
;; This is a workaround, the tags must be recognized as something
;; in order for the syntactic guesses of code below the tag
;; to be correct and as a result not break indentation.
;;
;; Note that submatches or \\| here are not expected by cc-mode.
(c-lang-defconst c-opt-cpp-prefix
php "\\s-*<\\?")
(c-lang-defconst c-anchored-cpp-prefix
php "\\s-*\\(<\\?(=\\|\\sw+)\\)")
(c-lang-defconst c-identifier-ops
php '(
(left-assoc "\\" "::" "->")
(prefix "\\" "::")))
(c-lang-defconst c-operators
php `((prefix "new" "clone")
,@(c-lang-const c-identifier-ops)
(postfix "->")
(postfix "++" "--" "[" "]" "(" ")")
(right-assoc "**")
(prefix "++" "--" "+" "-" "~" "(" ")" "@")
(prefix "instanceof")
(prefix "!")
(left-assoc "*" "/" "%")
(left-assoc "+" "-" ".")
(left-assoc "<<" ">>")
(left-assoc "<" ">" "<=" ">=")
(left-assoc "==" "!=" "===" "!==" "<>" "<=>")
(left-assoc "&")
(left-assoc "^")
(left-assoc "|")
(left-assoc "&&")
(left-assoc "||")
(right-assoc "??")
(left-assoc "?:")
(right-assoc-sequence "?" ":")
(right-assoc ,@(c-lang-const c-assignment-operators))
(left-assoc "and")
(left-assoc "xor")
(left-assoc "or")
(left-assoc ",")))
;; Allow '\' when scanning from open brace back to defining
;; construct like class
(c-lang-defconst c-block-prefix-disallowed-chars
php (cl-set-difference (c-lang-const c-block-prefix-disallowed-chars)
'(?\\)))
;; Allow $ so variables are recognized in cc-mode and remove @. This
;; makes cc-mode highlight variables and their type hints in arglists.
(c-lang-defconst c-symbol-start
php (concat "[" c-alpha "_$]"))
;; All string literals can possibly span multiple lines
(c-lang-defconst c-multiline-string-start-char
php t)
(c-lang-defconst c-assignment-operators
php '("=" "*=" "/=" "%=" "+=" "-=" ">>=" "<<=" "&=" "^=" "|=" ".=" "??="))
(c-lang-defconst beginning-of-defun-function
php 'php-beginning-of-defun)
(c-lang-defconst end-of-defun-function
php 'php-end-of-defun)
(c-lang-defconst c-primitive-type-kwds
php '("int" "integer" "bool" "boolean" "float" "double" "real"
"string" "object" "void"))
(c-lang-defconst c-class-decl-kwds
"Keywords introducing declarations where the following block (if any)
contains another declaration level that should be considered a class."
php '("class" "trait" "interface"))
(c-lang-defconst c-brace-list-decl-kwds
"Keywords introducing declarations where the following block (if
any) is a brace list.
PHP does not have an \"enum\"-like keyword."
php nil)
(c-lang-defconst c-typeless-decl-kwds
php (append (c-lang-const c-class-decl-kwds) '("function")))
(c-lang-defconst c-modifier-kwds
php '("abstract" "const" "final" "static"))
(c-lang-defconst c-protection-kwds
"Access protection label keywords in classes."
php '("private" "protected" "public"))
(c-lang-defconst c-postfix-decl-spec-kwds
php '("implements" "extends"))
(c-lang-defconst c-type-list-kwds
php '("@new" ;; @new is *NOT* language construct, it's workaround for coloring.
"new" "use" "implements" "extends" "namespace" "instanceof" "insteadof"))
(c-lang-defconst c-ref-list-kwds
php nil)
(c-lang-defconst c-block-stmt-2-kwds
php '("catch" "declare" "elseif" "for" "foreach" "if" "switch" "while"))
(c-lang-defconst c-simple-stmt-kwds
php '("break" "continue" "die" "echo" "exit" "goto" "return" "throw"
"include" "include_once" "print" "require" "require_once"))
(c-lang-defconst c-constant-kwds
php '("true" "false" "null"))
(c-lang-defconst c-lambda-kwds
php '("function" "use"))
(c-lang-defconst c-other-block-decl-kwds
php '("namespace"))
(c-lang-defconst c-other-kwds
"Keywords not accounted for by any other `*-kwds' language constant."
php
'(
"__halt_compiler"
"and"
"array"
"as"
"break"
"catch"
"clone"
"default"
"empty"
"enddeclare"
"endfor"
"endforeach"
"endif"
"endswitch"
"endwhile"
"eval"
"fn" ;; NOT c-lambda-kwds
"global"
"isset"
"list"
"or"
"parent"
"static"
"unset"
"var"
"xor"
"yield"
"yield from"
;; Below keywords are technically not reserved keywords, but
;; threated no differently by php-mode from actual reserved
;; keywords
;;
;;; declare directives:
"encoding"
"ticks"
"strict_types"
;;; self for static references:
"self"
))
;; PHP does not have <> templates/generics
(c-lang-defconst c-recognize-<>-arglists
php nil)
(c-lang-defconst c-<>-type-kwds
php nil)
(c-lang-defconst c-inside-<>-type-kwds
php nil)
(c-lang-defconst c-enums-contain-decls
php nil)
(c-lang-defconst c-nonlabel-token-key
"Regexp matching things that can't occur in generic colon labels.
This overrides cc-mode `c-nonlabel-token-key' to support switching on
double quoted strings and true/false/null.
Note: this regexp is also applied to goto-labels, a future improvement
might be to handle switch and goto labels differently."
php (concat
;; All keywords except `c-label-kwds' and `c-constant-kwds'.
(c-make-keywords-re t
(cl-set-difference (c-lang-const c-keywords)
(append (c-lang-const c-label-kwds)
(c-lang-const c-constant-kwds))
:test 'string-equal))))
(c-lang-defconst c-basic-matchers-before
php (cl-remove-if (lambda (elm) (and (listp elm) (equal (car elm) "\\s|")))
(c-lang-const c-basic-matchers-before php)))
(c-lang-defconst c-basic-matchers-after
php (cl-remove-if (lambda (elm) (and (listp elm) (memq 'c-annotation-face elm)))
(c-lang-const c-basic-matchers-after php)))
(c-lang-defconst c-opt-<>-sexp-key
php nil)
(defun php-lineup-cascaded-calls (langelem)
"Line up chained methods using `c-lineup-cascaded-calls',
but only if the setting is enabled"
(if php-lineup-cascaded-calls
(c-lineup-cascaded-calls langelem)))
(c-add-style
"php"
`((c-basic-offset . 4)
(c-offsets-alist . ((arglist-close . php-lineup-arglist-close)
(arglist-cont . (first php-lineup-cascaded-calls 0))
(arglist-cont-nonempty . (first php-lineup-cascaded-calls c-lineup-arglist))
(arglist-intro . php-lineup-arglist-intro)
(case-label . +)
(class-open . 0)
(comment-intro . 0)
(inlambda . 0)
(inline-open . 0)
(namespace-open . 0)
(lambda-intro-cont . +)
(label . +)
(statement-cont . (first php-lineup-cascaded-calls php-lineup-string-cont +))
(substatement-open . 0)
(topmost-intro-cont . (first php-lineup-cascaded-calls +))))
(indent-tabs-mode . nil)
(tab-width . ,(default-value 'tab-width))
(fill-column . ,(default-value 'fill-column))
(show-trailing-whitespace . ,(default-value 'show-trailing-whitespace))
(php-style-delete-trailing-whitespace . nil)))
(defun php-enable-default-coding-style ()
"Set PHP Mode to use reasonable default formatting."
(interactive)
(php-set-style "php"))
(c-add-style
"pear"
'("php"
(c-basic-offset . 4)
(c-offsets-alist . ((case-label . 0)))
(tab-width . 4)))
(defun php-enable-pear-coding-style ()
"Set up php-mode to use the coding styles preferred for PEAR code and modules."
(interactive)
(php-set-style "pear"))
(c-add-style
"drupal"
'("php"
(c-basic-offset . 2)
(tab-width . 2)
(fill-column . 78)
(show-trailing-whitespace . t)
(php-style-delete-trailing-whitespace . t)))
(defun php-enable-drupal-coding-style ()
"Make php-mode use coding styles that are preferable for working with Drupal."
(interactive)
(php-set-style "drupal"))
(c-add-style
"wordpress"
'("php"
(c-basic-offset . 4)
(c-indent-comments-syntactically-p t)
(indent-tabs-mode . t)
(tab-width . 4)
(fill-column . 78)))
(defun php-enable-wordpress-coding-style ()
"Make php-mode use coding styles that are preferable for working with Wordpress."
(interactive)
(php-set-style "wordpress"))
(c-add-style
"symfony2"
'("php"
(c-offsets-alist . ((statement-cont . php-lineup-hanging-semicolon)))
(c-indent-comments-syntactically-p . t)
(fill-column . 78)))
(defun php-enable-symfony2-coding-style ()
"Make php-mode use coding styles that are preferable for working with Symfony2."
(interactive)
(php-set-style "symfony2"))
(c-add-style
"psr2"
'("php"
(c-offsets-alist . ((statement-cont . +)))
(c-indent-comments-syntactically-p . t)
(fill-column . 78)
(show-trailing-whitespace . t)
(php-style-delete-trailing-whitespace . t)))
(defun php-enable-psr2-coding-style ()
"Make php-mode comply to the PSR-2 coding style."
(interactive)
(php-set-style "psr2"))
(defun php-beginning-of-defun (&optional arg)
"Move to the beginning of the ARGth PHP function from point.
Implements PHP version of `beginning-of-defun-function'."
(interactive "p")
(let (found-p (arg (or arg 1)))
(while (> arg 0)
(setq found-p (re-search-backward php-beginning-of-defun-regexp
nil 'noerror))
(setq arg (1- arg)))
(while (< arg 0)
(end-of-line 1)
(let ((opoint (point)))
(beginning-of-defun 1)
(forward-list 2)
(forward-line 1)
(if (eq opoint (point))
(setq found-p (re-search-forward php-beginning-of-defun-regexp
nil 'noerror)))
(setq arg (1+ arg))))
(not (null found-p))))
(defun php-end-of-defun (&optional arg)
"Move the end of the ARGth PHP function from point.
Implements PHP version of `end-of-defun-function'
See `php-beginning-of-defun'."
(interactive "p")
(php-beginning-of-defun (- (or arg 1))))
(defvar php-warned-bad-indent nil)
;; Do it but tell it is not good if html tags in buffer.
(defun php-check-html-for-indentation ()
(let ((html-tag-re "^\\s-*</?\\sw+.*?>")
(here (point)))
(goto-char (line-beginning-position))
(if (or (when (boundp 'mumamo-multi-major-mode) mumamo-multi-major-mode)
;; Fix-me: no idea how to check for mmm or multi-mode
(save-match-data
(not (or (re-search-forward html-tag-re (line-end-position) t)
(re-search-backward html-tag-re (line-beginning-position) t)))))
(progn
(goto-char here)
t)
(goto-char here)
(setq php-warned-bad-indent t)
(let* ((known-multi-libs '(("mumamo" mumamo (lambda () (nxhtml-mumamo)))
("mmm-mode" mmm-mode (lambda () (mmm-mode 1)))
("multi-mode" multi-mode (lambda () (multi-mode 1)))
("web-mode" web-mode (lambda () (web-mode)))))
(known-names (mapcar (lambda (lib) (car lib)) known-multi-libs))
(available-multi-libs (delq nil
(mapcar
(lambda (lib)
(when (locate-library (car lib)) lib))
known-multi-libs)))
(available-names (mapcar (lambda (lib) (car lib)) available-multi-libs))
(base-msg
(concat
"Indentation fails badly with mixed HTML/PHP in the HTML part in
plain `php-mode'. To get indentation to work you must use an
Emacs library that supports 'multiple major modes' in a buffer.
Parts of the buffer will then be in `php-mode' and parts in for
example `html-mode'. Known such libraries are:\n\t"
(mapconcat 'identity known-names ", ")
"\n"
(if available-multi-libs
(concat
"You have these available in your `load-path':\n\t"
(mapconcat 'identity available-names ", ")
"\n\n"
"Do you want to turn any of those on? ")
"You do not have any of those in your `load-path'.")))
(is-using-multi
(catch 'is-using
(dolist (lib available-multi-libs)
(when (and (boundp (cadr lib))
(symbol-value (cadr lib)))
(throw 'is-using t))))))
(unless is-using-multi
(if available-multi-libs
(if (not (y-or-n-p base-msg))
(message "Did not do indentation, but you can try again now if you want")
(let* ((name
(if (= 1 (length available-multi-libs))
(car available-names)
;; Minibuffer window is more than one line, fix that first:
(message "")
(completing-read "Choose multiple major mode support library: "
available-names nil t
(car available-names)
'(available-names . 1)
)))
(mode (when name
(cl-caddr (assoc name available-multi-libs)))))
(when mode
;; Minibuffer window is more than one line, fix that first:
(message "")
(load name)
(funcall mode))))
(lwarn 'php-indent :warning base-msg)))
nil))))
(defun php-cautious-indent-region (start end &optional quiet)
"Carefully indent region `START' `END' in contexts other than HTML templates.
If the optional argument `QUIET' is non-nil then no syntactic errors are
reported, even if `c-report-syntactic-errors' is non-nil."
(if (or (not php-mode-warn-if-mumamo-off)
(not (php-in-poly-php-html-mode))
php-warned-bad-indent
(php-check-html-for-indentation))
(funcall 'c-indent-region start end quiet)))
(defun php-cautious-indent-line ()
"Carefully indent lines in contexts other than HTML templates."
(if (or (not php-mode-warn-if-mumamo-off)
(not (php-in-poly-php-html-mode))
php-warned-bad-indent
(php-check-html-for-indentation))
(let ((here (point))
doit)
(move-beginning-of-line nil)
;; Don't indent heredoc end mark
(save-match-data
(unless (and (looking-at "[a-zA-Z0-9_]+;\n")
(php-in-string-p))
(setq doit t)))
(goto-char here)
(when doit
(funcall 'c-indent-line)))))
(defun php-c-at-vsemi-p (&optional pos)
"Return t on html lines (including php region border), otherwise nil.
POS is a position on the line in question.
This is was done due to the problem reported here:
URL `https://answers.launchpad.net/nxhtml/+question/43320'"
(if (not php-template-compatibility)
nil
(setq pos (or pos (point)))
(let ((here (point))
ret)
(save-match-data
(goto-char pos)
(beginning-of-line)
(setq ret (looking-at
(rx
(or (seq
bol
(0+ space)
"<"
(in "a-z\\?"))
(seq
(0+ not-newline)
(in "a-z\\?")
">"
(0+ space)
eol))))))
(goto-char here)
ret)))
(defun php-c-vsemi-status-unknown-p ()
"Always return NIL. See `php-c-at-vsemi-p'."
nil)
(defun php-lineup-string-cont (langelem)
"Line up string toward equal sign or dot.
e.g.
$str = 'some'
. 'string';
this ^ lineup"
(save-excursion
(goto-char (cdr langelem))
(let (ret finish)
(while (and (not finish) (re-search-forward "[=.]" (line-end-position) t))
(unless (php-in-string-or-comment-p)
(setq finish t
ret (vector (1- (current-column))))))
ret)))
(defun php-lineup-arglist-intro (langelem)
(save-excursion
(goto-char (cdr langelem))
(vector (+ (current-column) c-basic-offset))))
(defun php-lineup-arglist-close (langelem)
(save-excursion
(goto-char (cdr langelem))
(vector (current-column))))
(defun php-lineup-arglist (_langelem)
(save-excursion
(beginning-of-line)
(if (looking-at-p "\\s-*->") '+ 0)))
(defun php-lineup-hanging-semicolon (_langelem)
(save-excursion
(beginning-of-line)
(if (looking-at-p "\\s-*;\\s-*$") 0 '+)))
(eval-and-compile
(defconst php-heredoc-start-re
"<<<\\(?:\\_<.+?\\_>\\|'\\_<.+?\\_>'\\|\"\\_<.+?\\_>\"\\)$"
"Regular expression for the start of a PHP heredoc."))
(defun php-heredoc-end-re (heredoc-start)
"Build a regular expression for the end of a heredoc started by the string HEREDOC-START."
;; Extract just the identifier without <<< and quotes.
(string-match "\\_<.+?\\_>" heredoc-start)
(concat "^\\s-*\\(" (match-string 0 heredoc-start) "\\)\\W"))
(defun php-syntax-propertize-function (start end)
"Apply propertize rules from START to END."
(goto-char start)
(while (and (< (point) end)
(re-search-forward php-heredoc-start-re end t))
(php-heredoc-syntax))
(goto-char start)
(while (re-search-forward "['\"]" end t)
(when (php-in-comment-p)
(c-put-char-property (match-beginning 0)
'syntax-table (string-to-syntax "_")))))
(defun php-heredoc-syntax ()
"Mark the boundaries of searched heredoc."
(goto-char (match-beginning 0))
(c-put-char-property (point) 'syntax-table (string-to-syntax "|"))
(if (re-search-forward (php-heredoc-end-re (match-string 0)) nil t)
(goto-char (match-end 1))
;; Did not find the delimiter so go to the end of the buffer.
(goto-char (point-max)))
(c-put-char-property (1- (point)) 'syntax-table (string-to-syntax "|")))
(defvar-local php-mode--propertize-extend-region-current nil
"Prevent undesirable recursion in PHP-SYNTAX-PROPERTIZE-EXTEND-REGION")
(defun php-syntax-propertize-extend-region (start end)
"Extend the propertize region if START or END falls inside a PHP heredoc."
(let ((pair (cons start end)))
(when (not (member pair php-mode--propertize-extend-region-current))
;; re-search functions may trigger
;; syntax-propertize-extend-region-functions to be called again, which in
;; turn call this to be called again.
(push pair php-mode--propertize-extend-region-current)
(unwind-protect
(let ((new-start)
(new-end))
(goto-char start)
(when (re-search-backward php-heredoc-start-re nil t)
(let ((maybe (point)))
(when (and (re-search-forward (php-heredoc-end-re (match-string 0)) nil t)
(> (point) start))
(setq new-start maybe))))
(goto-char end)
(when (re-search-backward php-heredoc-start-re nil t)
(if (re-search-forward (php-heredoc-end-re (match-string 0)) nil t)
(when (> (point) end)
(setq new-end (point)))
(setq new-end (point-max))))
(when (or new-start new-end)
(cons (or new-start start) (or new-end end))))