Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Generate vim syntax based on the documentation #99

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Generate vim syntax based on the documentation #99

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion man/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
TARGETS := flashmq.1 flashmq.conf.5 flashmq.1.html flashmq.conf.5.html
TARGETS := flashmq.1 flashmq.conf.5 flashmq.1.html flashmq.conf.5.html flashmq.vim

all: $(TARGETS)

Expand Down Expand Up @@ -29,3 +29,6 @@ clean:

%.html: docbook5-to-html5/docbook5-to-html5.xsl %.dbk5
xsltproc --xinclude --stringparam dbk5.reference $(CURDIR)/reference.dbk5 $^ > $@

%.vim: flashmq.conf.5.dbk5
vim/syntax.generate.sh vim/syntax.template.vim flashmq.conf.5.dbk5 > $@
24 changes: 12 additions & 12 deletions man/flashmq.conf.5.dbk5
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -596,7 +596,7 @@ multi-value-param one 'two' "three" "with ' char"
Listen parameters can only be used within <literal>listen { }</literal> blocks.
</para>
<variablelist>
<varlistentry xml:id="port">
<varlistentry xml:id="listen__port">
<term><option>port</option></term>
<listitem>
<para>
Expand Down Expand Up @@ -626,7 +626,7 @@ multi-value-param one 'two' "three" "with ' char"
</itemizedlist>
</listitem>
</varlistentry>
<varlistentry xml:id="protocol">
<varlistentry xml:id="listen__protocol">
<term><option>protocol</option></term>
<listitem>
<para>
Expand All @@ -642,7 +642,7 @@ multi-value-param one 'two' "three" "with ' char"
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="inet_protocol">
<varlistentry xml:id="listen__inet_protocol">
<term><option>inet_protocol</option></term>
<listitem>
<para>
Expand All @@ -664,31 +664,31 @@ multi-value-param one 'two' "three" "with ' char"
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="inet4_bind_address">
<varlistentry xml:id="listen__inet4_bind_address">
<term><option>inet4_bind_address</option> <replaceable>inet4address</replaceable></term>
<listitem>
<para>
Default: 0.0.0.0
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="inet6_bind_address">
<varlistentry xml:id="listen__inet6_bind_address">
<term><option>inet6_bind_address</option> <replaceable>inet6address</replaceable></term>
<listitem>
<para>
Default: ::0
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="fullchain">
<varlistentry xml:id="listen__fullchain">
<term><option>fullchain</option> <replaceable>/foobar/server.crt</replaceable></term>
<listitem>
<para>
Specifying a chain makes the listener SSL, and also requires the <option>privkey</option> to be set.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="privkey">
<varlistentry xml:id="listen__privkey">
<term><option>privkey</option> <replaceable>/foobar/server.key</replaceable></term>
<listitem>
<para>
Expand All @@ -697,7 +697,7 @@ multi-value-param one 'two' "three" "with ' char"
</listitem>
</varlistentry>

<varlistentry xml:id="client_verification_ca_file">
<varlistentry xml:id="listen__client_verification_ca_file">
<term><option>client_verification_ca_file</option> <replaceable>/foobar/client_authority.crt</replaceable></term>
<listitem>
<para>
Expand All @@ -709,7 +709,7 @@ multi-value-param one 'two' "three" "with ' char"
</listitem>
</varlistentry>

<varlistentry xml:id="client_verification_ca_dir">
<varlistentry xml:id="listen__client_verification_ca_dir">
<term><option>client_verification_ca_dir</option> <replaceable>/foobar/dir_with_certificates</replaceable></term>
<listitem>
<para>
Expand All @@ -724,7 +724,7 @@ multi-value-param one 'two' "three" "with ' char"
</listitem>
</varlistentry>

<varlistentry xml:id="client_verification_still_do_authn">
<varlistentry xml:id="listen__client_verification_still_do_authn">
<term><option>client_verification_still_do_authn</option> <replaceable>true/false</replaceable></term>
<listitem>
<para>
Expand All @@ -742,7 +742,7 @@ multi-value-param one 'two' "three" "with ' char"
</listitem>
</varlistentry>

<varlistentry xml:id="haproxy">
<varlistentry xml:id="listen__haproxy">
<term><option>haproxy</option> <replaceable>true/false</replaceable></term>
<listitem>
<para>
Expand All @@ -760,7 +760,7 @@ multi-value-param one 'two' "three" "with ' char"
</listitem>
</varlistentry>

<varlistentry xml:id="tcp_nodelay">
<varlistentry xml:id="listen__tcp_nodelay">
<term><option>tcp_nodelay</option> <replaceable>true/false</replaceable></term>
<listitem>
<para>
Expand Down
211 changes: 211 additions & 0 deletions man/flashmq.vim
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,211 @@
" Vim syntax file
" Language: FlashMQ configuration file

"
" Goals:
"
" Make incorrect / unknown options stand out. Special attention is given to
" also have this work correctly for blocks, E.G., the toplevel directive
" `log_file` is colored in a global scope but not when it's used inside a
" `listen` block
"
" https://vimdoc.sourceforge.net/htmldoc/syntax.html
"
" TODO:
" - Test number of arguments, specifically: most options take 1 argument, but
" fe. bridge__subscribe takes an optional second argument
" - Deal with quoted options?
"

if exists("b:current_syntax")
finish
endif
let b:current_syntax = "flashmq"

syn region fmqComment display oneline start='^\s*#' end='$'

" We "render" fmqWrongBlock as Error (which makes it red), but then also use
" transparent which makes it be the color of the parent, so it all becomes a
" neutral color.
" Without the transparent+Error trick you would see fmqTopLevelDirective
" highlighted inside blocks which is undesirable: you can't specify `log_file`
" inside a `listen` block, so it shouldn't get colorized.
"
" Real blocks (like `listen` and `bridge`) are defined later and thus get a
" higher priority, and will replace this match.
syn region fmqWrongBlock start=+^.*{+ end=+}+ transparent contains=NONE,fmqComment

hi link fmqComment Comment
hi link fmqWrongBlock Error
hi link fmqTopLevelDirective Type

" The rest of this file has been dynamically generated
"
" Local scopes
"

syn match fmqTopLevelDirective "^\s*allow_anonymous\s"
syn match fmqTopLevelDirective "^\s*allow_anonymous$"
syn match fmqTopLevelDirective "^\s*allow_unsafe_clientid_chars\s"
syn match fmqTopLevelDirective "^\s*allow_unsafe_clientid_chars$"
syn match fmqTopLevelDirective "^\s*allow_unsafe_username_chars\s"
syn match fmqTopLevelDirective "^\s*allow_unsafe_username_chars$"
syn match fmq_bridge_Directive "^\s*address\s" contained
syn match fmq_bridge_Directive "^\s*address$" contained
syn match fmq_bridge_Directive "^\s*bridge_protocol_bit\s" contained
syn match fmq_bridge_Directive "^\s*bridge_protocol_bit$" contained
syn match fmq_bridge_Directive "^\s*ca_dir\s" contained
syn match fmq_bridge_Directive "^\s*ca_dir$" contained
syn match fmq_bridge_Directive "^\s*ca_file\s" contained
syn match fmq_bridge_Directive "^\s*ca_file$" contained
syn match fmq_bridge_Directive "^\s*clientid_prefix\s" contained
syn match fmq_bridge_Directive "^\s*clientid_prefix$" contained
syn match fmq_bridge_Directive "^\s*inet_protocol\s" contained
syn match fmq_bridge_Directive "^\s*inet_protocol$" contained
syn match fmq_bridge_Directive "^\s*keepalive\s" contained
syn match fmq_bridge_Directive "^\s*keepalive$" contained
syn match fmq_bridge_Directive "^\s*local_clean_start\s" contained
syn match fmq_bridge_Directive "^\s*local_clean_start$" contained
syn match fmq_bridge_Directive "^\s*local_session_expiry_interval\s" contained
syn match fmq_bridge_Directive "^\s*local_session_expiry_interval$" contained
syn match fmq_bridge_Directive "^\s*local_username\s" contained
syn match fmq_bridge_Directive "^\s*local_username$" contained
syn match fmq_bridge_Directive "^\s*max_incoming_topic_aliases\s" contained
syn match fmq_bridge_Directive "^\s*max_incoming_topic_aliases$" contained
syn match fmq_bridge_Directive "^\s*max_outgoing_topic_aliases\s" contained
syn match fmq_bridge_Directive "^\s*max_outgoing_topic_aliases$" contained
syn match fmq_bridge_Directive "^\s*port\s" contained
syn match fmq_bridge_Directive "^\s*port$" contained
syn match fmq_bridge_Directive "^\s*protocol_version\s" contained
syn match fmq_bridge_Directive "^\s*protocol_version$" contained
syn match fmq_bridge_Directive "^\s*publish\s" contained
syn match fmq_bridge_Directive "^\s*publish$" contained
syn match fmq_bridge_Directive "^\s*remote_clean_start\s" contained
syn match fmq_bridge_Directive "^\s*remote_clean_start$" contained
syn match fmq_bridge_Directive "^\s*remote_password\s" contained
syn match fmq_bridge_Directive "^\s*remote_password$" contained
syn match fmq_bridge_Directive "^\s*remote_retain_available\s" contained
syn match fmq_bridge_Directive "^\s*remote_retain_available$" contained
syn match fmq_bridge_Directive "^\s*remote_session_expiry_interval\s" contained
syn match fmq_bridge_Directive "^\s*remote_session_expiry_interval$" contained
syn match fmq_bridge_Directive "^\s*remote_username\s" contained
syn match fmq_bridge_Directive "^\s*remote_username$" contained
syn match fmq_bridge_Directive "^\s*subscribe\s" contained
syn match fmq_bridge_Directive "^\s*subscribe$" contained
syn match fmq_bridge_Directive "^\s*tcp_nodelay\s" contained
syn match fmq_bridge_Directive "^\s*tcp_nodelay$" contained
syn match fmq_bridge_Directive "^\s*tls\s" contained
syn match fmq_bridge_Directive "^\s*tls$" contained
syn match fmq_bridge_Directive "^\s*use_saved_clientid\s" contained
syn match fmq_bridge_Directive "^\s*use_saved_clientid$" contained
syn match fmqTopLevelDirective "^\s*client_initial_buffer_size\s"
syn match fmqTopLevelDirective "^\s*client_initial_buffer_size$"
syn match fmqTopLevelDirective "^\s*client_max_write_buffer_size\s"
syn match fmqTopLevelDirective "^\s*client_max_write_buffer_size$"
syn match fmqTopLevelDirective "^\s*expire_retained_messages_after_seconds\s"
syn match fmqTopLevelDirective "^\s*expire_retained_messages_after_seconds$"
syn match fmqTopLevelDirective "^\s*expire_sessions_after_seconds\s"
syn match fmqTopLevelDirective "^\s*expire_sessions_after_seconds$"
syn match fmqTopLevelDirective "^\s*include_dir\s"
syn match fmqTopLevelDirective "^\s*include_dir$"
syn match fmq_listen_Directive "^\s*allow_anonymous\s" contained
syn match fmq_listen_Directive "^\s*allow_anonymous$" contained
syn match fmq_listen_Directive "^\s*client_verification_ca_dir\s" contained
syn match fmq_listen_Directive "^\s*client_verification_ca_dir$" contained
syn match fmq_listen_Directive "^\s*client_verification_ca_file\s" contained
syn match fmq_listen_Directive "^\s*client_verification_ca_file$" contained
syn match fmq_listen_Directive "^\s*client_verification_still_do_authn\s" contained
syn match fmq_listen_Directive "^\s*client_verification_still_do_authn$" contained
syn match fmq_listen_Directive "^\s*fullchain\s" contained
syn match fmq_listen_Directive "^\s*fullchain$" contained
syn match fmq_listen_Directive "^\s*haproxy\s" contained
syn match fmq_listen_Directive "^\s*haproxy$" contained
syn match fmq_listen_Directive "^\s*inet4_bind_address\s" contained
syn match fmq_listen_Directive "^\s*inet4_bind_address$" contained
syn match fmq_listen_Directive "^\s*inet6_bind_address\s" contained
syn match fmq_listen_Directive "^\s*inet6_bind_address$" contained
syn match fmq_listen_Directive "^\s*inet_protocol\s" contained
syn match fmq_listen_Directive "^\s*inet_protocol$" contained
syn match fmq_listen_Directive "^\s*port\s" contained
syn match fmq_listen_Directive "^\s*port$" contained
syn match fmq_listen_Directive "^\s*privkey\s" contained
syn match fmq_listen_Directive "^\s*privkey$" contained
syn match fmq_listen_Directive "^\s*protocol\s" contained
syn match fmq_listen_Directive "^\s*protocol$" contained
syn match fmq_listen_Directive "^\s*tcp_nodelay\s" contained
syn match fmq_listen_Directive "^\s*tcp_nodelay$" contained
syn match fmqTopLevelDirective "^\s*log_debug\s"
syn match fmqTopLevelDirective "^\s*log_debug$"
syn match fmqTopLevelDirective "^\s*log_file\s"
syn match fmqTopLevelDirective "^\s*log_file$"
syn match fmqTopLevelDirective "^\s*log_level\s"
syn match fmqTopLevelDirective "^\s*log_level$"
syn match fmqTopLevelDirective "^\s*log_subscriptions\s"
syn match fmqTopLevelDirective "^\s*log_subscriptions$"
syn match fmqTopLevelDirective "^\s*max_event_loop_drift\s"
syn match fmqTopLevelDirective "^\s*max_event_loop_drift$"
syn match fmqTopLevelDirective "^\s*max_incoming_topic_alias_value\s"
syn match fmqTopLevelDirective "^\s*max_incoming_topic_alias_value$"
syn match fmqTopLevelDirective "^\s*max_outgoing_topic_alias_value\s"
syn match fmqTopLevelDirective "^\s*max_outgoing_topic_alias_value$"
syn match fmqTopLevelDirective "^\s*max_packet_size\s"
syn match fmqTopLevelDirective "^\s*max_packet_size$"
syn match fmqTopLevelDirective "^\s*minimum_wildcard_subscription_depth\s"
syn match fmqTopLevelDirective "^\s*minimum_wildcard_subscription_depth$"
syn match fmqTopLevelDirective "^\s*mosquitto_acl_file\s"
syn match fmqTopLevelDirective "^\s*mosquitto_acl_file$"
syn match fmqTopLevelDirective "^\s*mosquitto_password_file\s"
syn match fmqTopLevelDirective "^\s*mosquitto_password_file$"
syn match fmqTopLevelDirective "^\s*overload_mode\s"
syn match fmqTopLevelDirective "^\s*overload_mode$"
syn match fmqTopLevelDirective "^\s*plugin\s"
syn match fmqTopLevelDirective "^\s*plugin$"
syn match fmqTopLevelDirective "^\s*plugin_opt_\s"
syn match fmqTopLevelDirective "^\s*plugin_opt_$"
syn match fmqTopLevelDirective "^\s*plugin_serialize_auth_checks\s"
syn match fmqTopLevelDirective "^\s*plugin_serialize_auth_checks$"
syn match fmqTopLevelDirective "^\s*plugin_serialize_init\s"
syn match fmqTopLevelDirective "^\s*plugin_serialize_init$"
syn match fmqTopLevelDirective "^\s*plugin_timer_period\s"
syn match fmqTopLevelDirective "^\s*plugin_timer_period$"
syn match fmqTopLevelDirective "^\s*quiet\s"
syn match fmqTopLevelDirective "^\s*quiet$"
syn match fmqTopLevelDirective "^\s*retained_messages_delivery_limit\s"
syn match fmqTopLevelDirective "^\s*retained_messages_delivery_limit$"
syn match fmqTopLevelDirective "^\s*retained_messages_mode\s"
syn match fmqTopLevelDirective "^\s*retained_messages_mode$"
syn match fmqTopLevelDirective "^\s*retained_messages_node_limit\s"
syn match fmqTopLevelDirective "^\s*retained_messages_node_limit$"
syn match fmqTopLevelDirective "^\s*rlimit_nofile\s"
syn match fmqTopLevelDirective "^\s*rlimit_nofile$"
syn match fmqTopLevelDirective "^\s*shared_subscription_targeting\s"
syn match fmqTopLevelDirective "^\s*shared_subscription_targeting$"
syn match fmqTopLevelDirective "^\s*storage_dir\s"
syn match fmqTopLevelDirective "^\s*storage_dir$"
syn match fmqTopLevelDirective "^\s*thread_count\s"
syn match fmqTopLevelDirective "^\s*thread_count$"
syn match fmqTopLevelDirective "^\s*websocket_set_real_ip_from\s"
syn match fmqTopLevelDirective "^\s*websocket_set_real_ip_from$"
syn match fmqTopLevelDirective "^\s*wildcard_subscription_deny_mode\s"
syn match fmqTopLevelDirective "^\s*wildcard_subscription_deny_mode$"
syn match fmqTopLevelDirective "^\s*wills_enabled\s"
syn match fmqTopLevelDirective "^\s*wills_enabled$"
syn match fmqTopLevelDirective "^\s*zero_byte_username_is_anonymous\s"
syn match fmqTopLevelDirective "^\s*zero_byte_username_is_anonymous$"

"
" Global scopes
"

syn region fmq_bridge_InnerBlock start="{" end="}" contains=fmq_bridge_Directive,fmqComment
syn region fmq_bridge_Block start="^bridge\s" end="$" contains=fmq_bridge_InnerBlock
syn region fmq_bridge_Block start="^bridge$" end="$"
hi link fmq_bridge_Directive Type
hi link fmq_bridge_Block Statement

syn region fmq_listen_InnerBlock start="{" end="}" contains=fmq_listen_Directive,fmqComment
syn region fmq_listen_Block start="^listen\s" end="$" contains=fmq_listen_InnerBlock
syn region fmq_listen_Block start="^listen$" end="$"
hi link fmq_listen_Directive Type
hi link fmq_listen_Block Statement

Loading
Loading