Paraconf release 1.1.0

 * Add a way to query the path to the parsed configuration file
 * Add a way to check version

Author: jbigot

CMakeLists.txt

@@ -51,10 +51,24 @@ set(paraconf_VERSION_MAJOR "${CMAKE_MATCH_1}")
 set(paraconf_VERSION_MINOR "${CMAKE_MATCH_2}")
 set(paraconf_VERSION_PATCH "${CMAKE_MATCH_3}")
 set(paraconf_VERSION_MODIF "${CMAKE_MATCH_5}")
-if("git" STREQUAL "${paraconf_VERSION_MODIF}" OR "alpha" STREQUAL "${paraconf_VERSION_MODIF}")
+set(paraconf_VERSION_VARIANT 0)
+if("git" STREQUAL "${paraconf_VERSION_MODIF}" OR "${paraconf_VERSION_MODIF}" MATCHES "(alpha|beta|rc)([0-9]*)")
+	if("git" STREQUAL "${paraconf_VERSION_MODIF}")
+		execute_process(COMMAND "${paraconf_SOURCE_DIR}/cmake/version-uid" "--nbdays" WORKING_DIRECTORY "${paraconf_SOURCE_DIR}" OUTPUT_VARIABLE paraconf_VERSION_VARIANT OUTPUT_STRIP_TRAILING_WHITESPACE)
+	else()
+		if("alpha" STREQUAL "${CMAKE_MATCH_1}")
+			set(paraconf_VERSION_VARIANT 65512)
+		elseif("beta" STREQUAL "${CMAKE_MATCH_1}")
+			set(paraconf_VERSION_VARIANT 65520)
+		elseif("rc" STREQUAL "${CMAKE_MATCH_1}")
+			set(paraconf_VERSION_VARIANT 65528)
+		endif()
+		math(EXPR paraconf_VERSION_VARIANT "${paraconf_VERSION_VARIANT} + 0${CMAKE_MATCH_2}")
+	endif()
 	execute_process(COMMAND "${paraconf_SOURCE_DIR}/cmake/version-uid" "${paraconf_VERSION_MODIF}" WORKING_DIRECTORY "${paraconf_SOURCE_DIR}" OUTPUT_VARIABLE paraconf_VERSION_MODIF OUTPUT_STRIP_TRAILING_WHITESPACE)
 endif()
 set(paraconf_VERSION "${paraconf_VERSION_MAJOR}.${paraconf_VERSION_MINOR}.${paraconf_VERSION_PATCH}${paraconf_VERSION_MODIF}")
+configure_file(include/paraconf_version.h.in paraconf_version.h @ONLY)
 
 
 # Libraries
@@ -85,7 +99,7 @@ install(TARGETS paraconf EXPORT PC_export
 	LIBRARY DESTINATION "${CMAKE_INSTALL_LIBDIR}" COMPONENT Runtime NAMELINK_COMPONENT Development
 	INCLUDES DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}"
 )
-install(FILES include/paraconf.h "${paraconf_BINARY_DIR}/paraconf_export.h"
+install(FILES include/paraconf.h "${paraconf_BINARY_DIR}/paraconf_export.h" "${paraconf_BINARY_DIR}/paraconf_version.h"
 	DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}"
 	COMPONENT Development
 )

VERSION

@@ -1 +1 @@
-1.0.4
+1.1.0

cmake/version-uid

@@ -7,18 +7,30 @@
 set -e
 export LC_ALL=C
 
-PRE_RELEASE="${1-alpha}"
-WORK_DIR="${2-.}"
 GIT_EXE="${GIT_EXE-"$(which git 2> /dev/null || true)"}"
 
+WORK_DIR="${2-.}"
+cd "${WORK_DIR}"
+
+if [ "x${1}" = "x--nbdays" ]
+then
+	if [ -x "${GIT_EXE}" ]
+	then
+		echo "$(( ( $(date +%s -d $(git show -s --format=%cs HEAD | sed 's/ .*//') ) - $(date +%s -u -d 20150101) ) / 86400 ))"
+	else
+		echo "$(( ( $(date +%s -u) - $(date +%s -u -d 20150101) ) / 86400 ))"
+	fi
+	exit
+fi
+
+PRE_RELEASE="${1-alpha}"
 if [ git = "${PRE_RELEASE}" ]
 then
 	PRE_RELEASE=alpha
 fi
 
 if [ -x "${GIT_EXE}" ]
 then
-	cd "${WORK_DIR}"
 	GIT_DATE="$("${GIT_EXE}" show -s --format=%ci HEAD | sed 's/ .*//')"
 	GIT_SHA1="$("${GIT_EXE}" rev-parse --verify --short=7 HEAD)"
 	echo "-${PRE_RELEASE}.${GIT_DATE}.${GIT_SHA1}"

include/paraconf.h

@@ -12,6 +12,7 @@
 #include <yaml.h>
 
 #include "paraconf_export.h"
+#include "paraconf_version.h"
 
 #ifdef __cplusplus
 extern "C" {
@@ -55,14 +56,18 @@ typedef struct PC_errhandler_s {
 
 } PC_errhandler_t;
 
+/** An opaque type describing a yaml document
+ */
+typedef struct PC_document_s PC_document_t;
+
 /** An opaque type describing a yaml tree (possibly a leaf node)
  */
 typedef struct PC_tree_s {
 	/// The tree status
 	PC_status_t status;
 
 	/// The document containing the tree
-	yaml_document_t* document;
+	PC_document_t* pcdoc;
 
 	/// the node inside the tree
 	yaml_node_t* node;
@@ -87,9 +92,28 @@ static inline PC_status_t PC_status(PC_tree_t tree)
 }
 
 /** Return a human-readabe message describing the last error that occured in paraconf
+ *
+ * \return a human-readabe message describing the last error that occured in paraconf
  */
 char PARACONF_EXPORT* PC_errmsg();
 
+/** Return the version of paraconf
+ *
+ * The version is returned as a 64 bit integer where:
+ * - the 16 upper bits represent the major revision number
+ * - the 16 following bits represent the minor revision number
+ * - the 16 following bits represent the patch revision number
+ * - the 16 lower bits can represent a variant such as pre-release
+ *   - 0 for a normal release
+ *   - number of days since Jan. 01 2015 for a git revision
+ *   - 65532 (2^16-24) + alpha number for an alpha release
+ *   - 65532 (2^16-16) + beta number for a beta release
+ *   - 65532 (2^16-8) + rc-number for a release candidate
+ *
+ * \return the version of paraconf
+ */
+uint64_t PARACONF_EXPORT PC_version();
+
 /** Sets the error handler to use
  *
  * PC_assert is the default handler before this function is called
@@ -142,6 +166,11 @@ PC_tree_t PARACONF_EXPORT PC_parse_string(const char* document);
  */
 PC_tree_t PARACONF_EXPORT PC_root(yaml_document_t* document);
 
+/** Returns the path of the file from which the document was loaded
+ * (or `\<string\>' if this was not loaded from a file)
+ */
+const char PARACONF_EXPORT* PC_path(PC_tree_t tree);
+
 /** Looks for a node in a yaml document given a ypath index
  *
  * Does nothing if the provided tree is in error and returns the input tree.

include/paraconf_version.h.in

@@ -0,0 +1,43 @@
+/* Copyright (C) The Paraconf development team, see COPYRIGHT.md file at the
+ *               root of the project or at https://github.com/pdidev/paraconf
+ * 
+ * SPDX-License-Identifier: MIT
+ */
+
+#ifndef PARACONF_VERSION_H__
+#define PARACONF_VERSION_H__
+
+#include <stdint.h>
+
+// clang-format off
+/// paraconf major revision number
+#define PARACONF_VERSION_MAJOR @paraconf_VERSION_MAJOR@
+/// paraconf minor revision number
+#define PARACONF_VERSION_MINOR @paraconf_VERSION_MINOR@
+/// paraconf patch revision number
+#define PARACONF_VERSION_PATCH @paraconf_VERSION_PATCH@
+/** paraconf version variant, such as pre-release
+ * - 0 for a normal release
+ * - number of days since Jan. 01 2015 for a git revision
+ * - 65532 (2^16-24) + alpha number for an alpha release
+ * - 65532 (2^16-16) + beta number for a beta release
+ * - 65532 (2^16-8) + rc-number for a release candidate
+ */
+#define PARACONF_VERSION_VARIANT @paraconf_VERSION_VARIANT@
+// clang-format on
+/** The version of paraconf as a 64 bit integer where:
+ * - the 16 upper bits represent the major revision number
+ * - the 16 following bits represent the minor revision number
+ * - the 16 following bits represent the patch revision number
+ * - the 16 lower bits can represent a variant such as pre-release
+ *   - 0 for a normal release
+ *   - number of days since Jan. 01 2015 for a git revision
+ *   - 65512 (2^16-24) + alpha number for an alpha release
+ *   - 65520 (2^16-16) + beta number for a beta release
+ *   - 65528 (2^16-8) + rc-number for a release candidate
+ */
+#define PARACONF_VERSION                                                                                                                             \
+	((((uint64_t)(PARACONF_VERSION_MAJOR)) << 48) | (((uint64_t)(PARACONF_VERSION_MINOR)) << 32) | (((uint64_t)(PARACONF_VERSION_PATCH)) << 16)      \
+	 | ((uint64_t)(PARACONF_VERSION_VARIANT)))
+
+#endif // PARACONF_VERSION_H__

src/api.c

@@ -22,6 +22,27 @@
 
 static const char* nodetype[4] = {"none", "scalar", "sequence", "mapping"};
 
+static const char* PC_NO_PATH = "<string>";
+
+static inline void pc_path_free(const char* path)
+{
+	if (path != PC_NO_PATH) free((void*)path);
+}
+
+static inline void pc_set_path(PC_tree_t tree, const char* path)
+{
+	pc_path_free(tree.pcdoc->path);
+	size_t pathlen = strlen(path);
+	char* pathcpy = malloc((pathlen + 1) * sizeof(char));
+	strncpy(pathcpy, path, pathlen);
+	tree.pcdoc->path = pathcpy;
+}
+
+uint64_t PC_version()
+{
+	return PARACONF_VERSION;
+}
+
 PC_tree_t PC_parse_path(const char* path)
 {
 	PC_tree_t restree = {PC_OK, NULL, NULL};
@@ -41,6 +62,7 @@ PC_tree_t PC_parse_path(const char* path)
 	}
 
 	fclose(conf_file);
+	pc_set_path(restree, path);
 	return restree;
 
 err1:
@@ -169,10 +191,17 @@ PC_tree_t PC_parse_file(FILE* conf_file)
 
 PC_tree_t PC_root(yaml_document_t* document)
 {
-	PC_tree_t restree = {PC_OK, document, yaml_document_get_root_node(document)};
+	PC_tree_t restree = {PC_OK, malloc(sizeof(PC_document_t)), yaml_document_get_root_node(document)};
+	PC_document_t pcdoc = {*document, PC_NO_PATH};
+	*restree.pcdoc = pcdoc;
 	return restree;
 }
 
+const char* PC_path(PC_tree_t tree)
+{
+	return tree.pcdoc->path;
+}
+
 PC_tree_t PC_get(const PC_tree_t tree, const char* index_fmt, ...)
 {
 	va_list ap;
@@ -364,8 +393,11 @@ PC_status_t PC_bool(const PC_tree_t tree, int* res)
 
 PC_status_t PC_tree_destroy(PC_tree_t* tree)
 {
-	yaml_document_delete(tree->document);
-	free(tree->document);
+	yaml_document_delete(&tree->pcdoc->document);
+	pc_path_free(tree->pcdoc->path);
+	tree->pcdoc->path = NULL;
+	free(tree->pcdoc);
+	tree->pcdoc = NULL;
 	tree->node = NULL;
 	return tree->status;
 }

src/tools.h

@@ -12,10 +12,11 @@
 #include <string.h>
 
 #include "paraconf.h"
+#include "ypath.h"
 
 static inline PC_tree_t subtree(PC_tree_t tree, int key)
 {
-	tree.node = yaml_document_get_node(tree.document, key);
+	tree.node = yaml_document_get_node(&tree.pcdoc->document, key);
 	assert(tree.node);
 	return tree;
 }

src/ypath.c

@@ -99,7 +99,7 @@ static PC_tree_t get_seq_idx(const PC_tree_t tree, const char** req_index, const
 			err0
 		);
 	}
-	restree.node = yaml_document_get_node(tree.document, *(tree.node->data.sequence.items.start + seq_idx));
+	restree.node = yaml_document_get_node(&tree.pcdoc->document, *(tree.node->data.sequence.items.start + seq_idx));
 	assert(tree.node);
 
 	*req_index = index;
@@ -177,7 +177,7 @@ static PC_tree_t get_map_key_val(const PC_tree_t tree, const char** req_index, c
 			err0
 		);
 	}
-	restree.node = yaml_document_get_node(tree.document, pair->value);
+	restree.node = yaml_document_get_node(&tree.pcdoc->document, pair->value);
 	assert(tree.node);
 
 	*req_index = index;
@@ -291,7 +291,7 @@ static PC_tree_t get_map_idx_key(const PC_tree_t tree, const char** req_index, c
 	++index;
 
 	// handle pair
-	restree.node = yaml_document_get_node(tree.document, pair->key);
+	restree.node = yaml_document_get_node(&tree.pcdoc->document, pair->key);
 	assert(tree.node);
 
 	*req_index = index;
@@ -343,7 +343,7 @@ static PC_tree_t get_map_idx_val(const PC_tree_t tree, const char** req_index, c
 	++index;
 
 	// handle pair
-	restree.node = yaml_document_get_node(tree.document, pair->value);
+	restree.node = yaml_document_get_node(&tree.pcdoc->document, pair->value);
 	assert(tree.node);
 
 	*req_index = index;

src/ypath.h

@@ -9,6 +9,13 @@
 
 #include "paraconf.h"
 
+struct PC_document_s {
+	/// The underlying YAML document
+	yaml_document_t document;
+	/// The path to the file from which the document was parsed
+	const char* path;
+};
+
 PC_tree_t PARACONF_EXPORT PC_sget(PC_tree_t tree, const char* index);
 
 #endif // YPATH_H__