From 957d903cb7af41539efd3195d053293987af85d9 Mon Sep 17 00:00:00 2001 From: "K.Takata" Date: Mon, 20 May 2024 21:13:35 +0900 Subject: runtime(arduino): Add Arduino ftplugin and indent files (#14811) We already have Arduino syntax file, but we didn't have ftplugin and indent files. This commit adds a basic ftplugin file and a basic indent file. Both of them are derived from {ftplugin,indent}/c.vim. Signed-off-by: Ken Takata Signed-off-by: Christian Brabandt --- runtime/doc/filetype.txt | 12 ++++++++ runtime/doc/tags | 1 + runtime/ftplugin/arduino.vim | 66 ++++++++++++++++++++++++++++++++++++++++++++ runtime/indent/arduino.vim | 16 +++++++++++ 4 files changed, 95 insertions(+) create mode 100644 runtime/ftplugin/arduino.vim create mode 100644 runtime/indent/arduino.vim (limited to 'runtime') diff --git a/runtime/doc/filetype.txt b/runtime/doc/filetype.txt index f8a8ebec53..8f4dc13858 100644 --- a/runtime/doc/filetype.txt +++ b/runtime/doc/filetype.txt @@ -452,6 +452,18 @@ To disable folding everything under the title use this: > let asciidoc_fold_under_title = 0 +ARDUINO *ft-arduino-plugin* + +By default the following options are set, in accordance with the default +settings of Arduino IDE: > + + setlocal expandtab tabstop=2 softtabstop=2 shiftwidth=2 + +To disable this behavior, set the following variable in your vimrc: > + + let g:arduino_recommended_style = 0 + + AWK *ft-awk-plugin* Support for features specific to GNU Awk, like @include, can be enabled by diff --git a/runtime/doc/tags b/runtime/doc/tags index 2c3fd7f9da..a6bc523392 100644 --- a/runtime/doc/tags +++ b/runtime/doc/tags @@ -7228,6 +7228,7 @@ ft-ada-syntax ft_ada.txt /*ft-ada-syntax* ft-ada-variables ft_ada.txt /*ft-ada-variables* ft-ant-syntax syntax.txt /*ft-ant-syntax* ft-apache-syntax syntax.txt /*ft-apache-syntax* +ft-arduino-plugin filetype.txt /*ft-arduino-plugin* ft-asciidoc-plugin filetype.txt /*ft-asciidoc-plugin* ft-asm-syntax syntax.txt /*ft-asm-syntax* ft-asm68k-syntax syntax.txt /*ft-asm68k-syntax* diff --git a/runtime/ftplugin/arduino.vim b/runtime/ftplugin/arduino.vim new file mode 100644 index 0000000000..dae3dd83d3 --- /dev/null +++ b/runtime/ftplugin/arduino.vim @@ -0,0 +1,66 @@ +" Vim filetype plugin file +" Language: Arduino +" Maintainer: The Vim Project +" Ken Takata +" Last Change: 2024 Apr 12 +" +" Most of the part was copied from c.vim. + +" Only do this when not done yet for this buffer +if exists("b:did_ftplugin") + finish +endif + +" Don't load another plugin for this buffer +let b:did_ftplugin = 1 + +" Using line continuation here. +let s:cpo_save = &cpo +set cpo-=C + +let b:undo_ftplugin = "setl fo< com< ofu< cms< def< inc<" + +if !exists("g:arduino_recommended_style") || g:arduino_recommended_style != 0 + " Use the default setting of Arduino IDE. + setlocal expandtab tabstop=2 softtabstop=2 shiftwidth=2 + let b:undo_ftplugin ..= " et< ts< sts< sw<" +endif + +" Set 'formatoptions' to break comment lines but not other lines, +" and insert the comment leader when hitting or using "o". +setlocal fo-=t fo+=croql + +" These options have the right value as default, but the user may have +" overruled that. +setlocal commentstring& define& include& + +" Set completion with CTRL-X CTRL-O to autoloaded function. +if exists('&ofu') + setlocal ofu=ccomplete#Complete +endif + +" Set 'comments' to format dashed lists in comments. +" Also include ///, used for Doxygen. +setlocal comments=sO:*\ -,mO:*\ \ ,exO:*/,s1:/*,mb:*,ex:*/,:///,:// + +" When the matchit plugin is loaded, this makes the % command skip parens and +" braces in comments properly. +if !exists("b:match_words") + let b:match_words = '^\s*#\s*if\(\|def\|ndef\)\>:^\s*#\s*elif\>:^\s*#\s*else\>:^\s*#\s*endif\>' + let b:match_skip = 's:comment\|string\|character\|special' + let b:undo_ftplugin ..= " | unlet! b:match_skip b:match_words" +endif + +" Win32 and GTK can filter files in the browse dialog +if (has("gui_win32") || has("gui_gtk")) && !exists("b:browsefilter") + let b:browsefilter = "Arduino Source Files (*.ino, *.pde)\t*.ino;*.pde\n" + if has("win32") + let b:browsefilter ..= "All Files (*.*)\t*\n" + else + let b:browsefilter ..= "All Files (*)\t*\n" + endif + let b:undo_ftplugin ..= " | unlet! b:browsefilter" +endif + +let &cpo = s:cpo_save +unlet s:cpo_save diff --git a/runtime/indent/arduino.vim b/runtime/indent/arduino.vim new file mode 100644 index 0000000000..88717ac00d --- /dev/null +++ b/runtime/indent/arduino.vim @@ -0,0 +1,16 @@ +" Vim indent file +" Language: Arduino +" Maintainer: The Vim Project +" Ken Takata +" Last Change: 2024 Apr 03 + +" Only load this indent file when no other was loaded. +if exists("b:did_indent") + finish +endif +let b:did_indent = 1 + +" Use C indenting. +setlocal cindent + +let b:undo_indent = "setl cin<" -- cgit v1.2.3