Do not #include platform.h in headers

platform.h includes config.h which is a default name for any project's configuration definitions. We could use a more specific name, but every config.h defines things like PACKAGE_NAME and thus including two such files results in compilation warnings or errors. The general rule is that only .c files should include config.h. When built and installed, the library should provide library files (static or dynamic) and headers defining the API, but not config.h.
NorthernTechHQ · Sep 15, 2023 · a97533a · a97533a
1 parent e7660b7
commit a97533a
Show file tree

Hide file tree

Showing 41 changed files with 220 additions and 45 deletions.
diff --git a/.gitignore b/.gitignore
@@ -88,6 +88,10 @@ stamp-h1
 /libutils/config.h
 /libutils/config.h.in
 /libutils/config.post.h
+/libutils/writer.h
+/libutils/clockid_t.h
+/libutils/regex.h
+/libutils/json-yaml.h
 
 # examples
 /examples/cfengine_stdlib.cf

diff --git a/configure.ac b/configure.ac
@@ -311,9 +311,12 @@ if test "x$with_pcre" != "xno"; then
   ])
   AC_DEFINE(WITH_PCRE, 1, [Define if PCRE is being used])
   AM_CONDITIONAL(WITH_PCRE, true)
+  WITH_PCRE_DEFINE="#define WITH_PCRE 1"
 else
   AM_CONDITIONAL(WITH_PCRE, false)
+  WITH_PCRE_DEFINE="// #undef WITH_PCRE"
 fi
+AC_SUBST(WITH_PCRE_DEFINE)
 
 dnl systemd structured logging
 
@@ -336,13 +339,17 @@ if test "x$with_libyaml" != xno
 then
   CF3_WITH_LIBRARY(libyaml, [
     AC_CHECK_LIB(yaml, yaml_parser_initialize,
-      [],
-      [if test "x$with_libyaml" != xcheck; then AC_MSG_ERROR(Cannot find libyaml library); fi])
+      [HAVE_LIBYAML_DEFINE="#define HAVE_LIBYAML 1"],
+      [if test "x$with_libyaml" != xcheck; then AC_MSG_ERROR(Cannot find libyaml library); fi
+       HAVE_LIBYAML_DEFINE="// #undef HAVE_LIBYAML"])
     AC_CHECK_HEADERS(yaml.h,
       [libyaml_header_found=yes],
       [if test "x$with_libyaml" != xcheck; then AC_MSG_ERROR(Cannot find libyaml header files); fi])
   ])
+else
+  HAVE_LIBYAML_DEFINE="// #undef HAVE_LIBYAML"
 fi
+AC_SUBST(HAVE_LIBYAML_DEFINE)
 
 dnl ######################################################################
 dnl Checks for header files.
@@ -366,7 +373,12 @@ AC_CHECK_HEADERS(net/if_arp.h, , , [AC_INCLUDES_DEFAULT
 #include <sys/socket.h>
 ])
 
-AC_CHECK_HEADERS(getopt.h)
+AC_CHECK_HEADERS(getopt.h,
+    [HAVE_GETOPT_H_DEFINE="#define HAVE_GETOPT_H 1"],
+    [HAVE_GETOPT_H_DEFINE="// #undef HAVE_GETOPT_H"]
+)
+AC_SUBST(HAVE_GETOPT_H_DEFINE)
+
 AC_CHECK_HEADERS(utime.h)
 AC_CHECK_HEADERS(time.h)
 AC_CHECK_HEADERS(sys/time.h)
@@ -411,11 +423,15 @@ AC_TYPE_MODE_T
 AC_TYPE_SIZE_T
 AC_TYPE_UID_T
 AC_TYPE_PID_T
-AC_CHECK_TYPES(clockid_t, [], [], [[
+AC_CHECK_TYPES(clockid_t,
+    [HAVE_CLOCKID_T_DEFINE="#define HAVE_CLOCKID_T 1"],
+    [HAVE_CLOCKID_T_DEFINE="// #undef HAVE_CLOCKID_T"]
+, [[
 #ifdef HAVE_TIME_H
 # include <time.h>
 #endif
 ]])
+AC_SUBST(HAVE_CLOCKID_T_DEFINE)
 
 AC_CHECK_TYPES(socklen_t, [], [], [[
 #ifdef HAVE_SYS_TYPES_H
@@ -1244,6 +1260,10 @@ dnl ######################################################################
 AC_CONFIG_FILES([Makefile
     libcompat/Makefile
     libutils/Makefile
+    libutils/writer.h
+    libutils/clockid_t.h
+    libutils/regex.h
+    libutils/json-yaml.h
     config.post.h
     tests/Makefile
     tests/unit/Makefile])

diff --git a/libutils/Makefile.am b/libutils/Makefile.am
@@ -34,6 +34,7 @@ libutils_la_SOURCES = \
 	array_map.c array_map_priv.h \
 	buffer.c buffer.h \
 	cleanup.c cleanup.h \
+	clockid_t.h \
 	compiler.h \
 	csv_writer.c csv_writer.h \
 	csv_parser.c csv_parser.h \
@@ -58,6 +59,7 @@ libutils_la_SOURCES = \
 	mutex.c mutex.h \
 	passopenfile.c passopenfile.h \
 	path.c path.h \
+	path_max.h \
 	platform.h condition_macros.h \
 	printsize.h \
 	proc_keyvalue.c proc_keyvalue.h \

diff --git a/libutils/clockid_t.h.in b/libutils/clockid_t.h.in
@@ -0,0 +1,36 @@
+/*
+  Copyright 2023 Northern.tech AS
+
+  This file is part of CFEngine 3 - written and maintained by Northern.tech AS.
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+
+  To the extent this program is licensed as part of the Enterprise
+  versions of CFEngine, the applicable Commercial Open Source License
+  (COSL) may apply to this file if you as a licensee so wish it. See
+  included file COSL.txt.
+*/
+
+#ifndef CLOCKID_T_H
+#define CLOCKID_T_H
+
+/* Set by ./configure allowing us to avoid #include <config.h> here. */
+@HAVE_CLOCKID_T_DEFINE@
+
+#ifndef HAVE_CLOCKID_T
+typedef int clockid_t;
+#else
+#include <time.h>
+#endif
+
+#endif	/* CLOCKID_T_H */
diff --git a/libutils/csv_writer.c b/libutils/csv_writer.c
@@ -21,6 +21,7 @@
   included file COSL.txt.
 */
 
+#include <platform.h>
 #include <csv_writer.h>
 
 #include <alloc.h>

diff --git a/libutils/csv_writer.h b/libutils/csv_writer.h
@@ -28,7 +28,6 @@
  * This writer implements CSV as in RFC 4180
  */
 
-#include <platform.h>
 #include <writer.h>
 
 typedef struct CsvWriter_ CsvWriter;

diff --git a/libutils/encode.h b/libutils/encode.h
@@ -25,10 +25,6 @@
 #ifndef CFENGINE_ENCODE_H
 #define CFENGINE_ENCODE_H
 
-
-#include <platform.h>
-
-
 char *StringEncodeBase64(const char *str, size_t len);
 
 

diff --git a/libutils/json-yaml.c b/libutils/json-yaml.c
@@ -21,6 +21,7 @@
   included file COSL.txt.
 */
 
+#include <platform.h>
 #include <alloc.h>
 #include <logging.h>
 #include <misc_lib.h>

diff --git a/libutils/json-yaml.h b/libutils/json-yaml.h
@@ -26,6 +26,9 @@
 
 #include <json.h>
 
+/* Set by ./configure allowing us to avoid #include <config.h> here. */
+#define HAVE_LIBYAML 1
+
 #ifdef HAVE_LIBYAML
 #include <yaml.h>
 #endif

diff --git a/libutils/json-yaml.h.in b/libutils/json-yaml.h.in
@@ -0,0 +1,53 @@
+/*
+  Copyright 2023 Northern.tech AS
+
+  This file is part of CFEngine 3 - written and maintained by Northern.tech AS.
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+
+  To the extent this program is licensed as part of the Enterprise
+  versions of CFEngine, the applicable Commercial Open Source License
+  (COSL) may apply to this file if you as a licensee so wish it. See
+  included file COSL.txt.
+*/
+
+#ifndef CFENGINE_JSON_YAML_H
+#define CFENGINE_JSON_YAML_H
+
+#include <json.h>
+
+/* Set by ./configure allowing us to avoid #include <config.h> here. */
+@HAVE_LIBYAML_DEFINE@
+
+#ifdef HAVE_LIBYAML
+#include <yaml.h>
+#endif
+
+/**
+  @brief Parse a YAML string to create a JsonElement
+  @param data [in Pointer to the string to parse
+  @param json_out Resulting JSON object
+  @returns See JsonParseError and JsonParseErrorToString
+  */
+JsonParseError JsonParseYamlString(const char **data, JsonElement **json_out);
+
+/**
+ * @brief Convenience function to parse JSON from a YAML file
+ * @param path Path to the file
+ * @param size_max Maximum size to read in memory
+ * @param json_out Resulting JSON object
+ * @return See JsonParseError and JsonParseErrorToString
+ */
+JsonParseError JsonParseYamlFile(const char *path, size_t size_max, JsonElement **json_out);
+
+#endif // CFENGINE_JSON_YAML_H
diff --git a/libutils/json.c b/libutils/json.c
@@ -21,6 +21,7 @@
   included file COSL.txt.
 */
 
+#include <platform.h>
 #include <logging.h>
 #include <json.h>
 #include <json-priv.h>

diff --git a/libutils/known_dirs.c b/libutils/known_dirs.c
@@ -21,6 +21,7 @@
   included file COSL.txt.
 */
 
+#include <platform.h>
 #include <known_dirs.h>
 #include <definitions.h>
 #include <file_lib.h>

diff --git a/libutils/known_dirs.h b/libutils/known_dirs.h
@@ -24,7 +24,7 @@
 #ifndef CFENGINE_KNOWN_DIRS_H
 #define CFENGINE_KNOWN_DIRS_H
 
-#include <platform.h>
+#include <path_max.h>
 
 const char *GetDefaultDir_helper(char dir[PATH_MAX], const char *root_dir,
                                  const char *append_dir);

diff --git a/libutils/libcrypto-compat.h b/libutils/libcrypto-compat.h
@@ -1,7 +1,6 @@
 #ifndef LIBCRYPTO_COMPAT_H
 #define LIBCRYPTO_COMPAT_H
 
-#include <platform.h>
 #include <openssl/opensslv.h>
 
 

diff --git a/libutils/logging.c b/libutils/logging.c
@@ -21,6 +21,7 @@
   included file COSL.txt.
 */
 
+#include <platform.h>
 #include <logging.h>
 #include <alloc.h>
 #include <string_lib.h>

diff --git a/libutils/logging.h b/libutils/logging.h
@@ -25,10 +25,11 @@
 #ifndef CFENGINE_LOGGING_H
 #define CFENGINE_LOGGING_H
 
-
-#include <platform.h>
 #include <compiler.h>
+#include <stdbool.h>
 #include <stdarg.h>                     /* va_list */
+#include <stddef.h>						/* size_t */
+#include <time.h>						/* struct tm */
 
 
 // Does not include timezone, since it is hard to match on Windows.

diff --git a/libutils/man.c b/libutils/man.c
@@ -21,6 +21,7 @@
   included file COSL.txt.
 */
 
+#include <platform.h>
 #include <man.h>
 
 #include <string_lib.h>

diff --git a/libutils/man.h b/libutils/man.h
@@ -24,7 +24,7 @@
 #ifndef CFENGINE_MAN_H
 #define CFENGINE_MAN_H
 
-#include <platform.h>
+#include <time.h>						/* time_t */
 #include <writer.h>
 
 void ManPageWrite(Writer *out, const char *program, time_t last_modified,

diff --git a/libutils/misc_lib.h b/libutils/misc_lib.h
@@ -24,10 +24,9 @@
 #ifndef CFENGINE_MISC_LIB_H
 #define CFENGINE_MISC_LIB_H
 
-#include <platform.h>
-
 #include <compiler.h>
-
+#include <stddef.h>						/* size_t */
+#include <clockid_t.h>
 
 #define ProgrammingError(...) __ProgrammingError(__FILE__, __LINE__, __VA_ARGS__)
 

diff --git a/libutils/mutex.c b/libutils/mutex.c
@@ -21,6 +21,7 @@
   included file COSL.txt.
 */
 
+#include <platform.h>
 #include <mutex.h>
 
 #include <logging.h>                                            /* Log */

diff --git a/libutils/mutex.h b/libutils/mutex.h
@@ -24,7 +24,7 @@
 #ifndef CFENGINE_MUTEX_H
 #define CFENGINE_MUTEX_H
 
-#include <platform.h>
+#include <pthread.h>
 
 #define THREAD_BLOCK_INDEFINITELY  -1
 

diff --git a/libutils/passopenfile.c b/libutils/passopenfile.c
@@ -20,7 +20,8 @@
   (COSL) may apply to this file if you as a licensee so wish it. See
   included file COSL.txt.
 */
-#include <passopenfile.h> /* Starts with <platform.h> */
+#include <platform.h>
+#include <passopenfile.h>
 
 #include <logging.h>
 #include <alloc.h>

diff --git a/libutils/passopenfile.h b/libutils/passopenfile.h
@@ -69,7 +69,6 @@
  * transmission of a text message accompanying the descriptor).
  */
 
-#include <platform.h>
 /* Send a file descriptor to another process.
  *
  * @param uds The local communications socket.

diff --git a/libutils/path.c b/libutils/path.c
@@ -1,3 +1,27 @@
+/*
+  Copyright 2023 Northern.tech AS
+
+  This file is part of CFEngine 3 - written and maintained by Northern.tech AS.
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+
+  To the extent this program is licensed as part of the Enterprise
+  versions of CFEngine, the applicable Commercial Open Source License
+  (COSL) may apply to this file if you as a licensee so wish it. See
+  included file COSL.txt.
+*/
+
+#include <platform.h>
 #include <path.h>
 #include <string_lib.h>
 #include <file_lib.h>

diff --git a/libutils/path.h b/libutils/path.h
@@ -24,8 +24,6 @@
 #ifndef CFENGINE_PATH_H
 #define CFENGINE_PATH_H
 
-#include <platform.h>
-
 // TODO: Move more functions from files_names.c here
 
 /**