Add versioning and 1.1.0 as version (#16)

Author: gitbuda

CMakeLists.txt

@@ -13,7 +13,13 @@
 # limitations under the License.
 
 cmake_minimum_required(VERSION 3.8)
-project(mgclient VERSION 0.1)
+
+project(mgclient VERSION 1.1.0)
+# Minor version increase can also mean ABI incompatibility with previous
+# versions. IMPORTANT: Take care of the SO version manually.
+set(mgclient_SOVERSION 2)
+add_definitions(-DMGCLIENT_VERSION="${mgclient_VERSION}")
+
 # Building tests is disabled by default to simplify the default build config.
 option(BUILD_TESTING "" OFF)
 message(STATUS "BUILD_TESTING: ${BUILD_TESTING}")

examples/basic.c

@@ -9,6 +9,8 @@ int main(int argc, char *argv[]) {
     exit(1);
   }
 
+  printf("mgclient version: %s\n", mg_client_version());
+
   mg_session_params *params = mg_session_params_make();
   if (!params) {
     fprintf(stderr, "failed to allocate session parameters\n");

examples/basic.cpp

@@ -9,6 +9,7 @@ int main(int argc, char *argv[]) {
     exit(1);
   }
 
+  std::cout << "mgclient version: " << mg::Client::Version() << std::endl;
   mg::Client::Params params;
   params.host = argv[1];
   params.port = static_cast<uint16_t>(atoi(argv[2]));

include/mgclient.h

@@ -129,6 +129,11 @@ extern "C" {
 
 #include <stdint.h>
 
+/// Client software version.
+///
+/// \return Client version in the major.minor.patch format.
+MGCLIENT_EXPORT const char *mg_client_version();
+
 /// An enum listing all the types as specified by Bolt protocol.
 enum mg_value_type {
   MG_VALUE_TYPE_NULL,

include/mgclient.hpp

@@ -18,6 +18,7 @@
 #include <optional>
 
 #include "mgclient.h"
+
 #include "mgvalue.hpp"
 
 namespace mg {
@@ -41,6 +42,10 @@ class Client {
   Client &operator=(Client &&) = delete;
   ~Client();
 
+  /// \brief Client software version.
+  /// \return client version in the major.minor.patch format.
+  static const char *Version();
+
   /// \brief Executes the given Cypher `statement`.
   /// \return true when the statement is successfully executed, false otherwise.
   /// \note
@@ -121,6 +126,8 @@ inline Client::Client(mg_session *session) : session_(session) {}
 
 inline Client::~Client() { mg_session_destroy(session_); }
 
+inline const char *Client::Version() { return mg_client_version(); }
+
 inline bool Client::Execute(const std::string &statement) {
   int status = mg_session_run(session_, statement.c_str(), nullptr, nullptr,
                               nullptr, nullptr);

src/CMakeLists.txt

@@ -45,6 +45,7 @@ target_link_libraries(mgclient-static PRIVATE ${OPENSSL_LIBRARIES} project_optio
 add_library(mgclient-shared SHARED ${mgclient_src_files})
 set_target_properties(mgclient-shared PROPERTIES
         OUTPUT_NAME mgclient
+        SOVERSION ${mgclient_SOVERSION}
         C_VISIBILITY_PRESET hidden)
 target_include_directories(mgclient-shared
         PUBLIC

src/mgclient.c

@@ -34,6 +34,8 @@
 #include "mgsession.h"
 #include "mgvalue.h"
 
+const char *mg_client_version() { return MGCLIENT_VERSION; }
+
 typedef struct mg_session_params {
   const char *address;
   const char *host;