Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
997 lines (888 sloc) 43 KB
;;; php-mode.el --- major mode for editing PHP code
;; Copyright (C) 1999-2004 Turadg Aleahmad
;; Maintainer: Turadg Aleahmad <turadg at>
;; Keywords: php languages oop
;; Created: 1999-05-17
;; Modified: 2005-07-27
;; X-URL:
(defconst php-version "1.2.0"
"PHP Mode version number.")
;;; License
;; 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
;; 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
;; 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
;;; Usage
;; Rename this file to php-mode.el if it isn't already then place it in
;; your Emacs lisp path (eg. site-lisp) and add to your .emacs file:
;; (require 'php-mode)
;; If you want colorization, turn on global-font-lock or
;; add this to your .emacs:
;; (add-hook 'php-mode-user-hook 'turn-on-font-lock)
;; To use abbrev-mode, add lines like this:
;; (add-hook 'php-mode-user-hook
;; '(lambda () (define-abbrev php-mode-abbrev-table "ex" "extends")))
;; To make php-mode compatible with html-mode, see
;; Many options available under Help:Customize
;; Options specific to php-mode are in
;; Programming/Languages/Php
;; Since it inherits much functionality from c-mode, look there too
;; Programming/Languages/C
;;; Commentary:
;; PHP mode is a major mode for editing PHP 3 and 4 source code. It's
;; an extension of C mode; thus it inherits all C mode's navigation
;; functionality. But it colors according to the PHP grammar and indents
;; according to the PEAR coding guidelines. It also includes a couple
;; handy IDE-type features such as documentation search and a source
;; and class browser.
;;; Contributors: (in chronological order)
;; Juanjo, Torsten Martinsen, Vinai Kopp, Sean Champ, Doug Marcey,
;; Kevin Blake, Rex McMaster, Mathias Meyer, Boris Folgmann, Roland
;; Rosenfeld, Fred Yankowski, Craig Andrews, John Keller, Ryan
;; Sammartino, ppercot, Valentin Funk, Stig Bakken, Gregory Stark,
;; Chris Morris, Nils Rennebarth, Gerrit Riessen, Eric Mc Sween,
;; Ville Skytta, Giacomo Tesio
;;; Changelog:
;; 1.2
;; Implemented php-show-arglist, C-. (Engelke Eschner)
;; Implemented php-complete-function, M-tab (Engelke Eschner)
;; Re-enabled # comment detection in GNU Emacs (Urban Müller)
;; Fixed some keybindings and default settings (Engelke Eschner)
;; 1.1
;; Added PHP5 support (Giacomo Tesio)
;; known problem: doesn't highlight after first 'implements'
;; Better XEmacs compatibility (imenu, regexp, and comments!) (Ville Skytta)
;; Improvement to php-conditional-key regexp (Eric Mc Sween)
;; 1.05
;; Incorporated speedbar defs by Gerrit Riessen
;; Add "foreach" to conditional introducing keywords (Nils Rennebarth)
;; Cleared the Changelog
;; Moved contribution credits into comments above
;;; Code:
(require 'speedbar)
(require 'font-lock)
(require 'cc-mode)
(require 'custom)
(require 'etags)
(require 'regexp-opt))
;; Local variables
(defgroup php nil
"Major mode for editing PHP code."
:prefix "php-"
:group 'languages)
(defcustom php-speedbar-config t
"*When set to true automatically configures Speedbar to observe PHP files.\
Ignores php-file patterns option; fixed to expression \"\\.\\(inc\\|php[s34]?\\)\""
:type 'boolean
:group 'php)
(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."
:type 'boolean
:group 'php)
(defcustom php-manual-url ""
"*URL at which to find PHP manual.\
You can replace \"en\" with your ISO language code."
:type 'string
:group 'php)
(defcustom php-search-url ""
"*URL at which to search for documentation on a word"
:type 'string
:group 'php)
(defcustom php-completion-file ""
"*Path to the file which contains the function names known to PHP"
:type 'string
:group 'php)
(defcustom php-manual-path ""
"*Path to the directory which contains the PHP manual"
:type 'string
:group 'php)
(defcustom php-file-patterns (list "\\.php[s34]?\\'" "\\.phtml\\'" "\\.inc\\'")
"*List of file patterns for which to automatically invoke php-mode."
:type '(repeat (regexp :tag "Pattern"))
:group 'php)
(defcustom php-mode-user-hook nil
"List of functions to be executed on entry to php-mode"
:type 'hook
:group 'php)
(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."
:type 'boolean
:group 'php)
(defvar php-completion-table nil
"Obarray of tag names defined in current tags table and functions know to PHP.")
;; Note whether we're in XEmacs
(defconst xemacsp (string-match "Lucid\\|XEmacs" emacs-version)
"Non nil if using XEmacs.")
(define-derived-mode php-mode c-mode "PHP"
"Major mode for editing PHP code.\n\n\\{php-mode-map}"
(setq comment-start "// "
comment-end ""
comment-start-skip "// *")
(setq c-class-key php-class-key)
(setq c-conditional-key php-conditional-key)
(defvar php-mode-syntax-table php-mode-syntax-table)
;; this line makes $ into punctuation instead of a word constituent
;; it used to be active, but it killed indenting of case lines that
;; begin with '$' (many do). If anyone has a solution to this
;; problem, please let me know. Of course, you're welcome to
;; uncomment this line in your installation.
; (modify-syntax-entry ?$ "." php-mode-syntax-table)
;; The above causes XEmacs to handle shell-style comments correctly,
;; but fails to work in GNU Emacs which fails to interpret \n as the
;; end of the comment.
(if xemacsp (progn
(modify-syntax-entry ?# "< b" php-mode-syntax-table)
(modify-syntax-entry ?\n "> b" php-mode-syntax-table)))
(make-local-variable 'font-lock-defaults)
(setq font-lock-defaults
;; Comment-out the next line if the font-coloring is too
;; extreme/ugly for you.
(font-lock-syntactic-keywords . php-font-lock-syntactic-keywords)))
(setq font-lock-maximum-decoration t
case-fold-search t ; PHP vars are case-sensitive
imenu-generic-expression php-imenu-generic-expression)
;; Do not force newline at end of file. Such newlines can cause
;; trouble if the PHP file is included in another file before calls
;; to header() or cookie().
(set (make-local-variable 'require-final-newline) nil)
(set (make-local-variable 'next-line-add-newlines) nil)
;; PEAR coding standards
(make-local-hook 'php-mode-pear-hook)
(add-hook 'php-mode-pear-hook
(lambda nil (set (make-local-variable 'tab-width) 4)) nil t)
(add-hook 'php-mode-pear-hook
(lambda nil (set (make-local-variable 'c-basic-offset) 4)) nil t)
(add-hook 'php-mode-pear-hook
(lambda nil (set (make-local-variable 'c-hanging-comment-ender-p) nil)) nil t)
(add-hook 'php-mode-pear-hook
(lambda nil (set (make-local-variable 'indent-tabs-mode) nil)) nil t)
(add-hook 'php-mode-pear-hook
(lambda nil (c-set-offset 'block-open' - )) nil t)
(add-hook 'php-mode-pear-hook
(lambda nil (c-set-offset 'block-close' 0 )) nil t)
(if (or php-mode-force-pear
(and (stringp buffer-file-name)
(string-match "PEAR\\|pear"
(string-match "\\.php$" (buffer-file-name))))
(run-hooks 'php-mode-pear-hook))
(run-hooks 'php-mode-user-hook))
;; Make php-mode the default mode for PHP source code buffers.
(let ((php-file-patterns-temp php-file-patterns))
(while php-file-patterns-temp
(add-to-list 'auto-mode-alist
(cons (car php-file-patterns-temp) 'php-mode))
(setq php-file-patterns-temp (cdr php-file-patterns-temp))))
;; Handle Speedbar
(if php-mode-speedbar-open
(speedbar 1))
(if (and php-speedbar-config (symbolp 'speedbar))
(speedbar-add-supported-extension "\\.\\(inc\\|php[s34]?\\)"))
;; Make a menu keymap (with a prompt string)
;; and make it the menu bar item's definition.
(define-key php-mode-map [menu-bar] (make-sparse-keymap))
(define-key php-mode-map [menu-bar php]
(cons "PHP" (make-sparse-keymap "PHP")))
;; Define specific subcommands in this menu.
(define-key php-mode-map [menu-bar php complete-function]
'("Complete function name" . php-complete-function))
(define-key php-mode-map
[menu-bar php browse-manual]
'("Browse manual" . php-browse-manual))
(define-key php-mode-map
[menu-bar php search-documentation]
'("Search documentation" . php-search-documentation))
;; Define function name completion function
(defun php-complete-function ()
"Perform function completion on the text around point.
Completes to the set of names listed in the current tags table
and the standard php functions.
The string to complete is chosen in the same way as the default
for \\[find-tag] (which see)."
(let ((pattern (php-get-pattern))
(php-functions (php-completion-table)))
(if (not pattern) (message "Nothing to complete")
(search-backward pattern)
(setq beg (point))
(forward-char (length pattern))
(setq completion (try-completion pattern php-functions nil))
(cond ((eq completion t))
((null completion)
(message "Can't find completion for \"%s\"" pattern)
((not (string= pattern completion))
(delete-region beg (point))
(insert completion))
(message "Making completion list...")
(with-output-to-temp-buffer "*Completions*"
(all-completions pattern php-functions)))
(message "Making completion list...%s" "done"))))))
;; Build php-completion-table on demand. The table includes the
;; PHP functions and the tags from the current tags-file-name
(defun php-completion-table ()
(or (and tags-file-name
(save-excursion (tags-verify-table tags-file-name))
(let ((tags-table
(if (and tags-file-name
(functionp 'etags-tags-completion-table))
(with-current-buffer (get-file-buffer tags-file-name)
(cond ((and (not (string= "" php-completion-file))
(file-readable-p php-completion-file))
(php-build-table-from-file php-completion-file))
(php-build-table-from-path php-manual-path))
(t nil))))
(unless (or php-table tags-table)
(concat "No TAGS file active nor are "
"`php-completion-file' or `php-manual-path' set")))
(when tags-table
;; Combine the tables.
(mapatoms (lambda (sym) (intern (symbol-name sym) php-table))
(setq php-completion-table php-table))))
(defun php-build-table-from-file (filename)
(let ((table (make-vector 1022 0))
(buf (find-file-noselect filename)))
(set-buffer buf)
(goto-char (point-min))
(while (re-search-forward
nil t)
(intern (buffer-substring (match-beginning 1) (match-end 1))
(kill-buffer buf)
(defun php-build-table-from-path (path)
(let ((table (make-vector 1022 0))
(files (directory-files
(mapc (lambda (file)
(string-match "\\.\\([-a-zA-Z_0-9]+\\)\\.html$" file)
"-" "_" (substring file (match-beginning 1) (match-end 1)) t)
;; Find the pattern we want to complete
;; find-tag-default from GNU Emacs etags.el
(defun php-get-pattern ()
(while (looking-at "\\sw\\|\\s_")
(forward-char 1))
(if (or (re-search-backward "\\sw\\|\\s_"
(save-excursion (beginning-of-line) (point))
(re-search-forward "\\(\\sw\\|\\s_\\)+"
(save-excursion (end-of-line) (point))
(progn (goto-char (match-end 0))
(progn (forward-sexp -1)
(while (looking-at "\\s'")
(forward-char 1))
(defun php-show-arglist ()
(let* ((tagname (php-get-pattern))
(buf (find-tag-noselect tagname nil nil))
(set-buffer buf)
(goto-char (point-min))
(when (re-search-forward
(format "function[ \t]+%s[ \t]*(\\([^{]*\\))" tagname)
nil t)
(setq arglist (buffer-substring-no-properties
(match-beginning 1) (match-end 1)))))
(if arglist
(message "Arglist for %s: %s" tagname arglist)
(message "unknown function: %s" tagname))))
;; Define function documentation function
(defun php-search-documentation ()
"Search PHP documentation for the word at the point."
(browse-url (concat php-search-url (current-word t))))
;; Define function for browsing manual
(defun php-browse-manual ()
"Bring up manual for PHP."
(browse-url php-manual-url))
;; Define shortcut
(define-key php-mode-map
;; Define shortcut
(define-key php-mode-map
[(meta tab)]
;; Define shortcut
(define-key php-mode-map
;; Define shortcut
(define-key php-mode-map
'[(control .)]
(defconst php-constants
'(;; core constants
"__LINE__" "__FILE__"
;; from ext/standard:
"M_LN10" "M_PI" "M_PI_2" "M_PI_4" "M_1_PI" "M_2_PI"
;; Disabled by default because they slow buffer loading
;; If you have use for them, decomment the strings
;; that you want colored.
;; To compile, you may have to increase 'max-specpdl-size'
;; from other bundled extensions:
; "VT_I4" "VT_R4" "VT_R8" "VT_BOOL" "VT_ERROR" "VT_CY" "VT_DATE"
; "FBSQL_NUM" "FBSQL_BOTH" "FDFValue" "FDFStatus" "FDFFile"
; "FDFID" "FDFFf" "FDFSetFf" "FDFClearFf" "FDFFlags" "FDFSetF"
; "FDFIF" "FDFEnter" "FDFExit" "FDFDown" "FDFUp" "FDFFormat"
; "FDFValidate" "FDFKeystroke" "FDFCalculate"
; "BSOver" "BSUp" "OverDowntoIdle" "IdletoOverDown"
; "OutDowntoIdle" "OutDowntoOverDown" "OverDowntoOutDown"
; "OverUptoOverDown" "OverUptoIdle" "IdletoOverUp" "ButtonEnter"
; "ButtonExit" "MenuEnter" "MenuExit" "XML_ERROR_NONE"
;; PEAR constants
"PHP constants.")
(defconst php-keywords
;; "class", "new" and "extends" get special treatment
;; "case" and "default" get special treatment elsewhere
'("and" "as" "break" "continue" "declare" "do" "echo" "else" "elseif"
"endfor" "endforeach" "endif" "endswitch" "endwhile" "exit"
"extends" "for" "foreach" "global" "if" "include" "include_once"
"next" "or" "require" "require_once" "return" "static" "switch"
"then" "var" "while" "xor" "private" "throw" "catch" "try"
"instanceof" "catch all" "finally")))
"PHP keywords.")
(defconst php-identifier
"Characters in a PHP identifier.")
(defconst php-types
(regexp-opt '("array" "bool" "boolean" "char" "const" "double" "float"
"int" "integer" "long" "mixed" "object" "real"
"PHP types.")
(defconst php-superglobals
(regexp-opt '("_GET" "_POST" "_COOKIE" "_SESSION" "_ENV" "GLOBALS"
"PHP superglobal variables.")
;; Set up font locking
(defconst php-font-lock-keywords-1
;; Fontify constants
(concat "\\<\\(" php-constants "\\)\\>")
;; Fontify keywords
(concat "\\<\\(" php-keywords "\\)\\>")
;; Fontify keywords and targets, and case default tags.
(list "\\<\\(break\\|case\\|continue\\)\\>[ \t]*\\(-?\\(?:\\sw\\|\\s_\\)+\\)?"
'(1 font-lock-keyword-face) '(2 font-lock-constant-face t t))
;; This must come after the one for keywords and targets.
'(":" ("^[ \t]*\\(\\(?:\\sw\\|\\s_\\)+\\)[ \t]*:[ \t]*$"
(beginning-of-line) (end-of-line)
(1 font-lock-constant-face)))
;; treat 'print' as keyword only when not used like a function name
'("\\<print\\s-*(" . default)
'("\\<print\\>" . font-lock-keyword-face)
;; Fontify PHP tag
'("<\\?\\(php\\)?" . font-lock-constant-face)
'("\\?>" . font-lock-constant-face)
;; Fontify ASP-style tag
'("<\\%\\(=\\)?" . font-lock-constant-face)
'("\\%>" . font-lock-constant-face)
"Subdued level highlighting for PHP mode.")
(defconst php-font-lock-keywords-2
;; class declaration
'("\\<\\(class\\|interface\\)[ \t]*\\(\\(?:\\sw\\|\\s_\\)+\\)?"
(1 font-lock-keyword-face) (2 font-lock-type-face nil t))
;; handle several words specially, to include following word,
;; thereby excluding it from unknown-symbol checks later
;; FIX to handle implementing multiple
;; currently breaks on "class Foo implements Bar, Baz"
(1 font-lock-keyword-face) (2 font-lock-type-face))
;; function declaration
(1 font-lock-keyword-face)
(2 font-lock-function-name-face nil t))
;; class hierarchy
'("\\(self\\|parent\\)\\W" (1 font-lock-constant-face nil nil))
;; method and variable features
(1 font-lock-keyword-face))
;; method features
'("^[ \t]*\\(abstract\\|static\\|final\\)\\s-+\\$?\\(?:\\sw\\|\\s_\\)+"
(1 font-lock-keyword-face))
;; variable features
'("^[ \t]*\\(static\\|const\\)\\s-+\\$?\\(?:\\sw\\|\\s_\\)+"
(1 font-lock-keyword-face))
"Medium level highlighting for PHP mode.")
(defconst php-font-lock-keywords-3
;; <word> or </word> for HTML
'("</?\\sw+[^>]*>" . font-lock-constant-face)
;; HTML entities
'("&\\w+;" . font-lock-variable-name-face)
;; warn about '$' immediately after ->
(1 font-lock-warning-face) (2 default))
;; warn about $word.word -- it could be a valid concatenation,
;; but without any spaces we'll assume $word->word was meant.
1 font-lock-warning-face)
;; Warn about ==> instead of =>
'("==+>" . font-lock-warning-face)
;; exclude casts from bare-word treatment (may contain spaces)
`(,(concat "(\\s-*\\(" php-types "\\)\\s-*)")
1 font-lock-type-face)
;; PHP5: function declarations may contain classes as parameters type
`(,(concat "[(,]\\s-*\\(\\(?:\\sw\\|\\s_\\)+\\)\\s-+\\$\\(?:\\sw\\|\\s_\\)+\\>")
1 font-lock-type-face)
;; Fontify variables and function calls
'("\\$\\(this\\|that\\)\\W" (1 font-lock-constant-face nil nil))
`(,(concat "\\$\\(" php-superglobals "\\)\\W")
(1 font-lock-constant-face nil nil)) ; $_GET & co
'("\\$\\(\\(?:\\sw\\|\\s_\\)+\\)" (1 font-lock-variable-name-face)) ; $variable
'("->\\(\\(?:\\sw\\|\\s_\\)+\\)" (1 font-lock-variable-name-face t t)) ; ->variable
'("->\\(\\(?:\\sw\\|\\s_\\)+\\)\\s-*(" . (1 default t t)) ; ->function_call
'("\\(?:\\sw\\|\\s_\\)+::\\(?:\\sw\\|\\s_\\)+\\s-*(" . default) ; class::method call
'("\\<\\(?:\\sw\\|\\s_\\)+\\s-*[[(]" . default) ; word( or word[
'("\\<[0-9]+" . default) ; number (also matches word)
;; Warn on any words not already fontified
'("\\<\\(?:\\sw\\|\\s_\\)+\\>" . font-lock-warning-face)
"Gauchy level highlighting for PHP mode.")
(defconst php-font-lock-syntactic-keywords
(if xemacsp nil
;; Mark shell-style comments. font-lock handles this in a
;; separate pass from normal syntactic scanning (somehow), so we
;; get a chance to mark these in addition to C and C++ style
;; comments. This only works in GNU Emacs, not XEmacs 21 which
;; seems to ignore this same code if we try to use it.
;; Mark _all_ # chars as being comment-start. That will be
;; ignored when inside a quoted string.
(1 (11 . nil)))
;; Mark all newlines ending a line with # as being comment-end.
;; This causes a problem, premature end-of-comment, when '#'
;; appears inside a multiline C-style comment. Oh well.
(1 (12 . nil)))
;; Define the imenu-generic-expression for PHP mode.
;; To use, execute M-x imenu, then click on Functions or Classes,
;; then select given function/class name to go to its definition.
;; [Contributed by Gerrit Riessen]
(defvar php-imenu-generic-expression
"^\\s-*function\\s-+\\([a-zA-Z0-9_]+\\)\\s-*(" 1)
"^\\s-*class\\s-+\\([a-zA-Z0-9_]+\\)\\s-*" 1)
"Imenu generic expression for PHP Mode. See `imenu-generic-expression'."
;; Add "foreach" to conditional introducing keywords
(defconst php-conditional-key nil)
(let ((all-kws "for\\|if\\|do\\|else\\|while\\|switch\\|foreach\\|elseif\\|try\\|finally\\|try\\|catch all")
(front "\\<\\(")
(back "\\)\\>[^_]"))
(setq php-conditional-key (concat front all-kws back)))
(defconst php-class-kwds "class\\|interface")
(defconst php-class-key
"\\(" php-class-kwds "\\)\\s +"
c-symbol-key ;name of the class
"\\(\\s *extends\\s *" c-symbol-key "\\)?" ;maybe followed by superclass
"\\(\\s *implements *[^{]+{\\)?" ;maybe the adopted protocols list
;; Create "default" symbol for GNU Emacs so that both XEmacs and GNU
;; emacs can refer to the default face by a variable named "default".
(unless (boundp 'default)
(defvar default 'default))
;; Create faces for XEmacs
(unless (boundp 'font-lock-keyword-face)
(copy-face 'bold 'font-lock-keyword-face))
(unless (boundp 'font-lock-constant-face)
(copy-face 'font-lock-keyword-face 'font-lock-constant-face))
(provide 'php-mode)
;;; php-mode.el ends here