public
Last active

  • Download Gist
vcl-mode.el
Emacs Lisp
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301
;;; vcl-mode.el - Syntax highlighting for Varnish Command Language
;;;
;;; Copyright (c) 2008-2009 Linpro AS
;;; All rights reserved.
;;;
;;; Author: Stig Sandbeck Mathisen <ssm@linpro.no>
;;;
;;; Redistribution and use in source and binary forms, with or without
;;; modification, are permitted provided that the following conditions
;;; are met:
;;; 1. Redistributions of source code must retain the above copyright
;;; notice, this list of conditions and the following disclaimer.
;;; 2. Redistributions in binary form must reproduce the above
;;; copyright notice, this list of conditions and the following
;;; disclaimer in the documentation and/or other materials provided
;;; with the distribution.
;;;
;;; THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS''
;;; AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
;;; TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
;;; PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR
;;; CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
;;; SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
;;; LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
;;; USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
;;; AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
;;; LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
;;; ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
;;; POSSIBILITY OF SUCH DAMAGE.
;;;
;;; $Id$
;;;
;;; Based on
;;; https://www.varnish-cache.org/trac/browser/fragmentation/varnish-tools/emacs/vcl-mode.el?rev=72322230cfe73244bcf31e008a05a9c2c3867816
;;; Updated to work with varnish 3 a bit better; highlight more of the
;;; variable names and functions
 
(defgroup vcl nil
"Customizations for vcl-mode")
 
(defcustom vcl-indent-level 8
"*The level of indentation (number of space characters) in VCL-mode."
:type 'integer :group 'vcl)
 
(defcustom vcl-indent-tabs-mode nil
"*Allow tabs when indentation in vcl-mode if non-nil"
:type 'boolean :group 'vcl)
 
;; I just love standards, there are so many to choose from
(if (string-match "XEmacs\\|Lucid" emacs-version)
(require 'generic-mode)
(require 'generic))
 
;; Add a VCL major mode called "vcl-mode", based on generic-mode
 
(define-generic-mode 'vcl-mode
;; comments (defined in "vcl-mode-setup-function"
nil
;; keywords (defined under "others" instead)
nil
;; others
(list
;; Logic
(generic-make-keywords-list
(list
"else"
"elsif"
"if"
"remove"
)
'font-lock-keyword-face)
;; Types
(generic-make-keywords-list
(list
"set"
"unset"
"ban_url"
"ban"
"regsub"
"regsuball"
"hash_data"
"return"
"call"
"import"
)
'font-lock-builtin-face)
;; VCL Functions
(generic-make-keywords-list
(list
"acl"
"backend"
"sub"
"vcl_deliver"
"vcl_discard"
"vcl_fetch"
"vcl_hash"
"vcl_hit"
"vcl_miss"
"vcl_pass"
"vcl_pipe"
"vcl_recv"
"vcl_timeout"
)
'font-lock-function-name-face)
;; Actions
(generic-make-keywords-list
(list
"deliver"
"discard"
"error"
"fetch"
"hash"
"keep"
"lookup"
"pass"
"pipe"
"hit_for_pass"
)
'font-lock-function-name-face)
 
;; Variables
(generic-make-keywords-list
(list
"now"
".host"
".port"
 
"client.ip"
"client.identity"
"server.ip"
"server.port"
"server.hostname"
"server.identity"
 
"req.request"
"req.url"
"req.proto"
"req.backend"
"req.backend.healthy"
"req.hash_always_miss"
"req.hash_ignore_busy"
"req.can_gzip"
"req.restarts"
"req.esi"
"req.esi_level"
"req.grace"
"req.xid"
 
 
"bereq.request"
"bereq.url"
"bereq.proto"
"bereq.connect_timeout"
"bereq.first_byte_timeout"
"bereq.between_bytes_timeout"
 
"beresp.do_stream"
"beresp.do_esi"
"beresp.do_gzip"
"beresp.do_gunzip"
"beresp.proto"
"beresp.status"
"beresp.response"
"beresp.ttl"
"beresp.grace"
"beresp.saintmode"
"beresp.backend.name"
"beresp.backend.ip"
"beresp.backend.port"
"beresp.storage"
 
 
"obj.proto"
"obj.status"
"obj.response"
"obj.ttl"
"obj.lastuse"
"obj.hits"
"obj.grace"
"obj.http.header"
 
 
"req.hash"
"resp.proto"
"resp.status"
"resp.response"
"resp.http.header"
)
'font-lock-variable-name-face)
 
;; More variables
'("\\(\\(be\\)?\\(req\\|resp\\|obj\\)\\)\.http\.[A-Za-z-]+" .
font-lock-variable-name-face))
;; Filenames to highlight
'("\\.vcl\\'")
(list 'vcl-mode-setup-function)
"Mode for Varnish Command Language")
 
 
;; A function to modify syntax, add a hook if needed, and setup
;; indentation.
 
(defun vcl-mode-setup-function ()
;; These are "part of words"
(modify-syntax-entry ?_ "w")
(modify-syntax-entry ?. "w")
 
;; C++-style comments
(modify-syntax-entry ?/ ". 124")
(modify-syntax-entry ?* ". 23b")
 
;; Perl-style comments
(modify-syntax-entry ?# "<")
(modify-syntax-entry ?\n ">")
(run-hooks 'vcl-mode-hook)
(set (make-local-variable 'indent-line-function) 'vcl-indent-line)
(setq indent-tabs-mode vcl-indent-tabs-mode)
)
 
(defvar vcl-mode-hook nil)
 
(defun vcl-indent-line ()
"Indent the current VCL line according to syntax."
(interactive)
(indent-line-to
(max (vcl-calculate-indentation) 0)))
 
;; The function to calculate indentation level. This is a really
;; simple and naive function, and does not perform anything like a
;; syntax check.
(defun vcl-calculate-indentation ()
"Return the column to which the current line should be indented."
(interactive)
(save-excursion
; Do not indent the first line.
(if (vcl-first-line-p) 0
; Reduce indent level if we
; close a block on this line
(if (vcl-closing-tag-on-this-line-p)
(- (vcl-previous-line-indentation)
vcl-indent-level)
; Increase indent level if a
; block opened on the previous
; line
(if (vcl-opening-tag-on-previous-line-p)
(+ (vcl-previous-line-indentation)
vcl-indent-level)
; By default, indent to the
; level of the previous
; non-empty line
(vcl-previous-line-indentation))))))
 
(defun vcl-opening-tag-on-previous-line-p ()
"Checks if we have an opening tag on the previous line."
(interactive)
(save-excursion
(beginning-of-line)
(skip-chars-backward " \t\n")
(beginning-of-line)
(if (and (looking-at ".*{[ \t]*$")
(not (vcl-comment-p)))
t)))
 
(defun vcl-closing-tag-on-this-line-p ()
"Checks if we have a closing tag on this line."
(interactive)
(save-excursion
(back-to-indentation)
(looking-at "}")))
 
(defun vcl-previous-line-indentation ()
"Return the indent level of the previous line."
(interactive)
(save-excursion
(beginning-of-line)
(skip-chars-backward " \t\n")
(back-to-indentation)
(current-column)))
 
(defun vcl-comment-p ()
"Checks if we have a commented line."
(interactive)
(save-excursion
(beginning-of-line)
(looking-at "^[ \t]*#")))
 
(defun vcl-first-line-p ()
"Checks if we are on the first line."
(interactive)
(save-excursion
(beginning-of-line)
(eq (point) 1)))
 
(provide 'vcl-mode)

Please sign in to comment on this gist.

Something went wrong with that request. Please try again.