Move headers Part 3

.cirrus.yml

@@ -266,7 +266,8 @@ task:
                 $CIRRUS_WORKING_DIR
       git reset --hard $CIRRUS_CHANGE_IN_REPO
     else
-      git clone https://x-access-token:${CIRRUS_REPO_CLONE_TOKEN}@github.com/${CIRRUS_REPO_FULL_NAME}.git $CIRRUS_WORKING_DIR
+      git clone --branch=$CIRRUS_BASE_BRANCH https://x-access-token:${CIRRUS_REPO_CLONE_TOKEN}@github.com/${CIRRUS_REPO_FULL_NAME}.git \
+                $CIRRUS_WORKING_DIR
       git fetch origin pull/$CIRRUS_PR/head:pull/$CIRRUS_PR
       git config user.email "[email protected]"
       git config user.name "nobody"
@@ -309,7 +310,8 @@ task:
                 $CIRRUS_WORKING_DIR
       git reset --hard $CIRRUS_CHANGE_IN_REPO
     else
-      git clone https://x-access-token:${CIRRUS_REPO_CLONE_TOKEN}@github.com/${CIRRUS_REPO_FULL_NAME}.git $CIRRUS_WORKING_DIR
+      git clone --branch=$CIRRUS_BASE_BRANCH https://x-access-token:${CIRRUS_REPO_CLONE_TOKEN}@github.com/${CIRRUS_REPO_FULL_NAME}.git \
+                $CIRRUS_WORKING_DIR
       git fetch origin pull/$CIRRUS_PR/head:pull/$CIRRUS_PR
       git config user.email "[email protected]"
       git config user.name "nobody"

.github/workflows/macOS.yml

@@ -75,12 +75,31 @@ jobs:
 
     - name: Install Dependencies
       run: |
-        brew update
+        set -ex
+
         brew config
-        # Unlink parallel package, because of conflict with moreutils
-        brew unlink parallel || >&2 printf 'Unlinking parallel failed.`\n'
-        # Uninstall old Python versions and azure-cli due to file conflicts
-        brew remove azure-cli pipx [email protected] [email protected]|| >&2 printf 'Uninstalling old python versions and azure-cli failed.`\n'
+
+        brew update
+
+        # homebrew fails to upgrade python due to unlinking failure
+        # (cf. https://github.com/actions/setup-python/issues/577 )
+        rm -f /usr/local/bin/2to3
+        rm -f /usr/local/bin/idle3
+        rm -f /usr/local/bin/pydoc3
+        rm -f /usr/local/bin/python3
+        rm -f /usr/local/bin/python3-config
+        rm -f /usr/local/bin/2to3-3.11
+        rm -f /usr/local/bin/idle3.11
+        rm -f /usr/local/bin/pydoc3.11
+        rm -f /usr/local/bin/python3.11
+        rm -f /usr/local/bin/python3.11-config
+        rm -f /usr/local/lib/libtcl8.6.dylib
+        rm -f /usr/local/lib/libtk8.6.dylib
+        rm -f /usr/local/bin/go
+        rm -f /usr/local/bin/gofmt
+
+        brew upgrade
+
         brew install augeas \
           antlr \
           antlr4-cpp-runtime \
@@ -113,10 +132,13 @@ jobs:
           yajl \
           yaml-cpp \
           zeromq
+
         if [ "$CC" = 'clang' ]; then
           brew install --cask oclint
         fi
+
         brew install --cask adoptopenjdk
+
         # Try to install `checkbashisms` (The file server that hosts the package is unfortunately quite unreliable.)
         brew install checkbashisms || >&2 printf 'Warning: Unable to install `checkbashims`\n'
 

benchmarks/CMakeLists.txt

@@ -1,11 +1,9 @@
 include (LibAddMacros)
 
-add_headers (HDR_FILES)
-
 macro (do_benchmark source)
-	include_directories ("${CMAKE_CURRENT_SOURCE_DIR}")
 	set (SOURCES ${HDR_FILES} ${ADDITIONAL_SOURCES} benchmarks.c benchmarks.h ${source}.c)
 	add_executable (benchmark_${source} ${SOURCES})
+	target_include_directories (benchmark_${source} PRIVATE "${CMAKE_SOURCE_DIR}/src/include" "${CMAKE_BINARY_DIR}/src/include")
 
 	target_link_elektra (benchmark_${source} elektra-kdb elektra-meta)
 
@@ -55,6 +53,7 @@ if (ENABLE_OPTIMIZATIONS AND NOT WIN32)
 endif (ENABLE_OPTIMIZATIONS AND NOT WIN32)
 
 add_executable (benchmark_plugingetset plugingetset.c)
+target_include_directories (benchmark_plugingetset PRIVATE "${CMAKE_SOURCE_DIR}/src/include" "${CMAKE_BINARY_DIR}/src/include")
 target_link_elektra (benchmark_plugingetset elektra-core elektra-kdb)
 
 target_link_elektra (benchmark_diff elektra-kdb)

benchmarks/benchmarks.c

@@ -7,12 +7,13 @@
  */
 
 #define _GNU_SOURCE
-#include <benchmarks.h>
+#include "./benchmarks.h"
 #ifdef HAVE_HSEARCHR
 #include <search.h>
 #endif
 #include <sys/time.h>
 
+#include <internal/macros/attributes.h>
 #include <internal/utility/alloc.h>
 
 struct timeval start;

benchmarks/changetracking.c

@@ -1,7 +1,10 @@
 #include "./benchmarks.h"
 
+#include <internal/macros/attributes.h>
+
 #include <getopt.h>
 #include <stdbool.h>
+#include <stddef.h>
 
 size_t keys = 5000;
 char * keyNameFormat = "user:/test/sw/org/myapp/#0/current/section/subsection/key%zu";

benchmarks/cmp.c

@@ -6,7 +6,7 @@
  * @copyright BSD License (see LICENSE.md or https://www.libelektra.org)
  */
 
-#include <benchmarks.h>
+#include "./benchmarks.h"
 
 #include <ctype.h>
 
@@ -86,7 +86,7 @@ int main (void)
 	long long nrIterations = 100000000;
 	const char str1[] = "some string to be compared with/some\\/more with a long common part, and only a bit different";
 	char * str2 = elektraMalloc (sizeof (str1));
-	strcat (str2, str1);
+	strcpy (str2, str1);
 	str2[sizeof (str1) - 5] = 'X';
 
 	int res = 0;

benchmarks/createkeys.c

@@ -6,7 +6,7 @@
  * @copyright BSD License (see LICENSE.md or https://www.libelektra.org)
  */
 
-#include <benchmarks.h>
+#include "./benchmarks.h"
 
 void benchmarkDel (void)
 {

benchmarks/deepdup.c

@@ -6,7 +6,7 @@
  * @copyright BSD License (see LICENSE.md or https://www.libelektra.org)
  */
 
-#include <benchmarks.h>
+#include "./benchmarks.h"
 
 Key * key;
 

benchmarks/diff.c

@@ -1,4 +1,5 @@
-#include <benchmarks.h>
+#include "./benchmarks.h"
+
 #include <elektra/core.h>
 #include <elektra/diff.h>
 

benchmarks/kdb.c

@@ -8,10 +8,12 @@
 
 #include <stdio.h>
 
-#include <benchmarks.h>
+#include "./benchmarks.h"
+
 #include <elektra/core/key.h>
 #include <elektra/core/keyset.h>
 #include <elektra/kdb/kdb.h>
+
 #define NUM_RUNS 7
 
 #define CSV_STR_FMT "%s;%s;%d\n"

benchmarks/kdbget.c

@@ -8,10 +8,12 @@
 
 #include <stdio.h>
 
-#include <benchmarks.h>
+#include "./benchmarks.h"
+
 #include <elektra/core/key.h>
 #include <elektra/core/keyset.h>
 #include <elektra/kdb/kdb.h>
+
 #define CSV_STR_FMT "%s;%s;%d\n"
 
 

benchmarks/kdbmodify.c

@@ -8,10 +8,12 @@
 
 #include <stdio.h>
 
-#include <benchmarks.h>
+#include "./benchmarks.h"
+
 #include <elektra/core/key.h>
 #include <elektra/core/keyset.h>
 #include <elektra/kdb/kdb.h>
+
 #define CSV_STR_FMT "%s;%s;%d\n"
 
 

benchmarks/large.c

@@ -6,7 +6,7 @@
  * @copyright BSD License (see LICENSE.md or https://www.libelektra.org)
  */
 
-#include <benchmarks.h>
+#include "./benchmarks.h"
 
 KDB * kdb;
 Key * key;

benchmarks/memoryleak.c

@@ -7,12 +7,13 @@
  */
 
 #include <stdio.h>
+#include <unistd.h>
+
+#include "./benchmarks.h"
 
-#include <benchmarks.h>
 #include <elektra/core/key.h>
 #include <elektra/core/keyset.h>
 #include <elektra/kdb/kdb.h>
-#include <unistd.h>
 
 #define NUM_RUNS 30
 

benchmarks/opmphm.c

@@ -20,7 +20,7 @@
 #endif
 
 // ==== INCLUDE SECTION ====
-#include "benchmarks.h"
+#include "./benchmarks.h"
 #ifdef HAVE_HSEARCHR
 #include <search.h>
 #endif
@@ -29,13 +29,14 @@
 #include <omp.h>
 #endif
 
-#include "../src/libs/elektra/opmphm.c"
-#include "../src/libs/elektra/opmphmpredictor.c"
-#include "../src/libs/elektra/rand.c"
+#include "../src/libs/core/opmphm.c"
+#include "../src/libs/core/opmphmpredictor.c"
+#include "../src/libs/core/rand.c"
 #include <sys/time.h>
 
 #include <internal/core/keyset.h>
 #include <internal/core/lookup.h>
+#include <internal/macros/attributes.h>
 
 int32_t elektraRandBenchmarkInitSeed;
 

benchmarks/plugingetset.c

@@ -12,12 +12,12 @@
 #include <elektra/core/key.h>
 #include <elektra/core/keyset.h>
 
+#include <elektra/utility/format.h>
 #include <internal/plugin/load.h>
 #include <internal/plugin/struct.h>
 #include <internal/pluginload/module.h>
 #include <internal/utility/alloc.h>
 #include <internal/utility/compare.h>
-#include <internal/utility/format.h>
 
 int main (int argc, char ** argv)
 {

benchmarks/storage.c

@@ -9,8 +9,10 @@
 #include <stdio.h>
 #include <stdlib.h>
 
-#include <benchmarks.h>
+#include "./benchmarks.h"
+
 #include <internal/plugin/load.h>
+
 #include <tests.h>
 
 #define CSV_STR_FMT "%s;%s;%d\n"

doc/CODING.md

@@ -130,7 +130,7 @@ You can also enable that formatting runs automatically before commiting using `s
 - C-Files have extension `.c`, Header files `.h`.
 - Use internal functions: prefer to use `elektraMalloc`, `elektraFree`.
 
-**Example:** [src/libs/elektra/kdb.c](/src/libs/elektra/kdb.c)
+**Example:** [src/libs/kdb/kdb.c](/src/libs/kdb/kdb.c)
 
 #### Clang Format
 

doc/Doxyfile

@@ -907,8 +907,8 @@ WARN_LOGFILE           = @OUTPUT_DIRECTORY@/doxygen.log
 # Note: If this tag is empty the current directory is searched.
 
 INPUT                  = @PROJECT_SOURCE_DIR@/src/libs \
-                         @PROJECT_SOURCE_DIR@/src/libs/loader/doc.c \
-                         @PROJECT_SOURCE_DIR@/src/libs/getenv/README.md \
+                         @PROJECT_SOURCE_DIR@/src/libs/pluginload/doc.c \
+                         @PROJECT_SOURCE_DIR@/src/bindings/intercept/env/README.md \
                          @PROJECT_SOURCE_DIR@/src/include \
                          @PROJECT_SOURCE_DIR@/src/bindings/cpp/include \
                          @PROJECT_SOURCE_DIR@/src/bindings/jna/libelektra/src \

doc/KEYNAMES.md

@@ -6,7 +6,7 @@ This document is a full explanation of how _key names_ work in Elektra.
 
 In addition to this document, a reference Python implementation can be found in [keynames.py](../scripts/keynames.py).
 The goal of the Python implementation is not to be fast, or to be used in any way other than as a reference.
-If there are any discrepancies between this document, the Python implementation and the actual C implementation in [src/libs/elektra/keyname.c](../src/libs/elektra/keyname.c), you should consider them as follows:
+If there are any discrepancies between this document, the Python implementation and the actual C implementation in [src/libs/elektra/keyname.c](../src/libs/core/keyname.c), you should consider them as follows:
 
 1. The C implementation is optimized for speed and thus much harder to implement correctly.
 2. In most cases, this document outranks the Python implementation.

doc/decisions/2_solutions_clear/simplify_api.md

@@ -2,7 +2,7 @@
 
 ## Problem
 
-According to [symbols.map](/src/libs/elektra/symbols.map) the public core API has 124 symbols¹, which is arguable too much for a key-value API which has as highest goal simplicity.
+According to [symbols.map](/src/libs/core/symbols.map) the public core API has 124 symbols¹, which is arguable too much for a key-value API which has as highest goal simplicity.
 
 In particular following areas have many functions and are not simple:
 

doc/decisions/4_decided/private_api.md

@@ -24,7 +24,7 @@ All other headers are anybody's guess.
 - Also allow other libraries (e.g. a new `libelektra-operations`) to access non-public API.
   Such libraries need to have a good reason (e.g. performance, impossible otherwise, etc.) why they access non-public API and they need to be kept up-to-date.
   If a library cannot provide a stable API on top of the unstable non-public API, it clearly needs to state which APIs are not stable.
-- Put struct definitions of Key/KeySet in a separate header file, which gets included by parts that need it (see also [Header File Structure](../5_partially_implemented/header_file_structure.md)).
+- Put struct definitions of Key/KeySet in a separate header file, which gets included by parts that need it (see also [Header File Structure](../6_implemented/header_file_structure.md)).
 
 ## Rationale
 
@@ -48,6 +48,6 @@ All other headers are anybody's guess.
 
 ## Related Decisions
 
-- [Header File Structure](../5_partially_implemented/header_file_structure.md)
+- [Header File Structure](../6_implemented/header_file_structure.md)
 
 ## Notes

doc/decisions/5_partially_implemented/library_split.md → doc/decisions/6_implemented/library_split.md

@@ -102,7 +102,7 @@ All currently planned libraries and their respective API prefixes are listed in
   (Note: previously `libelektra-plugin` merged with `libelektra-invoke`)
 
 - `libelektra-pluginload`:
-  Internal static library, linked into `libelektra-plugin` (re-exported) and `libelektra-kdb` (not exported).
+  Internal object library, linked into `libelektra-plugin` (re-exported) and `libelektra-kdb` (not exported).
   Contains the code for loading plugins.
 
   **Prefix:**: `elektraPlugin*` (shared with `libelektra-plugin` because exported there)
@@ -140,7 +140,7 @@ All currently planned libraries and their respective API prefixes are listed in
   **Prefix:** `elektraUtil*`
 
 - `libelektra-base`:
-  Internal static library, linked into `libelektra-core` (not exported) and `libelektra-utility` (partially re-exported).
+  Internal object library, linked into `libelektra-core` (not exported) and `libelektra-utility` (partially re-exported).
   Contains helper functions for e.g., memory allocations, string formatting, etc.
 
   **Prefix:** `elektra*` (for internal), `elektraUtil*` (for exported)

doc/dev/data-structures.md

@@ -213,7 +213,7 @@ The OPMPHM is a non-dynamic randomized hash map of the Las Vegas type, that crea
 to gain O(1) access.
 
 The elements must be arranged in an array and each element must have a unique name, to identify the elements.
-The source can be found in [opmphm.h](/src/include/internal/core/opmphm.h) and [opmphm.c](/src/libs/elektra/opmphm.c)
+The source can be found in [opmphm.h](/src/include/internal/core/opmphm.h) and [opmphm.c](/src/libs/core/opmphm.c)
 and also works outside of Elektra.
 
 The OPMPHM does not store any buckets, your array of elements are the buckets and the OPMPHM represent an arbitrary

doc/dev/symbol-versioning.md

@@ -9,7 +9,7 @@ The setup used is based on the one used by FreeBSD. The main script [`version_ge
 (with small modifications to enable Alpine Linux compatibility).
 
 The main script, is called by CMake during the build process. It parses the `symbols.map` files of all libraries (e.g.
-[`/src/libs/elektra/symbols.map`](/src/libs/elektra/symbols.map)) and combines them into a single file, which is then used by the compiler
+[`/src/libs/core/symbols.map`](/src/libs/core/symbols.map)) and combines them into a single file, which is then used by the compiler
 and the linker.
 
 ### `versions.def`

doc/help/elektra-key-names.md

@@ -107,7 +107,7 @@ the key names of software-applications should always start with:
 
 - [see application integration tutorial](/doc/tutorials/application-integration.md)
 - [see namespaces tutorial](/doc/tutorials/namespaces.md)
-- [key name source file](/src/libs/elektra/keyname.c) or [its rendered API documentation](https://doc.libelektra.org/api/master/html/group__keyname.html#details)
+- [key name source file](/src/libs/core/keyname.c) or [its rendered API documentation](https://doc.libelektra.org/api/master/html/group__keyname.html#details)
 
 - [elektra-namespaces(7)](elektra-namespaces.md)
 - [elektra-cascading(7)](elektra-cascading.md)

doc/man/man7/elektra-key-names.7

@@ -1,6 +1,6 @@
 .\" generated with Ronn-NG/v0.10.1
 .\" http://github.com/apjanke/ronn-ng/tree/0.10.1.pre3
-.TH "ELEKTRA\-KEY\-NAMES" "7" "November 2021" ""
+.TH "ELEKTRA\-KEY\-NAMES" "7" "June 2023" ""
 .SH "NAME"
 \fBelektra\-key\-names\fR \- the names of keys
 .P
@@ -71,7 +71,7 @@ see application integration tutorial \fI/doc/tutorials/application\-integration\
 .IP "\(bu" 4
 see namespaces tutorial \fI/doc/tutorials/namespaces\.md\fR
 .IP "\(bu" 4
-key name source file \fI/src/libs/elektra/keyname\.c\fR or its rendered API documentation \fIhttps://doc\.libelektra\.org/api/master/html/group__keyname\.html#details\fR
+key name source file \fI/src/libs/core/keyname\.c\fR or its rendered API documentation \fIhttps://doc\.libelektra\.org/api/master/html/group__keyname\.html#details\fR
 .IP "\(bu" 4
 elektra\-namespaces(7) \fIelektra\-namespaces\.md\fR
 .IP "\(bu" 4