From: Benoit Cerrina <benoit.cerrina@...>
Date: 2002-02-08T10:04:32+09:00
Subject: Re: ruby and vim


"Martin Maciaszek" <fastjack@www.germanistik.fu-berlin.de> wrote in message
news:slrna650l6.vk7.fastjack@www.germanistik.fu-berlin.de...
> To edit my ruby code I rediscovered the good old vim. vim6 even has
> syntax highlighting rules for ruby. Which works great, except on the
> following code:
> dbh.do("select whatever from whereever;")
>   foo
> end
>
> The syntax highlighting rules seem to think that do starts a code
> block. This is just a mior nuisance but it freaked me out the first
> time when I was wondering why one of my "end"s war differently colored
> then the other ones :)
this is a more generic problem with using any keyword as a method name,
please try the attached replacement ruby.vim syntax file, this should go
in the syntax subdirectory of one of the directory in your runtime path.
(do :set rtp , drop this in a syntax subdirectory in the first directory
in this list)

>
> A IMHO bigger nuisance is the lack of folding support based on
> syntax. I would like to collapse whole methods. Folding based on
> indentation is not very helpful with that. (maybe it's just the way
> I indent my code?)
syntax dependant folding has usually been shown as very very slow.  It
doesn't work very well due to this.
Maybe it is just the way other syntax maintainer have added it I don't
know...
But usually whenever there is support for syntax dependent folding it is
disabled by default.

>
> Has someone come up with a better syntax highlighting/folding file for
> vim?
>
> Cheers
> Martin
>
Benoit

PS:
I'm having problem sending the attached file the server complains that it
is binary so here it is
--------------------cut ruby.vim-----------------------------
" Vim syntax file
" Language:     Ruby
" Maintainer:   Mirko Nasato
" Last Change:  2002 February 8
" Location:     http://altern.org/mn/ruby/ruby.vim
" last change done by Benoit Cerrina
" See http://altern.org/mn/ruby/vim.html for documentation.
" Thanks to perl.vim authors, and to Reimer Behrends. :-)

" For version 5.x: Clear all syntax items
" For version 6.x: Quit when a syntax file was already loaded
if version < 600
  syntax clear
elseif exists("b:current_syntax")
  finish
endif

" Expression Substitution: and Backslash Notation
syn match   rubyExprSubst
"\\\\\|\(\(\\M-\\C-\|\\c\|\\C-\|\\M-\)\w\)\|\(\\\o\{3}\|\\x\x\{2}\|\\[tnrfba
es]\)" contained
syn match   rubyExprSubst  "#{[^}]*}" contained
syn match   rubyExprSubst  "#[$@]\w\+" contained

" Numbers: and ASCII Codes
syn match   rubyNumber
"\<\(0x\x\+\|0b[01]\+\|0\o\+\|0\.\d\+\|0\|[1-9][\.0-9_]*\)\>"
syn match   rubyNumber
"?\(\\M-\\C-\|\\c\|\\C-\|\\M-\)\=\(\\\o\{3}\|\\x\x\{2}\|\\\=\w\)"

" Special Identifiers: instance, global, symbol, iterator, predefined
if !exists("ruby_no_identifiers")
  syn match   rubyIdentifier  "\<\u\w*"
  syn match   rubyIdentifier  "@\h\w*"
  syn match   rubyIdentifier  "$\h\w*"
  syn match   rubyIdentifier  "\s:\h\w*"
  syn match   rubyIdentifier  "|[ ,a-zA-Z0-9_*]\+|"
  syn match   rubyIdentifier  "$[\\\"/:'&`+*.,;=~!?@$<>0-9]"
  syn match   rubyIdentifier  "$-[0adFiIlpv]"
endif

"
" BEGIN Autogenerated Stuff (Ruby script @
http://altern.org/mn/ruby/vimregions.rb)
"
" Generalized Regular Expression:
syn region rubyString matchgroup=rubyStringDelimit start="%r!"
end="![iopx]*" skip="\\\\\|\\!" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%r\""
end="\"[iopx]*" skip="\\\\\|\\\"" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%r#"
end="#[iopx]*" skip="\\\\\|\\#" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%r\$"
end="\$[iopx]*" skip="\\\\\|\\\$" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%r%"
end="%[iopx]*" skip="\\\\\|\\%" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%r&"
end="&[iopx]*" skip="\\\\\|\\&" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%r'"
end="'[iopx]*" skip="\\\\\|\\'" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%r\*"
end="\*[iopx]*" skip="\\\\\|\\\*" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%r+"
end="+[iopx]*" skip="\\\\\|\\+" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%r-"
end="-[iopx]*" skip="\\\\\|\\-" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%r\."
end="\.[iopx]*" skip="\\\\\|\\\." contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%r/"
end="/[iopx]*" skip="\\\\\|\\/" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%r:"
end=":[iopx]*" skip="\\\\\|\\:" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%r;"
end=";[iopx]*" skip="\\\\\|\\;" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%r="
end="=[iopx]*" skip="\\\\\|\\=" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%r?"
end="?[iopx]*" skip="\\\\\|\\?" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%r@"
end="@[iopx]*" skip="\\\\\|\\@" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%r\\"
end="\\[iopx]*"  contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%r\^"
end="\^[iopx]*" skip="\\\\\|\\\^" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%r`"
end="`[iopx]*" skip="\\\\\|\\`" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%r|"
end="|[iopx]*" skip="\\\\\|\\|" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%r\~"
end="\~[iopx]*" skip="\\\\\|\\\~" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%r{"
end="}[iopx]*" skip="\\\\\|\\}" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%r<"
end=">[iopx]*" skip="\\\\\|\\>" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%r\["
end="\][iopx]*" skip="\\\\\|\\\]" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%r("
end=")[iopx]*" skip="\\\\\|\\)" contains=rubyExprSubst

" Generalized Single Quoted String and Array of Strings:
syn region rubyString matchgroup=rubyStringDelimit start="%[wq]!" end="!"
skip="\\\\\|\\!"
syn region rubyString matchgroup=rubyStringDelimit start="%[wq]\"" end="\""
skip="\\\\\|\\\""
syn region rubyString matchgroup=rubyStringDelimit start="%[wq]#" end="#"
skip="\\\\\|\\#"
syn region rubyString matchgroup=rubyStringDelimit start="%[wq]\$" end="\$"
skip="\\\\\|\\\$"
syn region rubyString matchgroup=rubyStringDelimit start="%[wq]%" end="%"
skip="\\\\\|\\%"
syn region rubyString matchgroup=rubyStringDelimit start="%[wq]&" end="&"
skip="\\\\\|\\&"
syn region rubyString matchgroup=rubyStringDelimit start="%[wq]'" end="'"
skip="\\\\\|\\'"
syn region rubyString matchgroup=rubyStringDelimit start="%[wq]\*" end="\*"
skip="\\\\\|\\\*"
syn region rubyString matchgroup=rubyStringDelimit start="%[wq]+" end="+"
skip="\\\\\|\\+"
syn region rubyString matchgroup=rubyStringDelimit start="%[wq]-" end="-"
skip="\\\\\|\\-"
syn region rubyString matchgroup=rubyStringDelimit start="%[wq]\." end="\."
skip="\\\\\|\\\."
syn region rubyString matchgroup=rubyStringDelimit start="%[wq]/" end="/"
skip="\\\\\|\\/"
syn region rubyString matchgroup=rubyStringDelimit start="%[wq]:" end=":"
skip="\\\\\|\\:"
syn region rubyString matchgroup=rubyStringDelimit start="%[wq];" end=";"
skip="\\\\\|\\;"
syn region rubyString matchgroup=rubyStringDelimit start="%[wq]=" end="="
skip="\\\\\|\\="
syn region rubyString matchgroup=rubyStringDelimit start="%[wq]?" end="?"
skip="\\\\\|\\?"
syn region rubyString matchgroup=rubyStringDelimit start="%[wq]@" end="@"
skip="\\\\\|\\@"
syn region rubyString matchgroup=rubyStringDelimit start="%[wq]\\" end="\\"
syn region rubyString matchgroup=rubyStringDelimit start="%[wq]\^" end="\^"
skip="\\\\\|\\\^"
syn region rubyString matchgroup=rubyStringDelimit start="%[wq]`" end="`"
skip="\\\\\|\\`"
syn region rubyString matchgroup=rubyStringDelimit start="%[wq]|" end="|"
skip="\\\\\|\\|"
syn region rubyString matchgroup=rubyStringDelimit start="%[wq]\~" end="\~"
skip="\\\\\|\\\~"
syn region rubyString matchgroup=rubyStringDelimit start="%[wq]{" end="}"
skip="\\\\\|\\}"
syn region rubyString matchgroup=rubyStringDelimit start="%[wq]<" end=">"
skip="\\\\\|\\>"
syn region rubyString matchgroup=rubyStringDelimit start="%[wq]\[" end="\]"
skip="\\\\\|\\\]"
syn region rubyString matchgroup=rubyStringDelimit start="%[wq](" end=")"
skip="\\\\\|\\)"

" Generalized Double Quoted String and Shell Command Output:
syn region rubyString matchgroup=rubyStringDelimit start="%[Qx]\=!" end="!"
skip="\\\\\|\\!" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%[Qx]\=\""
end="\"" skip="\\\\\|\\\"" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%[Qx]\=#" end="#"
skip="\\\\\|\\#" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%[Qx]\=\$"
end="\$" skip="\\\\\|\\\$" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%[Qx]\=%" end="%"
skip="\\\\\|\\%" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%[Qx]\=&" end="&"
skip="\\\\\|\\&" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%[Qx]\='" end="'"
skip="\\\\\|\\'" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%[Qx]\=\*"
end="\*" skip="\\\\\|\\\*" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%[Qx]\=+" end="+"
skip="\\\\\|\\+" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%[Qx]\=-" end="-"
skip="\\\\\|\\-" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%[Qx]\=\."
end="\." skip="\\\\\|\\\." contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%[Qx]\=/" end="/"
skip="\\\\\|\\/" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%[Qx]\=:" end=":"
skip="\\\\\|\\:" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%[Qx]\=;" end=";"
skip="\\\\\|\\;" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%[Qx]\==" end="="
skip="\\\\\|\\=" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%[Qx]\=?" end="?"
skip="\\\\\|\\?" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%[Qx]\=@" end="@"
skip="\\\\\|\\@" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%[Qx]\=\\"
end="\\"  contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%[Qx]\=\^"
end="\^" skip="\\\\\|\\\^" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%[Qx]\=`" end="`"
skip="\\\\\|\\`" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%[Qx]\=|" end="|"
skip="\\\\\|\\|" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%[Qx]\=\~"
end="\~" skip="\\\\\|\\\~" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%[Qx]\={" end="}"
skip="\\\\\|\\}" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%[Qx]\=<" end=">"
skip="\\\\\|\\>" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%[Qx]\=\["
end="\]" skip="\\\\\|\\\]" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="%[Qx]\=(" end=")"
skip="\\\\\|\\)" contains=rubyExprSubst

" Normal String and Shell Command Output:
syn region rubyString matchgroup=rubyStringDelimit start="\"" end="\""
skip="\\\\\|\\\"" contains=rubyExprSubst
syn region rubyString matchgroup=rubyStringDelimit start="'" end="'"
skip="\\\\\|\\'"
syn region rubyString matchgroup=rubyStringDelimit start="`" end="`"
skip="\\\\\|\\`" contains=rubyExprSubst
"
" END Autogenerated Stuff
"

" Normal Regular Expression:
syn region  rubyString  matchgroup=rubyStringDelimit
start="\.\@<!\<if\s*/"lc=2 start="[\~=!|&(,]\s*/"lc=1 end="/[iopx]*"
skip="\\\\\|\\/" contains=rubyExprSubst

" Here Document:
syn region  rubyString matchgroup=rubyStringDelimit
start=+<<-\(\u\{3,}\|'\u\{3,}'\|"\u\{3,}"\|`\u\{3,}`\)+hs=s+2
end=+^\s*\u\{3,}$+
syn region  rubyString matchgroup=rubyStringDelimit
start=+<<-\(EOF\|'EOF'\|"EOF"\|`EOF`\)+hs=s+2 end=+^\s*EOF$+
contains=rubyExprSubst
syn region  rubyString matchgroup=rubyStringDelimit
start=+<<-\(EOS\|'EOS'\|"EOS"\|`EOS`\)+hs=s+2 end=+^\s*EOS$+
contains=rubyExprSubst
syn region  rubyString matchgroup=rubyStringDelimit
start=+<<\(\u\{3,}\|'\u\{3,}'\|"\u\{3,}"\|`\u\{3,}`\)+hs=s+2 end=+^\u\{3,}$+
syn region  rubyString matchgroup=rubyStringDelimit
start=+<<\(EOF\|'EOF'\|"EOF"\|`EOF`\)+hs=s+2 end=+^EOF$+
contains=rubyExprSubst
syn region  rubyString matchgroup=rubyStringDelimit
start=+<<\(EOS\|'EOS'\|"EOS"\|`EOS`\)+hs=s+2 end=+^EOS$+
contains=rubyExprSubst

" Expensive Mode: colorize *end* according to opening statement
if !exists("ruby_no_expensive")
  syn region  rubyFunction  matchgroup=rubyDefine start="^\s*def\s"
matchgroup=NONE end="[?!]\|\>" skip="\.\|\(::\)" oneline
  syn region  rubyClassOrModule  matchgroup=rubyDefine
start="^\s*\(class\|module\)\s" end="<\|$\|;"he=e-1 oneline
  syn region  rubyBlock  start="^\s*def\s\+"rs=s matchgroup=rubyDefine
end="\.\@<!\<end\>" contains=ALLBUT,rubyExprSubst,rubyTodo
nextgroup=rubyFunction
  syn region  rubyBlock  start="^\s*\(class\|module\)\>"rs=s
matchgroup=rubyDefine end="\.\@<!\<end\>"
contains=ALLBUT,rubyExprSubst,rubyTodo nextgroup=rubyClassOrModule
  " modifiers + redundant *do*
  syn match   rubyControl  "\.\@<!\<\(if\|unless\|while\|until\|do\)\>"
  " *do* requiring *end*
  syn region  rubyDoBlock  matchgroup=rubyControl start="\.\@<!\<do\>"
end="\.\@<!\<end\>" contains=ALLBUT,rubyExprSubst,rubyTodo
  " statements without *do*
  syn region  rubyNoDoBlock  matchgroup=rubyControl
start="\.\@<!\<\(case\|begin\)\>" start="^\s*\(if\|unless\)\>"
start=";\s*\(if\|unless\)\>"hs=s+1 end="\.\@<!\<end\>"
contains=ALLBUT,rubyExprSubst,rubyTodo
  " statement with optional *do*
  syn region  rubyOptDoBlock matchgroup=rubyControl start="\.\@<!\<for\>"
start="^\s*\(while\|until\)\>" start=";\s*\(while\|until\)\>"hs=s+1
end="\.\@<!\<end\>" contains=ALLBUT,rubyExprSubst,rubyTodo,rubyDoBlock

  if !exists("ruby_minlines")
    let ruby_minlines = 50
  endif
  exec "syn sync minlines=" . ruby_minlines

else " not Expensive
  syn region  rubyFunction  matchgroup=rubyControl start="^\s*def\s"
matchgroup=NONE end="[?!]\|\>" skip="\.\|\(::\)" oneline
  syn region  rubyClassOrModule  matchgroup=rubyControl
start="^\s*\(class\|module\)\s" end="<\|$\|;"he=e-1 oneline
  syn keyword rubyControl case begin do for if unless while until end
endif " Expensive?

" Keywords:
syn keyword rubyControl  then else elsif when ensure rescue
syn keyword rubyControl  and or not in yield lambda proc loop
syn keyword rubyControl  break redo retry next return
syn match   rubyInclude  "^\s*include\>"
syn keyword rubyInclude  require
syn keyword rubyTodo  TODO FIXME XXX contained
syn keyword rubyBoolean  true false self nil
syn keyword rubyException  raise fail catch throw

" Comments: and Documentation
syn match   rubyComment  "#.*" contains=rubyTodo
syn match   rubySharpBang  "#!.*"
syn region  rubyDocumentation  start="^=begin" end="^=end.*$"
contains=rubyTodo

" Define the default highlighting.
" For version 5.7 and earlier: only when not done already
" For version 5.8 and later: only when an item doesn't have highlighting yet
if version >= 508 || !exists("did_ruby_syntax_inits")
  if version < 508
    let did_ruby_syntax_inits = 1
    command -nargs=+ HiLink hi link <args>
  else
    command -nargs=+ HiLink hi def link <args>
  endif

  HiLink rubyDefine          Define
  HiLink rubyFunction        Function
  HiLink rubyControl         Statement
  HiLink rubyInclude         Include
  HiLink rubyNumber          Number
  HiLink rubyBoolean         Boolean
  HiLink rubyException       Exception
  HiLink rubyClassOrModule   Type
  HiLink rubyIdentifier      Special
  HiLink rubySharpBang       PreProc

  HiLink rubyString          String
  HiLink rubyStringDelimit   Delimiter
  HiLink rubyExprSubst       Special

  HiLink rubyComment         Comment
  HiLink rubyDocumentation   Comment
  HiLink rubyTodo            Todo

  delcommand HiLink
endif

let b:current_syntax = "ruby"