Elektra Highlevel API

.gitignore

@@ -32,3 +32,8 @@ nbproject/
 #ignore macOS folder attribute files
 .DS_Store
 .directory
+
+#ignore CLion project files
+.idea/
+cmake-build-debug/
+cmake-build-release/

cmake/ElektraConfig.cmake.in

@@ -18,7 +18,7 @@ if (NOT elektra_imported_targets)
 endif()
 
 set (Elektra_INCLUDE_DIRS "@CMAKE_INSTALL_PREFIX@/include/@TARGET_INCLUDE_FOLDER@")
-set (Elektra_LIBRARIES elektra-core elektra-kdb)
+set (Elektra_LIBRARIES elektra-core elektra-kdb elektra-highlevel)
 
 find_path (Elektra_TEMPLATES_DIR
 	NAMES template.h

cmake/elektra.pc.in

@@ -9,5 +9,5 @@ templatedir=${prefix}/@TARGET_TEMPLATE_FOLDER@
 Name: @PACKAGE_NAME@
 Description: @PACKAGE_DESCRIPTION@
 Version: @KDB_VERSION@
-Libs: -L${libdir} -lelektra-core -lelektra-kdb
+Libs: -L${libdir} -lelektra-core -lelektra-kdb -lelektra-highlevel
 Cflags: -I${includedir}

doc/decisions/high_level_api.md

@@ -75,13 +75,18 @@ sure to use pass a `KeySet`, that has your whole specification included
 ### Error Handling
 
 ```c
-const char * elektraErrorMessage (const ElektraError * error);
-kdb_boolean_t elektraErrorAbort (const ElektraError * error);
-void elektraErrorFree (ElektraError * error)
+ElektraErrorCode elektraErrorCode (ElektraError * error);
+const char * elektraErrorDescription (ElektraError * error);
+ElektraErrorSeverity elektraErrorSeverity (ElektraError * error);
+ElektraErrorGroup elektraErrorGroup (ElektraError * error);
+ElektraErrorModule elektraErrorModule (ElektraError * error);
+
+void elektraErrorFree (ElektraError * error);
+
 ```
 
-`elektraErrorAbort` tells you if you need to quit your application because of severe
-issues that are permanent. Otherwise, developers can just print the message and
+`elektraErrorSeverity` tells you if you need to quit your application because of severe
+issues that are permanent (severity == ELEKTRA_ERROR_SEVERITY_FATAL). Otherwise, developers can just print the message and
 continue. (Default settings might be used then.)
 
 ### Simple Getters
@@ -113,7 +118,7 @@ kdb_long_double_t elektraGetLongDouble (Elektra * elektra, const char * name);
 
 ```c
 size_t elektraArraySize (Elektra * handle, const char * name);
-kdb_long_t elektraArrayLong (Elektra * handle, const char * name, size_t elem);
+const char * elektraGetStringArrayElement (Elektra * elektra, const char * name, size_t index);
 // same types as above
 
 ```

doc/tutorials/README.md

@@ -25,6 +25,7 @@ provides.
 - [Python Bindings](python-kdb.md)
 - [Ruby Bindings](/src/bindings/swig/ruby/README.md)
 - [Code Generation](/src/tools/gen/README.md)
+- [High Level API](/src/libs/highlevel/README.md)
 
 ## System Administrators
 

src/bindings/cpp/include/kdbcontext.hpp

@@ -262,7 +262,7 @@ class Context : public Subject
 	 * @par on_layer is called for every layer in the
 	 * specification.
 	 * @return the evaluated string
-	*/
+	 */
 	std::string evaluate (std::string const & key_name,
 			      std::function<bool(std::string const &, std::string &, bool in_group)> const & on_layer) const
 	{

src/bindings/cpp/include/kdbplugin.hpp

@@ -59,7 +59,7 @@ class Delegator
 
 private:
 	/**This function avoid that every return path need to release the
-	  * configuration. */
+	 * configuration. */
 	inline static int openHelper (ckdb::Plugin * handle, kdb::KeySet & config, ckdb::Key * errorKey, Builder builder)
 	{
 		if (config.lookup ("/module"))

src/bindings/glib/gelektra-kdb.c

@@ -20,7 +20,7 @@ static void gelektra_kdb_finalize (GObject * object)
 
 	/* Always chain up to the parent class; as with dispose(), finalize()
 	 * is guaranteed to exist on the parent's class virtual function table
-	*/
+	 */
 	G_OBJECT_CLASS (gelektra_kdb_parent_class)->finalize (object);
 }
 

src/bindings/glib/gelektra-key.c

@@ -69,7 +69,7 @@ static void gelektra_key_finalize (GObject * object)
 
 	/* Always chain up to the parent class; as with dispose(), finalize()
 	 * is guaranteed to exist on the parent's class virtual function table
-	*/
+	 */
 	G_OBJECT_CLASS (gelektra_key_parent_class)->finalize (object);
 }
 

src/bindings/glib/gelektra-keyset.c

@@ -19,7 +19,7 @@ static void gelektra_keyset_finalize (GObject * object)
 
 	/* Always chain up to the parent class; as with dispose(), finalize()
 	 * is guaranteed to exist on the parent's class virtual function table
-	*/
+	 */
 	G_OBJECT_CLASS (gelektra_keyset_parent_class)->finalize (object);
 }
 

src/bindings/intercept/env/benchmarks/benchmark_getenv.cpp

@@ -150,12 +150,12 @@ __attribute__ ((noinline)) void benchmark_kslookup ()
 	using namespace kdb; // needed for KS_END
 	kdb::KeySet ks (100,
 			/*
-			*kdb::Key("user/env/override/some", KEY_END),
-			*kdb::Key("user/env/override/a/key", KEY_END),
-			*kdb::Key("user/env/override/b/key", KEY_END),
-			*kdb::Key("user/env/override/c/key", KEY_END),
-			*kdb::Key("user/env/override/d/key", KEY_END),
-			*/
+			 *kdb::Key("user/env/override/some", KEY_END),
+			 *kdb::Key("user/env/override/a/key", KEY_END),
+			 *kdb::Key("user/env/override/b/key", KEY_END),
+			 *kdb::Key("user/env/override/c/key", KEY_END),
+			 *kdb::Key("user/env/override/d/key", KEY_END),
+			 */
 			KS_END);
 	for (int i = 0; i < nr_keys; ++i)
 	{

src/error/exporterrors.cpp

@@ -111,6 +111,28 @@ ostream & operator<< (ostream & os, parse_t & p)
 
 	os << endl << endl;
 
+	/* Temporarily disable enum generation.
+    os << "typedef enum {" << endl;
+    for (size_t i = 1; i < p.size (); ++i)
+    {
+	if (p[i]["unused"] == "yes")
+	{
+	    continue;
+	}
+
+	if (p[i]["macro"].empty ())
+	{
+	    continue;
+	}
+
+	os << "    ELEKTRA_ERROR_CODE_";
+	os << p[i]["enum"] << " = " << i << "," << endl;
+    }
+    os << "} ElektraErrorCode;" << endl;
+
+	os << endl << endl;
+	*/
+
 	for (size_t i = 1; i < p.size (); ++i)
 	{
 		if (p[i]["unused"] == "yes")

src/error/specification

@@ -69,13 +69,13 @@ ingroup:kdb
 
 number:9
 description:Insufficient permissions to open configuration file for writing. You might want to retry as root.
-severity:normal
+severity:error
 ingroup:kdb
 see:75 109 110
 
 number:10
 description:general parse error
-severity:normal
+severity:error
 ingroup:kdb
 macro:PARSE
 
@@ -656,7 +656,7 @@ see:9 75 110
 
 number:110
 description:could not open configuration file for reading.
-severity:normal
+severity:error
 ingroup:plugin
 module:storage
 see:9 75 109

src/include/CMakeLists.txt

@@ -95,6 +95,11 @@ install (FILES
 	kdbinvoke.h
 	kdbutility.h
 	"${CMAKE_CURRENT_BINARY_DIR}/kdbversion.h"
+	elektra.h
+	elektra_generic.h
+	elektra_error.h
+	elektra_error_codes.h
+	elektra_conversion.h
 	DESTINATION include/${TARGET_INCLUDE_FOLDER})