Add functions to retrieve PDAL version information.

Author: jimmysoda

source/pdal/capi/CMakeLists.txt

@@ -4,6 +4,7 @@ find_package(PDAL REQUIRED CONFIG)
 message(STATUS "Found PDAL ${PDAL_VERSION}")
 
 set(SOURCES
+	Config.cpp
 	DimType.cpp
 	Pipeline.cpp
 	PointLayout.cpp
@@ -12,6 +13,7 @@ set(SOURCES
 )
 
 set(HEADERS
+	Config.h
 	Defines.h
 	DimType.h
 	Forward.h

source/pdal/capi/Config.cpp

@@ -0,0 +1,122 @@
+/*
+ * Copyright (c) Simverge Software LLC - All Rights Reserved
+ */
+
+#include "Config.h"
+
+#include <pdal/pdal_config.hpp>
+
+#include <cstring>
+#include <string>
+
+namespace pdal
+{
+	namespace capi
+	{
+		size_t PDALFullVersionString(char *version, size_t size)
+		{
+			size_t length = 0;
+
+			if (version && size > 0)
+			{
+				version[0] = '\0';
+				version[size-1] = '\0';
+
+				std::string s = pdal::Config::fullVersionString();
+				std::strncpy(version, s.c_str(), size - 1);
+				length = std::min(s.length(), size - 1);
+			}
+
+			return length;
+		}
+
+		size_t PDALVersionString(char *version, size_t size)
+		{
+			size_t length = 0;
+
+			if (version && size > 0)
+			{
+				version[0] = '\0';
+				version[size-1] = '\0';
+
+				std::string s = pdal::Config::versionString();
+				std::strncpy(version, s.c_str(), size - 1);
+				length = std::min(s.length(), size - 1);
+			}
+
+			return length;
+		}
+
+		int PDALVersionInteger()
+		{
+			return pdal::Config::versionInteger();
+		}
+
+		size_t PDALSha1(char *sha1, size_t size)
+		{
+			size_t length = 0;
+
+			if (sha1 && size > 0)
+			{
+				sha1[0] = '\0';
+				sha1[size-1] = '\0';
+
+				std::string s = pdal::Config::sha1();
+				std::strncpy(sha1, s.c_str(), size - 1);
+				length = std::min(s.length(), size - 1);
+			}
+
+			return length;
+		}
+
+		int PDALVersionMajor()
+		{
+			return pdal::Config::versionMajor();
+		}
+
+		int PDALVersionMinor()
+		{
+			return pdal::Config::versionMinor();
+		}
+
+		int PDALVersionPatch()
+		{
+			return pdal::Config::versionPatch();
+		}
+
+		size_t PDALDebugInformation(char *info, size_t size)
+		{
+			size_t length = 0;
+
+			if (info && size > 0)
+			{
+				info[0] = '\0';
+				info[size-1] = '\0';
+
+				std::string s = pdal::Config::debugInformation();
+				std::strncpy(info, s.c_str(), size - 1);
+				length = std::min(s.length(), size - 1);
+			}
+
+			return length;
+		}
+
+		size_t PDALPluginInstallPath(char *path, size_t size)
+		{
+			size_t length = 0;
+
+			if (path && size > 0)
+			{
+				path[0] = '\0';
+				path[size-1] = '\0';
+
+				std::string s = pdal::Config::pluginInstallPath();
+				std::strncpy(path, s.c_str(), size - 1);
+				length = std::min(s.length(), size - 1);
+			}
+
+			return length;
+		}
+	}
+}
+

source/pdal/capi/Config.h

@@ -0,0 +1,77 @@
+/*
+ * Copyright (c) Simverge Software LLC - All Rights Reserved
+ */
+
+#ifndef PDAL_CAPI_CONFIG_H
+#define PDAL_CAPI_CONFIG_H
+
+#include "Forward.h"
+
+/**
+ * @file Config.h
+ * Functions to PDAL version and configuration information.
+ */
+
+#ifdef __cplusplus
+
+namespace pdal
+{
+	namespace capi
+	{
+		extern "C"
+		{
+#else
+#include <stdbool.h>
+#endif
+			/**
+			 * @see pdal::config::fullVersionString
+			 */
+			PDAL_C_API size_t PDALFullVersionString(char *version, size_t size);
+
+			/**
+			 * @see pdal::config::versionString
+			 */
+			PDAL_C_API size_t PDALVersionString(char *version, size_t size);
+
+			/**
+			 * @see pdal::config::versionInteger
+			 */
+			PDAL_C_API int PDALVersionInteger();
+
+			/**
+			 * @see pdal::config::sha1
+			 */
+			PDAL_C_API size_t PDALSha1(char *sha1, size_t size);
+
+			/**
+			 * @see pdal::config::versionMajor
+			 */
+			PDAL_C_API int PDALVersionMajor();
+
+			/**
+			 * @see pdal::config::versionMinor
+			 */
+			PDAL_C_API int PDALVersionMinor();
+
+			/**
+			 * @see pdal::config::versionPatch
+			 */
+			PDAL_C_API int PDALVersionPatch();
+
+			/**
+			 * @see pdal::config::debugInformation
+			 */
+			PDAL_C_API size_t PDALDebugInformation(char *info, size_t size);
+
+			/**
+			 * @see pdal::config::pluginInstallPath
+			 */
+			PDAL_C_API size_t PDALPluginInstallPath(char *path, size_t size);
+
+#ifdef __cplusplus
+		}
+	}
+}
+#endif
+
+#endif

tests/pdal/capi/CMakeLists.txt

@@ -1,11 +1,17 @@
 set(TARGET test_pdal_c)
 
+find_package(PDAL REQUIRED CONFIG)
+
 set(CONFIGS )
 set(SOURCES main.c)
 set(HEADERS )
-set(DEPENDENCIES pdal_c)
+set(DEPENDENCIES 
+	${PDAL_LIBRARIES}
+	pdal_c
+)
 
 set(TESTS
+	ConfigTest
 	PipelineTest
 	PointLayoutTest
 	PointViewIteratorTest
@@ -20,7 +26,11 @@ foreach(TEST ${TESTS})
 endforeach()
 
 source_group("Config Files" FILES ${CONFIGS})
-include_directories(${CMAKE_SOURCE_DIR}/source)
+
+include_directories(
+	${CMAKE_SOURCE_DIR}/source
+	${PDAL_INCLUDE_DIRS}
+)
 
 add_executable(${TARGET} ${SOURCES} ${HEADERS} ${CONFIG})
 set_target_properties(${TARGET} PROPERTIES DEBUG_POSTFIX ${CMAKE_DEBUG_POSTFIX})

tests/pdal/capi/ConfigTest.c.in

@@ -0,0 +1,88 @@
+/*
+ * Copyright (c) Simverge Software LLC - All Rights Reserved
+ */
+
+#include <stdlib.h>
+#include <stdio.h>
+#include <assert.h>
+
+#include <pdal/capi/Config.h>
+#include <pdal/gitsha.h>
+#include <pdal/pdal_features.hpp>
+
+#include "greatest.h"
+
+SUITE(ConfigTest);
+
+TEST testPDALVersionInfo(void)
+{
+	int versionInteger = PDALVersionInteger();
+	ASSERT_EQ(PDAL_VERSION_INTEGER, versionInteger);
+
+	int major = PDALVersionMajor();
+	ASSERT_EQ(PDAL_VERSION_MAJOR, major);
+
+	int minor = PDALVersionMinor();
+	ASSERT_EQ(PDAL_VERSION_MINOR, minor);
+
+	int patch = PDALVersionPatch();
+	ASSERT_EQ(PDAL_VERSION_PATCH, patch);
+
+	ASSERT_EQ(major*10000 + minor*100 + patch, versionInteger);
+
+	char expected[64];
+	sprintf(expected, "%d.%d.%d", major, minor, patch);
+
+	char version[64];
+	size_t size = PDALVersionString(version, 64);
+	ASSERT(size > 0 && size <= 64);
+	ASSERT(version[0]);
+	ASSERT_STR_EQ(expected, version);
+	ASSERT_STR_EQ(PDAL_VERSION_STRING, version);
+
+	char sha1[64];
+	size = PDALSha1(sha1, 64);
+	ASSERT(size > 0 && size <= 64);
+	ASSERT(sha1[0]);
+
+	// Shorten SHA1 to six characters
+	ASSERT(size > 6);
+	sha1[6] = '\0';
+
+	sprintf(expected + strlen(version), " (git-version: %s)", sha1);
+
+	char fullVersion[64];
+	size = PDALFullVersionString(fullVersion, 64);
+	ASSERT(size > 0 && size <= 64);
+	ASSERT(fullVersion[0]);
+	ASSERT_STR_EQ(expected, fullVersion);
+
+	PASS();
+}
+
+TEST testPDALDebugInformation(void)
+{
+	char info[1024];
+	size_t size = PDALDebugInformation(info, 1024);
+	ASSERT(size > 0 && size <= 1024);
+	ASSERT(info[0]);
+	PASS();
+}
+
+TEST testPDALPluginInstallPath(void)
+{
+	char path[1024];
+	size_t size = PDALPluginInstallPath(path, 1024);
+	ASSERT(size > 0 && size <= 1024);
+	ASSERT(path[0]);
+	ASSERT_STR_EQ(PDAL_PLUGIN_INSTALL_PATH, path);
+	PASS();
+}
+
+
+GREATEST_SUITE(ConfigTest)
+{
+	RUN_TEST(testPDALVersionInfo);
+	RUN_TEST(testPDALDebugInformation);
+	RUN_TEST(testPDALPluginInstallPath);
+}

tests/pdal/capi/PipelineTest.c.in

@@ -10,7 +10,7 @@
 
 #include "greatest.h"
 
-SUITE(Pipeline);
+SUITE(PipelineTest);
 
 static char *gPipelineJson = NULL;
 

tests/pdal/capi/main.c

@@ -8,6 +8,7 @@
 
 #include "greatest.h"
 
+SUITE_EXTERN(ConfigTest);
 SUITE_EXTERN(PipelineTest);
 SUITE_EXTERN(PointLayoutTest);
 SUITE_EXTERN(PointViewIteratorTest);
@@ -18,6 +19,7 @@ GREATEST_MAIN_DEFS();
 int main(int argc, char **argv)
 {
 	GREATEST_MAIN_BEGIN();
+	RUN_SUITE(ConfigTest);
 	RUN_SUITE(PipelineTest);
 	RUN_SUITE(PointLayoutTest);
 	RUN_SUITE(PointViewIteratorTest);