From 81c98cf3ee6cce6c8b102ef1d8cb104b105e293a Mon Sep 17 00:00:00 2001 From: Dan Liew Date: Wed, 9 Dec 2015 15:54:41 +0000 Subject: [PATCH 1/6] Refactor ``mk_all_assembly_infos()`` to use the ``configure_file()`` function. The old implementation was buggy under Python 3.5 and unsafe (not using with statements on calls to ``open()``). --- scripts/mk_util.py | 45 ++++++------------- .../{AssemblyInfo => AssemblyInfo.cs.in} | 4 +- 2 files changed, 15 insertions(+), 34 deletions(-) rename src/api/dotnet/Properties/{AssemblyInfo => AssemblyInfo.cs.in} (89%) diff --git a/scripts/mk_util.py b/scripts/mk_util.py index ffbad3f51..a21663326 100644 --- a/scripts/mk_util.py +++ b/scripts/mk_util.py @@ -2582,42 +2582,23 @@ def mk_version_dot_h(major, minor, build, revision): if VERBOSE: print("Generated '%s'" % os.path.join(c.src_dir, 'version.h')) -# Generate AssemblyInfo.cs files with the right version numbers by using AssemblyInfo files as a template +# Generate AssemblyInfo.cs files with the right version numbers by using ``AssemblyInfo.cs.in`` files as a template def mk_all_assembly_infos(major, minor, build, revision): for c in get_components(): if c.has_assembly_info(): - assembly = os.path.join(c.src_dir, c.assembly_info_dir, 'AssemblyInfo') - if os.path.exists(assembly): - # It is a CS file - mk_assembly_info_version(assembly, major, minor, build, revision) + assembly_info_template = os.path.join(c.src_dir, c.assembly_info_dir, 'AssemblyInfo.cs.in') + assembly_info_output = assembly_info_template[:-3] + assert assembly_info_output.endswith('.cs') + if os.path.exists(assembly_info_template): + configure_file(assembly_info_template, assembly_info_output, + { 'VER_MAJOR': str(major), + 'VER_MINOR': str(minor), + 'VER_BUILD': str(build), + 'VER_REVISION': str(revision), + } + ) else: - raise MKException("Failed to find assembly info file 'AssemblyInfo' at '%s'" % os.path.join(c.src_dir, c.assembly_info_dir)) - - -# Generate version number in the given 'AssemblyInfo.cs' file using 'AssemblyInfo' as a template. -def mk_assembly_info_version(assemblyinfo, major, minor, build, revision): - ver_pat = re.compile('[assembly: AssemblyVersion\("[\.\d]*"\) *') - fver_pat = re.compile('[assembly: AssemblyFileVersion\("[\.\d]*"\) *') - fin = open(assemblyinfo, 'r') - tmp = '%s.cs' % assemblyinfo - fout = open(tmp, 'w') - num_updates = 0 - for line in fin: - if ver_pat.match(line): - fout.write('[assembly: AssemblyVersion("%s.%s.%s.%s")]\n' % (major, minor, build, revision)) - num_updates = num_updates + 1 - elif fver_pat.match(line): - fout.write('[assembly: AssemblyFileVersion("%s.%s.%s.%s")]\n' % (major, minor, build, revision)) - num_updates = num_updates + 1 - else: - fout.write(line) - # if VERBOSE: - # print("%s version numbers updated at '%s'" % (num_updates, assemblyinfo)) - assert num_updates == 2, "unexpected number of version number updates" - fin.close() - fout.close() - if VERBOSE: - print("Updated '%s'" % assemblyinfo) + raise MKException("Failed to find assembly template info file '%s'" % assembly_info_template) ADD_TACTIC_DATA=[] ADD_PROBE_DATA=[] diff --git a/src/api/dotnet/Properties/AssemblyInfo b/src/api/dotnet/Properties/AssemblyInfo.cs.in similarity index 89% rename from src/api/dotnet/Properties/AssemblyInfo rename to src/api/dotnet/Properties/AssemblyInfo.cs.in index 4afbb4a26..c892cb074 100644 --- a/src/api/dotnet/Properties/AssemblyInfo +++ b/src/api/dotnet/Properties/AssemblyInfo.cs.in @@ -34,5 +34,5 @@ using System.Security.Permissions; // You can specify all the values or you can default the Build and Revision Numbers // by using the '*' as shown below: // [assembly: AssemblyVersion("4.2.0.0")] -[assembly: AssemblyVersion("4.3.2.0")] -[assembly: AssemblyFileVersion("4.3.2.0")] +[assembly: AssemblyVersion("@VER_MAJOR@.@VER_MINOR@.@VER_BUILD@.@VER_REVISION@")] +[assembly: AssemblyFileVersion("@VER_MAJOR@.@VER_MINOR@.@VER_BUILD@.@VER_REVISION@")] From 288fb3b7c1e51466b58e847b56e65510038e9b7b Mon Sep 17 00:00:00 2001 From: Dan Liew Date: Sat, 12 Dec 2015 08:47:31 +0000 Subject: [PATCH 2/6] Remove some trailing spaces in ``AssemblyInfo.cs.in`` --- src/api/dotnet/Properties/AssemblyInfo.cs.in | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/api/dotnet/Properties/AssemblyInfo.cs.in b/src/api/dotnet/Properties/AssemblyInfo.cs.in index c892cb074..4455415fb 100644 --- a/src/api/dotnet/Properties/AssemblyInfo.cs.in +++ b/src/api/dotnet/Properties/AssemblyInfo.cs.in @@ -4,7 +4,7 @@ using System.Runtime.CompilerServices; using System.Runtime.InteropServices; using System.Security.Permissions; -// General Information about an assembly is controlled through the following +// General Information about an assembly is controlled through the following // set of attributes. Change these attribute values to modify the information // associated with an assembly. [assembly: AssemblyTitle("Z3 .NET Interface")] @@ -16,8 +16,8 @@ using System.Security.Permissions; [assembly: AssemblyTrademark("")] [assembly: AssemblyCulture("")] -// Setting ComVisible to false makes the types in this assembly not visible -// to COM components. If you need to access a type in this assembly from +// Setting ComVisible to false makes the types in this assembly not visible +// to COM components. If you need to access a type in this assembly from // COM, set the ComVisible attribute to true on that type. [assembly: ComVisible(false)] @@ -27,11 +27,11 @@ using System.Security.Permissions; // Version information for an assembly consists of the following four values: // // Major Version -// Minor Version +// Minor Version // Build Number // Revision // -// You can specify all the values or you can default the Build and Revision Numbers +// You can specify all the values or you can default the Build and Revision Numbers // by using the '*' as shown below: // [assembly: AssemblyVersion("4.2.0.0")] [assembly: AssemblyVersion("@VER_MAJOR@.@VER_MINOR@.@VER_BUILD@.@VER_REVISION@")] From 28eb21442e1bc6bd0b5e5e56aca9cdf8721d151e Mon Sep 17 00:00:00 2001 From: Dan Liew Date: Sat, 12 Dec 2015 08:57:16 +0000 Subject: [PATCH 3/6] Bump the copyright year in ``AssemblyInfo.cs.in``. Perhaps we should automatically generate this year during the configure step with a ``@COPYRIGHT_END_YEAR@`` substitution instead? --- src/api/dotnet/Properties/AssemblyInfo.cs.in | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/api/dotnet/Properties/AssemblyInfo.cs.in b/src/api/dotnet/Properties/AssemblyInfo.cs.in index 4455415fb..e5a85f16f 100644 --- a/src/api/dotnet/Properties/AssemblyInfo.cs.in +++ b/src/api/dotnet/Properties/AssemblyInfo.cs.in @@ -12,7 +12,7 @@ using System.Security.Permissions; [assembly: AssemblyConfiguration("")] [assembly: AssemblyCompany("Microsoft Corporation")] [assembly: AssemblyProduct("Z3")] -[assembly: AssemblyCopyright("Copyright (C) 2006-2014 Microsoft Corporation")] +[assembly: AssemblyCopyright("Copyright (C) 2006-2015 Microsoft Corporation")] [assembly: AssemblyTrademark("")] [assembly: AssemblyCulture("")] From d3d10490ead62e18e82a5b89099db5286380b0ea Mon Sep 17 00:00:00 2001 From: Dan Liew Date: Mon, 14 Dec 2015 09:56:03 +0000 Subject: [PATCH 4/6] Fix bug in ``Makefile`` generation when emitting the command to build the ".NET" bindings when in debug mode. ``;`` is a shell command separator so it needs to be quoted when emitting ``/define:DEBUG;TRACE``. --- scripts/mk_util.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/mk_util.py b/scripts/mk_util.py index a21663326..4cb2971da 100644 --- a/scripts/mk_util.py +++ b/scripts/mk_util.py @@ -1535,7 +1535,7 @@ class DotNetDLLComponent(Component): ] ) if DEBUG_MODE: - cscCmdLine.extend( ['/define:DEBUG;TRACE', + cscCmdLine.extend( ['"/define:DEBUG;TRACE"', # Needs to be quoted due to ``;`` being a shell command separator '/debug+', '/debug:full', '/optimize-' From 44393b37debda8627f69249595ce5540e2939ac4 Mon Sep 17 00:00:00 2001 From: Dan Liew Date: Tue, 15 Dec 2015 08:46:47 +0000 Subject: [PATCH 5/6] Emit dependency of phony target ``examples`` on ``_ex_dotnet_example`` when building of the ".NET" bindings is enabled. --- scripts/mk_util.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/mk_util.py b/scripts/mk_util.py index 4cb2971da..3e65bf782 100644 --- a/scripts/mk_util.py +++ b/scripts/mk_util.py @@ -1950,7 +1950,7 @@ class DotNetExampleComponent(ExampleComponent): ExampleComponent.__init__(self, name, path) def is_example(self): - return IS_WINDOWS + return is_dotnet_enabled() def mk_makefile(self, out): if DOTNET_ENABLED: From 439d8d8afe7c1e9c4f6d38613177965e06d2d82c Mon Sep 17 00:00:00 2001 From: Dan Liew Date: Tue, 15 Dec 2015 08:56:47 +0000 Subject: [PATCH 6/6] Fix issue on non-windows systems when emitting the build rule for the ".NET" bindings example. Previously there was a hack that would to path separator replacement ( '/' -> '\' ) which breaks paths under non-windows platforms. The hack has been made slightly better by doing ( '/' -> os.path.sep). This preserves the existing behaviour under Windows and unbreaks the build on non-windows platforms. I'm not entirely sure why the path replacement needs to be done in the first place. I thought Windows was supposed to support using '/' as a path separator (as well as '/'). Maybe ``csc.exe`` doesn't support these kind of paths? --- scripts/mk_util.py | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/scripts/mk_util.py b/scripts/mk_util.py index 3e65bf782..a0e8300c2 100644 --- a/scripts/mk_util.py +++ b/scripts/mk_util.py @@ -1969,9 +1969,11 @@ class DotNetExampleComponent(ExampleComponent): out.write(' /platform:x86') for csfile in get_cs_files(self.ex_dir): out.write(' ') - # HACK - win_ex_dir = self.to_ex_dir.replace('/', '\\') - out.write(os.path.join(win_ex_dir, csfile)) + # HACK: I'm not really sure why csc on Windows need to be + # given Windows style paths (``\``) here. I thought Windows + # supported using ``/`` as a path separator... + relative_path = self.to_ex_dir.replace('/', os.path.sep) + out.write(os.path.join(relative_path, csfile)) out.write('\n') out.write('_ex_%s: %s\n\n' % (self.name, exefile))