spec.vim

   1 " Filename:    spec.vim
   2 " Purpose:     Vim syntax file
   3 " Language:    SPEC: Build/install scripts for Linux RPM packages
   4 " Maintainer:  Donovan Rebbechi elflord@pegasus.rutgers.edu
   5 " URL:         http://pegasus.rutgers.edu/~elflord/vim/syntax/spec.vim
   6 " Last Change: Tue Oct  3 17:35:15 BRST 2000 <aurelio@conectiva.com.br>
   7
   8 " For version 5.x: Clear all syntax items
   9 " For version 6.x: Quit when a syntax file was already loaded
  10 if version < 600
  11   syntax clear
  12 elseif exists("b:current_syntax")
  13   finish
  14 endif
  15
  16 syn sync minlines=1000
  17
  18 syn match specSpecialChar contained '[][!$()\\|>^;:]'
  19 syn match specColon       contained ':'
  20 syn match specPercent     contained '%'
  21 syn match specSubstChar   contained '[#%]'
  22
  23 syn match specVariables   contained '\$\h\w*' contains=specSpecialVariablesNames,specSpecialChar
  24 syn match specVariables   contained '\${\w*}' contains=specSpecialVariablesNames,specSpecialChar
  25 syn match specVariables   contained '\${\w*[#%][^}]*}' contains=specSubstChar
  26
  27 syn match specMacroIdentifier contained '%\h\w*' contains=specMacroNameLocal,specMacroNameOther,specPercent,specSpecialChar
  28 "syn match specMacroIdentifier contained '%{\w*}' contains=specMacroNameLocal,specMacroNameOther,specPercent,specSpecialChar
  29 syn region specMacroIdentifier oneline matchgroup=Special start='%{' skip='\\}' end='}' contains=specMacroNameLocal,specMacroNameOther,specPercent,specSpecialChar
  30 syn match specBcond contained '%{with\(out\)\?\s\+[a-zA-Z0-9_-]\+}'
  31
  32 syn match specSpecialVariables contained '\$[0-9]\|\${[0-9]}'
  33 syn match specCommandOpts      contained '\s\(-\w\+\|--\w[a-zA-Z0-9_-]\+\)'ms=s+1
  34 syn match specComment '^\s*#.*$'
  35
  36
  37 syn case match
  38
  39
  40 " matches with no highlight
  41 syn match specNoNumberHilite 'X11\|X11R6\|[a-zA-Z]*\.\d\|[a-zA-Z][-/]\d'
  42 syn match specManpageFile '[a-zA-Z]\.1'
  43
  44 " Day, Month and most used license acronyms
  45 syn keyword specLicense contained GPL LGPL BSD MIT GNU Apache PHP
  46 syn keyword specLicenseWarning contained unknown
  47 syn match specLicenseWarning contained /same as perl/
  48 syn match specLicenseWarning contained "(enter GPL/LGPL/BSD/BSD-like/Artistic/other license name here)"
  49 syn keyword specWeekday contained Mon Tue Wed Thu Fri Sat Sun
  50 syn keyword specMonth   contained Jan Feb Mar Apr Jun Jul Aug Sep Oct Nov Dec
  51 syn keyword specMonth   contained January February March April May June July August September October November December
  52
  53 " #, @, www
  54 syn match specNumber '\(^-\=\|[ \t]-\=\|-\)[0-9.-]*[0-9]'
  55 syn match specEmail contained "<\=\<[A-Za-z0-9_.-]\+@\([A-Za-z0-9_-]\+\.\)\+[A-Za-z]\+\>>\="
  56 syn match specURL      contained '\<\(\(https\{0,1}\|ftp\)://\|\(www[23]\{0,1}\.\|ftp\.\)\)[A-Za-z0-9._/~:,#?=-]\+\>'
  57 syn match specURLMacro contained '\<\(\(https\{0,1}\|ftp\)://\|\(www[23]\{0,1}\.\|ftp\.\)\)[A-Za-z0-9._/~:,#%{}-]\+\>' contains=specMacroIdentifier
  58
  59 " TODO take specSpecialVariables out of the cluster for the sh* contains (ALLBUT)
  60 " Special system directories
  61 syn match specListedFilesPrefix contained '/\(usr\|local\|opt\|X11R6\|X11\)/'me=e-1
  62 syn match specListedFilesBin    contained '/s\=bin/'me=e-1
  63 syn match specListedFilesLib    contained '/\(lib\|include\)/'me=e-1
  64 syn match specListedFilesDoc    contained '/\(man\d*\|doc\|info\)\>'
  65 syn match specListedFilesEtc    contained '/etc/'me=e-1
  66 syn match specListedFilesShare  contained '/share/'me=e-1
  67 syn cluster specListedFiles contains=specListedFilesBin,specListedFilesLib,specListedFilesDoc,specListedFilesEtc,specListedFilesShare,specListedFilesPrefix,specSpecialChar
  68
  69 " specComands
  70 syn match   specConfigure  contained '\./configure'
  71 syn match   specTarCommand contained '\<tar\s\+[cxvpzjf]\{,5}\s*'
  72
  73 " XXX don't forget to update specScriptArea when updating specMacro
  74 syn match   specMacro contained '%\(group\|user\)\(add\|remove\)'
  75 syn match   specMacro contained '%\(depmod\|banner\|service\|addusertogroup\|env_update\)'
  76 syn match   specMacro contained '%\(\(nsplugin\|apache_config\)_\(un\)\?install\)'
  77 syn match   specMacro contained '%\(\(openldap_schema\|webapp\)_\(un\)\?register\)'
  78 syn match   specMacro contained '%\(pear_package_\(setup\|install\)\)'
  79 syn match   specMacro contained '%\(py_o\?comp\|py_postclean\)'
  80 syn match   specMacro contained '%\(build\|install\)_kernel_modules'
  81 syn match   specMacro contained '%ant'
  82 syn match   specMacro contained '%\(php\|php4\)_webserver_restart'
  83 syn match   specMacro contained '%update_browser_plugins\|%browser_plugins_add_browser'
  84
  85 syn keyword specCommandSpecial contained root
  86 syn keyword specCommand         contained make xmkmf mkdir chmod find sed rm strip moc echo grep ls rm mv mkdir chown install cp pwd cat tail then else elif cd gzip rmdir ln eval export touch unzip bzip2
  87 syn cluster specCommands contains=specCommand,specTarCommand,specConfigure,specCommandSpecial,specMacro
  88
  89 " frequently used rpm env vars
  90 syn keyword specSpecialVariablesNames contained RPM_BUILD_ROOT RPM_BUILD_DIR RPM_SOURCE_DIR RPM_OPT_FLAGS LDFLAGS CC CC_FLAGS CPPNAME CFLAGS CXX CXXFLAGS CPPFLAGS
  91
  92 " valid macro names from /usr/lib/rpm/macros
  93 syn keyword specMacroNameOther contained buildroot buildsubdir distribution disturl ix86 name nil optflags perl_sitearch release requires_eq vendor version
  94 syn keyword specMacroNameOther contained __kernel_ver date debugcflags debuginfocflags epoch kgcc kgcc_package packager
  95 syn keyword specMacroNameOther contained pear_package_install pear_package_setup perl_archlib perl_privlib perl_sitelib
  96 syn keyword specMacroNameOther contained perl_vendorarch perl_vendorlib php_pear_dir py_sitedir py_scriptdir py_sitescriptdir releq_kernel_smp
  97 syn keyword specMacroNameOther contained releq_kernel_up requires_php_extension requires_php_pdo_module requires_releq_kernel_smp requires_releq_kernel_up
  98 syn keyword specMacroNameOther contained requires_zend_extension ruby_mod_ver_requires_eq rpmcflags rpmcxxflags rpmldflags tmpdir x8664
  99 syn keyword specMacroNameOther contained ruby_archdir ruby_rubylibdir ruby_ridir ruby_sitearchdir ruby_sitelibdir ruby_version
 100 syn keyword specMacroNameOther contained apache_modules_api php_sysconfdir php_extensiondir _browserpluginsdir _browserpluginsconfdir
 101
 102 syn match   specMacroNameOther contained '\<\(PATCH\|SOURCE\)\d*\>'
 103
 104 " valid _macro names from /usr/lib/rpm/macros
 105 syn keyword specMacroNameLocal contained _aclocaldir _applnkdir _arch _binary_payload _bindir _build _build_arch _build_alias
 106 syn keyword specMacroNameLocal contained _build_cpu _builddir _build_os _buildshell _buildsubdir _build_vendor _bzip2bin _datadir
 107 syn keyword specMacroNameLocal contained _dbpath _dbpath_rebuild _defaultdocdir _desktopdir _docdir _examplesdir _excludedocs _kdedocdir
 108 syn keyword specMacroNameLocal contained _exec_prefix _fixgroup _fixowner _fixperms _fontsdir _ftpport _ftpproxy _gnu _gpg_name
 109 syn keyword specMacroNameLocal contained _gpg_path _gtkdocdir _gzipbin _host _host_alias _host_cpu _host_os _host_vendor
 110 syn keyword specMacroNameLocal contained _httpport _httpproxy _iconsdir _includedir _infodir _initrddir _install_langs
 111 syn keyword specMacroNameLocal contained _install_script_path _instchangelog _javaclasspath _javadir _javadocdir _kernelsrcdir
 112 syn keyword specMacroNameLocal contained _kernel_ver _kernel_ver_str _langpatt _lib _libdir _libexecdir _localstatedir _mandir
 113 syn keyword specMacroNameLocal contained _netsharedpath _oldincludedir _omf_dest_dir _os _package_version _pgpbin _pgp_name
 114 syn keyword specMacroNameLocal contained _pgp_path _pixmapsdir _pkgconfigdir _prefix _preScriptEnvironment _provides _rpmdir
 115 syn keyword specMacroNameLocal contained _rpmfilename _sbindir _sharedstatedir _signature _smp_mflags _sourcedir _source_payload
 116 syn keyword specMacroNameLocal contained _specdir _srcrpmdir _sysconfdir _target _target_alias _target_cpu _target_os _target_platform
 117 syn keyword specMacroNameLocal contained _target_vendor _target_base_arch _timecheck _tmppath _topdir _usr _usrsrc _var _vendor
 118 syn keyword specMacroNameLocal contained __cxx __cc __libtoolize __autopoint __aclocal __autoconf __automake __autoheader
 119 syn keyword specMacroNameLocal contained __gettextize __glib_gettextize __intltoolize
 120 syn keyword specMacroNameLocal contained __bzip2 __cat __chgrp __chmod __chown __cp   __cpio __file __gpg __grep __gzip
 121 syn keyword specMacroNameLocal contained __id  __install __ld   __make   __mkdir __mkdir_p __mv __nm  __objcopy __objdump
 122 syn keyword specMacroNameLocal contained __patch __perl __pgp __python __rm __rsh  __sed __ssh __strip  __tar __unzip
 123
 124
 125
 126 " ------------------------------------------------------------------------------
 127 " here's is all the spec sections definitions: PreAmble, Description, Package,
 128 "   Scripts, Files and Changelog
 129
 130 " One line macros - valid in all ScriptAreas
 131 " tip: remember do include new items on specScriptArea's skip section
 132 syn region specSectionMacroArea oneline matchgroup=specSectionMacro start='^%\(\(un\)\?define\|dump\|trace\|patch\d*\|setup\|configure2_13\|configure\|GNUconfigure\|find_lang\|makeinstall\|cmake\|scons\|waf\|bcond_with\(out\)\?\|include\)\>' end='$' contains=specCommandOpts,specMacroIdentifier,specSectionMacroBcondArea
 133 syn region specSectionMacroBracketArea oneline matchgroup=specSectionMacro start='^%{\(configure2_13\|configure\|GNUconfigure\|find_lang\|makeinstall\|cmake\|scons\|waf\)}' end='$' contains=specCommandOpts,specMacroIdentifier
 134 syn region specSectionMacroBcondArea oneline matchgroup=specBlock start='%{!\??\(with\(out\)\?_[a-zA-Z0-9_]\+\|debug\):' skip='\\}' end='}' contains=ALLBUT,shCase
 135
 136 " %% Files Section %%
 137 " TODO %config valid parameters: missingok\|noreplace
 138 " TODO %verify valid parameters: \(not\)\= \(md5\|atime\|...\)
 139 syn region specFilesArea matchgroup=specSection start='^%[Ff][Ii][Ll][Ee][Ss]\>'
 140         \ skip='%\(attrib\|defattr\|attr\|dir\|config\|docdir\|doc\|lang\|verify\|ghost\|exclude\|dev\|if\|else\|endif\)\>'
 141         \ end='^%[a-zA-Z]'me=e-2
 142         \ contains=specFilesOpts,specFilesDirective,@specListedFiles,specComment,specCommandSpecial,specMacroIdentifier,specSectionMacroBcondArea,specIf
 143
 144 " tip: remember to include new items in specFilesArea above
 145 syn match  specFilesDirective contained '%\(attrib\|defattr\|attr\|dir\|config\|docdir\|doc\|lang\|verify\|ghost\|exclude\|dev\)\>'
 146
 147 " valid options for certain section headers
 148 syn match specDescriptionOpts contained '\s-[ln]\s*\a'ms=s+1,me=e-1
 149 syn match specPackageOpts     contained    '\s-n\s*\w'ms=s+1,me=e-1
 150 syn match specFilesOpts       contained    '\s-f\s*\w'ms=s+1,me=e-1
 151
 152
 153 syn case ignore
 154
 155
 156 " %% PreAmble Section %%
 157 " Copyright and Serial were deprecated by License and Epoch
 158 " PreReq and BuildPreReq deprecated by Requires ans BuildRequires
 159 syn region specPreAmbleDeprecated oneline matchgroup=specError start='^\(Copyright\|Serial\|PreReq\|BuildPreReq\(uires\)\?\)' end='$' contains=specEmail,specURL,specURLMacro,specLicense,specColon,specVariables,specSpecialChar,specMacroIdentifier
 160 syn region specPreAmble oneline matchgroup=specCommand
 161         \ start='\(^\|\(^%{!\??\(with\(out\)\?_[a-zA-Z0-9_]\+\|debug\):\)\@<=\)\(Summary\|Name\|Version\|Packager\|Requires\|Icon\|URL\|Source\d*\|Patch\d*\|Prefix\|Packager\|Group\|License\|Release\|BuildRoot\|Distribution\|Vendor\|Provides\|ExclusiveArch\|ExcludeArch\|ExclusiveOS\|Obsoletes\|BuildArch\|BuildArchitectures\|BuildRequires\|BuildConflicts\|Conflicts\|AutoRequires\|AutoReqProv\|AutoReq\|AutoProv\|Epoch\|NoSource\)'
 162         \ end='$\|}\@='
 163         \ contains=specEmail,specURL,specURLMacro,specLicense,specLicenseWarning,specColon,specVariables,specSpecialChar,specMacroIdentifier,specSectionMacroBcondArea
 164
 165 " %% Description Section %%
 166 syn region specDescriptionArea matchgroup=specSection start='^%description' end='^%'me=e-1
 167         \ contains=specDescriptionOpts,specEmail,specURL,specNumber,specMacroIdentifier,specComment
 168
 169 " %% Package Section %%
 170 syn region specPackageArea matchgroup=specSection start='^%package' end='^%'me=e-1
 171         \ contains=specPackageOpts,specPreAmble,specComment,specMacroNameOther
 172
 173 " %% Scripts Section %%
 174 syn region specScriptArea matchgroup=specSection
 175         \ start='^%\(prep\|build\|install\|clean\|pre\|postun\|preun\|post\|triggerin\|triggerun\|triggerpostun\|pretrans\|posttrans\|verifyscript\|check\)\>'
 176         \ skip='^%{\|^%\(define\|patch\d*\|configure2_13\|configure\|ant\|GNUconfigure\|setup\|find_lang\|makeinstall\|cmake\|scons\|waf\|useradd\|groupadd\|addusertogroup\|banner\|service\|env_update\|py_o\?comp\|py_postclean\|\(\(nsplugin\|apache_config\)_\(un\)\?install\)\|\(openldap_schema\|webapp\)_\(un\)\?register\|depmod\|pear_package_\(setup\|install\)\|\(build\|install\)_kernel_modules\|php_webserver_restart\|php4_webserver_restart\|update_browser_plugins\)\>'
 177         \ end='^%'me=e-1
 178         \ contains=specSpecialVariables,specVariables,@specCommands,specVariables,shDo,shFor,shCaseEsac,specNoNumberHilite,specCommandOpts,shComment,shIf,specSpecialChar,specMacroIdentifier,specSectionMacroArea,specSectionMacroBracketArea,shOperator,shQuote1,shQuote2,specSectionMacroBcondArea
 179 " XXX don't forget to update specMacro when updating specScriptArea skip definition
 180
 181 " %% Changelog Section %%
 182 syn region specChangelogArea matchgroup=specSection start='^%changelog' end='^%'me=e-1
 183         \ contains=specEmail,specURL,specWeekday,specMonth,specNumber,specComment,specLicense,specRevision,specLogMessage,specLogError
 184
 185 syn match specRevision contained "^Revision [.0-9]\+  [/0-9]\+ [:0-9]\+  [a-zA-Z0-9]\+$"
 186 syn region specLogMessage contained start="^[- ] " end="$" contains=specLogError,specURL,specEmail
 187 syn match specLogError contained "%%"
 188
 189 " ------------------------------------------------------------------------------
 190 " here's the shell syntax for all the Script Sections
 191
 192
 193 syn case match
 194
 195
 196 " sh-like comment style, only valid in script part
 197 syn match shComment contained '#.*$'
 198
 199 syn region shQuote1 contained matchgroup=shQuoteDelim start=+'+ skip=+\\'+ end=+'+ contains=specMacroIdentifier
 200 syn region shQuote2 contained matchgroup=shQuoteDelim start=+"+ skip=+\\"+ end=+"+ contains=specVariables,specMacroIdentifier,specSectionMacroBcondArea
 201
 202 syn match shOperator contained '[><|!&;]\|[!=]='
 203 syn region shDo transparent matchgroup=specBlock start="\(^\|\s\)do\(\s\|$\)" end="\(^\|\s\)done\(\s\|$\)" contains=ALLBUT,shDoError,shCase,specPreAmble,@specListedFiles
 204
 205 syn region specIf  matchgroup=specBlock start="%ifosf\|%ifos\|%ifnos\|%ifarch\|%ifnarch\|ifdef\|ifndef\|%if\|%else"  end='%endif'  contains=ALLBUT, specIfError, shCase, shComment
 206
 207 syn region shIf transparent matchgroup=specBlock start="\(^\|\s\)if\(\s\|$\)" end="\(^\|\s\)fi\(\s\|$\)" contains=ALLBUT,shIfError,shCase,@specListedFiles
 208
 209 syn region shFor  matchgroup=specBlock start="\(^\|\s\)for\(\s\|$\)" end="\(^\|\s\)in\(\s\|$\)" contains=ALLBUT,shInError,shCase,@specListedFiles
 210
 211 syn region shCaseEsac transparent matchgroup=specBlock start="\(^\|\s\)case\(\s\|$\)" matchgroup=NONE end="\(^\|\s\)in\(\s\|$\)"me=s-1 contains=ALLBUT,@specListedFiles nextgroup=shCaseEsac
 212 syn region shCaseEsac matchgroup=specBlock start="\(^\|\s\)in\(\s\|$\)" end="\(^\|\s\)esac\(\s\|$\)" contains=ALLBUT,@specListedFilesBin
 213 syn region shCase matchgroup=specBlock contained start=")"  end=";;" contains=ALLBUT,shCase,@specListedFiles
 214
 215 syn sync match shDoSync       grouphere  shDo       "\<do\>"
 216 syn sync match shDoSync       groupthere shDo       "\<done\>"
 217 syn sync match shIfSync       grouphere  shIf       "\<if\>"
 218 syn sync match shIfSync       groupthere shIf       "\<fi\>"
 219 syn sync match specIfSync     grouphere  specIf     "%ifarch\|%ifos\|%ifnos"
 220 syn sync match specIfSync     groupthere specIf     "%endIf"
 221 syn sync match shForSync      grouphere  shFor      "\<for\>"
 222 syn sync match shForSync      groupthere shFor      "\<in\>"
 223 syn sync match shCaseEsacSync grouphere  shCaseEsac "\<case\>"
 224 syn sync match shCaseEsacSync groupthere shCaseEsac "\<esac\>"
 225
 226 " Define the default highlighting.
 227 " For version 5.7 and earlier: only when not done already
 228 " For version 5.8 and later: only when an item doesn't have highlighting yet
 229 if version >= 508 || !exists("did_spec_syntax_inits")
 230   if version < 508
 231     let did_spec_syntax_inits = 1
 232     command -nargs=+ HiLink hi link <args>
 233   else
 234     command -nargs=+ HiLink hi def link <args>
 235   endif
 236
 237   "main types color definitions
 238   HiLink specSection                    Structure
 239   HiLink specSectionMacro               Macro
 240   HiLink specWWWlink                    PreProc
 241   HiLink specOpts                       Operator
 242
 243   "yes, it's ugly, but white is sooo cool
 244   if &background == "dark"
 245     hi def specGlobalMacro              ctermfg=white
 246   else
 247     HiLink specGlobalMacro              Identifier
 248   endif
 249
 250   "sh colors
 251   HiLink shComment                      Comment
 252   HiLink shIf                           Statement
 253   HiLink shOperator                     Special
 254   HiLink shQuote1                       String
 255   HiLink shQuote2                       String
 256   HiLink shQuoteDelim                   Statement
 257
 258   " spec colors
 259   HiLink specBlock                      Function
 260   HiLink specBcond                      Function
 261   HiLink specColon                      Special
 262   HiLink specCommand                    Statement
 263   HiLink specCommandOpts                specOpts
 264   HiLink specCommandSpecial             Special
 265   HiLink specComment                    Comment
 266   HiLink specConfigure                  specCommand
 267   HiLink specDate                       String
 268   HiLink specDescriptionOpts            specOpts
 269   HiLink specEmail                      specWWWlink
 270   HiLink specError                      Error
 271   HiLink specFilesDirective             specSectionMacro
 272   HiLink specFilesOpts                  specOpts
 273   HiLink specLicense                    String
 274   HiLink specLicenseWarning             specError
 275   HiLink specMacroNameLocal             specGlobalMacro
 276   HiLink specMacroNameOther             specGlobalMacro
 277   HiLink specManpageFile                NONE
 278   HiLink specMonth                      specDate
 279   HiLink specNoNumberHilite             NONE
 280   HiLink specNumber                     Number
 281   HiLink specPackageOpts                specOpts
 282   HiLink specPercent                    Special
 283   HiLink specSpecialChar                Special
 284   HiLink specSubstChar                  Special
 285   HiLink specSpecialVariables           specGlobalMacro
 286   HiLink specSpecialVariablesNames      specGlobalMacro
 287   HiLink specTarCommand                 specCommand
 288   HiLink specMacro                      Macro
 289   HiLink specURL                        specWWWlink
 290   HiLink specURLMacro                   specWWWlink
 291   HiLink specVariables                  Identifier
 292   HiLink specWeekday                    specDate
 293   HiLink specListedFilesBin             Statement
 294   HiLink specListedFilesDoc             Statement
 295   HiLink specListedFilesEtc             Statement
 296   HiLink specListedFilesLib             Statement
 297   HiLink specListedFilesPrefix          Statement
 298   HiLink specListedFilesShare           Statement
 299
 300   HiLink specRevision                   Number
 301   HiLink specLogMessage                 Identifier
 302   HiLink specLogError                   Error
 303
 304   delcommand HiLink
 305 endif
 306
 307 let b:current_syntax = "spec"
 308
 309 " vim: ts=8