Replace CMake generated version files with checked-in versions (#1993)

* Move the version number into the source code

Signed-off-by: Darby Johnston <darbyjohnston@yahoo.com>

Author: darbyjohnston

CMakeLists.txt

@@ -6,9 +6,13 @@ cmake_minimum_required(VERSION 3.18.2)
 # Project Metadata
 # TODO: read this information from a configuration file, here, and in setup.py
 
-set(OTIO_VERSION_MAJOR "0")
-set(OTIO_VERSION_MINOR "19")
-set(OTIO_VERSION_PATCH "0")
+file(READ "src/opentimelineio/version.h" VERSION_H)
+string(REGEX MATCH "VERSION_MAJOR ([0-9]*)" _ ${VERSION_H})
+set(OTIO_VERSION_MAJOR ${CMAKE_MATCH_1})
+string(REGEX MATCH "VERSION_MINOR ([0-9]*)" _ ${VERSION_H})
+set(OTIO_VERSION_MINOR ${CMAKE_MATCH_1})
+string(REGEX MATCH "VERSION_PATCH ([0-9]*)" _ ${VERSION_H})
+set(OTIO_VERSION_PATCH ${CMAKE_MATCH_1})
 set(OTIO_VERSION ${OTIO_VERSION_MAJOR}.${OTIO_VERSION_MINOR}.${OTIO_VERSION_PATCH})
 
 set(OTIO_AUTHOR       "Contributors to the OpenTimelineIO project")

README.md

@@ -111,19 +111,17 @@ C++:
 
 #include "opentimelineio/timeline.h"
 
-namespace otio = opentimelineio::OPENTIMELINEIO_VERSION;
-
 void
 main()
 {
-    otio::SerializableObject::Retainer<otio::Timeline> tl(
-            dynamic_cast<otio::Timeline*>(
-                otio::Timeline::from_json_file("taco.otio")
+    OTIO_NS::SerializableObject::Retainer<OTIO_NS::Timeline> tl(
+            dynamic_cast<OTIO_NS::Timeline*>(
+                OTIO_NS::Timeline::from_json_file("taco.otio")
         )
     );
     for (const auto& cl : tl->find_clips())
     {
-        otio::RationalTime dur = cl->duration();
+        OTIO_NS::RationalTime dur = cl->duration();
         std::cout << "Name: " << cl->name() << " [";
         std::cout << dur.value() << "/" << dur.rate() << "]" << std::endl;
     }

src/opentime/CMakeLists.txt

@@ -7,7 +7,8 @@ set(OPENTIME_HEADER_FILES
     rationalTime.h
     stringPrintf.h
     timeRange.h
-    timeTransform.h)
+    timeTransform.h
+    version.h)
 
 add_library(opentime ${OTIO_SHARED_OR_STATIC_LIB} 
             errorStatus.cpp
@@ -16,12 +17,7 @@ add_library(opentime ${OTIO_SHARED_OR_STATIC_LIB}
 
 add_library(OTIO::opentime ALIAS opentime)
 
-target_include_directories(
-    opentime
-    PRIVATE
-        "${PROJECT_SOURCE_DIR}/src"
-        "${CMAKE_CURRENT_BINARY_DIR}/.."
-)
+target_include_directories(opentime PRIVATE "${PROJECT_SOURCE_DIR}/src")
 
 set_target_properties(opentime PROPERTIES 
     DEBUG_POSTFIX "${OTIO_DEBUG_POSTFIX}"
@@ -56,11 +52,6 @@ target_compile_options(opentime PRIVATE
      $<$<CXX_COMPILER_ID:MSVC>: /EHsc>
 )
 
-configure_file(
-    ${CMAKE_CURRENT_SOURCE_DIR}/version.h.in
-    ${CMAKE_CURRENT_BINARY_DIR}/version.h
-)
-
 if(OTIO_CXX_INSTALL)
     install(FILES ${OPENTIME_HEADER_FILES} 
             DESTINATION "${OTIO_RESOLVED_CXX_INSTALL_DIR}/include/opentime")
@@ -98,12 +89,5 @@ if(OTIO_CXX_INSTALL)
         DESTINATION
             ${OTIO_RESOLVED_CXX_INSTALL_DIR}/share/opentime
     )
-
-    install(
-        FILES
-            ${CMAKE_CURRENT_BINARY_DIR}/version.h
-        DESTINATION
-            "${OTIO_RESOLVED_CXX_INSTALL_DIR}/include/opentime"
-    )
 endif()
 

src/opentime/version.h

@@ -0,0 +1,17 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Contributors to the OpenTimelineIO project
+
+#pragma once
+
+#define OPENTIME_VERSION_MAJOR 0
+#define OPENTIME_VERSION_MINOR 19
+#define OPENTIME_VERSION_PATCH 0
+#define OPENTIME_VERSION v0_19_0
+#define OPENTIME_VERSION_NS v0_19
+
+namespace opentime {
+namespace OPENTIME_VERSION_NS {
+}
+
+using namespace OPENTIME_VERSION_NS;
+} // namespace opentime

src/opentime/version.h.in

@@ -37,7 +37,8 @@ set(OPENTIMELINEIO_HEADER_FILES
     transition.h
     typeRegistry.h
     unknownSchema.h
-    vectorIndexing.h)
+    vectorIndexing.h
+    version.h)
 
 add_library(opentimelineio ${OTIO_SHARED_OR_STATIC_LIB}
     color.cpp
@@ -79,12 +80,7 @@ add_library(opentimelineio ${OTIO_SHARED_OR_STATIC_LIB}
 
 add_library(OTIO::opentimelineio ALIAS opentimelineio)
 
-target_include_directories(
-    opentimelineio
-    PRIVATE
-        "${PROJECT_SOURCE_DIR}/src"
-        "${CMAKE_CURRENT_BINARY_DIR}/.."
-)
+target_include_directories(opentimelineio PRIVATE "${PROJECT_SOURCE_DIR}/src")
 
 if(OTIO_FIND_RAPIDJSON)
     target_include_directories(opentimelineio
@@ -132,11 +128,6 @@ target_compile_options(opentimelineio PRIVATE
      $<$<CXX_COMPILER_ID:MSVC>: /EHsc>
 )
 
-configure_file(
-    ${CMAKE_CURRENT_SOURCE_DIR}/version.h.in
-    ${CMAKE_CURRENT_BINARY_DIR}/version.h
-)
-
 if(OTIO_CXX_INSTALL)
     install(FILES ${OPENTIMELINEIO_HEADER_FILES} 
             DESTINATION "${OTIO_RESOLVED_CXX_INSTALL_DIR}/include/opentimelineio")
@@ -176,11 +167,4 @@ if(OTIO_CXX_INSTALL)
         DESTINATION
             ${OTIO_RESOLVED_CXX_INSTALL_DIR}/share/opentimelineio
     )
-
-    install(
-        FILES
-            ${CMAKE_CURRENT_BINARY_DIR}/version.h
-        DESTINATION
-            "${OTIO_RESOLVED_CXX_INSTALL_DIR}/include/opentimelineio"
-    )
 endif()

src/opentimelineio/CMakeLists.txt

@@ -3,11 +3,11 @@
 
 #pragma once
 
-#define OPENTIMELINEIO_VERSION_MAJOR @PROJECT_VERSION_MAJOR@
-#define OPENTIMELINEIO_VERSION_MINOR @PROJECT_VERSION_MINOR@
-#define OPENTIMELINEIO_VERSION_PATCH @PROJECT_VERSION_PATCH@
-#define OPENTIMELINEIO_VERSION v@PROJECT_VERSION_MAJOR@_@PROJECT_VERSION_MINOR@_@PROJECT_VERSION_PATCH@
-#define OPENTIMELINEIO_VERSION_NS v@PROJECT_VERSION_MAJOR@_@PROJECT_VERSION_MINOR@
+#define OPENTIMELINEIO_VERSION_MAJOR 0
+#define OPENTIMELINEIO_VERSION_MINOR 19
+#define OPENTIMELINEIO_VERSION_PATCH 0
+#define OPENTIMELINEIO_VERSION v0_19_0
+#define OPENTIMELINEIO_VERSION_NS v0_19
 
 #include "opentime/rationalTime.h"
 #include "opentime/timeRange.h"

src/opentimelineio/version.h.in src/opentimelineio/version.hsrc/opentimelineio/version.h.in renamed to src/opentimelineio/version.h

@@ -13,7 +13,6 @@ target_include_directories(_opentime
     PRIVATE "${PROJECT_SOURCE_DIR}/src"
     PRIVATE "${PROJECT_SOURCE_DIR}/src/deps"
     PRIVATE "${PROJECT_SOURCE_DIR}/src/deps/optional-lite/include"
-    PRIVATE "${CMAKE_BINARY_DIR}/src"
 )
 
 target_link_libraries(_opentime PUBLIC opentimelineio opentime)

src/py-opentimelineio/opentime-bindings/CMakeLists.txt

@@ -23,7 +23,6 @@ target_include_directories(_otio
     PRIVATE "${PROJECT_SOURCE_DIR}/src"
     PRIVATE "${PROJECT_SOURCE_DIR}/src/deps"
     PRIVATE "${PROJECT_SOURCE_DIR}/src/deps/optional-lite/include"
-    PRIVATE "${CMAKE_BINARY_DIR}/src"
 )
 
 target_link_libraries(_otio PUBLIC opentimelineio opentime)

src/py-opentimelineio/opentimelineio-bindings/CMakeLists.txt

@@ -3,7 +3,6 @@ include_directories(
     ${PROJECT_SOURCE_DIR}/src/deps
     ${PROJECT_SOURCE_DIR}/src/deps/optional-lite/include
     ${PROJECT_SOURCE_DIR}/src/tests
-    ${CMAKE_BINARY_DIR}/src
 )
 
 list(APPEND tests_opentime test_opentime)