CMake configuration for Visual Studio

.gitignore

@@ -14,7 +14,6 @@
 # Compiled Dynamic libraries
 *.so
 *.dylib
-*.dll
 
 # Fortran module files
 *.mod
@@ -24,7 +23,6 @@
 *.lai
 *.la
 *.a
-*.lib
 
 # Executables
 *.exe
@@ -41,10 +39,16 @@
 ehthumbs.db
 Thumbs.db
 
-# Xcode 
+# Xcode
 *.xcuserstate
 *.xcodeproj/project.xcworkspace/
 *.xcodeproj/xcuserdata/
 
-# Project specific
+# Visual Studio
+.vs/
+Debug/
+Release/
+*.vcxproj.user
 
+# CMake
+build/

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "third-party/googletest"]
+	path = third-party/googletest
+	url = https://github.com/google/googletest.git

CMakeLists.txt

@@ -0,0 +1,44 @@
+cmake_minimum_required(VERSION 3.8)
+
+set(CMAKE_CXX_STANDARD 14)
+
+project (SketchUpApiCppWrapper)
+
+# Define various paths:
+
+set(CPP_API_BASENAME "SUAPI-CppWrapper")
+set(CPP_API_INCLUDE_PATH "${PROJECT_SOURCE_DIR}/include")
+set(CPP_API_SOURCE_PATH "${PROJECT_SOURCE_DIR}/src")
+set(CPP_API_TESTS_PATH "${PROJECT_SOURCE_DIR}/tests")
+
+set(CPP_API_THIRD_PARTY_PATH "${PROJECT_SOURCE_DIR}/third-party")
+
+# TODO(thomthom): Configure for Mac:
+set(SLAPI_PATH "${CPP_API_THIRD_PARTY_PATH}/slapi")
+set(SLAPI_INCLUDE_PATH "${SLAPI_PATH}/win/headers")
+set(SLAPI_BINARIES_PATH "${SLAPI_PATH}/win/binaries")
+set(SLAPI_BINARIES_X64_PATH "${SLAPI_BINARIES_PATH}/sketchup/x64")
+# TODO(thomthom): Add library paths per platform, and try to add just "SketchUpAPI"
+#                 to `target_link_libraries`.
+set(SLAPI_LIB "${SLAPI_BINARIES_X64_PATH}/SketchUpAPI.lib")
+
+set(GOOGLETEST_PATH "${CPP_API_THIRD_PARTY_PATH}/googletest/googletest")
+set(GOOGLETEST_INCLUDE_PATH "${GOOGLETEST_PATH}/include")
+
+
+# GoogleTest 1.8 produce a warning that must be silenced. The fix is yet to be
+# pushed to the GoogleTest stable branch.
+#   warning C4996: 'std::tr1': warning STL4002: The non-Standard std::tr1
+#   namespace and TR1-only machinery are deprecated and will be REMOVED. You can
+#   define _SILENCE_TR1_NAMESPACE_DEPRECATION_WARNING to acknowledge that you
+#   have received this warning.
+add_definitions(-D_SILENCE_TR1_NAMESPACE_DEPRECATION_WARNING)
+
+# Avoid conflicting macros from Win32 API.
+add_definitions(-DWIN32_LEAN_AND_MEAN)
+add_definitions(-DNOMINMAX)
+
+
+include(${CMAKE_CURRENT_SOURCE_DIR}/cmake/SketchUpAPICpp.cmake)
+include(${CMAKE_CURRENT_SOURCE_DIR}/cmake/GoogleTest.cmake)
+include(${CMAKE_CURRENT_SOURCE_DIR}/cmake/SketchUpAPITests.cmake)

README.md

@@ -30,6 +30,43 @@ Added to this benefit, the wrapper classes have helper functions to help with ge
 The project is documented in Doxygen, accessible here:
 https://tommykaneko.github.io/Sketchup-API-C-Wrapper/html
 
+## CMake
+
+### Visual Studio
+
+```
+ CMake .. -G "Visual Studio 15 2017 Win64"
+```
+
+### XCode
+
+Coming...
+
+## Testing
+The project uses GoogleTest for unit testing. It's included as a submodule so make sure to also initialize those when checking out the project.
+
+The tests are located under `/tests/`. One file per testcase. One testcase per class being tested.
+
+Keep tests small, keep their name descriptive.
+
+### Running Tests
+
+#### Visual Studio
+1. Set the SketchUpAPITests project as your startup project.
+2. Build
+3. Run
+
+Alternativly you can use the [Google Test Adapter extension](https://marketplace.visualstudio.com/items?itemName=ChristianSoltenborn.GoogleTestAdapter) which provides  overview of the tests from the UI. Makes it easy to run induvidual tests.
+
+#### Xcode
+*Coming soon.*
+
+### GoogleTests References
+* https://github.com/google/googletest/blob/master/googlemock/docs/ForDummies.md
+* https://github.com/google/googletest/blob/master/googletest/docs/Primer.md
+* https://github.com/google/googletest/blob/master/googletest/docs/AdvancedGuide.md
+* https://github.com/google/googletest/blob/master/googletest/docs/FAQ.md
+
 ======================
 ## Project Objectives
 

cmake/GoogleTest.cmake

@@ -0,0 +1,4 @@
+include_directories(SYSTEM "${PROJECT_SOURCE_DIR}/third-party/googletest/googletest/include")
+include_directories("${PROJECT_SOURCE_DIR}/third-party/googletest/googletest")
+
+add_library(GoogleTest STATIC third-party/googletest/googletest/src/gtest-all.cc)

cmake/SketchUpAPICpp.cmake

@@ -0,0 +1,31 @@
+# TODO(thomthom): Configure for Mac:
+include_directories(SYSTEM "${SLAPI_INCLUDE_PATH}")
+include_directories("${CPP_API_INCLUDE_PATH}")
+
+file(GLOB_RECURSE CPP_API_HEADERS ${CPP_API_INCLUDE_PATH}/*.hpp)
+file(GLOB_RECURSE CPP_API_SOURCES ${CPP_API_SOURCE_PATH}/*.cpp)
+
+add_library(SketchUpAPICpp STATIC ${CPP_API_HEADERS} ${CPP_API_SOURCES})
+
+# https://stackoverflow.com/a/14235055/486990
+if ( MSVC )
+  # TODO(thomthom): Enable /W4 when the warnings it trigger is addressed.
+  # target_compile_options(SketchUpAPICpp PRIVATE "/W4")
+  target_compile_options(SketchUpAPICpp PRIVATE "/W3")
+  target_compile_options(SketchUpAPICpp PRIVATE "/WX")
+  target_compile_options(SketchUpAPICpp PRIVATE "/MP")
+else()
+  # target_compile_options(SketchUpAPICpp PRIVATE "-Wall")
+  target_compile_options(SketchUpAPICpp PRIVATE "-Werror")
+endif()
+
+source_group(
+  TREE "${CPP_API_INCLUDE_PATH}/${CPP_API_BASENAME}"
+  PREFIX "Header Files"
+  FILES ${CPP_API_HEADERS}
+)
+source_group(
+  TREE "${CPP_API_SOURCE_PATH}/${CPP_API_BASENAME}"
+  PREFIX "Source Files"
+  FILES ${CPP_API_SOURCES}
+)

cmake/SketchUpAPITests.cmake

@@ -0,0 +1,29 @@
+include_directories("${CPP_API_TESTS_PATH}")
+include_directories("${GOOGLETEST_INCLUDE_PATH}")
+
+file(GLOB_RECURSE TESTS_HEADERS ${CPP_API_TESTS_PATH}/*.hpp)
+file(GLOB_RECURSE TESTS_SOURCES ${CPP_API_TESTS_PATH}/*.cpp)
+
+add_executable(SketchUpAPITests ${TESTS_HEADERS} ${TESTS_SOURCES})
+
+target_link_libraries(SketchUpAPITests GoogleTest SketchUpAPICpp ${SLAPI_LIB})
+
+set_target_properties(${SketchUpAPITests} PROPERTIES COMPILE_FLAGS "-Wall")
+
+source_group(
+  "Tests"
+  REGULAR_EXPRESSION "${CPP_API_TESTS_PATH}/[^\//]+Tests.cpp"
+)
+# Force the CPP file that define `main` to not appear in the Tests list.
+source_group(
+  "Source Files"
+  FILES "${CPP_API_TESTS_PATH}/SketchUpAPITests.cpp"
+)
+
+# TODO(thomthom): Set up per-platform post-build commands.
+add_custom_command(TARGET SketchUpAPITests POST_BUILD
+  # xcopy seem to require at least one \ slash in the source path, otherwise it
+  # appear to fail.
+  COMMAND xcopy \"${SLAPI_BINARIES_PATH}\\sketchup\\x64\\SketchUpAPI.dll\" $(OutputPath) /D /Y
+  COMMAND xcopy \"${SLAPI_BINARIES_PATH}\\sketchup\\x64\\SketchUpCommonPreferences.dll\" $(OutputPath) /D /Y
+)

include/SUAPI-CppWrapper/Geometry.hpp

@@ -58,6 +58,7 @@ class Radians
 public:
   double m_val;
   static constexpr double PI = 3.141592653589793;
+  static constexpr double PI2 = PI * 2;
   // Estimate the degree of correctness of angles (Sketchup Tolerance is 1/1000", so try to make some sort of guess - suggest discrepancies of 1/1000" over radians rotations over 30m (approx 1000")
   constexpr static double EPSILON = 0.0000000000005; // Sketchup Tolerance is 1/1000"
 

src/SUAPI-CppWrapper/Geometry.cpp

@@ -46,15 +46,13 @@ namespace CW {
 */
 Radians::Radians(const double &rhs):
   m_val(rhs)
-{ 
-    if(rhs > (2*PI)) {
-      int numPi = rhs / (2*PI); // Get number of times 2pi fits in to rhs
-      m_val = rhs - (numPi*2*PI);
-    }
-    else if(rhs < 0.0) {
-      int numPi = (rhs / (2*PI)) - 1; // Get number of times 2pi fits in to rhs
-      m_val = rhs - (numPi*2*PI);
-    }
+{
+  if(rhs > PI2) {
+    m_val = std::fmod(rhs, PI2);
+  }
+  else if(rhs < 0.0) {
+    m_val = PI2 - std::fmod(std::fabs(rhs), PI2);
+  }
 }
 
 // Copy constructor

src/SUAPI-CppWrapper/String.cpp

@@ -152,11 +152,11 @@ std::string String::std_string() const {
   size_t out_length = 0;
   SUResult res = SUStringGetUTF8Length(m_string, &out_length);
   assert(res == SU_ERROR_NONE);
-  out_length++; // Allow for null termianted string
-  std::vector<char> char_array(out_length);
+  out_length++; // Allow for null terminated string
+  std::vector<char> char_array(out_length, 0);
   res = SUStringGetUTF8(m_string, out_length, char_array.data(), &out_length);
   assert(res == SU_ERROR_NONE);
-  std::string str(char_array.begin(),char_array.end());
+  std::string str(char_array.data());
   return str;
 }
 

src/SUAPI-CppWrapper/model/AttributeDictionary.cpp

@@ -134,13 +134,6 @@ AttributeDictionary::operator SUAttributeDictionaryRef() const {
 }
 
 
-AttributeDictionary::operator SUAttributeDictionaryRef*() {
-  // TODO: test if the solution below works.
-  SUAttributeDictionaryRef dict = SUAttributeDictionaryFromEntity(m_entity);
-  return &dict;
-}
-
-
 TypedValue AttributeDictionary::get_attribute(const std::string &key, const TypedValue &default_value) const {
   if (!(*this)) {
     throw std::logic_error("CW::AttributeDictionary::get_attribute(): AttributeDictionary is null");

src/SUAPI-CppWrapper/model/ComponentDefinition.cpp

@@ -117,11 +117,6 @@ SUComponentDefinitionRef ComponentDefinition::ref() const {
 ComponentDefinition::operator SUComponentDefinitionRef() const {
   return this->ref();
 }
-ComponentDefinition::operator SUComponentDefinitionRef*() {
-  // TODO: test if the solution below works.
-  SUComponentDefinitionRef definition = this->ref();
-  return &definition;
-}
 
 
 ComponentInstance ComponentDefinition::create_instance() const {

src/SUAPI-CppWrapper/model/ComponentInstance.cpp

@@ -105,13 +105,6 @@ ComponentInstance::operator SUComponentInstanceRef() const {
 }
 
 
-ComponentInstance::operator SUComponentInstanceRef*() {
-  // TODO: test if the solution below works.
-  SUComponentInstanceRef instance = this->ref();
-  return &instance;
-}
-
-
 Transformation ComponentInstance::transformation() const {
   if (!(*this)) {
     throw std::logic_error("CW::ComponentInstance::transformation(): ComponentInstance is null");