Partially correct fontification of "(b*3)", and the like, in C++ Mode

[emacs.git] / lisp / progmodes / cc-fonts.el

;;; cc-fonts.el --- font lock support for CC Mode

;; Copyright (C) 2002-2016 Free Software Foundation, Inc.

;; Authors:    2003- Alan Mackenzie
;;             2002- Martin Stjernholm
;; Maintainer: bug-cc-mode@gnu.org
;; Created:    07-Jan-2002
;; Keywords:   c languages
;; Package:    cc-mode

;; 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 <http://www.gnu.org/licenses/>.

;;; Commentary:

;; Some comments on the use of faces:
;;
;; o  `c-label-face-name' is either `font-lock-constant-face' (in
;;    Emacs), or `font-lock-reference-face'.
;;
;; o  `c-constant-face-name', `c-reference-face-name' and
;;    `c-doc-markup-face-name' are essentially set up like
;;    `c-label-face-name'.
;;
;; o  `c-preprocessor-face-name' is `font-lock-preprocessor-face' in
;;    XEmacs and - in lack of a closer equivalent -
;;    `font-lock-builtin-face' or `font-lock-reference-face' in Emacs.
;;
;; o  `c-doc-face-name' is `font-lock-doc-string-face' in XEmacs,
;;    `font-lock-doc-face' in Emacs 21 and later, or
;;    `font-lock-comment-face' in older Emacs (that since source
;;    documentation are actually comments in these languages, as opposed
;;    to elisp).
;;
;; TBD: We should probably provide real faces for the above uses and
;; instead initialize them from the standard faces.

;;; Code:

;; The faces that already have been put onto the text is tested in
;; various places to direct further fontifications.  For this to work,
;; the following assumptions regarding the faces must hold (apart from
;; the dependencies on the font locking order):
;;
;; o  `font-lock-comment-face' and the face in `c-doc-face-name' is
;;    not used in anything but comments.
;; o  If any face (e.g. `c-doc-markup-face-name') but those above is
;;    used in comments, it doesn't replace them.
;; o  `font-lock-string-face' is not used in anything but string
;;    literals (single or double quoted).
;; o  `font-lock-keyword-face' and the face in `c-label-face-name' are
;;    never overlaid with other faces.

(eval-when-compile
  (let ((load-path
         (if (and (boundp 'byte-compile-dest-file)
                  (stringp byte-compile-dest-file))
             (cons (file-name-directory byte-compile-dest-file) load-path)
           load-path)))
    (load "cc-bytecomp" nil t)))

(cc-require 'cc-defs)
(cc-require-when-compile 'cc-langs)
(cc-require 'cc-vars)
(cc-require 'cc-engine)
(cc-require-when-compile 'cc-awk) ; Change from cc-require, 2003/6/18 to
;; prevent cc-awk being loaded when it's not needed.  There is now a (require
;; 'cc-awk) in (defun awk-mode ..).

;; Avoid repeated loading through the eval-after-load directive in
;; cc-mode.el.
(provide 'cc-fonts)

(cc-external-require 'font-lock)

(cc-bytecomp-defvar parse-sexp-lookup-properties) ; Emacs only.

;; Need to declare these local symbols during compilation since
;; they're referenced from lambdas in `byte-compile' calls that are
;; executed at compile time.  They don't need to have the proper
;; definitions, though, since the generated functions aren't called
;; during compilation.
(cc-bytecomp-defvar c-preprocessor-face-name)
(cc-bytecomp-defvar c-reference-face-name)
(cc-bytecomp-defun c-fontify-recorded-types-and-refs)
(cc-bytecomp-defun c-font-lock-declarators)
(cc-bytecomp-defun c-font-lock-objc-method)
(cc-bytecomp-defun c-font-lock-invalid-string)

\f
;; Note that font-lock in XEmacs doesn't expand face names as
;; variables, so we have to use the (eval . FORM) in the font lock
;; matchers wherever we use these alias variables.

(defconst c-preprocessor-face-name
  (cond ((c-face-name-p 'font-lock-preprocessor-face)
         ;; XEmacs has a font-lock-preprocessor-face.
         'font-lock-preprocessor-face)
        ((c-face-name-p 'font-lock-builtin-face)
         ;; In Emacs font-lock-builtin-face has traditionally been
         ;; used for preprocessor directives.
         'font-lock-builtin-face)
        (t
         'font-lock-reference-face)))

(cc-bytecomp-defvar font-lock-constant-face)

(defconst c-label-face-name
  (cond ((c-face-name-p 'font-lock-label-face)
         ;; If it happens to occur in the future.  (Well, the more
         ;; pragmatic reason is to get unique faces for the test
         ;; suite.)
         'font-lock-label-face)
        ((and (c-face-name-p 'font-lock-constant-face)
              (eq font-lock-constant-face 'font-lock-constant-face))
         ;; Test both if font-lock-constant-face exists and that it's
         ;; not an alias for something else.  This is important since
         ;; we compare already set faces in various places.
         'font-lock-constant-face)
        (t
         'font-lock-reference-face)))

(defconst c-constant-face-name
  (if (and (c-face-name-p 'font-lock-constant-face)
           (eq font-lock-constant-face 'font-lock-constant-face))
      ;; This doesn't exist in some earlier versions of XEmacs 21.
      'font-lock-constant-face
    c-label-face-name))

(defconst c-reference-face-name
  (with-no-warnings
   (if (and (c-face-name-p 'font-lock-reference-face)
            (eq font-lock-reference-face 'font-lock-reference-face))
       ;; This is considered obsolete in Emacs, but it still maps well
       ;; to this use.  (Another reason to do this is to get unique
       ;; faces for the test suite.)
       'font-lock-reference-face
     c-label-face-name)))

;; This should not mapped to a face that also is used to fontify things
;; that aren't comments or string literals.
(defconst c-doc-face-name
  (cond ((c-face-name-p 'font-lock-doc-string-face)
         ;; XEmacs.
         'font-lock-doc-string-face)
        ((c-face-name-p 'font-lock-doc-face)
         ;; Emacs 21 and later.
         'font-lock-doc-face)
        (t
         'font-lock-comment-face)))

(defconst c-doc-markup-face-name
  (if (c-face-name-p 'font-lock-doc-markup-face)
         ;; If it happens to occur in the future.  (Well, the more
         ;; pragmatic reason is to get unique faces for the test
         ;; suite.)
         'font-lock-doc-markup-face
    c-label-face-name))

(defconst c-negation-char-face-name
  (if (c-face-name-p 'font-lock-negation-char-face)
      ;; Emacs 22 has a special face for negation chars.
      'font-lock-negation-char-face))

(cc-bytecomp-defun face-inverse-video-p) ; Only in Emacs.

(defun c-make-inverse-face (oldface newface)
  ;; Emacs and XEmacs have completely different face manipulation
  ;; routines. :P
  (copy-face oldface newface)
  (cond ((fboundp 'face-inverse-video-p)
         ;; Emacs.  This only looks at the inverse flag in the current
         ;; frame.  Other display configurations might be different,
         ;; but it can only show if the same Emacs has frames on
         ;; e.g. a color and a monochrome display simultaneously.
         (unless (face-inverse-video-p oldface)
           (invert-face newface)))
        ((fboundp 'face-property-instance)
         ;; XEmacs.  Same pitfall here.
         (unless (face-property-instance oldface 'reverse)
           (invert-face newface)))))

(defvar c-annotation-face 'c-annotation-face)

(defface c-annotation-face
  '((default :inherit font-lock-constant-face))
  "Face for highlighting annotations in Java mode and similar modes."
  :version "24.1"
  :group 'c)

(eval-and-compile
  ;; We need the following definitions during compilation since they're
  ;; used when the `c-lang-defconst' initializers are evaluated.  Define
  ;; them at runtime too for the sake of derived modes.

  ;; This indicates the "font locking context", and is set just before
  ;; fontification is done.  If non-nil, it says, e.g., point starts
  ;; from within a #if preprocessor construct.
  (defvar c-font-lock-context nil)
  (make-variable-buffer-local 'c-font-lock-context)

  (defmacro c-put-font-lock-face (from to face)
    ;; Put a face on a region (overriding any existing face) in the way
    ;; font-lock would do it.  In XEmacs that means putting an
    ;; additional font-lock property, or else the font-lock package
    ;; won't recognize it as fontified and might override it
    ;; incorrectly.
    ;;
    ;; This function does a hidden buffer change.
    (if (fboundp 'font-lock-set-face)
        ;; Note: This function has no docstring in XEmacs so it might be
        ;; considered internal.
        `(font-lock-set-face ,from ,to ,face)
      `(put-text-property ,from ,to 'face ,face)))

  (defmacro c-remove-font-lock-face (from to)
    ;; This is the inverse of `c-put-font-lock-face'.
    ;;
    ;; This function does a hidden buffer change.
    (if (fboundp 'font-lock-remove-face)
        `(font-lock-remove-face ,from ,to)
      `(remove-text-properties ,from ,to '(face nil))))

  (defmacro c-put-font-lock-string-face (from to)
    ;; Put `font-lock-string-face' on a string.  The surrounding
    ;; quotes are included in Emacs but not in XEmacs.  The passed
    ;; region should include them.
    ;;
    ;; This function does a hidden buffer change.
    (if (featurep 'xemacs)
        `(c-put-font-lock-face (1+ ,from) (1- ,to) 'font-lock-string-face)
      `(c-put-font-lock-face ,from ,to 'font-lock-string-face)))

  (defmacro c-fontify-types-and-refs (varlist &rest body)
    ;; Like `let', but additionally activates `c-record-type-identifiers'
    ;; and `c-record-ref-identifiers', and fontifies the recorded ranges
    ;; accordingly on exit.
    ;;
    ;; This function does hidden buffer changes.
    `(let ((c-record-type-identifiers t)
           c-record-ref-identifiers
           ,@varlist)
       (prog1 (progn ,@body)
         (c-fontify-recorded-types-and-refs))))
  (put 'c-fontify-types-and-refs 'lisp-indent-function 1)

  (defun c-skip-comments-and-strings (limit)
    ;; If the point is within a region fontified as a comment or
    ;; string literal skip to the end of it or to LIMIT, whichever
    ;; comes first, and return t.  Otherwise return nil.  The match
    ;; data is not clobbered.
    ;;
    ;; This function might do hidden buffer changes.
    (when (c-got-face-at (point) c-literal-faces)
      (while (progn
               (goto-char (c-next-single-property-change
                           (point) 'face nil limit))
               (and (< (point) limit)
                    (c-got-face-at (point) c-literal-faces))))
      t))

  (defun c-make-syntactic-matcher (regexp)
    ;; Returns a byte compiled function suitable for use in place of a
    ;; regexp string in a `font-lock-keywords' matcher, except that
    ;; only matches outside comments and string literals count.
    ;;
    ;; This function does not do any hidden buffer changes, but the
    ;; generated functions will.  (They are however used in places
    ;; covered by the font-lock context.)
    (byte-compile
     `(lambda (limit)
        (let (res)
          (while (and (setq res (re-search-forward ,regexp limit t))
                      (progn
                        (goto-char (match-beginning 0))
                        (or (c-skip-comments-and-strings limit)
                            (progn
                              (goto-char (match-end 0))
                              nil)))))
          res))))

  (defun c-make-font-lock-search-form (regexp highlights)
    ;; Return a lisp form which will fontify every occurrence of REGEXP
    ;; (a regular expression, NOT a function) between POINT and `limit'
    ;; with HIGHLIGHTS, a list of highlighters as specified on page
    ;; "Search-based Fontification" in the elisp manual.
    `(while (re-search-forward ,regexp limit t)
       (unless (progn
                 (goto-char (match-beginning 0))
                 (c-skip-comments-and-strings limit))
         (goto-char (match-end 0))
         ,@(mapcar
            (lambda (highlight)
              (if (integerp (car highlight))
                  ;; e.g. highlight is (1 font-lock-type-face t)
                  (progn
                    (unless (eq (nth 2 highlight) t)
                      (error
                       "The override flag must currently be t in %s"
                       highlight))
                    (when (nth 3 highlight)
                      (error
                       "The laxmatch flag may currently not be set in %s"
                       highlight))
                    `(save-match-data
                       (c-put-font-lock-face
                        (match-beginning ,(car highlight))
                        (match-end ,(car highlight))
                        ,(elt highlight 1))))
                ;; highlight is an "ANCHORED HIGHLIGHTER" of the form
                ;; (ANCHORED-MATCHER PRE-FORM POST-FORM SUBEXP-HIGHLIGHTERS...)
                (when (nth 3 highlight)
                  (error "Match highlights currently not supported in %s"
                         highlight))
                `(progn
                   ,(nth 1 highlight)
                   (save-match-data ,(car highlight))
                   ,(nth 2 highlight))))
            highlights))))

  (defun c-make-font-lock-search-function (regexp &rest highlights)
    ;; This function makes a byte compiled function that works much like
    ;; a matcher element in `font-lock-keywords'.  It cuts out a little
    ;; bit of the overhead compared to a real matcher.  The main reason
    ;; is however to pass the real search limit to the anchored
    ;; matcher(s), since most (if not all) font-lock implementations
    ;; arbitrarily limit anchored matchers to the same line, and also
    ;; to insulate against various other irritating differences between
    ;; the different (X)Emacs font-lock packages.
    ;;
    ;; REGEXP is the matcher, which must be a regexp.  Only matches
    ;; where the beginning is outside any comment or string literal are
    ;; significant.
    ;;
    ;; HIGHLIGHTS is a list of highlight specs, just like in
    ;; `font-lock-keywords', with these limitations: The face is always
    ;; overridden (no big disadvantage, since hits in comments etc are
    ;; filtered anyway), there is no "laxmatch", and an anchored matcher
    ;; is always a form which must do all the fontification directly.
    ;; `limit' is a variable bound to the real limit in the context of
    ;; the anchored matcher forms.
    ;;
    ;; This function does not do any hidden buffer changes, but the
    ;; generated functions will.  (They are however used in places
    ;; covered by the font-lock context.)

    ;; Note: Replace `byte-compile' with `eval' to debug the generated
    ;; lambda more easily.
    (byte-compile
     `(lambda (limit)
        (let ( ;; The font-lock package in Emacs is known to clobber
              ;; `parse-sexp-lookup-properties' (when it exists).
              (parse-sexp-lookup-properties
               (cc-eval-when-compile
                 (boundp 'parse-sexp-lookup-properties))))
          ,(c-make-font-lock-search-form regexp highlights))
        nil)))

  (defun c-make-font-lock-BO-decl-search-function (regexp &rest highlights)
    ;; This function makes a byte compiled function that first moves back
    ;; to the beginning of the current declaration (if any), then searches
    ;; forward for matcher elements (as in `font-lock-keywords') and
    ;; fontifies them.
    ;;
    ;; The motivation for moving back to the declaration start is to
    ;; establish a context for the current text when, e.g., a character
    ;; is typed on a C++ inheritance continuation line, or a jit-lock
    ;; chunk starts there.
    ;;
    ;; The new function works much like a matcher element in
    ;; `font-lock-keywords'.  It cuts out a little bit of the overhead
    ;; compared to a real matcher.  The main reason is however to pass the
    ;; real search limit to the anchored matcher(s), since most (if not
    ;; all) font-lock implementations arbitrarily limit anchored matchers
    ;; to the same line, and also to insulate against various other
    ;; irritating differences between the different (X)Emacs font-lock
    ;; packages.
    ;;
    ;; REGEXP is the matcher, which must be a regexp.  Only matches
    ;; where the beginning is outside any comment or string literal are
    ;; significant.
    ;;
    ;; HIGHLIGHTS is a list of highlight specs, just like in
    ;; `font-lock-keywords', with these limitations: The face is always
    ;; overridden (no big disadvantage, since hits in comments etc are
    ;; filtered anyway), there is no "laxmatch", and an anchored matcher
    ;; is always a form which must do all the fontification directly.
    ;; `limit' is a variable bound to the real limit in the context of
    ;; the anchored matcher forms.
    ;;
    ;; This function does not do any hidden buffer changes, but the
    ;; generated functions will.  (They are however used in places
    ;; covered by the font-lock context.)

    ;; Note: Replace `byte-compile' with `eval' to debug the generated
    ;; lambda more easily.
    (byte-compile
     `(lambda (limit)
        (let ( ;; The font-lock package in Emacs is known to clobber
              ;; `parse-sexp-lookup-properties' (when it exists).
              (parse-sexp-lookup-properties
               (cc-eval-when-compile
                 (boundp 'parse-sexp-lookup-properties)))
              (BOD-limit
               (c-determine-limit 1000)))
          (goto-char
           (let ((here (point)))
             (if (eq (car (c-beginning-of-decl-1 BOD-limit)) 'same)
                 (point)
               here)))
          ,(c-make-font-lock-search-form regexp highlights))
        nil)))

  (defun c-make-font-lock-context-search-function (normal &rest state-stanzas)
    ;; This function makes a byte compiled function that works much like
    ;; a matcher element in `font-lock-keywords', with the following
    ;; enhancement: the generated function will test for particular "font
    ;; lock contexts" at the start of the region, i.e. is this point in
    ;; the middle of some particular construct?  if so the generated
    ;; function will first fontify the tail of the construct, before
    ;; going into the main loop and fontify full constructs up to limit.
    ;;
    ;; The generated function takes one parameter called `limit', and
    ;; will fontify the region between POINT and LIMIT.
    ;;
    ;; NORMAL is a list of the form (REGEXP HIGHLIGHTS .....), and is
    ;; used to fontify the "regular" bit of the region.
    ;; STATE-STANZAS is list of elements of the form (STATE LIM REGEXP
    ;; HIGHLIGHTS), each element coding one possible font lock context.

    ;; o - REGEXP is a font-lock regular expression (NOT a function),
    ;; o - HIGHLIGHTS is a list of zero or more highlighters as defined
    ;;   on page "Search-based Fontification" in the elisp manual.  As
    ;;   yet (2009-06), they must have OVERRIDE set, and may not have
    ;;   LAXMATCH set.
    ;;
    ;; o - STATE is the "font lock context" (e.g. in-cpp-expr) and is
    ;;   not quoted.
    ;; o - LIM is a lisp form whose evaluation will yield the limit
    ;;   position in the buffer for fontification by this stanza.
    ;;
    ;; This function does not do any hidden buffer changes, but the
    ;; generated functions will.  (They are however used in places
    ;; covered by the font-lock context.)
    ;;
    ;; Note: Replace `byte-compile' with `eval' to debug the generated
    ;; lambda more easily.
    (byte-compile
     `(lambda (limit)
        (let ( ;; The font-lock package in Emacs is known to clobber
              ;; `parse-sexp-lookup-properties' (when it exists).
              (parse-sexp-lookup-properties
               (cc-eval-when-compile
                 (boundp 'parse-sexp-lookup-properties))))
          ,@(mapcar
             (lambda (stanza)
               (let ((state (car stanza))
                     (lim (nth 1 stanza))
                     (regexp (nth 2 stanza))
                     (highlights (cdr (cddr stanza))))
                 `(if (eq c-font-lock-context ',state)
                      (let ((limit ,lim))
                        ,(c-make-font-lock-search-form
                          regexp highlights)))))
             state-stanzas)
          ,(c-make-font-lock-search-form (car normal) (cdr normal))
          nil))))

;  (eval-after-load "edebug" ; 2006-07-09: def-edebug-spec is now in subr.el.
;    '(progn
  (def-edebug-spec c-fontify-types-and-refs let*)
  (def-edebug-spec c-make-syntactic-matcher t)
  ;; If there are literal quoted or backquoted highlight specs in
  ;; the call to `c-make-font-lock-search-function' then let's
  ;; instrument the forms in them.
  (def-edebug-spec c-make-font-lock-search-function
    (form &rest &or ("quote" (&rest form)) ("`" (&rest form)) form)));))

(defun c-fontify-recorded-types-and-refs ()
  ;; Convert the ranges recorded on `c-record-type-identifiers' and
  ;; `c-record-ref-identifiers' to fontification.
  ;;
  ;; This function does hidden buffer changes.
  (let (elem)
    (while (consp c-record-type-identifiers)
      (setq elem (car c-record-type-identifiers)
            c-record-type-identifiers (cdr c-record-type-identifiers))
      (c-put-font-lock-face (car elem) (cdr elem)
                            'font-lock-type-face))
    (while c-record-ref-identifiers
      (setq elem (car c-record-ref-identifiers)
            c-record-ref-identifiers (cdr c-record-ref-identifiers))
      ;; Note that the reference face is a variable that is
      ;; dereferenced, since it's an alias in Emacs.
      (c-put-font-lock-face (car elem) (cdr elem)
                            c-reference-face-name))))

(c-lang-defconst c-cpp-matchers
  "Font lock matchers for preprocessor directives and purely lexical
stuff.  Used on level 1 and higher."

  ;; Note: `c-font-lock-declarations' assumes that no matcher here
  ;; sets `font-lock-type-face' in languages where
  ;; `c-recognize-<>-arglists' is set.

  t `(,@(when (c-lang-const c-opt-cpp-prefix)
          (let* ((noncontinued-line-end "\\(\\=\\|\\(\\=\\|[^\\]\\)[\n\r]\\)")
                 (ncle-depth (regexp-opt-depth noncontinued-line-end))
                 (sws-depth (c-lang-const c-syntactic-ws-depth))
                 (nsws-depth (c-lang-const c-nonempty-syntactic-ws-depth)))

            `(;; The stuff after #error and #warning is a message, so
              ;; fontify it as a string.
              ,@(when (c-lang-const c-cpp-message-directives)
                  (let* ((re (c-make-keywords-re 'appendable ; nil
                               (c-lang-const c-cpp-message-directives)))
                         (re-depth (regexp-opt-depth re)))
                    `((,(concat noncontinued-line-end
                                (c-lang-const c-opt-cpp-prefix)
                                re
                                "\\s +\\(.*\\)$")
                       ,(+ ncle-depth re-depth 1) font-lock-string-face t))))

              ;; Fontify filenames in #include <...> as strings.
              ,@(when (c-lang-const c-cpp-include-directives)
                  (let* ((re (c-make-keywords-re nil
                               (c-lang-const c-cpp-include-directives)))
                         (re-depth (regexp-opt-depth re)))
                    ;; We used to use a font-lock "anchored matcher" here for
                    ;; the paren syntax.  This failed when the ">" was at EOL,
                    ;; since `font-lock-fontify-anchored-keywords' terminated
                    ;; its loop at EOL without executing our lambda form at
                    ;; all.
                    `((,(c-make-font-lock-search-function
                         (concat noncontinued-line-end
                                 (c-lang-const c-opt-cpp-prefix)
                                 re
                                 (c-lang-const c-syntactic-ws)
                                 "\\(<[^>\n\r]*>?\\)")
                         `(,(+ ncle-depth re-depth sws-depth 1)
                           font-lock-string-face t)
                         `((let ((beg (match-beginning
                                       ,(+ ncle-depth re-depth sws-depth 1)))
                                 (end (1- (match-end ,(+ ncle-depth re-depth
                                                         sws-depth 1)))))
                             (if (eq (char-after end) ?>)
                                 (progn
                                   (c-mark-<-as-paren beg)
                                   (c-mark->-as-paren end))
                               (c-unmark-<->-as-paren beg)))
                           nil))))))

              ;; #define.
              ,@(when (c-lang-const c-opt-cpp-macro-define)
                  `((,(c-make-font-lock-search-function
                       (concat
                        noncontinued-line-end
                        (c-lang-const c-opt-cpp-prefix)
                        (c-lang-const c-opt-cpp-macro-define)
                        (c-lang-const c-nonempty-syntactic-ws)
                        "\\(" (c-lang-const ; 1 + ncle + nsws
                               c-symbol-key) "\\)"
                        (concat "\\("   ; 2 + ncle + nsws + c-sym-key
                                ;; Macro with arguments - a "function".
                                "\\((\\)" ; 3 + ncle + nsws + c-sym-key
                                "\\|"
                                ;; Macro without arguments - a "variable".
                                "\\([^(]\\|$\\)"
                                "\\)"))
                       `((if (match-beginning
                              ,(+ 3 ncle-depth nsws-depth
                                  (c-lang-const c-symbol-key-depth)))

                             ;; "Function".  Fontify the name and the arguments.
                             (save-restriction
                               (c-put-font-lock-face
                                (match-beginning ,(+ 1 ncle-depth nsws-depth))
                                (match-end ,(+ 1 ncle-depth nsws-depth))
                                'font-lock-function-name-face)
                               (goto-char
                                (match-end
                                 ,(+ 3 ncle-depth nsws-depth
                                     (c-lang-const c-symbol-key-depth))))

                               (narrow-to-region (point-min) limit)
                               (while (and
                                       (progn
                                         (c-forward-syntactic-ws)
                                         (looking-at c-symbol-key))
                                       (progn
                                         (c-put-font-lock-face
                                          (match-beginning 0) (match-end 0)
                                          'font-lock-variable-name-face)
                                         (goto-char (match-end 0))
                                         (c-forward-syntactic-ws)
                                         (eq (char-after) ?,)))
                                 (forward-char)))

                           ;; "Variable".
                           (c-put-font-lock-face
                            (match-beginning ,(+ 1 ncle-depth nsws-depth))
                            (match-end ,(+ 1 ncle-depth nsws-depth))
                            'font-lock-variable-name-face)))))))

              ;; Fontify cpp function names in preprocessor
              ;; expressions in #if and #elif.
              ,@(when (and (c-lang-const c-cpp-expr-directives)
                           (c-lang-const c-cpp-expr-functions))
                  (let ((ced-re (c-make-keywords-re t
                                  (c-lang-const c-cpp-expr-directives)))
                        (cef-re (c-make-keywords-re t
                                  (c-lang-const c-cpp-expr-functions))))

                    `((,(c-make-font-lock-context-search-function
                         `(,(concat noncontinued-line-end
                                    (c-lang-const c-opt-cpp-prefix)
                                    ced-re ; 1 + ncle-depth
                                    ;; Match the whole logical line to look
                                    ;; for the functions in.
                                    "\\(\\\\\\(.\\|[\n\r]\\)\\|[^\n\r]\\)*")
                           ((let ((limit (match-end 0)))
                              (while (re-search-forward ,cef-re limit 'move)
                                (c-put-font-lock-face (match-beginning 1)
                                                      (match-end 1)
                                                      c-preprocessor-face-name)))
                            (goto-char (match-end ,(1+ ncle-depth)))))
                         `(in-cpp-expr
                           (save-excursion (c-end-of-macro) (point))
                           ,cef-re
                           (1 c-preprocessor-face-name t)))))))

              ;; Fontify the directive names.
              (,(c-make-font-lock-search-function
                 (concat noncontinued-line-end
                         "\\("
                         (c-lang-const c-opt-cpp-prefix)
                         "[" (c-lang-const c-symbol-chars) "]+"
                         "\\)")
                 `(,(1+ ncle-depth) c-preprocessor-face-name t)))

              (eval . (list ,(c-make-syntactic-matcher
                              (concat noncontinued-line-end
                                      (c-lang-const c-opt-cpp-prefix)
                                      "if\\(n\\)def\\>"))
                            ,(+ ncle-depth 1)
                            c-negation-char-face-name
                            'append))
              )))

      ,@(when (c-major-mode-is 'pike-mode)
          ;; Recognize hashbangs in Pike.
          `((eval . (list "\\`#![^\n\r]*"
                          0 c-preprocessor-face-name))))

      ;; Make hard spaces visible through an inverted `font-lock-warning-face'.
      (eval . (list
               "\240"
               0 (progn
                   (unless (c-face-name-p 'c-nonbreakable-space-face)
                     (c-make-inverse-face 'font-lock-warning-face
                                          'c-nonbreakable-space-face))
                   ''c-nonbreakable-space-face)))
      ))

(defun c-font-lock-invalid-string ()
  ;; Assuming the point is after the opening character of a string,
  ;; fontify that char with `font-lock-warning-face' if the string
  ;; decidedly isn't terminated properly.
  ;;
  ;; This function does hidden buffer changes.
  (let ((start (1- (point))))
    (save-excursion
      (and (eq (elt (parse-partial-sexp start (c-point 'eol)) 8) start)
           (if (if (eval-when-compile (integerp ?c))
                   ;; Emacs
                   (integerp c-multiline-string-start-char)
                 ;; XEmacs
                 (characterp c-multiline-string-start-char))
               ;; There's no multiline string start char before the
               ;; string, so newlines aren't allowed.
               (not (eq (char-before start) c-multiline-string-start-char))
             ;; Multiline strings are allowed anywhere if
             ;; c-multiline-string-start-char is t.
             (not c-multiline-string-start-char))
           (if c-string-escaped-newlines
               ;; There's no \ before the newline.
               (not (eq (char-before (point)) ?\\))
             ;; Escaped newlines aren't supported.
             t)
           (c-put-font-lock-face start (1+ start) 'font-lock-warning-face)))))

(c-lang-defconst c-basic-matchers-before
  "Font lock matchers for basic keywords, labels, references and various
other easily recognizable things that should be fontified before generic
casts and declarations are fontified.  Used on level 2 and higher."

  ;; Note: `c-font-lock-declarations' assumes that no matcher here
  ;; sets `font-lock-type-face' in languages where
  ;; `c-recognize-<>-arglists' is set.

  t `(;; Put a warning face on the opener of unclosed strings that
      ;; can't span lines.  Later font
      ;; lock packages have a `font-lock-syntactic-face-function' for
      ;; this, but it doesn't give the control we want since any
      ;; fontification done inside the function will be
      ;; unconditionally overridden.
      ,(c-make-font-lock-search-function
        ;; Match a char before the string starter to make
        ;; `c-skip-comments-and-strings' work correctly.
        (concat ".\\(" c-string-limit-regexp "\\)")
        '((c-font-lock-invalid-string)))

      ;; Fontify C++ raw strings.
      ,@(when (c-major-mode-is 'c++-mode)
          '(c-font-lock-raw-strings))

      ;; Fontify keyword constants.
      ,@(when (c-lang-const c-constant-kwds)
          (let ((re (c-make-keywords-re nil (c-lang-const c-constant-kwds))))
            (if (c-major-mode-is 'pike-mode)
                ;; No symbol is a keyword after "->" in Pike.
                `((eval . (list ,(concat "\\(\\=.?\\|[^>]\\|[^-]>\\)"
                                         "\\<\\(" re "\\)\\>")
                                2 c-constant-face-name)))
              `((eval . (list ,(concat "\\<\\(" re "\\)\\>")
                              1 c-constant-face-name))))))

      ;; Fontify all keywords except the primitive types.
      ,(if (c-major-mode-is 'pike-mode)
           ;; No symbol is a keyword after "->" in Pike.
           `(,(concat "\\(\\=.?\\|[^>]\\|[^-]>\\)"
                      "\\<" (c-lang-const c-regular-keywords-regexp))
             2 font-lock-keyword-face)
         `(,(concat "\\<" (c-lang-const c-regular-keywords-regexp))
           1 font-lock-keyword-face))

      ;; Fontify leading identifiers in fully qualified names like
      ;; "foo::bar" in languages that supports such things.
      ,@(when (c-lang-const c-opt-identifier-concat-key)
          (if (c-major-mode-is 'java-mode)
              ;; Java needs special treatment since "." is used both to
              ;; qualify names and in normal indexing.  Here we look for
              ;; capital characters at the beginning of an identifier to
              ;; recognize the class.  "*" is also recognized to cover
              ;; wildcard import declarations.  All preceding dot separated
              ;; identifiers are taken as package names and therefore
              ;; fontified as references.
              `(,(c-make-font-lock-search-function
                  ;; Search for class identifiers preceded by ".".  The
                  ;; anchored matcher takes it from there.
                  (concat (c-lang-const c-opt-identifier-concat-key)
                          (c-lang-const c-simple-ws) "*"
                          (concat "\\("
                                  "[" c-upper "]"
                                  "[" (c-lang-const c-symbol-chars) "]*"
                                  "\\|"
                                  "\\*"
                                  "\\)"))
                  `((let (id-end)
                      (goto-char (1+ (match-beginning 0)))
                      (while (and (eq (char-before) ?.)
                                  (progn
                                    (backward-char)
                                    (c-backward-syntactic-ws)
                                    (setq id-end (point))
                                    (< (skip-chars-backward
                                        ,(c-lang-const c-symbol-chars)) 0))
                                  (not (get-text-property (point) 'face)))
                        (c-put-font-lock-face (point) id-end
                                              c-reference-face-name)
                        (c-backward-syntactic-ws)))
                    nil
                    (goto-char (match-end 0)))))

            `((,(byte-compile
                 ;; Must use a function here since we match longer than
                 ;; we want to move before doing a new search.  This is
                 ;; not necessary for XEmacs since it restarts the
                 ;; search from the end of the first highlighted
                 ;; submatch (something that causes problems in other
                 ;; places).
                 `(lambda (limit)
                    (while (re-search-forward
                            ,(concat "\\(\\<" ; 1
                                     "\\(" (c-lang-const c-symbol-key) "\\)" ; 2
                                     (c-lang-const c-simple-ws) "*"
                                     (c-lang-const c-opt-identifier-concat-key)
                                     (c-lang-const c-simple-ws) "*"
                                     "\\)"
                                     "\\("
                                     (c-lang-const c-opt-after-id-concat-key)
                                     "\\)")
                            limit t)
                      (unless (progn
                                (goto-char (match-beginning 0))
                                (c-skip-comments-and-strings limit))
                        (or (get-text-property (match-beginning 2) 'face)
                            (c-put-font-lock-face (match-beginning 2)
                                                  (match-end 2)
                                                  c-reference-face-name))
                        (goto-char (match-end 1))))))))))

      ;; Fontify the special declarations in Objective-C.
      ,@(when (c-major-mode-is 'objc-mode)
          `(;; Fontify class names in the beginning of message expressions.
            ,(c-make-font-lock-search-function
              "\\["
              '((c-fontify-types-and-refs ()
                  (c-forward-syntactic-ws limit)
                  (let ((start (point)))
                    ;; In this case we accept both primitive and known types.
                    (when (eq (c-forward-type) 'known)
                      (goto-char start)
                      (let ((c-promote-possible-types t))
                        (c-forward-type))))
                  (if (> (point) limit) (goto-char limit)))))

            ;; The @interface/@implementation/@protocol directives.
            ,(c-make-font-lock-search-function
              (concat "\\<"
                      (regexp-opt
                       '("@interface" "@implementation" "@protocol")
                       t)
                      "\\>")
              '((c-fontify-types-and-refs
                    (;; The font-lock package in Emacs is known to clobber
                     ;; `parse-sexp-lookup-properties' (when it exists).
                     (parse-sexp-lookup-properties
                      (cc-eval-when-compile
                        (boundp 'parse-sexp-lookup-properties))))
                  (c-forward-objc-directive)
                  nil)
                (goto-char (match-beginning 0))))))

      (eval . (list "\\(!\\)[^=]" 1 c-negation-char-face-name))
      ))

(defun c-font-lock-complex-decl-prepare (limit)
  ;; This function will be called from font-lock for a region bounded by POINT
  ;; and LIMIT, as though it were to identify a keyword for
  ;; font-lock-keyword-face.  It always returns NIL to inhibit this and
  ;; prevent a repeat invocation.  See elisp/lispref page "Search-based
  ;; Fontification".
  ;;
  ;; Called before any of the matchers in `c-complex-decl-matchers'.
  ;;
  ;; This function does hidden buffer changes.

  ;;(message "c-font-lock-complex-decl-prepare %s %s" (point) limit)

  ;; Clear the list of found types if we start from the start of the
  ;; buffer, to make it easier to get rid of misspelled types and
  ;; variables that have gotten recognized as types in malformed code.
  (when (bobp)
    (c-clear-found-types))

  ;; Clear the c-type char properties which mark the region, to recalculate
  ;; them properly.  The most interesting properties are those put on the
  ;; closest token before the region.
  (save-excursion
    (let ((pos (point)))
      (c-backward-syntactic-ws)
      (c-clear-char-properties
       (if (and (not (bobp))
                (memq (c-get-char-property (1- (point)) 'c-type)
                      '(c-decl-arg-start
                        c-decl-end
                        c-decl-id-start
                        c-decl-type-start)))
           (1- (point))
         pos)
       limit 'c-type)))

  ;; Update `c-state-cache' to the beginning of the region.  This will
  ;; make `c-beginning-of-syntax' go faster when it's used later on,
  ;; and it's near the point most of the time.
  (c-parse-state)

  ;; Check if the fontified region starts inside a declarator list so
  ;; that `c-font-lock-declarators' should be called at the start.
  ;; The declared identifiers are font-locked correctly as types, if
  ;; that is what they are.
  (let ((prop (save-excursion
                (c-backward-syntactic-ws)
                (unless (bobp)
                  (c-get-char-property (1- (point)) 'c-type)))))
    (when (memq prop '(c-decl-id-start c-decl-type-start))
      (c-forward-syntactic-ws limit)
      (c-font-lock-declarators limit t (eq prop 'c-decl-type-start)
                               (c-bs-at-toplevel-p (point)))))

  (setq c-font-lock-context ;; (c-guess-font-lock-context)
        (save-excursion
          (if (and c-cpp-expr-intro-re
                   (c-beginning-of-macro)
                   (looking-at c-cpp-expr-intro-re))
              'in-cpp-expr)))
  nil)

(defun c-font-lock-<>-arglists (limit)
  ;; This function will be called from font-lock for a region bounded by POINT
  ;; and LIMIT, as though it were to identify a keyword for
  ;; font-lock-keyword-face.  It always returns NIL to inhibit this and
  ;; prevent a repeat invocation.  See elisp/lispref page "Search-based
  ;; Fontification".
  ;;
  ;; Fontify types and references in names containing angle bracket
  ;; arglists from the point to LIMIT.  Note that
  ;; `c-font-lock-declarations' has already handled many of them.
  ;;
  ;; This function might do hidden buffer changes.

  (let (;; The font-lock package in Emacs is known to clobber
        ;; `parse-sexp-lookup-properties' (when it exists).
        (parse-sexp-lookup-properties
         (cc-eval-when-compile
           (boundp 'parse-sexp-lookup-properties)))
        (c-parse-and-markup-<>-arglists t)
        c-restricted-<>-arglists
        id-start id-end id-face pos kwd-sym)

    (while (and (< (point) limit)
                (re-search-forward c-opt-<>-arglist-start limit t))

      (setq id-start (match-beginning 1)
            id-end (match-end 1)
            pos (point))

      (goto-char id-start)
      (unless (c-skip-comments-and-strings limit)
        (setq kwd-sym nil
              c-restricted-<>-arglists nil
              id-face (get-text-property id-start 'face))

        (if (cond
             ((eq id-face 'font-lock-type-face)
              ;; The identifier got the type face so it has already been
              ;; handled in `c-font-lock-declarations'.
              nil)

             ((eq id-face 'font-lock-keyword-face)
              (when (looking-at c-opt-<>-sexp-key)
                ;; There's a special keyword before the "<" that tells
                ;; that it's an angle bracket arglist.
                (setq kwd-sym (c-keyword-sym (match-string 1)))))

             (t
              ;; There's a normal identifier before the "<".  If we're not in
              ;; a declaration context then we set `c-restricted-<>-arglists'
              ;; to avoid recognizing templates in function calls like "foo (a
              ;; < b, c > d)".
              (c-backward-syntactic-ws)
              (when (and (memq (char-before) '(?\( ?,))
                         (not (eq (get-text-property (1- (point)) 'c-type)
                                  'c-decl-arg-start)))
                (setq c-restricted-<>-arglists t))
              t))

            (progn
              (goto-char (1- pos))
              ;; Check for comment/string both at the identifier and
              ;; at the "<".
              (unless (c-skip-comments-and-strings limit)

                (c-fontify-types-and-refs ()
                  (when (c-forward-<>-arglist (c-keyword-member
                                               kwd-sym 'c-<>-type-kwds))
                    (when (and c-opt-identifier-concat-key
                               (not (get-text-property id-start 'face)))
                      (c-forward-syntactic-ws)
                      (cond ((looking-at c-opt-identifier-concat-key)
                             (c-put-font-lock-face id-start id-end
                                                c-reference-face-name))
                            ((eq (char-after) ?\())
                            (t (c-put-font-lock-face id-start id-end
                                              'font-lock-type-face))))))

                (goto-char pos)))
          (goto-char pos)))))
  nil)

(defun c-font-lock-declarators (limit list types not-top)
  ;; Assuming the point is at the start of a declarator in a declaration,
  ;; fontify the identifier it declares.  (If TYPES is set, it does this via
  ;; the macro `c-fontify-types-and-refs'.)
  ;;
  ;; If LIST is non-nil, also fontify the ids in any following declarators in
  ;; a comma separated list (e.g.  "foo" and "*bar" in "int foo = 17, *bar;");
  ;; additionally, mark the commas with c-type property 'c-decl-id-start or
  ;; 'c-decl-type-start (according to TYPES).  Stop at LIMIT.
  ;;
  ;; If TYPES is non-nil, fontify all identifiers as types.  If NOT-TOP is
  ;; non-nil, we are not at the top-level ("top-level" includes being directly
  ;; inside a class or namespace, etc.).
  ;;
  ;; Nil is always returned.  The function leaves point at the delimiter after
  ;; the last declarator it processes.
  ;;
  ;; This function might do hidden buffer changes.

  ;;(message "c-font-lock-declarators from %s to %s" (point) limit)
  (c-fontify-types-and-refs
      ((pos (point)) next-pos id-start id-end
       decl-res
       paren-depth
       id-face got-type got-init
       c-last-identifier-range
       (separator-prop (if types 'c-decl-type-start 'c-decl-id-start))
       brackets-after-id)

    ;; The following `while' fontifies a single declarator id each time round.
    ;; It loops only when LIST is non-nil.
    (while
        (and pos (setq decl-res (c-forward-declarator limit)))
      (setq next-pos (point)
            id-start (car decl-res)
            id-face (if (and (eq (char-after) ?\()
                             (or (not (c-major-mode-is 'c++-mode))
                                 (not not-top)
                                 (car (cddr (cddr decl-res))) ; Id is in
                                                              ; parens, etc.
                                 (save-excursion
                                   (forward-char)
                                   (c-forward-syntactic-ws)
                                   (looking-at "[*&]")))
                             (not (car (cddr decl-res))) ; brackets-after-id
                             (or (not (c-major-mode-is 'c++-mode))
                                 (save-excursion
                                   (let (c-last-identifier-range)
                                     (forward-char)
                                     (c-forward-syntactic-ws)
                                     (catch 'is-function
                                       (while
                                           (progn
                                             (if (eq (char-after) ?\))
                                                 (throw 'is-function t))
                                             (setq got-type (c-forward-type))
                                             (cond
                                              ((null got-type)
                                               (throw 'is-function nil))
                                              ((not (eq got-type 'maybe))
                                               (throw 'is-function t)))
                                             (c-forward-declarator limit t)
                                             (eq (char-after) ?,))
                                         (forward-char)
                                         (c-forward-syntactic-ws))
                                       t)))))
                        'font-lock-function-name-face
                      'font-lock-variable-name-face)
            got-init (and (cadr (cddr decl-res)) ; got-init
                          (char-after)))

      (if types
          ;; Register and fontify the identifier as a type.
          (let ((c-promote-possible-types t))
            (goto-char id-start)
            (c-forward-type))
        ;; Fontify the last symbol in the identifier if it isn't fontified
        ;; already.  The check is necessary only in certain cases where this
        ;; function is used "sloppily", e.g. in `c-simple-decl-matchers'.
        (when (and c-last-identifier-range
                   (not (get-text-property (car c-last-identifier-range)
                                           'face)))
          (c-put-font-lock-face (car c-last-identifier-range)
                                (cdr c-last-identifier-range)
                                id-face)))

      (goto-char next-pos)
      (setq pos nil)          ; So as to terminate the enclosing `while' form.
      (when list
        ;; Jump past any initializer or function prototype to see if
        ;; there's a ',' to continue at.
        (cond ((eq id-face 'font-lock-function-name-face)
               ;; Skip a parenthesized initializer (C++) or a function
               ;; prototype.
               (if (c-safe (c-forward-sexp 1) t) ; over the parameter list.
                   (c-forward-syntactic-ws limit)
                 (goto-char limit)))    ; unbalanced parens

              (got-init ; "=" sign OR opening "(", "[", or "{"
               ;; Skip an initializer expression.  If we're at a '='
               ;; then accept a brace list directly after it to cope
               ;; with array initializers.  Otherwise stop at braces
               ;; to avoid going past full function and class blocks.
               (and (if (and (eq got-init ?=)
                             (= (c-forward-token-2 1 nil limit) 0)
                             (looking-at "{"))
                        (c-safe (c-forward-sexp) t) ; over { .... }
                      t)
                    (< (point) limit)
                    ;; FIXME: Should look for c-decl-end markers here;
                    ;; we might go far into the following declarations
                    ;; in e.g. ObjC mode (see e.g. methods-4.m).
                    (c-syntactic-re-search-forward "[;,{]" limit 'move t)
                    (backward-char)))

              (t (c-forward-syntactic-ws limit)))

        ;; If a ',' is found we set pos to the next declarator and iterate.
        (when (and (< (point) limit) (looking-at ","))
          (c-put-char-property (point) 'c-type separator-prop)
          (forward-char)
          (c-forward-syntactic-ws limit)
          (setq pos (point))))))     ; acts to make the `while' form continue.
  nil)

(defun c-font-lock-declarations (limit)
  ;; Fontify all the declarations, casts and labels from the point to LIMIT.
  ;; Assumes that strings and comments have been fontified already.
  ;;
  ;; This function will be called from font-lock for a region bounded by POINT
  ;; and LIMIT, as though it were to identify a keyword for
  ;; font-lock-keyword-face.  It always returns NIL to inhibit this and
  ;; prevent a repeat invocation.  See elisp/lispref page "Search-based
  ;; Fontification".
  ;;
  ;; This function might do hidden buffer changes.

  ;;(message "c-font-lock-declarations search from %s to %s" (point) limit)

  (save-restriction
    (let (;; The position where `c-find-decl-spots' last stopped.
          start-pos
          ;; o - 'decl if we're in an arglist containing declarations
          ;;   (but if `c-recognize-paren-inits' is set it might also be
          ;;   an initializer arglist);
          ;; o - '<> if the arglist is of angle bracket type;
          ;; o - 'arglist if it's some other arglist;
          ;; o - nil, if not in an arglist at all.  This includes the
          ;;   parenthesized condition which follows "if", "while", etc.
          context
          ;; A list of starting positions of possible type declarations, or of
          ;; the typedef preceding one, if any.
          last-cast-end
          ;; The result from `c-forward-decl-or-cast-1'.
          decl-or-cast
          ;; The maximum of the end positions of all the checked type
          ;; decl expressions in the successfully identified
          ;; declarations.  The position might be either before or
          ;; after the syntactic whitespace following the last token
          ;; in the type decl expression.
          (max-type-decl-end 0)
          ;; Same as `max-type-decl-*', but used when we're before
          ;; `token-pos'.
          (max-type-decl-end-before-token 0)
          ;; End of <..> construct which has had c-<>-arg-sep c-type
          ;; properties set within it.
          (max-<>-end 0)
          ;; Set according to the context to direct the heuristics for
          ;; recognizing C++ templates.
          c-restricted-<>-arglists
          ;; Turn on recording of identifier ranges in
          ;; `c-forward-decl-or-cast-1' and `c-forward-label' for
          ;; later fontification.
          (c-record-type-identifiers t)
          label-type
          c-record-ref-identifiers
          ;; Make `c-forward-type' calls mark up template arglists if
          ;; it finds any.  That's necessary so that we later will
          ;; stop inside them to fontify types there.
          (c-parse-and-markup-<>-arglists t)
          lbrace ; position of some {.
          ;; The font-lock package in Emacs is known to clobber
          ;; `parse-sexp-lookup-properties' (when it exists).
          (parse-sexp-lookup-properties
           (cc-eval-when-compile
             (boundp 'parse-sexp-lookup-properties))
           ))

      ;; Below we fontify a whole declaration even when it crosses the limit,
      ;; to avoid gaps when jit/lazy-lock fontifies the file a block at a
      ;; time.  That is however annoying during editing, e.g. the following is
      ;; a common situation while the first line is being written:
      ;;
      ;;     my_variable
      ;;     some_other_variable = 0;
      ;;
      ;; font-lock will put the limit at the beginning of the second line
      ;; here, and if we go past it we'll fontify "my_variable" as a type and
      ;; "some_other_variable" as an identifier, and the latter will not
      ;; correct itself until the second line is changed.  To avoid that we
      ;; narrow to the limit if the region to fontify is a single line.
      (if (<= limit (c-point 'bonl))
          (narrow-to-region
           (point-min)
           (save-excursion
             ;; Narrow after any operator chars following the limit though,
             ;; since those characters can be useful in recognizing a
             ;; declaration (in particular the '{' that opens a function body
             ;; after the header).
             (goto-char limit)
             (skip-chars-forward c-nonsymbol-chars)
             (point))))

      (c-find-decl-spots
       limit
       c-decl-start-re
       (eval c-maybe-decl-faces)

       (lambda (match-pos inside-macro &optional toplev)
         ;; Note to maintainers: don't use `limit' inside this lambda form;
         ;; c-find-decl-spots sometimes narrows to less than `limit'.
         (setq start-pos (point))
         (when
          ;; The result of the form below is true when we don't recognize a
          ;; declaration or cast, and we don't recognize a "non-decl",
          ;; typically a brace list.
          (if (or (and (eq (get-text-property (point) 'face)
                           'font-lock-keyword-face)
                       (looking-at c-not-decl-init-keywords))
                  (and c-macro-with-semi-re
                       (looking-at c-macro-with-semi-re))) ; 2008-11-04
              ;; Don't do anything more if we're looking at a keyword that
              ;; can't start a declaration.
              t

            ;; Set `context' and `c-restricted-<>-arglists'.  Look for
            ;; "<" for the sake of C++-style template arglists.
            ;; Ignore "(" when it's part of a control flow construct
            ;; (e.g. "for (").
            (let ((type (and (> match-pos (point-min))
                             (c-get-char-property (1- match-pos) 'c-type))))
              (cond ((not (memq (char-before match-pos) '(?\( ?, ?\[ ?< ?{)))
                     (setq context (and toplev 'top)
                           c-restricted-<>-arglists nil))
                    ;; A control flow expression or a decltype
                    ((and (eq (char-before match-pos) ?\()
                          (save-excursion
                            (goto-char match-pos)
                            (backward-char)
                            (c-backward-token-2)
                            (or (looking-at c-block-stmt-2-key)
                                (looking-at c-block-stmt-1-2-key)
                                (looking-at c-typeof-key))))
                     (setq context nil
                           c-restricted-<>-arglists t))
                    ;; Near BOB.
                    ((<= match-pos (point-min))
                     (setq context 'arglist
                           c-restricted-<>-arglists t))
                    ;; Got a cached hit in a declaration arglist.
                    ((eq type 'c-decl-arg-start)
                     (setq context 'decl
                           c-restricted-<>-arglists nil))
                    ;; We're inside (probably) a brace list.
                    ((eq type 'c-not-decl)
                     (setq context 'not-decl
                           c-restricted-<>-arglists nil))
                    ;; Inside a C++11 lambda function arglist.
                    ((and (c-major-mode-is 'c++-mode)
                          (eq (char-before match-pos) ?\()
                          (save-excursion
                            (goto-char match-pos)
                            (c-backward-token-2)
                            (and
                             (c-safe (goto-char (scan-sexps (point) -1)))
                             (c-looking-at-c++-lambda-capture-list))))
                     (setq context 'decl
                           c-restricted-<>-arglists nil)
                     (c-put-char-property (1- match-pos) 'c-type
                                          'c-decl-arg-start))
                    ;; We're inside a brace list.
                    ((and (eq (char-before match-pos) ?{)
                          (save-excursion
                            (goto-char (1- match-pos))
                            (consp
                             (c-looking-at-or-maybe-in-bracelist))))
                     (setq context 'not-decl
                           c-restricted-<>-arglists nil)
                     (c-put-char-property (1- match-pos) 'c-type
                                          'c-not-decl))
                    ;; We're inside an "ordinary" open brace.
                    ((eq (char-before match-pos) ?{)
                     (setq context (and toplev 'top)
                           c-restricted-<>-arglists nil))
                    ;; Inside an angle bracket arglist.
                    ((or (eq type 'c-<>-arg-sep)
                         (eq (char-before match-pos) ?<))
                     (setq context '<>
                           c-restricted-<>-arglists nil))
                    ;; Got a cached hit in some other type of arglist.
                    (type
                     (setq context 'arglist
                           c-restricted-<>-arglists t))
                    ((if inside-macro
                         (< match-pos max-type-decl-end-before-token)
                       (< match-pos max-type-decl-end))
                     ;; The point is within the range of a previously
                     ;; encountered type decl expression, so the arglist
                     ;; is probably one that contains declarations.
                     ;; However, if `c-recognize-paren-inits' is set it
                     ;; might also be an initializer arglist.
                     (setq context 'decl
                           c-restricted-<>-arglists nil)
                     ;; The result of this check is cached with a char
                     ;; property on the match token, so that we can look
                     ;; it up again when refontifying single lines in a
                     ;; multiline declaration.
                     (c-put-char-property (1- match-pos)
                                          'c-type 'c-decl-arg-start))
                    ;; Got an open paren preceded by an arith operator.
                    ((and (eq (char-before match-pos) ?\()
                          (save-excursion
                            (and (zerop (c-backward-token-2 2))
                                 (looking-at c-arithmetic-op-regexp))))
                     (setq context nil
                           c-restricted-<>-arglists nil))
                    (t (setq context 'arglist
                             c-restricted-<>-arglists t))))

            ;; Check we haven't missed a preceding "typedef".
            (when (not (looking-at c-typedef-key))
              (c-backward-syntactic-ws)
              (c-backward-token-2)
              (or (looking-at c-typedef-key)
                  (goto-char start-pos)))

            ;; In QT, "more" is an irritating keyword that expands to nothing.
            ;; We skip over it to prevent recognition of "more slots: <symbol>"
            ;; as a bitfield declaration.
            (when (and (c-major-mode-is 'c++-mode)
                       (looking-at
                        (concat "\\(more\\)\\([^" c-symbol-chars "]\\|$\\)")))
              (goto-char (match-end 1))
              (c-forward-syntactic-ws))

            ;; Now analyze the construct.
            (if (eq context 'not-decl)
                (progn
                  (setq decl-or-cast nil)
                  (if (c-syntactic-re-search-forward
                       "," (min limit (point-max)) 'at-limit t)
                      (c-put-char-property (1- (point)) 'c-type 'c-not-decl))
                  nil)
              (setq decl-or-cast
                    (c-forward-decl-or-cast-1
                     match-pos context last-cast-end))

              ;; Ensure that c-<>-arg-sep c-type properties are in place on the
              ;; commas separating the arguments inside template/generic <..>s.
              (when (and (eq (char-before match-pos) ?<)
                         (> match-pos max-<>-end))
                (save-excursion
                  (goto-char match-pos)
                  (c-backward-token-2)
                  (if (and
                       (eq (char-after) ?<)
                       (let ((c-restricted-<>-arglists
                              (save-excursion
                                (c-backward-token-2)
                                (and
                                 (not (looking-at c-opt-<>-sexp-key))
                                 (progn (c-backward-syntactic-ws)
                                        (memq (char-before) '(?\( ?,)))
                                 (not (eq (c-get-char-property (1- (point))
                                                               'c-type)
                                          'c-decl-arg-start))))))
                         (c-forward-<>-arglist nil)))
                      (setq max-<>-end (point)))))

              (cond
               ((eq decl-or-cast 'cast)
                ;; Save the position after the previous cast so we can feed
                ;; it to `c-forward-decl-or-cast-1' in the next round.  That
                ;; helps it discover cast chains like "(a) (b) c".
                (setq last-cast-end (point))
                (c-fontify-recorded-types-and-refs)
                nil)

               (decl-or-cast
                ;; We've found a declaration.

                ;; Set `max-type-decl-end' or `max-type-decl-end-before-token'
                ;; under the assumption that we're after the first type decl
                ;; expression in the declaration now.  That's not really true;
                ;; we could also be after a parenthesized initializer
                ;; expression in C++, but this is only used as a last resort
                ;; to slant ambiguous expression/declarations, and overall
                ;; it's worth the risk to occasionally fontify an expression
                ;; as a declaration in an initializer expression compared to
                ;; getting ambiguous things in normal function prototypes
                ;; fontified as expressions.
                (if inside-macro
                    (when (> (point) max-type-decl-end-before-token)
                      (setq max-type-decl-end-before-token (point)))
                  (when (> (point) max-type-decl-end)
                    (setq max-type-decl-end (point))))

                ;; Do we have an expression as the second or third clause of
                ;; a "for" paren expression?
                (if (save-excursion
                      (and
                       (car (cddr decl-or-cast)) ; maybe-expression flag.
                       (goto-char start-pos)
                       (c-go-up-list-backward)
                       (eq (char-after) ?\()
                       (progn (c-backward-syntactic-ws)
                              (c-simple-skip-symbol-backward))
                       (looking-at c-paren-stmt-key)
                       (progn (goto-char match-pos)
                              (while (and (eq (char-before) ?\))
                                          (c-go-list-backward))
                                (c-backward-syntactic-ws))
                              (eq (char-before) ?\;))))
                    ;; We've got an expression in "for" parens.  Remove the
                    ;; "type" that would spuriously get fontified.
                    (let ((elt (and (consp c-record-type-identifiers)
                                    (assq (cadr (cddr decl-or-cast))
                                          c-record-type-identifiers))))
                      (when elt
                        (setq c-record-type-identifiers
                              (c-delq-from-dotted-list
                               elt c-record-type-identifiers)))
                      t)
                  ;; Back up to the type to fontify the declarator(s).
                  (goto-char (car decl-or-cast))

                  (let ((decl-list
                         (if (not (memq context '(nil top)))
                             ;; Should normally not fontify a list of
                             ;; declarators inside an arglist, but the first
                             ;; argument in the ';' separated list of a "for"
                             ;; statement is an exception.
                             (when (eq (char-before match-pos) ?\()
                               (save-excursion
                                 (goto-char (1- match-pos))
                                 (c-backward-syntactic-ws)
                                 (and (c-simple-skip-symbol-backward)
                                      (looking-at c-paren-stmt-key))))
                           t)))

                    ;; Fix the `c-decl-id-start' or `c-decl-type-start' property
                    ;; before the first declarator if it's a list.
                    ;; `c-font-lock-declarators' handles the rest.
                    (when decl-list
                      (save-excursion
                        (c-backward-syntactic-ws)
                        (unless (bobp)
                          (c-put-char-property (1- (point)) 'c-type
                                               (if (cadr decl-or-cast)
                                                   'c-decl-type-start
                                                 'c-decl-id-start)))))

                    (c-font-lock-declarators
                     (min limit (point-max)) decl-list
                     (cadr decl-or-cast) (not toplev)))

                  ;; A declaration has been successfully identified, so do all the
                  ;; fontification of types and refs that've been recorded.
                  (c-fontify-recorded-types-and-refs)
                  nil))

               (t t))))

          ;; It was a false alarm.  Check if we're in a label (or other
          ;; construct with `:' except bitfield) instead.
          (goto-char start-pos)
          (when (setq label-type (c-forward-label t match-pos nil))
            ;; Can't use `c-fontify-types-and-refs' here since we
            ;; use the label face at times.
            (cond ((eq label-type 'goto-target)
                   (c-put-font-lock-face (caar c-record-ref-identifiers)
                                         (cdar c-record-ref-identifiers)
                                         c-label-face-name))
                  ((eq label-type 'qt-1kwd-colon)
                   (c-put-font-lock-face (caar c-record-ref-identifiers)
                                         (cdar c-record-ref-identifiers)
                                         'font-lock-keyword-face))
                  ((eq label-type 'qt-2kwds-colon)
                   (mapc
                    (lambda (kwd)
                      (c-put-font-lock-face (car kwd) (cdr kwd)
                                            'font-lock-keyword-face))
                    c-record-ref-identifiers)))
            (setq c-record-ref-identifiers nil)
            ;; `c-forward-label' has probably added a `c-decl-end'
            ;; marker, so return t to `c-find-decl-spots' to signal
            ;; that.
            t))))

      nil)))

(defun c-font-lock-enum-tail (limit)
  ;; Fontify an enum's identifiers when POINT is within the enum's brace
  ;; block.
  ;;
  ;; This function will be called from font-lock for a region bounded by POINT
  ;; and LIMIT, as though it were to identify a keyword for
  ;; font-lock-keyword-face.  It always returns NIL to inhibit this and
  ;; prevent a repeat invocation.  See elisp/lispref page "Search-based
  ;; Fontification".
  ;;
  ;; Note that this function won't attempt to fontify beyond the end of the
  ;; current enum block, if any.
  (let* ((paren-state (c-parse-state))
         (encl-pos (c-most-enclosing-brace paren-state)))
    (when (and
           encl-pos
           (eq (char-after encl-pos) ?\{)
           (save-excursion
             (goto-char encl-pos)
             (c-backward-over-enum-header)))
      (c-syntactic-skip-backward "^{," nil t)
      (c-put-char-property (1- (point)) 'c-type 'c-decl-id-start)

      (c-forward-syntactic-ws)
      (c-font-lock-declarators limit t nil t)))
  nil)

(defun c-font-lock-cut-off-declarators (limit)
  ;; Fontify any declarators "cut off" from their declaring type at the start
  ;; of the region being fontified.
  ;;
  ;; This function will be called from font-lock- for a region bounded by
  ;; POINT and LIMIT, as though it were to identify a keyword for
  ;; font-lock-keyword-face.  It always returns NIL to inhibit this and
  ;; prevent a repeat invocation.  See elisp/lispref page "Search-based
  ;; fontification".
  (let ((decl-search-lim (c-determine-limit 1000))
        paren-state bod-res is-typedef encl-pos
        (here (point))
        c-recognize-knr-p)              ; Strictly speaking, bogus, but it
                                        ; speeds up lisp.h tremendously.
    (save-excursion
      (when (not (c-back-over-member-initializers))
        (unless (or (eobp)
                    (looking-at "\\s(\\|\\s)"))
          (forward-char))
        (c-syntactic-skip-backward "^;{}" decl-search-lim t)
        (when (eq (char-before) ?})
          (c-go-list-backward)  ; brace block of struct, etc.?
          (c-syntactic-skip-backward "^;{}" decl-search-lim t))
        (when (or (bobp)
                  (memq (char-before) '(?\; ?{ ?})))
          (c-forward-syntactic-ws)
          ;; We're now putatively at the declaration.
          (setq paren-state (c-parse-state))
          ;; At top level or inside a "{"?
          (if (or (not (setq encl-pos
                             (c-most-enclosing-brace paren-state)))
                  (eq (char-after encl-pos) ?\{))
              (progn
                (when (looking-at c-typedef-key) ; "typedef"
                  (setq is-typedef t)
                  (goto-char (match-end 0))
                  (c-forward-syntactic-ws))
                ;; At a real declaration?
                (if (memq (c-forward-type t) '(t known found decltype))
                    (c-font-lock-declarators
                     limit t is-typedef (not (c-bs-at-toplevel-p here)))))))))
    nil))

(defun c-font-lock-enclosing-decls (limit)
  ;; Fontify the declarators of (nested) declarations we're in the middle of.
  ;; This is mainly for when a jit-lock etc. chunk starts inside the brace
  ;; block of a struct/union/class, etc.
  ;;
  ;; This function will be called from font-lock for a region bounded by POINT
  ;; and LIMIT, as though it were to identify a keyword for
  ;; font-lock-keyword-face.  It always returns NIL to inhibit this and
  ;; prevent a repeat invocation.  See elisp/lispref page "Search-based
  ;; Fontification".
  (let* ((paren-state (c-parse-state))
         (decl-search-lim (c-determine-limit 1000))
         in-typedef ps-elt)
    ;; Are we in any nested struct/union/class/etc. braces?
    (while paren-state
      (setq ps-elt (car paren-state)
            paren-state (cdr paren-state))
      (when (and (atom ps-elt)
                 (eq (char-after ps-elt) ?\{))
        (goto-char ps-elt)
        (c-syntactic-skip-backward "^;{}" decl-search-lim)
        (when (or (bobp)
                  (memq (char-before) '(?\; ?})))
          (c-forward-syntactic-ws)
          (setq in-typedef (looking-at c-typedef-key))
          (if in-typedef (c-forward-token-2))
          (when (and c-opt-block-decls-with-vars-key
                     (looking-at c-opt-block-decls-with-vars-key))
            (goto-char ps-elt)
            (when (c-safe (c-forward-sexp))
              (c-forward-syntactic-ws)
              (c-font-lock-declarators limit t in-typedef
                                       (not (c-bs-at-toplevel-p (point)))))))))))

(defun c-font-lock-raw-strings (limit)
  ;; Fontify C++ raw strings.
  ;;
  ;; This function will be called from font-lock for a region bounded by POINT
  ;; and LIMIT, as though it were to identify a keyword for
  ;; font-lock-keyword-face.  It always returns NIL to inhibit this and
  ;; prevent a repeat invocation.  See elisp/lispref page "Search-based
  ;; Fontification".
  (let* ((state (c-state-semi-pp-to-literal (point)))
         (string-start (and (eq (cadr state) 'string)
                            (car (cddr state))))
         (raw-id (and string-start
                      (save-excursion
                        (goto-char string-start)
                        (and (eq (char-before) ?R)
                             (looking-at "\"\\([^ ()\\\n\r\t]\\{0,16\\}\\)(")
                             (match-string-no-properties 1))))))
    (while (< (point) limit)
      (if raw-id
          (progn
            (if (search-forward-regexp (concat ")\\(" (regexp-quote raw-id) "\\)\"")
                                       limit 'limit)
                (c-put-font-lock-face (match-beginning 1) (point) 'default))
            (setq raw-id nil))

        (when (search-forward-regexp
               "R\\(\"\\)\\([^ ()\\\n\r\t]\\{0,16\\}\\)(" limit 'limit)
          (when
              (or (and (eobp)
                       (eq (c-get-char-property (1- (point)) 'face)
                           'font-lock-warning-face))
                  (eq (c-get-char-property (point) 'face) 'font-lock-string-face)
                  (and (equal (c-get-char-property (match-end 2) 'syntax-table) '(1))
                       (equal (c-get-char-property (match-beginning 1) 'syntax-table)
                              '(1))))
            (let ((paren-prop (c-get-char-property (1- (point)) 'syntax-table)))
              (if paren-prop
                  (progn
                    (c-put-font-lock-face (match-beginning 0) (match-end 0)
                                          'font-lock-warning-face)
                    (when
                        (and
                         (equal paren-prop '(15))
                         (not (c-search-forward-char-property 'syntax-table '(15) limit)))
                      (goto-char limit)))
                (c-put-font-lock-face (match-beginning 1) (match-end 2) 'default)
                (setq raw-id (match-string-no-properties 2)))))))))
  nil)

(defun c-font-lock-c++-lambda-captures (limit)
  ;; Fontify the lambda capture component of C++ lambda declarations.
  ;;
  ;; This function will be called from font-lock for a region bounded by POINT
  ;; and LIMIT, as though it were to identify a keyword for
  ;; font-lock-keyword-face.  It always returns NIL to inhibit this and
  ;; prevent a repeat invocation.  See elisp/lispref page "Search-based
  ;; Fontification".
  (let (mode capture-default id-start id-end declaration sub-begin sub-end)
    (while (and (< (point) limit)
                (search-forward "[" limit t))
      (when (progn (backward-char)
                   (prog1
                       (c-looking-at-c++-lambda-capture-list)
                     (forward-char)))
        (c-forward-syntactic-ws)
        (setq mode (and (memq (char-after) '(?= ?&))
                        (char-after)))
        ;; Is the first element of the list a bare "=" or "&"?
        (when mode
          (forward-char)
          (c-forward-syntactic-ws)
          (if (memq (char-after) '(?, ?\]))
              (progn
                (setq capture-default mode)
                (when (eq (char-after) ?,)
                  (forward-char)
                  (c-forward-syntactic-ws)))
            (c-backward-token-2)))

        ;; Go round the following loop once per captured item.  We use "\\s)"
        ;; rather than "\\]" here to avoid infinite looping in this situation:
        ;; "unsigned items [] { [ }".  The second "[" triggers this function,
        ;; but if we don't match the "}" with an "\\s)", the
        ;; `c-syntactic-re-search-forward' at the end of the loop fails to
        ;; move forward over it, leaving point stuck at the "}".
        (while (and (not (looking-at "\\s)"))
                    (< (point) limit))
          (if (eq (char-after) ?&)
              (progn (setq mode ?&)
                     (forward-char)
                     (c-forward-syntactic-ws))
            (setq mode ?=))
          (if (c-on-identifier)
              (progn
                (setq id-start (point))
                (forward-char)
                (c-end-of-current-token)
                (setq id-end (point))
                (c-forward-syntactic-ws)

                (setq declaration (eq (char-after) ?=))
                (when declaration
                  (forward-char)        ; over "="
                  (c-forward-syntactic-ws)
                  (setq sub-begin (point)))
                (if (or (and (< (point) limit)
                             (c-syntactic-re-search-forward "," limit t t))
                        (and (c-go-up-list-forward nil limit)
                             (eq (char-before) ?\])))
                    (backward-char)
                  (goto-char limit))
                (when declaration
                  (save-excursion
                    (setq sub-end (point))
                    (goto-char sub-begin)
                    (c-font-lock-c++-lambda-captures sub-end)))

                (c-put-font-lock-face id-start id-end
                                      (cond
                                       (declaration
                                        'font-lock-variable-name-face)
                                       ((and capture-default
                                             (eq mode capture-default))
                                        'font-lock-warning-face)
                                       ((eq mode ?=) font-lock-constant-face)
                                       (t 'font-lock-variable-name-face))))
            (c-syntactic-re-search-forward "," limit 'bound t))

          (c-forward-syntactic-ws)
          (when (eq (char-after) ?,)
            (forward-char)
            (c-forward-syntactic-ws)))

        (setq capture-default nil)
        (if (< (point) limit)
            (forward-char))))) ; over the terminating "]" or other close paren.
  nil)


(c-lang-defconst c-simple-decl-matchers
  "Simple font lock matchers for types and declarations.  These are used
on level 2 only and so aren't combined with `c-complex-decl-matchers'."

  t `(;; Objective-C methods.
      ,@(when (c-major-mode-is 'objc-mode)
          `((,(c-lang-const c-opt-method-key)
             (,(byte-compile
                (lambda (limit)
                  (let (;; The font-lock package in Emacs is known to clobber
                        ;; `parse-sexp-lookup-properties' (when it exists).
                        (parse-sexp-lookup-properties
                         (cc-eval-when-compile
                           (boundp 'parse-sexp-lookup-properties))))
                    (save-restriction
                      (narrow-to-region (point-min) limit)
                      (c-font-lock-objc-method)))
                  nil))
              (goto-char (match-end 1))))))

      ;; Fontify all type names and the identifiers in the
      ;; declarations they might start.  Use eval here since
      ;; `c-known-type-key' gets its value from
      ;; `*-font-lock-extra-types' on mode init.
      (eval . (list ,(c-make-font-lock-search-function
                      'c-known-type-key
                      '(1 'font-lock-type-face t)
                      '((c-font-lock-declarators limit t nil nil)
                        (save-match-data
                          (goto-char (match-end 1))
                          (c-forward-syntactic-ws))
                        (goto-char (match-end 1))))))

      ;; Fontify types preceded by `c-type-prefix-kwds' and the
      ;; identifiers in the declarations they might start.
      ,@(when (c-lang-const c-type-prefix-kwds)
          (let* ((prefix-re (c-make-keywords-re nil
                              (c-lang-const c-type-prefix-kwds)))
                 (type-match (+ 2
                                (regexp-opt-depth prefix-re)
                                (c-lang-const c-simple-ws-depth))))
            `((,(c-make-font-lock-search-function
                 (concat "\\<\\(" prefix-re "\\)" ; 1
                         (c-lang-const c-simple-ws) "+"
                         (concat "\\("  ; 2 + prefix-re + c-simple-ws
                                 (c-lang-const c-symbol-key)
                                 "\\)"))
                 `(,type-match
                   'font-lock-type-face t)
                 `((c-font-lock-declarators limit t nil nil)
                   (save-match-data
                     (goto-char (match-end ,type-match))
                     (c-forward-syntactic-ws))
                   (goto-char (match-end ,type-match))))))))

      ;; Fontify special declarations that lacks a type.
      ,@(when (c-lang-const c-typeless-decl-kwds)
          `((,(c-make-font-lock-search-function
               (concat "\\<\\("
                       (regexp-opt (c-lang-const c-typeless-decl-kwds))
                       "\\)\\>")
               '((c-font-lock-declarators limit t nil nil)
                 (save-match-data
                   (goto-char (match-end 1))
                   (c-forward-syntactic-ws))
                 (goto-char (match-end 1)))))))

      ;; Fontify generic colon labels in languages that support them.
      ,@(when (c-lang-const c-recognize-colon-labels)
          `(c-font-lock-labels))))

(c-lang-defconst c-complex-decl-matchers
  "Complex font lock matchers for types and declarations.  Used on level
3 and higher."

  ;; Note: This code in this form dumps a number of functions into the
  ;; resulting constant, `c-matchers-3'.  At run time, font lock will call
  ;; each of them as a "FUNCTION" (see Elisp page "Search-based
  ;; Fontification").  The font lock region is delimited by POINT and the
  ;; single parameter, LIMIT.  Each of these functions returns NIL (thus
  ;; inhibiting spurious font-lock-keyword-face highlighting and another
  ;; call).

  t `(;; Initialize some things before the search functions below.
      c-font-lock-complex-decl-prepare

      ,@(if (c-major-mode-is 'objc-mode)
            ;; Fontify method declarations in Objective-C, but first
            ;; we have to put the `c-decl-end' `c-type' property on
            ;; all the @-style directives that haven't been handled in
            ;; `c-basic-matchers-before'.
            `(,(c-make-font-lock-search-function
                (c-make-keywords-re t
                  ;; Exclude "@class" since that directive ends with a
                  ;; semicolon anyway.
                  (delete "@class"
                          (append (c-lang-const c-protection-kwds)
                                  (c-lang-const c-other-decl-kwds)
                                  nil)))
                '((c-put-char-property (1- (match-end 1))
                                       'c-type 'c-decl-end)))
              c-font-lock-objc-methods))

      ;; Fontify declarators which have been cut off from their declaring
      ;; types at the start of the region.
      c-font-lock-cut-off-declarators

      ;; Fontify all declarations, casts and normal labels.
      c-font-lock-declarations

      ;; Fontify declarators when POINT is within their declaration.
      c-font-lock-enclosing-decls

      ;; Fontify angle bracket arglists like templates in C++.
      ,@(when (c-lang-const c-recognize-<>-arglists)
          `(c-font-lock-<>-arglists))

      ,@(when (c-major-mode-is 'c++-mode)
          `(c-font-lock-c++-lambda-captures))

      ;; The first two rules here mostly find occurrences that
      ;; `c-font-lock-declarations' has found already, but not
      ;; declarations containing blocks in the type (see note below).
      ;; It's also useful to fontify these everywhere to show e.g. when
      ;; a type keyword is accidentally used as an identifier.

      ;; Fontify basic types.
      ,(let ((re (c-make-keywords-re nil
                   (c-lang-const c-primitive-type-kwds))))
         (if (c-major-mode-is 'pike-mode)
             ;; No symbol is a keyword after "->" in Pike.
             `(,(concat "\\(\\=.?\\|[^>]\\|[^-]>\\)"
                        "\\<\\(" re "\\)\\>")
               2 font-lock-type-face)
           `(,(concat "\\<\\(" re "\\)\\>")
             1 'font-lock-type-face)))

      ;; Fontify types preceded by `c-type-prefix-kwds' (e.g. "struct").
      ,@(when (c-lang-const c-type-prefix-kwds)
          `((,(byte-compile
               `(lambda (limit)
                  (c-fontify-types-and-refs
                      ((c-promote-possible-types t)
                       ;; The font-lock package in Emacs is known to clobber
                       ;; `parse-sexp-lookup-properties' (when it exists).
                       (parse-sexp-lookup-properties
                        (cc-eval-when-compile
                          (boundp 'parse-sexp-lookup-properties))))
                    (save-restriction
                      ;; Narrow to avoid going past the limit in
                      ;; `c-forward-type'.
                      (narrow-to-region (point) limit)
                      (while (re-search-forward
                              ,(concat "\\<\\("
                                       (c-make-keywords-re nil
                                         (c-lang-const c-type-prefix-kwds))
                                       "\\)\\>")
                              limit t)
                        (unless (c-skip-comments-and-strings limit)
                          (c-forward-syntactic-ws)
                          ;; Handle prefix declaration specifiers.
                          (while
                              (or
                               (when (or (looking-at c-prefix-spec-kwds-re)
                                         (and (c-major-mode-is 'java-mode)
                                              (looking-at "@[A-Za-z0-9]+")))
                                 (c-forward-keyword-clause 1)
                                 t)
                               (when (and c-opt-cpp-prefix
                                          (looking-at
                                           c-noise-macro-with-parens-name-re))
                                 (c-forward-noise-clause)
                                 t)))
                          ,(if (c-major-mode-is 'c++-mode)
                               `(when (and (c-forward-type)
                                           (eq (char-after) ?=))
                                  ;; In C++ we additionally check for a "class
                                  ;; X = Y" construct which is used in
                                  ;; templates, to fontify Y as a type.
                                  (forward-char)
                                  (c-forward-syntactic-ws)
                                  (c-forward-type))
                             `(c-forward-type))
                          )))))))))

      ;; Fontify symbols after closing braces as declaration
      ;; identifiers under the assumption that they are part of
      ;; declarations like "class Foo { ... } foo;".  It's too
      ;; expensive to check this accurately by skipping past the
      ;; brace block, so we use the heuristic that it's such a
      ;; declaration if the first identifier is on the same line as
      ;; the closing brace.  `c-font-lock-declarations' will later
      ;; override it if it turns out to be an new declaration, but
      ;; it will be wrong if it's an expression (see the test
      ;; decls-8.cc).
;;       ,@(when (c-lang-const c-opt-block-decls-with-vars-key)
;;        `((,(c-make-font-lock-search-function
;;             (concat "}"
;;                     (c-lang-const c-single-line-syntactic-ws)
;;                     "\\("            ; 1 + c-single-line-syntactic-ws-depth
;;                     (c-lang-const c-type-decl-prefix-key)
;;                     "\\|"
;;                     (c-lang-const c-symbol-key)
;;                     "\\)")
;;             `((c-font-lock-declarators limit t nil) ; That nil says use `font-lock-variable-name-face';
;;                                      ; t would mean `font-lock-function-name-face'.
;;               (progn
;;                 (c-put-char-property (match-beginning 0) 'c-type
;;                                      'c-decl-id-start)
;; ;                                    'c-decl-type-start)
;;                 (goto-char (match-beginning
;;                             ,(1+ (c-lang-const
;;                                   c-single-line-syntactic-ws-depth)))))
;;               (goto-char (match-end 0)))))))

      ;; Fontify the type in C++ "new" expressions.
      ,@(when (c-major-mode-is 'c++-mode)
          ;; This pattern is a probably a "(MATCHER . ANCHORED-HIGHLIGHTER)"
          ;; (see Elisp page "Search-based Fontification").
          `(("\\<new\\>"
             (c-font-lock-c++-new))))
      ))

(defun c-font-lock-labels (limit)
  ;; Fontify all statement labels from the point to LIMIT.  Assumes
  ;; that strings and comments have been fontified already.  Nil is
  ;; always returned.
  ;;
  ;; Note: This function is only used on decoration level 2; this is
  ;; taken care of directly by the gargantuan
  ;; `c-font-lock-declarations' on higher levels.
  ;;
  ;; This function might do hidden buffer changes.

  (let (continue-pos id-start
        ;; The font-lock package in Emacs is known to clobber
        ;; `parse-sexp-lookup-properties' (when it exists).
        (parse-sexp-lookup-properties
         (cc-eval-when-compile
           (boundp 'parse-sexp-lookup-properties))))

    (while (re-search-forward ":[^:]" limit t)
      (setq continue-pos (point))
      (goto-char (match-beginning 0))
      (unless (c-skip-comments-and-strings limit)

        (c-backward-syntactic-ws)
        (and (setq id-start (c-on-identifier))

             (not (get-text-property id-start 'face))

             (progn
               (goto-char id-start)
               (c-backward-syntactic-ws)
               (or
                ;; Check for a char that precedes a statement.
                (memq (char-before) '(?\} ?\{ ?\;))
                ;; Check for a preceding label.  We exploit the font
                ;; locking made earlier by this function.
                (and (eq (char-before) ?:)
                     (progn
                       (backward-char)
                       (c-backward-syntactic-ws)
                       (not (bobp)))
                     (eq (get-text-property (1- (point)) 'face)
                         c-label-face-name))
                ;; Check for a keyword that precedes a statement.
                (c-after-conditional)))

             (progn
               ;; Got a label.
               (goto-char id-start)
               (looking-at c-symbol-key)
               (c-put-font-lock-face (match-beginning 0) (match-end 0)
                                     c-label-face-name)))

        (goto-char continue-pos))))
  nil)

(c-lang-defconst c-basic-matchers-after
  "Font lock matchers for various things that should be fontified after
generic casts and declarations are fontified.  Used on level 2 and
higher."

  t `(,@(when (c-lang-const c-brace-id-list-kwds)
      ;; Fontify the remaining identifiers inside an enum list when we start
      ;; inside it.
          `(c-font-lock-enum-tail
      ;; Fontify the identifiers inside enum lists.  (The enum type
      ;; name is handled by `c-simple-decl-matchers' or
      ;; `c-complex-decl-matchers' below.
            (,(c-make-font-lock-search-function
               (concat
                "\\<\\("
                (c-make-keywords-re nil (c-lang-const c-brace-id-list-kwds))
                "\\)\\>"
                ;; Disallow various common punctuation chars that can't come
                ;; before the '{' of the enum list, to avoid searching too far.
                "[^][{};/#=]*"
                "{")
               '((c-font-lock-declarators limit t nil t)
                 (save-match-data
                   (goto-char (match-end 0))
                   (c-put-char-property (1- (point)) 'c-type
                                        'c-decl-id-start)
                   (c-forward-syntactic-ws))
                 (goto-char (match-end 0)))))))

        ;; Fontify labels after goto etc.
        ,@(when (c-lang-const c-before-label-kwds)
          `(;; (Got three different interpretation levels here,
            ;; which makes it a bit complicated: 1) The backquote
            ;; stuff is expanded when compiled or loaded, 2) the
            ;; eval form is evaluated at font-lock setup (to
            ;; substitute c-label-face-name correctly), and 3) the
            ;; resulting structure is interpreted during
            ;; fontification.)
            (eval
             . ,(let* ((c-before-label-re
                        (c-make-keywords-re nil
                          (c-lang-const c-before-label-kwds))))
                  `(list
                    ,(concat "\\<\\(" c-before-label-re "\\)\\>"
                             "\\s *"
                             "\\("      ; identifier-offset
                             (c-lang-const c-symbol-key)
                             "\\)")
                    (list ,(+ (regexp-opt-depth c-before-label-re) 2)
                          c-label-face-name nil t))))))

      ;; Fontify the clauses after various keywords.
        ,@(when (or (c-lang-const c-type-list-kwds)
                    (c-lang-const c-ref-list-kwds)
                    (c-lang-const c-colon-type-list-kwds))
            `((,(c-make-font-lock-BO-decl-search-function
                 (concat "\\<\\("
                         (c-make-keywords-re nil
                           (append (c-lang-const c-type-list-kwds)
                                   (c-lang-const c-ref-list-kwds)
                                   (c-lang-const c-colon-type-list-kwds)))
                         "\\)\\>")
                 '((c-fontify-types-and-refs ((c-promote-possible-types t))
                     (c-forward-keyword-clause 1)
                     (if (> (point) limit) (goto-char limit))))))))

        ,@(when (c-lang-const c-paren-type-kwds)
            `((,(c-make-font-lock-search-function
                 (concat "\\<\\("
                         (c-make-keywords-re nil
                           (c-lang-const c-paren-type-kwds))
                         "\\)\\>")
                 '((c-fontify-types-and-refs ((c-promote-possible-types t))
                     (c-forward-keyword-clause 1)
                     (if (> (point) limit) (goto-char limit))))))))

        ,@(when (c-major-mode-is 'java-mode)
            `((eval . (list "\\<\\(@[a-zA-Z0-9]+\\)\\>" 1 c-annotation-face))))
      ))

(c-lang-defconst c-matchers-1
  t (c-lang-const c-cpp-matchers))

(c-lang-defconst c-matchers-2
  t (append (c-lang-const c-matchers-1)
            (c-lang-const c-basic-matchers-before)
            (c-lang-const c-simple-decl-matchers)
            (c-lang-const c-basic-matchers-after)))

(c-lang-defconst c-matchers-3
  t (append (c-lang-const c-matchers-1)
            (c-lang-const c-basic-matchers-before)
            (c-lang-const c-complex-decl-matchers)
            (c-lang-const c-basic-matchers-after)))

(defun c-compose-keywords-list (base-list)
  ;; Incorporate the font lock keyword lists according to
  ;; `c-doc-comment-style' on the given keyword list and return it.
  ;; This is used in the function bindings of the
  ;; `*-font-lock-keywords-*' symbols since we have to build the list
  ;; when font-lock is initialized.

  (unless (memq c-doc-face-name c-literal-faces)
    (setq c-literal-faces (cons c-doc-face-name c-literal-faces)))

  (let* ((doc-keywords
          (if (consp (car-safe c-doc-comment-style))
              (cdr-safe (or (assq c-buffer-is-cc-mode c-doc-comment-style)
                            (assq 'other c-doc-comment-style)))
            c-doc-comment-style))
         (list (nconc (c--mapcan
                       (lambda (doc-style)
                         (let ((sym (intern
                                     (concat (symbol-name doc-style)
                                             "-font-lock-keywords"))))
                           (cond ((fboundp sym)
                                  (funcall sym))
                                 ((boundp sym)
                                  (append (eval sym) nil)))))
                       (if (listp doc-keywords)
                           doc-keywords
                         (list doc-keywords)))
                      base-list)))

    ;; Kludge: If `c-font-lock-complex-decl-prepare' is on the list we
    ;; move it first since the doc comment font lockers might add
    ;; `c-type' text properties, so they have to be cleared before that.
    (when (memq 'c-font-lock-complex-decl-prepare list)
      (setq list (cons 'c-font-lock-complex-decl-prepare
                       (delq 'c-font-lock-complex-decl-prepare
                             (append list nil)))))

    list))

(defun c-override-default-keywords (def-var)
  ;; This is used to override the value on a `*-font-lock-keywords'
  ;; variable only if it's nil or has the same value as one of the
  ;; `*-font-lock-keywords-*' variables.  Older font-lock packages
  ;; define a default value for `*-font-lock-keywords' which we want
  ;; to override, but we should otoh avoid clobbering a user setting.
  ;; This heuristic for that isn't perfect, but I can't think of any
  ;; better. /mast
  (when (and (boundp def-var)
             (memq (symbol-value def-var)
                   (cons nil
                         (mapcar
                          (lambda (suffix)
                            (let ((sym (intern (concat (symbol-name def-var)
                                                       suffix))))
                              (and (boundp sym) (symbol-value sym))))
                          '("-1" "-2" "-3")))))
    ;; The overriding is done by unbinding the variable so that the normal
    ;; defvar will install its default value later on.
    (makunbound def-var)))

\f
;;; C.

(c-override-default-keywords 'c-font-lock-keywords)

(defconst c-font-lock-keywords-1 (c-lang-const c-matchers-1 c)
  "Minimal font locking for C mode.
Fontifies only preprocessor directives (in addition to the syntactic
fontification of strings and comments).")

(defconst c-font-lock-keywords-2 (c-lang-const c-matchers-2 c)
  "Fast normal font locking for C mode.
In addition to `c-font-lock-keywords-1', this adds fontification of
keywords, simple types, declarations that are easy to recognize, the
user defined types on `c-font-lock-extra-types', and the doc comment
styles specified by `c-doc-comment-style'.")

(defconst c-font-lock-keywords-3 (c-lang-const c-matchers-3 c)
  "Accurate normal font locking for C mode.
Like the variable `c-font-lock-keywords-2' but detects declarations in a more
accurate way that works in most cases for arbitrary types without the
need for `c-font-lock-extra-types'.")

(defvar c-font-lock-keywords c-font-lock-keywords-3
  "Default expressions to highlight in C mode.")

(defun c-font-lock-keywords-2 ()
  (c-compose-keywords-list c-font-lock-keywords-2))
(defun c-font-lock-keywords-3 ()
  (c-compose-keywords-list c-font-lock-keywords-3))
(defun c-font-lock-keywords ()
  (c-compose-keywords-list c-font-lock-keywords))

\f
;;; C++.

(defun c-font-lock-c++-new (limit)
  ;; FIXME!!!  Put in a comment about the context of this function's
  ;; invocation.  I think it's called as an ANCHORED-MATCHER within an
  ;; ANCHORED-HIGHLIGHTER.  (2007/2/10).
  ;;
  ;; Assuming point is after a "new" word, check that it isn't inside
  ;; a string or comment, and if so try to fontify the type in the
  ;; allocation expression.  Nil is always returned.
  ;;
  ;; As usual, C++ takes the prize in coming up with a hard to parse
  ;; syntax. :P
  ;;
  ;; This function might do hidden buffer changes.

  (unless (c-skip-comments-and-strings limit)
    (save-excursion
      (catch 'false-alarm
        ;; A "new" keyword is followed by one to three expressions, where
        ;; the type is the middle one, and the only required part.
        (let (expr1-pos expr2-pos
              ;; Enable recording of identifier ranges in `c-forward-type'
              ;; etc for later fontification.  Not using
              ;; `c-fontify-types-and-refs' here since the ranges should
              ;; be fontified selectively only when an allocation
              ;; expression is successfully recognized.
              (c-record-type-identifiers t)
              c-record-ref-identifiers
              ;; The font-lock package in Emacs is known to clobber
              ;; `parse-sexp-lookup-properties' (when it exists).
              (parse-sexp-lookup-properties
               (cc-eval-when-compile
                 (boundp 'parse-sexp-lookup-properties))))
          (c-forward-syntactic-ws)

          ;; The first placement arglist is always parenthesized, if it
          ;; exists.
          (when (eq (char-after) ?\()
            (setq expr1-pos (1+ (point)))
            (condition-case nil
                (c-forward-sexp)
              (scan-error (throw 'false-alarm t)))
            (c-forward-syntactic-ws))

          ;; The second expression is either a type followed by some "*" or
          ;; "[...]" or similar, or a parenthesized type followed by a full
          ;; identifierless declarator.
          (setq expr2-pos (1+ (point)))
          (cond ((eq (char-after) ?\())
                ((let ((c-promote-possible-types t))
                   (c-forward-type)))
                (t (setq expr2-pos nil)))

          (when expr1-pos
            (cond
             ((not expr2-pos)
              ;; No second expression, so the first has to be a
              ;; parenthesized type.
              (goto-char expr1-pos)
              (let ((c-promote-possible-types t))
                (c-forward-type)))

             ((eq (char-before expr2-pos) ?\()
              ;; Got two parenthesized expressions, so we have to look
              ;; closer at them to decide which is the type.  No need to
              ;; handle `c-record-ref-identifiers' since all references
              ;; have already been handled by other fontification rules.
              (let (expr1-res expr2-res)

                (goto-char expr1-pos)
                (when (setq expr1-res (c-forward-type))
                  (unless (looking-at
                           (cc-eval-when-compile
                             (concat (c-lang-const c-symbol-start c++)
                                     "\\|[*:)[]")))
                    ;; There's something after the would-be type that
                    ;; can't be there, so this is a placement arglist.
                    (setq expr1-res nil)))

                (goto-char expr2-pos)
                (when (setq expr2-res (c-forward-type))
                  (unless (looking-at
                           (cc-eval-when-compile
                             (concat (c-lang-const c-symbol-start c++)
                                     "\\|[*:)[]")))
                    ;; There's something after the would-be type that can't
                    ;; be there, so this is an initialization expression.
                    (setq expr2-res nil))
                  (when (and (c-go-up-list-forward)
                             (progn (c-forward-syntactic-ws)
                                    (eq (char-after) ?\()))
                    ;; If there's a third initialization expression
                    ;; then the second one is the type, so demote the
                    ;; first match.
                    (setq expr1-res nil)))

                ;; We fontify the most likely type, with a preference for
                ;; the first argument since a placement arglist is more
                ;; unusual than an initializer.
                (cond ((memq expr1-res '(t known prefix)))
                      ((memq expr2-res '(t known prefix)))
                      ;; Presumably 'decltype's will be fontified elsewhere.
                      ((eq expr1-res 'decltype))
                      ((eq expr2-res 'decltype))
                      ((eq expr1-res 'found)
                       (let ((c-promote-possible-types t))
                         (goto-char expr1-pos)
                         (c-forward-type)))
                      ((eq expr2-res 'found)
                       (let ((c-promote-possible-types t))
                         (goto-char expr2-pos)
                         (c-forward-type)))
                      ((and (eq expr1-res 'maybe) (not expr2-res))
                       (let ((c-promote-possible-types t))
                         (goto-char expr1-pos)
                         (c-forward-type)))
                      ((and (not expr1-res) (eq expr2-res 'maybe))
                       (let ((c-promote-possible-types t))
                         (goto-char expr2-pos)
                         (c-forward-type)))
                      ;; If both type matches are 'maybe then we're
                      ;; too uncertain to promote either of them.
                      )))))

          ;; Fontify the type that now is recorded in
          ;; `c-record-type-identifiers', if any.
          (c-fontify-recorded-types-and-refs)))))
  nil)

(c-override-default-keywords 'c++-font-lock-keywords)

(defconst c++-font-lock-keywords-1 (c-lang-const c-matchers-1 c++)
  "Minimal font locking for C++ mode.
Fontifies only preprocessor directives (in addition to the syntactic
fontification of strings and comments).")

(defconst c++-font-lock-keywords-2 (c-lang-const c-matchers-2 c++)
  "Fast normal font locking for C++ mode.
In addition to `c++-font-lock-keywords-1', this adds fontification of
keywords, simple types, declarations that are easy to recognize, the
user defined types on `c++-font-lock-extra-types', and the doc comment
styles specified by `c-doc-comment-style'.")

(defconst c++-font-lock-keywords-3 (c-lang-const c-matchers-3 c++)
  "Accurate normal font locking for C++ mode.
Like the variable `c++-font-lock-keywords-2' but detects declarations in a more
accurate way that works in most cases for arbitrary types without the
need for `c++-font-lock-extra-types'.")

(defvar c++-font-lock-keywords c++-font-lock-keywords-3
  "Default expressions to highlight in C++ mode.")

(defun c++-font-lock-keywords-2 ()
  (c-compose-keywords-list c++-font-lock-keywords-2))
(defun c++-font-lock-keywords-3 ()
  (c-compose-keywords-list c++-font-lock-keywords-3))
(defun c++-font-lock-keywords ()
  (c-compose-keywords-list c++-font-lock-keywords))

\f
;;; Objective-C.

(defun c-font-lock-objc-method ()
  ;; Assuming the point is after the + or - that starts an Objective-C
  ;; method declaration, fontify it.  This must be done before normal
  ;; casts, declarations and labels are fontified since they will get
  ;; false matches in these things.
  ;;
  ;; This function might do hidden buffer changes.

  (c-fontify-types-and-refs
      ((first t)
       (c-promote-possible-types t))

    (while (and
            (progn
              (c-forward-syntactic-ws)

              ;; An optional method type.
              (if (eq (char-after) ?\()
                  (progn
                    (forward-char)
                    (c-forward-syntactic-ws)
                    (c-forward-type)
                    (prog1 (c-go-up-list-forward)
                      (c-forward-syntactic-ws)))
                t))

            ;; The name.  The first time it's the first part of
            ;; the function name, the rest of the time it's an
            ;; argument name.
            (looking-at c-symbol-key)
            (progn
              (goto-char (match-end 0))
              (c-put-font-lock-face (match-beginning 0)
                                    (point)
                                    (if first
                                        'font-lock-function-name-face
                                      'font-lock-variable-name-face))
              (c-forward-syntactic-ws)

              ;; Another optional part of the function name.
              (when (looking-at c-symbol-key)
                (goto-char (match-end 0))
                (c-put-font-lock-face (match-beginning 0)
                                      (point)
                                      'font-lock-function-name-face)
                (c-forward-syntactic-ws))

              ;; There's another argument if a colon follows.
              (eq (char-after) ?:)))
      (forward-char)
      (setq first nil))))

(defun c-font-lock-objc-methods (limit)
  ;; Fontify method declarations in Objective-C.  Nil is always
  ;; returned.
  ;;
  ;; This function might do hidden buffer changes.

  (let (;; The font-lock package in Emacs is known to clobber
        ;; `parse-sexp-lookup-properties' (when it exists).
        (parse-sexp-lookup-properties
         (cc-eval-when-compile
           (boundp 'parse-sexp-lookup-properties))))

    (c-find-decl-spots
     limit
     "[-+]"
     nil
     (lambda (match-pos inside-macro &optional top-level)
       (forward-char)
       (c-font-lock-objc-method))))
  nil)

(c-override-default-keywords 'objc-font-lock-keywords)

(defconst objc-font-lock-keywords-1 (c-lang-const c-matchers-1 objc)
  "Minimal font locking for Objective-C mode.
Fontifies only compiler directives (in addition to the syntactic
fontification of strings and comments).")

(defconst objc-font-lock-keywords-2 (c-lang-const c-matchers-2 objc)
  "Fast normal font locking for Objective-C mode.
In addition to `objc-font-lock-keywords-1', this adds fontification of
keywords, simple types, declarations that are easy to recognize, the
user defined types on `objc-font-lock-extra-types', and the doc
comment styles specified by `c-doc-comment-style'.")

(defconst objc-font-lock-keywords-3 (c-lang-const c-matchers-3 objc)
  "Accurate normal font locking for Objective-C mode.
Like the variable `objc-font-lock-keywords-2' but detects declarations in a more
accurate way that works in most cases for arbitrary types without the
need for `objc-font-lock-extra-types'.")

(defvar objc-font-lock-keywords objc-font-lock-keywords-3
  "Default expressions to highlight in Objective-C mode.")

(defun objc-font-lock-keywords-2 ()
  (c-compose-keywords-list objc-font-lock-keywords-2))
(defun objc-font-lock-keywords-3 ()
  (c-compose-keywords-list objc-font-lock-keywords-3))
(defun objc-font-lock-keywords ()
  (c-compose-keywords-list objc-font-lock-keywords))

;; Kludge to override the default value that
;; `objc-font-lock-extra-types' might have gotten from the font-lock
;; package.  The value replaced here isn't relevant now anyway since
;; those types are builtin and therefore listed directly in
;; `c-primitive-type-kwds'.
(when (equal (sort (append objc-font-lock-extra-types nil) 'string-lessp)
             '("BOOL" "Class" "IMP" "SEL"))
  (setq objc-font-lock-extra-types
        (cc-eval-when-compile (list (concat "[" c-upper "]\\sw*")))))

\f
;;; Java.

(c-override-default-keywords 'java-font-lock-keywords)

(defconst java-font-lock-keywords-1 (c-lang-const c-matchers-1 java)
  "Minimal font locking for Java mode.
Fontifies nothing except the syntactic fontification of strings and
comments.")

(defconst java-font-lock-keywords-2 (c-lang-const c-matchers-2 java)
  "Fast normal font locking for Java mode.
In addition to `java-font-lock-keywords-1', this adds fontification of
keywords, simple types, declarations that are easy to recognize, the
user defined types on `java-font-lock-extra-types', and the doc
comment styles specified by `c-doc-comment-style'.")

(defconst java-font-lock-keywords-3 (c-lang-const c-matchers-3 java)
  "Accurate normal font locking for Java mode.
Like variable `java-font-lock-keywords-2' but detects declarations in a more
accurate way that works in most cases for arbitrary types without the
need for `java-font-lock-extra-types'.")

(defvar java-font-lock-keywords java-font-lock-keywords-3
  "Default expressions to highlight in Java mode.")

(defun java-font-lock-keywords-2 ()
  (c-compose-keywords-list java-font-lock-keywords-2))
(defun java-font-lock-keywords-3 ()
  (c-compose-keywords-list java-font-lock-keywords-3))
(defun java-font-lock-keywords ()
  (c-compose-keywords-list java-font-lock-keywords))

\f
;;; CORBA IDL.

(c-override-default-keywords 'idl-font-lock-keywords)

(defconst idl-font-lock-keywords-1 (c-lang-const c-matchers-1 idl)
  "Minimal font locking for CORBA IDL mode.
Fontifies nothing except the syntactic fontification of strings and
comments.")

(defconst idl-font-lock-keywords-2 (c-lang-const c-matchers-2 idl)
  "Fast normal font locking for CORBA IDL mode.
In addition to `idl-font-lock-keywords-1', this adds fontification of
keywords, simple types, declarations that are easy to recognize, the
user defined types on `idl-font-lock-extra-types', and the doc comment
styles specified by `c-doc-comment-style'.")

(defconst idl-font-lock-keywords-3 (c-lang-const c-matchers-3 idl)
  "Accurate normal font locking for CORBA IDL mode.
Like the variable `idl-font-lock-keywords-2' but detects declarations in a more
accurate way that works in most cases for arbitrary types without the
need for `idl-font-lock-extra-types'.")

(defvar idl-font-lock-keywords idl-font-lock-keywords-3
  "Default expressions to highlight in CORBA IDL mode.")

(defun idl-font-lock-keywords-2 ()
  (c-compose-keywords-list idl-font-lock-keywords-2))
(defun idl-font-lock-keywords-3 ()
  (c-compose-keywords-list idl-font-lock-keywords-3))
(defun idl-font-lock-keywords ()
  (c-compose-keywords-list idl-font-lock-keywords))

\f
;;; Pike.

(c-override-default-keywords 'pike-font-lock-keywords)

(defconst pike-font-lock-keywords-1 (c-lang-const c-matchers-1 pike)
  "Minimal font locking for Pike mode.
Fontifies only preprocessor directives (in addition to the syntactic
fontification of strings and comments).")

(defconst pike-font-lock-keywords-2 (c-lang-const c-matchers-2 pike)
  "Fast normal font locking for Pike mode.
In addition to `pike-font-lock-keywords-1', this adds fontification of
keywords, simple types, declarations that are easy to recognize, the
user defined types on `pike-font-lock-extra-types', and the doc
comment styles specified by `c-doc-comment-style'.")

(defconst pike-font-lock-keywords-3 (c-lang-const c-matchers-3 pike)
  "Accurate normal font locking for Pike mode.
Like the variable `pike-font-lock-keywords-2' but detects declarations in a more
accurate way that works in most cases for arbitrary types without the
need for `pike-font-lock-extra-types'.")

(defvar pike-font-lock-keywords pike-font-lock-keywords-3
  "Default expressions to highlight in Pike mode.")

(defun pike-font-lock-keywords-2 ()
  (c-compose-keywords-list pike-font-lock-keywords-2))
(defun pike-font-lock-keywords-3 ()
  (c-compose-keywords-list pike-font-lock-keywords-3))
(defun pike-font-lock-keywords ()
  (c-compose-keywords-list pike-font-lock-keywords))

\f
;;; Doc comments.

(defun c-font-lock-doc-comments (prefix limit keywords)
  ;; Fontify the comments between the point and LIMIT whose start
  ;; matches PREFIX with `c-doc-face-name'.  Assumes comments have been
  ;; fontified with `font-lock-comment-face' already.  nil is always
  ;; returned.
  ;;
  ;; After the fontification of a matching comment, fontification
  ;; according to KEYWORDS is applied inside it.  It's a list like
  ;; `font-lock-keywords' except that anchored matches and eval
  ;; clauses aren't supported and that some abbreviated forms can't be
  ;; used.  The buffer is narrowed to the comment while KEYWORDS is
  ;; applied; leading comment starters are included but trailing
  ;; comment enders for block comment are not.
  ;;
  ;; Note that faces added through KEYWORDS should never replace the
  ;; existing `c-doc-face-name' face since the existence of that face
  ;; is used as a flag in other code to skip comments.
  ;;
  ;; This function might do hidden buffer changes.

  (let (comment-beg region-beg)
    (if (eq (get-text-property (point) 'face)
            'font-lock-comment-face)
        ;; Handle the case when the fontified region starts inside a
        ;; comment.
        (let ((start (c-literal-start)))
          (setq region-beg (point))
          (when start
            (goto-char start))
          (when (looking-at prefix)
            (setq comment-beg (point)))))

    (while (or
            comment-beg

            ;; Search for the prefix until a match is found at the start
            ;; of a comment.
            (while (when (re-search-forward prefix limit t)
                     (setq comment-beg (match-beginning 0))
                     (or (not (c-got-face-at comment-beg
                                             c-literal-faces))
                         (and (/= comment-beg (point-min))
                              (c-got-face-at (1- comment-beg)
                                             c-literal-faces))))
              (setq comment-beg nil))
            (setq region-beg comment-beg))

      (if (elt (parse-partial-sexp comment-beg (+ comment-beg 2)) 7)
          ;; Collect a sequence of doc style line comments.
          (progn
            (goto-char comment-beg)
            (while (and (progn
                          (c-forward-single-comment)
                          (skip-syntax-forward " ")
                          (< (point) limit))
                        (looking-at prefix))))
        (goto-char comment-beg)
        (c-forward-single-comment))
      (if (> (point) limit) (goto-char limit))
      (setq comment-beg nil)

      (let ((region-end (point))
            (keylist keywords) keyword matcher highlights)
        (c-put-font-lock-face region-beg region-end c-doc-face-name)
        (save-restriction
          ;; Narrow to the doc comment.  Among other things, this
          ;; helps by making "^" match at the start of the comment.
          ;; Do not include a trailing block comment ender, though.
          (and (> region-end (1+ region-beg))
               (progn (goto-char region-end)
                      (backward-char 2)
                      (looking-at "\\*/"))
               (setq region-end (point)))
          (narrow-to-region region-beg region-end)

          (while keylist
            (setq keyword (car keylist)
                  keylist (cdr keylist)
                  matcher (car keyword))
            (goto-char region-beg)
            (while (if (stringp matcher)
                       (re-search-forward matcher region-end t)
                     (funcall matcher region-end))
              (setq highlights (cdr keyword))
              (if (consp (car highlights))
                  (while highlights
                    (font-lock-apply-highlight (car highlights))
                    (setq highlights (cdr highlights)))
                (font-lock-apply-highlight highlights))))

          (goto-char region-end)))))
  nil)
(put 'c-font-lock-doc-comments 'lisp-indent-function 2)

(defun c-find-invalid-doc-markup (regexp limit)
  ;; Used to fontify invalid markup in doc comments after the correct
  ;; ones have been fontified: Find the first occurrence of REGEXP
  ;; between the point and LIMIT that only is fontified with
  ;; `c-doc-face-name'.  If a match is found then submatch 0 surrounds
  ;; the first char and t is returned, otherwise nil is returned.
  ;;
  ;; This function might do hidden buffer changes.
  (let (start)
    (while (if (re-search-forward regexp limit t)
               (not (eq (get-text-property
                         (setq start (match-beginning 0)) 'face)
                        c-doc-face-name))
             (setq start nil)))
    (when start
      (store-match-data (list (copy-marker start)
                              (copy-marker (1+ start))))
      t)))

;; GtkDoc patterns contributed by Masatake YAMATO <jet@gyve.org>.

(defconst gtkdoc-font-lock-doc-comments
  (let ((symbol "[a-zA-Z0-9_]+")
        (header "^ \\* "))
    `((,(concat header "\\("     symbol "\\):[ \t]*$")
       1 ,c-doc-markup-face-name prepend nil)
      (,(concat                  symbol     "()")
       0 ,c-doc-markup-face-name prepend nil)
      (,(concat header "\\(" "@" symbol "\\):")
       1 ,c-doc-markup-face-name prepend nil)
      (,(concat "[#%@]" symbol)
       0 ,c-doc-markup-face-name prepend nil))
    ))

(defconst gtkdoc-font-lock-doc-protection
  `(("< \\(public\\|private\\|protected\\) >"
     1 ,c-doc-markup-face-name prepend nil)))

(defconst gtkdoc-font-lock-keywords
  `((,(lambda (limit)
        (c-font-lock-doc-comments "/\\*\\*$" limit
          gtkdoc-font-lock-doc-comments)
        (c-font-lock-doc-comments "/\\*< " limit
          gtkdoc-font-lock-doc-protection)
        ))))

;; Javadoc.

(defconst javadoc-font-lock-doc-comments
  `(("{@[a-z]+[^}\n\r]*}"               ; "{@foo ...}" markup.
     0 ,c-doc-markup-face-name prepend nil)
    ("^\\(/\\*\\)?\\(\\s \\|\\*\\)*\\(@[a-z]+\\)" ; "@foo ..." markup.
     3 ,c-doc-markup-face-name prepend nil)
    (,(concat "</?\\sw"                 ; HTML tags.
              "\\("
              (concat "\\sw\\|\\s \\|[=\n\r*.:]\\|"
                      "\"[^\"]*\"\\|'[^']*'")
              "\\)*>")
     0 ,c-doc-markup-face-name prepend nil)
    ("&\\(\\sw\\|[.:]\\)+;"             ; HTML entities.
     0 ,c-doc-markup-face-name prepend nil)
    ;; Fontify remaining markup characters as invalid.  Note
    ;; that the Javadoc spec is hazy about when "@" is
    ;; allowed in non-markup use.
    (,(lambda (limit)
        (c-find-invalid-doc-markup "[<>&]\\|{@" limit))
     0 'font-lock-warning-face prepend nil)))

(defconst javadoc-font-lock-keywords
  `((,(lambda (limit)
        (c-font-lock-doc-comments "/\\*\\*" limit
          javadoc-font-lock-doc-comments)))))

;; Pike autodoc.

(defconst autodoc-decl-keywords
  ;; Adorned regexp matching the keywords that introduce declarations
  ;; in Pike Autodoc.
  (cc-eval-when-compile
    (c-make-keywords-re t '("@decl" "@elem" "@index" "@member") 'pike-mode)))

(defconst autodoc-decl-type-keywords
  ;; Adorned regexp matching the keywords that are followed by a type.
  (cc-eval-when-compile
    (c-make-keywords-re t '("@elem" "@member") 'pike-mode)))

(defun autodoc-font-lock-line-markup (limit)
  ;; Fontify all line oriented keywords between the point and LIMIT.
  ;; Nil is always returned.
  ;;
  ;; This function might do hidden buffer changes.

  (let ((line-re (concat "^\\(\\(/\\*!\\|\\s *\\("
                         c-current-comment-prefix
                         "\\)\\)\\s *\\)@[A-Za-z_-]+\\(\\s \\|$\\)"))
        (markup-faces (list c-doc-markup-face-name c-doc-face-name)))

    (while (re-search-forward line-re limit t)
      (goto-char (match-end 1))

      (if (looking-at autodoc-decl-keywords)
          (let* ((kwd-pos (point))
                 (start (match-end 1))
                 (pos start)
                 end)

            (c-put-font-lock-face (point) pos markup-faces)

            ;; Put a declaration end mark at the markup keyword and
            ;; remove the faces from the rest of the line so that it
            ;; gets refontified as a declaration later on by
            ;; `c-font-lock-declarations'.
            (c-put-char-property (1- pos) 'c-type 'c-decl-end)
            (goto-char pos)
            (while (progn
                     (end-of-line)
                     (setq end (point))
                     (and (eq (char-before) ?@)
                          (not (eobp))
                          (progn (forward-char)
                                 (skip-syntax-forward " ")
                                 (looking-at c-current-comment-prefix))))
              (goto-char (match-end 0))
              (c-remove-font-lock-face pos (1- end))
              (c-put-font-lock-face (1- end) end markup-faces)
              (setq pos (point)))

            ;; Include the final newline in the removed area.  This
            ;; has no visual effect but it avoids some tricky special
            ;; cases in the testsuite wrt the differences in string
            ;; fontification in Emacs vs XEmacs.
            (c-remove-font-lock-face pos (min (1+ (point)) (point-max)))

            ;; Must handle string literals explicitly inside the declaration.
            (goto-char start)
            (while (re-search-forward
                    "\"\\([^\\\"]\\|\\\\.\\)*\"\\|'\\([^\\']\\|\\\\.\\)*'"
                    end 'move)
              (c-put-font-lock-string-face (match-beginning 0)
                                           (point)))

            ;; Fontify types after keywords that always are followed
            ;; by them.
            (goto-char kwd-pos)
            (when (looking-at autodoc-decl-type-keywords)
              (c-fontify-types-and-refs ((c-promote-possible-types t))
                (goto-char start)
                (c-forward-syntactic-ws)
                (c-forward-type))))

        ;; Mark each whole line as markup, as long as the logical line
        ;; continues.
        (while (progn
                 (c-put-font-lock-face (point)
                                       (progn (end-of-line) (point))
                                       markup-faces)
                 (and (eq (char-before) ?@)
                      (not (eobp))
                      (progn (forward-char)
                             (skip-syntax-forward " ")
                             (looking-at c-current-comment-prefix))))
          (goto-char (match-end 0))))))

  nil)

(defconst autodoc-font-lock-doc-comments
  `(("@\\(\\w+{\\|\\[\\([^]@\n\r]\\|@@\\)*\\]\\|[@}]\\|$\\)"
     ;; In-text markup.
     0 ,c-doc-markup-face-name prepend nil)
    (autodoc-font-lock-line-markup)
    ;; Fontify remaining markup characters as invalid.
    (,(lambda (limit)
        (c-find-invalid-doc-markup "@" limit))
     0 'font-lock-warning-face prepend nil)
    ))

(defun autodoc-font-lock-keywords ()
  ;; Note that we depend on that `c-current-comment-prefix' has got
  ;; its proper value here.
  ;;
  ;; This function might do hidden buffer changes.

  ;; The `c-type' text property with `c-decl-end' is used to mark the
  ;; end of the `autodoc-decl-keywords' occurrences to fontify the
  ;; following declarations.
  (setq c-type-decl-end-used t)

  `((,(lambda (limit)
        (c-font-lock-doc-comments "/[*/]!" limit
          autodoc-font-lock-doc-comments)))))

\f
;; 2006-07-10:  awk-font-lock-keywords has been moved back to cc-awk.el.
(cc-provide 'cc-fonts)

;; Local Variables:
;; indent-tabs-mode: t
;; tab-width: 8
;; End:
;;; cc-fonts.el ends here