Merge pull request syslog-ng#4896 from bshifter/filterx-istype

inrduce Filterx istype builtin function

lib/filterx/CMakeLists.txt

@@ -33,7 +33,7 @@ set(FILTERX_HEADERS
     filterx/expr-condition.h
     filterx/expr-isset.h
     filterx/expr-unset.h
-    filterx/filterx-globals-tests.h
+    filterx/filterx-private.h
     PARENT_SCOPE
     )
 
@@ -73,6 +73,7 @@ set(FILTERX_SOURCES
     filterx/expr-condition.c
     filterx/expr-isset.c
     filterx/expr-unset.c
+    filterx/filterx-private.c
     PARENT_SCOPE
     )
 

lib/filterx/Makefile.am

@@ -35,7 +35,7 @@ filterxinclude_HEADERS = 			\
 	lib/filterx/expr-condition.h \
 	lib/filterx/expr-isset.h \
 	lib/filterx/expr-unset.h		\
-	lib/filterx/filterx-globals-tests.h
+	lib/filterx/filterx-private.h
 
 
 filterx_sources = 				\
@@ -74,6 +74,7 @@ filterx_sources = 				\
 	lib/filterx/expr-condition.c		\
 	lib/filterx/expr-isset.c		\
 	lib/filterx/expr-unset.c		\
+	lib/filterx/filterx-private.c	\
 	lib/filterx/filterx-grammar.y
 
 BUILT_SOURCES += 				\

lib/filterx/filterx-globals.c

@@ -21,6 +21,7 @@
  *
  */
 #include "filterx/filterx-globals.h"
+#include "filterx/filterx-private.h"
 #include "filterx/object-primitive.h"
 #include "filterx/object-null.h"
 #include "filterx/object-string.h"
@@ -31,41 +32,26 @@
 #include "filterx/object-dict-interface.h"
 
 static GHashTable *filterx_builtin_functions = NULL;
+static GHashTable *filterx_types = NULL;
 
-gboolean
-filterx_builtin_function_register_inner(GHashTable *ht, const gchar *fn_name, FilterXFunctionProto func)
-{
-  return g_hash_table_insert(ht, g_strdup(fn_name), func);
-}
+// Builtin functions
 
 gboolean
 filterx_builtin_function_register(const gchar *fn_name, FilterXFunctionProto func)
 {
-  return filterx_builtin_function_register_inner(filterx_builtin_functions, fn_name, func);
-}
-
-FilterXFunctionProto
-filterx_builtin_function_lookup_inner(GHashTable *ht, const gchar *fn_name)
-{
-  return (FilterXFunctionProto)g_hash_table_lookup(ht, fn_name);
+  return filterx_builtin_function_register_private(filterx_builtin_functions, fn_name, func);
 }
 
 FilterXFunctionProto
 filterx_builtin_function_lookup(const gchar *fn_name)
 {
-  return filterx_builtin_function_lookup_inner(filterx_builtin_functions, fn_name);
-}
-
-void
-filterx_builtin_functions_init_inner(GHashTable **ht)
-{
-  *ht = g_hash_table_new_full(g_str_hash, g_str_equal, g_free, (GDestroyNotify) NULL);
+  return filterx_builtin_function_lookup_private(filterx_builtin_functions, fn_name);
 }
 
 void
 filterx_builtin_functions_init(void)
 {
-  filterx_builtin_functions_init_inner(&filterx_builtin_functions);
+  filterx_builtin_functions_init_private(&filterx_builtin_functions);
   filterx_builtin_function_register("json", filterx_json_new_from_args);
   filterx_builtin_function_register("json_array", filterx_json_array_new_from_args);
   g_assert(filterx_builtin_function_register("datetime", filterx_typecast_datetime));
@@ -77,23 +63,49 @@ filterx_builtin_functions_init(void)
   g_assert(filterx_builtin_function_register("int", filterx_typecast_integer));
   g_assert(filterx_builtin_function_register("double", filterx_typecast_double));
   g_assert(filterx_builtin_function_register("strptime", filterx_datetime_strptime));
+  g_assert(filterx_builtin_function_register("istype", filterx_object_is_type_builtin));
 }
 
 void
-filterx_builtin_functions_deinit_inner(GHashTable *ht)
+filterx_builtin_functions_deinit(void)
 {
-  g_hash_table_destroy(ht);
+  filterx_builtin_functions_deinit_private(filterx_builtin_functions);
+}
+
+// FilterX types
+
+FilterXType *
+filterx_type_lookup(const gchar *type_name)
+{
+  return filterx_type_lookup_private(filterx_types, type_name);
+}
+
+gboolean
+filterx_type_register(const gchar *type_name, FilterXType *fxtype)
+{
+  return filterx_type_register_private(filterx_types, type_name, fxtype);
 }
 
 void
-filterx_builtin_functions_deinit(void)
+filterx_types_init(void)
 {
-  filterx_builtin_functions_deinit_inner(filterx_builtin_functions);
+  filterx_types_init_private(&filterx_types);
+  filterx_type_register("object", &FILTERX_TYPE_NAME(object));
 }
 
+void
+filterx_types_deinit(void)
+{
+  filterx_types_deinit_private(filterx_types);
+}
+
+// Globals
+
 void
 filterx_global_init(void)
 {
+  filterx_types_init();
+
   filterx_type_init(&FILTERX_TYPE_NAME(list));
   filterx_type_init(&FILTERX_TYPE_NAME(dict));
 
@@ -118,6 +130,7 @@ void
 filterx_global_deinit(void)
 {
   filterx_builtin_functions_deinit();
+  filterx_types_deinit();
 }
 
 FilterXObject *filterx_typecast_get_arg(GPtrArray *args, gchar *alt_msg)

lib/filterx/filterx-globals.h

@@ -28,7 +28,12 @@
 
 void filterx_global_init(void);
 void filterx_global_deinit(void);
+// Builtin functions
 FilterXFunctionProto filterx_builtin_function_lookup(const gchar *);
+// FilterX types
+FilterXType *filterx_type_lookup(const gchar *type_name);
+gboolean filterx_type_register(const gchar *type_name, FilterXType *fxtype);
+// Helpers
 FilterXObject *filterx_typecast_get_arg(GPtrArray *args, gchar *alt_msg);
 
 #endif

lib/filterx/filterx-object.c

@@ -23,6 +23,9 @@
 #include "filterx-object.h"
 #include "filterx-eval.h"
 #include "mainloop-worker.h"
+#include "filterx/object-primitive.h"
+#include "filterx/object-string.h"
+#include "filterx/filterx-globals.h"
 
 #define INIT_TYPE_METHOD(type, method_name) do { \
     if (type->method_name) \
@@ -57,6 +60,7 @@ filterx_type_init(FilterXType *type)
   INIT_TYPE_METHOD(type, dict_factory);
   INIT_TYPE_METHOD(type, repr);
   INIT_TYPE_METHOD(type, free_fn);
+  g_assert(filterx_type_register(type->name, type));
 }
 
 #define FILTERX_OBJECT_MAGIC_BIAS G_MAXINT32
@@ -156,6 +160,44 @@ filterx_object_unref(FilterXObject *self)
     }
 }
 
+FilterXObject *
+filterx_object_is_type_builtin(GPtrArray *args)
+{
+  if (args == NULL || args->len != 2)
+    {
+      msg_error("FilterX: is_type: invalid number of arguments. "
+                "Usage: is_type(object, type_str)");
+      return NULL;
+    }
+
+  FilterXObject *object = g_ptr_array_index(args, 0);
+  if (!object)
+    {
+      msg_error("FilterX: is_type: invalid argument: object"
+                "Usage: is_type(object, type_str)");
+      return NULL;
+    }
+
+  FilterXObject *type_arg = g_ptr_array_index(args, 1);
+  if (!type_arg || !filterx_object_is_type(type_arg, &FILTERX_TYPE_NAME(string)))
+    {
+      msg_error("FilterX: is_type: invalid argument: type_str"
+                "Usage: is_type(object, type_str)");
+      return NULL;
+    }
+
+  const gchar *type_name = filterx_string_get_value(type_arg, NULL);
+  FilterXType *fxtype = filterx_type_lookup(type_name);
+  if (!fxtype)
+    {
+      msg_error("FilterX: is_type: unknown type name",
+                evt_tag_str("type_name", type_name));
+      return NULL;
+    }
+
+  return filterx_boolean_new(filterx_object_is_type(object, fxtype));
+}
+
 FilterXType FILTERX_TYPE_NAME(object) =
 {
   .super_type = NULL,

lib/filterx/filterx-object.h

@@ -96,6 +96,7 @@ gboolean filterx_object_freeze(FilterXObject *self);
 void filterx_object_unfreeze_and_free(FilterXObject *self);
 void filterx_object_init_instance(FilterXObject *self, FilterXType *type);
 void filterx_object_free_method(FilterXObject *self);
+FilterXObject *filterx_object_is_type_builtin(GPtrArray *args);
 
 static inline gboolean
 filterx_object_is_type(FilterXObject *object, FilterXType *type)

lib/filterx/filterx-private.c

@@ -0,0 +1,83 @@
+/*
+ * Copyright (c) 2024 shifter <[email protected]>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * As an additional exemption you are allowed to compile & link against the
+ * OpenSSL libraries as published by the OpenSSL project. See the file
+ * COPYING for details.
+ *
+ */
+#include "filterx/filterx-private.h"
+#include "filterx/object-primitive.h"
+#include "filterx/object-null.h"
+#include "filterx/object-string.h"
+#include "filterx/object-json.h"
+#include "filterx/object-datetime.h"
+#include "filterx/object-message-value.h"
+#include "filterx/object-list-interface.h"
+#include "filterx/object-dict-interface.h"
+
+// Builtin functions
+
+gboolean
+filterx_builtin_function_register_private(GHashTable *ht, const gchar *fn_name, FilterXFunctionProto func)
+{
+  return g_hash_table_insert(ht, g_strdup(fn_name), func);
+}
+
+FilterXFunctionProto
+filterx_builtin_function_lookup_private(GHashTable *ht, const gchar *fn_name)
+{
+  return (FilterXFunctionProto)g_hash_table_lookup(ht, fn_name);
+}
+
+void
+filterx_builtin_functions_init_private(GHashTable **ht)
+{
+  *ht = g_hash_table_new_full(g_str_hash, g_str_equal, g_free, (GDestroyNotify) NULL);
+}
+
+void
+filterx_builtin_functions_deinit_private(GHashTable *ht)
+{
+  g_hash_table_destroy(ht);
+}
+
+// FilterX Types
+
+gboolean
+filterx_type_register_private(GHashTable *ht, const gchar *type_name, FilterXType *fxtype)
+{
+  return g_hash_table_insert(ht, g_strdup(type_name), fxtype);
+}
+
+FilterXType *
+filterx_type_lookup_private(GHashTable *ht, const gchar *type_name)
+{
+  return (FilterXType *)g_hash_table_lookup(ht, type_name);
+}
+
+void
+filterx_types_init_private(GHashTable **ht)
+{
+  *ht = g_hash_table_new_full(g_str_hash, g_str_equal, g_free, (GDestroyNotify) NULL);
+}
+
+void
+filterx_types_deinit_private(GHashTable *ht)
+{
+  g_hash_table_destroy(ht);
+}

lib/filterx/filterx-globals-tests.h → lib/filterx/filterx-private.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023 Balazs Scheidler <balazs.scheidler@axoflow.com>
+ * Copyright (c) 2024 shifter <shifter@axoflow.com>
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
@@ -20,15 +20,23 @@
  * COPYING for details.
  *
  */
-#ifndef FILTERX_GLOBALS_TESTS_H_INCLUDED
-#define FILTERX_GLOBALS_TESTS_H_INCLUDED
+#ifndef FILTERX_PRIVATE_H_INCLUDED
+#define FILTERX_PRIVATE_H_INCLUDED
 
 #include "filterx-object.h"
 #include "filterx/expr-function.h"
 
-gboolean filterx_builtin_function_register_inner(GHashTable *ht, const gchar *fn_name, FilterXFunctionProto func);
-FilterXFunctionProto filterx_builtin_function_lookup_inner(GHashTable *ht, const gchar *fn_name);
-void filterx_builtin_functions_init_inner(GHashTable **ht);
-void filterx_builtin_functions_deinit_inner(GHashTable *ht);
+// Builtin functions
+gboolean filterx_builtin_function_register_private(GHashTable *ht, const gchar *fn_name, FilterXFunctionProto func);
+FilterXFunctionProto filterx_builtin_function_lookup_private(GHashTable *ht, const gchar *fn_name);
+void filterx_builtin_functions_init_private(GHashTable **ht);
+void filterx_builtin_functions_deinit_private(GHashTable *ht);
+// Types
+gboolean filterx_type_register_private(GHashTable *ht, const gchar *type_name, FilterXType *fxtype);
+FilterXType *filterx_type_lookup_private(GHashTable *ht, const gchar *type_name);
+void filterx_types_init_private(GHashTable **ht);
+void filterx_types_deinit_private(GHashTable *ht);
+
+
 
 #endif

lib/filterx/tests/CMakeLists.txt

@@ -13,3 +13,5 @@ add_unit_test(LIBTEST CRITERION TARGET test_object_protobuf DEPENDS json-plugin
 add_unit_test(LIBTEST CRITERION TARGET test_object_boolean DEPENDS json-plugin ${JSONC_LIBRARY})
 add_unit_test(LIBTEST CRITERION TARGET test_object_integer DEPENDS json-plugin ${JSONC_LIBRARY})
 add_unit_test(LIBTEST CRITERION TARGET test_object_double DEPENDS json-plugin ${JSONC_LIBRARY})
+add_unit_test(LIBTEST CRITERION TARGET test_type_registry DEPENDS json-plugin ${JSONC_LIBRARY})
+add_unit_test(LIBTEST CRITERION TARGET test_filterx_object DEPENDS json-plugin ${JSONC_LIBRARY})

lib/filterx/tests/Makefile.am

@@ -13,7 +13,9 @@ lib_filterx_tests_TESTS		 =              \
 		lib/filterx/tests/test_filterx_expr	\
 		lib/filterx/tests/test_expr_comparison \
 		lib/filterx/tests/test_expr_condition \
-		lib/filterx/tests/test_builtin_functions
+		lib/filterx/tests/test_builtin_functions \
+		lib/filterx/tests/test_type_registry \
+		lib/filterx/tests/test_filterx_object
 
 EXTRA_DIST += lib/filterx/tests/CMakeLists.txt \
 	lib/filterx/tests/filterx-lib.h
@@ -64,3 +66,9 @@ lib_filterx_tests_test_object_integer_LDADD   = $(TEST_LDADD) $(JSON_LIBS)
 
 lib_filterx_tests_test_object_double_CFLAGS  = $(TEST_CFLAGS)
 lib_filterx_tests_test_object_double_LDADD   = $(TEST_LDADD) $(JSON_LIBS)
+
+lib_filterx_tests_test_type_registry_CFLAGS  = $(TEST_CFLAGS)
+lib_filterx_tests_test_type_registry_LDADD   = $(TEST_LDADD) $(JSON_LIBS)
+
+lib_filterx_tests_test_filterx_object_CFLAGS  = $(TEST_CFLAGS)
+lib_filterx_tests_test_filterx_object_LDADD   = $(TEST_LDADD) $(JSON_LIBS)