Place the version number in one file (VERSION)

Author: AhmedMzid

.gitignore

@@ -13,4 +13,6 @@ build
 osi
 .project
 doc/html
-doc/latex
+doc/latex
+osi_version.proto
+version.py

CMakeLists.txt

@@ -1,15 +1,22 @@
 cmake_minimum_required(VERSION 3.7)
 
-# set name and version of the project 
 project(open_simulation_interface)
-set(VERSION_MAJOR 2)
-set(VERSION_MINOR 1)
-set(VERSION_PATCH 1)
 
+# read the version number from the file "VERSION" 
+file(STRINGS "VERSION" VERSION_CONTENTS)
+foreach(LINE ${VERSION_CONTENTS})
+  string(REGEX REPLACE " |\t" "" LINE ${LINE})
+  string(REGEX MATCH "^[^=]+" VERSION_NAME ${LINE})
+  string(REPLACE "${VERSION_NAME}=" "" VERSION_VALUE ${LINE})
+  set(${VERSION_NAME} "${VERSION_VALUE}")
+endforeach()
+
+configure_file(osi_version.proto.in ${CMAKE_CURRENT_SOURCE_DIR}/osi_version.proto)
 
 find_package(Protobuf 2.6.1 REQUIRED)
 
 set(OSI_PROTO_FILES
+	osi_version.proto
     osi_common.proto
     osi_datarecording.proto
     osi_detectedlandmark.proto

VERSION

@@ -0,0 +1,3 @@
+VERSION_MAJOR = 2
+VERSION_MINOR = 2
+VERSION_PATCH = 0

osi_common.proto

@@ -4,26 +4,6 @@ option optimize_for = SPEED;
 
 package osi;
 
-//
-// \brief The interface version number.
-//
-// The field containing the version number. Should be left on default, not to be modified by sender.
-// Increments will happen as part of changes to the whole interface.
-//
-message InterfaceVersion
-{
-	// Major version number.
-	//
-    optional uint32 major = 1 [default = 2];
-	
-	// Minor version number.
-	//
-    optional uint32 minor = 2 [default = 1];
-	
-	// Patch version number.
-	//
-    optional uint32 patch = 3 [default = 1];
-}
 
 //
 // \brief A cartesian 3D vector for positions, velocities or accelerations.
@@ -238,6 +218,7 @@ message BaseMoving
     optional Vector3d position = 2;
 
     // The relative orientation of the object w.r.t its parent frame.
+	//
     optional Orientation3d orientation = 3;
 
     // The relative velocity of the object w.r.t. its parent frame and parent velocity.

osi_groundtruth.proto

@@ -2,6 +2,7 @@ syntax = "proto2";
 
 option optimize_for = SPEED;
 
+import "osi_version.proto";
 import "osi_common.proto";
 import "osi_environment.proto";
 import "osi_landmark.proto";

osi_version.proto.in

@@ -0,0 +1,26 @@
+syntax = "proto2";
+
+option optimize_for = SPEED;
+
+package osi;
+
+//
+// \brief The interface version number.
+//
+// The field containing the version number. Should be left on default, not to be modified by sender.
+// Increments will happen as part of changes to the whole interface.
+//
+message InterfaceVersion
+{
+	// Major version number.
+	//
+    optional uint32 major = 1 [default = @VERSION_MAJOR@];
+	
+	// Minor version number.
+	//
+    optional uint32 minor = 2 [default = @VERSION_MINOR@];
+	
+	// Patch version number.
+	//
+    optional uint32 patch = 3 [default = @VERSION_PATCH@];
+}

setup.py

@@ -9,10 +9,21 @@
 from setuptools import setup
 from setuptools.command.install import install
 
+# configure the version number
+from shutil import copyfile
+copyfile('VERSION', 'version.py')
+from version import *
+with open("osi_version.proto.in", "rt") as fin:
+	with open("osi_version.proto", "wt") as fout:
+		for line in fin:
+			lineConfigured = line.replace('@VERSION_MAJOR@',str(VERSION_MAJOR))
+			lineConfigured = lineConfigured.replace('@VERSION_MINOR@',str(VERSION_MINOR))
+			lineConfigured = lineConfigured.replace('@VERSION_PATCH@',str(VERSION_PATCH))
+			fout.write(lineConfigured)
+
 package_name = 'osi'
 package_path = os.path.join(os.getcwd(), package_name)
 
-
 class GenerateProtobuf(install):
 
     @staticmethod
@@ -33,6 +44,7 @@ def find_protoc():
         return protoc
 
     osi_files = (
+		'osi_version.proto',
         'osi_common.proto',
         'osi_datarecording.proto',
         'osi_detectedlandmark.proto',
@@ -74,7 +86,7 @@ def run(self):
 
 setup(
     name='open-simulation-interface',
-    version='2.1.1',
+    version=str(VERSION_MAJOR)+'.'+str(VERSION_MINOR)+'.'+str(VERSION_PATCH),
     description='A generic interface for the environmental perception of'
     'automated driving functions in virtual scenarios.',
     author='Carlo van Driesten, Timo Hanke, Nils Hirsenkorn,'