path: root/runtime/syntax/muttrc.vim

" Vim syntax file
" Language:	Mutt setup files
" Original:	Preben 'Peppe' Guldberg <peppe-vim@wielders.org>
" Maintainer:	Luna Celeste <luna@unixpoet.dev>
" Last Change:	14 Aug 2023

" This file covers mutt version 2.2.10

" quit when a syntax file was already loaded
if exists("b:current_syntax")
  finish
endif

let s:cpo_save = &cpo
set cpo&vim

" Set the keyword characters
setlocal isk=@,48-57,_,-

" handling optional variables
if !exists("use_mutt_sidebar")
  let use_mutt_sidebar=0
endif

syn match muttrcComment		"^# .*$" contains=@Spell
syn match muttrcComment		"^#[^ ].*$"
syn match muttrcComment		"^#$"
syn match muttrcComment		"[^\\]#.*$"lc=1

" Escape sequences (back-tick and pipe goes here too)
syn match muttrcEscape		+\\[#tnr"'Cc ]+
syn match muttrcEscape		+[`|]+
syn match muttrcEscape		+\\$+

" The variables takes the following arguments
"syn match  muttrcString		contained "=\s*[^ #"'`]\+"lc=1 contains=muttrcEscape
syn region muttrcString		contained keepend start=+"+ms=e skip=+\\"+ end=+"+ contains=muttrcEscape,muttrcCommand,muttrcAction,muttrcShellString
syn region muttrcString		contained keepend start=+'+ms=e skip=+\\'+ end=+'+ contains=muttrcEscape,muttrcCommand,muttrcAction
syn match muttrcStringNL	contained skipwhite skipnl "\s*\\$" nextgroup=muttrcString,muttrcStringNL

syn region muttrcShellString	matchgroup=muttrcEscape keepend start=+`+ skip=+\\`+ end=+`+ contains=muttrcVarStr,muttrcVarBool,muttrcVarQuad,muttrcVarNum,muttrcCommand

syn match  muttrcRXChars	contained /[^\\][][.*?+]\+/hs=s+1
syn match  muttrcRXChars	contained /[][|()][.*?+]*/
syn match  muttrcRXChars	contained /['"]^/ms=s+1
syn match  muttrcRXChars	contained /$['"]/me=e-1
syn match  muttrcRXChars	contained /\\/
" Why does muttrcRXString2 work with one \ when muttrcRXString requires two?
syn region muttrcRXString	contained skipwhite start=+'+ skip=+\\'+ end=+'+ contains=muttrcRXChars
syn region muttrcRXString	contained skipwhite start=+"+ skip=+\\"+ end=+"+ contains=muttrcRXChars
syn region muttrcRXString	contained skipwhite start=+[^ 	"'^]+ skip=+\\\s+ end=+\s+re=e-1 contains=muttrcRXChars
" For some reason, skip refuses to match backslashes here...
syn region muttrcRXString	contained matchgroup=muttrcRXChars skipwhite start=+\^+ end=+[^\\]\s+re=e-1 contains=muttrcRXChars
syn region muttrcRXString	contained matchgroup=muttrcRXChars skipwhite start=+\^+ end=+$\s+ contains=muttrcRXChars
syn region muttrcRXString2	contained skipwhite start=+'+ skip=+\'+ end=+'+ contains=muttrcRXChars
syn region muttrcRXString2	contained skipwhite start=+"+ skip=+\"+ end=+"+ contains=muttrcRXChars

" these must be kept synchronized with muttrcRXString, but are intended for
" muttrcRXHooks
syn region muttrcRXHookString	contained keepend skipwhite start=+'+ skip=+\\'+ end=+'+ contains=muttrcRXString nextgroup=muttrcString,muttrcStringNL
syn region muttrcRXHookString	contained keepend skipwhite start=+"+ skip=+\\"+ end=+"+ contains=muttrcRXString nextgroup=muttrcString,muttrcStringNL
syn region muttrcRXHookString	contained keepend skipwhite start=+[^ 	"'^]+ skip=+\\\s+ end=+\s+re=e-1 contains=muttrcRXString nextgroup=muttrcString,muttrcStringNL
syn region muttrcRXHookString	contained keepend skipwhite start=+\^+ end=+[^\\]\s+re=e-1 contains=muttrcRXString nextgroup=muttrcString,muttrcStringNL
syn region muttrcRXHookString	contained keepend matchgroup=muttrcRXChars skipwhite start=+\^+ end=+$\s+ contains=muttrcRXString nextgroup=muttrcString,muttrcStringNL
syn match muttrcRXHookStringNL contained skipwhite skipnl "\s*\\$" nextgroup=muttrcRXHookString,muttrcRXHookStringNL

" these are exclusively for args lists (e.g. -rx pat pat pat ...)
syn region muttrcRXPat		contained keepend skipwhite start=+'+ skip=+\\'+ end=+'\s*+ contains=muttrcRXString nextgroup=muttrcRXPat
syn region muttrcRXPat		contained keepend skipwhite start=+"+ skip=+\\"+ end=+"\s*+ contains=muttrcRXString nextgroup=muttrcRXPat
syn match muttrcRXPat		contained /[^-'"#!]\S\+/ skipwhite contains=muttrcRXChars nextgroup=muttrcRXPat
syn match muttrcRXDef 		contained "-rx\s\+" skipwhite nextgroup=muttrcRXPat

syn match muttrcSpecial		+\(['"]\)!\1+

syn match muttrcSetStrAssignment contained skipwhite /=\s*\%(\\\?\$\)\?[0-9A-Za-z_-]\+/hs=s+1 nextgroup=muttrcVPrefix,muttrcVarBool,muttrcVarQuad,muttrcVarNum,muttrcVarStr contains=muttrcVariable,muttrcEscapedVariable
syn region muttrcSetStrAssignment contained skipwhite keepend start=+=\s*"+hs=s+1 end=+"+ skip=+\\"+ nextgroup=muttrcVPrefix,muttrcVarBool,muttrcVarQuad,muttrcVarNum,muttrcVarStr contains=muttrcString
syn region muttrcSetStrAssignment contained skipwhite keepend start=+=\s*'+hs=s+1 end=+'+ skip=+\\'+ nextgroup=muttrcVPrefix,muttrcVarBool,muttrcVarQuad,muttrcVarNum,muttrcVarStr contains=muttrcString
syn match muttrcSetBoolAssignment contained skipwhite /=\s*\\\?\$\w\+/hs=s+1 nextgroup=muttrcVPrefix,muttrcVarBool,muttrcVarQuad,muttrcVarNum,muttrcVarStr contains=muttrcVariable,muttrcEscapedVariable
syn match muttrcSetBoolAssignment contained skipwhite /=\s*\%(yes\|no\)/hs=s+1 nextgroup=muttrcVPrefix,muttrcVarBool,muttrcVarQuad,muttrcVarNum,muttrcVarStr
syn match muttrcSetBoolAssignment contained skipwhite /=\s*"\%(yes\|no\)"/hs=s+1 nextgroup=muttrcVPrefix,muttrcVarBool,muttrcVarQuad,muttrcVarNum,muttrcVarStr
syn match muttrcSetBoolAssignment contained skipwhite /=\s*'\%(yes\|no\)'/hs=s+1 nextgroup=muttrcVPrefix,muttrcVarBool,muttrcVarQuad,muttrcVarNum,muttrcVarStr
syn match muttrcSetQuadAssignment contained skipwhite /=\s*\\\?\$\w\+/hs=s+1 nextgroup=muttrcVPrefix,muttrcVarBool,muttrcVarQuad,muttrcVarNum,muttrcVarStr contains=muttrcVariable,muttrcEscapedVariable
syn match muttrcSetQuadAssignment contained skipwhite /=\s*\%(ask-\)\?\%(yes\|no\)/hs=s+1 nextgroup=muttrcVPrefix,muttrcVarBool,muttrcVarQuad,muttrcVarNum,muttrcVarStr
syn match muttrcSetQuadAssignment contained skipwhite /=\s*"\%(ask-\)\?\%(yes\|no\)"/hs=s+1 nextgroup=muttrcVPrefix,muttrcVarBool,muttrcVarQuad,muttrcVarNum,muttrcVarStr
syn match muttrcSetQuadAssignment contained skipwhite /=\s*'\%(ask-\)\?\%(yes\|no\)'/hs=s+1 nextgroup=muttrcVPrefix,muttrcVarBool,muttrcVarQuad,muttrcVarNum,muttrcVarStr
syn match muttrcSetNumAssignment contained skipwhite /=\s*\\\?\$\w\+/hs=s+1 nextgroup=muttrcVPrefix,muttrcVarBool,muttrcVarQuad,muttrcVarNum,muttrcVarStr contains=muttrcVariable,muttrcEscapedVariable
syn match muttrcSetNumAssignment contained skipwhite /=\s*\d\+/hs=s+1 nextgroup=muttrcVPrefix,muttrcVarBool,muttrcVarQuad,muttrcVarNum,muttrcVarStr
syn match muttrcSetNumAssignment contained skipwhite /=\s*"\d\+"/hs=s+1 nextgroup=muttrcVPrefix,muttrcVarBool,muttrcVarQuad,muttrcVarNum,muttrcVarStr
syn match muttrcSetNumAssignment contained skipwhite /=\s*'\d\+'/hs=s+1 nextgroup=muttrcVPrefix,muttrcVarBool,muttrcVarQuad,muttrcVarNum,muttrcVarStr

" Now catch some email addresses and headers (purified version from mail.vim)
syn match muttrcEmail		"[a-zA-Z0-9._-]\+@[a-zA-Z0-9./-]\+"
syn match muttrcHeader		"\<\c\%(From\|To\|C[Cc]\|B[Cc][Cc]\|Reply-To\|Subject\|Return-Path\|Received\|Date\|Replied\|Attach\)\>:\="

syn match   muttrcKeySpecial	contained +\%(\\[Cc'"]\|\^\|\\[01]\d\{2}\)+
syn match   muttrcKey		contained "\S\+"			contains=muttrcKeySpecial,muttrcKeyName
syn region  muttrcKey		contained start=+"+ skip=+\\\\\|\\"+ end=+"+	contains=muttrcKeySpecial,muttrcKeyName
syn region  muttrcKey		contained start=+'+ skip=+\\\\\|\\'+ end=+'+	contains=muttrcKeySpecial,muttrcKeyName
syn match   muttrcKeyName	contained "\<f\%(\d\|10\)\>"
syn match   muttrcKeyName	contained "\\[trne]"
syn match   muttrcKeyName	contained "\c<\%(BackSpace\|BackTab\|Delete\|Down\|End\|Enter\|Esc\|Home\|Insert\|Left\|PageDown\|PageUp\|Return\|Right\|Space\|Tab\|Up\)>"
syn match   muttrcKeyName	contained "<F[0-9]\+>"

syn keyword muttrcVarBool	skipwhite contained 
			\ allow_8bit allow_ansi arrow_cursor ascii_chars askbcc askcc attach_split
			\ auto_tag autoedit auto_subscribe background_edit background_confirm_quit beep beep_new
			\ bounce_delivered braille_friendly browser_abbreviate_mailboxes browser_sticky_cursor
			\ change_folder_next check_mbox_size check_new collapse_unread compose_confirm_detach_first
			\ confirmappend confirmcreate copy_decode_weed count_alternatives crypt_autoencrypt crypt_autopgp
			\ crypt_autosign crypt_autosmime crypt_confirmhook crypt_protected_headers_read
			\ crypt_protected_headers_save crypt_protected_headers_write crypt_opportunistic_encrypt
			\ crypt_opportunistic_encrypt_strong_keys crypt_replyencrypt crypt_replysign
			\ crypt_replysignencrypted crypt_timestamp crypt_use_gpgme crypt_use_pka cursor_overlay
			\ delete_untag digest_collapse duplicate_threads edit_hdrs edit_headers encode_from
			\ envelope_from fast_reply fcc_before_send fcc_clear flag_safe followup_to force_name forw_decode
			\ forw_decrypt forw_quote forward_decode forward_quote hdrs header
			\ header_color_partial help hidden_host hide_limited hide_missing hide_thread_subject
			\ hide_top_limited hide_top_missing history_remove_dups honor_disposition idn_decode idn_encode
			\ ignore_linear_white_space ignore_list_reply_to imap_check_subscribed imap_condstore imap_deflate
			\ imap_list_subscribed imap_passive imap_peek imap_qresync imap_servernoise
			\ implicit_autoview include_encrypted include_onlyfirst keep_flagged local_date_header
			\ mail_check_recent mail_check_stats mailcap_sanitize maildir_check_cur
			\ maildir_header_cache_verify maildir_trash mark_old markers menu_move_off
			\ menu_scroll message_cache_clean meta_key metoo mh_purge mime_forward_decode
			\ mime_type_query_first muttlisp_inline_eval narrow_tree pager_stop pgp_auto_decode
			\ pgp_auto_traditional pgp_autoencrypt pgp_autoinline pgp_autosign
			\ pgp_check_exit pgp_check_gpg_decrypt_status_fd pgp_create_traditional
			\ pgp_ignore_subkeys pgp_long_ids pgp_replyencrypt pgp_replyinline
			\ pgp_replysign pgp_replysignencrypted pgp_retainable_sigs pgp_self_encrypt
			\ pgp_self_encrypt_as pgp_show_unusable pgp_strict_enc pgp_use_gpg_agent
			\ pipe_decode pipe_decode_weed pipe_split pop_auth_try_all pop_last postpone_encrypt
			\ postpone_encrypt_as print_decode print_decode_weed print_split prompt_after read_only
			\ reflow_space_quotes reflow_text reflow_wrap reply_self resolve
			\ resume_draft_files resume_edited_draft_files reverse_alias reverse_name
			\ reverse_realname rfc2047_parameters save_address save_empty save_name score
			\ sidebar_folder_indent sidebar_new_mail_only sidebar_next_new_wrap
			\ sidebar_relative_shortpath_indent sidebar_short_path sidebar_sort sidebar_use_mailbox_shortcuts
			\ sidebar_visible sig_on_top sig_dashes size_show_bytes size_show_fraction size_show_mb
			\ size_units_on_left smart_wrap smime_ask_cert_label smime_decrypt_use_default_key
			\ smime_is_default smime_self_encrypt smime_self_encrypt_as sort_re
			\ ssl_force_tls ssl_use_sslv2 ssl_use_sslv3 ssl_use_tlsv1 ssl_use_tlsv1_3 ssl_usesystemcerts
			\ ssl_verify_dates ssl_verify_host ssl_verify_partial_chains status_on_top
			\ strict_mime strict_threads suspend text_flowed thorough_search
			\ thread_received tilde ts_enabled tunnel_is_secure uncollapse_jump use_8bitmime use_domain
			\ use_envelope_from use_from use_idn use_ipv6 uncollapse_new user_agent
			\ wait_key weed wrap_search write_bcc
			\ nextgroup=muttrcSetBoolAssignment,muttrcVPrefix,muttrcVarBool,muttrcVarQuad,muttrcVarNum,muttrcVarStr

syn keyword muttrcVarBool	skipwhite contained 
			\ noallow_8bit noallow_ansi noarrow_cursor noascii_chars noaskbcc noaskcc
			\ noattach_split noauto_tag noautoedit noauto_subscribe nobackground_edit
			\ nobackground_confirm_quit nobeep nobeep_new nobounce_delivered
			\ nobraille_friendly nobrowser_abbreviate_mailboxes nobrowser_sticky_cursor nochange_folder_next
			\ nocheck_mbox_size nocheck_new nocompose_confirm_detach_first nocollapse_unread noconfirmappend
			\ noconfirmcreate nocopy_decode_weed nocount_alternatives nocrypt_autoencrypt nocrypt_autopgp
			\ nocrypt_autosign nocrypt_autosmime nocrypt_confirmhook nocrypt_protected_headers_read
			\ nocrypt_protected_headers_save nocrypt_protected_headers_write nocrypt_opportunistic_encrypt
			\ nocrypt_opportunistic_encrypt_strong_keys nocrypt_replyencrypt nocrypt_replysign
			\ nocrypt_replysignencrypted nocrypt_timestamp nocrypt_use_gpgme nocrypt_use_pka nocursor_overlay
			\ nodelete_untag nodigest_collapse noduplicate_threads noedit_hdrs noedit_headers
			\ noencode_from noenvelope_from nofast_reply nofcc_before_send nofcc_clear noflag_safe
			\ nofollowup_to noforce_name noforw_decode noforw_decrypt noforw_quote
			\ noforward_decode noforward_quote nohdrs noheader
			\ noheader_color_partial nohelp nohidden_host nohide_limited nohide_missing
			\ nohide_thread_subject nohide_top_limited nohide_top_missing
			\ nohistory_remove_dups nohonor_disposition noidn_decode noidn_encode
			\ noignore_linear_white_space noignore_list_reply_to noimap_check_subscribed
			\ noimap_condstore noimap_deflate noimap_list_subscribed noimap_passive noimap_peek
			\ noimap_qresync noimap_servernoise noimplicit_autoview noinclude_encrypted noinclude_onlyfirst
			\ nokeep_flagged nolocal_date_header nomail_check_recent nomail_check_stats nomailcap_sanitize
			\ nomaildir_check_cur nomaildir_header_cache_verify nomaildir_trash nomark_old
			\ nomarkers nomenu_move_off nomenu_scroll nomessage_cache_clean nometa_key
			\ nometoo nomh_purge nomime_forward_decode nomime_type_query_first nomuttlisp_inline_eval
			\ nonarrow_tree nopager_stop nopgp_auto_decode nopgp_auto_traditional nopgp_autoencrypt
			\ nopgp_autoinline nopgp_autosign nopgp_check_exit
			\ nopgp_check_gpg_decrypt_status_fd nopgp_create_traditional
			\ nopgp_ignore_subkeys nopgp_long_ids nopgp_replyencrypt nopgp_replyinline
			\ nopgp_replysign nopgp_replysignencrypted nopgp_retainable_sigs
			\ nopgp_self_encrypt nopgp_self_encrypt_as nopgp_show_unusable
			\ nopgp_strict_enc nopgp_use_gpg_agent nopipe_decode nopipe_decode_weed nopipe_split
			\ nopop_auth_try_all nopop_last nopostpone_encrypt nopostpone_encrypt_as
			\ noprint_decode noprint_decode_weed noprint_split noprompt_after noread_only
			\ noreflow_space_quotes noreflow_text noreflow_wrap noreply_self noresolve
			\ noresume_draft_files noresume_edited_draft_files noreverse_alias
			\ noreverse_name noreverse_realname norfc2047_parameters nosave_address
			\ nosave_empty nosave_name noscore nosidebar_folder_indent
			\ nosidebar_new_mail_only nosidebar_next_new_wrap nosidebar_relative_shortpath_indent
			\ nosidebar_short_path nosidebar_sort nosidebar_visible nosidebar_use_mailbox_shortcuts
			\ nosig_dashes nosig_on_top nosize_show_bytes nosize_show_fraction nosize_show_mb
			\ nosize_units_on_left nosmart_wrap nosmime_ask_cert_label nosmime_decrypt_use_default_key
			\ nosmime_is_default nosmime_self_encrypt nosmime_self_encrypt_as nosort_re nossl_force_tls
			\ nossl_use_sslv2 nossl_use_sslv3 nossl_use_tlsv1 nossl_use_tlsv1_3 nossl_usesystemcerts
			\ nossl_verify_dates nossl_verify_host nossl_verify_partial_chains
			\ nostatus_on_top nostrict_mime nostrict_threads nosuspend notext_flowed
			\ nothorough_search nothread_received notilde nots_enabled notunnel_is_secure nouncollapse_jump
			\ nouse_8bitmime nouse_domain nouse_envelope_from nouse_from nouse_idn
			\ nouse_ipv6 nouncollapse_new nouser_agent nowait_key noweed nowrap_search
			\ nowrite_bcc
			\ nextgroup=muttrcVPrefix,muttrcVarBool,muttrcVarQuad,muttrcVarNum,muttrcVarStr

syn keyword muttrcVarBool	skipwhite contained
			\ invallow_8bit invallow_ansi invarrow_cursor invascii_chars invaskbcc
			\ invaskcc invattach_split invauto_tag invautoedit invauto_subscribe nobackground_edit
			\ nobackground_confirm_quit invbeep invbeep_new invbounce_delivered invbraille_friendly
			\ invbrowser_abbreviate_mailboxes invbrowser_sticky_cursor invchange_folder_next
			\ invcheck_mbox_size invcheck_new invcollapse_unread invcompose_confirm_detach_first
			\ invconfirmappend invcopy_decode_weed invconfirmcreate invcount_alternatives invcrypt_autopgp
			\ invcrypt_autoencrypt invcrypt_autosign invcrypt_autosmime invcrypt_confirmhook
			\ invcrypt_protected_headers_read invcrypt_protected_headers_save invcrypt_protected_headers_write
			\ invcrypt_opportunistic_encrypt invcrypt_opportunistic_encrypt_strong_keys invcrypt_replysign
			\ invcrypt_replyencrypt invcrypt_replysignencrypted invcrypt_timestamp invcrypt_use_gpgme
			\ invcrypt_use_pka invcursor_overlay invdelete_untag invdigest_collapse invduplicate_threads
			\ invedit_hdrs invedit_headers invencode_from invenvelope_from invfast_reply
			\ invfcc_before_send invfcc_clear invflag_safe invfollowup_to invforce_name invforw_decode
			\ invforw_decrypt invforw_quote invforward_decode
			\ invforward_quote invhdrs invheader invheader_color_partial invhelp
			\ invhidden_host invhide_limited invhide_missing invhide_thread_subject
			\ invhide_top_limited invhide_top_missing invhistory_remove_dups
			\ invhonor_disposition invidn_decode invidn_encode
			\ invignore_linear_white_space invignore_list_reply_to
			\ invimap_check_subscribed invimap_condstore invimap_deflate invimap_list_subscribed
			\ invimap_passive invimap_peek invimap_qresync invimap_servernoise invimplicit_autoview
			\ invinclude_encrypted invinclude_onlyfirst invkeep_flagged invlocal_date_header
			\ invmail_check_recent invmail_check_stats invmailcap_sanitize invmaildir_check_cur
			\ invmaildir_header_cache_verify invmaildir_trash invmark_old invmarkers invmenu_move_off
			\ invmenu_scroll invmessage_cache_clean invmeta_key invmetoo invmh_purge
			\ invmime_forward_decode invmime_type_query_first invmuttlisp_inline_eval invnarrow_tree
			\ invpager_stop invpgp_auto_decode invpgp_auto_traditional invpgp_autoencrypt
			\ invpgp_autoinline invpgp_autosign invpgp_check_exit
			\ invpgp_check_gpg_decrypt_status_fd invpgp_create_traditional
			\ invpgp_ignore_subkeys invpgp_long_ids invpgp_replyencrypt invpgp_replyinline
			\ invpgp_replysign invpgp_replysignencrypted invpgp_retainable_sigs
			\ invpgp_self_encrypt invpgp_self_encrypt_as invpgp_show_unusable
			\ invpgp_strict_enc invpgp_use_gpg_agent invpipe_decode invpipe_decode_weed invpipe_split
			\ invpop_auth_try_all invpop_last invpostpone_encrypt invpostpone_encrypt_as
			\ invprint_decode invprint_decode_weed invprint_split invprompt_after invread_only
			\ invreflow_space_quotes invreflow_text invreflow_wrap invreply_self invresolve
			\ invresume_draft_file sinvresume_edited_draft_files invreverse_alias
			\ invreverse_name invreverse_realname invrfc2047_parameters invsave_address
			\ invsave_empty invsave_name invscore invsidebar_folder_indent
			\ invsidebar_new_mail_only invsidebar_next_new_wrap invsidebar_relative_shortpath_indent
			\ invsidebar_short_path invsidebar_sort sidebar_use_mailbox_shortcuts invsidebar_visible
			\ invsig_dashes invsig_on_top invsize_show_bytes invsize_show_fraction invsize_show_mb
			\ invsize_units_on_left invsmart_wrap invsmime_ask_cert_label invsmime_decrypt_use_default_key
			\ invsmime_is_default invsmime_self_encrypt invsmime_self_encrypt_as invsort_re invssl_force_tls
			\ invssl_use_sslv2 invssl_use_sslv3 invssl_use_tlsv1 invssl_use_tlsv1_3 invssl_usesystemcerts
			\ invssl_verify_dates invssl_verify_host invssl_verify_partial_chains
			\ invstatus_on_top invstrict_mime invstrict_threads invsuspend invtext_flowed
			\ invthorough_search invthread_received invtilde invts_enabled invtunnel_is_secure
			\ invuncollapse_jump invuse_8bitmime invuse_domain invuse_envelope_from
			\ invuse_from invuse_idn invuse_ipv6 invuncollapse_new invuser_agent
			\ invwait_key invweed invwrap_search invwrite_bcc
			\ nextgroup=muttrcVPrefi