codekingpro/portable-devtools
115k
1" Vim syntax file2" Language: R Help File3" Maintainer: This runtime file is looking for a new maintainer.4" Former Maintainers: Jakson Aquino <jalvesaq@gmail.com>5" Johannes Ranke <jranke@uni-bremen.de>6" Former Repository: https://github.com/jalvesaq/R-Vim-runtime7" Last Change: 2016 Jun 28 08:53AM8" 2024 Feb 19 by Vim Project (announce adoption)9" Remarks: - Includes R syntax highlighting in the appropriate10" sections if an r.vim file is in the same directory or in the11" default debian location.12" - There is no Latex markup in equations13" - Thanks to Will Gray for finding and fixing a bug14" - No support for \var tag within quoted string15 16" Version Clears: {{{117if exists("b:current_syntax")18 finish19endif 20 21scriptencoding utf-822 23syn case match24 25" R help identifiers {{{126syn region rhelpIdentifier matchgroup=rhelpSection start="\\name{" end="}" 27syn region rhelpIdentifier matchgroup=rhelpSection start="\\alias{" end="}" 28syn region rhelpIdentifier matchgroup=rhelpSection start="\\pkg{" end="}" contains=rhelpLink29syn region rhelpIdentifier matchgroup=rhelpSection start="\\CRANpkg{" end="}" contains=rhelpLink30syn region rhelpIdentifier matchgroup=rhelpSection start="\\method{" end="}" contained31syn region rhelpIdentifier matchgroup=rhelpSection start="\\Rdversion{" end="}"32 33 34" Highlighting of R code using an existing r.vim syntax file if available {{{135syn include @R syntax/r.vim36 37" Strings {{{138syn region rhelpString start=/"/ skip=/\\"/ end=/"/ contains=rhelpSpecialChar,rhelpCodeSpecial,rhelpLink contained39 40" Special characters in R strings41syn match rhelpCodeSpecial display contained "\\\\\(n\|r\|t\|b\|a\|f\|v\|'\|\"\)\|\\\\"42 43" Special characters ( \$ \& \% \# \{ \} \_)44syn match rhelpSpecialChar "\\[$&%#{}_]"45 46 47" R code {{{148syn match rhelpDots "\\dots" containedin=@R49syn region rhelpRcode matchgroup=Delimiter start="\\examples{" matchgroup=Delimiter transparent end="}" contains=@R,rhelpLink,rhelpIdentifier,rhelpString,rhelpSpecialChar,rhelpSection50syn region rhelpRcode matchgroup=Delimiter start="\\usage{" matchgroup=Delimiter transparent end="}" contains=@R,rhelpIdentifier,rhelpS4method51syn region rhelpRcode matchgroup=Delimiter start="\\synopsis{" matchgroup=Delimiter transparent end="}" contains=@R52syn region rhelpRcode matchgroup=Delimiter start="\\special{" matchgroup=Delimiter transparent end="}" contains=@R53 54if v:version > 70355 syn region rhelpRcode matchgroup=Delimiter start="\\code{" skip='\\\@1<!{.\{-}\\\@1<!}' transparent end="}" contains=@R,rhelpDots,rhelpString,rhelpSpecialChar,rhelpLink keepend56else57 syn region rhelpRcode matchgroup=Delimiter start="\\code{" skip='\\\@<!{.\{-}\\\@<!}' transparent end="}" contains=@R,rhelpDots,rhelpString,rhelpSpecialChar,rhelpLink keepend58endif59syn region rhelpS4method matchgroup=Delimiter start="\\S4method{.*}(" matchgroup=Delimiter transparent end=")" contains=@R,rhelpDots60syn region rhelpSexpr matchgroup=Delimiter start="\\Sexpr{" matchgroup=Delimiter transparent end="}" contains=@R61 62" PreProc {{{163syn match rhelpPreProc "^#ifdef.*" 64syn match rhelpPreProc "^#endif.*" 65 66" Special Delimiters {{{167syn match rhelpDelimiter "\\cr"68syn match rhelpDelimiter "\\tab "69 70" Keywords {{{171syn match rhelpKeyword "\\R\>"72syn match rhelpKeyword "\\ldots\>"73syn match rhelpKeyword "\\sspace\>"74syn match rhelpKeyword "--"75syn match rhelpKeyword "---"76 77" Condition Keywords {{{278syn match rhelpKeyword "\\if\>"79syn match rhelpKeyword "\\ifelse\>"80syn match rhelpKeyword "\\out\>"81" Examples of usage:82" \ifelse{latex}{\eqn{p = 5 + 6 - 7 \times 8}}{\eqn{p = 5 + 6 - 7 * 8}}83" \ifelse{latex}{\out{$\alpha$}}{\ifelse{html}{\out{α}}{alpha}}84 85" Keywords and operators valid only if in math mode {{{286syn match rhelpMathOp "<" contained87syn match rhelpMathOp ">" contained88syn match rhelpMathOp "+" contained89syn match rhelpMathOp "-" contained90syn match rhelpMathOp "=" contained91 92" Conceal function based on syntax/tex.vim {{{293if exists("g:tex_conceal")94 let s:tex_conceal = g:tex_conceal95else96 let s:tex_conceal = 'gm'97endif98function s:HideSymbol(pat, cchar, hide)99 if a:hide100 exe "syn match rhelpMathSymb '" . a:pat . "' contained conceal cchar=" . a:cchar101 else102 exe "syn match rhelpMathSymb '" . a:pat . "' contained"103 endif104endfunction105 106" Math symbols {{{2107if s:tex_conceal =~ 'm'108 let s:hd = 1109else110 let s:hd = 0111endif112call s:HideSymbol('\\infty\>', '∞', s:hd)113call s:HideSymbol('\\ge\>', '≥', s:hd)114call s:HideSymbol('\\le\>', '≤', s:hd)115call s:HideSymbol('\\prod\>', '∏', s:hd)116call s:HideSymbol('\\sum\>', '∑', s:hd)117syn match rhelpMathSymb "\\sqrt\>" contained118 119" Greek letters {{{2120if s:tex_conceal =~ 'g'121 let s:hd = 1122else123 let s:hd = 0124endif125call s:HideSymbol('\\alpha\>', 'α', s:hd)126call s:HideSymbol('\\beta\>', 'β', s:hd)127call s:HideSymbol('\\gamma\>', 'γ', s:hd)128call s:HideSymbol('\\delta\>', 'δ', s:hd)129call s:HideSymbol('\\epsilon\>', 'ϵ', s:hd)130call s:HideSymbol('\\zeta\>', 'ζ', s:hd)131call s:HideSymbol('\\eta\>', 'η', s:hd)132call s:HideSymbol('\\theta\>', 'θ', s:hd)133call s:HideSymbol('\\iota\>', 'ι', s:hd)134call s:HideSymbol('\\kappa\>', 'κ', s:hd)135call s:HideSymbol('\\lambda\>', 'λ', s:hd)136call s:HideSymbol('\\mu\>', 'μ', s:hd)137call s:HideSymbol('\\nu\>', 'ν', s:hd)138call s:HideSymbol('\\xi\>', 'ξ', s:hd)139call s:HideSymbol('\\pi\>', 'π', s:hd)140call s:HideSymbol('\\rho\>', 'ρ', s:hd)141call s:HideSymbol('\\sigma\>', 'σ', s:hd)142call s:HideSymbol('\\tau\>', 'τ', s:hd)143call s:HideSymbol('\\upsilon\>', 'υ', s:hd)144call s:HideSymbol('\\phi\>', 'ϕ', s:hd)145call s:HideSymbol('\\chi\>', 'χ', s:hd)146call s:HideSymbol('\\psi\>', 'ψ', s:hd)147call s:HideSymbol('\\omega\>', 'ω', s:hd)148call s:HideSymbol('\\Gamma\>', 'Γ', s:hd)149call s:HideSymbol('\\Delta\>', 'Δ', s:hd)150call s:HideSymbol('\\Theta\>', 'Θ', s:hd)151call s:HideSymbol('\\Lambda\>', 'Λ', s:hd)152call s:HideSymbol('\\Xi\>', 'Ξ', s:hd)153call s:HideSymbol('\\Pi\>', 'Π', s:hd)154call s:HideSymbol('\\Sigma\>', 'Σ', s:hd)155call s:HideSymbol('\\Upsilon\>', 'Υ', s:hd)156call s:HideSymbol('\\Phi\>', 'Φ', s:hd)157call s:HideSymbol('\\Psi\>', 'Ψ', s:hd)158call s:HideSymbol('\\Omega\>', 'Ω', s:hd)159delfunction s:HideSymbol160" Note: The letters 'omicron', 'Alpha', 'Beta', 'Epsilon', 'Zeta', 'Eta',161" 'Iota', 'Kappa', 'Mu', 'Nu', 'Omicron', 'Rho', 'Tau' and 'Chi' are listed162" at src/library/tools/R/Rd2txt.R because they are valid in HTML, although163" they do not make valid LaTeX code (e.g. Α versus \Alpha).164 165" Links {{{1166syn region rhelpLink matchgroup=rhelpType start="\\link{" end="}" contained keepend extend167syn region rhelpLink matchgroup=rhelpType start="\\link\[.\{-}\]{" end="}" contained keepend extend168syn region rhelpLink matchgroup=rhelpType start="\\linkS4class{" end="}" contained keepend extend169syn region rhelpLink matchgroup=rhelpType start="\\url{" end="}" contained keepend extend170syn region rhelpLink matchgroup=rhelpType start="\\href{" end="}" contained keepend extend171syn region rhelpLink matchgroup=rhelpType start="\\figure{" end="}" contained keepend extend172 173" Verbatim like {{{1174syn region rhelpVerbatim matchgroup=rhelpType start="\\samp{" skip='\\\@1<!{.\{-}\\\@1<!}' end="}" contains=rhelpSpecialChar,rhelpComment175syn region rhelpVerbatim matchgroup=rhelpType start="\\verb{" skip='\\\@1<!{.\{-}\\\@1<!}' end="}" contains=rhelpSpecialChar,rhelpComment176 177" Equation {{{1178syn region rhelpEquation matchgroup=rhelpType start="\\eqn{" skip='\\\@1<!{.\{-}\\\@1<!}' end="}" contains=rhelpMathSymb,rhelpMathOp,rhelpRegion contained keepend extend179syn region rhelpEquation matchgroup=rhelpType start="\\deqn{" skip='\\\@1<!{.\{-}\\\@1<!}' end="}" contains=rhelpMathSymb,rhelpMathOp,rhelpRegion contained keepend extend180 181" Type Styles {{{1182syn match rhelpType "\\emph\>"183syn match rhelpType "\\strong\>"184syn match rhelpType "\\bold\>"185syn match rhelpType "\\sQuote\>"186syn match rhelpType "\\dQuote\>"187syn match rhelpType "\\preformatted\>"188syn match rhelpType "\\kbd\>"189syn match rhelpType "\\file\>"190syn match rhelpType "\\email\>"191syn match rhelpType "\\enc\>"192syn match rhelpType "\\var\>"193syn match rhelpType "\\env\>"194syn match rhelpType "\\option\>"195syn match rhelpType "\\command\>"196syn match rhelpType "\\newcommand\>"197syn match rhelpType "\\renewcommand\>"198syn match rhelpType "\\dfn\>"199syn match rhelpType "\\cite\>"200syn match rhelpType "\\acronym\>"201syn match rhelpType "\\doi\>"202 203" rhelp sections {{{1204syn match rhelpSection "\\encoding\>"205syn match rhelpSection "\\title\>"206syn match rhelpSection "\\item\>"207syn match rhelpSection "\\description\>"208syn match rhelpSection "\\concept\>"209syn match rhelpSection "\\arguments\>"210syn match rhelpSection "\\details\>"211syn match rhelpSection "\\value\>"212syn match rhelpSection "\\references\>"213syn match rhelpSection "\\note\>"214syn match rhelpSection "\\author\>"215syn match rhelpSection "\\seealso\>"216syn match rhelpSection "\\keyword\>"217syn match rhelpSection "\\docType\>"218syn match rhelpSection "\\format\>"219syn match rhelpSection "\\source\>"220syn match rhelpSection "\\itemize\>"221syn match rhelpSection "\\describe\>"222syn match rhelpSection "\\enumerate\>"223syn match rhelpSection "\\item "224syn match rhelpSection "\\item$"225syn match rhelpSection "\\tabular{[lcr]*}"226syn match rhelpSection "\\dontrun\>"227syn match rhelpSection "\\dontshow\>"228syn match rhelpSection "\\testonly\>"229syn match rhelpSection "\\donttest\>"230 231" Freely named Sections {{{1232syn region rhelpFreesec matchgroup=Delimiter start="\\section{" matchgroup=Delimiter transparent end="}"233syn region rhelpFreesubsec matchgroup=Delimiter start="\\subsection{" matchgroup=Delimiter transparent end="}" 234 235syn match rhelpDelimiter "{\|\[\|(\|)\|\]\|}"236 237" R help file comments {{{1238syn match rhelpComment /%.*$/239 240" Error {{{1241syn region rhelpRegion matchgroup=Delimiter start=/(/ matchgroup=Delimiter end=/)/ contains=@Spell,rhelpCodeSpecial,rhelpComment,rhelpDelimiter,rhelpDots,rhelpFreesec,rhelpFreesubsec,rhelpIdentifier,rhelpKeyword,rhelpLink,rhelpPreProc,rhelpRComment,rhelpRcode,rhelpRegion,rhelpS4method,rhelpSection,rhelpSexpr,rhelpSpecialChar,rhelpString,rhelpType,rhelpVerbatim,rhelpEquation242syn region rhelpRegion matchgroup=Delimiter start=/{/ matchgroup=Delimiter end=/}/ contains=@Spell,rhelpCodeSpecial,rhelpComment,rhelpDelimiter,rhelpDots,rhelpFreesec,rhelpFreesubsec,rhelpIdentifier,rhelpKeyword,rhelpLink,rhelpPreProc,rhelpRComment,rhelpRcode,rhelpRegion,rhelpS4method,rhelpSection,rhelpSexpr,rhelpSpecialChar,rhelpString,rhelpType,rhelpVerbatim,rhelpEquation243syn region rhelpRegion matchgroup=Delimiter start=/\[/ matchgroup=Delimiter end=/]/ contains=@Spell,rhelpCodeSpecial,rhelpComment,rhelpDelimiter,rhelpDots,rhelpFreesec,rhelpFreesubsec,rhelpIdentifier,rhelpKeyword,rhelpLink,rhelpPreProc,rhelpRComment,rhelpRcode,rhelpRegion,rhelpS4method,rhelpSection,rhelpSexpr,rhelpSpecialChar,rhelpString,rhelpType,rhelpVerbatim,rhelpEquation244syn match rhelpError /[)\]}]/245syn match rhelpBraceError /[)}]/ contained246syn match rhelpCurlyError /[)\]]/ contained247syn match rhelpParenError /[\]}]/ contained248 249syntax sync match rhelpSyncRcode grouphere rhelpRcode "\\examples{"250 251" Define the default highlighting {{{1252hi def link rhelpVerbatim String253hi def link rhelpDelimiter Delimiter254hi def link rhelpIdentifier Identifier255hi def link rhelpString String256hi def link rhelpCodeSpecial Special257hi def link rhelpKeyword Keyword258hi def link rhelpDots Keyword259hi def link rhelpLink Underlined260hi def link rhelpType Type261hi def link rhelpSection PreCondit262hi def link rhelpError Error263hi def link rhelpBraceError Error264hi def link rhelpCurlyError Error265hi def link rhelpParenError Error266hi def link rhelpPreProc PreProc267hi def link rhelpDelimiter Delimiter268hi def link rhelpComment Comment269hi def link rhelpRComment Comment270hi def link rhelpSpecialChar SpecialChar271hi def link rhelpMathSymb Special272hi def link rhelpMathOp Operator273 274let b:current_syntax = "rhelp"275 276" vim: foldmethod=marker sw=2277