Update to CMake 3.7.1 - but not only

README.md

@@ -1,4 +1,32 @@
 # vim-cmake-syntax
-Vim syntax highlighting rules for modern CMake.
 
-The vim syntax rules shipped with vim are out-of-date. These ones are less so.
+Vim syntax highlighting rules for modern CMakeLists.txt.
+
+Original code from KitWare.
+First hosted on Github by Nicholas Hutchinson.
+Extended and modified by Patrick Boettcher and contributors
+
+Keyword update - refer to syntax/cmake.vim-header.
+
+The code of this repository is integrated in and released with CMake and is pulled
+into the official cmake-distribution "from time to time".
+
+## Installation
+
+With Pathogen
+
+    cd ~/.vim/bundle
+    git clone git://github.com/pboettch/vim-cmake-syntax.git
+
+With Vundle
+
+    " inside .vimrc
+    Plugin 'pboettch/vim-cmake-syntax'
+
+## Test
+
+There is a ever growing test-suite based on ctest located in test/
+
+    cd <build-dir-where-ever-located>
+    cmake path/to/this/repo/test
+    ctest

cmake.vim.in

@@ -0,0 +1,130 @@
+" Vim syntax file
+" Program:      CMake - Cross-Platform Makefile Generator
+" Version:      @VERSION@
+" Language:     CMake
+" Author:       Andy Cedilnik <[email protected]>,
+"               Nicholas Hutchinson <[email protected]>,
+"               Patrick Boettcher <[email protected]>
+" Maintainer:   Dimitri Merejkowsky <[email protected]>
+" Former Maintainer: Karthik Krishnan <[email protected]>
+" Last Change:  @DATE@
+"
+" Licence:      The CMake license applies to this file. See
+"               https://cmake.org/licensing
+"               This implies that distribution with Vim is allowed
+
+if exists("b:current_syntax")
+  finish
+endif
+let s:keepcpo= &cpo
+set cpo&vim
+
+syn region cmakeBracketArgument start="\[\z(=\?\|=[0-9]*\)\[" end="\]\z1\]" contains=cmakeTodo,@Spell
+
+syn region cmakeComment start="#" end="$" contains=cmakeTodo,@Spell
+syn region cmakeBracketComment start="\[\z(=*\)\[" end="\]\z1\]" contains=cmakeTodo,@Spell
+
+syn match cmakeEscaped /\(\\\\\|\\"\|\\n\|\\t\)/ contained
+syn region cmakeRegistry start="\[" end="]" contained oneline contains=cmakeTodo,cmakeEscaped
+
+syn region cmakeGeneratorExpression start="$<" end=">" contained oneline contains=cmakeVariableValue,cmakeProperty,cmakeGeneratorExpressions,cmakeTodo
+
+syn region cmakeString start='"' end='"' contained contains=cmakeTodo,cmakeVariableValue,cmakeEscaped,@Spell
+
+syn region cmakeVariableValue start="${" end="}" contained oneline contains=cmakeVariable,cmakeTodo,cmakeVariableValue
+
+syn region cmakeEnvironment start="$ENV{" end="}" contained oneline contains=cmakeTodo
+
+syn region cmakeArguments start="(" end=")" contains=ALLBUT,cmakeGeneratorExpressions,cmakeCommand,cmakeCommandConditional,cmakeCommandRepeat,cmakeCommandDeprecated,cmakeCommandManuallyAdded,cmakeArguments,cmakeTodo,@Spell
+
+syn case match
+
+syn keyword cmakeProperty contained
+@PROPERTIES@
+
+syn keyword cmakeVariable contained
+@VARIABLE_LIST@
+
+syn keyword cmakeModule contained
+@MODULES@
+
+@KEYWORDS@
+
+syn keyword cmakeGeneratorExpressions contained
+@GENERATOR_EXPRESSIONS@
+
+syn case ignore
+
+syn keyword cmakeCommand
+@COMMAND_LIST@
+            \ nextgroup=cmakeArguments
+
+syn keyword cmakeCommandConditional
+@CONDITIONALS@
+            \ nextgroup=cmakeArguments
+
+syn keyword cmakeCommandRepeat
+@LOOPS@
+            \ nextgroup=cmakeArguments
+
+syn keyword cmakeCommandDeprecated
+@DEPRECATED@
+            \ nextgroup=cmakeArguments
+
+syn case match
+
+syn keyword cmakeTodo
+            \ TODO FIXME XXX
+            \ contained
+
+hi def link cmakeBracketArgument String
+hi def link cmakeBracketComment Comment
+hi def link cmakeCommand Function
+hi def link cmakeCommandConditional Conditional
+hi def link cmakeCommandDeprecated WarningMsg
+hi def link cmakeCommandRepeat Repeat
+hi def link cmakeComment Comment
+hi def link cmakeEnvironment Special
+hi def link cmakeEscaped Special
+hi def link cmakeGeneratorExpression WarningMsg
+hi def link cmakeGeneratorExpressions Constant
+hi def link cmakeModule Include
+hi def link cmakeProperty Constant
+hi def link cmakeRegistry Underlined
+hi def link cmakeString String
+hi def link cmakeTodo TODO
+hi def link cmakeVariableValue Type
+hi def link cmakeVariable Identifier
+
+@KEYWORDS_HIGHLIGHT@
+
+" Manually added - difficult to parse out of documentation
+syn case ignore
+
+syn keyword cmakeCommandManuallyAdded
+            \ configure_package_config_file write_basic_package_version_file
+            \ nextgroup=cmakeArguments
+
+syn case match
+
+syn keyword cmakeKWconfigure_package_config_file contained
+            \ INSTALL_DESTINATION PATH_VARS NO_SET_AND_CHECK_MACRO NO_CHECK_REQUIRED_COMPONENTS_MACRO INSTALL_PREFIX
+
+syn keyword cmakeKWconfigure_package_config_file_constants contained
+            \ AnyNewerVersion SameMajorVersion SameMinorVersion ExactVersion
+
+syn keyword cmakeKWwrite_basic_package_version_file contained
+            \ VERSION COMPATIBILITY
+
+hi def link cmakeCommandManuallyAdded Function
+
+hi def link cmakeKWconfigure_package_config_file ModeMsg
+hi def link cmakeKWwrite_basic_package_version_file ModeMsg
+hi def link cmakeKWconfigure_package_config_file_constants Constant
+
+let b:current_syntax = "cmake"
+
+let &cpo = s:keepcpo
+unlet s:keepcpo
+
+" vim: set nowrap:

extract-upper-case.pl

@@ -0,0 +1,213 @@
+#!/usr/bin/env perl
+
+use strict;
+use warnings;
+use POSIX qw(strftime);
+use JSON;
+use File::Basename;
+
+#my $cmake = "/home/pboettch/devel/upstream/cmake/build/bin/cmake";
+my $cmake = "cmake";
+
+my @variables;
+my @commands;
+my @properties;
+my @modules;
+my %keywords; # command => keyword-list
+
+# find cmake/Modules/ | sed -rn 's/.*CMakeDetermine(.+)Compiler.cmake/\1/p' | sort
+my @languages = qw(ASM ASM_MASM ASM_NASM C CSharp CUDA CXX Fortran Java RC Swift HIP);
+
+# unwanted upper-cases
+my %unwanted = map { $_ => 1 } qw(VS CXX IDE NOTFOUND NO_ DFOO DBAR NEW GNU);
+	# cannot remove ALL - exists for add_custom_command
+
+# control-statements
+my %conditional = map { $_ => 1 } qw(if else elseif endif);
+my %loop = map { $_ => 1 } qw(foreach while endforeach endwhile);
+
+# decrecated
+my %deprecated = map { $_ => 1 } qw(build_name exec_program export_library_dependencies install_files install_programs install_targets link_libraries make_directory output_required_files remove subdir_depends subdirs use_mangled_mesa utility_source variable_requires write_file);
+
+# add some (popular) modules
+push @modules, "ExternalProject", "FetchContent";
+
+# variables
+open(CMAKE, "$cmake --help-variable-list|") or die "could not run cmake";
+while (<CMAKE>) {
+	chomp;
+
+	if (/<(.*?)>/) {
+		if ($1 eq 'LANG') {
+			foreach my $lang (@languages) {
+			(my $V = $_) =~ s/<.*>/$lang/;
+				push @variables, $V;
+			}
+
+			next
+		} else {
+			next; # skip if containing < or >
+		}
+	}
+
+	push @variables, $_;
+}
+close(CMAKE);
+
+# transform all variables in a hash - to be able to use exists later on
+my %variables = map { $_ => 1 } @variables;
+
+# commands
+open(CMAKE, "$cmake --help-command-list|");
+while (my $cmd = <CMAKE>) {
+	chomp $cmd;
+	push @commands, $cmd;
+}
+close(CMAKE);
+
+# now generate a keyword-list per command
+foreach my $cmd (@commands) {
+	my @word = extract_upper("$cmake --help-command $cmd|");
+
+	next if scalar @word == 0;
+
+	$keywords{$cmd} = [ sort keys %{ { map { $_ => 1 } @word } } ];
+}
+
+# and now for modules
+foreach my $mod (@modules) {
+	my @word = extract_upper("$cmake --help-module $mod|");
+
+	next if scalar @word == 0;
+
+	$keywords{$mod} = [ sort keys %{ { map { $_ => 1 } @word } } ];
+}
+
+# and now for generator-expressions
+my @generator_expr = extract_upper("$cmake --help-manual cmake-generator-expressions |");
+
+# properties
+open(CMAKE, "$cmake --help-property-list|");
+while (<CMAKE>) {
+	next if /\</; # skip if containing < or >
+	chomp;
+	push @properties, $_;
+}
+close(CMAKE);
+
+# transform all properties in a hash
+my %properties = map { $_ => 1 } @properties;
+
+# read in manually written files
+my $modules_dir =  dirname(__FILE__) . "/modules";
+opendir(DIR, $modules_dir) || die "can't opendir $modules_dir: $!";
+my @json_files = grep { /\.json$/ && -f "$modules_dir/$_" } readdir(DIR);
+closedir DIR;
+
+foreach my $file (@json_files) {
+	local $/; # Enable 'slurp' mode
+	open my $fh, "<", $modules_dir."/".$file;
+	my $json = <$fh>;
+	close $fh;
+
+	my $mod = decode_json($json);
+	foreach my $var (@{$mod->{variables}}) {
+		$variables{$var} = 1;
+	}
+
+	while (my ($cmd, $keywords) = each %{$mod->{commands}}) {
+		$keywords{$cmd} = [ sort @{$keywords} ];
+	}
+}
+
+# version
+open(CMAKE, "$cmake --version|");
+my $version = 'unknown';
+while (<CMAKE>) {
+	chomp;
+	$version = $_ if /cmake version/;
+}
+close(CMAKE);
+
+# generate cmake.vim
+open(IN,  "<cmake.vim.in") or die "could not read cmake.vim.in";
+open(OUT, ">syntax/cmake.vim") or die "could not write to syntax/cmake.vim";
+
+my @keyword_hi;
+
+while(<IN>)
+{
+	if (m/\@([A-Z0-9_]+)\@/) { # match for @SOMETHING@
+		if ($1 eq "COMMAND_LIST") {
+			# do not include "special" commands in this list
+			my @tmp = grep { ! exists $conditional{$_} and
+			                 ! exists $loop{$_} and
+			                 ! exists $deprecated{$_} } @commands;
+			print_list(\*OUT, @tmp);
+		} elsif ($1 eq "VARIABLE_LIST") {
+			print_list(\*OUT, keys %variables);
+		} elsif ($1 eq "MODULES") {
+			print_list(\*OUT, @modules);
+		} elsif ($1 eq "GENERATOR_EXPRESSIONS") {
+			print_list(\*OUT, @generator_expr);
+		} elsif ($1 eq "CONDITIONALS") {
+			print_list(\*OUT, keys %conditional);
+		} elsif ($1 eq "LOOPS") {
+			print_list(\*OUT, keys %loop);
+		} elsif ($1 eq "DEPRECATED") {
+			print_list(\*OUT, keys %deprecated);
+		} elsif ($1 eq "PROPERTIES") {
+			print_list(\*OUT, keys %properties);
+		} elsif ($1 eq "KEYWORDS") {
+			foreach my $k (sort keys %keywords) {
+				print OUT "syn keyword cmakeKW$k contained\n";
+				print_list(\*OUT, @{$keywords{$k}});
+				print OUT "\n";
+				push @keyword_hi, "hi def link cmakeKW$k ModeMsg";
+			}
+		} elsif ($1 eq "KEYWORDS_HIGHLIGHT") {
+			print OUT join("\n", @keyword_hi), "\n";
+		} elsif ($1 eq "VERSION") {
+			$_ =~ s/\@VERSION\@/$version/;
+			print OUT $_;
+		} elsif ($1 eq "DATE") {
+			my $date = strftime "%Y %b %d", localtime;
+			$_ =~ s/\@DATE\@/$date/;
+			print OUT $_;
+		} else {
+			print "ERROR do not know how to replace $1\n";
+		}
+	} else {
+		print OUT $_;
+	}
+}
+close(IN);
+close(OUT);
+
+sub extract_upper
+{
+	my $input = shift;
+	my @word;
+
+	open(KW, $input);
+	while (<KW>) {
+		foreach my $w (m/\b([A-Z_]{2,})\b/g) {
+			next
+				if exists $variables{$w} or  # skip if it is a variable
+				   exists $unwanted{$w} or   # skip if not wanted
+				   grep(/$w/, @word);     # skip if already in array
+
+			push @word, $w;
+		}
+	}
+	close(KW);
+
+	return @word;
+}
+
+sub print_list
+{
+	my $O = shift;
+	my $indent = " " x 12 . "\\ ";
+	print $O $indent, join("\n" . $indent, sort @_), "\n";
+}