From 5f2e901a458d4d69beeb46735879389b37d238b5 Mon Sep 17 00:00:00 2001 From: Israel Date: Mon, 13 Oct 2025 09:53:43 -0600 Subject: [PATCH 001/275] Checkpoint: Switching to DM UI project. --- .gitignore | 1 + centrallix-lib/Makefile.in | 4 +- centrallix-lib/include/clusters.h | 93 + centrallix-lib/include/util.h | 109 +- centrallix-lib/include/xhash.h | 4 +- centrallix-lib/src/clusters.c | 989 +++++ centrallix-lib/src/util.c | 170 +- centrallix-lib/src/xhash.c | 70 + centrallix-os/cluster-schema.cluster | 176 + centrallix-os/file.cluster | 64 + centrallix-os/file2.cluster | 42 + centrallix-sysdoc/OSDriver_Authoring.md | 99 +- centrallix-sysdoc/string_comparison.md | 12 +- centrallix/Makefile.in | 3 + centrallix/centrallix.c | 2 +- centrallix/etc/types.cfg | 1 + centrallix/expression/exp_compiler.c | 17 +- centrallix/expression/exp_double_metaphone.c | 1517 ++++++++ centrallix/expression/exp_functions.c | 1819 ++++++++- centrallix/include/cxss/policy.h | 2 +- centrallix/include/expression.h | 1 + centrallix/include/stparse.h | 2 +- centrallix/osdrivers/objdrv_cluster.c | 3345 +++++++++++++++++ .../tests/test_expfn_double_metaphone_00.cmp | 140 + .../tests/test_expfn_double_metaphone_00.to | 161 + 25 files changed, 8751 insertions(+), 92 deletions(-) create mode 100644 centrallix-lib/include/clusters.h create mode 100644 centrallix-lib/src/clusters.c create mode 100644 centrallix-os/cluster-schema.cluster create mode 100644 centrallix-os/file.cluster create mode 100644 centrallix-os/file2.cluster create mode 100644 centrallix/expression/exp_double_metaphone.c create mode 100644 centrallix/osdrivers/objdrv_cluster.c create mode 100644 centrallix/tests/test_expfn_double_metaphone_00.cmp create mode 100644 centrallix/tests/test_expfn_double_metaphone_00.to diff --git a/.gitignore b/.gitignore index cbfe20f1d..bddd6b099 100644 --- a/.gitignore +++ b/.gitignore @@ -62,3 +62,4 @@ perf.data.old .idea/ .vscode/ centrallix-os/tmp/* +centrallix-os/datasets/ diff --git a/centrallix-lib/Makefile.in b/centrallix-lib/Makefile.in index a7197622b..20c57c11f 100644 --- a/centrallix-lib/Makefile.in +++ b/centrallix-lib/Makefile.in @@ -63,10 +63,10 @@ CFLAGS=@CFLAGS@ @DEFS@ -Iinclude -DCXLIB_INTERNAL -DNM_USE_SYSMALLOC -Wall $(PRO MTCFLAGS=@CFLAGS@ @DEFS@ -Iinclude -DCXLIB_INTERNAL -DNM_USE_SYSMALLOC -Wall $(PROFILE) $(COVERAGE) -g -O0 TCFLAGS=$(patsubst -DNDEBUG,,$(CFLAGS)) -XSTATICFILES=mtask.o mtlexer.o memstr.o xarray.o xhash.o xstring.o mtsession.o newmalloc.o xhashqueue.o bdqs_transport.o xhandle.o xringqueue.o cxsec.o smmalloc.o qprintf.o strtcpy.o util.o +XSTATICFILES=mtask.o mtlexer.o memstr.o xarray.o xhash.o xstring.o mtsession.o newmalloc.o xhashqueue.o bdqs_transport.o xhandle.o xringqueue.o cxsec.o smmalloc.o clusters.o qprintf.o strtcpy.o util.o STATICFILES=$(patsubst %,src/%,$(XSTATICFILES)) -XDYNAMICFILES=mtask.lo mtlexer.lo memstr.lo xarray.lo xhash.lo xstring.lo mtsession.lo newmalloc.lo xhashqueue.lo bdqs_transport.lo xhandle.lo xringqueue.lo cxsec.lo smmalloc.lo qprintf.lo strtcpy.lo util.lo +XDYNAMICFILES=mtask.lo mtlexer.lo memstr.lo xarray.lo xhash.lo xstring.lo mtsession.lo newmalloc.lo xhashqueue.lo bdqs_transport.lo xhandle.lo xringqueue.lo cxsec.lo smmalloc.lo clusters.o qprintf.lo strtcpy.lo util.lo DYNAMICFILES=$(patsubst %,src/%,$(XDYNAMICFILES)) INCLUDEFILES:=$(wildcard include/*.h) diff --git a/centrallix-lib/include/clusters.h b/centrallix-lib/include/clusters.h new file mode 100644 index 000000000..2605b4314 --- /dev/null +++ b/centrallix-lib/include/clusters.h @@ -0,0 +1,93 @@ + +/************************************************************************/ +/* Centrallix Application Server System */ +/* Centrallix Core */ +/* */ +/* Copyright (C) 1998-2012 LightSys Technology Services, Inc. */ +/* */ +/* This program is free software; you can redistribute it and/or modify */ +/* it under the terms of the GNU General Public License as published by */ +/* the Free Software Foundation; either version 2 of the License, or */ +/* (at your option) any later version. */ +/* */ +/* This program 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 General Public License for more details. */ +/* */ +/* You should have received a copy of the GNU General Public License */ +/* along with this program; if not, write to the Free Software */ +/* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA */ +/* 02111-1307 USA */ +/* */ +/* A copy of the GNU General Public License has been included in this */ +/* distribution in the file "COPYING". */ +/* */ +/* Module: lib_cluster.c */ +/* Author: Israel Fuller */ +/* Creation: September 29, 2025 */ +/* Description: Internal algorithms for the cluster object driver. */ +/* See centrallix-sysdoc/EAV_Pivot.md for more information. */ +/************************************************************************/ + +#include + +#ifdef CXLIB_INTERNAL +#include "xarray.h" +#else +#include "cxlib/xarray.h" +#endif + +#define CA_NUM_DIMS 251 /* aka. The vector table size. */ + +/** The character used to create a pair with the first and last characters of a string. **/ +#define CA_BOUNDARY_CHAR ('a' - 1) + +/** Types. **/ +typedef int* pVector; /* Sparse vector. */ +typedef double* pCentroid; /* Dense centroid. */ +#define pCentroidSize CA_NUM_DIMS * sizeof(double) + +/** Duplocate information. **/ +typedef struct + { + unsigned int id1; + unsigned int id2; + double similarity; + } + Dup, *pDup; + +pVector ca_build_vector(const char* str); +unsigned int ca_sparse_len(const pVector vector); +void ca_free_vector(pVector sparse_vector); +void ca_kmeans( + pVector* vectors, + const unsigned int num_vectors, + unsigned int* labels, + const unsigned int num_clusters, + const unsigned int max_iter, + const double improvement_threshold +); +pXArray ca_search( + pVector* vectors, + const unsigned int num_vectors, + const unsigned int* labels, + const double dupe_threshold +); +pXArray ca_lightning_search( + pVector* vectors, + const unsigned int num_vectors, + const double dupe_threshold +); +unsigned int ca_edit_dist( + const char* str1, + const char* str2, + const size_t str1_length, + const size_t str2_length +); +pXArray ca_phone_search( + char dataset[][10u], + const unsigned int dataset_size, + const double dupe_threshold +); +void ca_init(); diff --git a/centrallix-lib/include/util.h b/centrallix-lib/include/util.h index df4ba0d58..2b9d7b26f 100644 --- a/centrallix-lib/include/util.h +++ b/centrallix-lib/include/util.h @@ -21,14 +21,119 @@ extern "C" { #endif - int strtoi(const char *nptr, char **endptr, int base); unsigned int strtoui(const char *nptr, char **endptr, int base); + char* snprint_bytes(char* buf, const size_t buf_size, unsigned int bytes); + void fprint_mem(FILE* out); + + typedef struct + { + double start, end; + } + Timer, *pTimer; + + pTimer timer_init(pTimer timer); + pTimer timer_new(void); + pTimer timer_start(pTimer timer); + pTimer timer_stop(pTimer timer); + double timer_get(pTimer timer); + void timer_de_init(pTimer timer); + void timer_free(pTimer timer); #ifdef __cplusplus } #endif -#endif /* UTILITY_H */ +#ifndef __cplusplus + +/** TODO: Greg, is the __typeof__ syntax from GCC a portability concern? **/ + +/*** @brief Returns the smaller of two values. + *** + *** @param a The first value. + *** @param b The second value. + *** @return The smaller of the two values. + *** + *** @note This macro uses GCC extensions to enusre type safety. + ***/ +#define min(a, b) \ + ({ \ + __typeof__ (a) _a = (a); \ + __typeof__ (b) _b = (b); \ + (_a < _b) ? _a : _b; \ + }) + +/*** @brief Returns the larger of two values. + *** + *** @param a The first value. + *** @param b The second value. + *** @return The larger of the two values. + *** + *** @note This macro uses GCC extensions to enusre type safety. + ***/ +#define max(a, b) \ + ({ \ + __typeof__ (a) _a = (a); \ + __typeof__ (b) _b = (b); \ + (_a > _b) ? _a : _b; \ + }) + +/** Error Handling. **/ +void fail(const char* function_name, int code); +/*** Helper function for compact error handling on library & system function calls. + *** Any non-zero value is treated as an error, exiting the program. + *** + *** @param result The result of the function we're checking. + *** @returns result + ***/ +#define check(result) \ + ({ \ + __typeof__ (result) _r = (result); \ + if (_r != 0) fail(#result, _r); \ + _r; \ + }) + +/*** Helper function for compact error handling on library & system function calls. + *** Any negative is treated as an error, exiting the program. + *** + *** @param result The result of the function we're checking. + *** @returns result + ***/ +#define check_neg(result) \ + ({ \ + __typeof__ (result) _r = (result); \ + if (_r < 0) fail(#result, _r); \ + _r; \ + }) + +/*** Helper function for compact error handling on library & system function calls. + *** Any value of -1 is treated as an error, exiting the program. + *** + *** @param result The result of the function we're checking. + *** @returns result + ***/ +#define check_strict(result) \ + ({ \ + __typeof__ (result) _r = (result); \ + if (_r == -1) fail(#result, _r); \ + _r; \ + }) + +/*** Helper function for compact error handling on library & system function calls. + *** Any null value is treated as an error, exiting the program. + *** + *** @param result The result of the function we're checking + *** @returns result + ***/ +#define check_ptr(result) \ + ({ \ + __typeof__ (result) _r = (result); \ + if (_r == NULL) fail(#result, 0); \ + _r; \ + }) + +#endif /* __cplusplus */ + +#endif /* UTILITY_H */ diff --git a/centrallix-lib/include/xhash.h b/centrallix-lib/include/xhash.h index 1b5d8459a..65b900570 100644 --- a/centrallix-lib/include/xhash.h +++ b/centrallix-lib/include/xhash.h @@ -1,7 +1,6 @@ #ifndef _XHASH_H #define _XHASH_H - /************************************************************************/ /* Centrallix Application Server System */ /* Centrallix Base Library */ @@ -55,6 +54,7 @@ int xhAdd(pXHashTable this, char* key, char* data); int xhRemove(pXHashTable this, char* key); char* xhLookup(pXHashTable this, char* key); int xhClear(pXHashTable this, int (*free_fn)(), void* free_arg); +int xhForEach(pXHashTable this, int (*callback_fn)(pXHashEntry, void*), void* each_arg); +int xhClearKeySafe(pXHashTable this, void (*free_fn)(pXHashEntry, void*), void* free_arg); #endif /* _XHASH_H */ - diff --git a/centrallix-lib/src/clusters.c b/centrallix-lib/src/clusters.c new file mode 100644 index 000000000..4e41d449d --- /dev/null +++ b/centrallix-lib/src/clusters.c @@ -0,0 +1,989 @@ + +/************************************************************************/ +/* Centrallix Application Server System */ +/* Centrallix Core */ +/* */ +/* Copyright (C) 1998-2012 LightSys Technology Services, Inc. */ +/* */ +/* This program is free software; you can redistribute it and/or modify */ +/* it under the terms of the GNU General Public License as published by */ +/* the Free Software Foundation; either version 2 of the License, or */ +/* (at your option) any later version. */ +/* */ +/* This program 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 General Public License for more details. */ +/* */ +/* You should have received a copy of the GNU General Public License */ +/* along with this program; if not, write to the Free Software */ +/* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA */ +/* 02111-1307 USA */ +/* */ +/* A copy of the GNU General Public License has been included in this */ +/* distribution in the file "COPYING". */ +/* */ +/* Module: lib_cluster.c */ +/* Author: Israel Fuller */ +/* Creation: September 29, 2025 */ +/* Description: Internal algorithms for the cluster object driver. */ +/* See centrallix-sysdoc/EAV_Pivot.md for more information. */ +/************************************************************************/ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "clusters.h" +#include "newmalloc.h" +#include "util.h" +#include "xarray.h" + +/*** Gets the hash, representing a pair of ASCII characters, represented by unsigned ints. + *** Thank you to professor John Delano for this hashing algorithm. + *** + *** @param num1 The first character in the pair. + *** @param num1 The second character in the pair. + *** @returns The resulting hash. + ***/ +static unsigned int hash_char_pair(const unsigned int num1, const unsigned int num2) + { + if (num1 == CA_BOUNDARY_CHAR && num2 == CA_BOUNDARY_CHAR) + { + // fprintf(stderr, + // "hash_char_pair(%u, %u) - Warning: Pair of boundary characters.\n", + // num1, num2 + // ); + } + const double sum = (num1 * num1 * num1) + (num2 * num2 * num2); + const double scale = ((double)num1 + 1.0) / ((double)num2 + 1.0); + const unsigned int hash = (unsigned int)round(sum * scale) - 1u; + return hash % CA_NUM_DIMS; + } + +/*** Builds a vector using a string. + *** + *** Vectors are based on the frequencies of character pairs in the string. + *** Space characters and punctuation characters (see code for list) are ignored, + *** and all characters are converted to lowercase. Character 96, which is just + *** before 'a' in the ASCII table (and maps to '`') is used to make pairs on the + *** start and end of strings. The only supported characters for the passed char* + *** are spaces, punctuation, uppercase and lowercase letters, and numbers. + *** + *** This results in the following modified ASCII table: + *** ```csv + *** #, char, #, char, #, char + *** 97, a, 109, m, 121, y + *** 98, b, 110, n, 122, z + *** 99, c, 111, o, 123, 0 + *** 100, d, 112, p, 124, 1 + *** 101, e, 113, q, 125, 2 + *** 102, f, 114, r, 126, 3 + *** 103, g, 115, s, 127, 4 + *** 104, h, 116, t, 128, 5 + *** 105, i, 117, u, 129, 6 + *** 106, j, 118, v, 130, 7 + *** 107, k, 119, w, 131, 8 + *** 108, l, 120, x, 132, 9 + *** ``` + *** Thus, any number from 96 (the start/end character) to 132 ('9') is a valid + *** input to get_char_pair_hash(). + *** + *** After hashing each character pair, we add some number from 1 to 13 to the + *** coresponding dimention. However, for most names, this results in a lot of + *** zeros and a FEW positive numbers. Thus, after creating the dense vector, + *** we convert it to a sparse vector in which a negative number replaces a run + *** of that many zeros. Consider the following example: + *** + *** Dense pVector: `[1,0,0,0,3,0]` + *** + *** Sparse pVector: `[1,-3,3,-1]` + *** + *** Using these sparse vectors greatly reduces the required memory and gives + *** aproximately an x5 boost to performance when traversing vectors, at the + *** cost of more algorithmically complex code. + *** + *** @param str The string to be divided into pairs and hashed to make the vector. + *** @returns The sparse vector built using the hashed character pairs. + ***/ +pVector ca_build_vector(const char* str) + { + /** Allocate space for a dense vector. **/ + unsigned int dense_vector[CA_NUM_DIMS] = {0u}; + + /** j is the former character, i is the latter. **/ + const unsigned int num_chars = (unsigned int)strlen(str); + for (unsigned int j = 65535u, i = 0u; i <= num_chars; i++) + { + /** isspace: space, \n, \v, \f, \r **/ + if (isspace(str[i])) continue; + + /** ispunct: !"#$%&'()*+,-./:;<=>?@[\]^_{|}~ **/ + if (ispunct(str[i]) && str[i] != CA_BOUNDARY_CHAR) continue; + + /*** iscntrl (0-8): NULL, SOH, STX, ETX, EOT, ENQ, ACK, BEL, BS + *** (14-31): SO, SI, DLE, DC1-4, NAK, SYN, ETB, CAN EM, + *** SUB, ESC, FS, GS, RS, US + ***/ + if (iscntrl(str[i]) && i != num_chars) + { + fprintf(stderr, + "ca_build_vector(%s) - Warning: Skipping unknown character #%u.\n", + str, (unsigned int)str[i] + ); + continue; + } + + /** First and last character should fall one before 'a' in the ASCII table. **/ + unsigned int temp1 = (j == 65535u) ? CA_BOUNDARY_CHAR : (unsigned int)tolower(str[j]); + unsigned int temp2 = (i == num_chars) ? CA_BOUNDARY_CHAR : (unsigned int)tolower(str[i]); + + /** Shift numbers to the end of the lowercase letters. **/ + if ('0' <= temp1 && temp1 <= '9') temp1 += 75u; + if ('0' <= temp2 && temp2 <= '9') temp2 += 75u; + + /** Hash the character pair into an index (dimension). **/ + /** Note that temp will be between 97 ('a') and 132 ('9'). **/ + unsigned int dim = hash_char_pair(temp1, temp2); + + /** Increment the dimension of the dense vector by a number from 1 to 13. **/ + dense_vector[dim] += (temp1 + temp2) % 13u + 1u; + + j = i; + } + + /** Count how much space is needed for a sparse vector. **/ + bool zero_prev = false; + size_t size = 0u; + for (unsigned int dim = 0u; dim < CA_NUM_DIMS; dim++) + { + if (dense_vector[dim] == 0u) + { + size += (zero_prev) ? 0u : 1u; + zero_prev = true; + } + else + { + size++; + zero_prev = false; + } + } + + /*** Check compression size. + *** If this check fails, I doubt anything will break. However, the longest + *** word I know (supercalifragilisticexpialidocious) has only 35 character + *** pairs, so it shouldn't reach half this size (and it'd be even shorter + *** if the hash generates at least one collision). + *** + *** Bad vector compression will result in degraded performace and increased + *** memory usage. This indicates a likely bug in the code. Thus, if this + *** warning is ever generated, it is definitely worth investigating. + ***/ + const size_t expected_max_size = 64u; + if (size > expected_max_size) + { + fprintf(stderr, + "cli_build_vector(%s) - Warning: Sparse vector larger than expected.\n" + " > Size: %lu\n" + " > #Dims: %u\n", + str, + size, + CA_NUM_DIMS + ); + } + + /** Allocate space for sparse vector. **/ + const size_t sparse_vector_size = size * sizeof(int); + pVector sparse_vector = (pVector)nmSysMalloc(sparse_vector_size); + if (sparse_vector == NULL) + { + fprintf(stderr, + "cli_build_vector(%s) - nmSysMalloc(%lu) failed.\n", + str, sparse_vector_size + ); + return NULL; + } + + /** Convert the dense vector above to a sparse vector. **/ + unsigned int j = 0u, sparse_idx = 0u; + while (j < CA_NUM_DIMS) + { + if (dense_vector[j] == 0u) + { + /*** Count and store consecutive zeros, except the first one, + *** which we already know is zero. + ***/ + unsigned int zero_count = 1u; + j++; + while (j < CA_NUM_DIMS && dense_vector[j] == 0u) + { + zero_count++; + j++; + } + sparse_vector[sparse_idx++] = (int)-zero_count; + } + else + { + /** Store the value. **/ + sparse_vector[sparse_idx++] = (int)dense_vector[j++]; + } + } + + return sparse_vector; + } + +/*** Free memory allocated to store a sparse vector. + *** + *** @param sparse_vector The sparse vector being freed. + ***/ +void ca_free_vector(pVector sparse_vector) + { + nmSysFree(sparse_vector); + } + +/*** Compute the magnitude of a sparsely allocated vector. + *** + *** @param vector The vector. + *** @returns The computed magnitude. + ***/ +static double magnitude_sparse(const pVector vector) + { + unsigned int magnitude = 0u; + for (unsigned int i = 0u, dim = 0u; dim < CA_NUM_DIMS;) + { + const int val = vector[i++]; + + /** Negative val represents -val 0s in the array, so skip that many values. **/ + if (val < 0) dim += (unsigned)(-val); + + /** We have a param_value, so square it and add it to the magnitude. **/ + else { magnitude += (unsigned)(val * val); dim++; } + } + return sqrt((double)magnitude); + } + +/*** Compute the length of a sparsely allocated vector. + *** + *** @param vector The vector. + *** @returns The computed length. + ***/ +unsigned int ca_sparse_len(const pVector vector) + { + unsigned int i = 0u; + for (unsigned int dim = 0u; dim < CA_NUM_DIMS;) + { + const int val = vector[i++]; + + /** Negative val represents -val 0s in the array, so skip that many values. **/ + if (val < 0) dim += (unsigned)(-val); + + /** We have a param_value, but we don't need to do anything with it. **/ + else dim++; + } + return i; + } + +/*** Compute the magnitude of a densely allocated centroid. + *** + *** @param centroid The centroid. + *** @returns The computed magnitude. + ***/ +static double magnitude_dense(const pCentroid centroid) + { + double magnitude = 0.0; + for (int i = 0; i < CA_NUM_DIMS; i++) + magnitude += centroid[i] * centroid[i]; + return sqrt(magnitude); + } + +/*** Parse a token from a sparsely allocated vector and write the param_value and + *** number of remaining values to the passed locations. + *** + *** @param token The sparse vector token being parsed. + *** @param remaining The location to save the remaining number of characters. + *** @param param_value The location to save the param_value of the token. + ***/ +static void parse_vector_token(const int token, unsigned int* remaining, unsigned int* param_value) + { + if (token < 0) + { + /** This run contains -token zeros. **/ + *remaining = (unsigned)(-token); + *param_value = 0u; + } + else + { + /** This run contains one param_value. **/ + *remaining = 1u; + *param_value = (unsigned)(token); + } + } + +/*** Calculate the similarity on sparcely allocated vectors. Comparing + *** any string to an empty string should always return 0.5 (untested). + *** + *** @param v1 Sparse vector #1. + *** @param v2 Sparse vector #2. + *** @returns Similarity between 0 and 1 where + *** 1 indicates identical and + *** 0 indicates completely different. + ***/ +static double sparse_similarity(const pVector v1, const pVector v2) + { + /** Calculate dot product. **/ + unsigned int vec1_remaining = 0u, vec2_remaining = 0u; + unsigned int dim = 0u, i1 = 0u, i2 = 0u, dot_product = 0u; + while (dim < CA_NUM_DIMS) + { + unsigned int val1 = 0u, val2 = 0u; + if (vec1_remaining == 0u) parse_vector_token(v1[i1++], &vec1_remaining, &val1); + if (vec2_remaining == 0u) parse_vector_token(v2[i2++], &vec2_remaining, &val2); + + /*** Accumulate the dot_product. If either vector is 0 here, + *** the total is 0 and this statement does nothing. + ***/ + dot_product += val1 * val2; + + /** Consume overlap from both runs. **/ + unsigned int overlap = min(vec1_remaining, vec2_remaining); + vec1_remaining -= overlap; + vec2_remaining -= overlap; + dim += overlap; + } + + /** Optional optimization to speed up nonsimilar vectors. **/ + if (dot_product == 0u) return 0.0; + + /** Return the difference score. **/ + return (double)dot_product / (magnitude_sparse(v1) * magnitude_sparse(v2)); + } + +/*** Calculate the difference on sparcely allocated vectors. Comparing + *** any string to an empty string should always return 0.5 (untested). + *** + *** @param v1 Sparse vector #1. + *** @param v2 Sparse vector #2. + *** @returns Similarity between 0 and 1 where + *** 1 indicates completely different and + *** 0 indicates identical. + ***/ +#define sparse_dif(v1, v2) (1.0 - sparse_similarity(v1, v2)) + +/*** Calculate the similarity between a sparsely allocated vector + *** and a densely allocated centroid. Comparing any string to an + *** empty string should always return 0.5 (untested). + *** + *** @param v1 Sparse vector #1. + *** @param c1 Dense centroid #2. + *** @returns Similarity between 0 and 1 where + *** 1 indicates identical and + *** 0 indicates completely different. + ***/ +static double sparse_similarity_to_centroid(const pVector v1, const pCentroid c2) + { + /** Calculate dot product. **/ + double dot_product = 0.0; + for (unsigned int i = 0u, dim = 0u; dim < CA_NUM_DIMS;) + { + const int val = v1[i++]; + + /** Negative val represents -val 0s in the array, so skip that many values. **/ + if (val < 0) dim += (unsigned)(-val); + + /** We have a param_value, so square it and add it to the magnitude. **/ + else dot_product += (double)val * c2[dim++]; + } + + /** Return the difference score. **/ + return dot_product / (magnitude_sparse(v1) * magnitude_dense(c2)); + } + +/*** Calculate the difference between a sparsely allocated vector + *** and a densely allocated centroid. Comparing any string to an + *** empty string should always return 0.5 (untested). + *** + *** @param v1 Sparse vector #1. + *** @param c1 Dense centroid #2. + *** @returns Difference between 0 and 1 where + *** 1 indicates completely different and + *** 0 indicates identical. + ***/ +#define sparse_dif_to_centroid(v1, c2) (1.0 - sparse_similarity_to_centroid(v1, c2)) + +/*** Calculate the average size of all clusters in a set of vectors. + *** + *** @param vectors The vectors of the dataset (allocated sparsely). + *** @param num_vectors The number of vectors in the dataset. + *** @param labels The clusters to which vectors are assigned. + *** @param centroids The locations of the centroids (allocated densely). + *** @param num_clusters The number of centroids (k). + *** @returns The average cluster size. + ***/ +static double get_cluster_size( + pVector* vectors, + const unsigned int num_vectors, + unsigned int* labels, + pCentroid* centroids, + const unsigned int num_clusters) + { + /** Could be up to around 1KB on the stack, but I think that's fine. **/ + double cluster_sums[num_clusters]; + unsigned int cluster_counts[num_clusters]; + for (unsigned int i = 0u; i < num_clusters; i++) + cluster_sums[i] = 0.0; + memset(cluster_counts, 0, sizeof(cluster_counts)); + + /** Sum the difference from each vector to its cluster centroid. **/ + for (unsigned int i = 0u; i < num_vectors; i++) + { + const unsigned int label = labels[i]; + cluster_sums[label] += sparse_dif_to_centroid(vectors[i], centroids[label]); + cluster_counts[label]++; + } + + /** Add up the average cluster size. **/ + double cluster_total = 0.0; + unsigned int num_valid_clusters = 0u; + for (unsigned int label = 0u; label < num_clusters; label++) + { + const unsigned int cluster_count = cluster_counts[label]; + if (cluster_count == 0u) continue; + + cluster_total += cluster_sums[label] / cluster_count; + num_valid_clusters++; + } + + /** Return average sizes. **/ + return cluster_total / num_valid_clusters; + } + +/*** Compute the param_value for `k` (number of clusters), given a dataset of with + *** a size of `n`. + *** + *** The following table shows data sizes vs.selected cluster size. In testing, + *** these numbers tended to givea good balance of accuracy and dulocates detected. + *** + *** ```csv + *** Data Size, Actual + *** 10k, 12 + *** 100k, 33 + *** 1M, 67 + *** 4M, 93 + *** ``` + *** + *** This function is not intended for datasets smaller than (`n < ~2000`). + *** These should be handled using complete search. + *** + *** LaTeX Notation: \log_{36}\left(n\right)^{3.1}-8 + *** + *** @param n The size of the dataset. + *** @returns k, the number of clusters to use. + *** + *** Complexity: `O(1)` + ***/ +unsigned int compute_k(const unsigned int n) + { + return (unsigned)max(2, pow(log(n) / log(36), 3.2) - 8); + } + +/*** Executes the k-means clustering algorithm. Selects NUM_CLUSTERS random + *** vectors as initial centroids. Then points are assigned to the nearest + *** centroid, after which centroids are moved to the center of their points. + *** + *** @param vectors The vectors to cluster. + *** @param num_vectors The number of vectors to cluster. + *** @param labels Stores the final cluster identities of the vectors after + *** clustering is completed. + *** @param centroids Stores the locations of the centroids used for the clusters + *** of the data. + *** @param iterations The number of iterations that actually executed is stored + *** here. Leave this NULL if you don't care. + *** @param max_iter The max number of iterations. + *** @param num_clusters The number of clusters to generate. + *** + *** @attention - Assumes: num_vectors is the length of vectors. + *** @attention - Assumes: num_clusters is the length of labels. + *** + *** @attention - Issue: At larger numbers of clustering iterations, some + *** clusters have a size of negative infinity. In this implementation, + *** the bug is mitigated by setting a small number of max iterations, + *** such as 16 instead of 100. + *** @attention - Issue: Clusters do not apear to improve much after the first + *** iteration, which puts the efficacy of the algorithm into question. This + *** may be due to the uneven density of a typical dataset. However, the + *** clusters still offer useful information. + *** + *** Complexity: + *** + *** - `O(kd + k + i*(k + n*(k+d) + kd))` + *** + *** - `O(kd + k + ik + ink + ind + ikd)` + *** + *** - `O(nk + nd)` + ***/ +void ca_kmeans( + pVector* vectors, + const unsigned int num_vectors, + unsigned int* labels, + const unsigned int num_clusters, + const unsigned int max_iter, + const double improvement_threshold) + { + /** Ensure labels is clean. **/ + memset(labels, 0, num_clusters * sizeof(unsigned int)); + + /** Allocate space to store centroids and new_centroids. **/ + /** Dynamic allocation is required because these densely allocated arrays might be up to 500KB! **/ + pCentroid* centroids = (pCentroid*)nmMalloc(num_clusters * sizeof(pCentroid)); + if (centroids == NULL) + { + fprintf(stderr, "ca_kmeans() - nmMalloc(%lu) failed.\n", num_clusters * sizeof(pCentroid)); + assert(false); + } + pCentroid* new_centroids = (pCentroid*)nmMalloc(num_clusters * sizeof(pCentroid)); + if (new_centroids == NULL) + { + fprintf(stderr, "ca_kmeans() - nmMalloc(%lu) failed.\n", num_clusters * sizeof(pCentroid)); + assert(false); + } + for (unsigned int i = 0u; i < num_clusters; i++) + { + /** Malloc each centroid. **/ + centroids[i] = (pCentroid)nmMalloc(pCentroidSize); + if (centroids[i] == NULL) + { + fprintf(stderr, "ca_kmeans() - nmMalloc(%lu) failed.\n", pCentroidSize); + assert(false); + } + memset(centroids[i], 0, pCentroidSize); + + /** Malloc each new centroid. **/ + new_centroids[i] = (pCentroid)nmMalloc(pCentroidSize); + if (new_centroids[i] == NULL) + { + fprintf(stderr, "ca_kmeans() - nmMalloc(%lu) failed.\n", pCentroidSize); + assert(false); + } + memset(new_centroids[i], 0, pCentroidSize); + } + + /** Select random vectors to use as the initial centroids. **/ + srand(time(NULL)); + for (unsigned int i = 0u; i < num_clusters; i++) + { + // Pick a random vector. + const pVector vector = vectors[rand() % num_vectors]; + + // Sparse copy the vector to expand it into a densely allocated centroid. + pCentroid centroid = centroids[i]; + for (unsigned int i = 0u, dim = 0u; dim < CA_NUM_DIMS;) + { + const int token = vector[i++]; + if (token > 0) centroid[dim++] = (double)token; + else for (unsigned int j = 0u; j < -token; j++) centroid[dim++] = 0.0; + } + } + + /** Main kmeans loop. **/ + double old_average_cluster_size = 1.0; + unsigned int cluster_counts[num_clusters]; + for (unsigned int iter = 0u; iter < max_iter; iter++) + { + bool changed = false; + + /** Reset new centroids. **/ + for (unsigned int i = 0u; i < num_clusters; i++) + { + cluster_counts[i] = 0u; + for (unsigned int dim = 0; dim < CA_NUM_DIMS; dim++) + new_centroids[i][dim] = 0.0; + } + + /** Assign each point to the nearest centroid. **/ + for (unsigned int i = 0u; i < num_vectors; i++) + { + const pVector vector = vectors[i]; + double min_dist = DBL_MAX; + unsigned int best_centroid_label = 0u; + + // Find nearest centroid. + for (unsigned int j = 0u; j < num_clusters; j++) + { + const double dist = sparse_dif_to_centroid(vector, centroids[j]); + if (dist < min_dist) + { + min_dist = dist; + best_centroid_label = j; + } + } + + /** Update label to new centroid, if necessary. **/ + if (labels[i] != best_centroid_label) + { + labels[i] = best_centroid_label; + changed = true; + } + + /** Accumulate values for new centroid calculation. **/ + pCentroid best_centroid = new_centroids[best_centroid_label]; + for (unsigned int i = 0u, dim = 0u; dim < CA_NUM_DIMS;) + { + const int val = vector[i++]; + if (val < 0) dim += (unsigned)(-val); + else best_centroid[dim++] += (double)val; + } + cluster_counts[best_centroid_label]++; + } + + /** Stop if centroids didn't change. **/ + if (!changed) break; + + /** Update centroids. **/ + for (unsigned int i = 0u; i < num_clusters; i++) + { + if (cluster_counts[i] == 0u) continue; + pCentroid centroid = centroids[i]; + const pCentroid new_centroid = new_centroids[i]; + const unsigned int cluster_count = cluster_counts[i]; + for (unsigned int dim = 0u; dim < CA_NUM_DIMS; dim++) + centroid[dim] = new_centroid[dim] / cluster_count; + } + + /** Is there enough improvement? **/ + const double average_cluster_size = get_cluster_size(vectors, num_vectors, labels, centroids, num_clusters); + const double improvement = old_average_cluster_size - average_cluster_size; + if (improvement < improvement_threshold) break; + old_average_cluster_size = average_cluster_size; + } + + /** Clean up. **/ + for (unsigned int i = 0u; i < num_clusters; i++) + { + nmFree(centroids[i], pCentroidSize); + nmFree(new_centroids[i], pCentroidSize); + } + nmFree(centroids, num_clusters * sizeof(pCentroid)); + nmFree(new_centroids, num_clusters * sizeof(pCentroid)); + } + +pXArray ca_search( + pVector* vectors, + const unsigned int num_vectors, + const unsigned int* labels, + const double dupe_threshold) + { + /** Allocate space for dups. **/ + pXArray dups = xaNew(num_vectors); + if (dups == NULL) + { + fprintf(stderr, "ca_search() - xaNew(%u) failed.\n", num_vectors); + return NULL; + } + + unsigned int a = 0, b = 0, c = 0, d = 0; + for (unsigned int i = 0u; i < num_vectors; i++) + { + const pVector v1 = vectors[i]; + const unsigned int label = labels[i]; + for (unsigned int j = i + 1u; j < num_vectors; j++) + { + if (b++ % 100 == 0) printf("."); + if (labels[j] != label) continue; + if (c++ % 100 == 0) printf(":"); + const pVector v2 = vectors[j]; + const double similarity = sparse_similarity(v1, v2); + if (similarity > dupe_threshold) /* Dup found! */ + { + Dup* dup = (Dup*)nmMalloc(sizeof(Dup)); + if (dup == NULL) + { + fprintf(stderr, + "ca_search() - nmMalloc(%lu) failed.\n", + sizeof(Dup) + ); + goto err_free_dups; + } + + dup->id1 = i; + dup->id2 = j; + dup->similarity = similarity; + xaAddItem(dups, (void*)dup); + if (d++ % 4 == 0) printf("!"); + } + } + if (a++ % 4 == 0) printf("\n"); + } + + return dups; + + /** Free dups. **/ + err_free_dups:; + const size_t num_dups = dups->nItems; + for (unsigned int i = 0u; i < num_dups; i++) + { + nmFree(dups->Items[i], sizeof(Dup)); + dups->Items[i] = NULL; + } + xaDeInit(dups); + return NULL; + } + +/*** Runs complete search to find duplocates if `num_vectors < MAX_COMPLETE_SEARCH` + *** and runs a search using k-means clustering on larger amounts of data. + *** + *** @param vectors Array of precomputed frequency vectors for all dataset strings. + *** @param num_vectors The number of vectors to be scanned. + *** @param dupe_threshold The similarity threshold, below which dups are ignored. + *** @returns The duplicates in pDup structs. + ***/ +pXArray ca_lightning_search(pVector* vectors, const unsigned int num_vectors, const double dupe_threshold) + { + /** Allocate space for dups. **/ + const size_t guess_size = num_vectors * 2u; + pXArray dups = xaNew(guess_size); + if (dups == NULL) + { + fprintf(stderr, "ca_lightning_search() - xaNew(%lu) failed.\n", guess_size); + return NULL; + } + + /** Descide which algorithm to use. **/ + if (num_vectors <= 50 * 1000) + { /** Do a complete search. **/ + for (unsigned int i = 0u; i < num_vectors; i++) + { + const pVector v1 = vectors[i]; + for (unsigned int j = i + 1u; j < num_vectors; j++) + { + const pVector v2 = vectors[j]; + const double similarity = sparse_similarity(v1, v2); + if (similarity > dupe_threshold) // Dup found! + { + Dup* dup = (Dup*)nmMalloc(sizeof(Dup)); + if (dup == NULL) + { + fprintf(stderr, "ca_lightning_search() - nmMalloc(%lu) failed.\n", sizeof(Dup)); + goto err_free_dups; + } + + dup->id1 = i; + dup->id2 = j; + dup->similarity = similarity; + xaAddItem(dups, (void*)dup); + } + } + } + } + else + { /** Do a k-means search. **/ + /** Define constants for the algorithm. **/ + const unsigned int max_iter = 64u; /** Hardcode value because idk. **/ + const unsigned int num_clusters = compute_k(num_vectors); + + /** Allocate static memory for finding clusters. **/ + unsigned int labels[num_vectors]; + memset(labels, 0u, sizeof(labels)); + + /** Execute kmeans clustering. **/ + ca_kmeans(vectors, num_vectors, labels, num_clusters, max_iter, 0.0002); + + /** Find duplocates in clusters. **/ + for (unsigned int i = 0u; i < num_vectors; i++) + { + const pVector v1 = vectors[i]; + const unsigned int label = labels[i]; + for (unsigned int j = i + 1u; j < num_vectors; j++) + { + if (labels[j] != label) continue; + const pVector v2 = vectors[j]; + const double similarity = sparse_similarity(v1, v2); + if (similarity > dupe_threshold) /* Dup found! */ + { + Dup* dup = (Dup*)nmMalloc(sizeof(Dup)); + if (dup == NULL) + { + fprintf(stderr, + "ca_lightning_search() - nmMalloc(%lu) failed.\n", + sizeof(Dup) + ); + goto err_free_dups; + } + + dup->id1 = i; + dup->id2 = j; + dup->similarity = similarity; + xaAddItem(dups, (void*)dup); + } + } + } + } + + /** Done **/ + return dups; + + /** Free dups. **/ + err_free_dups:; + const size_t num_dups = dups->nItems; + for (unsigned int i = 0u; i < num_dups; i++) + { + nmFree(dups->Items[i], sizeof(Dup)); + dups->Items[i] = NULL; + } + xaDeInit(dups); + return NULL; + } + +/*** Computes Levenshtein distance between two strings. + *** + *** @param str1 The first string. + *** @param str2 The second string. + *** @param length1 The length of the first string. + *** @param length1 The length of the first string. + *** + *** @attention - Tip: Pass 0 for the length of either string to infer it + *** using the null terminating character. Thus, strings with no null + *** terminator are supported if you pass explicit lengths. + *** + *** Complexity: O(length1 * length2). + *** + *** @see centrallix-sysdoc/string_comparison.md + ***/ +unsigned int ca_edit_dist(const char* str1, const char* str2, const size_t str1_length, const size_t str2_length) + { + /*** lev_matrix: + *** For all i and j, d[i][j] will hold the Levenshtein distance between + *** the first i characters of s and the first j characters of t. + *** + *** As they say, no dynamic programming algorithm is complete without a + *** matrix that you fill out and it has the answer in the final location. + ***/ + const size_t str1_len = (str1_length == 0u) ? strlen(str1) : str1_length; + const size_t str2_len = (str2_length == 0u) ? strlen(str2) : str2_length; + unsigned int lev_matrix[str1_len + 1][str2_len + 1]; + + /*** Base case #0: + *** Transforming an empty string into an empty string has 0 cost. + ***/ + lev_matrix[0][0] = 0u; + + /*** Base case #1: + *** Any source prefixe can be transformed into an empty string by + *** dropping each character. + ***/ + for (unsigned int i = 1u; i <= str1_len; i++) + lev_matrix[i][0] = i; + + /*** Base case #2: + *** Any target prefixes can be transformed into an empty string by + *** inserting each character. + ***/ + for (unsigned int j = 1u; j <= str2_len; j++) + lev_matrix[0][j] = j; + + /** General Case **/ + for (unsigned int i = 1u; i <= str1_len; i++) + { + for (unsigned int j = 1u; j <= str2_len; j++) + { + /** Equal characters need no changes. **/ + if (str1[i - 1] == str2[j - 1]) + lev_matrix[i][j] = lev_matrix[i - 1][j - 1]; + + /*** We need to make a change, so use the opereration with the + *** lowest cost out of delete, insert, replace, or swap. + ***/ + else + { + unsigned int cost_delete = lev_matrix[i - 1][j] + 1u; + unsigned int cost_insert = lev_matrix[i][j - 1] + 1u; + unsigned int cost_replace = lev_matrix[i-1][j-1] + 1u; + + /** If a swap is possible, calculate the cost. **/ + bool can_swap = ( + i > 1 && j > 1 && + str1[i - 1] == str2[j - 2] && + str1[i - 2] == str2[j - 1] + ); + unsigned int cost_swap = (can_swap) ? lev_matrix[i - 2][j - 2] + 1 : UINT_MAX; + + // Find the best operation. + lev_matrix[i][j] = min(min(min(cost_delete, cost_insert), cost_replace), cost_swap); + } + } + } + + return lev_matrix[str1_len][str2_len]; + } + +/*** Runs complete search to find duplocates in phone numbers using the + *** levenshtein min edit distance algorithm. + *** + *** @param dataset An array of characters for all dataset strings. + *** @param dataset_size The number of phone numbers to be scanned. + *** @param dupe_threshold The similarity threshold, below which dups are ignored. + *** @returns The duplicates in pDup structs. + ***/ +pXArray ca_phone_search(char dataset[][10u], const unsigned int dataset_size, const double dupe_threshold) + { + /** Allocate space for dups. **/ + const size_t guess_size = dataset_size * 2u; + pXArray dups = xaNew(guess_size); + if (dups == NULL) + { + fprintf(stderr, "ca_phone_search() - xaNew(%lu) failed.\n", guess_size); + return NULL; + } + + /** Search for dups using edit distance. **/ + for (unsigned int i = 0u; i < dataset_size; i++) + { + const char* v1 = dataset[i]; + for (unsigned int j = i + 1u; j < dataset_size; j++) + { + const char* v2 = dataset[j]; + const unsigned int dist = ca_edit_dist(v1, v2, 10u, 10u); + const double similarity = (double)dist / 10.0; + if (similarity > dupe_threshold) /* Dup found! */ + { + Dup* dup = (Dup*)nmMalloc(sizeof(Dup)); + if (dup == NULL) + { + fprintf(stderr, "ca_phone_search() - nmMalloc(%lu) failed.\n", sizeof(Dup)); + + /** Free data before returning. **/ + const size_t num_dups = dups->nItems; + for (unsigned int i = 0u; i < num_dups; i++) + { + void* dup = dups->Items[i]; + nmFree(dup, sizeof(Dup)); + } + xaDeInit(dups); + return NULL; + } + + dup->id1 = i; + dup->id2 = j; + dup->similarity = similarity; + xaAddItem(dups, (void*)dup); + } + } + } + + return dups; + } + +void ca_init() + { + nmRegister(sizeof(Dup), "Dup"); + } + +/** Scope cleanup. **/ +#undef sparse_dif +#undef sparse_dif_to_centroid diff --git a/centrallix-lib/src/util.c b/centrallix-lib/src/util.c index 629b59c79..ec1d87bcf 100644 --- a/centrallix-lib/src/util.c +++ b/centrallix-lib/src/util.c @@ -14,11 +14,17 @@ /* Description: Collection of utilities */ /************************************************************************/ +#include +#include +#include +#include +#include #include - #include -#include -#include +#include +#include + +#include "newmalloc.h" #include "util.h" /** @@ -77,3 +83,161 @@ unsigned int strtoui(const char *nptr, char **endptr, int base){ //return as tmp; return (unsigned int)tmp; } + +/*** Detects the optimal number of threads to use on this system. + *** Note: Multithreading is not currently supported, so this funciton + *** will always return 1, for now. + *** + *** @returns The number of threads that should be used on this system. + ***/ +int util_detect_num_threads(void) + { + /** Centrallix does not support multithreading. **/ + return 1; + + long num_procs = sysconf(_SC_NPROCESSORS_ONLN); + if (num_procs < 1 || INT_MAX < num_procs) + { + fprintf(stderr, "Warning: Detected strange number of processors (assuming 1): %ld\n", num_procs); + return 1; + } + else return (int)num_procs; + } + +/*** snprint_bytes() allows one to pick between CS units, where the kibibyte + *** (KiB) is 1024 bytes, and metric units where the kilobyte (KB) is 1000 bytes. + *** Fun Fact: Windows uses kibibytes, but displays them as KB. + ***/ +#define USE_METRIC false +#define nUnits 6u +static char* units_cs[nUnits] = {"bytes", "KiB", "MiB", "GiB", "TiB", "PiB"}; +static char* units_metric[nUnits] = {"bytes", "KB", "MB", "GB", "TB", "PB"}; +/*** Displays a size in bytes using the largest unit where the result would be + *** at least 1.0. + *** + *** @param buf The buffer to which new text will be written, using snprintf(). + *** @param buf_size The amount of space in the buffer, passed to snprintf(). + *** It is recomended to have at least 12 characters available. + *** @param bytes The number of bytes, which will be formatted and written + *** to the buffer.. + *** @returns buf, for chaining. + ***/ +char* snprint_bytes(char* buf, const size_t buf_size, unsigned int bytes) + { + char** units = (USE_METRIC) ? units_metric : units_cs; + const double unit_size = (USE_METRIC) ? 1000.0 : 1024.0; + + /** Search for the largest unit where the value would be at least 1. **/ + const double size = (double)bytes; + for (unsigned char i = nUnits; i >= 1u; i--) + { + const double denominator = pow(unit_size, i); + if (size >= denominator) + { + const double converted_size = size / denominator; + if (converted_size >= 100.0) + snprintf(buf, buf_size, "%.5g %s", converted_size, units[i]); + else if (converted_size >= 10.0) + snprintf(buf, buf_size, "%.4g %s", converted_size, units[i]); + else /* if (converted_size >= 1.0) - Always true. */ + snprintf(buf, buf_size, "%.3g %s", converted_size, units[i]); + return buf; + } + } + + /** None of the larger units work, so we just use bytes. **/ + snprintf(buf, buf_size, "%u %s", bytes, units[0]); + + return buf; + } +#undef nUints + +void fprint_mem(FILE* out) + { + FILE* fp = fopen("/proc/self/statm", "r"); + if (fp == NULL) { perror("fopen()"); return; } + + long size, resident, share, text, lib, data, dt; + if (fscanf(fp, "%ld %ld %ld %ld %ld %ld %ld", + &size, &resident, &share, &text, &lib, &data, &dt) != 7) + { + fprintf(stderr, "Failed to read memory info\n"); + fclose(fp); + return; + } + fclose(fp); + + long page_size = sysconf(_SC_PAGESIZE); // in bytes + long resident_bytes = resident * page_size; + + const size_t buf_siz = 16u; + char buf[buf_siz]; + snprint_bytes(buf, buf_siz, (unsigned int)resident_bytes); + + fprintf(out, "Memory used: %ld bytes (%s)\n", resident_bytes, buf); + fprintf(out, "Share %ldb, Text %ldb, Lib %ldb, Data %ldb\n", share, text, lib, data); + } + +static double get_time(void) + { + struct timespec ts; + clock_gettime(CLOCK_MONOTONIC, &ts); + return (double)ts.tv_sec + (double)ts.tv_nsec / 1.0e9f; + } + +pTimer timer_init(pTimer timer) + { + if (timer == NULL) return NULL; + timer->start = NAN; + timer->end = NAN; + return timer; + } + +pTimer timer_new(void) + { + return timer_init(nmMalloc(sizeof(Timer))); + } + +pTimer timer_start(pTimer timer) + { + if (!timer) return timer; + timer->start = get_time(); + return timer; + } + +pTimer timer_stop(pTimer timer) + { + if (!timer) return timer; + timer->end = get_time(); + return timer; + } + +double timer_get(pTimer timer) + { + return (timer) ? timer->end - timer->start : NAN; + } + +void timer_de_init(pTimer timer) {} + +void timer_free(pTimer timer) + { + timer_de_init(timer); + nmFree(timer, sizeof(Timer)); + } + +/*** Function for failing on error, assuming the error came from a library or + *** system function call, so that the error buffer is set to a valid value. + ***/ +void fail(const char* function_name, int code) + { + /** Create the most descriptive error message we can. **/ + char error_buf[BUFSIZ]; + snprintf(error_buf, sizeof(error_buf), "kmeans.c: Fail - %s", function_name); + if (errno != 0) perror(error_buf); + else if (code != 0) fprintf(stderr, "%s (error code %d)\n", error_buf, code); + else fprintf(stderr, "%s", error_buf); + + /** Throw error for easier locating in a debugger. **/ + fprintf(stderr, "Program will now crash.\n"); + raise(SIGSEGV); + } diff --git a/centrallix-lib/src/xhash.c b/centrallix-lib/src/xhash.c index afeb432b5..32a4a35eb 100644 --- a/centrallix-lib/src/xhash.c +++ b/centrallix-lib/src/xhash.c @@ -290,4 +290,74 @@ xhClear(pXHashTable this, int (*free_fn)(), void* free_arg) return 0; } +/*** Executes an operation on each entry of the hash table entry. + *** + *** @param this The affected hash table. + *** @param callback_fn A callback function to be called on each hash table + *** entry. It takes 2 parameters: the current hash table entry and a void* + *** argument specified using each_arg. If any invokation of the callback + *** function returns a value other than 0, xhForEach() will immediately + *** fail, returning that value as the error code. + *** @param each_arg An aditional argument which will be passed to each + *** invokation of the callback function. + *** @returns 0 if the function executes successfully. + *** 1 if the callback function is NULL. + *** n (where n != 0) if the callback function returns n. + ***/ +int +xhForEach(pXHashTable this, int (*callback_fn)(pXHashEntry, void*), void* each_arg) + { + if (callback_fn == NULL) return 1; + + for (int row = 0; row < this->nRows; row++) + { + pXHashEntry entry = (pXHashEntry)(this->Rows.Items[row]); + while (entry != NULL) + { + pXHashEntry next = entry->Next; + const int ret = callback_fn(entry, each_arg); + if (ret != 0) return ret; + entry = next; + } + } + + return 0; + } + +static int +xhiFreeEntry(pXHashEntry entry, void* arg) + { + /*** The passed void* actually points to a void* array with 2 elements. + *** The first element is a function pointer to the free function, which + *** we invoke using the provided entry and the free_arg, specified as the + *** second element of the array. + *** + *** Interestingly, you can write this code in one line like this: + *** ((void (*)(pXHashEntry, void*))((void**)arg)[0])(entry, ((void**)arg)[1]); + *** But I value code readability, so fortunately, I can't be THAT cleaver... + ***/ + void** args = (void**)arg; + void (*free_fn)(pXHashEntry, void*) = args[0]; + free_fn(entry, args[1]); + + /** Free the entry. **/ + nmFree(entry, sizeof(XHashEntry)); + + return 0; + } +int +xhClearKeySafe(pXHashTable this, void (*free_fn)(pXHashEntry, void*), void* free_arg) + { + /** Free each row. **/ + void* args[2] = {free_fn, free_arg}; + const int ret = xhForEach(this, xhiFreeEntry, args); + + /** Mark all rows as empty. **/ + for (int i = 0; i < this->nRows; i++) + this->Rows.Items[i] = NULL; + this->nItems = 0; + + /** We are successful only if the free function didn't fail. **/ + return ret; + } diff --git a/centrallix-os/cluster-schema.cluster b/centrallix-os/cluster-schema.cluster new file mode 100644 index 000000000..201c41255 --- /dev/null +++ b/centrallix-os/cluster-schema.cluster @@ -0,0 +1,176 @@ +// Input schema +$Version=2$ +file_name "system/cluster" + { + name "cluster/parameter" + { + type : DATA_T // See datatypes.h + ?default : type + ?name : String // Overrides the name above. + ?style : StyleObj // idk where to find docs for this. + } + // Access with :parameters:name. Accessing dynamic data (e.g. parameters) + // should be managed within a runserver() call. + ... + + source : DataSourcePath + attr_name : string ⊂ DataSourcePath/columns + + cluster_name "cluster/cluster" + { + algorithm : "none" | "sliding-window" | "k-means" + | "k-means++" | "k-medoids" |"db-scan" // dbscan not implemented + similarity_measure : "cosine" | "levenshtein" // levenshtein not implemented. + num_clusters : uint > 1 // (probably a parameter) + ?min_improvement : double && 0.0 < x < 1.0 | "none" // default: 0.0001 + ?max_iterations : uint // default: 64 + + // Not implemented + sub_cluster_name "cluster/cluster" + { + // Same as above. + } + } + ... + + search_name "system/search" + { + source : string ⊂ [cluster_name, ...] + threshold : double && 0.0 < x < 1.0 // optimization. + similarity_measure : "cosine" | "levenshtein" // levenshtein not implemented. + } + ... + } + +// Output schema + +- /{arbitrary uint} + ? /sub_cluster_name + ? /{arbitrary uint} + ... + - /average_similarity : double && 0.0 < x < 1.0 + - /size = average_similarity + - /{arbitrary uint} + - /val : typeof(attr_name) // The value of the data point. + - /label : uint < num_clusters // id of the cluster to which this data point belongs. + - /sim : double && 0.0 < x <= threshold // Similarity to cluster centroid. +... +/search_name +- /{arbitrary uint} + - /id1 : uint // The id of the first data point. + - /id2 : uint // The id of the second data point. + - /val1 : typeof(attr_name) // The value of the first data point. + - /val2 : typeof(attr_name) // The value of the second data point. + - /sim : double && 0.0 < x <= threshold // The similarity of the two data points. +... + +// Other notes + +// This means centrallix scripts will have to chose when to switch +// from complete search to clustered search. I think this is a good +// thing, because that feels like a higher-level responsibility. + +// Invoke file: +// select * from /file.cl + +// Driver-authoring.md +// Comprehend stparse.c (lib vs. centrallix?) +// Design what a .cluster file looks like. +// +// Figure out how to invoke the object system. + +// Random queries + +// Names +SELECT CONCAT(p_given_name, ' ', p_surname) AS full_name, + COUNT(*) AS num_dups +FROM p_partner +WHERE p_given_name is not null +AND p_surname is not null +AND p_given_name != "" +AND p_surname != "" +AND p_given_name != " " +AND p_surname != " " +GROUP BY full_name +ORDER BY num_dups DESC +LIMIT 1; +// Result: Ine Bradley with 4 dups + +// Phone Numbers +SELECT CONCAT(ci.p_phone_country, ci.p_phone_area_city, ci.p_contact_data) AS phone_number, + COUNT(*) AS num_dups +FROM p_partner AS p +JOIN p_contact_info AS ci + ON p.p_partner_key = ci.p_partner_key +WHERE ci.p_contact_data != ' ' +AND ci.p_contact_data != '' +AND (ci.p_contact_type = 'P' OR ci.p_contact_type = 'C') +GROUP BY phone_number +ORDER BY num_dups DESC +LIMIT 1; +// Result: 1813762-2274 with 2 dups + +// Emails and Addresses +SELECT CONCAT(ci.p_contact_data, ' ', + l.p_in_care_of, ' ', + l.p_address_1, ' ', + l.p_address_2, ' ', + l.p_address_3, ' ', + l.p_city, ' ', + l.p_state_province, ' ', + l.p_country_code, ' ', + l.p_postal_code) AS email_and_address, + COUNT(*) AS duplicate_count +FROM p_partner AS p +JOIN p_contact_info AS ci + ON p.p_partner_key = ci.p_partner_key +JOIN p_location AS l + ON p.p_partner_key = l.p_partner_key +WHERE ci.p_contact_type = 'E' +GROUP BY email_and_address +ORDER BY duplicate_count DESC +LIMIT 1; +// Result: richard.aypofblcsg@iipr.yeen with 2 dups + +// Email +SELECT ci.p_contact_data AS email, + COUNT(*) AS duplicate_count +FROM p_partner AS p +JOIN p_contact_info AS ci + ON p.p_partner_key = ci.p_partner_key +WHERE ci.p_contact_type = 'E' +GROUP BY email +ORDER BY duplicate_count DESC +LIMIT 1; + +// Result: uoehtbtjvqh20@ltirs.zese with 2 dups + +// Address +SELECT CONCAT(l.p_in_care_of, ' ', + l.p_address_1, ' ', + l.p_address_2, ' ', + l.p_address_3, ' ', + l.p_city, ' ', + l.p_state_province, ' ', + l.p_country_code, ' ', + l.p_postal_code) AS address, + COUNT(*) AS duplicate_count +FROM p_partner AS p +JOIN p_location AS l + ON p.p_partner_key = l.p_partner_key +WHERE l.p_address_1 != ' ' +GROUP BY address +ORDER BY duplicate_count DESC +LIMIT 1; +// Result: "742 1ben Sc E Adams FL US 49152" with 4 + + +// Output to dataset +INTO OUTFILE '/var/lib/mysql/db_output.csv' +LINES TERMINATED BY '|' + +// Output to CSV +INTO OUTFILE '/var/lib/mysql/db_output.csv' +FIELDS TERMINATED BY ',' +ENCLOSED BY '"' +LINES TERMINATED BY '\n'; diff --git a/centrallix-os/file.cluster b/centrallix-os/file.cluster new file mode 100644 index 000000000..929efdd03 --- /dev/null +++ b/centrallix-os/file.cluster @@ -0,0 +1,64 @@ +$Version=2$ +file_name "system/cluster" + { + // Developer can specify parameters to improve file reuseability. + // TIP: Improve performance by declairing frequently used parameters first. + k "cluster/parameter" { type = integer; style=notnull; } + str "cluster/parameter" { type = string; } + int "cluster/parameter" { type = integer; default = runserver(:parameters:k); } + dbl "cluster/parameter" { type = double; default=4.2; } + // conversion "cluster/parameter" { type=double; default=4; } + + null_str "cluster/parameter" { type = string; default = null; } + null_int "cluster/parameter" { type = integer; default = null; } + null_dbl "cluster/parameter" { type = double; default = null; } + + // We calculate k in a centrallix script using: + // k = max(2, pow(log(n) / log(36), 3.2) - 8) + // where n is the number of records passed. + + // Specify the data source at the top of the file. + // How do we pass distinct data? Should the driver + // handle that for us? + source = "/apps/kardia/data/Kardia_DB/p_partner/rows"; + attr_name = p_given_name; // runserver(:parameters:str) + + // Clustering object specifies properties for clustering. + kmeans_cluster "cluster/cluster" + { + algorithm = "k-means"; + similarity_measure = "cosine"; + num_clusters = runserver(:parameters:k); + min_improvement = 0.0001; + max_iterations = 48; + + // Create subclusters. (Not implemented) + sub_cluster "cluster/cluster" + { + algorithm = "none"; + similarity_measure = "cosine"; + num_clusters = 7; + min_improvement = "max"; + } + } + + // Complete search. + no_clustering "cluster/cluster" + { + algorithm = "none"; + } + + dups "cluster/search" + { + source = kmeans_cluster; + threshold = 0.75; + similarity_measure = "cosine"; + } + + dups2 "cluster/search" + { + source = no_clustering; + threshold = 0.75; + similarity_measure = "cosine"; + } + } diff --git a/centrallix-os/file2.cluster b/centrallix-os/file2.cluster new file mode 100644 index 000000000..a55c37f85 --- /dev/null +++ b/centrallix-os/file2.cluster @@ -0,0 +1,42 @@ +$Version=2$ +file_name "system/cluster" + { + // Developer can specify parameters to improve file reuseability. + // TIP: Improve performance by declairing frequently used parameters first. + k "cluster/parameter" { type = integer; style=notnull; } + str "cluster/parameter" { type = string; default="k-means"; } + int "cluster/parameter" { type=integer; default=:parameters:k; } + dbl "cluster/parameter" { type=double; default=4.2; } + // conversion "cluster/parameter" { type=double; default=4; } + + null_str "cluster/parameter" { type = string; default = null; } + null_int "cluster/parameter" { type = integer; default = null; } + null_dbl "cluster/parameter" { type = double; default = null; } + + // We calculate k in a centrallix script using: + // k = max(2, pow(log(n) / log(36), 3.2) - 8) + // where n is the number of records passed. + + // Specify the data source at the top of the file. + // How do we pass distinct data? Should the driver + // handle that for us? + source = "/apps/kardia/data/Kardia_DB/p_partner/rows"; + attr_name = "p_given_name"; + + // Clustering object specifies properties for clustering. + kmeans_cluster "cluster/cluster" + { + algorithm = "k-means"; + similarity_measure = "cosine"; + num_clusters = :parameters:k; + min_improvement = 0.0001; + max_iterations = 48; + } + + dups "cluster/search" + { + source = kmeans_cluster; + threshold = 0.75; + similarity_measure = "cosine"; + } + } diff --git a/centrallix-sysdoc/OSDriver_Authoring.md b/centrallix-sysdoc/OSDriver_Authoring.md index c167fce26..5755d15c5 100644 --- a/centrallix-sysdoc/OSDriver_Authoring.md +++ b/centrallix-sysdoc/OSDriver_Authoring.md @@ -166,9 +166,11 @@ Within the initialization function, the driver should initialize all necessary g To register with the OSML, the driver must first allocate an ObjDriver structure and fill in its contents. +```c pObjDriver drv; drv = (pObjDriver)nmMalloc(sizeof(ObjDriver)); +``` This involves setting a large number of fields to the appropriate entry points within the OS Driver, as well as telling the OSML what object type(s) are handled by the driver and giving the OSML a description of the driver. A list of the required entry point functions / fields follows: @@ -208,14 +210,17 @@ Another field in the driver structure is the Capabilities field. This field is a The 'Name' field should be filled in with a description of the OS driver, with a maximum length of 63 characters (plus the string null terminator). Normally, the 2-4 letter prefix of the driver is included at the beginning of 'Name', such as "UXD - UNIX filesystem driver". Finally, the 'RootContentTypes' field is an XArray containing a list of strings, each of which specifies the node object types that the driver will handle. Such types are added to this XArray using the normal XArray utility functions, such as: - +```c xaInit(&drv->RootContentTypes, 16); xaAddItem(&drv->RootContentTypes, "system/file"); xaAddItem(&drv->RootContentTypes, "system/directory"); +``` When the structure has been filled out, the os driver should call the OSML to register itself, using the objRegisterDriver function: +```c objRegisterDriver(drv); +``` The initialization function should return 0 to indicate success, or -1 on failure. Currently, initialization success/failure is not verified by lsmain.c. @@ -234,54 +239,58 @@ As an overview, the normal procedure for the open routine to follow is this: The first basic part of the OS driver consists of the Open and Close routines, normally named 'xxxOpen' and 'xxxClose' within the driver, where 'xxx' is the driver's prefix. The Close routine is normally fairly simple, but the Open routine is one of the most complicated routines in a typical OS driver, for the Open routine must parse the subtree pathname beneath the node object. For example, if the node object had a pathname like: +```sh /datasources/OMSS_DB +``` and the user opened an object called: +```sh /datasources/OMSS_DB/JNetHelp/rows/1 +``` the OS driver would have to determine what the subtree pathname 'JNetHelp/rows/1' means, since this path will mean different things to different os drivers. -The Open routine also must determine whether the object already exists or not, and if not, whether to create a new object. This logic is largely dependent on the obj->Mode flags, as if O_CREAT is included, the driver must attempt to create the object if it does not already exist, and if O_EXCL is included, the driver must refuse to open the object if it already exists, as with the UNIX open() system call semantics. +The Open routine also must determine whether the object already exists or not, and if not, whether to create a new object. This logic is largely dependent on the `obj->Mode` flags, as if `O_CREAT` is included, the driver must attempt to create the object if it does not already exist, and if `O_EXCL` is included, the driver must refuse to open the object if it already exists, as with the UNIX `open()` system call semantics. -Finally, if the os driver specified a capability of OBJDRV_C_TRANS, it must pay attention to the current state of the end-user's trans- action. If a new object is being created, an object is being deleted, or other modifications/additions are being performed, and if the OXT layer indicates a transaction is in process, the driver must either complete the current transaction and then complete the current call, or else add the current delete/create/modify call to the transaction tree (in which case the tree item is preallocated; all the driver needs to do is fill it in). The transaction layer will be discussed in depth later in this document. +Finally, if the os driver specified a capability of `OBJDRV_C_TRANS`, it must pay attention to the current state of the end-user's transaction. If a new object is being created, an object is being deleted, or other modifications/additions are being performed, and if the OXT layer indicates a transaction is in process, the driver must either complete the current transaction and then complete the current call, or else add the current delete/create/modify call to the transaction tree (in which case the tree item is preallocated; all the driver needs to do is fill it in). The transaction layer will be discussed in depth later in this document. -As a part of the Open process, the OS driver will normally allocate an internal structure to represent the current open object, and will return that structure as a void* data type in the return value. This pointer will be then passed to each of the other driver entry point functions, with the exception of QueryFetch, QueryDelete, and Query- Close, which will be discussed later. +As a part of the Open process, the OS driver will normally allocate an internal structure to represent the current open object, and will return that structure as a `void*` data type in the return value. This pointer will be then passed to each of the other driver entry point functions, with the exception of QueryFetch, QueryDelete, and Query- Close, which will be discussed later. The Open() routine is called with five parameters: -- obj (pObject) +- `obj` (pObject) This is a pointer to the Object sturcture maintained by the OSML. This structure will contain some important fields for processing the open() request. - obj->Mode is a bitmask of the O_* flags, which include O_RDONLY, O_WRONLY, O_RDWR, O_CREAT, O_TRUNC, and O_EXCL. + - `obj->Mode` is a bitmask of the O_* flags, which include `O_RDONLY`, `O_WRONLY`, `O_RDWR`, `O_CREAT`, `O_TRUNC`, and `O_EXCL`. - obj->Pathname is a Pathname structure which contains the complete parsed pathname for the object. This structure is defined in the file include/obj.h, and has a buffer for the pathname as well as an array of pointers to the pathname's components. The function obj_internal_PathPart() can be used to obtain at will any component or series of components of the pathname. + - `obj->Pathname` is a Pathname structure which contains the complete parsed pathname for the object. This structure is defined in the file `include/obj.h`, and has a buffer for the pathname as well as an array of pointers to the pathname's components. The function `obj_internal_PathPart()` can be used to obtain at will any component or series of components of the pathname. - obj->Pathname->OpenCtl[] contains parameters to the open() operation. Frequently these params provide additional information on how to open the object. The use of these parameters is determined by the author of the objectsystem driver. The parameters are those passed in normal URL fasion (?param=value, etc.). Typically, the only OpenCtl of interest is going to be obj->Pathname->OpenCtl[obj->SubPtr] (see below for SubPtr meaning). + - `obj->Pathname->OpenCtl[]` contains parameters to the open() operation. Frequently these params provide additional information on how to open the object. The use of these parameters is determined by the author of the objectsystem driver. The parameters are those passed in normal URL fasion (?param=value, etc.). Typically, the only OpenCtl of interest is going to be `obj->Pathname->OpenCtl[obj->SubPtr]` (see below for SubPtr meaning). - obj->SubPtr is the number of components in the path that are a part of the node object's path. For example, in the above path of '/datasources/OMSS_DB', the path would be internally represented as './datasources/ OMSS_DB', and the SubPtr would be 3. + - `obj->SubPtr` is the number of components in the path that are a part of the node object's path. For example, in the above path of '/datasources/OMSS_DB', the path would be internally represented as './datasources/ OMSS_DB', and the SubPtr would be 3. - obj->SubCnt reflects the number of components of the path which are under the control of the current driver. This includes the node object, so SubCnt will always be at least 1. For example, when opening '/data/file.csv/rows/1', and the driver in question is the CSV driver, SubPtr would be 3 (includes an "invisible" first component), from '/data/file.csv', and SubCnt would be 3, from 'file.csv/rows/1'. The driver will need to SET THE SUBCNT value in its Open function. SubPtr is already set. + - `obj->SubCnt` reflects the number of components of the path which are under the control of the current driver. This includes the node object, so SubCnt will always be at least 1. For example, when opening '/data/file.csv/rows/1', and the driver in question is the CSV driver, SubPtr would be 3 (includes an "invisible" first component), from '/data/file.csv', and SubCnt would be 3, from 'file.csv/rows/1'. The driver will need to SET THE SUBCNT value in its Open function. SubPtr is already set. - obj->Prev is the underlying object as opened by the next-lower-level driver. It is the duty of this driver to parse the content of that object and do something meaningful with it. + - `obj->Prev` is the underlying object as opened by the next-lower-level driver. It is the duty of this driver to parse the content of that object and do something meaningful with it. - obj->Prev->Flags contains some critical infor- mation about the underlying object. If it contains the flag OBJ_F_CREATED, then the underlying object was just created by this open() operation. In that case, this driver is expected to create the node with snNewNode() (see later in this document) as long as obj->Mode contains O_CREAT. + - `obj->Prev->Flags` contains some critical information about the underlying object. If it contains the flag `OBJ_F_CREATED`, then the underlying object was just created by this open() operation. In that case, this driver is expected to create the node with snNewNode() (see later in this document) as long as obj->Mode contains O_CREAT. -- mask (int) +- `mask` (int) Indicates the security mask to be given to the object if it is being created. Typically, this will only apply to files and directories. The values are the same as UNIX chmod() type values. -- systype (pContentType) +- `systype` (pContentType) This param indicates the content type of the node object as determined by the OSML. The ContentType structure is defined in include/ obj.h, and includes among other things the name of the content type. For example, for the reporting driver, this type would be "system/report". -- usrtype (char*) +- `usrtype` (char*) This param is the requested object type by the user and is normally used when creating a new object, though under some circumstances it may change the way the open operates on an existing object. For example, the reporting driver can change whether it generates HTML report text or plaintext reports based on usrtype being either "text/html" or "text/plain". -- oxt (pObjTrxTree*) +- `oxt` (pObjTrxTree*) This param is only used by object drivers that specified a capability of OBJDRV_C_TRANS. More on this field later. For non-transaction-aware drivers, this field can be safely ignored. Yes, this param *is* a pointer to a pointer. Essentially, a pointer passed by reference. -The Open routine should return its internal structure pointer on success, or NULL on failure. It is normal to allocate one such structure per Open call, and for the structure to point, among other things, to shared data describing the node object. Accessing the node object is described later in this document. +The Open routine should return its internal structure pointer on success, or `NULL` on failure. It is normal to allocate one such structure per Open call, and for the structure to point, among other things, to shared data describing the node object. Accessing the node object is described later in this document. It is important to know what kinds of fields normally are placed in the allocated data structure returned by Open. These fields are all determined by the driver author, but here are a few typical ones that are helpful to have ("inf" is the pointer to the structure here): @@ -307,7 +316,7 @@ Before exiting, the Close routine should make sure it decrements the Open Count ### C. Creating and Deleting Objects. The Create and Delete functions are used for creating and deleting objects. Normally, the os driver will process the Pathname in the same manner for Create and Delete as for Open, thus such functionality could be placed in another function. -As a side note, within Centrallix, the standard function naming convention is to use xxx_internal_FunctionName for functions that are more or less internal to the module and not a part of any standard interface. +As a side note, within Centrallix, the standard function naming convention is to use `xxx_internal_FunctionName()` for functions that are more or less internal to the module and not a part of any standard interface. The Create routine has parameters identical to the Open routine. It should return 0 on success and -1 on error. @@ -349,19 +358,19 @@ The query mechanism can also be used to delete a set of child objects, optionall The first main function for handling queries is OpenQuery. This function is passed three arguments: -- inf_v (void*) The value returned from Open for this object. +- `inf_v` (void*) The value returned from Open for this object. -- query (pObjQuery) The query structure setup by the OSML. It will contain several key fields: +- `query` (pObjQuery) The query structure setup by the OSML. It will contain several key fields: - query->QyText: the text of the criteria (i.e., the WHERE clause, in Centrallix SQL syntax) + - `query->QyText`: the text of the criteria (i.e., the WHERE clause, in Centrallix SQL syntax) - query->Tree: the compiled expression tree, which evaluates to nonzero for true or zero for false as the WHERE clause condition. + - `query->Tree`: the compiled expression tree, which evaluates to nonzero for true or zero for false as the WHERE clause condition. - query->SortBy[]: an array of expressions giving the various components of the sorting criteria. + - `query->SortBy[]`: an array of expressions giving the various components of the sorting criteria. - query->Flags: the driver should set and/or clear the flags OBJ_QY_F_FULLQUERY and OBJ_QY_F_FULLSORT if need be. The former indicates that the driver is willing to handle the full WHERE clause (the query->Tree). The latter indicates that the driver is willing to handle the sorting of the data as well (in query->SortBy[]). If the driver can easily have the sorting/selection done (as when querying an RDBMS), it should set these flags. Otherwise, it should let the OSML take care of the ORDER BY and WHERE conditions. + - `query->Flags`: the driver should set and/or clear the flags `OBJ_QY_F_FULLQUERY` and `OBJ_QY_F_FULLSORT` if need be. The former indicates that the driver is willing to handle the full WHERE clause (the query->Tree). The latter indicates that the driver is willing to handle the sorting of the data as well (in query->SortBy[]). If the driver can easily have the sorting/selection done (as when querying an RDBMS), it should set these flags. Otherwise, it should let the OSML take care of the ORDER BY and WHERE conditions. -- oxt (pObjTrxTree*) The transaction tree pointer. +- `oxt` (pObjTrxTree*) The transaction tree pointer. The OpenQuery function should return a void* value, which will within the driver point to a structure used for managing the query. This structure will normally have a pointer to the inf_v value returned by Open as well, since inf_v is never passed to QueryFetch, QueryDelete or QueryClose. OpenQuery should return NULL if the object does not support queries or if some other error condition occurs that will prevent the execution of the query. @@ -378,6 +387,7 @@ The QueryFetch routine should return an inf_v pointer to the child object, or NU All object drivers will need to add an element to the obj->Pathname structure to indicate the path to the child object being returned. This will involve a process somewhat like this: (given that new_name is the new object's name, qy is the current query structure, which contains a field 'Parent' that points to the inf_v originally returned by Open, and where the inf_v contains a field Obj that points to the Object structure containing a Pathname structure) +```c int cnt; pObject obj; char* new_name; @@ -389,6 +399,7 @@ All object drivers will need to add an element to the obj->Pathname structure to if (cnt < 0 || cnt >= 256) return NULL; obj->Pathname->Elements[obj->Pathname->nElements++] = strrchr(obj->Pathname->Pathbuf,'/')+1; +``` QueryDelete is passed the qy_v void* parameter, and an oxt parameter. It should return 0 on successful deletion, and -1 on failure. @@ -456,22 +467,28 @@ The driver's first course of action to obtain node object data is to open the no ### pSnNode snReadNode(pObject obj) This function reads a Structure File from the already-open node object which is passed in the "obj" parameter in the xxxOpen() routine. The "obj" parameter has an element, obj->Prev, which is a link to the node object as opened by the previous driver in the OSML's chain of drivers for handling this open(). All you need to know to get the parsed node object is the following: +```c pSnNode node; node = snReadNode(obj->Prev); +``` The returned node structure is managed by the SN module and need not be nmFree()ed. The only thing that must be done is that the driver should increment the node structure's link count like this: +```c node->OpenCnt++; +``` When closing an object (and thus releasing a reference to the Node structure), the driver should decrement the link count. ### pSnNode snNewNode(pObject obj, char* content_type) This function creates a new node object with a given content type. The open link count should be incremented as appropriate, as before with snReadNode(). +```c pSnNode node; node = snNewNode(obj->Prev, "system/structure"); +``` The "system/structure" argument is the type that will be assigned to the newly created node object. Note that the underlying object must already exist in order for this to create a node object as that object's content. Normally the OSML does this for you by commanding the previous driver (handling obj->Prev) to create the underlying object in question. @@ -512,6 +529,7 @@ This function adds a node of type ST_T_SUBGROUP to either a ST_T_SUBGROUP or ST_ ### int stAddValue(pStructInf inf, char* strval, int intval) This function adds a value to an attribute, and can be called multiple times on an attribute to add a list of values. If 'strval' is not null, a string value is added, otherwise an integer value is added. The string is NOT copied, but is simply pointed-to. If the string is non-static, and has a lifetime less than the ST_T_ATTRIB tree node, then the following procedure must be used: +```c char* ptr; char* nptr; pStructInf attr_inf; @@ -522,6 +540,7 @@ This function adds a value to an attribute, and can be called multiple times on strcpy(nptr, ptr); stAddValue(attr_inf, nptr, 0); attr_inf->StrAlloc[0] = 1; +``` By following this method (making a copy of the string and then setting the StrAlloc value for that string), when the StructInf tree node is freed by the stparse module, the string will auto- matically be freed as well. @@ -533,6 +552,7 @@ This function returns the value of the given attribute in an ST_T_ATTRIB tree no It is common practice to use the stLookup and stAttrValue functions together to retrieve values, and search for an attribute StructInf and retrieve its value in one operation: +```c pStructInf inf; char* ptr; @@ -540,12 +560,14 @@ It is common practice to use the stLookup and stAttrValue functions together to { printf("%s is the value\n", ptr); } +``` ### int stFreeInf(pStructInf this) This function is used to free a StructInf tree node. It will free any sub-nodes first, so if that is not desired, be sure to disconnect them by removing them from the SubInf array and appropriately adjusting the nSubInf counter, and setting the SubInf array position to NULL. This function also disconnects the tree node from its parent, if any, so if the parent is already free()'d, be sure to set the node's Parent pointer to NULL. Any strings marked allocated with the StrAlloc flags will be free()'d. It is also common practice to bypass the stXxx() functions entirely and access the elements of the StructInf structures themselves. This is not forbidden, and may be done. See the file stparse.h for a description of the structure. For example, +```c pStructInf inf; int i; @@ -556,6 +578,7 @@ It is also common practice to bypass the stXxx() functions entirely and access t /** do stuff with attribute... **/ } } +``` ## IV Memory Management in Centrallix Centrallix has its own memory manager that caches freshly-deallocated blocks of memory in lists according to size so that they can be quickly reallocated. This memory manager also catches double-freeing of blocks, making debugging of memory problems a little easier. @@ -625,6 +648,7 @@ This adds an item to the xarray, and keeps the array sorted. The value for sort #### xaFindItem(pXArray this, void* item) This returns the offset into the array's items of the given value. An exact match is required. The array's items are given below: +```c XArray xa; pStructInf inf; int item_id; @@ -639,6 +663,7 @@ This returns the offset into the array's items of the given value. An exact matc item_id = xaFindItem(&xa, inf); inf == xa.Items[item_id]; +``` #### xaRemoveItem(pXArray this, int index) This function removes an item from the xarray at the given index. @@ -682,22 +707,27 @@ Copies the string 'text' into the XString. Like xsConcatenate, except that the #### char* xsStringEnd(pXString this) Returns a pointer to the end of the string. Useful for finding the end of the string without performing: +```c pXString xs; xs->String + strlen(xs->String) +``` since the xs module already knows the string length and does not have to search for the null terminator. Furthermore, since the string can contain nulls, the above statement could produce incorrect results in those situations. The contents of the XString can be easily referenced via: +```c pXString xs; printf("This string is %s\n", xs->String); +``` IMPORTANT NOTE: Do not store pointers to values within the string while you are still adding text to the end of the string. If the string ends up realloc()ing, your pointers will be incorrect. Instead, if data in the middle of the string needs to be pointed to, store offsets from the beginning of the string, not pointers to the string. For example, this is WRONG: +```c pXString xs; char* ptr; @@ -706,9 +736,11 @@ For example, this is WRONG: ptr = xsStringEnd(&xs); xsConcatenate(&xs, "This is the second sentence.", -1); printf("A pointer to the second sentence is '%s'\n", ptr); +``` Instead, use pointer aritmetic and do this: +```c pXString xs; int offset; @@ -717,6 +749,7 @@ Instead, use pointer aritmetic and do this: offset = xsStringEnd(&xs) - xs->String; xsConcatenate(&xs, "This is the second sentence.", -1); printf("A pointer to the second sentence is '%s'\n",xs->String+offset); +``` ### D. Expression (EXP) - Expression Trees @@ -726,7 +759,9 @@ Expressions can be stand-alone expression trees, or they can take parameter obje Expression evaluation results in the top-level expression tree node having the final value of the expression, which may be NULL, and may be an integer, string, datetime, money, or double data type. For example, the final value of +``` :myobject:oneattribute == 'yes' +``` would be integer 1 (true) if the attribute's value is indeed 'yes'. @@ -777,8 +812,10 @@ Frees a parameter object list. #### int expAddParamToList(pParamObjects this, char* name, pObject obj, int flags) Adds a parameter to the parameter object list. The 'obj' pointer may be left NULL during the expCompileExpression state of operation but must be set to a value before expEvalTree is called. Otherwise the attributes that reference that parameter object will result in NULL values in the expression (it's technically not an error). Flags can be EXPR_O_CURRENT if the object is to be marked as the current one, or EXPR_O_PARENT if it is to be marked as the parent object. Current and Parent objects can be referenced in an expression like this: +``` :currentobjattr ::parentobjattr +``` and is thus a shortcut to typing the full object name. @@ -851,15 +888,21 @@ drivers. Most of them are named obj_internal_XxxYyy or similar. #### char* obj_internal_PathPart(pPathname path, int start, int length) The Pathname structure breaks down a pathname into path elements, which are text strings separated by the directory separator '/'. This function takes the given Pathname structure, and returns the number of path elements requested. For instance, if you have a path: +``` /apps/kardia/data/Kardia_DB/p_partner/rows/1 +``` that path would be stored internally in Centrallix as: +``` ./apps/kardia/data/Kardia_DB/p_partner/rows/1 +``` To just return "Kardia_DB/p_partner", you could call: +``` obj_internal_PathPart(pathstruct, 4, 2); +``` Note that return values from obj_internal_PathPart are only valid until the next call to PathPart on the given pathname structure. @@ -886,9 +929,9 @@ This function closes a network connection, and optionally waits up to 'linger_ms ### int fdWrite(pFile filedesc, char* buffer, int length, int offset, int flags) This function writes data to a file descriptor, from a given buffer and length, and to an optional seek offset and with some optional flags. Flags can be the following: -- FD_U_NOBLOCK - If the write can't be performed immediately, don't perform it at all. -- FD_U_SEEK - The 'offset' value is valid. Seek to it before writing. Not valid for network connections. -- FD_U_PACKET - ALL of the data of 'length' in 'buffer' must be written. Normal write() semantics in UNIX state that not all data has to be written, and the number of bytes actually written is returned. Setting this flag makes sure all data is really written before returning. +- `FD_U_NOBLOCK` - If the write can't be performed immediately, don't perform it at all. +- `FD_U_SEEK` - The 'offset' value is valid. Seek to it before writing. Not valid for network connections. +- `FD_U_PACKET` - ALL of the data of 'length' in 'buffer' must be written. Normal write() semantics in UNIX state that not all data has to be written, and the number of bytes actually written is returned. Setting this flag makes sure all data is really written before returning. #### int fdRead(pFile filedesc, char* buffer, int maxlen, int offset, int flags) The complement to the above routine. Takes the same flags as the above routine, except FD_U_PACKET means that all of 'maxlen' bytes must be read before returning. This is good for reading a packet that is known to be exactly 'maxlen' bytes long, but which might be broken up into fragments by the network (TCP/IP has a maximum frame transmission size of about 1450 bytes). diff --git a/centrallix-sysdoc/string_comparison.md b/centrallix-sysdoc/string_comparison.md index 222e3e6d9..dac13d544 100644 --- a/centrallix-sysdoc/string_comparison.md +++ b/centrallix-sysdoc/string_comparison.md @@ -31,9 +31,9 @@ int exp_fn_fuzzy_compare(pExpression tree, pParamObjects objlist, pExpression i0 ``` Returns a value between 0.0 (complete match) and 1.0 (complete difference) between strings a and b, based on the (levenshtein distance) / (max len of input strings). Some alterations to the calculation are as follows: -- matching an empty string against anything returns 0.5. -- a string that only required insertions to become the other string has its (lev_dist)/(strlen) value halved before returning -The parameter max_field_width is required, but not used. +- Matching an empty string against anything returns 0.5. +- A string that only required insertions to become the other string has its `(lev_dist)/(strlen)` value halved before returning. +- The parameter `max_field_width` is required, but not used. ## Cosine Similarity @@ -46,6 +46,7 @@ const char *CHAR_SET ... `CHAR_SET` represents all of the characters that should be considered during the calculation of similarity. `CHAR_SET` can be extended to include additional characters, as necessary. ### Frequency Table + ```c int exp_fn_i_frequency_table(double *table, char *term) ``` @@ -70,6 +71,7 @@ Helper function for similarity(). Creates a TF x IDF vector from a frequency tab The `frequency_table` parameter must have been created using the `exp_fn_i_frequency_table` function above. ### Dot Product + ```c int exp_fn_i_dot_product(double *dot_product, double *r_freq_table1, double *r_freq_table2) ``` @@ -78,6 +80,7 @@ Helper function for similarity(). Calculates the dot product of two relative fre The `dot_product` parameter should be initialized to 0 before calling the function. The table parameters must contain relative frequency tables that are generated from the `exp_fn_i_relative_frequency_table` function. The lengths of both tables must equal the length of `CHAR_SET`. ### Magnitude + ```c int exp_fn_i_magnitude(double *magnitude, double *r_freq_table) ``` @@ -86,6 +89,7 @@ Helper function for similarity(). Calculates the magnitude of a relative frequen The `magnitude` parameter should be initialized to 0 before calling the function. The table parameter must contain a relative frequency table that was generated from the `exp_fn_i_relative_frequency_table` function. The length of the frequency table must equal the length of `CHAR_SET`. ### Similarity + ```c int exp_fn_similarity(pExpression tree, pParamObjects objlist, pExpression i0, pExpression i1, pExpression i2) ``` @@ -95,5 +99,3 @@ Returns a value between 0.0 (completely different) and 1.0 (complete match) refl ### Inverse Document Frequency (IDF) In text mining, the most common metric to use in the cosine similarity function is the [TF x IDF](https://en.wikipedia.org/wiki/Tf%E2%80%93idf) metric. Our approach uses only TF (term frequency). Inverse document frequency calculates a weighting factor for each character. This could increase precision a small amount by weighting characters that appear on many records as less important in distinguishing matches, and weighting characters that appear on only certain records as more important. IDF could be calculated by iterating through the entire partner dataset each time. The current approach uses the relative frequency of each letter used in the English language on [Wikipedia](https://en.wikipedia.org/wiki/Letter_frequency), which may not be consistent with the data in the partner database. - - diff --git a/centrallix/Makefile.in b/centrallix/Makefile.in index 7d2b1e238..0d13843de 100644 --- a/centrallix/Makefile.in +++ b/centrallix/Makefile.in @@ -115,6 +115,7 @@ XOBJDRIVERS=objdrv_ux.o \ objdrv_uxprint.o \ objdrv_qytree.o \ objdrv_qypivot.o \ + objdrv_cluster.o \ objdrv_datafile.o \ objdrv_audio.o \ objdrv_link.o \ @@ -133,6 +134,7 @@ XV3OBJDRIVERS= \ objdrv_uxprint_v3.o \ objdrv_qytree.o \ objdrv_qypivot.o \ + objdrv_cluster.o \ objdrv_query.o \ objdrv_datafile.o \ objdrv_audio.o \ @@ -314,6 +316,7 @@ XEXPRMODS=exp_main.o \ exp_compiler.o \ exp_evaluate.o \ exp_functions.o \ + exp_double_metaphone.o \ exp_generator.o EXPRMODS=$(patsubst %,expression/%,$(XEXPRMODS)) diff --git a/centrallix/centrallix.c b/centrallix/centrallix.c index 6467ab2b7..75e19d12d 100644 --- a/centrallix/centrallix.c +++ b/centrallix/centrallix.c @@ -440,6 +440,7 @@ cxDriverInit() stxInitialize(); /* Structure file driver */ qytInitialize(); /* Query Tree driver */ qypInitialize(); /* Query Pivot driver */ + clusterInitialize(); /* Cluster driver */ qyInitialize(); /* stored query (aka view) driver */ rptInitialize(); /* report writer driver */ uxpInitialize(); /* UNIX printer access driver */ @@ -694,4 +695,3 @@ cxLinkSigningSetup(pStructInf my_config) return 0; } - diff --git a/centrallix/etc/types.cfg b/centrallix/etc/types.cfg index 11ebc3e3e..6cbac5ae6 100644 --- a/centrallix/etc/types.cfg +++ b/centrallix/etc/types.cfg @@ -51,6 +51,7 @@ "system/symbolic-link" "Symbolic Link" lnk "" "text/plain" "text/css" "CSS File" css "" "text/plain" "system/querypivot" "Query Pivot Object" qyp "" "system/structure" +"system/cluster" "Clustering Object" cluster "" "system/structure" "application/json" "JSON data" json "" "text/plain" "text/json" "JSON data" "" "" "application/json" "text/x-json" "JSON data" "" "" "application/json" diff --git a/centrallix/expression/exp_compiler.c b/centrallix/expression/exp_compiler.c index 9455d6676..bcda38f71 100644 --- a/centrallix/expression/exp_compiler.c +++ b/centrallix/expression/exp_compiler.c @@ -1022,8 +1022,8 @@ expCompileExpression(char* text, pParamObjects objlist, int lxflags, int cmpflag /*** expBindExpression - do late binding of an expression tree to an *** object list. 'domain' specifies the requested bind domain, whether - *** runstatic (EXP_F_RUNSTATIC), runserver (EXP_F_RUNSERVER), or runclient - *** (EXP_F_RUNCLIENT). 'domain' can also be -0-, in which case we rebind + *** runstatic (EXPR_F_RUNSTATIC), runserver (EXPR_F_RUNSERVER), or runclient + *** (EXPR_F_RUNCLIENT). 'domain' can also be -0-, in which case we rebind *** a domainless expression. ***/ int @@ -1051,16 +1051,10 @@ expBindExpression(pExpression exp, pParamObjects objlist, int flags) break; } } - if (exp->ObjID == -1) - { - cm |= EXPR_MASK_EXTREF; - } - } - else if (exp->ObjID == -2 || exp->ObjID == -3) - { - if (exp->ObjID == -2) cm |= (1<<(objlist->CurrentID)); - if (exp->ObjID == -3) cm |= (1<<(objlist->ParentID)); + cm |= EXPR_MASK_EXTREF; } + else if (exp->ObjID == EXPR_CTL_CURRENT) cm |= (1<<(objlist->CurrentID)); + else if (exp->ObjID == EXPR_CTL_PARENT) cm |= (1<<(objlist->ParentID)); else if (exp->ObjID >= 0) { cm |= (1<<(exp->ObjID)); @@ -1084,4 +1078,3 @@ expBindExpression(pExpression exp, pParamObjects objlist, int flags) return cm; } - diff --git a/centrallix/expression/exp_double_metaphone.c b/centrallix/expression/exp_double_metaphone.c new file mode 100644 index 000000000..f3d76c49b --- /dev/null +++ b/centrallix/expression/exp_double_metaphone.c @@ -0,0 +1,1517 @@ +/************************************************************************/ +/* Text-DoubleMetaphone */ +/* Centrallix Core */ +/* */ +/* Copyright 2000, Maurice Aubrey . */ +/* All rights reserved. */ +/* */ +/* This code is copied for redistribution with modification, from the */ +/* gitpan/Text-DoubleMetaphone implementation on GitHub (1), which is */ +/* under the following license. */ +/* */ +/* This code is based heavily on the C++ implementation by Lawrence */ +/* Philips and incorporates several bug fixes courtesy of Kevin */ +/* Atkinson . */ +/* */ +/* This module is free software; you may redistribute it and/or */ +/* modify it under the same terms as Perl itself. */ +/* */ +/* A summary of the relevant content from https://dev.perl.org/licenses */ +/* has been included below for the convenience of the reader. This */ +/* was collected and saved on September 5th, 2025 and may not reflect */ +/* current information. For the most up to date information, please use */ +/* the link above. */ +/* */ +/* Perl5 is Copyright © 1993 and later, by Larry Wall and others. */ +/* */ +/* It is free software; you can redistribute it and/or modify it */ +/* under the terms of either: */ +/* */ +/* a) the GNU General Public License (2) as published by the Free */ +/* Software Foundation (3); either version 1 (2), or (at your */ +/* option) any later version (4), or */ +/* */ +/* b) the "Artistic License" (5). */ +/* */ +/* Citations: */ +/* 1: https://github.com/gitpan/Text-meta_double_metaphone */ +/* 2: https://dev.perl.org/licenses/gpl1.html */ +/* 3: http://www.fsf.org */ +/* 4: http://www.fsf.org/licenses/licenses.html#GNUGPL */ +/* 5: https://dev.perl.org/licenses/artistic.html */ +/* */ +/* Centrallix is published under the GNU General Public License, */ +/* satisfying the above requirement. A summary of this is included */ +/* below for the convenience of the reader. */ +/* */ +/* This program is free software; you can redistribute it and/or modify */ +/* it under the terms of the GNU General Public License as published by */ +/* the Free Software Foundation; either version 2 of the License, or */ +/* (at your option) any later version. */ +/* */ +/* This program 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 General Public License for more details. */ +/* */ +/* You should have received a copy of the GNU General Public License */ +/* along with this program; if not, write to the Free Software */ +/* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA */ +/* 02111-1307 USA */ +/* */ +/* A copy of the GNU General Public License has been included in this */ +/* distribution in the file "COPYING". */ +/* */ +/* Module: exp_double_metaphone.c */ +/* Author: Maurice Aubrey */ +/* Description: This module implements a "sounds like" algorithm */ +/* developed by Lawrence Philips which he published */ +/* in the June, 2000 issue of C/C++ Users Journal. */ +/* Double Metaphone is an improved version of Philips' */ +/* original Metaphone algorithm. */ +/************************************************************************/ + +/*** Note to future programmers reading this file (by Israel Fuller): + *** + *** This file was copied from a GitHub Repo with proper licensing (in case + *** you didn't read the legal stuff above), so feel free to check it out. + *** + *** As for this code, I've modified it to use styling and memory allocation + *** consistent with the rest of the Centrallix codebase. Also, I have added + *** documentation comments and extensive test cases (at the end of the file), + *** however, these reflect my own (possibly incorrect) understanding, which + *** might not line up with the original author. + *** + *** To be honest, though, trying to make this code as readable as possible + *** was very challanging due to all the messy boolean algebra. If there is + *** ever a professional linguist reading this, please factor out some of the + *** logic into local variables with descriptive names so that the rest of us + *** can read this code without our eyes glazing over. + *** + *** If you have any questions, please feel free to reach out to me or Greg. + *** + *** Original Source: https://github.com/gitpan/Text-meta_double_metaphone + ***/ + +#include +#include +#include +#include +#include +#include + +/*** If running in a testing environment, newmalloc is not + *** available, so we fall back to default C memory allocation. + ***/ +#ifndef TESTING +#include "cxlib/newmalloc.h" +#define META_MALLOC(size) nmSysMalloc(size) +#define META_REALLOC(ptr, size) nmSysRealloc(ptr, size) +#define META_FREE(ptr) nmSysFree(ptr) +#else +#include +#define META_MALLOC(size) malloc(size) +#define META_REALLOC(ptr, size) realloc(ptr, size) +#define META_FREE(ptr) free(ptr) +#endif + +/*** Helper function to handle checking for failed memory allocation + *** Author: Israel Fuller. + *** + *** @param ptr Pointer to the memory that should be allocated. + *** @param fname The name of the function invoked to allocate memory. + *** @param size The amount of memory being allocated. + *** @returns The pointer, for chaining. + ***/ +void* meta_check_allocation(void* ptr, const char* fname, const size_t size) + { + if (ptr == NULL) + { + /** Create the most descriptive error message we can. **/ + char error_buf[BUFSIZ]; + snprintf(error_buf, sizeof(error_buf), "exp_double_metaphone.c: Fail - %s(%lu)", fname, size); + perror(error_buf); + + // Throw error for easier locating in a debugger. + fprintf(stderr, "Program will now crash.\n"); + assert(0); + } + return ptr; + } + +/** Malloc shortcut macros. **/ +#define SAFE_MALLOC(size) \ + ({ \ + const size_t sz = (size); \ + memset(meta_check_allocation(META_MALLOC(sz), "META_MALLOC", sz), 0, sz); \ + }) +#define SAFE_REALLOC(ptr, size) \ + ({ \ + const size_t sz = (size); \ + meta_check_allocation(META_REALLOC(ptr, sz), "META_REALLOC", sz); \ + }) + +typedef struct + { + char* str; + size_t length; + size_t bufsize; + int free_str_on_destroy; + } +MetaString; + +/*** Allocates a new MetaString. + *** + *** @param init_str The initial size of the string. + *** @returns The new MetaString. + ***/ +MetaString* meta_new_string(const char* init_str) + { + MetaString *s; + char empty_string[] = ""; + + s = (MetaString*)SAFE_MALLOC(sizeof(MetaString)); + + if (init_str == NULL) + init_str = empty_string; + + s->length = strlen(init_str); + /** Preallocate a bit more for potential growth. **/ + s->bufsize = s->length + 7u; + + s->str = (char*)SAFE_MALLOC(s->bufsize * sizeof(char)); + + strncpy(s->str, init_str, s->length + 1); + s->free_str_on_destroy = 1; + + return s; + } + +/*** Frees a MetaString. + *** + *** @param s The MetaString. + ***/ +void meta_destroy_string(MetaString* s) + { + if (s == NULL) + return; + + if (s->free_str_on_destroy && s->str != NULL) + META_FREE(s->str); + + META_FREE(s); + } + +/*** Increases a MetaString's buffer size. + *** + *** @param s The MetaString* being modified. + *** @param chars_needed Minimumn number of characters to increase buffer size. + ***/ +void meta_increase_buffer(MetaString* s, const size_t chars_needed) + { + s->bufsize += chars_needed + 8u; + s->str = SAFE_REALLOC(s->str, s->bufsize * sizeof(char)); + } + +/*** Convert all characters of a MetaString to uppercase. + *** + *** @param s The MetaString being modified. + ***/ +void meta_make_upper(MetaString* s) + { + for (char* i = s->str; i[0] != '\0'; i++) + *i = (char)toupper(*i); + } + +/*** @param s The MetaString being checked. + *** @param pos The character location to check within the MetaString. + *** @returns 1 if the location is out of bounds for the MetaString, + *** 0 otherwise. + ***/ +bool meta_is_out_of_bounds(MetaString* s, unsigned int pos) + { + return (s->length <= pos); + } + +/*** Checks if a character in a MetaString is a vowel. + *** + *** @param s The MetaString being checked. + *** @param pos The character location to check within the MetaString. + ***/ +bool meta_is_vowel(MetaString* s, unsigned int pos) + { + if (meta_is_out_of_bounds(s, pos)) return 0; + + const char c = *(s->str + pos); + return ((c == 'A') || (c == 'E') || (c == 'I') || + (c == 'O') || (c == 'U') || (c == 'Y')); + } + +/*** Search a MetaString for "W", "K", "CZ", or "WITZ", which indicate that the + *** string is Slavo Germanic. + *** + *** @param s The MetaString to be searched. + *** @returns 1 if the MetaString is Slavo Germanic, or 0 otherwise. + ***/ +bool meta_is_slavo_germanic(MetaString* s) + { + return (strstr(s->str, "W") != NULL) + || (strstr(s->str, "K") != NULL) + || (strstr(s->str, "CZ") != NULL) + || (strstr(s->str, "WITZ") != NULL); + } + +/*** @param s The MetaString being checked. + *** @param pos The character location to check within the MetaString. + *** @returns The character at the position in the MetaString, or + *** '\0' if the position is not in the MetaString. + ***/ +char meta_get_char_at(MetaString* s, unsigned int pos) + { + return (meta_is_out_of_bounds(s, pos)) ? '\0' : ((char) *(s->str + pos)); + } + +/*** Checks for to see if any of a list of strings appear in a the given + *** MetaString after the given start position. + *** + *** @attention - Note that the START value is 0 based. + *** + *** @param s The MetaString being modified. + *** @param start The zero-based start of at which to begin searching + *** within the MetaString. + *** @param length The length of the character strings being checked. + *** @returns 1 if any of the character sequences appear after the start + *** in the MetaString and 0 otherwise. + ***/ +bool meta_is_str_at(MetaString* s, unsigned int start, ...) + { + va_list ap; + + /** Should never happen. **/ + if (meta_is_out_of_bounds(s, start)) + return 0; + + const char* pos = (s->str + start); + va_start(ap, start); + + char* test; + do + { + test = va_arg(ap, char*); + if (*test && (strncmp(pos, test, strlen(test)) == 0)) + return true; + } + while (test[0] != '\0'); + + va_end(ap); + + return false; + } + +/*** Adds a string to a MetaString, expanding the MetaString if needed. + *** + *** @param s The MetaString being modified. + *** @param new_str The string being added. + ***/ +void meta_add_str(MetaString* s, const char* new_str) + { + if (new_str == NULL) + return; + + const size_t add_length = strlen(new_str); + if ((s->length + add_length) > (s->bufsize - 1)) + meta_increase_buffer(s, add_length); + + strcat(s->str, new_str); + s->length += add_length; + } + +/*** Computes double metaphone. + *** + *** Example Usage: + *** ```c + *** char* primary_code; + *** char* secondary_code; + *** meta_double_metaphone(input, &primary_code, &secondary_code); + *** ``` + *** + *** @param str The string to compute. + *** @param primary_code A pointer to a buffer where the pointer to a string + *** containing the produced primary code will be stored. + *** @param secondary_code A pointer to a buffer where the pointer to a string + *** containing the produced secondary code will be stored. + ***/ +void meta_double_metaphone(const char* str, char** primary_code, char** secondary_code) + { + size_t length; + if (str == NULL || (length = strlen(str)) == 0u) { + fprintf(stderr, "Warning: Call to meta_double_metaphone() with invalid string.\n"); + + /** Double Metaphone on an invalid string yeilds two empty strings. **/ + *primary_code = (char*)SAFE_MALLOC(sizeof(char)); + *secondary_code = (char*)SAFE_MALLOC(sizeof(char)); + return; + } + unsigned int current = 0; + unsigned int last = (unsigned int)(length - 1); + + /** Pad original so we can index beyond end. **/ + MetaString* original = meta_new_string(str); + meta_make_upper(original); + meta_add_str(original, " "); + + MetaString* primary = meta_new_string(""); + MetaString* secondary = meta_new_string(""); + primary->free_str_on_destroy = 0; + secondary->free_str_on_destroy = 0; + + /** Skip these if they are at start of a word. **/ + if (meta_is_str_at(original, 0, "GN", "KN", "PN", "WR", "PS", "")) + current += 1; + + /** Initial 'X' is pronounced 'Z' e.g. 'Xavier' **/ + const char first_char = meta_get_char_at(original, 0); + if (first_char == 'X') + { + meta_add_str(primary, "S"); /* 'Z' maps to 'S' */ + meta_add_str(secondary, "S"); + current += 1; + } + + /** Precomputing this is useful. **/ + const bool is_slavo_germanic = meta_is_slavo_germanic(original); + + /** Main loop. **/ + while (current < length) + { + const char cur_char = meta_get_char_at(original, current); + const char next_char = meta_get_char_at(original, current + 1); + switch (cur_char) + { + case 'A': + case 'E': + case 'I': + case 'O': + case 'U': + case 'Y': + { + if (current == 0) + { + /** All init vowels now map to 'A'. **/ + meta_add_str(primary, "A"); + meta_add_str(secondary, "A"); + } + current += 1; + break; + } + + case 'B': + { + /** "-mb", e.g", "dumb", already skipped over... **/ + meta_add_str(primary, "P"); + meta_add_str(secondary, "P"); + + current += (next_char == 'B') ? 2 : 1; + break; + } + + case 'C': + { + /** Various germanic. **/ + if ( + (current > 1) + && !meta_is_vowel(original, current - 2) + && meta_is_str_at(original, (current - 1), "ACH", "") + && meta_get_char_at(original, current + 2) != 'I' + && ( + meta_get_char_at(original, current + 2) != 'E' + || meta_is_str_at(original, (current - 2), "BACHER", "MACHER", "") + ) + ) + { + meta_add_str(primary, "K"); + meta_add_str(secondary, "K"); + current += 2; + break; + } + + /** Special case 'caesar' **/ + if (current == 0 && meta_is_str_at(original, current, "CAESAR", "")) + { + meta_add_str(primary, "S"); + meta_add_str(secondary, "S"); + current += 2; + break; + } + + /** Italian 'chianti' **/ + if (meta_is_str_at(original, current, "CHIA", "")) + { + meta_add_str(primary, "K"); + meta_add_str(secondary, "K"); + current += 2; + break; + } + + if (meta_is_str_at(original, current, "CH", "")) + { + /** Find 'michael' **/ + if (current > 0 && meta_is_str_at(original, current, "CHAE", "")) + { + meta_add_str(primary, "K"); + meta_add_str(secondary, "X"); + current += 2; + break; + } + + /** Greek roots e.g. 'chemistry', 'chorus' **/ + if ( + current == 0 + && meta_is_str_at(original, (current + 1), "HOR", "HYM", "HIA", "HEM", "HARAC", "HARIS", "") + && !meta_is_str_at(original, 0, "CHORE", "") + ) + { + meta_add_str(primary, "K"); + meta_add_str(secondary, "K"); + current += 2; + break; + } + + /** Germanic, greek, or otherwise 'ch' for 'kh' sound. */ + if ( + meta_is_str_at(original, 0, "SCH", "VAN ", "VON ", "") + /** 'architect but not 'arch', 'orchestra', 'orchid' **/ + || meta_is_str_at(original, (current - 2), "ORCHES", "ARCHIT", "ORCHID", "") + || meta_is_str_at(original, (current + 2), "T", "S", "") + || ( + (current == 0 || meta_is_str_at(original, (current - 1), "A", "O", "U", "E", "")) + /** e.g., 'wachtler', 'wechsler', but not 'tichner' **/ + && meta_is_str_at(original, (current + 2), "L", "R", "N", "M", "B", "H", "F", "V", "W", " ", "") + ) + ) + { + meta_add_str(primary, "K"); + meta_add_str(secondary, "K"); + } + else + { + if (current > 0) + { + if (meta_is_str_at(original, 0, "MC", "")) + { + /* e.g., "McHugh" */ + meta_add_str(primary, "K"); + meta_add_str(secondary, "K"); + } + else + { + meta_add_str(primary, "X"); + meta_add_str(secondary, "K"); + } + } + else + { + meta_add_str(primary, "X"); + meta_add_str(secondary, "X"); + } + } + current += 2; + break; + } + + /** e.g, 'czerny' **/ + if (meta_is_str_at(original, current, "CZ", "") + && !meta_is_str_at(original, (current - 2), "WICZ", "")) + { + meta_add_str(primary, "S"); + meta_add_str(secondary, "X"); + current += 2; + break; + } + + /** e.g., 'focaccia' **/ + if (meta_is_str_at(original, (current + 1), "CIA", "")) + { + meta_add_str(primary, "X"); + meta_add_str(secondary, "X"); + current += 3; + break; + } + + /** Double 'C' rule. **/ + if ( + meta_is_str_at(original, current, "CC", "") + && !(current == 1 && first_char == 'M') /* McClellan exception. */ + ) + { + /** 'bellocchio' but not 'bacchus' **/ + if ( + meta_is_str_at(original, (current + 2), "I", "E", "H", "") + && !meta_is_str_at(original, (current + 2), "HU", "") + ) + { + /** 'accident', 'accede' 'succeed' **/ + if ( + (current == 1 && meta_get_char_at(original, current - 1) == 'A') + || meta_is_str_at(original, (current - 1), "UCCEE", "UCCES", "") + ) + { + meta_add_str(primary, "KS"); + meta_add_str(secondary, "KS"); + /** 'bacci', 'bertucci', other italian **/ + } + else + { + meta_add_str(primary, "X"); + meta_add_str(secondary, "X"); + } + current += 3; + break; + } + else + { /** Pierce's rule **/ + meta_add_str(primary, "K"); + meta_add_str(secondary, "K"); + current += 2; + break; + } + } + + if (meta_is_str_at(original, current, "CK", "CG", "CQ", "")) + { + meta_add_str(primary, "K"); + meta_add_str(secondary, "K"); + current += 2; + break; + } + + if (meta_is_str_at(original, current, "CI", "CE", "CY", "")) + { + /* Italian vs. English */ + if (meta_is_str_at(original, current, "CIO", "CIE", "CIA", "")) + { + meta_add_str(primary, "S"); + meta_add_str(secondary, "X"); + } + else + { + meta_add_str(primary, "S"); + meta_add_str(secondary, "S"); + } + current += 2; + break; + } + + /** else **/ + meta_add_str(primary, "K"); + meta_add_str(secondary, "K"); + + /** Name sent in 'mac caffrey', 'mac gregor **/ + if (meta_is_str_at(original, (current + 1), " C", " Q", " G", "")) + current += 3; + else if (meta_is_str_at(original, (current + 1), "C", "K", "Q", "") + && !meta_is_str_at(original, (current + 1), "CE", "CI", "")) + current += 2; + else + current += 1; + break; + } + + case 'D': + { + if (meta_is_str_at(original, current, "DG", "")) + { + if (meta_is_str_at(original, (current + 2), "I", "E", "Y", "")) + { + /** e.g. 'edge' **/ + meta_add_str(primary, "J"); + meta_add_str(secondary, "J"); + current += 3; + break; + } + else + { + /** e.g. 'edgar' **/ + meta_add_str(primary, "TK"); + meta_add_str(secondary, "TK"); + current += 2; + break; + } + } + + if (meta_is_str_at(original, current, "DT", "DD", "")) + { + meta_add_str(primary, "T"); + meta_add_str(secondary, "T"); + current += 2; + break; + } + + /** else **/ + meta_add_str(primary, "T"); + meta_add_str(secondary, "T"); + current += 1; + break; + } + + case 'F': + { + current += (next_char == 'F') ? 2 : 1; + meta_add_str(primary, "F"); + meta_add_str(secondary, "F"); + break; + } + + case 'G': + { + if (next_char == 'H') + { + /** 'Vghee' */ + if (current > 0 && !meta_is_vowel(original, (current - 1))) + { + meta_add_str(primary, "K"); + meta_add_str(secondary, "K"); + current += 2; + break; + } + + if (current < 3) + { + /** 'ghislane', 'ghiradelli' **/ + if (current == 0) + { + if (meta_get_char_at(original, (current + 2)) == 'I') + { + meta_add_str(primary, "J"); + meta_add_str(secondary, "J"); + } + else + { + meta_add_str(primary, "K"); + meta_add_str(secondary, "K"); + } + current += 2; + break; + } + } + + if ( + /** Parker's rule (with some further refinements) - e.g., 'hugh' **/ + (current > 1 && meta_is_str_at(original, (current - 2), "B", "H", "D", "")) + /** e.g., 'bough' **/ + || (current > 2 && meta_is_str_at(original, (current - 3), "B", "H", "D", "")) + /** e.g., 'broughton' **/ + || (current > 3 && meta_is_str_at(original, (current - 4), "B", "H", "")) + ) + { + current += 2; + break; + } + else + { + /** e.g., 'laugh', 'McLaughlin', 'cough', 'gough', 'rough', 'tough' **/ + if ( + current > 2 + && meta_get_char_at(original, (current - 1)) == 'U' + && meta_is_str_at(original, (current - 3), "C", "G", "L", "R", "T", "") + ) + { + meta_add_str(primary, "F"); + meta_add_str(secondary, "F"); + } + else if (current > 0 && meta_get_char_at(original, (current - 1)) != 'I') + { + meta_add_str(primary, "K"); + meta_add_str(secondary, "K"); + } + + current += 2; + break; + } + } + + if (next_char == 'N') + { + if (current == 1 && !is_slavo_germanic && meta_is_vowel(original, 0)) + { + meta_add_str(primary, "KN"); + meta_add_str(secondary, "N"); + } + else + /** not e.g. 'cagney' **/ + if ( + next_char != 'Y' + && !is_slavo_germanic + && !meta_is_str_at(original, (current + 2), "EY", "") + ) + { + meta_add_str(primary, "N"); + meta_add_str(secondary, "KN"); + } + else + { + meta_add_str(primary, "KN"); + meta_add_str(secondary, "KN"); + } + current += 2; + break; + } + + /** 'tagliaro' **/ + if ( + !is_slavo_germanic + && meta_is_str_at(original, (current + 1), "LI", "") + ) + { + meta_add_str(primary, "KL"); + meta_add_str(secondary, "L"); + current += 2; + break; + } + + /** -ges-,-gep-,-gel-, -gie- at beginning **/ + if ( + current == 0 + && ( + next_char == 'Y' + || meta_is_str_at( + original, (current + 1), + "ES", "EP", "EB", "EL", "EY", "IB", + "IL", "IN", "IE", "EI", "ER", "" + ) + ) + ) + { + meta_add_str(primary, "K"); + meta_add_str(secondary, "J"); + current += 2; + break; + } + + /** -ger-, -gy- **/ + if ( + (next_char == 'Y' || meta_is_str_at(original, (current + 1), "ER", "")) + /** Exceptions. **/ + && !meta_is_str_at(original, 0, "DANGER", "RANGER", "MANGER", "") + && !meta_is_str_at(original, (current - 1), "E", "I", "RGY", "OGY", "") + ) + { + meta_add_str(primary, "K"); + meta_add_str(secondary, "J"); + current += 2; + break; + } + + /** Italian e.g, 'biaggi' **/ + if ( + meta_is_str_at(original, (current + 1), "E", "I", "Y", "") + || meta_is_str_at(original, (current - 1), "AGGI", "OGGI", "") + ) + { + /** Obvious germanic. **/ + if (meta_is_str_at(original, 0, "SCH", "VAN ", "VON ", "") + || meta_is_str_at(original, (current + 1), "ET", "")) + { + meta_add_str(primary, "K"); + meta_add_str(secondary, "K"); + } + else + { + /** Always soft, if french ending. **/ + if (meta_is_str_at(original, (current + 1), "IER ", "")) + { + meta_add_str(primary, "J"); + meta_add_str(secondary, "J"); + } + else + { + meta_add_str(primary, "J"); + meta_add_str(secondary, "K"); + } + } + current += 2; + break; + } + + current += (next_char == 'G') ? 2 : 1; + meta_add_str(primary, "K"); + meta_add_str(secondary, "K"); + break; + } + + case 'H': + { + /** Only keep if first & before vowel or between 2 vowels. **/ + if ( + (current == 0 || meta_is_vowel(original, (current - 1))) + && meta_is_vowel(original, current + 1) + ) + { + meta_add_str(primary, "H"); + meta_add_str(secondary, "H"); + current += 2; + } + else /* also takes care of 'HH' */ + current += 1; + break; + } + + case 'J': + { + /** Obvious spanish, 'jose', 'san jacinto' **/ + const bool has_jose_next = meta_is_str_at(original, current, "JOSE", ""); + const bool starts_with_san = meta_is_str_at(original, 0, "SAN ", ""); + if (has_jose_next || starts_with_san) + { + if ( + starts_with_san + /** I don't know what this condition means. **/ + || (current == 0 && meta_get_char_at(original, current + 4) == ' ') + ) + { + meta_add_str(primary, "H"); + meta_add_str(secondary, "H"); + } + else + { + meta_add_str(primary, "J"); + meta_add_str(secondary, "H"); + } + current += 1; + break; + } + + if (current == 0 && !has_jose_next) + { + meta_add_str(primary, "J"); /* Yankelovich/Jankelowicz */ + meta_add_str(secondary, "A"); + } + else + { + /** spanish pron. of e.g. 'bajador' **/ + if ( + !is_slavo_germanic + && (next_char == 'A' || next_char == 'O') + && meta_is_vowel(original, (current - 1)) + ) + { + meta_add_str(primary, "J"); + meta_add_str(secondary, "H"); + } + else + { + if (current == last) + { + meta_add_str(primary, "J"); + meta_add_str(secondary, ""); + } + else + { + if ( + !meta_is_str_at(original, (current + 1), "L", "T", "K", "S", "N", "M", "B", "Z", "") + && !meta_is_str_at(original, (current - 1), "S", "K", "L", "") + ) + { + meta_add_str(primary, "J"); + meta_add_str(secondary, "J"); + } + } + } + } + + current += (next_char == 'J') ? 2 : 1; + break; + } + + case 'K': + { + current += (next_char == 'K') ? 2 : 1; + meta_add_str(primary, "K"); + meta_add_str(secondary, "K"); + break; + } + + case 'L': + { + if (next_char == 'L') + { + /** Spanish e.g. 'cabrillo', 'gallegos' **/ + if ( + ( + current == length - 3 + && meta_is_str_at(original, (current - 1), "ILLO", "ILLA", "ALLE", "") + ) + || ( + meta_is_str_at(original, (current - 1), "ALLE", "") + && ( + meta_is_str_at(original, (last - 1), "AS", "OS", "") + || meta_is_str_at(original, last, "A", "O", "") + ) + ) + ) + { + meta_add_str(primary, "L"); + meta_add_str(secondary, ""); + current += 2; + break; + } + current += 2; + } + else + current += 1; + meta_add_str(primary, "L"); + meta_add_str(secondary, "L"); + break; + } + + case 'M': + { + current += ( + ( + meta_is_str_at(original, (current - 1), "UMB", "") + && (current + 1 == last || meta_is_str_at(original, (current + 2), "ER", "")) + ) + /** 'dumb','thumb' **/ + || next_char == 'M' + ) ? 2 : 1; + meta_add_str(primary, "M"); + meta_add_str(secondary, "M"); + break; + } + + case 'N': + { + current += (next_char == 'N') ? 2 : 1; + meta_add_str(primary, "N"); + meta_add_str(secondary, "N"); + break; + } + + case 'P': + { + if (next_char == 'H') + { + meta_add_str(primary, "F"); + meta_add_str(secondary, "F"); + current += 2; + break; + } + + /** Also account for "campbell", "raspberry" **/ + current += (meta_is_str_at(original, (current + 1), "P", "B", "")) ? 2 : 1; + meta_add_str(primary, "P"); + meta_add_str(secondary, "P"); + break; + } + + case 'Q': + { + current += (next_char == 'Q') ? 2 : 1; + meta_add_str(primary, "K"); + meta_add_str(secondary, "K"); + break; + } + + case 'R': + { + /** French e.g. 'rogier', but exclude 'hochmeier' **/ + const bool no_primary = ( + !is_slavo_germanic + && current == last + && meta_is_str_at(original, (current - 2), "IE", "") + && !meta_is_str_at(original, (current - 4), "ME", "MA", "") + ); + + meta_add_str(primary, (no_primary) ? "" : "R"); + meta_add_str(secondary, "R"); + current += (next_char == 'R') ? 2 : 1; + break; + } + + case 'S': + { + /** Special cases 'island', 'isle', 'carlisle', 'carlysle' **/ + if (meta_is_str_at(original, (current - 1), "ISL", "YSL", "")) + { + current += 1; + break; + } + + /** Special case 'sugar-' **/ + if (current == 0 && meta_is_str_at(original, current, "SUGAR", "")) + { + meta_add_str(primary, "X"); + meta_add_str(secondary, "S"); + current += 1; + break; + } + + if (meta_is_str_at(original, current, "SH", "")) + { + const bool germanic = meta_is_str_at(original, (current + 1), "HEIM", "HOEK", "HOLM", "HOLZ", ""); + const char* sound = (germanic) ? "S" : "X"; + meta_add_str(primary, sound); + meta_add_str(secondary, sound); + current += 2; + break; + } + + /** Italian & Armenian. **/ + if (meta_is_str_at(original, current, "SIO", "SIA", "SIAN", "")) + { + meta_add_str(primary, "S"); + meta_add_str(secondary, (is_slavo_germanic) ? "S" : "X"); + current += 3; + break; + } + + /** german & anglicisations, e.g. 'smith' match 'schmidt', 'snider' match 'schneider' **/ + /** also, -sz- in slavic language altho in hungarian it is pronounced 's' **/ + if (current == 0 && meta_is_str_at(original, (current + 1), "M", "N", "L", "W", "")) + { + meta_add_str(primary, "S"); + meta_add_str(secondary, "X"); + current += 1; + break; + } + if (meta_is_str_at(original, (current + 1), "Z", "")) + { + meta_add_str(primary, "S"); + meta_add_str(secondary, "X"); + current += 2; + break; + } + + if (meta_is_str_at(original, current, "SC", "")) + { + /** Schlesinger's rule. **/ + if (meta_get_char_at(original, current + 2) == 'H') + { + /** Dutch origin, e.g. 'school', 'schooner' **/ + if (meta_is_str_at(original, (current + 3), "OO", "ER", "EN", "UY", "ED", "EM", "")) + { + /** 'schermerhorn', 'schenker' **/ + const bool x_sound = meta_is_str_at(original, (current + 3), "ER", "EN", ""); + meta_add_str(primary, (x_sound) ? "X" : "SK"); + meta_add_str(secondary, "SK"); + current += 3; + break; + } + else + { + const bool s_sound = ( + current == 0 + && !meta_is_vowel(original, 3) + && meta_get_char_at(original, 3) != 'W' + ); + meta_add_str(primary, "X"); + meta_add_str(secondary, (s_sound) ? "S" : "X"); + current += 3; + break; + } + } + + /** Default case. **/ + const char* sound = (meta_is_str_at(original, (current + 2), "E", "I", "Y", "")) ? "S" : "SK"; + meta_add_str(primary, sound); + meta_add_str(secondary, sound); + current += 3; + break; + } + + /** French e.g. 'resnais', 'artois' **/ + const bool no_primary = (current == last && meta_is_str_at(original, (current - 2), "AI", "OI", "")); + meta_add_str(primary, (no_primary) ? "" : "S"); + meta_add_str(secondary, "S"); + current += (meta_is_str_at(original, (current + 1), "S", "Z", "")) ? 2 : 1; + break; + } + + case 'T': + { + if (meta_is_str_at(original, current, "TIA", "TCH", "TION", "")) + { + meta_add_str(primary, "X"); + meta_add_str(secondary, "X"); + current += 3; + break; + } + + if (meta_is_str_at(original, current, "TH", "TTH", "")) + { + /** Special case 'thomas', 'thames' or germanic. **/ + if ( + meta_is_str_at(original, (current + 2), "OM", "AM", "") + || meta_is_str_at(original, 0, "SCH", "VAN ", "VON ", "") + ) + meta_add_str(primary, "T"); + else + meta_add_str(primary, "0"); /* Yes, zero. */ + meta_add_str(secondary, "T"); + current += 2; + break; + } + + meta_add_str(primary, "T"); + meta_add_str(secondary, "T"); + current += (meta_is_str_at(original, (current + 1), "T", "D", "")) ? 2 : 1; + break; + } + + case 'V': + { + meta_add_str(primary, "F"); + meta_add_str(secondary, "F"); + current += (next_char == 'V') ? 2 : 1; + break; + } + + case 'W': + { + /** Can also be in middle of word. **/ + if (meta_is_str_at(original, current, "WR", "")) + { + meta_add_str(primary, "R"); + meta_add_str(secondary, "R"); + current += 2; + break; + } + + const bool next_is_vowel = meta_is_vowel(original, current + 1); + if (current == 0 && (next_is_vowel || meta_is_str_at(original, current, "WH", ""))) + { + /** Wasserman should match Vasserman. **/ + meta_add_str(primary, "A"); + meta_add_str(secondary, (next_is_vowel) ? "F" : "A"); + } + + /** Arnow should match Arnoff. **/ + if ((current == last && meta_is_vowel(original, current - 1)) + || meta_is_str_at(original, (current - 1), "EWSKI", "EWSKY", "OWSKI", "OWSKY", "") + || meta_is_str_at(original, 0, "SCH", "") + ) + { + meta_add_str(primary, ""); + meta_add_str(secondary, "F"); + current += 1; + break; + } + + /** Polish e.g. 'filipowicz' **/ + if (meta_is_str_at(original, current, "WICZ", "WITZ", "")) + { + meta_add_str(primary, "TS"); + meta_add_str(secondary, "FX"); + current += 4; + break; + } + + /** Else skip it. **/ + current += 1; + break; + } + + case 'X': + { + /** French e.g. breaux **/ + const bool silent = ( + current == last + && ( + meta_is_str_at(original, (current - 2), "AU", "OU", "") + || meta_is_str_at(original, (current - 3), "IAU", "EAU", "") + ) + ); + if (!silent) + { + meta_add_str(primary, "KS"); + meta_add_str(secondary, "KS"); + } + + current += (meta_is_str_at(original, (current + 1), "C", "X", "")) ? 2 : 1; + break; + } + + case 'Z': + { + /** Chinese pinyin e.g. 'zhao' **/ + if (next_char == 'H') + { + meta_add_str(primary, "J"); + meta_add_str(secondary, "J"); + current += 2; + break; + } + + const bool has_t_sound = ( + meta_is_str_at(original, (current + 1), "ZO", "ZI", "ZA", "") + || (is_slavo_germanic && current > 0 && meta_get_char_at(original, (current - 1)) != 'T') + ); + meta_add_str(primary, "S"); + meta_add_str(secondary, (has_t_sound) ? "TS" : "S"); + current += (next_char == 'Z') ? 2 : 1; + break; + } + + default: + current += 1; + } + } + + *primary_code = primary->str; + *secondary_code = secondary->str; + + meta_destroy_string(original); + meta_destroy_string(primary); + meta_destroy_string(secondary); + } + +#ifdef TESTING +/*** Built in test cases. + *** + *** These tests have been integrated into the Centrallix testing environment, + *** where they can be run using `export TONLY=expfn_double_metaphone_00`, + *** followed by make test, in the Centrallix directory. + *** + *** The can also be run here by executing the following commands in the + *** centrallix/expression directory, which aditionally generates a coverage + *** report. These tests cover all parts of the double metaphone algorithm, + *** although some of the error cases in various helper functions (such as + *** meta_destroy_string(null)) are not covered by testing. + *** + *** Commands: + *** gcc exp_double_metaphone.c -o exp_double_metaphone.o -I .. -DTESTING -fprofile-arcs -ftest-coverage -O0 + *** ./exp_double_metaphone.o + *** gcov exp_double_metaphone.c + ***/ + +unsigned int num_tests_passed = 0u, num_tests_failed = 0u; + +void test(const char* input, const char* expected_primary, const char* expected_secondary) { + char* codes[2]; + + /** Run DoubleMetaphone() and extract results. **/ + char* actual_primary; + char* actual_secondary; + meta_double_metaphone( + input, + memset(&actual_primary, 0, sizeof(actual_primary)), + memset(&actual_secondary, 0, sizeof(actual_secondary)) + ); + + /** Test for correct value. **/ + if (!strcmp(expected_primary, actual_primary) && + !strcmp(expected_secondary, actual_secondary)) + num_tests_passed++; + else + { + printf( + "\nTEST FAILED: \"%s\"\n" + "Expected: %s %s\n" + "Actual: %s %s\n", + input, + expected_primary, expected_secondary, + actual_primary, actual_secondary + ); + num_tests_failed++; + } + } + +// Special thanks to the following websites for double checking the correct results: +// 1: https://words.github.io/double-metaphone +// 2: https://mainegenealogy.net/metaphone_converter.asp +// 3: https://en.toolpage.org/tool/metaphone +void run_tests(void) { + printf("\nRunning tests...\n"); + + /** Test that always fails. **/ + // test("This", "test", "fails."); + + /** Invalid string tests, by Israel. **/ + fprintf(stderr, "There should be two warnings after this line.\n"); + test(NULL, "", ""); + test("", "", ""); + + /** Basic tests, by Israel. **/ + test("Test", "TST", "TST"); + test("Basic", "PSK", "PSK"); + test("Centrallix", "SNTRLKS", "SNTRLKS"); + test("Lawrence", "LRNS", "LRNS"); + test("Philips", "FLPS", "FLPS"); + test("Acceptingness", "AKSPTNNS", "AKSPTNKNS"); + test("Supercalifragilisticexpialidocious", "SPRKLFRJLSTSKSPLTSS", "SPRKLFRKLSTSKSPLTXS"); + test("Suoicodilaipxecitsiligarfilacrepus", "SKTLPKSSTSLKRFLKRPS", "SKTLPKSSTSLKRFLKRPS"); + + /** Match tests from code comments above. **/ + test("Smith", "SM0", "XMT"); + test("Schmidt", "XMT", "SMT"); + test("Snider", "SNTR", "XNTR"); + test("Schneider", "XNTR", "SNTR"); + test("Arnow", "ARN", "ARNF"); + test("Arnoff", "ARNF", "ARNF"); + + /** Tests from examples in code comments above. **/ + test("Accede", "AKST", "AKST"); + test("Accident", "AKSTNT", "AKSTNT"); + test("Actually", "AKTL", "AKTL"); + test("Arch", "ARX", "ARK"); + test("Artois", "ART", "ARTS"); + test("Bacchus", "PKS", "PKS"); + test("Bacci", "PX", "PX"); + test("Bajador", "PJTR", "PHTR"); + test("Bellocchio", "PLX", "PLX"); + test("Bertucci", "PRTX", "PRTX"); + test("Biaggi", "PJ", "PK"); + test("Bough", "P", "P"); + test("Breaux", "PR", "PR"); + test("Broughton", "PRTN", "PRTN"); + test("Cabrillo", "KPRL", "KPR"); + test("Caesar", "SSR", "SSR"); + test("Cagney", "KKN", "KKN"); + test("Campbell", "KMPL", "KMPL"); + test("Carlisle", "KRLL", "KRLL"); + test("Carlysle", "KRLL", "KRLL"); + test("Chemistry", "KMSTR", "KMSTR"); + test("Chianti", "KNT", "KNT"); + test("Chorus", "KRS", "KRS"); + test("Cough", "KF", "KF"); + test("Czerny", "SRN", "XRN"); + test("Dumb", "TM", "TM"); + test("Edgar", "ATKR", "ATKR"); + test("Edge", "AJ", "AJ"); + test("Filipowicz", "FLPTS", "FLPFX"); + test("Focaccia", "FKX", "FKX"); + test("Gallegos", "KLKS", "KKS"); + test("Germanic", "KRMNK", "JRMNK"); + test("Ghiradelli", "JRTL", "JRTL"); + test("Ghislane", "JLN", "JLN"); + test("Gospel", "KSPL", "KSPL"); + test("Gough", "KF", "KF"); + test("Greek", "KRK", "KRK"); + test("Hochmeier", "HKMR", "HKMR"); + test("Hugh", "H", "H"); + test("Island", "ALNT", "ALNT"); + test("Isle", "AL", "AL"); + test("Italian", "ATLN", "ATLN"); + test("Jankelowicz", "JNKLTS", "ANKLFX"); + test("Jose", "HS", "HS"); + test("Laugh", "LF", "LF"); + test("Mac Caffrey", "MKFR", "MKFR"); + test("Mac Gregor", "MKRKR", "MKRKR"); + test("Manager", "MNKR", "MNJR"); + test("McHugh", "MK", "MK"); + test("McLaughlin", "MKLFLN", "MKLFLN"); + test("Michael", "MKL", "MXL"); + test("Middle", "MTL", "MTL"); + test("Orchestra", "ARKSTR", "ARKSTR"); + test("Orchid", "ARKT", "ARKT"); + test("Pinyin", "PNN", "PNN"); + test("Raspberry", "RSPR", "RSPR"); + test("Resnais", "RSN", "RSNS"); + test("Rogier", "RJ", "RJR"); + test("Rough", "RF", "RF"); + test("Salvador", "SLFTR", "SLFTR"); + test("San jacinto", "SNHSNT", "SNHSNT"); + test("Schenker", "XNKR", "SKNKR"); + test("Schermerhorn", "XRMRRN", "SKRMRRN"); + test("Schlesinger", "XLSNKR", "SLSNJR"); + test("School", "SKL", "SKL"); + test("Schooner", "SKNR", "SKNR"); + test("Succeed", "SKST", "SKST"); + test("Sugar", "XKR", "SKR"); + test("Sugary", "XKR", "SKR"); + test("Tagliaro", "TKLR", "TLR"); + test("Thames", "TMS", "TMS"); + test("Thomas", "TMS", "TMS"); + test("Thumb", "0M", "TM"); + test("Tichner", "TXNR", "TKNR"); + test("Tough", "TF", "TF"); + test("Vghee", "FK", "FK"); + test("Wachtler", "AKTLR", "FKTLR"); + test("Wechsler", "AKSLR", "FKSLR"); + test("Word", "ART", "FRT"); + test("Xavier", "SF", "SFR"); + test("Yankelovich", "ANKLFX", "ANKLFK"); + test("Zhao", "J", "J"); + + /** Intereesting Edge Case: "McClellan" **/ + /*** Note: Sources (1) and (3) both include a double K ("MKKLLN"), but the + *** original code on GitHub and mainegenealogy.net do not. I chose "MKLLN" + *** to be correct because I personally do not pronounce the second c. + ***/ + test("McClellan", "MKLLN", "MKLLN"); + + /** Maurice Aubrey's Tests. **/ + /** Source: https://github.com/gitpan/Text-DoubleMetaphone/blob/master/t/words.txt **/ + test("maurice", "MRS", "MRS"); + test("aubrey", "APR", "APR"); + test("cambrillo", "KMPRL", "KMPR"); + test("heidi", "HT", "HT"); + test("katherine", "K0RN", "KTRN"); + test("catherine", "K0RN", "KTRN"); + test("richard", "RXRT", "RKRT"); + test("bob", "PP", "PP"); + test("eric", "ARK", "ARK"); + test("geoff", "JF", "KF"); + test("dave", "TF", "TF"); + test("ray", "R", "R"); + test("steven", "STFN", "STFN"); + test("bryce", "PRS", "PRS"); + test("randy", "RNT", "RNT"); + test("bryan", "PRN", "PRN"); + test("brian", "PRN", "PRN"); + test("otto", "AT", "AT"); + test("auto", "AT", "AT"); + + /** GPT-5 Coverage Tests. **/ + /*** GPT-5 mini (Preview) running in GitHub Copilot suggested the words + *** after analizing a generated coverage report, and I (Israel) used + *** them to write the tests below. I kept the AI's reasoning for tests, + *** while removing tests that did not contribute any coverage, but after + *** a few reprompts, the AI started just giving words without reasoning. + *** I guess we were both getting pretty tired. + ***/ + test("Abbott", "APT", "APT"); /* double-B ("BB") handling. */ + test("Back", "PK", "PK"); /* "CK"/"CG"/"CQ" branch. */ + test("Bacher", "PKR", "PKR"); /* matches "...BACHER" / ACH special-case. */ + test("Charles", "XRLS", "XRLS"); /* initial "CH" -> the branch that maps to "X"/"X" at start. */ + test("Ghana", "KN", "KN"); /* initial "GH" special-start handling. */ + test("Gnome", "NM", "NM"); /* "GN" sequence handling. */ + test("Raj", "RJ", "R"); /* J at end (exercise J-last behavior). */ + test("Quentin", "KNTN", "KNTN"); /* Q case (Q -> K mapping). */ + test("Who", "A", "A"); /* "WH" at start handling. */ + test("Shoemaker", "XMKR", "XMKR"); /* "SH" general mapping paths. */ + test("Sian", "SN", "XN"); /* "SIO"/"SIA"/"SIAN" branch. */ + test("Scold", "SKLT", "SKLT"); /* "SC" default / "SK" vs other SC subcases. */ + test("Station", "STXN", "STXN"); /* "TION" -> X mapping. */ + test("Match", "MX", "MX"); /* "TCH"/"TIA" -> X mapping. */ + test("Pizza", "PS", "PTS"); /* double-Z ("ZZ") handling. */ + test("Agnes", "AKNS", "ANS"); /* "GN" at index 1 (GN handling that yields KN / N). */ + test("Science", "SNS", "SNS"); /* "SC" followed by I (SC + I/E/Y branch). */ + test("Van Gogh", "FNKK", "FNKK"); + test("Josef", "JSF", "HSF"); + test("Object", "APJKT", "APJKT"); + test("Sholz", "SLS", "SLS"); + test("Scharf", "XRF", "XRF"); + test("Kasia", "KS", "KS"); + test("Van Geller", "FNKLR", "FNKLR"); + + const unsigned int total_tests = num_tests_passed + num_tests_failed; + printf("\nTests completed!\n"); + printf(" > Failed: %u\n", num_tests_failed); + printf(" > Skipped: %u\n", 0u); /* Implementation removed. */ + printf(" > Passed: %u/%u\n", num_tests_passed, total_tests); +} + +int main(void) { + run_tests(); + return 0; +} + +/** Prevent scope leak. **/ +#undef META_FREE +#undef META_MALLOC +#undef META_REALLOC +#undef SAFE_MALLOC +#undef SAFE_REALLOC + +#endif diff --git a/centrallix/expression/exp_functions.c b/centrallix/expression/exp_functions.c index 6425114db..df55559be 100644 --- a/centrallix/expression/exp_functions.c +++ b/centrallix/expression/exp_functions.c @@ -1,27 +1,3 @@ -#define _GNU_SOURCE -#include -#include -#include -#include -#include -#include -#include -#include -#include "obj.h" -#include "cxlib/mtask.h" -#include "cxlib/xarray.h" -#include "cxlib/xhash.h" -#include "cxlib/mtlexer.h" -#include "expression.h" -#include "cxlib/mtsession.h" -#include "cxss/cxss.h" -#include -#include -#include -#include -#include - - /************************************************************************/ /* Centrallix Application Server System */ /* Centrallix Core */ @@ -65,6 +41,48 @@ /* that issue in exp_evaluate.c */ /************************************************************************/ +#define _GNU_SOURCE +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "cxlib/clusters.h" +#include "cxlib/mtask.h" +#include "cxlib/mtlexer.h" +#include "cxlib/mtsession.h" +#include "cxlib/newmalloc.h" +#include "cxlib/xarray.h" +#include "cxlib/xhash.h" +#include "cxss/cxss.h" +#include "expression.h" +#include "obj.h" + +/** Duplocate detection settings. **/ +// #define SEPARATOR "|" +// #define SEPARATOR_CHAR '|' +// #define DBL_BUF_SIZE 16u +// #define USE_PARALLEL_COMPLETE_SEARCH true +// #define MIN_PARALLEL_COMPLETE_SEARCH 1000 +// #define MAX_COMPLETE_SEARCH 50 * 1000 // Default: 100 * 1000 +// #define KMEANS_IMPROVEMENT_THRESHOLD 0.0002 +#define EXP_NUM_DIMS 251 /* aka. The size of the vector table. */ +const int EXP_VECTOR_TABLE_SIZE = EXP_NUM_DIMS; /* Should probably be removed. */ /****** Evaluator functions follow for expEvalFunction ******/ @@ -1111,7 +1129,7 @@ int exp_fn_reverse(pExpression tree, pParamObjects objlist, pExpression i0, pExp return 0; } - +/** Leading zero trim. */ int exp_fn_lztrim(pExpression tree, pParamObjects objlist, pExpression i0, pExpression i1, pExpression i2) { char* ptr; @@ -1337,6 +1355,7 @@ int exp_fn_ralign(pExpression tree, pParamObjects objlist, pExpression i0, pExpr tree->Alloc = 0; tree->String = tree->Types.StringBuf; } + /** Possible overflow? **/ sprintf(tree->String,"%*.*s",i1->Integer,i1->Integer,i0->String); } return 0; @@ -4119,9 +4138,6 @@ int exp_fn_lev_compare(pExpression tree, pParamObjects objlist, pExpression i0, return 0; } -// This is the size of the vector table. It is also used in calculating the table indices. -const int EXP_VECTOR_TABLE_SIZE = 251; - /* * hash_char_pair * This method creates an vector table index based a given character pair. The characters are represented @@ -4151,6 +4167,8 @@ int exp_fn_i_hash_char_pair(double num1, double num2) * * Returns: * 0 + * + * LINK ../../centrallix-sysdoc/string_comparison.md#exp_fn_i_frequency_table */ int exp_fn_i_frequency_table(unsigned short *table, char *term) { @@ -4233,7 +4251,9 @@ int exp_fn_i_frequency_table(unsigned short *table, char *term) * r_freq_table2 : the second vector (unsigned short) * * Returns: - * 0 + * 0 + * + * LINK ../../centrallix-sysdoc/string_comparison.md#exp_fn_i_dot_product */ int exp_fn_i_dot_product(double *dot_product, unsigned short *r_freq_table1, unsigned short *r_freq_table2) { @@ -4252,6 +4272,8 @@ int exp_fn_i_dot_product(double *dot_product, unsigned short *r_freq_table1, uns * Parameters: * magnitude : the place where the result is stored (double) * r_freq_table : the vector (unsigned short) + * + * LINK ../../centrallix-sysdoc/string_comparison.md#exp_fn_i_magnitude */ int exp_fn_i_magnitude(double *magnitude, unsigned short *r_freq_table) { @@ -4271,13 +4293,15 @@ int exp_fn_i_magnitude(double *magnitude, unsigned short *r_freq_table) * * Parameters: * tree : structure where output is stored - * objlist: + * objlist : unused * i0 : first data entry (pExpression) * i1 : second data entry (pExpression) - * i2 : + * i2 : unused * * Returns: - * 0 + * 0 + * + * LINK ../../centrallix-sysdoc/string_comparison.md#exp_fn_similarity */ int exp_fn_cos_compare(pExpression tree, pParamObjects objlist, pExpression i0, pExpression i1, pExpression i2) { @@ -4343,6 +4367,1722 @@ int exp_fn_cos_compare(pExpression tree, pParamObjects objlist, pExpression i0, return 0; } +// /*** ========================= +// *** DUPE SECTION +// *** By: Israel Fuller +// *** Last Updated: September, 2025 +// *** +// *** This section of the file deals with finding duplocates. +// ***/ + +// /*** @brief Returns the smaller of two values. +// *** +// *** @param a The first value. +// *** @param b The second value. +// *** @return The smaller of the two values. +// *** +// *** @note This macro uses GNU C extensions and is type-safe. +// ***/ +// #define min(a, b) ({ \ +// __typeof__ (a) _a = (a); \ +// __typeof__ (b) _b = (b); \ +// (_a < _b) ? _a : _b; \ +// }) + +// /*** @brief Returns the larger of two values. +// *** +// *** @param a The first value. +// *** @param b The second value. +// *** @return The larger of the two values. +// *** +// *** @note This macro uses GNU C extensions and is type-safe. +// ***/ +// #define max(a, b) ({ \ +// __typeof__ (a) _a = (a); \ +// __typeof__ (b) _b = (b); \ +// (_a > _b) ? _a : _b; \ +// }) + +// /** The character used to create a pair with the first and last characters of a string. **/ +// #define EXP_BOUNDARY_CHAR ('a' - 1) + +// /*** Helpful error handling function. **/ +// void mssErrorf(int clr, char* module, const char* format, ...); + +// /*** Gets the hash, representing a pair of ASCII characters, represented by unsigned ints. +// *** +// *** @param num1 The first character in the pair. +// *** @param num1 The second character in the pair. +// *** @returns The resulting hash. +// ***/ +// unsigned int exp_fn_get_char_pair_hash(const unsigned int num1, const unsigned int num2) +// { +// if (num1 == EXP_BOUNDARY_CHAR && num2 == EXP_BOUNDARY_CHAR) +// { +// mssErrorf(1, "EXP", +// "exp_fn_get_char_pair_hash(%u, %u) - Warning: Pair of boundary characters.", +// num1, num2 +// ); +// } +// const double sum = (num1 * num1 * num1) + (num2 * num2 * num2); +// const double scale = ((double)num1 + 1.0) / ((double)num2 + 1.0); +// const unsigned int hash = (unsigned int)round(sum * scale) - 1u; +// return hash % EXP_NUM_DIMS; +// } + +// /*** Builds a vector using a string. +// *** +// *** Vectors are based on the frequencies of character pairs in the string. +// *** Space characters and punctuation characters (see code for list) are ignored, +// *** and all characters are converted to lowercase. Character 96, which is just +// *** before 'a' in the ASCII table (and maps to '`') is used to make pairs on the +// *** start and end of strings. The only supported characters for the passed char* +// *** are spaces, punctuation, uppercase and lowercase letters, and numbers. +// *** +// *** This results in the following modified ASCII table: +// *** ```csv +// *** #, char, #, char, #, char +// *** 97, a, 109, m, 121, y +// *** 98, b, 110, n, 122, z +// *** 99, c, 111, o, 123, 0 +// *** 100, d, 112, p, 124, 1 +// *** 101, e, 113, q, 125, 2 +// *** 102, f, 114, r, 126, 3 +// *** 103, g, 115, s, 127, 4 +// *** 104, h, 116, t, 128, 5 +// *** 105, i, 117, u, 129, 6 +// *** 106, j, 118, v, 130, 7 +// *** 107, k, 119, w, 131, 8 +// *** 108, l, 120, x, 132, 9 +// *** ``` +// *** Thus, any number from 96 (the start/end character) to 132 ('9') is a valid +// *** input to get_char_pair_hash(). +// *** +// *** After hashing each character pair, we add some number from 1 to 13 to the +// *** coresponding dimention. However, for most names, this results in a lot of +// *** zeros and a FEW positive numbers. Thus, after creating the dense vector, +// *** we convert it to a sparse vector in which a negative number replaces a run +// *** of that many zeros. Consider the following example: +// *** +// *** Dense Vector: `[1,0,0,0,3,0]` +// *** +// *** Sparse Vector: `[1,-3,3,-1]` +// *** +// *** Using these sparse vectors greatly reduces the required memory and gives +// *** aproximately an x5 boost to performance when traversing vectors, at the +// *** cost of more algorithmically complex code. +// *** +// *** @param str The string to be divided into pairs and hashed to make the vector. +// *** @returns The sparse vector built using the hashed character pairs. +// ***/ +// int* build_vector(char* str) { +// /** Allocate space for a dense vector. **/ +// unsigned int dense_vector[EXP_NUM_DIMS] = {0u}; + +// /** j is the former character, i is the latter. **/ +// const unsigned int num_chars = (unsigned int)strlen(str); +// for (unsigned int j = 65535u, i = 0u; i <= num_chars; i++) +// { +// /** isspace: space, \n, \v, \f, \r **/ +// if (isspace(str[i])) continue; + +// /** ispunct: !"#$%&'()*+,-./:;<=>?@[\]^_{|}~ **/ +// if (ispunct(str[i]) && str[i] != EXP_BOUNDARY_CHAR) continue; + +// /*** iscntrl (0-8): SOH, STX, ETX, EOT, ENQ, ACK, BEL, BS +// *** (14-31): SO, SI, DLE, DC1-4, NAK, SYN, ETB, CAN +// *** EM, SUB, ESC, FS, GS, RS, US +// ***/ +// if (iscntrl(str[i]) && i != num_chars) { +// mssErrorf(1, "EXP", +// "build_vector(%s) - Warning: Skipping unknown character #%u.\n", +// str, (unsigned int)str[i] +// ); +// continue; +// } + +// /** First and last character should fall one before 'a' in the ASCII table. **/ +// unsigned int temp1 = (j == 65535u) ? EXP_BOUNDARY_CHAR : (unsigned int)tolower(str[j]); +// unsigned int temp2 = (i == num_chars) ? EXP_BOUNDARY_CHAR : (unsigned int)tolower(str[i]); + +// /** Shift numbers to the end of the lowercase letters. **/ +// if ('0' <= temp1 && temp1 <= '9') temp1 += 75u; +// if ('0' <= temp2 && temp2 <= '9') temp2 += 75u; + +// /** Hash the character pair into an index (dimension). **/ +// /** Note that temp will be between 97 ('a') and 132 ('9'). **/ +// unsigned int dim = exp_fn_get_char_pair_hash(temp1, temp2); + +// /** Increment the dimension of the dense vector by a number from 1 to 13. **/ +// dense_vector[dim] += (temp1 + temp2) % 13u + 1u; + +// j = i; +// } + +// /** Count how much space is needed for a sparse vector. **/ +// bool zero_prev = false; +// size_t size = 0u; +// for (unsigned int dim = 0u; dim < EXP_NUM_DIMS; dim++) +// { +// if (dense_vector[dim] == 0u) +// { +// size += (zero_prev) ? 0u : 1u; +// zero_prev = true; +// } +// else +// { +// size++; +// zero_prev = false; +// } +// } + +// /*** Check compression size. +// *** If this check fails, I doubt anything will break. However, the longest +// *** word I know (supercalifragilisticexpialidocious) has only 35 character +// *** pairs, so it shouldn't reach half this size (and it'd be even shorter +// *** if the hash generates at least one collision). +// *** +// *** Bad vector compression will result in degraded performace and increased +// *** memory usage, and likely also indicates a bug or modified assumption +// *** elsewhere in the code. +// *** +// *** If this warning is ever generated, it's definitely worth investigating. +// ***/ +// const size_t expected_max_size = 64u; +// if (size > expected_max_size) +// { +// mssErrorf(1, "EXP" +// "build_vector(%s) - Warning: Sparse vector larger than expected.\n" +// " > Size: %lu\n" +// " > #Dims: %u\n", +// str, +// size, +// EXP_NUM_DIMS +// ); +// } + +// /** Allocate space for sparse vector. **/ +// const size_t sparse_vector_size = size * sizeof(int); +// int* sparse_vector = (int*)nmSysMalloc(sparse_vector_size); +// if (sparse_vector == NULL) { +// mssErrorf(1, "EXP", +// "build_vector(%s) - nmSysMalloc(%lu) failed.", +// str, sparse_vector_size +// ); +// return NULL; +// } + +// /** Convert the dense vector above to a sparse vector. **/ +// unsigned int j = 0u, sparse_idx = 0u; +// while (j < EXP_NUM_DIMS) +// { +// if (dense_vector[j] == 0u) +// { +// /*** Count and store consecutive zeros, except the first one, +// *** which we already know is zero. +// ***/ +// unsigned int zero_count = 1u; +// j++; +// while (j < EXP_NUM_DIMS && dense_vector[j] == 0u) +// { +// zero_count++; +// j++; +// } +// sparse_vector[sparse_idx++] = (int)-zero_count; +// } +// else +// { +// /** Store the value. **/ +// sparse_vector[sparse_idx++] = (int)dense_vector[j++]; +// } +// } + +// return sparse_vector; +// } + +// /*** Compute the magnitude of a sparsely allocated vector. +// *** +// *** @param vector The vector. +// *** @returns The computed magnitude. +// ***/ +// double exp_fn_magnitude_sparse(const int* vector) +// { +// unsigned int magnitude = 0u; +// for (unsigned int i = 0u, dim = 0u; dim < EXP_NUM_DIMS;) +// { +// const int val = vector[i++]; + +// /** Negative val represents -val 0s in the array, so skip that many values. **/ +// if (val < 0) dim += (unsigned)(-val); + +// /** We have a param_value, so square it and add it to the magnitude. **/ +// else { magnitude += (unsigned)(val * val); dim++; } +// } +// return sqrt((double)magnitude); +// } + +// /*** Compute the magnitude of a densely allocated centroid. +// *** +// *** @param centroid The centroid. +// *** @returns The computed magnitude. +// ***/ +// double exp_fn_magnitude_dense(const double* centroid) +// { +// double magnitude = 0.0; +// for (int i = 0; i < EXP_NUM_DIMS; i++) +// magnitude += centroid[i] * centroid[i]; +// return sqrt(magnitude); +// } + +// /*** Parse a token from a sparsely allocated vector and write the param_value and +// *** number of remaining values to the passed locations. +// *** +// *** @param token The sparse vector token being parsed. +// *** @param remaining The location to save the remaining number of characters. +// *** @param param_value The location to save the param_value of the token. +// ***/ +// void exp_fn_parse_token(const int token, unsigned int* remaining, unsigned int* param_value) { +// if (token < 0) +// { +// /** This run contains -token zeros. **/ +// *remaining = (unsigned)(-token); +// *param_value = 0u; +// } +// else +// { +// /** This run contains one param_value. **/ +// *remaining = 1u; +// *param_value = (unsigned)(token); +// } +// } + +// /*** Calculate the similarity on sparcely allocated vectors. Comparing +// *** any string to an empty string should always return 0.5 (untested). +// *** +// *** @param v1 Sparse vector #1. +// *** @param v2 Sparse vector #2. +// *** @returns Similarity between 0 and 1 where +// *** 1 indicates identical and +// *** 0 indicates completely different. +// ***/ +// double exp_fn_sparse_similarity(const int* v1, const int* v2) +// { +// /** Calculate dot product. **/ +// unsigned int vec1_remaining = 0u, vec2_remaining = 0u; +// unsigned int dim = 0u, i1 = 0u, i2 = 0u, dot_product = 0u; +// while (dim < EXP_NUM_DIMS) +// { +// unsigned int val1 = 0u, val2 = 0u; +// if (vec1_remaining == 0u) exp_fn_parse_token(v1[i1++], &vec1_remaining, &val1); +// if (vec2_remaining == 0u) exp_fn_parse_token(v2[i2++], &vec2_remaining, &val2); + +// /*** Accumulate the dot_product. If either vector is 0 here, +// *** the total is 0 and this statement does nothing. +// ***/ +// dot_product += val1 * val2; + +// /** Consume overlap from both runs. **/ +// unsigned int overlap = min(vec1_remaining, vec2_remaining); +// vec1_remaining -= overlap; +// vec2_remaining -= overlap; +// dim += overlap; +// } + +// /** Optional optimization to speed up nonsimilar vectors. **/ +// if (dot_product == 0u) return 0.0; + +// /** Return the difference score. **/ +// return (double)dot_product / (exp_fn_magnitude_sparse(v1) * exp_fn_magnitude_sparse(v2)); +// } + +// /*** Calculate the difference on sparcely allocated vectors. Comparing +// *** any string to an empty string should always return 0.5 (untested). +// *** +// *** @param v1 Sparse vector #1. +// *** @param v2 Sparse vector #2. +// *** @returns Similarity between 0 and 1 where +// *** 1 indicates completely different and +// *** 0 indicates identical. +// ***/ +// #define exp_fn_sparse_dif(v1, v2) (1.0 - exp_fn_sparse_similarity(v1, v2)) + +// /*** Calculate the similarity between a sparsely allocated vector +// *** and a densely allocated centroid. Comparing any string to an +// *** empty string should always return 0.5 (untested). +// *** +// *** @param v1 Sparse vector #1. +// *** @param c1 Dense centroid #2. +// *** @returns Similarity between 0 and 1 where +// *** 1 indicates identical and +// *** 0 indicates completely different. +// ***/ +// double exp_fn_sparse_similarity_c(const int* v1, const double* c2) +// { +// /** Calculate dot product. **/ +// double dot_product = 0.0; +// for (unsigned int i = 0u, dim = 0u; dim < EXP_NUM_DIMS;) +// { +// const int val = v1[i++]; + +// /** Negative val represents -val 0s in the array, so skip that many values. **/ +// if (val < 0) dim += (unsigned)(-val); + +// /** We have a param_value, so square it and add it to the magnitude. **/ +// else dot_product += (double)val * c2[dim++]; +// } + +// /** Return the difference score. **/ +// return dot_product / (exp_fn_magnitude_sparse(v1) * exp_fn_magnitude_dense(c2)); +// } + +// /*** Calculate the difference between a sparsely allocated vector +// *** and a densely allocated centroid. Comparing any string to an +// *** empty string should always return 0.5 (untested). +// *** +// *** @param v1 Sparse vector #1. +// *** @param c1 Dense centroid #2. +// *** @returns Difference between 0 and 1 where +// *** 1 indicates completely different and +// *** 0 indicates identical. +// ***/ +// #define exp_fn_sparse_dif_c(v1, c2) (1.0 - exp_fn_sparse_similarity_c(v1, c2)) + +// /*** Calculate the average size of all clusters in a set of vectors. +// *** +// *** @param vectors The vectors of the dataset (allocated sparsely). +// *** @param num_vectors The number of vectors in the dataset. +// *** @param labels The clusters to which vectors are assigned. +// *** @param centroids The locations of the centroids (allocated densely). +// *** @param num_clusters The number of centroids (k). +// *** @returns The average cluster size. +// ***/ +// double exp_fn_get_cluster_size( +// int** vectors, +// const unsigned int num_vectors, +// unsigned int* labels, +// double centroids[][EXP_NUM_DIMS], +// const unsigned int num_clusters +// ) +// { +// double cluster_sums[num_clusters]; +// unsigned int cluster_counts[num_clusters]; +// for (unsigned int i = 0u; i < num_clusters; i++) +// cluster_sums[i] = 0.0; +// memset(cluster_counts, 0, sizeof(cluster_counts)); + +// /** Sum the difference from each vector to its cluster centroid. **/ +// for (unsigned int i = 0u; i < num_vectors; i++) +// { +// const unsigned int label = labels[i]; +// cluster_sums[label] += exp_fn_sparse_dif_c(vectors[i], centroids[label]); +// cluster_counts[label]++; +// } + +// /** Add up the average cluster size. **/ +// double cluster_total = 0.0; +// unsigned int num_valid_clusters = 0u; +// for (unsigned int label = 0u; label < num_clusters; label++) +// { +// const unsigned int cluster_count = cluster_counts[label]; +// if (cluster_count == 0u) continue; + +// cluster_total += cluster_sums[label] / cluster_count; +// num_valid_clusters++; +// } + +// /** Return average sizes. **/ +// return cluster_total / num_valid_clusters; +// } + +// /*** Compute the param_value for `k` (number of clusters), given a dataset of with +// *** a size of `n`. +// *** +// *** The following table shows data sizes vs.selected cluster size. In testing, +// *** these numbers tended to givea good balance of accuracy and dulocates detected. +// *** +// *** ```csv +// *** Data Size, Actual +// *** 10k, 12 +// *** 100k, 33 +// *** 1M, 67 +// *** 4M, 93 +// *** ``` +// *** +// *** This function is not intended for datasets smaller than (`n < ~2000`). +// *** These should be handled using complete search. +// *** +// *** LaTeX Notation: \log_{36}\left(n\right)^{3.1}-8 +// *** +// *** @param n The size of the dataset. +// *** @returns k, the number of clusters to use. +// *** +// *** Complexity: `O(1)` +// ***/ +// unsigned int exp_fn_compute_k(const unsigned int n) +// { +// return (unsigned)max(2, pow(log(n) / log(36), 3.2) - 8); +// } + +// /*** Executes the k-means clustering algorithm. Selects NUM_CLUSTERS random +// *** vectors as initial centroids. Then points are assigned to the nearest +// *** centroid, after which centroids are moved to the center of their points. +// *** +// *** @param vectors The vectors to cluster. +// *** @param num_vectors The number of vectors to cluster. +// *** @param labels Stores the final cluster identities of the vectors after +// *** clustering is completed. +// *** @param centroids Stores the locations of the centroids used for the clusters +// *** of the data. +// *** @param iterations The number of iterations that actually executed is stored +// *** here. Leave this NULL if you don't care. +// *** @param max_iter The max number of iterations. +// *** @param num_clusters The number of clusters to generate. +// *** +// *** @attention - Assumes: num_vectors is the length of vectors. +// *** @attention - Assumes: num_clusters is the length of labels. +// *** +// *** @attention - Issue: At larger numbers of clustering iterations, some +// *** clusters have a size of negative infinity. In this implementation, +// *** the bug is mitigated by setting a small number of max iterations, +// *** such as 16 instead of 100. +// *** @attention - Issue: Clusters do not apear to improve much after the first +// *** iteration, which puts the efficacy of the algorithm into question. This +// *** may be due to the uneven density of a typical dataset. However, the +// *** clusters still offer useful information. +// *** +// *** Complexity: +// *** +// *** - `O(kd + k + i*(k + n*(k+d) + kd))` +// *** +// *** - `O(kd + k + ik + ink + ind + ikd)` +// *** +// *** - `O(nk + nd)` +// ***/ +// void exp_fn_kmeans( +// int** vectors, +// const unsigned int num_vectors, +// unsigned int* labels, +// const unsigned int num_clusters, +// const unsigned int max_iter +// ) +// { +// // const size_t centroids_size = num_clusters * sizeof(double*); +// // const size_t centroid_size = EXP_NUM_DIMS * sizeof(double); +// // double** centroids = (double**)nmMalloc(centroids_size); +// // if (centroids == NULL) +// // { +// // fprintf(stderr, "exp_fn_kmeans() - nmMalloc(%u) failed.\n", centroids_size); +// // return; +// // } +// // for (int i = 0; i < num_clusters; i++) +// // { +// // double* centroid = centroids[i] = (double*)nmMalloc(centroid_size); +// // if (centroid == NULL) +// // { +// // fprintf(stderr, "exp_fn_kmeans() - nmMalloc(%u) failed.\n", centroid_size); +// // return; +// // } +// // memset(centroids[i], 0, centroid_size); +// // } +// double centroids[num_clusters][EXP_NUM_DIMS]; +// memset(centroids, 0, sizeof(centroids)); + +// /** Select random vectors to use as the initial centroids. **/ +// srand(time(NULL)); +// for (unsigned int i = 0u; i < num_clusters; i++) +// { +// // Pick a random vector. +// const unsigned int random_index = (unsigned int)rand() % num_vectors; + +// // Sparse copy the vector into a densely allocated centroid. +// double* centroid = centroids[i]; +// const int* vector = vectors[random_index]; +// for (unsigned int i = 0u, dim = 0u; dim < EXP_NUM_DIMS;) +// { +// const int token = vector[i++]; +// if (token > 0) centroid[dim++] = (double)token; +// else for (unsigned int j = 0u; j < -token; j++) centroid[dim++] = 0.0; +// } +// } + +// /** Allocate memory for new centroids. **/ +// double new_centroids[num_clusters][EXP_NUM_DIMS]; + +// /** Main exp_fn_kmeans loop. **/ +// double old_average_cluster_size = 1.0; +// unsigned int cluster_counts[num_clusters]; +// for (unsigned int iter = 0u; iter < max_iter; iter++) +// { +// bool changed = false; + +// /** Reset new centroids. **/ +// for (unsigned int i = 0u; i < num_clusters; i++) +// { +// cluster_counts[i] = 0u; +// for (unsigned int dim = 0; dim < EXP_NUM_DIMS; dim++) +// new_centroids[i][dim] = 0.0; +// } + +// /** Assign each point to the nearest centroid. **/ +// for (unsigned int i = 0u; i < num_vectors; i++) +// { +// const int* vector = vectors[i]; +// double min_dist = DBL_MAX; +// unsigned int best_centroid_label = 0u; + +// // Find nearest centroid. +// for (unsigned int j = 0u; j < num_clusters; j++) +// { +// const double dist = exp_fn_sparse_dif_c(vector, centroids[j]); +// if (dist < min_dist) +// { +// min_dist = dist; +// best_centroid_label = j; +// } +// } + +// /** Update label to new centroid, if necessary. **/ +// if (labels[i] != best_centroid_label) +// { +// labels[i] = best_centroid_label; +// changed = true; +// } + +// /** Accumulate values for new centroid calculation. **/ +// double* best_centroid = new_centroids[best_centroid_label]; +// for (unsigned int i = 0u, dim = 0u; dim < EXP_NUM_DIMS;) +// { +// const int val = vector[i++]; +// if (val < 0) dim += (unsigned)(-val); +// else best_centroid[dim++] += (double)val; +// } +// cluster_counts[best_centroid_label]++; +// } + +// /** Stop if centroids didn't change. **/ +// if (!changed) break; + +// /** Update centroids. **/ +// for (unsigned int i = 0u; i < num_clusters; i++) +// { +// if (cluster_counts[i] == 0u) continue; +// double* centroid = centroids[i]; +// const double* new_centroid = new_centroids[i]; +// const unsigned int cluster_count = cluster_counts[i]; +// for (unsigned int dim = 0u; dim < EXP_NUM_DIMS; dim++) +// centroid[dim] = new_centroid[dim] / cluster_count; +// } + +// /** Print cluster size for debugging. **/ +// const double average_cluster_size = exp_fn_get_cluster_size(vectors, num_vectors, labels, centroids, num_clusters); + +// /** Is there enough improvement? **/ +// const double improvement = old_average_cluster_size - average_cluster_size; +// if (improvement < KMEANS_IMPROVEMENT_THRESHOLD) break; +// old_average_cluster_size = average_cluster_size; +// } + +// // Free unused memory. +// // for (int i = 0; i < num_clusters; i++) { +// // nmFree(centroids[i], centroid_size); +// // } +// // nmFree(centroids, centroids_size); +// } + +// /** Duplocate information. **/ +// typedef struct +// { +// unsigned int id1; +// unsigned int id2; +// double similarity; +// } +// Dup, *pDup; + +// /*** Runs complete search to find duplocates if `num_vectors < MAX_COMPLETE_SEARCH` +// *** and runs a search using k-means clustering on larger amounts of data. +// *** +// *** @param vectors Array of precomputed frequency vectors for all dataset strings. +// *** @param num_vectors The number of vectors to be scanned. +// *** @param dupe_threshold The similarity threshold, below which dups are ignored. +// *** @returns The duplicates in pDup structs. +// ***/ +// pXArray lightning_search(int** vectors, const unsigned int num_vectors, const double dupe_threshold) +// { +// /** Allocate space for dups. **/ +// const size_t guess_size = num_vectors * 2u; +// pXArray dups = xaNew(guess_size); +// if (dups == NULL) +// { +// mssErrorf(1, "EXP", "lightning_search() - xaNew(%lu) failed.", guess_size); +// return NULL; +// } + +// /** Descide which algorithm to use. **/ +// if (num_vectors <= MAX_COMPLETE_SEARCH) +// { /** Do a complete search. **/ +// for (unsigned int i = 0u; i < num_vectors; i++) +// { +// const int* v1 = vectors[i]; +// for (unsigned int j = i + 1u; j < num_vectors; j++) +// { +// const int* v2 = vectors[j]; +// const double similarity = exp_fn_sparse_similarity(v1, v2); +// if (similarity > dupe_threshold) // Dup found! +// { +// Dup* dup = (Dup*)nmMalloc(sizeof(Dup)); +// if (dup == NULL) +// { +// mssErrorf(1, "EXP", "lightning_search() - nmMalloc(%lu) failed.", sizeof(Dup)); +// goto err_free_dups; +// } + +// dup->id1 = i; +// dup->id2 = j; +// dup->similarity = similarity; +// xaAddItem(dups, (void*)dup); +// } +// } +// } +// } +// else +// { /** Do a k-means search. **/ +// /** Define constants for the algorithm. **/ +// const unsigned int max_iter = 64u; /** Hardcode value because idk. **/ +// const unsigned int num_clusters = exp_fn_compute_k(num_vectors); + +// /** Allocate static memory for finding clusters. **/ +// unsigned int labels[num_vectors]; +// memset(labels, 0u, sizeof(labels)); + +// /** Execute kmeans clustering. **/ +// exp_fn_kmeans(vectors, num_vectors, labels, num_clusters, max_iter); + +// /** Find duplocates in clusters. **/ +// for (unsigned int i = 0u; i < num_vectors; i++) +// { +// const int* v1 = vectors[i]; +// const unsigned int label = labels[i]; +// for (unsigned int j = i + 1u; j < num_vectors; j++) +// { +// if (labels[j] != label) continue; +// const int* v2 = vectors[j]; +// const double similarity = exp_fn_sparse_similarity(v1, v2); +// if (similarity > dupe_threshold) /* Dup found! */ +// { +// Dup* dup = (Dup*)nmMalloc(sizeof(Dup)); +// if (dup == NULL) +// { +// mssErrorf(1, "EXP", +// "lightning_search() - nmMalloc(%lu) failed.", +// sizeof(Dup) +// ); +// goto err_free_dups; +// } + +// dup->id1 = i; +// dup->id2 = j; +// dup->similarity = similarity; +// xaAddItem(dups, (void*)dup); +// } +// } +// } +// } + +// /** Done **/ +// return dups; + +// /** Free dups. **/ +// err_free_dups:; +// const size_t num_dups = dups->nItems; +// for (unsigned int i = 0u; i < num_dups; i++) +// { +// nmFree(dups->Items[i], sizeof(Dup)); +// dups->Items[i] = NULL; +// } +// xaDeInit(dups); +// return NULL; +// } + +// /*** Computes Levenshtein distance between two strings. +// *** +// *** @param str1 The first string. +// *** @param str2 The second string. +// *** @param length1 The length of the first string. +// *** @param length1 The length of the first string. +// *** +// *** @attention - Tip: Pass 0 for the length of either string to infer it +// *** using the null terminating character. Thus, strings with no null +// *** terminator are supported if you pass explicit lengths. +// *** +// *** Complexity: O(length1 * length2). +// *** +// *** @see centrallix-sysdoc/string_comparison.md +// ***/ +// unsigned int exp_fn_edit_dist(const char* str1, const char* str2, const size_t str1_length, const size_t str2_length) +// { +// /*** lev_matrix: +// *** For all i and j, d[i][j] will hold the Levenshtein distance between +// *** the first i characters of s and the first j characters of t. +// *** +// *** As they say, no dynamic programming algorithm is complete without a +// *** matrix that you fill out and it has the answer in the final location. +// ***/ +// const size_t str1_len = (str1_length == 0u) ? strlen(str1) : str1_length; +// const size_t str2_len = (str2_length == 0u) ? strlen(str2) : str2_length; +// unsigned int lev_matrix[str1_len + 1][str2_len + 1]; + +// /*** Base case #0: +// *** Transforming an empty string into an empty string has 0 cost. +// ***/ +// lev_matrix[0][0] = 0u; + +// /*** Base case #1: +// *** Any source prefixe can be transformed into an empty string by +// *** dropping each character. +// ***/ +// for (unsigned int i = 1u; i <= str1_len; i++) +// lev_matrix[i][0] = i; + +// /*** Base case #2: +// *** Any target prefixes can be transformed into an empty string by +// *** inserting each character. +// ***/ +// for (unsigned int j = 1u; j <= str2_len; j++) +// lev_matrix[0][j] = j; + +// /** General Case **/ +// for (unsigned int i = 1u; i <= str1_len; i++) +// { +// for (unsigned int j = 1u; j <= str2_len; j++) +// { +// /** Equal characters need no changes. **/ +// if (str1[i - 1] == str2[j - 1]) +// lev_matrix[i][j] = lev_matrix[i - 1][j - 1]; + +// /*** We need to make a change, so use the opereration with the +// *** lowest cost out of delete, insert, replace, or swap. +// ***/ +// else +// { +// unsigned int cost_delete = lev_matrix[i - 1][j] + 1u; +// unsigned int cost_insert = lev_matrix[i][j - 1] + 1u; +// unsigned int cost_replace = lev_matrix[i-1][j-1] + 1u; + +// /** If a swap is possible, calculate the cost. **/ +// bool can_swap = ( +// i > 1 && j > 1 && +// str1[i - 1] == str2[j - 2] && +// str1[i - 2] == str2[j - 1] +// ); +// unsigned int cost_swap = (can_swap) ? lev_matrix[i - 2][j - 2] + 1 : UINT_MAX; + +// // Find the best operation. +// lev_matrix[i][j] = min(min(min(cost_delete, cost_insert), cost_replace), cost_swap); +// } +// } +// } + +// return lev_matrix[str1_len][str2_len]; +// } + +// /*** Runs complete search to find duplocates in phone numbers using the +// *** levenshtein min edit distance algorithm. +// *** +// *** @param dataset An array of characters for all dataset strings. +// *** @param dataset_size The number of phone numbers to be scanned. +// *** @param dupe_threshold The similarity threshold, below which dups are ignored. +// *** @returns The duplicates in pDup structs. +// ***/ +// pXArray phone_search(char dataset[][10u], const unsigned int dataset_size, const double dupe_threshold) +// { +// /** Allocate space for dups. **/ +// const size_t guess_size = dataset_size * 2u; +// pXArray dups = xaNew(guess_size); +// if (dups == NULL) +// { +// mssErrorf(1, "EXP", "phone_search() - xaNew(%lu) failed.", guess_size); +// return NULL; +// } + +// /** Search for dups using edit distance. **/ +// for (unsigned int i = 0u; i < dataset_size; i++) +// { +// const char* v1 = dataset[i]; +// for (unsigned int j = i + 1u; j < dataset_size; j++) +// { +// const char* v2 = dataset[j]; +// const unsigned int dist = exp_fn_edit_dist(v1, v2, 10u, 10u); +// const double similarity = (double)dist / 10.0; +// if (similarity > dupe_threshold) /* Dup found! */ +// { +// Dup* dup = (Dup*)nmMalloc(sizeof(Dup)); +// if (dup == NULL) +// { +// mssErrorf(1, "EXP", "phone_search() - nmMalloc(%lu) failed.", sizeof(Dup)); + +// /** Free data before returning. **/ +// const size_t num_dups = dups->nItems; +// for (unsigned int i = 0u; i < num_dups; i++) +// { +// void* dup = dups->Items[i]; +// nmFree(dup, sizeof(Dup)); +// } +// xaDeInit(dups); +// return NULL; +// } + +// dup->id1 = i; +// dup->id2 = j; +// dup->similarity = similarity; +// xaAddItem(dups, (void*)dup); +// } +// } +// } + +// return dups; +// } + +// /*** Usage: get_dups(, , ) +// *** data is assumed to contain only the following characters: +// *** (Data containing ` or control characters is undefined.) +// *** \n\v\f\r 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghij +// *** klmnopqrstuvwxyz!"#$%&'()*+,-./:;<=>?@[\]^_{|}~ +// ***/ +// int exp_fn_get_dups_general(pExpression tree, pParamObjects objlist, pExpression maybe_dup_threshold, pExpression maybe_out_file_path, pExpression maybe_data, const char* fn_name, bool is_phone_numbers) +// { +// /** Check number of arguments. **/ +// if (!maybe_dup_threshold || !maybe_out_file_path || !maybe_data) +// { +// mssErrorf(1, "EXP", "%s(?) expects 3 parameters.", fn_name); +// return -1; +// } +// const int num_params = tree->Children.nItems; +// if (num_params != 3) +// { +// mssErrorf(1, "EXP", "%s(?) expects 3 parameter, got %d.", fn_name, num_params); +// return -1; +// } + +// /** Magic checks. **/ +// ASSERTMAGIC(tree, MGK_EXPRESSION); +// ASSERTMAGIC(maybe_dup_threshold, MGK_EXPRESSION); +// ASSERTMAGIC(maybe_out_file_path, MGK_EXPRESSION); +// ASSERTMAGIC(maybe_data, MGK_EXPRESSION); + +// /** Check object list. **/ +// if (!objlist) +// { +// mssErrorf(1, "EXP", "%s(\?\?\?) no object list?", fn_name); +// return -1; +// } +// ASSERTMAGIC(objlist->Session, MGK_OBJSESSION); + +// /** Extract dup_threshold. **/ +// if (maybe_dup_threshold->Flags & EXPR_F_NULL) +// { +// mssErrorf(1, "EXP", "%s(NULL, ...) dup_threshold cannot be NULL.", fn_name); +// return -1; +// } +// if (maybe_dup_threshold->DataType != DATA_T_DOUBLE) +// { +// mssErrorf(1, "EXP", "%s(?, ...) dup_threshold must be a doube.", fn_name); +// return -1; +// } +// double dup_threshold = maybe_dup_threshold->Types.Double; +// if (isnan(dup_threshold)) +// { +// mssErrorf(1, "EXP", "%s(NAN, ...) dup_threshold cannot be NAN.", fn_name); +// return -1; +// } +// if (dup_threshold <= 0 || 1 <= dup_threshold) +// { +// mssErrorf(1, "EXP", +// "%s(%lg, ...) dup_threshold must be between 0 and 1 (exclusive).", +// fn_name, dup_threshold +// ); +// return -1; +// } + +// /** Extract output file path. **/ +// if (maybe_out_file_path->Flags & EXPR_F_NULL) +// { +// mssErrorf(1, "EXP", +// "%s(%lg, NULL, ...) out_file_path cannot be NULL.", +// fn_name, dup_threshold +// ); +// return -1; +// } +// if (maybe_out_file_path->DataType != DATA_T_STRING) +// { +// mssErrorf(1, "EXP", +// "%s(%lg, \?\?\?, ...) out_file_path should be a string.", +// fn_name, dup_threshold +// ); +// return -1; +// } +// char* out_file_path = maybe_out_file_path->String; +// if (out_file_path == NULL) +// { +// mssErrorf(1, "EXP", +// "%s(%lg, nothing?, ...) expected string from out_file_path " +// "(of type DataType = DATA_T_STRING), but the String was NULL " +// "or did not exist!", +// fn_name, dup_threshold +// ); +// return -1; +// } +// size_t out_path_len = strlen(out_file_path); +// if (out_path_len == 0u) +// { +// mssErrorf(1, "EXP", +// "%s(%lg, \"%s\", ...) out_file_path cannot be an empty string.", +// fn_name, dup_threshold, out_file_path +// ); +// return -1; +// } +// const size_t max_len = BUFSIZ - 48u; +// if (out_path_len >= max_len) +// { +// mssErrorf(1, "EXP", +// "%s(%lg, \"%s\", ...) out_file_path length (%lu) > max length (%lu).", +// fn_name, dup_threshold, out_file_path, out_path_len, max_len +// ); +// return -1; +// } +// if (strncmp(out_file_path + (out_path_len - 4u), ".csv", 4u) != 0) +// { +// mssErrorf(1, "EXP", +// "%s(%lg, \"%s\", ...) out_file_path must end in .csv, " +// "because the output file is a csv.", +// fn_name, dup_threshold, out_file_path +// ); +// return -1; +// } + +// /** Extract dataset string. **/ +// if (maybe_data->Flags & EXPR_F_NULL) +// { +// mssErrorf(1, "EXP", +// "%s(%lg, \"%s\", NULL) data cannot be NULL.", +// fn_name, dup_threshold, out_file_path +// ); +// return -1; +// } +// if (maybe_data->DataType != DATA_T_STRING) +// { +// mssErrorf(1, "EXP", +// "%s(%lg, \"%s\", \?\?\?) data must be a string.", +// fn_name, dup_threshold, out_file_path +// ); +// return -1; +// } +// char* data = maybe_data->String; +// if (data == NULL) +// { +// mssErrorf(1, "EXP", +// "%s(%lg, \"%s\", \?\?\?) expected string from data " +// "(of type DataType = DATA_T_STRING), but the String " +// "was NULL or did not exist!", +// fn_name, dup_threshold, out_file_path +// ); +// return -1; +// } +// if (strlen(data) == 0u) +// { +// mssErrorf(1, "EXP", +// "%s(%lg, \"%s\", \"%s\") data cannot be an empty string.", +// fn_name, dup_threshold, out_file_path, data +// ); +// return -1; +// } + +// /** Check number of entries in the dataset. **/ +// size_t dataset_size = 1; +// for (char* buf = data; *buf != '\0'; buf++) +// if (*buf == SEPARATOR_CHAR) dataset_size++; + +// /** Verify dataset is reasonable size. **/ +// if (dataset_size == 1) +// { +// mssErrorf(1, "EXP", +// "%s(%lg, \"%s\", \"\?\?\?\") Expected data to contain multiple " +// "values separated by \""SEPARATOR"\", but data was: \"%s\"", +// fn_name, dup_threshold, out_file_path, data +// ); +// return -1; +// } + +// /** Parse strs out of the data into the dataset. **/ +// size_t count = 0u; +// char* token = strtok(data, SEPARATOR); +// char* dataset[dataset_size]; +// memset(dataset, 0, sizeof(dataset)); +// while (token && count < dataset_size) +// { +// char* new_token = strdup(token); +// if (new_token == NULL) +// { +// mssErrorf(1, "EXP", +// "%s(%lg, \"%s\", \"...\") Failed to copy token \"%s\" from data.", +// fn_name, dup_threshold, out_file_path, token +// ); +// goto err_free_dataset; +// } +// dataset[count++] = new_token; +// token = strtok(NULL, SEPARATOR); +// } + +// /** Allocate memory to store dups. **/ +// pXArray dups; + +// /** Handle phone numbers. **/ +// if (is_phone_numbers) +// { +// /*** Phone number strings are always 10 characters long. Thus, they +// *** are NOT NULL TERMINATED because we can assume the length. +// ***/ +// unsigned int num_phone_numbers = 0u; +// char phone_numbers[dataset_size][10u]; + +// /** Parse the dataset. **/ +// for (unsigned int i = 0u; i < dataset_size; i++) +// { +// char* maybe_phone_number = dataset[i]; + +// /** Verify length can be a valid phone number. **/ +// const size_t len = strlen(maybe_phone_number); +// if (len < 10u) +// { +// mssErrorf(1, "EXP", +// "%s(%lg, \"%s\", \"...\") \"Phone number\" (\"%s\") is too short. (skipped)", +// fn_name, dup_threshold, out_file_path, maybe_phone_number +// ); +// continue; +// } +// if (len > 18u) +// { +// mssErrorf(1, "EXP", +// "%s(%lg, \"%s\", \"...\") \"Phone number\" (\"%s\") is too long. (skipped)", +// fn_name, dup_threshold, out_file_path, maybe_phone_number +// ); +// continue; +// } + +// /** Parse phone number. **/ +// char buf[11u], cur_char = maybe_phone_number[0]; +// unsigned int j = ((cur_char == '+') ? 2u : +// ((cur_char == '1') ? 1u : 0u)); +// unsigned int number_len = 0u; +// while (cur_char != '\0' && number_len <= 10u) +// { +// cur_char = maybe_phone_number[j]; + +// if ( +// cur_char == '-' || +// cur_char == ' ' || +// cur_char == '(' || +// cur_char == ')' +// ) continue; +// else if (!isdigit(cur_char)) +// { +// /** Unknown character. **/ +// mssErrorf(1, "EXP", +// "%s(%lg, \"%s\", \"...\") \"Phone number\" (\"%s\") contains unexpected character '%c'. (skipped)", +// fn_name, dup_threshold, out_file_path, maybe_phone_number, cur_char +// ); +// goto next_phone_number; +// } + +// /** Add the character to the phone number. */ +// buf[number_len] = cur_char; +// number_len++; + +// /** Advance to next number. **/ +// j++; +// } + +// /** Check number of digits. **/ +// if (number_len < 10u) +// { +// mssErrorf(1, "EXP", +// "%s(%lg, \"%s\", \"...\") \"Phone number\" (\"%s\") has less than 10 digits. (skipped)", +// fn_name, dup_threshold, out_file_path, maybe_phone_number +// ); +// continue; +// } +// if (number_len > 10u) +// { +// mssErrorf(1, "EXP", +// "%s(%lg, \"%s\", \"...\") \"Phone number\" (\"%s\") has more than 10 digits. (skipped)", +// fn_name, dup_threshold, out_file_path, maybe_phone_number +// ); +// continue; +// } + +// /** Copy valid phone number (with no null-terminator). **/ +// memcpy(phone_numbers[num_phone_numbers++], buf, 10u); + +// next_phone_number:; +// } + +// /** Invoke phone number search to find dups in the processed data. **/ +// dups = phone_search(phone_numbers, num_phone_numbers, dup_threshold); +// } + +// /** Handle text. **/ +// else +// { +// /** Build vectors from the strs in the dataset. **/ +// const size_t vectors_size = dataset_size * sizeof(int*); +// int** vectors = (int**)nmMalloc(vectors_size); +// if (vectors == NULL) +// { +// mssErrorf(1, "EXP", +// "%s(%lg, \"%s\", \"...\") - nmMalloc(%lu) failed.", +// fn_name, dup_threshold, out_file_path, vectors_size +// ); +// goto err_free_dataset; +// } +// for (size_t i = 0; i < dataset_size; i++) +// { +// const int* vector = vectors[i] = build_vector(dataset[i]); +// if (vector == NULL) +// { +// mssErrorf(1, "EXP", +// "%s(%lg, \"%s\", \"...\") - build_vector(%s) failed.", +// fn_name, dup_threshold, out_file_path, dataset[i] +// ); +// goto err_free_vectors; +// } +// if (vector[0] == -EXP_NUM_DIMS) { +// mssErrorf(1, "EXP", +// "%s(%lg, \"%s\", \"...\") - build_vector(%s) produced no character pairs.", +// fn_name, dup_threshold, out_file_path, dataset[i] +// ); +// goto err_free_vectors; +// } +// } + +// /** Invoke lightning search to find dups using the vectors. **/ +// dups = lightning_search(vectors, dataset_size, dup_threshold); +// if (dups == NULL) { +// mssErrorf(1, "EXP", +// "%s(%lg, \"%s\", \"...\") - lightning_search() failed.", +// fn_name, dup_threshold, out_file_path +// ); +// goto err_free_vectors; +// } + +// /** Free unused memory. **/ +// for (size_t i = 0; i < dataset_size; i++) +// { +// nmSysFree(vectors[i]); +// vectors[i] = NULL; +// } +// nmFree(vectors, vectors_size); +// vectors = NULL; +// goto search_done; + +// /** Free vectors, if needed. **/ +// err_free_vectors: +// if (vectors != NULL) +// { +// for (size_t i = 0; i < dataset_size; i++) +// { +// if (vectors[i] == NULL) break; +// nmSysFree(vectors[i]); +// vectors[i] = NULL; +// } +// nmFree(vectors, vectors_size); +// vectors = NULL; +// } +// goto err_free_dataset; + +// search_done:; +// } + +// /** Check number of dups found. **/ +// const int num_dups = dups->nItems; + +// // Hack where we hardcode the path to the root directory because trying to +// // track it down is way too hard. +// const char root_path[] = "/usr/local/src/cx-git/centrallix-os"; + +// /** Create output file path. **/ +// char out_path[BUFSIZ]; +// snprintf(memset(out_path, 0, sizeof(out_path)), sizeof(out_path), "%s/%s", root_path, out_file_path); + +// /** Write output file. **/ +// FILE* file = fopen(out_path, "w"); +// if (file == NULL) +// { +// perror("Failed to open file."); +// mssErrorf(1, "EXP", +// "%s(%lg, \"...\", ...) failed to open file: %s", +// fn_name, dup_threshold, out_path +// ); +// goto err_free_dups; +// } +// const int setvbuf_ret = setvbuf(file, NULL, _IOFBF, (1000 * 1000)); +// if (setvbuf_ret != 0) +// { +// perror("Failed to set buffering on file."); +// mssErrorf(1, "EXP", +// "%s(%lg, \"...\", ...) failed to set buffering on file: %d, %s", +// fn_name, dup_threshold, setvbuf_ret, out_path +// ); +// goto err_close_file; +// } + +// /** Write CSV header. **/ +// fprintf(file, "id1,id2,sim\n"); + +// /*** If no data was written, make sure there is at least one row in the +// *** output file since assuming this file has data makes the sql faster. +// ***/ +// if (num_dups == 0u) +// fprintf(file, "error,undefined,0.0\n"); + +// /** Write CSV data rows. **/ +// else +// { +// for (unsigned int i = 0u; i < num_dups; i++) +// { +// Dup* data = (Dup*)dups->Items[i]; +// fprintf(file, "%s,%s,%.8lf\n", dataset[data->id1], dataset[data->id2], data->similarity); +// nmFree(data, sizeof(Dup)); /* Free unused data. */ +// dups->Items[i] = NULL; +// } +// } + +// /** Free unused data. **/ +// for (unsigned int i = 0u; i < dataset_size; i++) +// { +// free(dataset[i]); +// dataset[i] = NULL; +// } +// xaDeInit(dups); +// dups = NULL; + +// /** Close file. **/ +// const int fclose_ret = fclose(file); +// if (fclose_ret != 0) +// { +// perror("Failed to close file."); +// mssErrorf(1, "EXP", +// "%s(%lg, \"...\") failed to close file: %d, %s", +// fn_name, dup_threshold, fclose_ret, out_path +// ); +// goto err_free_dataset; +// } +// file = NULL; + +// /** Success. **/ +// tree->DataType = DATA_T_INTEGER; +// tree->Integer = (int)num_dups; +// return 0; + +// /** Error cases. **/ + +// /** Close file, if needed. **/ +// err_close_file: +// if (file != NULL) +// { +// const int fclose_ret = fclose(file); +// if (fclose_ret != 0) +// { +// char dbl_buf[DBL_BUF_SIZE]; +// snprintf(dbl_buf, sizeof(dbl_buf), "%lg", dup_threshold); +// perror("Failed to close file."); +// mssErrorf(1, "EXP", +// "%s(%s, \"...\") failed to close file: %d, %s", +// fn_name, dbl_buf, fclose_ret, out_path +// ); +// } +// } + +// /** Free dups, if needed. **/ +// err_free_dups: +// if (dups != NULL) +// { +// for (unsigned int i = 0u; i < num_dups; i++) +// { +// nmFree(dups->Items[i], sizeof(Dup)); +// dups->Items[i] = NULL; +// } +// xaDeInit(dups); +// dups = NULL; +// } + +// /** Free dataset, if needed. **/ +// err_free_dataset: +// for (unsigned int i = 0u; i < dataset_size; i++) +// { +// if (dataset[i] == NULL) break; +// free(dataset[i]); +// dataset[i] = NULL; +// } + +// return -1; +// } + +// int exp_fn_get_dups(pExpression tree, pParamObjects objlist, pExpression p1, pExpression p2, pExpression p3) +// { +// return exp_fn_get_dups_general(tree, objlist, p1, p2, p3, "get_dups", false); +// } + +// int exp_fn_get_dups_phone(pExpression tree, pParamObjects objlist, pExpression p1, pExpression p2, pExpression p3) +// { +// return exp_fn_get_dups_general(tree, objlist, p1, p2, p3, "get_dups_phone", true); +// } + +// /** Magic values. **/ +// #define EXP_NUM_FIELDS 7 +// #define EXP_INDEX_FIRST_NAME 0 +// #define EXP_INDEX_FIRST_NAME_METAPHONE 1 +// #define EXP_INDEX_LAST_NAME 2 +// #define EXP_INDEX_LAST_NAME_METAPHONE 3 +// #define EXP_INDEX_EMAIL 4 +// #define EXP_INDEX_PHONE 5 +// #define EXP_INDEX_ADDRESS 6 + +// /** No-op function. **/ +// int exp_fn_do_nothing() { return 0; } + +// /*** Function to add parameters to private storage so that more than 3 parameters can be passed. +// *** Currently, doubles are the only supported param type. +// *** +// *** Usage: param(, , ) : R, +// *** where: V : Double +// *** +// *** @param tree Return param_value. +// *** @param objlist Function scope. +// *** @param maybe_array The 1st param, should be NULL or another call to param(). +// *** @param maybe_param_name The 2nd param, should be a string for the name of the param. +// *** @param maybe_param_value The 3rd param, should be the param_value of the param being set. +// ***/ +// int exp_fn_param(pExpression tree, pParamObjects objlist, pExpression maybe_param_name, pExpression maybe_param_value, pExpression maybe_array) { +// // Verify arg number. +// if (!maybe_param_name || !maybe_param_value) +// { +// mssErrorf(1, "EXP", "param(?) expects two or three parameters."); +// return -1; +// } + +// // Magic checks. +// ASSERTMAGIC(tree, MGK_EXPRESSION); +// ASSERTMAGIC(maybe_param_name, MGK_EXPRESSION); +// ASSERTMAGIC(maybe_param_value, MGK_EXPRESSION); +// ASSERTMAGIC(maybe_array, MGK_EXPRESSION); + +// // Check object list. +// if (!objlist) +// { +// mssErrorf(1, "EXP", "param(\?\?\?) no object list?"); +// return -1; +// } +// ASSERTMAGIC(objlist->Session, MGK_OBJSESSION); + +// // Extract param name. +// if (maybe_param_name->Flags & EXPR_F_NULL) +// { +// mssErrorf(1, "EXP", "param(NULL, ...) param_name cannot be null."); +// return -1; +// } +// if (maybe_param_name->DataType != DATA_T_STRING) +// { +// mssErrorf(1, "EXP", "param(?, ...) param_name must be a string."); +// return -1; +// } +// const char* param_name = maybe_param_name->String; + +// // Extract param value. +// if (maybe_param_value->Flags & EXPR_F_NULL) +// { +// mssErrorf(1, "EXP", "param(\"%s\", NULL, ...) param_value cannot be null.", param_name); +// return -1; +// } +// if (maybe_param_value->DataType != DATA_T_DOUBLE) +// { +// mssErrorf(1, "EXP", "param(\"%s\", ?, ...) param_value must be a doube.", param_name); +// return -1; +// } +// double param_value = maybe_param_value->Types.Double; + +// // Verify the value being set. +// // TODO: Replace with hashmap. +// signed int index = -1; +// if (strcmp(param_name, "first_name") == 0) index = EXP_INDEX_FIRST_NAME; +// else if (strcmp(param_name, "first_name_metaphone") == 0) index = EXP_INDEX_FIRST_NAME_METAPHONE; +// else if (strcmp(param_name, "last_name") == 0) index = EXP_INDEX_LAST_NAME; +// else if (strcmp(param_name, "last_name_metaphone") == 0) index = EXP_INDEX_LAST_NAME_METAPHONE; +// else if (strcmp(param_name, "email") == 0) index = EXP_INDEX_EMAIL; +// else if (strcmp(param_name, "phone") == 0) index = EXP_INDEX_PHONE; +// else if (strcmp(param_name, "address") == 0) index = EXP_INDEX_ADDRESS; +// if (index == -1) +// { +// mssErrorf(1, "EXP", +// "param(\"%s\", %lf, ...) invalid field name %s.", +// param_name, param_value, param_name +// ); +// return -1; +// } + +// // Extract array. +// double* array; +// if (!maybe_array || maybe_array->Flags & EXPR_F_NULL) +// { +// const size_t size = EXP_NUM_FIELDS * sizeof(double); +// void* PrivateData = tree->PrivateData = memset(nmSysMalloc(size), 0, size); +// tree->PrivateDataFinalize = exp_fn_do_nothing; // DON'T FREE MY DATA UNTIL I'M READY. + +// array = (double*)PrivateData; +// for (unsigned int i = 0u; i < EXP_NUM_FIELDS; i++) array[i] = NAN; +// } +// else if ( +// maybe_array->DataType == DATA_T_ARRAY && +// maybe_array->PrivateData != NULL && +// !strcmp(maybe_array->Name, "param") +// ) +// { +// tree->PrivateData = maybe_array->PrivateData; +// tree->PrivateDataFinalize = exp_fn_do_nothing; // DON'T FREE MY DATA UNTIL I'M READY. +// array = (double*)maybe_array->PrivateData; +// } +// else +// { +// mssErrorf(1, "EXP", "param(\"%s\", %lf, ...) if provided, array must be from a call to param().", param_name, param_value); +// return -1; +// } + +// // Warn on previous data. +// double old_value = array[index]; +// if (!isnan(old_value)) +// { +// fprintf(stderr, +// "Warning: Overwriting field '%s'(@ index %d) with %lf (was %lf).\n", +// param_name, index, param_value, old_value +// ); +// } + +// // Set param_value. +// array[index] = param_value; + +// // Done +// tree->DataType = DATA_T_ARRAY; +// tree->Integer = 0; +// tree->Types.Double = 0.0; +// return 0; +// } + +// int exp_fn_get_sim(pExpression tree, pParamObjects objlist, pExpression maybe_fields, pExpression unused1, pExpression unused2) +// { +// if (!maybe_fields || unused1 || unused2) +// { +// mssErrorf(1, "EXP", "get_sim(param(...)) expects one parameter, from param()."); +// return -1; +// } + +// // Magic checks. +// ASSERTMAGIC(tree, MGK_EXPRESSION); +// ASSERTMAGIC(maybe_fields, MGK_EXPRESSION); + +// // Check object list. +// if (!objlist) +// { +// mssErrorf(1, "EXP", "get_sim(\?\?\?) no object list?"); +// return -1; +// } +// ASSERTMAGIC(objlist->Session, MGK_OBJSESSION); + +// // Verify arg. +// if (maybe_fields->Flags & EXPR_F_NULL) +// { +// mssErrorf(1, "EXP", "get_sim(NULL) fields from param() cannot be NULL."); +// return -1; +// } +// if (maybe_fields->DataType != DATA_T_ARRAY || maybe_fields->PrivateData == NULL) +// { +// mssErrorf(1, "EXP", "get_sim(\?\?\?) expects arg 0 to be fields from a call to param()."); +// return -1; +// } + +// // Extract arg(s?). +// double* fields = (double*)maybe_fields->PrivateData; + +// const double first_name = fields[EXP_INDEX_FIRST_NAME]; +// if (isnan(first_name)) +// { +// mssErrorf(1, "EXP", "get_sim(...) first_name similarity not set."); +// return -1; +// } + +// const double first_name_metaphone = fields[EXP_INDEX_FIRST_NAME_METAPHONE]; +// if (isnan(first_name_metaphone)) +// { +// mssErrorf(1, "EXP", "get_sim(...) first_name_metaphone similarity not set."); +// return -1; +// } + +// const double last_name = fields[EXP_INDEX_LAST_NAME]; +// if (isnan(last_name)) +// { +// mssErrorf(1, "EXP", "get_sim(...) last_name similarity not set."); +// return -1; +// } + +// const double last_name_metaphone = fields[EXP_INDEX_LAST_NAME_METAPHONE]; +// if (isnan(last_name_metaphone)) +// { +// mssErrorf(1, "EXP", "get_sim(...) last_name_metaphone similarity not set."); +// return -1; +// } + +// const double email = fields[EXP_INDEX_EMAIL]; +// if (isnan(email)) +// { +// mssErrorf(1, "EXP", "get_sim(...) email similarity not set."); +// return -1; +// } + +// const double phone = fields[EXP_INDEX_PHONE]; +// if (isnan(phone)) +// { +// mssErrorf(1, "EXP", "get_sim(...) phone similarity not set."); +// return -1; +// } + +// const double address = fields[EXP_INDEX_ADDRESS]; +// if (isnan(address)) +// { +// mssErrorf(1, "EXP", "get_sim(...) address similarity not set."); +// return -1; +// } + +// char* primary; +// char* secondary; +// meta_double_metaphone("text", &primary, &secondary); +// printf("Primary: %s, secondary: %s\n", primary, secondary); + +// // Print args. +// printf( +// "Sims:\n" +// "\tfirst_name: %lf\n" +// "\tfirst_name_metaphone: %lf\n" +// "\tlast_name: %lf\n" +// "\tlast_name_metaphone: %lf\n" +// "\temail: %lf\n" +// "\tphone: %lf\n" +// "\taddress: %lf\n", +// first_name, +// first_name_metaphone, +// last_name, +// last_name_metaphone, +// email, +// phone, +// address +// ); + +// // Compute total. +// const double first_name_total = max(first_name * 1.0, first_name_metaphone * 0.9); +// const double last_name_total = max(last_name * 1.0, last_name_metaphone * 0.9); +// double total = (first_name_total * last_name_total) * 0.6 + email * 0.2 + address * 0.2; + +// // Clean up. +// nmSysFree(fields); + +// // Return total. +// tree->DataType = DATA_T_DOUBLE; +// tree->Types.Double = total; +// return 0; +// } + + +int exp_fn_double_metaphone(pExpression tree, pParamObjects objlist, pExpression maybe_str, pExpression u1, pExpression u2) + { + const char fn_name[] = "double_metaphone"; + + /** Check number of arguments. **/ + if (!maybe_str || u1 || u2) + { + mssErrorf(1, "EXP", "%s(?) expects 1 parameter.", fn_name); + return -1; + } + const int num_params = tree->Children.nItems; + if (num_params != 1) + { + mssErrorf(1, "EXP", "%s(?) expects 1 parameter, got %d.", fn_name, num_params); + return -1; + } + + /** Magic checks. **/ + ASSERTMAGIC(tree, MGK_EXPRESSION); + ASSERTMAGIC(maybe_str, MGK_EXPRESSION); + + /** Check object list. **/ + if (!objlist) + { + mssErrorf(1, "EXP", "%s(\?\?\?) no object list?", fn_name); + return -1; + } + ASSERTMAGIC(objlist->Session, MGK_OBJSESSION); + + /** Extract str. **/ + if (maybe_str->Flags & EXPR_F_NULL) + { + mssErrorf(1, "EXP", "%s(NULL) str cannot be NULL.", fn_name); + return -1; + } + if (maybe_str->DataType != DATA_T_STRING) + { + mssErrorf(1, "EXP", "%s(\?\?\?) str should be a string.", fn_name); + return -1; + } + const char* str = maybe_str->String; + if (str == NULL) + { + mssErrorf(1, "EXP", + "%s(nothing?) expected string from str " + "(of type DataType = DATA_T_STRING), but the String " + "was NULL or did not exist!", + fn_name + ); + return -1; + } + const size_t str_len = strlen(str); + if (str_len == 0u) + { + mssErrorf(1, "EXP", "%s(\"\") str cannot be an empty string.", fn_name); + return -1; + } + + /** Compute DoubleMetaphone. **/ + char* primary; + char* secondary; + meta_double_metaphone( + str, + memset(&primary, 0, sizeof(primary)), + memset(&secondary, 0, sizeof(secondary)) + ); + + /** Process result. **/ + const size_t primary_length = strlen(primary); + const size_t secondary_length = strlen(secondary); + char* result = nmSysMalloc(primary_length + 1u + secondary_length + 1u); + sprintf(result, "%s%c%s", primary, CA_BOUNDARY_CHAR, secondary); + + /** Return the result. **/ + tree->String = result; + tree->DataType = DATA_T_STRING; + return 0; + } + +// // Clean up. +// #undef min +// #undef max + +// // END OF DUPE SECTION +// // =================== /* * exp_fn_argon2id @@ -4521,8 +6261,8 @@ int exp_internal_DefineFunctions() xhAdd(&EXP.Functions, "log10", (char*)exp_fn_log10); xhAdd(&EXP.Functions, "power", (char*)exp_fn_power); xhAdd(&EXP.Functions, "pbkdf2", (char*)exp_fn_pbkdf2); - xhAdd(&EXP.Functions, "levenshtein", (char*)exp_fn_levenshtein); - xhAdd(&EXP.Functions, "lev_compare", (char*)exp_fn_lev_compare); + xhAdd(&EXP.Functions, "levenshtein", (char*)exp_fn_levenshtein); /* Only used in its own tests. */ + xhAdd(&EXP.Functions, "lev_compare", (char*)exp_fn_lev_compare); /* Only used in its own tests. */ xhAdd(&EXP.Functions, "cos_compare", (char*)exp_fn_cos_compare); xhAdd(&EXP.Functions, "to_base64", (char*)exp_fn_to_base64); xhAdd(&EXP.Functions, "from_base64", (char*)exp_fn_from_base64); @@ -4530,7 +6270,16 @@ int exp_internal_DefineFunctions() xhAdd(&EXP.Functions, "from_hex", (char*)exp_fn_from_hex); xhAdd(&EXP.Functions, "octet_length", (char*)exp_fn_octet_length); xhAdd(&EXP.Functions, "argon2id",(char*)exp_fn_argon2id); - + + /** Duplicate Detection **/ + // xhAdd(&EXP.Functions, "get_dups", (char*)exp_fn_get_dups); + // xhAdd(&EXP.Functions, "get_dups_phone", (char*)exp_fn_get_dups_phone); + // xhAdd(&EXP.Functions, "no_op", (char*)exp_fn_do_nothing); + // xhAdd(&EXP.Functions, "do_nothing", (char*)exp_fn_do_nothing); + // xhAdd(&EXP.Functions, "param", (char*)exp_fn_param); + // xhAdd(&EXP.Functions, "total_sim", (char*)exp_fn_get_sim); + xhAdd(&EXP.Functions, "double_metaphone", (char*)exp_fn_double_metaphone); + /** Windowing **/ xhAdd(&EXP.Functions, "row_number", (char*)exp_fn_row_number); xhAdd(&EXP.Functions, "dense_rank", (char*)exp_fn_dense_rank); diff --git a/centrallix/include/cxss/policy.h b/centrallix/include/cxss/policy.h index aeee11ce8..6f9ca7d83 100644 --- a/centrallix/include/cxss/policy.h +++ b/centrallix/include/cxss/policy.h @@ -2,6 +2,7 @@ #define _CXSS_POLICY_H #include "cxss/cxss.h" +#include "obj.h" /************************************************************************/ /* Centrallix Application Server System */ @@ -89,4 +90,3 @@ typedef struct _CXSSPOL CxssPolicy, *pCxssPolicy; #endif /* defined _CXSS_POLICY_H */ - diff --git a/centrallix/include/expression.h b/centrallix/include/expression.h index 8d506f72e..3b334606b 100644 --- a/centrallix/include/expression.h +++ b/centrallix/include/expression.h @@ -307,6 +307,7 @@ int exp_internal_SetupControl(pExpression exp); pExpControl exp_internal_LinkControl(pExpControl ctl); int exp_internal_UnlinkControl(pExpControl ctl); +void meta_double_metaphone(const char* str, char** primary_code, char** secondary_code); /*** Evaluator functions ***/ int expEvalIsNull(pExpression tree, pParamObjects objlist); diff --git a/centrallix/include/stparse.h b/centrallix/include/stparse.h index 50d9e2c20..fad7f9604 100644 --- a/centrallix/include/stparse.h +++ b/centrallix/include/stparse.h @@ -46,7 +46,7 @@ typedef struct _SI int Magic; int LinkCnt; char* Name; /* name of attrib or group */ - char* UsrType; /* type of group, null if attrib */ + char* UsrType; /* type of group (e.g. "system/object"), null if attrib */ pExpression Value; /* value; EXPR_N_LIST if several listed */ struct _SI* Parent; /* Parent inf, null if toplevel */ struct _SI** SubInf; /* List of attrs/groups included */ diff --git a/centrallix/osdrivers/objdrv_cluster.c b/centrallix/osdrivers/objdrv_cluster.c new file mode 100644 index 000000000..9ffbd1d22 --- /dev/null +++ b/centrallix/osdrivers/objdrv_cluster.c @@ -0,0 +1,3345 @@ + +/************************************************************************/ +/* Centrallix Application Server System */ +/* Centrallix Core */ +/* */ +/* Copyright (C) 1998-2012 LightSys Technology Services, Inc. */ +/* */ +/* This program is free software; you can redistribute it and/or modify */ +/* it under the terms of the GNU General Public License as published by */ +/* the Free Software Foundation; either version 2 of the License, or */ +/* (at your option) any later version. */ +/* */ +/* This program 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 General Public License for more details. */ +/* */ +/* You should have received a copy of the GNU General Public License */ +/* along with this program; if not, write to the Free Software */ +/* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA */ +/* 02111-1307 USA */ +/* */ +/* A copy of the GNU General Public License has been included in this */ +/* distribution in the file "COPYING". */ +/* */ +/* Module: objdrv_cluster.c */ +/* Author: Israel Fuller */ +/* Creation: September 17, 2025 */ +/* Description: Cluster object driver. */ +/************************************************************************/ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "cxlib/clusters.h" +#include "cxlib/mtask.h" +#include "cxlib/mtsession.h" +#include "cxlib/newmalloc.h" +#include "cxlib/util.h" +#include "cxlib/xarray.h" +#include "cxlib/xhash.h" +#include "expression.h" +#include "hints.h" +#include "obj.h" +#include "param.h" +#include "st_node.h" +#include "stparse.h" + +/*** File notes: + *** This file uses comment anchors, provided by the Comment Anchors VSCode + *** extension from Starlane Studios. This allows developers with the extension + *** to control click the "LINK " comments to navigate to the coresponding + *** "ANCHOR[id=]" comment. (Note: Invalid or broken links will default to + *** the first line of the file.) + *** + *** For example, this link should take you to the function signatures: + *** LINK #functions + *** + *** Any developers without this extension can safely ignore these comments, + *** although please try not to break them. :) + *** + *** Comment Anchors VSCode Extension: + *** https://marketplace.visualstudio.com/items?itemName=ExodiusStudios.comment-anchors + ***/ + + +/** Debugging **/ +// void void_func() {} +// #define tprintf void_func +#define tprintf printf + +/** Defaults for unspecified optional attributes. **/ +#define DEFAULT_MIN_IMPROVEMENT 0.0001 +#define DEFAULT_MAX_ITERATIONS 64u + +/** ================ Stuff That Should Be Somewhere Else ================ **/ +/** ANCHOR[id=temp] **/ + +#define INT_TO_BINARY_PATTERN "%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c" +#define INT_TO_BINARY(int_val) \ + ((int_val) & 0b10000000000000000000000000000000 ? '1' : '0'), \ + ((int_val) & 0b01000000000000000000000000000000 ? '1' : '0'), \ + ((int_val) & 0b00100000000000000000000000000000 ? '1' : '0'), \ + ((int_val) & 0b00010000000000000000000000000000 ? '1' : '0'), \ + ((int_val) & 0b00001000000000000000000000000000 ? '1' : '0'), \ + ((int_val) & 0b00000100000000000000000000000000 ? '1' : '0'), \ + ((int_val) & 0b00000010000000000000000000000000 ? '1' : '0'), \ + ((int_val) & 0b00000001000000000000000000000000 ? '1' : '0'), \ + ((int_val) & 0b00000000100000000000000000000000 ? '1' : '0'), \ + ((int_val) & 0b00000000010000000000000000000000 ? '1' : '0'), \ + ((int_val) & 0b00000000001000000000000000000000 ? '1' : '0'), \ + ((int_val) & 0b00000000000100000000000000000000 ? '1' : '0'), \ + ((int_val) & 0b00000000000010000000000000000000 ? '1' : '0'), \ + ((int_val) & 0b00000000000001000000000000000000 ? '1' : '0'), \ + ((int_val) & 0b00000000000000100000000000000000 ? '1' : '0'), \ + ((int_val) & 0b00000000000000010000000000000000 ? '1' : '0'), \ + ((int_val) & 0b00000000000000001000000000000000 ? '1' : '0'), \ + ((int_val) & 0b00000000000000000100000000000000 ? '1' : '0'), \ + ((int_val) & 0b00000000000000000010000000000000 ? '1' : '0'), \ + ((int_val) & 0b00000000000000000001000000000000 ? '1' : '0'), \ + ((int_val) & 0b00000000000000000000100000000000 ? '1' : '0'), \ + ((int_val) & 0b00000000000000000000010000000000 ? '1' : '0'), \ + ((int_val) & 0b00000000000000000000001000000000 ? '1' : '0'), \ + ((int_val) & 0b00000000000000000000000100000000 ? '1' : '0'), \ + ((int_val) & 0b00000000000000000000000010000000 ? '1' : '0'), \ + ((int_val) & 0b00000000000000000000000001000000 ? '1' : '0'), \ + ((int_val) & 0b00000000000000000000000000100000 ? '1' : '0'), \ + ((int_val) & 0b00000000000000000000000000010000 ? '1' : '0'), \ + ((int_val) & 0b00000000000000000000000000001000 ? '1' : '0'), \ + ((int_val) & 0b00000000000000000000000000000100 ? '1' : '0'), \ + ((int_val) & 0b00000000000000000000000000000010 ? '1' : '0'), \ + ((int_val) & 0b00000000000000000000000000000001 ? '1' : '0') + + +/** TODO: I think this should be moved to mtsession. **/ +/*** I caused at least 10 bugs so far trying to pass format specifiers to + *** mssError without realizing that it didn't support them. Eventually, I + *** got fed up enough with the whole thing to write the following function. + ***/ +/*** Displays error text to the user. Does not print a stack trace. Does not + *** exit the program, allowing for the calling function to fail, generating + *** an error cascade which may be useful to the user since a stack trace is + *** not readily available. + *** + *** @todo I think this should be moved to somewhere else. + *** + *** @param clr Whether to clear the current error stack. As a rule of thumb, + *** if you are the first one to detec the error, clear the stack so that + *** other unrelated messages are not shown. If you are detecting an error + *** from another function that may also call an mssError() function, do + *** not clear the stack. + *** @param module The name or abbreviation of the module in which this + *** function is being called, to help developers narrow down the location + *** of the error. + *** @param format The format text for the error, which accepts any format + *** specifier that would be accepted by printf(). + *** @param ... Variables matching format specifiers in the format. + *** @returns Nothing, always succeeds. + ***/ +void mssErrorf(int clr, char* module, const char* format, ...) + { + /** Prevent interlacing with stdout flushing at a weird time. **/ + check(fflush(stdout)); + + /** Insert convenient newline before error stack begins. **/ + if (clr == 1) fprintf(stderr, "\n"); + + /** Process the format with all the same rules as printf(). **/ + char buf[BUFSIZ]; + va_list args; + va_start(args, format); + const int num_chars = vsnprintf(buf, sizeof(buf), format, args); + va_end(args); + + /** Error check vsnprintf, just to be safe. **/ + if (num_chars < 0) + { + perror("vsnprintf() failed"); + fprintf(stderr, "FAIL: mssErrorf(%d, \"%s\", \"%s\", ...)\n", clr, module, format); + return; + } + if (num_chars > BUFSIZ) + fprintf(stderr, "WARNING: Error truncated (length %d > buffer size %d).\n", num_chars, BUFSIZ); + + /** Print the error. **/ + const int ret = mssError(clr, module, "%s", buf); + + /** Not sure why you have to error check the error function... **/ + if (ret != 0) fprintf(stderr, "FAIL %d: mssError(%d, \"%s\", \"%%s\", \"%s\")\n", ret, clr, module, buf); + } + + +/** TODO: I think this should be moved to datatypes. **/ +/** Should maybe replace current type parsing in the presentation hints. **/ +int ci_TypeFromStr(const char* str) + { + if (str == NULL) return -1; + + /** Check string length. **/ + const size_t len = strlen(str); + if (len < 3 || 13 < len) return -1; + + /** Copy str to enable mutability. **/ + char buf[len + 1u]; + strcpy(buf, str); + + /** First character is case insensitive. **/ + buf[0] = toupper(buf[0]); + + /** Check type. **/ + if (strcmp(buf, "Any") == 0) return DATA_T_UNAVAILABLE; + if (strcmp(buf, "Integer") == 0) return DATA_T_INTEGER; + if (strcmp(buf, "String") == 0) return DATA_T_STRING; + if (strcmp(buf, "Double") == 0) return DATA_T_DOUBLE; + if (strcmp(buf, "DateTime") == 0) return DATA_T_DATETIME; + if (strcmp(buf, "IntVecor") == 0) return DATA_T_INTVEC; + if (strcmp(buf, "StringVector") == 0) return DATA_T_STRINGVEC; + if (strcmp(buf, "Money") == 0) return DATA_T_MONEY; + if (strcmp(buf, "Array") == 0) return DATA_T_ARRAY; + if (strcmp(buf, "Code") == 0) return DATA_T_CODE; + if (strcmp(buf, "Binary") == 0) return DATA_T_BINARY; + + /** Invalid type. **/ + return -1; + } + +/** TODO: I think this should be moved to datatypes. **/ +/** Should maybe replace duplocate functionality elsewhere. **/ +char* ci_TypeToStr(const int type) + { + switch (type) + { + case DATA_T_UNAVAILABLE: return "Unknown"; + case DATA_T_INTEGER: return "Integer"; + case DATA_T_STRING: return "String"; + case DATA_T_DOUBLE: return "Double"; + case DATA_T_DATETIME: return "DateTime"; + case DATA_T_INTVEC: return "IntVecor"; + case DATA_T_STRINGVEC: return "StringVector"; + case DATA_T_MONEY: return "Money"; + case DATA_T_ARRAY: return "Array"; + case DATA_T_CODE: return "Code"; + case DATA_T_BINARY: return "Binary"; + } + + /** Invalid type. **/ + mssErrorf(1, "Cluster", "Invalid type %d.\n", type); + return "Invalid"; + } + +/** TODO: I think this should be moved to xarray. **/ +/** Contract: Return value is null iff pXArray has 0 items. **/ +void** ci_xaToTrimmedArray(pXArray arr) + { + if (arr->nItems == 0) { + mssErrorf(1, "Cluster", "Failed to trim XArray of length 0."); + return NULL; + } + + const size_t arr_size = arr->nItems * sizeof(void*); + void** result = check_ptr(nmMalloc(arr_size)); + memcpy(result, arr->Items, arr_size); + return result; + } + +/** ================ Enum Declairations ================ **/ +/** ANCHOR[id=enums] **/ + +/** Enum representing a clustering algorithm. **/ +typedef unsigned char ClusterAlgorithm; +#define ALGORITHM_NULL (ClusterAlgorithm)0u +#define ALGORITHM_NONE (ClusterAlgorithm)1u +#define ALGORITHM_SLIDING_WINDOW (ClusterAlgorithm)2u +#define ALGORITHM_KMEANS (ClusterAlgorithm)3u +#define ALGORITHM_KMEANS_PLUS_PLUS (ClusterAlgorithm)4u +#define ALGORITHM_KMEDOIDS (ClusterAlgorithm)5u +#define ALGORITHM_DB_SCAN (ClusterAlgorithm)6u + +/** Converts a clustering algorithm to its string name. **/ +char* ci_ClusteringAlgorithmToString(ClusterAlgorithm clustering_algorithm) + { + switch (clustering_algorithm) + { + case ALGORITHM_NULL: return "NULL algorithm"; + case ALGORITHM_NONE: return "none"; + case ALGORITHM_SLIDING_WINDOW: return "sliding-window"; + case ALGORITHM_KMEANS: return "k-means"; + case ALGORITHM_KMEANS_PLUS_PLUS: return "k-means++"; + case ALGORITHM_KMEDOIDS: return "k-medoids"; + case ALGORITHM_DB_SCAN: return "db-scan"; + default: return "Unknown algorithm"; + } + } + +/** Enum representing a similarity measurement algorithm. **/ +typedef unsigned char SimilarityMeasure; +#define SIMILARITY_NULL (SimilarityMeasure)0u +#define SIMILARITY_COSINE (SimilarityMeasure)1u +#define SIMILARITY_LEVENSHTEIN (SimilarityMeasure)2u + +/** Converts a similarity measure to its string name. **/ +char* ci_SimilarityMeasureToString(SimilarityMeasure similarity_measure) + { + switch (similarity_measure) + { + case SIMILARITY_NULL: return "NULL similarity measure"; + case SIMILARITY_COSINE: return "cosine"; + case SIMILARITY_LEVENSHTEIN: return "levenshtein"; + default: return "Unknown similarity measure"; + } + } + +/*** Enum representing the type of data targetted by the driver, + *** set based on the path given when the driver is used to open + *** a cluster file. + *** + *** `0u` is reserved for a possible `NULL` value in the future. + *** However, there is currently no allowed `NULL` TargetType. + ***/ +typedef unsigned char TargetType; +#define TARGET_ROOT (TargetType)1u +#define TARGET_CLUSTER (TargetType)2u +#define TARGET_SEARCH (TargetType)3u +#define TARGET_CLUSTER_ENTRY (TargetType)4u +#define TARGET_SEARCH_ENTRY (TargetType)5u + +/** Attribute name lists by TargetType. **/ +#define nATTR_ROOT 2u +char* const ATTR_ROOT[nATTR_ROOT] = { + "source", + "attr_name", +}; +#define nATTR_CLUSTER 5u +char* const ATTR_CLUSTER[nATTR_CLUSTER] = { + "algorithm", + "similarity_measure", + "num_clusters", + "min_improvement", + "max_iterations", +}; +#define nATTR_SEARCH 4u +char* const ATTR_SEARCH[nATTR_SEARCH] = { + "source", + "threshold", + "similarity_measure", +}; +#define nATTR_CLUSTER_ENTRY 2u +char* const ATTR_CLUSTER_ENTRY[nATTR_CLUSTER_ENTRY] = { + "val", + "sim", +}; +#define nATTR_SEARCH_ENTRY 3u +char* const ATTR_SEARCH_ENTRY[nATTR_SEARCH_ENTRY] = { + "val1", + "val2", + "sim", +}; +#define END_OF_ATTRIBUTES NULL + + +/** Method name list. **/ +#define nMETHOD_NAME 2u +char* const METHOD_NAME[nMETHOD_NAME] = { + "cache", +}; +#define END_OF_METHODS END_OF_ATTRIBUTES + + +/** ================ Struct Declarations ================ **/ +/** ANCHOR[id=structs] **/ + +/** Represents the data source which may have data already fetched. **/ +typedef struct _SOURCE + { + /** Top level attributes (specified in the .cluster file). **/ + char* Name; /* The node name, specified in the .cluster file. + * Warning: Some code makes the assumption that this + * is the first field in the struct. + */ + char* Key; /* The key associated with this object in the global SourceCache. */ + char* SourcePath; /* The path to the data source from which to retrieve data. */ + char* AttrName; /* The name of the attribute to get from the data source. */ + + /** Computed data. **/ + char** Data; /* The data strings to be clustered and searched, or NULL if they + * have not been fetched from the source. + */ + pVector* Vectors; /* The cosine comparison vectors from the fetched data, or NULL if + * they haven't been computed. Note that vectors are no longer + * needed once all clusters and searches have been computed, so + * they are automatically freed in that case to save memory. + */ + unsigned int nVectors; /* The number of vectors and data strings. Note: This is not + * set to 0 if the vector array is freed, this case should be + * checked separately. + */ + } SourceData, *pSourceData; + +/** Data for each cluster. **/ +typedef struct _CLUSTER + { + /** Attribute Data. **/ + char* Name; /* The cluster name, specified in the .cluster file. + * Warning: Some code makes the assumption that this + * is the first field in the struct. + */ + char* Key; /* The key associated with this object in the global ClusterCache. */ + ClusterAlgorithm ClusterAlgorithm; /* The clustering algorithm to be used. */ + SimilarityMeasure SimilarityMeasure; /* The similarity measurse to be used when clustering. */ + unsigned int NumClusters; /* The number of clusters. 1 if algorithm = none. */ + double MinImprovement; /* The minimum amount of improvement that must be met each + * clustering iteration. If there is less improvement, the + * algorithm will stop. Specifying "max" in the .cluster + * file should be represented by a value of -inf. + */ + unsigned int MaxIterations; /* The maximum number of iterations to run clustering. */ + + /** Other data (ignored by caching). **/ + unsigned int nSubClusters; /* The number of subclusters of this cluster. */ + struct _CLUSTER** SubClusters; /* A pClusterData array, NULL if nSubClusters == 0. */ + struct _CLUSTER* Parent; /* This cluster's parent. NULL if it is not a subcluster. */ + pSourceData SourceData; /* Pointer to the source data that this cluster uses. */ + + /** Computed data. **/ + unsigned int* Labels; /* An array with one element for each vector in the data + * (aka. DriverData->nVectors). For vector i, Labels[i] is + * the ID of the cluster to which that data is assigned. + * NULL if the cluster has not been computed. */ + } + ClusterData, *pClusterData; + +/** Data for each search. **/ +typedef struct _SEARCH + { + char* Name; /* The search name, specified in the .cluster file. + * Warning: Some code makes the assumption that this + * is the first field in the struct. + */ + char* Key; /* The key associated with this object in the global SearchCache. */ + pClusterData Source; /* The cluster from which this search is to be derived. */ + double Threshold; /* The minimum similarity threshold for elements to be + * included in the results of the search. + */ + SimilarityMeasure SimilarityMeasure; /* The similarity measure used to compare items. */ + + /** Computed data. **/ + pDup* Dups; /* An array holding the dups found by the search, or NULL + * if the search has not been computed. + */ + unsigned int nDups; /* The number of dups found. */ + } + SearchData, *pSearchData; + +/*** Node instance data. + *** When a .cluster file is openned, there will be only one node for that + *** file. However, in the course of the query, many driver instance structs + *** may be created by functions like clusterQueryFetch(), and closed by the + *** object system using clusterClose(). + ***/ +typedef struct _NODE + { + /** Substructures. **/ + pSourceData SourceData; /* Data from the provided source. */ + pParam* Params; /* A pParam array storing the params in the .cluster file. */ + unsigned int nParams; /* The number of specified params. */ + pParamObjects ParamList; /* Functions as a "scope" for resolving values during parsing. */ + pClusterData* Clusters; /* A pCluster array storing the clusters in the .cluster file. + * Will be NULL if nClusters = 0. + */ + unsigned int nClusters; /* The number of specified clusters. */ + pSearchData* Searches; /* A SearchData array storing the searches in the .cluster file. */ + unsigned int nSearches; /* The number of specified searches. */ + + /** Other stuff, idk why it's here. **/ + pSnNode Node; + pObject Obj; + char* CreateDateField; + char* ModifyDateField; + } + NodeData, *pNodeData; + +/** Driver instance data. **/ +/*** Similar to a pointer to specific, computed data in the pNodeData struct. + *** If target type is the root, a cluster, or a search, no data is guarnteed + *** to be computed yet. These three types can be returned from clusterOpen(). + *** To target a cluster entry or search entry, fetch a driver targetting a + *** cluster or search (respectively). These target types ensure that the data + *** has been computed, so the GetAttr functions do not need to ensure this. + ***/ +typedef struct _DRIVER + { + pNodeData NodeData; /* The associated node data. */ + TargetType TargetType; /* The type of data targetted by this driver instance. */ + void* TargetData; /* A pointer to the specific targetted cluster or search. */ + unsigned int TargetIndex; /* An index into the cluster or search (entries only). */ + unsigned char TargetAttrIndex; /* An index into an attribute list (for GetNextAttr()). */ + unsigned char TargetMethodIndex; /* An index into an method list (for GetNextMethod()). */ + } + DriverData, *pDriverData; + +/** Query instance data. **/ +typedef struct + { + pDriverData DriverData; /* The associated driver instance being queried. */ + unsigned int RowIndex; /* The selected row of the data targetted by the driver. */ + } + ClusterQuery, *pClusterQuery; + +/** Global storage for caches. **/ +struct + { + XHashTable SourceCache; + XHashTable ClusterCache; + XHashTable SearchCache; + } + ClusterCaches; + + +/** ================ Function Declarations ================ **/ +/** ANCHOR[id=functions] **/ + +/** Note: ci stands for "cluster_internal". **/ + +/** Parsing Functions. **/ +// LINK #parsing +int ci_ParseAttribute(pStructInf inf, char* attr_name, int datatype, pObjData data, pParamObjects param_list, bool required, bool print_type_error); +ClusterAlgorithm ci_ParseClusteringAlgorithm(pStructInf cluster_inf, pParamObjects param_list); +SimilarityMeasure ci_ParseSimilarityMeasure(pStructInf cluster_inf, pParamObjects param_list); +pSourceData ci_ParseSourceData(pStructInf inf, pParamObjects param_list, char* path); +pClusterData ci_ParseClusterData(pStructInf inf, pNodeData node_data); +pSearchData ci_ParseSearchData(pStructInf inf, pNodeData node_data); +pNodeData ci_ParseNodeData(pStructInf inf, pObject obj); + +/** Freeing Functions. **/ +// LINK #freeing +void ci_FreeSourceData(pSourceData source_data); +void ci_FreeClusterData(pClusterData cluster_data, bool recursive); +void ci_FreeSearchData(pSearchData search_data); +void ci_FreeNodeData(pNodeData node_data); + +/** Deep Size Computation Functions. **/ +// LINK #sizing +unsigned int ci_SizeOfSourceData(pSourceData source_data); +unsigned int ci_SizeOfClusterData(pClusterData cluster_data, bool recursive); +unsigned int ci_SizeOfSearchData(pSearchData search_data); +unsigned int ci_SizeOfNodeData(pNodeData node_data); + +/** Cache Invalidation Functions. **/ +// LINK #invalidation +void ci_CacheFreeSourceData(pXHashEntry entry, void* _); +void ci_CacheFreeCluster(pXHashEntry entry, void* _); +void ci_CacheFreeSearch(pXHashEntry entry, void* _); + +/** Computation Functions. (Ensure data is computed.) **/ +// LINK #computation +int ci_ComputeSourceData(pSourceData source_data, pObjSession session); +int ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data); +int ci_ComputeSearchData(pSearchData search_data, pNodeData node_data); + +/** Parameter Functions. **/ +// LINK #params +int ci_GetParamType(void* inf_v, const char* attr_name); +int ci_GetParamValue(void* inf_v, char* attr_name, int datatype, pObjData val); +int ci_SetParamValue(void* inf_v, char* attr_name, int datatype, pObjData val); + +/** Driver Functions. **/ +// LINK #driver +void* clusterOpen(pObject obj, int mask, pContentType systype, char* usr_type, pObjTrxTree* oxt); +int clusterClose(void* inf_v, pObjTrxTree* oxt); +void* clusterOpenQuery(void* inf_v, pObjQuery query, pObjTrxTree* oxt); +void* clusterQueryFetch(void* qy_v, pObject obj, int mode, pObjTrxTree* oxt); +int clusterQueryClose(void* qy_v, pObjTrxTree* oxt); +int clusterGetAttrType(void* inf_v, char* attr_name, pObjTrxTree* oxt); +int clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val, pObjTrxTree* oxt); +char* clusterGetFirstAttr(void* inf_v, pObjTrxTree oxt); +char* clusterGetNextAttr(void* inf_v, pObjTrxTree oxt); +int clusterInfo(void* inf_v, pObjectInfo info); + +/** Method Execution Functions. **/ +// LINK #method +char* clusterGetFirstMethod(void* inf_v, pObjTrxTree oxt); +char* clusterGetNextMethod(void* inf_v, pObjTrxTree oxt); +int clusterExecuteMethod(void* inf_v, char* methodname, pObjData param, pObjTrxTree oxt); + +/** Unimplemented DriverFunctions. **/ +// LINK #unimplemented +int clusterCreate(pObject obj, int mask, pContentType systype, char* usrtype, pObjTrxTree* oxt); +int clusterDeleteObj(void* inf_v, pObjTrxTree* oxt); +int clusterDelete(pObject obj, pObjTrxTree* oxt); +int clusterRead(void* inf_v, char* buffer, int maxcnt, int offset, int flags, pObjTrxTree* oxt); +int clusterWrite(void* inf_v, char* buffer, int cnt, int offset, int flags, pObjTrxTree* oxt); +int clusterSetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val, pObjTrxTree oxt); +int clusterAddAttr(void* inf_v, char* attr_name, int type, pObjData val, pObjTrxTree oxt); +void* clusterOpenAttr(void* inf_v, char* attr_name, int mode, pObjTrxTree oxt); +int clusterCommit(void* inf_v, pObjTrxTree *oxt); +pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pObjTrxTree* oxt); + +/** ================ Parsing Functions ================ **/ +/** ANCHOR[id=parsing] **/ +// LINK #functions + +/*** Returns 0 for success and -1 on failure. Promises that mssError() will be + *** invoked on failure, so the caller need not specify their own error message. + *** Returns 1 if attribute is available, printing an error if the attribute was + *** marked as required. + *** + *** @attention - Promises that mssError() will be invoked on failure, so the + *** caller is not required to specify their own error message. + *** + *** TODO: Greg + *** This function took several hours of debugging before it worked at all, and I + *** still don't know if it works correctly... or really how it works. Please + *** review this code carefully! + ***/ +int ci_ParseAttribute( + pStructInf inf, + char* attr_name, + int datatype, + pObjData data, + pParamObjects param_list, + bool required, + bool print_type_error) + { + int ret; + + /** Get attribute name. **/ + pStructInf attr_info = stLookup(inf, attr_name); + if (attr_info == NULL) + { + if (required) mssErrorf(1, "Cluster", "'%s' must be specified for clustering.", attr_name); + return 1; + } + ASSERTMAGIC(attr_info, MGK_STRUCTINF); + + /** Get the attribute. **/ + tprintf("Invoking ci_ParseAttribute('%s')...\n", attr_name); + pExpression exp = check_ptr(stGetExpression(attr_info, 0)); + expBindExpression(exp, param_list, EXPR_F_RUNSERVER); + ret = expEvalTree(exp, param_list); + if (ret != 0) + { + mssErrorf(0, "Cluster", "Expression evaluation failed."); + goto err; + } + + /** Check for data type mismatch. **/ + if (datatype != exp->DataType) + { + mssErrorf(1, "Cluster", + "Expected \"%s\" : %s, but got type %s.", + attr_name, ci_TypeToStr(datatype), ci_TypeToStr(exp->DataType) + ); + goto err; + } + + /** Get the data out of the expression. **/ + ret = expExpressionToPod(exp, datatype, data); + if (ret != 0) + { + mssErrorf(1, "Cluster", + "Failed to get data of type \"%s\" from exp \"%s\" (error code %d).", + ci_TypeToStr(datatype), exp->Name, ret + ); + goto err; + } + +// const int ret = stGetAttrValueOSML( +// attr_info, +// datatype, +// data, +// 0, +// param_list->Session, +// param_list +// ); +// if (ret == 1) +// { +// mssErrorf(1, "Cluster", +// "stGetAttrValueOSML('%s') because %s cannot be null.\n" +// " > Hint: You might have used an undefined variable or forgot to add runserver().", +// attr_name, attr_name +// ); +// return 1; +// } +// if (ret != 0) +// { +// if (print_type_error) +// { +// mssErrorf(1, "Cluster", +// "stGetAttrValueOSML('%s') failed (error code %d).\n" +// " > Hint: It might be a type mismatch, or you used an undefined variable.", +// attr_name, ret +// ); +// } +// return ret; +// } + + return 0; + + err: + mssErrorf(0, "Cluster", + "Failed to parse attribute \"%s\" from group \"%s\"", + attr_name, inf->Name + ); + return -1; + } + + +/*** Parses a ClusteringAlgorithm from the algorithm field in the pStructInf + *** representing some structure with that attribute in a parsed structure file. + *** + *** @attention - Promises that mssError() will be invoked on failure, so the + *** caller is not required to specify their own error message. + *** + *** @param inf A parsed pStructInf. + *** @param param_list The param objects that function as a kind of "scope" for + *** evaluating parameter variables in the structure file. + *** @returns The data algorithm, or ALGORITHM_NULL on failure. + ***/ +ClusterAlgorithm ci_ParseClusteringAlgorithm(pStructInf inf, pParamObjects param_list) + { + /** Get the algorithm attribute. **/ + char* algorithm; + if (ci_ParseAttribute(inf, "algorithm", DATA_T_STRING, POD(&algorithm), param_list, true, true) != 0) + { + mssErrorf(0, "Cluster", "Failed to parse attribute 'algorithm' in group \"%s\".", inf->Name); + return ALGORITHM_NULL; + } + + /** Parse known clustering algorithms. **/ + if (!strcasecmp(algorithm, "none")) return ALGORITHM_NONE; + if (!strcasecmp(algorithm, "sliding-window")) return ALGORITHM_SLIDING_WINDOW; + if (!strcasecmp(algorithm, "k-means")) return ALGORITHM_KMEANS; + if (!strcasecmp(algorithm, "k-means++")) return ALGORITHM_KMEANS_PLUS_PLUS; + if (!strcasecmp(algorithm, "k-medoids")) return ALGORITHM_KMEDOIDS; + if (!strcasecmp(algorithm, "db-scan")) return ALGORITHM_DB_SCAN; + + /** Unknown value for clustering algorithm. **/ + mssErrorf(1, "Cluster", "Unknown \"clustering algorithm\": %s", algorithm); + return ALGORITHM_NULL; + } + + +/*** Parses a SimilarityMeasure from the similarity_measure field in the given + *** pStructInf parameter, which represents some structure with that attribute + *** in a parsed structure file. + *** + *** @attention - Promises that mssError() will be invoked on failure, so the + *** caller is not required to specify their own error message. + *** + *** @param inf A parsed pStructInf. + *** @param param_list The param objects that function as a kind of "scope" for + *** evaluating parameter variables in the structure file. + *** @returns The similarity measure, or SIMILARITY_NULL on failure. + ***/ +SimilarityMeasure ci_ParseSimilarityMeasure(pStructInf inf, pParamObjects param_list) + { + /** Get the similarity_measure attribute. **/ + char* measure; + if (ci_ParseAttribute(inf, "similarity_measure", DATA_T_STRING, POD(&measure), param_list, true, true) != 0) + { + mssErrorf(0, "Cluster", "Failed to parse attribute 'similarity_measure' in group \"%s\".", inf->Name); + return SIMILARITY_NULL; + } + + /** Parse known clustering algorithms. **/ + if (!strcasecmp(measure, "cosine")) return SIMILARITY_COSINE; + if (!strcasecmp(measure, "levenshtein")) return SIMILARITY_LEVENSHTEIN; + + mssErrorf(1, "Cluster", "Unknown \"similarity measure\": %s", measure); + return SIMILARITY_NULL; + } + + +/*** Allocates a new pSourceData struct from a parsed pStructInf representing + *** a .cluster structure file. + *** + *** @attention - Warning: Caching in use. + *** @attention - Promises that mssError() will be invoked on failure, so the + *** caller is not required to specify their own error message. + *** + *** @param inf A parsed pStructInf for a .cluster structure file. + *** @param param_list The param objects that function as a kind of "scope" for + *** evaluating parameter variables in the structure file. + *** @param path The file path to the parsed structure file, used to generate + *** cache entry keys. + *** @returns A new pSourceData struct on success, or NULL on failure. + ***/ +pSourceData ci_ParseSourceData(pStructInf inf, pParamObjects param_list, char* path) + { + char* buf; + + /** Get source. **/ + if (ci_ParseAttribute(inf, "source", DATA_T_STRING, POD(&buf), param_list, true, true) != 0) goto err; + char* source_path = check_ptr(strdup(buf)); + + /** Get attribute name. **/ + if (ci_ParseAttribute(inf, "attr_name", DATA_T_STRING, POD(&buf), param_list, true, true) != 0) goto err; + char* attr_name = check_ptr(strdup(buf)); + + /** Create cache entry key. **/ + const size_t len = strlen(path) + strlen(source_path) + strlen(attr_name) + 3lu; + char* key = check_ptr(nmSysMalloc(len * sizeof(char))); + snprintf(key, len, "%s?%s:%s", path, source_path, attr_name); + pXHashTable source_cache = &ClusterCaches.SourceCache; + + /** Check for a cached version. **/ + pSourceData source_maybe = (pSourceData)xhLookup(source_cache, key); + if (source_maybe != NULL) + { + /** Cache hit. **/ + tprintf("# source: \"%s\"\n", key); + tprintf("--> Name: %s\n", source_maybe->Name); /* Cause invalid read if cache was incorrectly freed. */ + + /** Free data we don't need. */ + free(source_path); + free(attr_name); + nmSysFree(key); + + /** Return the cached source data. **/ + return source_maybe; + } + + /** Cache miss: Create a new source data object. **/ + pSourceData source_data = check_ptr(nmMalloc(sizeof(SourceData))); + memset(source_data, 0, sizeof(SourceData)); + source_data->Name = check_ptr(strdup(inf->Name)); + source_data->Key = key; + source_data->SourcePath = source_path; + source_data->AttrName = attr_name; + + /** Add the new object to the cache for next time. **/ + tprintf("+ source: \"%s\"\n", key); + check(xhAdd(source_cache, key, (void*)source_data)); + + return source_data; + + err: + mssErrorf(0, "Cluster", "Failed to parse source data from group \"%s\" in file: %s", inf->Name, path); + return NULL; + } + + +/*** Allocates a new pClusterData struct from a parsed pStructInf. + *** + *** @attention - Warning: Caching in use. + *** @attention - Promises that mssError() will be invoked on failure, so the + *** caller is not required to specify their own error message. + *** + *** @param inf A parsed pStructInf for a cluster group in a structure file. + *** @param param_list The param objects that function as a kind of "scope" for + *** evaluating parameter variables in the structure file. + *** @param source_data The pSourceData that clusters are to be built from, also + *** used to generate cache entry keys. + *** @returns A new pClusterData struct on success, or NULL on failure. + ***/ +pClusterData ci_ParseClusterData(pStructInf inf, pNodeData node_data) + { + int result; + + tprintf("Parsing cluster: %s\n", inf->Name); + + pParamObjects param_list = node_data->ParamList; + pSourceData source_data = node_data->SourceData; + + /** Allocate space for data struct. **/ + pClusterData cluster_data = check_ptr(nmMalloc(sizeof(ClusterData))); + memset(cluster_data, 0, sizeof(ClusterData)); + + /** Basic Properties. **/ + cluster_data->Name = check_ptr(strdup(inf->Name)); + cluster_data->SourceData = source_data; + + /** Get algorithm. **/ + cluster_data->ClusterAlgorithm = ci_ParseClusteringAlgorithm(inf, param_list); + if (cluster_data->ClusterAlgorithm == ALGORITHM_NULL) goto err; + + /** Handle no clustering case. **/ + if (cluster_data->ClusterAlgorithm == ALGORITHM_NONE) + { + cluster_data->NumClusters = 1u; + goto parsing_done; + } + + /** Get similarity_measure. **/ + cluster_data->SimilarityMeasure = ci_ParseSimilarityMeasure(inf, param_list); + if (cluster_data->SimilarityMeasure == SIMILARITY_NULL) goto err_free_cluster; + + /** Handle sliding window case. **/ + if (cluster_data->ClusterAlgorithm == ALGORITHM_SLIDING_WINDOW) + goto parsing_done; + + /** Get num_clusters. **/ + int num_clusters; + if (ci_ParseAttribute(inf, "num_clusters", DATA_T_INTEGER, POD(&num_clusters), param_list, true, true) != 0) goto err_free_cluster; + if (num_clusters < 2) + { + mssErrorf(1, "Cluster", "Invalid value for [num_clusters : uint > 1]: %d", num_clusters); + if (num_clusters == 1) fprintf(stderr, "HINT: Use algorithm=\"none\" to disable clustering.\n"); + goto err_free_cluster; + } + cluster_data->NumClusters = (unsigned int)num_clusters; + tprintf("Got value for num_clusters: %d\n", num_clusters); + + /** Get min_improvement. **/ + double improvement; + result = ci_ParseAttribute(inf, "min_improvement", DATA_T_DOUBLE, POD(&improvement), param_list, false, false); + if (result == 1) cluster_data->MinImprovement = DEFAULT_MIN_IMPROVEMENT; + else if (result == 0) + { + if (improvement <= 0.0 || 1.0 <= improvement) + { + mssErrorf(1, "Cluster", "Invalid value for [min_improvement : 0.0 < x < 1.0 | \"none\"]: %g", improvement); + goto err_free_cluster; + } + cluster_data->MinImprovement = improvement; + } + else if (result == -1) + { + char* str; + result = ci_ParseAttribute(inf, "min_improvement", DATA_T_STRING, POD(&str), param_list, false, true); + if (result == 0 && !strcasecmp(str, "none")) + { + /** Specify no min improvement. **/ + cluster_data->MinImprovement = -INFINITY; + } + } + if (result == -1) goto err_free_cluster; + + /** Get max_iterations. **/ + int max_iterations; + result = ci_ParseAttribute(inf, "max_iterations", DATA_T_INTEGER, POD(&max_iterations), param_list, false, true); + if (result == -1) goto err_free_cluster; + if (result == 0) + { + if (max_iterations < 0) + { + mssErrorf(1, "Cluster", "Invalid value for [max_iterations : uint]: %d", max_iterations); + goto err_free_cluster; + } + cluster_data->MaxIterations = (unsigned int)max_iterations; + } + else cluster_data->MaxIterations = DEFAULT_MAX_ITERATIONS; + + /** Search for sub-clusters. **/ + XArray sub_clusters; + const int ret = xaInit(&sub_clusters, 4u); + if (ret != 0) + { + mssErrorf(1, "Cluster", "FAIL - xaInit(&sub_clusters, %u): %d", 4u, ret); + goto err_free_cluster; + } + for (unsigned int i = 0u; i < inf->nSubInf; i++) + { + /** Check that this is a group (not an attribute). **/ + pStructInf group_inf = inf->SubInf[i]; + ASSERTMAGIC(group_inf, MGK_STRUCTINF); + if (stStructType(group_inf) != ST_T_SUBGROUP) continue; + + /** Select array by group type. **/ + assert(group_inf->UsrType != NULL); + if (strcmp(group_inf->UsrType, "cluster/cluster")) continue; + + /** Subcluster found. **/ + pClusterData sub_cluster = ci_ParseClusterData(group_inf, node_data); + if (sub_cluster == NULL) goto err_free_sub_clusters; + sub_cluster->Parent = cluster_data; + xaAddItem(&sub_clusters, sub_cluster); + } + cluster_data->nSubClusters = sub_clusters.nItems; + cluster_data->SubClusters = (cluster_data->nSubClusters > 0u) ? + (pClusterData*)ci_xaToTrimmedArray(&sub_clusters) + : NULL; /* No sub-clusters. */ + xaDeInit(&sub_clusters); + + /** Create the cache key. **/ + parsing_done:; + char* key; + switch (cluster_data->ClusterAlgorithm) + { + case ALGORITHM_NONE: + { + const size_t len = strlen(source_data->Key) + strlen(cluster_data->Name) + 5lu; + key = nmSysMalloc(len * sizeof(char)); + snprintf(key, len, "%s/%s?%u", + source_data->Key, + cluster_data->Name, + ALGORITHM_NONE + ); + break; + } + + case ALGORITHM_SLIDING_WINDOW: + { + const size_t len = strlen(source_data->Key) + strlen(cluster_data->Name) + 8lu; + key = nmSysMalloc(len * sizeof(char)); + snprintf(key, len, "%s/%s?%u&%u", + source_data->Key, + cluster_data->Name, + ALGORITHM_SLIDING_WINDOW, + cluster_data->SimilarityMeasure + ); + break; + } + + default: + { + const size_t len = strlen(source_data->Key) + strlen(cluster_data->Name) + 32lu; + key = nmSysMalloc(len * sizeof(char)); + snprintf(key, len, "%s/%s?%u&%u&%u&%g&%u", + source_data->Key, + cluster_data->Name, + cluster_data->ClusterAlgorithm, + cluster_data->SimilarityMeasure, + cluster_data->NumClusters, + cluster_data->MinImprovement, + cluster_data->MaxIterations + ); + break; + } + } + pXHashTable cluster_cache = &ClusterCaches.ClusterCache; + cluster_data->Key = key; + + /** Check for a cached version. **/ + pClusterData cluster_maybe = (pClusterData)xhLookup(cluster_cache, key); + if (cluster_maybe != NULL) + { + /** Cache hit. **/ + tprintf("# cluster: \"%s\"\n", key); + tprintf("--> Name: %s\n", cluster_maybe->Name); /* Cause invalid read if cache was incorrectly freed. */ + + /** Free the parsed cluster that we no longer need. */ + ci_FreeClusterData(cluster_data, false); + nmSysFree(key); + + /** Return the cached cluster. **/ + return cluster_maybe; + } + + /** Cache miss. **/ + tprintf("+ cluster: \"%s\"\n", key); + check(xhAdd(cluster_cache, key, (void*)cluster_data)); + return cluster_data; + + /** Error cleanup. **/ + err_free_sub_clusters: + for (unsigned int i = 0u; i < sub_clusters.nItems; i++) + ci_FreeClusterData(sub_clusters.Items[i], true); + xaDeInit(&sub_clusters); + + err_free_cluster: + nmFree(cluster_data, sizeof(ClusterData)); + + err: + mssErrorf(0, "Cluster", "Failed to parse cluster from group \"%s\".", inf->Name); + return NULL; + } + + +/*** Allocates a new pSearchData struct from a parsed pStructInf. + *** + *** @attention - Warning: Caching in use. + *** @attention - Promises that mssError() will be invoked on failure, so the + *** caller is not required to specify their own error message. + *** + *** @param inf A parsed pStructInf for a search group in a structure file. + *** @param param_list The param objects that function as a kind of "scope" for + *** evaluating parameter variables in the structure file. + *** @param node_data The pNodeData, used to get the param list and to look up + *** the cluster pointed to by the source attribute. + *** @returns A new pSearchData struct on success, or NULL on failure. + ***/ +pSearchData ci_ParseSearchData(pStructInf inf, pNodeData node_data) + { + tprintf("Parsing search: %s\n", inf->Name); + + /** Allocate space for search struct. **/ + pSearchData search_data = nmMalloc(sizeof(SearchData)); + assert(search_data != NULL); + memset(search_data, 0, sizeof(SearchData)); + + /** Get search name. **/ + search_data->Name = check_ptr(strdup(inf->Name)); + + /** Get source. **/ + char* source_name; + if (ci_ParseAttribute(inf, "source", DATA_T_STRING, POD(&source_name), node_data->ParamList, true, true) != 0) return NULL; + for (unsigned int i = 0; i < node_data->nClusters; i++) + { + pClusterData cluster_data = node_data->Clusters[i]; + if (strcmp(source_name, cluster_data->Name) == 0) + { + /** Source found. **/ + search_data->Source = cluster_data; + break; + } + + /** Note: Subclusters not implemented here. **/ + } + if (search_data->Source == NULL) + { + mssErrorf(1, "Cluster", "Could not find cluster %s for search %s.", source_name, search_data->Name); + goto err_free_search; + } + + /** Get threshold attribute. **/ + if (ci_ParseAttribute(inf, "threshold", DATA_T_DOUBLE, POD(&search_data->Threshold), node_data->ParamList, true, true) != 0) goto err_free_search; + if (search_data->Threshold <= 0.0 || 1.0 <= search_data->Threshold) + { + mssErrorf(1, "Cluster", + "Invalid value for [threshold : 0.0 < x < 1.0 | \"none\"]: %g", + search_data->Threshold + ); + goto err_free_search; + } + + /** Get similarity measure. **/ + search_data->SimilarityMeasure = ci_ParseSimilarityMeasure(inf, node_data->ParamList); + if (search_data->SimilarityMeasure == SIMILARITY_NULL) goto err_free_search; + + /** Create cache entry key. **/ + char* source_key = search_data->Source->Key; + const size_t len = strlen(source_key) + strlen(search_data->Name) + 16lu; + char* key = nmSysMalloc(len * sizeof(char)); + snprintf(key, len, "%s/%s?%g&%u", + source_key, + search_data->Name, + search_data->Threshold, + search_data->SimilarityMeasure + ); + pXHashTable search_cache = &ClusterCaches.SearchCache; + + /** Check for a cached version. **/ + pSearchData search_maybe = (pSearchData)xhLookup(search_cache, key); + if (search_maybe != NULL) + { + /** Cache hit. **/ + tprintf("# search: \"%s\"\n", key); + tprintf("--> Name: %s\n", search_maybe->Name); /* Cause invalid read if cache was incorrectly freed. */ + + /** Free the parsed search that we no longer need. */ + ci_FreeSearchData(search_data); + nmSysFree(key); + + /** Return the cached search. **/ + return search_maybe; + } + + /** Cache miss. **/ + tprintf("+ search: \"%s\"\n", key); + check(xhAdd(search_cache, key, (void*)search_data)); + return search_data; + + err_free_search: + ci_FreeSearchData(search_data); + mssErrorf(0, "Cluster", "Failed to parse search from group \"%s\".", inf->Name); + return NULL; + } + + +/*** Allocates a new pNodeData struct from a parsed pStructInf. + *** + *** @attention - Does not use caching directly, but uses subfunctions to + *** handle caching of substructures. + *** @attention - Promises that mssError() will be invoked on failure, so the + *** caller is not required to specify their own error message. + *** + *** @param inf A parsed pStructInf for the top level group in a .cluster + *** structure file. + *** @param obj The parent object struct. + *** @returns A new pNodeData struct on success, or NULL on failure. + ***/ +pNodeData ci_ParseNodeData(pStructInf inf, pObject obj) + { + int ret; + + /** Retrieve path so we'll know we have it later. **/ + char* path = obj_internal_PathPart(obj->Pathname, 0, obj->SubPtr); + + /** Allocate node struct data. **/ + // pNodeData node_data = NodeData |> sizeof() |> nmMalloc() |> check_ptr(); + pNodeData node_data = check_ptr(nmMalloc(sizeof(NodeData))); + memset(node_data, 0, sizeof(NodeData)); + node_data->Obj = obj; + + /** Set up param list. **/ + node_data->ParamList = check_ptr(expCreateParamList()); + node_data->ParamList->Session = obj->Session; + ret = expAddParamToList(node_data->ParamList, "parameters", (void*)node_data, 0); + if (ret != 0) + { + mssErrorf(0, "Cluster", "Failed to add parameters to the param list scope (error code %d).", ret); + goto err_free_node; + } + + /** Set the param functions, defined later in the file. **/ + ret = expSetParamFunctions( + node_data->ParamList, + "parameters", + ci_GetParamType, + ci_GetParamValue, + ci_SetParamValue + ); + if (ret != 0) + { + mssErrorf(0, "Cluster", "Failed to set param functions (error code %d).", ret); + goto err_free_node; + } + + /** Detect relevant groups. **/ + XArray param_infs, cluster_infs, search_infs; + check(xaInit(¶m_infs, 8)); + check(xaInit(&cluster_infs, 8)); + check(xaInit(&search_infs, 8)); + for (unsigned int i = 0u; i < inf->nSubInf; i++) + { + /** Check that this is a group (not an attribute). **/ + pStructInf group_inf = inf->SubInf[i]; + ASSERTMAGIC(group_inf, MGK_STRUCTINF); + if (stStructType(group_inf) != ST_T_SUBGROUP) continue; + + /** Select array by group type. **/ + const char* group_type = group_inf->UsrType; + if (strcmp(group_type, "cluster/parameter") == 0) check_strict(xaAddItem(¶m_infs, group_inf)); + else if (strcmp(group_type, "cluster/cluster") == 0) check_strict(xaAddItem(&cluster_infs, group_inf)); + else if (strcmp(group_type, "cluster/search") == 0) check_strict(xaAddItem(&search_infs, group_inf)); + else + { + mssErrorf(1, "Cluster", + "Unkown group type \"%s\" on group \"%s\".", + group_type, group_inf->Name + ); + goto err_free_arrs; + } + } + + /** Extract OpenCtl for use below. **/ + bool has_provided_params = obj != NULL + && obj->Pathname != NULL + && obj->Pathname->OpenCtl != NULL + && obj->Pathname->OpenCtl[obj->SubPtr - 1] != NULL + && obj->Pathname->OpenCtl[obj->SubPtr - 1]->nSubInf > 0 + && obj->Pathname->OpenCtl[obj->SubPtr - 1]->SubInf != NULL; + int num_provided_params = (has_provided_params) ? obj->Pathname->OpenCtl[obj->SubPtr - 1]->nSubInf : 0; + pStruct* provided_params = (has_provided_params) ? obj->Pathname->OpenCtl[obj->SubPtr - 1]->SubInf : NULL; + + /** Itterate over each param in the structure file. **/ + node_data->nParams = param_infs.nItems; + const size_t params_size = node_data->nParams * sizeof(pParam); + node_data->Params = check_ptr(nmMalloc(params_size)); + memset(node_data->Params, 0, params_size); + for (unsigned int i = 0u; i < node_data->nParams; i++) + { + pParam param = paramCreateFromInf(param_infs.Items[i]); + if (param == NULL) + { + mssErrorf(0, "Cluster", + "Failed to create param from inf for param #%u: %s", + i, ((pStructInf)param_infs.Items[i])->Name + ); + goto err_free_arrs; + } + node_data->Params[i] = param; + + /** Check each provided param to see if the user provided value. **/ + for (unsigned int j = 0u; j < num_provided_params; j++) + { + pStruct provided_param = provided_params[j]; + if (provided_param == NULL) + { + mssErrorf(1, "Cluster", "Provided param struct cannot be NULL."); + fprintf(stderr, + "Debug info: obj->Pathname->OpenCtl[%d]->SubInf[%u] is NULL", + obj->SubPtr - 1, j + ); + goto err_free_arrs; + } + + /** If this provided param value isn't for the param, ignore it. **/ + if (strcmp(provided_param->Name, param->Name) != 0) continue; + + /** Matched! The user is providing a value for this param. **/ + ret = paramSetValueFromInfNe(param, provided_param, 0, node_data->ParamList, obj->Session); + if (ret != 0) + { + mssErrorf(0, "Cluster", + "Failed to set param value from struct info.\n" + " > Param #%u: %s\n" + " > Provided Param #%u: %n\n" + " > Error code: %d", + i, param->Name, + j, provided_param->Name, + ret + ); + goto err_free_arrs; + } + tprintf("Found provided value for %s, which is now %d\n", param->Name, param->Value->Data.Integer); + + /** Provided value successfully handled, we're done. **/ + break; + } + + /** Invoke param hints parsing. **/ + ret = paramEvalHints(param, node_data->ParamList, obj->Session); + if (ret != 0) + { + mssErrorf(0, "Cluster", + "Failed to evaluate parameter hints for parameter \"%s\" (error code %d).", + param->Name, ret + ); + goto err_free_arrs; + } + if (strcmp("k", param->Name) == 0) tprintf("Param k is now %d\n", param->Value->Data.Integer); + } + check(xaDeInit(¶m_infs)); + param_infs.nAlloc = 0; + + /** Parse source data. **/ + node_data->SourceData = ci_ParseSourceData(inf, node_data->ParamList, path); + if (node_data->SourceData == NULL) goto err_free_node; + + /** Parse each cluster. **/ + node_data->nClusters = cluster_infs.nItems; + if (node_data->nClusters > 0) + { + const size_t clusters_size = node_data->nClusters * sizeof(pClusterData); + node_data->Clusters = check_ptr(nmMalloc(clusters_size)); + memset(node_data->Clusters, 0, clusters_size); + for (unsigned int i = 0u; i < node_data->nClusters; i++) + { + node_data->Clusters[i] = ci_ParseClusterData(cluster_infs.Items[i], node_data); + if (node_data->Clusters[i] == NULL) goto err_free_arrs; + } + } + else node_data->Clusters = NULL; + check(xaDeInit(&cluster_infs)); + cluster_infs.nAlloc = 0; + + /** Parse each search. **/ + node_data->nSearches = search_infs.nItems; + if (node_data->nSearches > 0) + { + const size_t searches_size = node_data->nSearches * sizeof(pSearchData); + node_data->Searches = check_ptr(nmMalloc(searches_size)); + memset(node_data->Searches, 0, searches_size); + for (unsigned int i = 0u; i < node_data->nSearches; i++) + { + node_data->Searches[i] = ci_ParseSearchData(search_infs.Items[i], node_data); + if (node_data->Searches[i] == NULL) goto err_free_node; /* The XArrays are already freed. */ + } + } + else node_data->Searches = NULL; + check(xaDeInit(&search_infs)); + search_infs.nAlloc = 0; + + /** Success. **/ + return node_data; + + err_free_arrs: + if (param_infs.nAlloc != 0) check(xaDeInit(¶m_infs)); + if (cluster_infs.nAlloc != 0) check(xaDeInit(&cluster_infs)); + if (search_infs.nAlloc != 0) check(xaDeInit(&search_infs)); + + err_free_node: + ci_FreeNodeData(node_data); + mssErrorf(0, "Cluster", "Failed to parse node from group \"%s\" in file: %s", inf->Name, path); + return NULL; + } + + +/** ================ Freeing Functions ================ **/ +/** ANCHOR[id=freeing] **/ +// LINK #functions + +/** @param source_data A pSourceData struct, freed by this function. **/ +void ci_FreeSourceData(pSourceData source_data) + { + /** Free top level attributes, if they exist. **/ + if (source_data->Name != NULL) + { + free(source_data->Name); + source_data->Name = NULL; + } + if (source_data->SourcePath != NULL) + { + free(source_data->SourcePath); + source_data->SourcePath = NULL; + } + if (source_data->AttrName != NULL) + { + free(source_data->AttrName); + source_data->AttrName = NULL; + } + + /** Free fetched data, if it exists. **/ + if (source_data->Data != NULL) + { + for (unsigned int i = 0u; i < source_data->nVectors; i++) + free(source_data->Data[i]); + nmFree(source_data->Data, source_data->nVectors * sizeof(char*)); + source_data->Data = NULL; + } + + /** Free computed vectors, if they exist. **/ + if (source_data->Vectors != NULL) + { + for (unsigned int i = 0u; i < source_data->nVectors; i++) + ca_free_vector(source_data->Vectors[i]); + nmFree(source_data->Vectors, source_data->nVectors * sizeof(pVector)); + source_data->Vectors = NULL; + } + + /** Free the source_data struct. **/ + nmFree(source_data, sizeof(SourceData)); + } + + +/*** Free pClusterData struct with an option to recursively free subclusters. + *** + *** @param cluster_data The cluster data struct to free. + *** @param recrusive Whether to recursively free subclusters. + ***/ +void ci_FreeClusterData(pClusterData cluster_data, bool recursive) + { + /** Free top level cluster data. **/ + if (cluster_data->Name != NULL) free(cluster_data->Name); + + /** Free computed data, if it exists. **/ + if (cluster_data->Labels != NULL) + { + const unsigned int nVectors = cluster_data->SourceData->nVectors; + nmFree(cluster_data->Labels, nVectors * sizeof(unsigned int)); + } + + /** Free subclusters recursively. **/ + if (cluster_data->SubClusters != NULL) + { + if (recursive) + { + for (unsigned int i = 0u; i < cluster_data->nSubClusters; i++) + ci_FreeClusterData(cluster_data->SubClusters[i], recursive); + } + nmFree(cluster_data->SubClusters, cluster_data->nSubClusters * sizeof(void*)); + } + + /** Free the cluster struct. **/ + nmFree(cluster_data, sizeof(ClusterData)); + } + + +/** @param search_data A pSearchData struct, freed by this function. **/ +void ci_FreeSearchData(pSearchData search_data) + { + if (search_data->Name != NULL) free(search_data->Name); + if (search_data->Dups != NULL) + { + for (unsigned int i = 0; i < search_data->nDups; i++) + nmFree(search_data->Dups[i], sizeof(Dup)); + nmFree(search_data->Dups, search_data->nDups * sizeof(void*)); + } + nmFree(search_data, sizeof(SearchData)); + } + + +/** @param node_data A pNodeData struct, freed by this function. **/ +void ci_FreeNodeData(pNodeData node_data) + { + /** Free parsed params, if they exist. **/ + if (node_data->Params != NULL) + { + for (unsigned int i = 0u; i < node_data->nParams; i++) + { + if (node_data->Params[i] == NULL) break; + paramFree(node_data->Params[i]); + } + nmFree(node_data->Params, node_data->nParams * sizeof(pParam)); + } + if (node_data->ParamList != NULL) expFreeParamList(node_data->ParamList); + + /** Free parsed clusters, if they exist. **/ + if (node_data->Clusters != NULL) + { + /*** This data is cached, so we should NOT free it! + *** The caching system is responsible for the memory. + ***/ + nmFree(node_data->Clusters, node_data->nClusters * sizeof(pClusterData)); + node_data->Clusters = NULL; + } + + /** Free parsed searches, if they exist. **/ + if (node_data->Searches != NULL) + { + /*** This data is cached, so we should NOT free it! + *** The caching system is responsible for the memory. + ***/ + nmFree(node_data->Searches, node_data->nSearches * sizeof(pSearchData)); + node_data->Searches = NULL; + } + + /** Free data source, if one exists. **/ + /*** Note: SourceData is freed last since other free functions may need to + *** access information from this structure when freeing data. + *** (For example, nVector which is used to determine the size of the + *** label struct in each cluster.) + ***/ + if (node_data->SourceData != NULL) + { + /*** This data is cached, so we should NOT free it! + *** The caching system is responsible for the memory. + ***/ + node_data->SourceData = NULL; + } + + /** Free the node data. **/ + nmFree(node_data, sizeof(NodeData)); + } + +/** ================ Deep Size Computation Functions ================ **/ +/** ANCHOR[id=sizing] **/ +// LINK #functions + +/*** Returns the deep size of a SourceData struct, including the size of all + *** allocated substructures. As far as I can tell, this is probably only + *** useful for cache management and debugging. + *** + *** Note that Key is ignored because it is a pointer to data managed by the + *** caching systems, so it is not technically part of the struct. + *** + *** @param source_data The source data struct to be queried. + *** @returns The size in bytes of the struct and all internal allocated data. + ***/ +unsigned int ci_SizeOfSourceData(pSourceData source_data) + { + unsigned int size = 0u; + if (source_data->Name != NULL) size += strlen(source_data->Name) * sizeof(char); + if (source_data->SourcePath != NULL) size += strlen(source_data->SourcePath) * sizeof(char); + if (source_data->AttrName != NULL) size += strlen(source_data->AttrName) * sizeof(char); + if (source_data->Data != NULL) + { + for (unsigned int i = 0u; i < source_data->nVectors; i++) + size += strlen(source_data->Data[i]) * sizeof(char); + size += source_data->nVectors * sizeof(char*); + } + if (source_data->Vectors != NULL) + { + for (unsigned int i = 0u; i < source_data->nVectors; i++) + size += ca_sparse_len(source_data->Vectors[i]) * sizeof(int); + size += source_data->nVectors * sizeof(pVector); + } + size += sizeof(SourceData); + return size; + } + + +/*** Returns the deep size of a ClusterData struct, including the size of all + *** allocated substructures. As far as I can tell, this is probably only + *** useful for cache management and debugging. + *** + *** Note that Key is ignored because it is a pointer to data managed by the + *** caching systems, so it is not technically part of the struct. + *** + *** @param cluster_data The cluster data struct to be queried. + *** @param recrusive Whether to recursively free subclusters. + *** @returns The size in bytes of the struct and all internal allocated data. + ***/ +unsigned int ci_SizeOfClusterData(pClusterData cluster_data, bool recursive) + { + unsigned int size = 0u; + if (cluster_data->Name != NULL) size += strlen(cluster_data->Name) * sizeof(char); + if (cluster_data->Labels != NULL) size += cluster_data->SourceData->nVectors * sizeof(unsigned int); + if (cluster_data->SubClusters != NULL) + { + if (recursive) + { + for (unsigned int i = 0u; i < cluster_data->nSubClusters; i++) + size += ci_SizeOfClusterData(cluster_data->SubClusters[i], recursive); + } + size += cluster_data->nSubClusters * sizeof(void*); + } + size += sizeof(ClusterData); + return size; + } + + +/*** Returns the deep size of a SearchData struct, including the size of all + *** allocated substructures. As far as I can tell, this is probably only + *** useful for cache management and debugging. + *** + *** Note that Key is ignored because it is a pointer to data managed by the + *** caching systems, so it is not technically part of the struct. + *** + *** @param search_data The search data struct to be queried. + *** @returns The size in bytes of the struct and all internal allocated data. + ***/ +unsigned int ci_SizeOfSearchData(pSearchData search_data) + { + unsigned int size = 0u; + if (search_data->Name != NULL) size += strlen(search_data->Name) * sizeof(char); + if (search_data->Dups != NULL) size += search_data->nDups * (sizeof(void*) + sizeof(Dup)); + size += sizeof(SearchData); + return size; + } + + +/*** Returns the deep size of a NodeData struct, including the size of all + *** allocated substructures. As far as I can tell, this is probably only + *** useful for cache management and debugging. + *** + *** Note that Key is ignored because it is a pointer to data managed by the + *** caching systems, so it is not technically part of the struct. + *** + *** @param node_data The cluster data struct to be queried. + *** @returns The size in bytes of the struct and all internal allocated data. + ***/ +unsigned int ci_SizeOfNodeData(pNodeData node_data) + { + unsigned int size = 0u; + if (node_data->Params != NULL) + { + /** Approximate. **/ + size += node_data->nParams * (sizeof(Param) + sizeof(pParam)); + } + if (node_data->ParamList == NULL) + { + /** Approximate. **/ + size += node_data->nParams * 30u * sizeof(char); + size += sizeof(pParamObjects); + } + if (node_data->Clusters != NULL) + { + /** Note: This data is also stored in a cache. **/ + for (unsigned int i = 0u; i < node_data->nClusters; i++) + size += ci_SizeOfClusterData(node_data->Clusters[i], true); + size += node_data->nClusters * sizeof(pClusterData); + } + if (node_data->Searches != NULL) + { + /** Note: This data is also stored in a cache. **/ + for (unsigned int i = 0u; i < node_data->nSearches; i++) + size += ci_SizeOfSearchData(node_data->Searches[i]); + size += node_data->nSearches * sizeof(pSearchData); + } + if (node_data->SourceData != NULL) + { + /** Note: This data is also stored in a cache. **/ + size += ci_SizeOfSourceData(node_data->SourceData); + } + size += sizeof(NodeData); + return size; + } + + +/** ================ Cache Invalidation Functions ================ **/ +/** ANCHOR[id=invalidation] **/ +// LINK #functions + +/** Intended for use in xhClearKeySafe(). **/ +void ci_CacheFreeSourceData(pXHashEntry entry, void* _) + { + /** Extract hash entry. **/ + char* key = entry->Key; + pSourceData source_data = (pSourceData)entry->Data; + + /** Free data. **/ + tprintf("- source: \"%s\"\n", key); + ci_FreeSourceData(source_data); + nmSysFree(key); + } + +/** Intended for use in xhClearKeySafe(). **/ +void ci_CacheFreeCluster(pXHashEntry entry, void* _) + { + /** Extract hash entry. **/ + char* key = entry->Key; + pClusterData cluster_data = (pClusterData)entry->Data; + + /** Free data. **/ + tprintf("- cluster: \"%s\"\n", key); + ci_FreeClusterData(cluster_data, false); + nmSysFree(key); + } + +/** Intended for use in xhClearKeySafe(). **/ +void ci_CacheFreeSearch(pXHashEntry entry, void* _) + { + /** Extract hash entry. **/ + char* key = entry->Key; + pSearchData search_data = (pSearchData)entry->Data; + + /** Free data. **/ + tprintf("- search: \"%s\"\n", key); + ci_FreeSearchData(search_data); + nmSysFree(key); + } + +/** ================ Computation Functions ================ **/ +/** ANCHOR[id=computation] **/ +// LINK #functions + +/*** Ensures that the source_data->Data has been fetched from the data source + *** and that source_data->nVectors has been computed from the fetched data. + *** + *** @attention - Promises that mssError() will be invoked on failure, so the + *** caller is not required to specify their own error message. + *** + *** @param source_data The pSourceData affected by the computation. + *** @param session The current session, used to open the data source. + *** @returns 0 if successful, or + *** -1 other value on failure. + ***/ +int ci_ComputeSourceData(pSourceData source_data, pObjSession session) + { + /** If the vectors are already computed, we're done. **/ + if (source_data->Vectors != NULL) return 0; + + /** Handle error case that happens if memory optimizations break. **/ + if (source_data->Data != NULL) + { + /*** We have data, but not vectors, which means that this function ran + *** before, but the vectors were cleared by ci_GCSourceData(). This + *** should only happen if the vectors will not be needed again. Thus, + *** clearly something has gone wrong. + ***/ + fprintf(stderr, "ERROR:" + "\tci_computeSourceData() invoked on source data \"%s\" where\n" + "\tvectors were previously freed. There is likely a bug in\n" + "\tci_GCSourceData() which caused it to free vectors when we\n" + "\tstill needed them.\n", + source_data->Name + ); + fprintf(stderr, "Resolution:\n" + "\tThe original data will be dropped and refetched, and the\n" + "\tthe vectors will be recomputed, avoiding possible issues\n" + "\tfrom stale data.\n" + ); + + /** Drop source_data->Data. **/ + for (unsigned int i = 0u; i < source_data->nVectors; i++) + free(source_data->Data[i]); + nmFree(source_data->Data, source_data->nVectors * sizeof(char*)); + source_data->Data = NULL; + source_data->nVectors = 0; + } + + /** Time to play shoots-and-ladders in an error-handling jungle of gotos. **/ + bool successful = false; + int ret; + + /** Open the source path specified by the .cluster file. **/ + tprintf("Openning...\n"); + pObject obj = objOpen(session, source_data->SourcePath, OBJ_O_RDONLY, 0600, "system/directory"); + if (obj == NULL) + { + mssErrorf(0, "Cluster", + "Failed to open object driver:" + " > Attribute: \"%s\" : String\n" + " > Source Path: %s", + source_data->AttrName, + source_data->SourcePath + ); + successful = false; + goto end; + } + + /** Generate a "query" for retrieving data. **/ + tprintf("Openning query...\n"); + pObjQuery query = objOpenQuery(obj, NULL, NULL, NULL, NULL, 0); + if (query == NULL) + { + mssErrorf(0, "Cluster", + "Failed to open query:\n" + " > Attribute: \"%s\" : String\n" + " > Driver Used: %s\n" + " > Source Path: %s", + source_data->AttrName, + obj->Driver->Name, + source_data->SourcePath + ); + successful = false; + goto end_close; + } + + /** Initialize an xarray to store the retrieved data. **/ + XArray data_xarray, vector_xarray; + check(xaInit(&data_xarray, 64)); + check(xaInit(&vector_xarray, 64)); + + /** Fetch data and build vectors. **/ + tprintf("Skips: "); + unsigned int i = 0u; + while (true) + { + pObject entry = objQueryFetch(query, O_RDONLY); + if (entry == NULL) break; /* Done. */ + + /** Type checking. **/ + const int datatype = objGetAttrType(entry, source_data->AttrName); + if (datatype == -1) + { + mssErrorf(0, "Cluster", + "Failed to get type for %uth entry:\n" + " > Attribute: \"%s\" : String\n" + " > Driver Used: %s\n" + " > Source Path: %s", + i, + source_data->AttrName, + obj->Driver->Name, + source_data->SourcePath + ); + goto end_free_data; + } + if (datatype != DATA_T_STRING) + { + mssErrorf(1, "Cluster", + "Type for %uth entry was not a string:\n" + " > Attribute: \"%s\" : %s!!\n" + " > Driver Used: %s\n" + " > Source Path: %s", + i, + source_data->AttrName, ci_TypeToStr(datatype), + obj->Driver->Name, + source_data->SourcePath + ); + goto end_free_data; + } + + /** Get value from database. **/ + char* val; + ret = objGetAttrValue(entry, source_data->AttrName, DATA_T_STRING, POD(&val)); + if (ret != 0) + { + tprintf("\n"); + mssErrorf(0, "Cluster", + "Failed to value for %uth entry:\n" + " > Attribute: \"%s\" : String\n" + " > Driver Used: %s\n" + " > Source Path: %s\n" + " > Error code: %d", + i, + source_data->AttrName, + obj->Driver->Name, + source_data->SourcePath, + ret + ); + successful = false; + goto end_free_data; + } + + /** Skip empty strings. **/ + if (strlen(val) == 0) + { + tprintf("_"); + check(fflush(stdout)); + continue; + } + + /** Convert the string to a vector. **/ + pVector vector = ca_build_vector(val); + if (vector == NULL) + { + mssErrorf(1, "Cluster", "Failed to build vectors for string \"%s\".", val); + successful = false; + goto end_free_data; + } + if (vector[0] == -CA_NUM_DIMS) + { + mssErrorf(1, "Cluster", "Vector building for string \"%s\" produced no character pairs.", val); + successful = false; + goto end_free_data; + } + if (vector[0] == -172 && vector[1] == 11 && vector[2] == -78) + { + /** Skip pVector with no pairs. **/ + tprintf("."); + check(fflush(stdout)); + ca_free_vector(vector); + continue; + } + + /** Store value. **/ + char* dup_val = check_ptr(strdup(val)); + check_strict(xaAddItem(&data_xarray, (void*)dup_val)); + check_strict(xaAddItem(&vector_xarray, (void*)vector)); + + /** Clean up. **/ + check(objClose(entry)); + } + tprintf("\nData aquired.\n"); + source_data->nVectors = vector_xarray.nItems; + + /** Trim data and store data. **/ + const size_t data_size = source_data->nVectors * sizeof(char*); + source_data->Data = check_ptr(nmMalloc(data_size)); + memcpy(source_data->Data, data_xarray.Items, data_size); + check(xaDeInit(&data_xarray)); + data_xarray.nAlloc = 0; + + /** Trim data and store vectors. **/ + const size_t vectors_size = source_data->nVectors * sizeof(pVector); + source_data->Vectors = check_ptr(nmMalloc(vectors_size)); + memcpy(source_data->Vectors, vector_xarray.Items, vectors_size); + check(xaDeInit(&vector_xarray)); + vector_xarray.nAlloc = 0; + + /** Success. **/ + successful = true; + + end_free_data: + if (data_xarray.nAlloc != 0) + { + for (unsigned int i = 0u; i < data_xarray.nItems; i++) + free(data_xarray.Items[i]); + check(xaDeInit(&data_xarray)); + } + if (vector_xarray.nAlloc != 0) + { + for (unsigned int i = 0u; i < vector_xarray.nItems; i++) + ca_free_vector(vector_xarray.Items[i]); + check(xaDeInit(&vector_xarray)); + } + + // end_close_query: + ret = objQueryClose(query); + if (ret != 0) + { + mssErrorf(0, "Cluster", "Failed to close query (error code %d).", ret); + // ret = ret; // Fall-through: Continue through failure. + } + + end_close: + ret = objClose(obj); + if (ret != 0) + { + mssErrorf(0, "Cluster", "Failed to close object driver (error code %d).", ret); + // ret = ret; // Fall-through: Continue through failure. + } + + end: + if (!successful) mssErrorf(0, "Cluster", "Vector computation failed."); + return (successful) ? 0 : -1; + } + +/*** Ensures that the cluster_data->Labels has been computed, running the + *** specified clustering algorithm if necessary. + *** + *** @attention - Promises that mssError() will be invoked on failure, so the + *** caller is not required to specify their own error message. + *** + *** @param cluster_data The pClusterData affected by the computation. + *** @param node_data The current pNodeData, used to get vectors to cluster. + *** @returns 0 if successful, or + *** -1 other value on failure. + ***/ +int ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data) + { + /** If the clusters are alreadyd computed, we're done. **/ + if (cluster_data->Labels != NULL) return 0; + + /** Make source data available. **/ + pSourceData source_data = node_data->SourceData; + + /** We need the vectors to compute clusters. **/ + if (ci_ComputeSourceData(source_data, node_data->ParamList->Session) != 0) + { + mssErrorf(0, "Cluster", "Vectors not found."); + goto err; + } + + /** Allocate static memory for finding clusters. **/ + const size_t labels_size = source_data->nVectors * sizeof(unsigned int); + cluster_data->Labels = check_ptr(nmMalloc(labels_size)); + + /** Execute clustering. **/ + switch (cluster_data->ClusterAlgorithm) + { + case ALGORITHM_NONE: + case ALGORITHM_SLIDING_WINDOW: /* Clusters are not computed separately for performance reasons. */ + tprintf("Applying no clustering...\n"); + memset(cluster_data->Labels, 0u, labels_size); + break; + + case ALGORITHM_KMEANS: + /** Check for unimplemented similarity measures. **/ + if (cluster_data->SimilarityMeasure != SIMILARITY_COSINE) + { + mssErrorf(1, "Cluster", + "The similarity meausre \"%s\" is not implemented.", + ci_SimilarityMeasureToString(cluster_data->SimilarityMeasure) + ); + goto err; + } + + /** kmeans expects clusters to be initialized. **/ + memset(cluster_data->Labels, 0u, labels_size); + + tprintf("Running kmeans\n"); + Timer timer_i, *timer = timer_start(timer_init(&timer_i)); + ca_kmeans( + source_data->Vectors, + source_data->nVectors, + cluster_data->Labels, + cluster_data->NumClusters, + cluster_data->MaxIterations, + cluster_data->MinImprovement + ); + timer_stop(timer); + tprintf("Done after %.4lf.\n", timer_get(timer)); + break; + + default: + mssErrorf(1, "Cluster", + "Clustering algorithm \"%s\" is not implemented.", + ci_ClusteringAlgorithmToString(cluster_data->ClusterAlgorithm) + ); + goto err; + } + + tprintf("Clustering done.\n"); + return 0; + + err: + mssErrorf(0, "Cluster", "Cluster computation failed for \"%s\".", cluster_data->Name); + return -1; + } + +/*** Ensures that the search_data->Dups has been computed, running the a + *** search with the specified similarity measure if necessary. + *** + *** @attention - Promises that mssError() will be invoked on failure, so the + *** caller is not required to specify their own error message. + *** + *** @param cluster_data The pClusterData affected by the computation. + *** @param node_data The current pNodeData, used to get vectors to cluster. + *** @returns 0 if successful, or + *** -1 other value on failure. + ***/ +int ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) + { + int ret; + + /** If the clusters are already computed, we're done. **/ + if (search_data->Dups != NULL) return 0; + + /** Extract structs. **/ + pClusterData cluster_data = search_data->Source; + pSourceData source_data = node_data->SourceData; + + /** We need the clusters to be able to search them. **/ + ret = ci_ComputeClusterData(cluster_data, node_data); + if (ret != 0) + { + mssErrorf(0, "Cluster", "Search computation failed due to missing clusters."); + goto err; + } + + /** Check for unimplemented similarity measures. **/ + if (search_data->SimilarityMeasure != SIMILARITY_COSINE) + { + mssErrorf(1, "Cluster", + "The similarity meausre \"%s\" is not implemented.", + ci_SimilarityMeasureToString(search_data->SimilarityMeasure) + ); + goto err; + } + + /** Execute the search. **/ + tprintf("Invoking ca_search.\n"); + Timer timer_i, *timer = timer_start(timer_init(&timer_i)); + pXArray dups_temp = ca_search( + source_data->Vectors, + source_data->nVectors, + cluster_data->Labels, + search_data->Threshold + ); + timer_stop(timer); + if (dups_temp == NULL) goto err; + tprintf("ca_search done after %.4lf.\n", timer_get(timer)); + + /** Store dups. **/ + search_data->nDups = dups_temp->nItems; + search_data->Dups = (dups_temp->nItems == 0) + ? check_ptr(nmMalloc(0)) + : ci_xaToTrimmedArray(dups_temp); + + /** Free unused data. **/ + tprintf("Cleanup.\n"); + check(xaFree(dups_temp)); + + return 0; + + err: + mssErrorf(0, "Cluster", "Search computation failed for \"%s\".", search_data->Name); + return -1; + } + + +/** ================ Parameter Functions ================ **/ +/** ANCHOR[id=params] **/ +// LINK #functions + +/*** Get the type of a parameter. Intended for expSetParamFunctions(). + *** + *** @param inf_v Node data containing the list of paramenters. + *** @param attr_name The name of the requested paramenter. + *** @returns The datatype, see datatypes.h for a list of valid datatypes. + *** + *** LINK ../../centrallix-lib/include/datatypes.h:72 + ***/ +int ci_GetParamType(void* inf_v, const char* attr_name) + { + tprintf("Call to ci_GetParamType(\"%s\")\n", attr_name); + pNodeData node_data = (pNodeData)inf_v; + + /** Find the parameter. **/ + for (unsigned int i = 0; i < node_data->nParams; i++) + { + pParam param = node_data->Params[i]; + if (strcmp(param->Name, attr_name) != 0) continue; + + /** Parameter found. **/ + return (param->Value == NULL) ? DATA_T_UNAVAILABLE : param->Value->DataType; + } + + /** Parameter not found. **/ + return DATA_T_UNAVAILABLE; + } + + +/*** Get the value of a parameter. Intended for `expSetParamFunctions()`. + *** + *** @attention - Warning: If the retrieved value is `NULL`, the pObjectData + *** val is not updated, and the function returns 1, indicating `NULL`. + *** This is intended behavior, for consistancy with other Centrallix + *** functions, so keep it in mind so you're not surpised. + *** + *** @param inf_v Node data containing the list of paramenters. + *** @param attr_name The name of the requested paramenter. + *** @param datatype The expected datatype of the parameter value. + *** See datatypes.h for a list of valid datatypes. + *** @param val A pointer to a location where a pointer to the requested + *** data should be stored. Typically, the caller creates a local variable + *** to store this pointer, then passes a pointer to that local variable + *** so that they will have a pointer to the data. + *** This buffer will not be modified unless the data is successfully + *** found. If a value other than 0 is returned, the buffer is not updated. + *** @returns 0 if successsful, + *** 1 if the variable is null, + *** -1 if an error occures. + *** + *** LINK ../../centrallix-lib/include/datatypes.h:72 + ***/ +int ci_GetParamValue(void* inf_v, char* attr_name, int datatype, pObjData val) + { + tprintf("Call to ci_GetParamValue(\"%s\", %s)\n", attr_name, ci_TypeToStr(datatype)); + pNodeData node_data = (pNodeData)inf_v; + + /** Find the parameter. **/ + for (unsigned int i = 0; i < node_data->nParams; i++) + { + pParam param = (pParam)node_data->Params[i]; + if (strcmp(param->Name, attr_name) != 0) continue; + + tprintf("Param found: Parsing...\n"); + + /** Parameter found. **/ + if (param->Value == NULL) return 1; + if (param->Value->Flags & DATA_TF_NULL) return 1; + if (param->Value->DataType != datatype) + { + mssErrorf(1, "Cluster", "Type mismatch accessing parameter '%s'.", param->Name); + return -1; + } + + tprintf("Param found: Copying...\n"); + /** Return param value. **/ + objCopyData(&(param->Value->Data), val, datatype); + return 0; + } + + /** Param not found. **/ + tprintf("Param not found.\n"); + return -1; + } + + +/** Not implemented. **/ +int ci_SetParamValue(void* inf_v, char* attr_name, int datatype, pObjData val) + { + tprintf("Call to ci_SetParamValue(%s, %s)\n", attr_name, ci_TypeToStr(datatype)); + mssErrorf(1, "Cluster", "SetParamValue() is not implemented because clusters are imutable."); + return -1; + } + + +/** ================ Driver functions ================ **/ +/** ANCHOR[id=driver] **/ +// LINK #functions + +/*** Opens a new cluster driver instance by parsing a `.cluster` file found + *** at the path provided in obj. + *** + *** @param obj The object being opened, including the path, session, and + *** other necessary information. + *** @param mask Driver permission mask (unused). + *** @param systype ? (unused) + *** @param usr_type The object system file type being openned. Should always + *** be "system/cluster" because this driver is only registered for that + *** type of file. + *** @param oxt The object system tree, similar to a kind of "scope" (unused). + *** + *** @returns A pDriverData struct representing a driver instance, or + *** NULL if an error occures. + ***/ +void* clusterOpen(pObject obj, int mask, pContentType systype, char* usr_type, pObjTrxTree* oxt) + { + tprintf( + "Warning: clusterOpen(\"%s\") is under active development.\n", + obj_internal_PathPart(obj->Pathname, obj->SubPtr + obj->SubCnt, 1) + ); + + /** If CREAT and EXCL are specified, create it and fail if it already exists. **/ + pSnNode node_struct = NULL; + bool can_create = (obj->Mode & O_CREAT) && (obj->SubPtr == obj->Pathname->nElements); + if (can_create && (obj->Mode & O_EXCL)) + { + node_struct = snNewNode(obj->Prev, usr_type); + if (node_struct == NULL) + { + mssErrorf(0, "Cluster", "Failed to EXCL create new node struct."); + goto err; + } + } + + /** Read the node if it exists. **/ + if (node_struct == NULL) + node_struct = snReadNode(obj->Prev); + + /** If we can't read, create it (if allowed). **/ + if (node_struct == NULL && can_create) + node_struct = snNewNode(obj->Prev, usr_type); + + /** If there still isn't a node, fail early. **/ + if (node_struct == NULL) + { + mssErrorf(0, "Cluster", "Failed to create node struct."); + goto err; + } + + /** Parse node data. **/ + pNodeData node_data = ci_ParseNodeData(node_struct->Data, obj); + if (node_data == NULL) + { + mssErrorf(0, "Cluster", + "Failed to parse structure file of name %s.", + obj_internal_PathPart(obj->Pathname, obj->SubPtr + obj->SubCnt, 1) + ); + goto err; + } + node_data->Node = node_struct; + node_data->Node->OpenCnt++; + + /** Allocate driver instance data. **/ + pDriverData driver_data = check_ptr(nmMalloc(sizeof(DriverData))); + memset(driver_data, 0, sizeof(DriverData)); + driver_data->NodeData = node_data; + + /** Detect target from path. **/ + tprintf("Parsing node path: %d %d\n", obj->SubPtr, obj->SubCnt); obj->SubCnt = 0; + char* target_name = obj_internal_PathPart(obj->Pathname, obj->SubPtr + obj->SubCnt++, 1); + if (target_name == NULL) + { + /** Target found: Root **/ + tprintf("Found target: Root.\n"); + driver_data->TargetType = TARGET_ROOT; + driver_data->TargetData = (void*)driver_data->NodeData->SourceData; + return (void*)driver_data; /* Sucess. */ + } + + /** Search clusters. **/ + for (unsigned int i = 0u; i < node_data->nClusters; i++) + { + pClusterData cluster = node_data->Clusters[i]; + if (strcmp(cluster->Name, target_name) != 0) continue; + + /** Target found: Cluster **/ + driver_data->TargetType = TARGET_CLUSTER; + tprintf("Found target cluster: %s\n", cluster->Name); + + /** Check for sub-clusters in the path. **/ + while (true) + { + /** Decend one path part deeper into the path. **/ + const char* path_part = obj_internal_PathPart(obj->Pathname, obj->SubPtr + obj->SubCnt++, 1); + + /** If the path does not go any deeper, we're done. **/ + if (path_part == NULL) + { + driver_data->TargetData = (void*)cluster; + break; + } + + /** Need to go deeper: Search for the requested sub-cluster. **/ + for (unsigned int i = 0u; i < cluster->nSubClusters; i++) + { + pClusterData sub_cluster = cluster->SubClusters[i]; + if (strcmp(sub_cluster->Name, path_part) != 0) continue; + + /** Target found: Sub-cluster **/ + tprintf("Found target sub-cluster: %s\n", sub_cluster->Name); + cluster = sub_cluster; + goto continue_descent; + } + + /** Path names sub-cluster that does not exist. **/ + mssErrorf(1, "Cluster", "Sub-cluster \"%s\" does not exist.", path_part); + goto err_free_node; + + continue_descent:; + } + return (void*)driver_data; /* Sucess. */ + } + + /** Search searches. **/ + for (unsigned int i = 0u; i < node_data->nSearches; i++) + { + pSearchData search = node_data->Searches[i]; + if (strcmp(search->Name, target_name) != 0) continue; + + /** Target found: Search **/ + driver_data->TargetType = TARGET_SEARCH; + driver_data->TargetData = (void*)search; + + /** Check for extra, invalid path parts. **/ + char* extra_data = obj_internal_PathPart(obj->Pathname, obj->SubPtr + obj->SubCnt++, 1); + if (extra_data != NULL) + { + mssErrorf(1, "Cluster", "Unknown path part %s.", extra_data); + goto err_free_node; + } + tprintf("Found target search: %s %d %d\n", search->Name, obj->SubPtr, obj->SubCnt); + return (void*)driver_data; /* Sucess. */ + } + + /** We were unable to find the requested cluster or search. **/ + mssErrorf(1, "Cluster", "\"%s\" is not the name of a declaired cluster or search.", target_name); + + /** Error cleanup. **/ + err_free_node: + ci_FreeNodeData(node_data); + nmFree(driver_data, sizeof(DriverData)); + + err: + return NULL; + } + + +/*** Close a cluster driver instance object, releasing any necessary memory + *** and closing any necessary underlying resources. However, most of that + *** data will be cached and won't be freed unless the cache is dropped. + *** + *** @param inf_v The affected driver instance. + *** @param oxt The object system tree, similar to a kind of "scope" (unused). + *** @returns 0, success. + ***/ +int clusterClose(void* inf_v, pObjTrxTree* oxt) + { + tprintf("Warning: clusterClose() is under active development.\n"); + pDriverData driver_data = (pDriverData)inf_v; + + /** Entries are shallow copies so we shouldn't do a deep free. **/ + if (driver_data->TargetType == TARGET_CLUSTER_ENTRY + || driver_data->TargetType == TARGET_SEARCH_ENTRY) + { + nmFree(driver_data, sizeof(DriverData)); + return 0; + } + + /** Free the node data (which is held in cache). **/ + ci_FreeNodeData(driver_data->NodeData); + + /** Free driver data. **/ + nmFree(driver_data, sizeof(DriverData)); + + return 0; + } + + +/*** Opens a new query pointing to the first row of the data targetted by + *** the driver instance struct. The query has an internal index counter + *** that starts at the first row and increments as data is fetched. + *** + *** @param inf_v The driver instance to be queried. + *** @param query The query to use on this struct. This is assumed to be + *** handled elsewhere, so we don't read it here (unused). + *** @param oxt The object system tree, similar to a kind of "scope" (unused). + *** @returns The cluster query. + ***/ +void* clusterOpenQuery(void* inf_v, pObjQuery query, pObjTrxTree* oxt) + { + tprintf("Warning: clusterOpenQuery() is under active development.\n"); + pClusterQuery cluster_query = check_ptr(nmMalloc(sizeof(ClusterQuery))); + cluster_query->DriverData = (pDriverData)inf_v; + cluster_query->RowIndex = 0u; + return cluster_query; + } + + +/*** Get the next entry as an open driver instance object. + *** + *** @param qy_v A query instance, storing an internal index which is + *** incremented once that data has been fetched. + *** @param obj Unused. + *** @param mode Unused. + *** @param oxt Unused. + *** @returns pDriverData that is either a cluster entry or search entry, + *** pointing to a specific target index into the relevant data. + *** OR NULL, indicating that all data has been fetched. + ***/ +void* clusterQueryFetch(void* qy_v, pObject obj, int mode, pObjTrxTree* oxt) + { + int ret; + tprintf("Warning: clusterQueryFetch() is under active development.\n"); + pClusterQuery cluster_query = (pClusterQuery)qy_v; + + /** Ensure that the data being fetched exists and is computed. **/ + TargetType target_type = cluster_query->DriverData->TargetType, new_target_type; + unsigned int data_amount = 0u; + switch (target_type) + { + case TARGET_ROOT: + mssErrorf(1, "Cluster", "Querying the root node of a cluster file is not allowed."); + fprintf(stderr, " > Hint: Try / or /\n"); + return NULL; + + case TARGET_CLUSTER: + { + new_target_type = TARGET_CLUSTER_ENTRY; + pClusterData target = (pClusterData)cluster_query->DriverData->TargetData; + ret = ci_ComputeClusterData(target, cluster_query->DriverData->NodeData); + if (ret != 0) + { + mssErrorf(0, "Cluster", "Internal cluster computation failed."); + return NULL; + } + data_amount = cluster_query->DriverData->NodeData->SourceData->nVectors; + break; + } + + case TARGET_SEARCH: + { + new_target_type = TARGET_SEARCH_ENTRY; + pSearchData target = (pSearchData)cluster_query->DriverData->TargetData; + ret = ci_ComputeSearchData(target, cluster_query->DriverData->NodeData); + if (ret != 0) + { + mssErrorf(0, "Cluster", "Internal search computation failed."); + return NULL; + } + data_amount = target->nDups; + break; + } + + case TARGET_CLUSTER_ENTRY: + case TARGET_SEARCH_ENTRY: + mssErrorf(1, "Cluster", "Querying a query result is not allowed."); + return NULL; + + default: + mssErrorf(1, "Cluster", "Unknown target type %u.", target_type); + return NULL; + } + tprintf("Fetch Index: %u/16 (total: %u)\n", cluster_query->RowIndex, data_amount); + + /** Cap results to 16 for faster debugging. TODO: Remove. **/ + data_amount = min(data_amount, 16); + + /** Check that the requested data exists, returning null if we've reached the end of the data. **/ + if (cluster_query->RowIndex >= data_amount) return NULL; + + /** Create the result struct. **/ + pDriverData driver_data = nmMalloc(sizeof(DriverData)); + assert(driver_data != NULL); + memcpy(driver_data, cluster_query->DriverData, sizeof(DriverData)); + driver_data->TargetType = new_target_type; + driver_data->TargetIndex = cluster_query->RowIndex++; + + return driver_data; + } + + +/*** Close a cluster query instance, releasing any necessary memory and + *** closing any necessary underlying resources. This does not close the + *** underlying driver instance, which must be closed with clusterClose(). + *** + *** @param qy_v The affected query instance. + *** @param oxt The object system tree, similar to a kind of "scope" (unused). + *** @returns 0, success. + ***/ +int clusterQueryClose(void* qy_v, pObjTrxTree* oxt) + { + tprintf("Warning: clusterQueryClose() is under active development.\n"); + + nmFree(qy_v, sizeof(ClusterQuery)); + return 0; + } + + +/*** Get the type of a cluster driver instance attribute. + *** + *** @param inf_v The driver instance. + *** @param attr_name The name of the requested attribute. + *** @param oxt The object system tree, similar to a kind of "scope" (unused). + *** @returns The datatype, see datatypes.h for a list of valid datatypes. + *** + *** LINK ../../centrallix-lib/include/datatypes.h:72 + ***/ +int clusterGetAttrType(void* inf_v, char* attr_name, pObjTrxTree* oxt) + { + pDriverData driver_data = (pDriverData)inf_v; + + /** Performance shortcut for frequently requested attributes: val1, val2, and sim. **/ + if (attr_name[0] == 'v' || attr_name[0] == 's') goto handle_targets; + + /** Debug info. **/ + if (oxt == NULL) tprintf(" > "); + tprintf("Call to clusterGetAttrType(%s)\n", attr_name); + + /** Guard possible segfault. **/ + if (attr_name == NULL) + { + fprintf(stderr, "Warning: Call to clusterGetAttrType() with NULL attribute name.\n"); + return DATA_T_UNAVAILABLE; + } + + /** Types for general attributes. **/ + if (strcmp(attr_name, "name") == 0 + || strcmp(attr_name, "annotation") == 0 + || strcmp(attr_name,"content_type") == 0 + || strcmp(attr_name, "inner_type") == 0 + || strcmp(attr_name,"outer_type") == 0) + return DATA_T_STRING; + if (strcmp(attr_name, "last_modification") == 0) + return DATA_T_DATETIME; + + /** Types for specific data targets. **/ + handle_targets: + switch (driver_data->TargetType) + { + case TARGET_ROOT: + if (strcmp(attr_name, "source") == 0 + || strcmp(attr_name, "attr_name") == 0) + return DATA_T_STRING; + break; + + case TARGET_CLUSTER: + if (strcmp(attr_name, "algorithm") == 0 + || strcmp(attr_name, "similarity_measure") == 0) + return DATA_T_STRING; + if (strcmp(attr_name, "num_clusters") == 0 + || strcmp(attr_name, "max_iterations") == 0) + return DATA_T_INTEGER; + if (strcmp(attr_name, "min_improvement") == 0 + || strcmp(attr_name, "average_similarity") == 0 + || strcmp(attr_name, "size") == 0) + return DATA_T_DOUBLE; + break; + + case TARGET_SEARCH: + if (strcmp(attr_name, "source") == 0 + || strcmp(attr_name, "similarity_measure") == 0) + return DATA_T_STRING; + if (strcmp(attr_name, "threshold") == 0) + return DATA_T_DOUBLE; + break; + + case TARGET_CLUSTER_ENTRY: + if (strcmp(attr_name, "id") == 0) + return DATA_T_INTEGER; + if (strcmp(attr_name, "val") == 0) + { + /** TODO: Replace with type calculation. **/ + return DATA_T_STRING; + } + if (strcmp(attr_name, "sim") == 0) + return DATA_T_DOUBLE; + break; + + case TARGET_SEARCH_ENTRY: + if (strcmp(attr_name, "id1") == 0 + || strcmp(attr_name, "id2") == 0) + return DATA_T_INTEGER; + if (strcmp(attr_name, "val1") == 0 + || strcmp(attr_name, "val2") == 0) + { + /** TODO: Replace with type calculation. **/ + return DATA_T_STRING; + } + if (strcmp(attr_name, "sim") == 0) + return DATA_T_DOUBLE; + break; + + default: + mssErrorf(1, "Cluster", "Unknown target type %u.", driver_data->TargetType); + return DATA_T_UNAVAILABLE; + } + + return DATA_T_UNAVAILABLE; + } + + +/*** Get the value of a cluster driver instance attribute. + *** + *** @param inf_v Node data containing the list of paramenters. + *** @param attr_name The name of the requested paramenter. + *** @param datatype The expected datatype of the parameter value. + *** See datatypes.h for a list of valid datatypes. + *** @param oxt The object system tree, similar to a kind of "scope" (unused). + *** @param val A pointer to a location where a pointer to the requested + *** data should be stored. Typically, the caller creates a local variable + *** to store this pointer, then passes a pointer to that local variable + *** so that they will have a pointer to the data. + *** This buffer will not be modified unless the data is successfully + *** found. If a value other than 0 is returned, the buffer is not updated. + *** @returns 0 if successsful, + *** -1 if an error occures. + *** + *** LINK ../../centrallix-lib/include/datatypes.h:72 + ***/ +int clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val, pObjTrxTree* oxt) + { + pDriverData driver_data = (pDriverData)inf_v; + + /** Performance shortcut for frequently requested attributes: val1, val2, and sim. **/ + if ( + (attr_name[0] == 'v' && datatype == DATA_T_STRING) /* val, val1, val2 : String */ + || (attr_name[0] == 's' && datatype == DATA_T_DOUBLE) /* sim : double */ + ) goto handle_targets; + + /** Debug info. **/ + tprintf("Call to clusterGetAttrValue(%s)\n", attr_name); + + /** Type check. **/ + const int expected_datatype = clusterGetAttrType(inf_v, attr_name, NULL); + if (datatype != expected_datatype) + { + mssErrorf(1, "Cluster", + "Type mismatch: Accessing attribute '%s' : %s as type %s.", + attr_name, ci_TypeToStr(expected_datatype), ci_TypeToStr(datatype) + ); + return -1; + } + + /** Handle name and annotation. **/ + if (strcmp(attr_name, "name") == 0) + { + switch (driver_data->TargetType) + { + case TARGET_ROOT: + val->String = ((pSourceData)driver_data->TargetData)->Name; + break; + + case TARGET_CLUSTER: + case TARGET_CLUSTER_ENTRY: + val->String = ((pClusterData)driver_data->TargetData)->Name; + break; + + case TARGET_SEARCH: + case TARGET_SEARCH_ENTRY: + val->String = ((pSearchData)driver_data->TargetData)->Name; + break; + + default: + mssErrorf(1, "Cluster", "Unknown target type %u.", driver_data->TargetType); + return -1; + } + + return 0; + } + if (strcmp(attr_name, "annotation") == 0) + { + switch (driver_data->TargetType) + { + case TARGET_ROOT: val->String = "Clustering driver."; break; + case TARGET_CLUSTER: val->String = "Clustering driver: Cluster."; break; + case TARGET_CLUSTER_ENTRY: val->String = "Clustering driver: Cluster Entry."; break; + case TARGET_SEARCH: val->String = "Clustering driver: Search."; break; + case TARGET_SEARCH_ENTRY: val->String = "Clustering driver: Cluster Entry."; break; + } + return 0; + } + + /** Return the appropriate types. **/ + if (strcmp(attr_name, "outer_type") == 0) + { + val->String = "system/row"; + return 0; + } + if (strcmp(attr_name, "content_type") == 0 + || strcmp(attr_name, "inner_type") == 0) + { + val->String = "system/void"; + return 0; + } + + /** Last modification is not implemented yet. **/ + if (strcmp(attr_name, "last_modification") == 0) return 1; /* null */ + + /** Handle attributes for specific data targets. **/ + handle_targets: + switch (driver_data->TargetType) + { + case TARGET_ROOT: + if (strcmp(attr_name, "source") == 0) + { + val->String = ((pSourceData)driver_data->TargetData)->SourcePath; + return 0; + } + if (strcmp(attr_name, "attr_name") == 0) + { + val->String = ((pSourceData)driver_data->TargetData)->AttrName; + return 0; + } + break; + + case TARGET_CLUSTER: + { + pClusterData target = (pClusterData)driver_data->TargetData; + + if (strcmp(attr_name, "algorithm") == 0) + { + val->String = ci_ClusteringAlgorithmToString(target->ClusterAlgorithm); + return 0; + } + if (strcmp(attr_name, "similarity_measure") == 0) + { + val->String = ci_SimilarityMeasureToString(target->SimilarityMeasure); + return 0; + } + if (strcmp(attr_name, "num_clusters") == 0) + { + if (target->NumClusters > INT_MAX) + fprintf(stderr, "Warning: num_clusters value of %u exceeds INT_MAX.\n", target->NumClusters); + val->Integer = (int)target->NumClusters; + return 0; + } + if (strcmp(attr_name, "max_iterations") == 0) + { + if (target->MaxIterations > INT_MAX) + fprintf(stderr, "Warning: max_iterations value of %u exceeds INT_MAX.\n", target->MaxIterations); + val->Integer = (int)target->MaxIterations; + return 0; + } + if (strcmp(attr_name, "min_improvement") == 0) + { + val->Double = target->MinImprovement; + return 0; + } + if (strcmp(attr_name, "average_similarity") == 0 + || strcmp(attr_name, "size") == 0) + { + mssErrorf(1, "Cluster", "average_similarity is not implemented."); + return -1; + } + break; + } + + case TARGET_SEARCH: + { + pSearchData target = (pSearchData)driver_data->TargetData; + + if (strcmp(attr_name, "source") == 0) + { + val->String = target->Source->Name; + return 0; + } + if (strcmp(attr_name, "similarity_measure") == 0) + { + val->String = ci_SimilarityMeasureToString(target->SimilarityMeasure); + return 0; + } + if (strcmp(attr_name, "threshold") == 0) + { + val->Double = target->Threshold; + return 0; + } + } + + case TARGET_CLUSTER_ENTRY: + { + pClusterData target = (pClusterData)driver_data->TargetData; + + if (strcmp(attr_name, "id") == 0) + { + val->Integer = (int)target->Labels[driver_data->TargetIndex]; + return 0; + } + if (strcmp(attr_name, "val") == 0) + { + val->String = driver_data->NodeData->SourceData->Data[driver_data->TargetIndex]; + return 0; + } + if (strcmp(attr_name, "sim") == 0) + { + mssErrorf(1, "Cluster", "Cluster entry similarity is not supported."); + return -1; + } + break; + } + + case TARGET_SEARCH_ENTRY: + { + pSearchData target = (pSearchData)driver_data->TargetData; + pDup target_dup = target->Dups[driver_data->TargetIndex]; + + if (strcmp(attr_name, "id1") == 0) + { + val->Integer = (int)target_dup->id1; + return 0; + } + if (strcmp(attr_name, "id2") == 0) + { + val->Integer = (int)target_dup->id2; + return 0; + } + if (strcmp(attr_name, "val1") == 0) + { + val->String = driver_data->NodeData->SourceData->Data[target_dup->id1]; + // val->Integer = (int)target_dup->id1; + return 0; + } + if (strcmp(attr_name, "val2") == 0) + { + val->String = driver_data->NodeData->SourceData->Data[target_dup->id2]; + // val->Integer = (int)target_dup->id2; + return 0; + } + if (strcmp(attr_name, "sim") == 0) + { + val->Double = target_dup->similarity; + return 0; + } + break; + } + + default: + mssErrorf(1, "Cluster", "Unknown target type %u.", driver_data->TargetType); + return -1; + } + + /** Unknown attribute. **/ + char* name; + clusterGetAttrValue(inf_v, "name", DATA_T_STRING, POD(&name), NULL); + mssErrorf(1, "Cluster", + "Unknown attribute '%s' for cluster object %s (target type: %u, \"%s\").", + attr_name, driver_data->NodeData->SourceData->Name, driver_data->TargetType, name + ); + + return -1; + } + + +/*** Returns the name of the first attribute that one can get from + *** this driver instance (using GetAttrType() and GetAttrValue()). + *** Resets the internal variable (TargetAttrIndex) used to maintain + *** itteration state for clusterGetNextAttr(). + *** + *** @param inf_v The driver instance to be read. + *** @param oxt Unused. + *** @returns The name of the first attribute. + ***/ +char* clusterGetFirstAttr(void* inf_v, pObjTrxTree oxt) + { + tprintf("Warning: clusterGetFirstAttr() is under active development.\n"); + pDriverData driver_data = (pDriverData)inf_v; + driver_data->TargetAttrIndex = 0u; + return clusterGetNextAttr(inf_v, oxt); + } + + +/*** Returns the name of the next attribute that one can get from + *** this driver instance (using GetAttrType() and GetAttrValue()). + *** Uses an internal variable (TargetAttrIndex) used to maintain + *** the state of this itteration over repeated calls. + *** + *** @param inf_v The driver instance to be read. + *** @param oxt Unused. + *** @returns The name of the next attribute. + ***/ +char* clusterGetNextAttr(void* inf_v, pObjTrxTree oxt) + { + tprintf("Warning: clusterGetNextAttr("); + pDriverData driver_data = (pDriverData)inf_v; + const unsigned int i = driver_data->TargetAttrIndex++; + tprintf("%u) is under active development.\n", i); + switch (driver_data->TargetType) + { + case TARGET_ROOT: return (i < nATTR_ROOT) ? ATTR_ROOT[i] : END_OF_ATTRIBUTES; + case TARGET_CLUSTER: return (i < nATTR_CLUSTER) ? ATTR_CLUSTER[i] : END_OF_ATTRIBUTES; + case TARGET_SEARCH: return (i < nATTR_SEARCH) ? ATTR_SEARCH[i] : END_OF_ATTRIBUTES; + case TARGET_CLUSTER_ENTRY: return (i < nATTR_CLUSTER_ENTRY) ? ATTR_CLUSTER_ENTRY[i] : END_OF_ATTRIBUTES; + case TARGET_SEARCH_ENTRY: return (i < nATTR_SEARCH_ENTRY) ? ATTR_SEARCH_ENTRY[i] : END_OF_ATTRIBUTES; + default: + mssErrorf(1, "Cluster", "Unknown target type %u.", driver_data->TargetType); + return NULL; + } + } + + +/*** Get the capabilities of the driver instance object. + *** + *** @param inf_v The driver instance to be checked. + *** @param info The struct to be populated with driver flags. + *** @returns 0 if succesful, + *** -1 if the driver is an unimplemented type (should never happen). + ***/ +int clusterInfo(void* inf_v, pObjectInfo info) + { + tprintf("Warning: clusterInfo() is under active development.\n"); + pDriverData driver_data = (pDriverData)inf_v; + pNodeData node_data = (pNodeData)driver_data->NodeData; + + /** Reset flags buffer. **/ + info->Flags = 0; + + /** Disallow unsupported functionality. **/ + info->Flags |= OBJ_INFO_F_CANT_ADD_ATTR; + info->Flags |= OBJ_INFO_F_CANT_HAVE_CONTENT; + info->Flags |= OBJ_INFO_F_NO_CONTENT; + + switch (driver_data->TargetType) + { + case TARGET_ROOT: + info->nSubobjects = node_data->nClusters + node_data->nSearches; + info->Flags |= OBJ_INFO_F_CAN_HAVE_SUBOBJ; + info->Flags |= OBJ_INFO_F_SUBOBJ_CNT_KNOWN; + info->Flags |= (info->nSubobjects > 0) ? OBJ_INFO_F_HAS_SUBOBJ : OBJ_INFO_F_NO_SUBOBJ; + break; + + case TARGET_CLUSTER: + info->Flags |= OBJ_INFO_F_CAN_HAVE_SUBOBJ; + info->Flags |= OBJ_INFO_F_HAS_SUBOBJ; /* Data must not be empty. */ + + /*** Clusters always have one label per vector. + *** If we know how many vectors are in the dataset, + *** we know how many labels this cluster will have, + *** even if it hasn't been computed yet. + ***/ + if (node_data->SourceData->Vectors != NULL) + { + info->Flags |= OBJ_INFO_F_SUBOBJ_CNT_KNOWN; + info->nSubobjects = node_data->SourceData->nVectors; + } + break; + + case TARGET_SEARCH: + { + pSearchData search_data = (pSearchData)driver_data->TargetData; + info->Flags |= OBJ_INFO_F_CAN_HAVE_SUBOBJ; + if (search_data->Dups != NULL) + { + info->nSubobjects = search_data->nDups; + info->Flags |= OBJ_INFO_F_SUBOBJ_CNT_KNOWN; + info->Flags |= (info->nSubobjects > 0) ? OBJ_INFO_F_HAS_SUBOBJ : OBJ_INFO_F_NO_SUBOBJ; + } + break; + } + + case TARGET_CLUSTER_ENTRY: + case TARGET_SEARCH_ENTRY: + /** No Subobjects. **/ + info->Flags |= OBJ_INFO_F_CANT_HAVE_SUBOBJ; + info->Flags |= OBJ_INFO_F_NO_SUBOBJ; + info->Flags |= OBJ_INFO_F_SUBOBJ_CNT_KNOWN; + info->nSubobjects = 0; + break; + + default: + mssErrorf(1, "Cluster", "Unknown target type %u.", driver_data->TargetType); + return -1; + } + + tprintf("Info result: "INT_TO_BINARY_PATTERN"\n", INT_TO_BINARY(info->Flags)); + return 0; + } + + +/** ================ Method Execution Functions ================ **/ +/** ANCHOR[id=method] **/ +// LINK #functions + +/*** Returns the name of the first method that one can execute from + *** this driver instance (using clusterExecuteMethod()). Resets the + *** internal variable (TargetMethodIndex) used to maintain itteration + *** state for clusterGetNextMethod(). + *** + *** @param inf_v The driver instance to be read. + *** @param oxt Unused. + *** @returns The name of the first methd. + ***/ +char* clusterGetFirstMethod(void* inf_v, pObjTrxTree oxt) + { + tprintf("Warning: clusterGetFirstMethod() is under active development.\n"); + pDriverData driver_data = (pDriverData)inf_v; + driver_data->TargetMethodIndex = 0u; + return clusterGetNextMethod(inf_v, oxt); + } + + +/*** Returns the name of the next method that one can get from + *** this driver instance (using GetAttrType() and GetAttrValue()). + *** Uses an internal variable (TargetMethodIndex) used to maintain + *** the state of this itteration over repeated calls. + *** + *** @param inf_v The driver instance to be read. + *** @param oxt Unused. + *** @returns The name of the next method. + ***/ +char* clusterGetNextMethod(void* inf_v, pObjTrxTree oxt) + { + tprintf("Warning: clusterGetNextMethod("); + pDriverData driver_data = (pDriverData)inf_v; + const unsigned int i = driver_data->TargetMethodIndex++; + tprintf("%u) is under active development.\n", i); + return (i < nMETHOD_NAME) ? METHOD_NAME[i] : END_OF_METHODS; + } + +/** Intended for use in xhForEach(). **/ +static int ci_PrintEntry(pXHashEntry entry, void* arg) + { + /** Extract entry. **/ + char* key = entry->Key; + void* data = entry->Data; + + /** Extract args. **/ + void** args = (void**)arg; + unsigned int* type_id_ptr = (unsigned int*)args[0]; + unsigned int* total_bytes_ptr = (unsigned int*)args[1]; + char* path = (char*)args[2]; + + /** If a path is provided, check that it matches the start of the key. **/ +// if (path != NULL) printf("Comparing \"%s\" to \"%s\"[0,%lu].\n", path, key, strlen((char*)path)); + if (path != NULL && strncmp(key, (char*)path, strlen((char*)path)) != 0) return 0; + + /** Handle type. **/ + char* type; + char* name; + unsigned int bytes; + switch (*type_id_ptr) + { + case 1u: + { + pSourceData source_data = (pSourceData)data; + type = "Source"; + name = source_data->Name; + bytes = ci_SizeOfSourceData(source_data); + break; + } + case 2u: + { + pClusterData cluster_data = (pClusterData)data; + type = "Cluster"; + name = cluster_data->Name; + bytes = ci_SizeOfClusterData(cluster_data, false); + break; + } + case 3u: + { + pSearchData search_data = (pSearchData)data; + type = "Search"; + name = search_data->Name; + bytes = ci_SizeOfSearchData(search_data); + break; + } + default: assert(false); + } + + /** Increment total bytes. **/ + *total_bytes_ptr += bytes; + + char buf[12]; + snprint_bytes(buf, sizeof(buf), bytes); + printf("%-8s %-16s %-12s \"%s\"\n", type, name, buf, key); + + return 0; + } + + +/*** Executes a method with the given name. + *** + *** @param inf_v The affected driver instance. + *** @param method_name The name of the method. + *** @param param A possibly optional param passed to the method. + *** @param oxt The object system tree, similar to a kind of "scope" (unused). + ***/ +int clusterExecuteMethod(void* inf_v, char* method_name, pObjData param, pObjTrxTree oxt) + { + tprintf("Warning: clusterExecuteMethod(\"%s\") is under active development.\n", method_name); + + /** Cache management method. **/ + if (strcmp(method_name, "cache") == 0) + { + /** Second parameter is required. **/ + if (param->String == NULL) + { + mssErrorf(1, "Cluster", + "param : \"show\" | \"show_all\" | \"drop_all\" is required for the cache method." + ); + return -1; + } + + /** Show cache. **/ + if (strcmp(param->String, "show") == 0) + { + const pObject obj = ((pDriverData)inf_v)->NodeData->Obj; + char* path = obj_internal_PathPart(obj->Pathname, 0, obj->SubPtr); + + /** Print cache info table. **/ + unsigned int i = 1u, source_bytes = 0u, cluster_bytes = 0u, search_bytes = 0u; + printf("\nShowing cache for \"%s\":\n", path); + printf("%-8s %-16s %-12s %s\n", "Type", "Name", "Size", "Cache Entry Key"); + xhForEach(&ClusterCaches.SourceCache, ci_PrintEntry, (void*[]){&i, &source_bytes, path}); i++; + xhForEach(&ClusterCaches.ClusterCache, ci_PrintEntry, (void*[]){&i, &cluster_bytes, path}); i++; + xhForEach(&ClusterCaches.SearchCache, ci_PrintEntry, (void*[]){&i, &search_bytes, path}); i++; + + /** Print stats. **/ + char buf[16]; + printf("\nCache Stats:\n"); + printf("%-8s %-4s %-12s\n", "", "#", "Total Size"); + const int n_sources = ClusterCaches.SourceCache.nItems; + snprint_bytes(buf, sizeof(buf), source_bytes); + printf("%-8s %-4d %-12s\n", "Source", n_sources, buf); + const int n_clusters = ClusterCaches.ClusterCache.nItems; + snprint_bytes(buf, sizeof(buf), cluster_bytes); + printf("%-8s %-4d %-12s\n", "Cluster", n_clusters, buf); + const int n_searches = ClusterCaches.SearchCache.nItems; + snprint_bytes(buf, sizeof(buf), search_bytes); + printf("%-8s %-4d %-12s\n", "Search", n_searches, buf); + snprint_bytes(buf, sizeof(buf), source_bytes + cluster_bytes + search_bytes); + printf("%-8s %-4d %-12s\n\n", "Total", n_sources + n_clusters + n_searches, buf); + return 0; + } + + + /** Show all cache. **/ + if (strcmp(param->String, "show_all") == 0) + { + /** Print cache info table. **/ + unsigned int i = 1u, total_bytes = 0u; + tprintf("Showing cluster driver cache for all files...\n"); + printf("%-8s %-16s %-12s %s\n", "Type", "Name", "Size", "Cache Entry Key"); + xhForEach(&ClusterCaches.SourceCache, ci_PrintEntry, (void*[]){&i, &total_bytes, NULL}); i++; + xhForEach(&ClusterCaches.ClusterCache, ci_PrintEntry, (void*[]){&i, &total_bytes, NULL}); i++; + xhForEach(&ClusterCaches.SearchCache, ci_PrintEntry, (void*[]){&i, &total_bytes, NULL}); i++; + + /** Print total size. **/ + char buf[16]; + snprint_bytes(buf, sizeof(buf), total_bytes); + printf("Total cache size: %s\n", buf); + return 0; + } + + /** Drop allcache. **/ + if (strcmp(param->String, "drop_all") == 0) + { + tprintf("Dropping cluster driver cache for all files...\n"); + /*** Free caches in reverse of the order they are created in case + *** cached data relies on its source during the freeing process. + ***/ + xhClearKeySafe(&ClusterCaches.SearchCache, ci_CacheFreeSearch, NULL); + xhClearKeySafe(&ClusterCaches.ClusterCache, ci_CacheFreeCluster, NULL); + xhClearKeySafe(&ClusterCaches.SourceCache, ci_CacheFreeSourceData, NULL); + printf("Cache dropped.\n"); + return 0; + } + + /** Unknown parameter. **/ + mssErrorf(1, "Cluster", + "Expected param : \"show\" | \"show_all\" | \"drop_all\" the cache method, but got: \"%s\"", + param->String + ); + return -1; + } + + return -1; + } + +/** ================ Unimplemented Functions ================ **/ +/** ANCHOR[id=unimplemented] **/ +// LINK #functions + +/** Not implemented. **/ +int clusterCreate(pObject obj, int mask, pContentType systype, char* usrtype, pObjTrxTree* oxt) + { + mssErrorf(1, "Cluster", "clusterCreate() is not implemented."); + return -ENOSYS; + } +/** Not implemented. **/ +int clusterDeleteObj(void* inf_v, pObjTrxTree* oxt) + { + mssErrorf(1, "Cluster", "clusterDeleteObj() is not implemented."); + return -1; + } +/** Not implemented. **/ +int clusterDelete(pObject obj, pObjTrxTree* oxt) + { + mssErrorf(1, "Cluster", "clusterDelete() is not implemented."); + return -1; + } +/** Not implemented. **/ +int clusterRead(void* inf_v, char* buffer, int maxcnt, int offset, int flags, pObjTrxTree* oxt) + { + mssErrorf(1, "Cluster", "clusterRead() not implemented."); + fprintf(stderr, "HINT: Use queries instead, (e.g. clusterOpenQuery()).\n"); + return -1; + } +/** Not implemented. **/ +int clusterWrite(void* inf_v, char* buffer, int cnt, int offset, int flags, pObjTrxTree* oxt) + { + mssErrorf(1, "Cluster", "clusterWrite() not implemented because clusters are imutable."); + return -1; + } +/** Not implemented. **/ +int clusterSetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val, pObjTrxTree oxt) + { + mssErrorf(1, "Cluster", "clusterSetAttrValue() not implemented because clusters are imutable."); + return -1; + } +/** Not implemented. **/ +int clusterAddAttr(void* inf_v, char* attr_name, int type, pObjData val, pObjTrxTree oxt) + { + mssErrorf(1, "Cluster", "clusterAddAttr() not implemented because clusters are imutable."); + return -1; + } +/** Not implemented. **/ +void* clusterOpenAttr(void* inf_v, char* attr_name, int mode, pObjTrxTree oxt) + { + mssErrorf(1, "Cluster", "clusterOpenAttr() not implemented."); + return NULL; + } +/** Not implemented. **/ +int clusterCommit(void* inf_v, pObjTrxTree *oxt) + { + mssErrorf(1, "Cluster", "clusterCommit() not implemented because clusters are imutable."); + return 0; + } +/** Not implemented. **/ +pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pObjTrxTree* oxt) + { + mssErrorf(1, "Cluster", "clusterPresentationHints() not implemented."); + return NULL; + } + + +/*** Initialize the driver. This includes: + *** - Registering the driver with the objectsystem. + *** - Registering structs with newmalloc for debugging. + *** - Initializing global data needed for the driver. + *** + *** @returns 0 if successful, or + *** a negative value if an error occured. + ***/ +int clusterInitialize(void) + { + int ret; + /** Initialize library. **/ + ca_init(); + + /** Allocate the driver. **/ + pObjDriver drv = (pObjDriver)nmMalloc(sizeof(ObjDriver)); + if (drv == NULL) return -1; + memset(drv, 0, sizeof(ObjDriver)); + + /** Initialize globals. **/ + memset(&ClusterCaches, 0, sizeof(ClusterCaches)); + ret = xhInit(&ClusterCaches.SourceCache, 251, 0); + if (ret < 0) return ret; + ret = xhInit(&ClusterCaches.ClusterCache, 251, 0); + if (ret < 0) return ret; + ret = xhInit(&ClusterCaches.SearchCache, 251, 0); + if (ret < 0) return ret; + + /** Setup the structure. **/ + strcpy(drv->Name, "clu - Clustering Driver"); + drv->Capabilities = OBJDRV_C_TRANS | OBJDRV_C_FULLQUERY; // OBJDRV_C_TRANS | OBJDRV_C_FULLQUERY; + ret = xaInit(&(drv->RootContentTypes), 1); + if (ret < 0) return ret; + ret = xaAddItem(&(drv->RootContentTypes), "system/cluster"); + if (ret < 0) return ret; + + /** Setup the function references. **/ + drv->Open = clusterOpen; + drv->Close = clusterClose; + drv->Create = clusterCreate; + drv->Delete = clusterDelete; + drv->DeleteObj = clusterDeleteObj; + drv->OpenQuery = clusterOpenQuery; + drv->QueryDelete = NULL; + drv->QueryFetch = clusterQueryFetch; + drv->QueryClose = clusterQueryClose; + drv->Read = clusterRead; + drv->Write = clusterWrite; + drv->GetAttrType = clusterGetAttrType; + drv->GetAttrValue = clusterGetAttrValue; + drv->GetFirstAttr = clusterGetFirstAttr; + drv->GetNextAttr = clusterGetNextAttr; + drv->SetAttrValue = clusterSetAttrValue; + drv->AddAttr = clusterAddAttr; + drv->OpenAttr = clusterOpenAttr; + drv->GetFirstMethod = clusterGetFirstMethod; + drv->GetNextMethod = clusterGetNextMethod; + drv->ExecuteMethod = clusterExecuteMethod; + drv->Commit = clusterCommit; + drv->Info = clusterInfo; + drv->PresentationHints = clusterPresentationHints; + + /** Register some structures. **/ + nmRegister(sizeof(ClusterData), "ClusterData"); + nmRegister(sizeof(SearchData), "ClusterSearch"); + nmRegister(sizeof(SourceData), "ClusterSourceData"); + nmRegister(sizeof(NodeData), "ClusterNodeData"); + nmRegister(sizeof(DriverData), "ClusterDriverData"); + nmRegister(sizeof(ClusterQuery), "ClusterQuery"); + nmRegister(sizeof(ClusterCaches), "ClusterCaches"); + + /** Print debug size info. **/ + char cluster_size_buf[16]; + char search_size_buf[16]; + char source_size_buf[16]; + char node_size_buf[16]; + char driver_size_buf[16]; + char query_size_buf[16]; + char caches_size_buf[16]; + tprintf( + "Cluster driver struct sizes:\n" + " > sizeof(ClusterData): %s\n" + " > sizeof(SearchData): %s\n" + " > sizeof(SourceData): %s\n" + " > sizeof(NodeData): %s\n" + " > sizeof(DriverData): %s\n" + " > sizeof(ClusterQuery): %s\n" + " > sizeof(ClusterCaches): %s\n", + snprint_bytes(cluster_size_buf, sizeof(cluster_size_buf), sizeof(ClusterData)), + snprint_bytes(search_size_buf, sizeof(search_size_buf), sizeof(SearchData)), + snprint_bytes(source_size_buf, sizeof(source_size_buf), sizeof(SourceData)), + snprint_bytes(node_size_buf, sizeof(node_size_buf), sizeof(NodeData)), + snprint_bytes(driver_size_buf, sizeof(driver_size_buf), sizeof(DriverData)), + snprint_bytes(query_size_buf, sizeof(query_size_buf), sizeof(ClusterQuery)), + snprint_bytes(caches_size_buf, sizeof(caches_size_buf), sizeof(ClusterCaches)) + ); + + /** Register the driver. **/ + ret = objRegisterDriver(drv); + if (ret < 0) return ret; + + return 0; + } diff --git a/centrallix/tests/test_expfn_double_metaphone_00.cmp b/centrallix/tests/test_expfn_double_metaphone_00.cmp new file mode 100644 index 000000000..d13cf05ca --- /dev/null +++ b/centrallix/tests/test_expfn_double_metaphone_00.cmp @@ -0,0 +1,140 @@ +Attribute [result]: string "TST`TST" +Attribute [result]: string "PSK`PSK" +Attribute [result]: string "SNTRLKS`SNTRLKS" +Attribute [result]: string "LRNS`LRNS" +Attribute [result]: string "FLPS`FLPS" +Attribute [result]: string "AKSPTNNS`AKSPTNKNS" +Attribute [result]: string "SPRKLFRJLSTSKSPLTSS`SPRKLFRKLSTSKSPLTXS" +Attribute [result]: string "SKTLPKSSTSLKRFLKRPS`SKTLPKSSTSLKRFLKRPS" +Attribute [result]: string "SM0`XMT" +Attribute [result]: string "XMT`SMT" +Attribute [result]: string "SNTR`XNTR" +Attribute [result]: string "XNTR`SNTR" +Attribute [result]: string "ARN`ARNF" +Attribute [result]: string "ARNF`ARNF" +Attribute [result]: string "AKST`AKST" +Attribute [result]: string "AKSTNT`AKSTNT" +Attribute [result]: string "AKTL`AKTL" +Attribute [result]: string "ARX`ARK" +Attribute [result]: string "ART`ARTS" +Attribute [result]: string "PKS`PKS" +Attribute [result]: string "PX`PX" +Attribute [result]: string "PJTR`PHTR" +Attribute [result]: string "PLX`PLX" +Attribute [result]: string "PRTX`PRTX" +Attribute [result]: string "PJ`PK" +Attribute [result]: string "P`P" +Attribute [result]: string "PR`PR" +Attribute [result]: string "PRTN`PRTN" +Attribute [result]: string "KPRL`KPR" +Attribute [result]: string "SSR`SSR" +Attribute [result]: string "KKN`KKN" +Attribute [result]: string "KMPL`KMPL" +Attribute [result]: string "KRLL`KRLL" +Attribute [result]: string "KRLL`KRLL" +Attribute [result]: string "KMSTR`KMSTR" +Attribute [result]: string "KNT`KNT" +Attribute [result]: string "KRS`KRS" +Attribute [result]: string "KF`KF" +Attribute [result]: string "SRN`XRN" +Attribute [result]: string "TM`TM" +Attribute [result]: string "ATKR`ATKR" +Attribute [result]: string "AJ`AJ" +Attribute [result]: string "FLPTS`FLPFX" +Attribute [result]: string "FKX`FKX" +Attribute [result]: string "KLKS`KKS" +Attribute [result]: string "KRMNK`JRMNK" +Attribute [result]: string "JRTL`JRTL" +Attribute [result]: string "JLN`JLN" +Attribute [result]: string "KSPL`KSPL" +Attribute [result]: string "KF`KF" +Attribute [result]: string "KRK`KRK" +Attribute [result]: string "HKMR`HKMR" +Attribute [result]: string "H`H" +Attribute [result]: string "ALNT`ALNT" +Attribute [result]: string "AL`AL" +Attribute [result]: string "ATLN`ATLN" +Attribute [result]: string "JNKLTS`ANKLFX" +Attribute [result]: string "HS`HS" +Attribute [result]: string "LF`LF" +Attribute [result]: string "MKFR`MKFR" +Attribute [result]: string "MKRKR`MKRKR" +Attribute [result]: string "MNKR`MNJR" +Attribute [result]: string "MK`MK" +Attribute [result]: string "MKLFLN`MKLFLN" +Attribute [result]: string "MKL`MXL" +Attribute [result]: string "MTL`MTL" +Attribute [result]: string "ARKSTR`ARKSTR" +Attribute [result]: string "ARKT`ARKT" +Attribute [result]: string "PNN`PNN" +Attribute [result]: string "RSPR`RSPR" +Attribute [result]: string "RSN`RSNS" +Attribute [result]: string "RJ`RJR" +Attribute [result]: string "RF`RF" +Attribute [result]: string "SLFTR`SLFTR" +Attribute [result]: string "SNHSNT`SNHSNT" +Attribute [result]: string "XNKR`SKNKR" +Attribute [result]: string "XRMRRN`SKRMRRN" +Attribute [result]: string "XLSNKR`SLSNJR" +Attribute [result]: string "SKL`SKL" +Attribute [result]: string "SKNR`SKNR" +Attribute [result]: string "SKST`SKST" +Attribute [result]: string "XKR`SKR" +Attribute [result]: string "XKR`SKR" +Attribute [result]: string "TKLR`TLR" +Attribute [result]: string "TMS`TMS" +Attribute [result]: string "TMS`TMS" +Attribute [result]: string "0M`TM" +Attribute [result]: string "TXNR`TKNR" +Attribute [result]: string "TF`TF" +Attribute [result]: string "FK`FK" +Attribute [result]: string "AKTLR`FKTLR" +Attribute [result]: string "AKSLR`FKSLR" +Attribute [result]: string "ART`FRT" +Attribute [result]: string "SF`SFR" +Attribute [result]: string "ANKLFX`ANKLFK" +Attribute [result]: string "J`J" +Attribute [result]: string "MKLLN`MKLLN" +Attribute [result]: string "MRS`MRS" +Attribute [result]: string "APR`APR" +Attribute [result]: string "KMPRL`KMPR" +Attribute [result]: string "HT`HT" +Attribute [result]: string "K0RN`KTRN" +Attribute [result]: string "K0RN`KTRN" +Attribute [result]: string "RXRT`RKRT" +Attribute [result]: string "PP`PP" +Attribute [result]: string "ARK`ARK" +Attribute [result]: string "JF`KF" +Attribute [result]: string "TF`TF" +Attribute [result]: string "R`R" +Attribute [result]: string "STFN`STFN" +Attribute [result]: string "PRS`PRS" +Attribute [result]: string "RNT`RNT" +Attribute [result]: string "PRN`PRN" +Attribute [result]: string "PRN`PRN" +Attribute [result]: string "AT`AT" +Attribute [result]: string "AT`AT" +Attribute [result]: string "APT`APT" +Attribute [result]: string "PK`PK" +Attribute [result]: string "PKR`PKR" +Attribute [result]: string "XRLS`XRLS" +Attribute [result]: string "KN`KN" +Attribute [result]: string "NM`NM" +Attribute [result]: string "RJ`R" +Attribute [result]: string "KNTN`KNTN" +Attribute [result]: string "A`A" +Attribute [result]: string "XMKR`XMKR" +Attribute [result]: string "SN`XN" +Attribute [result]: string "SKLT`SKLT" +Attribute [result]: string "STXN`STXN" +Attribute [result]: string "MX`MX" +Attribute [result]: string "PS`PTS" +Attribute [result]: string "AKNS`ANS" +Attribute [result]: string "SNS`SNS" +Attribute [result]: string "FNKK`FNKK" +Attribute [result]: string "JSF`HSF" +Attribute [result]: string "APJKT`APJKT" +Attribute [result]: string "SLS`SLS" +Attribute [result]: string "XRF`XRF" +Attribute [result]: string "KS`KS" +Attribute [result]: string "FNKLR`FNKLR" diff --git a/centrallix/tests/test_expfn_double_metaphone_00.to b/centrallix/tests/test_expfn_double_metaphone_00.to new file mode 100644 index 000000000..efd7548cc --- /dev/null +++ b/centrallix/tests/test_expfn_double_metaphone_00.to @@ -0,0 +1,161 @@ +##NAME double_metaphone() function + +# Special thanks to the following websites for double checking the correct results: +# 1: https://words.github.io/double-metaphone +# 2: https://mainegenealogy.net/metaphone_converter.asp +# 3: https://en.toolpage.org/tool/metaphone + +# These tests were collected from the following sources: +# - Example comments in the source code of exp_double_metaphone.c +# - Maurice Aubrey's Tests* +# - Tests manually written by Israel Fuller +# - Tests written by prompting ChatGPT-5 (preview)** +# +# *Source: https://github.com/gitpan/Text-DoubleMetaphone/blob/master/t/words.txt +# **GPT-5 mini (Preview) was run in GitHub Copilot to suggest the words +# for some tests after analizing a generated coverage report. I (Israel) +# used the suggestions to write some "AI generated" test cases. +# +# For more information, see the manual test suite implementation at the +# end of the exp_double_metaphone.c file. + +query select result = double_metaphone("Test") +query select result = double_metaphone("Basic") +query select result = double_metaphone("Centrallix") +query select result = double_metaphone("Lawrence") +query select result = double_metaphone("Philips") +query select result = double_metaphone("Acceptingness") +query select result = double_metaphone("Supercalifragilisticexpialidocious") +query select result = double_metaphone("Suoicodilaipxecitsiligarfilacrepus") +query select result = double_metaphone("Smith") +query select result = double_metaphone("Schmidt") +query select result = double_metaphone("Snider") +query select result = double_metaphone("Schneider") +query select result = double_metaphone("Arnow") +query select result = double_metaphone("Arnoff") +query select result = double_metaphone("Accede") +query select result = double_metaphone("Accident") +query select result = double_metaphone("Actually") +query select result = double_metaphone("Arch") +query select result = double_metaphone("Artois") +query select result = double_metaphone("Bacchus") +query select result = double_metaphone("Bacci") +query select result = double_metaphone("Bajador") +query select result = double_metaphone("Bellocchio") +query select result = double_metaphone("Bertucci") +query select result = double_metaphone("Biaggi") +query select result = double_metaphone("Bough") +query select result = double_metaphone("Breaux") +query select result = double_metaphone("Broughton") +query select result = double_metaphone("Cabrillo") +query select result = double_metaphone("Caesar") +query select result = double_metaphone("Cagney") +query select result = double_metaphone("Campbell") +query select result = double_metaphone("Carlisle") +query select result = double_metaphone("Carlysle") +query select result = double_metaphone("Chemistry") +query select result = double_metaphone("Chianti") +query select result = double_metaphone("Chorus") +query select result = double_metaphone("Cough") +query select result = double_metaphone("Czerny") +query select result = double_metaphone("Dumb") +query select result = double_metaphone("Edgar") +query select result = double_metaphone("Edge") +query select result = double_metaphone("Filipowicz") +query select result = double_metaphone("Focaccia") +query select result = double_metaphone("Gallegos") +query select result = double_metaphone("Germanic") +query select result = double_metaphone("Ghiradelli") +query select result = double_metaphone("Ghislane") +query select result = double_metaphone("Gospel") +query select result = double_metaphone("Gough") +query select result = double_metaphone("Greek") +query select result = double_metaphone("Hochmeier") +query select result = double_metaphone("Hugh") +query select result = double_metaphone("Island") +query select result = double_metaphone("Isle") +query select result = double_metaphone("Italian") +query select result = double_metaphone("Jankelowicz") +query select result = double_metaphone("Jose") +query select result = double_metaphone("Laugh") +query select result = double_metaphone("Mac Caffrey") +query select result = double_metaphone("Mac Gregor") +query select result = double_metaphone("Manager") +query select result = double_metaphone("McHugh") +query select result = double_metaphone("McLaughlin") +query select result = double_metaphone("Michael") +query select result = double_metaphone("Middle") +query select result = double_metaphone("Orchestra") +query select result = double_metaphone("Orchid") +query select result = double_metaphone("Pinyin") +query select result = double_metaphone("Raspberry") +query select result = double_metaphone("Resnais") +query select result = double_metaphone("Rogier") +query select result = double_metaphone("Rough") +query select result = double_metaphone("Salvador") +query select result = double_metaphone("San jacinto") +query select result = double_metaphone("Schenker") +query select result = double_metaphone("Schermerhorn") +query select result = double_metaphone("Schlesinger") +query select result = double_metaphone("School") +query select result = double_metaphone("Schooner") +query select result = double_metaphone("Succeed") +query select result = double_metaphone("Sugar") +query select result = double_metaphone("Sugary") +query select result = double_metaphone("Tagliaro") +query select result = double_metaphone("Thames") +query select result = double_metaphone("Thomas") +query select result = double_metaphone("Thumb") +query select result = double_metaphone("Tichner") +query select result = double_metaphone("Tough") +query select result = double_metaphone("Vghee") +query select result = double_metaphone("Wachtler") +query select result = double_metaphone("Wechsler") +query select result = double_metaphone("Word") +query select result = double_metaphone("Xavier") +query select result = double_metaphone("Yankelovich") +query select result = double_metaphone("Zhao") +query select result = double_metaphone("McClellan") +query select result = double_metaphone("maurice") +query select result = double_metaphone("aubrey") +query select result = double_metaphone("cambrillo") +query select result = double_metaphone("heidi") +query select result = double_metaphone("katherine") +query select result = double_metaphone("catherine") +query select result = double_metaphone("richard") +query select result = double_metaphone("bob") +query select result = double_metaphone("eric") +query select result = double_metaphone("geoff") +query select result = double_metaphone("dave") +query select result = double_metaphone("ray") +query select result = double_metaphone("steven") +query select result = double_metaphone("bryce") +query select result = double_metaphone("randy") +query select result = double_metaphone("bryan") +query select result = double_metaphone("brian") +query select result = double_metaphone("otto") +query select result = double_metaphone("auto") +query select result = double_metaphone("Abbott") +query select result = double_metaphone("Back") +query select result = double_metaphone("Bacher") +query select result = double_metaphone("Charles") +query select result = double_metaphone("Ghana") +query select result = double_metaphone("Gnome") +query select result = double_metaphone("Raj") +query select result = double_metaphone("Quentin") +query select result = double_metaphone("Who") +query select result = double_metaphone("Shoemaker") +query select result = double_metaphone("Sian") +query select result = double_metaphone("Scold") +query select result = double_metaphone("Station") +query select result = double_metaphone("Match") +query select result = double_metaphone("Pizza") +query select result = double_metaphone("Agnes") +query select result = double_metaphone("Science") +query select result = double_metaphone("Van Gogh") +query select result = double_metaphone("Josef") +query select result = double_metaphone("Object") +query select result = double_metaphone("Sholz") +query select result = double_metaphone("Scharf") +query select result = double_metaphone("Kasia") +query select result = double_metaphone("Van Geller") From 994e99fa9c6f494b9709f4dac99d9924b5b1b95e Mon Sep 17 00:00:00 2001 From: Israel Date: Tue, 14 Oct 2025 11:41:41 -0600 Subject: [PATCH 002/275] Checkpoint: Switching to DM project. --- centrallix-lib/Makefile.in | 2 +- centrallix-os/cluster-schema.cluster | 10 +- centrallix/osdrivers/objdrv_cluster.c | 699 ++++++++++++++++++++++---- 3 files changed, 602 insertions(+), 109 deletions(-) diff --git a/centrallix-lib/Makefile.in b/centrallix-lib/Makefile.in index 20c57c11f..0daf7e568 100644 --- a/centrallix-lib/Makefile.in +++ b/centrallix-lib/Makefile.in @@ -66,7 +66,7 @@ TCFLAGS=$(patsubst -DNDEBUG,,$(CFLAGS)) XSTATICFILES=mtask.o mtlexer.o memstr.o xarray.o xhash.o xstring.o mtsession.o newmalloc.o xhashqueue.o bdqs_transport.o xhandle.o xringqueue.o cxsec.o smmalloc.o clusters.o qprintf.o strtcpy.o util.o STATICFILES=$(patsubst %,src/%,$(XSTATICFILES)) -XDYNAMICFILES=mtask.lo mtlexer.lo memstr.lo xarray.lo xhash.lo xstring.lo mtsession.lo newmalloc.lo xhashqueue.lo bdqs_transport.lo xhandle.lo xringqueue.lo cxsec.lo smmalloc.lo clusters.o qprintf.lo strtcpy.lo util.lo +XDYNAMICFILES=mtask.lo mtlexer.lo memstr.lo xarray.lo xhash.lo xstring.lo mtsession.lo newmalloc.lo xhashqueue.lo bdqs_transport.lo xhandle.lo xringqueue.lo cxsec.lo smmalloc.lo clusters.lo qprintf.lo strtcpy.lo util.lo DYNAMICFILES=$(patsubst %,src/%,$(XDYNAMICFILES)) INCLUDEFILES:=$(wildcard include/*.h) diff --git a/centrallix-os/cluster-schema.cluster b/centrallix-os/cluster-schema.cluster index 201c41255..a97d7f9ba 100644 --- a/centrallix-os/cluster-schema.cluster +++ b/centrallix-os/cluster-schema.cluster @@ -51,16 +51,16 @@ file_name "system/cluster" - /average_similarity : double && 0.0 < x < 1.0 - /size = average_similarity - /{arbitrary uint} - - /val : typeof(attr_name) // The value of the data point. + - /val : string // The value of the data point. - /label : uint < num_clusters // id of the cluster to which this data point belongs. - /sim : double && 0.0 < x <= threshold // Similarity to cluster centroid. ... /search_name - /{arbitrary uint} - - /id1 : uint // The id of the first data point. - - /id2 : uint // The id of the second data point. - - /val1 : typeof(attr_name) // The value of the first data point. - - /val2 : typeof(attr_name) // The value of the second data point. + - /id1 : uint < sizeof(source/attr_name) // The id of the first data point. + - /id2 : uint < sizeof(source/attr_name) // The id of the second data point. + - /val1 : string // The value of the first data point. + - /val2 : string // The value of the second data point. - /sim : double && 0.0 < x <= threshold // The similarity of the two data points. ... diff --git a/centrallix/osdrivers/objdrv_cluster.c b/centrallix/osdrivers/objdrv_cluster.c index 9ffbd1d22..2369bc1fb 100644 --- a/centrallix/osdrivers/objdrv_cluster.c +++ b/centrallix/osdrivers/objdrv_cluster.c @@ -74,9 +74,9 @@ /** Debugging **/ -// void void_func() {} -// #define tprintf void_func -#define tprintf printf +void void_func() {} +#define tprintf void_func +// #define tprintf printf /** Defaults for unspecified optional attributes. **/ #define DEFAULT_MIN_IMPROVEMENT 0.0001 @@ -181,33 +181,62 @@ void mssErrorf(int clr, char* module, const char* format, ...) /** TODO: I think this should be moved to datatypes. **/ /** Should maybe replace current type parsing in the presentation hints. **/ +/*** Parse the given string into a datatype. The case of the first character + *** is ignored, but all other characters must be capitalized correctly. + *** + *** @attention - This function is optimized to prevent performance hits + *** situations where it may need to be called many thousands of times. + *** + *** @param str The string to be parsed to a datatype. + *** @returns The datatype. + *** + *** LINK ../../centrallix-lib/include/datatypes.h:72 + ***/ int ci_TypeFromStr(const char* str) { - if (str == NULL) return -1; - - /** Check string length. **/ - const size_t len = strlen(str); - if (len < 3 || 13 < len) return -1; - - /** Copy str to enable mutability. **/ - char buf[len + 1u]; - strcpy(buf, str); - - /** First character is case insensitive. **/ - buf[0] = toupper(buf[0]); + /** All valid types are non-null strings, at least 2 characters long. **/ + if (str == NULL || str[0] == '\0' || str[1] == '\0') return -1; /** Check type. **/ - if (strcmp(buf, "Any") == 0) return DATA_T_UNAVAILABLE; - if (strcmp(buf, "Integer") == 0) return DATA_T_INTEGER; - if (strcmp(buf, "String") == 0) return DATA_T_STRING; - if (strcmp(buf, "Double") == 0) return DATA_T_DOUBLE; - if (strcmp(buf, "DateTime") == 0) return DATA_T_DATETIME; - if (strcmp(buf, "IntVecor") == 0) return DATA_T_INTVEC; - if (strcmp(buf, "StringVector") == 0) return DATA_T_STRINGVEC; - if (strcmp(buf, "Money") == 0) return DATA_T_MONEY; - if (strcmp(buf, "Array") == 0) return DATA_T_ARRAY; - if (strcmp(buf, "Code") == 0) return DATA_T_CODE; - if (strcmp(buf, "Binary") == 0) return DATA_T_BINARY; + switch (str[0]) + { + case 'A': case 'a': + if (strcmp(str+1, "Array"+1) == 0) return DATA_T_ARRAY; + if (strcmp(str+1, "Any"+1) == 0) return DATA_T_ANY; + break; + + case 'B': case 'b': + if (strcmp(str+1, "Binary"+1) == 0) return DATA_T_BINARY; + break; + + case 'C': case 'c': + if (strcmp(str+1, "Code"+1) == 0) return DATA_T_CODE; + break; + + case 'D': case 'd': + if (strcmp(str+1, "Double"+1) == 0) return DATA_T_DOUBLE; + if (strcmp(str+1, "DateTime"+1) == 0) return DATA_T_DATETIME; + break; + + case 'I': case 'i': + if (strcmp(str+1, "Integer"+1) == 0) return DATA_T_INTEGER; + if (strcmp(str+1, "IntVecor"+1) == 0) return DATA_T_INTVEC; + break; + + case 'M': case 'm': + if (strcmp(str+1, "Money"+1) == 0) return DATA_T_MONEY; + break; + + case 'S': case 's': + if (strcmp(str+1, "String"+1) == 0) return DATA_T_STRING; + if (strcmp(str+1, "StringVector"+1) == 0) return DATA_T_STRINGVEC; + break; + + case 'U': case 'u': + if (strcmp(str+1, "Unknown"+1) == 0) return DATA_T_UNAVAILABLE; + if (strcmp(str+1, "Unavailable"+1) == 0) return DATA_T_UNAVAILABLE; + break; + } /** Invalid type. **/ return -1; @@ -220,21 +249,21 @@ char* ci_TypeToStr(const int type) switch (type) { case DATA_T_UNAVAILABLE: return "Unknown"; - case DATA_T_INTEGER: return "Integer"; - case DATA_T_STRING: return "String"; - case DATA_T_DOUBLE: return "Double"; - case DATA_T_DATETIME: return "DateTime"; - case DATA_T_INTVEC: return "IntVecor"; - case DATA_T_STRINGVEC: return "StringVector"; - case DATA_T_MONEY: return "Money"; - case DATA_T_ARRAY: return "Array"; - case DATA_T_CODE: return "Code"; - case DATA_T_BINARY: return "Binary"; + case DATA_T_INTEGER: return "Integer"; + case DATA_T_STRING: return "String"; + case DATA_T_DOUBLE: return "Double"; + case DATA_T_DATETIME: return "DateTime"; + case DATA_T_INTVEC: return "IntVecor"; + case DATA_T_STRINGVEC: return "StringVector"; + case DATA_T_MONEY: return "Money"; + case DATA_T_ARRAY: return "Array"; + case DATA_T_CODE: return "Code"; + case DATA_T_BINARY: return "Binary"; } /** Invalid type. **/ mssErrorf(1, "Cluster", "Invalid type %d.\n", type); - return "Invalid"; + return "Invalid"; /* Shall not parse to a valid type in ci_TypeFromStr(). */ } /** TODO: I think this should be moved to xarray. **/ @@ -252,6 +281,19 @@ void** ci_xaToTrimmedArray(pXArray arr) return result; } +/** I got tired of forgetting how to do these. **/ +#define ci_file_name(obj) \ + ({ \ + __typeof__ (obj) _obj = (obj); \ + obj_internal_PathPart(_obj->Pathname, _obj->SubPtr - 1, 1); \ + }) +#define ci_file_path(obj) \ + ({ \ + __typeof__ (obj) _obj = (obj); \ + obj_internal_PathPart(_obj->Pathname, 0, _obj->SubPtr); \ + }) + + /** ================ Enum Declairations ================ **/ /** ANCHOR[id=enums] **/ @@ -265,6 +307,18 @@ typedef unsigned char ClusterAlgorithm; #define ALGORITHM_KMEDOIDS (ClusterAlgorithm)5u #define ALGORITHM_DB_SCAN (ClusterAlgorithm)6u +#define nClusteringAlgorithms 7u +ClusterAlgorithm ALL_CLUSTERING_ALGORITHMS[nClusteringAlgorithms] = + { + ALGORITHM_NULL, + ALGORITHM_NONE, + ALGORITHM_SLIDING_WINDOW, + ALGORITHM_KMEANS, + ALGORITHM_KMEANS_PLUS_PLUS, + ALGORITHM_KMEDOIDS, + ALGORITHM_DB_SCAN, + }; + /** Converts a clustering algorithm to its string name. **/ char* ci_ClusteringAlgorithmToString(ClusterAlgorithm clustering_algorithm) { @@ -287,6 +341,14 @@ typedef unsigned char SimilarityMeasure; #define SIMILARITY_COSINE (SimilarityMeasure)1u #define SIMILARITY_LEVENSHTEIN (SimilarityMeasure)2u +#define nSimilarityMeasures 3u +SimilarityMeasure ALL_SIMILARITY_MEASURES[nSimilarityMeasures] = + { + SIMILARITY_NULL, + SIMILARITY_COSINE, + SIMILARITY_LEVENSHTEIN, + }; + /** Converts a similarity measure to its string name. **/ char* ci_SimilarityMeasureToString(SimilarityMeasure similarity_measure) { @@ -319,39 +381,48 @@ char* const ATTR_ROOT[nATTR_ROOT] = { "source", "attr_name", }; -#define nATTR_CLUSTER 5u -char* const ATTR_CLUSTER[nATTR_CLUSTER] = { +#define nATTR_CLUSTER 7u +char* const ATTR_CLUSTER[nATTR_CLUSTER] = + { "algorithm", "similarity_measure", "num_clusters", "min_improvement", "max_iterations", -}; -#define nATTR_SEARCH 4u -char* const ATTR_SEARCH[nATTR_SEARCH] = { + "date_created", + "date_computed", + }; +#define nATTR_SEARCH 5u +char* const ATTR_SEARCH[nATTR_SEARCH] = + { "source", "threshold", "similarity_measure", -}; + "date_created", + "date_computed", + }; #define nATTR_CLUSTER_ENTRY 2u -char* const ATTR_CLUSTER_ENTRY[nATTR_CLUSTER_ENTRY] = { +char* const ATTR_CLUSTER_ENTRY[nATTR_CLUSTER_ENTRY] = + { "val", "sim", -}; + }; #define nATTR_SEARCH_ENTRY 3u -char* const ATTR_SEARCH_ENTRY[nATTR_SEARCH_ENTRY] = { +char* const ATTR_SEARCH_ENTRY[nATTR_SEARCH_ENTRY] = + { "val1", "val2", "sim", -}; + }; #define END_OF_ATTRIBUTES NULL /** Method name list. **/ #define nMETHOD_NAME 2u -char* const METHOD_NAME[nMETHOD_NAME] = { +char* const METHOD_NAME[nMETHOD_NAME] = + { "cache", -}; + }; #define END_OF_METHODS END_OF_ATTRIBUTES @@ -362,27 +433,31 @@ char* const METHOD_NAME[nMETHOD_NAME] = { typedef struct _SOURCE { /** Top level attributes (specified in the .cluster file). **/ - char* Name; /* The node name, specified in the .cluster file. - * Warning: Some code makes the assumption that this - * is the first field in the struct. - */ - char* Key; /* The key associated with this object in the global SourceCache. */ - char* SourcePath; /* The path to the data source from which to retrieve data. */ - char* AttrName; /* The name of the attribute to get from the data source. */ + char* Name; /* The node name, specified in the .cluster file. + * Warning: Some code makes the assumption that this + * is the first field in the struct. + */ + char* Key; /* The key associated with this object in the global SourceCache. */ + char* SourcePath; /* The path to the data source from which to retrieve data. */ + char* AttrName; /* The name of the attribute to get from the data source. */ /** Computed data. **/ - char** Data; /* The data strings to be clustered and searched, or NULL if they - * have not been fetched from the source. - */ - pVector* Vectors; /* The cosine comparison vectors from the fetched data, or NULL if - * they haven't been computed. Note that vectors are no longer - * needed once all clusters and searches have been computed, so - * they are automatically freed in that case to save memory. - */ - unsigned int nVectors; /* The number of vectors and data strings. Note: This is not - * set to 0 if the vector array is freed, this case should be - * checked separately. - */ + char** Data; /* The data strings to be clustered and searched, or NULL if they + * have not been fetched from the source. + */ + pVector* Vectors; /* The cosine comparison vectors from the fetched data, or NULL if + * they haven't been computed. Note that vectors are no longer + * needed once all clusters and searches have been computed, so + * they are automatically freed in that case to save memory. + */ + unsigned int nVectors; /* The number of vectors and data strings. Note: This is not + * set to 0 if the vector array is freed, this case should be + * checked separately. + */ + + /** Time. **/ + DateTime DateCreated; /* The date and time that this object was created and initialized. */ + DateTime DateComputed; /* The date and time that the Data and Vectors fields were computed. */ } SourceData, *pSourceData; /** Data for each cluster. **/ @@ -415,6 +490,10 @@ typedef struct _CLUSTER * (aka. DriverData->nVectors). For vector i, Labels[i] is * the ID of the cluster to which that data is assigned. * NULL if the cluster has not been computed. */ + + /** Time. **/ + DateTime DateCreated; /* The date and time that this object was created and initialized. */ + DateTime DateComputed; /* The date and time that the Labels field was computed. */ } ClusterData, *pClusterData; @@ -437,6 +516,10 @@ typedef struct _SEARCH * if the search has not been computed. */ unsigned int nDups; /* The number of dups found. */ + + /** Time. **/ + DateTime DateCreated; /* The date and time that this object was created and initialized. */ + DateTime DateComputed; /* The date and time that the Dups field was computed. */ } SearchData, *pSearchData; @@ -463,8 +546,6 @@ typedef struct _NODE /** Other stuff, idk why it's here. **/ pSnNode Node; pObject Obj; - char* CreateDateField; - char* ModifyDateField; } NodeData, *pNodeData; @@ -694,6 +775,7 @@ int ci_ParseAttribute( } +// LINK #functions /*** Parses a ClusteringAlgorithm from the algorithm field in the pStructInf *** representing some structure with that attribute in a parsed structure file. *** @@ -729,6 +811,7 @@ ClusterAlgorithm ci_ParseClusteringAlgorithm(pStructInf inf, pParamObjects param } +// LINK #functions /*** Parses a SimilarityMeasure from the similarity_measure field in the given *** pStructInf parameter, which represents some structure with that attribute *** in a parsed structure file. @@ -760,6 +843,7 @@ SimilarityMeasure ci_ParseSimilarityMeasure(pStructInf inf, pParamObjects param_ } +// LINK #functions /*** Allocates a new pSourceData struct from a parsed pStructInf representing *** a .cluster structure file. *** @@ -816,6 +900,7 @@ pSourceData ci_ParseSourceData(pStructInf inf, pParamObjects param_list, char* p source_data->Key = key; source_data->SourcePath = source_path; source_data->AttrName = attr_name; + check(objCurrentDate(&source_data->DateCreated)); /** Add the new object to the cache for next time. **/ tprintf("+ source: \"%s\"\n", key); @@ -829,6 +914,7 @@ pSourceData ci_ParseSourceData(pStructInf inf, pParamObjects param_list, char* p } +// LINK #functions /*** Allocates a new pClusterData struct from a parsed pStructInf. *** *** @attention - Warning: Caching in use. @@ -858,6 +944,7 @@ pClusterData ci_ParseClusterData(pStructInf inf, pNodeData node_data) /** Basic Properties. **/ cluster_data->Name = check_ptr(strdup(inf->Name)); cluster_data->SourceData = source_data; + check(objCurrentDate(&cluster_data->DateCreated)); /** Get algorithm. **/ cluster_data->ClusterAlgorithm = ci_ParseClusteringAlgorithm(inf, param_list); @@ -1046,6 +1133,7 @@ pClusterData ci_ParseClusterData(pStructInf inf, pNodeData node_data) } +// LINK #functions /*** Allocates a new pSearchData struct from a parsed pStructInf. *** *** @attention - Warning: Caching in use. @@ -1068,8 +1156,9 @@ pSearchData ci_ParseSearchData(pStructInf inf, pNodeData node_data) assert(search_data != NULL); memset(search_data, 0, sizeof(SearchData)); - /** Get search name. **/ + /** Get basic information. **/ search_data->Name = check_ptr(strdup(inf->Name)); + check(objCurrentDate(&search_data->DateCreated)); /** Get source. **/ char* source_name; @@ -1147,6 +1236,7 @@ pSearchData ci_ParseSearchData(pStructInf inf, pNodeData node_data) } +// LINK #functions /*** Allocates a new pNodeData struct from a parsed pStructInf. *** *** @attention - Does not use caching directly, but uses subfunctions to @@ -1164,7 +1254,7 @@ pNodeData ci_ParseNodeData(pStructInf inf, pObject obj) int ret; /** Retrieve path so we'll know we have it later. **/ - char* path = obj_internal_PathPart(obj->Pathname, 0, obj->SubPtr); + char* path = ci_file_path(obj); /** Allocate node struct data. **/ // pNodeData node_data = NodeData |> sizeof() |> nmMalloc() |> check_ptr(); @@ -1404,6 +1494,7 @@ void ci_FreeSourceData(pSourceData source_data) } +// LINK #functions /*** Free pClusterData struct with an option to recursively free subclusters. *** *** @param cluster_data The cluster data struct to free. @@ -1437,6 +1528,7 @@ void ci_FreeClusterData(pClusterData cluster_data, bool recursive) } +// LINK #functions /** @param search_data A pSearchData struct, freed by this function. **/ void ci_FreeSearchData(pSearchData search_data) { @@ -1451,6 +1543,7 @@ void ci_FreeSearchData(pSearchData search_data) } +// LINK #functions /** @param node_data A pNodeData struct, freed by this function. **/ void ci_FreeNodeData(pNodeData node_data) { @@ -1541,6 +1634,7 @@ unsigned int ci_SizeOfSourceData(pSourceData source_data) } +// LINK #functions /*** Returns the deep size of a ClusterData struct, including the size of all *** allocated substructures. As far as I can tell, this is probably only *** useful for cache management and debugging. @@ -1571,6 +1665,7 @@ unsigned int ci_SizeOfClusterData(pClusterData cluster_data, bool recursive) } +// LINK #functions /*** Returns the deep size of a SearchData struct, including the size of all *** allocated substructures. As far as I can tell, this is probably only *** useful for cache management and debugging. @@ -1591,6 +1686,7 @@ unsigned int ci_SizeOfSearchData(pSearchData search_data) } +// LINK #functions /*** Returns the deep size of a NodeData struct, including the size of all *** allocated substructures. As far as I can tell, this is probably only *** useful for cache management and debugging. @@ -1656,6 +1752,7 @@ void ci_CacheFreeSourceData(pXHashEntry entry, void* _) nmSysFree(key); } +// LINK #functions /** Intended for use in xhClearKeySafe(). **/ void ci_CacheFreeCluster(pXHashEntry entry, void* _) { @@ -1669,6 +1766,7 @@ void ci_CacheFreeCluster(pXHashEntry entry, void* _) nmSysFree(key); } +// LINK #functions /** Intended for use in xhClearKeySafe(). **/ void ci_CacheFreeSearch(pXHashEntry entry, void* _) { @@ -1731,6 +1829,10 @@ int ci_ComputeSourceData(pSourceData source_data, pObjSession session) source_data->nVectors = 0; } + /** Record the date and time. **/ + /** Even if this computation fails, we may want this information. **/ + check(objCurrentDate(&source_data->DateComputed)); + /** Time to play shoots-and-ladders in an error-handling jungle of gotos. **/ bool successful = false; int ret; @@ -1929,6 +2031,8 @@ int ci_ComputeSourceData(pSourceData source_data, pObjSession session) return (successful) ? 0 : -1; } + +// LINK #functions /*** Ensures that the cluster_data->Labels has been computed, running the *** specified clustering algorithm if necessary. *** @@ -1955,6 +2059,10 @@ int ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data) goto err; } + /** Record the date and time. **/ + /** Even if this computation fails, we may want this information. **/ + check(objCurrentDate(&cluster_data->DateComputed)); + /** Allocate static memory for finding clusters. **/ const size_t labels_size = source_data->nVectors * sizeof(unsigned int); cluster_data->Labels = check_ptr(nmMalloc(labels_size)); @@ -2012,6 +2120,8 @@ int ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data) return -1; } + +// LINK #functions /*** Ensures that the search_data->Dups has been computed, running the a *** search with the specified similarity measure if necessary. *** @@ -2052,6 +2162,10 @@ int ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) goto err; } + /** Record the date and time. **/ + /** Even if this computation fails, we may want this information. **/ + check(objCurrentDate(&search_data->DateComputed)); + /** Execute the search. **/ tprintf("Invoking ca_search.\n"); Timer timer_i, *timer = timer_start(timer_init(&timer_i)); @@ -2115,6 +2229,7 @@ int ci_GetParamType(void* inf_v, const char* attr_name) } +// LINK #functions /*** Get the value of a parameter. Intended for `expSetParamFunctions()`. *** *** @attention - Warning: If the retrieved value is `NULL`, the pObjectData @@ -2191,7 +2306,7 @@ int ci_SetParamValue(void* inf_v, char* attr_name, int datatype, pObjData val) *** @param obj The object being opened, including the path, session, and *** other necessary information. *** @param mask Driver permission mask (unused). - *** @param systype ? (unused) + *** @param sys_type ? (unused) *** @param usr_type The object system file type being openned. Should always *** be "system/cluster" because this driver is only registered for that *** type of file. @@ -2200,12 +2315,9 @@ int ci_SetParamValue(void* inf_v, char* attr_name, int datatype, pObjData val) *** @returns A pDriverData struct representing a driver instance, or *** NULL if an error occures. ***/ -void* clusterOpen(pObject obj, int mask, pContentType systype, char* usr_type, pObjTrxTree* oxt) +void* clusterOpen(pObject obj, int mask, pContentType sys_type, char* usr_type, pObjTrxTree* oxt) { - tprintf( - "Warning: clusterOpen(\"%s\") is under active development.\n", - obj_internal_PathPart(obj->Pathname, obj->SubPtr + obj->SubCnt, 1) - ); + tprintf("Warning: clusterOpen(\"%s\") is under active development.\n", ci_file_name(obj)); /** If CREAT and EXCL are specified, create it and fail if it already exists. **/ pSnNode node_struct = NULL; @@ -2239,10 +2351,7 @@ void* clusterOpen(pObject obj, int mask, pContentType systype, char* usr_type, p pNodeData node_data = ci_ParseNodeData(node_struct->Data, obj); if (node_data == NULL) { - mssErrorf(0, "Cluster", - "Failed to parse structure file of name %s.", - obj_internal_PathPart(obj->Pathname, obj->SubPtr + obj->SubCnt, 1) - ); + mssErrorf(0, "Cluster", "Failed to parse structure file \"%s\".", ci_file_name(obj)); goto err; } node_data->Node = node_struct; @@ -2343,6 +2452,7 @@ void* clusterOpen(pObject obj, int mask, pContentType systype, char* usr_type, p } +// LINK #functions /*** Close a cluster driver instance object, releasing any necessary memory *** and closing any necessary underlying resources. However, most of that *** data will be cached and won't be freed unless the cache is dropped. @@ -2374,6 +2484,7 @@ int clusterClose(void* inf_v, pObjTrxTree* oxt) } +// LINK #functions /*** Opens a new query pointing to the first row of the data targetted by *** the driver instance struct. The query has an internal index counter *** that starts at the first row and increments as data is fetched. @@ -2394,6 +2505,7 @@ void* clusterOpenQuery(void* inf_v, pObjQuery query, pObjTrxTree* oxt) } +// LINK #functions /*** Get the next entry as an open driver instance object. *** *** @param qy_v A query instance, storing an internal index which is @@ -2477,6 +2589,7 @@ void* clusterQueryFetch(void* qy_v, pObject obj, int mode, pObjTrxTree* oxt) } +// LINK #functions /*** Close a cluster query instance, releasing any necessary memory and *** closing any necessary underlying resources. This does not close the *** underlying driver instance, which must be closed with clusterClose(). @@ -2494,6 +2607,7 @@ int clusterQueryClose(void* qy_v, pObjTrxTree* oxt) } +// LINK #functions /*** Get the type of a cluster driver instance attribute. *** *** @param inf_v The driver instance. @@ -2507,13 +2621,6 @@ int clusterGetAttrType(void* inf_v, char* attr_name, pObjTrxTree* oxt) { pDriverData driver_data = (pDriverData)inf_v; - /** Performance shortcut for frequently requested attributes: val1, val2, and sim. **/ - if (attr_name[0] == 'v' || attr_name[0] == 's') goto handle_targets; - - /** Debug info. **/ - if (oxt == NULL) tprintf(" > "); - tprintf("Call to clusterGetAttrType(%s)\n", attr_name); - /** Guard possible segfault. **/ if (attr_name == NULL) { @@ -2521,6 +2628,13 @@ int clusterGetAttrType(void* inf_v, char* attr_name, pObjTrxTree* oxt) return DATA_T_UNAVAILABLE; } + /** Performance shortcut for frequently requested attributes: val, val1, val2, and sim. **/ + if (attr_name[0] == 'v' || attr_name[0] == 's') goto handle_targets; + + /** Debug info. **/ + if (oxt == NULL) tprintf(" > "); + tprintf("Call to clusterGetAttrType(%s)\n", attr_name); + /** Types for general attributes. **/ if (strcmp(attr_name, "name") == 0 || strcmp(attr_name, "annotation") == 0 @@ -2530,6 +2644,12 @@ int clusterGetAttrType(void* inf_v, char* attr_name, pObjTrxTree* oxt) return DATA_T_STRING; if (strcmp(attr_name, "last_modification") == 0) return DATA_T_DATETIME; + if ((strcmp(attr_name, "date_created") == 0 + || strcmp(attr_name, "date_computed") == 0) + && + (driver_data->TargetType == TARGET_CLUSTER + || driver_data->TargetType == TARGET_SEARCH)) + return DATA_T_DATETIME; /** Types for specific data targets. **/ handle_targets: @@ -2566,10 +2686,7 @@ int clusterGetAttrType(void* inf_v, char* attr_name, pObjTrxTree* oxt) if (strcmp(attr_name, "id") == 0) return DATA_T_INTEGER; if (strcmp(attr_name, "val") == 0) - { - /** TODO: Replace with type calculation. **/ return DATA_T_STRING; - } if (strcmp(attr_name, "sim") == 0) return DATA_T_DOUBLE; break; @@ -2580,10 +2697,7 @@ int clusterGetAttrType(void* inf_v, char* attr_name, pObjTrxTree* oxt) return DATA_T_INTEGER; if (strcmp(attr_name, "val1") == 0 || strcmp(attr_name, "val2") == 0) - { - /** TODO: Replace with type calculation. **/ return DATA_T_STRING; - } if (strcmp(attr_name, "sim") == 0) return DATA_T_DOUBLE; break; @@ -2597,6 +2711,7 @@ int clusterGetAttrType(void* inf_v, char* attr_name, pObjTrxTree* oxt) } +// LINK #functions /*** Get the value of a cluster driver instance attribute. *** *** @param inf_v Node data containing the list of paramenters. @@ -2619,7 +2734,14 @@ int clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val { pDriverData driver_data = (pDriverData)inf_v; - /** Performance shortcut for frequently requested attributes: val1, val2, and sim. **/ + /** Guard possible segfault. **/ + if (attr_name == NULL) + { + fprintf(stderr, "Warning: Call to clusterGetAttrType() with NULL attribute name.\n"); + return DATA_T_UNAVAILABLE; + } + + /** Performance shortcut for frequently requested attributes: val, val1, val2, and sim. **/ if ( (attr_name[0] == 'v' && datatype == DATA_T_STRING) /* val, val1, val2 : String */ || (attr_name[0] == 's' && datatype == DATA_T_DOUBLE) /* sim : double */ @@ -2674,6 +2796,10 @@ int clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val case TARGET_CLUSTER_ENTRY: val->String = "Clustering driver: Cluster Entry."; break; case TARGET_SEARCH: val->String = "Clustering driver: Search."; break; case TARGET_SEARCH_ENTRY: val->String = "Clustering driver: Cluster Entry."; break; + + default: + mssErrorf(1, "Cluster", "Unknown target type %u.", driver_data->TargetType); + return -1; } return 0; } @@ -2694,6 +2820,61 @@ int clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val /** Last modification is not implemented yet. **/ if (strcmp(attr_name, "last_modification") == 0) return 1; /* null */ + /** Handle creation and computation dates. **/ + if (strcmp(attr_name, "date_created") == 0) + { + switch (driver_data->TargetType) + { + case TARGET_ROOT: + case TARGET_CLUSTER_ENTRY: + case TARGET_SEARCH_ENTRY: + /** Field is not defined for this target type. **/ + return -1; + + case TARGET_CLUSTER: + val->DateTime = &((pClusterData)driver_data->TargetData)->DateCreated; + return 0; + + case TARGET_SEARCH: + val->DateTime = &((pSearchData)driver_data->TargetData)->DateCreated; + return 0; + } + return -1; + } + if (strcmp(attr_name, "date_computed") == 0) + { + switch (driver_data->TargetType) + { + case TARGET_ROOT: + case TARGET_CLUSTER_ENTRY: + case TARGET_SEARCH_ENTRY: + /** Field is not defined for this target type. **/ + return -1; + + case TARGET_CLUSTER: + { + pClusterData target = (pClusterData)driver_data->TargetData; + pDateTime date_time = &target->DateComputed; + if (date_time->Value == 0) return 1; /* null */ + else val->DateTime = date_time; + return 0; + } + + case TARGET_SEARCH: + { + pSearchData target = (pSearchData)driver_data->TargetData; + pDateTime date_time = &target->DateComputed; + if (date_time->Value == 0) return 1; /* null */ + else val->DateTime = date_time; + return 0; + } + } + + /** Default: Unknown type. **/ + mssErrorf(1, "Cluster", "Unknown target type %u.", driver_data->TargetType); + return -1; + } + /** Handle attributes for specific data targets. **/ handle_targets: switch (driver_data->TargetType) @@ -2848,6 +3029,318 @@ int clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val } +// LINK #functions +/** Not implemented. **/ +pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pObjTrxTree* oxt) + { + tprintf("Warning: clusterPresentationHints(\"%s\") is under active development.", attr_name); + pDriverData driver_data = (pDriverData)inf_v; + + /** Malloc presentation hints struct. **/ + pObjPresentationHints hints = check_ptr(nmMalloc(sizeof(ObjPresentationHints))); + memset(hints, 0, sizeof(ObjPresentationHints)); + + /** Hints that are the same for all fields */ + hints->GroupID = -1; + hints->VisualLength2 = 1; + hints->Style |= OBJ_PH_STYLE_READONLY | OBJ_PH_STYLE_CREATEONLY | OBJ_PH_STYLE_NOTNULL; + hints->StyleMask |= OBJ_PH_STYLE_READONLY | OBJ_PH_STYLE_CREATEONLY | OBJ_PH_STYLE_NOTNULL; + + /** Temporary param list for compiling expressions. **/ + pParamObjects tmp_list = check_ptr(expCreateParamList()); + + if (strcmp(attr_name, "name") == 0) + { + hints->Length = 32; + hints->VisualLength = 16; + goto end; + } + if (strcmp(attr_name, "annotation") == 0) + { + hints->Length = 36; + hints->VisualLength = 36; + goto end; + } + if (strcmp(attr_name, "inner_type") == 0 + || strcmp(attr_name, "inner_type") == 0 + || strcmp(attr_name, "outer_type") == 0 + || strcmp(attr_name, "content_type") == 0 + || strcmp(attr_name, "last_modification") == 0) + { + hints->VisualLength = 30; + goto end; + } + + if (strcmp(attr_name, "date_created") == 0 + || strcmp(attr_name, "date_computed") == 0) + { + hints->Length = 24; + hints->VisualLength = 20; + hints->Format = nmSysStrdup("datetime"); + goto end; + } + + switch (driver_data->TargetType) + { + case TARGET_ROOT: + if (strcmp(attr_name, "source") == 0) + { + hints->Length = _PC_PATH_MAX; + hints->VisualLength = 64; + hints->FriendlyName = "Source Path"; + goto end; + } + if (strcmp(attr_name, "attr_name") == 0) + { + hints->Length = 255; + hints->VisualLength = 32; + hints->FriendlyName = "Attribute Name"; + goto end; + } + break; + + case TARGET_CLUSTER: + if (strcmp(attr_name, "num_clusters") == 0) + { + /** Min and max values. **/ + hints->MinValue = expCompileExpression("2", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + hints->MaxValue = expCompileExpression("2147483647", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + + /** Other hints. **/ + hints->Length = 8; + hints->VisualLength = 4; + hints->FriendlyName = nmSysStrdup("Number of Clusters"); + goto end; + } + if (strcmp(attr_name, "min_improvement") == 0) + { + /** Min and max values. **/ + hints->DefaultExpr = expCompileExpression("0.0001", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + hints->MinValue = expCompileExpression("0.0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + hints->MaxValue = expCompileExpression("1.0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + + /** Other hints. **/ + hints->Length = 16; + hints->VisualLength = 8; + hints->FriendlyName = nmSysStrdup("Minimum Improvement Threshold"); + goto end; + } + if (strcmp(attr_name, "max_iterations") == 0) + { + /** Min and max values. **/ + hints->DefaultExpr = expCompileExpression("64", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + hints->MinValue = expCompileExpression("0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + hints->MaxValue = expCompileExpression("2147483647", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + + /** Other hints. **/ + hints->Length = 8; + hints->VisualLength = 4; + hints->FriendlyName = nmSysStrdup("Maximum Number of Clustering Iterations"); + goto end; + } + if (strcmp(attr_name, "average_similarity") == 0) + { + /** Min and max values. **/ + hints->MinValue = expCompileExpression("0.0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + hints->MaxValue = expCompileExpression("1.0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + + /** Other hints. **/ + hints->Length = 16; + hints->VisualLength = 8; + hints->FriendlyName = nmSysStrdup("Average Similarity"); + goto end; + } + if (strcmp(attr_name, "size") == 0) + { + /** Min and max values. **/ + hints->MinValue = expCompileExpression("0.0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + hints->MaxValue = expCompileExpression("1.0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + + /** Other hints. **/ + hints->Length = 16; + hints->VisualLength = 8; + hints->FriendlyName = nmSysStrdup("Average Cluster Size"); + goto end; + } + if (strcmp(attr_name, "algorithm") == 0) + { + /** Enum values. **/ + check(xaInit(&(hints->EnumList), nClusteringAlgorithms)); + for (unsigned int i = 0u; i < nClusteringAlgorithms; i++) + check_neg(xaAddItem(&(hints->EnumList), &ALL_CLUSTERING_ALGORITHMS[i])); + + /** Min and max values. **/ + hints->MinValue = expCompileExpression("0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + char buf[4u]; + snprintf(buf, sizeof(buf), "%d", nClusteringAlgorithms); + hints->MaxValue = expCompileExpression(buf, tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + + /** Display flags. **/ + hints->Style |= OBJ_PH_STYLE_BUTTONS; + hints->StyleMask |= OBJ_PH_STYLE_BUTTONS; + + /** Other hints. **/ + hints->Length = 24; + hints->VisualLength = 20; + hints->FriendlyName = nmSysStrdup("Clustering Algorithm"); + goto end; + } + /** Fall-through: Start of overlapping region. **/ + + case TARGET_SEARCH: + if (strcmp(attr_name, "similarity_measure") == 0) + { + /** Enum values. **/ + check(xaInit(&(hints->EnumList), nSimilarityMeasures)); + for (unsigned int i = 0u; i < nSimilarityMeasures; i++) + check_neg(xaAddItem(&(hints->EnumList), &ALL_SIMILARITY_MEASURES[i])); + + /** Display flags. **/ + hints->Style |= OBJ_PH_STYLE_BUTTONS; + hints->StyleMask |= OBJ_PH_STYLE_BUTTONS; + + /** Min and max values. **/ + hints->MinValue = expCompileExpression("0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + char buf[4u]; + snprintf(buf, sizeof(buf), "%d", nSimilarityMeasures); + hints->MaxValue = expCompileExpression(buf, tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + + /** Other hints. **/ + hints->Length = 32; + hints->VisualLength = 20; + hints->FriendlyName = nmSysStrdup("Similarity Measure"); + goto end; + } + + /** End of overlapping region. **/ + if (driver_data->TargetType == TARGET_CLUSTER) break; + + if (strcmp(attr_name, "source") == 0) + { + hints->Length = 64; + hints->VisualLength = 32; + hints->FriendlyName = nmSysStrdup("Source Cluster Name"); + goto end; + } + if (strcmp(attr_name, "threshold") == 0) + { + /** Min and max values. **/ + hints->MinValue = expCompileExpression("0.0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + hints->MaxValue = expCompileExpression("1.0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + + /** Other hints. **/ + hints->Length = 16; + hints->VisualLength = 8; + hints->FriendlyName = nmSysStrdup("Similarity Threshold"); + goto end; + } + break; + + case TARGET_CLUSTER_ENTRY: + { + pClusterData target = (pClusterData)driver_data->TargetData; + + if (strcmp(attr_name, "id") == 0) + { + pSourceData source_data = (pSourceData)target->SourceData; + + /** Min and max values. **/ + hints->MinValue = expCompileExpression("0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + if (source_data->Vectors != NULL) + { + char buf[16u]; + snprintf(buf, sizeof(buf), "%u", source_data->nVectors); + hints->MaxValue = expCompileExpression(buf, tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + return 0; + } + + /** Other hints. **/ + hints->Length = 8; + hints->VisualLength = 4; + goto end; + } + if (strcmp(attr_name, "val") == 0) + { + /** Other hints. **/ + hints->Length = 255; + hints->VisualLength = 32; + hints->FriendlyName = nmSysStrdup("Value"); + goto end; + } + if (strcmp(attr_name, "sim") == 0) + { + /** Min and max values. **/ + hints->MinValue = expCompileExpression("0.0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + hints->MaxValue = expCompileExpression("1.0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + + /** Other hints. **/ + hints->Length = 16; + hints->VisualLength = 8; + hints->FriendlyName = nmSysStrdup("Similarity"); + goto end; + } + break; + } + + case TARGET_SEARCH_ENTRY: + { + pSearchData target = (pSearchData)driver_data->TargetData; + + if (strcmp(attr_name, "id1") == 0 || strcmp(attr_name, "id2") == 0) + { + pSourceData source_data = (pSourceData)target->Source->SourceData; + + /** Min and max values. **/ + hints->MinValue = expCompileExpression("0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + if (source_data->Vectors != NULL) + { + char buf[16u]; + snprintf(buf, sizeof(buf), "%u", source_data->nVectors); + hints->MaxValue = expCompileExpression(buf, tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + return 0; + } + + /** Other hints. **/ + hints->Length = 8; + hints->VisualLength = 4; + goto end; + } + if (strcmp(attr_name, "val1") == 0 || strcmp(attr_name, "val2") == 0) + { + /** Other hints. **/ + hints->Length = 255; + hints->VisualLength = 32; + hints->FriendlyName = nmSysStrdup("Value"); + goto end; + } + if (strcmp(attr_name, "sim") == 0) + { + /** Min and max values. **/ + hints->MinValue = expCompileExpression("0.0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + hints->MaxValue = expCompileExpression("1.0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + + /** Other hints. **/ + hints->Length = 16; + hints->VisualLength = 8; + hints->FriendlyName = nmSysStrdup("Similarity"); + goto end; + } + break; + } + + default: + mssErrorf(1, "Cluster", "Unknown target type %u.", driver_data->TargetType); + return NULL; + } + + + end: + check(expFreeParamList(tmp_list)); + return hints; + } + + +// LINK #functions /*** Returns the name of the first attribute that one can get from *** this driver instance (using GetAttrType() and GetAttrValue()). *** Resets the internal variable (TargetAttrIndex) used to maintain @@ -2866,6 +3359,7 @@ char* clusterGetFirstAttr(void* inf_v, pObjTrxTree oxt) } +// LINK #functions /*** Returns the name of the next attribute that one can get from *** this driver instance (using GetAttrType() and GetAttrValue()). *** Uses an internal variable (TargetAttrIndex) used to maintain @@ -2895,6 +3389,7 @@ char* clusterGetNextAttr(void* inf_v, pObjTrxTree oxt) } +// LINK #functions /*** Get the capabilities of the driver instance object. *** *** @param inf_v The driver instance to be checked. @@ -2995,6 +3490,7 @@ char* clusterGetFirstMethod(void* inf_v, pObjTrxTree oxt) } +// LINK #functions /*** Returns the name of the next method that one can get from *** this driver instance (using GetAttrType() and GetAttrValue()). *** Uses an internal variable (TargetMethodIndex) used to maintain @@ -3013,6 +3509,7 @@ char* clusterGetNextMethod(void* inf_v, pObjTrxTree oxt) return (i < nMETHOD_NAME) ? METHOD_NAME[i] : END_OF_METHODS; } +// LINK #functions /** Intended for use in xhForEach(). **/ static int ci_PrintEntry(pXHashEntry entry, void* arg) { @@ -3074,6 +3571,7 @@ static int ci_PrintEntry(pXHashEntry entry, void* arg) } +// LINK #functions /*** Executes a method with the given name. *** *** @param inf_v The affected driver instance. @@ -3101,7 +3599,7 @@ int clusterExecuteMethod(void* inf_v, char* method_name, pObjData param, pObjTrx if (strcmp(param->String, "show") == 0) { const pObject obj = ((pDriverData)inf_v)->NodeData->Obj; - char* path = obj_internal_PathPart(obj->Pathname, 0, obj->SubPtr); + char* path = ci_file_path(obj); /** Print cache info table. **/ unsigned int i = 1u, source_bytes = 0u, cluster_bytes = 0u, search_bytes = 0u; @@ -3232,14 +3730,9 @@ int clusterCommit(void* inf_v, pObjTrxTree *oxt) mssErrorf(1, "Cluster", "clusterCommit() not implemented because clusters are imutable."); return 0; } -/** Not implemented. **/ -pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pObjTrxTree* oxt) - { - mssErrorf(1, "Cluster", "clusterPresentationHints() not implemented."); - return NULL; - } +// LINK #functions /*** Initialize the driver. This includes: *** - Registering the driver with the objectsystem. *** - Registering structs with newmalloc for debugging. From ea6430fa8e0965aaac782b49cc73e5ceff457ddc Mon Sep 17 00:00:00 2001 From: Israel Date: Thu, 16 Oct 2025 08:55:52 -0600 Subject: [PATCH 003/275] Checkpoing: Switching to DM project. --- centrallix-lib/include/util.h | 47 +++ centrallix-os/testdir/file.cluster | 64 ++++ centrallix/expression/exp_functions.c | 1 - centrallix/multiquery/multiquery.c | 8 +- centrallix/osdrivers/objdrv_cluster.c | 451 +++++++++++--------------- centrallix/test_obj.c | 1 + 6 files changed, 314 insertions(+), 258 deletions(-) create mode 100644 centrallix-os/testdir/file.cluster diff --git a/centrallix-lib/include/util.h b/centrallix-lib/include/util.h index 2b9d7b26f..12019abfb 100644 --- a/centrallix-lib/include/util.h +++ b/centrallix-lib/include/util.h @@ -134,6 +134,53 @@ void fail(const char* function_name, int code); _r; \ }) +/** Pattern for printing a binary int using printf(). **/ +#define INT_TO_BINARY_PATTERN "%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c" + +/*** Converts an int to the values that should be passed to printf() for the + *** INT_TO_BINARY_PATTERN pattern. + *** + *** @attention - Double evaluation is NOT HANDLED so int_val will be evaluted + *** 32 times when this macro is used. Ensure that evaluation of the value + *** passed for int_val does not have important side effects! + *** + *** @param int_val The int to be printed. + *** @returns Values for printf(). + ***/ +#define INT_TO_BINARY(int_val) \ + ((int_val) & 0b10000000000000000000000000000000 ? '1' : '0'), \ + ((int_val) & 0b01000000000000000000000000000000 ? '1' : '0'), \ + ((int_val) & 0b00100000000000000000000000000000 ? '1' : '0'), \ + ((int_val) & 0b00010000000000000000000000000000 ? '1' : '0'), \ + ((int_val) & 0b00001000000000000000000000000000 ? '1' : '0'), \ + ((int_val) & 0b00000100000000000000000000000000 ? '1' : '0'), \ + ((int_val) & 0b00000010000000000000000000000000 ? '1' : '0'), \ + ((int_val) & 0b00000001000000000000000000000000 ? '1' : '0'), \ + ((int_val) & 0b00000000100000000000000000000000 ? '1' : '0'), \ + ((int_val) & 0b00000000010000000000000000000000 ? '1' : '0'), \ + ((int_val) & 0b00000000001000000000000000000000 ? '1' : '0'), \ + ((int_val) & 0b00000000000100000000000000000000 ? '1' : '0'), \ + ((int_val) & 0b00000000000010000000000000000000 ? '1' : '0'), \ + ((int_val) & 0b00000000000001000000000000000000 ? '1' : '0'), \ + ((int_val) & 0b00000000000000100000000000000000 ? '1' : '0'), \ + ((int_val) & 0b00000000000000010000000000000000 ? '1' : '0'), \ + ((int_val) & 0b00000000000000001000000000000000 ? '1' : '0'), \ + ((int_val) & 0b00000000000000000100000000000000 ? '1' : '0'), \ + ((int_val) & 0b00000000000000000010000000000000 ? '1' : '0'), \ + ((int_val) & 0b00000000000000000001000000000000 ? '1' : '0'), \ + ((int_val) & 0b00000000000000000000100000000000 ? '1' : '0'), \ + ((int_val) & 0b00000000000000000000010000000000 ? '1' : '0'), \ + ((int_val) & 0b00000000000000000000001000000000 ? '1' : '0'), \ + ((int_val) & 0b00000000000000000000000100000000 ? '1' : '0'), \ + ((int_val) & 0b00000000000000000000000010000000 ? '1' : '0'), \ + ((int_val) & 0b00000000000000000000000001000000 ? '1' : '0'), \ + ((int_val) & 0b00000000000000000000000000100000 ? '1' : '0'), \ + ((int_val) & 0b00000000000000000000000000010000 ? '1' : '0'), \ + ((int_val) & 0b00000000000000000000000000001000 ? '1' : '0'), \ + ((int_val) & 0b00000000000000000000000000000100 ? '1' : '0'), \ + ((int_val) & 0b00000000000000000000000000000010 ? '1' : '0'), \ + ((int_val) & 0b00000000000000000000000000000001 ? '1' : '0') + #endif /* __cplusplus */ #endif /* UTILITY_H */ diff --git a/centrallix-os/testdir/file.cluster b/centrallix-os/testdir/file.cluster new file mode 100644 index 000000000..929efdd03 --- /dev/null +++ b/centrallix-os/testdir/file.cluster @@ -0,0 +1,64 @@ +$Version=2$ +file_name "system/cluster" + { + // Developer can specify parameters to improve file reuseability. + // TIP: Improve performance by declairing frequently used parameters first. + k "cluster/parameter" { type = integer; style=notnull; } + str "cluster/parameter" { type = string; } + int "cluster/parameter" { type = integer; default = runserver(:parameters:k); } + dbl "cluster/parameter" { type = double; default=4.2; } + // conversion "cluster/parameter" { type=double; default=4; } + + null_str "cluster/parameter" { type = string; default = null; } + null_int "cluster/parameter" { type = integer; default = null; } + null_dbl "cluster/parameter" { type = double; default = null; } + + // We calculate k in a centrallix script using: + // k = max(2, pow(log(n) / log(36), 3.2) - 8) + // where n is the number of records passed. + + // Specify the data source at the top of the file. + // How do we pass distinct data? Should the driver + // handle that for us? + source = "/apps/kardia/data/Kardia_DB/p_partner/rows"; + attr_name = p_given_name; // runserver(:parameters:str) + + // Clustering object specifies properties for clustering. + kmeans_cluster "cluster/cluster" + { + algorithm = "k-means"; + similarity_measure = "cosine"; + num_clusters = runserver(:parameters:k); + min_improvement = 0.0001; + max_iterations = 48; + + // Create subclusters. (Not implemented) + sub_cluster "cluster/cluster" + { + algorithm = "none"; + similarity_measure = "cosine"; + num_clusters = 7; + min_improvement = "max"; + } + } + + // Complete search. + no_clustering "cluster/cluster" + { + algorithm = "none"; + } + + dups "cluster/search" + { + source = kmeans_cluster; + threshold = 0.75; + similarity_measure = "cosine"; + } + + dups2 "cluster/search" + { + source = no_clustering; + threshold = 0.75; + similarity_measure = "cosine"; + } + } diff --git a/centrallix/expression/exp_functions.c b/centrallix/expression/exp_functions.c index df55559be..a8e16ecc7 100644 --- a/centrallix/expression/exp_functions.c +++ b/centrallix/expression/exp_functions.c @@ -1355,7 +1355,6 @@ int exp_fn_ralign(pExpression tree, pParamObjects objlist, pExpression i0, pExpr tree->Alloc = 0; tree->String = tree->Types.StringBuf; } - /** Possible overflow? **/ sprintf(tree->String,"%*.*s",i1->Integer,i1->Integer,i0->String); } return 0; diff --git a/centrallix/multiquery/multiquery.c b/centrallix/multiquery/multiquery.c index 897362751..069186e80 100644 --- a/centrallix/multiquery/multiquery.c +++ b/centrallix/multiquery/multiquery.c @@ -2086,6 +2086,7 @@ mq_internal_SyntaxParse(pLxSession lxs, pQueryStatement stmt, int allow_empty, p mssError(1,"MQ","Expected equals after EXEC parameter"); mlxNoteError(lxs); xsFree(xs); + xs = NULL; break; } @@ -2098,6 +2099,7 @@ mq_internal_SyntaxParse(pLxSession lxs, pQueryStatement stmt, int allow_empty, p mssError(1,"MQ","Error in EXEC parameter"); mlxNoteError(lxs); xsFree(xs); + xs = NULL; xsFree(param); break; } @@ -2108,6 +2110,7 @@ mq_internal_SyntaxParse(pLxSession lxs, pQueryStatement stmt, int allow_empty, p mssError(1,"MQ","Could not evaluate EXEC parameter"); mlxNoteError(lxs); xsFree(xs); + xs = NULL; xsFree(param); break; } @@ -2120,7 +2123,8 @@ mq_internal_SyntaxParse(pLxSession lxs, pQueryStatement stmt, int allow_empty, p } } - strtcpy(new_qs->Source, xs->String, sizeof(new_qs->Source)); + if (xs != NULL) + strtcpy(new_qs->Source, xs->String, sizeof(new_qs->Source)); next_state = LookForClause; } else @@ -4774,5 +4778,3 @@ mqInitialize() return 0; } - - diff --git a/centrallix/osdrivers/objdrv_cluster.c b/centrallix/osdrivers/objdrv_cluster.c index 2369bc1fb..f56cca5de 100644 --- a/centrallix/osdrivers/objdrv_cluster.c +++ b/centrallix/osdrivers/objdrv_cluster.c @@ -72,11 +72,17 @@ *** https://marketplace.visualstudio.com/items?itemName=ExodiusStudios.comment-anchors ***/ +/** Pure Laziness **/ +#define ENABLE_TPRINTF /** Debugging **/ +#ifndef ENABLE_TPRINTF void void_func() {} #define tprintf void_func -// #define tprintf printf +#endif +#ifdef ENABLE_TPRINTF +#define tprintf printf +#endif /** Defaults for unspecified optional attributes. **/ #define DEFAULT_MIN_IMPROVEMENT 0.0001 @@ -85,42 +91,6 @@ void void_func() {} /** ================ Stuff That Should Be Somewhere Else ================ **/ /** ANCHOR[id=temp] **/ -#define INT_TO_BINARY_PATTERN "%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c" -#define INT_TO_BINARY(int_val) \ - ((int_val) & 0b10000000000000000000000000000000 ? '1' : '0'), \ - ((int_val) & 0b01000000000000000000000000000000 ? '1' : '0'), \ - ((int_val) & 0b00100000000000000000000000000000 ? '1' : '0'), \ - ((int_val) & 0b00010000000000000000000000000000 ? '1' : '0'), \ - ((int_val) & 0b00001000000000000000000000000000 ? '1' : '0'), \ - ((int_val) & 0b00000100000000000000000000000000 ? '1' : '0'), \ - ((int_val) & 0b00000010000000000000000000000000 ? '1' : '0'), \ - ((int_val) & 0b00000001000000000000000000000000 ? '1' : '0'), \ - ((int_val) & 0b00000000100000000000000000000000 ? '1' : '0'), \ - ((int_val) & 0b00000000010000000000000000000000 ? '1' : '0'), \ - ((int_val) & 0b00000000001000000000000000000000 ? '1' : '0'), \ - ((int_val) & 0b00000000000100000000000000000000 ? '1' : '0'), \ - ((int_val) & 0b00000000000010000000000000000000 ? '1' : '0'), \ - ((int_val) & 0b00000000000001000000000000000000 ? '1' : '0'), \ - ((int_val) & 0b00000000000000100000000000000000 ? '1' : '0'), \ - ((int_val) & 0b00000000000000010000000000000000 ? '1' : '0'), \ - ((int_val) & 0b00000000000000001000000000000000 ? '1' : '0'), \ - ((int_val) & 0b00000000000000000100000000000000 ? '1' : '0'), \ - ((int_val) & 0b00000000000000000010000000000000 ? '1' : '0'), \ - ((int_val) & 0b00000000000000000001000000000000 ? '1' : '0'), \ - ((int_val) & 0b00000000000000000000100000000000 ? '1' : '0'), \ - ((int_val) & 0b00000000000000000000010000000000 ? '1' : '0'), \ - ((int_val) & 0b00000000000000000000001000000000 ? '1' : '0'), \ - ((int_val) & 0b00000000000000000000000100000000 ? '1' : '0'), \ - ((int_val) & 0b00000000000000000000000010000000 ? '1' : '0'), \ - ((int_val) & 0b00000000000000000000000001000000 ? '1' : '0'), \ - ((int_val) & 0b00000000000000000000000000100000 ? '1' : '0'), \ - ((int_val) & 0b00000000000000000000000000010000 ? '1' : '0'), \ - ((int_val) & 0b00000000000000000000000000001000 ? '1' : '0'), \ - ((int_val) & 0b00000000000000000000000000000100 ? '1' : '0'), \ - ((int_val) & 0b00000000000000000000000000000010 ? '1' : '0'), \ - ((int_val) & 0b00000000000000000000000000000001 ? '1' : '0') - - /** TODO: I think this should be moved to mtsession. **/ /*** I caused at least 10 bugs so far trying to pass format specifiers to *** mssError without realizing that it didn't support them. Eventually, I @@ -593,45 +563,38 @@ struct /** Parsing Functions. **/ // LINK #parsing -int ci_ParseAttribute(pStructInf inf, char* attr_name, int datatype, pObjData data, pParamObjects param_list, bool required, bool print_type_error); -ClusterAlgorithm ci_ParseClusteringAlgorithm(pStructInf cluster_inf, pParamObjects param_list); -SimilarityMeasure ci_ParseSimilarityMeasure(pStructInf cluster_inf, pParamObjects param_list); -pSourceData ci_ParseSourceData(pStructInf inf, pParamObjects param_list, char* path); -pClusterData ci_ParseClusterData(pStructInf inf, pNodeData node_data); -pSearchData ci_ParseSearchData(pStructInf inf, pNodeData node_data); -pNodeData ci_ParseNodeData(pStructInf inf, pObject obj); +static int ci_ParseAttribute(pStructInf inf, char* attr_name, int datatype, pObjData data, pParamObjects param_list, bool required, bool print_type_error); +static ClusterAlgorithm ci_ParseClusteringAlgorithm(pStructInf cluster_inf, pParamObjects param_list); +static SimilarityMeasure ci_ParseSimilarityMeasure(pStructInf cluster_inf, pParamObjects param_list); +static pSourceData ci_ParseSourceData(pStructInf inf, pParamObjects param_list, char* path); +static pClusterData ci_ParseClusterData(pStructInf inf, pNodeData node_data); +static pSearchData ci_ParseSearchData(pStructInf inf, pNodeData node_data); +static pNodeData ci_ParseNodeData(pStructInf inf, pObject obj); /** Freeing Functions. **/ // LINK #freeing -void ci_FreeSourceData(pSourceData source_data); -void ci_FreeClusterData(pClusterData cluster_data, bool recursive); -void ci_FreeSearchData(pSearchData search_data); -void ci_FreeNodeData(pNodeData node_data); +static void ci_FreeSourceData(pSourceData source_data); +static void ci_FreeClusterData(pClusterData cluster_data, bool recursive); +static void ci_FreeSearchData(pSearchData search_data); +static void ci_FreeNodeData(pNodeData node_data); /** Deep Size Computation Functions. **/ // LINK #sizing -unsigned int ci_SizeOfSourceData(pSourceData source_data); -unsigned int ci_SizeOfClusterData(pClusterData cluster_data, bool recursive); -unsigned int ci_SizeOfSearchData(pSearchData search_data); -unsigned int ci_SizeOfNodeData(pNodeData node_data); - -/** Cache Invalidation Functions. **/ -// LINK #invalidation -void ci_CacheFreeSourceData(pXHashEntry entry, void* _); -void ci_CacheFreeCluster(pXHashEntry entry, void* _); -void ci_CacheFreeSearch(pXHashEntry entry, void* _); +static unsigned int ci_SizeOfSourceData(pSourceData source_data); +static unsigned int ci_SizeOfClusterData(pClusterData cluster_data, bool recursive); +static unsigned int ci_SizeOfSearchData(pSearchData search_data); /** Computation Functions. (Ensure data is computed.) **/ // LINK #computation -int ci_ComputeSourceData(pSourceData source_data, pObjSession session); -int ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data); -int ci_ComputeSearchData(pSearchData search_data, pNodeData node_data); +static int ci_ComputeSourceData(pSourceData source_data, pObjSession session); +static int ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data); +static int ci_ComputeSearchData(pSearchData search_data, pNodeData node_data); /** Parameter Functions. **/ // LINK #params -int ci_GetParamType(void* inf_v, const char* attr_name); -int ci_GetParamValue(void* inf_v, char* attr_name, int datatype, pObjData val); -int ci_SetParamValue(void* inf_v, char* attr_name, int datatype, pObjData val); +static int ci_GetParamType(void* inf_v, const char* attr_name); +static int ci_GetParamValue(void* inf_v, char* attr_name, int datatype, pObjData val); +static int ci_SetParamValue(void* inf_v, char* attr_name, int datatype, pObjData val); /** Driver Functions. **/ // LINK #driver @@ -642,6 +605,7 @@ void* clusterQueryFetch(void* qy_v, pObject obj, int mode, pObjTrxTree* oxt); int clusterQueryClose(void* qy_v, pObjTrxTree* oxt); int clusterGetAttrType(void* inf_v, char* attr_name, pObjTrxTree* oxt); int clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val, pObjTrxTree* oxt); +pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pObjTrxTree* oxt); char* clusterGetFirstAttr(void* inf_v, pObjTrxTree oxt); char* clusterGetNextAttr(void* inf_v, pObjTrxTree oxt); int clusterInfo(void* inf_v, pObjectInfo info); @@ -650,6 +614,10 @@ int clusterInfo(void* inf_v, pObjectInfo info); // LINK #method char* clusterGetFirstMethod(void* inf_v, pObjTrxTree oxt); char* clusterGetNextMethod(void* inf_v, pObjTrxTree oxt); +static int ci_PrintEntry(pXHashEntry entry, void* arg); +static void ci_CacheFreeSourceData(pXHashEntry entry, void* path); +static void ci_CacheFreeCluster(pXHashEntry entry, void* path); +static void ci_CacheFreeSearch(pXHashEntry entry, void* path); int clusterExecuteMethod(void* inf_v, char* methodname, pObjData param, pObjTrxTree oxt); /** Unimplemented DriverFunctions. **/ @@ -663,7 +631,6 @@ int clusterSetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val int clusterAddAttr(void* inf_v, char* attr_name, int type, pObjData val, pObjTrxTree oxt); void* clusterOpenAttr(void* inf_v, char* attr_name, int mode, pObjTrxTree oxt); int clusterCommit(void* inf_v, pObjTrxTree *oxt); -pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pObjTrxTree* oxt); /** ================ Parsing Functions ================ **/ /** ANCHOR[id=parsing] **/ @@ -682,7 +649,7 @@ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pOb *** still don't know if it works correctly... or really how it works. Please *** review this code carefully! ***/ -int ci_ParseAttribute( +static int ci_ParseAttribute( pStructInf inf, char* attr_name, int datatype, @@ -787,7 +754,7 @@ int ci_ParseAttribute( *** evaluating parameter variables in the structure file. *** @returns The data algorithm, or ALGORITHM_NULL on failure. ***/ -ClusterAlgorithm ci_ParseClusteringAlgorithm(pStructInf inf, pParamObjects param_list) +static ClusterAlgorithm ci_ParseClusteringAlgorithm(pStructInf inf, pParamObjects param_list) { /** Get the algorithm attribute. **/ char* algorithm; @@ -824,7 +791,7 @@ ClusterAlgorithm ci_ParseClusteringAlgorithm(pStructInf inf, pParamObjects param *** evaluating parameter variables in the structure file. *** @returns The similarity measure, or SIMILARITY_NULL on failure. ***/ -SimilarityMeasure ci_ParseSimilarityMeasure(pStructInf inf, pParamObjects param_list) +static SimilarityMeasure ci_ParseSimilarityMeasure(pStructInf inf, pParamObjects param_list) { /** Get the similarity_measure attribute. **/ char* measure; @@ -858,17 +825,17 @@ SimilarityMeasure ci_ParseSimilarityMeasure(pStructInf inf, pParamObjects param_ *** cache entry keys. *** @returns A new pSourceData struct on success, or NULL on failure. ***/ -pSourceData ci_ParseSourceData(pStructInf inf, pParamObjects param_list, char* path) +static pSourceData ci_ParseSourceData(pStructInf inf, pParamObjects param_list, char* path) { char* buf; /** Get source. **/ if (ci_ParseAttribute(inf, "source", DATA_T_STRING, POD(&buf), param_list, true, true) != 0) goto err; - char* source_path = check_ptr(strdup(buf)); + char* source_path = check_ptr(nmSysStrdup(buf)); /** Get attribute name. **/ if (ci_ParseAttribute(inf, "attr_name", DATA_T_STRING, POD(&buf), param_list, true, true) != 0) goto err; - char* attr_name = check_ptr(strdup(buf)); + char* attr_name = check_ptr(nmSysStrdup(buf)); /** Create cache entry key. **/ const size_t len = strlen(path) + strlen(source_path) + strlen(attr_name) + 3lu; @@ -885,8 +852,8 @@ pSourceData ci_ParseSourceData(pStructInf inf, pParamObjects param_list, char* p tprintf("--> Name: %s\n", source_maybe->Name); /* Cause invalid read if cache was incorrectly freed. */ /** Free data we don't need. */ - free(source_path); - free(attr_name); + nmSysFree(source_path); + nmSysFree(attr_name); nmSysFree(key); /** Return the cached source data. **/ @@ -896,7 +863,7 @@ pSourceData ci_ParseSourceData(pStructInf inf, pParamObjects param_list, char* p /** Cache miss: Create a new source data object. **/ pSourceData source_data = check_ptr(nmMalloc(sizeof(SourceData))); memset(source_data, 0, sizeof(SourceData)); - source_data->Name = check_ptr(strdup(inf->Name)); + source_data->Name = check_ptr(nmSysStrdup(inf->Name)); source_data->Key = key; source_data->SourcePath = source_path; source_data->AttrName = attr_name; @@ -928,7 +895,7 @@ pSourceData ci_ParseSourceData(pStructInf inf, pParamObjects param_list, char* p *** used to generate cache entry keys. *** @returns A new pClusterData struct on success, or NULL on failure. ***/ -pClusterData ci_ParseClusterData(pStructInf inf, pNodeData node_data) +static pClusterData ci_ParseClusterData(pStructInf inf, pNodeData node_data) { int result; @@ -942,13 +909,13 @@ pClusterData ci_ParseClusterData(pStructInf inf, pNodeData node_data) memset(cluster_data, 0, sizeof(ClusterData)); /** Basic Properties. **/ - cluster_data->Name = check_ptr(strdup(inf->Name)); + cluster_data->Name = check_ptr(nmSysStrdup(inf->Name)); cluster_data->SourceData = source_data; check(objCurrentDate(&cluster_data->DateCreated)); /** Get algorithm. **/ cluster_data->ClusterAlgorithm = ci_ParseClusteringAlgorithm(inf, param_list); - if (cluster_data->ClusterAlgorithm == ALGORITHM_NULL) goto err; + if (cluster_data->ClusterAlgorithm == ALGORITHM_NULL) goto err_free_cluster; /** Handle no clustering case. **/ if (cluster_data->ClusterAlgorithm == ALGORITHM_NONE) @@ -1008,7 +975,7 @@ pClusterData ci_ParseClusterData(pStructInf inf, pNodeData node_data) if (result == -1) goto err_free_cluster; if (result == 0) { - if (max_iterations < 0) + if (max_iterations < 1) { mssErrorf(1, "Cluster", "Invalid value for [max_iterations : uint]: %d", max_iterations); goto err_free_cluster; @@ -1033,8 +1000,7 @@ pClusterData ci_ParseClusterData(pStructInf inf, pNodeData node_data) if (stStructType(group_inf) != ST_T_SUBGROUP) continue; /** Select array by group type. **/ - assert(group_inf->UsrType != NULL); - if (strcmp(group_inf->UsrType, "cluster/cluster")) continue; + if (strcmp(check_ptr(group_inf->UsrType), "cluster/cluster") != 0) continue; /** Subcluster found. **/ pClusterData sub_cluster = ci_ParseClusterData(group_inf, node_data); @@ -1125,9 +1091,9 @@ pClusterData ci_ParseClusterData(pStructInf inf, pNodeData node_data) xaDeInit(&sub_clusters); err_free_cluster: - nmFree(cluster_data, sizeof(ClusterData)); + ci_FreeClusterData(cluster_data, false); - err: + // err: mssErrorf(0, "Cluster", "Failed to parse cluster from group \"%s\".", inf->Name); return NULL; } @@ -1147,7 +1113,7 @@ pClusterData ci_ParseClusterData(pStructInf inf, pNodeData node_data) *** the cluster pointed to by the source attribute. *** @returns A new pSearchData struct on success, or NULL on failure. ***/ -pSearchData ci_ParseSearchData(pStructInf inf, pNodeData node_data) +static pSearchData ci_ParseSearchData(pStructInf inf, pNodeData node_data) { tprintf("Parsing search: %s\n", inf->Name); @@ -1157,7 +1123,7 @@ pSearchData ci_ParseSearchData(pStructInf inf, pNodeData node_data) memset(search_data, 0, sizeof(SearchData)); /** Get basic information. **/ - search_data->Name = check_ptr(strdup(inf->Name)); + search_data->Name = check_ptr(nmSysStrdup(inf->Name)); check(objCurrentDate(&search_data->DateCreated)); /** Get source. **/ @@ -1249,7 +1215,7 @@ pSearchData ci_ParseSearchData(pStructInf inf, pNodeData node_data) *** @param obj The parent object struct. *** @returns A new pNodeData struct on success, or NULL on failure. ***/ -pNodeData ci_ParseNodeData(pStructInf inf, pObject obj) +static pNodeData ci_ParseNodeData(pStructInf inf, pObject obj) { int ret; @@ -1452,30 +1418,18 @@ pNodeData ci_ParseNodeData(pStructInf inf, pObject obj) // LINK #functions /** @param source_data A pSourceData struct, freed by this function. **/ -void ci_FreeSourceData(pSourceData source_data) +static void ci_FreeSourceData(pSourceData source_data) { /** Free top level attributes, if they exist. **/ - if (source_data->Name != NULL) - { - free(source_data->Name); - source_data->Name = NULL; - } - if (source_data->SourcePath != NULL) - { - free(source_data->SourcePath); - source_data->SourcePath = NULL; - } - if (source_data->AttrName != NULL) - { - free(source_data->AttrName); - source_data->AttrName = NULL; - } + if (source_data->Name != NULL) nmSysFree(source_data->Name); + if (source_data->SourcePath != NULL) nmSysFree(source_data->SourcePath); + if (source_data->AttrName != NULL) nmSysFree(source_data->AttrName); /** Free fetched data, if it exists. **/ if (source_data->Data != NULL) { for (unsigned int i = 0u; i < source_data->nVectors; i++) - free(source_data->Data[i]); + nmSysFree(source_data->Data[i]); nmFree(source_data->Data, source_data->nVectors * sizeof(char*)); source_data->Data = NULL; } @@ -1500,16 +1454,17 @@ void ci_FreeSourceData(pSourceData source_data) *** @param cluster_data The cluster data struct to free. *** @param recrusive Whether to recursively free subclusters. ***/ -void ci_FreeClusterData(pClusterData cluster_data, bool recursive) +static void ci_FreeClusterData(pClusterData cluster_data, bool recursive) { /** Free top level cluster data. **/ - if (cluster_data->Name != NULL) free(cluster_data->Name); + if (cluster_data->Name != NULL) nmSysFree(cluster_data->Name); /** Free computed data, if it exists. **/ if (cluster_data->Labels != NULL) { const unsigned int nVectors = cluster_data->SourceData->nVectors; nmFree(cluster_data->Labels, nVectors * sizeof(unsigned int)); + cluster_data->Labels = NULL; } /** Free subclusters recursively. **/ @@ -1521,6 +1476,7 @@ void ci_FreeClusterData(pClusterData cluster_data, bool recursive) ci_FreeClusterData(cluster_data->SubClusters[i], recursive); } nmFree(cluster_data->SubClusters, cluster_data->nSubClusters * sizeof(void*)); + cluster_data->SubClusters = NULL; } /** Free the cluster struct. **/ @@ -1530,14 +1486,15 @@ void ci_FreeClusterData(pClusterData cluster_data, bool recursive) // LINK #functions /** @param search_data A pSearchData struct, freed by this function. **/ -void ci_FreeSearchData(pSearchData search_data) +static void ci_FreeSearchData(pSearchData search_data) { - if (search_data->Name != NULL) free(search_data->Name); + if (search_data->Name != NULL) nmSysFree(search_data->Name); if (search_data->Dups != NULL) { for (unsigned int i = 0; i < search_data->nDups; i++) nmFree(search_data->Dups[i], sizeof(Dup)); nmFree(search_data->Dups, search_data->nDups * sizeof(void*)); + search_data->Dups = NULL; } nmFree(search_data, sizeof(SearchData)); } @@ -1545,7 +1502,7 @@ void ci_FreeSearchData(pSearchData search_data) // LINK #functions /** @param node_data A pNodeData struct, freed by this function. **/ -void ci_FreeNodeData(pNodeData node_data) +static void ci_FreeNodeData(pNodeData node_data) { /** Free parsed params, if they exist. **/ if (node_data->Params != NULL) @@ -1611,7 +1568,7 @@ void ci_FreeNodeData(pNodeData node_data) *** @param source_data The source data struct to be queried. *** @returns The size in bytes of the struct and all internal allocated data. ***/ -unsigned int ci_SizeOfSourceData(pSourceData source_data) +static unsigned int ci_SizeOfSourceData(pSourceData source_data) { unsigned int size = 0u; if (source_data->Name != NULL) size += strlen(source_data->Name) * sizeof(char); @@ -1646,7 +1603,7 @@ unsigned int ci_SizeOfSourceData(pSourceData source_data) *** @param recrusive Whether to recursively free subclusters. *** @returns The size in bytes of the struct and all internal allocated data. ***/ -unsigned int ci_SizeOfClusterData(pClusterData cluster_data, bool recursive) +static unsigned int ci_SizeOfClusterData(pClusterData cluster_data, bool recursive) { unsigned int size = 0u; if (cluster_data->Name != NULL) size += strlen(cluster_data->Name) * sizeof(char); @@ -1676,7 +1633,7 @@ unsigned int ci_SizeOfClusterData(pClusterData cluster_data, bool recursive) *** @param search_data The search data struct to be queried. *** @returns The size in bytes of the struct and all internal allocated data. ***/ -unsigned int ci_SizeOfSearchData(pSearchData search_data) +static unsigned int ci_SizeOfSearchData(pSearchData search_data) { unsigned int size = 0u; if (search_data->Name != NULL) size += strlen(search_data->Name) * sizeof(char); @@ -1686,100 +1643,6 @@ unsigned int ci_SizeOfSearchData(pSearchData search_data) } -// LINK #functions -/*** Returns the deep size of a NodeData struct, including the size of all - *** allocated substructures. As far as I can tell, this is probably only - *** useful for cache management and debugging. - *** - *** Note that Key is ignored because it is a pointer to data managed by the - *** caching systems, so it is not technically part of the struct. - *** - *** @param node_data The cluster data struct to be queried. - *** @returns The size in bytes of the struct and all internal allocated data. - ***/ -unsigned int ci_SizeOfNodeData(pNodeData node_data) - { - unsigned int size = 0u; - if (node_data->Params != NULL) - { - /** Approximate. **/ - size += node_data->nParams * (sizeof(Param) + sizeof(pParam)); - } - if (node_data->ParamList == NULL) - { - /** Approximate. **/ - size += node_data->nParams * 30u * sizeof(char); - size += sizeof(pParamObjects); - } - if (node_data->Clusters != NULL) - { - /** Note: This data is also stored in a cache. **/ - for (unsigned int i = 0u; i < node_data->nClusters; i++) - size += ci_SizeOfClusterData(node_data->Clusters[i], true); - size += node_data->nClusters * sizeof(pClusterData); - } - if (node_data->Searches != NULL) - { - /** Note: This data is also stored in a cache. **/ - for (unsigned int i = 0u; i < node_data->nSearches; i++) - size += ci_SizeOfSearchData(node_data->Searches[i]); - size += node_data->nSearches * sizeof(pSearchData); - } - if (node_data->SourceData != NULL) - { - /** Note: This data is also stored in a cache. **/ - size += ci_SizeOfSourceData(node_data->SourceData); - } - size += sizeof(NodeData); - return size; - } - - -/** ================ Cache Invalidation Functions ================ **/ -/** ANCHOR[id=invalidation] **/ -// LINK #functions - -/** Intended for use in xhClearKeySafe(). **/ -void ci_CacheFreeSourceData(pXHashEntry entry, void* _) - { - /** Extract hash entry. **/ - char* key = entry->Key; - pSourceData source_data = (pSourceData)entry->Data; - - /** Free data. **/ - tprintf("- source: \"%s\"\n", key); - ci_FreeSourceData(source_data); - nmSysFree(key); - } - -// LINK #functions -/** Intended for use in xhClearKeySafe(). **/ -void ci_CacheFreeCluster(pXHashEntry entry, void* _) - { - /** Extract hash entry. **/ - char* key = entry->Key; - pClusterData cluster_data = (pClusterData)entry->Data; - - /** Free data. **/ - tprintf("- cluster: \"%s\"\n", key); - ci_FreeClusterData(cluster_data, false); - nmSysFree(key); - } - -// LINK #functions -/** Intended for use in xhClearKeySafe(). **/ -void ci_CacheFreeSearch(pXHashEntry entry, void* _) - { - /** Extract hash entry. **/ - char* key = entry->Key; - pSearchData search_data = (pSearchData)entry->Data; - - /** Free data. **/ - tprintf("- search: \"%s\"\n", key); - ci_FreeSearchData(search_data); - nmSysFree(key); - } - /** ================ Computation Functions ================ **/ /** ANCHOR[id=computation] **/ // LINK #functions @@ -1795,7 +1658,7 @@ void ci_CacheFreeSearch(pXHashEntry entry, void* _) *** @returns 0 if successful, or *** -1 other value on failure. ***/ -int ci_ComputeSourceData(pSourceData source_data, pObjSession session) +static int ci_ComputeSourceData(pSourceData source_data, pObjSession session) { /** If the vectors are already computed, we're done. **/ if (source_data->Vectors != NULL) return 0; @@ -1823,7 +1686,7 @@ int ci_ComputeSourceData(pSourceData source_data, pObjSession session) /** Drop source_data->Data. **/ for (unsigned int i = 0u; i < source_data->nVectors; i++) - free(source_data->Data[i]); + nmSysFree(source_data->Data[i]); nmFree(source_data->Data, source_data->nVectors * sizeof(char*)); source_data->Data = NULL; source_data->nVectors = 0; @@ -1969,7 +1832,7 @@ int ci_ComputeSourceData(pSourceData source_data, pObjSession session) } /** Store value. **/ - char* dup_val = check_ptr(strdup(val)); + char* dup_val = check_ptr(nmSysStrdup(val)); check_strict(xaAddItem(&data_xarray, (void*)dup_val)); check_strict(xaAddItem(&vector_xarray, (void*)vector)); @@ -2000,7 +1863,7 @@ int ci_ComputeSourceData(pSourceData source_data, pObjSession session) if (data_xarray.nAlloc != 0) { for (unsigned int i = 0u; i < data_xarray.nItems; i++) - free(data_xarray.Items[i]); + nmSysFree(data_xarray.Items[i]); check(xaDeInit(&data_xarray)); } if (vector_xarray.nAlloc != 0) @@ -2044,7 +1907,7 @@ int ci_ComputeSourceData(pSourceData source_data, pObjSession session) *** @returns 0 if successful, or *** -1 other value on failure. ***/ -int ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data) +static int ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data) { /** If the clusters are alreadyd computed, we're done. **/ if (cluster_data->Labels != NULL) return 0; @@ -2133,7 +1996,7 @@ int ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data) *** @returns 0 if successful, or *** -1 other value on failure. ***/ -int ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) +static int ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) { int ret; @@ -2209,7 +2072,7 @@ int ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) *** *** LINK ../../centrallix-lib/include/datatypes.h:72 ***/ -int ci_GetParamType(void* inf_v, const char* attr_name) +static int ci_GetParamType(void* inf_v, const char* attr_name) { tprintf("Call to ci_GetParamType(\"%s\")\n", attr_name); pNodeData node_data = (pNodeData)inf_v; @@ -2253,7 +2116,7 @@ int ci_GetParamType(void* inf_v, const char* attr_name) *** *** LINK ../../centrallix-lib/include/datatypes.h:72 ***/ -int ci_GetParamValue(void* inf_v, char* attr_name, int datatype, pObjData val) +static int ci_GetParamValue(void* inf_v, char* attr_name, int datatype, pObjData val) { tprintf("Call to ci_GetParamValue(\"%s\", %s)\n", attr_name, ci_TypeToStr(datatype)); pNodeData node_data = (pNodeData)inf_v; @@ -2286,9 +2149,9 @@ int ci_GetParamValue(void* inf_v, char* attr_name, int datatype, pObjData val) return -1; } - +// LINK #functions /** Not implemented. **/ -int ci_SetParamValue(void* inf_v, char* attr_name, int datatype, pObjData val) +static int ci_SetParamValue(void* inf_v, char* attr_name, int datatype, pObjData val) { tprintf("Call to ci_SetParamValue(%s, %s)\n", attr_name, ci_TypeToStr(datatype)); mssErrorf(1, "Cluster", "SetParamValue() is not implemented because clusters are imutable."); @@ -2714,9 +2577,9 @@ int clusterGetAttrType(void* inf_v, char* attr_name, pObjTrxTree* oxt) // LINK #functions /*** Get the value of a cluster driver instance attribute. *** - *** @param inf_v Node data containing the list of paramenters. - *** @param attr_name The name of the requested paramenter. - *** @param datatype The expected datatype of the parameter value. + *** @param inf_v The driver instance to be read. + *** @param attr_name The name of the requested attribute. + *** @param datatype The expected datatype of the attribute value. *** See datatypes.h for a list of valid datatypes. *** @param oxt The object system tree, similar to a kind of "scope" (unused). *** @param val A pointer to a location where a pointer to the requested @@ -2909,14 +2772,14 @@ int clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val if (strcmp(attr_name, "num_clusters") == 0) { if (target->NumClusters > INT_MAX) - fprintf(stderr, "Warning: num_clusters value of %u exceeds INT_MAX.\n", target->NumClusters); + fprintf(stderr, "Warning: num_clusters value of %u exceeds INT_MAX (%d).\n", target->NumClusters, INT_MAX); val->Integer = (int)target->NumClusters; return 0; } if (strcmp(attr_name, "max_iterations") == 0) { if (target->MaxIterations > INT_MAX) - fprintf(stderr, "Warning: max_iterations value of %u exceeds INT_MAX.\n", target->MaxIterations); + fprintf(stderr, "Warning: max_iterations value of %u exceeds INT_MAX (%d).\n", target->MaxIterations, INT_MAX); val->Integer = (int)target->MaxIterations; return 0; } @@ -3030,7 +2893,20 @@ int clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val // LINK #functions -/** Not implemented. **/ +/*** Create a new presentation hints object, describing this attribute on the + *** provided cluster driver instance. + *** + *** Note: expCompileExpression() and nmSysStrdup() are run unchecked because + *** the worst case senario is that the fields are set to null and ignored, + *** which I consider to be better than ending the script because one of + *** them failed. + *** + *** @param inf_v The driver instance to be read. + *** @param attr_name The name of the requested attribute. + *** @param oxt The object system tree, similar to a kind of "scope" (unused). + *** @returns A presentation hints object, if successsful, + *** NULL if an error occures. + ***/ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pObjTrxTree* oxt) { tprintf("Warning: clusterPresentationHints(\"%s\") is under active development.", attr_name); @@ -3251,7 +3127,6 @@ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pOb char buf[16u]; snprintf(buf, sizeof(buf), "%u", source_data->nVectors); hints->MaxValue = expCompileExpression(buf, tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); - return 0; } /** Other hints. **/ @@ -3297,7 +3172,6 @@ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pOb char buf[16u]; snprintf(buf, sizeof(buf), "%u", source_data->nVectors); hints->MaxValue = expCompileExpression(buf, tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); - return 0; } /** Other hints. **/ @@ -3330,13 +3204,17 @@ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pOb default: mssErrorf(1, "Cluster", "Unknown target type %u.", driver_data->TargetType); - return NULL; + goto err; } end: check(expFreeParamList(tmp_list)); return hints; + + err: + mssErrorf(0, "Cluster", "Failed execute generate presentation hints."); + return NULL; } @@ -3460,11 +3338,15 @@ int clusterInfo(void* inf_v, pObjectInfo info) default: mssErrorf(1, "Cluster", "Unknown target type %u.", driver_data->TargetType); - return -1; + goto err; } tprintf("Info result: "INT_TO_BINARY_PATTERN"\n", INT_TO_BINARY(info->Flags)); return 0; + + err: + mssErrorf(0, "Cluster", "Failed execute get info."); + return -1; } @@ -3509,6 +3391,7 @@ char* clusterGetNextMethod(void* inf_v, pObjTrxTree oxt) return (i < nMETHOD_NAME) ? METHOD_NAME[i] : END_OF_METHODS; } + // LINK #functions /** Intended for use in xhForEach(). **/ static int ci_PrintEntry(pXHashEntry entry, void* arg) @@ -3524,7 +3407,6 @@ static int ci_PrintEntry(pXHashEntry entry, void* arg) char* path = (char*)args[2]; /** If a path is provided, check that it matches the start of the key. **/ -// if (path != NULL) printf("Comparing \"%s\" to \"%s\"[0,%lu].\n", path, key, strlen((char*)path)); if (path != NULL && strncmp(key, (char*)path, strlen((char*)path)) != 0) return 0; /** Handle type. **/ @@ -3571,6 +3453,60 @@ static int ci_PrintEntry(pXHashEntry entry, void* arg) } +// LINK #functions +/** Intended for use in xhClearKeySafe(). **/ +static void ci_CacheFreeSourceData(pXHashEntry entry, void* path) + { + /** Extract hash entry. **/ + char* key = entry->Key; + pSourceData source_data = (pSourceData)entry->Data; + + /** If a path is provided, check that it matches the start of the key. **/ + if (path != NULL && strncmp(key, (char*)path, strlen((char*)path)) != 0) return; + + /** Free data. **/ + tprintf("- source: \"%s\"\n", key); + ci_FreeSourceData(source_data); + nmSysFree(key); + } + + +// LINK #functions +/** Intended for use in xhClearKeySafe(). **/ +static void ci_CacheFreeCluster(pXHashEntry entry, void* path) + { + /** Extract hash entry. **/ + char* key = entry->Key; + pClusterData cluster_data = (pClusterData)entry->Data; + + /** If a path is provided, check that it matches the start of the key. **/ + if (path != NULL && strncmp(key, (char*)path, strlen((char*)path)) != 0) return; + + /** Free data. **/ + tprintf("- cluster: \"%s\"\n", key); + ci_FreeClusterData(cluster_data, false); + nmSysFree(key); + } + + +// LINK #functions +/** Intended for use in xhClearKeySafe(). **/ +static void ci_CacheFreeSearch(pXHashEntry entry, void* path) + { + /** Extract hash entry. **/ + char* key = entry->Key; + pSearchData search_data = (pSearchData)entry->Data; + + /** If a path is provided, check that it matches the start of the key. **/ + if (path != NULL && strncmp(key, (char*)path, strlen((char*)path)) != 0) return; + + /** Free data. **/ + tprintf("- search: \"%s\"\n", key); + ci_FreeSearchData(search_data); + nmSysFree(key); + } + + // LINK #functions /*** Executes a method with the given name. *** @@ -3582,28 +3518,38 @@ static int ci_PrintEntry(pXHashEntry entry, void* arg) int clusterExecuteMethod(void* inf_v, char* method_name, pObjData param, pObjTrxTree oxt) { tprintf("Warning: clusterExecuteMethod(\"%s\") is under active development.\n", method_name); + pDriverData driver_data = (pDriverData)inf_v; /** Cache management method. **/ if (strcmp(method_name, "cache") == 0) { + char* path = NULL; + /** Second parameter is required. **/ if (param->String == NULL) { mssErrorf(1, "Cluster", "param : \"show\" | \"show_all\" | \"drop_all\" is required for the cache method." ); - return -1; + goto err; } - /** Show cache. **/ + /** show and show_all. **/ + bool show = false; if (strcmp(param->String, "show") == 0) { - const pObject obj = ((pDriverData)inf_v)->NodeData->Obj; - char* path = ci_file_path(obj); - + show = true; + path = ci_file_path(driver_data->NodeData->Obj); + } + if (strcmp(param->String, "show_all") == 0) show = true; + + if (show) + { /** Print cache info table. **/ unsigned int i = 1u, source_bytes = 0u, cluster_bytes = 0u, search_bytes = 0u; - printf("\nShowing cache for \"%s\":\n", path); + printf("\nShowing cache for "); + if (path != NULL) printf("\"%s\":\n", path); + else printf("all files:\n"); printf("%-8s %-16s %-12s %s\n", "Type", "Name", "Size", "Cache Entry Key"); xhForEach(&ClusterCaches.SourceCache, ci_PrintEntry, (void*[]){&i, &source_bytes, path}); i++; xhForEach(&ClusterCaches.ClusterCache, ci_PrintEntry, (void*[]){&i, &cluster_bytes, path}); i++; @@ -3627,35 +3573,27 @@ int clusterExecuteMethod(void* inf_v, char* method_name, pObjData param, pObjTrx return 0; } - - /** Show all cache. **/ - if (strcmp(param->String, "show_all") == 0) + /** drop and drop_all. **/ + bool drop = false; + if (strcmp(param->String, "drop") == 0) { - /** Print cache info table. **/ - unsigned int i = 1u, total_bytes = 0u; - tprintf("Showing cluster driver cache for all files...\n"); - printf("%-8s %-16s %-12s %s\n", "Type", "Name", "Size", "Cache Entry Key"); - xhForEach(&ClusterCaches.SourceCache, ci_PrintEntry, (void*[]){&i, &total_bytes, NULL}); i++; - xhForEach(&ClusterCaches.ClusterCache, ci_PrintEntry, (void*[]){&i, &total_bytes, NULL}); i++; - xhForEach(&ClusterCaches.SearchCache, ci_PrintEntry, (void*[]){&i, &total_bytes, NULL}); i++; - - /** Print total size. **/ - char buf[16]; - snprint_bytes(buf, sizeof(buf), total_bytes); - printf("Total cache size: %s\n", buf); - return 0; + show = true; + path = ci_file_path(driver_data->NodeData->Obj); } + if (strcmp(param->String, "drop_all") == 0) drop = true; - /** Drop allcache. **/ - if (strcmp(param->String, "drop_all") == 0) + if (drop) { - tprintf("Dropping cluster driver cache for all files...\n"); + printf("\nDropping cache for "); + if (path != NULL) printf("\"%s\":\n", path); + else printf("all files:\n"); + /*** Free caches in reverse of the order they are created in case *** cached data relies on its source during the freeing process. ***/ - xhClearKeySafe(&ClusterCaches.SearchCache, ci_CacheFreeSearch, NULL); - xhClearKeySafe(&ClusterCaches.ClusterCache, ci_CacheFreeCluster, NULL); - xhClearKeySafe(&ClusterCaches.SourceCache, ci_CacheFreeSourceData, NULL); + xhClearKeySafe(&ClusterCaches.SearchCache, ci_CacheFreeSearch, path); + xhClearKeySafe(&ClusterCaches.ClusterCache, ci_CacheFreeCluster, path); + xhClearKeySafe(&ClusterCaches.SourceCache, ci_CacheFreeSourceData, path); printf("Cache dropped.\n"); return 0; } @@ -3665,9 +3603,14 @@ int clusterExecuteMethod(void* inf_v, char* method_name, pObjData param, pObjTrx "Expected param : \"show\" | \"show_all\" | \"drop_all\" the cache method, but got: \"%s\"", param->String ); - return -1; + goto err; } + + /** Unknown parameter. **/ + mssErrorf(1, "Cluster", "Unknown command: \"%s\"", method_name); + err: + mssErrorf(0, "Cluster", "Failed execute command."); return -1; } diff --git a/centrallix/test_obj.c b/centrallix/test_obj.c index c4c64e25b..5ef492de3 100644 --- a/centrallix/test_obj.c +++ b/centrallix/test_obj.c @@ -1443,6 +1443,7 @@ testobj_do_cmd(pObjSession s, char* cmd, int batch_mode, pLxSession inp_lx) else { printf("Unknown command '%s'\n",cmdname); + mlxCloseSession(ls); return -1; } From cf0dbb5fb1f061c617e65e6fd91924f4d389ec9f Mon Sep 17 00:00:00 2001 From: Israel Date: Mon, 27 Oct 2025 17:14:15 -0600 Subject: [PATCH 004/275] Finish implementing major features for the cluster driver. --- centrallix-lib/include/clusters.h | 69 +- centrallix-lib/include/glyph.h | 78 + centrallix-lib/include/util.h | 59 +- centrallix-lib/src/clusters.c | 716 ++++----- centrallix-lib/src/util.c | 25 +- centrallix-os/cluster-schema.cluster | 27 +- centrallix-os/file.cluster | 3 + centrallix-sysdoc/string_similarity.md | 167 +++ centrallix/include/obj.h | 1 + centrallix/osdrivers/objdrv_cluster.c | 1854 ++++++++++++++++-------- centrallix/test_obj.c | 7 + 11 files changed, 1936 insertions(+), 1070 deletions(-) create mode 100644 centrallix-lib/include/glyph.h create mode 100644 centrallix-sysdoc/string_similarity.md diff --git a/centrallix-lib/include/clusters.h b/centrallix-lib/include/clusters.h index 2605b4314..d8b7f97c6 100644 --- a/centrallix-lib/include/clusters.h +++ b/centrallix-lib/include/clusters.h @@ -1,3 +1,5 @@ +#ifndef CLUSTERS_H +#define CLUSTERS_H /************************************************************************/ /* Centrallix Application Server System */ @@ -23,7 +25,7 @@ /* A copy of the GNU General Public License has been included in this */ /* distribution in the file "COPYING". */ /* */ -/* Module: lib_cluster.c */ +/* Module: lib_cluster.h */ /* Author: Israel Fuller */ /* Creation: September 29, 2025 */ /* Description: Internal algorithms for the cluster object driver. */ @@ -40,6 +42,7 @@ #define CA_NUM_DIMS 251 /* aka. The vector table size. */ +/// LINK ../../centrallix-sysdoc/string_comparison.md#cosine_charsets /** The character used to create a pair with the first and last characters of a string. **/ #define CA_BOUNDARY_CHAR ('a' - 1) @@ -57,37 +60,47 @@ typedef struct } Dup, *pDup; +/** Registering all defined types for debugging. **/ +#define ca_init() \ + nmRegister(sizeof(pVector), "pVector"); \ + nmRegister(sizeof(pCentroid), "pCentroid"); \ + nmRegister(pCentroidSize, "Centroid"); \ + nmRegister(sizeof(Dup), "Dup") + pVector ca_build_vector(const char* str); unsigned int ca_sparse_len(const pVector vector); void ca_free_vector(pVector sparse_vector); -void ca_kmeans( +int ca_kmeans( pVector* vectors, const unsigned int num_vectors, - unsigned int* labels, const unsigned int num_clusters, const unsigned int max_iter, - const double improvement_threshold -); -pXArray ca_search( - pVector* vectors, - const unsigned int num_vectors, - const unsigned int* labels, - const double dupe_threshold -); -pXArray ca_lightning_search( - pVector* vectors, - const unsigned int num_vectors, - const double dupe_threshold -); -unsigned int ca_edit_dist( - const char* str1, - const char* str2, - const size_t str1_length, - const size_t str2_length -); -pXArray ca_phone_search( - char dataset[][10u], - const unsigned int dataset_size, - const double dupe_threshold -); -void ca_init(); + const double min_improvement, + unsigned int* labels, + double* vector_sims); + +/** Comparison functions, for ca_search(). **/ +double ca_cos_compare(void* v1, void* v2); +double ca_lev_compare(void* str1, void* str2); + +void* ca_most_similar( + void* target, + void** data, + const unsigned int num_data, + const double (*similarity)(void*, void*), + const double threshold); +pXArray ca_sliding_search( + void** data, + const unsigned int num_data, + const unsigned int window_size, + const double (*similarity)(void*, void*), + const double dupe_threshold, + pXArray dups); +pXArray ca_complete_search( + void** data, + const unsigned int num_data, + const double (*similarity)(void*, void*), + const double dupe_threshold, + pXArray dups); + +#endif /* End of .h file. */ diff --git a/centrallix-lib/include/glyph.h b/centrallix-lib/include/glyph.h new file mode 100644 index 000000000..5f78eab5d --- /dev/null +++ b/centrallix-lib/include/glyph.h @@ -0,0 +1,78 @@ +#ifndef GLYPH_H +#define GLYPH_H + +/************************************************************************/ +/* Centrallix Application Server System */ +/* Centrallix Core */ +/* */ +/* Copyright (C) 1998-2012 LightSys Technology Services, Inc. */ +/* */ +/* This program is free software; you can redistribute it and/or modify */ +/* it under the terms of the GNU General Public License as published by */ +/* the Free Software Foundation; either version 2 of the License, or */ +/* (at your option) any later version. */ +/* */ +/* This program 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 General Public License for more details. */ +/* */ +/* You should have received a copy of the GNU General Public License */ +/* along with this program; if not, write to the Free Software */ +/* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA */ +/* 02111-1307 USA */ +/* */ +/* A copy of the GNU General Public License has been included in this */ +/* distribution in the file "COPYING". */ +/* */ +/* Module: glyph.h */ +/* Author: Israel Fuller */ +/* Creation: October 27, 2025 */ +/* Description: A simple debug visualizer to make pretty patterns in */ +/* developer's terminal which can be surprisingly useful */ +/* for debugging algorithms. */ +/************************************************************************/ + +#include + +/** Uncomment to use glyphs. **/ +/** TODO: Israel - Comment this out. **/ +// #define ENABLE_GLYPHS + +#ifdef ENABLE_GLYPHS +#define glyph_print(s) printf("%s", s); +/*** Initialize a simple debug visualizer to make pretty patterns in the + *** developer's terminal. Great for when you need to run a long task and + *** want a super simple way to make sure it's still working. + *** + *** @attention - Relies on storing data in variables in scope, so calling + *** glyph() requires a call to glyph_init() previously in the same scope. + *** + *** @param name The symbol name of the visualizer. + *** @param str The string printed for the visualization. + *** @param interval The number of invokations of glyph() required to print. + *** @param flush Whether to flush on output. + ***/ +#define glyph_init(name, str, interval, flush) \ + const char* vis_##name##_str = str; \ + const unsigned int vis_##name##_interval = interval; \ + const bool vis_##name##_flush = flush; \ + unsigned int vis_##name##_i = 0u; + +/*** Invoke a visualizer. + *** + *** @param name The name of the visualizer to invoke. + ***/ +#define glyph(name) \ + if (++vis_##name##_i % vis_##name##_interval == 0) \ + { \ + glyph_print(vis_##name##_str); \ + if (vis_##name##_flush) fflush(stdout); \ + } +#else +#define glyph_print(str) +#define glyph_init(name, str, interval, flush) +#define glyph(name) +#endif + +#endif /* End of .h file. */ diff --git a/centrallix-lib/include/util.h b/centrallix-lib/include/util.h index 12019abfb..dd821767f 100644 --- a/centrallix-lib/include/util.h +++ b/centrallix-lib/include/util.h @@ -46,6 +46,7 @@ extern "C" { #endif #ifndef __cplusplus +#include /** TODO: Greg, is the __typeof__ syntax from GCC a portability concern? **/ @@ -79,58 +80,72 @@ extern "C" { (_a > _b) ? _a : _b; \ }) +/** File name macro, expanding functionality like __FILE__ and __LINE__. **/ +#define __FILENAME__ \ + ({ \ + const char* last_directory = strrchr(__FILE__, '/'); \ + ((last_directory != NULL) ? last_directory + 1 : __FILE__); \ + }) + /** Error Handling. **/ -void fail(const char* function_name, int code); +void print_diagnostics(int code, const char* function_name, const char* file_name, const int line_number); -/*** Helper function for compact error handling on library & system function calls. - *** Any non-zero value is treated as an error, exiting the program. +/*** Ensures that developer diagnostics are printed if the result of the + *** passed function call is not zero. Not intended for user errors. *** *** @param result The result of the function we're checking. - *** @returns result + *** @returns Whether the passed function succeeded. ***/ #define check(result) \ ({ \ + errno = 0; /* Reset errno to prevent confusion. */ \ __typeof__ (result) _r = (result); \ - if (_r != 0) fail(#result, _r); \ - _r; \ + const bool success = (_r == 0); \ + if (!success) print_diagnostics(_r, #result, __FILE__, __LINE__); \ + success; \ }) - -/*** Helper function for compact error handling on library & system function calls. - *** Any negative is treated as an error, exiting the program. + +/*** Ensures that developer diagnostics are printed if the result of the + *** passed function call is negative. Not intended for user errors. *** *** @param result The result of the function we're checking. - *** @returns result + *** @returns Whether the passed function succeeded. ***/ #define check_neg(result) \ ({ \ + errno = 0; /* Reset errno to prevent confusion. */ \ __typeof__ (result) _r = (result); \ - if (_r < 0) fail(#result, _r); \ - _r; \ + const bool success = (_r >= 0); \ + if (!success) print_diagnostics(_r, #result, __FILE__, __LINE__); \ + success; \ }) -/*** Helper function for compact error handling on library & system function calls. - *** Any value of -1 is treated as an error, exiting the program. +/*** Ensures that developer diagnostics are printed if the result of the + *** passed function call is -1. Not intended for user errors. *** *** @param result The result of the function we're checking. - *** @returns result + *** @returns Whether the passed function succeeded. ***/ -#define check_strict(result) \ +#define check_weak(result) \ ({ \ + errno = 0; /* Reset errno to prevent confusion. */ \ __typeof__ (result) _r = (result); \ - if (_r == -1) fail(#result, _r); \ - _r; \ + const bool success = (_r != -1); \ + if (!success) print_diagnostics(_r, #result, __FILE__, __LINE__); \ + success; \ }) -/*** Helper function for compact error handling on library & system function calls. - *** Any null value is treated as an error, exiting the program. +/*** Ensures that developer diagnostics are printed if the result of the + *** passed function call is a NULL pointer. Not intended for user errors. *** - *** @param result The result of the function we're checking + *** @param result The result of the function we're checking. *** @returns result ***/ #define check_ptr(result) \ ({ \ + errno = 0; /* Reset errno to prevent confusion. */ \ __typeof__ (result) _r = (result); \ - if (_r == NULL) fail(#result, 0); \ + if (_r == NULL) print_diagnostics(0, #result, __FILE__, __LINE__); \ _r; \ }) diff --git a/centrallix-lib/src/clusters.c b/centrallix-lib/src/clusters.c index 4e41d449d..90599269c 100644 --- a/centrallix-lib/src/clusters.c +++ b/centrallix-lib/src/clusters.c @@ -27,10 +27,10 @@ /* Author: Israel Fuller */ /* Creation: September 29, 2025 */ /* Description: Internal algorithms for the cluster object driver. */ -/* See centrallix-sysdoc/EAV_Pivot.md for more information. */ /************************************************************************/ -#include +/** This file has additional documentation in string_similarity.md. **/ + #include #include #include @@ -42,6 +42,7 @@ #include #include "clusters.h" +#include "glyph.h" #include "newmalloc.h" #include "util.h" #include "xarray.h" @@ -55,13 +56,6 @@ ***/ static unsigned int hash_char_pair(const unsigned int num1, const unsigned int num2) { - if (num1 == CA_BOUNDARY_CHAR && num2 == CA_BOUNDARY_CHAR) - { - // fprintf(stderr, - // "hash_char_pair(%u, %u) - Warning: Pair of boundary characters.\n", - // num1, num2 - // ); - } const double sum = (num1 * num1 * num1) + (num2 * num2 * num2); const double scale = ((double)num1 + 1.0) / ((double)num2 + 1.0); const unsigned int hash = (unsigned int)round(sum * scale) - 1u; @@ -201,15 +195,8 @@ pVector ca_build_vector(const char* str) /** Allocate space for sparse vector. **/ const size_t sparse_vector_size = size * sizeof(int); - pVector sparse_vector = (pVector)nmSysMalloc(sparse_vector_size); - if (sparse_vector == NULL) - { - fprintf(stderr, - "cli_build_vector(%s) - nmSysMalloc(%lu) failed.\n", - str, sparse_vector_size - ); - return NULL; - } + pVector sparse_vector = (pVector)check_ptr(nmSysMalloc(sparse_vector_size)); + if (sparse_vector == NULL) return NULL; /** Convert the dense vector above to a sparse vector. **/ unsigned int j = 0u, sparse_idx = 0u; @@ -248,46 +235,46 @@ void ca_free_vector(pVector sparse_vector) nmSysFree(sparse_vector); } -/*** Compute the magnitude of a sparsely allocated vector. +/*** Compute the length of a sparsely allocated vector. *** *** @param vector The vector. - *** @returns The computed magnitude. + *** @returns The computed length. ***/ -static double magnitude_sparse(const pVector vector) +unsigned int ca_sparse_len(const pVector vector) { - unsigned int magnitude = 0u; - for (unsigned int i = 0u, dim = 0u; dim < CA_NUM_DIMS;) + unsigned int i = 0u; + for (unsigned int dim = 0u; dim < CA_NUM_DIMS;) { const int val = vector[i++]; /** Negative val represents -val 0s in the array, so skip that many values. **/ if (val < 0) dim += (unsigned)(-val); - /** We have a param_value, so square it and add it to the magnitude. **/ - else { magnitude += (unsigned)(val * val); dim++; } + /** We have a param_value, but we don't need to do anything with it. **/ + else dim++; } - return sqrt((double)magnitude); + return i; } -/*** Compute the length of a sparsely allocated vector. +/*** Compute the magnitude of a sparsely allocated vector. *** *** @param vector The vector. - *** @returns The computed length. + *** @returns The computed magnitude. ***/ -unsigned int ca_sparse_len(const pVector vector) +static double magnitude_sparse(const pVector vector) { - unsigned int i = 0u; - for (unsigned int dim = 0u; dim < CA_NUM_DIMS;) + unsigned int magnitude = 0u; + for (unsigned int i = 0u, dim = 0u; dim < CA_NUM_DIMS;) { const int val = vector[i++]; /** Negative val represents -val 0s in the array, so skip that many values. **/ if (val < 0) dim += (unsigned)(-val); - /** We have a param_value, but we don't need to do anything with it. **/ - else dim++; + /** We have a param_value, so square it and add it to the magnitude. **/ + else { magnitude += (unsigned)(val * val); dim++; } } - return i; + return sqrt((double)magnitude); } /*** Compute the magnitude of a densely allocated centroid. @@ -417,6 +404,163 @@ static double sparse_similarity_to_centroid(const pVector v1, const pCentroid c2 ***/ #define sparse_dif_to_centroid(v1, c2) (1.0 - sparse_similarity_to_centroid(v1, c2)) +/*** Computes Levenshtein distance between two strings. + *** + *** @param str1 The first string. + *** @param str2 The second string. + *** @param length1 The length of the first string. + *** @param length1 The length of the first string. + *** + *** @attention - `Tip`: Pass 0 for the length of either string to infer it + *** using the null terminating character. Conversely, character arrays + *** with no null terminator are allowed if an explicit length is specified. + *** + *** @attention - `Complexity`: O(nm), where n and m are the lengths of str1 + *** and str2 (respectively). + *** + *** @skip + *** LINK ../../centrallix-sysdoc/string_comparison.md#levenshtein + ***/ +static unsigned int edit_dist(const char* str1, const char* str2, const size_t str1_length, const size_t str2_length) + { + /*** lev_matrix: + *** For all i and j, d[i][j] will hold the Levenshtein distance between + *** the first i characters of s and the first j characters of t. + *** + *** As they say, no dynamic programming algorithm is complete without a + *** matrix that you fill out and it has the answer in the final location. + ***/ + const size_t str1_len = (str1_length == 0u) ? strlen(str1) : str1_length; + const size_t str2_len = (str2_length == 0u) ? strlen(str2) : str2_length; + unsigned int* lev_matrix[str1_len + 1]; + for (unsigned int i = 0u; i < str1_len + 1u; i++) + lev_matrix[i] = nmMalloc((str2_len + 1) * sizeof(unsigned int)); + + /*** Base case #0: + *** Transforming an empty string into an empty string has 0 cost. + ***/ + lev_matrix[0][0] = 0u; + + /*** Base case #1: + *** Any source prefixe can be transformed into an empty string by + *** dropping each character. + ***/ + for (unsigned int i = 1u; i <= str1_len; i++) + lev_matrix[i][0] = i; + + /*** Base case #2: + *** Any target prefixes can be transformed into an empty string by + *** inserting each character. + ***/ + for (unsigned int j = 1u; j <= str2_len; j++) + lev_matrix[0][j] = j; + + /** General Case **/ + for (unsigned int i = 1u; i <= str1_len; i++) + { + for (unsigned int j = 1u; j <= str2_len; j++) + { + /** Equal characters need no changes. **/ + if (str1[i - 1] == str2[j - 1]) + lev_matrix[i][j] = lev_matrix[i - 1][j - 1]; + + /*** We need to make a change, so use the opereration with the + *** lowest cost out of delete, insert, replace, or swap. + ***/ + else + { + unsigned int cost_delete = lev_matrix[i - 1][j] + 1u; + unsigned int cost_insert = lev_matrix[i][j - 1] + 1u; + unsigned int cost_replace = lev_matrix[i-1][j-1] + 1u; + + /** If a swap is possible, calculate the cost. **/ + bool can_swap = ( + i > 1 && j > 1 && + str1[i - 1] == str2[j - 2] && + str1[i - 2] == str2[j - 1] + ); + unsigned int cost_swap = (can_swap) ? lev_matrix[i - 2][j - 2] + 1 : UINT_MAX; + + // Find the best operation. + lev_matrix[i][j] = min(min(min(cost_delete, cost_insert), cost_replace), cost_swap); + } + } + } + + /** Store result. **/ + unsigned int result = lev_matrix[str1_len][str2_len]; + + /** Cleanup. **/ + for (unsigned int i = 0u; i < str1_len + 1u; i++) + nmFree(lev_matrix[i], (str2_len + 1) * sizeof(unsigned int)); + + return result; + } + +/*** Compares two strings using their cosie simiarity, returning a value + *** between `0.0` (completely different) and `1.0` (identical). If either + *** OR BOTH strings are NULL, this function returns `0.0`. + *** + *** @attention - This function takes `void*` instead of `pVector` so that it + *** can be used as the similarity function in the ca_search() function + *** family without needing a messy typecast to avoid the compiler warning. + *** + *** @param v1 A `pVector` to the first string to compare. + *** @param v2 A `pVector` to the second string to compare. + *** @returns The cosine similarity between the two strings. + *** + *** @skip + *** LINK ../../centrallix-sysdoc/string_comparison.md#cosine + ***/ +double ca_cos_compare(void* v1, void* v2) + { + /** Input validation checks. **/ + if (v1 == NULL || v2 == NULL) return 0.0; + if (v1 == v2) return 1.0; + + /** Return the sparse similarity. **/ + return sparse_similarity((const pVector)v1, (const pVector)v2); + } + +/*** Compares two strings using their levenstien edit distance to compute a + *** similarity between `0.0` (completely different) and `1.0` (identical). + *** If both strings are empty, this function returns `1.0` (identical). If + *** either OR BOTH strings are NULL, this function returns `0.0`. + *** + *** @attention - This function takes `void*` instead of `char*` so that it + *** can be used as the similarity function in the ca_search() function + *** family without needing a messy typecast to avoid the compiler warning. + *** + *** @param str1 A `char*` to the first string to compare. + *** @param str2 A `char*` to the second string to compare. + *** @returns The levenshtein similarity between the two strings. + *** + *** @skip + *** LINK ../../centrallix-sysdoc/string_comparison.md#levenshtein + ***/ +double ca_lev_compare(void* str1, void* str2) + { + /** Input validation checks. **/ + if (str1 == NULL || str2 == NULL) return 0.0; + if (str1 == str2) return 1.0; + + /** Compute string length. **/ + const size_t len1 = strlen(str1); + const size_t len2 = strlen(str2); + + /** Empty strings are identical, avoiding a divide by zero. */ + if (len1 == 0lu && len2 == 0lu) return 1.0; + + /** Compute levenshtein edit distance. **/ + const unsigned int dist = edit_dist((const char*)str1, (const char*)str2, len1, len2); + + /** Normalize edit distance into a similarity measure. **/ + const double normalized_similarity = 1.0 - (double)dist / (double)max(len1, len2); + + /** Done. **/ + return normalized_similarity; + } + /*** Calculate the average size of all clusters in a set of vectors. *** *** @param vectors The vectors of the dataset (allocated sparsely). @@ -436,8 +580,7 @@ static double get_cluster_size( /** Could be up to around 1KB on the stack, but I think that's fine. **/ double cluster_sums[num_clusters]; unsigned int cluster_counts[num_clusters]; - for (unsigned int i = 0u; i < num_clusters; i++) - cluster_sums[i] = 0.0; + memset(cluster_sums, 0, sizeof(cluster_sums)); memset(cluster_counts, 0, sizeof(cluster_counts)); /** Sum the difference from each vector to its cluster centroid. **/ @@ -499,14 +642,16 @@ unsigned int compute_k(const unsigned int n) *** *** @param vectors The vectors to cluster. *** @param num_vectors The number of vectors to cluster. - *** @param labels Stores the final cluster identities of the vectors after - *** clustering is completed. - *** @param centroids Stores the locations of the centroids used for the clusters - *** of the data. - *** @param iterations The number of iterations that actually executed is stored - *** here. Leave this NULL if you don't care. - *** @param max_iter The max number of iterations. *** @param num_clusters The number of clusters to generate. + *** @param max_iter The max number of iterations. + *** @param min_improvement The minimum amount of improvement that must be met + *** each clustering iteration. If there is less improvement, the algorithm + *** will stop. Pass any value less than -1 to fully disable this feature. + *** @param labels Stores the final cluster identities of the vectors after + *** clustering is completed. Each value will be `0 <= n < num_clusters`. + *** @param vector_sims An array of num_vectors elements, allocated by the + *** caller, where index i stores the similarity of vector i to its assigned + *** cluster. Passing NULL skips evaluation of these values. *** *** @attention - Assumes: num_vectors is the length of vectors. *** @attention - Assumes: num_clusters is the length of labels. @@ -528,49 +673,39 @@ unsigned int compute_k(const unsigned int n) *** *** - `O(nk + nd)` ***/ -void ca_kmeans( +int ca_kmeans( pVector* vectors, const unsigned int num_vectors, - unsigned int* labels, const unsigned int num_clusters, const unsigned int max_iter, - const double improvement_threshold) + const double min_improvement, + unsigned int* labels, + double* vector_sims) { - /** Ensure labels is clean. **/ - memset(labels, 0, num_clusters * sizeof(unsigned int)); + /** Setup stuff. **/ + bool successful = false; + unsigned int cluster_counts[num_clusters]; + memset(labels, 0u, num_vectors * sizeof(unsigned int)); /** Allocate space to store centroids and new_centroids. **/ /** Dynamic allocation is required because these densely allocated arrays might be up to 500KB! **/ - pCentroid* centroids = (pCentroid*)nmMalloc(num_clusters * sizeof(pCentroid)); - if (centroids == NULL) - { - fprintf(stderr, "ca_kmeans() - nmMalloc(%lu) failed.\n", num_clusters * sizeof(pCentroid)); - assert(false); - } - pCentroid* new_centroids = (pCentroid*)nmMalloc(num_clusters * sizeof(pCentroid)); - if (new_centroids == NULL) - { - fprintf(stderr, "ca_kmeans() - nmMalloc(%lu) failed.\n", num_clusters * sizeof(pCentroid)); - assert(false); - } + const size_t centroids_size = num_clusters * sizeof(pCentroid); + pCentroid* centroids = (pCentroid*)check_ptr(nmMalloc(centroids_size)); + if (centroids == NULL) goto end; + memset(centroids, 0, centroids_size); + pCentroid* new_centroids = (pCentroid*)check_ptr(nmMalloc(centroids_size)); + if (new_centroids == NULL) goto end_free_centroids; + memset(new_centroids, 0, centroids_size); for (unsigned int i = 0u; i < num_clusters; i++) { /** Malloc each centroid. **/ - centroids[i] = (pCentroid)nmMalloc(pCentroidSize); - if (centroids[i] == NULL) - { - fprintf(stderr, "ca_kmeans() - nmMalloc(%lu) failed.\n", pCentroidSize); - assert(false); - } + centroids[i] = (pCentroid)check_ptr(nmMalloc(pCentroidSize)); + if (centroids[i] == NULL) goto end_deep_free_centroids; memset(centroids[i], 0, pCentroidSize); /** Malloc each new centroid. **/ - new_centroids[i] = (pCentroid)nmMalloc(pCentroidSize); - if (new_centroids[i] == NULL) - { - fprintf(stderr, "ca_kmeans() - nmMalloc(%lu) failed.\n", pCentroidSize); - assert(false); - } + new_centroids[i] = (pCentroid)check_ptr(nmMalloc(pCentroidSize)); + if (new_centroids[i] == NULL) goto end_deep_free_centroids; memset(new_centroids[i], 0, pCentroidSize); } @@ -578,10 +713,10 @@ void ca_kmeans( srand(time(NULL)); for (unsigned int i = 0u; i < num_clusters; i++) { - // Pick a random vector. + /** Pick a random vector. **/ const pVector vector = vectors[rand() % num_vectors]; - // Sparse copy the vector to expand it into a densely allocated centroid. + /** Sparse copy the vector to expand it into a densely allocated centroid. **/ pCentroid centroid = centroids[i]; for (unsigned int i = 0u, dim = 0u; dim < CA_NUM_DIMS;) { @@ -591,11 +726,17 @@ void ca_kmeans( } } + /** Setup debug visualizations. **/ + glyph_init(iter, "\n", 1, false); + glyph_init(find, ".", 64, false); + glyph_init(update_label, "!", 16, false); + glyph_init(update_centroid, ":", 8, false); + /** Main kmeans loop. **/ double old_average_cluster_size = 1.0; - unsigned int cluster_counts[num_clusters]; for (unsigned int iter = 0u; iter < max_iter; iter++) { + glyph(iter); bool changed = false; /** Reset new centroids. **/ @@ -609,6 +750,7 @@ void ca_kmeans( /** Assign each point to the nearest centroid. **/ for (unsigned int i = 0u; i < num_vectors; i++) { + glyph(find); const pVector vector = vectors[i]; double min_dist = DBL_MAX; unsigned int best_centroid_label = 0u; @@ -627,6 +769,7 @@ void ca_kmeans( /** Update label to new centroid, if necessary. **/ if (labels[i] != best_centroid_label) { + glyph(update_label); labels[i] = best_centroid_label; changed = true; } @@ -648,6 +791,7 @@ void ca_kmeans( /** Update centroids. **/ for (unsigned int i = 0u; i < num_clusters; i++) { + glyph(update_centroid); if (cluster_counts[i] == 0u) continue; pCentroid centroid = centroids[i]; const pCentroid new_centroid = new_centroids[i]; @@ -657,331 +801,187 @@ void ca_kmeans( } /** Is there enough improvement? **/ + if (min_improvement < -1) continue; /** Skip check if it will always fail. **/ const double average_cluster_size = get_cluster_size(vectors, num_vectors, labels, centroids, num_clusters); const double improvement = old_average_cluster_size - average_cluster_size; - if (improvement < improvement_threshold) break; + if (improvement < min_improvement) break; old_average_cluster_size = average_cluster_size; } - /** Clean up. **/ - for (unsigned int i = 0u; i < num_clusters; i++) + /** Compute vector similarities, if requested. **/ + if (vector_sims != NULL) { - nmFree(centroids[i], pCentroidSize); - nmFree(new_centroids[i], pCentroidSize); - } - nmFree(centroids, num_clusters * sizeof(pCentroid)); - nmFree(new_centroids, num_clusters * sizeof(pCentroid)); - } - -pXArray ca_search( - pVector* vectors, - const unsigned int num_vectors, - const unsigned int* labels, - const double dupe_threshold) - { - /** Allocate space for dups. **/ - pXArray dups = xaNew(num_vectors); - if (dups == NULL) - { - fprintf(stderr, "ca_search() - xaNew(%u) failed.\n", num_vectors); - return NULL; + for (unsigned int i = 0u; i < num_vectors; i++) + vector_sims[i] = sparse_similarity_to_centroid(vectors[i], centroids[labels[i]]); } - unsigned int a = 0, b = 0, c = 0, d = 0; - for (unsigned int i = 0u; i < num_vectors; i++) - { - const pVector v1 = vectors[i]; - const unsigned int label = labels[i]; - for (unsigned int j = i + 1u; j < num_vectors; j++) - { - if (b++ % 100 == 0) printf("."); - if (labels[j] != label) continue; - if (c++ % 100 == 0) printf(":"); - const pVector v2 = vectors[j]; - const double similarity = sparse_similarity(v1, v2); - if (similarity > dupe_threshold) /* Dup found! */ - { - Dup* dup = (Dup*)nmMalloc(sizeof(Dup)); - if (dup == NULL) - { - fprintf(stderr, - "ca_search() - nmMalloc(%lu) failed.\n", - sizeof(Dup) - ); - goto err_free_dups; - } - - dup->id1 = i; - dup->id2 = j; - dup->similarity = similarity; - xaAddItem(dups, (void*)dup); - if (d++ % 4 == 0) printf("!"); - } - } - if (a++ % 4 == 0) printf("\n"); - } + glyph_print("\n"); - return dups; + /** Success. **/ + successful = true; - /** Free dups. **/ - err_free_dups:; - const size_t num_dups = dups->nItems; - for (unsigned int i = 0u; i < num_dups; i++) - { - nmFree(dups->Items[i], sizeof(Dup)); - dups->Items[i] = NULL; - } - xaDeInit(dups); - return NULL; - } - -/*** Runs complete search to find duplocates if `num_vectors < MAX_COMPLETE_SEARCH` - *** and runs a search using k-means clustering on larger amounts of data. - *** - *** @param vectors Array of precomputed frequency vectors for all dataset strings. - *** @param num_vectors The number of vectors to be scanned. - *** @param dupe_threshold The similarity threshold, below which dups are ignored. - *** @returns The duplicates in pDup structs. - ***/ -pXArray ca_lightning_search(pVector* vectors, const unsigned int num_vectors, const double dupe_threshold) - { - /** Allocate space for dups. **/ - const size_t guess_size = num_vectors * 2u; - pXArray dups = xaNew(guess_size); - if (dups == NULL) + /** Clean up. **/ + end_deep_free_centroids: + for (unsigned int i = 0u; i < num_clusters; i++) { - fprintf(stderr, "ca_lightning_search() - xaNew(%lu) failed.\n", guess_size); - return NULL; + if (centroids[i] != NULL) nmFree(centroids[i], pCentroidSize); + else break; + if (new_centroids[i] != NULL) nmFree(new_centroids[i], pCentroidSize); + else break; } - /** Descide which algorithm to use. **/ - if (num_vectors <= 50 * 1000) - { /** Do a complete search. **/ - for (unsigned int i = 0u; i < num_vectors; i++) - { - const pVector v1 = vectors[i]; - for (unsigned int j = i + 1u; j < num_vectors; j++) - { - const pVector v2 = vectors[j]; - const double similarity = sparse_similarity(v1, v2); - if (similarity > dupe_threshold) // Dup found! - { - Dup* dup = (Dup*)nmMalloc(sizeof(Dup)); - if (dup == NULL) - { - fprintf(stderr, "ca_lightning_search() - nmMalloc(%lu) failed.\n", sizeof(Dup)); - goto err_free_dups; - } - - dup->id1 = i; - dup->id2 = j; - dup->similarity = similarity; - xaAddItem(dups, (void*)dup); - } - } - } - } - else - { /** Do a k-means search. **/ - /** Define constants for the algorithm. **/ - const unsigned int max_iter = 64u; /** Hardcode value because idk. **/ - const unsigned int num_clusters = compute_k(num_vectors); - - /** Allocate static memory for finding clusters. **/ - unsigned int labels[num_vectors]; - memset(labels, 0u, sizeof(labels)); - - /** Execute kmeans clustering. **/ - ca_kmeans(vectors, num_vectors, labels, num_clusters, max_iter, 0.0002); - - /** Find duplocates in clusters. **/ - for (unsigned int i = 0u; i < num_vectors; i++) - { - const pVector v1 = vectors[i]; - const unsigned int label = labels[i]; - for (unsigned int j = i + 1u; j < num_vectors; j++) - { - if (labels[j] != label) continue; - const pVector v2 = vectors[j]; - const double similarity = sparse_similarity(v1, v2); - if (similarity > dupe_threshold) /* Dup found! */ - { - Dup* dup = (Dup*)nmMalloc(sizeof(Dup)); - if (dup == NULL) - { - fprintf(stderr, - "ca_lightning_search() - nmMalloc(%lu) failed.\n", - sizeof(Dup) - ); - goto err_free_dups; - } - - dup->id1 = i; - dup->id2 = j; - dup->similarity = similarity; - xaAddItem(dups, (void*)dup); - } - } - } - } + // end_free_new_centroids: + nmFree(new_centroids, num_clusters * sizeof(pCentroid)); - /** Done **/ - return dups; + end_free_centroids: + nmFree(centroids, num_clusters * sizeof(pCentroid)); - /** Free dups. **/ - err_free_dups:; - const size_t num_dups = dups->nItems; - for (unsigned int i = 0u; i < num_dups; i++) - { - nmFree(dups->Items[i], sizeof(Dup)); - dups->Items[i] = NULL; - } - xaDeInit(dups); - return NULL; + end: + return (successful) ? 0 : -1; } -/*** Computes Levenshtein distance between two strings. - *** - *** @param str1 The first string. - *** @param str2 The second string. - *** @param length1 The length of the first string. - *** @param length1 The length of the first string. - *** - *** @attention - Tip: Pass 0 for the length of either string to infer it - *** using the null terminating character. Thus, strings with no null - *** terminator are supported if you pass explicit lengths. - *** - *** Complexity: O(length1 * length2). - *** - *** @see centrallix-sysdoc/string_comparison.md +/*** Finds the data that is the most similar to the target and returns + *** it if the similarity meets the threshold. + *** + *** @param target The target data to compare to the rest of the data. + *** @param data The rest of the data, compared against the target to + *** find the data that is the most similar. + *** @param num_data The number of elements in data. Specify 0 to detect + *** length on a null terminated array of data. + *** @param similarity A function which takes two data items of the type + *** of the data param and returns their similarity. + *** @param threshold The minimum similarity threshold. If the most similar + *** data does not meet this threshold, the funciton returns NULL. + *** @returns A pointer to the most similar piece of data found in the data + *** array, or NULL if the most similar data did not meet the threshold. ***/ -unsigned int ca_edit_dist(const char* str1, const char* str2, const size_t str1_length, const size_t str2_length) +void* ca_most_similar( + void* target, + void** data, + const unsigned int num_data, + const double (*similarity)(void*, void*), + const double threshold) { - /*** lev_matrix: - *** For all i and j, d[i][j] will hold the Levenshtein distance between - *** the first i characters of s and the first j characters of t. - *** - *** As they say, no dynamic programming algorithm is complete without a - *** matrix that you fill out and it has the answer in the final location. - ***/ - const size_t str1_len = (str1_length == 0u) ? strlen(str1) : str1_length; - const size_t str2_len = (str2_length == 0u) ? strlen(str2) : str2_length; - unsigned int lev_matrix[str1_len + 1][str2_len + 1]; - - /*** Base case #0: - *** Transforming an empty string into an empty string has 0 cost. - ***/ - lev_matrix[0][0] = 0u; - - /*** Base case #1: - *** Any source prefixe can be transformed into an empty string by - *** dropping each character. - ***/ - for (unsigned int i = 1u; i <= str1_len; i++) - lev_matrix[i][0] = i; - - /*** Base case #2: - *** Any target prefixes can be transformed into an empty string by - *** inserting each character. - ***/ - for (unsigned int j = 1u; j <= str2_len; j++) - lev_matrix[0][j] = j; - - /** General Case **/ - for (unsigned int i = 1u; i <= str1_len; i++) + void* most_similar = NULL; + double best_sim = -INFINITY; + for (unsigned int i = 0u; (num_data == 0u) ? (data[i] != NULL) : (i < num_data); i++) { - for (unsigned int j = 1u; j <= str2_len; j++) + const double sim = similarity(target, data[i]); + if (sim > best_sim && sim > threshold) { - /** Equal characters need no changes. **/ - if (str1[i - 1] == str2[j - 1]) - lev_matrix[i][j] = lev_matrix[i - 1][j - 1]; - - /*** We need to make a change, so use the opereration with the - *** lowest cost out of delete, insert, replace, or swap. - ***/ - else - { - unsigned int cost_delete = lev_matrix[i - 1][j] + 1u; - unsigned int cost_insert = lev_matrix[i][j - 1] + 1u; - unsigned int cost_replace = lev_matrix[i-1][j-1] + 1u; - - /** If a swap is possible, calculate the cost. **/ - bool can_swap = ( - i > 1 && j > 1 && - str1[i - 1] == str2[j - 2] && - str1[i - 2] == str2[j - 1] - ); - unsigned int cost_swap = (can_swap) ? lev_matrix[i - 2][j - 2] + 1 : UINT_MAX; - - // Find the best operation. - lev_matrix[i][j] = min(min(min(cost_delete, cost_insert), cost_replace), cost_swap); - } + most_similar = data[i]; + best_sim = sim; } } - - return lev_matrix[str1_len][str2_len]; + return most_similar; } -/*** Runs complete search to find duplocates in phone numbers using the - *** levenshtein min edit distance algorithm. - *** - *** @param dataset An array of characters for all dataset strings. - *** @param dataset_size The number of phone numbers to be scanned. - *** @param dupe_threshold The similarity threshold, below which dups are ignored. - *** @returns The duplicates in pDup structs. + +/*** Runs a sliding search over the povided data, comparing each element to + *** the following `window_size` elements, invoking the passed comparison + *** function just under `window_size * num_data` times. If any comparison + *** yeilds a similarity greater than the threshold, it is stored in the + *** xArray returned by this function. + *** + *** @param data The data to be searched. + *** @param num_data The number of data items in data. + *** @param window_size The size of the sliding window used for the search. + *** @param similarity A function which takes two data items of the type of + *** the data param and returns their similarity. + *** @param threshold The minimum threshold required for a duplocate to be + *** included in the returned xArray. + *** @param maybe_dups A pointer to an xArray in which dups should be found. + *** Pass NULL to allocate a new one. + *** @returns An xArray holding all of the duplocates found. If maybe_dups is + *** not NULL, this will be that xArray, to allow for chaining. ***/ -pXArray ca_phone_search(char dataset[][10u], const unsigned int dataset_size, const double dupe_threshold) +pXArray ca_sliding_search( + void** data, + const unsigned int num_data, + const unsigned int window_size, + const double (*similarity)(void*, void*), + const double threshold, + pXArray dups) { - /** Allocate space for dups. **/ - const size_t guess_size = dataset_size * 2u; - pXArray dups = xaNew(guess_size); - if (dups == NULL) + /** Allocate space for dups (if necessary). **/ + const bool allocate_dups = (dups == NULL); + if (allocate_dups) { - fprintf(stderr, "ca_phone_search() - xaNew(%lu) failed.\n", guess_size); - return NULL; + /** Guess that we will need space for num_data * 2 dups. **/ + const int guess_size = num_data * 2; + dups = check_ptr(xaNew(guess_size)); + if (dups == NULL) goto err; } + const int num_starting_dups = dups->nItems; - /** Search for dups using edit distance. **/ - for (unsigned int i = 0u; i < dataset_size; i++) - { - const char* v1 = dataset[i]; - for (unsigned int j = i + 1u; j < dataset_size; j++) + /** Setup debug visualizations. **/ + glyph_init(outer, " ", 4, true); + glyph_init(inner, ".", 128, false); + glyph_init(find, "!", 32, false); + + /** Search for dups. **/ + for (unsigned int i = 0u; i < num_data; i++) + { + glyph(outer); + const unsigned int window_start = i + 1u; + const unsigned int window_end = min(i + window_size, num_data); + for (unsigned int j = window_start; j < window_end; j++) { - const char* v2 = dataset[j]; - const unsigned int dist = ca_edit_dist(v1, v2, 10u, 10u); - const double similarity = (double)dist / 10.0; - if (similarity > dupe_threshold) /* Dup found! */ + glyph(inner); + const double sim = similarity(data[i], data[j]); + if (sim > threshold) /* Dup found! */ { - Dup* dup = (Dup*)nmMalloc(sizeof(Dup)); - if (dup == NULL) - { - fprintf(stderr, "ca_phone_search() - nmMalloc(%lu) failed.\n", sizeof(Dup)); - - /** Free data before returning. **/ - const size_t num_dups = dups->nItems; - for (unsigned int i = 0u; i < num_dups; i++) - { - void* dup = dups->Items[i]; - nmFree(dup, sizeof(Dup)); - } - xaDeInit(dups); - return NULL; - } - + glyph(find); + Dup* dup = (Dup*)check_ptr(nmMalloc(sizeof(Dup))); + if (dup == NULL) goto err_free_dups; dup->id1 = i; dup->id2 = j; - dup->similarity = similarity; - xaAddItem(dups, (void*)dup); + dup->similarity = sim; + if (!check_neg(xaAddItem(dups, (void*)dup))) goto err_free_dups; } } } + glyph_print("\n"); + /** Success. **/ return dups; + + /** Error cleanup. **/ + + err_free_dups: + /** Free the dups we added to the XArray. */ + while (dups->nItems > num_starting_dups) + nmFree(dups->Items[dups->nItems--], sizeof(Dup)); + if (allocate_dups) check(xaDeInit(dups)); /* Failure ignored. */ + + err: + return NULL; } -void ca_init() +/*** Runs a complete search over the povided data, comparing each element to + *** each other element, invoking the passed comparison function `num_data^2` + *** times. If any comparison yeilds a similarity greater than the threshold, + *** it is stored in the xArray returned by this function. + *** + *** @param data The data to be searched. + *** @param num_data The number of data items in data. + *** @param similarity A function which takes two data items of the type of + *** the data param and returns their similarity. + *** @param threshold The minimum threshold required for a duplocate to be + *** included in the returned xArray. + *** @param maybe_dups A pointer to an xArray in which dups should be found. + *** Pass NULL to allocate a new one. + *** @returns An xArray holding all of the duplocates found. If maybe_dups is + *** not NULL, this will be that xArray, to allow for chaining. + ***/ +pXArray ca_complete_search( + void** data, + const unsigned int num_data, + const double (*similarity)(void*, void*), + const double threshold, + pXArray dups) { - nmRegister(sizeof(Dup), "Dup"); + return ca_sliding_search(data, num_data, num_data, similarity, threshold, dups); } /** Scope cleanup. **/ diff --git a/centrallix-lib/src/util.c b/centrallix-lib/src/util.c index ec1d87bcf..450c16593 100644 --- a/centrallix-lib/src/util.c +++ b/centrallix-lib/src/util.c @@ -110,10 +110,13 @@ int util_detect_num_threads(void) ***/ #define USE_METRIC false #define nUnits 6u -static char* units_cs[nUnits] = {"bytes", "KiB", "MiB", "GiB", "TiB", "PiB"}; -static char* units_metric[nUnits] = {"bytes", "KB", "MB", "GB", "TB", "PB"}; +static char* units_cs[nUnits] = {"bytes", "KiB", "MiB", "GiB"}; +static char* units_metric[nUnits] = {"bytes", "KB", "MB", "GB"}; + /*** Displays a size in bytes using the largest unit where the result would be - *** at least 1.0. + *** at least 1.0. Note that units larger than GB and GiB are not supported + *** because the largest possible unsigned int is 4,294,967,295, which is + *** exactly 4 GiB (or approximately 4.29 GB). *** *** @param buf The buffer to which new text will be written, using snprintf(). *** @param buf_size The amount of space in the buffer, passed to snprintf(). @@ -228,16 +231,14 @@ void timer_free(pTimer timer) /*** Function for failing on error, assuming the error came from a library or *** system function call, so that the error buffer is set to a valid value. ***/ -void fail(const char* function_name, int code) +void print_diagnostics(int code, const char* function_name, const char* file_name, const int line_number) { - /** Create the most descriptive error message we can. **/ + /** Create a descriptive error message. **/ char error_buf[BUFSIZ]; - snprintf(error_buf, sizeof(error_buf), "kmeans.c: Fail - %s", function_name); - if (errno != 0) perror(error_buf); - else if (code != 0) fprintf(stderr, "%s (error code %d)\n", error_buf, code); - else fprintf(stderr, "%s", error_buf); + snprintf(error_buf, sizeof(error_buf), "%s:%d: %s failed", file_name, line_number, function_name); - /** Throw error for easier locating in a debugger. **/ - fprintf(stderr, "Program will now crash.\n"); - raise(SIGSEGV); + /** Print it with as much info as we can reasonably find. **/ + if (errno != 0) perror(error_buf); + else if (code != 0) fprintf(stderr, "%s (error code %d).\n", error_buf, code); + else fprintf(stderr, "%s.\n", error_buf); } diff --git a/centrallix-os/cluster-schema.cluster b/centrallix-os/cluster-schema.cluster index a97d7f9ba..9f11c1636 100644 --- a/centrallix-os/cluster-schema.cluster +++ b/centrallix-os/cluster-schema.cluster @@ -10,7 +10,7 @@ file_name "system/cluster" ?style : StyleObj // idk where to find docs for this. } // Access with :parameters:name. Accessing dynamic data (e.g. parameters) - // should be managed within a runserver() call. + // should be done within a runserver() call. ... source : DataSourcePath @@ -18,12 +18,14 @@ file_name "system/cluster" cluster_name "cluster/cluster" { - algorithm : "none" | "sliding-window" | "k-means" - | "k-means++" | "k-medoids" |"db-scan" // dbscan not implemented + algorithm : "none" | "sliding-window" | "k-means" // Implemented + | "k-means++" | "k-medoids" | "db-scan" // Not implemented similarity_measure : "cosine" | "levenshtein" // levenshtein not implemented. num_clusters : uint > 1 // (probably a parameter) ?min_improvement : double && 0.0 < x < 1.0 | "none" // default: 0.0001 ?max_iterations : uint // default: 64 + ?window_size : uint > 0 // required for algorithm = sliding_window. + ?overlap_size : double && 0.0 <= x <= 1.0 // default: 0.0, only allowed for algorithm = k-means | k-means++ | k-medoids, not implemented // Not implemented sub_cluster_name "cluster/cluster" @@ -37,26 +39,21 @@ file_name "system/cluster" { source : string ⊂ [cluster_name, ...] threshold : double && 0.0 < x < 1.0 // optimization. - similarity_measure : "cosine" | "levenshtein" // levenshtein not implemented. + similarity_measure : "cosine" | "levenshtein" } ... } // Output schema -- /{arbitrary uint} +- /cluster_name ? /sub_cluster_name - ? /{arbitrary uint} + ? ... + - /{query} + - /items : StringVec // The data points in the cluster. ... - - /average_similarity : double && 0.0 < x < 1.0 - - /size = average_similarity - - /{arbitrary uint} - - /val : string // The value of the data point. - - /label : uint < num_clusters // id of the cluster to which this data point belongs. - - /sim : double && 0.0 < x <= threshold // Similarity to cluster centroid. -... /search_name -- /{arbitrary uint} +- /{query} - /id1 : uint < sizeof(source/attr_name) // The id of the first data point. - /id2 : uint < sizeof(source/attr_name) // The id of the second data point. - /val1 : string // The value of the first data point. @@ -71,7 +68,7 @@ file_name "system/cluster" // thing, because that feels like a higher-level responsibility. // Invoke file: -// select * from /file.cl +// select * from /file.cluster // Driver-authoring.md // Comprehend stparse.c (lib vs. centrallix?) diff --git a/centrallix-os/file.cluster b/centrallix-os/file.cluster index 929efdd03..078a39fcc 100644 --- a/centrallix-os/file.cluster +++ b/centrallix-os/file.cluster @@ -23,11 +23,14 @@ file_name "system/cluster" source = "/apps/kardia/data/Kardia_DB/p_partner/rows"; attr_name = p_given_name; // runserver(:parameters:str) + // Multiple data sources when? + // Clustering object specifies properties for clustering. kmeans_cluster "cluster/cluster" { algorithm = "k-means"; similarity_measure = "cosine"; + // window_size = 16; num_clusters = runserver(:parameters:k); min_improvement = 0.0001; max_iterations = 48; diff --git a/centrallix-sysdoc/string_similarity.md b/centrallix-sysdoc/string_similarity.md new file mode 100644 index 000000000..f466a057c --- /dev/null +++ b/centrallix-sysdoc/string_similarity.md @@ -0,0 +1,167 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +# String Similarity +The following sections discuss the approaches to calculating similarity between two strings which are implemented in the `clusters.c` library. This library can be incuded using `#include "clusters.h"` in centrallix-lib and `#include "cxlib/clusters.h"` in centrallix. + + +## Table of Contents +- [String Comparison](#string-comparison) + - [Table of Contents](#table-of-contents) + - [Cosine Similarity](#cosine-similarity) + - [Character Sets](#character-sets) + - [Character Pair Hashing](#character-pair-hashing) + - [String Vectors](#string-vectors) + - [Sparse Vectors](#sparse-vectors) + - [Computing Similarity](#computing-similarity) + - [Levenshtein Similarity](#levenshtein-similarity) + - [Clustering](#clustering) + - [K-means Clustering](#k-means-clustering) + - [K-means++ Clustering](#k-means-clustering-1) + - [K-medoids Clustering](#k-medoids-clustering) + - [DBScan Clustering](#db-scan) + - [Sliding Clusters](#sliding-clusters) + - [Future Implementation](#future-implementation) + - [K-means Fuzzy Clustering](#k-means-fuzzy-clusterings) + - [Implement Missing Algorithms](#implement-missing-algorithms) + + +## Cosine Similarity +The [Cosine Similarity](https://en.wikipedia.org/wiki/Cosine_similarity) function is defined as the dot product of two vectors divided by the product of the magnitude of the two vectors. Conceptually, it's like finding the _angle_ between two vectors. To get these vectors, we use the relative frequency of character pairs within each string. To reduce memory cost and speed up computation, we store them in a special sparcely allocated form, described below. + +### Character Sets +Cosine compare currnetly uses the following character sets. These can be extended or modified later, if necessary. +```c +const char ALLOW_SET[] = " \n\v\f\r!#$%&\"'()*+,-./:;<=>?@[]^_{|}~ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789"; +const char CHAR_SET[] = "`abcdefghijklmnopqrstuvwxyz0123456789"; +const char SIGNIFICANT_SET[] = "`ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789"; +const char IGNORE_SET[] = " \n\v\f\r!#$%&\"'()*+,-./:;<=>?@[]^_{|}"; +const char BOUNDARY_CHAR = ('a' - 1); // aka. '`' +``` +- `ALLOW_SET` represents all characters which can be passed to a similarity detection algorithm. Passing other characters may cause warnings and errors, undefined or unintended behavior, and even security concerns. +- `CHAR_SET` represents all of the characters that will be uniquely considered during the calculation of similarity. Currently, this is all lowercase letters and numbers. +- `SIGNIFICANT_SET` represents all of the characters that are significant for the purposes of similarity. For example, the upercase letters are significant because they are considered identical to lowercase letters. Thus, they are included in the `SIGNIFICANT_SET`, but not in the `CHAR_SET`. +- `IGNORE_SET` represents characters which, while allowed to be passed to a similarity algorithm, will be ignored. For example, the strings "Ya!!" and "Ya..." will be considered identical. +- The `BOUNDARY_CHAR` is a special character which is conceptually added to the start and end of any string to be checked. + - This allows for pairs that functionally include only the first and last character. + - This character appears to have been selected to be one before the first character in `CHAR_SET` (thus convention dictates that it be written `'a' - 1` to indicate this), although it's unknown if that's the main or only reason. + - If `clusters.h` is included, it can be accessed using the `CA_BOUNDARY_CHAR` macro. + +### Character Pair Hashing +Even with a small set of ASCII characters (say 36), there are still `36^2 = 1296` possible character pairs. If the number of characters in the `CHAR_SET` ever needed to be expanded - for example, to include all UTF-8 characters - this number would quickly explode exponentially to utterly infeasible proportions. Thus, a hashing algorithm is employed to hash each character pair down to a more reasonable number of dimensions (which can be accessed with the `CA_NUM_DIMS` macro). + +### String Vectors +Any string of characters in the `ALLOW_SET` can be represented by a vector. For simplicty, imagine this vector has only `5` dimensions. To find this vector, we hash each character pair in the string. As each character pair is hashed (for example, that the pair "ab" happens to hash to `3`), the corresponding dimension is increased by some amount. This amount varies to based on the characters in the pair, helping to mitigate the impact of collisions where different character pairs hash to identical numbers (a larger number of dimensions also helps to mitigate this). + +Remember that the first and last characters form a pair with the `BOUNDARY_CHAR`, so the string "ab" has three pairs: "a", "ab", and "b". If these each hash to `2`, `3`, and `0`. Thus, the vector generated by the string "ab" might be: `[7, 0, 4, 3, 0]`. Notice that dimensions #1 and #4 are both `0` because no character pairs generated a hash of `1` or `4`. In real usecases, the vast majority of elements are `0`s because the number of dimensions used is much larger than the number of character pairs in a typical string. + +### Sparse Vectors +As noted above, the vast majority of elements in a vector generated by a typical string are `0`s. This would lead to a large waste of memory and computation if every `0` was stored separately, so instead, vectors are stored sparsely. Because all hashes are positive integers, we represent `n` `0`s with a value of ` -n`. Thus, the vector `[0, 1, 0, 0, 0]` (representing an empty string in `5` dimensions) would be represented sparsely as `[-1, 1, -3]`. + +**Note**: A value of `0` in a sparse vector is undefined, so no element should be equal to `0`. + +**Note**: Sparse arrays can vary greatly in length. To find their size, one needs to traverse the array until the total number of values found adds up to `CA_NUM_DIMS`. The `ca_sparse_len()` function can be used to do this. Also, the `ca_build_vector()` and `ca_free_vector()` use the `nmSys` functions from `newmalloc.h` to avoid conflicts over the size of the allocated data. + +### Computing Similarity +Finally, to find the cosine similarity between two strings, we can simply take the [dot product](https://en.wikipedia.org/wiki/Dot_product) of their coresponding vectors. Then, we normalize the dot product by dividing by the magnitudes of both vectors multiplied together. Two strings can be compared this way using the `ca_cos_compare()` function. + + +## Levenshtein Similarity +The [Levenshtein](https://en.wikipedia.org/wiki/Levenshtein_distance) distance is defined as the number of insertions, deletions, or substitutions required to make one string exactly like another string. The version implemented in `clusters.c` additionally allows a new operation called a "swap" in which two adjacent characters change places. Transpositions of larger pieces of text are, unfortunately, not handled as well, which is a potential downfall of using levenshtein edit distance. + +The levenshtein similarity of two strings can be compared using the `ca_lev_compare()` function. + + +## Clustering +When searching for similar strings in a large amount of data (for example, `1,000,000` strings), comparing every string to every other string can be very computationally expensive. To speed up this process, it is helpful to _cluster_ similar strings together, then only compare strings within similar clusters. This sacrifices some accuracy to allow large amounts of data to be searched and compared in a feasable amount of time. + +### K-means Clustering +When clustering data using the [k-means](https://en.wikipedia.org/wiki/K-means_clustering) algorithm, data is divided into a predefined number of clusters with the goal of maximizing the average similarity of datapoints within any given cluster. To quickly summarize the algorithm: +1. Randomly select `k` datapoints to be the initial centroids of each cluster. +2. For each datapoint, find the centroid it is most similar to, and assign it to that clustser. +3. For each cluster, find the new centroid by averaging all datapoints in the cluster. +4. Repeat steps 2 and 3 until the clusters stabilize (i.e. no datapoint changes clusters). + +The implementation used in `clusters.c` also allows the programmer to specify a maximum number of iterations (called `max_iter` in the code) to prevent this process from running forever. Additionally, successive iterations can give diminishing results or even produce clusters that are slightly worse. To improve performance, the programmer can also specify a minimum improvement threshold (called `min_improvement`). Clusters must become more similar by at least this amount each iteration, otherwise the algorithm ends, even if the maximum number of iterations has not yet been reached. + +The `ca_kmeans()` function can be invoked using [the cosine comparison string vectors](#string-vectors) (see above) to cluster them into similar clusters. + +### K-means++ Clustering +**Not yet implemented** +This method is largely identical to k-means, except that [k-means++](https://en.wikipedia.org/wiki/K-means%2B%2B) assignes the initial centroids using an aproximate algorithm designed to avoid some of the poor clusterings possible with random assignment. + +### K-medoids Clustering +**Not yet implemented** +This method is also very similar to k-means, except that [k-medoids](https://en.wikipedia.org/wiki/K-medoids) places an aditional requirement that all centroids be points in the data. This would theoretically allow for other similarity measures (such as levenshtein edit distance) to be used for clustering instead of only cosine compare. + +### DB-Scan +**Proposed, not yet implemented or documented** + +### Sliding Clusters +A far more basic method of "clustering" is to simply sort all data alphabetically, then, instead of comparing each string to all other strings, it can be compared to only the next `n` strings. Of course, differences near the start of a string (for example, "fox" vs. "box") will cause those strings to sort far away from each other, leading them to be completely missed. + +Sorting using a similarity measure, such as `ca_cos_compare()` or `ca_lev_compare()` would resolve this issue. However, these comparison functions do not meet the transitivity requirement for sorting, which is that `(A < B) & (B < C) -> (A < C)`. For example, "car" is similar to "boxcar", which is also similar to "box". However, "car" and "box" are not similar at all. + +Additionally, sorting by the cosine vectors (similarly to how we cluster by them when using k-means) was proposed, but further investigation showed that this was also not possible. + +For problems where a sorting algorithm exists which can mitigate the above issues, this solution may prove very promissing. However, so far we have not found such a problem, so the other clustering algorithms tend to out perform Sliding Clusters. + + +## Future Implementation + +### K-means Fuzzy Clustering +One of the biggest downsides with k-means is that it creates very arbitrary boundaries between clusters. Elements on either side of these boundaries may be highly similar, but if comparisons only occur within a cluster, these similar entries will be missed. The problem becomes more extreme as a higher k value (more clusters) is used, creating more arbitrary boundaries. This drawback is probably the main reason that clustering sacrifices some accuracy over searching every element. + +Running the entire search multiple types may allow some of these to be found because the initial cluster locations are random. This approach is partially implemented for duplocate searching because the algorithm runs nightly anyway, so a simple up-sert (**UP**date existing entries; in**SERT** new entries) slightly reduces this problem. However, this solution is obviously far from ideal. + +If the clustering could be expanded with an additional step that makes clusters larger, adding elements from other clusters to them, this might effectively mitigate the issue. It may also allow developers to use larger numbers of clusters, improving performance as well as accuracy. Further research is needed to verify the effectiveness of this approach before an implementation is written. + +### Implement Missing Algorithms +Several algorithms (such as [k-means++](#k-means-clustering-1), [k-medoids](#k-medoids-clustering), and [DBScan](#db-scan)) above are proposed but lack an implementation. They may be effective and useful, however, to reduce development time, they have not yet been implemented. diff --git a/centrallix/include/obj.h b/centrallix/include/obj.h index 045d57f85..54d4c988a 100644 --- a/centrallix/include/obj.h +++ b/centrallix/include/obj.h @@ -192,6 +192,7 @@ typedef struct _OSD int (*Commit)(); int (*GetQueryCoverageMask)(); int (*GetQueryIdentityPath)(); + int (*Unregister)(); } ObjDriver, *pObjDriver; diff --git a/centrallix/osdrivers/objdrv_cluster.c b/centrallix/osdrivers/objdrv_cluster.c index f56cca5de..4acfc8579 100644 --- a/centrallix/osdrivers/objdrv_cluster.c +++ b/centrallix/osdrivers/objdrv_cluster.c @@ -29,7 +29,6 @@ /* Description: Cluster object driver. */ /************************************************************************/ -#include #include #include #include @@ -73,7 +72,7 @@ ***/ /** Pure Laziness **/ -#define ENABLE_TPRINTF +// #define ENABLE_TPRINTF /** Debugging **/ #ifndef ENABLE_TPRINTF @@ -101,8 +100,6 @@ void void_func() {} *** an error cascade which may be useful to the user since a stack trace is *** not readily available. *** - *** @todo I think this should be moved to somewhere else. - *** *** @param clr Whether to clear the current error stack. As a rule of thumb, *** if you are the first one to detec the error, clear the stack so that *** other unrelated messages are not shown. If you are detecting an error @@ -119,7 +116,7 @@ void void_func() {} void mssErrorf(int clr, char* module, const char* format, ...) { /** Prevent interlacing with stdout flushing at a weird time. **/ - check(fflush(stdout)); + check(fflush(stdout)); /* Failure ignored. */ /** Insert convenient newline before error stack begins. **/ if (clr == 1) fprintf(stderr, "\n"); @@ -139,7 +136,7 @@ void mssErrorf(int clr, char* module, const char* format, ...) return; } if (num_chars > BUFSIZ) - fprintf(stderr, "WARNING: Error truncated (length %d > buffer size %d).\n", num_chars, BUFSIZ); + fprintf(stderr, "Warning: Error truncated (length %d > buffer size %d).\n", num_chars, BUFSIZ); /** Print the error. **/ const int ret = mssError(clr, module, "%s", buf); @@ -346,13 +343,13 @@ typedef unsigned char TargetType; #define TARGET_SEARCH_ENTRY (TargetType)5u /** Attribute name lists by TargetType. **/ -#define nATTR_ROOT 2u -char* const ATTR_ROOT[nATTR_ROOT] = { +#define END_OF_ARRAY NULL +char* const ATTR_ROOT[] = { "source", "attr_name", + END_OF_ARRAY, }; -#define nATTR_CLUSTER 7u -char* const ATTR_CLUSTER[nATTR_CLUSTER] = +char* const ATTR_CLUSTER[] = { "algorithm", "similarity_measure", @@ -361,199 +358,300 @@ char* const ATTR_CLUSTER[nATTR_CLUSTER] = "max_iterations", "date_created", "date_computed", + END_OF_ARRAY, }; -#define nATTR_SEARCH 5u -char* const ATTR_SEARCH[nATTR_SEARCH] = +char* const ATTR_SEARCH[] = { "source", "threshold", "similarity_measure", "date_created", "date_computed", + END_OF_ARRAY, }; -#define nATTR_CLUSTER_ENTRY 2u -char* const ATTR_CLUSTER_ENTRY[nATTR_CLUSTER_ENTRY] = +char* const ATTR_CLUSTER_ENTRY[] = { - "val", - "sim", + "items", + END_OF_ARRAY, }; -#define nATTR_SEARCH_ENTRY 3u -char* const ATTR_SEARCH_ENTRY[nATTR_SEARCH_ENTRY] = +char* const ATTR_SEARCH_ENTRY[] = { "val1", "val2", "sim", + END_OF_ARRAY, }; -#define END_OF_ATTRIBUTES NULL - /** Method name list. **/ -#define nMETHOD_NAME 2u -char* const METHOD_NAME[nMETHOD_NAME] = +char* const METHOD_NAME[] = { "cache", + END_OF_ARRAY, }; -#define END_OF_METHODS END_OF_ATTRIBUTES /** ================ Struct Declarations ================ **/ /** ANCHOR[id=structs] **/ -/** Represents the data source which may have data already fetched. **/ +/*** Represents the data source which may have data already fetched. + *** + *** Memory Stats: + *** - Padding: 4 bytes + *** - Total size: 72 bytes + *** + *** @skip --> Attribute Data. + *** @param Name The source name, specified in the .cluster file. + *** @param Key The key associated with this object in the SourceDataCache. + *** @param SourcePath The path to the data source from which to retrieve data. + *** @param AttrName The name of the attribute to get from the data source. + *** + *** @skip --> Computed data. + *** @param Strings The data strings to be clustered and searched, or NULL if + *** they have not been fetched from the source. + *** @param Vectors The cosine comparison vectors from the fetched data, or + *** NULL if they haven't been computed. Note that vectors are no longer + *** needed once all clusters and searches have been computed, so they are + *** automatically freed in that case to save memory. + *** @param nVectors The number of vectors and data strings. + *** + *** @skip --> Time. + *** @param DateCreated The date and time that this object was created and initialized. + *** @param DateComputed The date and time that the Labels field was computed. + ***/ typedef struct _SOURCE { - /** Top level attributes (specified in the .cluster file). **/ - char* Name; /* The node name, specified in the .cluster file. - * Warning: Some code makes the assumption that this - * is the first field in the struct. - */ - char* Key; /* The key associated with this object in the global SourceCache. */ - char* SourcePath; /* The path to the data source from which to retrieve data. */ - char* AttrName; /* The name of the attribute to get from the data source. */ - - /** Computed data. **/ - char** Data; /* The data strings to be clustered and searched, or NULL if they - * have not been fetched from the source. - */ - pVector* Vectors; /* The cosine comparison vectors from the fetched data, or NULL if - * they haven't been computed. Note that vectors are no longer - * needed once all clusters and searches have been computed, so - * they are automatically freed in that case to save memory. - */ - unsigned int nVectors; /* The number of vectors and data strings. Note: This is not - * set to 0 if the vector array is freed, this case should be - * checked separately. - */ - - /** Time. **/ - DateTime DateCreated; /* The date and time that this object was created and initialized. */ - DateTime DateComputed; /* The date and time that the Data and Vectors fields were computed. */ - } SourceData, *pSourceData; - -/** Data for each cluster. **/ + char* Name; + char* Key; + char* SourcePath; + char* AttrName; + char** Strings; + pVector* Vectors; + unsigned int nVectors; + DateTime DateCreated; + DateTime DateComputed; + } + SourceData, *pSourceData; + + +/*** Computed data for a single cluster. + *** + *** Memory Stats: + *** - Padding: 4 bytes + *** - Total size: 24 bytes + *** + *** @param Size The number of items in the cluster. + *** @param Strings The string values of each item. + *** @param Vectors The cosine vectors for each item. + ***/ +typedef struct + { + unsigned int Size; + char** Strings; + pVector* Vectors; + } + Cluster, *pCluster; + + +/*** Data for each cluster. Only attribute data is checked for caching. + *** + *** Memory Stats: + *** - Padding: 2 bytes + *** - Total size: 96 bytes + *** + *** @skip --> Attribute Data. + *** @param Name The cluster name, specified in the .cluster file. + *** @param Key The key associated with this object in the ClusterDataCache. + *** @param ClusterAlgorithm The clustering algorithm to be used. + *** @param SimilarityMeasure The similarity measure used to compare items. + *** @param nClusters The number of clusters. 1 if algorithm = none. + *** @param MinImprovement The minimum amount of improvement that must be met + *** each clustering iteration. If there is less improvement, the algorithm + *** will stop. The "max" in a .cluster file is represented by -inf. + *** @param MaxIterations The maximum number of iterations that a clustering + *** algorithm can run for. Note: Sliding window uses this field to store + *** the window_size. + *** + *** @skip --> Relationship Data. + *** @param nSubClusters The number of subclusters of this cluster. + *** @param SubClusters A pClusterData array, NULL if nSubClusters == 0. + *** @param Parent This cluster's parent. NULL if it is not a subcluster. + *** @param SourceData Pointer to the source data that this cluster uses. + *** + *** @skip --> Computed data. + *** @param Clusters An array of length num_clusters, NULL if the clusters + *** have not yet been computed. + *** @param Sims An array of num_vectors elements, where index i stores the + *** similarity of vector i to its assigned cluster. This field is NULL + *** if the clusters have not yet been computed. + *** + *** @skip --> Time. + *** @param DateCreated The date and time that this object was created and initialized. + *** @param DateComputed The date and time that the Labels field was computed. + ***/ typedef struct _CLUSTER { - /** Attribute Data. **/ - char* Name; /* The cluster name, specified in the .cluster file. - * Warning: Some code makes the assumption that this - * is the first field in the struct. - */ - char* Key; /* The key associated with this object in the global ClusterCache. */ - ClusterAlgorithm ClusterAlgorithm; /* The clustering algorithm to be used. */ - SimilarityMeasure SimilarityMeasure; /* The similarity measurse to be used when clustering. */ - unsigned int NumClusters; /* The number of clusters. 1 if algorithm = none. */ - double MinImprovement; /* The minimum amount of improvement that must be met each - * clustering iteration. If there is less improvement, the - * algorithm will stop. Specifying "max" in the .cluster - * file should be represented by a value of -inf. - */ - unsigned int MaxIterations; /* The maximum number of iterations to run clustering. */ - - /** Other data (ignored by caching). **/ - unsigned int nSubClusters; /* The number of subclusters of this cluster. */ - struct _CLUSTER** SubClusters; /* A pClusterData array, NULL if nSubClusters == 0. */ - struct _CLUSTER* Parent; /* This cluster's parent. NULL if it is not a subcluster. */ - pSourceData SourceData; /* Pointer to the source data that this cluster uses. */ - - /** Computed data. **/ - unsigned int* Labels; /* An array with one element for each vector in the data - * (aka. DriverData->nVectors). For vector i, Labels[i] is - * the ID of the cluster to which that data is assigned. - * NULL if the cluster has not been computed. */ - - /** Time. **/ - DateTime DateCreated; /* The date and time that this object was created and initialized. */ - DateTime DateComputed; /* The date and time that the Labels field was computed. */ + char* Name; + char* Key; + ClusterAlgorithm ClusterAlgorithm; + SimilarityMeasure SimilarityMeasure; + unsigned int nClusters; + double MinImprovement; + unsigned int MaxIterations; + unsigned int nSubClusters; + struct _CLUSTER** SubClusters; + struct _CLUSTER* Parent; + pSourceData SourceData; + Cluster* Clusters; + double* Sims; + DateTime DateCreated; + DateTime DateComputed; } ClusterData, *pClusterData; -/** Data for each search. **/ + +/*** Data for each search. + *** + *** Memory Stats: + *** - Padding: 3 bytes + *** - Total size: 64 bytes + *** + *** @skip --> Attribute Data. + *** @param Name The search name, specified in the .cluster file. + *** @param Key The key associated with this object in the SearchDataCache. + *** @param Source The cluster from which this search is to be derived. + *** @param SimilarityMeasure The similarity measure used to compare items. + *** @param Threshold The minimum similarity threshold for elements to be + *** included in the results of the search. + *** + *** @skip --> Computed data. + *** @param Dups An array holding the dups found by the search, or NULL if the + *** search has not been computed. + *** @param nDups The number of dups found. + *** + *** @skip --> Time. + *** @param DateCreated The date and time that this object was created and initialized. + *** @param DateComputed The date and time that the Dups field was computed. + ***/ typedef struct _SEARCH { - char* Name; /* The search name, specified in the .cluster file. - * Warning: Some code makes the assumption that this - * is the first field in the struct. - */ - char* Key; /* The key associated with this object in the global SearchCache. */ - pClusterData Source; /* The cluster from which this search is to be derived. */ - double Threshold; /* The minimum similarity threshold for elements to be - * included in the results of the search. - */ - SimilarityMeasure SimilarityMeasure; /* The similarity measure used to compare items. */ - - /** Computed data. **/ - pDup* Dups; /* An array holding the dups found by the search, or NULL - * if the search has not been computed. - */ - unsigned int nDups; /* The number of dups found. */ - - /** Time. **/ - DateTime DateCreated; /* The date and time that this object was created and initialized. */ - DateTime DateComputed; /* The date and time that the Dups field was computed. */ + char* Name; + char* Key; + pClusterData Source; + double Threshold; + pDup* Dups; + unsigned int nDups; + SimilarityMeasure SimilarityMeasure; + DateTime DateCreated; + DateTime DateComputed; } SearchData, *pSearchData; + /*** Node instance data. - *** When a .cluster file is openned, there will be only one node for that + *** + *** Memory Stats: + *** - Padding: 4 bytes + *** - Total size: 64 bytes + *** + *** @note When a .cluster file is openned, there will be only one node for that *** file. However, in the course of the query, many driver instance structs *** may be created by functions like clusterQueryFetch(), and closed by the *** object system using clusterClose(). + *** + *** @param SourceData Data from the provided source. + *** @param Params A pParam array storing the params in the .cluster file. + *** @param nParams The number of specified params. + *** @param ParamList Functions as a "scope" for resolving values during parsing. + *** @param ClusterDatas A pCluster array storing the clusters in the .cluster file. + *** Will be NULL if nClusters = 0. + *** @param nClusterDatas The number of specified clusters. + *** @param SearchDatas A SearchData array storing the searches in the .cluster file. + *** @param nSearches The number of specified searches. + *** @param nSearchDatas The parent object used to open this NodeData instance. ***/ typedef struct _NODE { - /** Substructures. **/ - pSourceData SourceData; /* Data from the provided source. */ - pParam* Params; /* A pParam array storing the params in the .cluster file. */ - unsigned int nParams; /* The number of specified params. */ - pParamObjects ParamList; /* Functions as a "scope" for resolving values during parsing. */ - pClusterData* Clusters; /* A pCluster array storing the clusters in the .cluster file. - * Will be NULL if nClusters = 0. - */ - unsigned int nClusters; /* The number of specified clusters. */ - pSearchData* Searches; /* A SearchData array storing the searches in the .cluster file. */ - unsigned int nSearches; /* The number of specified searches. */ - - /** Other stuff, idk why it's here. **/ - pSnNode Node; - pObject Obj; + pObject Parent; + pParam* Params; + pParamObjects ParamList; + pSourceData SourceData; + pClusterData* ClusterDatas; + pSearchData* SearchDatas; + unsigned int nParams; + unsigned int nClusterDatas; + unsigned int nSearchDatas; } NodeData, *pNodeData; -/** Driver instance data. **/ -/*** Similar to a pointer to specific, computed data in the pNodeData struct. - *** If target type is the root, a cluster, or a search, no data is guarnteed - *** to be computed yet. These three types can be returned from clusterOpen(). - *** To target a cluster entry or search entry, fetch a driver targetting a - *** cluster or search (respectively). These target types ensure that the data - *** has been computed, so the GetAttr functions do not need to ensure this. +/*** Driver instance data. + *** + *** Memory Stats: + *** - Padding: 1 bytes + *** - Total size: 24 bytes + *** + *** This struct can be thought of like a "pointer" to specific data accessible + *** through the stored pNodeData struct. This struct also communicates whether + *** that data is guaranteed to have been computed. + *** + *** For example, if target type is the root, a cluster, or a search, no data + *** is guaranteed to be computed. These three types can be returned from + *** clusterOpen(), based on the provided path. + *** + *** Alternatively, a cluster entry or search entry can be targetted by calling + *** fetch on a query pointing to a driver instance that targets a cluster or + *** search (respectively). These two entry target types ensure that the data + *** they indicate has been computed, so the GetAttrType() and GetAttrValue() + *** functions do not need to check this repeatedly each time they are called. + *** + *** @param NodeData The associated node data struct. There can be many driver + *** instances pointing to one NodeData at a time, but each driver instance + *** always points to singular NodeData struct. + *** @param TargetType The type of data targetted (see above). + *** @param TargetData If target type is: + *** ```csv + *** Root: A pointer to the SourceData struct. + *** Cluster or ClusterEntry: A pointer to the targetted cluster. + *** Search or SearchEntry: A pointer to the targetted search. + *** ``` + *** @param TargetAttrIndex An index into an attribute list (for GetNextAttr()). + *** @param TargetMethodIndex An index into an method list (for GetNextMethod()). ***/ typedef struct _DRIVER { - pNodeData NodeData; /* The associated node data. */ - TargetType TargetType; /* The type of data targetted by this driver instance. */ - void* TargetData; /* A pointer to the specific targetted cluster or search. */ - unsigned int TargetIndex; /* An index into the cluster or search (entries only). */ - unsigned char TargetAttrIndex; /* An index into an attribute list (for GetNextAttr()). */ - unsigned char TargetMethodIndex; /* An index into an method list (for GetNextMethod()). */ + pNodeData NodeData; + void* TargetData; + unsigned int TargetIndex; + unsigned char TargetAttrIndex; + unsigned char TargetMethodIndex; + TargetType TargetType; } DriverData, *pDriverData; -/** Query instance data. **/ +/*** Query instance data. + *** + *** Memory Stats: + *** - Padding: 4 bytes + *** - Total size: 16 bytes + *** + *** @param DriverData The associated driver instance being queried. + *** @param RowIndex The selected row of the data targetted by the driver. + ***/ typedef struct { - pDriverData DriverData; /* The associated driver instance being queried. */ - unsigned int RowIndex; /* The selected row of the data targetted by the driver. */ + pDriverData DriverData; + unsigned int RowIndex; } ClusterQuery, *pClusterQuery; + /** Global storage for caches. **/ struct { - XHashTable SourceCache; - XHashTable ClusterCache; - XHashTable SearchCache; + XHashTable SourceDataCache; + XHashTable ClusterDataCache; + XHashTable SearchDataCache; } - ClusterCaches; + ClusterDriverCaches; /** ================ Function Declarations ================ **/ @@ -577,6 +675,7 @@ static void ci_FreeSourceData(pSourceData source_data); static void ci_FreeClusterData(pClusterData cluster_data, bool recursive); static void ci_FreeSearchData(pSearchData search_data); static void ci_FreeNodeData(pNodeData node_data); +static void ci_FreeCaches(void); /** Deep Size Computation Functions. **/ // LINK #sizing @@ -619,6 +718,7 @@ static void ci_CacheFreeSourceData(pXHashEntry entry, void* path); static void ci_CacheFreeCluster(pXHashEntry entry, void* path); static void ci_CacheFreeSearch(pXHashEntry entry, void* path); int clusterExecuteMethod(void* inf_v, char* methodname, pObjData param, pObjTrxTree oxt); +int clusterUnregister(pObjDriver object_driver, pObjSession session); /** Unimplemented DriverFunctions. **/ // LINK #unimplemented @@ -636,18 +736,44 @@ int clusterCommit(void* inf_v, pObjTrxTree *oxt); /** ANCHOR[id=parsing] **/ // LINK #functions +/** Format a hint to give to the user. **/ +static void ci_GiveHint(const char* hint) + { + fprintf(stderr, " > Hint: Did you mean \"%s\"?\n", hint); + } + +/*** Given the user a hint when they specify an invalid string for a field + *** where we know the list of valid strings. The hint is only displayed if + *** their string is close enough to a valid string. + *** + *** @param value The value the user gave. + *** @param valid_values The valid values that could be what they meant. + *** @param n_valid_values The number of valid values. Specify 0 to detect + *** length on a null terminated array of values. + *** @returns Whether a hint was given. + ***/ +static bool ci_TryHint(char* value, char** valid_values, const unsigned int n_valid_values) + { + char* guess = ca_most_similar(value, (void**)valid_values, n_valid_values, ca_lev_compare, 0.5); + if (guess == NULL) return false; /* No hint. */ + + /** Issue hint. **/ + ci_GiveHint(guess); + return true; + } + + +// LINK #functions /*** Returns 0 for success and -1 on failure. Promises that mssError() will be *** invoked on failure, so the caller need not specify their own error message. *** Returns 1 if attribute is available, printing an error if the attribute was *** marked as required. *** - *** @attention - Promises that mssError() will be invoked on failure, so the - *** caller is not required to specify their own error message. + *** @attention - Promises that a failure invokes mssError() at least once. *** - *** TODO: Greg - *** This function took several hours of debugging before it worked at all, and I - *** still don't know if it works correctly... or really how it works. Please - *** review this code carefully! + *** TODO: Greg - Review Carefully. + *** This function took a lot of debugging to get it to work. Please make sure + *** it works correctly and properly requires runserver() for dynamic attributes. ***/ static int ci_ParseAttribute( pStructInf inf, @@ -659,8 +785,9 @@ static int ci_ParseAttribute( bool print_type_error) { int ret; + tprintf("Invoking ci_ParseAttribute('%s').\n", attr_name); - /** Get attribute name. **/ + /** Get attribute inf. **/ pStructInf attr_info = stLookup(inf, attr_name); if (attr_info == NULL) { @@ -669,14 +796,19 @@ static int ci_ParseAttribute( } ASSERTMAGIC(attr_info, MGK_STRUCTINF); - /** Get the attribute. **/ - tprintf("Invoking ci_ParseAttribute('%s')...\n", attr_name); + /** Allocate expression. **/ pExpression exp = check_ptr(stGetExpression(attr_info, 0)); + if (exp == NULL) goto err; + + /** Bind parameters. **/ + /** TODO: Greg - What does this return? How do I know if it fails? **/ expBindExpression(exp, param_list, EXPR_F_RUNSERVER); + + /** Evaluate expression. **/ ret = expEvalTree(exp, param_list); if (ret != 0) { - mssErrorf(0, "Cluster", "Expression evaluation failed."); + mssErrorf(0, "Cluster", "Expression evaluation failed (error code %d).", ret); goto err; } @@ -695,42 +827,13 @@ static int ci_ParseAttribute( if (ret != 0) { mssErrorf(1, "Cluster", - "Failed to get data of type \"%s\" from exp \"%s\" (error code %d).", - ci_TypeToStr(datatype), exp->Name, ret + "Failed to get \"%s\" : %s using expression \"%s\" (error code %d).", + attr_name, ci_TypeToStr(datatype), exp->Name, ret ); goto err; } -// const int ret = stGetAttrValueOSML( -// attr_info, -// datatype, -// data, -// 0, -// param_list->Session, -// param_list -// ); -// if (ret == 1) -// { -// mssErrorf(1, "Cluster", -// "stGetAttrValueOSML('%s') because %s cannot be null.\n" -// " > Hint: You might have used an undefined variable or forgot to add runserver().", -// attr_name, attr_name -// ); -// return 1; -// } -// if (ret != 0) -// { -// if (print_type_error) -// { -// mssErrorf(1, "Cluster", -// "stGetAttrValueOSML('%s') failed (error code %d).\n" -// " > Hint: It might be a type mismatch, or you used an undefined variable.", -// attr_name, ret -// ); -// } -// return ret; -// } - + /** Success. **/ return 0; err: @@ -746,8 +849,7 @@ static int ci_ParseAttribute( /*** Parses a ClusteringAlgorithm from the algorithm field in the pStructInf *** representing some structure with that attribute in a parsed structure file. *** - *** @attention - Promises that mssError() will be invoked on failure, so the - *** caller is not required to specify their own error message. + *** @attention - Promises that a failure invokes mssError() at least once. *** *** @param inf A parsed pStructInf. *** @param param_list The param objects that function as a kind of "scope" for @@ -758,7 +860,7 @@ static ClusterAlgorithm ci_ParseClusteringAlgorithm(pStructInf inf, pParamObject { /** Get the algorithm attribute. **/ char* algorithm; - if (ci_ParseAttribute(inf, "algorithm", DATA_T_STRING, POD(&algorithm), param_list, true, true) != 0) + if (ci_ParseAttribute(inf, "algorithm", DATA_T_STRING, POD(&algorithm), param_list, true, true) != 0) { mssErrorf(0, "Cluster", "Failed to parse attribute 'algorithm' in group \"%s\".", inf->Name); return ALGORITHM_NULL; @@ -771,9 +873,21 @@ static ClusterAlgorithm ci_ParseClusteringAlgorithm(pStructInf inf, pParamObject if (!strcasecmp(algorithm, "k-means++")) return ALGORITHM_KMEANS_PLUS_PLUS; if (!strcasecmp(algorithm, "k-medoids")) return ALGORITHM_KMEDOIDS; if (!strcasecmp(algorithm, "db-scan")) return ALGORITHM_DB_SCAN; - + /** Unknown value for clustering algorithm. **/ mssErrorf(1, "Cluster", "Unknown \"clustering algorithm\": %s", algorithm); + + /** Attempt to give a hint. **/ + char* all_names[nClusteringAlgorithms] = {NULL}; + for (unsigned int i = 0u; i < nClusteringAlgorithms; i++) + all_names[i] = ci_ClusteringAlgorithmToString(ALL_CLUSTERING_ALGORITHMS[i]); + if (ci_TryHint(algorithm, all_names, nClusteringAlgorithms)); + else if (strcasecmp(algorithm, "sliding") == 0) ci_GiveHint(ci_ClusteringAlgorithmToString(ALGORITHM_SLIDING_WINDOW)); + else if (strcasecmp(algorithm, "window") == 0) ci_GiveHint(ci_ClusteringAlgorithmToString(ALGORITHM_SLIDING_WINDOW)); + else if (strcasecmp(algorithm, "null") == 0) ci_GiveHint(ci_ClusteringAlgorithmToString(ALGORITHM_NONE)); + else if (strcasecmp(algorithm, "nothing") == 0) ci_GiveHint(ci_ClusteringAlgorithmToString(ALGORITHM_NONE)); + + /** Fail. **/ return ALGORITHM_NULL; } @@ -783,8 +897,7 @@ static ClusterAlgorithm ci_ParseClusteringAlgorithm(pStructInf inf, pParamObject *** pStructInf parameter, which represents some structure with that attribute *** in a parsed structure file. *** - *** @attention - Promises that mssError() will be invoked on failure, so the - *** caller is not required to specify their own error message. + *** @attention - Promises that a failure invokes mssError() at least once. *** *** @param inf A parsed pStructInf. *** @param param_list The param objects that function as a kind of "scope" for @@ -805,7 +918,20 @@ static SimilarityMeasure ci_ParseSimilarityMeasure(pStructInf inf, pParamObjects if (!strcasecmp(measure, "cosine")) return SIMILARITY_COSINE; if (!strcasecmp(measure, "levenshtein")) return SIMILARITY_LEVENSHTEIN; + /** Unknown similarity measure. **/ mssErrorf(1, "Cluster", "Unknown \"similarity measure\": %s", measure); + + /** Attempt to give a hint. **/ + char* all_names[nSimilarityMeasures] = {NULL}; + for (unsigned int i = 0u; i < nSimilarityMeasures; i++) + all_names[i] = ci_SimilarityMeasureToString(ALL_SIMILARITY_MEASURES[i]); + if (ci_TryHint(measure, all_names, nSimilarityMeasures)); + else if (strcasecmp(measure, "cos") == 0) ci_GiveHint(ci_SimilarityMeasureToString(SIMILARITY_COSINE)); + else if (strcasecmp(measure, "lev") == 0) ci_GiveHint(ci_SimilarityMeasureToString(SIMILARITY_LEVENSHTEIN)); + else if (strcasecmp(measure, "edit-dist") == 0) ci_GiveHint(ci_SimilarityMeasureToString(SIMILARITY_LEVENSHTEIN)); + else if (strcasecmp(measure, "edit-distance") == 0) ci_GiveHint(ci_SimilarityMeasureToString(SIMILARITY_LEVENSHTEIN)); + + /** Fail. **/ return SIMILARITY_NULL; } @@ -815,8 +941,7 @@ static SimilarityMeasure ci_ParseSimilarityMeasure(pStructInf inf, pParamObjects *** a .cluster structure file. *** *** @attention - Warning: Caching in use. - *** @attention - Promises that mssError() will be invoked on failure, so the - *** caller is not required to specify their own error message. + *** @attention - Promises that a failure invokes mssError() at least once. *** *** @param inf A parsed pStructInf for a .cluster structure file. *** @param param_list The param objects that function as a kind of "scope" for @@ -832,26 +957,30 @@ static pSourceData ci_ParseSourceData(pStructInf inf, pParamObjects param_list, /** Get source. **/ if (ci_ParseAttribute(inf, "source", DATA_T_STRING, POD(&buf), param_list, true, true) != 0) goto err; char* source_path = check_ptr(nmSysStrdup(buf)); + if (source_path == NULL) goto err; /** Get attribute name. **/ if (ci_ParseAttribute(inf, "attr_name", DATA_T_STRING, POD(&buf), param_list, true, true) != 0) goto err; char* attr_name = check_ptr(nmSysStrdup(buf)); + if (attr_name == NULL) goto err_free_path; /** Create cache entry key. **/ const size_t len = strlen(path) + strlen(source_path) + strlen(attr_name) + 3lu; char* key = check_ptr(nmSysMalloc(len * sizeof(char))); + if (key == NULL) goto err_free_attr; snprintf(key, len, "%s?%s:%s", path, source_path, attr_name); - pXHashTable source_cache = &ClusterCaches.SourceCache; /** Check for a cached version. **/ - pSourceData source_maybe = (pSourceData)xhLookup(source_cache, key); + pSourceData source_maybe = (pSourceData)xhLookup(&ClusterDriverCaches.SourceDataCache, key); if (source_maybe != NULL) { /** Cache hit. **/ tprintf("# source: \"%s\"\n", key); - tprintf("--> Name: %s\n", source_maybe->Name); /* Cause invalid read if cache was incorrectly freed. */ - /** Free data we don't need. */ + /** Cause an imediate invalid read if cache was incorrectly freed. **/ + tprintf("--> Name: %s\n", source_maybe->Name); + + /** Free data we don't need. **/ nmSysFree(source_path); nmSysFree(attr_name); nmSysFree(key); @@ -862,21 +991,43 @@ static pSourceData ci_ParseSourceData(pStructInf inf, pParamObjects param_list, /** Cache miss: Create a new source data object. **/ pSourceData source_data = check_ptr(nmMalloc(sizeof(SourceData))); + if (source_data == NULL) goto err_free_key; memset(source_data, 0, sizeof(SourceData)); - source_data->Name = check_ptr(nmSysStrdup(inf->Name)); source_data->Key = key; source_data->SourcePath = source_path; source_data->AttrName = attr_name; - check(objCurrentDate(&source_data->DateCreated)); + source_data->Name = check_ptr(nmSysStrdup(inf->Name)); + if (source_data->Name == NULL) goto err_free_source; + if (!check(objCurrentDate(&source_data->DateCreated))) goto err_free_source; /** Add the new object to the cache for next time. **/ tprintf("+ source: \"%s\"\n", key); - check(xhAdd(source_cache, key, (void*)source_data)); + if (!check(xhAdd(&ClusterDriverCaches.SourceDataCache, key, (void*)source_data))) + goto err_free_source; + /** Success. **/ return source_data; + /** Error handling. **/ + err_free_source: + ci_FreeSourceData(source_data); + nmSysFree(key); + goto err; + + err_free_key: + nmSysFree(key); + + err_free_attr: + nmSysFree(attr_name); + + err_free_path: + nmSysFree(source_path); + err: - mssErrorf(0, "Cluster", "Failed to parse source data from group \"%s\" in file: %s", inf->Name, path); + mssErrorf(0, "Cluster", + "Failed to parse source data from group \"%s\" in file: %s", + inf->Name, path + ); return NULL; } @@ -901,17 +1052,21 @@ static pClusterData ci_ParseClusterData(pStructInf inf, pNodeData node_data) tprintf("Parsing cluster: %s\n", inf->Name); + /** Extract values. **/ pParamObjects param_list = node_data->ParamList; pSourceData source_data = node_data->SourceData; /** Allocate space for data struct. **/ pClusterData cluster_data = check_ptr(nmMalloc(sizeof(ClusterData))); + if (cluster_data == NULL) goto err; memset(cluster_data, 0, sizeof(ClusterData)); /** Basic Properties. **/ cluster_data->Name = check_ptr(nmSysStrdup(inf->Name)); - cluster_data->SourceData = source_data; - check(objCurrentDate(&cluster_data->DateCreated)); + if (cluster_data->Name == NULL) goto err_free_cluster; + cluster_data->SourceData = check_ptr(source_data); + if (cluster_data->SourceData == NULL) goto err_free_cluster; + if (!check(objCurrentDate(&cluster_data->DateCreated))) goto err_free_cluster; /** Get algorithm. **/ cluster_data->ClusterAlgorithm = ci_ParseClusteringAlgorithm(inf, param_list); @@ -920,7 +1075,7 @@ static pClusterData ci_ParseClusterData(pStructInf inf, pNodeData node_data) /** Handle no clustering case. **/ if (cluster_data->ClusterAlgorithm == ALGORITHM_NONE) { - cluster_data->NumClusters = 1u; + cluster_data->nClusters = 1u; goto parsing_done; } @@ -930,19 +1085,36 @@ static pClusterData ci_ParseClusterData(pStructInf inf, pNodeData node_data) /** Handle sliding window case. **/ if (cluster_data->ClusterAlgorithm == ALGORITHM_SLIDING_WINDOW) + { + /** Sliding window doesn't allocate any clusters. **/ + cluster_data->nClusters = 0u; + + /** Get window_size. **/ + int window_size; + if (ci_ParseAttribute(inf, "window_size", DATA_T_INTEGER, POD(&window_size), param_list, true, true) != 0) + goto err_free_cluster; + if (window_size < 1) + { + mssErrorf(1, "Cluster", "Invalid value for [window_size : uint > 0]: %d", window_size); + goto err_free_cluster; + } + + /** Store value. **/ + cluster_data->MaxIterations = (unsigned int)window_size; goto parsing_done; + } /** Get num_clusters. **/ int num_clusters; - if (ci_ParseAttribute(inf, "num_clusters", DATA_T_INTEGER, POD(&num_clusters), param_list, true, true) != 0) goto err_free_cluster; + if (ci_ParseAttribute(inf, "num_clusters", DATA_T_INTEGER, POD(&num_clusters), param_list, true, true) != 0) + goto err_free_cluster; if (num_clusters < 2) { mssErrorf(1, "Cluster", "Invalid value for [num_clusters : uint > 1]: %d", num_clusters); if (num_clusters == 1) fprintf(stderr, "HINT: Use algorithm=\"none\" to disable clustering.\n"); goto err_free_cluster; } - cluster_data->NumClusters = (unsigned int)num_clusters; - tprintf("Got value for num_clusters: %d\n", num_clusters); + cluster_data->nClusters = (unsigned int)num_clusters; /** Get min_improvement. **/ double improvement; @@ -955,19 +1127,24 @@ static pClusterData ci_ParseClusterData(pStructInf inf, pNodeData node_data) mssErrorf(1, "Cluster", "Invalid value for [min_improvement : 0.0 < x < 1.0 | \"none\"]: %g", improvement); goto err_free_cluster; } + + /** Successfully got value. **/ cluster_data->MinImprovement = improvement; } else if (result == -1) { char* str; result = ci_ParseAttribute(inf, "min_improvement", DATA_T_STRING, POD(&str), param_list, false, true); - if (result == 0 && !strcasecmp(str, "none")) + if (result != 0) goto err_free_cluster; + if (strcasecmp(str, "none") != 0) { - /** Specify no min improvement. **/ - cluster_data->MinImprovement = -INFINITY; + mssErrorf(1, "Cluster", "Invalid value for [min_improvement : 0.0 < x < 1.0 | \"none\"]: %s", str); + goto err_free_cluster; } + + /** Successfully got none. **/ + cluster_data->MinImprovement = -INFINITY; } - if (result == -1) goto err_free_cluster; /** Get max_iterations. **/ int max_iterations; @@ -986,33 +1163,89 @@ static pClusterData ci_ParseClusterData(pStructInf inf, pNodeData node_data) /** Search for sub-clusters. **/ XArray sub_clusters; - const int ret = xaInit(&sub_clusters, 4u); - if (ret != 0) - { - mssErrorf(1, "Cluster", "FAIL - xaInit(&sub_clusters, %u): %d", 4u, ret); - goto err_free_cluster; - } + if (!check(xaInit(&sub_clusters, 4u))) goto err_free_cluster; for (unsigned int i = 0u; i < inf->nSubInf; i++) { - /** Check that this is a group (not an attribute). **/ - pStructInf group_inf = inf->SubInf[i]; - ASSERTMAGIC(group_inf, MGK_STRUCTINF); - if (stStructType(group_inf) != ST_T_SUBGROUP) continue; - - /** Select array by group type. **/ - if (strcmp(check_ptr(group_inf->UsrType), "cluster/cluster") != 0) continue; + pStructInf sub_inf = check_ptr(inf->SubInf[i]); + ASSERTMAGIC(sub_inf, MGK_STRUCTINF); + char* name = sub_inf->Name; - /** Subcluster found. **/ - pClusterData sub_cluster = ci_ParseClusterData(group_inf, node_data); - if (sub_cluster == NULL) goto err_free_sub_clusters; - sub_cluster->Parent = cluster_data; - xaAddItem(&sub_clusters, sub_cluster); + /** Handle various struct types. **/ + const int struct_type = stStructType(sub_inf); + switch (struct_type) + { + case ST_T_ATTRIB: + { + /** Valid attribute names. **/ + char* attrs[] = { + "algorithm", + "similarity_measure", + "num_clusters", + "min_improvement", + "max_iterations", + "window_size", + }; + const unsigned int nattrs = sizeof(attrs) / sizeof(char*); + + /** Ignore valid attribute names. **/ + bool is_valid = false; + for (unsigned int i = 0u; i < nattrs; i++) + { + if (strcmp(name, attrs[i]) == 0) + { + is_valid = true; + break; + } + } + if (is_valid) continue; /* Next inf. */ + + /** Give the user a warning, and attempt to give them a hint. **/ + fprintf(stderr, "Warning: Unknown attribute '%s' in cluster \"%s\".\n", name, inf->Name); + if (ci_TryHint(name, attrs, nattrs)); + else if (strcasecmp(name, "k") == 0) ci_GiveHint("num_clusters"); + else if (strcasecmp(name, "threshold") == 0) ci_GiveHint("min_improvement"); + + break; + } + + case ST_T_SUBGROUP: + { + /** Select array by group type. **/ + char* group_type = check_ptr(sub_inf->UsrType); + if (group_type == NULL) goto err_free_subclusters; + if (strcmp(group_type, "cluster/cluster") != 0) + { + fprintf(stderr, + "Warning: Unknown group \"%s\" : \"%s\" in cluster \"%s\".\n", + name, group_type, inf->Name + ); + continue; + } + + /** Subcluster found. **/ + pClusterData sub_cluster = ci_ParseClusterData(sub_inf, node_data); + if (sub_cluster == NULL) goto err_free_subclusters; + sub_cluster->Parent = cluster_data; + if (!check_neg(xaAddItem(&sub_clusters, sub_cluster))) goto err_free_subclusters; + + break; + } + + default: + { + mssErrorf(1, "Cluster", + "Warning: Unknown struct type %d in cluster \"%s\".", + struct_type, inf->Name + ); + goto err_free_subclusters; + } + } } cluster_data->nSubClusters = sub_clusters.nItems; cluster_data->SubClusters = (cluster_data->nSubClusters > 0u) ? (pClusterData*)ci_xaToTrimmedArray(&sub_clusters) : NULL; /* No sub-clusters. */ - xaDeInit(&sub_clusters); + check(xaDeInit(&sub_clusters)); /* Failure ignored. */ /** Create the cache key. **/ parsing_done:; @@ -1021,7 +1254,7 @@ static pClusterData ci_ParseClusterData(pStructInf inf, pNodeData node_data) { case ALGORITHM_NONE: { - const size_t len = strlen(source_data->Key) + strlen(cluster_data->Name) + 5lu; + const size_t len = strlen(source_data->Key) + strlen(cluster_data->Name) + 8lu; key = nmSysMalloc(len * sizeof(char)); snprintf(key, len, "%s/%s?%u", source_data->Key, @@ -1033,13 +1266,14 @@ static pClusterData ci_ParseClusterData(pStructInf inf, pNodeData node_data) case ALGORITHM_SLIDING_WINDOW: { - const size_t len = strlen(source_data->Key) + strlen(cluster_data->Name) + 8lu; + const size_t len = strlen(source_data->Key) + strlen(cluster_data->Name) + 16lu; key = nmSysMalloc(len * sizeof(char)); - snprintf(key, len, "%s/%s?%u&%u", + snprintf(key, len, "%s/%s?%u&%u&%u", source_data->Key, cluster_data->Name, ALGORITHM_SLIDING_WINDOW, - cluster_data->SimilarityMeasure + cluster_data->SimilarityMeasure, + cluster_data->MaxIterations ); break; } @@ -1053,23 +1287,24 @@ static pClusterData ci_ParseClusterData(pStructInf inf, pNodeData node_data) cluster_data->Name, cluster_data->ClusterAlgorithm, cluster_data->SimilarityMeasure, - cluster_data->NumClusters, + cluster_data->nClusters, cluster_data->MinImprovement, cluster_data->MaxIterations ); break; } } - pXHashTable cluster_cache = &ClusterCaches.ClusterCache; cluster_data->Key = key; /** Check for a cached version. **/ - pClusterData cluster_maybe = (pClusterData)xhLookup(cluster_cache, key); + pClusterData cluster_maybe = (pClusterData)xhLookup(&ClusterDriverCaches.ClusterDataCache, key); if (cluster_maybe != NULL) { /** Cache hit. **/ tprintf("# cluster: \"%s\"\n", key); - tprintf("--> Name: %s\n", cluster_maybe->Name); /* Cause invalid read if cache was incorrectly freed. */ + + /** Cause invalid read if cache was incorrectly freed. **/ + tprintf("--> Name: %s\n", cluster_maybe->Name); /** Free the parsed cluster that we no longer need. */ ci_FreeClusterData(cluster_data, false); @@ -1081,19 +1316,22 @@ static pClusterData ci_ParseClusterData(pStructInf inf, pNodeData node_data) /** Cache miss. **/ tprintf("+ cluster: \"%s\"\n", key); - check(xhAdd(cluster_cache, key, (void*)cluster_data)); + if (!check(xhAdd(&ClusterDriverCaches.ClusterDataCache, key, (void*)cluster_data))) goto err_free_key; return cluster_data; /** Error cleanup. **/ - err_free_sub_clusters: + err_free_key: + nmSysFree(key); + + err_free_subclusters: for (unsigned int i = 0u; i < sub_clusters.nItems; i++) ci_FreeClusterData(sub_clusters.Items[i], true); - xaDeInit(&sub_clusters); + check(xaDeInit(&sub_clusters)); /* Failure ignored. */ err_free_cluster: ci_FreeClusterData(cluster_data, false); - // err: + err: mssErrorf(0, "Cluster", "Failed to parse cluster from group \"%s\".", inf->Name); return NULL; } @@ -1118,20 +1356,21 @@ static pSearchData ci_ParseSearchData(pStructInf inf, pNodeData node_data) tprintf("Parsing search: %s\n", inf->Name); /** Allocate space for search struct. **/ - pSearchData search_data = nmMalloc(sizeof(SearchData)); - assert(search_data != NULL); + pSearchData search_data = check_ptr(nmMalloc(sizeof(SearchData))); + if (search_data == NULL) goto err; memset(search_data, 0, sizeof(SearchData)); - + /** Get basic information. **/ search_data->Name = check_ptr(nmSysStrdup(inf->Name)); - check(objCurrentDate(&search_data->DateCreated)); + if (search_data->Name == NULL) goto err_free_search; + if (!check(objCurrentDate(&search_data->DateCreated))) goto err_free_search; /** Get source. **/ char* source_name; if (ci_ParseAttribute(inf, "source", DATA_T_STRING, POD(&source_name), node_data->ParamList, true, true) != 0) return NULL; - for (unsigned int i = 0; i < node_data->nClusters; i++) + for (unsigned int i = 0; i < node_data->nClusterDatas; i++) { - pClusterData cluster_data = node_data->Clusters[i]; + pClusterData cluster_data = node_data->ClusterDatas[i]; if (strcmp(source_name, cluster_data->Name) == 0) { /** Source found. **/ @@ -1139,11 +1378,22 @@ static pSearchData ci_ParseSearchData(pStructInf inf, pNodeData node_data) break; } - /** Note: Subclusters not implemented here. **/ + /** Note: Subclusters should probably be parsed here, if they were implemented. **/ } + + /** Did we find the requested source? **/ if (search_data->Source == NULL) { - mssErrorf(1, "Cluster", "Could not find cluster %s for search %s.", source_name, search_data->Name); + /** Print error. **/ + mssErrorf(1, "Cluster", "Could not find cluster \"%s\" for search \"%s\".", source_name, search_data->Name); + + /** Attempt to give a hint. **/ + char* cluster_names[node_data->nClusterDatas]; + for (unsigned int i = 0; i < node_data->nClusterDatas; i++) + cluster_names[i] = node_data->ClusterDatas[i]->Name; + ci_TryHint(source_name, cluster_names, node_data->nClusterDatas); + + /** Fail. **/ goto err_free_search; } @@ -1162,17 +1412,81 @@ static pSearchData ci_ParseSearchData(pStructInf inf, pNodeData node_data) search_data->SimilarityMeasure = ci_ParseSimilarityMeasure(inf, node_data->ParamList); if (search_data->SimilarityMeasure == SIMILARITY_NULL) goto err_free_search; + /** Check for additional data to warn the user about. **/ + for (unsigned int i = 0u; i < inf->nSubInf; i++) + { + pStructInf sub_inf = check_ptr(inf->SubInf[i]); + ASSERTMAGIC(sub_inf, MGK_STRUCTINF); + char* name = sub_inf->Name; + + /** Handle various struct types. **/ + const int struct_type = stStructType(sub_inf); + switch (struct_type) + { + case ST_T_ATTRIB: + { + /** Valid attribute names. **/ + char* attrs[] = { + "source", + "threshold", + "similarity_measure", + }; + const unsigned int nattrs = sizeof(attrs) / sizeof(char*); + + /** Ignore valid attribute names. **/ + bool is_valid = false; + for (unsigned int i = 0u; i < nattrs; i++) + { + if (strcmp(name, attrs[i]) == 0) + { + is_valid = true; + break; + } + } + if (is_valid) continue; /* Next inf. */ + + /** Give the user a warning, and attempt to give them a hint. **/ + fprintf(stderr, "Warning: Unknown attribute '%s' in search \"%s\".\n", name, inf->Name); + ci_TryHint(name, attrs, nattrs); + + break; + } + + case ST_T_SUBGROUP: + { + /** The spec does not specify any valid sub-groups for searches. **/ + char* group_type = check_ptr(sub_inf->UsrType); + if (group_type == NULL) goto err_free_search; + fprintf(stderr, + "Warning: Unknown group \"%s\" : \"%s\" in search \"%s\".\n", + name, group_type, inf->Name + ); + break; + } + + default: + { + mssErrorf(1, "Cluster", + "Warning: Unknown struct type %d in search \"%s\".", + struct_type, inf->Name + ); + goto err_free_search; + } + } + } + /** Create cache entry key. **/ char* source_key = search_data->Source->Key; const size_t len = strlen(source_key) + strlen(search_data->Name) + 16lu; - char* key = nmSysMalloc(len * sizeof(char)); + char* key = check_ptr(nmSysMalloc(len * sizeof(char))); + if (key == NULL) goto err_free_search; snprintf(key, len, "%s/%s?%g&%u", source_key, search_data->Name, search_data->Threshold, search_data->SimilarityMeasure ); - pXHashTable search_cache = &ClusterCaches.SearchCache; + pXHashTable search_cache = &ClusterDriverCaches.SearchDataCache; /** Check for a cached version. **/ pSearchData search_maybe = (pSearchData)xhLookup(search_cache, key); @@ -1182,7 +1496,7 @@ static pSearchData ci_ParseSearchData(pStructInf inf, pNodeData node_data) tprintf("# search: \"%s\"\n", key); tprintf("--> Name: %s\n", search_maybe->Name); /* Cause invalid read if cache was incorrectly freed. */ - /** Free the parsed search that we no longer need. */ + /** Free the parsed search that we no longer need. **/ ci_FreeSearchData(search_data); nmSysFree(key); @@ -1195,8 +1509,11 @@ static pSearchData ci_ParseSearchData(pStructInf inf, pNodeData node_data) check(xhAdd(search_cache, key, (void*)search_data)); return search_data; + /** Error cleanup. **/ err_free_search: ci_FreeSearchData(search_data); + + err: mssErrorf(0, "Cluster", "Failed to parse search from group \"%s\".", inf->Name); return NULL; } @@ -1212,25 +1529,27 @@ static pSearchData ci_ParseSearchData(pStructInf inf, pNodeData node_data) *** *** @param inf A parsed pStructInf for the top level group in a .cluster *** structure file. - *** @param obj The parent object struct. + *** @param parent The parent object struct. *** @returns A new pNodeData struct on success, or NULL on failure. ***/ -static pNodeData ci_ParseNodeData(pStructInf inf, pObject obj) +static pNodeData ci_ParseNodeData(pStructInf inf, pObject parent) { int ret; - - /** Retrieve path so we'll know we have it later. **/ - char* path = ci_file_path(obj); + char* path = check_ptr(ci_file_path(parent)); + if (path == NULL) goto err; /** Allocate node struct data. **/ // pNodeData node_data = NodeData |> sizeof() |> nmMalloc() |> check_ptr(); pNodeData node_data = check_ptr(nmMalloc(sizeof(NodeData))); + if (node_data == NULL) goto err; memset(node_data, 0, sizeof(NodeData)); - node_data->Obj = obj; + node_data->Parent = parent; /** Set up param list. **/ node_data->ParamList = check_ptr(expCreateParamList()); - node_data->ParamList->Session = obj->Session; + if (node_data->ParamList == NULL) goto err; + node_data->ParamList->Session = check_ptr(parent->Session); + if (node_data->ParamList->Session == NULL) goto err; ret = expAddParamToList(node_data->ParamList, "parameters", (void*)node_data, 0); if (ret != 0) { @@ -1254,45 +1573,113 @@ static pNodeData ci_ParseNodeData(pStructInf inf, pObject obj) /** Detect relevant groups. **/ XArray param_infs, cluster_infs, search_infs; - check(xaInit(¶m_infs, 8)); - check(xaInit(&cluster_infs, 8)); - check(xaInit(&search_infs, 8)); + memset(¶m_infs, 0, sizeof(XArray)); + memset(&cluster_infs, 0, sizeof(XArray)); + memset(&search_infs, 0, sizeof(XArray)); + if (!check(xaInit(¶m_infs, 8))) goto err_free_arrs; + if (!check(xaInit(&cluster_infs, 8))) goto err_free_arrs; + if (!check(xaInit(&search_infs, 8))) goto err_free_arrs; for (unsigned int i = 0u; i < inf->nSubInf; i++) { - /** Check that this is a group (not an attribute). **/ - pStructInf group_inf = inf->SubInf[i]; - ASSERTMAGIC(group_inf, MGK_STRUCTINF); - if (stStructType(group_inf) != ST_T_SUBGROUP) continue; - - /** Select array by group type. **/ - const char* group_type = group_inf->UsrType; - if (strcmp(group_type, "cluster/parameter") == 0) check_strict(xaAddItem(¶m_infs, group_inf)); - else if (strcmp(group_type, "cluster/cluster") == 0) check_strict(xaAddItem(&cluster_infs, group_inf)); - else if (strcmp(group_type, "cluster/search") == 0) check_strict(xaAddItem(&search_infs, group_inf)); - else + pStructInf sub_inf = check_ptr(inf->SubInf[i]); + ASSERTMAGIC(sub_inf, MGK_STRUCTINF); + char* name = sub_inf->Name; + + /** Handle various struct types. **/ + const int struct_type = stStructType(sub_inf); + switch (struct_type) { - mssErrorf(1, "Cluster", - "Unkown group type \"%s\" on group \"%s\".", - group_type, group_inf->Name - ); - goto err_free_arrs; + case ST_T_ATTRIB: + { + /** Valid attribute names. **/ + char* attrs[] = { + "source", + "attr_name", + }; + const unsigned int nattrs = sizeof(attrs) / sizeof(char*); + + /** Ignore valid attribute names. **/ + bool is_valid = false; + for (unsigned int i = 0u; i < nattrs; i++) + { + if (strcmp(name, attrs[i]) == 0) + { + is_valid = true; + break; + } + } + if (is_valid) continue; /* Next inf. */ + + /** Give the user a warning, and attempt to give them a hint. **/ + fprintf(stderr, "Warning: Unknown attribute '%s' in cluster node \"%s\".\n", name, inf->Name); + ci_TryHint(name, attrs, nattrs); + + break; + } + + case ST_T_SUBGROUP: + { + /** The spec does not specify any valid sub-groups for searches. **/ + char* group_type = check_ptr(sub_inf->UsrType); + if (group_type == NULL) goto err_free_arrs; + if (strcmp(group_type, "cluster/parameter") == 0) + { + if (!check_neg(xaAddItem(¶m_infs, sub_inf))) + goto err_free_arrs; + } + else if (strcmp(group_type, "cluster/cluster") == 0) + { + if (!check_neg(xaAddItem(&cluster_infs, sub_inf))) + goto err_free_arrs; + } + else if (strcmp(group_type, "cluster/search") == 0) + { + if (!check_neg(xaAddItem(&search_infs, sub_inf))) + goto err_free_arrs; + } + else + { + /** Give the user a warning, and attempt to give them a hint. **/ + fprintf(stderr, + "Warning: Unknown group type \"%s\" on group \"%s\".\n", + group_type, sub_inf->Name + ); + ci_TryHint(group_type, (char*[]){ + "cluster/parameter", + "cluster/cluster", + "cluster/search", + NULL, + }, 0u); + } + break; + } + + default: + { + mssErrorf(1, "Cluster", + "Warning: Unknown struct type %d in search \"%s\".", + struct_type, inf->Name + ); + goto err_free_arrs; + } } } /** Extract OpenCtl for use below. **/ - bool has_provided_params = obj != NULL - && obj->Pathname != NULL - && obj->Pathname->OpenCtl != NULL - && obj->Pathname->OpenCtl[obj->SubPtr - 1] != NULL - && obj->Pathname->OpenCtl[obj->SubPtr - 1]->nSubInf > 0 - && obj->Pathname->OpenCtl[obj->SubPtr - 1]->SubInf != NULL; - int num_provided_params = (has_provided_params) ? obj->Pathname->OpenCtl[obj->SubPtr - 1]->nSubInf : 0; - pStruct* provided_params = (has_provided_params) ? obj->Pathname->OpenCtl[obj->SubPtr - 1]->SubInf : NULL; + bool has_provided_params = parent != NULL + && parent->Pathname != NULL + && parent->Pathname->OpenCtl != NULL + && parent->Pathname->OpenCtl[parent->SubPtr - 1] != NULL + && parent->Pathname->OpenCtl[parent->SubPtr - 1]->nSubInf > 0 + && parent->Pathname->OpenCtl[parent->SubPtr - 1]->SubInf != NULL; + int num_provided_params = (has_provided_params) ? parent->Pathname->OpenCtl[parent->SubPtr - 1]->nSubInf : 0; + pStruct* provided_params = (has_provided_params) ? parent->Pathname->OpenCtl[parent->SubPtr - 1]->SubInf : NULL; /** Itterate over each param in the structure file. **/ node_data->nParams = param_infs.nItems; const size_t params_size = node_data->nParams * sizeof(pParam); node_data->Params = check_ptr(nmMalloc(params_size)); + if (node_data->Params == NULL) goto err_free_arrs; memset(node_data->Params, 0, params_size); for (unsigned int i = 0u; i < node_data->nParams; i++) { @@ -1316,7 +1703,7 @@ static pNodeData ci_ParseNodeData(pStructInf inf, pObject obj) mssErrorf(1, "Cluster", "Provided param struct cannot be NULL."); fprintf(stderr, "Debug info: obj->Pathname->OpenCtl[%d]->SubInf[%u] is NULL", - obj->SubPtr - 1, j + parent->SubPtr - 1, j ); goto err_free_arrs; } @@ -1325,7 +1712,7 @@ static pNodeData ci_ParseNodeData(pStructInf inf, pObject obj) if (strcmp(provided_param->Name, param->Name) != 0) continue; /** Matched! The user is providing a value for this param. **/ - ret = paramSetValueFromInfNe(param, provided_param, 0, node_data->ParamList, obj->Session); + ret = paramSetValueFromInfNe(param, provided_param, 0, node_data->ParamList, node_data->ParamList->Session); if (ret != 0) { mssErrorf(0, "Cluster", @@ -1346,7 +1733,7 @@ static pNodeData ci_ParseNodeData(pStructInf inf, pObject obj) } /** Invoke param hints parsing. **/ - ret = paramEvalHints(param, node_data->ParamList, obj->Session); + ret = paramEvalHints(param, node_data->ParamList, node_data->ParamList->Session); if (ret != 0) { mssErrorf(0, "Cluster", @@ -1355,59 +1742,62 @@ static pNodeData ci_ParseNodeData(pStructInf inf, pObject obj) ); goto err_free_arrs; } - if (strcmp("k", param->Name) == 0) tprintf("Param k is now %d\n", param->Value->Data.Integer); } - check(xaDeInit(¶m_infs)); + check(xaDeInit(¶m_infs)); /* Failure ignored. */ param_infs.nAlloc = 0; /** Parse source data. **/ node_data->SourceData = ci_ParseSourceData(inf, node_data->ParamList, path); - if (node_data->SourceData == NULL) goto err_free_node; + if (node_data->SourceData == NULL) goto err_free_arrs; /** Parse each cluster. **/ - node_data->nClusters = cluster_infs.nItems; - if (node_data->nClusters > 0) + node_data->nClusterDatas = cluster_infs.nItems; + if (node_data->nClusterDatas > 0) { - const size_t clusters_size = node_data->nClusters * sizeof(pClusterData); - node_data->Clusters = check_ptr(nmMalloc(clusters_size)); - memset(node_data->Clusters, 0, clusters_size); - for (unsigned int i = 0u; i < node_data->nClusters; i++) + const size_t clusters_size = node_data->nClusterDatas * sizeof(pClusterData); + node_data->ClusterDatas = check_ptr(nmMalloc(clusters_size)); + if (node_data->ClusterDatas == NULL) goto err_free_arrs; + memset(node_data->ClusterDatas, 0, clusters_size); + for (unsigned int i = 0u; i < node_data->nClusterDatas; i++) { - node_data->Clusters[i] = ci_ParseClusterData(cluster_infs.Items[i], node_data); - if (node_data->Clusters[i] == NULL) goto err_free_arrs; + node_data->ClusterDatas[i] = ci_ParseClusterData(cluster_infs.Items[i], node_data); + if (node_data->ClusterDatas[i] == NULL) goto err_free_arrs; } } - else node_data->Clusters = NULL; - check(xaDeInit(&cluster_infs)); + else node_data->ClusterDatas = NULL; + check(xaDeInit(&cluster_infs)); /* Failure ignored. */ cluster_infs.nAlloc = 0; /** Parse each search. **/ - node_data->nSearches = search_infs.nItems; - if (node_data->nSearches > 0) + node_data->nSearchDatas = search_infs.nItems; + if (node_data->nSearchDatas > 0) { - const size_t searches_size = node_data->nSearches * sizeof(pSearchData); - node_data->Searches = check_ptr(nmMalloc(searches_size)); - memset(node_data->Searches, 0, searches_size); - for (unsigned int i = 0u; i < node_data->nSearches; i++) + const size_t searches_size = node_data->nSearchDatas * sizeof(pSearchData); + node_data->SearchDatas = check_ptr(nmMalloc(searches_size)); + if (node_data->SearchDatas == NULL) goto err_free_arrs; + memset(node_data->SearchDatas, 0, searches_size); + for (unsigned int i = 0u; i < node_data->nSearchDatas; i++) { - node_data->Searches[i] = ci_ParseSearchData(search_infs.Items[i], node_data); - if (node_data->Searches[i] == NULL) goto err_free_node; /* The XArrays are already freed. */ + node_data->SearchDatas[i] = ci_ParseSearchData(search_infs.Items[i], node_data); + if (node_data->SearchDatas[i] == NULL) goto err_free_arrs; } } - else node_data->Searches = NULL; - check(xaDeInit(&search_infs)); + else node_data->SearchDatas = NULL; + check(xaDeInit(&search_infs)); /* Failure ignored. */ search_infs.nAlloc = 0; /** Success. **/ return node_data; err_free_arrs: - if (param_infs.nAlloc != 0) check(xaDeInit(¶m_infs)); - if (cluster_infs.nAlloc != 0) check(xaDeInit(&cluster_infs)); - if (search_infs.nAlloc != 0) check(xaDeInit(&search_infs)); + if (param_infs.nAlloc != 0) check(xaDeInit(¶m_infs)); /* Failure ignored. */ + if (cluster_infs.nAlloc != 0) check(xaDeInit(&cluster_infs)); /* Failure ignored. */ + if (search_infs.nAlloc != 0) check(xaDeInit(&search_infs)); /* Failure ignored. */ err_free_node: ci_FreeNodeData(node_data); + + err: mssErrorf(0, "Cluster", "Failed to parse node from group \"%s\" in file: %s", inf->Name, path); return NULL; } @@ -1426,12 +1816,12 @@ static void ci_FreeSourceData(pSourceData source_data) if (source_data->AttrName != NULL) nmSysFree(source_data->AttrName); /** Free fetched data, if it exists. **/ - if (source_data->Data != NULL) + if (source_data->Strings != NULL) { for (unsigned int i = 0u; i < source_data->nVectors; i++) - nmSysFree(source_data->Data[i]); - nmFree(source_data->Data, source_data->nVectors * sizeof(char*)); - source_data->Data = NULL; + nmSysFree(source_data->Strings[i]); + nmFree(source_data->Strings, source_data->nVectors * sizeof(char*)); + source_data->Strings = NULL; } /** Free computed vectors, if they exist. **/ @@ -1460,11 +1850,19 @@ static void ci_FreeClusterData(pClusterData cluster_data, bool recursive) if (cluster_data->Name != NULL) nmSysFree(cluster_data->Name); /** Free computed data, if it exists. **/ - if (cluster_data->Labels != NULL) + if (cluster_data->Clusters != NULL) { const unsigned int nVectors = cluster_data->SourceData->nVectors; - nmFree(cluster_data->Labels, nVectors * sizeof(unsigned int)); - cluster_data->Labels = NULL; + for (unsigned int i = 0u; i < cluster_data->nClusters; i++) + { + pCluster cluster = &cluster_data->Clusters[i]; + nmFree(cluster->Strings, cluster->Size * sizeof(char*)); + nmFree(cluster->Vectors, cluster->Size * sizeof(pVector)); + } + nmFree(cluster_data->Clusters, nVectors * sizeof(Cluster)); + nmFree(cluster_data->Sims, nVectors * sizeof(double)); + cluster_data->Clusters = NULL; + cluster_data->Sims = NULL; } /** Free subclusters recursively. **/ @@ -1517,23 +1915,23 @@ static void ci_FreeNodeData(pNodeData node_data) if (node_data->ParamList != NULL) expFreeParamList(node_data->ParamList); /** Free parsed clusters, if they exist. **/ - if (node_data->Clusters != NULL) + if (node_data->ClusterDatas != NULL) { /*** This data is cached, so we should NOT free it! *** The caching system is responsible for the memory. ***/ - nmFree(node_data->Clusters, node_data->nClusters * sizeof(pClusterData)); - node_data->Clusters = NULL; + nmFree(node_data->ClusterDatas, node_data->nClusterDatas * sizeof(pClusterData)); + node_data->ClusterDatas = NULL; } /** Free parsed searches, if they exist. **/ - if (node_data->Searches != NULL) + if (node_data->SearchDatas != NULL) { /*** This data is cached, so we should NOT free it! *** The caching system is responsible for the memory. ***/ - nmFree(node_data->Searches, node_data->nSearches * sizeof(pSearchData)); - node_data->Searches = NULL; + nmFree(node_data->SearchDatas, node_data->nSearchDatas * sizeof(pSearchData)); + node_data->SearchDatas = NULL; } /** Free data source, if one exists. **/ @@ -1554,6 +1952,18 @@ static void ci_FreeNodeData(pNodeData node_data) nmFree(node_data, sizeof(NodeData)); } +/** Frees all caches for all cluster driver instances. **/ +static void ci_FreeCaches(void) + { + /*** Free caches in reverse of the order they are created in case + *** cached data relies on its source during the freeing process. + ***/ + check(xhClearKeySafe(&ClusterDriverCaches.SearchDataCache, ci_CacheFreeSearch, NULL)); /* Failure ignored. */ + check(xhClearKeySafe(&ClusterDriverCaches.ClusterDataCache, ci_CacheFreeCluster, NULL)); /* Failure ignored. */ + check(xhClearKeySafe(&ClusterDriverCaches.SourceDataCache, ci_CacheFreeSourceData, NULL)); /* Failure ignored. */ + } + + /** ================ Deep Size Computation Functions ================ **/ /** ANCHOR[id=sizing] **/ // LINK #functions @@ -1574,10 +1984,10 @@ static unsigned int ci_SizeOfSourceData(pSourceData source_data) if (source_data->Name != NULL) size += strlen(source_data->Name) * sizeof(char); if (source_data->SourcePath != NULL) size += strlen(source_data->SourcePath) * sizeof(char); if (source_data->AttrName != NULL) size += strlen(source_data->AttrName) * sizeof(char); - if (source_data->Data != NULL) + if (source_data->Strings != NULL) { for (unsigned int i = 0u; i < source_data->nVectors; i++) - size += strlen(source_data->Data[i]) * sizeof(char); + size += strlen(source_data->Strings[i]) * sizeof(char); size += source_data->nVectors * sizeof(char*); } if (source_data->Vectors != NULL) @@ -1607,7 +2017,18 @@ static unsigned int ci_SizeOfClusterData(pClusterData cluster_data, bool recursi { unsigned int size = 0u; if (cluster_data->Name != NULL) size += strlen(cluster_data->Name) * sizeof(char); - if (cluster_data->Labels != NULL) size += cluster_data->SourceData->nVectors * sizeof(unsigned int); + if (cluster_data->Clusters != NULL) + { + const unsigned int nVectors = cluster_data->SourceData->nVectors; + for (unsigned int i = 0u; i < cluster_data->nClusters; i++) + { + const unsigned int cluster_size = cluster_data->Clusters[i].Size; + size += cluster_size * sizeof(char*); + size += cluster_size * sizeof(pVector); + } + size += nVectors * sizeof(Cluster); + size += nVectors * sizeof(double); + } if (cluster_data->SubClusters != NULL) { if (recursive) @@ -1663,43 +2084,13 @@ static int ci_ComputeSourceData(pSourceData source_data, pObjSession session) /** If the vectors are already computed, we're done. **/ if (source_data->Vectors != NULL) return 0; - /** Handle error case that happens if memory optimizations break. **/ - if (source_data->Data != NULL) - { - /*** We have data, but not vectors, which means that this function ran - *** before, but the vectors were cleared by ci_GCSourceData(). This - *** should only happen if the vectors will not be needed again. Thus, - *** clearly something has gone wrong. - ***/ - fprintf(stderr, "ERROR:" - "\tci_computeSourceData() invoked on source data \"%s\" where\n" - "\tvectors were previously freed. There is likely a bug in\n" - "\tci_GCSourceData() which caused it to free vectors when we\n" - "\tstill needed them.\n", - source_data->Name - ); - fprintf(stderr, "Resolution:\n" - "\tThe original data will be dropped and refetched, and the\n" - "\tthe vectors will be recomputed, avoiding possible issues\n" - "\tfrom stale data.\n" - ); - - /** Drop source_data->Data. **/ - for (unsigned int i = 0u; i < source_data->nVectors; i++) - nmSysFree(source_data->Data[i]); - nmFree(source_data->Data, source_data->nVectors * sizeof(char*)); - source_data->Data = NULL; - source_data->nVectors = 0; - } - - /** Record the date and time. **/ - /** Even if this computation fails, we may want this information. **/ - check(objCurrentDate(&source_data->DateComputed)); - /** Time to play shoots-and-ladders in an error-handling jungle of gotos. **/ bool successful = false; int ret; + /** Record the date and time. **/ + if (!check(objCurrentDate(&source_data->DateComputed))) goto end; + /** Open the source path specified by the .cluster file. **/ tprintf("Openning...\n"); pObject obj = objOpen(session, source_data->SourcePath, OBJ_O_RDONLY, 0600, "system/directory"); @@ -1712,7 +2103,6 @@ static int ci_ComputeSourceData(pSourceData source_data, pObjSession session) source_data->AttrName, source_data->SourcePath ); - successful = false; goto end; } @@ -1730,14 +2120,15 @@ static int ci_ComputeSourceData(pSourceData source_data, pObjSession session) obj->Driver->Name, source_data->SourcePath ); - successful = false; goto end_close; } /** Initialize an xarray to store the retrieved data. **/ XArray data_xarray, vector_xarray; - check(xaInit(&data_xarray, 64)); - check(xaInit(&vector_xarray, 64)); + memset(&data_xarray, 0, sizeof(XArray)); + memset(&vector_xarray, 0, sizeof(XArray)); + if (!check(xaInit(&data_xarray, 64))) goto end_close_query; + if (!check(xaInit(&vector_xarray, 64))) goto end_free_data; /** Fetch data and build vectors. **/ tprintf("Skips: "); @@ -1804,7 +2195,7 @@ static int ci_ComputeSourceData(pSourceData source_data, pObjSession session) if (strlen(val) == 0) { tprintf("_"); - check(fflush(stdout)); + check(fflush(stdout)); /* Failure ignored. */ continue; } @@ -1826,34 +2217,41 @@ static int ci_ComputeSourceData(pSourceData source_data, pObjSession session) { /** Skip pVector with no pairs. **/ tprintf("."); - check(fflush(stdout)); + check(fflush(stdout)); /* Failure ignored. */ ca_free_vector(vector); continue; } /** Store value. **/ char* dup_val = check_ptr(nmSysStrdup(val)); - check_strict(xaAddItem(&data_xarray, (void*)dup_val)); - check_strict(xaAddItem(&vector_xarray, (void*)vector)); + if (dup_val == NULL) goto end_free_data; + if (!check_neg(xaAddItem(&data_xarray, (void*)dup_val))) goto end_free_data; + if (!check_neg(xaAddItem(&vector_xarray, (void*)vector))) goto end_free_data; /** Clean up. **/ - check(objClose(entry)); + ret = objClose(entry); + if (ret != 0) + { + mssErrorf(0, "Cluster", "Failed to close object entry (error code %d).", ret); + // ret = ret; // Fall-through: Failure ignored. + } } tprintf("\nData aquired.\n"); source_data->nVectors = vector_xarray.nItems; /** Trim data and store data. **/ const size_t data_size = source_data->nVectors * sizeof(char*); - source_data->Data = check_ptr(nmMalloc(data_size)); - memcpy(source_data->Data, data_xarray.Items, data_size); - check(xaDeInit(&data_xarray)); + source_data->Strings = check_ptr(nmMalloc(data_size)); + if (source_data->Strings == NULL) goto end_free_data; + memcpy(source_data->Strings, data_xarray.Items, data_size); + check(xaDeInit(&data_xarray)); /* Failure ignored. */ data_xarray.nAlloc = 0; /** Trim data and store vectors. **/ const size_t vectors_size = source_data->nVectors * sizeof(pVector); source_data->Vectors = check_ptr(nmMalloc(vectors_size)); memcpy(source_data->Vectors, vector_xarray.Items, vectors_size); - check(xaDeInit(&vector_xarray)); + check(xaDeInit(&vector_xarray)); /* Failure ignored. */ vector_xarray.nAlloc = 0; /** Success. **/ @@ -1864,21 +2262,21 @@ static int ci_ComputeSourceData(pSourceData source_data, pObjSession session) { for (unsigned int i = 0u; i < data_xarray.nItems; i++) nmSysFree(data_xarray.Items[i]); - check(xaDeInit(&data_xarray)); + check(xaDeInit(&data_xarray)); /* Failure ignored. */ } if (vector_xarray.nAlloc != 0) { for (unsigned int i = 0u; i < vector_xarray.nItems; i++) ca_free_vector(vector_xarray.Items[i]); - check(xaDeInit(&vector_xarray)); + check(xaDeInit(&vector_xarray)); /* Failure ignored. */ } - // end_close_query: + end_close_query: ret = objQueryClose(query); if (ret != 0) { mssErrorf(0, "Cluster", "Failed to close query (error code %d).", ret); - // ret = ret; // Fall-through: Continue through failure. + // ret = ret; // Fall-through: Failure ignored. } end_close: @@ -1886,11 +2284,11 @@ static int ci_ComputeSourceData(pSourceData source_data, pObjSession session) if (ret != 0) { mssErrorf(0, "Cluster", "Failed to close object driver (error code %d).", ret); - // ret = ret; // Fall-through: Continue through failure. + // ret = ret; // Fall-through: Failure ignored. } end: - if (!successful) mssErrorf(0, "Cluster", "Vector computation failed."); + if (!successful) mssErrorf(0, "Cluster", "SourceData computation failed."); return (successful) ? 0 : -1; } @@ -1910,36 +2308,58 @@ static int ci_ComputeSourceData(pSourceData source_data, pObjSession session) static int ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data) { /** If the clusters are alreadyd computed, we're done. **/ - if (cluster_data->Labels != NULL) return 0; + if (cluster_data->Clusters != NULL) return 0; /** Make source data available. **/ pSourceData source_data = node_data->SourceData; - /** We need the vectors to compute clusters. **/ + /** We need the SourceData vectors to compute clusters. **/ if (ci_ComputeSourceData(source_data, node_data->ParamList->Session) != 0) { - mssErrorf(0, "Cluster", "Vectors not found."); + mssErrorf(0, "Cluster", "Failed to compute SourceData."); goto err; } /** Record the date and time. **/ - /** Even if this computation fails, we may want this information. **/ - check(objCurrentDate(&cluster_data->DateComputed)); + if (!check(objCurrentDate(&cluster_data->DateComputed))) goto err; /** Allocate static memory for finding clusters. **/ - const size_t labels_size = source_data->nVectors * sizeof(unsigned int); - cluster_data->Labels = check_ptr(nmMalloc(labels_size)); + const size_t clusters_size = cluster_data->nClusters * sizeof(Cluster); + cluster_data->Clusters = check_ptr(nmMalloc(clusters_size)); + if (cluster_data->Clusters == NULL) goto err; + memset(cluster_data->Clusters, 0, clusters_size); + const size_t sims_size = source_data->nVectors * sizeof(double); + cluster_data->Sims = check_ptr(nmMalloc(sims_size)); + if (cluster_data->Sims == NULL) goto err_free_clusters; + memset(cluster_data->Sims, 0, sims_size); /** Execute clustering. **/ switch (cluster_data->ClusterAlgorithm) { case ALGORITHM_NONE: - case ALGORITHM_SLIDING_WINDOW: /* Clusters are not computed separately for performance reasons. */ + { tprintf("Applying no clustering...\n"); - memset(cluster_data->Labels, 0u, labels_size); + /** Put all the data into one cluster. **/ + pCluster first_cluster = &cluster_data->Clusters[0]; + first_cluster->Size = source_data->nVectors; + first_cluster->Strings = check_ptr(nmMalloc(source_data->nVectors * sizeof(char*))); + if (first_cluster->Strings == NULL) goto err_free_sims; + first_cluster->Vectors = check_ptr(nmMalloc(source_data->nVectors * sizeof(pVector))); + if (first_cluster->Vectors == NULL) goto err_free_sims; + memcpy(first_cluster->Strings, source_data->Strings, source_data->nVectors * sizeof(char*)); + memcpy(first_cluster->Vectors, source_data->Vectors, source_data->nVectors * sizeof(pVector)); + break; + } + + case ALGORITHM_SLIDING_WINDOW: + /** Computed in each search for efficiency. **/ + tprintf("Skipping sliding window clustering...\n"); + memset(cluster_data->Clusters, 0, clusters_size); break; case ALGORITHM_KMEANS: + { + tprintf("Applying kmeans clustering...\n"); /** Check for unimplemented similarity measures. **/ if (cluster_data->SimilarityMeasure != SIMILARITY_COSINE) { @@ -1947,25 +2367,64 @@ static int ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data) "The similarity meausre \"%s\" is not implemented.", ci_SimilarityMeasureToString(cluster_data->SimilarityMeasure) ); - goto err; + goto err_free_sims; } - /** kmeans expects clusters to be initialized. **/ - memset(cluster_data->Labels, 0u, labels_size); + /** Allocate lables. Note: kmeans does not require us to initialize them. **/ + const size_t lables_size = source_data->nVectors * sizeof(unsigned int); + unsigned int* labels = check_ptr(nmMalloc(lables_size)); + if (labels == NULL) goto err_free_sims; + /** Run kmeans. **/ tprintf("Running kmeans\n"); Timer timer_i, *timer = timer_start(timer_init(&timer_i)); - ca_kmeans( + const bool successful = check(ca_kmeans( source_data->Vectors, source_data->nVectors, - cluster_data->Labels, - cluster_data->NumClusters, + cluster_data->nClusters, cluster_data->MaxIterations, - cluster_data->MinImprovement - ); + cluster_data->MinImprovement, + labels, + cluster_data->Sims + )); timer_stop(timer); - tprintf("Done after %.4lf.\n", timer_get(timer)); + tprintf("Clustering done after %.4lf.\n", timer_get(timer)); + if (!successful) goto err_free_sims; + + /** Convert the labels into clusters. **/ + + /** Allocate space for clusters. **/ + XArray indexes_in_cluster[cluster_data->nClusters]; + for (unsigned int i = 0u; i < cluster_data->nClusters; i++) + if (!check(xaInit(&indexes_in_cluster[i], 8))) goto err_free_sims; + + /** Iterate through each label and add the index of the specified cluster to the xArray. **/ + for (unsigned long long i = 0llu; i < source_data->nVectors; i++) + if (!check_neg(xaAddItem(&indexes_in_cluster[labels[i]], (void*)i))) goto err_free_sims; + nmFree(labels, lables_size); /* Free unused data. */ + + /** Iterate through each cluster, store it, and free the xArray. **/ + for (unsigned int i = 0u; i < cluster_data->nClusters; i++) + { + pXArray indexes_in_this_cluster = &indexes_in_cluster[i]; + pCluster cluster = &cluster_data->Clusters[i]; + cluster->Size = indexes_in_this_cluster->nItems; + cluster->Strings = check_ptr(nmMalloc(cluster->Size * sizeof(char*))); + if (cluster->Strings == NULL) goto err_free_sims; + cluster->Vectors = check_ptr(nmMalloc(cluster->Size * sizeof(pVector))); + if (cluster->Vectors == NULL) goto err_free_sims; + for (unsigned int j = 0u; j < cluster->Size; j++) + { + const unsigned long long index = (unsigned long long)indexes_in_this_cluster->Items[j]; + cluster->Strings[j] = source_data->Strings[index]; + cluster->Vectors[j] = source_data->Vectors[index]; + } + check(xaDeInit(indexes_in_this_cluster)); /* Failure ignored. */ + } + + /** k-means is done. **/ break; + } default: mssErrorf(1, "Cluster", @@ -1975,9 +2434,26 @@ static int ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data) goto err; } + /** Success. **/ tprintf("Clustering done.\n"); return 0; + err_free_sims: + nmFree(cluster_data->Sims, sims_size); + cluster_data->Sims = NULL; + + err_free_clusters: + for (unsigned int i = 0u; i < cluster_data->nClusters; i++) + { + pCluster cluster = &cluster_data->Clusters[i]; + if (cluster->Strings != NULL) nmFree(cluster->Strings, cluster->Size * sizeof(char*)); + else break; + if (cluster->Vectors != NULL) nmFree(cluster->Vectors, cluster->Size * sizeof(pVector)); + else break; + } + nmFree(cluster_data->Clusters, clusters_size); + cluster_data->Clusters = NULL; + err: mssErrorf(0, "Cluster", "Cluster computation failed for \"%s\".", cluster_data->Name); return -1; @@ -2003,11 +2479,8 @@ static int ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) /** If the clusters are already computed, we're done. **/ if (search_data->Dups != NULL) return 0; - /** Extract structs. **/ + /** We need the cluster data to be computed before we search it. **/ pClusterData cluster_data = search_data->Source; - pSourceData source_data = node_data->SourceData; - - /** We need the clusters to be able to search them. **/ ret = ci_ComputeClusterData(cluster_data, node_data); if (ret != 0) { @@ -2026,35 +2499,112 @@ static int ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) } /** Record the date and time. **/ - /** Even if this computation fails, we may want this information. **/ - check(objCurrentDate(&search_data->DateComputed)); + if (!check(objCurrentDate(&search_data->DateComputed))) goto err; - /** Execute the search. **/ - tprintf("Invoking ca_search.\n"); + tprintf("Invoking search.\n"); Timer timer_i, *timer = timer_start(timer_init(&timer_i)); - pXArray dups_temp = ca_search( - source_data->Vectors, - source_data->nVectors, - cluster_data->Labels, - search_data->Threshold - ); + /** Execute the search using the specified source and comparison function. **/ + pXArray dups = NULL, dups_temp = NULL; + switch (search_data->SimilarityMeasure) + { + case SIMILARITY_COSINE: + { + if (cluster_data->ClusterAlgorithm == ALGORITHM_SLIDING_WINDOW) + { + dups_temp = check_ptr(ca_sliding_search( + (void**)cluster_data->SourceData->Vectors, + cluster_data->SourceData->nVectors, + cluster_data->MaxIterations, /* Window size. */ + ca_cos_compare, + search_data->Threshold, + dups + )); + } + else + { + for (unsigned int i = 0u; i < cluster_data->nClusters; i++) + { + dups_temp = check_ptr(ca_complete_search( + (void**)cluster_data->Clusters[i].Vectors, + cluster_data->Clusters[i].Size, + ca_cos_compare, + search_data->Threshold, + dups + )); + if (dups_temp == NULL) goto err; + else dups = dups_temp; + } + } + break; + } + + case SIMILARITY_LEVENSHTEIN: + { + if (cluster_data->ClusterAlgorithm == ALGORITHM_SLIDING_WINDOW) + { + dups_temp = check_ptr(ca_sliding_search( + (void**)cluster_data->SourceData->Vectors, + cluster_data->SourceData->nVectors, + cluster_data->MaxIterations, /* Window size. */ + ca_lev_compare, + search_data->Threshold, + dups + )); + } + else + { + for (unsigned int i = 0u; i < cluster_data->nClusters; i++) + { + dups_temp = check_ptr(ca_complete_search( + (void**)cluster_data->Clusters[i].Strings, + cluster_data->Clusters[i].Size, + ca_lev_compare, + search_data->Threshold, + dups + )); + if (dups_temp == NULL) goto err; + else dups = dups_temp; + } + } + break; + } + + default: + mssErrorf(1, "Cluster", + "Unknown similarity meansure \"%s\".", + ci_SimilarityMeasureToString(search_data->SimilarityMeasure) + ); + goto err; + } timer_stop(timer); if (dups_temp == NULL) goto err; - tprintf("ca_search done after %.4lf.\n", timer_get(timer)); + else dups = dups_temp; + tprintf("Search done after %.4lf.\n", timer_get(timer)); /** Store dups. **/ - search_data->nDups = dups_temp->nItems; - search_data->Dups = (dups_temp->nItems == 0) + search_data->nDups = dups->nItems; + search_data->Dups = (dups->nItems == 0) ? check_ptr(nmMalloc(0)) - : ci_xaToTrimmedArray(dups_temp); + : ci_xaToTrimmedArray(dups); /** Free unused data. **/ tprintf("Cleanup.\n"); - check(xaFree(dups_temp)); + check(xaFree(dups)); /* Failure ignored. */ + /** Success. **/ return 0; err: + if (dups != NULL) + { + for (unsigned int i = 0u; i < dups->nItems; i++) + { + if (dups->Items[i] != NULL) nmFree(dups->Items[i], sizeof(Dup)); + else break; + } + check(xaFree(dups)); /* Failure ignored. */ + } + mssErrorf(0, "Cluster", "Search computation failed for \"%s\".", search_data->Name); return -1; } @@ -2126,9 +2676,7 @@ static int ci_GetParamValue(void* inf_v, char* attr_name, int datatype, pObjData { pParam param = (pParam)node_data->Params[i]; if (strcmp(param->Name, attr_name) != 0) continue; - - tprintf("Param found: Parsing...\n"); - + /** Parameter found. **/ if (param->Value == NULL) return 1; if (param->Value->Flags & DATA_TF_NULL) return 1; @@ -2138,14 +2686,16 @@ static int ci_GetParamValue(void* inf_v, char* attr_name, int datatype, pObjData return -1; } - tprintf("Param found: Copying...\n"); /** Return param value. **/ - objCopyData(&(param->Value->Data), val, datatype); + if (!check(objCopyData(&(param->Value->Data), val, datatype))) goto err; return 0; } - /** Param not found. **/ - tprintf("Param not found.\n"); + err: + mssErrorf(1, "Cluster", + "Failed to get parameter %s : %s", + attr_name, ci_TypeToStr(datatype) + ); return -1; } @@ -2164,10 +2714,10 @@ static int ci_SetParamValue(void* inf_v, char* attr_name, int datatype, pObjData // LINK #functions /*** Opens a new cluster driver instance by parsing a `.cluster` file found - *** at the path provided in obj. + *** at the path provided in parent. *** - *** @param obj The object being opened, including the path, session, and - *** other necessary information. + *** @param parent The parent of the object to be openned, including useful + *** information such as the pathname, session, etc. *** @param mask Driver permission mask (unused). *** @param sys_type ? (unused) *** @param usr_type The object system file type being openned. Should always @@ -2178,30 +2728,30 @@ static int ci_SetParamValue(void* inf_v, char* attr_name, int datatype, pObjData *** @returns A pDriverData struct representing a driver instance, or *** NULL if an error occures. ***/ -void* clusterOpen(pObject obj, int mask, pContentType sys_type, char* usr_type, pObjTrxTree* oxt) +void* clusterOpen(pObject parent, int mask, pContentType sys_type, char* usr_type, pObjTrxTree* oxt) { - tprintf("Warning: clusterOpen(\"%s\") is under active development.\n", ci_file_name(obj)); + tprintf("Warning: clusterOpen(\"%s\") is under active development.\n", ci_file_name(parent)); - /** If CREAT and EXCL are specified, create it and fail if it already exists. **/ + /** If CREAT and EXCL are specified, exclusively create it, failing if the file already exists. **/ pSnNode node_struct = NULL; - bool can_create = (obj->Mode & O_CREAT) && (obj->SubPtr == obj->Pathname->nElements); - if (can_create && (obj->Mode & O_EXCL)) + bool can_create = (parent->Mode & O_CREAT) && (parent->SubPtr == parent->Pathname->nElements); + if (can_create && (parent->Mode & O_EXCL)) { - node_struct = snNewNode(obj->Prev, usr_type); + node_struct = snNewNode(parent->Prev, usr_type); if (node_struct == NULL) { - mssErrorf(0, "Cluster", "Failed to EXCL create new node struct."); + mssErrorf(0, "Cluster", "Failed to exclusively create new node struct."); goto err; } } /** Read the node if it exists. **/ if (node_struct == NULL) - node_struct = snReadNode(obj->Prev); + node_struct = snReadNode(parent->Prev); - /** If we can't read, create it (if allowed). **/ + /** If we can't read it, create it (if allowed). **/ if (node_struct == NULL && can_create) - node_struct = snNewNode(obj->Prev, usr_type); + node_struct = snNewNode(parent->Prev, usr_type); /** If there still isn't a node, fail early. **/ if (node_struct == NULL) @@ -2210,37 +2760,40 @@ void* clusterOpen(pObject obj, int mask, pContentType sys_type, char* usr_type, goto err; } - /** Parse node data. **/ - pNodeData node_data = ci_ParseNodeData(node_struct->Data, obj); + /** Magic. **/ + ASSERTMAGIC(node_struct, MGK_STNODE); + ASSERTMAGIC(node_struct->Data, MGK_STRUCTINF); + + /** Parse node data from the node_struct. **/ + pNodeData node_data = ci_ParseNodeData(node_struct->Data, parent); if (node_data == NULL) { - mssErrorf(0, "Cluster", "Failed to parse structure file \"%s\".", ci_file_name(obj)); + mssErrorf(0, "Cluster", "Failed to parse structure file \"%s\".", ci_file_name(parent)); goto err; } - node_data->Node = node_struct; - node_data->Node->OpenCnt++; /** Allocate driver instance data. **/ pDriverData driver_data = check_ptr(nmMalloc(sizeof(DriverData))); + if (driver_data == NULL) goto err_free_node; memset(driver_data, 0, sizeof(DriverData)); driver_data->NodeData = node_data; /** Detect target from path. **/ - tprintf("Parsing node path: %d %d\n", obj->SubPtr, obj->SubCnt); obj->SubCnt = 0; - char* target_name = obj_internal_PathPart(obj->Pathname, obj->SubPtr + obj->SubCnt++, 1); + tprintf("Parsing node path: %d %d\n", parent->SubPtr, parent->SubCnt); parent->SubCnt = 0; + char* target_name = obj_internal_PathPart(parent->Pathname, parent->SubPtr + parent->SubCnt++, 1); if (target_name == NULL) { /** Target found: Root **/ tprintf("Found target: Root.\n"); driver_data->TargetType = TARGET_ROOT; driver_data->TargetData = (void*)driver_data->NodeData->SourceData; - return (void*)driver_data; /* Sucess. */ + return (void*)driver_data; /* Success. */ } /** Search clusters. **/ - for (unsigned int i = 0u; i < node_data->nClusters; i++) + for (unsigned int i = 0u; i < node_data->nClusterDatas; i++) { - pClusterData cluster = node_data->Clusters[i]; + pClusterData cluster = node_data->ClusterDatas[i]; if (strcmp(cluster->Name, target_name) != 0) continue; /** Target found: Cluster **/ @@ -2251,7 +2804,7 @@ void* clusterOpen(pObject obj, int mask, pContentType sys_type, char* usr_type, while (true) { /** Decend one path part deeper into the path. **/ - const char* path_part = obj_internal_PathPart(obj->Pathname, obj->SubPtr + obj->SubCnt++, 1); + const char* path_part = obj_internal_PathPart(parent->Pathname, parent->SubPtr + parent->SubCnt++, 1); /** If the path does not go any deeper, we're done. **/ if (path_part == NULL) @@ -2278,13 +2831,13 @@ void* clusterOpen(pObject obj, int mask, pContentType sys_type, char* usr_type, continue_descent:; } - return (void*)driver_data; /* Sucess. */ + return (void*)driver_data; /* Success. */ } /** Search searches. **/ - for (unsigned int i = 0u; i < node_data->nSearches; i++) + for (unsigned int i = 0u; i < node_data->nSearchDatas; i++) { - pSearchData search = node_data->Searches[i]; + pSearchData search = node_data->SearchDatas[i]; if (strcmp(search->Name, target_name) != 0) continue; /** Target found: Search **/ @@ -2292,25 +2845,40 @@ void* clusterOpen(pObject obj, int mask, pContentType sys_type, char* usr_type, driver_data->TargetData = (void*)search; /** Check for extra, invalid path parts. **/ - char* extra_data = obj_internal_PathPart(obj->Pathname, obj->SubPtr + obj->SubCnt++, 1); + char* extra_data = obj_internal_PathPart(parent->Pathname, parent->SubPtr + parent->SubCnt++, 1); if (extra_data != NULL) { mssErrorf(1, "Cluster", "Unknown path part %s.", extra_data); goto err_free_node; } - tprintf("Found target search: %s %d %d\n", search->Name, obj->SubPtr, obj->SubCnt); - return (void*)driver_data; /* Sucess. */ + tprintf("Found target search: %s %d %d\n", search->Name, parent->SubPtr, parent->SubCnt); + return (void*)driver_data; /* Success. */ } /** We were unable to find the requested cluster or search. **/ - mssErrorf(1, "Cluster", "\"%s\" is not the name of a declaired cluster or search.", target_name); + mssErrorf(1, "Cluster", "\"%s\" is not the name of a declared cluster or search.", target_name); + + /** Attempt to give a hint. **/ + { + const unsigned int n_targets = node_data->nClusterDatas + node_data->nSearchDatas; + char* target_names[n_targets]; + for (unsigned int i = 0u; i < node_data->nClusterDatas; i++) + target_names[i] = node_data->ClusterDatas[i]->Name; + for (unsigned int i = 0u; i < node_data->nSearchDatas; i++) + target_names[i + node_data->nClusterDatas] = node_data->SearchDatas[i]->Name; + ci_TryHint(target_name, target_names, n_targets); + } /** Error cleanup. **/ err_free_node: - ci_FreeNodeData(node_data); - nmFree(driver_data, sizeof(DriverData)); + if (node_data != NULL) ci_FreeNodeData(node_data); + if (driver_data != NULL) nmFree(driver_data, sizeof(DriverData)); err: + mssErrorf(0, "Cluster", + "Failed to open cluster file \"%s\" at: %s", + ci_file_name(parent), ci_file_path(parent) + ); return NULL; } @@ -2362,6 +2930,7 @@ void* clusterOpenQuery(void* inf_v, pObjQuery query, pObjTrxTree* oxt) { tprintf("Warning: clusterOpenQuery() is under active development.\n"); pClusterQuery cluster_query = check_ptr(nmMalloc(sizeof(ClusterQuery))); + if (cluster_query == NULL) return NULL; cluster_query->DriverData = (pDriverData)inf_v; cluster_query->RowIndex = 0u; return cluster_query; @@ -2404,9 +2973,9 @@ void* clusterQueryFetch(void* qy_v, pObject obj, int mode, pObjTrxTree* oxt) if (ret != 0) { mssErrorf(0, "Cluster", "Internal cluster computation failed."); - return NULL; + return NULL; } - data_amount = cluster_query->DriverData->NodeData->SourceData->nVectors; + data_amount = target->nClusters; break; } @@ -2418,7 +2987,7 @@ void* clusterQueryFetch(void* qy_v, pObject obj, int mode, pObjTrxTree* oxt) if (ret != 0) { mssErrorf(0, "Cluster", "Internal search computation failed."); - return NULL; + return NULL; } data_amount = target->nDups; break; @@ -2442,12 +3011,13 @@ void* clusterQueryFetch(void* qy_v, pObject obj, int mode, pObjTrxTree* oxt) if (cluster_query->RowIndex >= data_amount) return NULL; /** Create the result struct. **/ - pDriverData driver_data = nmMalloc(sizeof(DriverData)); - assert(driver_data != NULL); + pDriverData driver_data = check_ptr(nmMalloc(sizeof(DriverData))); + if (driver_data == NULL) return NULL; memcpy(driver_data, cluster_query->DriverData, sizeof(DriverData)); driver_data->TargetType = new_target_type; driver_data->TargetIndex = cluster_query->RowIndex++; + /** Success. **/ return driver_data; } @@ -2531,9 +3101,7 @@ int clusterGetAttrType(void* inf_v, char* attr_name, pObjTrxTree* oxt) if (strcmp(attr_name, "num_clusters") == 0 || strcmp(attr_name, "max_iterations") == 0) return DATA_T_INTEGER; - if (strcmp(attr_name, "min_improvement") == 0 - || strcmp(attr_name, "average_similarity") == 0 - || strcmp(attr_name, "size") == 0) + if (strcmp(attr_name, "min_improvement") == 0) return DATA_T_DOUBLE; break; @@ -2546,12 +3114,8 @@ int clusterGetAttrType(void* inf_v, char* attr_name, pObjTrxTree* oxt) break; case TARGET_CLUSTER_ENTRY: - if (strcmp(attr_name, "id") == 0) - return DATA_T_INTEGER; - if (strcmp(attr_name, "val") == 0) - return DATA_T_STRING; - if (strcmp(attr_name, "sim") == 0) - return DATA_T_DOUBLE; + if (strcmp(attr_name, "items") == 0) + return DATA_T_STRINGVEC; break; case TARGET_SEARCH_ENTRY: @@ -2604,9 +3168,9 @@ int clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val return DATA_T_UNAVAILABLE; } - /** Performance shortcut for frequently requested attributes: val, val1, val2, and sim. **/ + /** Performance shortcut for frequently requested attributes: val1, val2, and sim. **/ if ( - (attr_name[0] == 'v' && datatype == DATA_T_STRING) /* val, val1, val2 : String */ + (attr_name[0] == 'v' && datatype == DATA_T_STRING) /* val1, val2 : String */ || (attr_name[0] == 's' && datatype == DATA_T_DOUBLE) /* sim : double */ ) goto handle_targets; @@ -2771,15 +3335,15 @@ int clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val } if (strcmp(attr_name, "num_clusters") == 0) { - if (target->NumClusters > INT_MAX) - fprintf(stderr, "Warning: num_clusters value of %u exceeds INT_MAX (%d).\n", target->NumClusters, INT_MAX); - val->Integer = (int)target->NumClusters; + if (target->nClusters > INT_MAX) + fprintf(stderr, "Warning: 'num_clusters' value of %u exceeds INT_MAX (%d).\n", target->nClusters, INT_MAX); + val->Integer = (int)target->nClusters; return 0; } if (strcmp(attr_name, "max_iterations") == 0) { if (target->MaxIterations > INT_MAX) - fprintf(stderr, "Warning: max_iterations value of %u exceeds INT_MAX (%d).\n", target->MaxIterations, INT_MAX); + fprintf(stderr, "Warning: 'max_iterations' value of %u exceeds INT_MAX (%d).\n", target->MaxIterations, INT_MAX); val->Integer = (int)target->MaxIterations; return 0; } @@ -2788,12 +3352,6 @@ int clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val val->Double = target->MinImprovement; return 0; } - if (strcmp(attr_name, "average_similarity") == 0 - || strcmp(attr_name, "size") == 0) - { - mssErrorf(1, "Cluster", "average_similarity is not implemented."); - return -1; - } break; } @@ -2822,21 +3380,22 @@ int clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val { pClusterData target = (pClusterData)driver_data->TargetData; - if (strcmp(attr_name, "id") == 0) - { - val->Integer = (int)target->Labels[driver_data->TargetIndex]; - return 0; - } - if (strcmp(attr_name, "val") == 0) + if (strcmp(attr_name, "items") == 0) { - val->String = driver_data->NodeData->SourceData->Data[driver_data->TargetIndex]; + /** Static variable to prevent leaking StringVec from previous calls. **/ + static StringVec* vec = NULL; + if (vec != NULL) nmFree(vec, sizeof(StringVec)); + + /** Allocate and initiallize the requested data. **/ + pCluster target_cluster = &target->Clusters[driver_data->TargetIndex]; + val->StringVec = vec = check_ptr(nmMalloc(sizeof(StringVec))); + if (val->StringVec == NULL) return -1; + val->StringVec->nStrings = target_cluster->Size; + val->StringVec->Strings = target_cluster->Strings; + + /** Success. **/ return 0; } - if (strcmp(attr_name, "sim") == 0) - { - mssErrorf(1, "Cluster", "Cluster entry similarity is not supported."); - return -1; - } break; } @@ -2847,23 +3406,29 @@ int clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val if (strcmp(attr_name, "id1") == 0) { - val->Integer = (int)target_dup->id1; + unsigned int value = target_dup->id1; + if (value > INT_MAX) + fprintf(stderr, "Warning: id1 value of %u exceeds INT_MAX (%d).\n", value, INT_MAX); + val->Integer = (int)value; return 0; } if (strcmp(attr_name, "id2") == 0) { - val->Integer = (int)target_dup->id2; + unsigned int value = target_dup->id2; + if (value > INT_MAX) + fprintf(stderr, "Warning: id2 value of %u exceeds INT_MAX (%d).\n", value, INT_MAX); + val->Integer = (int)value; return 0; } if (strcmp(attr_name, "val1") == 0) { - val->String = driver_data->NodeData->SourceData->Data[target_dup->id1]; + val->String = driver_data->NodeData->SourceData->Strings[target_dup->id1]; // val->Integer = (int)target_dup->id1; return 0; } if (strcmp(attr_name, "val2") == 0) { - val->String = driver_data->NodeData->SourceData->Data[target_dup->id2]; + val->String = driver_data->NodeData->SourceData->Strings[target_dup->id2]; // val->Integer = (int)target_dup->id2; return 0; } @@ -2914,9 +3479,10 @@ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pOb /** Malloc presentation hints struct. **/ pObjPresentationHints hints = check_ptr(nmMalloc(sizeof(ObjPresentationHints))); + if (hints == NULL) goto err; memset(hints, 0, sizeof(ObjPresentationHints)); - /** Hints that are the same for all fields */ + /** Hints that are the same for all fields **/ hints->GroupID = -1; hints->VisualLength2 = 1; hints->Style |= OBJ_PH_STYLE_READONLY | OBJ_PH_STYLE_CREATEONLY | OBJ_PH_STYLE_NOTNULL; @@ -2924,18 +3490,20 @@ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pOb /** Temporary param list for compiling expressions. **/ pParamObjects tmp_list = check_ptr(expCreateParamList()); + if (hints == NULL) goto err; + /** Search for the requested attribute through attributes common to all instances. **/ if (strcmp(attr_name, "name") == 0) { hints->Length = 32; hints->VisualLength = 16; - goto end; + goto success; } if (strcmp(attr_name, "annotation") == 0) { hints->Length = 36; hints->VisualLength = 36; - goto end; + goto success; } if (strcmp(attr_name, "inner_type") == 0 || strcmp(attr_name, "inner_type") == 0 @@ -2944,18 +3512,24 @@ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pOb || strcmp(attr_name, "last_modification") == 0) { hints->VisualLength = 30; - goto end; + goto success; } + /** Handle date created and date computed. */ if (strcmp(attr_name, "date_created") == 0 || strcmp(attr_name, "date_computed") == 0) { - hints->Length = 24; - hints->VisualLength = 20; - hints->Format = nmSysStrdup("datetime"); - goto end; + if (driver_data->TargetType == TARGET_CLUSTER || driver_data->TargetType == TARGET_SEARCH) + { + hints->Length = 24; + hints->VisualLength = 20; + hints->Format = nmSysStrdup("datetime"); + goto success; + } + else goto unknown_attribute; } + /** Search by target type. **/ switch (driver_data->TargetType) { case TARGET_ROOT: @@ -2964,14 +3538,14 @@ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pOb hints->Length = _PC_PATH_MAX; hints->VisualLength = 64; hints->FriendlyName = "Source Path"; - goto end; + goto success; } if (strcmp(attr_name, "attr_name") == 0) { hints->Length = 255; hints->VisualLength = 32; hints->FriendlyName = "Attribute Name"; - goto end; + goto success; } break; @@ -2986,7 +3560,7 @@ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pOb hints->Length = 8; hints->VisualLength = 4; hints->FriendlyName = nmSysStrdup("Number of Clusters"); - goto end; + goto success; } if (strcmp(attr_name, "min_improvement") == 0) { @@ -2999,7 +3573,7 @@ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pOb hints->Length = 16; hints->VisualLength = 8; hints->FriendlyName = nmSysStrdup("Minimum Improvement Threshold"); - goto end; + goto success; } if (strcmp(attr_name, "max_iterations") == 0) { @@ -3012,31 +3586,7 @@ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pOb hints->Length = 8; hints->VisualLength = 4; hints->FriendlyName = nmSysStrdup("Maximum Number of Clustering Iterations"); - goto end; - } - if (strcmp(attr_name, "average_similarity") == 0) - { - /** Min and max values. **/ - hints->MinValue = expCompileExpression("0.0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); - hints->MaxValue = expCompileExpression("1.0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); - - /** Other hints. **/ - hints->Length = 16; - hints->VisualLength = 8; - hints->FriendlyName = nmSysStrdup("Average Similarity"); - goto end; - } - if (strcmp(attr_name, "size") == 0) - { - /** Min and max values. **/ - hints->MinValue = expCompileExpression("0.0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); - hints->MaxValue = expCompileExpression("1.0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); - - /** Other hints. **/ - hints->Length = 16; - hints->VisualLength = 8; - hints->FriendlyName = nmSysStrdup("Average Cluster Size"); - goto end; + goto success; } if (strcmp(attr_name, "algorithm") == 0) { @@ -3059,7 +3609,7 @@ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pOb hints->Length = 24; hints->VisualLength = 20; hints->FriendlyName = nmSysStrdup("Clustering Algorithm"); - goto end; + goto success; } /** Fall-through: Start of overlapping region. **/ @@ -3085,7 +3635,7 @@ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pOb hints->Length = 32; hints->VisualLength = 20; hints->FriendlyName = nmSysStrdup("Similarity Measure"); - goto end; + goto success; } /** End of overlapping region. **/ @@ -3096,7 +3646,7 @@ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pOb hints->Length = 64; hints->VisualLength = 32; hints->FriendlyName = nmSysStrdup("Source Cluster Name"); - goto end; + goto success; } if (strcmp(attr_name, "threshold") == 0) { @@ -3108,7 +3658,7 @@ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pOb hints->Length = 16; hints->VisualLength = 8; hints->FriendlyName = nmSysStrdup("Similarity Threshold"); - goto end; + goto success; } break; @@ -3132,7 +3682,7 @@ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pOb /** Other hints. **/ hints->Length = 8; hints->VisualLength = 4; - goto end; + goto success; } if (strcmp(attr_name, "val") == 0) { @@ -3140,7 +3690,7 @@ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pOb hints->Length = 255; hints->VisualLength = 32; hints->FriendlyName = nmSysStrdup("Value"); - goto end; + goto success; } if (strcmp(attr_name, "sim") == 0) { @@ -3152,7 +3702,7 @@ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pOb hints->Length = 16; hints->VisualLength = 8; hints->FriendlyName = nmSysStrdup("Similarity"); - goto end; + goto success; } break; } @@ -3177,7 +3727,7 @@ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pOb /** Other hints. **/ hints->Length = 8; hints->VisualLength = 4; - goto end; + goto success; } if (strcmp(attr_name, "val1") == 0 || strcmp(attr_name, "val2") == 0) { @@ -3185,7 +3735,7 @@ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pOb hints->Length = 255; hints->VisualLength = 32; hints->FriendlyName = nmSysStrdup("Value"); - goto end; + goto success; } if (strcmp(attr_name, "sim") == 0) { @@ -3197,7 +3747,7 @@ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pOb hints->Length = 16; hints->VisualLength = 8; hints->FriendlyName = nmSysStrdup("Similarity"); - goto end; + goto success; } break; } @@ -3207,14 +3757,26 @@ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pOb goto err; } + /** Unknown attribute. **/ + unknown_attribute:; + char* name; + clusterGetAttrValue(inf_v, "name", DATA_T_STRING, POD(&name), NULL); + mssErrorf(1, "Cluster", + "Unknown attribute '%s' for cluster object %s (target type: %u, \"%s\").", + attr_name, driver_data->NodeData->SourceData->Name, driver_data->TargetType, name + ); - end: - check(expFreeParamList(tmp_list)); - return hints; - + /** Error cleanup. **/ err: + if (tmp_list != NULL) check(expFreeParamList(tmp_list)); /* Failure ignored. */ + if (hints != NULL) nmFree(hints, sizeof(ObjPresentationHints)); mssErrorf(0, "Cluster", "Failed execute generate presentation hints."); return NULL; + + /** Success. **/ + success: + check(expFreeParamList(tmp_list)); /* Failure ignored. */ + return hints; } @@ -3255,11 +3817,11 @@ char* clusterGetNextAttr(void* inf_v, pObjTrxTree oxt) tprintf("%u) is under active development.\n", i); switch (driver_data->TargetType) { - case TARGET_ROOT: return (i < nATTR_ROOT) ? ATTR_ROOT[i] : END_OF_ATTRIBUTES; - case TARGET_CLUSTER: return (i < nATTR_CLUSTER) ? ATTR_CLUSTER[i] : END_OF_ATTRIBUTES; - case TARGET_SEARCH: return (i < nATTR_SEARCH) ? ATTR_SEARCH[i] : END_OF_ATTRIBUTES; - case TARGET_CLUSTER_ENTRY: return (i < nATTR_CLUSTER_ENTRY) ? ATTR_CLUSTER_ENTRY[i] : END_OF_ATTRIBUTES; - case TARGET_SEARCH_ENTRY: return (i < nATTR_SEARCH_ENTRY) ? ATTR_SEARCH_ENTRY[i] : END_OF_ATTRIBUTES; + case TARGET_ROOT: return ATTR_ROOT[i]; + case TARGET_CLUSTER: return ATTR_CLUSTER[i]; + case TARGET_SEARCH: return ATTR_SEARCH[i]; + case TARGET_CLUSTER_ENTRY: return ATTR_CLUSTER_ENTRY[i]; + case TARGET_SEARCH_ENTRY: return ATTR_SEARCH_ENTRY[i]; default: mssErrorf(1, "Cluster", "Unknown target type %u.", driver_data->TargetType); return NULL; @@ -3292,7 +3854,7 @@ int clusterInfo(void* inf_v, pObjectInfo info) switch (driver_data->TargetType) { case TARGET_ROOT: - info->nSubobjects = node_data->nClusters + node_data->nSearches; + info->nSubobjects = node_data->nClusterDatas + node_data->nSearchDatas; info->Flags |= OBJ_INFO_F_CAN_HAVE_SUBOBJ; info->Flags |= OBJ_INFO_F_SUBOBJ_CNT_KNOWN; info->Flags |= (info->nSubobjects > 0) ? OBJ_INFO_F_HAS_SUBOBJ : OBJ_INFO_F_NO_SUBOBJ; @@ -3384,11 +3946,9 @@ char* clusterGetFirstMethod(void* inf_v, pObjTrxTree oxt) ***/ char* clusterGetNextMethod(void* inf_v, pObjTrxTree oxt) { - tprintf("Warning: clusterGetNextMethod("); + tprintf("Warning: clusterGetNextMethod() is under active development."); pDriverData driver_data = (pDriverData)inf_v; - const unsigned int i = driver_data->TargetMethodIndex++; - tprintf("%u) is under active development.\n", i); - return (i < nMETHOD_NAME) ? METHOD_NAME[i] : END_OF_METHODS; + return METHOD_NAME[driver_data->TargetMethodIndex++]; } @@ -3439,7 +3999,9 @@ static int ci_PrintEntry(pXHashEntry entry, void* arg) bytes = ci_SizeOfSearchData(search_data); break; } - default: assert(false); + default: + mssErrorf(0, "Cluster", "Unknown type_id %u.", *type_id_ptr); + return -1; } /** Increment total bytes. **/ @@ -3539,62 +4101,70 @@ int clusterExecuteMethod(void* inf_v, char* method_name, pObjData param, pObjTrx if (strcmp(param->String, "show") == 0) { show = true; - path = ci_file_path(driver_data->NodeData->Obj); + path = ci_file_path(driver_data->NodeData->Parent); } if (strcmp(param->String, "show_all") == 0) show = true; if (show) { /** Print cache info table. **/ + int ret = 0; unsigned int i = 1u, source_bytes = 0u, cluster_bytes = 0u, search_bytes = 0u; + bool failed = false; printf("\nShowing cache for "); if (path != NULL) printf("\"%s\":\n", path); else printf("all files:\n"); printf("%-8s %-16s %-12s %s\n", "Type", "Name", "Size", "Cache Entry Key"); - xhForEach(&ClusterCaches.SourceCache, ci_PrintEntry, (void*[]){&i, &source_bytes, path}); i++; - xhForEach(&ClusterCaches.ClusterCache, ci_PrintEntry, (void*[]){&i, &cluster_bytes, path}); i++; - xhForEach(&ClusterCaches.SearchCache, ci_PrintEntry, (void*[]){&i, &search_bytes, path}); i++; + failed |= !check(xhForEach( + &ClusterDriverCaches.SourceDataCache, + ci_PrintEntry, + (void*[]){&i, &source_bytes, path} + )); + i++; + failed |= !check(xhForEach( + &ClusterDriverCaches.ClusterDataCache, + ci_PrintEntry, + (void*[]){&i, &cluster_bytes, path} + )); + i++; + failed |= !check(xhForEach( + &ClusterDriverCaches.SearchDataCache, + ci_PrintEntry, + (void*[]){&i, &search_bytes, path} + )); + if (failed) + { + mssErrorf(0, "Cluster", "Unexpected error occured while showhing caches."); + ret = -1; + } /** Print stats. **/ char buf[16]; printf("\nCache Stats:\n"); printf("%-8s %-4s %-12s\n", "", "#", "Total Size"); - const int n_sources = ClusterCaches.SourceCache.nItems; - snprint_bytes(buf, sizeof(buf), source_bytes); - printf("%-8s %-4d %-12s\n", "Source", n_sources, buf); - const int n_clusters = ClusterCaches.ClusterCache.nItems; - snprint_bytes(buf, sizeof(buf), cluster_bytes); - printf("%-8s %-4d %-12s\n", "Cluster", n_clusters, buf); - const int n_searches = ClusterCaches.SearchCache.nItems; - snprint_bytes(buf, sizeof(buf), search_bytes); - printf("%-8s %-4d %-12s\n", "Search", n_searches, buf); - snprint_bytes(buf, sizeof(buf), source_bytes + cluster_bytes + search_bytes); - printf("%-8s %-4d %-12s\n\n", "Total", n_sources + n_clusters + n_searches, buf); - return 0; - } - - /** drop and drop_all. **/ - bool drop = false; - if (strcmp(param->String, "drop") == 0) - { - show = true; - path = ci_file_path(driver_data->NodeData->Obj); + printf("%-8s %-4d %-12s\n", "Source", ClusterDriverCaches.SourceDataCache.nItems, snprint_bytes(buf, sizeof(buf), source_bytes)); + printf("%-8s %-4d %-12s\n", "Cluster", ClusterDriverCaches.ClusterDataCache.nItems, snprint_bytes(buf, sizeof(buf), cluster_bytes)); + printf("%-8s %-4d %-12s\n", "Search", ClusterDriverCaches.SearchDataCache.nItems, snprint_bytes(buf, sizeof(buf), search_bytes)); + printf("%-8s %-4d %-12s\n\n", "Total", + ClusterDriverCaches.SourceDataCache.nItems + ClusterDriverCaches.ClusterDataCache.nItems + ClusterDriverCaches.SearchDataCache.nItems, + snprint_bytes(buf, sizeof(buf), source_bytes + cluster_bytes + search_bytes) + ); + + return ret; } - if (strcmp(param->String, "drop_all") == 0) drop = true; - if (drop) + /** drop_all. **/ + if (strcmp(param->String, "drop_all") == 0) { + /** Print info. **/ printf("\nDropping cache for "); if (path != NULL) printf("\"%s\":\n", path); else printf("all files:\n"); - /*** Free caches in reverse of the order they are created in case - *** cached data relies on its source during the freeing process. - ***/ - xhClearKeySafe(&ClusterCaches.SearchCache, ci_CacheFreeSearch, path); - xhClearKeySafe(&ClusterCaches.ClusterCache, ci_CacheFreeCluster, path); - xhClearKeySafe(&ClusterCaches.SourceCache, ci_CacheFreeSourceData, path); - printf("Cache dropped.\n"); + /** Free caches. **/ + ci_FreeCaches(); + + tprintf("Cache dropped.\n"); return 0; } @@ -3613,7 +4183,23 @@ int clusterExecuteMethod(void* inf_v, char* method_name, pObjData param, pObjTrx mssErrorf(0, "Cluster", "Failed execute command."); return -1; } - + + +/*** Frees caches when the driver is unregistered. + *** + *** This function does not free either of the given parameters. + *** + *** @param object_driver The driver instance which was registered being unregistered. (unused) + *** @param session The session being closed. (unused) + *** Returns + ***/ +int clusterUnregister(pObjDriver object_driver, pObjSession session) + { + ci_FreeCaches(); + return 0; + } + + /** ================ Unimplemented Functions ================ **/ /** ANCHOR[id=unimplemented] **/ // LINK #functions @@ -3682,38 +4268,33 @@ int clusterCommit(void* inf_v, pObjTrxTree *oxt) *** - Initializing global data needed for the driver. *** *** @returns 0 if successful, or - *** a negative value if an error occured. + *** -1 if an error occured. ***/ int clusterInitialize(void) { - int ret; /** Initialize library. **/ ca_init(); /** Allocate the driver. **/ - pObjDriver drv = (pObjDriver)nmMalloc(sizeof(ObjDriver)); - if (drv == NULL) return -1; + pObjDriver drv = (pObjDriver)check_ptr(nmMalloc(sizeof(ObjDriver))); + if (drv == NULL) goto err; memset(drv, 0, sizeof(ObjDriver)); /** Initialize globals. **/ - memset(&ClusterCaches, 0, sizeof(ClusterCaches)); - ret = xhInit(&ClusterCaches.SourceCache, 251, 0); - if (ret < 0) return ret; - ret = xhInit(&ClusterCaches.ClusterCache, 251, 0); - if (ret < 0) return ret; - ret = xhInit(&ClusterCaches.SearchCache, 251, 0); - if (ret < 0) return ret; + memset(&ClusterDriverCaches, 0, sizeof(ClusterDriverCaches)); + if (!check(xhInit(&ClusterDriverCaches.SourceDataCache, 251, 0))) goto err; + if (!check(xhInit(&ClusterDriverCaches.ClusterDataCache, 251, 0))) goto err; + if (!check(xhInit(&ClusterDriverCaches.SearchDataCache, 251, 0))) goto err; /** Setup the structure. **/ - strcpy(drv->Name, "clu - Clustering Driver"); - drv->Capabilities = OBJDRV_C_TRANS | OBJDRV_C_FULLQUERY; // OBJDRV_C_TRANS | OBJDRV_C_FULLQUERY; - ret = xaInit(&(drv->RootContentTypes), 1); - if (ret < 0) return ret; - ret = xaAddItem(&(drv->RootContentTypes), "system/cluster"); - if (ret < 0) return ret; + if (check_ptr(strcpy(drv->Name, "clu - Clustering Driver")) == NULL) goto err; + if (!check(xaInit(&(drv->RootContentTypes), 1))) goto err; + if (!check_neg(xaAddItem(&(drv->RootContentTypes), "system/cluster"))) goto err; + drv->Capabilities = OBJDRV_C_TRANS | OBJDRV_C_FULLQUERY; /* TODO: Greg, double check these are correct. */ /** Setup the function references. **/ drv->Open = clusterOpen; + drv->OpenChild = NULL; drv->Close = clusterClose; drv->Create = clusterCreate; drv->Delete = clusterDelete; @@ -3734,9 +4315,12 @@ int clusterInitialize(void) drv->GetFirstMethod = clusterGetFirstMethod; drv->GetNextMethod = clusterGetNextMethod; drv->ExecuteMethod = clusterExecuteMethod; - drv->Commit = clusterCommit; - drv->Info = clusterInfo; drv->PresentationHints = clusterPresentationHints; + drv->Info = clusterInfo; + drv->Commit = clusterCommit; + drv->GetQueryCoverageMask = NULL; + drv->GetQueryIdentityPath = NULL; + drv->Unregister = clusterUnregister; /** Register some structures. **/ nmRegister(sizeof(ClusterData), "ClusterData"); @@ -3745,37 +4329,37 @@ int clusterInitialize(void) nmRegister(sizeof(NodeData), "ClusterNodeData"); nmRegister(sizeof(DriverData), "ClusterDriverData"); nmRegister(sizeof(ClusterQuery), "ClusterQuery"); - nmRegister(sizeof(ClusterCaches), "ClusterCaches"); + nmRegister(sizeof(ClusterDriverCaches), "ClusterDriverCaches"); /** Print debug size info. **/ - char cluster_size_buf[16]; - char search_size_buf[16]; - char source_size_buf[16]; - char node_size_buf[16]; - char driver_size_buf[16]; - char query_size_buf[16]; - char caches_size_buf[16]; + char buf1[16], buf2[16], buf3[16], buf4[16], buf5[16], buf6[16], buf7[16]; tprintf( "Cluster driver struct sizes:\n" + " > sizeof(SourceData): %s\n" " > sizeof(ClusterData): %s\n" " > sizeof(SearchData): %s\n" - " > sizeof(SourceData): %s\n" " > sizeof(NodeData): %s\n" " > sizeof(DriverData): %s\n" " > sizeof(ClusterQuery): %s\n" - " > sizeof(ClusterCaches): %s\n", - snprint_bytes(cluster_size_buf, sizeof(cluster_size_buf), sizeof(ClusterData)), - snprint_bytes(search_size_buf, sizeof(search_size_buf), sizeof(SearchData)), - snprint_bytes(source_size_buf, sizeof(source_size_buf), sizeof(SourceData)), - snprint_bytes(node_size_buf, sizeof(node_size_buf), sizeof(NodeData)), - snprint_bytes(driver_size_buf, sizeof(driver_size_buf), sizeof(DriverData)), - snprint_bytes(query_size_buf, sizeof(query_size_buf), sizeof(ClusterQuery)), - snprint_bytes(caches_size_buf, sizeof(caches_size_buf), sizeof(ClusterCaches)) + " > sizeof(ClusterDriverCaches): %s\n", + snprint_bytes(buf1, sizeof(buf1), sizeof(SourceData)), + snprint_bytes(buf2, sizeof(buf2), sizeof(ClusterData)), + snprint_bytes(buf3, sizeof(buf3), sizeof(SearchData)), + snprint_bytes(buf4, sizeof(buf4), sizeof(NodeData)), + snprint_bytes(buf5, sizeof(buf5), sizeof(DriverData)), + snprint_bytes(buf6, sizeof(buf6), sizeof(ClusterQuery)), + snprint_bytes(buf7, sizeof(buf7), sizeof(ClusterDriverCaches)) ); /** Register the driver. **/ - ret = objRegisterDriver(drv); - if (ret < 0) return ret; + if (!check(objRegisterDriver(drv))) goto err; + /** Success. **/ return 0; + + /** Error cleanup. **/ + err: + if (drv != NULL) nmFree(drv, sizeof(ObjDriver)); + fprintf(stderr, "Error: Failed to initialize cluster driver.\n"); + return -1; } diff --git a/centrallix/test_obj.c b/centrallix/test_obj.c index 5ef492de3..6b09a8586 100644 --- a/centrallix/test_obj.c +++ b/centrallix/test_obj.c @@ -1271,6 +1271,13 @@ testobj_do_cmd(pObjSession s, char* cmd, int batch_mode, pLxSession inp_lx) } else if (!strcmp(cmdname,"quit")) { + /** Loop through each driver and call their unregister handler, if they have one. **/ + for (unsigned int i = 0u; i < OSYS.Drivers.nItems; i++) + { + pObjDriver cur = (pObjDriver)OSYS.Drivers.Items[i]; + if (cur->Unregister != NULL) cur->Unregister(cur, s); + } + mlxCloseSession(ls); return 1; } From a861fb4a2f55241e5bfa1c2ac15c888ff2eccab8 Mon Sep 17 00:00:00 2001 From: Israel Date: Tue, 28 Oct 2025 10:58:21 -0600 Subject: [PATCH 005/275] Upgrade memory handling in the cluster driver. Improve edge case logic in comparison functions. Remove unregister driver function. Clean up exp_functions.c. --- centrallix-lib/include/clusters.h | 8 + centrallix-lib/src/clusters.c | 18 +- centrallix/expression/exp_functions.c | 2151 ++----------------------- centrallix/include/obj.h | 1 - centrallix/osdrivers/objdrv_cluster.c | 246 ++- centrallix/test_obj.c | 7 - 6 files changed, 326 insertions(+), 2105 deletions(-) diff --git a/centrallix-lib/include/clusters.h b/centrallix-lib/include/clusters.h index d8b7f97c6..bddd0800c 100644 --- a/centrallix-lib/include/clusters.h +++ b/centrallix-lib/include/clusters.h @@ -79,6 +79,14 @@ int ca_kmeans( unsigned int* labels, double* vector_sims); +/** Vector helper macros. **/ +#define ca_is_empty(vector) (vector[0] == -CA_NUM_DIMS) +#define ca_has_no_pairs(vector) \ + ({ \ + __typeof__ (vector) _v = (vector); \ + _v[0] == -172 && _v[1] == 11 && _v[2] == -78; \ + }) + /** Comparison functions, for ca_search(). **/ double ca_cos_compare(void* v1, void* v2); double ca_lev_compare(void* str1, void* str2); diff --git a/centrallix-lib/src/clusters.c b/centrallix-lib/src/clusters.c index 90599269c..864ff36eb 100644 --- a/centrallix-lib/src/clusters.c +++ b/centrallix-lib/src/clusters.c @@ -514,12 +514,18 @@ static unsigned int edit_dist(const char* str1, const char* str2, const size_t s ***/ double ca_cos_compare(void* v1, void* v2) { - /** Input validation checks. **/ - if (v1 == NULL || v2 == NULL) return 0.0; if (v1 == v2) return 1.0; + /** Input validation checks. **/ + const pVector vec1 = v1, vec2 = v2; + const bool v1_empty = (vec1 == NULL || ca_is_empty(vec1) || ca_has_no_pairs(vec1)); + const bool v2_empty = (vec2 == NULL || ca_is_empty(vec2) || ca_has_no_pairs(vec2)); + if (v1_empty && v2_empty) return 1.0; + if (v1_empty && !v2_empty) return 0.0; + if (!v1_empty && v2_empty) return 0.0; + /** Return the sparse similarity. **/ - return sparse_similarity((const pVector)v1, (const pVector)v2); + return sparse_similarity(vec1, vec2); } /*** Compares two strings using their levenstien edit distance to compute a @@ -544,12 +550,12 @@ double ca_lev_compare(void* str1, void* str2) if (str1 == NULL || str2 == NULL) return 0.0; if (str1 == str2) return 1.0; - /** Compute string length. **/ + /** Handle string length. **/ const size_t len1 = strlen(str1); const size_t len2 = strlen(str2); - - /** Empty strings are identical, avoiding a divide by zero. */ if (len1 == 0lu && len2 == 0lu) return 1.0; + if (len1 != 0lu && len2 == 0lu) return 0.0; + if (len1 != 0lu && len2 != 0lu) return 0.0; /** Compute levenshtein edit distance. **/ const unsigned int dist = edit_dist((const char*)str1, (const char*)str2, len1, len2); diff --git a/centrallix/expression/exp_functions.c b/centrallix/expression/exp_functions.c index a8e16ecc7..4f9ffa563 100644 --- a/centrallix/expression/exp_functions.c +++ b/centrallix/expression/exp_functions.c @@ -67,6 +67,7 @@ #include "cxlib/mtlexer.h" #include "cxlib/mtsession.h" #include "cxlib/newmalloc.h" +#include "cxlib/util.h" #include "cxlib/xarray.h" #include "cxlib/xhash.h" #include "cxss/cxss.h" @@ -3996,2021 +3997,177 @@ int exp_fn_nth(pExpression tree, pParamObjects objlist, pExpression i0, pExpress return 0; } -/* See centrallix-sysdoc/string_comparison.md for more information. */ -int exp_fn_levenshtein(pExpression tree, pParamObjects objlist, pExpression i0, pExpression i1, pExpression i2) - { - if (!i0 || !i1) +/*** Computes cosine or levenshtien similarity between two strings. These two + *** tasks have a large amount of overlapping logic (mostly error checking), + *** so doing them with one function greatly reduces code duplocation. + *** + *** @param tree The tree resulting from this function. + *** @param objlist The evaluation "scope", including available variables. + *** @param maybe_str1 Possibly the first string. + *** @param maybe_str2 Possibly the second string. + *** @param u1 Unused parameter. + *** @param is_cos Whether to compute cosine or levenshtien. + ***/ +static int exp_fn_cmp(pExpression tree, pParamObjects objlist, pExpression maybe_str1, pExpression maybe_str2, pExpression u1, bool is_cos) + { + const char fn_name[] = "cos_cmp"; + + /** Check number of arguments. **/ + const int num_params = tree->Children.nItems; + if (num_params != 2) { - mssError(1,"EXP","levenshtein() requires two parameters"); - return -1; + mssErrorf(1, "EXP", "%s(?) expects 2 parameters, got %d parameters.", fn_name, num_params); + return -1; } - - if ((i0->Flags & EXPR_F_NULL) || (i1->Flags & EXPR_F_NULL)) + if (maybe_str1 == NULL || maybe_str2 == NULL || u1 != NULL) { - tree->DataType = DATA_T_INTEGER; - tree->Flags |= EXPR_F_NULL; - return 0; + mssErrorf(1, "EXP", "%s(?) expects 2 parameters.", fn_name); + return -1; } - - if ((i0->DataType != DATA_T_STRING) || (i1->DataType != DATA_T_STRING)) + + /** Magic checks. **/ + ASSERTMAGIC(tree, MGK_EXPRESSION); + ASSERTMAGIC(maybe_str1, MGK_EXPRESSION); + ASSERTMAGIC(maybe_str2, MGK_EXPRESSION); + + /** Check object list. **/ + if (objlist == NULL) { - mssError(1,"EXP","levenshtein() requires two string parameters"); - return -1; + mssErrorf(1, "EXP", "%s(\?\?\?) no object list?", fn_name); + return -1; } - - // for all i and j, d[i,j] will hold the Levenshtein distance between - // the first i characters of s and the first j characters of t - int length1 = strlen(i0->String); - int length2 = strlen(i1->String); - //int levMatrix[length1+1][length2+1]; - int (*levMatrix)[length1+1][length2+1] = nmSysMalloc(sizeof(*levMatrix)); - int i; - int j; - //set each element in d to zero - for (i = 0; i < length1; i++) - { - for (j = 0; j < length2; j++) - { - (*levMatrix)[i][j] = 0; - } - } - - // source prefixes can be transformed into empty string by - // dropping all characters - for (i = 0; i <= length1; i++) - { - (*levMatrix)[i][0] = i; - } - - // target prefixes can be reached from empty source prefix - // by inserting every character - for (j = 0; j <= length2; j++) - { - (*levMatrix)[0][j] = j; - } + ASSERTMAGIC(objlist->Session, MGK_OBJSESSION); - for (i = 1; i <= length1; i++) - { - for (j = 1; j <= length2; j++) - { - if (i0->String[i-1] == i1->String[j-1]) - { - (*levMatrix)[i][j] = (*levMatrix)[i-1][j-1]; - } - else - { - int value1 = (*levMatrix)[i - 1][j] + 1; - int value2 = (*levMatrix)[i][j-1] + 1; - int value3 = (*levMatrix)[i-1][j-1] + 1; - (*levMatrix)[i][j] = (value1 < value2) ? - ((value1 < value3) ? value1 : value3) : - (value2 < value3) ? value2 : value3; - } - } - } - tree->DataType = DATA_T_INTEGER; - tree->Integer = (*levMatrix)[length1][length2]; - nmSysFree(levMatrix); - return 0; - } - -/* See centrallix-sysdoc/string_comparison.md for more information. */ -int exp_fn_lev_compare(pExpression tree, pParamObjects objlist, pExpression i0, pExpression i1, pExpression i2) - { - - if (!i0 || !i1) + /** Extract str1. **/ + if (maybe_str1->Flags & EXPR_F_NULL) { - mssError(1,"EXP","lev_compare() requires two or three parameters"); - return -1; + mssErrorf(1, "EXP", "%s(NULL, ...) str1 cannot be NULL.", fn_name); + return -1; } - - if ((i0->Flags & EXPR_F_NULL) || (i1->Flags & EXPR_F_NULL) || (i2 && (i2->Flags & EXPR_F_NULL))) + if (maybe_str1->DataType != DATA_T_STRING) { - tree->DataType = DATA_T_DOUBLE; - tree->Flags |= EXPR_F_NULL; - return 0; + mssErrorf(1, "EXP", "%s(\?\?\?, ..) str1 should be a string.", fn_name); + return -1; } - - if ((i0->DataType != DATA_T_STRING) || (i1->DataType != DATA_T_STRING) || (i2 && i2->DataType != DATA_T_INTEGER)) + char* str1 = maybe_str1->String; + if (str1 == NULL) { - mssError(1,"EXP","lev_compare() requires two string and one optional integer parameters"); - return -1; + mssErrorf(1, "EXP", + "%s(nothing?, ...) expected string from str1 (of datatype DataType = " + "DATA_T_STRING), but the String was NULL or did not exist!", + fn_name + ); + return -1; } - exp_fn_levenshtein(tree, objlist, i0, i1, i2); - //!!! I am not checking for errors here, because IN THEORY we have two strings... if we don't, big uh-oh. - int lev_dist = tree->Integer; - - int length1 = strlen(i0->String); - int length2 = strlen(i1->String); - - double clamped_dist = 1.0; - - if (length1 == 0 || length2 == 0) //empty string + /** Extract str2. **/ + if (maybe_str2->Flags & EXPR_F_NULL) { - clamped_dist = 0.5; - } - else //normal case - { - int max_len = (length1 > length2) ? length1 : length2; - clamped_dist = ((double) lev_dist) / max_len; - - if (abs(length1-length2) == lev_dist) //only inserts. Maybe substring. - { - clamped_dist /= 2; - } - - //use max_field_width if it was provided as a sensible value. If not, don't use it. - double max_field_width = i2?(i2->Integer):0; - if (max_field_width && max_field_width >= max_len) { - double mod = (lev_dist + max_field_width * 3/4) / max_field_width; - if (mod < 1) { //don't make clamped_dist bigger - clamped_dist *= mod; - } - } + mssErrorf(1, "EXP", "%s(\"%s\", NULL) str2 cannot be NULL.", fn_name, str1); + return -1; } - - - tree->DataType = DATA_T_DOUBLE; - tree->Types.Double = 1.0 - clamped_dist; - return 0; -} - -/* - * hash_char_pair - * This method creates an vector table index based a given character pair. The characters are represented - * as their ASCII code points. - * - * Parameters: - * num1 : first ASCII code point (double) - * num2 : second ASCII code point (double) - * - * Returns: - * vector table index (integer) - */ -int exp_fn_i_hash_char_pair(double num1, double num2) - { - int func_result = round(((num1 * num1 * num1) + (num2 * num2 * num2)) * ((num1+1)/(num2+1))) -1; - return func_result % EXP_VECTOR_TABLE_SIZE; - } - - -/* - * exp_fn_i_frequency_table - * This method creates a vector frequency table based on a string of characters. - * - * Parameters: - * table : integer pointer to vector frequency table (unsigned short) - * term : the string of characters (char*) - * - * Returns: - * 0 - * - * LINK ../../centrallix-sysdoc/string_comparison.md#exp_fn_i_frequency_table - */ -int exp_fn_i_frequency_table(unsigned short *table, char *term) - { - int i; - // Initialize hash table with 0 values - for (i = 0; i < EXP_VECTOR_TABLE_SIZE; i++) + if (maybe_str2->DataType != DATA_T_STRING) { - table[i] = 0; + mssErrorf(1, "EXP", "%s(\"%s\", \?\?\?) str2 should be a string.", fn_name, str1); + return -1; } - - int j = -1; - for(i = 0; i < strlen(term) + 1; i++) + char* str2 = maybe_str2->String; + if (str2 == NULL) { - // If latter character is punctuation or whitespace, skip it - if (ispunct(term[i]) || isspace(term[i])) - { - continue; - } - - double temp1 = 0.0; - double temp2 = 0.0; - - // If previous character is null - if (j == -1) - { - temp1 = 96; - } - - // Else character is not null - else - { - temp1 = (int)tolower(term[j]); - } - - // If latter character is null - if (i == strlen(term)) + mssErrorf(1, "EXP", + "%s(\"%s\", nothing?) expected string from str2 (of datatype DataType = " + "DATA_T_STRING), but the String was NULL or did not exist!", + fn_name, str1 + ); + return -1; + } + + /** Handle either cos_cmp or lev_cmp. **/ + if (is_cos) + { /* cos_cmp */ + int ret; + + /** Build vectors. **/ + const pVector v1 = check_ptr(ca_build_vector(str1)); + const pVector v2 = check_ptr(ca_build_vector(str2)); + if (v1 == NULL || v2 == NULL) { - temp2 = 96; + mssErrorf(1, "EXP", + "%s(\"%s\", \"%s\") - Failed to build vectors.", + fn_name, str1, str2 + ); + ret = -1; } - - // Else character is not null else { - temp2 = (int)tolower(term[i]); - } - - // Else character is not null // If either character is a number, reassign the code point - if (temp1 >= 48 && temp1 <= 57) - { - temp1 += 75; - } - - if (temp2 >= 48 && temp2 <= 57) - { - temp2 += 75; + tree->Types.Double = ca_cos_compare(v1, v2); + tree->DataType = DATA_T_DOUBLE; + ret = 0; } - - // Hash the character pair into an index - int index = exp_fn_i_hash_char_pair(temp1, temp2); - - // Increment Frequency Table value by number from 0 to 13 - table[index] += ((unsigned short)temp1 + (unsigned short)temp2) % 13 + 1; - - // Move j up to latter character before incrementing i - j = i; - + + if (v1 != NULL) ca_free_vector(v1); + if (v2 != NULL) ca_free_vector(v2); + return ret; } - - return 0; - - } - -/* - * exp_fn_i_dot_product - * This method calculautes the dot product of two vectors. - * - * Parameters: - * dot_product : the place where the result is stored (double) - * r_freq_table1 : the first vector (unsigned short) - * r_freq_table2 : the second vector (unsigned short) - * - * Returns: - * 0 - * - * LINK ../../centrallix-sysdoc/string_comparison.md#exp_fn_i_dot_product - */ -int exp_fn_i_dot_product(double *dot_product, unsigned short *r_freq_table1, unsigned short *r_freq_table2) - { - int i; - for (i = 0; i < EXP_VECTOR_TABLE_SIZE; i++) - { - *dot_product = *dot_product + ((double)r_freq_table1[i] * (double)r_freq_table2[i]); + else + { /* lev_cmp */ + tree->Types.Double = ca_lev_compare(str1, str2); + tree->DataType = DATA_T_DOUBLE; + return 0; } - return 0; + return -1; } -/* - * exp_fn_i_magnitude - * This method calculates the magnitude of a vector - * - * Parameters: - * magnitude : the place where the result is stored (double) - * r_freq_table : the vector (unsigned short) - * - * LINK ../../centrallix-sysdoc/string_comparison.md#exp_fn_i_magnitude - */ -int exp_fn_i_magnitude(double *magnitude, unsigned short *r_freq_table) +/*** Computes cosine similarity between two strings. + *** + *** @param tree The tree resulting from this function. + *** @param objlist The evaluation "scope", including available variables. + *** @param maybe_str1 Possibly the first string. + *** @param maybe_str2 Possibly the second string. + *** @param u1 Unused parameter. + ***/ +int exp_fn_cos_cmp(pExpression tree, pParamObjects objlist, pExpression maybe_str1, pExpression maybe_str2, pExpression u1) { - int i; - for (i = 0; i < EXP_VECTOR_TABLE_SIZE; i++) - { - *magnitude = *magnitude + ((double)r_freq_table[i] * (double)r_freq_table[i]); - } - *magnitude = sqrt(*magnitude); - return 0; + return exp_fn_cmp(tree, objlist, maybe_str1, maybe_str2, u1, true); } -/* - * exp_fn_cos_compare - * This method calculates the cosine similarity of two vector frequency tables - * See centrallix-sysdoc/string_comparison.md for more information. - * - * Parameters: - * tree : structure where output is stored - * objlist : unused - * i0 : first data entry (pExpression) - * i1 : second data entry (pExpression) - * i2 : unused - * - * Returns: - * 0 - * - * LINK ../../centrallix-sysdoc/string_comparison.md#exp_fn_similarity - */ -int exp_fn_cos_compare(pExpression tree, pParamObjects objlist, pExpression i0, pExpression i1, pExpression i2) +/*** Computes levenshtein similarity by normalizing the levenshtein edit + *** distance between two strings with the length of the longer string. + *** + *** @param tree The tree resulting from this function. + *** @param objlist The evaluation "scope", including available variables. + *** @param maybe_str1 Possibly the first string. + *** @param maybe_str2 Possibly the second string. + *** @param u1 Unused parameter. + ***/ +int exp_fn_lev_cmp(pExpression tree, pParamObjects objlist, pExpression maybe_str1, pExpression maybe_str2, pExpression u1) { - // Ensure function receives two non-null parameters - if (!i0 || !i1) - { - mssError(1,"EXP","cos_compare() requires two parameter."); - return -1; - } - - // Ensure value passed in both parameters is not null - if ((i0->Flags & EXPR_F_NULL) || (i1->Flags & EXPR_F_NULL)) - { - tree->DataType = DATA_T_DOUBLE; - tree->Flags |= EXPR_F_NULL; - return 0; - } - - // Ensure both parameters contain string values - if ((i0->DataType != DATA_T_STRING) || (i1->DataType != DATA_T_STRING)) - { - mssError(1,"EXP","cos_compare() requires two string parameters."); - return -1; - } - - //If the two strings are identical, don't bother running cosine compare - if (strcmp(i0->String, i1->String) == 0) - { - tree->DataType = DATA_T_DOUBLE; - tree->Types.Double = 1.0; - return 0; - } - - // Allocate frequency tables (arrays of integers) for each term - unsigned short *table1 = nmMalloc(EXP_VECTOR_TABLE_SIZE * sizeof(unsigned short)); - unsigned short *table2 = nmMalloc(EXP_VECTOR_TABLE_SIZE * sizeof(unsigned short)); - - if (table1 == NULL || table2 == NULL) - { - mssError(1,"EXP","Memory allocation failed."); - return -1; - } - - // Calculate frequency tables for each term - exp_fn_i_frequency_table(table1, i0->String); - exp_fn_i_frequency_table(table2, i1->String); - - // Calculate dot product - double dot_product = 0; - exp_fn_i_dot_product(&dot_product, table1, table2); - - // Calculate magnitudes of each relative frequency vector - double magnitude1 = 0; - double magnitude2 = 0; - exp_fn_i_magnitude(&magnitude1, table1); - exp_fn_i_magnitude(&magnitude2, table2); - - tree->DataType = DATA_T_DOUBLE; - tree->Types.Double = dot_product / (magnitude1 * magnitude2); - nmFree(table1, EXP_VECTOR_TABLE_SIZE * sizeof(unsigned short)); - nmFree(table2, EXP_VECTOR_TABLE_SIZE * sizeof(unsigned short)); - - return 0; + return exp_fn_cmp(tree, objlist, maybe_str1, maybe_str2, u1, false); } -// /*** ========================= -// *** DUPE SECTION -// *** By: Israel Fuller -// *** Last Updated: September, 2025 -// *** -// *** This section of the file deals with finding duplocates. -// ***/ - -// /*** @brief Returns the smaller of two values. -// *** -// *** @param a The first value. -// *** @param b The second value. -// *** @return The smaller of the two values. -// *** -// *** @note This macro uses GNU C extensions and is type-safe. -// ***/ -// #define min(a, b) ({ \ -// __typeof__ (a) _a = (a); \ -// __typeof__ (b) _b = (b); \ -// (_a < _b) ? _a : _b; \ -// }) - -// /*** @brief Returns the larger of two values. -// *** -// *** @param a The first value. -// *** @param b The second value. -// *** @return The larger of the two values. -// *** -// *** @note This macro uses GNU C extensions and is type-safe. -// ***/ -// #define max(a, b) ({ \ -// __typeof__ (a) _a = (a); \ -// __typeof__ (b) _b = (b); \ -// (_a > _b) ? _a : _b; \ -// }) - -// /** The character used to create a pair with the first and last characters of a string. **/ -// #define EXP_BOUNDARY_CHAR ('a' - 1) - -// /*** Helpful error handling function. **/ -// void mssErrorf(int clr, char* module, const char* format, ...); - -// /*** Gets the hash, representing a pair of ASCII characters, represented by unsigned ints. -// *** -// *** @param num1 The first character in the pair. -// *** @param num1 The second character in the pair. -// *** @returns The resulting hash. -// ***/ -// unsigned int exp_fn_get_char_pair_hash(const unsigned int num1, const unsigned int num2) -// { -// if (num1 == EXP_BOUNDARY_CHAR && num2 == EXP_BOUNDARY_CHAR) -// { -// mssErrorf(1, "EXP", -// "exp_fn_get_char_pair_hash(%u, %u) - Warning: Pair of boundary characters.", -// num1, num2 -// ); -// } -// const double sum = (num1 * num1 * num1) + (num2 * num2 * num2); -// const double scale = ((double)num1 + 1.0) / ((double)num2 + 1.0); -// const unsigned int hash = (unsigned int)round(sum * scale) - 1u; -// return hash % EXP_NUM_DIMS; -// } - -// /*** Builds a vector using a string. -// *** -// *** Vectors are based on the frequencies of character pairs in the string. -// *** Space characters and punctuation characters (see code for list) are ignored, -// *** and all characters are converted to lowercase. Character 96, which is just -// *** before 'a' in the ASCII table (and maps to '`') is used to make pairs on the -// *** start and end of strings. The only supported characters for the passed char* -// *** are spaces, punctuation, uppercase and lowercase letters, and numbers. -// *** -// *** This results in the following modified ASCII table: -// *** ```csv -// *** #, char, #, char, #, char -// *** 97, a, 109, m, 121, y -// *** 98, b, 110, n, 122, z -// *** 99, c, 111, o, 123, 0 -// *** 100, d, 112, p, 124, 1 -// *** 101, e, 113, q, 125, 2 -// *** 102, f, 114, r, 126, 3 -// *** 103, g, 115, s, 127, 4 -// *** 104, h, 116, t, 128, 5 -// *** 105, i, 117, u, 129, 6 -// *** 106, j, 118, v, 130, 7 -// *** 107, k, 119, w, 131, 8 -// *** 108, l, 120, x, 132, 9 -// *** ``` -// *** Thus, any number from 96 (the start/end character) to 132 ('9') is a valid -// *** input to get_char_pair_hash(). -// *** -// *** After hashing each character pair, we add some number from 1 to 13 to the -// *** coresponding dimention. However, for most names, this results in a lot of -// *** zeros and a FEW positive numbers. Thus, after creating the dense vector, -// *** we convert it to a sparse vector in which a negative number replaces a run -// *** of that many zeros. Consider the following example: -// *** -// *** Dense Vector: `[1,0,0,0,3,0]` -// *** -// *** Sparse Vector: `[1,-3,3,-1]` -// *** -// *** Using these sparse vectors greatly reduces the required memory and gives -// *** aproximately an x5 boost to performance when traversing vectors, at the -// *** cost of more algorithmically complex code. -// *** -// *** @param str The string to be divided into pairs and hashed to make the vector. -// *** @returns The sparse vector built using the hashed character pairs. -// ***/ -// int* build_vector(char* str) { -// /** Allocate space for a dense vector. **/ -// unsigned int dense_vector[EXP_NUM_DIMS] = {0u}; - -// /** j is the former character, i is the latter. **/ -// const unsigned int num_chars = (unsigned int)strlen(str); -// for (unsigned int j = 65535u, i = 0u; i <= num_chars; i++) -// { -// /** isspace: space, \n, \v, \f, \r **/ -// if (isspace(str[i])) continue; - -// /** ispunct: !"#$%&'()*+,-./:;<=>?@[\]^_{|}~ **/ -// if (ispunct(str[i]) && str[i] != EXP_BOUNDARY_CHAR) continue; - -// /*** iscntrl (0-8): SOH, STX, ETX, EOT, ENQ, ACK, BEL, BS -// *** (14-31): SO, SI, DLE, DC1-4, NAK, SYN, ETB, CAN -// *** EM, SUB, ESC, FS, GS, RS, US -// ***/ -// if (iscntrl(str[i]) && i != num_chars) { -// mssErrorf(1, "EXP", -// "build_vector(%s) - Warning: Skipping unknown character #%u.\n", -// str, (unsigned int)str[i] -// ); -// continue; -// } - -// /** First and last character should fall one before 'a' in the ASCII table. **/ -// unsigned int temp1 = (j == 65535u) ? EXP_BOUNDARY_CHAR : (unsigned int)tolower(str[j]); -// unsigned int temp2 = (i == num_chars) ? EXP_BOUNDARY_CHAR : (unsigned int)tolower(str[i]); - -// /** Shift numbers to the end of the lowercase letters. **/ -// if ('0' <= temp1 && temp1 <= '9') temp1 += 75u; -// if ('0' <= temp2 && temp2 <= '9') temp2 += 75u; - -// /** Hash the character pair into an index (dimension). **/ -// /** Note that temp will be between 97 ('a') and 132 ('9'). **/ -// unsigned int dim = exp_fn_get_char_pair_hash(temp1, temp2); - -// /** Increment the dimension of the dense vector by a number from 1 to 13. **/ -// dense_vector[dim] += (temp1 + temp2) % 13u + 1u; - -// j = i; -// } - -// /** Count how much space is needed for a sparse vector. **/ -// bool zero_prev = false; -// size_t size = 0u; -// for (unsigned int dim = 0u; dim < EXP_NUM_DIMS; dim++) -// { -// if (dense_vector[dim] == 0u) -// { -// size += (zero_prev) ? 0u : 1u; -// zero_prev = true; -// } -// else -// { -// size++; -// zero_prev = false; -// } -// } - -// /*** Check compression size. -// *** If this check fails, I doubt anything will break. However, the longest -// *** word I know (supercalifragilisticexpialidocious) has only 35 character -// *** pairs, so it shouldn't reach half this size (and it'd be even shorter -// *** if the hash generates at least one collision). -// *** -// *** Bad vector compression will result in degraded performace and increased -// *** memory usage, and likely also indicates a bug or modified assumption -// *** elsewhere in the code. -// *** -// *** If this warning is ever generated, it's definitely worth investigating. -// ***/ -// const size_t expected_max_size = 64u; -// if (size > expected_max_size) -// { -// mssErrorf(1, "EXP" -// "build_vector(%s) - Warning: Sparse vector larger than expected.\n" -// " > Size: %lu\n" -// " > #Dims: %u\n", -// str, -// size, -// EXP_NUM_DIMS -// ); -// } - -// /** Allocate space for sparse vector. **/ -// const size_t sparse_vector_size = size * sizeof(int); -// int* sparse_vector = (int*)nmSysMalloc(sparse_vector_size); -// if (sparse_vector == NULL) { -// mssErrorf(1, "EXP", -// "build_vector(%s) - nmSysMalloc(%lu) failed.", -// str, sparse_vector_size -// ); -// return NULL; -// } - -// /** Convert the dense vector above to a sparse vector. **/ -// unsigned int j = 0u, sparse_idx = 0u; -// while (j < EXP_NUM_DIMS) -// { -// if (dense_vector[j] == 0u) -// { -// /*** Count and store consecutive zeros, except the first one, -// *** which we already know is zero. -// ***/ -// unsigned int zero_count = 1u; -// j++; -// while (j < EXP_NUM_DIMS && dense_vector[j] == 0u) -// { -// zero_count++; -// j++; -// } -// sparse_vector[sparse_idx++] = (int)-zero_count; -// } -// else -// { -// /** Store the value. **/ -// sparse_vector[sparse_idx++] = (int)dense_vector[j++]; -// } -// } - -// return sparse_vector; -// } - -// /*** Compute the magnitude of a sparsely allocated vector. -// *** -// *** @param vector The vector. -// *** @returns The computed magnitude. -// ***/ -// double exp_fn_magnitude_sparse(const int* vector) -// { -// unsigned int magnitude = 0u; -// for (unsigned int i = 0u, dim = 0u; dim < EXP_NUM_DIMS;) -// { -// const int val = vector[i++]; - -// /** Negative val represents -val 0s in the array, so skip that many values. **/ -// if (val < 0) dim += (unsigned)(-val); - -// /** We have a param_value, so square it and add it to the magnitude. **/ -// else { magnitude += (unsigned)(val * val); dim++; } -// } -// return sqrt((double)magnitude); -// } - -// /*** Compute the magnitude of a densely allocated centroid. -// *** -// *** @param centroid The centroid. -// *** @returns The computed magnitude. -// ***/ -// double exp_fn_magnitude_dense(const double* centroid) -// { -// double magnitude = 0.0; -// for (int i = 0; i < EXP_NUM_DIMS; i++) -// magnitude += centroid[i] * centroid[i]; -// return sqrt(magnitude); -// } - -// /*** Parse a token from a sparsely allocated vector and write the param_value and -// *** number of remaining values to the passed locations. -// *** -// *** @param token The sparse vector token being parsed. -// *** @param remaining The location to save the remaining number of characters. -// *** @param param_value The location to save the param_value of the token. -// ***/ -// void exp_fn_parse_token(const int token, unsigned int* remaining, unsigned int* param_value) { -// if (token < 0) -// { -// /** This run contains -token zeros. **/ -// *remaining = (unsigned)(-token); -// *param_value = 0u; -// } -// else -// { -// /** This run contains one param_value. **/ -// *remaining = 1u; -// *param_value = (unsigned)(token); -// } -// } - -// /*** Calculate the similarity on sparcely allocated vectors. Comparing -// *** any string to an empty string should always return 0.5 (untested). -// *** -// *** @param v1 Sparse vector #1. -// *** @param v2 Sparse vector #2. -// *** @returns Similarity between 0 and 1 where -// *** 1 indicates identical and -// *** 0 indicates completely different. -// ***/ -// double exp_fn_sparse_similarity(const int* v1, const int* v2) -// { -// /** Calculate dot product. **/ -// unsigned int vec1_remaining = 0u, vec2_remaining = 0u; -// unsigned int dim = 0u, i1 = 0u, i2 = 0u, dot_product = 0u; -// while (dim < EXP_NUM_DIMS) -// { -// unsigned int val1 = 0u, val2 = 0u; -// if (vec1_remaining == 0u) exp_fn_parse_token(v1[i1++], &vec1_remaining, &val1); -// if (vec2_remaining == 0u) exp_fn_parse_token(v2[i2++], &vec2_remaining, &val2); - -// /*** Accumulate the dot_product. If either vector is 0 here, -// *** the total is 0 and this statement does nothing. -// ***/ -// dot_product += val1 * val2; - -// /** Consume overlap from both runs. **/ -// unsigned int overlap = min(vec1_remaining, vec2_remaining); -// vec1_remaining -= overlap; -// vec2_remaining -= overlap; -// dim += overlap; -// } - -// /** Optional optimization to speed up nonsimilar vectors. **/ -// if (dot_product == 0u) return 0.0; - -// /** Return the difference score. **/ -// return (double)dot_product / (exp_fn_magnitude_sparse(v1) * exp_fn_magnitude_sparse(v2)); -// } - -// /*** Calculate the difference on sparcely allocated vectors. Comparing -// *** any string to an empty string should always return 0.5 (untested). -// *** -// *** @param v1 Sparse vector #1. -// *** @param v2 Sparse vector #2. -// *** @returns Similarity between 0 and 1 where -// *** 1 indicates completely different and -// *** 0 indicates identical. -// ***/ -// #define exp_fn_sparse_dif(v1, v2) (1.0 - exp_fn_sparse_similarity(v1, v2)) - -// /*** Calculate the similarity between a sparsely allocated vector -// *** and a densely allocated centroid. Comparing any string to an -// *** empty string should always return 0.5 (untested). -// *** -// *** @param v1 Sparse vector #1. -// *** @param c1 Dense centroid #2. -// *** @returns Similarity between 0 and 1 where -// *** 1 indicates identical and -// *** 0 indicates completely different. -// ***/ -// double exp_fn_sparse_similarity_c(const int* v1, const double* c2) -// { -// /** Calculate dot product. **/ -// double dot_product = 0.0; -// for (unsigned int i = 0u, dim = 0u; dim < EXP_NUM_DIMS;) -// { -// const int val = v1[i++]; - -// /** Negative val represents -val 0s in the array, so skip that many values. **/ -// if (val < 0) dim += (unsigned)(-val); - -// /** We have a param_value, so square it and add it to the magnitude. **/ -// else dot_product += (double)val * c2[dim++]; -// } - -// /** Return the difference score. **/ -// return dot_product / (exp_fn_magnitude_sparse(v1) * exp_fn_magnitude_dense(c2)); -// } - -// /*** Calculate the difference between a sparsely allocated vector -// *** and a densely allocated centroid. Comparing any string to an -// *** empty string should always return 0.5 (untested). -// *** -// *** @param v1 Sparse vector #1. -// *** @param c1 Dense centroid #2. -// *** @returns Difference between 0 and 1 where -// *** 1 indicates completely different and -// *** 0 indicates identical. -// ***/ -// #define exp_fn_sparse_dif_c(v1, c2) (1.0 - exp_fn_sparse_similarity_c(v1, c2)) - -// /*** Calculate the average size of all clusters in a set of vectors. -// *** -// *** @param vectors The vectors of the dataset (allocated sparsely). -// *** @param num_vectors The number of vectors in the dataset. -// *** @param labels The clusters to which vectors are assigned. -// *** @param centroids The locations of the centroids (allocated densely). -// *** @param num_clusters The number of centroids (k). -// *** @returns The average cluster size. -// ***/ -// double exp_fn_get_cluster_size( -// int** vectors, -// const unsigned int num_vectors, -// unsigned int* labels, -// double centroids[][EXP_NUM_DIMS], -// const unsigned int num_clusters -// ) -// { -// double cluster_sums[num_clusters]; -// unsigned int cluster_counts[num_clusters]; -// for (unsigned int i = 0u; i < num_clusters; i++) -// cluster_sums[i] = 0.0; -// memset(cluster_counts, 0, sizeof(cluster_counts)); - -// /** Sum the difference from each vector to its cluster centroid. **/ -// for (unsigned int i = 0u; i < num_vectors; i++) -// { -// const unsigned int label = labels[i]; -// cluster_sums[label] += exp_fn_sparse_dif_c(vectors[i], centroids[label]); -// cluster_counts[label]++; -// } - -// /** Add up the average cluster size. **/ -// double cluster_total = 0.0; -// unsigned int num_valid_clusters = 0u; -// for (unsigned int label = 0u; label < num_clusters; label++) -// { -// const unsigned int cluster_count = cluster_counts[label]; -// if (cluster_count == 0u) continue; - -// cluster_total += cluster_sums[label] / cluster_count; -// num_valid_clusters++; -// } - -// /** Return average sizes. **/ -// return cluster_total / num_valid_clusters; -// } - -// /*** Compute the param_value for `k` (number of clusters), given a dataset of with -// *** a size of `n`. -// *** -// *** The following table shows data sizes vs.selected cluster size. In testing, -// *** these numbers tended to givea good balance of accuracy and dulocates detected. -// *** -// *** ```csv -// *** Data Size, Actual -// *** 10k, 12 -// *** 100k, 33 -// *** 1M, 67 -// *** 4M, 93 -// *** ``` -// *** -// *** This function is not intended for datasets smaller than (`n < ~2000`). -// *** These should be handled using complete search. -// *** -// *** LaTeX Notation: \log_{36}\left(n\right)^{3.1}-8 -// *** -// *** @param n The size of the dataset. -// *** @returns k, the number of clusters to use. -// *** -// *** Complexity: `O(1)` -// ***/ -// unsigned int exp_fn_compute_k(const unsigned int n) -// { -// return (unsigned)max(2, pow(log(n) / log(36), 3.2) - 8); -// } - -// /*** Executes the k-means clustering algorithm. Selects NUM_CLUSTERS random -// *** vectors as initial centroids. Then points are assigned to the nearest -// *** centroid, after which centroids are moved to the center of their points. -// *** -// *** @param vectors The vectors to cluster. -// *** @param num_vectors The number of vectors to cluster. -// *** @param labels Stores the final cluster identities of the vectors after -// *** clustering is completed. -// *** @param centroids Stores the locations of the centroids used for the clusters -// *** of the data. -// *** @param iterations The number of iterations that actually executed is stored -// *** here. Leave this NULL if you don't care. -// *** @param max_iter The max number of iterations. -// *** @param num_clusters The number of clusters to generate. -// *** -// *** @attention - Assumes: num_vectors is the length of vectors. -// *** @attention - Assumes: num_clusters is the length of labels. -// *** -// *** @attention - Issue: At larger numbers of clustering iterations, some -// *** clusters have a size of negative infinity. In this implementation, -// *** the bug is mitigated by setting a small number of max iterations, -// *** such as 16 instead of 100. -// *** @attention - Issue: Clusters do not apear to improve much after the first -// *** iteration, which puts the efficacy of the algorithm into question. This -// *** may be due to the uneven density of a typical dataset. However, the -// *** clusters still offer useful information. -// *** -// *** Complexity: -// *** -// *** - `O(kd + k + i*(k + n*(k+d) + kd))` -// *** -// *** - `O(kd + k + ik + ink + ind + ikd)` -// *** -// *** - `O(nk + nd)` -// ***/ -// void exp_fn_kmeans( -// int** vectors, -// const unsigned int num_vectors, -// unsigned int* labels, -// const unsigned int num_clusters, -// const unsigned int max_iter -// ) -// { -// // const size_t centroids_size = num_clusters * sizeof(double*); -// // const size_t centroid_size = EXP_NUM_DIMS * sizeof(double); -// // double** centroids = (double**)nmMalloc(centroids_size); -// // if (centroids == NULL) -// // { -// // fprintf(stderr, "exp_fn_kmeans() - nmMalloc(%u) failed.\n", centroids_size); -// // return; -// // } -// // for (int i = 0; i < num_clusters; i++) -// // { -// // double* centroid = centroids[i] = (double*)nmMalloc(centroid_size); -// // if (centroid == NULL) -// // { -// // fprintf(stderr, "exp_fn_kmeans() - nmMalloc(%u) failed.\n", centroid_size); -// // return; -// // } -// // memset(centroids[i], 0, centroid_size); -// // } -// double centroids[num_clusters][EXP_NUM_DIMS]; -// memset(centroids, 0, sizeof(centroids)); - -// /** Select random vectors to use as the initial centroids. **/ -// srand(time(NULL)); -// for (unsigned int i = 0u; i < num_clusters; i++) -// { -// // Pick a random vector. -// const unsigned int random_index = (unsigned int)rand() % num_vectors; - -// // Sparse copy the vector into a densely allocated centroid. -// double* centroid = centroids[i]; -// const int* vector = vectors[random_index]; -// for (unsigned int i = 0u, dim = 0u; dim < EXP_NUM_DIMS;) -// { -// const int token = vector[i++]; -// if (token > 0) centroid[dim++] = (double)token; -// else for (unsigned int j = 0u; j < -token; j++) centroid[dim++] = 0.0; -// } -// } - -// /** Allocate memory for new centroids. **/ -// double new_centroids[num_clusters][EXP_NUM_DIMS]; - -// /** Main exp_fn_kmeans loop. **/ -// double old_average_cluster_size = 1.0; -// unsigned int cluster_counts[num_clusters]; -// for (unsigned int iter = 0u; iter < max_iter; iter++) -// { -// bool changed = false; - -// /** Reset new centroids. **/ -// for (unsigned int i = 0u; i < num_clusters; i++) -// { -// cluster_counts[i] = 0u; -// for (unsigned int dim = 0; dim < EXP_NUM_DIMS; dim++) -// new_centroids[i][dim] = 0.0; -// } - -// /** Assign each point to the nearest centroid. **/ -// for (unsigned int i = 0u; i < num_vectors; i++) -// { -// const int* vector = vectors[i]; -// double min_dist = DBL_MAX; -// unsigned int best_centroid_label = 0u; - -// // Find nearest centroid. -// for (unsigned int j = 0u; j < num_clusters; j++) -// { -// const double dist = exp_fn_sparse_dif_c(vector, centroids[j]); -// if (dist < min_dist) -// { -// min_dist = dist; -// best_centroid_label = j; -// } -// } - -// /** Update label to new centroid, if necessary. **/ -// if (labels[i] != best_centroid_label) -// { -// labels[i] = best_centroid_label; -// changed = true; -// } - -// /** Accumulate values for new centroid calculation. **/ -// double* best_centroid = new_centroids[best_centroid_label]; -// for (unsigned int i = 0u, dim = 0u; dim < EXP_NUM_DIMS;) -// { -// const int val = vector[i++]; -// if (val < 0) dim += (unsigned)(-val); -// else best_centroid[dim++] += (double)val; -// } -// cluster_counts[best_centroid_label]++; -// } - -// /** Stop if centroids didn't change. **/ -// if (!changed) break; - -// /** Update centroids. **/ -// for (unsigned int i = 0u; i < num_clusters; i++) -// { -// if (cluster_counts[i] == 0u) continue; -// double* centroid = centroids[i]; -// const double* new_centroid = new_centroids[i]; -// const unsigned int cluster_count = cluster_counts[i]; -// for (unsigned int dim = 0u; dim < EXP_NUM_DIMS; dim++) -// centroid[dim] = new_centroid[dim] / cluster_count; -// } - -// /** Print cluster size for debugging. **/ -// const double average_cluster_size = exp_fn_get_cluster_size(vectors, num_vectors, labels, centroids, num_clusters); - -// /** Is there enough improvement? **/ -// const double improvement = old_average_cluster_size - average_cluster_size; -// if (improvement < KMEANS_IMPROVEMENT_THRESHOLD) break; -// old_average_cluster_size = average_cluster_size; -// } - -// // Free unused memory. -// // for (int i = 0; i < num_clusters; i++) { -// // nmFree(centroids[i], centroid_size); -// // } -// // nmFree(centroids, centroids_size); -// } - -// /** Duplocate information. **/ -// typedef struct -// { -// unsigned int id1; -// unsigned int id2; -// double similarity; -// } -// Dup, *pDup; - -// /*** Runs complete search to find duplocates if `num_vectors < MAX_COMPLETE_SEARCH` -// *** and runs a search using k-means clustering on larger amounts of data. -// *** -// *** @param vectors Array of precomputed frequency vectors for all dataset strings. -// *** @param num_vectors The number of vectors to be scanned. -// *** @param dupe_threshold The similarity threshold, below which dups are ignored. -// *** @returns The duplicates in pDup structs. -// ***/ -// pXArray lightning_search(int** vectors, const unsigned int num_vectors, const double dupe_threshold) -// { -// /** Allocate space for dups. **/ -// const size_t guess_size = num_vectors * 2u; -// pXArray dups = xaNew(guess_size); -// if (dups == NULL) -// { -// mssErrorf(1, "EXP", "lightning_search() - xaNew(%lu) failed.", guess_size); -// return NULL; -// } - -// /** Descide which algorithm to use. **/ -// if (num_vectors <= MAX_COMPLETE_SEARCH) -// { /** Do a complete search. **/ -// for (unsigned int i = 0u; i < num_vectors; i++) -// { -// const int* v1 = vectors[i]; -// for (unsigned int j = i + 1u; j < num_vectors; j++) -// { -// const int* v2 = vectors[j]; -// const double similarity = exp_fn_sparse_similarity(v1, v2); -// if (similarity > dupe_threshold) // Dup found! -// { -// Dup* dup = (Dup*)nmMalloc(sizeof(Dup)); -// if (dup == NULL) -// { -// mssErrorf(1, "EXP", "lightning_search() - nmMalloc(%lu) failed.", sizeof(Dup)); -// goto err_free_dups; -// } - -// dup->id1 = i; -// dup->id2 = j; -// dup->similarity = similarity; -// xaAddItem(dups, (void*)dup); -// } -// } -// } -// } -// else -// { /** Do a k-means search. **/ -// /** Define constants for the algorithm. **/ -// const unsigned int max_iter = 64u; /** Hardcode value because idk. **/ -// const unsigned int num_clusters = exp_fn_compute_k(num_vectors); - -// /** Allocate static memory for finding clusters. **/ -// unsigned int labels[num_vectors]; -// memset(labels, 0u, sizeof(labels)); - -// /** Execute kmeans clustering. **/ -// exp_fn_kmeans(vectors, num_vectors, labels, num_clusters, max_iter); - -// /** Find duplocates in clusters. **/ -// for (unsigned int i = 0u; i < num_vectors; i++) -// { -// const int* v1 = vectors[i]; -// const unsigned int label = labels[i]; -// for (unsigned int j = i + 1u; j < num_vectors; j++) -// { -// if (labels[j] != label) continue; -// const int* v2 = vectors[j]; -// const double similarity = exp_fn_sparse_similarity(v1, v2); -// if (similarity > dupe_threshold) /* Dup found! */ -// { -// Dup* dup = (Dup*)nmMalloc(sizeof(Dup)); -// if (dup == NULL) -// { -// mssErrorf(1, "EXP", -// "lightning_search() - nmMalloc(%lu) failed.", -// sizeof(Dup) -// ); -// goto err_free_dups; -// } - -// dup->id1 = i; -// dup->id2 = j; -// dup->similarity = similarity; -// xaAddItem(dups, (void*)dup); -// } -// } -// } -// } - -// /** Done **/ -// return dups; - -// /** Free dups. **/ -// err_free_dups:; -// const size_t num_dups = dups->nItems; -// for (unsigned int i = 0u; i < num_dups; i++) -// { -// nmFree(dups->Items[i], sizeof(Dup)); -// dups->Items[i] = NULL; -// } -// xaDeInit(dups); -// return NULL; -// } - -// /*** Computes Levenshtein distance between two strings. -// *** -// *** @param str1 The first string. -// *** @param str2 The second string. -// *** @param length1 The length of the first string. -// *** @param length1 The length of the first string. -// *** -// *** @attention - Tip: Pass 0 for the length of either string to infer it -// *** using the null terminating character. Thus, strings with no null -// *** terminator are supported if you pass explicit lengths. -// *** -// *** Complexity: O(length1 * length2). -// *** -// *** @see centrallix-sysdoc/string_comparison.md -// ***/ -// unsigned int exp_fn_edit_dist(const char* str1, const char* str2, const size_t str1_length, const size_t str2_length) -// { -// /*** lev_matrix: -// *** For all i and j, d[i][j] will hold the Levenshtein distance between -// *** the first i characters of s and the first j characters of t. -// *** -// *** As they say, no dynamic programming algorithm is complete without a -// *** matrix that you fill out and it has the answer in the final location. -// ***/ -// const size_t str1_len = (str1_length == 0u) ? strlen(str1) : str1_length; -// const size_t str2_len = (str2_length == 0u) ? strlen(str2) : str2_length; -// unsigned int lev_matrix[str1_len + 1][str2_len + 1]; - -// /*** Base case #0: -// *** Transforming an empty string into an empty string has 0 cost. -// ***/ -// lev_matrix[0][0] = 0u; - -// /*** Base case #1: -// *** Any source prefixe can be transformed into an empty string by -// *** dropping each character. -// ***/ -// for (unsigned int i = 1u; i <= str1_len; i++) -// lev_matrix[i][0] = i; - -// /*** Base case #2: -// *** Any target prefixes can be transformed into an empty string by -// *** inserting each character. -// ***/ -// for (unsigned int j = 1u; j <= str2_len; j++) -// lev_matrix[0][j] = j; - -// /** General Case **/ -// for (unsigned int i = 1u; i <= str1_len; i++) -// { -// for (unsigned int j = 1u; j <= str2_len; j++) -// { -// /** Equal characters need no changes. **/ -// if (str1[i - 1] == str2[j - 1]) -// lev_matrix[i][j] = lev_matrix[i - 1][j - 1]; - -// /*** We need to make a change, so use the opereration with the -// *** lowest cost out of delete, insert, replace, or swap. -// ***/ -// else -// { -// unsigned int cost_delete = lev_matrix[i - 1][j] + 1u; -// unsigned int cost_insert = lev_matrix[i][j - 1] + 1u; -// unsigned int cost_replace = lev_matrix[i-1][j-1] + 1u; - -// /** If a swap is possible, calculate the cost. **/ -// bool can_swap = ( -// i > 1 && j > 1 && -// str1[i - 1] == str2[j - 2] && -// str1[i - 2] == str2[j - 1] -// ); -// unsigned int cost_swap = (can_swap) ? lev_matrix[i - 2][j - 2] + 1 : UINT_MAX; - -// // Find the best operation. -// lev_matrix[i][j] = min(min(min(cost_delete, cost_insert), cost_replace), cost_swap); -// } -// } -// } - -// return lev_matrix[str1_len][str2_len]; -// } - -// /*** Runs complete search to find duplocates in phone numbers using the -// *** levenshtein min edit distance algorithm. -// *** -// *** @param dataset An array of characters for all dataset strings. -// *** @param dataset_size The number of phone numbers to be scanned. -// *** @param dupe_threshold The similarity threshold, below which dups are ignored. -// *** @returns The duplicates in pDup structs. -// ***/ -// pXArray phone_search(char dataset[][10u], const unsigned int dataset_size, const double dupe_threshold) -// { -// /** Allocate space for dups. **/ -// const size_t guess_size = dataset_size * 2u; -// pXArray dups = xaNew(guess_size); -// if (dups == NULL) -// { -// mssErrorf(1, "EXP", "phone_search() - xaNew(%lu) failed.", guess_size); -// return NULL; -// } - -// /** Search for dups using edit distance. **/ -// for (unsigned int i = 0u; i < dataset_size; i++) -// { -// const char* v1 = dataset[i]; -// for (unsigned int j = i + 1u; j < dataset_size; j++) -// { -// const char* v2 = dataset[j]; -// const unsigned int dist = exp_fn_edit_dist(v1, v2, 10u, 10u); -// const double similarity = (double)dist / 10.0; -// if (similarity > dupe_threshold) /* Dup found! */ -// { -// Dup* dup = (Dup*)nmMalloc(sizeof(Dup)); -// if (dup == NULL) -// { -// mssErrorf(1, "EXP", "phone_search() - nmMalloc(%lu) failed.", sizeof(Dup)); - -// /** Free data before returning. **/ -// const size_t num_dups = dups->nItems; -// for (unsigned int i = 0u; i < num_dups; i++) -// { -// void* dup = dups->Items[i]; -// nmFree(dup, sizeof(Dup)); -// } -// xaDeInit(dups); -// return NULL; -// } - -// dup->id1 = i; -// dup->id2 = j; -// dup->similarity = similarity; -// xaAddItem(dups, (void*)dup); -// } -// } -// } - -// return dups; -// } - -// /*** Usage: get_dups(, , ) -// *** data is assumed to contain only the following characters: -// *** (Data containing ` or control characters is undefined.) -// *** \n\v\f\r 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghij -// *** klmnopqrstuvwxyz!"#$%&'()*+,-./:;<=>?@[\]^_{|}~ -// ***/ -// int exp_fn_get_dups_general(pExpression tree, pParamObjects objlist, pExpression maybe_dup_threshold, pExpression maybe_out_file_path, pExpression maybe_data, const char* fn_name, bool is_phone_numbers) -// { -// /** Check number of arguments. **/ -// if (!maybe_dup_threshold || !maybe_out_file_path || !maybe_data) -// { -// mssErrorf(1, "EXP", "%s(?) expects 3 parameters.", fn_name); -// return -1; -// } -// const int num_params = tree->Children.nItems; -// if (num_params != 3) -// { -// mssErrorf(1, "EXP", "%s(?) expects 3 parameter, got %d.", fn_name, num_params); -// return -1; -// } - -// /** Magic checks. **/ -// ASSERTMAGIC(tree, MGK_EXPRESSION); -// ASSERTMAGIC(maybe_dup_threshold, MGK_EXPRESSION); -// ASSERTMAGIC(maybe_out_file_path, MGK_EXPRESSION); -// ASSERTMAGIC(maybe_data, MGK_EXPRESSION); - -// /** Check object list. **/ -// if (!objlist) -// { -// mssErrorf(1, "EXP", "%s(\?\?\?) no object list?", fn_name); -// return -1; -// } -// ASSERTMAGIC(objlist->Session, MGK_OBJSESSION); - -// /** Extract dup_threshold. **/ -// if (maybe_dup_threshold->Flags & EXPR_F_NULL) -// { -// mssErrorf(1, "EXP", "%s(NULL, ...) dup_threshold cannot be NULL.", fn_name); -// return -1; -// } -// if (maybe_dup_threshold->DataType != DATA_T_DOUBLE) -// { -// mssErrorf(1, "EXP", "%s(?, ...) dup_threshold must be a doube.", fn_name); -// return -1; -// } -// double dup_threshold = maybe_dup_threshold->Types.Double; -// if (isnan(dup_threshold)) -// { -// mssErrorf(1, "EXP", "%s(NAN, ...) dup_threshold cannot be NAN.", fn_name); -// return -1; -// } -// if (dup_threshold <= 0 || 1 <= dup_threshold) -// { -// mssErrorf(1, "EXP", -// "%s(%lg, ...) dup_threshold must be between 0 and 1 (exclusive).", -// fn_name, dup_threshold -// ); -// return -1; -// } - -// /** Extract output file path. **/ -// if (maybe_out_file_path->Flags & EXPR_F_NULL) -// { -// mssErrorf(1, "EXP", -// "%s(%lg, NULL, ...) out_file_path cannot be NULL.", -// fn_name, dup_threshold -// ); -// return -1; -// } -// if (maybe_out_file_path->DataType != DATA_T_STRING) -// { -// mssErrorf(1, "EXP", -// "%s(%lg, \?\?\?, ...) out_file_path should be a string.", -// fn_name, dup_threshold -// ); -// return -1; -// } -// char* out_file_path = maybe_out_file_path->String; -// if (out_file_path == NULL) -// { -// mssErrorf(1, "EXP", -// "%s(%lg, nothing?, ...) expected string from out_file_path " -// "(of type DataType = DATA_T_STRING), but the String was NULL " -// "or did not exist!", -// fn_name, dup_threshold -// ); -// return -1; -// } -// size_t out_path_len = strlen(out_file_path); -// if (out_path_len == 0u) -// { -// mssErrorf(1, "EXP", -// "%s(%lg, \"%s\", ...) out_file_path cannot be an empty string.", -// fn_name, dup_threshold, out_file_path -// ); -// return -1; -// } -// const size_t max_len = BUFSIZ - 48u; -// if (out_path_len >= max_len) -// { -// mssErrorf(1, "EXP", -// "%s(%lg, \"%s\", ...) out_file_path length (%lu) > max length (%lu).", -// fn_name, dup_threshold, out_file_path, out_path_len, max_len -// ); -// return -1; -// } -// if (strncmp(out_file_path + (out_path_len - 4u), ".csv", 4u) != 0) -// { -// mssErrorf(1, "EXP", -// "%s(%lg, \"%s\", ...) out_file_path must end in .csv, " -// "because the output file is a csv.", -// fn_name, dup_threshold, out_file_path -// ); -// return -1; -// } - -// /** Extract dataset string. **/ -// if (maybe_data->Flags & EXPR_F_NULL) -// { -// mssErrorf(1, "EXP", -// "%s(%lg, \"%s\", NULL) data cannot be NULL.", -// fn_name, dup_threshold, out_file_path -// ); -// return -1; -// } -// if (maybe_data->DataType != DATA_T_STRING) -// { -// mssErrorf(1, "EXP", -// "%s(%lg, \"%s\", \?\?\?) data must be a string.", -// fn_name, dup_threshold, out_file_path -// ); -// return -1; -// } -// char* data = maybe_data->String; -// if (data == NULL) -// { -// mssErrorf(1, "EXP", -// "%s(%lg, \"%s\", \?\?\?) expected string from data " -// "(of type DataType = DATA_T_STRING), but the String " -// "was NULL or did not exist!", -// fn_name, dup_threshold, out_file_path -// ); -// return -1; -// } -// if (strlen(data) == 0u) -// { -// mssErrorf(1, "EXP", -// "%s(%lg, \"%s\", \"%s\") data cannot be an empty string.", -// fn_name, dup_threshold, out_file_path, data -// ); -// return -1; -// } - -// /** Check number of entries in the dataset. **/ -// size_t dataset_size = 1; -// for (char* buf = data; *buf != '\0'; buf++) -// if (*buf == SEPARATOR_CHAR) dataset_size++; - -// /** Verify dataset is reasonable size. **/ -// if (dataset_size == 1) -// { -// mssErrorf(1, "EXP", -// "%s(%lg, \"%s\", \"\?\?\?\") Expected data to contain multiple " -// "values separated by \""SEPARATOR"\", but data was: \"%s\"", -// fn_name, dup_threshold, out_file_path, data -// ); -// return -1; -// } - -// /** Parse strs out of the data into the dataset. **/ -// size_t count = 0u; -// char* token = strtok(data, SEPARATOR); -// char* dataset[dataset_size]; -// memset(dataset, 0, sizeof(dataset)); -// while (token && count < dataset_size) -// { -// char* new_token = strdup(token); -// if (new_token == NULL) -// { -// mssErrorf(1, "EXP", -// "%s(%lg, \"%s\", \"...\") Failed to copy token \"%s\" from data.", -// fn_name, dup_threshold, out_file_path, token -// ); -// goto err_free_dataset; -// } -// dataset[count++] = new_token; -// token = strtok(NULL, SEPARATOR); -// } - -// /** Allocate memory to store dups. **/ -// pXArray dups; - -// /** Handle phone numbers. **/ -// if (is_phone_numbers) -// { -// /*** Phone number strings are always 10 characters long. Thus, they -// *** are NOT NULL TERMINATED because we can assume the length. -// ***/ -// unsigned int num_phone_numbers = 0u; -// char phone_numbers[dataset_size][10u]; - -// /** Parse the dataset. **/ -// for (unsigned int i = 0u; i < dataset_size; i++) -// { -// char* maybe_phone_number = dataset[i]; - -// /** Verify length can be a valid phone number. **/ -// const size_t len = strlen(maybe_phone_number); -// if (len < 10u) -// { -// mssErrorf(1, "EXP", -// "%s(%lg, \"%s\", \"...\") \"Phone number\" (\"%s\") is too short. (skipped)", -// fn_name, dup_threshold, out_file_path, maybe_phone_number -// ); -// continue; -// } -// if (len > 18u) -// { -// mssErrorf(1, "EXP", -// "%s(%lg, \"%s\", \"...\") \"Phone number\" (\"%s\") is too long. (skipped)", -// fn_name, dup_threshold, out_file_path, maybe_phone_number -// ); -// continue; -// } - -// /** Parse phone number. **/ -// char buf[11u], cur_char = maybe_phone_number[0]; -// unsigned int j = ((cur_char == '+') ? 2u : -// ((cur_char == '1') ? 1u : 0u)); -// unsigned int number_len = 0u; -// while (cur_char != '\0' && number_len <= 10u) -// { -// cur_char = maybe_phone_number[j]; - -// if ( -// cur_char == '-' || -// cur_char == ' ' || -// cur_char == '(' || -// cur_char == ')' -// ) continue; -// else if (!isdigit(cur_char)) -// { -// /** Unknown character. **/ -// mssErrorf(1, "EXP", -// "%s(%lg, \"%s\", \"...\") \"Phone number\" (\"%s\") contains unexpected character '%c'. (skipped)", -// fn_name, dup_threshold, out_file_path, maybe_phone_number, cur_char -// ); -// goto next_phone_number; -// } - -// /** Add the character to the phone number. */ -// buf[number_len] = cur_char; -// number_len++; - -// /** Advance to next number. **/ -// j++; -// } - -// /** Check number of digits. **/ -// if (number_len < 10u) -// { -// mssErrorf(1, "EXP", -// "%s(%lg, \"%s\", \"...\") \"Phone number\" (\"%s\") has less than 10 digits. (skipped)", -// fn_name, dup_threshold, out_file_path, maybe_phone_number -// ); -// continue; -// } -// if (number_len > 10u) -// { -// mssErrorf(1, "EXP", -// "%s(%lg, \"%s\", \"...\") \"Phone number\" (\"%s\") has more than 10 digits. (skipped)", -// fn_name, dup_threshold, out_file_path, maybe_phone_number -// ); -// continue; -// } - -// /** Copy valid phone number (with no null-terminator). **/ -// memcpy(phone_numbers[num_phone_numbers++], buf, 10u); - -// next_phone_number:; -// } - -// /** Invoke phone number search to find dups in the processed data. **/ -// dups = phone_search(phone_numbers, num_phone_numbers, dup_threshold); -// } - -// /** Handle text. **/ -// else -// { -// /** Build vectors from the strs in the dataset. **/ -// const size_t vectors_size = dataset_size * sizeof(int*); -// int** vectors = (int**)nmMalloc(vectors_size); -// if (vectors == NULL) -// { -// mssErrorf(1, "EXP", -// "%s(%lg, \"%s\", \"...\") - nmMalloc(%lu) failed.", -// fn_name, dup_threshold, out_file_path, vectors_size -// ); -// goto err_free_dataset; -// } -// for (size_t i = 0; i < dataset_size; i++) -// { -// const int* vector = vectors[i] = build_vector(dataset[i]); -// if (vector == NULL) -// { -// mssErrorf(1, "EXP", -// "%s(%lg, \"%s\", \"...\") - build_vector(%s) failed.", -// fn_name, dup_threshold, out_file_path, dataset[i] -// ); -// goto err_free_vectors; -// } -// if (vector[0] == -EXP_NUM_DIMS) { -// mssErrorf(1, "EXP", -// "%s(%lg, \"%s\", \"...\") - build_vector(%s) produced no character pairs.", -// fn_name, dup_threshold, out_file_path, dataset[i] -// ); -// goto err_free_vectors; -// } -// } - -// /** Invoke lightning search to find dups using the vectors. **/ -// dups = lightning_search(vectors, dataset_size, dup_threshold); -// if (dups == NULL) { -// mssErrorf(1, "EXP", -// "%s(%lg, \"%s\", \"...\") - lightning_search() failed.", -// fn_name, dup_threshold, out_file_path -// ); -// goto err_free_vectors; -// } - -// /** Free unused memory. **/ -// for (size_t i = 0; i < dataset_size; i++) -// { -// nmSysFree(vectors[i]); -// vectors[i] = NULL; -// } -// nmFree(vectors, vectors_size); -// vectors = NULL; -// goto search_done; - -// /** Free vectors, if needed. **/ -// err_free_vectors: -// if (vectors != NULL) -// { -// for (size_t i = 0; i < dataset_size; i++) -// { -// if (vectors[i] == NULL) break; -// nmSysFree(vectors[i]); -// vectors[i] = NULL; -// } -// nmFree(vectors, vectors_size); -// vectors = NULL; -// } -// goto err_free_dataset; - -// search_done:; -// } - -// /** Check number of dups found. **/ -// const int num_dups = dups->nItems; - -// // Hack where we hardcode the path to the root directory because trying to -// // track it down is way too hard. -// const char root_path[] = "/usr/local/src/cx-git/centrallix-os"; - -// /** Create output file path. **/ -// char out_path[BUFSIZ]; -// snprintf(memset(out_path, 0, sizeof(out_path)), sizeof(out_path), "%s/%s", root_path, out_file_path); - -// /** Write output file. **/ -// FILE* file = fopen(out_path, "w"); -// if (file == NULL) -// { -// perror("Failed to open file."); -// mssErrorf(1, "EXP", -// "%s(%lg, \"...\", ...) failed to open file: %s", -// fn_name, dup_threshold, out_path -// ); -// goto err_free_dups; -// } -// const int setvbuf_ret = setvbuf(file, NULL, _IOFBF, (1000 * 1000)); -// if (setvbuf_ret != 0) -// { -// perror("Failed to set buffering on file."); -// mssErrorf(1, "EXP", -// "%s(%lg, \"...\", ...) failed to set buffering on file: %d, %s", -// fn_name, dup_threshold, setvbuf_ret, out_path -// ); -// goto err_close_file; -// } - -// /** Write CSV header. **/ -// fprintf(file, "id1,id2,sim\n"); - -// /*** If no data was written, make sure there is at least one row in the -// *** output file since assuming this file has data makes the sql faster. -// ***/ -// if (num_dups == 0u) -// fprintf(file, "error,undefined,0.0\n"); - -// /** Write CSV data rows. **/ -// else -// { -// for (unsigned int i = 0u; i < num_dups; i++) -// { -// Dup* data = (Dup*)dups->Items[i]; -// fprintf(file, "%s,%s,%.8lf\n", dataset[data->id1], dataset[data->id2], data->similarity); -// nmFree(data, sizeof(Dup)); /* Free unused data. */ -// dups->Items[i] = NULL; -// } -// } - -// /** Free unused data. **/ -// for (unsigned int i = 0u; i < dataset_size; i++) -// { -// free(dataset[i]); -// dataset[i] = NULL; -// } -// xaDeInit(dups); -// dups = NULL; - -// /** Close file. **/ -// const int fclose_ret = fclose(file); -// if (fclose_ret != 0) -// { -// perror("Failed to close file."); -// mssErrorf(1, "EXP", -// "%s(%lg, \"...\") failed to close file: %d, %s", -// fn_name, dup_threshold, fclose_ret, out_path -// ); -// goto err_free_dataset; -// } -// file = NULL; - -// /** Success. **/ -// tree->DataType = DATA_T_INTEGER; -// tree->Integer = (int)num_dups; -// return 0; - -// /** Error cases. **/ - -// /** Close file, if needed. **/ -// err_close_file: -// if (file != NULL) -// { -// const int fclose_ret = fclose(file); -// if (fclose_ret != 0) -// { -// char dbl_buf[DBL_BUF_SIZE]; -// snprintf(dbl_buf, sizeof(dbl_buf), "%lg", dup_threshold); -// perror("Failed to close file."); -// mssErrorf(1, "EXP", -// "%s(%s, \"...\") failed to close file: %d, %s", -// fn_name, dbl_buf, fclose_ret, out_path -// ); -// } -// } - -// /** Free dups, if needed. **/ -// err_free_dups: -// if (dups != NULL) -// { -// for (unsigned int i = 0u; i < num_dups; i++) -// { -// nmFree(dups->Items[i], sizeof(Dup)); -// dups->Items[i] = NULL; -// } -// xaDeInit(dups); -// dups = NULL; -// } - -// /** Free dataset, if needed. **/ -// err_free_dataset: -// for (unsigned int i = 0u; i < dataset_size; i++) -// { -// if (dataset[i] == NULL) break; -// free(dataset[i]); -// dataset[i] = NULL; -// } - -// return -1; -// } - -// int exp_fn_get_dups(pExpression tree, pParamObjects objlist, pExpression p1, pExpression p2, pExpression p3) -// { -// return exp_fn_get_dups_general(tree, objlist, p1, p2, p3, "get_dups", false); -// } - -// int exp_fn_get_dups_phone(pExpression tree, pParamObjects objlist, pExpression p1, pExpression p2, pExpression p3) -// { -// return exp_fn_get_dups_general(tree, objlist, p1, p2, p3, "get_dups_phone", true); -// } - -// /** Magic values. **/ -// #define EXP_NUM_FIELDS 7 -// #define EXP_INDEX_FIRST_NAME 0 -// #define EXP_INDEX_FIRST_NAME_METAPHONE 1 -// #define EXP_INDEX_LAST_NAME 2 -// #define EXP_INDEX_LAST_NAME_METAPHONE 3 -// #define EXP_INDEX_EMAIL 4 -// #define EXP_INDEX_PHONE 5 -// #define EXP_INDEX_ADDRESS 6 - -// /** No-op function. **/ -// int exp_fn_do_nothing() { return 0; } - -// /*** Function to add parameters to private storage so that more than 3 parameters can be passed. -// *** Currently, doubles are the only supported param type. -// *** -// *** Usage: param(, , ) : R, -// *** where: V : Double -// *** -// *** @param tree Return param_value. -// *** @param objlist Function scope. -// *** @param maybe_array The 1st param, should be NULL or another call to param(). -// *** @param maybe_param_name The 2nd param, should be a string for the name of the param. -// *** @param maybe_param_value The 3rd param, should be the param_value of the param being set. -// ***/ -// int exp_fn_param(pExpression tree, pParamObjects objlist, pExpression maybe_param_name, pExpression maybe_param_value, pExpression maybe_array) { -// // Verify arg number. -// if (!maybe_param_name || !maybe_param_value) -// { -// mssErrorf(1, "EXP", "param(?) expects two or three parameters."); -// return -1; -// } - -// // Magic checks. -// ASSERTMAGIC(tree, MGK_EXPRESSION); -// ASSERTMAGIC(maybe_param_name, MGK_EXPRESSION); -// ASSERTMAGIC(maybe_param_value, MGK_EXPRESSION); -// ASSERTMAGIC(maybe_array, MGK_EXPRESSION); - -// // Check object list. -// if (!objlist) -// { -// mssErrorf(1, "EXP", "param(\?\?\?) no object list?"); -// return -1; -// } -// ASSERTMAGIC(objlist->Session, MGK_OBJSESSION); - -// // Extract param name. -// if (maybe_param_name->Flags & EXPR_F_NULL) -// { -// mssErrorf(1, "EXP", "param(NULL, ...) param_name cannot be null."); -// return -1; -// } -// if (maybe_param_name->DataType != DATA_T_STRING) -// { -// mssErrorf(1, "EXP", "param(?, ...) param_name must be a string."); -// return -1; -// } -// const char* param_name = maybe_param_name->String; - -// // Extract param value. -// if (maybe_param_value->Flags & EXPR_F_NULL) -// { -// mssErrorf(1, "EXP", "param(\"%s\", NULL, ...) param_value cannot be null.", param_name); -// return -1; -// } -// if (maybe_param_value->DataType != DATA_T_DOUBLE) -// { -// mssErrorf(1, "EXP", "param(\"%s\", ?, ...) param_value must be a doube.", param_name); -// return -1; -// } -// double param_value = maybe_param_value->Types.Double; - -// // Verify the value being set. -// // TODO: Replace with hashmap. -// signed int index = -1; -// if (strcmp(param_name, "first_name") == 0) index = EXP_INDEX_FIRST_NAME; -// else if (strcmp(param_name, "first_name_metaphone") == 0) index = EXP_INDEX_FIRST_NAME_METAPHONE; -// else if (strcmp(param_name, "last_name") == 0) index = EXP_INDEX_LAST_NAME; -// else if (strcmp(param_name, "last_name_metaphone") == 0) index = EXP_INDEX_LAST_NAME_METAPHONE; -// else if (strcmp(param_name, "email") == 0) index = EXP_INDEX_EMAIL; -// else if (strcmp(param_name, "phone") == 0) index = EXP_INDEX_PHONE; -// else if (strcmp(param_name, "address") == 0) index = EXP_INDEX_ADDRESS; -// if (index == -1) -// { -// mssErrorf(1, "EXP", -// "param(\"%s\", %lf, ...) invalid field name %s.", -// param_name, param_value, param_name -// ); -// return -1; -// } - -// // Extract array. -// double* array; -// if (!maybe_array || maybe_array->Flags & EXPR_F_NULL) -// { -// const size_t size = EXP_NUM_FIELDS * sizeof(double); -// void* PrivateData = tree->PrivateData = memset(nmSysMalloc(size), 0, size); -// tree->PrivateDataFinalize = exp_fn_do_nothing; // DON'T FREE MY DATA UNTIL I'M READY. - -// array = (double*)PrivateData; -// for (unsigned int i = 0u; i < EXP_NUM_FIELDS; i++) array[i] = NAN; -// } -// else if ( -// maybe_array->DataType == DATA_T_ARRAY && -// maybe_array->PrivateData != NULL && -// !strcmp(maybe_array->Name, "param") -// ) -// { -// tree->PrivateData = maybe_array->PrivateData; -// tree->PrivateDataFinalize = exp_fn_do_nothing; // DON'T FREE MY DATA UNTIL I'M READY. -// array = (double*)maybe_array->PrivateData; -// } -// else -// { -// mssErrorf(1, "EXP", "param(\"%s\", %lf, ...) if provided, array must be from a call to param().", param_name, param_value); -// return -1; -// } - -// // Warn on previous data. -// double old_value = array[index]; -// if (!isnan(old_value)) -// { -// fprintf(stderr, -// "Warning: Overwriting field '%s'(@ index %d) with %lf (was %lf).\n", -// param_name, index, param_value, old_value -// ); -// } - -// // Set param_value. -// array[index] = param_value; - -// // Done -// tree->DataType = DATA_T_ARRAY; -// tree->Integer = 0; -// tree->Types.Double = 0.0; -// return 0; -// } - -// int exp_fn_get_sim(pExpression tree, pParamObjects objlist, pExpression maybe_fields, pExpression unused1, pExpression unused2) -// { -// if (!maybe_fields || unused1 || unused2) -// { -// mssErrorf(1, "EXP", "get_sim(param(...)) expects one parameter, from param()."); -// return -1; -// } - -// // Magic checks. -// ASSERTMAGIC(tree, MGK_EXPRESSION); -// ASSERTMAGIC(maybe_fields, MGK_EXPRESSION); - -// // Check object list. -// if (!objlist) -// { -// mssErrorf(1, "EXP", "get_sim(\?\?\?) no object list?"); -// return -1; -// } -// ASSERTMAGIC(objlist->Session, MGK_OBJSESSION); - -// // Verify arg. -// if (maybe_fields->Flags & EXPR_F_NULL) -// { -// mssErrorf(1, "EXP", "get_sim(NULL) fields from param() cannot be NULL."); -// return -1; -// } -// if (maybe_fields->DataType != DATA_T_ARRAY || maybe_fields->PrivateData == NULL) -// { -// mssErrorf(1, "EXP", "get_sim(\?\?\?) expects arg 0 to be fields from a call to param()."); -// return -1; -// } - -// // Extract arg(s?). -// double* fields = (double*)maybe_fields->PrivateData; - -// const double first_name = fields[EXP_INDEX_FIRST_NAME]; -// if (isnan(first_name)) -// { -// mssErrorf(1, "EXP", "get_sim(...) first_name similarity not set."); -// return -1; -// } - -// const double first_name_metaphone = fields[EXP_INDEX_FIRST_NAME_METAPHONE]; -// if (isnan(first_name_metaphone)) -// { -// mssErrorf(1, "EXP", "get_sim(...) first_name_metaphone similarity not set."); -// return -1; -// } - -// const double last_name = fields[EXP_INDEX_LAST_NAME]; -// if (isnan(last_name)) -// { -// mssErrorf(1, "EXP", "get_sim(...) last_name similarity not set."); -// return -1; -// } - -// const double last_name_metaphone = fields[EXP_INDEX_LAST_NAME_METAPHONE]; -// if (isnan(last_name_metaphone)) -// { -// mssErrorf(1, "EXP", "get_sim(...) last_name_metaphone similarity not set."); -// return -1; -// } - -// const double email = fields[EXP_INDEX_EMAIL]; -// if (isnan(email)) -// { -// mssErrorf(1, "EXP", "get_sim(...) email similarity not set."); -// return -1; -// } - -// const double phone = fields[EXP_INDEX_PHONE]; -// if (isnan(phone)) -// { -// mssErrorf(1, "EXP", "get_sim(...) phone similarity not set."); -// return -1; -// } - -// const double address = fields[EXP_INDEX_ADDRESS]; -// if (isnan(address)) -// { -// mssErrorf(1, "EXP", "get_sim(...) address similarity not set."); -// return -1; -// } - -// char* primary; -// char* secondary; -// meta_double_metaphone("text", &primary, &secondary); -// printf("Primary: %s, secondary: %s\n", primary, secondary); - -// // Print args. -// printf( -// "Sims:\n" -// "\tfirst_name: %lf\n" -// "\tfirst_name_metaphone: %lf\n" -// "\tlast_name: %lf\n" -// "\tlast_name_metaphone: %lf\n" -// "\temail: %lf\n" -// "\tphone: %lf\n" -// "\taddress: %lf\n", -// first_name, -// first_name_metaphone, -// last_name, -// last_name_metaphone, -// email, -// phone, -// address -// ); - -// // Compute total. -// const double first_name_total = max(first_name * 1.0, first_name_metaphone * 0.9); -// const double last_name_total = max(last_name * 1.0, last_name_metaphone * 0.9); -// double total = (first_name_total * last_name_total) * 0.6 + email * 0.2 + address * 0.2; - -// // Clean up. -// nmSysFree(fields); - -// // Return total. -// tree->DataType = DATA_T_DOUBLE; -// tree->Types.Double = total; -// return 0; -// } - - +/*** Computes double metaphone. + *** + *** @param tree The tree resulting from this function. + *** @param objlist The evaluation "scope", including available variables. + *** @param maybe_str Possibly the string passed to double metaphone. + *** @param u1 Unused parameter. + *** @param u2 Unused parameter. + ***/ int exp_fn_double_metaphone(pExpression tree, pParamObjects objlist, pExpression maybe_str, pExpression u1, pExpression u2) { const char fn_name[] = "double_metaphone"; /** Check number of arguments. **/ - if (!maybe_str || u1 || u2) + const int num_params = tree->Children.nItems; + if (num_params != 1) { - mssErrorf(1, "EXP", "%s(?) expects 1 parameter.", fn_name); + mssErrorf(1, "EXP", "%s(?) expects 1 parameter, got %d parameters.", fn_name, num_params); return -1; } - const int num_params = tree->Children.nItems; - if (num_params != 1) + if (maybe_str == NULL || u1 != NULL || u2 != NULL) { - mssErrorf(1, "EXP", "%s(?) expects 1 parameter, got %d.", fn_name, num_params); + mssErrorf(1, "EXP", "%s(?) expects 1 parameter.", fn_name); return -1; } @@ -6019,7 +4176,7 @@ int exp_fn_double_metaphone(pExpression tree, pParamObjects objlist, pExpression ASSERTMAGIC(maybe_str, MGK_EXPRESSION); /** Check object list. **/ - if (!objlist) + if (objlist == NULL) { mssErrorf(1, "EXP", "%s(\?\?\?) no object list?", fn_name); return -1; @@ -6041,9 +4198,8 @@ int exp_fn_double_metaphone(pExpression tree, pParamObjects objlist, pExpression if (str == NULL) { mssErrorf(1, "EXP", - "%s(nothing?) expected string from str " - "(of type DataType = DATA_T_STRING), but the String " - "was NULL or did not exist!", + "%s(nothing?) expected string from str (of datatype DataType = " + "DATA_T_STRING), but the String was NULL or did not exist!", fn_name ); return -1; @@ -6056,18 +4212,15 @@ int exp_fn_double_metaphone(pExpression tree, pParamObjects objlist, pExpression } /** Compute DoubleMetaphone. **/ - char* primary; - char* secondary; - meta_double_metaphone( - str, - memset(&primary, 0, sizeof(primary)), - memset(&secondary, 0, sizeof(secondary)) - ); + char* primary = NULL; + char* secondary = NULL; + meta_double_metaphone(str, &primary, &secondary); /** Process result. **/ const size_t primary_length = strlen(primary); const size_t secondary_length = strlen(secondary); - char* result = nmSysMalloc(primary_length + 1u + secondary_length + 1u); + char* result = check_ptr(nmSysMalloc(primary_length + 1u + secondary_length + 1u)); + if (result == NULL) return -1; sprintf(result, "%s%c%s", primary, CA_BOUNDARY_CHAR, secondary); /** Return the result. **/ @@ -6076,13 +4229,6 @@ int exp_fn_double_metaphone(pExpression tree, pParamObjects objlist, pExpression return 0; } -// // Clean up. -// #undef min -// #undef max - -// // END OF DUPE SECTION -// // =================== - /* * exp_fn_argon2id * This method hashes a given password using the Argon2 algorithm (ID variant) @@ -6205,7 +4351,9 @@ int exp_fn_argon2id(pExpression tree, pParamObjects objlist, pExpression passwor int exp_internal_DefineFunctions() { - + /** Initialize library **/ + ca_init(); + /** Function list for EXPR_N_FUNCTION nodes **/ xhAdd(&EXP.Functions, "getdate", (char*)exp_fn_getdate); xhAdd(&EXP.Functions, "user_name", (char*)exp_fn_user_name); @@ -6260,9 +4408,6 @@ int exp_internal_DefineFunctions() xhAdd(&EXP.Functions, "log10", (char*)exp_fn_log10); xhAdd(&EXP.Functions, "power", (char*)exp_fn_power); xhAdd(&EXP.Functions, "pbkdf2", (char*)exp_fn_pbkdf2); - xhAdd(&EXP.Functions, "levenshtein", (char*)exp_fn_levenshtein); /* Only used in its own tests. */ - xhAdd(&EXP.Functions, "lev_compare", (char*)exp_fn_lev_compare); /* Only used in its own tests. */ - xhAdd(&EXP.Functions, "cos_compare", (char*)exp_fn_cos_compare); xhAdd(&EXP.Functions, "to_base64", (char*)exp_fn_to_base64); xhAdd(&EXP.Functions, "from_base64", (char*)exp_fn_from_base64); xhAdd(&EXP.Functions, "to_hex", (char*)exp_fn_to_hex); @@ -6271,19 +4416,19 @@ int exp_internal_DefineFunctions() xhAdd(&EXP.Functions, "argon2id",(char*)exp_fn_argon2id); /** Duplicate Detection **/ - // xhAdd(&EXP.Functions, "get_dups", (char*)exp_fn_get_dups); - // xhAdd(&EXP.Functions, "get_dups_phone", (char*)exp_fn_get_dups_phone); - // xhAdd(&EXP.Functions, "no_op", (char*)exp_fn_do_nothing); - // xhAdd(&EXP.Functions, "do_nothing", (char*)exp_fn_do_nothing); - // xhAdd(&EXP.Functions, "param", (char*)exp_fn_param); - // xhAdd(&EXP.Functions, "total_sim", (char*)exp_fn_get_sim); + xhAdd(&EXP.Functions, "cos_cmp", (char*)exp_fn_cos_cmp); + xhAdd(&EXP.Functions, "cos_compare", (char*)exp_fn_cos_cmp); + xhAdd(&EXP.Functions, "cosine_compare", (char*)exp_fn_cos_cmp); + xhAdd(&EXP.Functions, "lev_cmp", (char*)exp_fn_lev_cmp); + xhAdd(&EXP.Functions, "lev_compare", (char*)exp_fn_lev_cmp); + xhAdd(&EXP.Functions, "levenshtein_compare", (char*)exp_fn_lev_cmp); xhAdd(&EXP.Functions, "double_metaphone", (char*)exp_fn_double_metaphone); /** Windowing **/ xhAdd(&EXP.Functions, "row_number", (char*)exp_fn_row_number); xhAdd(&EXP.Functions, "dense_rank", (char*)exp_fn_dense_rank); xhAdd(&EXP.Functions, "lag", (char*)exp_fn_lag); - + /** Aggregate **/ xhAdd(&EXP.Functions, "count", (char*)exp_fn_count); xhAdd(&EXP.Functions, "avg", (char*)exp_fn_avg); @@ -6293,9 +4438,9 @@ int exp_internal_DefineFunctions() xhAdd(&EXP.Functions, "first", (char*)exp_fn_first); xhAdd(&EXP.Functions, "last", (char*)exp_fn_last); xhAdd(&EXP.Functions, "nth", (char*)exp_fn_nth); - + /** Reverse functions **/ xhAdd(&EXP.ReverseFunctions, "isnull", (char*)exp_fn_reverse_isnull); - + return 0; } diff --git a/centrallix/include/obj.h b/centrallix/include/obj.h index 54d4c988a..045d57f85 100644 --- a/centrallix/include/obj.h +++ b/centrallix/include/obj.h @@ -192,7 +192,6 @@ typedef struct _OSD int (*Commit)(); int (*GetQueryCoverageMask)(); int (*GetQueryIdentityPath)(); - int (*Unregister)(); } ObjDriver, *pObjDriver; diff --git a/centrallix/osdrivers/objdrv_cluster.c b/centrallix/osdrivers/objdrv_cluster.c index 4acfc8579..c10c6fca6 100644 --- a/centrallix/osdrivers/objdrv_cluster.c +++ b/centrallix/osdrivers/objdrv_cluster.c @@ -72,7 +72,7 @@ ***/ /** Pure Laziness **/ -// #define ENABLE_TPRINTF +#define ENABLE_TPRINTF /** Debugging **/ #ifndef ENABLE_TPRINTF @@ -243,7 +243,7 @@ void** ci_xaToTrimmedArray(pXArray arr) } const size_t arr_size = arr->nItems * sizeof(void*); - void** result = check_ptr(nmMalloc(arr_size)); + void** result = check_ptr(nmSysMalloc(arr_size)); memcpy(result, arr->Items, arr_size); return result; } @@ -675,7 +675,7 @@ static void ci_FreeSourceData(pSourceData source_data); static void ci_FreeClusterData(pClusterData cluster_data, bool recursive); static void ci_FreeSearchData(pSearchData search_data); static void ci_FreeNodeData(pNodeData node_data); -static void ci_FreeCaches(void); +static void ci_ClearCaches(void); /** Deep Size Computation Functions. **/ // LINK #sizing @@ -718,7 +718,6 @@ static void ci_CacheFreeSourceData(pXHashEntry entry, void* path); static void ci_CacheFreeCluster(pXHashEntry entry, void* path); static void ci_CacheFreeSearch(pXHashEntry entry, void* path); int clusterExecuteMethod(void* inf_v, char* methodname, pObjData param, pObjTrxTree oxt); -int clusterUnregister(pObjDriver object_driver, pObjSession session); /** Unimplemented DriverFunctions. **/ // LINK #unimplemented @@ -1539,7 +1538,6 @@ static pNodeData ci_ParseNodeData(pStructInf inf, pObject parent) if (path == NULL) goto err; /** Allocate node struct data. **/ - // pNodeData node_data = NodeData |> sizeof() |> nmMalloc() |> check_ptr(); pNodeData node_data = check_ptr(nmMalloc(sizeof(NodeData))); if (node_data == NULL) goto err; memset(node_data, 0, sizeof(NodeData)); @@ -1678,7 +1676,7 @@ static pNodeData ci_ParseNodeData(pStructInf inf, pObject parent) /** Itterate over each param in the structure file. **/ node_data->nParams = param_infs.nItems; const size_t params_size = node_data->nParams * sizeof(pParam); - node_data->Params = check_ptr(nmMalloc(params_size)); + node_data->Params = check_ptr(nmSysMalloc(params_size)); if (node_data->Params == NULL) goto err_free_arrs; memset(node_data->Params, 0, params_size); for (unsigned int i = 0u; i < node_data->nParams; i++) @@ -1755,7 +1753,7 @@ static pNodeData ci_ParseNodeData(pStructInf inf, pObject parent) if (node_data->nClusterDatas > 0) { const size_t clusters_size = node_data->nClusterDatas * sizeof(pClusterData); - node_data->ClusterDatas = check_ptr(nmMalloc(clusters_size)); + node_data->ClusterDatas = check_ptr(nmSysMalloc(clusters_size)); if (node_data->ClusterDatas == NULL) goto err_free_arrs; memset(node_data->ClusterDatas, 0, clusters_size); for (unsigned int i = 0u; i < node_data->nClusterDatas; i++) @@ -1773,7 +1771,7 @@ static pNodeData ci_ParseNodeData(pStructInf inf, pObject parent) if (node_data->nSearchDatas > 0) { const size_t searches_size = node_data->nSearchDatas * sizeof(pSearchData); - node_data->SearchDatas = check_ptr(nmMalloc(searches_size)); + node_data->SearchDatas = check_ptr(nmSysMalloc(searches_size)); if (node_data->SearchDatas == NULL) goto err_free_arrs; memset(node_data->SearchDatas, 0, searches_size); for (unsigned int i = 0u; i < node_data->nSearchDatas; i++) @@ -1810,17 +1808,39 @@ static pNodeData ci_ParseNodeData(pStructInf inf, pObject parent) /** @param source_data A pSourceData struct, freed by this function. **/ static void ci_FreeSourceData(pSourceData source_data) { + /** Guard segfault. **/ + if (source_data == NULL) + { + fprintf(stderr, "Call to ci_FreeSourceData(NULL);\n"); + return; + } + /** Free top level attributes, if they exist. **/ - if (source_data->Name != NULL) nmSysFree(source_data->Name); - if (source_data->SourcePath != NULL) nmSysFree(source_data->SourcePath); - if (source_data->AttrName != NULL) nmSysFree(source_data->AttrName); + if (source_data->Name != NULL) + { + nmSysFree(source_data->Name); + source_data->Name = NULL; + } + if (source_data->SourcePath != NULL) + { + nmSysFree(source_data->SourcePath); + source_data->SourcePath = NULL; + } + if (source_data->AttrName != NULL) + { + nmSysFree(source_data->AttrName); + source_data->AttrName = NULL; + } /** Free fetched data, if it exists. **/ if (source_data->Strings != NULL) { for (unsigned int i = 0u; i < source_data->nVectors; i++) + { nmSysFree(source_data->Strings[i]); - nmFree(source_data->Strings, source_data->nVectors * sizeof(char*)); + source_data->Strings[i] = NULL; + } + nmSysFree(source_data->Strings); source_data->Strings = NULL; } @@ -1828,13 +1848,17 @@ static void ci_FreeSourceData(pSourceData source_data) if (source_data->Vectors != NULL) { for (unsigned int i = 0u; i < source_data->nVectors; i++) + { ca_free_vector(source_data->Vectors[i]); - nmFree(source_data->Vectors, source_data->nVectors * sizeof(pVector)); + source_data->Vectors[i] = NULL; + } + nmSysFree(source_data->Vectors); source_data->Vectors = NULL; } - /** Free the source_data struct. **/ + /** Free the source data struct. **/ nmFree(source_data, sizeof(SourceData)); + source_data = NULL; } @@ -1846,21 +1870,33 @@ static void ci_FreeSourceData(pSourceData source_data) ***/ static void ci_FreeClusterData(pClusterData cluster_data, bool recursive) { - /** Free top level cluster data. **/ - if (cluster_data->Name != NULL) nmSysFree(cluster_data->Name); + /** Guard segfault. **/ + if (cluster_data == NULL) + { + fprintf(stderr, "Call to ci_FreeClusterData(NULL, %s);\n", (recursive) ? "true" : "false"); + return; + } + + /** Free attribute data. **/ + if (cluster_data->Name != NULL) + { + nmSysFree(cluster_data->Name); + cluster_data->Name = NULL; + } /** Free computed data, if it exists. **/ if (cluster_data->Clusters != NULL) { - const unsigned int nVectors = cluster_data->SourceData->nVectors; for (unsigned int i = 0u; i < cluster_data->nClusters; i++) { pCluster cluster = &cluster_data->Clusters[i]; - nmFree(cluster->Strings, cluster->Size * sizeof(char*)); - nmFree(cluster->Vectors, cluster->Size * sizeof(pVector)); + nmSysFree(cluster->Strings); + nmSysFree(cluster->Vectors); + cluster->Strings = NULL; + cluster->Vectors = NULL; } - nmFree(cluster_data->Clusters, nVectors * sizeof(Cluster)); - nmFree(cluster_data->Sims, nVectors * sizeof(double)); + nmSysFree(cluster_data->Clusters); + nmSysFree(cluster_data->Sims); cluster_data->Clusters = NULL; cluster_data->Sims = NULL; } @@ -1871,14 +1907,18 @@ static void ci_FreeClusterData(pClusterData cluster_data, bool recursive) if (recursive) { for (unsigned int i = 0u; i < cluster_data->nSubClusters; i++) + { ci_FreeClusterData(cluster_data->SubClusters[i], recursive); + cluster_data->SubClusters[i] = NULL; + } } - nmFree(cluster_data->SubClusters, cluster_data->nSubClusters * sizeof(void*)); + nmSysFree(cluster_data->SubClusters); cluster_data->SubClusters = NULL; } - /** Free the cluster struct. **/ + /** Free the cluster data struct. **/ nmFree(cluster_data, sizeof(ClusterData)); + cluster_data = NULL; } @@ -1886,15 +1926,35 @@ static void ci_FreeClusterData(pClusterData cluster_data, bool recursive) /** @param search_data A pSearchData struct, freed by this function. **/ static void ci_FreeSearchData(pSearchData search_data) { - if (search_data->Name != NULL) nmSysFree(search_data->Name); + /** Guard segfault. **/ + if (search_data == NULL) + { + fprintf(stderr, "Call to ci_FreeSearchData(NULL);\n"); + return; + } + + /** Free attribute data. **/ + if (search_data->Name != NULL) + { + nmSysFree(search_data->Name); + search_data->Name = NULL; + } + + /** Free computed data. **/ if (search_data->Dups != NULL) { for (unsigned int i = 0; i < search_data->nDups; i++) + { nmFree(search_data->Dups[i], sizeof(Dup)); - nmFree(search_data->Dups, search_data->nDups * sizeof(void*)); + search_data->Dups[i] = NULL; + } + nmSysFree(search_data->Dups); search_data->Dups = NULL; } + + /** Free the search data struct. **/ nmFree(search_data, sizeof(SearchData)); + search_data = NULL; } @@ -1902,6 +1962,13 @@ static void ci_FreeSearchData(pSearchData search_data) /** @param node_data A pNodeData struct, freed by this function. **/ static void ci_FreeNodeData(pNodeData node_data) { + /** Guard segfault. **/ + if (node_data == NULL) + { + fprintf(stderr, "Call to ci_FreeNodeData(NULL);\n"); + return; + } + /** Free parsed params, if they exist. **/ if (node_data->Params != NULL) { @@ -1909,28 +1976,36 @@ static void ci_FreeNodeData(pNodeData node_data) { if (node_data->Params[i] == NULL) break; paramFree(node_data->Params[i]); + node_data->Params[i] = NULL; } - nmFree(node_data->Params, node_data->nParams * sizeof(pParam)); + nmSysFree(node_data->Params); + node_data->Params = NULL; } - if (node_data->ParamList != NULL) expFreeParamList(node_data->ParamList); + if (node_data->ParamList != NULL) + { + expFreeParamList(node_data->ParamList); + node_data->ParamList = NULL; + } /** Free parsed clusters, if they exist. **/ if (node_data->ClusterDatas != NULL) { - /*** This data is cached, so we should NOT free it! - *** The caching system is responsible for the memory. + /*** This data is cached, so we should NOT free it! The caching system + *** is responsible for the memory. We only need to free the array + *** holding our pointers to said cached memory. ***/ - nmFree(node_data->ClusterDatas, node_data->nClusterDatas * sizeof(pClusterData)); + nmSysFree(node_data->ClusterDatas); node_data->ClusterDatas = NULL; } /** Free parsed searches, if they exist. **/ if (node_data->SearchDatas != NULL) { - /*** This data is cached, so we should NOT free it! - *** The caching system is responsible for the memory. + /*** This data is cached, so we should NOT free it! The caching system + *** is responsible for the memory. We only need to free the array + *** holding our pointers to said cached memory. ***/ - nmFree(node_data->SearchDatas, node_data->nSearchDatas * sizeof(pSearchData)); + nmSysFree(node_data->SearchDatas); node_data->SearchDatas = NULL; } @@ -1942,18 +2017,20 @@ static void ci_FreeNodeData(pNodeData node_data) ***/ if (node_data->SourceData != NULL) { - /*** This data is cached, so we should NOT free it! - *** The caching system is responsible for the memory. + /*** This data is cached, so we should NOT free it! The caching system + *** is responsible for the memory. We only need to free the array + *** holding our pointers to said cached memory. ***/ node_data->SourceData = NULL; } /** Free the node data. **/ nmFree(node_data, sizeof(NodeData)); + node_data = NULL; } -/** Frees all caches for all cluster driver instances. **/ -static void ci_FreeCaches(void) +/** Frees all data in caches for all cluster driver instances. **/ +static void ci_ClearCaches(void) { /*** Free caches in reverse of the order they are created in case *** cached data relies on its source during the freeing process. @@ -2207,13 +2284,13 @@ static int ci_ComputeSourceData(pSourceData source_data, pObjSession session) successful = false; goto end_free_data; } - if (vector[0] == -CA_NUM_DIMS) + if (ca_is_empty(vector)) { mssErrorf(1, "Cluster", "Vector building for string \"%s\" produced no character pairs.", val); successful = false; goto end_free_data; } - if (vector[0] == -172 && vector[1] == 11 && vector[2] == -78) + if (ca_has_no_pairs(vector)) { /** Skip pVector with no pairs. **/ tprintf("."); @@ -2241,7 +2318,7 @@ static int ci_ComputeSourceData(pSourceData source_data, pObjSession session) /** Trim data and store data. **/ const size_t data_size = source_data->nVectors * sizeof(char*); - source_data->Strings = check_ptr(nmMalloc(data_size)); + source_data->Strings = check_ptr(nmSysMalloc(data_size)); if (source_data->Strings == NULL) goto end_free_data; memcpy(source_data->Strings, data_xarray.Items, data_size); check(xaDeInit(&data_xarray)); /* Failure ignored. */ @@ -2249,7 +2326,7 @@ static int ci_ComputeSourceData(pSourceData source_data, pObjSession session) /** Trim data and store vectors. **/ const size_t vectors_size = source_data->nVectors * sizeof(pVector); - source_data->Vectors = check_ptr(nmMalloc(vectors_size)); + source_data->Vectors = check_ptr(nmSysMalloc(vectors_size)); memcpy(source_data->Vectors, vector_xarray.Items, vectors_size); check(xaDeInit(&vector_xarray)); /* Failure ignored. */ vector_xarray.nAlloc = 0; @@ -2325,11 +2402,11 @@ static int ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data) /** Allocate static memory for finding clusters. **/ const size_t clusters_size = cluster_data->nClusters * sizeof(Cluster); - cluster_data->Clusters = check_ptr(nmMalloc(clusters_size)); + cluster_data->Clusters = check_ptr(nmSysMalloc(clusters_size)); if (cluster_data->Clusters == NULL) goto err; memset(cluster_data->Clusters, 0, clusters_size); const size_t sims_size = source_data->nVectors * sizeof(double); - cluster_data->Sims = check_ptr(nmMalloc(sims_size)); + cluster_data->Sims = check_ptr(nmSysMalloc(sims_size)); if (cluster_data->Sims == NULL) goto err_free_clusters; memset(cluster_data->Sims, 0, sims_size); @@ -2342,9 +2419,9 @@ static int ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data) /** Put all the data into one cluster. **/ pCluster first_cluster = &cluster_data->Clusters[0]; first_cluster->Size = source_data->nVectors; - first_cluster->Strings = check_ptr(nmMalloc(source_data->nVectors * sizeof(char*))); + first_cluster->Strings = check_ptr(nmSysMalloc(source_data->nVectors * sizeof(char*))); if (first_cluster->Strings == NULL) goto err_free_sims; - first_cluster->Vectors = check_ptr(nmMalloc(source_data->nVectors * sizeof(pVector))); + first_cluster->Vectors = check_ptr(nmSysMalloc(source_data->nVectors * sizeof(pVector))); if (first_cluster->Vectors == NULL) goto err_free_sims; memcpy(first_cluster->Strings, source_data->Strings, source_data->nVectors * sizeof(char*)); memcpy(first_cluster->Vectors, source_data->Vectors, source_data->nVectors * sizeof(pVector)); @@ -2372,7 +2449,7 @@ static int ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data) /** Allocate lables. Note: kmeans does not require us to initialize them. **/ const size_t lables_size = source_data->nVectors * sizeof(unsigned int); - unsigned int* labels = check_ptr(nmMalloc(lables_size)); + unsigned int* labels = check_ptr(nmSysMalloc(lables_size)); if (labels == NULL) goto err_free_sims; /** Run kmeans. **/ @@ -2409,9 +2486,9 @@ static int ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data) pXArray indexes_in_this_cluster = &indexes_in_cluster[i]; pCluster cluster = &cluster_data->Clusters[i]; cluster->Size = indexes_in_this_cluster->nItems; - cluster->Strings = check_ptr(nmMalloc(cluster->Size * sizeof(char*))); + cluster->Strings = check_ptr(nmSysMalloc(cluster->Size * sizeof(char*))); if (cluster->Strings == NULL) goto err_free_sims; - cluster->Vectors = check_ptr(nmMalloc(cluster->Size * sizeof(pVector))); + cluster->Vectors = check_ptr(nmSysMalloc(cluster->Size * sizeof(pVector))); if (cluster->Vectors == NULL) goto err_free_sims; for (unsigned int j = 0u; j < cluster->Size; j++) { @@ -2584,7 +2661,7 @@ static int ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) /** Store dups. **/ search_data->nDups = dups->nItems; search_data->Dups = (dups->nItems == 0) - ? check_ptr(nmMalloc(0)) + ? check_ptr(nmSysMalloc(0)) : ci_xaToTrimmedArray(dups); /** Free unused data. **/ @@ -4162,7 +4239,7 @@ int clusterExecuteMethod(void* inf_v, char* method_name, pObjData param, pObjTrx else printf("all files:\n"); /** Free caches. **/ - ci_FreeCaches(); + ci_ClearCaches(); tprintf("Cache dropped.\n"); return 0; @@ -4185,21 +4262,6 @@ int clusterExecuteMethod(void* inf_v, char* method_name, pObjData param, pObjTrx } -/*** Frees caches when the driver is unregistered. - *** - *** This function does not free either of the given parameters. - *** - *** @param object_driver The driver instance which was registered being unregistered. (unused) - *** @param session The session being closed. (unused) - *** Returns - ***/ -int clusterUnregister(pObjDriver object_driver, pObjSession session) - { - ci_FreeCaches(); - return 0; - } - - /** ================ Unimplemented Functions ================ **/ /** ANCHOR[id=unimplemented] **/ // LINK #functions @@ -4272,9 +4334,6 @@ int clusterCommit(void* inf_v, pObjTrxTree *oxt) ***/ int clusterInitialize(void) { - /** Initialize library. **/ - ca_init(); - /** Allocate the driver. **/ pObjDriver drv = (pObjDriver)check_ptr(nmMalloc(sizeof(ObjDriver))); if (drv == NULL) goto err; @@ -4320,36 +4379,47 @@ int clusterInitialize(void) drv->Commit = clusterCommit; drv->GetQueryCoverageMask = NULL; drv->GetQueryIdentityPath = NULL; - drv->Unregister = clusterUnregister; /** Register some structures. **/ + nmRegister(sizeof(SourceData), "ClusterSourceData"); + nmRegister(sizeof(Cluster), "Cluster"); nmRegister(sizeof(ClusterData), "ClusterData"); nmRegister(sizeof(SearchData), "ClusterSearch"); - nmRegister(sizeof(SourceData), "ClusterSourceData"); nmRegister(sizeof(NodeData), "ClusterNodeData"); nmRegister(sizeof(DriverData), "ClusterDriverData"); nmRegister(sizeof(ClusterQuery), "ClusterQuery"); nmRegister(sizeof(ClusterDriverCaches), "ClusterDriverCaches"); /** Print debug size info. **/ - char buf1[16], buf2[16], buf3[16], buf4[16], buf5[16], buf6[16], buf7[16]; - tprintf( - "Cluster driver struct sizes:\n" - " > sizeof(SourceData): %s\n" - " > sizeof(ClusterData): %s\n" - " > sizeof(SearchData): %s\n" - " > sizeof(NodeData): %s\n" - " > sizeof(DriverData): %s\n" - " > sizeof(ClusterQuery): %s\n" - " > sizeof(ClusterDriverCaches): %s\n", - snprint_bytes(buf1, sizeof(buf1), sizeof(SourceData)), - snprint_bytes(buf2, sizeof(buf2), sizeof(ClusterData)), - snprint_bytes(buf3, sizeof(buf3), sizeof(SearchData)), - snprint_bytes(buf4, sizeof(buf4), sizeof(NodeData)), - snprint_bytes(buf5, sizeof(buf5), sizeof(DriverData)), - snprint_bytes(buf6, sizeof(buf6), sizeof(ClusterQuery)), - snprint_bytes(buf7, sizeof(buf7), sizeof(ClusterDriverCaches)) - ); +// char buf1[16], buf2[16], buf3[16], buf4[16], buf5[16], buf6[16], buf7[16], buf8[16]; +// tprintf( +// "Cluster driver struct sizes:\n" +// " > sizeof(SourceData): %s\n" +// " > sizeof(Cluster): %s\n" +// " > sizeof(ClusterData): %s\n" +// " > sizeof(SearchData): %s\n" +// " > sizeof(NodeData): %s\n" +// " > sizeof(DriverData): %s\n" +// " > sizeof(ClusterQuery): %s\n" +// " > sizeof(ClusterDriverCaches): %s\n", +// snprint_bytes(buf1, sizeof(buf1), sizeof(SourceData)), +// snprint_bytes(buf2, sizeof(buf2), sizeof(Cluster)), +// snprint_bytes(buf3, sizeof(buf3), sizeof(ClusterData)), +// snprint_bytes(buf4, sizeof(buf4), sizeof(SearchData)), +// snprint_bytes(buf5, sizeof(buf5), sizeof(NodeData)), +// snprint_bytes(buf6, sizeof(buf6), sizeof(DriverData)), +// snprint_bytes(buf7, sizeof(buf7), sizeof(ClusterQuery)), +// snprint_bytes(buf8, sizeof(buf8), sizeof(ClusterDriverCaches)) +// ); + +// pVector v = ca_build_vector(""); +// const unsigned int len = ca_sparse_len(v); +// fprintf(stderr, "Vector (x%d): [%d", len, v[0]); +// for (unsigned int i = 1u; i < len; i++) +// { +// fprintf(stderr, ", %d", v[i]); +// } +// fprintf(stderr, "]\n"); /** Register the driver. **/ if (!check(objRegisterDriver(drv))) goto err; diff --git a/centrallix/test_obj.c b/centrallix/test_obj.c index 6b09a8586..5ef492de3 100644 --- a/centrallix/test_obj.c +++ b/centrallix/test_obj.c @@ -1271,13 +1271,6 @@ testobj_do_cmd(pObjSession s, char* cmd, int batch_mode, pLxSession inp_lx) } else if (!strcmp(cmdname,"quit")) { - /** Loop through each driver and call their unregister handler, if they have one. **/ - for (unsigned int i = 0u; i < OSYS.Drivers.nItems; i++) - { - pObjDriver cur = (pObjDriver)OSYS.Drivers.Items[i]; - if (cur->Unregister != NULL) cur->Unregister(cur, s); - } - mlxCloseSession(ls); return 1; } From b4634f3cbd1410c147e8b7cb6a6f3ac1fb89ad96 Mon Sep 17 00:00:00 2001 From: Israel Date: Thu, 30 Oct 2025 14:48:10 -0600 Subject: [PATCH 006/275] Begin adding query files to search for duplicates. Simplify dataqa_duplicates component in preparation for making it the boundary into our new duplicate system. Add exp functions: sparse_eql(), ln(), and logn(). Fix bugs in comparison functions. Make minor tweaks to objdrv_cluster.c. --- centrallix-lib/include/clusters.h | 2 + centrallix-lib/src/clusters.c | 19 ++- centrallix-os/cluster-schema.cluster | 2 +- centrallix-os/file.cluster | 4 +- centrallix/expression/exp_functions.c | 209 ++++++++++++++++++++++++++ centrallix/osdrivers/objdrv_cluster.c | 100 ++++++------ 6 files changed, 283 insertions(+), 53 deletions(-) diff --git a/centrallix-lib/include/clusters.h b/centrallix-lib/include/clusters.h index bddd0800c..288f81714 100644 --- a/centrallix-lib/include/clusters.h +++ b/centrallix-lib/include/clusters.h @@ -33,6 +33,7 @@ /************************************************************************/ #include +#include #ifdef CXLIB_INTERNAL #include "xarray.h" @@ -90,6 +91,7 @@ int ca_kmeans( /** Comparison functions, for ca_search(). **/ double ca_cos_compare(void* v1, void* v2); double ca_lev_compare(void* str1, void* str2); +bool ca_eql(pVector v1, pVector v2); void* ca_most_similar( void* target, diff --git a/centrallix-lib/src/clusters.c b/centrallix-lib/src/clusters.c index 864ff36eb..ef1222873 100644 --- a/centrallix-lib/src/clusters.c +++ b/centrallix-lib/src/clusters.c @@ -184,7 +184,7 @@ pVector ca_build_vector(const char* str) if (size > expected_max_size) { fprintf(stderr, - "cli_build_vector(%s) - Warning: Sparse vector larger than expected.\n" + "cli_build_vector(\"%s\") - Warning: Sparse vector larger than expected.\n" " > Size: %lu\n" " > #Dims: %u\n", str, @@ -555,7 +555,7 @@ double ca_lev_compare(void* str1, void* str2) const size_t len2 = strlen(str2); if (len1 == 0lu && len2 == 0lu) return 1.0; if (len1 != 0lu && len2 == 0lu) return 0.0; - if (len1 != 0lu && len2 != 0lu) return 0.0; + if (len1 == 0lu && len2 != 0lu) return 0.0; /** Compute levenshtein edit distance. **/ const unsigned int dist = edit_dist((const char*)str1, (const char*)str2, len1, len2); @@ -567,6 +567,21 @@ double ca_lev_compare(void* str1, void* str2) return normalized_similarity; } +/*** Check if two sparse vectors are identical. + *** + *** @param v1 The first vector. + *** @param v2 The second vector. + *** @returns true if they are equal, + *** false if any element is different. + ***/ +bool ca_eql(pVector v1, pVector v2) + { + const unsigned int len = ca_sparse_len(v1); + for (unsigned int i = 0u; i < len; i++) + if (v1[i] != v2[i]) return false; + return true; + } + /*** Calculate the average size of all clusters in a set of vectors. *** *** @param vectors The vectors of the dataset (allocated sparsely). diff --git a/centrallix-os/cluster-schema.cluster b/centrallix-os/cluster-schema.cluster index 9f11c1636..e87ae6b5f 100644 --- a/centrallix-os/cluster-schema.cluster +++ b/centrallix-os/cluster-schema.cluster @@ -38,8 +38,8 @@ file_name "system/cluster" search_name "system/search" { source : string ⊂ [cluster_name, ...] - threshold : double && 0.0 < x < 1.0 // optimization. similarity_measure : "cosine" | "levenshtein" + threshold : double && 0.0 < x < 1.0 // optimization. } ... } diff --git a/centrallix-os/file.cluster b/centrallix-os/file.cluster index 078a39fcc..95eacfee0 100644 --- a/centrallix-os/file.cluster +++ b/centrallix-os/file.cluster @@ -54,14 +54,14 @@ file_name "system/cluster" dups "cluster/search" { source = kmeans_cluster; - threshold = 0.75; similarity_measure = "cosine"; + threshold = 0.75; } dups2 "cluster/search" { source = no_clustering; - threshold = 0.75; similarity_measure = "cosine"; + threshold = 0.75; } } diff --git a/centrallix/expression/exp_functions.c b/centrallix/expression/exp_functions.c index 4f9ffa563..751e07297 100644 --- a/centrallix/expression/exp_functions.c +++ b/centrallix/expression/exp_functions.c @@ -3288,6 +3288,101 @@ int exp_fn_log10(pExpression tree, pParamObjects objlist, pExpression i0, pExpre } +int exp_fn_log_natural(pExpression tree, pParamObjects objlist, pExpression i0, pExpression i1, pExpression i2) + { + double n; + + if (!i0) + { + mssError(1, "EXP", "ln() requires a number as its first parameter"); + goto error; + } + if (i0->Flags & EXPR_F_NULL) + { + tree->DataType = DATA_T_DOUBLE; + tree->Flags |= EXPR_F_NULL; + return 0; + } + switch(i0->DataType) + { + case DATA_T_INTEGER: + n = i0->Integer; + break; + case DATA_T_DOUBLE: + n = i0->Types.Double; + break; + case DATA_T_MONEY: + n = objDataToDouble(DATA_T_MONEY, &(i0->Types.Money)); + break; + default: + mssError(1, "EXP", "ln() requires a number as its first parameter"); + goto error; + } + if (n < 0) + { + mssError(1, "EXP", "ln(): cannot compute the logarithm of a negative number"); + goto error; + } + tree->DataType = DATA_T_DOUBLE; + tree->Types.Double = log(n); + return 0; + + error: + return -1; + } + + +int exp_fn_log_base_n(pExpression tree, pParamObjects objlist, pExpression i0, pExpression i1, pExpression i2) + { + double n, p; + + if (!i0 || !i1) + { + mssError(1, "EXP", "logn() requires numbers as its first and second parameters"); + goto error; + } + if ((i0->Flags & EXPR_F_NULL) || (i1->Flags & EXPR_F_NULL)) + { + tree->DataType = DATA_T_DOUBLE; + tree->Flags |= EXPR_F_NULL; + return 0; + } + switch(i0->DataType) + { + case DATA_T_INTEGER: + n = i0->Integer; + break; + case DATA_T_DOUBLE: + n = i0->Types.Double; + break; + case DATA_T_MONEY: + n = objDataToDouble(DATA_T_MONEY, &(i0->Types.Money)); + break; + default: + mssError(1, "EXP", "logn() requires a number as its first parameter"); + goto error; + } + switch(i1->DataType) + { + case DATA_T_INTEGER: + p = i1->Integer; + break; + case DATA_T_DOUBLE: + p = i1->Types.Double; + break; + default: + mssError(1, "EXP", "logn() requires an integer or double as its second parameter"); + goto error; + } + tree->DataType = DATA_T_DOUBLE; + tree->Types.Double = log(n) / log(p); + return 0; + + error: + return -1; + } + + int exp_fn_power(pExpression tree, pParamObjects objlist, pExpression i0, pExpression i1, pExpression i2) { double n, p; @@ -4008,6 +4103,7 @@ int exp_fn_nth(pExpression tree, pParamObjects objlist, pExpression i0, pExpress *** @param maybe_str2 Possibly the second string. *** @param u1 Unused parameter. *** @param is_cos Whether to compute cosine or levenshtien. + *** @returns 0 for success, -1 for failure. ***/ static int exp_fn_cmp(pExpression tree, pParamObjects objlist, pExpression maybe_str1, pExpression maybe_str2, pExpression u1, bool is_cos) { @@ -4126,6 +4222,7 @@ static int exp_fn_cmp(pExpression tree, pParamObjects objlist, pExpression maybe *** @param maybe_str1 Possibly the first string. *** @param maybe_str2 Possibly the second string. *** @param u1 Unused parameter. + *** @returns 0 for success, -1 for failure. ***/ int exp_fn_cos_cmp(pExpression tree, pParamObjects objlist, pExpression maybe_str1, pExpression maybe_str2, pExpression u1) { @@ -4140,12 +4237,121 @@ int exp_fn_cos_cmp(pExpression tree, pParamObjects objlist, pExpression maybe_st *** @param maybe_str1 Possibly the first string. *** @param maybe_str2 Possibly the second string. *** @param u1 Unused parameter. + *** @returns 0 for success, -1 for failure. ***/ int exp_fn_lev_cmp(pExpression tree, pParamObjects objlist, pExpression maybe_str1, pExpression maybe_str2, pExpression u1) { return exp_fn_cmp(tree, objlist, maybe_str1, maybe_str2, u1, false); } + +/*** Comparse two strings to see if their sparse vectors are equal. + *** + *** @param tree The tree resulting from this function. + *** @param objlist The evaluation "scope", including available variables. + *** @param maybe_str1 Possibly the first string. + *** @param maybe_str2 Possibly the second string. + *** @param u1 Unused parameter. + *** @returns 0 for success, -1 for failure. + ***/ +static int exp_fn_sparse_eql(pExpression tree, pParamObjects objlist, pExpression maybe_str1, pExpression maybe_str2, pExpression u1, bool is_cos) + { + const char fn_name[] = "sparse_compare"; + + /** Check number of arguments. **/ + const int num_params = tree->Children.nItems; + if (num_params != 2) + { + mssErrorf(1, "EXP", "%s(?) expects 2 parameters, got %d parameters.", fn_name, num_params); + return -1; + } + if (maybe_str1 == NULL || maybe_str2 == NULL || u1 != NULL) + { + mssErrorf(1, "EXP", "%s(?) expects 2 parameters.", fn_name); + return -1; + } + + /** Magic checks. **/ + ASSERTMAGIC(tree, MGK_EXPRESSION); + ASSERTMAGIC(maybe_str1, MGK_EXPRESSION); + ASSERTMAGIC(maybe_str2, MGK_EXPRESSION); + + /** Check object list. **/ + if (objlist == NULL) + { + mssErrorf(1, "EXP", "%s(\?\?\?) no object list?", fn_name); + return -1; + } + ASSERTMAGIC(objlist->Session, MGK_OBJSESSION); + + /** Extract str1. **/ + if (maybe_str1->Flags & EXPR_F_NULL) + { + mssErrorf(1, "EXP", "%s(NULL, ...) str1 cannot be NULL.", fn_name); + return -1; + } + if (maybe_str1->DataType != DATA_T_STRING) + { + mssErrorf(1, "EXP", "%s(\?\?\?, ..) str1 should be a string.", fn_name); + return -1; + } + char* str1 = maybe_str1->String; + if (str1 == NULL) + { + mssErrorf(1, "EXP", + "%s(nothing?, ...) expected string from str1 (of datatype DataType = " + "DATA_T_STRING), but the String was NULL or did not exist!", + fn_name + ); + return -1; + } + + /** Extract str2. **/ + if (maybe_str2->Flags & EXPR_F_NULL) + { + mssErrorf(1, "EXP", "%s(\"%s\", NULL) str2 cannot be NULL.", fn_name, str1); + return -1; + } + if (maybe_str2->DataType != DATA_T_STRING) + { + mssErrorf(1, "EXP", "%s(\"%s\", \?\?\?) str2 should be a string.", fn_name, str1); + return -1; + } + char* str2 = maybe_str2->String; + if (str2 == NULL) + { + mssErrorf(1, "EXP", + "%s(\"%s\", nothing?) expected string from str2 (of datatype DataType = " + "DATA_T_STRING), but the String was NULL or did not exist!", + fn_name, str1 + ); + return -1; + } + + /** Build vectors. **/ + int ret; + const pVector v1 = check_ptr(ca_build_vector(str1)); + const pVector v2 = check_ptr(ca_build_vector(str2)); + if (v1 == NULL || v2 == NULL) + { + mssErrorf(1, "EXP", + "%s(\"%s\", \"%s\") - Failed to build vectors.", + fn_name, str1, str2 + ); + ret = -1; + } + else + { + tree->Integer = (ca_eql(v1, v2)) ? 1 : 0; + tree->DataType = DATA_T_INTEGER; + ret = 0; + } + + if (v1 != NULL) ca_free_vector(v1); + if (v2 != NULL) ca_free_vector(v2); + return ret; + } + /*** Computes double metaphone. *** *** @param tree The tree resulting from this function. @@ -4406,6 +4612,8 @@ int exp_internal_DefineFunctions() xhAdd(&EXP.Functions, "hash", (char*)exp_fn_hash); xhAdd(&EXP.Functions, "hmac", (char*)exp_fn_hmac); xhAdd(&EXP.Functions, "log10", (char*)exp_fn_log10); + xhAdd(&EXP.Functions, "ln", (char*)exp_fn_log_natural); + xhAdd(&EXP.Functions, "logn", (char*)exp_fn_log_base_n); xhAdd(&EXP.Functions, "power", (char*)exp_fn_power); xhAdd(&EXP.Functions, "pbkdf2", (char*)exp_fn_pbkdf2); xhAdd(&EXP.Functions, "to_base64", (char*)exp_fn_to_base64); @@ -4422,6 +4630,7 @@ int exp_internal_DefineFunctions() xhAdd(&EXP.Functions, "lev_cmp", (char*)exp_fn_lev_cmp); xhAdd(&EXP.Functions, "lev_compare", (char*)exp_fn_lev_cmp); xhAdd(&EXP.Functions, "levenshtein_compare", (char*)exp_fn_lev_cmp); + xhAdd(&EXP.Functions, "sparse_eql", (char*)exp_fn_sparse_eql); xhAdd(&EXP.Functions, "double_metaphone", (char*)exp_fn_double_metaphone); /** Windowing **/ diff --git a/centrallix/osdrivers/objdrv_cluster.c b/centrallix/osdrivers/objdrv_cluster.c index c10c6fca6..6d1aaf313 100644 --- a/centrallix/osdrivers/objdrv_cluster.c +++ b/centrallix/osdrivers/objdrv_cluster.c @@ -71,8 +71,8 @@ *** https://marketplace.visualstudio.com/items?itemName=ExodiusStudios.comment-anchors ***/ -/** Pure Laziness **/ -#define ENABLE_TPRINTF +/** Pure Laziness. **/ +// #define ENABLE_TPRINTF /** Debugging **/ #ifndef ENABLE_TPRINTF @@ -815,7 +815,7 @@ static int ci_ParseAttribute( if (datatype != exp->DataType) { mssErrorf(1, "Cluster", - "Expected \"%s\" : %s, but got type %s.", + "Expected ['%s' : %s], but got type %s.", attr_name, ci_TypeToStr(datatype), ci_TypeToStr(exp->DataType) ); goto err; @@ -826,7 +826,7 @@ static int ci_ParseAttribute( if (ret != 0) { mssErrorf(1, "Cluster", - "Failed to get \"%s\" : %s using expression \"%s\" (error code %d).", + "Failed to get ['%s' : %s] using expression \"%s\" (error code %d).", attr_name, ci_TypeToStr(datatype), exp->Name, ret ); goto err; @@ -1215,7 +1215,7 @@ static pClusterData ci_ParseClusterData(pStructInf inf, pNodeData node_data) if (strcmp(group_type, "cluster/cluster") != 0) { fprintf(stderr, - "Warning: Unknown group \"%s\" : \"%s\" in cluster \"%s\".\n", + "Warning: Unknown group [\"%s\" : \"%s\"] in cluster \"%s\".\n", name, group_type, inf->Name ); continue; @@ -1364,13 +1364,13 @@ static pSearchData ci_ParseSearchData(pStructInf inf, pNodeData node_data) if (search_data->Name == NULL) goto err_free_search; if (!check(objCurrentDate(&search_data->DateCreated))) goto err_free_search; - /** Get source. **/ - char* source_name; - if (ci_ParseAttribute(inf, "source", DATA_T_STRING, POD(&source_name), node_data->ParamList, true, true) != 0) return NULL; + /** Get source cluster. **/ + char* source_cluster_name; + if (ci_ParseAttribute(inf, "source", DATA_T_STRING, POD(&source_cluster_name), node_data->ParamList, true, true) != 0) return NULL; for (unsigned int i = 0; i < node_data->nClusterDatas; i++) { pClusterData cluster_data = node_data->ClusterDatas[i]; - if (strcmp(source_name, cluster_data->Name) == 0) + if (strcmp(source_cluster_name, cluster_data->Name) == 0) { /** Source found. **/ search_data->Source = cluster_data; @@ -1384,13 +1384,13 @@ static pSearchData ci_ParseSearchData(pStructInf inf, pNodeData node_data) if (search_data->Source == NULL) { /** Print error. **/ - mssErrorf(1, "Cluster", "Could not find cluster \"%s\" for search \"%s\".", source_name, search_data->Name); + mssErrorf(1, "Cluster", "Could not find cluster \"%s\" for search \"%s\".", source_cluster_name, search_data->Name); /** Attempt to give a hint. **/ char* cluster_names[node_data->nClusterDatas]; for (unsigned int i = 0; i < node_data->nClusterDatas; i++) cluster_names[i] = node_data->ClusterDatas[i]->Name; - ci_TryHint(source_name, cluster_names, node_data->nClusterDatas); + ci_TryHint(source_cluster_name, cluster_names, node_data->nClusterDatas); /** Fail. **/ goto err_free_search; @@ -1457,7 +1457,7 @@ static pSearchData ci_ParseSearchData(pStructInf inf, pNodeData node_data) char* group_type = check_ptr(sub_inf->UsrType); if (group_type == NULL) goto err_free_search; fprintf(stderr, - "Warning: Unknown group \"%s\" : \"%s\" in search \"%s\".\n", + "Warning: Unknown group [\"%s\" : \"%s\"] in search \"%s\".\n", name, group_type, inf->Name ); break; @@ -1513,7 +1513,7 @@ static pSearchData ci_ParseSearchData(pStructInf inf, pNodeData node_data) ci_FreeSearchData(search_data); err: - mssErrorf(0, "Cluster", "Failed to parse search from group \"%s\".", inf->Name); + mssErrorf(0, "Cluster", "Failed to parse SearchData from group \"%s\".", inf->Name); return NULL; } @@ -2174,9 +2174,9 @@ static int ci_ComputeSourceData(pSourceData source_data, pObjSession session) if (obj == NULL) { mssErrorf(0, "Cluster", - "Failed to open object driver:" - " > Attribute: \"%s\" : String\n" - " > Source Path: %s", + "Failed to open object driver:\n" + " > Attribute: ['%s' : String]\n" + " > Source Path: \"%s\"", source_data->AttrName, source_data->SourcePath ); @@ -2190,9 +2190,9 @@ static int ci_ComputeSourceData(pSourceData source_data, pObjSession session) { mssErrorf(0, "Cluster", "Failed to open query:\n" - " > Attribute: \"%s\" : String\n" + " > Attribute: ['%s' : String]\n" " > Driver Used: %s\n" - " > Source Path: %s", + " > Source Path: \"%s\"", source_data->AttrName, obj->Driver->Name, source_data->SourcePath @@ -2221,9 +2221,9 @@ static int ci_ComputeSourceData(pSourceData source_data, pObjSession session) { mssErrorf(0, "Cluster", "Failed to get type for %uth entry:\n" - " > Attribute: \"%s\" : String\n" + " > Attribute: '%s' : String\n" " > Driver Used: %s\n" - " > Source Path: %s", + " > Source Path: \"%s\"", i, source_data->AttrName, obj->Driver->Name, @@ -2235,9 +2235,9 @@ static int ci_ComputeSourceData(pSourceData source_data, pObjSession session) { mssErrorf(1, "Cluster", "Type for %uth entry was not a string:\n" - " > Attribute: \"%s\" : %s!!\n" + " > Attribute: ['%s' : %s]\n" " > Driver Used: %s\n" - " > Source Path: %s", + " > Source Path: \"%s\"", i, source_data->AttrName, ci_TypeToStr(datatype), obj->Driver->Name, @@ -2254,9 +2254,9 @@ static int ci_ComputeSourceData(pSourceData source_data, pObjSession session) tprintf("\n"); mssErrorf(0, "Cluster", "Failed to value for %uth entry:\n" - " > Attribute: \"%s\" : String\n" + " > Attribute: ['%s' : String]\n" " > Driver Used: %s\n" - " > Source Path: %s\n" + " > Source Path: \"%s\"\n" " > Error code: %d", i, source_data->AttrName, @@ -2264,7 +2264,6 @@ static int ci_ComputeSourceData(pSourceData source_data, pObjSession session) source_data->SourcePath, ret ); - successful = false; goto end_free_data; } @@ -2393,7 +2392,7 @@ static int ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data) /** We need the SourceData vectors to compute clusters. **/ if (ci_ComputeSourceData(source_data, node_data->ParamList->Session) != 0) { - mssErrorf(0, "Cluster", "Failed to compute SourceData."); + mssErrorf(0, "Cluster", "ClusterData computation failed due to missing SourceData."); goto err; } @@ -2532,7 +2531,7 @@ static int ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data) cluster_data->Clusters = NULL; err: - mssErrorf(0, "Cluster", "Cluster computation failed for \"%s\".", cluster_data->Name); + mssErrorf(0, "Cluster", "ClusterData computation failed for \"%s\".", cluster_data->Name); return -1; } @@ -2561,7 +2560,7 @@ static int ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) ret = ci_ComputeClusterData(cluster_data, node_data); if (ret != 0) { - mssErrorf(0, "Cluster", "Search computation failed due to missing clusters."); + mssErrorf(0, "Cluster", "SearchData computation failed due to missing clusters."); goto err; } @@ -2608,7 +2607,7 @@ static int ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) search_data->Threshold, dups )); - if (dups_temp == NULL) goto err; + if (dups_temp == NULL) goto err_free; else dups = dups_temp; } } @@ -2639,7 +2638,7 @@ static int ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) search_data->Threshold, dups )); - if (dups_temp == NULL) goto err; + if (dups_temp == NULL) goto err_free; else dups = dups_temp; } } @@ -2651,10 +2650,10 @@ static int ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) "Unknown similarity meansure \"%s\".", ci_SimilarityMeasureToString(search_data->SimilarityMeasure) ); - goto err; + goto err_free; } timer_stop(timer); - if (dups_temp == NULL) goto err; + if (dups_temp == NULL) goto err_free; else dups = dups_temp; tprintf("Search done after %.4lf.\n", timer_get(timer)); @@ -2671,7 +2670,7 @@ static int ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) /** Success. **/ return 0; - err: + err_free: if (dups != NULL) { for (unsigned int i = 0u; i < dups->nItems; i++) @@ -2682,7 +2681,8 @@ static int ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) check(xaFree(dups)); /* Failure ignored. */ } - mssErrorf(0, "Cluster", "Search computation failed for \"%s\".", search_data->Name); + err: + mssErrorf(0, "Cluster", "SearchData computation failed for \"%s\".", search_data->Name); return -1; } @@ -2770,7 +2770,7 @@ static int ci_GetParamValue(void* inf_v, char* attr_name, int datatype, pObjData err: mssErrorf(1, "Cluster", - "Failed to get parameter %s : %s", + "Failed to get parameter ['%s' : %s]", attr_name, ci_TypeToStr(datatype) ); return -1; @@ -3040,7 +3040,7 @@ void* clusterQueryFetch(void* qy_v, pObject obj, int mode, pObjTrxTree* oxt) case TARGET_ROOT: mssErrorf(1, "Cluster", "Querying the root node of a cluster file is not allowed."); fprintf(stderr, " > Hint: Try / or /\n"); - return NULL; + goto err; case TARGET_CLUSTER: { @@ -3049,8 +3049,8 @@ void* clusterQueryFetch(void* qy_v, pObject obj, int mode, pObjTrxTree* oxt) ret = ci_ComputeClusterData(target, cluster_query->DriverData->NodeData); if (ret != 0) { - mssErrorf(0, "Cluster", "Internal cluster computation failed."); - return NULL; + mssErrorf(0, "Cluster", "Failed to compute ClusterData for query."); + goto err; } data_amount = target->nClusters; break; @@ -3063,8 +3063,8 @@ void* clusterQueryFetch(void* qy_v, pObject obj, int mode, pObjTrxTree* oxt) ret = ci_ComputeSearchData(target, cluster_query->DriverData->NodeData); if (ret != 0) { - mssErrorf(0, "Cluster", "Internal search computation failed."); - return NULL; + mssErrorf(0, "Cluster", "Failed to compute SearchData for query."); + goto err; } data_amount = target->nDups; break; @@ -3073,29 +3073,33 @@ void* clusterQueryFetch(void* qy_v, pObject obj, int mode, pObjTrxTree* oxt) case TARGET_CLUSTER_ENTRY: case TARGET_SEARCH_ENTRY: mssErrorf(1, "Cluster", "Querying a query result is not allowed."); - return NULL; + goto err; default: mssErrorf(1, "Cluster", "Unknown target type %u.", target_type); - return NULL; + goto err; } tprintf("Fetch Index: %u/16 (total: %u)\n", cluster_query->RowIndex, data_amount); - /** Cap results to 16 for faster debugging. TODO: Remove. **/ - data_amount = min(data_amount, 16); + /** Cap results to 16 for faster debugging. TODO: Israel - Remove. **/ +// data_amount = min(data_amount, 16); /** Check that the requested data exists, returning null if we've reached the end of the data. **/ if (cluster_query->RowIndex >= data_amount) return NULL; /** Create the result struct. **/ pDriverData driver_data = check_ptr(nmMalloc(sizeof(DriverData))); - if (driver_data == NULL) return NULL; + if (driver_data == NULL) goto err; memcpy(driver_data, cluster_query->DriverData, sizeof(DriverData)); driver_data->TargetType = new_target_type; driver_data->TargetIndex = cluster_query->RowIndex++; /** Success. **/ return driver_data; + + err: + mssErrorf(0, "Cluster", "Failed to fetch query result."); + return NULL; } @@ -3259,7 +3263,7 @@ int clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val if (datatype != expected_datatype) { mssErrorf(1, "Cluster", - "Type mismatch: Accessing attribute '%s' : %s as type %s.", + "Type mismatch: Accessing attribute ['%s' : %s] as type %s.", attr_name, ci_TypeToStr(expected_datatype), ci_TypeToStr(datatype) ); return -1; @@ -4168,7 +4172,7 @@ int clusterExecuteMethod(void* inf_v, char* method_name, pObjData param, pObjTrx if (param->String == NULL) { mssErrorf(1, "Cluster", - "param : \"show\" | \"show_all\" | \"drop_all\" is required for the cache method." + "[param : \"show\" | \"show_all\" | \"drop_all\"] is required for the cache method." ); goto err; } @@ -4247,7 +4251,7 @@ int clusterExecuteMethod(void* inf_v, char* method_name, pObjData param, pObjTrx /** Unknown parameter. **/ mssErrorf(1, "Cluster", - "Expected param : \"show\" | \"show_all\" | \"drop_all\" the cache method, but got: \"%s\"", + "Expected [param : \"show\" | \"show_all\" | \"drop_all\"] for the cache method, but got: \"%s\"", param->String ); goto err; From 63a4dc224ae126d38c6902d118d2e92872d2490a Mon Sep 17 00:00:00 2001 From: Israel Date: Fri, 7 Nov 2025 11:10:31 -0700 Subject: [PATCH 007/275] Add warning for providing an invalid parameter. Modify cluster files to use string keys. Build vectors fully sparsely. Add ca_fprint_vector(). Add snprint_llu(). Add exp_fn_trim(). Update exp_fn_cmp(). Organize exp function definitions by group. Add statistics tracking to cluster driver. Reduce minimum hint threshold. Add array handling to ci_xaToTrimmedArray(). Update timer to handle multiple starts and stops properly. --- centrallix-lib/include/clusters.h | 13 +- centrallix-lib/include/util.h | 4 +- centrallix-lib/src/clusters.c | 321 ++++++++---- centrallix-lib/src/util.c | 37 +- centrallix-os/cluster-schema.cluster | 9 +- centrallix/expression/exp_functions.c | 325 ++++++++---- centrallix/osdrivers/objdrv_cluster.c | 698 +++++++++++++++----------- 7 files changed, 896 insertions(+), 511 deletions(-) diff --git a/centrallix-lib/include/clusters.h b/centrallix-lib/include/clusters.h index 288f81714..8338cd5e0 100644 --- a/centrallix-lib/include/clusters.h +++ b/centrallix-lib/include/clusters.h @@ -41,7 +41,11 @@ #include "cxlib/xarray.h" #endif -#define CA_NUM_DIMS 251 /* aka. The vector table size. */ +/*** 2147483629 is the signed int max, and is also a prime number. + *** Using this value ensures that the longest run of 0s will not + *** cause an int underflow with the current encoding scheme. + ***/ +#define CA_NUM_DIMS 251 //2147483629 /* aka. The vector table size. */ /// LINK ../../centrallix-sysdoc/string_comparison.md#cosine_charsets /** The character used to create a pair with the first and last characters of a string. **/ @@ -55,8 +59,8 @@ typedef double* pCentroid; /* Dense centroid. */ /** Duplocate information. **/ typedef struct { - unsigned int id1; - unsigned int id2; + void* key1; + void* key2; double similarity; } Dup, *pDup; @@ -70,6 +74,7 @@ typedef struct pVector ca_build_vector(const char* str); unsigned int ca_sparse_len(const pVector vector); +void ca_print_vector(const pVector vector); void ca_free_vector(pVector sparse_vector); int ca_kmeans( pVector* vectors, @@ -105,12 +110,14 @@ pXArray ca_sliding_search( const unsigned int window_size, const double (*similarity)(void*, void*), const double dupe_threshold, + void** maybe_keys, pXArray dups); pXArray ca_complete_search( void** data, const unsigned int num_data, const double (*similarity)(void*, void*), const double dupe_threshold, + void** maybe_keys, pXArray dups); #endif /* End of .h file. */ diff --git a/centrallix-lib/include/util.h b/centrallix-lib/include/util.h index dd821767f..1f286cc26 100644 --- a/centrallix-lib/include/util.h +++ b/centrallix-lib/include/util.h @@ -25,11 +25,12 @@ extern "C" { unsigned int strtoui(const char *nptr, char **endptr, int base); char* snprint_bytes(char* buf, const size_t buf_size, unsigned int bytes); + char* snprint_llu(char* buf, size_t buflen, unsigned long long value); void fprint_mem(FILE* out); typedef struct { - double start, end; + double start, total; } Timer, *pTimer; @@ -38,6 +39,7 @@ extern "C" { pTimer timer_start(pTimer timer); pTimer timer_stop(pTimer timer); double timer_get(pTimer timer); + pTimer timer_reset(pTimer timer); void timer_de_init(pTimer timer); void timer_free(pTimer timer); diff --git a/centrallix-lib/src/clusters.c b/centrallix-lib/src/clusters.c index ef1222873..d61a558c7 100644 --- a/centrallix-lib/src/clusters.c +++ b/centrallix-lib/src/clusters.c @@ -50,18 +50,31 @@ /*** Gets the hash, representing a pair of ASCII characters, represented by unsigned ints. *** Thank you to professor John Delano for this hashing algorithm. *** - *** @param num1 The first character in the pair. - *** @param num1 The second character in the pair. + *** @param c1 The first character in the pair. + *** @param c2 The second character in the pair. *** @returns The resulting hash. ***/ -static unsigned int hash_char_pair(const unsigned int num1, const unsigned int num2) +static unsigned int hash_char_pair(const char c1, const char c2) { - const double sum = (num1 * num1 * num1) + (num2 * num2 * num2); - const double scale = ((double)num1 + 1.0) / ((double)num2 + 1.0); + const double sum = (c1 * c1 * c1) + (c2 * c2 * c2); + const double scale = ((double)c1 + 1.0) / ((double)c2 + 1.0); const unsigned int hash = (unsigned int)round(sum * scale) - 1u; return hash % CA_NUM_DIMS; } +typedef struct + { + unsigned char c1, c2; + unsigned int hash; + } + CharPair, *pCharPair; + +static int charpair_cmp(const void *p1, const void *p2) + { + const CharPair *a = p1, *b = p2; + return a->hash - b->hash; + } + /*** Builds a vector using a string. *** *** Vectors are based on the frequencies of character pairs in the string. @@ -109,123 +122,185 @@ static unsigned int hash_char_pair(const unsigned int num1, const unsigned int n ***/ pVector ca_build_vector(const char* str) { - /** Allocate space for a dense vector. **/ - unsigned int dense_vector[CA_NUM_DIMS] = {0u}; - - /** j is the former character, i is the latter. **/ - const unsigned int num_chars = (unsigned int)strlen(str); - for (unsigned int j = 65535u, i = 0u; i <= num_chars; i++) + char chars[strlen(str) + 2u]; + unsigned int num_chars = 0u; + chars[num_chars++] = CA_BOUNDARY_CHAR; /* Starting boundary character. */ + for (const char* char_ptr = str; *char_ptr != '\0'; char_ptr++) { - /** isspace: space, \n, \v, \f, \r **/ - if (isspace(str[i])) continue; - - /** ispunct: !"#$%&'()*+,-./:;<=>?@[\]^_{|}~ **/ - if (ispunct(str[i]) && str[i] != CA_BOUNDARY_CHAR) continue; + unsigned char c = *char_ptr; - /*** iscntrl (0-8): NULL, SOH, STX, ETX, EOT, ENQ, ACK, BEL, BS - *** (14-31): SO, SI, DLE, DC1-4, NAK, SYN, ETB, CAN EM, - *** SUB, ESC, FS, GS, RS, US - ***/ - if (iscntrl(str[i]) && i != num_chars) - { - fprintf(stderr, - "ca_build_vector(%s) - Warning: Skipping unknown character #%u.\n", - str, (unsigned int)str[i] - ); - continue; - } + /** Always consider boundary character in string. **/ + if (c == CA_BOUNDARY_CHAR) goto skip_checks; - /** First and last character should fall one before 'a' in the ASCII table. **/ - unsigned int temp1 = (j == 65535u) ? CA_BOUNDARY_CHAR : (unsigned int)tolower(str[j]); - unsigned int temp2 = (i == num_chars) ? CA_BOUNDARY_CHAR : (unsigned int)tolower(str[i]); + /** Ignore insignificant characters: spaces and punctuation. **/ + if (isspace(c)) continue; /* space, \n, \v, \f, \r */ + if (ispunct(c)) continue; /* !"#$%&'()*+,-./:;<=>?@[\]^_{|}~ */ + skip_checks: /** Shift numbers to the end of the lowercase letters. **/ - if ('0' <= temp1 && temp1 <= '9') temp1 += 75u; - if ('0' <= temp2 && temp2 <= '9') temp2 += 75u; + if ('0' <= c && c <= '9') c += 75u; - /** Hash the character pair into an index (dimension). **/ - /** Note that temp will be between 97 ('a') and 132 ('9'). **/ - unsigned int dim = hash_char_pair(temp1, temp2); - - /** Increment the dimension of the dense vector by a number from 1 to 13. **/ - dense_vector[dim] += (temp1 + temp2) % 13u + 1u; - - j = i; + /** Store the character. **/ + chars[num_chars++] = tolower(c); } + chars[num_chars++] = CA_BOUNDARY_CHAR; /* Ending boundary character. */ - /** Count how much space is needed for a sparse vector. **/ - bool zero_prev = false; - size_t size = 0u; - for (unsigned int dim = 0u; dim < CA_NUM_DIMS; dim++) + /** Compute char pairs. **/ + CharPair char_pairs[num_chars]; + const unsigned int num_pairs = num_chars - 1u; + for (unsigned int i = 0u; i < num_pairs; i++) { - if (dense_vector[dim] == 0u) - { - size += (zero_prev) ? 0u : 1u; - zero_prev = true; - } - else - { - size++; - zero_prev = false; - } + /** Store characters. **/ + char_pairs[i].c1 = chars[i]; + char_pairs[i].c2 = chars[i + 1]; + + /** Hash the character pair into an index (dimension). **/ + /** Note that the passed value should always be between 97 ('a') and 132 ('9'). **/ + char_pairs[i].hash = hash_char_pair(chars[i], chars[i + 1]); } - /*** Check compression size. - *** If this check fails, I doubt anything will break. However, the longest - *** word I know (supercalifragilisticexpialidocious) has only 35 character - *** pairs, so it shouldn't reach half this size (and it'd be even shorter - *** if the hash generates at least one collision). - *** - *** Bad vector compression will result in degraded performace and increased - *** memory usage. This indicates a likely bug in the code. Thus, if this - *** warning is ever generated, it is definitely worth investigating. - ***/ - const size_t expected_max_size = 64u; - if (size > expected_max_size) - { - fprintf(stderr, - "cli_build_vector(\"%s\") - Warning: Sparse vector larger than expected.\n" - " > Size: %lu\n" - " > #Dims: %u\n", - str, - size, - CA_NUM_DIMS - ); - } + /** Sort char_pairs by hash value. **/ + qsort(char_pairs, num_pairs, sizeof(CharPair), charpair_cmp); - /** Allocate space for sparse vector. **/ - const size_t sparse_vector_size = size * sizeof(int); - pVector sparse_vector = (pVector)check_ptr(nmSysMalloc(sparse_vector_size)); + /** Allocate space for the sparce vector. **/ + pVector sparse_vector = (pVector)check_ptr(nmSysMalloc((num_pairs * 2u + 1u) * sizeof(int))); if (sparse_vector == NULL) return NULL; - /** Convert the dense vector above to a sparse vector. **/ - unsigned int j = 0u, sparse_idx = 0u; - while (j < CA_NUM_DIMS) - { - if (dense_vector[j] == 0u) - { - /*** Count and store consecutive zeros, except the first one, - *** which we already know is zero. - ***/ - unsigned int zero_count = 1u; - j++; - while (j < CA_NUM_DIMS && dense_vector[j] == 0u) - { - zero_count++; - j++; - } - sparse_vector[sparse_idx++] = (int)-zero_count; - } - else + /** Build the sparse vector. **/ + unsigned int cur = 0u, dim = 0u; + for (unsigned int i = 0u; i < num_pairs;) + { + unsigned int hash = char_pairs[i].hash; + + /** Proceed through the pairs until we find a unique hash. **/ + /** Dividing value by 2 each time reduces the impact of repeated pairs. **/ + int value = 0; + for (; i < num_pairs && char_pairs[i].hash == hash; i++) + value = (value / 2) + ((unsigned int)char_pairs[i].c1 + (unsigned int)char_pairs[i].c2) % 13u + 1u; + + /** Skip zeros to reach the dimension index specified by the hash. **/ + unsigned int num_zeros = hash - dim; + if (num_zeros > 0u) { - /** Store the value. **/ - sparse_vector[sparse_idx++] = (int)dense_vector[j++]; + sparse_vector[cur++] = (int)-num_zeros; + dim = hash; } + + /** Add the value to the sparse vector. **/ + sparse_vector[cur++] = value; + dim++; } + if (dim != CA_NUM_DIMS) sparse_vector[cur++] = -(CA_NUM_DIMS - dim); - return sparse_vector; + /** Trim extra space wasted by identical hashes. **/ + pVector trimmed_sparse_vector = (pVector)check_ptr(nmSysRealloc(sparse_vector, cur * sizeof(int))); + if (trimmed_sparse_vector == NULL) return NULL; + + return trimmed_sparse_vector; } +// Build vector by converting a dense vector to a sparse one. +//pVector ca_build_vector_old(const char* str) +// { +// /** Allocate space for a dense vector. **/ +// unsigned int dense_vector[CA_NUM_DIMS] = {0u}; +// +// /** j is the former character, i is the latter. **/ +// const unsigned int num_chars = (unsigned int)strlen(str); +// for (unsigned int j = 65535u, i = 0u; i <= num_chars; i++) +// { +// if (isspace(str[i])) continue; +// if (ispunct(str[i]) && str[i] != CA_BOUNDARY_CHAR) continue; +// +// /** First and last character should fall one before 'a' in the ASCII table. **/ +// unsigned int temp1 = (j == 65535u) ? CA_BOUNDARY_CHAR : (unsigned int)tolower(str[j]); +// unsigned int temp2 = (i == num_chars) ? CA_BOUNDARY_CHAR : (unsigned int)tolower(str[i]); +// +// /** Shift numbers to the end of the lowercase letters. **/ +// if ('0' <= temp1 && temp1 <= '9') temp1 += 75u; +// if ('0' <= temp2 && temp2 <= '9') temp2 += 75u; +// +// /** Hash the character pair into an index (dimension). **/ +// /** Note that temp will be between 97 ('a') and 132 ('9'). **/ +// unsigned int dim = hash_char_pair(temp1, temp2); +// +// /** Increment the dimension of the dense vector by a number from 1 to 13. **/ +// dense_vector[dim] += (temp1 + temp2) % 13u + 1u; +// +// j = i; +// } +// +// /** Count how much space is needed for a sparse vector. **/ +// bool zero_prev = false; +// size_t size = 0u; +// for (unsigned int dim = 0u; dim < CA_NUM_DIMS; dim++) +// { +// if (dense_vector[dim] == 0u) +// { +// size += (zero_prev) ? 0u : 1u; +// zero_prev = true; +// } +// else +// { +// size++; +// zero_prev = false; +// } +// } +// +// /*** Check compression size. +// *** If this check fails, I doubt anything will break. However, the longest +// *** word I know (supercalifragilisticexpialidocious) has only 35 character +// *** pairs, so it shouldn't reach half this size (and it'd be even shorter +// *** if the hash generates at least one collision). +// *** +// *** Bad vector compression will result in degraded performace and increased +// *** memory usage. This indicates a likely bug in the code. Thus, if this +// *** warning is ever generated, it is definitely worth investigating. +// ***/ +// const size_t expected_max_size = 256u; +// if (size > expected_max_size) +// { +// fprintf(stderr, +// "cli_build_vector(\"%s\") - Warning: Sparse vector larger than expected.\n" +// " > Size: %lu\n" +// " > #Dims: %u\n", +// str, +// size, +// CA_NUM_DIMS +// ); +// } +// +// /** Allocate space for sparse vector. **/ +// const size_t sparse_vector_size = size * sizeof(int); +// pVector sparse_vector = (pVector)check_ptr(nmSysMalloc(sparse_vector_size)); +// if (sparse_vector == NULL) return NULL; +// +// /** Convert the dense vector above to a sparse vector. **/ +// unsigned int dim = 0u, sparse_idx = 0u; +// while (dim < CA_NUM_DIMS) +// { +// if (dense_vector[dim] == 0u) +// { +// /** Count and store consecutive zeros, skipping the first one. **/ +// unsigned int zero_count = 1u; +// dim++; +// while (dim < CA_NUM_DIMS && dense_vector[dim] == 0u) +// { +// zero_count++; +// dim++; +// } +// sparse_vector[sparse_idx++] = (int)-zero_count; +// } +// else +// { +// /** Store the value. **/ +// sparse_vector[sparse_idx++] = (int)dense_vector[dim++]; +// } +// } +// +// return sparse_vector; +// } + /*** Free memory allocated to store a sparse vector. *** *** @param sparse_vector The sparse vector being freed. @@ -256,6 +331,21 @@ unsigned int ca_sparse_len(const pVector vector) return i; } +/*** Print the underlying implementation values sparsely allocated + *** vector (intended for debugging). + *** + *** @param out File to print to. + *** @param vector The vector. + ***/ +void ca_fprint_vector(FILE* out, const pVector vector) + { + const unsigned int len = ca_sparse_len(vector); + fprintf(out, "Vector: [%d", vector[0]); + for (unsigned int i = 1u; i < len; i++) + fprintf(out, ", %d", vector[i]); + fprintf(out, "]"); + } + /*** Compute the magnitude of a sparsely allocated vector. *** *** @param vector The vector. @@ -911,6 +1001,9 @@ void* ca_most_similar( *** the data param and returns their similarity. *** @param threshold The minimum threshold required for a duplocate to be *** included in the returned xArray. + *** @param maybe_keys A pointer to an array of keys, with one key per data. + *** These will be used to fill in the key1 and key2 attributes for each + *** struct. If this variable is null, these values are also left null. *** @param maybe_dups A pointer to an xArray in which dups should be found. *** Pass NULL to allocate a new one. *** @returns An xArray holding all of the duplocates found. If maybe_dups is @@ -922,11 +1015,12 @@ pXArray ca_sliding_search( const unsigned int window_size, const double (*similarity)(void*, void*), const double threshold, - pXArray dups) + void** maybe_keys, + pXArray maybe_dups) { /** Allocate space for dups (if necessary). **/ - const bool allocate_dups = (dups == NULL); - if (allocate_dups) + pXArray dups = maybe_dups; + if (dups == NULL) { /** Guess that we will need space for num_data * 2 dups. **/ const int guess_size = num_data * 2; @@ -955,8 +1049,11 @@ pXArray ca_sliding_search( glyph(find); Dup* dup = (Dup*)check_ptr(nmMalloc(sizeof(Dup))); if (dup == NULL) goto err_free_dups; - dup->id1 = i; - dup->id2 = j; + if (maybe_keys != NULL) + { + dup->key1 = maybe_keys[i]; + dup->key2 = maybe_keys[j]; + } dup->similarity = sim; if (!check_neg(xaAddItem(dups, (void*)dup))) goto err_free_dups; } @@ -973,7 +1070,7 @@ pXArray ca_sliding_search( /** Free the dups we added to the XArray. */ while (dups->nItems > num_starting_dups) nmFree(dups->Items[dups->nItems--], sizeof(Dup)); - if (allocate_dups) check(xaDeInit(dups)); /* Failure ignored. */ + if (maybe_dups == NULL) check(xaDeInit(dups)); /* Failure ignored. */ err: return NULL; @@ -990,6 +1087,9 @@ pXArray ca_sliding_search( *** the data param and returns their similarity. *** @param threshold The minimum threshold required for a duplocate to be *** included in the returned xArray. + *** @param maybe_keys A pointer to an array of keys, with one key per data. + *** These will be used to fill in the key1 and key2 attributes for each + *** struct. If this variable is null, these values are also left null. *** @param maybe_dups A pointer to an xArray in which dups should be found. *** Pass NULL to allocate a new one. *** @returns An xArray holding all of the duplocates found. If maybe_dups is @@ -1000,9 +1100,10 @@ pXArray ca_complete_search( const unsigned int num_data, const double (*similarity)(void*, void*), const double threshold, - pXArray dups) + void** maybe_keys, + pXArray maybe_dups) { - return ca_sliding_search(data, num_data, num_data, similarity, threshold, dups); + return ca_sliding_search(data, num_data, num_data, similarity, threshold, maybe_keys, maybe_dups); } /** Scope cleanup. **/ diff --git a/centrallix-lib/src/util.c b/centrallix-lib/src/util.c index 450c16593..b18361280 100644 --- a/centrallix-lib/src/util.c +++ b/centrallix-lib/src/util.c @@ -155,6 +155,32 @@ char* snprint_bytes(char* buf, const size_t buf_size, unsigned int bytes) } #undef nUints +char* snprint_llu(char* buf, size_t buflen, unsigned long long value) + { + if (buflen == 0) return NULL; + if (value == 0) + { + if (buflen > 1) { buf[0] = '0'; buf[1] = '\0'; } + else buf[0] = '\0'; + return buf; + } + + char tmp[32]; + unsigned int ti = 0; + while (value > 0 && ti < sizeof(tmp) - 1) + { + if (ti % 4 == 3) tmp[ti++] = ','; + tmp[ti++] = '0' + (value % 10); + value /= 10; + } + tmp[ti] = '\0'; + + unsigned int outlen = min(ti, buflen - 1u); + for (unsigned int i = 0u; i < outlen; i++) buf[i] = tmp[ti - i - 1]; + buf[outlen] = '\0'; + return buf; + } + void fprint_mem(FILE* out) { FILE* fp = fopen("/proc/self/statm", "r"); @@ -192,7 +218,7 @@ pTimer timer_init(pTimer timer) { if (timer == NULL) return NULL; timer->start = NAN; - timer->end = NAN; + timer->total = 0.0; return timer; } @@ -211,13 +237,18 @@ pTimer timer_start(pTimer timer) pTimer timer_stop(pTimer timer) { if (!timer) return timer; - timer->end = get_time(); + timer->total += get_time() - timer->start; return timer; } double timer_get(pTimer timer) { - return (timer) ? timer->end - timer->start : NAN; + return (timer) ? timer->total : NAN; + } + +pTimer timer_reset(pTimer timer) + { + return timer_init(timer); } void timer_de_init(pTimer timer) {} diff --git a/centrallix-os/cluster-schema.cluster b/centrallix-os/cluster-schema.cluster index e87ae6b5f..277e2bb12 100644 --- a/centrallix-os/cluster-schema.cluster +++ b/centrallix-os/cluster-schema.cluster @@ -14,7 +14,8 @@ file_name "system/cluster" ... source : DataSourcePath - attr_name : string ⊂ DataSourcePath/columns + key_attr : string ⊂ DataSourcePath/columns + data_attr : string ⊂ DataSourcePath/columns cluster_name "cluster/cluster" { @@ -54,10 +55,8 @@ file_name "system/cluster" ... /search_name - /{query} - - /id1 : uint < sizeof(source/attr_name) // The id of the first data point. - - /id2 : uint < sizeof(source/attr_name) // The id of the second data point. - - /val1 : string // The value of the first data point. - - /val2 : string // The value of the second data point. + - /key1 : string // The key of the first data point. + - /key2 : string // The key of the second data point. - /sim : double && 0.0 < x <= threshold // The similarity of the two data points. ... diff --git a/centrallix/expression/exp_functions.c b/centrallix/expression/exp_functions.c index 751e07297..71f906e3d 100644 --- a/centrallix/expression/exp_functions.c +++ b/centrallix/expression/exp_functions.c @@ -74,16 +74,30 @@ #include "expression.h" #include "obj.h" -/** Duplocate detection settings. **/ -// #define SEPARATOR "|" -// #define SEPARATOR_CHAR '|' -// #define DBL_BUF_SIZE 16u -// #define USE_PARALLEL_COMPLETE_SEARCH true -// #define MIN_PARALLEL_COMPLETE_SEARCH 1000 -// #define MAX_COMPLETE_SEARCH 50 * 1000 // Default: 100 * 1000 -// #define KMEANS_IMPROVEMENT_THRESHOLD 0.0002 -#define EXP_NUM_DIMS 251 /* aka. The size of the vector table. */ -const int EXP_VECTOR_TABLE_SIZE = EXP_NUM_DIMS; /* Should probably be removed. */ + +/** TODO: I think this should be moved to datatypes. **/ +/** Should maybe replace duplocate functionality elsewhere. **/ +static char* ci_TypeToStr(const int type) + { + switch (type) + { + case DATA_T_UNAVAILABLE: return "Unknown"; + case DATA_T_INTEGER: return "Integer"; + case DATA_T_STRING: return "String"; + case DATA_T_DOUBLE: return "Double"; + case DATA_T_DATETIME: return "DateTime"; + case DATA_T_INTVEC: return "IntVecor"; + case DATA_T_STRINGVEC: return "StringVector"; + case DATA_T_MONEY: return "Money"; + case DATA_T_ARRAY: return "Array"; + case DATA_T_CODE: return "Code"; + case DATA_T_BINARY: return "Binary"; + } + + /** Invalid type. **/ + mssErrorf(1, "Cluster", "Invalid type %d.\n", type); + return "Invalid"; /* Shall not parse to a valid type in ci_TypeFromStr(). */ + } /****** Evaluator functions follow for expEvalFunction ******/ @@ -1239,6 +1253,31 @@ int exp_fn_rtrim(pExpression tree, pParamObjects objlist, pExpression i0, pExpre } +int exp_fn_trim(pExpression tree, pParamObjects objlist, pExpression i0, pExpression i1, pExpression i2) + { + int ret; + + /** Invoke left trim. **/ + ret = exp_fn_ltrim(tree, objlist, i0, i1, i2); + if (ret != 0) + { + mssErrorf(0, "EXP", "Failed to left trim (error code: %d).", ret); + return ret; + } + + /** Invoke right trim. **/ + ret = exp_fn_rtrim(tree, objlist, i0, i1, i2); + if (ret != 0) + { + mssErrorf(0, "EXP", "Failed to right trim (error code: %d).", ret); + return ret; + } + + /** Success. **/ + return 0; + } + + int exp_fn_right(pExpression tree, pParamObjects objlist, pExpression i0, pExpression i1, pExpression i2) { int n,i; @@ -4105,10 +4144,8 @@ int exp_fn_nth(pExpression tree, pParamObjects objlist, pExpression i0, pExpress *** @param is_cos Whether to compute cosine or levenshtien. *** @returns 0 for success, -1 for failure. ***/ -static int exp_fn_cmp(pExpression tree, pParamObjects objlist, pExpression maybe_str1, pExpression maybe_str2, pExpression u1, bool is_cos) +static int exp_fn_cmp(pExpression tree, pParamObjects objlist, pExpression maybe_str1, pExpression maybe_str2, pExpression u1, const char* fn_name) { - const char fn_name[] = "cos_cmp"; - /** Check number of arguments. **/ const int num_params = tree->Children.nItems; if (num_params != 2) @@ -4138,49 +4175,33 @@ static int exp_fn_cmp(pExpression tree, pParamObjects objlist, pExpression maybe /** Extract str1. **/ if (maybe_str1->Flags & EXPR_F_NULL) { - mssErrorf(1, "EXP", "%s(NULL, ...) str1 cannot be NULL.", fn_name); - return -1; + tree->Flags |= EXPR_F_NULL; + tree->DataType = DATA_T_DOUBLE; + return 0; } if (maybe_str1->DataType != DATA_T_STRING) { mssErrorf(1, "EXP", "%s(\?\?\?, ..) str1 should be a string.", fn_name); return -1; } - char* str1 = maybe_str1->String; - if (str1 == NULL) - { - mssErrorf(1, "EXP", - "%s(nothing?, ...) expected string from str1 (of datatype DataType = " - "DATA_T_STRING), but the String was NULL or did not exist!", - fn_name - ); - return -1; - } + char* str1 = check_ptr(maybe_str1->String); /** Extract str2. **/ if (maybe_str2->Flags & EXPR_F_NULL) { - mssErrorf(1, "EXP", "%s(\"%s\", NULL) str2 cannot be NULL.", fn_name, str1); - return -1; + tree->Flags |= EXPR_F_NULL; + tree->DataType = DATA_T_DOUBLE; + return 0; } if (maybe_str2->DataType != DATA_T_STRING) { mssErrorf(1, "EXP", "%s(\"%s\", \?\?\?) str2 should be a string.", fn_name, str1); return -1; } - char* str2 = maybe_str2->String; - if (str2 == NULL) - { - mssErrorf(1, "EXP", - "%s(\"%s\", nothing?) expected string from str2 (of datatype DataType = " - "DATA_T_STRING), but the String was NULL or did not exist!", - fn_name, str1 - ); - return -1; - } + char* str2 = check_ptr(maybe_str2->String); /** Handle either cos_cmp or lev_cmp. **/ - if (is_cos) + if (fn_name[0] == 'c') { /* cos_cmp */ int ret; @@ -4215,35 +4236,20 @@ static int exp_fn_cmp(pExpression tree, pParamObjects objlist, pExpression maybe return -1; } -/*** Computes cosine similarity between two strings. - *** - *** @param tree The tree resulting from this function. - *** @param objlist The evaluation "scope", including available variables. - *** @param maybe_str1 Possibly the first string. - *** @param maybe_str2 Possibly the second string. - *** @param u1 Unused parameter. - *** @returns 0 for success, -1 for failure. - ***/ -int exp_fn_cos_cmp(pExpression tree, pParamObjects objlist, pExpression maybe_str1, pExpression maybe_str2, pExpression u1) - { - return exp_fn_cmp(tree, objlist, maybe_str1, maybe_str2, u1, true); - } -/*** Computes levenshtein similarity by normalizing the levenshtein edit - *** distance between two strings with the length of the longer string. - *** - *** @param tree The tree resulting from this function. - *** @param objlist The evaluation "scope", including available variables. - *** @param maybe_str1 Possibly the first string. - *** @param maybe_str2 Possibly the second string. - *** @param u1 Unused parameter. - *** @returns 0 for success, -1 for failure. - ***/ +int exp_fn_cos_cmp(pExpression tree, pParamObjects objlist, pExpression maybe_str1, pExpression maybe_str2, pExpression u1) + { return exp_fn_cmp(tree, objlist, maybe_str1, maybe_str2, u1, "cos_cmp"); } +int exp_fn_cos_compare(pExpression tree, pParamObjects objlist, pExpression maybe_str1, pExpression maybe_str2, pExpression u1) + { return exp_fn_cmp(tree, objlist, maybe_str1, maybe_str2, u1, "cos_compare"); } +int exp_fn_cosine_compare(pExpression tree, pParamObjects objlist, pExpression maybe_str1, pExpression maybe_str2, pExpression u1) + { return exp_fn_cmp(tree, objlist, maybe_str1, maybe_str2, u1, "cosine_compare"); } int exp_fn_lev_cmp(pExpression tree, pParamObjects objlist, pExpression maybe_str1, pExpression maybe_str2, pExpression u1) - { - return exp_fn_cmp(tree, objlist, maybe_str1, maybe_str2, u1, false); - } - + { return exp_fn_cmp(tree, objlist, maybe_str1, maybe_str2, u1, "lev_cmp"); } +int exp_fn_lev_compare(pExpression tree, pParamObjects objlist, pExpression maybe_str1, pExpression maybe_str2, pExpression u1) + { return exp_fn_cmp(tree, objlist, maybe_str1, maybe_str2, u1, "lev_compare"); } +int exp_fn_levenshtein_compare(pExpression tree, pParamObjects objlist, pExpression maybe_str1, pExpression maybe_str2, pExpression u1) + { return exp_fn_cmp(tree, objlist, maybe_str1, maybe_str2, u1, "levenshtein_compare"); } + /*** Comparse two strings to see if their sparse vectors are equal. *** @@ -4435,6 +4441,110 @@ int exp_fn_double_metaphone(pExpression tree, pParamObjects objlist, pExpression return 0; } + +int exp_fn_aggregate_similarities(pExpression tree, pParamObjects objlist) + { + const char fn_name[] = "aggregate_similarities"; + + /** Check number of arguments. **/ + const int num_params = tree->Children.nItems; + if (num_params != 6) + { + mssErrorf(1, "EXP", "%s(?) expects 6 parameters, got %d parameters.", fn_name, num_params); + return -1; + } + + /** Magic checks. **/ + ASSERTMAGIC(tree, MGK_EXPRESSION); + ASSERTMAGIC(tree->Children.Items[0], MGK_EXPRESSION); + ASSERTMAGIC(tree->Children.Items[1], MGK_EXPRESSION); + ASSERTMAGIC(tree->Children.Items[2], MGK_EXPRESSION); + ASSERTMAGIC(tree->Children.Items[3], MGK_EXPRESSION); + + /** Check object list. **/ + if (objlist == NULL) + { + mssErrorf(1, "EXP", "%s(\?\?\?) no object list?", fn_name); + return -1; + } + ASSERTMAGIC(objlist->Session, MGK_OBJSESSION); + + /** Extract parameters. **/ + double params[4] = {NAN}; + const char names[4][8] = {"name", "email", "phone", "address"}; + for (unsigned int i = 0; i < 4u; i++) + { + pExpression param = (pExpression)tree->Children.Items[i]; + + /** Ignore null values. **/ + if (param->Flags & EXPR_F_NULL) continue; + + /** Only accept doubles. **/ + if (param->DataType != DATA_T_DOUBLE) + { + mssErrorf(1, "EXP", + "%s() param%u (%s) expected type %s but got %s.", + fn_name, i, names[i], ci_TypeToStr(DATA_T_DOUBLE), ci_TypeToStr(param->DataType) + ); + if (param->DataType == DATA_T_INTEGER) fprintf(stderr, "Value: %d\n", param->Integer); + return -1; + } + + /** Do not accept NaN. **/ + params[i] = param->Types.Double; + if (isnan(params[i])) + { + mssErrorf(1, "EXP", "%s() param%u (%s) cannot be NaN", fn_name, names[i], i); + return -1; + } + } + + char* dup_names[2] = {NULL}; + for (unsigned int i = 0; i < 2u; i++) + { + pExpression param = (pExpression)tree->Children.Items[i + 4u]; + + /** Ignore null values. **/ + if (param->Flags & EXPR_F_NULL) continue; + + /** Only accept doubles. **/ + if (param->DataType != DATA_T_STRING) + { + mssErrorf(1, "EXP", + "%s() param%u expected type %s but got %s.", + fn_name, i, ci_TypeToStr(DATA_T_STRING), ci_TypeToStr(param->DataType) + ); + return -1; + } + + dup_names[i] = param->String; + } + + FILE *f = check_ptr(fopen("/home/israel/exp_log.swift", "a")); + check_neg(fprintf(f, "aggregate_similarities(%g, %g, %g, %g, \"%s\", \"%s\")", params[0], params[1], params[2], params[3], dup_names[0], dup_names[1])); + + /** Compute aggregated similarity. **/ + double name_sim = params[0]; + double email_sim = params[1]; + double phone_sim = params[2]; + double address_sim = params[3]; + + double mean = 0.0, n = 0.0; + if (name_sim > 0.0) { mean += name_sim; n++; } + if (email_sim > 0.0) { mean += email_sim; n++; } + if (phone_sim > 0.0) { mean += phone_sim; n++; } + if (address_sim > 0.0) { mean += address_sim; n++; } + mean /= n; + + /** Success. **/ + tree->DataType = DATA_T_DOUBLE; + tree->Types.Double = mean; + fprintf(f, " = %g\n", tree->Types.Double); + check(fclose(f)); + return 0; + } + + /* * exp_fn_argon2id * This method hashes a given password using the Argon2 algorithm (ID variant) @@ -4557,27 +4667,42 @@ int exp_fn_argon2id(pExpression tree, pParamObjects objlist, pExpression passwor int exp_internal_DefineFunctions() { - /** Initialize library **/ + /** Initialize library. **/ ca_init(); - /** Function list for EXPR_N_FUNCTION nodes **/ - xhAdd(&EXP.Functions, "getdate", (char*)exp_fn_getdate); + /** Function list for EXPR_N_FUNCTION nodes. **/ + + /** General. **/ xhAdd(&EXP.Functions, "user_name", (char*)exp_fn_user_name); xhAdd(&EXP.Functions, "convert", (char*)exp_fn_convert); xhAdd(&EXP.Functions, "wordify", (char*)exp_fn_wordify); xhAdd(&EXP.Functions, "abs", (char*)exp_fn_abs); xhAdd(&EXP.Functions, "ascii", (char*)exp_fn_ascii); xhAdd(&EXP.Functions, "condition", (char*)exp_fn_condition); - xhAdd(&EXP.Functions, "charindex", (char*)exp_fn_charindex); - xhAdd(&EXP.Functions, "upper", (char*)exp_fn_upper); - xhAdd(&EXP.Functions, "lower", (char*)exp_fn_lower); - xhAdd(&EXP.Functions, "mixed", (char*)exp_fn_mixed); - xhAdd(&EXP.Functions, "char_length", (char*)exp_fn_char_length); - xhAdd(&EXP.Functions, "datepart", (char*)exp_fn_datepart); xhAdd(&EXP.Functions, "isnull", (char*)exp_fn_isnull); + xhAdd(&EXP.Functions, "eval", (char*)exp_fn_eval); + xhAdd(&EXP.Functions, "truncate", (char*)exp_fn_truncate); + xhAdd(&EXP.Functions, "constrain", (char*)exp_fn_constrain); + xhAdd(&EXP.Functions, "has_endorsement", (char*)exp_fn_has_endorsement); + xhAdd(&EXP.Functions, "rand", (char*)exp_fn_rand); + xhAdd(&EXP.Functions, "nullif", (char*)exp_fn_nullif); + xhAdd(&EXP.Functions, "hash", (char*)exp_fn_hash); + xhAdd(&EXP.Functions, "hmac", (char*)exp_fn_hmac); + xhAdd(&EXP.Functions, "pbkdf2", (char*)exp_fn_pbkdf2); + xhAdd(&EXP.Functions, "octet_length", (char*)exp_fn_octet_length); + xhAdd(&EXP.Functions, "argon2id",(char*)exp_fn_argon2id); + + /** Dates. **/ + xhAdd(&EXP.Functions, "getdate", (char*)exp_fn_getdate); + xhAdd(&EXP.Functions, "datepart", (char*)exp_fn_datepart); + xhAdd(&EXP.Functions, "dateadd", (char*)exp_fn_dateadd); + xhAdd(&EXP.Functions, "datediff", (char*)exp_fn_datediff); + + /** Strings. **/ xhAdd(&EXP.Functions, "ltrim", (char*)exp_fn_ltrim); xhAdd(&EXP.Functions, "lztrim", (char*)exp_fn_lztrim); xhAdd(&EXP.Functions, "rtrim", (char*)exp_fn_rtrim); + xhAdd(&EXP.Functions, "trim", (char*)exp_fn_trim); xhAdd(&EXP.Functions, "substring", (char*)exp_fn_substring); xhAdd(&EXP.Functions, "right", (char*)exp_fn_right); xhAdd(&EXP.Functions, "ralign", (char*)exp_fn_ralign); @@ -4587,12 +4712,22 @@ int exp_internal_DefineFunctions() xhAdd(&EXP.Functions, "escape", (char*)exp_fn_escape); xhAdd(&EXP.Functions, "quote", (char*)exp_fn_quote); xhAdd(&EXP.Functions, "substitute", (char*)exp_fn_substitute); - xhAdd(&EXP.Functions, "eval", (char*)exp_fn_eval); + xhAdd(&EXP.Functions, "upper", (char*)exp_fn_upper); + xhAdd(&EXP.Functions, "lower", (char*)exp_fn_lower); + xhAdd(&EXP.Functions, "mixed", (char*)exp_fn_mixed); + xhAdd(&EXP.Functions, "char_length", (char*)exp_fn_char_length); + xhAdd(&EXP.Functions, "charindex", (char*)exp_fn_charindex); + xhAdd(&EXP.Functions, "dateformat", (char*)exp_fn_dateformat); + xhAdd(&EXP.Functions, "moneyformat", (char*)exp_fn_moneyformat); + + /** Numbering systems (e.g. base 16 aka. hex, base 8 aka. octal, etc.). **/ + xhAdd(&EXP.Functions, "to_base64", (char*)exp_fn_to_base64); + xhAdd(&EXP.Functions, "from_base64", (char*)exp_fn_from_base64); + xhAdd(&EXP.Functions, "to_hex", (char*)exp_fn_to_hex); + xhAdd(&EXP.Functions, "from_hex", (char*)exp_fn_from_hex); + + /** Math. **/ xhAdd(&EXP.Functions, "round", (char*)exp_fn_round); - xhAdd(&EXP.Functions, "dateadd", (char*)exp_fn_dateadd); - xhAdd(&EXP.Functions, "datediff", (char*)exp_fn_datediff); - xhAdd(&EXP.Functions, "truncate", (char*)exp_fn_truncate); - xhAdd(&EXP.Functions, "constrain", (char*)exp_fn_constrain); xhAdd(&EXP.Functions, "sin", (char*)exp_fn_sin); xhAdd(&EXP.Functions, "cos", (char*)exp_fn_cos); xhAdd(&EXP.Functions, "tan", (char*)exp_fn_tan); @@ -4604,41 +4739,28 @@ int exp_internal_DefineFunctions() xhAdd(&EXP.Functions, "square", (char*)exp_fn_square); xhAdd(&EXP.Functions, "degrees", (char*)exp_fn_degrees); xhAdd(&EXP.Functions, "radians", (char*)exp_fn_radians); - xhAdd(&EXP.Functions, "has_endorsement", (char*)exp_fn_has_endorsement); - xhAdd(&EXP.Functions, "rand", (char*)exp_fn_rand); - xhAdd(&EXP.Functions, "nullif", (char*)exp_fn_nullif); - xhAdd(&EXP.Functions, "dateformat", (char*)exp_fn_dateformat); - xhAdd(&EXP.Functions, "moneyformat", (char*)exp_fn_moneyformat); - xhAdd(&EXP.Functions, "hash", (char*)exp_fn_hash); - xhAdd(&EXP.Functions, "hmac", (char*)exp_fn_hmac); xhAdd(&EXP.Functions, "log10", (char*)exp_fn_log10); xhAdd(&EXP.Functions, "ln", (char*)exp_fn_log_natural); xhAdd(&EXP.Functions, "logn", (char*)exp_fn_log_base_n); xhAdd(&EXP.Functions, "power", (char*)exp_fn_power); - xhAdd(&EXP.Functions, "pbkdf2", (char*)exp_fn_pbkdf2); - xhAdd(&EXP.Functions, "to_base64", (char*)exp_fn_to_base64); - xhAdd(&EXP.Functions, "from_base64", (char*)exp_fn_from_base64); - xhAdd(&EXP.Functions, "to_hex", (char*)exp_fn_to_hex); - xhAdd(&EXP.Functions, "from_hex", (char*)exp_fn_from_hex); - xhAdd(&EXP.Functions, "octet_length", (char*)exp_fn_octet_length); - xhAdd(&EXP.Functions, "argon2id",(char*)exp_fn_argon2id); - /** Duplicate Detection **/ + /** Duplicate detection. **/ xhAdd(&EXP.Functions, "cos_cmp", (char*)exp_fn_cos_cmp); - xhAdd(&EXP.Functions, "cos_compare", (char*)exp_fn_cos_cmp); - xhAdd(&EXP.Functions, "cosine_compare", (char*)exp_fn_cos_cmp); + xhAdd(&EXP.Functions, "cos_compare", (char*)exp_fn_cos_compare); + xhAdd(&EXP.Functions, "cosine_compare", (char*)exp_fn_cosine_compare); xhAdd(&EXP.Functions, "lev_cmp", (char*)exp_fn_lev_cmp); - xhAdd(&EXP.Functions, "lev_compare", (char*)exp_fn_lev_cmp); - xhAdd(&EXP.Functions, "levenshtein_compare", (char*)exp_fn_lev_cmp); + xhAdd(&EXP.Functions, "lev_compare", (char*)exp_fn_lev_compare); + xhAdd(&EXP.Functions, "levenshtein_compare", (char*)exp_fn_levenshtein_compare); xhAdd(&EXP.Functions, "sparse_eql", (char*)exp_fn_sparse_eql); + xhAdd(&EXP.Functions, "aggregate_similarities", (char*)exp_fn_aggregate_similarities); xhAdd(&EXP.Functions, "double_metaphone", (char*)exp_fn_double_metaphone); - /** Windowing **/ + /** Windowing. **/ xhAdd(&EXP.Functions, "row_number", (char*)exp_fn_row_number); xhAdd(&EXP.Functions, "dense_rank", (char*)exp_fn_dense_rank); xhAdd(&EXP.Functions, "lag", (char*)exp_fn_lag); - /** Aggregate **/ + /** Aggregate. **/ xhAdd(&EXP.Functions, "count", (char*)exp_fn_count); xhAdd(&EXP.Functions, "avg", (char*)exp_fn_avg); xhAdd(&EXP.Functions, "sum", (char*)exp_fn_sum); @@ -4648,7 +4770,8 @@ int exp_internal_DefineFunctions() xhAdd(&EXP.Functions, "last", (char*)exp_fn_last); xhAdd(&EXP.Functions, "nth", (char*)exp_fn_nth); - /** Reverse functions **/ + + /** Reverse functions. **/ xhAdd(&EXP.ReverseFunctions, "isnull", (char*)exp_fn_reverse_isnull); return 0; diff --git a/centrallix/osdrivers/objdrv_cluster.c b/centrallix/osdrivers/objdrv_cluster.c index 6d1aaf313..b3d416668 100644 --- a/centrallix/osdrivers/objdrv_cluster.c +++ b/centrallix/osdrivers/objdrv_cluster.c @@ -33,6 +33,7 @@ #include #include #include +#include #include #include #include @@ -159,7 +160,7 @@ void mssErrorf(int clr, char* module, const char* format, ...) *** *** LINK ../../centrallix-lib/include/datatypes.h:72 ***/ -int ci_TypeFromStr(const char* str) +static int ci_TypeFromStr(const char* str) { /** All valid types are non-null strings, at least 2 characters long. **/ if (str == NULL || str[0] == '\0' || str[1] == '\0') return -1; @@ -211,7 +212,7 @@ int ci_TypeFromStr(const char* str) /** TODO: I think this should be moved to datatypes. **/ /** Should maybe replace duplocate functionality elsewhere. **/ -char* ci_TypeToStr(const int type) +static char* ci_TypeToStr(const int type) { switch (type) { @@ -234,17 +235,37 @@ char* ci_TypeToStr(const int type) } /** TODO: I think this should be moved to xarray. **/ -/** Contract: Return value is null iff pXArray has 0 items. **/ -void** ci_xaToTrimmedArray(pXArray arr) +/*** Trims an xArray, returning a new array (with nmSysMalloc). + *** + *** @param arr The array to be trimmed. + *** @param cleanup 0: No clean up. + *** 1: DeInit arr. + *** 2: Free arr. + *** *: Any other value prints a warning and does nothing. + *** @returns The new array, or null if and only if the passed pXArray has 0 items. + ***/ +static void** ci_xaToTrimmedArray(pXArray arr, int array_handling) { - if (arr->nItems == 0) { - mssErrorf(1, "Cluster", "Failed to trim XArray of length 0."); - return NULL; - } - const size_t arr_size = arr->nItems * sizeof(void*); void** result = check_ptr(nmSysMalloc(arr_size)); + if (result == NULL) return NULL; memcpy(result, arr->Items, arr_size); + + /** Handle the array. **/ + switch (array_handling) + { + case 0: break; + case 1: check(xaDeInit(arr)); arr->nAlloc = 0; break; /* Failure ignored. */ + case 2: check(xaFree(arr)); break; /* Failure ignored. */ + default: + /** Uh oh, there might be a memory leak... **/ + fprintf(stderr, + "Warning: ci_xaToTrimmedArray(%p, %d) - Unknown value (%d) for array_handling.\n", + arr, array_handling, array_handling + ); + break; + } + return result; } @@ -376,8 +397,8 @@ char* const ATTR_CLUSTER_ENTRY[] = }; char* const ATTR_SEARCH_ENTRY[] = { - "val1", - "val2", + "key1", + "key2", "sim", END_OF_ARRAY, }; @@ -397,15 +418,20 @@ char* const METHOD_NAME[] = *** *** Memory Stats: *** - Padding: 4 bytes - *** - Total size: 72 bytes + *** - Total size: 80 bytes *** *** @skip --> Attribute Data. *** @param Name The source name, specified in the .cluster file. *** @param Key The key associated with this object in the SourceDataCache. *** @param SourcePath The path to the data source from which to retrieve data. - *** @param AttrName The name of the attribute to get from the data source. + *** @param KeyAttr The name of the attribute to use when getting keys from + *** the SourcePath. + *** @param NameAttr The name of the attribute to use when getting data from + *** the SourcePath. *** *** @skip --> Computed data. + *** @param Strings The keys for each data string strings recieved from the + *** database, allowing them to be lined up again when queried. *** @param Strings The data strings to be clustered and searched, or NULL if *** they have not been fetched from the source. *** @param Vectors The cosine comparison vectors from the fetched data, or @@ -416,14 +442,16 @@ char* const METHOD_NAME[] = *** *** @skip --> Time. *** @param DateCreated The date and time that this object was created and initialized. - *** @param DateComputed The date and time that the Labels field was computed. + *** @param DateComputed The date and time that the computed attributes were computed. ***/ typedef struct _SOURCE { char* Name; char* Key; char* SourcePath; - char* AttrName; + char* KeyAttr; + char* NameAttr; + char** Keys; char** Strings; pVector* Vectors; unsigned int nVectors; @@ -468,7 +496,7 @@ typedef struct *** each clustering iteration. If there is less improvement, the algorithm *** will stop. The "max" in a .cluster file is represented by -inf. *** @param MaxIterations The maximum number of iterations that a clustering - *** algorithm can run for. Note: Sliding window uses this field to store + *** algorithm can run for. Note: Sliding window uses this attribute to store *** the window_size. *** *** @skip --> Relationship Data. @@ -481,12 +509,12 @@ typedef struct *** @param Clusters An array of length num_clusters, NULL if the clusters *** have not yet been computed. *** @param Sims An array of num_vectors elements, where index i stores the - *** similarity of vector i to its assigned cluster. This field is NULL + *** similarity of vector i to its assigned cluster. This attribute is NULL *** if the clusters have not yet been computed. *** *** @skip --> Time. *** @param DateCreated The date and time that this object was created and initialized. - *** @param DateComputed The date and time that the Labels field was computed. + *** @param DateComputed The date and time that the computed attributes were computed. ***/ typedef struct _CLUSTER { @@ -530,7 +558,7 @@ typedef struct _CLUSTER *** *** @skip --> Time. *** @param DateCreated The date and time that this object was created and initialized. - *** @param DateComputed The date and time that the Dups field was computed. + *** @param DateComputed The date and time that the computed attributes were computed. ***/ typedef struct _SEARCH { @@ -653,6 +681,20 @@ struct } ClusterDriverCaches; +struct + { + unsigned long long OpenCalls; + unsigned long long OpenQueryCalls; + unsigned long long FetchCalls; + unsigned long long CloseCalls; + unsigned long long GetTypeCalls; + unsigned long long GetValCalls; + unsigned long long GetValCalls_name; + unsigned long long GetValCalls_key1; + unsigned long long GetValCalls_key2; + unsigned long long GetValCalls_sim; + } ClusterStatistics; + /** ================ Function Declarations ================ **/ /** ANCHOR[id=functions] **/ @@ -661,6 +703,8 @@ struct /** Parsing Functions. **/ // LINK #parsing +static void ci_GiveHint(const char* hint); +static bool ci_TryHint(char* value, char** valid_values, const unsigned int n_valid_values); static int ci_ParseAttribute(pStructInf inf, char* attr_name, int datatype, pObjData data, pParamObjects param_list, bool required, bool print_type_error); static ClusterAlgorithm ci_ParseClusteringAlgorithm(pStructInf cluster_inf, pParamObjects param_list); static SimilarityMeasure ci_ParseSimilarityMeasure(pStructInf cluster_inf, pParamObjects param_list); @@ -741,7 +785,8 @@ static void ci_GiveHint(const char* hint) fprintf(stderr, " > Hint: Did you mean \"%s\"?\n", hint); } -/*** Given the user a hint when they specify an invalid string for a field + +/*** Given the user a hint when they specify an invalid string for an attribute *** where we know the list of valid strings. The hint is only displayed if *** their string is close enough to a valid string. *** @@ -753,11 +798,12 @@ static void ci_GiveHint(const char* hint) ***/ static bool ci_TryHint(char* value, char** valid_values, const unsigned int n_valid_values) { - char* guess = ca_most_similar(value, (void**)valid_values, n_valid_values, ca_lev_compare, 0.5); + char* guess = ca_most_similar(value, (void**)valid_values, n_valid_values, ca_lev_compare, 0.25); if (guess == NULL) return false; /* No hint. */ /** Issue hint. **/ ci_GiveHint(guess); + tprintf(" > Similarity: %.4g\n", ca_lev_compare(value, guess)); return true; } @@ -845,7 +891,7 @@ static int ci_ParseAttribute( // LINK #functions -/*** Parses a ClusteringAlgorithm from the algorithm field in the pStructInf +/*** Parses a ClusteringAlgorithm from the algorithm attribute in the pStructInf *** representing some structure with that attribute in a parsed structure file. *** *** @attention - Promises that a failure invokes mssError() at least once. @@ -892,7 +938,7 @@ static ClusterAlgorithm ci_ParseClusteringAlgorithm(pStructInf inf, pParamObject // LINK #functions -/*** Parses a SimilarityMeasure from the similarity_measure field in the given +/*** Parses a SimilarityMeasure from the similarity_measure attribute in the given *** pStructInf parameter, which represents some structure with that attribute *** in a parsed structure file. *** @@ -951,78 +997,70 @@ static SimilarityMeasure ci_ParseSimilarityMeasure(pStructInf inf, pParamObjects ***/ static pSourceData ci_ParseSourceData(pStructInf inf, pParamObjects param_list, char* path) { - char* buf; + char* buf = NULL; + + /** Allocate SourceData. **/ + pSourceData source_data = check_ptr(nmMalloc(sizeof(SourceData))); + if (source_data == NULL) goto err_free; + memset(source_data, 0, sizeof(SourceData)); + + /** Initialize obvious values for SourceData. **/ + source_data->Name = check_ptr(nmSysStrdup(inf->Name)); + if (source_data->Name == NULL) goto err_free; + if (!check(objCurrentDate(&source_data->DateCreated))) goto err_free; /** Get source. **/ - if (ci_ParseAttribute(inf, "source", DATA_T_STRING, POD(&buf), param_list, true, true) != 0) goto err; - char* source_path = check_ptr(nmSysStrdup(buf)); - if (source_path == NULL) goto err; + if (ci_ParseAttribute(inf, "source", DATA_T_STRING, POD(&buf), param_list, true, true) != 0) goto err_free; + source_data->SourcePath = check_ptr(nmSysStrdup(buf)); + if (source_data->SourcePath == NULL) goto err_free; - /** Get attribute name. **/ - if (ci_ParseAttribute(inf, "attr_name", DATA_T_STRING, POD(&buf), param_list, true, true) != 0) goto err; - char* attr_name = check_ptr(nmSysStrdup(buf)); - if (attr_name == NULL) goto err_free_path; + /** Get the attribute name to use when querying keys from the source. **/ + if (ci_ParseAttribute(inf, "key_attr", DATA_T_STRING, POD(&buf), param_list, true, true) != 0) goto err_free; + source_data->KeyAttr = check_ptr(nmSysStrdup(buf)); + if (source_data->KeyAttr == NULL) goto err_free; + + /** Get the attribute name to use for querying data from the source. **/ + if (ci_ParseAttribute(inf, "data_attr", DATA_T_STRING, POD(&buf), param_list, true, true) != 0) goto err_free; + source_data->NameAttr = check_ptr(nmSysStrdup(buf)); + if (source_data->NameAttr == NULL) goto err_free; /** Create cache entry key. **/ - const size_t len = strlen(path) + strlen(source_path) + strlen(attr_name) + 3lu; - char* key = check_ptr(nmSysMalloc(len * sizeof(char))); - if (key == NULL) goto err_free_attr; - snprintf(key, len, "%s?%s:%s", path, source_path, attr_name); + const size_t len = strlen(path) + strlen(source_data->SourcePath) + strlen(source_data->KeyAttr) + strlen(source_data->NameAttr) + 5lu; + source_data->Key = check_ptr(nmSysMalloc(len * sizeof(char))); + if (source_data->Key == NULL) goto err_free; + snprintf(source_data->Key, len, "%s?%s->%s:%s", path, source_data->SourcePath, source_data->KeyAttr, source_data->NameAttr); /** Check for a cached version. **/ - pSourceData source_maybe = (pSourceData)xhLookup(&ClusterDriverCaches.SourceDataCache, key); + pSourceData source_maybe = (pSourceData)xhLookup(&ClusterDriverCaches.SourceDataCache, source_data->Key); if (source_maybe != NULL) { /** Cache hit. **/ - tprintf("# source: \"%s\"\n", key); + tprintf("# source: \"%s\"\n", source_data->Key); /** Cause an imediate invalid read if cache was incorrectly freed. **/ tprintf("--> Name: %s\n", source_maybe->Name); /** Free data we don't need. **/ - nmSysFree(source_path); - nmSysFree(attr_name); - nmSysFree(key); + nmSysFree(source_data->Key); + ci_FreeSourceData(source_data); /** Return the cached source data. **/ return source_maybe; } - /** Cache miss: Create a new source data object. **/ - pSourceData source_data = check_ptr(nmMalloc(sizeof(SourceData))); - if (source_data == NULL) goto err_free_key; - memset(source_data, 0, sizeof(SourceData)); - source_data->Key = key; - source_data->SourcePath = source_path; - source_data->AttrName = attr_name; - source_data->Name = check_ptr(nmSysStrdup(inf->Name)); - if (source_data->Name == NULL) goto err_free_source; - if (!check(objCurrentDate(&source_data->DateCreated))) goto err_free_source; - - /** Add the new object to the cache for next time. **/ - tprintf("+ source: \"%s\"\n", key); - if (!check(xhAdd(&ClusterDriverCaches.SourceDataCache, key, (void*)source_data))) - goto err_free_source; + /** Cache miss: Add the new object to the cache for next time. **/ + tprintf("+ source: \"%s\"\n", source_data->Key); + if (!check(xhAdd(&ClusterDriverCaches.SourceDataCache, source_data->Key, (void*)source_data))) + goto err_free; /** Success. **/ return source_data; /** Error handling. **/ - err_free_source: - ci_FreeSourceData(source_data); - nmSysFree(key); - goto err; - - err_free_key: - nmSysFree(key); - - err_free_attr: - nmSysFree(attr_name); - - err_free_path: - nmSysFree(source_path); + err_free: + if (source_data->Key != NULL) nmSysFree(source_data->Key); + if (source_data != NULL) ci_FreeSourceData(source_data); - err: mssErrorf(0, "Cluster", "Failed to parse source data from group \"%s\" in file: %s", inf->Name, path @@ -1241,10 +1279,7 @@ static pClusterData ci_ParseClusterData(pStructInf inf, pNodeData node_data) } } cluster_data->nSubClusters = sub_clusters.nItems; - cluster_data->SubClusters = (cluster_data->nSubClusters > 0u) ? - (pClusterData*)ci_xaToTrimmedArray(&sub_clusters) - : NULL; /* No sub-clusters. */ - check(xaDeInit(&sub_clusters)); /* Failure ignored. */ + cluster_data->SubClusters = (pClusterData*)ci_xaToTrimmedArray(&sub_clusters, 1); /** Create the cache key. **/ parsing_done:; @@ -1592,7 +1627,8 @@ static pNodeData ci_ParseNodeData(pStructInf inf, pObject parent) /** Valid attribute names. **/ char* attrs[] = { "source", - "attr_name", + "key_attr", + "data_attr", }; const unsigned int nattrs = sizeof(attrs) / sizeof(char*); @@ -1695,16 +1731,7 @@ static pNodeData ci_ParseNodeData(pStructInf inf, pObject parent) /** Check each provided param to see if the user provided value. **/ for (unsigned int j = 0u; j < num_provided_params; j++) { - pStruct provided_param = provided_params[j]; - if (provided_param == NULL) - { - mssErrorf(1, "Cluster", "Provided param struct cannot be NULL."); - fprintf(stderr, - "Debug info: obj->Pathname->OpenCtl[%d]->SubInf[%u] is NULL", - parent->SubPtr - 1, j - ); - goto err_free_arrs; - } + pStruct provided_param = check_ptr(provided_params[j]); /* Failure ignored. */ /** If this provided param value isn't for the param, ignore it. **/ if (strcmp(provided_param->Name, param->Name) != 0) continue; @@ -1724,7 +1751,7 @@ static pNodeData ci_ParseNodeData(pStructInf inf, pObject parent) ); goto err_free_arrs; } - tprintf("Found provided value for %s, which is now %d\n", param->Name, param->Value->Data.Integer); + tprintf("Found provided value for %s of type %s\n", param->Name, ci_TypeToStr(param->Type)); /** Provided value successfully handled, we're done. **/ break; @@ -1744,6 +1771,28 @@ static pNodeData ci_ParseNodeData(pStructInf inf, pObject parent) check(xaDeInit(¶m_infs)); /* Failure ignored. */ param_infs.nAlloc = 0; + /** Iterate over provided parameters and warn the user if they specified a parameter that does not exist. **/ + for (unsigned int i = 0u; i < num_provided_params; i++) + { + pStruct provided_param = check_ptr(provided_params[i]); /* Failure ignored. */ + char* provided_name = provided_param->Name; + + /** Look to see if this provided param actually exists for this driver instance. **/ + for (unsigned int j = 0u; j < node_data->nParams; j++) + if (strcmp(provided_name, node_data->Params[j]->Name) == 0) + goto next_provided_param; + + /** This param doesn't exist, warn the user and attempt to give them a hint. **/ + fprintf(stderr, "Warning: Unknown provided parameter '%s' for cluster file: %s.\n", provided_name, ci_file_name(parent)); + char** param_names = check_ptr(nmSysMalloc(node_data->nParams * sizeof(char*))); + for (unsigned int j = 0u; j < node_data->nParams; j++) + param_names[j] = node_data->Params[j]->Name; + ci_TryHint(provided_name, param_names, node_data->nParams); + nmSysFree(param_names); + + next_provided_param:; + } + /** Parse source data. **/ node_data->SourceData = ci_ParseSourceData(inf, node_data->ParamList, path); if (node_data->SourceData == NULL) goto err_free_arrs; @@ -1826,10 +1875,15 @@ static void ci_FreeSourceData(pSourceData source_data) nmSysFree(source_data->SourcePath); source_data->SourcePath = NULL; } - if (source_data->AttrName != NULL) + if (source_data->KeyAttr != NULL) + { + nmSysFree(source_data->KeyAttr); + source_data->KeyAttr = NULL; + } + if (source_data->NameAttr != NULL) { - nmSysFree(source_data->AttrName); - source_data->AttrName = NULL; + nmSysFree(source_data->NameAttr); + source_data->NameAttr = NULL; } /** Free fetched data, if it exists. **/ @@ -2060,7 +2114,8 @@ static unsigned int ci_SizeOfSourceData(pSourceData source_data) unsigned int size = 0u; if (source_data->Name != NULL) size += strlen(source_data->Name) * sizeof(char); if (source_data->SourcePath != NULL) size += strlen(source_data->SourcePath) * sizeof(char); - if (source_data->AttrName != NULL) size += strlen(source_data->AttrName) * sizeof(char); + if (source_data->KeyAttr != NULL) size += strlen(source_data->KeyAttr) * sizeof(char); + if (source_data->NameAttr != NULL) size += strlen(source_data->NameAttr) * sizeof(char); if (source_data->Strings != NULL) { for (unsigned int i = 0u; i < source_data->nVectors; i++) @@ -2175,9 +2230,9 @@ static int ci_ComputeSourceData(pSourceData source_data, pObjSession session) { mssErrorf(0, "Cluster", "Failed to open object driver:\n" - " > Attribute: ['%s' : String]\n" - " > Source Path: \"%s\"", - source_data->AttrName, + " > Attribute: ['%s':'%s' : String]\n" + " > Source Path: %s\n", + source_data->KeyAttr, source_data->NameAttr, source_data->SourcePath ); goto end; @@ -2190,85 +2245,86 @@ static int ci_ComputeSourceData(pSourceData source_data, pObjSession session) { mssErrorf(0, "Cluster", "Failed to open query:\n" - " > Attribute: ['%s' : String]\n" - " > Driver Used: %s\n" - " > Source Path: \"%s\"", - source_data->AttrName, - obj->Driver->Name, - source_data->SourcePath + " > Attribute: ['%s':'%s' : String]\n" + " > Source Path: %s\n" + " > Driver Used: %s\n", + source_data->KeyAttr, source_data->NameAttr, + source_data->SourcePath, + obj->Driver->Name ); goto end_close; } /** Initialize an xarray to store the retrieved data. **/ - XArray data_xarray, vector_xarray; + XArray key_xarray, data_xarray, vector_xarray; + memset(&key_xarray, 0, sizeof(XArray)); memset(&data_xarray, 0, sizeof(XArray)); memset(&vector_xarray, 0, sizeof(XArray)); - if (!check(xaInit(&data_xarray, 64))) goto end_close_query; + if (!check(xaInit(&key_xarray, 64))) goto end_close_query; + if (!check(xaInit(&data_xarray, 64))) goto end_free_data; if (!check(xaInit(&vector_xarray, 64))) goto end_free_data; /** Fetch data and build vectors. **/ tprintf("Skips: "); - unsigned int i = 0u; while (true) { pObject entry = objQueryFetch(query, O_RDONLY); if (entry == NULL) break; /* Done. */ - /** Type checking. **/ - const int datatype = objGetAttrType(entry, source_data->AttrName); - if (datatype == -1) + /** Data value: Type checking. **/ + const int data_datatype = objGetAttrType(entry, source_data->NameAttr); + if (data_datatype == -1) { mssErrorf(0, "Cluster", "Failed to get type for %uth entry:\n" - " > Attribute: '%s' : String\n" - " > Driver Used: %s\n" - " > Source Path: \"%s\"", - i, - source_data->AttrName, - obj->Driver->Name, - source_data->SourcePath + " > Attribute: ['%s':'%s' : String]\n" + " > Source Path: %s\n" + " > Driver Used: %s\n", + vector_xarray.nItems, + source_data->KeyAttr, source_data->NameAttr, + source_data->SourcePath, + obj->Driver->Name ); goto end_free_data; } - if (datatype != DATA_T_STRING) + if (data_datatype != DATA_T_STRING) { mssErrorf(1, "Cluster", "Type for %uth entry was not a string:\n" - " > Attribute: ['%s' : %s]\n" - " > Driver Used: %s\n" - " > Source Path: \"%s\"", - i, - source_data->AttrName, ci_TypeToStr(datatype), - obj->Driver->Name, - source_data->SourcePath + " > Attribute: ['%s':'%s' : %s]\n" + " > Source Path: %s\n" + " > Driver Used: %s\n", + vector_xarray.nItems, + source_data->KeyAttr, source_data->NameAttr, ci_TypeToStr(data_datatype), + source_data->SourcePath, + obj->Driver->Name ); goto end_free_data; } - /** Get value from database. **/ - char* val; - ret = objGetAttrValue(entry, source_data->AttrName, DATA_T_STRING, POD(&val)); + /** Data value: Get value from database. **/ + char* data; + ret = objGetAttrValue(entry, source_data->NameAttr, DATA_T_STRING, POD(&data)); if (ret != 0) { tprintf("\n"); mssErrorf(0, "Cluster", "Failed to value for %uth entry:\n" - " > Attribute: ['%s' : String]\n" + " > Attribute: ['%s':'%s' : String]\n" + " > Source Path: %s\n" " > Driver Used: %s\n" - " > Source Path: \"%s\"\n" - " > Error code: %d", - i, - source_data->AttrName, - obj->Driver->Name, + " > Error code: %d\n", + vector_xarray.nItems, + source_data->KeyAttr, source_data->NameAttr, source_data->SourcePath, + obj->Driver->Name, ret ); goto end_free_data; } /** Skip empty strings. **/ - if (strlen(val) == 0) + if (strlen(data) == 0) { tprintf("_"); check(fflush(stdout)); /* Failure ignored. */ @@ -2276,16 +2332,16 @@ static int ci_ComputeSourceData(pSourceData source_data, pObjSession session) } /** Convert the string to a vector. **/ - pVector vector = ca_build_vector(val); + pVector vector = ca_build_vector(data); if (vector == NULL) { - mssErrorf(1, "Cluster", "Failed to build vectors for string \"%s\".", val); + mssErrorf(1, "Cluster", "Failed to build vectors for string \"%s\".", data); successful = false; goto end_free_data; } if (ca_is_empty(vector)) { - mssErrorf(1, "Cluster", "Vector building for string \"%s\" produced no character pairs.", val); + mssErrorf(1, "Cluster", "Vector building for string \"%s\" produced no character pairs.", data); successful = false; goto end_free_data; } @@ -2298,10 +2354,66 @@ static int ci_ComputeSourceData(pSourceData source_data, pObjSession session) continue; } - /** Store value. **/ - char* dup_val = check_ptr(nmSysStrdup(val)); - if (dup_val == NULL) goto end_free_data; - if (!check_neg(xaAddItem(&data_xarray, (void*)dup_val))) goto end_free_data; + + /** Key value: Type checking. **/ + const int key_datatype = objGetAttrType(entry, source_data->KeyAttr); + if (key_datatype == -1) + { + mssErrorf(0, "Cluster", + "Failed to get type for key on %uth entry:\n" + " > Attribute: ['%s':'%s' : String]\n" + " > Source Path: %s\n" + " > Driver Used: %s\n", + vector_xarray.nItems, + source_data->KeyAttr, source_data->NameAttr, + source_data->SourcePath, + obj->Driver->Name + ); + goto end_free_data; + } + if (key_datatype != DATA_T_STRING) + { + mssErrorf(1, "Cluster", + "Type for key on %uth entry was not a string:\n" + " > Attribute: ['%s':'%s' : %s]\n" + " > Source Path: %s\n" + " > Driver Used: %s\n", + vector_xarray.nItems, + source_data->KeyAttr, source_data->NameAttr, ci_TypeToStr(key_datatype), + source_data->SourcePath, + obj->Driver->Name + ); + goto end_free_data; + } + + /** key value: Get value from database. **/ + char* key; + ret = objGetAttrValue(entry, source_data->KeyAttr, DATA_T_STRING, POD(&key)); + if (ret != 0) + { + tprintf("\n"); + mssErrorf(0, "Cluster", + "Failed to value for key on %uth entry:\n" + " > Attribute: ['%s':'%s' : String]\n" + " > Source Path: %s\n" + " > Driver Used: %s\n" + " > Error code: %d\n", + vector_xarray.nItems, + source_data->KeyAttr, source_data->NameAttr, + source_data->SourcePath, + obj->Driver->Name, + ret + ); + goto end_free_data; + } + + /** Store values. **/ + char* key_dup = check_ptr(nmSysStrdup(key)); + if (key_dup == NULL) goto end_free_data; + char* data_dup = check_ptr(nmSysStrdup(data)); + if (data_dup == NULL) goto end_free_data; + if (!check_neg(xaAddItem(&key_xarray, (void*)key_dup))) goto end_free_data; + if (!check_neg(xaAddItem(&data_xarray, (void*)data_dup))) goto end_free_data; if (!check_neg(xaAddItem(&vector_xarray, (void*)vector))) goto end_free_data; /** Clean up. **/ @@ -2314,26 +2426,39 @@ static int ci_ComputeSourceData(pSourceData source_data, pObjSession session) } tprintf("\nData aquired.\n"); source_data->nVectors = vector_xarray.nItems; + if (source_data->nVectors == 0) + { + mssErrorf(0, "Cluster", + "Data source path did not contain any valid data:\n" + " > Attribute: ['%s':'%s' : String]\n" + " > Source Path: %s\n" + " > Driver Used: %s\n", + vector_xarray.nItems, + source_data->KeyAttr, source_data->NameAttr, + source_data->SourcePath, + obj->Driver->Name + ); + } - /** Trim data and store data. **/ - const size_t data_size = source_data->nVectors * sizeof(char*); - source_data->Strings = check_ptr(nmSysMalloc(data_size)); + /** Trim and store: keys, data, and vectors. **/ + source_data->Keys = (char**)check_ptr(ci_xaToTrimmedArray(&key_xarray, 1)); + source_data->Strings = (char**)check_ptr(ci_xaToTrimmedArray(&data_xarray, 1)); + source_data->Vectors = (int**)check_ptr(ci_xaToTrimmedArray(&vector_xarray, 1)); + if (source_data->Keys == NULL) goto end_free_data; if (source_data->Strings == NULL) goto end_free_data; - memcpy(source_data->Strings, data_xarray.Items, data_size); - check(xaDeInit(&data_xarray)); /* Failure ignored. */ - data_xarray.nAlloc = 0; - - /** Trim data and store vectors. **/ - const size_t vectors_size = source_data->nVectors * sizeof(pVector); - source_data->Vectors = check_ptr(nmSysMalloc(vectors_size)); - memcpy(source_data->Vectors, vector_xarray.Items, vectors_size); - check(xaDeInit(&vector_xarray)); /* Failure ignored. */ - vector_xarray.nAlloc = 0; + if (source_data->Vectors == NULL) goto end_free_data; /** Success. **/ + fprintf(stderr, "[SourceData: %s] Compute done.\n", source_data->Name); successful = true; end_free_data: + if (key_xarray.nAlloc != 0) + { + for (unsigned int i = 0u; i < vector_xarray.nItems; i++) + nmSysFree(key_xarray.Items[i]); + check(xaDeInit(&key_xarray)); /* Failure ignored. */ + } if (data_xarray.nAlloc != 0) { for (unsigned int i = 0u; i < data_xarray.nItems; i++) @@ -2464,7 +2589,7 @@ static int ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data) cluster_data->Sims )); timer_stop(timer); - tprintf("Clustering done after %.4lf.\n", timer_get(timer)); + tprintf("Clustering done after %.4lfs.\n", timer_get(timer)); if (!successful) goto err_free_sims; /** Convert the labels into clusters. **/ @@ -2511,7 +2636,7 @@ static int ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data) } /** Success. **/ - tprintf("Clustering done.\n"); + fprintf(stderr, "[ClusterData: %s] Compute done.\n", cluster_data->Name); return 0; err_free_sims: @@ -2564,16 +2689,6 @@ static int ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) goto err; } - /** Check for unimplemented similarity measures. **/ - if (search_data->SimilarityMeasure != SIMILARITY_COSINE) - { - mssErrorf(1, "Cluster", - "The similarity meausre \"%s\" is not implemented.", - ci_SimilarityMeasureToString(search_data->SimilarityMeasure) - ); - goto err; - } - /** Record the date and time. **/ if (!check(objCurrentDate(&search_data->DateComputed))) goto err; @@ -2593,6 +2708,7 @@ static int ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) cluster_data->MaxIterations, /* Window size. */ ca_cos_compare, search_data->Threshold, + (void**)cluster_data->SourceData->Keys, dups )); } @@ -2605,6 +2721,7 @@ static int ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) cluster_data->Clusters[i].Size, ca_cos_compare, search_data->Threshold, + (void**)cluster_data->SourceData->Keys, dups )); if (dups_temp == NULL) goto err_free; @@ -2624,6 +2741,7 @@ static int ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) cluster_data->MaxIterations, /* Window size. */ ca_lev_compare, search_data->Threshold, + (void**)cluster_data->SourceData->Keys, dups )); } @@ -2636,6 +2754,7 @@ static int ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) cluster_data->Clusters[i].Size, ca_lev_compare, search_data->Threshold, + (void**)cluster_data->SourceData->Keys, dups )); if (dups_temp == NULL) goto err_free; @@ -2655,19 +2774,16 @@ static int ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) timer_stop(timer); if (dups_temp == NULL) goto err_free; else dups = dups_temp; - tprintf("Search done after %.4lf.\n", timer_get(timer)); + tprintf("Search done after %.4lfs.\n", timer_get(timer)); /** Store dups. **/ search_data->nDups = dups->nItems; search_data->Dups = (dups->nItems == 0) ? check_ptr(nmSysMalloc(0)) - : ci_xaToTrimmedArray(dups); - - /** Free unused data. **/ - tprintf("Cleanup.\n"); - check(xaFree(dups)); /* Failure ignored. */ + : ci_xaToTrimmedArray(dups, 2); /** Success. **/ + fprintf(stderr, "[SearchData: %s] Compute done.\n", search_data->Name); return 0; err_free: @@ -2808,6 +2924,7 @@ static int ci_SetParamValue(void* inf_v, char* attr_name, int datatype, pObjData void* clusterOpen(pObject parent, int mask, pContentType sys_type, char* usr_type, pObjTrxTree* oxt) { tprintf("Warning: clusterOpen(\"%s\") is under active development.\n", ci_file_name(parent)); + ClusterStatistics.OpenCalls++; /** If CREAT and EXCL are specified, exclusively create it, failing if the file already exists. **/ pSnNode node_struct = NULL; @@ -2973,6 +3090,7 @@ int clusterClose(void* inf_v, pObjTrxTree* oxt) { tprintf("Warning: clusterClose() is under active development.\n"); pDriverData driver_data = (pDriverData)inf_v; + ClusterStatistics.CloseCalls++; /** Entries are shallow copies so we shouldn't do a deep free. **/ if (driver_data->TargetType == TARGET_CLUSTER_ENTRY @@ -3005,6 +3123,7 @@ int clusterClose(void* inf_v, pObjTrxTree* oxt) ***/ void* clusterOpenQuery(void* inf_v, pObjQuery query, pObjTrxTree* oxt) { + ClusterStatistics.OpenQueryCalls++; tprintf("Warning: clusterOpenQuery() is under active development.\n"); pClusterQuery cluster_query = check_ptr(nmMalloc(sizeof(ClusterQuery))); if (cluster_query == NULL) return NULL; @@ -3029,7 +3148,8 @@ void* clusterOpenQuery(void* inf_v, pObjQuery query, pObjTrxTree* oxt) void* clusterQueryFetch(void* qy_v, pObject obj, int mode, pObjTrxTree* oxt) { int ret; - tprintf("Warning: clusterQueryFetch() is under active development.\n"); + ClusterStatistics.FetchCalls++; +// tprintf("Warning: clusterQueryFetch() is under active development.\n"); pClusterQuery cluster_query = (pClusterQuery)qy_v; /** Ensure that the data being fetched exists and is computed. **/ @@ -3114,7 +3234,7 @@ void* clusterQueryFetch(void* qy_v, pObject obj, int mode, pObjTrxTree* oxt) ***/ int clusterQueryClose(void* qy_v, pObjTrxTree* oxt) { - tprintf("Warning: clusterQueryClose() is under active development.\n"); +// tprintf("Warning: clusterQueryClose() is under active development.\n"); nmFree(qy_v, sizeof(ClusterQuery)); return 0; @@ -3134,6 +3254,7 @@ int clusterQueryClose(void* qy_v, pObjTrxTree* oxt) int clusterGetAttrType(void* inf_v, char* attr_name, pObjTrxTree* oxt) { pDriverData driver_data = (pDriverData)inf_v; + ClusterStatistics.GetTypeCalls++; /** Guard possible segfault. **/ if (attr_name == NULL) @@ -3142,8 +3263,8 @@ int clusterGetAttrType(void* inf_v, char* attr_name, pObjTrxTree* oxt) return DATA_T_UNAVAILABLE; } - /** Performance shortcut for frequently requested attributes: val, val1, val2, and sim. **/ - if (attr_name[0] == 'v' || attr_name[0] == 's') goto handle_targets; + /** Performance shortcut for frequently requested attributes: key1, key2, and sim. **/ + if (attr_name[0] == 'k' || attr_name[0] == 's') goto handle_targets; /** Debug info. **/ if (oxt == NULL) tprintf(" > "); @@ -3171,7 +3292,8 @@ int clusterGetAttrType(void* inf_v, char* attr_name, pObjTrxTree* oxt) { case TARGET_ROOT: if (strcmp(attr_name, "source") == 0 - || strcmp(attr_name, "attr_name") == 0) + || strcmp(attr_name, "data_attr") == 0 + || strcmp(attr_name, "key_attr") == 0) return DATA_T_STRING; break; @@ -3200,11 +3322,8 @@ int clusterGetAttrType(void* inf_v, char* attr_name, pObjTrxTree* oxt) break; case TARGET_SEARCH_ENTRY: - if (strcmp(attr_name, "id1") == 0 - || strcmp(attr_name, "id2") == 0) - return DATA_T_INTEGER; - if (strcmp(attr_name, "val1") == 0 - || strcmp(attr_name, "val2") == 0) + if (strcmp(attr_name, "key1") == 0 + || strcmp(attr_name, "key2") == 0) return DATA_T_STRING; if (strcmp(attr_name, "sim") == 0) return DATA_T_DOUBLE; @@ -3241,6 +3360,7 @@ int clusterGetAttrType(void* inf_v, char* attr_name, pObjTrxTree* oxt) int clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val, pObjTrxTree* oxt) { pDriverData driver_data = (pDriverData)inf_v; + ClusterStatistics.GetValCalls++; /** Guard possible segfault. **/ if (attr_name == NULL) @@ -3249,9 +3369,8 @@ int clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val return DATA_T_UNAVAILABLE; } - /** Performance shortcut for frequently requested attributes: val1, val2, and sim. **/ - if ( - (attr_name[0] == 'v' && datatype == DATA_T_STRING) /* val1, val2 : String */ + /** Performance shortcut for frequently requested attributes: key1, key2, and sim. **/ + if ((attr_name[0] == 'k' && datatype == DATA_T_STRING) /* key1, key2 : string */ || (attr_name[0] == 's' && datatype == DATA_T_DOUBLE) /* sim : double */ ) goto handle_targets; @@ -3272,6 +3391,7 @@ int clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val /** Handle name and annotation. **/ if (strcmp(attr_name, "name") == 0) { + ClusterStatistics.GetValCalls_name++; switch (driver_data->TargetType) { case TARGET_ROOT: @@ -3336,7 +3456,7 @@ int clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val case TARGET_ROOT: case TARGET_CLUSTER_ENTRY: case TARGET_SEARCH_ENTRY: - /** Field is not defined for this target type. **/ + /** Attribute is not defined for this target type. **/ return -1; case TARGET_CLUSTER: @@ -3356,7 +3476,7 @@ int clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val case TARGET_ROOT: case TARGET_CLUSTER_ENTRY: case TARGET_SEARCH_ENTRY: - /** Field is not defined for this target type. **/ + /** Attribute is not defined for this target type. **/ return -1; case TARGET_CLUSTER: @@ -3393,9 +3513,14 @@ int clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val val->String = ((pSourceData)driver_data->TargetData)->SourcePath; return 0; } - if (strcmp(attr_name, "attr_name") == 0) + if (strcmp(attr_name, "key_attr") == 0) + { + val->String = ((pSourceData)driver_data->TargetData)->KeyAttr; + return 0; + } + if (strcmp(attr_name, "name_attr") == 0) { - val->String = ((pSourceData)driver_data->TargetData)->AttrName; + val->String = ((pSourceData)driver_data->TargetData)->NameAttr; return 0; } break; @@ -3460,6 +3585,7 @@ int clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val case TARGET_CLUSTER_ENTRY: { pClusterData target = (pClusterData)driver_data->TargetData; + pCluster target_cluster = &target->Clusters[driver_data->TargetIndex]; if (strcmp(attr_name, "items") == 0) { @@ -3468,7 +3594,6 @@ int clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val if (vec != NULL) nmFree(vec, sizeof(StringVec)); /** Allocate and initiallize the requested data. **/ - pCluster target_cluster = &target->Clusters[driver_data->TargetIndex]; val->StringVec = vec = check_ptr(nmMalloc(sizeof(StringVec))); if (val->StringVec == NULL) return -1; val->StringVec->nStrings = target_cluster->Size; @@ -3485,37 +3610,22 @@ int clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val pSearchData target = (pSearchData)driver_data->TargetData; pDup target_dup = target->Dups[driver_data->TargetIndex]; - if (strcmp(attr_name, "id1") == 0) - { - unsigned int value = target_dup->id1; - if (value > INT_MAX) - fprintf(stderr, "Warning: id1 value of %u exceeds INT_MAX (%d).\n", value, INT_MAX); - val->Integer = (int)value; - return 0; - } - if (strcmp(attr_name, "id2") == 0) - { - unsigned int value = target_dup->id2; - if (value > INT_MAX) - fprintf(stderr, "Warning: id2 value of %u exceeds INT_MAX (%d).\n", value, INT_MAX); - val->Integer = (int)value; - return 0; - } - if (strcmp(attr_name, "val1") == 0) + if (strcmp(attr_name, "sim") == 0) { - val->String = driver_data->NodeData->SourceData->Strings[target_dup->id1]; - // val->Integer = (int)target_dup->id1; + ClusterStatistics.GetValCalls_sim++; + val->Double = target_dup->similarity; return 0; } - if (strcmp(attr_name, "val2") == 0) + if (strcmp(attr_name, "key1") == 0) { - val->String = driver_data->NodeData->SourceData->Strings[target_dup->id2]; - // val->Integer = (int)target_dup->id2; + ClusterStatistics.GetValCalls_key1++; + val->String = target_dup->key1; return 0; } - if (strcmp(attr_name, "sim") == 0) + if (strcmp(attr_name, "key2") == 0) { - val->Double = target_dup->similarity; + ClusterStatistics.GetValCalls_key2++; + val->String = target_dup->key2; return 0; } break; @@ -3542,10 +3652,10 @@ int clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val /*** Create a new presentation hints object, describing this attribute on the *** provided cluster driver instance. *** - *** Note: expCompileExpression() and nmSysStrdup() are run unchecked because - *** the worst case senario is that the fields are set to null and ignored, - *** which I consider to be better than ending the script because one of - *** them failed. + *** Note: Failures from nmSysStrdup() and several others are ignored because + *** the worst case senario is that the attributes are set to null, which + *** will cause them to be ignored. I consider that to be better than than + *** throwing an error that could unnecessarily disrupt normal usage. *** *** @param inf_v The driver instance to be read. *** @param attr_name The name of the requested attribute. @@ -3563,7 +3673,7 @@ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pOb if (hints == NULL) goto err; memset(hints, 0, sizeof(ObjPresentationHints)); - /** Hints that are the same for all fields **/ + /** Hints that are the same for all attributes. **/ hints->GroupID = -1; hints->VisualLength2 = 1; hints->Style |= OBJ_PH_STYLE_READONLY | OBJ_PH_STYLE_CREATEONLY | OBJ_PH_STYLE_NOTNULL; @@ -3604,7 +3714,7 @@ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pOb { hints->Length = 24; hints->VisualLength = 20; - hints->Format = nmSysStrdup("datetime"); + hints->Format = check_ptr(nmSysStrdup("datetime")); /* Failure ignored. */ goto success; } else goto unknown_attribute; @@ -3618,14 +3728,21 @@ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pOb { hints->Length = _PC_PATH_MAX; hints->VisualLength = 64; - hints->FriendlyName = "Source Path"; + hints->FriendlyName = check_ptr(nmSysStrdup("Source Path")); /* Failure ignored. */ goto success; } - if (strcmp(attr_name, "attr_name") == 0) + if (strcmp(attr_name, "key_attr") == 0) { hints->Length = 255; hints->VisualLength = 32; - hints->FriendlyName = "Attribute Name"; + hints->FriendlyName = check_ptr(nmSysStrdup("Key Attribute Name")); /* Failure ignored. */ + goto success; + } + if (strcmp(attr_name, "data_attr") == 0) + { + hints->Length = 255; + hints->VisualLength = 32; + hints->FriendlyName = check_ptr(nmSysStrdup("Data Attribute Name")); /* Failure ignored. */ goto success; } break; @@ -3640,7 +3757,7 @@ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pOb /** Other hints. **/ hints->Length = 8; hints->VisualLength = 4; - hints->FriendlyName = nmSysStrdup("Number of Clusters"); + hints->FriendlyName = check_ptr(nmSysStrdup("Number of Clusters")); /* Failure ignored. */ goto success; } if (strcmp(attr_name, "min_improvement") == 0) @@ -3653,7 +3770,7 @@ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pOb /** Other hints. **/ hints->Length = 16; hints->VisualLength = 8; - hints->FriendlyName = nmSysStrdup("Minimum Improvement Threshold"); + hints->FriendlyName = check_ptr(nmSysStrdup("Minimum Improvement Threshold")); /* Failure ignored. */ goto success; } if (strcmp(attr_name, "max_iterations") == 0) @@ -3666,15 +3783,15 @@ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pOb /** Other hints. **/ hints->Length = 8; hints->VisualLength = 4; - hints->FriendlyName = nmSysStrdup("Maximum Number of Clustering Iterations"); + hints->FriendlyName = check_ptr(nmSysStrdup("Maximum Iterations")); /* Failure ignored. */ goto success; } if (strcmp(attr_name, "algorithm") == 0) { /** Enum values. **/ - check(xaInit(&(hints->EnumList), nClusteringAlgorithms)); + check(xaInit(&(hints->EnumList), nClusteringAlgorithms)); /* Failure ignored. */ for (unsigned int i = 0u; i < nClusteringAlgorithms; i++) - check_neg(xaAddItem(&(hints->EnumList), &ALL_CLUSTERING_ALGORITHMS[i])); + check_neg(xaAddItem(&(hints->EnumList), &ALL_CLUSTERING_ALGORITHMS[i])); /* Failure ignored. */ /** Min and max values. **/ hints->MinValue = expCompileExpression("0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); @@ -3689,7 +3806,7 @@ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pOb /** Other hints. **/ hints->Length = 24; hints->VisualLength = 20; - hints->FriendlyName = nmSysStrdup("Clustering Algorithm"); + hints->FriendlyName = check_ptr(nmSysStrdup("Clustering Algorithm")); /* Failure ignored. */ goto success; } /** Fall-through: Start of overlapping region. **/ @@ -3698,9 +3815,9 @@ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pOb if (strcmp(attr_name, "similarity_measure") == 0) { /** Enum values. **/ - check(xaInit(&(hints->EnumList), nSimilarityMeasures)); + check(xaInit(&(hints->EnumList), nSimilarityMeasures)); /* Failure ignored. */ for (unsigned int i = 0u; i < nSimilarityMeasures; i++) - check_neg(xaAddItem(&(hints->EnumList), &ALL_SIMILARITY_MEASURES[i])); + check_neg(xaAddItem(&(hints->EnumList), &ALL_SIMILARITY_MEASURES[i])); /* Failure ignored. */ /** Display flags. **/ hints->Style |= OBJ_PH_STYLE_BUTTONS; @@ -3715,7 +3832,7 @@ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pOb /** Other hints. **/ hints->Length = 32; hints->VisualLength = 20; - hints->FriendlyName = nmSysStrdup("Similarity Measure"); + hints->FriendlyName = check_ptr(nmSysStrdup("Similarity Measure")); /* Failure ignored. */ goto success; } @@ -3726,7 +3843,7 @@ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pOb { hints->Length = 64; hints->VisualLength = 32; - hints->FriendlyName = nmSysStrdup("Source Cluster Name"); + hints->FriendlyName = check_ptr(nmSysStrdup("Source Cluster Name")); /* Failure ignored. */ goto success; } if (strcmp(attr_name, "threshold") == 0) @@ -3738,39 +3855,22 @@ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pOb /** Other hints. **/ hints->Length = 16; hints->VisualLength = 8; - hints->FriendlyName = nmSysStrdup("Similarity Threshold"); + hints->FriendlyName = check_ptr(nmSysStrdup("Similarity Threshold")); /* Failure ignored. */ goto success; } break; case TARGET_CLUSTER_ENTRY: { - pClusterData target = (pClusterData)driver_data->TargetData; + pClusterData target = (pClusterData)check_ptr(driver_data->TargetData); + if (target == NULL) goto err; - if (strcmp(attr_name, "id") == 0) - { - pSourceData source_data = (pSourceData)target->SourceData; - - /** Min and max values. **/ - hints->MinValue = expCompileExpression("0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); - if (source_data->Vectors != NULL) - { - char buf[16u]; - snprintf(buf, sizeof(buf), "%u", source_data->nVectors); - hints->MaxValue = expCompileExpression(buf, tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); - } - - /** Other hints. **/ - hints->Length = 8; - hints->VisualLength = 4; - goto success; - } - if (strcmp(attr_name, "val") == 0) + if (strcmp(attr_name, "items") == 0) { /** Other hints. **/ - hints->Length = 255; - hints->VisualLength = 32; - hints->FriendlyName = nmSysStrdup("Value"); + hints->Length = 65536; + hints->VisualLength = 256; + hints->FriendlyName = check_ptr(nmSysStrdup("Cluster Data")); /* Failure ignored. */ goto success; } if (strcmp(attr_name, "sim") == 0) @@ -3782,7 +3882,7 @@ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pOb /** Other hints. **/ hints->Length = 16; hints->VisualLength = 8; - hints->FriendlyName = nmSysStrdup("Similarity"); + hints->FriendlyName = check_ptr(nmSysStrdup("Similarity")); /* Failure ignored. */ goto success; } break; @@ -3790,32 +3890,21 @@ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pOb case TARGET_SEARCH_ENTRY: { - pSearchData target = (pSearchData)driver_data->TargetData; + pSearchData target = (pSearchData)check_ptr(driver_data->TargetData); + if (target == NULL) goto err; - if (strcmp(attr_name, "id1") == 0 || strcmp(attr_name, "id2") == 0) + if (strcmp(attr_name, "key1") == 0) { - pSourceData source_data = (pSourceData)target->Source->SourceData; - - /** Min and max values. **/ - hints->MinValue = expCompileExpression("0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); - if (source_data->Vectors != NULL) - { - char buf[16u]; - snprintf(buf, sizeof(buf), "%u", source_data->nVectors); - hints->MaxValue = expCompileExpression(buf, tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); - } - - /** Other hints. **/ - hints->Length = 8; - hints->VisualLength = 4; + hints->Length = 255; + hints->VisualLength = 32; + hints->FriendlyName = check_ptr(nmSysStrdup("Key 1")); /* Failure ignored. */ goto success; } - if (strcmp(attr_name, "val1") == 0 || strcmp(attr_name, "val2") == 0) + if (strcmp(attr_name, "key2") == 0) { - /** Other hints. **/ hints->Length = 255; hints->VisualLength = 32; - hints->FriendlyName = nmSysStrdup("Value"); + hints->FriendlyName = check_ptr(nmSysStrdup("Key 2")); /* Failure ignored. */ goto success; } if (strcmp(attr_name, "sim") == 0) @@ -3827,7 +3916,7 @@ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pOb /** Other hints. **/ hints->Length = 16; hints->VisualLength = 8; - hints->FriendlyName = nmSysStrdup("Similarity"); + hints->FriendlyName = check_ptr(nmSysStrdup("Similarity")); /* Failure ignored. */ goto success; } break; @@ -3841,7 +3930,7 @@ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pOb /** Unknown attribute. **/ unknown_attribute:; char* name; - clusterGetAttrValue(inf_v, "name", DATA_T_STRING, POD(&name), NULL); + check(clusterGetAttrValue(inf_v, "name", DATA_T_STRING, POD(&name), NULL)); /* Failure ignored. */ mssErrorf(1, "Cluster", "Unknown attribute '%s' for cluster object %s (target type: %u, \"%s\").", attr_name, driver_data->NodeData->SourceData->Name, driver_data->TargetType, name @@ -4174,7 +4263,7 @@ int clusterExecuteMethod(void* inf_v, char* method_name, pObjData param, pObjTrx mssErrorf(1, "Cluster", "[param : \"show\" | \"show_all\" | \"drop_all\"] is required for the cache method." ); - goto err; + goto err; } /** show and show_all. **/ @@ -4256,6 +4345,34 @@ int clusterExecuteMethod(void* inf_v, char* method_name, pObjData param, pObjTrx ); goto err; } + + if (strcmp(method_name, "stat") == 0) + { + unsigned long long ExpectedOpenCalls = 10666; + unsigned long long ExpectedOpenQueryCalls = 10665; + unsigned long long ExpectedFetchCalls = 3368007; + unsigned long long ExpectedCloseCalls = 3368007; + unsigned long long ExpectedGetTypeCalls = 26664164; + unsigned long long ExpectedGetValCalls = 15021419; + unsigned long long ExpectedGetValCalls_name = 3368008; + unsigned long long ExpectedGetValCalls_key1 = 3357342; + unsigned long long ExpectedGetValCalls_key2 = 1574; + unsigned long long ExpectedGetValCalls_sim = 8283829; + char buf[12]; + printf("Cluster Driver Statistics:\n"); + printf(" Stat Name Value\n"); + printf(" OpenCalls %10s / %10s (%.4g%%)\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.OpenCalls), snprint_llu(buf, sizeof(buf), ExpectedOpenCalls), ClusterStatistics.OpenCalls / ExpectedOpenCalls * 100.0); + printf(" OpenQueryCalls %10s / %10s (%.4g%%)\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.OpenQueryCalls), snprint_llu(buf, sizeof(buf), ExpectedOpenQueryCalls), ClusterStatistics.OpenQueryCalls / ExpectedOpenQueryCalls * 100.0); + printf(" FetchCalls %10s / %10s (%.4g%%)\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.FetchCalls), snprint_llu(buf, sizeof(buf), ExpectedFetchCalls), ClusterStatistics.FetchCalls / ExpectedFetchCalls * 100.0); + printf(" CloseCalls %10s / %10s (%.4g%%)\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.CloseCalls), snprint_llu(buf, sizeof(buf), ExpectedCloseCalls), ClusterStatistics.CloseCalls / ExpectedCloseCalls * 100.0); + printf(" GetTypeCalls %10s / %10s (%.4g%%)\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.GetTypeCalls), snprint_llu(buf, sizeof(buf), ExpectedGetTypeCalls), ClusterStatistics.GetTypeCalls / ExpectedGetTypeCalls * 100.0); + printf(" GetValCalls %10s / %10s (%.4g%%)\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.GetValCalls), snprint_llu(buf, sizeof(buf), ExpectedGetValCalls), ClusterStatistics.GetValCalls / ExpectedGetValCalls * 100.0); + printf(" GetValCalls_name %10s / %10s (%.4g%%)\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.GetValCalls_name), snprint_llu(buf, sizeof(buf), ExpectedGetValCalls_name), ClusterStatistics.GetValCalls_name / ExpectedGetValCalls_name * 100.0); + printf(" GetValCalls_key1 %10s / %10s (%.4g%%)\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.GetValCalls_key1), snprint_llu(buf, sizeof(buf), ExpectedGetValCalls_key1), ClusterStatistics.GetValCalls_key1 / ExpectedGetValCalls_key1 * 100.0); + printf(" GetValCalls_key2 %10s / %10s (%.4g%%)\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.GetValCalls_key2), snprint_llu(buf, sizeof(buf), ExpectedGetValCalls_key2), ClusterStatistics.GetValCalls_key2 / ExpectedGetValCalls_key2 * 100.0); + printf(" GetValCalls_sim %10s / %10s (%.4g%%)\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.GetValCalls_sim), snprint_llu(buf, sizeof(buf), ExpectedGetValCalls_sim), ClusterStatistics.GetValCalls_sim / ExpectedGetValCalls_sim * 100.0); + return 0; + } /** Unknown parameter. **/ mssErrorf(1, "Cluster", "Unknown command: \"%s\"", method_name); @@ -4343,17 +4460,20 @@ int clusterInitialize(void) if (drv == NULL) goto err; memset(drv, 0, sizeof(ObjDriver)); - /** Initialize globals. **/ + /** Initialize caches. **/ memset(&ClusterDriverCaches, 0, sizeof(ClusterDriverCaches)); if (!check(xhInit(&ClusterDriverCaches.SourceDataCache, 251, 0))) goto err; if (!check(xhInit(&ClusterDriverCaches.ClusterDataCache, 251, 0))) goto err; if (!check(xhInit(&ClusterDriverCaches.SearchDataCache, 251, 0))) goto err; + /** Initialize statistics. **/ + memset(&ClusterStatistics, 0, sizeof(ClusterStatistics)); + /** Setup the structure. **/ if (check_ptr(strcpy(drv->Name, "clu - Clustering Driver")) == NULL) goto err; - if (!check(xaInit(&(drv->RootContentTypes), 1))) goto err; - if (!check_neg(xaAddItem(&(drv->RootContentTypes), "system/cluster"))) goto err; - drv->Capabilities = OBJDRV_C_TRANS | OBJDRV_C_FULLQUERY; /* TODO: Greg, double check these are correct. */ + if (!check(xaInit(&drv->RootContentTypes, 1))) goto err; + if (!check_neg(xaAddItem(&drv->RootContentTypes, "system/cluster"))) goto err; + drv->Capabilities = OBJDRV_C_TRANS | OBJDRV_C_FULLQUERY; /* TODO: Greg, are these correct? Should I add any others? */ /** Setup the function references. **/ drv->Open = clusterOpen; @@ -4415,15 +4535,17 @@ int clusterInitialize(void) // snprint_bytes(buf7, sizeof(buf7), sizeof(ClusterQuery)), // snprint_bytes(buf8, sizeof(buf8), sizeof(ClusterDriverCaches)) // ); - -// pVector v = ca_build_vector(""); -// const unsigned int len = ca_sparse_len(v); -// fprintf(stderr, "Vector (x%d): [%d", len, v[0]); -// for (unsigned int i = 1u; i < len; i++) -// { -// fprintf(stderr, ", %d", v[i]); -// } -// fprintf(stderr, "]\n"); +// + // 'st' (7: 13) collides with 'an' (7: 11) +// char* str1 = "This is a very long string of text"; +// char* str2 = "This is a very long string of textttttttttttt"; +// pVector v1 = ca_build_vector(str1); +// pVector v2 = ca_build_vector(str2); +// ca_fprint_vector(stdout, v1); printf("\n"); +// ca_fprint_vector(stdout, v2); printf("\n"); +// fprintf(stderr, "'%s' ?= '%s' -> %g\n", str1, str2, ca_cos_compare(v1, v2)); +// ca_free_vector(v1); +// ca_free_vector(v2); /** Register the driver. **/ if (!check(objRegisterDriver(drv))) goto err; From 4b656a4a407468296395b25ac11433eebdcb928f Mon Sep 17 00:00:00 2001 From: Israel Date: Thu, 13 Nov 2025 16:50:35 -0700 Subject: [PATCH 008/275] Improve exp_functions() to use central schema verification. Re-add Levenshtein to exp_functions. Publish edit_dist() in the cluster library. Fix mistakes in cluster driver function signatures. Fix spelling mistakes. Add detail to an error message in the lexer. Remove unused .cluster files. Clean up cluster-schema.cluster. Clean up other unused junk. --- centrallix-doc/Widgets/widgets.xml | 2 +- centrallix-lib/include/clusters.h | 7 + centrallix-lib/include/glyph.h | 6 +- centrallix-lib/include/util.h | 56 +- centrallix-lib/src/clusters.c | 32 +- centrallix-lib/src/mtlexer.c | 6 +- centrallix-lib/src/util.c | 4 +- centrallix-lib/src/xhash.c | 6 +- centrallix-os/cluster-schema.cluster | 111 -- centrallix-os/file.cluster | 67 - centrallix-os/file2.cluster | 42 - centrallix-sysdoc/OSDriver_Authoring.md | 1222 +++++++++++++----- centrallix-sysdoc/string_comparison.md | 101 -- centrallix-sysdoc/string_similarity.md | 63 +- centrallix/expression/exp_double_metaphone.c | 30 +- centrallix/expression/exp_functions.c | 513 +++----- centrallix/osdrivers/objdrv_cluster.c | 167 +-- 17 files changed, 1200 insertions(+), 1235 deletions(-) delete mode 100644 centrallix-os/file.cluster delete mode 100644 centrallix-os/file2.cluster delete mode 100644 centrallix-sysdoc/string_comparison.md diff --git a/centrallix-doc/Widgets/widgets.xml b/centrallix-doc/Widgets/widgets.xml index b6b50afde..f38f178d0 100644 --- a/centrallix-doc/Widgets/widgets.xml +++ b/centrallix-doc/Widgets/widgets.xml @@ -3731,7 +3731,7 @@ myTabControl "widget/tab" The title of the column to be displayed in the header row. - The type of the column: "text", "check", or "image". "text" is a normal column, and displays the textual value of the data element. "check" displays a checkmark if the data is non-zero (integers) or for strings if the value is non-empty and not "N" or "No". "image" displays the image referred to by the pathname contained in the data value. + The type of the column: "text", "check", "image", or "progress". "text" is a normal column, and displays the textual value of the data element. "check" displays a checkmark if the data is non-zero (integers) or for strings if the value is non-empty and not "N" or "No". "image" displays the image referred to by the pathname contained in the data value. "progress" displays a progress bar, with additional fields such as bar_color, bar_textcollor, and bar_padding. width of the column. diff --git a/centrallix-lib/include/clusters.h b/centrallix-lib/include/clusters.h index 8338cd5e0..05480e742 100644 --- a/centrallix-lib/include/clusters.h +++ b/centrallix-lib/include/clusters.h @@ -71,11 +71,17 @@ typedef struct nmRegister(sizeof(pCentroid), "pCentroid"); \ nmRegister(pCentroidSize, "Centroid"); \ nmRegister(sizeof(Dup), "Dup") + +/** Edit distance function. **/ +unsigned int edit_dist(const char* str1, const char* str2, const size_t str1_length, const size_t str2_length); +/** Vector functions. **/ pVector ca_build_vector(const char* str); unsigned int ca_sparse_len(const pVector vector); void ca_print_vector(const pVector vector); void ca_free_vector(pVector sparse_vector); + +/** Kmeans function. **/ int ca_kmeans( pVector* vectors, const unsigned int num_vectors, @@ -98,6 +104,7 @@ double ca_cos_compare(void* v1, void* v2); double ca_lev_compare(void* str1, void* str2); bool ca_eql(pVector v1, pVector v2); +/** Similarity search functions. **/ void* ca_most_similar( void* target, void** data, diff --git a/centrallix-lib/include/glyph.h b/centrallix-lib/include/glyph.h index 5f78eab5d..cfafd3946 100644 --- a/centrallix-lib/include/glyph.h +++ b/centrallix-lib/include/glyph.h @@ -35,8 +35,8 @@ #include -/** Uncomment to use glyphs. **/ -/** TODO: Israel - Comment this out. **/ +/** Uncomment to activate glyphs. **/ +/** Should not be enabled in production code on the master branch. */ // #define ENABLE_GLYPHS #ifdef ENABLE_GLYPHS @@ -50,7 +50,7 @@ *** *** @param name The symbol name of the visualizer. *** @param str The string printed for the visualization. - *** @param interval The number of invokations of glyph() required to print. + *** @param interval The number of invocations of glyph() required to print. *** @param flush Whether to flush on output. ***/ #define glyph_init(name, str, interval, flush) \ diff --git a/centrallix-lib/include/util.h b/centrallix-lib/include/util.h index 1f286cc26..0f2685039 100644 --- a/centrallix-lib/include/util.h +++ b/centrallix-lib/include/util.h @@ -50,7 +50,10 @@ extern "C" { #ifndef __cplusplus #include -/** TODO: Greg, is the __typeof__ syntax from GCC a portability concern? **/ +/*** TODO: Greg - Can we assume this code will always be compiled with GCC? + *** If not, then the __typeof__, __LINE__, and __FILE__ syntaxes might be a + *** portability concern. + ***/ /*** @brief Returns the smaller of two values. *** @@ -58,7 +61,7 @@ extern "C" { *** @param b The second value. *** @return The smaller of the two values. *** - *** @note This macro uses GCC extensions to enusre type safety. + *** @note This macro uses GCC extensions to ensure type safety. ***/ #define min(a, b) \ ({ \ @@ -73,7 +76,7 @@ extern "C" { *** @param b The second value. *** @return The larger of the two values. *** - *** @note This macro uses GCC extensions to enusre type safety. + *** @note This macro uses GCC extensions to ensure type safety. ***/ #define max(a, b) \ ({ \ @@ -151,53 +154,6 @@ void print_diagnostics(int code, const char* function_name, const char* file_nam _r; \ }) -/** Pattern for printing a binary int using printf(). **/ -#define INT_TO_BINARY_PATTERN "%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c%c" - -/*** Converts an int to the values that should be passed to printf() for the - *** INT_TO_BINARY_PATTERN pattern. - *** - *** @attention - Double evaluation is NOT HANDLED so int_val will be evaluted - *** 32 times when this macro is used. Ensure that evaluation of the value - *** passed for int_val does not have important side effects! - *** - *** @param int_val The int to be printed. - *** @returns Values for printf(). - ***/ -#define INT_TO_BINARY(int_val) \ - ((int_val) & 0b10000000000000000000000000000000 ? '1' : '0'), \ - ((int_val) & 0b01000000000000000000000000000000 ? '1' : '0'), \ - ((int_val) & 0b00100000000000000000000000000000 ? '1' : '0'), \ - ((int_val) & 0b00010000000000000000000000000000 ? '1' : '0'), \ - ((int_val) & 0b00001000000000000000000000000000 ? '1' : '0'), \ - ((int_val) & 0b00000100000000000000000000000000 ? '1' : '0'), \ - ((int_val) & 0b00000010000000000000000000000000 ? '1' : '0'), \ - ((int_val) & 0b00000001000000000000000000000000 ? '1' : '0'), \ - ((int_val) & 0b00000000100000000000000000000000 ? '1' : '0'), \ - ((int_val) & 0b00000000010000000000000000000000 ? '1' : '0'), \ - ((int_val) & 0b00000000001000000000000000000000 ? '1' : '0'), \ - ((int_val) & 0b00000000000100000000000000000000 ? '1' : '0'), \ - ((int_val) & 0b00000000000010000000000000000000 ? '1' : '0'), \ - ((int_val) & 0b00000000000001000000000000000000 ? '1' : '0'), \ - ((int_val) & 0b00000000000000100000000000000000 ? '1' : '0'), \ - ((int_val) & 0b00000000000000010000000000000000 ? '1' : '0'), \ - ((int_val) & 0b00000000000000001000000000000000 ? '1' : '0'), \ - ((int_val) & 0b00000000000000000100000000000000 ? '1' : '0'), \ - ((int_val) & 0b00000000000000000010000000000000 ? '1' : '0'), \ - ((int_val) & 0b00000000000000000001000000000000 ? '1' : '0'), \ - ((int_val) & 0b00000000000000000000100000000000 ? '1' : '0'), \ - ((int_val) & 0b00000000000000000000010000000000 ? '1' : '0'), \ - ((int_val) & 0b00000000000000000000001000000000 ? '1' : '0'), \ - ((int_val) & 0b00000000000000000000000100000000 ? '1' : '0'), \ - ((int_val) & 0b00000000000000000000000010000000 ? '1' : '0'), \ - ((int_val) & 0b00000000000000000000000001000000 ? '1' : '0'), \ - ((int_val) & 0b00000000000000000000000000100000 ? '1' : '0'), \ - ((int_val) & 0b00000000000000000000000000010000 ? '1' : '0'), \ - ((int_val) & 0b00000000000000000000000000001000 ? '1' : '0'), \ - ((int_val) & 0b00000000000000000000000000000100 ? '1' : '0'), \ - ((int_val) & 0b00000000000000000000000000000010 ? '1' : '0'), \ - ((int_val) & 0b00000000000000000000000000000001 ? '1' : '0') - #endif /* __cplusplus */ #endif /* UTILITY_H */ diff --git a/centrallix-lib/src/clusters.c b/centrallix-lib/src/clusters.c index d61a558c7..4a96b6ca1 100644 --- a/centrallix-lib/src/clusters.c +++ b/centrallix-lib/src/clusters.c @@ -104,7 +104,7 @@ static int charpair_cmp(const void *p1, const void *p2) *** input to get_char_pair_hash(). *** *** After hashing each character pair, we add some number from 1 to 13 to the - *** coresponding dimention. However, for most names, this results in a lot of + *** coresponding dimension. However, for most names, this results in a lot of *** zeros and a FEW positive numbers. Thus, after creating the dense vector, *** we convert it to a sparse vector in which a negative number replaces a run *** of that many zeros. Consider the following example: @@ -114,7 +114,7 @@ static int charpair_cmp(const void *p1, const void *p2) *** Sparse pVector: `[1,-3,3,-1]` *** *** Using these sparse vectors greatly reduces the required memory and gives - *** aproximately an x5 boost to performance when traversing vectors, at the + *** approximately an x5 boost to performance when traversing vectors, at the *** cost of more algorithmically complex code. *** *** @param str The string to be divided into pairs and hashed to make the vector. @@ -162,7 +162,7 @@ pVector ca_build_vector(const char* str) /** Sort char_pairs by hash value. **/ qsort(char_pairs, num_pairs, sizeof(CharPair), charpair_cmp); - /** Allocate space for the sparce vector. **/ + /** Allocate space for the sparse vector. **/ pVector sparse_vector = (pVector)check_ptr(nmSysMalloc((num_pairs * 2u + 1u) * sizeof(int))); if (sparse_vector == NULL) return NULL; @@ -403,7 +403,7 @@ static void parse_vector_token(const int token, unsigned int* remaining, unsigne } } -/*** Calculate the similarity on sparcely allocated vectors. Comparing +/*** Calculate the similarity on sparsely allocated vectors. Comparing *** any string to an empty string should always return 0.5 (untested). *** *** @param v1 Sparse vector #1. @@ -442,7 +442,7 @@ static double sparse_similarity(const pVector v1, const pVector v2) return (double)dot_product / (magnitude_sparse(v1) * magnitude_sparse(v2)); } -/*** Calculate the difference on sparcely allocated vectors. Comparing +/*** Calculate the difference on sparsely allocated vectors. Comparing *** any string to an empty string should always return 0.5 (untested). *** *** @param v1 Sparse vector #1. @@ -511,7 +511,7 @@ static double sparse_similarity_to_centroid(const pVector v1, const pCentroid c2 *** @skip *** LINK ../../centrallix-sysdoc/string_comparison.md#levenshtein ***/ -static unsigned int edit_dist(const char* str1, const char* str2, const size_t str1_length, const size_t str2_length) +unsigned int edit_dist(const char* str1, const char* str2, const size_t str1_length, const size_t str2_length) { /*** lev_matrix: *** For all i and j, d[i][j] will hold the Levenshtein distance between @@ -554,7 +554,7 @@ static unsigned int edit_dist(const char* str1, const char* str2, const size_t s if (str1[i - 1] == str2[j - 1]) lev_matrix[i][j] = lev_matrix[i - 1][j - 1]; - /*** We need to make a change, so use the opereration with the + /*** We need to make a change, so use the oppereration with the *** lowest cost out of delete, insert, replace, or swap. ***/ else @@ -587,7 +587,7 @@ static unsigned int edit_dist(const char* str1, const char* str2, const size_t s return result; } -/*** Compares two strings using their cosie simiarity, returning a value +/*** Compares two strings using their cosie similarity, returning a value *** between `0.0` (completely different) and `1.0` (identical). If either *** OR BOTH strings are NULL, this function returns `0.0`. *** @@ -618,7 +618,7 @@ double ca_cos_compare(void* v1, void* v2) return sparse_similarity(vec1, vec2); } -/*** Compares two strings using their levenstien edit distance to compute a +/*** Compares two strings using their Levenshtein edit distance to compute a *** similarity between `0.0` (completely different) and `1.0` (identical). *** If both strings are empty, this function returns `1.0` (identical). If *** either OR BOTH strings are NULL, this function returns `0.0`. @@ -722,7 +722,7 @@ static double get_cluster_size( *** a size of `n`. *** *** The following table shows data sizes vs.selected cluster size. In testing, - *** these numbers tended to givea good balance of accuracy and dulocates detected. + *** these numbers tended to give a good balance of accuracy and duplicates detected. *** *** ```csv *** Data Size, Actual @@ -771,7 +771,7 @@ unsigned int compute_k(const unsigned int n) *** clusters have a size of negative infinity. In this implementation, *** the bug is mitigated by setting a small number of max iterations, *** such as 16 instead of 100. - *** @attention - Issue: Clusters do not apear to improve much after the first + *** @attention - Issue: Clusters do not appear to improve much after the first *** iteration, which puts the efficacy of the algorithm into question. This *** may be due to the uneven density of a typical dataset. However, the *** clusters still offer useful information. @@ -962,7 +962,7 @@ int ca_kmeans( *** @param similarity A function which takes two data items of the type *** of the data param and returns their similarity. *** @param threshold The minimum similarity threshold. If the most similar - *** data does not meet this threshold, the funciton returns NULL. + *** data does not meet this threshold, the function returns NULL. *** @returns A pointer to the most similar piece of data found in the data *** array, or NULL if the most similar data did not meet the threshold. ***/ @@ -988,10 +988,10 @@ void* ca_most_similar( } -/*** Runs a sliding search over the povided data, comparing each element to +/*** Runs a sliding search over the provided data, comparing each element to *** the following `window_size` elements, invoking the passed comparison *** function just under `window_size * num_data` times. If any comparison - *** yeilds a similarity greater than the threshold, it is stored in the + *** yields a similarity greater than the threshold, it is stored in the *** xArray returned by this function. *** *** @param data The data to be searched. @@ -1076,9 +1076,9 @@ pXArray ca_sliding_search( return NULL; } -/*** Runs a complete search over the povided data, comparing each element to +/*** Runs a complete search over the provided data, comparing each element to *** each other element, invoking the passed comparison function `num_data^2` - *** times. If any comparison yeilds a similarity greater than the threshold, + *** times. If any comparison yields a similarity greater than the threshold, *** it is stored in the xArray returned by this function. *** *** @param data The data to be searched. diff --git a/centrallix-lib/src/mtlexer.c b/centrallix-lib/src/mtlexer.c index e92ea49ff..39a69cc15 100644 --- a/centrallix-lib/src/mtlexer.c +++ b/centrallix-lib/src/mtlexer.c @@ -7,6 +7,7 @@ #include #include #include + #include "newmalloc.h" #include "mtask.h" #include "mtlexer.h" @@ -907,7 +908,9 @@ mlxNextToken(pLxSession this) } else { - mssError(1,"MLX","Unexpected character encountered"); + char buf[4]; + snprintf(buf, sizeof(buf), "%c", ch); // mssError() does not support %c. + mssError(1, "MLX", "Unexpected character encountered: '%s'", buf); this->TokType = MLX_TOK_ERROR; break; } @@ -1305,4 +1308,3 @@ mlxSetOffset(pLxSession this, unsigned long new_offset) return 0; } - diff --git a/centrallix-lib/src/util.c b/centrallix-lib/src/util.c index b18361280..f60349a74 100644 --- a/centrallix-lib/src/util.c +++ b/centrallix-lib/src/util.c @@ -85,7 +85,7 @@ unsigned int strtoui(const char *nptr, char **endptr, int base){ } /*** Detects the optimal number of threads to use on this system. - *** Note: Multithreading is not currently supported, so this funciton + *** Note: Multithreading is not currently supported, so this function *** will always return 1, for now. *** *** @returns The number of threads that should be used on this system. @@ -120,7 +120,7 @@ static char* units_metric[nUnits] = {"bytes", "KB", "MB", "GB"}; *** *** @param buf The buffer to which new text will be written, using snprintf(). *** @param buf_size The amount of space in the buffer, passed to snprintf(). - *** It is recomended to have at least 12 characters available. + *** It is recommended to have at least 12 characters available. *** @param bytes The number of bytes, which will be formatted and written *** to the buffer.. *** @returns buf, for chaining. diff --git a/centrallix-lib/src/xhash.c b/centrallix-lib/src/xhash.c index 32a4a35eb..46ef3a6fb 100644 --- a/centrallix-lib/src/xhash.c +++ b/centrallix-lib/src/xhash.c @@ -295,11 +295,11 @@ xhClear(pXHashTable this, int (*free_fn)(), void* free_arg) *** @param this The affected hash table. *** @param callback_fn A callback function to be called on each hash table *** entry. It takes 2 parameters: the current hash table entry and a void* - *** argument specified using each_arg. If any invokation of the callback + *** argument specified using each_arg. If any invocation of the callback *** function returns a value other than 0, xhForEach() will immediately *** fail, returning that value as the error code. - *** @param each_arg An aditional argument which will be passed to each - *** invokation of the callback function. + *** @param each_arg An additional argument which will be passed to each + *** invocation of the callback function. *** @returns 0 if the function executes successfully. *** 1 if the callback function is NULL. *** n (where n != 0) if the callback function returns n. diff --git a/centrallix-os/cluster-schema.cluster b/centrallix-os/cluster-schema.cluster index 277e2bb12..4113a339a 100644 --- a/centrallix-os/cluster-schema.cluster +++ b/centrallix-os/cluster-schema.cluster @@ -59,114 +59,3 @@ file_name "system/cluster" - /key2 : string // The key of the second data point. - /sim : double && 0.0 < x <= threshold // The similarity of the two data points. ... - -// Other notes - -// This means centrallix scripts will have to chose when to switch -// from complete search to clustered search. I think this is a good -// thing, because that feels like a higher-level responsibility. - -// Invoke file: -// select * from /file.cluster - -// Driver-authoring.md -// Comprehend stparse.c (lib vs. centrallix?) -// Design what a .cluster file looks like. -// -// Figure out how to invoke the object system. - -// Random queries - -// Names -SELECT CONCAT(p_given_name, ' ', p_surname) AS full_name, - COUNT(*) AS num_dups -FROM p_partner -WHERE p_given_name is not null -AND p_surname is not null -AND p_given_name != "" -AND p_surname != "" -AND p_given_name != " " -AND p_surname != " " -GROUP BY full_name -ORDER BY num_dups DESC -LIMIT 1; -// Result: Ine Bradley with 4 dups - -// Phone Numbers -SELECT CONCAT(ci.p_phone_country, ci.p_phone_area_city, ci.p_contact_data) AS phone_number, - COUNT(*) AS num_dups -FROM p_partner AS p -JOIN p_contact_info AS ci - ON p.p_partner_key = ci.p_partner_key -WHERE ci.p_contact_data != ' ' -AND ci.p_contact_data != '' -AND (ci.p_contact_type = 'P' OR ci.p_contact_type = 'C') -GROUP BY phone_number -ORDER BY num_dups DESC -LIMIT 1; -// Result: 1813762-2274 with 2 dups - -// Emails and Addresses -SELECT CONCAT(ci.p_contact_data, ' ', - l.p_in_care_of, ' ', - l.p_address_1, ' ', - l.p_address_2, ' ', - l.p_address_3, ' ', - l.p_city, ' ', - l.p_state_province, ' ', - l.p_country_code, ' ', - l.p_postal_code) AS email_and_address, - COUNT(*) AS duplicate_count -FROM p_partner AS p -JOIN p_contact_info AS ci - ON p.p_partner_key = ci.p_partner_key -JOIN p_location AS l - ON p.p_partner_key = l.p_partner_key -WHERE ci.p_contact_type = 'E' -GROUP BY email_and_address -ORDER BY duplicate_count DESC -LIMIT 1; -// Result: richard.aypofblcsg@iipr.yeen with 2 dups - -// Email -SELECT ci.p_contact_data AS email, - COUNT(*) AS duplicate_count -FROM p_partner AS p -JOIN p_contact_info AS ci - ON p.p_partner_key = ci.p_partner_key -WHERE ci.p_contact_type = 'E' -GROUP BY email -ORDER BY duplicate_count DESC -LIMIT 1; - -// Result: uoehtbtjvqh20@ltirs.zese with 2 dups - -// Address -SELECT CONCAT(l.p_in_care_of, ' ', - l.p_address_1, ' ', - l.p_address_2, ' ', - l.p_address_3, ' ', - l.p_city, ' ', - l.p_state_province, ' ', - l.p_country_code, ' ', - l.p_postal_code) AS address, - COUNT(*) AS duplicate_count -FROM p_partner AS p -JOIN p_location AS l - ON p.p_partner_key = l.p_partner_key -WHERE l.p_address_1 != ' ' -GROUP BY address -ORDER BY duplicate_count DESC -LIMIT 1; -// Result: "742 1ben Sc E Adams FL US 49152" with 4 - - -// Output to dataset -INTO OUTFILE '/var/lib/mysql/db_output.csv' -LINES TERMINATED BY '|' - -// Output to CSV -INTO OUTFILE '/var/lib/mysql/db_output.csv' -FIELDS TERMINATED BY ',' -ENCLOSED BY '"' -LINES TERMINATED BY '\n'; diff --git a/centrallix-os/file.cluster b/centrallix-os/file.cluster deleted file mode 100644 index 95eacfee0..000000000 --- a/centrallix-os/file.cluster +++ /dev/null @@ -1,67 +0,0 @@ -$Version=2$ -file_name "system/cluster" - { - // Developer can specify parameters to improve file reuseability. - // TIP: Improve performance by declairing frequently used parameters first. - k "cluster/parameter" { type = integer; style=notnull; } - str "cluster/parameter" { type = string; } - int "cluster/parameter" { type = integer; default = runserver(:parameters:k); } - dbl "cluster/parameter" { type = double; default=4.2; } - // conversion "cluster/parameter" { type=double; default=4; } - - null_str "cluster/parameter" { type = string; default = null; } - null_int "cluster/parameter" { type = integer; default = null; } - null_dbl "cluster/parameter" { type = double; default = null; } - - // We calculate k in a centrallix script using: - // k = max(2, pow(log(n) / log(36), 3.2) - 8) - // where n is the number of records passed. - - // Specify the data source at the top of the file. - // How do we pass distinct data? Should the driver - // handle that for us? - source = "/apps/kardia/data/Kardia_DB/p_partner/rows"; - attr_name = p_given_name; // runserver(:parameters:str) - - // Multiple data sources when? - - // Clustering object specifies properties for clustering. - kmeans_cluster "cluster/cluster" - { - algorithm = "k-means"; - similarity_measure = "cosine"; - // window_size = 16; - num_clusters = runserver(:parameters:k); - min_improvement = 0.0001; - max_iterations = 48; - - // Create subclusters. (Not implemented) - sub_cluster "cluster/cluster" - { - algorithm = "none"; - similarity_measure = "cosine"; - num_clusters = 7; - min_improvement = "max"; - } - } - - // Complete search. - no_clustering "cluster/cluster" - { - algorithm = "none"; - } - - dups "cluster/search" - { - source = kmeans_cluster; - similarity_measure = "cosine"; - threshold = 0.75; - } - - dups2 "cluster/search" - { - source = no_clustering; - similarity_measure = "cosine"; - threshold = 0.75; - } - } diff --git a/centrallix-os/file2.cluster b/centrallix-os/file2.cluster deleted file mode 100644 index a55c37f85..000000000 --- a/centrallix-os/file2.cluster +++ /dev/null @@ -1,42 +0,0 @@ -$Version=2$ -file_name "system/cluster" - { - // Developer can specify parameters to improve file reuseability. - // TIP: Improve performance by declairing frequently used parameters first. - k "cluster/parameter" { type = integer; style=notnull; } - str "cluster/parameter" { type = string; default="k-means"; } - int "cluster/parameter" { type=integer; default=:parameters:k; } - dbl "cluster/parameter" { type=double; default=4.2; } - // conversion "cluster/parameter" { type=double; default=4; } - - null_str "cluster/parameter" { type = string; default = null; } - null_int "cluster/parameter" { type = integer; default = null; } - null_dbl "cluster/parameter" { type = double; default = null; } - - // We calculate k in a centrallix script using: - // k = max(2, pow(log(n) / log(36), 3.2) - 8) - // where n is the number of records passed. - - // Specify the data source at the top of the file. - // How do we pass distinct data? Should the driver - // handle that for us? - source = "/apps/kardia/data/Kardia_DB/p_partner/rows"; - attr_name = "p_given_name"; - - // Clustering object specifies properties for clustering. - kmeans_cluster "cluster/cluster" - { - algorithm = "k-means"; - similarity_measure = "cosine"; - num_clusters = :parameters:k; - min_improvement = 0.0001; - max_iterations = 48; - } - - dups "cluster/search" - { - source = kmeans_cluster; - threshold = 0.75; - similarity_measure = "cosine"; - } - } diff --git a/centrallix-sysdoc/OSDriver_Authoring.md b/centrallix-sysdoc/OSDriver_Authoring.md index 5755d15c5..d00c192f6 100644 --- a/centrallix-sysdoc/OSDriver_Authoring.md +++ b/centrallix-sysdoc/OSDriver_Authoring.md @@ -1,52 +1,76 @@ # ObjectSystem Driver Interface -Author: Greg Beeley -Date: January 13, 1999 +**Author**: Greg Beeley -Updated: March 9, 2011 +**Date**: January 13, 1999 -License: Copyright (C) 2001-2011 LightSys Technology Services. See LICENSE.txt for more information. +**Updated**: November 27, 2025 + +**License**: Copyright (C) 2001-2011 LightSys Technology Services. See LICENSE.txt for more information. ## Table of Contents - [ObjectSystem Driver Interface](#objectsystem-driver-interface) - [Table of Contents](#table-of-contents) - [I Introduction](#i-introduction) - [II Interface](#ii-interface) - - [A. Initialization](#a--initialization) - - [B. Opening And Closing Objects](#b--opening-and-closing-objects) - - [C. Creating and Deleting Objects.](#c--creating-and-deleting-objects) - - [D. Reading and Writing Object Content.](#d--reading-and-writing-object-content) - - [E. Querying for Child Objects.](#e--querying-for-child-objects) - - [F. Managing Object Attributes](#f--managing-object-attributes) - - [G. Managing Object Methods](#g--managing-object-methods) + - [Function: Open](#function-open) + - [Function: OpenChild()](#function-openchild) + - [Function: Close()](#function-close) + - [Function: Create()](#function-create) + - [Function: Delete()](#function-delete) + - [Function: DeleteObj()](#function-deleteobj) + - [Function: Read()](#function-read) + - [Function: Write()](#function-write) + - [Function: OpenQuery()](#function-openquery) + - [Function: QueryDelete()](#function-querydelete) + - [Function: QueryFetch()](#function-queryfetch) + - [Function: QueryCreate()](#function-querycreate) + - [Function: QueryClose()](#function-queryclose) + - [Function: GetAttrType()](#function-getattrtype) + - [Function: GetAttrValue()](#function-getattrvalue) + - [Function: GetFirstAttr()](#function-getfirstattr--getnextattr) + - [Function: GetNextAttr()](#function-getfirstattr--getnextattr) + - [Function: SetAttrValue()](#function-setattrvalue) + - [Function: AddAttr()](#function-addattr) + - [Function: OpenAttr()](#function-openattr) + - [Function: GetFirstMethod()](#function-getfirstmethod--getnextmethod) + - [Function: GetNextMethod()](#function-getfirstmethod--getnextmethod) + - [Function: ExecuteMethod()](#function-executemethod) + - [Function: PresentationHints()](#function-presentationhints) + - [Function: Info()](#function-info) + - [Function: Commit()](#function-commit) + - [Function: GetQueryCoverageMask()](#function-getquerycoveragemask) + - [Function: GetQueryIdentityPath()](#function-getqueryidentitypath) - [III Reading the Node Object](#iii-reading-the-node-object) - - [pSnNode snReadNode(pObject obj)](#psnnode-snreadnodepobject-obj) - - [pSnNode snNewNode(pObject obj, char* content_type)](#psnnode-snnewnodepobject-obj-char-content_type) - - [int snWriteNode(pSnNode node)](#int-snwritenodepsnnode-node) - - [int snDeleteNode(pSnNode node)](#int-sndeletenodepsnnode-node) - - [int snGetSerial(pSnNode node)](#int-sngetserialpsnnode-node) - - [pStructInf stParseMsg(pFile inp_fd, int flags)](#pstructinf-stparsemsgpfile-inp_fd-int-flags) - - [pStructInf stParseMsgGeneric(void* src, int (*read_fn)(), int flags)](#pstructinf-stparsemsggenericvoid-src-int-read_fn-int-flags) - - [int stGenerateMsg(pFile out_fd, pStructInf info, int flags)](#int-stgeneratemsgpfile-out_fd-pstructinf-info-int-flags) - - [int stGenerateMsgGeneric(void* dst, int (*write_fn)(), pStructInf info, int flags)](#int-stgeneratemsggenericvoid-dst-int-write_fn-pstructinf-info-int-flags) - - [pStructInf stCreateStruct(char* name, char* type)](#pstructinf-stcreatestructchar-name-char-type) - - [pStructInf stAddAttr(pStructInf inf, char* name)](#pstructinf-staddattrpstructinf-inf-char-name) - - [pStructInf stAddGroup(pStructInf inf, char* name, char* type)](#pstructinf-staddgrouppstructinf-inf-char-name-char-type) - - [int stAddValue(pStructInf inf, char* strval, int intval)](#int-staddvaluepstructinf-inf-char-strval-int-intval) - - [pStructInf stLookup(pStructInf inf, char* name)](#pstructinf-stlookuppstructinf-inf-char-name) - - [int stAttrValue(pStructInf inf, int* intval, char** strval, int nval)](#int-stattrvaluepstructinf-inf-int-intval-char-strval-int-nval) - - [int stFreeInf(pStructInf this)](#int-stfreeinfpstructinf-this) + - [Module: st_node](#module-st_node) + - [st_node: snReadNode()](#st_node-snreadnode) + - [st_node: snNewNode()](#st_node-snnewnode) + - [st_node: snWriteNode()](#st_node-snwritenode) + - [st_node: snDelete()](#st_node-sndeletenode) + - [st_node: snGetSerial()](#st_node-sngetserial) + - [st_node: snGetLastModification()](#st_node-sngetlastmodification) + - [Module: stparse](#module-stparse) + - [stparse: stStructType()](#stparse-ststructtype) + - [stparse: stLookup()](#stparse-stlookup) + - [stparse: stAttrValue()](#stparse-stattrvalue) + - [stparse: stGetExpression()](#stparse-stgetexpression) + - [stparse: stCreateStruct()](#stparse-stcreatestruct) + - [stparse: stAddAttr()](#stparse-staddattr) + - [stparse: stAddGroup()](#stparse-staddgroup) + - [stparse: stAddValue()](#stparse-staddvalue) + - [stparse: stFreeInf()](#stparse-stfreeinf) + - [stparse: Using Fields Directly](#stparse-using-fields-directly) - [IV Memory Management in Centrallix](#iv-memory-management-in-centrallix) - - [void* nmMalloc(int size)](#void-nmmallocint-size) - - [void nmFree(void* ptr, int size)](#void-nmfreevoid-ptr-int-size) - - [void nmStats()](#void-nmstats) - - [void nmRegister(int size, char* name)](#void-nmregisterint-size-char-name) - - [void nmDebug()](#void-nmdebug) - - [void nmDeltas()](#void-nmdeltas) - - [void* nmSysMalloc(int size)](#void-nmsysmallocint-size) - - [void nmSysFree(void* ptr)](#void-nmsysfreevoid-ptr) - - [void* nmSysRealloc(void* ptr, int newsize)](#void-nmsysreallocvoid-ptr-int-newsize) - - [char* nmSysStrdup(const char* str)](#char-nmsysstrdupconst-char-str) + - [nmMalloc()](#nmmalloc) + - [nmFree()](#nmfree) + - [nmStats()](#nmstats) + - [nmRegister()](#nmregister) + - [nmDebug()](#nmdebug) + - [nmDeltas()](#nmdeltas) + - [nmSysMalloc()](#nmsysmalloc) + - [nmSysRealloc()](#nmsysrealloc) + - [nmSysStrdup()](#nmsysstrdup) + - [nmSysFree()](#nmsysfree) - [V Other Utility Modules](#v-other-utility-modules) - [A. XArray (XA) - Arrays](#axarray-xa---arrays) - [xaInit(pXArray this, int init_size)](#xainitpxarray-this-int-init_size) @@ -115,520 +139,1028 @@ License: Copyright (C) 2001-2011 LightSys Technology Services. See LICENSE.txt - [B. Object attribute enumeration, getting, and setting.](#bobject-attribute-enumeration-getting-and-setting) - [C. Object querying (for subobjects)](#cobject-querying-for-subobjects) + + ## I Introduction -An objectsystem driver's purpose is to provide access to a particular type of local or network data/resource, and to organize that data in a tree- structured heirarchy that can be integrated into the Centrallix's ObjectSystem. This tree structure will vary based on the data being presented, but will fit the basic ObjectSystem model of a heirarchy of objects, each having attributes, perhaps some methods, and possibly content. +An objectsystem driver's purpose is to provide access to a particular type of local or network data/resource. Specific information about the resource to be accessed (such as credentials for a database, queries for selecting data, the auth token for an API, etc.) is stored in a file that is openned by the relevant driver. For example, the query driver (defined in `objdrv_query.c`) opens `.qy` files, which store one or more ObjectSQL queries used to fetch data. -Each objectsystem driver will implement this subtree structure rooted at what is called the "node" object. The node has a specifically recognizable object type which the ObjectSystem Management Layer uses to determine which OS Driver to pass control to. Normally, the 'node' object is a UNIX file either with a particular extension registered with the OSML, or a UNIX file residing in a directory containing a '.type' file, which contains the explicit object type for all objects in that directory without recognizable extensions. +When the object system starts up, each driver registers one or more type names that it supports (e.g. `"system/query"` for the query driver). When a file is openned, the object system uses the file's type name to select which driver to use. It finds this type name with one of two strategies. If the file has an extension (e.g. `example.qy`), that extension can be mapped to a type name using `types.cfg` (e.g. `.qy` maps to `"system/query"`). Althernatively, the file may reside in a directory containing a `.type` file which explicitly specifies the type name for all files in that directory without recognizable extensions. -Normally, objectsystem drivers will be able to manage any number of 'node' objects and the subtrees rooted at them. Each 'node' object will normally relate to a particular instance of a network resource, or in some cases, a group of resources that are easily enumerated. For example, a POP3 server would be a network resource that an OS driver could be written for. If the network had multiple POP3 servers, then that one OS driver would be able to access each of them using different node objects. However, if somehow the OS driver were able to easily enumerate the various POP3 servers on the network (i.e., they responded to some kind of hypothetical broadcast query), then the OS driver author could optionally design the driver to list the POP3 servers under a single node for the whole network. +Once a file is openned, the driver should organize provided data into a tree-structured hierarchy, which becomes part of the path used by Centrallix's ObjectSystem. For example, when opening `example.qy` in the ObjectSystem, the driver makes `/rows` and `/columns` available, allowing for paths such as `/apps/data/example.qy/rows`. The root of a driver's tree (`example.qy`) is called the driver's "node" object, and most paths traverse the root nodes of multiple drivers. A driver author is free to define any manner of tree structures for representing data available within their driver. However, the structure should fit the basic ObjectSystem model of a hierarchy of objects, each having attributes, and optionally some methods and/or content. -The structure of the subtree beneath the node object is entirely up to the drivers' author to determine; the OSML does not impose any structural restrictions on such subtrees. +A driver can be openned multiple times, leading one driver to have multiple "node" objects, also called instances. Typically, each "node" object relates to a particular instance of a network resource. For example, an instance of a POP3 driver might represent a POP3 server on the network. If the network had multiple POP3 servers, this driver could be used to access each of them through different node objects (e.g. `dev.pop3`, `prod.pop3`, etc.). However, if somehow the OS driver were able to easily enumerate the various POP3 servers on the network (i.e., they responded to some kind of hypothetical broadcast query), then the OS driver author could also design the driver to list the POP3 servers under a single node for the whole network. -Here is one example of an OS Driver's node object and subtree (this is for the Sybase OS Driver, objdrv_sybase.c): +The structure of the subtree beneath the node object is entirely up to the drivers' author to determine; the OSML does not impose any structural restrictions on such subtrees. Each object within this structure (e.g. `/example.qy`) can have three types of readable data: +- Child objects (e.g. `/rows`) which can have their own data. +- Content, which can be read similar to reading a file. +- Query data, allowing the object to be queried for information. -``` -OMSS_DB (type = application/sybase) +Thus, parent objects with child objects behave similarly to a directory, although they can still have separate readable data _and_ queryable data. This may seem foreign in the standard file system paradime, however, it is common for web servers, where opening a directory often returns `index.html` file in that directory, or some other form of information to allow further navigation. Querying an object was originally intended as a way to quickly traversal of its child objects, although queries are not required to be implemented this way. + +Below is an example of the Sybase driver's node object and its subtrees of child objects (defined in `objdrv_sybase.c`): + +```sh +OMSS_DB (type = "application/sybase") | - +--- JNetHelp (type = system/table) - | | - | +--- columns (type = system/table-columns) - | | | - | | +--- document_id (type = system/column) - | | | - | | +--- parent_id (type = system/column) - | | | - | | +--- title (type = system/column) - | | | - | | +--- content (type = system/column) - | | - | +--- rows (type = system/table-rows) - | | - | +--- 1 (type = system/row) - | | - | +--- 2 (type = system/row) + +----- JNetHelp (type = "system/table") + | | + | +----- columns (type = "system/table-columns") + | | | + | | +----- document_id (type = "system/column") + | | | + | | +----- parent_id (type = "system/column") + | | | + | | +----- title (type = "system/column") + | | | + | | +----- content (type = "system/column") + | | + | +----- rows (type = "system/table-rows") + | | + | +----- 1 (type = "system/row") + | | + | +----- 2 (type = "system/row") | - +--- Partner (type = system/table) + +----- Partner (type = "system/table") ``` (... and so forth) -In this case the node object would contain the information necessary to access the database, such as server name, database name, max connections to pool, and so forth. More about the node object and managing its parameters will be discussed later in this document. +In this case, the `OMSS_DB` file becomes the driver's node object. This file would contain the information necessary to access the database, such as server name, database name, max connections to pool, and so forth. -OS Drivers support several primary areas of functionality: opening and closing objects, reading and writing object content (if the object has content), setting and viewing object attributes, executing object methods, and querying an object's child objects based on name and/or attribute values. Drivers will also support the creation and deletion of objects and/or a set of child objects. +OS Drivers support several primary areas of functionality: +- Opening and closing objects. +- Creating and deleting node objects (optional). +- Reading and writing object content (optional). +- Getting and (optionally) setting object attributes. +- Executing object methods (optional). +- Querying data attributes (optional). -## II Interface -This section describes the standard interface between the OSML and the ObjectSystem driver itself. +Using the example above, we can query from the database using a statement like `select :title from /OMSS_DB/JNetHelp/rows`, which will open a sybase driver instance, then open a query and repeatedly fetch rows, getting the `title` attribute from each row. -### A. Initialization -Each OS Driver will have an initialization function, normally named xxxInitialize() where 'xxx' is the driver's abbreviative prefix. This prefix should be attached to each and every function within the OS driver for consistency and project management. Normally 'xxx' is two to four characters, all lowercase. This initialization function is called when the Centrallix starts up, and at least at the present time, this initial call to the OS driver must be manually added to the appropriate startup code, currently found in 'centrallix.c'. - -Within the initialization function, the driver should initialize all necessary global variables and register itself with the OSML. Global variables should all be placed inside a single global 'struct', which is normally named similarly to the driver's prefix, except normally in all uppercase. Under no circumstances should global variables be accessed outside of the module, except via the module's functions. - -To register with the OSML, the driver must first allocate an ObjDriver structure and fill in its contents. +## II Interface +This section describes the standard interface between the OSML and the ObjectSystem driver itself. Every driver should implement certain required functions. (**Note**: Many drivers "implement" some required functions to simply fail with a not implemented or not supported error. For example, most database drivers "implement" `Read()` and `Write()` this way because database content should be queried, not read). Various optional functions are also available, which a driver is not required to implement. + + +The driver should implement an `Initialize()` function, as well as the following (* indicates required functions): +| Function Name | Description +| --------------------------------------------------------- | ------------ +| [Open](#function-open)* | Opens a new driver instance object on a given root node. +| [OpenChild](#function-openchild) | ??? +| [Close](#function-close)* | Close an open object created by either `Open()` or `QueryFetch()`. +| [Create](#function-create) | Create a new driver root node object. +| [Delete](#function-delete) | Delete an existing driver root node object. +| [DeleteObj](#function-deleteobj)* | ??? +| [OpenQuery](#function-openquery)** | Start a new query for child objects of a given object. +| [QueryDelete](#function-querydelete) | Delete specific objects from a query's result set. +| [QueryFetch](#function-queryfetch)** | Open the next child object in the query's result set. +| [QueryCreate](#function-querycreate) | ??? +| [QueryClose](#function-queryclose)** | Close an open query. +| [Read](#function-read)* | Read content from the object. +| [Write](#function-write)* | Write content to the object. +| [GetAttrType](#function-getattrtype)* | Get the type of a given object's attribute. +| [GetAttrValue](#function-getattrvalue)* | Get the value of a given object's attribute. +| [GetFirstAttr](#function-getfirstattr--getnextattr)* | Get the name of the object's first attribute. +| [GetNextAttr](#function-getfirstattr--getnextattr)* | Get the name of the object's next attribute. +| [SetAttrValue](#function-setattrvalue) | Set the value of an object's attribute. +| [AddAttr](#function-addattr) | Add a new attribute to an object. +| [OpenAttr](#function-openattr) | Open an attribute as if it were an object with content. +| [GetFirstMethod](#function-getfirstmethod--getnextmethod) | Get the name of an object's first method. +| [GetNextMethod](#function-getfirstmethod--getnextmethod) | Get the name of an object's next method. +| [ExecuteMethod](#function-executemethod) | Execute a method with a given name and optional parameter string. +| [PresentationHints](#function-presentationhints) | Get info about an object's attributes. +| [Info](#function-info)* | Get info about an object instance. +| [Commit](#function-commit) | Commit changes made to an object. +| [GetQueryCoverageMask](#function-getquerycoveragemask) | ??? +| [GetQueryIdentityPath](#function-getqueryidentitypath) | ??? + +_*Function is always required._ + +_**Function is required to support queries._ + + +--- +### Abbreviative Prefix +Each OS Driver will have an abbreviation prefix, such as `qy` for the query driver or `sydb` for the sybase database driver. This prefix should be prepended to the start of every public function name within the OS driver for consistency and scope management (e.g. `qyInitialize()`, `sydbQueryFetch()`, etc.). Normally, a driver's abbreviation prefix is two to four characters, all lowercase and may be the same as a file extension the driver supports. However, this is not an absolute requirement (see the cluster driver in `objdrv_cluster.c` which supports `.cluster` files using an abbreviation prefix of `cluster`). + +This document uses `xxx` to refer to an unspecified abbreviative prefix. + +--- +### Internal Functions +It is highly likely that driver authors will find shared functionality in the following functions, or wish to abstract out functionality from any of them for a variety of reasons. When creating additional internal functions in this way, they should be named using the convention of `xxx_internal_FunctionName()`, or possibly `xxxi_FunctionName()` for short. + +--- +### Function: Initialize ```c - pObjDriver drv; - - drv = (pObjDriver)nmMalloc(sizeof(ObjDriver)); +/*** @returns 0 if successful, or + *** -1 if an error occurred. + ***/ +int xxxInitialize(void) ``` +- ⚠️ **Warning**: Currently, the success/failure of this function is ignored by the caller. +- 📖 **Note**: Unlike other functions defined in the driver, each driver author must manually add this call to the start up code, found in the `cxDriverInit()` function in `centrallix.c`. -This involves setting a large number of fields to the appropriate entry points within the OS Driver, as well as telling the OSML what object type(s) are handled by the driver and giving the OSML a description of the driver. A list of the required entry point functions / fields follows: - -| Function/Field | Description -| -------------------- | ------------ -| Open | Function that the OSML calls when the user opens an object managed by this driver. -| Close | Close an open object. -| Create | Create a new object. -| Delete | Delete an existing object. -| OpenQuery | Start a query for child objects. -| QueryDelete | Delete all objects in the query result set. -| QueryFetch | Open the next child object in the query's result set. -| QueryClose | Close an open query. -| Read | Read content from the object. -| Write | Write content to the object. -| GetAttrType | Get the type of an object's attribute. -| GetAttrValue | Get the value of an object's attribute. -| GetFirstAttr | Get the first attribute associated with the object. -| GetNextAttr | Get the next attribute associated with the object. -| SetAttrValue | Set the value of an attribute. -| AddAttr | Add a new attribute to an object. -| OpenAttr | Open an attribute as if it were an object with content. -| GetFirstMethod | Get the first method of the object. -| GetNextMethod | Get the next method of an object. -| ExecuteMethod | Execute a method with an optional string parameter. - -The only method that can be set to NULL is the QueryDelete method, in which case the OSML will call QueryFetch() and Delete() in succession. However, if the underlying network resource has the capability of intelligently deleting objects matching the query's criteria, this method should be implemented (as with a database server). - -Another field in the driver structure is the Capabilities field. This field is a bitmask, and can currently contain zero or more of the following options: +The initialization function is called when the Centrallix starts up, and should register the driver with the OSML and initialize necessary global variables. It is recommended to place global variables in a single global 'struct' that is named with the driver's prefix in all uppercase. Global variables should **NOT** be accessed from outside the driver. Instead, the driver should define functions to access them, allowing it to abstract details away from other drivers. -- OBJDRV_C_FULLQUERY: Indicates that this objectsystem driver will intelligently process the query's expression tree specified in the OpenQuery call, and will only return objects that match that expression. If this flag is missing, the OSML will filter objects returned by QueryFetch so that the calling user does not get objects that do not match the query. Typically this is set by database server drivers. +To register itself with the OSML, the driver should first allocate an ObjDriver structure and initialize its contents: - THE ABOVE IS OUT-OF-DATE. From now on, a driver can determine whether to handle the Where and OrderBy on a per-query basis, by setting values in the ObjQuery structure used when opening a new query. This is because a driver may be able to handle Where and OrderBy for some object listings but not for others. +```c +pObjDriver drv = (pObjDriver)nmMalloc(sizeof(ObjDriver)); +if (drv == NULL) goto error_handling; +memset(drv, 0, sizeof(ObjDriver)); +... +``` -- OBJDRV_C_TRANS: Indicates that this objectsystem driver requires transaction management by the OSML's transaction layer (the OXT layer). OS drivers that require this normally are those that for some reason cannot complete operations in independence from one another. For example, with a database driver, the creation of a new row object and the setting of its attributes must be done as one operation, although the operation requires several calls from the end user's process. The OXT allows for the grouping of objectsystem calls so that the os driver does not have to complete them independently, but instead can wait until several calls have been made before actually completing the operation. +To initialize this struct, the driver must: +- Provide a name (in `drv->Name`). +- Provide an array of supported root node types (in `drv->RootContentTypes`). +- Provide capability flags (in `drv->Capabilities`). +- Provide function pointers to implemented functions (see [II Interface](#ii-interface) for a list). -The 'Name' field should be filled in with a description of the OS driver, with a maximum length of 63 characters (plus the string null terminator). Normally, the 2-4 letter prefix of the driver is included at the beginning of 'Name', such as "UXD - UNIX filesystem driver". +#### Name +The `name` field is a 64 character buffer (allowing names up to 63 characters, with a null terminator). It usually follows the format of the driver abbreviation prefix (in all uppercase), followed by a dash, followed by a descriptive name for the driver. -Finally, the 'RootContentTypes' field is an XArray containing a list of strings, each of which specifies the node object types that the driver will handle. Such types are added to this XArray using the normal XArray utility functions, such as: +For example: ```c - xaInit(&drv->RootContentTypes, 16); - xaAddItem(&drv->RootContentTypes, "system/file"); - xaAddItem(&drv->RootContentTypes, "system/directory"); +if (strcpy(drv->Name, "SYBD - Sybase Database Driver") == NULL) goto error_handling; ``` -When the structure has been filled out, the os driver should call the OSML to register itself, using the objRegisterDriver function: +#### RootContentTypes +The `RootContentTypes` field is an XArray containing a list of strings, representing the type names that the driver can open. This should only include types the driver will handle as root nodes, not other objects created by the driver. Thus, the sybase driver would include `"application/sybase"`, but not `"system/table"`. +For example: ```c - objRegisterDriver(drv); +if (xaInit(&(drv->RootContentTypes), 2) != 0) goto error_handling; +if (xaAddItem(&(drv->RootContentTypes), "application/sybase") < 0) goto error_handling; +if (xaAddItem(&(drv->RootContentTypes), ""system/query"") < 0) goto error_handling; ``` -The initialization function should return 0 to indicate success, or -1 on failure. Currently, initialization success/failure is not verified by lsmain.c. +- 📖 **Note**: To make a specific file extension (like `.qy`) open in a driver, edit `types.cfg` to map that file extension to an available root content type supported by the driver (such as `"system/query"`). -The driver should NOT nmFree() the allocated driver structure unless the objRegisterDriver() routine fails (returns -1). +#### Capabilities +The capabilities field is a bitmask which can contain zero or more of the following flags: -Note that the RootContentTypes handled by the driver should only include the types of the objects this driver will handle as node objects. For instance, the Sybase database access driver uses "application/sybase" as its top level type. It won't register such things as "system/table". +- `OBJDRV_C_FULLQUERY`: Indicates that this objectsystem driver will intelligently process the query's expression tree specified in the OpenQuery call, and will only return objects that match that expression. If this flag is missing, the OSML will filter objects returned by QueryFetch so that the calling user does not get objects that do not match the query. Typically this is set by database server drivers. + - > **THE ABOVE IS OUT-OF-DATE** (May 16th, 2022): A driver can now determine whether to handle the Where and OrderBy on a per-query basis, by setting values in the ObjQuery structure used when opening a new query. This allows a because a driver to handle Where and OrderBy for some object listings but not others. -### B. Opening And Closing Objects -As an overview, the normal procedure for the open routine to follow is this: +- `OBJDRV_C_TRANS`: Indicates that this objectsystem driver requires transaction management by the OSML's transaction layer (the OXT layer). OS drivers that require this normally are those that for some reason cannot complete operations in independence from one another. For example, with a database driver, the creation of a new row object and the setting of its attributes must be done as one operation, although the operation requires several calls from the end user's process. The OXT allows for the grouping of objectsystem calls so that the os driver does not have to complete them independently, but instead can wait until several calls have been made before actually completing the operation. -1. Access the node object, or create it, depending on whether the object already exists as well as the open mode flags indicated by the end-user. -2. Upon successful node object access, determine what additional components of the pathname are to be handled by this driver, and verify that they can be opened, depending on the object's open mode (CREAT, EXCL, etc.) -3. If it hasn't been already, allocate a structure that will represent this open object and contain information about it and how we're to handle it. It should include a pointer to the node object. -4. Perform any operations inherent in the open process that have not already been performed (such as reading database table information, etc., when a db table's row is being accessed). -5. Return a pointer to the structure allocated in (3) as a void pointer. The OSML will pass this pointer back to the driver on subsequent calls that involve this object. +#### Registering the Driver Struct +When all values within the structure have been initialized, the driver should call the OSML to register itself, using the `objRegisterDriver()` function: -The first basic part of the OS driver consists of the Open and Close routines, normally named 'xxxOpen' and 'xxxClose' within the driver, where 'xxx' is the driver's prefix. The Close routine is normally fairly simple, but the Open routine is one of the most complicated routines in a typical OS driver, for the Open routine must parse the subtree pathname beneath the node object. For example, if the node object had a pathname like: - -```sh - /datasources/OMSS_DB +```c +if (objRegisterDriver(drv) != 0) goto error_handling; ``` -and the user opened an object called: -```sh - /datasources/OMSS_DB/JNetHelp/rows/1 +--- +### Function: Open() +```c +void* xxxOpen(pObject parent, int mask, pContentType sys_type, char* usr_type, pObjTrxTree* oxt); ``` -the OS driver would have to determine what the subtree pathname 'JNetHelp/rows/1' means, since this path will mean different things to different os drivers. - -The Open routine also must determine whether the object already exists or not, and if not, whether to create a new object. This logic is largely dependent on the `obj->Mode` flags, as if `O_CREAT` is included, the driver must attempt to create the object if it does not already exist, and if `O_EXCL` is included, the driver must refuse to open the object if it already exists, as with the UNIX `open()` system call semantics. +The `Open()` function opens a given file to create a new driver instance. This procedure normally includes the following steps: -Finally, if the os driver specified a capability of `OBJDRV_C_TRANS`, it must pay attention to the current state of the end-user's transaction. If a new object is being created, an object is being deleted, or other modifications/additions are being performed, and if the OXT layer indicates a transaction is in process, the driver must either complete the current transaction and then complete the current call, or else add the current delete/create/modify call to the transaction tree (in which case the tree item is preallocated; all the driver needs to do is fill it in). The transaction layer will be discussed in depth later in this document. +1. Access or create the node object, depending on specified flags and whether or not it already exists. +2. Parse additional contents of the path after the root node. +3. Allocate a structure that will represent the open object, including a pointer to the node object. +4. Perform other opening operations (such as reading database table information, etc., when a db table's row is being accessed). +5. Return a pointer to the node instance as a void pointer. This pointer will be passed as `void* inf_v` to the driver in subsequent calls involving this object (except the Query functions, discussed below). -As a part of the Open process, the OS driver will normally allocate an internal structure to represent the current open object, and will return that structure as a `void*` data type in the return value. This pointer will be then passed to each of the other driver entry point functions, with the exception of QueryFetch, QueryDelete, and Query- Close, which will be discussed later. +- 📖 **Note - Transactions**: If the os driver specified the `OBJDRV_C_TRANS` capability, it must respect the current state of the user's transaction. If a new object is being created, an object is being deleted, or other modifications/additions are being performed, and if the OXT layer indicates a transaction is in process, the driver must either complete the current transaction and then complete the current call, or else add the current delete/create/modify call to the transaction tree (in which case the tree item is preallocated; all the driver needs to do is fill it in). This is handled using the transaction tree parameter (`oxt : pObjTrxTree*`). The transaction later is discussed in depth in the ??? section. + -The Open() routine is called with five parameters: +#### Accessing the Node Object +If `O_CREAT` and `O_EXCL` are both specified in `parent->Mode`, the driver should **only** create a new file and fail if the file already exists (refusing to open and read it). Otherwise, the driver should read an existing file, or create one if it does not exist and `O_CREAT` is specified, failing if no file can be read or created. -- `obj` (pObject) - This is a pointer to the Object sturcture maintained by the OSML. This structure will contain some important fields for processing the open() request. +#### Parsing Path Contents +The task of parsing the provided path into the subtree beneath its root node is one of the more complex operations for a driver. For example, the path to a driver's root node might be `/datasources/OMSS_DB` and the user opens an object called `/datasources/OMSS_DB/JNetHelp/rows/1`. In this case, the OS driver must parse the meaning of the subtree path `JNetHelp/rows/1`, storing the data targetted by the user into the driver instance to allow later method calls to access the correct data. - - `obj->Mode` is a bitmask of the O_* flags, which include `O_RDONLY`, `O_WRONLY`, `O_RDWR`, `O_CREAT`, `O_TRUNC`, and `O_EXCL`. +#### Parameters +The `Open()` routine is called with five parameters: - - `obj->Pathname` is a Pathname structure which contains the complete parsed pathname for the object. This structure is defined in the file `include/obj.h`, and has a buffer for the pathname as well as an array of pointers to the pathname's components. The function `obj_internal_PathPart()` can be used to obtain at will any component or series of components of the pathname. +- `obj : pObject`: A pointer to the Object structure maintained by the OSML. This structure includes some useful fields: + + - `obj->Mode : int`: A bitmask of the O_* flags, which include: `O_RDONLY` (read only), `O_WRONLY` (write only), `O_RDWR` (read/write), `O_CREAT` (create), `O_TRUNC` (truncate), and `O_EXCL` (exclusive, see above). + + - `obj->Pathname : pPathname`: A pointer to a Pathname struct (defined in `include/obj.h`) which contains the complete parsed pathname for the object. This provides a buffer for the pathname as well as an array of pointers to the pathname's components. The function `obj_internal_PathPart()` can be used to obtain at will any component or series of components of the pathname. - - `obj->Pathname->OpenCtl[]` contains parameters to the open() operation. Frequently these params provide additional information on how to open the object. The use of these parameters is determined by the author of the objectsystem driver. The parameters are those passed in normal URL fasion (?param=value, etc.). Typically, the only OpenCtl of interest is going to be `obj->Pathname->OpenCtl[obj->SubPtr]` (see below for SubPtr meaning). + - `obj->Pathname->OpenCtl : pStruct[]`: Parameters for the open() operation, as defined by the driver author. These are specified in the path in a similar way to URLs (`example.qy?param1=value¶m2=other_value`). Drivers typically only use `obj->Pathname->OpenCtl[obj->SubPtr]` (see SubPtr below) to retrieve their own parameters, ignoring parameters passed to other drivers in the path. - - `obj->SubPtr` is the number of components in the path that are a part of the node object's path. For example, in the above path of '/datasources/OMSS_DB', the path would be internally represented as './datasources/ OMSS_DB', and the SubPtr would be 3. + - `obj->SubPtr : short`: The number of components in the path that are a part of the path to the root node object, including the `.` for the top level directory. For example, in the above path of `/data/file.csv`, the path would be internally represented as `./ data/ file.csv`, so SubPtr is 3. - - `obj->SubCnt` reflects the number of components of the path which are under the control of the current driver. This includes the node object, so SubCnt will always be at least 1. For example, when opening '/data/file.csv/rows/1', and the driver in question is the CSV driver, SubPtr would be 3 (includes an "invisible" first component), from '/data/file.csv', and SubCnt would be 3, from 'file.csv/rows/1'. The driver will need to SET THE SUBCNT value in its Open function. SubPtr is already set. + - `obj->SubCnt : short`: _The driver should set this value_ to show the number of components it controls. This includes the root node object, so `SubCnt` will always be at least 1. For example, when opening `/data/file.csv/rows/1`, the CSV driver will read the `SubPtr` of 3 (see above), representing `./ data/ file.csv`. It will then set a `SubCnt` of 3, representing that it will control `file.csv /rows /1`. (The driver only sets `SubCnt`, `SubPtr` is provided.) - - `obj->Prev` is the underlying object as opened by the next-lower-level driver. It is the duty of this driver to parse the content of that object and do something meaningful with it. + - `obj->Prev : pObject`: The underlying object as opened by the next-lower-level driver. The file can be accessed and parsed by calling functions and passing this pointer to them (such as the st_parse functions, see below). **DO NOT attempt to open the file directly with a call like `fopen()`,** as this would require hard coding the path to the root directory of the object system, which *will* break if the code runs on another machine. - - `obj->Prev->Flags` contains some critical information about the underlying object. If it contains the flag `OBJ_F_CREATED`, then the underlying object was just created by this open() operation. In that case, this driver is expected to create the node with snNewNode() (see later in this document) as long as obj->Mode contains O_CREAT. + - `obj->Prev->Flags : short`: Contains some useful flags about the underlying object, such as: + - `OBJ_F_CREATED`: The underlying object was just created by this open() operation. In that case, this driver is expected to create the node with `snNewNode()` (see later in this document) as long as `obj->Mode` contains `O_CREAT`. + -- `mask` (int) - Indicates the security mask to be given to the object if it is being created. Typically, this will only apply to files and directories. The values are the same as UNIX chmod() type values. +- `mask : int`: The permission mask to be given to the object, if it is being created. Typically, this will only apply to files and directories, so most drivers can ignore it. The values are the same as the UNIX [octal digit permissions](https://en.wikipedia.org/wiki/Chmod#:~:text=Octal%20digit%20permission) used for the `chmod()` command. -- `systype` (pContentType) - This param indicates the content type of the node object as determined by the OSML. The ContentType structure is defined in include/ obj.h, and includes among other things the name of the content type. For example, for the reporting driver, this type would be "system/report". +- `sys_type : pContentType`: Indicates the content type of the node object as determined by the OSML. The ContentType structure is defined in `include/obj.h`. `sys_type->Name` lists the name of the content type (e.g. `"system/query"` for the query driver). + -- `usrtype` (char*) - This param is the requested object type by the user and is normally used when creating a new object, though under some circumstances it may change the way the open operates on an existing object. For example, the reporting driver can change whether it generates HTML report text or plaintext reports based on usrtype being either "text/html" or "text/plain". +- `usr_type : char*`: The object type requested by the user. This is normally used when creating a new object, though some drivers also use it when opening an existing object. For example, the reporting driver generates HTML report text or plaintext reports if `usr_type` is `"text/html"` or `"text/plain"` (respectively). -- `oxt` (pObjTrxTree*) - This param is only used by object drivers that specified a capability of OBJDRV_C_TRANS. More on this field later. For non-transaction-aware drivers, this field can be safely ignored. +- `oxt : pObjTrxTree*`: The transaction tree, used when the driver specifies the `OBJDRV_C_TRANS` capability. More on this field later. Non-transaction-aware drivers can safely ignore this field. + + 📖 **Note**: Yes, this param *is* a pointer to a pointer. Essentially, a pointer passed by reference. - Yes, this param *is* a pointer to a pointer. Essentially, a pointer passed by reference. -The Open routine should return its internal structure pointer on success, or `NULL` on failure. It is normal to allocate one such structure per Open call, and for the structure to point, among other things, to shared data describing the node object. Accessing the node object is described later in this document. +The `Open()` routine should return a pointer to an internal driver structure on success, or `NULL` on failure. It is normal to allocate one such structure per `Open()` call, and for one of the structure fields to point to shared data describing the node object. Accessing the node object is described later in this document. -It is important to know what kinds of fields normally are placed in the allocated data structure returned by Open. These fields are all determined by the driver author, but here are a few typical ones that are helpful to have ("inf" is the pointer to the structure here): +While driver instance structures may vary, some fields are common in most drivers (`inf` is the pointer to the structure here): | Field | Type | Description | ---------- | --------- | ------------ -| inf->Obj | pObject | This is a copy of the 'obj' pointer passed to the Open routine. -| inf->Mask | int | The 'mask' argument passed to Open. -| inf->Node | pSnNode | A pointer to the node object, as returned from snNewNode() or snReadNode(), or if structure files aren't being used as the node content type, a pointer to whatever structure contains information about the node object. +| inf->Obj | pObject | A copy of the `obj` pointer passed to `Open()`. +| inf->Mask | int | The `mask` argument passed to `Open()`. +| inf->Node | pSnNode | A pointer to the node object. This can come from `snNewNode()` or `snReadNode()` (for structure files), or other node struct information. + + +--- +### Function: OpenChild() +*(Optional)* +```c +void* xxxOpenChild(void* inf_v, pObject obj, char* child_name, int mask, pContentType sys_type, char* usr_type, pObjTrxTree* oxt); +``` +**No documentation provided.** + +--- +### Function: Close() +```c +int xxxClose(void* inf_v, pObjTrxTree* oxt); +``` +The close function closes a driver instance, freeing all allocated data and releasing all shared memory such as open connections, files, or other driver instances. The driver must ensure that all memory allocated by originally opening the object (or allocated by other functions that may be called on an open object) is properly deallocated. This includes the internal structure returned by `Open()`, or by `QueryFetch()`, which is passed in as `inf_v`. The driver may also need to decrement the Open Count (`node->OpenCnt--`) if it had to increment this value during `Open()`. Before doing so, it should also perform a `snWriteNode()` to write any modified node information to the node object. -The Close() routine is called with two parameters: +- 📖 **Note**: Remember that the passed driver instance may originally be from a call to `Open()` or a call to `QueryFetch()`. + +- 📖 **Note**: Even if close fails, the object should still be closed in whatever way is possible. The end-user should deal with the resulting situation by reviewing the `mssError()` messages left by the driver. + +- 📖 **Note**: Information may be left unfreed if it is stored in a cache for later use. + +The `Close()` routine is called with two parameters: | Param | Type | Description | ------ | ------------ | ------------ -| inf_v | void* | This param is the pointer that the Open routine returned. Normally the driver will cast the void* parameter to some other structure pointer to access the object's information. -| oxt | pObjTrxTree* | The transaction tree pointer. - -The Close routine should return 0 on success or -1 on failure. The os driver must make sure it properly deallocates the memory used by originally opening the object, such as the internal structure returned by open and passed in as inf_v. +| inf_v | void* | A driver instance pointer (returned from `Open()` or `QueryFetch()`). +| oxt | pObjTrxTree* | The transaction tree pointer for the `OBJDRV_C_TRANS` capability. -Note the semantics of a Close failure - the object should still be closed in whatever way is still meaningful. The end-user must deal with the situation by reviewing the returned mssError messages. +The Close routine should return 0 on success or -1 on failure. -Before exiting, the Close routine should make sure it decrements the Open Count (node->OpenCnt--). Before doing so, it should also perform a snWriteNode() to write any modified node information back to the node object. -### C. Creating and Deleting Objects. -The Create and Delete functions are used for creating and deleting objects. Normally, the os driver will process the Pathname in the same manner for Create and Delete as for Open, thus such functionality could be placed in another function. +### Function: Create() +```c +int xxxCreate(pObject obj, int mask, pContentType sys_type, char* usr_type, pObjTrxTree* oxt); +``` +The `Create()` function is used to create a new object, and uses the same parameters and return value as `Open()` (documented in detail above). This often means adding a new file to the file system to represent the object. Many drivers do not implement this and recommend that driver end-users create files using a standard text editor or programatically using more general means, such as general structure file generation. If implemented, this function frequently requires very similar path parsing functionality to `Open()`. -As a side note, within Centrallix, the standard function naming convention is to use `xxx_internal_FunctionName()` for functions that are more or less internal to the module and not a part of any standard interface. +- 📖 **Note**: For many drivers, the `Create()` function calls the driver's `Open()` function with `O_CREAT`, then calls its `Close()` function, although some drivers may manage this differently. -The Create routine has parameters identical to the Open routine. It should return 0 on success and -1 on error. -The Delete routine is passed the following parameters: +### Function: Delete() +```c +int clusterDelete(pObject obj, pObjTrxTree* oxt); +``` +The `Delete()` function is used to delete an object, which often means removing a file from the file system. The Delete routine is passed the following parameters: | Param | Type | Description | ------ | ------------- | ------------ | obj | pObject | The Object structure pointer, used in the same way as in Open and Delete. -| oxt | pObjTrxTree* | The transaction tree pointer. +| oxt | pObjTrxTree* | The transaction tree pointer for the `OBJDRV_C_TRANS` capability. Delete should return 0 on success and -1 on failure. -For many objectsystem drivers, the Create function simply calls the driver's internal Open() with O_CREAT and then its internal Close, although some drivers could manage Create differently from Open. -### D. Reading and Writing Object Content. -Some, but not all, objects will have content. If the object does or can have content, the driver should handle these functions as is appropriate. Otherwise, the driver should return a failure code (-1) from these functions. +### Function: DeleteObj() +```c +int xxxDeleteObj(void* inf_v, pObjTrxTree* oxt); +``` +**No documentation provided.** + + +### Function: Read() +```c +int xxxRead(void* inf_v, char* buffer, int max_cnt, int offset, int flags, pObjTrxTree* oxt); +``` + + +The `Read()` function reads content from objects that have content, similar to reading content from a file. If the object does or can have content, the driver should handle these functions as is appropriate. Otherwise, the driver should return a failure code (-1) and call `mssError()` in these functions. -The Read routine reads content from the object, as if reading from a file. The parameters passed are almost identical to those used in the fdRead command in MTASK: +The parameters passed are intentionally similar to the `fdRead()` function in `mtask.c`: | Parameter | Type | Description | --------- | ------------- | ------------ -| inf_v | void* | The generic pointer to the structure returned from Open(). -| buffer | char* | The destination buffer for the data being read in. -| maxcnt | int | The maximum number of bytes to read into the buffer. -| flags | int | Either 0 or FD_U_SEEK, in which case the user is specifying the seek offset for the read in the 5th argument. Of course, not all objects will be seekable, and furthermore, some of the objects handled by the driver may have full or limited seek functionality, even though others may not. -| arg | int | Extra argument, currently only used to specify an optional seek offset. -| oxt | pObjTrxTree* | The transaction tree pointer. +| inf_v | void* | A driver instance pointer (returned from `Open()` or `QueryFetch()`). +| buffer | char* | The buffer where read data should be stored. +| max_cnt | int | The maximum number of bytes to read into the buffer. +| flags | int | Either `0` or `FD_U_SEEK`. If `FD_U_SEEK` is specified, the caller should specify a seek offset in the 5th argument (`arg`). +| arg | int | Extra argument, currently only used to specify the optional seek offset. +| oxt | pObjTrxTree* | The transaction tree pointer for the `OBJDRV_C_TRANS` capability. -The Write routine is very similar, except that instead of 'maxcnt', the third argument is 'cnt', and specifies how much data is in the buffer waiting to be written. +- 📖 **Note**: Not all objects can be seekable and some of the objects handled by the driver may have limited seek functionality, even if others do not. Each of these routines should return -1 on failure and return the number of bytes read/written on success. At end of file or on device hangup, 0 should be returned once, and then subsequent calls should return -1. -### E. Querying for Child Objects. -Many objects will have the capability of having sub-objects beneath them, called child objects. In such a case, the parent object becomes a directory of sorts, even though the parent object may also have content, something which is somewhat foreign in the standard filesystem world, but is common for web servers, where opening a directory returns the file 'index.html' on many occasions. -To enumerate a parent object's child objects, the query functions are used. A query may have a specific criteria so that only objects having certain attributes will be listed. As mentioned earlier in this document, a driver may or may not choose to intelligently handle those criteria. The driver has the option of always enumerating all child objects via its query functions, and allowing the OSML filter them and only return to the user the objects that match the criteria. But it also can do the filtering itself or, more typically, pass the filtering on to the source of the data the driver manages, as with a database server. +### Function: Write() +```c +int xxxWrite(void* inf_v, char* buffer, int cnt, int offset, int flags, pObjTrxTree* oxt); +``` + +The `Write()` function is very similar to the `Read()` function above, allowing the caller to write data to objects of supporting drivers with content. However, the third argument (`max_cnt`) is replaced with `cnt`, specifying the number of bytes of data in the buffer that should be written. -The query mechanism can also be used to delete a set of child objects, optionally matching a certain criteria. The QueryDelete method may be left NULL in the ObjDriver structure if the driver does not implement full query support, in which case the OSML will iterate through the query results and delete the objects one by one. -The first main function for handling queries is OpenQuery. This function is passed three arguments: +### Function: OpenQuery() +```c +void* xxxOpenQuery(void* inf_v, pObjQuery query, pObjTrxTree* oxt); +``` +The `OpenQuery()` function opens a new query instance struct for fetching query results from a specific driver instance. Queries are often used to enumerate an object's child objects, although this is not a requirement. Queries may include specific criteria, and the driver may decide to intelligently handle them (either manually or, more often, by passing them on to a lower level driver or database) or simply to enumerating all results with its query functions. In the latter case, the OSML layer will filter results and only return objects that match the criteria to the user. -- `inf_v` (void*) The value returned from Open for this object. +`OpenQuery()` is passed three parameters: +| Parameter | Type | Description +| --------- | ------------- | ------------ +| inf_v | void* | A driver instance pointer (returned from `Open()` or `QueryFetch()`). +| query | pObjQuery | A query structure created by the object system. +| oxt | pObjTrxTree* | The transaction tree pointer for the `OBJDRV_C_TRANS` capability. -- `query` (pObjQuery) The query structure setup by the OSML. It will contain several key fields: +The `query : pObjQuery` parameter contains several useful fields: +| Parameter | Type | Description +| --------------- | ----------------------- | ------------ +| query->QyText | char* | The text specifying the criteria (i.e., the WHERE clause, in Centrallix SQL syntax). +| query->Tree | void* (pExpression) | The compiled expression tree. This expression evaluates to a nonzero value for `true` if the where clause is satisfied, or zero for `false` if it is not. +| query->SortBy[] | void*[] (pExpression[]) | An array of expressions giving the various components of the sorting criteria. +| query->Flags | int | The driver should set and/or clear the `OBJ_QY_F_FULLQUERY` and `OBJ_QY_F_FULLSORT` flags, if needed. - - `query->QyText`: the text of the criteria (i.e., the WHERE clause, in Centrallix SQL syntax) +The `OBJ_QY_F_FULLQUERY` flag indicates that the driver will handle the full WHERE clause specified in `query->Tree`. - - `query->Tree`: the compiled expression tree, which evaluates to nonzero for true or zero for false as the WHERE clause condition. +The `OBJ_QY_F_FULLSORT` flag indicates that the driver will handle all sorting for the data specified in `query->SortBy[]`. - - `query->SortBy[]`: an array of expressions giving the various components of the sorting criteria. +If the driver can easily handle sorting/selection (as when querying an database), it should set these flags. Otherwise, it should let the OSML handle the ORDER BY and WHERE conditions to avoid unnecessary work for the driver author. - - `query->Flags`: the driver should set and/or clear the flags `OBJ_QY_F_FULLQUERY` and `OBJ_QY_F_FULLSORT` if need be. The former indicates that the driver is willing to handle the full WHERE clause (the query->Tree). The latter indicates that the driver is willing to handle the sorting of the data as well (in query->SortBy[]). If the driver can easily have the sorting/selection done (as when querying an RDBMS), it should set these flags. Otherwise, it should let the OSML take care of the ORDER BY and WHERE conditions. +The `OpenQuery()` function returns a `void*` for the query instance struct, which will be passed to the other query functions (`QueryDelete()`, `QueryFetch()`, and `QueryClose()`). This structure normally points to the driver instance struct to allow easy access to queried data. `OpenQuery()` returns `NULL` if the object does not support queries or if an error occurs, in which case `mssError()` should be called before returning. -- `oxt` (pObjTrxTree*) The transaction tree pointer. -The OpenQuery function should return a void* value, which will within the driver point to a structure used for managing the query. This structure will normally have a pointer to the inf_v value returned by Open as well, since inf_v is never passed to QueryFetch, QueryDelete or QueryClose. OpenQuery should return NULL if the object does not support queries or if some other error condition occurs that will prevent the execution of the query. +### Function: QueryDelete() +*(Optional)* +```c +int xxxQueryDelete(void* qy_v, pObjTrxTree* oxt); +``` + +Deletes results in the query result set, optionally matching a certain criteria. `QueryDelete()` is passed two parameters: -Once the query is underway with OpenQuery, the user will either start fetching the results with QueryFetch, or will issue a delete operation with QueryDelete. +| Parameter | Type | Description +| --------- | ------------- | ------------ +| qy_v | void* | A query instance pointer (returned from `QueryOpen()`). +| oxt | pObjTrxTree* | The transaction tree pointer for the `OBJDRV_C_TRANS` capability. -The QueryFetch routine should return an inf_v pointer to the child object, or NULL if no more child objects are to be returned by the query. Some drivers may be able to use their internal Open function to generate the newly opened object, although others will directly allocate the inf_v structure and fill it in based on the current queried child object. QueryFetch will be passed these parameters: +`QueryDelete()` returns 0 to indicate a successful deletion, or -1 to indicate failure, in which case `mssError()` should be called before returning. -| Parameter | Type | Description -| ---------- | -------------- | ------------ -| qy_v | void* | The value returned by OpenQuery. -| obj | pObject | The newly-created object structure that the OSML is using to track the newly queried child object. -| mode | int | The open mode for the new object, as with obj->Mode in Open(). -| oxt | pObjTrxTree* | The transaction tree pointer. +If a delete is needed and this method is not implemented, the OSML will iterate through the query results and delete the objects one by one. -All object drivers will need to add an element to the obj->Pathname structure to indicate the path to the child object being returned. This will involve a process somewhat like this: (given that new_name is the new object's name, qy is the current query structure, which contains a field 'Parent' that points to the inf_v originally returned by Open, and where the inf_v contains a field Obj that points to the Object structure containing a Pathname structure) +### Function: QueryFetch() ```c - int cnt; +void* xxxQueryFetch(void* qy_v, pObject obj, int mode, pObjTrxTree* oxt); +``` +The `QueryFetch()` function fetches a driver instance pointer (aka. an `inf_v` pointer) to a child object, or `NULL` if there are no more child objects. It may be helpful to think of `QueryFetch()` as similar to an alternate form of `Open()`, even if your driver does not implement the functionality to `Open()` every object that can be found with `QueryFetch()`. In fact, some drivers may use an internal `Open()` function to generate the opened objects. + +`QueryFetch()` takes four parameters: + +| Parameter | Type | Description +| ---------- | ------------- | ------------ +| qy_v | void* | A query instance struct (returned by `OpenQuery()`). +| obj | pObject | An object structure that the OSML uses to track the newly queried child object. +| mode | int | The open mode for the new object, the same as `obj->Mode` in `Open()`. +| oxt | pObjTrxTree* | The transaction tree pointer for the `OBJDRV_C_TRANS` capability. + + +The driver should add an element to the `obj->Pathname` structure to indicate the path of the returned child object. This will involve a process somewhat like this, where: +- `new_name : char*` is the new object's name. +- `qy : pMyDriversQueryInf` is the current query structure. +- `qy->Parent->Obj->Pathname : pPathname` points to the affected Pathname struct. + +```c + int count; pObject obj; char* new_name; pMyDriversQueryInf qy; - /** Build the filename. **/ - cnt = snprintf(obj->Pathname->Pathbuf, 256, "%s/%s", - qy->Parent->Obj->Pathname->Pathbuf,new_name); - if (cnt < 0 || cnt >= 256) return NULL; - obj->Pathname->Elements[obj->Pathname->nElements++] = - strrchr(obj->Pathname->Pathbuf,'/')+1; + /** Build the new filename. **/ + count = snprintf(obj->Pathname->Pathbuf, 256, "%s/%s", qy->Parent->Obj->Pathname->Pathbuf, new_name); + if (count < 0 || 256 <= count) return NULL; + obj->Pathname->Elements[obj->Pathname->nElements++] = strrchr(obj->Pathname->Pathbuf, '/') + 1; +``` + +### Function: QueryCreate() +```c +void* xxxQueryCreate(void* qy_v, pObject new_obj, char* name, int mode, int permission_mask, pObjTrxTree *oxt); ``` + +**No documentation provided.** + -QueryDelete is passed the qy_v void* parameter, and an oxt parameter. It should return 0 on successful deletion, and -1 on failure. +### Function: QueryClose() +```c +int xxxQueryClose(void* qy_v, pObjTrxTree* oxt); +``` +The close function closes a query instance, freeing all allocated data and releasing all shared memory such as open connections, files, or other driver instances. This function operates very similarly to `Close()`, documented in detail above. The query should be closed, whether or not `QueryFetch()` has been called enough times to enumerate all of the query results. -QueryClose is also passed qy_v and oxt. It should close the query, whether or not QueryFetch has been called enough times to enumerate all of the query results. -### F. Managing Object Attributes -All objects will have at least some attributes. Five attributes are mandatory: 'name', 'content_type', 'inner_type', 'outer_type', and 'annotation'. All compliant drivers must implement these five attributes, all of which have a data type of DATA_T_STRING. +### Object Attributes +All objects can have attributes, and there are five required attributes that all drivers must implement (explained below). Currently, the OS specification includes support for the following data types: -- DATA_T_INTEGER - 32-bit signed integer. -- DATA_T_STRING - Zero-terminated ASCII string. -- DATA_T_DOUBLE - Double-precision floating point. -- DATA_T_DATETIME - date/time structure. -- DATA_T_MONEY - money data type. +| Name | Description +| ----------------- | ------------ +| `DATA_T_INTEGER` | 32-bit signed integer. +| `DATA_T_STRING` | Null-terminated ASCII string. +| `DATA_T_DOUBLE` | Double-precision floating point number. +| `DATA_T_DATETIME` | Date/time structure. +| `DATA_T_MONEY` | Money structure. + +See `datatypes.h` for more information. + +For `true`/`false` or `on`/`off` attributes, use `DATA_T_INTEGER` where 0 indicates `false` and 1 indicates `true`. + +The following five attributes are required (all are of type `DATA_T_STRING`): + +| Attribute | Description +| ------------ | ------------ +| name | The name of the object, just as it appears in any directory listing. The name of the object must always be unique for its directory. +| annotation | A short description of the object. While users may not assign annotations to all objects, each object should be able to have an annotation. For example, in the Sybase driver, annotations for rows are created by assigning an 'expression' to the table in question, such as `first_name + last_name` for a people table. +| content_type | The type of the object's content, given as a MIME-type. Specify `"system/void"` if the object does not have content. +| inner_type | An alias for 'content_type'. Both should be supported. +| outer_type | This is the type of the object itself (the container). Specify `"system/row"` for objects that can be queried. + +The `last_modification : DATA_T_DATETIME` attribute is a sixth, optional attribute that may be useful in some situations. This attribute should indicate the last time that the object's content was modified or updated. + + + + +### Function: GetAttrType() +```c +int xxxGetAttrType(void* inf_v, char* attr_name, pObjTrxTree* oxt); +``` +The `GetAttrType()` function returns DATA_T_xxx value for the datatype of the requested. It takes three parameters: + +| Parameter | Type | Description +| --------- | ------------- | ------------ +| inf_v | void* | A driver instance pointer (returned from `Open()` or `QueryFetch()`). +| attr_name | char* | The name of the attribute to be queried. +| oxt | pObjTrxTree* | The transaction tree pointer for the `OBJDRV_C_TRANS` capability. + +This function should return `DATA_T_UNAVAILABLE` if the requested attribute does not exist on the driver instance. It should return -1 to indicate an error, in which case `mssError()` should be called before returning. + +For example, calling the following on any driver should return `DATA_T_STRING`. +```c +int datatype = driver->GetAttrType(inf_v, 'name', oxt); +``` + + +### Function: GetAttrValue() +```c +int xxxGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val, pObjTrxTree* oxt); +``` +The `GetAttrValue()` function takes four parameters: + +| Parameter | Type | Description +| --------- | ------------- | ------------ +| inf_v | void* | A driver instance pointer (returned from `Open()` or `QueryFetch()`). +| attr_name | char* | The name of the attribute to be queried. +| val | pObjData | A pointer to a location where the value of the attribute should be stored. +| oxt | pObjTrxTree* | The transaction tree pointer for the `OBJDRV_C_TRANS` capability. -True/false or on/off attributes should be treated as DATA_T_INTEGER for the time being with values of 0 and 1. +The value pointer should be handled in different ways, depending on the type: +- For `DATA_T_INTEGER` types, it is assumed to point to a 32-bit integer where the value should be written. +- For `DATA_T_STRING` types, it is assumed to point to an empty `char*` location where a pointer to a string should be written. +- For `DATA_T_DOUBLE` types, it is assumed to point to a double value where the double should be written. +- For `DATA_T_DATETIME` types, it is assumed to point to an empty `pDateTime` where a pointer to a date time struct (see `obj.h`) should be written. -Here is a description of the functionality of the five mandatory attributes: +In this way, integer and double values are returned by value, and string or datetime values are returned by reference. Items returned by reference are guaranteed to be valid until either the object is closed, or another call to `GetAttrValue()` or `SetAttrValue()` call is made on the same driver (which ever happens first). -| Attribute | Description -| -------------- | ------------ -| 'name' | This attribute indicates the name of the object, just as it should appear in any directory listing. The name of the object must be unique for the directory it is in. -| 'content_type' | This is the type of the object's content, given as a MIME-type. -| 'annotation' | This is an annotation for the object. While users may not assign annotations to all objects, each object should be able to have an annotation. Normally the annotation is a short description of what the object is. For the Sybase driver, annotations for rows are created by assigning an 'expression' to the table in question, such as 'first_name + last_name' for a people table. -| 'inner_type' | An alias for 'content_type'. Both should be supported. -| 'outer_type' | This is the type of the object itself (the container). +This function should return -1 on a non-existent attribute, 0 on success, and 1 if the value is `NULL` or undefined / unset. -A sixth attribute is not mandatory, but is useful if the object might have content that could in turn be a node object (be interpreted by another driver). This attribute is 'last_modification', of type DATA_T_DATETIME, and should indicate when the object's content was last updated or modified. +- 📖 **Note**: The caller of this function can use the POD(x) macro to typecast appropriate pointers to the pObjData pointer, passed to this function. The ObjData structure is a UNION type of structure, allowing easy manipulation of data of various types. See `datatypes.h` for more information. -The first function to be aware of is the GetAttrType function. This routine takes the inf_v pointer, the name of the attribute in question, and the oxt* pointer. It should return the DATA_T_xxx value for the data type of the attribute. +- 📖 **Note**: In legacy code, a typecasted void* was used instead of a pObjData pointer used today. This method was binary compatible the current solution because the pObjData is a pointer to a struct union. See `datatypes.h` for more information. -Next is the GetAttrValue function, which takes four parameters: the inf_v pointer, the name of the attribute, a void pointer pointing to where the attribute's value will be put, and the oxt* pointer. The way the value pointer is handled depends on the data type. For DATA_T_INTEGER types, the value pointer is assumed to be pointing to a 32-bit integer where the integer value can be written. For DATA_T_ STRING types, the value pointer is assumed to be pointing to an empty pointer location where a pointer to the string can be stored. For DATA_T_DATETIME types, the value pointer is assumed to be pointing to an empty pointer where a pointer to a date time structure (from obj.h) can be stored. And for double values, the value pointer points to a double value where the double will be stored. In this way, integer and double values are returned from GetAttrValue by value, and string or datetime values are returned from GetAttrValue by reference. Items returned by reference must be guaranteed to be valid until the object is closed, or another GetAttrValue or SetAttrValue call is made. This function should return -1 on a non-existent attribute, 0 on success, and 1 if the value is NULL or unset. -UPDATE ON GETATTR/SETATTR: These functions now, instead of taking a void* pointer for the value, take a pObjData pointer, which points to an ObjData structure. The POD(x) macro can be used to typecast appropriate pointers to a pObjData pointer. The ObjData structure is a UNION type of structure, allowing easy manipulation of data of various types. See 'datatypes.h'. Note that this is binary compatible with the old way of using a typecasted void pointer. +### Function: SetAttrValue() +```c +int xxxSetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val, pObjTrxTree* oxt); +``` +The `SetAttrValue()` function is the same as `GetAttrValue()`, however it sets the value by reading it from the `val` parameter instead of getting the value by writing it to the `val` parameter. The return value is also identical, and `mssError()` should be invoked on failure, or if setting attributes programatically is not implemented. -The SetAttrValue function works much the same way as GetAttrValue, just with the information moving in the opposite direction. The third parameter, void* value, is treated in the same manner. -The GetFirstAttr and GetNextAttr functions each take two parameters, the inf_v pointer and the oxt* pointer, and are used to iterate through the non-mandatory attributes for the object. GetFirstAttr should return a string naming the first attribute, and GetNextAttr should iterate through subsequent attributes. When the attributes are exhausted, these functions should return NULL. The attributes 'name', 'annotation', and 'content_type' should not be returned. If the object has no other attributes, GetFirstAttr should return NULL. +### Function: GetFirstAttr() & GetNextAttr() +```c +char* xxxGetFirstAttr(void* inf_v, pObjTrxTree* oxt); +char* xxxGetNextAttr(void* inf_v, pObjTrxTree* oxt); +``` +These functions return the names of attributes that can be queried on an object. They both take the same two parameters. -AddAttr is used to add a new attribute to an existing object. Not all objects support this, and many will refuse the operation. The parameters are as follows: void* inf_v, char* attrname, int type, void* value, and pObjTrxTree* oxt. +| Parameter | Type | Description +| --------- | ------------- | ------------ +| inf_v | void* | A driver instance pointer (returned from `Open()` or `QueryFetch()`). +| oxt | pObjTrxTree* | The transaction tree pointer for the `OBJDRV_C_TRANS` capability. + +These functions should only return the names of significant values, so `name`, `annotation`, etc. should not be returned from these functions, even though they are required to be valid values for any object. Typically, this is implemented by `GetFirstAttr()` resetting some internal value in the driver `inf_v`, then returning the result of `GetNextAttr()`. `GetNextAttr()` extracts a string from an array or other list of valid attribute names for the object and increments the internal counter. Once the attributes are exhausted, `GetNextAttr()` returns `NULL` and `GetFirstAttr()` can be used to restart and begin querying elements from the start of the list again. If an object has no significant attributes, `GetFirstAttr()` and `GetNextAttr()` both return NULL. -OpenAttr is used to open an attribute for objRead/objWrite as if it were an object with content. Not all object drivers will support this; this routine should return an inf_v pointer for the new descriptor, and takes four parameters: void* inf_v, char* attrname, int mode, and pObjTrxTree* oxt. The mode is used in the same manner as the Open function. -### G. Managing Object Methods -Objects may optionally have methods associated with them. Each method is given a unique name within the object, and can take a single string parameter. Three functions exist for managing methods. +### Function: AddAttr() +```c +int clusterAddAttr(void* inf_v, char* attr_name, int type, pObjData val, pObjTrxTree* oxt); +``` +The `AddAttr()` function adds a new attribute to an existing object. Not all objects support this, and many will refuse the operation. The parameters are the same as those of `GetAttrValue()` and `SetAttrValue()`, documented in detail above. + + +### Function: OpenAttr() +```c +void* clusterOpenAttr(void* inf_v, char* attr_name, int mode, pObjTrxTree* oxt); +``` +The `OpenAttr()` function is used to open an attribute for `objRead()`/`objWrite()` as if it were an object with content. Not all object drivers will support this, and many will refuse the operation. + +This function takes 4 parameters. `inf_v`, `attr_name`, and `oxt` are the same as they are for `GetAttrValue()` and `SetAttrValue()`. `mode` is the same as it is for `Open()`. This function should return an `inf_v` pointer for the new descriptor (similar to `Open()` and `QueryFetch()` above). + + +### Function: ExecuteMethod() +```c +int clusterExecuteMethod(void* inf_v, char* method_name, pObjData param, pObjTrxTree* oxt); +``` +The `ExecuteMethod()` function is used to execute a method on an object. This feature is rarely used, but some drivers have created methods for actions like dropping their cache or printing debug information. Each method has a unique name within that object, and can take a single string parameter. + +The `ExecuteMethod()` function takes four parameters: + +| Parameter | Type | Description +| ----------- | ------------- | ------------ +| inf_v | void* | A driver instance pointer (returned from `Open()` or `QueryFetch()`). +| method_name | char* | The name of the method to be executed. +| param | pObjData | A pointer to a location where the string value of the param is stored. +| oxt | pObjTrxTree* | The transaction tree pointer for the `OBJDRV_C_TRANS` capability. + +- 📖 **Note**: The `pObjData` type of the `param` parameter makes it possible that other types of parameters could be supported in the future, however, this is not currently implemented. + +The function returns 0 on success, and -1 to indicate an error, in which case `mssError()` should be called before returning. + + +### Function: GetFirstMethod() & GetNextMethod() +```c +char* xxxGetFirstMethod(void* inf_v, pObjTrxTree* oxt); +char* xxxGetNextMethod(void* inf_v, pObjTrxTree* oxt); +``` +These functions work the same as `GetFirstAttr()` and `GetNextAttr()` (respectively), except that they return the method names instead of the attribute names. + + +### Function: PresentationHints() +```c +pObjPresentationHints xxxPresentationHints(void* inf_v, char* attr_name, pObjTrxTree* oxt); +``` +The `PresentationHints()` function allows the caller to request extra information about a specific attribute on a specific driver instance object. Most of this information is intended to be used for displaying the attribute in a user interface, although it can also be useful for general data validation. As such, many drivers may not implement this function. + +The `PresentationHints()` function takes three parameters: + +| Parameter | Type | Description +| --------- | ------------- | ------------ +| inf_v | void* | A driver instance pointer (returned from `Open()` or `QueryFetch()`). +| attr_name | char* | The name of the requested attribute. +| oxt | pObjTrxTree* | The transaction tree pointer for the `OBJDRV_C_TRANS` capability. + +The returns a new pObjPresentationHints struct on success, or NULL to indicate an error, in which case `mssError()` should be called before returning. This struct should be allocated using `nmMalloc()`, and memset to zero, like this: +```c +pObjPresentationHints hints = nmMalloc(sizeof(ObjPresentationHints)); +if (hints == NULL) goto error_handling; +memset(hints, 0, sizeof(ObjPresentationHints)); +``` + +The return value, `hints : ObjPresentationHints`, contains the following useful fields which the function should set to give various useful information about the attribute. +- `hints->Constraint : void*`: An expression for determining if a value is valid. +- `hints->DefaultExpr : void*`: An expression defining the default value. +- `hints->MinValue : void*`: An expression defining the minimum valid value. +- `hints->MaxValue : void*`: An expression defining the maximum valid value. +- `hints->EnumList : XArray`: If the attribute is a string enum, this XArray lists the valid string values. +- `hints->EnumQuery : char*`: A query string which enumerates the valid values a string enum attribute. +- `hints->Format : char*`: presentation format - datetime or money +- `hints->AllowChars : char*`: An array of all valid characters for a string attribute, NULL to allow all characters. +- `hints->BadChars : char*`: An array of all invalid characters for a string attribute. +- `hints->Length : int`: The maximum length of data that can be included in a string attribute. +- `hints->VisualLength : int`: The length that the attribute should be displayed if it is show to the user. +- `hints->VisualLength2 : int`: The number of lines to use in a multi-line edit box for the attribute. +- `hints->BitmaskRO : unsigned int`: which bits, if any, in bitmask are read-only +- `hints->Style : int`: Style flags, documented below. +- `hints->StyleMask : int`: A mask for which style flags were set and which were left unset / undefined. +- `hints->GroupID : int`: Used to assign attributes to groups. Use -1 if the attribute is not in a group. +- `hints->GroupName : char*`: The name of the group to which this attribute belongs, or NULL if it is ungrouped or if the group is named elsewhere. +- `hints->OrderID : int`: Used to specify an attribute order. +- `hints->FriendlyName : char*`: Used to specify a "display name" for an attribute (e.g. `n_rows` might have a friendly name of `"Number of Rows"`). Should be `nmSysMalloc()`ed, often using `nmSysStrdup()`. + +- ⚠️ **Warning**: Behavior is undefined if: + - If a character is included in both `hints->AllowChars` and `hints->BadChars`. + - The data is longer than length. + +The `hints->Style` field can be set with several useful flags. To specify that a flag is not set (e.g. to specify explicitly that a field does allow `NULL`s), set the coresponding bit in the `hints->StyleMask` field while leaving the the bit in the `hints->Style` field set to 0. + +The following macros are provided for setting style flags: +- `OBJ_PH_STYLE_BITMASK`: The items in `hints->EnumList` or `hints->EnumQuery` are bitmasked. +- `OBJ_PH_STYLE_LIST`: List-style presentation should be used for the values of an enum attribute. +- `OBJ_PH_STYLE_BUTTONS`: Radio buttons or check boxes should be used for the presentation of enum attribute values. +- `OBJ_PH_STYLE_NOTNULL`: The attribute does not allow `NULL` values. +- `OBJ_PH_STYLE_STRNULL`: An empty string (`""`) should be treated as a `NULL` value. +- `OBJ_PH_STYLE_GROUPED`: The GroupID should be checked and so that fields can be grouped together. +- `OBJ_PH_STYLE_READONLY`: The user is not allowed to modify this attribute. +- `OBJ_PH_STYLE_HIDDEN`: This attribute should be hidden and not presented to the user. +- `OBJ_PH_STYLE_PASSWORD`: Values in this attribute should be hidden, such as for passwords. +- `OBJ_PH_STYLE_MULTILINE`: String values should allow multiline editting. +- `OBJ_PH_STYLE_HIGHLIGHT`: This attribute should be highlighted when presented to the user. +- `OBJ_PH_STYLE_LOWERCASE`: This attribute only allows lowercase characters. +- `OBJ_PH_STYLE_UPPERCASE`: This attribute only allows uppercase characters. +- `OBJ_PH_STYLE_TABPAGE`: Prefer the tab-page layout for grouped fields. +- `OBJ_PH_STYLE_SEPWINDOW`: Prefer separate windows for grouped fields. +- `OBJ_PH_STYLE_ALWAYSDEF`: Always reset the default value when this attribute is modified. +- `OBJ_PH_STYLE_CREATEONLY`: This attribute is writeable only when created, after that it is read only. +- `OBJ_PH_STYLE_MULTISEL`: Multiple select +- `OBJ_PH_STYLE_KEY`: This attribute is a primary key. +- `OBJ_PH_STYLE_APPLYCHG`: Presentation hints should be applied on DataChange instead of on DataModify. + + +### Function: Info() +```c +int xxxInfo(void* inf_v, pObjectInfo info); +``` +The `Info()` function allows the caller to request extra information about a specific driver instance object. It takes two parameters: + +| Parameter | Type | Description +| --------- | ------------- | ------------ +| inf_v | void* | A driver instance pointer (returned from `Open()` or `QueryFetch()`). +| info | pObjectInfo | A driver info struct allocated by the caller which the driver sets with information. + +The `pObjectInfo` struct has two fields: `Flags` and `nSubobjects`. This function should set `info->Flags` to 0 (to ensure no uninitialized noise gets into the data), then & it with all of the following flags that apply to that object. +- `OBJ_INFO_F_CAN_HAVE_SUBOBJ` / `OBJ_INFO_F_CANT_HAVE_SUBOBJ`: Indicates that the object can or cannot have subobjects. +- `OBJ_INFO_F_HAS_SUBOBJ` / `OBJ_INFO_F_NO_SUBOBJ`: Indicates that the object has or does not have subobjects. +- `OBJ_INFO_F_SUBOBJ_CNT_KNOWN`: Indicates that we know the number of subobjects. If set, the count should be stored in `info->nSubobjects`. +- `OBJ_INFO_F_CAN_HAVE_CONTENT` / `OBJ_INFO_F_CANT_HAVE_CONTENT`: Indicates that the object can or cannot have content (see `Read()` / `Write()`). +- `OBJ_INFO_F_HAS_CONTENT` / `OBJ_INFO_F_NO_CONTENT`: Indicates that this object does or does not have content (see `Read()` / `Write()`). +- `OBJ_INFO_F_CAN_SEEK_FULL`: Seeking is fully supported (both forwards and backwards) on the object. +- `OBJ_INFO_F_CAN_SEEK_REWIND`: Seeking is only supported with an offset of `0`. +- `OBJ_INFO_F_CANT_SEEK`: Seeking is not supported at all. +- `OBJ_INFO_F_CAN_ADD_ATTR` / `OBJ_INFO_F_CANT_ADD_ATTR`: Indicates that the object does or does not allow attributes to be added with the [AddAttr()](#function-addattr) function. +- `OBJ_INFO_F_SUPPORTS_INHERITANCE`: Indicates that the object supports inheritance through attributes such as `cx__inherit`. See ??? for more information about object inheritance. + +- `OBJ_INFO_F_FORCED_LEAF`: Indicates that the object is forced to be a 'leaf' unless ls__type used. +- `OBJ_INFO_F_TEMPORARY`: Indicates that this is a temporary object without a vaoid pathname. + + +The function returns 0 on success, and -1 to indicate an error, in which case `mssError()` should be called before returning. + + +### Function: Commit() +```c +int xxxCommit(void* inf_v, pObjTrxTree *oxt); +``` +**No documentation provided.** + + +### Function: GetQueryCoverageMask() +```c +int xxxGetQueryCoverageMask(pObjQuery this); +``` +**No documentation provided.** + + +### Function: GetQueryIdentityPath() +```c +int xxxGetQueryIdentityPath(pObjQuery this, char* pathbuf, int maxlen); +``` +**No documentation provided.** + -The first two functions, GetFirstMethod and GetNextMethod, work identically to their counterparts dealing with attributes. The third function, ExecuteMethod, starts a method executing. This function takes four parameters: the inf_v pointer, the name of the method, the optional string parameter, and the oxt* pointer. ## III Reading the Node Object -The Node object has content which controls what resource(s) this driver will actually access, so it is important for the driver to access the node object's content. If the driver's node objects are structure files (which is normally the case when dealing with a remote network resource), then the SN module can make opening the node object much more painless. It also performs caching automatically to improve performance. +A driver will commonly configure itself by reading text content from its node object file, at the root of its object subtree. This content may define what resource(s) a driver should provide, how it should access or compute them, and other similar information. Most drivers use the structure file format for their node objects because SN module makes parsing, reading, and writing these files easier. It also performs caching automatically to improve performance. -Note that the Node object will technically ALREADY BE OPEN as an object in the objectsystem. The OSML does that for you. If your driver will not use the SN/ST modules, then it should read the node object via the normal objRead() function, and write it via objWrite(). Your driver should NEVER objClose() the node object! The OSML does that for you. +- 📖 **Note**: The node object will **already be open** as an object in the ObjectSystem: The OSML does this for each driver. If a driver does not use the SN/ST modules, then it should read and write the node object directly with `objRead()` and `objWrite()`. A driver should **NEVER** `objClose()` the node object! The OSML handles that. -An objectsystem driver will commonly configure itself by reading a text file at the root of its object subtree. There are two main modules available for making this easier. +Although using the structure file format may be complex, it allows significant flexibility. Data is structured in hierarchies where each sub-object can have named attributes as well as sub-objects. Centrallix is filled with examples of this, including any `.qy`, `.app`, `.cmp`, or `.cluster` file. -The normal way to manage object parameters is to use a structure file. Structure files are a little more complicated, but allow for arrays of values for a given attribute name, as well as allowing for tree- structured hierarchies of attributes and values. Structure files are accessed via the stparse and st_node modules. The stparse module provides access to the individual attributes and groups of attributes, and the st_node module loads and saves the structure file heirarchies as a whole. The st_node module also provides node caching to reduce disk activity and eliminate repeated parsing of one file. +Structure files are accessed via the st_node (SN) and stparse (SP) modules. The st_node module loads and saves the structure file heirarchies as a whole. It also manages caching to reduce disk activity and eliminate repeated parsing of the same file. The stparse module provides access to the individual attributes and groups of attributes within a node structure file. -For example, if two sessions open two files, '/test1.rpt' and '/test2.rpt' the st_node (SN) module will cache the internal representations of these node object files, and for successive uses of these node objects, the physical file will not be re-parsed. The file will be re-parsed if its timestamp changes. +For example, if two sessions open two files, `/test1.rpt` and `/test2.rpt` the st_node module will cache the internal representations of these node object files, and for successive uses of these node objects, the physical file will not be re-parsed. The file will be re-parsed if its timestamp changes. + -If the underlying object does not support the attribute "last_modification" (assumed to be the timestamp), then SN prints a warning. In essence, this warning indicates that changes to the underlying object will not trigger the SN module to re-read the structure file defining the node object. Otherwise, the SN module keeps track of the timestamp, and if it changes, the node object is re-read and re-parsed. +If the underlying object does not support the attribute "last_modification" (assumed to be the timestamp), then st_node prints a warning. In essence, this warning indicates that changes to the underlying object will not trigger the st_node module to re-read the structure file defining the node object. Otherwise, the st_node module keeps track of the timestamp, and if it changes, the node object is re-read and re-parsed. -The driver's first course of action to obtain node object data is to open the node object with the SN module. The SN module's functions are listed below: +### Module: st_node +To obtain node object data, the driver should first open the node object with the st_node module. To use this module, include the file `st_node.h`, which provides the following functions (read `st_node.c` for more functions and additional information): -### pSnNode snReadNode(pObject obj) -This function reads a Structure File from the already-open node object which is passed in the "obj" parameter in the xxxOpen() routine. The "obj" parameter has an element, obj->Prev, which is a link to the node object as opened by the previous driver in the OSML's chain of drivers for handling this open(). All you need to know to get the parsed node object is the following: +### st_node: snReadNode() ```c - pSnNode node; +pSnNode snReadNode(pObject obj); +``` +The `snReadNode()` function reads a Structure File from the `obj` parameter, which should be a previously openned object. In a driver's `Open()` function, this is `obj->Prev` (the node object as opened by the previous driver in the OSML's chain of drivers). - node = snReadNode(obj->Prev); +**Usage:** +```c +pSnNode node = snReadNode(obj->Prev); +if (node == NULL) goto error_handling; ``` -The returned node structure is managed by the SN module and need not be nmFree()ed. The only thing that must be done is that the driver should increment the node structure's link count like this: +The returned node structure is managed by the SN module and does not need to be `nmFree()`ed. Instead, the driver should increment the node structure's link count for as long as it intends to use this structure, using `node->OpenCnt++;`. When the structure is no longer needed (e.g. when the driver instance is closed), the driver should decrement the link count. + + +### st_node: snNewNode() +```c +pSnNode snNewNode(pObject obj, char* content_type); +``` +The `snNewNode()` function creates a new node object of the given content type. The open link count should be incremented and decremented when appropriate, as with `snReadNode()`. +**Usage:** ```c - node->OpenCnt++; +pSnNode node = snNewNode(obj->Prev, "system/structure"); +if (node == NULL) goto error_handling; ``` -When closing an object (and thus releasing a reference to the Node structure), the driver should decrement the link count. +In this case, the new structure file will have the type: `"system/structure"`. + +- 📖 **Note**: This function only creates node object content, so the underlying object file must already exist. The OSML should do this for you because the previous driver (`obj->Prev`) creates the underlying object. -### pSnNode snNewNode(pObject obj, char* content_type) -This function creates a new node object with a given content type. The open link count should be incremented as appropriate, as before with snReadNode(). +### st_node: snWriteNode() ```c - pSnNode node; +int snWriteNode(pSnNode node); +``` +The `snWriteNode()` function writes a node's internal data back out to the node file, if the node's status (`node->Status`) is set to `SN_NS_DIRTY`. Otherwise, `snWriteNode()` does nothing. + - node = snNewNode(obj->Prev, "system/structure"); +### st_node: snDelete() +```c +int snDelete(pSnNode node); ``` +The `snDelete()` function deletes a node by removing the node's data from the internal node cache. -The "system/structure" argument is the type that will be assigned to the newly created node object. Note that the underlying object must already exist in order for this to create a node object as that object's content. Normally the OSML does this for you by commanding the previous driver (handling obj->Prev) to create the underlying object in question. +- 📖 **Note**: This does not actually delete the node file. -### int snWriteNode(pSnNode node) -This function writes a node's internal representation back out to the node file. The node's status (node->Status) should be set to SN_NS_DIRTY in order for the write to actually occur. Otherwise, snWriteNode() does nothing. -### int snDeleteNode(pSnNode node) -This function deletes a node file. At this point, does not actually delete the file but instead just removes the node's data structures from the internal node cache. +### st_node: snGetSerial() +```c +int snGetSerial(pSnNode node); +``` +The `snGetSerial()` function returns the serial number of the node. -### int snGetSerial(pSnNode node) -This function returns the serial number of the node. Each time the node is re-read because of modifications to the file or is written via snWriteNode because of modifications to the internal structure, the serial number is increased. This is a good way for a driver to refresh internal information that it caches should it determine a node object has changed. +Each time the node is re-read because of modifications to the node file or is written with because `snWriteNode()` was called after modifications to the internal structure, the serial number is increased. This is a good way for a driver to determine if the node file has changed so it can refresh internal cached data. -The stparse module is used to examine the parsed contents of the node file. A node file using the stparse module (and thus st_node module) has a structure file format; see StructureFile.txt. The file format is a tree structure with objects, subobjects, and attributes. The internal parsed representation is a tree, with each tree node being an object in the structure file, and each node having attributes, each of which is also a tree node. Thus, there are three different node types in the tree representation: the top-level ST_T_STRUCT element, which can contain subgroups and attributes; a mid-level ST_T_SUBGROUP tree node, which has a content type, name, and can contain attributes and other subgroups, and lastly a ST_T_ATTRIB node which contains an attribute name and attribute values, either integer or string, and optional lists of such up to 64 items in length. To use this module, include the file stparse.h. -The following functions are used to manage a parsed structure file: +### st_node: snGetLastModification() +```c +pDateTime snGetLastModification(pSnNode node); +``` +The `snGetLastModification()` function returns the date and time that a file was last modified. This pointer will remain valid as long as the passed `pSnNode` struct remains valid. It is managed by the `st_node` module, so the caller should not free the returned pointer. This function promises not to fail and return `NULL`. -### pStructInf stParseMsg(pFile inp_fd, int flags) -This function is internal-use-only and is used by the st_node module to parse a structure file. -### pStructInf stParseMsgGeneric(void* src, int (*read_fn)(), int flags) -This function is also internal-use-only (unless you want to parse the file manually without st_node's help) and is used to parse the structure file when the structure file isn't being read from an MTASK pFile descriptor. This is always the case, as the structure file data is being read from a pObject pointer. In such a case, src is the pObject pointer and read_fn is objRead(). +### Module: stparse +The stparse module is used to examine the parsed contents of the node file using the structure file format; see [StructureFile.txt](../centrallix-doc/StructureFile.txt). This format is a tree structure with node objects that can each have sub-objects and named attributes. Thus, stparse uses three distinct node types: +- `ST_T_STRUCT`: The top-level node, containing the subtrees and attributes in the file. +- `ST_T_SUBGROUP`: A mid-level type for subobjects within the top-level node. Each subgroup has a content type, name, and may contain attributes and other subgroups. +- `ST_T_ATTRIB`: A bottom-level type for each named attribute. Each attribute has a name and values, either of type integer or string, and optional lists of such up to 64 items in length. -### int stGenerateMsg(pFile out_fd, pStructInf info, int flags) -This function, also internal-use only, is used by the st_node module to write a structure file whose internal representation is given in the 'info' parameter. +To use this module, include the file `stparse.h`, which includes the following functions (read `stparse.c` for more functions and additional information): -### int stGenerateMsgGeneric(void* dst, int (*write_fn)(), pStructInf info, int flags) -This function is stParseMsgGeneric's converse. -### pStructInf stCreateStruct(char* name, char* type) -This function creates a new top-level tree item of type ST_T_STRUCT, with a given name and content-type. +### stparse: stStructType() +```c +int stStructType(pStructInf this); +``` +The `stStructType()` function returns the struct type of the past `pStructInf` parameter, which is either `ST_T_ATTRIB` or `ST_T_SUBGROUP` (see above). -### pStructInf stAddAttr(pStructInf inf, char* name) -This function adds a node of type ST_T_ATTRIB to either a ST_T_STRUCT or ST_T_SUBGROUP type of node, with a given name and no values associated with that name (see AddValue, below). The new attribute tree node is linked under the 'inf' node passed, and is returned. +- ⚠️ **Warning**: The root node of type `ST_T_STRUCT` will return `ST_T_SUBGROUP` from this function. If you wish to avoid this, read `inf->Type` (see [stparse: Using Fields Directly](#stparse-using-fields-directly) for more info). It is unclear whether this behavior is a bug or a feature. I've decided to call it a feature! ;) -### pStructInf stAddGroup(pStructInf inf, char* name, char* type) -This function adds a node of type ST_T_SUBGROUP to either a ST_T_SUBGROUP or ST_T_STRUCT tree node, with a given name and content type (content type such as 'report/query'). -### int stAddValue(pStructInf inf, char* strval, int intval) -This function adds a value to an attribute, and can be called multiple times on an attribute to add a list of values. If 'strval' is not null, a string value is added, otherwise an integer value is added. The string is NOT copied, but is simply pointed-to. If the string is non-static, and has a lifetime less than the ST_T_ATTRIB tree node, then the following procedure must be used: +### stparse: stLookup() +```c +pStructInf stLookup(pStructInf inf, char* name); +``` +The `stLookup()` function searches all sub-tree nodes for a group or attribute of the given name and returns a pointer to it or returns `NULL` if no group or attribute was found. + +### stparse: stAttrValue() ```c - char* ptr; - char* nptr; - pStructInf attr_inf; +int stAttrValue(pStructInf inf, int* intval, char** strval, int nval); +``` +This function gets the value of the given attribute in an `ST_T_ATTRIB` node. If the value is an integer, the caller should pass a pointer to an integer where it can be stored. If the value is a string, the caller should pass a pointer to string (aka. a `char*`) where char* for the string can be stored. The unused alternate pointer must be left `NULL`. `nval` can normally be 0, but if the attribute has several values, setting nval to 1, 2, 3, etc., returns the 2nd, 3rd, 4th item, respectively. + +This function returns -1 if the attribute value did not exist, if the wrong type was requested, or if 'inf' was `NULL`. + +It is common practice to use `stLookup()` and `stAttrValue()` or `stGetExpression()` (see below) together to retrieve values, for example (where `inf` is a `pStructInfo` variable from somewhere): - attr_inf = stAddAttr(my_parent_inf, "myattr"); - nptr = (char*)malloc(strlen(ptr)+1); - if (!nptr) go_report_the_error_and_return; - strcpy(nptr, ptr); - stAddValue(attr_inf, nptr, 0); - attr_inf->StrAlloc[0] = 1; +```c +char* ptr; +if (stAttrValue(stLookup(inf, "my_attr"), NULL, &ptr, 0) != 0) + goto error_handling; +printf("The value is: %s\n", ptr); ``` -By following this method (making a copy of the string and then setting the StrAlloc value for that string), when the StructInf tree node is freed by the stparse module, the string will auto- matically be freed as well. -### pStructInf stLookup(pStructInf inf, char* name) -This routine examines all sub-tree-nodes, both group and attribute nodes, for a group or attribute with the given name. If it finds one, it returns a pointer to the sub-node, otherwise NULL. +### stparse: stGetExpression() +```c +pExpression stGetExpression(pStructInf this, int nval); +``` +Returns a pointer to an expression that represents the value of the nval-th element of the given struct. -### int stAttrValue(pStructInf inf, int* intval, char** strval, int nval) -This function returns the value of the given attribute in an ST_T_ATTRIB tree node. If a string value is being returned, pass a pointer to the string pointer. If an integer value is being returned, pass a pointer to an integer. The pointer not being used must be left NULL. 'nval' can normally be 0, but if the attribute has several values, setting nval to 1,2,3, etc., returns the 2nd, 3rd, 4th item, respectively. This routing returns -1 if the attribute value did not exist or if the wrong type was requested. It also returns -1 if 'inf' was NULL. -It is common practice to use the stLookup and stAttrValue functions together to retrieve values, and search for an attribute StructInf and retrieve its value in one operation: +### stparse: stCreateStruct() +```c +pStructInf stCreateStruct(char* name, char* type); +``` +This function creates a new top-level tree item of type `ST_T_STRUCT`, with a given name and content-type. + +### stparse: stAddAttr() ```c - pStructInf inf; - char* ptr; +pStructInf stAddAttr(pStructInf inf, char* name); +``` +This function adds a node of type `ST_T_ATTRIB` to either an `ST_T_STRUCT` or an `ST_T_SUBGROUP` type of node, with a given name and no values (see AddValue, below). The new attribute tree node is linked under the `inf` node passed, and is returned. - if (stAttrValue(stLookup(inf, "myattr"),NULL,&ptr,0) == 0) - { - printf("%s is the value\n", ptr); - } + +### stparse: stAddGroup() +```c +pStructInf stAddGroup(pStructInf inf, char* name, char* type); ``` +This function adds a node of type `ST_T_SUBGROUP` to either an `ST_T_SUBGROUP` or an `ST_T_STRUCT` tree node, with a given name and content type (content type such as `"report/query"`). -### int stFreeInf(pStructInf this) -This function is used to free a StructInf tree node. It will free any sub-nodes first, so if that is not desired, be sure to disconnect them by removing them from the SubInf array and appropriately adjusting the nSubInf counter, and setting the SubInf array position to NULL. This function also disconnects the tree node from its parent, if any, so if the parent is already free()'d, be sure to set the node's Parent pointer to NULL. Any strings marked allocated with the StrAlloc flags will be free()'d. -It is also common practice to bypass the stXxx() functions entirely and access the elements of the StructInf structures themselves. This is not forbidden, and may be done. See the file stparse.h for a description of the structure. For example, +### stparse: stAddValue() +```c +int stAddValue(pStructInf inf, char* strval, int intval); +``` +This function adds a value to an attribute, and can be called multiple times on an attribute to add a list of values. If `strval` is not null, a string value is added, otherwise an integer value is added. The string is NOT copied, but is simply pointed-to. If the string is non-static, and has a lifetime less than the `ST_T_ATTRIB` tree node, then the following procedure should be used, where `str` is the string pointer to the string: ```c - pStructInf inf; - int i; +pStructInf attr_inf = stAddAttr(my_parent_inf, "my_attr"); +if (attr_inf == NULL) goto error_handling; + +char* new_str = (char*)malloc(strlen(str) + 1lu); +if (new_str == NULL) goto error_handling; +strcpy(new_str, str); +stAddValue(attr_inf, new_str, 0); +attr_inf->StrAlloc[0] = 1; +``` - for(i=0;inSubInf;i++) - { - if (inf->SubInf[i]->Type == ST_T_ATTRIB) - { - /** do stuff with attribute... **/ - } - } +With this method (making a copy of the string and then setting the StrAlloc value for that string), the string is automatically freed when the StructInf tree node is freed by the stparse module. + + +### stparse: stFreeInf() +```c +int stFreeInf(pStructInf this); ``` +This function is used to free a `StructInf` tree node. This also recursively frees sub-tree nodes, so these should be disconnected before calling if they are still needed. To do this, remove them from the SubInf array by appropriately adjusting the nSubInf counter and setting the SubInf array position to `NULL`. This function also disconnects the tree node from its parent, if any, so if the parent is already `free()`'d, prevent this behavior by setting the node's Parent pointer to `NULL` before calling this function. Any strings marked allocated with the StrAlloc flags will also be `free()`'d by this function, so update that flag if necessary. + + +### stparse: Using Fields Directly +It is also common practice to bypass the stparse functions entirely and access the elements of the `StructInf` struct directly, which is allowed. (See `stparse.h` for more information about this structure.) + +For example (assuming `inf` is a `pStructInfo` variable in scope): +```c +for (unsigned int i = 0u; i < inf->nSubInf; i++) + { + switch (inf->SubInf[i]->Type) + { + case ST_T_ATTRIB: + /** Do stuff with attribute... **/ + break; + + case ST_T_SUBGROUP: + /** Do stuff with group... **/ + break; + + ... + } + } +``` + + ## IV Memory Management in Centrallix -Centrallix has its own memory manager that caches freshly-deallocated blocks of memory in lists according to size so that they can be quickly reallocated. This memory manager also catches double-freeing of blocks, making debugging of memory problems a little easier. + +Centrallix has its own memory management wrapper that caches deallocated blocks of memory by size to allow for faster reuse. This wrapper also detects double-freeing of blocks (sometimes), making debugging of memory problems just a little bit easier. + +In addition, the memory manager provides statistics on the hit ratio of allocated blocks coming from the lists vs. `malloc()`, and on how many blocks of each size/type are `malloc()`ed and cached. This information can be helpful for tracking down memory leaks. Empirical testing has shown an increase of performance of around 50% or more in programs with the newmalloc module in use. -In addition the memory manager provides statistics on the hit ratio of allocated blocks coming from the lists vs. malloc(), and information on how many blocks of each size/type are allocated out and cached. This information can be invaluable in tracking down memory leaks. +One caveat is that this memory manager does not provide `nmRealloc()` function, only `nmMalloc()` and `nmFree()`. Thus, either `malloc()`, `free()`, and `realloc()` or `nmSysMalloc()`, `nmSysFree()`, and `nmSysRealloc()` should be used for blocks of memory that might vary in size. -One caveat is that this memory manager does not provide a realloc() function, so the standard malloc(), free(), and realloc() must be used for blocks of memory that might grow in size. This memory manager is also perhaps not the best to use for blocks of memory of arbitrary sizes, but rather is best for allocating structures quickly that are of a specific size and belong to specific objects, such as the StructInf structure or the SnNode structure, and others. In short, use it for structures, but not for strings. +- 📖 **Note**: This memory manager is usually the wrong choice for blocks of memory of arbitrary sizes. It is intended for allocating structures quickly that are of a specific size. For example, allocated space for a struct that is always the same size. + +- 🥱 **tl;dr**: Use `nmMalloc()` for structs, not for strings. + +- ⚠️ **Warning**: Calling `free()` on a block obtained from `nmMalloc()` or calling `nmFree()` on a block obtained from `malloc()` might not crash the program immediately. Instead, it will result in either inefficient use of the memory manager, or a significant memory leak, respectively. These practices will also lead to incorrect results from the statistics and block count mechanisms. -Empirical testing has shown an increase of performance of around 50% or more in programs with the newmalloc module in use. The following are the functions for the newmalloc module: -### void* nmMalloc(int size) -This function allocates a block of the given 'size'. It returns NULL if the memory could not be allocated. +### nmMalloc() +```c +void* nmMalloc(int size); +``` +This function allocates a block of the given `size`. It returns `NULL` if the memory could not be allocated. + + +### nmFree() +```c +void nmFree(void* ptr, int size); +``` +This function frees the block of memory. + +- ⚠️ **Warning**: The caller **must know the size of the block.** Getting this wrong is very bad!! For structures, this is trivial, simply use `sizeof()`, exactly the same as with `nmMalloc()`. + -### void nmFree(void* ptr, int size) -This function frees the block of memory. NOTE THAT THE CALLING FUNCTION MUST KNOW THE SIZE OF THE BLOCK. Getting this wrong is very bad. For structures, this is trivial, just use sizeof() just like with nmMalloc(). +### nmStats() +```c +void nmStats(void); +``` +Prints statistics about the memory manager, for debugging and optimizing. -### void nmStats() -Prints out statistics on how well the memory manager is doing. +For example: +``` +NewMalloc subsystem statistics: + nmMalloc: 0 calls, 0 hits (-nan%) + nmFree: 0 calls + bigblks: 0 too big, 0 largest size +``` -### void nmRegister(int size, char* name) -Registers a name with a block size. This allows the memory manager to be intelligent when reporting block allocation counts. The first argument is the size of the block, the second, an intelligent name for that size of block. A size can have more than one name. This function is optional and need not be used except when tracking down memory leaks, but can be used freely. + -Typically this function is called in a module's Initialize() function on each of the structures the module uses internally. -### void nmDebug() -Prints out a listing of block allocation counts, giving (by size): 1) number of blocks allocated but not yet freed, 2) number of blocks in the cache, 3) total allocations for this block size, and a list of names (from nmRegister()) for that block size. +### nmRegister() +```c +void nmRegister(int size, char* name); +``` +Registers an inteligent name with a block size. This allows the memory manager to be intelligent when reporting block allocation counts. A given size can have more than one name. This function is optional and not required for any production code to work, but using it can make tracking down memory leaks easier. -### void nmDeltas() -Prints a listing of all blocks whose allocation count has changed, and by how much, since the last nmDeltas() call. This function is VERY USEFUL FOR MEMORY LEAK DETECTIVE WORK. +This function is usually called in a module's `Initialize()` function on each of the structures the module uses internally. -### void* nmSysMalloc(int size) -Allocates memory without using the block-caching algorithm. This is roughly equivalent to malloc(), but pointers returned by malloc and this function are not compatible with each other - i.e., you cannot free() something that was nmSysMalloc'ed, nor can you nmSysFree() something that was malloc'ed. -This function is much better to use on variable-sized blocks of memory. nmMalloc is better for fixed-size blocks, such as for data structures. +### nmDebug() +```c +void nmDebug(void); +``` +Prints a listing of block allocation counts, giving (by size): +- The number of blocks allocated but not yet freed. +- The number of blocks in the cache. +- The total allocations for this block size. +- A list of names (from `nmRegister()`) for that block size. -### void nmSysFree(void* ptr) -Frees a block of memory allocated by nmSysMalloc, nmSysStrdup, or nmSysRealloc. -### void* nmSysRealloc(void* ptr, int newsize) -Changes the size of an allocated block of memory that was obtained via nmSysMalloc or nmSysRealloc or nmSysStrdup. The new pointer may be different if the block had to be moved. This is the rough equivalent of realloc(). Usage Note: If you are realloc'ing a block of memory, and need to store pointers to data somewhere inside the block, it is often better to store the offset rather than a full pointer, as a pointer would become invalid if a nmSysRealloc caused the block to move. +### nmDeltas() +```c +void nmDeltas(void); +``` +Prints a listing of all blocks whose allocation count has changed, and by how much, since the last `nmDeltas()` call. This function is VERY USEFUL FOR MEMORY LEAK DETECTIVE WORK. + + +### nmSysMalloc() +```c +void* nmSysMalloc(int size); +``` +Allocates memory without using the block-caching algorithm. This is roughly equivalent to `malloc()`, but pointers returned by malloc and this function are not compatible with each other - i.e., you cannot `free()` something that was `nmSysMalloc()`'ed, nor can you `nmSysFree()` something that was `malloc()`'ed. + +- 📖 **Note**: This function is much better to use on variable-sized blocks of memory. `nmMalloc()` is better for fixed-size blocks, such as for data structures. + + +### nmSysRealloc() +```c +void* nmSysRealloc(void* ptr, int newsize); +``` +Changes the size of an allocated block of memory that was obtained from `nmSysMalloc()`, `nmSysRealloc()`, or `nmSysStrdup()`. The new pointer may be different if the block has to be moved. This is the rough equivalent of `realloc()`. + +- 📖 **Note**: If you are `realloc()`'ing a block of memory and need to store pointers to data somewhere inside the block, it is often better to store an offset rather than a full pointer. This is because a full pointer becomes invalid if a `nmSysRealloc()` causes the block to move. + + +### nmSysStrdup() +```c +char* nmSysStrdup(const char* str); +``` +Allocates memory using `nmSysMalloc()` function and copies the string `str` into this memory. It is a rough equivalent of `strdup()`. The resulting pointer can be free'd using `nmSysFree()`. + + +### nmSysFree() +```c +void nmSysFree(void* ptr); +``` +Frees a block of memory allocated by `nmSysMalloc()`, `nmSysRealloc()`, or `nmSysStrdup()`. -### char* nmSysStrdup(const char* str) -Allocates memory for a copy of the string str by using the nmSysMalloc function, and then makes a copy of the string str. It is a rough equivalent of strdup(). The resulting pointer can be free'd using nmSysFree(). -Calling free() on a block obtained from nmMalloc() or calling nmFree() on a block obtained from malloc() will not crash the program. Instead, it will result in either inefficient use of the memory manager, or a huge memory leak, respectively. These practices will also render the statistics and block count mechanisms useless. ## V Other Utility Modules -There are many other utility modules useful in Centrallix. These include the xarray module, used for managing growable arrays; the xhash module, used for managing hash tables with no overflow problems and variable-length keys, the xstring module used for managing growable strings; the expression module used for compiling and evaluating expressions; and the mtsession module, used for managing session-level variables and reporting errors. + + +The Centrallix library (`centralllix-lib`) has a host of useful utility modules. These include `xarray`, used for managing growable arrays; `xstring`, used for managing growable strings; `xhash`, used for managing hash tables with no overflow problems and variable-length keys; `expression`, used for compiling and evaluating expressions; and `mtsession`, used for managing session-level variables and reporting errors. + ### A. XArray (XA) - Arrays The first is the xarray (XA) module. diff --git a/centrallix-sysdoc/string_comparison.md b/centrallix-sysdoc/string_comparison.md deleted file mode 100644 index dac13d544..000000000 --- a/centrallix-sysdoc/string_comparison.md +++ /dev/null @@ -1,101 +0,0 @@ -# String Comparison -The following sections discuss the two approaches to calculating similarity between two strings. Both approaches use a SQL function to calculate a similarity metric (on a scale of 0 to 1) for two string parameters. - -## Table of Contents -- [String Comparison](#string-comparison) - - [Table of Contents](#table-of-contents) - - [Levenshtein Similarity](#levenshtein-similarity) - - [Levenshtein](#levenshtein) - - [Cosine Similarity](#cosine-similarity) - - [CHAR_SET](#char_set) - - [Frequency Table](#frequency-table) - - [Relative Frequency Table](#relative-frequency-table) - - [TF-IDF](#tf-idf) - - [Dot Product](#dot-product) - - [Magnitude](#magnitude) - - [Similarity](#similarity) - - [Future Implementation](#future-implementation) - - [Inverse Document Frequency (IDF)](#inverse-document-frequency-idf) - -## Levenshtein Similarity -The [Levenshtein](https://en.wikipedia.org/wiki/Levenshtein_distance) distance is defined as the number of insertions, deletions, or substitutions required to make one string exactly like another string. - -### Levenshtein -```c -int exp_fn_levenshtein(pExpression tree, pParamObjects objlist, pExpression i0, pExpression i1, pExpression i2) -``` -Returns the levenshtein edit distance between two strings. - -```c -int exp_fn_fuzzy_compare(pExpression tree, pParamObjects objlist, pExpression i0, pExpression i1, pExpression i2) -``` -Returns a value between 0.0 (complete match) and 1.0 (complete difference) between strings a and b, based on the (levenshtein distance) / (max len of input strings). -Some alterations to the calculation are as follows: -- Matching an empty string against anything returns 0.5. -- A string that only required insertions to become the other string has its `(lev_dist)/(strlen)` value halved before returning. -- The parameter `max_field_width` is required, but not used. - -## Cosine Similarity - -The [Cosine Similarity](https://en.wikipedia.org/wiki/Cosine_similarity) function is defined as the dot product of two vectors divided by the product of the magnitude of the two vectors. We use the relative frequency of the individual characters within each term as the vectors in the calculation. The following functions are used to calculate cosine similarity. - -### CHAR_SET -```c -const char *CHAR_SET ... -``` -`CHAR_SET` represents all of the characters that should be considered during the calculation of similarity. `CHAR_SET` can be extended to include additional characters, as necessary. - -### Frequency Table - -```c -int exp_fn_i_frequency_table(double *table, char *term) -``` -Helper function for similarity(). Creates a frequency table containing indices corresponding to all characters in `CHAR_SET` (all other characters are ignored). The values in the frequency table will contain the number of times each character appers in `term`. - -The `table` parameter must be allocated prior to calling the function with `nmMalloc()` using `sizeof(x * sizeof(double))`, where `x` is the length of `CHAR_SET`. The function will initialize all `table` values to 0, before calculating the frequency values. - -### Relative Frequency Table -```c -int exp_fn_i_relative_frequency_table(double *frequency_table) -``` -Helper function for similarity(). Converts a frequency table into a relative frequency table, where each value in the `frequency_table` is converted to the percent of occurrence (i.e., frequency divided by the sum of total occurrences). - -The `frequency_table` parameter must have been created using the `exp_fn_i_frequency_table` function above. - -### TF-IDF -```c -int exp_fn_i_tf_idf_table(double *frequency_table) -``` -Helper function for similarity(). Creates a TF x IDF vector from a frequency table, where each value in the resulting table is created by multiplying the relative frequency of each letter by the corresponding coefficient in the IDF array. - -The `frequency_table` parameter must have been created using the `exp_fn_i_frequency_table` function above. - -### Dot Product - -```c -int exp_fn_i_dot_product(double *dot_product, double *r_freq_table1, double *r_freq_table2) -``` -Helper function for similarity(). Calculates the dot product of two relative frequency tables (sum of the squared values from each relative frequency table). - -The `dot_product` parameter should be initialized to 0 before calling the function. The table parameters must contain relative frequency tables that are generated from the `exp_fn_i_relative_frequency_table` function. The lengths of both tables must equal the length of `CHAR_SET`. - -### Magnitude - -```c -int exp_fn_i_magnitude(double *magnitude, double *r_freq_table) -``` -Helper function for similarity(). Calculates the magnitude of a relative frequency table (square root of the sum of the squared relative frequencies). - -The `magnitude` parameter should be initialized to 0 before calling the function. The table parameter must contain a relative frequency table that was generated from the `exp_fn_i_relative_frequency_table` function. The length of the frequency table must equal the length of `CHAR_SET`. - -### Similarity - -```c -int exp_fn_similarity(pExpression tree, pParamObjects objlist, pExpression i0, pExpression i1, pExpression i2) -``` -Returns a value between 0.0 (completely different) and 1.0 (complete match) reflecting the similarity between the value passed in to i0 and the value passed in to i1. The first two parameters should contain strings that need to be compared. If the value 1 is passed in the third parameter, then the similarity function will rely on TF x IDF scores to determine similarity. If no third parameter is passed, then the function will rely only on relative frequency scores. - -## Future Implementation - -### Inverse Document Frequency (IDF) -In text mining, the most common metric to use in the cosine similarity function is the [TF x IDF](https://en.wikipedia.org/wiki/Tf%E2%80%93idf) metric. Our approach uses only TF (term frequency). Inverse document frequency calculates a weighting factor for each character. This could increase precision a small amount by weighting characters that appear on many records as less important in distinguishing matches, and weighting characters that appear on only certain records as more important. IDF could be calculated by iterating through the entire partner dataset each time. The current approach uses the relative frequency of each letter used in the English language on [Wikipedia](https://en.wikipedia.org/wiki/Letter_frequency), which may not be consistent with the data in the partner database. diff --git a/centrallix-sysdoc/string_similarity.md b/centrallix-sysdoc/string_similarity.md index f466a057c..b9a3a28b6 100644 --- a/centrallix-sysdoc/string_similarity.md +++ b/centrallix-sysdoc/string_similarity.md @@ -49,7 +49,7 @@ ---> # String Similarity -The following sections discuss the approaches to calculating similarity between two strings which are implemented in the `clusters.c` library. This library can be incuded using `#include "clusters.h"` in centrallix-lib and `#include "cxlib/clusters.h"` in centrallix. +The following sections discuss the approaches to calculating similarity between two strings which are implemented in the `clusters.c` library. This library can be included using `#include "clusters.h"` in centrallix-lib and `#include "cxlib/clusters.h"` in centrallix. ## Table of Contents @@ -74,10 +74,10 @@ The following sections discuss the approaches to calculating similarity between ## Cosine Similarity -The [Cosine Similarity](https://en.wikipedia.org/wiki/Cosine_similarity) function is defined as the dot product of two vectors divided by the product of the magnitude of the two vectors. Conceptually, it's like finding the _angle_ between two vectors. To get these vectors, we use the relative frequency of character pairs within each string. To reduce memory cost and speed up computation, we store them in a special sparcely allocated form, described below. +The [Cosine Similarity](https://en.wikipedia.org/wiki/Cosine_similarity) function is defined as the dot product of two vectors divided by the product of the magnitude of the two vectors. Conceptually, it's like finding the _angle_ between two vectors. To get these vectors, we use the relative frequency of character pairs within each string. To reduce memory cost and speed up computation, we store them in a special sparsely allocated form, described below. ### Character Sets -Cosine compare currnetly uses the following character sets. These can be extended or modified later, if necessary. +Cosine compare currently uses the following character sets. These can be extended or modified later, if necessary. ```c const char ALLOW_SET[] = " \n\v\f\r!#$%&\"'()*+,-./:;<=>?@[]^_{|}~ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789"; const char CHAR_SET[] = "`abcdefghijklmnopqrstuvwxyz0123456789"; @@ -85,83 +85,86 @@ const char SIGNIFICANT_SET[] = "`ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstu const char IGNORE_SET[] = " \n\v\f\r!#$%&\"'()*+,-./:;<=>?@[]^_{|}"; const char BOUNDARY_CHAR = ('a' - 1); // aka. '`' ``` -- `ALLOW_SET` represents all characters which can be passed to a similarity detection algorithm. Passing other characters may cause warnings and errors, undefined or unintended behavior, and even security concerns. -- `CHAR_SET` represents all of the characters that will be uniquely considered during the calculation of similarity. Currently, this is all lowercase letters and numbers. -- `SIGNIFICANT_SET` represents all of the characters that are significant for the purposes of similarity. For example, the upercase letters are significant because they are considered identical to lowercase letters. Thus, they are included in the `SIGNIFICANT_SET`, but not in the `CHAR_SET`. -- `IGNORE_SET` represents characters which, while allowed to be passed to a similarity algorithm, will be ignored. For example, the strings "Ya!!" and "Ya..." will be considered identical. +- `ALLOW_SET` represents all characters which can be passed to a similarity detection algorithm. Passing other characters may cause warnings and errors, undefined or unintended behavior, and even security concerns. +- `CHAR_SET` represents all of the characters that will be uniquely considered during the calculation of similarity. Currently, this is all lowercase letters and numbers. +- `SIGNIFICANT_SET` represents all of the characters that are significant for the purposes of similarity. For example, the uppercase letters are significant because they are considered identical to lowercase letters. Thus, they are included in the `SIGNIFICANT_SET`, but not in the `CHAR_SET`. +- `IGNORE_SET` represents characters which, while allowed to be passed to a similarity algorithm, will be ignored. For example, the strings "Ya!!" and "Ya..." will be considered identical. - The `BOUNDARY_CHAR` is a special character which is conceptually added to the start and end of any string to be checked. - This allows for pairs that functionally include only the first and last character. - This character appears to have been selected to be one before the first character in `CHAR_SET` (thus convention dictates that it be written `'a' - 1` to indicate this), although it's unknown if that's the main or only reason. - If `clusters.h` is included, it can be accessed using the `CA_BOUNDARY_CHAR` macro. ### Character Pair Hashing -Even with a small set of ASCII characters (say 36), there are still `36^2 = 1296` possible character pairs. If the number of characters in the `CHAR_SET` ever needed to be expanded - for example, to include all UTF-8 characters - this number would quickly explode exponentially to utterly infeasible proportions. Thus, a hashing algorithm is employed to hash each character pair down to a more reasonable number of dimensions (which can be accessed with the `CA_NUM_DIMS` macro). +Even with a small set of ASCII characters (say 36), there are still `36^2 = 1296` possible character pairs. If the number of characters in the `CHAR_SET` ever needed to be expanded - for example, to include all UTF-8 characters - this number would quickly explode exponentially to utterly infeasible proportions. Thus, a hashing algorithm is employed to hash each character pair down to a more reasonable number of dimensions (which can be accessed with the `CA_NUM_DIMS` macro). ### String Vectors -Any string of characters in the `ALLOW_SET` can be represented by a vector. For simplicty, imagine this vector has only `5` dimensions. To find this vector, we hash each character pair in the string. As each character pair is hashed (for example, that the pair "ab" happens to hash to `3`), the corresponding dimension is increased by some amount. This amount varies to based on the characters in the pair, helping to mitigate the impact of collisions where different character pairs hash to identical numbers (a larger number of dimensions also helps to mitigate this). +Any string of characters in the `ALLOW_SET` can be represented by a vector. For simplicity, imagine this vector has only `5` dimensions. To find this vector, we hash each character pair in the string. As each character pair is hashed (for example, that the pair "ab" happens to hash to `3`), the corresponding dimension is increased by some amount. This amount varies to based on the characters in the pair, helping to mitigate the impact of collisions where different character pairs hash to identical numbers (a larger number of dimensions also helps to mitigate this). -Remember that the first and last characters form a pair with the `BOUNDARY_CHAR`, so the string "ab" has three pairs: "a", "ab", and "b". If these each hash to `2`, `3`, and `0`. Thus, the vector generated by the string "ab" might be: `[7, 0, 4, 3, 0]`. Notice that dimensions #1 and #4 are both `0` because no character pairs generated a hash of `1` or `4`. In real usecases, the vast majority of elements are `0`s because the number of dimensions used is much larger than the number of character pairs in a typical string. +Remember that the first and last characters form a pair with the `BOUNDARY_CHAR`, so the string "ab" has three pairs: "a", "ab", and "b". If these each hash to `2`, `3`, and `0`. Thus, the vector generated by the string "ab" might be: `[7, 0, 4, 3, 0]`. Notice that dimensions #1 and #4 are both `0` because no character pairs generated a hash of `1` or `4`. In real usecases, the vast majority of elements are `0`s because the number of dimensions used is much larger than the number of character pairs in a typical string. ### Sparse Vectors -As noted above, the vast majority of elements in a vector generated by a typical string are `0`s. This would lead to a large waste of memory and computation if every `0` was stored separately, so instead, vectors are stored sparsely. Because all hashes are positive integers, we represent `n` `0`s with a value of ` -n`. Thus, the vector `[0, 1, 0, 0, 0]` (representing an empty string in `5` dimensions) would be represented sparsely as `[-1, 1, -3]`. +As noted above, the vast majority of elements in a vector generated by a typical string are `0`s. This would lead to a large waste of memory and computation if every `0` was stored separately, so instead, vectors are stored sparsely. Because all hashes are positive integers, we represent `n` `0`s with a value of ` -n`. Thus, the vector `[0, 1, 0, 0, 0]` (representing an empty string in `5` dimensions) would be represented sparsely as `[-1, 1, -3]`. **Note**: A value of `0` in a sparse vector is undefined, so no element should be equal to `0`. -**Note**: Sparse arrays can vary greatly in length. To find their size, one needs to traverse the array until the total number of values found adds up to `CA_NUM_DIMS`. The `ca_sparse_len()` function can be used to do this. Also, the `ca_build_vector()` and `ca_free_vector()` use the `nmSys` functions from `newmalloc.h` to avoid conflicts over the size of the allocated data. +**Note**: Sparse arrays can vary greatly in length. To find their size, one needs to traverse the array until the total number of values found adds up to `CA_NUM_DIMS`. The `ca_sparse_len()` function can be used to do this. Also, the `ca_build_vector()` and `ca_free_vector()` use the `nmSys` functions from `newmalloc.h` to avoid conflicts over the size of the allocated data. ### Computing Similarity -Finally, to find the cosine similarity between two strings, we can simply take the [dot product](https://en.wikipedia.org/wiki/Dot_product) of their coresponding vectors. Then, we normalize the dot product by dividing by the magnitudes of both vectors multiplied together. Two strings can be compared this way using the `ca_cos_compare()` function. +Finally, to find the cosine similarity between two strings, we can simply take the [dot product](https://en.wikipedia.org/wiki/Dot_product) of their coresponding vectors. Then, we normalize the dot product by dividing by the magnitudes of both vectors multiplied together. Two strings can be compared this way using the `ca_cos_compare()` function. ## Levenshtein Similarity -The [Levenshtein](https://en.wikipedia.org/wiki/Levenshtein_distance) distance is defined as the number of insertions, deletions, or substitutions required to make one string exactly like another string. The version implemented in `clusters.c` additionally allows a new operation called a "swap" in which two adjacent characters change places. Transpositions of larger pieces of text are, unfortunately, not handled as well, which is a potential downfall of using levenshtein edit distance. +The [Levenshtein](https://en.wikipedia.org/wiki/Levenshtein_distance) distance is defined as the number of insertions, deletions, or substitutions required to make one string exactly like another string. The version implemented in `clusters.c` additionally allows a new operation called a "swap" in which two adjacent characters change places. Transpositions of larger pieces of text are, unfortunately, not handled as well, which is a potential downfall of using levenshtein edit distance. The levenshtein similarity of two strings can be compared using the `ca_lev_compare()` function. ## Clustering -When searching for similar strings in a large amount of data (for example, `1,000,000` strings), comparing every string to every other string can be very computationally expensive. To speed up this process, it is helpful to _cluster_ similar strings together, then only compare strings within similar clusters. This sacrifices some accuracy to allow large amounts of data to be searched and compared in a feasable amount of time. +When searching for similar strings in a large amount of data (for example, `1,000,000` strings), comparing every string to every other string can be very computationally expensive. To speed up this process, it is helpful to _cluster_ similar strings together, then only compare strings within similar clusters. This sacrifices some accuracy to allow large amounts of data to be searched and compared in a feasible amount of time. ### K-means Clustering -When clustering data using the [k-means](https://en.wikipedia.org/wiki/K-means_clustering) algorithm, data is divided into a predefined number of clusters with the goal of maximizing the average similarity of datapoints within any given cluster. To quickly summarize the algorithm: -1. Randomly select `k` datapoints to be the initial centroids of each cluster. -2. For each datapoint, find the centroid it is most similar to, and assign it to that clustser. -3. For each cluster, find the new centroid by averaging all datapoints in the cluster. -4. Repeat steps 2 and 3 until the clusters stabilize (i.e. no datapoint changes clusters). +When clustering data using the [k-means](https://en.wikipedia.org/wiki/K-means_clustering) algorithm, data is divided into a predefined number of clusters with the goal of maximizing the average similarity of data points within any given cluster. To quickly summarize the algorithm: +1. Randomly select `k` data points to be the initial centroids of each cluster. +2. For each data point, find the centroid it is most similar to, and assign it to that cluster. +3. For each cluster, find the new centroid by averaging all data points in the cluster. +4. Repeat steps 2 and 3 until the clusters stabilize (i.e. no data point changes clusters). -The implementation used in `clusters.c` also allows the programmer to specify a maximum number of iterations (called `max_iter` in the code) to prevent this process from running forever. Additionally, successive iterations can give diminishing results or even produce clusters that are slightly worse. To improve performance, the programmer can also specify a minimum improvement threshold (called `min_improvement`). Clusters must become more similar by at least this amount each iteration, otherwise the algorithm ends, even if the maximum number of iterations has not yet been reached. +The implementation used in `clusters.c` also allows the programmer to specify a maximum number of iterations (called `max_iter` in the code) to prevent this process from running forever. Additionally, successive iterations can give diminishing results or even produce clusters that are slightly worse. To improve performance, the programmer can also specify a minimum improvement threshold (called `min_improvement`). Clusters must become more similar by at least this amount each iteration, otherwise the algorithm ends, even if the maximum number of iterations has not yet been reached. The `ca_kmeans()` function can be invoked using [the cosine comparison string vectors](#string-vectors) (see above) to cluster them into similar clusters. ### K-means++ Clustering **Not yet implemented** -This method is largely identical to k-means, except that [k-means++](https://en.wikipedia.org/wiki/K-means%2B%2B) assignes the initial centroids using an aproximate algorithm designed to avoid some of the poor clusterings possible with random assignment. +This method is largely identical to k-means, except that [k-means++](https://en.wikipedia.org/wiki/K-means%2B%2B) assigns the initial centroids using an approximate algorithm designed to avoid some of the poor clustering possible with random assignment. ### K-medoids Clustering **Not yet implemented** -This method is also very similar to k-means, except that [k-medoids](https://en.wikipedia.org/wiki/K-medoids) places an aditional requirement that all centroids be points in the data. This would theoretically allow for other similarity measures (such as levenshtein edit distance) to be used for clustering instead of only cosine compare. +This method is also very similar to k-means, except that [k-medoids](https://en.wikipedia.org/wiki/K-medoids) places an additional requirement that all centroids be points in the data. This would theoretically allow for other similarity measures (such as Levenshtein edit distance) to be used for clustering instead of only cosine compare. ### DB-Scan **Proposed, not yet implemented or documented** ### Sliding Clusters -A far more basic method of "clustering" is to simply sort all data alphabetically, then, instead of comparing each string to all other strings, it can be compared to only the next `n` strings. Of course, differences near the start of a string (for example, "fox" vs. "box") will cause those strings to sort far away from each other, leading them to be completely missed. +A far more basic method of "clustering" is to simply sort all data alphabetically, then, instead of comparing each string to all other strings, it can be compared to only the next `n` strings. Of course, differences near the start of a string (for example, "fox" vs. "box") will cause those strings to sort far away from each other, leading them to be completely missed. -Sorting using a similarity measure, such as `ca_cos_compare()` or `ca_lev_compare()` would resolve this issue. However, these comparison functions do not meet the transitivity requirement for sorting, which is that `(A < B) & (B < C) -> (A < C)`. For example, "car" is similar to "boxcar", which is also similar to "box". However, "car" and "box" are not similar at all. +Sorting using a similarity measure, such as `ca_cos_compare()` or `ca_lev_compare()` would resolve this issue. However, these comparison functions do not meet the transitivity requirement for sorting, which is that `(A < B) & (B < C) -> (A < C)`. For example, "car" is similar to "boxcar", which is also similar to "box". However, "car" and "box" are not similar at all. Additionally, sorting by the cosine vectors (similarly to how we cluster by them when using k-means) was proposed, but further investigation showed that this was also not possible. -For problems where a sorting algorithm exists which can mitigate the above issues, this solution may prove very promissing. However, so far we have not found such a problem, so the other clustering algorithms tend to out perform Sliding Clusters. +For problems where a sorting algorithm exists which can mitigate the above issues, this solution may prove very promising. However, so far we have not found such a problem, so the other clustering algorithms tend to outperform Sliding Clusters. ## Future Implementation ### K-means Fuzzy Clustering -One of the biggest downsides with k-means is that it creates very arbitrary boundaries between clusters. Elements on either side of these boundaries may be highly similar, but if comparisons only occur within a cluster, these similar entries will be missed. The problem becomes more extreme as a higher k value (more clusters) is used, creating more arbitrary boundaries. This drawback is probably the main reason that clustering sacrifices some accuracy over searching every element. +One of the biggest downsides with k-means is that it creates very arbitrary boundaries between clusters. Elements on either side of these boundaries may be highly similar, but if comparisons only occur within a cluster, these similar entries will be missed. The problem becomes more extreme as a higher k value (more clusters) is used, creating more arbitrary boundaries. This drawback is probably the main reason that clustering sacrifices some accuracy over searching every element. -Running the entire search multiple types may allow some of these to be found because the initial cluster locations are random. This approach is partially implemented for duplocate searching because the algorithm runs nightly anyway, so a simple up-sert (**UP**date existing entries; in**SERT** new entries) slightly reduces this problem. However, this solution is obviously far from ideal. +Running the entire search multiple types may allow some of these to be found because the initial cluster locations are random. This approach is partially implemented for duplicate searching because the algorithm runs nightly anyway, so a simple upsert (**UP**date existing entries; in**SERT** new entries) slightly reduces this problem. However, this solution is obviously far from ideal. -If the clustering could be expanded with an additional step that makes clusters larger, adding elements from other clusters to them, this might effectively mitigate the issue. It may also allow developers to use larger numbers of clusters, improving performance as well as accuracy. Further research is needed to verify the effectiveness of this approach before an implementation is written. +If the clustering could be expanded with an additional step that makes clusters larger, adding elements from other clusters to them, this might effectively mitigate the issue. It may also allow developers to use larger numbers of clusters, improving performance as well as accuracy. Further research is needed to verify the effectiveness of this approach before an implementation is written. ### Implement Missing Algorithms -Several algorithms (such as [k-means++](#k-means-clustering-1), [k-medoids](#k-medoids-clustering), and [DBScan](#db-scan)) above are proposed but lack an implementation. They may be effective and useful, however, to reduce development time, they have not yet been implemented. +Several algorithms (such as [k-means++](#k-means-clustering-1), [k-medoids](#k-medoids-clustering), and [DBScan](#db-scan)) above are proposed but lack an implementation. They may be effective and useful, however, to reduce development time, they have not yet been implemented. + +### Upgrade Other Duplicate Detection Systems +When a new record is entered, a quick scan is run to check if it might be a duplicate. There is also a button in the UI for a record that lets you run a duplicate check. These systems could also be upgraded using the new algorithms and strategies developed for general duplicate detection. \ No newline at end of file diff --git a/centrallix/expression/exp_double_metaphone.c b/centrallix/expression/exp_double_metaphone.c index f3d76c49b..8b7c4cd6f 100644 --- a/centrallix/expression/exp_double_metaphone.c +++ b/centrallix/expression/exp_double_metaphone.c @@ -18,9 +18,9 @@ /* */ /* A summary of the relevant content from https://dev.perl.org/licenses */ /* has been included below for the convenience of the reader. This */ -/* was collected and saved on September 5th, 2025 and may not reflect */ -/* current information. For the most up to date information, please use */ -/* the link above. */ +/* information was collected and saved on September 5th, 2025 and may */ +/* differ from current information. For the most up to date copy of */ +/* this information, please use the link provided above. */ /* */ /* Perl5 is Copyright © 1993 and later, by Larry Wall and others. */ /* */ @@ -64,11 +64,15 @@ /* */ /* Module: exp_double_metaphone.c */ /* Author: Maurice Aubrey */ -/* Description: This module implements a "sounds like" algorithm */ -/* developed by Lawrence Philips which he published */ -/* in the June, 2000 issue of C/C++ Users Journal. */ -/* Double Metaphone is an improved version of Philips' */ -/* original Metaphone algorithm. */ +/* Description: This module implements a "sounds like" algorithm by */ +/* Lawrence Philips which he published in the June, 2000 */ +/* issue of C/C++ Users Journal. Double Metaphone is an */ +/* improved version of the original Metaphone algorithm */ +/* written by Philips'. This implementaton was written by */ +/* Maurice Aubrey for C/C++ with bug fixes provided by */ +/* Kevin Atkinson. It was revised by Israel Fuller to */ +/* better align with the Centrallix coding style and */ +/* standards so that it could be included here. */ /************************************************************************/ /*** Note to future programmers reading this file (by Israel Fuller): @@ -83,7 +87,7 @@ *** might not line up with the original author. *** *** To be honest, though, trying to make this code as readable as possible - *** was very challanging due to all the messy boolean algebra. If there is + *** was very challenging due to all the messy boolean algebra. If there is *** ever a professional linguist reading this, please factor out some of the *** logic into local variables with descriptive names so that the rest of us *** can read this code without our eyes glazing over. @@ -205,7 +209,7 @@ void meta_destroy_string(MetaString* s) /*** Increases a MetaString's buffer size. *** *** @param s The MetaString* being modified. - *** @param chars_needed Minimumn number of characters to increase buffer size. + *** @param chars_needed Minimum number of characters to increase buffer size. ***/ void meta_increase_buffer(MetaString* s, const size_t chars_needed) { @@ -347,7 +351,7 @@ void meta_double_metaphone(const char* str, char** primary_code, char** secondar if (str == NULL || (length = strlen(str)) == 0u) { fprintf(stderr, "Warning: Call to meta_double_metaphone() with invalid string.\n"); - /** Double Metaphone on an invalid string yeilds two empty strings. **/ + /** Double Metaphone on an invalid string yields two empty strings. **/ *primary_code = (char*)SAFE_MALLOC(sizeof(char)); *secondary_code = (char*)SAFE_MALLOC(sizeof(char)); return; @@ -1066,7 +1070,7 @@ void meta_double_metaphone(const char* str, char** primary_code, char** secondar } /** german & anglicisations, e.g. 'smith' match 'schmidt', 'snider' match 'schneider' **/ - /** also, -sz- in slavic language altho in hungarian it is pronounced 's' **/ + /** also, -sz- in slavic language although in hungarian it is pronounced 's' **/ if (current == 0 && meta_is_str_at(original, (current + 1), "M", "N", "L", "W", "")) { meta_add_str(primary, "S"); @@ -1269,7 +1273,7 @@ void meta_double_metaphone(const char* str, char** primary_code, char** secondar /*** Built in test cases. *** *** These tests have been integrated into the Centrallix testing environment, - *** where they can be run using `export TONLY=expfn_double_metaphone_00`, + *** where they can be run using `export TONLY=exp_fn_double_metaphone_00`, *** followed by make test, in the Centrallix directory. *** *** The can also be run here by executing the following commands in the diff --git a/centrallix/expression/exp_functions.c b/centrallix/expression/exp_functions.c index 71f906e3d..159c292b0 100644 --- a/centrallix/expression/exp_functions.c +++ b/centrallix/expression/exp_functions.c @@ -86,7 +86,7 @@ static char* ci_TypeToStr(const int type) case DATA_T_STRING: return "String"; case DATA_T_DOUBLE: return "Double"; case DATA_T_DATETIME: return "DateTime"; - case DATA_T_INTVEC: return "IntVecor"; + case DATA_T_INTVEC: return "IntVector"; case DATA_T_STRINGVEC: return "StringVector"; case DATA_T_MONEY: return "Money"; case DATA_T_ARRAY: return "Array"; @@ -2414,17 +2414,37 @@ int exp_fn_truncate(pExpression tree, pParamObjects objlist, pExpression i0, pEx /*** constrain(value, min, max) ***/ int exp_fn_constrain(pExpression tree, pParamObjects objlist, pExpression i0, pExpression i1, pExpression i2) { - if (!i0 || !i1 || !i2 || (i0->DataType != i1->DataType) || i0->DataType != i2->DataType || !(i0->DataType == DATA_T_INTEGER || i0->DataType == DATA_T_MONEY || i0->DataType == DATA_T_DOUBLE)) - { - mssError(1,"EXP","constrain() requires three numeric parameters of the same data type"); - return -1; - } + /** Skip null value. **/ tree->DataType = i0->DataType; if ((i0->Flags & EXPR_F_NULL)) { tree->Flags |= EXPR_F_NULL; return 0; } + + /** Verify parameters. **/ + if (i0 == NULL || i1 == NULL || i2 == NULL) + { + mssError(1, "EXP", "constrain() expects three parameters."); + return -1; + } + if (i0->DataType != DATA_T_INTEGER && i0->DataType != DATA_T_DOUBLE && i0->DataType != DATA_T_MONEY) + { + mssError(1, "EXP", + "constrain() expects three numeric parameters: %s is not numeric.", + ci_TypeToStr(i0->DataType) + ); + if (i0->DataType == DATA_T_STRING) printf("Value: '%s'\n", i0->String); + return -1; + } + if (i0->DataType != i1->DataType || i1->DataType != i2->DataType) + { + mssError(1, "EXP", + "constrain() expects three numeric parameters of the same data type but got types %s, %s, and %s.", + ci_TypeToStr(i0->DataType), ci_TypeToStr(i1->DataType), ci_TypeToStr(i2->DataType) + ); + return -1; + } /* check min */ if (!(i1->Flags & EXPR_F_NULL)) @@ -4131,78 +4151,143 @@ int exp_fn_nth(pExpression tree, pParamObjects objlist, pExpression i0, pExpress return 0; } - -/*** Computes cosine or levenshtien similarity between two strings. These two - *** tasks have a large amount of overlapping logic (mostly error checking), - *** so doing them with one function greatly reduces code duplocation. - *** - *** @param tree The tree resulting from this function. - *** @param objlist The evaluation "scope", including available variables. - *** @param maybe_str1 Possibly the first string. - *** @param maybe_str2 Possibly the second string. - *** @param u1 Unused parameter. - *** @param is_cos Whether to compute cosine or levenshtien. - *** @returns 0 for success, -1 for failure. - ***/ -static int exp_fn_cmp(pExpression tree, pParamObjects objlist, pExpression maybe_str1, pExpression maybe_str2, pExpression u1, const char* fn_name) +static int exp_fn_verify_schema( + const char* fn_name, + const int* param_types, + const int num_params, + pExpression tree, + pParamObjects obj_list) { - /** Check number of arguments. **/ - const int num_params = tree->Children.nItems; - if (num_params != 2) + /** Verify object list and session. **/ + if (obj_list == NULL) { - mssErrorf(1, "EXP", "%s(?) expects 2 parameters, got %d parameters.", fn_name, num_params); + mssErrorf(1, "EXP", "%s(\?\?\?) no object list?", fn_name); return -1; } - if (maybe_str1 == NULL || maybe_str2 == NULL || u1 != NULL) + ASSERTMAGIC(obj_list->Session, MGK_OBJSESSION); + + /** Verify expression tree. **/ + ASSERTMAGIC(tree, MGK_EXPRESSION); + + /** Verify parameter number. **/ + const int num_params_actual = tree->Children.nItems; + if (num_params != num_params_actual) { - mssErrorf(1, "EXP", "%s(?) expects 2 parameters.", fn_name); + mssErrorf(1, "EXP", + "%s(?) expects %u param%s, got %d param%s.", + fn_name, num_params, (num_params > 1) ? "s" : "", num_params_actual, (num_params_actual > 1) ? "s" : "" + ); return -1; } + + /** Verify parameter datatypes. **/ + for (int i = 0; i < num_params; i++) + { + const pExpression arg = tree->Children.Items[i]; + ASSERTMAGIC(arg, MGK_EXPRESSION); + + /** Skip null values. **/ + if (arg->Flags & EXPR_F_NULL) continue; + + /** Extract datatypes. **/ + const int expected_datatype = param_types[i]; + const int actual_datatype = arg->DataType; + + /** Verify datatypes. **/ + if (expected_datatype != actual_datatype) + { + mssErrorf(1, "EXP", + "%s(...) param #%d/%d expects type %s (%d) but got type %s (%d).", + fn_name, i + 1, num_params, ci_TypeToStr(expected_datatype), expected_datatype, ci_TypeToStr(actual_datatype), actual_datatype + ); + return -1; + } + } - /** Magic checks. **/ - ASSERTMAGIC(tree, MGK_EXPRESSION); - ASSERTMAGIC(maybe_str1, MGK_EXPRESSION); - ASSERTMAGIC(maybe_str2, MGK_EXPRESSION); + /** Pass. **/ + return 0; + } + + +int exp_fn_metaphone(pExpression tree, pParamObjects obj_list) + { + const char fn_name[] = "metaphone"; - /** Check object list. **/ - if (objlist == NULL) + /** Verify function schema. **/ + if (exp_fn_verify_schema(fn_name, (int[]){ DATA_T_STRING }, 1, tree, obj_list) != 0) { - mssErrorf(1, "EXP", "%s(\?\?\?) no object list?", fn_name); + mssErrorf(0, "EXP", "%s(?) Call does not match function schema.", fn_name); return -1; } - ASSERTMAGIC(objlist->Session, MGK_OBJSESSION); - /** Extract str1. **/ - if (maybe_str1->Flags & EXPR_F_NULL) + /** Extract string param. **/ + pExpression maybe_str = check_ptr(tree->Children.Items[0]); + if (maybe_str->Flags & EXPR_F_NULL) { tree->Flags |= EXPR_F_NULL; - tree->DataType = DATA_T_DOUBLE; + tree->DataType = DATA_T_STRING; + return 0; + } + const char* str = check_ptr(maybe_str->String); + const size_t str_len = strlen(str); + if (str_len == 0u) + { + tree->String = ""; + tree->DataType = DATA_T_STRING; return 0; } - if (maybe_str1->DataType != DATA_T_STRING) + + /** Compute DoubleMetaphone. **/ + char* primary = NULL; + char* secondary = NULL; + meta_double_metaphone(str, &primary, &secondary); + + /** Process result. **/ + const size_t result_length = strlen(primary) + 1u + strlen(secondary) + 1u; + char* result = check_ptr(nmSysMalloc(result_length * sizeof(char*))); + if (result == NULL) return -1; + sprintf(result, "%s%c%s", primary, CA_BOUNDARY_CHAR, secondary); + + /** Return the result. **/ + tree->String = result; + tree->DataType = DATA_T_STRING; + return 0; + } + + +/*** Computes cosine or Levenshtein similarity between two strings. These two + *** tasks have a large amount of overlapping logic (mostly error checking), + *** so doing them with one function greatly reduces code duplocation. + *** + *** @param tree The tree resulting from this function. + *** @param obj_list The evaluation "scope", including available variables. + *** @param fn_name Either `cos_compare()` or `lev_compare()`. + *** @returns 0 for success, -1 for failure. + ***/ +static int exp_fn_compare(pExpression tree, pParamObjects obj_list, const char* fn_name) + { + /** Verify function schema. **/ + if (exp_fn_verify_schema(fn_name, (int[]){ DATA_T_STRING, DATA_T_STRING }, 2, tree, obj_list) != 0) { - mssErrorf(1, "EXP", "%s(\?\?\?, ..) str1 should be a string.", fn_name); + mssErrorf(0, "EXP", "%s(?) Call does not match function schema.", fn_name); return -1; } - char* str1 = check_ptr(maybe_str1->String); - - /** Extract str2. **/ - if (maybe_str2->Flags & EXPR_F_NULL) + + /** Extract strings. **/ + pExpression maybe_str1 = check_ptr(tree->Children.Items[0]); + pExpression maybe_str2 = check_ptr(tree->Children.Items[1]); + if (maybe_str1->Flags & EXPR_F_NULL || maybe_str2->Flags & EXPR_F_NULL) { tree->Flags |= EXPR_F_NULL; tree->DataType = DATA_T_DOUBLE; return 0; } - if (maybe_str2->DataType != DATA_T_STRING) - { - mssErrorf(1, "EXP", "%s(\"%s\", \?\?\?) str2 should be a string.", fn_name, str1); - return -1; - } + char* str1 = check_ptr(maybe_str1->String); char* str2 = check_ptr(maybe_str2->String); - /** Handle either cos_cmp or lev_cmp. **/ + /** Handle either cos_compare() or lev_compare(). **/ if (fn_name[0] == 'c') - { /* cos_cmp */ + { /* cos_compare() */ int ret; /** Build vectors. **/ @@ -4218,17 +4303,19 @@ static int exp_fn_cmp(pExpression tree, pParamObjects objlist, pExpression maybe } else { + /** Compute the similarity. **/ tree->Types.Double = ca_cos_compare(v1, v2); tree->DataType = DATA_T_DOUBLE; ret = 0; } + /** Clean up. **/ if (v1 != NULL) ca_free_vector(v1); if (v2 != NULL) ca_free_vector(v2); return ret; } else - { /* lev_cmp */ + { /* lev_compare() */ tree->Types.Double = ca_lev_compare(str1, str2); tree->DataType = DATA_T_DOUBLE; return 0; @@ -4237,310 +4324,43 @@ static int exp_fn_cmp(pExpression tree, pParamObjects objlist, pExpression maybe } -int exp_fn_cos_cmp(pExpression tree, pParamObjects objlist, pExpression maybe_str1, pExpression maybe_str2, pExpression u1) - { return exp_fn_cmp(tree, objlist, maybe_str1, maybe_str2, u1, "cos_cmp"); } -int exp_fn_cos_compare(pExpression tree, pParamObjects objlist, pExpression maybe_str1, pExpression maybe_str2, pExpression u1) - { return exp_fn_cmp(tree, objlist, maybe_str1, maybe_str2, u1, "cos_compare"); } -int exp_fn_cosine_compare(pExpression tree, pParamObjects objlist, pExpression maybe_str1, pExpression maybe_str2, pExpression u1) - { return exp_fn_cmp(tree, objlist, maybe_str1, maybe_str2, u1, "cosine_compare"); } -int exp_fn_lev_cmp(pExpression tree, pParamObjects objlist, pExpression maybe_str1, pExpression maybe_str2, pExpression u1) - { return exp_fn_cmp(tree, objlist, maybe_str1, maybe_str2, u1, "lev_cmp"); } -int exp_fn_lev_compare(pExpression tree, pParamObjects objlist, pExpression maybe_str1, pExpression maybe_str2, pExpression u1) - { return exp_fn_cmp(tree, objlist, maybe_str1, maybe_str2, u1, "lev_compare"); } -int exp_fn_levenshtein_compare(pExpression tree, pParamObjects objlist, pExpression maybe_str1, pExpression maybe_str2, pExpression u1) - { return exp_fn_cmp(tree, objlist, maybe_str1, maybe_str2, u1, "levenshtein_compare"); } - - -/*** Comparse two strings to see if their sparse vectors are equal. - *** - *** @param tree The tree resulting from this function. - *** @param objlist The evaluation "scope", including available variables. - *** @param maybe_str1 Possibly the first string. - *** @param maybe_str2 Possibly the second string. - *** @param u1 Unused parameter. - *** @returns 0 for success, -1 for failure. - ***/ -static int exp_fn_sparse_eql(pExpression tree, pParamObjects objlist, pExpression maybe_str1, pExpression maybe_str2, pExpression u1, bool is_cos) +int exp_fn_cos_compare(pExpression tree, pParamObjects obj_list) { - const char fn_name[] = "sparse_compare"; - - /** Check number of arguments. **/ - const int num_params = tree->Children.nItems; - if (num_params != 2) - { - mssErrorf(1, "EXP", "%s(?) expects 2 parameters, got %d parameters.", fn_name, num_params); - return -1; - } - if (maybe_str1 == NULL || maybe_str2 == NULL || u1 != NULL) - { - mssErrorf(1, "EXP", "%s(?) expects 2 parameters.", fn_name); - return -1; - } - - /** Magic checks. **/ - ASSERTMAGIC(tree, MGK_EXPRESSION); - ASSERTMAGIC(maybe_str1, MGK_EXPRESSION); - ASSERTMAGIC(maybe_str2, MGK_EXPRESSION); - - /** Check object list. **/ - if (objlist == NULL) - { - mssErrorf(1, "EXP", "%s(\?\?\?) no object list?", fn_name); - return -1; - } - ASSERTMAGIC(objlist->Session, MGK_OBJSESSION); - - /** Extract str1. **/ - if (maybe_str1->Flags & EXPR_F_NULL) - { - mssErrorf(1, "EXP", "%s(NULL, ...) str1 cannot be NULL.", fn_name); - return -1; - } - if (maybe_str1->DataType != DATA_T_STRING) - { - mssErrorf(1, "EXP", "%s(\?\?\?, ..) str1 should be a string.", fn_name); - return -1; - } - char* str1 = maybe_str1->String; - if (str1 == NULL) - { - mssErrorf(1, "EXP", - "%s(nothing?, ...) expected string from str1 (of datatype DataType = " - "DATA_T_STRING), but the String was NULL or did not exist!", - fn_name - ); - return -1; - } - - /** Extract str2. **/ - if (maybe_str2->Flags & EXPR_F_NULL) - { - mssErrorf(1, "EXP", "%s(\"%s\", NULL) str2 cannot be NULL.", fn_name, str1); - return -1; - } - if (maybe_str2->DataType != DATA_T_STRING) - { - mssErrorf(1, "EXP", "%s(\"%s\", \?\?\?) str2 should be a string.", fn_name, str1); - return -1; - } - char* str2 = maybe_str2->String; - if (str2 == NULL) - { - mssErrorf(1, "EXP", - "%s(\"%s\", nothing?) expected string from str2 (of datatype DataType = " - "DATA_T_STRING), but the String was NULL or did not exist!", - fn_name, str1 - ); - return -1; - } - - /** Build vectors. **/ - int ret; - const pVector v1 = check_ptr(ca_build_vector(str1)); - const pVector v2 = check_ptr(ca_build_vector(str2)); - if (v1 == NULL || v2 == NULL) - { - mssErrorf(1, "EXP", - "%s(\"%s\", \"%s\") - Failed to build vectors.", - fn_name, str1, str2 - ); - ret = -1; - } - else - { - tree->Integer = (ca_eql(v1, v2)) ? 1 : 0; - tree->DataType = DATA_T_INTEGER; - ret = 0; - } - - if (v1 != NULL) ca_free_vector(v1); - if (v2 != NULL) ca_free_vector(v2); - return ret; + return exp_fn_compare(tree, obj_list, "cos_compare"); } - -/*** Computes double metaphone. - *** - *** @param tree The tree resulting from this function. - *** @param objlist The evaluation "scope", including available variables. - *** @param maybe_str Possibly the string passed to double metaphone. - *** @param u1 Unused parameter. - *** @param u2 Unused parameter. - ***/ -int exp_fn_double_metaphone(pExpression tree, pParamObjects objlist, pExpression maybe_str, pExpression u1, pExpression u2) +int exp_fn_lev_compare(pExpression tree, pParamObjects obj_list) { - const char fn_name[] = "double_metaphone"; - - /** Check number of arguments. **/ - const int num_params = tree->Children.nItems; - if (num_params != 1) - { - mssErrorf(1, "EXP", "%s(?) expects 1 parameter, got %d parameters.", fn_name, num_params); - return -1; - } - if (maybe_str == NULL || u1 != NULL || u2 != NULL) - { - mssErrorf(1, "EXP", "%s(?) expects 1 parameter.", fn_name); - return -1; - } - - /** Magic checks. **/ - ASSERTMAGIC(tree, MGK_EXPRESSION); - ASSERTMAGIC(maybe_str, MGK_EXPRESSION); - - /** Check object list. **/ - if (objlist == NULL) - { - mssErrorf(1, "EXP", "%s(\?\?\?) no object list?", fn_name); - return -1; - } - ASSERTMAGIC(objlist->Session, MGK_OBJSESSION); - - /** Extract str. **/ - if (maybe_str->Flags & EXPR_F_NULL) - { - mssErrorf(1, "EXP", "%s(NULL) str cannot be NULL.", fn_name); - return -1; - } - if (maybe_str->DataType != DATA_T_STRING) - { - mssErrorf(1, "EXP", "%s(\?\?\?) str should be a string.", fn_name); - return -1; - } - const char* str = maybe_str->String; - if (str == NULL) - { - mssErrorf(1, "EXP", - "%s(nothing?) expected string from str (of datatype DataType = " - "DATA_T_STRING), but the String was NULL or did not exist!", - fn_name - ); - return -1; - } - const size_t str_len = strlen(str); - if (str_len == 0u) - { - mssErrorf(1, "EXP", "%s(\"\") str cannot be an empty string.", fn_name); - return -1; - } - - /** Compute DoubleMetaphone. **/ - char* primary = NULL; - char* secondary = NULL; - meta_double_metaphone(str, &primary, &secondary); - - /** Process result. **/ - const size_t primary_length = strlen(primary); - const size_t secondary_length = strlen(secondary); - char* result = check_ptr(nmSysMalloc(primary_length + 1u + secondary_length + 1u)); - if (result == NULL) return -1; - sprintf(result, "%s%c%s", primary, CA_BOUNDARY_CHAR, secondary); - - /** Return the result. **/ - tree->String = result; - tree->DataType = DATA_T_STRING; - return 0; + return exp_fn_compare(tree, obj_list, "lev_compare"); } - -int exp_fn_aggregate_similarities(pExpression tree, pParamObjects objlist) - { - const char fn_name[] = "aggregate_similarities"; - - /** Check number of arguments. **/ - const int num_params = tree->Children.nItems; - if (num_params != 6) - { - mssErrorf(1, "EXP", "%s(?) expects 6 parameters, got %d parameters.", fn_name, num_params); - return -1; - } - /** Magic checks. **/ - ASSERTMAGIC(tree, MGK_EXPRESSION); - ASSERTMAGIC(tree->Children.Items[0], MGK_EXPRESSION); - ASSERTMAGIC(tree->Children.Items[1], MGK_EXPRESSION); - ASSERTMAGIC(tree->Children.Items[2], MGK_EXPRESSION); - ASSERTMAGIC(tree->Children.Items[3], MGK_EXPRESSION); +int exp_fn_levenshtein(pExpression tree, pParamObjects obj_list) + { + const char fn_name[] = "levenshtein"; - /** Check object list. **/ - if (objlist == NULL) + /** Verify function schema. **/ + if (exp_fn_verify_schema(fn_name, (int[]){ DATA_T_STRING, DATA_T_STRING }, 2, tree, obj_list) != 0) { - mssErrorf(1, "EXP", "%s(\?\?\?) no object list?", fn_name); + mssErrorf(0, "EXP", "%s(?) Call does not match function schema.", fn_name); return -1; } - ASSERTMAGIC(objlist->Session, MGK_OBJSESSION); - - /** Extract parameters. **/ - double params[4] = {NAN}; - const char names[4][8] = {"name", "email", "phone", "address"}; - for (unsigned int i = 0; i < 4u; i++) - { - pExpression param = (pExpression)tree->Children.Items[i]; - - /** Ignore null values. **/ - if (param->Flags & EXPR_F_NULL) continue; - - /** Only accept doubles. **/ - if (param->DataType != DATA_T_DOUBLE) - { - mssErrorf(1, "EXP", - "%s() param%u (%s) expected type %s but got %s.", - fn_name, i, names[i], ci_TypeToStr(DATA_T_DOUBLE), ci_TypeToStr(param->DataType) - ); - if (param->DataType == DATA_T_INTEGER) fprintf(stderr, "Value: %d\n", param->Integer); - return -1; - } - - /** Do not accept NaN. **/ - params[i] = param->Types.Double; - if (isnan(params[i])) - { - mssErrorf(1, "EXP", "%s() param%u (%s) cannot be NaN", fn_name, names[i], i); - return -1; - } - } - char* dup_names[2] = {NULL}; - for (unsigned int i = 0; i < 2u; i++) + /** Extract strings. **/ + pExpression maybe_str1 = check_ptr(tree->Children.Items[0]); + pExpression maybe_str2 = check_ptr(tree->Children.Items[1]); + if (maybe_str1->Flags & EXPR_F_NULL || maybe_str2->Flags & EXPR_F_NULL) { - pExpression param = (pExpression)tree->Children.Items[i + 4u]; - - /** Ignore null values. **/ - if (param->Flags & EXPR_F_NULL) continue; - - /** Only accept doubles. **/ - if (param->DataType != DATA_T_STRING) - { - mssErrorf(1, "EXP", - "%s() param%u expected type %s but got %s.", - fn_name, i, ci_TypeToStr(DATA_T_STRING), ci_TypeToStr(param->DataType) - ); - return -1; - } - - dup_names[i] = param->String; + tree->Flags |= EXPR_F_NULL; + tree->DataType = DATA_T_INTEGER; + return 0; } + char* str1 = check_ptr(maybe_str1->String); + char* str2 = check_ptr(maybe_str2->String); - FILE *f = check_ptr(fopen("/home/israel/exp_log.swift", "a")); - check_neg(fprintf(f, "aggregate_similarities(%g, %g, %g, %g, \"%s\", \"%s\")", params[0], params[1], params[2], params[3], dup_names[0], dup_names[1])); - - /** Compute aggregated similarity. **/ - double name_sim = params[0]; - double email_sim = params[1]; - double phone_sim = params[2]; - double address_sim = params[3]; - - double mean = 0.0, n = 0.0; - if (name_sim > 0.0) { mean += name_sim; n++; } - if (email_sim > 0.0) { mean += email_sim; n++; } - if (phone_sim > 0.0) { mean += phone_sim; n++; } - if (address_sim > 0.0) { mean += address_sim; n++; } - mean /= n; - - /** Success. **/ - tree->DataType = DATA_T_DOUBLE; - tree->Types.Double = mean; - fprintf(f, " = %g\n", tree->Types.Double); - check(fclose(f)); + /** Compute edit distance. **/ + /** Length 0 is provided for both strings so that the function will compute it for us. **/ + tree->Integer = edit_dist(str1, str2, 0lu, 0lu); + tree->DataType = DATA_T_INTEGER; return 0; } @@ -4552,7 +4372,7 @@ int exp_fn_aggregate_similarities(pExpression tree, pParamObjects objlist) * Parameters: * pExpression tree: * pParamObjects: - * pExpression passowrd: The password, passed as a pExpression + * pExpression password: The password, passed as a pExpression * pExpression salt: The salt, passed as a pExpression * * returns: @@ -4745,15 +4565,10 @@ int exp_internal_DefineFunctions() xhAdd(&EXP.Functions, "power", (char*)exp_fn_power); /** Duplicate detection. **/ - xhAdd(&EXP.Functions, "cos_cmp", (char*)exp_fn_cos_cmp); + xhAdd(&EXP.Functions, "metaphone", (char*)exp_fn_metaphone); xhAdd(&EXP.Functions, "cos_compare", (char*)exp_fn_cos_compare); - xhAdd(&EXP.Functions, "cosine_compare", (char*)exp_fn_cosine_compare); - xhAdd(&EXP.Functions, "lev_cmp", (char*)exp_fn_lev_cmp); xhAdd(&EXP.Functions, "lev_compare", (char*)exp_fn_lev_compare); - xhAdd(&EXP.Functions, "levenshtein_compare", (char*)exp_fn_levenshtein_compare); - xhAdd(&EXP.Functions, "sparse_eql", (char*)exp_fn_sparse_eql); - xhAdd(&EXP.Functions, "aggregate_similarities", (char*)exp_fn_aggregate_similarities); - xhAdd(&EXP.Functions, "double_metaphone", (char*)exp_fn_double_metaphone); + xhAdd(&EXP.Functions, "levenshtein", (char*)exp_fn_levenshtein); /** Windowing. **/ xhAdd(&EXP.Functions, "row_number", (char*)exp_fn_row_number); diff --git a/centrallix/osdrivers/objdrv_cluster.c b/centrallix/osdrivers/objdrv_cluster.c index b3d416668..4bf94ebe9 100644 --- a/centrallix/osdrivers/objdrv_cluster.c +++ b/centrallix/osdrivers/objdrv_cluster.c @@ -102,7 +102,7 @@ void void_func() {} *** not readily available. *** *** @param clr Whether to clear the current error stack. As a rule of thumb, - *** if you are the first one to detec the error, clear the stack so that + *** if you are the first one to detect the error, clear the stack so that *** other unrelated messages are not shown. If you are detecting an error *** from another function that may also call an mssError() function, do *** not clear the stack. @@ -188,7 +188,7 @@ static int ci_TypeFromStr(const char* str) case 'I': case 'i': if (strcmp(str+1, "Integer"+1) == 0) return DATA_T_INTEGER; - if (strcmp(str+1, "IntVecor"+1) == 0) return DATA_T_INTVEC; + if (strcmp(str+1, "IntVector"+1) == 0) return DATA_T_INTVEC; break; case 'M': case 'm': @@ -221,7 +221,7 @@ static char* ci_TypeToStr(const int type) case DATA_T_STRING: return "String"; case DATA_T_DOUBLE: return "Double"; case DATA_T_DATETIME: return "DateTime"; - case DATA_T_INTVEC: return "IntVecor"; + case DATA_T_INTVEC: return "IntVector"; case DATA_T_STRINGVEC: return "StringVector"; case DATA_T_MONEY: return "Money"; case DATA_T_ARRAY: return "Array"; @@ -282,7 +282,7 @@ static void** ci_xaToTrimmedArray(pXArray arr, int array_handling) }) -/** ================ Enum Declairations ================ **/ +/** ================ Enum Declarations ================ **/ /** ANCHOR[id=enums] **/ /** Enum representing a clustering algorithm. **/ @@ -430,7 +430,7 @@ char* const METHOD_NAME[] = *** the SourcePath. *** *** @skip --> Computed data. - *** @param Strings The keys for each data string strings recieved from the + *** @param Strings The keys for each data string strings received from the *** database, allowing them to be lined up again when queried. *** @param Strings The data strings to be clustered and searched, or NULL if *** they have not been fetched from the source. @@ -741,7 +741,7 @@ static int ci_SetParamValue(void* inf_v, char* attr_name, int datatype, pObjData /** Driver Functions. **/ // LINK #driver -void* clusterOpen(pObject obj, int mask, pContentType systype, char* usr_type, pObjTrxTree* oxt); +void* clusterOpen(pObject parent, int mask, pContentType systype, char* usr_type, pObjTrxTree* oxt); int clusterClose(void* inf_v, pObjTrxTree* oxt); void* clusterOpenQuery(void* inf_v, pObjQuery query, pObjTrxTree* oxt); void* clusterQueryFetch(void* qy_v, pObject obj, int mode, pObjTrxTree* oxt); @@ -749,30 +749,30 @@ int clusterQueryClose(void* qy_v, pObjTrxTree* oxt); int clusterGetAttrType(void* inf_v, char* attr_name, pObjTrxTree* oxt); int clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val, pObjTrxTree* oxt); pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pObjTrxTree* oxt); -char* clusterGetFirstAttr(void* inf_v, pObjTrxTree oxt); -char* clusterGetNextAttr(void* inf_v, pObjTrxTree oxt); +char* clusterGetFirstAttr(void* inf_v, pObjTrxTree* oxt); +char* clusterGetNextAttr(void* inf_v, pObjTrxTree* oxt); int clusterInfo(void* inf_v, pObjectInfo info); /** Method Execution Functions. **/ // LINK #method -char* clusterGetFirstMethod(void* inf_v, pObjTrxTree oxt); -char* clusterGetNextMethod(void* inf_v, pObjTrxTree oxt); +char* clusterGetFirstMethod(void* inf_v, pObjTrxTree* oxt); +char* clusterGetNextMethod(void* inf_v, pObjTrxTree* oxt); static int ci_PrintEntry(pXHashEntry entry, void* arg); static void ci_CacheFreeSourceData(pXHashEntry entry, void* path); static void ci_CacheFreeCluster(pXHashEntry entry, void* path); static void ci_CacheFreeSearch(pXHashEntry entry, void* path); -int clusterExecuteMethod(void* inf_v, char* methodname, pObjData param, pObjTrxTree oxt); +int clusterExecuteMethod(void* inf_v, char* method_name, pObjData param, pObjTrxTree* oxt); /** Unimplemented DriverFunctions. **/ // LINK #unimplemented int clusterCreate(pObject obj, int mask, pContentType systype, char* usrtype, pObjTrxTree* oxt); -int clusterDeleteObj(void* inf_v, pObjTrxTree* oxt); int clusterDelete(pObject obj, pObjTrxTree* oxt); -int clusterRead(void* inf_v, char* buffer, int maxcnt, int offset, int flags, pObjTrxTree* oxt); +int clusterDeleteObj(void* inf_v, pObjTrxTree* oxt); +int clusterRead(void* inf_v, char* buffer, int max_cnt, int offset, int flags, pObjTrxTree* oxt); int clusterWrite(void* inf_v, char* buffer, int cnt, int offset, int flags, pObjTrxTree* oxt); -int clusterSetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val, pObjTrxTree oxt); -int clusterAddAttr(void* inf_v, char* attr_name, int type, pObjData val, pObjTrxTree oxt); -void* clusterOpenAttr(void* inf_v, char* attr_name, int mode, pObjTrxTree oxt); +int clusterSetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val, pObjTrxTree* oxt); +int clusterAddAttr(void* inf_v, char* attr_name, int type, pObjData val, pObjTrxTree* oxt); +void* clusterOpenAttr(void* inf_v, char* attr_name, int mode, pObjTrxTree* oxt); int clusterCommit(void* inf_v, pObjTrxTree *oxt); /** ================ Parsing Functions ================ **/ @@ -1037,7 +1037,7 @@ static pSourceData ci_ParseSourceData(pStructInf inf, pParamObjects param_list, /** Cache hit. **/ tprintf("# source: \"%s\"\n", source_data->Key); - /** Cause an imediate invalid read if cache was incorrectly freed. **/ + /** Cause an immediate invalid read if cache was incorrectly freed. **/ tprintf("--> Name: %s\n", source_maybe->Name); /** Free data we don't need. **/ @@ -1709,7 +1709,7 @@ static pNodeData ci_ParseNodeData(pStructInf inf, pObject parent) int num_provided_params = (has_provided_params) ? parent->Pathname->OpenCtl[parent->SubPtr - 1]->nSubInf : 0; pStruct* provided_params = (has_provided_params) ? parent->Pathname->OpenCtl[parent->SubPtr - 1]->SubInf : NULL; - /** Itterate over each param in the structure file. **/ + /** Iterate over each param in the structure file. **/ node_data->nParams = param_infs.nItems; const size_t params_size = node_data->nParams * sizeof(pParam); node_data->Params = check_ptr(nmSysMalloc(params_size)); @@ -1920,7 +1920,7 @@ static void ci_FreeSourceData(pSourceData source_data) /*** Free pClusterData struct with an option to recursively free subclusters. *** *** @param cluster_data The cluster data struct to free. - *** @param recrusive Whether to recursively free subclusters. + *** @param recursive Whether to recursively free subclusters. ***/ static void ci_FreeClusterData(pClusterData cluster_data, bool recursive) { @@ -2142,7 +2142,7 @@ static unsigned int ci_SizeOfSourceData(pSourceData source_data) *** caching systems, so it is not technically part of the struct. *** *** @param cluster_data The cluster data struct to be queried. - *** @param recrusive Whether to recursively free subclusters. + *** @param recursive Whether to recursively free subclusters. *** @returns The size in bytes of the struct and all internal allocated data. ***/ static unsigned int ci_SizeOfClusterData(pClusterData cluster_data, bool recursive) @@ -2224,7 +2224,7 @@ static int ci_ComputeSourceData(pSourceData source_data, pObjSession session) if (!check(objCurrentDate(&source_data->DateComputed))) goto end; /** Open the source path specified by the .cluster file. **/ - tprintf("Openning...\n"); + tprintf("Opening...\n"); pObject obj = objOpen(session, source_data->SourcePath, OBJ_O_RDONLY, 0600, "system/directory"); if (obj == NULL) { @@ -2239,7 +2239,7 @@ static int ci_ComputeSourceData(pSourceData source_data, pObjSession session) } /** Generate a "query" for retrieving data. **/ - tprintf("Openning query...\n"); + tprintf("Opening query...\n"); pObjQuery query = objOpenQuery(obj, NULL, NULL, NULL, NULL, 0); if (query == NULL) { @@ -2424,7 +2424,7 @@ static int ci_ComputeSourceData(pSourceData source_data, pObjSession session) // ret = ret; // Fall-through: Failure ignored. } } - tprintf("\nData aquired.\n"); + tprintf("\nData acquired.\n"); source_data->nVectors = vector_xarray.nItems; if (source_data->nVectors == 0) { @@ -2508,7 +2508,7 @@ static int ci_ComputeSourceData(pSourceData source_data, pObjSession session) ***/ static int ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data) { - /** If the clusters are alreadyd computed, we're done. **/ + /** If the clusters are already computed, we're done. **/ if (cluster_data->Clusters != NULL) return 0; /** Make source data available. **/ @@ -2565,7 +2565,7 @@ static int ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data) if (cluster_data->SimilarityMeasure != SIMILARITY_COSINE) { mssErrorf(1, "Cluster", - "The similarity meausre \"%s\" is not implemented.", + "The similarity measure \"%s\" is not implemented.", ci_SimilarityMeasureToString(cluster_data->SimilarityMeasure) ); goto err_free_sims; @@ -2840,8 +2840,8 @@ static int ci_GetParamType(void* inf_v, const char* attr_name) *** *** @attention - Warning: If the retrieved value is `NULL`, the pObjectData *** val is not updated, and the function returns 1, indicating `NULL`. - *** This is intended behavior, for consistancy with other Centrallix - *** functions, so keep it in mind so you're not surpised. + *** This is intended behavior, for consistency with other Centrallix + *** functions, so keep it in mind so you're not surprised. *** *** @param inf_v Node data containing the list of paramenters. *** @param attr_name The name of the requested paramenter. @@ -2853,9 +2853,9 @@ static int ci_GetParamType(void* inf_v, const char* attr_name) *** so that they will have a pointer to the data. *** This buffer will not be modified unless the data is successfully *** found. If a value other than 0 is returned, the buffer is not updated. - *** @returns 0 if successsful, + *** @returns 0 if successful, *** 1 if the variable is null, - *** -1 if an error occures. + *** -1 if an error occurs. *** *** LINK ../../centrallix-lib/include/datatypes.h:72 ***/ @@ -2919,7 +2919,7 @@ static int ci_SetParamValue(void* inf_v, char* attr_name, int datatype, pObjData *** @param oxt The object system tree, similar to a kind of "scope" (unused). *** *** @returns A pDriverData struct representing a driver instance, or - *** NULL if an error occures. + *** NULL if an error occurs. ***/ void* clusterOpen(pObject parent, int mask, pContentType sys_type, char* usr_type, pObjTrxTree* oxt) { @@ -3352,8 +3352,8 @@ int clusterGetAttrType(void* inf_v, char* attr_name, pObjTrxTree* oxt) *** so that they will have a pointer to the data. *** This buffer will not be modified unless the data is successfully *** found. If a value other than 0 is returned, the buffer is not updated. - *** @returns 0 if successsful, - *** -1 if an error occures. + *** @returns 0 if successful, + *** -1 if an error occurs. *** *** LINK ../../centrallix-lib/include/datatypes.h:72 ***/ @@ -3593,7 +3593,7 @@ int clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val static StringVec* vec = NULL; if (vec != NULL) nmFree(vec, sizeof(StringVec)); - /** Allocate and initiallize the requested data. **/ + /** Allocate and initialize the requested data. **/ val->StringVec = vec = check_ptr(nmMalloc(sizeof(StringVec))); if (val->StringVec == NULL) return -1; val->StringVec->nStrings = target_cluster->Size; @@ -3653,15 +3653,15 @@ int clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val *** provided cluster driver instance. *** *** Note: Failures from nmSysStrdup() and several others are ignored because - *** the worst case senario is that the attributes are set to null, which + *** the worst case scenario is that the attributes are set to null, which *** will cause them to be ignored. I consider that to be better than than *** throwing an error that could unnecessarily disrupt normal usage. *** *** @param inf_v The driver instance to be read. *** @param attr_name The name of the requested attribute. *** @param oxt The object system tree, similar to a kind of "scope" (unused). - *** @returns A presentation hints object, if successsful, - *** NULL if an error occures. + *** @returns A presentation hints object, if successful, + *** NULL if an error occurs. ***/ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pObjTrxTree* oxt) { @@ -3954,13 +3954,13 @@ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pOb /*** Returns the name of the first attribute that one can get from *** this driver instance (using GetAttrType() and GetAttrValue()). *** Resets the internal variable (TargetAttrIndex) used to maintain - *** itteration state for clusterGetNextAttr(). + *** iteration state for clusterGetNextAttr(). *** *** @param inf_v The driver instance to be read. *** @param oxt Unused. *** @returns The name of the first attribute. ***/ -char* clusterGetFirstAttr(void* inf_v, pObjTrxTree oxt) +char* clusterGetFirstAttr(void* inf_v, pObjTrxTree* oxt) { tprintf("Warning: clusterGetFirstAttr() is under active development.\n"); pDriverData driver_data = (pDriverData)inf_v; @@ -3973,13 +3973,13 @@ char* clusterGetFirstAttr(void* inf_v, pObjTrxTree oxt) /*** Returns the name of the next attribute that one can get from *** this driver instance (using GetAttrType() and GetAttrValue()). *** Uses an internal variable (TargetAttrIndex) used to maintain - *** the state of this itteration over repeated calls. + *** the state of this iteration over repeated calls. *** *** @param inf_v The driver instance to be read. *** @param oxt Unused. *** @returns The name of the next attribute. ***/ -char* clusterGetNextAttr(void* inf_v, pObjTrxTree oxt) +char* clusterGetNextAttr(void* inf_v, pObjTrxTree* oxt) { tprintf("Warning: clusterGetNextAttr("); pDriverData driver_data = (pDriverData)inf_v; @@ -4004,7 +4004,7 @@ char* clusterGetNextAttr(void* inf_v, pObjTrxTree oxt) *** *** @param inf_v The driver instance to be checked. *** @param info The struct to be populated with driver flags. - *** @returns 0 if succesful, + *** @returns 0 if successful, *** -1 if the driver is an unimplemented type (should never happen). ***/ int clusterInfo(void* inf_v, pObjectInfo info) @@ -4088,14 +4088,14 @@ int clusterInfo(void* inf_v, pObjectInfo info) /*** Returns the name of the first method that one can execute from *** this driver instance (using clusterExecuteMethod()). Resets the - *** internal variable (TargetMethodIndex) used to maintain itteration + *** internal variable (TargetMethodIndex) used to maintain iteration *** state for clusterGetNextMethod(). *** *** @param inf_v The driver instance to be read. *** @param oxt Unused. - *** @returns The name of the first methd. + *** @returns The name of the first method. ***/ -char* clusterGetFirstMethod(void* inf_v, pObjTrxTree oxt) +char* clusterGetFirstMethod(void* inf_v, pObjTrxTree* oxt) { tprintf("Warning: clusterGetFirstMethod() is under active development.\n"); pDriverData driver_data = (pDriverData)inf_v; @@ -4108,13 +4108,13 @@ char* clusterGetFirstMethod(void* inf_v, pObjTrxTree oxt) /*** Returns the name of the next method that one can get from *** this driver instance (using GetAttrType() and GetAttrValue()). *** Uses an internal variable (TargetMethodIndex) used to maintain - *** the state of this itteration over repeated calls. + *** the state of this iteration over repeated calls. *** *** @param inf_v The driver instance to be read. *** @param oxt Unused. *** @returns The name of the next method. ***/ -char* clusterGetNextMethod(void* inf_v, pObjTrxTree oxt) +char* clusterGetNextMethod(void* inf_v, pObjTrxTree* oxt) { tprintf("Warning: clusterGetNextMethod() is under active development."); pDriverData driver_data = (pDriverData)inf_v; @@ -4247,7 +4247,7 @@ static void ci_CacheFreeSearch(pXHashEntry entry, void* path) *** @param param A possibly optional param passed to the method. *** @param oxt The object system tree, similar to a kind of "scope" (unused). ***/ -int clusterExecuteMethod(void* inf_v, char* method_name, pObjData param, pObjTrxTree oxt) +int clusterExecuteMethod(void* inf_v, char* method_name, pObjData param, pObjTrxTree* oxt) { tprintf("Warning: clusterExecuteMethod(\"%s\") is under active development.\n", method_name); pDriverData driver_data = (pDriverData)inf_v; @@ -4304,7 +4304,7 @@ int clusterExecuteMethod(void* inf_v, char* method_name, pObjData param, pObjTrx )); if (failed) { - mssErrorf(0, "Cluster", "Unexpected error occured while showhing caches."); + mssErrorf(0, "Cluster", "Unexpected error occurred while showhing caches."); ret = -1; } @@ -4345,7 +4345,7 @@ int clusterExecuteMethod(void* inf_v, char* method_name, pObjData param, pObjTrx ); goto err; } - + if (strcmp(method_name, "stat") == 0) { unsigned long long ExpectedOpenCalls = 10666; @@ -4388,25 +4388,25 @@ int clusterExecuteMethod(void* inf_v, char* method_name, pObjData param, pObjTrx // LINK #functions /** Not implemented. **/ -int clusterCreate(pObject obj, int mask, pContentType systype, char* usrtype, pObjTrxTree* oxt) +int clusterCreate(pObject obj, int mask, pContentType sys_type, char* usr_type, pObjTrxTree* oxt) { mssErrorf(1, "Cluster", "clusterCreate() is not implemented."); return -ENOSYS; } /** Not implemented. **/ -int clusterDeleteObj(void* inf_v, pObjTrxTree* oxt) +int clusterDelete(pObject obj, pObjTrxTree* oxt) { - mssErrorf(1, "Cluster", "clusterDeleteObj() is not implemented."); + mssErrorf(1, "Cluster", "clusterDelete() is not implemented."); return -1; } /** Not implemented. **/ -int clusterDelete(pObject obj, pObjTrxTree* oxt) +int clusterDeleteObj(void* inf_v, pObjTrxTree* oxt) { - mssErrorf(1, "Cluster", "clusterDelete() is not implemented."); + mssErrorf(1, "Cluster", "clusterDeleteObj() is not implemented."); return -1; } /** Not implemented. **/ -int clusterRead(void* inf_v, char* buffer, int maxcnt, int offset, int flags, pObjTrxTree* oxt) +int clusterRead(void* inf_v, char* buffer, int max_cnt, int offset, int flags, pObjTrxTree* oxt) { mssErrorf(1, "Cluster", "clusterRead() not implemented."); fprintf(stderr, "HINT: Use queries instead, (e.g. clusterOpenQuery()).\n"); @@ -4419,25 +4419,25 @@ int clusterWrite(void* inf_v, char* buffer, int cnt, int offset, int flags, pObj return -1; } /** Not implemented. **/ -int clusterSetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val, pObjTrxTree oxt) +int clusterSetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val, pObjTrxTree* oxt) { mssErrorf(1, "Cluster", "clusterSetAttrValue() not implemented because clusters are imutable."); return -1; } /** Not implemented. **/ -int clusterAddAttr(void* inf_v, char* attr_name, int type, pObjData val, pObjTrxTree oxt) +int clusterAddAttr(void* inf_v, char* attr_name, int type, pObjData val, pObjTrxTree* oxt) { mssErrorf(1, "Cluster", "clusterAddAttr() not implemented because clusters are imutable."); return -1; } /** Not implemented. **/ -void* clusterOpenAttr(void* inf_v, char* attr_name, int mode, pObjTrxTree oxt) +void* clusterOpenAttr(void* inf_v, char* attr_name, int mode, pObjTrxTree* oxt) { mssErrorf(1, "Cluster", "clusterOpenAttr() not implemented."); return NULL; } /** Not implemented. **/ -int clusterCommit(void* inf_v, pObjTrxTree *oxt) +int clusterCommit(void* inf_v, pObjTrxTree* oxt) { mssErrorf(1, "Cluster", "clusterCommit() not implemented because clusters are imutable."); return 0; @@ -4451,7 +4451,7 @@ int clusterCommit(void* inf_v, pObjTrxTree *oxt) *** - Initializing global data needed for the driver. *** *** @returns 0 if successful, or - *** -1 if an error occured. + *** -1 if an error occurs. ***/ int clusterInitialize(void) { @@ -4470,10 +4470,10 @@ int clusterInitialize(void) memset(&ClusterStatistics, 0, sizeof(ClusterStatistics)); /** Setup the structure. **/ - if (check_ptr(strcpy(drv->Name, "clu - Clustering Driver")) == NULL) goto err; + if (check_ptr(strcpy(drv->Name, "cluster - Clustering Driver")) == NULL) goto err; if (!check(xaInit(&drv->RootContentTypes, 1))) goto err; if (!check_neg(xaAddItem(&drv->RootContentTypes, "system/cluster"))) goto err; - drv->Capabilities = OBJDRV_C_TRANS | OBJDRV_C_FULLQUERY; /* TODO: Greg, are these correct? Should I add any others? */ + drv->Capabilities = 0; /* TODO: Greg - Should I add any of these? */ /** Setup the function references. **/ drv->Open = clusterOpen; @@ -4503,8 +4503,11 @@ int clusterInitialize(void) drv->Commit = clusterCommit; drv->GetQueryCoverageMask = NULL; drv->GetQueryIdentityPath = NULL; - - /** Register some structures. **/ + + /** Register the driver. **/ + if (!check(objRegisterDriver(drv))) goto err; + + /** Register structs used in this project with the newmalloc memory management system. **/ nmRegister(sizeof(SourceData), "ClusterSourceData"); nmRegister(sizeof(Cluster), "Cluster"); nmRegister(sizeof(ClusterData), "ClusterData"); @@ -4514,42 +4517,6 @@ int clusterInitialize(void) nmRegister(sizeof(ClusterQuery), "ClusterQuery"); nmRegister(sizeof(ClusterDriverCaches), "ClusterDriverCaches"); - /** Print debug size info. **/ -// char buf1[16], buf2[16], buf3[16], buf4[16], buf5[16], buf6[16], buf7[16], buf8[16]; -// tprintf( -// "Cluster driver struct sizes:\n" -// " > sizeof(SourceData): %s\n" -// " > sizeof(Cluster): %s\n" -// " > sizeof(ClusterData): %s\n" -// " > sizeof(SearchData): %s\n" -// " > sizeof(NodeData): %s\n" -// " > sizeof(DriverData): %s\n" -// " > sizeof(ClusterQuery): %s\n" -// " > sizeof(ClusterDriverCaches): %s\n", -// snprint_bytes(buf1, sizeof(buf1), sizeof(SourceData)), -// snprint_bytes(buf2, sizeof(buf2), sizeof(Cluster)), -// snprint_bytes(buf3, sizeof(buf3), sizeof(ClusterData)), -// snprint_bytes(buf4, sizeof(buf4), sizeof(SearchData)), -// snprint_bytes(buf5, sizeof(buf5), sizeof(NodeData)), -// snprint_bytes(buf6, sizeof(buf6), sizeof(DriverData)), -// snprint_bytes(buf7, sizeof(buf7), sizeof(ClusterQuery)), -// snprint_bytes(buf8, sizeof(buf8), sizeof(ClusterDriverCaches)) -// ); -// - // 'st' (7: 13) collides with 'an' (7: 11) -// char* str1 = "This is a very long string of text"; -// char* str2 = "This is a very long string of textttttttttttt"; -// pVector v1 = ca_build_vector(str1); -// pVector v2 = ca_build_vector(str2); -// ca_fprint_vector(stdout, v1); printf("\n"); -// ca_fprint_vector(stdout, v2); printf("\n"); -// fprintf(stderr, "'%s' ?= '%s' -> %g\n", str1, str2, ca_cos_compare(v1, v2)); -// ca_free_vector(v1); -// ca_free_vector(v2); - - /** Register the driver. **/ - if (!check(objRegisterDriver(drv))) goto err; - /** Success. **/ return 0; From fa28afa4b0c282b45fe46a87a7d11db904578925 Mon Sep 17 00:00:00 2001 From: Israel Date: Fri, 14 Nov 2025 11:48:53 -0700 Subject: [PATCH 009/275] Add ClusterDriverRequirements (forgot to commit them before). Add known issues to string similarity documentation. Clean up and organize todos. Clean up testing code in several files. --- .../ClusterDriverRequirements-old.md | 186 +++++++++++++++ centrallix-sysdoc/OSDriver_Authoring.md | 22 +- centrallix-sysdoc/string_similarity.md | 6 +- centrallix/expression/exp_functions.c | 2 +- centrallix/osdrivers/objdrv_cluster.c | 217 ++++++------------ 5 files changed, 271 insertions(+), 162 deletions(-) create mode 100644 centrallix-sysdoc/ClusterDriverRequirements-old.md diff --git a/centrallix-sysdoc/ClusterDriverRequirements-old.md b/centrallix-sysdoc/ClusterDriverRequirements-old.md new file mode 100644 index 000000000..601f41703 --- /dev/null +++ b/centrallix-sysdoc/ClusterDriverRequirements-old.md @@ -0,0 +1,186 @@ + +## Cluster Driver Specifications +### Cluster Open +```c +void* clusterOpen(pObject obj, int mask, pContentType sys_type, char* usr_type, pObjTrxTree* oxt); +``` +`clusterOpen()` shall... +- Create or read a node, as indicated by passed flags. + - Read flags from `obj->Mode`. + - If `O_EXCL` is specified, `O_CREAT` is specified, and there are no other elements in the path, create a new node. + - Otherwise attempt to read the previous object (in `obj->Prev`). + - If this fails and `O_CREAT` is specified, create a new node. + - If there is still no node, fail. +- Parse the provided path. + - Use `obj_internal_PathPart()` with the pathname in `obj->Pathname`. + - Not parse previous parts of the path already parsed by other drivers. + - Start at the `obj->SubPtr`-th path element (skipping `obj->SubPtr - 1` elements). + - Consume elements in the path until `obj_internal_PathPart()` returns `NULL`. + - Store the number of elements consumed in `obj->SubCnt`. +- Determine what data is being targeted from the parsed path. + - If the relevant part of the path contains only the name of the file, the driver shall set the target to root. + - If it contains the name of a valid (sub)cluster or search, the driver shall set the target to that (sub)cluster or search. + - Otherwise, the driver shall produce a descriptive error. +- Parse the provided structure file. + - Follow the spec given in `cluster-schema.cluster`. + - Produce descriptive errors when issues are detected. +- Return a new struct containing necessary information, including: + - The name, source path, and attribute name. + - All parameters (and a param list for scope), clusters, and searches. + - Each parameter shall be represented by a `pParam` object (see `params.h`). + - Each cluster shall be represented by a struct with information including: + - Its name, clustering algorithm, and similarity measure. + - The number of clusters to generate. + - If a k-means algorithm is specified, the improvement threshold. + - The maximum number of iterations to run. + - A list of subclusters with at least this information for each. + - Each search shall be represented by a struct with information including: + - Its name, threshold, and similarity measure. + - Its source, which is a valid cluster name of a cluster in the clusters list. + - Information about targets, derived from the path. + +### Cluster Close +```c +int clusterClose(void* inf_v, pObjTrxTree* oxt); +``` +`clusterClose()` shall... +- Free all allocated data in the driver struct. +- Close any open files or the like in the driver struct. +- Return 0. + +### Cluster Open Query +```c +void* clusterOpenQuery(void* inf_v, pObjQuery query, pObjTrxTree* oxt); +``` +`clusterOpenQuery()` shall... +- Return a query struct that can be passed to `clusterQueryFetch()`. + - This struct shall contain an index to the last row accessed (starting at 0). + - This struct shall contain a pointer to the driver data. + +### Cluster Query Fetch +```c +void* clusterQueryFetch(void* qy_v, pObject obj, int mode, pObjTrxTree* oxt) +``` +`clusterQueryFetch()` shall... +- If the driver struct targets the root node, this function shall produce an error. +- If the driver struct targets an entry, this function shall produce a different error. +- If the driver targets a cluster or search, this function shall return a driver struct targetting the cluster or search *entry* (respectively) indicated by the query struct's row pointer, and increment the pointer. + - Exception: If no data remains, this function shall return `NULL` instead. + - This request shall cause clustering / searching to execute, if it has not executed already. + +### Cluster Query Close +```c +int clusterQueryClose(void* qy_v, pObjTrxTree* oxt); +``` +`clusterQueryClose()` shall... +- Free all allocated data in the query struct. +- Close any open files or the like in the query struct. +- Return 0. + +### Cluster Get Attribute Type +```c +int clusterGetAttrType(void* qy_v, pObjTrxTree* oxt); +``` +`clusterGetAttrType()` shall... +- Return the `DATA_T_...` type of the requested attribute, or `DATA_T_UNAVAILABLE` if the attribute does not exist. +- The name, content_type, inner_type, and outer_type attributes shall be of type `DATA_T_STRING`. +- The last_modification attribute shall be of type `DATA_T_DATETIME`. +- If the target is root... + - The source and attr_name attributes shall be of type `DATA_T_STRING`. +- If the target is a cluster... + - The algorithm and similarity_measure attributes shall be of type `DATA_T_STRING`. + - The num_clusters and max_iterations attributes shall be of type `DATA_T_INTEGER`. + - The improvement_threshold and average_similarity attributes shall be of type `DATA_T_DOUBLE`. +- If the target is a search... + - The source and similarity_measure attribute shall be of type `DATA_T_STRING`. + - The threshold attribute shall be of type `DATA_T_DOUBLE`. +- If the target is a cluster entry... + - The val attribute shall be of type `DATA_T_INTEGER`. + - The sim attribute shall be of type `DATA_T_DOUBLE`. +- If the target is a search entry... + - The val1 and val2 attribute shall be of type `DATA_T_INTEGER`. + - The sim attribute shall be of type `DATA_T_DOUBLE`. + +### Cluster Get Attribute Value +```c +int clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val, pObjTrxTree* _); +``` +`clusterGetAttrValue()` shall... +- If the given datatype does not match that returned from `clusterGetAttrType()`, the function shall produce an error. +- Requesting the name attribute shall produce the following values, depending on the target: + - If the target is root, the name in the driver struct (aka. the one specified in the .cluster file) shall be produced. + - If the target is a cluster or cluster entry, the name of the cluster shall be produced. + - If the target is a search or search entry, the name of the search shall be produced. +- Requesting the annotation shall produce some string describing the driver. +- Requesting the outer_type shall produce "system/row". +- Requesting the inner_type or content_type shall produce "system/void". (All path elements are consumed.) +- If the target is root... + - Requesting source shall produce the source path. + - Requesting attr_name shall produce the attribute name. +- If the target is a cluster... + - Requesting algorithm shall produce the name of the clustering algorithm. + - Requesting similarity_measure shall produce the name of the similarity measure. + - Requesting num_clusters shall produce the number of clusters. + - Requesting max_iterations shall produce the maximum number of iterations. + - Requesting improvement_threshold shall produce the minimum improvement threshold. + - Requesting average_similarity shall produce the average size of clusters, running clustering / searching algorithms, if necessary. +- If the target is a search... + - Requesting source shall produce the name of the source cluster for the search. + - Requesting similarity_measure shall produce the name of the similarity measure. + - Requesting threshold shall produce the filtering threshold. +- If the target is a cluster entry... + - Requesting val shall produce the value of the data point in this cluster. + - Requesting sim shall produce the similarity of the data point to the center of the cluster. +- If the target is a cluster entry... + - Requesting val1 or val2 shall produce the first and second value (respectively)detected in this search. + - Requesting sim shall produce the similarity of these two data points. + + +### Cluster Get First Attribute +```c +char* clusterGetFirstAttr(void* inf_v, pObjTrxTree oxt); +``` +`clusterGetFirstAttr()` shall... +- Reset the current attribute index on the driver struct to 0. +- Return the value of invoking `clusterGetNextAttr()`. + +### Cluster Get Next Attribute +```c +char* clusterGetNextAttr(void* inf_v, pObjTrxTree oxt); +``` +`clusterGetNextAttr()` shall... +- Return the attribute name at the attribute index given by the driver struct in the list of attributes based on the target type. +- Return `NULL` if the end of the list has been reached. +- Increase the attribute index on the driver struct by 1. + +- The attribute name list for a targetting root shall include "source" and "attr_name". +- The attribute name list for a targetting a cluster shall include "algorithm", "similarity_measure", "num_clusters", "improvement_threshold", and "max_iterations". +- The attribute name list for a targetting a search shall include "source", "threshold", and "similarity_measure". +- The attribute name list for a targetting a cluster entry shall include "val" and "sim". +- The attribute name list for a targetting a search entry shall include "val1", "val2", and "sim". + +### Cluster Get Next Attribute +```c +int clusterInfo(void* inf_v, pObjectInfo info); +``` +`clusterInfo()` shall... +- Provide the OBJ_INFO_F_CANT_ADD_ATTR flag. +- Provide the OBJ_INFO_F_CANT_HAVE_CONTENT flag. +- Provide the OBJ_INFO_F_NO_CONTENT flag. +- If the target is a root... + - Provide the OBJ_INFO_F_CAN_HAVE_SUBOBJ flag. + - Provide the OBJ_INFO_F_SUBOBJ_CNT_KNOWN flag. + - Provide the OBJ_INFO_F_HAS_SUBOBJ flag if there is at least one cluster or search. + - Provide the OBJ_INFO_F_NO_SUBOBJ flag otherwise. + - Provide the total number of clusters and searches as the number of subobjects. +- If the target is a cluster... + - Provide the OBJ_INFO_F_CAN_HAVE_SUBOBJ flag. + - Provide the OBJ_INFO_F_HAS_SUBOBJ flag. + - If the algorithm has been run, provide OBJ_INFO_F_SUBOBJ_CNT_KNOWN flag and the number of data points clustered as the number of subobjects. +- If the target is a search... + - Provide the OBJ_INFO_F_CAN_HAVE_SUBOBJ flag. + - If the algorithm has been run... + - Provide OBJ_INFO_F_SUBOBJ_CNT_KNOWN flag and the number of elements found by the search as the number of subobjects. + - Provide the OBJ_INFO_F_HAS_SUBOBJ flag if at least one element was found. +- If the target is a cluster entry or a search entry... + - Provide the OBJ_INFO_F_CANT_HAVE_SUBOBJ flag. \ No newline at end of file diff --git a/centrallix-sysdoc/OSDriver_Authoring.md b/centrallix-sysdoc/OSDriver_Authoring.md index d00c192f6..f679dac32 100644 --- a/centrallix-sysdoc/OSDriver_Authoring.md +++ b/centrallix-sysdoc/OSDriver_Authoring.md @@ -202,9 +202,12 @@ Using the example above, we can query from the database using a statement like ` This section describes the standard interface between the OSML and the ObjectSystem driver itself. Every driver should implement certain required functions. (**Note**: Many drivers "implement" some required functions to simply fail with a not implemented or not supported error. For example, most database drivers "implement" `Read()` and `Write()` this way because database content should be queried, not read). Various optional functions are also available, which a driver is not required to implement. The driver should implement an `Initialize()` function, as well as the following (* indicates required functions): | Function Name | Description @@ -332,7 +335,8 @@ The `Open()` function opens a given file to create a new driver instance. This p 5. Return a pointer to the node instance as a void pointer. This pointer will be passed as `void* inf_v` to the driver in subsequent calls involving this object (except the Query functions, discussed below). - 📖 **Note - Transactions**: If the os driver specified the `OBJDRV_C_TRANS` capability, it must respect the current state of the user's transaction. If a new object is being created, an object is being deleted, or other modifications/additions are being performed, and if the OXT layer indicates a transaction is in process, the driver must either complete the current transaction and then complete the current call, or else add the current delete/create/modify call to the transaction tree (in which case the tree item is preallocated; all the driver needs to do is fill it in). This is handled using the transaction tree parameter (`oxt : pObjTrxTree*`). The transaction later is discussed in depth in the ??? section. - + + #### Accessing the Node Object If `O_CREAT` and `O_EXCL` are both specified in `parent->Mode`, the driver should **only** create a new file and fail if the file already exists (refusing to open and read it). Otherwise, the driver should read an existing file, or create one if it does not exist and `O_CREAT` is specified, failing if no file can be read or created. @@ -540,7 +544,6 @@ The `QueryFetch()` function fetches a driver instance pointer (aka. an `inf_v` p | mode | int | The open mode for the new object, the same as `obj->Mode` in `Open()`. | oxt | pObjTrxTree* | The transaction tree pointer for the `OBJDRV_C_TRANS` capability. - The driver should add an element to the `obj->Pathname` structure to indicate the path of the returned child object. This will involve a process somewhat like this, where: - `new_name : char*` is the new object's name. - `qy : pMyDriversQueryInf` is the current query structure. @@ -747,7 +750,7 @@ The return value, `hints : ObjPresentationHints`, contains the following useful - `hints->MaxValue : void*`: An expression defining the maximum valid value. - `hints->EnumList : XArray`: If the attribute is a string enum, this XArray lists the valid string values. - `hints->EnumQuery : char*`: A query string which enumerates the valid values a string enum attribute. -- `hints->Format : char*`: presentation format - datetime or money +- `hints->Format : char*`: presentation format - datetime or money - `hints->AllowChars : char*`: An array of all valid characters for a string attribute, NULL to allow all characters. - `hints->BadChars : char*`: An array of all invalid characters for a string attribute. - `hints->Length : int`: The maximum length of data that can be included in a string attribute. @@ -785,7 +788,7 @@ The following macros are provided for setting style flags: - `OBJ_PH_STYLE_SEPWINDOW`: Prefer separate windows for grouped fields. - `OBJ_PH_STYLE_ALWAYSDEF`: Always reset the default value when this attribute is modified. - `OBJ_PH_STYLE_CREATEONLY`: This attribute is writeable only when created, after that it is read only. -- `OBJ_PH_STYLE_MULTISEL`: Multiple select +- `OBJ_PH_STYLE_MULTISEL`: Multiple select - `OBJ_PH_STYLE_KEY`: This attribute is a primary key. - `OBJ_PH_STYLE_APPLYCHG`: Presentation hints should be applied on DataChange instead of on DataModify. @@ -812,10 +815,12 @@ The `pObjectInfo` struct has two fields: `Flags` and `nSubobjects`. This functi - `OBJ_INFO_F_CANT_SEEK`: Seeking is not supported at all. - `OBJ_INFO_F_CAN_ADD_ATTR` / `OBJ_INFO_F_CANT_ADD_ATTR`: Indicates that the object does or does not allow attributes to be added with the [AddAttr()](#function-addattr) function. - `OBJ_INFO_F_SUPPORTS_INHERITANCE`: Indicates that the object supports inheritance through attributes such as `cx__inherit`. See ??? for more information about object inheritance. - + + - `OBJ_INFO_F_FORCED_LEAF`: Indicates that the object is forced to be a 'leaf' unless ls__type used. - `OBJ_INFO_F_TEMPORARY`: Indicates that this is a temporary object without a vaoid pathname. + The function returns 0 on success, and -1 to indicate an error, in which case `mssError()` should be called before returning. @@ -852,7 +857,6 @@ Although using the structure file format may be complex, it allows significant f Structure files are accessed via the st_node (SN) and stparse (SP) modules. The st_node module loads and saves the structure file heirarchies as a whole. It also manages caching to reduce disk activity and eliminate repeated parsing of the same file. The stparse module provides access to the individual attributes and groups of attributes within a node structure file. For example, if two sessions open two files, `/test1.rpt` and `/test2.rpt` the st_node module will cache the internal representations of these node object files, and for successive uses of these node objects, the physical file will not be re-parsed. The file will be re-parsed if its timestamp changes. - If the underlying object does not support the attribute "last_modification" (assumed to be the timestamp), then st_node prints a warning. In essence, this warning indicates that changes to the underlying object will not trigger the st_node module to re-read the structure file defining the node object. Otherwise, the st_node module keeps track of the timestamp, and if it changes, the node object is re-read and re-parsed. @@ -1157,7 +1161,7 @@ Frees a block of memory allocated by `nmSysMalloc()`, `nmSysRealloc()`, or `nmSy ## V Other Utility Modules - + The Centrallix library (`centralllix-lib`) has a host of useful utility modules. These include `xarray`, used for managing growable arrays; `xstring`, used for managing growable strings; `xhash`, used for managing hash tables with no overflow problems and variable-length keys; `expression`, used for compiling and evaluating expressions; and `mtsession`, used for managing session-level variables and reporting errors. diff --git a/centrallix-sysdoc/string_similarity.md b/centrallix-sysdoc/string_similarity.md index b9a3a28b6..33667a05c 100644 --- a/centrallix-sysdoc/string_similarity.md +++ b/centrallix-sysdoc/string_similarity.md @@ -167,4 +167,8 @@ If the clustering could be expanded with an additional step that makes clusters Several algorithms (such as [k-means++](#k-means-clustering-1), [k-medoids](#k-medoids-clustering), and [DBScan](#db-scan)) above are proposed but lack an implementation. They may be effective and useful, however, to reduce development time, they have not yet been implemented. ### Upgrade Other Duplicate Detection Systems -When a new record is entered, a quick scan is run to check if it might be a duplicate. There is also a button in the UI for a record that lets you run a duplicate check. These systems could also be upgraded using the new algorithms and strategies developed for general duplicate detection. \ No newline at end of file +When a new record is entered, a quick scan is run to check if it might be a duplicate. There is also a button in the UI for a record that lets you run a duplicate check. These systems could also be upgraded using the new algorithms and strategies developed for general duplicate detection. + +### Known Issues +- The cluster driver often fails to open the structure file if it was modifed since the last time the path was openned. Opening a different path (including the root path, even though it does not support queries) fixes this issue. This is either a bug in the st_node caching or in the cluster driver's usage of stparse. +- The cluster does not invalidate caches if the underlying data source changes. This bug exists because I wasn't sure how to do this, but I'm pretty sure it's possible. Workaround: Developers should use `exec "cache" "drop_all"` to invalidate caches when data is changed, or use a fresh object system instance. diff --git a/centrallix/expression/exp_functions.c b/centrallix/expression/exp_functions.c index 159c292b0..dd65a0c52 100644 --- a/centrallix/expression/exp_functions.c +++ b/centrallix/expression/exp_functions.c @@ -75,7 +75,7 @@ #include "obj.h" -/** TODO: I think this should be moved to datatypes. **/ +/** TODO: Greg - I think this should be moved to datatypes. **/ /** Should maybe replace duplocate functionality elsewhere. **/ static char* ci_TypeToStr(const int type) { diff --git a/centrallix/osdrivers/objdrv_cluster.c b/centrallix/osdrivers/objdrv_cluster.c index 4bf94ebe9..462d0625f 100644 --- a/centrallix/osdrivers/objdrv_cluster.c +++ b/centrallix/osdrivers/objdrv_cluster.c @@ -72,18 +72,6 @@ *** https://marketplace.visualstudio.com/items?itemName=ExodiusStudios.comment-anchors ***/ -/** Pure Laziness. **/ -// #define ENABLE_TPRINTF - -/** Debugging **/ -#ifndef ENABLE_TPRINTF -void void_func() {} -#define tprintf void_func -#endif -#ifdef ENABLE_TPRINTF -#define tprintf printf -#endif - /** Defaults for unspecified optional attributes. **/ #define DEFAULT_MIN_IMPROVEMENT 0.0001 #define DEFAULT_MAX_ITERATIONS 64u @@ -91,7 +79,7 @@ void void_func() {} /** ================ Stuff That Should Be Somewhere Else ================ **/ /** ANCHOR[id=temp] **/ -/** TODO: I think this should be moved to mtsession. **/ +/** TODO: Greg - I think this should be moved to mtsession. **/ /*** I caused at least 10 bugs so far trying to pass format specifiers to *** mssError without realizing that it didn't support them. Eventually, I *** got fed up enough with the whole thing to write the following function. @@ -147,7 +135,7 @@ void mssErrorf(int clr, char* module, const char* format, ...) } -/** TODO: I think this should be moved to datatypes. **/ +/** TODO: Greg - I think this should be moved to datatypes. **/ /** Should maybe replace current type parsing in the presentation hints. **/ /*** Parse the given string into a datatype. The case of the first character *** is ignored, but all other characters must be capitalized correctly. @@ -210,8 +198,8 @@ static int ci_TypeFromStr(const char* str) return -1; } -/** TODO: I think this should be moved to datatypes. **/ -/** Should maybe replace duplocate functionality elsewhere. **/ +/** TODO: Greg - I think this should be moved to datatypes. **/ +/** Should maybe replace this functionality where it appears elsewhere. **/ static char* ci_TypeToStr(const int type) { switch (type) @@ -234,7 +222,7 @@ static char* ci_TypeToStr(const int type) return "Invalid"; /* Shall not parse to a valid type in ci_TypeFromStr(). */ } -/** TODO: I think this should be moved to xarray. **/ +/** TODO: Greg - I think this should be moved to xarray. **/ /*** Trims an xArray, returning a new array (with nmSysMalloc). *** *** @param arr The array to be trimmed. @@ -803,7 +791,6 @@ static bool ci_TryHint(char* value, char** valid_values, const unsigned int n_va /** Issue hint. **/ ci_GiveHint(guess); - tprintf(" > Similarity: %.4g\n", ca_lev_compare(value, guess)); return true; } @@ -816,9 +803,9 @@ static bool ci_TryHint(char* value, char** valid_values, const unsigned int n_va *** *** @attention - Promises that a failure invokes mssError() at least once. *** - *** TODO: Greg - Review Carefully. - *** This function took a lot of debugging to get it to work. Please make sure - *** it works correctly and properly requires runserver() for dynamic attributes. + *** TODO: Greg - Review carefully. I think this code is the reason that runserver() + *** is NOT REQUIRED for dynamic attributes in the cluster driver. I had to debug + *** and rewrite this for ages and it uses several functions I don't 100% understand. ***/ static int ci_ParseAttribute( pStructInf inf, @@ -830,7 +817,6 @@ static int ci_ParseAttribute( bool print_type_error) { int ret; - tprintf("Invoking ci_ParseAttribute('%s').\n", attr_name); /** Get attribute inf. **/ pStructInf attr_info = stLookup(inf, attr_name); @@ -1035,10 +1021,8 @@ static pSourceData ci_ParseSourceData(pStructInf inf, pParamObjects param_list, if (source_maybe != NULL) { /** Cache hit. **/ - tprintf("# source: \"%s\"\n", source_data->Key); /** Cause an immediate invalid read if cache was incorrectly freed. **/ - tprintf("--> Name: %s\n", source_maybe->Name); /** Free data we don't need. **/ nmSysFree(source_data->Key); @@ -1049,7 +1033,6 @@ static pSourceData ci_ParseSourceData(pStructInf inf, pParamObjects param_list, } /** Cache miss: Add the new object to the cache for next time. **/ - tprintf("+ source: \"%s\"\n", source_data->Key); if (!check(xhAdd(&ClusterDriverCaches.SourceDataCache, source_data->Key, (void*)source_data))) goto err_free; @@ -1087,8 +1070,6 @@ static pClusterData ci_ParseClusterData(pStructInf inf, pNodeData node_data) { int result; - tprintf("Parsing cluster: %s\n", inf->Name); - /** Extract values. **/ pParamObjects param_list = node_data->ParamList; pSourceData source_data = node_data->SourceData; @@ -1252,7 +1233,7 @@ static pClusterData ci_ParseClusterData(pStructInf inf, pNodeData node_data) if (group_type == NULL) goto err_free_subclusters; if (strcmp(group_type, "cluster/cluster") != 0) { - fprintf(stderr, + mssErrorf(1, "Cluster", "Warning: Unknown group [\"%s\" : \"%s\"] in cluster \"%s\".\n", name, group_type, inf->Name ); @@ -1333,13 +1314,7 @@ static pClusterData ci_ParseClusterData(pStructInf inf, pNodeData node_data) /** Check for a cached version. **/ pClusterData cluster_maybe = (pClusterData)xhLookup(&ClusterDriverCaches.ClusterDataCache, key); if (cluster_maybe != NULL) - { - /** Cache hit. **/ - tprintf("# cluster: \"%s\"\n", key); - - /** Cause invalid read if cache was incorrectly freed. **/ - tprintf("--> Name: %s\n", cluster_maybe->Name); - + { /* Cache hit. */ /** Free the parsed cluster that we no longer need. */ ci_FreeClusterData(cluster_data, false); nmSysFree(key); @@ -1349,7 +1324,6 @@ static pClusterData ci_ParseClusterData(pStructInf inf, pNodeData node_data) } /** Cache miss. **/ - tprintf("+ cluster: \"%s\"\n", key); if (!check(xhAdd(&ClusterDriverCaches.ClusterDataCache, key, (void*)cluster_data))) goto err_free_key; return cluster_data; @@ -1386,9 +1360,7 @@ static pClusterData ci_ParseClusterData(pStructInf inf, pNodeData node_data) *** @returns A new pSearchData struct on success, or NULL on failure. ***/ static pSearchData ci_ParseSearchData(pStructInf inf, pNodeData node_data) - { - tprintf("Parsing search: %s\n", inf->Name); - + { /** Allocate space for search struct. **/ pSearchData search_data = check_ptr(nmMalloc(sizeof(SearchData))); if (search_data == NULL) goto err; @@ -1525,10 +1497,7 @@ static pSearchData ci_ParseSearchData(pStructInf inf, pNodeData node_data) /** Check for a cached version. **/ pSearchData search_maybe = (pSearchData)xhLookup(search_cache, key); if (search_maybe != NULL) - { - /** Cache hit. **/ - tprintf("# search: \"%s\"\n", key); - tprintf("--> Name: %s\n", search_maybe->Name); /* Cause invalid read if cache was incorrectly freed. */ + { /* Cache hit. */ /** Free the parsed search that we no longer need. **/ ci_FreeSearchData(search_data); @@ -1539,7 +1508,6 @@ static pSearchData ci_ParseSearchData(pStructInf inf, pNodeData node_data) } /** Cache miss. **/ - tprintf("+ search: \"%s\"\n", key); check(xhAdd(search_cache, key, (void*)search_data)); return search_data; @@ -1751,7 +1719,6 @@ static pNodeData ci_ParseNodeData(pStructInf inf, pObject parent) ); goto err_free_arrs; } - tprintf("Found provided value for %s of type %s\n", param->Name, ci_TypeToStr(param->Type)); /** Provided value successfully handled, we're done. **/ break; @@ -1860,7 +1827,7 @@ static void ci_FreeSourceData(pSourceData source_data) /** Guard segfault. **/ if (source_data == NULL) { - fprintf(stderr, "Call to ci_FreeSourceData(NULL);\n"); + fprintf(stderr, "Warning: Call to ci_FreeSourceData(NULL);\n"); return; } @@ -1927,7 +1894,7 @@ static void ci_FreeClusterData(pClusterData cluster_data, bool recursive) /** Guard segfault. **/ if (cluster_data == NULL) { - fprintf(stderr, "Call to ci_FreeClusterData(NULL, %s);\n", (recursive) ? "true" : "false"); + fprintf(stderr, "Warning: Call to ci_FreeClusterData(NULL, %s);\n", (recursive) ? "true" : "false"); return; } @@ -1983,7 +1950,7 @@ static void ci_FreeSearchData(pSearchData search_data) /** Guard segfault. **/ if (search_data == NULL) { - fprintf(stderr, "Call to ci_FreeSearchData(NULL);\n"); + fprintf(stderr, "Warning: Call to ci_FreeSearchData(NULL);\n"); return; } @@ -2019,7 +1986,7 @@ static void ci_FreeNodeData(pNodeData node_data) /** Guard segfault. **/ if (node_data == NULL) { - fprintf(stderr, "Call to ci_FreeNodeData(NULL);\n"); + fprintf(stderr, "Warning: Call to ci_FreeNodeData(NULL);\n"); return; } @@ -2111,6 +2078,13 @@ static void ci_ClearCaches(void) ***/ static unsigned int ci_SizeOfSourceData(pSourceData source_data) { + /** Guard segfault. **/ + if (source_data == NULL) + { + fprintf(stderr, "Warning: Call to ci_SizeOfSourceData(NULL);\n"); + return 0u; + } + unsigned int size = 0u; if (source_data->Name != NULL) size += strlen(source_data->Name) * sizeof(char); if (source_data->SourcePath != NULL) size += strlen(source_data->SourcePath) * sizeof(char); @@ -2146,20 +2120,22 @@ static unsigned int ci_SizeOfSourceData(pSourceData source_data) *** @returns The size in bytes of the struct and all internal allocated data. ***/ static unsigned int ci_SizeOfClusterData(pClusterData cluster_data, bool recursive) - { + { + /** Guard segfault. **/ + if (cluster_data == NULL) + { + fprintf(stderr, "Warning: Call to ci_SizeOfClusterData(NULL, %s);\n", (recursive) ? "true" : "false"); + return 0u; + } + unsigned int size = 0u; if (cluster_data->Name != NULL) size += strlen(cluster_data->Name) * sizeof(char); if (cluster_data->Clusters != NULL) { const unsigned int nVectors = cluster_data->SourceData->nVectors; for (unsigned int i = 0u; i < cluster_data->nClusters; i++) - { - const unsigned int cluster_size = cluster_data->Clusters[i].Size; - size += cluster_size * sizeof(char*); - size += cluster_size * sizeof(pVector); - } - size += nVectors * sizeof(Cluster); - size += nVectors * sizeof(double); + size += cluster_data->Clusters[i].Size * (sizeof(char*) + sizeof(pVector)); + size += nVectors * (sizeof(Cluster) + sizeof(double)); } if (cluster_data->SubClusters != NULL) { @@ -2188,6 +2164,13 @@ static unsigned int ci_SizeOfClusterData(pClusterData cluster_data, bool recursi ***/ static unsigned int ci_SizeOfSearchData(pSearchData search_data) { + /** Guard segfault. **/ + if (search_data == NULL) + { + fprintf(stderr, "Warning: Call to ci_SizeOfSearchData(NULL);\n"); + return 0u; + } + unsigned int size = 0u; if (search_data->Name != NULL) size += strlen(search_data->Name) * sizeof(char); if (search_data->Dups != NULL) size += search_data->nDups * (sizeof(void*) + sizeof(Dup)); @@ -2224,7 +2207,6 @@ static int ci_ComputeSourceData(pSourceData source_data, pObjSession session) if (!check(objCurrentDate(&source_data->DateComputed))) goto end; /** Open the source path specified by the .cluster file. **/ - tprintf("Opening...\n"); pObject obj = objOpen(session, source_data->SourcePath, OBJ_O_RDONLY, 0600, "system/directory"); if (obj == NULL) { @@ -2239,7 +2221,6 @@ static int ci_ComputeSourceData(pSourceData source_data, pObjSession session) } /** Generate a "query" for retrieving data. **/ - tprintf("Opening query...\n"); pObjQuery query = objOpenQuery(obj, NULL, NULL, NULL, NULL, 0); if (query == NULL) { @@ -2265,7 +2246,6 @@ static int ci_ComputeSourceData(pSourceData source_data, pObjSession session) if (!check(xaInit(&vector_xarray, 64))) goto end_free_data; /** Fetch data and build vectors. **/ - tprintf("Skips: "); while (true) { pObject entry = objQueryFetch(query, O_RDONLY); @@ -2307,7 +2287,6 @@ static int ci_ComputeSourceData(pSourceData source_data, pObjSession session) ret = objGetAttrValue(entry, source_data->NameAttr, DATA_T_STRING, POD(&data)); if (ret != 0) { - tprintf("\n"); mssErrorf(0, "Cluster", "Failed to value for %uth entry:\n" " > Attribute: ['%s':'%s' : String]\n" @@ -2326,7 +2305,6 @@ static int ci_ComputeSourceData(pSourceData source_data, pObjSession session) /** Skip empty strings. **/ if (strlen(data) == 0) { - tprintf("_"); check(fflush(stdout)); /* Failure ignored. */ continue; } @@ -2348,7 +2326,6 @@ static int ci_ComputeSourceData(pSourceData source_data, pObjSession session) if (ca_has_no_pairs(vector)) { /** Skip pVector with no pairs. **/ - tprintf("."); check(fflush(stdout)); /* Failure ignored. */ ca_free_vector(vector); continue; @@ -2391,7 +2368,6 @@ static int ci_ComputeSourceData(pSourceData source_data, pObjSession session) ret = objGetAttrValue(entry, source_data->KeyAttr, DATA_T_STRING, POD(&key)); if (ret != 0) { - tprintf("\n"); mssErrorf(0, "Cluster", "Failed to value for key on %uth entry:\n" " > Attribute: ['%s':'%s' : String]\n" @@ -2424,7 +2400,7 @@ static int ci_ComputeSourceData(pSourceData source_data, pObjSession session) // ret = ret; // Fall-through: Failure ignored. } } - tprintf("\nData acquired.\n"); + source_data->nVectors = vector_xarray.nItems; if (source_data->nVectors == 0) { @@ -2449,7 +2425,6 @@ static int ci_ComputeSourceData(pSourceData source_data, pObjSession session) if (source_data->Vectors == NULL) goto end_free_data; /** Success. **/ - fprintf(stderr, "[SourceData: %s] Compute done.\n", source_data->Name); successful = true; end_free_data: @@ -2539,7 +2514,6 @@ static int ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data) { case ALGORITHM_NONE: { - tprintf("Applying no clustering...\n"); /** Put all the data into one cluster. **/ pCluster first_cluster = &cluster_data->Clusters[0]; first_cluster->Size = source_data->nVectors; @@ -2554,13 +2528,11 @@ static int ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data) case ALGORITHM_SLIDING_WINDOW: /** Computed in each search for efficiency. **/ - tprintf("Skipping sliding window clustering...\n"); memset(cluster_data->Clusters, 0, clusters_size); break; case ALGORITHM_KMEANS: { - tprintf("Applying kmeans clustering...\n"); /** Check for unimplemented similarity measures. **/ if (cluster_data->SimilarityMeasure != SIMILARITY_COSINE) { @@ -2577,7 +2549,6 @@ static int ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data) if (labels == NULL) goto err_free_sims; /** Run kmeans. **/ - tprintf("Running kmeans\n"); Timer timer_i, *timer = timer_start(timer_init(&timer_i)); const bool successful = check(ca_kmeans( source_data->Vectors, @@ -2589,7 +2560,6 @@ static int ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data) cluster_data->Sims )); timer_stop(timer); - tprintf("Clustering done after %.4lfs.\n", timer_get(timer)); if (!successful) goto err_free_sims; /** Convert the labels into clusters. **/ @@ -2636,7 +2606,6 @@ static int ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data) } /** Success. **/ - fprintf(stderr, "[ClusterData: %s] Compute done.\n", cluster_data->Name); return 0; err_free_sims: @@ -2692,8 +2661,6 @@ static int ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) /** Record the date and time. **/ if (!check(objCurrentDate(&search_data->DateComputed))) goto err; - tprintf("Invoking search.\n"); - Timer timer_i, *timer = timer_start(timer_init(&timer_i)); /** Execute the search using the specified source and comparison function. **/ pXArray dups = NULL, dups_temp = NULL; switch (search_data->SimilarityMeasure) @@ -2771,10 +2738,8 @@ static int ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) ); goto err_free; } - timer_stop(timer); if (dups_temp == NULL) goto err_free; else dups = dups_temp; - tprintf("Search done after %.4lfs.\n", timer_get(timer)); /** Store dups. **/ search_data->nDups = dups->nItems; @@ -2783,7 +2748,6 @@ static int ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) : ci_xaToTrimmedArray(dups, 2); /** Success. **/ - fprintf(stderr, "[SearchData: %s] Compute done.\n", search_data->Name); return 0; err_free: @@ -2817,7 +2781,6 @@ static int ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) ***/ static int ci_GetParamType(void* inf_v, const char* attr_name) { - tprintf("Call to ci_GetParamType(\"%s\")\n", attr_name); pNodeData node_data = (pNodeData)inf_v; /** Find the parameter. **/ @@ -2861,7 +2824,6 @@ static int ci_GetParamType(void* inf_v, const char* attr_name) ***/ static int ci_GetParamValue(void* inf_v, char* attr_name, int datatype, pObjData val) { - tprintf("Call to ci_GetParamValue(\"%s\", %s)\n", attr_name, ci_TypeToStr(datatype)); pNodeData node_data = (pNodeData)inf_v; /** Find the parameter. **/ @@ -2896,7 +2858,6 @@ static int ci_GetParamValue(void* inf_v, char* attr_name, int datatype, pObjData /** Not implemented. **/ static int ci_SetParamValue(void* inf_v, char* attr_name, int datatype, pObjData val) { - tprintf("Call to ci_SetParamValue(%s, %s)\n", attr_name, ci_TypeToStr(datatype)); mssErrorf(1, "Cluster", "SetParamValue() is not implemented because clusters are imutable."); return -1; } @@ -2923,7 +2884,7 @@ static int ci_SetParamValue(void* inf_v, char* attr_name, int datatype, pObjData ***/ void* clusterOpen(pObject parent, int mask, pContentType sys_type, char* usr_type, pObjTrxTree* oxt) { - tprintf("Warning: clusterOpen(\"%s\") is under active development.\n", ci_file_name(parent)); + /** Update statistics. **/ ClusterStatistics.OpenCalls++; /** If CREAT and EXCL are specified, exclusively create it, failing if the file already exists. **/ @@ -2973,12 +2934,10 @@ void* clusterOpen(pObject parent, int mask, pContentType sys_type, char* usr_typ driver_data->NodeData = node_data; /** Detect target from path. **/ - tprintf("Parsing node path: %d %d\n", parent->SubPtr, parent->SubCnt); parent->SubCnt = 0; char* target_name = obj_internal_PathPart(parent->Pathname, parent->SubPtr + parent->SubCnt++, 1); if (target_name == NULL) { /** Target found: Root **/ - tprintf("Found target: Root.\n"); driver_data->TargetType = TARGET_ROOT; driver_data->TargetData = (void*)driver_data->NodeData->SourceData; return (void*)driver_data; /* Success. */ @@ -2992,7 +2951,6 @@ void* clusterOpen(pObject parent, int mask, pContentType sys_type, char* usr_typ /** Target found: Cluster **/ driver_data->TargetType = TARGET_CLUSTER; - tprintf("Found target cluster: %s\n", cluster->Name); /** Check for sub-clusters in the path. **/ while (true) @@ -3014,7 +2972,6 @@ void* clusterOpen(pObject parent, int mask, pContentType sys_type, char* usr_typ if (strcmp(sub_cluster->Name, path_part) != 0) continue; /** Target found: Sub-cluster **/ - tprintf("Found target sub-cluster: %s\n", sub_cluster->Name); cluster = sub_cluster; goto continue_descent; } @@ -3045,7 +3002,6 @@ void* clusterOpen(pObject parent, int mask, pContentType sys_type, char* usr_typ mssErrorf(1, "Cluster", "Unknown path part %s.", extra_data); goto err_free_node; } - tprintf("Found target search: %s %d %d\n", search->Name, parent->SubPtr, parent->SubCnt); return (void*)driver_data; /* Success. */ } @@ -3088,7 +3044,6 @@ void* clusterOpen(pObject parent, int mask, pContentType sys_type, char* usr_typ ***/ int clusterClose(void* inf_v, pObjTrxTree* oxt) { - tprintf("Warning: clusterClose() is under active development.\n"); pDriverData driver_data = (pDriverData)inf_v; ClusterStatistics.CloseCalls++; @@ -3124,7 +3079,6 @@ int clusterClose(void* inf_v, pObjTrxTree* oxt) void* clusterOpenQuery(void* inf_v, pObjQuery query, pObjTrxTree* oxt) { ClusterStatistics.OpenQueryCalls++; - tprintf("Warning: clusterOpenQuery() is under active development.\n"); pClusterQuery cluster_query = check_ptr(nmMalloc(sizeof(ClusterQuery))); if (cluster_query == NULL) return NULL; cluster_query->DriverData = (pDriverData)inf_v; @@ -3148,10 +3102,11 @@ void* clusterOpenQuery(void* inf_v, pObjQuery query, pObjTrxTree* oxt) void* clusterQueryFetch(void* qy_v, pObject obj, int mode, pObjTrxTree* oxt) { int ret; - ClusterStatistics.FetchCalls++; -// tprintf("Warning: clusterQueryFetch() is under active development.\n"); pClusterQuery cluster_query = (pClusterQuery)qy_v; + /** Update statistics. **/ + ClusterStatistics.FetchCalls++; + /** Ensure that the data being fetched exists and is computed. **/ TargetType target_type = cluster_query->DriverData->TargetType, new_target_type; unsigned int data_amount = 0u; @@ -3199,10 +3154,6 @@ void* clusterQueryFetch(void* qy_v, pObject obj, int mode, pObjTrxTree* oxt) mssErrorf(1, "Cluster", "Unknown target type %u.", target_type); goto err; } - tprintf("Fetch Index: %u/16 (total: %u)\n", cluster_query->RowIndex, data_amount); - - /** Cap results to 16 for faster debugging. TODO: Israel - Remove. **/ -// data_amount = min(data_amount, 16); /** Check that the requested data exists, returning null if we've reached the end of the data. **/ if (cluster_query->RowIndex >= data_amount) return NULL; @@ -3233,9 +3184,7 @@ void* clusterQueryFetch(void* qy_v, pObject obj, int mode, pObjTrxTree* oxt) *** @returns 0, success. ***/ int clusterQueryClose(void* qy_v, pObjTrxTree* oxt) - { -// tprintf("Warning: clusterQueryClose() is under active development.\n"); - + { nmFree(qy_v, sizeof(ClusterQuery)); return 0; } @@ -3254,6 +3203,8 @@ int clusterQueryClose(void* qy_v, pObjTrxTree* oxt) int clusterGetAttrType(void* inf_v, char* attr_name, pObjTrxTree* oxt) { pDriverData driver_data = (pDriverData)inf_v; + + /** Update statistics. **/ ClusterStatistics.GetTypeCalls++; /** Guard possible segfault. **/ @@ -3266,10 +3217,6 @@ int clusterGetAttrType(void* inf_v, char* attr_name, pObjTrxTree* oxt) /** Performance shortcut for frequently requested attributes: key1, key2, and sim. **/ if (attr_name[0] == 'k' || attr_name[0] == 's') goto handle_targets; - /** Debug info. **/ - if (oxt == NULL) tprintf(" > "); - tprintf("Call to clusterGetAttrType(%s)\n", attr_name); - /** Types for general attributes. **/ if (strcmp(attr_name, "name") == 0 || strcmp(attr_name, "annotation") == 0 @@ -3374,9 +3321,6 @@ int clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val || (attr_name[0] == 's' && datatype == DATA_T_DOUBLE) /* sim : double */ ) goto handle_targets; - /** Debug info. **/ - tprintf("Call to clusterGetAttrValue(%s)\n", attr_name); - /** Type check. **/ const int expected_datatype = clusterGetAttrType(inf_v, attr_name, NULL); if (datatype != expected_datatype) @@ -3665,7 +3609,6 @@ int clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val ***/ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pObjTrxTree* oxt) { - tprintf("Warning: clusterPresentationHints(\"%s\") is under active development.", attr_name); pDriverData driver_data = (pDriverData)inf_v; /** Malloc presentation hints struct. **/ @@ -3795,7 +3738,7 @@ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pOb /** Min and max values. **/ hints->MinValue = expCompileExpression("0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); - char buf[4u]; + char buf[8]; snprintf(buf, sizeof(buf), "%d", nClusteringAlgorithms); hints->MaxValue = expCompileExpression(buf, tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); @@ -3825,7 +3768,7 @@ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pOb /** Min and max values. **/ hints->MinValue = expCompileExpression("0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); - char buf[4u]; + char buf[8]; snprintf(buf, sizeof(buf), "%d", nSimilarityMeasures); hints->MaxValue = expCompileExpression(buf, tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); @@ -3962,7 +3905,6 @@ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pOb ***/ char* clusterGetFirstAttr(void* inf_v, pObjTrxTree* oxt) { - tprintf("Warning: clusterGetFirstAttr() is under active development.\n"); pDriverData driver_data = (pDriverData)inf_v; driver_data->TargetAttrIndex = 0u; return clusterGetNextAttr(inf_v, oxt); @@ -3981,10 +3923,8 @@ char* clusterGetFirstAttr(void* inf_v, pObjTrxTree* oxt) ***/ char* clusterGetNextAttr(void* inf_v, pObjTrxTree* oxt) { - tprintf("Warning: clusterGetNextAttr("); pDriverData driver_data = (pDriverData)inf_v; const unsigned int i = driver_data->TargetAttrIndex++; - tprintf("%u) is under active development.\n", i); switch (driver_data->TargetType) { case TARGET_ROOT: return ATTR_ROOT[i]; @@ -4009,7 +3949,6 @@ char* clusterGetNextAttr(void* inf_v, pObjTrxTree* oxt) ***/ int clusterInfo(void* inf_v, pObjectInfo info) { - tprintf("Warning: clusterInfo() is under active development.\n"); pDriverData driver_data = (pDriverData)inf_v; pNodeData node_data = (pNodeData)driver_data->NodeData; @@ -4073,7 +4012,6 @@ int clusterInfo(void* inf_v, pObjectInfo info) goto err; } - tprintf("Info result: "INT_TO_BINARY_PATTERN"\n", INT_TO_BINARY(info->Flags)); return 0; err: @@ -4097,7 +4035,6 @@ int clusterInfo(void* inf_v, pObjectInfo info) ***/ char* clusterGetFirstMethod(void* inf_v, pObjTrxTree* oxt) { - tprintf("Warning: clusterGetFirstMethod() is under active development.\n"); pDriverData driver_data = (pDriverData)inf_v; driver_data->TargetMethodIndex = 0u; return clusterGetNextMethod(inf_v, oxt); @@ -4116,7 +4053,6 @@ char* clusterGetFirstMethod(void* inf_v, pObjTrxTree* oxt) ***/ char* clusterGetNextMethod(void* inf_v, pObjTrxTree* oxt) { - tprintf("Warning: clusterGetNextMethod() is under active development."); pDriverData driver_data = (pDriverData)inf_v; return METHOD_NAME[driver_data->TargetMethodIndex++]; } @@ -4197,7 +4133,6 @@ static void ci_CacheFreeSourceData(pXHashEntry entry, void* path) if (path != NULL && strncmp(key, (char*)path, strlen((char*)path)) != 0) return; /** Free data. **/ - tprintf("- source: \"%s\"\n", key); ci_FreeSourceData(source_data); nmSysFree(key); } @@ -4215,7 +4150,6 @@ static void ci_CacheFreeCluster(pXHashEntry entry, void* path) if (path != NULL && strncmp(key, (char*)path, strlen((char*)path)) != 0) return; /** Free data. **/ - tprintf("- cluster: \"%s\"\n", key); ci_FreeClusterData(cluster_data, false); nmSysFree(key); } @@ -4233,7 +4167,6 @@ static void ci_CacheFreeSearch(pXHashEntry entry, void* path) if (path != NULL && strncmp(key, (char*)path, strlen((char*)path)) != 0) return; /** Free data. **/ - tprintf("- search: \"%s\"\n", key); ci_FreeSearchData(search_data); nmSysFree(key); } @@ -4249,7 +4182,6 @@ static void ci_CacheFreeSearch(pXHashEntry entry, void* path) ***/ int clusterExecuteMethod(void* inf_v, char* method_name, pObjData param, pObjTrxTree* oxt) { - tprintf("Warning: clusterExecuteMethod(\"%s\") is under active development.\n", method_name); pDriverData driver_data = (pDriverData)inf_v; /** Cache management method. **/ @@ -4266,7 +4198,7 @@ int clusterExecuteMethod(void* inf_v, char* method_name, pObjData param, pObjTrx goto err; } - /** show and show_all. **/ + /** 'show' and 'show_all'. **/ bool show = false; if (strcmp(param->String, "show") == 0) { @@ -4323,18 +4255,11 @@ int clusterExecuteMethod(void* inf_v, char* method_name, pObjData param, pObjTrx return ret; } - /** drop_all. **/ + /** 'drop_all'. **/ if (strcmp(param->String, "drop_all") == 0) { - /** Print info. **/ - printf("\nDropping cache for "); - if (path != NULL) printf("\"%s\":\n", path); - else printf("all files:\n"); - - /** Free caches. **/ + printf("\nDropping cache for all files:\n"); ci_ClearCaches(); - - tprintf("Cache dropped.\n"); return 0; } @@ -4348,29 +4273,19 @@ int clusterExecuteMethod(void* inf_v, char* method_name, pObjData param, pObjTrx if (strcmp(method_name, "stat") == 0) { - unsigned long long ExpectedOpenCalls = 10666; - unsigned long long ExpectedOpenQueryCalls = 10665; - unsigned long long ExpectedFetchCalls = 3368007; - unsigned long long ExpectedCloseCalls = 3368007; - unsigned long long ExpectedGetTypeCalls = 26664164; - unsigned long long ExpectedGetValCalls = 15021419; - unsigned long long ExpectedGetValCalls_name = 3368008; - unsigned long long ExpectedGetValCalls_key1 = 3357342; - unsigned long long ExpectedGetValCalls_key2 = 1574; - unsigned long long ExpectedGetValCalls_sim = 8283829; char buf[12]; printf("Cluster Driver Statistics:\n"); - printf(" Stat Name Value\n"); - printf(" OpenCalls %10s / %10s (%.4g%%)\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.OpenCalls), snprint_llu(buf, sizeof(buf), ExpectedOpenCalls), ClusterStatistics.OpenCalls / ExpectedOpenCalls * 100.0); - printf(" OpenQueryCalls %10s / %10s (%.4g%%)\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.OpenQueryCalls), snprint_llu(buf, sizeof(buf), ExpectedOpenQueryCalls), ClusterStatistics.OpenQueryCalls / ExpectedOpenQueryCalls * 100.0); - printf(" FetchCalls %10s / %10s (%.4g%%)\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.FetchCalls), snprint_llu(buf, sizeof(buf), ExpectedFetchCalls), ClusterStatistics.FetchCalls / ExpectedFetchCalls * 100.0); - printf(" CloseCalls %10s / %10s (%.4g%%)\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.CloseCalls), snprint_llu(buf, sizeof(buf), ExpectedCloseCalls), ClusterStatistics.CloseCalls / ExpectedCloseCalls * 100.0); - printf(" GetTypeCalls %10s / %10s (%.4g%%)\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.GetTypeCalls), snprint_llu(buf, sizeof(buf), ExpectedGetTypeCalls), ClusterStatistics.GetTypeCalls / ExpectedGetTypeCalls * 100.0); - printf(" GetValCalls %10s / %10s (%.4g%%)\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.GetValCalls), snprint_llu(buf, sizeof(buf), ExpectedGetValCalls), ClusterStatistics.GetValCalls / ExpectedGetValCalls * 100.0); - printf(" GetValCalls_name %10s / %10s (%.4g%%)\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.GetValCalls_name), snprint_llu(buf, sizeof(buf), ExpectedGetValCalls_name), ClusterStatistics.GetValCalls_name / ExpectedGetValCalls_name * 100.0); - printf(" GetValCalls_key1 %10s / %10s (%.4g%%)\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.GetValCalls_key1), snprint_llu(buf, sizeof(buf), ExpectedGetValCalls_key1), ClusterStatistics.GetValCalls_key1 / ExpectedGetValCalls_key1 * 100.0); - printf(" GetValCalls_key2 %10s / %10s (%.4g%%)\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.GetValCalls_key2), snprint_llu(buf, sizeof(buf), ExpectedGetValCalls_key2), ClusterStatistics.GetValCalls_key2 / ExpectedGetValCalls_key2 * 100.0); - printf(" GetValCalls_sim %10s / %10s (%.4g%%)\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.GetValCalls_sim), snprint_llu(buf, sizeof(buf), ExpectedGetValCalls_sim), ClusterStatistics.GetValCalls_sim / ExpectedGetValCalls_sim * 100.0); + printf(" Stat Name Value\n"); + printf(" OpenCalls %8s\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.OpenCalls)); + printf(" OpenQueryCalls %8s\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.OpenQueryCalls)); + printf(" FetchCalls %8s\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.FetchCalls)); + printf(" CloseCalls %8s\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.CloseCalls)); + printf(" GetTypeCalls %8s\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.GetTypeCalls)); + printf(" GetValCalls %8s\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.GetValCalls)); + printf(" GetValCalls_name %8s\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.GetValCalls_name)); + printf(" GetValCalls_key1 %8s\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.GetValCalls_key1)); + printf(" GetValCalls_key2 %8s\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.GetValCalls_key2)); + printf(" GetValCalls_sim %8s\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.GetValCalls_sim)); return 0; } @@ -4473,7 +4388,7 @@ int clusterInitialize(void) if (check_ptr(strcpy(drv->Name, "cluster - Clustering Driver")) == NULL) goto err; if (!check(xaInit(&drv->RootContentTypes, 1))) goto err; if (!check_neg(xaAddItem(&drv->RootContentTypes, "system/cluster"))) goto err; - drv->Capabilities = 0; /* TODO: Greg - Should I add any of these? */ + drv->Capabilities = 0; /* TODO: Greg - Should I indicate any capabilities? */ /** Setup the function references. **/ drv->Open = clusterOpen; @@ -4523,6 +4438,6 @@ int clusterInitialize(void) /** Error cleanup. **/ err: if (drv != NULL) nmFree(drv, sizeof(ObjDriver)); - fprintf(stderr, "Error: Failed to initialize cluster driver.\n"); + mssErrorf(1, "Cluster", "Failed to initialize cluster driver.\n"); return -1; } From 81a1d2fd3c46edd7b511f877afb60071f73497fe Mon Sep 17 00:00:00 2001 From: Israel Date: Fri, 14 Nov 2025 12:05:39 -0700 Subject: [PATCH 010/275] Clean up unintended usage of glyph.h --- centrallix-lib/src/clusters.c | 124 ---------------------------------- 1 file changed, 124 deletions(-) diff --git a/centrallix-lib/src/clusters.c b/centrallix-lib/src/clusters.c index 4a96b6ca1..ef2336269 100644 --- a/centrallix-lib/src/clusters.c +++ b/centrallix-lib/src/clusters.c @@ -42,7 +42,6 @@ #include #include "clusters.h" -#include "glyph.h" #include "newmalloc.h" #include "util.h" #include "xarray.h" @@ -199,108 +198,6 @@ pVector ca_build_vector(const char* str) return trimmed_sparse_vector; } -// Build vector by converting a dense vector to a sparse one. -//pVector ca_build_vector_old(const char* str) -// { -// /** Allocate space for a dense vector. **/ -// unsigned int dense_vector[CA_NUM_DIMS] = {0u}; -// -// /** j is the former character, i is the latter. **/ -// const unsigned int num_chars = (unsigned int)strlen(str); -// for (unsigned int j = 65535u, i = 0u; i <= num_chars; i++) -// { -// if (isspace(str[i])) continue; -// if (ispunct(str[i]) && str[i] != CA_BOUNDARY_CHAR) continue; -// -// /** First and last character should fall one before 'a' in the ASCII table. **/ -// unsigned int temp1 = (j == 65535u) ? CA_BOUNDARY_CHAR : (unsigned int)tolower(str[j]); -// unsigned int temp2 = (i == num_chars) ? CA_BOUNDARY_CHAR : (unsigned int)tolower(str[i]); -// -// /** Shift numbers to the end of the lowercase letters. **/ -// if ('0' <= temp1 && temp1 <= '9') temp1 += 75u; -// if ('0' <= temp2 && temp2 <= '9') temp2 += 75u; -// -// /** Hash the character pair into an index (dimension). **/ -// /** Note that temp will be between 97 ('a') and 132 ('9'). **/ -// unsigned int dim = hash_char_pair(temp1, temp2); -// -// /** Increment the dimension of the dense vector by a number from 1 to 13. **/ -// dense_vector[dim] += (temp1 + temp2) % 13u + 1u; -// -// j = i; -// } -// -// /** Count how much space is needed for a sparse vector. **/ -// bool zero_prev = false; -// size_t size = 0u; -// for (unsigned int dim = 0u; dim < CA_NUM_DIMS; dim++) -// { -// if (dense_vector[dim] == 0u) -// { -// size += (zero_prev) ? 0u : 1u; -// zero_prev = true; -// } -// else -// { -// size++; -// zero_prev = false; -// } -// } -// -// /*** Check compression size. -// *** If this check fails, I doubt anything will break. However, the longest -// *** word I know (supercalifragilisticexpialidocious) has only 35 character -// *** pairs, so it shouldn't reach half this size (and it'd be even shorter -// *** if the hash generates at least one collision). -// *** -// *** Bad vector compression will result in degraded performace and increased -// *** memory usage. This indicates a likely bug in the code. Thus, if this -// *** warning is ever generated, it is definitely worth investigating. -// ***/ -// const size_t expected_max_size = 256u; -// if (size > expected_max_size) -// { -// fprintf(stderr, -// "cli_build_vector(\"%s\") - Warning: Sparse vector larger than expected.\n" -// " > Size: %lu\n" -// " > #Dims: %u\n", -// str, -// size, -// CA_NUM_DIMS -// ); -// } -// -// /** Allocate space for sparse vector. **/ -// const size_t sparse_vector_size = size * sizeof(int); -// pVector sparse_vector = (pVector)check_ptr(nmSysMalloc(sparse_vector_size)); -// if (sparse_vector == NULL) return NULL; -// -// /** Convert the dense vector above to a sparse vector. **/ -// unsigned int dim = 0u, sparse_idx = 0u; -// while (dim < CA_NUM_DIMS) -// { -// if (dense_vector[dim] == 0u) -// { -// /** Count and store consecutive zeros, skipping the first one. **/ -// unsigned int zero_count = 1u; -// dim++; -// while (dim < CA_NUM_DIMS && dense_vector[dim] == 0u) -// { -// zero_count++; -// dim++; -// } -// sparse_vector[sparse_idx++] = (int)-zero_count; -// } -// else -// { -// /** Store the value. **/ -// sparse_vector[sparse_idx++] = (int)dense_vector[dim++]; -// } -// } -// -// return sparse_vector; -// } - /*** Free memory allocated to store a sparse vector. *** *** @param sparse_vector The sparse vector being freed. @@ -837,17 +734,10 @@ int ca_kmeans( } } - /** Setup debug visualizations. **/ - glyph_init(iter, "\n", 1, false); - glyph_init(find, ".", 64, false); - glyph_init(update_label, "!", 16, false); - glyph_init(update_centroid, ":", 8, false); - /** Main kmeans loop. **/ double old_average_cluster_size = 1.0; for (unsigned int iter = 0u; iter < max_iter; iter++) { - glyph(iter); bool changed = false; /** Reset new centroids. **/ @@ -861,7 +751,6 @@ int ca_kmeans( /** Assign each point to the nearest centroid. **/ for (unsigned int i = 0u; i < num_vectors; i++) { - glyph(find); const pVector vector = vectors[i]; double min_dist = DBL_MAX; unsigned int best_centroid_label = 0u; @@ -880,7 +769,6 @@ int ca_kmeans( /** Update label to new centroid, if necessary. **/ if (labels[i] != best_centroid_label) { - glyph(update_label); labels[i] = best_centroid_label; changed = true; } @@ -902,7 +790,6 @@ int ca_kmeans( /** Update centroids. **/ for (unsigned int i = 0u; i < num_clusters; i++) { - glyph(update_centroid); if (cluster_counts[i] == 0u) continue; pCentroid centroid = centroids[i]; const pCentroid new_centroid = new_centroids[i]; @@ -926,8 +813,6 @@ int ca_kmeans( vector_sims[i] = sparse_similarity_to_centroid(vectors[i], centroids[labels[i]]); } - glyph_print("\n"); - /** Success. **/ successful = true; @@ -1028,25 +913,17 @@ pXArray ca_sliding_search( if (dups == NULL) goto err; } const int num_starting_dups = dups->nItems; - - /** Setup debug visualizations. **/ - glyph_init(outer, " ", 4, true); - glyph_init(inner, ".", 128, false); - glyph_init(find, "!", 32, false); /** Search for dups. **/ for (unsigned int i = 0u; i < num_data; i++) { - glyph(outer); const unsigned int window_start = i + 1u; const unsigned int window_end = min(i + window_size, num_data); for (unsigned int j = window_start; j < window_end; j++) { - glyph(inner); const double sim = similarity(data[i], data[j]); if (sim > threshold) /* Dup found! */ { - glyph(find); Dup* dup = (Dup*)check_ptr(nmMalloc(sizeof(Dup))); if (dup == NULL) goto err_free_dups; if (maybe_keys != NULL) @@ -1059,7 +936,6 @@ pXArray ca_sliding_search( } } } - glyph_print("\n"); /** Success. **/ return dups; From e624d40b242d8cd5644c05f243688eb6da13f53e Mon Sep 17 00:00:00 2001 From: Israel Date: Fri, 14 Nov 2025 16:10:00 -0700 Subject: [PATCH 011/275] Attempt to reduce issues from ambiguously signed chars. --- centrallix-lib/include/clusters.h | 2 +- centrallix-lib/src/clusters.c | 16 ++++++++++++---- 2 files changed, 13 insertions(+), 5 deletions(-) diff --git a/centrallix-lib/include/clusters.h b/centrallix-lib/include/clusters.h index 05480e742..ffa1223fb 100644 --- a/centrallix-lib/include/clusters.h +++ b/centrallix-lib/include/clusters.h @@ -49,7 +49,7 @@ /// LINK ../../centrallix-sysdoc/string_comparison.md#cosine_charsets /** The character used to create a pair with the first and last characters of a string. **/ -#define CA_BOUNDARY_CHAR ('a' - 1) +#define CA_BOUNDARY_CHAR (unsigned char)('a' - 1) /** Types. **/ typedef int* pVector; /* Sparse vector. */ diff --git a/centrallix-lib/src/clusters.c b/centrallix-lib/src/clusters.c index ef2336269..ba126e5f1 100644 --- a/centrallix-lib/src/clusters.c +++ b/centrallix-lib/src/clusters.c @@ -53,7 +53,7 @@ *** @param c2 The second character in the pair. *** @returns The resulting hash. ***/ -static unsigned int hash_char_pair(const char c1, const char c2) +static unsigned int hash_char_pair(const unsigned char c1, const unsigned char c2) { const double sum = (c1 * c1 * c1) + (c2 * c2 * c2); const double scale = ((double)c1 + 1.0) / ((double)c2 + 1.0); @@ -121,12 +121,17 @@ static int charpair_cmp(const void *p1, const void *p2) ***/ pVector ca_build_vector(const char* str) { - char chars[strlen(str) + 2u]; + unsigned char chars[strlen(str) + 2u]; unsigned int num_chars = 0u; chars[num_chars++] = CA_BOUNDARY_CHAR; /* Starting boundary character. */ for (const char* char_ptr = str; *char_ptr != '\0'; char_ptr++) { - unsigned char c = *char_ptr; + char maybe_char = *char_ptr; + if (maybe_char < 0) + { + fprintf(stderr, "Warning: Unexpected negative char '%c' in string: \"%s\"\n", maybe_char, str); + } + unsigned char c = (unsigned char)maybe_char; /** Always consider boundary character in string. **/ if (c == CA_BOUNDARY_CHAR) goto skip_checks; @@ -175,7 +180,10 @@ pVector ca_build_vector(const char* str) /** Dividing value by 2 each time reduces the impact of repeated pairs. **/ int value = 0; for (; i < num_pairs && char_pairs[i].hash == hash; i++) - value = (value / 2) + ((unsigned int)char_pairs[i].c1 + (unsigned int)char_pairs[i].c2) % 13u + 1u; + { + value /= 2; /* Reduce impact of repeated pairs. */ + value += ((unsigned int)char_pairs[i].c1 + (unsigned int)char_pairs[i].c2) % 13u + 1u; + } /** Skip zeros to reach the dimension index specified by the hash. **/ unsigned int num_zeros = hash - dim; From b0e000bfa58535b3a73b79e4f2dcec0e60f3553b Mon Sep 17 00:00:00 2001 From: Israel Date: Mon, 17 Nov 2025 10:43:37 -0700 Subject: [PATCH 012/275] All tests now pass. --- centrallix-lib/src/clusters.c | 7 +- centrallix/tests/test_cos_compare_00.cmp | 18 +- centrallix/tests/test_cos_compare_00.to | 23 ++- .../tests/test_expfn_double_metaphone_00.to | 161 ------------------ ...one_00.cmp => test_expfn_metaphone_00.cmp} | 0 centrallix/tests/test_expfn_metaphone_00.to | 161 ++++++++++++++++++ centrallix/tests/test_fuzzycompare_00.cmp | 13 -- centrallix/tests/test_fuzzycompare_00.to | 15 -- centrallix/tests/test_lev_compare_00.cmp | 23 +++ centrallix/tests/test_lev_compare_00.to | 28 +++ centrallix/tests/test_levenshtein_00.cmp | 24 ++- centrallix/tests/test_levenshtein_00.to | 29 +++- centrallix/tests/test_similarity_00.cmp | 5 - centrallix/tests/test_similarity_00.to | 7 - 14 files changed, 281 insertions(+), 233 deletions(-) delete mode 100644 centrallix/tests/test_expfn_double_metaphone_00.to rename centrallix/tests/{test_expfn_double_metaphone_00.cmp => test_expfn_metaphone_00.cmp} (100%) create mode 100644 centrallix/tests/test_expfn_metaphone_00.to delete mode 100644 centrallix/tests/test_fuzzycompare_00.cmp delete mode 100644 centrallix/tests/test_fuzzycompare_00.to create mode 100644 centrallix/tests/test_lev_compare_00.cmp create mode 100644 centrallix/tests/test_lev_compare_00.to delete mode 100644 centrallix/tests/test_similarity_00.cmp delete mode 100644 centrallix/tests/test_similarity_00.to diff --git a/centrallix-lib/src/clusters.c b/centrallix-lib/src/clusters.c index ba126e5f1..84f01c535 100644 --- a/centrallix-lib/src/clusters.c +++ b/centrallix-lib/src/clusters.c @@ -127,10 +127,7 @@ pVector ca_build_vector(const char* str) for (const char* char_ptr = str; *char_ptr != '\0'; char_ptr++) { char maybe_char = *char_ptr; - if (maybe_char < 0) - { - fprintf(stderr, "Warning: Unexpected negative char '%c' in string: \"%s\"\n", maybe_char, str); - } + if (maybe_char < 0) fprintf(stderr, "Warning: Unexpected negative char '%c' in string: \"%s\"\n", maybe_char, str); unsigned char c = (unsigned char)maybe_char; /** Always consider boundary character in string. **/ @@ -181,7 +178,7 @@ pVector ca_build_vector(const char* str) int value = 0; for (; i < num_pairs && char_pairs[i].hash == hash; i++) { - value /= 2; /* Reduce impact of repeated pairs. */ + // value /= 2; /* Reduce impact of repeated pairs. */ value += ((unsigned int)char_pairs[i].c1 + (unsigned int)char_pairs[i].c2) % 13u + 1u; } diff --git a/centrallix/tests/test_cos_compare_00.cmp b/centrallix/tests/test_cos_compare_00.cmp index d586365f7..2061443ac 100644 --- a/centrallix/tests/test_cos_compare_00.cmp +++ b/centrallix/tests/test_cos_compare_00.cmp @@ -1,7 +1,11 @@ -Attribute [case1]: integer 1 -Attribute [case2]: integer 1 -Attribute [case3]: integer 1 -Attribute [case4]: integer 1 -Attribute [case5]: integer 1 -Attribute [case6]: integer 1 -Attribute [case7]: integer 1 +Attribute [case1]: string "pass" +Attribute [case2]: string "pass" +Attribute [case3]: string "pass" +Attribute [case4]: string "pass" +Attribute [cynthia]: string "pass" +Attribute [timothy]: string "pass" +Attribute [lance]: string "pass" +Attribute [gregory]: string "pass" +Attribute [nathan]: string "pass" +Attribute [identical]: string "pass" +Attribute [name]: string "pass" diff --git a/centrallix/tests/test_cos_compare_00.to b/centrallix/tests/test_cos_compare_00.to index 5bf950514..f45dec13a 100644 --- a/centrallix/tests/test_cos_compare_00.to +++ b/centrallix/tests/test_cos_compare_00.to @@ -1,17 +1,24 @@ ##NAME Text Mining String Similarity with Cosine Compare -# All email addresses and phone numbers are imaginary and were fabricated for the purposes of this test +# Basic tests of cosine similarity. +query select case1 = condition((cos_compare('hello', 'hello') >= 0.999) and (cos_compare('hello', 'hello') <= 1.0), "pass", "fail") +query select case2 = condition((cos_compare('hello', 'zephora') <= 0.001) and (cos_compare('hello', 'zephora') >= 0.0), "pass", "fail") +query select case3 = condition((cos_compare('hello', 'hello world') <= 0.7) and (cos_compare('hello', 'hello world') >= 0.6), "pass", "fail") +query select case4 = condition((cos_compare('hello there', 'hellow there') >= 0.9) and (cos_compare('hello', 'hellow') <= 1.0), "pass", "fail") + -query select case1 = (cos_compare("Cynthia Adams; cynthiaadams@gmail.com; 720-769-1293", "Timothy Adams; thetbear@gmail.com; 720-891-1470") >= 0.49) and (cos_compare("Cynthia Adams; cynthiaadams@gmail.com; 720-769-1293", "Timothy Adams; thetbear@gmail.com; 720-891-1470") <= 0.54) +# Tests on fabricated contact information. +# All email addresses and phone numbers are imaginary and were fabricated for the purposes of this test +query select cynthia = condition((cos_compare("Cynthia Adams; cynthiaadams@gmail.com; 720-769-1293", "Timothy Adams; thetbear@gmail.com; 720-891-1470") >= 0.49) and (cos_compare("Cynthia Adams; cynthiaadams@gmail.com; 720-769-1293", "Timothy Adams; thetbear@gmail.com; 720-891-1470") <= 0.54), "pass", "fail") -query select case2 = (cos_compare("Timothy Adams; thetbear@gmail.com; 720-891-1470", "Lance Freson; lancetheturtle@gmail.com; 720-111-8189") >= 0.425) and (cos_compare("Timothy Adams; thetbear@gmail.com; 720-891-1470", "Lance Freson; lancetheturtle@gmail.com; 720-111-8189") <= 0.475) +query select timothy = condition((cos_compare("Timothy Adams; thetbear@gmail.com; 720-891-1470", "Lance Freson; lancetheturtle@gmail.com; 720-111-8189") >= 0.425) and (cos_compare("Timothy Adams; thetbear@gmail.com; 720-891-1470", "Lance Freson; lancetheturtle@gmail.com; 720-111-8189") <= 0.475), "pass", "fail") -query select case3 = (cos_compare("Lance Freson; lancetheturtle@gmail.com; 720-111-8189", "Gregory Freson; greatgregory@gmail.com; 720-198-5791") >= 0.35) and (cos_compare("Lance Freson; lancetheturtle@gmail.com; 720-111-8189", "Gregory Freson; greatgregory@gmail.com; 720-198-5791") <= 0.40) +query select lance = condition((cos_compare("Lance Freson; lancetheturtle@gmail.com; 720-111-8189", "Gregory Freson; greatgregory@gmail.com; 720-198-5791") >= 0.35) and (cos_compare("Lance Freson; lancetheturtle@gmail.com; 720-111-8189", "Gregory Freson; greatgregory@gmail.com; 720-198-5791") <= 0.40), "pass", "fail") -query select case4 = (cos_compare("Gregory Freson; greatgregory@gmail.com; 720-198-5791", "Gregory Freson; greatgregory@gmail.co; 720-198-5791") >= 0.94) and (cos_compare("Gregory Freson; greatgregory@gmail.com; 720-198-5791", "Gregory Freson; greatgregory@gmail.co; 720-198-5791") <= 0.99) +query select gregory = condition((cos_compare("Gregory Freson; greatgregory@gmail.com; 720-198-5791", "Gregory Freson; greatgregory@gmail.co; 720-198-5791") >= 0.94) and (cos_compare("Gregory Freson; greatgregory@gmail.com; 720-198-5791", "Gregory Freson; greatgregory@gmail.co; 720-198-5791") <= 0.99), "pass", "fail") -query select case5 = (cos_compare("Nathan Mayor; nmmayor@yahoo.com; +1-800-192-9128", "Mindy Mayor; nmmayor@yahoo.com; 720-981-9149") >=0.66) and (cos_compare("Nathan Mayor; nmmayor@yahoo.com; +1-800-192-9128", "Mindy Mayor; nmmayor@yahoo.com; 720-981-9149") <= 0.71) +query select nathan = condition((cos_compare("Nathan Mayor; nmmayor@yahoo.com; +1-800-192-9128", "Mindy Mayor; nmmayor@yahoo.com; 720-981-9149") >= 0.66) and (cos_compare("Nathan Mayor; nmmayor@yahoo.com; +1-800-192-9128", "Mindy Mayor; nmmayor@yahoo.com; 720-981-9149") <= 0.71), "pass", "fail") -query select case6 = (cos_compare("This is an identical case", "This is an identical case") >=0.975) and (cos_compare("This is an identical case", "This is an identical case") <=1.00) +query select identical = condition((cos_compare("This is an identical case", "This is an identical case") >= 0.975) and (cos_compare("This is an identical case", "This is an identical case") <= 1.00), "pass", "fail") -query select case7 = (cos_compare("Samuel", "Alex") >= 0.00) and (cos_compare("Samuel", "Alex") <= 0.025) +query select name = condition((cos_compare("Samuel", "Alex") >= 0.00) and (cos_compare("Samuel", "Alex") <= 0.025), "pass", "fail") diff --git a/centrallix/tests/test_expfn_double_metaphone_00.to b/centrallix/tests/test_expfn_double_metaphone_00.to deleted file mode 100644 index efd7548cc..000000000 --- a/centrallix/tests/test_expfn_double_metaphone_00.to +++ /dev/null @@ -1,161 +0,0 @@ -##NAME double_metaphone() function - -# Special thanks to the following websites for double checking the correct results: -# 1: https://words.github.io/double-metaphone -# 2: https://mainegenealogy.net/metaphone_converter.asp -# 3: https://en.toolpage.org/tool/metaphone - -# These tests were collected from the following sources: -# - Example comments in the source code of exp_double_metaphone.c -# - Maurice Aubrey's Tests* -# - Tests manually written by Israel Fuller -# - Tests written by prompting ChatGPT-5 (preview)** -# -# *Source: https://github.com/gitpan/Text-DoubleMetaphone/blob/master/t/words.txt -# **GPT-5 mini (Preview) was run in GitHub Copilot to suggest the words -# for some tests after analizing a generated coverage report. I (Israel) -# used the suggestions to write some "AI generated" test cases. -# -# For more information, see the manual test suite implementation at the -# end of the exp_double_metaphone.c file. - -query select result = double_metaphone("Test") -query select result = double_metaphone("Basic") -query select result = double_metaphone("Centrallix") -query select result = double_metaphone("Lawrence") -query select result = double_metaphone("Philips") -query select result = double_metaphone("Acceptingness") -query select result = double_metaphone("Supercalifragilisticexpialidocious") -query select result = double_metaphone("Suoicodilaipxecitsiligarfilacrepus") -query select result = double_metaphone("Smith") -query select result = double_metaphone("Schmidt") -query select result = double_metaphone("Snider") -query select result = double_metaphone("Schneider") -query select result = double_metaphone("Arnow") -query select result = double_metaphone("Arnoff") -query select result = double_metaphone("Accede") -query select result = double_metaphone("Accident") -query select result = double_metaphone("Actually") -query select result = double_metaphone("Arch") -query select result = double_metaphone("Artois") -query select result = double_metaphone("Bacchus") -query select result = double_metaphone("Bacci") -query select result = double_metaphone("Bajador") -query select result = double_metaphone("Bellocchio") -query select result = double_metaphone("Bertucci") -query select result = double_metaphone("Biaggi") -query select result = double_metaphone("Bough") -query select result = double_metaphone("Breaux") -query select result = double_metaphone("Broughton") -query select result = double_metaphone("Cabrillo") -query select result = double_metaphone("Caesar") -query select result = double_metaphone("Cagney") -query select result = double_metaphone("Campbell") -query select result = double_metaphone("Carlisle") -query select result = double_metaphone("Carlysle") -query select result = double_metaphone("Chemistry") -query select result = double_metaphone("Chianti") -query select result = double_metaphone("Chorus") -query select result = double_metaphone("Cough") -query select result = double_metaphone("Czerny") -query select result = double_metaphone("Dumb") -query select result = double_metaphone("Edgar") -query select result = double_metaphone("Edge") -query select result = double_metaphone("Filipowicz") -query select result = double_metaphone("Focaccia") -query select result = double_metaphone("Gallegos") -query select result = double_metaphone("Germanic") -query select result = double_metaphone("Ghiradelli") -query select result = double_metaphone("Ghislane") -query select result = double_metaphone("Gospel") -query select result = double_metaphone("Gough") -query select result = double_metaphone("Greek") -query select result = double_metaphone("Hochmeier") -query select result = double_metaphone("Hugh") -query select result = double_metaphone("Island") -query select result = double_metaphone("Isle") -query select result = double_metaphone("Italian") -query select result = double_metaphone("Jankelowicz") -query select result = double_metaphone("Jose") -query select result = double_metaphone("Laugh") -query select result = double_metaphone("Mac Caffrey") -query select result = double_metaphone("Mac Gregor") -query select result = double_metaphone("Manager") -query select result = double_metaphone("McHugh") -query select result = double_metaphone("McLaughlin") -query select result = double_metaphone("Michael") -query select result = double_metaphone("Middle") -query select result = double_metaphone("Orchestra") -query select result = double_metaphone("Orchid") -query select result = double_metaphone("Pinyin") -query select result = double_metaphone("Raspberry") -query select result = double_metaphone("Resnais") -query select result = double_metaphone("Rogier") -query select result = double_metaphone("Rough") -query select result = double_metaphone("Salvador") -query select result = double_metaphone("San jacinto") -query select result = double_metaphone("Schenker") -query select result = double_metaphone("Schermerhorn") -query select result = double_metaphone("Schlesinger") -query select result = double_metaphone("School") -query select result = double_metaphone("Schooner") -query select result = double_metaphone("Succeed") -query select result = double_metaphone("Sugar") -query select result = double_metaphone("Sugary") -query select result = double_metaphone("Tagliaro") -query select result = double_metaphone("Thames") -query select result = double_metaphone("Thomas") -query select result = double_metaphone("Thumb") -query select result = double_metaphone("Tichner") -query select result = double_metaphone("Tough") -query select result = double_metaphone("Vghee") -query select result = double_metaphone("Wachtler") -query select result = double_metaphone("Wechsler") -query select result = double_metaphone("Word") -query select result = double_metaphone("Xavier") -query select result = double_metaphone("Yankelovich") -query select result = double_metaphone("Zhao") -query select result = double_metaphone("McClellan") -query select result = double_metaphone("maurice") -query select result = double_metaphone("aubrey") -query select result = double_metaphone("cambrillo") -query select result = double_metaphone("heidi") -query select result = double_metaphone("katherine") -query select result = double_metaphone("catherine") -query select result = double_metaphone("richard") -query select result = double_metaphone("bob") -query select result = double_metaphone("eric") -query select result = double_metaphone("geoff") -query select result = double_metaphone("dave") -query select result = double_metaphone("ray") -query select result = double_metaphone("steven") -query select result = double_metaphone("bryce") -query select result = double_metaphone("randy") -query select result = double_metaphone("bryan") -query select result = double_metaphone("brian") -query select result = double_metaphone("otto") -query select result = double_metaphone("auto") -query select result = double_metaphone("Abbott") -query select result = double_metaphone("Back") -query select result = double_metaphone("Bacher") -query select result = double_metaphone("Charles") -query select result = double_metaphone("Ghana") -query select result = double_metaphone("Gnome") -query select result = double_metaphone("Raj") -query select result = double_metaphone("Quentin") -query select result = double_metaphone("Who") -query select result = double_metaphone("Shoemaker") -query select result = double_metaphone("Sian") -query select result = double_metaphone("Scold") -query select result = double_metaphone("Station") -query select result = double_metaphone("Match") -query select result = double_metaphone("Pizza") -query select result = double_metaphone("Agnes") -query select result = double_metaphone("Science") -query select result = double_metaphone("Van Gogh") -query select result = double_metaphone("Josef") -query select result = double_metaphone("Object") -query select result = double_metaphone("Sholz") -query select result = double_metaphone("Scharf") -query select result = double_metaphone("Kasia") -query select result = double_metaphone("Van Geller") diff --git a/centrallix/tests/test_expfn_double_metaphone_00.cmp b/centrallix/tests/test_expfn_metaphone_00.cmp similarity index 100% rename from centrallix/tests/test_expfn_double_metaphone_00.cmp rename to centrallix/tests/test_expfn_metaphone_00.cmp diff --git a/centrallix/tests/test_expfn_metaphone_00.to b/centrallix/tests/test_expfn_metaphone_00.to new file mode 100644 index 000000000..de1897c3e --- /dev/null +++ b/centrallix/tests/test_expfn_metaphone_00.to @@ -0,0 +1,161 @@ +##NAME metaphone() function + +# Special thanks to the following websites for double checking the correct results: +# 1: https://words.github.io/double-metaphone +# 2: https://mainegenealogy.net/metaphone_converter.asp +# 3: https://en.toolpage.org/tool/metaphone + +# These tests were collected from the following sources: +# - Example comments in the source code of exp_double_metaphone.c +# - Maurice Aubrey's Tests* +# - Tests manually written by Israel Fuller +# - Tests written by prompting ChatGPT-5 (preview)** +# +# *Source: https://github.com/gitpan/Text-DoubleMetaphone/blob/master/t/words.txt +# **GPT-5 mini (Preview) was run in GitHub Copilot to suggest the words +# for some tests after analizing a generated coverage report. I (Israel) +# used the suggestions to write some "AI generated" test cases. +# +# For more information, see the manual test suite implementation at the +# end of the exp_double_metaphone.c file. + +query select result = metaphone("Test") +query select result = metaphone("Basic") +query select result = metaphone("Centrallix") +query select result = metaphone("Lawrence") +query select result = metaphone("Philips") +query select result = metaphone("Acceptingness") +query select result = metaphone("Supercalifragilisticexpialidocious") +query select result = metaphone("Suoicodilaipxecitsiligarfilacrepus") +query select result = metaphone("Smith") +query select result = metaphone("Schmidt") +query select result = metaphone("Snider") +query select result = metaphone("Schneider") +query select result = metaphone("Arnow") +query select result = metaphone("Arnoff") +query select result = metaphone("Accede") +query select result = metaphone("Accident") +query select result = metaphone("Actually") +query select result = metaphone("Arch") +query select result = metaphone("Artois") +query select result = metaphone("Bacchus") +query select result = metaphone("Bacci") +query select result = metaphone("Bajador") +query select result = metaphone("Bellocchio") +query select result = metaphone("Bertucci") +query select result = metaphone("Biaggi") +query select result = metaphone("Bough") +query select result = metaphone("Breaux") +query select result = metaphone("Broughton") +query select result = metaphone("Cabrillo") +query select result = metaphone("Caesar") +query select result = metaphone("Cagney") +query select result = metaphone("Campbell") +query select result = metaphone("Carlisle") +query select result = metaphone("Carlysle") +query select result = metaphone("Chemistry") +query select result = metaphone("Chianti") +query select result = metaphone("Chorus") +query select result = metaphone("Cough") +query select result = metaphone("Czerny") +query select result = metaphone("Dumb") +query select result = metaphone("Edgar") +query select result = metaphone("Edge") +query select result = metaphone("Filipowicz") +query select result = metaphone("Focaccia") +query select result = metaphone("Gallegos") +query select result = metaphone("Germanic") +query select result = metaphone("Ghiradelli") +query select result = metaphone("Ghislane") +query select result = metaphone("Gospel") +query select result = metaphone("Gough") +query select result = metaphone("Greek") +query select result = metaphone("Hochmeier") +query select result = metaphone("Hugh") +query select result = metaphone("Island") +query select result = metaphone("Isle") +query select result = metaphone("Italian") +query select result = metaphone("Jankelowicz") +query select result = metaphone("Jose") +query select result = metaphone("Laugh") +query select result = metaphone("Mac Caffrey") +query select result = metaphone("Mac Gregor") +query select result = metaphone("Manager") +query select result = metaphone("McHugh") +query select result = metaphone("McLaughlin") +query select result = metaphone("Michael") +query select result = metaphone("Middle") +query select result = metaphone("Orchestra") +query select result = metaphone("Orchid") +query select result = metaphone("Pinyin") +query select result = metaphone("Raspberry") +query select result = metaphone("Resnais") +query select result = metaphone("Rogier") +query select result = metaphone("Rough") +query select result = metaphone("Salvador") +query select result = metaphone("San jacinto") +query select result = metaphone("Schenker") +query select result = metaphone("Schermerhorn") +query select result = metaphone("Schlesinger") +query select result = metaphone("School") +query select result = metaphone("Schooner") +query select result = metaphone("Succeed") +query select result = metaphone("Sugar") +query select result = metaphone("Sugary") +query select result = metaphone("Tagliaro") +query select result = metaphone("Thames") +query select result = metaphone("Thomas") +query select result = metaphone("Thumb") +query select result = metaphone("Tichner") +query select result = metaphone("Tough") +query select result = metaphone("Vghee") +query select result = metaphone("Wachtler") +query select result = metaphone("Wechsler") +query select result = metaphone("Word") +query select result = metaphone("Xavier") +query select result = metaphone("Yankelovich") +query select result = metaphone("Zhao") +query select result = metaphone("McClellan") +query select result = metaphone("maurice") +query select result = metaphone("aubrey") +query select result = metaphone("cambrillo") +query select result = metaphone("heidi") +query select result = metaphone("katherine") +query select result = metaphone("catherine") +query select result = metaphone("richard") +query select result = metaphone("bob") +query select result = metaphone("eric") +query select result = metaphone("geoff") +query select result = metaphone("dave") +query select result = metaphone("ray") +query select result = metaphone("steven") +query select result = metaphone("bryce") +query select result = metaphone("randy") +query select result = metaphone("bryan") +query select result = metaphone("brian") +query select result = metaphone("otto") +query select result = metaphone("auto") +query select result = metaphone("Abbott") +query select result = metaphone("Back") +query select result = metaphone("Bacher") +query select result = metaphone("Charles") +query select result = metaphone("Ghana") +query select result = metaphone("Gnome") +query select result = metaphone("Raj") +query select result = metaphone("Quentin") +query select result = metaphone("Who") +query select result = metaphone("Shoemaker") +query select result = metaphone("Sian") +query select result = metaphone("Scold") +query select result = metaphone("Station") +query select result = metaphone("Match") +query select result = metaphone("Pizza") +query select result = metaphone("Agnes") +query select result = metaphone("Science") +query select result = metaphone("Van Gogh") +query select result = metaphone("Josef") +query select result = metaphone("Object") +query select result = metaphone("Sholz") +query select result = metaphone("Scharf") +query select result = metaphone("Kasia") +query select result = metaphone("Van Geller") diff --git a/centrallix/tests/test_fuzzycompare_00.cmp b/centrallix/tests/test_fuzzycompare_00.cmp deleted file mode 100644 index baa6db1e9..000000000 --- a/centrallix/tests/test_fuzzycompare_00.cmp +++ /dev/null @@ -1,13 +0,0 @@ -Attribute [sw1]: integer 1 -Attribute [sw1]: integer 1 -Attribute [sw1]: integer 1 -Attribute [sw1]: integer 1 -Attribute [sw1]: integer 1 -Attribute [sw1]: integer 1 -Attribute [sw1]: integer 1 -Attribute [sw1]: integer 1 -Attribute [sw1]: integer 1 -Attribute [sw1]: integer 1 -Attribute [sw1]: integer 1 -Attribute [sw1]: integer 1 -Attribute [sw1]: integer 1 diff --git a/centrallix/tests/test_fuzzycompare_00.to b/centrallix/tests/test_fuzzycompare_00.to deleted file mode 100644 index 78141a473..000000000 --- a/centrallix/tests/test_fuzzycompare_00.to +++ /dev/null @@ -1,15 +0,0 @@ -##NAME Levenshtein String Comparison - -query select sw1 = 1 where fuzzy_compare('hello', 'hello!', 20) >= 0 and fuzzy_compare("hello","hello!", 20) <= 1 -query select sw1 = 1 where fuzzy_compare('hello', 'asdfkh', 20) >= 0 and fuzzy_compare("hello","asdfkh", 20) <= 1 -query select sw1 = 1 where fuzzy_compare('hello', 'aaaaaaaaaaaaaaaaa', 20) >= 0 and fuzzy_compare("hello","aaaaaaaaaaaaaaaaa", 20) <= 1 -query select sw1 = 1 where fuzzy_compare('hello', 'nope', 20) >= 0 and fuzzy_compare("hello","nope", 20) <= 1 -query select sw1 = 1 where fuzzy_compare('below', 'hello!', 20) >= 0 and fuzzy_compare("below","hello!", 20) <= 1 -query select sw1 = 1 where fuzzy_compare('kitten', 'smitten', 20) >= 0 and fuzzy_compare("kitten","smitten", 20) <= 1 -query select sw1 = 1 where fuzzy_compare('hello', 'bobbobbobbob', 20) >= 0 and fuzzy_compare("hello","bobbobbobbob", 20) <= 1 -query select sw1 = 1 where fuzzy_compare('hello', '', 20) >= 0 and fuzzy_compare("hello","", 20) <= 1 -query select sw1 = 1 where fuzzy_compare('', '', 20) >= 0 and fuzzy_compare("","", 20) <= 1 -query select sw1 = 1 where fuzzy_compare('blooooop', 'blob', 20) >= 0 and fuzzy_compare("blooooop","blob", 20) <= 1 -query select sw1 = 1 where fuzzy_compare('', '!', 20) >= 0 and fuzzy_compare("","!", 20) <= 1 -query select sw1 = 1 where fuzzy_compare('h', 'h', 20) >= 0 and fuzzy_compare("h","h", 20) <= 1 -query select sw1 = 1 where fuzzy_compare('hi', 'hi', 20) >= 0 and fuzzy_compare("hi","hi", 20) <= 1 diff --git a/centrallix/tests/test_lev_compare_00.cmp b/centrallix/tests/test_lev_compare_00.cmp new file mode 100644 index 000000000..1c295a360 --- /dev/null +++ b/centrallix/tests/test_lev_compare_00.cmp @@ -0,0 +1,23 @@ +Attribute [case1]: string "pass" +Attribute [case2]: string "pass" +Attribute [case3]: string "pass" +Attribute [case4]: string "pass" +Attribute [case5]: string "pass" +Attribute [case6]: string "pass" +Attribute [case7]: string "pass" +Attribute [case8]: string "pass" +Attribute [case9]: string "pass" +Attribute [case10]: string "pass" +Attribute [case11]: string "pass" +Attribute [case12]: string "pass" +Attribute [case13]: string "pass" +Attribute [case14]: string "pass" +Attribute [case15]: string "pass" +Attribute [case16]: string "pass" +Attribute [case17]: string "pass" +Attribute [case18]: string "pass" +Attribute [case19]: string "pass" +Attribute [case20]: string "pass" +Attribute [case21]: string "pass" +Attribute [case22]: string "pass" +Attribute [case23]: string "pass" diff --git a/centrallix/tests/test_lev_compare_00.to b/centrallix/tests/test_lev_compare_00.to new file mode 100644 index 000000000..5d9cec0f7 --- /dev/null +++ b/centrallix/tests/test_lev_compare_00.to @@ -0,0 +1,28 @@ +##NAME Levenshtein String Comparison + +# Legacy tests. +query select case1 = condition(lev_compare('hello', 'hello!') >= 0 and lev_compare('hello','hello!') <= 1, 'pass', 'fail') +query select case2 = condition(lev_compare('hello', 'asdfkh') >= 0 and lev_compare('hello','asdfkh') <= 1, 'pass', 'fail') +query select case3 = condition(lev_compare('hello', 'aaaaaaaaaaaaaaaaa') >= 0 and lev_compare('hello','aaaaaaaaaaaaaaaaa') <= 1, 'pass', 'fail') +query select case4 = condition(lev_compare('hello', 'nope') >= 0 and lev_compare('hello', 'nope') <= 1, 'pass', 'fail') +query select case5 = condition(lev_compare('below', 'hello!') >= 0 and lev_compare('below', 'hello!') <= 1, 'pass', 'fail') +query select case6 = condition(lev_compare('kitten', 'smitten') >= 0 and lev_compare('kitten', 'smitten') <= 1, 'pass', 'fail') +query select case7 = condition(lev_compare('hello', 'bobbobbobbob') >= 0 and lev_compare('hello', 'bobbobbobbob') <= 1, 'pass', 'fail') +query select case8 = condition(lev_compare('hello', '') >= 0 and lev_compare('hello', '') <= 1, 'pass', 'fail') +query select case9 = condition(lev_compare('', '') >= 0 and lev_compare('', '') <= 1, 'pass', 'fail') +query select case10 = condition(lev_compare('blooooop', 'blob') >= 0 and lev_compare('blooooop', 'blob') <= 1, 'pass', 'fail') +query select case11 = condition(lev_compare('', '!') >= 0 and lev_compare('','!') <= 1, 'pass', 'fail') +query select case12 = condition(lev_compare('h', 'h') >= 0 and lev_compare('h','h') <= 1, 'pass', 'fail') +query select case13 = condition(lev_compare('hi', 'hi') >= 0 and lev_compare('hi','hi') <= 1, 'pass', 'fail') + +# Kitten tests. +query select case14 = condition(lev_compare('kitten', 'kitten') >= 0.99 and lev_compare('kitten', 'kitten') <= 1.0, 'pass', 'fail') -- 0 edits +query select case15 = condition(lev_compare('kitten', 'skitten') >= 0.8 and lev_compare('kitten', 'skitten') <= 0.9, 'pass', 'fail') -- 1 insert +query select case16 = condition(lev_compare('kitten', 'itten') >= 0.8 and lev_compare('kitten', 'itten') <= 0.9, 'pass', 'fail') -- 1 delete +query select case17 = condition(lev_compare('kitten', 'mitten') >= 0.8 and lev_compare('kitten', 'mitten') <= 0.9, 'pass', 'fail') -- 1 replace +query select case18 = condition(lev_compare('kitten', 'smitten') >= 0.7 and lev_compare('kitten', 'smitten') <= 0.8, 'pass', 'fail') -- 1 insert and one replace +query select case19 = condition(lev_compare('kitten', 'iktten') >= 0.8 and lev_compare('kitten', 'iktten') <= 0.9, 'pass', 'fail') -- 1 transpose +query select case20 = condition(lev_compare('kitten', 'kittens') >= 0.8 and lev_compare('kitten', 'kittens') <= 0.9, 'pass', 'fail') -- 1 insert (end) +query select case21 = condition(lev_compare('kitten', 'kitte') >= 0.8 and lev_compare('kitten', 'kitte') <= 0.9, 'pass', 'fail') -- 1 delete (end) +query select case22 = condition(lev_compare('kitten', 'kittem') >= 0.8 and lev_compare('kitten', 'kittem') <= 0.9, 'pass', 'fail') -- 1 replace (end) +query select case23 = condition(lev_compare('kitten', 'kittne') >= 0.8 and lev_compare('kitten', 'kittne') <= 0.9, 'pass', 'fail') -- 1 transpose (end) diff --git a/centrallix/tests/test_levenshtein_00.cmp b/centrallix/tests/test_levenshtein_00.cmp index 0bc319c9d..2a084162d 100644 --- a/centrallix/tests/test_levenshtein_00.cmp +++ b/centrallix/tests/test_levenshtein_00.cmp @@ -1,6 +1,18 @@ -Attribute [sw1]: integer 1 -Attribute [sw1]: integer 1 -Attribute [sw1]: integer 2 -Attribute [sw1]: integer 2 -Attribute [sw1]: integer 1 -Attribute [sw1]: integer 1 +Attribute [case1]: string "pass" +Attribute [case2]: string "pass" +Attribute [case3]: string "pass" +Attribute [case4]: string "pass" +Attribute [case5]: string "pass" +Attribute [case6]: string "pass" +Attribute [case7]: string "pass" +Attribute [case8]: string "pass" +Attribute [case9]: string "pass" +Attribute [case10]: string "pass" +Attribute [case11]: string "pass" +Attribute [case12]: string "pass" +Attribute [case13]: string "pass" +Attribute [case14]: string "pass" +Attribute [case15]: string "pass" +Attribute [case16]: string "pass" +Attribute [case17]: string "pass" +Attribute [case18]: string "pass" diff --git a/centrallix/tests/test_levenshtein_00.to b/centrallix/tests/test_levenshtein_00.to index a666c3a4b..33f78e5f8 100644 --- a/centrallix/tests/test_levenshtein_00.to +++ b/centrallix/tests/test_levenshtein_00.to @@ -1,8 +1,25 @@ ##NAME Levenshtein String Comparison -query select sw1 = levenshtein('hello', 'hello!') -query select sw1 = levenshtein('kitten', 'mitten') -query select sw1 = levenshtein('kitten', 'smitten') -query select sw1 = levenshtein('lawn', 'flown') -query select sw1 = levenshtein('kitten', 'itten') -query select sw1 = levenshtein('kitten', 'skitten') +# Kitten tests. +query select case1 = condition(levenshtein('kitten', 'kitten') == 0, 'pass', 'fail') -- 0 edits +query select case2 = condition(levenshtein('kitten', 'skitten') == 1, 'pass', 'fail') -- 1 insert +query select case3 = condition(levenshtein('kitten', 'itten') == 1, 'pass', 'fail') -- 1 delete +query select case4 = condition(levenshtein('kitten', 'mitten') == 1, 'pass', 'fail') -- 1 replace +query select case5 = condition(levenshtein('kitten', 'smitten') == 2, 'pass', 'fail') -- 1 insert and one replace +query select case6 = condition(levenshtein('kitten', 'iktten') == 1, 'pass', 'fail') -- 1 transpose +query select case7 = condition(levenshtein('kitten', 'kittens') == 1, 'pass', 'fail') -- 1 insert (end) +query select case8 = condition(levenshtein('kitten', 'kitte') == 1, 'pass', 'fail') -- 1 delete (end) +query select case9 = condition(levenshtein('kitten', 'kittem') == 1, 'pass', 'fail') -- 1 replace (end) +query select case10 = condition(levenshtein('kitten', 'kittne') == 1, 'pass', 'fail') -- 1 transpose (end) + +# Alternate words. +query select case11 = condition(levenshtein('lawn', 'flown') == 2, 'pass', 'fail') -- 1 insert and one replace +query select case12 = condition(levenshtein('hello', 'hello!') == 1, 'pass', 'fail') -- 1 insert (end) +query select case13 = condition(levenshtein('zert', 'zerf') == 1, 'pass', 'fail') -- 1 replace (end) +query select case14 = condition(levenshtein('llearr', 'lear') == 2, 'pass', 'fail') -- 2 deletes (start & end) + +# Edge cases. +query select case15 = condition(levenshtein('', '') == 0, 'pass', 'fail') -- 0 edits +query select case16 = condition(levenshtein('This is a very long string!! I do not expect this function to need to process a string longer than this, because this string is a full 254 characters. That is pretty long. The object system limits strings to this size so we cannot make a longer string...', 'This is a very long string!! I do not expect this function to need to process a string longer than this, because this string is a full 254 characters. That is pretty long. The object system limits strings to this size so we cannot make a longer string...') == 0, 'pass', 'fail') -- 0 edits. +query select case17 = condition(levenshtein('This is a very long string!! I do not expect this function to need to process a string longer than this, because this string is a full 254 characters. That is pretty long. The object system limits strings to this size so we cannot make a longer string...', 'This is quite a lengthy string. I do not expect the function to compute any longer string since this one is a full 254 characters. That is plenty, even if someone adds many contact details to their record!! Thus, this test should cover most cases we see.') == 133, 'pass', 'fail') -- 133 edits. +query select case18 = condition(levenshtein('AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA', 'BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB') == 254, 'pass', 'fail') -- 254 replaces. diff --git a/centrallix/tests/test_similarity_00.cmp b/centrallix/tests/test_similarity_00.cmp deleted file mode 100644 index a0d292206..000000000 --- a/centrallix/tests/test_similarity_00.cmp +++ /dev/null @@ -1,5 +0,0 @@ -Attribute [sw1]: integer 1 -Attribute [sw1]: integer 1 -Attribute [sw1]: integer 1 -Attribute [sw1]: integer 1 -Attribute [sw1]: integer 1 diff --git a/centrallix/tests/test_similarity_00.to b/centrallix/tests/test_similarity_00.to deleted file mode 100644 index a0942ab76..000000000 --- a/centrallix/tests/test_similarity_00.to +++ /dev/null @@ -1,7 +0,0 @@ -##NAME Text Mining String Similarity - -query select sw1 = (cos_compare('hello', 'hello') >= 0.999) and (cos_compare('hello', 'hello') <= 1) -query select sw1 = (cos_compare('hello', 'nancy') <= 0.001) and (cos_compare('hello', 'nancy') >= 0) -query select sw1 = (cos_compare('hello', 'hello world') <= 0.891) and (cos_compare('hello', 'hello world') >= 0.890) -query select sw1 = (cos_compare('hello', 'hellow') >= 0.935) and (cos_compare('hello', 'hellow') <= 0.936) -query select sw1 = (cos_compare('hello', 'hellow', 1) >= 0.935) and (cos_compare('hello', 'hellow', 1) <= 0.936) From 08743657d5d4aa922f85ac5c2f7f0e1ff117da79 Mon Sep 17 00:00:00 2001 From: Israel Date: Mon, 17 Nov 2025 10:50:42 -0700 Subject: [PATCH 013/275] Re-apply reduced weight for duplicate pairs (temporarily turned off last commit). Update tests to pass with this modification. --- centrallix-lib/src/clusters.c | 2 +- centrallix/tests/test_cos_compare_00.to | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/centrallix-lib/src/clusters.c b/centrallix-lib/src/clusters.c index 84f01c535..7d8a225ca 100644 --- a/centrallix-lib/src/clusters.c +++ b/centrallix-lib/src/clusters.c @@ -178,7 +178,7 @@ pVector ca_build_vector(const char* str) int value = 0; for (; i < num_pairs && char_pairs[i].hash == hash; i++) { - // value /= 2; /* Reduce impact of repeated pairs. */ + value /= 2; /* Reduce impact of repeated pairs. */ value += ((unsigned int)char_pairs[i].c1 + (unsigned int)char_pairs[i].c2) % 13u + 1u; } diff --git a/centrallix/tests/test_cos_compare_00.to b/centrallix/tests/test_cos_compare_00.to index f45dec13a..c5b0b1a5b 100644 --- a/centrallix/tests/test_cos_compare_00.to +++ b/centrallix/tests/test_cos_compare_00.to @@ -11,13 +11,13 @@ query select case4 = condition((cos_compare('hello there', 'hellow there') >= 0. # All email addresses and phone numbers are imaginary and were fabricated for the purposes of this test query select cynthia = condition((cos_compare("Cynthia Adams; cynthiaadams@gmail.com; 720-769-1293", "Timothy Adams; thetbear@gmail.com; 720-891-1470") >= 0.49) and (cos_compare("Cynthia Adams; cynthiaadams@gmail.com; 720-769-1293", "Timothy Adams; thetbear@gmail.com; 720-891-1470") <= 0.54), "pass", "fail") -query select timothy = condition((cos_compare("Timothy Adams; thetbear@gmail.com; 720-891-1470", "Lance Freson; lancetheturtle@gmail.com; 720-111-8189") >= 0.425) and (cos_compare("Timothy Adams; thetbear@gmail.com; 720-891-1470", "Lance Freson; lancetheturtle@gmail.com; 720-111-8189") <= 0.475), "pass", "fail") +query select timothy = condition((cos_compare("Timothy Adams; thetbear@gmail.com; 720-891-1470", "Lance Freson; lancetheturtle@gmail.com; 720-111-8189") >= 0.45) and (cos_compare("Timothy Adams; thetbear@gmail.com; 720-891-1470", "Lance Freson; lancetheturtle@gmail.com; 720-111-8189") <= 0.50), "pass", "fail") -query select lance = condition((cos_compare("Lance Freson; lancetheturtle@gmail.com; 720-111-8189", "Gregory Freson; greatgregory@gmail.com; 720-198-5791") >= 0.35) and (cos_compare("Lance Freson; lancetheturtle@gmail.com; 720-111-8189", "Gregory Freson; greatgregory@gmail.com; 720-198-5791") <= 0.40), "pass", "fail") +query select lance = condition((cos_compare("Lance Freson; lancetheturtle@gmail.com; 720-111-8189", "Gregory Freson; greatgregory@gmail.com; 720-198-5791") >= 0.425) and (cos_compare("Lance Freson; lancetheturtle@gmail.com; 720-111-8189", "Gregory Freson; greatgregory@gmail.com; 720-198-5791") <= 0.475), "pass", "fail") query select gregory = condition((cos_compare("Gregory Freson; greatgregory@gmail.com; 720-198-5791", "Gregory Freson; greatgregory@gmail.co; 720-198-5791") >= 0.94) and (cos_compare("Gregory Freson; greatgregory@gmail.com; 720-198-5791", "Gregory Freson; greatgregory@gmail.co; 720-198-5791") <= 0.99), "pass", "fail") -query select nathan = condition((cos_compare("Nathan Mayor; nmmayor@yahoo.com; +1-800-192-9128", "Mindy Mayor; nmmayor@yahoo.com; 720-981-9149") >= 0.66) and (cos_compare("Nathan Mayor; nmmayor@yahoo.com; +1-800-192-9128", "Mindy Mayor; nmmayor@yahoo.com; 720-981-9149") <= 0.71), "pass", "fail") +query select nathan = condition((cos_compare("Nathan Mayor; nmmayor@yahoo.com; +1-800-192-9128", "Mindy Mayor; nmmayor@yahoo.com; 720-981-9149") >= 0.575) and (cos_compare("Nathan Mayor; nmmayor@yahoo.com; +1-800-192-9128", "Mindy Mayor; nmmayor@yahoo.com; 720-981-9149") <= 0.625), "pass", "fail") query select identical = condition((cos_compare("This is an identical case", "This is an identical case") >= 0.975) and (cos_compare("This is an identical case", "This is an identical case") <= 1.00), "pass", "fail") From 01d918aa2d4f3f3cb03fbf95d682c6da5388fca2 Mon Sep 17 00:00:00 2001 From: Israel Date: Mon, 17 Nov 2025 11:09:19 -0700 Subject: [PATCH 014/275] Clean up. --- centrallix-lib/src/clusters.c | 20 +++------ centrallix-os/cluster-schema.cluster | 6 +-- centrallix-os/testdir/file.cluster | 64 ---------------------------- 3 files changed, 8 insertions(+), 82 deletions(-) delete mode 100644 centrallix-os/testdir/file.cluster diff --git a/centrallix-lib/src/clusters.c b/centrallix-lib/src/clusters.c index 7d8a225ca..e0b71efaa 100644 --- a/centrallix-lib/src/clusters.c +++ b/centrallix-lib/src/clusters.c @@ -234,18 +234,17 @@ unsigned int ca_sparse_len(const pVector vector) } /*** Print the underlying implementation values sparsely allocated - *** vector (intended for debugging). + *** vector (for debugging). *** - *** @param out File to print to. *** @param vector The vector. ***/ -void ca_fprint_vector(FILE* out, const pVector vector) +void ca_print_vector(const pVector vector) { const unsigned int len = ca_sparse_len(vector); - fprintf(out, "Vector: [%d", vector[0]); + printf("Vector: [%d", vector[0]); for (unsigned int i = 1u; i < len; i++) - fprintf(out, ", %d", vector[i]); - fprintf(out, "]"); + printf(", %d", vector[i]); + printf("]"); } /*** Compute the magnitude of a sparsely allocated vector. @@ -409,9 +408,6 @@ static double sparse_similarity_to_centroid(const pVector v1, const pCentroid c2 *** *** @attention - `Complexity`: O(nm), where n and m are the lengths of str1 *** and str2 (respectively). - *** - *** @skip - *** LINK ../../centrallix-sysdoc/string_comparison.md#levenshtein ***/ unsigned int edit_dist(const char* str1, const char* str2, const size_t str1_length, const size_t str2_length) { @@ -500,9 +496,6 @@ unsigned int edit_dist(const char* str1, const char* str2, const size_t str1_len *** @param v1 A `pVector` to the first string to compare. *** @param v2 A `pVector` to the second string to compare. *** @returns The cosine similarity between the two strings. - *** - *** @skip - *** LINK ../../centrallix-sysdoc/string_comparison.md#cosine ***/ double ca_cos_compare(void* v1, void* v2) { @@ -532,9 +525,6 @@ double ca_cos_compare(void* v1, void* v2) *** @param str1 A `char*` to the first string to compare. *** @param str2 A `char*` to the second string to compare. *** @returns The levenshtein similarity between the two strings. - *** - *** @skip - *** LINK ../../centrallix-sysdoc/string_comparison.md#levenshtein ***/ double ca_lev_compare(void* str1, void* str2) { diff --git a/centrallix-os/cluster-schema.cluster b/centrallix-os/cluster-schema.cluster index 4113a339a..5e11cd7c2 100644 --- a/centrallix-os/cluster-schema.cluster +++ b/centrallix-os/cluster-schema.cluster @@ -4,9 +4,9 @@ file_name "system/cluster" { name "cluster/parameter" { - type : DATA_T // See datatypes.h - ?default : type - ?name : String // Overrides the name above. + type : DATA_T // See datatypes.h + ?default : type // Default value for the variable. + ?name : String // Overrides the name above. ?style : StyleObj // idk where to find docs for this. } // Access with :parameters:name. Accessing dynamic data (e.g. parameters) diff --git a/centrallix-os/testdir/file.cluster b/centrallix-os/testdir/file.cluster deleted file mode 100644 index 929efdd03..000000000 --- a/centrallix-os/testdir/file.cluster +++ /dev/null @@ -1,64 +0,0 @@ -$Version=2$ -file_name "system/cluster" - { - // Developer can specify parameters to improve file reuseability. - // TIP: Improve performance by declairing frequently used parameters first. - k "cluster/parameter" { type = integer; style=notnull; } - str "cluster/parameter" { type = string; } - int "cluster/parameter" { type = integer; default = runserver(:parameters:k); } - dbl "cluster/parameter" { type = double; default=4.2; } - // conversion "cluster/parameter" { type=double; default=4; } - - null_str "cluster/parameter" { type = string; default = null; } - null_int "cluster/parameter" { type = integer; default = null; } - null_dbl "cluster/parameter" { type = double; default = null; } - - // We calculate k in a centrallix script using: - // k = max(2, pow(log(n) / log(36), 3.2) - 8) - // where n is the number of records passed. - - // Specify the data source at the top of the file. - // How do we pass distinct data? Should the driver - // handle that for us? - source = "/apps/kardia/data/Kardia_DB/p_partner/rows"; - attr_name = p_given_name; // runserver(:parameters:str) - - // Clustering object specifies properties for clustering. - kmeans_cluster "cluster/cluster" - { - algorithm = "k-means"; - similarity_measure = "cosine"; - num_clusters = runserver(:parameters:k); - min_improvement = 0.0001; - max_iterations = 48; - - // Create subclusters. (Not implemented) - sub_cluster "cluster/cluster" - { - algorithm = "none"; - similarity_measure = "cosine"; - num_clusters = 7; - min_improvement = "max"; - } - } - - // Complete search. - no_clustering "cluster/cluster" - { - algorithm = "none"; - } - - dups "cluster/search" - { - source = kmeans_cluster; - threshold = 0.75; - similarity_measure = "cosine"; - } - - dups2 "cluster/search" - { - source = no_clustering; - threshold = 0.75; - similarity_measure = "cosine"; - } - } From 42a65f17a15c96fe2792268e7af6638cd285d4c3 Mon Sep 17 00:00:00 2001 From: Israel Date: Mon, 17 Nov 2025 13:34:41 -0700 Subject: [PATCH 015/275] Update licences. --- centrallix-lib/include/clusters.h | 7 ++++-- centrallix-lib/include/util.h | 33 +++++++++++++++---------- centrallix-lib/src/clusters.c | 7 ++++-- centrallix-lib/src/util.c | 33 +++++++++++++++---------- centrallix-sysdoc/OSDriver_Authoring.md | 31 +++++++++++++++++++++++ centrallix-sysdoc/string_similarity.md | 5 +++- 6 files changed, 85 insertions(+), 31 deletions(-) diff --git a/centrallix-lib/include/clusters.h b/centrallix-lib/include/clusters.h index ffa1223fb..c0718cea9 100644 --- a/centrallix-lib/include/clusters.h +++ b/centrallix-lib/include/clusters.h @@ -28,8 +28,11 @@ /* Module: lib_cluster.h */ /* Author: Israel Fuller */ /* Creation: September 29, 2025 */ -/* Description: Internal algorithms for the cluster object driver. */ -/* See centrallix-sysdoc/EAV_Pivot.md for more information. */ +/* Description: Clustering library used to cluster and search data with */ +/* cosine similarity and Levenshtein similarity (aka. edit */ +/* distance). Used by the "clustering driver". */ +/* For more information on how to use this library, see */ +/* string-similarity.md in the centrallix-sysdoc folder. */ /************************************************************************/ #include diff --git a/centrallix-lib/include/util.h b/centrallix-lib/include/util.h index 0f2685039..853954409 100644 --- a/centrallix-lib/include/util.h +++ b/centrallix-lib/include/util.h @@ -2,19 +2,26 @@ #define UTILITY_H /************************************************************************/ -/* Centrallix Application Server System */ -/* Centrallix Base Library */ -/* */ -/* Copyright (C) 1998-2011 LightSys Technology Services, Inc. */ -/* */ -/* You may use these files and this library under the terms of the */ -/* GNU Lesser General Public License, Version 2.1, contained in the */ -/* included file "COPYING". */ -/* */ -/* Module: (util.c,.h) */ -/* Author: Micah Shennum */ -/* Date: May 26, 2011 */ -/* Description: Collection of utilities */ +/* Centrallix Application Server System */ +/* Centrallix Base Library */ +/* */ +/* Copyright (C) 1998-2011 LightSys Technology Services, Inc. */ +/* */ +/* You may use these files and this library under the terms of the */ +/* GNU Lesser General Public License, Version 2.1, contained in the */ +/* included file "COPYING". */ +/* */ +/* Module: util.c, util.h */ +/* Author: Micah Shennum and Israel Fuller */ +/* Date: May 26, 2011 */ +/* Description: Collection of utilities including: */ +/* - Utilities for parsing numbers. */ +/* - The timer utility for benchmarking code. */ +/* - snprint_bytes() for formatting a byte count. */ +/* - snprint_llu() for formatting large numbers. */ +/* - fprint_mem() for printing memory stats. */ +/* - min() and max() for handling numbers. */ +/* - The check functions for reliably printing debug data. */ /************************************************************************/ #ifdef __cplusplus diff --git a/centrallix-lib/src/clusters.c b/centrallix-lib/src/clusters.c index e0b71efaa..4bfce8ee6 100644 --- a/centrallix-lib/src/clusters.c +++ b/centrallix-lib/src/clusters.c @@ -1,4 +1,3 @@ - /************************************************************************/ /* Centrallix Application Server System */ /* Centrallix Core */ @@ -26,7 +25,11 @@ /* Module: lib_cluster.c */ /* Author: Israel Fuller */ /* Creation: September 29, 2025 */ -/* Description: Internal algorithms for the cluster object driver. */ +/* Description: Clustering library used to cluster and search data with */ +/* cosine similarity and Levenshtein similarity (aka. edit */ +/* distance). Used by the "clustering driver". */ +/* For more information on how to use this library, see */ +/* string-similarity.md in the centrallix-sysdoc folder. */ /************************************************************************/ /** This file has additional documentation in string_similarity.md. **/ diff --git a/centrallix-lib/src/util.c b/centrallix-lib/src/util.c index f60349a74..7c234a341 100644 --- a/centrallix-lib/src/util.c +++ b/centrallix-lib/src/util.c @@ -1,17 +1,24 @@ /************************************************************************/ -/* Centrallix Application Server System */ -/* Centrallix Base Library */ -/* */ -/* Copyright (C) 1998-2011 LightSys Technology Services, Inc. */ -/* */ -/* You may use these files and this library under the terms of the */ -/* GNU Lesser General Public License, Version 2.1, contained in the */ -/* included file "COPYING". */ -/* */ -/* Module: (util.c,.h) */ -/* Author: Micah Shennum */ -/* Date: May 26, 2011 */ -/* Description: Collection of utilities */ +/* Centrallix Application Server System */ +/* Centrallix Base Library */ +/* */ +/* Copyright (C) 1998-2011 LightSys Technology Services, Inc. */ +/* */ +/* You may use these files and this library under the terms of the */ +/* GNU Lesser General Public License, Version 2.1, contained in the */ +/* included file "COPYING". */ +/* */ +/* Module: util.c, util.h */ +/* Author: Micah Shennum and Israel Fuller */ +/* Date: May 26, 2011 */ +/* Description: Collection of utilities including: */ +/* - Utilities for parsing numbers. */ +/* - The timer utility for benchmarking code. */ +/* - snprint_bytes() for formatting a byte count. */ +/* - snprint_llu() for formatting large numbers. */ +/* - fprint_mem() for printing memory stats. */ +/* - min() and max() for handling numbers. */ +/* - The check functions for reliably printing debug data. */ /************************************************************************/ #include diff --git a/centrallix-sysdoc/OSDriver_Authoring.md b/centrallix-sysdoc/OSDriver_Authoring.md index f679dac32..8e58f7cee 100644 --- a/centrallix-sysdoc/OSDriver_Authoring.md +++ b/centrallix-sysdoc/OSDriver_Authoring.md @@ -1,3 +1,34 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + # ObjectSystem Driver Interface **Author**: Greg Beeley diff --git a/centrallix-sysdoc/string_similarity.md b/centrallix-sysdoc/string_similarity.md index 33667a05c..526cbe307 100644 --- a/centrallix-sysdoc/string_similarity.md +++ b/centrallix-sysdoc/string_similarity.md @@ -25,7 +25,10 @@ - + + + + - - # String Similarity -The following sections discuss the approaches to calculating similarity between two strings which are implemented in the `clusters.c` library. This library can be included using `#include "clusters.h"` in centrallix-lib and `#include "cxlib/clusters.h"` in centrallix. +The following sections discuss the approaches to calculating similarity between two strings using the `clusters.c` library. This library can be included using `#include "cxlib/clusters.h"` in the centrallix codebase (use `#include "clusters.h"` in other libaries in centrallix-lib). -## Table of Contents +## Table of Contents - [String Comparison](#string-comparison) - [Table of Contents](#table-of-contents) - [Cosine Similarity](#cosine-similarity) @@ -76,10 +56,10 @@ The following sections discuss the approaches to calculating similarity between - [Implement Missing Algorithms](#implement-missing-algorithms) -## Cosine Similarity +## Cosine Similarity The [Cosine Similarity](https://en.wikipedia.org/wiki/Cosine_similarity) function is defined as the dot product of two vectors divided by the product of the magnitude of the two vectors. Conceptually, it's like finding the _angle_ between two vectors. To get these vectors, we use the relative frequency of character pairs within each string. To reduce memory cost and speed up computation, we store them in a special sparsely allocated form, described below. -### Character Sets +### Character Sets Cosine compare currently uses the following character sets. These can be extended or modified later, if necessary. ```c const char ALLOW_SET[] = " \n\v\f\r!#$%&\"'()*+,-./:;<=>?@[]^_{|}~ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789"; @@ -97,26 +77,26 @@ const char BOUNDARY_CHAR = ('a' - 1); // aka. '`' - This character appears to have been selected to be one before the first character in `CHAR_SET` (thus convention dictates that it be written `'a' - 1` to indicate this), although it's unknown if that's the main or only reason. - If `clusters.h` is included, it can be accessed using the `CA_BOUNDARY_CHAR` macro. -### Character Pair Hashing +### Character Pair Hashing Even with a small set of ASCII characters (say 36), there are still `36^2 = 1296` possible character pairs. If the number of characters in the `CHAR_SET` ever needed to be expanded - for example, to include all UTF-8 characters - this number would quickly explode exponentially to utterly infeasible proportions. Thus, a hashing algorithm is employed to hash each character pair down to a more reasonable number of dimensions (which can be accessed with the `CA_NUM_DIMS` macro). -### String Vectors +### String Vectors Any string of characters in the `ALLOW_SET` can be represented by a vector. For simplicity, imagine this vector has only `5` dimensions. To find this vector, we hash each character pair in the string. As each character pair is hashed (for example, that the pair "ab" happens to hash to `3`), the corresponding dimension is increased by some amount. This amount varies to based on the characters in the pair, helping to mitigate the impact of collisions where different character pairs hash to identical numbers (a larger number of dimensions also helps to mitigate this). Remember that the first and last characters form a pair with the `BOUNDARY_CHAR`, so the string "ab" has three pairs: "a", "ab", and "b". If these each hash to `2`, `3`, and `0`. Thus, the vector generated by the string "ab" might be: `[7, 0, 4, 3, 0]`. Notice that dimensions #1 and #4 are both `0` because no character pairs generated a hash of `1` or `4`. In real usecases, the vast majority of elements are `0`s because the number of dimensions used is much larger than the number of character pairs in a typical string. -### Sparse Vectors +### Sparse Vectors As noted above, the vast majority of elements in a vector generated by a typical string are `0`s. This would lead to a large waste of memory and computation if every `0` was stored separately, so instead, vectors are stored sparsely. Because all hashes are positive integers, we represent `n` `0`s with a value of ` -n`. Thus, the vector `[0, 1, 0, 0, 0]` (representing an empty string in `5` dimensions) would be represented sparsely as `[-1, 1, -3]`. **Note**: A value of `0` in a sparse vector is undefined, so no element should be equal to `0`. **Note**: Sparse arrays can vary greatly in length. To find their size, one needs to traverse the array until the total number of values found adds up to `CA_NUM_DIMS`. The `ca_sparse_len()` function can be used to do this. Also, the `ca_build_vector()` and `ca_free_vector()` use the `nmSys` functions from `newmalloc.h` to avoid conflicts over the size of the allocated data. -### Computing Similarity +### Computing Similarity Finally, to find the cosine similarity between two strings, we can simply take the [dot product](https://en.wikipedia.org/wiki/Dot_product) of their coresponding vectors. Then, we normalize the dot product by dividing by the magnitudes of both vectors multiplied together. Two strings can be compared this way using the `ca_cos_compare()` function. -## Levenshtein Similarity +## Levenshtein Similarity The [Levenshtein](https://en.wikipedia.org/wiki/Levenshtein_distance) distance is defined as the number of insertions, deletions, or substitutions required to make one string exactly like another string. The version implemented in `clusters.c` additionally allows a new operation called a "swap" in which two adjacent characters change places. Transpositions of larger pieces of text are, unfortunately, not handled as well, which is a potential downfall of using levenshtein edit distance. The levenshtein similarity of two strings can be compared using the `ca_lev_compare()` function. diff --git a/centrallix/osdrivers/objdrv_cluster.c b/centrallix/osdrivers/objdrv_cluster.c index 462d0625f..7ee0bdbba 100644 --- a/centrallix/osdrivers/objdrv_cluster.c +++ b/centrallix/osdrivers/objdrv_cluster.c @@ -1,4 +1,3 @@ - /************************************************************************/ /* Centrallix Application Server System */ /* Centrallix Core */ @@ -42,14 +41,12 @@ #include #include "cxlib/clusters.h" -#include "cxlib/mtask.h" #include "cxlib/mtsession.h" #include "cxlib/newmalloc.h" #include "cxlib/util.h" #include "cxlib/xarray.h" #include "cxlib/xhash.h" #include "expression.h" -#include "hints.h" #include "obj.h" #include "param.h" #include "st_node.h" From ee0bca7351115d3ea5c6cdbd46db7b1225ad4424 Mon Sep 17 00:00:00 2001 From: Israel Date: Wed, 19 Nov 2025 11:58:18 -0700 Subject: [PATCH 017/275] Add "show_less" option to the cache method (skips printing uncomputed caches). Fix a formatting issue with the stat method. Fix a missing include in the util.c library. --- centrallix-lib/src/util.c | 1 + centrallix/osdrivers/objdrv_cluster.c | 93 +++++++++++++++++++-------- 2 files changed, 67 insertions(+), 27 deletions(-) diff --git a/centrallix-lib/src/util.c b/centrallix-lib/src/util.c index cd8a3b49a..e39572f95 100644 --- a/centrallix-lib/src/util.c +++ b/centrallix-lib/src/util.c @@ -24,6 +24,7 @@ #include #include #include +#include #include #include #include diff --git a/centrallix/osdrivers/objdrv_cluster.c b/centrallix/osdrivers/objdrv_cluster.c index 7ee0bdbba..8fb97b184 100644 --- a/centrallix/osdrivers/objdrv_cluster.c +++ b/centrallix/osdrivers/objdrv_cluster.c @@ -4067,7 +4067,8 @@ static int ci_PrintEntry(pXHashEntry entry, void* arg) void** args = (void**)arg; unsigned int* type_id_ptr = (unsigned int*)args[0]; unsigned int* total_bytes_ptr = (unsigned int*)args[1]; - char* path = (char*)args[2]; + unsigned long long* less_ptr = (unsigned long long*)args[2]; + char* path = (char*)args[3]; /** If a path is provided, check that it matches the start of the key. **/ if (path != NULL && strncmp(key, (char*)path, strlen((char*)path)) != 0) return 0; @@ -4081,25 +4082,46 @@ static int ci_PrintEntry(pXHashEntry entry, void* arg) case 1u: { pSourceData source_data = (pSourceData)data; + + /** Compute size. **/ + bytes = ci_SizeOfSourceData(source_data); + + /** If less is specified, skip uncomputed source. **/ + if (*less_ptr > 0llu && source_data->Vectors == NULL) goto no_print; + + /** Compute printing information. **/ type = "Source"; name = source_data->Name; - bytes = ci_SizeOfSourceData(source_data); break; } case 2u: { pClusterData cluster_data = (pClusterData)data; + + /** Compute size. **/ + bytes = ci_SizeOfClusterData(cluster_data, false); + + /** If less is specified, skip uncomputed source. **/ + if (*less_ptr > 0llu && cluster_data->Clusters == NULL) goto no_print; + + /** Compute printing information. **/ type = "Cluster"; name = cluster_data->Name; - bytes = ci_SizeOfClusterData(cluster_data, false); break; } case 3u: { pSearchData search_data = (pSearchData)data; + + /** Compute size. **/ + bytes = ci_SizeOfSearchData(search_data); + + /** If less is specified, skip uncomputed source. **/ + if (*less_ptr > 0llu && search_data->Dups == NULL) goto no_print; + + /** Compute printing information. **/ type = "Search"; name = search_data->Name; - bytes = ci_SizeOfSearchData(search_data); break; } default: @@ -4107,14 +4129,20 @@ static int ci_PrintEntry(pXHashEntry entry, void* arg) return -1; } - /** Increment total bytes. **/ - *total_bytes_ptr += bytes; + /** Print the cache entry data. **/ char buf[12]; snprint_bytes(buf, sizeof(buf), bytes); printf("%-8s %-16s %-12s \"%s\"\n", type, name, buf, key); + increment_total: + *total_bytes_ptr += bytes; + return 0; + + no_print: + (*less_ptr)++; + goto increment_total; } @@ -4190,14 +4218,18 @@ int clusterExecuteMethod(void* inf_v, char* method_name, pObjData param, pObjTrx if (param->String == NULL) { mssErrorf(1, "Cluster", - "[param : \"show\" | \"show_all\" | \"drop_all\"] is required for the cache method." + "[param : \"show\" | \"show_less\" | \"show_all\" | \"drop_all\"] is required for the cache method." ); goto err; } /** 'show' and 'show_all'. **/ bool show = false; - if (strcmp(param->String, "show") == 0) + unsigned long long skip_uncomputed = 0llu; + if (strcmp(param->String, "show_less") == 0) + /** Specify show_less to skip uncomputed caches. **/ + skip_uncomputed = 1ull; + if (skip_uncomputed == 1ull || strcmp(param->String, "show") == 0) { show = true; path = ci_file_path(driver_data->NodeData->Parent); @@ -4217,25 +4249,32 @@ int clusterExecuteMethod(void* inf_v, char* method_name, pObjData param, pObjTrx failed |= !check(xhForEach( &ClusterDriverCaches.SourceDataCache, ci_PrintEntry, - (void*[]){&i, &source_bytes, path} + (void*[]){&i, &source_bytes, (void*)&skip_uncomputed, path} )); i++; failed |= !check(xhForEach( &ClusterDriverCaches.ClusterDataCache, ci_PrintEntry, - (void*[]){&i, &cluster_bytes, path} + (void*[]){&i, &cluster_bytes, (void*)&skip_uncomputed, path} )); i++; failed |= !check(xhForEach( &ClusterDriverCaches.SearchDataCache, ci_PrintEntry, - (void*[]){&i, &search_bytes, path} + (void*[]){&i, &search_bytes, (void*)&skip_uncomputed, path} )); if (failed) { mssErrorf(0, "Cluster", "Unexpected error occurred while showhing caches."); ret = -1; } + + /** Precomputations. **/ + unsigned int total_caches = 0u + + (unsigned int)ClusterDriverCaches.SourceDataCache.nItems + + (unsigned int)ClusterDriverCaches.ClusterDataCache.nItems + + (unsigned int)ClusterDriverCaches.SearchDataCache.nItems; + if (total_caches <= skip_uncomputed) printf("All caches skipped, nothing to show...\n"); /** Print stats. **/ char buf[16]; @@ -4244,10 +4283,10 @@ int clusterExecuteMethod(void* inf_v, char* method_name, pObjData param, pObjTrx printf("%-8s %-4d %-12s\n", "Source", ClusterDriverCaches.SourceDataCache.nItems, snprint_bytes(buf, sizeof(buf), source_bytes)); printf("%-8s %-4d %-12s\n", "Cluster", ClusterDriverCaches.ClusterDataCache.nItems, snprint_bytes(buf, sizeof(buf), cluster_bytes)); printf("%-8s %-4d %-12s\n", "Search", ClusterDriverCaches.SearchDataCache.nItems, snprint_bytes(buf, sizeof(buf), search_bytes)); - printf("%-8s %-4d %-12s\n\n", "Total", - ClusterDriverCaches.SourceDataCache.nItems + ClusterDriverCaches.ClusterDataCache.nItems + ClusterDriverCaches.SearchDataCache.nItems, - snprint_bytes(buf, sizeof(buf), source_bytes + cluster_bytes + search_bytes) - ); + printf("%-8s %-4d %-12s\n\n", "Total", total_caches, snprint_bytes(buf, sizeof(buf), source_bytes + cluster_bytes + search_bytes)); + + /** Print skip stats (if anything was skipped.) **/ + if (skip_uncomputed > 0llu) printf("Skipped %llu uncomputed caches.\n\n", skip_uncomputed - 1llu); return ret; } @@ -4262,7 +4301,7 @@ int clusterExecuteMethod(void* inf_v, char* method_name, pObjData param, pObjTrx /** Unknown parameter. **/ mssErrorf(1, "Cluster", - "Expected [param : \"show\" | \"show_all\" | \"drop_all\"] for the cache method, but got: \"%s\"", + "Expected [param : \"show\" | \"show_less\" | \"show_all\" | \"drop_all\"] for the cache method, but got: \"%s\"", param->String ); goto err; @@ -4272,17 +4311,17 @@ int clusterExecuteMethod(void* inf_v, char* method_name, pObjData param, pObjTrx { char buf[12]; printf("Cluster Driver Statistics:\n"); - printf(" Stat Name Value\n"); - printf(" OpenCalls %8s\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.OpenCalls)); - printf(" OpenQueryCalls %8s\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.OpenQueryCalls)); - printf(" FetchCalls %8s\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.FetchCalls)); - printf(" CloseCalls %8s\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.CloseCalls)); - printf(" GetTypeCalls %8s\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.GetTypeCalls)); - printf(" GetValCalls %8s\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.GetValCalls)); - printf(" GetValCalls_name %8s\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.GetValCalls_name)); - printf(" GetValCalls_key1 %8s\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.GetValCalls_key1)); - printf(" GetValCalls_key2 %8s\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.GetValCalls_key2)); - printf(" GetValCalls_sim %8s\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.GetValCalls_sim)); + printf(" Stat Name %12s\n", "Value"); + printf(" OpenCalls %12s\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.OpenCalls)); + printf(" OpenQueryCalls %12s\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.OpenQueryCalls)); + printf(" FetchCalls %12s\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.FetchCalls)); + printf(" CloseCalls %12s\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.CloseCalls)); + printf(" GetTypeCalls %12s\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.GetTypeCalls)); + printf(" GetValCalls %12s\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.GetValCalls)); + printf(" GetValCalls_name %12s\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.GetValCalls_name)); + printf(" GetValCalls_key1 %12s\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.GetValCalls_key1)); + printf(" GetValCalls_key2 %12s\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.GetValCalls_key2)); + printf(" GetValCalls_sim %12s\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.GetValCalls_sim)); return 0; } From 0c9eb2cf957b109b981b8f318652e0cff8effa0d Mon Sep 17 00:00:00 2001 From: Israel Date: Wed, 19 Nov 2025 15:30:35 -0700 Subject: [PATCH 018/275] Update cluster library to use dynamic memory for any data over a couple hundred bytes. Add check_double() to handle functions that return NAN on failure. Clean up. --- centrallix-lib/include/clusters.h | 4 +- centrallix-lib/include/util.h | 14 ++ centrallix-lib/src/clusters.c | 191 +++++++++++++++----------- centrallix/expression/exp_functions.c | 16 ++- centrallix/osdrivers/objdrv_cluster.c | 24 +++- 5 files changed, 160 insertions(+), 89 deletions(-) diff --git a/centrallix-lib/include/clusters.h b/centrallix-lib/include/clusters.h index c0718cea9..218422253 100644 --- a/centrallix-lib/include/clusters.h +++ b/centrallix-lib/include/clusters.h @@ -76,7 +76,7 @@ typedef struct nmRegister(sizeof(Dup), "Dup") /** Edit distance function. **/ -unsigned int edit_dist(const char* str1, const char* str2, const size_t str1_length, const size_t str2_length); +int edit_dist(const char* str1, const char* str2, const size_t str1_length, const size_t str2_length); /** Vector functions. **/ pVector ca_build_vector(const char* str); @@ -102,7 +102,7 @@ int ca_kmeans( _v[0] == -172 && _v[1] == 11 && _v[2] == -78; \ }) -/** Comparison functions, for ca_search(). **/ +/** Comparison functions (see ca_search()). **/ double ca_cos_compare(void* v1, void* v2); double ca_lev_compare(void* str1, void* str2); bool ca_eql(pVector v1, pVector v2); diff --git a/centrallix-lib/include/util.h b/centrallix-lib/include/util.h index 853954409..2c8537327 100644 --- a/centrallix-lib/include/util.h +++ b/centrallix-lib/include/util.h @@ -147,6 +147,20 @@ void print_diagnostics(int code, const char* function_name, const char* file_nam success; \ }) +/*** Ensures that developer diagnostics are printed if the result of the + *** passed function call is a NAN double. Not intended for user errors. + *** + *** @param result The result of the function we're checking. + *** @returns result + ***/ +#define check_double(result) \ + ({ \ + errno = 0; /* Reset errno to prevent confusion. */ \ + __typeof__ (result) _r = (result); \ + if (isnan(_r)) print_diagnostics(0, #result, __FILE__, __LINE__); \ + _r; \ + }) + /*** Ensures that developer diagnostics are printed if the result of the *** passed function call is a NULL pointer. Not intended for user errors. *** diff --git a/centrallix-lib/src/clusters.c b/centrallix-lib/src/clusters.c index 4bfce8ee6..6487e28e7 100644 --- a/centrallix-lib/src/clusters.c +++ b/centrallix-lib/src/clusters.c @@ -124,8 +124,11 @@ static int charpair_cmp(const void *p1, const void *p2) ***/ pVector ca_build_vector(const char* str) { - unsigned char chars[strlen(str) + 2u]; unsigned int num_chars = 0u; + unsigned char* chars = check_ptr(nmSysMalloc((strlen(str) + 2u) * sizeof(unsigned char))); + if (chars == NULL) goto err; + + /** Begin adding char pairs (in order). **/ chars[num_chars++] = CA_BOUNDARY_CHAR; /* Starting boundary character. */ for (const char* char_ptr = str; *char_ptr != '\0'; char_ptr++) { @@ -149,8 +152,9 @@ pVector ca_build_vector(const char* str) } chars[num_chars++] = CA_BOUNDARY_CHAR; /* Ending boundary character. */ - /** Compute char pairs. **/ - CharPair char_pairs[num_chars]; + /** Compute hash values for char pairs. **/ + CharPair* char_pairs = check_ptr(nmSysMalloc(num_chars * sizeof(CharPair))); + if (char_pairs == NULL) goto err; const unsigned int num_pairs = num_chars - 1u; for (unsigned int i = 0u; i < num_pairs; i++) { @@ -163,12 +167,16 @@ pVector ca_build_vector(const char* str) char_pairs[i].hash = hash_char_pair(chars[i], chars[i + 1]); } + /** Free unused memory. **/ + nmSysFree(chars); + chars = NULL; + /** Sort char_pairs by hash value. **/ qsort(char_pairs, num_pairs, sizeof(CharPair), charpair_cmp); /** Allocate space for the sparse vector. **/ - pVector sparse_vector = (pVector)check_ptr(nmSysMalloc((num_pairs * 2u + 1u) * sizeof(int))); - if (sparse_vector == NULL) return NULL; + pVector sparse_vector = check_ptr(nmSysMalloc((num_pairs * 2u + 1u) * sizeof(int))); + if (sparse_vector == NULL) goto err; /** Build the sparse vector. **/ unsigned int cur = 0u, dim = 0u; @@ -199,11 +207,23 @@ pVector ca_build_vector(const char* str) } if (dim != CA_NUM_DIMS) sparse_vector[cur++] = -(CA_NUM_DIMS - dim); + /** Free unused memory. **/ + nmSysFree(char_pairs); + char_pairs = NULL; + /** Trim extra space wasted by identical hashes. **/ - pVector trimmed_sparse_vector = (pVector)check_ptr(nmSysRealloc(sparse_vector, cur * sizeof(int))); - if (trimmed_sparse_vector == NULL) return NULL; + pVector trimmed_sparse_vector = check_ptr(nmSysRealloc(sparse_vector, cur * sizeof(int))); + if (trimmed_sparse_vector == NULL) goto err; + sparse_vector = NULL; /* Mark memory freed by nmSysRealloc() no longer valid. */ + /** Return the result. **/ return trimmed_sparse_vector; + + err: + if (sparse_vector != NULL) nmSysFree(sparse_vector); + if (char_pairs != NULL) nmSysFree(char_pairs); + if (chars != NULL) nmSysFree(chars); + return NULL; } /*** Free memory allocated to store a sparse vector. @@ -404,6 +424,7 @@ static double sparse_similarity_to_centroid(const pVector v1, const pCentroid c2 *** @param str2 The second string. *** @param length1 The length of the first string. *** @param length1 The length of the first string. + *** @returns The edit distance between the two strings, or a negative value on error. *** *** @attention - `Tip`: Pass 0 for the length of either string to infer it *** using the null terminating character. Conversely, character arrays @@ -412,8 +433,10 @@ static double sparse_similarity_to_centroid(const pVector v1, const pCentroid c2 *** @attention - `Complexity`: O(nm), where n and m are the lengths of str1 *** and str2 (respectively). ***/ -unsigned int edit_dist(const char* str1, const char* str2, const size_t str1_length, const size_t str2_length) +int edit_dist(const char* str1, const char* str2, const size_t str1_length, const size_t str2_length) { + int result = -1; + /*** lev_matrix: *** For all i and j, d[i][j] will hold the Levenshtein distance between *** the first i characters of s and the first j characters of t. @@ -423,9 +446,13 @@ unsigned int edit_dist(const char* str1, const char* str2, const size_t str1_len ***/ const size_t str1_len = (str1_length == 0u) ? strlen(str1) : str1_length; const size_t str2_len = (str2_length == 0u) ? strlen(str2) : str2_length; - unsigned int* lev_matrix[str1_len + 1]; + unsigned int** lev_matrix = check_ptr(nmSysMalloc((str1_len + 1) * sizeof(unsigned int*))); + if (lev_matrix == NULL) goto end; for (unsigned int i = 0u; i < str1_len + 1u; i++) - lev_matrix[i] = nmMalloc((str2_len + 1) * sizeof(unsigned int)); + { + lev_matrix[i] = check_ptr(nmSysMalloc((str2_len + 1) * sizeof(unsigned int))); + if (lev_matrix[i] == NULL) goto end; + } /*** Base case #0: *** Transforming an empty string into an empty string has 0 cost. @@ -472,19 +499,36 @@ unsigned int edit_dist(const char* str1, const char* str2, const size_t str1_len ); unsigned int cost_swap = (can_swap) ? lev_matrix[i - 2][j - 2] + 1 : UINT_MAX; - // Find the best operation. + /** Assign the best operation. **/ lev_matrix[i][j] = min(min(min(cost_delete, cost_insert), cost_replace), cost_swap); } } } /** Store result. **/ - unsigned int result = lev_matrix[str1_len][str2_len]; + unsigned int unsigned_result = lev_matrix[str1_len][str2_len]; + if (unsigned_result > INT_MAX) + { + fprintf(stderr, + "Warning: Integer overflow detected in edit_dist(\"%s\", \"%s\", %lu, %lu) = %u > %d\n", + str1, str2, str1_length, str2_length, unsigned_result, INT_MAX + ); + } + result = (int)unsigned_result; /** Cleanup. **/ - for (unsigned int i = 0u; i < str1_len + 1u; i++) - nmFree(lev_matrix[i], (str2_len + 1) * sizeof(unsigned int)); + end: + if (lev_matrix != NULL) + { + for (unsigned int i = 0u; i < str1_len + 1u; i++) + { + if (lev_matrix[i] == NULL) break; + else nmSysFree(lev_matrix[i]); + } + nmSysFree(lev_matrix); + } + /** Done. **/ return result; } @@ -527,7 +571,7 @@ double ca_cos_compare(void* v1, void* v2) *** *** @param str1 A `char*` to the first string to compare. *** @param str2 A `char*` to the second string to compare. - *** @returns The levenshtein similarity between the two strings. + *** @returns The levenshtein similarity between the two strings, or NAN on failure. ***/ double ca_lev_compare(void* str1, void* str2) { @@ -543,7 +587,8 @@ double ca_lev_compare(void* str1, void* str2) if (len1 == 0lu && len2 != 0lu) return 0.0; /** Compute levenshtein edit distance. **/ - const unsigned int dist = edit_dist((const char*)str1, (const char*)str2, len1, len2); + const int dist = check_neg(edit_dist((const char*)str1, (const char*)str2, len1, len2)); + if (dist < 0) return NAN; /** Normalize edit distance into a similarity measure. **/ const double normalized_similarity = 1.0 - (double)dist / (double)max(len1, len2); @@ -583,11 +628,14 @@ static double get_cluster_size( pCentroid* centroids, const unsigned int num_clusters) { + double result = NAN; /** Could be up to around 1KB on the stack, but I think that's fine. **/ - double cluster_sums[num_clusters]; - unsigned int cluster_counts[num_clusters]; - memset(cluster_sums, 0, sizeof(cluster_sums)); - memset(cluster_counts, 0, sizeof(cluster_counts)); + double* cluster_sums = check_ptr(nmSysMalloc(num_clusters * sizeof(double))); + unsigned int* cluster_counts = check_ptr(nmSysMalloc(num_clusters * sizeof(unsigned int))); + if (cluster_sums == NULL) goto end; + if (cluster_counts == NULL) goto end; + memset(cluster_sums, 0, sizeof(num_clusters * sizeof(double))); + memset(cluster_counts, 0, sizeof(num_clusters * sizeof(unsigned int))); /** Sum the difference from each vector to its cluster centroid. **/ for (unsigned int i = 0u; i < num_vectors; i++) @@ -609,37 +657,15 @@ static double get_cluster_size( num_valid_clusters++; } - /** Return average sizes. **/ - return cluster_total / num_valid_clusters; - } - -/*** Compute the param_value for `k` (number of clusters), given a dataset of with - *** a size of `n`. - *** - *** The following table shows data sizes vs.selected cluster size. In testing, - *** these numbers tended to give a good balance of accuracy and duplicates detected. - *** - *** ```csv - *** Data Size, Actual - *** 10k, 12 - *** 100k, 33 - *** 1M, 67 - *** 4M, 93 - *** ``` - *** - *** This function is not intended for datasets smaller than (`n < ~2000`). - *** These should be handled using complete search. - *** - *** LaTeX Notation: \log_{36}\left(n\right)^{3.1}-8 - *** - *** @param n The size of the dataset. - *** @returns k, the number of clusters to use. - *** - *** Complexity: `O(1)` - ***/ -unsigned int compute_k(const unsigned int n) - { - return (unsigned)max(2, pow(log(n) / log(36), 3.2) - 8); + /** Calculate average sizes. **/ + result = cluster_total / num_valid_clusters; + + end: + /** Clean up. **/ + if (cluster_sums != NULL) nmSysFree(cluster_sums); + if (cluster_counts != NULL) nmSysFree(cluster_counts); + + return result; } /*** Executes the k-means clustering algorithm. Selects NUM_CLUSTERS random @@ -696,22 +722,19 @@ int ca_kmeans( /** Allocate space to store centroids and new_centroids. **/ /** Dynamic allocation is required because these densely allocated arrays might be up to 500KB! **/ const size_t centroids_size = num_clusters * sizeof(pCentroid); - pCentroid* centroids = (pCentroid*)check_ptr(nmMalloc(centroids_size)); + pCentroid* centroids = check_ptr(nmMalloc(centroids_size)); + pCentroid* new_centroids = check_ptr(nmMalloc(centroids_size)); if (centroids == NULL) goto end; + if (new_centroids == NULL) goto end; memset(centroids, 0, centroids_size); - pCentroid* new_centroids = (pCentroid*)check_ptr(nmMalloc(centroids_size)); - if (new_centroids == NULL) goto end_free_centroids; memset(new_centroids, 0, centroids_size); for (unsigned int i = 0u; i < num_clusters; i++) { - /** Malloc each centroid. **/ - centroids[i] = (pCentroid)check_ptr(nmMalloc(pCentroidSize)); - if (centroids[i] == NULL) goto end_deep_free_centroids; + centroids[i] = check_ptr(nmMalloc(pCentroidSize)); + new_centroids[i] = check_ptr(nmMalloc(pCentroidSize)); + if (centroids[i] == NULL) goto end; + if (new_centroids[i] == NULL) goto end; memset(centroids[i], 0, pCentroidSize); - - /** Malloc each new centroid. **/ - new_centroids[i] = (pCentroid)check_ptr(nmMalloc(pCentroidSize)); - if (new_centroids[i] == NULL) goto end_deep_free_centroids; memset(new_centroids[i], 0, pCentroidSize); } @@ -797,8 +820,9 @@ int ca_kmeans( } /** Is there enough improvement? **/ - if (min_improvement < -1) continue; /** Skip check if it will always fail. **/ - const double average_cluster_size = get_cluster_size(vectors, num_vectors, labels, centroids, num_clusters); + if (min_improvement < -1) continue; /** Skip check if it will never end the loop. **/ + const double average_cluster_size = check_double(get_cluster_size(vectors, num_vectors, labels, centroids, num_clusters)); + if (isnan(average_cluster_size)) goto end; const double improvement = old_average_cluster_size - average_cluster_size; if (improvement < min_improvement) break; old_average_cluster_size = average_cluster_size; @@ -815,22 +839,25 @@ int ca_kmeans( successful = true; /** Clean up. **/ - end_deep_free_centroids: - for (unsigned int i = 0u; i < num_clusters; i++) + end: + if (centroids != NULL) + { + for (unsigned int i = 0u; i < num_clusters; i++) + { + if (centroids[i] != NULL) nmFree(centroids[i], pCentroidSize); + else break; + } + nmFree(centroids, num_clusters * sizeof(pCentroid)); + } + if (new_centroids != NULL) { - if (centroids[i] != NULL) nmFree(centroids[i], pCentroidSize); - else break; - if (new_centroids[i] != NULL) nmFree(new_centroids[i], pCentroidSize); - else break; + for (unsigned int i = 0u; i < num_clusters; i++) + { + if (new_centroids[i] != NULL) nmFree(new_centroids[i], pCentroidSize); + else break; + } + nmFree(new_centroids, num_clusters * sizeof(pCentroid)); } - - // end_free_new_centroids: - nmFree(new_centroids, num_clusters * sizeof(pCentroid)); - - end_free_centroids: - nmFree(centroids, num_clusters * sizeof(pCentroid)); - - end: return (successful) ? 0 : -1; } @@ -860,7 +887,8 @@ void* ca_most_similar( double best_sim = -INFINITY; for (unsigned int i = 0u; (num_data == 0u) ? (data[i] != NULL) : (i < num_data); i++) { - const double sim = similarity(target, data[i]); + const double sim = check_double(similarity(target, data[i])); + if (isnan(sim)) continue; /* Skip this comparison. */ if (sim > best_sim && sim > threshold) { most_similar = data[i]; @@ -889,8 +917,8 @@ void* ca_most_similar( *** struct. If this variable is null, these values are also left null. *** @param maybe_dups A pointer to an xArray in which dups should be found. *** Pass NULL to allocate a new one. - *** @returns An xArray holding all of the duplocates found. If maybe_dups is - *** not NULL, this will be that xArray, to allow for chaining. + *** @returns An xArray holding all of the duplocates found, or NULL if an + *** error occurs. ***/ pXArray ca_sliding_search( void** data, @@ -919,7 +947,8 @@ pXArray ca_sliding_search( const unsigned int window_end = min(i + window_size, num_data); for (unsigned int j = window_start; j < window_end; j++) { - const double sim = similarity(data[i], data[j]); + const double sim = check_double(similarity(data[i], data[j])); + if (isnan(sim)) goto err_free_dups; if (sim > threshold) /* Dup found! */ { Dup* dup = (Dup*)check_ptr(nmMalloc(sizeof(Dup))); diff --git a/centrallix/expression/exp_functions.c b/centrallix/expression/exp_functions.c index dd65a0c52..4932bcf1a 100644 --- a/centrallix/expression/exp_functions.c +++ b/centrallix/expression/exp_functions.c @@ -4316,7 +4316,15 @@ static int exp_fn_compare(pExpression tree, pParamObjects obj_list, const char* } else { /* lev_compare() */ - tree->Types.Double = ca_lev_compare(str1, str2); + double lev_sim = check_double(ca_lev_compare(str1, str2)); + if (isnan(lev_sim)) + { + mssErrorf(1, "EXP", "%s(\"%s\", \"%s\") Failed to compute levenstein edit distance."); + return -1; + } + + /** Return the computed result. **/ + tree->Types.Double = lev_sim; tree->DataType = DATA_T_DOUBLE; return 0; } @@ -4359,7 +4367,11 @@ int exp_fn_levenshtein(pExpression tree, pParamObjects obj_list) /** Compute edit distance. **/ /** Length 0 is provided for both strings so that the function will compute it for us. **/ - tree->Integer = edit_dist(str1, str2, 0lu, 0lu); + int dist = check_neg(edit_dist(str1, str2, 0lu, 0lu)); + if (dist < 0) return -1; + + /** Return the computed distance. **/ + tree->Integer = dist; tree->DataType = DATA_T_INTEGER; return 0; } diff --git a/centrallix/osdrivers/objdrv_cluster.c b/centrallix/osdrivers/objdrv_cluster.c index 8fb97b184..e38fb3e68 100644 --- a/centrallix/osdrivers/objdrv_cluster.c +++ b/centrallix/osdrivers/objdrv_cluster.c @@ -2546,7 +2546,6 @@ static int ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data) if (labels == NULL) goto err_free_sims; /** Run kmeans. **/ - Timer timer_i, *timer = timer_start(timer_init(&timer_i)); const bool successful = check(ca_kmeans( source_data->Vectors, source_data->nVectors, @@ -2556,7 +2555,6 @@ static int ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data) labels, cluster_data->Sims )); - timer_stop(timer); if (!successful) goto err_free_sims; /** Convert the labels into clusters. **/ @@ -2675,6 +2673,11 @@ static int ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) (void**)cluster_data->SourceData->Keys, dups )); + if (dups_temp == NULL) + { + mssErrorf(1, "Cluster", "Failed to compute sliding search with cosine similarity measure."); + goto err_free; + } } else { @@ -2688,7 +2691,11 @@ static int ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) (void**)cluster_data->SourceData->Keys, dups )); - if (dups_temp == NULL) goto err_free; + if (dups_temp == NULL) + { + mssErrorf(1, "Cluster", "Failed to compute complete search with cosine similarity measure."); + goto err_free; + } else dups = dups_temp; } } @@ -2708,6 +2715,11 @@ static int ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) (void**)cluster_data->SourceData->Keys, dups )); + if (dups_temp == NULL) + { + mssErrorf(1, "Cluster", "Failed to compute sliding search with Levenstein similarity measure."); + goto err_free; + } } else { @@ -2721,7 +2733,11 @@ static int ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) (void**)cluster_data->SourceData->Keys, dups )); - if (dups_temp == NULL) goto err_free; + if (dups_temp == NULL) + { + mssErrorf(1, "Cluster", "Failed to compute complete search with Levenstein similarity measure."); + goto err_free; + } else dups = dups_temp; } } From 394764efdbc6548162b1b5b7a9401428ec8e6aaa Mon Sep 17 00:00:00 2001 From: Israel Date: Wed, 19 Nov 2025 15:37:31 -0700 Subject: [PATCH 019/275] Remove necessary requests for the driver name in objQueryFetch(). --- centrallix/objectsystem/obj_query.c | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/centrallix/objectsystem/obj_query.c b/centrallix/objectsystem/obj_query.c index 9b64f241f..c4dff40ac 100644 --- a/centrallix/objectsystem/obj_query.c +++ b/centrallix/objectsystem/obj_query.c @@ -414,7 +414,6 @@ objQueryFetch(pObjQuery this, int mode) { pObject obj = NULL; void* obj_data; - char* name; char buf[OBJSYS_MAX_PATH + 32]; pObjQuerySortItem sort_item; int rval; @@ -529,14 +528,6 @@ objQueryFetch(pObjQuery this, int mode) goto error; } obj->Data = obj_data; - - this->Obj->Driver->GetAttrValue(obj_data, "name", DATA_T_STRING, &name, NULL); - if (strlen(name) + strlen(this->Obj->Pathname->Pathbuf) + 2 > OBJSYS_MAX_PATH) - { - mssError(1,"OSML","Filename in query result exceeded internal limits"); - OSMLDEBUG(OBJ_DEBUG_F_APITRACE, " null\n"); - goto error; - } /** If we need to check it, do so now. **/ if (!(this->Flags & OBJ_QY_F_FULLQUERY) && this->Tree) @@ -778,4 +769,3 @@ objGetQueryIdentityPath(pObjQuery this, char* pathbuf, int maxlen) return 0; } - From 9b8cc19754e2109004de9bac1cb944ce378fbdf9 Mon Sep 17 00:00:00 2001 From: Israel Date: Thu, 20 Nov 2025 09:52:50 -0700 Subject: [PATCH 020/275] Fix bugs that caused regressions after the updates to the cluster library. Round similarity results to avoid floating point errors. Enable caching for memory allocated in get_cluster_size(). Rename edit_dist() to ca_edit_dist() to match format for public functions. Rename print_diagnostics() to print_err(). --- centrallix-lib/include/clusters.h | 2 +- centrallix-lib/include/util.h | 12 +++---- centrallix-lib/src/clusters.c | 51 ++++++++++++++++----------- centrallix-lib/src/util.c | 2 +- centrallix/expression/exp_functions.c | 10 ++++-- centrallix/osdrivers/objdrv_cluster.c | 5 +-- 6 files changed, 48 insertions(+), 34 deletions(-) diff --git a/centrallix-lib/include/clusters.h b/centrallix-lib/include/clusters.h index 218422253..879ac652a 100644 --- a/centrallix-lib/include/clusters.h +++ b/centrallix-lib/include/clusters.h @@ -76,7 +76,7 @@ typedef struct nmRegister(sizeof(Dup), "Dup") /** Edit distance function. **/ -int edit_dist(const char* str1, const char* str2, const size_t str1_length, const size_t str2_length); +int ca_edit_dist(const char* str1, const char* str2, const size_t str1_length, const size_t str2_length); /** Vector functions. **/ pVector ca_build_vector(const char* str); diff --git a/centrallix-lib/include/util.h b/centrallix-lib/include/util.h index 2c8537327..03b63abaf 100644 --- a/centrallix-lib/include/util.h +++ b/centrallix-lib/include/util.h @@ -100,7 +100,7 @@ extern "C" { }) /** Error Handling. **/ -void print_diagnostics(int code, const char* function_name, const char* file_name, const int line_number); +void print_err(int code, const char* function_name, const char* file_name, const int line_number); /*** Ensures that developer diagnostics are printed if the result of the *** passed function call is not zero. Not intended for user errors. @@ -113,7 +113,7 @@ void print_diagnostics(int code, const char* function_name, const char* file_nam errno = 0; /* Reset errno to prevent confusion. */ \ __typeof__ (result) _r = (result); \ const bool success = (_r == 0); \ - if (!success) print_diagnostics(_r, #result, __FILE__, __LINE__); \ + if (!success) print_err(_r, #result, __FILE__, __LINE__); \ success; \ }) @@ -128,7 +128,7 @@ void print_diagnostics(int code, const char* function_name, const char* file_nam errno = 0; /* Reset errno to prevent confusion. */ \ __typeof__ (result) _r = (result); \ const bool success = (_r >= 0); \ - if (!success) print_diagnostics(_r, #result, __FILE__, __LINE__); \ + if (!success) print_err(_r, #result, __FILE__, __LINE__); \ success; \ }) @@ -143,7 +143,7 @@ void print_diagnostics(int code, const char* function_name, const char* file_nam errno = 0; /* Reset errno to prevent confusion. */ \ __typeof__ (result) _r = (result); \ const bool success = (_r != -1); \ - if (!success) print_diagnostics(_r, #result, __FILE__, __LINE__); \ + if (!success) print_err(_r, #result, __FILE__, __LINE__); \ success; \ }) @@ -157,7 +157,7 @@ void print_diagnostics(int code, const char* function_name, const char* file_nam ({ \ errno = 0; /* Reset errno to prevent confusion. */ \ __typeof__ (result) _r = (result); \ - if (isnan(_r)) print_diagnostics(0, #result, __FILE__, __LINE__); \ + if (isnan(_r)) print_err(0, #result, __FILE__, __LINE__); \ _r; \ }) @@ -171,7 +171,7 @@ void print_diagnostics(int code, const char* function_name, const char* file_nam ({ \ errno = 0; /* Reset errno to prevent confusion. */ \ __typeof__ (result) _r = (result); \ - if (_r == NULL) print_diagnostics(0, #result, __FILE__, __LINE__); \ + if (_r == NULL) print_err(0, #result, __FILE__, __LINE__); \ _r; \ }) diff --git a/centrallix-lib/src/clusters.c b/centrallix-lib/src/clusters.c index 6487e28e7..92125ce03 100644 --- a/centrallix-lib/src/clusters.c +++ b/centrallix-lib/src/clusters.c @@ -433,7 +433,7 @@ static double sparse_similarity_to_centroid(const pVector v1, const pCentroid c2 *** @attention - `Complexity`: O(nm), where n and m are the lengths of str1 *** and str2 (respectively). ***/ -int edit_dist(const char* str1, const char* str2, const size_t str1_length, const size_t str2_length) +int ca_edit_dist(const char* str1, const char* str2, const size_t str1_length, const size_t str2_length) { int result = -1; @@ -473,12 +473,12 @@ int edit_dist(const char* str1, const char* str2, const size_t str1_length, cons for (unsigned int j = 1u; j <= str2_len; j++) lev_matrix[0][j] = j; - /** General Case **/ + /** General Case. **/ for (unsigned int i = 1u; i <= str1_len; i++) { for (unsigned int j = 1u; j <= str2_len; j++) { - /** Equal characters need no changes. **/ + /** If the characters are equal, no change is needed. **/ if (str1[i - 1] == str2[j - 1]) lev_matrix[i][j] = lev_matrix[i - 1][j - 1]; @@ -510,7 +510,7 @@ int edit_dist(const char* str1, const char* str2, const size_t str1_length, cons if (unsigned_result > INT_MAX) { fprintf(stderr, - "Warning: Integer overflow detected in edit_dist(\"%s\", \"%s\", %lu, %lu) = %u > %d\n", + "Warning: Integer overflow detected in ca_edit_dist(\"%s\", \"%s\", %lu, %lu) = %u > %d\n", str1, str2, str1_length, str2_length, unsigned_result, INT_MAX ); } @@ -556,8 +556,8 @@ double ca_cos_compare(void* v1, void* v2) if (v1_empty && !v2_empty) return 0.0; if (!v1_empty && v2_empty) return 0.0; - /** Return the sparse similarity. **/ - return sparse_similarity(vec1, vec2); + /** Apply rounding to avoid annoying floating point issues before returning. **/ + return round(sparse_similarity(vec1, vec2) * 1000000) / 1000000; } /*** Compares two strings using their Levenshtein edit distance to compute a @@ -587,14 +587,14 @@ double ca_lev_compare(void* str1, void* str2) if (len1 == 0lu && len2 != 0lu) return 0.0; /** Compute levenshtein edit distance. **/ - const int dist = check_neg(edit_dist((const char*)str1, (const char*)str2, len1, len2)); - if (dist < 0) return NAN; + const int edit_dist = ca_edit_dist((const char*)str1, (const char*)str2, len1, len2); + if (!check_neg(edit_dist)) return NAN; /** Normalize edit distance into a similarity measure. **/ - const double normalized_similarity = 1.0 - (double)dist / (double)max(len1, len2); + const double normalized_similarity = 1.0 - (double)edit_dist / (double)max(len1, len2); - /** Done. **/ - return normalized_similarity; + /** Apply rounding to avoid annoying floating point issues before returning. **/ + return round(normalized_similarity * 1000000) / 1000000; } /*** Check if two sparse vectors are identical. @@ -629,9 +629,15 @@ static double get_cluster_size( const unsigned int num_clusters) { double result = NAN; - /** Could be up to around 1KB on the stack, but I think that's fine. **/ - double* cluster_sums = check_ptr(nmSysMalloc(num_clusters * sizeof(double))); - unsigned int* cluster_counts = check_ptr(nmSysMalloc(num_clusters * sizeof(unsigned int))); + + /** Allocate space to store clusters as averages are computed. **/ + /*** We use nmMalloc() here because this function is usually called + *** repeatedly with the same number of clusters in the k-means loop. + *** Also, it is likely that k-means may be invoked multiple times with + *** the same k value, leading to additional caching benefits. + ***/ + double* cluster_sums = check_ptr(nmMalloc(num_clusters * sizeof(double))); + unsigned int* cluster_counts = check_ptr(nmMalloc(num_clusters * sizeof(unsigned int))); if (cluster_sums == NULL) goto end; if (cluster_counts == NULL) goto end; memset(cluster_sums, 0, sizeof(num_clusters * sizeof(double))); @@ -662,8 +668,8 @@ static double get_cluster_size( end: /** Clean up. **/ - if (cluster_sums != NULL) nmSysFree(cluster_sums); - if (cluster_counts != NULL) nmSysFree(cluster_counts); + if (cluster_sums != NULL) nmFree(cluster_sums, num_clusters * sizeof(double)); + if (cluster_counts != NULL) nmFree(cluster_counts, num_clusters * sizeof(unsigned int)); return result; } @@ -939,7 +945,7 @@ pXArray ca_sliding_search( if (dups == NULL) goto err; } const int num_starting_dups = dups->nItems; - + /** Search for dups. **/ for (unsigned int i = 0u; i < num_data; i++) { @@ -948,7 +954,11 @@ pXArray ca_sliding_search( for (unsigned int j = window_start; j < window_end; j++) { const double sim = check_double(similarity(data[i], data[j])); - if (isnan(sim)) goto err_free_dups; + if (isnan(sim) || sim < 0.0 || 1.0 < sim) + { + fprintf(stderr, "Invalid similarity %g %lf.\n", sim, sim); + goto err_free_dups; + } if (sim > threshold) /* Dup found! */ { Dup* dup = (Dup*)check_ptr(nmMalloc(sizeof(Dup))); @@ -968,11 +978,10 @@ pXArray ca_sliding_search( return dups; /** Error cleanup. **/ - err_free_dups: - /** Free the dups we added to the XArray. */ + /** Free the dups that we added to the XArray. **/ while (dups->nItems > num_starting_dups) - nmFree(dups->Items[dups->nItems--], sizeof(Dup)); + nmFree(dups->Items[--dups->nItems], sizeof(Dup)); if (maybe_dups == NULL) check(xaDeInit(dups)); /* Failure ignored. */ err: diff --git a/centrallix-lib/src/util.c b/centrallix-lib/src/util.c index e39572f95..d326944d1 100644 --- a/centrallix-lib/src/util.c +++ b/centrallix-lib/src/util.c @@ -268,7 +268,7 @@ void timer_free(pTimer timer) /*** Function for failing on error, assuming the error came from a library or *** system function call, so that the error buffer is set to a valid value. ***/ -void print_diagnostics(int code, const char* function_name, const char* file_name, const int line_number) +void print_err(int code, const char* function_name, const char* file_name, const int line_number) { /** Create a descriptive error message. **/ char error_buf[BUFSIZ]; diff --git a/centrallix/expression/exp_functions.c b/centrallix/expression/exp_functions.c index 4932bcf1a..b2e3e84a8 100644 --- a/centrallix/expression/exp_functions.c +++ b/centrallix/expression/exp_functions.c @@ -4367,11 +4367,15 @@ int exp_fn_levenshtein(pExpression tree, pParamObjects obj_list) /** Compute edit distance. **/ /** Length 0 is provided for both strings so that the function will compute it for us. **/ - int dist = check_neg(edit_dist(str1, str2, 0lu, 0lu)); - if (dist < 0) return -1; + int edit_dist = ca_edit_dist(str1, str2, 0lu, 0lu); + if (!check_neg(edit_dist)) + { + mssErrorf(1, "EXP", "%s(\"%s\", \"%s\") Failed to compute edit distance.\n", fn_name, str1, str2); + return -1; + } /** Return the computed distance. **/ - tree->Integer = dist; + tree->Integer = edit_dist; tree->DataType = DATA_T_INTEGER; return 0; } diff --git a/centrallix/osdrivers/objdrv_cluster.c b/centrallix/osdrivers/objdrv_cluster.c index e38fb3e68..a264d886b 100644 --- a/centrallix/osdrivers/objdrv_cluster.c +++ b/centrallix/osdrivers/objdrv_cluster.c @@ -2691,7 +2691,7 @@ static int ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) (void**)cluster_data->SourceData->Keys, dups )); - if (dups_temp == NULL) + if (dups_temp == NULL) { mssErrorf(1, "Cluster", "Failed to compute complete search with cosine similarity measure."); goto err_free; @@ -2733,7 +2733,7 @@ static int ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) (void**)cluster_data->SourceData->Keys, dups )); - if (dups_temp == NULL) + if (dups_temp == NULL) { mssErrorf(1, "Cluster", "Failed to compute complete search with Levenstein similarity measure."); goto err_free; @@ -2753,6 +2753,7 @@ static int ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) } if (dups_temp == NULL) goto err_free; else dups = dups_temp; + // fprintf(stderr, "Done searching, found %d dups.\n", dups->nItems); /** Store dups. **/ search_data->nDups = dups->nItems; From 17156b7344d1aa2c32a839c66960b810b67b4d60 Mon Sep 17 00:00:00 2001 From: Israel Date: Thu, 20 Nov 2025 13:53:39 -0700 Subject: [PATCH 021/275] Fix an invalid free (nmFree used instead of nmSysFree()). Fix a possible uninitialized read. Fix memset() not initializing data. --- centrallix-lib/src/clusters.c | 23 ++++++++++++++++------- centrallix/osdrivers/objdrv_cluster.c | 2 +- 2 files changed, 17 insertions(+), 8 deletions(-) diff --git a/centrallix-lib/src/clusters.c b/centrallix-lib/src/clusters.c index 92125ce03..4504f53d7 100644 --- a/centrallix-lib/src/clusters.c +++ b/centrallix-lib/src/clusters.c @@ -154,7 +154,7 @@ pVector ca_build_vector(const char* str) /** Compute hash values for char pairs. **/ CharPair* char_pairs = check_ptr(nmSysMalloc(num_chars * sizeof(CharPair))); - if (char_pairs == NULL) goto err; + if (char_pairs == NULL) goto err_free_chars; const unsigned int num_pairs = num_chars - 1u; for (unsigned int i = 0u; i < num_pairs; i++) { @@ -176,7 +176,7 @@ pVector ca_build_vector(const char* str) /** Allocate space for the sparse vector. **/ pVector sparse_vector = check_ptr(nmSysMalloc((num_pairs * 2u + 1u) * sizeof(int))); - if (sparse_vector == NULL) goto err; + if (sparse_vector == NULL) goto err_free_char_pairs; /** Build the sparse vector. **/ unsigned int cur = 0u, dim = 0u; @@ -213,16 +213,22 @@ pVector ca_build_vector(const char* str) /** Trim extra space wasted by identical hashes. **/ pVector trimmed_sparse_vector = check_ptr(nmSysRealloc(sparse_vector, cur * sizeof(int))); - if (trimmed_sparse_vector == NULL) goto err; + if (trimmed_sparse_vector == NULL) goto err_free_sparse_vector; sparse_vector = NULL; /* Mark memory freed by nmSysRealloc() no longer valid. */ /** Return the result. **/ return trimmed_sparse_vector; - err: + err_free_sparse_vector: if (sparse_vector != NULL) nmSysFree(sparse_vector); + + err_free_char_pairs: if (char_pairs != NULL) nmSysFree(char_pairs); + + err_free_chars: if (chars != NULL) nmSysFree(chars); + + err: return NULL; } @@ -640,8 +646,11 @@ static double get_cluster_size( unsigned int* cluster_counts = check_ptr(nmMalloc(num_clusters * sizeof(unsigned int))); if (cluster_sums == NULL) goto end; if (cluster_counts == NULL) goto end; - memset(cluster_sums, 0, sizeof(num_clusters * sizeof(double))); - memset(cluster_counts, 0, sizeof(num_clusters * sizeof(unsigned int))); + for (unsigned int i = 0u; i < num_clusters; i++) + { + cluster_sums[i] = 0.0; + cluster_counts[i] = 0u; + } /** Sum the difference from each vector to its cluster centroid. **/ for (unsigned int i = 0u; i < num_vectors; i++) @@ -757,7 +766,7 @@ int ca_kmeans( { const int token = vector[i++]; if (token > 0) centroid[dim++] = (double)token; - else for (unsigned int j = 0u; j < -token; j++) centroid[dim++] = 0.0; + else for (unsigned int j = 0u; j < (unsigned)-token; j++) centroid[dim++] = 0.0; } } diff --git a/centrallix/osdrivers/objdrv_cluster.c b/centrallix/osdrivers/objdrv_cluster.c index a264d886b..8561eaba1 100644 --- a/centrallix/osdrivers/objdrv_cluster.c +++ b/centrallix/osdrivers/objdrv_cluster.c @@ -2567,7 +2567,7 @@ static int ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data) /** Iterate through each label and add the index of the specified cluster to the xArray. **/ for (unsigned long long i = 0llu; i < source_data->nVectors; i++) if (!check_neg(xaAddItem(&indexes_in_cluster[labels[i]], (void*)i))) goto err_free_sims; - nmFree(labels, lables_size); /* Free unused data. */ + nmSysFree(labels); /* Free unused data. */ /** Iterate through each cluster, store it, and free the xArray. **/ for (unsigned int i = 0u; i < cluster_data->nClusters; i++) From 29640a165ae7041158bcca22113a08941006f466 Mon Sep 17 00:00:00 2001 From: Israel Date: Thu, 20 Nov 2025 16:21:45 -0700 Subject: [PATCH 022/275] Minor improvements and clean up. --- centrallix/osdrivers/objdrv_cluster.c | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/centrallix/osdrivers/objdrv_cluster.c b/centrallix/osdrivers/objdrv_cluster.c index 8561eaba1..c09939b66 100644 --- a/centrallix/osdrivers/objdrv_cluster.c +++ b/centrallix/osdrivers/objdrv_cluster.c @@ -392,6 +392,7 @@ char* const ATTR_SEARCH_ENTRY[] = char* const METHOD_NAME[] = { "cache", + "stat", END_OF_ARRAY, }; @@ -549,7 +550,7 @@ typedef struct _SEARCH { char* Name; char* Key; - pClusterData Source; + pClusterData SourceCluster; double Threshold; pDup* Dups; unsigned int nDups; @@ -1376,8 +1377,8 @@ static pSearchData ci_ParseSearchData(pStructInf inf, pNodeData node_data) pClusterData cluster_data = node_data->ClusterDatas[i]; if (strcmp(source_cluster_name, cluster_data->Name) == 0) { - /** Source found. **/ - search_data->Source = cluster_data; + /** SourceCluster found. **/ + search_data->SourceCluster = cluster_data; break; } @@ -1385,7 +1386,7 @@ static pSearchData ci_ParseSearchData(pStructInf inf, pNodeData node_data) } /** Did we find the requested source? **/ - if (search_data->Source == NULL) + if (search_data->SourceCluster == NULL) { /** Print error. **/ mssErrorf(1, "Cluster", "Could not find cluster \"%s\" for search \"%s\".", source_cluster_name, search_data->Name); @@ -1479,7 +1480,7 @@ static pSearchData ci_ParseSearchData(pStructInf inf, pNodeData node_data) } /** Create cache entry key. **/ - char* source_key = search_data->Source->Key; + char* source_key = search_data->SourceCluster->Key; const size_t len = strlen(source_key) + strlen(search_data->Name) + 16lu; char* key = check_ptr(nmSysMalloc(len * sizeof(char))); if (key == NULL) goto err_free_search; @@ -2645,7 +2646,7 @@ static int ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) if (search_data->Dups != NULL) return 0; /** We need the cluster data to be computed before we search it. **/ - pClusterData cluster_data = search_data->Source; + pClusterData cluster_data = search_data->SourceCluster; ret = ci_ComputeClusterData(cluster_data, node_data); if (ret != 0) { @@ -3525,7 +3526,7 @@ int clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val if (strcmp(attr_name, "source") == 0) { - val->String = target->Source->Name; + val->String = target->SourceCluster->Name; return 0; } if (strcmp(attr_name, "similarity_measure") == 0) From 0fa62d3e487bae818a5e23a06ef99b006c09bcd4 Mon Sep 17 00:00:00 2001 From: Israel Date: Thu, 20 Nov 2025 16:38:48 -0700 Subject: [PATCH 023/275] Correct minor mistakes. Improve documentation. --- centrallix-lib/include/clusters.h | 4 ++++ centrallix-lib/src/clusters.c | 17 ++++++++++++++ centrallix/osdrivers/objdrv_cluster.c | 33 ++++++++++++++++----------- 3 files changed, 41 insertions(+), 13 deletions(-) diff --git a/centrallix-lib/include/clusters.h b/centrallix-lib/include/clusters.h index 879ac652a..8f916210e 100644 --- a/centrallix-lib/include/clusters.h +++ b/centrallix-lib/include/clusters.h @@ -47,6 +47,10 @@ /*** 2147483629 is the signed int max, and is also a prime number. *** Using this value ensures that the longest run of 0s will not *** cause an int underflow with the current encoding scheme. + *** + *** Unfortunately, we can't use a number this large yet because + *** kmeans algorithm creates densely allocated centroids with + *** `CA_NUM_DIMS` dimensions, so a large number causes it to fail. ***/ #define CA_NUM_DIMS 251 //2147483629 /* aka. The vector table size. */ diff --git a/centrallix-lib/src/clusters.c b/centrallix-lib/src/clusters.c index 4504f53d7..48119176a 100644 --- a/centrallix-lib/src/clusters.c +++ b/centrallix-lib/src/clusters.c @@ -64,6 +64,14 @@ static unsigned int hash_char_pair(const unsigned char c1, const unsigned char c return hash % CA_NUM_DIMS; } +/*** An internal struct for temporarily storing character pairs while building + *** sparse vectors. + *** + *** @param c1 The first character in the character pair. + *** @param c2 The second character in the character pair. + *** @param hash The hash for the two characters, calculated by calling the + *** hash_char_pair() function (above). + **/ typedef struct { unsigned char c1, c2; @@ -71,6 +79,15 @@ typedef struct } CharPair, *pCharPair; +/*** Internal function to compare two character pairs to allow us to sort them + *** by hash (ascending). + *** + *** @param p1 The first pCharPair. + *** @param p2 The second pCharPair. + *** @returns An int > 0 if p1's hash is larger. + *** An int < 0 if p2's hash is larger. + *** 0 if p1 and p2 have identical hashes. + ***/ static int charpair_cmp(const void *p1, const void *p2) { const CharPair *a = p1, *b = p2; diff --git a/centrallix/osdrivers/objdrv_cluster.c b/centrallix/osdrivers/objdrv_cluster.c index c09939b66..a41ffbd21 100644 --- a/centrallix/osdrivers/objdrv_cluster.c +++ b/centrallix/osdrivers/objdrv_cluster.c @@ -350,11 +350,14 @@ typedef unsigned char TargetType; /** Attribute name lists by TargetType. **/ #define END_OF_ARRAY NULL -char* const ATTR_ROOT[] = { +char* const ATTR_ROOT[] = + { "source", "attr_name", + "date_created", + "date_computed", END_OF_ARRAY, -}; + }; char* const ATTR_CLUSTER[] = { "algorithm", @@ -378,6 +381,8 @@ char* const ATTR_SEARCH[] = char* const ATTR_CLUSTER_ENTRY[] = { "items", + "date_created", + "date_computed", END_OF_ARRAY, }; char* const ATTR_SEARCH_ENTRY[] = @@ -385,6 +390,8 @@ char* const ATTR_SEARCH_ENTRY[] = "key1", "key2", "sim", + "date_created", + "date_computed", END_OF_ARRAY, }; @@ -432,17 +439,17 @@ char* const METHOD_NAME[] = ***/ typedef struct _SOURCE { - char* Name; - char* Key; - char* SourcePath; - char* KeyAttr; - char* NameAttr; - char** Keys; - char** Strings; - pVector* Vectors; - unsigned int nVectors; - DateTime DateCreated; - DateTime DateComputed; + char* Name; + char* Key; + char* SourcePath; + char* KeyAttr; + char* NameAttr; + char** Keys; + char** Strings; + pVector* Vectors; + unsigned int nVectors; + DateTime DateCreated; + DateTime DateComputed; } SourceData, *pSourceData; From 06bae81769b36244c3fb555c4041c7d1965d334e Mon Sep 17 00:00:00 2001 From: Israel Date: Fri, 21 Nov 2025 14:36:37 -0700 Subject: [PATCH 024/275] Implement a more extendable schema verification system. --- centrallix/expression/exp_functions.c | 193 ++++++++++++++++++++++++++ 1 file changed, 193 insertions(+) diff --git a/centrallix/expression/exp_functions.c b/centrallix/expression/exp_functions.c index b2e3e84a8..2e98cfd7c 100644 --- a/centrallix/expression/exp_functions.c +++ b/centrallix/expression/exp_functions.c @@ -99,6 +99,199 @@ static char* ci_TypeToStr(const int type) return "Invalid"; /* Shall not parse to a valid type in ci_TypeFromStr(). */ } +/*** Specifies expectations about an argument. + *** + *** @param Datatypes An array of datatypes (terminated with a -1). Set to NULL + *** to accept any datatype as valid for this argument. + *** @param Flags Flags to require other properties about an argument. If the + *** flag a required behavior for specific types, the requirement will be + *** skipped for other types. + *** + *** Valid Flags: + *** - `EXP_ARG_NOT_NULL`: Expect the arg to not be null. + *** - `EXP_ARG_FORCE_TYPE`: Run type check on null args (not recommended). + *** + *** @attention - Checks like `EXP_ARG_NON_EMPTY`, `EXP_ARG_NON_NAN`, etc. also + *** succeed for `NULL` values. To avoid this, specify `EXP_ARG_NOT_NULL`. + ***/ +typedef struct + { + int* Datatypes; + int Flags; + } + ArgExpect, *pArgExpect; + +#define EXP_ARG_NO_FLAGS (0) +#define EXP_ARG_NOT_NULL (1 << 0) +#define EXP_ARG_FORCE_TYPE (1 << 1) + +/*** An internal function used by the schema verifier (below) to verify each + *** argument of the schema. + ***/ +static int verify_arg(const char* fn_name, pExpression arg, const ArgExpect* arg_expect) + { + /** The expectation struct cannot be NULL. **/ + if (arg_expect == NULL) + { + mssErrorf(1, "EXP", + "%s(...): Expectation struct cannot be NULL", + fn_name + ); + return -1; + } + + /** Extract values. **/ + ASSERTMAGIC(arg, MGK_EXPRESSION); + int actual_datatype = arg->DataType; + + /** Check for a provided NULL value. **/ + if (arg->Flags & EXPR_F_NULL) + { + if (arg_expect->Flags & EXP_ARG_NOT_NULL) + { + mssErrorf(1, "EXP", + "%s(...): Expects a non-null value, but got NULL : %s (%d).", + fn_name, ci_TypeToStr(actual_datatype), actual_datatype + ); + return -1; + } + + /** Skip type checks unless forced. **/ + if (!(arg_expect->Flags & EXP_ARG_FORCE_TYPE)) goto skip_type_checks; + } + + /** No type checking required. **/ + if (arg_expect->Datatypes == NULL) goto skip_type_checks; + + /** No types given: Probably a mistake. **/ + if (arg_expect->Datatypes[0] == -1) + { + mssErrorf(1, "EXP", + "%s(...): Array of allowed Datatypes is empty.", + fn_name + ); + return -1; + } + + /** Verify Datatypes. **/ + bool found = false; + for (int j = 0; arg_expect->Datatypes[j] != -1; j++) + { + const int expected_datatype = arg_expect->Datatypes[j]; + if (expected_datatype == actual_datatype) + { + found = true; + break; + } + } + + /** Handle failure. **/ + if (!found) + { + /** Accumulate additional valid types. **/ + char buf[256] = {'\0'}; + int cur = 0, j = 1; + while (true) + { + int datatype = arg_expect->Datatypes[j++]; + if (datatype == -1) break; + + cur += snprintf( + buf + cur, 256 - cur, + " or %s (%d)", + ci_TypeToStr(datatype), datatype + ); + } + + /** Print error. **/ + int first_datatype = arg_expect->Datatypes[0]; + mssErrorf(1, "EXP", + "%s(...): Expects type %s (%d)%s but got type %s (%d).", + fn_name, ci_TypeToStr(first_datatype), first_datatype, buf, ci_TypeToStr(actual_datatype), actual_datatype + ); + return -1; + } + + skip_type_checks: + return 0; + } + +/*** Verify that arguments passed to a function match some expected values. + *** + *** @param fn_name The name of the function (for error messages). + *** @param arg_expects A pointer to an array of ArgExpect structs, each + *** representing expectations for a single argument, in the order they + *** are passed to the function. + *** @param num_args The number of arguments to expect to be passed to the + *** function (and the length of arg_expects). + *** @param tree The tree containing the actual arguments passed. + *** @param obj_list The object list scope which was passed to the function. + *** @returns 0 if all arguments are successfully verified, or + *** -1 if an error occurs or arguments are incorrect. + *** + *** @attention - Promises that an error message will be printed with a call + *** to mssError() if an error occurs. + *** + *** Example: + *** ```c + *** char fn_name[] = "example"; + *** if (verify_schema(fn_name, + *** (ArgExpect[]){ + *** {(int[]){DATA_T_INTEGER, DATA_T_DOUBLE, -1}, EXP_PARAM_NOT_NULL}, + *** {(int[]){DATA_T_STRING, -1}, 0} + *** }, 2, + *** tree, obj_list + *** ) != 0) + *** { + *** mssErrorf(0, "EXP", "%s(?) Call does not match function schema.", fn_name); + *** return -1; + *** } + *** ``` + ***/ +static int verify_schema( + const char* fn_name, + const ArgExpect* arg_expects, + const int num_args, + pExpression tree, + pParamObjects obj_list) + { + /** Verify object list and session. **/ + if (obj_list == NULL) + { + mssErrorf(1, "EXP", "%s(\?\?\?): No object list?", fn_name); + return -1; + } + ASSERTMAGIC(obj_list->Session, MGK_OBJSESSION); + + /** Verify expression tree. **/ + ASSERTMAGIC(tree, MGK_EXPRESSION); + + /** Verify argument count. **/ + const int num_args_actual = tree->Children.nItems; + if (num_args != num_args_actual) + { + mssErrorf(1, "EXP", + "%s(?): Expects %u argument%s, got %d argument%s.", + fn_name, num_args, (num_args == 1) ? "" : "s", num_args_actual, (num_args_actual == 1) ? "" : "s" + ); + return -1; + } + + /** Verify argument datatypes. **/ + for (int i = 0; i < num_args; i++) + { + if (verify_arg(fn_name, tree->Children.Items[i], &arg_expects[i]) != 0) + { + mssErrorf(0, "EXP", "%s(...): Error while reading arg #%d/%d.", fn_name, i + 1, num_args); + return -1; + } + } + + /** Pass. **/ + return 0; + } + + /****** Evaluator functions follow for expEvalFunction ******/ int exp_fn_getdate(pExpression tree, pParamObjects objlist, pExpression i0, pExpression i1, pExpression i2) From 13fd4b7017bcf3da971129d3d8e1a6b3f86d5fe3 Mon Sep 17 00:00:00 2001 From: Israel Date: Fri, 21 Nov 2025 14:38:24 -0700 Subject: [PATCH 025/275] Replace old schema verification with the new system. --- centrallix/expression/exp_functions.c | 94 ++++++++------------------- 1 file changed, 26 insertions(+), 68 deletions(-) diff --git a/centrallix/expression/exp_functions.c b/centrallix/expression/exp_functions.c index 2e98cfd7c..50e3ec745 100644 --- a/centrallix/expression/exp_functions.c +++ b/centrallix/expression/exp_functions.c @@ -4344,72 +4344,18 @@ int exp_fn_nth(pExpression tree, pParamObjects objlist, pExpression i0, pExpress return 0; } -static int exp_fn_verify_schema( - const char* fn_name, - const int* param_types, - const int num_params, - pExpression tree, - pParamObjects obj_list) - { - /** Verify object list and session. **/ - if (obj_list == NULL) - { - mssErrorf(1, "EXP", "%s(\?\?\?) no object list?", fn_name); - return -1; - } - ASSERTMAGIC(obj_list->Session, MGK_OBJSESSION); - - /** Verify expression tree. **/ - ASSERTMAGIC(tree, MGK_EXPRESSION); - - /** Verify parameter number. **/ - const int num_params_actual = tree->Children.nItems; - if (num_params != num_params_actual) - { - mssErrorf(1, "EXP", - "%s(?) expects %u param%s, got %d param%s.", - fn_name, num_params, (num_params > 1) ? "s" : "", num_params_actual, (num_params_actual > 1) ? "s" : "" - ); - return -1; - } - - /** Verify parameter datatypes. **/ - for (int i = 0; i < num_params; i++) - { - const pExpression arg = tree->Children.Items[i]; - ASSERTMAGIC(arg, MGK_EXPRESSION); - - /** Skip null values. **/ - if (arg->Flags & EXPR_F_NULL) continue; - - /** Extract datatypes. **/ - const int expected_datatype = param_types[i]; - const int actual_datatype = arg->DataType; - - /** Verify datatypes. **/ - if (expected_datatype != actual_datatype) - { - mssErrorf(1, "EXP", - "%s(...) param #%d/%d expects type %s (%d) but got type %s (%d).", - fn_name, i + 1, num_params, ci_TypeToStr(expected_datatype), expected_datatype, ci_TypeToStr(actual_datatype), actual_datatype - ); - return -1; - } - } - - /** Pass. **/ - return 0; - } - int exp_fn_metaphone(pExpression tree, pParamObjects obj_list) { const char fn_name[] = "metaphone"; /** Verify function schema. **/ - if (exp_fn_verify_schema(fn_name, (int[]){ DATA_T_STRING }, 1, tree, obj_list) != 0) + if (verify_schema(fn_name, + (ArgExpect[]){{(int[]){DATA_T_STRING, -1}, EXP_ARG_NO_FLAGS}}, 1, + tree, obj_list + ) != 0) { - mssErrorf(0, "EXP", "%s(?) Call does not match function schema.", fn_name); + mssErrorf(0, "EXP", "%s(?): Call does not match function schema.", fn_name); return -1; } @@ -4460,9 +4406,15 @@ int exp_fn_metaphone(pExpression tree, pParamObjects obj_list) static int exp_fn_compare(pExpression tree, pParamObjects obj_list, const char* fn_name) { /** Verify function schema. **/ - if (exp_fn_verify_schema(fn_name, (int[]){ DATA_T_STRING, DATA_T_STRING }, 2, tree, obj_list) != 0) - { - mssErrorf(0, "EXP", "%s(?) Call does not match function schema.", fn_name); + if (verify_schema(fn_name, + (ArgExpect[]){ + {(int[]){DATA_T_STRING, -1}, EXP_ARG_NO_FLAGS}, + {(int[]){DATA_T_STRING, -1}, EXP_ARG_NO_FLAGS} + }, 2, + tree, obj_list + ) != 0) + { + mssErrorf(0, "EXP", "%s(?): Call does not match function schema.", fn_name); return -1; } @@ -4489,7 +4441,7 @@ static int exp_fn_compare(pExpression tree, pParamObjects obj_list, const char* if (v1 == NULL || v2 == NULL) { mssErrorf(1, "EXP", - "%s(\"%s\", \"%s\") - Failed to build vectors.", + "%s(\"%s\", \"%s\"): Failed to build vectors.", fn_name, str1, str2 ); ret = -1; @@ -4512,7 +4464,7 @@ static int exp_fn_compare(pExpression tree, pParamObjects obj_list, const char* double lev_sim = check_double(ca_lev_compare(str1, str2)); if (isnan(lev_sim)) { - mssErrorf(1, "EXP", "%s(\"%s\", \"%s\") Failed to compute levenstein edit distance."); + mssErrorf(1, "EXP", "%s(\"%s\", \"%s\"): Failed to compute levenstein edit distance."); return -1; } @@ -4540,9 +4492,15 @@ int exp_fn_levenshtein(pExpression tree, pParamObjects obj_list) const char fn_name[] = "levenshtein"; /** Verify function schema. **/ - if (exp_fn_verify_schema(fn_name, (int[]){ DATA_T_STRING, DATA_T_STRING }, 2, tree, obj_list) != 0) - { - mssErrorf(0, "EXP", "%s(?) Call does not match function schema.", fn_name); + if (verify_schema(fn_name, + (ArgExpect[]){ + {(int[]){DATA_T_STRING, -1}, EXP_ARG_NO_FLAGS}, + {(int[]){DATA_T_STRING, -1}, EXP_ARG_NO_FLAGS} + }, 2, + tree, obj_list + ) != 0) + { + mssErrorf(0, "EXP", "%s(?): Call does not match function schema.", fn_name); return -1; } @@ -4563,7 +4521,7 @@ int exp_fn_levenshtein(pExpression tree, pParamObjects obj_list) int edit_dist = ca_edit_dist(str1, str2, 0lu, 0lu); if (!check_neg(edit_dist)) { - mssErrorf(1, "EXP", "%s(\"%s\", \"%s\") Failed to compute edit distance.\n", fn_name, str1, str2); + mssErrorf(1, "EXP", "%s(\"%s\", \"%s\"): Failed to compute edit distance.\n", fn_name, str1, str2); return -1; } From e83c15f8255ea451e3310019400031576225ad12 Mon Sep 17 00:00:00 2001 From: Israel Date: Fri, 21 Nov 2025 14:41:00 -0700 Subject: [PATCH 026/275] Expand the new schema verification system with extra data validation features. --- centrallix/expression/exp_functions.c | 181 ++++++++++++++++++++++++++ 1 file changed, 181 insertions(+) diff --git a/centrallix/expression/exp_functions.c b/centrallix/expression/exp_functions.c index 50e3ec745..7f8ad875d 100644 --- a/centrallix/expression/exp_functions.c +++ b/centrallix/expression/exp_functions.c @@ -110,6 +110,13 @@ static char* ci_TypeToStr(const int type) *** Valid Flags: *** - `EXP_ARG_NOT_NULL`: Expect the arg to not be null. *** - `EXP_ARG_FORCE_TYPE`: Run type check on null args (not recommended). + *** - `EXP_ARG_NON_EMPTY`: Expect string to be non-empty. Expect a + *** stringvec or intvec to have elements (does not check them). + *** - `EXP_ARG_POSITIVE`: Expect a positive or zero value for int, double, + *** money, or datetime. (Includes NON_NAN: NAN is not positive). + *** - `EXP_ARG_NEGATIVE`: Expect a negative or zero value for int, double, + *** money, or datetime. (Includes NON_NAN: NAN is not negative). + *** - `EXP_ARG_NON_NAN`: Expect a double to be a number, not NAN. *** *** @attention - Checks like `EXP_ARG_NON_EMPTY`, `EXP_ARG_NON_NAN`, etc. also *** succeed for `NULL` values. To avoid this, specify `EXP_ARG_NOT_NULL`. @@ -124,6 +131,10 @@ typedef struct #define EXP_ARG_NO_FLAGS (0) #define EXP_ARG_NOT_NULL (1 << 0) #define EXP_ARG_FORCE_TYPE (1 << 1) +#define EXP_ARG_NON_EMPTY (1 << 2) +#define EXP_ARG_NEGATIVE (1 << 3) +#define EXP_ARG_POSITIVE (1 << 4) +#define EXP_ARG_NON_NAN (1 << 5) /*** An internal function used by the schema verifier (below) to verify each *** argument of the schema. @@ -213,6 +224,150 @@ static int verify_arg(const char* fn_name, pExpression arg, const ArgExpect* arg } skip_type_checks: + /** All flag checks not implemented above should pass on NULL values. **/ + if (arg->Flags & EXPR_F_NULL) return 0; + + /** Verify other Flags by type, if specified. **/ + switch (actual_datatype) + { + case DATA_T_INTEGER: + { + int value = arg->Integer; + if (arg_expect->Flags & EXP_ARG_POSITIVE && value < 0) + { + mssErrorf(1, "EXP", + "%s(...): Expects positive int but got %d.", + fn_name, value + ); + return -1; + } + if (arg_expect->Flags & EXP_ARG_NEGATIVE && value > 0) + { + mssErrorf(1, "EXP", + "%s(...): Expects negative int but got %d.", + fn_name, value + ); + return -1; + } + break; + } + + case DATA_T_DOUBLE: + { + double value = arg->Types.Double; + if (arg_expect->Flags & EXP_ARG_NON_NAN && isnan(value)) + { + mssErrorf(1, "EXP", + "%s(...): Expects non-nan double but got %g.", + fn_name, value + ); + return -1; + } + if (arg_expect->Flags & EXP_ARG_POSITIVE && value < 0) + { + mssErrorf(1, "EXP", + "%s(...): Expects positive double but got %g.", + fn_name, value + ); + return -1; + } + if (arg_expect->Flags & EXP_ARG_NEGATIVE && value > 0) + { + mssErrorf(1, "EXP", + "%s(...): Expects negative double but got %g.", + fn_name, value + ); + return -1; + } + break; + } + + case DATA_T_STRING: + { + char* str = arg->String; + if (arg_expect->Flags & EXP_ARG_NON_EMPTY && str[0] == '\0') + { + mssErrorf(1, "EXP", + "%s(...): Expects string to contain characters, but got \"\".", + fn_name + ); + return -1; + } + break; + } + + case DATA_T_DATETIME: + { + pDateTime value = &arg->Types.Date; + if (arg_expect->Flags & EXP_ARG_POSITIVE && value->Value < 0) + { + mssErrorf(1, "EXP", + "%s(...): Expects positive date offset but got %llu.", + fn_name, value->Value + ); + return -1; + } + if (arg_expect->Flags & EXP_ARG_NEGATIVE && value->Value > 0) + { + mssErrorf(1, "EXP", + "%s(...): Expects negative date offset but got %llu.", + fn_name, value->Value + ); + return -1; + } + break; + } + + case DATA_T_MONEY: + { + pMoneyType value = &arg->Types.Money; + if (arg_expect->Flags & EXP_ARG_POSITIVE && value->WholePart < 0) + { + mssErrorf(1, "EXP", + "%s(...): Expects positive money value but got $%d.%d.", + fn_name, value->WholePart, value->FractionPart + ); + return -1; + } + if (arg_expect->Flags & EXP_ARG_NEGATIVE && value->WholePart > 0) + { + mssErrorf(1, "EXP", + "%s(...): Expects negative money value but got $%d.%d.", + fn_name, value->WholePart, value->FractionPart + ); + return -1; + } + } + + case DATA_T_STRINGVEC: + { + pStringVec str_vec = &arg->Types.StrVec; + if (arg_expect->Flags & EXP_ARG_NON_EMPTY && str_vec->nStrings == 0) + { + mssErrorf(1, "EXP", + "%s(...): Expects StringVec to contain strings, but got [].", + fn_name + ); + return -1; + } + break; + } + + case DATA_T_INTVEC: + { + pIntVec int_vec = &arg->Types.IntVec; + if (arg_expect->Flags & EXP_ARG_NON_EMPTY && int_vec->nIntegers == 0) + { + mssErrorf(1, "EXP", + "%s(...): Expects IntVec to contain strings, but got [].", + fn_name + ); + return -1; + } + break; + } + } + return 0; } @@ -291,6 +446,31 @@ static int verify_schema( return 0; } +int exp_fn_test(pExpression tree, pParamObjects obj_list) + { + char fn_name[] = "test"; + if (verify_schema(fn_name, + (ArgExpect[]){ + {(int[]){DATA_T_INTEGER, DATA_T_DOUBLE, -1}, EXP_ARG_NOT_NULL | EXP_ARG_NON_NAN}, + {(int[]){DATA_T_STRING, -1}, EXP_ARG_NOT_NULL | EXP_ARG_NON_EMPTY} + }, 2, + tree, obj_list + ) != 0) + { + mssErrorf(0, "EXP", "%s(?): Call does not match function schema.", fn_name); + return -1; + } + + pExpression arg1 = tree->Children.Items[0]; + pExpression arg2 = tree->Children.Items[1]; + if (arg1->DataType == DATA_T_INTEGER) printf("Success: %d, '%s'.\n", arg1->Integer, arg2->String); + else printf("Success: %g, '%s'.\n", arg1->Types.Double, arg2->String); + + tree->DataType = DATA_T_INTEGER; + tree->Flags |= EXPR_F_NULL; + return 0; + } + /****** Evaluator functions follow for expEvalFunction ******/ @@ -4678,6 +4858,7 @@ int exp_internal_DefineFunctions() xhAdd(&EXP.Functions, "pbkdf2", (char*)exp_fn_pbkdf2); xhAdd(&EXP.Functions, "octet_length", (char*)exp_fn_octet_length); xhAdd(&EXP.Functions, "argon2id",(char*)exp_fn_argon2id); + xhAdd(&EXP.Functions, "test", (char*)exp_fn_test); /** Dates. **/ xhAdd(&EXP.Functions, "getdate", (char*)exp_fn_getdate); From 070cfe3191265ee9c5546066799cfdcedf3572d0 Mon Sep 17 00:00:00 2001 From: Israel Date: Fri, 21 Nov 2025 16:04:14 -0700 Subject: [PATCH 027/275] Clean up, bug fixes, and naming convention updates. Remove test function. --- centrallix/expression/exp_functions.c | 54 +++++++-------------------- 1 file changed, 14 insertions(+), 40 deletions(-) diff --git a/centrallix/expression/exp_functions.c b/centrallix/expression/exp_functions.c index 7f8ad875d..08867f8af 100644 --- a/centrallix/expression/exp_functions.c +++ b/centrallix/expression/exp_functions.c @@ -139,7 +139,7 @@ typedef struct /*** An internal function used by the schema verifier (below) to verify each *** argument of the schema. ***/ -static int verify_arg(const char* fn_name, pExpression arg, const ArgExpect* arg_expect) +static int exp_fn_i_verify_arg(const char* fn_name, pExpression arg, const ArgExpect* arg_expect) { /** The expectation struct cannot be NULL. **/ if (arg_expect == NULL) @@ -251,7 +251,7 @@ static int verify_arg(const char* fn_name, pExpression arg, const ArgExpect* arg } break; } - + case DATA_T_DOUBLE: { double value = arg->Types.Double; @@ -281,7 +281,7 @@ static int verify_arg(const char* fn_name, pExpression arg, const ArgExpect* arg } break; } - + case DATA_T_STRING: { char* str = arg->String; @@ -295,7 +295,7 @@ static int verify_arg(const char* fn_name, pExpression arg, const ArgExpect* arg } break; } - + case DATA_T_DATETIME: { pDateTime value = &arg->Types.Date; @@ -317,15 +317,15 @@ static int verify_arg(const char* fn_name, pExpression arg, const ArgExpect* arg } break; } - + case DATA_T_MONEY: { pMoneyType value = &arg->Types.Money; if (arg_expect->Flags & EXP_ARG_POSITIVE && value->WholePart < 0) { mssErrorf(1, "EXP", - "%s(...): Expects positive money value but got $%d.%d.", - fn_name, value->WholePart, value->FractionPart + "%s(...): Expects positive money value but got $%d.%g.", + fn_name, value->WholePart, (double)value->FractionPart / 100.0 ); return -1; } @@ -333,7 +333,7 @@ static int verify_arg(const char* fn_name, pExpression arg, const ArgExpect* arg { mssErrorf(1, "EXP", "%s(...): Expects negative money value but got $%d.%d.", - fn_name, value->WholePart, value->FractionPart + fn_name, value->WholePart, (double)value->FractionPart / 100.0 ); return -1; } @@ -390,7 +390,7 @@ static int verify_arg(const char* fn_name, pExpression arg, const ArgExpect* arg *** Example: *** ```c *** char fn_name[] = "example"; - *** if (verify_schema(fn_name, + *** if (exp_fn_i_verify_schema(fn_name, *** (ArgExpect[]){ *** {(int[]){DATA_T_INTEGER, DATA_T_DOUBLE, -1}, EXP_PARAM_NOT_NULL}, *** {(int[]){DATA_T_STRING, -1}, 0} @@ -403,7 +403,7 @@ static int verify_arg(const char* fn_name, pExpression arg, const ArgExpect* arg *** } *** ``` ***/ -static int verify_schema( +static int exp_fn_i_verify_schema( const char* fn_name, const ArgExpect* arg_expects, const int num_args, @@ -435,7 +435,7 @@ static int verify_schema( /** Verify argument datatypes. **/ for (int i = 0; i < num_args; i++) { - if (verify_arg(fn_name, tree->Children.Items[i], &arg_expects[i]) != 0) + if (exp_fn_i_verify_arg(fn_name, tree->Children.Items[i], &arg_expects[i]) != 0) { mssErrorf(0, "EXP", "%s(...): Error while reading arg #%d/%d.", fn_name, i + 1, num_args); return -1; @@ -446,31 +446,6 @@ static int verify_schema( return 0; } -int exp_fn_test(pExpression tree, pParamObjects obj_list) - { - char fn_name[] = "test"; - if (verify_schema(fn_name, - (ArgExpect[]){ - {(int[]){DATA_T_INTEGER, DATA_T_DOUBLE, -1}, EXP_ARG_NOT_NULL | EXP_ARG_NON_NAN}, - {(int[]){DATA_T_STRING, -1}, EXP_ARG_NOT_NULL | EXP_ARG_NON_EMPTY} - }, 2, - tree, obj_list - ) != 0) - { - mssErrorf(0, "EXP", "%s(?): Call does not match function schema.", fn_name); - return -1; - } - - pExpression arg1 = tree->Children.Items[0]; - pExpression arg2 = tree->Children.Items[1]; - if (arg1->DataType == DATA_T_INTEGER) printf("Success: %d, '%s'.\n", arg1->Integer, arg2->String); - else printf("Success: %g, '%s'.\n", arg1->Types.Double, arg2->String); - - tree->DataType = DATA_T_INTEGER; - tree->Flags |= EXPR_F_NULL; - return 0; - } - /****** Evaluator functions follow for expEvalFunction ******/ @@ -4530,7 +4505,7 @@ int exp_fn_metaphone(pExpression tree, pParamObjects obj_list) const char fn_name[] = "metaphone"; /** Verify function schema. **/ - if (verify_schema(fn_name, + if (exp_fn_i_verify_schema(fn_name, (ArgExpect[]){{(int[]){DATA_T_STRING, -1}, EXP_ARG_NO_FLAGS}}, 1, tree, obj_list ) != 0) @@ -4586,7 +4561,7 @@ int exp_fn_metaphone(pExpression tree, pParamObjects obj_list) static int exp_fn_compare(pExpression tree, pParamObjects obj_list, const char* fn_name) { /** Verify function schema. **/ - if (verify_schema(fn_name, + if (exp_fn_i_verify_schema(fn_name, (ArgExpect[]){ {(int[]){DATA_T_STRING, -1}, EXP_ARG_NO_FLAGS}, {(int[]){DATA_T_STRING, -1}, EXP_ARG_NO_FLAGS} @@ -4672,7 +4647,7 @@ int exp_fn_levenshtein(pExpression tree, pParamObjects obj_list) const char fn_name[] = "levenshtein"; /** Verify function schema. **/ - if (verify_schema(fn_name, + if (exp_fn_i_verify_schema(fn_name, (ArgExpect[]){ {(int[]){DATA_T_STRING, -1}, EXP_ARG_NO_FLAGS}, {(int[]){DATA_T_STRING, -1}, EXP_ARG_NO_FLAGS} @@ -4858,7 +4833,6 @@ int exp_internal_DefineFunctions() xhAdd(&EXP.Functions, "pbkdf2", (char*)exp_fn_pbkdf2); xhAdd(&EXP.Functions, "octet_length", (char*)exp_fn_octet_length); xhAdd(&EXP.Functions, "argon2id",(char*)exp_fn_argon2id); - xhAdd(&EXP.Functions, "test", (char*)exp_fn_test); /** Dates. **/ xhAdd(&EXP.Functions, "getdate", (char*)exp_fn_getdate); From 8795aaf1b89c934ca6ec05797e559077b7551e50 Mon Sep 17 00:00:00 2001 From: Israel Date: Fri, 21 Nov 2025 17:44:12 -0700 Subject: [PATCH 028/275] Add tests for log and power functions. --- centrallix/tests/test_expfn_log_00.cmp | 34 ++++++++++++++++++++ centrallix/tests/test_expfn_log_00.to | 44 ++++++++++++++++++++++++++ 2 files changed, 78 insertions(+) create mode 100644 centrallix/tests/test_expfn_log_00.cmp create mode 100644 centrallix/tests/test_expfn_log_00.to diff --git a/centrallix/tests/test_expfn_log_00.cmp b/centrallix/tests/test_expfn_log_00.cmp new file mode 100644 index 000000000..c072b68f2 --- /dev/null +++ b/centrallix/tests/test_expfn_log_00.cmp @@ -0,0 +1,34 @@ +Attribute [ln(1)]: double 0.0 +Attribute [ln(e)]: double 1.0 +Attribute [ln(0)]: double -inf.0 +Attribute [ln(-1)]: double nan.0 +Attribute [ln(10)]: double 2.30258509 +Attribute [ln(1.5)]: double 0.40546511 +Attribute [ln(1e-10)]: integer 1 +Attribute [ln(1e10)+]: integer 1 +Attribute [ln(1e10)-]: integer 1 +Attribute [log10(1)]: double 0.0 +Attribute [log10(10)]: double 1.0 +Attribute [log10(0)]: double -inf.0 +Attribute [log10(-10)]: double nan.0 +Attribute [log10(100)]: double 2.0 +Attribute [log10(0.01)]: double -2.0 +Attribute [log10(1.234)]: double 0.09131516 +Attribute [log10(1e-10)]: double -10.0 +Attribute [log10(1e10)]: double 10.0 +Attribute [logn(8, 2)]: double 3.0 +Attribute [logn(1000, 10)]: double 3.0 +Attribute [logn(10, 0)]: double -0.0 +Attribute [logn(10, 1)]: double inf.0 +Attribute [logn(8, -2)]: double nan.0 +Attribute [logn(0, 2)]: double -inf.0 +Attribute [logn(-8, 2)]: double nan.0 +Attribute [logn(1, 2)]: double 0.0 +Attribute [logn(1e10, 10)]: double 10.0 +Attribute [logn(8, 0.5)]: double -3.0 +Attribute [ln(2.718281828)]: double 1.0 +Attribute [log10(3.14159)]: double 0.49714951 +Attribute [logn(10, 1.1)]: double 0.04139269 +Attribute [logn(1.1, 10)]: double 24.15885793 +Attribute [logn(10, 0.001)]: double -3.0 +Attribute [logn(0.1, 1000)]: double -3.0 diff --git a/centrallix/tests/test_expfn_log_00.to b/centrallix/tests/test_expfn_log_00.to new file mode 100644 index 000000000..e454e4003 --- /dev/null +++ b/centrallix/tests/test_expfn_log_00.to @@ -0,0 +1,44 @@ +##NAME log() functions + +# Natural Log: ln(x) +query select 'ln(1)' = ln(1) -- Expect 0. +query select 'ln(e)' = ln(2.718281828459045) -- Expect 1. +query select 'ln(0)' = ln(0) -- Expect -inf (log approaches infinity). +query select 'ln(-1)' = ln(-1) -- Expect NaN (log undefined for negative). +query select 'ln(10)' = round(ln(10), 8) -- Expect ~2.30258509. +query select 'ln(1.5)' = round(ln(1.5), 8) -- Expect ~0.40546511. +query select 'ln(1e-10)' = ln(0.0000000001) < 0.0000000001 -- Expect true (value is very small). +query select 'ln(1e10)+' = ln(10000000000.0) > 23.0 -- Expect true (value is ~23.02585). +query select 'ln(1e10)-' = ln(10000000000.0) < 23.1 -- Expect true (value is ~23.02585). + +# Log base 10: log10(x) +query select 'log10(1)' = log10(1) -- Expect 0. +query select 'log10(10)' = log10(10) -- Expect 1. +query select 'log10(0)' = log10(0) -- Expect -inf. +query select 'log10(-10)' = log10(-10) -- Expect NaN. +query select 'log10(100)' = log10(100) -- Expect 2. +query select 'log10(0.01)' = log10(0.01) -- Expect -2. +query select 'log10(1.234)' = round(log10(1.234), 8) -- Expect ~0.091315. +query select 'log10(1e-10)' = log10(0.0000000001) -- Expect ~-10. +query select 'log10(1e10)' = log10(10000000000.0) -- Expect ~10. + +# General base n of x: logn(x, n) +# Edge cases: base <= 0 or base == 1 (invalid), x <= 0 (invalid) +query select 'logn(8, 2)' = logn(8, 2) -- Expect 3. +query select 'logn(1000, 10)' = logn(1000, 10) -- Expect 3. +query select 'logn(10, 0)' = logn(10, 0) -- Expect -0.0 (base 0 is undefined). +query select 'logn(10, 1)' = logn(10, 1) -- Expect inf (base 1 is undefined). +query select 'logn(8, -2)' = logn(8, -2) -- Expect NaN (negative base). +query select 'logn(0, 2)' = logn(0, 2) -- Expect -inf (x=0). +query select 'logn(-8, 2)' = logn(-8, 2) -- Expect NaN or error (x negative). +query select 'logn(1, 2)' = logn(1, 2) -- Expect 0. +query select 'logn(1e10, 10)' = logn(10000000000.0, 10) -- Expect 10. +query select 'logn(8, 0.5)' = logn(8, 0.5) -- Expect negative value. + +-- Additional double/int mixed cases +query select 'ln(2.718281828)' = round(ln(2.718281828), 8) -- Expect ~1 (close to e). +query select 'log10(3.14159)' = round(log10(3.14159), 8) -- Expect ~0.49715. +query select 'logn(10, 1.1)' = round(logn(1.1, 10), 8) -- Expect 0.04139289. +query select 'logn(1.1, 10)' = round(logn(10, 1.1), 8) -- Expect 24.15885793. +query select 'logn(10, 0.001)' = round(logn(0.001, 10), 8) -- Expect ~-0.33333333... +query select 'logn(0.1, 1000)' = round(logn(1000, 0.1), 8) -- Expect ~-0.33333333... From 2e948d8028f8c88aa933d17c172a4b089c5795b3 Mon Sep 17 00:00:00 2001 From: Israel Date: Fri, 21 Nov 2025 17:44:53 -0700 Subject: [PATCH 029/275] Add exp_fn_i_get_number(). --- centrallix/expression/exp_functions.c | 41 +++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) diff --git a/centrallix/expression/exp_functions.c b/centrallix/expression/exp_functions.c index 08867f8af..e8d67976d 100644 --- a/centrallix/expression/exp_functions.c +++ b/centrallix/expression/exp_functions.c @@ -446,6 +446,47 @@ static int exp_fn_i_verify_schema( return 0; } +/*** Extract a number from a numeric expression. + *** + *** @param numeric_expr The numeric expression to be extracted. + *** @param result_ptr A pointer to a double where the result is stored. + *** @returns 0 on success, + *** -1 on failure, + *** 1 if the expression is NULL. + ***/ +static int exp_fn_i_get_number(pExpression numeric_expr, double* result_ptr) + { + /** Check for null values. **/ + if (numeric_expr == NULL || numeric_expr->Flags & EXPR_F_NULL) return 1; + + /** Check for null destination. **/ + if (result_ptr == NULL) + { + mssError(1, "EXP", "Null location provided to store numeric result."); + return -1; + } + + /** Get the numeric value. **/ + double n; + switch(numeric_expr->DataType) + { + case DATA_T_INTEGER: n = numeric_expr->Integer; break; + case DATA_T_DOUBLE: n = numeric_expr->Types.Double; break; + case DATA_T_MONEY: n = objDataToDouble(DATA_T_MONEY, &(numeric_expr->Types.Money)); break; + default: + mssError(1, "EXP", + "%s (%d) is not a numeric type.", + ci_TypeToStr(numeric_expr->DataType), numeric_expr->DataType + ); + return -1; + } + + /** Store the result. **/ + *result_ptr = n; + + return 0; + } + /****** Evaluator functions follow for expEvalFunction ******/ From 4c347be808bf95a80fa7ee8e5346cf95900ab36a Mon Sep 17 00:00:00 2001 From: Israel Date: Fri, 21 Nov 2025 17:45:44 -0700 Subject: [PATCH 030/275] Add exp_fn_i_do_math() to bring the power of schema verification to logarithm and power functions. --- centrallix/expression/exp_functions.c | 223 ++++++-------------------- 1 file changed, 52 insertions(+), 171 deletions(-) diff --git a/centrallix/expression/exp_functions.c b/centrallix/expression/exp_functions.c index e8d67976d..208bd48f8 100644 --- a/centrallix/expression/exp_functions.c +++ b/centrallix/expression/exp_functions.c @@ -3691,194 +3691,75 @@ int exp_fn_from_base64(pExpression tree, pParamObjects objlist, pExpression i0, return -1; } - -int exp_fn_log10(pExpression tree, pParamObjects objlist, pExpression i0, pExpression i1, pExpression i2) +static int exp_fn_i_do_math(pExpression tree, pParamObjects obj_list, const char* fn_name, double (*math)(), int arg_num) { - double n; - - if (!i0) - { - mssError(1, "EXP", "log10() requires a number as its first parameter"); - goto error; - } - if (i0->Flags & EXPR_F_NULL) - { - tree->DataType = DATA_T_DOUBLE; - tree->Flags |= EXPR_F_NULL; - return 0; - } - switch(i0->DataType) - { - case DATA_T_INTEGER: - n = i0->Integer; - break; - case DATA_T_DOUBLE: - n = i0->Types.Double; - break; - case DATA_T_MONEY: - n = objDataToDouble(DATA_T_MONEY, &(i0->Types.Money)); - break; - default: - mssError(1, "EXP", "log10() requires a number as its first parameter"); - goto error; - } - if (n < 0) - { - mssError(1, "EXP", "log10(): cannot compute the logarithm of a negative number"); - goto error; - } - tree->DataType = DATA_T_DOUBLE; - tree->Types.Double = log10(n); - return 0; - - error: + /** Verify function schema: expect arg_num numeric values. **/ + ArgExpect expects[arg_num]; + for (int i = 0; i < arg_num; i++) + expects[i] = (ArgExpect){(int[]){DATA_T_INTEGER, DATA_T_DOUBLE, DATA_T_MONEY, -1}, EXP_ARG_NO_FLAGS}; + if (exp_fn_i_verify_schema(fn_name, expects, arg_num, tree, obj_list) != 0) + { + mssErrorf(0, "EXP", "%s(?): Call does not match function schema.", fn_name); return -1; - } - - -int exp_fn_log_natural(pExpression tree, pParamObjects objlist, pExpression i0, pExpression i1, pExpression i2) - { - double n; - - if (!i0) - { - mssError(1, "EXP", "ln() requires a number as its first parameter"); - goto error; - } - if (i0->Flags & EXPR_F_NULL) + } + + /** Null checks. **/ + for (int i = 0; i < arg_num; i++) + { + pExpression arg = tree->Children.Items[i]; + if (arg->Flags & EXPR_F_NULL) { tree->DataType = DATA_T_DOUBLE; tree->Flags |= EXPR_F_NULL; return 0; } - switch(i0->DataType) - { - case DATA_T_INTEGER: - n = i0->Integer; - break; - case DATA_T_DOUBLE: - n = i0->Types.Double; - break; - case DATA_T_MONEY: - n = objDataToDouble(DATA_T_MONEY, &(i0->Types.Money)); - break; - default: - mssError(1, "EXP", "ln() requires a number as its first parameter"); - goto error; - } - if (n < 0) - { - mssError(1, "EXP", "ln(): cannot compute the logarithm of a negative number"); - goto error; - } - tree->DataType = DATA_T_DOUBLE; - tree->Types.Double = log(n); - return 0; + } - error: + /** Maximum supported args. **/ + if (arg_num > 4) + { + mssErrorf(1, "EXP", "%s(...): exp_fn_i_do_math() does not support functions with more than 4 arguments. If this is an issue, please increase the number of arguments here: %s:%d", fn_name, __FILE__, __LINE__); return -1; - } - - -int exp_fn_log_base_n(pExpression tree, pParamObjects objlist, pExpression i0, pExpression i1, pExpression i2) - { - double n, p; - - if (!i0 || !i1) - { - mssError(1, "EXP", "logn() requires numbers as its first and second parameters"); - goto error; - } - if ((i0->Flags & EXPR_F_NULL) || (i1->Flags & EXPR_F_NULL)) - { - tree->DataType = DATA_T_DOUBLE; - tree->Flags |= EXPR_F_NULL; - return 0; - } - switch(i0->DataType) - { - case DATA_T_INTEGER: - n = i0->Integer; - break; - case DATA_T_DOUBLE: - n = i0->Types.Double; - break; - case DATA_T_MONEY: - n = objDataToDouble(DATA_T_MONEY, &(i0->Types.Money)); - break; - default: - mssError(1, "EXP", "logn() requires a number as its first parameter"); - goto error; - } - switch(i1->DataType) + } + + /** Get the numbers for the args. **/ + double n[4]; + for (int i = 0; i < arg_num; i++) + { + if (!check(exp_fn_i_get_number(tree->Children.Items[i], &(n[i])))) { - case DATA_T_INTEGER: - p = i1->Integer; - break; - case DATA_T_DOUBLE: - p = i1->Types.Double; - break; - default: - mssError(1, "EXP", "logn() requires an integer or double as its second parameter"); - goto error; + mssErrorf(0, "EXP", "%s(...): Failed to get arg%d.", fn_name, i); + return -1; } - tree->DataType = DATA_T_DOUBLE; - tree->Types.Double = log(n) / log(p); - return 0; + } - error: - return -1; + tree->DataType = DATA_T_DOUBLE; + tree->Types.Double = math(n[0], n[1], n[2], n[3]); /* Call function with max supported args. */ + return 0; } +int exp_fn_log_natural(pExpression tree, pParamObjects obj_list) + { + return exp_fn_i_do_math(tree, obj_list, "ln", log, 1); + } +int exp_fn_log10(pExpression tree, pParamObjects obj_list) + { + return exp_fn_i_do_math(tree, obj_list, "log10", log10, 1); + } -int exp_fn_power(pExpression tree, pParamObjects objlist, pExpression i0, pExpression i1, pExpression i2) +/** This is why we need lambdas in C. **/ +double exp_fn_i_log_base_n(double x, double base) { - double n, p; + return log(x) / log(base); + } - if (!i0 || !i1) - { - mssError(1, "EXP", "power() requires numbers as its first and second parameters"); - goto error; - } - if ((i0->Flags & EXPR_F_NULL) || (i1->Flags & EXPR_F_NULL)) - { - tree->DataType = DATA_T_DOUBLE; - tree->Flags |= EXPR_F_NULL; - return 0; - } - switch(i0->DataType) - { - case DATA_T_INTEGER: - n = i0->Integer; - break; - case DATA_T_DOUBLE: - n = i0->Types.Double; - break; - case DATA_T_MONEY: - n = objDataToDouble(DATA_T_MONEY, &(i0->Types.Money)); - break; - default: - mssError(1, "EXP", "power() requires a number as its first parameter"); - goto error; - } - switch(i1->DataType) - { - case DATA_T_INTEGER: - p = i1->Integer; - break; - case DATA_T_DOUBLE: - p = i1->Types.Double; - break; - default: - mssError(1, "EXP", "power() requires an integer or double as its second parameter"); - goto error; - } - tree->DataType = DATA_T_DOUBLE; - tree->Types.Double = pow(n, p); - return 0; - - error: - return -1; +int exp_fn_log_base_n(pExpression tree, pParamObjects obj_list) + { + return exp_fn_i_do_math(tree, obj_list, "logn", exp_fn_i_log_base_n, 2); + } +int exp_fn_power(pExpression tree, pParamObjects obj_list) + { + return exp_fn_i_do_math(tree, obj_list, "power", pow, 2); } From d1775228b7b911ad6e5a73aef5ae8e18f3949788 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Tue, 25 Nov 2025 09:45:26 -0700 Subject: [PATCH 031/275] Minor clean up. --- centrallix-lib/include/clusters.h | 2 +- centrallix-lib/src/clusters.c | 2 +- centrallix-lib/src/util.c | 20 -------------------- 3 files changed, 2 insertions(+), 22 deletions(-) diff --git a/centrallix-lib/include/clusters.h b/centrallix-lib/include/clusters.h index 8f916210e..06c5075fe 100644 --- a/centrallix-lib/include/clusters.h +++ b/centrallix-lib/include/clusters.h @@ -25,7 +25,7 @@ /* A copy of the GNU General Public License has been included in this */ /* distribution in the file "COPYING". */ /* */ -/* Module: lib_cluster.h */ +/* Module: lib_cluster.c, lib_cluster.h */ /* Author: Israel Fuller */ /* Creation: September 29, 2025 */ /* Description: Clustering library used to cluster and search data with */ diff --git a/centrallix-lib/src/clusters.c b/centrallix-lib/src/clusters.c index 48119176a..edc37920e 100644 --- a/centrallix-lib/src/clusters.c +++ b/centrallix-lib/src/clusters.c @@ -22,7 +22,7 @@ /* A copy of the GNU General Public License has been included in this */ /* distribution in the file "COPYING". */ /* */ -/* Module: lib_cluster.c */ +/* Module: lib_cluster.c, lib_cluster.h */ /* Author: Israel Fuller */ /* Creation: September 29, 2025 */ /* Description: Clustering library used to cluster and search data with */ diff --git a/centrallix-lib/src/util.c b/centrallix-lib/src/util.c index d326944d1..edb65dbfa 100644 --- a/centrallix-lib/src/util.c +++ b/centrallix-lib/src/util.c @@ -90,26 +90,6 @@ unsigned int strtoui(const char *nptr, char **endptr, int base){ return (unsigned int)tmp; } -/*** Detects the optimal number of threads to use on this system. - *** Note: Multithreading is not currently supported, so this function - *** will always return 1, for now. - *** - *** @returns The number of threads that should be used on this system. - ***/ -int util_detect_num_threads(void) - { - /** Centrallix does not support multithreading. **/ - return 1; - - long num_procs = sysconf(_SC_NPROCESSORS_ONLN); - if (num_procs < 1 || INT_MAX < num_procs) - { - fprintf(stderr, "Warning: Detected strange number of processors (assuming 1): %ld\n", num_procs); - return 1; - } - else return (int)num_procs; - } - /*** snprint_bytes() allows one to pick between CS units, where the kibibyte *** (KiB) is 1024 bytes, and metric units where the kilobyte (KB) is 1000 bytes. *** Fun Fact: Windows uses kibibytes, but displays them as KB. From 7b49a5bd07acf1b2a43f02339bf29c6b71b682b9 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Thu, 11 Dec 2025 10:30:04 -0700 Subject: [PATCH 032/275] Address Greg's comments Fix styling mistakes. Finish docs in OSDriver_Authoring.md. Add support for querying the driver node object. Fix clusterOpenQuery() succeeding on objects that could not be queried, resulting in fetch failures. Remove "date_created" and "date_computed" from the list of * attributes on cluster and search entries. Rename TARGET_ROOT to TARGET_NODE. Rename snprint_llu() to snprint_commas_llu(). Move double_metaphone.c into centrallix util. Move TypeToStr() to obj_datatypes.c. Move TypeFromStr() to obj_datatypes.c. Remove exp_fn_trim() (temporarily). Revert reorder of exp_function registrations to avoid merge conflicts. Update tests to give clearer feedback. Add GCC_Dependencies.md to document a list of dependencies on GCC features. Add .cluster to Prefixes.md. --- centrallix-lib/include/clusters.h | 87 +- centrallix-lib/include/glyph.h | 18 +- centrallix-lib/include/util.h | 93 +- centrallix-lib/src/clusters.c | 1072 ++-- centrallix-lib/src/mtask.c | 3 +- centrallix-lib/src/util.c | 223 +- centrallix-lib/src/xhash.c | 103 +- centrallix-sysdoc/GCC_Dependencies.md | 20 + centrallix-sysdoc/OSDriver_Authoring.md | 1614 +++-- centrallix-sysdoc/Prefixes.md | 1 + centrallix/Makefile.in | 2 +- centrallix/centrallix.c | 2 +- centrallix/expression/exp_compiler.c | 9 +- centrallix/expression/exp_double_metaphone.c | 1521 ----- centrallix/expression/exp_functions.c | 460 +- centrallix/include/double_metaphone.h | 83 + centrallix/include/expression.h | 1 - centrallix/include/obj.h | 4 +- centrallix/multiquery/multiquery.c | 4 +- centrallix/objectsystem/obj_datatypes.c | 85 + centrallix/osdrivers/objdrv_cluster.c | 5910 +++++++++--------- centrallix/test_obj.c | 8 +- centrallix/tests/test_levenshtein_00.cmp | 36 +- centrallix/tests/test_levenshtein_00.to | 38 +- centrallix/utility/double_metaphone.c | 1545 +++++ 25 files changed, 6962 insertions(+), 5980 deletions(-) create mode 100644 centrallix-sysdoc/GCC_Dependencies.md delete mode 100644 centrallix/expression/exp_double_metaphone.c create mode 100644 centrallix/include/double_metaphone.h create mode 100644 centrallix/utility/double_metaphone.c diff --git a/centrallix-lib/include/clusters.h b/centrallix-lib/include/clusters.h index 06c5075fe..5aa3123e4 100644 --- a/centrallix-lib/include/clusters.h +++ b/centrallix-lib/include/clusters.h @@ -2,37 +2,37 @@ #define CLUSTERS_H /************************************************************************/ -/* Centrallix Application Server System */ -/* Centrallix Core */ -/* */ -/* Copyright (C) 1998-2012 LightSys Technology Services, Inc. */ -/* */ -/* This program is free software; you can redistribute it and/or modify */ -/* it under the terms of the GNU General Public License as published by */ -/* the Free Software Foundation; either version 2 of the License, or */ -/* (at your option) any later version. */ -/* */ -/* This program 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 General Public License for more details. */ -/* */ -/* You should have received a copy of the GNU General Public License */ -/* along with this program; if not, write to the Free Software */ -/* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA */ -/* 02111-1307 USA */ -/* */ -/* A copy of the GNU General Public License has been included in this */ -/* distribution in the file "COPYING". */ -/* */ -/* Module: lib_cluster.c, lib_cluster.h */ -/* Author: Israel Fuller */ -/* Creation: September 29, 2025 */ -/* Description: Clustering library used to cluster and search data with */ -/* cosine similarity and Levenshtein similarity (aka. edit */ -/* distance). Used by the "clustering driver". */ -/* For more information on how to use this library, see */ -/* string-similarity.md in the centrallix-sysdoc folder. */ +/* Centrallix Application Server System */ +/* Centrallix Core */ +/* */ +/* Copyright (C) 1998-2012 LightSys Technology Services, Inc. */ +/* */ +/* This program is free software; you can redistribute it and/or modify */ +/* it under the terms of the GNU General Public License as published by */ +/* the Free Software Foundation; either version 2 of the License, or */ +/* (at your option) any later version. */ +/* */ +/* This program 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 General Public License for more details. */ +/* */ +/* You should have received a copy of the GNU General Public License */ +/* along with this program; if not, write to the Free Software */ +/* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA */ +/* 02111-1307 USA */ +/* */ +/* A copy of the GNU General Public License has been included in this */ +/* distribution in the file "COPYING". */ +/* */ +/* Module: lib_cluster.c, lib_cluster.h */ +/* Author: Israel Fuller */ +/* Creation: September 29, 2025 */ +/* Description Clustering library used to cluster and search data with */ +/* cosine similarity and Levenshtein similarity (aka. edit */ +/* distance). Used by the "clustering driver". */ +/* For more information on how to use this library, see */ +/* string-similarity.md in the centrallix-sysdoc folder. */ /************************************************************************/ #include @@ -44,15 +44,24 @@ #include "cxlib/xarray.h" #endif -/*** 2147483629 is the signed int max, and is also a prime number. +/*** This value defines the number of dimensions used for a sparse + *** vector. The higher the number, the fewer collisions will be + *** encountered when using these vectors for cosine comparisons. + *** This is also called the vector table size, if viewing the + *** vector as a hash table of character pairs. + *** + *** 2147483629 is the signed int max, and is also a prime number. *** Using this value ensures that the longest run of 0s will not *** cause an int underflow with the current encoding scheme. *** *** Unfortunately, we can't use a number this large yet because *** kmeans algorithm creates densely allocated centroids with *** `CA_NUM_DIMS` dimensions, so a large number causes it to fail. + *** This, we use 251 as the largest prime number less than 256, + *** giving us a decent balance between collision reduction and + *** kmeans centroid performance/memory overhead. ***/ -#define CA_NUM_DIMS 251 //2147483629 /* aka. The vector table size. */ +#define CA_NUM_DIMS 251 /// LINK ../../centrallix-sysdoc/string_comparison.md#cosine_charsets /** The character used to create a pair with the first and last characters of a string. **/ @@ -74,10 +83,10 @@ typedef struct /** Registering all defined types for debugging. **/ #define ca_init() \ - nmRegister(sizeof(pVector), "pVector"); \ - nmRegister(sizeof(pCentroid), "pCentroid"); \ - nmRegister(pCentroidSize, "Centroid"); \ - nmRegister(sizeof(Dup), "Dup") + nmRegister(sizeof(pVector), "pVector"); \ + nmRegister(sizeof(pCentroid), "pCentroid"); \ + nmRegister(pCentroidSize, "Centroid"); \ + nmRegister(sizeof(Dup), "Dup") /** Edit distance function. **/ int ca_edit_dist(const char* str1, const char* str2, const size_t str1_length, const size_t str2_length); @@ -102,8 +111,8 @@ int ca_kmeans( #define ca_is_empty(vector) (vector[0] == -CA_NUM_DIMS) #define ca_has_no_pairs(vector) \ ({ \ - __typeof__ (vector) _v = (vector); \ - _v[0] == -172 && _v[1] == 11 && _v[2] == -78; \ + __typeof__ (vector) _v = (vector); \ + _v[0] == -172 && _v[1] == 11 && _v[2] == -78; \ }) /** Comparison functions (see ca_search()). **/ diff --git a/centrallix-lib/include/glyph.h b/centrallix-lib/include/glyph.h index cfafd3946..649437fac 100644 --- a/centrallix-lib/include/glyph.h +++ b/centrallix-lib/include/glyph.h @@ -54,21 +54,21 @@ *** @param flush Whether to flush on output. ***/ #define glyph_init(name, str, interval, flush) \ - const char* vis_##name##_str = str; \ - const unsigned int vis_##name##_interval = interval; \ - const bool vis_##name##_flush = flush; \ - unsigned int vis_##name##_i = 0u; + const char* vis_##name##_str = str; \ + const unsigned int vis_##name##_interval = interval; \ + const bool vis_##name##_flush = flush; \ + unsigned int vis_##name##_i = 0u; /*** Invoke a visualizer. *** *** @param name The name of the visualizer to invoke. ***/ #define glyph(name) \ - if (++vis_##name##_i % vis_##name##_interval == 0) \ - { \ - glyph_print(vis_##name##_str); \ - if (vis_##name##_flush) fflush(stdout); \ - } + if (++vis_##name##_i % vis_##name##_interval == 0) \ + { \ + glyph_print(vis_##name##_str); \ + if (vis_##name##_flush) fflush(stdout); \ + } #else #define glyph_print(str) #define glyph_init(name, str, interval, flush) diff --git a/centrallix-lib/include/util.h b/centrallix-lib/include/util.h index 03b63abaf..efe914d8a 100644 --- a/centrallix-lib/include/util.h +++ b/centrallix-lib/include/util.h @@ -2,26 +2,26 @@ #define UTILITY_H /************************************************************************/ -/* Centrallix Application Server System */ -/* Centrallix Base Library */ -/* */ -/* Copyright (C) 1998-2011 LightSys Technology Services, Inc. */ -/* */ -/* You may use these files and this library under the terms of the */ -/* GNU Lesser General Public License, Version 2.1, contained in the */ -/* included file "COPYING". */ -/* */ -/* Module: util.c, util.h */ -/* Author: Micah Shennum and Israel Fuller */ -/* Date: May 26, 2011 */ -/* Description: Collection of utilities including: */ -/* - Utilities for parsing numbers. */ -/* - The timer utility for benchmarking code. */ -/* - snprint_bytes() for formatting a byte count. */ -/* - snprint_llu() for formatting large numbers. */ -/* - fprint_mem() for printing memory stats. */ -/* - min() and max() for handling numbers. */ -/* - The check functions for reliably printing debug data. */ +/* Centrallix Application Server System */ +/* Centrallix Base Library */ +/* */ +/* Copyright (C) 1998-2011 LightSys Technology Services, Inc. */ +/* */ +/* You may use these files and this library under the terms of the */ +/* GNU Lesser General Public License, Version 2.1, contained in the */ +/* included file "COPYING". */ +/* */ +/* Module: util.c, util.h */ +/* Author: Micah Shennum and Israel Fuller */ +/* Date: May 26, 2011 */ +/* Description: Collection of utilities including: */ +/* - Utilities for parsing numbers. */ +/* - The timer utility for benchmarking code. */ +/* - snprint_bytes() for formatting a byte count. */ +/* - snprint_commas_llu() for formatting large numbers. */ +/* - fprint_mem() for printing memory stats. */ +/* - min() and max() for handling numbers. */ +/* - The check functions for reliably printing debug data. */ /************************************************************************/ #ifdef __cplusplus @@ -32,7 +32,7 @@ extern "C" { unsigned int strtoui(const char *nptr, char **endptr, int base); char* snprint_bytes(char* buf, const size_t buf_size, unsigned int bytes); - char* snprint_llu(char* buf, size_t buflen, unsigned long long value); + char* snprint_commas_llu(char* buf, size_t buf_size, unsigned long long value); void fprint_mem(FILE* out); typedef struct @@ -57,11 +57,6 @@ extern "C" { #ifndef __cplusplus #include -/*** TODO: Greg - Can we assume this code will always be compiled with GCC? - *** If not, then the __typeof__, __LINE__, and __FILE__ syntaxes might be a - *** portability concern. - ***/ - /*** @brief Returns the smaller of two values. *** *** @param a The first value. @@ -110,11 +105,11 @@ void print_err(int code, const char* function_name, const char* file_name, const ***/ #define check(result) \ ({ \ - errno = 0; /* Reset errno to prevent confusion. */ \ - __typeof__ (result) _r = (result); \ - const bool success = (_r == 0); \ - if (!success) print_err(_r, #result, __FILE__, __LINE__); \ - success; \ + errno = 0; /* Reset errno to prevent confusion. */ \ + __typeof__ (result) _r = (result); \ + const bool success = (_r == 0); \ + if (!success) print_err(_r, #result, __FILE__, __LINE__); \ + success; \ }) /*** Ensures that developer diagnostics are printed if the result of the @@ -125,11 +120,11 @@ void print_err(int code, const char* function_name, const char* file_name, const ***/ #define check_neg(result) \ ({ \ - errno = 0; /* Reset errno to prevent confusion. */ \ - __typeof__ (result) _r = (result); \ - const bool success = (_r >= 0); \ - if (!success) print_err(_r, #result, __FILE__, __LINE__); \ - success; \ + errno = 0; /* Reset errno to prevent confusion. */ \ + __typeof__ (result) _r = (result); \ + const bool success = (_r >= 0); \ + if (!success) print_err(_r, #result, __FILE__, __LINE__); \ + success; \ }) /*** Ensures that developer diagnostics are printed if the result of the @@ -140,11 +135,11 @@ void print_err(int code, const char* function_name, const char* file_name, const ***/ #define check_weak(result) \ ({ \ - errno = 0; /* Reset errno to prevent confusion. */ \ - __typeof__ (result) _r = (result); \ - const bool success = (_r != -1); \ - if (!success) print_err(_r, #result, __FILE__, __LINE__); \ - success; \ + errno = 0; /* Reset errno to prevent confusion. */ \ + __typeof__ (result) _r = (result); \ + const bool success = (_r != -1); \ + if (!success) print_err(_r, #result, __FILE__, __LINE__); \ + success; \ }) /*** Ensures that developer diagnostics are printed if the result of the @@ -155,10 +150,10 @@ void print_err(int code, const char* function_name, const char* file_name, const ***/ #define check_double(result) \ ({ \ - errno = 0; /* Reset errno to prevent confusion. */ \ - __typeof__ (result) _r = (result); \ - if (isnan(_r)) print_err(0, #result, __FILE__, __LINE__); \ - _r; \ + errno = 0; /* Reset errno to prevent confusion. */ \ + __typeof__ (result) _r = (result); \ + if (isnan(_r)) print_err(0, #result, __FILE__, __LINE__); \ + _r; \ }) /*** Ensures that developer diagnostics are printed if the result of the @@ -169,10 +164,10 @@ void print_err(int code, const char* function_name, const char* file_name, const ***/ #define check_ptr(result) \ ({ \ - errno = 0; /* Reset errno to prevent confusion. */ \ - __typeof__ (result) _r = (result); \ - if (_r == NULL) print_err(0, #result, __FILE__, __LINE__); \ - _r; \ + errno = 0; /* Reset errno to prevent confusion. */ \ + __typeof__ (result) _r = (result); \ + if (_r == NULL) print_err(0, #result, __FILE__, __LINE__); \ + _r; \ }) #endif /* __cplusplus */ diff --git a/centrallix-lib/src/clusters.c b/centrallix-lib/src/clusters.c index edc37920e..d404e863e 100644 --- a/centrallix-lib/src/clusters.c +++ b/centrallix-lib/src/clusters.c @@ -1,35 +1,35 @@ /************************************************************************/ -/* Centrallix Application Server System */ -/* Centrallix Core */ -/* */ -/* Copyright (C) 1998-2012 LightSys Technology Services, Inc. */ -/* */ -/* This program is free software; you can redistribute it and/or modify */ -/* it under the terms of the GNU General Public License as published by */ -/* the Free Software Foundation; either version 2 of the License, or */ -/* (at your option) any later version. */ -/* */ -/* This program 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 General Public License for more details. */ -/* */ -/* You should have received a copy of the GNU General Public License */ -/* along with this program; if not, write to the Free Software */ -/* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA */ -/* 02111-1307 USA */ -/* */ -/* A copy of the GNU General Public License has been included in this */ -/* distribution in the file "COPYING". */ -/* */ -/* Module: lib_cluster.c, lib_cluster.h */ -/* Author: Israel Fuller */ -/* Creation: September 29, 2025 */ -/* Description: Clustering library used to cluster and search data with */ -/* cosine similarity and Levenshtein similarity (aka. edit */ -/* distance). Used by the "clustering driver". */ -/* For more information on how to use this library, see */ -/* string-similarity.md in the centrallix-sysdoc folder. */ +/* Centrallix Application Server System */ +/* Centrallix Core */ +/* */ +/* Copyright (C) 1998-2012 LightSys Technology Services, Inc. */ +/* */ +/* This program is free software; you can redistribute it and/or modify */ +/* it under the terms of the GNU General Public License as published by */ +/* the Free Software Foundation; either version 2 of the License, or */ +/* (at your option) any later version. */ +/* */ +/* This program 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 General Public License for more details. */ +/* */ +/* You should have received a copy of the GNU General Public License */ +/* along with this program; if not, write to the Free Software */ +/* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA */ +/* 02111-1307 USA */ +/* */ +/* A copy of the GNU General Public License has been included in this */ +/* distribution in the file "COPYING". */ +/* */ +/* Module: lib_cluster.c, lib_cluster.h */ +/* Author: Israel Fuller */ +/* Creation: September 29, 2025 */ +/* Description Clustering library used to cluster and search data with */ +/* cosine similarity and Levenshtein similarity (aka. edit */ +/* distance). Used by the "clustering driver". */ +/* For more information on how to use this library, see */ +/* string-similarity.md in the centrallix-sysdoc folder. */ /************************************************************************/ /** This file has additional documentation in string_similarity.md. **/ @@ -58,10 +58,10 @@ ***/ static unsigned int hash_char_pair(const unsigned char c1, const unsigned char c2) { - const double sum = (c1 * c1 * c1) + (c2 * c2 * c2); - const double scale = ((double)c1 + 1.0) / ((double)c2 + 1.0); - const unsigned int hash = (unsigned int)round(sum * scale) - 1u; - return hash % CA_NUM_DIMS; + const double sum = (c1 * c1 * c1) + (c2 * c2 * c2); + const double scale = ((double)c1 + 1.0) / ((double)c2 + 1.0); + const unsigned int hash = (unsigned int)round(sum * scale) - 1u; + return hash % CA_NUM_DIMS; } /*** An internal struct for temporarily storing character pairs while building @@ -90,8 +90,8 @@ typedef struct ***/ static int charpair_cmp(const void *p1, const void *p2) { - const CharPair *a = p1, *b = p2; - return a->hash - b->hash; + const CharPair *a = p1, *b = p2; + return a->hash - b->hash; } /*** Builds a vector using a string. @@ -141,112 +141,112 @@ static int charpair_cmp(const void *p1, const void *p2) ***/ pVector ca_build_vector(const char* str) { - unsigned int num_chars = 0u; - unsigned char* chars = check_ptr(nmSysMalloc((strlen(str) + 2u) * sizeof(unsigned char))); - if (chars == NULL) goto err; + unsigned char* chars = NULL; + CharPair* char_pairs = NULL; + pVector sparse_vector = NULL; + pVector trimmed_sparse_vector = NULL; - /** Begin adding char pairs (in order). **/ - chars[num_chars++] = CA_BOUNDARY_CHAR; /* Starting boundary character. */ - for (const char* char_ptr = str; *char_ptr != '\0'; char_ptr++) - { - char maybe_char = *char_ptr; - if (maybe_char < 0) fprintf(stderr, "Warning: Unexpected negative char '%c' in string: \"%s\"\n", maybe_char, str); - unsigned char c = (unsigned char)maybe_char; + unsigned int num_chars = 0u; + chars = check_ptr(nmSysMalloc((strlen(str) + 2u) * sizeof(unsigned char))); + if (chars == NULL) goto err_free; - /** Always consider boundary character in string. **/ - if (c == CA_BOUNDARY_CHAR) goto skip_checks; + /** Begin adding char pairs (in order). **/ + chars[num_chars++] = CA_BOUNDARY_CHAR; /* Starting boundary character. */ + for (const char* char_ptr = str; *char_ptr != '\0'; char_ptr++) + { + char maybe_char = *char_ptr; + if (maybe_char < 0) fprintf(stderr, "Warning: Unexpected negative char '%c' in string: \"%s\"\n", maybe_char, str); + unsigned char c = (unsigned char)maybe_char; + + /** Always consider boundary character in string. **/ + if (c != CA_BOUNDARY_CHAR) goto skip_checks; + + /** Ignore insignificant characters: spaces and punctuation. **/ + if (isspace(c)) continue; /* space, \n, \v, \f, \r */ + if (ispunct(c)) continue; /* !"#$%&'()*+,-./:;<=>?@[\]^_{|}~ */ + + skip_checks: + /** Shift numbers to the end of the lowercase letters. **/ + if ('0' <= c && c <= '9') c += 75u; + + /** Store the character. **/ + chars[num_chars++] = tolower(c); + } + chars[num_chars++] = CA_BOUNDARY_CHAR; /* Ending boundary character. */ - /** Ignore insignificant characters: spaces and punctuation. **/ - if (isspace(c)) continue; /* space, \n, \v, \f, \r */ - if (ispunct(c)) continue; /* !"#$%&'()*+,-./:;<=>?@[\]^_{|}~ */ + /** Compute hash values for char pairs. **/ + char_pairs = check_ptr(nmSysMalloc(num_chars * sizeof(CharPair))); + if (char_pairs == NULL) goto err_free; + const unsigned int num_pairs = num_chars - 1u; + for (unsigned int i = 0u; i < num_pairs; i++) + { + /** Store characters. **/ + char_pairs[i].c1 = chars[i]; + char_pairs[i].c2 = chars[i + 1]; + + /** Hash the character pair into an index (dimension). **/ + /** Note that the passed value should always be between 97 ('a') and 132 ('9'). **/ + char_pairs[i].hash = hash_char_pair(chars[i], chars[i + 1]); + } - skip_checks: - /** Shift numbers to the end of the lowercase letters. **/ - if ('0' <= c && c <= '9') c += 75u; + /** Free unused memory. **/ + nmSysFree(chars); + chars = NULL; - /** Store the character. **/ - chars[num_chars++] = tolower(c); - } - chars[num_chars++] = CA_BOUNDARY_CHAR; /* Ending boundary character. */ - - /** Compute hash values for char pairs. **/ - CharPair* char_pairs = check_ptr(nmSysMalloc(num_chars * sizeof(CharPair))); - if (char_pairs == NULL) goto err_free_chars; - const unsigned int num_pairs = num_chars - 1u; - for (unsigned int i = 0u; i < num_pairs; i++) - { - /** Store characters. **/ - char_pairs[i].c1 = chars[i]; - char_pairs[i].c2 = chars[i + 1]; + /** Sort char_pairs by hash value. **/ + qsort(char_pairs, num_pairs, sizeof(CharPair), charpair_cmp); - /** Hash the character pair into an index (dimension). **/ - /** Note that the passed value should always be between 97 ('a') and 132 ('9'). **/ - char_pairs[i].hash = hash_char_pair(chars[i], chars[i + 1]); - } - - /** Free unused memory. **/ - nmSysFree(chars); - chars = NULL; - - /** Sort char_pairs by hash value. **/ - qsort(char_pairs, num_pairs, sizeof(CharPair), charpair_cmp); - - /** Allocate space for the sparse vector. **/ - pVector sparse_vector = check_ptr(nmSysMalloc((num_pairs * 2u + 1u) * sizeof(int))); - if (sparse_vector == NULL) goto err_free_char_pairs; - - /** Build the sparse vector. **/ - unsigned int cur = 0u, dim = 0u; - for (unsigned int i = 0u; i < num_pairs;) - { - unsigned int hash = char_pairs[i].hash; + /** Allocate space for the sparse vector. **/ + sparse_vector = check_ptr(nmSysMalloc((num_pairs * 2u + 1u) * sizeof(int))); + if (sparse_vector == NULL) goto err_free; - /** Proceed through the pairs until we find a unique hash. **/ - /** Dividing value by 2 each time reduces the impact of repeated pairs. **/ - int value = 0; - for (; i < num_pairs && char_pairs[i].hash == hash; i++) + /** Build the sparse vector. **/ + unsigned int cur = 0u, dim = 0u; + for (unsigned int i = 0u; i < num_pairs;) { - value /= 2; /* Reduce impact of repeated pairs. */ - value += ((unsigned int)char_pairs[i].c1 + (unsigned int)char_pairs[i].c2) % 13u + 1u; + unsigned int hash = char_pairs[i].hash; + + /** Proceed through the pairs until we find a unique hash. **/ + /** Dividing value by 2 each time reduces the impact of repeated pairs. **/ + int value = 0; + for (; i < num_pairs && char_pairs[i].hash == hash; i++) + { + value /= 2; /* Reduce impact of repeated pairs. */ + value += ((unsigned int)char_pairs[i].c1 + (unsigned int)char_pairs[i].c2) % 13u + 1u; + } + + /** Skip zeros to reach the dimension index specified by the hash. **/ + unsigned int num_zeros = hash - dim; + if (num_zeros > 0u) + { + sparse_vector[cur++] = (int)-num_zeros; + dim = hash; + } + + /** Add the value to the sparse vector. **/ + sparse_vector[cur++] = value; + dim++; } + if (dim != CA_NUM_DIMS) sparse_vector[cur++] = -(CA_NUM_DIMS - dim); - /** Skip zeros to reach the dimension index specified by the hash. **/ - unsigned int num_zeros = hash - dim; - if (num_zeros > 0u) - { - sparse_vector[cur++] = (int)-num_zeros; - dim = hash; - } + /** Free unused memory. **/ + nmSysFree(char_pairs); + char_pairs = NULL; - /** Add the value to the sparse vector. **/ - sparse_vector[cur++] = value; - dim++; - } - if (dim != CA_NUM_DIMS) sparse_vector[cur++] = -(CA_NUM_DIMS - dim); - - /** Free unused memory. **/ - nmSysFree(char_pairs); - char_pairs = NULL; - - /** Trim extra space wasted by identical hashes. **/ - pVector trimmed_sparse_vector = check_ptr(nmSysRealloc(sparse_vector, cur * sizeof(int))); - if (trimmed_sparse_vector == NULL) goto err_free_sparse_vector; - sparse_vector = NULL; /* Mark memory freed by nmSysRealloc() no longer valid. */ - - /** Return the result. **/ - return trimmed_sparse_vector; - - err_free_sparse_vector: - if (sparse_vector != NULL) nmSysFree(sparse_vector); - - err_free_char_pairs: - if (char_pairs != NULL) nmSysFree(char_pairs); - - err_free_chars: - if (chars != NULL) nmSysFree(chars); - - err: - return NULL; + /** Trim extra space wasted by identical hashes. **/ + trimmed_sparse_vector = check_ptr(nmSysRealloc(sparse_vector, cur * sizeof(int))); + if (trimmed_sparse_vector == NULL) goto err_free; + sparse_vector = NULL; /* Mark memory freed by nmSysRealloc() no longer valid. */ + + /** Return the result. **/ + return trimmed_sparse_vector; + + err_free: + if (trimmed_sparse_vector != NULL) nmSysFree(trimmed_sparse_vector); + if (sparse_vector != NULL) nmSysFree(sparse_vector); + if (char_pairs != NULL) nmSysFree(char_pairs); + if (chars != NULL) nmSysFree(chars); + return NULL; } /*** Free memory allocated to store a sparse vector. @@ -255,7 +255,7 @@ pVector ca_build_vector(const char* str) ***/ void ca_free_vector(pVector sparse_vector) { - nmSysFree(sparse_vector); + nmSysFree(sparse_vector); } /*** Compute the length of a sparsely allocated vector. @@ -266,16 +266,18 @@ void ca_free_vector(pVector sparse_vector) unsigned int ca_sparse_len(const pVector vector) { unsigned int i = 0u; - for (unsigned int dim = 0u; dim < CA_NUM_DIMS;) - { - const int val = vector[i++]; - - /** Negative val represents -val 0s in the array, so skip that many values. **/ - if (val < 0) dim += (unsigned)(-val); - - /** We have a param_value, but we don't need to do anything with it. **/ - else dim++; - } + + for (unsigned int dim = 0u; dim < CA_NUM_DIMS;) + { + const int val = vector[i++]; + + /** Negative val represents -val 0s in the array, so skip that many values. **/ + if (val < 0) dim += (unsigned)(-val); + + /** We have a param_value, but we don't need to do anything with it. **/ + else dim++; + } + return i; } @@ -286,11 +288,11 @@ unsigned int ca_sparse_len(const pVector vector) ***/ void ca_print_vector(const pVector vector) { - const unsigned int len = ca_sparse_len(vector); - printf("Vector: [%d", vector[0]); - for (unsigned int i = 1u; i < len; i++) - printf(", %d", vector[i]); - printf("]"); + const unsigned int len = ca_sparse_len(vector); + printf("Vector: [%d", vector[0]); + for (unsigned int i = 1u; i < len; i++) + printf(", %d", vector[i]); + printf("]"); } /*** Compute the magnitude of a sparsely allocated vector. @@ -301,16 +303,18 @@ void ca_print_vector(const pVector vector) static double magnitude_sparse(const pVector vector) { unsigned int magnitude = 0u; - for (unsigned int i = 0u, dim = 0u; dim < CA_NUM_DIMS;) - { - const int val = vector[i++]; - - /** Negative val represents -val 0s in the array, so skip that many values. **/ - if (val < 0) dim += (unsigned)(-val); - - /** We have a param_value, so square it and add it to the magnitude. **/ - else { magnitude += (unsigned)(val * val); dim++; } - } + + for (unsigned int i = 0u, dim = 0u; dim < CA_NUM_DIMS;) + { + const int val = vector[i++]; + + /** Negative val represents -val 0s in the array, so skip that many values. **/ + if (val < 0) dim += (unsigned)(-val); + + /** We have a param_value, so square it and add it to the magnitude. **/ + else { magnitude += (unsigned)(val * val); dim++; } + } + return sqrt((double)magnitude); } @@ -322,8 +326,10 @@ static double magnitude_sparse(const pVector vector) static double magnitude_dense(const pCentroid centroid) { double magnitude = 0.0; - for (int i = 0; i < CA_NUM_DIMS; i++) - magnitude += centroid[i] * centroid[i]; + + for (int i = 0; i < CA_NUM_DIMS; i++) + magnitude += centroid[i] * centroid[i]; + return sqrt(magnitude); } @@ -336,18 +342,18 @@ static double magnitude_dense(const pCentroid centroid) ***/ static void parse_vector_token(const int token, unsigned int* remaining, unsigned int* param_value) { - if (token < 0) - { - /** This run contains -token zeros. **/ - *remaining = (unsigned)(-token); - *param_value = 0u; - } - else - { - /** This run contains one param_value. **/ - *remaining = 1u; - *param_value = (unsigned)(token); - } + if (token < 0) + { + /** This run contains -token zeros. **/ + *remaining = (unsigned)(-token); + *param_value = 0u; + } + else + { + /** This run contains one param_value. **/ + *remaining = 1u; + *param_value = (unsigned)(token); + } } /*** Calculate the similarity on sparsely allocated vectors. Comparing @@ -361,30 +367,30 @@ static void parse_vector_token(const int token, unsigned int* remaining, unsigne ***/ static double sparse_similarity(const pVector v1, const pVector v2) { - /** Calculate dot product. **/ - unsigned int vec1_remaining = 0u, vec2_remaining = 0u; - unsigned int dim = 0u, i1 = 0u, i2 = 0u, dot_product = 0u; - while (dim < CA_NUM_DIMS) - { - unsigned int val1 = 0u, val2 = 0u; - if (vec1_remaining == 0u) parse_vector_token(v1[i1++], &vec1_remaining, &val1); - if (vec2_remaining == 0u) parse_vector_token(v2[i2++], &vec2_remaining, &val2); + /** Calculate dot product. **/ + unsigned int vec1_remaining = 0u, vec2_remaining = 0u; + unsigned int dim = 0u, i1 = 0u, i2 = 0u, dot_product = 0u; + while (dim < CA_NUM_DIMS) + { + unsigned int val1 = 0u, val2 = 0u; + if (vec1_remaining == 0u) parse_vector_token(v1[i1++], &vec1_remaining, &val1); + if (vec2_remaining == 0u) parse_vector_token(v2[i2++], &vec2_remaining, &val2); + + /*** Accumulate the dot_product. If either vector is 0 here, + *** the total is 0 and this statement does nothing. + ***/ + dot_product += val1 * val2; + + /** Consume overlap from both runs. **/ + unsigned int overlap = min(vec1_remaining, vec2_remaining); + vec1_remaining -= overlap; + vec2_remaining -= overlap; + dim += overlap; + } - /*** Accumulate the dot_product. If either vector is 0 here, - *** the total is 0 and this statement does nothing. - ***/ - dot_product += val1 * val2; + /** Optional optimization to speed up nonsimilar vectors. **/ + if (dot_product == 0u) return 0.0; - /** Consume overlap from both runs. **/ - unsigned int overlap = min(vec1_remaining, vec2_remaining); - vec1_remaining -= overlap; - vec2_remaining -= overlap; - dim += overlap; - } - - /** Optional optimization to speed up nonsimilar vectors. **/ - if (dot_product == 0u) return 0.0; - /** Return the difference score. **/ return (double)dot_product / (magnitude_sparse(v1) * magnitude_sparse(v2)); } @@ -400,9 +406,9 @@ static double sparse_similarity(const pVector v1, const pVector v2) ***/ #define sparse_dif(v1, v2) (1.0 - sparse_similarity(v1, v2)) -/*** Calculate the similarity between a sparsely allocated vector - *** and a densely allocated centroid. Comparing any string to an - *** empty string should always return 0.5 (untested). +/*** Calculate the similarity between a sparsely allocated vector and a densely + *** allocated centroid using a dot product. Comparing any string to an empty + *** string should always return 0.5 (untested). *** *** @param v1 Sparse vector #1. *** @param c1 Dense centroid #2. @@ -412,26 +418,26 @@ static double sparse_similarity(const pVector v1, const pVector v2) ***/ static double sparse_similarity_to_centroid(const pVector v1, const pCentroid c2) { - /** Calculate dot product. **/ double dot_product = 0.0; - for (unsigned int i = 0u, dim = 0u; dim < CA_NUM_DIMS;) - { - const int val = v1[i++]; - - /** Negative val represents -val 0s in the array, so skip that many values. **/ - if (val < 0) dim += (unsigned)(-val); - - /** We have a param_value, so square it and add it to the magnitude. **/ - else dot_product += (double)val * c2[dim++]; - } + + for (unsigned int i = 0u, dim = 0u; dim < CA_NUM_DIMS;) + { + const int val = v1[i++]; + + /** Negative val represents -val 0s in the array, so skip that many values. **/ + if (val < 0) dim += (unsigned)(-val); + + /** We have a param_value, so square it and add it to the magnitude. **/ + else dot_product += (double)val * c2[dim++]; + } /** Return the difference score. **/ return dot_product / (magnitude_sparse(v1) * magnitude_dense(c2)); } -/*** Calculate the difference between a sparsely allocated vector - *** and a densely allocated centroid. Comparing any string to an - *** empty string should always return 0.5 (untested). +/*** Calculate the difference between a sparsely allocated vector and a densely + *** allocated centroid. Comparing any string to an empty string should always + *** return 0.5 (untested). *** *** @param v1 Sparse vector #1. *** @param c1 Dense centroid #2. @@ -459,97 +465,98 @@ static double sparse_similarity_to_centroid(const pVector v1, const pCentroid c2 int ca_edit_dist(const char* str1, const char* str2, const size_t str1_length, const size_t str2_length) { int result = -1; + unsigned int** lev_matrix = NULL; - /*** lev_matrix: - *** For all i and j, d[i][j] will hold the Levenshtein distance between - *** the first i characters of s and the first j characters of t. - *** - *** As they say, no dynamic programming algorithm is complete without a - *** matrix that you fill out and it has the answer in the final location. - ***/ - const size_t str1_len = (str1_length == 0u) ? strlen(str1) : str1_length; - const size_t str2_len = (str2_length == 0u) ? strlen(str2) : str2_length; - unsigned int** lev_matrix = check_ptr(nmSysMalloc((str1_len + 1) * sizeof(unsigned int*))); - if (lev_matrix == NULL) goto end; - for (unsigned int i = 0u; i < str1_len + 1u; i++) - { - lev_matrix[i] = check_ptr(nmSysMalloc((str2_len + 1) * sizeof(unsigned int))); - if (lev_matrix[i] == NULL) goto end; - } - - /*** Base case #0: - *** Transforming an empty string into an empty string has 0 cost. - ***/ - lev_matrix[0][0] = 0u; - - /*** Base case #1: - *** Any source prefixe can be transformed into an empty string by - *** dropping each character. - ***/ - for (unsigned int i = 1u; i <= str1_len; i++) - lev_matrix[i][0] = i; - - /*** Base case #2: - *** Any target prefixes can be transformed into an empty string by - *** inserting each character. - ***/ - for (unsigned int j = 1u; j <= str2_len; j++) - lev_matrix[0][j] = j; - - /** General Case. **/ - for (unsigned int i = 1u; i <= str1_len; i++) - { + /*** lev_matrix: + *** For all i and j, d[i][j] will hold the Levenshtein distance between + *** the first i characters of s and the first j characters of t. + *** + *** As they say, no dynamic programming algorithm is complete without a + *** matrix that you fill out and it has the answer in the final location. + ***/ + const size_t str1_len = (str1_length == 0u) ? strlen(str1) : str1_length; + const size_t str2_len = (str2_length == 0u) ? strlen(str2) : str2_length; + lev_matrix = check_ptr(nmSysMalloc((str1_len + 1) * sizeof(unsigned int*))); + if (lev_matrix == NULL) goto end; + for (unsigned int i = 0u; i < str1_len + 1u; i++) + { + lev_matrix[i] = check_ptr(nmSysMalloc((str2_len + 1) * sizeof(unsigned int))); + if (lev_matrix[i] == NULL) goto end; + } + + /*** Base case #0: + *** Transforming an empty string into an empty string has 0 cost. + ***/ + lev_matrix[0][0] = 0u; + + /*** Base case #1: + *** Any source prefixe can be transformed into an empty string by + *** dropping each character. + ***/ + for (unsigned int i = 1u; i <= str1_len; i++) + lev_matrix[i][0] = i; + + /*** Base case #2: + *** Any target prefixes can be transformed into an empty string by + *** inserting each character. + ***/ for (unsigned int j = 1u; j <= str2_len; j++) + lev_matrix[0][j] = j; + + /** General Case. **/ + for (unsigned int i = 1u; i <= str1_len; i++) { - /** If the characters are equal, no change is needed. **/ - if (str1[i - 1] == str2[j - 1]) - lev_matrix[i][j] = lev_matrix[i - 1][j - 1]; - - /*** We need to make a change, so use the oppereration with the - *** lowest cost out of delete, insert, replace, or swap. - ***/ - else + for (unsigned int j = 1u; j <= str2_len; j++) { - unsigned int cost_delete = lev_matrix[i - 1][j] + 1u; - unsigned int cost_insert = lev_matrix[i][j - 1] + 1u; - unsigned int cost_replace = lev_matrix[i-1][j-1] + 1u; + /** If the characters are equal, no change is needed. **/ + if (str1[i - 1] == str2[j - 1]) + lev_matrix[i][j] = lev_matrix[i - 1][j - 1]; - /** If a swap is possible, calculate the cost. **/ - bool can_swap = ( - i > 1 && j > 1 && - str1[i - 1] == str2[j - 2] && - str1[i - 2] == str2[j - 1] - ); - unsigned int cost_swap = (can_swap) ? lev_matrix[i - 2][j - 2] + 1 : UINT_MAX; - - /** Assign the best operation. **/ - lev_matrix[i][j] = min(min(min(cost_delete, cost_insert), cost_replace), cost_swap); + /*** We need to make a change, so use the oppereration with the + *** lowest cost out of delete, insert, replace, or swap. + ***/ + else + { + unsigned int cost_delete = lev_matrix[i - 1][j] + 1u; + unsigned int cost_insert = lev_matrix[i][j - 1] + 1u; + unsigned int cost_replace = lev_matrix[i-1][j-1] + 1u; + + /** If a swap is possible, calculate the cost. **/ + bool can_swap = ( + i > 1 && j > 1 && + str1[i - 1] == str2[j - 2] && + str1[i - 2] == str2[j - 1] + ); + unsigned int cost_swap = (can_swap) ? lev_matrix[i - 2][j - 2] + 1 : UINT_MAX; + + /** Assign the best operation. **/ + lev_matrix[i][j] = min(min(min(cost_delete, cost_insert), cost_replace), cost_swap); + } } } - } - - /** Store result. **/ - unsigned int unsigned_result = lev_matrix[str1_len][str2_len]; - if (unsigned_result > INT_MAX) - { - fprintf(stderr, - "Warning: Integer overflow detected in ca_edit_dist(\"%s\", \"%s\", %lu, %lu) = %u > %d\n", - str1, str2, str1_length, str2_length, unsigned_result, INT_MAX - ); - } - result = (int)unsigned_result; - - /** Cleanup. **/ + + /** Store result. **/ + unsigned int unsigned_result = lev_matrix[str1_len][str2_len]; + if (unsigned_result > INT_MAX) + { + fprintf(stderr, + "Warning: Integer overflow detected in ca_edit_dist(\"%s\", \"%s\", %lu, %lu) = %u > %d\n", + str1, str2, str1_length, str2_length, unsigned_result, INT_MAX + ); + } + result = (int)unsigned_result; + + /** Cleanup. **/ end: - if (lev_matrix != NULL) - { - for (unsigned int i = 0u; i < str1_len + 1u; i++) + if (lev_matrix != NULL) { - if (lev_matrix[i] == NULL) break; - else nmSysFree(lev_matrix[i]); + for (unsigned int i = 0u; i < str1_len + 1u; i++) + { + if (lev_matrix[i] == NULL) break; + else nmSysFree(lev_matrix[i]); + } + nmSysFree(lev_matrix); } - nmSysFree(lev_matrix); - } /** Done. **/ return result; @@ -569,15 +576,15 @@ int ca_edit_dist(const char* str1, const char* str2, const size_t str1_length, c ***/ double ca_cos_compare(void* v1, void* v2) { - if (v1 == v2) return 1.0; - - /** Input validation checks. **/ - const pVector vec1 = v1, vec2 = v2; - const bool v1_empty = (vec1 == NULL || ca_is_empty(vec1) || ca_has_no_pairs(vec1)); - const bool v2_empty = (vec2 == NULL || ca_is_empty(vec2) || ca_has_no_pairs(vec2)); - if (v1_empty && v2_empty) return 1.0; - if (v1_empty && !v2_empty) return 0.0; - if (!v1_empty && v2_empty) return 0.0; + if (v1 == v2) return 1.0; + + /** Input validation checks. **/ + const pVector vec1 = v1, vec2 = v2; + const bool v1_empty = (vec1 == NULL || ca_is_empty(vec1) || ca_has_no_pairs(vec1)); + const bool v2_empty = (vec2 == NULL || ca_is_empty(vec2) || ca_has_no_pairs(vec2)); + if (v1_empty && v2_empty) return 1.0; + if (v1_empty && !v2_empty) return 0.0; + if (!v1_empty && v2_empty) return 0.0; /** Apply rounding to avoid annoying floating point issues before returning. **/ return round(sparse_similarity(vec1, vec2) * 1000000) / 1000000; @@ -598,23 +605,23 @@ double ca_cos_compare(void* v1, void* v2) ***/ double ca_lev_compare(void* str1, void* str2) { - /** Input validation checks. **/ - if (str1 == NULL || str2 == NULL) return 0.0; - if (str1 == str2) return 1.0; - - /** Handle string length. **/ - const size_t len1 = strlen(str1); - const size_t len2 = strlen(str2); - if (len1 == 0lu && len2 == 0lu) return 1.0; - if (len1 != 0lu && len2 == 0lu) return 0.0; - if (len1 == 0lu && len2 != 0lu) return 0.0; - - /** Compute levenshtein edit distance. **/ - const int edit_dist = ca_edit_dist((const char*)str1, (const char*)str2, len1, len2); - if (!check_neg(edit_dist)) return NAN; - - /** Normalize edit distance into a similarity measure. **/ - const double normalized_similarity = 1.0 - (double)edit_dist / (double)max(len1, len2); + /** Input validation checks. **/ + if (str1 == NULL || str2 == NULL) return 0.0; + if (str1 == str2) return 1.0; + + /** Handle string length. **/ + const size_t len1 = strlen(str1); + const size_t len2 = strlen(str2); + if (len1 == 0lu && len2 == 0lu) return 1.0; + if (len1 != 0lu && len2 == 0lu) return 0.0; + if (len1 == 0lu && len2 != 0lu) return 0.0; + + /** Compute levenshtein edit distance. **/ + const int edit_dist = ca_edit_dist((const char*)str1, (const char*)str2, len1, len2); + if (!check_neg(edit_dist)) return NAN; + + /** Normalize edit distance into a similarity measure. **/ + const double normalized_similarity = 1.0 - (double)edit_dist / (double)max(len1, len2); /** Apply rounding to avoid annoying floating point issues before returning. **/ return round(normalized_similarity * 1000000) / 1000000; @@ -630,8 +637,10 @@ double ca_lev_compare(void* str1, void* str2) bool ca_eql(pVector v1, pVector v2) { const unsigned int len = ca_sparse_len(v1); - for (unsigned int i = 0u; i < len; i++) - if (v1[i] != v2[i]) return false; + + for (unsigned int i = 0u; i < len; i++) + if (v1[i] != v2[i]) return false; + return true; } @@ -652,50 +661,52 @@ static double get_cluster_size( const unsigned int num_clusters) { double result = NAN; + double* cluster_sums = NULL; + unsigned int* cluster_counts = NULL; - /** Allocate space to store clusters as averages are computed. **/ - /*** We use nmMalloc() here because this function is usually called - *** repeatedly with the same number of clusters in the k-means loop. - *** Also, it is likely that k-means may be invoked multiple times with - *** the same k value, leading to additional caching benefits. - ***/ - double* cluster_sums = check_ptr(nmMalloc(num_clusters * sizeof(double))); - unsigned int* cluster_counts = check_ptr(nmMalloc(num_clusters * sizeof(unsigned int))); - if (cluster_sums == NULL) goto end; - if (cluster_counts == NULL) goto end; - for (unsigned int i = 0u; i < num_clusters; i++) - { - cluster_sums[i] = 0.0; - cluster_counts[i] = 0u; - } - - /** Sum the difference from each vector to its cluster centroid. **/ - for (unsigned int i = 0u; i < num_vectors; i++) - { - const unsigned int label = labels[i]; - cluster_sums[label] += sparse_dif_to_centroid(vectors[i], centroids[label]); - cluster_counts[label]++; - } - - /** Add up the average cluster size. **/ - double cluster_total = 0.0; - unsigned int num_valid_clusters = 0u; - for (unsigned int label = 0u; label < num_clusters; label++) - { - const unsigned int cluster_count = cluster_counts[label]; - if (cluster_count == 0u) continue; + /** Allocate space to store clusters as averages are computed. **/ + /*** We use nmMalloc() here because this function is usually called + *** repeatedly with the same number of clusters in the k-means loop. + *** Also, it is likely that k-means may be invoked multiple times with + *** the same k value, leading to additional caching benefits. + ***/ + cluster_sums = check_ptr(nmMalloc(num_clusters * sizeof(double))); + cluster_counts = check_ptr(nmMalloc(num_clusters * sizeof(unsigned int))); + if (cluster_sums == NULL) goto end; + if (cluster_counts == NULL) goto end; + for (unsigned int i = 0u; i < num_clusters; i++) + { + cluster_sums[i] = 0.0; + cluster_counts[i] = 0u; + } + + /** Sum the difference from each vector to its cluster centroid. **/ + for (unsigned int i = 0u; i < num_vectors; i++) + { + const unsigned int label = labels[i]; + cluster_sums[label] += sparse_dif_to_centroid(vectors[i], centroids[label]); + cluster_counts[label]++; + } + + /** Add up the average cluster size. **/ + double cluster_total = 0.0; + unsigned int num_valid_clusters = 0u; + for (unsigned int label = 0u; label < num_clusters; label++) + { + const unsigned int cluster_count = cluster_counts[label]; + if (cluster_count == 0u) continue; + + cluster_total += cluster_sums[label] / cluster_count; + num_valid_clusters++; + } + + /** Calculate average sizes. **/ + result = cluster_total / num_valid_clusters; - cluster_total += cluster_sums[label] / cluster_count; - num_valid_clusters++; - } - - /** Calculate average sizes. **/ - result = cluster_total / num_valid_clusters; - end: - /** Clean up. **/ - if (cluster_sums != NULL) nmFree(cluster_sums, num_clusters * sizeof(double)); - if (cluster_counts != NULL) nmFree(cluster_counts, num_clusters * sizeof(unsigned int)); + /** Clean up. **/ + if (cluster_sums != NULL) nmFree(cluster_sums, num_clusters * sizeof(double)); + if (cluster_counts != NULL) nmFree(cluster_counts, num_clusters * sizeof(unsigned int)); return result; } @@ -746,151 +757,156 @@ int ca_kmeans( unsigned int* labels, double* vector_sims) { - /** Setup stuff. **/ - bool successful = false; - unsigned int cluster_counts[num_clusters]; - memset(labels, 0u, num_vectors * sizeof(unsigned int)); - - /** Allocate space to store centroids and new_centroids. **/ - /** Dynamic allocation is required because these densely allocated arrays might be up to 500KB! **/ - const size_t centroids_size = num_clusters * sizeof(pCentroid); - pCentroid* centroids = check_ptr(nmMalloc(centroids_size)); - pCentroid* new_centroids = check_ptr(nmMalloc(centroids_size)); - if (centroids == NULL) goto end; - if (new_centroids == NULL) goto end; - memset(centroids, 0, centroids_size); - memset(new_centroids, 0, centroids_size); - for (unsigned int i = 0u; i < num_clusters; i++) - { - centroids[i] = check_ptr(nmMalloc(pCentroidSize)); - new_centroids[i] = check_ptr(nmMalloc(pCentroidSize)); - if (centroids[i] == NULL) goto end; - if (new_centroids[i] == NULL) goto end; - memset(centroids[i], 0, pCentroidSize); - memset(new_centroids[i], 0, pCentroidSize); - } - - /** Select random vectors to use as the initial centroids. **/ - srand(time(NULL)); - for (unsigned int i = 0u; i < num_clusters; i++) - { - /** Pick a random vector. **/ - const pVector vector = vectors[rand() % num_vectors]; + pCentroid* centroids = NULL; + pCentroid* new_centroids = NULL; - /** Sparse copy the vector to expand it into a densely allocated centroid. **/ - pCentroid centroid = centroids[i]; - for (unsigned int i = 0u, dim = 0u; dim < CA_NUM_DIMS;) + /** Setup variables. **/ + bool successful = false; + unsigned int cluster_counts[num_clusters]; + memset(labels, 0u, num_vectors * sizeof(unsigned int)); + + /** Allocate space to store centroids and new_centroids. **/ + /** Dynamic allocation is required because these densely allocated arrays might be up to 500KB! **/ + const size_t centroids_size = num_clusters * sizeof(pCentroid); + centroids = check_ptr(nmMalloc(centroids_size)); + new_centroids = check_ptr(nmMalloc(centroids_size)); + if (centroids == NULL) goto end; + if (new_centroids == NULL) goto end; + memset(centroids, 0, centroids_size); + memset(new_centroids, 0, centroids_size); + for (unsigned int i = 0u; i < num_clusters; i++) { - const int token = vector[i++]; - if (token > 0) centroid[dim++] = (double)token; - else for (unsigned int j = 0u; j < (unsigned)-token; j++) centroid[dim++] = 0.0; + centroids[i] = check_ptr(nmMalloc(pCentroidSize)); + new_centroids[i] = check_ptr(nmMalloc(pCentroidSize)); + if (centroids[i] == NULL) goto end; + if (new_centroids[i] == NULL) goto end; + memset(centroids[i], 0, pCentroidSize); + memset(new_centroids[i], 0, pCentroidSize); } - } - - /** Main kmeans loop. **/ - double old_average_cluster_size = 1.0; - for (unsigned int iter = 0u; iter < max_iter; iter++) - { - bool changed = false; - /** Reset new centroids. **/ + /** Select random vectors to use as the initial centroids. **/ + srand(time(NULL)); for (unsigned int i = 0u; i < num_clusters; i++) { - cluster_counts[i] = 0u; - for (unsigned int dim = 0; dim < CA_NUM_DIMS; dim++) - new_centroids[i][dim] = 0.0; + /** Pick a random vector. **/ + const pVector vector = vectors[rand() % num_vectors]; + + /** Sparse copy the vector to expand it into a densely allocated centroid. **/ + pCentroid centroid = centroids[i]; + for (unsigned int i = 0u, dim = 0u; dim < CA_NUM_DIMS;) + { + const int token = vector[i++]; + if (token > 0) centroid[dim++] = (double)token; + else for (unsigned int j = 0u; j < (unsigned)-token; j++) centroid[dim++] = 0.0; + } } - /** Assign each point to the nearest centroid. **/ - for (unsigned int i = 0u; i < num_vectors; i++) + /** Main kmeans loop. **/ + double old_average_cluster_size = 1.0; + for (unsigned int iter = 0u; iter < max_iter; iter++) { - const pVector vector = vectors[i]; - double min_dist = DBL_MAX; - unsigned int best_centroid_label = 0u; + bool changed = false; - // Find nearest centroid. - for (unsigned int j = 0u; j < num_clusters; j++) + /** Reset new centroids. **/ + for (unsigned int i = 0u; i < num_clusters; i++) + { + cluster_counts[i] = 0u; + for (unsigned int dim = 0; dim < CA_NUM_DIMS; dim++) + new_centroids[i][dim] = 0.0; + } + + /** Assign each point to the nearest centroid. **/ + for (unsigned int i = 0u; i < num_vectors; i++) { - const double dist = sparse_dif_to_centroid(vector, centroids[j]); - if (dist < min_dist) + const pVector vector = vectors[i]; + double min_dist = DBL_MAX; + unsigned int best_centroid_label = 0u; + + /** Find nearest centroid. **/ + for (unsigned int j = 0u; j < num_clusters; j++) { - min_dist = dist; - best_centroid_label = j; + const double dist = sparse_dif_to_centroid(vector, centroids[j]); + if (dist < min_dist) + { + min_dist = dist; + best_centroid_label = j; + } } - } - /** Update label to new centroid, if necessary. **/ - if (labels[i] != best_centroid_label) - { - labels[i] = best_centroid_label; - changed = true; + /** Update label to new centroid, if necessary. **/ + if (labels[i] != best_centroid_label) + { + labels[i] = best_centroid_label; + changed = true; + } + + /** Accumulate values for new centroid calculation. **/ + pCentroid best_centroid = new_centroids[best_centroid_label]; + for (unsigned int i = 0u, dim = 0u; dim < CA_NUM_DIMS;) + { + const int val = vector[i++]; + if (val < 0) dim += (unsigned)(-val); + else best_centroid[dim++] += (double)val; + } + cluster_counts[best_centroid_label]++; } - /** Accumulate values for new centroid calculation. **/ - pCentroid best_centroid = new_centroids[best_centroid_label]; - for (unsigned int i = 0u, dim = 0u; dim < CA_NUM_DIMS;) + /** Stop if centroids didn't change. **/ + if (!changed) break; + + /** Update centroids. **/ + for (unsigned int i = 0u; i < num_clusters; i++) { - const int val = vector[i++]; - if (val < 0) dim += (unsigned)(-val); - else best_centroid[dim++] += (double)val; + if (cluster_counts[i] == 0u) continue; + pCentroid centroid = centroids[i]; + const pCentroid new_centroid = new_centroids[i]; + const unsigned int cluster_count = cluster_counts[i]; + for (unsigned int dim = 0u; dim < CA_NUM_DIMS; dim++) + centroid[dim] = new_centroid[dim] / cluster_count; } - cluster_counts[best_centroid_label]++; + + /** Is there enough improvement? **/ + if (min_improvement < -1) continue; /** Skip check if it will never end the loop. **/ + const double average_cluster_size = check_double(get_cluster_size(vectors, num_vectors, labels, centroids, num_clusters)); + if (isnan(average_cluster_size)) goto end; + const double improvement = old_average_cluster_size - average_cluster_size; + if (improvement < min_improvement) break; + old_average_cluster_size = average_cluster_size; } - - /** Stop if centroids didn't change. **/ - if (!changed) break; - - /** Update centroids. **/ - for (unsigned int i = 0u; i < num_clusters; i++) + + /** Compute vector similarities, if requested. **/ + if (vector_sims != NULL) { - if (cluster_counts[i] == 0u) continue; - pCentroid centroid = centroids[i]; - const pCentroid new_centroid = new_centroids[i]; - const unsigned int cluster_count = cluster_counts[i]; - for (unsigned int dim = 0u; dim < CA_NUM_DIMS; dim++) - centroid[dim] = new_centroid[dim] / cluster_count; + for (unsigned int i = 0u; i < num_vectors; i++) + vector_sims[i] = sparse_similarity_to_centroid(vectors[i], centroids[labels[i]]); } - /** Is there enough improvement? **/ - if (min_improvement < -1) continue; /** Skip check if it will never end the loop. **/ - const double average_cluster_size = check_double(get_cluster_size(vectors, num_vectors, labels, centroids, num_clusters)); - if (isnan(average_cluster_size)) goto end; - const double improvement = old_average_cluster_size - average_cluster_size; - if (improvement < min_improvement) break; - old_average_cluster_size = average_cluster_size; - } - - /** Compute vector similarities, if requested. **/ - if (vector_sims != NULL) - { - for (unsigned int i = 0u; i < num_vectors; i++) - vector_sims[i] = sparse_similarity_to_centroid(vectors[i], centroids[labels[i]]); - } - - /** Success. **/ - successful = true; - - /** Clean up. **/ + /** Success. **/ + successful = true; + end: - if (centroids != NULL) - { - for (unsigned int i = 0u; i < num_clusters; i++) + /** Clean up. **/ + if (centroids != NULL) { - if (centroids[i] != NULL) nmFree(centroids[i], pCentroidSize); - else break; + for (unsigned int i = 0u; i < num_clusters; i++) + { + if (centroids[i] != NULL) nmFree(centroids[i], pCentroidSize); + else break; + } + nmFree(centroids, num_clusters * sizeof(pCentroid)); } - nmFree(centroids, num_clusters * sizeof(pCentroid)); - } - if (new_centroids != NULL) - { - for (unsigned int i = 0u; i < num_clusters; i++) + if (new_centroids != NULL) { - if (new_centroids[i] != NULL) nmFree(new_centroids[i], pCentroidSize); - else break; + for (unsigned int i = 0u; i < num_clusters; i++) + { + if (new_centroids[i] != NULL) nmFree(new_centroids[i], pCentroidSize); + else break; + } + nmFree(new_centroids, num_clusters * sizeof(pCentroid)); } - nmFree(new_centroids, num_clusters * sizeof(pCentroid)); - } - return (successful) ? 0 : -1; + + /** Return the function result code. **/ + return (successful) ? 0 : -1; } /*** Finds the data that is the most similar to the target and returns @@ -917,16 +933,18 @@ void* ca_most_similar( { void* most_similar = NULL; double best_sim = -INFINITY; - for (unsigned int i = 0u; (num_data == 0u) ? (data[i] != NULL) : (i < num_data); i++) - { - const double sim = check_double(similarity(target, data[i])); - if (isnan(sim)) continue; /* Skip this comparison. */ - if (sim > best_sim && sim > threshold) + + for (unsigned int i = 0u; (num_data == 0u) ? (data[i] != NULL) : (i < num_data); i++) { - most_similar = data[i]; - best_sim = sim; + const double sim = check_double(similarity(target, data[i])); + if (isnan(sim)) continue; /* Skip this comparison. */ + if (sim > best_sim && sim > threshold) + { + most_similar = data[i]; + best_sim = sim; + } } - } + return most_similar; } @@ -961,57 +979,57 @@ pXArray ca_sliding_search( void** maybe_keys, pXArray maybe_dups) { - /** Allocate space for dups (if necessary). **/ pXArray dups = maybe_dups; - if (dups == NULL) - { - /** Guess that we will need space for num_data * 2 dups. **/ - const int guess_size = num_data * 2; - dups = check_ptr(xaNew(guess_size)); - if (dups == NULL) goto err; - } - const int num_starting_dups = dups->nItems; - /** Search for dups. **/ - for (unsigned int i = 0u; i < num_data; i++) - { - const unsigned int window_start = i + 1u; - const unsigned int window_end = min(i + window_size, num_data); - for (unsigned int j = window_start; j < window_end; j++) + /** Allocate space for dups (if necessary). **/ + if (dups == NULL) { - const double sim = check_double(similarity(data[i], data[j])); - if (isnan(sim) || sim < 0.0 || 1.0 < sim) - { - fprintf(stderr, "Invalid similarity %g %lf.\n", sim, sim); - goto err_free_dups; - } - if (sim > threshold) /* Dup found! */ + /** Guess that we will need space for num_data * 2 dups. **/ + const int guess_size = num_data * 2; + dups = check_ptr(xaNew(guess_size)); + if (dups == NULL) goto err; + } + const int num_starting_dups = dups->nItems; + + /** Search for dups. **/ + for (unsigned int i = 0u; i < num_data; i++) + { + const unsigned int window_start = i + 1u; + const unsigned int window_end = min(i + window_size, num_data); + for (unsigned int j = window_start; j < window_end; j++) { - Dup* dup = (Dup*)check_ptr(nmMalloc(sizeof(Dup))); - if (dup == NULL) goto err_free_dups; - if (maybe_keys != NULL) + const double sim = check_double(similarity(data[i], data[j])); + if (isnan(sim) || sim < 0.0 || 1.0 < sim) { - dup->key1 = maybe_keys[i]; - dup->key2 = maybe_keys[j]; + fprintf(stderr, "Invalid similarity %g %lf.\n", sim, sim); + goto err_free_dups; + } + if (sim > threshold) /* Dup found! */ + { + Dup* dup = (Dup*)check_ptr(nmMalloc(sizeof(Dup))); + if (dup == NULL) goto err_free_dups; + if (maybe_keys != NULL) + { + dup->key1 = maybe_keys[i]; + dup->key2 = maybe_keys[j]; + } + dup->similarity = sim; + if (!check_neg(xaAddItem(dups, (void*)dup))) goto err_free_dups; } - dup->similarity = sim; - if (!check_neg(xaAddItem(dups, (void*)dup))) goto err_free_dups; } } - } - - /** Success. **/ - return dups; - - /** Error cleanup. **/ + + /** Success. **/ + return dups; + err_free_dups: - /** Free the dups that we added to the XArray. **/ - while (dups->nItems > num_starting_dups) - nmFree(dups->Items[--dups->nItems], sizeof(Dup)); - if (maybe_dups == NULL) check(xaDeInit(dups)); /* Failure ignored. */ + /** Error cleanup: Free the dups that we added to the XArray. **/ + while (dups->nItems > num_starting_dups) + nmFree(dups->Items[--dups->nItems], sizeof(Dup)); + if (maybe_dups == NULL) check(xaDeInit(dups)); /* Failure ignored. */ err: - return NULL; + return NULL; } /*** Runs a complete search over the provided data, comparing each element to diff --git a/centrallix-lib/src/mtask.c b/centrallix-lib/src/mtask.c index 9a167d724..401fbf15b 100644 --- a/centrallix-lib/src/mtask.c +++ b/centrallix-lib/src/mtask.c @@ -3407,7 +3407,7 @@ netGetRemotePort(pFile net_filedesc) } -/*** NETCONNECTTCP creats a client socket and connects it to a +/*** NETCONNECTTCP creates a client socket and connects it to a *** server on a given TCP service/port and host name. The flag *** NET_U_NOBLOCK causes the request to return immediately even *** if the connection is still trying to establish. Further @@ -4265,4 +4265,3 @@ syGetSem(pSemaphore sem, int cnt, int flags) return code; } - diff --git a/centrallix-lib/src/util.c b/centrallix-lib/src/util.c index edb65dbfa..6dbc8bd22 100644 --- a/centrallix-lib/src/util.c +++ b/centrallix-lib/src/util.c @@ -1,24 +1,24 @@ /************************************************************************/ -/* Centrallix Application Server System */ -/* Centrallix Base Library */ -/* */ -/* Copyright (C) 1998-2011 LightSys Technology Services, Inc. */ -/* */ -/* You may use these files and this library under the terms of the */ -/* GNU Lesser General Public License, Version 2.1, contained in the */ -/* included file "COPYING". */ -/* */ -/* Module: util.c, util.h */ -/* Author: Micah Shennum and Israel Fuller */ -/* Date: May 26, 2011 */ -/* Description: Collection of utilities including: */ -/* - Utilities for parsing numbers. */ -/* - The timer utility for benchmarking code. */ -/* - snprint_bytes() for formatting a byte count. */ -/* - snprint_llu() for formatting large numbers. */ -/* - fprint_mem() for printing memory stats. */ -/* - min() and max() for handling numbers. */ -/* - The check functions for reliably printing debug data. */ +/* Centrallix Application Server System */ +/* Centrallix Base Library */ +/* */ +/* Copyright (C) 1998-2011 LightSys Technology Services, Inc. */ +/* */ +/* You may use these files and this library under the terms of the */ +/* GNU Lesser General Public License, Version 2.1, contained in the */ +/* included file "COPYING". */ +/* */ +/* Module: util.c, util.h */ +/* Author: Micah Shennum and Israel Fuller */ +/* Date: May 26, 2011 */ +/* Description: Collection of utilities including: */ +/* - Utilities for parsing numbers. */ +/* - The timer utility for benchmarking code. */ +/* - snprint_bytes() for formatting a byte count. */ +/* - snprint_commas_llu() for formatting large numbers. */ +/* - fprint_mem() for printing memory stats. */ +/* - min() and max() for handling numbers. */ +/* - The check functions for reliably printing debug data. */ /************************************************************************/ #include @@ -95,9 +95,9 @@ unsigned int strtoui(const char *nptr, char **endptr, int base){ *** Fun Fact: Windows uses kibibytes, but displays them as KB. ***/ #define USE_METRIC false -#define nUnits 6u -static char* units_cs[nUnits] = {"bytes", "KiB", "MiB", "GiB"}; -static char* units_metric[nUnits] = {"bytes", "KB", "MB", "GB"}; +#define N_UNITS 6u +static char* units_cs[N_UNITS] = {"bytes", "KiB", "MiB", "GiB"}; +static char* units_metric[N_UNITS] = {"bytes", "KB", "MB", "GB"}; /*** Displays a size in bytes using the largest unit where the result would be *** at least 1.0. Note that units larger than GB and GiB are not supported @@ -113,98 +113,109 @@ static char* units_metric[nUnits] = {"bytes", "KB", "MB", "GB"}; ***/ char* snprint_bytes(char* buf, const size_t buf_size, unsigned int bytes) { - char** units = (USE_METRIC) ? units_metric : units_cs; - const double unit_size = (USE_METRIC) ? 1000.0 : 1024.0; - - /** Search for the largest unit where the value would be at least 1. **/ - const double size = (double)bytes; - for (unsigned char i = nUnits; i >= 1u; i--) - { - const double denominator = pow(unit_size, i); - if (size >= denominator) + char** units = (USE_METRIC) ? units_metric : units_cs; + const double unit_size = (USE_METRIC) ? 1000.0 : 1024.0; + + /** Search for the largest unit where the value would be at least 1. **/ + const double size = (double)bytes; + for (unsigned char i = N_UNITS; i >= 1u; i--) { - const double converted_size = size / denominator; - if (converted_size >= 100.0) - snprintf(buf, buf_size, "%.5g %s", converted_size, units[i]); - else if (converted_size >= 10.0) - snprintf(buf, buf_size, "%.4g %s", converted_size, units[i]); - else /* if (converted_size >= 1.0) - Always true. */ - snprintf(buf, buf_size, "%.3g %s", converted_size, units[i]); - return buf; + const double denominator = pow(unit_size, i); + if (size >= denominator) + { + const double converted_size = size / denominator; + if (converted_size >= 100.0) + snprintf(buf, buf_size, "%.5g %s", converted_size, units[i]); + else if (converted_size >= 10.0) + snprintf(buf, buf_size, "%.4g %s", converted_size, units[i]); + else /* if (converted_size >= 1.0) - Always true. */ + snprintf(buf, buf_size, "%.3g %s", converted_size, units[i]); + return buf; + } } - } - - /** None of the larger units work, so we just use bytes. **/ - snprintf(buf, buf_size, "%u %s", bytes, units[0]); + + /** None of the larger units work, so we just use bytes. **/ + snprintf(buf, buf_size, "%u %s", bytes, units[0]); return buf; } #undef nUints -char* snprint_llu(char* buf, size_t buflen, unsigned long long value) +/*** Print a large number formatted with comas to a buffer. + *** + *** @param buf The buffer to print the number into. + *** @param buf_size The maximum number of characters to add to the buffer. + *** @param value The value to write into the buffer. + *** @returns `buf`, or `NULL` if `buf_size` is 0. + */ +char* snprint_commas_llu(char* buf, size_t buf_size, unsigned long long value) { - if (buflen == 0) return NULL; - if (value == 0) - { - if (buflen > 1) { buf[0] = '0'; buf[1] = '\0'; } - else buf[0] = '\0'; - return buf; - } - - char tmp[32]; - unsigned int ti = 0; - while (value > 0 && ti < sizeof(tmp) - 1) - { - if (ti % 4 == 3) tmp[ti++] = ','; - tmp[ti++] = '0' + (value % 10); - value /= 10; - } - tmp[ti] = '\0'; - - unsigned int outlen = min(ti, buflen - 1u); - for (unsigned int i = 0u; i < outlen; i++) buf[i] = tmp[ti - i - 1]; - buf[outlen] = '\0'; + if (buf_size == 0) return NULL; + if (value == 0) + { + if (buf_size > 1) { buf[0] = '0'; buf[1] = '\0'; } + else buf[0] = '\0'; + return buf; + } + + char tmp[32]; + unsigned int ti = 0; + while (value > 0 && ti < sizeof(tmp) - 1) + { + if (ti % 4 == 3) tmp[ti++] = ','; + tmp[ti++] = '0' + (value % 10); + value /= 10; + } + tmp[ti] = '\0'; + + unsigned int outlen = min(ti, buf_size - 1u); + for (unsigned int i = 0u; i < outlen; i++) buf[i] = tmp[ti - i - 1]; + buf[outlen] = '\0'; + return buf; } void fprint_mem(FILE* out) { - FILE* fp = fopen("/proc/self/statm", "r"); - if (fp == NULL) { perror("fopen()"); return; } - - long size, resident, share, text, lib, data, dt; - if (fscanf(fp, "%ld %ld %ld %ld %ld %ld %ld", - &size, &resident, &share, &text, &lib, &data, &dt) != 7) - { - fprintf(stderr, "Failed to read memory info\n"); - fclose(fp); - return; - } - fclose(fp); - - long page_size = sysconf(_SC_PAGESIZE); // in bytes - long resident_bytes = resident * page_size; - - const size_t buf_siz = 16u; - char buf[buf_siz]; - snprint_bytes(buf, buf_siz, (unsigned int)resident_bytes); + FILE* fp = fopen("/proc/self/statm", "r"); + if (fp == NULL) { perror("fopen()"); return; } + + long size, resident, share, text, lib, data, dt; + if (fscanf(fp, "%ld %ld %ld %ld %ld %ld %ld", + &size, &resident, &share, &text, &lib, &data, &dt) != 7) + { + fprintf(stderr, "Failed to read memory info\n"); + check(fclose(fp)); /* Failure ignored. */ + return; + } + check(fclose(fp)); /* Failure ignored. */ + + long page_size = sysconf(_SC_PAGESIZE); // in bytes + long resident_bytes = resident * page_size; - fprintf(out, "Memory used: %ld bytes (%s)\n", resident_bytes, buf); - fprintf(out, "Share %ldb, Text %ldb, Lib %ldb, Data %ldb\n", share, text, lib, data); + const size_t buf_siz = 16u; + char buf[buf_siz]; + snprint_bytes(buf, buf_siz, (unsigned int)resident_bytes); + + fprintf(out, "Memory used: %ld bytes (%s)\n", resident_bytes, buf); + fprintf(out, "Share %ldb, Text %ldb, Lib %ldb, Data %ldb\n", share, text, lib, data); } static double get_time(void) { struct timespec ts; - clock_gettime(CLOCK_MONOTONIC, &ts); + + clock_gettime(CLOCK_MONOTONIC, &ts); + return (double)ts.tv_sec + (double)ts.tv_nsec / 1.0e9f; } pTimer timer_init(pTimer timer) { - if (timer == NULL) return NULL; - timer->start = NAN; - timer->total = 0.0; + if (timer == NULL) return NULL; + timer->start = NAN; + timer->total = 0.0; + return timer; } @@ -215,15 +226,17 @@ pTimer timer_new(void) pTimer timer_start(pTimer timer) { - if (!timer) return timer; - timer->start = get_time(); + if (!timer) return timer; + timer->start = get_time(); + return timer; } pTimer timer_stop(pTimer timer) { - if (!timer) return timer; - timer->total += get_time() - timer->start; + if (!timer) return timer; + timer->total += get_time() - timer->start; + return timer; } @@ -241,8 +254,8 @@ void timer_de_init(pTimer timer) {} void timer_free(pTimer timer) { - timer_de_init(timer); - nmFree(timer, sizeof(Timer)); + timer_de_init(timer); + nmFree(timer, sizeof(Timer)); } /*** Function for failing on error, assuming the error came from a library or @@ -250,12 +263,12 @@ void timer_free(pTimer timer) ***/ void print_err(int code, const char* function_name, const char* file_name, const int line_number) { - /** Create a descriptive error message. **/ - char error_buf[BUFSIZ]; - snprintf(error_buf, sizeof(error_buf), "%s:%d: %s failed", file_name, line_number, function_name); - - /** Print it with as much info as we can reasonably find. **/ - if (errno != 0) perror(error_buf); - else if (code != 0) fprintf(stderr, "%s (error code %d).\n", error_buf, code); - else fprintf(stderr, "%s.\n", error_buf); + /** Create a descriptive error message. **/ + char error_buf[BUFSIZ]; + snprintf(error_buf, sizeof(error_buf), "%s:%d: %s failed", file_name, line_number, function_name); + + /** Print it with as much info as we can reasonably find. **/ + if (errno != 0) perror(error_buf); + else if (code != 0) fprintf(stderr, "%s (error code %d).\n", error_buf, code); + else fprintf(stderr, "%s.\n", error_buf); } diff --git a/centrallix-lib/src/xhash.c b/centrallix-lib/src/xhash.c index 46ef3a6fb..7bf4242cc 100644 --- a/centrallix-lib/src/xhash.c +++ b/centrallix-lib/src/xhash.c @@ -292,7 +292,8 @@ xhClear(pXHashTable this, int (*free_fn)(), void* free_arg) /*** Executes an operation on each entry of the hash table entry. *** - *** @param this The affected hash table. + *** @param this The affected hash table (passing NULL causes undefined + *** behavior). *** @param callback_fn A callback function to be called on each hash table *** entry. It takes 2 parameters: the current hash table entry and a void* *** argument specified using each_arg. If any invocation of the callback @@ -307,57 +308,85 @@ xhClear(pXHashTable this, int (*free_fn)(), void* free_arg) int xhForEach(pXHashTable this, int (*callback_fn)(pXHashEntry, void*), void* each_arg) { - if (callback_fn == NULL) return 1; - - for (int row = 0; row < this->nRows; row++) - { - pXHashEntry entry = (pXHashEntry)(this->Rows.Items[row]); - while (entry != NULL) + if (callback_fn == NULL) return 1; + + for (int row = 0; row < this->nRows; row++) { - pXHashEntry next = entry->Next; - const int ret = callback_fn(entry, each_arg); - if (ret != 0) return ret; - entry = next; + pXHashEntry entry = (pXHashEntry)(this->Rows.Items[row]); + while (entry != NULL) + { + pXHashEntry next = entry->Next; + const int ret = callback_fn(entry, each_arg); + if (ret != 0) return ret; + entry = next; + } } - } return 0; } +/*** A helper function for `xhClearKeySafe()`. Deallocates a hash table entry + *** after calling the appropriate free function with the provided free arg. + *** + *** @param entry A pointer to the hash table entry to be freed (passing NULL + *** causes undefined behavior). + *** @param arg A pointer to a void* array with 2 elements: The first element + *** is a function pointer to the free function, which we invoke using the + *** provided entry and the free_arg, specified as the second element of + *** this array. + *** @returns 0, success. + ****/ static int -xhiFreeEntry(pXHashEntry entry, void* arg) +xh_i_FreeEntry(pXHashEntry entry, void* arg) { - /*** The passed void* actually points to a void* array with 2 elements. - *** The first element is a function pointer to the free function, which - *** we invoke using the provided entry and the free_arg, specified as the - *** second element of the array. - *** - *** Interestingly, you can write this code in one line like this: - *** ((void (*)(pXHashEntry, void*))((void**)arg)[0])(entry, ((void**)arg)[1]); - *** But I value code readability, so fortunately, I can't be THAT cleaver... - ***/ - void** args = (void**)arg; - void (*free_fn)(pXHashEntry, void*) = args[0]; - free_fn(entry, args[1]); - - /** Free the entry. **/ - nmFree(entry, sizeof(XHashEntry)); + /*** The passed void* actually points to a void* array with 2 elements. + *** + *** The first element is a function pointer to the free function, which + *** we invoke using the provided entry and the free_arg, specified as the + *** second element of the array. + *** + *** Interestingly, you can write this code in one line like this: + *** ((void (*)(pXHashEntry, void*))((void**)arg)[0])(entry, ((void**)arg)[1]); + *** But I value code readability, so fortunately, I can't be THAT cleaver... + ***/ + void** args = (void**)arg; + void (*free_fn)(pXHashEntry, void*) = args[0]; + free_fn(entry, args[1]); + + /** Free the entry. **/ + nmFree(entry, sizeof(XHashEntry)); return 0; } +/*** Clears all contents from a hash table. The free function is passed each + *** hash entry struct, allowing it to free both the value and key, if needed. + *** + *** @param this The affected hash table (passing NULL causes undefined + *** behavior). + *** @param free_fn A pointer to a free function which will be called with a + *** pointer to each `XHashEntry` before they are deallocated. It is also + *** passed a `void*`, which will be `free_arg` (the third argument). + *** @param free_arg The void pointer value passed to the free function. + *** @returns 0 if successful, or + *** -1 if `free_fn()` is `NULL`. + ***/ int xhClearKeySafe(pXHashTable this, void (*free_fn)(pXHashEntry, void*), void* free_arg) { - /** Free each row. **/ - void* args[2] = {free_fn, free_arg}; - const int ret = xhForEach(this, xhiFreeEntry, args); - - /** Mark all rows as empty. **/ - for (int i = 0; i < this->nRows; i++) - this->Rows.Items[i] = NULL; - this->nItems = 0; + if (free_fn == NULL) return -1; + + /** Free each row. **/ + void* args[2] = {free_fn, free_arg}; + const int ret = xhForEach(this, xh_i_FreeEntry, args); + + /** Mark all rows as empty. **/ + for (int i = 0; i < this->nRows; i++) + this->Rows.Items[i] = NULL; + this->nItems = 0; - /** We are successful only if the free function didn't fail. **/ + /*** We are successful only if the free function didn't fail (and it should + *** not be able to fail). + ***/ return ret; } diff --git a/centrallix-sysdoc/GCC_Dependencies.md b/centrallix-sysdoc/GCC_Dependencies.md new file mode 100644 index 000000000..1327ea090 --- /dev/null +++ b/centrallix-sysdoc/GCC_Dependencies.md @@ -0,0 +1,20 @@ +# GCC Dependencies + +Author: Israel Fuller + +Date: Descember 4, 2025 + +## Table of Contents +- [GCC Dependencies](#gcc-dependencies) + - [Table of Contents](#table-of-contents) + - [Introduction](#intoduction) + - [List of Dependencies](#list-of-dependencies) + +## Intoduction +This document tracks dependencies on the GCC toolchain in the centrallix codebase. As code is added which relies on GCC specific behavior, such additions should be noted here to make possible use of a different toolchain (e.g. LLVM) in the future less painful. + +## List of Dependencies +- `util.h` Uses the `__typeof__` to avoid double-computation in macros. + +## Notes +`__FILE__` and `__LINE__` are not dependencies as they were added in C90. See [this page](https://gcc.gnu.org/onlinedocs/cpp/Standard-Predefined-Macros.html) for information about predefined macros. diff --git a/centrallix-sysdoc/OSDriver_Authoring.md b/centrallix-sysdoc/OSDriver_Authoring.md index c48288860..6283a8855 100644 --- a/centrallix-sysdoc/OSDriver_Authoring.md +++ b/centrallix-sysdoc/OSDriver_Authoring.md @@ -27,6 +27,8 @@ + + # ObjectSystem Driver Interface @@ -35,16 +37,21 @@ **Date**: January 13, 1999 -**Updated**: November 17, 2025 +**Updated**: December 11, 2025 + +**License**: Copyright (C) 2001-2025 LightSys Technology Services. See LICENSE.txt for more information. + -**License**: Copyright (C) 2001-2011 LightSys Technology Services. See LICENSE.txt for more information. ## Table of Contents - [ObjectSystem Driver Interface](#objectsystem-driver-interface) - [Table of Contents](#table-of-contents) - [I Introduction](#i-introduction) - [II Interface](#ii-interface) - - [Function: Open](#function-open) + - [Abbreviation Prefix](#abbreviation-prefix) + - [Internal Functions](#internal-functions) + - [Function: Initialize()](#function-initialize) + - [Function: Open()](#function-open) - [Function: OpenChild()](#function-openchild) - [Function: Close()](#function-close) - [Function: Create()](#function-create) @@ -102,84 +109,124 @@ - [nmSysRealloc()](#nmsysrealloc) - [nmSysStrdup()](#nmsysstrdup) - [nmSysFree()](#nmsysfree) - - [V Other Utility Modules](#v-other-utility-modules) - - [A. XArray (XA) - Arrays](#axarray-xa---arrays) - - [xaInit(pXArray this, int init_size)](#xainitpxarray-this-int-init_size) - - [xaDeInit(pXArray this)](#xadeinitpxarray-this) - - [xaAddItem(pXArray this, void* item)](#xaadditempxarray-this-void-item) - - [xaAddItemSorted(pXArray this, void* item, int keyoffset, int keylen)](#xaadditemsortedpxarray-this-void-item-int-keyoffset-int-keylen) - - [xaFindItem(pXArray this, void* item)](#xafinditempxarray-this-void-item) - - [xaRemoveItem(pXArray this, int index)](#xaremoveitempxarray-this-int-index) - - [B. XHash (XH) - Hash Tables](#bxhash-xh---hash-tables) - - [int xhInit(pXHashTable this, int rows, int keylen)](#int-xhinitpxhashtable-this-int-rows-int-keylen) - - [int xhDeInit(pXHashTable this)](#int-xhdeinitpxhashtable-this) - - [int xhAdd(pXHashTable this, char* key, char* data)](#int-xhaddpxhashtable-this-char-key-char-data) - - [int xhRemove(pXHashTable this, char* key)](#int-xhremovepxhashtable-this-char-key) - - [char* xhLookup(pXHashTable this, char* key)](#char-xhlookuppxhashtable-this-char-key) - - [int xhClear(pXHashTable this, int free_blk)](#int-xhclearpxhashtable-this-int-free_blk) - - [C. XString (XS) - Strings](#cxstring-xs---strings) - - [int xsInit(pXString this)](#int-xsinitpxstring-this) - - [int xsDeInit(pXString this)](#int-xsdeinitpxstring-this) - - [int xsConcatenate(pXString this, char* text, int len)](#int-xsconcatenatepxstring-this-char-text-int-len) - - [int xsCopy(pXString this, char* text, int len)](#int-xscopypxstring-this-char-text-int-len) - - [char* xsStringEnd(pXString this)](#char-xsstringendpxstring-this) - - [D. Expression (EXP) - Expression Trees](#dexpression-exp---expression-trees) - - [pExpression expCompileExpression(char* text, pParamObjects objlist, int lxflags, int cmpflags)](#pexpression-expcompileexpressionchar-text-pparamobjects-objlist-int-lxflags-int-cmpflags) - - [expFreeExpression(pExpression this)](#expfreeexpressionpexpression-this) - - [int expEvalTree(pExpression this, pParamObjects objlist)](#int-expevaltreepexpression-this-pparamobjects-objlist) - - [pParamObjects expCreateParamList()](#pparamobjects-expcreateparamlist) - - [int expFreeParamList(pParamObjects this)](#int-expfreeparamlistpparamobjects-this) - - [int expAddParamToList(pParamObjects this, char* name, pObject obj, int flags)](#int-expaddparamtolistpparamobjects-this-char-name-pobject-obj-int-flags) - - [int expModifyParam(pParamObjects this, char* name, pObject replace_obj)](#int-expmodifyparampparamobjects-this-char-name-pobject-replace_obj) - - [int expRemoveParamFromList(pParamObjects this, char* name)](#int-expremoveparamfromlistpparamobjects-this-char-name) - - [int expReverseEvalTree(pExpression tree, pParamObjects objlist)](#int-expreverseevaltreepexpression-tree-pparamobjects-objlist) - - [E. MTSession (MSS) - Basic Session Management](#emtsession-mss---basic-session-management) - - [char* mssUserName()](#char-mssusername) - - [char* mssPassword()](#char-msspassword) - - [int mssSetParam(char* paramname, char* param)](#int-msssetparamchar-paramname-char-param) - - [char* mssGetParam(char* paramname)](#char-mssgetparamchar-paramname) - - [int mssError(int clr, char* module, char* message, ...)](#int-msserrorint-clr-char-module-char-message-) - - [int mssErrorErrno(int clr, char* module, char* message, ...)](#int-msserrorerrnoint-clr-char-module-char-message-) - - [F. OSML Utility Functions](#fosml-utility-functions) - - [char* obj_internal_PathPart(pPathname path, int start, int length)](#char-obj_internal_pathpartppathname-path-int-start-int-length) - - [int obj_internal_AddToPath(pPathname path, char* new_element)](#int-obj_internal_addtopathppathname-path-char-new_element) - - [int obj_internal_CopyPath(pPathname dest, pPathname src)](#int-obj_internal_copypathppathname-dest-ppathname-src) - - [void obj_internal_FreePathStruct(pPathname path)](#void-obj_internal_freepathstructppathname-path) - - [VI Network Connection Functionality](#vi-network-connection-functionality) - - [pFile netConnectTCP(char* host_name, char* service_name, int flags)](#pfile-netconnecttcpchar-host_name-char-service_name-int-flags) - - [int netCloseTCP(pFile net_filedesc, int linger_msec, int flags)](#int-netclosetcppfile-net_filedesc-int-linger_msec-int-flags) - - [int fdWrite(pFile filedesc, char* buffer, int length, int offset, int flags)](#int-fdwritepfile-filedesc-char-buffer-int-length-int-offset-int-flags) - - [int fdRead(pFile filedesc, char* buffer, int maxlen, int offset, int flags)](#int-fdreadpfile-filedesc-char-buffer-int-maxlen-int-offset-int-flags) - - [VII Parsing Data](#vii-parsing-data) - - [pLxSession mlxOpenSession(pFile fd, int flags)](#plxsession-mlxopensessionpfile-fd-int-flags) - - [pLxSession mlxStringSession(char* str, int flags)](#plxsession-mlxstringsessionchar-str-int-flags) - - [int mlxCloseSession(pLxSession this)](#int-mlxclosesessionplxsession-this) - - [int mlxNextToken(pLxSession this)](#int-mlxnexttokenplxsession-this) - - [char* mlxStringVal(pLxSession this, int* alloc)](#char-mlxstringvalplxsession-this-int-alloc) - - [int mlxIntVal(pLxSession this)](#int-mlxintvalplxsession-this) - - [double mlxDoubleVal(pLxSession this)](#double-mlxdoublevalplxsession-this) - - [int mlxCopyToken(pLxSession this, char* buffer, int maxlen)](#int-mlxcopytokenplxsession-this-char-buffer-int-maxlen) - - [int mlxHoldToken(pLxSession this)](#int-mlxholdtokenplxsession-this) - - [int mlxSetOptions(pLxSession this, int options)](#int-mlxsetoptionsplxsession-this-int-options) - - [int mlxUnsetOptions(pLxSession this, int options)](#int-mlxunsetoptionsplxsession-this-int-options) - - [int mlxSetReservedWords(pLxSession this, char** res_words)](#int-mlxsetreservedwordsplxsession-this-char-res_words) - - [int mlxNoteError(pLxSession this)](#int-mlxnoteerrorplxsession-this) - - [int mlxNotePosition(pLxSession this)](#int-mlxnotepositionplxsession-this) - - [VIII Objectsystem Driver Testing](#viii-objectsystem-driver-testing) - - [A. Object opening, closing, creation, and deletion](#aobject-opening-closing-creation-and-deletion) - - [B. Object attribute enumeration, getting, and setting.](#bobject-attribute-enumeration-getting-and-setting) - - [C. Object querying (for subobjects)](#cobject-querying-for-subobjects) + - [V Module: XArray](#v-module-xarray) + - [xaNew()](#xanew) + - [xaFree()](#xafree) + - [xaInit()](#xainit) + - [xaDeInit()](#xadeinit) + - [xaAddItem()](#xaadditem) + - [xaAddItemSorted()](#xaadditemsorted) + - [xaAddItemSortedInt32()](#xaadditemsortedint32) + - [xaGetItem()](#xagetitem) + - [xaFindItem()](#xafinditem) + - [xaFindItemR()](#xafinditemr) + - [xaRemoveItem()](#xaremoveitem) + - [xaClear()](#xaclear) + - [xaClearR()](#xaclearr) + - [xaCount()](#xacount) + - [xaInsertBefore()](#xainsertbefore) + - [xaInsertAfter()](#xainsertafter) + - [VI Module: XHash](#vi-module-xhash) + - [xhInitialize()](#xhinitialize) + - [xhInit()](#xhinit) + - [xhDeInit()](#xhdeinit) + - [xhAdd()](#xhadd) + - [xhRemove()](#xhremove) + - [xhLookup()](#xhlookup) + - [xhClear()](#xhclear) + - [xhForEach()](#xhforeach) + - [xhClearKeySafe()](#xhclearkeysafe) + - [VII Module: XString](#vii-module-xstring) + - [xsNew()](#xsnew) + - [xsFree()](#xsfree) + - [xsInit()](#xsinit) + - [xsDeInit()](#xsdeinit) + - [xsCheckAlloc()](#xscheckalloc) + - [xsConcatenate()](#xsconcatenate) + - [xsCopy()](#xscopy) + - [xsStringEnd()](#xsstringend) + - [xsConcatPrintf()](#xsconcatprintf) + - [xsPrintf()](#xsprintf) + - [xsWrite()](#xswrite) + - [xsRTrim()](#xsrtrim) + - [xsLTrim()](#xsltrim) + - [xsTrim()](#xstrim) + - [xsFind()](#xsfind) + - [xsFindRev()](#xsfindrev) + - [xsSubst()](#xssubst) + - [xsReplace()](#xsreplace) + - [xsInsertAfter()](#xsinsertafter) + - [xsGenPrintf_va()](#xsgenprintf_va) + - [xsGenPrintf()](#xsgenprintf) + - [xsString()](#xsstring) + - [xsLength()](#xslength) + - [xsQPrintf_va(), xsQPrintf(), & xsConcatQPrintf()](#xsqprintf_va-xsqprintf--xsconcatqprintf) + - [VIII Module: Expression](#viii-module-expression) + - [expCompileExpression())](#expallocexpression) + - [expFreeExpression()](#expfreeexpression) + - [expCompileExpression()](#expcompileexpression) + - [expCompileExpressionFromLxs()](#expcompileexpressionfromlxs) + - [expPodToExpression()](#exppodtoexpression) + - [expExpressionToPod()](#expexpressiontopod) + - [expDuplicateExpression()](#expduplicateexpression) + - [expIsConstant()](#expisconstant) + - [expEvalTree()](#expevaltree) + - [expCreateParamList()](#expcreateparamlist) + - [expFreeParamList()](#expfreeparamlist) + - [expAddParamToList()](#expaddparamtolist) + - [expModifyParam()](#expmodifyparam) + - [expRemoveParamFromList()](#expremoveparamfromlist) + - [expSetParamFunctions()](#expsetparamfunctions) + - [expReverseEvalTree()](#expreverseevaltree) + - [IX MTSession](#ix-module-mtsession) + - [mssUserName()](#mssusername) + - [mssPassword()](#msspassword) + - [mssSetParam()](#msssetparam) + - [mssGetParam()](#mssgetparam) + - [mssError()](#msserror) + - [mssErrorErrno()](#msserrorerrno) + - [X Path Handling Functions](#x-path-handling-functions) + - [obj_internal_PathPart()](#obj_internal_pathpart) + - [obj_internal_AddToPath()](#obj_internal_addtopath) + - [obj_internal_CopyPath](#obj_internal_copypath) + - [obj_internal_FreePathStruct()](#obj_internal_freepathstruct) + - [XI Network Connection Functionality](#vi-network-connection-functionality) + - [netConnectTCP()](#netconnecttcp) + - [netCloseTCP()](#netclosetcp) + - [fdWrite()](#fdwrite) + - [fdRead()](#fdread) + - [XII Parsing Data](#xii-parsing-data) + - [mlxOpenSession()](#mlxopensession) + - [mlxStringSession()](#mlxstringsession) + - [mlxCloseSession()](#mlxclosesession) + - [mlxNextToken()](#mlxnexttoken) + - [mlxStringVal()](#mlxstringval) + - [mlxIntVal()](#mlxintval) + - [mlxDoubleVal()](#mlxdoubleval) + - [mlxCopyToken()](#mlxcopytoken) + - [mlxHoldToken()](#mlxholdtoken) + - [mlxSetOptions()](#mlxsetoptions) + - [mlxUnsetOptions()](#mlxunsetoptions) + - [mlxSetReservedWords()](#mlxsetreservedwords) + - [mlxNoteError()](#mlxnoteerror) + - [mlxNotePosition()](#mlxnoteposition) + - [XIII Driver Testing](#xiii-driver-testing) + - [Object opening, closing, creation, and deletion](#aobject-opening-closing-creation-and-deletion) + - [Object attribute enumeration, getting, and setting.](#bobject-attribute-enumeration-getting-and-setting) + - [Object querying (for subobjects)](#cobject-querying-for-subobjects) ## I Introduction -An objectsystem driver's purpose is to provide access to a particular type of local or network data/resource. Specific information about the resource to be accessed (such as credentials for a database, queries for selecting data, the auth token for an API, etc.) is stored in a file that is openned by the relevant driver. For example, the query driver (defined in `objdrv_query.c`) opens `.qy` files, which store one or more ObjectSQL queries used to fetch data. +An objectsystem driver's purpose is to provide access to a particular type of local or network data/resource. Specific information about the resource to be accessed (such as credentials for a database, queries for selecting data, the auth token for an API, etc.) is stored in a file that is opened by the relevant driver. For example, the query driver (defined in `objdrv_query.c`) opens `.qy` files, which store one or more ObjectSQL queries used to fetch data. + +When the object system starts up, each driver registers one or more type names that it supports (e.g. `"system/query"` for the query driver). When a file is opened, the object system uses the file's type name to select which driver to use. It finds this type name with one of two strategies. If the file has an extension (e.g. `example.qy`), that extension can be mapped to a type name using `types.cfg` (e.g. `.qy` maps to `"system/query"`). Althernatively, the file may reside in a directory containing a `.type` file which explicitly specifies the type name for all files in that directory without recognizable extensions. -When the object system starts up, each driver registers one or more type names that it supports (e.g. `"system/query"` for the query driver). When a file is openned, the object system uses the file's type name to select which driver to use. It finds this type name with one of two strategies. If the file has an extension (e.g. `example.qy`), that extension can be mapped to a type name using `types.cfg` (e.g. `.qy` maps to `"system/query"`). Althernatively, the file may reside in a directory containing a `.type` file which explicitly specifies the type name for all files in that directory without recognizable extensions. +Once a file is opened, the driver should organize provided data into a tree-structured hierarchy, which becomes part of the path used by Centrallix's ObjectSystem. For example, when opening `example.qy` in the ObjectSystem, the driver makes `/rows` and `/columns` available, allowing for paths such as `/apps/data/example.qy/rows`. The root of a driver's tree (`example.qy`) is called the driver's "node" object, and most paths traverse the node objects of multiple drivers. The root of the entire tree is a special driver called the root node which is used to begin traversal. Within its tree, a driver author is free to define any manner of hierarchical structures for representing available data. However, the structure should fit the basic ObjectSystem model of a hierarchy of objects, each having attributes, and optionally some methods and/or content. -Once a file is openned, the driver should organize provided data into a tree-structured hierarchy, which becomes part of the path used by Centrallix's ObjectSystem. For example, when opening `example.qy` in the ObjectSystem, the driver makes `/rows` and `/columns` available, allowing for paths such as `/apps/data/example.qy/rows`. The root of a driver's tree (`example.qy`) is called the driver's "node" object, and most paths traverse the root nodes of multiple drivers. A driver author is free to define any manner of tree structures for representing data available within their driver. However, the structure should fit the basic ObjectSystem model of a hierarchy of objects, each having attributes, and optionally some methods and/or content. +A driver can be opened multiple times, leading one driver to have multiple "node" objects, also called instances. Typically, each "node" object relates to a particular instance of a resource. For example, say you are designing a driver to access MySQL databases. You could design the driver file to describe a MySQL instance. Thus, the node object for this driver could have children for each database in that instance (e.g. `Kardia_DB`, `mysql`, and even the system databases used by MySQL to manage the database internals). Another design would be for each driver file to describe one MySQL database. Thus, you could make a `Kardia_DB` file to access that database, and the children of that node object would be each table in the database. A third design option would be for each driver file to describe a MySQL table. Thus, you make a `p_partner` file to access members of the partner table, a `p_contact_info` file to access contact info for parterners, etc. with each node object having children for the rows in the table. This last option would require the developer to create a _lot_ of files (and would probably also make joins hard to implement), so in this case, it's probably not the best. Ultimately, though, these design choices are up to the driver author. -A driver can be openned multiple times, leading one driver to have multiple "node" objects, also called instances. Typically, each "node" object relates to a particular instance of a network resource. For example, an instance of a POP3 driver might represent a POP3 server on the network. If the network had multiple POP3 servers, this driver could be used to access each of them through different node objects (e.g. `dev.pop3`, `prod.pop3`, etc.). However, if somehow the OS driver were able to easily enumerate the various POP3 servers on the network (i.e., they responded to some kind of hypothetical broadcast query), then the OS driver author could also design the driver to list the POP3 servers under a single node for the whole network. +an instance of a POP3 driver might represent a POP3 server on the network. If the network had multiple POP3 servers, this driver could be used to access each of them through different node objects (e.g. `dev.pop3`, `prod.pop3`, etc.). However, if somehow the OS driver were able to easily enumerate the various POP3 servers on the network (i.e., they responded to some kind of hypothetical broadcast query), then the OS driver author could also design the driver to list the POP3 servers under a single node for the whole network. The structure of the subtree beneath the node object is entirely up to the drivers' author to determine; the OSML does not impose any structural restrictions on such subtrees. Each object within this structure (e.g. `/example.qy`) can have three types of readable data: - Child objects (e.g. `/rows`) which can have their own data. @@ -191,27 +238,34 @@ Thus, parent objects with child objects behave similarly to a directory, althoug Below is an example of the Sybase driver's node object and its subtrees of child objects (defined in `objdrv_sybase.c`): ```sh -OMSS_DB (type = "application/sybase") +Kardia_DB (type = "application/mysql") | - +----- JNetHelp (type = "system/table") + +----- p_partner (type = "system/table") | | | +----- columns (type = "system/table-columns") | | | - | | +----- document_id (type = "system/column") + | | +----- p_partner_key (type = "system/column") | | | - | | +----- parent_id (type = "system/column") + | | +----- p_given_name (type = "system/column") | | | - | | +----- title (type = "system/column") + | | +----- p_surname (type = "system/column") | | | - | | +----- content (type = "system/column") + | | ... | | | +----- rows (type = "system/table-rows") + | | | + | | +----- 1 (type = "system/row") + | | | + | | +----- 2 (type = "system/row") + | | | + | | ... | | - | +----- 1 (type = "system/row") - | | - | +----- 2 (type = "system/row") + | ... | - +----- Partner (type = "system/table") + +----- p_contact_info (type = "system/table") + | | + | ... + ... ``` (... and so forth) @@ -229,6 +283,7 @@ OS Drivers support several primary areas of functionality: Using the example above, we can query from the database using a statement like `select :title from /OMSS_DB/JNetHelp/rows`, which will open a sybase driver instance, then open a query and repeatedly fetch rows, getting the `title` attribute from each row. + ## II Interface This section describes the standard interface between the OSML and the ObjectSystem driver itself. Every driver should implement certain required functions. (**Note**: Many drivers "implement" some required functions to simply fail with a not implemented or not supported error. For example, most database drivers "implement" `Read()` and `Write()` this way because database content should be queried, not read). Various optional functions are also available, which a driver is not required to implement. @@ -243,16 +298,16 @@ This section describes the standard interface between the OSML and the ObjectSys The driver should implement an `Initialize()` function, as well as the following (* indicates required functions): | Function Name | Description | --------------------------------------------------------- | ------------ -| [Open](#function-open)* | Opens a new driver instance object on a given root node. -| [OpenChild](#function-openchild) | ??? +| [Open](#function-open)* | Opens a new driver instance object on a given node object. +| [OpenChild](#function-openchild) | Opens a single child object of the provided object by name. | [Close](#function-close)* | Close an open object created by either `Open()` or `QueryFetch()`. -| [Create](#function-create) | Create a new driver root node object. -| [Delete](#function-delete) | Delete an existing driver root node object. -| [DeleteObj](#function-deleteobj)* | ??? +| [Create](#function-create) | Create a new driver node object. (Not currently used because the OSML calls the driver Open with the `O_WRONLY \| O_CREAT \| O_EXCL` options instead. See [Open()](#function-open) below for more info.) +| [Delete](#function-delete) | Used for general object deletion. Drivers can implement `DeleteObj()` instead. +| [DeleteObj](#function-deleteobj)* | Replacement for `Delete()` which operates on an already-open object. | [OpenQuery](#function-openquery)** | Start a new query for child objects of a given object. | [QueryDelete](#function-querydelete) | Delete specific objects from a query's result set. | [QueryFetch](#function-queryfetch)** | Open the next child object in the query's result set. -| [QueryCreate](#function-querycreate) | ??? +| [QueryCreate](#function-querycreate) | Currently just a stub function that is not fully implemented. | [QueryClose](#function-queryclose)** | Close an open query. | [Read](#function-read)* | Read content from the object. | [Write](#function-write)* | Write content to the object. @@ -260,7 +315,7 @@ The driver should implement an `Initialize()` function, as well as the following | [GetAttrValue](#function-getattrvalue)* | Get the value of a given object's attribute. | [GetFirstAttr](#function-getfirstattr--getnextattr)* | Get the name of the object's first attribute. | [GetNextAttr](#function-getfirstattr--getnextattr)* | Get the name of the object's next attribute. -| [SetAttrValue](#function-setattrvalue) | Set the value of an object's attribute. +| [SetAttrValue](#function-setattrvalue)* | Set the value of an object's attribute. | [AddAttr](#function-addattr) | Add a new attribute to an object. | [OpenAttr](#function-openattr) | Open an attribute as if it were an object with content. | [GetFirstMethod](#function-getfirstmethod--getnextmethod) | Get the name of an object's first method. @@ -268,35 +323,37 @@ The driver should implement an `Initialize()` function, as well as the following | [ExecuteMethod](#function-executemethod) | Execute a method with a given name and optional parameter string. | [PresentationHints](#function-presentationhints) | Get info about an object's attributes. | [Info](#function-info)* | Get info about an object instance. -| [Commit](#function-commit) | Commit changes made to an object. -| [GetQueryCoverageMask](#function-getquerycoveragemask) | ??? -| [GetQueryIdentityPath](#function-getqueryidentitypath) | ??? +| [Commit](#function-commit) | Commit changes made to an object, ensuring that all modifications in the current transaction are completed and the transaction is closed before returning. +| [GetQueryCoverageMask](#function-getquerycoveragemask) | Should be left `NULL` outside the MultiQuery module. +| [GetQueryIdentityPath](#function-getqueryidentitypath) | Should be left `NULL` outside the MultiQuery module. _*Function is always required._ -_**Function is required to support queries._ +_**Function is always required, but can always return NULL if queries are not supported._ --- -### Abbreviative Prefix +### Abbreviation Prefix Each OS Driver will have an abbreviation prefix, such as `qy` for the query driver or `sydb` for the sybase database driver. This prefix should be prepended to the start of every public function name within the OS driver for consistency and scope management (e.g. `qyInitialize()`, `sydbQueryFetch()`, etc.). Normally, a driver's abbreviation prefix is two to four characters, all lowercase and may be the same as a file extension the driver supports. However, this is not an absolute requirement (see the cluster driver in `objdrv_cluster.c` which supports `.cluster` files using an abbreviation prefix of `cluster`). -This document uses `xxx` to refer to an unspecified abbreviative prefix. +This document uses `xxx` to refer to an unspecified abbreviation prefix. + +- 📖 **Note**: Once an abbreviation prefix has been selected, the driver author should add it to the [Prefixes.md](Prefixes.md) file. + ---- ### Internal Functions It is highly likely that driver authors will find shared functionality in the following functions, or wish to abstract out functionality from any of them for a variety of reasons. When creating additional internal functions in this way, they should be named using the convention of `xxx_internal_FunctionName()`, or possibly `xxxi_FunctionName()` for short. --- -### Function: Initialize +### Function: Initialize() ```c /*** @returns 0 if successful, or *** -1 if an error occurred. ***/ int xxxInitialize(void) ``` -- ⚠️ **Warning**: Currently, the success/failure of this function is ignored by the caller. -- 📖 **Note**: Unlike other functions defined in the driver, each driver author must manually add this call to the start up code, found in the `cxDriverInit()` function in `centrallix.c`. +- ⚠️ **Warning**: For compiled drivers, the success/failure of this function is ignored by the caller. However, for drivers loaded as modules, the return value is checked in order to determine whether to keep the module loaded. In either case, `mssError()` should be called for any failure (other than memory allocation failures). +- 📖 **Note**: Unlike other functions defined in the driver, each driver author must manually add this call to the start up code, found in the `cxDriverInit()` function in `centrallix.c`. The initialization function is called when the Centrallix starts up, and should register the driver with the OSML and initialize necessary global variables. It is recommended to place global variables in a single global 'struct' that is named with the driver's prefix in all uppercase. Global variables should **NOT** be accessed from outside the driver. Instead, the driver should define functions to access them, allowing it to abstract details away from other drivers. @@ -311,7 +368,7 @@ memset(drv, 0, sizeof(ObjDriver)); To initialize this struct, the driver must: - Provide a name (in `drv->Name`). -- Provide an array of supported root node types (in `drv->RootContentTypes`). +- Provide an array of supported root types (in `drv->RootContentTypes`). - Provide capability flags (in `drv->Capabilities`). - Provide function pointers to implemented functions (see [II Interface](#ii-interface) for a list). @@ -324,7 +381,7 @@ if (strcpy(drv->Name, "SYBD - Sybase Database Driver") == NULL) goto error_handl ``` #### RootContentTypes -The `RootContentTypes` field is an XArray containing a list of strings, representing the type names that the driver can open. This should only include types the driver will handle as root nodes, not other objects created by the driver. Thus, the sybase driver would include `"application/sybase"`, but not `"system/table"`. +The `RootContentTypes` field is an XArray containing a list of strings, representing the type names that the driver can open. This should only include types the driver will open as node objects at the root of its tree, not other objects created by the driver within that tree. Thus, the sybase driver would include `"application/sybase"`, but not `"system/table"`. For example: ```c @@ -338,8 +395,8 @@ if (xaAddItem(&(drv->RootContentTypes), ""system/query"") < 0) goto error_handli #### Capabilities The capabilities field is a bitmask which can contain zero or more of the following flags: -- `OBJDRV_C_FULLQUERY`: Indicates that this objectsystem driver will intelligently process the query's expression tree specified in the OpenQuery call, and will only return objects that match that expression. If this flag is missing, the OSML will filter objects returned by QueryFetch so that the calling user does not get objects that do not match the query. Typically this is set by database server drivers. - - > **THE ABOVE IS OUT-OF-DATE** (May 16th, 2022): A driver can now determine whether to handle the Where and OrderBy on a per-query basis, by setting values in the ObjQuery structure used when opening a new query. This allows a because a driver to handle Where and OrderBy for some object listings but not others. +- `OBJDRV_C_FULLQUERY`: Indicates that this objectsystem driver will intelligently process the query's expression tree specified in the `OpenQuery()` call, and will only return objects that match that expression. If this flag is missing, the OSML will filter objects returned by `QueryFetch()` so that the calling user does not get objects that do not match the query. Typically this is set by database server drivers. + - > **THE ABOVE IS OUT-OF-DATE** (May 16th, 2022): A driver can now determine whether to handle the `Where` and `OrderBy` on a per-query basis, by setting values in the ObjQuery structure used when opening a new query. This allows a driver to handle `Where` and `OrderBy` selectively for some object listings but not others. - `OBJDRV_C_TRANS`: Indicates that this objectsystem driver requires transaction management by the OSML's transaction layer (the OXT layer). OS drivers that require this normally are those that for some reason cannot complete operations in independence from one another. For example, with a database driver, the creation of a new row object and the setting of its attributes must be done as one operation, although the operation requires several calls from the end user's process. The OXT allows for the grouping of objectsystem calls so that the os driver does not have to complete them independently, but instead can wait until several calls have been made before actually completing the operation. @@ -360,64 +417,63 @@ void* xxxOpen(pObject parent, int mask, pContentType sys_type, char* usr_type, p The `Open()` function opens a given file to create a new driver instance. This procedure normally includes the following steps: 1. Access or create the node object, depending on specified flags and whether or not it already exists. -2. Parse additional contents of the path after the root node. +2. Parse additional contents of the path after the driver node object. 3. Allocate a structure that will represent the open object, including a pointer to the node object. 4. Perform other opening operations (such as reading database table information, etc., when a db table's row is being accessed). 5. Return a pointer to the node instance as a void pointer. This pointer will be passed as `void* inf_v` to the driver in subsequent calls involving this object (except the Query functions, discussed below). -- 📖 **Note - Transactions**: If the os driver specified the `OBJDRV_C_TRANS` capability, it must respect the current state of the user's transaction. If a new object is being created, an object is being deleted, or other modifications/additions are being performed, and if the OXT layer indicates a transaction is in process, the driver must either complete the current transaction and then complete the current call, or else add the current delete/create/modify call to the transaction tree (in which case the tree item is preallocated; all the driver needs to do is fill it in). This is handled using the transaction tree parameter (`oxt : pObjTrxTree*`). The transaction later is discussed in depth in the ??? section. - - +- 📖 **Note - Transactions**: If the os driver specified the `OBJDRV_C_TRANS` capability, it must respect the current state of the user's transaction. If a new object is being created, an object is being deleted, or other modifications/additions are being performed, and if the OXT layer indicates a transaction is in process, the driver must either complete the current transaction and then complete the current call, or else add the current delete/create/modify call to the transaction tree (in which case the tree item is preallocated; all the driver needs to do is fill it in). This is handled using the transaction tree parameter (`oxt : pObjTrxTree*`). #### Accessing the Node Object If `O_CREAT` and `O_EXCL` are both specified in `parent->Mode`, the driver should **only** create a new file and fail if the file already exists (refusing to open and read it). Otherwise, the driver should read an existing file, or create one if it does not exist and `O_CREAT` is specified, failing if no file can be read or created. #### Parsing Path Contents -The task of parsing the provided path into the subtree beneath its root node is one of the more complex operations for a driver. For example, the path to a driver's root node might be `/datasources/OMSS_DB` and the user opens an object called `/datasources/OMSS_DB/JNetHelp/rows/1`. In this case, the OS driver must parse the meaning of the subtree path `JNetHelp/rows/1`, storing the data targetted by the user into the driver instance to allow later method calls to access the correct data. +The task of parsing the provided path into the subtree beneath its node object is one of the more complex operations for a driver. For example, the path to a driver's node object might be `/datasources/Kardia_DB` and the user opens an object called `/datasources/Kardia_DB/p_partner/rows/1`. In this case, the OS driver must parse the meaning of the subtree path `p_partner/rows/1`, storing the data targetted by the user into the driver instance to allow later method calls to access the correct data. #### Parameters The `Open()` routine is called with five parameters: -- `obj : pObject`: A pointer to the Object structure maintained by the OSML. This structure includes some useful fields: +- `parent : pObject`: A pointer to the Object structure maintained by the OSML. This structure includes some useful fields: - - `obj->Mode : int`: A bitmask of the O_* flags, which include: `O_RDONLY` (read only), `O_WRONLY` (write only), `O_RDWR` (read/write), `O_CREAT` (create), `O_TRUNC` (truncate), and `O_EXCL` (exclusive, see above). + - `parent->Mode : int`: A bitmask of the OBJ_O_* flags, which include: `OBJ_O_RDONLY` (read only), `OBJ_O_WRONLY` (write only), `OBJ_O_RDWR` (read/write), `OBJ_O_CREAT` (create), `OBJ_O_TRUNC` (truncate), and `OBJ_O_EXCL` (exclusive, see above). - - `obj->Pathname : pPathname`: A pointer to a Pathname struct (defined in `include/obj.h`) which contains the complete parsed pathname for the object. This provides a buffer for the pathname as well as an array of pointers to the pathname's components. The function `obj_internal_PathPart()` can be used to obtain at will any component or series of components of the pathname. + - `parent->Pathname : pPathname`: A pointer to a Pathname struct (defined in `include/obj.h`) which contains the complete parsed pathname for the object. This provides a buffer for the pathname as well as an array of pointers to the pathname's components. The function `obj_internal_PathPart()` can be used to obtain at will any component or series of components of the pathname. - - `obj->Pathname->OpenCtl : pStruct[]`: Parameters for the open() operation, as defined by the driver author. These are specified in the path in a similar way to URLs (`example.qy?param1=value¶m2=other_value`). Drivers typically only use `obj->Pathname->OpenCtl[obj->SubPtr]` (see SubPtr below) to retrieve their own parameters, ignoring parameters passed to other drivers in the path. + - `parent->Pathname->OpenCtl : pStruct[]`: Parameters for the open() operation, as defined by the driver author. These are specified in the path in a similar way to URLs (`example.qy?param1=value¶m2=other_value`). Drivers typically only use `parent->Pathname->OpenCtl[parent->SubPtr]` (see SubPtr below) to retrieve their own parameters, ignoring parameters passed to other drivers in the path. - - `obj->SubPtr : short`: The number of components in the path that are a part of the path to the root node object, including the `.` for the top level directory. For example, in the above path of `/data/file.csv`, the path would be internally represented as `./ data/ file.csv`, so SubPtr is 3. + - `parent->SubPtr : short`: The number of components in the path that are a part of the path to the driver's node object, including the `.` for the top level directory and the driver's node object. For example, in the above path of `/data/file.csv`, the path would be internally represented as `./ data/ file.csv`, so SubPtr is 3. + + - For example, use `obj_internal_PathPart(parent->Pathname, parent->SubPtr - 1, 1)` to get the name of the file being openned, and use `obj_internal_PathPart(parent->Pathname, 0, parent->SubPtr)` to get the path. - - `obj->SubCnt : short`: _The driver should set this value_ to show the number of components it controls. This includes the root node object, so `SubCnt` will always be at least 1. For example, when opening `/data/file.csv/rows/1`, the CSV driver will read the `SubPtr` of 3 (see above), representing `./ data/ file.csv`. It will then set a `SubCnt` of 3, representing that it will control `file.csv /rows /1`. (The driver only sets `SubCnt`, `SubPtr` is provided.) + - `parent->SubCnt : short`: _The driver should set this value_ to show the number of components it controls. This includes the driver's node object, so `SubCnt` will always be at least 1. For example, when opening `/data/file.csv/rows/1`, the CSV driver will read the `SubPtr` of 3 (see above), representing `./ data/ file.csv`. It will then set a `SubCnt` of 3, representing that it controls `file.csv /rows /1`. (The driver only sets `SubCnt`; `SubPtr` is provided.) - - `obj->Prev : pObject`: The underlying object as opened by the next-lower-level driver. The file can be accessed and parsed by calling functions and passing this pointer to them (such as the st_parse functions, see below). **DO NOT attempt to open the file directly with a call like `fopen()`,** as this would require hard coding the path to the root directory of the object system, which *will* break if the code runs on another machine. + - `parent->Prev : pObject`: The underlying object as opened by the next-lower-level driver. The file can be accessed and parsed by calling functions and passing this pointer to them (such as the st_parse functions, see below). **DO NOT attempt to open the file directly with a call like `fopen()`,** as this would require hard coding the path to the root directory of the object system, which *will* break if the code runs on another machine. - - `obj->Prev->Flags : short`: Contains some useful flags about the underlying object, such as: - - `OBJ_F_CREATED`: The underlying object was just created by this open() operation. In that case, this driver is expected to create the node with `snNewNode()` (see later in this document) as long as `obj->Mode` contains `O_CREAT`. - + - `parent->Prev->Flags : short`: Contains some useful flags about the underlying object, such as: + - `OBJ_F_CREATED`: The underlying object was just created by this open() operation. In that case, this driver is expected to create the node with `snNewNode()` (see later in this document) as long as `parent->Mode` contains `O_CREAT`. - `mask : int`: The permission mask to be given to the object, if it is being created. Typically, this will only apply to files and directories, so most drivers can ignore it. The values are the same as the UNIX [octal digit permissions](https://en.wikipedia.org/wiki/Chmod#:~:text=Octal%20digit%20permission) used for the `chmod()` command. -- `sys_type : pContentType`: Indicates the content type of the node object as determined by the OSML. The ContentType structure is defined in `include/obj.h`. `sys_type->Name` lists the name of the content type (e.g. `"system/query"` for the query driver). - +- `sys_type : pContentType`: Indicates the content type of the node object as determined by the OSML. The ContentType structure is defined in `include/obj.h`. `sys_type->Name` lists the name of the content type (e.g. `"system/query"` for the query driver). This is also the type used to select which driver should open the node object, so it will be one of the types registered in the `Initialize()` function. - `usr_type : char*`: The object type requested by the user. This is normally used when creating a new object, though some drivers also use it when opening an existing object. For example, the reporting driver generates HTML report text or plaintext reports if `usr_type` is `"text/html"` or `"text/plain"` (respectively). - `oxt : pObjTrxTree*`: The transaction tree, used when the driver specifies the `OBJDRV_C_TRANS` capability. More on this field later. Non-transaction-aware drivers can safely ignore this field. - - 📖 **Note**: Yes, this param *is* a pointer to a pointer. Essentially, a pointer passed by reference. + + - 📖 **Note**: Yes, this param *is* a pointer to a pointer. Essentially, a pointer passed by reference. This allows the driver to create a new transaction tree even if none is in progress. The `Open()` routine should return a pointer to an internal driver structure on success, or `NULL` on failure. It is normal to allocate one such structure per `Open()` call, and for one of the structure fields to point to shared data describing the node object. Accessing the node object is described later in this document. While driver instance structures may vary, some fields are common in most drivers (`inf` is the pointer to the structure here): -| Field | Type | Description -| ---------- | --------- | ------------ -| inf->Obj | pObject | A copy of the `obj` pointer passed to `Open()`. -| inf->Mask | int | The `mask` argument passed to `Open()`. -| inf->Node | pSnNode | A pointer to the node object. This can come from `snNewNode()` or `snReadNode()` (for structure files), or other node struct information. +| Field | Type | Description | +|-----------|---------|-------------------------------------------------| +| inf->Obj | pObject | A copy of the `obj` pointer passed to `Open()`. | +| inf->Mask | int | The `mask` argument passed to `Open()`. | +| inf->Node | pSnNode | A pointer to the node object. | +The driver's node pointer typically comes from `snNewNode()` or `snReadNode()` (for structure files), but it can also be other node struct information. --- ### Function: OpenChild() @@ -425,7 +481,25 @@ While driver instance structures may vary, some fields are common in most driver ```c void* xxxOpenChild(void* inf_v, pObject obj, char* child_name, int mask, pContentType sys_type, char* usr_type, pObjTrxTree* oxt); ``` -**No documentation provided.** +Opens a single child object of the provided object by name. Conceptually, this is similar to querying the object for all children where the name attribute equals the passed `child_name` parameter and fetching only the first result. This function is used to open children of a driver that do not map well into the driver's node object tree. For example, the query file driver uses this function to allow the caller to open a temporary collection declared in that query file. + +The `OpenChild()` function is called with two parameters: + +| Param | Type | Description | +|------------|--------------|---------------------------------------------------------------------------| +| inf_v | void* | A driver instance pointer (returned from `Open()` or `QueryFetch()`). | +| obj | pObject | An object? | +| child_name | char* | The value for the name attribute of the child object to be openned. | +| mask | int | The permission mask to be given to the object (if created).* | +| sys_type | pContentType | Indicates the content type of the node object as determined by the OSML.* | +| usr_type | char* | The object type requested by the user.* | +| oxt | pObjTrxTree* | The transaction tree pointer for the `OBJDRV_C_TRANS` capability. | + + + +*See [`Open()`](#function-open) above for more info. + +The `OpenChild()` function should a pointer to the node object for the newly openned child on success or `NULL` on failure. --- ### Function: Close() @@ -440,14 +514,14 @@ The close function closes a driver instance, freeing all allocated data and rele - 📖 **Note**: Information may be left unfreed if it is stored in a cache for later use. -The `Close()` routine is called with two parameters: +The `Close()` function is called with two parameters: -| Param | Type | Description -| ------ | ------------ | ------------ -| inf_v | void* | A driver instance pointer (returned from `Open()` or `QueryFetch()`). -| oxt | pObjTrxTree* | The transaction tree pointer for the `OBJDRV_C_TRANS` capability. +| Param | Type | Description | +|-------|--------------|-----------------------------------------------------------------------| +| inf_v | void* | A driver instance pointer (returned from `Open()` or `QueryFetch()`). | +| oxt | pObjTrxTree* | The transaction tree pointer for the `OBJDRV_C_TRANS` capability. | -The Close routine should return 0 on success or -1 on failure. +The `Close()` function should return 0 on success or -1 on failure. ### Function: Create() @@ -465,12 +539,12 @@ int clusterDelete(pObject obj, pObjTrxTree* oxt); ``` The `Delete()` function is used to delete an object, which often means removing a file from the file system. The Delete routine is passed the following parameters: -| Param | Type | Description -| ------ | ------------- | ------------ -| obj | pObject | The Object structure pointer, used in the same way as in Open and Delete. -| oxt | pObjTrxTree* | The transaction tree pointer for the `OBJDRV_C_TRANS` capability. +| Param | Type | Description | +|-------|--------------|---------------------------------------------------------------------------| +| obj | pObject | The Object structure pointer, used in the same way as in Open and Delete. | +| oxt | pObjTrxTree* | The transaction tree pointer for the `OBJDRV_C_TRANS` capability. | -Delete should return 0 on success and -1 on failure. +`Delete()` should return 0 on success and -1 on failure. ### Function: DeleteObj() @@ -490,19 +564,21 @@ The `Read()` function reads content from objects that have content, similar to r The parameters passed are intentionally similar to the `fdRead()` function in `mtask.c`: -| Parameter | Type | Description -| --------- | ------------- | ------------ -| inf_v | void* | A driver instance pointer (returned from `Open()` or `QueryFetch()`). -| buffer | char* | The buffer where read data should be stored. -| max_cnt | int | The maximum number of bytes to read into the buffer. -| flags | int | Either `0` or `FD_U_SEEK`. If `FD_U_SEEK` is specified, the caller should specify a seek offset in the 5th argument (`arg`). -| arg | int | Extra argument, currently only used to specify the optional seek offset. -| oxt | pObjTrxTree* | The transaction tree pointer for the `OBJDRV_C_TRANS` capability. +| Parameter | Type | Description | +|-----------|--------------|------------------------------------------------------------------------------------------------------------------------------| +| inf_v | void* | A driver instance pointer (returned from `Open()` or `QueryFetch()`). | +| buffer | char* | The buffer where read data should be stored. | +| max_cnt | int | The maximum number of bytes to read into the buffer. | +| offset | int | An optional seek offset. | +| flags | int | Either `0` or `FD_U_SEEK`. If `FD_U_SEEK` is specified, the caller should specify a seek offset in the 5th argument (`arg`). | +| oxt | pObjTrxTree* | The transaction tree pointer for the `OBJDRV_C_TRANS` capability. | - 📖 **Note**: Not all objects can be seekable and some of the objects handled by the driver may have limited seek functionality, even if others do not. Each of these routines should return -1 on failure and return the number of bytes read/written on success. At end of file or on device hangup, 0 should be returned once, and then subsequent calls should return -1. +- 📖 **Note**: There is no separate seek command to help mitigate [Time-of-check to time-of-use attacks](https://en.wikipedia.org/wiki/Time-of-check_to_time-of-use). To seek without reading data, specify a buffer size of zero. + ### Function: Write() ```c @@ -519,11 +595,12 @@ void* xxxOpenQuery(void* inf_v, pObjQuery query, pObjTrxTree* oxt); The `OpenQuery()` function opens a new query instance struct for fetching query results from a specific driver instance. Queries are often used to enumerate an object's child objects, although this is not a requirement. Queries may include specific criteria, and the driver may decide to intelligently handle them (either manually or, more often, by passing them on to a lower level driver or database) or simply to enumerating all results with its query functions. In the latter case, the OSML layer will filter results and only return objects that match the criteria to the user. `OpenQuery()` is passed three parameters: -| Parameter | Type | Description -| --------- | ------------- | ------------ -| inf_v | void* | A driver instance pointer (returned from `Open()` or `QueryFetch()`). -| query | pObjQuery | A query structure created by the object system. -| oxt | pObjTrxTree* | The transaction tree pointer for the `OBJDRV_C_TRANS` capability. + +| Parameter | Type | Description | +|-----------|--------------|-----------------------------------------------------------------------| +| inf_v | void* | A driver instance pointer (returned from `Open()` or `QueryFetch()`). | +| query | pObjQuery | A query structure created by the object system. | +| oxt | pObjTrxTree* | The transaction tree pointer for the `OBJDRV_C_TRANS` capability. | The `query : pObjQuery` parameter contains several useful fields: | Parameter | Type | Description @@ -533,7 +610,7 @@ The `query : pObjQuery` parameter contains several useful fields: | query->SortBy[] | void*[] (pExpression[]) | An array of expressions giving the various components of the sorting criteria. | query->Flags | int | The driver should set and/or clear the `OBJ_QY_F_FULLQUERY` and `OBJ_QY_F_FULLSORT` flags, if needed. -The `OBJ_QY_F_FULLQUERY` flag indicates that the driver will handle the full WHERE clause specified in `query->Tree`. +The `OBJ_QY_F_FULLQUERY` flag indicates that the driver will handle the full `where` clause specified in `query->Tree`. Even if this flag is not specified, the driver is still free to use the provided `where` clause to pre-filter data, which improves performance when the Object System does its final filtering. However, setting this flag disables the Object System filtering because it promises that the driver will _always_ handle _all_ filtering for _every_ valid queries. The `OBJ_QY_F_FULLSORT` flag indicates that the driver will handle all sorting for the data specified in `query->SortBy[]`. @@ -547,7 +624,6 @@ The `OpenQuery()` function returns a `void*` for the query instance struct, whic ```c int xxxQueryDelete(void* qy_v, pObjTrxTree* oxt); ``` - Deletes results in the query result set, optionally matching a certain criteria. `QueryDelete()` is passed two parameters: | Parameter | Type | Description @@ -581,30 +657,29 @@ The driver should add an element to the `obj->Pathname` structure to indicate th - `qy->Parent->Obj->Pathname : pPathname` points to the affected Pathname struct. ```c - int count; - pObject obj; - char* new_name; - pMyDriversQueryInf qy; +int count; +pObject obj; +char* new_name; +pMyDriversQueryInf qy; - /** Build the new filename. **/ - count = snprintf(obj->Pathname->Pathbuf, 256, "%s/%s", qy->Parent->Obj->Pathname->Pathbuf, new_name); - if (count < 0 || 256 <= count) return NULL; - obj->Pathname->Elements[obj->Pathname->nElements++] = strrchr(obj->Pathname->Pathbuf, '/') + 1; +/** Build the new filename. **/ +count = snprintf(obj->Pathname->Pathbuf, 256, "%s/%s", qy->Parent->Obj->Pathname->Pathbuf, new_name); +if (count < 0 || 256 <= count) goto error_handling; +obj->Pathname->Elements[obj->Pathname->nElements++] = strrchr(obj->Pathname->Pathbuf, '/') + 1; ``` ### Function: QueryCreate() ```c void* xxxQueryCreate(void* qy_v, pObject new_obj, char* name, int mode, int permission_mask, pObjTrxTree *oxt); ``` - -**No documentation provided.** +The `QueryCreate()` function is just a stub function that is not fully implemented yet. Simply not providing it (aka. setting the location in the driver initialization struct to `NULL`) is fine. ### Function: QueryClose() ```c int xxxQueryClose(void* qy_v, pObjTrxTree* oxt); ``` -The close function closes a query instance, freeing all allocated data and releasing all shared memory such as open connections, files, or other driver instances. This function operates very similarly to `Close()`, documented in detail above. The query should be closed, whether or not `QueryFetch()` has been called enough times to enumerate all of the query results. +The `QueryClose()` function closes a query instance, freeing all allocated data and releasing all shared memory such as open connections, files, or other driver instances. This function operates very similarly to `Close()`, documented in detail above. The query should be closed, whether or not `QueryFetch()` has been called enough times to enumerate all of the query results. ### Object Attributes @@ -628,11 +703,11 @@ The following five attributes are required (all are of type `DATA_T_STRING`): | Attribute | Description | ------------ | ------------ -| name | The name of the object, just as it appears in any directory listing. The name of the object must always be unique for its directory. -| annotation | A short description of the object. While users may not assign annotations to all objects, each object should be able to have an annotation. For example, in the Sybase driver, annotations for rows are created by assigning an 'expression' to the table in question, such as `first_name + last_name` for a people table. -| content_type | The type of the object's content, given as a MIME-type. Specify `"system/void"` if the object does not have content. +| name | The name of the object, just as it appears in any directory listing. The name of the object must always be unique for its level in the tree (e.g. a unique file name in a directory, the primary key of a database row, etc.). +| annotation | A short description of the object. While users may not assign annotations to all objects, each object should be able to have an annotation. For example, in the Sybase driver, annotations for rows are created by assigning an 'expression' to the table in question, such as `first_name + last_name` for a people table. This attribute should _never_ be null, however, it can be an empty string (`""`) if the driver has no meaningful way to provide an annotation. +| content_type | The type of the object's content, given as a MIME-type. Specify `"system/void"` if the object does not have content. | inner_type | An alias for 'content_type'. Both should be supported. -| outer_type | This is the type of the object itself (the container). Specify `"system/row"` for objects that can be queried. +| outer_type | This is the type of the object itself (the container). The `last_modification : DATA_T_DATETIME` attribute is a sixth, optional attribute that may be useful in some situations. This attribute should indicate the last time that the object's content was modified or updated. @@ -669,22 +744,35 @@ The `GetAttrValue()` function takes four parameters: | --------- | ------------- | ------------ | inf_v | void* | A driver instance pointer (returned from `Open()` or `QueryFetch()`). | attr_name | char* | The name of the attribute to be queried. +| datatype | int | The expected datatype for the requested value. | val | pObjData | A pointer to a location where the value of the attribute should be stored. | oxt | pObjTrxTree* | The transaction tree pointer for the `OBJDRV_C_TRANS` capability. -The value pointer should be handled in different ways, depending on the type: -- For `DATA_T_INTEGER` types, it is assumed to point to a 32-bit integer where the value should be written. -- For `DATA_T_STRING` types, it is assumed to point to an empty `char*` location where a pointer to a string should be written. -- For `DATA_T_DOUBLE` types, it is assumed to point to a double value where the double should be written. -- For `DATA_T_DATETIME` types, it is assumed to point to an empty `pDateTime` where a pointer to a date time struct (see `obj.h`) should be written. +The value pointer points to a union struct which can hold one of several types of data in the same memory location. Which type of data is expected depends on the value of the `datatype` parameter. +| Field | Datatype | Description +| ----------- | ------------------ | ----------- +| `Integer` | `DATA_T_INTEGER` | An int where the value should be written. +| `String` | `DATA_T_STRING` | A `char*` where a pointer to the string should be written. +| `Double` | `DATA_T_DOUBLE` | A double where the double should be written. +| `DateTime` | `DATA_T_DATETIME` | A `pDateTime` where a pointer to the `DateTime` struct (see [`datatypes.h`](../centrallix/include/datatypes.h)) should be written. +| `IntVec` | `DATA_T_INTVEC` | A `pIntVec` where a pointer to the `IntVec` struct (see [`datatypes.h`](../centrallix/include/datatypes.h)) should be written. +| `StringVec` | `DATA_T_STRINGVEC` | A `pStringVec` where a pointer to the `StringVec` struct (see [`datatypes.h`](../centrallix/include/datatypes.h)) should be written. +| `Money` | `DATA_T_MONEY` | A `pMoneyType` where a pointer to the `MoneyType` struct (see [`datatypes.h`](../centrallix/include/datatypes.h)) should be written. +| `Generic` | ? | A `void*` to somewhere where something should be written should be written (usually implementation dependant). -In this way, integer and double values are returned by value, and string or datetime values are returned by reference. Items returned by reference are guaranteed to be valid until either the object is closed, or another call to `GetAttrValue()` or `SetAttrValue()` call is made on the same driver (which ever happens first). +In this way, `int`s and `double`s can be returned by value while other types are returned by reference. Items returned by reference must be guaranteed to be valid until either the object is closed, or another `GetAttrValue()` or `SetAttrValue()` call is made on the same driver (which ever happens first). -This function should return -1 on a non-existent attribute, 0 on success, and 1 if the value is `NULL` or undefined / unset. +This function should return 0 on success, 1 if the value is `NULL` or undefined / unset, or -1 on a non-existent attribute or other error. -- 📖 **Note**: The caller of this function can use the POD(x) macro to typecast appropriate pointers to the pObjData pointer, passed to this function. The ObjData structure is a UNION type of structure, allowing easy manipulation of data of various types. See `datatypes.h` for more information. +- 📖 **Note**: The caller can use the `POD(x)` macro to typecast appropriate pointers to the `pObjData` pointer. For example: + ```c + char* name; + if (xxxGetAttrValue(obj, "name", DATA_T_STRING, POD(&name)) != 0) + goto error_handling; + printf("Object name: \"%s\"\n", name); + ``` -- 📖 **Note**: In legacy code, a typecasted void* was used instead of a pObjData pointer used today. This method was binary compatible the current solution because the pObjData is a pointer to a struct union. See `datatypes.h` for more information. +- 📖 **Note**: In legacy code, a typecasted `void*` was used instead of a `pObjData` pointer used today. This method was binary compatible the current solution because of the union struct implementation (See [`datatypes.h`](../centrallix/include/datatypes.h) for more information). ### Function: SetAttrValue() @@ -781,22 +869,21 @@ The return value, `hints : ObjPresentationHints`, contains the following useful - `hints->MaxValue : void*`: An expression defining the maximum valid value. - `hints->EnumList : XArray`: If the attribute is a string enum, this XArray lists the valid string values. - `hints->EnumQuery : char*`: A query string which enumerates the valid values a string enum attribute. -- `hints->Format : char*`: presentation format - datetime or money +- `hints->Format : char*`: A presentation format for datetime or money types, such as `"dd MMM yyyy HH:mm"` or `"$0.00"`. See `obj_datatypes.c` (near line 100) for more information creating a presentation format. - `hints->AllowChars : char*`: An array of all valid characters for a string attribute, NULL to allow all characters. -- `hints->BadChars : char*`: An array of all invalid characters for a string attribute. +- `hints->BadChars : char*`: An array of all invalid characters for a string attribute. If a character appears in both `hints->BadChars` and `hints->AllowChars`, the character should be rejected. - `hints->Length : int`: The maximum length of data that can be included in a string attribute. - `hints->VisualLength : int`: The length that the attribute should be displayed if it is show to the user. - `hints->VisualLength2 : int`: The number of lines to use in a multi-line edit box for the attribute. -- `hints->BitmaskRO : unsigned int`: which bits, if any, in bitmask are read-only +- `hints->BitmaskRO : unsigned int`: If the value is an integer that represents a bit mask, _this_ bit mask shows which bits of that bitmask are read-only. - `hints->Style : int`: Style flags, documented below. - `hints->StyleMask : int`: A mask for which style flags were set and which were left unset / undefined. - `hints->GroupID : int`: Used to assign attributes to groups. Use -1 if the attribute is not in a group. - `hints->GroupName : char*`: The name of the group to which this attribute belongs, or NULL if it is ungrouped or if the group is named elsewhere. - `hints->OrderID : int`: Used to specify an attribute order. -- `hints->FriendlyName : char*`: Used to specify a "display name" for an attribute (e.g. `n_rows` might have a friendly name of `"Number of Rows"`). Should be `nmSysMalloc()`ed, often using `nmSysStrdup()`. +- `hints->FriendlyName : char*`: Used to specify a "display name" for an attribute (e.g. `n_rows` might have a friendly name of `"Number of Rows"`). Should be [`nmSysMalloc()`](#nmsysmalloc)ed, often using [`nmSysStrdup()`](#nmsysstrdup). - ⚠️ **Warning**: Behavior is undefined if: - - If a character is included in both `hints->AllowChars` and `hints->BadChars`. - The data is longer than length. The `hints->Style` field can be set with several useful flags. To specify that a flag is not set (e.g. to specify explicitly that a field does allow `NULL`s), set the coresponding bit in the `hints->StyleMask` field while leaving the the bit in the `hints->Style` field set to 0. @@ -819,7 +906,7 @@ The following macros are provided for setting style flags: - `OBJ_PH_STYLE_SEPWINDOW`: Prefer separate windows for grouped fields. - `OBJ_PH_STYLE_ALWAYSDEF`: Always reset the default value when this attribute is modified. - `OBJ_PH_STYLE_CREATEONLY`: This attribute is writeable only when created, after that it is read only. -- `OBJ_PH_STYLE_MULTISEL`: Multiple select +- `OBJ_PH_STYLE_MULTISEL`: This enum attribute can accept more than one value from the list of valid values. Think of using checkboxes instead of radio buttons (although the flag does requirement this UI decision). - `OBJ_PH_STYLE_KEY`: This attribute is a primary key. - `OBJ_PH_STYLE_APPLYCHG`: Presentation hints should be applied on DataChange instead of on DataModify. @@ -845,13 +932,9 @@ The `pObjectInfo` struct has two fields: `Flags` and `nSubobjects`. This functi - `OBJ_INFO_F_CAN_SEEK_REWIND`: Seeking is only supported with an offset of `0`. - `OBJ_INFO_F_CANT_SEEK`: Seeking is not supported at all. - `OBJ_INFO_F_CAN_ADD_ATTR` / `OBJ_INFO_F_CANT_ADD_ATTR`: Indicates that the object does or does not allow attributes to be added with the [AddAttr()](#function-addattr) function. -- `OBJ_INFO_F_SUPPORTS_INHERITANCE`: Indicates that the object supports inheritance through attributes such as `cx__inherit`. See ??? for more information about object inheritance. - - +- `OBJ_INFO_F_SUPPORTS_INHERITANCE`: Indicates that the object supports inheritance through attributes such as `cx__inherit`. - `OBJ_INFO_F_FORCED_LEAF`: Indicates that the object is forced to be a 'leaf' unless ls__type used. -- `OBJ_INFO_F_TEMPORARY`: Indicates that this is a temporary object without a vaoid pathname. - - +- `OBJ_INFO_F_TEMPORARY`: Indicates that this is a temporary object without a valid pathname. The function returns 0 on success, and -1 to indicate an error, in which case `mssError()` should be called before returning. @@ -860,21 +943,30 @@ The function returns 0 on success, and -1 to indicate an error, in which case `m ```c int xxxCommit(void* inf_v, pObjTrxTree *oxt); ``` -**No documentation provided.** +The `Commit()` function immediately completes the current transaction, ensuring that all writes are applied to the affected data before returning. For example, if the current transaction involves creating a database row, this call will ensure that the row is created and the transaction is closed before returning. This allows the caller to ensure that actions in a transaction have been completed without needing to close the object, which they may wish to continue using. + +The `Commit()` function takes two parameters: + +| Parameter | Type | Description +| --------- | ------------- | ------------ +| inf_v | void* | A driver instance pointer (returned from `Open()` or `QueryFetch()`). +| oxt | pObjTrxTree* | The transaction tree pointer for the `OBJDRV_C_TRANS` capability. + +The function returns 0 on success, and -1 to indicate an error, in which case `mssError()` should be called before returning. ### Function: GetQueryCoverageMask() ```c int xxxGetQueryCoverageMask(pObjQuery this); ``` -**No documentation provided.** +This function is only intended to be used by the MultiQuery module. Any other driver should not provide this function by setting the appropriate struct field to `NULL`. ### Function: GetQueryIdentityPath() ```c int xxxGetQueryIdentityPath(pObjQuery this, char* pathbuf, int maxlen); ``` -**No documentation provided.** +This function is only intended to be used by the MultiQuery module. Any other driver should not provide this function by setting the appropriate struct field to `NULL`. @@ -883,7 +975,7 @@ A driver will commonly configure itself by reading text content from its node ob - 📖 **Note**: The node object will **already be open** as an object in the ObjectSystem: The OSML does this for each driver. If a driver does not use the SN/ST modules, then it should read and write the node object directly with `objRead()` and `objWrite()`. A driver should **NEVER** `objClose()` the node object! The OSML handles that. -Although using the structure file format may be complex, it allows significant flexibility. Data is structured in hierarchies where each sub-object can have named attributes as well as sub-objects. Centrallix is filled with examples of this, including any `.qy`, `.app`, `.cmp`, or `.cluster` file. +Although using the structure file format may be complex, it allows significant flexibility, as well as greater consistency across drivers. The use of this shared syntax across different drivers makes learning to use a new driver far easier than it would be if they all used unique, custom syntax for specifying properties. In the structure file syntax, data is structured in hierarchies where each sub-object can have named attributes as well as sub-objects. Centrallix has many examples of this, including any `.qy`, `.app`, `.cmp`, or `.cluster` file. Structure files are accessed via the st_node (SN) and stparse (SP) modules. The st_node module loads and saves the structure file heirarchies as a whole. It also manages caching to reduce disk activity and eliminate repeated parsing of the same file. The stparse module provides access to the individual attributes and groups of attributes within a node structure file. @@ -899,7 +991,7 @@ To obtain node object data, the driver should first open the node object with th ```c pSnNode snReadNode(pObject obj); ``` -The `snReadNode()` function reads a Structure File from the `obj` parameter, which should be a previously openned object. In a driver's `Open()` function, this is `obj->Prev` (the node object as opened by the previous driver in the OSML's chain of drivers). +The `snReadNode()` function reads a Structure File from the `obj` parameter, which should be a previously opened object. In a driver's `Open()` function, this is `obj->Prev` (the node object as opened by the previous driver in the OSML's chain of drivers). **Usage:** ```c @@ -974,7 +1066,7 @@ int stStructType(pStructInf this); ``` The `stStructType()` function returns the struct type of the past `pStructInf` parameter, which is either `ST_T_ATTRIB` or `ST_T_SUBGROUP` (see above). -- ⚠️ **Warning**: The root node of type `ST_T_STRUCT` will return `ST_T_SUBGROUP` from this function. If you wish to avoid this, read `inf->Type` (see [stparse: Using Fields Directly](#stparse-using-fields-directly) for more info). It is unclear whether this behavior is a bug or a feature. I've decided to call it a feature! ;) +- ⚠️ **Warning**: The node object root of type `ST_T_STRUCT` will return `ST_T_SUBGROUP` from this function. In most cases, treating this node as ust another subgroup simplifies logic for the caller. However, if you wish to avoid this behavior, read `inf->Type` (see [stparse: Using Fields Directly](#stparse-using-fields-directly) for more info). ### stparse: stLookup() @@ -1034,13 +1126,13 @@ This function adds a node of type `ST_T_SUBGROUP` to either an `ST_T_SUBGROUP` o ```c int stAddValue(pStructInf inf, char* strval, int intval); ``` -This function adds a value to an attribute, and can be called multiple times on an attribute to add a list of values. If `strval` is not null, a string value is added, otherwise an integer value is added. The string is NOT copied, but is simply pointed-to. If the string is non-static, and has a lifetime less than the `ST_T_ATTRIB` tree node, then the following procedure should be used, where `str` is the string pointer to the string: +This function adds a value to an attribute, and can be called multiple times on an attribute to add a list of values. If `strval` is not null, a string value is added, otherwise an integer value is added. The string is NOT copied, but is simply pointed-to. If the string is non-static, and has a lifetime less than the `ST_T_ATTRIB` tree node, then the following procedure should be used to allocate a new string which will have the correct lifetime: (In this example, `str` is the string pointer to the string.) ```c pStructInf attr_inf = stAddAttr(my_parent_inf, "my_attr"); if (attr_inf == NULL) goto error_handling; -char* new_str = (char*)malloc(strlen(str) + 1lu); +char* new_str = (char*)nmSysMalloc(strlen(str) + 1lu); if (new_str == NULL) goto error_handling; strcpy(new_str, str); stAddValue(attr_inf, new_str, 0); @@ -1049,6 +1141,7 @@ attr_inf->StrAlloc[0] = 1; With this method (making a copy of the string and then setting the StrAlloc value for that string), the string is automatically freed when the StructInf tree node is freed by the stparse module. + ### stparse: stFreeInf() ```c @@ -1082,18 +1175,17 @@ for (unsigned int i = 0u; i < inf->nSubInf; i++) ## IV Memory Management in Centrallix - -Centrallix has its own memory management wrapper that caches deallocated blocks of memory by size to allow for faster reuse. This wrapper also detects double-freeing of blocks (sometimes), making debugging of memory problems just a little bit easier. +Centrallix has its own memory management wrapper that caches deallocated blocks of memory by size for faster reuse. This wrapper also detects double-freeing of blocks (sometimes), making debugging of memory problems just a little bit easier. -In addition, the memory manager provides statistics on the hit ratio of allocated blocks coming from the lists vs. `malloc()`, and on how many blocks of each size/type are `malloc()`ed and cached. This information can be helpful for tracking down memory leaks. Empirical testing has shown an increase of performance of around 50% or more in programs with the newmalloc module in use. +In addition, the memory manager provides statistics on the hit ratio of allocated blocks coming from the lists vs. `malloc()`, and on how many blocks of each size/type are `malloc()`ed and cached. This information can be helpful for tracking down memory leaks. Empirical testing has shown an increase of performance of around 50% or more in programs that use newmalloc. -One caveat is that this memory manager does not provide `nmRealloc()` function, only `nmMalloc()` and `nmFree()`. Thus, either `malloc()`, `free()`, and `realloc()` or `nmSysMalloc()`, `nmSysFree()`, and `nmSysRealloc()` should be used for blocks of memory that might vary in size. +One caveat is that this memory manager does not provide `nmRealloc()` function, only `nmMalloc()` and `nmFree()`. Thus, either `malloc()`, `free()`, and `realloc()` or [`nmSysMalloc()`](#nmsysmalloc), [`nmSysFree()`](#nmsysfree), and [`nmSysRealloc()`](#nmsysrealloc) should be used for blocks of memory that might vary in size. -- 📖 **Note**: This memory manager is usually the wrong choice for blocks of memory of arbitrary sizes. It is intended for allocating structures quickly that are of a specific size. For example, allocated space for a struct that is always the same size. +- 📖 **Note**: This memory manager is usually the wrong choice for blocks of memory of arbitrary, inconsistent sizes. It is intended for allocating structures quickly that are of a specific size. For example, allocated space for a struct that is always the same size. - 🥱 **tl;dr**: Use `nmMalloc()` for structs, not for strings. -- ⚠️ **Warning**: Calling `free()` on a block obtained from `nmMalloc()` or calling `nmFree()` on a block obtained from `malloc()` might not crash the program immediately. Instead, it will result in either inefficient use of the memory manager, or a significant memory leak, respectively. These practices will also lead to incorrect results from the statistics and block count mechanisms. +- ⚠️ **Warning**: Do not mix and match, even though calling `free()` on a block obtained from `nmMalloc()` or calling `nmFree()` on a block obtained from `malloc()` might not crash the program immediately. However, it may result in either inefficient use of the memory manager, or a significant memory leak, respectively. These practices will also lead to incorrect results from the statistics and block count mechanisms. The following are the functions for the newmalloc module: @@ -1123,19 +1215,19 @@ Prints statistics about the memory manager, for debugging and optimizing. For example: ``` NewMalloc subsystem statistics: - nmMalloc: 0 calls, 0 hits (-nan%) - nmFree: 0 calls - bigblks: 0 too big, 0 largest size + nmMalloc: 20244967 calls, 19908369 hits (98.337%) + nmFree: 20233966 calls + bigblks: 49370 too big, 32768 largest size ``` - +- ⚠️ **Warning**: Centrallix-lib must be built with the configure option `--enable-debugging` for this function to work. Otherwise, all the stats will be zeros. ### nmRegister() ```c void nmRegister(int size, char* name); ``` -Registers an inteligent name with a block size. This allows the memory manager to be intelligent when reporting block allocation counts. A given size can have more than one name. This function is optional and not required for any production code to work, but using it can make tracking down memory leaks easier. +Registers an inteligent name for block of the specified size. This allows the memory manager to give more information when reporting block allocation counts. A given size can have more than one name. This function is optional and not required for any production usecases, but using it can make tracking down memory leaks easier. This function is usually called in a module's `Initialize()` function on each of the structures the module uses internally. @@ -1148,7 +1240,7 @@ Prints a listing of block allocation counts, giving (by size): - The number of blocks allocated but not yet freed. - The number of blocks in the cache. - The total allocations for this block size. -- A list of names (from `nmRegister()`) for that block size. +- A list of names (from [`nmRegister()`](#nmregister)) for that block size. ### nmDeltas() @@ -1162,237 +1254,601 @@ Prints a listing of all blocks whose allocation count has changed, and by how mu ```c void* nmSysMalloc(int size); ``` -Allocates memory without using the block-caching algorithm. This is roughly equivalent to `malloc()`, but pointers returned by malloc and this function are not compatible with each other - i.e., you cannot `free()` something that was `nmSysMalloc()`'ed, nor can you `nmSysFree()` something that was `malloc()`'ed. +Allocates memory without using the block-caching algorithm. This is roughly equivalent to `malloc()`, but pointers returned by malloc and this function are not compatible - i.e., you cannot `free()` something that was [`nmSysMalloc()`](#nmsysmalloc)'ed, nor can you [`nmSysFree()`](#nmsysfree) something that was `malloc()`'ed. -- 📖 **Note**: This function is much better to use on variable-sized blocks of memory. `nmMalloc()` is better for fixed-size blocks, such as for data structures. +- 📖 **Note**: This function is much better to use on variable-sized blocks of memory. `nmMalloc()` is better for fixed-size blocks, such as for structs. ### nmSysRealloc() ```c void* nmSysRealloc(void* ptr, int newsize); ``` -Changes the size of an allocated block of memory that was obtained from `nmSysMalloc()`, `nmSysRealloc()`, or `nmSysStrdup()`. The new pointer may be different if the block has to be moved. This is the rough equivalent of `realloc()`. +Changes the size of an allocated block of memory that was obtained from [`nmSysMalloc()`](#nmsysmalloc), [`nmSysRealloc()`](#nmsysrealloc), or [`nmSysStrdup()`](#nmsysstrdup). The new pointer may be different if the block needs to be moved. This is the rough equivalent of `realloc()`. -- 📖 **Note**: If you are `realloc()`'ing a block of memory and need to store pointers to data somewhere inside the block, it is often better to store an offset rather than a full pointer. This is because a full pointer becomes invalid if a `nmSysRealloc()` causes the block to move. +- 📖 **Note**: If you are `realloc()`'ing a block of memory and need to store pointers to data somewhere inside the block, it is often better to store an offset rather than a full pointer. This is because a full pointer becomes invalid if a [`nmSysRealloc()`](#nmsysrealloc) causes the block to move. ### nmSysStrdup() ```c char* nmSysStrdup(const char* str); ``` -Allocates memory using `nmSysMalloc()` function and copies the string `str` into this memory. It is a rough equivalent of `strdup()`. The resulting pointer can be free'd using `nmSysFree()`. +Allocates memory using the [`nmSysMalloc()`](#nmsysmalloc) function and copies the string `str` into this memory. It is a rough equivalent of `strdup()`. The resulting pointer can be free'd using [`nmSysFree()`](#nmsysfree). ### nmSysFree() ```c void nmSysFree(void* ptr); ``` -Frees a block of memory allocated by `nmSysMalloc()`, `nmSysRealloc()`, or `nmSysStrdup()`. +Frees a block of memory allocated by [`nmSysMalloc()`](#nmsysmalloc), [`nmSysRealloc()`](#nmsysrealloc), or [`nmSysStrdup()`](#nmsysstrdup). + + + +## V Module: XArray +The xarray (xa) module is intended to manage sized growable arrays, similar to a light-weight arraylist implementation. It includes the `XArray`, which has the following fields: +- `nItems : int`: The number of items in the array. +- `nAlloc : int`: Internal variable to store the size of the allocated memory. +- `Items : void**`: The allocated array of items. + +- 📖 **Note**: Some code occasionally sets `nAlloc` to 0 after an XArray struct has been deinitialized to indicate that the relevant data is no longer allocated. Other than this, it is only used internally by the library. + +- ⚠️ **Warning**: Do not mix calls to [`xaNew()`](#xanew)/[`xaFree()`](#xafree) with calls to [`xaInit()`](#xainit)/[`xaDeInit()`](#xadeinit). Every struct allocated using new must be freed, and ever struct allocated using init must be deinitted. Mixing these calls can lead to memory leaks, bad frees, and crashes. + + +### xaNew() +```c +pXArray xaNew(int init_size); +``` +Allocates a new `XArray` struct on the heap (using [`nmMalloc()`](#nmmalloc) for caching) and returns a pointer to it, or returns `NULL` if an error occurs. + +### xaFree() +```c +int xaFree(pXArray this); +``` +Frees a `pXArray` allocated using [`xaNew`](#xanew), returning 0 if successful or -1 if an error occurs. + +### xaInit() +```c +int xaInit(pXArray this, int init_size); +``` +This function initializes an allocated (but uninitialized) xarray. It makes room for `init_size` items initially, but this is only an optimization. A typical value for `init_size` is 16. Remember to [`xaDeInit`](#xadeinit) this xarray, do **not** [`xaFree`](#xafree) it. + +This function returns 0 on success, or -1 if an error occurs. + +### xaDeInit() +```c +int xaDeInit(pXArray this); +``` +This function de-initializes an xarray, but does not free the XArray structure itself. This is useful if the structure is a local variable allocated using [`xaInit()`](#xainit). +This function returns 0 on success, or -1 if an error occurs. +For example: +```c +XArray arr; +if (xaInit(&arr, 16) != 0) goto handle_error; -## V Other Utility Modules - - -The Centrallix library (`centralllix-lib`) has a host of useful utility modules. These include `xarray`, used for managing growable arrays; `xstring`, used for managing growable strings; `xhash`, used for managing hash tables with no overflow problems and variable-length keys; `expression`, used for compiling and evaluating expressions; and `mtsession`, used for managing session-level variables and reporting errors. +/** Use the xarray. **/ +if (arr.nAlloc != 0 && xaDeInit(&arr) != 0) goto handle_error; +arr.nAlloc = 0; +``` -### A. XArray (XA) - Arrays -The first is the xarray (XA) module. +### xaAddItem() +```c +int xaAddItem(pXArray this, void* item); +``` +This function adds an item to the end of the xarray. The item is assumed to be a `void*`, but this function will _not_ follow pointeres stored in the array. Thus, other types can be typecast and stored into that location (such as an `int`). -#### xaInit(pXArray this, int init_size) -This function initializes an allocated-but-uninitialized xarray. It makes room for 'init_size' items initially, but this is only an optimization. A typical value for init_size is 16. +This function returns 0 on success, or -1 if an error occurs. -#### xaDeInit(pXArray this) -This de-initializes an xarray, but does not free the XArray structure itself. +### xaAddItemSorted() +```c +int xaAddItemSorted(pXArray this, void* item, int keyoffset, int keylen); +``` +This function adds an item to a sorted xarray while maintaining the sorted property. The value for sorting is expected to begin at the offset given by `keyoffset` and continue for `keylen` bytes. This function _will_ follow pointers are stored in the array so casting other types to store them is not allowed (as it is with [`xaAddItem()`](#xaadditem)). -#### xaAddItem(pXArray this, void* item) -This adds an item to the array. The item can be a pointer or an integer (but ints will need a typecast on the function call). +### xaAddItemSortedInt32() +```c +int xaAddItemSortedInt32(pXArray this, void* item, int keyoffset) +``` + -#### xaAddItemSorted(pXArray this, void* item, int keyoffset, int keylen) -This adds an item to the xarray, and keeps the array sorted. The value for sorting is expected to begin at offset 'keyoffset' and continue for 'keylen' bytes. This only works when pointers are stored in the array, not integers. +### xaGetItem() +```c +void* xaGetItem(pXArray this, int index) +``` +This function returns an item given a specific index into the xarray, or `NULL` if the index is out of bounds. If the bounds check needs to be omitted for performance and the caller can otherwise verify that no out of bounds read is possible (e.g. because they are iterating from 0 to `xarray->nItems`), the caller should access `xarray->Items` directly. Either way, the result may need to be typecasted or stored in a variable of a specific type for it to be useable, and error checking for `NULL` values should be used. -#### xaFindItem(pXArray this, void* item) -This returns the offset into the array's items of the given value. An exact match is required. The array's items are given below: +### xaFindItem() +```c +int xaFindItem(pXArray this, void* item); +``` +This function returns array index for the provided item in the array, or -1 if the item could not be found. Requires an exact match, so two `void*` pointing to different memory with identical contents are not considered equal by this function. If the data is actually another datatype typecasted as a `void*`, all 8 bytes must be identical for a match. +For example: ```c - XArray xa; - pStructInf inf; - int item_id; +void* data = &some_data; + +XArray xa; +xaInit(&xa, 16); + +... - xaInit(&xa, 16); +xaAddItem(&xa, data); - [...] +... - xaAddItem(&xa, inf); +int item_id = xaFindItem(&xa, data); +assert(data == xa.Items[item_id]); +``` - [...] +### xaFindItemR() +```c +int xaFindItemR(pXArray this, void* item); +``` +This function works the same as [`xaFindItem()`](#xafinditem), however it iterates in reverse, giving a slight performance boost, especially for finding items near the end of the array. - item_id = xaFindItem(&xa, inf); - inf == xa.Items[item_id]; +### xaRemoveItem(pXArray this, int index) +```c +int xaRemoveItem(pXArray this, int index) ``` +This function removes an item from the xarray at the given the index, then shifts all following items back to fill the gap created by the removal. XArray is not optimized for removing multiple items efficiently. This function returns 0 on success, or -1 if an error occurs. -#### xaRemoveItem(pXArray this, int index) -This function removes an item from the xarray at the given index. +### xaClear() +```c +int xaClear(pXArray this, int (*free_fn)(), void* free_arg); +``` +This function removes all elements from the xarray, leaving it empty. `free_fn()` is invoked on each element with a `void*` to the element to be freed as the first argument and `free_arg` as the second argument (the return value of `free_fn()` is always ignored). This function returns 0 on success (even if the `free_fn()` returns an error), or -1 if an error is detected. -### B. XHash (XH) - Hash Tables -The xhash module provides an extensible hashing table interface. The hash table is a table of linked lists of items, so collisions and overflows are not a problem as in conventional hash tables. +### xaClearR() +```c +int xaClearR(pXArray this, int (*free_fn)(), void* free_arg); +``` +This function works the same as [`xaClear()`](#xaclear), except that it is slightly faster because the free function is evaluated on items in reverse order. -### int xhInit(pXHashTable this, int rows, int keylen) -This initializes a hash table, giving it the given number of rows, and setting the key length. For variable length keys (null- terminated strings), use a key length of 0 (zero). The 'rows' should be an odd number, preferably prime, but does not need to be. It SHOULD NOT be a power of 2. It's value is an optimization depending on how much data you expect to be in the hash table. If its value is set to 1, the hash search degenerates to a linear array search. The value should be large enough to comfortably accomodate the elements. Typical values might be 31 or 255 (though 255 is not prime). +### xaCount() +```c +int xaCount(pXArray this); +``` +This function returns the number of items in the xarray, or -1 on error. It is equivalent to accessing `xarray->nItems` (although the latter expression will not return an error). -#### int xhDeInit(pXHashTable this) -De-initializes a hash table. +### xaInsertBefore() +```c +int xaInsertBefore(pXArray this, int index, void* item) +``` +This function inserts an item before the specified index, moving all following items forward to make space. The new item cannot be inserted past the end of the array. This function returns the index on success, or -1 if an error occurs. -#### int xhAdd(pXHashTable this, char* key, char* data) -Adds an item to the hash table, with a given key value and data pointer. Both data and key pointers must have a lifetime that exceeds the time that they item is hashed. +### xaInsertAfter() +```c +int xaInsertAfter(pXArray this, int index, void* item) +``` +This function inserts an item after the specified index, moving all following items forward to make space. The new item cannot be inserted past the end of the array. This function returns the index on success, or -1 if an error occurs. -#### int xhRemove(pXHashTable this, char* key) -Removes an item with the given key value from the hash table. -#### char* xhLookup(pXHashTable this, char* key) -Returns the data pointer for a given key, or NULL if the item is not found. -#### int xhClear(pXHashTable this, int free_blk) -Clears all items from a hash table. If free_blk is set to 1, the items are free()'d as they are removed. +## VI Module: XHash +The xhash (xh) module provides an extensible hash table interface. The hash table is a table of linked lists of items, so collisions and overflows are handled by this data structure (although excessive collisions still cause a performance loss). This implementation also supports variable-length keys for more flexible usecases. -### C. XString (XS) - Strings -The xstring (XS) module is used for managing growable strings. It is based on a structure containing a small initial string buffer to avoid string allocations for small strings, but with the capability of performing realloc() operations to extend the string space for storing incrementally larger strings. The interface to this module allows for strings to contain arbitrary data, even null '\0' characters mid-string. Thus it is useful as an extensible buffer module as well. +- ⚠️ **Warning**: All `xhXYZ()` function calls assume that the `pXHashTable this` arg points to a valid hashtable struct. All non-init functions assume that this struct has been validly initialized and has not yet been freed. If these conditions are not met, the resulting behavior is undefined. -#### int xsInit(pXString this) -Initializes an XString structure, to an empty string. +### xhInitialize() +```c +int xhInitialize(); +``` +Initialize the random number table for hash computation, returning 0 on success or -1 if an error occurs. Normally, you can assume someone else has already called this during program startup. -#### int xsDeInit(pXString this) -Deinitializes an XString structure. +### xhInit() +```c +int xhInit(pXHashTable this, int rows, int keylen); +``` +This function initializes a hash table, setting the number of rows and the key length. Specify a `keylen` of 0 for for variable length keys (aka. null-terminated strings). The `rows` should be an odd number, preferably prime (although that isn't required). `rows` **SHOULD NOT** be a power of 2. Providing this value allows the caller to optimize it based on how much data they expect to be stored in the hash table. If this value is set to 1, the hash search degenerates to a linear array search with extra overhead. Thus, the value should be large enough to comfortably accommodate the elements with minimal collisions. Typical values include 31, 251, or 255 (though 255 is not prime). -#### int xsConcatenate(pXString this, char* text, int len) -Concatenates the string 'text' onto the end of the XString's value. If len is -1, all data up to the null terminater is copied. If len is set, all data up to length 'len' is copied, including possible '\0' characters. +### xhDeInit() +```c +int xhDeInit(pXHashTable this); +``` +This function deinitializes a hash table struct, freeing all rows. Note that the stored data is not freed and neither are the keys as this data is assumed to be the responsibility of the caller. Returns 0 on success, or -1 if an error occurs. -#### int xsCopy(pXString this, char* text, int len) -Copies the string 'text' into the XString. Like xsConcatenate, except that the previous string contents are overwritten. +### xhAdd() +```c +int xhAdd(pXHashTable this, char* key, char* data); +``` +Adds an item to the hash table, with a given key value and data pointer. Both data and key pointers must have a lifetime that exceeds the time that they item is hashed, as they are assumed to be the responsibility of the caller. This function returns 0 on success, or -1 if an error occurs. -#### char* xsStringEnd(pXString this) -Returns a pointer to the end of the string. Useful for finding the end of the string without performing: +### xhRemove() +```c +int xhRemove(pXHashTable this, char* key); +``` +This function removes an item with the given key value from the hash table. It returns 0 if the item was successfully removed, or -1 if an error occurs (including failing to find the item). +### xhLookup() ```c - pXString xs; +char* xhLookup(pXHashTable this, char* key); +``` +This function returns a pointer to the data associated with the given key, or `NULL` if an error occurs (including failing to find the key). - xs->String + strlen(xs->String) +### xhClear() +```c +int xhClear(pXHashTable this, int (*free_fn)(), void* free_arg); ``` +Clears all items from a hash table. If a `free_fn()` is provided, it will be invoked with each data pointer as the first argument and `free_arg` as the second argument as items are removed. The return value of the `free_fn()` is ignored. This function returns 0 on success (even if the `free_fn()` returns an error), or -1 if an error is detected. -since the xs module already knows the string length and does not have to search for the null terminator. Furthermore, since the string can contain nulls, the above statement could produce incorrect results in those situations. +### xhForEach() +```c +int xhForEach(pXHashTable this, int (*callback_fn)(pXHashEntry, void*), void* each_arg); +``` +This function executes an operation on each entry of the hash table entry. The provided callback function will be called with each entry (in an arbitrary order). This function is provided 2 parameters: the current hash table entry, and a `void*` argument specified using `each_arg`. If any invocation of the callback function returns a value other than 0, the `xhForEach()` will immediately fail, returning that value as the error code. -The contents of the XString can be easily referenced via: +This function returns 0 if the function executes successfully, 1 if the callback function is `NULL`, or n (where n != 0) if the callback function returns n. It does not return any error code other than 1 or any error codes returned by `callback_fn()`. +### xhClearKeySafe() ```c - pXString xs; +int xhClearKeySafe(pXHashTable this, void (*free_fn)(pXHashEntry, void*), void* free_arg); +``` +This function clears all contents from the hash table. The free function is passed each hash entry struct and `free_arg`, allowing it to free both the value and key, if needed, and the free function is not allowed to return an error code. This function returns 0 for success as long as `free_fn()` is nonnull, otherwise it returns -1. - printf("This string is %s\n", xs->String); + + +## VII Module: XString +The xstring (xs) module is used for managing growable strings. It is based on a structure containing a small initial string buffer to avoid string allocations for small strings. However, it can also perform `realloc()` operations to extend the string space for storing incrementally larger strings. This module allows for strings to contain arbitrary data, even NULL (`'\0'`) characters mid-string. Thus, it can also be used as an extensible buffer for arbitrary binary data. + +- 📖 **Note**: The contents of the XString can be easily referenced with the `xstring->String` field in the xstring struct. + +- ⚠️ **Warning**: Do not mix calls to [`xsNew()`](#xsnew)/[`xsFree()`](#xsfree) with calls to [`xsInit()`](#xsinit)/[`xsDeInit()`](#xsdeinit). Every struct allocated using new must be freed, and ever struct allocated using init must be deinitted. Mixing these calls can lead to memory leaks, bad frees, and crashes. + +### xsNew() +```c +pXString xsNew() ``` +This function allocates a new XString structure to contain a new, empty string. It uses [`nmMalloc()`](#nmmalloc) because the XString struct is always a consistant size. This function returns a pointer to the new string if successful, or `NULL` if an error occurs. -IMPORTANT NOTE: Do not store pointers to values within the string while you are still adding text to the end of the string. If the string ends up realloc()ing, your pointers will be incorrect. Instead, if data in the middle of the string needs to be pointed to, store offsets from the beginning of the string, not pointers to the string. +### xsFree() +```c +void xsFree(pXString this); +``` +This function frees an XString structure allocated with [`xsNew()`](#xsnew), freeing all associated memory. -For example, this is WRONG: +### xsInit() +```c +int xsInit(pXString this); +``` +This function initializes an XString structure to contain a new, empty string. This function returns 0 if successful, or -1 if an error occurs. + +### xsDeInit() +```c +int xsDeInit(pXString this); +``` +This function deinitializes an XString structure allocated with [`xsInit()`](#xsinit), freeing all associated memory. This function returns 0 if successful, or -1 if an error occurs. + +### xsCheckAlloc() +```c +int xsCheckAlloc(pXString this, int addl_needed); +``` +This function will optionally allocate more memory, if needed, given the currently occupied data area and the additional space required (specified with `addl_needed`). This function returns 0 if successful, or -1 if an error occurs. +### xsConcatenate() ```c - pXString xs; - char* ptr; +int xsConcatenate(pXString this, char* text, int len); +``` +This function concatenates the `text` string onto the end of the XString's value. If `len` is set, that number of characters are copied, including possible null characters (`'\0'`). If `len` is -1, all data up to the null-terminater is copied. This function returns 0 if successful, or -1 if an error occurs. - xsInit(&xs); - xsConcatenate(&xs, "This is the first sentence. ", -1); - ptr = xsStringEnd(&xs); - xsConcatenate(&xs, "This is the second sentence.", -1); +- ⚠️ **Warning**: Do not store pointers to values within the string while adding text to the end of the string. The string may be reallocated to increase space, causing such pointers to break. Instead, use offset indexes into the string and calculate pointers on demand with `xs->String + offset`. + + For example, **DO NOT**: + ```c + XString xs; + if (xsInit(&xs) != 0) goto handle_error; + + if (xsConcatenate(&xs, "This is the first sentence. ", -1) != 0) goto handle_error; + char* ptr = xsStringEnd(&xs); /* Stores string pointer! */ + if (xsConcatenate(&xs, "This is the second sentence.", -1) != 0) goto handle_error; + + /** Print will probably read invalid memory. **/ printf("A pointer to the second sentence is '%s'\n", ptr); + + ... + + if (xsDeInit(&xs) != 0) goto handle_error; + ``` + + Instead, use indexes and pointer arithmetic like this: + ```c + XString xs; + if (xsInit(&xs) != 0) goto handle_error; + + if (xsConcatenate(&xs, "This is the first sentence. ", -1) != 0) goto handle_error; + int offset = xsStringEnd(&xs) - xs->String; /* Stores index offset. */ + if (xsConcatenate(&xs, "This is the second sentence.", -1) != 0) goto handle_error; + + /** Print will probably work fine. **/ + printf("A pointer to the second sentence is '%s'\n", xs->String + offset); + + ... + + if (xsDeInit(&xs) != 0) goto handle_error; + ``` + +### xsCopy() +```c +int xsCopy(pXString this, char* text, int len); +``` +This function copies the string `text` into the XString, overwriting any previous contents. This function returns 0 if successful, or -1 if an error occurs. + +### xsStringEnd() +```c +char* xsStringEnd(pXString this); +``` +This function returns a pointer to the end of the string. This function is more efficient than searching for a null-terminator using `strlen()` because the xs module already knows the string length. Furthermore, since some string may contain nulls, using `strlen()` may produce an incorrect result. + +### xsConcatPrintf() +```c +int xsConcatPrintf(pXString this, char* fmt, ...); +``` +This function prints additional data onto the end of the string. It is similar to printf, however, only the following features are supported: +- `%s`: Add a string (`char*`). +- `%d`: Add a number (`int`). +- `%X`: Add something? +- `%%`: Add a `'%'` character. +Attempting to use other features of printf (such as `%lf`, `%c`, `%u`, etc.) will cause unexpected results. + +This function returns 0 if successful, or -1 if an error occurs. + +### xsPrintf() +```c +int xsPrintf(pXString this, char* fmt, ...); +``` +This function works the same as [`xsConcatPrintf()`](#xsconcatprintf), except that it overwrites the previous string instead of appending to it. This function returns 0 if successful, or -1 if an error occurs. + +### xsWrite() +```c +int xsWrite(pXString this, char* buf, int len, int offset, int flags); +``` +This function writes data into the xstring, similar to using the standard fdWrite or objWrite API. This function can thus be used as a value for `write_fn`, for those functions that require this (such as the `expGenerateText()` function). This function returns `len` if successful, or -1 if an error occurs. + +### xsRTrim() +```c +int xsRTrim(pXString this); +``` +This function trims whitespace characters (spaces, tabs, newlines, and line feeds) from the right side of the xstring. This function returns 0 if successful, or -1 if an error occurs. + +### xsLTrim() +```c +int xsLTrim(pXString this); +``` +This function trims whitespace characters (spaces, tabs, newlines, and line feeds) from the left side of the xstring. This function returns 0 if successful, or -1 if an error occurs. + +### xsTrim() +```c +int xsTrim(pXString this); +``` +This function trims whitespace characters (spaces, tabs, newlines, and line feeds) from both sides of the xstring. This function returns 0 if successful, or -1 if an error occurs. + +### xsFind() +```c +int xsFind(pXString this, char* find, int findlen, int offset) ``` +This function searches for a specific string (`find`) in the xstring, starting at the provided `offset`. `findlen` is the length of the provided string, allowing it to include null characters (pass -1 to have the length calculated using `strlen(find)`). This function returns the index where the string was found if successful, or -1 if an error occurs (including the string not being found). -Instead, use pointer aritmetic and do this: +### xsFind() +```c +int xsFindRev(pXString this, char* find, int findlen, int offset) +``` +This function works the same as [`xsFind()`](#xsfind) except that it searches from the end of the string, resulting in better performance if the value is closer to the end of the string. This function returns the index where the string was found if successful, or -1 if an error occurs (including the string not being found). +### xsSubst() ```c - pXString xs; - int offset; +int xsSubst(pXString this, int offset, int len, char* rep, int replen) +``` +This function substitutes a string into a given position in an xstring. This does not search for matches as with [`xsReplace()`](#xsrepalce), instead the position (`offset`) and length (`len`) must be specified. Additionally, the length of the replacement string (`replen`) can be specified handle null characters. Both `len` and `replen` can be left blank to generate them using `strlen()`. This function returns 0 if successful, or -1 if an error occurs. - xsInit(&xs); - xsConcatenate(&xs, "This is the first sentence. ", -1); - offset = xsStringEnd(&xs) - xs->String; - xsConcatenate(&xs, "This is the second sentence.", -1); - printf("A pointer to the second sentence is '%s'\n",xs->String+offset); +### xsReplace() +```c +int xsReplace(pXString this, char* find, int findlen, int offset, char* rep, int replen); ``` +This function searches an xString for the specified string (`find`) and replaces that string with another specified string (`rep`). Both strings can have their length specified (`findlen` and `replen` respectively), or left as -1 to generate it using `strlen()`. This function returns the starting offset of the replace if successful, or -1 if an error occurs (including the string not being found). +### xsInsertAfter() +```c +int xsInsertAfter(pXString this, char* ins, int inslen, int offset); +``` +This function inserts the specified string (`ins`) at offset (`offset`). The length of the string can be specified (`inslen`), or left as -1 to generate it using `strlen()`. This function returns the new offset after the insertion (i.e. `offset + inslen`), or -1 if an error occurs. -### D. Expression (EXP) - Expression Trees -The expression (EXP) module is used for compiling, evaluating, reverse- evaluating, and passing parameters to expression strings. The expression strings are compiled and stored in an expression tree structure. +### xsGenPrintf_va() +```c +int xsGenPrintf_va(int (*write_fn)(), void* write_arg, char** buf, int* buf_size, const char* fmt, va_list va); +``` +This function performs a `printf()` operation to an `xxxWrite()` style function. -Expressions can be stand-alone expression trees, or they can take parameter objects. A parameter object is an open object (from objOpen()) whose values (attributes) are referenced within the expression string. By using such parameter objects, one expression can be compiled and then evaluated for many different objects with diverse attribute values. +In the wise words of Greg Beeley from 2002: +> This routine isn't really all that closely tied to the XString module, but this seemed to be the best place for it. If a `buf` and `buf_size` are supplied (`NULL` otherwise), then `buf` MUST be allocated with the `nmSysMalloc()` routine. Otherwise, **kaboom!** This routine will grow `buf` if it is too small, and will update `buf_size` accordingly. -Expression evaluation results in the top-level expression tree node having the final value of the expression, which may be NULL, and may be an integer, string, datetime, money, or double data type. For example, the final value of +This function returns the printed length (>= 0) on success, or -(errno) if an error occurs. +### xsGenPrintf() +```c +int xsGenPrintf(int (*write_fn)(), void* write_arg, char** buf, int* buf_size, const char* fmt, ...); ``` - :myobject:oneattribute == 'yes' +This function works the same as [`xsGenPrintf_va()`](#xsgenprintf_va), but with a more convenient signature for the developer. + +### xsString() +```c +char* xsString(pXString this); ``` +This function returns the stored string after checking for various errors, or returns `NULL` if an error occurs. -would be integer 1 (true) if the attribute's value is indeed 'yes'. +### xsLength() +```c +xsLength(pXString this); +``` +This function returns the length of the string in constant time (since this value is stored in `this->Length`) checking for various errors, or returns `NULL` if an error occurs. -Reverse expression evaluation takes a given final value and attempts to assign values to the parameter object attributes based on the structure of the expression tree. It is akin to 'solving for X' in algebraic work, but isn't nearly that 'smart'. For example, with the previous expression, if the final value was set to 1 (true), then an objSetAttrValue() function would be issued to set myobject's 'oneattribute' to 'yes'. Trying this with a final value of 0 (false) would result in no assignment to the attribute, since there would be no way of determining the proper value for that attribute (anything other than 'yes' would work). + + +### xsQPrintf_va(), xsQPrintf(), & xsConcatQPrintf() +```c +int xsQPrintf_va(pXString this, char* fmt, va_list va); +int xsQPrintf(pXString this, char* fmt, ...); +int xsConcatQPrintf(pXString this, char* fmt, ...); +``` +These functions use the `QPrintf` to add data to an xstring. They return 0 on success, or some other value on failure. + + + +## VIII Module: Expression +The expression (EXP) module is used for compiling, evaluating, reverse-evaluating, and managing parameters for expression strings. The expression strings are compiled and stored in an expression tree structure. + +Expressions can be stand-alone expression trees, or they can take parameter objects. A parameter object is an open object (from `objOpen()`) whose values (attributes) are referenced within the expression string. By using such parameter objects, one expression can be compiled and then evaluated for many different objects with diverse attribute values. + +Expression evaluation results in the top-level expression tree node having the final value of the expression, which may be `NULL`, and may be an integer, string, datetime, money, or double data type. For example, the final value of `:myobject:oneattribute == 'yes'` is the integer 1, `true`, if the attribute's value is indeed `'yes'` (and the integer 0, `false`, otherwise). + +Expression reverse-evaluation takes a given final value and attempts to assign values to the parameter object attributes based on the structure of the expression tree. It is akin to 'solving for X' in algebraic work, but isn't nearly that 'smart'. For example, with the previous expression, if the final value was set to 1 (`true`), then an `objSetAttrValue()` function would be called to set myobject's `oneattribute` to `yes`. Trying this with a final value of 0 (`false`) would result in no assignment to the attribute, since there would be no way of determining the proper value for that attribute (anything other than `yes` would work). Reverse evaluation is typically very useful in updateable joins and views. -Here are the basic expression functions: +The expression module includes the following functions: -#### pExpression expCompileExpression(char* text, pParamObjects objlist, int lxflags, int cmpflags) -This function compiles a textual expression into an expression tree. The 'objlist' lists the parameter objects that are allowed in the expression (see below for param objects maintenance functions). +### expAllocExpression() +```c +pExpression expAllocExpression(); +``` +This function allocates space to store a new expression tree, returning a pointer to the allocated memory or `NULL` if an error occurs. -The 'lxflags' parameter gives a set of lexical analyzer flags for the compilation. These flags alter the manner in which the input string is tokenized. A bitmask; possible values are: +### expFreeExpression() +```c +int expFreeExpression(pExpression this); +``` +This function frees an expression tree allocated using `expAllocExpression()`, returning 0 if successful or -1 if an error occurs. -| Value | Description -| ---------------- | ------------ -| MLX_F_ICASEK | automatically convert all keywords (non-quoted strings) to lowercase. -| MLX_F_POUNDCOMM | allow comment lines that begin with a # sign. -| MLX_F_CCOMM | allow c-style comments /* */ -| MLX_F_CPPCOMM | allow c-plus-plus comments // -| MLX_F_SEMICOMM | allow semicolon comments ;this is a comment -| MLX_F_DASHCOMM | allow double-dash comments --this is a comment -| MLX_F_DASHKW | keywords can include the dash '-'. Otherwise, the keyword is treated as two keywords with a minus sign between them. -| MLX_F_FILENAMES | Treat a non-quoted string beginning with a slash '/' or dot-slash './' as a filename, and allow slashes and dots in the string without quotes needed. -| MLX_F_ICASER | automatically convert all reserved words to lowercase. The use of this flag is highly recommended, and in some cases, required. -| MLX_F_ICASE | same as MLX_F_ICASER | MLX_F_ICASEK. +### expCompileExpression() +```c +pExpression expCompileExpression(char* text, pParamObjects objlist, int lxflags, int cmpflags); +``` +This function compiles a textual expression into an expression tree. The `objlist` lists the parameter objects that are allowed in the expression (see below for param objects maintenance functions). -The 'cmpflags' is a bitmask parameter controlling the compilation of the expression. It can contain the following values: +The `lxflags` parameter is a bitmask that provides flags which will be passed to the lexer. These flags alter the manner in which the input string is tokenized. For information about these flags, see [`mlxOpenSession()`](#mlxopensession). -| Value | Description -| ------------------- | ------------ -| EXPR_CMP_WATCHLIST | A list "value,value,value" is expected first in the expression. -| EXPR_CMP_ASCDESC | Recognize 'asc' and 'desc' following a value as flags to indicate sort order. -| EXPR_CMP_OUTERJOIN | Recognize the *= and =* syntax as outer joins. +The `cmpflags` parameter is a bitmask that provides flags which will be passed to the expression compiler. It can contain the following values: -#### expFreeExpression(pExpression this) -Frees an expression tree. +| Value | Description +| -------------------- | ------------ +| `EXPR_CMP_ASCDESC` | Recognize `asc`/`desc` following a value as flags to indicate sort order. +| `EXPR_CMP_OUTERJOIN` | Recognize the `*=` and `=*` syntax for left and right outer joins. +| `EXPR_CMP_WATCHLIST` | A list (`"value,value,value"`) is expected first in the expression. +| `EXPR_CMP_LATEBIND` | Allow late object-name binding. +| `EXPR_CMP_RUNSERVER` | Compile as a `runserver` expression (for dynamic binding). +| `EXPR_CMP_RUNCLIENT` | Compile as a `runclient` expression (for client-side binding). +| `EXPR_CMP_REVERSE` | Lookup names in the reverse order. -#### int expEvalTree(pExpression this, pParamObjects objlist) -Evaluates an expression against a list of parameter objects. If the evaluation is successful, returns 0 or 1, otherwise -1. +### expCompileExpressionFromLxs() +```c +pExpression expCompileExpressionFromLxs(pLxSession s, pParamObjects objlist, int cmpflags); +``` +This function is similar to [`expCompileExpression()`](#expcompileexpression), excpet that it compiles from a provided lexer session instead of from a string. -#### pParamObjects expCreateParamList() -Allocates a new parameter object list, with no parameters. +### expPodToExpression() +```c +pExpression expPodToExpression(pObjData pod, int type, pExpression provided_exp) +``` +This function builds an expression node from a single piece of data, passed using the `pObjData` of the given datatype. This function can be used to initialize a provided expression (`provided_exp`), or it will allocate a new one if none is provided (aka. `provided_exp` is `NULL`). -#### int expFreeParamList(pParamObjects this) -Frees a parameter object list. +For example, the following code creates an expression representing the integer 1. +```c +int value = 1; +pExpression exp = expPodToExpression(POD(value), DATA_T_INTEGER, NULL); +``` + +This function returns a pointer to the expression if successful, or `NULL` if an error occurs. + +- 📖 **Note**: There is also a `expPtodToExpression()` function for working with the `Ptod` (pointer to object data) struct. + +### expExpressionToPod() +```c +int expExpressionToPod(pExpression this, int type, pObjData pod); +``` +This function reverses the functionality of [`expPodToExpression()`](#exppodtoexpression) to instead read data from an evaluated expression. Be careful, this does not evaluate the expression if it is not already evaluated. This function returns 0 if successful, 1 if the expression is NULL, or -1 if an error occurs. + +- 📖 **Note**: The source code for this function can be a useful reference when interacting with expression structures, such as when implementing the c code for an exp_function. + +- 📖 **Note**: There is also a `expExpressionToPtod()` function for working with the `Ptod` (pointer to object data) struct. + +### expDuplicateExpression() +```c +pExpression expDuplicateExpression(pExpression this); +``` +This function creates a recursive deep copy of the expression and associated expression tree, returning a pointer to this new copy if successful and `NULL` if an error occurs. + +### expIsConstant() +```c +int expIsConstant(pExpression this); +``` +This function returns a truthy value if the provided expression is of a type that is always the same, such as an integer, string, double, etc. Otherwise, it returns a falsy value. + +### expEvalTree() +```c +int expEvalTree(pExpression this, pParamObjects objlist); +``` +This function evaluates the expression using the provided list of parameter objects. It returns 0 if successful or 1 if the result is `NULL`, and -1 if an error occurs. + +### expCreateParamList() +```c +pParamObjects expCreateParamList(); +``` +This function allocates and returns a new parameter object list containing no parameters, or returns `NULL` if an error occurs. -#### int expAddParamToList(pParamObjects this, char* name, pObject obj, int flags) -Adds a parameter to the parameter object list. The 'obj' pointer may be left NULL during the expCompileExpression state of operation but must be set to a value before expEvalTree is called. Otherwise the attributes that reference that parameter object will result in NULL values in the expression (it's technically not an error). Flags can be EXPR_O_CURRENT if the object is to be marked as the current one, or EXPR_O_PARENT if it is to be marked as the parent object. Current and Parent objects can be referenced in an expression like this: +### expFreeParamList() +```c +int expFreeParamList(pParamObjects this); +``` +This function frees a parameter object list, returning 0 if successful and -1 if an error occurs. + +### expAddParamToList() +```c +int expAddParamToList(pParamObjects this, char* name, pObject obj, int flags); +``` +This function adds a parameter to the parameter object list. The `obj` pointer may be left `NULL` during the expCompileExpression state of operation but must be set to a value before expEvalTree is called. Otherwise the attributes that reference that parameter object will result in `NULL` values in the expression. (Although this _technically_ is not an error, it's usually not intended behavior). Flags can be `EXPR_O_CURRENT` if the object is to be marked as the current one, or `EXPR_O_PARENT` if it is to be marked as the parent object. Current and Parent objects can be referenced in an expression like this: ``` - :currentobjattr - ::parentobjattr +:currentobjattr +::parentobjattr ``` -and is thus a shortcut to typing the full object name. +### expModifyParam() +```c +int expModifyParam(pParamObjects this, char* name, pObject replace_obj); +``` +This function is used to update a parameter object with a new open pObject, possibly one returned from `objOpen()` or `objQueryFetch()`. This function returns 0 if successful and -1 if an error occurs. -#### int expModifyParam(pParamObjects this, char* name, pObject replace_obj) -This function is used to update a parameter object with a new open pObject returned from objOpen or objQueryFetch. +### expRemoveParamFromList() +```c +int expRemoveParamFromList(pParamObjects this, char* name); +``` +This function removes a parameter object from the list, returning 0 if successful and -1 if an error occurs. -#### int expRemoveParamFromList(pParamObjects this, char* name) -This function removes a parameter object from the list. +- 📖 **Note**: There is also a `expRemoveParamFromListById()` function. -#### int expReverseEvalTree(pExpression tree, pParamObjects objlist) +### expSetParamFunctions() +```c +int expSetParamFunctions(pParamObjects this, char* name, int (*type_fn)(), int (*get_fn)(), int (*set_fn)()); +``` +This function sets the param accessor functions used to access params on a specific name. Some example function signatures for the `type_fn()`, `get_fn()`, and `set_fn()` are provided below: + +```c +static int ci_GetParamType(void* v, char* attr_name); +static int ci_GetParamValue(void* v, char* attr_name, int datatype, pObjData val); +static int ci_SetParamValue(void* v, char* attr_name, int datatype, pObjData val); +``` + +- `v : void*` is the object provided in `expAddParamToList()` (or a similar function). +- `attr_name : char*` is the string name for the requested attribute. +- `datatype : int` is the data type for the requested attribute. +- `val : pObjectData` is either a buffer in which to store the requested data (`ci_GetParamValue()`) or a buffer containing data that will be copied to the parameter `ci_SetParamValue()`. + +All three of these functions return 0 for success, 1 if the attribute is `NULL`, or -1 if an error occurs. The `expSetParamFunctions()` function returns 0 if the functions were set successfully, or -1 if an error occurs. + +### expReverseEvalTree() +```c +int expReverseEvalTree(pExpression tree, pParamObjects objlist)l +``` This function reverse-evaluates a tree. The results of an expression evaluation can be accessed by examining the @@ -1411,234 +1867,379 @@ top-level tree node. The following properties are useful: There are several other EXP functions used to deal with aggregates and a few other obscure features as well. Aggregates are mostly handled internally by Centrallix so further explanation should not be necessary here. -### E. MTSession (MSS) - Basic Session Management -The next utility module to be described here is the mtsession module (MSS). This module is used for session authentication, error reporting, and for storing session-wide variables such as the currently used date format, current username, and current password (for issuing a login request to a remote server). Care should be taken in the use of Centrallix that its coredump files are NOT in a world-readable location, as the password will be visible in the core file (or just ulimit the core file size to 0). -#### char* mssUserName() -This function returns the current user name. +## IX Module: MTSession +The mtsession (MSS) module is used for session authentication, error reporting, and for storing session-wide variables such as the current date format, username, and password (used when issuing a login request to a remote server). Care should be taken in the use of Centrallix that its coredump files are NOT in a world-readable location, as the password will be visible in the coredump file (or just ulimit the core file size to 0). + -#### char* mssPassword() -This function returns the password used to login to the Centrallix +### mssInitialize() +```c +int mssInitialize(char* authmethod, char* authfile, char* logmethod, int logall, char* log_progname); +``` +This function initializes the session manager and sets global variables used in this module. It returns 0 if successful and -1 if an error occurs. + +### mssUserName() +```c +char* mssUserName(); +``` +This function returns the current user name, or `NULL` an error occurs. -#### int mssSetParam(char* paramname, char* param) -This function sets a session parameter. The parameter MUST be a string value. +### mssPassword() +```c +char* mssPassword(); +``` +This function returns the current user's password that they used to log into Centrallix, or `NULL` an error occurs. -#### char* mssGetParam(char* paramname) -Returns the value of a session parameter. Common ones are: +### mssSetParam() +```c +int mssSetParam(char* paramname, char* param); +``` +This function sets the session parameter of the provided name (`paramname`) to the provided value (`param`). The parameter MUST be a string value. This function returns 0 if successful, or -1 an error occurs. -- dfmt - current date format. -- mfmt - current money format. -- textsize - current max text size from a read of an object's content via objGetAttrValue(obj, "objcontent", POD(&str)) +### mssGetParam() +```c +char* mssGetParam(char* paramname); +``` +Returns the value of a session parameter of the provided name (`paramname`), or `NULL` if an error occurs. Common session parameters include: +- `dfmt`: The current date format. +- `mfmt`: The current money format. +- `textsize`: The current max text size from a read of an object's content via `objGetAttrValue(obj, "objcontent", POD(&str))` -#### int mssError(int clr, char* module, char* message, ...) -Formats and caches an error message for return to the user. If 'clr' is set to 1, the assumption is that the error was JUST discovered and no other module has had reason to do an mssError on the current problem. Setting 'clr' to 1 clears all error messages from the current error message list and adds the current message. +### mssError() +```c +int mssError(int clr, char* module, char* message, ...); +``` +Formats and caches an error message for return to the user. This function returns 0 if successful, or -1 if an error occurred. -'module' is a two-to-five letter abbreviation of the module reporting the error. Typically it is all upper-case. +| Parameter | Type | Description +| --------- | ------------- | ------------ +| crl | int | If set to 1, all previous error messages are cleared. Set this when the error is initially discovered and no other module is likely to have made a relevant `mssError()` call for the current error. +| module | char* | A two-to-five letter abbreviation of the module reporting the error. This is typically the module or driver's abbreviation prefix in full uppercase letters (although that is not required). This is intended to help the developer find the source of the error faster. +| message | char* | A string error message, accepting format specifiers like `%d` and `%s` which are supplied by the argument list, similar to `printf()`. +| ... | ... | Parameters for the formatting. -'message' is a string for the error message. As this function will accept a variable-length argument list, the strings '%d' and '%s' can be included in 'message', and will be substituted with the appropriate integer or string arguments, in a similar way to how printf() works. +Errors that occur inside a session context are normally stored up and not printed until other MSS module routines are called to fetch the errors. Errors occurring outside a session context (such as in Centrallix's network listener) are printed to Centrallix's standard output immediately. -#### int mssErrorErrno(int clr, char* module, char* message, ...) -Works much the same way as mssError, except checks the current value of 'errno' and includes a description of any error stored there. Used primarily when a system call was at fault for an error occurring. +The `mssError()` function is not required to be called at every function nesting level when an error occurs. For example, if the expression compiler returns -1 indicating that a compilation error occurred, it has probably already added one or more error messages to the error list. The calling function should only call `mssError()` if doing so would provide additional context or other useful information (e.g. _What_ expression failed compilation? _Why_ as an expression being compiled? etc.). However, it is far easier to give too little information that too much, so it can often be best to air on the side of calling `mssError()` with information that might be irrelevant, rather than skipping it and leaving the developer confused. -Errors that occur inside a session context are normally stored up and not printed until other MSS module routines are called to fetch those errors. Errors occurring outside a session context (such as in Centrallix's network listener) are printed to Centrallix's standard output immediately. +- 📖 **Note**: The `mssError()` routines do not cause the calling function to return or exit. The function must still clean up after itself and return an appropriate value (such as `-1` or `NULL`) to indicate failure. -These mssError routines need not be called at every function nesting level when an error happens. For example, if the expression compiler returns -1 indicating that a compilation error occurred, it probably has set one or more error messages in the error list. The calling function only needs to provide context information (e.g. _what_ expression failed compilation?) so that the user has enough information to locate the error. And once the user is told the full context of the expression compilation error, no more information need be returned. +- ⚠️ **Warning**: Even if `-1` is returned, the error message may still be sent to the user in some scenarios. This is not guaranteed, though. -Another example of this is the memory manager, which sets an error message indicating when an nmMalloc() failed. The user probably does not care what kind of structure failed allocation -- he/she only needs to know that the hardware ran out of resources. Thus, upon receiving a NULL from nmMalloc, in most cases another mssError need not be issued. +- ⚠️ **Warning**: `%d` and `%s` are the ONLY supported format specifier for this function. **DO NOT** use any other format specifiers like `%lf`, `%u`, `%lu`, `%c` etc. **DO NOT** attempt to include `%%` for a percent symbol in your error message, as misplaced percent symbols often break this function. If you wish to use these features of printf, it is recommended to print the error message to a buffer and pass that buffer to `mssError()`, as follows: + ```c + char err_buf[256]; + snprintf(err_buf, sizeof(err_buf), + "Incorrect values detected: %u, %g (%lf), '%c'", + unsigned_int_value, double_value, char_value + ); + if (mssError(1, "EXMPL", "%s", err_buf) != 0) + { + fprintf(stderr, "ERROR! %s\n", err_buf); + } + return -1; + ``` -The mssError() routines do not cause the calling function to return. The function must still clean up after itself and return an appropriate value (like -1 or NULL) to indicate failure. -### F. OSML Utility Functions -The OSML provides a set of utility functions that make it easier to write -drivers. Most of them are named obj_internal_XxxYyy or similar. +### mssErrorErrno() +```c +int mssErrorErrno(int clr, char* module, char* message, ...); +``` +This function works the same way as [`mssError`](#mssError), except checks the current value of `errno` and includes a description of any error stored there. This is useful if a system call or other library function is responsible for this error. -#### char* obj_internal_PathPart(pPathname path, int start, int length) -The Pathname structure breaks down a pathname into path elements, which are text strings separated by the directory separator '/'. This function takes the given Pathname structure, and returns the number of path elements requested. For instance, if you have a path: + + +## X Path Handling Functions +The OSML provides a set of utility functions that make it easier to handle path structs when writing drivers. Most of them are named `obj_internal_XxxYyy()` or similar. + +### obj_internal_PathPart() +```c +char* obj_internal_PathPart(pPathname path, int start, int length); +``` +The Pathname structure breaks down a pathname into path elements, which are text strings separated by the directory separator `'/'`. This function takes the given Pathname structure and returns the number of path elements requested (using `length`) after skipping to the `start`th element (where element 0 is the starting `.` that begins any Centrallix path). + +For example, given the path: +```bash +/apps/kardia/data/Kardia_DB/p_partner/rows/1 ``` - /apps/kardia/data/Kardia_DB/p_partner/rows/1 +Centrallix stores the path internally as the following (see [Parsing Path Contents](#parsing-path-contents) and [Parameters](#parameters) above): +```bash +./apps/kardia/data/Kardia_DB/p_partner/rows/1 ``` +Thus, calling `obj_internal_PathPart(pathstruct, 4, 2);` will return `"Kardia_DB/p_partner"` because the `.` is the 0th element, making `Kardia_DB` the 4th element, and we have requested two elements. -that path would be stored internally in Centrallix as: +- 📖 **Note**: The values returned from `obj_internal_PathPart()` use an internal buffer, so they are only valid until the next call to a PathPart function on the given pathname structure. +### obj_internal_AddToPath() +```c +int obj_internal_AddToPath(pPathname path, char* new_element); ``` - ./apps/kardia/data/Kardia_DB/p_partner/rows/1 -``` +This function lengthens the path by one element, adding new_element on to the end of the path. This function is frequently useful for drivers in the QueryFetch routine where the new child object needs to be appended onto the end of the given path. -To just return "Kardia_DB/p_partner", you could call: +This function returns the index of the new element in the path on success, or a value less than 0 on failure. +### obj_internal_CopyPath() +```c +int obj_internal_CopyPath(pPathname dest, pPathname src); ``` - obj_internal_PathPart(pathstruct, 4, 2); +This function copies a pathname structure from the `src` to the `dest`, returning 0 if successful or -1 if an error occurs. + +### obj_internal_FreePathStruct() +```c +void obj_internal_FreePathStruct(pPathname path); ``` +This function frees a pathname structure. -Note that return values from obj_internal_PathPart are only valid until the next call to PathPart on the given pathname structure. -#### int obj_internal_AddToPath(pPathname path, char* new_element) -This function lengthens the path by one element, adding new_element on to the end of the path. This function is frequently useful for drivers in the QueryFetch routine where the new child object needs to be appended onto the end of the given path. -This function returns < 0 on failure, or the index of the new element in the path on success. +## XI Network Connection Functionality +Sometimes, a driver may need to initiate a network connection. This can be done via the `MTASK` module, which provides simple and easy TCP/IP connectivity. It includes many functions, only a few of which are documented below: -#### int obj_internal_CopyPath(pPathname dest, pPathname src) -Copies a pathname structure. +### netConnectTCP() +```c +pFile netConnectTCP(char* host_name, char* service_name, int flags); +``` +This function creates a client socket and connects it to a server on a given TCP service/port and host name. It takes the following three parameters: +- `host_name`: The host name or ascii string for the host's ip address. +- `service_name`: The name of the service (from `/etc/services`) or its numeric representation as a string. +- `flags`: Normally left 0. -#### void obj_internal_FreePathStruct(pPathname path) -Frees a pathname structure. +- 📖 **Note**: The `NET_U_NOBLOCK` flag causes the function to return immediately even if the connection is still being established. Further reads and writes will block until the connection either establishes or fails. -## VI Network Connection Functionality -Sometimes a driver will need to initiate a network connection. This can be done via the MTASK module, which provides simple and easy TCP/IP connectivity. +This function returns the connection file descriptor if successful, or `NULL` if an error occurs. -### pFile netConnectTCP(char* host_name, char* service_name, int flags) -This function connects to a server. The host name or ascii string for its ip address is in 'host_name'. The name of the service (from /etc/services) or its numeric representation in a string is the 'service_name'. Flags can normally be left 0. +### netCloseTCP() +```c +int netCloseTCP(pFile net_filedesc, int linger_msec, int flags); +``` +This function closes a network connection (either a TCP listening, server, or client socket). It will also optionally waits up to `linger_msec` milliseconds (1/1000 seconds) for any data written to the connection to make it to the other end before performing the close. If `linger_msec` is set to 0, the connection is aborted (reset). The linger time can be set to 1000 msec or so if no writes were performed on the connection prior to the close. If a large amount of writes were performed immediately prior to the close, offering to linger for a few more seconds (perhaps 5 or 10 by specifying 5000 or 10000 msec) can be a good idea. -### int netCloseTCP(pFile net_filedesc, int linger_msec, int flags) -This function closes a network connection, and optionally waits up to 'linger_msec' milliseconds (1/1000 seconds) for any data written to the connection to make it to the other end before performing the close. If linger_msec is set to 0, the connection is aborted (reset). The linger time can be set to 1000 msec or so if no writes were performed on the connection prior to the close. If a large amount of writes were performed immediately perior to the close, offering to linger for a few more seconds (perhaps 5 or 10, 5000 or 10000 msec), might be a good idea. +### fdWrite() +```c +int fdWrite(pFile filedesc, char* buffer, int length, int offset, int flags); +``` +This function writes data to an open file descriptor, from a given `buffer` and `length` of data to write. It also takes an optional seek `offset` and and `flags`, which can be zero or more of: +- `FD_U_NOBLOCK` - If the write can't be performed immediately, don't perform it at all. +- `FD_U_SEEK` - The `offset` value is valid. Seek to it before writing. Not allowed for network connections. +- `FD_U_PACKET` - *ALL* of the data specified by `length` in `buffer` must be written. Normal `write()` semantics in UNIX state that not all data has to be written, and the number of bytes actually written is returned. Setting this flag makes sure all data is really written before returning. -### int fdWrite(pFile filedesc, char* buffer, int length, int offset, int flags) -This function writes data to a file descriptor, from a given buffer and length, and to an optional seek offset and with some optional flags. Flags can be the following: +### fdRead() +```c +int fdRead(pFile filedesc, char* buffer, int maxlen, int offset, int flags); +``` +This function works the same as [`fdWrite()`](#fdwrite) except that it reads data instead of writing it. It takes the same flags as above, except that `FD_U_PACKET` now requires that all of `maxlen` bytes must be read before returning. This is good for reading a packet of a known length that might be broken up into fragments by the network (TCP/IP has a maximum frame transmission size of about 1450 bytes). -- `FD_U_NOBLOCK` - If the write can't be performed immediately, don't perform it at all. -- `FD_U_SEEK` - The 'offset' value is valid. Seek to it before writing. Not valid for network connections. -- `FD_U_PACKET` - ALL of the data of 'length' in 'buffer' must be written. Normal write() semantics in UNIX state that not all data has to be written, and the number of bytes actually written is returned. Setting this flag makes sure all data is really written before returning. -#### int fdRead(pFile filedesc, char* buffer, int maxlen, int offset, int flags) -The complement to the above routine. Takes the same flags as the above routine, except FD_U_PACKET means that all of 'maxlen' bytes must be read before returning. This is good for reading a packet that is known to be exactly 'maxlen' bytes long, but which might be broken up into fragments by the network (TCP/IP has a maximum frame transmission size of about 1450 bytes). +## XII Parsing Data +The mtlexer (MLX) module is a lexical analyzer library provided by Centrallix for parsing many types of data. It can parse data from either a `pFile` descriptor or from a string value. This lexical analyzer is also used by the [expression compiler](#viii-module-expression). In simple terms, it's a very fancy string tokenizer. -## VII Parsing Data -Centrallix provides a lexical analyzer library that can be used for parsing many types of data. This module, mtlexer (MLX) can either parse data from a pFile descriptor or from a string value. This lexical analyzer is used by the expression compiler as well. It is basically a very fancy string tokenizer. +### mlxOpenSession() +```c +pLxSession mlxOpenSession(pFile fd, int flags); +``` +This function opens a lexer session, using a file descripter as its source. Some of the more useful values for `flags` include: -### pLxSession mlxOpenSession(pFile fd, int flags) -This function opens a lexer session from a file source. See the 'expression' module description previous in this document for more information on the flags. Some flags of use here but not mentioned in that section are: +| Value | Description +| ----------------- | ------------ +| `MLX_F_ICASEK` | Automatically convert all keywords (non-quoted strings) to lowercase. +| `MLX_F_ICASER` | Automatically convert all reserved words to lowercase. This flag is highly recommended, and in some cases, required. +| `MLX_F_ICASE` | Same as MLX_F_ICASER | MLX_F_ICASEK. +| `MLX_F_POUNDCOMM` | Respect # comment at the start of the line (`#comment`). +| `MLX_F_CCOMM` | Respect c-style comments (`/*comment*/`). +| `MLX_F_CPPCOMM` | Respect c-plus-plus comments (`//comment`). +| `MLX_F_SEMICOMM` | Respect semicolon comments (`;comment`). +| `MLX_F_DASHCOMM` | Respect double-dash comments (`--comment`). +| `MLX_F_EOL` | Return end-of-line as a token. Otherwise, this is considered whitespace. +| `MLX_F_EOF` | Return end-of-file as a token. Otherwise, reaching end of file is an error. +| `MLX_F_ALLOWNUL` | Allow null characters (`'\0'`) in the input stream, which otherwise cause an error. If this flag is set, the caller must ensure that null characters are handled safely. +| `MLX_F_IFSONLY` | Only return string values separated by tabs, spaces, newlines, and carriage returns. For example, normally the brace in `"this{brace"` is a token and that string will result in three tokens, but in `IFSONLY` mode it is just one token. +| `MLX_F_DASHKW` | Keywords can include the dash (`-`). Otherwise, the keyword is treated as two keywords with a minus sign between them. +| `MLX_F_FILENAMES` | Treat a non-quoted string beginning with a slash (`/`) or dot-slash (`./`) as a filename, and allow slashes and dots in the string without requiring quotes. +| `MLX_F_NODISCARD` | Attempt to unread unused buffered data rather than discarding it, allowing the calling function to continue reading with `fdRead()` or another lexer session after the last token is read and the session is closed. The lexer `fdRead()`s in 2k or so chunks for performance, and normally discards this data when done, causing future file decriptors to start at an undefined file location. +| `MLX_F_DBLBRACE` | Treat `{{` and `}}` as double brace tokens, not two single brace tokens. +| `MLX_F_NOUNESC` | Do not remove escapes in strings. +| `MLX_F_SSTRING` | Differentiate between strings values using `""` and `''`. -| Flag | Description -| ------------------- | ------------ -| MLX_F_EOL | Return end-of-line as a token. Otherwise, the end of a line is just considered whitespace. -| MLX_F_EOF | Return end-of-file as a token. Otherwise, if end of file is reached it is an error. -| MLX_F_IFSONLY | Only return string values separated by tabs, spaces, newlines, and carriage returns. For example, normally the brace in "this{brace" is a token and that string will result in three tokens, but in IFSONLY mode it is just one token. -| MLX_F_NODISCARD | This flag indicates to the lexer that the calling function expects to be able to read data normally using fdRead() or another lexer session after the last token is read and the session is closed. The lexer will then attempt to "unread" bytes that it buffered during the lexical analysis process (it does fdRead() operations in 2k or so chunks). If this flag is not specified, up to 2k of information after the last token will be discarded and further fdRead()s on the file descriptor will start at an undefined place in the file. -| MLX_F_ALLOWNUL | Allow NUL characters ('\0') in the input stream. If this flag is not set, then NUL characters result in an error condition. This prevents unwary callers from mis-reading a token returned by mlxStringVal if the token contains a NUL. If ALLOWNUL is turned on, then the caller must ensure that it is safely handling values with NULs. +This function returns a pointer to the new lexer session if successful, or `NULL` if an error occurs. -### pLxSession mlxStringSession(char* str, int flags) -This function opens a lexer session from a text string. Same as the above function except that the flag MLX_F_NODISCARD makes no sense for the string. +### mlxStringSession() +```c +pLxSession mlxStringSession(char* str, int flags); +``` +This function opens a lexer session, using a text string as its source. The flags are the same as [`mlxOpenSession()`](#mlxopensession) above, except that `MLX_F_NODISCARD` has no effect. -### int mlxCloseSession(pLxSession this) -Closes a lexer session. +This function returns a pointer to the new lexer session if successful, or `NULL` if an error occurs. -### int mlxNextToken(pLxSession this) +### mlxCloseSession() +```c +int mlxCloseSession(pLxSession this); +``` +This function closes a lexer session, freeing all associated data. This does not also close the file descriptor used to open the lexer session, as this is assumed to be managed by the caller. This function returns 0 if successful, and -1 if an error occurs. + +### mlxNextToken() +```c +int mlxNextToken(pLxSession this); +``` Returns the type of the next token in the token stream. Valid token types are: -| Token | Meaning | -|----------------------|---------------------------------------| -| MLX_TOK_STRING | String value, as in a "string". | -| MLX_TOK_INTEGER | Integer value. | -| MLX_TOK_EQUALS | = | -| MLX_TOK_OPENBRACE | { | -| MLX_TOK_CLOSEBRACE | } | -| MLX_TOK_ERROR | An error has occurred. | -| MLX_TOK_KEYWORD | An unquoted string. | -| MLX_TOK_COMMA | , | -| MLX_TOK_EOL | End-of-line. | -| MLX_TOK_EOF | End-of-file reached. | -| MLX_TOK_COMPARE | <> != < > >= <= == | -| MLX_TOK_COLON | : | -| MLX_TOK_OPENPAREN | ( | -| MLX_TOK_CLOSEPAREN | ) | -| MLX_TOK_SLASH | / | -| MLX_TOK_PERIOD | . | -| MLX_TOK_PLUS | + | -| MLX_TOK_ASTERISK | * | -| MLX_TOK_RESERVEDWD | Reserved word (special keyword). | -| MLX_TOK_FILENAME | Unquoted string starting with / or ./ | -| MLX_TOK_DOUBLE | Double precision floating point. | -| MLX_TOK_DOLLAR | $ | -| MLX_TOK_MINUS | - | - -### char* mlxStringVal(pLxSession this, int* alloc) -Gets the string value of the current token. If 'alloc' is NULL, only the first 255 bytes of the string will be returned, and the rest will be discarded. If 'alloc' is non-null and set to 0, the routine will set 'alloc' to 1 if it needed to allocate memory for a very long string, otherwise leave it at 0. If 'alloc' is non- null and set to 1, this routine will ALWAYS allocate memory for the string, whether long or short. - -This routine works no matter what the token type, and returns a string representation of the token if not MLX_TOK_STRING. +| Token | Required Flag | Meaning | +|-------------------------|-------------------|---------------------------------------------| +| `MLX_TOK_BEGIN` | - | Beginning of the input stream. | +| `MLX_TOK_STRING` | - | String value, e.g. `"string"`. | +| `MLX_TOK_INTEGER` | - | Integer value, e.g. `42`. | +| `MLX_TOK_EQUALS` | - | `=` | +| `MLX_TOK_OPENBRACE` | - | `{` | +| `MLX_TOK_CLOSEBRACE` | - | `}` | +| `MLX_TOK_ERROR` | - | An error has occurred. | +| `MLX_TOK_KEYWORD` | - | A keyword (unquoted string). | +| `MLX_TOK_COMMA` | - | `,` | +| `MLX_TOK_EOL` | `MLX_F_EOL` | End-of-line. | +| `MLX_TOK_EOF` | `MLX_F_EOF` | End-of-file reached. | +| `MLX_TOK_COMPARE` | - | `<>` `!=` `<` `>` `>=` `<=` `==` | +| `MLX_TOK_COLON` | - | `:` | +| `MLX_TOK_OPENPAREN` | - | `(` | +| `MLX_TOK_CLOSEPAREN` | - | `)` | +| `MLX_TOK_SLASH` | - | `/` | +| `MLX_TOK_PERIOD` | - | `.` | +| `MLX_TOK_PLUS` | - | `+` | +| `MLX_TOK_ASTERISK` | - | `*` | +| `MLX_TOK_RESERVEDWD` | - | Reserved word (special keyword). | +| `MLX_TOK_FILENAME` | `MLX_F_FILENAMES` | Unquoted string starting with / or ./ | +| `MLX_TOK_DOUBLE` | - | Double precision floating point. | +| `MLX_TOK_DOLLAR` | - | `$` | +| `MLX_TOK_MINUS` | - | `-` | +| `MLX_TOK_DBLOPENBRACE` | `MLX_F_DBLBRACE` | `{{` | +| `MLX_TOK_DBLCLOSEBRACE` | `MLX_F_DBLBRACE` | `}}` | +| `MLX_TOK_SYMBOL` | - | `+-=.,<>` etc. | +| `MLX_TOK_SEMICOLON` | - | `;` | +| `MLX_TOK_SSTRING` | `MLX_F_SSTRING` | Single quote string value, e.g. `'string'`. | +| `MLX_TOK_POUND` | - | `#` | +| `MLX_TOK_MAX` | - | Max token value (internal). | + +### mlxStringVal() +```c +char* mlxStringVal(pLxSession this, int* alloc); +``` +This function gets the string value of the current token. If `alloc` is `NULL`, only the first 255 bytes of the string will be returned, and the rest will be discarded. If `alloc` is non-null and set to 0, the routine will set `alloc` to 1 if it needed to allocate memory for a very long string, otherwise leave it as 0. If `alloc` is non-null and set to 1, this routine will _always allocate memory for the string, whether long or short. + +This routine works no matter what the token type, and returns a string representation of the token if not `MLX_TOK_STRING`. This routine MAY NOT be called twice for the same token. -Note that if MLX_F_ALLOWNUL is enabled, there is no way to tell from the return value of mlxStringVal() whether a NUL in the returned string is the end-of-string terminator, or whether it existed in the input data stream. Thus, this function should not be called when MLX_F_ALLOWNUL is being used. Use mlxCopyToken instead on MLX_TOK_STRING's, as it gives a definitive answer on the token length. (mlxStringVal can still be used on keywords since those will never contain a NUL, by definition). - -### int mlxIntVal(pLxSession this) -Returns the integer value of MLX_TOK_INTEGER tokens, or returns the compare type for MLX_TOK_COMPARE tokens. The compare type is a bitmask of the following flags: +- ⚠️ **Warning**: This function should not be called when `MLX_F_ALLOWNUL` is being used because it may return a null character, giving the caller no way to know whether it is the null-terminator or it simply existed in the input data stream. In this case, `mlxCopyToken()` should be used instead, as it gives a definitive answer on the token length. (`mlxStringVal()` can still be used on keywords, though, since they never contain a null, by definition). -- MLX_CMP_EQUALS -- MLX_CMP_GREATER -- MLX_CMP_LESS +### mlxIntVal() +```c +int mlxIntVal(pLxSession this); +``` +This function returns the integer value of `MLX_TOK_INTEGER` tokens, or returns the compare type for `MLX_TOK_COMPARE` tokens. The compare type is a bitmask of the `MLX_CMP_EQUALS`, `MLX_CMP_GREATER`, and `MLX_CMP_LESS` flags. For `MLX_TOK_DOUBLE` tokens, this function returns the whole part. -For MLX_TOK_DOUBLE tokens, returns the whole part. +### mlxDoubleVal() +```c +double mlxDoubleVal(pLxSession this); +``` +This function returns a double precision floating point number for either `MLX_TOK_INTEGER` or `MLX_TOK_DOUBLE` values. -### double mlxDoubleVal(pLxSession this) -Returns a double precision floating point number for either MLX_TOK_INTEGER or MLX_TOK_DOUBLE values. +### mlxCopyToken() +```c +int mlxCopyToken(pLxSession this, char* buffer, int maxlen); +``` +This function copies the contents of the current token to a string buffer, up to `maxlen` characters. It should be used instead of `mlxStringVal()`, _especially_ where null characters may be involved. This function returns the number of characters copied on success, or -1 on failure, and it can be called multiple times if more data needs to be read from the same token. -### int mlxCopyToken(pLxSession this, char* buffer, int maxlen) -For use instead of mlxStringVal, copies the contents of the current token to a string buffer, up to 'maxlen' characters. Returns the number of characters copied. This function can be called multiple times if more data needs to be read from the token. +### mlxHoldToken() +```c +int mlxHoldToken(pLxSession this); +``` +This function "puts back" a token, causing the next `mlxNextToken()` to return the current token again. This is useful when a function realizes after `mlxNextToken()` that it has read one-too-many. This function returns 0 on success, or -1 if an error occurs. -### int mlxHoldToken(pLxSession this) -Basically causes the next mlxNextToken() to do nothing but return the current token again. Used for when a routine realizes after mlxNextToken() that it has read one-too-many tokens and needs to 'put a token back'. +### mlxSetOptions() +```c +int mlxSetOptions(pLxSession this, int options); +``` +This function sets the options (`MLX_F_xxx`) for an active lexer session. The options that are valid here are `MLX_F_ICASE` and `MLX_F_IFSONLY`. This function returns 0 if successful, or -1 if an error occurs. -### int mlxSetOptions(pLxSession this, int options) -Sets options (MLX_F_xxx) in the middle of a lexer session. The options that are valid here are MLX_F_ICASE and MLX_F_IFSONLY. +### mlxUnsetOptions() +```c +int mlxUnsetOptions(pLxSession this, int options); +``` +Clears options set by [`mlxSetOptions()`](#mlxsetoptions). This function returns 0 if successful, or -1 if an error occurs. -### int mlxUnsetOptions(pLxSession this, int options) -Clears options (see above). +### mlxSetReservedWords() +```c +int mlxSetReservedWords(pLxSession this, char** res_words); +``` +This function sets the lexer to return the list of `res_words` as `MLX_TOK_RESERVEDWD` tokens instead of `MLX_TOK_KEYWORD` tokens. The list of words should be an array of character strings, with the last string in the list being `NULL`. This function returns 0 if successful, or -1 if an error occurs. -### int mlxSetReservedWords(pLxSession this, char** res_words) -Informs the lexer that a certain list of words are to be returned as MLX_TOK_RESERVEDWD instead of MLX_TOK_KEYWORD. The list of words should be an array of character strings, with the last string in the list NULL. mtlexer does not copy this list, so it must be static or have a lifetime greater than that of the lexer session. +- ⚠️ **Warning**: `mtlexer` does not copy this list! Ensure that it has a lifetime longer than that of the lexer session. -### int mlxNoteError(pLxSession this) -Generates an mssError() message of this form: +### mlxNoteError() +```c +int mlxNoteError(pLxSession this); +``` +This function generates an `mssError()` message of the form: +```bash +MLX: Error near '' +``` - MLX: Error near '' +- 📖 **Note**: The calling routine may have detected the error long after the actual place where it occurred. The MLX module just tries to come close :) -NOTE: the calling routine may have detected the error long after the actual place where it occurred. The MLX module just tries to come close :) +### mlxNotePosition() +```c +int mlxNotePosition(pLxSession this); +``` +This function generates an mssError() message of this form: +```bash +MLX: Error at line ## +``` -### int mlxNotePosition(pLxSession this) -Generates an mssError() message of this form: +- 📖 **Note**: If using a `StringSession` instead of a `pFile` session, this may not be accurate, as the string may have come from the middle of a file somewhere. Use with care. - MLX: Error at line ## -NOTE: If using a StringSession instead of a pFile session, this may not be accurate, as the string may have come from the middle of a file somewhere. Use with care. -## VIII Objectsystem Driver Testing -This section contains a list of things that can be done to test an objectsystem driver, to make sure that it is performing all basic operations normally. We will use the test_obj command line interface for testing here. For more information on test_obj commands, see the online Centrallix documentation at: http://www.centrallix.net/docs/docs.php +## XIII Driver Testing +This section contains a list of things that can be done to test an objectsystem driver and ensure that it preforms all basic operations correctly, using the [test_obj command line interface](http://www.centrallix.net/docs/docs.php). -Testing for memory leaks for each of these items is strongly encouraged, by watching memory utilization using nmDeltas() during repetitive operations (e.g., nmDeltas(), open, close, nmDeltas(), open, close, and then nmDeltas() again). +It is strongly recommended to test for invalid reads, writes, frees, and memory leaks during each of these by watching memory utilization using nmDeltas() during repetitive operations (e.g., nmDeltas(), open, close, nmDeltas(), open, close, and then nmDeltas() again). -Testing for more general bugs using the "valgrind" tool is also strongly encouraged, via running these various tests in test_obj while test_obj is running under valgrind. +Testing for more general memory bugs using the "valgrind" tool is also strongly encouraged, via running these various tests in test_obj while test_obj is running under valgrind. To properly test under Valgrind, centrallix-lib must be compiled with the configure flag `--enable-valgrind-integration` turned on. This disables `nmMalloc()` block caching (so that valgrind can properly detect memory leaks and free memory reuse), and it provides better information to valgrind's analyzer regarding MTASK threads. -Magic number checking on data structures is encouraged. To use magic number checking, determine a magic number value for each of your structures, and code that as a constant #define in your code. The magic number should be a 32-bit integer, possibly with 0x00 in either the 2nd or 3rd byte of the integer. Many existing magic number values can be found in the file "magic.h" in centrallix-lib. The 32-bit integer is placed as the first element of the structure, and set using the macro SETMAGIC(), and then tested using the macros ASSERTMAGIC(), and less commonly, ASSERTNOTMAGIC(). ASSERTMAGIC() should be used any time a pointer to the structure crosses an interface boundary. It also may be used at the entry to internal methods/functions, or when traversing linked lists of data structures, or when retrieving data structures from an array. +Magic number checking on data structures is encouraged. To use magic number checking, determine a magic number value for each of your structures, and add a #define for that constant in your code. The magic number should be a 32-bit integer, possibly with 0x00 in either the 2nd or 3rd byte of the integer. Many existing magic number values can be found in [magic.h](../centrallix-lib/include/magic.h). The 32-bit integer is placed as the first element of the structure, and set using the `SETMAGIC()` macro, then tested using the macros `ASSERTMAGIC()` macro or, less commonly, `ASSERTNOTMAGIC()`. Common times to `ASSERTMAGIC()` include: +- Any time a pointer to the structure crosses an interface boundary. +- At the entry to internal methods/functions. +- When traversing linked lists of data structures. +- When retrieving data structures from an array. +- etc. -When used in conjunction with nmMalloc() and nmFree(), ASSERTMAGIC also helps to detect the reuse of already-freed memory, since nmFree() tags the first four bytes of the memory block with the constant MGK_FREEMEM. nmFree() also looks for the constant MGK_FREEMEM in the magic number slot to detect already-freed memory (so do not use that same constant for your own magic numbers). +When used in conjunction with `nmMalloc()` and `nmFree()`, `ASSERTMAGIC` also helps to detect the reuse of already-freed memory, since `nmFree()` tags the first four bytes of the memory block with the constant `MGK_FREEMEM`. `nmFree()` also looks for the constant `MGK_FREEMEM` in the magic number slot to detect already-freed memory. (**DO NOT** use that constant for your own magic numbers!) -To properly test under Valgrind, centrallix-lib must be compiled with the configure flag --enable-valgrind-integration turned on. This disables nmMalloc block caching (so that valgrind can properly detect memory leaks and free memory reuse), and it provides better information to valgrind's analyzer regarding MTASK threads. +The term "**MUST**", as used here, means that the driver will likely cause problems if the functionality is not present. -The term "MUST", as used here, means that the driver will likely cause problems if the functionality is not present. +The term "**SHOULD**" indicates behavior which is desirable, but that might not cause immediate problems if not fully implemented. -The term "SHOULD" indicates behavior which is desirable, but may not cause problems if not fully implemented. +The term "**MAY**" refers to optional, but permissible, behavior. -The term "MAY" refers to optional, but permissible, behavior. -### A. Object opening, closing, creation, and deletion +### A. Opening, closing, creating, and deleting -1. Any object in the driver's subtree, including the node object itself, MUST be able to be opened using objOpen() and then closed using objClose(). Although it does more than just open and close, the "show" command in test_obj can be useful for testing this. +1. Any object in the driver's subtree, including the node object itself, MUST be able to be opened using `xxxOpen()` and then closed using `xxxClose()`. Although it does more than just open and close, the "show" command in test_obj can be useful for testing this. 2. Objects MUST be able to be opened regardless of the location of the node object in the ObjectSystem. For example, don't just test the driver with the node object in the top level directory of the ObjectSystem - also try it in other subdirectories. -3. New objects within the driver's subtree SHOULD be able to be created using objOpen with OBJ_O_CREAT, or using objCreate(). The flags OBJ_O_EXCL and OBJ_O_TRUNC should also be supported, where meaningful. +3. New objects within the driver's subtree SHOULD be able to be created using `xxxOpen()` with `OBJ_O_CREAT`, or using `objCreate()`. The flags `OBJ_O_EXCL` and `OBJ_O_TRUNC` should also be supported, where meaningful. + +4. Where possible, `OBJ_O_AUTONAME` should be supported on object creation. With this, the name of the object will be set to `*` in the pathname structure, and `OBJ_O_CREAT` will also be set. The driver should automatically determine a suitable "name" for the object, and subsequent calls to objGetAttrValue on "name" should return the determined name. A driver MAY choose to return NULL for "name" until after certain object properties have been set and an `xxxCommit()` operation performed. A driver MUST NOT return `*` for the object name unless `*` is truly the name chosen for the object. -4. Where possible, OBJ_O_AUTONAME should be supported on object creation. With this, the name of the object will be set to `*` in the pathname structure, and OBJ_O_CREAT will also be set. The driver should automatically determine a suitable "name" for the object, and subsequent calls to objGetAttrValue on "name" should return the determined name. A driver MAY choose to return NULL for "name" until after certain object properties have been set and an objCommit operation performed. A driver MUST NOT return `*` for the object name unless `*` is truly the name chosen for the object. +5. A driver SHOULD support deletion of any object in its subtree with the exception of the node object itself. Deletion may be done directly with `xxxDelete()`, or on an already-open object using `xxxDeleteObj()`. A driver MAY refuse to delete an object if the object still contains deletable sub-objects. Some objects in the subtree might inherently not be deletable apart from the parent objects of said objects. In those cases, deletion should not succeed. -5. A driver SHOULD support deletion of any object in its subtree with the exception of the node object itself. Deletion may be done directly with objDelete(), or on an already-open object using objDeleteObj(). A driver MAY refuse to delete an object if the object still contains deletable sub-objects. Some objects in the subtree might inherently not be deletable apart from the parent objects of said objects. In those cases, deletion should not succeed. -### B. Object attribute enumeration, getting, and setting. -1. The driver MUST NOT return system attributes (name, inner_type, and so forth) when enumerating with objGetFirst/NextAttr. +### B. Attributes -2. The driver does not need to handle objGetAttrType on the system attributes. The OSML does this. +1. The driver MUST NOT return system attributes (name, inner_type, etc) when enumerating with `xxxGetFirst()`/`xxxNextAttr()`. -3. The driver SHOULD support the attribute last_modification if at all reasonable. Not all objects can have this property however. +2. The driver MAY choose not to handle `xxxGetAttrType` on the system attributes. The OSML handles this. + +3. The driver SHOULD support the attribute `last_modification` if at all reasonable. Not all objects can have this property however. 4. The driver SHOULD support the attribute "annotation" if reasonable to do so. Database drivers should have a configurable "row annotation expression" to auto-generate annotations from existing row content, where reasonable. The driver MAY permit the user to directly set annotation values. The driver MUST return an empty string ("") for any annotation values that are unavailable. @@ -1648,43 +2249,44 @@ The term "MAY" refers to optional, but permissible, behavior. 7. The "show" command in test_obj is a good way to display a list of attributes for an object. -8. Attribute enumeration, retrieval, and modification MUST work equally well on objects returned by objOpen() and objects returned by objQueryFetch(). +8. Attribute enumeration, retrieval, and modification MUST work equally well on objects returned by `xxxOpen()` and objects returned by `xxxQueryFetch()`. -9. If a driver returns an attribute during attribute enumeration, then that attribute MUST return a valid type via objGetAttrType. +9. If a driver returns an attribute during attribute enumeration, then that attribute MUST return a valid type via `xxxGetAttrType`. -10. A driver MUST return -1 and error with a "type mismatch" type of error from objGet/SetAttrValue, if the data type is inappropriate. +10. A driver MUST return -1 and error with a "type mismatch" type of error from `xxxGetAttrValue()`/`xxxSetAttrValue()`, if the data type is inappropriate. 11. A driver MAY choose to perform auto-conversion of data types on certain attributes, but SHOULD NOT perform such auto conversion on a widespread wholesale basis. -12. A driver MAY support the DATA_T_CODE attribute data type. +12. A driver MAY support the `DATA_T_CODE` attribute data type. + +13. Drivers MAY support `DATA_T_INTVEC` and `DATA_T_STRINGVEC`. -13. Drivers MAY support DATA_T_INTVEC and DATA_T_STRINGVEC. +14. Drivers MAY support `xxxAddAttr()` and `xxxOpenAttr()`. -14. Drivers MAY support objAddAttr and objOpenAttr. +15. Drivers MAY support methods on objects. Objects without any methods should be indicated by a `NULL` return value from the method enumeration functions. -15. Drivers MAY support methods on objects. Objects without any methods should be indicated by a NULL return value from the method enumeration functions. +16. When returning attribute values, the value MUST remain valid at least until the next call to `xxxGetAttrValue()`, `xxxSetAttrValue()`, or `xxxGetAttrType()`, or until the object is closed, whichever occurs first. Drivers MUST NOT require the caller to free attribute memory. -16. When returning attribute values, the value MUST remain valid at least until the next call to objGetAttrValue, objSetAttrValue, or objGetAttrType, or until the object is closed, whichever occurs first. Drivers MUST NOT require the caller to free attribute memory. +17. When `xxxSetAttrValue()` is used, drivers MUST NOT depend on the referenced value (in the POD) being valid past the end of the call to `xxxSetAttrValue()`. -17. When objSetAttrValue is used, drivers MUST NOT depend on the referenced value (in the POD) being valid past the end of the call to objSetAttrValue(). -### C. Object querying (for subobjects) +### C. Querying Subobjects -1. If an object cannot support queries for subobjects, the OpenQuery call SHOULD fail. +1. If an object cannot support queries for subobjects, `xxxOpenQuery()` call SHOULD fail. -2. If an object can support the existence of subobjects, but has no subobjects, the OpenQuery should succeed, but calls to QueryFetch MUST return NULL. +2. If an object can support the existence of subobjects, but has no subobjects, the `xxxOpenQuery()` should succeed, but calls to `xxxQueryFetch()` MUST return `NULL`. -3. Objects returned by QueryFetch MUST remain valid even after the query is closed using QueryClose. +3. Objects returned by `xxxQueryFetch()` MUST remain valid even after the query is closed using `xxxQueryClose()`. -4. Objects returned by QueryFetch MUST also be able to be passed to OpenQuery to check for the existence of further subobjects, though the OpenQuery call is permitted to fail as in (C)(1) above. +4. Objects returned by `xxxQueryFetch()` MUST also be able to be passed to `xxxOpenQuery()` to check for the existence of further subobjects, though the `xxxOpenQuery()` call is permitted to fail as in (C)(1) above. -5. Any name returned by objGetAttrValue(name) on a queried subobject MUST be able to be used to open the same object using objOpen(). +5. Any name returned by `xxxGetAttrValue(name)` on a queried subobject MUST be usable to open the same object using `xxxOpen()`. -6. Drivers which connect to resources which are able to perform sorting and/or selection (filtering) of records or objects SHOULD use the OBJ_QY_F_FULLSORT and OBJ_QY_F_FULLQUERY flags (see previous discussion) as well as pass on the sorting and filtering expressions to the remote resource so that resource can do the filtering and/or sorting. +6. Drivers which connect to resources which are able to perform sorting and/or selection (filtering) of records or objects SHOULD use the [`OBJ_QY_F_FULLSORT`](#function-openquery) and [`OBJ_QY_F_FULLQUERY`](#function-openquery) flags. Further, they SHOULD pass on the sorting and filtering expressions to the remote resource so that resource can optimize sorting and/or filtering as needed. -7. If the driver's remote resource can filter and/or sort, but can only do so imperfectly (e.g., the resource cannot handle the potential complexity of all sorting/selection expressions, but can handle parts of them), then OBJ_QY_F_FULLSORT and/or OBJ_QY_F_FULL- QUERY MUST NOT be used. However the remote resource MAY still provide partial sorting and/or selection of data. +7. If the driver's remote resource can filter and/or sort, but can only do so imperfectly (e.g., the resource cannot handle the potential complexity of all sorting/selection expressions, but can handle parts of them), then `OBJ_QY_F_FULLSORT` and/or `OBJ_QY_F_FULL`- QUERY MUST NOT be used. However the remote resource MAY still provide partial sorting and/or selection of data. -8. Drivers SHOULD NOT use OBJ_QY_F_FULLSORT and OBJ_QY_F_FULLQUERY if there is no advantage to letting the resource perform these operations (usually, however, if the resource provides such functionality, there is advantage to letting the resource perform those operations. However, the coding burden to provide the filtering and sorting expressions to the resource, and in the correct format for the resource, may be not worth the work). +8. Drivers SHOULD NOT use `OBJ_QY_F_FULLSORT` and `OBJ_QY_F_FULLQUERY` if there is no advantage to letting the resource perform these operations (usually, however, if the resource provides such functionality, there is advantage to letting the resource perform those operations. However, the coding burden to provide the filtering and sorting expressions to the resource, and in the correct format for the resource, may be not worth the work). 9. Testing of query functionality can be done via test_obj's "query", "csv", and "ls" (or "list") commands. To test for nested querying of objects returned from QueryFetch, a SUBTREE select can be used with the "query" or "csv" commands. diff --git a/centrallix-sysdoc/Prefixes.md b/centrallix-sysdoc/Prefixes.md index b0e12c6b0..30e536324 100644 --- a/centrallix-sysdoc/Prefixes.md +++ b/centrallix-sysdoc/Prefixes.md @@ -4,6 +4,7 @@ |---------|--------------------------------------------------------------------- | aud | OSDriver - Linux OSS /dev/dsp audio (plays WAV files on ExecMethod) | bar | BarCode generator module (for prt mgmt) +| cluster | OSDriver - Cluster & search file | dat | OSDriver - Flat data file (CSV/etc) | ev | MTASK internal - event handling | exp | Expression compiler/parser/evaluator diff --git a/centrallix/Makefile.in b/centrallix/Makefile.in index 0d13843de..827a23b59 100644 --- a/centrallix/Makefile.in +++ b/centrallix/Makefile.in @@ -80,6 +80,7 @@ XSUPPORT=stparse.o \ endorsement_utils.o \ obfuscate.o \ json_util.o \ + double_metaphone.o \ double.o SUPPORT=$(patsubst %,utility/%,$(XSUPPORT)) @@ -316,7 +317,6 @@ XEXPRMODS=exp_main.o \ exp_compiler.o \ exp_evaluate.o \ exp_functions.o \ - exp_double_metaphone.o \ exp_generator.o EXPRMODS=$(patsubst %,expression/%,$(XEXPRMODS)) diff --git a/centrallix/centrallix.c b/centrallix/centrallix.c index 75e19d12d..b8a9e4ea8 100644 --- a/centrallix/centrallix.c +++ b/centrallix/centrallix.c @@ -440,7 +440,7 @@ cxDriverInit() stxInitialize(); /* Structure file driver */ qytInitialize(); /* Query Tree driver */ qypInitialize(); /* Query Pivot driver */ - clusterInitialize(); /* Cluster driver */ + clusterInitialize(); /* Cluster driver */ qyInitialize(); /* stored query (aka view) driver */ rptInitialize(); /* report writer driver */ uxpInitialize(); /* UNIX printer access driver */ diff --git a/centrallix/expression/exp_compiler.c b/centrallix/expression/exp_compiler.c index 702b31f84..3fcd83efb 100644 --- a/centrallix/expression/exp_compiler.c +++ b/centrallix/expression/exp_compiler.c @@ -1074,12 +1074,9 @@ expBindExpression(pExpression exp, pParamObjects objlist, int flags) } cm |= EXPR_MASK_EXTREF; } - else if (exp->ObjID == EXPR_CTL_CURRENT) cm |= (1<<(objlist->CurrentID)); - else if (exp->ObjID == EXPR_CTL_PARENT) cm |= (1<<(objlist->ParentID)); - else if (exp->ObjID >= 0) - { - cm |= (1<<(exp->ObjID)); - } + else if (exp->ObjID == EXPR_OBJID_CURRENT) cm |= (1<<(objlist->CurrentID)); + else if (exp->ObjID == EXPR_OBJID_PARENT) cm |= (1<<(objlist->ParentID)); + else if (exp->ObjID >= 0) cm |= (1<<(exp->ObjID)); } /** Check for absolute references in functions **/ diff --git a/centrallix/expression/exp_double_metaphone.c b/centrallix/expression/exp_double_metaphone.c deleted file mode 100644 index 8b7c4cd6f..000000000 --- a/centrallix/expression/exp_double_metaphone.c +++ /dev/null @@ -1,1521 +0,0 @@ -/************************************************************************/ -/* Text-DoubleMetaphone */ -/* Centrallix Core */ -/* */ -/* Copyright 2000, Maurice Aubrey . */ -/* All rights reserved. */ -/* */ -/* This code is copied for redistribution with modification, from the */ -/* gitpan/Text-DoubleMetaphone implementation on GitHub (1), which is */ -/* under the following license. */ -/* */ -/* This code is based heavily on the C++ implementation by Lawrence */ -/* Philips and incorporates several bug fixes courtesy of Kevin */ -/* Atkinson . */ -/* */ -/* This module is free software; you may redistribute it and/or */ -/* modify it under the same terms as Perl itself. */ -/* */ -/* A summary of the relevant content from https://dev.perl.org/licenses */ -/* has been included below for the convenience of the reader. This */ -/* information was collected and saved on September 5th, 2025 and may */ -/* differ from current information. For the most up to date copy of */ -/* this information, please use the link provided above. */ -/* */ -/* Perl5 is Copyright © 1993 and later, by Larry Wall and others. */ -/* */ -/* It is free software; you can redistribute it and/or modify it */ -/* under the terms of either: */ -/* */ -/* a) the GNU General Public License (2) as published by the Free */ -/* Software Foundation (3); either version 1 (2), or (at your */ -/* option) any later version (4), or */ -/* */ -/* b) the "Artistic License" (5). */ -/* */ -/* Citations: */ -/* 1: https://github.com/gitpan/Text-meta_double_metaphone */ -/* 2: https://dev.perl.org/licenses/gpl1.html */ -/* 3: http://www.fsf.org */ -/* 4: http://www.fsf.org/licenses/licenses.html#GNUGPL */ -/* 5: https://dev.perl.org/licenses/artistic.html */ -/* */ -/* Centrallix is published under the GNU General Public License, */ -/* satisfying the above requirement. A summary of this is included */ -/* below for the convenience of the reader. */ -/* */ -/* This program is free software; you can redistribute it and/or modify */ -/* it under the terms of the GNU General Public License as published by */ -/* the Free Software Foundation; either version 2 of the License, or */ -/* (at your option) any later version. */ -/* */ -/* This program 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 General Public License for more details. */ -/* */ -/* You should have received a copy of the GNU General Public License */ -/* along with this program; if not, write to the Free Software */ -/* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA */ -/* 02111-1307 USA */ -/* */ -/* A copy of the GNU General Public License has been included in this */ -/* distribution in the file "COPYING". */ -/* */ -/* Module: exp_double_metaphone.c */ -/* Author: Maurice Aubrey */ -/* Description: This module implements a "sounds like" algorithm by */ -/* Lawrence Philips which he published in the June, 2000 */ -/* issue of C/C++ Users Journal. Double Metaphone is an */ -/* improved version of the original Metaphone algorithm */ -/* written by Philips'. This implementaton was written by */ -/* Maurice Aubrey for C/C++ with bug fixes provided by */ -/* Kevin Atkinson. It was revised by Israel Fuller to */ -/* better align with the Centrallix coding style and */ -/* standards so that it could be included here. */ -/************************************************************************/ - -/*** Note to future programmers reading this file (by Israel Fuller): - *** - *** This file was copied from a GitHub Repo with proper licensing (in case - *** you didn't read the legal stuff above), so feel free to check it out. - *** - *** As for this code, I've modified it to use styling and memory allocation - *** consistent with the rest of the Centrallix codebase. Also, I have added - *** documentation comments and extensive test cases (at the end of the file), - *** however, these reflect my own (possibly incorrect) understanding, which - *** might not line up with the original author. - *** - *** To be honest, though, trying to make this code as readable as possible - *** was very challenging due to all the messy boolean algebra. If there is - *** ever a professional linguist reading this, please factor out some of the - *** logic into local variables with descriptive names so that the rest of us - *** can read this code without our eyes glazing over. - *** - *** If you have any questions, please feel free to reach out to me or Greg. - *** - *** Original Source: https://github.com/gitpan/Text-meta_double_metaphone - ***/ - -#include -#include -#include -#include -#include -#include - -/*** If running in a testing environment, newmalloc is not - *** available, so we fall back to default C memory allocation. - ***/ -#ifndef TESTING -#include "cxlib/newmalloc.h" -#define META_MALLOC(size) nmSysMalloc(size) -#define META_REALLOC(ptr, size) nmSysRealloc(ptr, size) -#define META_FREE(ptr) nmSysFree(ptr) -#else -#include -#define META_MALLOC(size) malloc(size) -#define META_REALLOC(ptr, size) realloc(ptr, size) -#define META_FREE(ptr) free(ptr) -#endif - -/*** Helper function to handle checking for failed memory allocation - *** Author: Israel Fuller. - *** - *** @param ptr Pointer to the memory that should be allocated. - *** @param fname The name of the function invoked to allocate memory. - *** @param size The amount of memory being allocated. - *** @returns The pointer, for chaining. - ***/ -void* meta_check_allocation(void* ptr, const char* fname, const size_t size) - { - if (ptr == NULL) - { - /** Create the most descriptive error message we can. **/ - char error_buf[BUFSIZ]; - snprintf(error_buf, sizeof(error_buf), "exp_double_metaphone.c: Fail - %s(%lu)", fname, size); - perror(error_buf); - - // Throw error for easier locating in a debugger. - fprintf(stderr, "Program will now crash.\n"); - assert(0); - } - return ptr; - } - -/** Malloc shortcut macros. **/ -#define SAFE_MALLOC(size) \ - ({ \ - const size_t sz = (size); \ - memset(meta_check_allocation(META_MALLOC(sz), "META_MALLOC", sz), 0, sz); \ - }) -#define SAFE_REALLOC(ptr, size) \ - ({ \ - const size_t sz = (size); \ - meta_check_allocation(META_REALLOC(ptr, sz), "META_REALLOC", sz); \ - }) - -typedef struct - { - char* str; - size_t length; - size_t bufsize; - int free_str_on_destroy; - } -MetaString; - -/*** Allocates a new MetaString. - *** - *** @param init_str The initial size of the string. - *** @returns The new MetaString. - ***/ -MetaString* meta_new_string(const char* init_str) - { - MetaString *s; - char empty_string[] = ""; - - s = (MetaString*)SAFE_MALLOC(sizeof(MetaString)); - - if (init_str == NULL) - init_str = empty_string; - - s->length = strlen(init_str); - /** Preallocate a bit more for potential growth. **/ - s->bufsize = s->length + 7u; - - s->str = (char*)SAFE_MALLOC(s->bufsize * sizeof(char)); - - strncpy(s->str, init_str, s->length + 1); - s->free_str_on_destroy = 1; - - return s; - } - -/*** Frees a MetaString. - *** - *** @param s The MetaString. - ***/ -void meta_destroy_string(MetaString* s) - { - if (s == NULL) - return; - - if (s->free_str_on_destroy && s->str != NULL) - META_FREE(s->str); - - META_FREE(s); - } - -/*** Increases a MetaString's buffer size. - *** - *** @param s The MetaString* being modified. - *** @param chars_needed Minimum number of characters to increase buffer size. - ***/ -void meta_increase_buffer(MetaString* s, const size_t chars_needed) - { - s->bufsize += chars_needed + 8u; - s->str = SAFE_REALLOC(s->str, s->bufsize * sizeof(char)); - } - -/*** Convert all characters of a MetaString to uppercase. - *** - *** @param s The MetaString being modified. - ***/ -void meta_make_upper(MetaString* s) - { - for (char* i = s->str; i[0] != '\0'; i++) - *i = (char)toupper(*i); - } - -/*** @param s The MetaString being checked. - *** @param pos The character location to check within the MetaString. - *** @returns 1 if the location is out of bounds for the MetaString, - *** 0 otherwise. - ***/ -bool meta_is_out_of_bounds(MetaString* s, unsigned int pos) - { - return (s->length <= pos); - } - -/*** Checks if a character in a MetaString is a vowel. - *** - *** @param s The MetaString being checked. - *** @param pos The character location to check within the MetaString. - ***/ -bool meta_is_vowel(MetaString* s, unsigned int pos) - { - if (meta_is_out_of_bounds(s, pos)) return 0; - - const char c = *(s->str + pos); - return ((c == 'A') || (c == 'E') || (c == 'I') || - (c == 'O') || (c == 'U') || (c == 'Y')); - } - -/*** Search a MetaString for "W", "K", "CZ", or "WITZ", which indicate that the - *** string is Slavo Germanic. - *** - *** @param s The MetaString to be searched. - *** @returns 1 if the MetaString is Slavo Germanic, or 0 otherwise. - ***/ -bool meta_is_slavo_germanic(MetaString* s) - { - return (strstr(s->str, "W") != NULL) - || (strstr(s->str, "K") != NULL) - || (strstr(s->str, "CZ") != NULL) - || (strstr(s->str, "WITZ") != NULL); - } - -/*** @param s The MetaString being checked. - *** @param pos The character location to check within the MetaString. - *** @returns The character at the position in the MetaString, or - *** '\0' if the position is not in the MetaString. - ***/ -char meta_get_char_at(MetaString* s, unsigned int pos) - { - return (meta_is_out_of_bounds(s, pos)) ? '\0' : ((char) *(s->str + pos)); - } - -/*** Checks for to see if any of a list of strings appear in a the given - *** MetaString after the given start position. - *** - *** @attention - Note that the START value is 0 based. - *** - *** @param s The MetaString being modified. - *** @param start The zero-based start of at which to begin searching - *** within the MetaString. - *** @param length The length of the character strings being checked. - *** @returns 1 if any of the character sequences appear after the start - *** in the MetaString and 0 otherwise. - ***/ -bool meta_is_str_at(MetaString* s, unsigned int start, ...) - { - va_list ap; - - /** Should never happen. **/ - if (meta_is_out_of_bounds(s, start)) - return 0; - - const char* pos = (s->str + start); - va_start(ap, start); - - char* test; - do - { - test = va_arg(ap, char*); - if (*test && (strncmp(pos, test, strlen(test)) == 0)) - return true; - } - while (test[0] != '\0'); - - va_end(ap); - - return false; - } - -/*** Adds a string to a MetaString, expanding the MetaString if needed. - *** - *** @param s The MetaString being modified. - *** @param new_str The string being added. - ***/ -void meta_add_str(MetaString* s, const char* new_str) - { - if (new_str == NULL) - return; - - const size_t add_length = strlen(new_str); - if ((s->length + add_length) > (s->bufsize - 1)) - meta_increase_buffer(s, add_length); - - strcat(s->str, new_str); - s->length += add_length; - } - -/*** Computes double metaphone. - *** - *** Example Usage: - *** ```c - *** char* primary_code; - *** char* secondary_code; - *** meta_double_metaphone(input, &primary_code, &secondary_code); - *** ``` - *** - *** @param str The string to compute. - *** @param primary_code A pointer to a buffer where the pointer to a string - *** containing the produced primary code will be stored. - *** @param secondary_code A pointer to a buffer where the pointer to a string - *** containing the produced secondary code will be stored. - ***/ -void meta_double_metaphone(const char* str, char** primary_code, char** secondary_code) - { - size_t length; - if (str == NULL || (length = strlen(str)) == 0u) { - fprintf(stderr, "Warning: Call to meta_double_metaphone() with invalid string.\n"); - - /** Double Metaphone on an invalid string yields two empty strings. **/ - *primary_code = (char*)SAFE_MALLOC(sizeof(char)); - *secondary_code = (char*)SAFE_MALLOC(sizeof(char)); - return; - } - unsigned int current = 0; - unsigned int last = (unsigned int)(length - 1); - - /** Pad original so we can index beyond end. **/ - MetaString* original = meta_new_string(str); - meta_make_upper(original); - meta_add_str(original, " "); - - MetaString* primary = meta_new_string(""); - MetaString* secondary = meta_new_string(""); - primary->free_str_on_destroy = 0; - secondary->free_str_on_destroy = 0; - - /** Skip these if they are at start of a word. **/ - if (meta_is_str_at(original, 0, "GN", "KN", "PN", "WR", "PS", "")) - current += 1; - - /** Initial 'X' is pronounced 'Z' e.g. 'Xavier' **/ - const char first_char = meta_get_char_at(original, 0); - if (first_char == 'X') - { - meta_add_str(primary, "S"); /* 'Z' maps to 'S' */ - meta_add_str(secondary, "S"); - current += 1; - } - - /** Precomputing this is useful. **/ - const bool is_slavo_germanic = meta_is_slavo_germanic(original); - - /** Main loop. **/ - while (current < length) - { - const char cur_char = meta_get_char_at(original, current); - const char next_char = meta_get_char_at(original, current + 1); - switch (cur_char) - { - case 'A': - case 'E': - case 'I': - case 'O': - case 'U': - case 'Y': - { - if (current == 0) - { - /** All init vowels now map to 'A'. **/ - meta_add_str(primary, "A"); - meta_add_str(secondary, "A"); - } - current += 1; - break; - } - - case 'B': - { - /** "-mb", e.g", "dumb", already skipped over... **/ - meta_add_str(primary, "P"); - meta_add_str(secondary, "P"); - - current += (next_char == 'B') ? 2 : 1; - break; - } - - case 'C': - { - /** Various germanic. **/ - if ( - (current > 1) - && !meta_is_vowel(original, current - 2) - && meta_is_str_at(original, (current - 1), "ACH", "") - && meta_get_char_at(original, current + 2) != 'I' - && ( - meta_get_char_at(original, current + 2) != 'E' - || meta_is_str_at(original, (current - 2), "BACHER", "MACHER", "") - ) - ) - { - meta_add_str(primary, "K"); - meta_add_str(secondary, "K"); - current += 2; - break; - } - - /** Special case 'caesar' **/ - if (current == 0 && meta_is_str_at(original, current, "CAESAR", "")) - { - meta_add_str(primary, "S"); - meta_add_str(secondary, "S"); - current += 2; - break; - } - - /** Italian 'chianti' **/ - if (meta_is_str_at(original, current, "CHIA", "")) - { - meta_add_str(primary, "K"); - meta_add_str(secondary, "K"); - current += 2; - break; - } - - if (meta_is_str_at(original, current, "CH", "")) - { - /** Find 'michael' **/ - if (current > 0 && meta_is_str_at(original, current, "CHAE", "")) - { - meta_add_str(primary, "K"); - meta_add_str(secondary, "X"); - current += 2; - break; - } - - /** Greek roots e.g. 'chemistry', 'chorus' **/ - if ( - current == 0 - && meta_is_str_at(original, (current + 1), "HOR", "HYM", "HIA", "HEM", "HARAC", "HARIS", "") - && !meta_is_str_at(original, 0, "CHORE", "") - ) - { - meta_add_str(primary, "K"); - meta_add_str(secondary, "K"); - current += 2; - break; - } - - /** Germanic, greek, or otherwise 'ch' for 'kh' sound. */ - if ( - meta_is_str_at(original, 0, "SCH", "VAN ", "VON ", "") - /** 'architect but not 'arch', 'orchestra', 'orchid' **/ - || meta_is_str_at(original, (current - 2), "ORCHES", "ARCHIT", "ORCHID", "") - || meta_is_str_at(original, (current + 2), "T", "S", "") - || ( - (current == 0 || meta_is_str_at(original, (current - 1), "A", "O", "U", "E", "")) - /** e.g., 'wachtler', 'wechsler', but not 'tichner' **/ - && meta_is_str_at(original, (current + 2), "L", "R", "N", "M", "B", "H", "F", "V", "W", " ", "") - ) - ) - { - meta_add_str(primary, "K"); - meta_add_str(secondary, "K"); - } - else - { - if (current > 0) - { - if (meta_is_str_at(original, 0, "MC", "")) - { - /* e.g., "McHugh" */ - meta_add_str(primary, "K"); - meta_add_str(secondary, "K"); - } - else - { - meta_add_str(primary, "X"); - meta_add_str(secondary, "K"); - } - } - else - { - meta_add_str(primary, "X"); - meta_add_str(secondary, "X"); - } - } - current += 2; - break; - } - - /** e.g, 'czerny' **/ - if (meta_is_str_at(original, current, "CZ", "") - && !meta_is_str_at(original, (current - 2), "WICZ", "")) - { - meta_add_str(primary, "S"); - meta_add_str(secondary, "X"); - current += 2; - break; - } - - /** e.g., 'focaccia' **/ - if (meta_is_str_at(original, (current + 1), "CIA", "")) - { - meta_add_str(primary, "X"); - meta_add_str(secondary, "X"); - current += 3; - break; - } - - /** Double 'C' rule. **/ - if ( - meta_is_str_at(original, current, "CC", "") - && !(current == 1 && first_char == 'M') /* McClellan exception. */ - ) - { - /** 'bellocchio' but not 'bacchus' **/ - if ( - meta_is_str_at(original, (current + 2), "I", "E", "H", "") - && !meta_is_str_at(original, (current + 2), "HU", "") - ) - { - /** 'accident', 'accede' 'succeed' **/ - if ( - (current == 1 && meta_get_char_at(original, current - 1) == 'A') - || meta_is_str_at(original, (current - 1), "UCCEE", "UCCES", "") - ) - { - meta_add_str(primary, "KS"); - meta_add_str(secondary, "KS"); - /** 'bacci', 'bertucci', other italian **/ - } - else - { - meta_add_str(primary, "X"); - meta_add_str(secondary, "X"); - } - current += 3; - break; - } - else - { /** Pierce's rule **/ - meta_add_str(primary, "K"); - meta_add_str(secondary, "K"); - current += 2; - break; - } - } - - if (meta_is_str_at(original, current, "CK", "CG", "CQ", "")) - { - meta_add_str(primary, "K"); - meta_add_str(secondary, "K"); - current += 2; - break; - } - - if (meta_is_str_at(original, current, "CI", "CE", "CY", "")) - { - /* Italian vs. English */ - if (meta_is_str_at(original, current, "CIO", "CIE", "CIA", "")) - { - meta_add_str(primary, "S"); - meta_add_str(secondary, "X"); - } - else - { - meta_add_str(primary, "S"); - meta_add_str(secondary, "S"); - } - current += 2; - break; - } - - /** else **/ - meta_add_str(primary, "K"); - meta_add_str(secondary, "K"); - - /** Name sent in 'mac caffrey', 'mac gregor **/ - if (meta_is_str_at(original, (current + 1), " C", " Q", " G", "")) - current += 3; - else if (meta_is_str_at(original, (current + 1), "C", "K", "Q", "") - && !meta_is_str_at(original, (current + 1), "CE", "CI", "")) - current += 2; - else - current += 1; - break; - } - - case 'D': - { - if (meta_is_str_at(original, current, "DG", "")) - { - if (meta_is_str_at(original, (current + 2), "I", "E", "Y", "")) - { - /** e.g. 'edge' **/ - meta_add_str(primary, "J"); - meta_add_str(secondary, "J"); - current += 3; - break; - } - else - { - /** e.g. 'edgar' **/ - meta_add_str(primary, "TK"); - meta_add_str(secondary, "TK"); - current += 2; - break; - } - } - - if (meta_is_str_at(original, current, "DT", "DD", "")) - { - meta_add_str(primary, "T"); - meta_add_str(secondary, "T"); - current += 2; - break; - } - - /** else **/ - meta_add_str(primary, "T"); - meta_add_str(secondary, "T"); - current += 1; - break; - } - - case 'F': - { - current += (next_char == 'F') ? 2 : 1; - meta_add_str(primary, "F"); - meta_add_str(secondary, "F"); - break; - } - - case 'G': - { - if (next_char == 'H') - { - /** 'Vghee' */ - if (current > 0 && !meta_is_vowel(original, (current - 1))) - { - meta_add_str(primary, "K"); - meta_add_str(secondary, "K"); - current += 2; - break; - } - - if (current < 3) - { - /** 'ghislane', 'ghiradelli' **/ - if (current == 0) - { - if (meta_get_char_at(original, (current + 2)) == 'I') - { - meta_add_str(primary, "J"); - meta_add_str(secondary, "J"); - } - else - { - meta_add_str(primary, "K"); - meta_add_str(secondary, "K"); - } - current += 2; - break; - } - } - - if ( - /** Parker's rule (with some further refinements) - e.g., 'hugh' **/ - (current > 1 && meta_is_str_at(original, (current - 2), "B", "H", "D", "")) - /** e.g., 'bough' **/ - || (current > 2 && meta_is_str_at(original, (current - 3), "B", "H", "D", "")) - /** e.g., 'broughton' **/ - || (current > 3 && meta_is_str_at(original, (current - 4), "B", "H", "")) - ) - { - current += 2; - break; - } - else - { - /** e.g., 'laugh', 'McLaughlin', 'cough', 'gough', 'rough', 'tough' **/ - if ( - current > 2 - && meta_get_char_at(original, (current - 1)) == 'U' - && meta_is_str_at(original, (current - 3), "C", "G", "L", "R", "T", "") - ) - { - meta_add_str(primary, "F"); - meta_add_str(secondary, "F"); - } - else if (current > 0 && meta_get_char_at(original, (current - 1)) != 'I') - { - meta_add_str(primary, "K"); - meta_add_str(secondary, "K"); - } - - current += 2; - break; - } - } - - if (next_char == 'N') - { - if (current == 1 && !is_slavo_germanic && meta_is_vowel(original, 0)) - { - meta_add_str(primary, "KN"); - meta_add_str(secondary, "N"); - } - else - /** not e.g. 'cagney' **/ - if ( - next_char != 'Y' - && !is_slavo_germanic - && !meta_is_str_at(original, (current + 2), "EY", "") - ) - { - meta_add_str(primary, "N"); - meta_add_str(secondary, "KN"); - } - else - { - meta_add_str(primary, "KN"); - meta_add_str(secondary, "KN"); - } - current += 2; - break; - } - - /** 'tagliaro' **/ - if ( - !is_slavo_germanic - && meta_is_str_at(original, (current + 1), "LI", "") - ) - { - meta_add_str(primary, "KL"); - meta_add_str(secondary, "L"); - current += 2; - break; - } - - /** -ges-,-gep-,-gel-, -gie- at beginning **/ - if ( - current == 0 - && ( - next_char == 'Y' - || meta_is_str_at( - original, (current + 1), - "ES", "EP", "EB", "EL", "EY", "IB", - "IL", "IN", "IE", "EI", "ER", "" - ) - ) - ) - { - meta_add_str(primary, "K"); - meta_add_str(secondary, "J"); - current += 2; - break; - } - - /** -ger-, -gy- **/ - if ( - (next_char == 'Y' || meta_is_str_at(original, (current + 1), "ER", "")) - /** Exceptions. **/ - && !meta_is_str_at(original, 0, "DANGER", "RANGER", "MANGER", "") - && !meta_is_str_at(original, (current - 1), "E", "I", "RGY", "OGY", "") - ) - { - meta_add_str(primary, "K"); - meta_add_str(secondary, "J"); - current += 2; - break; - } - - /** Italian e.g, 'biaggi' **/ - if ( - meta_is_str_at(original, (current + 1), "E", "I", "Y", "") - || meta_is_str_at(original, (current - 1), "AGGI", "OGGI", "") - ) - { - /** Obvious germanic. **/ - if (meta_is_str_at(original, 0, "SCH", "VAN ", "VON ", "") - || meta_is_str_at(original, (current + 1), "ET", "")) - { - meta_add_str(primary, "K"); - meta_add_str(secondary, "K"); - } - else - { - /** Always soft, if french ending. **/ - if (meta_is_str_at(original, (current + 1), "IER ", "")) - { - meta_add_str(primary, "J"); - meta_add_str(secondary, "J"); - } - else - { - meta_add_str(primary, "J"); - meta_add_str(secondary, "K"); - } - } - current += 2; - break; - } - - current += (next_char == 'G') ? 2 : 1; - meta_add_str(primary, "K"); - meta_add_str(secondary, "K"); - break; - } - - case 'H': - { - /** Only keep if first & before vowel or between 2 vowels. **/ - if ( - (current == 0 || meta_is_vowel(original, (current - 1))) - && meta_is_vowel(original, current + 1) - ) - { - meta_add_str(primary, "H"); - meta_add_str(secondary, "H"); - current += 2; - } - else /* also takes care of 'HH' */ - current += 1; - break; - } - - case 'J': - { - /** Obvious spanish, 'jose', 'san jacinto' **/ - const bool has_jose_next = meta_is_str_at(original, current, "JOSE", ""); - const bool starts_with_san = meta_is_str_at(original, 0, "SAN ", ""); - if (has_jose_next || starts_with_san) - { - if ( - starts_with_san - /** I don't know what this condition means. **/ - || (current == 0 && meta_get_char_at(original, current + 4) == ' ') - ) - { - meta_add_str(primary, "H"); - meta_add_str(secondary, "H"); - } - else - { - meta_add_str(primary, "J"); - meta_add_str(secondary, "H"); - } - current += 1; - break; - } - - if (current == 0 && !has_jose_next) - { - meta_add_str(primary, "J"); /* Yankelovich/Jankelowicz */ - meta_add_str(secondary, "A"); - } - else - { - /** spanish pron. of e.g. 'bajador' **/ - if ( - !is_slavo_germanic - && (next_char == 'A' || next_char == 'O') - && meta_is_vowel(original, (current - 1)) - ) - { - meta_add_str(primary, "J"); - meta_add_str(secondary, "H"); - } - else - { - if (current == last) - { - meta_add_str(primary, "J"); - meta_add_str(secondary, ""); - } - else - { - if ( - !meta_is_str_at(original, (current + 1), "L", "T", "K", "S", "N", "M", "B", "Z", "") - && !meta_is_str_at(original, (current - 1), "S", "K", "L", "") - ) - { - meta_add_str(primary, "J"); - meta_add_str(secondary, "J"); - } - } - } - } - - current += (next_char == 'J') ? 2 : 1; - break; - } - - case 'K': - { - current += (next_char == 'K') ? 2 : 1; - meta_add_str(primary, "K"); - meta_add_str(secondary, "K"); - break; - } - - case 'L': - { - if (next_char == 'L') - { - /** Spanish e.g. 'cabrillo', 'gallegos' **/ - if ( - ( - current == length - 3 - && meta_is_str_at(original, (current - 1), "ILLO", "ILLA", "ALLE", "") - ) - || ( - meta_is_str_at(original, (current - 1), "ALLE", "") - && ( - meta_is_str_at(original, (last - 1), "AS", "OS", "") - || meta_is_str_at(original, last, "A", "O", "") - ) - ) - ) - { - meta_add_str(primary, "L"); - meta_add_str(secondary, ""); - current += 2; - break; - } - current += 2; - } - else - current += 1; - meta_add_str(primary, "L"); - meta_add_str(secondary, "L"); - break; - } - - case 'M': - { - current += ( - ( - meta_is_str_at(original, (current - 1), "UMB", "") - && (current + 1 == last || meta_is_str_at(original, (current + 2), "ER", "")) - ) - /** 'dumb','thumb' **/ - || next_char == 'M' - ) ? 2 : 1; - meta_add_str(primary, "M"); - meta_add_str(secondary, "M"); - break; - } - - case 'N': - { - current += (next_char == 'N') ? 2 : 1; - meta_add_str(primary, "N"); - meta_add_str(secondary, "N"); - break; - } - - case 'P': - { - if (next_char == 'H') - { - meta_add_str(primary, "F"); - meta_add_str(secondary, "F"); - current += 2; - break; - } - - /** Also account for "campbell", "raspberry" **/ - current += (meta_is_str_at(original, (current + 1), "P", "B", "")) ? 2 : 1; - meta_add_str(primary, "P"); - meta_add_str(secondary, "P"); - break; - } - - case 'Q': - { - current += (next_char == 'Q') ? 2 : 1; - meta_add_str(primary, "K"); - meta_add_str(secondary, "K"); - break; - } - - case 'R': - { - /** French e.g. 'rogier', but exclude 'hochmeier' **/ - const bool no_primary = ( - !is_slavo_germanic - && current == last - && meta_is_str_at(original, (current - 2), "IE", "") - && !meta_is_str_at(original, (current - 4), "ME", "MA", "") - ); - - meta_add_str(primary, (no_primary) ? "" : "R"); - meta_add_str(secondary, "R"); - current += (next_char == 'R') ? 2 : 1; - break; - } - - case 'S': - { - /** Special cases 'island', 'isle', 'carlisle', 'carlysle' **/ - if (meta_is_str_at(original, (current - 1), "ISL", "YSL", "")) - { - current += 1; - break; - } - - /** Special case 'sugar-' **/ - if (current == 0 && meta_is_str_at(original, current, "SUGAR", "")) - { - meta_add_str(primary, "X"); - meta_add_str(secondary, "S"); - current += 1; - break; - } - - if (meta_is_str_at(original, current, "SH", "")) - { - const bool germanic = meta_is_str_at(original, (current + 1), "HEIM", "HOEK", "HOLM", "HOLZ", ""); - const char* sound = (germanic) ? "S" : "X"; - meta_add_str(primary, sound); - meta_add_str(secondary, sound); - current += 2; - break; - } - - /** Italian & Armenian. **/ - if (meta_is_str_at(original, current, "SIO", "SIA", "SIAN", "")) - { - meta_add_str(primary, "S"); - meta_add_str(secondary, (is_slavo_germanic) ? "S" : "X"); - current += 3; - break; - } - - /** german & anglicisations, e.g. 'smith' match 'schmidt', 'snider' match 'schneider' **/ - /** also, -sz- in slavic language although in hungarian it is pronounced 's' **/ - if (current == 0 && meta_is_str_at(original, (current + 1), "M", "N", "L", "W", "")) - { - meta_add_str(primary, "S"); - meta_add_str(secondary, "X"); - current += 1; - break; - } - if (meta_is_str_at(original, (current + 1), "Z", "")) - { - meta_add_str(primary, "S"); - meta_add_str(secondary, "X"); - current += 2; - break; - } - - if (meta_is_str_at(original, current, "SC", "")) - { - /** Schlesinger's rule. **/ - if (meta_get_char_at(original, current + 2) == 'H') - { - /** Dutch origin, e.g. 'school', 'schooner' **/ - if (meta_is_str_at(original, (current + 3), "OO", "ER", "EN", "UY", "ED", "EM", "")) - { - /** 'schermerhorn', 'schenker' **/ - const bool x_sound = meta_is_str_at(original, (current + 3), "ER", "EN", ""); - meta_add_str(primary, (x_sound) ? "X" : "SK"); - meta_add_str(secondary, "SK"); - current += 3; - break; - } - else - { - const bool s_sound = ( - current == 0 - && !meta_is_vowel(original, 3) - && meta_get_char_at(original, 3) != 'W' - ); - meta_add_str(primary, "X"); - meta_add_str(secondary, (s_sound) ? "S" : "X"); - current += 3; - break; - } - } - - /** Default case. **/ - const char* sound = (meta_is_str_at(original, (current + 2), "E", "I", "Y", "")) ? "S" : "SK"; - meta_add_str(primary, sound); - meta_add_str(secondary, sound); - current += 3; - break; - } - - /** French e.g. 'resnais', 'artois' **/ - const bool no_primary = (current == last && meta_is_str_at(original, (current - 2), "AI", "OI", "")); - meta_add_str(primary, (no_primary) ? "" : "S"); - meta_add_str(secondary, "S"); - current += (meta_is_str_at(original, (current + 1), "S", "Z", "")) ? 2 : 1; - break; - } - - case 'T': - { - if (meta_is_str_at(original, current, "TIA", "TCH", "TION", "")) - { - meta_add_str(primary, "X"); - meta_add_str(secondary, "X"); - current += 3; - break; - } - - if (meta_is_str_at(original, current, "TH", "TTH", "")) - { - /** Special case 'thomas', 'thames' or germanic. **/ - if ( - meta_is_str_at(original, (current + 2), "OM", "AM", "") - || meta_is_str_at(original, 0, "SCH", "VAN ", "VON ", "") - ) - meta_add_str(primary, "T"); - else - meta_add_str(primary, "0"); /* Yes, zero. */ - meta_add_str(secondary, "T"); - current += 2; - break; - } - - meta_add_str(primary, "T"); - meta_add_str(secondary, "T"); - current += (meta_is_str_at(original, (current + 1), "T", "D", "")) ? 2 : 1; - break; - } - - case 'V': - { - meta_add_str(primary, "F"); - meta_add_str(secondary, "F"); - current += (next_char == 'V') ? 2 : 1; - break; - } - - case 'W': - { - /** Can also be in middle of word. **/ - if (meta_is_str_at(original, current, "WR", "")) - { - meta_add_str(primary, "R"); - meta_add_str(secondary, "R"); - current += 2; - break; - } - - const bool next_is_vowel = meta_is_vowel(original, current + 1); - if (current == 0 && (next_is_vowel || meta_is_str_at(original, current, "WH", ""))) - { - /** Wasserman should match Vasserman. **/ - meta_add_str(primary, "A"); - meta_add_str(secondary, (next_is_vowel) ? "F" : "A"); - } - - /** Arnow should match Arnoff. **/ - if ((current == last && meta_is_vowel(original, current - 1)) - || meta_is_str_at(original, (current - 1), "EWSKI", "EWSKY", "OWSKI", "OWSKY", "") - || meta_is_str_at(original, 0, "SCH", "") - ) - { - meta_add_str(primary, ""); - meta_add_str(secondary, "F"); - current += 1; - break; - } - - /** Polish e.g. 'filipowicz' **/ - if (meta_is_str_at(original, current, "WICZ", "WITZ", "")) - { - meta_add_str(primary, "TS"); - meta_add_str(secondary, "FX"); - current += 4; - break; - } - - /** Else skip it. **/ - current += 1; - break; - } - - case 'X': - { - /** French e.g. breaux **/ - const bool silent = ( - current == last - && ( - meta_is_str_at(original, (current - 2), "AU", "OU", "") - || meta_is_str_at(original, (current - 3), "IAU", "EAU", "") - ) - ); - if (!silent) - { - meta_add_str(primary, "KS"); - meta_add_str(secondary, "KS"); - } - - current += (meta_is_str_at(original, (current + 1), "C", "X", "")) ? 2 : 1; - break; - } - - case 'Z': - { - /** Chinese pinyin e.g. 'zhao' **/ - if (next_char == 'H') - { - meta_add_str(primary, "J"); - meta_add_str(secondary, "J"); - current += 2; - break; - } - - const bool has_t_sound = ( - meta_is_str_at(original, (current + 1), "ZO", "ZI", "ZA", "") - || (is_slavo_germanic && current > 0 && meta_get_char_at(original, (current - 1)) != 'T') - ); - meta_add_str(primary, "S"); - meta_add_str(secondary, (has_t_sound) ? "TS" : "S"); - current += (next_char == 'Z') ? 2 : 1; - break; - } - - default: - current += 1; - } - } - - *primary_code = primary->str; - *secondary_code = secondary->str; - - meta_destroy_string(original); - meta_destroy_string(primary); - meta_destroy_string(secondary); - } - -#ifdef TESTING -/*** Built in test cases. - *** - *** These tests have been integrated into the Centrallix testing environment, - *** where they can be run using `export TONLY=exp_fn_double_metaphone_00`, - *** followed by make test, in the Centrallix directory. - *** - *** The can also be run here by executing the following commands in the - *** centrallix/expression directory, which aditionally generates a coverage - *** report. These tests cover all parts of the double metaphone algorithm, - *** although some of the error cases in various helper functions (such as - *** meta_destroy_string(null)) are not covered by testing. - *** - *** Commands: - *** gcc exp_double_metaphone.c -o exp_double_metaphone.o -I .. -DTESTING -fprofile-arcs -ftest-coverage -O0 - *** ./exp_double_metaphone.o - *** gcov exp_double_metaphone.c - ***/ - -unsigned int num_tests_passed = 0u, num_tests_failed = 0u; - -void test(const char* input, const char* expected_primary, const char* expected_secondary) { - char* codes[2]; - - /** Run DoubleMetaphone() and extract results. **/ - char* actual_primary; - char* actual_secondary; - meta_double_metaphone( - input, - memset(&actual_primary, 0, sizeof(actual_primary)), - memset(&actual_secondary, 0, sizeof(actual_secondary)) - ); - - /** Test for correct value. **/ - if (!strcmp(expected_primary, actual_primary) && - !strcmp(expected_secondary, actual_secondary)) - num_tests_passed++; - else - { - printf( - "\nTEST FAILED: \"%s\"\n" - "Expected: %s %s\n" - "Actual: %s %s\n", - input, - expected_primary, expected_secondary, - actual_primary, actual_secondary - ); - num_tests_failed++; - } - } - -// Special thanks to the following websites for double checking the correct results: -// 1: https://words.github.io/double-metaphone -// 2: https://mainegenealogy.net/metaphone_converter.asp -// 3: https://en.toolpage.org/tool/metaphone -void run_tests(void) { - printf("\nRunning tests...\n"); - - /** Test that always fails. **/ - // test("This", "test", "fails."); - - /** Invalid string tests, by Israel. **/ - fprintf(stderr, "There should be two warnings after this line.\n"); - test(NULL, "", ""); - test("", "", ""); - - /** Basic tests, by Israel. **/ - test("Test", "TST", "TST"); - test("Basic", "PSK", "PSK"); - test("Centrallix", "SNTRLKS", "SNTRLKS"); - test("Lawrence", "LRNS", "LRNS"); - test("Philips", "FLPS", "FLPS"); - test("Acceptingness", "AKSPTNNS", "AKSPTNKNS"); - test("Supercalifragilisticexpialidocious", "SPRKLFRJLSTSKSPLTSS", "SPRKLFRKLSTSKSPLTXS"); - test("Suoicodilaipxecitsiligarfilacrepus", "SKTLPKSSTSLKRFLKRPS", "SKTLPKSSTSLKRFLKRPS"); - - /** Match tests from code comments above. **/ - test("Smith", "SM0", "XMT"); - test("Schmidt", "XMT", "SMT"); - test("Snider", "SNTR", "XNTR"); - test("Schneider", "XNTR", "SNTR"); - test("Arnow", "ARN", "ARNF"); - test("Arnoff", "ARNF", "ARNF"); - - /** Tests from examples in code comments above. **/ - test("Accede", "AKST", "AKST"); - test("Accident", "AKSTNT", "AKSTNT"); - test("Actually", "AKTL", "AKTL"); - test("Arch", "ARX", "ARK"); - test("Artois", "ART", "ARTS"); - test("Bacchus", "PKS", "PKS"); - test("Bacci", "PX", "PX"); - test("Bajador", "PJTR", "PHTR"); - test("Bellocchio", "PLX", "PLX"); - test("Bertucci", "PRTX", "PRTX"); - test("Biaggi", "PJ", "PK"); - test("Bough", "P", "P"); - test("Breaux", "PR", "PR"); - test("Broughton", "PRTN", "PRTN"); - test("Cabrillo", "KPRL", "KPR"); - test("Caesar", "SSR", "SSR"); - test("Cagney", "KKN", "KKN"); - test("Campbell", "KMPL", "KMPL"); - test("Carlisle", "KRLL", "KRLL"); - test("Carlysle", "KRLL", "KRLL"); - test("Chemistry", "KMSTR", "KMSTR"); - test("Chianti", "KNT", "KNT"); - test("Chorus", "KRS", "KRS"); - test("Cough", "KF", "KF"); - test("Czerny", "SRN", "XRN"); - test("Dumb", "TM", "TM"); - test("Edgar", "ATKR", "ATKR"); - test("Edge", "AJ", "AJ"); - test("Filipowicz", "FLPTS", "FLPFX"); - test("Focaccia", "FKX", "FKX"); - test("Gallegos", "KLKS", "KKS"); - test("Germanic", "KRMNK", "JRMNK"); - test("Ghiradelli", "JRTL", "JRTL"); - test("Ghislane", "JLN", "JLN"); - test("Gospel", "KSPL", "KSPL"); - test("Gough", "KF", "KF"); - test("Greek", "KRK", "KRK"); - test("Hochmeier", "HKMR", "HKMR"); - test("Hugh", "H", "H"); - test("Island", "ALNT", "ALNT"); - test("Isle", "AL", "AL"); - test("Italian", "ATLN", "ATLN"); - test("Jankelowicz", "JNKLTS", "ANKLFX"); - test("Jose", "HS", "HS"); - test("Laugh", "LF", "LF"); - test("Mac Caffrey", "MKFR", "MKFR"); - test("Mac Gregor", "MKRKR", "MKRKR"); - test("Manager", "MNKR", "MNJR"); - test("McHugh", "MK", "MK"); - test("McLaughlin", "MKLFLN", "MKLFLN"); - test("Michael", "MKL", "MXL"); - test("Middle", "MTL", "MTL"); - test("Orchestra", "ARKSTR", "ARKSTR"); - test("Orchid", "ARKT", "ARKT"); - test("Pinyin", "PNN", "PNN"); - test("Raspberry", "RSPR", "RSPR"); - test("Resnais", "RSN", "RSNS"); - test("Rogier", "RJ", "RJR"); - test("Rough", "RF", "RF"); - test("Salvador", "SLFTR", "SLFTR"); - test("San jacinto", "SNHSNT", "SNHSNT"); - test("Schenker", "XNKR", "SKNKR"); - test("Schermerhorn", "XRMRRN", "SKRMRRN"); - test("Schlesinger", "XLSNKR", "SLSNJR"); - test("School", "SKL", "SKL"); - test("Schooner", "SKNR", "SKNR"); - test("Succeed", "SKST", "SKST"); - test("Sugar", "XKR", "SKR"); - test("Sugary", "XKR", "SKR"); - test("Tagliaro", "TKLR", "TLR"); - test("Thames", "TMS", "TMS"); - test("Thomas", "TMS", "TMS"); - test("Thumb", "0M", "TM"); - test("Tichner", "TXNR", "TKNR"); - test("Tough", "TF", "TF"); - test("Vghee", "FK", "FK"); - test("Wachtler", "AKTLR", "FKTLR"); - test("Wechsler", "AKSLR", "FKSLR"); - test("Word", "ART", "FRT"); - test("Xavier", "SF", "SFR"); - test("Yankelovich", "ANKLFX", "ANKLFK"); - test("Zhao", "J", "J"); - - /** Intereesting Edge Case: "McClellan" **/ - /*** Note: Sources (1) and (3) both include a double K ("MKKLLN"), but the - *** original code on GitHub and mainegenealogy.net do not. I chose "MKLLN" - *** to be correct because I personally do not pronounce the second c. - ***/ - test("McClellan", "MKLLN", "MKLLN"); - - /** Maurice Aubrey's Tests. **/ - /** Source: https://github.com/gitpan/Text-DoubleMetaphone/blob/master/t/words.txt **/ - test("maurice", "MRS", "MRS"); - test("aubrey", "APR", "APR"); - test("cambrillo", "KMPRL", "KMPR"); - test("heidi", "HT", "HT"); - test("katherine", "K0RN", "KTRN"); - test("catherine", "K0RN", "KTRN"); - test("richard", "RXRT", "RKRT"); - test("bob", "PP", "PP"); - test("eric", "ARK", "ARK"); - test("geoff", "JF", "KF"); - test("dave", "TF", "TF"); - test("ray", "R", "R"); - test("steven", "STFN", "STFN"); - test("bryce", "PRS", "PRS"); - test("randy", "RNT", "RNT"); - test("bryan", "PRN", "PRN"); - test("brian", "PRN", "PRN"); - test("otto", "AT", "AT"); - test("auto", "AT", "AT"); - - /** GPT-5 Coverage Tests. **/ - /*** GPT-5 mini (Preview) running in GitHub Copilot suggested the words - *** after analizing a generated coverage report, and I (Israel) used - *** them to write the tests below. I kept the AI's reasoning for tests, - *** while removing tests that did not contribute any coverage, but after - *** a few reprompts, the AI started just giving words without reasoning. - *** I guess we were both getting pretty tired. - ***/ - test("Abbott", "APT", "APT"); /* double-B ("BB") handling. */ - test("Back", "PK", "PK"); /* "CK"/"CG"/"CQ" branch. */ - test("Bacher", "PKR", "PKR"); /* matches "...BACHER" / ACH special-case. */ - test("Charles", "XRLS", "XRLS"); /* initial "CH" -> the branch that maps to "X"/"X" at start. */ - test("Ghana", "KN", "KN"); /* initial "GH" special-start handling. */ - test("Gnome", "NM", "NM"); /* "GN" sequence handling. */ - test("Raj", "RJ", "R"); /* J at end (exercise J-last behavior). */ - test("Quentin", "KNTN", "KNTN"); /* Q case (Q -> K mapping). */ - test("Who", "A", "A"); /* "WH" at start handling. */ - test("Shoemaker", "XMKR", "XMKR"); /* "SH" general mapping paths. */ - test("Sian", "SN", "XN"); /* "SIO"/"SIA"/"SIAN" branch. */ - test("Scold", "SKLT", "SKLT"); /* "SC" default / "SK" vs other SC subcases. */ - test("Station", "STXN", "STXN"); /* "TION" -> X mapping. */ - test("Match", "MX", "MX"); /* "TCH"/"TIA" -> X mapping. */ - test("Pizza", "PS", "PTS"); /* double-Z ("ZZ") handling. */ - test("Agnes", "AKNS", "ANS"); /* "GN" at index 1 (GN handling that yields KN / N). */ - test("Science", "SNS", "SNS"); /* "SC" followed by I (SC + I/E/Y branch). */ - test("Van Gogh", "FNKK", "FNKK"); - test("Josef", "JSF", "HSF"); - test("Object", "APJKT", "APJKT"); - test("Sholz", "SLS", "SLS"); - test("Scharf", "XRF", "XRF"); - test("Kasia", "KS", "KS"); - test("Van Geller", "FNKLR", "FNKLR"); - - const unsigned int total_tests = num_tests_passed + num_tests_failed; - printf("\nTests completed!\n"); - printf(" > Failed: %u\n", num_tests_failed); - printf(" > Skipped: %u\n", 0u); /* Implementation removed. */ - printf(" > Passed: %u/%u\n", num_tests_passed, total_tests); -} - -int main(void) { - run_tests(); - return 0; -} - -/** Prevent scope leak. **/ -#undef META_FREE -#undef META_MALLOC -#undef META_REALLOC -#undef SAFE_MALLOC -#undef SAFE_REALLOC - -#endif diff --git a/centrallix/expression/exp_functions.c b/centrallix/expression/exp_functions.c index b2e3e84a8..474f5b1dc 100644 --- a/centrallix/expression/exp_functions.c +++ b/centrallix/expression/exp_functions.c @@ -71,34 +71,11 @@ #include "cxlib/xarray.h" #include "cxlib/xhash.h" #include "cxss/cxss.h" +#include "double_metaphone.h" #include "expression.h" #include "obj.h" -/** TODO: Greg - I think this should be moved to datatypes. **/ -/** Should maybe replace duplocate functionality elsewhere. **/ -static char* ci_TypeToStr(const int type) - { - switch (type) - { - case DATA_T_UNAVAILABLE: return "Unknown"; - case DATA_T_INTEGER: return "Integer"; - case DATA_T_STRING: return "String"; - case DATA_T_DOUBLE: return "Double"; - case DATA_T_DATETIME: return "DateTime"; - case DATA_T_INTVEC: return "IntVector"; - case DATA_T_STRINGVEC: return "StringVector"; - case DATA_T_MONEY: return "Money"; - case DATA_T_ARRAY: return "Array"; - case DATA_T_CODE: return "Code"; - case DATA_T_BINARY: return "Binary"; - } - - /** Invalid type. **/ - mssErrorf(1, "Cluster", "Invalid type %d.\n", type); - return "Invalid"; /* Shall not parse to a valid type in ci_TypeFromStr(). */ - } - /****** Evaluator functions follow for expEvalFunction ******/ int exp_fn_getdate(pExpression tree, pParamObjects objlist, pExpression i0, pExpression i1, pExpression i2) @@ -1253,31 +1230,6 @@ int exp_fn_rtrim(pExpression tree, pParamObjects objlist, pExpression i0, pExpre } -int exp_fn_trim(pExpression tree, pParamObjects objlist, pExpression i0, pExpression i1, pExpression i2) - { - int ret; - - /** Invoke left trim. **/ - ret = exp_fn_ltrim(tree, objlist, i0, i1, i2); - if (ret != 0) - { - mssErrorf(0, "EXP", "Failed to left trim (error code: %d).", ret); - return ret; - } - - /** Invoke right trim. **/ - ret = exp_fn_rtrim(tree, objlist, i0, i1, i2); - if (ret != 0) - { - mssErrorf(0, "EXP", "Failed to right trim (error code: %d).", ret); - return ret; - } - - /** Success. **/ - return 0; - } - - int exp_fn_right(pExpression tree, pParamObjects objlist, pExpression i0, pExpression i1, pExpression i2) { int n,i; @@ -2432,7 +2384,7 @@ int exp_fn_constrain(pExpression tree, pParamObjects objlist, pExpression i0, pE { mssError(1, "EXP", "constrain() expects three numeric parameters: %s is not numeric.", - ci_TypeToStr(i0->DataType) + objTypeToStr(i0->DataType) ); if (i0->DataType == DATA_T_STRING) printf("Value: '%s'\n", i0->String); return -1; @@ -2441,7 +2393,7 @@ int exp_fn_constrain(pExpression tree, pParamObjects objlist, pExpression i0, pE { mssError(1, "EXP", "constrain() expects three numeric parameters of the same data type but got types %s, %s, and %s.", - ci_TypeToStr(i0->DataType), ci_TypeToStr(i1->DataType), ci_TypeToStr(i2->DataType) + objTypeToStr(i0->DataType), objTypeToStr(i1->DataType), objTypeToStr(i2->DataType) ); return -1; } @@ -4158,51 +4110,43 @@ static int exp_fn_verify_schema( pExpression tree, pParamObjects obj_list) { - /** Verify object list and session. **/ - if (obj_list == NULL) - { - mssErrorf(1, "EXP", "%s(\?\?\?) no object list?", fn_name); - return -1; - } - ASSERTMAGIC(obj_list->Session, MGK_OBJSESSION); - - /** Verify expression tree. **/ - ASSERTMAGIC(tree, MGK_EXPRESSION); - - /** Verify parameter number. **/ - const int num_params_actual = tree->Children.nItems; - if (num_params != num_params_actual) - { - mssErrorf(1, "EXP", - "%s(?) expects %u param%s, got %d param%s.", - fn_name, num_params, (num_params > 1) ? "s" : "", num_params_actual, (num_params_actual > 1) ? "s" : "" - ); - return -1; - } - - /** Verify parameter datatypes. **/ - for (int i = 0; i < num_params; i++) - { - const pExpression arg = tree->Children.Items[i]; - ASSERTMAGIC(arg, MGK_EXPRESSION); - - /** Skip null values. **/ - if (arg->Flags & EXPR_F_NULL) continue; - - /** Extract datatypes. **/ - const int expected_datatype = param_types[i]; - const int actual_datatype = arg->DataType; + /** Verify expression tree. **/ + ASSERTMAGIC(tree, MGK_EXPRESSION); - /** Verify datatypes. **/ - if (expected_datatype != actual_datatype) + /** Verify parameter number. **/ + const int num_params_actual = tree->Children.nItems; + if (num_params != num_params_actual) { mssErrorf(1, "EXP", - "%s(...) param #%d/%d expects type %s (%d) but got type %s (%d).", - fn_name, i + 1, num_params, ci_TypeToStr(expected_datatype), expected_datatype, ci_TypeToStr(actual_datatype), actual_datatype + "%s(?) expects %u param%s, got %d param%s.", + fn_name, num_params, (num_params > 1) ? "s" : "", num_params_actual, (num_params_actual > 1) ? "s" : "" ); return -1; } - } + + /** Verify parameter datatypes. **/ + for (int i = 0; i < num_params; i++) + { + const pExpression arg = tree->Children.Items[i]; + ASSERTMAGIC(arg, MGK_EXPRESSION); + + /** Skip null values. **/ + if (arg->Flags & EXPR_F_NULL) continue; + + /** Extract datatypes. **/ + const int expected_datatype = param_types[i]; + const int actual_datatype = arg->DataType; + + /** Verify datatypes. **/ + if (expected_datatype != actual_datatype) + { + mssErrorf(1, "EXP", + "%s(...) param #%d/%d expects type %s (%d) but got type %s (%d).", + fn_name, i + 1, num_params, objTypeToStr(expected_datatype), expected_datatype, objTypeToStr(actual_datatype), actual_datatype + ); + return -1; + } + } /** Pass. **/ return 0; @@ -4213,44 +4157,60 @@ int exp_fn_metaphone(pExpression tree, pParamObjects obj_list) { const char fn_name[] = "metaphone"; - /** Verify function schema. **/ - if (exp_fn_verify_schema(fn_name, (int[]){ DATA_T_STRING }, 1, tree, obj_list) != 0) - { - mssErrorf(0, "EXP", "%s(?) Call does not match function schema.", fn_name); - return -1; - } + /** Verify function schema. **/ + if (exp_fn_verify_schema(fn_name, (int[]){ DATA_T_STRING }, 1, tree, obj_list) != 0) + { + mssErrorf(0, "EXP", "%s(?) Call does not match function schema.", fn_name); + return -1; + } + + /** Allocate space to store metaphone pointers. **/ + char* primary = NULL; + char* secondary = NULL; + + /** Extract string param. **/ + pExpression maybe_str = check_ptr(tree->Children.Items[0]); + if (maybe_str->Flags & EXPR_F_NULL) + { + tree->Flags |= EXPR_F_NULL; + tree->DataType = DATA_T_STRING; + return 0; + } + const char* str = check_ptr(maybe_str->String); + const size_t str_len = strlen(str); + if (str_len == 0u) + { + primary = ""; + secondary = ""; + goto store_data; + } + + /** Compute DoubleMetaphone. **/ + meta_double_metaphone(str, &primary, &secondary); + + /** Find memory to store the result. **/ + store_data:; + const size_t result_length = strlen(primary) + 1u + strlen(secondary) + 1u; + if (tree->Alloc == 1) nmSysFree(tree->String); + if (result_length < 64) + { + /** We can use the preallocated buffer. **/ + tree->String = tree->Types.StringBuf; + tree->Alloc = 0; + } + else + { + char* result = check_ptr(nmSysMalloc(result_length * sizeof(char*))); + if (result == NULL) return -1; + tree->String = result; + } + + /** Write the result into the selected memory. **/ + sprintf(tree->String, "%s%c%s", primary, CA_BOUNDARY_CHAR, secondary); - /** Extract string param. **/ - pExpression maybe_str = check_ptr(tree->Children.Items[0]); - if (maybe_str->Flags & EXPR_F_NULL) - { - tree->Flags |= EXPR_F_NULL; + /** Return the result. **/ tree->DataType = DATA_T_STRING; - return 0; - } - const char* str = check_ptr(maybe_str->String); - const size_t str_len = strlen(str); - if (str_len == 0u) - { - tree->String = ""; - tree->DataType = DATA_T_STRING; - return 0; - } - - /** Compute DoubleMetaphone. **/ - char* primary = NULL; - char* secondary = NULL; - meta_double_metaphone(str, &primary, &secondary); - /** Process result. **/ - const size_t result_length = strlen(primary) + 1u + strlen(secondary) + 1u; - char* result = check_ptr(nmSysMalloc(result_length * sizeof(char*))); - if (result == NULL) return -1; - sprintf(result, "%s%c%s", primary, CA_BOUNDARY_CHAR, secondary); - - /** Return the result. **/ - tree->String = result; - tree->DataType = DATA_T_STRING; return 0; } @@ -4266,69 +4226,70 @@ int exp_fn_metaphone(pExpression tree, pParamObjects obj_list) ***/ static int exp_fn_compare(pExpression tree, pParamObjects obj_list, const char* fn_name) { - /** Verify function schema. **/ - if (exp_fn_verify_schema(fn_name, (int[]){ DATA_T_STRING, DATA_T_STRING }, 2, tree, obj_list) != 0) - { - mssErrorf(0, "EXP", "%s(?) Call does not match function schema.", fn_name); - return -1; - } - - /** Extract strings. **/ - pExpression maybe_str1 = check_ptr(tree->Children.Items[0]); - pExpression maybe_str2 = check_ptr(tree->Children.Items[1]); - if (maybe_str1->Flags & EXPR_F_NULL || maybe_str2->Flags & EXPR_F_NULL) - { - tree->Flags |= EXPR_F_NULL; - tree->DataType = DATA_T_DOUBLE; - return 0; - } - char* str1 = check_ptr(maybe_str1->String); - char* str2 = check_ptr(maybe_str2->String); - - /** Handle either cos_compare() or lev_compare(). **/ - if (fn_name[0] == 'c') - { /* cos_compare() */ - int ret; - - /** Build vectors. **/ - const pVector v1 = check_ptr(ca_build_vector(str1)); - const pVector v2 = check_ptr(ca_build_vector(str2)); - if (v1 == NULL || v2 == NULL) + /** Verify function schema. **/ + if (exp_fn_verify_schema(fn_name, (int[]){ DATA_T_STRING, DATA_T_STRING }, 2, tree, obj_list) != 0) { - mssErrorf(1, "EXP", - "%s(\"%s\", \"%s\") - Failed to build vectors.", - fn_name, str1, str2 - ); - ret = -1; + mssErrorf(0, "EXP", "%s(?) Call does not match function schema.", fn_name); + return -1; } - else + + /** Extract strings. **/ + pExpression maybe_str1 = check_ptr(tree->Children.Items[0]); + pExpression maybe_str2 = check_ptr(tree->Children.Items[1]); + if (maybe_str1->Flags & EXPR_F_NULL || maybe_str2->Flags & EXPR_F_NULL) { - /** Compute the similarity. **/ - tree->Types.Double = ca_cos_compare(v1, v2); + tree->Flags |= EXPR_F_NULL; tree->DataType = DATA_T_DOUBLE; - ret = 0; + return 0; } + char* str1 = check_ptr(maybe_str1->String); + char* str2 = check_ptr(maybe_str2->String); - /** Clean up. **/ - if (v1 != NULL) ca_free_vector(v1); - if (v2 != NULL) ca_free_vector(v2); - return ret; - } - else - { /* lev_compare() */ - double lev_sim = check_double(ca_lev_compare(str1, str2)); - if (isnan(lev_sim)) - { - mssErrorf(1, "EXP", "%s(\"%s\", \"%s\") Failed to compute levenstein edit distance."); - return -1; + /** Handle either cos_compare() or lev_compare(). **/ + if (fn_name[0] == 'c') + { /* cos_compare() */ + int ret; + + /** Build vectors. **/ + const pVector v1 = check_ptr(ca_build_vector(str1)); + const pVector v2 = check_ptr(ca_build_vector(str2)); + if (v1 == NULL || v2 == NULL) + { + mssErrorf(1, "EXP", + "%s(\"%s\", \"%s\") - Failed to build vectors.", + fn_name, str1, str2 + ); + ret = -1; + } + else + { + /** Compute the similarity. **/ + tree->Types.Double = ca_cos_compare(v1, v2); + tree->DataType = DATA_T_DOUBLE; + ret = 0; + } + + /** Clean up. **/ + if (v1 != NULL) ca_free_vector(v1); + if (v2 != NULL) ca_free_vector(v2); + return ret; + } + else + { /* lev_compare() */ + double lev_sim = check_double(ca_lev_compare(str1, str2)); + if (isnan(lev_sim)) + { + mssErrorf(1, "EXP", "%s(\"%s\", \"%s\") Failed to compute levenstein edit distance."); + return -1; + } + + /** Return the computed result. **/ + tree->Types.Double = lev_sim; + tree->DataType = DATA_T_DOUBLE; + return 0; } - /** Return the computed result. **/ - tree->Types.Double = lev_sim; - tree->DataType = DATA_T_DOUBLE; - return 0; - } - return -1; + return -1; } @@ -4346,37 +4307,38 @@ int exp_fn_levenshtein(pExpression tree, pParamObjects obj_list) { const char fn_name[] = "levenshtein"; - /** Verify function schema. **/ - if (exp_fn_verify_schema(fn_name, (int[]){ DATA_T_STRING, DATA_T_STRING }, 2, tree, obj_list) != 0) - { - mssErrorf(0, "EXP", "%s(?) Call does not match function schema.", fn_name); - return -1; - } + /** Verify function schema. **/ + if (exp_fn_verify_schema(fn_name, (int[]){ DATA_T_STRING, DATA_T_STRING }, 2, tree, obj_list) != 0) + { + mssErrorf(0, "EXP", "%s(?) Call does not match function schema.", fn_name); + return -1; + } + + /** Extract strings. **/ + pExpression maybe_str1 = check_ptr(tree->Children.Items[0]); + pExpression maybe_str2 = check_ptr(tree->Children.Items[1]); + if (maybe_str1->Flags & EXPR_F_NULL || maybe_str2->Flags & EXPR_F_NULL) + { + tree->Flags |= EXPR_F_NULL; + tree->DataType = DATA_T_INTEGER; + return 0; + } + char* str1 = check_ptr(maybe_str1->String); + char* str2 = check_ptr(maybe_str2->String); + + /** Compute edit distance. **/ + /** Length 0 is provided for both strings so that the function will compute it for us. **/ + int edit_dist = ca_edit_dist(str1, str2, 0lu, 0lu); + if (!check_neg(edit_dist)) + { + mssErrorf(1, "EXP", "%s(\"%s\", \"%s\") Failed to compute edit distance.\n", fn_name, str1, str2); + return -1; + } - /** Extract strings. **/ - pExpression maybe_str1 = check_ptr(tree->Children.Items[0]); - pExpression maybe_str2 = check_ptr(tree->Children.Items[1]); - if (maybe_str1->Flags & EXPR_F_NULL || maybe_str2->Flags & EXPR_F_NULL) - { - tree->Flags |= EXPR_F_NULL; + /** Return the computed distance. **/ + tree->Integer = edit_dist; tree->DataType = DATA_T_INTEGER; - return 0; - } - char* str1 = check_ptr(maybe_str1->String); - char* str2 = check_ptr(maybe_str2->String); - /** Compute edit distance. **/ - /** Length 0 is provided for both strings so that the function will compute it for us. **/ - int edit_dist = ca_edit_dist(str1, str2, 0lu, 0lu); - if (!check_neg(edit_dist)) - { - mssErrorf(1, "EXP", "%s(\"%s\", \"%s\") Failed to compute edit distance.\n", fn_name, str1, str2); - return -1; - } - - /** Return the computed distance. **/ - tree->Integer = edit_dist; - tree->DataType = DATA_T_INTEGER; return 0; } @@ -4503,42 +4465,27 @@ int exp_fn_argon2id(pExpression tree, pParamObjects objlist, pExpression passwor int exp_internal_DefineFunctions() { - /** Initialize library. **/ + /** Initialize clustering library. **/ ca_init(); - /** Function list for EXPR_N_FUNCTION nodes. **/ - - /** General. **/ + /** Function list for EXPR_N_FUNCTION nodes **/ + xhAdd(&EXP.Functions, "getdate", (char*)exp_fn_getdate); xhAdd(&EXP.Functions, "user_name", (char*)exp_fn_user_name); xhAdd(&EXP.Functions, "convert", (char*)exp_fn_convert); xhAdd(&EXP.Functions, "wordify", (char*)exp_fn_wordify); xhAdd(&EXP.Functions, "abs", (char*)exp_fn_abs); xhAdd(&EXP.Functions, "ascii", (char*)exp_fn_ascii); xhAdd(&EXP.Functions, "condition", (char*)exp_fn_condition); - xhAdd(&EXP.Functions, "isnull", (char*)exp_fn_isnull); - xhAdd(&EXP.Functions, "eval", (char*)exp_fn_eval); - xhAdd(&EXP.Functions, "truncate", (char*)exp_fn_truncate); - xhAdd(&EXP.Functions, "constrain", (char*)exp_fn_constrain); - xhAdd(&EXP.Functions, "has_endorsement", (char*)exp_fn_has_endorsement); - xhAdd(&EXP.Functions, "rand", (char*)exp_fn_rand); - xhAdd(&EXP.Functions, "nullif", (char*)exp_fn_nullif); - xhAdd(&EXP.Functions, "hash", (char*)exp_fn_hash); - xhAdd(&EXP.Functions, "hmac", (char*)exp_fn_hmac); - xhAdd(&EXP.Functions, "pbkdf2", (char*)exp_fn_pbkdf2); - xhAdd(&EXP.Functions, "octet_length", (char*)exp_fn_octet_length); - xhAdd(&EXP.Functions, "argon2id",(char*)exp_fn_argon2id); - - /** Dates. **/ - xhAdd(&EXP.Functions, "getdate", (char*)exp_fn_getdate); + xhAdd(&EXP.Functions, "charindex", (char*)exp_fn_charindex); + xhAdd(&EXP.Functions, "upper", (char*)exp_fn_upper); + xhAdd(&EXP.Functions, "lower", (char*)exp_fn_lower); + xhAdd(&EXP.Functions, "mixed", (char*)exp_fn_mixed); + xhAdd(&EXP.Functions, "char_length", (char*)exp_fn_char_length); xhAdd(&EXP.Functions, "datepart", (char*)exp_fn_datepart); - xhAdd(&EXP.Functions, "dateadd", (char*)exp_fn_dateadd); - xhAdd(&EXP.Functions, "datediff", (char*)exp_fn_datediff); - - /** Strings. **/ + xhAdd(&EXP.Functions, "isnull", (char*)exp_fn_isnull); xhAdd(&EXP.Functions, "ltrim", (char*)exp_fn_ltrim); xhAdd(&EXP.Functions, "lztrim", (char*)exp_fn_lztrim); xhAdd(&EXP.Functions, "rtrim", (char*)exp_fn_rtrim); - xhAdd(&EXP.Functions, "trim", (char*)exp_fn_trim); xhAdd(&EXP.Functions, "substring", (char*)exp_fn_substring); xhAdd(&EXP.Functions, "right", (char*)exp_fn_right); xhAdd(&EXP.Functions, "ralign", (char*)exp_fn_ralign); @@ -4548,22 +4495,12 @@ int exp_internal_DefineFunctions() xhAdd(&EXP.Functions, "escape", (char*)exp_fn_escape); xhAdd(&EXP.Functions, "quote", (char*)exp_fn_quote); xhAdd(&EXP.Functions, "substitute", (char*)exp_fn_substitute); - xhAdd(&EXP.Functions, "upper", (char*)exp_fn_upper); - xhAdd(&EXP.Functions, "lower", (char*)exp_fn_lower); - xhAdd(&EXP.Functions, "mixed", (char*)exp_fn_mixed); - xhAdd(&EXP.Functions, "char_length", (char*)exp_fn_char_length); - xhAdd(&EXP.Functions, "charindex", (char*)exp_fn_charindex); - xhAdd(&EXP.Functions, "dateformat", (char*)exp_fn_dateformat); - xhAdd(&EXP.Functions, "moneyformat", (char*)exp_fn_moneyformat); - - /** Numbering systems (e.g. base 16 aka. hex, base 8 aka. octal, etc.). **/ - xhAdd(&EXP.Functions, "to_base64", (char*)exp_fn_to_base64); - xhAdd(&EXP.Functions, "from_base64", (char*)exp_fn_from_base64); - xhAdd(&EXP.Functions, "to_hex", (char*)exp_fn_to_hex); - xhAdd(&EXP.Functions, "from_hex", (char*)exp_fn_from_hex); - - /** Math. **/ + xhAdd(&EXP.Functions, "eval", (char*)exp_fn_eval); xhAdd(&EXP.Functions, "round", (char*)exp_fn_round); + xhAdd(&EXP.Functions, "dateadd", (char*)exp_fn_dateadd); + xhAdd(&EXP.Functions, "datediff", (char*)exp_fn_datediff); + xhAdd(&EXP.Functions, "truncate", (char*)exp_fn_truncate); + xhAdd(&EXP.Functions, "constrain", (char*)exp_fn_constrain); xhAdd(&EXP.Functions, "sin", (char*)exp_fn_sin); xhAdd(&EXP.Functions, "cos", (char*)exp_fn_cos); xhAdd(&EXP.Functions, "tan", (char*)exp_fn_tan); @@ -4575,23 +4512,35 @@ int exp_internal_DefineFunctions() xhAdd(&EXP.Functions, "square", (char*)exp_fn_square); xhAdd(&EXP.Functions, "degrees", (char*)exp_fn_degrees); xhAdd(&EXP.Functions, "radians", (char*)exp_fn_radians); + xhAdd(&EXP.Functions, "has_endorsement", (char*)exp_fn_has_endorsement); + xhAdd(&EXP.Functions, "rand", (char*)exp_fn_rand); + xhAdd(&EXP.Functions, "nullif", (char*)exp_fn_nullif); + xhAdd(&EXP.Functions, "dateformat", (char*)exp_fn_dateformat); + xhAdd(&EXP.Functions, "moneyformat", (char*)exp_fn_moneyformat); + xhAdd(&EXP.Functions, "hash", (char*)exp_fn_hash); + xhAdd(&EXP.Functions, "hmac", (char*)exp_fn_hmac); xhAdd(&EXP.Functions, "log10", (char*)exp_fn_log10); xhAdd(&EXP.Functions, "ln", (char*)exp_fn_log_natural); xhAdd(&EXP.Functions, "logn", (char*)exp_fn_log_base_n); xhAdd(&EXP.Functions, "power", (char*)exp_fn_power); - - /** Duplicate detection. **/ + xhAdd(&EXP.Functions, "pbkdf2", (char*)exp_fn_pbkdf2); xhAdd(&EXP.Functions, "metaphone", (char*)exp_fn_metaphone); - xhAdd(&EXP.Functions, "cos_compare", (char*)exp_fn_cos_compare); - xhAdd(&EXP.Functions, "lev_compare", (char*)exp_fn_lev_compare); xhAdd(&EXP.Functions, "levenshtein", (char*)exp_fn_levenshtein); - - /** Windowing. **/ + xhAdd(&EXP.Functions, "lev_compare", (char*)exp_fn_lev_compare); + xhAdd(&EXP.Functions, "cos_compare", (char*)exp_fn_cos_compare); + xhAdd(&EXP.Functions, "to_base64", (char*)exp_fn_to_base64); + xhAdd(&EXP.Functions, "from_base64", (char*)exp_fn_from_base64); + xhAdd(&EXP.Functions, "to_hex", (char*)exp_fn_to_hex); + xhAdd(&EXP.Functions, "from_hex", (char*)exp_fn_from_hex); + xhAdd(&EXP.Functions, "octet_length", (char*)exp_fn_octet_length); + xhAdd(&EXP.Functions, "argon2id",(char*)exp_fn_argon2id); + + /** Windowing **/ xhAdd(&EXP.Functions, "row_number", (char*)exp_fn_row_number); xhAdd(&EXP.Functions, "dense_rank", (char*)exp_fn_dense_rank); xhAdd(&EXP.Functions, "lag", (char*)exp_fn_lag); - /** Aggregate. **/ + /** Aggregate **/ xhAdd(&EXP.Functions, "count", (char*)exp_fn_count); xhAdd(&EXP.Functions, "avg", (char*)exp_fn_avg); xhAdd(&EXP.Functions, "sum", (char*)exp_fn_sum); @@ -4601,8 +4550,7 @@ int exp_internal_DefineFunctions() xhAdd(&EXP.Functions, "last", (char*)exp_fn_last); xhAdd(&EXP.Functions, "nth", (char*)exp_fn_nth); - - /** Reverse functions. **/ + /** Reverse functions **/ xhAdd(&EXP.ReverseFunctions, "isnull", (char*)exp_fn_reverse_isnull); return 0; diff --git a/centrallix/include/double_metaphone.h b/centrallix/include/double_metaphone.h new file mode 100644 index 000000000..757195862 --- /dev/null +++ b/centrallix/include/double_metaphone.h @@ -0,0 +1,83 @@ +#ifndef DOUBLE_METAPHONE_H +#define DOUBLE_METAPHONE_H + +/************************************************************************/ +/* Text-DoubleMetaphone */ +/* Centrallix Base Library */ +/* */ +/* Copyright 2000, Maurice Aubrey . */ +/* All rights reserved. */ +/* */ +/* This code is copied for redistribution with modification, from the */ +/* gitpan/Text-DoubleMetaphone implementation on GitHub (1), which is */ +/* under the following license. */ +/* */ +/* This code is based heavily on the C++ implementation by Lawrence */ +/* Philips and incorporates several bug fixes courtesy of Kevin */ +/* Atkinson . */ +/* */ +/* This module is free software; you may redistribute it and/or */ +/* modify it under the same terms as Perl itself. */ +/* */ +/* A summary of the relevant content from https://dev.perl.org/licenses */ +/* has been included below for the convenience of the reader. This */ +/* information was collected and saved on September 5th, 2025 and may */ +/* differ from current information. For the most up to date copy of */ +/* this information, please use the link provided above. */ +/* */ +/* Perl5 is Copyright © 1993 and later, by Larry Wall and others. */ +/* */ +/* It is free software; you can redistribute it and/or modify it */ +/* under the terms of either: */ +/* */ +/* a) the GNU General Public License (2) as published by the Free */ +/* Software Foundation (3); either version 1 (2), or (at your */ +/* option) any later version (4), or */ +/* */ +/* b) the "Artistic License" (5). */ +/* */ +/* Citations: */ +/* 1: https://github.com/gitpan/Text-meta_double_metaphone */ +/* 2: https://dev.perl.org/licenses/gpl1.html */ +/* 3: http://www.fsf.org */ +/* 4: http://www.fsf.org/licenses/licenses.html#GNUGPL */ +/* 5: https://dev.perl.org/licenses/artistic.html */ +/* */ +/* Centrallix is published under the GNU General Public License, */ +/* satisfying the above requirement. A summary of this is included */ +/* below for the convenience of the reader. */ +/* */ +/* This program is free software; you can redistribute it and/or modify */ +/* it under the terms of the GNU General Public License as published by */ +/* the Free Software Foundation; either version 2 of the License, or */ +/* (at your option) any later version. */ +/* */ +/* This program 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 General Public License for more details. */ +/* */ +/* You should have received a copy of the GNU General Public License */ +/* along with this program; if not, write to the Free Software */ +/* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA */ +/* 02111-1307 USA */ +/* */ +/* A copy of the GNU General Public License has been included in this */ +/* distribution in the file "COPYING". */ +/* */ +/* Module: double_metaphone.c, double_metaphone.h */ +/* Author: Maurice Aubrey and Israel Fuller */ +/* Description: This module implements a "sounds like" algorithm by */ +/* Lawrence Philips which he published in the June, 2000 */ +/* issue of C/C++ Users Journal. Double Metaphone is an */ +/* improved version of the original Metaphone algorithm */ +/* written by Philips'. This implementaton was written by */ +/* Maurice Aubrey for C/C++ with bug fixes provided by */ +/* Kevin Atkinson. It was revised by Israel Fuller to */ +/* better align with the Centrallix coding style and */ +/* standards so that it could be included here. */ +/************************************************************************/ + +void meta_double_metaphone(const char* str, char** primary_code, char** secondary_code); + +#endif /* End of .h file. */ diff --git a/centrallix/include/expression.h b/centrallix/include/expression.h index 3b334606b..8d506f72e 100644 --- a/centrallix/include/expression.h +++ b/centrallix/include/expression.h @@ -307,7 +307,6 @@ int exp_internal_SetupControl(pExpression exp); pExpControl exp_internal_LinkControl(pExpControl ctl); int exp_internal_UnlinkControl(pExpControl ctl); -void meta_double_metaphone(const char* str, char** primary_code, char** secondary_code); /*** Evaluator functions ***/ int expEvalIsNull(pExpression tree, pParamObjects objlist); diff --git a/centrallix/include/obj.h b/centrallix/include/obj.h index 0db1ea3ef..7015b05e5 100644 --- a/centrallix/include/obj.h +++ b/centrallix/include/obj.h @@ -307,7 +307,7 @@ typedef struct _OA #define OBJ_INFO_F_NO_CONTENT (1<<13) /* object does not have content, objRead() would fail */ #define OBJ_INFO_F_SUPPORTS_INHERITANCE (1<<14) /* object can support inheritance attr cx__inherit, etc. */ #define OBJ_INFO_F_FORCED_LEAF (1<<15) /* object is forced to be a 'leaf' unless ls__type used. */ -#define OBJ_INFO_F_TEMPORARY (1<<16) /* this is a temporary object without a vaoid pathname. */ +#define OBJ_INFO_F_TEMPORARY (1<<16) /* this is a temporary object without a valid pathname. */ /** object virtual attribute - these are attributes which persist only while @@ -735,6 +735,8 @@ void obj_internal_OpenCtlToString(pPathname pathinfo, int pathstart, int pathend int obj_internal_PathToText(pPathname pathinfo, int pathend, pXString str); /** objectsystem datatype functions **/ +int objTypeFromStr(const char* str); +char* objTypeToStr(const int type); int objDataToString(pXString dest, int data_type, void* data_ptr, int flags); double objDataToDouble(int data_type, void* data_ptr); int objDataToInteger(int data_type, void* data_ptr, char* format); diff --git a/centrallix/multiquery/multiquery.c b/centrallix/multiquery/multiquery.c index 069186e80..5ba4f10c0 100644 --- a/centrallix/multiquery/multiquery.c +++ b/centrallix/multiquery/multiquery.c @@ -2124,8 +2124,10 @@ mq_internal_SyntaxParse(pLxSession lxs, pQueryStatement stmt, int allow_empty, p } if (xs != NULL) + { strtcpy(new_qs->Source, xs->String, sizeof(new_qs->Source)); - next_state = LookForClause; + next_state = LookForClause; + } } else { diff --git a/centrallix/objectsystem/obj_datatypes.c b/centrallix/objectsystem/obj_datatypes.c index c674fe3df..4510e2116 100644 --- a/centrallix/objectsystem/obj_datatypes.c +++ b/centrallix/objectsystem/obj_datatypes.c @@ -127,6 +127,91 @@ char* obj_default_money_fmt = "$0.00"; char* obj_default_null_fmt = "NULL"; +/** Should maybe replace current type parsing in the presentation hints. **/ +/*** Parse the given string into a datatype. The case of the first character + *** is ignored, but all other characters must be capitalized correctly. + *** + *** @attention - This function is optimized to prevent performance hits + *** situations where it may need to be called many thousands of times. + *** + *** @param str The string to be parsed to a datatype. + *** @returns The datatype. + *** + *** LINK ../../centrallix-lib/include/datatypes.h:72 + ***/ +int objTypeFromStr(const char* str) + { + /** All valid types are non-null strings, at least 2 characters long. **/ + if (str == NULL || str[0] == '\0' || str[1] == '\0') return -1; + + /** Check type. **/ + switch (str[0]) + { + case 'A': case 'a': + if (strcmp(str+1, "Array"+1) == 0) return DATA_T_ARRAY; + if (strcmp(str+1, "Any"+1) == 0) return DATA_T_ANY; + break; + + case 'B': case 'b': + if (strcmp(str+1, "Binary"+1) == 0) return DATA_T_BINARY; + break; + + case 'C': case 'c': + if (strcmp(str+1, "Code"+1) == 0) return DATA_T_CODE; + break; + + case 'D': case 'd': + if (strcmp(str+1, "Double"+1) == 0) return DATA_T_DOUBLE; + if (strcmp(str+1, "DateTime"+1) == 0) return DATA_T_DATETIME; + break; + + case 'I': case 'i': + if (strcmp(str+1, "Integer"+1) == 0) return DATA_T_INTEGER; + if (strcmp(str+1, "IntVector"+1) == 0) return DATA_T_INTVEC; + break; + + case 'M': case 'm': + if (strcmp(str+1, "Money"+1) == 0) return DATA_T_MONEY; + break; + + case 'S': case 's': + if (strcmp(str+1, "String"+1) == 0) return DATA_T_STRING; + if (strcmp(str+1, "StringVector"+1) == 0) return DATA_T_STRINGVEC; + break; + + case 'U': case 'u': + if (strcmp(str+1, "Unknown"+1) == 0) return DATA_T_UNAVAILABLE; + if (strcmp(str+1, "Unavailable"+1) == 0) return DATA_T_UNAVAILABLE; + break; + } + + /** Invalid type. **/ + return -1; + } + + +/*** Convert a type to its string name. + *** + *** @param type The type to be converted. + *** @returns A char* to the type name, or + *** "(unknown)" if the type is unknown, or + *** "invalid" if the type number cannot even be a valid type. + ***/ +char* objTypeToStr(const int type) + { + /** Guard out of bounds reads. **/ + if (type < 0 || OBJ_TYPE_NAMES_CNT <= type) + { + /** Invalid type. **/ + mssErrorf(1, "Cluster", "Invalid type %d.\n", type); + + return "invalid"; /* Shall not parse to a valid type in ci_TypeFromStr(). */ + } + + return obj_type_names[type]; + } + + /*** obj_internal_ParseDateLang - looks up a list of language internationalization *** strings inside the date format. WARNING - modifies the "srcptr" data in *** place. diff --git a/centrallix/osdrivers/objdrv_cluster.c b/centrallix/osdrivers/objdrv_cluster.c index a41ffbd21..a30ba2d84 100644 --- a/centrallix/osdrivers/objdrv_cluster.c +++ b/centrallix/osdrivers/objdrv_cluster.c @@ -1,31 +1,31 @@ /************************************************************************/ -/* Centrallix Application Server System */ -/* Centrallix Core */ -/* */ -/* Copyright (C) 1998-2012 LightSys Technology Services, Inc. */ -/* */ -/* This program is free software; you can redistribute it and/or modify */ -/* it under the terms of the GNU General Public License as published by */ -/* the Free Software Foundation; either version 2 of the License, or */ -/* (at your option) any later version. */ -/* */ -/* This program 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 General Public License for more details. */ -/* */ -/* You should have received a copy of the GNU General Public License */ -/* along with this program; if not, write to the Free Software */ -/* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA */ -/* 02111-1307 USA */ -/* */ -/* A copy of the GNU General Public License has been included in this */ -/* distribution in the file "COPYING". */ -/* */ -/* Module: objdrv_cluster.c */ -/* Author: Israel Fuller */ -/* Creation: September 17, 2025 */ -/* Description: Cluster object driver. */ +/* Centrallix Application Server System */ +/* Centrallix Core */ +/* */ +/* Copyright (C) 1998-2012 LightSys Technology Services, Inc. */ +/* */ +/* This program is free software; you can redistribute it and/or modify */ +/* it under the terms of the GNU General Public License as published by */ +/* the Free Software Foundation; either version 2 of the License, or */ +/* (at your option) any later version. */ +/* */ +/* This program 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 General Public License for more details. */ +/* */ +/* You should have received a copy of the GNU General Public License */ +/* along with this program; if not, write to the Free Software */ +/* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA */ +/* 02111-1307 USA */ +/* */ +/* A copy of the GNU General Public License has been included in this */ +/* distribution in the file "COPYING". */ +/* */ +/* Module: objdrv_cluster.c */ +/* Author: Israel Fuller */ +/* Creation: September 17, 2025 */ +/* Description: Cluster object driver. */ /************************************************************************/ #include @@ -77,9 +77,11 @@ /** ANCHOR[id=temp] **/ /** TODO: Greg - I think this should be moved to mtsession. **/ -/*** I caused at least 10 bugs so far trying to pass format specifiers to - *** mssError without realizing that it didn't support them. Eventually, I - *** got fed up enough with the whole thing to write the following function. +/*** I caused at least 10 bugs early in the project trying to pass format + *** specifiers to mssError() without realizing that it didn't support them. + *** Eventually, I got fed up enough having to write errors to a sting buffer + *** and passing that buffer to mssError(), so I wrote this wrapper that does + *** it for me. Adding this behavior to mssError() would be better, though. ***/ /*** Displays error text to the user. Does not print a stack trace. Does not *** exit the program, allowing for the calling function to fail, generating @@ -101,123 +103,36 @@ ***/ void mssErrorf(int clr, char* module, const char* format, ...) { - /** Prevent interlacing with stdout flushing at a weird time. **/ - check(fflush(stdout)); /* Failure ignored. */ - - /** Insert convenient newline before error stack begins. **/ - if (clr == 1) fprintf(stderr, "\n"); - - /** Process the format with all the same rules as printf(). **/ - char buf[BUFSIZ]; - va_list args; - va_start(args, format); - const int num_chars = vsnprintf(buf, sizeof(buf), format, args); - va_end(args); - - /** Error check vsnprintf, just to be safe. **/ - if (num_chars < 0) - { - perror("vsnprintf() failed"); - fprintf(stderr, "FAIL: mssErrorf(%d, \"%s\", \"%s\", ...)\n", clr, module, format); - return; - } - if (num_chars > BUFSIZ) - fprintf(stderr, "Warning: Error truncated (length %d > buffer size %d).\n", num_chars, BUFSIZ); - - /** Print the error. **/ - const int ret = mssError(clr, module, "%s", buf); - - /** Not sure why you have to error check the error function... **/ - if (ret != 0) fprintf(stderr, "FAIL %d: mssError(%d, \"%s\", \"%%s\", \"%s\")\n", ret, clr, module, buf); - } - - -/** TODO: Greg - I think this should be moved to datatypes. **/ -/** Should maybe replace current type parsing in the presentation hints. **/ -/*** Parse the given string into a datatype. The case of the first character - *** is ignored, but all other characters must be capitalized correctly. - *** - *** @attention - This function is optimized to prevent performance hits - *** situations where it may need to be called many thousands of times. - *** - *** @param str The string to be parsed to a datatype. - *** @returns The datatype. - *** - *** LINK ../../centrallix-lib/include/datatypes.h:72 - ***/ -static int ci_TypeFromStr(const char* str) - { - /** All valid types are non-null strings, at least 2 characters long. **/ - if (str == NULL || str[0] == '\0' || str[1] == '\0') return -1; - - /** Check type. **/ - switch (str[0]) - { - case 'A': case 'a': - if (strcmp(str+1, "Array"+1) == 0) return DATA_T_ARRAY; - if (strcmp(str+1, "Any"+1) == 0) return DATA_T_ANY; - break; - - case 'B': case 'b': - if (strcmp(str+1, "Binary"+1) == 0) return DATA_T_BINARY; - break; - - case 'C': case 'c': - if (strcmp(str+1, "Code"+1) == 0) return DATA_T_CODE; - break; - - case 'D': case 'd': - if (strcmp(str+1, "Double"+1) == 0) return DATA_T_DOUBLE; - if (strcmp(str+1, "DateTime"+1) == 0) return DATA_T_DATETIME; - break; - - case 'I': case 'i': - if (strcmp(str+1, "Integer"+1) == 0) return DATA_T_INTEGER; - if (strcmp(str+1, "IntVector"+1) == 0) return DATA_T_INTVEC; - break; - - case 'M': case 'm': - if (strcmp(str+1, "Money"+1) == 0) return DATA_T_MONEY; - break; - - case 'S': case 's': - if (strcmp(str+1, "String"+1) == 0) return DATA_T_STRING; - if (strcmp(str+1, "StringVector"+1) == 0) return DATA_T_STRINGVEC; - break; - - case 'U': case 'u': - if (strcmp(str+1, "Unknown"+1) == 0) return DATA_T_UNAVAILABLE; - if (strcmp(str+1, "Unavailable"+1) == 0) return DATA_T_UNAVAILABLE; - break; - } - - /** Invalid type. **/ - return -1; + /** Prevent interlacing with stdout flushing at a weird time. **/ + check(fflush(stdout)); /* Failure ignored. */ + + /** Insert convenient newline before error stack begins. **/ + if (clr == 1) fprintf(stderr, "\n"); + + /** Process the format with all the same rules as printf(). **/ + char buf[BUFSIZ]; + va_list args; + va_start(args, format); + const int num_chars = vsnprintf(buf, sizeof(buf), format, args); + va_end(args); + + /** Error check vsnprintf, just to be safe. **/ + if (num_chars < 0) + { + perror("vsnprintf() failed"); + fprintf(stderr, "FAIL: mssErrorf(%d, \"%s\", \"%s\", ...)\n", clr, module, format); + return; + } + if (num_chars > BUFSIZ) + fprintf(stderr, "Warning: Error truncated (length %d > buffer size %d).\n", num_chars, BUFSIZ); + + /** Print the error. **/ + const int ret = mssError(clr, module, "%s", buf); + + /** Not sure why you have to error check the error function... **/ + if (ret != 0) fprintf(stderr, "FAIL %d: mssError(%d, \"%s\", \"%%s\", \"%s\")\n", ret, clr, module, buf); } -/** TODO: Greg - I think this should be moved to datatypes. **/ -/** Should maybe replace this functionality where it appears elsewhere. **/ -static char* ci_TypeToStr(const int type) - { - switch (type) - { - case DATA_T_UNAVAILABLE: return "Unknown"; - case DATA_T_INTEGER: return "Integer"; - case DATA_T_STRING: return "String"; - case DATA_T_DOUBLE: return "Double"; - case DATA_T_DATETIME: return "DateTime"; - case DATA_T_INTVEC: return "IntVector"; - case DATA_T_STRINGVEC: return "StringVector"; - case DATA_T_MONEY: return "Money"; - case DATA_T_ARRAY: return "Array"; - case DATA_T_CODE: return "Code"; - case DATA_T_BINARY: return "Binary"; - } - - /** Invalid type. **/ - mssErrorf(1, "Cluster", "Invalid type %d.\n", type); - return "Invalid"; /* Shall not parse to a valid type in ci_TypeFromStr(). */ - } /** TODO: Greg - I think this should be moved to xarray. **/ /*** Trims an xArray, returning a new array (with nmSysMalloc). @@ -231,25 +146,25 @@ static char* ci_TypeToStr(const int type) ***/ static void** ci_xaToTrimmedArray(pXArray arr, int array_handling) { - const size_t arr_size = arr->nItems * sizeof(void*); - void** result = check_ptr(nmSysMalloc(arr_size)); - if (result == NULL) return NULL; - memcpy(result, arr->Items, arr_size); - - /** Handle the array. **/ - switch (array_handling) - { - case 0: break; - case 1: check(xaDeInit(arr)); arr->nAlloc = 0; break; /* Failure ignored. */ - case 2: check(xaFree(arr)); break; /* Failure ignored. */ - default: - /** Uh oh, there might be a memory leak... **/ - fprintf(stderr, - "Warning: ci_xaToTrimmedArray(%p, %d) - Unknown value (%d) for array_handling.\n", - arr, array_handling, array_handling - ); - break; - } + const size_t arr_size = arr->nItems * sizeof(void*); + void** result = check_ptr(nmSysMalloc(arr_size)); + if (result == NULL) return NULL; + memcpy(result, arr->Items, arr_size); + + /** Handle the array. **/ + switch (array_handling) + { + case 0: break; + case 1: check(xaDeInit(arr)); arr->nAlloc = 0; break; /* Failure ignored. */ + case 2: check(xaFree(arr)); break; /* Failure ignored. */ + default: + /** Uh oh, there might be a memory leak... **/ + fprintf(stderr, + "Warning: ci_xaToTrimmedArray(%p, %d) - Unknown value (%d) for array_handling.\n", + arr, array_handling, array_handling + ); + break; + } return result; } @@ -257,13 +172,13 @@ static void** ci_xaToTrimmedArray(pXArray arr, int array_handling) /** I got tired of forgetting how to do these. **/ #define ci_file_name(obj) \ ({ \ - __typeof__ (obj) _obj = (obj); \ - obj_internal_PathPart(_obj->Pathname, _obj->SubPtr - 1, 1); \ + __typeof__ (obj) _obj = (obj); \ + obj_internal_PathPart(_obj->Pathname, _obj->SubPtr - 1, 1); \ }) #define ci_file_path(obj) \ ({ \ - __typeof__ (obj) _obj = (obj); \ - obj_internal_PathPart(_obj->Pathname, 0, _obj->SubPtr); \ + __typeof__ (obj) _obj = (obj); \ + obj_internal_PathPart(_obj->Pathname, 0, _obj->SubPtr); \ }) @@ -295,17 +210,17 @@ ClusterAlgorithm ALL_CLUSTERING_ALGORITHMS[nClusteringAlgorithms] = /** Converts a clustering algorithm to its string name. **/ char* ci_ClusteringAlgorithmToString(ClusterAlgorithm clustering_algorithm) { - switch (clustering_algorithm) - { - case ALGORITHM_NULL: return "NULL algorithm"; - case ALGORITHM_NONE: return "none"; - case ALGORITHM_SLIDING_WINDOW: return "sliding-window"; - case ALGORITHM_KMEANS: return "k-means"; - case ALGORITHM_KMEANS_PLUS_PLUS: return "k-means++"; - case ALGORITHM_KMEDOIDS: return "k-medoids"; - case ALGORITHM_DB_SCAN: return "db-scan"; - default: return "Unknown algorithm"; - } + switch (clustering_algorithm) + { + case ALGORITHM_NULL: return "NULL algorithm"; + case ALGORITHM_NONE: return "none"; + case ALGORITHM_SLIDING_WINDOW: return "sliding-window"; + case ALGORITHM_KMEANS: return "k-means"; + case ALGORITHM_KMEANS_PLUS_PLUS: return "k-means++"; + case ALGORITHM_KMEDOIDS: return "k-medoids"; + case ALGORITHM_DB_SCAN: return "db-scan"; + default: return "Unknown algorithm"; + } } /** Enum representing a similarity measurement algorithm. **/ @@ -325,13 +240,13 @@ SimilarityMeasure ALL_SIMILARITY_MEASURES[nSimilarityMeasures] = /** Converts a similarity measure to its string name. **/ char* ci_SimilarityMeasureToString(SimilarityMeasure similarity_measure) { - switch (similarity_measure) - { - case SIMILARITY_NULL: return "NULL similarity measure"; - case SIMILARITY_COSINE: return "cosine"; - case SIMILARITY_LEVENSHTEIN: return "levenshtein"; - default: return "Unknown similarity measure"; - } + switch (similarity_measure) + { + case SIMILARITY_NULL: return "NULL similarity measure"; + case SIMILARITY_COSINE: return "cosine"; + case SIMILARITY_LEVENSHTEIN: return "levenshtein"; + default: return "Unknown similarity measure"; + } } /*** Enum representing the type of data targetted by the driver, @@ -342,7 +257,7 @@ char* ci_SimilarityMeasureToString(SimilarityMeasure similarity_measure) *** However, there is currently no allowed `NULL` TargetType. ***/ typedef unsigned char TargetType; -#define TARGET_ROOT (TargetType)1u +#define TARGET_NODE (TargetType)1u #define TARGET_CLUSTER (TargetType)2u #define TARGET_SEARCH (TargetType)3u #define TARGET_CLUSTER_ENTRY (TargetType)4u @@ -374,8 +289,6 @@ char* const ATTR_SEARCH[] = "source", "threshold", "similarity_measure", - "date_created", - "date_computed", END_OF_ARRAY, }; char* const ATTR_CLUSTER_ENTRY[] = @@ -390,13 +303,11 @@ char* const ATTR_SEARCH_ENTRY[] = "key1", "key2", "sim", - "date_created", - "date_computed", END_OF_ARRAY, }; /** Method name list. **/ -char* const METHOD_NAME[] = +char* const METHOD_NAMES[] = { "cache", "stat", @@ -571,7 +482,7 @@ typedef struct _SEARCH /*** Node instance data. *** *** Memory Stats: - *** - Padding: 4 bytes + *** - Padding: 0 bytes *** - Total size: 64 bytes *** *** @note When a .cluster file is openned, there will be only one node for that @@ -582,13 +493,15 @@ typedef struct _SEARCH *** @param SourceData Data from the provided source. *** @param Params A pParam array storing the params in the .cluster file. *** @param nParams The number of specified params. - *** @param ParamList Functions as a "scope" for resolving values during parsing. - *** @param ClusterDatas A pCluster array storing the clusters in the .cluster file. - *** Will be NULL if nClusters = 0. + *** @param ParamList A "scope" for resolving parameter values during parsing. + *** @param ClusterDatas A pCluster array for the clusters in the .cluster file. + *** Will be NULL if `nClusters = 0`. *** @param nClusterDatas The number of specified clusters. - *** @param SearchDatas A SearchData array storing the searches in the .cluster file. + *** @param SearchDatas A SearchData array for the searches in the .cluster file. *** @param nSearches The number of specified searches. *** @param nSearchDatas The parent object used to open this NodeData instance. + *** @param OpenCount The number of open driver instances that are using the + *** NodeData struct. When this reaches 0, the struct should be freed. ***/ typedef struct _NODE { @@ -598,6 +511,7 @@ typedef struct _NODE pSourceData SourceData; pClusterData* ClusterDatas; pSearchData* SearchDatas; + unsigned int OpenCount; unsigned int nParams; unsigned int nClusterDatas; unsigned int nSearchDatas; @@ -630,7 +544,7 @@ typedef struct _NODE *** @param TargetType The type of data targetted (see above). *** @param TargetData If target type is: *** ```csv - *** Root: A pointer to the SourceData struct. + *** Node: A pointer to the SourceData struct. *** Cluster or ClusterEntry: A pointer to the targetted cluster. *** Search or SearchEntry: A pointer to the targetted search. *** ``` @@ -672,7 +586,7 @@ struct XHashTable ClusterDataCache; XHashTable SearchDataCache; } - ClusterDriverCaches; + ClusterDriverCaches = {0}; struct { @@ -775,7 +689,7 @@ int clusterCommit(void* inf_v, pObjTrxTree *oxt); /** Format a hint to give to the user. **/ static void ci_GiveHint(const char* hint) { - fprintf(stderr, " > Hint: Did you mean \"%s\"?\n", hint); + fprintf(stderr, " > Hint: Did you mean \"%s\"?\n", hint); } @@ -791,11 +705,12 @@ static void ci_GiveHint(const char* hint) ***/ static bool ci_TryHint(char* value, char** valid_values, const unsigned int n_valid_values) { - char* guess = ca_most_similar(value, (void**)valid_values, n_valid_values, ca_lev_compare, 0.25); - if (guess == NULL) return false; /* No hint. */ + char* guess = ca_most_similar(value, (void**)valid_values, n_valid_values, ca_lev_compare, 0.25); + if (guess == NULL) return false; /* No hint. */ + + /** Issue hint. **/ + ci_GiveHint(guess); - /** Issue hint. **/ - ci_GiveHint(guess); return true; } @@ -823,61 +738,63 @@ static int ci_ParseAttribute( { int ret; - /** Get attribute inf. **/ - pStructInf attr_info = stLookup(inf, attr_name); - if (attr_info == NULL) - { - if (required) mssErrorf(1, "Cluster", "'%s' must be specified for clustering.", attr_name); - return 1; - } - ASSERTMAGIC(attr_info, MGK_STRUCTINF); - - /** Allocate expression. **/ - pExpression exp = check_ptr(stGetExpression(attr_info, 0)); - if (exp == NULL) goto err; - - /** Bind parameters. **/ - /** TODO: Greg - What does this return? How do I know if it fails? **/ - expBindExpression(exp, param_list, EXPR_F_RUNSERVER); - - /** Evaluate expression. **/ - ret = expEvalTree(exp, param_list); - if (ret != 0) - { - mssErrorf(0, "Cluster", "Expression evaluation failed (error code %d).", ret); - goto err; - } - - /** Check for data type mismatch. **/ - if (datatype != exp->DataType) - { - mssErrorf(1, "Cluster", - "Expected ['%s' : %s], but got type %s.", - attr_name, ci_TypeToStr(datatype), ci_TypeToStr(exp->DataType) - ); - goto err; - } - - /** Get the data out of the expression. **/ - ret = expExpressionToPod(exp, datatype, data); - if (ret != 0) - { - mssErrorf(1, "Cluster", - "Failed to get ['%s' : %s] using expression \"%s\" (error code %d).", - attr_name, ci_TypeToStr(datatype), exp->Name, ret - ); - goto err; - } - - /** Success. **/ - return 0; - + /** Get attribute inf. **/ + pStructInf attr_info = stLookup(inf, attr_name); + if (attr_info == NULL) + { + if (required) mssErrorf(1, "Cluster", "'%s' must be specified for clustering.", attr_name); + return 1; + } + ASSERTMAGIC(attr_info, MGK_STRUCTINF); + + /** Allocate expression. **/ + pExpression exp = check_ptr(stGetExpression(attr_info, 0)); + if (exp == NULL) goto err; + + /** Bind parameters. **/ + /** TODO: Greg - What does this return? How do I know if it fails? **/ + expBindExpression(exp, param_list, EXPR_F_RUNSERVER); + + /** Evaluate expression. **/ + ret = expEvalTree(exp, param_list); + if (ret != 0) + { + mssErrorf(0, "Cluster", "Expression evaluation failed (error code %d).", ret); + goto err; + } + + /** Check for data type mismatch. **/ + if (datatype != exp->DataType) + { + mssErrorf(1, "Cluster", + "Expected ['%s' : %s], but got type %s.", + attr_name, objTypeToStr(datatype), objTypeToStr(exp->DataType) + ); + goto err; + } + + /** Get the data out of the expression. **/ + ret = expExpressionToPod(exp, datatype, data); + if (ret != 0) + { + mssErrorf(1, "Cluster", + "Failed to get ['%s' : %s] using expression \"%s\" (error code %d).", + attr_name, objTypeToStr(datatype), exp->Name, ret + ); + goto err; + } + + /** Success. **/ + return 0; + err: - mssErrorf(0, "Cluster", - "Failed to parse attribute \"%s\" from group \"%s\"", - attr_name, inf->Name - ); - return -1; + mssErrorf(0, "Cluster", + "Failed to parse attribute \"%s\" from group \"%s\"", + attr_name, inf->Name + ); + + /** Return error. **/ + return -1; } @@ -894,34 +811,34 @@ static int ci_ParseAttribute( ***/ static ClusterAlgorithm ci_ParseClusteringAlgorithm(pStructInf inf, pParamObjects param_list) { - /** Get the algorithm attribute. **/ - char* algorithm; - if (ci_ParseAttribute(inf, "algorithm", DATA_T_STRING, POD(&algorithm), param_list, true, true) != 0) - { - mssErrorf(0, "Cluster", "Failed to parse attribute 'algorithm' in group \"%s\".", inf->Name); - return ALGORITHM_NULL; - } - - /** Parse known clustering algorithms. **/ - if (!strcasecmp(algorithm, "none")) return ALGORITHM_NONE; - if (!strcasecmp(algorithm, "sliding-window")) return ALGORITHM_SLIDING_WINDOW; - if (!strcasecmp(algorithm, "k-means")) return ALGORITHM_KMEANS; - if (!strcasecmp(algorithm, "k-means++")) return ALGORITHM_KMEANS_PLUS_PLUS; - if (!strcasecmp(algorithm, "k-medoids")) return ALGORITHM_KMEDOIDS; - if (!strcasecmp(algorithm, "db-scan")) return ALGORITHM_DB_SCAN; - - /** Unknown value for clustering algorithm. **/ - mssErrorf(1, "Cluster", "Unknown \"clustering algorithm\": %s", algorithm); - - /** Attempt to give a hint. **/ - char* all_names[nClusteringAlgorithms] = {NULL}; - for (unsigned int i = 0u; i < nClusteringAlgorithms; i++) - all_names[i] = ci_ClusteringAlgorithmToString(ALL_CLUSTERING_ALGORITHMS[i]); - if (ci_TryHint(algorithm, all_names, nClusteringAlgorithms)); - else if (strcasecmp(algorithm, "sliding") == 0) ci_GiveHint(ci_ClusteringAlgorithmToString(ALGORITHM_SLIDING_WINDOW)); - else if (strcasecmp(algorithm, "window") == 0) ci_GiveHint(ci_ClusteringAlgorithmToString(ALGORITHM_SLIDING_WINDOW)); - else if (strcasecmp(algorithm, "null") == 0) ci_GiveHint(ci_ClusteringAlgorithmToString(ALGORITHM_NONE)); - else if (strcasecmp(algorithm, "nothing") == 0) ci_GiveHint(ci_ClusteringAlgorithmToString(ALGORITHM_NONE)); + /** Get the algorithm attribute. **/ + char* algorithm; + if (ci_ParseAttribute(inf, "algorithm", DATA_T_STRING, POD(&algorithm), param_list, true, true) != 0) + { + mssErrorf(0, "Cluster", "Failed to parse attribute 'algorithm' in group \"%s\".", inf->Name); + return ALGORITHM_NULL; + } + + /** Parse known clustering algorithms. **/ + if (!strcasecmp(algorithm, "none")) return ALGORITHM_NONE; + if (!strcasecmp(algorithm, "sliding-window")) return ALGORITHM_SLIDING_WINDOW; + if (!strcasecmp(algorithm, "k-means")) return ALGORITHM_KMEANS; + if (!strcasecmp(algorithm, "k-means++")) return ALGORITHM_KMEANS_PLUS_PLUS; + if (!strcasecmp(algorithm, "k-medoids")) return ALGORITHM_KMEDOIDS; + if (!strcasecmp(algorithm, "db-scan")) return ALGORITHM_DB_SCAN; + + /** Unknown value for clustering algorithm. **/ + mssErrorf(1, "Cluster", "Unknown \"clustering algorithm\": %s", algorithm); + + /** Attempt to give a hint. **/ + char* all_names[nClusteringAlgorithms] = {NULL}; + for (unsigned int i = 0u; i < nClusteringAlgorithms; i++) + all_names[i] = ci_ClusteringAlgorithmToString(ALL_CLUSTERING_ALGORITHMS[i]); + if (ci_TryHint(algorithm, all_names, nClusteringAlgorithms)); + else if (strcasecmp(algorithm, "sliding") == 0) ci_GiveHint(ci_ClusteringAlgorithmToString(ALGORITHM_SLIDING_WINDOW)); + else if (strcasecmp(algorithm, "window") == 0) ci_GiveHint(ci_ClusteringAlgorithmToString(ALGORITHM_SLIDING_WINDOW)); + else if (strcasecmp(algorithm, "null") == 0) ci_GiveHint(ci_ClusteringAlgorithmToString(ALGORITHM_NONE)); + else if (strcasecmp(algorithm, "nothing") == 0) ci_GiveHint(ci_ClusteringAlgorithmToString(ALGORITHM_NONE)); /** Fail. **/ return ALGORITHM_NULL; @@ -942,30 +859,30 @@ static ClusterAlgorithm ci_ParseClusteringAlgorithm(pStructInf inf, pParamObject ***/ static SimilarityMeasure ci_ParseSimilarityMeasure(pStructInf inf, pParamObjects param_list) { - /** Get the similarity_measure attribute. **/ - char* measure; - if (ci_ParseAttribute(inf, "similarity_measure", DATA_T_STRING, POD(&measure), param_list, true, true) != 0) - { - mssErrorf(0, "Cluster", "Failed to parse attribute 'similarity_measure' in group \"%s\".", inf->Name); - return SIMILARITY_NULL; - } - - /** Parse known clustering algorithms. **/ - if (!strcasecmp(measure, "cosine")) return SIMILARITY_COSINE; - if (!strcasecmp(measure, "levenshtein")) return SIMILARITY_LEVENSHTEIN; - - /** Unknown similarity measure. **/ - mssErrorf(1, "Cluster", "Unknown \"similarity measure\": %s", measure); - - /** Attempt to give a hint. **/ - char* all_names[nSimilarityMeasures] = {NULL}; - for (unsigned int i = 0u; i < nSimilarityMeasures; i++) - all_names[i] = ci_SimilarityMeasureToString(ALL_SIMILARITY_MEASURES[i]); - if (ci_TryHint(measure, all_names, nSimilarityMeasures)); - else if (strcasecmp(measure, "cos") == 0) ci_GiveHint(ci_SimilarityMeasureToString(SIMILARITY_COSINE)); - else if (strcasecmp(measure, "lev") == 0) ci_GiveHint(ci_SimilarityMeasureToString(SIMILARITY_LEVENSHTEIN)); - else if (strcasecmp(measure, "edit-dist") == 0) ci_GiveHint(ci_SimilarityMeasureToString(SIMILARITY_LEVENSHTEIN)); - else if (strcasecmp(measure, "edit-distance") == 0) ci_GiveHint(ci_SimilarityMeasureToString(SIMILARITY_LEVENSHTEIN)); + /** Get the similarity_measure attribute. **/ + char* measure; + if (ci_ParseAttribute(inf, "similarity_measure", DATA_T_STRING, POD(&measure), param_list, true, true) != 0) + { + mssErrorf(0, "Cluster", "Failed to parse attribute 'similarity_measure' in group \"%s\".", inf->Name); + return SIMILARITY_NULL; + } + + /** Parse known clustering algorithms. **/ + if (!strcasecmp(measure, "cosine")) return SIMILARITY_COSINE; + if (!strcasecmp(measure, "levenshtein")) return SIMILARITY_LEVENSHTEIN; + + /** Unknown similarity measure. **/ + mssErrorf(1, "Cluster", "Unknown \"similarity measure\": %s", measure); + + /** Attempt to give a hint. **/ + char* all_names[nSimilarityMeasures] = {NULL}; + for (unsigned int i = 0u; i < nSimilarityMeasures; i++) + all_names[i] = ci_SimilarityMeasureToString(ALL_SIMILARITY_MEASURES[i]); + if (ci_TryHint(measure, all_names, nSimilarityMeasures)); + else if (strcasecmp(measure, "cos") == 0) ci_GiveHint(ci_SimilarityMeasureToString(SIMILARITY_COSINE)); + else if (strcasecmp(measure, "lev") == 0) ci_GiveHint(ci_SimilarityMeasureToString(SIMILARITY_LEVENSHTEIN)); + else if (strcasecmp(measure, "edit-dist") == 0) ci_GiveHint(ci_SimilarityMeasureToString(SIMILARITY_LEVENSHTEIN)); + else if (strcasecmp(measure, "edit-distance") == 0) ci_GiveHint(ci_SimilarityMeasureToString(SIMILARITY_LEVENSHTEIN)); /** Fail. **/ return SIMILARITY_NULL; @@ -989,71 +906,78 @@ static SimilarityMeasure ci_ParseSimilarityMeasure(pStructInf inf, pParamObjects static pSourceData ci_ParseSourceData(pStructInf inf, pParamObjects param_list, char* path) { char* buf = NULL; - - /** Allocate SourceData. **/ - pSourceData source_data = check_ptr(nmMalloc(sizeof(SourceData))); - if (source_data == NULL) goto err_free; - memset(source_data, 0, sizeof(SourceData)); - - /** Initialize obvious values for SourceData. **/ - source_data->Name = check_ptr(nmSysStrdup(inf->Name)); - if (source_data->Name == NULL) goto err_free; - if (!check(objCurrentDate(&source_data->DateCreated))) goto err_free; - - /** Get source. **/ - if (ci_ParseAttribute(inf, "source", DATA_T_STRING, POD(&buf), param_list, true, true) != 0) goto err_free; - source_data->SourcePath = check_ptr(nmSysStrdup(buf)); - if (source_data->SourcePath == NULL) goto err_free; - - /** Get the attribute name to use when querying keys from the source. **/ - if (ci_ParseAttribute(inf, "key_attr", DATA_T_STRING, POD(&buf), param_list, true, true) != 0) goto err_free; - source_data->KeyAttr = check_ptr(nmSysStrdup(buf)); - if (source_data->KeyAttr == NULL) goto err_free; - - /** Get the attribute name to use for querying data from the source. **/ - if (ci_ParseAttribute(inf, "data_attr", DATA_T_STRING, POD(&buf), param_list, true, true) != 0) goto err_free; - source_data->NameAttr = check_ptr(nmSysStrdup(buf)); - if (source_data->NameAttr == NULL) goto err_free; - - /** Create cache entry key. **/ - const size_t len = strlen(path) + strlen(source_data->SourcePath) + strlen(source_data->KeyAttr) + strlen(source_data->NameAttr) + 5lu; - source_data->Key = check_ptr(nmSysMalloc(len * sizeof(char))); - if (source_data->Key == NULL) goto err_free; - snprintf(source_data->Key, len, "%s?%s->%s:%s", path, source_data->SourcePath, source_data->KeyAttr, source_data->NameAttr); - - /** Check for a cached version. **/ - pSourceData source_maybe = (pSourceData)xhLookup(&ClusterDriverCaches.SourceDataCache, source_data->Key); - if (source_maybe != NULL) - { - /** Cache hit. **/ + pSourceData source_data = NULL; + + /** Allocate SourceData. **/ + source_data = check_ptr(nmMalloc(sizeof(SourceData))); + if (source_data == NULL) goto err_free; + memset(source_data, 0, sizeof(SourceData)); - /** Cause an immediate invalid read if cache was incorrectly freed. **/ + /** Initialize obvious values for SourceData. **/ + source_data->Name = check_ptr(nmSysStrdup(inf->Name)); + if (source_data->Name == NULL) goto err_free; + if (!check(objCurrentDate(&source_data->DateCreated))) goto err_free; - /** Free data we don't need. **/ - nmSysFree(source_data->Key); - ci_FreeSourceData(source_data); + /** Get source. **/ + if (ci_ParseAttribute(inf, "source", DATA_T_STRING, POD(&buf), param_list, true, true) != 0) goto err_free; + source_data->SourcePath = check_ptr(nmSysStrdup(buf)); + if (source_data->SourcePath == NULL) goto err_free; - /** Return the cached source data. **/ - return source_maybe; - } - - /** Cache miss: Add the new object to the cache for next time. **/ - if (!check(xhAdd(&ClusterDriverCaches.SourceDataCache, source_data->Key, (void*)source_data))) - goto err_free; - - /** Success. **/ - return source_data; - - /** Error handling. **/ + /** Get the attribute name to use when querying keys from the source. **/ + if (ci_ParseAttribute(inf, "key_attr", DATA_T_STRING, POD(&buf), param_list, true, true) != 0) goto err_free; + source_data->KeyAttr = check_ptr(nmSysStrdup(buf)); + if (source_data->KeyAttr == NULL) goto err_free; + + /** Get the attribute name to use for querying data from the source. **/ + if (ci_ParseAttribute(inf, "data_attr", DATA_T_STRING, POD(&buf), param_list, true, true) != 0) goto err_free; + source_data->NameAttr = check_ptr(nmSysStrdup(buf)); + if (source_data->NameAttr == NULL) goto err_free; + + /** Create cache entry key. **/ + const size_t len = strlen(path) + + strlen(source_data->SourcePath) + + strlen(source_data->KeyAttr) + + strlen(source_data->NameAttr) + 5lu; + source_data->Key = check_ptr(nmSysMalloc(len * sizeof(char))); + if (source_data->Key == NULL) goto err_free; + snprintf(source_data->Key, len, + "%s?%s->%s:%s", + path, source_data->SourcePath, source_data->KeyAttr, source_data->NameAttr + ); + + /** Check for a cached version. **/ + pSourceData source_maybe = (pSourceData)xhLookup(&ClusterDriverCaches.SourceDataCache, source_data->Key); + if (source_maybe != NULL) + { /* Cache hit. */ + /** Free data we don't need. **/ + nmSysFree(source_data->Key); + ci_FreeSourceData(source_data); + + /** Return the cached source data. **/ + return source_maybe; + } + + /** Cache miss: Add the new object to the cache for next time. **/ + if (!check(xhAdd(&ClusterDriverCaches.SourceDataCache, source_data->Key, (void*)source_data))) + goto err_free; + + /** Success. **/ + return source_data; + + /** Error handling. **/ err_free: - if (source_data->Key != NULL) nmSysFree(source_data->Key); - if (source_data != NULL) ci_FreeSourceData(source_data); - - mssErrorf(0, "Cluster", - "Failed to parse source data from group \"%s\" in file: %s", - inf->Name, path - ); - return NULL; + if (source_data != NULL) + { + if (source_data->Key != NULL) nmSysFree(source_data->Key); + ci_FreeSourceData(source_data); + } + + mssErrorf(0, "Cluster", + "Failed to parse source data from group \"%s\" in file: %s", + inf->Name, path + ); + + return NULL; } @@ -1074,279 +998,285 @@ static pSourceData ci_ParseSourceData(pStructInf inf, pParamObjects param_list, static pClusterData ci_ParseClusterData(pStructInf inf, pNodeData node_data) { int result; + pClusterData cluster_data = NULL; + XArray sub_clusters = {0}; + char* key = NULL; - /** Extract values. **/ - pParamObjects param_list = node_data->ParamList; - pSourceData source_data = node_data->SourceData; - - /** Allocate space for data struct. **/ - pClusterData cluster_data = check_ptr(nmMalloc(sizeof(ClusterData))); - if (cluster_data == NULL) goto err; - memset(cluster_data, 0, sizeof(ClusterData)); - - /** Basic Properties. **/ - cluster_data->Name = check_ptr(nmSysStrdup(inf->Name)); - if (cluster_data->Name == NULL) goto err_free_cluster; - cluster_data->SourceData = check_ptr(source_data); - if (cluster_data->SourceData == NULL) goto err_free_cluster; - if (!check(objCurrentDate(&cluster_data->DateCreated))) goto err_free_cluster; - - /** Get algorithm. **/ - cluster_data->ClusterAlgorithm = ci_ParseClusteringAlgorithm(inf, param_list); - if (cluster_data->ClusterAlgorithm == ALGORITHM_NULL) goto err_free_cluster; - - /** Handle no clustering case. **/ - if (cluster_data->ClusterAlgorithm == ALGORITHM_NONE) - { - cluster_data->nClusters = 1u; - goto parsing_done; - } - - /** Get similarity_measure. **/ - cluster_data->SimilarityMeasure = ci_ParseSimilarityMeasure(inf, param_list); - if (cluster_data->SimilarityMeasure == SIMILARITY_NULL) goto err_free_cluster; - - /** Handle sliding window case. **/ - if (cluster_data->ClusterAlgorithm == ALGORITHM_SLIDING_WINDOW) - { - /** Sliding window doesn't allocate any clusters. **/ - cluster_data->nClusters = 0u; - - /** Get window_size. **/ - int window_size; - if (ci_ParseAttribute(inf, "window_size", DATA_T_INTEGER, POD(&window_size), param_list, true, true) != 0) - goto err_free_cluster; - if (window_size < 1) + /** Extract values. **/ + pParamObjects param_list = node_data->ParamList; + pSourceData source_data = node_data->SourceData; + + /** Allocate space for data struct. **/ + cluster_data = check_ptr(nmMalloc(sizeof(ClusterData))); + if (cluster_data == NULL) goto err_free; + memset(cluster_data, 0, sizeof(ClusterData)); + + /** Basic Properties. **/ + cluster_data->Name = check_ptr(nmSysStrdup(inf->Name)); + if (cluster_data->Name == NULL) goto err_free; + cluster_data->SourceData = check_ptr(source_data); + if (cluster_data->SourceData == NULL) goto err_free; + if (!check(objCurrentDate(&cluster_data->DateCreated))) goto err_free; + + /** Get algorithm. **/ + cluster_data->ClusterAlgorithm = ci_ParseClusteringAlgorithm(inf, param_list); + if (cluster_data->ClusterAlgorithm == ALGORITHM_NULL) goto err_free; + + /** Handle no clustering case. **/ + if (cluster_data->ClusterAlgorithm == ALGORITHM_NONE) { - mssErrorf(1, "Cluster", "Invalid value for [window_size : uint > 0]: %d", window_size); - goto err_free_cluster; + cluster_data->nClusters = 1u; + goto parsing_done; } - /** Store value. **/ - cluster_data->MaxIterations = (unsigned int)window_size; - goto parsing_done; - } - - /** Get num_clusters. **/ - int num_clusters; - if (ci_ParseAttribute(inf, "num_clusters", DATA_T_INTEGER, POD(&num_clusters), param_list, true, true) != 0) - goto err_free_cluster; - if (num_clusters < 2) - { - mssErrorf(1, "Cluster", "Invalid value for [num_clusters : uint > 1]: %d", num_clusters); - if (num_clusters == 1) fprintf(stderr, "HINT: Use algorithm=\"none\" to disable clustering.\n"); - goto err_free_cluster; - } - cluster_data->nClusters = (unsigned int)num_clusters; - - /** Get min_improvement. **/ - double improvement; - result = ci_ParseAttribute(inf, "min_improvement", DATA_T_DOUBLE, POD(&improvement), param_list, false, false); - if (result == 1) cluster_data->MinImprovement = DEFAULT_MIN_IMPROVEMENT; - else if (result == 0) - { - if (improvement <= 0.0 || 1.0 <= improvement) + /** Get similarity_measure. **/ + cluster_data->SimilarityMeasure = ci_ParseSimilarityMeasure(inf, param_list); + if (cluster_data->SimilarityMeasure == SIMILARITY_NULL) goto err_free; + + /** Handle sliding window case. **/ + if (cluster_data->ClusterAlgorithm == ALGORITHM_SLIDING_WINDOW) { - mssErrorf(1, "Cluster", "Invalid value for [min_improvement : 0.0 < x < 1.0 | \"none\"]: %g", improvement); - goto err_free_cluster; + /** Sliding window doesn't allocate any clusters. **/ + cluster_data->nClusters = 0u; + + /** Get window_size. **/ + int window_size; + if (ci_ParseAttribute(inf, "window_size", DATA_T_INTEGER, POD(&window_size), param_list, true, true) != 0) + goto err_free; + if (window_size < 1) + { + mssErrorf(1, "Cluster", "Invalid value for [window_size : uint > 0]: %d", window_size); + goto err_free; + } + + /** Store value. **/ + cluster_data->MaxIterations = (unsigned int)window_size; + goto parsing_done; } - /** Successfully got value. **/ - cluster_data->MinImprovement = improvement; - } - else if (result == -1) - { - char* str; - result = ci_ParseAttribute(inf, "min_improvement", DATA_T_STRING, POD(&str), param_list, false, true); - if (result != 0) goto err_free_cluster; - if (strcasecmp(str, "none") != 0) + /** Get num_clusters. **/ + int num_clusters; + if (ci_ParseAttribute(inf, "num_clusters", DATA_T_INTEGER, POD(&num_clusters), param_list, true, true) != 0) + goto err_free; + if (num_clusters < 2) { - mssErrorf(1, "Cluster", "Invalid value for [min_improvement : 0.0 < x < 1.0 | \"none\"]: %s", str); - goto err_free_cluster; + mssErrorf(1, "Cluster", "Invalid value for [num_clusters : uint > 1]: %d", num_clusters); + if (num_clusters == 1) fprintf(stderr, "HINT: Use algorithm=\"none\" to disable clustering.\n"); + goto err_free; } + cluster_data->nClusters = (unsigned int)num_clusters; - /** Successfully got none. **/ - cluster_data->MinImprovement = -INFINITY; - } - - /** Get max_iterations. **/ - int max_iterations; - result = ci_ParseAttribute(inf, "max_iterations", DATA_T_INTEGER, POD(&max_iterations), param_list, false, true); - if (result == -1) goto err_free_cluster; - if (result == 0) - { - if (max_iterations < 1) + /** Get min_improvement. **/ + double improvement; + result = ci_ParseAttribute(inf, "min_improvement", DATA_T_DOUBLE, POD(&improvement), param_list, false, false); + if (result == 1) cluster_data->MinImprovement = DEFAULT_MIN_IMPROVEMENT; + else if (result == 0) { - mssErrorf(1, "Cluster", "Invalid value for [max_iterations : uint]: %d", max_iterations); - goto err_free_cluster; + if (improvement <= 0.0 || 1.0 <= improvement) + { + mssErrorf(1, "Cluster", "Invalid value for [min_improvement : 0.0 < x < 1.0 | \"none\"]: %g", improvement); + goto err_free; + } + + /** Successfully got value. **/ + cluster_data->MinImprovement = improvement; } - cluster_data->MaxIterations = (unsigned int)max_iterations; - } - else cluster_data->MaxIterations = DEFAULT_MAX_ITERATIONS; - - /** Search for sub-clusters. **/ - XArray sub_clusters; - if (!check(xaInit(&sub_clusters, 4u))) goto err_free_cluster; - for (unsigned int i = 0u; i < inf->nSubInf; i++) - { - pStructInf sub_inf = check_ptr(inf->SubInf[i]); - ASSERTMAGIC(sub_inf, MGK_STRUCTINF); - char* name = sub_inf->Name; - - /** Handle various struct types. **/ - const int struct_type = stStructType(sub_inf); - switch (struct_type) + else if (result == -1) { - case ST_T_ATTRIB: + char* str; + result = ci_ParseAttribute(inf, "min_improvement", DATA_T_STRING, POD(&str), param_list, false, true); + if (result != 0) goto err_free; + if (strcasecmp(str, "none") != 0) { - /** Valid attribute names. **/ - char* attrs[] = { - "algorithm", - "similarity_measure", - "num_clusters", - "min_improvement", - "max_iterations", - "window_size", - }; - const unsigned int nattrs = sizeof(attrs) / sizeof(char*); - - /** Ignore valid attribute names. **/ - bool is_valid = false; - for (unsigned int i = 0u; i < nattrs; i++) + mssErrorf(1, "Cluster", "Invalid value for [min_improvement : 0.0 < x < 1.0 | \"none\"]: %s", str); + goto err_free; + } + + /** Successfully got none. **/ + cluster_data->MinImprovement = -INFINITY; + } + + /** Get max_iterations. **/ + int max_iterations; + result = ci_ParseAttribute(inf, "max_iterations", DATA_T_INTEGER, POD(&max_iterations), param_list, false, true); + if (result == -1) goto err_free; + if (result == 0) + { + if (max_iterations < 1) + { + mssErrorf(1, "Cluster", "Invalid value for [max_iterations : uint]: %d", max_iterations); + goto err_free; + } + cluster_data->MaxIterations = (unsigned int)max_iterations; + } + else cluster_data->MaxIterations = DEFAULT_MAX_ITERATIONS; + + /** Search for sub-clusters. **/ + if (!check(xaInit(&sub_clusters, 4u))) goto err_free; + for (unsigned int i = 0u; i < inf->nSubInf; i++) + { + pStructInf sub_inf = check_ptr(inf->SubInf[i]); + ASSERTMAGIC(sub_inf, MGK_STRUCTINF); + char* name = sub_inf->Name; + + /** Handle various struct types. **/ + const int struct_type = stStructType(sub_inf); + switch (struct_type) + { + case ST_T_ATTRIB: { - if (strcmp(name, attrs[i]) == 0) + /** Valid attribute names. **/ + char* attrs[] = { + "algorithm", + "similarity_measure", + "num_clusters", + "min_improvement", + "max_iterations", + "window_size", + }; + const unsigned int nattrs = sizeof(attrs) / sizeof(char*); + + /** Ignore valid attribute names. **/ + bool is_valid = false; + for (unsigned int i = 0u; i < nattrs; i++) { - is_valid = true; - break; + if (strcmp(name, attrs[i]) == 0) + { + is_valid = true; + break; + } } + if (is_valid) continue; /* Next inf. */ + + /** Give the user a warning, and attempt to give them a hint. **/ + fprintf(stderr, "Warning: Unknown attribute '%s' in cluster \"%s\".\n", name, inf->Name); + if (ci_TryHint(name, attrs, nattrs)); + else if (strcasecmp(name, "k") == 0) ci_GiveHint("num_clusters"); + else if (strcasecmp(name, "threshold") == 0) ci_GiveHint("min_improvement"); + + break; } - if (is_valid) continue; /* Next inf. */ - /** Give the user a warning, and attempt to give them a hint. **/ - fprintf(stderr, "Warning: Unknown attribute '%s' in cluster \"%s\".\n", name, inf->Name); - if (ci_TryHint(name, attrs, nattrs)); - else if (strcasecmp(name, "k") == 0) ci_GiveHint("num_clusters"); - else if (strcasecmp(name, "threshold") == 0) ci_GiveHint("min_improvement"); + case ST_T_SUBGROUP: + { + /** Select array by group type. **/ + char* group_type = check_ptr(sub_inf->UsrType); + if (group_type == NULL) goto err_free; + if (strcmp(group_type, "cluster/cluster") != 0) + { + mssErrorf(1, "Cluster", + "Warning: Unknown group [\"%s\" : \"%s\"] in cluster \"%s\".\n", + name, group_type, inf->Name + ); + continue; + } + + /** Subcluster found. **/ + pClusterData sub_cluster = ci_ParseClusterData(sub_inf, node_data); + if (sub_cluster == NULL) goto err_free; + sub_cluster->Parent = cluster_data; + if (!check_neg(xaAddItem(&sub_clusters, sub_cluster))) goto err_free; + + break; + } - break; - } - - case ST_T_SUBGROUP: - { - /** Select array by group type. **/ - char* group_type = check_ptr(sub_inf->UsrType); - if (group_type == NULL) goto err_free_subclusters; - if (strcmp(group_type, "cluster/cluster") != 0) + default: { mssErrorf(1, "Cluster", - "Warning: Unknown group [\"%s\" : \"%s\"] in cluster \"%s\".\n", - name, group_type, inf->Name + "Warning: Unknown struct type %d in cluster \"%s\".", + struct_type, inf->Name ); - continue; + goto err_free; } - - /** Subcluster found. **/ - pClusterData sub_cluster = ci_ParseClusterData(sub_inf, node_data); - if (sub_cluster == NULL) goto err_free_subclusters; - sub_cluster->Parent = cluster_data; - if (!check_neg(xaAddItem(&sub_clusters, sub_cluster))) goto err_free_subclusters; - + } + } + cluster_data->nSubClusters = sub_clusters.nItems; + cluster_data->SubClusters = (pClusterData*)ci_xaToTrimmedArray(&sub_clusters, 1); + sub_clusters.nAlloc = 0; + + /** Create the cache key. **/ + parsing_done:; + switch (cluster_data->ClusterAlgorithm) + { + case ALGORITHM_NONE: + { + const size_t len = strlen(source_data->Key) + strlen(cluster_data->Name) + 8lu; + key = nmSysMalloc(len * sizeof(char)); + snprintf(key, len, "%s/%s?%u", + source_data->Key, + cluster_data->Name, + ALGORITHM_NONE + ); + break; + } + + case ALGORITHM_SLIDING_WINDOW: + { + const size_t len = strlen(source_data->Key) + strlen(cluster_data->Name) + 16lu; + key = nmSysMalloc(len * sizeof(char)); + snprintf(key, len, "%s/%s?%u&%u&%u", + source_data->Key, + cluster_data->Name, + ALGORITHM_SLIDING_WINDOW, + cluster_data->SimilarityMeasure, + cluster_data->MaxIterations + ); break; } default: { - mssErrorf(1, "Cluster", - "Warning: Unknown struct type %d in cluster \"%s\".", - struct_type, inf->Name + const size_t len = strlen(source_data->Key) + strlen(cluster_data->Name) + 32lu; + key = nmSysMalloc(len * sizeof(char)); + snprintf(key, len, "%s/%s?%u&%u&%u&%g&%u", + source_data->Key, + cluster_data->Name, + cluster_data->ClusterAlgorithm, + cluster_data->SimilarityMeasure, + cluster_data->nClusters, + cluster_data->MinImprovement, + cluster_data->MaxIterations ); - goto err_free_subclusters; + break; } } - } - cluster_data->nSubClusters = sub_clusters.nItems; - cluster_data->SubClusters = (pClusterData*)ci_xaToTrimmedArray(&sub_clusters, 1); - - /** Create the cache key. **/ - parsing_done:; - char* key; - switch (cluster_data->ClusterAlgorithm) - { - case ALGORITHM_NONE: - { - const size_t len = strlen(source_data->Key) + strlen(cluster_data->Name) + 8lu; - key = nmSysMalloc(len * sizeof(char)); - snprintf(key, len, "%s/%s?%u", - source_data->Key, - cluster_data->Name, - ALGORITHM_NONE - ); - break; - } + cluster_data->Key = key; - case ALGORITHM_SLIDING_WINDOW: - { - const size_t len = strlen(source_data->Key) + strlen(cluster_data->Name) + 16lu; - key = nmSysMalloc(len * sizeof(char)); - snprintf(key, len, "%s/%s?%u&%u&%u", - source_data->Key, - cluster_data->Name, - ALGORITHM_SLIDING_WINDOW, - cluster_data->SimilarityMeasure, - cluster_data->MaxIterations - ); - break; + /** Check for a cached version. **/ + pClusterData cluster_maybe = (pClusterData)xhLookup(&ClusterDriverCaches.ClusterDataCache, key); + if (cluster_maybe != NULL) + { /* Cache hit. */ + /** Free the parsed cluster that we no longer need. */ + ci_FreeClusterData(cluster_data, false); + nmSysFree(key); + + /** Return the cached cluster. **/ + return cluster_maybe; } - default: + /** Cache miss. **/ + if (!check(xhAdd(&ClusterDriverCaches.ClusterDataCache, key, (void*)cluster_data))) goto err_free; + return cluster_data; + + /** Error cleanup. **/ + err_free: + if (key != NULL) nmSysFree(key); + + if (sub_clusters.nAlloc != 0) { - const size_t len = strlen(source_data->Key) + strlen(cluster_data->Name) + 32lu; - key = nmSysMalloc(len * sizeof(char)); - snprintf(key, len, "%s/%s?%u&%u&%u&%g&%u", - source_data->Key, - cluster_data->Name, - cluster_data->ClusterAlgorithm, - cluster_data->SimilarityMeasure, - cluster_data->nClusters, - cluster_data->MinImprovement, - cluster_data->MaxIterations - ); - break; + for (unsigned int i = 0u; i < sub_clusters.nItems; i++) + { + pClusterData cur = sub_clusters.Items[i]; + if (cur == NULL) break; + ci_FreeClusterData(cur, true); + } + check(xaDeInit(&sub_clusters)); /* Failure ignored. */ } - } - cluster_data->Key = key; - - /** Check for a cached version. **/ - pClusterData cluster_maybe = (pClusterData)xhLookup(&ClusterDriverCaches.ClusterDataCache, key); - if (cluster_maybe != NULL) - { /* Cache hit. */ - /** Free the parsed cluster that we no longer need. */ - ci_FreeClusterData(cluster_data, false); - nmSysFree(key); - /** Return the cached cluster. **/ - return cluster_maybe; - } - - /** Cache miss. **/ - if (!check(xhAdd(&ClusterDriverCaches.ClusterDataCache, key, (void*)cluster_data))) goto err_free_key; - return cluster_data; - - /** Error cleanup. **/ - err_free_key: - nmSysFree(key); - - err_free_subclusters: - for (unsigned int i = 0u; i < sub_clusters.nItems; i++) - ci_FreeClusterData(sub_clusters.Items[i], true); - check(xaDeInit(&sub_clusters)); /* Failure ignored. */ - - err_free_cluster: - ci_FreeClusterData(cluster_data, false); - - err: - mssErrorf(0, "Cluster", "Failed to parse cluster from group \"%s\".", inf->Name); - return NULL; + if (cluster_data != NULL) ci_FreeClusterData(cluster_data, false); + + mssErrorf(0, "Cluster", "Failed to parse cluster from group \"%s\".", inf->Name); + return NULL; } @@ -1365,164 +1295,166 @@ static pClusterData ci_ParseClusterData(pStructInf inf, pNodeData node_data) *** @returns A new pSearchData struct on success, or NULL on failure. ***/ static pSearchData ci_ParseSearchData(pStructInf inf, pNodeData node_data) - { - /** Allocate space for search struct. **/ - pSearchData search_data = check_ptr(nmMalloc(sizeof(SearchData))); - if (search_data == NULL) goto err; - memset(search_data, 0, sizeof(SearchData)); - - /** Get basic information. **/ - search_data->Name = check_ptr(nmSysStrdup(inf->Name)); - if (search_data->Name == NULL) goto err_free_search; - if (!check(objCurrentDate(&search_data->DateCreated))) goto err_free_search; + { + pSearchData search_data = NULL; + char* key = NULL; - /** Get source cluster. **/ - char* source_cluster_name; - if (ci_ParseAttribute(inf, "source", DATA_T_STRING, POD(&source_cluster_name), node_data->ParamList, true, true) != 0) return NULL; - for (unsigned int i = 0; i < node_data->nClusterDatas; i++) - { - pClusterData cluster_data = node_data->ClusterDatas[i]; - if (strcmp(source_cluster_name, cluster_data->Name) == 0) - { - /** SourceCluster found. **/ - search_data->SourceCluster = cluster_data; - break; - } + /** Allocate space for search struct. **/ + search_data = check_ptr(nmMalloc(sizeof(SearchData))); + if (search_data == NULL) goto err_free; + memset(search_data, 0, sizeof(SearchData)); - /** Note: Subclusters should probably be parsed here, if they were implemented. **/ - } - - /** Did we find the requested source? **/ - if (search_data->SourceCluster == NULL) - { - /** Print error. **/ - mssErrorf(1, "Cluster", "Could not find cluster \"%s\" for search \"%s\".", source_cluster_name, search_data->Name); + /** Get basic information. **/ + search_data->Name = check_ptr(nmSysStrdup(inf->Name)); + if (search_data->Name == NULL) goto err_free; + if (!check(objCurrentDate(&search_data->DateCreated))) goto err_free; - /** Attempt to give a hint. **/ - char* cluster_names[node_data->nClusterDatas]; + /** Get source cluster. **/ + char* source_cluster_name; + if (ci_ParseAttribute(inf, "source", DATA_T_STRING, POD(&source_cluster_name), node_data->ParamList, true, true) != 0) return NULL; for (unsigned int i = 0; i < node_data->nClusterDatas; i++) - cluster_names[i] = node_data->ClusterDatas[i]->Name; - ci_TryHint(source_cluster_name, cluster_names, node_data->nClusterDatas); - - /** Fail. **/ - goto err_free_search; - } - - /** Get threshold attribute. **/ - if (ci_ParseAttribute(inf, "threshold", DATA_T_DOUBLE, POD(&search_data->Threshold), node_data->ParamList, true, true) != 0) goto err_free_search; - if (search_data->Threshold <= 0.0 || 1.0 <= search_data->Threshold) - { - mssErrorf(1, "Cluster", - "Invalid value for [threshold : 0.0 < x < 1.0 | \"none\"]: %g", - search_data->Threshold - ); - goto err_free_search; - } - - /** Get similarity measure. **/ - search_data->SimilarityMeasure = ci_ParseSimilarityMeasure(inf, node_data->ParamList); - if (search_data->SimilarityMeasure == SIMILARITY_NULL) goto err_free_search; - - /** Check for additional data to warn the user about. **/ - for (unsigned int i = 0u; i < inf->nSubInf; i++) - { - pStructInf sub_inf = check_ptr(inf->SubInf[i]); - ASSERTMAGIC(sub_inf, MGK_STRUCTINF); - char* name = sub_inf->Name; - - /** Handle various struct types. **/ - const int struct_type = stStructType(sub_inf); - switch (struct_type) { - case ST_T_ATTRIB: + pClusterData cluster_data = node_data->ClusterDatas[i]; + if (strcmp(source_cluster_name, cluster_data->Name) == 0) { - /** Valid attribute names. **/ - char* attrs[] = { - "source", - "threshold", - "similarity_measure", - }; - const unsigned int nattrs = sizeof(attrs) / sizeof(char*); - - /** Ignore valid attribute names. **/ - bool is_valid = false; - for (unsigned int i = 0u; i < nattrs; i++) - { - if (strcmp(name, attrs[i]) == 0) - { - is_valid = true; - break; - } - } - if (is_valid) continue; /* Next inf. */ - - /** Give the user a warning, and attempt to give them a hint. **/ - fprintf(stderr, "Warning: Unknown attribute '%s' in search \"%s\".\n", name, inf->Name); - ci_TryHint(name, attrs, nattrs); - + /** SourceCluster found. **/ + search_data->SourceCluster = cluster_data; break; } - case ST_T_SUBGROUP: - { - /** The spec does not specify any valid sub-groups for searches. **/ - char* group_type = check_ptr(sub_inf->UsrType); - if (group_type == NULL) goto err_free_search; - fprintf(stderr, - "Warning: Unknown group [\"%s\" : \"%s\"] in search \"%s\".\n", - name, group_type, inf->Name - ); - break; - } + /** Note: Subclusters should probably be parsed here, if they were implemented. **/ + } + + /** Did we find the requested source? **/ + if (search_data->SourceCluster == NULL) + { + /** Print error. **/ + mssErrorf(1, "Cluster", "Could not find cluster \"%s\" for search \"%s\".", source_cluster_name, search_data->Name); - default: + /** Attempt to give a hint. **/ + char* cluster_names[node_data->nClusterDatas]; + for (unsigned int i = 0; i < node_data->nClusterDatas; i++) + cluster_names[i] = node_data->ClusterDatas[i]->Name; + ci_TryHint(source_cluster_name, cluster_names, node_data->nClusterDatas); + + /** Fail. **/ + goto err_free; + } + + /** Get threshold attribute. **/ + if (ci_ParseAttribute(inf, "threshold", DATA_T_DOUBLE, POD(&search_data->Threshold), node_data->ParamList, true, true) != 0) goto err_free; + if (search_data->Threshold <= 0.0 || 1.0 <= search_data->Threshold) + { + mssErrorf(1, "Cluster", + "Invalid value for [threshold : 0.0 < x < 1.0 | \"none\"]: %g", + search_data->Threshold + ); + goto err_free; + } + + /** Get similarity measure. **/ + search_data->SimilarityMeasure = ci_ParseSimilarityMeasure(inf, node_data->ParamList); + if (search_data->SimilarityMeasure == SIMILARITY_NULL) goto err_free; + + /** Check for additional data to warn the user about. **/ + for (unsigned int i = 0u; i < inf->nSubInf; i++) + { + pStructInf sub_inf = check_ptr(inf->SubInf[i]); + ASSERTMAGIC(sub_inf, MGK_STRUCTINF); + char* name = sub_inf->Name; + + /** Handle various struct types. **/ + const int struct_type = stStructType(sub_inf); + switch (struct_type) { - mssErrorf(1, "Cluster", - "Warning: Unknown struct type %d in search \"%s\".", - struct_type, inf->Name - ); - goto err_free_search; + case ST_T_ATTRIB: + { + /** Valid attribute names. **/ + char* attrs[] = { + "source", + "threshold", + "similarity_measure", + }; + const unsigned int nattrs = sizeof(attrs) / sizeof(char*); + + /** Ignore valid attribute names. **/ + bool is_valid = false; + for (unsigned int i = 0u; i < nattrs; i++) + { + if (strcmp(name, attrs[i]) == 0) + { + is_valid = true; + break; + } + } + if (is_valid) continue; /* Next inf. */ + + /** Give the user a warning, and attempt to give them a hint. **/ + fprintf(stderr, "Warning: Unknown attribute '%s' in search \"%s\".\n", name, inf->Name); + ci_TryHint(name, attrs, nattrs); + + break; + } + + case ST_T_SUBGROUP: + { + /** The spec does not specify any valid sub-groups for searches. **/ + char* group_type = check_ptr(sub_inf->UsrType); + if (group_type == NULL) goto err_free; + fprintf(stderr, + "Warning: Unknown group [\"%s\" : \"%s\"] in search \"%s\".\n", + name, group_type, inf->Name + ); + break; + } + + default: + { + mssErrorf(1, "Cluster", + "Warning: Unknown struct type %d in search \"%s\".", + struct_type, inf->Name + ); + goto err_free; + } } } - } - - /** Create cache entry key. **/ - char* source_key = search_data->SourceCluster->Key; - const size_t len = strlen(source_key) + strlen(search_data->Name) + 16lu; - char* key = check_ptr(nmSysMalloc(len * sizeof(char))); - if (key == NULL) goto err_free_search; - snprintf(key, len, "%s/%s?%g&%u", - source_key, - search_data->Name, - search_data->Threshold, - search_data->SimilarityMeasure - ); - pXHashTable search_cache = &ClusterDriverCaches.SearchDataCache; - - /** Check for a cached version. **/ - pSearchData search_maybe = (pSearchData)xhLookup(search_cache, key); - if (search_maybe != NULL) - { /* Cache hit. */ - /** Free the parsed search that we no longer need. **/ - ci_FreeSearchData(search_data); - nmSysFree(key); + /** Create cache entry key. **/ + char* source_key = search_data->SourceCluster->Key; + const size_t len = strlen(source_key) + strlen(search_data->Name) + 16lu; + key = check_ptr(nmSysMalloc(len * sizeof(char))); + if (key == NULL) goto err_free; + snprintf(key, len, "%s/%s?%g&%u", + source_key, + search_data->Name, + search_data->Threshold, + search_data->SimilarityMeasure + ); + pXHashTable search_cache = &ClusterDriverCaches.SearchDataCache; - /** Return the cached search. **/ - return search_maybe; - } - - /** Cache miss. **/ - check(xhAdd(search_cache, key, (void*)search_data)); - return search_data; - - /** Error cleanup. **/ - err_free_search: - ci_FreeSearchData(search_data); - - err: - mssErrorf(0, "Cluster", "Failed to parse SearchData from group \"%s\".", inf->Name); - return NULL; + /** Check for a cached version. **/ + pSearchData search_maybe = (pSearchData)xhLookup(search_cache, key); + if (search_maybe != NULL) + { /* Cache hit. */ + /** Free the parsed search that we no longer need. **/ + if (search_data != NULL) ci_FreeSearchData(search_data); + if (key != NULL) nmSysFree(key); + + /** Return the cached search. **/ + return search_maybe; + } + + /** Cache miss. **/ + check(xhAdd(search_cache, key, (void*)search_data)); + return search_data; + + /** Error cleanup. **/ + err_free: + if (search_data != NULL) ci_FreeSearchData(search_data); + + mssErrorf(0, "Cluster", "Failed to parse SearchData from group \"%s\".", inf->Name); + + return NULL; } @@ -1541,284 +1473,283 @@ static pSearchData ci_ParseSearchData(pStructInf inf, pNodeData node_data) ***/ static pNodeData ci_ParseNodeData(pStructInf inf, pObject parent) { - int ret; - char* path = check_ptr(ci_file_path(parent)); - if (path == NULL) goto err; - - /** Allocate node struct data. **/ - pNodeData node_data = check_ptr(nmMalloc(sizeof(NodeData))); - if (node_data == NULL) goto err; - memset(node_data, 0, sizeof(NodeData)); - node_data->Parent = parent; - - /** Set up param list. **/ - node_data->ParamList = check_ptr(expCreateParamList()); - if (node_data->ParamList == NULL) goto err; - node_data->ParamList->Session = check_ptr(parent->Session); - if (node_data->ParamList->Session == NULL) goto err; - ret = expAddParamToList(node_data->ParamList, "parameters", (void*)node_data, 0); - if (ret != 0) - { - mssErrorf(0, "Cluster", "Failed to add parameters to the param list scope (error code %d).", ret); - goto err_free_node; - } - - /** Set the param functions, defined later in the file. **/ - ret = expSetParamFunctions( - node_data->ParamList, - "parameters", - ci_GetParamType, - ci_GetParamValue, - ci_SetParamValue - ); - if (ret != 0) - { - mssErrorf(0, "Cluster", "Failed to set param functions (error code %d).", ret); - goto err_free_node; - } - - /** Detect relevant groups. **/ - XArray param_infs, cluster_infs, search_infs; - memset(¶m_infs, 0, sizeof(XArray)); - memset(&cluster_infs, 0, sizeof(XArray)); - memset(&search_infs, 0, sizeof(XArray)); - if (!check(xaInit(¶m_infs, 8))) goto err_free_arrs; - if (!check(xaInit(&cluster_infs, 8))) goto err_free_arrs; - if (!check(xaInit(&search_infs, 8))) goto err_free_arrs; - for (unsigned int i = 0u; i < inf->nSubInf; i++) - { - pStructInf sub_inf = check_ptr(inf->SubInf[i]); - ASSERTMAGIC(sub_inf, MGK_STRUCTINF); - char* name = sub_inf->Name; - - /** Handle various struct types. **/ - const int struct_type = stStructType(sub_inf); - switch (struct_type) + int ret = -1; + pNodeData node_data = NULL; + XArray param_infs = {0}; + XArray cluster_infs = {0}; + XArray search_infs = {0}; + + /** Get file path. **/ + char* path = check_ptr(ci_file_path(parent)); + if (path == NULL) goto err_free; + + /** Allocate node struct data. **/ + node_data = check_ptr(nmMalloc(sizeof(NodeData))); + if (node_data == NULL) goto err_free; + memset(node_data, 0, sizeof(NodeData)); + node_data->Parent = parent; + + /** Set up param list. **/ + node_data->ParamList = check_ptr(expCreateParamList()); + if (node_data->ParamList == NULL) goto err_free; + node_data->ParamList->Session = check_ptr(parent->Session); + if (node_data->ParamList->Session == NULL) goto err_free; + ret = expAddParamToList(node_data->ParamList, "parameters", (void*)node_data, 0); + if (ret != 0) + { + mssErrorf(0, "Cluster", "Failed to add parameters to the param list scope (error code %d).", ret); + goto err_free; + } + + /** Set the param functions, defined later in the file. **/ + ret = expSetParamFunctions( + node_data->ParamList, + "parameters", + ci_GetParamType, + ci_GetParamValue, + ci_SetParamValue + ); + if (ret != 0) + { + mssErrorf(0, "Cluster", "Failed to set param functions (error code %d).", ret); + goto err_free; + } + + /** Detect relevant groups. **/ + if (!check(xaInit(¶m_infs, 8))) goto err_free; + if (!check(xaInit(&cluster_infs, 8))) goto err_free; + if (!check(xaInit(&search_infs, 8))) goto err_free; + for (unsigned int i = 0u; i < inf->nSubInf; i++) { - case ST_T_ATTRIB: + pStructInf sub_inf = check_ptr(inf->SubInf[i]); + ASSERTMAGIC(sub_inf, MGK_STRUCTINF); + char* name = sub_inf->Name; + + /** Handle various struct types. **/ + const int struct_type = stStructType(sub_inf); + switch (struct_type) { - /** Valid attribute names. **/ - char* attrs[] = { - "source", - "key_attr", - "data_attr", - }; - const unsigned int nattrs = sizeof(attrs) / sizeof(char*); - - /** Ignore valid attribute names. **/ - bool is_valid = false; - for (unsigned int i = 0u; i < nattrs; i++) + case ST_T_ATTRIB: { - if (strcmp(name, attrs[i]) == 0) + /** Valid attribute names. **/ + char* attrs[] = { + "source", + "key_attr", + "data_attr", + }; + const unsigned int nattrs = sizeof(attrs) / sizeof(char*); + + /** Ignore valid attribute names. **/ + bool is_valid = false; + for (unsigned int i = 0u; i < nattrs; i++) { - is_valid = true; - break; + if (strcmp(name, attrs[i]) == 0) + { + is_valid = true; + break; + } } + if (is_valid) continue; /* Next inf. */ + + /** Give the user a warning, and attempt to give them a hint. **/ + fprintf(stderr, "Warning: Unknown attribute '%s' in cluster node \"%s\".\n", name, inf->Name); + ci_TryHint(name, attrs, nattrs); + + break; } - if (is_valid) continue; /* Next inf. */ - /** Give the user a warning, and attempt to give them a hint. **/ - fprintf(stderr, "Warning: Unknown attribute '%s' in cluster node \"%s\".\n", name, inf->Name); - ci_TryHint(name, attrs, nattrs); - - break; - } - - case ST_T_SUBGROUP: - { - /** The spec does not specify any valid sub-groups for searches. **/ - char* group_type = check_ptr(sub_inf->UsrType); - if (group_type == NULL) goto err_free_arrs; - if (strcmp(group_type, "cluster/parameter") == 0) - { - if (!check_neg(xaAddItem(¶m_infs, sub_inf))) - goto err_free_arrs; - } - else if (strcmp(group_type, "cluster/cluster") == 0) + case ST_T_SUBGROUP: { - if (!check_neg(xaAddItem(&cluster_infs, sub_inf))) - goto err_free_arrs; + /** The spec does not specify any valid sub-groups for searches. **/ + char* group_type = check_ptr(sub_inf->UsrType); + if (group_type == NULL) goto err_free; + if (strcmp(group_type, "cluster/parameter") == 0) + { + if (!check_neg(xaAddItem(¶m_infs, sub_inf))) + goto err_free; + } + else if (strcmp(group_type, "cluster/cluster") == 0) + { + if (!check_neg(xaAddItem(&cluster_infs, sub_inf))) + goto err_free; + } + else if (strcmp(group_type, "cluster/search") == 0) + { + if (!check_neg(xaAddItem(&search_infs, sub_inf))) + goto err_free; + } + else + { + /** Give the user a warning, and attempt to give them a hint. **/ + fprintf(stderr, + "Warning: Unknown group type \"%s\" on group \"%s\".\n", + group_type, sub_inf->Name + ); + ci_TryHint(group_type, (char*[]){ + "cluster/parameter", + "cluster/cluster", + "cluster/search", + NULL, + }, 0u); + } + break; } - else if (strcmp(group_type, "cluster/search") == 0) + + default: { - if (!check_neg(xaAddItem(&search_infs, sub_inf))) - goto err_free_arrs; + mssErrorf(1, "Cluster", + "Warning: Unknown struct type %d in search \"%s\".", + struct_type, inf->Name + ); + goto err_free; } - else + } + } + + /** Extract OpenCtl for use below. **/ + bool has_provided_params = parent != NULL + && parent->Pathname != NULL + && parent->Pathname->OpenCtl != NULL + && parent->Pathname->OpenCtl[parent->SubPtr - 1] != NULL + && parent->Pathname->OpenCtl[parent->SubPtr - 1]->nSubInf > 0 + && parent->Pathname->OpenCtl[parent->SubPtr - 1]->SubInf != NULL; + int num_provided_params = (has_provided_params) ? parent->Pathname->OpenCtl[parent->SubPtr - 1]->nSubInf : 0; + pStruct* provided_params = (has_provided_params) ? parent->Pathname->OpenCtl[parent->SubPtr - 1]->SubInf : NULL; + + /** Iterate over each param in the structure file. **/ + node_data->nParams = param_infs.nItems; + const size_t params_size = node_data->nParams * sizeof(pParam); + node_data->Params = check_ptr(nmSysMalloc(params_size)); + if (node_data->Params == NULL) goto err_free; + memset(node_data->Params, 0, params_size); + for (unsigned int i = 0u; i < node_data->nParams; i++) + { + pParam param = paramCreateFromInf(param_infs.Items[i]); + if (param == NULL) + { + mssErrorf(0, "Cluster", + "Failed to create param from inf for param #%u: %s", + i, ((pStructInf)param_infs.Items[i])->Name + ); + goto err_free; + } + node_data->Params[i] = param; + + /** Check each provided param to see if the user provided value. **/ + for (unsigned int j = 0u; j < num_provided_params; j++) + { + pStruct provided_param = check_ptr(provided_params[j]); /* Failure ignored. */ + + /** If this provided param value isn't for the param, ignore it. **/ + if (strcmp(provided_param->Name, param->Name) != 0) continue; + + /** Matched! The user is providing a value for this param. **/ + ret = paramSetValueFromInfNe(param, provided_param, 0, node_data->ParamList, node_data->ParamList->Session); + if (ret != 0) { - /** Give the user a warning, and attempt to give them a hint. **/ - fprintf(stderr, - "Warning: Unknown group type \"%s\" on group \"%s\".\n", - group_type, sub_inf->Name + mssErrorf(0, "Cluster", + "Failed to set param value from struct info.\n" + " > Param #%u: %s\n" + " > Provided Param #%u: %n\n" + " > Error code: %d", + i, param->Name, + j, provided_param->Name, + ret ); - ci_TryHint(group_type, (char*[]){ - "cluster/parameter", - "cluster/cluster", - "cluster/search", - NULL, - }, 0u); + goto err_free; } + + /** Provided value successfully handled, we're done. **/ break; } - default: + /** Invoke param hints parsing. **/ + ret = paramEvalHints(param, node_data->ParamList, node_data->ParamList->Session); + if (ret != 0) { - mssErrorf(1, "Cluster", - "Warning: Unknown struct type %d in search \"%s\".", - struct_type, inf->Name + mssErrorf(0, "Cluster", + "Failed to evaluate parameter hints for parameter \"%s\" (error code %d).", + param->Name, ret ); - goto err_free_arrs; + goto err_free; } } - } - - /** Extract OpenCtl for use below. **/ - bool has_provided_params = parent != NULL - && parent->Pathname != NULL - && parent->Pathname->OpenCtl != NULL - && parent->Pathname->OpenCtl[parent->SubPtr - 1] != NULL - && parent->Pathname->OpenCtl[parent->SubPtr - 1]->nSubInf > 0 - && parent->Pathname->OpenCtl[parent->SubPtr - 1]->SubInf != NULL; - int num_provided_params = (has_provided_params) ? parent->Pathname->OpenCtl[parent->SubPtr - 1]->nSubInf : 0; - pStruct* provided_params = (has_provided_params) ? parent->Pathname->OpenCtl[parent->SubPtr - 1]->SubInf : NULL; - - /** Iterate over each param in the structure file. **/ - node_data->nParams = param_infs.nItems; - const size_t params_size = node_data->nParams * sizeof(pParam); - node_data->Params = check_ptr(nmSysMalloc(params_size)); - if (node_data->Params == NULL) goto err_free_arrs; - memset(node_data->Params, 0, params_size); - for (unsigned int i = 0u; i < node_data->nParams; i++) - { - pParam param = paramCreateFromInf(param_infs.Items[i]); - if (param == NULL) - { - mssErrorf(0, "Cluster", - "Failed to create param from inf for param #%u: %s", - i, ((pStructInf)param_infs.Items[i])->Name - ); - goto err_free_arrs; - } - node_data->Params[i] = param; + check(xaDeInit(¶m_infs)); /* Failure ignored. */ + param_infs.nAlloc = 0; - /** Check each provided param to see if the user provided value. **/ - for (unsigned int j = 0u; j < num_provided_params; j++) + /** Iterate over provided parameters and warn the user if they specified a parameter that does not exist. **/ + for (unsigned int i = 0u; i < num_provided_params; i++) { - pStruct provided_param = check_ptr(provided_params[j]); /* Failure ignored. */ + pStruct provided_param = check_ptr(provided_params[i]); /* Failure ignored. */ + char* provided_name = provided_param->Name; - /** If this provided param value isn't for the param, ignore it. **/ - if (strcmp(provided_param->Name, param->Name) != 0) continue; + /** Look to see if this provided param actually exists for this driver instance. **/ + for (unsigned int j = 0u; j < node_data->nParams; j++) + if (strcmp(provided_name, node_data->Params[j]->Name) == 0) + goto next_provided_param; - /** Matched! The user is providing a value for this param. **/ - ret = paramSetValueFromInfNe(param, provided_param, 0, node_data->ParamList, node_data->ParamList->Session); - if (ret != 0) - { - mssErrorf(0, "Cluster", - "Failed to set param value from struct info.\n" - " > Param #%u: %s\n" - " > Provided Param #%u: %n\n" - " > Error code: %d", - i, param->Name, - j, provided_param->Name, - ret - ); - goto err_free_arrs; - } + /** This param doesn't exist, warn the user and attempt to give them a hint. **/ + fprintf(stderr, "Warning: Unknown provided parameter '%s' for cluster file: %s.\n", provided_name, ci_file_name(parent)); + char** param_names = check_ptr(nmSysMalloc(node_data->nParams * sizeof(char*))); + for (unsigned int j = 0u; j < node_data->nParams; j++) + param_names[j] = node_data->Params[j]->Name; + ci_TryHint(provided_name, param_names, node_data->nParams); + nmSysFree(param_names); - /** Provided value successfully handled, we're done. **/ - break; + next_provided_param:; } - /** Invoke param hints parsing. **/ - ret = paramEvalHints(param, node_data->ParamList, node_data->ParamList->Session); - if (ret != 0) - { - mssErrorf(0, "Cluster", - "Failed to evaluate parameter hints for parameter \"%s\" (error code %d).", - param->Name, ret - ); - goto err_free_arrs; - } - } - check(xaDeInit(¶m_infs)); /* Failure ignored. */ - param_infs.nAlloc = 0; - - /** Iterate over provided parameters and warn the user if they specified a parameter that does not exist. **/ - for (unsigned int i = 0u; i < num_provided_params; i++) - { - pStruct provided_param = check_ptr(provided_params[i]); /* Failure ignored. */ - char* provided_name = provided_param->Name; - - /** Look to see if this provided param actually exists for this driver instance. **/ - for (unsigned int j = 0u; j < node_data->nParams; j++) - if (strcmp(provided_name, node_data->Params[j]->Name) == 0) - goto next_provided_param; - - /** This param doesn't exist, warn the user and attempt to give them a hint. **/ - fprintf(stderr, "Warning: Unknown provided parameter '%s' for cluster file: %s.\n", provided_name, ci_file_name(parent)); - char** param_names = check_ptr(nmSysMalloc(node_data->nParams * sizeof(char*))); - for (unsigned int j = 0u; j < node_data->nParams; j++) - param_names[j] = node_data->Params[j]->Name; - ci_TryHint(provided_name, param_names, node_data->nParams); - nmSysFree(param_names); - - next_provided_param:; - } - - /** Parse source data. **/ - node_data->SourceData = ci_ParseSourceData(inf, node_data->ParamList, path); - if (node_data->SourceData == NULL) goto err_free_arrs; - - /** Parse each cluster. **/ - node_data->nClusterDatas = cluster_infs.nItems; - if (node_data->nClusterDatas > 0) - { - const size_t clusters_size = node_data->nClusterDatas * sizeof(pClusterData); - node_data->ClusterDatas = check_ptr(nmSysMalloc(clusters_size)); - if (node_data->ClusterDatas == NULL) goto err_free_arrs; - memset(node_data->ClusterDatas, 0, clusters_size); - for (unsigned int i = 0u; i < node_data->nClusterDatas; i++) + /** Parse source data. **/ + node_data->SourceData = ci_ParseSourceData(inf, node_data->ParamList, path); + if (node_data->SourceData == NULL) goto err_free; + + /** Parse each cluster. **/ + node_data->nClusterDatas = cluster_infs.nItems; + if (node_data->nClusterDatas > 0) { - node_data->ClusterDatas[i] = ci_ParseClusterData(cluster_infs.Items[i], node_data); - if (node_data->ClusterDatas[i] == NULL) goto err_free_arrs; + const size_t clusters_size = node_data->nClusterDatas * sizeof(pClusterData); + node_data->ClusterDatas = check_ptr(nmSysMalloc(clusters_size)); + if (node_data->ClusterDatas == NULL) goto err_free; + memset(node_data->ClusterDatas, 0, clusters_size); + for (unsigned int i = 0u; i < node_data->nClusterDatas; i++) + { + node_data->ClusterDatas[i] = ci_ParseClusterData(cluster_infs.Items[i], node_data); + if (node_data->ClusterDatas[i] == NULL) goto err_free; + } } - } - else node_data->ClusterDatas = NULL; - check(xaDeInit(&cluster_infs)); /* Failure ignored. */ - cluster_infs.nAlloc = 0; - - /** Parse each search. **/ - node_data->nSearchDatas = search_infs.nItems; - if (node_data->nSearchDatas > 0) - { - const size_t searches_size = node_data->nSearchDatas * sizeof(pSearchData); - node_data->SearchDatas = check_ptr(nmSysMalloc(searches_size)); - if (node_data->SearchDatas == NULL) goto err_free_arrs; - memset(node_data->SearchDatas, 0, searches_size); - for (unsigned int i = 0u; i < node_data->nSearchDatas; i++) + else node_data->ClusterDatas = NULL; + check(xaDeInit(&cluster_infs)); /* Failure ignored. */ + cluster_infs.nAlloc = 0; + + /** Parse each search. **/ + node_data->nSearchDatas = search_infs.nItems; + if (node_data->nSearchDatas > 0) { - node_data->SearchDatas[i] = ci_ParseSearchData(search_infs.Items[i], node_data); - if (node_data->SearchDatas[i] == NULL) goto err_free_arrs; + const size_t searches_size = node_data->nSearchDatas * sizeof(pSearchData); + node_data->SearchDatas = check_ptr(nmSysMalloc(searches_size)); + if (node_data->SearchDatas == NULL) goto err_free; + memset(node_data->SearchDatas, 0, searches_size); + for (unsigned int i = 0u; i < node_data->nSearchDatas; i++) + { + node_data->SearchDatas[i] = ci_ParseSearchData(search_infs.Items[i], node_data); + if (node_data->SearchDatas[i] == NULL) goto err_free; + } } - } - else node_data->SearchDatas = NULL; - check(xaDeInit(&search_infs)); /* Failure ignored. */ - search_infs.nAlloc = 0; - - /** Success. **/ - return node_data; - - err_free_arrs: - if (param_infs.nAlloc != 0) check(xaDeInit(¶m_infs)); /* Failure ignored. */ - if (cluster_infs.nAlloc != 0) check(xaDeInit(&cluster_infs)); /* Failure ignored. */ - if (search_infs.nAlloc != 0) check(xaDeInit(&search_infs)); /* Failure ignored. */ - - err_free_node: - ci_FreeNodeData(node_data); + else node_data->SearchDatas = NULL; + check(xaDeInit(&search_infs)); /* Failure ignored. */ + search_infs.nAlloc = 0; + + /** Success. **/ + return node_data; + + err_free: + if (param_infs.nAlloc != 0) check(xaDeInit(¶m_infs)); /* Failure ignored. */ + if (cluster_infs.nAlloc != 0) check(xaDeInit(&cluster_infs)); /* Failure ignored. */ + if (search_infs.nAlloc != 0) check(xaDeInit(&search_infs)); /* Failure ignored. */ + if (node_data != NULL) ci_FreeNodeData(node_data); + mssErrorf(0, "Cluster", "Failed to parse node from group \"%s\" in file: %s", inf->Name, path); - err: - mssErrorf(0, "Cluster", "Failed to parse node from group \"%s\" in file: %s", inf->Name, path); - return NULL; + return NULL; } @@ -1829,62 +1760,66 @@ static pNodeData ci_ParseNodeData(pStructInf inf, pObject parent) /** @param source_data A pSourceData struct, freed by this function. **/ static void ci_FreeSourceData(pSourceData source_data) { - /** Guard segfault. **/ - if (source_data == NULL) - { - fprintf(stderr, "Warning: Call to ci_FreeSourceData(NULL);\n"); - return; - } - - /** Free top level attributes, if they exist. **/ - if (source_data->Name != NULL) - { - nmSysFree(source_data->Name); - source_data->Name = NULL; - } - if (source_data->SourcePath != NULL) - { - nmSysFree(source_data->SourcePath); - source_data->SourcePath = NULL; - } - if (source_data->KeyAttr != NULL) - { - nmSysFree(source_data->KeyAttr); - source_data->KeyAttr = NULL; - } - if (source_data->NameAttr != NULL) - { - nmSysFree(source_data->NameAttr); - source_data->NameAttr = NULL; - } - - /** Free fetched data, if it exists. **/ - if (source_data->Strings != NULL) - { - for (unsigned int i = 0u; i < source_data->nVectors; i++) + /** Guard segfault. **/ + if (source_data == NULL) { - nmSysFree(source_data->Strings[i]); - source_data->Strings[i] = NULL; + fprintf(stderr, "Warning: Call to ci_FreeSourceData(NULL);\n"); + return; } - nmSysFree(source_data->Strings); - source_data->Strings = NULL; - } - - /** Free computed vectors, if they exist. **/ - if (source_data->Vectors != NULL) - { - for (unsigned int i = 0u; i < source_data->nVectors; i++) + + /** Free top level attributes, if they exist. **/ + if (source_data->Name != NULL) { - ca_free_vector(source_data->Vectors[i]); - source_data->Vectors[i] = NULL; + nmSysFree(source_data->Name); + source_data->Name = NULL; } - nmSysFree(source_data->Vectors); - source_data->Vectors = NULL; - } - - /** Free the source data struct. **/ - nmFree(source_data, sizeof(SourceData)); - source_data = NULL; + if (source_data->SourcePath != NULL) + { + nmSysFree(source_data->SourcePath); + source_data->SourcePath = NULL; + } + if (source_data->KeyAttr != NULL) + { + nmSysFree(source_data->KeyAttr); + source_data->KeyAttr = NULL; + } + if (source_data->NameAttr != NULL) + { + nmSysFree(source_data->NameAttr); + source_data->NameAttr = NULL; + } + + /** Free fetched data, if it exists. **/ + if (source_data->Strings != NULL) + { + for (unsigned int i = 0u; i < source_data->nVectors; i++) + { + if (source_data->Strings[i] != NULL) + nmSysFree(source_data->Strings[i]); + else continue; + source_data->Strings[i] = NULL; + } + nmSysFree(source_data->Strings); + source_data->Strings = NULL; + } + + /** Free computed vectors, if they exist. **/ + if (source_data->Vectors != NULL) + { + for (unsigned int i = 0u; i < source_data->nVectors; i++) + { + if (source_data->Vectors[i] != NULL) + ca_free_vector(source_data->Vectors[i]); + else continue; + source_data->Vectors[i] = NULL; + } + nmSysFree(source_data->Vectors); + source_data->Vectors = NULL; + } + + /** Free the source data struct. **/ + nmFree(source_data, sizeof(SourceData)); + source_data = NULL; } @@ -1896,55 +1831,58 @@ static void ci_FreeSourceData(pSourceData source_data) ***/ static void ci_FreeClusterData(pClusterData cluster_data, bool recursive) { - /** Guard segfault. **/ - if (cluster_data == NULL) - { - fprintf(stderr, "Warning: Call to ci_FreeClusterData(NULL, %s);\n", (recursive) ? "true" : "false"); - return; - } - - /** Free attribute data. **/ - if (cluster_data->Name != NULL) - { - nmSysFree(cluster_data->Name); - cluster_data->Name = NULL; - } - - /** Free computed data, if it exists. **/ - if (cluster_data->Clusters != NULL) - { - for (unsigned int i = 0u; i < cluster_data->nClusters; i++) + /** Guard segfault. **/ + if (cluster_data == NULL) { - pCluster cluster = &cluster_data->Clusters[i]; - nmSysFree(cluster->Strings); - nmSysFree(cluster->Vectors); - cluster->Strings = NULL; - cluster->Vectors = NULL; + fprintf(stderr, "Warning: Call to ci_FreeClusterData(NULL, %s);\n", (recursive) ? "true" : "false"); + return; } - nmSysFree(cluster_data->Clusters); - nmSysFree(cluster_data->Sims); - cluster_data->Clusters = NULL; - cluster_data->Sims = NULL; - } - - /** Free subclusters recursively. **/ - if (cluster_data->SubClusters != NULL) - { - if (recursive) + + /** Free attribute data. **/ + if (cluster_data->Name != NULL) + { + nmSysFree(cluster_data->Name); + cluster_data->Name = NULL; + } + + /** Free computed data, if it exists. **/ + if (cluster_data->Clusters != NULL) { - for (unsigned int i = 0u; i < cluster_data->nSubClusters; i++) + for (unsigned int i = 0u; i < cluster_data->nClusters; i++) { - ci_FreeClusterData(cluster_data->SubClusters[i], recursive); - cluster_data->SubClusters[i] = NULL; + pCluster cluster = &cluster_data->Clusters[i]; + if (cluster == NULL) continue; + if (cluster->Strings != NULL) nmSysFree(cluster->Strings); + if (cluster->Vectors != NULL) nmSysFree(cluster->Vectors); + cluster->Strings = NULL; + cluster->Vectors = NULL; } + nmSysFree(cluster_data->Clusters); + nmSysFree(cluster_data->Sims); + cluster_data->Clusters = NULL; + cluster_data->Sims = NULL; } - nmSysFree(cluster_data->SubClusters); - cluster_data->SubClusters = NULL; - } - - /** Free the cluster data struct. **/ - nmFree(cluster_data, sizeof(ClusterData)); - cluster_data = NULL; + + /** Free subclusters recursively. **/ + if (cluster_data->SubClusters != NULL) + { + if (recursive) + { + for (unsigned int i = 0u; i < cluster_data->nSubClusters; i++) + { + if (cluster_data->SubClusters[i] != NULL) + ci_FreeClusterData(cluster_data->SubClusters[i], recursive); + else continue; + cluster_data->SubClusters[i] = NULL; + } + } + nmSysFree(cluster_data->SubClusters); + cluster_data->SubClusters = NULL; + } + + /** Free the cluster data struct. **/ + nmFree(cluster_data, sizeof(ClusterData)); + cluster_data = NULL; } @@ -1952,35 +1890,35 @@ static void ci_FreeClusterData(pClusterData cluster_data, bool recursive) /** @param search_data A pSearchData struct, freed by this function. **/ static void ci_FreeSearchData(pSearchData search_data) { - /** Guard segfault. **/ - if (search_data == NULL) - { - fprintf(stderr, "Warning: Call to ci_FreeSearchData(NULL);\n"); - return; - } - - /** Free attribute data. **/ - if (search_data->Name != NULL) - { - nmSysFree(search_data->Name); - search_data->Name = NULL; - } - - /** Free computed data. **/ - if (search_data->Dups != NULL) - { - for (unsigned int i = 0; i < search_data->nDups; i++) + /** Guard segfault. **/ + if (search_data == NULL) { - nmFree(search_data->Dups[i], sizeof(Dup)); - search_data->Dups[i] = NULL; + fprintf(stderr, "Warning: Call to ci_FreeSearchData(NULL);\n"); + return; } - nmSysFree(search_data->Dups); - search_data->Dups = NULL; - } - - /** Free the search data struct. **/ - nmFree(search_data, sizeof(SearchData)); - search_data = NULL; + + /** Free attribute data. **/ + if (search_data->Name != NULL) + { + nmSysFree(search_data->Name); + search_data->Name = NULL; + } + + /** Free computed data. **/ + if (search_data->Dups != NULL) + { + for (unsigned int i = 0; i < search_data->nDups; i++) + { + nmFree(search_data->Dups[i], sizeof(Dup)); + search_data->Dups[i] = NULL; + } + nmSysFree(search_data->Dups); + search_data->Dups = NULL; + } + + /** Free the search data struct. **/ + nmFree(search_data, sizeof(SearchData)); + search_data = NULL; } @@ -1988,82 +1926,82 @@ static void ci_FreeSearchData(pSearchData search_data) /** @param node_data A pNodeData struct, freed by this function. **/ static void ci_FreeNodeData(pNodeData node_data) { - /** Guard segfault. **/ - if (node_data == NULL) - { - fprintf(stderr, "Warning: Call to ci_FreeNodeData(NULL);\n"); - return; - } - - /** Free parsed params, if they exist. **/ - if (node_data->Params != NULL) - { - for (unsigned int i = 0u; i < node_data->nParams; i++) + /** Guard segfault. **/ + if (node_data == NULL) { - if (node_data->Params[i] == NULL) break; - paramFree(node_data->Params[i]); - node_data->Params[i] = NULL; + fprintf(stderr, "Warning: Call to ci_FreeNodeData(NULL);\n"); + return; } - nmSysFree(node_data->Params); - node_data->Params = NULL; - } - if (node_data->ParamList != NULL) - { - expFreeParamList(node_data->ParamList); - node_data->ParamList = NULL; - } - - /** Free parsed clusters, if they exist. **/ - if (node_data->ClusterDatas != NULL) - { - /*** This data is cached, so we should NOT free it! The caching system - *** is responsible for the memory. We only need to free the array - *** holding our pointers to said cached memory. - ***/ - nmSysFree(node_data->ClusterDatas); - node_data->ClusterDatas = NULL; - } - - /** Free parsed searches, if they exist. **/ - if (node_data->SearchDatas != NULL) - { - /*** This data is cached, so we should NOT free it! The caching system - *** is responsible for the memory. We only need to free the array - *** holding our pointers to said cached memory. - ***/ - nmSysFree(node_data->SearchDatas); - node_data->SearchDatas = NULL; - } - - /** Free data source, if one exists. **/ - /*** Note: SourceData is freed last since other free functions may need to - *** access information from this structure when freeing data. - *** (For example, nVector which is used to determine the size of the - *** label struct in each cluster.) - ***/ - if (node_data->SourceData != NULL) - { - /*** This data is cached, so we should NOT free it! The caching system - *** is responsible for the memory. We only need to free the array - *** holding our pointers to said cached memory. - ***/ - node_data->SourceData = NULL; - } - - /** Free the node data. **/ - nmFree(node_data, sizeof(NodeData)); - node_data = NULL; + + /** Free parsed params, if they exist. **/ + if (node_data->Params != NULL) + { + for (unsigned int i = 0u; i < node_data->nParams; i++) + { + if (node_data->Params[i] == NULL) break; + paramFree(node_data->Params[i]); + node_data->Params[i] = NULL; + } + nmSysFree(node_data->Params); + node_data->Params = NULL; + } + if (node_data->ParamList != NULL) + { + expFreeParamList(node_data->ParamList); + node_data->ParamList = NULL; + } + + /** Free parsed clusters, if they exist. **/ + if (node_data->ClusterDatas != NULL) + { + /*** This data is cached, so we should NOT free it! The caching system + *** is responsible for the memory. We only need to free the array + *** holding our pointers to said cached memory. + ***/ + nmSysFree(node_data->ClusterDatas); + node_data->ClusterDatas = NULL; + } + + /** Free parsed searches, if they exist. **/ + if (node_data->SearchDatas != NULL) + { + /*** This data is cached, so we should NOT free it! The caching system + *** is responsible for the memory. We only need to free the array + *** holding our pointers to said cached memory. + ***/ + nmSysFree(node_data->SearchDatas); + node_data->SearchDatas = NULL; + } + + /** Free data source, if one exists. **/ + /*** Note: SourceData is freed last since other free functions may need to + *** access information from this structure when freeing data. + *** (For example, nVector which is used to determine the size of the + *** label struct in each cluster.) + ***/ + if (node_data->SourceData != NULL) + { + /*** This data is cached, so we should NOT free it! The caching system + *** is responsible for the memory. We only need to free the array + *** holding our pointers to said cached memory. + ***/ + node_data->SourceData = NULL; + } + + /** Free the node data. **/ + nmFree(node_data, sizeof(NodeData)); + node_data = NULL; } /** Frees all data in caches for all cluster driver instances. **/ static void ci_ClearCaches(void) { - /*** Free caches in reverse of the order they are created in case - *** cached data relies on its source during the freeing process. - ***/ - check(xhClearKeySafe(&ClusterDriverCaches.SearchDataCache, ci_CacheFreeSearch, NULL)); /* Failure ignored. */ - check(xhClearKeySafe(&ClusterDriverCaches.ClusterDataCache, ci_CacheFreeCluster, NULL)); /* Failure ignored. */ - check(xhClearKeySafe(&ClusterDriverCaches.SourceDataCache, ci_CacheFreeSourceData, NULL)); /* Failure ignored. */ + /*** Free caches in reverse of the order they are created in case + *** cached data relies on its source during the freeing process. + ***/ + check(xhClearKeySafe(&ClusterDriverCaches.SearchDataCache, ci_CacheFreeSearch, NULL)); /* Failure ignored. */ + check(xhClearKeySafe(&ClusterDriverCaches.ClusterDataCache, ci_CacheFreeCluster, NULL)); /* Failure ignored. */ + check(xhClearKeySafe(&ClusterDriverCaches.SourceDataCache, ci_CacheFreeSourceData, NULL)); /* Failure ignored. */ } @@ -2083,31 +2021,32 @@ static void ci_ClearCaches(void) ***/ static unsigned int ci_SizeOfSourceData(pSourceData source_data) { - /** Guard segfault. **/ - if (source_data == NULL) - { - fprintf(stderr, "Warning: Call to ci_SizeOfSourceData(NULL);\n"); - return 0u; - } + /** Guard segfault. **/ + if (source_data == NULL) + { + fprintf(stderr, "Warning: Call to ci_SizeOfSourceData(NULL);\n"); + return 0u; + } + + unsigned int size = 0u; + if (source_data->Name != NULL) size += strlen(source_data->Name) * sizeof(char); + if (source_data->SourcePath != NULL) size += strlen(source_data->SourcePath) * sizeof(char); + if (source_data->KeyAttr != NULL) size += strlen(source_data->KeyAttr) * sizeof(char); + if (source_data->NameAttr != NULL) size += strlen(source_data->NameAttr) * sizeof(char); + if (source_data->Strings != NULL) + { + for (unsigned int i = 0u; i < source_data->nVectors; i++) + size += strlen(source_data->Strings[i]) * sizeof(char); + size += source_data->nVectors * sizeof(char*); + } + if (source_data->Vectors != NULL) + { + for (unsigned int i = 0u; i < source_data->nVectors; i++) + size += ca_sparse_len(source_data->Vectors[i]) * sizeof(int); + size += source_data->nVectors * sizeof(pVector); + } + size += sizeof(SourceData); - unsigned int size = 0u; - if (source_data->Name != NULL) size += strlen(source_data->Name) * sizeof(char); - if (source_data->SourcePath != NULL) size += strlen(source_data->SourcePath) * sizeof(char); - if (source_data->KeyAttr != NULL) size += strlen(source_data->KeyAttr) * sizeof(char); - if (source_data->NameAttr != NULL) size += strlen(source_data->NameAttr) * sizeof(char); - if (source_data->Strings != NULL) - { - for (unsigned int i = 0u; i < source_data->nVectors; i++) - size += strlen(source_data->Strings[i]) * sizeof(char); - size += source_data->nVectors * sizeof(char*); - } - if (source_data->Vectors != NULL) - { - for (unsigned int i = 0u; i < source_data->nVectors; i++) - size += ca_sparse_len(source_data->Vectors[i]) * sizeof(int); - size += source_data->nVectors * sizeof(pVector); - } - size += sizeof(SourceData); return size; } @@ -2125,33 +2064,34 @@ static unsigned int ci_SizeOfSourceData(pSourceData source_data) *** @returns The size in bytes of the struct and all internal allocated data. ***/ static unsigned int ci_SizeOfClusterData(pClusterData cluster_data, bool recursive) - { - /** Guard segfault. **/ - if (cluster_data == NULL) - { - fprintf(stderr, "Warning: Call to ci_SizeOfClusterData(NULL, %s);\n", (recursive) ? "true" : "false"); - return 0u; - } - - unsigned int size = 0u; - if (cluster_data->Name != NULL) size += strlen(cluster_data->Name) * sizeof(char); - if (cluster_data->Clusters != NULL) - { - const unsigned int nVectors = cluster_data->SourceData->nVectors; - for (unsigned int i = 0u; i < cluster_data->nClusters; i++) - size += cluster_data->Clusters[i].Size * (sizeof(char*) + sizeof(pVector)); - size += nVectors * (sizeof(Cluster) + sizeof(double)); - } - if (cluster_data->SubClusters != NULL) - { - if (recursive) + { + /** Guard segfault. **/ + if (cluster_data == NULL) + { + fprintf(stderr, "Warning: Call to ci_SizeOfClusterData(NULL, %s);\n", (recursive) ? "true" : "false"); + return 0u; + } + + unsigned int size = 0u; + if (cluster_data->Name != NULL) size += strlen(cluster_data->Name) * sizeof(char); + if (cluster_data->Clusters != NULL) { - for (unsigned int i = 0u; i < cluster_data->nSubClusters; i++) - size += ci_SizeOfClusterData(cluster_data->SubClusters[i], recursive); + const unsigned int nVectors = cluster_data->SourceData->nVectors; + for (unsigned int i = 0u; i < cluster_data->nClusters; i++) + size += cluster_data->Clusters[i].Size * (sizeof(char*) + sizeof(pVector)); + size += nVectors * (sizeof(Cluster) + sizeof(double)); + } + if (cluster_data->SubClusters != NULL) + { + if (recursive) + { + for (unsigned int i = 0u; i < cluster_data->nSubClusters; i++) + size += ci_SizeOfClusterData(cluster_data->SubClusters[i], recursive); + } + size += cluster_data->nSubClusters * sizeof(void*); } - size += cluster_data->nSubClusters * sizeof(void*); - } - size += sizeof(ClusterData); + size += sizeof(ClusterData); + return size; } @@ -2169,18 +2109,19 @@ static unsigned int ci_SizeOfClusterData(pClusterData cluster_data, bool recursi ***/ static unsigned int ci_SizeOfSearchData(pSearchData search_data) { - /** Guard segfault. **/ - if (search_data == NULL) - { - fprintf(stderr, "Warning: Call to ci_SizeOfSearchData(NULL);\n"); - return 0u; - } - - unsigned int size = 0u; - if (search_data->Name != NULL) size += strlen(search_data->Name) * sizeof(char); - if (search_data->Dups != NULL) size += search_data->nDups * (sizeof(void*) + sizeof(Dup)); - size += sizeof(SearchData); - return size; + /** Guard segfault. **/ + if (search_data == NULL) + { + fprintf(stderr, "Warning: Call to ci_SizeOfSearchData(NULL);\n"); + return 0u; + } + + unsigned int size = 0u; + if (search_data->Name != NULL) size += strlen(search_data->Name) * sizeof(char); + if (search_data->Dups != NULL) size += search_data->nDups * (sizeof(void*) + sizeof(Dup)); + size += sizeof(SearchData); + + return size; } @@ -2201,148 +2142,222 @@ static unsigned int ci_SizeOfSearchData(pSearchData search_data) ***/ static int ci_ComputeSourceData(pSourceData source_data, pObjSession session) { - /** If the vectors are already computed, we're done. **/ - if (source_data->Vectors != NULL) return 0; - - /** Time to play shoots-and-ladders in an error-handling jungle of gotos. **/ bool successful = false; int ret; - - /** Record the date and time. **/ - if (!check(objCurrentDate(&source_data->DateComputed))) goto end; - - /** Open the source path specified by the .cluster file. **/ - pObject obj = objOpen(session, source_data->SourcePath, OBJ_O_RDONLY, 0600, "system/directory"); - if (obj == NULL) - { - mssErrorf(0, "Cluster", - "Failed to open object driver:\n" - " > Attribute: ['%s':'%s' : String]\n" - " > Source Path: %s\n", - source_data->KeyAttr, source_data->NameAttr, - source_data->SourcePath - ); - goto end; - } - - /** Generate a "query" for retrieving data. **/ - pObjQuery query = objOpenQuery(obj, NULL, NULL, NULL, NULL, 0); - if (query == NULL) - { - mssErrorf(0, "Cluster", - "Failed to open query:\n" - " > Attribute: ['%s':'%s' : String]\n" - " > Source Path: %s\n" - " > Driver Used: %s\n", - source_data->KeyAttr, source_data->NameAttr, - source_data->SourcePath, - obj->Driver->Name - ); - goto end_close; - } - - /** Initialize an xarray to store the retrieved data. **/ - XArray key_xarray, data_xarray, vector_xarray; - memset(&key_xarray, 0, sizeof(XArray)); - memset(&data_xarray, 0, sizeof(XArray)); - memset(&vector_xarray, 0, sizeof(XArray)); - if (!check(xaInit(&key_xarray, 64))) goto end_close_query; - if (!check(xaInit(&data_xarray, 64))) goto end_free_data; - if (!check(xaInit(&vector_xarray, 64))) goto end_free_data; - - /** Fetch data and build vectors. **/ - while (true) - { - pObject entry = objQueryFetch(query, O_RDONLY); - if (entry == NULL) break; /* Done. */ - - /** Data value: Type checking. **/ - const int data_datatype = objGetAttrType(entry, source_data->NameAttr); - if (data_datatype == -1) + pObject obj = NULL; + pObjQuery query = NULL; + XArray key_xarray = {0}; + XArray data_xarray = {0}; + XArray vector_xarray = {0}; + + /** Guard segfault. **/ + if (source_data == NULL) return -1; + + /** If the vectors are already computed, we're done. **/ + if (source_data->Vectors != NULL) return 0; + + /** Record the date and time. **/ + if (!check(objCurrentDate(&source_data->DateComputed))) goto end_free; + + /** Open the source path specified by the .cluster file. **/ + obj = objOpen(session, source_data->SourcePath, OBJ_O_RDONLY, 0600, "system/directory"); + if (obj == NULL) { mssErrorf(0, "Cluster", - "Failed to get type for %uth entry:\n" + "Failed to open object driver:\n" " > Attribute: ['%s':'%s' : String]\n" - " > Source Path: %s\n" - " > Driver Used: %s\n", - vector_xarray.nItems, + " > Source Path: %s\n", source_data->KeyAttr, source_data->NameAttr, - source_data->SourcePath, - obj->Driver->Name - ); - goto end_free_data; - } - if (data_datatype != DATA_T_STRING) - { - mssErrorf(1, "Cluster", - "Type for %uth entry was not a string:\n" - " > Attribute: ['%s':'%s' : %s]\n" - " > Source Path: %s\n" - " > Driver Used: %s\n", - vector_xarray.nItems, - source_data->KeyAttr, source_data->NameAttr, ci_TypeToStr(data_datatype), - source_data->SourcePath, - obj->Driver->Name + source_data->SourcePath ); - goto end_free_data; + goto end_free; } - /** Data value: Get value from database. **/ - char* data; - ret = objGetAttrValue(entry, source_data->NameAttr, DATA_T_STRING, POD(&data)); - if (ret != 0) + /** Generate a "query" for retrieving data. **/ + query = objOpenQuery(obj, NULL, NULL, NULL, NULL, 0); + if (query == NULL) { mssErrorf(0, "Cluster", - "Failed to value for %uth entry:\n" + "Failed to open query:\n" " > Attribute: ['%s':'%s' : String]\n" " > Source Path: %s\n" - " > Driver Used: %s\n" - " > Error code: %d\n", - vector_xarray.nItems, + " > Driver Used: %s\n", source_data->KeyAttr, source_data->NameAttr, source_data->SourcePath, - obj->Driver->Name, - ret + obj->Driver->Name ); - goto end_free_data; + goto end_free; } - /** Skip empty strings. **/ - if (strlen(data) == 0) - { - check(fflush(stdout)); /* Failure ignored. */ - continue; - } + /** Initialize an xarray to store the retrieved data. **/ + // memset(&key_xarray, 0, sizeof(XArray)); + // memset(&data_xarray, 0, sizeof(XArray)); + // memset(&vector_xarray, 0, sizeof(XArray)); + if (!check(xaInit(&key_xarray, 64))) goto end_free; + if (!check(xaInit(&data_xarray, 64))) goto end_free; + if (!check(xaInit(&vector_xarray, 64))) goto end_free; - /** Convert the string to a vector. **/ - pVector vector = ca_build_vector(data); - if (vector == NULL) - { - mssErrorf(1, "Cluster", "Failed to build vectors for string \"%s\".", data); - successful = false; - goto end_free_data; - } - if (ca_is_empty(vector)) - { - mssErrorf(1, "Cluster", "Vector building for string \"%s\" produced no character pairs.", data); - successful = false; - goto end_free_data; - } - if (ca_has_no_pairs(vector)) + /** Fetch data and build vectors. **/ + while (true) { - /** Skip pVector with no pairs. **/ - check(fflush(stdout)); /* Failure ignored. */ - ca_free_vector(vector); - continue; + pObject entry = objQueryFetch(query, O_RDONLY); + if (entry == NULL) break; /* Done. */ + + /** Data value: Type checking. **/ + const int data_datatype = objGetAttrType(entry, source_data->NameAttr); + if (data_datatype == -1) + { + mssErrorf(0, "Cluster", + "Failed to get type for %uth entry:\n" + " > Attribute: ['%s':'%s' : String]\n" + " > Source Path: %s\n" + " > Driver Used: %s\n", + vector_xarray.nItems, + source_data->KeyAttr, source_data->NameAttr, + source_data->SourcePath, + obj->Driver->Name + ); + goto end_free; + } + if (data_datatype != DATA_T_STRING) + { + mssErrorf(1, "Cluster", + "Type for %uth entry was not a string:\n" + " > Attribute: ['%s':'%s' : %s]\n" + " > Source Path: %s\n" + " > Driver Used: %s\n", + vector_xarray.nItems, + source_data->KeyAttr, source_data->NameAttr, objTypeToStr(data_datatype), + source_data->SourcePath, + obj->Driver->Name + ); + goto end_free; + } + + /** Data value: Get value from database. **/ + char* data; + ret = objGetAttrValue(entry, source_data->NameAttr, DATA_T_STRING, POD(&data)); + if (ret != 0) + { + mssErrorf(0, "Cluster", + "Failed to value for %uth entry:\n" + " > Attribute: ['%s':'%s' : String]\n" + " > Source Path: %s\n" + " > Driver Used: %s\n" + " > Error code: %d\n", + vector_xarray.nItems, + source_data->KeyAttr, source_data->NameAttr, + source_data->SourcePath, + obj->Driver->Name, + ret + ); + goto end_free; + } + + /** Skip empty strings. **/ + if (strlen(data) == 0) + { + check(fflush(stdout)); /* Failure ignored. */ + continue; + } + + /** Convert the string to a vector. **/ + pVector vector = ca_build_vector(data); + if (vector == NULL) + { + mssErrorf(1, "Cluster", "Failed to build vectors for string \"%s\".", data); + successful = false; + goto end_free; + } + if (ca_is_empty(vector)) + { + mssErrorf(1, "Cluster", "Vector building for string \"%s\" produced no character pairs.", data); + successful = false; + goto end_free; + } + if (ca_has_no_pairs(vector)) + { + /** Skip pVector with no pairs. **/ + check(fflush(stdout)); /* Failure ignored. */ + ca_free_vector(vector); + continue; + } + + + /** Key value: Type checking. **/ + const int key_datatype = objGetAttrType(entry, source_data->KeyAttr); + if (key_datatype == -1) + { + mssErrorf(0, "Cluster", + "Failed to get type for key on %uth entry:\n" + " > Attribute: ['%s':'%s' : String]\n" + " > Source Path: %s\n" + " > Driver Used: %s\n", + vector_xarray.nItems, + source_data->KeyAttr, source_data->NameAttr, + source_data->SourcePath, + obj->Driver->Name + ); + goto end_free; + } + if (key_datatype != DATA_T_STRING) + { + mssErrorf(1, "Cluster", + "Type for key on %uth entry was not a string:\n" + " > Attribute: ['%s':'%s' : %s]\n" + " > Source Path: %s\n" + " > Driver Used: %s\n", + vector_xarray.nItems, + source_data->KeyAttr, source_data->NameAttr, objTypeToStr(key_datatype), + source_data->SourcePath, + obj->Driver->Name + ); + goto end_free; + } + + /** key value: Get value from database. **/ + char* key; + ret = objGetAttrValue(entry, source_data->KeyAttr, DATA_T_STRING, POD(&key)); + if (ret != 0) + { + mssErrorf(0, "Cluster", + "Failed to value for key on %uth entry:\n" + " > Attribute: ['%s':'%s' : String]\n" + " > Source Path: %s\n" + " > Driver Used: %s\n" + " > Error code: %d\n", + vector_xarray.nItems, + source_data->KeyAttr, source_data->NameAttr, + source_data->SourcePath, + obj->Driver->Name, + ret + ); + goto end_free; + } + + /** Store values. **/ + char* key_dup = check_ptr(nmSysStrdup(key)); + if (key_dup == NULL) goto end_free; + char* data_dup = check_ptr(nmSysStrdup(data)); + if (data_dup == NULL) goto end_free; + if (!check_neg(xaAddItem(&key_xarray, (void*)key_dup))) goto end_free; + if (!check_neg(xaAddItem(&data_xarray, (void*)data_dup))) goto end_free; + if (!check_neg(xaAddItem(&vector_xarray, (void*)vector))) goto end_free; + + /** Clean up. **/ + ret = objClose(entry); + if (ret != 0) + { + mssErrorf(0, "Cluster", "Failed to close object entry (error code %d).", ret); + // success = false; // Fall-through: Failure ignored. + } } - - /** Key value: Type checking. **/ - const int key_datatype = objGetAttrType(entry, source_data->KeyAttr); - if (key_datatype == -1) + source_data->nVectors = vector_xarray.nItems; + if (source_data->nVectors == 0) { mssErrorf(0, "Cluster", - "Failed to get type for key on %uth entry:\n" + "Data source path did not contain any valid data:\n" " > Attribute: ['%s':'%s' : String]\n" " > Source Path: %s\n" " > Driver Used: %s\n", @@ -2351,126 +2366,92 @@ static int ci_ComputeSourceData(pSourceData source_data, pObjSession session) source_data->SourcePath, obj->Driver->Name ); - goto end_free_data; } - if (key_datatype != DATA_T_STRING) + + /** Trim and store keys. **/ + source_data->Keys = (char**)check_ptr(ci_xaToTrimmedArray(&key_xarray, 1)); + if (source_data->Keys == NULL) goto err_free; + key_xarray.nAlloc = 0; + + /** Trim and store data strings. **/ + source_data->Strings = (char**)check_ptr(ci_xaToTrimmedArray(&data_xarray, 1)); + if (source_data->Strings == NULL) goto err_free; + data_xarray.nAlloc = 0; + + /** Trim and store vectors. **/ + source_data->Vectors = (int**)check_ptr(ci_xaToTrimmedArray(&vector_xarray, 1)); + if (source_data->Vectors == NULL) goto err_free; + vector_xarray.nAlloc = 0; + + /** Success. **/ + successful = true; + goto end_free; + + err_free: + if (source_data->Keys != NULL) nmSysFree(source_data->Keys); + if (source_data->Strings != NULL) nmSysFree(source_data->Strings); + if (source_data->Vectors != NULL) nmSysFree(source_data->Vectors); + + end_free: + /** Clean up xarrays. **/ + if (key_xarray.nAlloc != 0) + { + for (unsigned int i = 0u; i < vector_xarray.nItems; i++) + { + char* key = key_xarray.Items[i]; + if (key != NULL) nmSysFree(key); + else break; + } + check(xaDeInit(&key_xarray)); /* Failure ignored. */ + } + if (data_xarray.nAlloc != 0) { - mssErrorf(1, "Cluster", - "Type for key on %uth entry was not a string:\n" - " > Attribute: ['%s':'%s' : %s]\n" - " > Source Path: %s\n" - " > Driver Used: %s\n", - vector_xarray.nItems, - source_data->KeyAttr, source_data->NameAttr, ci_TypeToStr(key_datatype), - source_data->SourcePath, - obj->Driver->Name - ); - goto end_free_data; + for (unsigned int i = 0u; i < data_xarray.nItems; i++) + { + char* str = data_xarray.Items[i]; + if (str != NULL) nmSysFree(str); + else break; + } + check(xaDeInit(&data_xarray)); /* Failure ignored. */ + } + if (vector_xarray.nAlloc != 0) + { + for (unsigned int i = 0u; i < vector_xarray.nItems; i++) + { + pVector vec = vector_xarray.Items[i]; + if (vec != NULL) ca_free_vector(vec); + else break; + } + check(xaDeInit(&vector_xarray)); /* Failure ignored. */ } - /** key value: Get value from database. **/ - char* key; - ret = objGetAttrValue(entry, source_data->KeyAttr, DATA_T_STRING, POD(&key)); - if (ret != 0) + /** Clean up query. **/ + if (query != NULL) { - mssErrorf(0, "Cluster", - "Failed to value for key on %uth entry:\n" - " > Attribute: ['%s':'%s' : String]\n" - " > Source Path: %s\n" - " > Driver Used: %s\n" - " > Error code: %d\n", - vector_xarray.nItems, - source_data->KeyAttr, source_data->NameAttr, - source_data->SourcePath, - obj->Driver->Name, - ret - ); - goto end_free_data; + ret = objQueryClose(query); + if (ret != 0) + { + mssErrorf(0, "Cluster", "Failed to close query (error code %d).", ret); + // success = false; // Fall-through: Failure ignored. + } } - /** Store values. **/ - char* key_dup = check_ptr(nmSysStrdup(key)); - if (key_dup == NULL) goto end_free_data; - char* data_dup = check_ptr(nmSysStrdup(data)); - if (data_dup == NULL) goto end_free_data; - if (!check_neg(xaAddItem(&key_xarray, (void*)key_dup))) goto end_free_data; - if (!check_neg(xaAddItem(&data_xarray, (void*)data_dup))) goto end_free_data; - if (!check_neg(xaAddItem(&vector_xarray, (void*)vector))) goto end_free_data; - - /** Clean up. **/ - ret = objClose(entry); - if (ret != 0) + /** Clean up object. **/ + if (obj != NULL) { - mssErrorf(0, "Cluster", "Failed to close object entry (error code %d).", ret); - // ret = ret; // Fall-through: Failure ignored. + ret = objClose(obj); + if (ret != 0) + { + mssErrorf(0, "Cluster", "Failed to close object driver (error code %d).", ret); + // success = false; // Fall-through: Failure ignored. + } } - } - - source_data->nVectors = vector_xarray.nItems; - if (source_data->nVectors == 0) - { - mssErrorf(0, "Cluster", - "Data source path did not contain any valid data:\n" - " > Attribute: ['%s':'%s' : String]\n" - " > Source Path: %s\n" - " > Driver Used: %s\n", - vector_xarray.nItems, - source_data->KeyAttr, source_data->NameAttr, - source_data->SourcePath, - obj->Driver->Name - ); - } - - /** Trim and store: keys, data, and vectors. **/ - source_data->Keys = (char**)check_ptr(ci_xaToTrimmedArray(&key_xarray, 1)); - source_data->Strings = (char**)check_ptr(ci_xaToTrimmedArray(&data_xarray, 1)); - source_data->Vectors = (int**)check_ptr(ci_xaToTrimmedArray(&vector_xarray, 1)); - if (source_data->Keys == NULL) goto end_free_data; - if (source_data->Strings == NULL) goto end_free_data; - if (source_data->Vectors == NULL) goto end_free_data; - - /** Success. **/ - successful = true; - - end_free_data: - if (key_xarray.nAlloc != 0) - { - for (unsigned int i = 0u; i < vector_xarray.nItems; i++) - nmSysFree(key_xarray.Items[i]); - check(xaDeInit(&key_xarray)); /* Failure ignored. */ - } - if (data_xarray.nAlloc != 0) - { - for (unsigned int i = 0u; i < data_xarray.nItems; i++) - nmSysFree(data_xarray.Items[i]); - check(xaDeInit(&data_xarray)); /* Failure ignored. */ - } - if (vector_xarray.nAlloc != 0) - { - for (unsigned int i = 0u; i < vector_xarray.nItems; i++) - ca_free_vector(vector_xarray.Items[i]); - check(xaDeInit(&vector_xarray)); /* Failure ignored. */ - } - - end_close_query: - ret = objQueryClose(query); - if (ret != 0) - { - mssErrorf(0, "Cluster", "Failed to close query (error code %d).", ret); - // ret = ret; // Fall-through: Failure ignored. - } - - end_close: - ret = objClose(obj); - if (ret != 0) - { - mssErrorf(0, "Cluster", "Failed to close object driver (error code %d).", ret); - // ret = ret; // Fall-through: Failure ignored. - } - - end: - if (!successful) mssErrorf(0, "Cluster", "SourceData computation failed."); - return (successful) ? 0 : -1; + + /** Print an error if the function failed. **/ + if (!successful) mssErrorf(0, "Cluster", "SourceData computation failed."); + + /** Return the function status code. **/ + return (successful) ? 0 : -1; } @@ -2488,148 +2469,159 @@ static int ci_ComputeSourceData(pSourceData source_data, pObjSession session) ***/ static int ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data) { - /** If the clusters are already computed, we're done. **/ - if (cluster_data->Clusters != NULL) return 0; - - /** Make source data available. **/ - pSourceData source_data = node_data->SourceData; - - /** We need the SourceData vectors to compute clusters. **/ - if (ci_ComputeSourceData(source_data, node_data->ParamList->Session) != 0) - { - mssErrorf(0, "Cluster", "ClusterData computation failed due to missing SourceData."); - goto err; - } - - /** Record the date and time. **/ - if (!check(objCurrentDate(&cluster_data->DateComputed))) goto err; - - /** Allocate static memory for finding clusters. **/ - const size_t clusters_size = cluster_data->nClusters * sizeof(Cluster); - cluster_data->Clusters = check_ptr(nmSysMalloc(clusters_size)); - if (cluster_data->Clusters == NULL) goto err; - memset(cluster_data->Clusters, 0, clusters_size); - const size_t sims_size = source_data->nVectors * sizeof(double); - cluster_data->Sims = check_ptr(nmSysMalloc(sims_size)); - if (cluster_data->Sims == NULL) goto err_free_clusters; - memset(cluster_data->Sims, 0, sims_size); + cluster_data->Sims = NULL; + cluster_data->Clusters = NULL; - /** Execute clustering. **/ - switch (cluster_data->ClusterAlgorithm) - { - case ALGORITHM_NONE: + /** Guard segfaults. **/ + if (cluster_data == NULL || node_data == NULL) return -1; + + /** If the clusters are already computed, we're done. **/ + if (cluster_data->Clusters != NULL) return 0; + + /** Make source data available. **/ + pSourceData source_data = check_ptr(node_data->SourceData); + if (source_data == NULL) + { + mssErrorf(1, "Cluster", "Failed to get source data for cluster computation."); + goto err_free; + } + + /** We need the SourceData vectors to compute clusters. **/ + if (ci_ComputeSourceData(source_data, node_data->ParamList->Session) != 0) { - /** Put all the data into one cluster. **/ - pCluster first_cluster = &cluster_data->Clusters[0]; - first_cluster->Size = source_data->nVectors; - first_cluster->Strings = check_ptr(nmSysMalloc(source_data->nVectors * sizeof(char*))); - if (first_cluster->Strings == NULL) goto err_free_sims; - first_cluster->Vectors = check_ptr(nmSysMalloc(source_data->nVectors * sizeof(pVector))); - if (first_cluster->Vectors == NULL) goto err_free_sims; - memcpy(first_cluster->Strings, source_data->Strings, source_data->nVectors * sizeof(char*)); - memcpy(first_cluster->Vectors, source_data->Vectors, source_data->nVectors * sizeof(pVector)); - break; + mssErrorf(0, "Cluster", "ClusterData computation failed due to missing SourceData."); + goto err_free; } - case ALGORITHM_SLIDING_WINDOW: - /** Computed in each search for efficiency. **/ - memset(cluster_data->Clusters, 0, clusters_size); - break; + /** Record the date and time. **/ + if (!check(objCurrentDate(&cluster_data->DateComputed))) goto err_free; + + /** Allocate static memory for finding clusters. **/ + const size_t clusters_size = cluster_data->nClusters * sizeof(Cluster); + cluster_data->Clusters = check_ptr(nmSysMalloc(clusters_size)); + if (cluster_data->Clusters == NULL) goto err_free; + memset(cluster_data->Clusters, 0, clusters_size); + const size_t sims_size = source_data->nVectors * sizeof(double); + cluster_data->Sims = check_ptr(nmSysMalloc(sims_size)); + if (cluster_data->Sims == NULL) goto err_free; + memset(cluster_data->Sims, 0, sims_size); - case ALGORITHM_KMEANS: + /** Execute clustering. **/ + switch (cluster_data->ClusterAlgorithm) { - /** Check for unimplemented similarity measures. **/ - if (cluster_data->SimilarityMeasure != SIMILARITY_COSINE) + case ALGORITHM_NONE: { - mssErrorf(1, "Cluster", - "The similarity measure \"%s\" is not implemented.", - ci_SimilarityMeasureToString(cluster_data->SimilarityMeasure) - ); - goto err_free_sims; + /** Put all the data into one cluster. **/ + pCluster first_cluster = &cluster_data->Clusters[0]; + first_cluster->Size = source_data->nVectors; + first_cluster->Strings = check_ptr(nmSysMalloc(source_data->nVectors * sizeof(char*))); + if (first_cluster->Strings == NULL) goto err_free; + first_cluster->Vectors = check_ptr(nmSysMalloc(source_data->nVectors * sizeof(pVector))); + if (first_cluster->Vectors == NULL) goto err_free; + memcpy(first_cluster->Strings, source_data->Strings, source_data->nVectors * sizeof(char*)); + memcpy(first_cluster->Vectors, source_data->Vectors, source_data->nVectors * sizeof(pVector)); + break; } - /** Allocate lables. Note: kmeans does not require us to initialize them. **/ - const size_t lables_size = source_data->nVectors * sizeof(unsigned int); - unsigned int* labels = check_ptr(nmSysMalloc(lables_size)); - if (labels == NULL) goto err_free_sims; - - /** Run kmeans. **/ - const bool successful = check(ca_kmeans( - source_data->Vectors, - source_data->nVectors, - cluster_data->nClusters, - cluster_data->MaxIterations, - cluster_data->MinImprovement, - labels, - cluster_data->Sims - )); - if (!successful) goto err_free_sims; - - /** Convert the labels into clusters. **/ - - /** Allocate space for clusters. **/ - XArray indexes_in_cluster[cluster_data->nClusters]; - for (unsigned int i = 0u; i < cluster_data->nClusters; i++) - if (!check(xaInit(&indexes_in_cluster[i], 8))) goto err_free_sims; - - /** Iterate through each label and add the index of the specified cluster to the xArray. **/ - for (unsigned long long i = 0llu; i < source_data->nVectors; i++) - if (!check_neg(xaAddItem(&indexes_in_cluster[labels[i]], (void*)i))) goto err_free_sims; - nmSysFree(labels); /* Free unused data. */ + case ALGORITHM_SLIDING_WINDOW: + /** Computed in each search for efficiency. **/ + memset(cluster_data->Clusters, 0, clusters_size); + break; - /** Iterate through each cluster, store it, and free the xArray. **/ - for (unsigned int i = 0u; i < cluster_data->nClusters; i++) + case ALGORITHM_KMEANS: { - pXArray indexes_in_this_cluster = &indexes_in_cluster[i]; - pCluster cluster = &cluster_data->Clusters[i]; - cluster->Size = indexes_in_this_cluster->nItems; - cluster->Strings = check_ptr(nmSysMalloc(cluster->Size * sizeof(char*))); - if (cluster->Strings == NULL) goto err_free_sims; - cluster->Vectors = check_ptr(nmSysMalloc(cluster->Size * sizeof(pVector))); - if (cluster->Vectors == NULL) goto err_free_sims; - for (unsigned int j = 0u; j < cluster->Size; j++) + /** Check for unimplemented similarity measures. **/ + if (cluster_data->SimilarityMeasure != SIMILARITY_COSINE) + { + mssErrorf(1, "Cluster", + "The similarity measure \"%s\" is not implemented.", + ci_SimilarityMeasureToString(cluster_data->SimilarityMeasure) + ); + goto err_free; + } + + /** Allocate lables. Note: kmeans does not require us to initialize them. **/ + const size_t lables_size = source_data->nVectors * sizeof(unsigned int); + unsigned int* labels = check_ptr(nmSysMalloc(lables_size)); + if (labels == NULL) goto err_free; + + /** Run kmeans. **/ + const bool successful = check(ca_kmeans( + source_data->Vectors, + source_data->nVectors, + cluster_data->nClusters, + cluster_data->MaxIterations, + cluster_data->MinImprovement, + labels, + cluster_data->Sims + )); + if (!successful) goto err_free; + + /** Convert the labels into clusters. **/ + + /** Allocate space for clusters. **/ + XArray indexes_in_cluster[cluster_data->nClusters]; + for (unsigned int i = 0u; i < cluster_data->nClusters; i++) + if (!check(xaInit(&indexes_in_cluster[i], 8))) goto err_free; + + /** Iterate through each label and add the index of the specified cluster to the xArray. **/ + for (unsigned long long i = 0llu; i < source_data->nVectors; i++) + if (!check_neg(xaAddItem(&indexes_in_cluster[labels[i]], (void*)i))) goto err_free; + nmSysFree(labels); /* Free unused data. */ + + /** Iterate through each cluster, store it, and free the xArray. **/ + for (unsigned int i = 0u; i < cluster_data->nClusters; i++) { - const unsigned long long index = (unsigned long long)indexes_in_this_cluster->Items[j]; - cluster->Strings[j] = source_data->Strings[index]; - cluster->Vectors[j] = source_data->Vectors[index]; + pXArray indexes_in_this_cluster = &indexes_in_cluster[i]; + pCluster cluster = &cluster_data->Clusters[i]; + cluster->Size = indexes_in_this_cluster->nItems; + cluster->Strings = check_ptr(nmSysMalloc(cluster->Size * sizeof(char*))); + if (cluster->Strings == NULL) goto err_free; + cluster->Vectors = check_ptr(nmSysMalloc(cluster->Size * sizeof(pVector))); + if (cluster->Vectors == NULL) goto err_free; + for (unsigned int j = 0u; j < cluster->Size; j++) + { + const unsigned long long index = (unsigned long long)indexes_in_this_cluster->Items[j]; + cluster->Strings[j] = source_data->Strings[index]; + cluster->Vectors[j] = source_data->Vectors[index]; + } + check(xaDeInit(indexes_in_this_cluster)); /* Failure ignored. */ } - check(xaDeInit(indexes_in_this_cluster)); /* Failure ignored. */ + + /** k-means done. **/ + break; } - /** k-means is done. **/ - break; + default: + mssErrorf(1, "Cluster", + "Clustering algorithm \"%s\" is not implemented.", + ci_ClusteringAlgorithmToString(cluster_data->ClusterAlgorithm) + ); + goto err_free; } - default: - mssErrorf(1, "Cluster", - "Clustering algorithm \"%s\" is not implemented.", - ci_ClusteringAlgorithmToString(cluster_data->ClusterAlgorithm) - ); - goto err; - } - - /** Success. **/ - return 0; - - err_free_sims: - nmFree(cluster_data->Sims, sims_size); - cluster_data->Sims = NULL; - - err_free_clusters: - for (unsigned int i = 0u; i < cluster_data->nClusters; i++) - { - pCluster cluster = &cluster_data->Clusters[i]; - if (cluster->Strings != NULL) nmFree(cluster->Strings, cluster->Size * sizeof(char*)); - else break; - if (cluster->Vectors != NULL) nmFree(cluster->Vectors, cluster->Size * sizeof(pVector)); - else break; - } - nmFree(cluster_data->Clusters, clusters_size); - cluster_data->Clusters = NULL; - - err: - mssErrorf(0, "Cluster", "ClusterData computation failed for \"%s\".", cluster_data->Name); - return -1; + /** Success. **/ + return 0; + + err_free: + if (cluster_data->Sims != NULL) nmFree(cluster_data->Sims, sims_size); + + if (cluster_data->Clusters != NULL) + { + for (unsigned int i = 0u; i < cluster_data->nClusters; i++) + { + pCluster cluster = &cluster_data->Clusters[i]; + if (cluster->Strings != NULL) nmFree(cluster->Strings, cluster->Size * sizeof(char*)); + else break; + if (cluster->Vectors != NULL) nmFree(cluster->Vectors, cluster->Size * sizeof(pVector)); + else break; + } + nmFree(cluster_data->Clusters, clusters_size); + } + + mssErrorf(0, "Cluster", "ClusterData computation failed for \"%s\".", cluster_data->Name); + + return -1; } @@ -2647,53 +2639,39 @@ static int ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data) ***/ static int ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) { - int ret; - - /** If the clusters are already computed, we're done. **/ - if (search_data->Dups != NULL) return 0; - - /** We need the cluster data to be computed before we search it. **/ - pClusterData cluster_data = search_data->SourceCluster; - ret = ci_ComputeClusterData(cluster_data, node_data); - if (ret != 0) - { - mssErrorf(0, "Cluster", "SearchData computation failed due to missing clusters."); - goto err; - } + pXArray dups = NULL; - /** Record the date and time. **/ - if (!check(objCurrentDate(&search_data->DateComputed))) goto err; - - /** Execute the search using the specified source and comparison function. **/ - pXArray dups = NULL, dups_temp = NULL; - switch (search_data->SimilarityMeasure) - { - case SIMILARITY_COSINE: + /** If the clusters are already computed, we're done. **/ + if (search_data->Dups != NULL) return 0; + + /** We need the cluster data to be computed before we search it. **/ + pClusterData cluster_data = check_ptr(search_data->SourceCluster); + if (cluster_data == NULL) { - if (cluster_data->ClusterAlgorithm == ALGORITHM_SLIDING_WINDOW) - { - dups_temp = check_ptr(ca_sliding_search( - (void**)cluster_data->SourceData->Vectors, - cluster_data->SourceData->nVectors, - cluster_data->MaxIterations, /* Window size. */ - ca_cos_compare, - search_data->Threshold, - (void**)cluster_data->SourceData->Keys, - dups - )); - if (dups_temp == NULL) - { - mssErrorf(1, "Cluster", "Failed to compute sliding search with cosine similarity measure."); - goto err_free; - } - } - else + mssErrorf(1, "Cluster", "Failed to get cluster data for search computation."); + goto err_free; + } + if (ci_ComputeClusterData(cluster_data, node_data) != 0) + { + mssErrorf(0, "Cluster", "SearchData computation failed due to missing clusters."); + goto err_free; + } + + /** Record the date and time. **/ + if (!check(objCurrentDate(&search_data->DateComputed))) goto err_free; + + /** Execute the search using the specified source and comparison function. **/ + pXArray dups_temp = NULL; + switch (search_data->SimilarityMeasure) + { + case SIMILARITY_COSINE: { - for (unsigned int i = 0u; i < cluster_data->nClusters; i++) + if (cluster_data->ClusterAlgorithm == ALGORITHM_SLIDING_WINDOW) { - dups_temp = check_ptr(ca_complete_search( - (void**)cluster_data->Clusters[i].Vectors, - cluster_data->Clusters[i].Size, + dups_temp = check_ptr(ca_sliding_search( + (void**)cluster_data->SourceData->Vectors, + cluster_data->SourceData->nVectors, + cluster_data->MaxIterations, /* Window size. */ ca_cos_compare, search_data->Threshold, (void**)cluster_data->SourceData->Keys, @@ -2701,41 +2679,41 @@ static int ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) )); if (dups_temp == NULL) { - mssErrorf(1, "Cluster", "Failed to compute complete search with cosine similarity measure."); + mssErrorf(1, "Cluster", "Failed to compute sliding search with cosine similarity measure."); goto err_free; } - else dups = dups_temp; } - } - break; - } - - case SIMILARITY_LEVENSHTEIN: - { - if (cluster_data->ClusterAlgorithm == ALGORITHM_SLIDING_WINDOW) - { - dups_temp = check_ptr(ca_sliding_search( - (void**)cluster_data->SourceData->Vectors, - cluster_data->SourceData->nVectors, - cluster_data->MaxIterations, /* Window size. */ - ca_lev_compare, - search_data->Threshold, - (void**)cluster_data->SourceData->Keys, - dups - )); - if (dups_temp == NULL) + else { - mssErrorf(1, "Cluster", "Failed to compute sliding search with Levenstein similarity measure."); - goto err_free; + for (unsigned int i = 0u; i < cluster_data->nClusters; i++) + { + dups_temp = check_ptr(ca_complete_search( + (void**)cluster_data->Clusters[i].Vectors, + cluster_data->Clusters[i].Size, + ca_cos_compare, + search_data->Threshold, + (void**)cluster_data->SourceData->Keys, + dups + )); + if (dups_temp == NULL) + { + mssErrorf(1, "Cluster", "Failed to compute complete search with cosine similarity measure."); + goto err_free; + } + else dups = dups_temp; + } } + break; } - else + + case SIMILARITY_LEVENSHTEIN: { - for (unsigned int i = 0u; i < cluster_data->nClusters; i++) + if (cluster_data->ClusterAlgorithm == ALGORITHM_SLIDING_WINDOW) { - dups_temp = check_ptr(ca_complete_search( - (void**)cluster_data->Clusters[i].Strings, - cluster_data->Clusters[i].Size, + dups_temp = check_ptr(ca_sliding_search( + (void**)cluster_data->SourceData->Vectors, + cluster_data->SourceData->nVectors, + cluster_data->MaxIterations, /* Window size. */ ca_lev_compare, search_data->Threshold, (void**)cluster_data->SourceData->Keys, @@ -2743,49 +2721,73 @@ static int ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) )); if (dups_temp == NULL) { - mssErrorf(1, "Cluster", "Failed to compute complete search with Levenstein similarity measure."); + mssErrorf(1, "Cluster", "Failed to compute sliding search with Levenstein similarity measure."); goto err_free; } - else dups = dups_temp; } + else + { + for (unsigned int i = 0u; i < cluster_data->nClusters; i++) + { + dups_temp = check_ptr(ca_complete_search( + (void**)cluster_data->Clusters[i].Strings, + cluster_data->Clusters[i].Size, + ca_lev_compare, + search_data->Threshold, + (void**)cluster_data->SourceData->Keys, + dups + )); + if (dups_temp == NULL) + { + mssErrorf(1, "Cluster", "Failed to compute complete search with Levenstein similarity measure."); + goto err_free; + } + else dups = dups_temp; + } + } + break; } - break; + + default: + mssErrorf(1, "Cluster", + "Unknown similarity meansure \"%s\".", + ci_SimilarityMeasureToString(search_data->SimilarityMeasure) + ); + goto err_free; } + if (dups_temp == NULL) goto err_free; + else dups = dups_temp; + // fprintf(stderr, "Done searching, found %d dups.\n", dups->nItems); - default: - mssErrorf(1, "Cluster", - "Unknown similarity meansure \"%s\".", - ci_SimilarityMeasureToString(search_data->SimilarityMeasure) - ); + /** Store dups. **/ + search_data->nDups = dups->nItems; + search_data->Dups = (dups->nItems == 0) + ? check_ptr(nmSysMalloc(0)) + : ci_xaToTrimmedArray(dups, 2); + if (search_data->Dups == NULL) + { + mssErrorf(1, "Cluster", "Failed to store dups after computing search data."); goto err_free; - } - if (dups_temp == NULL) goto err_free; - else dups = dups_temp; - // fprintf(stderr, "Done searching, found %d dups.\n", dups->nItems); - - /** Store dups. **/ - search_data->nDups = dups->nItems; - search_data->Dups = (dups->nItems == 0) - ? check_ptr(nmSysMalloc(0)) - : ci_xaToTrimmedArray(dups, 2); - - /** Success. **/ - return 0; - + } + + /** Success. **/ + return 0; + err_free: - if (dups != NULL) - { - for (unsigned int i = 0u; i < dups->nItems; i++) + if (search_data->Dups != NULL) nmSysFree(search_data->Dups); + if (dups != NULL) { - if (dups->Items[i] != NULL) nmFree(dups->Items[i], sizeof(Dup)); - else break; + for (unsigned int i = 0u; i < dups->nItems; i++) + { + if (dups->Items[i] != NULL) nmFree(dups->Items[i], sizeof(Dup)); + else break; + } + check(xaFree(dups)); /* Failure ignored. */ } - check(xaFree(dups)); /* Failure ignored. */ - } - - err: - mssErrorf(0, "Cluster", "SearchData computation failed for \"%s\".", search_data->Name); - return -1; + + mssErrorf(0, "Cluster", "SearchData computation failed for \"%s\".", search_data->Name); + + return -1; } @@ -2805,15 +2807,15 @@ static int ci_GetParamType(void* inf_v, const char* attr_name) { pNodeData node_data = (pNodeData)inf_v; - /** Find the parameter. **/ - for (unsigned int i = 0; i < node_data->nParams; i++) - { - pParam param = node_data->Params[i]; - if (strcmp(param->Name, attr_name) != 0) continue; - - /** Parameter found. **/ - return (param->Value == NULL) ? DATA_T_UNAVAILABLE : param->Value->DataType; - } + /** Find the parameter. **/ + for (unsigned int i = 0; i < node_data->nParams; i++) + { + pParam param = node_data->Params[i]; + if (strcmp(param->Name, attr_name) != 0) continue; + + /** Parameter found. **/ + return (param->Value == NULL) ? DATA_T_UNAVAILABLE : param->Value->DataType; + } /** Parameter not found. **/ return DATA_T_UNAVAILABLE; @@ -2848,39 +2850,41 @@ static int ci_GetParamValue(void* inf_v, char* attr_name, int datatype, pObjData { pNodeData node_data = (pNodeData)inf_v; - /** Find the parameter. **/ - for (unsigned int i = 0; i < node_data->nParams; i++) - { - pParam param = (pParam)node_data->Params[i]; - if (strcmp(param->Name, attr_name) != 0) continue; - - /** Parameter found. **/ - if (param->Value == NULL) return 1; - if (param->Value->Flags & DATA_TF_NULL) return 1; - if (param->Value->DataType != datatype) + /** Find the parameter. **/ + for (unsigned int i = 0; i < node_data->nParams; i++) { - mssErrorf(1, "Cluster", "Type mismatch accessing parameter '%s'.", param->Name); - return -1; + pParam param = (pParam)node_data->Params[i]; + if (strcmp(param->Name, attr_name) != 0) continue; + + /** Parameter found. **/ + if (param->Value == NULL) return 1; + if (param->Value->Flags & DATA_TF_NULL) return 1; + if (param->Value->DataType != datatype) + { + mssErrorf(1, "Cluster", "Type mismatch accessing parameter '%s'.", param->Name); + return -1; + } + + /** Return param value. **/ + if (!check(objCopyData(&(param->Value->Data), val, datatype))) goto err; + return 0; } - /** Return param value. **/ - if (!check(objCopyData(&(param->Value->Data), val, datatype))) goto err; - return 0; - } - err: - mssErrorf(1, "Cluster", - "Failed to get parameter ['%s' : %s]", - attr_name, ci_TypeToStr(datatype) - ); - return -1; + mssErrorf(1, "Cluster", + "Failed to get parameter ['%s' : %s]", + attr_name, objTypeToStr(datatype) + ); + + return -1; } // LINK #functions /** Not implemented. **/ static int ci_SetParamValue(void* inf_v, char* attr_name, int datatype, pObjData val) { - mssErrorf(1, "Cluster", "SetParamValue() is not implemented because clusters are imutable."); + mssErrorf(1, "Cluster", "SetParamValue() is not implemented because clusters are imutable."); + return -1; } @@ -2906,152 +2910,159 @@ static int ci_SetParamValue(void* inf_v, char* attr_name, int datatype, pObjData ***/ void* clusterOpen(pObject parent, int mask, pContentType sys_type, char* usr_type, pObjTrxTree* oxt) { - /** Update statistics. **/ - ClusterStatistics.OpenCalls++; + pNodeData node_data = NULL; + pDriverData driver_data = NULL; - /** If CREAT and EXCL are specified, exclusively create it, failing if the file already exists. **/ - pSnNode node_struct = NULL; - bool can_create = (parent->Mode & O_CREAT) && (parent->SubPtr == parent->Pathname->nElements); - if (can_create && (parent->Mode & O_EXCL)) - { - node_struct = snNewNode(parent->Prev, usr_type); + /** Update statistics. **/ + ClusterStatistics.OpenCalls++; + + /** If CREAT and EXCL are specified, exclusively create it, failing if the file already exists. **/ + pSnNode node_struct = NULL; + bool can_create = (parent->Mode & O_CREAT) && (parent->SubPtr == parent->Pathname->nElements); + if (can_create && (parent->Mode & O_EXCL)) + { + node_struct = snNewNode(parent->Prev, usr_type); + if (node_struct == NULL) + { + mssErrorf(0, "Cluster", "Failed to exclusively create new node struct."); + goto err_free; + } + } + + /** Read the node if it exists. **/ + if (node_struct == NULL) + node_struct = snReadNode(parent->Prev); + + /** If we can't read it, create it (if allowed). **/ + if (node_struct == NULL && can_create) + node_struct = snNewNode(parent->Prev, usr_type); + + /** If there still isn't a node, fail early. **/ if (node_struct == NULL) { - mssErrorf(0, "Cluster", "Failed to exclusively create new node struct."); - goto err; + mssErrorf(0, "Cluster", "Failed to create node struct."); + goto err_free; } - } - - /** Read the node if it exists. **/ - if (node_struct == NULL) - node_struct = snReadNode(parent->Prev); - - /** If we can't read it, create it (if allowed). **/ - if (node_struct == NULL && can_create) - node_struct = snNewNode(parent->Prev, usr_type); - - /** If there still isn't a node, fail early. **/ - if (node_struct == NULL) - { - mssErrorf(0, "Cluster", "Failed to create node struct."); - goto err; - } - - /** Magic. **/ - ASSERTMAGIC(node_struct, MGK_STNODE); - ASSERTMAGIC(node_struct->Data, MGK_STRUCTINF); - - /** Parse node data from the node_struct. **/ - pNodeData node_data = ci_ParseNodeData(node_struct->Data, parent); - if (node_data == NULL) - { - mssErrorf(0, "Cluster", "Failed to parse structure file \"%s\".", ci_file_name(parent)); - goto err; - } - - /** Allocate driver instance data. **/ - pDriverData driver_data = check_ptr(nmMalloc(sizeof(DriverData))); - if (driver_data == NULL) goto err_free_node; - memset(driver_data, 0, sizeof(DriverData)); - driver_data->NodeData = node_data; - - /** Detect target from path. **/ - char* target_name = obj_internal_PathPart(parent->Pathname, parent->SubPtr + parent->SubCnt++, 1); - if (target_name == NULL) - { - /** Target found: Root **/ - driver_data->TargetType = TARGET_ROOT; - driver_data->TargetData = (void*)driver_data->NodeData->SourceData; - return (void*)driver_data; /* Success. */ - } - - /** Search clusters. **/ - for (unsigned int i = 0u; i < node_data->nClusterDatas; i++) - { - pClusterData cluster = node_data->ClusterDatas[i]; - if (strcmp(cluster->Name, target_name) != 0) continue; - /** Target found: Cluster **/ - driver_data->TargetType = TARGET_CLUSTER; + /** Magic. **/ + ASSERTMAGIC(node_struct, MGK_STNODE); + ASSERTMAGIC(node_struct->Data, MGK_STRUCTINF); - /** Check for sub-clusters in the path. **/ - while (true) + /** Parse node data from the node_struct. **/ + node_data = ci_ParseNodeData(node_struct->Data, parent); + if (node_data == NULL) { - /** Decend one path part deeper into the path. **/ - const char* path_part = obj_internal_PathPart(parent->Pathname, parent->SubPtr + parent->SubCnt++, 1); + mssErrorf(0, "Cluster", "Failed to parse structure file \"%s\".", ci_file_name(parent)); + goto err_free; + } + + /** Allocate driver instance data. **/ + driver_data = check_ptr(nmMalloc(sizeof(DriverData))); + if (driver_data == NULL) goto err_free; + memset(driver_data, 0, sizeof(DriverData)); + driver_data->NodeData = node_data; + driver_data->NodeData->OpenCount++; - /** If the path does not go any deeper, we're done. **/ - if (path_part == NULL) - { - driver_data->TargetData = (void*)cluster; - break; - } + /** Detect target from path. **/ + char* target_name = obj_internal_PathPart(parent->Pathname, parent->SubPtr + parent->SubCnt++, 1); + if (target_name == NULL) + { + /** Target found: Root **/ + driver_data->TargetType = TARGET_NODE; + driver_data->TargetData = (void*)driver_data->NodeData->SourceData; + goto success; + } + + /** Search clusters. **/ + for (unsigned int i = 0u; i < node_data->nClusterDatas; i++) + { + pClusterData cluster = node_data->ClusterDatas[i]; + if (strcmp(cluster->Name, target_name) != 0) continue; + + /** Target found: Cluster **/ + driver_data->TargetType = TARGET_CLUSTER; - /** Need to go deeper: Search for the requested sub-cluster. **/ - for (unsigned int i = 0u; i < cluster->nSubClusters; i++) + /** Check for sub-clusters in the path. **/ + while (true) { - pClusterData sub_cluster = cluster->SubClusters[i]; - if (strcmp(sub_cluster->Name, path_part) != 0) continue; + /** Decend one path part deeper into the path. **/ + const char* path_part = obj_internal_PathPart(parent->Pathname, parent->SubPtr + parent->SubCnt++, 1); - /** Target found: Sub-cluster **/ - cluster = sub_cluster; - goto continue_descent; - } + /** If the path does not go any deeper, we're done. **/ + if (path_part == NULL) + { + driver_data->TargetData = (void*)cluster; + break; + } + + /** Need to go deeper: Search for the requested sub-cluster. **/ + for (unsigned int i = 0u; i < cluster->nSubClusters; i++) + { + pClusterData sub_cluster = cluster->SubClusters[i]; + if (strcmp(sub_cluster->Name, path_part) != 0) continue; + + /** Target found: Sub-cluster **/ + cluster = sub_cluster; + goto continue_descent; + } + + /** Path names sub-cluster that does not exist. **/ + mssErrorf(1, "Cluster", "Sub-cluster \"%s\" does not exist.", path_part); + goto err_free; - /** Path names sub-cluster that does not exist. **/ - mssErrorf(1, "Cluster", "Sub-cluster \"%s\" does not exist.", path_part); - goto err_free_node; + continue_descent:; + } + goto success; + } + + /** Search searches. **/ + for (unsigned int i = 0u; i < node_data->nSearchDatas; i++) + { + pSearchData search = node_data->SearchDatas[i]; + if (strcmp(search->Name, target_name) != 0) continue; + + /** Target found: Search **/ + driver_data->TargetType = TARGET_SEARCH; + driver_data->TargetData = (void*)search; - continue_descent:; + /** Check for extra, invalid path parts. **/ + char* extra_data = obj_internal_PathPart(parent->Pathname, parent->SubPtr + parent->SubCnt++, 1); + if (extra_data != NULL) + { + mssErrorf(1, "Cluster", "Unknown path part %s.", extra_data); + goto err_free; + } + return (void*)driver_data; /* Success. */ } - return (void*)driver_data; /* Success. */ - } - - /** Search searches. **/ - for (unsigned int i = 0u; i < node_data->nSearchDatas; i++) - { - pSearchData search = node_data->SearchDatas[i]; - if (strcmp(search->Name, target_name) != 0) continue; - - /** Target found: Search **/ - driver_data->TargetType = TARGET_SEARCH; - driver_data->TargetData = (void*)search; - - /** Check for extra, invalid path parts. **/ - char* extra_data = obj_internal_PathPart(parent->Pathname, parent->SubPtr + parent->SubCnt++, 1); - if (extra_data != NULL) + + /** We were unable to find the requested cluster or search. **/ + mssErrorf(1, "Cluster", "\"%s\" is not the name of a declared cluster or search.", target_name); + + /** Attempt to give a hint. **/ { - mssErrorf(1, "Cluster", "Unknown path part %s.", extra_data); - goto err_free_node; + const unsigned int n_targets = node_data->nClusterDatas + node_data->nSearchDatas; + char* target_names[n_targets]; + for (unsigned int i = 0u; i < node_data->nClusterDatas; i++) + target_names[i] = node_data->ClusterDatas[i]->Name; + for (unsigned int i = 0u; i < node_data->nSearchDatas; i++) + target_names[i + node_data->nClusterDatas] = node_data->SearchDatas[i]->Name; + ci_TryHint(target_name, target_names, n_targets); } - return (void*)driver_data; /* Success. */ - } - - /** We were unable to find the requested cluster or search. **/ - mssErrorf(1, "Cluster", "\"%s\" is not the name of a declared cluster or search.", target_name); - - /** Attempt to give a hint. **/ - { - const unsigned int n_targets = node_data->nClusterDatas + node_data->nSearchDatas; - char* target_names[n_targets]; - for (unsigned int i = 0u; i < node_data->nClusterDatas; i++) - target_names[i] = node_data->ClusterDatas[i]->Name; - for (unsigned int i = 0u; i < node_data->nSearchDatas; i++) - target_names[i + node_data->nClusterDatas] = node_data->SearchDatas[i]->Name; - ci_TryHint(target_name, target_names, n_targets); - } - - /** Error cleanup. **/ - err_free_node: - if (node_data != NULL) ci_FreeNodeData(node_data); - if (driver_data != NULL) nmFree(driver_data, sizeof(DriverData)); - - err: - mssErrorf(0, "Cluster", - "Failed to open cluster file \"%s\" at: %s", - ci_file_name(parent), ci_file_path(parent) - ); - return NULL; + + /** Error cleanup. **/ + err_free: + if (node_data != NULL) ci_FreeNodeData(node_data); + if (driver_data != NULL) nmFree(driver_data, sizeof(DriverData)); + + mssErrorf(0, "Cluster", + "Failed to open cluster file \"%s\" at: %s", + ci_file_name(parent), ci_file_path(parent) + ); + + return NULL; + + success: + return driver_data; } @@ -3067,21 +3078,20 @@ void* clusterOpen(pObject parent, int mask, pContentType sys_type, char* usr_typ int clusterClose(void* inf_v, pObjTrxTree* oxt) { pDriverData driver_data = (pDriverData)inf_v; - ClusterStatistics.CloseCalls++; - /** Entries are shallow copies so we shouldn't do a deep free. **/ - if (driver_data->TargetType == TARGET_CLUSTER_ENTRY - || driver_data->TargetType == TARGET_SEARCH_ENTRY) - { + /** Update statistics. **/ + ClusterStatistics.CloseCalls++; + + /** No work needed. **/ + if (driver_data == NULL) return 0; + + /** Unlink the driver's node data. **/ + pNodeData node_data = driver_data->NodeData; + if (node_data != NULL && --node_data->OpenCount == 0) + ci_FreeNodeData(driver_data->NodeData); + + /** Free driver data. **/ nmFree(driver_data, sizeof(DriverData)); - return 0; - } - - /** Free the node data (which is held in cache). **/ - ci_FreeNodeData(driver_data->NodeData); - - /** Free driver data. **/ - nmFree(driver_data, sizeof(DriverData)); return 0; } @@ -3096,15 +3106,33 @@ int clusterClose(void* inf_v, pObjTrxTree* oxt) *** @param query The query to use on this struct. This is assumed to be *** handled elsewhere, so we don't read it here (unused). *** @param oxt The object system tree, similar to a kind of "scope" (unused). - *** @returns The cluster query. + *** @returns The cluster query, or + *** NULL if an error occurs. ***/ void* clusterOpenQuery(void* inf_v, pObjQuery query, pObjTrxTree* oxt) { - ClusterStatistics.OpenQueryCalls++; - pClusterQuery cluster_query = check_ptr(nmMalloc(sizeof(ClusterQuery))); - if (cluster_query == NULL) return NULL; - cluster_query->DriverData = (pDriverData)inf_v; - cluster_query->RowIndex = 0u; + pClusterQuery cluster_query = NULL; + pDriverData driver_data = inf_v; + + if (driver_data->TargetType != TARGET_SEARCH + && driver_data->TargetType != TARGET_CLUSTER + && driver_data->TargetType != TARGET_NODE) + { + /** Queries are not supported for this target type. **/ + return NULL; + } + + /** Update statistics. **/ + ClusterStatistics.OpenQueryCalls++; + + /** Allocate memory for the query. **/ + cluster_query = check_ptr(nmMalloc(sizeof(ClusterQuery))); + if (cluster_query == NULL) return NULL; + + /** Initialize the query. **/ + cluster_query->DriverData = (pDriverData)inf_v; + cluster_query->RowIndex = 0u; + return cluster_query; } @@ -3123,76 +3151,124 @@ void* clusterOpenQuery(void* inf_v, pObjQuery query, pObjTrxTree* oxt) ***/ void* clusterQueryFetch(void* qy_v, pObject obj, int mode, pObjTrxTree* oxt) { - int ret; pClusterQuery cluster_query = (pClusterQuery)qy_v; + pDriverData driver_data = cluster_query->DriverData; + pDriverData result_data = NULL; - /** Update statistics. **/ - ClusterStatistics.FetchCalls++; - - /** Ensure that the data being fetched exists and is computed. **/ - TargetType target_type = cluster_query->DriverData->TargetType, new_target_type; - unsigned int data_amount = 0u; - switch (target_type) - { - case TARGET_ROOT: - mssErrorf(1, "Cluster", "Querying the root node of a cluster file is not allowed."); - fprintf(stderr, " > Hint: Try / or /\n"); - goto err; + /** Update statistics. **/ + ClusterStatistics.FetchCalls++; + + /** Allocate result struct. **/ + result_data = check_ptr(nmMalloc(sizeof(DriverData))); + if (result_data == NULL) goto err; + + /** Default initialization. **/ + result_data->NodeData = driver_data->NodeData; + result_data->TargetData = driver_data->TargetData; + result_data->TargetType = 0; /* Unset. */ + result_data->TargetIndex = 0; /* Reset. */ + result_data->TargetAttrIndex = 0; /* Reset. */ + result_data->TargetMethodIndex = 0; /* Reset. */ - case TARGET_CLUSTER: + /** Load node data. **/ + pNodeData node_data = driver_data->NodeData; + + /** Ensure that the data being fetched exists and is computed. **/ + const TargetType target_type = driver_data->TargetType; + switch (target_type) { - new_target_type = TARGET_CLUSTER_ENTRY; - pClusterData target = (pClusterData)cluster_query->DriverData->TargetData; - ret = ci_ComputeClusterData(target, cluster_query->DriverData->NodeData); - if (ret != 0) + case TARGET_NODE: { - mssErrorf(0, "Cluster", "Failed to compute ClusterData for query."); - goto err; + unsigned int index = cluster_query->RowIndex++; + + /** Iterate over clusters. **/ + const unsigned int n_cluster_datas = node_data->nClusterDatas; + if (index < n_cluster_datas) + { + /** Fetch a cluster. **/ + result_data->TargetType = TARGET_CLUSTER; + result_data->TargetData = node_data->ClusterDatas[index]; + break; + } + else index -= n_cluster_datas; + + /** Iterate over searches. **/ + const unsigned int n_search_datas = node_data->nSearchDatas; + if (index < n_search_datas) + { + /** Fetch a search. **/ + result_data->TargetType = TARGET_SEARCH; + result_data->TargetData = node_data->SearchDatas[index]; + break; + } + else index -= n_search_datas; + + /** Iteration complete. **/ + goto done; } - data_amount = target->nClusters; - break; - } - - case TARGET_SEARCH: - { - new_target_type = TARGET_SEARCH_ENTRY; - pSearchData target = (pSearchData)cluster_query->DriverData->TargetData; - ret = ci_ComputeSearchData(target, cluster_query->DriverData->NodeData); - if (ret != 0) + + case TARGET_CLUSTER: { - mssErrorf(0, "Cluster", "Failed to compute SearchData for query."); - goto err; + /** Ensure the required data is computed. **/ + pClusterData target = (pClusterData)driver_data->TargetData; + if (ci_ComputeClusterData(target, node_data) != 0) + { + mssErrorf(0, "Cluster", "Failed to compute ClusterData for query."); + goto err; + } + + /** Stop iteration if the requested data does not exist. **/ + if (cluster_query->RowIndex >= target->nClusters) goto done; + + /** Set the data being fetched. **/ + result_data->TargetType = TARGET_CLUSTER_ENTRY; + result_data->TargetIndex = cluster_query->RowIndex++; + + break; + } + + case TARGET_SEARCH: + { + /** Ensure the required data is computed. **/ + pSearchData target = (pSearchData)driver_data->TargetData; + if (ci_ComputeSearchData(target, node_data) != 0) + { + mssErrorf(0, "Cluster", "Failed to compute SearchData for query."); + goto err; + } + + /** Stop iteration if the requested data does not exist. **/ + if (cluster_query->RowIndex >= target->nDups) goto done; + + /** Set the data being fetched. **/ + result_data->TargetType = TARGET_SEARCH_ENTRY; + result_data->TargetIndex = cluster_query->RowIndex++; + + break; } - data_amount = target->nDups; - break; + + case TARGET_CLUSTER_ENTRY: + case TARGET_SEARCH_ENTRY: + mssErrorf(1, "Cluster", "Querying a query result is not allowed."); + goto err; + + default: + mssErrorf(1, "Cluster", "Unknown target type %u.", target_type); + goto err; } - case TARGET_CLUSTER_ENTRY: - case TARGET_SEARCH_ENTRY: - mssErrorf(1, "Cluster", "Querying a query result is not allowed."); - goto err; + /** Add a link to the NodeData so that it isn't freed while we're using it. **/ + node_data->OpenCount++; - default: - mssErrorf(1, "Cluster", "Unknown target type %u.", target_type); - goto err; - } - - /** Check that the requested data exists, returning null if we've reached the end of the data. **/ - if (cluster_query->RowIndex >= data_amount) return NULL; - - /** Create the result struct. **/ - pDriverData driver_data = check_ptr(nmMalloc(sizeof(DriverData))); - if (driver_data == NULL) goto err; - memcpy(driver_data, cluster_query->DriverData, sizeof(DriverData)); - driver_data->TargetType = new_target_type; - driver_data->TargetIndex = cluster_query->RowIndex++; - - /** Success. **/ - return driver_data; - + /** Success. **/ + return result_data; + err: - mssErrorf(0, "Cluster", "Failed to fetch query result."); - return NULL; + mssErrorf(0, "Cluster", "Failed to fetch query result."); + + done: + if (result_data != NULL) nmFree(result_data, sizeof(DriverData)); + return NULL; } @@ -3207,7 +3283,8 @@ void* clusterQueryFetch(void* qy_v, pObject obj, int mode, pObjTrxTree* oxt) ***/ int clusterQueryClose(void* qy_v, pObjTrxTree* oxt) { - nmFree(qy_v, sizeof(ClusterQuery)); + if (qy_v != NULL) nmFree(qy_v, sizeof(ClusterQuery)); + return 0; } @@ -3226,82 +3303,86 @@ int clusterGetAttrType(void* inf_v, char* attr_name, pObjTrxTree* oxt) { pDriverData driver_data = (pDriverData)inf_v; - /** Update statistics. **/ - ClusterStatistics.GetTypeCalls++; - - /** Guard possible segfault. **/ - if (attr_name == NULL) - { - fprintf(stderr, "Warning: Call to clusterGetAttrType() with NULL attribute name.\n"); - return DATA_T_UNAVAILABLE; - } - - /** Performance shortcut for frequently requested attributes: key1, key2, and sim. **/ - if (attr_name[0] == 'k' || attr_name[0] == 's') goto handle_targets; - - /** Types for general attributes. **/ - if (strcmp(attr_name, "name") == 0 - || strcmp(attr_name, "annotation") == 0 - || strcmp(attr_name,"content_type") == 0 - || strcmp(attr_name, "inner_type") == 0 - || strcmp(attr_name,"outer_type") == 0) - return DATA_T_STRING; - if (strcmp(attr_name, "last_modification") == 0) - return DATA_T_DATETIME; - if ((strcmp(attr_name, "date_created") == 0 - || strcmp(attr_name, "date_computed") == 0) - && - (driver_data->TargetType == TARGET_CLUSTER - || driver_data->TargetType == TARGET_SEARCH)) - return DATA_T_DATETIME; - - /** Types for specific data targets. **/ - handle_targets: - switch (driver_data->TargetType) - { - case TARGET_ROOT: - if (strcmp(attr_name, "source") == 0 - || strcmp(attr_name, "data_attr") == 0 - || strcmp(attr_name, "key_attr") == 0) - return DATA_T_STRING; - break; - - case TARGET_CLUSTER: - if (strcmp(attr_name, "algorithm") == 0 - || strcmp(attr_name, "similarity_measure") == 0) - return DATA_T_STRING; - if (strcmp(attr_name, "num_clusters") == 0 - || strcmp(attr_name, "max_iterations") == 0) - return DATA_T_INTEGER; - if (strcmp(attr_name, "min_improvement") == 0) - return DATA_T_DOUBLE; - break; - - case TARGET_SEARCH: - if (strcmp(attr_name, "source") == 0 - || strcmp(attr_name, "similarity_measure") == 0) - return DATA_T_STRING; - if (strcmp(attr_name, "threshold") == 0) - return DATA_T_DOUBLE; - break; - - case TARGET_CLUSTER_ENTRY: - if (strcmp(attr_name, "items") == 0) - return DATA_T_STRINGVEC; - break; - - case TARGET_SEARCH_ENTRY: - if (strcmp(attr_name, "key1") == 0 - || strcmp(attr_name, "key2") == 0) - return DATA_T_STRING; - if (strcmp(attr_name, "sim") == 0) - return DATA_T_DOUBLE; - break; - - default: - mssErrorf(1, "Cluster", "Unknown target type %u.", driver_data->TargetType); + /** Update statistics. **/ + ClusterStatistics.GetTypeCalls++; + + /** Guard possible segfault. **/ + if (attr_name == NULL) + { + fprintf(stderr, "Warning: Call to clusterGetAttrType() with NULL attribute name.\n"); return DATA_T_UNAVAILABLE; - } + } + + /** Performance shortcut for frequently requested attributes: key1, key2, and sim. **/ + if (attr_name[0] == 'k' || attr_name[0] == 's') goto handle_targets; + + /** Types for general attributes. **/ + if (strcmp(attr_name, "name") == 0 + || strcmp(attr_name, "annotation") == 0 + || strcmp(attr_name,"content_type") == 0 + || strcmp(attr_name, "inner_type") == 0 + || strcmp(attr_name,"outer_type") == 0) + return DATA_T_STRING; + if (strcmp(attr_name, "last_modification") == 0) + return DATA_T_DATETIME; + if (strcmp(attr_name, "date_created") == 0 + || strcmp(attr_name, "date_computed") == 0) + { + return (driver_data->TargetType == TARGET_CLUSTER + || driver_data->TargetType == TARGET_CLUSTER_ENTRY + || driver_data->TargetType == TARGET_SEARCH + || driver_data->TargetType == TARGET_SEARCH_ENTRY) + ? DATA_T_DATETIME /* Target has date attr. */ + : DATA_T_UNAVAILABLE; /* Target does not have date attr. */ + } + + /** Types for specific data targets. **/ + handle_targets: + switch (driver_data->TargetType) + { + case TARGET_NODE: + if (strcmp(attr_name, "source") == 0 + || strcmp(attr_name, "data_attr") == 0 + || strcmp(attr_name, "key_attr") == 0) + return DATA_T_STRING; + break; + + case TARGET_CLUSTER: + if (strcmp(attr_name, "algorithm") == 0 + || strcmp(attr_name, "similarity_measure") == 0) + return DATA_T_STRING; + if (strcmp(attr_name, "num_clusters") == 0 + || strcmp(attr_name, "max_iterations") == 0) + return DATA_T_INTEGER; + if (strcmp(attr_name, "min_improvement") == 0) + return DATA_T_DOUBLE; + break; + + case TARGET_SEARCH: + if (strcmp(attr_name, "source") == 0 + || strcmp(attr_name, "similarity_measure") == 0) + return DATA_T_STRING; + if (strcmp(attr_name, "threshold") == 0) + return DATA_T_DOUBLE; + break; + + case TARGET_CLUSTER_ENTRY: + if (strcmp(attr_name, "items") == 0) + return DATA_T_STRINGVEC; + break; + + case TARGET_SEARCH_ENTRY: + if (strcmp(attr_name, "key1") == 0 + || strcmp(attr_name, "key2") == 0) + return DATA_T_STRING; + if (strcmp(attr_name, "sim") == 0) + return DATA_T_DOUBLE; + break; + + default: + mssErrorf(1, "Cluster", "Unknown target type %u.", driver_data->TargetType); + return DATA_T_UNAVAILABLE; + } return DATA_T_UNAVAILABLE; } @@ -3329,287 +3410,320 @@ int clusterGetAttrType(void* inf_v, char* attr_name, pObjTrxTree* oxt) int clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val, pObjTrxTree* oxt) { pDriverData driver_data = (pDriverData)inf_v; - ClusterStatistics.GetValCalls++; - - /** Guard possible segfault. **/ - if (attr_name == NULL) - { - fprintf(stderr, "Warning: Call to clusterGetAttrType() with NULL attribute name.\n"); - return DATA_T_UNAVAILABLE; - } - - /** Performance shortcut for frequently requested attributes: key1, key2, and sim. **/ - if ((attr_name[0] == 'k' && datatype == DATA_T_STRING) /* key1, key2 : string */ - || (attr_name[0] == 's' && datatype == DATA_T_DOUBLE) /* sim : double */ - ) goto handle_targets; - - /** Type check. **/ - const int expected_datatype = clusterGetAttrType(inf_v, attr_name, NULL); - if (datatype != expected_datatype) - { - mssErrorf(1, "Cluster", - "Type mismatch: Accessing attribute ['%s' : %s] as type %s.", - attr_name, ci_TypeToStr(expected_datatype), ci_TypeToStr(datatype) - ); - return -1; - } - /** Handle name and annotation. **/ - if (strcmp(attr_name, "name") == 0) - { - ClusterStatistics.GetValCalls_name++; - switch (driver_data->TargetType) - { - case TARGET_ROOT: - val->String = ((pSourceData)driver_data->TargetData)->Name; - break; - - case TARGET_CLUSTER: - case TARGET_CLUSTER_ENTRY: - val->String = ((pClusterData)driver_data->TargetData)->Name; - break; - - case TARGET_SEARCH: - case TARGET_SEARCH_ENTRY: - val->String = ((pSearchData)driver_data->TargetData)->Name; - break; - - default: - mssErrorf(1, "Cluster", "Unknown target type %u.", driver_data->TargetType); - return -1; - } + /** Update statistics. **/ + ClusterStatistics.GetValCalls++; - return 0; - } - if (strcmp(attr_name, "annotation") == 0) - { - switch (driver_data->TargetType) + /** Guard possible segfault. **/ + if (attr_name == NULL) { - case TARGET_ROOT: val->String = "Clustering driver."; break; - case TARGET_CLUSTER: val->String = "Clustering driver: Cluster."; break; - case TARGET_CLUSTER_ENTRY: val->String = "Clustering driver: Cluster Entry."; break; - case TARGET_SEARCH: val->String = "Clustering driver: Search."; break; - case TARGET_SEARCH_ENTRY: val->String = "Clustering driver: Cluster Entry."; break; - - default: - mssErrorf(1, "Cluster", "Unknown target type %u.", driver_data->TargetType); - return -1; + fprintf(stderr, "Warning: Call to clusterGetAttrType() with NULL attribute name.\n"); + return DATA_T_UNAVAILABLE; } - return 0; - } - - /** Return the appropriate types. **/ - if (strcmp(attr_name, "outer_type") == 0) - { - val->String = "system/row"; - return 0; - } - if (strcmp(attr_name, "content_type") == 0 - || strcmp(attr_name, "inner_type") == 0) - { - val->String = "system/void"; - return 0; - } - - /** Last modification is not implemented yet. **/ - if (strcmp(attr_name, "last_modification") == 0) return 1; /* null */ - - /** Handle creation and computation dates. **/ - if (strcmp(attr_name, "date_created") == 0) - { - switch (driver_data->TargetType) + + /** Performance shortcut for frequently requested attributes: key1, key2, and sim. **/ + if ((attr_name[0] == 'k' && datatype == DATA_T_STRING) /* key1, key2 : string */ + || (attr_name[0] == 's' && datatype == DATA_T_DOUBLE) /* sim : double */ + ) goto handle_targets; + + /** Type check. **/ + const int expected_datatype = clusterGetAttrType(inf_v, attr_name, oxt); + if (datatype != expected_datatype) { - case TARGET_ROOT: - case TARGET_CLUSTER_ENTRY: - case TARGET_SEARCH_ENTRY: - /** Attribute is not defined for this target type. **/ - return -1; - - case TARGET_CLUSTER: - val->DateTime = &((pClusterData)driver_data->TargetData)->DateCreated; - return 0; - - case TARGET_SEARCH: - val->DateTime = &((pSearchData)driver_data->TargetData)->DateCreated; - return 0; + mssErrorf(1, "Cluster", + "Type mismatch: Accessing attribute ['%s' : %s] as type %s.", + attr_name, objTypeToStr(expected_datatype), objTypeToStr(datatype) + ); + return -1; } - return -1; - } - if (strcmp(attr_name, "date_computed") == 0) - { - switch (driver_data->TargetType) + + /** Handle name. **/ + if (strcmp(attr_name, "name") == 0) { - case TARGET_ROOT: - case TARGET_CLUSTER_ENTRY: - case TARGET_SEARCH_ENTRY: - /** Attribute is not defined for this target type. **/ - return -1; - - case TARGET_CLUSTER: + ClusterStatistics.GetValCalls_name++; + switch (driver_data->TargetType) { - pClusterData target = (pClusterData)driver_data->TargetData; - pDateTime date_time = &target->DateComputed; - if (date_time->Value == 0) return 1; /* null */ - else val->DateTime = date_time; - return 0; + case TARGET_NODE: + val->String = ((pSourceData)driver_data->TargetData)->Name; + break; + + case TARGET_CLUSTER: + case TARGET_CLUSTER_ENTRY: + val->String = ((pClusterData)driver_data->TargetData)->Name; + break; + + case TARGET_SEARCH: + case TARGET_SEARCH_ENTRY: + val->String = ((pSearchData)driver_data->TargetData)->Name; + break; + + default: + mssErrorf(1, "Cluster", "Unknown target type %u.", driver_data->TargetType); + return -1; } - case TARGET_SEARCH: - { - pSearchData target = (pSearchData)driver_data->TargetData; - pDateTime date_time = &target->DateComputed; - if (date_time->Value == 0) return 1; /* null */ - else val->DateTime = date_time; - return 0; - } + return 0; } - /** Default: Unknown type. **/ - mssErrorf(1, "Cluster", "Unknown target type %u.", driver_data->TargetType); - return -1; - } - - /** Handle attributes for specific data targets. **/ - handle_targets: - switch (driver_data->TargetType) - { - case TARGET_ROOT: - if (strcmp(attr_name, "source") == 0) - { - val->String = ((pSourceData)driver_data->TargetData)->SourcePath; - return 0; - } - if (strcmp(attr_name, "key_attr") == 0) - { - val->String = ((pSourceData)driver_data->TargetData)->KeyAttr; - return 0; - } - if (strcmp(attr_name, "name_attr") == 0) + /** Handle annotation. **/ + if (strcmp(attr_name, "annotation") == 0) + { + switch (driver_data->TargetType) { - val->String = ((pSourceData)driver_data->TargetData)->NameAttr; - return 0; + case TARGET_NODE: val->String = "Clustering driver."; break; + case TARGET_CLUSTER: val->String = "Clustering driver: Cluster."; break; + case TARGET_CLUSTER_ENTRY: val->String = "Clustering driver: Cluster Entry."; break; + case TARGET_SEARCH: val->String = "Clustering driver: Search."; break; + case TARGET_SEARCH_ENTRY: val->String = "Clustering driver: Cluster Entry."; break; + + default: + mssErrorf(1, "Cluster", "Unknown target type %u.", driver_data->TargetType); + return -1; } - break; + return 0; + } - case TARGET_CLUSTER: + /** Handle various types. **/ + if (strcmp(attr_name, "outer_type") == 0) { - pClusterData target = (pClusterData)driver_data->TargetData; - - if (strcmp(attr_name, "algorithm") == 0) - { - val->String = ci_ClusteringAlgorithmToString(target->ClusterAlgorithm); - return 0; - } - if (strcmp(attr_name, "similarity_measure") == 0) - { - val->String = ci_SimilarityMeasureToString(target->SimilarityMeasure); - return 0; - } - if (strcmp(attr_name, "num_clusters") == 0) - { - if (target->nClusters > INT_MAX) - fprintf(stderr, "Warning: 'num_clusters' value of %u exceeds INT_MAX (%d).\n", target->nClusters, INT_MAX); - val->Integer = (int)target->nClusters; - return 0; - } - if (strcmp(attr_name, "max_iterations") == 0) - { - if (target->MaxIterations > INT_MAX) - fprintf(stderr, "Warning: 'max_iterations' value of %u exceeds INT_MAX (%d).\n", target->MaxIterations, INT_MAX); - val->Integer = (int)target->MaxIterations; - return 0; - } - if (strcmp(attr_name, "min_improvement") == 0) + val->String = "system/row"; + return 0; + } + if (strcmp(attr_name, "content_type") == 0 + || strcmp(attr_name, "inner_type") == 0) + { + val->String = "system/void"; + return 0; + } + if (strcmp(attr_name, "internal_type") == 0) + { + switch (driver_data->TargetType) { - val->Double = target->MinImprovement; - return 0; + case TARGET_NODE: val->String = "system/cluster"; break; + case TARGET_CLUSTER: val->String = "cluster/cluster"; break; + case TARGET_CLUSTER_ENTRY: val->String = "cluster/entry"; break; + case TARGET_SEARCH: val->String = "cluster/search"; break; + case TARGET_SEARCH_ENTRY: val->String = "search/entry"; break; + default: + mssErrorf(1, "Cluster", "Unknown target type %u.", driver_data->TargetType); + return -1; } - break; + + return 0; } - case TARGET_SEARCH: + /** Last modification is not implemented. **/ + if (strcmp(attr_name, "last_modification") == 0) { - pSearchData target = (pSearchData)driver_data->TargetData; - - if (strcmp(attr_name, "source") == 0) - { - val->String = target->SourceCluster->Name; - return 0; - } - if (strcmp(attr_name, "similarity_measure") == 0) - { - val->String = ci_SimilarityMeasureToString(target->SimilarityMeasure); - return 0; - } - if (strcmp(attr_name, "threshold") == 0) + if (driver_data->TargetType == TARGET_CLUSTER + || driver_data->TargetType == TARGET_CLUSTER_ENTRY + || driver_data->TargetType == TARGET_SEARCH + || driver_data->TargetType == TARGET_SEARCH_ENTRY) + goto date_computed; + else return 1; /* null */ + } + + /** Handle date_created. **/ + if (strcmp(attr_name, "date_created") == 0) + { + switch (driver_data->TargetType) { - val->Double = target->Threshold; - return 0; + case TARGET_NODE: + /** Attribute is not defined for this target type. **/ + return -1; + + case TARGET_CLUSTER: + case TARGET_CLUSTER_ENTRY: + val->DateTime = &((pClusterData)driver_data->TargetData)->DateCreated; + return 0; + + case TARGET_SEARCH: + case TARGET_SEARCH_ENTRY: + val->DateTime = &((pSearchData)driver_data->TargetData)->DateCreated; + return 0; } + return -1; } - case TARGET_CLUSTER_ENTRY: + /** Handle date_computed. **/ + if (strcmp(attr_name, "date_computed") == 0) { - pClusterData target = (pClusterData)driver_data->TargetData; - pCluster target_cluster = &target->Clusters[driver_data->TargetIndex]; - - if (strcmp(attr_name, "items") == 0) + date_computed: + switch (driver_data->TargetType) { - /** Static variable to prevent leaking StringVec from previous calls. **/ - static StringVec* vec = NULL; - if (vec != NULL) nmFree(vec, sizeof(StringVec)); + case TARGET_NODE: + /** Attribute is not defined for this target type. **/ + return -1; - /** Allocate and initialize the requested data. **/ - val->StringVec = vec = check_ptr(nmMalloc(sizeof(StringVec))); - if (val->StringVec == NULL) return -1; - val->StringVec->nStrings = target_cluster->Size; - val->StringVec->Strings = target_cluster->Strings; + case TARGET_CLUSTER: + case TARGET_CLUSTER_ENTRY: + { + pClusterData target = (pClusterData)driver_data->TargetData; + pDateTime date_time = &target->DateComputed; + if (date_time->Value == 0) return 1; /* null */ + else val->DateTime = date_time; + return 0; + } - /** Success. **/ - return 0; + case TARGET_SEARCH: + case TARGET_SEARCH_ENTRY: + { + pSearchData target = (pSearchData)driver_data->TargetData; + pDateTime date_time = &target->DateComputed; + if (date_time->Value == 0) return 1; /* null */ + else val->DateTime = date_time; + return 0; + } } - break; + + /** Default: Unknown type. **/ + mssErrorf(1, "Cluster", "Unknown target type %u.", driver_data->TargetType); + return -1; } - case TARGET_SEARCH_ENTRY: + /** Handle attributes for specific data targets. **/ + handle_targets: + switch (driver_data->TargetType) { - pSearchData target = (pSearchData)driver_data->TargetData; - pDup target_dup = target->Dups[driver_data->TargetIndex]; + case TARGET_NODE: + if (strcmp(attr_name, "source") == 0) + { + /** TODO: THAT'S NOT A SOURCE DATA STRUCT!?!?!?!?!?!?!??!?!?!? */ + val->String = ((pSourceData)driver_data->TargetData)->SourcePath; + fprintf(stderr, "Got source: \"%s\"", val->String); + return 0; + } + if (strcmp(attr_name, "key_attr") == 0) + { + val->String = ((pSourceData)driver_data->TargetData)->KeyAttr; + return 0; + } + if (strcmp(attr_name, "name_attr") == 0) + { + val->String = ((pSourceData)driver_data->TargetData)->NameAttr; + return 0; + } + break; - if (strcmp(attr_name, "sim") == 0) + case TARGET_CLUSTER: { - ClusterStatistics.GetValCalls_sim++; - val->Double = target_dup->similarity; - return 0; + pClusterData target = (pClusterData)driver_data->TargetData; + + if (strcmp(attr_name, "algorithm") == 0) + { + val->String = ci_ClusteringAlgorithmToString(target->ClusterAlgorithm); + return 0; + } + if (strcmp(attr_name, "similarity_measure") == 0) + { + val->String = ci_SimilarityMeasureToString(target->SimilarityMeasure); + return 0; + } + if (strcmp(attr_name, "num_clusters") == 0) + { + if (target->nClusters > INT_MAX) + fprintf(stderr, "Warning: 'num_clusters' value of %u exceeds INT_MAX (%d).\n", target->nClusters, INT_MAX); + val->Integer = (int)target->nClusters; + return 0; + } + if (strcmp(attr_name, "max_iterations") == 0) + { + if (target->MaxIterations > INT_MAX) + fprintf(stderr, "Warning: 'max_iterations' value of %u exceeds INT_MAX (%d).\n", target->MaxIterations, INT_MAX); + val->Integer = (int)target->MaxIterations; + return 0; + } + if (strcmp(attr_name, "min_improvement") == 0) + { + val->Double = target->MinImprovement; + return 0; + } + break; } - if (strcmp(attr_name, "key1") == 0) + + case TARGET_SEARCH: { - ClusterStatistics.GetValCalls_key1++; - val->String = target_dup->key1; - return 0; + pSearchData target = (pSearchData)driver_data->TargetData; + + if (strcmp(attr_name, "source") == 0) + { + val->String = target->SourceCluster->Name; + return 0; + } + if (strcmp(attr_name, "similarity_measure") == 0) + { + val->String = ci_SimilarityMeasureToString(target->SimilarityMeasure); + return 0; + } + if (strcmp(attr_name, "threshold") == 0) + { + val->Double = target->Threshold; + return 0; + } + } + + case TARGET_CLUSTER_ENTRY: + { + pClusterData target = (pClusterData)driver_data->TargetData; + pCluster target_cluster = &target->Clusters[driver_data->TargetIndex]; + + if (strcmp(attr_name, "items") == 0) + { + /** Static variable to prevent leaking StringVec from previous calls. **/ + static StringVec* vec = NULL; + if (vec != NULL) nmFree(vec, sizeof(StringVec)); + + /** Allocate and initialize the requested data. **/ + val->StringVec = vec = check_ptr(nmMalloc(sizeof(StringVec))); + if (val->StringVec == NULL) return -1; + val->StringVec->nStrings = target_cluster->Size; + val->StringVec->Strings = target_cluster->Strings; + + /** Success. **/ + return 0; + } + break; } - if (strcmp(attr_name, "key2") == 0) + + case TARGET_SEARCH_ENTRY: { - ClusterStatistics.GetValCalls_key2++; - val->String = target_dup->key2; - return 0; + pSearchData target = (pSearchData)driver_data->TargetData; + pDup target_dup = target->Dups[driver_data->TargetIndex]; + + if (strcmp(attr_name, "sim") == 0) + { + ClusterStatistics.GetValCalls_sim++; + val->Double = target_dup->similarity; + return 0; + } + if (strcmp(attr_name, "key1") == 0) + { + ClusterStatistics.GetValCalls_key1++; + val->String = target_dup->key1; + return 0; + } + if (strcmp(attr_name, "key2") == 0) + { + ClusterStatistics.GetValCalls_key2++; + val->String = target_dup->key2; + return 0; + } + break; } - break; + + default: + mssErrorf(1, "Cluster", "Unknown target type %u.", driver_data->TargetType); + return -1; } - default: - mssErrorf(1, "Cluster", "Unknown target type %u.", driver_data->TargetType); - return -1; - } - - /** Unknown attribute. **/ - char* name; - clusterGetAttrValue(inf_v, "name", DATA_T_STRING, POD(&name), NULL); - mssErrorf(1, "Cluster", - "Unknown attribute '%s' for cluster object %s (target type: %u, \"%s\").", - attr_name, driver_data->NodeData->SourceData->Name, driver_data->TargetType, name - ); - + /** Unknown attribute. **/ + char* name; + clusterGetAttrValue(inf_v, "name", DATA_T_STRING, POD(&name), NULL); + mssErrorf(1, "Cluster", + "Unknown attribute '%s' for cluster object %s (target type: %u, \"%s\").", + attr_name, driver_data->NodeData->SourceData->Name, driver_data->TargetType, name + ); + return -1; } @@ -3632,285 +3746,293 @@ int clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pObjTrxTree* oxt) { pDriverData driver_data = (pDriverData)inf_v; + pObjPresentationHints hints = NULL; + pParamObjects tmp_list = NULL; - /** Malloc presentation hints struct. **/ - pObjPresentationHints hints = check_ptr(nmMalloc(sizeof(ObjPresentationHints))); - if (hints == NULL) goto err; - memset(hints, 0, sizeof(ObjPresentationHints)); - - /** Hints that are the same for all attributes. **/ - hints->GroupID = -1; - hints->VisualLength2 = 1; - hints->Style |= OBJ_PH_STYLE_READONLY | OBJ_PH_STYLE_CREATEONLY | OBJ_PH_STYLE_NOTNULL; - hints->StyleMask |= OBJ_PH_STYLE_READONLY | OBJ_PH_STYLE_CREATEONLY | OBJ_PH_STYLE_NOTNULL; - - /** Temporary param list for compiling expressions. **/ - pParamObjects tmp_list = check_ptr(expCreateParamList()); - if (hints == NULL) goto err; - - /** Search for the requested attribute through attributes common to all instances. **/ - if (strcmp(attr_name, "name") == 0) - { - hints->Length = 32; - hints->VisualLength = 16; - goto success; - } - if (strcmp(attr_name, "annotation") == 0) - { - hints->Length = 36; - hints->VisualLength = 36; - goto success; - } - if (strcmp(attr_name, "inner_type") == 0 - || strcmp(attr_name, "inner_type") == 0 - || strcmp(attr_name, "outer_type") == 0 - || strcmp(attr_name, "content_type") == 0 - || strcmp(attr_name, "last_modification") == 0) - { - hints->VisualLength = 30; - goto success; - } - - /** Handle date created and date computed. */ - if (strcmp(attr_name, "date_created") == 0 - || strcmp(attr_name, "date_computed") == 0) - { - if (driver_data->TargetType == TARGET_CLUSTER || driver_data->TargetType == TARGET_SEARCH) + /** Malloc presentation hints struct. **/ + hints = check_ptr(nmMalloc(sizeof(ObjPresentationHints))); + if (hints == NULL) goto err_free; + memset(hints, 0, sizeof(ObjPresentationHints)); + + /** Hints that are the same for all attributes. **/ + hints->GroupID = -1; + hints->VisualLength2 = 1; + hints->Style |= OBJ_PH_STYLE_READONLY | OBJ_PH_STYLE_CREATEONLY | OBJ_PH_STYLE_NOTNULL; + hints->StyleMask |= OBJ_PH_STYLE_READONLY | OBJ_PH_STYLE_CREATEONLY | OBJ_PH_STYLE_NOTNULL; + + /** Temporary param list for compiling expressions. **/ + tmp_list = check_ptr(expCreateParamList()); + if (hints == NULL) goto err_free; + + /** Search for the requested attribute through attributes common to all instances. **/ + if (strcmp(attr_name, "name") == 0) { - hints->Length = 24; - hints->VisualLength = 20; - hints->Format = check_ptr(nmSysStrdup("datetime")); /* Failure ignored. */ - goto success; + hints->Length = 32; + hints->VisualLength = 16; + goto end; + } + if (strcmp(attr_name, "annotation") == 0) + { + hints->Length = 36; + hints->VisualLength = 36; + goto end; + } + if (strcmp(attr_name, "inner_type") == 0 + || strcmp(attr_name, "inner_type") == 0 + || strcmp(attr_name, "outer_type") == 0 + || strcmp(attr_name, "content_type") == 0 + || strcmp(attr_name, "last_modification") == 0) + { + hints->VisualLength = 30; + goto end; } - else goto unknown_attribute; - } - - /** Search by target type. **/ - switch (driver_data->TargetType) - { - case TARGET_ROOT: - if (strcmp(attr_name, "source") == 0) - { - hints->Length = _PC_PATH_MAX; - hints->VisualLength = 64; - hints->FriendlyName = check_ptr(nmSysStrdup("Source Path")); /* Failure ignored. */ - goto success; - } - if (strcmp(attr_name, "key_attr") == 0) - { - hints->Length = 255; - hints->VisualLength = 32; - hints->FriendlyName = check_ptr(nmSysStrdup("Key Attribute Name")); /* Failure ignored. */ - goto success; - } - if (strcmp(attr_name, "data_attr") == 0) - { - hints->Length = 255; - hints->VisualLength = 32; - hints->FriendlyName = check_ptr(nmSysStrdup("Data Attribute Name")); /* Failure ignored. */ - goto success; - } - break; - case TARGET_CLUSTER: - if (strcmp(attr_name, "num_clusters") == 0) - { - /** Min and max values. **/ - hints->MinValue = expCompileExpression("2", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); - hints->MaxValue = expCompileExpression("2147483647", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); - - /** Other hints. **/ - hints->Length = 8; - hints->VisualLength = 4; - hints->FriendlyName = check_ptr(nmSysStrdup("Number of Clusters")); /* Failure ignored. */ - goto success; - } - if (strcmp(attr_name, "min_improvement") == 0) - { - /** Min and max values. **/ - hints->DefaultExpr = expCompileExpression("0.0001", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); - hints->MinValue = expCompileExpression("0.0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); - hints->MaxValue = expCompileExpression("1.0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); - - /** Other hints. **/ - hints->Length = 16; - hints->VisualLength = 8; - hints->FriendlyName = check_ptr(nmSysStrdup("Minimum Improvement Threshold")); /* Failure ignored. */ - goto success; - } - if (strcmp(attr_name, "max_iterations") == 0) - { - /** Min and max values. **/ - hints->DefaultExpr = expCompileExpression("64", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); - hints->MinValue = expCompileExpression("0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); - hints->MaxValue = expCompileExpression("2147483647", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); - - /** Other hints. **/ - hints->Length = 8; - hints->VisualLength = 4; - hints->FriendlyName = check_ptr(nmSysStrdup("Maximum Iterations")); /* Failure ignored. */ - goto success; - } - if (strcmp(attr_name, "algorithm") == 0) + /** Handle date created and date computed. */ + if (strcmp(attr_name, "date_created") == 0 + || strcmp(attr_name, "date_computed") == 0) + { + if (driver_data->TargetType == TARGET_CLUSTER + || driver_data->TargetType == TARGET_CLUSTER_ENTRY + || driver_data->TargetType == TARGET_SEARCH + || driver_data->TargetType == TARGET_SEARCH_ENTRY) { - /** Enum values. **/ - check(xaInit(&(hints->EnumList), nClusteringAlgorithms)); /* Failure ignored. */ - for (unsigned int i = 0u; i < nClusteringAlgorithms; i++) - check_neg(xaAddItem(&(hints->EnumList), &ALL_CLUSTERING_ALGORITHMS[i])); /* Failure ignored. */ - - /** Min and max values. **/ - hints->MinValue = expCompileExpression("0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); - char buf[8]; - snprintf(buf, sizeof(buf), "%d", nClusteringAlgorithms); - hints->MaxValue = expCompileExpression(buf, tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); - - /** Display flags. **/ - hints->Style |= OBJ_PH_STYLE_BUTTONS; - hints->StyleMask |= OBJ_PH_STYLE_BUTTONS; - - /** Other hints. **/ hints->Length = 24; hints->VisualLength = 20; - hints->FriendlyName = check_ptr(nmSysStrdup("Clustering Algorithm")); /* Failure ignored. */ - goto success; + hints->Format = check_ptr(nmSysStrdup("datetime")); /* Failure ignored. */ + goto end; } - /** Fall-through: Start of overlapping region. **/ + else goto unknown_attribute; + } - case TARGET_SEARCH: - if (strcmp(attr_name, "similarity_measure") == 0) - { - /** Enum values. **/ - check(xaInit(&(hints->EnumList), nSimilarityMeasures)); /* Failure ignored. */ - for (unsigned int i = 0u; i < nSimilarityMeasures; i++) - check_neg(xaAddItem(&(hints->EnumList), &ALL_SIMILARITY_MEASURES[i])); /* Failure ignored. */ + /** Search by target type. **/ + switch (driver_data->TargetType) + { + case TARGET_NODE: + if (strcmp(attr_name, "source") == 0) + { + hints->Length = _PC_PATH_MAX; + hints->VisualLength = 64; + hints->FriendlyName = check_ptr(nmSysStrdup("Source Path")); /* Failure ignored. */ + goto end; + } + if (strcmp(attr_name, "key_attr") == 0) + { + hints->Length = 255; + hints->VisualLength = 32; + hints->FriendlyName = check_ptr(nmSysStrdup("Key Attribute Name")); /* Failure ignored. */ + goto end; + } + if (strcmp(attr_name, "data_attr") == 0) + { + hints->Length = 255; + hints->VisualLength = 32; + hints->FriendlyName = check_ptr(nmSysStrdup("Data Attribute Name")); /* Failure ignored. */ + goto end; + } + break; + + case TARGET_CLUSTER: + if (strcmp(attr_name, "num_clusters") == 0) + { + /** Min and max values. **/ + hints->MinValue = expCompileExpression("2", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + hints->MaxValue = expCompileExpression("2147483647", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + + /** Other hints. **/ + hints->Length = 8; + hints->VisualLength = 4; + hints->FriendlyName = check_ptr(nmSysStrdup("Number of Clusters")); /* Failure ignored. */ + goto end; + } + if (strcmp(attr_name, "min_improvement") == 0) + { + /** Min and max values. **/ + hints->DefaultExpr = expCompileExpression("0.0001", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + hints->MinValue = expCompileExpression("0.0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + hints->MaxValue = expCompileExpression("1.0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + + /** Other hints. **/ + hints->Length = 16; + hints->VisualLength = 8; + hints->FriendlyName = check_ptr(nmSysStrdup("Minimum Improvement Threshold")); /* Failure ignored. */ + goto end; + } + if (strcmp(attr_name, "max_iterations") == 0) + { + /** Min and max values. **/ + hints->DefaultExpr = expCompileExpression("64", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + hints->MinValue = expCompileExpression("0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + hints->MaxValue = expCompileExpression("2147483647", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + + /** Other hints. **/ + hints->Length = 8; + hints->VisualLength = 4; + hints->FriendlyName = check_ptr(nmSysStrdup("Maximum Iterations")); /* Failure ignored. */ + goto end; + } + if (strcmp(attr_name, "algorithm") == 0) + { + /** Enum values. **/ + check(xaInit(&(hints->EnumList), nClusteringAlgorithms)); /* Failure ignored. */ + for (unsigned int i = 0u; i < nClusteringAlgorithms; i++) + check_neg(xaAddItem(&(hints->EnumList), &ALL_CLUSTERING_ALGORITHMS[i])); /* Failure ignored. */ + + /** Min and max values. **/ + hints->MinValue = expCompileExpression("0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + char buf[8]; + snprintf(buf, sizeof(buf), "%d", nClusteringAlgorithms); + hints->MaxValue = expCompileExpression(buf, tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + + /** Display flags. **/ + hints->Style |= OBJ_PH_STYLE_BUTTONS; + hints->StyleMask |= OBJ_PH_STYLE_BUTTONS; - /** Display flags. **/ - hints->Style |= OBJ_PH_STYLE_BUTTONS; - hints->StyleMask |= OBJ_PH_STYLE_BUTTONS; + /** Other hints. **/ + hints->Length = 24; + hints->VisualLength = 20; + hints->FriendlyName = check_ptr(nmSysStrdup("Clustering Algorithm")); /* Failure ignored. */ + goto end; + } + /** Fall-through: Start of overlapping region. **/ + + case TARGET_SEARCH: + if (strcmp(attr_name, "similarity_measure") == 0) + { + /** Enum values. **/ + check(xaInit(&(hints->EnumList), nSimilarityMeasures)); /* Failure ignored. */ + for (unsigned int i = 0u; i < nSimilarityMeasures; i++) + check_neg(xaAddItem(&(hints->EnumList), &ALL_SIMILARITY_MEASURES[i])); /* Failure ignored. */ + + /** Display flags. **/ + hints->Style |= OBJ_PH_STYLE_BUTTONS; + hints->StyleMask |= OBJ_PH_STYLE_BUTTONS; + + /** Min and max values. **/ + hints->MinValue = expCompileExpression("0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + char buf[8]; + snprintf(buf, sizeof(buf), "%d", nSimilarityMeasures); + hints->MaxValue = expCompileExpression(buf, tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + + /** Other hints. **/ + hints->Length = 32; + hints->VisualLength = 20; + hints->FriendlyName = check_ptr(nmSysStrdup("Similarity Measure")); /* Failure ignored. */ + goto end; + } - /** Min and max values. **/ - hints->MinValue = expCompileExpression("0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); - char buf[8]; - snprintf(buf, sizeof(buf), "%d", nSimilarityMeasures); - hints->MaxValue = expCompileExpression(buf, tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + /** End of overlapping region. **/ + if (driver_data->TargetType == TARGET_CLUSTER) break; - /** Other hints. **/ - hints->Length = 32; - hints->VisualLength = 20; - hints->FriendlyName = check_ptr(nmSysStrdup("Similarity Measure")); /* Failure ignored. */ - goto success; - } - - /** End of overlapping region. **/ - if (driver_data->TargetType == TARGET_CLUSTER) break; + if (strcmp(attr_name, "source") == 0) + { + hints->Length = 64; + hints->VisualLength = 32; + hints->FriendlyName = check_ptr(nmSysStrdup("Source Cluster Name")); /* Failure ignored. */ + goto end; + } + if (strcmp(attr_name, "threshold") == 0) + { + /** Min and max values. **/ + hints->MinValue = expCompileExpression("0.0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + hints->MaxValue = expCompileExpression("1.0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + + /** Other hints. **/ + hints->Length = 16; + hints->VisualLength = 8; + hints->FriendlyName = check_ptr(nmSysStrdup("Similarity Threshold")); /* Failure ignored. */ + goto end; + } + break; - if (strcmp(attr_name, "source") == 0) - { - hints->Length = 64; - hints->VisualLength = 32; - hints->FriendlyName = check_ptr(nmSysStrdup("Source Cluster Name")); /* Failure ignored. */ - goto success; - } - if (strcmp(attr_name, "threshold") == 0) + case TARGET_CLUSTER_ENTRY: { - /** Min and max values. **/ - hints->MinValue = expCompileExpression("0.0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); - hints->MaxValue = expCompileExpression("1.0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + pClusterData target = (pClusterData)check_ptr(driver_data->TargetData); + if (target == NULL) goto err_free; - /** Other hints. **/ - hints->Length = 16; - hints->VisualLength = 8; - hints->FriendlyName = check_ptr(nmSysStrdup("Similarity Threshold")); /* Failure ignored. */ - goto success; + if (strcmp(attr_name, "items") == 0) + { + /** Other hints. **/ + hints->Length = 65536; + hints->VisualLength = 256; + hints->FriendlyName = check_ptr(nmSysStrdup("Cluster Data")); /* Failure ignored. */ + goto end; + } + if (strcmp(attr_name, "sim") == 0) + { + /** Min and max values. **/ + hints->MinValue = expCompileExpression("0.0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + hints->MaxValue = expCompileExpression("1.0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + + /** Other hints. **/ + hints->Length = 16; + hints->VisualLength = 8; + hints->FriendlyName = check_ptr(nmSysStrdup("Similarity")); /* Failure ignored. */ + goto end; + } + break; } - break; - - case TARGET_CLUSTER_ENTRY: - { - pClusterData target = (pClusterData)check_ptr(driver_data->TargetData); - if (target == NULL) goto err; - if (strcmp(attr_name, "items") == 0) - { - /** Other hints. **/ - hints->Length = 65536; - hints->VisualLength = 256; - hints->FriendlyName = check_ptr(nmSysStrdup("Cluster Data")); /* Failure ignored. */ - goto success; - } - if (strcmp(attr_name, "sim") == 0) + case TARGET_SEARCH_ENTRY: { - /** Min and max values. **/ - hints->MinValue = expCompileExpression("0.0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); - hints->MaxValue = expCompileExpression("1.0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + pSearchData target = (pSearchData)check_ptr(driver_data->TargetData); + if (target == NULL) goto err_free; - /** Other hints. **/ - hints->Length = 16; - hints->VisualLength = 8; - hints->FriendlyName = check_ptr(nmSysStrdup("Similarity")); /* Failure ignored. */ - goto success; + if (strcmp(attr_name, "key1") == 0) + { + hints->Length = 255; + hints->VisualLength = 32; + hints->FriendlyName = check_ptr(nmSysStrdup("Key 1")); /* Failure ignored. */ + goto end; + } + if (strcmp(attr_name, "key2") == 0) + { + hints->Length = 255; + hints->VisualLength = 32; + hints->FriendlyName = check_ptr(nmSysStrdup("Key 2")); /* Failure ignored. */ + goto end; + } + if (strcmp(attr_name, "sim") == 0) + { + /** Min and max values. **/ + hints->MinValue = expCompileExpression("0.0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + hints->MaxValue = expCompileExpression("1.0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); + + /** Other hints. **/ + hints->Length = 16; + hints->VisualLength = 8; + hints->FriendlyName = check_ptr(nmSysStrdup("Similarity")); /* Failure ignored. */ + goto end; + } + break; } - break; - } - - case TARGET_SEARCH_ENTRY: - { - pSearchData target = (pSearchData)check_ptr(driver_data->TargetData); - if (target == NULL) goto err; - if (strcmp(attr_name, "key1") == 0) - { - hints->Length = 255; - hints->VisualLength = 32; - hints->FriendlyName = check_ptr(nmSysStrdup("Key 1")); /* Failure ignored. */ - goto success; - } - if (strcmp(attr_name, "key2") == 0) - { - hints->Length = 255; - hints->VisualLength = 32; - hints->FriendlyName = check_ptr(nmSysStrdup("Key 2")); /* Failure ignored. */ - goto success; - } - if (strcmp(attr_name, "sim") == 0) - { - /** Min and max values. **/ - hints->MinValue = expCompileExpression("0.0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); - hints->MaxValue = expCompileExpression("1.0", tmp_list, MLX_F_ICASE | MLX_F_FILENAMES, 0); - - /** Other hints. **/ - hints->Length = 16; - hints->VisualLength = 8; - hints->FriendlyName = check_ptr(nmSysStrdup("Similarity")); /* Failure ignored. */ - goto success; - } - break; + default: + mssErrorf(1, "Cluster", "Unknown target type %u.", driver_data->TargetType); + goto err_free; } - default: - mssErrorf(1, "Cluster", "Unknown target type %u.", driver_data->TargetType); - goto err; - } - - /** Unknown attribute. **/ + /** Unknown attribute. **/ unknown_attribute:; - char* name; - check(clusterGetAttrValue(inf_v, "name", DATA_T_STRING, POD(&name), NULL)); /* Failure ignored. */ - mssErrorf(1, "Cluster", - "Unknown attribute '%s' for cluster object %s (target type: %u, \"%s\").", - attr_name, driver_data->NodeData->SourceData->Name, driver_data->TargetType, name - ); - - /** Error cleanup. **/ - err: - if (tmp_list != NULL) check(expFreeParamList(tmp_list)); /* Failure ignored. */ - if (hints != NULL) nmFree(hints, sizeof(ObjPresentationHints)); - mssErrorf(0, "Cluster", "Failed execute generate presentation hints."); - return NULL; + mssErrorf(1, "Cluster", "Unknown attribute '%s'.", attr_name); + + /** Error cleanup. **/ + err_free: + if (hints != NULL) nmFree(hints, sizeof(ObjPresentationHints)); + hints = NULL; + + /** Construct the clearest error message that we can. **/ + char* name = NULL; + char* internal_type = NULL; + check(clusterGetAttrValue(inf_v, "name", DATA_T_STRING, POD(&name), NULL)); /* Failure ignored. */ + check(clusterGetAttrValue(inf_v, "internal_type", DATA_T_STRING, POD(&internal_type), NULL)); /* Failure ignored. */ + mssErrorf(0, "Cluster", + "Failed to get presentation hints for object '%s' : \"%s\".", + name, internal_type + ); + + end: + if (tmp_list != NULL) check(expFreeParamList(tmp_list)); /* Failure ignored. */ - /** Success. **/ - success: - check(expFreeParamList(tmp_list)); /* Failure ignored. */ return hints; } @@ -3928,7 +4050,9 @@ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pOb char* clusterGetFirstAttr(void* inf_v, pObjTrxTree* oxt) { pDriverData driver_data = (pDriverData)inf_v; - driver_data->TargetAttrIndex = 0u; + + driver_data->TargetAttrIndex = 0u; + return clusterGetNextAttr(inf_v, oxt); } @@ -3946,18 +4070,19 @@ char* clusterGetFirstAttr(void* inf_v, pObjTrxTree* oxt) char* clusterGetNextAttr(void* inf_v, pObjTrxTree* oxt) { pDriverData driver_data = (pDriverData)inf_v; - const unsigned int i = driver_data->TargetAttrIndex++; - switch (driver_data->TargetType) - { - case TARGET_ROOT: return ATTR_ROOT[i]; - case TARGET_CLUSTER: return ATTR_CLUSTER[i]; - case TARGET_SEARCH: return ATTR_SEARCH[i]; - case TARGET_CLUSTER_ENTRY: return ATTR_CLUSTER_ENTRY[i]; - case TARGET_SEARCH_ENTRY: return ATTR_SEARCH_ENTRY[i]; - default: - mssErrorf(1, "Cluster", "Unknown target type %u.", driver_data->TargetType); - return NULL; - } + + const unsigned int i = driver_data->TargetAttrIndex++; + switch (driver_data->TargetType) + { + case TARGET_NODE: return ATTR_ROOT[i]; + case TARGET_CLUSTER: return ATTR_CLUSTER[i]; + case TARGET_SEARCH: return ATTR_SEARCH[i]; + case TARGET_CLUSTER_ENTRY: return ATTR_CLUSTER_ENTRY[i]; + case TARGET_SEARCH_ENTRY: return ATTR_SEARCH_ENTRY[i]; + default: + mssErrorf(1, "Cluster", "Unknown target type %u.", driver_data->TargetType); + return NULL; + } } @@ -3974,71 +4099,71 @@ int clusterInfo(void* inf_v, pObjectInfo info) pDriverData driver_data = (pDriverData)inf_v; pNodeData node_data = (pNodeData)driver_data->NodeData; - /** Reset flags buffer. **/ - info->Flags = 0; - - /** Disallow unsupported functionality. **/ - info->Flags |= OBJ_INFO_F_CANT_ADD_ATTR; - info->Flags |= OBJ_INFO_F_CANT_HAVE_CONTENT; - info->Flags |= OBJ_INFO_F_NO_CONTENT; - - switch (driver_data->TargetType) - { - case TARGET_ROOT: - info->nSubobjects = node_data->nClusterDatas + node_data->nSearchDatas; - info->Flags |= OBJ_INFO_F_CAN_HAVE_SUBOBJ; - info->Flags |= OBJ_INFO_F_SUBOBJ_CNT_KNOWN; - info->Flags |= (info->nSubobjects > 0) ? OBJ_INFO_F_HAS_SUBOBJ : OBJ_INFO_F_NO_SUBOBJ; - break; - - case TARGET_CLUSTER: - info->Flags |= OBJ_INFO_F_CAN_HAVE_SUBOBJ; - info->Flags |= OBJ_INFO_F_HAS_SUBOBJ; /* Data must not be empty. */ - - /*** Clusters always have one label per vector. - *** If we know how many vectors are in the dataset, - *** we know how many labels this cluster will have, - *** even if it hasn't been computed yet. - ***/ - if (node_data->SourceData->Vectors != NULL) - { - info->Flags |= OBJ_INFO_F_SUBOBJ_CNT_KNOWN; - info->nSubobjects = node_data->SourceData->nVectors; - } - break; + /** Reset flags buffer. **/ + info->Flags = 0; + + /** Disallow unsupported functionality. **/ + info->Flags |= OBJ_INFO_F_CANT_ADD_ATTR; + info->Flags |= OBJ_INFO_F_CANT_HAVE_CONTENT; + info->Flags |= OBJ_INFO_F_NO_CONTENT; - case TARGET_SEARCH: + switch (driver_data->TargetType) { - pSearchData search_data = (pSearchData)driver_data->TargetData; - info->Flags |= OBJ_INFO_F_CAN_HAVE_SUBOBJ; - if (search_data->Dups != NULL) - { - info->nSubobjects = search_data->nDups; + case TARGET_NODE: + info->nSubobjects = node_data->nClusterDatas + node_data->nSearchDatas; + info->Flags |= OBJ_INFO_F_CAN_HAVE_SUBOBJ; info->Flags |= OBJ_INFO_F_SUBOBJ_CNT_KNOWN; info->Flags |= (info->nSubobjects > 0) ? OBJ_INFO_F_HAS_SUBOBJ : OBJ_INFO_F_NO_SUBOBJ; + break; + + case TARGET_CLUSTER: + info->Flags |= OBJ_INFO_F_CAN_HAVE_SUBOBJ; + info->Flags |= OBJ_INFO_F_HAS_SUBOBJ; /* Data must not be empty. */ + + /*** Clusters always have one label per vector. + *** If we know how many vectors are in the dataset, + *** we know how many labels this cluster will have, + *** even if it hasn't been computed yet. + ***/ + if (node_data->SourceData->Vectors != NULL) + { + info->Flags |= OBJ_INFO_F_SUBOBJ_CNT_KNOWN; + info->nSubobjects = node_data->SourceData->nVectors; + } + break; + + case TARGET_SEARCH: + { + pSearchData search_data = (pSearchData)driver_data->TargetData; + info->Flags |= OBJ_INFO_F_CAN_HAVE_SUBOBJ; + if (search_data->Dups != NULL) + { + info->nSubobjects = search_data->nDups; + info->Flags |= OBJ_INFO_F_SUBOBJ_CNT_KNOWN; + info->Flags |= (info->nSubobjects > 0) ? OBJ_INFO_F_HAS_SUBOBJ : OBJ_INFO_F_NO_SUBOBJ; + } + break; } - break; + + case TARGET_CLUSTER_ENTRY: + case TARGET_SEARCH_ENTRY: + /** No Subobjects. **/ + info->Flags |= OBJ_INFO_F_CANT_HAVE_SUBOBJ; + info->Flags |= OBJ_INFO_F_NO_SUBOBJ; + info->Flags |= OBJ_INFO_F_SUBOBJ_CNT_KNOWN; + info->nSubobjects = 0; + break; + + default: + mssErrorf(1, "Cluster", "Unknown target type %u.", driver_data->TargetType); + goto err; } - case TARGET_CLUSTER_ENTRY: - case TARGET_SEARCH_ENTRY: - /** No Subobjects. **/ - info->Flags |= OBJ_INFO_F_CANT_HAVE_SUBOBJ; - info->Flags |= OBJ_INFO_F_NO_SUBOBJ; - info->Flags |= OBJ_INFO_F_SUBOBJ_CNT_KNOWN; - info->nSubobjects = 0; - break; + return 0; - default: - mssErrorf(1, "Cluster", "Unknown target type %u.", driver_data->TargetType); - goto err; - } - - return 0; - err: - mssErrorf(0, "Cluster", "Failed execute get info."); - return -1; + mssErrorf(0, "Cluster", "Failed execute get info."); + return -1; } @@ -4058,7 +4183,9 @@ int clusterInfo(void* inf_v, pObjectInfo info) char* clusterGetFirstMethod(void* inf_v, pObjTrxTree* oxt) { pDriverData driver_data = (pDriverData)inf_v; - driver_data->TargetMethodIndex = 0u; + + driver_data->TargetMethodIndex = 0u; + return clusterGetNextMethod(inf_v, oxt); } @@ -4076,7 +4203,8 @@ char* clusterGetFirstMethod(void* inf_v, pObjTrxTree* oxt) char* clusterGetNextMethod(void* inf_v, pObjTrxTree* oxt) { pDriverData driver_data = (pDriverData)inf_v; - return METHOD_NAME[driver_data->TargetMethodIndex++]; + + return METHOD_NAMES[driver_data->TargetMethodIndex++]; } @@ -4084,90 +4212,89 @@ char* clusterGetNextMethod(void* inf_v, pObjTrxTree* oxt) /** Intended for use in xhForEach(). **/ static int ci_PrintEntry(pXHashEntry entry, void* arg) { - /** Extract entry. **/ - char* key = entry->Key; - void* data = entry->Data; - - /** Extract args. **/ - void** args = (void**)arg; - unsigned int* type_id_ptr = (unsigned int*)args[0]; - unsigned int* total_bytes_ptr = (unsigned int*)args[1]; - unsigned long long* less_ptr = (unsigned long long*)args[2]; - char* path = (char*)args[3]; - - /** If a path is provided, check that it matches the start of the key. **/ - if (path != NULL && strncmp(key, (char*)path, strlen((char*)path)) != 0) return 0; - - /** Handle type. **/ - char* type; - char* name; - unsigned int bytes; - switch (*type_id_ptr) - { - case 1u: - { - pSourceData source_data = (pSourceData)data; - - /** Compute size. **/ - bytes = ci_SizeOfSourceData(source_data); - - /** If less is specified, skip uncomputed source. **/ - if (*less_ptr > 0llu && source_data->Vectors == NULL) goto no_print; - - /** Compute printing information. **/ - type = "Source"; - name = source_data->Name; - break; - } - case 2u: - { - pClusterData cluster_data = (pClusterData)data; - - /** Compute size. **/ - bytes = ci_SizeOfClusterData(cluster_data, false); - - /** If less is specified, skip uncomputed source. **/ - if (*less_ptr > 0llu && cluster_data->Clusters == NULL) goto no_print; - - /** Compute printing information. **/ - type = "Cluster"; - name = cluster_data->Name; - break; - } - case 3u: + /** Extract entry. **/ + char* key = entry->Key; + void* data = entry->Data; + + /** Extract args. **/ + void** args = (void**)arg; + unsigned int* type_id_ptr = (unsigned int*)args[0]; + unsigned int* total_bytes_ptr = (unsigned int*)args[1]; + unsigned long long* less_ptr = (unsigned long long*)args[2]; + char* path = (char*)args[3]; + + /** If a path is provided, check that it matches the start of the key. **/ + if (path != NULL && strncmp(key, (char*)path, strlen((char*)path)) != 0) return 0; + + /** Handle type. **/ + char* type; + char* name; + unsigned int bytes; + switch (*type_id_ptr) { - pSearchData search_data = (pSearchData)data; - - /** Compute size. **/ - bytes = ci_SizeOfSearchData(search_data); - - /** If less is specified, skip uncomputed source. **/ - if (*less_ptr > 0llu && search_data->Dups == NULL) goto no_print; - - /** Compute printing information. **/ - type = "Search"; - name = search_data->Name; - break; + case 1u: + { + pSourceData source_data = (pSourceData)data; + + /** Compute size. **/ + bytes = ci_SizeOfSourceData(source_data); + + /** If less is specified, skip uncomputed source. **/ + if (*less_ptr > 0llu && source_data->Vectors == NULL) goto no_print; + + /** Compute printing information. **/ + type = "Source"; + name = source_data->Name; + break; + } + case 2u: + { + pClusterData cluster_data = (pClusterData)data; + + /** Compute size. **/ + bytes = ci_SizeOfClusterData(cluster_data, false); + + /** If less is specified, skip uncomputed source. **/ + if (*less_ptr > 0llu && cluster_data->Clusters == NULL) goto no_print; + + /** Compute printing information. **/ + type = "Cluster"; + name = cluster_data->Name; + break; + } + case 3u: + { + pSearchData search_data = (pSearchData)data; + + /** Compute size. **/ + bytes = ci_SizeOfSearchData(search_data); + + /** If less is specified, skip uncomputed source. **/ + if (*less_ptr > 0llu && search_data->Dups == NULL) goto no_print; + + /** Compute printing information. **/ + type = "Search"; + name = search_data->Name; + break; + } + default: + mssErrorf(0, "Cluster", "Unknown type_id %u.", *type_id_ptr); + return -1; } - default: - mssErrorf(0, "Cluster", "Unknown type_id %u.", *type_id_ptr); - return -1; - } - - - /** Print the cache entry data. **/ - char buf[12]; - snprint_bytes(buf, sizeof(buf), bytes); - printf("%-8s %-16s %-12s \"%s\"\n", type, name, buf, key); - + + /** Print the cache entry data. **/ + char buf[12]; + snprint_bytes(buf, sizeof(buf), bytes); + printf("%-8s %-16s %-12s \"%s\"\n", type, name, buf, key); + goto increment_total; + + no_print: + (*less_ptr)++; + increment_total: - *total_bytes_ptr += bytes; + *total_bytes_ptr += bytes; return 0; - - no_print: - (*less_ptr)++; - goto increment_total; } @@ -4175,16 +4302,16 @@ static int ci_PrintEntry(pXHashEntry entry, void* arg) /** Intended for use in xhClearKeySafe(). **/ static void ci_CacheFreeSourceData(pXHashEntry entry, void* path) { - /** Extract hash entry. **/ - char* key = entry->Key; - pSourceData source_data = (pSourceData)entry->Data; - - /** If a path is provided, check that it matches the start of the key. **/ - if (path != NULL && strncmp(key, (char*)path, strlen((char*)path)) != 0) return; - - /** Free data. **/ - ci_FreeSourceData(source_data); - nmSysFree(key); + /** Extract hash entry. **/ + char* key = entry->Key; + pSourceData source_data = (pSourceData)entry->Data; + + /** If a path is provided, check that it matches the start of the key. **/ + if (path != NULL && strncmp(key, (char*)path, strlen((char*)path)) != 0) return; + + /** Free data. **/ + ci_FreeSourceData(source_data); + nmSysFree(key); } @@ -4192,16 +4319,16 @@ static void ci_CacheFreeSourceData(pXHashEntry entry, void* path) /** Intended for use in xhClearKeySafe(). **/ static void ci_CacheFreeCluster(pXHashEntry entry, void* path) { - /** Extract hash entry. **/ - char* key = entry->Key; - pClusterData cluster_data = (pClusterData)entry->Data; - - /** If a path is provided, check that it matches the start of the key. **/ - if (path != NULL && strncmp(key, (char*)path, strlen((char*)path)) != 0) return; - - /** Free data. **/ - ci_FreeClusterData(cluster_data, false); - nmSysFree(key); + /** Extract hash entry. **/ + char* key = entry->Key; + pClusterData cluster_data = (pClusterData)entry->Data; + + /** If a path is provided, check that it matches the start of the key. **/ + if (path != NULL && strncmp(key, (char*)path, strlen((char*)path)) != 0) return; + + /** Free data. **/ + ci_FreeClusterData(cluster_data, false); + nmSysFree(key); } @@ -4209,16 +4336,16 @@ static void ci_CacheFreeCluster(pXHashEntry entry, void* path) /** Intended for use in xhClearKeySafe(). **/ static void ci_CacheFreeSearch(pXHashEntry entry, void* path) { - /** Extract hash entry. **/ - char* key = entry->Key; - pSearchData search_data = (pSearchData)entry->Data; - - /** If a path is provided, check that it matches the start of the key. **/ - if (path != NULL && strncmp(key, (char*)path, strlen((char*)path)) != 0) return; - - /** Free data. **/ - ci_FreeSearchData(search_data); - nmSysFree(key); + /** Extract hash entry. **/ + char* key = entry->Key; + pSearchData search_data = (pSearchData)entry->Data; + + /** If a path is provided, check that it matches the start of the key. **/ + if (path != NULL && strncmp(key, (char*)path, strlen((char*)path)) != 0) return; + + /** Free data. **/ + ci_FreeSearchData(search_data); + nmSysFree(key); } @@ -4234,128 +4361,133 @@ int clusterExecuteMethod(void* inf_v, char* method_name, pObjData param, pObjTrx { pDriverData driver_data = (pDriverData)inf_v; - /** Cache management method. **/ - if (strcmp(method_name, "cache") == 0) - { - char* path = NULL; - - /** Second parameter is required. **/ - if (param->String == NULL) - { - mssErrorf(1, "Cluster", - "[param : \"show\" | \"show_less\" | \"show_all\" | \"drop_all\"] is required for the cache method." - ); - goto err; - } - - /** 'show' and 'show_all'. **/ - bool show = false; - unsigned long long skip_uncomputed = 0llu; - if (strcmp(param->String, "show_less") == 0) - /** Specify show_less to skip uncomputed caches. **/ - skip_uncomputed = 1ull; - if (skip_uncomputed == 1ull || strcmp(param->String, "show") == 0) - { - show = true; - path = ci_file_path(driver_data->NodeData->Parent); - } - if (strcmp(param->String, "show_all") == 0) show = true; - - if (show) + /** Cache management method. **/ + if (strcmp(method_name, "cache") == 0) { - /** Print cache info table. **/ - int ret = 0; - unsigned int i = 1u, source_bytes = 0u, cluster_bytes = 0u, search_bytes = 0u; - bool failed = false; - printf("\nShowing cache for "); - if (path != NULL) printf("\"%s\":\n", path); - else printf("all files:\n"); - printf("%-8s %-16s %-12s %s\n", "Type", "Name", "Size", "Cache Entry Key"); - failed |= !check(xhForEach( - &ClusterDriverCaches.SourceDataCache, - ci_PrintEntry, - (void*[]){&i, &source_bytes, (void*)&skip_uncomputed, path} - )); - i++; - failed |= !check(xhForEach( - &ClusterDriverCaches.ClusterDataCache, - ci_PrintEntry, - (void*[]){&i, &cluster_bytes, (void*)&skip_uncomputed, path} - )); - i++; - failed |= !check(xhForEach( - &ClusterDriverCaches.SearchDataCache, - ci_PrintEntry, - (void*[]){&i, &search_bytes, (void*)&skip_uncomputed, path} - )); - if (failed) + char* path = NULL; + + /** Second parameter is required. **/ + if (param->String == NULL) + { + mssErrorf(1, "Cluster", + "[param : \"show\" | \"show_less\" | \"show_all\" | \"drop_all\"] is required for the cache method." + ); + goto err; + } + + /** 'show' and 'show_all'. **/ + bool show = false; + unsigned long long skip_uncomputed = 0llu; + if (strcmp(param->String, "show_less") == 0) + /** Specify show_less to skip uncomputed caches. **/ + skip_uncomputed = 1ull; + if (skip_uncomputed == 1ull || strcmp(param->String, "show") == 0) { - mssErrorf(0, "Cluster", "Unexpected error occurred while showhing caches."); - ret = -1; + show = true; + path = ci_file_path(driver_data->NodeData->Parent); } - - /** Precomputations. **/ - unsigned int total_caches = 0u - + (unsigned int)ClusterDriverCaches.SourceDataCache.nItems - + (unsigned int)ClusterDriverCaches.ClusterDataCache.nItems - + (unsigned int)ClusterDriverCaches.SearchDataCache.nItems; - if (total_caches <= skip_uncomputed) printf("All caches skipped, nothing to show...\n"); + if (strcmp(param->String, "show_all") == 0) show = true; - /** Print stats. **/ - char buf[16]; - printf("\nCache Stats:\n"); - printf("%-8s %-4s %-12s\n", "", "#", "Total Size"); - printf("%-8s %-4d %-12s\n", "Source", ClusterDriverCaches.SourceDataCache.nItems, snprint_bytes(buf, sizeof(buf), source_bytes)); - printf("%-8s %-4d %-12s\n", "Cluster", ClusterDriverCaches.ClusterDataCache.nItems, snprint_bytes(buf, sizeof(buf), cluster_bytes)); - printf("%-8s %-4d %-12s\n", "Search", ClusterDriverCaches.SearchDataCache.nItems, snprint_bytes(buf, sizeof(buf), search_bytes)); - printf("%-8s %-4d %-12s\n\n", "Total", total_caches, snprint_bytes(buf, sizeof(buf), source_bytes + cluster_bytes + search_bytes)); + if (show) + { + /** Print cache info table. **/ + int ret = 0; + unsigned int i = 1u, source_bytes = 0u, cluster_bytes = 0u, search_bytes = 0u; + bool failed = false; + printf("\nShowing cache for "); + if (path != NULL) printf("\"%s\":\n", path); + else printf("all files:\n"); + printf("%-8s %-16s %-12s %s\n", "Type", "Name", "Size", "Cache Entry Key"); + failed |= !check(xhForEach( + &ClusterDriverCaches.SourceDataCache, + ci_PrintEntry, + (void*[]){&i, &source_bytes, (void*)&skip_uncomputed, path} + )); + i++; + failed |= !check(xhForEach( + &ClusterDriverCaches.ClusterDataCache, + ci_PrintEntry, + (void*[]){&i, &cluster_bytes, (void*)&skip_uncomputed, path} + )); + i++; + failed |= !check(xhForEach( + &ClusterDriverCaches.SearchDataCache, + ci_PrintEntry, + (void*[]){&i, &search_bytes, (void*)&skip_uncomputed, path} + )); + if (failed) + { + mssErrorf(0, "Cluster", "Unexpected error occurred while showhing caches."); + ret = -1; + } + + /** Precomputations. **/ + unsigned int total_caches = 0u + + (unsigned int)ClusterDriverCaches.SourceDataCache.nItems + + (unsigned int)ClusterDriverCaches.ClusterDataCache.nItems + + (unsigned int)ClusterDriverCaches.SearchDataCache.nItems; + if (total_caches <= skip_uncomputed) printf("All caches skipped, nothing to show...\n"); + + /** Print stats. **/ + char buf[16]; + printf("\nCache Stats:\n"); + printf("%-8s %-4s %-12s\n", "", "#", "Total Size"); + printf("%-8s %-4d %-12s\n", "Source", ClusterDriverCaches.SourceDataCache.nItems, snprint_bytes(buf, sizeof(buf), source_bytes)); + printf("%-8s %-4d %-12s\n", "Cluster", ClusterDriverCaches.ClusterDataCache.nItems, snprint_bytes(buf, sizeof(buf), cluster_bytes)); + printf("%-8s %-4d %-12s\n", "Search", ClusterDriverCaches.SearchDataCache.nItems, snprint_bytes(buf, sizeof(buf), search_bytes)); + printf("%-8s %-4d %-12s\n\n", "Total", total_caches, snprint_bytes(buf, sizeof(buf), source_bytes + cluster_bytes + search_bytes)); + + /** Print skip stats (if anything was skipped.) **/ + if (skip_uncomputed > 0llu) printf("Skipped %llu uncomputed caches.\n\n", skip_uncomputed - 1llu); + + return ret; + } - /** Print skip stats (if anything was skipped.) **/ - if (skip_uncomputed > 0llu) printf("Skipped %llu uncomputed caches.\n\n", skip_uncomputed - 1llu); + /** 'drop_all'. **/ + if (strcmp(param->String, "drop_all") == 0) + { + printf("\nDropping cache for all files:\n"); + ci_ClearCaches(); + return 0; + } - return ret; + /** Unknown parameter. **/ + mssErrorf(1, "Cluster", + "Expected [param : \"show\" | \"show_less\" | \"show_all\" | \"drop_all\"] for the cache method, but got: \"%s\"", + param->String + ); + goto err; } - /** 'drop_all'. **/ - if (strcmp(param->String, "drop_all") == 0) + if (strcmp(method_name, "stat") == 0) { - printf("\nDropping cache for all files:\n"); - ci_ClearCaches(); + char buf[12]; + printf("Cluster Driver Statistics:\n"); + printf(" Stat Name %12s\n", "Value"); + printf(" OpenCalls %12s\n", snprint_commas_llu(buf, sizeof(buf), ClusterStatistics.OpenCalls)); + printf(" OpenQueryCalls %12s\n", snprint_commas_llu(buf, sizeof(buf), ClusterStatistics.OpenQueryCalls)); + printf(" FetchCalls %12s\n", snprint_commas_llu(buf, sizeof(buf), ClusterStatistics.FetchCalls)); + printf(" CloseCalls %12s\n", snprint_commas_llu(buf, sizeof(buf), ClusterStatistics.CloseCalls)); + printf(" GetTypeCalls %12s\n", snprint_commas_llu(buf, sizeof(buf), ClusterStatistics.GetTypeCalls)); + printf(" GetValCalls %12s\n", snprint_commas_llu(buf, sizeof(buf), ClusterStatistics.GetValCalls)); + printf(" GetValCalls_name %12s\n", snprint_commas_llu(buf, sizeof(buf), ClusterStatistics.GetValCalls_name)); + printf(" GetValCalls_key1 %12s\n", snprint_commas_llu(buf, sizeof(buf), ClusterStatistics.GetValCalls_key1)); + printf(" GetValCalls_key2 %12s\n", snprint_commas_llu(buf, sizeof(buf), ClusterStatistics.GetValCalls_key2)); + printf(" GetValCalls_sim %12s\n", snprint_commas_llu(buf, sizeof(buf), ClusterStatistics.GetValCalls_sim)); + printf("\n"); + + nmStats(); + return 0; } - - /** Unknown parameter. **/ - mssErrorf(1, "Cluster", - "Expected [param : \"show\" | \"show_less\" | \"show_all\" | \"drop_all\"] for the cache method, but got: \"%s\"", - param->String - ); - goto err; - } - - if (strcmp(method_name, "stat") == 0) - { - char buf[12]; - printf("Cluster Driver Statistics:\n"); - printf(" Stat Name %12s\n", "Value"); - printf(" OpenCalls %12s\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.OpenCalls)); - printf(" OpenQueryCalls %12s\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.OpenQueryCalls)); - printf(" FetchCalls %12s\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.FetchCalls)); - printf(" CloseCalls %12s\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.CloseCalls)); - printf(" GetTypeCalls %12s\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.GetTypeCalls)); - printf(" GetValCalls %12s\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.GetValCalls)); - printf(" GetValCalls_name %12s\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.GetValCalls_name)); - printf(" GetValCalls_key1 %12s\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.GetValCalls_key1)); - printf(" GetValCalls_key2 %12s\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.GetValCalls_key2)); - printf(" GetValCalls_sim %12s\n", snprint_llu(buf, sizeof(buf), ClusterStatistics.GetValCalls_sim)); - return 0; - } - - /** Unknown parameter. **/ - mssErrorf(1, "Cluster", "Unknown command: \"%s\"", method_name); + /** Unknown parameter. **/ + mssErrorf(1, "Cluster", "Unknown command: \"%s\"", method_name); + err: - mssErrorf(0, "Cluster", "Failed execute command."); - return -1; + mssErrorf(0, "Cluster", "Failed execute command."); + + return -1; } @@ -4366,56 +4498,65 @@ int clusterExecuteMethod(void* inf_v, char* method_name, pObjData param, pObjTrx /** Not implemented. **/ int clusterCreate(pObject obj, int mask, pContentType sys_type, char* usr_type, pObjTrxTree* oxt) { - mssErrorf(1, "Cluster", "clusterCreate() is not implemented."); + mssErrorf(1, "Cluster", "clusterCreate() is not implemented."); + return -ENOSYS; } /** Not implemented. **/ int clusterDelete(pObject obj, pObjTrxTree* oxt) { - mssErrorf(1, "Cluster", "clusterDelete() is not implemented."); + mssErrorf(1, "Cluster", "clusterDelete() is not implemented."); + return -1; } /** Not implemented. **/ int clusterDeleteObj(void* inf_v, pObjTrxTree* oxt) { - mssErrorf(1, "Cluster", "clusterDeleteObj() is not implemented."); + mssErrorf(1, "Cluster", "clusterDeleteObj() is not implemented."); + return -1; } /** Not implemented. **/ int clusterRead(void* inf_v, char* buffer, int max_cnt, int offset, int flags, pObjTrxTree* oxt) { - mssErrorf(1, "Cluster", "clusterRead() not implemented."); - fprintf(stderr, "HINT: Use queries instead, (e.g. clusterOpenQuery()).\n"); + mssErrorf(1, "Cluster", "clusterRead() not implemented."); + fprintf(stderr, "HINT: Use queries instead, (e.g. clusterOpenQuery()).\n"); + return -1; } /** Not implemented. **/ int clusterWrite(void* inf_v, char* buffer, int cnt, int offset, int flags, pObjTrxTree* oxt) { - mssErrorf(1, "Cluster", "clusterWrite() not implemented because clusters are imutable."); + mssErrorf(1, "Cluster", "clusterWrite() not implemented because clusters are imutable."); + return -1; } /** Not implemented. **/ int clusterSetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val, pObjTrxTree* oxt) { - mssErrorf(1, "Cluster", "clusterSetAttrValue() not implemented because clusters are imutable."); + mssErrorf(1, "Cluster", "clusterSetAttrValue() not implemented because clusters are imutable."); + return -1; } /** Not implemented. **/ int clusterAddAttr(void* inf_v, char* attr_name, int type, pObjData val, pObjTrxTree* oxt) { - mssErrorf(1, "Cluster", "clusterAddAttr() not implemented because clusters are imutable."); + mssErrorf(1, "Cluster", "clusterAddAttr() not implemented because clusters are imutable."); + return -1; } /** Not implemented. **/ void* clusterOpenAttr(void* inf_v, char* attr_name, int mode, pObjTrxTree* oxt) { - mssErrorf(1, "Cluster", "clusterOpenAttr() not implemented."); + mssErrorf(1, "Cluster", "clusterOpenAttr() not implemented."); + return NULL; } /** Not implemented. **/ int clusterCommit(void* inf_v, pObjTrxTree* oxt) { - mssErrorf(1, "Cluster", "clusterCommit() not implemented because clusters are imutable."); + mssErrorf(1, "Cluster", "clusterCommit() not implemented because clusters are imutable."); + return 0; } @@ -4431,74 +4572,83 @@ int clusterCommit(void* inf_v, pObjTrxTree* oxt) ***/ int clusterInitialize(void) { - /** Allocate the driver. **/ - pObjDriver drv = (pObjDriver)check_ptr(nmMalloc(sizeof(ObjDriver))); - if (drv == NULL) goto err; - memset(drv, 0, sizeof(ObjDriver)); - - /** Initialize caches. **/ - memset(&ClusterDriverCaches, 0, sizeof(ClusterDriverCaches)); - if (!check(xhInit(&ClusterDriverCaches.SourceDataCache, 251, 0))) goto err; - if (!check(xhInit(&ClusterDriverCaches.ClusterDataCache, 251, 0))) goto err; - if (!check(xhInit(&ClusterDriverCaches.SearchDataCache, 251, 0))) goto err; - - /** Initialize statistics. **/ - memset(&ClusterStatistics, 0, sizeof(ClusterStatistics)); - - /** Setup the structure. **/ - if (check_ptr(strcpy(drv->Name, "cluster - Clustering Driver")) == NULL) goto err; - if (!check(xaInit(&drv->RootContentTypes, 1))) goto err; - if (!check_neg(xaAddItem(&drv->RootContentTypes, "system/cluster"))) goto err; - drv->Capabilities = 0; /* TODO: Greg - Should I indicate any capabilities? */ - - /** Setup the function references. **/ - drv->Open = clusterOpen; - drv->OpenChild = NULL; - drv->Close = clusterClose; - drv->Create = clusterCreate; - drv->Delete = clusterDelete; - drv->DeleteObj = clusterDeleteObj; - drv->OpenQuery = clusterOpenQuery; - drv->QueryDelete = NULL; - drv->QueryFetch = clusterQueryFetch; - drv->QueryClose = clusterQueryClose; - drv->Read = clusterRead; - drv->Write = clusterWrite; - drv->GetAttrType = clusterGetAttrType; - drv->GetAttrValue = clusterGetAttrValue; - drv->GetFirstAttr = clusterGetFirstAttr; - drv->GetNextAttr = clusterGetNextAttr; - drv->SetAttrValue = clusterSetAttrValue; - drv->AddAttr = clusterAddAttr; - drv->OpenAttr = clusterOpenAttr; - drv->GetFirstMethod = clusterGetFirstMethod; - drv->GetNextMethod = clusterGetNextMethod; - drv->ExecuteMethod = clusterExecuteMethod; - drv->PresentationHints = clusterPresentationHints; - drv->Info = clusterInfo; - drv->Commit = clusterCommit; - drv->GetQueryCoverageMask = NULL; - drv->GetQueryIdentityPath = NULL; - - /** Register the driver. **/ - if (!check(objRegisterDriver(drv))) goto err; - - /** Register structs used in this project with the newmalloc memory management system. **/ - nmRegister(sizeof(SourceData), "ClusterSourceData"); - nmRegister(sizeof(Cluster), "Cluster"); - nmRegister(sizeof(ClusterData), "ClusterData"); - nmRegister(sizeof(SearchData), "ClusterSearch"); - nmRegister(sizeof(NodeData), "ClusterNodeData"); - nmRegister(sizeof(DriverData), "ClusterDriverData"); - nmRegister(sizeof(ClusterQuery), "ClusterQuery"); - nmRegister(sizeof(ClusterDriverCaches), "ClusterDriverCaches"); - - /** Success. **/ - return 0; - - /** Error cleanup. **/ - err: - if (drv != NULL) nmFree(drv, sizeof(ObjDriver)); - mssErrorf(1, "Cluster", "Failed to initialize cluster driver.\n"); - return -1; + /** Allocate the driver. **/ + pObjDriver drv = (pObjDriver)check_ptr(nmMalloc(sizeof(ObjDriver))); + if (drv == NULL) goto err_free; + memset(drv, 0, sizeof(ObjDriver)); + + /** Initialize caches. **/ + // memset(&ClusterDriverCaches, 0, sizeof(ClusterDriverCaches)); + if (!check(xhInit(&ClusterDriverCaches.SourceDataCache, 251, 0))) goto err_free; + if (!check(xhInit(&ClusterDriverCaches.ClusterDataCache, 251, 0))) goto err_free; + if (!check(xhInit(&ClusterDriverCaches.SearchDataCache, 251, 0))) goto err_free; + + /** Initialize statistics. **/ + memset(&ClusterStatistics, 0, sizeof(ClusterStatistics)); + + /** Setup the structure. **/ + if (check_ptr(strcpy(drv->Name, "cluster - Clustering Driver")) == NULL) goto err_free; + if (!check(xaInit(&drv->RootContentTypes, 1))) goto err_free; + if (!check_neg(xaAddItem(&drv->RootContentTypes, "system/cluster"))) goto err_free; + drv->Capabilities = 0; /* TODO: Greg - Should I indicate any capabilities? */ + + /** Setup the function references. **/ + drv->Open = clusterOpen; + drv->OpenChild = NULL; + drv->Close = clusterClose; + drv->Create = clusterCreate; + drv->Delete = clusterDelete; + drv->DeleteObj = clusterDeleteObj; + drv->OpenQuery = clusterOpenQuery; + drv->QueryDelete = NULL; + drv->QueryFetch = clusterQueryFetch; + drv->QueryClose = clusterQueryClose; + drv->Read = clusterRead; + drv->Write = clusterWrite; + drv->GetAttrType = clusterGetAttrType; + drv->GetAttrValue = clusterGetAttrValue; + drv->GetFirstAttr = clusterGetFirstAttr; + drv->GetNextAttr = clusterGetNextAttr; + drv->SetAttrValue = clusterSetAttrValue; + drv->AddAttr = clusterAddAttr; + drv->OpenAttr = clusterOpenAttr; + drv->GetFirstMethod = clusterGetFirstMethod; + drv->GetNextMethod = clusterGetNextMethod; + drv->ExecuteMethod = clusterExecuteMethod; + drv->PresentationHints = clusterPresentationHints; + drv->Info = clusterInfo; + drv->Commit = clusterCommit; + drv->GetQueryCoverageMask = NULL; + drv->GetQueryIdentityPath = NULL; + + /** Register the driver. **/ + if (!check(objRegisterDriver(drv))) goto err_free; + + /** Register structs used in this project with the newmalloc memory management system. **/ + nmRegister(sizeof(SourceData), "ClusterSourceData"); + nmRegister(sizeof(Cluster), "Cluster"); + nmRegister(sizeof(ClusterData), "ClusterData"); + nmRegister(sizeof(SearchData), "ClusterSearch"); + nmRegister(sizeof(NodeData), "ClusterNodeData"); + nmRegister(sizeof(DriverData), "ClusterDriverData"); + nmRegister(sizeof(ClusterQuery), "ClusterQuery"); + nmRegister(sizeof(ClusterDriverCaches), "ClusterDriverCaches"); + + /** Success. **/ + return 0; + + /** Error cleanup. **/ + err_free: + if (ClusterDriverCaches.SourceDataCache.nRows != 0) check(xhDeInit(&ClusterDriverCaches.SourceDataCache)); /* Failure ignored. **/ + if (ClusterDriverCaches.ClusterDataCache.nRows != 0) check(xhDeInit(&ClusterDriverCaches.ClusterDataCache)); /* Failure ignored. **/ + if (ClusterDriverCaches.SearchDataCache.nRows != 0) check(xhDeInit(&ClusterDriverCaches.SearchDataCache)); /* Failure ignored. **/ + if (drv != NULL) + { + if (drv->RootContentTypes.nAlloc != 0) check(xaDeInit(&drv->RootContentTypes)); /* Failure ignored. */ + nmFree(drv, sizeof(ObjDriver)); + } + + mssErrorf(1, "Cluster", "Failed to initialize cluster driver.\n"); + + return -1; } diff --git a/centrallix/test_obj.c b/centrallix/test_obj.c index 5ef492de3..355a89f41 100644 --- a/centrallix/test_obj.c +++ b/centrallix/test_obj.c @@ -767,7 +767,13 @@ testobj_do_cmd(pObjSession s, char* cmd, int batch_mode, pLxSession inp_lx) fdQPrintf(TESTOBJ.Output, "%[,%]%STR", i!=0, ptr); else { - while (strpbrk(ptr, "\r\n")) *(strpbrk(ptr, "\r\n")) = ' '; + char* cur; + while (1) + { + cur = strpbrk(ptr, "\r\n"); + if (cur == NULL) break; + else *cur = ' '; + } fdQPrintf(TESTOBJ.Output, "%[,%]\"%STR&DSYB\"", i!=0, ptr); } diff --git a/centrallix/tests/test_levenshtein_00.cmp b/centrallix/tests/test_levenshtein_00.cmp index 2a084162d..b95f2d44a 100644 --- a/centrallix/tests/test_levenshtein_00.cmp +++ b/centrallix/tests/test_levenshtein_00.cmp @@ -1,18 +1,18 @@ -Attribute [case1]: string "pass" -Attribute [case2]: string "pass" -Attribute [case3]: string "pass" -Attribute [case4]: string "pass" -Attribute [case5]: string "pass" -Attribute [case6]: string "pass" -Attribute [case7]: string "pass" -Attribute [case8]: string "pass" -Attribute [case9]: string "pass" -Attribute [case10]: string "pass" -Attribute [case11]: string "pass" -Attribute [case12]: string "pass" -Attribute [case13]: string "pass" -Attribute [case14]: string "pass" -Attribute [case15]: string "pass" -Attribute [case16]: string "pass" -Attribute [case17]: string "pass" -Attribute [case18]: string "pass" +Attribute [case1]: integer 0 +Attribute [case2]: integer 1 +Attribute [case3]: integer 1 +Attribute [case4]: integer 1 +Attribute [case5]: integer 2 +Attribute [case6]: integer 1 +Attribute [case7]: integer 1 +Attribute [case8]: integer 1 +Attribute [case9]: integer 1 +Attribute [case10]: integer 1 +Attribute [case11]: integer 2 +Attribute [case12]: integer 1 +Attribute [case13]: integer 1 +Attribute [case14]: integer 2 +Attribute [case15]: integer 0 +Attribute [case16]: integer 0 +Attribute [case17]: integer 133 +Attribute [case18]: integer 254 diff --git a/centrallix/tests/test_levenshtein_00.to b/centrallix/tests/test_levenshtein_00.to index 33f78e5f8..a92bdd743 100644 --- a/centrallix/tests/test_levenshtein_00.to +++ b/centrallix/tests/test_levenshtein_00.to @@ -1,25 +1,25 @@ -##NAME Levenshtein String Comparison +##NAME Levenshtein Basic Comparisons # Kitten tests. -query select case1 = condition(levenshtein('kitten', 'kitten') == 0, 'pass', 'fail') -- 0 edits -query select case2 = condition(levenshtein('kitten', 'skitten') == 1, 'pass', 'fail') -- 1 insert -query select case3 = condition(levenshtein('kitten', 'itten') == 1, 'pass', 'fail') -- 1 delete -query select case4 = condition(levenshtein('kitten', 'mitten') == 1, 'pass', 'fail') -- 1 replace -query select case5 = condition(levenshtein('kitten', 'smitten') == 2, 'pass', 'fail') -- 1 insert and one replace -query select case6 = condition(levenshtein('kitten', 'iktten') == 1, 'pass', 'fail') -- 1 transpose -query select case7 = condition(levenshtein('kitten', 'kittens') == 1, 'pass', 'fail') -- 1 insert (end) -query select case8 = condition(levenshtein('kitten', 'kitte') == 1, 'pass', 'fail') -- 1 delete (end) -query select case9 = condition(levenshtein('kitten', 'kittem') == 1, 'pass', 'fail') -- 1 replace (end) -query select case10 = condition(levenshtein('kitten', 'kittne') == 1, 'pass', 'fail') -- 1 transpose (end) +query select case1 = levenshtein('kitten', 'kitten') -- 0 edits +query select case2 = levenshtein('kitten', 'skitten') -- 1 insert +query select case3 = levenshtein('kitten', 'itten') -- 1 delete +query select case4 = levenshtein('kitten', 'mitten') -- 1 replace +query select case5 = levenshtein('kitten', 'smitten') -- 1 insert and 1 replace +query select case6 = levenshtein('kitten', 'iktten') -- 1 transpose +query select case7 = levenshtein('kitten', 'kittens') -- 1 insert (end) +query select case8 = levenshtein('kitten', 'kitte') -- 1 delete (end) +query select case9 = levenshtein('kitten', 'kittem') -- 1 replace (end) +query select case10 = levenshtein('kitten', 'kittne') -- 1 transpose (end) # Alternate words. -query select case11 = condition(levenshtein('lawn', 'flown') == 2, 'pass', 'fail') -- 1 insert and one replace -query select case12 = condition(levenshtein('hello', 'hello!') == 1, 'pass', 'fail') -- 1 insert (end) -query select case13 = condition(levenshtein('zert', 'zerf') == 1, 'pass', 'fail') -- 1 replace (end) -query select case14 = condition(levenshtein('llearr', 'lear') == 2, 'pass', 'fail') -- 2 deletes (start & end) +query select case11 = levenshtein('lawn', 'flown') -- 1 insert and 1 replace +query select case12 = levenshtein('hello', 'hello!') -- 1 insert (end) +query select case13 = levenshtein('zert', 'zerf') -- 1 replace (end) +query select case14 = levenshtein('llearr', 'lear') -- 2 deletes (start & end) # Edge cases. -query select case15 = condition(levenshtein('', '') == 0, 'pass', 'fail') -- 0 edits -query select case16 = condition(levenshtein('This is a very long string!! I do not expect this function to need to process a string longer than this, because this string is a full 254 characters. That is pretty long. The object system limits strings to this size so we cannot make a longer string...', 'This is a very long string!! I do not expect this function to need to process a string longer than this, because this string is a full 254 characters. That is pretty long. The object system limits strings to this size so we cannot make a longer string...') == 0, 'pass', 'fail') -- 0 edits. -query select case17 = condition(levenshtein('This is a very long string!! I do not expect this function to need to process a string longer than this, because this string is a full 254 characters. That is pretty long. The object system limits strings to this size so we cannot make a longer string...', 'This is quite a lengthy string. I do not expect the function to compute any longer string since this one is a full 254 characters. That is plenty, even if someone adds many contact details to their record!! Thus, this test should cover most cases we see.') == 133, 'pass', 'fail') -- 133 edits. -query select case18 = condition(levenshtein('AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA', 'BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB') == 254, 'pass', 'fail') -- 254 replaces. +query select case15 = levenshtein('', '') -- 0 edits +query select case16 = levenshtein('This is a very long string!! I do not expect this function to need to process a string longer than this, because this string is a full 254 characters. That is pretty long. The object system limits strings to this size so we cannot make a longer string...', 'This is a very long string!! I do not expect this function to need to process a string longer than this, because this string is a full 254 characters. That is pretty long. The object system limits strings to this size so we cannot make a longer string...') -- 0 edits. +query select case17 = levenshtein('This is a very long string!! I do not expect this function to need to process a string longer than this, because this string is a full 254 characters. That is pretty long. The object system limits strings to this size so we cannot make a longer string...', 'This is quite a lengthy string. I do not expect the function to compute any longer string since this one is a full 254 characters. That is plenty, even if someone adds many contact details to their record!! Thus, this test should cover most cases we see.') -- 133 edits. +query select case18 = levenshtein('AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA', 'BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB') -- 254 replaces. diff --git a/centrallix/utility/double_metaphone.c b/centrallix/utility/double_metaphone.c new file mode 100644 index 000000000..3faf27c3c --- /dev/null +++ b/centrallix/utility/double_metaphone.c @@ -0,0 +1,1545 @@ +/************************************************************************/ +/* Text-DoubleMetaphone */ +/* Centrallix Base Library */ +/* */ +/* Copyright 2000, Maurice Aubrey . */ +/* All rights reserved. */ +/* */ +/* This code is copied for redistribution with modification, from the */ +/* gitpan/Text-DoubleMetaphone implementation on GitHub (1), which is */ +/* under the following license. */ +/* */ +/* This code is based heavily on the C++ implementation by Lawrence */ +/* Philips and incorporates several bug fixes courtesy of Kevin */ +/* Atkinson . */ +/* */ +/* This module is free software; you may redistribute it and/or */ +/* modify it under the same terms as Perl itself. */ +/* */ +/* A summary of the relevant content from https://dev.perl.org/licenses */ +/* has been included below for the convenience of the reader. This */ +/* information was collected and saved on September 5th, 2025 and may */ +/* differ from current information. For the most up to date copy of */ +/* this information, please use the link provided above. */ +/* */ +/* Perl5 is Copyright © 1993 and later, by Larry Wall and others. */ +/* */ +/* It is free software; you can redistribute it and/or modify it */ +/* under the terms of either: */ +/* */ +/* a) the GNU General Public License (2) as published by the Free */ +/* Software Foundation (3); either version 1 (2), or (at your */ +/* option) any later version (4), or */ +/* */ +/* b) the "Artistic License" (5). */ +/* */ +/* Citations: */ +/* 1: https://github.com/gitpan/Text-meta_double_metaphone */ +/* 2: https://dev.perl.org/licenses/gpl1.html */ +/* 3: http://www.fsf.org */ +/* 4: http://www.fsf.org/licenses/licenses.html#GNUGPL */ +/* 5: https://dev.perl.org/licenses/artistic.html */ +/* */ +/* Centrallix is published under the GNU General Public License, */ +/* satisfying the above requirement. A summary of this is included */ +/* below for the convenience of the reader. */ +/* */ +/* This program is free software; you can redistribute it and/or modify */ +/* it under the terms of the GNU General Public License as published by */ +/* the Free Software Foundation; either version 2 of the License, or */ +/* (at your option) any later version. */ +/* */ +/* This program 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 General Public License for more details. */ +/* */ +/* You should have received a copy of the GNU General Public License */ +/* along with this program; if not, write to the Free Software */ +/* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA */ +/* 02111-1307 USA */ +/* */ +/* A copy of the GNU General Public License has been included in this */ +/* distribution in the file "COPYING". */ +/* */ +/* Module: double_metaphone.c, double_metaphone.h */ +/* Author: Maurice Aubrey and Israel Fuller */ +/* Description: This module implements a "sounds like" algorithm by */ +/* Lawrence Philips which he published in the June, 2000 */ +/* issue of C/C++ Users Journal. Double Metaphone is an */ +/* improved version of the original Metaphone algorithm */ +/* written by Philips'. This implementaton was written by */ +/* Maurice Aubrey for C/C++ with bug fixes provided by */ +/* Kevin Atkinson. It was revised by Israel Fuller to */ +/* better align with the Centrallix coding style and */ +/* standards so that it could be included here. */ +/************************************************************************/ + +/*** Note to future programmers reading this file (by Israel Fuller): + *** + *** This file was copied from a GitHub Repo with proper licensing (in case + *** you didn't read the legal stuff above), so feel free to check it out. + *** + *** As for this code, I've modified it to use styling and memory allocation + *** consistent with the rest of the Centrallix codebase. Also, I have added + *** documentation comments and extensive test cases (at the end of the file), + *** however, these reflect my own (possibly incorrect) understanding, which + *** might not line up with the original author. + *** + *** To be honest, though, trying to make this code as readable as possible + *** was very challenging due to all the messy boolean algebra. If there is + *** ever a professional linguist reading this, please factor out some of the + *** logic into local variables with descriptive names so that the rest of us + *** can read this code without our eyes glazing over. + *** + *** If you have any questions, please feel free to reach out to me or Greg. + *** + *** Original Source: https://github.com/gitpan/Text-meta_double_metaphone + ***/ + +#include +#include +#include +#include +#include +#include + +/*** If running in a testing environment, newmalloc is not + *** available, so we fall back to default C memory allocation. + ***/ +#ifndef TESTING +#include "cxlib/newmalloc.h" +#define META_MALLOC(size) nmSysMalloc(size) +#define META_REALLOC(ptr, size) nmSysRealloc(ptr, size) +#define META_FREE(ptr) nmSysFree(ptr) +#else +#include +#define META_MALLOC(size) malloc(size) +#define META_REALLOC(ptr, size) realloc(ptr, size) +#define META_FREE(ptr) free(ptr) +#endif + +/*** Helper function to handle checking for failed memory allocation + *** Author: Israel Fuller. + *** + *** @param ptr Pointer to the memory that should be allocated. + *** @param fname The name of the function invoked to allocate memory. + *** @param size The amount of memory being allocated. + *** @returns The pointer, for chaining. + ***/ +void* meta_check_allocation(void* ptr, const char* fname, const size_t size) + { + if (ptr == NULL) + { + /** Create the most descriptive error message we can. **/ + char error_buf[BUFSIZ]; + snprintf(error_buf, sizeof(error_buf), "exp_double_metaphone.c: Fail - %s(%lu)", fname, size); + perror(error_buf); + + // Throw error for easier locating in a debugger. + fprintf(stderr, "Program will now crash.\n"); + assert(0); + } + + return ptr; + } + +/** Malloc shortcut macros. **/ +#define SAFE_MALLOC(size) \ + ({ \ + const size_t sz = (size); \ + memset(meta_check_allocation(META_MALLOC(sz), "META_MALLOC", sz), 0, sz); \ + }) +#define SAFE_REALLOC(ptr, size) \ + ({ \ + const size_t sz = (size); \ + meta_check_allocation(META_REALLOC(ptr, sz), "META_REALLOC", sz); \ + }) + +typedef struct + { + char* str; + size_t length; + size_t bufsize; + int free_str_on_destroy; + } +MetaString; + +/*** Allocates a new MetaString. + *** + *** @param init_str The initial size of the string. + *** @returns The new MetaString. + ***/ +MetaString* meta_new_string(const char* init_str) + { + MetaString *s; + char empty_string[] = ""; + + s = (MetaString*)SAFE_MALLOC(sizeof(MetaString)); + + if (init_str == NULL) + init_str = empty_string; + + s->length = strlen(init_str); + /** Preallocate a bit more for potential growth. **/ + s->bufsize = s->length + 7u; + + s->str = (char*)SAFE_MALLOC(s->bufsize * sizeof(char)); + + strncpy(s->str, init_str, s->length + 1); + s->free_str_on_destroy = 1; + + return s; + } + +/*** Frees a MetaString. + *** + *** @param s The MetaString. + ***/ +void meta_destroy_string(MetaString* s) + { + if (s == NULL) + return; + + if (s->free_str_on_destroy && s->str != NULL) + META_FREE(s->str); + + META_FREE(s); + } + +/*** Increases a MetaString's buffer size. + *** + *** @param s The MetaString* being modified. + *** @param chars_needed Minimum number of characters to increase buffer size. + ***/ +void meta_increase_buffer(MetaString* s, const size_t chars_needed) + { + s->bufsize += chars_needed + 8u; + s->str = SAFE_REALLOC(s->str, s->bufsize * sizeof(char)); + } + +/*** Convert all characters of a MetaString to uppercase. + *** + *** @param s The MetaString being modified. + ***/ +void meta_make_upper(MetaString* s) + { + for (char* i = s->str; i[0] != '\0'; i++) + *i = (char)toupper(*i); + } + +/*** @param s The MetaString being checked. + *** @param pos The character location to check within the MetaString. + *** @returns 1 if the location is out of bounds for the MetaString, + *** 0 otherwise. + ***/ +bool meta_is_out_of_bounds(MetaString* s, unsigned int pos) + { + return (s->length <= pos); + } + +/*** Checks if a character in a MetaString is a vowel. + *** + *** @param s The MetaString being checked. + *** @param pos The character location to check within the MetaString. + ***/ +bool meta_is_vowel(MetaString* s, unsigned int pos) + { + if (meta_is_out_of_bounds(s, pos)) return 0; + + const char c = *(s->str + pos); + + return ((c == 'A') || (c == 'E') || (c == 'I') || + (c == 'O') || (c == 'U') || (c == 'Y')); + } + +/*** Search a MetaString for "W", "K", "CZ", or "WITZ", which indicate that the + *** string is Slavo Germanic. + *** + *** @param s The MetaString to be searched. + *** @returns 1 if the MetaString is Slavo Germanic, or 0 otherwise. + ***/ +bool meta_is_slavo_germanic(MetaString* s) + { + return (strstr(s->str, "W") != NULL) + || (strstr(s->str, "K") != NULL) + || (strstr(s->str, "CZ") != NULL) + || (strstr(s->str, "WITZ") != NULL); + } + +/*** @param s The MetaString being checked. + *** @param pos The character location to check within the MetaString. + *** @returns The character at the position in the MetaString, or + *** '\0' if the position is not in the MetaString. + ***/ +char meta_get_char_at(MetaString* s, unsigned int pos) + { + return (meta_is_out_of_bounds(s, pos)) ? '\0' : ((char) *(s->str + pos)); + } + +/*** Checks for to see if any of a list of strings appear in a the given + *** MetaString after the given start position. + *** + *** @attention - Note that the START value is 0 based. + *** + *** @param s The MetaString being modified. + *** @param start The zero-based start of at which to begin searching + *** within the MetaString. + *** @param length The length of the character strings being checked. + *** @returns 1 if any of the character sequences appear after the start + *** in the MetaString and 0 otherwise. + ***/ +bool meta_is_str_at(MetaString* s, unsigned int start, ...) + { + va_list ap; + + /** Should never happen. **/ + if (meta_is_out_of_bounds(s, start)) + return 0; + + const char* pos = (s->str + start); + va_start(ap, start); + + char* test; + do + { + test = va_arg(ap, char*); + if (*test && (strncmp(pos, test, strlen(test)) == 0)) + return true; + } + while (test[0] != '\0'); + + va_end(ap); + + return false; + } + +/*** Adds a string to a MetaString, expanding the MetaString if needed. + *** + *** @param s The MetaString being modified. + *** @param new_str The string being added. + ***/ +void meta_add_str(MetaString* s, const char* new_str) + { + if (new_str == NULL) + return; + + const size_t add_length = strlen(new_str); + if ((s->length + add_length) > (s->bufsize - 1)) + meta_increase_buffer(s, add_length); + + strcat(s->str, new_str); + s->length += add_length; + } + +/*** Computes double metaphone. + *** + *** Example Usage: + *** ```c + *** char* primary_code; + *** char* secondary_code; + *** meta_double_metaphone(input, &primary_code, &secondary_code); + *** ``` + *** + *** @param str The string to compute. + *** @param primary_code A pointer to a buffer where the pointer to a string + *** containing the produced primary code will be stored. + *** @param secondary_code A pointer to a buffer where the pointer to a string + *** containing the produced secondary code will be stored. + ***/ +void meta_double_metaphone(const char* str, char** primary_code, char** secondary_code) + { + size_t length; + + if (primary_code == NULL) + { + fprintf(stderr, "Warning: Call to meta_double_metaphone() is missing a pointer to store primary code.\n"); + return; + } + + if (secondary_code == NULL) + { + fprintf(stderr, "Warning: Call to meta_double_metaphone() is missing a pointer to store secondary code.\n"); + return; + } + + if (str == NULL || (length = strlen(str)) == 0u) + { + fprintf(stderr, "Warning: Call to meta_double_metaphone() with invalid string.\n"); + + /** Double Metaphone on an invalid string yields two empty strings. **/ + *primary_code = (char*)SAFE_MALLOC(sizeof(char)); + *secondary_code = (char*)SAFE_MALLOC(sizeof(char)); + return; + } + unsigned int current = 0; + unsigned int last = (unsigned int)(length - 1); + + /** Pad original so we can index beyond end. **/ + MetaString* original = meta_new_string(str); + meta_make_upper(original); + meta_add_str(original, " "); + + MetaString* primary = meta_new_string(""); + MetaString* secondary = meta_new_string(""); + primary->free_str_on_destroy = 0; + secondary->free_str_on_destroy = 0; + + /** Skip these if they are at start of a word. **/ + if (meta_is_str_at(original, 0, "GN", "KN", "PN", "WR", "PS", "")) + current += 1; + + /** Initial 'X' is pronounced 'Z' e.g. 'Xavier' **/ + const char first_char = meta_get_char_at(original, 0); + if (first_char == 'X') + { + meta_add_str(primary, "S"); /* 'Z' maps to 'S' */ + meta_add_str(secondary, "S"); + current += 1; + } + + /** Precomputing this is useful. **/ + const bool is_slavo_germanic = meta_is_slavo_germanic(original); + + /** Main loop. **/ + while (current < length) + { + const char cur_char = meta_get_char_at(original, current); + const char next_char = meta_get_char_at(original, current + 1); + switch (cur_char) + { + case 'A': + case 'E': + case 'I': + case 'O': + case 'U': + case 'Y': + { + if (current == 0) + { + /** All init vowels now map to 'A'. **/ + meta_add_str(primary, "A"); + meta_add_str(secondary, "A"); + } + current += 1; + break; + } + + case 'B': + { + /** "-mb", e.g", "dumb", already skipped over... **/ + meta_add_str(primary, "P"); + meta_add_str(secondary, "P"); + + current += (next_char == 'B') ? 2 : 1; + break; + } + + case 'C': + { + /** Various germanic. **/ + if ( + (current > 1) + && !meta_is_vowel(original, current - 2) + && meta_is_str_at(original, (current - 1), "ACH", "") + && meta_get_char_at(original, current + 2) != 'I' + && ( + meta_get_char_at(original, current + 2) != 'E' + || meta_is_str_at(original, (current - 2), "BACHER", "MACHER", "") + ) + ) + { + meta_add_str(primary, "K"); + meta_add_str(secondary, "K"); + current += 2; + break; + } + + /** Special case 'caesar' **/ + if (current == 0 && meta_is_str_at(original, current, "CAESAR", "")) + { + meta_add_str(primary, "S"); + meta_add_str(secondary, "S"); + current += 2; + break; + } + + /** Italian 'chianti' **/ + if (meta_is_str_at(original, current, "CHIA", "")) + { + meta_add_str(primary, "K"); + meta_add_str(secondary, "K"); + current += 2; + break; + } + + if (meta_is_str_at(original, current, "CH", "")) + { + /** Find 'michael' **/ + if (current > 0 && meta_is_str_at(original, current, "CHAE", "")) + { + meta_add_str(primary, "K"); + meta_add_str(secondary, "X"); + current += 2; + break; + } + + /** Greek roots e.g. 'chemistry', 'chorus' **/ + if ( + current == 0 + && meta_is_str_at(original, (current + 1), "HOR", "HYM", "HIA", "HEM", "HARAC", "HARIS", "") + && !meta_is_str_at(original, 0, "CHORE", "") + ) + { + meta_add_str(primary, "K"); + meta_add_str(secondary, "K"); + current += 2; + break; + } + + /** Germanic, greek, or otherwise 'ch' for 'kh' sound. */ + if ( + meta_is_str_at(original, 0, "SCH", "VAN ", "VON ", "") + /** 'architect but not 'arch', 'orchestra', 'orchid' **/ + || meta_is_str_at(original, (current - 2), "ORCHES", "ARCHIT", "ORCHID", "") + || meta_is_str_at(original, (current + 2), "T", "S", "") + || ( + (current == 0 || meta_is_str_at(original, (current - 1), "A", "O", "U", "E", "")) + /** e.g., 'wachtler', 'wechsler', but not 'tichner' **/ + && meta_is_str_at(original, (current + 2), "L", "R", "N", "M", "B", "H", "F", "V", "W", " ", "") + ) + ) + { + meta_add_str(primary, "K"); + meta_add_str(secondary, "K"); + } + else + { + if (current > 0) + { + if (meta_is_str_at(original, 0, "MC", "")) + { + /* e.g., "McHugh" */ + meta_add_str(primary, "K"); + meta_add_str(secondary, "K"); + } + else + { + meta_add_str(primary, "X"); + meta_add_str(secondary, "K"); + } + } + else + { + meta_add_str(primary, "X"); + meta_add_str(secondary, "X"); + } + } + current += 2; + break; + } + + /** e.g, 'czerny' **/ + if (meta_is_str_at(original, current, "CZ", "") + && !meta_is_str_at(original, (current - 2), "WICZ", "")) + { + meta_add_str(primary, "S"); + meta_add_str(secondary, "X"); + current += 2; + break; + } + + /** e.g., 'focaccia' **/ + if (meta_is_str_at(original, (current + 1), "CIA", "")) + { + meta_add_str(primary, "X"); + meta_add_str(secondary, "X"); + current += 3; + break; + } + + /** Double 'C' rule. **/ + if ( + meta_is_str_at(original, current, "CC", "") + && !(current == 1 && first_char == 'M') /* McClellan exception. */ + ) + { + /** 'bellocchio' but not 'bacchus' **/ + if ( + meta_is_str_at(original, (current + 2), "I", "E", "H", "") + && !meta_is_str_at(original, (current + 2), "HU", "") + ) + { + /** 'accident', 'accede' 'succeed' **/ + if ( + (current == 1 && meta_get_char_at(original, current - 1) == 'A') + || meta_is_str_at(original, (current - 1), "UCCEE", "UCCES", "") + ) + { + meta_add_str(primary, "KS"); + meta_add_str(secondary, "KS"); + /** 'bacci', 'bertucci', other italian **/ + } + else + { + meta_add_str(primary, "X"); + meta_add_str(secondary, "X"); + } + current += 3; + break; + } + else + { /** Pierce's rule **/ + meta_add_str(primary, "K"); + meta_add_str(secondary, "K"); + current += 2; + break; + } + } + + if (meta_is_str_at(original, current, "CK", "CG", "CQ", "")) + { + meta_add_str(primary, "K"); + meta_add_str(secondary, "K"); + current += 2; + break; + } + + if (meta_is_str_at(original, current, "CI", "CE", "CY", "")) + { + /* Italian vs. English */ + if (meta_is_str_at(original, current, "CIO", "CIE", "CIA", "")) + { + meta_add_str(primary, "S"); + meta_add_str(secondary, "X"); + } + else + { + meta_add_str(primary, "S"); + meta_add_str(secondary, "S"); + } + current += 2; + break; + } + + /** else **/ + meta_add_str(primary, "K"); + meta_add_str(secondary, "K"); + + /** Name sent in 'mac caffrey', 'mac gregor **/ + if (meta_is_str_at(original, (current + 1), " C", " Q", " G", "")) + current += 3; + else if (meta_is_str_at(original, (current + 1), "C", "K", "Q", "") + && !meta_is_str_at(original, (current + 1), "CE", "CI", "")) + current += 2; + else + current += 1; + break; + } + + case 'D': + { + if (meta_is_str_at(original, current, "DG", "")) + { + if (meta_is_str_at(original, (current + 2), "I", "E", "Y", "")) + { + /** e.g. 'edge' **/ + meta_add_str(primary, "J"); + meta_add_str(secondary, "J"); + current += 3; + break; + } + else + { + /** e.g. 'edgar' **/ + meta_add_str(primary, "TK"); + meta_add_str(secondary, "TK"); + current += 2; + break; + } + } + + if (meta_is_str_at(original, current, "DT", "DD", "")) + { + meta_add_str(primary, "T"); + meta_add_str(secondary, "T"); + current += 2; + break; + } + + /** else **/ + meta_add_str(primary, "T"); + meta_add_str(secondary, "T"); + current += 1; + break; + } + + case 'F': + { + current += (next_char == 'F') ? 2 : 1; + meta_add_str(primary, "F"); + meta_add_str(secondary, "F"); + break; + } + + case 'G': + { + if (next_char == 'H') + { + /** 'Vghee' */ + if (current > 0 && !meta_is_vowel(original, (current - 1))) + { + meta_add_str(primary, "K"); + meta_add_str(secondary, "K"); + current += 2; + break; + } + + if (current < 3) + { + /** 'ghislane', 'ghiradelli' **/ + if (current == 0) + { + if (meta_get_char_at(original, (current + 2)) == 'I') + { + meta_add_str(primary, "J"); + meta_add_str(secondary, "J"); + } + else + { + meta_add_str(primary, "K"); + meta_add_str(secondary, "K"); + } + current += 2; + break; + } + } + + if ( + /** Parker's rule (with some further refinements) - e.g., 'hugh' **/ + (current > 1 && meta_is_str_at(original, (current - 2), "B", "H", "D", "")) + /** e.g., 'bough' **/ + || (current > 2 && meta_is_str_at(original, (current - 3), "B", "H", "D", "")) + /** e.g., 'broughton' **/ + || (current > 3 && meta_is_str_at(original, (current - 4), "B", "H", "")) + ) + { + current += 2; + break; + } + else + { + /** e.g., 'laugh', 'McLaughlin', 'cough', 'gough', 'rough', 'tough' **/ + if ( + current > 2 + && meta_get_char_at(original, (current - 1)) == 'U' + && meta_is_str_at(original, (current - 3), "C", "G", "L", "R", "T", "") + ) + { + meta_add_str(primary, "F"); + meta_add_str(secondary, "F"); + } + else if (current > 0 && meta_get_char_at(original, (current - 1)) != 'I') + { + meta_add_str(primary, "K"); + meta_add_str(secondary, "K"); + } + + current += 2; + break; + } + } + + if (next_char == 'N') + { + if (current == 1 && !is_slavo_germanic && meta_is_vowel(original, 0)) + { + meta_add_str(primary, "KN"); + meta_add_str(secondary, "N"); + } + else + /** not e.g. 'cagney' **/ + if ( + next_char != 'Y' + && !is_slavo_germanic + && !meta_is_str_at(original, (current + 2), "EY", "") + ) + { + meta_add_str(primary, "N"); + meta_add_str(secondary, "KN"); + } + else + { + meta_add_str(primary, "KN"); + meta_add_str(secondary, "KN"); + } + current += 2; + break; + } + + /** 'tagliaro' **/ + if ( + !is_slavo_germanic + && meta_is_str_at(original, (current + 1), "LI", "") + ) + { + meta_add_str(primary, "KL"); + meta_add_str(secondary, "L"); + current += 2; + break; + } + + /** -ges-,-gep-,-gel-, -gie- at beginning **/ + if ( + current == 0 + && ( + next_char == 'Y' + || meta_is_str_at( + original, (current + 1), + "ES", "EP", "EB", "EL", "EY", "IB", + "IL", "IN", "IE", "EI", "ER", "" + ) + ) + ) + { + meta_add_str(primary, "K"); + meta_add_str(secondary, "J"); + current += 2; + break; + } + + /** -ger-, -gy- **/ + if ( + (next_char == 'Y' || meta_is_str_at(original, (current + 1), "ER", "")) + /** Exceptions. **/ + && !meta_is_str_at(original, 0, "DANGER", "RANGER", "MANGER", "") + && !meta_is_str_at(original, (current - 1), "E", "I", "RGY", "OGY", "") + ) + { + meta_add_str(primary, "K"); + meta_add_str(secondary, "J"); + current += 2; + break; + } + + /** Italian e.g, 'biaggi' **/ + if ( + meta_is_str_at(original, (current + 1), "E", "I", "Y", "") + || meta_is_str_at(original, (current - 1), "AGGI", "OGGI", "") + ) + { + /** Obvious germanic. **/ + if (meta_is_str_at(original, 0, "SCH", "VAN ", "VON ", "") + || meta_is_str_at(original, (current + 1), "ET", "")) + { + meta_add_str(primary, "K"); + meta_add_str(secondary, "K"); + } + else + { + /** Always soft, if french ending. **/ + if (meta_is_str_at(original, (current + 1), "IER ", "")) + { + meta_add_str(primary, "J"); + meta_add_str(secondary, "J"); + } + else + { + meta_add_str(primary, "J"); + meta_add_str(secondary, "K"); + } + } + current += 2; + break; + } + + current += (next_char == 'G') ? 2 : 1; + meta_add_str(primary, "K"); + meta_add_str(secondary, "K"); + break; + } + + case 'H': + { + /** Only keep if first & before vowel or between 2 vowels. **/ + if ( + (current == 0 || meta_is_vowel(original, (current - 1))) + && meta_is_vowel(original, current + 1) + ) + { + meta_add_str(primary, "H"); + meta_add_str(secondary, "H"); + current += 2; + } + else /* also takes care of 'HH' */ + current += 1; + break; + } + + case 'J': + { + /** Obvious spanish, 'jose', 'san jacinto' **/ + const bool has_jose_next = meta_is_str_at(original, current, "JOSE", ""); + const bool starts_with_san = meta_is_str_at(original, 0, "SAN ", ""); + if (has_jose_next || starts_with_san) + { + if ( + starts_with_san + /** I don't know what this condition means. **/ + || (current == 0 && meta_get_char_at(original, current + 4) == ' ') + ) + { + meta_add_str(primary, "H"); + meta_add_str(secondary, "H"); + } + else + { + meta_add_str(primary, "J"); + meta_add_str(secondary, "H"); + } + current += 1; + break; + } + + if (current == 0 && !has_jose_next) + { + meta_add_str(primary, "J"); /* Yankelovich/Jankelowicz */ + meta_add_str(secondary, "A"); + } + else + { + /** spanish pron. of e.g. 'bajador' **/ + if ( + !is_slavo_germanic + && (next_char == 'A' || next_char == 'O') + && meta_is_vowel(original, (current - 1)) + ) + { + meta_add_str(primary, "J"); + meta_add_str(secondary, "H"); + } + else + { + if (current == last) + { + meta_add_str(primary, "J"); + meta_add_str(secondary, ""); + } + else + { + if ( + !meta_is_str_at(original, (current + 1), "L", "T", "K", "S", "N", "M", "B", "Z", "") + && !meta_is_str_at(original, (current - 1), "S", "K", "L", "") + ) + { + meta_add_str(primary, "J"); + meta_add_str(secondary, "J"); + } + } + } + } + + current += (next_char == 'J') ? 2 : 1; + break; + } + + case 'K': + { + current += (next_char == 'K') ? 2 : 1; + meta_add_str(primary, "K"); + meta_add_str(secondary, "K"); + break; + } + + case 'L': + { + if (next_char == 'L') + { + /** Spanish e.g. 'cabrillo', 'gallegos' **/ + if ( + ( + current == length - 3 + && meta_is_str_at(original, (current - 1), "ILLO", "ILLA", "ALLE", "") + ) + || ( + meta_is_str_at(original, (current - 1), "ALLE", "") + && ( + meta_is_str_at(original, (last - 1), "AS", "OS", "") + || meta_is_str_at(original, last, "A", "O", "") + ) + ) + ) + { + meta_add_str(primary, "L"); + meta_add_str(secondary, ""); + current += 2; + break; + } + current += 2; + } + else + current += 1; + meta_add_str(primary, "L"); + meta_add_str(secondary, "L"); + break; + } + + case 'M': + { + current += ( + ( + meta_is_str_at(original, (current - 1), "UMB", "") + && (current + 1 == last || meta_is_str_at(original, (current + 2), "ER", "")) + ) + /** 'dumb','thumb' **/ + || next_char == 'M' + ) ? 2 : 1; + meta_add_str(primary, "M"); + meta_add_str(secondary, "M"); + break; + } + + case 'N': + { + current += (next_char == 'N') ? 2 : 1; + meta_add_str(primary, "N"); + meta_add_str(secondary, "N"); + break; + } + + case 'P': + { + if (next_char == 'H') + { + meta_add_str(primary, "F"); + meta_add_str(secondary, "F"); + current += 2; + break; + } + + /** Also account for "campbell", "raspberry" **/ + current += (meta_is_str_at(original, (current + 1), "P", "B", "")) ? 2 : 1; + meta_add_str(primary, "P"); + meta_add_str(secondary, "P"); + break; + } + + case 'Q': + { + current += (next_char == 'Q') ? 2 : 1; + meta_add_str(primary, "K"); + meta_add_str(secondary, "K"); + break; + } + + case 'R': + { + /** French e.g. 'rogier', but exclude 'hochmeier' **/ + const bool no_primary = ( + !is_slavo_germanic + && current == last + && meta_is_str_at(original, (current - 2), "IE", "") + && !meta_is_str_at(original, (current - 4), "ME", "MA", "") + ); + + meta_add_str(primary, (no_primary) ? "" : "R"); + meta_add_str(secondary, "R"); + current += (next_char == 'R') ? 2 : 1; + break; + } + + case 'S': + { + /** Special cases 'island', 'isle', 'carlisle', 'carlysle' **/ + if (meta_is_str_at(original, (current - 1), "ISL", "YSL", "")) + { + current += 1; + break; + } + + /** Special case 'sugar-' **/ + if (current == 0 && meta_is_str_at(original, current, "SUGAR", "")) + { + meta_add_str(primary, "X"); + meta_add_str(secondary, "S"); + current += 1; + break; + } + + if (meta_is_str_at(original, current, "SH", "")) + { + const bool germanic = meta_is_str_at(original, (current + 1), "HEIM", "HOEK", "HOLM", "HOLZ", ""); + const char* sound = (germanic) ? "S" : "X"; + meta_add_str(primary, sound); + meta_add_str(secondary, sound); + current += 2; + break; + } + + /** Italian & Armenian. **/ + if (meta_is_str_at(original, current, "SIO", "SIA", "SIAN", "")) + { + meta_add_str(primary, "S"); + meta_add_str(secondary, (is_slavo_germanic) ? "S" : "X"); + current += 3; + break; + } + + /** german & anglicisations, e.g. 'smith' match 'schmidt', 'snider' match 'schneider' **/ + /** also, -sz- in slavic language although in hungarian it is pronounced 's' **/ + if (current == 0 && meta_is_str_at(original, (current + 1), "M", "N", "L", "W", "")) + { + meta_add_str(primary, "S"); + meta_add_str(secondary, "X"); + current += 1; + break; + } + if (meta_is_str_at(original, (current + 1), "Z", "")) + { + meta_add_str(primary, "S"); + meta_add_str(secondary, "X"); + current += 2; + break; + } + + if (meta_is_str_at(original, current, "SC", "")) + { + /** Schlesinger's rule. **/ + if (meta_get_char_at(original, current + 2) == 'H') + { + /** Dutch origin, e.g. 'school', 'schooner' **/ + if (meta_is_str_at(original, (current + 3), "OO", "ER", "EN", "UY", "ED", "EM", "")) + { + /** 'schermerhorn', 'schenker' **/ + const bool x_sound = meta_is_str_at(original, (current + 3), "ER", "EN", ""); + meta_add_str(primary, (x_sound) ? "X" : "SK"); + meta_add_str(secondary, "SK"); + current += 3; + break; + } + else + { + const bool s_sound = ( + current == 0 + && !meta_is_vowel(original, 3) + && meta_get_char_at(original, 3) != 'W' + ); + meta_add_str(primary, "X"); + meta_add_str(secondary, (s_sound) ? "S" : "X"); + current += 3; + break; + } + } + + /** Default case. **/ + const char* sound = (meta_is_str_at(original, (current + 2), "E", "I", "Y", "")) ? "S" : "SK"; + meta_add_str(primary, sound); + meta_add_str(secondary, sound); + current += 3; + break; + } + + /** French e.g. 'resnais', 'artois' **/ + const bool no_primary = (current == last && meta_is_str_at(original, (current - 2), "AI", "OI", "")); + meta_add_str(primary, (no_primary) ? "" : "S"); + meta_add_str(secondary, "S"); + current += (meta_is_str_at(original, (current + 1), "S", "Z", "")) ? 2 : 1; + break; + } + + case 'T': + { + if (meta_is_str_at(original, current, "TIA", "TCH", "TION", "")) + { + meta_add_str(primary, "X"); + meta_add_str(secondary, "X"); + current += 3; + break; + } + + if (meta_is_str_at(original, current, "TH", "TTH", "")) + { + /** Special case 'thomas', 'thames' or germanic. **/ + if ( + meta_is_str_at(original, (current + 2), "OM", "AM", "") + || meta_is_str_at(original, 0, "SCH", "VAN ", "VON ", "") + ) + meta_add_str(primary, "T"); + else + meta_add_str(primary, "0"); /* Yes, zero. */ + meta_add_str(secondary, "T"); + current += 2; + break; + } + + meta_add_str(primary, "T"); + meta_add_str(secondary, "T"); + current += (meta_is_str_at(original, (current + 1), "T", "D", "")) ? 2 : 1; + break; + } + + case 'V': + { + meta_add_str(primary, "F"); + meta_add_str(secondary, "F"); + current += (next_char == 'V') ? 2 : 1; + break; + } + + case 'W': + { + /** Can also be in middle of word. **/ + if (meta_is_str_at(original, current, "WR", "")) + { + meta_add_str(primary, "R"); + meta_add_str(secondary, "R"); + current += 2; + break; + } + + const bool next_is_vowel = meta_is_vowel(original, current + 1); + if (current == 0 && (next_is_vowel || meta_is_str_at(original, current, "WH", ""))) + { + /** Wasserman should match Vasserman. **/ + meta_add_str(primary, "A"); + meta_add_str(secondary, (next_is_vowel) ? "F" : "A"); + } + + /** Arnow should match Arnoff. **/ + if ((current == last && meta_is_vowel(original, current - 1)) + || meta_is_str_at(original, (current - 1), "EWSKI", "EWSKY", "OWSKI", "OWSKY", "") + || meta_is_str_at(original, 0, "SCH", "") + ) + { + meta_add_str(primary, ""); + meta_add_str(secondary, "F"); + current += 1; + break; + } + + /** Polish e.g. 'filipowicz' **/ + if (meta_is_str_at(original, current, "WICZ", "WITZ", "")) + { + meta_add_str(primary, "TS"); + meta_add_str(secondary, "FX"); + current += 4; + break; + } + + /** Else skip it. **/ + current += 1; + break; + } + + case 'X': + { + /** French e.g. breaux **/ + const bool silent = ( + current == last + && ( + meta_is_str_at(original, (current - 2), "AU", "OU", "") + || meta_is_str_at(original, (current - 3), "IAU", "EAU", "") + ) + ); + if (!silent) + { + meta_add_str(primary, "KS"); + meta_add_str(secondary, "KS"); + } + + current += (meta_is_str_at(original, (current + 1), "C", "X", "")) ? 2 : 1; + break; + } + + case 'Z': + { + /** Chinese pinyin e.g. 'zhao' **/ + if (next_char == 'H') + { + meta_add_str(primary, "J"); + meta_add_str(secondary, "J"); + current += 2; + break; + } + + const bool has_t_sound = ( + meta_is_str_at(original, (current + 1), "ZO", "ZI", "ZA", "") + || (is_slavo_germanic && current > 0 && meta_get_char_at(original, (current - 1)) != 'T') + ); + meta_add_str(primary, "S"); + meta_add_str(secondary, (has_t_sound) ? "TS" : "S"); + current += (next_char == 'Z') ? 2 : 1; + break; + } + + default: + current += 1; + } + } + + *primary_code = primary->str; + *secondary_code = secondary->str; + + meta_destroy_string(original); + meta_destroy_string(primary); + meta_destroy_string(secondary); + } + +#ifdef TESTING +/*** Built in test cases, written by Israel with inspiration from comments in + *** the above code, test cases written by Maurice Aubrey, and some words + *** suggested by AI. + *** + *** These tests have been integrated into the Centrallix testing environment, + *** where they can be run using `export TONLY=exp_fn_double_metaphone_00`, + *** followed by make test, in the Centrallix directory. + *** + *** The can also be run here by executing the following commands in the + *** centrallix/expression directory, which aditionally generates a coverage + *** report. These tests cover all parts of the double metaphone algorithm, + *** although some of the error cases in various helper functions (such as + *** meta_destroy_string(null)) are not covered by testing. + *** + *** Commands: + *** gcc exp_double_metaphone.c -o exp_double_metaphone.o -I .. -DTESTING -fprofile-arcs -ftest-coverage -O0 + *** ./exp_double_metaphone.o + *** gcov exp_double_metaphone.c + ***/ + +unsigned int num_tests_passed = 0u, num_tests_failed = 0u; + +void test(const char* input, const char* expected_primary, const char* expected_secondary) + { + char* codes[2]; + + /** Run DoubleMetaphone() and extract results. **/ + char* actual_primary; + char* actual_secondary; + meta_double_metaphone( + input, + memset(&actual_primary, 0, sizeof(actual_primary)), + memset(&actual_secondary, 0, sizeof(actual_secondary)) + ); + + /** Test for correct value. **/ + if (!strcmp(expected_primary, actual_primary) && + !strcmp(expected_secondary, actual_secondary)) + num_tests_passed++; + else + { + printf( + "\nTEST FAILED: \"%s\"\n" + "Expected: %s %s\n" + "Actual: %s %s\n", + input, + expected_primary, expected_secondary, + actual_primary, actual_secondary + ); + num_tests_failed++; + } + } + +// Special thanks to the following websites for double checking the correct results: +// 1: https://words.github.io/double-metaphone +// 2: https://mainegenealogy.net/metaphone_converter.asp +// 3: https://en.toolpage.org/tool/metaphone +void run_tests(void) + { + printf("\nRunning tests...\n"); + + /** Test that always fails. **/ + // test("This", "test", "fails."); + + /** Invalid string tests, by Israel. **/ + fprintf(stderr, "Expect two warnings between these two lines:\n"); + fprintf(stderr, "----------------\n"); + test(NULL, "", ""); + test("", "", ""); + fprintf(stderr, "----------------\n"); + + /** Basic tests, by Israel. **/ + test("Test", "TST", "TST"); + test("Basic", "PSK", "PSK"); + test("Centrallix", "SNTRLKS", "SNTRLKS"); + test("Lawrence", "LRNS", "LRNS"); + test("Philips", "FLPS", "FLPS"); + test("Acceptingness", "AKSPTNNS", "AKSPTNKNS"); + test("Supercalifragilisticexpialidocious", "SPRKLFRJLSTSKSPLTSS", "SPRKLFRKLSTSKSPLTXS"); + test("Suoicodilaipxecitsiligarfilacrepus", "SKTLPKSSTSLKRFLKRPS", "SKTLPKSSTSLKRFLKRPS"); + + /** Match tests, from code comments above. **/ + test("Smith", "SM0", "XMT"); + test("Schmidt", "XMT", "SMT"); + test("Snider", "SNTR", "XNTR"); + test("Schneider", "XNTR", "SNTR"); + test("Arnow", "ARN", "ARNF"); + test("Arnoff", "ARNF", "ARNF"); + + /** Example tests, from examples in code comments above. **/ + test("Accede", "AKST", "AKST"); + test("Accident", "AKSTNT", "AKSTNT"); + test("Actually", "AKTL", "AKTL"); + test("Arch", "ARX", "ARK"); + test("Artois", "ART", "ARTS"); + test("Bacchus", "PKS", "PKS"); + test("Bacci", "PX", "PX"); + test("Bajador", "PJTR", "PHTR"); + test("Bellocchio", "PLX", "PLX"); + test("Bertucci", "PRTX", "PRTX"); + test("Biaggi", "PJ", "PK"); + test("Bough", "P", "P"); + test("Breaux", "PR", "PR"); + test("Broughton", "PRTN", "PRTN"); + test("Cabrillo", "KPRL", "KPR"); + test("Caesar", "SSR", "SSR"); + test("Cagney", "KKN", "KKN"); + test("Campbell", "KMPL", "KMPL"); + test("Carlisle", "KRLL", "KRLL"); + test("Carlysle", "KRLL", "KRLL"); + test("Chemistry", "KMSTR", "KMSTR"); + test("Chianti", "KNT", "KNT"); + test("Chorus", "KRS", "KRS"); + test("Cough", "KF", "KF"); + test("Czerny", "SRN", "XRN"); + test("Dumb", "TM", "TM"); + test("Edgar", "ATKR", "ATKR"); + test("Edge", "AJ", "AJ"); + test("Filipowicz", "FLPTS", "FLPFX"); + test("Focaccia", "FKX", "FKX"); + test("Gallegos", "KLKS", "KKS"); + test("Germanic", "KRMNK", "JRMNK"); + test("Ghiradelli", "JRTL", "JRTL"); + test("Ghislane", "JLN", "JLN"); + test("Gospel", "KSPL", "KSPL"); + test("Gough", "KF", "KF"); + test("Greek", "KRK", "KRK"); + test("Hochmeier", "HKMR", "HKMR"); + test("Hugh", "H", "H"); + test("Island", "ALNT", "ALNT"); + test("Isle", "AL", "AL"); + test("Italian", "ATLN", "ATLN"); + test("Jankelowicz", "JNKLTS", "ANKLFX"); + test("Jose", "HS", "HS"); + test("Laugh", "LF", "LF"); + test("Mac Caffrey", "MKFR", "MKFR"); + test("Mac Gregor", "MKRKR", "MKRKR"); + test("Manager", "MNKR", "MNJR"); + test("McHugh", "MK", "MK"); + test("McLaughlin", "MKLFLN", "MKLFLN"); + test("Michael", "MKL", "MXL"); + test("Middle", "MTL", "MTL"); + test("Orchestra", "ARKSTR", "ARKSTR"); + test("Orchid", "ARKT", "ARKT"); + test("Pinyin", "PNN", "PNN"); + test("Raspberry", "RSPR", "RSPR"); + test("Resnais", "RSN", "RSNS"); + test("Rogier", "RJ", "RJR"); + test("Rough", "RF", "RF"); + test("Salvador", "SLFTR", "SLFTR"); + test("San jacinto", "SNHSNT", "SNHSNT"); + test("Schenker", "XNKR", "SKNKR"); + test("Schermerhorn", "XRMRRN", "SKRMRRN"); + test("Schlesinger", "XLSNKR", "SLSNJR"); + test("School", "SKL", "SKL"); + test("Schooner", "SKNR", "SKNR"); + test("Succeed", "SKST", "SKST"); + test("Sugar", "XKR", "SKR"); + test("Sugary", "XKR", "SKR"); + test("Tagliaro", "TKLR", "TLR"); + test("Thames", "TMS", "TMS"); + test("Thomas", "TMS", "TMS"); + test("Thumb", "0M", "TM"); + test("Tichner", "TXNR", "TKNR"); + test("Tough", "TF", "TF"); + test("Vghee", "FK", "FK"); + test("Wachtler", "AKTLR", "FKTLR"); + test("Wechsler", "AKSLR", "FKSLR"); + test("Word", "ART", "FRT"); + test("Xavier", "SF", "SFR"); + test("Yankelovich", "ANKLFX", "ANKLFK"); + test("Zhao", "J", "J"); + + /** Interesting Edge Case: "McClellan" **/ + /*** Note: Sources (1) and (3) both include a double K ("MKKLLN"), but the + *** original code on GitHub and mainegenealogy.net do not. I chose "MKLLN" + *** to be correct because I personally do not pronounce the second c. + ***/ + test("McClellan", "MKLLN", "MKLLN"); + + /** Maurice Aubrey's Tests. **/ + /** Source: https://github.com/gitpan/Text-DoubleMetaphone/blob/master/t/words.txt **/ + test("maurice", "MRS", "MRS"); + test("aubrey", "APR", "APR"); + test("cambrillo", "KMPRL", "KMPR"); + test("heidi", "HT", "HT"); + test("katherine", "K0RN", "KTRN"); + test("catherine", "K0RN", "KTRN"); + test("richard", "RXRT", "RKRT"); + test("bob", "PP", "PP"); + test("eric", "ARK", "ARK"); + test("geoff", "JF", "KF"); + test("dave", "TF", "TF"); + test("ray", "R", "R"); + test("steven", "STFN", "STFN"); + test("bryce", "PRS", "PRS"); + test("randy", "RNT", "RNT"); + test("bryan", "PRN", "PRN"); + test("brian", "PRN", "PRN"); + test("otto", "AT", "AT"); + test("auto", "AT", "AT"); + + /** GPT-5 Coverage Tests. **/ + /*** GPT-5 mini (Preview) running in GitHub Copilot suggested the words + *** after analizing a generated coverage report, and I (Israel) used + *** them to write the tests below. I kept the AI's reasoning for tests, + *** while removing tests that did not contribute any coverage, but after + *** a few reprompts, the AI started just giving words without reasoning. + *** I guess we were both getting pretty tired of writing tests. + ***/ + test("Abbott", "APT", "APT"); /* double-B ("BB") handling. */ + test("Back", "PK", "PK"); /* "CK"/"CG"/"CQ" branch. */ + test("Bacher", "PKR", "PKR"); /* matches "...BACHER" / ACH special-case. */ + test("Charles", "XRLS", "XRLS"); /* initial "CH" -> the branch that maps to "X"/"X" at start. */ + test("Ghana", "KN", "KN"); /* initial "GH" special-start handling. */ + test("Gnome", "NM", "NM"); /* "GN" sequence handling. */ + test("Raj", "RJ", "R"); /* J at end (exercise J-last behavior). */ + test("Quentin", "KNTN", "KNTN"); /* Q case (Q -> K mapping). */ + test("Who", "A", "A"); /* "WH" at start handling. */ + test("Shoemaker", "XMKR", "XMKR"); /* "SH" general mapping paths. */ + test("Sian", "SN", "XN"); /* "SIO"/"SIA"/"SIAN" branch. */ + test("Scold", "SKLT", "SKLT"); /* "SC" default / "SK" vs other SC subcases. */ + test("Station", "STXN", "STXN"); /* "TION" -> X mapping. */ + test("Match", "MX", "MX"); /* "TCH"/"TIA" -> X mapping. */ + test("Pizza", "PS", "PTS"); /* double-Z ("ZZ") handling. */ + test("Agnes", "AKNS", "ANS"); /* "GN" at index 1 (GN handling that yields KN / N). */ + test("Science", "SNS", "SNS"); /* "SC" followed by I (SC + I/E/Y branch). */ + test("Van Gogh", "FNKK", "FNKK"); + test("Josef", "JSF", "HSF"); + test("Object", "APJKT", "APJKT"); + test("Sholz", "SLS", "SLS"); + test("Scharf", "XRF", "XRF"); + test("Kasia", "KS", "KS"); + test("Van Geller", "FNKLR", "FNKLR"); + + const unsigned int total_tests = num_tests_passed + num_tests_failed; + printf("\nTests completed!\n"); + printf(" > Failed: %u\n", num_tests_failed); + printf(" > Skipped: %u\n", 0u); /* Implementation removed. */ + printf(" > Passed: %u/%u\n", num_tests_passed, total_tests); + } + +int main(void) + { + run_tests(); + + return 0; + } + +/** Prevent scope leak. **/ +#undef META_FREE +#undef META_MALLOC +#undef META_REALLOC +#undef SAFE_MALLOC +#undef SAFE_REALLOC + +#endif From b6abca77753711d05263ad6300bc6c8b5a2d1d90 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Thu, 11 Dec 2025 16:34:32 -0700 Subject: [PATCH 033/275] Finish exp_functions.c work. Add log() and trim() exp functions (with tests). Add optional variables in schemas. Fix styling for schema verification. Fix log() being treated as a reserved word. --- centrallix/expression/exp_functions.c | 963 ++++++++++++++---------- centrallix/multiquery/multiquery.c | 17 +- centrallix/tests/test_expfn_log_00.cmp | 37 +- centrallix/tests/test_expfn_log_00.to | 59 +- centrallix/tests/test_expfn_trim_00.cmp | 10 + centrallix/tests/test_expfn_trim_00.to | 19 + 6 files changed, 655 insertions(+), 450 deletions(-) create mode 100644 centrallix/tests/test_expfn_trim_00.cmp create mode 100644 centrallix/tests/test_expfn_trim_00.to diff --git a/centrallix/expression/exp_functions.c b/centrallix/expression/exp_functions.c index 647b157e8..772672bca 100644 --- a/centrallix/expression/exp_functions.c +++ b/centrallix/expression/exp_functions.c @@ -85,14 +85,16 @@ *** skipped for other types. *** *** Valid Flags: + *** - `EXP_ARG_OPTIONAL`: The arg is optional. It is not valid a required + *** argument after an optional one. *** - `EXP_ARG_NOT_NULL`: Expect the arg to not be null. *** - `EXP_ARG_FORCE_TYPE`: Run type check on null args (not recommended). - *** - `EXP_ARG_NON_EMPTY`: Expect string to be non-empty. Expect a - *** stringvec or intvec to have elements (does not check them). - *** - `EXP_ARG_POSITIVE`: Expect a positive or zero value for int, double, - *** money, or datetime. (Includes NON_NAN: NAN is not positive). - *** - `EXP_ARG_NEGATIVE`: Expect a negative or zero value for int, double, - *** money, or datetime. (Includes NON_NAN: NAN is not negative). + *** - `EXP_ARG_NON_EMPTY`: Expect string to be non-empty. Expect a + *** stringvec or intvec to have elements (does not check them). + *** - `EXP_ARG_POSITIVE`: Expect a positive or zero value for int, double, + *** money, or datetime. (Includes NON_NAN: NAN is not positive). + *** - `EXP_ARG_NEGATIVE`: Expect a negative or zero value for int, double, + *** money, or datetime. (Includes NON_NAN: NAN is not negative). *** - `EXP_ARG_NON_NAN`: Expect a double to be a number, not NAN. *** *** @attention - Checks like `EXP_ARG_NON_EMPTY`, `EXP_ARG_NON_NAN`, etc. also @@ -105,252 +107,258 @@ typedef struct } ArgExpect, *pArgExpect; +#define EXP_ARG_END (ArgExpect){NULL, -1} #define EXP_ARG_NO_FLAGS (0) -#define EXP_ARG_NOT_NULL (1 << 0) -#define EXP_ARG_FORCE_TYPE (1 << 1) -#define EXP_ARG_NON_EMPTY (1 << 2) -#define EXP_ARG_NEGATIVE (1 << 3) -#define EXP_ARG_POSITIVE (1 << 4) -#define EXP_ARG_NON_NAN (1 << 5) +#define EXP_ARG_OPTIONAL (1 << 0) +#define EXP_ARG_NOT_NULL (1 << 1) +#define EXP_ARG_FORCE_TYPE (1 << 2) +#define EXP_ARG_NON_EMPTY (1 << 3) +#define EXP_ARG_NEGATIVE (1 << 4) +#define EXP_ARG_POSITIVE (1 << 5) +#define EXP_ARG_NON_NAN (1 << 6) /*** An internal function used by the schema verifier (below) to verify each - *** argument of the schema. + *** argument of the provided schema. + *** + *** @param fn_name The name of the expression function to be verified. + *** @param arg The argument to be verified. + *** @param arg_expect The expectation struct which specifies the requirements + *** for this argument. + *** @returns 0 if the expectations are successfully met, + *** -1 if an expectation is violated (and mssError() is called). ***/ static int exp_fn_i_verify_arg(const char* fn_name, pExpression arg, const ArgExpect* arg_expect) { - /** The expectation struct cannot be NULL. **/ - if (arg_expect == NULL) - { - mssErrorf(1, "EXP", - "%s(...): Expectation struct cannot be NULL", - fn_name - ); - return -1; - } - - /** Extract values. **/ - ASSERTMAGIC(arg, MGK_EXPRESSION); - int actual_datatype = arg->DataType; - - /** Check for a provided NULL value. **/ - if (arg->Flags & EXPR_F_NULL) - { - if (arg_expect->Flags & EXP_ARG_NOT_NULL) + /** The expectation struct cannot be NULL. **/ + if (arg_expect == NULL) { mssErrorf(1, "EXP", - "%s(...): Expects a non-null value, but got NULL : %s (%d).", - fn_name, ci_TypeToStr(actual_datatype), actual_datatype + "%s(...): Expectation struct cannot be NULL", + fn_name ); return -1; } - /** Skip type checks unless forced. **/ - if (!(arg_expect->Flags & EXP_ARG_FORCE_TYPE)) goto skip_type_checks; - } - - /** No type checking required. **/ - if (arg_expect->Datatypes == NULL) goto skip_type_checks; - - /** No types given: Probably a mistake. **/ - if (arg_expect->Datatypes[0] == -1) - { - mssErrorf(1, "EXP", - "%s(...): Array of allowed Datatypes is empty.", - fn_name - ); - return -1; - } - - /** Verify Datatypes. **/ - bool found = false; - for (int j = 0; arg_expect->Datatypes[j] != -1; j++) - { - const int expected_datatype = arg_expect->Datatypes[j]; - if (expected_datatype == actual_datatype) - { - found = true; - break; - } - } - - /** Handle failure. **/ - if (!found) - { - /** Accumulate additional valid types. **/ - char buf[256] = {'\0'}; - int cur = 0, j = 1; - while (true) - { - int datatype = arg_expect->Datatypes[j++]; - if (datatype == -1) break; - - cur += snprintf( - buf + cur, 256 - cur, - " or %s (%d)", - ci_TypeToStr(datatype), datatype - ); - } + /** Extract values. **/ + ASSERTMAGIC(arg, MGK_EXPRESSION); + int actual_datatype = arg->DataType; - /** Print error. **/ - int first_datatype = arg_expect->Datatypes[0]; - mssErrorf(1, "EXP", - "%s(...): Expects type %s (%d)%s but got type %s (%d).", - fn_name, ci_TypeToStr(first_datatype), first_datatype, buf, ci_TypeToStr(actual_datatype), actual_datatype - ); - return -1; - } - - skip_type_checks: - /** All flag checks not implemented above should pass on NULL values. **/ - if (arg->Flags & EXPR_F_NULL) return 0; - - /** Verify other Flags by type, if specified. **/ - switch (actual_datatype) - { - case DATA_T_INTEGER: + /** Check for a provided NULL value. **/ + if (arg->Flags & EXPR_F_NULL) { - int value = arg->Integer; - if (arg_expect->Flags & EXP_ARG_POSITIVE && value < 0) + if (arg_expect->Flags & EXP_ARG_NOT_NULL) { mssErrorf(1, "EXP", - "%s(...): Expects positive int but got %d.", - fn_name, value + "%s(...): Expects a non-null value, but got NULL : %s (%d).", + fn_name, objTypeToStr(actual_datatype), actual_datatype ); return -1; } - if (arg_expect->Flags & EXP_ARG_NEGATIVE && value > 0) - { - mssErrorf(1, "EXP", - "%s(...): Expects negative int but got %d.", - fn_name, value - ); - return -1; - } - break; + + /** Skip type checks for NULL values (unless they are forced). **/ + if (!(arg_expect->Flags & EXP_ARG_FORCE_TYPE)) goto skip_type_checks; } - case DATA_T_DOUBLE: + /** Skip type checks if none are requested. **/ + if (arg_expect->Datatypes == NULL) goto skip_type_checks; + + /** Type checks requested, but no valid types given: Likely a mistake. **/ + if (arg_expect->Datatypes[0] == -1) { - double value = arg->Types.Double; - if (arg_expect->Flags & EXP_ARG_NON_NAN && isnan(value)) - { - mssErrorf(1, "EXP", - "%s(...): Expects non-nan double but got %g.", - fn_name, value - ); - return -1; - } - if (arg_expect->Flags & EXP_ARG_POSITIVE && value < 0) - { - mssErrorf(1, "EXP", - "%s(...): Expects positive double but got %g.", - fn_name, value - ); - return -1; - } - if (arg_expect->Flags & EXP_ARG_NEGATIVE && value > 0) + mssErrorf(1, "EXP", "%s(...): Invalid Schema! Empty array of allowed datatypes.", fn_name); + fprintf(stderr, "Hint: To skip type checks, pass NULL for the array of data types.\n"); + return -1; + } + + /** Verify datatypes. **/ + bool found = false; + for (int j = 0; arg_expect->Datatypes[j] != -1; j++) + { + const int expected_datatype = arg_expect->Datatypes[j]; + if (expected_datatype == actual_datatype) { - mssErrorf(1, "EXP", - "%s(...): Expects negative double but got %g.", - fn_name, value - ); - return -1; + found = true; + break; } - break; } - case DATA_T_STRING: + /** Handle failure. **/ + if (!found) { - char* str = arg->String; - if (arg_expect->Flags & EXP_ARG_NON_EMPTY && str[0] == '\0') + /** Accumulate additional valid types. **/ + char buf[256] = {'\0'}; + int cur = 0, j = 1; + while (true) { - mssErrorf(1, "EXP", - "%s(...): Expects string to contain characters, but got \"\".", - fn_name + int datatype = arg_expect->Datatypes[j++]; + if (datatype == -1) break; + + cur += snprintf( + buf + cur, 256 - cur, + " or %s (%d)", + objTypeToStr(datatype), datatype ); - return -1; } - break; + + /** Print error. **/ + int first_datatype = arg_expect->Datatypes[0]; + mssErrorf(1, "EXP", + "%s(...): Expects type %s (%d)%s but got type %s (%d).", + fn_name, objTypeToStr(first_datatype), first_datatype, buf, objTypeToStr(actual_datatype), actual_datatype + ); + return -1; } - case DATA_T_DATETIME: + skip_type_checks: + /** All flag checks not implemented above should pass on NULL values. **/ + if (arg->Flags & EXPR_F_NULL) return 0; + + /** Verify other Flags by type, if specified. **/ + switch (actual_datatype) { - pDateTime value = &arg->Types.Date; - if (arg_expect->Flags & EXP_ARG_POSITIVE && value->Value < 0) + case DATA_T_INTEGER: { - mssErrorf(1, "EXP", - "%s(...): Expects positive date offset but got %llu.", - fn_name, value->Value - ); - return -1; + int value = arg->Integer; + if (arg_expect->Flags & EXP_ARG_POSITIVE && value < 0) + { + mssErrorf(1, "EXP", + "%s(...): Expects positive int but got %d.", + fn_name, value + ); + return -1; + } + if (arg_expect->Flags & EXP_ARG_NEGATIVE && value > 0) + { + mssErrorf(1, "EXP", + "%s(...): Expects negative int but got %d.", + fn_name, value + ); + return -1; + } + break; } - if (arg_expect->Flags & EXP_ARG_NEGATIVE && value->Value > 0) + + case DATA_T_DOUBLE: { - mssErrorf(1, "EXP", - "%s(...): Expects negative date offset but got %llu.", - fn_name, value->Value - ); - return -1; + double value = arg->Types.Double; + if (arg_expect->Flags & EXP_ARG_NON_NAN && isnan(value)) + { + mssErrorf(1, "EXP", + "%s(...): Expects non-nan double but got %g.", + fn_name, value + ); + return -1; + } + if (arg_expect->Flags & EXP_ARG_POSITIVE && value < 0) + { + mssErrorf(1, "EXP", + "%s(...): Expects positive double but got %g.", + fn_name, value + ); + return -1; + } + if (arg_expect->Flags & EXP_ARG_NEGATIVE && value > 0) + { + mssErrorf(1, "EXP", + "%s(...): Expects negative double but got %g.", + fn_name, value + ); + return -1; + } + break; } - break; - } - - case DATA_T_MONEY: - { - pMoneyType value = &arg->Types.Money; - if (arg_expect->Flags & EXP_ARG_POSITIVE && value->WholePart < 0) + + case DATA_T_STRING: { - mssErrorf(1, "EXP", - "%s(...): Expects positive money value but got $%d.%g.", - fn_name, value->WholePart, (double)value->FractionPart / 100.0 - ); - return -1; + char* str = arg->String; + if (arg_expect->Flags & EXP_ARG_NON_EMPTY && str[0] == '\0') + { + mssErrorf(1, "EXP", + "%s(...): Expects string to contain characters, but got \"\".", + fn_name + ); + return -1; + } + break; } - if (arg_expect->Flags & EXP_ARG_NEGATIVE && value->WholePart > 0) + + case DATA_T_DATETIME: { - mssErrorf(1, "EXP", - "%s(...): Expects negative money value but got $%d.%d.", - fn_name, value->WholePart, (double)value->FractionPart / 100.0 - ); - return -1; + pDateTime value = &arg->Types.Date; + if (arg_expect->Flags & EXP_ARG_POSITIVE && value->Value < 0) + { + mssErrorf(1, "EXP", + "%s(...): Expects positive date offset but got %llu.", + fn_name, value->Value + ); + return -1; + } + if (arg_expect->Flags & EXP_ARG_NEGATIVE && value->Value > 0) + { + mssErrorf(1, "EXP", + "%s(...): Expects negative date offset but got %llu.", + fn_name, value->Value + ); + return -1; + } + break; } - } - - case DATA_T_STRINGVEC: - { - pStringVec str_vec = &arg->Types.StrVec; - if (arg_expect->Flags & EXP_ARG_NON_EMPTY && str_vec->nStrings == 0) + + case DATA_T_MONEY: { - mssErrorf(1, "EXP", - "%s(...): Expects StringVec to contain strings, but got [].", - fn_name - ); - return -1; + pMoneyType value = &arg->Types.Money; + if (arg_expect->Flags & EXP_ARG_POSITIVE && value->WholePart < 0) + { + mssErrorf(1, "EXP", + "%s(...): Expects positive money value but got $%d.%g.", + fn_name, value->WholePart, (double)value->FractionPart / 100.0 + ); + return -1; + } + if (arg_expect->Flags & EXP_ARG_NEGATIVE && value->WholePart > 0) + { + mssErrorf(1, "EXP", + "%s(...): Expects negative money value but got $%d.%d.", + fn_name, value->WholePart, (double)value->FractionPart / 100.0 + ); + return -1; + } } - break; - } - - case DATA_T_INTVEC: - { - pIntVec int_vec = &arg->Types.IntVec; - if (arg_expect->Flags & EXP_ARG_NON_EMPTY && int_vec->nIntegers == 0) + + case DATA_T_STRINGVEC: { - mssErrorf(1, "EXP", - "%s(...): Expects IntVec to contain strings, but got [].", - fn_name - ); - return -1; + pStringVec str_vec = &arg->Types.StrVec; + if (arg_expect->Flags & EXP_ARG_NON_EMPTY && str_vec->nStrings == 0) + { + mssErrorf(1, "EXP", + "%s(...): Expects StringVec to contain strings, but got [].", + fn_name + ); + return -1; + } + break; + } + + case DATA_T_INTVEC: + { + pIntVec int_vec = &arg->Types.IntVec; + if (arg_expect->Flags & EXP_ARG_NON_EMPTY && int_vec->nIntegers == 0) + { + mssErrorf(1, "EXP", + "%s(...): Expects IntVec to contain strings, but got [].", + fn_name + ); + return -1; + } + break; } - break; } - } return 0; } /*** Verify that arguments passed to a function match some expected values. *** - *** @param fn_name The name of the function (for error messages). *** @param arg_expects A pointer to an array of ArgExpect structs, each *** representing expectations for a single argument, in the order they *** are passed to the function. @@ -358,7 +366,7 @@ static int exp_fn_i_verify_arg(const char* fn_name, pExpression arg, const ArgEx *** function (and the length of arg_expects). *** @param tree The tree containing the actual arguments passed. *** @param obj_list The object list scope which was passed to the function. - *** @returns 0 if all arguments are successfully verified, or + *** @returns 0 if verification passes, or *** -1 if an error occurs or arguments are incorrect. *** *** @attention - Promises that an error message will be printed with a call @@ -366,50 +374,79 @@ static int exp_fn_i_verify_arg(const char* fn_name, pExpression arg, const ArgEx *** *** Example: *** ```c - *** char fn_name[] = "example"; - *** if (exp_fn_i_verify_schema(fn_name, + *** if (exp_fn_i_verify_schema( *** (ArgExpect[]){ - *** {(int[]){DATA_T_INTEGER, DATA_T_DOUBLE, -1}, EXP_PARAM_NOT_NULL}, - *** {(int[]){DATA_T_STRING, -1}, 0} - *** }, 2, - *** tree, obj_list + *** {(int[]){DATA_T_INTEGER, DATA_T_DOUBLE, DATA_T_DATETIME, -1}, EXP_ARG_NOT_NULL}, + *** {(int[]){DATA_T_STRING, -1}, EXP_ARG_NO_FLAGS}, + *** {(int[]){DATA_T_STRING, -1}, EXP_ARG_OPTIONAL}, + *** EXP_ARG_END + *** }, tree *** ) != 0) *** { - *** mssErrorf(0, "EXP", "%s(?) Call does not match function schema.", fn_name); + *** mssErrorf(0, "EXP", "%s(?): Call does not match function schema.", tree->Name); *** return -1; *** } *** ``` ***/ -static int exp_fn_i_verify_schema( - const char* fn_name, - const ArgExpect* arg_expects, - const int num_args, - pExpression tree, - pParamObjects obj_list) +static int exp_fn_i_verify_schema(const ArgExpect* arg_expects, pExpression tree) { - /** Verify expression tree. **/ - ASSERTMAGIC(tree, MGK_EXPRESSION); - - /** Verify argument count. **/ - const int num_args_actual = tree->Children.nItems; - if (num_args != num_args_actual) - { - mssErrorf(1, "EXP", - "%s(?): Expects %u argument%s, got %d argument%s.", - fn_name, num_args, (num_args == 1) ? "" : "s", num_args_actual, (num_args_actual == 1) ? "" : "s" - ); - return -1; - } - - /** Verify argument datatypes. **/ - for (int i = 0; i < num_args; i++) - { - if (exp_fn_i_verify_arg(fn_name, tree->Children.Items[i], &arg_expects[i]) != 0) + /** Verify expression tree. **/ + ASSERTMAGIC(tree, MGK_EXPRESSION); + + /** Count arguments. **/ + unsigned int req_args = 0u, opt_args = 0u; + for (unsigned int i = 0; arg_expects[i].Flags != EXP_ARG_END.Flags; i++) { - mssErrorf(0, "EXP", "%s(...): Error while reading arg #%d/%d.", fn_name, i + 1, num_args); - return -1; + if (arg_expects[i].Flags & EXP_ARG_OPTIONAL) + opt_args++; + else if (opt_args > 0) + { + /** Required argument follows optional argument (not allowed). **/ + mssErrorf(1, "EXP", "%s(?): Invalid Schema! Required argument #%u after optional argument.", tree->Name, i); + return -1; + } + else + req_args++; + } + const unsigned int total_args = req_args + opt_args; + + /** Verify argument count. **/ + const int actual_args = tree->Children.nItems; + if (opt_args == 0) + { + if (actual_args != req_args) + { + mssErrorf(1, "EXP", + "%s(?): Expects %u argument%s, got %d argument%s.", + tree->Name, req_args, (req_args == 1) ? "" : "s", actual_args, (actual_args == 1) ? "" : "s" + ); + return -1; + } + } + else + { + if (actual_args < req_args || total_args < actual_args) + { + mssErrorf(1, "EXP", + "%s(?): Expects between %u and %u arguments, got %d argument%s.", + tree->Name, req_args, total_args, actual_args, (actual_args == 1) ? "" : "s" + ); + return -1; + } + } + + /** Verify arguments. **/ + for (int i = 0; i < actual_args; i++) + { + if (exp_fn_i_verify_arg(tree->Name, tree->Children.Items[i], &arg_expects[i]) != 0) + { + mssErrorf(0, "EXP", + "%s(...): Error while reading arg #%d/%d.", + tree->Name, i + 1, max(i + 1, req_args) + ); + return -1; + } } - } /** Pass. **/ return 0; @@ -445,7 +482,7 @@ static int exp_fn_i_get_number(pExpression numeric_expr, double* result_ptr) default: mssError(1, "EXP", "%s (%d) is not a numeric type.", - ci_TypeToStr(numeric_expr->DataType), numeric_expr->DataType + objTypeToStr(numeric_expr->DataType), numeric_expr->DataType ); return -1; } @@ -456,6 +493,55 @@ static int exp_fn_i_get_number(pExpression numeric_expr, double* result_ptr) return 0; } +/*** Free the given tree's result string, if it has one. + *** + *** @param tree The affected tree. + ***/ +static void exp_fn_i_free_result_string(pExpression tree) + { + /** If no string is allocated, no work is needed. **/ + if (tree->Alloc == 0) return; + + /** Free the string, if it exists. **/ + if (tree->String != NULL) nmSysFree(tree->String); + + /** No string is allocated anymore. */ + tree->Alloc = 0; + } + +/*** Ensure that the allocated result string is long enough to store a given + *** amount of required data. This function promises that `tree->String` will + *** point to at least `required_space` bytes after it returns 0. + *** + *** @param tree The affected tree. + *** @param required_space The number of bytes required. + *** @returns 0 if successful, or + *** -1 if an error occurs. + ***/ +static int exp_fn_i_alloc_result_string(pExpression tree, const size_t required_space) + { + /** Free the previous string (if needed) so we can store a new one. **/ + exp_fn_i_free_result_string(tree); + + /** Decide how to allocate space. **/ + if (required_space <= 64) + { + /** We can use the preallocated buffer. **/ + tree->String = tree->Types.StringBuf; + tree->Alloc = 0; + } + else + { + /** We need to allocate new memory. **/ + char* result = check_ptr(nmSysMalloc(required_space * sizeof(char*))); + if (result == NULL) return -1; + tree->String = result; + tree->Alloc = 1; + } + + return 0; + } + /****** Evaluator functions follow for expEvalFunction ******/ @@ -1505,108 +1591,155 @@ int exp_fn_reverse(pExpression tree, pParamObjects objlist, pExpression i0, pExp /** Leading zero trim. */ int exp_fn_lztrim(pExpression tree, pParamObjects objlist, pExpression i0, pExpression i1, pExpression i2) { - char* ptr; - - if (!i0 || i0->Flags & EXPR_F_NULL) - { - tree->Flags |= EXPR_F_NULL; + /** Expect one nullable string parameter. **/ + if (exp_fn_i_verify_schema((ArgExpect[]){ + {(int[]){DATA_T_STRING, -1}, EXP_ARG_NO_FLAGS}, + EXP_ARG_END, + }, tree) != 0) + { + mssErrorf(0, "EXP", "%s(?): Call does not match function schema.", tree->Name); + return -1; + } + + /** Extract the arg string. **/ + pExpression maybe_str = check_ptr(tree->Children.Items[0]); + if (maybe_str->Flags & EXPR_F_NULL) + { + /** Propegate null values. **/ + tree->Flags |= EXPR_F_NULL; + tree->DataType = DATA_T_STRING; + return 0; + } + char* str = maybe_str->String; + + /*** We don't need to allocate new memory or copy anything because we + *** can simply point to the first character in the previous string + *** that isn't trimmed. + ***/ + + /** Iterate over all the characters that need to be removed. **/ + while (*str == '0' && (str[1] >= '0' && str[1] <= '9')) str++; + + /** Return the results using the tree. **/ + exp_fn_i_free_result_string(tree); tree->DataType = DATA_T_STRING; - return 0; - } - if (i0->DataType != DATA_T_STRING) - { - mssError(1,"EXP","lztrim() only works on STRING data types"); - return -1; - } - if (tree->Alloc && tree->String) - { - nmSysFree(tree->String); - } - tree->DataType = DATA_T_STRING; - ptr = i0->String; - while(*ptr == '0' && (ptr[1] >= '0' && ptr[1] <= '9')) ptr++; - tree->String = ptr; - tree->Alloc = 0; + tree->String = str; + return 0; } -int exp_fn_ltrim(pExpression tree, pParamObjects objlist, pExpression i0, pExpression i1, pExpression i2) +/** Left trim spaces. **/ +int exp_fn_ltrim(pExpression tree) { - char* ptr; - - if (!i0 || i0->Flags & EXPR_F_NULL) - { - tree->Flags |= EXPR_F_NULL; + /** Expect one nullable string parameter. **/ + if (exp_fn_i_verify_schema((ArgExpect[]){ + {(int[]){DATA_T_STRING, -1}, EXP_ARG_NO_FLAGS}, + EXP_ARG_END, + }, tree) != 0) + { + mssErrorf(0, "EXP", "%s(?): Call does not match function schema.", tree->Name); + return -1; + } + + /** Extract the arg string. **/ + pExpression maybe_str = check_ptr(tree->Children.Items[0]); + if (maybe_str->Flags & EXPR_F_NULL) + { + /** Propegate null values. **/ + tree->Flags |= EXPR_F_NULL; + tree->DataType = DATA_T_STRING; + return 0; + } + char* str = maybe_str->String; + + /*** We don't need to allocate new memory or copy anything because we + *** can simply point to the first character in the previous string + *** that isn't trimmed. + ***/ + + /** Iterate until we find the a charater that isn't a space. **/ + /** Note: Only spaces are trimmed, as with similar trim functions in most SQL languages. **/ + while (*str == ' ') str++; + + /** Return the results using the tree. **/ + exp_fn_i_free_result_string(tree); tree->DataType = DATA_T_STRING; - return 0; - } - if (i0->DataType != DATA_T_STRING) - { - mssError(1,"EXP","ltrim() only works on STRING data types"); - return -1; - } - if (tree->Alloc && tree->String) - { - nmSysFree(tree->String); - } - tree->DataType = DATA_T_STRING; - ptr = i0->String; - while(*ptr == ' ') ptr++; - tree->String = ptr; - tree->Alloc = 0; + tree->String = str; + return 0; } -int exp_fn_rtrim(pExpression tree, pParamObjects objlist, pExpression i0, pExpression i1, pExpression i2) +/** Right trim spaces. **/ +int exp_fn_rtrim(pExpression tree) { - char* ptr; - int n; - - if (!i0 || i0->Flags & EXPR_F_NULL) - { - tree->Flags |= EXPR_F_NULL; - tree->DataType = DATA_T_STRING; - return 0; - } - if (i0->DataType != DATA_T_STRING) - { - mssError(1,"EXP","rtrim() only works on STRING data types"); - return -1; - } - if (tree->Alloc && tree->String) - { - nmSysFree(tree->String); - } - tree->Alloc = 0; - tree->DataType = DATA_T_STRING; - ptr = i0->String + strlen(i0->String); - while(ptr > i0->String && ptr[-1] == ' ') ptr--; - if (ptr == i0->String + strlen(i0->String)) - { - /** optimization for strings are still the same **/ - tree->String = i0->String; - } - else - { - /** have to copy because we removed spaces **/ - n = ptr - i0->String; - if (n < 63) + /** Expect one nullable string parameter. **/ + if (exp_fn_i_verify_schema((ArgExpect[]){ + {(int[]){DATA_T_STRING, -1}, EXP_ARG_NO_FLAGS}, + EXP_ARG_END, + }, tree) != 0) { - tree->String = tree->Types.StringBuf; - memcpy(tree->String, i0->String, n); - tree->String[n] = '\0'; - tree->Alloc = 0; + mssErrorf(0, "EXP", "%s(?): Call does not match function schema.", tree->Name); + return -1; } - else + + /** Extract the arg string. **/ + pExpression maybe_str = check_ptr(tree->Children.Items[0]); + if (maybe_str->Flags & EXPR_F_NULL) { - tree->String = (char*)nmSysMalloc(n+1); - memcpy(tree->String, i0->String, n); - tree->String[n] = '\0'; - tree->Alloc = 1; + /** Propegate null values. **/ + tree->Flags |= EXPR_F_NULL; + tree->DataType = DATA_T_STRING; + return 0; } - } + char* str = maybe_str->String; + + /** Trim spaces from the end of the string. **/ + /** Note: Only spaces are trimmed, as with similar trim functions in most SQL languages. **/ + const int len = strlen(str); + int n = len; + while (n > 0 && str[n - 1] == ' ') n--; + + /** Optimization for strings that are still the same. **/ + if (n == len) + { + tree->String = str; + goto end; + } + + /** We need to copy to remove spaces. **/ + if (!check(exp_fn_i_alloc_result_string(tree, n + 1))) return -1; + memcpy(tree->String, str, n); + tree->String[n] = '\0'; + + end: + /** Return the results in the tree. **/ + tree->DataType = DATA_T_STRING; + tree->Alloc = 0; + + return 0; + } + + +/** Left and right trim spaces. **/ +int exp_fn_trim(pExpression tree) + { + /** Left trim the expression. **/ + exp_fn_ltrim(tree); + + /** Temporarily override the arg1 str pointer with the result from ltrim(). **/ + pExpression arg1 = tree->Children.Items[0]; + char* arg1_str = arg1->String; + arg1->String = tree->String; + tree->Alloc = 0; + + /** Right trim the expression, which will use the overriden string above. **/ + exp_fn_rtrim(tree); + + /** Restore the arg1 tree. **/ + arg1->String = arg1_str; + return 0; } @@ -3635,75 +3768,104 @@ int exp_fn_from_base64(pExpression tree, pParamObjects objlist, pExpression i0, return -1; } -static int exp_fn_i_do_math(pExpression tree, pParamObjects obj_list, const char* fn_name, double (*math)(), int arg_num) +static int exp_fn_i_do_math(pExpression tree, double (*math)(), int arg_num) { - /** Verify function schema: expect arg_num numeric values. **/ - ArgExpect expects[arg_num]; - for (int i = 0; i < arg_num; i++) - expects[i] = (ArgExpect){(int[]){DATA_T_INTEGER, DATA_T_DOUBLE, DATA_T_MONEY, -1}, EXP_ARG_NO_FLAGS}; - if (exp_fn_i_verify_schema(fn_name, expects, arg_num, tree, obj_list) != 0) - { - mssErrorf(0, "EXP", "%s(?): Call does not match function schema.", fn_name); - return -1; - } - - /** Null checks. **/ - for (int i = 0; i < arg_num; i++) - { - pExpression arg = tree->Children.Items[i]; - if (arg->Flags & EXPR_F_NULL) + /** Verify function schema: expect arg_num numeric values. **/ + ArgExpect expects[arg_num + 1]; + for (int i = 0; i < arg_num; i++) + expects[i] = (ArgExpect){(int[]){DATA_T_INTEGER, DATA_T_DOUBLE, DATA_T_MONEY, -1}, EXP_ARG_NO_FLAGS}; + expects[arg_num] = EXP_ARG_END; + if (exp_fn_i_verify_schema(expects, tree) != 0) { - tree->DataType = DATA_T_DOUBLE; - tree->Flags |= EXPR_F_NULL; - return 0; + mssErrorf(0, "EXP", "%s(?): Call does not match function schema.", tree->Name); + return -1; + } + + /** Null checks. **/ + for (int i = 0; i < arg_num; i++) + { + pExpression arg = tree->Children.Items[i]; + if (arg->Flags & EXPR_F_NULL) + { + tree->DataType = DATA_T_DOUBLE; + tree->Flags |= EXPR_F_NULL; + return 0; + } } - } - - /** Maximum supported args. **/ - if (arg_num > 4) - { - mssErrorf(1, "EXP", "%s(...): exp_fn_i_do_math() does not support functions with more than 4 arguments. If this is an issue, please increase the number of arguments here: %s:%d", fn_name, __FILE__, __LINE__); - return -1; - } - /** Get the numbers for the args. **/ - double n[4]; - for (int i = 0; i < arg_num; i++) - { - if (!check(exp_fn_i_get_number(tree->Children.Items[i], &(n[i])))) + /** Maximum supported args. **/ + if (arg_num > 4) { - mssErrorf(0, "EXP", "%s(...): Failed to get arg%d.", fn_name, i); + mssErrorf(1, "EXP", "%s(...): exp_fn_i_do_math() does not support functions with more than 4 arguments. If this is an issue, please increase the number of arguments here: %s:%d", tree->Name, __FILE__, __LINE__); return -1; } - } + + /** Get the numbers for the args. **/ + double n[4]; + for (int i = 0; i < arg_num; i++) + { + if (!check(exp_fn_i_get_number(tree->Children.Items[i], &(n[i])))) + { + mssErrorf(0, "EXP", "%s(...): Failed to get arg%d.", tree->Name, i); + return -1; + } + } + + /** Return results. **/ + tree->DataType = DATA_T_DOUBLE; + tree->Types.Double = math(n[0], n[1], n[2], n[3]); /* Call function with all supported args. */ - tree->DataType = DATA_T_DOUBLE; - tree->Types.Double = math(n[0], n[1], n[2], n[3]); /* Call function with max supported args. */ return 0; } -int exp_fn_log_natural(pExpression tree, pParamObjects obj_list) +int exp_fn_power(pExpression tree) { - return exp_fn_i_do_math(tree, obj_list, "ln", log, 1); + return exp_fn_i_do_math(tree, pow, 2); } -int exp_fn_log10(pExpression tree, pParamObjects obj_list) +int exp_fn_ln(pExpression tree) { - return exp_fn_i_do_math(tree, obj_list, "log10", log10, 1); + return exp_fn_i_do_math(tree, log, 1); } - -/** This is why we need lambdas in C. **/ -double exp_fn_i_log_base_n(double x, double base) +int exp_fn_log10(pExpression tree) { - return log(x) / log(base); + return exp_fn_i_do_math(tree, log10, 1); } -int exp_fn_log_base_n(pExpression tree, pParamObjects obj_list) - { - return exp_fn_i_do_math(tree, obj_list, "logn", exp_fn_i_log_base_n, 2); - } -int exp_fn_power(pExpression tree, pParamObjects obj_list) +int exp_fn_log(pExpression tree) { - return exp_fn_i_do_math(tree, obj_list, "power", pow, 2); + /** Verify function schema: A number and an optional base. **/ + if (exp_fn_i_verify_schema((ArgExpect[]){ + {(int[]){DATA_T_INTEGER, DATA_T_DOUBLE, DATA_T_MONEY, -1}, EXP_ARG_NO_FLAGS}, + {(int[]){DATA_T_INTEGER, DATA_T_DOUBLE, DATA_T_MONEY, -1}, EXP_ARG_OPTIONAL}, + EXP_ARG_END, + }, tree) != 0) + { + mssErrorf(0, "EXP", "%s(?): Call does not match function schema.", tree->Name); + return -1; + } + + /** Extract args. **/ + double number, base; + if (!check(exp_fn_i_get_number(check_ptr(tree->Children.Items[0]), &number))) + { + mssErrorf(0, "EXP", "%s(...): Failed to get arg1 (number).", tree->Name); + return -1; + } + if (tree->Children.nItems > 1) + { + if (!check(exp_fn_i_get_number(check_ptr(tree->Children.Items[1]), &base))) + { + mssErrorf(0, "EXP", "%s(...): Failed to get arg2 (base).", tree->Name); + return -1; + } + } + else base = M_E; + + /** Return the results in the tree. **/ + tree->DataType = DATA_T_DOUBLE; + tree->Types.Double = log(number) / log(base); + + return 0; } @@ -4371,10 +4533,10 @@ int exp_fn_metaphone(pExpression tree, pParamObjects obj_list) const char fn_name[] = "metaphone"; /** Verify function schema. **/ - if (exp_fn_i_verify_schema(fn_name, - (ArgExpect[]){{(int[]){DATA_T_STRING, -1}, EXP_ARG_NO_FLAGS}}, 1, - tree, obj_list - ) != 0) + if (exp_fn_i_verify_schema((ArgExpect[]){ + {(int[]){DATA_T_STRING, -1}, EXP_ARG_NO_FLAGS}, + EXP_ARG_END, + }, tree) != 0) { mssErrorf(0, "EXP", "%s(?): Call does not match function schema.", fn_name); return -1; @@ -4404,27 +4566,11 @@ int exp_fn_metaphone(pExpression tree, pParamObjects obj_list) /** Compute DoubleMetaphone. **/ meta_double_metaphone(str, &primary, &secondary); - /** Find memory to store the result. **/ - store_data:; - const size_t result_length = strlen(primary) + 1u + strlen(secondary) + 1u; - if (tree->Alloc == 1) nmSysFree(tree->String); - if (result_length < 64) - { - /** We can use the preallocated buffer. **/ - tree->String = tree->Types.StringBuf; - tree->Alloc = 0; - } - else - { - char* result = check_ptr(nmSysMalloc(result_length * sizeof(char*))); - if (result == NULL) return -1; - tree->String = result; - } - - /** Write the result into the selected memory. **/ + /** Store the results. **/ + store_data:; + const size_t length = strlen(primary) + 1lu + strlen(secondary) + 1lu; + if (!check(exp_fn_i_alloc_result_string(tree, length))) return -1; sprintf(tree->String, "%s%c%s", primary, CA_BOUNDARY_CHAR, secondary); - - /** Return the result. **/ tree->DataType = DATA_T_STRING; return 0; @@ -4443,13 +4589,11 @@ int exp_fn_metaphone(pExpression tree, pParamObjects obj_list) static int exp_fn_compare(pExpression tree, pParamObjects obj_list, const char* fn_name) { /** Verify function schema. **/ - if (exp_fn_i_verify_schema(fn_name, - (ArgExpect[]){ + if (exp_fn_i_verify_schema((ArgExpect[]){ + {(int[]){DATA_T_STRING, -1}, EXP_ARG_NO_FLAGS}, {(int[]){DATA_T_STRING, -1}, EXP_ARG_NO_FLAGS}, - {(int[]){DATA_T_STRING, -1}, EXP_ARG_NO_FLAGS} - }, 2, - tree, obj_list - ) != 0) + EXP_ARG_END, + }, tree) != 0) { mssErrorf(0, "EXP", "%s(?): Call does not match function schema.", fn_name); return -1; @@ -4530,13 +4674,11 @@ int exp_fn_levenshtein(pExpression tree, pParamObjects obj_list) const char fn_name[] = "levenshtein"; /** Verify function schema. **/ - if (exp_fn_i_verify_schema(fn_name, - (ArgExpect[]){ + if (exp_fn_i_verify_schema((ArgExpect[]){ + {(int[]){DATA_T_STRING, -1}, EXP_ARG_NO_FLAGS}, {(int[]){DATA_T_STRING, -1}, EXP_ARG_NO_FLAGS}, - {(int[]){DATA_T_STRING, -1}, EXP_ARG_NO_FLAGS} - }, 2, - tree, obj_list - ) != 0) + EXP_ARG_END, + }, tree) != 0) { mssErrorf(0, "EXP", "%s(?): Call does not match function schema.", fn_name); return -1; @@ -4714,6 +4856,7 @@ int exp_internal_DefineFunctions() xhAdd(&EXP.Functions, "ltrim", (char*)exp_fn_ltrim); xhAdd(&EXP.Functions, "lztrim", (char*)exp_fn_lztrim); xhAdd(&EXP.Functions, "rtrim", (char*)exp_fn_rtrim); + xhAdd(&EXP.Functions, "trim", (char*)exp_fn_trim); xhAdd(&EXP.Functions, "substring", (char*)exp_fn_substring); xhAdd(&EXP.Functions, "right", (char*)exp_fn_right); xhAdd(&EXP.Functions, "ralign", (char*)exp_fn_ralign); @@ -4748,8 +4891,8 @@ int exp_internal_DefineFunctions() xhAdd(&EXP.Functions, "hash", (char*)exp_fn_hash); xhAdd(&EXP.Functions, "hmac", (char*)exp_fn_hmac); xhAdd(&EXP.Functions, "log10", (char*)exp_fn_log10); - xhAdd(&EXP.Functions, "ln", (char*)exp_fn_log_natural); - xhAdd(&EXP.Functions, "logn", (char*)exp_fn_log_base_n); + xhAdd(&EXP.Functions, "ln", (char*)exp_fn_ln); + xhAdd(&EXP.Functions, "log", (char*)exp_fn_log); xhAdd(&EXP.Functions, "power", (char*)exp_fn_power); xhAdd(&EXP.Functions, "pbkdf2", (char*)exp_fn_pbkdf2); xhAdd(&EXP.Functions, "metaphone", (char*)exp_fn_metaphone); diff --git a/centrallix/multiquery/multiquery.c b/centrallix/multiquery/multiquery.c index 5ba4f10c0..438c011fa 100644 --- a/centrallix/multiquery/multiquery.c +++ b/centrallix/multiquery/multiquery.c @@ -1046,11 +1046,14 @@ mq_internal_ParseSelectItem(pQueryStructure item_qs, pLxSession lxs) n_tok = 0; while(1) { + /** Get the next token. **/ t = mlxNextToken(lxs); if (t == MLX_TOK_ERROR || t == MLX_TOK_EOF) break; n_tok++; - if ((t == MLX_TOK_RESERVEDWD || t == MLX_TOK_COMMA || t == MLX_TOK_SEMICOLON) && parenlevel <= 0) + + /** Special handling for certain token types. **/ + if ((t == MLX_TOK_COMMA || t == MLX_TOK_SEMICOLON) && parenlevel <= 0) break; if (t == MLX_TOK_OPENPAREN) parenlevel++; @@ -1061,9 +1064,19 @@ mq_internal_ParseSelectItem(pQueryStructure item_qs, pLxSession lxs) break; } - /** Copy it to the raw data **/ + /** Get the token string. **/ ptr = mlxStringVal(lxs,NULL); if (!ptr) break; + + /** Skip all reserved words except log(). **/ + if (t == MLX_TOK_RESERVEDWD && parenlevel <= 0) + { + /** Treat "log" as a keyword to allow the log function to be handled properly. **/ + if (strcmp(ptr, "log") == 0) t = MLX_TOK_KEYWORD; + else break; + }; + + /** Copy the token string into item_qs->RawData. **/ if (t == MLX_TOK_STRING) xsConcatQPrintf(&item_qs->RawData, "%STR&DQUOT", ptr); else diff --git a/centrallix/tests/test_expfn_log_00.cmp b/centrallix/tests/test_expfn_log_00.cmp index c072b68f2..130056813 100644 --- a/centrallix/tests/test_expfn_log_00.cmp +++ b/centrallix/tests/test_expfn_log_00.cmp @@ -16,19 +16,28 @@ Attribute [log10(0.01)]: double -2.0 Attribute [log10(1.234)]: double 0.09131516 Attribute [log10(1e-10)]: double -10.0 Attribute [log10(1e10)]: double 10.0 -Attribute [logn(8, 2)]: double 3.0 -Attribute [logn(1000, 10)]: double 3.0 -Attribute [logn(10, 0)]: double -0.0 -Attribute [logn(10, 1)]: double inf.0 -Attribute [logn(8, -2)]: double nan.0 -Attribute [logn(0, 2)]: double -inf.0 -Attribute [logn(-8, 2)]: double nan.0 -Attribute [logn(1, 2)]: double 0.0 -Attribute [logn(1e10, 10)]: double 10.0 -Attribute [logn(8, 0.5)]: double -3.0 +Attribute [log(8, 2)]: double 3.0 +Attribute [log(1000, 10)]: double 3.0 +Attribute [log(10, 0)]: double -0.0 +Attribute [log(10, 1)]: double inf.0 +Attribute [log(8, -2)]: double nan.0 +Attribute [log(0, 2)]: double -inf.0 +Attribute [log(-8, 2)]: double nan.0 +Attribute [log(1, 2)]: double 0.0 +Attribute [log(1e10, 10)]: double 10.0 +Attribute [log(8, 0.5)]: double -3.0 +Attribute [log(1)]: integer 1 +Attribute [log(e)]: integer 1 +Attribute [log(0)]: integer 1 +Attribute [log(-1)]: integer 1 +Attribute [log(10)]: integer 1 +Attribute [log(1.5)]: integer 1 +Attribute [log(1e-10)]: integer 1 +Attribute [log(1e10)+]: integer 1 +Attribute [log(1e10)-]: integer 1 Attribute [ln(2.718281828)]: double 1.0 Attribute [log10(3.14159)]: double 0.49714951 -Attribute [logn(10, 1.1)]: double 0.04139269 -Attribute [logn(1.1, 10)]: double 24.15885793 -Attribute [logn(10, 0.001)]: double -3.0 -Attribute [logn(0.1, 1000)]: double -3.0 +Attribute [log(10, 1.1)]: double 0.04139269 +Attribute [log(1.1, 10)]: double 24.15885793 +Attribute [log(10, 0.001)]: double -3.0 +Attribute [log(0.1, 1000)]: double -3.0 diff --git a/centrallix/tests/test_expfn_log_00.to b/centrallix/tests/test_expfn_log_00.to index e454e4003..c73140236 100644 --- a/centrallix/tests/test_expfn_log_00.to +++ b/centrallix/tests/test_expfn_log_00.to @@ -12,33 +12,44 @@ query select 'ln(1e10)+' = ln(10000000000.0) > 23.0 -- Expect true (value query select 'ln(1e10)-' = ln(10000000000.0) < 23.1 -- Expect true (value is ~23.02585). # Log base 10: log10(x) -query select 'log10(1)' = log10(1) -- Expect 0. -query select 'log10(10)' = log10(10) -- Expect 1. -query select 'log10(0)' = log10(0) -- Expect -inf. -query select 'log10(-10)' = log10(-10) -- Expect NaN. -query select 'log10(100)' = log10(100) -- Expect 2. -query select 'log10(0.01)' = log10(0.01) -- Expect -2. -query select 'log10(1.234)' = round(log10(1.234), 8) -- Expect ~0.091315. -query select 'log10(1e-10)' = log10(0.0000000001) -- Expect ~-10. -query select 'log10(1e10)' = log10(10000000000.0) -- Expect ~10. +query select 'log10(1)' = log10(1) -- Expect 0. +query select 'log10(10)' = log10(10) -- Expect 1. +query select 'log10(0)' = log10(0) -- Expect -inf. +query select 'log10(-10)' = log10(-10) -- Expect NaN. +query select 'log10(100)' = log10(100) -- Expect 2. +query select 'log10(0.01)' = log10(0.01) -- Expect -2. +query select 'log10(1.234)' = round(log10(1.234), 8) -- Expect ~0.091315. +query select 'log10(1e-10)' = log10(0.0000000001) -- Expect ~-10. +query select 'log10(1e10)' = log10(10000000000.0) -- Expect ~10. -# General base n of x: logn(x, n) +# General base n of x: log(x, n) # Edge cases: base <= 0 or base == 1 (invalid), x <= 0 (invalid) -query select 'logn(8, 2)' = logn(8, 2) -- Expect 3. -query select 'logn(1000, 10)' = logn(1000, 10) -- Expect 3. -query select 'logn(10, 0)' = logn(10, 0) -- Expect -0.0 (base 0 is undefined). -query select 'logn(10, 1)' = logn(10, 1) -- Expect inf (base 1 is undefined). -query select 'logn(8, -2)' = logn(8, -2) -- Expect NaN (negative base). -query select 'logn(0, 2)' = logn(0, 2) -- Expect -inf (x=0). -query select 'logn(-8, 2)' = logn(-8, 2) -- Expect NaN or error (x negative). -query select 'logn(1, 2)' = logn(1, 2) -- Expect 0. -query select 'logn(1e10, 10)' = logn(10000000000.0, 10) -- Expect 10. -query select 'logn(8, 0.5)' = logn(8, 0.5) -- Expect negative value. +query select 'log(8, 2)' = log(8, 2) -- Expect 3. +query select 'log(1000, 10)' = log(1000, 10) -- Expect 3. +query select 'log(10, 0)' = log(10, 0) -- Expect -0.0 (base 0 is undefined). +query select 'log(10, 1)' = log(10, 1) -- Expect inf (base 1 is undefined). +query select 'log(8, -2)' = log(8, -2) -- Expect NaN (negative base). +query select 'log(0, 2)' = log(0, 2) -- Expect -inf (x=0). +query select 'log(-8, 2)' = log(-8, 2) -- Expect NaN or error (x negative). +query select 'log(1, 2)' = log(1, 2) -- Expect 0. +query select 'log(1e10, 10)' = log(10000000000.0, 10) -- Expect 10. +query select 'log(8, 0.5)' = log(8, 0.5) -- Expect negative value. + +# log(x) = ln(x) +query select 'log(1)' = (log(1) == ln(1)) +query select 'log(e)' = (log(2.71828182845) == ln(2.71828182845)) +query select 'log(0)' = (log(0) == ln(0)) +query select 'log(-1)' = (log(-1) == ln(-1)) +query select 'log(10)' = (log(10) == ln(10)) +query select 'log(1.5)' = (log(1.5) == ln(1.5)) +query select 'log(1e-10)' = (log(0.0000000001) == ln(0.0000000001)) +query select 'log(1e10)+' = (log(10000000000.0) == ln(10000000000.0)) +query select 'log(1e10)-' = (log(10000000000.0) == ln(10000000000.0)) -- Additional double/int mixed cases query select 'ln(2.718281828)' = round(ln(2.718281828), 8) -- Expect ~1 (close to e). query select 'log10(3.14159)' = round(log10(3.14159), 8) -- Expect ~0.49715. -query select 'logn(10, 1.1)' = round(logn(1.1, 10), 8) -- Expect 0.04139289. -query select 'logn(1.1, 10)' = round(logn(10, 1.1), 8) -- Expect 24.15885793. -query select 'logn(10, 0.001)' = round(logn(0.001, 10), 8) -- Expect ~-0.33333333... -query select 'logn(0.1, 1000)' = round(logn(1000, 0.1), 8) -- Expect ~-0.33333333... +query select 'log(10, 1.1)' = round(log(1.1, 10), 8) -- Expect 0.04139289. +query select 'log(1.1, 10)' = round(log(10, 1.1), 8) -- Expect 24.15885793. +query select 'log(10, 0.001)' = round(log(0.001, 10), 8) -- Expect ~-0.33333333... +query select 'log(0.1, 1000)' = round(log(1000, 0.1), 8) -- Expect ~-0.33333333... diff --git a/centrallix/tests/test_expfn_trim_00.cmp b/centrallix/tests/test_expfn_trim_00.cmp new file mode 100644 index 000000000..5515d9aa1 --- /dev/null +++ b/centrallix/tests/test_expfn_trim_00.cmp @@ -0,0 +1,10 @@ +Attribute [trim("White space on the left o]: string "No white space on the left or right side." +Attribute [trim(" White space on the l]: string "White space on the left side." +Attribute [trim("White space on the right ]: string "White space on the right side." +Attribute [trim(" White space on the r]: string "White space on the right and the left side." +Attribute [trim("With tab character ")]: string "With tab character " +Attribute [trim("With newline character +")]: string "With newline character +" +Attribute [trim("")]: string "" +Attribute [trim(null)]: string NULL diff --git a/centrallix/tests/test_expfn_trim_00.to b/centrallix/tests/test_expfn_trim_00.to new file mode 100644 index 000000000..746de6ebc --- /dev/null +++ b/centrallix/tests/test_expfn_trim_00.to @@ -0,0 +1,19 @@ +##NAME trim() function + +query select 'trim("White space on the left or right side.")' = trim("No white space on the left or right side.") + +query select 'trim(" White space on the left side.")' = trim(" White space on the left side.") + +query select 'trim("White space on the right side. ")' = trim("White space on the right side. ") + +query select 'trim(" White space on the right and the left side. ")' = trim(" White space on the right and the left side. ") + +query select 'trim("With tab character\t")' = trim("With tab character\t") + +query select 'trim("With newline character\n")' = trim("With newline character\n") + +# query select 'trim("\r With carriage return character.")' = trim("\r With carriage return character") + +query select 'trim("")' = trim("") + +query select 'trim(null)' = trim(null) From 8c86b5feb473b0243ca8f8a44b7e453079701131 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Thu, 11 Dec 2025 17:15:38 -0700 Subject: [PATCH 034/275] Organize docs. Move docs for newmalloc, xarray, xhash, xstring, mtsession, and mtask out of OSDriver_Authoring.md and into their own files. Add the imported date to OSDriver_Authoring.md. --- centrallix-sysdoc/Libraries/mtask.md | 95 +++ centrallix-sysdoc/Libraries/mtsession.md | 141 +++++ centrallix-sysdoc/Libraries/newmalloc.md | 168 ++++++ centrallix-sysdoc/Libraries/xarray.md | 219 +++++++ centrallix-sysdoc/Libraries/xhash.md | 126 ++++ centrallix-sysdoc/Libraries/xstring.md | 298 +++++++++ centrallix-sysdoc/OSDriver_Authoring.md | 733 +---------------------- 7 files changed, 1057 insertions(+), 723 deletions(-) create mode 100644 centrallix-sysdoc/Libraries/mtask.md create mode 100644 centrallix-sysdoc/Libraries/mtsession.md create mode 100644 centrallix-sysdoc/Libraries/newmalloc.md create mode 100644 centrallix-sysdoc/Libraries/xarray.md create mode 100644 centrallix-sysdoc/Libraries/xhash.md create mode 100644 centrallix-sysdoc/Libraries/xstring.md diff --git a/centrallix-sysdoc/Libraries/mtask.md b/centrallix-sysdoc/Libraries/mtask.md new file mode 100644 index 000000000..e3395ce0e --- /dev/null +++ b/centrallix-sysdoc/Libraries/mtask.md @@ -0,0 +1,95 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +# Handling Network Connection + +**Author**: Greg Beeley + +**Date**: January 13, 1999 + +**Updated**: December 11, 2025 + +**License**: Copyright (C) 2001-2025 LightSys Technology Services. See LICENSE.txt for more information. + + +## Table of Contents +- [Handling Network Connection](#the-mtsession-library) + - [Introduction](#introduction) + - [netConnectTCP()](#netconnecttcp) + - [netCloseTCP()](#netclosetcp) + - [fdWrite()](#fdwrite) + - [fdRead()](#fdread) + + +## Introduction +The `MTASK` module provides simple and easy TCP/IP connectivity. It includes many functions, only a few of which are documented below: + +- ⚠️ **Warning**: This documentation is incomplete, as many relevant functions are not explained here. You can help by expanding it. + + +## netConnectTCP() +```c +pFile netConnectTCP(char* host_name, char* service_name, int flags); +``` +This function creates a client socket and connects it to a server on a given TCP service/port and host name. It takes the following three parameters: +- `host_name`: The host name or ascii string for the host's ip address. +- `service_name`: The name of the service (from `/etc/services`) or its numeric representation as a string. +- `flags`: Normally left 0. + +- 📖 **Note**: The `NET_U_NOBLOCK` flag causes the function to return immediately even if the connection is still being established. Further reads and writes will block until the connection either establishes or fails. + +This function returns the connection file descriptor if successful, or `NULL` if an error occurs. + + +## netCloseTCP() +```c +int netCloseTCP(pFile net_filedesc, int linger_msec, int flags); +``` +This function closes a network connection (either a TCP listening, server, or client socket). It will also optionally waits up to `linger_msec` milliseconds (1/1000 seconds) for any data written to the connection to make it to the other end before performing the close. If `linger_msec` is set to 0, the connection is aborted (reset). The linger time can be set to 1000 msec or so if no writes were performed on the connection prior to the close. If a large amount of writes were performed immediately prior to the close, offering to linger for a few more seconds (perhaps 5 or 10 by specifying 5000 or 10000 msec) can be a good idea. + + +## fdWrite() +```c +int fdWrite(pFile filedesc, char* buffer, int length, int offset, int flags); +``` +This function writes data to an open file descriptor, from a given `buffer` and `length` of data to write. It also takes an optional seek `offset` and and `flags`, which can be zero or more of: +- `FD_U_NOBLOCK` - If the write can't be performed immediately, don't perform it at all. +- `FD_U_SEEK` - The `offset` value is valid. Seek to it before writing. Not allowed for network connections. +- `FD_U_PACKET` - *ALL* of the data specified by `length` in `buffer` must be written. Normal `write()` semantics in UNIX state that not all data has to be written, and the number of bytes actually written is returned. Setting this flag makes sure all data is really written before returning. + + +## fdRead() +```c +int fdRead(pFile filedesc, char* buffer, int maxlen, int offset, int flags); +``` +This function works the same as [`fdWrite()`](#fdwrite) except that it reads data instead of writing it. It takes the same flags as above, except that `FD_U_PACKET` now requires that all of `maxlen` bytes must be read before returning. This is good for reading a packet of a known length that might be broken up into fragments by the network (TCP/IP has a maximum frame transmission size of about 1450 bytes). diff --git a/centrallix-sysdoc/Libraries/mtsession.md b/centrallix-sysdoc/Libraries/mtsession.md new file mode 100644 index 000000000..a6c946e4d --- /dev/null +++ b/centrallix-sysdoc/Libraries/mtsession.md @@ -0,0 +1,141 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +# The MTSession Library + +**Author**: Greg Beeley + +**Date**: January 13, 1999 + +**Updated**: December 11, 2025 + +**License**: Copyright (C) 2001-2025 LightSys Technology Services. See LICENSE.txt for more information. + + +## Table of Contents +- [The MTSession Library](#the-mtsession-library) + - [Introduction](#introduction) + - [mssUserName()](#mssusername) + - [mssPassword()](#msspassword) + - [mssSetParam()](#msssetparam) + - [mssGetParam()](#mssgetparam) + - [mssError()](#msserror) + - [mssErrorErrno()](#msserrorerrno) + + +## Introduction +The mtsession (MSS) module is used for session authentication, error reporting, and for storing session-wide variables such as the current date format, username, and password (used when issuing a login request to a remote server). Care should be taken in the use of Centrallix that its coredump files are NOT in a world-readable location, as the password will be visible in the coredump file (or just ulimit the core file size to 0). + + +- ⚠️ **Warning**: This documentation is incomplete, as several relevant functions are not explained here. You can help by expanding it. + + +## mssInitialize() +```c +int mssInitialize(char* authmethod, char* authfile, char* logmethod, int logall, char* log_progname); +``` +This function initializes the session manager and sets global variables used in this module. It returns 0 if successful and -1 if an error occurs. + + +## mssUserName() +```c +char* mssUserName(); +``` +This function returns the current user name, or `NULL` an error occurs. + + +## mssPassword() +```c +char* mssPassword(); +``` +This function returns the current user's password that they used to log into Centrallix, or `NULL` an error occurs. + + +## mssSetParam() +```c +int mssSetParam(char* paramname, char* param); +``` +This function sets the session parameter of the provided name (`paramname`) to the provided value (`param`). The parameter MUST be a string value. This function returns 0 if successful, or -1 an error occurs. + + +## mssGetParam() +```c +char* mssGetParam(char* paramname); +``` +Returns the value of a session parameter of the provided name (`paramname`), or `NULL` if an error occurs. Common session parameters include: +- `dfmt`: The current date format. +- `mfmt`: The current money format. +- `textsize`: The current max text size from a read of an object's content via `objGetAttrValue(obj, "objcontent", POD(&str))` + + +## mssError() +```c +int mssError(int clr, char* module, char* message, ...); +``` +Formats and caches an error message for return to the user. This function returns 0 if successful, or -1 if an error occurred. + +| Parameter | Type | Description +| --------- | ------------- | ------------ +| crl | int | If set to 1, all previous error messages are cleared. Set this when the error is initially discovered and no other module is likely to have made a relevant `mssError()` call for the current error. +| module | char* | A two-to-five letter abbreviation of the module reporting the error. This is typically the module or driver's abbreviation prefix in full uppercase letters (although that is not required). This is intended to help the developer find the source of the error faster. +| message | char* | A string error message, accepting format specifiers like `%d` and `%s` which are supplied by the argument list, similar to `printf()`. +| ... | ... | Parameters for the formatting. + +Errors that occur inside a session context are normally stored up and not printed until other MSS module routines are called to fetch the errors. Errors occurring outside a session context (such as in Centrallix's network listener) are printed to Centrallix's standard output immediately. + +The `mssError()` function is not required to be called at every function nesting level when an error occurs. For example, if the expression compiler returns -1 indicating that a compilation error occurred, it has probably already added one or more error messages to the error list. The calling function should only call `mssError()` if doing so would provide additional context or other useful information (e.g. _What_ expression failed compilation? _Why_ as an expression being compiled? etc.). However, it is far easier to give too little information that too much, so it can often be best to air on the side of calling `mssError()` with information that might be irrelevant, rather than skipping it and leaving the developer confused. + +- 📖 **Note**: The `mssError()` routines do not cause the calling function to return or exit. The function must still clean up after itself and return an appropriate value (such as `-1` or `NULL`) to indicate failure. + +- ⚠️ **Warning**: Even if `-1` is returned, the error message may still be sent to the user in some scenarios. This is not guaranteed, though. + +- ⚠️ **Warning**: `%d` and `%s` are the ONLY supported format specifier for this function. **DO NOT** use any other format specifiers like `%lf`, `%u`, `%lu`, `%c` etc. **DO NOT** attempt to include `%%` for a percent symbol in your error message, as misplaced percent symbols often break this function. If you wish to use these features of printf, it is recommended to print the error message to a buffer and pass that buffer to `mssError()`, as follows: + ```c + char err_buf[256]; + snprintf(err_buf, sizeof(err_buf), + "Incorrect values detected: %u, %g (%lf), '%c'", + unsigned_int_value, double_value, char_value + ); + if (mssError(1, "EXMPL", "%s", err_buf) != 0) + { + fprintf(stderr, "ERROR! %s\n", err_buf); + } + return -1; + ``` + + + +## mssErrorErrno() +```c +int mssErrorErrno(int clr, char* module, char* message, ...); +``` +This function works the same way as [`mssError`](#mssError), except checks the current value of `errno` and includes a description of any error stored there. This is useful if a system call or other library function is responsible for this error. diff --git a/centrallix-sysdoc/Libraries/newmalloc.md b/centrallix-sysdoc/Libraries/newmalloc.md new file mode 100644 index 000000000..c77d90f12 --- /dev/null +++ b/centrallix-sysdoc/Libraries/newmalloc.md @@ -0,0 +1,168 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +# Memory Management in Centrallix + +**Author**: Greg Beeley + +**Date**: January 13, 1999 + +**Updated**: December 11, 2025 + +**License**: Copyright (C) 2001-2025 LightSys Technology Services. See LICENSE.txt for more information. + + +## Table of Contents +- [Memory Management in Centrallix](#objectsystem-driver-interface) + - [Introduction](#introduction) + - [nmMalloc()](#nmmalloc) + - [nmFree()](#nmfree) + - [nmStats()](#nmstats) + - [nmRegister()](#nmregister) + - [nmDebug()](#nmdebug) + - [nmDeltas()](#nmdeltas) + - [nmSysMalloc()](#nmsysmalloc) + - [nmSysRealloc()](#nmsysrealloc) + - [nmSysStrdup()](#nmsysstrdup) + - [nmSysFree()](#nmsysfree) + + +## Introduction +Centrallix has its own memory management wrapper that caches deallocated blocks of memory by size for faster reuse. This wrapper also detects double-freeing of blocks (sometimes), making debugging of memory problems just a little bit easier. + +In addition, the memory manager provides statistics on the hit ratio of allocated blocks coming from the lists vs. `malloc()`, and on how many blocks of each size/type are `malloc()`ed and cached. This information can be helpful for tracking down memory leaks. Empirical testing has shown an increase of performance of around 50% or more in programs that use newmalloc. + +One caveat is that this memory manager does not provide `nmRealloc()` function, only `nmMalloc()` and `nmFree()`. Thus, either `malloc()`, `free()`, and `realloc()` or [`nmSysMalloc()`](#nmsysmalloc), [`nmSysFree()`](#nmsysfree), and [`nmSysRealloc()`](#nmsysrealloc) should be used for blocks of memory that might vary in size. + +The newmalloc module can be accessed by adding `#include "cxlib/newmalloc.h"` to the include section of a .c file in centrallix, or `#include "newmalloc.h"` in centrallix-lib. + +- 📖 **Note**: This memory manager is usually the wrong choice for blocks of memory of arbitrary, inconsistent sizes. It is intended for allocating structures quickly that are of a specific size. For example, allocated space for a struct that is always the same size. + +- 🥱 **tl;dr**: Use `nmMalloc()` for structs, not for strings. + +- ⚠️ **Warning**: Do not mix and match, even though calling `free()` on a block obtained from `nmMalloc()` or calling `nmFree()` on a block obtained from `malloc()` might not crash the program immediately. However, it may result in either inefficient use of the memory manager, or a significant memory leak, respectively. These practices will also lead to incorrect results from the statistics and block count mechanisms. + +The newmalloc module provides the following functions: + + +## nmMalloc() +```c +void* nmMalloc(int size); +``` +This function allocates a block of the given `size`. It returns `NULL` if the memory could not be allocated. + + +## nmFree() +```c +void nmFree(void* ptr, int size); +``` +This function frees the block of memory. + +- ⚠️ **Warning**: The caller **must know the size of the block.** Getting this wrong is very bad!! For structures, this is trivial, simply use `sizeof()`, exactly the same as with `nmMalloc()`. + + +## nmStats() +```c +void nmStats(void); +``` +Prints statistics about the memory manager, for debugging and optimizing. + +For example: +``` +NewMalloc subsystem statistics: + nmMalloc: 20244967 calls, 19908369 hits (98.337%) + nmFree: 20233966 calls + bigblks: 49370 too big, 32768 largest size +``` + +- ⚠️ **Warning**: Centrallix-lib must be built with the configure option `--enable-debugging` for this function to work. Otherwise, all the stats will be zeros. + + +## nmRegister() +```c +void nmRegister(int size, char* name); +``` +Registers an inteligent name for block of the specified size. This allows the memory manager to give more information when reporting block allocation counts. A given size can have more than one name. This function is optional and not required for any production usecases, but using it can make tracking down memory leaks easier. + +This function is usually called in a module's `Initialize()` function on each of the structures the module uses internally. + + +## nmDebug() +```c +void nmDebug(void); +``` +Prints a listing of block allocation counts, giving (by size): +- The number of blocks allocated but not yet freed. +- The number of blocks in the cache. +- The total allocations for this block size. +- A list of names (from [`nmRegister()`](#nmregister)) for that block size. + + +## nmDeltas() +```c +void nmDeltas(void); +``` +Prints a listing of all blocks whose allocation count has changed, and by how much, since the last `nmDeltas()` call. This function is VERY USEFUL FOR MEMORY LEAK DETECTIVE WORK. + + +## nmSysMalloc() +```c +void* nmSysMalloc(int size); +``` +Allocates memory without using the block-caching algorithm. This is roughly equivalent to `malloc()`, but pointers returned by malloc and this function are not compatible - i.e., you cannot `free()` something that was [`nmSysMalloc()`](#nmsysmalloc)'ed, nor can you [`nmSysFree()`](#nmsysfree) something that was `malloc()`'ed. + +- 📖 **Note**: This function is much better to use on variable-sized blocks of memory. `nmMalloc()` is better for fixed-size blocks, such as for structs. + + +## nmSysRealloc() +```c +void* nmSysRealloc(void* ptr, int newsize); +``` +Changes the size of an allocated block of memory that was obtained from [`nmSysMalloc()`](#nmsysmalloc), [`nmSysRealloc()`](#nmsysrealloc), or [`nmSysStrdup()`](#nmsysstrdup). The new pointer may be different if the block needs to be moved. This is the rough equivalent of `realloc()`. + +- 📖 **Note**: If you are `realloc()`'ing a block of memory and need to store pointers to data somewhere inside the block, it is often better to store an offset rather than a full pointer. This is because a full pointer becomes invalid if a [`nmSysRealloc()`](#nmsysrealloc) causes the block to move. + + +## nmSysStrdup() +```c +char* nmSysStrdup(const char* str); +``` +Allocates memory using the [`nmSysMalloc()`](#nmsysmalloc) function and copies the string `str` into this memory. It is a rough equivalent of `strdup()`. The resulting pointer can be free'd using [`nmSysFree()`](#nmsysfree). + + +## nmSysFree() +```c +void nmSysFree(void* ptr); +``` +Frees a block of memory allocated by [`nmSysMalloc()`](#nmsysmalloc), [`nmSysRealloc()`](#nmsysrealloc), or [`nmSysStrdup()`](#nmsysstrdup). diff --git a/centrallix-sysdoc/Libraries/xarray.md b/centrallix-sysdoc/Libraries/xarray.md new file mode 100644 index 000000000..48004cc1d --- /dev/null +++ b/centrallix-sysdoc/Libraries/xarray.md @@ -0,0 +1,219 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +# The XArray Library + +**Author**: Greg Beeley + +**Date**: January 13, 1999 + +**Updated**: December 11, 2025 + +**License**: Copyright (C) 2001-2025 LightSys Technology Services. See LICENSE.txt for more information. + + +## Table of Contents +- [The XArray Library](#the-xarray-library) + - [Introduction](#introduction) + - [xaNew()](#xanew) + - [xaFree()](#xafree) + - [xaInit()](#xainit) + - [xaDeInit()](#xadeinit) + - [xaAddItem()](#xaadditem) + - [xaAddItemSorted()](#xaadditemsorted) + - [xaAddItemSortedInt32()](#xaadditemsortedint32) + - [xaGetItem()](#xagetitem) + - [xaFindItem()](#xafinditem) + - [xaFindItemR()](#xafinditemr) + - [xaRemoveItem()](#xaremoveitem) + - [xaClear()](#xaclear) + - [xaClearR()](#xaclearr) + - [xaCount()](#xacount) + - [xaInsertBefore()](#xainsertbefore) + - [xaInsertAfter()](#xainsertafter) + + +## Introduction +The xarray (xa) module is intended to manage sized growable arrays, similar to a light-weight arraylist implementation. It includes the `XArray`, which has the following fields: +- `nItems : int`: The number of items in the array. +- `nAlloc : int`: Internal variable to store the size of the allocated memory. +- `Items : void**`: The allocated array of items. + +- 📖 **Note**: Some code occasionally sets `nAlloc` to 0 after an XArray struct has been deinitialized to indicate that the relevant data is no longer allocated. Other than this, it is only used internally by the library. + +- ⚠️ **Warning**: Do not mix calls to [`xaNew()`](#xanew)/[`xaFree()`](#xafree) with calls to [`xaInit()`](#xainit)/[`xaDeInit()`](#xadeinit). Every struct allocated using new must be freed, and ever struct allocated using init must be deinitted. Mixing these calls can lead to memory leaks, bad frees, and crashes. + + +## xaNew() +```c +pXArray xaNew(int init_size); +``` +Allocates a new `XArray` struct on the heap (using [`nmMalloc()`](#nmmalloc) for caching) and returns a pointer to it, or returns `NULL` if an error occurs. + + +## xaFree() +```c +int xaFree(pXArray this); +``` +Frees a `pXArray` allocated using [`xaNew`](#xanew), returning 0 if successful or -1 if an error occurs. + + +## xaInit() +```c +int xaInit(pXArray this, int init_size); +``` +This function initializes an allocated (but uninitialized) xarray. It makes room for `init_size` items initially, but this is only an optimization. A typical value for `init_size` is 16. Remember to [`xaDeInit`](#xadeinit) this xarray, do **not** [`xaFree`](#xafree) it. + +This function returns 0 on success, or -1 if an error occurs. + + +## xaDeInit() +```c +int xaDeInit(pXArray this); +``` +This function de-initializes an xarray, but does not free the XArray structure itself. This is useful if the structure is a local variable allocated using [`xaInit()`](#xainit). + +This function returns 0 on success, or -1 if an error occurs. + +For example: +```c +XArray arr; +if (xaInit(&arr, 16) != 0) goto handle_error; + +/** Use the xarray. **/ + +if (arr.nAlloc != 0 && xaDeInit(&arr) != 0) goto handle_error; +arr.nAlloc = 0; +``` + + +## xaAddItem() +```c +int xaAddItem(pXArray this, void* item); +``` +This function adds an item to the end of the xarray. The item is assumed to be a `void*`, but this function will _not_ follow pointeres stored in the array. Thus, other types can be typecast and stored into that location (such as an `int`). + +This function returns 0 on success, or -1 if an error occurs. + + +## xaAddItemSorted() +```c +int xaAddItemSorted(pXArray this, void* item, int keyoffset, int keylen); +``` +This function adds an item to a sorted xarray while maintaining the sorted property. The value for sorting is expected to begin at the offset given by `keyoffset` and continue for `keylen` bytes. This function _will_ follow pointers are stored in the array so casting other types to store them is not allowed (as it is with [`xaAddItem()`](#xaadditem)). + + +## xaAddItemSortedInt32() +```c +int xaAddItemSortedInt32(pXArray this, void* item, int keyoffset) +``` + + + +## xaGetItem() +```c +void* xaGetItem(pXArray this, int index) +``` +This function returns an item given a specific index into the xarray, or `NULL` if the index is out of bounds. If the bounds check needs to be omitted for performance and the caller can otherwise verify that no out of bounds read is possible (e.g. because they are iterating from 0 to `xarray->nItems`), the caller should access `xarray->Items` directly. Either way, the result may need to be typecasted or stored in a variable of a specific type for it to be useable, and error checking for `NULL` values should be used. + + +## xaFindItem() +```c +int xaFindItem(pXArray this, void* item); +``` +This function returns array index for the provided item in the array, or -1 if the item could not be found. Requires an exact match, so two `void*` pointing to different memory with identical contents are not considered equal by this function. If the data is actually another datatype typecasted as a `void*`, all 8 bytes must be identical for a match. + +For example: +```c +void* data = &some_data; + +XArray xa; +xaInit(&xa, 16); + +... + +xaAddItem(&xa, data); + +... + +int item_id = xaFindItem(&xa, data); +assert(data == xa.Items[item_id]); +``` + + +## xaFindItemR() +```c +int xaFindItemR(pXArray this, void* item); +``` +This function works the same as [`xaFindItem()`](#xafinditem), however it iterates in reverse, giving a slight performance boost, especially for finding items near the end of the array. + + +## xaRemoveItem() +```c +int xaRemoveItem(pXArray this, int index) +``` +This function removes an item from the xarray at the given the index, then shifts all following items back to fill the gap created by the removal. XArray is not optimized for removing multiple items efficiently. This function returns 0 on success, or -1 if an error occurs. + + +## xaClear() +```c +int xaClear(pXArray this, int (*free_fn)(), void* free_arg); +``` +This function removes all elements from the xarray, leaving it empty. `free_fn()` is invoked on each element with a `void*` to the element to be freed as the first argument and `free_arg` as the second argument (the return value of `free_fn()` is always ignored). This function returns 0 on success (even if the `free_fn()` returns an error), or -1 if an error is detected. + + +## xaClearR() +```c +int xaClearR(pXArray this, int (*free_fn)(), void* free_arg); +``` +This function works the same as [`xaClear()`](#xaclear), except that it is slightly faster because the free function is evaluated on items in reverse order. + + +## xaCount() +```c +int xaCount(pXArray this); +``` +This function returns the number of items in the xarray, or -1 on error. It is equivalent to accessing `xarray->nItems` (although the latter expression will not return an error). + + +## xaInsertBefore() +```c +int xaInsertBefore(pXArray this, int index, void* item) +``` +This function inserts an item before the specified index, moving all following items forward to make space. The new item cannot be inserted past the end of the array. This function returns the index on success, or -1 if an error occurs. + + +## xaInsertAfter() +```c +int xaInsertAfter(pXArray this, int index, void* item) +``` +This function inserts an item after the specified index, moving all following items forward to make space. The new item cannot be inserted past the end of the array. This function returns the index on success, or -1 if an error occurs. diff --git a/centrallix-sysdoc/Libraries/xhash.md b/centrallix-sysdoc/Libraries/xhash.md new file mode 100644 index 000000000..5d4ca8028 --- /dev/null +++ b/centrallix-sysdoc/Libraries/xhash.md @@ -0,0 +1,126 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +# The XHash Library + +**Author**: Greg Beeley + +**Date**: January 13, 1999 + +**Updated**: December 11, 2025 + +**License**: Copyright (C) 2001-2025 LightSys Technology Services. See LICENSE.txt for more information. + + +## Table of Contents +- [The XHash Library](#the-xhash-library) + - [Introduction](#introduction) + - [xhInitialize()](#xhinitialize) + - [xhInit()](#xhinit) + - [xhDeInit()](#xhdeinit) + - [xhAdd()](#xhadd) + - [xhRemove()](#xhremove) + - [xhLookup()](#xhlookup) + - [xhClear()](#xhclear) + - [xhForEach()](#xhforeach) + - [xhClearKeySafe()](#xhclearkeysafe) + + +## Introduction +The xhash (xh) module provides an extensible hash table interface. The hash table is a table of linked lists of items, so collisions and overflows are handled by this data structure (although excessive collisions still cause a performance loss). This implementation also supports variable-length keys for more flexible usecases. + +- ⚠️ **Warning**: All `xhXYZ()` function calls assume that the `pXHashTable this` arg points to a valid hashtable struct. All non-init functions assume that this struct has been validly initialized and has not yet been freed. If these conditions are not met, the resulting behavior is undefined. + + +## xhInitialize() +```c +int xhInitialize(); +``` +Initialize the random number table for hash computation, returning 0 on success or -1 if an error occurs. Normally, you can assume someone else has already called this during program startup. + + +## xhInit() +```c +int xhInit(pXHashTable this, int rows, int keylen); +``` +This function initializes a hash table, setting the number of rows and the key length. Specify a `keylen` of 0 for for variable length keys (aka. null-terminated strings). The `rows` should be an odd number, preferably prime (although that isn't required). `rows` **SHOULD NOT** be a power of 2. Providing this value allows the caller to optimize it based on how much data they expect to be stored in the hash table. If this value is set to 1, the hash search degenerates to a linear array search with extra overhead. Thus, the value should be large enough to comfortably accommodate the elements with minimal collisions. Typical values include 31, 251, or 255 (though 255 is not prime). + + +## xhDeInit() +```c +int xhDeInit(pXHashTable this); +``` +This function deinitializes a hash table struct, freeing all rows. Note that the stored data is not freed and neither are the keys as this data is assumed to be the responsibility of the caller. Returns 0 on success, or -1 if an error occurs. + + +## xhAdd() +```c +int xhAdd(pXHashTable this, char* key, char* data); +``` +Adds an item to the hash table, with a given key value and data pointer. Both data and key pointers must have a lifetime that exceeds the time that they item is hashed, as they are assumed to be the responsibility of the caller. This function returns 0 on success, or -1 if an error occurs. + + +## xhRemove() +```c +int xhRemove(pXHashTable this, char* key); +``` +This function removes an item with the given key value from the hash table. It returns 0 if the item was successfully removed, or -1 if an error occurs (including failing to find the item). + + +## xhLookup() +```c +char* xhLookup(pXHashTable this, char* key); +``` +This function returns a pointer to the data associated with the given key, or `NULL` if an error occurs (including failing to find the key). + + +## xhClear() +```c +int xhClear(pXHashTable this, int (*free_fn)(), void* free_arg); +``` +Clears all items from a hash table. If a `free_fn()` is provided, it will be invoked with each data pointer as the first argument and `free_arg` as the second argument as items are removed. The return value of the `free_fn()` is ignored. This function returns 0 on success (even if the `free_fn()` returns an error), or -1 if an error is detected. + + +## xhForEach() +```c +int xhForEach(pXHashTable this, int (*callback_fn)(pXHashEntry, void*), void* each_arg); +``` +This function executes an operation on each entry of the hash table entry. The provided callback function will be called with each entry (in an arbitrary order). This function is provided 2 parameters: the current hash table entry, and a `void*` argument specified using `each_arg`. If any invocation of the callback function returns a value other than 0, the `xhForEach()` will immediately fail, returning that value as the error code. + +This function returns 0 if the function executes successfully, 1 if the callback function is `NULL`, or n (where n != 0) if the callback function returns n. It does not return any error code other than 1 or any error codes returned by `callback_fn()`. + + +## xhClearKeySafe() +```c +int xhClearKeySafe(pXHashTable this, void (*free_fn)(pXHashEntry, void*), void* free_arg); +``` +This function clears all contents from the hash table. The free function is passed each hash entry struct and `free_arg`, allowing it to free both the value and key, if needed, and the free function is not allowed to return an error code. This function returns 0 for success as long as `free_fn()` is nonnull, otherwise it returns -1. diff --git a/centrallix-sysdoc/Libraries/xstring.md b/centrallix-sysdoc/Libraries/xstring.md new file mode 100644 index 000000000..4ecce289d --- /dev/null +++ b/centrallix-sysdoc/Libraries/xstring.md @@ -0,0 +1,298 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +# The XString Library + +**Author**: Greg Beeley + +**Date**: January 13, 1999 + +**Updated**: December 11, 2025 + +**License**: Copyright (C) 2001-2025 LightSys Technology Services. See LICENSE.txt for more information. + + +## Table of Contents +- [The XString Library](#the-xstring-library) + - [Introduction](#introduction) + - [xsNew()](#xsnew) + - [xsFree()](#xsfree) + - [xsInit()](#xsinit) + - [xsDeInit()](#xsdeinit) + - [xsCheckAlloc()](#xscheckalloc) + - [xsConcatenate()](#xsconcatenate) + - [xsCopy()](#xscopy) + - [xsStringEnd()](#xsstringend) + - [xsConcatPrintf()](#xsconcatprintf) + - [xsPrintf()](#xsprintf) + - [xsWrite()](#xswrite) + - [xsRTrim()](#xsrtrim) + - [xsLTrim()](#xsltrim) + - [xsTrim()](#xstrim) + - [xsFind()](#xsfind) + - [xsFindRev()](#xsfindrev) + - [xsSubst()](#xssubst) + - [xsReplace()](#xsreplace) + - [xsInsertAfter()](#xsinsertafter) + - [xsGenPrintf_va()](#xsgenprintf_va) + - [xsGenPrintf()](#xsgenprintf) + - [xsString()](#xsstring) + - [xsLength()](#xslength) + - [xsQPrintf_va(), xsQPrintf(), & xsConcatQPrintf()](#xsqprintf_va-xsqprintf--xsconcatqprintf) + + +## Introduction +The xstring (xs) module is used for managing growable strings. It is based on a structure containing a small initial string buffer to avoid string allocations for small strings. However, it can also perform `realloc()` operations to extend the string space for storing incrementally larger strings. This module allows for strings to contain arbitrary data, even NULL (`'\0'`) characters mid-string. Thus, it can also be used as an extensible buffer for arbitrary binary data. + +- 📖 **Note**: The contents of the XString can be easily referenced with the `xstring->String` field in the xstring struct. + +- ⚠️ **Warning**: Do not mix calls to [`xsNew()`](#xsnew)/[`xsFree()`](#xsfree) with calls to [`xsInit()`](#xsinit)/[`xsDeInit()`](#xsdeinit). Every struct allocated using new must be freed, and ever struct allocated using init must be deinitted. Mixing these calls can lead to memory leaks, bad frees, and crashes. + + +## xsNew() +```c +pXString xsNew() +``` +This function allocates a new XString structure to contain a new, empty string. It uses [`nmMalloc()`](#nmmalloc) because the XString struct is always a consistant size. This function returns a pointer to the new string if successful, or `NULL` if an error occurs. + + +## xsFree() +```c +void xsFree(pXString this); +``` +This function frees an XString structure allocated with [`xsNew()`](#xsnew), freeing all associated memory. + + +## xsInit() +```c +int xsInit(pXString this); +``` +This function initializes an XString structure to contain a new, empty string. This function returns 0 if successful, or -1 if an error occurs. + + +## xsDeInit() +```c +int xsDeInit(pXString this); +``` +This function deinitializes an XString structure allocated with [`xsInit()`](#xsinit), freeing all associated memory. This function returns 0 if successful, or -1 if an error occurs. + + +## xsCheckAlloc() +```c +int xsCheckAlloc(pXString this, int addl_needed); +``` +This function will optionally allocate more memory, if needed, given the currently occupied data area and the additional space required (specified with `addl_needed`). This function returns 0 if successful, or -1 if an error occurs. + + +## xsConcatenate() +```c +int xsConcatenate(pXString this, char* text, int len); +``` +This function concatenates the `text` string onto the end of the XString's value. If `len` is set, that number of characters are copied, including possible null characters (`'\0'`). If `len` is -1, all data up to the null-terminater is copied. This function returns 0 if successful, or -1 if an error occurs. + +- ⚠️ **Warning**: Do not store pointers to values within the string while adding text to the end of the string. The string may be reallocated to increase space, causing such pointers to break. Instead, use offset indexes into the string and calculate pointers on demand with `xs->String + offset`. + + For example, **DO NOT**: + ```c + XString xs; + if (xsInit(&xs) != 0) goto handle_error; + + if (xsConcatenate(&xs, "This is the first sentence. ", -1) != 0) goto handle_error; + char* ptr = xsStringEnd(&xs); /* Stores string pointer! */ + if (xsConcatenate(&xs, "This is the second sentence.", -1) != 0) goto handle_error; + + /** Print will probably read invalid memory. **/ + printf("A pointer to the second sentence is '%s'\n", ptr); + + ... + + if (xsDeInit(&xs) != 0) goto handle_error; + ``` + + Instead, use indexes and pointer arithmetic like this: + ```c + XString xs; + if (xsInit(&xs) != 0) goto handle_error; + + if (xsConcatenate(&xs, "This is the first sentence. ", -1) != 0) goto handle_error; + int offset = xsStringEnd(&xs) - xs->String; /* Stores index offset. */ + if (xsConcatenate(&xs, "This is the second sentence.", -1) != 0) goto handle_error; + + /** Print will probably work fine. **/ + printf("A pointer to the second sentence is '%s'\n", xs->String + offset); + + ... + + if (xsDeInit(&xs) != 0) goto handle_error; + ``` + + +## xsCopy() +```c +int xsCopy(pXString this, char* text, int len); +``` +This function copies the string `text` into the XString, overwriting any previous contents. This function returns 0 if successful, or -1 if an error occurs. + + +## xsStringEnd() +```c +char* xsStringEnd(pXString this); +``` +This function returns a pointer to the end of the string. This function is more efficient than searching for a null-terminator using `strlen()` because the xs module already knows the string length. Furthermore, since some string may contain nulls, using `strlen()` may produce an incorrect result. + + +## xsConcatPrintf() +```c +int xsConcatPrintf(pXString this, char* fmt, ...); +``` +This function prints additional data onto the end of the string. It is similar to printf, however, only the following features are supported: +- `%s`: Add a string (`char*`). +- `%d`: Add a number (`int`). +- `%X`: Add something? +- `%%`: Add a `'%'` character. +Attempting to use other features of printf (such as `%lf`, `%c`, `%u`, etc.) will cause unexpected results. + +This function returns 0 if successful, or -1 if an error occurs. + + +## xsPrintf() +```c +int xsPrintf(pXString this, char* fmt, ...); +``` +This function works the same as [`xsConcatPrintf()`](#xsconcatprintf), except that it overwrites the previous string instead of appending to it. This function returns 0 if successful, or -1 if an error occurs. + + +## xsWrite() +```c +int xsWrite(pXString this, char* buf, int len, int offset, int flags); +``` +This function writes data into the xstring, similar to using the standard fdWrite or objWrite API. This function can thus be used as a value for `write_fn`, for those functions that require this (such as the `expGenerateText()` function). This function returns `len` if successful, or -1 if an error occurs. + + +## xsRTrim() +```c +int xsRTrim(pXString this); +``` +This function trims whitespace characters (spaces, tabs, newlines, and line feeds) from the right side of the xstring. This function returns 0 if successful, or -1 if an error occurs. + + +## xsLTrim() +```c +int xsLTrim(pXString this); +``` +This function trims whitespace characters (spaces, tabs, newlines, and line feeds) from the left side of the xstring. This function returns 0 if successful, or -1 if an error occurs. + + +## xsTrim() +```c +int xsTrim(pXString this); +``` +This function trims whitespace characters (spaces, tabs, newlines, and line feeds) from both sides of the xstring. This function returns 0 if successful, or -1 if an error occurs. + + +## xsFind() +```c +int xsFind(pXString this, char* find, int findlen, int offset) +``` +This function searches for a specific string (`find`) in the xstring, starting at the provided `offset`. `findlen` is the length of the provided string, allowing it to include null characters (pass -1 to have the length calculated using `strlen(find)`). This function returns the index where the string was found if successful, or -1 if an error occurs (including the string not being found). + + +## xsFind() +```c +int xsFindRev(pXString this, char* find, int findlen, int offset) +``` +This function works the same as [`xsFind()`](#xsfind) except that it searches from the end of the string, resulting in better performance if the value is closer to the end of the string. This function returns the index where the string was found if successful, or -1 if an error occurs (including the string not being found). + + +## xsSubst() +```c +int xsSubst(pXString this, int offset, int len, char* rep, int replen) +``` +This function substitutes a string into a given position in an xstring. This does not search for matches as with [`xsReplace()`](#xsrepalce), instead the position (`offset`) and length (`len`) must be specified. Additionally, the length of the replacement string (`replen`) can be specified handle null characters. Both `len` and `replen` can be left blank to generate them using `strlen()`. This function returns 0 if successful, or -1 if an error occurs. + + +## xsReplace() +```c +int xsReplace(pXString this, char* find, int findlen, int offset, char* rep, int replen); +``` +This function searches an xString for the specified string (`find`) and replaces that string with another specified string (`rep`). Both strings can have their length specified (`findlen` and `replen` respectively), or left as -1 to generate it using `strlen()`. This function returns the starting offset of the replace if successful, or -1 if an error occurs (including the string not being found). + + +## xsInsertAfter() +```c +int xsInsertAfter(pXString this, char* ins, int inslen, int offset); +``` +This function inserts the specified string (`ins`) at offset (`offset`). The length of the string can be specified (`inslen`), or left as -1 to generate it using `strlen()`. This function returns the new offset after the insertion (i.e. `offset + inslen`), or -1 if an error occurs. + + +## xsGenPrintf_va() +```c +int xsGenPrintf_va(int (*write_fn)(), void* write_arg, char** buf, int* buf_size, const char* fmt, va_list va); +``` +This function performs a `printf()` operation to an `xxxWrite()` style function. + +In the wise words of Greg Beeley from 2002: +> This routine isn't really all that closely tied to the XString module, but this seemed to be the best place for it. If a `buf` and `buf_size` are supplied (`NULL` otherwise), then `buf` MUST be allocated with the `nmSysMalloc()` routine. Otherwise, **kaboom!** This routine will grow `buf` if it is too small, and will update `buf_size` accordingly. + +This function returns the printed length (>= 0) on success, or -(errno) if an error occurs. + + +## xsGenPrintf() +```c +int xsGenPrintf(int (*write_fn)(), void* write_arg, char** buf, int* buf_size, const char* fmt, ...); +``` +This function works the same as [`xsGenPrintf_va()`](#xsgenprintf_va), but with a more convenient signature for the developer. + + +## xsString() +```c +char* xsString(pXString this); +``` +This function returns the stored string after checking for various errors, or returns `NULL` if an error occurs. + + +## xsLength() +```c +xsLength(pXString this); +``` +This function returns the length of the string in constant time (since this value is stored in `this->Length`) checking for various errors, or returns `NULL` if an error occurs. + + + + +## xsQPrintf_va(), xsQPrintf(), & xsConcatQPrintf() +```c +int xsQPrintf_va(pXString this, char* fmt, va_list va); +int xsQPrintf(pXString this, char* fmt, ...); +int xsConcatQPrintf(pXString this, char* fmt, ...); +``` +These functions use the `QPrintf` to add data to an xstring. They return 0 on success, or some other value on failure. diff --git a/centrallix-sysdoc/OSDriver_Authoring.md b/centrallix-sysdoc/OSDriver_Authoring.md index 6283a8855..a6b3f783f 100644 --- a/centrallix-sysdoc/OSDriver_Authoring.md +++ b/centrallix-sysdoc/OSDriver_Authoring.md @@ -37,6 +37,8 @@ **Date**: January 13, 1999 +**Imported**: August 13, 2001 + **Updated**: December 11, 2025 **License**: Copyright (C) 2001-2025 LightSys Technology Services. See LICENSE.txt for more information. @@ -98,70 +100,7 @@ - [stparse: stAddValue()](#stparse-staddvalue) - [stparse: stFreeInf()](#stparse-stfreeinf) - [stparse: Using Fields Directly](#stparse-using-fields-directly) - - [IV Memory Management in Centrallix](#iv-memory-management-in-centrallix) - - [nmMalloc()](#nmmalloc) - - [nmFree()](#nmfree) - - [nmStats()](#nmstats) - - [nmRegister()](#nmregister) - - [nmDebug()](#nmdebug) - - [nmDeltas()](#nmdeltas) - - [nmSysMalloc()](#nmsysmalloc) - - [nmSysRealloc()](#nmsysrealloc) - - [nmSysStrdup()](#nmsysstrdup) - - [nmSysFree()](#nmsysfree) - - [V Module: XArray](#v-module-xarray) - - [xaNew()](#xanew) - - [xaFree()](#xafree) - - [xaInit()](#xainit) - - [xaDeInit()](#xadeinit) - - [xaAddItem()](#xaadditem) - - [xaAddItemSorted()](#xaadditemsorted) - - [xaAddItemSortedInt32()](#xaadditemsortedint32) - - [xaGetItem()](#xagetitem) - - [xaFindItem()](#xafinditem) - - [xaFindItemR()](#xafinditemr) - - [xaRemoveItem()](#xaremoveitem) - - [xaClear()](#xaclear) - - [xaClearR()](#xaclearr) - - [xaCount()](#xacount) - - [xaInsertBefore()](#xainsertbefore) - - [xaInsertAfter()](#xainsertafter) - - [VI Module: XHash](#vi-module-xhash) - - [xhInitialize()](#xhinitialize) - - [xhInit()](#xhinit) - - [xhDeInit()](#xhdeinit) - - [xhAdd()](#xhadd) - - [xhRemove()](#xhremove) - - [xhLookup()](#xhlookup) - - [xhClear()](#xhclear) - - [xhForEach()](#xhforeach) - - [xhClearKeySafe()](#xhclearkeysafe) - - [VII Module: XString](#vii-module-xstring) - - [xsNew()](#xsnew) - - [xsFree()](#xsfree) - - [xsInit()](#xsinit) - - [xsDeInit()](#xsdeinit) - - [xsCheckAlloc()](#xscheckalloc) - - [xsConcatenate()](#xsconcatenate) - - [xsCopy()](#xscopy) - - [xsStringEnd()](#xsstringend) - - [xsConcatPrintf()](#xsconcatprintf) - - [xsPrintf()](#xsprintf) - - [xsWrite()](#xswrite) - - [xsRTrim()](#xsrtrim) - - [xsLTrim()](#xsltrim) - - [xsTrim()](#xstrim) - - [xsFind()](#xsfind) - - [xsFindRev()](#xsfindrev) - - [xsSubst()](#xssubst) - - [xsReplace()](#xsreplace) - - [xsInsertAfter()](#xsinsertafter) - - [xsGenPrintf_va()](#xsgenprintf_va) - - [xsGenPrintf()](#xsgenprintf) - - [xsString()](#xsstring) - - [xsLength()](#xslength) - - [xsQPrintf_va(), xsQPrintf(), & xsConcatQPrintf()](#xsqprintf_va-xsqprintf--xsconcatqprintf) - - [VIII Module: Expression](#viii-module-expression) + - [IV Module: Expression](#viii-module-expression) - [expCompileExpression())](#expallocexpression) - [expFreeExpression()](#expfreeexpression) - [expCompileExpression()](#expcompileexpression) @@ -178,24 +117,12 @@ - [expRemoveParamFromList()](#expremoveparamfromlist) - [expSetParamFunctions()](#expsetparamfunctions) - [expReverseEvalTree()](#expreverseevaltree) - - [IX MTSession](#ix-module-mtsession) - - [mssUserName()](#mssusername) - - [mssPassword()](#msspassword) - - [mssSetParam()](#msssetparam) - - [mssGetParam()](#mssgetparam) - - [mssError()](#msserror) - - [mssErrorErrno()](#msserrorerrno) - - [X Path Handling Functions](#x-path-handling-functions) + - [V Path Handling Functions](#x-path-handling-functions) - [obj_internal_PathPart()](#obj_internal_pathpart) - [obj_internal_AddToPath()](#obj_internal_addtopath) - [obj_internal_CopyPath](#obj_internal_copypath) - [obj_internal_FreePathStruct()](#obj_internal_freepathstruct) - - [XI Network Connection Functionality](#vi-network-connection-functionality) - - [netConnectTCP()](#netconnecttcp) - - [netCloseTCP()](#netclosetcp) - - [fdWrite()](#fdwrite) - - [fdRead()](#fdread) - - [XII Parsing Data](#xii-parsing-data) + - [VI Parsing Data](#xii-parsing-data) - [mlxOpenSession()](#mlxopensession) - [mlxStringSession()](#mlxstringsession) - [mlxCloseSession()](#mlxclosesession) @@ -210,7 +137,7 @@ - [mlxSetReservedWords()](#mlxsetreservedwords) - [mlxNoteError()](#mlxnoteerror) - [mlxNotePosition()](#mlxnoteposition) - - [XIII Driver Testing](#xiii-driver-testing) + - [VII Driver Testing](#xiii-driver-testing) - [Object opening, closing, creation, and deletion](#aobject-opening-closing-creation-and-deletion) - [Object attribute enumeration, getting, and setting.](#bobject-attribute-enumeration-getting-and-setting) - [Object querying (for subobjects)](#cobject-querying-for-subobjects) @@ -1174,527 +1101,7 @@ for (unsigned int i = 0u; i < inf->nSubInf; i++) -## IV Memory Management in Centrallix -Centrallix has its own memory management wrapper that caches deallocated blocks of memory by size for faster reuse. This wrapper also detects double-freeing of blocks (sometimes), making debugging of memory problems just a little bit easier. - -In addition, the memory manager provides statistics on the hit ratio of allocated blocks coming from the lists vs. `malloc()`, and on how many blocks of each size/type are `malloc()`ed and cached. This information can be helpful for tracking down memory leaks. Empirical testing has shown an increase of performance of around 50% or more in programs that use newmalloc. - -One caveat is that this memory manager does not provide `nmRealloc()` function, only `nmMalloc()` and `nmFree()`. Thus, either `malloc()`, `free()`, and `realloc()` or [`nmSysMalloc()`](#nmsysmalloc), [`nmSysFree()`](#nmsysfree), and [`nmSysRealloc()`](#nmsysrealloc) should be used for blocks of memory that might vary in size. - -- 📖 **Note**: This memory manager is usually the wrong choice for blocks of memory of arbitrary, inconsistent sizes. It is intended for allocating structures quickly that are of a specific size. For example, allocated space for a struct that is always the same size. - -- 🥱 **tl;dr**: Use `nmMalloc()` for structs, not for strings. - -- ⚠️ **Warning**: Do not mix and match, even though calling `free()` on a block obtained from `nmMalloc()` or calling `nmFree()` on a block obtained from `malloc()` might not crash the program immediately. However, it may result in either inefficient use of the memory manager, or a significant memory leak, respectively. These practices will also lead to incorrect results from the statistics and block count mechanisms. - - -The following are the functions for the newmalloc module: - -### nmMalloc() -```c -void* nmMalloc(int size); -``` -This function allocates a block of the given `size`. It returns `NULL` if the memory could not be allocated. - - -### nmFree() -```c -void nmFree(void* ptr, int size); -``` -This function frees the block of memory. - -- ⚠️ **Warning**: The caller **must know the size of the block.** Getting this wrong is very bad!! For structures, this is trivial, simply use `sizeof()`, exactly the same as with `nmMalloc()`. - - -### nmStats() -```c -void nmStats(void); -``` -Prints statistics about the memory manager, for debugging and optimizing. - -For example: -``` -NewMalloc subsystem statistics: - nmMalloc: 20244967 calls, 19908369 hits (98.337%) - nmFree: 20233966 calls - bigblks: 49370 too big, 32768 largest size -``` - -- ⚠️ **Warning**: Centrallix-lib must be built with the configure option `--enable-debugging` for this function to work. Otherwise, all the stats will be zeros. - - -### nmRegister() -```c -void nmRegister(int size, char* name); -``` -Registers an inteligent name for block of the specified size. This allows the memory manager to give more information when reporting block allocation counts. A given size can have more than one name. This function is optional and not required for any production usecases, but using it can make tracking down memory leaks easier. - -This function is usually called in a module's `Initialize()` function on each of the structures the module uses internally. - - -### nmDebug() -```c -void nmDebug(void); -``` -Prints a listing of block allocation counts, giving (by size): -- The number of blocks allocated but not yet freed. -- The number of blocks in the cache. -- The total allocations for this block size. -- A list of names (from [`nmRegister()`](#nmregister)) for that block size. - - -### nmDeltas() -```c -void nmDeltas(void); -``` -Prints a listing of all blocks whose allocation count has changed, and by how much, since the last `nmDeltas()` call. This function is VERY USEFUL FOR MEMORY LEAK DETECTIVE WORK. - - -### nmSysMalloc() -```c -void* nmSysMalloc(int size); -``` -Allocates memory without using the block-caching algorithm. This is roughly equivalent to `malloc()`, but pointers returned by malloc and this function are not compatible - i.e., you cannot `free()` something that was [`nmSysMalloc()`](#nmsysmalloc)'ed, nor can you [`nmSysFree()`](#nmsysfree) something that was `malloc()`'ed. - -- 📖 **Note**: This function is much better to use on variable-sized blocks of memory. `nmMalloc()` is better for fixed-size blocks, such as for structs. - - -### nmSysRealloc() -```c -void* nmSysRealloc(void* ptr, int newsize); -``` -Changes the size of an allocated block of memory that was obtained from [`nmSysMalloc()`](#nmsysmalloc), [`nmSysRealloc()`](#nmsysrealloc), or [`nmSysStrdup()`](#nmsysstrdup). The new pointer may be different if the block needs to be moved. This is the rough equivalent of `realloc()`. - -- 📖 **Note**: If you are `realloc()`'ing a block of memory and need to store pointers to data somewhere inside the block, it is often better to store an offset rather than a full pointer. This is because a full pointer becomes invalid if a [`nmSysRealloc()`](#nmsysrealloc) causes the block to move. - - -### nmSysStrdup() -```c -char* nmSysStrdup(const char* str); -``` -Allocates memory using the [`nmSysMalloc()`](#nmsysmalloc) function and copies the string `str` into this memory. It is a rough equivalent of `strdup()`. The resulting pointer can be free'd using [`nmSysFree()`](#nmsysfree). - - -### nmSysFree() -```c -void nmSysFree(void* ptr); -``` -Frees a block of memory allocated by [`nmSysMalloc()`](#nmsysmalloc), [`nmSysRealloc()`](#nmsysrealloc), or [`nmSysStrdup()`](#nmsysstrdup). - - - -## V Module: XArray -The xarray (xa) module is intended to manage sized growable arrays, similar to a light-weight arraylist implementation. It includes the `XArray`, which has the following fields: -- `nItems : int`: The number of items in the array. -- `nAlloc : int`: Internal variable to store the size of the allocated memory. -- `Items : void**`: The allocated array of items. - -- 📖 **Note**: Some code occasionally sets `nAlloc` to 0 after an XArray struct has been deinitialized to indicate that the relevant data is no longer allocated. Other than this, it is only used internally by the library. - -- ⚠️ **Warning**: Do not mix calls to [`xaNew()`](#xanew)/[`xaFree()`](#xafree) with calls to [`xaInit()`](#xainit)/[`xaDeInit()`](#xadeinit). Every struct allocated using new must be freed, and ever struct allocated using init must be deinitted. Mixing these calls can lead to memory leaks, bad frees, and crashes. - - -### xaNew() -```c -pXArray xaNew(int init_size); -``` -Allocates a new `XArray` struct on the heap (using [`nmMalloc()`](#nmmalloc) for caching) and returns a pointer to it, or returns `NULL` if an error occurs. - -### xaFree() -```c -int xaFree(pXArray this); -``` -Frees a `pXArray` allocated using [`xaNew`](#xanew), returning 0 if successful or -1 if an error occurs. - -### xaInit() -```c -int xaInit(pXArray this, int init_size); -``` -This function initializes an allocated (but uninitialized) xarray. It makes room for `init_size` items initially, but this is only an optimization. A typical value for `init_size` is 16. Remember to [`xaDeInit`](#xadeinit) this xarray, do **not** [`xaFree`](#xafree) it. - -This function returns 0 on success, or -1 if an error occurs. - -### xaDeInit() -```c -int xaDeInit(pXArray this); -``` -This function de-initializes an xarray, but does not free the XArray structure itself. This is useful if the structure is a local variable allocated using [`xaInit()`](#xainit). - -This function returns 0 on success, or -1 if an error occurs. - -For example: -```c -XArray arr; -if (xaInit(&arr, 16) != 0) goto handle_error; - -/** Use the xarray. **/ - -if (arr.nAlloc != 0 && xaDeInit(&arr) != 0) goto handle_error; -arr.nAlloc = 0; -``` - -### xaAddItem() -```c -int xaAddItem(pXArray this, void* item); -``` -This function adds an item to the end of the xarray. The item is assumed to be a `void*`, but this function will _not_ follow pointeres stored in the array. Thus, other types can be typecast and stored into that location (such as an `int`). - -This function returns 0 on success, or -1 if an error occurs. - -### xaAddItemSorted() -```c -int xaAddItemSorted(pXArray this, void* item, int keyoffset, int keylen); -``` -This function adds an item to a sorted xarray while maintaining the sorted property. The value for sorting is expected to begin at the offset given by `keyoffset` and continue for `keylen` bytes. This function _will_ follow pointers are stored in the array so casting other types to store them is not allowed (as it is with [`xaAddItem()`](#xaadditem)). - -### xaAddItemSortedInt32() -```c -int xaAddItemSortedInt32(pXArray this, void* item, int keyoffset) -``` - - -### xaGetItem() -```c -void* xaGetItem(pXArray this, int index) -``` -This function returns an item given a specific index into the xarray, or `NULL` if the index is out of bounds. If the bounds check needs to be omitted for performance and the caller can otherwise verify that no out of bounds read is possible (e.g. because they are iterating from 0 to `xarray->nItems`), the caller should access `xarray->Items` directly. Either way, the result may need to be typecasted or stored in a variable of a specific type for it to be useable, and error checking for `NULL` values should be used. - -### xaFindItem() -```c -int xaFindItem(pXArray this, void* item); -``` -This function returns array index for the provided item in the array, or -1 if the item could not be found. Requires an exact match, so two `void*` pointing to different memory with identical contents are not considered equal by this function. If the data is actually another datatype typecasted as a `void*`, all 8 bytes must be identical for a match. - -For example: -```c -void* data = &some_data; - -XArray xa; -xaInit(&xa, 16); - -... - -xaAddItem(&xa, data); - -... - -int item_id = xaFindItem(&xa, data); -assert(data == xa.Items[item_id]); -``` - -### xaFindItemR() -```c -int xaFindItemR(pXArray this, void* item); -``` -This function works the same as [`xaFindItem()`](#xafinditem), however it iterates in reverse, giving a slight performance boost, especially for finding items near the end of the array. - -### xaRemoveItem(pXArray this, int index) -```c -int xaRemoveItem(pXArray this, int index) -``` -This function removes an item from the xarray at the given the index, then shifts all following items back to fill the gap created by the removal. XArray is not optimized for removing multiple items efficiently. This function returns 0 on success, or -1 if an error occurs. - -### xaClear() -```c -int xaClear(pXArray this, int (*free_fn)(), void* free_arg); -``` -This function removes all elements from the xarray, leaving it empty. `free_fn()` is invoked on each element with a `void*` to the element to be freed as the first argument and `free_arg` as the second argument (the return value of `free_fn()` is always ignored). This function returns 0 on success (even if the `free_fn()` returns an error), or -1 if an error is detected. - -### xaClearR() -```c -int xaClearR(pXArray this, int (*free_fn)(), void* free_arg); -``` -This function works the same as [`xaClear()`](#xaclear), except that it is slightly faster because the free function is evaluated on items in reverse order. - -### xaCount() -```c -int xaCount(pXArray this); -``` -This function returns the number of items in the xarray, or -1 on error. It is equivalent to accessing `xarray->nItems` (although the latter expression will not return an error). - -### xaInsertBefore() -```c -int xaInsertBefore(pXArray this, int index, void* item) -``` -This function inserts an item before the specified index, moving all following items forward to make space. The new item cannot be inserted past the end of the array. This function returns the index on success, or -1 if an error occurs. - -### xaInsertAfter() -```c -int xaInsertAfter(pXArray this, int index, void* item) -``` -This function inserts an item after the specified index, moving all following items forward to make space. The new item cannot be inserted past the end of the array. This function returns the index on success, or -1 if an error occurs. - - - -## VI Module: XHash -The xhash (xh) module provides an extensible hash table interface. The hash table is a table of linked lists of items, so collisions and overflows are handled by this data structure (although excessive collisions still cause a performance loss). This implementation also supports variable-length keys for more flexible usecases. - -- ⚠️ **Warning**: All `xhXYZ()` function calls assume that the `pXHashTable this` arg points to a valid hashtable struct. All non-init functions assume that this struct has been validly initialized and has not yet been freed. If these conditions are not met, the resulting behavior is undefined. - -### xhInitialize() -```c -int xhInitialize(); -``` -Initialize the random number table for hash computation, returning 0 on success or -1 if an error occurs. Normally, you can assume someone else has already called this during program startup. - -### xhInit() -```c -int xhInit(pXHashTable this, int rows, int keylen); -``` -This function initializes a hash table, setting the number of rows and the key length. Specify a `keylen` of 0 for for variable length keys (aka. null-terminated strings). The `rows` should be an odd number, preferably prime (although that isn't required). `rows` **SHOULD NOT** be a power of 2. Providing this value allows the caller to optimize it based on how much data they expect to be stored in the hash table. If this value is set to 1, the hash search degenerates to a linear array search with extra overhead. Thus, the value should be large enough to comfortably accommodate the elements with minimal collisions. Typical values include 31, 251, or 255 (though 255 is not prime). - -### xhDeInit() -```c -int xhDeInit(pXHashTable this); -``` -This function deinitializes a hash table struct, freeing all rows. Note that the stored data is not freed and neither are the keys as this data is assumed to be the responsibility of the caller. Returns 0 on success, or -1 if an error occurs. - -### xhAdd() -```c -int xhAdd(pXHashTable this, char* key, char* data); -``` -Adds an item to the hash table, with a given key value and data pointer. Both data and key pointers must have a lifetime that exceeds the time that they item is hashed, as they are assumed to be the responsibility of the caller. This function returns 0 on success, or -1 if an error occurs. - -### xhRemove() -```c -int xhRemove(pXHashTable this, char* key); -``` -This function removes an item with the given key value from the hash table. It returns 0 if the item was successfully removed, or -1 if an error occurs (including failing to find the item). - -### xhLookup() -```c -char* xhLookup(pXHashTable this, char* key); -``` -This function returns a pointer to the data associated with the given key, or `NULL` if an error occurs (including failing to find the key). - -### xhClear() -```c -int xhClear(pXHashTable this, int (*free_fn)(), void* free_arg); -``` -Clears all items from a hash table. If a `free_fn()` is provided, it will be invoked with each data pointer as the first argument and `free_arg` as the second argument as items are removed. The return value of the `free_fn()` is ignored. This function returns 0 on success (even if the `free_fn()` returns an error), or -1 if an error is detected. - -### xhForEach() -```c -int xhForEach(pXHashTable this, int (*callback_fn)(pXHashEntry, void*), void* each_arg); -``` -This function executes an operation on each entry of the hash table entry. The provided callback function will be called with each entry (in an arbitrary order). This function is provided 2 parameters: the current hash table entry, and a `void*` argument specified using `each_arg`. If any invocation of the callback function returns a value other than 0, the `xhForEach()` will immediately fail, returning that value as the error code. - -This function returns 0 if the function executes successfully, 1 if the callback function is `NULL`, or n (where n != 0) if the callback function returns n. It does not return any error code other than 1 or any error codes returned by `callback_fn()`. - -### xhClearKeySafe() -```c -int xhClearKeySafe(pXHashTable this, void (*free_fn)(pXHashEntry, void*), void* free_arg); -``` -This function clears all contents from the hash table. The free function is passed each hash entry struct and `free_arg`, allowing it to free both the value and key, if needed, and the free function is not allowed to return an error code. This function returns 0 for success as long as `free_fn()` is nonnull, otherwise it returns -1. - - - -## VII Module: XString -The xstring (xs) module is used for managing growable strings. It is based on a structure containing a small initial string buffer to avoid string allocations for small strings. However, it can also perform `realloc()` operations to extend the string space for storing incrementally larger strings. This module allows for strings to contain arbitrary data, even NULL (`'\0'`) characters mid-string. Thus, it can also be used as an extensible buffer for arbitrary binary data. - -- 📖 **Note**: The contents of the XString can be easily referenced with the `xstring->String` field in the xstring struct. - -- ⚠️ **Warning**: Do not mix calls to [`xsNew()`](#xsnew)/[`xsFree()`](#xsfree) with calls to [`xsInit()`](#xsinit)/[`xsDeInit()`](#xsdeinit). Every struct allocated using new must be freed, and ever struct allocated using init must be deinitted. Mixing these calls can lead to memory leaks, bad frees, and crashes. - -### xsNew() -```c -pXString xsNew() -``` -This function allocates a new XString structure to contain a new, empty string. It uses [`nmMalloc()`](#nmmalloc) because the XString struct is always a consistant size. This function returns a pointer to the new string if successful, or `NULL` if an error occurs. - -### xsFree() -```c -void xsFree(pXString this); -``` -This function frees an XString structure allocated with [`xsNew()`](#xsnew), freeing all associated memory. - -### xsInit() -```c -int xsInit(pXString this); -``` -This function initializes an XString structure to contain a new, empty string. This function returns 0 if successful, or -1 if an error occurs. - -### xsDeInit() -```c -int xsDeInit(pXString this); -``` -This function deinitializes an XString structure allocated with [`xsInit()`](#xsinit), freeing all associated memory. This function returns 0 if successful, or -1 if an error occurs. - -### xsCheckAlloc() -```c -int xsCheckAlloc(pXString this, int addl_needed); -``` -This function will optionally allocate more memory, if needed, given the currently occupied data area and the additional space required (specified with `addl_needed`). This function returns 0 if successful, or -1 if an error occurs. - -### xsConcatenate() -```c -int xsConcatenate(pXString this, char* text, int len); -``` -This function concatenates the `text` string onto the end of the XString's value. If `len` is set, that number of characters are copied, including possible null characters (`'\0'`). If `len` is -1, all data up to the null-terminater is copied. This function returns 0 if successful, or -1 if an error occurs. - -- ⚠️ **Warning**: Do not store pointers to values within the string while adding text to the end of the string. The string may be reallocated to increase space, causing such pointers to break. Instead, use offset indexes into the string and calculate pointers on demand with `xs->String + offset`. - - For example, **DO NOT**: - ```c - XString xs; - if (xsInit(&xs) != 0) goto handle_error; - - if (xsConcatenate(&xs, "This is the first sentence. ", -1) != 0) goto handle_error; - char* ptr = xsStringEnd(&xs); /* Stores string pointer! */ - if (xsConcatenate(&xs, "This is the second sentence.", -1) != 0) goto handle_error; - - /** Print will probably read invalid memory. **/ - printf("A pointer to the second sentence is '%s'\n", ptr); - - ... - - if (xsDeInit(&xs) != 0) goto handle_error; - ``` - - Instead, use indexes and pointer arithmetic like this: - ```c - XString xs; - if (xsInit(&xs) != 0) goto handle_error; - - if (xsConcatenate(&xs, "This is the first sentence. ", -1) != 0) goto handle_error; - int offset = xsStringEnd(&xs) - xs->String; /* Stores index offset. */ - if (xsConcatenate(&xs, "This is the second sentence.", -1) != 0) goto handle_error; - - /** Print will probably work fine. **/ - printf("A pointer to the second sentence is '%s'\n", xs->String + offset); - - ... - - if (xsDeInit(&xs) != 0) goto handle_error; - ``` - -### xsCopy() -```c -int xsCopy(pXString this, char* text, int len); -``` -This function copies the string `text` into the XString, overwriting any previous contents. This function returns 0 if successful, or -1 if an error occurs. - -### xsStringEnd() -```c -char* xsStringEnd(pXString this); -``` -This function returns a pointer to the end of the string. This function is more efficient than searching for a null-terminator using `strlen()` because the xs module already knows the string length. Furthermore, since some string may contain nulls, using `strlen()` may produce an incorrect result. - -### xsConcatPrintf() -```c -int xsConcatPrintf(pXString this, char* fmt, ...); -``` -This function prints additional data onto the end of the string. It is similar to printf, however, only the following features are supported: -- `%s`: Add a string (`char*`). -- `%d`: Add a number (`int`). -- `%X`: Add something? -- `%%`: Add a `'%'` character. -Attempting to use other features of printf (such as `%lf`, `%c`, `%u`, etc.) will cause unexpected results. - -This function returns 0 if successful, or -1 if an error occurs. - -### xsPrintf() -```c -int xsPrintf(pXString this, char* fmt, ...); -``` -This function works the same as [`xsConcatPrintf()`](#xsconcatprintf), except that it overwrites the previous string instead of appending to it. This function returns 0 if successful, or -1 if an error occurs. - -### xsWrite() -```c -int xsWrite(pXString this, char* buf, int len, int offset, int flags); -``` -This function writes data into the xstring, similar to using the standard fdWrite or objWrite API. This function can thus be used as a value for `write_fn`, for those functions that require this (such as the `expGenerateText()` function). This function returns `len` if successful, or -1 if an error occurs. - -### xsRTrim() -```c -int xsRTrim(pXString this); -``` -This function trims whitespace characters (spaces, tabs, newlines, and line feeds) from the right side of the xstring. This function returns 0 if successful, or -1 if an error occurs. - -### xsLTrim() -```c -int xsLTrim(pXString this); -``` -This function trims whitespace characters (spaces, tabs, newlines, and line feeds) from the left side of the xstring. This function returns 0 if successful, or -1 if an error occurs. - -### xsTrim() -```c -int xsTrim(pXString this); -``` -This function trims whitespace characters (spaces, tabs, newlines, and line feeds) from both sides of the xstring. This function returns 0 if successful, or -1 if an error occurs. - -### xsFind() -```c -int xsFind(pXString this, char* find, int findlen, int offset) -``` -This function searches for a specific string (`find`) in the xstring, starting at the provided `offset`. `findlen` is the length of the provided string, allowing it to include null characters (pass -1 to have the length calculated using `strlen(find)`). This function returns the index where the string was found if successful, or -1 if an error occurs (including the string not being found). - -### xsFind() -```c -int xsFindRev(pXString this, char* find, int findlen, int offset) -``` -This function works the same as [`xsFind()`](#xsfind) except that it searches from the end of the string, resulting in better performance if the value is closer to the end of the string. This function returns the index where the string was found if successful, or -1 if an error occurs (including the string not being found). - -### xsSubst() -```c -int xsSubst(pXString this, int offset, int len, char* rep, int replen) -``` -This function substitutes a string into a given position in an xstring. This does not search for matches as with [`xsReplace()`](#xsrepalce), instead the position (`offset`) and length (`len`) must be specified. Additionally, the length of the replacement string (`replen`) can be specified handle null characters. Both `len` and `replen` can be left blank to generate them using `strlen()`. This function returns 0 if successful, or -1 if an error occurs. - -### xsReplace() -```c -int xsReplace(pXString this, char* find, int findlen, int offset, char* rep, int replen); -``` -This function searches an xString for the specified string (`find`) and replaces that string with another specified string (`rep`). Both strings can have their length specified (`findlen` and `replen` respectively), or left as -1 to generate it using `strlen()`. This function returns the starting offset of the replace if successful, or -1 if an error occurs (including the string not being found). - -### xsInsertAfter() -```c -int xsInsertAfter(pXString this, char* ins, int inslen, int offset); -``` -This function inserts the specified string (`ins`) at offset (`offset`). The length of the string can be specified (`inslen`), or left as -1 to generate it using `strlen()`. This function returns the new offset after the insertion (i.e. `offset + inslen`), or -1 if an error occurs. - -### xsGenPrintf_va() -```c -int xsGenPrintf_va(int (*write_fn)(), void* write_arg, char** buf, int* buf_size, const char* fmt, va_list va); -``` -This function performs a `printf()` operation to an `xxxWrite()` style function. - -In the wise words of Greg Beeley from 2002: -> This routine isn't really all that closely tied to the XString module, but this seemed to be the best place for it. If a `buf` and `buf_size` are supplied (`NULL` otherwise), then `buf` MUST be allocated with the `nmSysMalloc()` routine. Otherwise, **kaboom!** This routine will grow `buf` if it is too small, and will update `buf_size` accordingly. - -This function returns the printed length (>= 0) on success, or -(errno) if an error occurs. - -### xsGenPrintf() -```c -int xsGenPrintf(int (*write_fn)(), void* write_arg, char** buf, int* buf_size, const char* fmt, ...); -``` -This function works the same as [`xsGenPrintf_va()`](#xsgenprintf_va), but with a more convenient signature for the developer. - -### xsString() -```c -char* xsString(pXString this); -``` -This function returns the stored string after checking for various errors, or returns `NULL` if an error occurs. - -### xsLength() -```c -xsLength(pXString this); -``` -This function returns the length of the string in constant time (since this value is stored in `this->Length`) checking for various errors, or returns `NULL` if an error occurs. - - - -### xsQPrintf_va(), xsQPrintf(), & xsConcatQPrintf() -```c -int xsQPrintf_va(pXString this, char* fmt, va_list va); -int xsQPrintf(pXString this, char* fmt, ...); -int xsConcatQPrintf(pXString this, char* fmt, ...); -``` -These functions use the `QPrintf` to add data to an xstring. They return 0 on success, or some other value on failure. - - - -## VIII Module: Expression +## IV Module: Expression The expression (EXP) module is used for compiling, evaluating, reverse-evaluating, and managing parameters for expression strings. The expression strings are compiled and stored in an expression tree structure. Expressions can be stand-alone expression trees, or they can take parameter objects. A parameter object is an open object (from `objOpen()`) whose values (attributes) are referenced within the expression string. By using such parameter objects, one expression can be compiled and then evaluated for many different objects with diverse attribute values. @@ -1868,89 +1275,7 @@ There are several other EXP functions used to deal with aggregates and a few oth -## IX Module: MTSession -The mtsession (MSS) module is used for session authentication, error reporting, and for storing session-wide variables such as the current date format, username, and password (used when issuing a login request to a remote server). Care should be taken in the use of Centrallix that its coredump files are NOT in a world-readable location, as the password will be visible in the coredump file (or just ulimit the core file size to 0). - - -### mssInitialize() -```c -int mssInitialize(char* authmethod, char* authfile, char* logmethod, int logall, char* log_progname); -``` -This function initializes the session manager and sets global variables used in this module. It returns 0 if successful and -1 if an error occurs. - -### mssUserName() -```c -char* mssUserName(); -``` -This function returns the current user name, or `NULL` an error occurs. - -### mssPassword() -```c -char* mssPassword(); -``` -This function returns the current user's password that they used to log into Centrallix, or `NULL` an error occurs. - -### mssSetParam() -```c -int mssSetParam(char* paramname, char* param); -``` -This function sets the session parameter of the provided name (`paramname`) to the provided value (`param`). The parameter MUST be a string value. This function returns 0 if successful, or -1 an error occurs. - -### mssGetParam() -```c -char* mssGetParam(char* paramname); -``` -Returns the value of a session parameter of the provided name (`paramname`), or `NULL` if an error occurs. Common session parameters include: -- `dfmt`: The current date format. -- `mfmt`: The current money format. -- `textsize`: The current max text size from a read of an object's content via `objGetAttrValue(obj, "objcontent", POD(&str))` - -### mssError() -```c -int mssError(int clr, char* module, char* message, ...); -``` -Formats and caches an error message for return to the user. This function returns 0 if successful, or -1 if an error occurred. - -| Parameter | Type | Description -| --------- | ------------- | ------------ -| crl | int | If set to 1, all previous error messages are cleared. Set this when the error is initially discovered and no other module is likely to have made a relevant `mssError()` call for the current error. -| module | char* | A two-to-five letter abbreviation of the module reporting the error. This is typically the module or driver's abbreviation prefix in full uppercase letters (although that is not required). This is intended to help the developer find the source of the error faster. -| message | char* | A string error message, accepting format specifiers like `%d` and `%s` which are supplied by the argument list, similar to `printf()`. -| ... | ... | Parameters for the formatting. - -Errors that occur inside a session context are normally stored up and not printed until other MSS module routines are called to fetch the errors. Errors occurring outside a session context (such as in Centrallix's network listener) are printed to Centrallix's standard output immediately. - -The `mssError()` function is not required to be called at every function nesting level when an error occurs. For example, if the expression compiler returns -1 indicating that a compilation error occurred, it has probably already added one or more error messages to the error list. The calling function should only call `mssError()` if doing so would provide additional context or other useful information (e.g. _What_ expression failed compilation? _Why_ as an expression being compiled? etc.). However, it is far easier to give too little information that too much, so it can often be best to air on the side of calling `mssError()` with information that might be irrelevant, rather than skipping it and leaving the developer confused. - -- 📖 **Note**: The `mssError()` routines do not cause the calling function to return or exit. The function must still clean up after itself and return an appropriate value (such as `-1` or `NULL`) to indicate failure. - -- ⚠️ **Warning**: Even if `-1` is returned, the error message may still be sent to the user in some scenarios. This is not guaranteed, though. - -- ⚠️ **Warning**: `%d` and `%s` are the ONLY supported format specifier for this function. **DO NOT** use any other format specifiers like `%lf`, `%u`, `%lu`, `%c` etc. **DO NOT** attempt to include `%%` for a percent symbol in your error message, as misplaced percent symbols often break this function. If you wish to use these features of printf, it is recommended to print the error message to a buffer and pass that buffer to `mssError()`, as follows: - ```c - char err_buf[256]; - snprintf(err_buf, sizeof(err_buf), - "Incorrect values detected: %u, %g (%lf), '%c'", - unsigned_int_value, double_value, char_value - ); - if (mssError(1, "EXMPL", "%s", err_buf) != 0) - { - fprintf(stderr, "ERROR! %s\n", err_buf); - } - return -1; - ``` - - -### mssErrorErrno() -```c -int mssErrorErrno(int clr, char* module, char* message, ...); -``` -This function works the same way as [`mssError`](#mssError), except checks the current value of `errno` and includes a description of any error stored there. This is useful if a system call or other library function is responsible for this error. - - - - -## X Path Handling Functions +## V Path Handling Functions The OSML provides a set of utility functions that make it easier to handle path structs when writing drivers. Most of them are named `obj_internal_XxxYyy()` or similar. ### obj_internal_PathPart() @@ -1993,45 +1318,7 @@ This function frees a pathname structure. -## XI Network Connection Functionality -Sometimes, a driver may need to initiate a network connection. This can be done via the `MTASK` module, which provides simple and easy TCP/IP connectivity. It includes many functions, only a few of which are documented below: - -### netConnectTCP() -```c -pFile netConnectTCP(char* host_name, char* service_name, int flags); -``` -This function creates a client socket and connects it to a server on a given TCP service/port and host name. It takes the following three parameters: -- `host_name`: The host name or ascii string for the host's ip address. -- `service_name`: The name of the service (from `/etc/services`) or its numeric representation as a string. -- `flags`: Normally left 0. - -- 📖 **Note**: The `NET_U_NOBLOCK` flag causes the function to return immediately even if the connection is still being established. Further reads and writes will block until the connection either establishes or fails. - -This function returns the connection file descriptor if successful, or `NULL` if an error occurs. - -### netCloseTCP() -```c -int netCloseTCP(pFile net_filedesc, int linger_msec, int flags); -``` -This function closes a network connection (either a TCP listening, server, or client socket). It will also optionally waits up to `linger_msec` milliseconds (1/1000 seconds) for any data written to the connection to make it to the other end before performing the close. If `linger_msec` is set to 0, the connection is aborted (reset). The linger time can be set to 1000 msec or so if no writes were performed on the connection prior to the close. If a large amount of writes were performed immediately prior to the close, offering to linger for a few more seconds (perhaps 5 or 10 by specifying 5000 or 10000 msec) can be a good idea. - -### fdWrite() -```c -int fdWrite(pFile filedesc, char* buffer, int length, int offset, int flags); -``` -This function writes data to an open file descriptor, from a given `buffer` and `length` of data to write. It also takes an optional seek `offset` and and `flags`, which can be zero or more of: -- `FD_U_NOBLOCK` - If the write can't be performed immediately, don't perform it at all. -- `FD_U_SEEK` - The `offset` value is valid. Seek to it before writing. Not allowed for network connections. -- `FD_U_PACKET` - *ALL* of the data specified by `length` in `buffer` must be written. Normal `write()` semantics in UNIX state that not all data has to be written, and the number of bytes actually written is returned. Setting this flag makes sure all data is really written before returning. - -### fdRead() -```c -int fdRead(pFile filedesc, char* buffer, int maxlen, int offset, int flags); -``` -This function works the same as [`fdWrite()`](#fdwrite) except that it reads data instead of writing it. It takes the same flags as above, except that `FD_U_PACKET` now requires that all of `maxlen` bytes must be read before returning. This is good for reading a packet of a known length that might be broken up into fragments by the network (TCP/IP has a maximum frame transmission size of about 1450 bytes). - - -## XII Parsing Data +## VI Parsing Data The mtlexer (MLX) module is a lexical analyzer library provided by Centrallix for parsing many types of data. It can parse data from either a `pFile` descriptor or from a string value. This lexical analyzer is also used by the [expression compiler](#viii-module-expression). In simple terms, it's a very fancy string tokenizer. ### mlxOpenSession() @@ -2197,7 +1484,7 @@ MLX: Error at line ## -## XIII Driver Testing +## VII Driver Testing This section contains a list of things that can be done to test an objectsystem driver and ensure that it preforms all basic operations correctly, using the [test_obj command line interface](http://www.centrallix.net/docs/docs.php). It is strongly recommended to test for invalid reads, writes, frees, and memory leaks during each of these by watching memory utilization using nmDeltas() during repetitive operations (e.g., nmDeltas(), open, close, nmDeltas(), open, close, and then nmDeltas() again). From 63fa5ba91fc854f18197a2b8bac2995abc572757 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Thu, 11 Dec 2025 17:32:56 -0700 Subject: [PATCH 035/275] Fix wrong stAddValue() info caused by reading old code. --- centrallix-sysdoc/OSDriver_Authoring.md | 15 +-------------- 1 file changed, 1 insertion(+), 14 deletions(-) diff --git a/centrallix-sysdoc/OSDriver_Authoring.md b/centrallix-sysdoc/OSDriver_Authoring.md index a6b3f783f..2b3dd707e 100644 --- a/centrallix-sysdoc/OSDriver_Authoring.md +++ b/centrallix-sysdoc/OSDriver_Authoring.md @@ -1053,20 +1053,7 @@ This function adds a node of type `ST_T_SUBGROUP` to either an `ST_T_SUBGROUP` o ```c int stAddValue(pStructInf inf, char* strval, int intval); ``` -This function adds a value to an attribute, and can be called multiple times on an attribute to add a list of values. If `strval` is not null, a string value is added, otherwise an integer value is added. The string is NOT copied, but is simply pointed-to. If the string is non-static, and has a lifetime less than the `ST_T_ATTRIB` tree node, then the following procedure should be used to allocate a new string which will have the correct lifetime: (In this example, `str` is the string pointer to the string.) - -```c -pStructInf attr_inf = stAddAttr(my_parent_inf, "my_attr"); -if (attr_inf == NULL) goto error_handling; - -char* new_str = (char*)nmSysMalloc(strlen(str) + 1lu); -if (new_str == NULL) goto error_handling; -strcpy(new_str, str); -stAddValue(attr_inf, new_str, 0); -attr_inf->StrAlloc[0] = 1; -``` - -With this method (making a copy of the string and then setting the StrAlloc value for that string), the string is automatically freed when the StructInf tree node is freed by the stparse module. +This function adds a value to an attribute, and can be called multiple times on an attribute to add a list of values. If `strval` is not null, a string value is added, otherwise an integer value is added. The string is NOT copied, but is simply pointed-to. From d0d4f544435897ddc10c953c78f9302527e3da2f Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Thu, 11 Dec 2025 17:38:17 -0700 Subject: [PATCH 036/275] Clean up stale TOODs. --- centrallix-sysdoc/OSDriver_Authoring.md | 13 +------------ 1 file changed, 1 insertion(+), 12 deletions(-) diff --git a/centrallix-sysdoc/OSDriver_Authoring.md b/centrallix-sysdoc/OSDriver_Authoring.md index 2b3dd707e..4b90a117b 100644 --- a/centrallix-sysdoc/OSDriver_Authoring.md +++ b/centrallix-sysdoc/OSDriver_Authoring.md @@ -214,15 +214,8 @@ Using the example above, we can query from the database using a statement like ` ## II Interface This section describes the standard interface between the OSML and the ObjectSystem driver itself. Every driver should implement certain required functions. (**Note**: Many drivers "implement" some required functions to simply fail with a not implemented or not supported error. For example, most database drivers "implement" `Read()` and `Write()` this way because database content should be queried, not read). Various optional functions are also available, which a driver is not required to implement. - The driver should implement an `Initialize()` function, as well as the following (* indicates required functions): + | Function Name | Description | --------------------------------------------------------- | ------------ | [Open](#function-open)* | Opens a new driver instance object on a given node object. @@ -485,7 +478,6 @@ int xxxDeleteObj(void* inf_v, pObjTrxTree* oxt); ```c int xxxRead(void* inf_v, char* buffer, int max_cnt, int offset, int flags, pObjTrxTree* oxt); ``` - The `Read()` function reads content from objects that have content, similar to reading content from a file. If the object does or can have content, the driver should handle these functions as is appropriate. Otherwise, the driver should return a failure code (-1) and call `mssError()` in these functions. @@ -511,7 +503,6 @@ Each of these routines should return -1 on failure and return the number of byte ```c int xxxWrite(void* inf_v, char* buffer, int cnt, int offset, int flags, pObjTrxTree* oxt); ``` - The `Write()` function is very similar to the `Read()` function above, allowing the caller to write data to objects of supporting drivers with content. However, the third argument (`max_cnt`) is replaced with `cnt`, specifying the number of bytes of data in the buffer that should be written. @@ -638,8 +629,6 @@ The following five attributes are required (all are of type `DATA_T_STRING`): The `last_modification : DATA_T_DATETIME` attribute is a sixth, optional attribute that may be useful in some situations. This attribute should indicate the last time that the object's content was modified or updated. - - ### Function: GetAttrType() ```c From 3b866275fdfd0c8d805b0008c10e8f3d7502bc57 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Fri, 12 Dec 2025 12:36:39 -0700 Subject: [PATCH 037/275] Fix more styling mistakes. --- centrallix-lib/include/glyph.h | 1 + centrallix-lib/src/clusters.c | 69 ++++++--- centrallix-lib/src/util.c | 42 +++-- centrallix/expression/exp_functions.c | 130 +++++++++------- centrallix/objectsystem/obj_datatypes.c | 6 +- centrallix/osdrivers/objdrv_cluster.c | 198 +++++++++++++++++------- centrallix/utility/double_metaphone.c | 56 +++++-- 7 files changed, 342 insertions(+), 160 deletions(-) diff --git a/centrallix-lib/include/glyph.h b/centrallix-lib/include/glyph.h index 649437fac..4636d6b47 100644 --- a/centrallix-lib/include/glyph.h +++ b/centrallix-lib/include/glyph.h @@ -41,6 +41,7 @@ #ifdef ENABLE_GLYPHS #define glyph_print(s) printf("%s", s); + /*** Initialize a simple debug visualizer to make pretty patterns in the *** developer's terminal. Great for when you need to run a long task and *** want a super simple way to make sure it's still working. diff --git a/centrallix-lib/src/clusters.c b/centrallix-lib/src/clusters.c index d404e863e..505c3c272 100644 --- a/centrallix-lib/src/clusters.c +++ b/centrallix-lib/src/clusters.c @@ -56,7 +56,8 @@ *** @param c2 The second character in the pair. *** @returns The resulting hash. ***/ -static unsigned int hash_char_pair(const unsigned char c1, const unsigned char c2) +static unsigned int +hash_char_pair(const unsigned char c1, const unsigned char c2) { const double sum = (c1 * c1 * c1) + (c2 * c2 * c2); const double scale = ((double)c1 + 1.0) / ((double)c2 + 1.0); @@ -88,7 +89,8 @@ typedef struct *** An int < 0 if p2's hash is larger. *** 0 if p1 and p2 have identical hashes. ***/ -static int charpair_cmp(const void *p1, const void *p2) +static int +charpair_cmp(const void *p1, const void *p2) { const CharPair *a = p1, *b = p2; return a->hash - b->hash; @@ -139,7 +141,8 @@ static int charpair_cmp(const void *p1, const void *p2) *** @param str The string to be divided into pairs and hashed to make the vector. *** @returns The sparse vector built using the hashed character pairs. ***/ -pVector ca_build_vector(const char* str) +pVector +ca_build_vector(const char* str) { unsigned char* chars = NULL; CharPair* char_pairs = NULL; @@ -253,9 +256,12 @@ pVector ca_build_vector(const char* str) *** *** @param sparse_vector The sparse vector being freed. ***/ -void ca_free_vector(pVector sparse_vector) +void +ca_free_vector(pVector sparse_vector) { nmSysFree(sparse_vector); + + return; } /*** Compute the length of a sparsely allocated vector. @@ -263,7 +269,8 @@ void ca_free_vector(pVector sparse_vector) *** @param vector The vector. *** @returns The computed length. ***/ -unsigned int ca_sparse_len(const pVector vector) +unsigned int +ca_sparse_len(const pVector vector) { unsigned int i = 0u; @@ -286,13 +293,16 @@ unsigned int ca_sparse_len(const pVector vector) *** *** @param vector The vector. ***/ -void ca_print_vector(const pVector vector) +void +ca_print_vector(const pVector vector) { const unsigned int len = ca_sparse_len(vector); printf("Vector: [%d", vector[0]); for (unsigned int i = 1u; i < len; i++) printf(", %d", vector[i]); printf("]"); + + return; } /*** Compute the magnitude of a sparsely allocated vector. @@ -300,7 +310,8 @@ void ca_print_vector(const pVector vector) *** @param vector The vector. *** @returns The computed magnitude. ***/ -static double magnitude_sparse(const pVector vector) +static double +magnitude_sparse(const pVector vector) { unsigned int magnitude = 0u; @@ -323,7 +334,8 @@ static double magnitude_sparse(const pVector vector) *** @param centroid The centroid. *** @returns The computed magnitude. ***/ -static double magnitude_dense(const pCentroid centroid) +static double +magnitude_dense(const pCentroid centroid) { double magnitude = 0.0; @@ -340,7 +352,8 @@ static double magnitude_dense(const pCentroid centroid) *** @param remaining The location to save the remaining number of characters. *** @param param_value The location to save the param_value of the token. ***/ -static void parse_vector_token(const int token, unsigned int* remaining, unsigned int* param_value) +static void +parse_vector_token(const int token, unsigned int* remaining, unsigned int* param_value) { if (token < 0) { @@ -354,6 +367,8 @@ static void parse_vector_token(const int token, unsigned int* remaining, unsigne *remaining = 1u; *param_value = (unsigned)(token); } + + return; } /*** Calculate the similarity on sparsely allocated vectors. Comparing @@ -365,7 +380,8 @@ static void parse_vector_token(const int token, unsigned int* remaining, unsigne *** 1 indicates identical and *** 0 indicates completely different. ***/ -static double sparse_similarity(const pVector v1, const pVector v2) +static double +sparse_similarity(const pVector v1, const pVector v2) { /** Calculate dot product. **/ unsigned int vec1_remaining = 0u, vec2_remaining = 0u; @@ -416,7 +432,8 @@ static double sparse_similarity(const pVector v1, const pVector v2) *** 1 indicates identical and *** 0 indicates completely different. ***/ -static double sparse_similarity_to_centroid(const pVector v1, const pCentroid c2) +static double +sparse_similarity_to_centroid(const pVector v1, const pCentroid c2) { double dot_product = 0.0; @@ -462,7 +479,8 @@ static double sparse_similarity_to_centroid(const pVector v1, const pCentroid c2 *** @attention - `Complexity`: O(nm), where n and m are the lengths of str1 *** and str2 (respectively). ***/ -int ca_edit_dist(const char* str1, const char* str2, const size_t str1_length, const size_t str2_length) +int +ca_edit_dist(const char* str1, const char* str2, const size_t str1_length, const size_t str2_length) { int result = -1; unsigned int** lev_matrix = NULL; @@ -574,7 +592,8 @@ int ca_edit_dist(const char* str1, const char* str2, const size_t str1_length, c *** @param v2 A `pVector` to the second string to compare. *** @returns The cosine similarity between the two strings. ***/ -double ca_cos_compare(void* v1, void* v2) +double +ca_cos_compare(void* v1, void* v2) { if (v1 == v2) return 1.0; @@ -603,7 +622,8 @@ double ca_cos_compare(void* v1, void* v2) *** @param str2 A `char*` to the second string to compare. *** @returns The levenshtein similarity between the two strings, or NAN on failure. ***/ -double ca_lev_compare(void* str1, void* str2) +double +ca_lev_compare(void* str1, void* str2) { /** Input validation checks. **/ if (str1 == NULL || str2 == NULL) return 0.0; @@ -634,7 +654,8 @@ double ca_lev_compare(void* str1, void* str2) *** @returns true if they are equal, *** false if any element is different. ***/ -bool ca_eql(pVector v1, pVector v2) +bool +ca_eql(pVector v1, pVector v2) { const unsigned int len = ca_sparse_len(v1); @@ -653,7 +674,8 @@ bool ca_eql(pVector v1, pVector v2) *** @param num_clusters The number of centroids (k). *** @returns The average cluster size. ***/ -static double get_cluster_size( +static double +get_cluster_size( pVector* vectors, const unsigned int num_vectors, unsigned int* labels, @@ -748,7 +770,8 @@ static double get_cluster_size( *** *** - `O(nk + nd)` ***/ -int ca_kmeans( +int +ca_kmeans( pVector* vectors, const unsigned int num_vectors, const unsigned int num_clusters, @@ -924,7 +947,8 @@ int ca_kmeans( *** @returns A pointer to the most similar piece of data found in the data *** array, or NULL if the most similar data did not meet the threshold. ***/ -void* ca_most_similar( +void* +ca_most_similar( void* target, void** data, const unsigned int num_data, @@ -934,10 +958,11 @@ void* ca_most_similar( void* most_similar = NULL; double best_sim = -INFINITY; + /** Iterate over all data options to find the one with the highest similarity. **/ for (unsigned int i = 0u; (num_data == 0u) ? (data[i] != NULL) : (i < num_data); i++) { const double sim = check_double(similarity(target, data[i])); - if (isnan(sim)) continue; /* Skip this comparison. */ + if (isnan(sim)) continue; /* Skip failed comparison. */ if (sim > best_sim && sim > threshold) { most_similar = data[i]; @@ -970,7 +995,8 @@ void* ca_most_similar( *** @returns An xArray holding all of the duplocates found, or NULL if an *** error occurs. ***/ -pXArray ca_sliding_search( +pXArray +ca_sliding_search( void** data, const unsigned int num_data, const unsigned int window_size, @@ -1051,7 +1077,8 @@ pXArray ca_sliding_search( *** @returns An xArray holding all of the duplocates found. If maybe_dups is *** not NULL, this will be that xArray, to allow for chaining. ***/ -pXArray ca_complete_search( +pXArray +ca_complete_search( void** data, const unsigned int num_data, const double (*similarity)(void*, void*), diff --git a/centrallix-lib/src/util.c b/centrallix-lib/src/util.c index 6dbc8bd22..6e35fb99b 100644 --- a/centrallix-lib/src/util.c +++ b/centrallix-lib/src/util.c @@ -111,7 +111,8 @@ static char* units_metric[N_UNITS] = {"bytes", "KB", "MB", "GB"}; *** to the buffer.. *** @returns buf, for chaining. ***/ -char* snprint_bytes(char* buf, const size_t buf_size, unsigned int bytes) +char* +snprint_bytes(char* buf, const size_t buf_size, unsigned int bytes) { char** units = (USE_METRIC) ? units_metric : units_cs; const double unit_size = (USE_METRIC) ? 1000.0 : 1024.0; @@ -148,7 +149,8 @@ char* snprint_bytes(char* buf, const size_t buf_size, unsigned int bytes) *** @param value The value to write into the buffer. *** @returns `buf`, or `NULL` if `buf_size` is 0. */ -char* snprint_commas_llu(char* buf, size_t buf_size, unsigned long long value) +char* +snprint_commas_llu(char* buf, size_t buf_size, unsigned long long value) { if (buf_size == 0) return NULL; if (value == 0) @@ -175,7 +177,8 @@ char* snprint_commas_llu(char* buf, size_t buf_size, unsigned long long value) return buf; } -void fprint_mem(FILE* out) +void +fprint_mem(FILE* out) { FILE* fp = fopen("/proc/self/statm", "r"); if (fp == NULL) { perror("fopen()"); return; } @@ -199,9 +202,12 @@ void fprint_mem(FILE* out) fprintf(out, "Memory used: %ld bytes (%s)\n", resident_bytes, buf); fprintf(out, "Share %ldb, Text %ldb, Lib %ldb, Data %ldb\n", share, text, lib, data); + + return; } -static double get_time(void) +static double +get_time(void) { struct timespec ts; @@ -210,7 +216,8 @@ static double get_time(void) return (double)ts.tv_sec + (double)ts.tv_nsec / 1.0e9f; } -pTimer timer_init(pTimer timer) +pTimer +timer_init(pTimer timer) { if (timer == NULL) return NULL; timer->start = NAN; @@ -219,12 +226,14 @@ pTimer timer_init(pTimer timer) return timer; } -pTimer timer_new(void) +pTimer +timer_new(void) { return timer_init(nmMalloc(sizeof(Timer))); } -pTimer timer_start(pTimer timer) +pTimer +timer_start(pTimer timer) { if (!timer) return timer; timer->start = get_time(); @@ -232,7 +241,8 @@ pTimer timer_start(pTimer timer) return timer; } -pTimer timer_stop(pTimer timer) +pTimer +timer_stop(pTimer timer) { if (!timer) return timer; timer->total += get_time() - timer->start; @@ -240,22 +250,28 @@ pTimer timer_stop(pTimer timer) return timer; } -double timer_get(pTimer timer) +double +timer_get(pTimer timer) { return (timer) ? timer->total : NAN; } -pTimer timer_reset(pTimer timer) +pTimer +timer_reset(pTimer timer) { return timer_init(timer); } -void timer_de_init(pTimer timer) {} +void +timer_de_init(pTimer timer) {} -void timer_free(pTimer timer) +void +timer_free(pTimer timer) { timer_de_init(timer); nmFree(timer, sizeof(Timer)); + + return; } /*** Function for failing on error, assuming the error came from a library or @@ -271,4 +287,6 @@ void print_err(int code, const char* function_name, const char* file_name, const if (errno != 0) perror(error_buf); else if (code != 0) fprintf(stderr, "%s (error code %d).\n", error_buf, code); else fprintf(stderr, "%s.\n", error_buf); + + return; } diff --git a/centrallix/expression/exp_functions.c b/centrallix/expression/exp_functions.c index 772672bca..70bbf480d 100644 --- a/centrallix/expression/exp_functions.c +++ b/centrallix/expression/exp_functions.c @@ -127,7 +127,8 @@ typedef struct *** @returns 0 if the expectations are successfully met, *** -1 if an expectation is violated (and mssError() is called). ***/ -static int exp_fn_i_verify_arg(const char* fn_name, pExpression arg, const ArgExpect* arg_expect) +static int +exp_fn_i_verify_arg(const char* fn_name, pExpression arg, const ArgExpect* arg_expect) { /** The expectation struct cannot be NULL. **/ if (arg_expect == NULL) @@ -388,7 +389,8 @@ static int exp_fn_i_verify_arg(const char* fn_name, pExpression arg, const ArgEx *** } *** ``` ***/ -static int exp_fn_i_verify_schema(const ArgExpect* arg_expects, pExpression tree) +static int +exp_fn_i_verify_schema(const ArgExpect* arg_expects, pExpression tree) { /** Verify expression tree. **/ ASSERTMAGIC(tree, MGK_EXPRESSION); @@ -460,35 +462,36 @@ static int exp_fn_i_verify_schema(const ArgExpect* arg_expects, pExpression tree *** -1 on failure, *** 1 if the expression is NULL. ***/ -static int exp_fn_i_get_number(pExpression numeric_expr, double* result_ptr) +static int +exp_fn_i_get_number(pExpression numeric_expr, double* result_ptr) { - /** Check for null values. **/ - if (numeric_expr == NULL || numeric_expr->Flags & EXPR_F_NULL) return 1; - - /** Check for null destination. **/ - if (result_ptr == NULL) - { - mssError(1, "EXP", "Null location provided to store numeric result."); - return -1; - } - - /** Get the numeric value. **/ - double n; - switch(numeric_expr->DataType) - { - case DATA_T_INTEGER: n = numeric_expr->Integer; break; - case DATA_T_DOUBLE: n = numeric_expr->Types.Double; break; - case DATA_T_MONEY: n = objDataToDouble(DATA_T_MONEY, &(numeric_expr->Types.Money)); break; - default: - mssError(1, "EXP", - "%s (%d) is not a numeric type.", - objTypeToStr(numeric_expr->DataType), numeric_expr->DataType - ); + /** Check for null values. **/ + if (numeric_expr == NULL || numeric_expr->Flags & EXPR_F_NULL) return 1; + + /** Check for null destination. **/ + if (result_ptr == NULL) + { + mssError(1, "EXP", "Null location provided to store numeric result."); return -1; - } - - /** Store the result. **/ - *result_ptr = n; + } + + /** Get the numeric value. **/ + double n; + switch(numeric_expr->DataType) + { + case DATA_T_INTEGER: n = numeric_expr->Integer; break; + case DATA_T_DOUBLE: n = numeric_expr->Types.Double; break; + case DATA_T_MONEY: n = objDataToDouble(DATA_T_MONEY, &(numeric_expr->Types.Money)); break; + default: + mssError(1, "EXP", + "%s (%d) is not a numeric type.", + objTypeToStr(numeric_expr->DataType), numeric_expr->DataType + ); + return -1; + } + + /** Store the result. **/ + *result_ptr = n; return 0; } @@ -497,7 +500,8 @@ static int exp_fn_i_get_number(pExpression numeric_expr, double* result_ptr) *** *** @param tree The affected tree. ***/ -static void exp_fn_i_free_result_string(pExpression tree) +static void +exp_fn_i_free_result_string(pExpression tree) { /** If no string is allocated, no work is needed. **/ if (tree->Alloc == 0) return; @@ -507,6 +511,8 @@ static void exp_fn_i_free_result_string(pExpression tree) /** No string is allocated anymore. */ tree->Alloc = 0; + + return; } /*** Ensure that the allocated result string is long enough to store a given @@ -518,7 +524,8 @@ static void exp_fn_i_free_result_string(pExpression tree) *** @returns 0 if successful, or *** -1 if an error occurs. ***/ -static int exp_fn_i_alloc_result_string(pExpression tree, const size_t required_space) +static int +exp_fn_i_alloc_result_string(pExpression tree, const size_t required_space) { /** Free the previous string (if needed) so we can store a new one. **/ exp_fn_i_free_result_string(tree); @@ -1589,7 +1596,8 @@ int exp_fn_reverse(pExpression tree, pParamObjects objlist, pExpression i0, pExp } /** Leading zero trim. */ -int exp_fn_lztrim(pExpression tree, pParamObjects objlist, pExpression i0, pExpression i1, pExpression i2) +int +exp_fn_lztrim(pExpression tree, pParamObjects objlist, pExpression i0, pExpression i1, pExpression i2) { /** Expect one nullable string parameter. **/ if (exp_fn_i_verify_schema((ArgExpect[]){ @@ -1630,7 +1638,8 @@ int exp_fn_lztrim(pExpression tree, pParamObjects objlist, pExpression i0, pExpr /** Left trim spaces. **/ -int exp_fn_ltrim(pExpression tree) +int +exp_fn_ltrim(pExpression tree) { /** Expect one nullable string parameter. **/ if (exp_fn_i_verify_schema((ArgExpect[]){ @@ -1672,7 +1681,8 @@ int exp_fn_ltrim(pExpression tree) /** Right trim spaces. **/ -int exp_fn_rtrim(pExpression tree) +int +exp_fn_rtrim(pExpression tree) { /** Expect one nullable string parameter. **/ if (exp_fn_i_verify_schema((ArgExpect[]){ @@ -1723,7 +1733,8 @@ int exp_fn_rtrim(pExpression tree) /** Left and right trim spaces. **/ -int exp_fn_trim(pExpression tree) +int +exp_fn_trim(pExpression tree) { /** Left trim the expression. **/ exp_fn_ltrim(tree); @@ -3768,7 +3779,8 @@ int exp_fn_from_base64(pExpression tree, pParamObjects objlist, pExpression i0, return -1; } -static int exp_fn_i_do_math(pExpression tree, double (*math)(), int arg_num) +static int +exp_fn_i_do_math(pExpression tree, double (*math)(), int arg_num) { /** Verify function schema: expect arg_num numeric values. **/ ArgExpect expects[arg_num + 1]; @@ -3818,20 +3830,26 @@ static int exp_fn_i_do_math(pExpression tree, double (*math)(), int arg_num) return 0; } -int exp_fn_power(pExpression tree) +int +exp_fn_power(pExpression tree) { return exp_fn_i_do_math(tree, pow, 2); } -int exp_fn_ln(pExpression tree) + +int +exp_fn_ln(pExpression tree) { return exp_fn_i_do_math(tree, log, 1); } -int exp_fn_log10(pExpression tree) + +int +exp_fn_log10(pExpression tree) { return exp_fn_i_do_math(tree, log10, 1); } -int exp_fn_log(pExpression tree) +int +exp_fn_log(pExpression tree) { /** Verify function schema: A number and an optional base. **/ if (exp_fn_i_verify_schema((ArgExpect[]){ @@ -4528,17 +4546,16 @@ int exp_fn_nth(pExpression tree, pParamObjects objlist, pExpression i0, pExpress } -int exp_fn_metaphone(pExpression tree, pParamObjects obj_list) +int +exp_fn_metaphone(pExpression tree, pParamObjects obj_list) { - const char fn_name[] = "metaphone"; - /** Verify function schema. **/ if (exp_fn_i_verify_schema((ArgExpect[]){ {(int[]){DATA_T_STRING, -1}, EXP_ARG_NO_FLAGS}, EXP_ARG_END, }, tree) != 0) { - mssErrorf(0, "EXP", "%s(?): Call does not match function schema.", fn_name); + mssErrorf(0, "EXP", "%s(?): Call does not match function schema.", tree->Name); return -1; } @@ -4586,7 +4603,8 @@ int exp_fn_metaphone(pExpression tree, pParamObjects obj_list) *** @param fn_name Either `cos_compare()` or `lev_compare()`. *** @returns 0 for success, -1 for failure. ***/ -static int exp_fn_compare(pExpression tree, pParamObjects obj_list, const char* fn_name) +static int +exp_fn_compare(pExpression tree, pParamObjects obj_list, const char* fn_name) { /** Verify function schema. **/ if (exp_fn_i_verify_schema((ArgExpect[]){ @@ -4654,25 +4672,25 @@ static int exp_fn_compare(pExpression tree, pParamObjects obj_list, const char* tree->DataType = DATA_T_DOUBLE; return 0; } - - return -1; + + return -1; /* Unreachable. */ } - -int exp_fn_cos_compare(pExpression tree, pParamObjects obj_list) +int +exp_fn_cos_compare(pExpression tree, pParamObjects obj_list) { return exp_fn_compare(tree, obj_list, "cos_compare"); } -int exp_fn_lev_compare(pExpression tree, pParamObjects obj_list) + +int +exp_fn_lev_compare(pExpression tree, pParamObjects obj_list) { return exp_fn_compare(tree, obj_list, "lev_compare"); } - -int exp_fn_levenshtein(pExpression tree, pParamObjects obj_list) +int +exp_fn_levenshtein(pExpression tree, pParamObjects obj_list) { - const char fn_name[] = "levenshtein"; - /** Verify function schema. **/ if (exp_fn_i_verify_schema((ArgExpect[]){ {(int[]){DATA_T_STRING, -1}, EXP_ARG_NO_FLAGS}, @@ -4680,7 +4698,7 @@ int exp_fn_levenshtein(pExpression tree, pParamObjects obj_list) EXP_ARG_END, }, tree) != 0) { - mssErrorf(0, "EXP", "%s(?): Call does not match function schema.", fn_name); + mssErrorf(0, "EXP", "%s(?): Call does not match function schema.", tree->Name); return -1; } @@ -4701,7 +4719,7 @@ int exp_fn_levenshtein(pExpression tree, pParamObjects obj_list) int edit_dist = ca_edit_dist(str1, str2, 0lu, 0lu); if (!check_neg(edit_dist)) { - mssErrorf(1, "EXP", "%s(\"%s\", \"%s\"): Failed to compute edit distance.\n", fn_name, str1, str2); + mssErrorf(1, "EXP", "%s(\"%s\", \"%s\"): Failed to compute edit distance.\n", tree->Name, str1, str2); return -1; } diff --git a/centrallix/objectsystem/obj_datatypes.c b/centrallix/objectsystem/obj_datatypes.c index 4510e2116..5d36089a1 100644 --- a/centrallix/objectsystem/obj_datatypes.c +++ b/centrallix/objectsystem/obj_datatypes.c @@ -139,7 +139,8 @@ char* obj_default_null_fmt = "NULL"; *** *** LINK ../../centrallix-lib/include/datatypes.h:72 ***/ -int objTypeFromStr(const char* str) +int +objTypeFromStr(const char* str) { /** All valid types are non-null strings, at least 2 characters long. **/ if (str == NULL || str[0] == '\0' || str[1] == '\0') return -1; @@ -197,7 +198,8 @@ int objTypeFromStr(const char* str) *** "(unknown)" if the type is unknown, or *** "invalid" if the type number cannot even be a valid type. ***/ -char* objTypeToStr(const int type) +char* +objTypeToStr(const int type) { /** Guard out of bounds reads. **/ if (type < 0 || OBJ_TYPE_NAMES_CNT <= type) diff --git a/centrallix/osdrivers/objdrv_cluster.c b/centrallix/osdrivers/objdrv_cluster.c index a30ba2d84..94a58cf5f 100644 --- a/centrallix/osdrivers/objdrv_cluster.c +++ b/centrallix/osdrivers/objdrv_cluster.c @@ -101,7 +101,8 @@ *** @param ... Variables matching format specifiers in the format. *** @returns Nothing, always succeeds. ***/ -void mssErrorf(int clr, char* module, const char* format, ...) +void +mssErrorf(int clr, char* module, const char* format, ...) { /** Prevent interlacing with stdout flushing at a weird time. **/ check(fflush(stdout)); /* Failure ignored. */ @@ -131,6 +132,8 @@ void mssErrorf(int clr, char* module, const char* format, ...) /** Not sure why you have to error check the error function... **/ if (ret != 0) fprintf(stderr, "FAIL %d: mssError(%d, \"%s\", \"%%s\", \"%s\")\n", ret, clr, module, buf); + + return; } @@ -144,7 +147,8 @@ void mssErrorf(int clr, char* module, const char* format, ...) *** *: Any other value prints a warning and does nothing. *** @returns The new array, or null if and only if the passed pXArray has 0 items. ***/ -static void** ci_xaToTrimmedArray(pXArray arr, int array_handling) +static void** +ci_xaToTrimmedArray(pXArray arr, int array_handling) { const size_t arr_size = arr->nItems * sizeof(void*); void** result = check_ptr(nmSysMalloc(arr_size)); @@ -208,7 +212,8 @@ ClusterAlgorithm ALL_CLUSTERING_ALGORITHMS[nClusteringAlgorithms] = }; /** Converts a clustering algorithm to its string name. **/ -char* ci_ClusteringAlgorithmToString(ClusterAlgorithm clustering_algorithm) +char* +ci_ClusteringAlgorithmToString(ClusterAlgorithm clustering_algorithm) { switch (clustering_algorithm) { @@ -221,6 +226,8 @@ char* ci_ClusteringAlgorithmToString(ClusterAlgorithm clustering_algorithm) case ALGORITHM_DB_SCAN: return "db-scan"; default: return "Unknown algorithm"; } + + return; /** Unreachable. **/ } /** Enum representing a similarity measurement algorithm. **/ @@ -238,7 +245,8 @@ SimilarityMeasure ALL_SIMILARITY_MEASURES[nSimilarityMeasures] = }; /** Converts a similarity measure to its string name. **/ -char* ci_SimilarityMeasureToString(SimilarityMeasure similarity_measure) +char* +ci_SimilarityMeasureToString(SimilarityMeasure similarity_measure) { switch (similarity_measure) { @@ -247,6 +255,8 @@ char* ci_SimilarityMeasureToString(SimilarityMeasure similarity_measure) case SIMILARITY_LEVENSHTEIN: return "levenshtein"; default: return "Unknown similarity measure"; } + + return; /** Unreachable. **/ } /*** Enum representing the type of data targetted by the driver, @@ -690,6 +700,8 @@ int clusterCommit(void* inf_v, pObjTrxTree *oxt); static void ci_GiveHint(const char* hint) { fprintf(stderr, " > Hint: Did you mean \"%s\"?\n", hint); + + return; } @@ -703,7 +715,8 @@ static void ci_GiveHint(const char* hint) *** length on a null terminated array of values. *** @returns Whether a hint was given. ***/ -static bool ci_TryHint(char* value, char** valid_values, const unsigned int n_valid_values) +static bool +ci_TryHint(char* value, char** valid_values, const unsigned int n_valid_values) { char* guess = ca_most_similar(value, (void**)valid_values, n_valid_values, ca_lev_compare, 0.25); if (guess == NULL) return false; /* No hint. */ @@ -727,7 +740,8 @@ static bool ci_TryHint(char* value, char** valid_values, const unsigned int n_va *** is NOT REQUIRED for dynamic attributes in the cluster driver. I had to debug *** and rewrite this for ages and it uses several functions I don't 100% understand. ***/ -static int ci_ParseAttribute( +static int +ci_ParseAttribute( pStructInf inf, char* attr_name, int datatype, @@ -809,7 +823,8 @@ static int ci_ParseAttribute( *** evaluating parameter variables in the structure file. *** @returns The data algorithm, or ALGORITHM_NULL on failure. ***/ -static ClusterAlgorithm ci_ParseClusteringAlgorithm(pStructInf inf, pParamObjects param_list) +static ClusterAlgorithm +ci_ParseClusteringAlgorithm(pStructInf inf, pParamObjects param_list) { /** Get the algorithm attribute. **/ char* algorithm; @@ -857,7 +872,8 @@ static ClusterAlgorithm ci_ParseClusteringAlgorithm(pStructInf inf, pParamObject *** evaluating parameter variables in the structure file. *** @returns The similarity measure, or SIMILARITY_NULL on failure. ***/ -static SimilarityMeasure ci_ParseSimilarityMeasure(pStructInf inf, pParamObjects param_list) +static SimilarityMeasure +ci_ParseSimilarityMeasure(pStructInf inf, pParamObjects param_list) { /** Get the similarity_measure attribute. **/ char* measure; @@ -903,7 +919,8 @@ static SimilarityMeasure ci_ParseSimilarityMeasure(pStructInf inf, pParamObjects *** cache entry keys. *** @returns A new pSourceData struct on success, or NULL on failure. ***/ -static pSourceData ci_ParseSourceData(pStructInf inf, pParamObjects param_list, char* path) +static pSourceData +ci_ParseSourceData(pStructInf inf, pParamObjects param_list, char* path) { char* buf = NULL; pSourceData source_data = NULL; @@ -995,7 +1012,8 @@ static pSourceData ci_ParseSourceData(pStructInf inf, pParamObjects param_list, *** used to generate cache entry keys. *** @returns A new pClusterData struct on success, or NULL on failure. ***/ -static pClusterData ci_ParseClusterData(pStructInf inf, pNodeData node_data) +static pClusterData +ci_ParseClusterData(pStructInf inf, pNodeData node_data) { int result; pClusterData cluster_data = NULL; @@ -1294,7 +1312,8 @@ static pClusterData ci_ParseClusterData(pStructInf inf, pNodeData node_data) *** the cluster pointed to by the source attribute. *** @returns A new pSearchData struct on success, or NULL on failure. ***/ -static pSearchData ci_ParseSearchData(pStructInf inf, pNodeData node_data) +static pSearchData +ci_ParseSearchData(pStructInf inf, pNodeData node_data) { pSearchData search_data = NULL; char* key = NULL; @@ -1471,7 +1490,8 @@ static pSearchData ci_ParseSearchData(pStructInf inf, pNodeData node_data) *** @param parent The parent object struct. *** @returns A new pNodeData struct on success, or NULL on failure. ***/ -static pNodeData ci_ParseNodeData(pStructInf inf, pObject parent) +static pNodeData +ci_ParseNodeData(pStructInf inf, pObject parent) { int ret = -1; pNodeData node_data = NULL; @@ -1758,7 +1778,8 @@ static pNodeData ci_ParseNodeData(pStructInf inf, pObject parent) // LINK #functions /** @param source_data A pSourceData struct, freed by this function. **/ -static void ci_FreeSourceData(pSourceData source_data) +static void +ci_FreeSourceData(pSourceData source_data) { /** Guard segfault. **/ if (source_data == NULL) @@ -1820,6 +1841,8 @@ static void ci_FreeSourceData(pSourceData source_data) /** Free the source data struct. **/ nmFree(source_data, sizeof(SourceData)); source_data = NULL; + + return; } @@ -1829,7 +1852,8 @@ static void ci_FreeSourceData(pSourceData source_data) *** @param cluster_data The cluster data struct to free. *** @param recursive Whether to recursively free subclusters. ***/ -static void ci_FreeClusterData(pClusterData cluster_data, bool recursive) +static void +ci_FreeClusterData(pClusterData cluster_data, bool recursive) { /** Guard segfault. **/ if (cluster_data == NULL) @@ -1883,12 +1907,15 @@ static void ci_FreeClusterData(pClusterData cluster_data, bool recursive) /** Free the cluster data struct. **/ nmFree(cluster_data, sizeof(ClusterData)); cluster_data = NULL; + + return; } // LINK #functions /** @param search_data A pSearchData struct, freed by this function. **/ -static void ci_FreeSearchData(pSearchData search_data) +static void +ci_FreeSearchData(pSearchData search_data) { /** Guard segfault. **/ if (search_data == NULL) @@ -1919,12 +1946,15 @@ static void ci_FreeSearchData(pSearchData search_data) /** Free the search data struct. **/ nmFree(search_data, sizeof(SearchData)); search_data = NULL; + + return; } // LINK #functions /** @param node_data A pNodeData struct, freed by this function. **/ -static void ci_FreeNodeData(pNodeData node_data) +static void +ci_FreeNodeData(pNodeData node_data) { /** Guard segfault. **/ if (node_data == NULL) @@ -1991,10 +2021,13 @@ static void ci_FreeNodeData(pNodeData node_data) /** Free the node data. **/ nmFree(node_data, sizeof(NodeData)); node_data = NULL; + + return; } /** Frees all data in caches for all cluster driver instances. **/ -static void ci_ClearCaches(void) +static void +ci_ClearCaches(void) { /*** Free caches in reverse of the order they are created in case *** cached data relies on its source during the freeing process. @@ -2002,6 +2035,8 @@ static void ci_ClearCaches(void) check(xhClearKeySafe(&ClusterDriverCaches.SearchDataCache, ci_CacheFreeSearch, NULL)); /* Failure ignored. */ check(xhClearKeySafe(&ClusterDriverCaches.ClusterDataCache, ci_CacheFreeCluster, NULL)); /* Failure ignored. */ check(xhClearKeySafe(&ClusterDriverCaches.SourceDataCache, ci_CacheFreeSourceData, NULL)); /* Failure ignored. */ + + return; } @@ -2019,7 +2054,8 @@ static void ci_ClearCaches(void) *** @param source_data The source data struct to be queried. *** @returns The size in bytes of the struct and all internal allocated data. ***/ -static unsigned int ci_SizeOfSourceData(pSourceData source_data) +static unsigned int +ci_SizeOfSourceData(pSourceData source_data) { /** Guard segfault. **/ if (source_data == NULL) @@ -2063,7 +2099,8 @@ static unsigned int ci_SizeOfSourceData(pSourceData source_data) *** @param recursive Whether to recursively free subclusters. *** @returns The size in bytes of the struct and all internal allocated data. ***/ -static unsigned int ci_SizeOfClusterData(pClusterData cluster_data, bool recursive) +static unsigned int +ci_SizeOfClusterData(pClusterData cluster_data, bool recursive) { /** Guard segfault. **/ if (cluster_data == NULL) @@ -2107,7 +2144,8 @@ static unsigned int ci_SizeOfClusterData(pClusterData cluster_data, bool recursi *** @param search_data The search data struct to be queried. *** @returns The size in bytes of the struct and all internal allocated data. ***/ -static unsigned int ci_SizeOfSearchData(pSearchData search_data) +static unsigned int +ci_SizeOfSearchData(pSearchData search_data) { /** Guard segfault. **/ if (search_data == NULL) @@ -2140,7 +2178,8 @@ static unsigned int ci_SizeOfSearchData(pSearchData search_data) *** @returns 0 if successful, or *** -1 other value on failure. ***/ -static int ci_ComputeSourceData(pSourceData source_data, pObjSession session) +static int +ci_ComputeSourceData(pSourceData source_data, pObjSession session) { bool successful = false; int ret; @@ -2467,7 +2506,8 @@ static int ci_ComputeSourceData(pSourceData source_data, pObjSession session) *** @returns 0 if successful, or *** -1 other value on failure. ***/ -static int ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data) +static int +ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data) { cluster_data->Sims = NULL; cluster_data->Clusters = NULL; @@ -2637,7 +2677,8 @@ static int ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data) *** @returns 0 if successful, or *** -1 other value on failure. ***/ -static int ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) +static int +ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) { pXArray dups = NULL; @@ -2803,7 +2844,8 @@ static int ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) *** *** LINK ../../centrallix-lib/include/datatypes.h:72 ***/ -static int ci_GetParamType(void* inf_v, const char* attr_name) +static int +ci_GetParamType(void* inf_v, const char* attr_name) { pNodeData node_data = (pNodeData)inf_v; @@ -2846,7 +2888,8 @@ static int ci_GetParamType(void* inf_v, const char* attr_name) *** *** LINK ../../centrallix-lib/include/datatypes.h:72 ***/ -static int ci_GetParamValue(void* inf_v, char* attr_name, int datatype, pObjData val) +static int +ci_GetParamValue(void* inf_v, char* attr_name, int datatype, pObjData val) { pNodeData node_data = (pNodeData)inf_v; @@ -2881,7 +2924,8 @@ static int ci_GetParamValue(void* inf_v, char* attr_name, int datatype, pObjData // LINK #functions /** Not implemented. **/ -static int ci_SetParamValue(void* inf_v, char* attr_name, int datatype, pObjData val) +static int +ci_SetParamValue(void* inf_v, char* attr_name, int datatype, pObjData val) { mssErrorf(1, "Cluster", "SetParamValue() is not implemented because clusters are imutable."); @@ -2908,7 +2952,8 @@ static int ci_SetParamValue(void* inf_v, char* attr_name, int datatype, pObjData *** @returns A pDriverData struct representing a driver instance, or *** NULL if an error occurs. ***/ -void* clusterOpen(pObject parent, int mask, pContentType sys_type, char* usr_type, pObjTrxTree* oxt) +void* +clusterOpen(pObject parent, int mask, pContentType sys_type, char* usr_type, pObjTrxTree* oxt) { pNodeData node_data = NULL; pDriverData driver_data = NULL; @@ -3075,7 +3120,8 @@ void* clusterOpen(pObject parent, int mask, pContentType sys_type, char* usr_typ *** @param oxt The object system tree, similar to a kind of "scope" (unused). *** @returns 0, success. ***/ -int clusterClose(void* inf_v, pObjTrxTree* oxt) +int +clusterClose(void* inf_v, pObjTrxTree* oxt) { pDriverData driver_data = (pDriverData)inf_v; @@ -3109,7 +3155,8 @@ int clusterClose(void* inf_v, pObjTrxTree* oxt) *** @returns The cluster query, or *** NULL if an error occurs. ***/ -void* clusterOpenQuery(void* inf_v, pObjQuery query, pObjTrxTree* oxt) +void* +clusterOpenQuery(void* inf_v, pObjQuery query, pObjTrxTree* oxt) { pClusterQuery cluster_query = NULL; pDriverData driver_data = inf_v; @@ -3149,7 +3196,8 @@ void* clusterOpenQuery(void* inf_v, pObjQuery query, pObjTrxTree* oxt) *** pointing to a specific target index into the relevant data. *** OR NULL, indicating that all data has been fetched. ***/ -void* clusterQueryFetch(void* qy_v, pObject obj, int mode, pObjTrxTree* oxt) +void* +clusterQueryFetch(void* qy_v, pObject obj, int mode, pObjTrxTree* oxt) { pClusterQuery cluster_query = (pClusterQuery)qy_v; pDriverData driver_data = cluster_query->DriverData; @@ -3281,7 +3329,8 @@ void* clusterQueryFetch(void* qy_v, pObject obj, int mode, pObjTrxTree* oxt) *** @param oxt The object system tree, similar to a kind of "scope" (unused). *** @returns 0, success. ***/ -int clusterQueryClose(void* qy_v, pObjTrxTree* oxt) +int +clusterQueryClose(void* qy_v, pObjTrxTree* oxt) { if (qy_v != NULL) nmFree(qy_v, sizeof(ClusterQuery)); @@ -3299,7 +3348,8 @@ int clusterQueryClose(void* qy_v, pObjTrxTree* oxt) *** *** LINK ../../centrallix-lib/include/datatypes.h:72 ***/ -int clusterGetAttrType(void* inf_v, char* attr_name, pObjTrxTree* oxt) +int +clusterGetAttrType(void* inf_v, char* attr_name, pObjTrxTree* oxt) { pDriverData driver_data = (pDriverData)inf_v; @@ -3407,7 +3457,8 @@ int clusterGetAttrType(void* inf_v, char* attr_name, pObjTrxTree* oxt) *** *** LINK ../../centrallix-lib/include/datatypes.h:72 ***/ -int clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val, pObjTrxTree* oxt) +int +clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val, pObjTrxTree* oxt) { pDriverData driver_data = (pDriverData)inf_v; @@ -3743,7 +3794,8 @@ int clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val *** @returns A presentation hints object, if successful, *** NULL if an error occurs. ***/ -pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pObjTrxTree* oxt) +pObjPresentationHints +clusterPresentationHints(void* inf_v, char* attr_name, pObjTrxTree* oxt) { pDriverData driver_data = (pDriverData)inf_v; pObjPresentationHints hints = NULL; @@ -4047,7 +4099,8 @@ pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pOb *** @param oxt Unused. *** @returns The name of the first attribute. ***/ -char* clusterGetFirstAttr(void* inf_v, pObjTrxTree* oxt) +char* +clusterGetFirstAttr(void* inf_v, pObjTrxTree* oxt) { pDriverData driver_data = (pDriverData)inf_v; @@ -4067,7 +4120,8 @@ char* clusterGetFirstAttr(void* inf_v, pObjTrxTree* oxt) *** @param oxt Unused. *** @returns The name of the next attribute. ***/ -char* clusterGetNextAttr(void* inf_v, pObjTrxTree* oxt) +char* +clusterGetNextAttr(void* inf_v, pObjTrxTree* oxt) { pDriverData driver_data = (pDriverData)inf_v; @@ -4083,6 +4137,8 @@ char* clusterGetNextAttr(void* inf_v, pObjTrxTree* oxt) mssErrorf(1, "Cluster", "Unknown target type %u.", driver_data->TargetType); return NULL; } + + return; /* Unreachable. */ } @@ -4094,7 +4150,8 @@ char* clusterGetNextAttr(void* inf_v, pObjTrxTree* oxt) *** @returns 0 if successful, *** -1 if the driver is an unimplemented type (should never happen). ***/ -int clusterInfo(void* inf_v, pObjectInfo info) +int +clusterInfo(void* inf_v, pObjectInfo info) { pDriverData driver_data = (pDriverData)inf_v; pNodeData node_data = (pNodeData)driver_data->NodeData; @@ -4180,7 +4237,8 @@ int clusterInfo(void* inf_v, pObjectInfo info) *** @param oxt Unused. *** @returns The name of the first method. ***/ -char* clusterGetFirstMethod(void* inf_v, pObjTrxTree* oxt) +char* +clusterGetFirstMethod(void* inf_v, pObjTrxTree* oxt) { pDriverData driver_data = (pDriverData)inf_v; @@ -4200,7 +4258,8 @@ char* clusterGetFirstMethod(void* inf_v, pObjTrxTree* oxt) *** @param oxt Unused. *** @returns The name of the next method. ***/ -char* clusterGetNextMethod(void* inf_v, pObjTrxTree* oxt) +char* +clusterGetNextMethod(void* inf_v, pObjTrxTree* oxt) { pDriverData driver_data = (pDriverData)inf_v; @@ -4210,7 +4269,8 @@ char* clusterGetNextMethod(void* inf_v, pObjTrxTree* oxt) // LINK #functions /** Intended for use in xhForEach(). **/ -static int ci_PrintEntry(pXHashEntry entry, void* arg) +static int +ci_PrintEntry(pXHashEntry entry, void* arg) { /** Extract entry. **/ char* key = entry->Key; @@ -4300,7 +4360,8 @@ static int ci_PrintEntry(pXHashEntry entry, void* arg) // LINK #functions /** Intended for use in xhClearKeySafe(). **/ -static void ci_CacheFreeSourceData(pXHashEntry entry, void* path) +static void +ci_CacheFreeSourceData(pXHashEntry entry, void* path) { /** Extract hash entry. **/ char* key = entry->Key; @@ -4312,12 +4373,15 @@ static void ci_CacheFreeSourceData(pXHashEntry entry, void* path) /** Free data. **/ ci_FreeSourceData(source_data); nmSysFree(key); + + return; } // LINK #functions /** Intended for use in xhClearKeySafe(). **/ -static void ci_CacheFreeCluster(pXHashEntry entry, void* path) +static void +ci_CacheFreeCluster(pXHashEntry entry, void* path) { /** Extract hash entry. **/ char* key = entry->Key; @@ -4329,12 +4393,15 @@ static void ci_CacheFreeCluster(pXHashEntry entry, void* path) /** Free data. **/ ci_FreeClusterData(cluster_data, false); nmSysFree(key); + + return; } // LINK #functions /** Intended for use in xhClearKeySafe(). **/ -static void ci_CacheFreeSearch(pXHashEntry entry, void* path) +static void +ci_CacheFreeSearch(pXHashEntry entry, void* path) { /** Extract hash entry. **/ char* key = entry->Key; @@ -4346,6 +4413,8 @@ static void ci_CacheFreeSearch(pXHashEntry entry, void* path) /** Free data. **/ ci_FreeSearchData(search_data); nmSysFree(key); + + return; } @@ -4357,7 +4426,8 @@ static void ci_CacheFreeSearch(pXHashEntry entry, void* path) *** @param param A possibly optional param passed to the method. *** @param oxt The object system tree, similar to a kind of "scope" (unused). ***/ -int clusterExecuteMethod(void* inf_v, char* method_name, pObjData param, pObjTrxTree* oxt) +int +clusterExecuteMethod(void* inf_v, char* method_name, pObjData param, pObjTrxTree* oxt) { pDriverData driver_data = (pDriverData)inf_v; @@ -4496,64 +4566,81 @@ int clusterExecuteMethod(void* inf_v, char* method_name, pObjData param, pObjTrx // LINK #functions /** Not implemented. **/ -int clusterCreate(pObject obj, int mask, pContentType sys_type, char* usr_type, pObjTrxTree* oxt) +int +clusterCreate(pObject obj, int mask, pContentType sys_type, char* usr_type, pObjTrxTree* oxt) { mssErrorf(1, "Cluster", "clusterCreate() is not implemented."); return -ENOSYS; } + /** Not implemented. **/ -int clusterDelete(pObject obj, pObjTrxTree* oxt) +int +clusterDelete(pObject obj, pObjTrxTree* oxt) { mssErrorf(1, "Cluster", "clusterDelete() is not implemented."); return -1; } + /** Not implemented. **/ -int clusterDeleteObj(void* inf_v, pObjTrxTree* oxt) +int +clusterDeleteObj(void* inf_v, pObjTrxTree* oxt) { mssErrorf(1, "Cluster", "clusterDeleteObj() is not implemented."); return -1; } + /** Not implemented. **/ -int clusterRead(void* inf_v, char* buffer, int max_cnt, int offset, int flags, pObjTrxTree* oxt) +int +clusterRead(void* inf_v, char* buffer, int max_cnt, int offset, int flags, pObjTrxTree* oxt) { mssErrorf(1, "Cluster", "clusterRead() not implemented."); fprintf(stderr, "HINT: Use queries instead, (e.g. clusterOpenQuery()).\n"); return -1; } + /** Not implemented. **/ -int clusterWrite(void* inf_v, char* buffer, int cnt, int offset, int flags, pObjTrxTree* oxt) +int +clusterWrite(void* inf_v, char* buffer, int cnt, int offset, int flags, pObjTrxTree* oxt) { mssErrorf(1, "Cluster", "clusterWrite() not implemented because clusters are imutable."); return -1; } + /** Not implemented. **/ -int clusterSetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val, pObjTrxTree* oxt) +int +clusterSetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val, pObjTrxTree* oxt) { mssErrorf(1, "Cluster", "clusterSetAttrValue() not implemented because clusters are imutable."); return -1; } + /** Not implemented. **/ -int clusterAddAttr(void* inf_v, char* attr_name, int type, pObjData val, pObjTrxTree* oxt) +int +clusterAddAttr(void* inf_v, char* attr_name, int type, pObjData val, pObjTrxTree* oxt) { mssErrorf(1, "Cluster", "clusterAddAttr() not implemented because clusters are imutable."); return -1; } + /** Not implemented. **/ -void* clusterOpenAttr(void* inf_v, char* attr_name, int mode, pObjTrxTree* oxt) +void* +clusterOpenAttr(void* inf_v, char* attr_name, int mode, pObjTrxTree* oxt) { mssErrorf(1, "Cluster", "clusterOpenAttr() not implemented."); return NULL; } + /** Not implemented. **/ -int clusterCommit(void* inf_v, pObjTrxTree* oxt) +int +clusterCommit(void* inf_v, pObjTrxTree* oxt) { mssErrorf(1, "Cluster", "clusterCommit() not implemented because clusters are imutable."); @@ -4570,7 +4657,8 @@ int clusterCommit(void* inf_v, pObjTrxTree* oxt) *** @returns 0 if successful, or *** -1 if an error occurs. ***/ -int clusterInitialize(void) +int +clusterInitialize(void) { /** Allocate the driver. **/ pObjDriver drv = (pObjDriver)check_ptr(nmMalloc(sizeof(ObjDriver))); @@ -4637,8 +4725,8 @@ int clusterInitialize(void) /** Success. **/ return 0; - /** Error cleanup. **/ err_free: + /** Error cleanup. **/ if (ClusterDriverCaches.SourceDataCache.nRows != 0) check(xhDeInit(&ClusterDriverCaches.SourceDataCache)); /* Failure ignored. **/ if (ClusterDriverCaches.ClusterDataCache.nRows != 0) check(xhDeInit(&ClusterDriverCaches.ClusterDataCache)); /* Failure ignored. **/ if (ClusterDriverCaches.SearchDataCache.nRows != 0) check(xhDeInit(&ClusterDriverCaches.SearchDataCache)); /* Failure ignored. **/ diff --git a/centrallix/utility/double_metaphone.c b/centrallix/utility/double_metaphone.c index 3faf27c3c..b767eeb64 100644 --- a/centrallix/utility/double_metaphone.c +++ b/centrallix/utility/double_metaphone.c @@ -127,7 +127,8 @@ *** @param size The amount of memory being allocated. *** @returns The pointer, for chaining. ***/ -void* meta_check_allocation(void* ptr, const char* fname, const size_t size) +void* +meta_check_allocation(void* ptr, const char* fname, const size_t size) { if (ptr == NULL) { @@ -170,7 +171,8 @@ MetaString; *** @param init_str The initial size of the string. *** @returns The new MetaString. ***/ -MetaString* meta_new_string(const char* init_str) +MetaString* +meta_new_string(const char* init_str) { MetaString *s; char empty_string[] = ""; @@ -196,7 +198,8 @@ MetaString* meta_new_string(const char* init_str) *** *** @param s The MetaString. ***/ -void meta_destroy_string(MetaString* s) +void +meta_destroy_string(MetaString* s) { if (s == NULL) return; @@ -205,6 +208,8 @@ void meta_destroy_string(MetaString* s) META_FREE(s->str); META_FREE(s); + + return; } /*** Increases a MetaString's buffer size. @@ -212,20 +217,26 @@ void meta_destroy_string(MetaString* s) *** @param s The MetaString* being modified. *** @param chars_needed Minimum number of characters to increase buffer size. ***/ -void meta_increase_buffer(MetaString* s, const size_t chars_needed) +void +meta_increase_buffer(MetaString* s, const size_t chars_needed) { s->bufsize += chars_needed + 8u; s->str = SAFE_REALLOC(s->str, s->bufsize * sizeof(char)); + + return; } /*** Convert all characters of a MetaString to uppercase. *** *** @param s The MetaString being modified. ***/ -void meta_make_upper(MetaString* s) +void +meta_make_upper(MetaString* s) { for (char* i = s->str; i[0] != '\0'; i++) *i = (char)toupper(*i); + + return; } /*** @param s The MetaString being checked. @@ -233,7 +244,8 @@ void meta_make_upper(MetaString* s) *** @returns 1 if the location is out of bounds for the MetaString, *** 0 otherwise. ***/ -bool meta_is_out_of_bounds(MetaString* s, unsigned int pos) +bool +meta_is_out_of_bounds(MetaString* s, unsigned int pos) { return (s->length <= pos); } @@ -243,7 +255,8 @@ bool meta_is_out_of_bounds(MetaString* s, unsigned int pos) *** @param s The MetaString being checked. *** @param pos The character location to check within the MetaString. ***/ -bool meta_is_vowel(MetaString* s, unsigned int pos) +bool +meta_is_vowel(MetaString* s, unsigned int pos) { if (meta_is_out_of_bounds(s, pos)) return 0; @@ -259,7 +272,8 @@ bool meta_is_vowel(MetaString* s, unsigned int pos) *** @param s The MetaString to be searched. *** @returns 1 if the MetaString is Slavo Germanic, or 0 otherwise. ***/ -bool meta_is_slavo_germanic(MetaString* s) +bool +meta_is_slavo_germanic(MetaString* s) { return (strstr(s->str, "W") != NULL) || (strstr(s->str, "K") != NULL) @@ -272,7 +286,8 @@ bool meta_is_slavo_germanic(MetaString* s) *** @returns The character at the position in the MetaString, or *** '\0' if the position is not in the MetaString. ***/ -char meta_get_char_at(MetaString* s, unsigned int pos) +char +meta_get_char_at(MetaString* s, unsigned int pos) { return (meta_is_out_of_bounds(s, pos)) ? '\0' : ((char) *(s->str + pos)); } @@ -289,7 +304,8 @@ char meta_get_char_at(MetaString* s, unsigned int pos) *** @returns 1 if any of the character sequences appear after the start *** in the MetaString and 0 otherwise. ***/ -bool meta_is_str_at(MetaString* s, unsigned int start, ...) +bool +meta_is_str_at(MetaString* s, unsigned int start, ...) { va_list ap; @@ -319,7 +335,8 @@ bool meta_is_str_at(MetaString* s, unsigned int start, ...) *** @param s The MetaString being modified. *** @param new_str The string being added. ***/ -void meta_add_str(MetaString* s, const char* new_str) +void +meta_add_str(MetaString* s, const char* new_str) { if (new_str == NULL) return; @@ -330,6 +347,8 @@ void meta_add_str(MetaString* s, const char* new_str) strcat(s->str, new_str); s->length += add_length; + + return; } /*** Computes double metaphone. @@ -347,7 +366,8 @@ void meta_add_str(MetaString* s, const char* new_str) *** @param secondary_code A pointer to a buffer where the pointer to a string *** containing the produced secondary code will be stored. ***/ -void meta_double_metaphone(const char* str, char** primary_code, char** secondary_code) +void +meta_double_metaphone(const char* str, char** primary_code, char** secondary_code) { size_t length; @@ -1283,6 +1303,8 @@ void meta_double_metaphone(const char* str, char** primary_code, char** secondar meta_destroy_string(original); meta_destroy_string(primary); meta_destroy_string(secondary); + + return; } #ifdef TESTING @@ -1308,7 +1330,8 @@ void meta_double_metaphone(const char* str, char** primary_code, char** secondar unsigned int num_tests_passed = 0u, num_tests_failed = 0u; -void test(const char* input, const char* expected_primary, const char* expected_secondary) +void +test(const char* input, const char* expected_primary, const char* expected_secondary) { char* codes[2]; @@ -1337,13 +1360,16 @@ void test(const char* input, const char* expected_primary, const char* expected_ ); num_tests_failed++; } + + return; } // Special thanks to the following websites for double checking the correct results: // 1: https://words.github.io/double-metaphone // 2: https://mainegenealogy.net/metaphone_converter.asp // 3: https://en.toolpage.org/tool/metaphone -void run_tests(void) +void +run_tests(void) { printf("\nRunning tests...\n"); @@ -1526,6 +1552,8 @@ void run_tests(void) printf(" > Failed: %u\n", num_tests_failed); printf(" > Skipped: %u\n", 0u); /* Implementation removed. */ printf(" > Passed: %u/%u\n", num_tests_passed, total_tests); + + return; } int main(void) From 6b83c67007663018c4bad1e3d9e1e25ffbdd6026 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Mon, 15 Dec 2025 15:01:02 -0700 Subject: [PATCH 038/275] Fix indentation mistakes (thanks Centrallix Indent extension). --- centrallix-lib/src/util.c | 4 ++-- centrallix/expression/exp_functions.c | 10 +++++----- centrallix/objectsystem/obj_datatypes.c | 2 +- centrallix/osdrivers/objdrv_cluster.c | 24 ++++++++++++------------ centrallix/utility/double_metaphone.c | 2 +- 5 files changed, 21 insertions(+), 21 deletions(-) diff --git a/centrallix-lib/src/util.c b/centrallix-lib/src/util.c index 6e35fb99b..9dbc804d7 100644 --- a/centrallix-lib/src/util.c +++ b/centrallix-lib/src/util.c @@ -191,11 +191,11 @@ fprint_mem(FILE* out) check(fclose(fp)); /* Failure ignored. */ return; } - check(fclose(fp)); /* Failure ignored. */ + check(fclose(fp)); /* Failure ignored. */ long page_size = sysconf(_SC_PAGESIZE); // in bytes long resident_bytes = resident * page_size; - + const size_t buf_siz = 16u; char buf[buf_siz]; snprint_bytes(buf, buf_siz, (unsigned int)resident_bytes); diff --git a/centrallix/expression/exp_functions.c b/centrallix/expression/exp_functions.c index 70bbf480d..3ee97016c 100644 --- a/centrallix/expression/exp_functions.c +++ b/centrallix/expression/exp_functions.c @@ -130,7 +130,7 @@ typedef struct static int exp_fn_i_verify_arg(const char* fn_name, pExpression arg, const ArgExpect* arg_expect) { - /** The expectation struct cannot be NULL. **/ + /** The expectation struct cannot be NULL. **/ if (arg_expect == NULL) { mssErrorf(1, "EXP", @@ -3782,7 +3782,7 @@ int exp_fn_from_base64(pExpression tree, pParamObjects objlist, pExpression i0, static int exp_fn_i_do_math(pExpression tree, double (*math)(), int arg_num) { - /** Verify function schema: expect arg_num numeric values. **/ + /** Verify function schema: expect arg_num numeric values. **/ ArgExpect expects[arg_num + 1]; for (int i = 0; i < arg_num; i++) expects[i] = (ArgExpect){(int[]){DATA_T_INTEGER, DATA_T_DOUBLE, DATA_T_MONEY, -1}, EXP_ARG_NO_FLAGS}; @@ -3804,7 +3804,7 @@ exp_fn_i_do_math(pExpression tree, double (*math)(), int arg_num) return 0; } } - + /** Maximum supported args. **/ if (arg_num > 4) { @@ -4549,7 +4549,7 @@ int exp_fn_nth(pExpression tree, pParamObjects objlist, pExpression i0, pExpress int exp_fn_metaphone(pExpression tree, pParamObjects obj_list) { - /** Verify function schema. **/ + /** Verify function schema. **/ if (exp_fn_i_verify_schema((ArgExpect[]){ {(int[]){DATA_T_STRING, -1}, EXP_ARG_NO_FLAGS}, EXP_ARG_END, @@ -4722,7 +4722,7 @@ exp_fn_levenshtein(pExpression tree, pParamObjects obj_list) mssErrorf(1, "EXP", "%s(\"%s\", \"%s\"): Failed to compute edit distance.\n", tree->Name, str1, str2); return -1; } - + /** Return the computed distance. **/ tree->Integer = edit_dist; tree->DataType = DATA_T_INTEGER; diff --git a/centrallix/objectsystem/obj_datatypes.c b/centrallix/objectsystem/obj_datatypes.c index 5d36089a1..388a75e60 100644 --- a/centrallix/objectsystem/obj_datatypes.c +++ b/centrallix/objectsystem/obj_datatypes.c @@ -202,7 +202,7 @@ char* objTypeToStr(const int type) { /** Guard out of bounds reads. **/ - if (type < 0 || OBJ_TYPE_NAMES_CNT <= type) + if (type < 0 || OBJ_TYPE_NAMES_CNT <= type) { /** Invalid type. **/ mssErrorf(1, "Cluster", "Invalid type %d.\n", type); diff --git a/centrallix/osdrivers/objdrv_cluster.c b/centrallix/osdrivers/objdrv_cluster.c index 94a58cf5f..b525dd9a1 100644 --- a/centrallix/osdrivers/objdrv_cluster.c +++ b/centrallix/osdrivers/objdrv_cluster.c @@ -1353,7 +1353,7 @@ ci_ParseSearchData(pStructInf inf, pNodeData node_data) /** Attempt to give a hint. **/ char* cluster_names[node_data->nClusterDatas]; for (unsigned int i = 0; i < node_data->nClusterDatas; i++) - cluster_names[i] = node_data->ClusterDatas[i]->Name; + cluster_names[i] = node_data->ClusterDatas[i]->Name; ci_TryHint(source_cluster_name, cluster_names, node_data->nClusterDatas); /** Fail. **/ @@ -1656,7 +1656,7 @@ ci_ParseNodeData(pStructInf inf, pObject parent) node_data->Params[i] = param; /** Check each provided param to see if the user provided value. **/ - for (unsigned int j = 0u; j < num_provided_params; j++) + for (unsigned int j = 0u; j < num_provided_params; j++) { pStruct provided_param = check_ptr(provided_params[j]); /* Failure ignored. */ @@ -2005,10 +2005,10 @@ ci_FreeNodeData(pNodeData node_data) /** Free data source, if one exists. **/ /*** Note: SourceData is freed last since other free functions may need to - *** access information from this structure when freeing data. - *** (For example, nVector which is used to determine the size of the - *** label struct in each cluster.) - ***/ + *** access information from this structure when freeing data. + *** (For example, nVector which is used to determine the size of the + *** label struct in each cluster.) + ***/ if (node_data->SourceData != NULL) { /*** This data is cached, so we should NOT free it! The caching system @@ -2436,7 +2436,7 @@ ci_ComputeSourceData(pSourceData source_data, pObjSession session) if (key_xarray.nAlloc != 0) { for (unsigned int i = 0u; i < vector_xarray.nItems; i++) - { + { char* key = key_xarray.Items[i]; if (key != NULL) nmSysFree(key); else break; @@ -2790,7 +2790,7 @@ ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) } default: - mssErrorf(1, "Cluster", + mssErrorf(1, "Cluster", "Unknown similarity meansure \"%s\".", ci_SimilarityMeasureToString(search_data->SimilarityMeasure) ); @@ -4178,10 +4178,10 @@ clusterInfo(void* inf_v, pObjectInfo info) info->Flags |= OBJ_INFO_F_HAS_SUBOBJ; /* Data must not be empty. */ /*** Clusters always have one label per vector. - *** If we know how many vectors are in the dataset, - *** we know how many labels this cluster will have, - *** even if it hasn't been computed yet. - ***/ + *** If we know how many vectors are in the dataset, + *** we know how many labels this cluster will have, + *** even if it hasn't been computed yet. + ***/ if (node_data->SourceData->Vectors != NULL) { info->Flags |= OBJ_INFO_F_SUBOBJ_CNT_KNOWN; diff --git a/centrallix/utility/double_metaphone.c b/centrallix/utility/double_metaphone.c index b767eeb64..f37b0964c 100644 --- a/centrallix/utility/double_metaphone.c +++ b/centrallix/utility/double_metaphone.c @@ -587,7 +587,7 @@ meta_double_metaphone(const char* str, char** primary_code, char** secondary_cod /** 'bellocchio' but not 'bacchus' **/ if ( meta_is_str_at(original, (current + 2), "I", "E", "H", "") - && !meta_is_str_at(original, (current + 2), "HU", "") + && !meta_is_str_at(original, (current + 2), "HU", "") ) { /** 'accident', 'accede' 'succeed' **/ From 66029f5859888050927f0e2c5e57e0771d2a633d Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Thu, 8 Jan 2026 10:21:58 -0700 Subject: [PATCH 039/275] Rename functions to use the proper prefix everywhere. Improve wording of cluster library description. Improve comments. --- centrallix-lib/include/clusters.h | 4 +- centrallix-lib/src/clusters.c | 75 +++++++++++++++++-------------- 2 files changed, 43 insertions(+), 36 deletions(-) diff --git a/centrallix-lib/include/clusters.h b/centrallix-lib/include/clusters.h index 5aa3123e4..288f1c2c5 100644 --- a/centrallix-lib/include/clusters.h +++ b/centrallix-lib/include/clusters.h @@ -29,8 +29,8 @@ /* Author: Israel Fuller */ /* Creation: September 29, 2025 */ /* Description Clustering library used to cluster and search data with */ -/* cosine similarity and Levenshtein similarity (aka. edit */ -/* distance). Used by the "clustering driver". */ +/* cosine or Levenshtein (aka. edit distance) similarity */ +/* measures. Used by the "clustering driver". */ /* For more information on how to use this library, see */ /* string-similarity.md in the centrallix-sysdoc folder. */ /************************************************************************/ diff --git a/centrallix-lib/src/clusters.c b/centrallix-lib/src/clusters.c index 505c3c272..652d5571c 100644 --- a/centrallix-lib/src/clusters.c +++ b/centrallix-lib/src/clusters.c @@ -26,8 +26,8 @@ /* Author: Israel Fuller */ /* Creation: September 29, 2025 */ /* Description Clustering library used to cluster and search data with */ -/* cosine similarity and Levenshtein similarity (aka. edit */ -/* distance). Used by the "clustering driver". */ +/* cosine or Levenshtein (aka. edit distance) similarity */ +/* measures. Used by the "clustering driver". */ /* For more information on how to use this library, see */ /* string-similarity.md in the centrallix-sysdoc folder. */ /************************************************************************/ @@ -57,7 +57,7 @@ *** @returns The resulting hash. ***/ static unsigned int -hash_char_pair(const unsigned char c1, const unsigned char c2) +ca_hash_char_pair(const unsigned char c1, const unsigned char c2) { const double sum = (c1 * c1 * c1) + (c2 * c2 * c2); const double scale = ((double)c1 + 1.0) / ((double)c2 + 1.0); @@ -71,7 +71,7 @@ hash_char_pair(const unsigned char c1, const unsigned char c2) *** @param c1 The first character in the character pair. *** @param c2 The second character in the character pair. *** @param hash The hash for the two characters, calculated by calling the - *** hash_char_pair() function (above). + *** ca_hash_char_pair() function (above). **/ typedef struct { @@ -90,7 +90,7 @@ typedef struct *** 0 if p1 and p2 have identical hashes. ***/ static int -charpair_cmp(const void *p1, const void *p2) +ca_char_pair_cmp(const void *p1, const void *p2) { const CharPair *a = p1, *b = p2; return a->hash - b->hash; @@ -149,11 +149,12 @@ ca_build_vector(const char* str) pVector sparse_vector = NULL; pVector trimmed_sparse_vector = NULL; + /** Allocate memory to store the characters. **/ unsigned int num_chars = 0u; chars = check_ptr(nmSysMalloc((strlen(str) + 2u) * sizeof(unsigned char))); if (chars == NULL) goto err_free; - /** Begin adding char pairs (in order). **/ + /** Store characters. **/ chars[num_chars++] = CA_BOUNDARY_CHAR; /* Starting boundary character. */ for (const char* char_ptr = str; *char_ptr != '\0'; char_ptr++) { @@ -177,7 +178,8 @@ ca_build_vector(const char* str) } chars[num_chars++] = CA_BOUNDARY_CHAR; /* Ending boundary character. */ - /** Compute hash values for char pairs. **/ + + /** Compute character pair hashes. **/ char_pairs = check_ptr(nmSysMalloc(num_chars * sizeof(CharPair))); if (char_pairs == NULL) goto err_free; const unsigned int num_pairs = num_chars - 1u; @@ -189,21 +191,23 @@ ca_build_vector(const char* str) /** Hash the character pair into an index (dimension). **/ /** Note that the passed value should always be between 97 ('a') and 132 ('9'). **/ - char_pairs[i].hash = hash_char_pair(chars[i], chars[i + 1]); + char_pairs[i].hash = ca_hash_char_pair(chars[i], chars[i + 1]); } /** Free unused memory. **/ nmSysFree(chars); chars = NULL; + /** Sort char_pairs by hash value. **/ - qsort(char_pairs, num_pairs, sizeof(CharPair), charpair_cmp); + qsort(char_pairs, num_pairs, sizeof(CharPair), ca_char_pair_cmp); + /** Allocate space for the sparse vector. **/ sparse_vector = check_ptr(nmSysMalloc((num_pairs * 2u + 1u) * sizeof(int))); if (sparse_vector == NULL) goto err_free; - /** Build the sparse vector. **/ + /** Build the sparse vector from the character pairs. **/ unsigned int cur = 0u, dim = 0u; for (unsigned int i = 0u; i < num_pairs;) { @@ -236,6 +240,7 @@ ca_build_vector(const char* str) nmSysFree(char_pairs); char_pairs = NULL; + /** Trim extra space wasted by identical hashes. **/ trimmed_sparse_vector = check_ptr(nmSysRealloc(sparse_vector, cur * sizeof(int))); if (trimmed_sparse_vector == NULL) goto err_free; @@ -245,6 +250,7 @@ ca_build_vector(const char* str) return trimmed_sparse_vector; err_free: + /** Cleanup. **/ if (trimmed_sparse_vector != NULL) nmSysFree(trimmed_sparse_vector); if (sparse_vector != NULL) nmSysFree(sparse_vector); if (char_pairs != NULL) nmSysFree(char_pairs); @@ -264,7 +270,8 @@ ca_free_vector(pVector sparse_vector) return; } -/*** Compute the length of a sparsely allocated vector. +/*** Compute the actual number of ints stored in memory to store the given + *** sparsely allocated vector. *** *** @param vector The vector. *** @returns The computed length. @@ -288,7 +295,7 @@ ca_sparse_len(const pVector vector) return i; } -/*** Print the underlying implementation values sparsely allocated +/*** Print the underlying implementation-level values of a sparsely allocated *** vector (for debugging). *** *** @param vector The vector. @@ -311,7 +318,7 @@ ca_print_vector(const pVector vector) *** @returns The computed magnitude. ***/ static double -magnitude_sparse(const pVector vector) +ca_magnitude_sparse(const pVector vector) { unsigned int magnitude = 0u; @@ -335,7 +342,7 @@ magnitude_sparse(const pVector vector) *** @returns The computed magnitude. ***/ static double -magnitude_dense(const pCentroid centroid) +ca_magnitude_dense(const pCentroid centroid) { double magnitude = 0.0; @@ -353,7 +360,7 @@ magnitude_dense(const pCentroid centroid) *** @param param_value The location to save the param_value of the token. ***/ static void -parse_vector_token(const int token, unsigned int* remaining, unsigned int* param_value) +ca_parse_vector_token(const int token, unsigned int* remaining, unsigned int* param_value) { if (token < 0) { @@ -381,7 +388,7 @@ parse_vector_token(const int token, unsigned int* remaining, unsigned int* param *** 0 indicates completely different. ***/ static double -sparse_similarity(const pVector v1, const pVector v2) +ca_sparse_similarity(const pVector v1, const pVector v2) { /** Calculate dot product. **/ unsigned int vec1_remaining = 0u, vec2_remaining = 0u; @@ -389,8 +396,8 @@ sparse_similarity(const pVector v1, const pVector v2) while (dim < CA_NUM_DIMS) { unsigned int val1 = 0u, val2 = 0u; - if (vec1_remaining == 0u) parse_vector_token(v1[i1++], &vec1_remaining, &val1); - if (vec2_remaining == 0u) parse_vector_token(v2[i2++], &vec2_remaining, &val2); + if (vec1_remaining == 0u) ca_parse_vector_token(v1[i1++], &vec1_remaining, &val1); + if (vec2_remaining == 0u) ca_parse_vector_token(v2[i2++], &vec2_remaining, &val2); /*** Accumulate the dot_product. If either vector is 0 here, *** the total is 0 and this statement does nothing. @@ -404,11 +411,11 @@ sparse_similarity(const pVector v1, const pVector v2) dim += overlap; } - /** Optional optimization to speed up nonsimilar vectors. **/ + /** Optimization: Skip computing magnitudes for completely different vectors. **/ if (dot_product == 0u) return 0.0; /** Return the difference score. **/ - return (double)dot_product / (magnitude_sparse(v1) * magnitude_sparse(v2)); + return (double)dot_product / (ca_magnitude_sparse(v1) * ca_magnitude_sparse(v2)); } /*** Calculate the difference on sparsely allocated vectors. Comparing @@ -420,7 +427,7 @@ sparse_similarity(const pVector v1, const pVector v2) *** 1 indicates completely different and *** 0 indicates identical. ***/ -#define sparse_dif(v1, v2) (1.0 - sparse_similarity(v1, v2)) +#define ca_sparse_dif(v1, v2) (1.0 - ca_sparse_similarity(v1, v2)) /*** Calculate the similarity between a sparsely allocated vector and a densely *** allocated centroid using a dot product. Comparing any string to an empty @@ -433,7 +440,7 @@ sparse_similarity(const pVector v1, const pVector v2) *** 0 indicates completely different. ***/ static double -sparse_similarity_to_centroid(const pVector v1, const pCentroid c2) +ca_sparse_similarity_to_centroid(const pVector v1, const pCentroid c2) { double dot_product = 0.0; @@ -449,7 +456,7 @@ sparse_similarity_to_centroid(const pVector v1, const pCentroid c2) } /** Return the difference score. **/ - return dot_product / (magnitude_sparse(v1) * magnitude_dense(c2)); + return dot_product / (ca_magnitude_sparse(v1) * ca_magnitude_dense(c2)); } /*** Calculate the difference between a sparsely allocated vector and a densely @@ -462,7 +469,7 @@ sparse_similarity_to_centroid(const pVector v1, const pCentroid c2) *** 1 indicates completely different and *** 0 indicates identical. ***/ -#define sparse_dif_to_centroid(v1, c2) (1.0 - sparse_similarity_to_centroid(v1, c2)) +#define ca_sparse_dif_to_centroid(v1, c2) (1.0 - ca_sparse_similarity_to_centroid(v1, c2)) /*** Computes Levenshtein distance between two strings. *** @@ -606,7 +613,7 @@ ca_cos_compare(void* v1, void* v2) if (!v1_empty && v2_empty) return 0.0; /** Apply rounding to avoid annoying floating point issues before returning. **/ - return round(sparse_similarity(vec1, vec2) * 1000000) / 1000000; + return round(ca_sparse_similarity(vec1, vec2) * 1000000.0) / 1000000.0; } /*** Compares two strings using their Levenshtein edit distance to compute a @@ -644,7 +651,7 @@ ca_lev_compare(void* str1, void* str2) const double normalized_similarity = 1.0 - (double)edit_dist / (double)max(len1, len2); /** Apply rounding to avoid annoying floating point issues before returning. **/ - return round(normalized_similarity * 1000000) / 1000000; + return round(normalized_similarity * 1000000.0) / 1000000.0; } /*** Check if two sparse vectors are identical. @@ -688,9 +695,9 @@ get_cluster_size( /** Allocate space to store clusters as averages are computed. **/ /*** We use nmMalloc() here because this function is usually called - *** repeatedly with the same number of clusters in the k-means loop. - *** Also, it is likely that k-means may be invoked multiple times with - *** the same k value, leading to additional caching benefits. + *** repeatedly with the same number of clusters at the end of the + *** loop in ca_kmeans(). Also, ca_kmeans() may be called multiple + *** times with the same k value, increasing this benefit. ***/ cluster_sums = check_ptr(nmMalloc(num_clusters * sizeof(double))); cluster_counts = check_ptr(nmMalloc(num_clusters * sizeof(unsigned int))); @@ -706,7 +713,7 @@ get_cluster_size( for (unsigned int i = 0u; i < num_vectors; i++) { const unsigned int label = labels[i]; - cluster_sums[label] += sparse_dif_to_centroid(vectors[i], centroids[label]); + cluster_sums[label] += ca_sparse_dif_to_centroid(vectors[i], centroids[label]); cluster_counts[label]++; } @@ -848,7 +855,7 @@ ca_kmeans( /** Find nearest centroid. **/ for (unsigned int j = 0u; j < num_clusters; j++) { - const double dist = sparse_dif_to_centroid(vector, centroids[j]); + const double dist = ca_sparse_dif_to_centroid(vector, centroids[j]); if (dist < min_dist) { min_dist = dist; @@ -901,7 +908,7 @@ ca_kmeans( if (vector_sims != NULL) { for (unsigned int i = 0u; i < num_vectors; i++) - vector_sims[i] = sparse_similarity_to_centroid(vectors[i], centroids[labels[i]]); + vector_sims[i] = ca_sparse_similarity_to_centroid(vectors[i], centroids[labels[i]]); } /** Success. **/ @@ -1090,5 +1097,5 @@ ca_complete_search( } /** Scope cleanup. **/ -#undef sparse_dif -#undef sparse_dif_to_centroid +#undef ca_sparse_dif +#undef ca_sparse_dif_to_centroid From fce7a2c07ec2cbd7811162488e3d210a14604a07 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Thu, 8 Jan 2026 10:23:26 -0700 Subject: [PATCH 040/275] Update magic.h to prepare for implementing magic on all cluster driver structs. --- centrallix-lib/include/magic.h | 42 +++++++++++++++++++++++---- centrallix-sysdoc/GCC_Dependencies.md | 2 +- 2 files changed, 37 insertions(+), 7 deletions(-) diff --git a/centrallix-lib/include/magic.h b/centrallix-lib/include/magic.h index 812483090..f7a0189f3 100644 --- a/centrallix-lib/include/magic.h +++ b/centrallix-lib/include/magic.h @@ -27,9 +27,39 @@ #ifdef DBMAGIC - -#define ASSERTMAGIC(x,y) ((!(x) || (((pMagicHdr)(x))->Magic == (y)))?0:(printf("LS-PANIC: Magic number assertion failed, unexpected %X != %X for %8.8lX\n",(x)?(((pMagicHdr)(x))->Magic):(0xEE1EE100),(y),(long)(x)),(*((int*)(8)) = *((int*)(0))))) -#define ASSERTNOTMAGIC(x,y) ((!(x) || (((pMagicHdr)(x))->Magic != (y)))?0:(printf("LS-PANIC: Magic number assertion failed, unexpected %X\n",(y)),(*((int*)(8)) = *((int*)(0))))) +#include + +#define ASSERTMAGIC(data, expect) \ + ({ \ + pMagicHdr _data = (pMagicHdr)(data); \ + Magic_t _expect = (expect); \ + Magic_t _actual = (_data == NULL) ? 0xEE1EE100 : _data->Magic; \ + if (_data != NULL && _actual != _expect) \ + { \ + printf( \ + "%s:%d: Magic assertion failed, unexpected %u != %d for %8.8lX.\n", \ + __FILE__, __LINE__, _actual, _expect, (long)_data \ + ); \ + abort(); \ + } \ + 0; \ + }) + +#define ASSERTNOTMAGIC(data, expect) \ + ({ \ + pMagicHdr _data = (pMagicHdr)(data); \ + Magic_t _expect = (expect); \ + Magic_t _actual = (_data == NULL) ? 0xEE1EE100 : _data->Magic; \ + if (_data != NULL && _actual == _expect) \ + { \ + printf( \ + "%s:%d: Magic assertion failed, unexpected %d.\n", \ + __FILE__, __LINE__, _expect \ + ); \ + abort(); \ + } \ + 0; \ + }) #else /* defined DBMAGIC */ @@ -38,9 +68,9 @@ #endif /* defined DBMAGIC */ -#define ISMAGIC(x,y) (((pMagicHdr)(x))->Magic == (y)) -#define ISNTMAGIC(x,y) (((pMagicHdr)(x))->Magic != (y)) -#define SETMAGIC(x,y) (((pMagicHdr)(x))->Magic = (y)) +#define ISMAGIC(data, expect) (((pMagicHdr)(data))->Magic == (expect)) +#define ISNTMAGIC(data, expect) (((pMagicHdr)(data))->Magic != (expect)) +#define SETMAGIC(data, expect) (((pMagicHdr)(data))->Magic = (expect)) typedef int Magic_t; diff --git a/centrallix-sysdoc/GCC_Dependencies.md b/centrallix-sysdoc/GCC_Dependencies.md index 1327ea090..5467ee13b 100644 --- a/centrallix-sysdoc/GCC_Dependencies.md +++ b/centrallix-sysdoc/GCC_Dependencies.md @@ -14,7 +14,7 @@ Date: Descember 4, 2025 This document tracks dependencies on the GCC toolchain in the centrallix codebase. As code is added which relies on GCC specific behavior, such additions should be noted here to make possible use of a different toolchain (e.g. LLVM) in the future less painful. ## List of Dependencies -- `util.h` Uses the `__typeof__` to avoid double-computation in macros. +- `util.h` & `magic.h`: Use `__typeof__` and `({ ... })` in macros to avoid double-computation. ## Notes `__FILE__` and `__LINE__` are not dependencies as they were added in C90. See [this page](https://gcc.gnu.org/onlinedocs/cpp/Standard-Predefined-Macros.html) for information about predefined macros. From b9defb8c5b1f0441f70d53ad34905ab9e5e1b286 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Thu, 8 Jan 2026 10:33:58 -0700 Subject: [PATCH 041/275] Refactor some cluster driver code to make it cleaner. Add more hints to the cluster driver. Clean up and review some code. --- centrallix-lib/src/mtlexer.c | 2 +- centrallix/osdrivers/objdrv_cluster.c | 334 +++++++++++++++----------- 2 files changed, 200 insertions(+), 136 deletions(-) diff --git a/centrallix-lib/src/mtlexer.c b/centrallix-lib/src/mtlexer.c index 39a69cc15..6c5a46dba 100644 --- a/centrallix-lib/src/mtlexer.c +++ b/centrallix-lib/src/mtlexer.c @@ -909,7 +909,7 @@ mlxNextToken(pLxSession this) else { char buf[4]; - snprintf(buf, sizeof(buf), "%c", ch); // mssError() does not support %c. + snprintf(buf, sizeof(buf), "%c", ch); /* mssError() does not support %c. */ mssError(1, "MLX", "Unexpected character encountered: '%s'", buf); this->TokType = MLX_TOK_ERROR; break; diff --git a/centrallix/osdrivers/objdrv_cluster.c b/centrallix/osdrivers/objdrv_cluster.c index b525dd9a1..fa9902fd2 100644 --- a/centrallix/osdrivers/objdrv_cluster.c +++ b/centrallix/osdrivers/objdrv_cluster.c @@ -70,8 +70,8 @@ ***/ /** Defaults for unspecified optional attributes. **/ -#define DEFAULT_MIN_IMPROVEMENT 0.0001 -#define DEFAULT_MAX_ITERATIONS 64u +#define CI_DEFAULT_MIN_IMPROVEMENT 0.0001 +#define CI_DEFAULT_MAX_ITERATIONS 64u /** ================ Stuff That Should Be Somewhere Else ================ **/ /** ANCHOR[id=temp] **/ @@ -227,7 +227,7 @@ ci_ClusteringAlgorithmToString(ClusterAlgorithm clustering_algorithm) default: return "Unknown algorithm"; } - return; /** Unreachable. **/ + return NULL; /** Unreachable. **/ } /** Enum representing a similarity measurement algorithm. **/ @@ -256,7 +256,7 @@ ci_SimilarityMeasureToString(SimilarityMeasure similarity_measure) default: return "Unknown similarity measure"; } - return; /** Unreachable. **/ + return NULL; /** Unreachable. **/ } /*** Enum representing the type of data targetted by the driver, @@ -275,7 +275,7 @@ typedef unsigned char TargetType; /** Attribute name lists by TargetType. **/ #define END_OF_ARRAY NULL -char* const ATTR_ROOT[] = +const char* ATTR_ROOT[] = { "source", "attr_name", @@ -283,7 +283,7 @@ char* const ATTR_ROOT[] = "date_computed", END_OF_ARRAY, }; -char* const ATTR_CLUSTER[] = +const char* ATTR_CLUSTER[] = { "algorithm", "similarity_measure", @@ -294,21 +294,21 @@ char* const ATTR_CLUSTER[] = "date_computed", END_OF_ARRAY, }; -char* const ATTR_SEARCH[] = +const char* ATTR_SEARCH[] = { "source", "threshold", "similarity_measure", END_OF_ARRAY, }; -char* const ATTR_CLUSTER_ENTRY[] = +const char* ATTR_CLUSTER_ENTRY[] = { "items", "date_created", "date_computed", END_OF_ARRAY, }; -char* const ATTR_SEARCH_ENTRY[] = +const char* ATTR_SEARCH_ENTRY[] = { "key1", "key2", @@ -317,7 +317,7 @@ char* const ATTR_SEARCH_ENTRY[] = }; /** Method name list. **/ -char* const METHOD_NAMES[] = +const char* METHOD_NAMES[] = { "cache", "stat", @@ -622,11 +622,12 @@ struct // LINK #parsing static void ci_GiveHint(const char* hint); static bool ci_TryHint(char* value, char** valid_values, const unsigned int n_valid_values); +static void ci_UnknownAttribute(const char* attr_name, int target_type); static int ci_ParseAttribute(pStructInf inf, char* attr_name, int datatype, pObjData data, pParamObjects param_list, bool required, bool print_type_error); static ClusterAlgorithm ci_ParseClusteringAlgorithm(pStructInf cluster_inf, pParamObjects param_list); static SimilarityMeasure ci_ParseSimilarityMeasure(pStructInf cluster_inf, pParamObjects param_list); static pSourceData ci_ParseSourceData(pStructInf inf, pParamObjects param_list, char* path); -static pClusterData ci_ParseClusterData(pStructInf inf, pNodeData node_data); +static pClusterData ci_ParseClusterData(pStructInf inf, pParamObjects param_list, pSourceData source_data); static pSearchData ci_ParseSearchData(pStructInf inf, pNodeData node_data); static pNodeData ci_ParseNodeData(pStructInf inf, pObject obj); @@ -728,6 +729,49 @@ ci_TryHint(char* value, char** valid_values, const unsigned int n_valid_values) } +/*** Display an error message when an unknown attribute is requested, including + *** a hint about which attribute might be intended, if available. + *** + *** @param attr_name The name of the missing attribute. + *** @param target_type The target type, for determining the list of available + *** attributes in this context. + ***/ +static void +ci_UnknownAttribute(const char* attr_name, int target_type) + { + /** Display the error message. */ + mssErrorf(1, "Cluster", "Unknown attribute '%s'.", attr_name); + + /** Collect specific attributes based on target type. **/ + const char** specific_attrs = NULL; + switch (target_type) + { + case TARGET_NODE: specific_attrs = ATTR_ROOT; break; + case TARGET_CLUSTER: specific_attrs = ATTR_CLUSTER; break; + case TARGET_SEARCH: specific_attrs = ATTR_SEARCH; break; + case TARGET_CLUSTER_ENTRY: specific_attrs = ATTR_CLUSTER_ENTRY; break; + case TARGET_SEARCH_ENTRY: specific_attrs = ATTR_SEARCH_ENTRY; break; + default: + mssErrorf(0, "Cluster", + "Unknown target type %u detected while attempting to generate hint.", + target_type + ); + return; + } + + /** Count specific attributes. **/ + unsigned int n_specific_attrs = 0; + while (specific_attrs[n_specific_attrs] != NULL) n_specific_attrs++; + + /** Collect general attributes. */ + const char* general_attrs = (char*[]){"name", "annoation", "content_type", "inner_type", "outer_type", "internal_type", "date_computed", "date_created", "last_modification"}; + + /** Attempt to give hints. **/ + if (ci_TryHint(attr_name, specific_attrs, n_specific_attrs)); + else if (ci_TryHint(attr_name, general_attrs, 9)); + } + + // LINK #functions /*** Returns 0 for success and -1 on failure. Promises that mssError() will be *** invoked on failure, so the caller need not specify their own error message. @@ -847,12 +891,12 @@ ci_ParseClusteringAlgorithm(pStructInf inf, pParamObjects param_list) /** Attempt to give a hint. **/ char* all_names[nClusteringAlgorithms] = {NULL}; - for (unsigned int i = 0u; i < nClusteringAlgorithms; i++) + for (unsigned int i = 1u; i < nClusteringAlgorithms; i++) all_names[i] = ci_ClusteringAlgorithmToString(ALL_CLUSTERING_ALGORITHMS[i]); if (ci_TryHint(algorithm, all_names, nClusteringAlgorithms)); else if (strcasecmp(algorithm, "sliding") == 0) ci_GiveHint(ci_ClusteringAlgorithmToString(ALGORITHM_SLIDING_WINDOW)); - else if (strcasecmp(algorithm, "window") == 0) ci_GiveHint(ci_ClusteringAlgorithmToString(ALGORITHM_SLIDING_WINDOW)); - else if (strcasecmp(algorithm, "null") == 0) ci_GiveHint(ci_ClusteringAlgorithmToString(ALGORITHM_NONE)); + else if (strcasecmp(algorithm, "window") == 0) ci_GiveHint(ci_ClusteringAlgorithmToString(ALGORITHM_SLIDING_WINDOW)); + else if (strcasecmp(algorithm, "null") == 0) ci_GiveHint(ci_ClusteringAlgorithmToString(ALGORITHM_NONE)); else if (strcasecmp(algorithm, "nothing") == 0) ci_GiveHint(ci_ClusteringAlgorithmToString(ALGORITHM_NONE)); /** Fail. **/ @@ -892,12 +936,12 @@ ci_ParseSimilarityMeasure(pStructInf inf, pParamObjects param_list) /** Attempt to give a hint. **/ char* all_names[nSimilarityMeasures] = {NULL}; - for (unsigned int i = 0u; i < nSimilarityMeasures; i++) + for (unsigned int i = 1u; i < nSimilarityMeasures; i++) all_names[i] = ci_SimilarityMeasureToString(ALL_SIMILARITY_MEASURES[i]); if (ci_TryHint(measure, all_names, nSimilarityMeasures)); - else if (strcasecmp(measure, "cos") == 0) ci_GiveHint(ci_SimilarityMeasureToString(SIMILARITY_COSINE)); - else if (strcasecmp(measure, "lev") == 0) ci_GiveHint(ci_SimilarityMeasureToString(SIMILARITY_LEVENSHTEIN)); - else if (strcasecmp(measure, "edit-dist") == 0) ci_GiveHint(ci_SimilarityMeasureToString(SIMILARITY_LEVENSHTEIN)); + else if (strcasecmp(measure, "cos") == 0) ci_GiveHint(ci_SimilarityMeasureToString(SIMILARITY_COSINE)); + else if (strcasecmp(measure, "lev") == 0) ci_GiveHint(ci_SimilarityMeasureToString(SIMILARITY_LEVENSHTEIN)); + else if (strcasecmp(measure, "edit-dist") == 0) ci_GiveHint(ci_SimilarityMeasureToString(SIMILARITY_LEVENSHTEIN)); else if (strcasecmp(measure, "edit-distance") == 0) ci_GiveHint(ci_SimilarityMeasureToString(SIMILARITY_LEVENSHTEIN)); /** Fail. **/ @@ -1013,7 +1057,7 @@ ci_ParseSourceData(pStructInf inf, pParamObjects param_list, char* path) *** @returns A new pClusterData struct on success, or NULL on failure. ***/ static pClusterData -ci_ParseClusterData(pStructInf inf, pNodeData node_data) +ci_ParseClusterData(pStructInf inf, pParamObjects param_list, pSourceData source_data) { int result; pClusterData cluster_data = NULL; @@ -1029,11 +1073,10 @@ ci_ParseClusterData(pStructInf inf, pNodeData node_data) if (cluster_data == NULL) goto err_free; memset(cluster_data, 0, sizeof(ClusterData)); - /** Basic Properties. **/ + /** Basic fields. **/ cluster_data->Name = check_ptr(nmSysStrdup(inf->Name)); if (cluster_data->Name == NULL) goto err_free; - cluster_data->SourceData = check_ptr(source_data); - if (cluster_data->SourceData == NULL) goto err_free; + cluster_data->SourceData = source_data; if (!check(objCurrentDate(&cluster_data->DateCreated))) goto err_free; /** Get algorithm. **/ @@ -1087,7 +1130,7 @@ ci_ParseClusterData(pStructInf inf, pNodeData node_data) /** Get min_improvement. **/ double improvement; result = ci_ParseAttribute(inf, "min_improvement", DATA_T_DOUBLE, POD(&improvement), param_list, false, false); - if (result == 1) cluster_data->MinImprovement = DEFAULT_MIN_IMPROVEMENT; + if (result == 1) cluster_data->MinImprovement = CI_DEFAULT_MIN_IMPROVEMENT; else if (result == 0) { if (improvement <= 0.0 || 1.0 <= improvement) @@ -1127,7 +1170,7 @@ ci_ParseClusterData(pStructInf inf, pNodeData node_data) } cluster_data->MaxIterations = (unsigned int)max_iterations; } - else cluster_data->MaxIterations = DEFAULT_MAX_ITERATIONS; + else cluster_data->MaxIterations = CI_DEFAULT_MAX_ITERATIONS; /** Search for sub-clusters. **/ if (!check(xaInit(&sub_clusters, 4u))) goto err_free; @@ -1186,11 +1229,12 @@ ci_ParseClusterData(pStructInf inf, pNodeData node_data) "Warning: Unknown group [\"%s\" : \"%s\"] in cluster \"%s\".\n", name, group_type, inf->Name ); + ci_GiveHint("cluster/cluster"); continue; } /** Subcluster found. **/ - pClusterData sub_cluster = ci_ParseClusterData(sub_inf, node_data); + pClusterData sub_cluster = ci_ParseClusterData(sub_inf, param_list, source_data); if (sub_cluster == NULL) goto err_free; sub_cluster->Parent = cluster_data; if (!check_neg(xaAddItem(&sub_clusters, sub_cluster))) goto err_free; @@ -1318,6 +1362,10 @@ ci_ParseSearchData(pStructInf inf, pNodeData node_data) pSearchData search_data = NULL; char* key = NULL; + /** Extract values. **/ + pParamObjects param_list = check_ptr(node_data->ParamList); + if (param_list == NULL) goto err_free; + /** Allocate space for search struct. **/ search_data = check_ptr(nmMalloc(sizeof(SearchData))); if (search_data == NULL) goto err_free; @@ -1328,9 +1376,9 @@ ci_ParseSearchData(pStructInf inf, pNodeData node_data) if (search_data->Name == NULL) goto err_free; if (!check(objCurrentDate(&search_data->DateCreated))) goto err_free; - /** Get source cluster. **/ + /** Search for the source cluster. **/ char* source_cluster_name; - if (ci_ParseAttribute(inf, "source", DATA_T_STRING, POD(&source_cluster_name), node_data->ParamList, true, true) != 0) return NULL; + if (ci_ParseAttribute(inf, "source", DATA_T_STRING, POD(&source_cluster_name), param_list, true, true) != 0) return NULL; for (unsigned int i = 0; i < node_data->nClusterDatas; i++) { pClusterData cluster_data = node_data->ClusterDatas[i]; @@ -1361,7 +1409,7 @@ ci_ParseSearchData(pStructInf inf, pNodeData node_data) } /** Get threshold attribute. **/ - if (ci_ParseAttribute(inf, "threshold", DATA_T_DOUBLE, POD(&search_data->Threshold), node_data->ParamList, true, true) != 0) goto err_free; + if (ci_ParseAttribute(inf, "threshold", DATA_T_DOUBLE, POD(&search_data->Threshold), param_list, true, true) != 0) goto err_free; if (search_data->Threshold <= 0.0 || 1.0 <= search_data->Threshold) { mssErrorf(1, "Cluster", @@ -1372,7 +1420,7 @@ ci_ParseSearchData(pStructInf inf, pNodeData node_data) } /** Get similarity measure. **/ - search_data->SimilarityMeasure = ci_ParseSimilarityMeasure(inf, node_data->ParamList); + search_data->SimilarityMeasure = ci_ParseSimilarityMeasure(inf, param_list); if (search_data->SimilarityMeasure == SIMILARITY_NULL) goto err_free; /** Check for additional data to warn the user about. **/ @@ -1636,12 +1684,14 @@ ci_ParseNodeData(pStructInf inf, pObject parent) int num_provided_params = (has_provided_params) ? parent->Pathname->OpenCtl[parent->SubPtr - 1]->nSubInf : 0; pStruct* provided_params = (has_provided_params) ? parent->Pathname->OpenCtl[parent->SubPtr - 1]->SubInf : NULL; - /** Iterate over each param in the structure file. **/ + /** Allocate space to store params. **/ node_data->nParams = param_infs.nItems; const size_t params_size = node_data->nParams * sizeof(pParam); node_data->Params = check_ptr(nmSysMalloc(params_size)); if (node_data->Params == NULL) goto err_free; memset(node_data->Params, 0, params_size); + + /** Iterate over each param in the structure file. **/ for (unsigned int i = 0u; i < node_data->nParams; i++) { pParam param = paramCreateFromInf(param_infs.Items[i]); @@ -1658,7 +1708,8 @@ ci_ParseNodeData(pStructInf inf, pObject parent) /** Check each provided param to see if the user provided value. **/ for (unsigned int j = 0u; j < num_provided_params; j++) { - pStruct provided_param = check_ptr(provided_params[j]); /* Failure ignored. */ + pStruct provided_param = check_ptr(provided_params[j]); + if (provided_param == NULL) goto err_free; /** If this provided param value isn't for the param, ignore it. **/ if (strcmp(provided_param->Name, param->Name) != 0) continue; @@ -1700,7 +1751,8 @@ ci_ParseNodeData(pStructInf inf, pObject parent) /** Iterate over provided parameters and warn the user if they specified a parameter that does not exist. **/ for (unsigned int i = 0u; i < num_provided_params; i++) { - pStruct provided_param = check_ptr(provided_params[i]); /* Failure ignored. */ + pStruct provided_param = check_ptr(provided_params[i]); + if (provided_param == NULL) goto err_free; char* provided_name = provided_param->Name; /** Look to see if this provided param actually exists for this driver instance. **/ @@ -1733,7 +1785,7 @@ ci_ParseNodeData(pStructInf inf, pObject parent) memset(node_data->ClusterDatas, 0, clusters_size); for (unsigned int i = 0u; i < node_data->nClusterDatas; i++) { - node_data->ClusterDatas[i] = ci_ParseClusterData(cluster_infs.Items[i], node_data); + node_data->ClusterDatas[i] = ci_ParseClusterData(cluster_infs.Items[i], node_data->ParamList, node_data->SourceData); if (node_data->ClusterDatas[i] == NULL) goto err_free; } } @@ -2057,7 +2109,7 @@ ci_ClearCaches(void) static unsigned int ci_SizeOfSourceData(pSourceData source_data) { - /** Guard segfault. **/ + /** Guard segfaults. **/ if (source_data == NULL) { fprintf(stderr, "Warning: Call to ci_SizeOfSourceData(NULL);\n"); @@ -2102,7 +2154,7 @@ ci_SizeOfSourceData(pSourceData source_data) static unsigned int ci_SizeOfClusterData(pClusterData cluster_data, bool recursive) { - /** Guard segfault. **/ + /** Guard segfaults. **/ if (cluster_data == NULL) { fprintf(stderr, "Warning: Call to ci_SizeOfClusterData(NULL, %s);\n", (recursive) ? "true" : "false"); @@ -2147,7 +2199,7 @@ ci_SizeOfClusterData(pClusterData cluster_data, bool recursive) static unsigned int ci_SizeOfSearchData(pSearchData search_data) { - /** Guard segfault. **/ + /** Guard segfaults. **/ if (search_data == NULL) { fprintf(stderr, "Warning: Call to ci_SizeOfSearchData(NULL);\n"); @@ -2189,7 +2241,7 @@ ci_ComputeSourceData(pSourceData source_data, pObjSession session) XArray data_xarray = {0}; XArray vector_xarray = {0}; - /** Guard segfault. **/ + /** Guard segfaults. **/ if (source_data == NULL) return -1; /** If the vectors are already computed, we're done. **/ @@ -2229,9 +2281,6 @@ ci_ComputeSourceData(pSourceData source_data, pObjSession session) } /** Initialize an xarray to store the retrieved data. **/ - // memset(&key_xarray, 0, sizeof(XArray)); - // memset(&data_xarray, 0, sizeof(XArray)); - // memset(&vector_xarray, 0, sizeof(XArray)); if (!check(xaInit(&key_xarray, 64))) goto end_free; if (!check(xaInit(&data_xarray, 64))) goto end_free; if (!check(xaInit(&vector_xarray, 64))) goto end_free; @@ -2538,12 +2587,12 @@ ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data) /** Allocate static memory for finding clusters. **/ const size_t clusters_size = cluster_data->nClusters * sizeof(Cluster); - cluster_data->Clusters = check_ptr(nmSysMalloc(clusters_size)); - if (cluster_data->Clusters == NULL) goto err_free; - memset(cluster_data->Clusters, 0, clusters_size); const size_t sims_size = source_data->nVectors * sizeof(double); + cluster_data->Clusters = check_ptr(nmSysMalloc(clusters_size)); cluster_data->Sims = check_ptr(nmSysMalloc(sims_size)); + if (cluster_data->Clusters == NULL) goto err_free; if (cluster_data->Sims == NULL) goto err_free; + memset(cluster_data->Clusters, 0, clusters_size); memset(cluster_data->Sims, 0, sims_size); /** Execute clustering. **/ @@ -2551,15 +2600,23 @@ ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data) { case ALGORITHM_NONE: { - /** Put all the data into one cluster. **/ + /*** Put all the data into one cluster. Remember, in the + *** no clustering case, there is only one cluster (see + *** ci_ParseClusterData() above). + ***/ + + /** Initialize the cluster. **/ pCluster first_cluster = &cluster_data->Clusters[0]; first_cluster->Size = source_data->nVectors; first_cluster->Strings = check_ptr(nmSysMalloc(source_data->nVectors * sizeof(char*))); if (first_cluster->Strings == NULL) goto err_free; first_cluster->Vectors = check_ptr(nmSysMalloc(source_data->nVectors * sizeof(pVector))); if (first_cluster->Vectors == NULL) goto err_free; + + /** Copy data. **/ memcpy(first_cluster->Strings, source_data->Strings, source_data->nVectors * sizeof(char*)); memcpy(first_cluster->Vectors, source_data->Vectors, source_data->nVectors * sizeof(pVector)); + break; } @@ -2619,6 +2676,8 @@ ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data) if (cluster->Strings == NULL) goto err_free; cluster->Vectors = check_ptr(nmSysMalloc(cluster->Size * sizeof(pVector))); if (cluster->Vectors == NULL) goto err_free; + + /** Add data to clusters. **/ for (unsigned int j = 0u; j < cluster->Size; j++) { const unsigned long long index = (unsigned long long)indexes_in_this_cluster->Items[j]; @@ -2650,6 +2709,11 @@ ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data) { for (unsigned int i = 0u; i < cluster_data->nClusters; i++) { + /*** NOTE: The clusters here do not need to each be freed + *** individually because they are part of the dynamically + *** allocated Clusters array (freed after the loop). + *** Thus, this loop only frees each cluster's content. + ***/ pCluster cluster = &cluster_data->Clusters[i]; if (cluster->Strings != NULL) nmFree(cluster->Strings, cluster->Size * sizeof(char*)); else break; @@ -2701,93 +2765,20 @@ ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) /** Record the date and time. **/ if (!check(objCurrentDate(&search_data->DateComputed))) goto err_free; - /** Execute the search using the specified source and comparison function. **/ - pXArray dups_temp = NULL; + /** Select the correct comparison function based on the similarity measure. **/ + const double (*similarity_function)(void *, void *); + char* similarity_function_name; switch (search_data->SimilarityMeasure) { case SIMILARITY_COSINE: - { - if (cluster_data->ClusterAlgorithm == ALGORITHM_SLIDING_WINDOW) - { - dups_temp = check_ptr(ca_sliding_search( - (void**)cluster_data->SourceData->Vectors, - cluster_data->SourceData->nVectors, - cluster_data->MaxIterations, /* Window size. */ - ca_cos_compare, - search_data->Threshold, - (void**)cluster_data->SourceData->Keys, - dups - )); - if (dups_temp == NULL) - { - mssErrorf(1, "Cluster", "Failed to compute sliding search with cosine similarity measure."); - goto err_free; - } - } - else - { - for (unsigned int i = 0u; i < cluster_data->nClusters; i++) - { - dups_temp = check_ptr(ca_complete_search( - (void**)cluster_data->Clusters[i].Vectors, - cluster_data->Clusters[i].Size, - ca_cos_compare, - search_data->Threshold, - (void**)cluster_data->SourceData->Keys, - dups - )); - if (dups_temp == NULL) - { - mssErrorf(1, "Cluster", "Failed to compute complete search with cosine similarity measure."); - goto err_free; - } - else dups = dups_temp; - } - } + similarity_function = ca_cos_compare; + similarity_function_name = "cosine"; break; - } - + case SIMILARITY_LEVENSHTEIN: - { - if (cluster_data->ClusterAlgorithm == ALGORITHM_SLIDING_WINDOW) - { - dups_temp = check_ptr(ca_sliding_search( - (void**)cluster_data->SourceData->Vectors, - cluster_data->SourceData->nVectors, - cluster_data->MaxIterations, /* Window size. */ - ca_lev_compare, - search_data->Threshold, - (void**)cluster_data->SourceData->Keys, - dups - )); - if (dups_temp == NULL) - { - mssErrorf(1, "Cluster", "Failed to compute sliding search with Levenstein similarity measure."); - goto err_free; - } - } - else - { - for (unsigned int i = 0u; i < cluster_data->nClusters; i++) - { - dups_temp = check_ptr(ca_complete_search( - (void**)cluster_data->Clusters[i].Strings, - cluster_data->Clusters[i].Size, - ca_lev_compare, - search_data->Threshold, - (void**)cluster_data->SourceData->Keys, - dups - )); - if (dups_temp == NULL) - { - mssErrorf(1, "Cluster", "Failed to compute complete search with Levenstein similarity measure."); - goto err_free; - } - else dups = dups_temp; - } - } + similarity_function = ca_lev_compare; + similarity_function_name = "Levenstein"; break; - } default: mssErrorf(1, "Cluster", @@ -2796,9 +2787,66 @@ ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) ); goto err_free; } + + + /** Execute the search using the specified algorithm. **/ + pXArray dups_temp = NULL; + if (cluster_data->ClusterAlgorithm == ALGORITHM_SLIDING_WINDOW) + { + /*** Note: We don't need to examine the clusters because nothing + *** was computed during the clustering phase. + ***/ + + /** Execute sliding search. **/ + dups_temp = check_ptr(ca_sliding_search( + (void**)source_data->Vectors, + source_data->nVectors, + cluster_data->MaxIterations, /* Window size. */ + similarity_function, + search_data->Threshold, + (void**)source_data->Keys, + dups + )); + if (dups_temp == NULL) + { + mssErrorf(1, "Cluster", + "Failed to compute sliding search with %s similarity measure.", + similarity_function_name + ); + goto err_free; + } + } + else + { + for (unsigned int i = 0u; i < cluster_data->nClusters; i++) + { + /** Extract the struct for the cluster. **/ + pCluster cluster = &cluster_data->Clusters[i]; + // ASSERTMAGIC(cluster, MGK_CL_CLUSTER); + + /** Execute complete search. **/ + dups_temp = check_ptr(ca_complete_search( + (void**)cluster->Vectors, + cluster->Size, + similarity_function, + search_data->Threshold, + (void**)source_data->Keys, + dups + )); + if (dups_temp == NULL) + { + mssErrorf(1, "Cluster", + "Failed to compute complete search with %s similarity measure.", + similarity_function_name + ); + goto err_free; + } + else dups = dups_temp; + } + } + if (dups_temp == NULL) goto err_free; else dups = dups_temp; - // fprintf(stderr, "Done searching, found %d dups.\n", dups->nItems); /** Store dups. **/ search_data->nDups = dups->nItems; @@ -2961,6 +3009,14 @@ clusterOpen(pObject parent, int mask, pContentType sys_type, char* usr_type, pOb /** Update statistics. **/ ClusterStatistics.OpenCalls++; + /** Guard segfaults. **/ + if (parent == NULL) + { + fprintf(stderr, "Warning: Call to clusterOpen(NULL, ...);\n"); + return; + } + ASSERTMAGIC(parent, MGK_OBJECT); + /** If CREAT and EXCL are specified, exclusively create it, failing if the file already exists. **/ pSnNode node_struct = NULL; bool can_create = (parent->Mode & O_CREAT) && (parent->SubPtr == parent->Pathname->nElements); @@ -3036,18 +3092,18 @@ clusterOpen(pObject parent, int mask, pContentType sys_type, char* usr_type, pOb /** If the path does not go any deeper, we're done. **/ if (path_part == NULL) { - driver_data->TargetData = (void*)cluster; + driver_data->TargetData = (void*)cluster_data; break; } /** Need to go deeper: Search for the requested sub-cluster. **/ - for (unsigned int i = 0u; i < cluster->nSubClusters; i++) + for (unsigned int i = 0u; i < cluster_data->nSubClusters; i++) { - pClusterData sub_cluster = cluster->SubClusters[i]; + pClusterData sub_cluster = cluster_data->SubClusters[i]; if (strcmp(sub_cluster->Name, path_part) != 0) continue; - /** Target found: Sub-cluster **/ - cluster = sub_cluster; + /** Target found: Sub-cluster_data **/ + cluster_data = sub_cluster; goto continue_descent; } @@ -3063,12 +3119,15 @@ clusterOpen(pObject parent, int mask, pContentType sys_type, char* usr_type, pOb /** Search searches. **/ for (unsigned int i = 0u; i < node_data->nSearchDatas; i++) { - pSearchData search = node_data->SearchDatas[i]; - if (strcmp(search->Name, target_name) != 0) continue; + pSearchData search_data = node_data->SearchDatas[i]; + // ASSERTMAGIC(search_data, MGK_CL_SEARCH_DATA); + + /** Skip clusters with the wrong name. **/ + if (strcmp(search_data->Name, target_name) != 0) continue; /** Target found: Search **/ driver_data->TargetType = TARGET_SEARCH; - driver_data->TargetData = (void*)search; + driver_data->TargetData = (void*)search_data; /** Check for extra, invalid path parts. **/ char* extra_data = obj_internal_PathPart(parent->Pathname, parent->SubPtr + parent->SubCnt++, 1); @@ -4138,7 +4197,7 @@ clusterGetNextAttr(void* inf_v, pObjTrxTree* oxt) return NULL; } - return; /* Unreachable. */ + return NULL; /* Unreachable. */ } @@ -4554,6 +4613,11 @@ clusterExecuteMethod(void* inf_v, char* method_name, pObjData param, pObjTrxTree /** Unknown parameter. **/ mssErrorf(1, "Cluster", "Unknown command: \"%s\"", method_name); + /** Attempt to give hint. **/ + unsigned int n_methods = 0; + while (METHOD_NAMES[n_methods] != NULL) n_methods++; + if (ci_TryHint(method_name, METHOD_NAMES, n_methods)); + err: mssErrorf(0, "Cluster", "Failed execute command."); From 636814e10e60c5a69fa756c81d4a7bb50baea894 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Thu, 8 Jan 2026 10:40:45 -0700 Subject: [PATCH 042/275] Add magic.h to all major cluster driver structs. Fix type warnings from const. Clean up code. --- centrallix-lib/include/magic.h | 8 + centrallix/osdrivers/objdrv_cluster.c | 480 ++++++++++++++++++-------- 2 files changed, 342 insertions(+), 146 deletions(-) diff --git a/centrallix-lib/include/magic.h b/centrallix-lib/include/magic.h index f7a0189f3..50ea697da 100644 --- a/centrallix-lib/include/magic.h +++ b/centrallix-lib/include/magic.h @@ -111,4 +111,12 @@ typedef struct #define MGK_SMREGION 0x1200345c /* smmalloc.h::SmRegion */ #define MGK_SMBLOCK 0x1200349a /* smmalloc_private.h::SmBlock */ +#define MGK_CL_SOURCE_DATA 0x12340c19 /* objdrv_cluster.c::SourceData */ +#define MGK_CL_CLUSTER 0x12340c28 /* objdrv_cluster.c::Cluster */ +#define MGK_CL_CLUSTER_DATA 0x12340c37 /* objdrv_cluster.c::ClusterData */ +#define MGK_CL_SEARCH_DATA 0x12340c46 /* objdrv_cluster.c::SearchData */ +#define MGK_CL_NODE_DATA 0x12340c55 /* objdrv_cluster.c::NodeData */ +#define MGK_CL_DRIVER_DATA 0x12340c64 /* objdrv_cluster.c::DriverData */ +#define MGK_CL_QUERY_DATA 0x12340c73 /* objdrv_cluster.c::QueryData */ + #endif /* not defined _MAGIC_H */ diff --git a/centrallix/osdrivers/objdrv_cluster.c b/centrallix/osdrivers/objdrv_cluster.c index fa9902fd2..f22449ec6 100644 --- a/centrallix/osdrivers/objdrv_cluster.c +++ b/centrallix/osdrivers/objdrv_cluster.c @@ -41,6 +41,7 @@ #include #include "cxlib/clusters.h" +#include "cxlib/magic.h" #include "cxlib/mtsession.h" #include "cxlib/newmalloc.h" #include "cxlib/util.h" @@ -275,7 +276,7 @@ typedef unsigned char TargetType; /** Attribute name lists by TargetType. **/ #define END_OF_ARRAY NULL -const char* ATTR_ROOT[] = +char* ATTR_ROOT[] = { "source", "attr_name", @@ -283,7 +284,7 @@ const char* ATTR_ROOT[] = "date_computed", END_OF_ARRAY, }; -const char* ATTR_CLUSTER[] = +char* ATTR_CLUSTER[] = { "algorithm", "similarity_measure", @@ -294,21 +295,21 @@ const char* ATTR_CLUSTER[] = "date_computed", END_OF_ARRAY, }; -const char* ATTR_SEARCH[] = +char* ATTR_SEARCH[] = { "source", "threshold", "similarity_measure", END_OF_ARRAY, }; -const char* ATTR_CLUSTER_ENTRY[] = +char* ATTR_CLUSTER_ENTRY[] = { "items", "date_created", "date_computed", END_OF_ARRAY, }; -const char* ATTR_SEARCH_ENTRY[] = +char* ATTR_SEARCH_ENTRY[] = { "key1", "key2", @@ -317,7 +318,7 @@ const char* ATTR_SEARCH_ENTRY[] = }; /** Method name list. **/ -const char* METHOD_NAMES[] = +char* METHOD_NAMES[] = { "cache", "stat", @@ -331,7 +332,7 @@ const char* METHOD_NAMES[] = /*** Represents the data source which may have data already fetched. *** *** Memory Stats: - *** - Padding: 4 bytes + *** - Padding: 0 bytes *** - Total size: 80 bytes *** *** @skip --> Attribute Data. @@ -357,9 +358,13 @@ const char* METHOD_NAMES[] = *** @skip --> Time. *** @param DateCreated The date and time that this object was created and initialized. *** @param DateComputed The date and time that the computed attributes were computed. + *** + *** @param Magic A magic value for detecting corrupted memory. ***/ typedef struct _SOURCE { + Magic_t Magic; + unsigned int nVectors; char* Name; char* Key; char* SourcePath; @@ -368,7 +373,6 @@ typedef struct _SOURCE char** Keys; char** Strings; pVector* Vectors; - unsigned int nVectors; DateTime DateCreated; DateTime DateComputed; } @@ -378,18 +382,20 @@ typedef struct _SOURCE /*** Computed data for a single cluster. *** *** Memory Stats: - *** - Padding: 4 bytes + *** - Padding: 0 bytes *** - Total size: 24 bytes *** *** @param Size The number of items in the cluster. *** @param Strings The string values of each item. *** @param Vectors The cosine vectors for each item. + *** @param Magic A magic value for detecting corrupted memory. ***/ typedef struct { + Magic_t Magic; unsigned int Size; - char** Strings; - pVector* Vectors; + char** Strings; + pVector* Vectors; } Cluster, *pCluster; @@ -397,8 +403,8 @@ typedef struct /*** Data for each cluster. Only attribute data is checked for caching. *** *** Memory Stats: - *** - Padding: 2 bytes - *** - Total size: 96 bytes + *** - Padding: 6 bytes + *** - Total size: 104 bytes *** *** @skip --> Attribute Data. *** @param Name The cluster name, specified in the .cluster file. @@ -429,14 +435,17 @@ typedef struct *** @skip --> Time. *** @param DateCreated The date and time that this object was created and initialized. *** @param DateComputed The date and time that the computed attributes were computed. + *** + *** @param Magic A magic value for detecting corrupted memory. ***/ typedef struct _CLUSTER { + Magic_t Magic; + unsigned int nClusters; char* Name; char* Key; ClusterAlgorithm ClusterAlgorithm; SimilarityMeasure SimilarityMeasure; - unsigned int nClusters; double MinImprovement; unsigned int MaxIterations; unsigned int nSubClusters; @@ -449,13 +458,13 @@ typedef struct _CLUSTER DateTime DateComputed; } ClusterData, *pClusterData; - + /*** Data for each search. *** *** Memory Stats: - *** - Padding: 3 bytes - *** - Total size: 64 bytes + *** - Padding: 7 bytes + *** - Total size: 72 bytes *** *** @skip --> Attribute Data. *** @param Name The search name, specified in the .cluster file. @@ -473,9 +482,12 @@ typedef struct _CLUSTER *** @skip --> Time. *** @param DateCreated The date and time that this object was created and initialized. *** @param DateComputed The date and time that the computed attributes were computed. + *** + *** @param Magic A magic value for detecting corrupted memory. ***/ typedef struct _SEARCH { + Magic_t Magic; char* Name; char* Key; pClusterData SourceCluster; @@ -492,8 +504,8 @@ typedef struct _SEARCH /*** Node instance data. *** *** Memory Stats: - *** - Padding: 0 bytes - *** - Total size: 64 bytes + *** - Padding: 4 bytes + *** - Total size: 72 bytes *** *** @note When a .cluster file is openned, there will be only one node for that *** file. However, in the course of the query, many driver instance structs @@ -512,9 +524,11 @@ typedef struct _SEARCH *** @param nSearchDatas The parent object used to open this NodeData instance. *** @param OpenCount The number of open driver instances that are using the *** NodeData struct. When this reaches 0, the struct should be freed. + *** @param Magic A magic value for detecting corrupted memory. ***/ typedef struct _NODE { + Magic_t Magic; pObject Parent; pParam* Params; pParamObjects ParamList; @@ -531,8 +545,8 @@ typedef struct _NODE /*** Driver instance data. *** *** Memory Stats: - *** - Padding: 1 bytes - *** - Total size: 24 bytes + *** - Padding: 5 bytes + *** - Total size: 32 bytes *** *** This struct can be thought of like a "pointer" to specific data accessible *** through the stored pNodeData struct. This struct also communicates whether @@ -560,9 +574,11 @@ typedef struct _NODE *** ``` *** @param TargetAttrIndex An index into an attribute list (for GetNextAttr()). *** @param TargetMethodIndex An index into an method list (for GetNextMethod()). + *** @param Magic A magic value for detecting corrupted memory. ***/ typedef struct _DRIVER { + Magic_t Magic; pNodeData NodeData; void* TargetData; unsigned int TargetIndex; @@ -575,18 +591,20 @@ typedef struct _DRIVER /*** Query instance data. *** *** Memory Stats: - *** - Padding: 4 bytes + *** - Padding: 0 bytes *** - Total size: 16 bytes *** *** @param DriverData The associated driver instance being queried. *** @param RowIndex The selected row of the data targetted by the driver. + *** @param Magic A magic value for detecting corrupted memory. ***/ typedef struct { - pDriverData DriverData; + Magic_t Magic; unsigned int RowIndex; + pDriverData DriverData; } - ClusterQuery, *pClusterQuery; + ClusterQuery, *pQueryData; /** Global storage for caches. **/ @@ -622,7 +640,7 @@ struct // LINK #parsing static void ci_GiveHint(const char* hint); static bool ci_TryHint(char* value, char** valid_values, const unsigned int n_valid_values); -static void ci_UnknownAttribute(const char* attr_name, int target_type); +static void ci_UnknownAttribute(char* attr_name, int target_type); static int ci_ParseAttribute(pStructInf inf, char* attr_name, int datatype, pObjData data, pParamObjects param_list, bool required, bool print_type_error); static ClusterAlgorithm ci_ParseClusteringAlgorithm(pStructInf cluster_inf, pParamObjects param_list); static SimilarityMeasure ci_ParseSimilarityMeasure(pStructInf cluster_inf, pParamObjects param_list); @@ -737,13 +755,13 @@ ci_TryHint(char* value, char** valid_values, const unsigned int n_valid_values) *** attributes in this context. ***/ static void -ci_UnknownAttribute(const char* attr_name, int target_type) +ci_UnknownAttribute(char* attr_name, const int target_type) { /** Display the error message. */ mssErrorf(1, "Cluster", "Unknown attribute '%s'.", attr_name); /** Collect specific attributes based on target type. **/ - const char** specific_attrs = NULL; + char** specific_attrs = NULL; switch (target_type) { case TARGET_NODE: specific_attrs = ATTR_ROOT; break; @@ -764,7 +782,7 @@ ci_UnknownAttribute(const char* attr_name, int target_type) while (specific_attrs[n_specific_attrs] != NULL) n_specific_attrs++; /** Collect general attributes. */ - const char* general_attrs = (char*[]){"name", "annoation", "content_type", "inner_type", "outer_type", "internal_type", "date_computed", "date_created", "last_modification"}; + char** general_attrs = (char*[]){"name", "annoation", "content_type", "inner_type", "outer_type", "internal_type", "date_computed", "date_created", "last_modification"}; /** Attempt to give hints. **/ if (ci_TryHint(attr_name, specific_attrs, n_specific_attrs)); @@ -968,11 +986,15 @@ ci_ParseSourceData(pStructInf inf, pParamObjects param_list, char* path) { char* buf = NULL; pSourceData source_data = NULL; - + + /** Magic checks. **/ + ASSERTMAGIC(inf, MGK_STRUCTINF); + /** Allocate SourceData. **/ source_data = check_ptr(nmMalloc(sizeof(SourceData))); if (source_data == NULL) goto err_free; memset(source_data, 0, sizeof(SourceData)); + SETMAGIC(source_data, MGK_CL_SOURCE_DATA); /** Initialize obvious values for SourceData. **/ source_data->Name = check_ptr(nmSysStrdup(inf->Name)); @@ -1010,6 +1032,8 @@ ci_ParseSourceData(pStructInf inf, pParamObjects param_list, char* path) pSourceData source_maybe = (pSourceData)xhLookup(&ClusterDriverCaches.SourceDataCache, source_data->Key); if (source_maybe != NULL) { /* Cache hit. */ + ASSERTMAGIC(source_maybe, MGK_CL_SOURCE_DATA); + /** Free data we don't need. **/ nmSysFree(source_data->Key); ci_FreeSourceData(source_data); @@ -1064,14 +1088,15 @@ ci_ParseClusterData(pStructInf inf, pParamObjects param_list, pSourceData source XArray sub_clusters = {0}; char* key = NULL; - /** Extract values. **/ - pParamObjects param_list = node_data->ParamList; - pSourceData source_data = node_data->SourceData; + /** Verify source_data value. **/ + if (source_data == NULL) goto err_free; + ASSERTMAGIC(source_data, MGK_CL_SOURCE_DATA); /** Allocate space for data struct. **/ cluster_data = check_ptr(nmMalloc(sizeof(ClusterData))); if (cluster_data == NULL) goto err_free; memset(cluster_data, 0, sizeof(ClusterData)); + SETMAGIC(cluster_data, MGK_CL_CLUSTER_DATA); /** Basic fields. **/ cluster_data->Name = check_ptr(nmSysStrdup(inf->Name)); @@ -1308,6 +1333,8 @@ ci_ParseClusterData(pStructInf inf, pParamObjects param_list, pSourceData source pClusterData cluster_maybe = (pClusterData)xhLookup(&ClusterDriverCaches.ClusterDataCache, key); if (cluster_maybe != NULL) { /* Cache hit. */ + ASSERTMAGIC(cluster_maybe, MGK_CL_CLUSTER_DATA); + /** Free the parsed cluster that we no longer need. */ ci_FreeClusterData(cluster_data, false); nmSysFree(key); @@ -1370,6 +1397,7 @@ ci_ParseSearchData(pStructInf inf, pNodeData node_data) search_data = check_ptr(nmMalloc(sizeof(SearchData))); if (search_data == NULL) goto err_free; memset(search_data, 0, sizeof(SearchData)); + SETMAGIC(search_data, MGK_CL_SEARCH_DATA); /** Get basic information. **/ search_data->Name = check_ptr(nmSysStrdup(inf->Name)); @@ -1382,6 +1410,7 @@ ci_ParseSearchData(pStructInf inf, pNodeData node_data) for (unsigned int i = 0; i < node_data->nClusterDatas; i++) { pClusterData cluster_data = node_data->ClusterDatas[i]; + ASSERTMAGIC(cluster_data, MGK_CL_CLUSTER_DATA); if (strcmp(source_cluster_name, cluster_data->Name) == 0) { /** SourceCluster found. **/ @@ -1503,6 +1532,8 @@ ci_ParseSearchData(pStructInf inf, pNodeData node_data) pSearchData search_maybe = (pSearchData)xhLookup(search_cache, key); if (search_maybe != NULL) { /* Cache hit. */ + ASSERTMAGIC(search_maybe, MGK_CL_SEARCH_DATA); + /** Free the parsed search that we no longer need. **/ if (search_data != NULL) ci_FreeSearchData(search_data); if (key != NULL) nmSysFree(key); @@ -1547,6 +1578,10 @@ ci_ParseNodeData(pStructInf inf, pObject parent) XArray cluster_infs = {0}; XArray search_infs = {0}; + /** Magic. **/ + ASSERTMAGIC(inf, MGK_STRUCTINF); + ASSERTMAGIC(parent, MGK_OBJECT); + /** Get file path. **/ char* path = check_ptr(ci_file_path(parent)); if (path == NULL) goto err_free; @@ -1555,6 +1590,7 @@ ci_ParseNodeData(pStructInf inf, pObject parent) node_data = check_ptr(nmMalloc(sizeof(NodeData))); if (node_data == NULL) goto err_free; memset(node_data, 0, sizeof(NodeData)); + SETMAGIC(node_data, MGK_CL_NODE_DATA); node_data->Parent = parent; /** Set up param list. **/ @@ -1787,6 +1823,7 @@ ci_ParseNodeData(pStructInf inf, pObject parent) { node_data->ClusterDatas[i] = ci_ParseClusterData(cluster_infs.Items[i], node_data->ParamList, node_data->SourceData); if (node_data->ClusterDatas[i] == NULL) goto err_free; + ASSERTMAGIC(node_data->ClusterDatas[i], MGK_CL_CLUSTER_DATA); } } else node_data->ClusterDatas = NULL; @@ -1805,6 +1842,7 @@ ci_ParseNodeData(pStructInf inf, pObject parent) { node_data->SearchDatas[i] = ci_ParseSearchData(search_infs.Items[i], node_data); if (node_data->SearchDatas[i] == NULL) goto err_free; + ASSERTMAGIC(node_data->SearchDatas[i], MGK_CL_SEARCH_DATA); } } else node_data->SearchDatas = NULL; @@ -1839,6 +1877,7 @@ ci_FreeSourceData(pSourceData source_data) fprintf(stderr, "Warning: Call to ci_FreeSourceData(NULL);\n"); return; } + ASSERTMAGIC(source_data, MGK_CL_SOURCE_DATA); /** Free top level attributes, if they exist. **/ if (source_data->Name != NULL) @@ -1913,6 +1952,7 @@ ci_FreeClusterData(pClusterData cluster_data, bool recursive) fprintf(stderr, "Warning: Call to ci_FreeClusterData(NULL, %s);\n", (recursive) ? "true" : "false"); return; } + ASSERTMAGIC(cluster_data, MGK_CL_CLUSTER_DATA); /** Free attribute data. **/ if (cluster_data->Name != NULL) @@ -1975,6 +2015,7 @@ ci_FreeSearchData(pSearchData search_data) fprintf(stderr, "Warning: Call to ci_FreeSearchData(NULL);\n"); return; } + ASSERTMAGIC(search_data, MGK_CL_SEARCH_DATA); /** Free attribute data. **/ if (search_data->Name != NULL) @@ -2014,6 +2055,7 @@ ci_FreeNodeData(pNodeData node_data) fprintf(stderr, "Warning: Call to ci_FreeNodeData(NULL);\n"); return; } + ASSERTMAGIC(node_data, MGK_CL_NODE_DATA); /** Free parsed params, if they exist. **/ if (node_data->Params != NULL) @@ -2115,6 +2157,7 @@ ci_SizeOfSourceData(pSourceData source_data) fprintf(stderr, "Warning: Call to ci_SizeOfSourceData(NULL);\n"); return 0u; } + ASSERTMAGIC(source_data, MGK_CL_SOURCE_DATA); unsigned int size = 0u; if (source_data->Name != NULL) size += strlen(source_data->Name) * sizeof(char); @@ -2160,6 +2203,7 @@ ci_SizeOfClusterData(pClusterData cluster_data, bool recursive) fprintf(stderr, "Warning: Call to ci_SizeOfClusterData(NULL, %s);\n", (recursive) ? "true" : "false"); return 0u; } + ASSERTMAGIC(cluster_data, MGK_CL_CLUSTER_DATA); unsigned int size = 0u; if (cluster_data->Name != NULL) size += strlen(cluster_data->Name) * sizeof(char); @@ -2205,6 +2249,7 @@ ci_SizeOfSearchData(pSearchData search_data) fprintf(stderr, "Warning: Call to ci_SizeOfSearchData(NULL);\n"); return 0u; } + ASSERTMAGIC(search_data, MGK_CL_SEARCH_DATA); unsigned int size = 0u; if (search_data->Name != NULL) size += strlen(search_data->Name) * sizeof(char); @@ -2243,6 +2288,7 @@ ci_ComputeSourceData(pSourceData source_data, pObjSession session) /** Guard segfaults. **/ if (source_data == NULL) return -1; + ASSERTMAGIC(source_data, MGK_CL_SOURCE_DATA); /** If the vectors are already computed, we're done. **/ if (source_data->Vectors != NULL) return 0; @@ -2290,6 +2336,7 @@ ci_ComputeSourceData(pSourceData source_data, pObjSession session) { pObject entry = objQueryFetch(query, O_RDONLY); if (entry == NULL) break; /* Done. */ + ASSERTMAGIC(entry, MGK_OBJECT); /** Data value: Type checking. **/ const int data_datatype = objGetAttrType(entry, source_data->NameAttr); @@ -2563,6 +2610,8 @@ ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data) /** Guard segfaults. **/ if (cluster_data == NULL || node_data == NULL) return -1; + ASSERTMAGIC(cluster_data, MGK_CL_CLUSTER_DATA); + ASSERTMAGIC(node_data, MGK_CL_NODE_DATA); /** If the clusters are already computed, we're done. **/ if (cluster_data->Clusters != NULL) return 0; @@ -2574,13 +2623,18 @@ ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data) mssErrorf(1, "Cluster", "Failed to get source data for cluster computation."); goto err_free; } + ASSERTMAGIC(source_data, MGK_CL_SOURCE_DATA); /** We need the SourceData vectors to compute clusters. **/ - if (ci_ComputeSourceData(source_data, node_data->ParamList->Session) != 0) + pObjSession session = check_ptr(node_data->ParamList->Session); + if (session == NULL) goto err_free; + ASSERTMAGIC(session, MGK_OBJSESSION); + if (ci_ComputeSourceData(source_data, session) != 0) { mssErrorf(0, "Cluster", "ClusterData computation failed due to missing SourceData."); goto err_free; } + ASSERTMAGIC(source_data, MGK_CL_SOURCE_DATA); /** Record the date and time. **/ if (!check(objCurrentDate(&cluster_data->DateComputed))) goto err_free; @@ -2607,6 +2661,9 @@ ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data) /** Initialize the cluster. **/ pCluster first_cluster = &cluster_data->Clusters[0]; + SETMAGIC(first_cluster, MGK_CL_CLUSTER); + + /** Allocate space. **/ first_cluster->Size = source_data->nVectors; first_cluster->Strings = check_ptr(nmSysMalloc(source_data->nVectors * sizeof(char*))); if (first_cluster->Strings == NULL) goto err_free; @@ -2671,6 +2728,9 @@ ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data) { pXArray indexes_in_this_cluster = &indexes_in_cluster[i]; pCluster cluster = &cluster_data->Clusters[i]; + SETMAGIC(cluster, MGK_CL_CLUSTER); + + /** Allocate space. **/ cluster->Size = indexes_in_this_cluster->nItems; cluster->Strings = check_ptr(nmSysMalloc(cluster->Size * sizeof(char*))); if (cluster->Strings == NULL) goto err_free; @@ -2715,6 +2775,7 @@ ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data) *** Thus, this loop only frees each cluster's content. ***/ pCluster cluster = &cluster_data->Clusters[i]; + ASSERTMAGIC(cluster, MGK_CL_CLUSTER); if (cluster->Strings != NULL) nmFree(cluster->Strings, cluster->Size * sizeof(char*)); else break; if (cluster->Vectors != NULL) nmFree(cluster->Vectors, cluster->Size * sizeof(pVector)); @@ -2746,11 +2807,17 @@ ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) { pXArray dups = NULL; + /** Guard segfaults. **/ + if (search_data == NULL || node_data == NULL) return -1; + ASSERTMAGIC(search_data, MGK_CL_SEARCH_DATA); + ASSERTMAGIC(node_data, MGK_CL_NODE_DATA); + /** If the clusters are already computed, we're done. **/ if (search_data->Dups != NULL) return 0; /** We need the cluster data to be computed before we search it. **/ pClusterData cluster_data = check_ptr(search_data->SourceCluster); + ASSERTMAGIC(cluster_data, MGK_CL_CLUSTER_DATA); if (cluster_data == NULL) { mssErrorf(1, "Cluster", "Failed to get cluster data for search computation."); @@ -2761,6 +2828,10 @@ ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) mssErrorf(0, "Cluster", "SearchData computation failed due to missing clusters."); goto err_free; } + + /** Extract source data. **/ + pSourceData source_data = cluster_data->SourceData; + ASSERTMAGIC(source_data, MGK_CL_SOURCE_DATA); /** Record the date and time. **/ if (!check(objCurrentDate(&search_data->DateComputed))) goto err_free; @@ -2895,8 +2966,9 @@ ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) static int ci_GetParamType(void* inf_v, const char* attr_name) { - pNodeData node_data = (pNodeData)inf_v; - + pNodeData node_data = (pNodeData)inf_v; + ASSERTMAGIC(node_data, MGK_CL_NODE_DATA); + /** Find the parameter. **/ for (unsigned int i = 0; i < node_data->nParams; i++) { @@ -2939,7 +3011,8 @@ ci_GetParamType(void* inf_v, const char* attr_name) static int ci_GetParamValue(void* inf_v, char* attr_name, int datatype, pObjData val) { - pNodeData node_data = (pNodeData)inf_v; + pNodeData node_data = (pNodeData)inf_v; + ASSERTMAGIC(node_data, MGK_CL_NODE_DATA); /** Find the parameter. **/ for (unsigned int i = 0; i < node_data->nParams; i++) @@ -3013,7 +3086,7 @@ clusterOpen(pObject parent, int mask, pContentType sys_type, char* usr_type, pOb if (parent == NULL) { fprintf(stderr, "Warning: Call to clusterOpen(NULL, ...);\n"); - return; + return NULL; } ASSERTMAGIC(parent, MGK_OBJECT); @@ -3056,11 +3129,13 @@ clusterOpen(pObject parent, int mask, pContentType sys_type, char* usr_type, pOb mssErrorf(0, "Cluster", "Failed to parse structure file \"%s\".", ci_file_name(parent)); goto err_free; } + ASSERTMAGIC(node_data, MGK_CL_NODE_DATA); /** Allocate driver instance data. **/ driver_data = check_ptr(nmMalloc(sizeof(DriverData))); if (driver_data == NULL) goto err_free; memset(driver_data, 0, sizeof(DriverData)); + SETMAGIC(driver_data, MGK_CL_DRIVER_DATA); driver_data->NodeData = node_data; driver_data->NodeData->OpenCount++; @@ -3077,8 +3152,11 @@ clusterOpen(pObject parent, int mask, pContentType sys_type, char* usr_type, pOb /** Search clusters. **/ for (unsigned int i = 0u; i < node_data->nClusterDatas; i++) { - pClusterData cluster = node_data->ClusterDatas[i]; - if (strcmp(cluster->Name, target_name) != 0) continue; + pClusterData cluster_data = node_data->ClusterDatas[i]; + ASSERTMAGIC(cluster_data, MGK_CL_CLUSTER_DATA); + + /** Skip clusters with the wrong name. **/ + if (strcmp(cluster_data->Name, target_name) != 0) continue; /** Target found: Cluster **/ driver_data->TargetType = TARGET_CLUSTER; @@ -3182,8 +3260,9 @@ clusterOpen(pObject parent, int mask, pContentType sys_type, char* usr_type, pOb int clusterClose(void* inf_v, pObjTrxTree* oxt) { - pDriverData driver_data = (pDriverData)inf_v; - + pDriverData driver_data = (pDriverData)inf_v; + ASSERTMAGIC(driver_data, MGK_CL_DRIVER_DATA); + /** Update statistics. **/ ClusterStatistics.CloseCalls++; @@ -3191,7 +3270,8 @@ clusterClose(void* inf_v, pObjTrxTree* oxt) if (driver_data == NULL) return 0; /** Unlink the driver's node data. **/ - pNodeData node_data = driver_data->NodeData; + pNodeData node_data = check_ptr(driver_data->NodeData); /** Failure ignored. **/ + ASSERTMAGIC(node_data, MGK_CL_NODE_DATA); if (node_data != NULL && --node_data->OpenCount == 0) ci_FreeNodeData(driver_data->NodeData); @@ -3217,29 +3297,42 @@ clusterClose(void* inf_v, pObjTrxTree* oxt) void* clusterOpenQuery(void* inf_v, pObjQuery query, pObjTrxTree* oxt) { - pClusterQuery cluster_query = NULL; - pDriverData driver_data = inf_v; + pQueryData query_data = NULL; + /** Get driver data. **/ + pDriverData driver_data = check_ptr(inf_v); + if (driver_data == NULL) goto err_free; + ASSERTMAGIC(driver_data, MGK_CL_DRIVER_DATA); + if (driver_data->TargetType != TARGET_SEARCH && driver_data->TargetType != TARGET_CLUSTER && driver_data->TargetType != TARGET_NODE) { /** Queries are not supported for this target type. **/ - return NULL; + goto err; } /** Update statistics. **/ ClusterStatistics.OpenQueryCalls++; /** Allocate memory for the query. **/ - cluster_query = check_ptr(nmMalloc(sizeof(ClusterQuery))); - if (cluster_query == NULL) return NULL; + query_data = check_ptr(nmMalloc(sizeof(ClusterQuery))); + if (query_data == NULL) goto err_free; /** Initialize the query. **/ - cluster_query->DriverData = (pDriverData)inf_v; - cluster_query->RowIndex = 0u; - - return cluster_query; + SETMAGIC(query_data, MGK_CL_QUERY_DATA); + query_data->DriverData = (pDriverData)inf_v; + query_data->RowIndex = 0u; + + return query_data; + + err_free: + /** Error cleanup. **/ + if (query_data != NULL) nmFree(query_data, sizeof(ClusterQuery)); + mssErrorf(0, "Cluster", "Failed to open query."); + + err: + return NULL; } @@ -3258,18 +3351,28 @@ clusterOpenQuery(void* inf_v, pObjQuery query, pObjTrxTree* oxt) void* clusterQueryFetch(void* qy_v, pObject obj, int mode, pObjTrxTree* oxt) { - pClusterQuery cluster_query = (pClusterQuery)qy_v; - pDriverData driver_data = cluster_query->DriverData; pDriverData result_data = NULL; + /** Unpack data into local variables. **/ + pQueryData query_data = check_ptr((pQueryData)qy_v); + if (query_data == NULL) goto err_free; + ASSERTMAGIC(query_data, MGK_CL_QUERY_DATA); + pDriverData driver_data = check_ptr(query_data->DriverData); + if (driver_data == NULL) goto err_free; + ASSERTMAGIC(driver_data, MGK_CL_DRIVER_DATA); + pNodeData node_data = check_ptr(driver_data->NodeData); + if (node_data == NULL) goto err_free; + ASSERTMAGIC(node_data, MGK_CL_NODE_DATA); + /** Update statistics. **/ ClusterStatistics.FetchCalls++; /** Allocate result struct. **/ result_data = check_ptr(nmMalloc(sizeof(DriverData))); - if (result_data == NULL) goto err; + if (result_data == NULL) goto err_free; /** Default initialization. **/ + SETMAGIC(result_data, MGK_CL_DRIVER_DATA); result_data->NodeData = driver_data->NodeData; result_data->TargetData = driver_data->TargetData; result_data->TargetType = 0; /* Unset. */ @@ -3277,16 +3380,13 @@ clusterQueryFetch(void* qy_v, pObject obj, int mode, pObjTrxTree* oxt) result_data->TargetAttrIndex = 0; /* Reset. */ result_data->TargetMethodIndex = 0; /* Reset. */ - /** Load node data. **/ - pNodeData node_data = driver_data->NodeData; - /** Ensure that the data being fetched exists and is computed. **/ const TargetType target_type = driver_data->TargetType; switch (target_type) { case TARGET_NODE: { - unsigned int index = cluster_query->RowIndex++; + unsigned int index = query_data->RowIndex++; /** Iterate over clusters. **/ const unsigned int n_cluster_datas = node_data->nClusterDatas; @@ -3311,25 +3411,26 @@ clusterQueryFetch(void* qy_v, pObject obj, int mode, pObjTrxTree* oxt) else index -= n_search_datas; /** Iteration complete. **/ - goto done; + goto done_free; } case TARGET_CLUSTER: { /** Ensure the required data is computed. **/ pClusterData target = (pClusterData)driver_data->TargetData; + ASSERTMAGIC(target, MGK_CL_CLUSTER_DATA); if (ci_ComputeClusterData(target, node_data) != 0) { mssErrorf(0, "Cluster", "Failed to compute ClusterData for query."); - goto err; + goto err_free; } /** Stop iteration if the requested data does not exist. **/ - if (cluster_query->RowIndex >= target->nClusters) goto done; + if (query_data->RowIndex >= target->nClusters) goto done_free; /** Set the data being fetched. **/ result_data->TargetType = TARGET_CLUSTER_ENTRY; - result_data->TargetIndex = cluster_query->RowIndex++; + result_data->TargetIndex = query_data->RowIndex++; break; } @@ -3338,18 +3439,19 @@ clusterQueryFetch(void* qy_v, pObject obj, int mode, pObjTrxTree* oxt) { /** Ensure the required data is computed. **/ pSearchData target = (pSearchData)driver_data->TargetData; + ASSERTMAGIC(target, MGK_CL_SEARCH_DATA); if (ci_ComputeSearchData(target, node_data) != 0) { mssErrorf(0, "Cluster", "Failed to compute SearchData for query."); - goto err; + goto err_free; } /** Stop iteration if the requested data does not exist. **/ - if (cluster_query->RowIndex >= target->nDups) goto done; + if (query_data->RowIndex >= target->nDups) goto done_free; /** Set the data being fetched. **/ result_data->TargetType = TARGET_SEARCH_ENTRY; - result_data->TargetIndex = cluster_query->RowIndex++; + result_data->TargetIndex = query_data->RowIndex++; break; } @@ -3357,11 +3459,11 @@ clusterQueryFetch(void* qy_v, pObject obj, int mode, pObjTrxTree* oxt) case TARGET_CLUSTER_ENTRY: case TARGET_SEARCH_ENTRY: mssErrorf(1, "Cluster", "Querying a query result is not allowed."); - goto err; + goto err_free; default: mssErrorf(1, "Cluster", "Unknown target type %u.", target_type); - goto err; + goto err_free; } /** Add a link to the NodeData so that it isn't freed while we're using it. **/ @@ -3370,10 +3472,10 @@ clusterQueryFetch(void* qy_v, pObject obj, int mode, pObjTrxTree* oxt) /** Success. **/ return result_data; - err: + err_free: mssErrorf(0, "Cluster", "Failed to fetch query result."); - done: + done_free: if (result_data != NULL) nmFree(result_data, sizeof(DriverData)); return NULL; } @@ -3390,8 +3492,16 @@ clusterQueryFetch(void* qy_v, pObject obj, int mode, pObjTrxTree* oxt) ***/ int clusterQueryClose(void* qy_v, pObjTrxTree* oxt) - { - if (qy_v != NULL) nmFree(qy_v, sizeof(ClusterQuery)); + { + /** No work needed to free NULL. **/ + if (qy_v == NULL) return 0; + + /** Cast the query data. **/ + pQueryData query_data = qy_v; + ASSERTMAGIC(query_data, MGK_CL_QUERY_DATA); + + /** Free the query data. **/ + nmFree(query_data, sizeof(ClusterQuery)); return 0; } @@ -3403,15 +3513,20 @@ clusterQueryClose(void* qy_v, pObjTrxTree* oxt) *** @param inf_v The driver instance. *** @param attr_name The name of the requested attribute. *** @param oxt The object system tree, similar to a kind of "scope" (unused). - *** @returns The datatype, see datatypes.h for a list of valid datatypes. + *** @returns The datatype, see datatypes.h for a list of valid datatypes, or + *** -1 if an error occurs. *** *** LINK ../../centrallix-lib/include/datatypes.h:72 ***/ int clusterGetAttrType(void* inf_v, char* attr_name, pObjTrxTree* oxt) { - pDriverData driver_data = (pDriverData)inf_v; - + /** Extract target type from driver data. **/ + pDriverData driver_data = check_ptr(inf_v); + if (driver_data == NULL) goto err; + ASSERTMAGIC(driver_data, MGK_CL_DRIVER_DATA); + const TargetType target_type = driver_data->TargetType; + /** Update statistics. **/ ClusterStatistics.GetTypeCalls++; @@ -3437,17 +3552,17 @@ clusterGetAttrType(void* inf_v, char* attr_name, pObjTrxTree* oxt) if (strcmp(attr_name, "date_created") == 0 || strcmp(attr_name, "date_computed") == 0) { - return (driver_data->TargetType == TARGET_CLUSTER - || driver_data->TargetType == TARGET_CLUSTER_ENTRY - || driver_data->TargetType == TARGET_SEARCH - || driver_data->TargetType == TARGET_SEARCH_ENTRY) + return (target_type == TARGET_CLUSTER + || target_type == TARGET_CLUSTER_ENTRY + || target_type == TARGET_SEARCH + || target_type == TARGET_SEARCH_ENTRY) ? DATA_T_DATETIME /* Target has date attr. */ : DATA_T_UNAVAILABLE; /* Target does not have date attr. */ } /** Types for specific data targets. **/ handle_targets: - switch (driver_data->TargetType) + switch (target_type) { case TARGET_NODE: if (strcmp(attr_name, "source") == 0 @@ -3489,11 +3604,14 @@ clusterGetAttrType(void* inf_v, char* attr_name, pObjTrxTree* oxt) break; default: - mssErrorf(1, "Cluster", "Unknown target type %u.", driver_data->TargetType); + mssErrorf(1, "Cluster", "Unknown target type %u.", target_type); return DATA_T_UNAVAILABLE; } - - return DATA_T_UNAVAILABLE; + + return DATA_T_UNAVAILABLE; + + err: + return -1; } @@ -3519,7 +3637,11 @@ clusterGetAttrType(void* inf_v, char* attr_name, pObjTrxTree* oxt) int clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val, pObjTrxTree* oxt) { - pDriverData driver_data = (pDriverData)inf_v; + /** Extract target type from driver data. **/ + pDriverData driver_data = check_ptr(inf_v); + if (driver_data == NULL) goto err; + ASSERTMAGIC(driver_data, MGK_CL_DRIVER_DATA); + const TargetType target_type = driver_data->TargetType; /** Update statistics. **/ ClusterStatistics.GetValCalls++; @@ -3528,7 +3650,7 @@ clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val, pO if (attr_name == NULL) { fprintf(stderr, "Warning: Call to clusterGetAttrType() with NULL attribute name.\n"); - return DATA_T_UNAVAILABLE; + goto err; } /** Performance shortcut for frequently requested attributes: key1, key2, and sim. **/ @@ -3538,6 +3660,7 @@ clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val, pO /** Type check. **/ const int expected_datatype = clusterGetAttrType(inf_v, attr_name, oxt); + if (expected_datatype == DATA_T_UNAVAILABLE) goto unknown_attribute; if (datatype != expected_datatype) { mssErrorf(1, "Cluster", @@ -3551,24 +3674,39 @@ clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val, pO if (strcmp(attr_name, "name") == 0) { ClusterStatistics.GetValCalls_name++; - switch (driver_data->TargetType) + switch (target_type) { case TARGET_NODE: - val->String = ((pSourceData)driver_data->TargetData)->Name; + { + pSourceData source_data = check_ptr(driver_data->TargetData); + if (source_data == NULL) goto err; + ASSERTMAGIC(source_data, MGK_CL_SOURCE_DATA); + val->String = source_data->Name; break; + } case TARGET_CLUSTER: case TARGET_CLUSTER_ENTRY: - val->String = ((pClusterData)driver_data->TargetData)->Name; + { + pClusterData cluster_data = check_ptr(driver_data->TargetData); + if (cluster_data == NULL) goto err; + ASSERTMAGIC(cluster_data, MGK_CL_CLUSTER_DATA); + val->String = cluster_data->Name; break; + } case TARGET_SEARCH: case TARGET_SEARCH_ENTRY: - val->String = ((pSearchData)driver_data->TargetData)->Name; + { + pSearchData search_data = check_ptr(driver_data->TargetData); + if (search_data == NULL) goto err; + ASSERTMAGIC(search_data, MGK_CL_SEARCH_DATA); + val->String = search_data->Name; break; + } default: - mssErrorf(1, "Cluster", "Unknown target type %u.", driver_data->TargetType); + mssErrorf(1, "Cluster", "Unknown target type %u.", target_type); return -1; } @@ -3578,7 +3716,7 @@ clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val, pO /** Handle annotation. **/ if (strcmp(attr_name, "annotation") == 0) { - switch (driver_data->TargetType) + switch (target_type) { case TARGET_NODE: val->String = "Clustering driver."; break; case TARGET_CLUSTER: val->String = "Clustering driver: Cluster."; break; @@ -3587,7 +3725,7 @@ clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val, pO case TARGET_SEARCH_ENTRY: val->String = "Clustering driver: Cluster Entry."; break; default: - mssErrorf(1, "Cluster", "Unknown target type %u.", driver_data->TargetType); + mssErrorf(1, "Cluster", "Unknown target type %u.", target_type); return -1; } return 0; @@ -3607,7 +3745,7 @@ clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val, pO } if (strcmp(attr_name, "internal_type") == 0) { - switch (driver_data->TargetType) + switch (target_type) { case TARGET_NODE: val->String = "system/cluster"; break; case TARGET_CLUSTER: val->String = "cluster/cluster"; break; @@ -3615,7 +3753,7 @@ clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val, pO case TARGET_SEARCH: val->String = "cluster/search"; break; case TARGET_SEARCH_ENTRY: val->String = "search/entry"; break; default: - mssErrorf(1, "Cluster", "Unknown target type %u.", driver_data->TargetType); + mssErrorf(1, "Cluster", "Unknown target type %u.", target_type); return -1; } @@ -3625,10 +3763,10 @@ clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val, pO /** Last modification is not implemented. **/ if (strcmp(attr_name, "last_modification") == 0) { - if (driver_data->TargetType == TARGET_CLUSTER - || driver_data->TargetType == TARGET_CLUSTER_ENTRY - || driver_data->TargetType == TARGET_SEARCH - || driver_data->TargetType == TARGET_SEARCH_ENTRY) + if (target_type == TARGET_CLUSTER + || target_type == TARGET_CLUSTER_ENTRY + || target_type == TARGET_SEARCH + || target_type == TARGET_SEARCH_ENTRY) goto date_computed; else return 1; /* null */ } @@ -3636,7 +3774,7 @@ clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val, pO /** Handle date_created. **/ if (strcmp(attr_name, "date_created") == 0) { - switch (driver_data->TargetType) + switch (target_type) { case TARGET_NODE: /** Attribute is not defined for this target type. **/ @@ -3644,13 +3782,23 @@ clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val, pO case TARGET_CLUSTER: case TARGET_CLUSTER_ENTRY: - val->DateTime = &((pClusterData)driver_data->TargetData)->DateCreated; + { + pClusterData cluster_data = check_ptr(driver_data->TargetData); + if (cluster_data == NULL) goto err; + ASSERTMAGIC(cluster_data, MGK_CL_CLUSTER_DATA); + val->DateTime = &cluster_data->DateCreated; return 0; + } case TARGET_SEARCH: case TARGET_SEARCH_ENTRY: - val->DateTime = &((pSearchData)driver_data->TargetData)->DateCreated; + { + pSearchData search_data = check_ptr(driver_data->TargetData); + if (search_data == NULL) goto err; + ASSERTMAGIC(search_data, MGK_CL_SEARCH_DATA); + val->DateTime = &search_data->DateCreated; return 0; + } } return -1; } @@ -3659,7 +3807,7 @@ clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val, pO if (strcmp(attr_name, "date_computed") == 0) { date_computed: - switch (driver_data->TargetType) + switch (target_type) { case TARGET_NODE: /** Attribute is not defined for this target type. **/ @@ -3668,7 +3816,9 @@ clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val, pO case TARGET_CLUSTER: case TARGET_CLUSTER_ENTRY: { - pClusterData target = (pClusterData)driver_data->TargetData; + pClusterData target = check_ptr((pClusterData)driver_data->TargetData); + if (target == NULL) goto err; + ASSERTMAGIC(target, MGK_CL_CLUSTER_DATA); pDateTime date_time = &target->DateComputed; if (date_time->Value == 0) return 1; /* null */ else val->DateTime = date_time; @@ -3678,7 +3828,9 @@ clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val, pO case TARGET_SEARCH: case TARGET_SEARCH_ENTRY: { - pSearchData target = (pSearchData)driver_data->TargetData; + pSearchData target = check_ptr((pSearchData)driver_data->TargetData); + if (target == NULL) goto err; + ASSERTMAGIC(target, MGK_CL_SEARCH_DATA); pDateTime date_time = &target->DateComputed; if (date_time->Value == 0) return 1; /* null */ else val->DateTime = date_time; @@ -3687,37 +3839,43 @@ clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val, pO } /** Default: Unknown type. **/ - mssErrorf(1, "Cluster", "Unknown target type %u.", driver_data->TargetType); + mssErrorf(1, "Cluster", "Unknown target type %u.", target_type); return -1; } /** Handle attributes for specific data targets. **/ handle_targets: - switch (driver_data->TargetType) + switch (target_type) { case TARGET_NODE: + { + pSourceData source_data = check_ptr(driver_data->TargetData); + if (source_data == NULL) goto err; + ASSERTMAGIC(source_data, MGK_CL_SEARCH_DATA); + if (strcmp(attr_name, "source") == 0) { - /** TODO: THAT'S NOT A SOURCE DATA STRUCT!?!?!?!?!?!?!??!?!?!? */ - val->String = ((pSourceData)driver_data->TargetData)->SourcePath; - fprintf(stderr, "Got source: \"%s\"", val->String); + val->String = source_data->SourcePath; return 0; } if (strcmp(attr_name, "key_attr") == 0) { - val->String = ((pSourceData)driver_data->TargetData)->KeyAttr; + val->String = source_data->KeyAttr; return 0; } if (strcmp(attr_name, "name_attr") == 0) { - val->String = ((pSourceData)driver_data->TargetData)->NameAttr; + val->String = source_data->NameAttr; return 0; } break; + } case TARGET_CLUSTER: { - pClusterData target = (pClusterData)driver_data->TargetData; + pClusterData target = check_ptr(driver_data->TargetData); + if (target == NULL) goto err; + ASSERTMAGIC(target, MGK_CL_CLUSTER_DATA); if (strcmp(attr_name, "algorithm") == 0) { @@ -3753,7 +3911,9 @@ clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val, pO case TARGET_SEARCH: { - pSearchData target = (pSearchData)driver_data->TargetData; + pSearchData target = check_ptr(driver_data->TargetData); + if (target == NULL) goto err; + ASSERTMAGIC(target, MGK_CL_CLUSTER_DATA); if (strcmp(attr_name, "source") == 0) { @@ -3774,11 +3934,18 @@ clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val, pO case TARGET_CLUSTER_ENTRY: { - pClusterData target = (pClusterData)driver_data->TargetData; + pClusterData target = check_ptr(driver_data->TargetData); + if (target == NULL) goto err; + ASSERTMAGIC(target, MGK_CL_CLUSTER_DATA); pCluster target_cluster = &target->Clusters[driver_data->TargetIndex]; + ASSERTMAGIC(target_cluster, MGK_CL_CLUSTER); if (strcmp(attr_name, "items") == 0) { + /** Extract target strings (the result). **/ + char** target_strings = check_ptr(target_cluster->Strings); + if (target_strings == NULL) goto err; + /** Static variable to prevent leaking StringVec from previous calls. **/ static StringVec* vec = NULL; if (vec != NULL) nmFree(vec, sizeof(StringVec)); @@ -3787,7 +3954,7 @@ clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val, pO val->StringVec = vec = check_ptr(nmMalloc(sizeof(StringVec))); if (val->StringVec == NULL) return -1; val->StringVec->nStrings = target_cluster->Size; - val->StringVec->Strings = target_cluster->Strings; + val->StringVec->Strings = target_strings; /** Success. **/ return 0; @@ -3797,8 +3964,11 @@ clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val, pO case TARGET_SEARCH_ENTRY: { - pSearchData target = (pSearchData)driver_data->TargetData; - pDup target_dup = target->Dups[driver_data->TargetIndex]; + pSearchData target = check_ptr(driver_data->TargetData); + if (target == NULL) goto err; + ASSERTMAGIC(target, MGK_CL_SEARCH_DATA); + pDup target_dup = check_ptr(target->Dups[driver_data->TargetIndex]); + if (target_dup == NULL) goto err; if (strcmp(attr_name, "sim") == 0) { @@ -3822,18 +3992,21 @@ clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val, pO } default: - mssErrorf(1, "Cluster", "Unknown target type %u.", driver_data->TargetType); + mssErrorf(1, "Cluster", "Unknown target type %u.", target_type); return -1; } - /** Unknown attribute. **/ + unknown_attribute: + ci_UnknownAttribute(attr_name, driver_data->TargetType); + + err:; char* name; clusterGetAttrValue(inf_v, "name", DATA_T_STRING, POD(&name), NULL); mssErrorf(1, "Cluster", - "Unknown attribute '%s' for cluster object %s (target type: %u, \"%s\").", - attr_name, driver_data->NodeData->SourceData->Name, driver_data->TargetType, name + "Failed to get attribute for cluster object %s (target type: %u, \"%s\").", + driver_data->NodeData->SourceData->Name, target_type, name ); - + return -1; } @@ -3856,10 +4029,15 @@ clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val, pO pObjPresentationHints clusterPresentationHints(void* inf_v, char* attr_name, pObjTrxTree* oxt) { - pDriverData driver_data = (pDriverData)inf_v; pObjPresentationHints hints = NULL; pParamObjects tmp_list = NULL; + /** Extract target type from driver data. **/ + pDriverData driver_data = check_ptr(inf_v); + if (driver_data == NULL) goto err_free; + ASSERTMAGIC(driver_data, MGK_CL_DRIVER_DATA); + const TargetType target_type = driver_data->TargetType; + /** Malloc presentation hints struct. **/ hints = check_ptr(nmMalloc(sizeof(ObjPresentationHints))); if (hints == NULL) goto err_free; @@ -3902,10 +4080,10 @@ clusterPresentationHints(void* inf_v, char* attr_name, pObjTrxTree* oxt) if (strcmp(attr_name, "date_created") == 0 || strcmp(attr_name, "date_computed") == 0) { - if (driver_data->TargetType == TARGET_CLUSTER - || driver_data->TargetType == TARGET_CLUSTER_ENTRY - || driver_data->TargetType == TARGET_SEARCH - || driver_data->TargetType == TARGET_SEARCH_ENTRY) + if (target_type == TARGET_CLUSTER + || target_type == TARGET_CLUSTER_ENTRY + || target_type == TARGET_SEARCH + || target_type == TARGET_SEARCH_ENTRY) { hints->Length = 24; hints->VisualLength = 20; @@ -3916,7 +4094,7 @@ clusterPresentationHints(void* inf_v, char* attr_name, pObjTrxTree* oxt) } /** Search by target type. **/ - switch (driver_data->TargetType) + switch (target_type) { case TARGET_NODE: if (strcmp(attr_name, "source") == 0) @@ -4032,7 +4210,7 @@ clusterPresentationHints(void* inf_v, char* attr_name, pObjTrxTree* oxt) } /** End of overlapping region. **/ - if (driver_data->TargetType == TARGET_CLUSTER) break; + if (target_type == TARGET_CLUSTER) break; if (strcmp(attr_name, "source") == 0) { @@ -4057,8 +4235,10 @@ clusterPresentationHints(void* inf_v, char* attr_name, pObjTrxTree* oxt) case TARGET_CLUSTER_ENTRY: { - pClusterData target = (pClusterData)check_ptr(driver_data->TargetData); - if (target == NULL) goto err_free; + /** Unused. **/ + // pClusterData target = check_ptr(driver_data->TargetData); + // if (target == NULL) goto err_free; + // ASSERTMAGIC(target, MGK_CL_CLUSTER_DATA); if (strcmp(attr_name, "items") == 0) { @@ -4085,8 +4265,10 @@ clusterPresentationHints(void* inf_v, char* attr_name, pObjTrxTree* oxt) case TARGET_SEARCH_ENTRY: { - pSearchData target = (pSearchData)check_ptr(driver_data->TargetData); - if (target == NULL) goto err_free; + /** Unused. **/ + // pSearchData target = check_ptr(driver_data->TargetData); + // if (target == NULL) goto err_free; + // ASSERTMAGIC(target, MGK_CL_SEARCH_DATA); if (strcmp(attr_name, "key1") == 0) { @@ -4118,16 +4300,15 @@ clusterPresentationHints(void* inf_v, char* attr_name, pObjTrxTree* oxt) } default: - mssErrorf(1, "Cluster", "Unknown target type %u.", driver_data->TargetType); + mssErrorf(1, "Cluster", "Unknown target type %u.", target_type); goto err_free; } - /** Unknown attribute. **/ - unknown_attribute:; - mssErrorf(1, "Cluster", "Unknown attribute '%s'.", attr_name); + unknown_attribute: + ci_UnknownAttribute(attr_name, driver_data->TargetType); - /** Error cleanup. **/ err_free: + /** Error cleanup. **/ if (hints != NULL) nmFree(hints, sizeof(ObjPresentationHints)); hints = NULL; @@ -4161,8 +4342,9 @@ clusterPresentationHints(void* inf_v, char* attr_name, pObjTrxTree* oxt) char* clusterGetFirstAttr(void* inf_v, pObjTrxTree* oxt) { - pDriverData driver_data = (pDriverData)inf_v; - + pDriverData driver_data = (pDriverData)inf_v; + ASSERTMAGIC(driver_data, MGK_CL_DRIVER_DATA); + driver_data->TargetAttrIndex = 0u; return clusterGetNextAttr(inf_v, oxt); @@ -4182,7 +4364,8 @@ clusterGetFirstAttr(void* inf_v, pObjTrxTree* oxt) char* clusterGetNextAttr(void* inf_v, pObjTrxTree* oxt) { - pDriverData driver_data = (pDriverData)inf_v; + pDriverData driver_data = (pDriverData)inf_v; + ASSERTMAGIC(driver_data, MGK_CL_DRIVER_DATA); const unsigned int i = driver_data->TargetAttrIndex++; switch (driver_data->TargetType) @@ -4212,8 +4395,10 @@ clusterGetNextAttr(void* inf_v, pObjTrxTree* oxt) int clusterInfo(void* inf_v, pObjectInfo info) { - pDriverData driver_data = (pDriverData)inf_v; - pNodeData node_data = (pNodeData)driver_data->NodeData; + pDriverData driver_data = (pDriverData)inf_v; + ASSERTMAGIC(driver_data, MGK_CL_DRIVER_DATA); + pNodeData node_data = (pNodeData)driver_data->NodeData; + ASSERTMAGIC(node_data, MGK_CL_NODE_DATA); /** Reset flags buffer. **/ info->Flags = 0; @@ -4299,8 +4484,9 @@ clusterInfo(void* inf_v, pObjectInfo info) char* clusterGetFirstMethod(void* inf_v, pObjTrxTree* oxt) { - pDriverData driver_data = (pDriverData)inf_v; - + pDriverData driver_data = (pDriverData)inf_v; + ASSERTMAGIC(driver_data, MGK_CL_DRIVER_DATA); + driver_data->TargetMethodIndex = 0u; return clusterGetNextMethod(inf_v, oxt); @@ -4320,7 +4506,8 @@ clusterGetFirstMethod(void* inf_v, pObjTrxTree* oxt) char* clusterGetNextMethod(void* inf_v, pObjTrxTree* oxt) { - pDriverData driver_data = (pDriverData)inf_v; + pDriverData driver_data = (pDriverData)inf_v; + ASSERTMAGIC(driver_data, MGK_CL_DRIVER_DATA); return METHOD_NAMES[driver_data->TargetMethodIndex++]; } @@ -4488,7 +4675,8 @@ ci_CacheFreeSearch(pXHashEntry entry, void* path) int clusterExecuteMethod(void* inf_v, char* method_name, pObjData param, pObjTrxTree* oxt) { - pDriverData driver_data = (pDriverData)inf_v; + pDriverData driver_data = (pDriverData)inf_v; + ASSERTMAGIC(driver_data, MGK_CL_DRIVER_DATA); /** Cache management method. **/ if (strcmp(method_name, "cache") == 0) From 495597e8567d21d8904636290c981ae9ea015a22 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Thu, 8 Jan 2026 11:15:56 -0700 Subject: [PATCH 043/275] Fix a broken test by increasing the tolerance for reasonable deviations. --- centrallix/tests/test_cos_compare_00.to | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/centrallix/tests/test_cos_compare_00.to b/centrallix/tests/test_cos_compare_00.to index c5b0b1a5b..f6a635389 100644 --- a/centrallix/tests/test_cos_compare_00.to +++ b/centrallix/tests/test_cos_compare_00.to @@ -9,16 +9,16 @@ query select case4 = condition((cos_compare('hello there', 'hellow there') >= 0. # Tests on fabricated contact information. # All email addresses and phone numbers are imaginary and were fabricated for the purposes of this test -query select cynthia = condition((cos_compare("Cynthia Adams; cynthiaadams@gmail.com; 720-769-1293", "Timothy Adams; thetbear@gmail.com; 720-891-1470") >= 0.49) and (cos_compare("Cynthia Adams; cynthiaadams@gmail.com; 720-769-1293", "Timothy Adams; thetbear@gmail.com; 720-891-1470") <= 0.54), "pass", "fail") +query select cynthia = condition((cos_compare("Cynthia Adams; cynthiaadams@gmail.com; 720-769-1293", "Timothy Adams; thetbear@gmail.com; 720-891-1470") >= 0.45) and (cos_compare("Cynthia Adams; cynthiaadams@gmail.com; 720-769-1293", "Timothy Adams; thetbear@gmail.com; 720-891-1470") <= 0.59), "pass", "fail") -query select timothy = condition((cos_compare("Timothy Adams; thetbear@gmail.com; 720-891-1470", "Lance Freson; lancetheturtle@gmail.com; 720-111-8189") >= 0.45) and (cos_compare("Timothy Adams; thetbear@gmail.com; 720-891-1470", "Lance Freson; lancetheturtle@gmail.com; 720-111-8189") <= 0.50), "pass", "fail") +query select timothy = condition((cos_compare("Timothy Adams; thetbear@gmail.com; 720-891-1470", "Lance Freson; lancetheturtle@gmail.com; 720-111-8189") >= 0.40) and (cos_compare("Timothy Adams; thetbear@gmail.com; 720-891-1470", "Lance Freson; lancetheturtle@gmail.com; 720-111-8189") <= 0.55), "pass", "fail") -query select lance = condition((cos_compare("Lance Freson; lancetheturtle@gmail.com; 720-111-8189", "Gregory Freson; greatgregory@gmail.com; 720-198-5791") >= 0.425) and (cos_compare("Lance Freson; lancetheturtle@gmail.com; 720-111-8189", "Gregory Freson; greatgregory@gmail.com; 720-198-5791") <= 0.475), "pass", "fail") +query select lance = condition((cos_compare("Lance Freson; lancetheturtle@gmail.com; 720-111-8189", "Gregory Freson; greatgregory@gmail.com; 720-198-5791") >= 0.4) and (cos_compare("Lance Freson; lancetheturtle@gmail.com; 720-111-8189", "Gregory Freson; greatgregory@gmail.com; 720-198-5791") <= 0.5), "pass", "fail") query select gregory = condition((cos_compare("Gregory Freson; greatgregory@gmail.com; 720-198-5791", "Gregory Freson; greatgregory@gmail.co; 720-198-5791") >= 0.94) and (cos_compare("Gregory Freson; greatgregory@gmail.com; 720-198-5791", "Gregory Freson; greatgregory@gmail.co; 720-198-5791") <= 0.99), "pass", "fail") -query select nathan = condition((cos_compare("Nathan Mayor; nmmayor@yahoo.com; +1-800-192-9128", "Mindy Mayor; nmmayor@yahoo.com; 720-981-9149") >= 0.575) and (cos_compare("Nathan Mayor; nmmayor@yahoo.com; +1-800-192-9128", "Mindy Mayor; nmmayor@yahoo.com; 720-981-9149") <= 0.625), "pass", "fail") +query select nathan = condition((cos_compare("Nathan Mayor; nmmayor@yahoo.com; +1-800-192-9128", "Mindy Mayor; nmmayor@yahoo.com; 720-981-9149") >= 0.6) and (cos_compare("Nathan Mayor; nmmayor@yahoo.com; +1-800-192-9128", "Mindy Mayor; nmmayor@yahoo.com; 720-981-9149") <= 0.7), "pass", "fail") query select identical = condition((cos_compare("This is an identical case", "This is an identical case") >= 0.975) and (cos_compare("This is an identical case", "This is an identical case") <= 1.00), "pass", "fail") -query select name = condition((cos_compare("Samuel", "Alex") >= 0.00) and (cos_compare("Samuel", "Alex") <= 0.025), "pass", "fail") +query select name = condition((cos_compare("Samuel", "Alex") >= 0.00) and (cos_compare("Samuel", "Alex") <= 0.05), "pass", "fail") From ab71333d202ec83687786d25fbe132c1058625f3 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Wed, 28 Jan 2026 12:58:18 -0700 Subject: [PATCH 044/275] Compile tests with -lm to prevent sporadic linker errors. --- centrallix-lib/Makefile.in | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/centrallix-lib/Makefile.in b/centrallix-lib/Makefile.in index 0daf7e568..91b670e83 100644 --- a/centrallix-lib/Makefile.in +++ b/centrallix-lib/Makefile.in @@ -59,7 +59,7 @@ LIBS = @LIBS@ ## PROFILE=@PROFILE@ COVERAGE=@COVERAGE@ -CFLAGS=@CFLAGS@ @DEFS@ -Iinclude -DCXLIB_INTERNAL -DNM_USE_SYSMALLOC -Wall $(PROFILE) $(COVERAGE) -g +CFLAGS=@CFLAGS@ @DEFS@ -Iinclude -DCXLIB_INTERNAL -DNM_USE_SYSMALLOC -Wall $(PROFILE) $(COVERAGE) -g -lm MTCFLAGS=@CFLAGS@ @DEFS@ -Iinclude -DCXLIB_INTERNAL -DNM_USE_SYSMALLOC -Wall $(PROFILE) $(COVERAGE) -g -O0 TCFLAGS=$(patsubst -DNDEBUG,,$(CFLAGS)) From 65e4458e1a8110d359cc311d514f3ad657bd03e2 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Wed, 28 Jan 2026 13:00:10 -0700 Subject: [PATCH 045/275] Fix a critical driver bug causing levenshtein to be executed on the cosine vectors instead of the data strings. Clean up driver code to make it more readable. --- centrallix/osdrivers/objdrv_cluster.c | 105 +++++++++++++++++--------- 1 file changed, 70 insertions(+), 35 deletions(-) diff --git a/centrallix/osdrivers/objdrv_cluster.c b/centrallix/osdrivers/objdrv_cluster.c index f22449ec6..62df6007e 100644 --- a/centrallix/osdrivers/objdrv_cluster.c +++ b/centrallix/osdrivers/objdrv_cluster.c @@ -260,6 +260,32 @@ ci_SimilarityMeasureToString(SimilarityMeasure similarity_measure) return NULL; /** Unreachable. **/ } +/*** Converts a similarity measure to the function pointer to a comparison + *** function. This function can be used to compute similarity between two + *** values, or it can be passed to `clusters.c` which uses it for similar + *** operations. + *** + *** @param similarity_measure The similarity measure to be converted. + *** @returns A similarity computation function. This function takes two void + *** pointers, representing the data to be compared, and a double that + *** represents how similar the data is. Or returns NULL if an error occurs, + *** calling mssError() to provide an error message. + ***/ +double (*ci_SimilarityMeasureToFunction(SimilarityMeasure similarity_measure))(void*, void*) + { + switch (similarity_measure) + { + case SIMILARITY_COSINE: return ca_cos_compare; + case SIMILARITY_LEVENSHTEIN: return ca_lev_compare; + default: + mssErrorf(1, "Cluster", + "Unknown similarity meansure \"%s\".", + ci_SimilarityMeasureToString(similarity_measure) + ); + return NULL; + } + } + /*** Enum representing the type of data targetted by the driver, *** set based on the path given when the driver is used to open *** a cluster file. @@ -2605,8 +2631,8 @@ ci_ComputeSourceData(pSourceData source_data, pObjSession session) static int ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data) { - cluster_data->Sims = NULL; - cluster_data->Clusters = NULL; + size_t clusters_size = -1; + size_t sims_size = -1; /** Guard segfaults. **/ if (cluster_data == NULL || node_data == NULL) return -1; @@ -2640,8 +2666,8 @@ ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data) if (!check(objCurrentDate(&cluster_data->DateComputed))) goto err_free; /** Allocate static memory for finding clusters. **/ - const size_t clusters_size = cluster_data->nClusters * sizeof(Cluster); - const size_t sims_size = source_data->nVectors * sizeof(double); + clusters_size = cluster_data->nClusters * sizeof(Cluster); + sims_size = source_data->nVectors * sizeof(double); cluster_data->Clusters = check_ptr(nmSysMalloc(clusters_size)); cluster_data->Sims = check_ptr(nmSysMalloc(sims_size)); if (cluster_data->Clusters == NULL) goto err_free; @@ -2770,8 +2796,8 @@ ci_ComputeClusterData(pClusterData cluster_data, pNodeData node_data) for (unsigned int i = 0u; i < cluster_data->nClusters; i++) { /*** NOTE: The clusters here do not need to each be freed - *** individually because they are part of the dynamically - *** allocated Clusters array (freed after the loop). + *** individually because the structs themselves are stored + *** directly in the cluster_data->Clusters array. *** Thus, this loop only frees each cluster's content. ***/ pCluster cluster = &cluster_data->Clusters[i]; @@ -2836,29 +2862,8 @@ ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) /** Record the date and time. **/ if (!check(objCurrentDate(&search_data->DateComputed))) goto err_free; - /** Select the correct comparison function based on the similarity measure. **/ - const double (*similarity_function)(void *, void *); - char* similarity_function_name; - switch (search_data->SimilarityMeasure) - { - case SIMILARITY_COSINE: - similarity_function = ca_cos_compare; - similarity_function_name = "cosine"; - break; - - case SIMILARITY_LEVENSHTEIN: - similarity_function = ca_lev_compare; - similarity_function_name = "Levenstein"; - break; - - default: - mssErrorf(1, "Cluster", - "Unknown similarity meansure \"%s\".", - ci_SimilarityMeasureToString(search_data->SimilarityMeasure) - ); - goto err_free; - } - + /** Get the comparison function based on the similarity measure. **/ + const double (*similarity_function)(void *, void *) = ci_SimilarityMeasureToFunction(search_data->SimilarityMeasure); /** Execute the search using the specified algorithm. **/ pXArray dups_temp = NULL; @@ -2868,9 +2873,23 @@ ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) *** was computed during the clustering phase. ***/ + /** Get a pointer to the data that will be used for the search. **/ + void** data = NULL; + switch (search_data->SimilarityMeasure) + { + case SIMILARITY_COSINE: data = (void**)source_data->Vectors; break; + case SIMILARITY_LEVENSHTEIN: data = (void**)source_data->Strings; break; + default: + mssErrorf(1, "Cluster", + "Unknown similarity meansure \"%s\".", + ci_SimilarityMeasureToString(search_data->SimilarityMeasure) + ); + goto err_free; + } + /** Execute sliding search. **/ dups_temp = check_ptr(ca_sliding_search( - (void**)source_data->Vectors, + data, source_data->nVectors, cluster_data->MaxIterations, /* Window size. */ similarity_function, @@ -2882,7 +2901,7 @@ ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) { mssErrorf(1, "Cluster", "Failed to compute sliding search with %s similarity measure.", - similarity_function_name + ci_SimilarityMeasureToString(search_data->SimilarityMeasure) ); goto err_free; } @@ -2893,11 +2912,25 @@ ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) { /** Extract the struct for the cluster. **/ pCluster cluster = &cluster_data->Clusters[i]; - // ASSERTMAGIC(cluster, MGK_CL_CLUSTER); + ASSERTMAGIC(cluster, MGK_CL_CLUSTER); + + /** Get a pointer to the data that will be used for the search. **/ + void** data = NULL; + switch (search_data->SimilarityMeasure) + { + case SIMILARITY_COSINE: data = (void**)cluster->Vectors; break; + case SIMILARITY_LEVENSHTEIN: data = (void**)cluster->Strings; break; + default: + mssErrorf(1, "Cluster", + "Unknown similarity meansure \"%s\".", + ci_SimilarityMeasureToString(search_data->SimilarityMeasure) + ); + goto err_free; + } /** Execute complete search. **/ dups_temp = check_ptr(ca_complete_search( - (void**)cluster->Vectors, + data, cluster->Size, similarity_function, search_data->Threshold, @@ -2908,7 +2941,7 @@ ci_ComputeSearchData(pSearchData search_data, pNodeData node_data) { mssErrorf(1, "Cluster", "Failed to compute complete search with %s similarity measure.", - similarity_function_name + ci_SimilarityMeasureToString(search_data->SimilarityMeasure) ); goto err_free; } @@ -3637,11 +3670,13 @@ clusterGetAttrType(void* inf_v, char* attr_name, pObjTrxTree* oxt) int clusterGetAttrValue(void* inf_v, char* attr_name, int datatype, pObjData val, pObjTrxTree* oxt) { + TargetType target_type = -1; + /** Extract target type from driver data. **/ pDriverData driver_data = check_ptr(inf_v); if (driver_data == NULL) goto err; ASSERTMAGIC(driver_data, MGK_CL_DRIVER_DATA); - const TargetType target_type = driver_data->TargetType; + target_type = driver_data->TargetType; /** Update statistics. **/ ClusterStatistics.GetValCalls++; From 8ba449eff3b7c5ba359f19b0cb497d5125f27593 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Wed, 28 Jan 2026 14:47:28 -0700 Subject: [PATCH 046/275] Fix a major bug where punctuation and whitespace was not properly ignored during cosine vector creation. Improve edge case handling in clusters.c. --- centrallix-lib/src/clusters.c | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/centrallix-lib/src/clusters.c b/centrallix-lib/src/clusters.c index 652d5571c..4e0910352 100644 --- a/centrallix-lib/src/clusters.c +++ b/centrallix-lib/src/clusters.c @@ -163,7 +163,7 @@ ca_build_vector(const char* str) unsigned char c = (unsigned char)maybe_char; /** Always consider boundary character in string. **/ - if (c != CA_BOUNDARY_CHAR) goto skip_checks; + if (c == CA_BOUNDARY_CHAR) goto skip_checks; /** Ignore insignificant characters: spaces and punctuation. **/ if (isspace(c)) continue; /* space, \n, \v, \f, \r */ @@ -303,6 +303,12 @@ ca_sparse_len(const pVector vector) void ca_print_vector(const pVector vector) { + if (vector == NULL) + { + printf("Vector: NULL"); + return; + } + const unsigned int len = ca_sparse_len(vector); printf("Vector: [%d", vector[0]); for (unsigned int i = 1u; i < len; i++) @@ -654,7 +660,8 @@ ca_lev_compare(void* str1, void* str2) return round(normalized_similarity * 1000000.0) / 1000000.0; } -/*** Check if two sparse vectors are identical. +/*** Check if two sparse vectors are identical. True if both vectors are + *** `NULL`, but false if one is and the other is not. *** *** @param v1 The first vector. *** @param v2 The second vector. @@ -664,8 +671,11 @@ ca_lev_compare(void* str1, void* str2) bool ca_eql(pVector v1, pVector v2) { - const unsigned int len = ca_sparse_len(v1); + /** Edge cases. **/ + if (v1 == v2) return true; + if (v1 == NULL || v2 == NULL) return false; + const unsigned int len = ca_sparse_len(v1); for (unsigned int i = 0u; i < len; i++) if (v1[i] != v2[i]) return false; From 2be1d2264a1d52c542479cb90c9b0f4b13a489ab Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Fri, 30 Jan 2026 15:15:36 -0700 Subject: [PATCH 047/275] Remove a broken link in clusters.h. Add CommentAnchorsExtension.md to document the use of the comment anchors VSCode extension. Add comment anchors support to string_similarity.md. Add a new known issue to string_similarity.md. --- centrallix-lib/include/clusters.h | 4 +- centrallix-lib/src/clusters.c | 5 +- centrallix-sysdoc/CommentAnchorsExtension.md | 96 ++++++++++++++++++++ centrallix-sysdoc/string_similarity.md | 43 +++++---- centrallix/osdrivers/objdrv_cluster.c | 17 +--- 5 files changed, 129 insertions(+), 36 deletions(-) create mode 100644 centrallix-sysdoc/CommentAnchorsExtension.md diff --git a/centrallix-lib/include/clusters.h b/centrallix-lib/include/clusters.h index 288f1c2c5..fd94d0be2 100644 --- a/centrallix-lib/include/clusters.h +++ b/centrallix-lib/include/clusters.h @@ -44,6 +44,9 @@ #include "cxlib/xarray.h" #endif +/** This file has additional documentation in string_similarity.md. **/ + + /*** This value defines the number of dimensions used for a sparse *** vector. The higher the number, the fewer collisions will be *** encountered when using these vectors for cosine comparisons. @@ -63,7 +66,6 @@ ***/ #define CA_NUM_DIMS 251 -/// LINK ../../centrallix-sysdoc/string_comparison.md#cosine_charsets /** The character used to create a pair with the first and last characters of a string. **/ #define CA_BOUNDARY_CHAR (unsigned char)('a' - 1) diff --git a/centrallix-lib/src/clusters.c b/centrallix-lib/src/clusters.c index 4e0910352..88b1bf318 100644 --- a/centrallix-lib/src/clusters.c +++ b/centrallix-lib/src/clusters.c @@ -32,8 +32,6 @@ /* string-similarity.md in the centrallix-sysdoc folder. */ /************************************************************************/ -/** This file has additional documentation in string_similarity.md. **/ - #include #include #include @@ -49,6 +47,9 @@ #include "util.h" #include "xarray.h" +/** This file has additional documentation in string_similarity.md. **/ + + /*** Gets the hash, representing a pair of ASCII characters, represented by unsigned ints. *** Thank you to professor John Delano for this hashing algorithm. *** diff --git a/centrallix-sysdoc/CommentAnchorsExtension.md b/centrallix-sysdoc/CommentAnchorsExtension.md new file mode 100644 index 000000000..397e5fa92 --- /dev/null +++ b/centrallix-sysdoc/CommentAnchorsExtension.md @@ -0,0 +1,96 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +# The Comment Anchors Extension +A couple of files in Centrallix use the [Comment Anchors VSCode extension](https://marketplace.visualstudio.com/items?itemName=ExodiusStudios.comment-anchors) from Starlane Studios. This extension allows developers to use certain text in comments to create links to other files, or other locations within the same file. This extension is _optional_ and developing in Centrallix without it is fine. If you don't intend to use it, you can safely ignore `LINK`, `ANCHOR`, and similar comments intended for it, although please try not to break them. + + +## Table of Contents +- [The Comment Anchors Extension](#the-comment-anchors-extension) + - [Table of Contents](#table-of-contents) + - [Basic Features](#basic-features) + - [Links](#links) + - [Anchors](#anchors) + - [Quick Warning](#quick-warning) + - [Informing other developers](#informing-other-developers) + + +## Basic Features +Below is a quick summary of the primary features from the extension that are used in Centrallix. This is intended to help get developers up to speed easily without needing to sift through other features that aren't currently in use. + +_For more information, visit the [extension page](https://marketplace.visualstudio.com/items?itemName=ExodiusStudios.comment-anchors)._ + + +### Links +Create a link by writing `LINK ` at the start of a line in a documentation comment. Control click the link to jump to the destination in the editor. A link might look like: +```c +/*** To read the license, click the link below: + *** LINK LICENSE + ***/ +``` +- Use `:line-number` to link to a specific line number. +- Use `#` to link to an [anchor](#anchors) with that id. +- Intra-file links don't need to specify a file (e.g. `LINK #example`). + +Note: Invalid or broken links to a location in a file will sometimes default to the first line of the file. + + +### Anchors +Create an anchor by writing `ANCHOR[id=]` at the start of a line in a documentation comment, like this: +```c +/*** ANCHOR[id=intro] + *** This file will teach you how to never write a memory error in C ever again... + ***/ +``` +Add `#ID` to the end of a link to target the anchor with that ID (useful for navigating long files, such as `objdrv_cluster.c`). + + +## Quick Warning +The comment anchors extension is a little less robust than I would like. Sometimes, placing characters before or after links or anchors on the same line will cause them to break. The extension is sometimes a little finicky. + + +## Informing other developers +When using the comment anchors extension, include something closely resembling the following snippet at the top of the file, just below the copywrite notice and include statements: + +**.c or .h file** +```c +/*** This file uses the optional Comment Anchors VSCode extension, documented + *** with CommentAnchorsExtension.md in centrallix-sysdoc. + ***/ +``` + +**.md file** +```md + +``` \ No newline at end of file diff --git a/centrallix-sysdoc/string_similarity.md b/centrallix-sysdoc/string_similarity.md index b6c96e8a2..310a5c2f2 100644 --- a/centrallix-sysdoc/string_similarity.md +++ b/centrallix-sysdoc/string_similarity.md @@ -30,12 +30,16 @@ + + -# String Similarity -The following sections discuss the approaches to calculating similarity between two strings using the `clusters.c` library. This library can be included using `#include "cxlib/clusters.h"` in the centrallix codebase (use `#include "clusters.h"` in other libaries in centrallix-lib). +# String Similarity +The following sections discuss the approaches to calculating similarity between two strings using the `clusters.c` library. This library can be included using `#include "cxlib/clusters.h"` in the centrallix codebase (use `#include "clusters.h"` in other libaries in centrallix-lib). -## Table of Contents +## Table of Contents - [String Comparison](#string-comparison) - [Table of Contents](#table-of-contents) - [Cosine Similarity](#cosine-similarity) @@ -54,12 +58,14 @@ The following sections discuss the approaches to calculating similarity between - [Future Implementation](#future-implementation) - [K-means Fuzzy Clustering](#k-means-fuzzy-clusterings) - [Implement Missing Algorithms](#implement-missing-algorithms) + - [Upgrade Other Duplicate Detection Systems](#upgrade-other-duplicate-detection-systems) + - [Fix Known Issues](#fix-known-issues) -## Cosine Similarity +## Cosine Similarity The [Cosine Similarity](https://en.wikipedia.org/wiki/Cosine_similarity) function is defined as the dot product of two vectors divided by the product of the magnitude of the two vectors. Conceptually, it's like finding the _angle_ between two vectors. To get these vectors, we use the relative frequency of character pairs within each string. To reduce memory cost and speed up computation, we store them in a special sparsely allocated form, described below. -### Character Sets +### Character Sets Cosine compare currently uses the following character sets. These can be extended or modified later, if necessary. ```c const char ALLOW_SET[] = " \n\v\f\r!#$%&\"'()*+,-./:;<=>?@[]^_{|}~ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789"; @@ -77,35 +83,35 @@ const char BOUNDARY_CHAR = ('a' - 1); // aka. '`' - This character appears to have been selected to be one before the first character in `CHAR_SET` (thus convention dictates that it be written `'a' - 1` to indicate this), although it's unknown if that's the main or only reason. - If `clusters.h` is included, it can be accessed using the `CA_BOUNDARY_CHAR` macro. -### Character Pair Hashing +### Character Pair Hashing Even with a small set of ASCII characters (say 36), there are still `36^2 = 1296` possible character pairs. If the number of characters in the `CHAR_SET` ever needed to be expanded - for example, to include all UTF-8 characters - this number would quickly explode exponentially to utterly infeasible proportions. Thus, a hashing algorithm is employed to hash each character pair down to a more reasonable number of dimensions (which can be accessed with the `CA_NUM_DIMS` macro). -### String Vectors +### String Vectors Any string of characters in the `ALLOW_SET` can be represented by a vector. For simplicity, imagine this vector has only `5` dimensions. To find this vector, we hash each character pair in the string. As each character pair is hashed (for example, that the pair "ab" happens to hash to `3`), the corresponding dimension is increased by some amount. This amount varies to based on the characters in the pair, helping to mitigate the impact of collisions where different character pairs hash to identical numbers (a larger number of dimensions also helps to mitigate this). Remember that the first and last characters form a pair with the `BOUNDARY_CHAR`, so the string "ab" has three pairs: "a", "ab", and "b". If these each hash to `2`, `3`, and `0`. Thus, the vector generated by the string "ab" might be: `[7, 0, 4, 3, 0]`. Notice that dimensions #1 and #4 are both `0` because no character pairs generated a hash of `1` or `4`. In real usecases, the vast majority of elements are `0`s because the number of dimensions used is much larger than the number of character pairs in a typical string. -### Sparse Vectors +### Sparse Vectors As noted above, the vast majority of elements in a vector generated by a typical string are `0`s. This would lead to a large waste of memory and computation if every `0` was stored separately, so instead, vectors are stored sparsely. Because all hashes are positive integers, we represent `n` `0`s with a value of ` -n`. Thus, the vector `[0, 1, 0, 0, 0]` (representing an empty string in `5` dimensions) would be represented sparsely as `[-1, 1, -3]`. **Note**: A value of `0` in a sparse vector is undefined, so no element should be equal to `0`. **Note**: Sparse arrays can vary greatly in length. To find their size, one needs to traverse the array until the total number of values found adds up to `CA_NUM_DIMS`. The `ca_sparse_len()` function can be used to do this. Also, the `ca_build_vector()` and `ca_free_vector()` use the `nmSys` functions from `newmalloc.h` to avoid conflicts over the size of the allocated data. -### Computing Similarity +### Computing Similarity Finally, to find the cosine similarity between two strings, we can simply take the [dot product](https://en.wikipedia.org/wiki/Dot_product) of their coresponding vectors. Then, we normalize the dot product by dividing by the magnitudes of both vectors multiplied together. Two strings can be compared this way using the `ca_cos_compare()` function. -## Levenshtein Similarity +## Levenshtein Similarity The [Levenshtein](https://en.wikipedia.org/wiki/Levenshtein_distance) distance is defined as the number of insertions, deletions, or substitutions required to make one string exactly like another string. The version implemented in `clusters.c` additionally allows a new operation called a "swap" in which two adjacent characters change places. Transpositions of larger pieces of text are, unfortunately, not handled as well, which is a potential downfall of using levenshtein edit distance. The levenshtein similarity of two strings can be compared using the `ca_lev_compare()` function. -## Clustering +## Clustering When searching for similar strings in a large amount of data (for example, `1,000,000` strings), comparing every string to every other string can be very computationally expensive. To speed up this process, it is helpful to _cluster_ similar strings together, then only compare strings within similar clusters. This sacrifices some accuracy to allow large amounts of data to be searched and compared in a feasible amount of time. -### K-means Clustering +### K-means Clustering When clustering data using the [k-means](https://en.wikipedia.org/wiki/K-means_clustering) algorithm, data is divided into a predefined number of clusters with the goal of maximizing the average similarity of data points within any given cluster. To quickly summarize the algorithm: 1. Randomly select `k` data points to be the initial centroids of each cluster. 2. For each data point, find the centroid it is most similar to, and assign it to that cluster. @@ -116,18 +122,18 @@ The implementation used in `clusters.c` also allows the programmer to specify a The `ca_kmeans()` function can be invoked using [the cosine comparison string vectors](#string-vectors) (see above) to cluster them into similar clusters. -### K-means++ Clustering +### K-means++ Clustering **Not yet implemented** This method is largely identical to k-means, except that [k-means++](https://en.wikipedia.org/wiki/K-means%2B%2B) assigns the initial centroids using an approximate algorithm designed to avoid some of the poor clustering possible with random assignment. -### K-medoids Clustering +### K-medoids Clustering **Not yet implemented** This method is also very similar to k-means, except that [k-medoids](https://en.wikipedia.org/wiki/K-medoids) places an additional requirement that all centroids be points in the data. This would theoretically allow for other similarity measures (such as Levenshtein edit distance) to be used for clustering instead of only cosine compare. -### DB-Scan +### DB-Scan **Proposed, not yet implemented or documented** -### Sliding Clusters +### Sliding Clusters A far more basic method of "clustering" is to simply sort all data alphabetically, then, instead of comparing each string to all other strings, it can be compared to only the next `n` strings. Of course, differences near the start of a string (for example, "fox" vs. "box") will cause those strings to sort far away from each other, leading them to be completely missed. Sorting using a similarity measure, such as `ca_cos_compare()` or `ca_lev_compare()` would resolve this issue. However, these comparison functions do not meet the transitivity requirement for sorting, which is that `(A < B) & (B < C) -> (A < C)`. For example, "car" is similar to "boxcar", which is also similar to "box". However, "car" and "box" are not similar at all. @@ -152,6 +158,7 @@ Several algorithms (such as [k-means++](#k-means-clustering-1), [k-medoids](#k-m ### Upgrade Other Duplicate Detection Systems When a new record is entered, a quick scan is run to check if it might be a duplicate. There is also a button in the UI for a record that lets you run a duplicate check. These systems could also be upgraded using the new algorithms and strategies developed for general duplicate detection. -### Known Issues +### Fix Known Issues - The cluster driver often fails to open the structure file if it was modifed since the last time the path was openned. Opening a different path (including the root path, even though it does not support queries) fixes this issue. This is either a bug in the st_node caching or in the cluster driver's usage of stparse. -- The cluster does not invalidate caches if the underlying data source changes. This bug exists because I wasn't sure how to do this, but I'm pretty sure it's possible. Workaround: Developers should use `exec "cache" "drop_all"` to invalidate caches when data is changed, or use a fresh object system instance. +- The cluster does not invalidate caches if the underlying data source changes. This bug exists because I wasn't sure how to do this, but I'm pretty sure it's possible. Workaround: Developers should use `exec "cache" "drop_all"` to manually invalidate caches when data is changed, or use a fresh object system instance. +- It is not possible to open cluster or search entries, they can only be retrieved by querying. diff --git a/centrallix/osdrivers/objdrv_cluster.c b/centrallix/osdrivers/objdrv_cluster.c index 62df6007e..10abd473e 100644 --- a/centrallix/osdrivers/objdrv_cluster.c +++ b/centrallix/osdrivers/objdrv_cluster.c @@ -53,21 +53,8 @@ #include "st_node.h" #include "stparse.h" -/*** File notes: - *** This file uses comment anchors, provided by the Comment Anchors VSCode - *** extension from Starlane Studios. This allows developers with the extension - *** to control click the "LINK " comments to navigate to the coresponding - *** "ANCHOR[id=]" comment. (Note: Invalid or broken links will default to - *** the first line of the file.) - *** - *** For example, this link should take you to the function signatures: - *** LINK #functions - *** - *** Any developers without this extension can safely ignore these comments, - *** although please try not to break them. :) - *** - *** Comment Anchors VSCode Extension: - *** https://marketplace.visualstudio.com/items?itemName=ExodiusStudios.comment-anchors +/*** This file uses the optional Comment Anchors VSCode extension, documented + *** with CommentAnchorsExtension.md in centrallix-sysdoc. ***/ /** Defaults for unspecified optional attributes. **/ From ba20cc940460b324d422a902a6f3316de428b2ba Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Thu, 26 Jun 2025 17:19:13 -0600 Subject: [PATCH 048/275] Update apos docs and code comments. --- centrallix/include/apos.h | 19 +- centrallix/wgtr/apos.c | 568 +++++++++++++++++++++++++++++++------- 2 files changed, 479 insertions(+), 108 deletions(-) diff --git a/centrallix/include/apos.h b/centrallix/include/apos.h index a40d3d26d..36f5e1ee4 100644 --- a/centrallix/include/apos.h +++ b/centrallix/include/apos.h @@ -115,23 +115,32 @@ int aposSpaceOutLines(pXArray, pXArray, int); /**Adjusts spaces between lines to int aposSnapWidgetsToGrid(pXArray, int); /**Refreshes widget dimensions to match adjusted grid**/ int aposProcessWindows(pWgtrNode, pWgtrNode); /**Makes a pass through the tree to process windows**/ -/** # defines **/ +/** # defines names for magic values to make them easier to read. **/ + +/** Indicates how a line links to a widget. */ #define APOS_SWIDGETS 1 #define APOS_EWIDGETS 2 +/*** Indicates if a section or line is a row (horizontal) or a column (vertical). + *** A row spans horizontally between two vertical lines, and a column spans + *** vertically between two horizontal lines. + ***/ #define APOS_ROW 1 #define APOS_COL 2 #define APOS_FUDGEFACTOR 0.5 -/** The greatest width between two widgets that still defines them as "adjacent," -*** indicating that we don't want to increase the distance between them **/ +/*** The greatest width between two widgets that still defines them as + *** "adjacent," indicating that we don't want to increase the distance + *** between them. Therefore, a section of this size or less is considered + *** a "spacer" which will not be resized. + ***/ #define APOS_MINSPACE 20 -/**Lowest acceptable width or height for a widget**/ +/** The lowest acceptable width or height for a widget. **/ #define APOS_MINWIDTH 30 -/**Default flexibilities for widgetless gaps in expanding or contracting applications **/ +/** Default flexibilities for widgetless gaps in expanding or contracting applications. **/ #define APOS_EGAPFLEX 30 #define APOS_CGAPFLEX 50 diff --git a/centrallix/wgtr/apos.c b/centrallix/wgtr/apos.c index 8c3780205..b4719bca3 100644 --- a/centrallix/wgtr/apos.c +++ b/centrallix/wgtr/apos.c @@ -26,9 +26,59 @@ /* Author: Nathaniel Colson */ /* Creation: August 9, 2005 */ /* Description: Applies layout logic to the widgets of an application. */ -/* See centrallix-sysdoc/Auto-Positioning.md for more information. */ +/* See centrallix-sysdoc/Auto-Positioning.md for more information. */ /************************************************************************/ +/*** Author: Israel Fuller + *** Date: June, 2025 + *** + *** I wasn't the one to write most of this (although I did write a ton of + *** comments), but after doing my best to understand it, I hope that you will + *** find the compiled information below helpful. + *** + *** Execution of this file usually begins when wgtrVerify() in wgtr.c calls + *** aposAutoPositionWidgetTree(). To auto position the tree, the code first + *** it draws four lines on the four edges of every visible widget (with some + *** exceptions, @see aposAddLinesToGrid()). These lines divide the page into + *** into horizontal sections (rows) and vertical sections (columns) which span + *** the page. @see aposAddSectionsToGrid() for more detail. + *** + *** The program guesses that some of these sections are "spacers", which are + *** small amounts of space intended to provide visual room between widgets. + *** When resizing, these do not flex at all. However, many elements are able + *** to flex. @see aposSetFlexibilities() for more information about flexing. + *** + *** Next, the program uses aposSetLimits() to honor minimum and maximum sizes + *** of widgets, and finally calls aposAutoPositionContainers() to position + *** the widgets on the screen. Lastly, it calls aposProcessWindows() to handle + *** floating window widgets, which are typically ignored by most of the rest + *** of the code. + *** + *** Note: Due to this approach, this means that all sections and widgets start + *** and end at a line. The way these lines are set up ensures that start + *** lines are always on the top or left, and end lines are always on the + *** bottom or right. @see aposAddLinesForChildren() + *** + *** Notes: I wrote some information about various structs below that's good to + *** know. Some of this is covered elsewhere in the documentation. + *** + *** AposGrid: A data structure to store sections and lines. + *** + *** AposLine: An AposLine spans the entire page. + *** + *** AposSection: After lines are created, sections are added in between the + *** lines (aka. in between the nodes). Every node begins and ends on the + *** edge of a section, although it may span multiple sections. + *** + *** pWgtrNode: A pointer to a widget node instance. You can think of this + *** like a DOM node, but remember that it's common for them to expand + *** into multiple DOM nodes. Also, these can have children, just like + *** a DOM node, which is why a single widget node pointer is really + *** more of a tree of them. + *** + *** XArray: This array also stores its size (nAlloc) and the number of items + *** stored (nItems), so you don't have to pass that info separately. + ***/ #include #include @@ -37,6 +87,12 @@ #include "cxlib/xarray.h" #include "cxlib/datatypes.h" +/*** Allocate space for a grid, section, and line using the custom allocation + *** system. Note that register is similar to creating a new heap-allocated + *** variable, then binding it to a name. + *** + *** @returns 0, success. + ***/ int aposInit() { @@ -47,6 +103,14 @@ aposInit() return 0; } +/*** Dumps the grid content of a widget node and its floating children. This + *** function is most likely intended for debugging. + *** + *** @param tree The widget tree from which to extract the layout grid. + *** @param indent The number of 4-space indentations to indent the output. + *** Note: Included for the sake of recursion; just pass 0. + *** @returns 0, success. + ***/ int aposDumpGrid(pWgtrNode tree, int indent) { @@ -57,6 +121,7 @@ pWgtrNode child; printf("%*.*s*** %s ***\n", indent*4, indent*4, "", tree->Name); if (tree->LayoutGrid) { + /** Dump the grid rows. **/ sectionCnt = xaCount(&AGRID(tree->LayoutGrid)->Rows); for(i=0;iStartLine->Loc, section->Width); printf("\n"); } + + /** Dump the grid columns. **/ sectionCnt = xaCount(&AGRID(tree->LayoutGrid)->Cols); for(i=0;iChildren); for(i=0;iName); return -1; } - /** Set flexibilities on containers **/ + /** Set flexibilities on containers. **/ if (aposSetFlexibilities(tree) < 0) { return -1; @@ -110,7 +186,7 @@ int i=0, count=0; /*aposDumpGrid(tree, 0);*/ - /** Honor minimum/maximum space requirements **/ + /** Detect and honor minimum/maximum space requirements. **/ if (aposSetLimits(tree) < 0) { return -1; @@ -133,7 +209,7 @@ int i=0, count=0; /**makes a final pass through the tree and processes html windows**/ aposProcessWindows(tree, tree); - /**unpatches all of the heights that were specified in aposPrepareTree**/ + /** Unpatches the heights specified by aposPrepareTree(). **/ count=xaCount(&PatchedWidgets); for(i=0; ipre_height = -1; } + /** Free the PatchedWidgets XArray.**/ xaDeInit(&PatchedWidgets); return 0; } - +/*** Recursively sets flexibility values for containers and their children. + *** + *** @param Parent The parent node who's flexibilities are being set. + *** @returns 0 if successful, -1 otherwise. + ***/ int aposSetFlexibilities(pWgtrNode Parent) { @@ -156,14 +237,14 @@ pWgtrNode Child; int i=0, childCount=xaCount(&(Parent->Children)); int sectCount; - /** Check recursion **/ + /** Check recursion. **/ if (thExcessiveRecursion()) { mssError(1,"APOS","Could not layout application: resource exhaustion occurred"); return -1; } - + /** Recursively set the flexibilities of all children. **/ for(i=0; iChildren), i); @@ -174,7 +255,7 @@ int sectCount; } } - /** Reset flexibility values in the grid **/ + /** Reset flexibility values in the grid. **/ if (theGrid && childCount > 0 && !(Parent->Flags & WGTR_F_NONVISUAL)) { sectCount = xaCount(&(theGrid->Rows)); @@ -191,7 +272,7 @@ int sectCount; } } - /**set the flexibility of the given container, if it is visual**/ + /** Set the flexibility of the given container, if it is visual. **/ if(!(Parent->Flags & WGTR_F_NONVISUAL)) if(aposSetContainerFlex(Parent) < 0) { @@ -202,8 +283,13 @@ int sectCount; return 0; } - -/** this function is the recursive function that actually does the work **/ +/*** Adjusts space to acomodate children, somehow? I think? + *** + *** @param Parent The widget node parent who's limits are being calculated. + *** @param delta_w The change in width required to accomodate children. + *** @param delta_h The change in height required to accomodate children. + *** @returns 0 if successful, -1 otherwise. + ***/ int aposSetLimits_r(pWgtrNode Parent, int* delta_w, int* delta_h) { @@ -215,14 +301,14 @@ int sectionCount; pAposSection s; pWgtrNode Child; - /** Check recursion **/ + /** Check recursion. **/ if (thExcessiveRecursion()) { mssError(1,"APOS","Could not layout application: resource exhaustion occurred"); return -1; } - /** Figure what is needed for children **/ + /** Calculate the total required space for children. **/ childCount = xaCount(&(Parent->Children)); total_child_delta_w = total_child_delta_h = 0; for(i=0;iLayoutGrid) { sectionCount = xaCount(&(AGRID(Parent->LayoutGrid)->Rows)); - for(i=0;iLayoutGrid)->Rows), i)); + /*** If it has a desired width, increase the height + *** enough to give it that width. + ***/ if (s->DesiredWidth >= 0) { *delta_h += (s->DesiredWidth - s->Width); @@ -263,6 +356,9 @@ pWgtrNode Child; for(i=0;iLayoutGrid)->Cols), i)); + /*** If it has a desired width, increase the width + *** enough to give it that width. + ***/ if (s->DesiredWidth >= 0) { *delta_w += (s->DesiredWidth - s->Width); @@ -273,7 +369,7 @@ pWgtrNode Child; } } - /** Make space for this widget bigger **/ + /** If there is extra space, expand this widget to fill that space. **/ if (*delta_w) { if (Parent->StartVLine && ALINE(Parent->StartVLine)->SSection) @@ -298,8 +394,11 @@ pWgtrNode Child; return 0; } - -/** This function simply call the recursive version **/ +/*** Adjusts space to acomodate children, somehow? I think? + *** + *** @param Parent The widget node parent who's limits are being calculated. + *** @returns 0, success. + ***/ int aposSetLimits(pWgtrNode Parent) { @@ -314,30 +413,40 @@ int rval; return 0; } - +/*** Patch children of the given Parent node with unspecified heights. Searches + *** recursively within containers. Patched children are logged in the given + *** PatchedWidgets array. + *** + *** @param Parent The parent node who's childen should be patched. + *** @param PatchedWidgets The widget children which have been patched. + *** @returns 0 if successful, -1 otherwise. + ***/ int aposPrepareTree(pWgtrNode Parent, pXArray PatchedWidgets) { pWgtrNode Child; int i=0, childCount=xaCount(&(Parent->Children)); - /** Check recursion **/ + /** Check recursion. **/ if (thExcessiveRecursion()) { mssError(1,"APOS","Could not layout application: resource exhaustion occurred"); return -1; } + /** Loop through each child. **/ for(i=0; iChildren), i); - /**if a visual child has an unspecified height, patch it, unless it is a scrollpane**/ + /*** If a visual child has an unspecified height, patch it, unless it is in a scrollpane + *** Remember here that strcmp() returns 0 (false) if the strings are equal. + ***/ if((Child->height < 0) && !(Child->Flags & WGTR_F_NONVISUAL) && strcmp(Parent->Type, "widget/scrollpane")) aposPatchNegativeHeight(Child, PatchedWidgets); - /** If child is a container but not a window, recursively prepare it as well **/ + /** If child is a container, but not a floating window, recursively prepare it as well. **/ if((Child->Flags & WGTR_F_CONTAINER) && !(Child->Flags & WGTR_F_FLOATING)) if (aposPrepareTree(Child, PatchedWidgets) < 0) return -1; @@ -346,12 +455,18 @@ int i=0, childCount=xaCount(&(Parent->Children)); return 0; } +/*** Try to guess the height of a widget with an unspecified height. + *** + *** @param Widget The widget child who's height is unspecified. + *** @param PatchedWidgets The array to add the widget to after patching it. + *** @returns 0 if successful, -1 otherwise. + ***/ int aposPatchNegativeHeight(pWgtrNode Widget, pXArray PatchedWidgets) { ObjData val; - /** set unspecified height of widget to an educated guess**/ + /** Try to guess the height based on the type of widget. **/ if(!strcmp(Widget->Type, "widget/editbox")) { Widget->height = 16; @@ -390,12 +505,21 @@ ObjData val; return 0; } + /** Add the widget to the provided array. **/ xaAddItem(PatchedWidgets, Widget); + + /** Overwrite the "prepositioning" height because it's most likely also invalid. **/ Widget->pre_height = Widget->height; return 0; } +/*** Calculates and sets the flexibility for a container by taking weighted + *** averages in each direction. + *** + *** @param W The container to be set. + *** @returns 0, success. + ***/ int aposSetContainerFlex(pWgtrNode W) { @@ -405,7 +529,8 @@ int i=0, sectCount=0, TotalWidth=0, ProductSum=0; if (!theGrid) return 0; - /**calculate average row flexibility, weighted by height **/ + /** Calculate average row flexibility, weighted by height. **/ + /** Note: Height is called width because rows are 1 dimentional. **/ sectCount = xaCount(&(theGrid->Rows)); for(i=0; iCols)); for(i=0; iType, "widget/scrollpane")); - /**set isWin to compensate windows' titlebars, if any**/ + /** Set isWin to compensate windows' titlebars, if any. **/ if(isWin && !strcmp(W->Type, "widget/childwindow")) { + /*** Set isWin (is window) to compensate for a titlebar. If the + *** node does not specify if it has a titlebar, assume it does. + ***/ if(wgtrGetPropertyValue(W, "titlebar", DATA_T_STRING, &val) < 0) - *isWin = 1; //if property not found, assume it has a titlebar + *isWin = 1; // Property not found, assume it has a titlebar. else *isWin = !strcmp(val.String, "yes"); } - /**isTopTab and isSideTab are used to compensate for tabs**/ + /** isTopTab and isSideTab are used to compensate for tabs. **/ if(isTopTab && !strcmp(W->Type, "widget/tab")) { - /**set isTopTab and isSideTab**/ + /*** Set isTopTab and isSideTab. If the node does not specify the + *** tab location, assume it has a top tab and leave side-tab unset. + **/ if(wgtrGetPropertyValue(W, "tab_location", DATA_T_STRING, &val) < 0) - *isTopTab = 1; //if property not found, assume top tab**/ + *isTopTab = 1; // Property not found, assume it has a top tab only. else { *isTopTab = (!strcmp(val.String, "top") || !strcmp(val.String, "bottom")); - *isSideTab = (!strcmp(val.String, "left") || (!strcmp(val.String, "right"))); + *isSideTab = (!strcmp(val.String, "left") || (!strcmp(val.String, "right"))); // Warning: Unchecked assignment. } - /**set tabWidth**/ + /** Set the tab width. If none is specified, default to 80. **/ if(wgtrGetPropertyValue(W, "tab_width", DATA_T_INTEGER, &val) < 0) *tabWidth = 80; else *tabWidth = val.Integer; @@ -467,7 +616,12 @@ ObjData val; return 0; } - +/*** Builds the layout grid for recursively for this container and all of its + *** children, including the lines and sections required for positioning. + *** + *** @param Parent The parent node who's grid is being built. + *** @returns 0 if successful, -1 otherwise. + ***/ int aposBuildGrid(pWgtrNode Parent) { @@ -475,25 +629,24 @@ int childCount, i; pWgtrNode Child; pAposGrid theGrid = NULL; - /** Check recursion **/ + /** Check recursion. **/ if (thExcessiveRecursion()) { mssError(1,"APOS","Could not layout application: resource exhaustion occurred"); return -1; } - /** Allocate a grid **/ + /** Allocate a grid. **/ if (Parent->Flags & WGTR_F_CONTAINER) { if (!(Parent->Flags & WGTR_F_NONVISUAL) || !Parent->Parent) { + /** Allocate and initialize a new pAposGrid. **/ theGrid = Parent->LayoutGrid = (pAposGrid)nmMalloc(sizeof(AposGrid)); if (!Parent->LayoutGrid) goto error; - - /**initiallize the XArrays in the grid**/ aposInitiallizeGrid(theGrid); - /**Add the lines to the grid**/ + /** Add lines for children to the grid. **/ if(aposAddLinesToGrid(Parent, &(theGrid->HLines), &(theGrid->VLines)) < 0) { mssError(0, "APOS", "aposBuildGrid: Couldn't add lines to %s's grid", @@ -501,7 +654,7 @@ pAposGrid theGrid = NULL; return -1; } - /**Add the sections to the grid**/ + /** Add the sections to the grid. **/ if(aposAddSectionsToGrid(theGrid, (Parent->height-Parent->pre_height), (Parent->width-Parent->pre_width)) < 0) @@ -512,7 +665,7 @@ pAposGrid theGrid = NULL; } } - /** Do it for all children of this widget **/ + /** Recursively build this grid for all children of this widget. **/ childCount = xaCount(&(Parent->Children)); for(i=0; iChildren)); for(i=0;ipre_height < Parent->min_height && Parent->min_height != 0) height_adj = Parent->min_height - Parent->pre_height; - /**Add the 2 horizontal border lines, unless parent is a scrollpane**/ + /** Add the 2 horizontal border lines, unless parent is a scrollpane. **/ if(strcmp(Parent->Type, "widget/scrollpane")) { if(aposCreateLine(NULL, HLines, 0, 0, 1, 0, 0) < 0) @@ -650,18 +838,19 @@ pXArray FirstCross, LastCross; if(aposCreateLine(NULL, HLines, (Parent->pre_height-isWin*24), 0, 1, height_adj, 0) < 0) goto CreateLineError; } - /**Add the 2 vertical border lines**/ - if(aposCreateLine(NULL, VLines, 0, 0, 1, 0, 1) < 0) + + /** Add the 2 vertical border lines. **/ goto CreateLineError; if(aposCreateLine(NULL, VLines, (Parent->pre_width-isSP*18), 0, 1, width_adj, 1) < 0) goto CreateLineError; + /** Recursively add the nonborder lines for all child nodes. **/ if(aposAddLinesForChildren(Parent, HLines, VLines) < 0) goto CreateLineError; - /**populate horizontal line cross XArrays**/ + /** Record the widgets that cross each horizontal line in its CWidgets XArray. **/ count = xaCount(HLines); - for(i=1; iCWidgets), &(CurrLine->EWidgets), &(CurrLine->CWidgets)); } - /**populate vertical line cross XArrays**/ + /** Record the widgets that cross each vertical line in its CWidgets XArray. **/ count = xaCount(VLines); - for(i=1; iCWidgets), &(CurrLine->EWidgets), &(CurrLine->CWidgets)); } - /**sanity check to make sure no widgets cross the border lines**/ - if(xaCount(HLines)) //don't test borderlines unless they exist + /** Sanity check to make sure no widgets cross the border lines. **/ + if(xaCount(HLines)) // Only check borderlines if they exist. { FirstCross = &(((pAposLine)xaGetItem(HLines, 0))->CWidgets); LastCross = &(((pAposLine)xaGetItem(HLines, (xaCount(HLines)-1)))->CWidgets); @@ -708,6 +897,16 @@ pXArray FirstCross, LastCross; return -1; } +/*** Adds 4 lines for the edges of each visual child. Searches nonvisual + *** containers recursively for qualifying grandchildren. Floating windows + *** are ignored. Scrollpanes recieve only 2 vertical lines (skipping their + *** horizontal edges). + *** + *** @param Parent The parent who's children are being given lines. + *** @param HLines The array to which horizontal lines should be added. + *** @param VLines The array to which vertical lines should be added. + *** @returns 0 if successful, -1 otherwise. + ***/ int aposAddLinesForChildren(pWgtrNode Parent, pXArray HLines, pXArray VLines) { @@ -716,14 +915,14 @@ int isTopTab=0, isSideTab=0, tabWidth=0; int height_adj, width_adj; pWgtrNode C; - /** Check recursion **/ + /** Check recursion. **/ if (thExcessiveRecursion()) { mssError(1,"APOS","Could not layout application: resource exhaustion occurred"); return -1; } - /**loop through the children and create 4 lines for each child's 4 edges**/ + /** Loop through the children and create 4 lines for each child's 4 edges. **/ for(i=0; iChildren), i); @@ -736,27 +935,36 @@ pWgtrNode C; if (C->pre_height < C->min_height && C->min_height != 0) height_adj = C->min_height - C->pre_height; - /** If C is a nonvisual container, add lines for - *** the grandchildren. Otherwise, if C is visual - *** and not a window, just add 4 lines for it **/ + /** If the child (C) is a nonvisual container, recursively add lines for any grandchildren. **/ if((C->Flags & WGTR_F_NONVISUAL) && (C->Flags & WGTR_F_CONTAINER)) { if (aposAddLinesForChildren(C, HLines, VLines) < 0) goto CreateLineError; } + /** Otherwise, if child (C) is visual and not a floating window, add 4 lines for it. **/ else if(!(C->Flags & WGTR_F_NONVISUAL) && !(C->Flags & WGTR_F_FLOATING)) { - /**add horizontal lines, unless parent is a scrollpane**/ + /** Add horizontal lines, unless parent is a scrollpane. **/ if(strcmp(Parent->Type, "widget/scrollpane")) { - if(aposCreateLine(C, HLines, (C->y), APOS_SWIDGETS, 0, 0, 0) < 0) + /*** From this code, we see that the start line is + *** always the minY, and the end of the line is + *** always the maxY. Thus, the top line is the + *** start line and the bottom line is the end line + *** because Y increases as we decend the page. + ***/ goto CreateLineError; if(aposCreateLine(C, HLines, (C->y + C->height + isTopTab*24), APOS_EWIDGETS, 0, height_adj, 0) < 0) goto CreateLineError; } - /**add vertical lines**/ - if(aposCreateLine(C, VLines, (C->x), APOS_SWIDGETS, 0, 0, 1) < 0) + /** Add vertical lines. **/ + /*** From this code, we see that the start line is always + *** the minX, and the end of the line is always the maxX. + *** Thus, the left line is the start line and the right + *** line is the end line because X increases as we move + *** right along the page. + ***/ goto CreateLineError; if(aposCreateLine(C, VLines, (C->x + C->width + isSideTab*tabWidth), APOS_EWIDGETS, 0, width_adj, 1) < 0) goto CreateLineError; @@ -770,12 +978,36 @@ pWgtrNode C; return -1; } +/*** Creates a new line in the grid or updates an existing line if it exists + *** in the same location. Remember that lines record the widgets that start + *** on them (SWidgets), end on them (EWidgets), and cross them (CWidgets). + *** + *** Note: This function all lines in the given array are oriented in the same + *** direction as the new line. At the time of this writing (June 2025), + *** all known calling functions upheld by maintaining an HLines and a + *** VLines array to store horizontal and vertical lines separately. + *** + *** @param Widget The widget which determined the location of this line, + *** which we add to the SWidgets or EWidgets array. + *** @param Lines The array that stores the lines. + *** @param Loc The location of the line. Only a single coordinate in + *** one dimension is needed since lines span the entire grid. + *** @param type The type, indicating whether the associated widget starts + *** or ends on this line. + *** @param isBorder A boolean that is true if this is a grid border line. + *** @param adj An adjustment added to or subtracted from the line to + *** satisfy min or max constraints (respectively). + *** @param is_vert A boolean that is true if this line is vertical. + *** See APOS_VERTICAL and APOS_HORIZONTAL. + *** + *** @returns 0, success. + ***/ int aposCreateLine(pWgtrNode Widget, pXArray Lines, int Loc, int type, int isBorder, int adj, int is_vert) { pAposLine Line = aposExistingLine(Lines, Loc); - /**if there is already a line, just upgrade it**/ + /** If there is already a line, we upgrade it instead of creating a new one. **/ if(Line != NULL) { @@ -789,14 +1021,14 @@ pAposLine Line = aposExistingLine(Lines, Loc); else { - /**otherwise, create and add the new line**/ + /** There's not already a line, so we allocate a new one. **/ if((Line = (pAposLine)nmMalloc(sizeof(AposLine))) < 0) { mssError(1, "APOS", "aposCreateLine: Couldn't allocate memory for new grid line"); return -1; } - /**initiallize new line**/ + /** Initiallize the new line. **/ memset(Line, 0, sizeof(AposLine)); xaInit(&(Line->SWidgets),16); xaInit(&(Line->EWidgets),16); @@ -807,11 +1039,11 @@ pAposLine Line = aposExistingLine(Lines, Loc); Line->SSection = NULL; Line->ESection = NULL; - /**add new line, sorted by location**/ + /** Add the new line, to the list of lines, sorted by location. **/ xaAddItemSortedInt32(Lines, Line, 0); } - /** Link the line and the widget together **/ + /** Link the line and the widget together. **/ if (type == APOS_SWIDGETS) { xaAddItem(&(Line->SWidgets), Widget); @@ -834,6 +1066,16 @@ pAposLine Line = aposExistingLine(Lines, Loc); return 0; } +/*** Gets a line from the array at the location, or returns NULL if none exists. + *** + *** Note: This function all lines in the given array are oriented in the same + *** direction. This is not tested, although at the time of this writing + *** (June, 2025), all calling functions upheld this contract. + *** + *** @param Lines The array of lines to search. + *** @param Loc The location to check for a line. + *** @returns A pointer to the line, if it exists, and NULL otherwise. + ***/ pAposLine aposExistingLine(pXArray Lines, int Loc) { @@ -848,36 +1090,64 @@ int i, count = xaCount(Lines); return NULL; } +/*** Detects if a widget in PrevList (usually the widgets that started in or + *** crossed the pevious line) ends on this line (aka. appears in EWidgets). + *** If it does not end on this line, we know it crosses this line, so we add + *** the widget to CWidgets. + *** + *** @param PrevList The list of previous widgets being checked. + *** @param EWidgets The list of widgets ending on the line in question. + *** @param CWidgets The list to which widgets that cross should be added. + *** @returns 0, success. + ***/ int aposFillInCWidget(pXArray PrevList, pXArray EWidgets, pXArray CWidgets) { pWgtrNode AddCandidate; int found=0, i=0, j=0, pCount=xaCount(PrevList), eCount=xaCount(EWidgets); - /** loop through the SWidgets or CWidgets array of the previous line**/ + /*** Loop through the array from the previous line. + *** Note: Could be that line's SWidgets OR CWidgets. + **/ for(i=0; iHLines)); for(i=1; iRows), ((pAposLine)xaGetItem(&(theGrid->HLines),(i-1))), @@ -887,7 +1157,7 @@ int count=0, i=0; return -1; } - /**Add columns**/ + /** Add column sections between vertical lines. **/ count = xaCount(&(theGrid->VLines)); for(i=1; iCols), ((pAposLine)xaGetItem(&(theGrid->VLines),(i-1))), @@ -900,15 +1170,29 @@ int count=0, i=0; return 0; } +/*** Calculate and set the flexibility value for a section. Spacers have 0 flex + *** and containers use the flex of their least flexible children. + *** + *** @param sect The section being set. + *** @param type The type of section (either APOS_ROW or APOS_COL). + *** @returns 0 if successful or -1 if a default value should be used instead + ***/ int aposSetSectionFlex(pAposSection sect, int type) { +/*** Note: + *** sCount + cCount includes all widgets intersecting this section because a + *** widget cannot begin inside a section. It always starts or eds at the edge + *** of a section. + ***/ int sCount = xaCount(&(sect->StartLine->SWidgets)); int cCount = xaCount(&(sect->StartLine->CWidgets)); - /** Set flex to 0 if the section is a spacer or contains non-flexible children, - *** otherwise set it to the average of the children. If none of those apply - *** it must be a wide, widgetless gap, assign a default flexibility **/ + /** Set flex to 0 if the section is a spacer or contains non-flexible + *** children, otherwise set it to the minimum of the children. If none + *** of those apply it must be a wide, widgetless gap. In this case, + *** return -1 to prompt the caller to determine a default flexibility. + ***/ if((sect->isSpacer) || (aposNonFlexChildren(sect->StartLine, type))) sect->Flex = 0; else if(sCount || cCount) @@ -919,12 +1203,21 @@ int cCount = xaCount(&(sect->StartLine->CWidgets)); return 0; } +/*** Creates a new row or column section between two lines in the grid. + *** + *** @param Sections The array of sections, to which this section will be added. + *** @param StartL The line which starts this section (typically the top/left line). + *** @param EndL The line which ends this section (typically the bottom/right line). + *** @param Diff I had a hard time figuring out what this means. + *** @param type Whether the section is a row (APOS_ROW) or a column (APAS_COL). + *** @returns 0 if successful, -1 otherwise. + ***/ int aposCreateSection(pXArray Sections, pAposLine StartL, pAposLine EndL, int Diff, int type) { pAposSection NewSect; - /**Allocate and initiallize a new section**/ + /** Allocate and initiallize a new section. **/ if((NewSect = (pAposSection)(nmMalloc(sizeof(AposSection)))) < 0) { mssError(1, "APOS", "nmMalloc(): Couldn't allocate memory for new row or column"); @@ -940,11 +1233,11 @@ pAposSection NewSect; StartL->SSection = NewSect; EndL->ESection = NewSect; - /** Need to adjust section width/height? **/ + /** Apply the adjustment from the end line, if needed. **/ if (EndL->Adj) NewSect->DesiredWidth = NewSect->Width + EndL->Adj; - /** Set section flexibility **/ + /** Set section flexibility. **/ if (aposSetSectionFlex(NewSect, type) < 0) { if (Diff < 0) @@ -958,22 +1251,36 @@ pAposSection NewSect; return 0; } +/*** Determines if a section between two lines is a spacer. + *** + *** If a section is a spacer, the assumption is that the designer probably put + *** that space there to provide visual breathing room in their design. Thus, we + *** should avoid resizing it as this may interfere with their design. + *** + *** @param StartL The line starting the section. (I think this is always the left/top.) + *** @param EndL The line starting the section. (I think this is always the right/bottom.) + *** @param type Whether the section is a row (APOS_ROW) or a column (APAS_COL). + *** @param isBorder Whether the section is on the border of the page. + *** @returns 0 if successful, -1 otherwise. + ***/ int aposIsSpacer(pAposLine StartL, pAposLine EndL, int type, int isBorder) { pWgtrNode SW, EW; int i=0, j=0; +/** @brief The number of widgets starting at the end of this section.**/ int sCount=xaCount(&(EndL->SWidgets)); +/** @brief The number of widgets ending at the start of this section.**/ int eCount=xaCount(&(StartL->EWidgets)); - if((EndL->Loc - StartL->Loc) <= APOS_MINSPACE) //if section is sufficiently narrow + if((EndL->Loc - StartL->Loc) <= APOS_MINSPACE) // If section is sufficiently narrow. { - /**gap between border and widget**/ + /** Gaps between the border and any widget(s) are spacers. **/ if(isBorder && (sCount || eCount)) return 1; - /** Checks every widget ending on one side of the section against - *** every widget beginning on the other side to see if any of them - *** are directly across from each other **/ + /** Checks every widget ending on one side to see if a widget + *** starts directly across from it on the other side. + ***/ for(i=0; iSWidgets), i)); @@ -981,9 +1288,10 @@ int eCount=xaCount(&(StartL->EWidgets)); { EW = (pWgtrNode)(xaGetItem(&(StartL->EWidgets), j)); - /** if a corner of a widget on one side of the - *** section falls between the two corners of a widget - *** on the other side, return 1 **/ + /** If a corner of the widget on one side falls + *** between the two corners of a widget on the + *** other side, this is a spacer. + ***/ if((type == APOS_ROW) && (((EW->x >= SW->x) && (EW->x < (SW->x + SW->width))) || (((EW->x + EW->width) > SW->x) && ((EW->x + EW->width) <= (SW->x + SW->width))))) return 1; @@ -998,6 +1306,14 @@ int eCount=xaCount(&(StartL->EWidgets)); return 0; } +/*** Checks for any widgets starting on or crossing a line that are non-flexible + *** in the relevant dimention. + *** + *** @param L The line along which to check. + *** @param type Specifies the relevant dimetion using APOS_ROW or APOS_COL. + *** @returns 1 if any child widget is non-flexible in the relevant dimension, + *** 0 otherwise. + ***/ int aposNonFlexChildren(pAposLine L, int type) { @@ -1005,8 +1321,9 @@ int i=0; int sCount = xaCount(&(L->SWidgets)); int cCount = xaCount(&(L->CWidgets)); - /** returns 1 if the widgets starting on or crossing the given - *** line have children that are completely non-flexible **/ + /*** Return 1 if the widgets starting on or crossing the given line have + *** children that are completely non-flexible. + ***/ if(type == APOS_ROW) { for(i=0; iCWidgets)); if(((pWgtrNode)(xaGetItem(&(L->CWidgets), i)))->fl_height == 0) return 1; } - else //type == APOS_COL + else // type == APOS_COL { for(i=0; iSWidgets), i)))->fl_width == 0) @@ -1029,6 +1346,12 @@ int cCount = xaCount(&(L->CWidgets)); return 0; } +/*** Calculates the average flexibility of widgets on a line. + *** + *** @param L The line along which to check. + *** @param type Specifies the relevant dimetion using APOS_ROW or APOS_COL. + *** @returns The average flexibility of children on the line. + ***/ int aposAverageChildFlex(pAposLine L, int type) { @@ -1036,7 +1359,7 @@ int TotalFlex=0, i=0; int sCount = xaCount(&(L->SWidgets)); int cCount = xaCount(&(L->CWidgets)); - /** Sum the flexibilities of widgets within the section proceeding the line**/ + /** Sum the flexibilities. **/ if(type == APOS_ROW) { for(i=0; iCWidgets)); TotalFlex += ((pWgtrNode)xaGetItem(&(L->CWidgets), i))->fl_width; } - /**return average flexibility**/ + /** Return the average flexibility with an aditional fudge factor. **/ return (int)(APOS_FUDGEFACTOR + ((float)TotalFlex)/((float)sCount+(float)cCount)); } +/*** Calculates the minimum flexibility of widgets on a line. + *** + *** @param L The line along which to check. + *** @param type Specifies the relevant dimetion using APOS_ROW or APOS_COL. + *** @returns The minimum flexibility of children on the line. + ***/ int aposMinimumChildFlex(pAposLine L, int type) { @@ -1063,7 +1392,7 @@ int MinFlex=100, i=0, f; int sCount = xaCount(&(L->SWidgets)); int cCount = xaCount(&(L->CWidgets)); - /** Find the min flex within the section proceeding the line**/ + /** Find the min flexibility. **/ if(type == APOS_ROW) { for(i=0; iCWidgets)); } } - /**return min flexibility**/ + /** Return the minimum flexibility. **/ return MinFlex; } +/*** Distributes extra or missing space among grid lines based on section flexibility. + *** + *** @param Lines The array of lines in the relevant direction on this grid. + *** @param Secctions The array of sections in the relevant direction on this grid. + *** @param Diff The space differencce from how the elements are currently spaced. + *** @returns The remaining space difference after spacing out elements as much as possible. + ***/ int aposSpaceOutLines(pXArray Lines, pXArray Sections, int Diff) { @@ -1105,7 +1441,7 @@ int FlexibleSections=0; float FlexWeight=0, SizeWeight=0; float TotalSum=0; - /**if there are no sections, don't bother going on**/ + /** If there are no sections, we have nothing to space out. **/ if(!count) return Diff; /**Sum the flexibilities of the sections**/ @@ -1118,9 +1454,13 @@ float TotalSum=0; FlexibleSections++; TotalFlexibleSpace += CurrSect->Width; } + else CurrSect->AdjWeight = 0.0f; } - /** if there is no flexibility for expansion or contraction return 0**/ + /*** If there is no flexibility (no expansion or contraction), we can't + *** space anything out. Return the original difference so this can be + *** spaced out elsewhere. + ***/ if(TotalFlex == 0) return Diff; /** sets each line's location equal to the previous line's location @@ -1201,6 +1541,14 @@ float TotalSum=0; return Extra; } +/*** Adjusts widget positions and sizes to snap them to grid lines. This + *** function should be called after updating grid lines to ensure that + *** widgets properly reflect the changes. + *** + *** @param Lines The lines being updated. + *** @param flag Either APOS_ROW or APOS_COL. + *** @returns 0, success. + ***/ int aposSnapWidgetsToGrid(pXArray Lines, int flag) { @@ -1231,6 +1579,7 @@ pWgtrNode Widget; aposSetOffsetBools(Widget, NULL, NULL, &isTopTab, &isSideTab, &tabWidth); if(flag==APOS_ROW && Widget->fl_height) { + /** Calculate the new size, taking APOS_MINWIDTH into account.**/ newsize = CurrLine->Loc - Widget->y - isTopTab*24; if (newsize < APOS_MINWIDTH && Widget->pre_height >= APOS_MINWIDTH) Widget->height = APOS_MINWIDTH; @@ -1242,6 +1591,7 @@ pWgtrNode Widget; } else if(flag==APOS_COL && Widget->fl_width) { + /** Calculate the new size, taking APOS_MINWIDTH into account.**/ newsize = CurrLine->Loc - Widget->x - isSideTab*tabWidth; if (newsize < APOS_MINWIDTH && Widget->pre_width >= APOS_MINWIDTH) Widget->width = APOS_MINWIDTH; @@ -1257,6 +1607,14 @@ pWgtrNode Widget; return 0; } +/*** + *** Processes floating windows and recursively positions visual and + *** nonvisual containers. + *** + *** @param VisualRef The last visual container up the inheritance tree. + *** @param Parent The widget being scanned for windows. + *** @returns 0 if successful, -1 otherwise. + ***/ int aposProcessWindows(pWgtrNode VisualRef, pWgtrNode Parent) { @@ -1359,6 +1717,10 @@ int ival; return 0; } +/*** Frees all memory used by a grid, including its lines and sections. + *** + *** @param theGrid The grid being freed. + ***/ int aposFree(pAposGrid theGrid) { From 49f4641284949bc12bb7b97fcc5a9848aee3ff3f Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Thu, 26 Jun 2025 17:25:50 -0600 Subject: [PATCH 049/275] Improve code readability without affecting functionality. --- centrallix/include/apos.h | 9 +++++++++ centrallix/wgtr/apos.c | 21 +++++++++++++-------- 2 files changed, 22 insertions(+), 8 deletions(-) diff --git a/centrallix/include/apos.h b/centrallix/include/apos.h index 36f5e1ee4..e99a90868 100644 --- a/centrallix/include/apos.h +++ b/centrallix/include/apos.h @@ -118,9 +118,14 @@ int aposProcessWindows(pWgtrNode, pWgtrNode); /**Makes a pass through the tree t /** # defines names for magic values to make them easier to read. **/ /** Indicates how a line links to a widget. */ +#define APOS_NOT_LINKED 0 #define APOS_SWIDGETS 1 #define APOS_EWIDGETS 2 +/** Indicates if a line is vertical. */ +#define APOS_VERTICAL 1 +#define APOS_HORIZONTAL 0 + /*** Indicates if a section or line is a row (horizontal) or a column (vertical). *** A row spans horizontally between two vertical lines, and a column spans *** vertically between two horizontal lines. @@ -128,6 +133,10 @@ int aposProcessWindows(pWgtrNode, pWgtrNode); /**Makes a pass through the tree t #define APOS_ROW 1 #define APOS_COL 2 +/** Indicates if a line is a border. */ +#define APOS_IS_BORDER 1 +#define APOS_NOT_BORDER 0 + #define APOS_FUDGEFACTOR 0.5 /*** The greatest width between two widgets that still defines them as diff --git a/centrallix/wgtr/apos.c b/centrallix/wgtr/apos.c index b4719bca3..49cfeb0db 100644 --- a/centrallix/wgtr/apos.c +++ b/centrallix/wgtr/apos.c @@ -833,15 +833,18 @@ pXArray FirstCross, LastCross; /** Add the 2 horizontal border lines, unless parent is a scrollpane. **/ if(strcmp(Parent->Type, "widget/scrollpane")) { - if(aposCreateLine(NULL, HLines, 0, 0, 1, 0, 0) < 0) + int minHeightLoc = 0, maxHeightLoc = Parent->pre_height - isWin * 24; + if(aposCreateLine(NULL, HLines, minHeightLoc, APOS_NOT_LINKED, APOS_IS_BORDER, 0, APOS_HORIZONTAL) < 0) goto CreateLineError; - if(aposCreateLine(NULL, HLines, (Parent->pre_height-isWin*24), 0, 1, height_adj, 0) < 0) + if(aposCreateLine(NULL, HLines, maxHeightLoc, APOS_NOT_LINKED, APOS_IS_BORDER, height_adj, APOS_HORIZONTAL) < 0) goto CreateLineError; } /** Add the 2 vertical border lines. **/ + int minWidthLoc = 0, maxWidthLoc = (Parent->pre_width-isSP*18); + if(aposCreateLine(NULL, VLines, minWidthLoc, APOS_NOT_LINKED, APOS_IS_BORDER, 0, APOS_VERTICAL) < 0) goto CreateLineError; - if(aposCreateLine(NULL, VLines, (Parent->pre_width-isSP*18), 0, 1, width_adj, 1) < 0) + if(aposCreateLine(NULL, VLines, maxWidthLoc, APOS_NOT_LINKED, APOS_IS_BORDER, width_adj, APOS_VERTICAL) < 0) goto CreateLineError; /** Recursively add the nonborder lines for all child nodes. **/ @@ -953,8 +956,10 @@ pWgtrNode C; *** start line and the bottom line is the end line *** because Y increases as we decend the page. ***/ + int minY = (C->y), maxY = (C->y + C->height + isTopTab*24); + if(aposCreateLine(C, HLines, minY, APOS_SWIDGETS, APOS_NOT_BORDER, 0, APOS_HORIZONTAL) < 0) goto CreateLineError; - if(aposCreateLine(C, HLines, (C->y + C->height + isTopTab*24), APOS_EWIDGETS, 0, height_adj, 0) < 0) + if(aposCreateLine(C, HLines, maxY, APOS_EWIDGETS, APOS_NOT_BORDER, height_adj, APOS_HORIZONTAL) < 0) goto CreateLineError; } @@ -965,8 +970,10 @@ pWgtrNode C; *** line is the end line because X increases as we move *** right along the page. ***/ + int minX = (C->x), maxX = (C->x + C->width + isSideTab*tabWidth); + if(aposCreateLine(C, VLines, minX, APOS_SWIDGETS, APOS_NOT_BORDER, 0, APOS_VERTICAL) < 0) goto CreateLineError; - if(aposCreateLine(C, VLines, (C->x + C->width + isSideTab*tabWidth), APOS_EWIDGETS, 0, width_adj, 1) < 0) + if(aposCreateLine(C, VLines, maxX, APOS_EWIDGETS, APOS_NOT_BORDER, width_adj, APOS_VERTICAL) < 0) goto CreateLineError; } } @@ -1470,9 +1477,7 @@ float TotalSum=0; { PrevSect = (pAposSection)xaGetItem(Sections, (i-1)); FlexWeight = (float)(PrevSect->Flex) / (float)(TotalFlex); - SizeWeight = 0; - if(FlexWeight > 0) - SizeWeight = (float)(PrevSect->Width) / (float)(TotalFlexibleSpace); + SizeWeight = (FlexWeight > 0) ? (float)(PrevSect->Width) / (float)(TotalFlexibleSpace) : 0; TotalSum += (FlexWeight * SizeWeight); } From 817f6e1a0edf4b7412c6a7a00a01d14101dee90b Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Thu, 26 Jun 2025 17:32:59 -0600 Subject: [PATCH 050/275] Store adj weights for later CSS use. --- centrallix/include/apos.h | 21 +++++++++++++++++ centrallix/include/wgtr.h | 2 ++ centrallix/wgtr/apos.c | 48 ++++++++++++++++++++++++++++++++++----- 3 files changed, 65 insertions(+), 6 deletions(-) diff --git a/centrallix/include/apos.h b/centrallix/include/apos.h index e99a90868..70bb49f12 100644 --- a/centrallix/include/apos.h +++ b/centrallix/include/apos.h @@ -51,6 +51,14 @@ struct _APOS_L XArray CWidgets; //widgets that cross the line pAposSection SSection; // section starting with this line pAposSection ESection; // section ending with this line + + /*** Used to find the distance the line should move when the parent + *** container is resized. LocAdjWeight is the weight that this line + *** moves relative to the container. MyAdjWeight is the amount that + *** this line moves relative to the line before (left of) it. + *** Used for generating responsive CSS. + ***/ + float LocAdjWeight, MyAdjWeight; }; /**Section Structure (used for both rows and columns)**/ @@ -63,6 +71,19 @@ struct _APOS_S int DesiredWidth; //When we need to resize to honor max/mins int isSpacer; //set for narrow spaces between widgets int isBorder; //set for grid border sections + + /*** Computed value which stores the weight for how much this section + *** should be adjusted when resizing. All sections along each dimention + *** inside a single page or other container should have a total adjWeight + *** of 1.0. + *** + *** For example, if we have two sections with adj weights of 0.4 and 0.6. + *** If the container/page is stretched by 10 px, then 4 px is distributed + *** to the first section and 6 px is distributed to the second section. + *** + *** Warning: Currently unused. + ***/ + float AdjWeight; }; /**Grid Structure**/ diff --git a/centrallix/include/wgtr.h b/centrallix/include/wgtr.h index 99f8c3760..eaf865ff4 100644 --- a/centrallix/include/wgtr.h +++ b/centrallix/include/wgtr.h @@ -102,6 +102,8 @@ typedef struct _WN int pre_x, pre_y, pre_width, pre_height; /** pre-layout geom. **/ int fl_x, fl_y, fl_width, fl_height;/** Flexibility **/ double fx, fy, fw, fh; /** internal flexibility calculations **/ + float xAdjWeight, yAdjWeight; /** Responsive CSS adjustment weights for x and y */ + float wAdjWeight, hAdjWeight; /** Responsive CSS adjustment weights for width and height */ int min_width, min_height; /** absolute minimums **/ int x, y, width, height; /** actual geometry **/ int top, bottom, left, right; /** container offsets **/ diff --git a/centrallix/wgtr/apos.c b/centrallix/wgtr/apos.c index 49cfeb0db..d802fca9c 100644 --- a/centrallix/wgtr/apos.c +++ b/centrallix/wgtr/apos.c @@ -1482,6 +1482,10 @@ float TotalSum=0; TotalSum += (FlexWeight * SizeWeight); } + /** The initial borders do not adjust.**/ + pAposLine leftBorder = (pAposLine)xaGetItem(Lines, 0); + leftBorder->LocAdjWeight = leftBorder->MyAdjWeight = 0.0f; + for(i=1; i 0) SizeWeight = (float)(PrevSect->Width) / (float)(TotalFlexibleSpace); + + /*** Calculate the adjustment weight, and also save it so we can + *** replicate some of the following logic in the CSS we will + *** eventually send to the client. + ***/ + float AdjWeight = PrevSect->AdjWeight = (float)(FlexWeight*SizeWeight)/TotalSum; /**for expanding lines**/ if(Diff > 0) { - /*Adj = APOS_FUDGEFACTOR + (float)(Diff) * ((float)(FlexWeight+SizeWeight)/2.0);*/ - Adj = APOS_FUDGEFACTOR + (float)(Diff) * ((float)(FlexWeight*SizeWeight)/TotalSum); + /** Calculate adjustment using the adjustment weight. **/ + Adj = (float)(Diff) * AdjWeight + APOS_FUDGEFACTOR; + + /** Store the line adjustment weight for responsive CSS later.**/ + CurrLine->LocAdjWeight = PrevLine->LocAdjWeight + AdjWeight; + CurrLine->MyAdjWeight = AdjWeight; + + /** Apply the calculated adjustment.**/ CurrLine->Loc = PrevLine->Loc + PrevSect->Width + Adj; PrevSect->Width += Adj; } /**for contracting lines**/ else if(Diff < 0) { - /*Adj = (float)(Diff) * ((float)(FlexWeight+SizeWeight)/2.0) - APOS_FUDGEFACTOR;*/ - Adj = (float)(Diff) * ((float)(FlexWeight*SizeWeight)/TotalSum) - APOS_FUDGEFACTOR; + /** Calculate adjustment using the adjustment weight. **/ + Adj = (float)(Diff) * AdjWeight - APOS_FUDGEFACTOR; /** if the section width will be unacceptably *** narrow or negative after the adjustment **/ @@ -1572,8 +1588,14 @@ pWgtrNode Widget; for(j=0; jSWidgets), j); - if(flag == APOS_ROW) Widget->y = CurrLine->Loc; - else Widget->x = CurrLine->Loc; + if(flag == APOS_ROW) { + Widget->y = CurrLine->Loc; + Widget->yAdjWeight = CurrLine->LocAdjWeight; + } + else { + Widget->x = CurrLine->Loc; + Widget->xAdjWeight = CurrLine->LocAdjWeight; + } } /** Adjusts width or height of widgets ending on this line **/ @@ -1593,6 +1615,13 @@ pWgtrNode Widget; else /*Widget->height = APOS_MINWIDTH;*/ Widget->height = Widget->pre_height; + + /*** The widget copies the adjustment weight of the + *** line, ignoring APOS_MINWIDTH. This might lead + *** to problems down the road, but I plan to fix + *** them if and when I encounter them. + ***/ + Widget->hAdjWeight = CurrLine->MyAdjWeight; } else if(flag==APOS_COL && Widget->fl_width) { @@ -1605,6 +1634,13 @@ pWgtrNode Widget; else /*Widget->width = APOS_MINWIDTH;*/ Widget->width = Widget->pre_width; + + /*** The widget copies the adjustment weight of the + *** line, ignoring APOS_MINWIDTH. This might lead + *** to problems down the road, but I plan to fix + *** them if and when I encounter them. + ***/ + Widget->hAdjWeight = CurrLine->MyAdjWeight; } } } From 7670b48916fb3fc537bb40511d6266c74e118d0e Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Thu, 26 Jun 2025 17:34:04 -0600 Subject: [PATCH 051/275] Add a helpful error value when attempting to write widget properties with an unknown type. --- centrallix/htmlgen/ht_render.c | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/centrallix/htmlgen/ht_render.c b/centrallix/htmlgen/ht_render.c index 285a1c0da..29b0152e7 100644 --- a/centrallix/htmlgen/ht_render.c +++ b/centrallix/htmlgen/ht_render.c @@ -1419,6 +1419,10 @@ htr_internal_WriteWgtrProperty(pHtSession s, pWgtrNode tree, char* propname) xsDeInit(&proptxt); xsDeInit(&exptxt); break; + + default: + htrAddScriptWgtr_va(s, "%STR&SYM:'Unknown Datatype (%INT) - Add it in ht_render.c:htr_internal_WriteWgtrProperty()', ", propname, t); + break; } } } From 1a3dc3cd88dfe9321b55e620b75951876b2a22c4 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Thu, 26 Jun 2025 17:35:32 -0600 Subject: [PATCH 052/275] Implement rendering doubles as widget properties. --- centrallix/htmlgen/ht_render.c | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/centrallix/htmlgen/ht_render.c b/centrallix/htmlgen/ht_render.c index 29b0152e7..a925d67fe 100644 --- a/centrallix/htmlgen/ht_render.c +++ b/centrallix/htmlgen/ht_render.c @@ -1405,6 +1405,10 @@ htr_internal_WriteWgtrProperty(pHtSession s, pWgtrNode tree, char* propname) htrAddScriptWgtr_va(s, "%STR&SYM:%INT, ", propname, od.Integer); break; + case DATA_T_DOUBLE: + htrAddScriptWgtr_va(s, "%STR&SYM:%DBL, ", propname, od.Double); + break; + case DATA_T_STRING: htrAddScriptWgtr_va(s, "%STR&SYM:'%STR&JSSTR', ", propname, od.String); break; From c5855faddde96ffaca223c808681872056982b64 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Thu, 26 Jun 2025 17:36:49 -0600 Subject: [PATCH 053/275] Render the new adjustment weight doubles as widget properties for debugging. --- centrallix/htmlgen/ht_render.c | 4 ++++ centrallix/wgtr/wgtr.c | 13 +++++++++++++ 2 files changed, 17 insertions(+) diff --git a/centrallix/htmlgen/ht_render.c b/centrallix/htmlgen/ht_render.c index a925d67fe..f2555e697 100644 --- a/centrallix/htmlgen/ht_render.c +++ b/centrallix/htmlgen/ht_render.c @@ -1496,6 +1496,10 @@ htr_internal_BuildClientWgtr_r(pHtSession s, pWgtrNode tree, int indent) htr_internal_WriteWgtrProperty(s, tree, "r_y"); htr_internal_WriteWgtrProperty(s, tree, "r_width"); htr_internal_WriteWgtrProperty(s, tree, "r_height"); + htr_internal_WriteWgtrProperty(s, tree, "adj_weight_x"); + htr_internal_WriteWgtrProperty(s, tree, "adj_weight_y"); + htr_internal_WriteWgtrProperty(s, tree, "adj_weight_w"); + htr_internal_WriteWgtrProperty(s, tree, "adj_weight_h"); } propname = wgtrFirstPropertyName(tree); while(propname) diff --git a/centrallix/wgtr/wgtr.c b/centrallix/wgtr/wgtr.c index 0293dfc62..fc7d48e79 100755 --- a/centrallix/wgtr/wgtr.c +++ b/centrallix/wgtr/wgtr.c @@ -1312,6 +1312,9 @@ wgtrGetPropertyType(pWgtrNode widget, char* name) !strcmp(name, "r_x") || !strcmp(name, "r_y") || !strcmp(name, "r_width") || !strcmp(name, "r_height") || !strcmp(name, "fl_x") || !strcmp(name, "fl_y") || !strcmp(name, "fl_width") || !strcmp(name, "fl_height")) return DATA_T_INTEGER; + else if (!strcmp(name, "adj_weight_x") || !strcmp(name, "adj_weight_y") || + !strcmp(name, "adj_weight_w") || !strcmp(name, "adj_weight_h")) + return DATA_T_DOUBLE; count = xaCount(&(widget->Properties)); for (i=0;iInteger = widget->fl_height; return 0; } } } + if (datatype == DATA_T_DOUBLE) + { + if (!strncmp(name, "adj_weight_", 11)) + { + if (!strcmp(name+11, "x")) { val->Double = (double)widget->xAdjWeight; return 0; } + else if (!strcmp(name+11, "y")) { val->Double = (double)widget->yAdjWeight; return 0; } + else if (!strcmp(name+11, "w")) { val->Double = (double)widget->wAdjWeight; return 0; } + else if (!strcmp(name+11, "h")) { val->Double = (double)widget->hAdjWeight; return 0; } + } + } else if (datatype == DATA_T_STRING) { if (!strcmp(name, "name")) { val->String = widget->Name; return 0; } From 837f6b4bf4b7d22a5b76686d2a76d32fc0db3f2b Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Fri, 27 Jun 2025 16:15:13 -0600 Subject: [PATCH 054/275] Reformat CSS. --- centrallix/htmlgen/ht_render.c | 59 ++++++++++++++++++++++++-------- centrallix/htmlgen/htdrv_pane.c | 60 +++++++++++++++++++++++++++------ 2 files changed, 95 insertions(+), 24 deletions(-) diff --git a/centrallix/htmlgen/ht_render.c b/centrallix/htmlgen/ht_render.c index f2555e697..32eb99bdf 100644 --- a/centrallix/htmlgen/ht_render.c +++ b/centrallix/htmlgen/ht_render.c @@ -2692,20 +2692,51 @@ htrFormatElement(pHtSession s, pWgtrNode node, char* id, int flags, int x, int y shadow_angle = strtod(strval, NULL); /** Generate the style CSS **/ - htrAddStylesheetItem_va(s, "\t%STR { left:%POSpx; top:%POSpx; %[width:%POSpx; %]%[height:%POSpx; %]%[z-index:%POS; %]%[color:%STR&CSSVAL; %]%[font-weight:bold; %]%[text-decoration:underline; %]%[font-style:italic; %]%[font:%STR&CSSVAL; %]%[font-size:%DBLpx; %]%[background-color:%STR&CSSVAL; %]%[background-image:url('%STR&CSSURL'); %]%[padding:%DBLpx; %]%[border:1px %STR&CSSVAL %STR&CSSVAL; %]%[border-radius:%DBLpx; %]%[text-align:%STR&CSSVAL; %]%[white-space:nowrap; %]%[box-shadow:%DBLpx %DBLpx %DBLpx %STR&CSSVAL%STR&CSSVAL; %]%[%STR %]}\n", - id, - x, y, w > 0, w, h > 0, h, z > 0, z, - *textcolor, textcolor, - !strcmp(style, "bold"), !strcmp(style, "underline"), !strcmp(style, "italic"), - *font, font, font_size > 0, font_size, - *bgcolor, bgcolor, *background, background, - padding > 0, padding, - *border_color, (*border_style)?border_style:"solid", border_color, border_radius > 0, border_radius, - *align, align, - !wrap, - (*shadow_color && shadow_radius > 0), sin(shadow_angle*M_PI/180)*shadow_offset, cos(shadow_angle*M_PI/180)*(-shadow_offset), shadow_radius, shadow_color, (!strcasecmp(shadow_location,"inside"))?" inset":"", - addl && *addl, addl - ); + htrAddStylesheetItem_va(s, + "\t%STR {" + "left:%POSpx; " + "top:%POSpx; " + "%[width:%POSpx; %]" + "%[height:%POSpx; %]" + "%[z-index:%POS; %]" + "%[color:%STR&CSSVAL; %]" + "%[font-weight:bold; %]" + "%[text-decoration:underline; %]" + "%[font-style:italic; %]" + "%[font:%STR&CSSVAL; %]" + "%[font-size:%DBLpx; %]" + "%[background-color:%STR&CSSVAL; %]" + "%[background-image:url('%STR&CSSURL'); %]" + "%[padding:%DBLpx; %]" + "%[border:1px %STR&CSSVAL %STR&CSSVAL; %]" + "%[border-radius:%DBLpx; %]" + "%[text-align:%STR&CSSVAL; %]" + "%[white-space:nowrap; %]" + "%[box-shadow:%DBLpx %DBLpx %DBLpx %STR&CSSVAL%STR&CSSVAL; %]" + "%[%STR %]" + "}\n", + id, + x, + y, + (w > 0), w, + (h > 0), h, + (z > 0), z, + (*textcolor), textcolor, + (!strcmp(style, "bold")), + (!strcmp(style, "underline")), + (!strcmp(style, "italic")), + (*font), font, + (font_size > 0), font_size, + (*bgcolor), bgcolor, + (*background), background, + (padding > 0), padding, + (*border_color), (*border_style) ? border_style : "solid", border_color, + (border_radius > 0), border_radius, + (*align), align, + (!wrap), + (*shadow_color && shadow_radius > 0), sin(shadow_angle * M_PI/180) * shadow_offset, cos(shadow_angle * M_PI/180) *(-shadow_offset), shadow_radius, shadow_color, (!strcasecmp(shadow_location,"inside"))?" inset":"", + (addl && *addl), addl + ); return 0; } diff --git a/centrallix/htmlgen/htdrv_pane.c b/centrallix/htmlgen/htdrv_pane.c index 0683cc6e6..64d5c0e68 100644 --- a/centrallix/htmlgen/htdrv_pane.c +++ b/centrallix/htmlgen/htdrv_pane.c @@ -154,24 +154,64 @@ htpnRender(pHtSession s, pWgtrNode tree, int z) } /** Ok, write the style header items. **/ - if (style == 2) /* flat */ - { - htrAddStylesheetItem_va(s,"\t#pn%POSmain { POSITION:absolute; VISIBILITY:inherit; overflow:hidden; LEFT:%INTpx; TOP:%INTpx; WIDTH:%POSpx; HEIGHT:%POSpx; Z-INDEX:%POS; }\n",id,x,y,w,h,z); - htrAddStylesheetItem_va(s,"\t#pn%POSmain { border-radius: %INTpx; %STR}\n",id,border_radius,main_bg); - } + int offset = 0; + if (style == 2) { /* flat, the default style, nothing to do */ } else if (style == 0 || style == 1) /* lowered or raised */ { - htrAddStylesheetItem_va(s,"\t#pn%POSmain { POSITION:absolute; VISIBILITY:inherit; overflow: hidden; LEFT:%INTpx; TOP:%INTpx; WIDTH:%POSpx; HEIGHT:%POSpx; Z-INDEX:%POS; }\n",id,x,y,w-2*box_offset,h-2*box_offset,z); - htrAddStylesheetItem_va(s,"\t#pn%POSmain { border-style: solid; border-width: 1px; border-color: %STR %STR %STR %STR; border-radius: %INTpx; %STR}\n",id,c1,c2,c2,c1,border_radius,main_bg); + offset = -2 * box_offset; + htrAddStylesheetItem_va(s, + "\t#pn%POSmain {" + "border-style: solid; " + "border-width: 1px; " + "border-color: %STR %STR %STR %STR; " + "}\n", + id, + c1, c2, c2, c1 + ); } else if (style == 3) /* bordered */ { - htrAddStylesheetItem_va(s,"\t#pn%POSmain { POSITION:absolute; VISIBILITY:inherit; overflow: hidden; LEFT:%INTpx; TOP:%INTpx; WIDTH:%POSpx; HEIGHT:%POSpx; Z-INDEX:%POS; }\n",id,x,y,w-2*box_offset,h-2*box_offset,z); - htrAddStylesheetItem_va(s,"\t#pn%POSmain { border-style: solid; border-width: 1px; border-color:%STR&CSSVAL; border-radius: %INTpx; %STR}\n",id,bdr,border_radius,main_bg); + offset = -2 * box_offset; + htrAddStylesheetItem_va(s, + "\t#pn%POSmain {" + "border-style: solid;" + "border-width: 1px; " + "border-color:%STR&CSSVAL; " + "}\n", + id, + bdr + ); } + + htrAddStylesheetItem_va(s, + "\t#pn%POSmain {" + "POSITION:absolute; " + "VISIBILITY:inherit; " + "overflow:hidden; " + "LEFT:%INTpx; " + "TOP:%INTpx; " + "WIDTH:%POSpx; " + "HEIGHT:%POSpx; " + "Z-INDEX:%POS; " + "border-radius: %INTpx;" + "%STR" + "}\n", + id, + x, + y, + w + offset, + h + offset, + z, + border_radius, + main_bg + ); + if (shadow_radius > 0) { - htrAddStylesheetItem_va(s,"\t#pn%POSmain { box-shadow: %POSpx %POSpx %POSpx %STR&CSSVAL; }\n", id, shadow_offset, shadow_offset, shadow_radius, shadow_color); + htrAddStylesheetItem_va(s, + "\t#pn%POSmain { box-shadow: %POSpx %POSpx %POSpx %STR&CSSVAL; }\n", + id, shadow_offset, shadow_offset, shadow_radius, shadow_color + ); } /** DOM linkages **/ From 0f0d1e8783da4bccfd1b3932b12c0d0e08e86fba Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Fri, 27 Jun 2025 16:20:47 -0600 Subject: [PATCH 055/275] Make design responsive by replacing px with %. --- centrallix/htmlgen/ht_render.c | 16 ++++++++-------- centrallix/htmlgen/htdrv_pane.c | 16 ++++++++-------- 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/centrallix/htmlgen/ht_render.c b/centrallix/htmlgen/ht_render.c index 32eb99bdf..084c38e65 100644 --- a/centrallix/htmlgen/ht_render.c +++ b/centrallix/htmlgen/ht_render.c @@ -2694,10 +2694,10 @@ htrFormatElement(pHtSession s, pWgtrNode node, char* id, int flags, int x, int y /** Generate the style CSS **/ htrAddStylesheetItem_va(s, "\t%STR {" - "left:%POSpx; " - "top:%POSpx; " - "%[width:%POSpx; %]" - "%[height:%POSpx; %]" + "left:%DBL%%; " + "top:%DBL%%; " + "%[width:%DBL%%; %]" // BUG! + "%[height:%DBL%%; %]"// BUG! "%[z-index:%POS; %]" "%[color:%STR&CSSVAL; %]" "%[font-weight:bold; %]" @@ -2716,10 +2716,10 @@ htrFormatElement(pHtSession s, pWgtrNode node, char* id, int flags, int x, int y "%[%STR %]" "}\n", id, - x, - y, - (w > 0), w, - (h > 0), h, + (double)x / node->Root->width * 100.0, + (double)y / node->Root->height * 100.0, + (w > 0), (double)w / node->Parent->width * 100.0, + (h > 0), (double)h / node->Parent->height * 100.0, (z > 0), z, (*textcolor), textcolor, (!strcmp(style, "bold")), diff --git a/centrallix/htmlgen/htdrv_pane.c b/centrallix/htmlgen/htdrv_pane.c index 64d5c0e68..86db161d9 100644 --- a/centrallix/htmlgen/htdrv_pane.c +++ b/centrallix/htmlgen/htdrv_pane.c @@ -188,19 +188,19 @@ htpnRender(pHtSession s, pWgtrNode tree, int z) "POSITION:absolute; " "VISIBILITY:inherit; " "overflow:hidden; " - "LEFT:%INTpx; " - "TOP:%INTpx; " - "WIDTH:%POSpx; " - "HEIGHT:%POSpx; " + "LEFT:%DBL%%; " + "TOP:%DBL%%; " + "WIDTH:%DBL%%; " + "HEIGHT:%DBL%%; " "Z-INDEX:%POS; " "border-radius: %INTpx;" "%STR" "}\n", id, - x, - y, - w + offset, - h + offset, + (double)tree->x / tree->Root->width * 100.0, + (double)tree->y / tree->Root->height * 100.0, + (double)(w + offset) / tree->Parent->width * 100.0, + (double)(h + offset) / tree->Parent->height * 100.0, z, border_radius, main_bg From 6f327d59d47e1679fb3ed74149b65e4572da1ee4 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Fri, 27 Jun 2025 16:40:45 -0600 Subject: [PATCH 056/275] Reformat CSS for autolayout. --- centrallix/htmlgen/htdrv_autolayout.c | 25 ++++++++++++++++++++----- 1 file changed, 20 insertions(+), 5 deletions(-) diff --git a/centrallix/htmlgen/htdrv_autolayout.c b/centrallix/htmlgen/htdrv_autolayout.c index 0dee2198b..ae1321182 100644 --- a/centrallix/htmlgen/htdrv_autolayout.c +++ b/centrallix/htmlgen/htdrv_autolayout.c @@ -99,11 +99,26 @@ htalRender(pHtSession s, pWgtrNode tree, int z) strtcpy(name,wgtrGetName(tree),sizeof(name)); /** Add the stylesheet for the layer **/ - htrAddStylesheetItem_va(s,"\t#al%POSbase { POSITION:absolute; VISIBILITY:inherit; OVERFLOW:visible; LEFT:%INTpx; TOP:%INTpx; WIDTH:%POSpx; HEIGHT:%POSpx; Z-INDEX:%POS; }\n", - //htrAddStylesheetItem_va(s,"\t#al%POSbase { POSITION:absolute; VISIBILITY:inherit; OVERFLOW:visible; LEFT:%INTpx; TOP:%INTpx; WIDTH:%POSpx; HEIGHT:%POSpx; CLIP:rect(%INTpx,%INTpx,%INTpx,%INTpx); Z-INDEX:%POS; }\n", - id,x,y,w,h, - //-1, w+1, h+1, -1, - z); + htrAddStylesheetItem_va(s, + "\t#al%POSbase {" + "POSITION:absolute; " + "VISIBILITY:inherit; " + "OVERFLOW:visible; " + "LEFT:%POSpx; " + "TOP:%POSpx; " + "WIDTH:%POSpx; " + "HEIGHT:%POSpx; " + //"CLIP:rect(%INTpx,%INTpx,%INTpx,%INTpx);" + "Z-INDEX:%POS; " + "}\n", + id, + x, + y, + w, + h, + //-1, w+1, h+1, -1, + z + ); /** Linkage **/ htrAddWgtrObjLinkage_va(s, tree, "al%POSbase",id); From 7becc703a0b6821f4ccc4bec06a8237a9d96a41d Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Tue, 1 Jul 2025 13:37:08 -0600 Subject: [PATCH 057/275] Improve debugging. --- centrallix/htmlgen/ht_render.c | 4 ++++ centrallix/htmlgen/htdrv_pane.c | 4 ++-- centrallix/wgtr/wgtr.c | 12 ++++++++++-- 3 files changed, 16 insertions(+), 4 deletions(-) diff --git a/centrallix/htmlgen/ht_render.c b/centrallix/htmlgen/ht_render.c index 084c38e65..7a5919f58 100644 --- a/centrallix/htmlgen/ht_render.c +++ b/centrallix/htmlgen/ht_render.c @@ -1496,6 +1496,10 @@ htr_internal_BuildClientWgtr_r(pHtSession s, pWgtrNode tree, int indent) htr_internal_WriteWgtrProperty(s, tree, "r_y"); htr_internal_WriteWgtrProperty(s, tree, "r_width"); htr_internal_WriteWgtrProperty(s, tree, "r_height"); + htr_internal_WriteWgtrProperty(s, tree, "fl_x"); + htr_internal_WriteWgtrProperty(s, tree, "fl_y"); + htr_internal_WriteWgtrProperty(s, tree, "fl_width"); + htr_internal_WriteWgtrProperty(s, tree, "fl_height"); htr_internal_WriteWgtrProperty(s, tree, "adj_weight_x"); htr_internal_WriteWgtrProperty(s, tree, "adj_weight_y"); htr_internal_WriteWgtrProperty(s, tree, "adj_weight_w"); diff --git a/centrallix/htmlgen/htdrv_pane.c b/centrallix/htmlgen/htdrv_pane.c index 86db161d9..e1503e8b5 100644 --- a/centrallix/htmlgen/htdrv_pane.c +++ b/centrallix/htmlgen/htdrv_pane.c @@ -197,8 +197,8 @@ htpnRender(pHtSession s, pWgtrNode tree, int z) "%STR" "}\n", id, - (double)tree->x / tree->Root->width * 100.0, - (double)tree->y / tree->Root->height * 100.0, + (double)x / tree->Root->width * 100.0, + (double)y / tree->Root->height * 100.0, (double)(w + offset) / tree->Parent->width * 100.0, (double)(h + offset) / tree->Parent->height * 100.0, z, diff --git a/centrallix/wgtr/wgtr.c b/centrallix/wgtr/wgtr.c index fc7d48e79..0fa312f19 100755 --- a/centrallix/wgtr/wgtr.c +++ b/centrallix/wgtr/wgtr.c @@ -1313,7 +1313,8 @@ wgtrGetPropertyType(pWgtrNode widget, char* name) !strcmp(name, "fl_x") || !strcmp(name, "fl_y") || !strcmp(name, "fl_width") || !strcmp(name, "fl_height")) return DATA_T_INTEGER; else if (!strcmp(name, "adj_weight_x") || !strcmp(name, "adj_weight_y") || - !strcmp(name, "adj_weight_w") || !strcmp(name, "adj_weight_h")) + !strcmp(name, "adj_weight_w") || !strcmp(name, "adj_weight_h") || + !strcmp(name, "fx") || !strcmp(name, "fy") || !strcmp(name, "fw") || !strcmp(name, "fh")) return DATA_T_DOUBLE; count = xaCount(&(widget->Properties)); for (i=0;iDouble = widget->fx; return 0; } + else if (!strcmp(name+1, "y")) { val->Double = widget->fy; return 0; } + else if (!strcmp(name+1, "w")) { val->Double = widget->fw; return 0; } + else if (!strcmp(name+1, "h")) { val->Double = widget->fh; return 0; } + } + else if (!strncmp(name, "adj_weight_", 11)) { if (!strcmp(name+11, "x")) { val->Double = (double)widget->xAdjWeight; return 0; } else if (!strcmp(name+11, "y")) { val->Double = (double)widget->yAdjWeight; return 0; } From e3f07570ffb93cdca87f4959f128353acd8d3905 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Tue, 1 Jul 2025 15:52:13 -0600 Subject: [PATCH 058/275] Add flexibility to autoscaling, using macros to make it more readable. --- centrallix/htmlgen/ht_render.c | 16 ++++++++-------- centrallix/htmlgen/htdrv_pane.c | 16 ++++++++-------- centrallix/include/ht_render.h | 4 ++++ 3 files changed, 20 insertions(+), 16 deletions(-) diff --git a/centrallix/htmlgen/ht_render.c b/centrallix/htmlgen/ht_render.c index 7a5919f58..2139ae124 100644 --- a/centrallix/htmlgen/ht_render.c +++ b/centrallix/htmlgen/ht_render.c @@ -2698,10 +2698,10 @@ htrFormatElement(pHtSession s, pWgtrNode node, char* id, int flags, int x, int y /** Generate the style CSS **/ htrAddStylesheetItem_va(s, "\t%STR {" - "left:%DBL%%; " - "top:%DBL%%; " - "%[width:%DBL%%; %]" // BUG! - "%[height:%DBL%%; %]"// BUG! + "left:"ht_flex_format"; " + "top:"ht_flex_format"; " + "%[width:"ht_flex_format"; %]" // BUG! + "%[height:"ht_flex_format"; %]"// BUG! "%[z-index:%POS; %]" "%[color:%STR&CSSVAL; %]" "%[font-weight:bold; %]" @@ -2720,10 +2720,10 @@ htrFormatElement(pHtSession s, pWgtrNode node, char* id, int flags, int x, int y "%[%STR %]" "}\n", id, - (double)x / node->Root->width * 100.0, - (double)y / node->Root->height * 100.0, - (w > 0), (double)w / node->Parent->width * 100.0, - (h > 0), (double)h / node->Parent->height * 100.0, + ht_flex(x, node->Parent->width, 100.0), + ht_flex(y, node->Parent->height, 100.0), + (w > 0), ht_flex(w, node->Parent->width, node->fl_width), + (h > 0), ht_flex(h, node->Parent->height, node->fl_height), (z > 0), z, (*textcolor), textcolor, (!strcmp(style, "bold")), diff --git a/centrallix/htmlgen/htdrv_pane.c b/centrallix/htmlgen/htdrv_pane.c index e1503e8b5..e6fe16338 100644 --- a/centrallix/htmlgen/htdrv_pane.c +++ b/centrallix/htmlgen/htdrv_pane.c @@ -188,19 +188,19 @@ htpnRender(pHtSession s, pWgtrNode tree, int z) "POSITION:absolute; " "VISIBILITY:inherit; " "overflow:hidden; " - "LEFT:%DBL%%; " - "TOP:%DBL%%; " - "WIDTH:%DBL%%; " - "HEIGHT:%DBL%%; " + "LEFT:"ht_flex_format"; " + "TOP:"ht_flex_format"; " + "WIDTH:"ht_flex_format"; " + "HEIGHT:"ht_flex_format"; " "Z-INDEX:%POS; " "border-radius: %INTpx;" "%STR" "}\n", id, - (double)x / tree->Root->width * 100.0, - (double)y / tree->Root->height * 100.0, - (double)(w + offset) / tree->Parent->width * 100.0, - (double)(h + offset) / tree->Parent->height * 100.0, + ht_flex(x, tree->Parent->width, 100.0), + ht_flex(y, tree->Parent->height, 100.0), + ht_flex(w + offset, tree->Parent->width, tree->fl_width), + ht_flex(h + offset, tree->Parent->height, tree->fl_height), z, border_radius, main_bg diff --git a/centrallix/include/ht_render.h b/centrallix/include/ht_render.h index aeded08fe..7e6b20da0 100644 --- a/centrallix/include/ht_render.h +++ b/centrallix/include/ht_render.h @@ -362,5 +362,9 @@ int htrBuildClientWgtr(pHtSession s, pWgtrNode tree); /** For the rule module... **/ int htruleRegister(char* ruletype, ...); +/** My attempt to make flex code more readable. **/ +#define ht_flex_format "calc(%POSpx + (%DBL%% - %POSpx) * %DBL)" +#define ht_flex(size, total, flex) (size), (double)(size) / (total) * 100.0, (size), (double)(flex) / 100.0 + #endif /* _HT_RENDER_H */ From 50111697ac4a00e5232078dcfc2141cce6c1f3a9 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Tue, 1 Jul 2025 17:12:26 -0600 Subject: [PATCH 059/275] Replace magic values for fl_x and fl_y with macros. --- centrallix/htmlgen/ht_render.c | 4 ++-- centrallix/htmlgen/htdrv_pane.c | 4 ++-- centrallix/include/ht_render.h | 7 +++++++ 3 files changed, 11 insertions(+), 4 deletions(-) diff --git a/centrallix/htmlgen/ht_render.c b/centrallix/htmlgen/ht_render.c index 2139ae124..03473eb9b 100644 --- a/centrallix/htmlgen/ht_render.c +++ b/centrallix/htmlgen/ht_render.c @@ -2720,8 +2720,8 @@ htrFormatElement(pHtSession s, pWgtrNode node, char* id, int flags, int x, int y "%[%STR %]" "}\n", id, - ht_flex(x, node->Parent->width, 100.0), - ht_flex(y, node->Parent->height, 100.0), + ht_flex(x, node->Parent->width, ht_fl_x_compat), + ht_flex(y, node->Parent->height, ht_fl_y_compat), (w > 0), ht_flex(w, node->Parent->width, node->fl_width), (h > 0), ht_flex(h, node->Parent->height, node->fl_height), (z > 0), z, diff --git a/centrallix/htmlgen/htdrv_pane.c b/centrallix/htmlgen/htdrv_pane.c index e6fe16338..f9106a2c0 100644 --- a/centrallix/htmlgen/htdrv_pane.c +++ b/centrallix/htmlgen/htdrv_pane.c @@ -197,8 +197,8 @@ htpnRender(pHtSession s, pWgtrNode tree, int z) "%STR" "}\n", id, - ht_flex(x, tree->Parent->width, 100.0), - ht_flex(y, tree->Parent->height, 100.0), + ht_flex(x, tree->Parent->width, ht_fl_x_compat), + ht_flex(y, tree->Parent->height, ht_fl_y_compat), ht_flex(w + offset, tree->Parent->width, tree->fl_width), ht_flex(h + offset, tree->Parent->height, tree->fl_height), z, diff --git a/centrallix/include/ht_render.h b/centrallix/include/ht_render.h index 7e6b20da0..3ef7893f9 100644 --- a/centrallix/include/ht_render.h +++ b/centrallix/include/ht_render.h @@ -366,5 +366,12 @@ int htruleRegister(char* ruletype, ...); #define ht_flex_format "calc(%POSpx + (%DBL%% - %POSpx) * %DBL)" #define ht_flex(size, total, flex) (size), (double)(size) / (total) * 100.0, (size), (double)(flex) / 100.0 +/*** The widget fl_x and fl_y fields are never used in the generated layout. + *** Thus, the CSS I created to add responsiveness uses the values below + *** instead of the provided value to preserve backwards compatibility. + ***/ +#define ht_fl_x_compat 100.0 +#define ht_fl_y_compat 100.0 + #endif /* _HT_RENDER_H */ From 9ea50118b47eb814e7e7d3adc013ae97ee036b72 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Thu, 3 Jul 2025 15:34:08 -0600 Subject: [PATCH 060/275] Improve code documentation and readability. --- centrallix/include/apos.h | 3 ++- centrallix/include/ht_render.h | 6 +++--- centrallix/wgtr/apos.c | 26 ++++++++++++++++---------- 3 files changed, 21 insertions(+), 14 deletions(-) diff --git a/centrallix/include/apos.h b/centrallix/include/apos.h index 70bb49f12..da8792946 100644 --- a/centrallix/include/apos.h +++ b/centrallix/include/apos.h @@ -158,12 +158,13 @@ int aposProcessWindows(pWgtrNode, pWgtrNode); /**Makes a pass through the tree t #define APOS_IS_BORDER 1 #define APOS_NOT_BORDER 0 +/** Allows rounding when casting floats or doubles to ints. */ #define APOS_FUDGEFACTOR 0.5 /*** The greatest width between two widgets that still defines them as *** "adjacent," indicating that we don't want to increase the distance *** between them. Therefore, a section of this size or less is considered - *** a "spacer" which will not be resized. + *** a "spacer" which will not be resized (aka. flex = 0). ***/ #define APOS_MINSPACE 20 diff --git a/centrallix/include/ht_render.h b/centrallix/include/ht_render.h index 3ef7893f9..e0448404f 100644 --- a/centrallix/include/ht_render.h +++ b/centrallix/include/ht_render.h @@ -362,9 +362,9 @@ int htrBuildClientWgtr(pHtSession s, pWgtrNode tree); /** For the rule module... **/ int htruleRegister(char* ruletype, ...); -/** My attempt to make flex code more readable. **/ -#define ht_flex_format "calc(%POSpx + (%DBL%% - %POSpx) * %DBL)" -#define ht_flex(size, total, flex) (size), (double)(size) / (total) * 100.0, (size), (double)(flex) / 100.0 +/** ===================================================== **/ +/** Define macros for implementing responsive dimensions. **/ +/** ===================================================== **/ /*** The widget fl_x and fl_y fields are never used in the generated layout. *** Thus, the CSS I created to add responsiveness uses the values below diff --git a/centrallix/wgtr/apos.c b/centrallix/wgtr/apos.c index d802fca9c..4b476038c 100644 --- a/centrallix/wgtr/apos.c +++ b/centrallix/wgtr/apos.c @@ -78,6 +78,11 @@ *** *** XArray: This array also stores its size (nAlloc) and the number of items *** stored (nItems), so you don't have to pass that info separately. + *** + *** SWidgets, CWidgets, and EWidgets: Lines record which widgets start, cross, + *** and end on them. These categories are exclusive, so a widget which + *** starts on a given line will be in the SWidgets list but it will not be + *** in the CWidgets list. ***/ #include @@ -529,8 +534,10 @@ int i=0, sectCount=0, TotalWidth=0, ProductSum=0; if (!theGrid) return 0; - /** Calculate average row flexibility, weighted by height. **/ - /** Note: Height is called width because rows are 1 dimentional. **/ + /*** Calculate average row flexibility, weighted by height. + *** Note: Section height is called width here because rows + *** are one dimentional and the feild is reused. + ***/ sectCount = xaCount(&(theGrid->Rows)); for(i=0; iFlex) / (float)(TotalFlex); - SizeWeight = 0; - - /** unless there's at least some flexibility, don't factor in size **/ - if(FlexWeight > 0) - SizeWeight = (float)(PrevSect->Width) / (float)(TotalFlexibleSpace); + SizeWeight = (FlexWeight > 0) ? (float)(PrevSect->Width) / (float)(TotalFlexibleSpace) : 0; /*** Calculate the adjustment weight, and also save it so we can *** replicate some of the following logic in the CSS we will @@ -1598,7 +1600,7 @@ pWgtrNode Widget; } } - /** Adjusts width or height of widgets ending on this line **/ + /** Adjusts width or height of widgets ending on this line. **/ count = xaCount(&(CurrLine->EWidgets)); for(j=0; jLoc - Widget->x - isSideTab*tabWidth; + + /** If the new size is now smaller than the minimum, clamp it. **/ if (newsize < APOS_MINWIDTH && Widget->pre_width >= APOS_MINWIDTH) Widget->width = APOS_MINWIDTH; + /** If the size is bigger than the minimum, or growing, that's fine. **/ else if (newsize >= APOS_MINWIDTH || newsize >= Widget->pre_width) Widget->width = newsize; + /** Otherwise, we can't update the size. **/ else /*Widget->width = APOS_MINWIDTH;*/ Widget->width = Widget->pre_width; From 108e14c6778223be3c9532a1e2f18e513d3f8a46 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Thu, 3 Jul 2025 15:36:30 -0600 Subject: [PATCH 061/275] Fix flexibility a little, but it's still broken. --- centrallix/htmlgen/ht_render.c | 8 ++--- centrallix/htmlgen/htdrv_pane.c | 8 ++--- centrallix/include/ht_render.h | 54 +++++++++++++++++++++++++++++++-- centrallix/include/wgtr.h | 4 +-- centrallix/wgtr/apos.c | 31 +++++++++++++------ 5 files changed, 84 insertions(+), 21 deletions(-) diff --git a/centrallix/htmlgen/ht_render.c b/centrallix/htmlgen/ht_render.c index 03473eb9b..0a6844768 100644 --- a/centrallix/htmlgen/ht_render.c +++ b/centrallix/htmlgen/ht_render.c @@ -2720,10 +2720,10 @@ htrFormatElement(pHtSession s, pWgtrNode node, char* id, int flags, int x, int y "%[%STR %]" "}\n", id, - ht_flex(x, node->Parent->width, ht_fl_x_compat), - ht_flex(y, node->Parent->height, ht_fl_y_compat), - (w > 0), ht_flex(w, node->Parent->width, node->fl_width), - (h > 0), ht_flex(h, node->Parent->height, node->fl_height), + ht_flex(x, node->Parent->width, ht_get_fl_x(node)), + ht_flex(y, node->Parent->height, ht_get_fl_y(node)), + (w > 0), ht_flex(w, node->Parent->width, ht_get_fl_w(node)), + (h > 0), ht_flex(h, node->Parent->height, ht_get_fl_h(node)), (z > 0), z, (*textcolor), textcolor, (!strcmp(style, "bold")), diff --git a/centrallix/htmlgen/htdrv_pane.c b/centrallix/htmlgen/htdrv_pane.c index f9106a2c0..9d0f23416 100644 --- a/centrallix/htmlgen/htdrv_pane.c +++ b/centrallix/htmlgen/htdrv_pane.c @@ -197,10 +197,10 @@ htpnRender(pHtSession s, pWgtrNode tree, int z) "%STR" "}\n", id, - ht_flex(x, tree->Parent->width, ht_fl_x_compat), - ht_flex(y, tree->Parent->height, ht_fl_y_compat), - ht_flex(w + offset, tree->Parent->width, tree->fl_width), - ht_flex(h + offset, tree->Parent->height, tree->fl_height), + ht_flex(x, tree->Parent->width, ht_get_fl_x(tree)), + ht_flex(y, tree->Parent->height, ht_get_fl_y(tree)), + ht_flex(w + offset, tree->Parent->width, ht_get_fl_w(tree)), + ht_flex(h + offset, tree->Parent->height, ht_get_fl_h(tree)), z, border_radius, main_bg diff --git a/centrallix/include/ht_render.h b/centrallix/include/ht_render.h index e0448404f..d078ba1e0 100644 --- a/centrallix/include/ht_render.h +++ b/centrallix/include/ht_render.h @@ -370,8 +370,58 @@ int htruleRegister(char* ruletype, ...); *** Thus, the CSS I created to add responsiveness uses the values below *** instead of the provided value to preserve backwards compatibility. ***/ -#define ht_fl_x_compat 100.0 -#define ht_fl_y_compat 100.0 +/** @brief widget->fl_x is never used. Use this instead for compatibility. **/ +#define ht_fl_x_compat 1.0 +/** @brief widget->fl_y is never used. Use this instead for compatibility. **/ +#define ht_fl_y_compat 1.0 + +/** @brief The qprintf format to specify a responsive dimension. **/ +#define ht_flex_format "calc(%INTpx + (%DBL%% - %INTpx) * %DBL)" +/*** @brief The function which generates the values that should be passed to + *** qprintf in order to satisfy an ht_flex_format. + *** + *** @param size The original size of the ui element. + *** @param total The total size of the ui element's container. + *** @param flex The flexibility of the ui element. It is strongly recomended + *** to generate this with an ht_get_fl function call. + *** @returns Several values to serve as parameters for a qprintf call. + ***/ +#define ht_flex(size, total, flex) (size), (double)(size) / (total) * 100.0, (size), (flex) +/*** @param widget The widget to be queried. + *** @returns The flexibility of the widget in the x direction. + ***/ +#define ht_get_fl_x(widget) (ht_fl_x_compat) +/*** @param widget The widget to be queried. + *** @returns The flexibility of the widget in the y direction. + ***/ +#define ht_get_fl_y(widget) (ht_fl_y_compat) +/*** @param widget The widget to be queried. + *** @returns The flexibility of the widget in the width direction. + ***/ +#define ht_get_fl_w(widget) ((widget)->wAdjWeight) +/*** @param widget The widget to be queried. + *** @returns The flexibility of the widget in the height direction. + ***/ +#define ht_get_fl_h(widget) ((widget)->hAdjWeight) +/*** @brief A shortcut function to get the flexibility when writing the + *** LEFT CSS attribute. + *** @param widget The widget to be queried. + *** @returns The flexibility of the widget in the left direction. + ***/ +#define ht_get_fl_l ht_get_fl_x +/*** @brief A shortcut function to get the flexibility when writing the + *** TOP CSS attribute. + *** @param widget The widget to be queried. + *** @returns The flexibility of the widget in the top direction. + ***/ +#define ht_get_fl_t ht_get_fl_y + +/*** Alternate formula suggested in the GitHub Issue. I think this should work + *** and be more efficient, but for some reason it doesn't at all, and I can't + *** understand why. I probably just implemented it wrong. + ***/ +// #define ht_flex_format "calc(%INTpx + (100%% - %INTpx) * %DBL)" +// #define ht_flex(size, total, flex) (size), (total), (double)(flex) / 100.0 #endif /* _HT_RENDER_H */ diff --git a/centrallix/include/wgtr.h b/centrallix/include/wgtr.h index eaf865ff4..f11584f0d 100644 --- a/centrallix/include/wgtr.h +++ b/centrallix/include/wgtr.h @@ -102,8 +102,8 @@ typedef struct _WN int pre_x, pre_y, pre_width, pre_height; /** pre-layout geom. **/ int fl_x, fl_y, fl_width, fl_height;/** Flexibility **/ double fx, fy, fw, fh; /** internal flexibility calculations **/ - float xAdjWeight, yAdjWeight; /** Responsive CSS adjustment weights for x and y */ - float wAdjWeight, hAdjWeight; /** Responsive CSS adjustment weights for width and height */ + double xAdjWeight, yAdjWeight; /** Responsive CSS adjustment weights for x and y */ + double wAdjWeight, hAdjWeight; /** Responsive CSS adjustment weights for width and height */ int min_width, min_height; /** absolute minimums **/ int x, y, width, height; /** actual geometry **/ int top, bottom, left, right; /** container offsets **/ diff --git a/centrallix/wgtr/apos.c b/centrallix/wgtr/apos.c index 4b476038c..619736703 100644 --- a/centrallix/wgtr/apos.c +++ b/centrallix/wgtr/apos.c @@ -1505,20 +1505,20 @@ float TotalSum=0; *** eventually send to the client. ***/ float AdjWeight = PrevSect->AdjWeight = (float)(FlexWeight*SizeWeight)/TotalSum; + + /** Store the line adjustment weight for responsive CSS later.**/ + CurrLine->LocAdjWeight = PrevLine->LocAdjWeight + AdjWeight; + CurrLine->MyAdjWeight = AdjWeight; /**for expanding lines**/ if(Diff > 0) { /** Calculate adjustment using the adjustment weight. **/ Adj = (float)(Diff) * AdjWeight + APOS_FUDGEFACTOR; - - /** Store the line adjustment weight for responsive CSS later.**/ - CurrLine->LocAdjWeight = PrevLine->LocAdjWeight + AdjWeight; - CurrLine->MyAdjWeight = AdjWeight; /** Apply the calculated adjustment.**/ - CurrLine->Loc = PrevLine->Loc + PrevSect->Width + Adj; PrevSect->Width += Adj; + CurrLine->Loc = PrevLine->Loc + PrevSect->Width; } /**for contracting lines**/ else if(Diff < 0) @@ -1551,8 +1551,8 @@ float TotalSum=0; } else { - CurrLine->Loc = PrevLine->Loc + PrevSect->Width + Adj; PrevSect->Width += Adj; + CurrLine->Loc = PrevLine->Loc + PrevSect->Width; } } } @@ -1623,11 +1623,11 @@ pWgtrNode Widget; *** to problems down the road, but I plan to fix *** them if and when I encounter them. ***/ - Widget->hAdjWeight = CurrLine->MyAdjWeight; + Widget->hAdjWeight += CurrLine->MyAdjWeight; } else if(flag==APOS_COL && Widget->fl_width) { - /** Calculate the new size, taking APOS_MINWIDTH into account.**/ + /** Calculate the new size, taking APOS_MINWIDTH into account. **/ newsize = CurrLine->Loc - Widget->x - isSideTab*tabWidth; /** If the new size is now smaller than the minimum, clamp it. **/ @@ -1646,9 +1646,22 @@ pWgtrNode Widget; *** to problems down the road, but I plan to fix *** them if and when I encounter them. ***/ - Widget->hAdjWeight = CurrLine->MyAdjWeight; + Widget->wAdjWeight += CurrLine->MyAdjWeight; } } + + /** Adjusts width or height of widgets ending on this line. **/ + count = xaCount(&(CurrLine->CWidgets)); + printf("Doing %d widgets.\n", count); + for(j=0; jCWidgets), j); + if(flag==APOS_ROW && Widget->fl_height) + Widget->hAdjWeight += CurrLine->MyAdjWeight; + else if(flag==APOS_COL && Widget->fl_width) + Widget->wAdjWeight += CurrLine->MyAdjWeight; + } + } return 0; From bbc0db3847c7f4cde2d6160e947a8e8f978a38c7 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Thu, 3 Jul 2025 15:37:24 -0600 Subject: [PATCH 062/275] Attempt to add responsiveness to widgets (doesn't quite work): autolayout, button, editbox, html, image, label, scrollpane, textbutton, & treeview. --- centrallix/htmlgen/htdrv_autolayout.c | 20 ++-- centrallix/htmlgen/htdrv_button.c | 100 +++++++++++++++--- centrallix/htmlgen/htdrv_editbox.c | 38 ++++++- centrallix/htmlgen/htdrv_html.c | 62 +++++++++-- centrallix/htmlgen/htdrv_image.c | 17 ++- centrallix/htmlgen/htdrv_label.c | 57 ++++++++-- centrallix/htmlgen/htdrv_scrollpane.c | 144 ++++++++++++++++++++++++-- centrallix/htmlgen/htdrv_textbutton.c | 48 ++++++--- centrallix/htmlgen/htdrv_treeview.c | 43 +++++++- 9 files changed, 458 insertions(+), 71 deletions(-) diff --git a/centrallix/htmlgen/htdrv_autolayout.c b/centrallix/htmlgen/htdrv_autolayout.c index ae1321182..66b7f83e0 100644 --- a/centrallix/htmlgen/htdrv_autolayout.c +++ b/centrallix/htmlgen/htdrv_autolayout.c @@ -100,23 +100,21 @@ htalRender(pHtSession s, pWgtrNode tree, int z) /** Add the stylesheet for the layer **/ htrAddStylesheetItem_va(s, - "\t#al%POSbase {" + "\t#al%POSbase { " "POSITION:absolute; " "VISIBILITY:inherit; " "OVERFLOW:visible; " - "LEFT:%POSpx; " - "TOP:%POSpx; " - "WIDTH:%POSpx; " - "HEIGHT:%POSpx; " - //"CLIP:rect(%INTpx,%INTpx,%INTpx,%INTpx);" + "LEFT:"ht_flex_format"; " + "TOP:"ht_flex_format"; " + "WIDTH:"ht_flex_format"; " + "HEIGHT:"ht_flex_format"; " "Z-INDEX:%POS; " "}\n", id, - x, - y, - w, - h, - //-1, w+1, h+1, -1, + ht_flex(x, tree->Parent->width, ht_get_fl_x(tree)), + ht_flex(y, tree->Parent->height, ht_get_fl_y(tree)), + ht_flex(w, tree->Parent->width, ht_get_fl_w(tree)), + ht_flex(h, tree->Parent->height, ht_get_fl_h(tree)), z ); diff --git a/centrallix/htmlgen/htdrv_button.c b/centrallix/htmlgen/htdrv_button.c index 67439566e..1779b54be 100644 --- a/centrallix/htmlgen/htdrv_button.c +++ b/centrallix/htmlgen/htdrv_button.c @@ -150,7 +150,21 @@ htbtnRender(pHtSession s, pWgtrNode tree, int z) if (!strcmp(type,"image") || !strcmp(type,"textoverimage")) { - htrAddStylesheetItem_va(s,"\t#gb%POSpane { POSITION:absolute; VISIBILITY:inherit; LEFT:%INTpx; TOP:%INTpx; WIDTH:%POSpx; Z-INDEX:%POS; }\n",id,x,y,w,z); + htrAddStylesheetItem_va(s, + "\t#gb%POSpane { " + "POSITION:absolute; " + "VISIBILITY:inherit; " + "LEFT:"ht_flex_format"; " + "TOP:"ht_flex_format"; " + "WIDTH:"ht_flex_format"; " + "Z-INDEX:%POS; " + "}\n", + id, + ht_flex(x, tree->Parent->width, ht_get_fl_x(tree)), + ht_flex(y, tree->Parent->height, ht_get_fl_y(tree)), + ht_flex(w, tree->Parent->width, ht_get_fl_w(tree)), + z + ); htrAddScriptGlobal(s, "gb_cur_img", "null", 0); htrAddScriptGlobal(s, "gb_current", "null", 0); @@ -191,10 +205,24 @@ htbtnRender(pHtSession s, pWgtrNode tree, int z) } /* text over image */ if(!strcmp(type,"textoverimage")) - { - htrAddStylesheetItem_va(s,"\t#gb%POSpane2 { POSITION:absolute; VISIBILITY:inherit; LEFT:%INTpx; TOP:%INTpx; WIDTH:%POSpx; Z-INDEX:%POS; }\n",id,0,0,w,z+1); - htrAddBodyItem_va(s,"
%STR&HTE
\n",id,h,fgcolor1,text); - } + { + htrAddStylesheetItem_va(s, + "\t#gb%POSpane2 { " + "POSITION:absolute; " + "VISIBILITY:inherit; " + "LEFT:%POS; " + "TOP:%POS; " + "WIDTH:"ht_flex_format"; " + "Z-INDEX:%POS; " + "}\n", + id, + 0, + 0, + ht_flex(w, tree->Parent->width, ht_get_fl_w(tree)), + z+1 + ); + htrAddBodyItem_va(s,"
%STR&HTE
\n",id,h,fgcolor1,text); + } else htrAddBodyItem_va(s,""); } @@ -226,11 +254,11 @@ htbtnRender(pHtSession s, pWgtrNode tree, int z) if(s->Capabilities.Dom0NS) { /** Ok, write the style header items. **/ - htrAddStylesheetItem_va(s,"\t#gb%POSpane { POSITION:absolute; VISIBILITY:inherit; LEFT:%INT; TOP:%INT; WIDTH:%POS; Z-INDEX:%POS; }\n",id,x,y,w,z); - htrAddStylesheetItem_va(s,"\t#gb%POSpane2 { POSITION:absolute; VISIBILITY:%STR; LEFT:-1; TOP:-1; WIDTH:%POS; Z-INDEX:%POS; }\n",id,is_enabled?"inherit":"hidden",w-1,z+1); - htrAddStylesheetItem_va(s,"\t#gb%POSpane3 { POSITION:absolute; VISIBILITY:%STR; LEFT:0; TOP:0; WIDTH:%POS; Z-INDEX:%POS; }\n",id,is_enabled?"hidden":"inherit",w-1,z+1); - htrAddStylesheetItem_va(s,"\t#gb%POStop { POSITION:absolute; VISIBILITY:%STR; LEFT:0; TOP:0; HEIGHT:1; WIDTH:%POS; Z-INDEX:%POS; }\n",id,is_ts?"hidden":"inherit",w,z+2); - htrAddStylesheetItem_va(s,"\t#gb%POSbtm { POSITION:absolute; VISIBILITY:%STR; LEFT:0; TOP:0; HEIGHT:1; WIDTH:%POS; Z-INDEX:%POS; }\n",id,is_ts?"hidden":"inherit",w,z+2); + htrAddStylesheetItem_va(s,"\t#gb%POSpane { POSITION:absolute; VISIBILITY:inherit; LEFT:"ht_flex_format"; TOP:"ht_flex_format"; WIDTH:"ht_flex_format"; Z-INDEX:%POS; }\n",id,ht_flex(x,tree->Parent->width,ht_get_fl_x(tree)),ht_flex(y,tree->Parent->height,ht_get_fl_y(tree)),ht_flex(w,tree->Parent->width,ht_get_fl_w(tree)),z); + htrAddStylesheetItem_va(s,"\t#gb%POSpane2 { POSITION:absolute; VISIBILITY:%STR; LEFT:-1; TOP:-1; WIDTH:"ht_flex_format"; Z-INDEX:%POS; }\n",id,is_enabled?"inherit":"hidden",ht_flex(w,tree->Parent->width,ht_get_fl_w(tree)),z+1); + htrAddStylesheetItem_va(s,"\t#gb%POSpane3 { POSITION:absolute; VISIBILITY:%STR; LEFT:0; TOP:0; WIDTH:"ht_flex_format"; Z-INDEX:%POS; }\n",id,is_enabled?"hidden":"inherit",ht_flex(w-1,tree->Parent->width,ht_get_fl_w(tree)),z+1); + htrAddStylesheetItem_va(s,"\t#gb%POStop { POSITION:absolute; VISIBILITY:%STR; LEFT:0; TOP:0; HEIGHT:1; WIDTH:"ht_flex_format"; Z-INDEX:%POS; }\n",id,is_ts?"hidden":"inherit",ht_flex(w,tree->Parent->width,ht_get_fl_w(tree)),z+2); + htrAddStylesheetItem_va(s,"\t#gb%POSbtm { POSITION:absolute; VISIBILITY:%STR; LEFT:0; TOP:0; HEIGHT:1; WIDTH:"ht_flex_format"; Z-INDEX:%POS; }\n",id,is_ts?"hidden":"inherit",ht_flex(w,tree->Parent->width,ht_get_fl_w(tree)),z+2); htrAddStylesheetItem_va(s,"\t#gb%POSrgt { POSITION:absolute; VISIBILITY:%STR; LEFT:0; TOP:0; HEIGHT:1; WIDTH:1; Z-INDEX:%POS; }\n",id,is_ts?"hidden":"inherit",z+2); htrAddStylesheetItem_va(s,"\t#gb%POSlft { POSITION:absolute; VISIBILITY:%STR; LEFT:0; TOP:0; HEIGHT:1; WIDTH:1; Z-INDEX:%POS; }\n",id,is_ts?"hidden":"inherit",z+2); @@ -307,19 +335,59 @@ htbtnRender(pHtSession s, pWgtrNode tree, int z) { if(h >=0 ) { - htrAddStylesheetItem_va(s,"\t#gb%POSpane { POSITION:absolute; VISIBILITY:inherit; LEFT:%INTpx; TOP:%INTpx; WIDTH:%POSpx; Z-INDEX:%POS; OVERFLOW:hidden; clip:rect(%INTpx %INTpx %INTpx %INTpx)}\n",id,x,y,w-1-2*box_offset,z,0,w-1-2*box_offset+2*clip_offset,h-1-2*box_offset+2*clip_offset,0); - htrAddStylesheetItem_va(s,"\t#gb%POSpane2, #gb%POSpane3 { height: %POSpx;}\n",id,id,h-3); - htrAddStylesheetItem_va(s,"\t#gb%POSpane { height: %POSpx;}\n",id,h-1-2*box_offset); + htrAddStylesheetItem_va(s, + "\t#gb%POSpane { " + "POSITION:absolute; " + "VISIBILITY:inherit; " + "OVERFLOW:hidden; " + "LEFT:"ht_flex_format"; " + "TOP:"ht_flex_format"; " + "WIDTH:"ht_flex_format"; " + "CLIP:rect(" + "0, " + ht_flex_format", " + ht_flex_format", " + "0" + "); " + "Z-INDEX:%POS; " + "}\n", + id, + ht_flex(x, tree->Parent->width, ht_get_fl_x(tree)), + ht_flex(y, tree->Parent->height, ht_get_fl_y(tree)), + ht_flex(w-1-2*box_offset, tree->Parent->width, ht_get_fl_w(tree)), + ht_flex(w-1-2*box_offset+2*clip_offset, tree->Parent->width, ht_get_fl_w(tree)), + ht_flex(h-1-2*box_offset+2*clip_offset, tree->Parent->height, ht_get_fl_h(tree)), + z + ); + htrAddStylesheetItem_va(s,"\t#gb%POSpane2, #gb%POSpane3 { height: "ht_flex_format";}\n",id,id,ht_flex(h-3,tree->Parent->height,ht_get_fl_h(tree))); + htrAddStylesheetItem_va(s,"\t#gb%POSpane { height: "ht_flex_format";}\n",id,ht_flex(h-1-2*box_offset,tree->Parent->height,ht_get_fl_h(tree))); } else { - htrAddStylesheetItem_va(s,"\t#gb%POSpane { POSITION:absolute; VISIBILITY:inherit; LEFT:%INTpx; TOP:%INTpx; WIDTH:%POSpx; Z-INDEX:%POS; OVERFLOW:hidden; clip:rect(%INTpx %INTpx auto %INTpx)}\n",id,x,y,w-1-2*box_offset,z,0,w-1-2*box_offset+2*clip_offset,0); + htrAddStylesheetItem_va(s, + "\t#gb%POSpane { " + "POSITION:absolute; " + "VISIBILITY:inherit; " + "OVERFLOW:hidden; " + "LEFT:"ht_flex_format"; " + "TOP:"ht_flex_format"; " + "WIDTH:"ht_flex_format"; " + "CLIP:rect(0, "ht_flex_format", auto, 0);" + "Z-INDEX:%POS; " + "}\n", + id, + ht_flex(x, tree->Parent->width, ht_get_fl_x(tree)), + ht_flex(y, tree->Parent->height, ht_get_fl_y(tree)), + ht_flex(w-1-2*box_offset, tree->Parent->width, ht_get_fl_w(tree)), + ht_flex(w-1-2*box_offset+2*clip_offset, tree->Parent->width, ht_get_fl_w(tree)), + z + ); } htrAddStylesheetItem_va(s,"\t#gb%POSpane, #gb%POSpane2, #gb%POSpane3 { cursor:default; text-align: center; }\n",id,id,id); htrAddStylesheetItem_va(s,"\t#gb%POSpane { %STR border-width: 1px; border-style: solid; border-color: white gray gray white; }\n",id,bgstyle); /*htrAddStylesheetItem_va(s,"\t#gb%dpane { color: %s; }\n",id,fgcolor2);*/ - htrAddStylesheetItem_va(s,"\t#gb%POSpane2 { VISIBILITY: %STR; Z-INDEX: %INT; position: absolute; left:-1px; top: -1px; width:%POSpx; }\n",id,is_enabled?"inherit":"hidden",z+1,w-3); - htrAddStylesheetItem_va(s,"\t#gb%POSpane3 { VISIBILITY: %STR; Z-INDEX: %INT; position: absolute; left:0px; top: 0px; width:%POSpx; }\n",id,is_enabled?"hidden":"inherit",z+1,w-3); + htrAddStylesheetItem_va(s,"\t#gb%POSpane2 { VISIBILITY: %STR; Z-INDEX: %INT; position: absolute; left:-1px; top: -1px; width:"ht_flex_format"; }\n",id,is_enabled?"inherit":"hidden",z+1,ht_flex(w-3,tree->Parent->width,ht_get_fl_w(tree))); + htrAddStylesheetItem_va(s,"\t#gb%POSpane3 { VISIBILITY: %STR; Z-INDEX: %INT; position: absolute; left:0px; top: 0px; width:"ht_flex_format"; }\n",id,is_enabled?"hidden":"inherit",z+1,ht_flex(w-3,tree->Parent->width,ht_get_fl_w(tree))); if(!strcmp(type,"text")) { diff --git a/centrallix/htmlgen/htdrv_editbox.c b/centrallix/htmlgen/htdrv_editbox.c index 0223038f9..7290692a7 100644 --- a/centrallix/htmlgen/htdrv_editbox.c +++ b/centrallix/htmlgen/htdrv_editbox.c @@ -149,8 +149,35 @@ htebRender(pHtSession s, pWgtrNode tree, int z) box_offset = 0; /** Ok, write the style header items. **/ - htrAddStylesheetItem_va(s,"\t#eb%POSbase { POSITION:absolute; VISIBILITY:inherit; LEFT:%INTpx; TOP:%INTpx; WIDTH:%POSpx; Z-INDEX:%POS; overflow:hidden; }\n",id,x,y,w-2*box_offset,z); - htrAddStylesheetItem_va(s,"\t#eb%POScon1 { VISIBILITY:inherit; LEFT:%INTpx; TOP:%INTpx; WIDTH:%POSpx; Z-INDEX:%POS; border:none; }\n",id,5,0,w-10,z+1); + htrAddStylesheetItem_va(s, + "\t#eb%POSbase { " + "POSITION:absolute; " + "VISIBILITY:inherit; " + "LEFT:"ht_flex_format"; " + "TOP:"ht_flex_format"; " + "WIDTH:"ht_flex_format"; " + "Z-INDEX:%POS; " + "overflow:hidden; " + "}\n", + id, + ht_flex(x, tree->Parent->width, ht_get_fl_x(tree)), + ht_flex(y, tree->Parent->height, ht_get_fl_y(tree)), + ht_flex(w - 2 * box_offset, tree->Parent->width, ht_get_fl_w(tree)), + z + ); + htrAddStylesheetItem_va(s, + "\t#eb%POScon1 { " + "VISIBILITY:inherit; " + "LEFT:5px; " + "TOP:0px; " + "WIDTH:"ht_flex_format"; " + "Z-INDEX:%POS; " + "border:none; " + "}\n", + id, + ht_flex(w - 10, tree->Parent->width, ht_get_fl_w(tree)), + z+1 + ); /** Write named global **/ htrAddWgtrObjLinkage_va(s, tree, "eb%POSbase",id); @@ -187,7 +214,12 @@ htebRender(pHtSession s, pWgtrNode tree, int z) else htrAddStylesheetItem_va(s,"\t#eb%POSbase { border-style:solid; border-width:1px; border-color: gray white white gray; %STR }\n",id, main_bg); if (h >= 0) - htrAddStylesheetItem_va(s,"\t#eb%POSbase { height:%POSpx; }\n\t#eb%POScon1 { height:%POSpx; }\n", id, h-2*box_offset, id, h-2*box_offset-2); + htrAddStylesheetItem_va(s, + "\t#eb%POSbase { height:"ht_flex_format"; }\n" + "\t#eb%POScon1 { height:"ht_flex_format"; }\n", + id, ht_flex(h - 2 * box_offset, tree->Parent->height, ht_get_fl_h(tree)), + id, ht_flex(h - 2 * box_offset - 2, tree->Parent->height, ht_get_fl_h(tree)) + ); //htrAddBodyItem_va(s, "
 
\n", w-2, h-2); //htrAddBodyItem_va(s, "
\n",id); diff --git a/centrallix/htmlgen/htdrv_html.c b/centrallix/htmlgen/htdrv_html.c index 9b899802a..3e7238209 100644 --- a/centrallix/htmlgen/htdrv_html.c +++ b/centrallix/htmlgen/htdrv_html.c @@ -101,17 +101,59 @@ hthtmlRender(pHtSession s, pWgtrNode tree, int z) { /** Only give x and y if supplied. **/ if (x < 0 || y < 0) - { - htrAddStylesheetItem_va(s,"\t#ht%POSpane { POSITION:relative; VISIBILITY:inherit; WIDTH:%POSpx; Z-INDEX:%POS; }\n",id,w,z); - htrAddStylesheetItem_va(s,"\t#ht%POSpane2 { POSITION:relative; VISIBILITY:hidden; WIDTH:%POSpx; Z-INDEX:%POS; }\n",id,w,z); - htrAddStylesheetItem_va(s,"\t#ht%POSfader { POSITION:relative; VISIBILITY:hidden; WIDTH:%POSpx; Z-INDEX:%POS; }\n",id,w,z+1); - } + { + htrAddStylesheetItem_va(s,"\t#ht%POSpane { POSITION:relative; VISIBILITY:inherit; WIDTH:"ht_flex_format"; Z-INDEX:%POS; }\n",id,ht_flex(w,tree->Parent->width,ht_get_fl_w(tree)),z); + htrAddStylesheetItem_va(s,"\t#ht%POSpane2 { POSITION:relative; VISIBILITY:hidden; WIDTH:"ht_flex_format"; Z-INDEX:%POS; }\n",id,ht_flex(w,tree->Parent->width,ht_get_fl_w(tree)),z); + htrAddStylesheetItem_va(s,"\t#ht%POSfader { POSITION:relative; VISIBILITY:hidden; WIDTH:"ht_flex_format"; Z-INDEX:%POS; }\n",id,ht_flex(w,tree->Parent->width,ht_get_fl_w(tree)),z+1); + } else - { - htrAddStylesheetItem_va(s,"\t#ht%POSpane { POSITION:absolute; VISIBILITY:inherit; LEFT:%INTpx; TOP:%INTpx; WIDTH:%POSpx; Z-INDEX:%POS; }\n",id,x,y,w,z); - htrAddStylesheetItem_va(s,"\t#ht%POSpane2 { POSITION:absolute; VISIBILITY:hidden; LEFT:%INTpx; TOP:%INTpx; WIDTH:%POSpx; Z-INDEX:%POS; }\n",id,x,y,w,z); - htrAddStylesheetItem_va(s,"\t#ht%POSfader { POSITION:absolute; VISIBILITY:hidden; LEFT:%INTpx; TOP:%INTpx; WIDTH:%POSpx; Z-INDEX:%POS; }\n",id,x,y,w,z+1); - } + { + htrAddStylesheetItem_va(s, + "\t#ht%POSpane { " + "POSITION:absolute; " + "VISIBILITY:inherit; " + "LEFT:"ht_flex_format"; " + "TOP:"ht_flex_format"; " + "WIDTH:"ht_flex_format"; " + "Z-INDEX:%POS; " + "}\n", + id, + ht_flex(x, tree->Parent->width, ht_get_fl_x(tree)), + ht_flex(y, tree->Parent->height, ht_get_fl_y(tree)), + ht_flex(w, tree->Parent->width, ht_get_fl_w(tree)), + z + ); + htrAddStylesheetItem_va(s, + "\t#ht%POSpane2 { " + "POSITION:absolute; " + "VISIBILITY:hidden; " + "LEFT:"ht_flex_format"; " + "TOP:"ht_flex_format"; " + "WIDTH:"ht_flex_format"; " + "Z-INDEX:%POS; " + "}\n", + id, + ht_flex(x, tree->Parent->width, ht_get_fl_x(tree)), + ht_flex(y, tree->Parent->height, ht_get_fl_y(tree)), + ht_flex(w, tree->Parent->width, ht_get_fl_w(tree)), + z + ); + htrAddStylesheetItem_va(s, + "\t#ht%POSfader { " + "POSITION:absolute; " + "VISIBILITY:hidden; " + "LEFT:"ht_flex_format"; " + "TOP:"ht_flex_format"; " + "WIDTH:"ht_flex_format"; " + "Z-INDEX:%POS; " + "}\n", + id, + ht_flex(x, tree->Parent->width, ht_get_fl_x(tree)), + ht_flex(y, tree->Parent->height, ht_get_fl_y(tree)), + ht_flex(w, tree->Parent->width, ht_get_fl_w(tree)), + z+1 + ); + } if (s->Capabilities.CSS1) { diff --git a/centrallix/htmlgen/htdrv_image.c b/centrallix/htmlgen/htdrv_image.c index 7ea3b9d47..b7195771b 100644 --- a/centrallix/htmlgen/htdrv_image.c +++ b/centrallix/htmlgen/htdrv_image.c @@ -145,7 +145,22 @@ htimgRender(pHtSession s, pWgtrNode tree, int z) form[0]='\0'; /** Ok, write the style header items. **/ - htrAddStylesheetItem_va(s,"\t#img%POS { left:%INTpx; top:%INTpx; width:%POSpx; height:%POSpx; z-index:%POS; text-align:center; }\n",id,x,y,w,h,z); + htrAddStylesheetItem_va(s, + "\t#img%POS { " + "left:"ht_flex_format"; " + "top:"ht_flex_format"; " + "width:"ht_flex_format"; " + "height:"ht_flex_format"; " + "z-index:%POS; " + "text-align:center; " + "}\n", + id, + ht_flex(x, tree->Parent->width, ht_get_fl_x(tree)), + ht_flex(y, tree->Parent->height, ht_get_fl_y(tree)), + ht_flex(w, tree->Parent->width, ht_get_fl_w(tree)), + ht_flex(h, tree->Parent->height, ht_get_fl_h(tree)), + z + ); /** Init image widget (?) **/ htrAddWgtrObjLinkage_va(s, tree, "img%POS",id); diff --git a/centrallix/htmlgen/htdrv_label.c b/centrallix/htmlgen/htdrv_label.c index d7140489f..27f53c9d2 100644 --- a/centrallix/htmlgen/htdrv_label.c +++ b/centrallix/htmlgen/htdrv_label.c @@ -197,17 +197,60 @@ htlblRender(pHtSession s, pWgtrNode tree, int z) form[0]='\0'; /** Ok, write the style header items. **/ - htrAddStylesheetItem_va(s,"\t#lbl%POS { POSITION:absolute; VISIBILITY:inherit; LEFT:%INTpx; TOP:%INTpx; %[HEIGHT:%POSpx; %]WIDTH:%POSpx; Z-INDEX:%POS; cursor:default; %[font-weight:bold; %]%[color:%STR&CSSVAL; %]%[font-size:%POSpx; %]text-align:%STR&CSSVAL; vertical-align:%STR&CSSVAL; %[white-space:nowrap; %]%[text-overflow:ellipsis; overflow:hidden; %]%[font-style:italic; %]}\n", - id,x,y, - !auto_height, h, - w,z, - is_bold, *fgcolor, fgcolor, font_size > 0, font_size, align, valign, - !allow_break, overflow_ellipsis, is_italic); + htrAddStylesheetItem_va(s, + "\t#lbl%POS { " + "POSITION:absolute; " + "VISIBILITY:inherit; " + "LEFT:"ht_flex_format"; " + "TOP:"ht_flex_format"; " + "WIDTH:"ht_flex_format"; " + "%[HEIGHT:"ht_flex_format"; %]" + "Z-INDEX:%POS; " + "cursor:default; " + "%[font-weight:bold; %]" + "%[color:%STR&CSSVAL; %]" + "%[font-size:%POSpx; %]" + "text-align:%STR&CSSVAL; " + "vertical-align:%STR&CSSVAL; " + "%[white-space:nowrap; %]" + "%[text-overflow:ellipsis; overflow:hidden; %]" + "%[font-style:italic; %]" + "}\n", + id, + ht_flex(x, tree->Parent->width, ht_get_fl_x(tree)), + ht_flex(y, tree->Parent->height, ht_get_fl_y(tree)), + ht_flex(w, tree->Parent->width, ht_get_fl_w(tree)), + (!auto_height), ht_flex(h, tree->Parent->height, ht_get_fl_h(tree)), + z, + (is_bold), + (*fgcolor), fgcolor, + (font_size > 0), font_size, + align, + valign, + (!allow_break), + (overflow_ellipsis), + (is_italic) + ); + if (is_link) htrAddStylesheetItem_va(s,"\t#lbl%POS:hover { %[color:%STR&CSSVAL; %]text-decoration:underline; cursor:pointer; }\n", id, *pfgcolor, pfgcolor); if (is_link && *cfgcolor) htrAddStylesheetItem_va(s,"\t#lbl%POS:active { color:%STR&CSSVAL; text-decoration:underline; cursor:pointer; }\n", id, cfgcolor); - htrAddStylesheetItem_va(s,"\t#lbl%POS p { text-align:%STR&CSSVAL; %[position:relative; top:50%%; transform:translateY(-50%%); %]padding:0px; margin:0px; border-spacing:0px; width:%POSpx; }\n", id, align, !strcmp(valign, "middle"), w); + + htrAddStylesheetItem_va(s, + "\t#lbl%POS p { " + "text-align:%STR&CSSVAL; " + "%[position:relative; top:50%%; transform:translateY(-50%%); %]" + "padding:0px; " + "margin:0px; " + "border-spacing:0px; " + "width:"ht_flex_format"; " + "}\n", + id, + align, + !strcmp(valign, "middle"), + ht_flex(w, tree->Parent->width, ht_get_fl_w(tree)) + ); htrAddWgtrObjLinkage_va(s, tree, "lbl%POS",id); stylestr[0] = '\0'; diff --git a/centrallix/htmlgen/htdrv_scrollpane.c b/centrallix/htmlgen/htdrv_scrollpane.c index db1a6ec40..3ceafbd4d 100644 --- a/centrallix/htmlgen/htdrv_scrollpane.c +++ b/centrallix/htmlgen/htdrv_scrollpane.c @@ -118,9 +118,52 @@ htspaneRender(pHtSession s, pWgtrNode tree, int z) /** Ok, write the style header items. **/ if (s->Capabilities.Dom0NS) { - htrAddStylesheetItem_va(s,"\t#sp%POSpane { POSITION:absolute; VISIBILITY:%STR; LEFT:%INTpx; TOP:%INTpx; WIDTH:%POSpx; HEIGHT:%POSpx; clip:rect(0px,%POSpx,%POSpx,0px); Z-INDEX:%POS; }\n",id,visible?"inherit":"hidden",x,y,w,h,w,h, z); - htrAddStylesheetItem_va(s,"\t#sp%POSarea { POSITION:absolute; VISIBILITY:inherit; LEFT:0px; TOP:0px; WIDTH:%POSpx; Z-INDEX:%POS; }\n",id,w-18,z+1); - htrAddStylesheetItem_va(s,"\t#sp%POSthum { POSITION:absolute; VISIBILITY:inherit; LEFT:%INTpx; TOP:18px; WIDTH:18px; Z-INDEX:%POS; }\n",id,w-18,z+1); + htrAddStylesheetItem_va(s, + "\t#sp%POSpane { " + "POSITION:absolute; " + "VISIBILITY:%STR; " + "LEFT:"ht_flex_format"; " + "TOP:"ht_flex_format"; " + "WIDTH:"ht_flex_format"; " + "HEIGHT:"ht_flex_format"; " + "clip:rect(0px, "ht_flex_format", "ht_flex_format", 0px); " + "Z-INDEX:%POS; " + "}\n", + id, + (visible) ? "inherit" : "hidden", + ht_flex(x, tree->Parent->width, ht_get_fl_x(tree)), + ht_flex(y, tree->Parent->height, ht_get_fl_y(tree)), + ht_flex(w, tree->Parent->width, ht_get_fl_w(tree)), + ht_flex(h, tree->Parent->height, ht_get_fl_h(tree)), + ht_flex(w, tree->Parent->width, ht_get_fl_w(tree)), ht_flex(h, tree->Parent->height, ht_get_fl_h(tree)), + z + ); + htrAddStylesheetItem_va(s, + "\t#sp%POSarea { " + "POSITION:absolute; " + "VISIBILITY:inherit; " + "LEFT:0px; " + "TOP:0px; " + "WIDTH:"ht_flex_format"; " + "Z-INDEX:%POS; " + "}\n", + id, + ht_flex(w - 18, tree->Parent->width, ht_get_fl_w(tree)), + z + 1 + ); + htrAddStylesheetItem_va(s, + "\t#sp%POSthum { " + "POSITION:absolute; " + "VISIBILITY:inherit; " + "LEFT:"ht_flex_format"; " + "TOP:18px; " + "WIDTH:18px; " + "Z-INDEX:%POS; " + "}\n", + id, + ht_flex(w - 18, tree->Parent->width, ht_get_fl_x(tree)), + z + 1 + ); } /** Write globals for internal use **/ @@ -155,15 +198,98 @@ htspaneRender(pHtSession s, pWgtrNode tree, int z) //htrAddStylesheetItem_va(s,"\t#sp%dpane { POSITION:absolute; VISIBILITY:%s; LEFT:%dpx; TOP:%dpx; WIDTH:%dpx; HEIGHT:%dpx; clip:rect(0px,%dpx,%dpx,0px); Z-INDEX:%d; }\n",id,visible?"inherit":"hidden",x,y,w,h,w,h, z); //htrAddStylesheetItem_va(s,"\t#sp%darea { HEIGHT: %dpx; WIDTH:%dpx; }\n",id, h, w-18); //htrAddStylesheetItem_va(s,"\t#sp%dthum { POSITION:absolute; VISIBILITY:inherit; LEFT:%dpx; TOP:18px; WIDTH:18px; Z-INDEX:%dpx; }\n",id,w-18,z+1); - htrAddBodyItem_va(s,"
\n",id,visible?"inherit":"hidden",x,y,w,h,w,h,z); + htrAddBodyItem_va(s, + "
\n", + id, + (visible) ? "inherit" : "hidden", + ht_flex(x, tree->Parent->width, ht_fl_x_compat), + ht_flex(y, tree->Parent->height, ht_fl_y_compat), + ht_flex(w, tree->Parent->width, tree->fl_width), + ht_flex(h, tree->Parent->height, tree->fl_height), + ht_flex(w, tree->Parent->width, tree->fl_width), ht_flex(h, tree->Parent->height, tree->fl_height), + z + ); htrAddBodyItem_va(s,"", id); htrAddBodyItem_va(s,"", id); htrAddBodyItem_va(s,"", id); - htrAddStylesheetItem_va(s,"\t#sp%POSup { POSITION: absolute; LEFT: %INTpx; TOP: 0px; }\n",id, w-18); - htrAddStylesheetItem_va(s,"\t#sp%POSbar { POSITION: absolute; LEFT: %INTpx; TOP: 18px; WIDTH: 18px; HEIGHT: %POSpx;}\n",id, w-18, h-36); - htrAddStylesheetItem_va(s,"\t#sp%POSdown { POSITION: absolute; LEFT: %INTpx; TOP: %INTpx; }\n",id, w-18, h-18); - htrAddBodyItem_va(s,"
\n", id,w-18,z+1); - htrAddBodyItem_va(s,"
",id,h,w-18,z+1); + htrAddStylesheetItem_va(s, + "\t#sp%POSup { " + "POSITION:absolute; " + "LEFT:"ht_flex_format"; " + "TOP:0px; " + "}\n", + id, + ht_flex(w - 18, tree->Parent->width, ht_get_fl_x(tree)) + ); + htrAddStylesheetItem_va(s, + "\t#sp%POSbar { " + "POSITION:absolute; " + "LEFT:"ht_flex_format"; " + "TOP:18px; " + "WIDTH:18px; " + "HEIGHT:"ht_flex_format"; " + "}\n", + id, + ht_flex(w - 18, tree->Parent->width, ht_get_fl_x(tree)), + ht_flex(h - 36, tree->Parent->height, ht_get_fl_h(tree)) + ); + htrAddStylesheetItem_va(s, + "\t#sp%POSdown { " + "POSITION:absolute; " + "LEFT:"ht_flex_format"; " + "TOP:"ht_flex_format"; " + "}\n", + id, + ht_flex(w - 18, tree->Parent->width, ht_get_fl_x(tree)), + ht_flex(h - 18, tree->Parent->height, ht_get_fl_y(tree)) + ); + htrAddBodyItem_va(s, + "
" + "" + "
\n", + id, + ht_flex(w - 18, tree->Parent->width, ht_get_fl_x(tree)), + z + 1 + ); + htrAddBodyItem_va(s, + "
", + id, + ht_flex(w - 18, tree->Parent->width, ht_get_fl_w(tree)), + ht_flex(h, tree->Parent->height, ht_get_fl_h(tree)), + z + 1 + ); } else { diff --git a/centrallix/htmlgen/htdrv_textbutton.c b/centrallix/htmlgen/htdrv_textbutton.c index 34575df52..1f6c1afef 100644 --- a/centrallix/htmlgen/htdrv_textbutton.c +++ b/centrallix/htmlgen/htdrv_textbutton.c @@ -206,10 +206,25 @@ httbtnRender(pHtSession s, pWgtrNode tree, int z) htrAddScriptInclude(s, "/sys/js/ht_utils_layers.js", 0); /** Initial CSS styles **/ - htrAddStylesheetItem_va(s,"\t#tb%POSpane { POSITION:absolute; VISIBILITY:inherit; LEFT:%INTpx; TOP:%INTpx; %[HEIGHT:%POSpx; %]WIDTH:%POSpx; Z-INDEX:%POS; OVERFLOW:hidden; display:table; }\n", - id, - x, y, h>=0, h-1-2*box_offset, w-1-2*box_offset, z - ); + htrAddStylesheetItem_va(s, + "\t#tb%POSpane { " + "POSITION:absolute; " + "VISIBILITY:inherit; " + "LEFT:"ht_flex_format"; " + "TOP:"ht_flex_format"; " + "WIDTH:"ht_flex_format"; " + "%[HEIGHT:"ht_flex_format"; %]" + "Z-INDEX:%POS; " + "OVERFLOW:hidden; " + "display:table; " + "}\n", + id, + ht_flex(x, tree->Parent->width, ht_get_fl_x(tree)), + ht_flex(y, tree->Parent->height, ht_get_fl_y(tree)), + ht_flex(w-1-2*box_offset, tree->Parent->width, ht_get_fl_w(tree)), + (h>=0), ht_flex(h-1-2*box_offset, tree->Parent->height, ht_get_fl_h(tree)), + z + ); htrAddStylesheetItem_va(s, "\t#tb%POSpane .cell { height:100%%; width:100%%; vertical-align:middle; display:table-cell; padding:1px; font-weight:bold; cursor:default; text-align:%STR; border-width:1px; border-style:%STR&CSSVAL; border-color:%STR&CSSVAL; border-radius:%INTpx; color:%STR&CSSVAL; %[text-shadow:1px 1px %STR&CSSVAL; %]%STR }\n", /* clipping no longer needed: 0, w-1-2*box_offset+2*clip_offset, h-1-2*box_offset+2*clip_offset, 0, */ id, @@ -249,14 +264,23 @@ httbtnRender(pHtSession s, pWgtrNode tree, int z) //htrAddBodyItem(s, "
"); /** We need two DIVs here because of a long-outstanding Firefox bug :( **/ - htrAddBodyItem_va(s,"
%[
%]%[%]%STR&HTE%[%]%[
%]
", - id, - image[0] && !strcmp(image_position, "top"), image, - image[0] && !strcmp(image_position, "left"), image, - text, - image[0] && !strcmp(image_position, "right"), image, - image[0] && !strcmp(image_position, "bottom"), image - ); + htrAddBodyItem_va(s, + "
" + "
" + "%[
%]" + "%[%]" + "%STR&HTE" + "%[%]" + "%[
%]" + "
" + "
", + id, + (image[0] && !strcmp(image_position, "top")), image, + (image[0] && !strcmp(image_position, "left")), image, + text, + (image[0] && !strcmp(image_position, "right")), image, + (image[0] && !strcmp(image_position, "bottom")), image + ); /** Script initialization call. **/ //htrAddScriptInit_va(s, " tb_init({layer:wgtrGetNodeRef(ns,'%STR&SYM'), span:document.getElementById(\"tb%POSspan\"), ena:%INT, c1:\"%STR&JSSTR\", c2:\"%STR&JSSTR\", dc1:\"%STR&JSSTR\", top:null, bottom:null, right:null, left:null, width:%INT, height:%INT, tristate:%INT, name:\"%STR&SYM\", text:'%STR&JSSTR'});\n", diff --git a/centrallix/htmlgen/htdrv_treeview.c b/centrallix/htmlgen/htdrv_treeview.c index 413a2123c..106b49718 100644 --- a/centrallix/htmlgen/htdrv_treeview.c +++ b/centrallix/htmlgen/htdrv_treeview.c @@ -172,7 +172,22 @@ httreeRender(pHtSession s, pWgtrNode tree, int z) /** Ok, write the style header items. **/ if (s->Capabilities.Dom0NS) { - htrAddStylesheetItem_va(s,"\t#tv%POSroot { POSITION:absolute; VISIBILITY:%STR; LEFT:%INTpx; TOP:%INTpx; WIDTH:%POSpx; Z-INDEX:%POS; }\n",id,show_root?"inherit":"hidden",x,y,w,z); + htrAddStylesheetItem_va(s, + "\t#tv%POSroot { " + "POSITION:absolute; " + "VISIBILITY:%STR; " + "LEFT:"ht_flex_format"; " + "TOP:"ht_flex_format"; " + "WIDTH:"ht_flex_format"; " + "Z-INDEX:%POS; " + "}\n", + id, + (show_root) ? "inherit" : "hidden", + ht_flex(x, tree->Parent->width, ht_get_fl_x(tree)), + ht_flex(y, tree->Parent->height, ht_get_fl_y(tree)), + ht_flex(w, tree->Parent->width, ht_get_fl_w(tree)), + z + ); } htrAddStylesheetItem_va(s,"\t#tv%POSload { POSITION:absolute; VISIBILITY:hidden; OVERFLOW:hidden; LEFT:0px; TOP:0px; WIDTH:0px; HEIGHT:0px; clip:rect(0px,0px,0px,0px); Z-INDEX:0; }\n",id); htrAddStylesheetItem_va(s,"\tdiv.tv%POS a { %[color:%STR&CSSVAL;%] }\n", id, *fgcolor, fgcolor); @@ -205,7 +220,31 @@ httreeRender(pHtSession s, pWgtrNode tree, int z) } else { - htrAddBodyItem_va(s, "
 %STR&HTE
\n",id,id,show_root?"inherit":"hidden",x,y,w,z,(*icon)?icon:"/sys/images/ico02b.gif", src); + htrAddBodyItem_va(s, + "
" + "" + " %STR&HTE" + "
\n", + id, /** Class **/ + id, /** ID **/ + (show_root) ? "inherit" : "hidden", + ht_flex(x, tree->Parent->width, ht_get_fl_x(tree)), + ht_flex(y, tree->Parent->height, ht_get_fl_y(tree)), + ht_flex(w, tree->Parent->width, ht_get_fl_w(tree)), + z, + (*icon) ? icon : "/sys/images/ico02b.gif", src + ); htrAddBodyItemLayer_va(s, HTR_LAYER_F_DYNAMIC, "tv%POSload", id, NULL, ""); /*htrAddBodyItem_va(s, "
\n",id);*/ } From bfadfe7adc7a99dbf8e55c49f2d7fb5309f62074 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Thu, 3 Jul 2025 15:37:40 -0600 Subject: [PATCH 063/275] Build testing apps. --- centrallix-os/samples/autoscale_test.app | 71 +++++++++++++++++++++++ centrallix-os/samples/autoscale_test2.app | 19 ++++++ 2 files changed, 90 insertions(+) create mode 100644 centrallix-os/samples/autoscale_test.app create mode 100644 centrallix-os/samples/autoscale_test2.app diff --git a/centrallix-os/samples/autoscale_test.app b/centrallix-os/samples/autoscale_test.app new file mode 100644 index 000000000..bcaace5c6 --- /dev/null +++ b/centrallix-os/samples/autoscale_test.app @@ -0,0 +1,71 @@ +$Version=2$ +MyPage "widget/page" + { + title = "Responsive Testing Page"; + bgcolor = "black"; + textcolor = "#00f8ff"; + width = 1000; + height = 1000; + + auto "widget/hbox" + { + x=100; y=50; width=900; height=750; + spacing=20; row_height=300; + fl_width=100; fl_height=100; + + pane0 "widget/pane" { fl_width=100; fl_height=100; width=190; height=180; bgcolor = "#9cf"; } // x=100; y=50; + pane1 "widget/pane" { fl_width=100; fl_height=100; width=130; height=180; bgcolor = "#ccc"; } // x=305; y=50; + pane2 "widget/pane" { fl_width=100; fl_height=100; width=80; height=320; bgcolor = "#f99"; } // x=455; y=50; + pane3 "widget/pane" { fl_width=100; fl_height=100; width=150; height=140; bgcolor = "#9f9"; } // x=555; y=50; + pane4 "widget/pane" { fl_width=100; fl_height=100; width=90; height=240; bgcolor = "#99f"; } // x=725; y=50; + pane5 "widget/pane" { fl_width=100; fl_height=100; width=230; height=100; bgcolor = "#ff9"; } // x=80; y=390; + pane6 "widget/pane" { fl_width=100; fl_height=100; width=80; height=200; bgcolor = "#f9f"; } // x=325; y=390; + pane7 "widget/pane" { fl_width=100; fl_height=100; width=170; height=220; bgcolor = "#9ff"; } // x=425; y=390; + pane8 "widget/pane" { fl_width=100; fl_height=100; width=110; height=200; bgcolor = "#fc9"; } // x=615; y=390; + pane9 "widget/pane" { fl_width=100; fl_height=100; width=130; height=120; bgcolor = "#cf9"; } // x=745; y=390; + } + + // pane0 "widget/pane" { x=100; y=50; width=190; height=180; bgcolor = "#9cf"; } + // pane1 "widget/pane" { x=305; y=50; width=130; height=180; bgcolor = "#ccc"; } + // pane2 "widget/pane" { x=455; y=50; width=80; height=320; bgcolor = "#f99"; } + // pane3 "widget/pane" { x=555; y=50; width=150; height=140; bgcolor = "#9f9"; } + // pane4 "widget/pane" { x=725; y=50; width= 90; height=240; bgcolor = "#99f"; } + // pane5 "widget/pane" { x=80; y=390; width=230; height=100; bgcolor = "#ff9"; } + // pane6 "widget/pane" { x=325; y=390; width=80; height=200; bgcolor = "#f9f"; } + // pane7 "widget/pane" { x=425; y=390; width=170; height=220; bgcolor = "#9ff"; } + // pane8 "widget/pane" { x=615; y=390; width=110; height=200; bgcolor = "#fc9"; } + // pane9 "widget/pane" { x=745; y=390; width=130; height=120; bgcolor = "#cf9"; } + + paneA "widget/pane" { x=40; y=680; width=890; height=220; bgcolor = "#620"; } + + // Outline the visible area. + top_left0 "widget/pane" { x=0; y=0; width=10; height=10; bgcolor = "#f00"; } + top_right0 "widget/pane" { x=990; y=0; width=10; height=10; bgcolor = "#ff0"; } + bottom_left0 "widget/pane" { x=0; y=990; width=10; height=10; bgcolor = "#0f0"; } + bottom_right0 "widget/pane" { x=990; y=990; width=10; height=10; bgcolor = "#00f"; } + + // Advance markers. + top_left1 "widget/pane" { x=100; y=100; width=10; height=10; fl_x=25; fl_y=25; fl_width=25; fl_height=25; bgcolor = "#a00"; } + top_right1 "widget/pane" { x=890; y=100; width=10; height=10; fl_x=25; fl_y=25; fl_width=25; fl_height=25; bgcolor = "#aa0"; } + bottom_left1 "widget/pane" { x=100; y=890; width=10; height=10; fl_x=25; fl_y=25; fl_width=25; fl_height=25; bgcolor = "#0a0"; } + bottom_right1 "widget/pane" { x=890; y=890; width=10; height=10; fl_x=25; fl_y=25; fl_width=25; fl_height=25; bgcolor = "#00a"; } + + // Interior markers. + top_left2 "widget/pane" { x=250; y=250; width=10; height=10; fl_x=100; fl_y=100; fl_width=25; fl_height=25; bgcolor = "#700"; } + top_right2 "widget/pane" { x=740; y=250; width=10; height=10; fl_x=100; fl_y=100; fl_width=25; fl_height=25; bgcolor = "#770"; } + bottom_left2 "widget/pane" { x=250; y=740; width=10; height=10; fl_x=100; fl_y=100; fl_width=25; fl_height=25; bgcolor = "#070"; } + bottom_right2 "widget/pane" { x=740; y=740; width=10; height=10; fl_x=100; fl_y=100; fl_width=25; fl_height=25; bgcolor = "#007"; } + + // Deep interior markers. + top_left3 "widget/pane" { x=400; y=400; width=10; height=10; fl_x=25; fl_y=25; fl_width=100; fl_height=100; bgcolor = "#500"; } + top_right3 "widget/pane" { x=590; y=400; width=10; height=10; fl_x=25; fl_y=25; fl_width=100; fl_height=100; bgcolor = "#550"; } + bottom_left3 "widget/pane" { x=400; y=590; width=10; height=10; fl_x=25; fl_y=25; fl_width=100; fl_height=100; bgcolor = "#050"; } + bottom_right3 "widget/pane" { x=590; y=590; width=10; height=10; fl_x=25; fl_y=25; fl_width=100; fl_height=100; bgcolor = "#005"; } + + // Center marker. + center "widget/pane" + { + x=450; y=450; width=100; height=100; bgcolor = "orange"; + centerer "widget/pane" { x=25; y=25; width=50; height=50; bgcolor = "purple"; } // Debug + } + } \ No newline at end of file diff --git a/centrallix-os/samples/autoscale_test2.app b/centrallix-os/samples/autoscale_test2.app new file mode 100644 index 000000000..10b7a4cff --- /dev/null +++ b/centrallix-os/samples/autoscale_test2.app @@ -0,0 +1,19 @@ +$Version=2$ +MyPage "widget/page" + { + title = "Flex Testing Page"; + bgcolor = "black"; + textcolor = "#00f8ff"; + width = 1000; + height = 1000; + + box "widget/pane" + { + x=25; y=25; width=975; height=975; bgcolor = "#111"; + + // Note: fl_x and fl_y seem to be ignored. + standard "widget/pane" { x=100; y=100; width=100; height=100; fl_x=100; fl_y=100; fl_width=100; fl_height=100; bgcolor = "orange"; } + big "widget/pane" { x=250; y=250; width=200; height=200; fl_x=10; fl_y=50; fl_width=10; fl_height=10; bgcolor = "purple"; } + double "widget/pane" { x=500; y=500; width=200; height=200; fl_x=50; fl_y=10; fl_width=50; fl_height=50; bgcolor = "green"; } + } + } \ No newline at end of file From c5d998c7b98cfe3ee9a3502869f367e36b415888 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Wed, 23 Jul 2025 14:21:00 -0600 Subject: [PATCH 064/275] Sample pages appear to work now. --- centrallix-os/sys/js/ht_geom_dom1html.js | 42 ++++++++++++++++++- centrallix-os/sys/js/htdrv_html.js | 15 ++++++- centrallix-os/sys/js/htdrv_scrollpane.js | 44 ++++++++++++++------ centrallix-os/sys/js/htdrv_textbutton.js | 2 - centrallix/htmlgen/ht_render.c | 37 +++++++++++++++-- centrallix/htmlgen/htdrv_autolayout.c | 8 ++-- centrallix/htmlgen/htdrv_editbox.c | 12 +++--- centrallix/htmlgen/htdrv_html.c | 24 +++++------ centrallix/htmlgen/htdrv_image.c | 8 ++-- centrallix/htmlgen/htdrv_label.c | 10 ++--- centrallix/htmlgen/htdrv_pane.c | 8 ++-- centrallix/htmlgen/htdrv_scrollpane.c | 42 +++++++++---------- centrallix/htmlgen/htdrv_textbutton.c | 50 +++++++++++++++++------ centrallix/htmlgen/htdrv_treeview.c | 14 +++---- centrallix/include/ht_render.h | 52 ++++++++++++++++-------- centrallix/wgtr/apos.c | 24 ++++++----- 16 files changed, 267 insertions(+), 125 deletions(-) diff --git a/centrallix-os/sys/js/ht_geom_dom1html.js b/centrallix-os/sys/js/ht_geom_dom1html.js index b8c17ab7d..f137d5dba 100644 --- a/centrallix-os/sys/js/ht_geom_dom1html.js +++ b/centrallix-os/sys/js/ht_geom_dom1html.js @@ -11,6 +11,35 @@ // Cross browser Geometry DOM1HTML +/*** Experimental system for turning off clipping CSS. + *** The clip values are still stored and can be queried + *** for legacy compatibility, but they will not output + *** any clip rectangles or clip paths in the CSS or HTML. + ***/ +/** Ensure clipping is disabled for a layer / HTML node. **/ +function disableClippingCSS(l) { + console.log(`Turning off clipping for ${l.clip.obj.id}.`); + l.clip.noclip = true; + updateClippingCSS(l); +} +/** Ensure clipping is enabled for a layer / HTML node. **/ +function enableClippingCSS(l) { + l.clip.noclip = false; + updateClippingCSS(l); +} +/** Update clipping without changing any specific values. **/ +function updateClippingCSS(l) { + setClipTop(l, getClipTop(l)); +} + +/** Debug function for finding clipped dom nodes. **/ +function getClipped() { + return Array + .from(Window.clipped) + .filter(id=>id) + .map(id=>document.getElementById(id)); +} + // Clip Width function getClipWidth(l) { @@ -321,6 +350,7 @@ function getHeight(l) // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU Lesser General Public License for more details. +Window.clipped = new Set(); // Debug set for saving clipped dom nodes. function ClipObject_SetAll(top,right,bottom,left) { var str = "rect(" @@ -329,7 +359,17 @@ function ClipObject_SetAll(top,right,bottom,left) + bottom + "px, " + left + "px)"; this.arr = {1:top,2:right,3:bottom,4:left}; - this.obj.style.setProperty('clip',str,""); + if (this.noclip) + { + Window.clipped.delete(this.obj.id); // debug + this.obj.style.setProperty('clip', ""); + } + else + { + Window.clipped.add(this.obj.id); // debug + this.obj.style.setProperty('clip', str, ""); + } + } var ClipRegexp = /rect\((.*), (.*), (.*), (.*)\)/; diff --git a/centrallix-os/sys/js/htdrv_html.js b/centrallix-os/sys/js/htdrv_html.js index b40264bec..3289d0b61 100644 --- a/centrallix-os/sys/js/htdrv_html.js +++ b/centrallix-os/sys/js/htdrv_html.js @@ -240,7 +240,10 @@ function ht_init(param) { setClipHeight(l, getdocHeight(l)); } - pg_set_style(l, 'height', getdocHeight(l)); + /*** This break's responsive design, and it looks like it's + *** put in for compatibility and is no longer necessary. + ***/ + // pg_set_style(l, 'height', getdocHeight(l)); if (param.width != -1) { setClipWidth(l, param.width); @@ -250,7 +253,15 @@ function ht_init(param) { setClipWidth(l, getdocWidth(l)); } - pg_set_style(l, 'width', getdocWidth(l)); + /*** This break's responsive design, and it looks like it's + *** put in for compatibility and is no longer necessary. + ***/ + // pg_set_style(l, 'width', getdocWidth(l)); + + /** Clipping breaks responsive pages and is not required in modern browers. **/ + disableClippingCSS(l); + disableClippingCSS(l2); + if (source.substr(0,5) == 'http:') { //pg_serialized_load(l, source, ht_reloaded); diff --git a/centrallix-os/sys/js/htdrv_scrollpane.js b/centrallix-os/sys/js/htdrv_scrollpane.js index f57d1313f..ccbf0dba5 100644 --- a/centrallix-os/sys/js/htdrv_scrollpane.js +++ b/centrallix-os/sys/js/htdrv_scrollpane.js @@ -58,6 +58,7 @@ function sp_init(param) images[0].area=alayer; images[0].pane=l; setClipWidth(alayer, getClipWidth(l)-18); + disableClippingCSS(alayer); // Clipping breaks responsive pages and is not required in modern browers. alayer.maxwidth=getClipWidth(alayer); alayer.minwidth=getClipWidth(alayer); tlayer.nofocus = true; @@ -96,10 +97,27 @@ function sp_init(param) } } +/** @returns The height of the scrollpane content (including content outside the visibile area). **/ +// Replaces getClipHeight(area) + getClipTop(area) +function sp_get_content_height(area) { + return getClipHeight(area) + getClipTop(area); +} + +/** @returns The height of visible area in the scrollpane. **/ +// Replaces getClipHeight(pane) +function sp_get_total_height(pane) { + return parseInt(window.getComputedStyle(pane).height); +} + +/** @returns The height of visible area in the scroll bar. **/ +function sp_get_sb_height(pane) { + return sp_get_total_height(pane) - (3*18); +} + function sp_action_scrollto(aparam) { - var h = getClipHeight(this.area)+getClipTop(this.area); // height of content - var ch = getClipHeight(this); + var h = sp_get_content_height(this.area); // height of content + var ch = sp_get_total_height(this); var d = h-ch; // height of non-visible content (max scrollable distance) if (d < 0) d=0; if (typeof aparam.Percent != 'undefined') @@ -135,8 +153,10 @@ function sp_WatchHeight(property, oldvalue, newvalue) // make sure region not offscreen now newvalue += getClipTop(this.pane.area); - if (getRelativeY(this.pane.area) + newvalue < getClipHeight(this.pane)) setRelativeY(this.pane.area, getClipHeight(this.pane) - newvalue); - if (newvalue < getClipHeight(this.pane)) setRelativeY(this.pane.area, 0); + if (getRelativeY(this.pane.area) + newvalue < sp_get_total_height(this.pane)) { + setRelativeY(this.pane.area, sp_get_total_height(this.pane) - newvalue); + } + if (newvalue < sp_get_total_height(this.pane)) setRelativeY(this.pane.area, 0); this.pane.UpdateThumb(newvalue); newvalue -= getClipTop(this.pane.area); this.bottom = this.top + newvalue; /* ns seems to unlink bottom = top + height if you modify clip obj */ @@ -148,10 +168,10 @@ function sp_UpdateThumb(h) /** 'this' is a spXpane **/ if(!h) { /** if h is supplied, it is the soon-to-be clip.height of the spXarea **/ - h=getClipHeight(this.area)+getClipTop(this.area); // height of content + h=sp_get_content_height(this.area); // height of content } - var d=h-getClipHeight(this); // height of non-visible content (max scrollable distance) - var v=getClipHeight(this)-(3*18); + var d=h-sp_get_total_height(this); // height of non-visible content (max scrollable distance) + var v=sp_get_sb_height(this); if(d<=0) setRelativeY(this.thum, 18); else @@ -167,8 +187,8 @@ function do_mv() { return; } - var h=getClipHeight(ti.area)+getClipTop(ti.area); // height of content - var d=h-getClipHeight(ti.pane); // height of non-visible content (max scrollable distance) + var h=sp_get_content_height(ti.area); // height of content + var d=h-sp_get_total_height(ti.pane); // height of non-visible content (max scrollable distance) var incr=sp_mv_incr; if(d<0) incr=0; @@ -253,13 +273,13 @@ function sp_mousemove(e) var ti=sp_target_img; if (ti != null && ti.kind=='sp' && ti.name=='t') { - var v=getClipHeight(ti.pane)-(3*18); + var v=sp_get_sb_height(ti.pane); var new_y=sp_thum_y + (e.pageY-sp_click_y); if (new_y > getPageY(ti.pane)+18+v) new_y=getPageY(ti.pane)+18+v; if (new_y < getPageY(ti.pane)+18) new_y=getPageY(ti.pane)+18; setPageY(ti.thum,new_y); - var h=getClipHeight(ti.area)+getClipTop(ti.area); - var d=h-getClipHeight(ti.pane); + var h=sp_get_content_height(ti.area); + var d=h-sp_get_total_height(ti.pane); if (d<0) d=0; var yincr = (((getRelativeY(ti.thum)-18)/v)*-d) - getRelativeY(ti.area); moveBy(ti.area, 0, yincr); diff --git a/centrallix-os/sys/js/htdrv_textbutton.js b/centrallix-os/sys/js/htdrv_textbutton.js index 77b968e75..d053453b1 100644 --- a/centrallix-os/sys/js/htdrv_textbutton.js +++ b/centrallix-os/sys/js/htdrv_textbutton.js @@ -226,7 +226,6 @@ function tb_setmode(layer,mode) break; case 1: /* point, but no click */ - moveTo(layer,layer.orig_x,layer.orig_y); $(layer).find(".cell").css({'border-style':wgtrGetServerProperty(layer, 'border_style', 'outset'), 'border-color':wgtrGetServerProperty(layer, 'border_color', '#c0c0c0')}); /*if(cx__capabilities.Dom2CSS) { @@ -259,7 +258,6 @@ function tb_setmode(layer,mode) break; case 2: /* point and click */ - moveTo(layer,layer.orig_x+1,layer.orig_y+1); var bstyle = wgtrGetServerProperty(layer, 'border_style', 'outset'); if (bstyle == 'outset') bstyle = 'inset'; diff --git a/centrallix/htmlgen/ht_render.c b/centrallix/htmlgen/ht_render.c index 0a6844768..c98f81b14 100644 --- a/centrallix/htmlgen/ht_render.c +++ b/centrallix/htmlgen/ht_render.c @@ -2720,10 +2720,10 @@ htrFormatElement(pHtSession s, pWgtrNode node, char* id, int flags, int x, int y "%[%STR %]" "}\n", id, - ht_flex(x, node->Parent->width, ht_get_fl_x(node)), - ht_flex(y, node->Parent->height, ht_get_fl_y(node)), - (w > 0), ht_flex(w, node->Parent->width, ht_get_fl_w(node)), - (h > 0), ht_flex(h, node->Parent->height, ht_get_fl_h(node)), + ht_flex(x, ht_get_total_w(node), ht_get_fl_x(node)), + ht_flex(y, ht_get_total_h(node), ht_get_fl_y(node)), + (w > 0), ht_flex(w, ht_get_total_w(node), ht_get_fl_w(node)), + (h > 0), ht_flex(h, ht_get_total_h(node), ht_get_fl_h(node)), (z > 0), z, (*textcolor), textcolor, (!strcmp(style, "bold")), @@ -2746,3 +2746,32 @@ htrFormatElement(pHtSession s, pWgtrNode node, char* id, int flags, int x, int y } +int +ht_get_total_w__INTERNAL(pWgtrNode widget) { + pWgtrNode parent = widget->Parent; + int parentWidth = parent->width; +// printf( +// "Getting total width available to '%s' (%s), child of '%s' (%s) - %dpx\n", +// widget->Name, widget->Type, parent->Name, parent->Type, parentWidth +// ); + if (parentWidth >= 0) { + int offset = parent->left + parent->right, ret = parentWidth - offset; + // printf("Returning %d-%d=%d\n", parentWidth, offset, ret); + return ret; + } else return ht_get_total_w(parent); // Tail-recursion +} + +int +ht_get_total_h__INTERNAL(pWgtrNode widget) { + pWgtrNode parent = widget->Parent; + int parentHeight = parent->height; +// printf( +// "Getting total height available to '%s' (%s), child of '%s' (%s) - %dpx\n", +// widget->Name, widget->Type, parent->Name, parent->Type, parentHeight +// ); + if (parentHeight >= 0) { + int offset = parent->top + parent->bottom, ret = parentHeight - offset; + // printf("Returning %d-%d=%d\n", parentHeight, offset, ret); + return ret; + } else return ht_get_total_h(parent); // Tail-recursion +} diff --git a/centrallix/htmlgen/htdrv_autolayout.c b/centrallix/htmlgen/htdrv_autolayout.c index 66b7f83e0..9cc7eb7c4 100644 --- a/centrallix/htmlgen/htdrv_autolayout.c +++ b/centrallix/htmlgen/htdrv_autolayout.c @@ -111,10 +111,10 @@ htalRender(pHtSession s, pWgtrNode tree, int z) "Z-INDEX:%POS; " "}\n", id, - ht_flex(x, tree->Parent->width, ht_get_fl_x(tree)), - ht_flex(y, tree->Parent->height, ht_get_fl_y(tree)), - ht_flex(w, tree->Parent->width, ht_get_fl_w(tree)), - ht_flex(h, tree->Parent->height, ht_get_fl_h(tree)), + ht_flex(x, ht_get_total_w(tree), ht_get_fl_x(tree)), + ht_flex(y, ht_get_total_h(tree), ht_get_fl_y(tree)), + ht_flex(w, ht_get_total_w(tree), ht_get_fl_w(tree)), + ht_flex(h, ht_get_total_h(tree), ht_get_fl_h(tree)), z ); diff --git a/centrallix/htmlgen/htdrv_editbox.c b/centrallix/htmlgen/htdrv_editbox.c index 7290692a7..ef40c8d8a 100644 --- a/centrallix/htmlgen/htdrv_editbox.c +++ b/centrallix/htmlgen/htdrv_editbox.c @@ -160,9 +160,9 @@ htebRender(pHtSession s, pWgtrNode tree, int z) "overflow:hidden; " "}\n", id, - ht_flex(x, tree->Parent->width, ht_get_fl_x(tree)), - ht_flex(y, tree->Parent->height, ht_get_fl_y(tree)), - ht_flex(w - 2 * box_offset, tree->Parent->width, ht_get_fl_w(tree)), + ht_flex(x, ht_get_total_w(tree), ht_get_fl_x(tree)), + ht_flex(y, ht_get_total_h(tree), ht_get_fl_y(tree)), + ht_flex(w - 2 * box_offset, ht_get_total_w(tree), ht_get_fl_w(tree)), z ); htrAddStylesheetItem_va(s, @@ -175,7 +175,7 @@ htebRender(pHtSession s, pWgtrNode tree, int z) "border:none; " "}\n", id, - ht_flex(w - 10, tree->Parent->width, ht_get_fl_w(tree)), + ht_flex(w - 10, ht_get_total_w(tree), ht_get_fl_w(tree)), z+1 ); @@ -217,8 +217,8 @@ htebRender(pHtSession s, pWgtrNode tree, int z) htrAddStylesheetItem_va(s, "\t#eb%POSbase { height:"ht_flex_format"; }\n" "\t#eb%POScon1 { height:"ht_flex_format"; }\n", - id, ht_flex(h - 2 * box_offset, tree->Parent->height, ht_get_fl_h(tree)), - id, ht_flex(h - 2 * box_offset - 2, tree->Parent->height, ht_get_fl_h(tree)) + id, ht_flex(h - 2 * box_offset, ht_get_total_h(tree), ht_get_fl_h(tree)), + id, ht_flex(h - 2 * box_offset - 2, ht_get_total_h(tree), ht_get_fl_h(tree)) ); //htrAddBodyItem_va(s, "
 
\n", w-2, h-2); diff --git a/centrallix/htmlgen/htdrv_html.c b/centrallix/htmlgen/htdrv_html.c index 3e7238209..0b41d7b35 100644 --- a/centrallix/htmlgen/htdrv_html.c +++ b/centrallix/htmlgen/htdrv_html.c @@ -102,9 +102,9 @@ hthtmlRender(pHtSession s, pWgtrNode tree, int z) /** Only give x and y if supplied. **/ if (x < 0 || y < 0) { - htrAddStylesheetItem_va(s,"\t#ht%POSpane { POSITION:relative; VISIBILITY:inherit; WIDTH:"ht_flex_format"; Z-INDEX:%POS; }\n",id,ht_flex(w,tree->Parent->width,ht_get_fl_w(tree)),z); - htrAddStylesheetItem_va(s,"\t#ht%POSpane2 { POSITION:relative; VISIBILITY:hidden; WIDTH:"ht_flex_format"; Z-INDEX:%POS; }\n",id,ht_flex(w,tree->Parent->width,ht_get_fl_w(tree)),z); - htrAddStylesheetItem_va(s,"\t#ht%POSfader { POSITION:relative; VISIBILITY:hidden; WIDTH:"ht_flex_format"; Z-INDEX:%POS; }\n",id,ht_flex(w,tree->Parent->width,ht_get_fl_w(tree)),z+1); + htrAddStylesheetItem_va(s,"\t#ht%POSpane { POSITION:relative; VISIBILITY:inherit; WIDTH:"ht_flex_format"; Z-INDEX:%POS; }\n",id,ht_flex(w,ht_get_total_w(tree),ht_get_fl_w(tree)),z); + htrAddStylesheetItem_va(s,"\t#ht%POSpane2 { POSITION:relative; VISIBILITY:hidden; WIDTH:"ht_flex_format"; Z-INDEX:%POS; }\n",id,ht_flex(w,ht_get_total_w(tree),ht_get_fl_w(tree)),z); + htrAddStylesheetItem_va(s,"\t#ht%POSfader { POSITION:relative; VISIBILITY:hidden; WIDTH:"ht_flex_format"; Z-INDEX:%POS; }\n",id,ht_flex(w,ht_get_total_w(tree),ht_get_fl_w(tree)),z+1); } else { @@ -118,9 +118,9 @@ hthtmlRender(pHtSession s, pWgtrNode tree, int z) "Z-INDEX:%POS; " "}\n", id, - ht_flex(x, tree->Parent->width, ht_get_fl_x(tree)), - ht_flex(y, tree->Parent->height, ht_get_fl_y(tree)), - ht_flex(w, tree->Parent->width, ht_get_fl_w(tree)), + ht_flex(x, ht_get_total_w(tree), ht_get_fl_x(tree)), + ht_flex(y, ht_get_total_h(tree), ht_get_fl_y(tree)), + ht_flex(w, ht_get_total_w(tree), ht_get_fl_w(tree)), z ); htrAddStylesheetItem_va(s, @@ -133,9 +133,9 @@ hthtmlRender(pHtSession s, pWgtrNode tree, int z) "Z-INDEX:%POS; " "}\n", id, - ht_flex(x, tree->Parent->width, ht_get_fl_x(tree)), - ht_flex(y, tree->Parent->height, ht_get_fl_y(tree)), - ht_flex(w, tree->Parent->width, ht_get_fl_w(tree)), + ht_flex(x, ht_get_total_w(tree), ht_get_fl_x(tree)), + ht_flex(y, ht_get_total_h(tree), ht_get_fl_y(tree)), + ht_flex(w, ht_get_total_w(tree), ht_get_fl_w(tree)), z ); htrAddStylesheetItem_va(s, @@ -148,9 +148,9 @@ hthtmlRender(pHtSession s, pWgtrNode tree, int z) "Z-INDEX:%POS; " "}\n", id, - ht_flex(x, tree->Parent->width, ht_get_fl_x(tree)), - ht_flex(y, tree->Parent->height, ht_get_fl_y(tree)), - ht_flex(w, tree->Parent->width, ht_get_fl_w(tree)), + ht_flex(x, ht_get_total_w(tree), ht_get_fl_x(tree)), + ht_flex(y, ht_get_total_h(tree), ht_get_fl_y(tree)), + ht_flex(w, ht_get_total_w(tree), ht_get_fl_w(tree)), z+1 ); } diff --git a/centrallix/htmlgen/htdrv_image.c b/centrallix/htmlgen/htdrv_image.c index b7195771b..7ad156f71 100644 --- a/centrallix/htmlgen/htdrv_image.c +++ b/centrallix/htmlgen/htdrv_image.c @@ -155,10 +155,10 @@ htimgRender(pHtSession s, pWgtrNode tree, int z) "text-align:center; " "}\n", id, - ht_flex(x, tree->Parent->width, ht_get_fl_x(tree)), - ht_flex(y, tree->Parent->height, ht_get_fl_y(tree)), - ht_flex(w, tree->Parent->width, ht_get_fl_w(tree)), - ht_flex(h, tree->Parent->height, ht_get_fl_h(tree)), + ht_flex(x, ht_get_total_w(tree), ht_get_fl_x(tree)), + ht_flex(y, ht_get_total_h(tree), ht_get_fl_y(tree)), + ht_flex(w, ht_get_total_w(tree), ht_get_fl_w(tree)), + ht_flex(h, ht_get_total_h(tree), ht_get_fl_h(tree)), z ); diff --git a/centrallix/htmlgen/htdrv_label.c b/centrallix/htmlgen/htdrv_label.c index 27f53c9d2..ea315a9a5 100644 --- a/centrallix/htmlgen/htdrv_label.c +++ b/centrallix/htmlgen/htdrv_label.c @@ -217,10 +217,10 @@ htlblRender(pHtSession s, pWgtrNode tree, int z) "%[font-style:italic; %]" "}\n", id, - ht_flex(x, tree->Parent->width, ht_get_fl_x(tree)), - ht_flex(y, tree->Parent->height, ht_get_fl_y(tree)), - ht_flex(w, tree->Parent->width, ht_get_fl_w(tree)), - (!auto_height), ht_flex(h, tree->Parent->height, ht_get_fl_h(tree)), + ht_flex(x, ht_get_total_w(tree), ht_get_fl_x(tree)), + ht_flex(y, ht_get_total_h(tree), ht_get_fl_y(tree)), + ht_flex(w, ht_get_total_w(tree), ht_get_fl_w(tree)), + (!auto_height), ht_flex(h, ht_get_total_h(tree), ht_get_fl_h(tree)), z, (is_bold), (*fgcolor), fgcolor, @@ -249,7 +249,7 @@ htlblRender(pHtSession s, pWgtrNode tree, int z) id, align, !strcmp(valign, "middle"), - ht_flex(w, tree->Parent->width, ht_get_fl_w(tree)) + ht_flex(w, ht_get_total_w(tree), ht_get_fl_w(tree)) ); htrAddWgtrObjLinkage_va(s, tree, "lbl%POS",id); diff --git a/centrallix/htmlgen/htdrv_pane.c b/centrallix/htmlgen/htdrv_pane.c index 9d0f23416..0caf96258 100644 --- a/centrallix/htmlgen/htdrv_pane.c +++ b/centrallix/htmlgen/htdrv_pane.c @@ -197,10 +197,10 @@ htpnRender(pHtSession s, pWgtrNode tree, int z) "%STR" "}\n", id, - ht_flex(x, tree->Parent->width, ht_get_fl_x(tree)), - ht_flex(y, tree->Parent->height, ht_get_fl_y(tree)), - ht_flex(w + offset, tree->Parent->width, ht_get_fl_w(tree)), - ht_flex(h + offset, tree->Parent->height, ht_get_fl_h(tree)), + ht_flex(x, ht_get_total_w(tree), ht_get_fl_x(tree)), + ht_flex(y, ht_get_total_h(tree), ht_get_fl_y(tree)), + ht_flex(w + offset, ht_get_total_w(tree), ht_get_fl_w(tree)), + ht_flex(h + offset, ht_get_total_h(tree), ht_get_fl_h(tree)), z, border_radius, main_bg diff --git a/centrallix/htmlgen/htdrv_scrollpane.c b/centrallix/htmlgen/htdrv_scrollpane.c index 3ceafbd4d..e5c061d16 100644 --- a/centrallix/htmlgen/htdrv_scrollpane.c +++ b/centrallix/htmlgen/htdrv_scrollpane.c @@ -126,16 +126,15 @@ htspaneRender(pHtSession s, pWgtrNode tree, int z) "TOP:"ht_flex_format"; " "WIDTH:"ht_flex_format"; " "HEIGHT:"ht_flex_format"; " - "clip:rect(0px, "ht_flex_format", "ht_flex_format", 0px); " + "OVERFLOW: clip; " "Z-INDEX:%POS; " "}\n", id, (visible) ? "inherit" : "hidden", - ht_flex(x, tree->Parent->width, ht_get_fl_x(tree)), - ht_flex(y, tree->Parent->height, ht_get_fl_y(tree)), - ht_flex(w, tree->Parent->width, ht_get_fl_w(tree)), - ht_flex(h, tree->Parent->height, ht_get_fl_h(tree)), - ht_flex(w, tree->Parent->width, ht_get_fl_w(tree)), ht_flex(h, tree->Parent->height, ht_get_fl_h(tree)), + ht_flex(x, ht_get_total_w(tree), ht_get_fl_x(tree)), + ht_flex(y, ht_get_total_h(tree), ht_get_fl_y(tree)), + ht_flex(w, ht_get_total_w(tree), ht_get_fl_w(tree)), + ht_flex(h, ht_get_total_h(tree), ht_get_fl_h(tree)), z ); htrAddStylesheetItem_va(s, @@ -148,7 +147,7 @@ htspaneRender(pHtSession s, pWgtrNode tree, int z) "Z-INDEX:%POS; " "}\n", id, - ht_flex(w - 18, tree->Parent->width, ht_get_fl_w(tree)), + ht_flex(w - 18, ht_get_total_w(tree), 1.0), z + 1 ); htrAddStylesheetItem_va(s, @@ -161,7 +160,7 @@ htspaneRender(pHtSession s, pWgtrNode tree, int z) "Z-INDEX:%POS; " "}\n", id, - ht_flex(w - 18, tree->Parent->width, ht_get_fl_x(tree)), + ht_flex(w - 18, tree->width, 1.0), z + 1 ); } @@ -207,17 +206,16 @@ htspaneRender(pHtSession s, pWgtrNode tree, int z) "TOP:"ht_flex_format"; " "WIDTH:"ht_flex_format"; " "HEIGHT:"ht_flex_format"; " - "clip:rect(0, "ht_flex_format", "ht_flex_format", 0); " + "OVERFLOW: clip; " "Z-INDEX:%POS; " "\"" ">\n", id, (visible) ? "inherit" : "hidden", - ht_flex(x, tree->Parent->width, ht_fl_x_compat), - ht_flex(y, tree->Parent->height, ht_fl_y_compat), - ht_flex(w, tree->Parent->width, tree->fl_width), - ht_flex(h, tree->Parent->height, tree->fl_height), - ht_flex(w, tree->Parent->width, tree->fl_width), ht_flex(h, tree->Parent->height, tree->fl_height), + ht_flex(x, ht_get_total_w(tree), ht_get_fl_x(tree)), + ht_flex(y, ht_get_total_h(tree), ht_get_fl_y(tree)), + ht_flex(w, ht_get_total_w(tree), ht_get_fl_w(tree)), + ht_flex(h, ht_get_total_h(tree), ht_get_fl_h(tree)), z ); htrAddBodyItem_va(s,"", id); @@ -230,7 +228,7 @@ htspaneRender(pHtSession s, pWgtrNode tree, int z) "TOP:0px; " "}\n", id, - ht_flex(w - 18, tree->Parent->width, ht_get_fl_x(tree)) + ht_flex(w - 18, tree->width, 1.0) ); htrAddStylesheetItem_va(s, "\t#sp%POSbar { " @@ -241,8 +239,8 @@ htspaneRender(pHtSession s, pWgtrNode tree, int z) "HEIGHT:"ht_flex_format"; " "}\n", id, - ht_flex(w - 18, tree->Parent->width, ht_get_fl_x(tree)), - ht_flex(h - 36, tree->Parent->height, ht_get_fl_h(tree)) + ht_flex(w - 18, tree->width, 1.0), + ht_flex(h - 36, tree->height, 1.0) ); htrAddStylesheetItem_va(s, "\t#sp%POSdown { " @@ -251,8 +249,8 @@ htspaneRender(pHtSession s, pWgtrNode tree, int z) "TOP:"ht_flex_format"; " "}\n", id, - ht_flex(w - 18, tree->Parent->width, ht_get_fl_x(tree)), - ht_flex(h - 18, tree->Parent->height, ht_get_fl_y(tree)) + ht_flex(w - 18, tree->width, 1.0), + ht_flex(h - 18, tree->height, 1.0) ); htrAddBodyItem_va(s, "
" "
\n", id, - ht_flex(w - 18, tree->Parent->width, ht_get_fl_x(tree)), + ht_flex(w - 18, tree->width, 1.0), z + 1 ); htrAddBodyItem_va(s, @@ -286,8 +284,8 @@ htspaneRender(pHtSession s, pWgtrNode tree, int z) "\"" ">", id, - ht_flex(w - 18, tree->Parent->width, ht_get_fl_w(tree)), - ht_flex(h, tree->Parent->height, ht_get_fl_h(tree)), + ht_flex(w - 18, ht_get_total_w(tree), 1.0), + ht_flex(h, ht_get_total_h(tree), 1.0), z + 1 ); } diff --git a/centrallix/htmlgen/htdrv_textbutton.c b/centrallix/htmlgen/htdrv_textbutton.c index 1f6c1afef..92c07357b 100644 --- a/centrallix/htmlgen/htdrv_textbutton.c +++ b/centrallix/htmlgen/htdrv_textbutton.c @@ -219,20 +219,46 @@ httbtnRender(pHtSession s, pWgtrNode tree, int z) "display:table; " "}\n", id, - ht_flex(x, tree->Parent->width, ht_get_fl_x(tree)), - ht_flex(y, tree->Parent->height, ht_get_fl_y(tree)), - ht_flex(w-1-2*box_offset, tree->Parent->width, ht_get_fl_w(tree)), - (h>=0), ht_flex(h-1-2*box_offset, tree->Parent->height, ht_get_fl_h(tree)), + ht_flex(x, ht_get_total_w(tree), ht_get_fl_x(tree)), + ht_flex(y, ht_get_total_h(tree), ht_get_fl_y(tree)), + ht_flex(w-1-2*box_offset, ht_get_total_w(tree), ht_get_fl_w(tree)), + (h>=0), ht_flex(h-1-2*box_offset, ht_get_total_h(tree), ht_get_fl_h(tree)), z ); - htrAddStylesheetItem_va(s, "\t#tb%POSpane .cell { height:100%%; width:100%%; vertical-align:middle; display:table-cell; padding:1px; font-weight:bold; cursor:default; text-align:%STR; border-width:1px; border-style:%STR&CSSVAL; border-color:%STR&CSSVAL; border-radius:%INTpx; color:%STR&CSSVAL; %[text-shadow:1px 1px %STR&CSSVAL; %]%STR }\n", - /* clipping no longer needed: 0, w-1-2*box_offset+2*clip_offset, h-1-2*box_offset+2*clip_offset, 0, */ - id, - h_align, - border_style, border_color, border_radius, - is_enabled?fgcolor1:disable_color, is_enabled, fgcolor2, - bgstyle - ); + // CSS button click animation (replaces manual the JS implementation). + if (is_enabled) { + htrAddStylesheetItem_va(s, + "\t#tb%POSpane:active { transform: translate(1px, 1px); }\n", + id + ); + } + htrAddStylesheetItem_va(s, + "\t#tb%POSpane .cell { " + "height:100%%; " + "width:100%%; " + "vertical-align:middle; " + "display:table-cell; " + "padding:1px; " + "font-weight:bold; " + "cursor:default; " + "text-align:%STR; " + "border-width:1px; " + "border-style:%STR&CSSVAL; " + "border-color:%STR&CSSVAL; " + "border-radius:%INTpx; " + "color:%STR&CSSVAL; " + "%[text-shadow:1px 1px %STR&CSSVAL; %]" + "%STR " + "}\n", + id, + h_align, + border_style, + border_color, + border_radius, + (is_enabled) ? fgcolor1 : disable_color, + (is_enabled), fgcolor2, + bgstyle + ); /** CSS for image on the button **/ if (image[0] && (image_width || image_height || image_margin)) diff --git a/centrallix/htmlgen/htdrv_treeview.c b/centrallix/htmlgen/htdrv_treeview.c index 106b49718..05a2bae8f 100644 --- a/centrallix/htmlgen/htdrv_treeview.c +++ b/centrallix/htmlgen/htdrv_treeview.c @@ -183,13 +183,13 @@ httreeRender(pHtSession s, pWgtrNode tree, int z) "}\n", id, (show_root) ? "inherit" : "hidden", - ht_flex(x, tree->Parent->width, ht_get_fl_x(tree)), - ht_flex(y, tree->Parent->height, ht_get_fl_y(tree)), - ht_flex(w, tree->Parent->width, ht_get_fl_w(tree)), + ht_flex(x, ht_get_total_w(tree), ht_get_fl_x(tree)), + ht_flex(y, ht_get_total_h(tree), ht_get_fl_y(tree)), + ht_flex(w, ht_get_total_w(tree), ht_get_fl_w(tree)), z ); } - htrAddStylesheetItem_va(s,"\t#tv%POSload { POSITION:absolute; VISIBILITY:hidden; OVERFLOW:hidden; LEFT:0px; TOP:0px; WIDTH:0px; HEIGHT:0px; clip:rect(0px,0px,0px,0px); Z-INDEX:0; }\n",id); + htrAddStylesheetItem_va(s,"\t#tv%POSload { POSITION:absolute; VISIBILITY:hidden; OVERFLOW:hidden; LEFT:0px; TOP:0px; WIDTH:0px; HEIGHT:0px; clip-path:inset(0px 0px 0px 0px); Z-INDEX:0; }\n",id); htrAddStylesheetItem_va(s,"\tdiv.tv%POS a { %[color:%STR&CSSVAL;%] }\n", id, *fgcolor, fgcolor); htrAddStylesheetItem_va(s,"\tdiv.tv%POSh a { %[color:%STR&CSSVAL;%] }\n", id, *hfgcolor, hfgcolor); @@ -239,9 +239,9 @@ httreeRender(pHtSession s, pWgtrNode tree, int z) id, /** Class **/ id, /** ID **/ (show_root) ? "inherit" : "hidden", - ht_flex(x, tree->Parent->width, ht_get_fl_x(tree)), - ht_flex(y, tree->Parent->height, ht_get_fl_y(tree)), - ht_flex(w, tree->Parent->width, ht_get_fl_w(tree)), + ht_flex(x, ht_get_total_w(tree), ht_get_fl_x(tree)), + ht_flex(y, ht_get_total_h(tree), ht_get_fl_y(tree)), + ht_flex(w, ht_get_total_w(tree), ht_get_fl_w(tree)), z, (*icon) ? icon : "/sys/images/ico02b.gif", src ); diff --git a/centrallix/include/ht_render.h b/centrallix/include/ht_render.h index d078ba1e0..b725eb9d4 100644 --- a/centrallix/include/ht_render.h +++ b/centrallix/include/ht_render.h @@ -366,17 +366,25 @@ int htruleRegister(char* ruletype, ...); /** Define macros for implementing responsive dimensions. **/ /** ===================================================== **/ -/*** The widget fl_x and fl_y fields are never used in the generated layout. - *** Thus, the CSS I created to add responsiveness uses the values below - *** instead of the provided value to preserve backwards compatibility. +/*** Brief explanation of the responsiveness formula. + *** + *** Responsive dimensions in widgets use the following formula: + *** Original px + (100% - Total px) * Flex + *** Where "Original" is the original size of the object in an adaptive layout, + *** "Total" is the total size of the widget's parent container, and + *** "Flex" is the widget flexibility (where all flexibilities add to 1). + *** All, with respect to the given dimension. + *** + *** The intuition behind this formula is that (100% - Total px) is 0px + *** if the parent container is the size intended by the adaptive design. + *** However, if the user resizes the window, (100% - Total px) is the + *** difference between the size in the adaptive design and the current + *** size, so the widget changes size with respect to that difference. ***/ -/** @brief widget->fl_x is never used. Use this instead for compatibility. **/ -#define ht_fl_x_compat 1.0 -/** @brief widget->fl_y is never used. Use this instead for compatibility. **/ -#define ht_fl_y_compat 1.0 /** @brief The qprintf format to specify a responsive dimension. **/ -#define ht_flex_format "calc(%INTpx + (%DBL%% - %INTpx) * %DBL)" +#define ht_flex_format "calc(%INTpx + (100%% - %INTpx) * %DBL)" + /*** @brief The function which generates the values that should be passed to *** qprintf in order to satisfy an ht_flex_format. *** @@ -386,29 +394,44 @@ int htruleRegister(char* ruletype, ...); *** to generate this with an ht_get_fl function call. *** @returns Several values to serve as parameters for a qprintf call. ***/ -#define ht_flex(size, total, flex) (size), (double)(size) / (total) * 100.0, (size), (flex) +#define ht_flex(size, total, flex) (size), (total), (flex) + /*** @param widget The widget to be queried. *** @returns The flexibility of the widget in the x direction. ***/ -#define ht_get_fl_x(widget) (ht_fl_x_compat) +#define ht_get_fl_x(widget) ((widget)->xAdjWeight) + /*** @param widget The widget to be queried. *** @returns The flexibility of the widget in the y direction. ***/ -#define ht_get_fl_y(widget) (ht_fl_y_compat) +#define ht_get_fl_y(widget) ((widget)->yAdjWeight) + /*** @param widget The widget to be queried. *** @returns The flexibility of the widget in the width direction. ***/ #define ht_get_fl_w(widget) ((widget)->wAdjWeight) + /*** @param widget The widget to be queried. *** @returns The flexibility of the widget in the height direction. ***/ #define ht_get_fl_h(widget) ((widget)->hAdjWeight) + +int ht_get_total_w__INTERNAL(pWgtrNode widget); +int ht_get_total_h__INTERNAL(pWgtrNode widget); + +#define ht_get_total_w(widget) ht_get_total_w__INTERNAL(widget) +#define ht_get_total_h(widget) ht_get_total_h__INTERNAL(widget) + +// #define ht_get_total_w(widget) ((widget)->Parent->width - (widget)->Parent->left - (widget)->Parent->right) +// #define ht_get_total_h(widget) ((widget)->Parent->height - (widget)->Parent->top - (widget)->Parent->bottom) + /*** @brief A shortcut function to get the flexibility when writing the *** LEFT CSS attribute. *** @param widget The widget to be queried. *** @returns The flexibility of the widget in the left direction. ***/ #define ht_get_fl_l ht_get_fl_x + /*** @brief A shortcut function to get the flexibility when writing the *** TOP CSS attribute. *** @param widget The widget to be queried. @@ -416,12 +439,5 @@ int htruleRegister(char* ruletype, ...); ***/ #define ht_get_fl_t ht_get_fl_y -/*** Alternate formula suggested in the GitHub Issue. I think this should work - *** and be more efficient, but for some reason it doesn't at all, and I can't - *** understand why. I probably just implemented it wrong. - ***/ -// #define ht_flex_format "calc(%INTpx + (100%% - %INTpx) * %DBL)" -// #define ht_flex(size, total, flex) (size), (total), (double)(flex) / 100.0 - #endif /* _HT_RENDER_H */ diff --git a/centrallix/wgtr/apos.c b/centrallix/wgtr/apos.c index 619736703..f51d508b1 100644 --- a/centrallix/wgtr/apos.c +++ b/centrallix/wgtr/apos.c @@ -222,7 +222,7 @@ int i=0, count=0; ((pWgtrNode)xaGetItem(&PatchedWidgets, i))->pre_height = -1; } - /** Free the PatchedWidgets XArray.**/ + /** Free the PatchedWidgets XArray. **/ xaDeInit(&PatchedWidgets); return 0; @@ -1282,9 +1282,9 @@ aposIsSpacer(pAposLine StartL, pAposLine EndL, int type, int isBorder) { pWgtrNode SW, EW; int i=0, j=0; -/** @brief The number of widgets starting at the end of this section.**/ +/** @brief The number of widgets starting at the end of this section. **/ int sCount=xaCount(&(EndL->SWidgets)); -/** @brief The number of widgets ending at the start of this section.**/ +/** @brief The number of widgets ending at the start of this section. **/ int eCount=xaCount(&(StartL->EWidgets)); if((EndL->Loc - StartL->Loc) <= APOS_MINSPACE) // If section is sufficiently narrow. @@ -1488,7 +1488,7 @@ float TotalSum=0; TotalSum += (FlexWeight * SizeWeight); } - /** The initial borders do not adjust.**/ + /** The initial borders do not adjust. **/ pAposLine leftBorder = (pAposLine)xaGetItem(Lines, 0); leftBorder->LocAdjWeight = leftBorder->MyAdjWeight = 0.0f; @@ -1506,26 +1506,30 @@ float TotalSum=0; ***/ float AdjWeight = PrevSect->AdjWeight = (float)(FlexWeight*SizeWeight)/TotalSum; - /** Store the line adjustment weight for responsive CSS later.**/ + /** Store the line adjustment weight for responsive CSS later. **/ CurrLine->LocAdjWeight = PrevLine->LocAdjWeight + AdjWeight; CurrLine->MyAdjWeight = AdjWeight; - /**for expanding lines**/ + /** Expand lines. **/ if(Diff > 0) { /** Calculate adjustment using the adjustment weight. **/ Adj = (float)(Diff) * AdjWeight + APOS_FUDGEFACTOR; - /** Apply the calculated adjustment.**/ + // printf("Expanding lines by %d*%f=%d\n", Diff, AdjWeight, Adj); + + /** Apply the calculated adjustment. **/ PrevSect->Width += Adj; CurrLine->Loc = PrevLine->Loc + PrevSect->Width; } - /**for contracting lines**/ + /** Contract lines. **/ else if(Diff < 0) { /** Calculate adjustment using the adjustment weight. **/ Adj = (float)(Diff) * AdjWeight - APOS_FUDGEFACTOR; + // printf("Contracting lines by %d*%f=%d\n", Diff, AdjWeight, Adj); + /** if the section width will be unacceptably *** narrow or negative after the adjustment **/ if((Adj + PrevSect->Width) <= APOS_MINSPACE) @@ -1608,7 +1612,7 @@ pWgtrNode Widget; aposSetOffsetBools(Widget, NULL, NULL, &isTopTab, &isSideTab, &tabWidth); if(flag==APOS_ROW && Widget->fl_height) { - /** Calculate the new size, taking APOS_MINWIDTH into account.**/ + /** Calculate the new size, taking APOS_MINWIDTH into account. **/ newsize = CurrLine->Loc - Widget->y - isTopTab*24; if (newsize < APOS_MINWIDTH && Widget->pre_height >= APOS_MINWIDTH) Widget->height = APOS_MINWIDTH; @@ -1652,7 +1656,7 @@ pWgtrNode Widget; /** Adjusts width or height of widgets ending on this line. **/ count = xaCount(&(CurrLine->CWidgets)); - printf("Doing %d widgets.\n", count); + // printf("Doing %d widgets.\n", count); for(j=0; jCWidgets), j); From 5ae7c542ed6a221f2854381145ea33e3f6e404f7 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Wed, 30 Jul 2025 16:11:58 -0600 Subject: [PATCH 065/275] Working, server-side code. Fixes components, dropdowns, and images. Renames flex variables to be more clear. Send parent_w and parent_h to client. --- centrallix-os/sys/js/htdrv_pane.js | 4 ++ centrallix/htmlgen/ht_render.c | 94 ++++++++++++++++++++++------ centrallix/htmlgen/htdrv_component.c | 28 ++++++++- centrallix/htmlgen/htdrv_dropdown.c | 56 ++++++++++++++++- centrallix/htmlgen/htdrv_image.c | 33 ++++++++-- centrallix/htmlgen/htdrv_pane.c | 4 +- centrallix/include/apos.h | 24 +++---- centrallix/include/ht_render.h | 55 ++++++++++++---- centrallix/include/wgtr.h | 11 ++-- centrallix/wgtr/apos.c | 58 +++++++++-------- centrallix/wgtr/wgtr.c | 26 +++++--- 11 files changed, 293 insertions(+), 100 deletions(-) diff --git a/centrallix-os/sys/js/htdrv_pane.js b/centrallix-os/sys/js/htdrv_pane.js index dfdb597ad..9489912e7 100644 --- a/centrallix-os/sys/js/htdrv_pane.js +++ b/centrallix-os/sys/js/htdrv_pane.js @@ -79,6 +79,10 @@ function pn_setbackground(aparam) function pn_action_resize(aparam) { + // I think this code is a better implementation of the following lines: + // var w = (aparam.Width) ?? pg_get_style(this, 'width'); + // var h = (aparam.Height) ?? pg_get_style(this, 'height'); + var w = aparam.Width?aparam.Width:pg_get_style(this, 'width'); var h = aparam.Height?aparam.Height:pg_get_style(this, 'height'); resizeTo(this, w, h); diff --git a/centrallix/htmlgen/ht_render.c b/centrallix/htmlgen/ht_render.c index c98f81b14..647374a67 100644 --- a/centrallix/htmlgen/ht_render.c +++ b/centrallix/htmlgen/ht_render.c @@ -1500,10 +1500,12 @@ htr_internal_BuildClientWgtr_r(pHtSession s, pWgtrNode tree, int indent) htr_internal_WriteWgtrProperty(s, tree, "fl_y"); htr_internal_WriteWgtrProperty(s, tree, "fl_width"); htr_internal_WriteWgtrProperty(s, tree, "fl_height"); - htr_internal_WriteWgtrProperty(s, tree, "adj_weight_x"); - htr_internal_WriteWgtrProperty(s, tree, "adj_weight_y"); - htr_internal_WriteWgtrProperty(s, tree, "adj_weight_w"); - htr_internal_WriteWgtrProperty(s, tree, "adj_weight_h"); + htr_internal_WriteWgtrProperty(s, tree, "total_fl_x"); + htr_internal_WriteWgtrProperty(s, tree, "total_fl_y"); + htr_internal_WriteWgtrProperty(s, tree, "total_fl_w"); + htr_internal_WriteWgtrProperty(s, tree, "total_fl_h"); + htr_internal_WriteWgtrProperty(s, tree, "parent_w"); + htr_internal_WriteWgtrProperty(s, tree, "parent_h"); } propname = wgtrFirstPropertyName(tree); while(propname) @@ -2748,30 +2750,82 @@ htrFormatElement(pHtSession s, pWgtrNode node, char* id, int flags, int x, int y int ht_get_total_w__INTERNAL(pWgtrNode widget) { + /** Check to see if the value was already cached by a previous call. **/ + int cached_value = widget->parent_w; + if (cached_value != -1) { +// printf( +// "Got total width available to '%s' (%s) from cache: %dpx\n", +// widget->Name, widget->Type, cached_value +// ); + return cached_value; + } + + // DEBUG + if (widget->Parent == NULL) { + printf("\nPANIC: Call to ht_get_total_w__INTERNAL() on widget with no parent!\n\n"); + wgtrPrint(widget, 1); + } + + /** Cache miss, we'll need to traverse to the parent and find its width manually. */ pWgtrNode parent = widget->Parent; int parentWidth = parent->width; -// printf( -// "Getting total width available to '%s' (%s), child of '%s' (%s) - %dpx\n", -// widget->Name, widget->Type, parent->Name, parent->Type, parentWidth -// ); - if (parentWidth >= 0) { +// int isParentVisual = !(parent->Flags & WGTR_F_NONVISUAL); +// printf( +// "Getting total width available to '%s' (%s), child of '%s' (%s) - %dpx %d\n", +// widget->Name, widget->Type, parent->Name, parent->Type, parentWidth, isParentVisual +// ); + + /** Check if the parent has a width value. **/ + if (parentWidth >= 0 /* && isParentVisual */) { int offset = parent->left + parent->right, ret = parentWidth - offset; - // printf("Returning %d-%d=%d\n", parentWidth, offset, ret); - return ret; - } else return ht_get_total_w(parent); // Tail-recursion + printf("Returning %d-%d=%d\n", parentWidth, offset, ret); + return (widget->parent_w = ret); + } else { + if (parent->Parent == NULL) { + printf("Recursive call would segfault! Guessing %dpx instead.\n", parentWidth); + return (widget->parent_w = parentWidth); + } + return (widget->parent_w = ht_get_total_w(parent)); + } } int ht_get_total_h__INTERNAL(pWgtrNode widget) { + /** Check to see if the value was already cached by a previous call. **/ + int cached_value = widget->parent_h; + if (cached_value != -1) { +// printf( +// "Got total height available to '%s' (%s) from cache: %dpx\n", +// widget->Name, widget->Type, cached_value +// ); + return cached_value; + } + + // DEBUG + if (widget->Parent == NULL) { + printf("\nPANIC: Call to ht_get_total_h__INTERNAL() on widget with no parent!\n\n"); + wgtrPrint(widget, 1); + } + + /** Cache miss, we'll need to traverse to the parent and find its height manually. */ pWgtrNode parent = widget->Parent; int parentHeight = parent->height; -// printf( -// "Getting total height available to '%s' (%s), child of '%s' (%s) - %dpx\n", -// widget->Name, widget->Type, parent->Name, parent->Type, parentHeight -// ); - if (parentHeight >= 0) { +// int isParentVisual = !(parent->Flags & WGTR_F_NONVISUAL); +// printf( +// "Getting total height available to '%s' (%s), child of '%s' (%s) - %dpx %d\n", +// widget->Name, widget->Type, parent->Name, parent->Type, parentHeight, isParentVisual +// ); + + /** Check if the parent has a height value. **/ + if (parentHeight >= 0 /* && isParentVisual */) { int offset = parent->top + parent->bottom, ret = parentHeight - offset; - // printf("Returning %d-%d=%d\n", parentHeight, offset, ret); - return ret; - } else return ht_get_total_h(parent); // Tail-recursion + printf("Returning %d-%d=%d\n", parentHeight, offset, ret); + return (widget->parent_h = ret); + } else { + if (parent->Parent == NULL) { + printf("Recursive call would segfault! Guessing %dpx instead.\n", parentHeight); + return (widget->parent_h = parentHeight); + } + return (widget->parent_h = ht_get_total_h__INTERNAL(parent)); + } } diff --git a/centrallix/htmlgen/htdrv_component.c b/centrallix/htmlgen/htdrv_component.c index 93c5533a5..14988d1a4 100644 --- a/centrallix/htmlgen/htdrv_component.c +++ b/centrallix/htmlgen/htdrv_component.c @@ -353,8 +353,31 @@ htcmpRender(pHtSession s, pWgtrNode tree, int z) mssError(0,"HTCMP","Invalid component for widget '%s'",name); goto out; } - wgtrMoveChildren(cmp_tree, x, y); + /*** Adjusting children is no longer necessary because + *** the component is placed inside an isolating div. + *** Thus, the children's location within this div will + *** be correct without adjustment. + ***/ + // wgtrMoveChildren(cmp_tree, x, y); + + /** Style enclosing div. **/ + htrAddStylesheetItem_va(s, + "\t#cmp%POSbase { " + "POSITION:absolute; " + "VISIBILITY:inherit; " + "OVERFLOW:hidden; " + ht_flex_format_all + "Z-INDEX:%POS; " + "}\n", + id, + ht_flex_all(x, y, w, h, tree), + z + ); + + /** Enclosing div to isolate children. **/ + htrAddBodyItem_va(s,"
\n", id); + /** Check param references **/ htcmp_internal_CheckReferences(cmp_tree, params, s->Namespace->DName); @@ -369,6 +392,9 @@ htcmpRender(pHtSession s, pWgtrNode tree, int z) /** Switch the namespace back **/ htrLeaveNamespace(s); + /** End the containing layer. **/ + htrAddBodyItem(s, "
\n"); + /** End Init component **/ htrAddScriptInit_va(s, " cmp_endinit(wgtrGetNodeRef(ns,\"%STR&SYM\"));\n", name); diff --git a/centrallix/htmlgen/htdrv_dropdown.c b/centrallix/htmlgen/htdrv_dropdown.c index 335fe7f48..7f16bcbe5 100644 --- a/centrallix/htmlgen/htdrv_dropdown.c +++ b/centrallix/htmlgen/htdrv_dropdown.c @@ -145,12 +145,62 @@ int htddRender(pHtSession s, pWgtrNode tree, int z) { strtcpy(name,ptr,sizeof(name)); /** Ok, write the style header items. **/ - htrAddStylesheetItem_va(s,"\t#dd%POSbtn { OVERFLOW:hidden; POSITION:absolute; VISIBILITY:inherit; LEFT:%INTpx; TOP:%INTpx; HEIGHT:%POSpx; WIDTH:%POSpx; Z-INDEX:%POS; cursor:default; background-color: %STR&CSSVAL; border:1px outset #e0e0e0;}\n",id,x,y,h,w,z,bgstr); + htrAddStylesheetItem_va(s, + "\t#dd%POSbtn { " + "OVERFLOW:hidden; " + "POSITION:absolute; " + "VISIBILITY:inherit; " + "LEFT:"ht_flex_format"; " + "TOP:"ht_flex_format"; " + "WIDTH:"ht_flex_format"; " + "HEIGHT:"ht_flex_format"; " + "Z-INDEX:%POS; " + "cursor:default; " + "background-color: %STR&CSSVAL; " + "border:1px outset #e0e0e0; " + "}\n", + id, + ht_flex(x, ht_get_total_w(tree), ht_get_fl_x(tree)), + ht_flex(y, ht_get_total_h(tree), ht_get_fl_y(tree)), + ht_flex(w, ht_get_total_w(tree), ht_get_fl_w(tree)), + ht_flex(h, ht_get_total_h(tree), ht_get_fl_h(tree)), + z, + bgstr + ); if (*textcolor) { htrAddStylesheetItem_va(s,"\t#dd%POSbtn { color: %STR&CSSVAL; }\n",id,textcolor); } - htrAddStylesheetItem_va(s,"\t#dd%POScon1 { OVERFLOW:hidden; POSITION:absolute; VISIBILITY:inherit; LEFT:1px; TOP:1px; WIDTH:1024px; HEIGHT:%POSpx; Z-INDEX:%POS; }\n",id,h-2,z+1); - htrAddStylesheetItem_va(s,"\t#dd%POScon2 { OVERFLOW:hidden; POSITION:absolute; VISIBILITY:hidden; LEFT:1px; TOP:1px; WIDTH:1024px; HEIGHT:%POSpx; Z-INDEX:%POS; }\n",id,h-2,z+1); + htrAddStylesheetItem_va(s, + "\t#dd%POScon1 { " + "OVERFLOW:hidden; " + "POSITION:absolute; " + "VISIBILITY:inherit; " + "LEFT:1px; " + "TOP:1px; " + "WIDTH:1024px; " + "HEIGHT:"ht_flex_format"; " + "Z-INDEX:%POS; " + "}\n", + id, + ht_flex(h-2, h, 0.0), + z+1 + ); + /** I have no idea why we need dd#con2. It's hidden by default. **/ + htrAddStylesheetItem_va(s, + "\t#dd%POScon2 { " + "OVERFLOW:hidden; " + "POSITION:absolute; " + "VISIBILITY:hidden; " + "LEFT:1px; " + "TOP:1px; " + "WIDTH:1024px; " + "HEIGHT:"ht_flex_format"; " + "Z-INDEX:%POS; " + "}\n", + id, + ht_flex(h-2, h, 0.0), + z+1 + ); htrAddScriptGlobal(s, "dd_current", "null", 0); htrAddScriptGlobal(s, "dd_lastkey", "null", 0); diff --git a/centrallix/htmlgen/htdrv_image.c b/centrallix/htmlgen/htdrv_image.c index 7ad156f71..c46c66219 100644 --- a/centrallix/htmlgen/htdrv_image.c +++ b/centrallix/htmlgen/htdrv_image.c @@ -178,14 +178,39 @@ htimgRender(pHtSession s, pWgtrNode tree, int z) /** HTML body
element for the base layer. **/ if (!strcmp(aspect, "stretch")) { - htrAddBodyItemLayer_va(s, 0, "img%POS", id, "wimage", - "\n\n", + htrAddBodyItemLayer_va(s, + 0, "img%POS", id, "wimage", + "\n\n", id, w, h, src); } else // "preserve" { - htrAddBodyItemLayer_va(s, 0, "img%POS", id, "wimage", - "\n\n", + htrAddBodyItemLayer_va(s, + 0, "img%POS", id, "wimage", + "\n\n", id, w, h, src); } diff --git a/centrallix/htmlgen/htdrv_pane.c b/centrallix/htmlgen/htdrv_pane.c index 0caf96258..9bd8a6759 100644 --- a/centrallix/htmlgen/htdrv_pane.c +++ b/centrallix/htmlgen/htdrv_pane.c @@ -187,7 +187,7 @@ htpnRender(pHtSession s, pWgtrNode tree, int z) "\t#pn%POSmain {" "POSITION:absolute; " "VISIBILITY:inherit; " - "overflow:hidden; " + "OVERFLOW:hidden; " "LEFT:"ht_flex_format"; " "TOP:"ht_flex_format"; " "WIDTH:"ht_flex_format"; " @@ -234,7 +234,7 @@ htpnRender(pHtSession s, pWgtrNode tree, int z) /** HTML body
element for the base layer. **/ //htrAddBodyItem_va(s,"
\n",id, w-2, h-2); - htrAddBodyItem_va(s,"
\n",id, w-2, h-2); + htrAddBodyItem_va(s,"
\n", id); /** Check for objects within the pane. **/ htrRenderSubwidgets(s, tree, z+2); diff --git a/centrallix/include/apos.h b/centrallix/include/apos.h index da8792946..74fe8adf1 100644 --- a/centrallix/include/apos.h +++ b/centrallix/include/apos.h @@ -53,12 +53,12 @@ struct _APOS_L pAposSection ESection; // section ending with this line /*** Used to find the distance the line should move when the parent - *** container is resized. LocAdjWeight is the weight that this line - *** moves relative to the container. MyAdjWeight is the amount that - *** this line moves relative to the line before (left of) it. + *** container is resized. loc_fl (local flex) is the weight that this + *** line moves relative to the container. my_fl (my flex) is the amount + *** that this line moves relative to the line before (left of) it. *** Used for generating responsive CSS. ***/ - float LocAdjWeight, MyAdjWeight; + float loc_fl, my_fl; }; /**Section Structure (used for both rows and columns)**/ @@ -71,19 +71,6 @@ struct _APOS_S int DesiredWidth; //When we need to resize to honor max/mins int isSpacer; //set for narrow spaces between widgets int isBorder; //set for grid border sections - - /*** Computed value which stores the weight for how much this section - *** should be adjusted when resizing. All sections along each dimention - *** inside a single page or other container should have a total adjWeight - *** of 1.0. - *** - *** For example, if we have two sections with adj weights of 0.4 and 0.6. - *** If the container/page is stretched by 10 px, then 4 px is distributed - *** to the first section and 6 px is distributed to the second section. - *** - *** Warning: Currently unused. - ***/ - float AdjWeight; }; /**Grid Structure**/ @@ -175,4 +162,7 @@ int aposProcessWindows(pWgtrNode, pWgtrNode); /**Makes a pass through the tree t #define APOS_EGAPFLEX 30 #define APOS_CGAPFLEX 50 +/** Macros for readability and anticipation-of-change. **/ +#define isScrollpane(Parent) (!strcmp((Parent)->Type, "widget/scrollpane")) + #endif diff --git a/centrallix/include/ht_render.h b/centrallix/include/ht_render.h index b725eb9d4..02d32ec6d 100644 --- a/centrallix/include/ht_render.h +++ b/centrallix/include/ht_render.h @@ -396,34 +396,37 @@ int htruleRegister(char* ruletype, ...); ***/ #define ht_flex(size, total, flex) (size), (total), (flex) +/** ====[ Macros for getting total container size ]==== **/ +int ht_get_total_w__INTERNAL(pWgtrNode widget); +int ht_get_total_h__INTERNAL(pWgtrNode widget); + +#define ht_get_total_w(widget) ht_get_total_w__INTERNAL(widget) +#define ht_get_total_h(widget) ht_get_total_h__INTERNAL(widget) + +// #define ht_get_total_w(widget) ((widget)->Parent->width - (widget)->Parent->left - (widget)->Parent->right) +// #define ht_get_total_h(widget) ((widget)->Parent->height - (widget)->Parent->top - (widget)->Parent->bottom) + +/** ====[ Macros for getting total flexibilities ]==== **/ + /*** @param widget The widget to be queried. *** @returns The flexibility of the widget in the x direction. ***/ -#define ht_get_fl_x(widget) ((widget)->xAdjWeight) +#define ht_get_fl_x(widget) ((widget)->total_fl_x) /*** @param widget The widget to be queried. *** @returns The flexibility of the widget in the y direction. ***/ -#define ht_get_fl_y(widget) ((widget)->yAdjWeight) +#define ht_get_fl_y(widget) ((widget)->total_fl_y) /*** @param widget The widget to be queried. *** @returns The flexibility of the widget in the width direction. ***/ -#define ht_get_fl_w(widget) ((widget)->wAdjWeight) +#define ht_get_fl_w(widget) ((widget)->total_fl_w) /*** @param widget The widget to be queried. *** @returns The flexibility of the widget in the height direction. ***/ -#define ht_get_fl_h(widget) ((widget)->hAdjWeight) - -int ht_get_total_w__INTERNAL(pWgtrNode widget); -int ht_get_total_h__INTERNAL(pWgtrNode widget); - -#define ht_get_total_w(widget) ht_get_total_w__INTERNAL(widget) -#define ht_get_total_h(widget) ht_get_total_h__INTERNAL(widget) - -// #define ht_get_total_w(widget) ((widget)->Parent->width - (widget)->Parent->left - (widget)->Parent->right) -// #define ht_get_total_h(widget) ((widget)->Parent->height - (widget)->Parent->top - (widget)->Parent->bottom) +#define ht_get_fl_h(widget) ((widget)->total_fl_h) /*** @brief A shortcut function to get the flexibility when writing the *** LEFT CSS attribute. @@ -439,5 +442,31 @@ int ht_get_total_h__INTERNAL(pWgtrNode widget); ***/ #define ht_get_fl_t ht_get_fl_y +/** ====[ Macros for being lazy ]==== **/ + +#define ht_flex_x(x, widget) ht_flex(x, ht_get_total_w(widget), ht_get_fl_x(widget)) +#define ht_flex_y(y, widget) ht_flex(y, ht_get_total_h(widget), ht_get_fl_y(widget)) +#define ht_flex_w(w, widget) ht_flex(w, ht_get_total_w(widget), ht_get_fl_w(widget)) +#define ht_flex_h(h, widget) ht_flex(h, ht_get_total_h(widget), ht_get_fl_h(widget)) + +#define ht_flex_format_all \ + "LEFT:"ht_flex_format"; " \ + "TOP:"ht_flex_format"; " \ + "WIDTH:"ht_flex_format"; " \ + "HEIGHT:"ht_flex_format"; " \ + +#define ht_flex_all(x, y, w, h, widget) \ + ht_flex_x(x, widget), \ + ht_flex_y(y, widget), \ + ht_flex_w(w, widget), \ + ht_flex_h(h, widget) \ + +// Workaround because -lm isn't passed to my editor and this was the easiest way to fix it. +// This code should not appear in a pull request. If you are a code reviewer, remove this +// code or reject the PR. +#ifndef M_PI +#define M_PI 3.14159 +#endif + #endif /* _HT_RENDER_H */ diff --git a/centrallix/include/wgtr.h b/centrallix/include/wgtr.h index f11584f0d..298bf5dc9 100644 --- a/centrallix/include/wgtr.h +++ b/centrallix/include/wgtr.h @@ -100,16 +100,17 @@ typedef struct _WN char Namespace[64]; /** Namespace this widget and subwidgets are in **/ int r_x, r_y, r_width, r_height; /** Requested geometry **/ int pre_x, pre_y, pre_width, pre_height; /** pre-layout geom. **/ - int fl_x, fl_y, fl_width, fl_height;/** Flexibility **/ - double fx, fy, fw, fh; /** internal flexibility calculations **/ - double xAdjWeight, yAdjWeight; /** Responsive CSS adjustment weights for x and y */ - double wAdjWeight, hAdjWeight; /** Responsive CSS adjustment weights for width and height */ + int fl_x, fl_y, fl_width, fl_height;/** Flexibilities as specified by the designer **/ + double fx, fy, fw, fh; /** internal flexibility calculations **/ + double total_fl_x, total_fl_y; /** Total flexiblities as calculated for this layout. */ + double total_fl_w, total_fl_h; /** Responsive CSS adjustment weights for width and height */ + int parent_w, parent_h; /** The expected size of the parent container */ int min_width, min_height; /** absolute minimums **/ int x, y, width, height; /** actual geometry **/ int top, bottom, left, right; /** container offsets **/ XArray Properties; /** Array of widget properties **/ XArray Children; /** Array of child widgets **/ - struct _WN* Parent; + struct _WN* Parent; struct _WN* Root; int CurrProperty; /** Property to return on next call to wgtNextProperty **/ int CurrChild; /** Child to return on next call to wgtrNextChild **/ diff --git a/centrallix/wgtr/apos.c b/centrallix/wgtr/apos.c index f51d508b1..29a1b88ec 100644 --- a/centrallix/wgtr/apos.c +++ b/centrallix/wgtr/apos.c @@ -31,6 +31,8 @@ /*** Author: Israel Fuller *** Date: June, 2025 + *** + *** See also: Auto-Positioning.md *** *** I wasn't the one to write most of this (although I did write a ton of *** comments), but after doing my best to understand it, I hope that you will @@ -123,6 +125,11 @@ int i, childCnt, sectionCnt; pAposSection section; pWgtrNode child; + /*** Note: The "%*.*s" format specifier here takes two parameters: + *** - The first (indent*4) specifies the minimum width (number of spaces). + *** - The second (indent*4) limits the maximum number of characters to print. + *** Essentially, this adds (indent*4) spaces to the start of the line. + ***/ printf("%*.*s*** %s ***\n", indent*4, indent*4, "", tree->Name); if (tree->LayoutGrid) { @@ -448,7 +455,7 @@ int i=0, childCount=xaCount(&(Parent->Children)); *** Remember here that strcmp() returns 0 (false) if the strings are equal. ***/ if((Child->height < 0) && !(Child->Flags & WGTR_F_NONVISUAL) && - strcmp(Parent->Type, "widget/scrollpane")) + !isScrollpane(Parent)) aposPatchNegativeHeight(Child, PatchedWidgets); /** If child is a container, but not a floating window, recursively prepare it as well. **/ @@ -587,7 +594,7 @@ aposSetOffsetBools(pWgtrNode W, int *isSP, int *isWin, int *isTopTab, int *isSid ObjData val; /** Set isSP to compensate for scrollpane scrollbars. **/ - if(isSP) *isSP = (!strcmp(W->Type, "widget/scrollpane")); + if(isSP) *isSP = (isScrollpane(W)); /** Set isWin to compensate windows' titlebars, if any. **/ if(isWin && !strcmp(W->Type, "widget/childwindow")) @@ -838,7 +845,7 @@ pXArray FirstCross, LastCross; height_adj = Parent->min_height - Parent->pre_height; /** Add the 2 horizontal border lines, unless parent is a scrollpane. **/ - if(strcmp(Parent->Type, "widget/scrollpane")) + if(!isScrollpane(Parent)) { int minHeightLoc = 0, maxHeightLoc = Parent->pre_height - isWin * 24; if(aposCreateLine(NULL, HLines, minHeightLoc, APOS_NOT_LINKED, APOS_IS_BORDER, 0, APOS_HORIZONTAL) < 0) @@ -955,9 +962,10 @@ pWgtrNode C; else if(!(C->Flags & WGTR_F_NONVISUAL) && !(C->Flags & WGTR_F_FLOATING)) { /** Add horizontal lines, unless parent is a scrollpane. **/ - if(strcmp(Parent->Type, "widget/scrollpane")) + if(!isScrollpane(Parent)) { - /*** From this code, we see that the start line is + /*** Note: + *** From this code, we see that the start line is *** always the minY, and the end of the line is *** always the maxY. Thus, the top line is the *** start line and the bottom line is the end line @@ -969,14 +977,15 @@ pWgtrNode C; if(aposCreateLine(C, HLines, maxY, APOS_EWIDGETS, APOS_NOT_BORDER, height_adj, APOS_HORIZONTAL) < 0) goto CreateLineError; } - - /** Add vertical lines. **/ - /*** From this code, we see that the start line is always + + /*** Note: + *** From this code, we see that the start line is always *** the minX, and the end of the line is always the maxX. *** Thus, the left line is the start line and the right *** line is the end line because X increases as we move *** right along the page. ***/ + /** Add vertical lines. **/ int minX = (C->x), maxX = (C->x + C->width + isSideTab*tabWidth); if(aposCreateLine(C, VLines, minX, APOS_SWIDGETS, APOS_NOT_BORDER, 0, APOS_VERTICAL) < 0) goto CreateLineError; @@ -1465,10 +1474,9 @@ float TotalSum=0; TotalFlex += CurrSect->Flex; if(CurrSect->Flex) { - FlexibleSections++; - TotalFlexibleSpace += CurrSect->Width; + FlexibleSections++; + TotalFlexibleSpace += CurrSect->Width; } - else CurrSect->AdjWeight = 0.0f; } /*** If there is no flexibility (no expansion or contraction), we can't @@ -1490,7 +1498,7 @@ float TotalSum=0; /** The initial borders do not adjust. **/ pAposLine leftBorder = (pAposLine)xaGetItem(Lines, 0); - leftBorder->LocAdjWeight = leftBorder->MyAdjWeight = 0.0f; + leftBorder->loc_fl = leftBorder->my_fl = 0.0f; for(i=1; iAdjWeight = (float)(FlexWeight*SizeWeight)/TotalSum; + float fl = (float)(FlexWeight * SizeWeight) / TotalSum; /** Store the line adjustment weight for responsive CSS later. **/ - CurrLine->LocAdjWeight = PrevLine->LocAdjWeight + AdjWeight; - CurrLine->MyAdjWeight = AdjWeight; + CurrLine->loc_fl = PrevLine->loc_fl + fl; + CurrLine->my_fl = fl; /** Expand lines. **/ if(Diff > 0) { /** Calculate adjustment using the adjustment weight. **/ - Adj = (float)(Diff) * AdjWeight + APOS_FUDGEFACTOR; + Adj = (float)(Diff) * fl + APOS_FUDGEFACTOR; - // printf("Expanding lines by %d*%f=%d\n", Diff, AdjWeight, Adj); + // printf("Expanding lines by %d*%f=%d\n", Diff, fl, Adj); /** Apply the calculated adjustment. **/ PrevSect->Width += Adj; @@ -1526,9 +1534,9 @@ float TotalSum=0; else if(Diff < 0) { /** Calculate adjustment using the adjustment weight. **/ - Adj = (float)(Diff) * AdjWeight - APOS_FUDGEFACTOR; + Adj = (float)(Diff) * fl - APOS_FUDGEFACTOR; - // printf("Contracting lines by %d*%f=%d\n", Diff, AdjWeight, Adj); + // printf("Contracting lines by %d*%f=%d\n", Diff, fl, Adj); /** if the section width will be unacceptably *** narrow or negative after the adjustment **/ @@ -1596,11 +1604,11 @@ pWgtrNode Widget; Widget = (pWgtrNode)xaGetItem(&(CurrLine->SWidgets), j); if(flag == APOS_ROW) { Widget->y = CurrLine->Loc; - Widget->yAdjWeight = CurrLine->LocAdjWeight; + Widget->total_fl_y = CurrLine->loc_fl; } else { Widget->x = CurrLine->Loc; - Widget->xAdjWeight = CurrLine->LocAdjWeight; + Widget->total_fl_x = CurrLine->loc_fl; } } @@ -1627,7 +1635,7 @@ pWgtrNode Widget; *** to problems down the road, but I plan to fix *** them if and when I encounter them. ***/ - Widget->hAdjWeight += CurrLine->MyAdjWeight; + Widget->total_fl_h += CurrLine->my_fl; } else if(flag==APOS_COL && Widget->fl_width) { @@ -1650,7 +1658,7 @@ pWgtrNode Widget; *** to problems down the road, but I plan to fix *** them if and when I encounter them. ***/ - Widget->wAdjWeight += CurrLine->MyAdjWeight; + Widget->total_fl_w += CurrLine->my_fl; } } @@ -1661,9 +1669,9 @@ pWgtrNode Widget; { Widget = (pWgtrNode)xaGetItem(&(CurrLine->CWidgets), j); if(flag==APOS_ROW && Widget->fl_height) - Widget->hAdjWeight += CurrLine->MyAdjWeight; + Widget->total_fl_h += CurrLine->my_fl; else if(flag==APOS_COL && Widget->fl_width) - Widget->wAdjWeight += CurrLine->MyAdjWeight; + Widget->total_fl_w += CurrLine->my_fl; } } diff --git a/centrallix/wgtr/wgtr.c b/centrallix/wgtr/wgtr.c index 0fa312f19..5723c67eb 100755 --- a/centrallix/wgtr/wgtr.c +++ b/centrallix/wgtr/wgtr.c @@ -1310,10 +1310,11 @@ wgtrGetPropertyType(pWgtrNode widget, char* name) else if (!strcmp(name, "outer_type")) return DATA_T_STRING; else if (!strcmp(name, "x") || !strcmp(name, "y") || !strcmp(name, "width") || !strcmp(name, "height") || !strcmp(name, "r_x") || !strcmp(name, "r_y") || !strcmp(name, "r_width") || !strcmp(name, "r_height") || - !strcmp(name, "fl_x") || !strcmp(name, "fl_y") || !strcmp(name, "fl_width") || !strcmp(name, "fl_height")) + !strcmp(name, "fl_x") || !strcmp(name, "fl_y") || !strcmp(name, "fl_width") || !strcmp(name, "fl_height") || + !strcmp(name, "parent_w") || !strcmp(name, "parent_h")) return DATA_T_INTEGER; - else if (!strcmp(name, "adj_weight_x") || !strcmp(name, "adj_weight_y") || - !strcmp(name, "adj_weight_w") || !strcmp(name, "adj_weight_h") || + else if (!strcmp(name, "total_fl_x") || !strcmp(name, "total_fl_y") || + !strcmp(name, "total_fl_w") || !strcmp(name, "total_fl_h") || !strcmp(name, "fx") || !strcmp(name, "fy") || !strcmp(name, "fw") || !strcmp(name, "fh")) return DATA_T_DOUBLE; count = xaCount(&(widget->Properties)); @@ -1356,6 +1357,11 @@ wgtrGetPropertyValue(pWgtrNode widget, char* name, int datatype, pObjData val) if (!strcmp(name+3, "width")) { val->Integer = widget->fl_width; return 0; } if (!strcmp(name+3, "height")) { val->Integer = widget->fl_height; return 0; } } + else if (!strncmp(name, "parent_", 7)) + { + if (!strcmp(name+7, "w")) { val->Integer = widget->parent_w; return 0; } + if (!strcmp(name+7, "h")) { val->Integer = widget->parent_h; return 0; } + } } if (datatype == DATA_T_DOUBLE) { @@ -1366,12 +1372,12 @@ wgtrGetPropertyValue(pWgtrNode widget, char* name, int datatype, pObjData val) else if (!strcmp(name+1, "w")) { val->Double = widget->fw; return 0; } else if (!strcmp(name+1, "h")) { val->Double = widget->fh; return 0; } } - else if (!strncmp(name, "adj_weight_", 11)) + else if (!strncmp(name, "total_fl_", 9)) { - if (!strcmp(name+11, "x")) { val->Double = (double)widget->xAdjWeight; return 0; } - else if (!strcmp(name+11, "y")) { val->Double = (double)widget->yAdjWeight; return 0; } - else if (!strcmp(name+11, "w")) { val->Double = (double)widget->wAdjWeight; return 0; } - else if (!strcmp(name+11, "h")) { val->Double = (double)widget->hAdjWeight; return 0; } + if (!strcmp(name+9, "x")) { val->Double = (double)widget->total_fl_x; return 0; } + else if (!strcmp(name+9, "y")) { val->Double = (double)widget->total_fl_y; return 0; } + else if (!strcmp(name+9, "w")) { val->Double = (double)widget->total_fl_w; return 0; } + else if (!strcmp(name+9, "h")) { val->Double = (double)widget->total_fl_h; return 0; } } } else if (datatype == DATA_T_STRING) @@ -1592,10 +1598,10 @@ wgtrNewNode( char* name, char* type, pObjSession s, node->fl_y = fly; node->fl_width = flwidth; node->fl_height = flheight; + node->parent_h = node->parent_w = -1; node->ObjSession = s; node->Parent = NULL; - node->min_height = 0; - node->min_width = 0; + node->min_height = node->min_width = 0; node->LayoutGrid = NULL; node->Root = node; /* this will change when it is added as a child */ node->DMPrivate = NULL; From 31f9a0d66a3442d3e0322328c240fb804ffb186a Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Fri, 6 Feb 2026 12:45:48 -0700 Subject: [PATCH 066/275] Improve apos.c & add design support. Add tab-height support to apos.c. Add design support to apos.c. Add IsDesign to the WgtrClientInfo struct. Fix spelling mistakes. Clean up. --- centrallix/include/apos.h | 19 ++-- centrallix/include/wgtr.h | 1 + centrallix/netdrivers/net_http.c | 3 + centrallix/wgtr/apos.c | 174 ++++++++++++++++--------------- 4 files changed, 106 insertions(+), 91 deletions(-) diff --git a/centrallix/include/apos.h b/centrallix/include/apos.h index 74fe8adf1..0333421cc 100644 --- a/centrallix/include/apos.h +++ b/centrallix/include/apos.h @@ -92,7 +92,7 @@ int aposInit(); /**Registers datastructures used in auto-positioning**/ int aposInitiallizeGrid (pAposGrid); /**Initiallizes the XArrays in the grid object**/ int aposFree(pAposGrid); /**Frees dynamically allocated memory**/ int aposFreeGrids(pWgtrNode); /**Frees dynamically allocated memory**/ -int aposSetOffsetBools(pWgtrNode, int*, int*, int*, int*, int*); /**sets bools used to offset widgets**/ +int aposSetOffsetBools(pWgtrNode, int*, int*, int*, int*, int*, int*); /**sets bools used to offset widgets**/ int aposBuildGrid(pWgtrNode); /** builds the layout grids **/ int aposSetLimits(pWgtrNode); /** enforce min/max sizing **/ @@ -120,17 +120,18 @@ int aposMinimumChildFlex(pAposLine, int); /**Returns minimum flexibility of wid /**Resizing and Repositioning**/ int aposSpaceOutLines(pXArray, pXArray, int); /**Adjusts spaces between lines to expand or contract grid**/ -int aposSnapWidgetsToGrid(pXArray, int); /**Refreshes widget dimensions to match adjusted grid**/ +int aposSnapWidgetsToGrid(pXArray, int, pWgtrClientInfo); /**Refreshes widget dimensions to match adjusted grid**/ int aposProcessWindows(pWgtrNode, pWgtrNode); /**Makes a pass through the tree to process windows**/ -/** # defines names for magic values to make them easier to read. **/ -/** Indicates how a line links to a widget. */ +/** #define names for values to improve readability. **/ + +/** Indicates how a line links to a widget. **/ #define APOS_NOT_LINKED 0 #define APOS_SWIDGETS 1 #define APOS_EWIDGETS 2 -/** Indicates if a line is vertical. */ +/** Indicates if a line is vertical. **/ #define APOS_VERTICAL 1 #define APOS_HORIZONTAL 0 @@ -141,11 +142,11 @@ int aposProcessWindows(pWgtrNode, pWgtrNode); /**Makes a pass through the tree t #define APOS_ROW 1 #define APOS_COL 2 -/** Indicates if a line is a border. */ +/** Indicates if a line is a border. **/ #define APOS_IS_BORDER 1 #define APOS_NOT_BORDER 0 -/** Allows rounding when casting floats or doubles to ints. */ +/** Allows rounding when casting floats or doubles to ints. **/ #define APOS_FUDGEFACTOR 0.5 /*** The greatest width between two widgets that still defines them as @@ -159,6 +160,10 @@ int aposProcessWindows(pWgtrNode, pWgtrNode); /**Makes a pass through the tree t #define APOS_MINWIDTH 30 /** Default flexibilities for widgetless gaps in expanding or contracting applications. **/ +/*** Israel: I don't know the difference between these two values. I'm guessing + *** E stands enlarge and C stands for contract, thus (30, 50) makes it + *** easier for gaps to grown than for them to shrink. + ***/ #define APOS_EGAPFLEX 30 #define APOS_CGAPFLEX 50 diff --git a/centrallix/include/wgtr.h b/centrallix/include/wgtr.h index 298bf5dc9..d9a89b1dc 100644 --- a/centrallix/include/wgtr.h +++ b/centrallix/include/wgtr.h @@ -69,6 +69,7 @@ typedef struct int CharWidth; int CharHeight; int ParagraphHeight; /* total height of one line of text */ + int IsDesign; /* 1 if the page is rendered with cx__geom=design, 0 otherwise. */ char AKey[256]; char* Templates[WGTR_MAX_TEMPLATE]; char* Overlays[WGTR_MAX_OVERLAY]; diff --git a/centrallix/netdrivers/net_http.c b/centrallix/netdrivers/net_http.c index c74bc121b..17c6a464c 100755 --- a/centrallix/netdrivers/net_http.c +++ b/centrallix/netdrivers/net_http.c @@ -2096,6 +2096,9 @@ nht_i_GET(pNhtConn conn, pStruct url_inf, char* if_modified_since) wgtr_params.CharWidth = 7; wgtr_params.CharHeight = 16; wgtr_params.ParagraphHeight = 16; + + /** Specify design geometry **/ + wgtr_params.IsDesign = 1; } else { diff --git a/centrallix/wgtr/apos.c b/centrallix/wgtr/apos.c index 29a1b88ec..06550eda0 100644 --- a/centrallix/wgtr/apos.c +++ b/centrallix/wgtr/apos.c @@ -31,13 +31,13 @@ /*** Author: Israel Fuller *** Date: June, 2025 - *** + *** *** See also: Auto-Positioning.md *** *** I wasn't the one to write most of this (although I did write a ton of *** comments), but after doing my best to understand it, I hope that you will *** find the compiled information below helpful. - *** + *** *** Execution of this file usually begins when wgtrVerify() in wgtr.c calls *** aposAutoPositionWidgetTree(). To auto position the tree, the code first *** it draws four lines on the four edges of every visible widget (with some @@ -49,25 +49,25 @@ *** small amounts of space intended to provide visual room between widgets. *** When resizing, these do not flex at all. However, many elements are able *** to flex. @see aposSetFlexibilities() for more information about flexing. - *** + *** *** Next, the program uses aposSetLimits() to honor minimum and maximum sizes *** of widgets, and finally calls aposAutoPositionContainers() to position *** the widgets on the screen. Lastly, it calls aposProcessWindows() to handle *** floating window widgets, which are typically ignored by most of the rest *** of the code. - *** + *** *** Note: Due to this approach, this means that all sections and widgets start - *** and end at a line. The way these lines are set up ensures that start - *** lines are always on the top or left, and end lines are always on the - *** bottom or right. @see aposAddLinesForChildren() - *** - *** Notes: I wrote some information about various structs below that's good to - *** know. Some of this is covered elsewhere in the documentation. + *** and end at a line. The way these lines are set up ensures that start + *** lines are always on the top or left, and end lines are always on the + *** bottom or right. @see aposAddLinesForChildren() + *** + *** Note: I wrote some information about various structs below that's good to + *** know. Some of this is covered elsewhere in the documentation. *** *** AposGrid: A data structure to store sections and lines. - *** + *** *** AposLine: An AposLine spans the entire page. - *** + *** *** AposSection: After lines are created, sections are added in between the *** lines (aka. in between the nodes). Every node begins and ends on the *** edge of a section, although it may span multiple sections. @@ -80,7 +80,7 @@ *** *** XArray: This array also stores its size (nAlloc) and the number of items *** stored (nItems), so you don't have to pass that info separately. - *** + *** *** SWidgets, CWidgets, and EWidgets: Lines record which widgets start, cross, *** and end on them. These categories are exclusive, so a widget which *** starts on a given line will be in the SWidgets list but it will not be @@ -295,11 +295,11 @@ int sectCount; return 0; } -/*** Adjusts space to acomodate children, somehow? I think? +/*** Adjusts space to accommodate children, somehow? I think? *** *** @param Parent The widget node parent who's limits are being calculated. - *** @param delta_w The change in width required to accomodate children. - *** @param delta_h The change in height required to accomodate children. + *** @param delta_w The change in width required to accommodate children. + *** @param delta_h The change in height required to accommodate children. *** @returns 0 if successful, -1 otherwise. ***/ int @@ -406,7 +406,7 @@ pWgtrNode Child; return 0; } -/*** Adjusts space to acomodate children, somehow? I think? +/*** Adjusts space to accommodate children, somehow? I think? *** *** @param Parent The widget node parent who's limits are being calculated. *** @returns 0, success. @@ -543,7 +543,7 @@ int i=0, sectCount=0, TotalWidth=0, ProductSum=0; /*** Calculate average row flexibility, weighted by height. *** Note: Section height is called width here because rows - *** are one dimentional and the feild is reused. + *** are one dimensional and the feild is reused. ***/ sectCount = xaCount(&(theGrid->Rows)); for(i=0; iType, "widget/tab")) + if((isTopTab != NULL || isSideTab != NULL) && strcmp(W->Type, "widget/tab") == 0) { /*** Set isTopTab and isSideTab. If the node does not specify the *** tab location, assume it has a top tab and leave side-tab unset. **/ if(wgtrGetPropertyValue(W, "tab_location", DATA_T_STRING, &val) < 0) - *isTopTab = 1; // Property not found, assume it has a top tab only. + { + if (isTopTab != NULL) *isTopTab = 1; // Property not found, assume it has a top tab only. + } else { *isTopTab = (!strcmp(val.String, "top") || !strcmp(val.String, "bottom")); - *isSideTab = (!strcmp(val.String, "left") || (!strcmp(val.String, "right"))); // Warning: Unchecked assignment. + *isSideTab = (!strcmp(val.String, "left") || (!strcmp(val.String, "right"))); } - - /** Set the tab width. If none is specified, default to 80. **/ - if(wgtrGetPropertyValue(W, "tab_width", DATA_T_INTEGER, &val) < 0) - *tabWidth = 80; - else *tabWidth = val.Integer; } + + /** Set the tab width and height (if needed), defaulting to 24 and 80 if unspecified. **/ + if(tabWidth != NULL) *tabWidth = (wgtrGetPropertyValue(W, "tab_width", DATA_T_INTEGER, &val) == 0) ? val.Integer : 80; + if(tabHeight != NULL) *tabHeight = (wgtrGetPropertyValue(W, "tab_height", DATA_T_INTEGER, &val) == 0) ? val.Integer : 24; return 0; } @@ -703,7 +705,7 @@ pAposGrid theGrid = NULL; /*** Recursively auto-positions containers and their children based on their grids. *** - *** Note: Assumes that the grild was already built with a call to aposBuildGrid(). + *** Note: Assumes that the grid was already built with a call to aposBuildGrid(). *** *** @param Parent The parent node who's containers are being autopositioned. *** @returns 0 if successful, -1 otherwise. @@ -739,9 +741,9 @@ int rows_extra=0, cols_extra=0; /**modify the widgets' x,y,w, and h values to snap to their adjusted lines**/ if (!(Parent->Flags & WGTR_F_VSCROLLABLE)) - aposSnapWidgetsToGrid(&(theGrid->HLines), APOS_ROW); //rows + aposSnapWidgetsToGrid(&(theGrid->HLines), APOS_ROW, Parent->Root->ClientInfo); //rows if (!(Parent->Flags & WGTR_F_HSCROLLABLE)) - aposSnapWidgetsToGrid(&(theGrid->VLines), APOS_COL); //columns + aposSnapWidgetsToGrid(&(theGrid->VLines), APOS_COL, Parent->Root->ClientInfo); //columns /** did not resize? **/ /*if (rows_extra < 0) @@ -814,7 +816,7 @@ aposInitiallizeGrid(pAposGrid theGrid) *** lines for each visual child. Searches nonvisual containers recursively for *** qualifying grandchildren. Floating windows are ignored. *** - *** Scrollpanes recieve only 2 vertical lines (skipping their horizontal edges), + *** Scrollpanes receive only 2 vertical lines (skipping their horizontal edges), *** and if the parent node is a scrollpane, the horizontal border lines are also *** skipped. *** @@ -836,7 +838,7 @@ pAposLine CurrLine, PrevLine; pXArray FirstCross, LastCross; /** Check if this node a scrollbar or window that needs an offset. **/ - aposSetOffsetBools(Parent, &isSP, &isWin, NULL, NULL, NULL); + aposSetOffsetBools(Parent, &isSP, &isWin, NULL, NULL, NULL, NULL); /** Does this widget need more room than it was given? **/ if (Parent->pre_width < Parent->min_width && Parent->min_width != 0) @@ -916,7 +918,7 @@ pXArray FirstCross, LastCross; /*** Adds 4 lines for the edges of each visual child. Searches nonvisual *** containers recursively for qualifying grandchildren. Floating windows - *** are ignored. Scrollpanes recieve only 2 vertical lines (skipping their + *** are ignored. Scrollpanes receive only 2 vertical lines (skipping their *** horizontal edges). *** *** @param Parent The parent who's children are being given lines. @@ -928,7 +930,7 @@ int aposAddLinesForChildren(pWgtrNode Parent, pXArray HLines, pXArray VLines) { int i=0, childCount=xaCount(&(Parent->Children)); -int isTopTab=0, isSideTab=0, tabWidth=0; +int isTopTab=0, isSideTab=0, tabWidth=0, tabHeight=0; int height_adj, width_adj; pWgtrNode C; @@ -943,7 +945,7 @@ pWgtrNode C; for(i=0; iChildren), i); - aposSetOffsetBools(C, NULL, NULL, &isTopTab, &isSideTab, &tabWidth); + aposSetOffsetBools(C, NULL, NULL, &isTopTab, &isSideTab, &tabWidth, &tabHeight); /** Does this widget need more room than it was given? **/ height_adj = width_adj = 0; @@ -971,7 +973,7 @@ pWgtrNode C; *** start line and the bottom line is the end line *** because Y increases as we decend the page. ***/ - int minY = (C->y), maxY = (C->y + C->height + isTopTab*24); + int minY = (C->y), maxY = (C->y + C->height + isTopTab*tabHeight); if(aposCreateLine(C, HLines, minY, APOS_SWIDGETS, APOS_NOT_BORDER, 0, APOS_HORIZONTAL) < 0) goto CreateLineError; if(aposCreateLine(C, HLines, maxY, APOS_EWIDGETS, APOS_NOT_BORDER, height_adj, APOS_HORIZONTAL) < 0) @@ -1051,7 +1053,7 @@ pAposLine Line = aposExistingLine(Lines, Loc); return -1; } - /** Initiallize the new line. **/ + /** Initialize the new line. **/ memset(Line, 0, sizeof(AposLine)); xaInit(&(Line->SWidgets),16); xaInit(&(Line->EWidgets),16); @@ -1114,7 +1116,7 @@ int i, count = xaCount(Lines); } /*** Detects if a widget in PrevList (usually the widgets that started in or - *** crossed the pevious line) ends on this line (aka. appears in EWidgets). + *** crossed the previous line) ends on this line (aka. appears in EWidgets). *** If it does not end on this line, we know it crosses this line, so we add *** the widget to CWidgets. *** @@ -1160,7 +1162,7 @@ int found=0, i=0, j=0, pCount=xaCount(PrevList), eCount=xaCount(EWidgets); /*** Adds row and column sections to the grid based on the lines. *** - *** @param theGrid The grid to which sections shoudl be added. + *** @param theGrid The grid to which sections should be added. *** @param VDiff I had a hard time figuring out what this means. *** @param HDiff I had a hard time figuring out what this means. *** @returns 0 if successful, -1 otherwise. @@ -1240,7 +1242,7 @@ aposCreateSection(pXArray Sections, pAposLine StartL, pAposLine EndL, int Diff, { pAposSection NewSect; - /** Allocate and initiallize a new section. **/ + /** Allocate and initialize a new section. **/ if((NewSect = (pAposSection)(nmMalloc(sizeof(AposSection)))) < 0) { mssError(1, "APOS", "nmMalloc(): Couldn't allocate memory for new row or column"); @@ -1282,7 +1284,7 @@ pAposSection NewSect; *** *** @param StartL The line starting the section. (I think this is always the left/top.) *** @param EndL The line starting the section. (I think this is always the right/bottom.) - *** @param type Whether the section is a row (APOS_ROW) or a column (APAS_COL). + *** @param type Whether the section is a row (APOS_ROW) or a column (APOS_COL). *** @param isBorder Whether the section is on the border of the page. *** @returns 0 if successful, -1 otherwise. ***/ @@ -1330,10 +1332,10 @@ int eCount=xaCount(&(StartL->EWidgets)); } /*** Checks for any widgets starting on or crossing a line that are non-flexible - *** in the relevant dimention. + *** in the relevant dimension. *** *** @param L The line along which to check. - *** @param type Specifies the relevant dimetion using APOS_ROW or APOS_COL. + *** @param type Specifies the relevant dimension using APOS_ROW or APOS_COL. *** @returns 1 if any child widget is non-flexible in the relevant dimension, *** 0 otherwise. ***/ @@ -1372,7 +1374,7 @@ int cCount = xaCount(&(L->CWidgets)); /*** Calculates the average flexibility of widgets on a line. *** *** @param L The line along which to check. - *** @param type Specifies the relevant dimetion using APOS_ROW or APOS_COL. + *** @param type Specifies the relevant dimension using APOS_ROW or APOS_COL. *** @returns The average flexibility of children on the line. ***/ int @@ -1405,7 +1407,7 @@ int cCount = xaCount(&(L->CWidgets)); /*** Calculates the minimum flexibility of widgets on a line. *** *** @param L The line along which to check. - *** @param type Specifies the relevant dimetion using APOS_ROW or APOS_COL. + *** @param type Specifies the relevant dimension using APOS_ROW or APOS_COL. *** @returns The minimum flexibility of children on the line. ***/ int @@ -1450,8 +1452,8 @@ int cCount = xaCount(&(L->CWidgets)); /*** Distributes extra or missing space among grid lines based on section flexibility. *** *** @param Lines The array of lines in the relevant direction on this grid. - *** @param Secctions The array of sections in the relevant direction on this grid. - *** @param Diff The space differencce from how the elements are currently spaced. + *** @param Sections The array of sections in the relevant direction on this grid. + *** @param Diff The space difference from how the elements are currently spaced. *** @returns The remaining space difference after spacing out elements as much as possible. ***/ int @@ -1474,8 +1476,8 @@ float TotalSum=0; TotalFlex += CurrSect->Flex; if(CurrSect->Flex) { - FlexibleSections++; - TotalFlexibleSpace += CurrSect->Width; + FlexibleSections++; + TotalFlexibleSpace += CurrSect->Width; } } @@ -1576,19 +1578,23 @@ float TotalSum=0; return Extra; } +/** TODO: Israel - Update widget flex scales to be 0 if design geometry is specified. **/ /*** Adjusts widget positions and sizes to snap them to grid lines. This *** function should be called after updating grid lines to ensure that *** widgets properly reflect the changes. *** *** @param Lines The lines being updated. *** @param flag Either APOS_ROW or APOS_COL. + *** @param info Info about the page design, currently used to determine if + *** flexibility should be used. *** @returns 0, success. ***/ int -aposSnapWidgetsToGrid(pXArray Lines, int flag) +aposSnapWidgetsToGrid(pXArray Lines, int flag, pWgtrClientInfo info) { +const int is_design = info->IsDesign; int i=0, j=0, count=0, lineCount = xaCount(Lines); -int isTopTab=0, isSideTab=0, tabWidth=0; +int isTopTab=0, isSideTab=0, tabWidth=0, tabHeight=0; int newsize; pAposLine CurrLine; pWgtrNode Widget; @@ -1602,14 +1608,16 @@ pWgtrNode Widget; for(j=0; jSWidgets), j); - if(flag == APOS_ROW) { - Widget->y = CurrLine->Loc; - Widget->total_fl_y = CurrLine->loc_fl; - } - else { - Widget->x = CurrLine->Loc; - Widget->total_fl_x = CurrLine->loc_fl; - } + if(flag == APOS_ROW) + { + Widget->y = CurrLine->Loc; + Widget->fl_scale_y = (is_design) ? 0.0 : CurrLine->loc_fl; + } + else + { + Widget->x = CurrLine->Loc; + Widget->fl_scale_x = (is_design) ? 0.0 : CurrLine->loc_fl; + } } /** Adjusts width or height of widgets ending on this line. **/ @@ -1617,7 +1625,7 @@ pWgtrNode Widget; for(j=0; jEWidgets), j); - aposSetOffsetBools(Widget, NULL, NULL, &isTopTab, &isSideTab, &tabWidth); + aposSetOffsetBools(Widget, NULL, NULL, &isTopTab, &isSideTab, &tabWidth, &tabHeight); if(flag==APOS_ROW && Widget->fl_height) { /** Calculate the new size, taking APOS_MINWIDTH into account. **/ @@ -1629,13 +1637,11 @@ pWgtrNode Widget; else /*Widget->height = APOS_MINWIDTH;*/ Widget->height = Widget->pre_height; - + /*** The widget copies the adjustment weight of the - *** line, ignoring APOS_MINWIDTH. This might lead - *** to problems down the road, but I plan to fix - *** them if and when I encounter them. + *** line, ignoring APOS_MINWIDTH. ***/ - Widget->total_fl_h += CurrLine->my_fl; + Widget->fl_scale_h += (is_design) ? 0.0 : CurrLine->my_fl; } else if(flag==APOS_COL && Widget->fl_width) { @@ -1654,24 +1660,24 @@ pWgtrNode Widget; Widget->width = Widget->pre_width; /*** The widget copies the adjustment weight of the - *** line, ignoring APOS_MINWIDTH. This might lead - *** to problems down the road, but I plan to fix - *** them if and when I encounter them. + *** line, ignoring APOS_MINWIDTH. ***/ - Widget->total_fl_w += CurrLine->my_fl; + Widget->fl_scale_w += (is_design) ? 0.0 : CurrLine->my_fl; } } - /** Adjusts width or height of widgets ending on this line. **/ - count = xaCount(&(CurrLine->CWidgets)); - // printf("Doing %d widgets.\n", count); - for(j=0; jCWidgets), j); - if(flag==APOS_ROW && Widget->fl_height) - Widget->total_fl_h += CurrLine->my_fl; - else if(flag==APOS_COL && Widget->fl_width) - Widget->total_fl_w += CurrLine->my_fl; + if (!is_design) + { + /** Adjusts width or height of widgets ending on this line. **/ + count = xaCount(&(CurrLine->CWidgets)); + for(j=0; jCWidgets), j); + if(flag==APOS_ROW && Widget->fl_height) + Widget->fl_scale_h += (is_design) ? 0.0 : CurrLine->my_fl; + else if(flag==APOS_COL && Widget->fl_width) + Widget->fl_scale_w += (is_design) ? 0.0 : CurrLine->my_fl; + } } } @@ -1704,7 +1710,7 @@ int ival; return -1; } - aposSetOffsetBools(Parent, &isSP, &isWin, NULL, NULL, NULL); + aposSetOffsetBools(Parent, &isSP, &isWin, NULL, NULL, NULL, NULL); /**loop through children and process any windows**/ for(i=0; i Date: Fri, 6 Feb 2026 12:47:42 -0700 Subject: [PATCH 067/275] Improve error handling. Add an error message when cxsecVerifySymbol_n() fails. Improve an existing error message when htr_internal_WriteWgtrProperty() fails to write a property of an unknown type. Set Centrallix event listener to be explicitly non-passive, fixing a console error when later code assumes that calling preventDefault() is allowed. --- centrallix-os/sys/js/ht_render.js | 2 +- centrallix/htmlgen/ht_render.c | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/centrallix-os/sys/js/ht_render.js b/centrallix-os/sys/js/ht_render.js index cc93e167a..6b80b9ace 100644 --- a/centrallix-os/sys/js/ht_render.js +++ b/centrallix-os/sys/js/ht_render.js @@ -1489,7 +1489,7 @@ function htr_addeventlistener(eventType,obj,handler) if (typeof pg_capturedevents[eventType] == 'undefined') { pg_capturedevents[eventType] = handler; - obj.addEventListener(eventType, handler, true); + obj.addEventListener(eventType, handler, { capture: true, passive: false }); } } else diff --git a/centrallix/htmlgen/ht_render.c b/centrallix/htmlgen/ht_render.c index 647374a67..e0ec2305a 100644 --- a/centrallix/htmlgen/ht_render.c +++ b/centrallix/htmlgen/ht_render.c @@ -1425,7 +1425,8 @@ htr_internal_WriteWgtrProperty(pHtSession s, pWgtrNode tree, char* propname) break; default: - htrAddScriptWgtr_va(s, "%STR&SYM:'Unknown Datatype (%INT) - Add it in ht_render.c:htr_internal_WriteWgtrProperty()', ", propname, t); + fprintf(stderr, "Failed to write widget property '%s': Unknown datatype %d (at %s:%d).\n", propname, t, __FILE__, __LINE__); + htrAddScriptWgtr_va(s, "%STR&SYM:'Unknown Datatype (%INT) - Add it to htr_internal_WriteWgtrProperty() in ht_render.c.', ", propname, t); break; } } From 7b4b20b046ea5bcbd03ac8f32e3ce47241e8b942 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Fri, 6 Feb 2026 12:49:50 -0700 Subject: [PATCH 068/275] Fix the qprintf() % bug. Fix a bug in qprintf() that caused % and & characters inside conditional printing areas to always print, regardless of the condition. Improve documentation for qpfPrintf_va_internal() and qpf_grow_fn_t(). Clean up. --- centrallix-lib/src/qprintf.c | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/centrallix-lib/src/qprintf.c b/centrallix-lib/src/qprintf.c index 1f4538a3d..3bac70867 100644 --- a/centrallix-lib/src/qprintf.c +++ b/centrallix-lib/src/qprintf.c @@ -880,6 +880,14 @@ qpf_internal_Translate(pQPSession s, const char* srcbuf, size_t srcsize, char** *** change out from under this function to a new buffer if a realloc is *** done by the grow_fn function. Do not store pointers to 'str'. Go *** solely by offsets. + *** + *** NULL, &(s->Tmpbuf), &(s->TmpbufSize), htr_internal_GrowFn, (void*)s, fmt, va + *** @param s Optional session struct. + *** @param str Pointer to a string buffer where data will be written. + *** @param size Pointer to the current size of the string buffer. + *** @param grow_fn A function to grow the string buffer. + *** @param format The format of data which should be written. + *** @param ap The arguments list to fulfill the provided format. ***/ int qpfPrintf_va_internal(pQPSession s, char** str, size_t* size, qpf_grow_fn_t grow_fn, void* grow_arg, const char* format, va_list ap) @@ -975,6 +983,12 @@ qpfPrintf_va_internal(pQPSession s, char** str, size_t* size, qpf_grow_fn_t grow /** Simple specifiers **/ if (__builtin_expect(format[0] == '%', 0)) { + if (ignore) + { + format++; + continue; + } + if (__builtin_expect(!nogrow, 1) && (__builtin_expect(cpoffset+2 <= *size, 1) || (grow_fn(str, size, cpoffset, grow_arg, cpoffset+2)))) (*str)[cpoffset++] = '%'; else @@ -987,6 +1001,12 @@ qpfPrintf_va_internal(pQPSession s, char** str, size_t* size, qpf_grow_fn_t grow } else if (__builtin_expect(format[0] == '&',0)) { + if (ignore) + { + format++; + continue; + } + if (__builtin_expect(!nogrow, 1) && (__builtin_expect(cpoffset+2 <= *size, 1) || (grow_fn(str, size, cpoffset, grow_arg, cpoffset+2)))) (*str)[cpoffset++] = '&'; else @@ -1448,5 +1468,3 @@ qpfRegisterExt(char* ext_spec, int (*ext_fn)(), int is_source) return; } - - From f55bb7952ffdfeafb5b9c96c86a10da86454c599 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Fri, 6 Feb 2026 17:17:54 -0700 Subject: [PATCH 069/275] Improve naming conventions and dev experience. Add shortcut functions: ht_flex_x(), ht_flex_y(), ht_flex_w(), ht_flex_h(). Rename fl_scale_x (was total_fl_x). Rename fl_scale_y (was total_fl_y). Rename fl_scale_w (was total_fl_w). Rename fl_scale_h (was total_fl_h). Rename fl_parent_w (was parent_w). Rename fl_parent_h (was parent_h). Remove ht_flex_format_all and ht_flex_all(). Improve usage of new feature in previously updated widgets. Fix spelling mistakes. Clean up. --- centrallix/htmlgen/ht_render.c | 48 +++++----- centrallix/htmlgen/htdrv_autolayout.c | 8 +- centrallix/htmlgen/htdrv_image.c | 125 +++++++++++++------------- centrallix/htmlgen/htdrv_label.c | 27 +++--- centrallix/htmlgen/htdrv_pane.c | 37 ++++---- centrallix/htmlgen/htdrv_textbutton.c | 114 ++++++++++++++++------- centrallix/htmlgen/htdrv_treeview.c | 49 +++++----- centrallix/include/ht_render.h | 42 +++------ centrallix/include/wgtr.h | 6 +- centrallix/wgtr/wgtr.c | 44 +++++---- 10 files changed, 267 insertions(+), 233 deletions(-) diff --git a/centrallix/htmlgen/ht_render.c b/centrallix/htmlgen/ht_render.c index e0ec2305a..871eb258d 100644 --- a/centrallix/htmlgen/ht_render.c +++ b/centrallix/htmlgen/ht_render.c @@ -1501,12 +1501,12 @@ htr_internal_BuildClientWgtr_r(pHtSession s, pWgtrNode tree, int indent) htr_internal_WriteWgtrProperty(s, tree, "fl_y"); htr_internal_WriteWgtrProperty(s, tree, "fl_width"); htr_internal_WriteWgtrProperty(s, tree, "fl_height"); - htr_internal_WriteWgtrProperty(s, tree, "total_fl_x"); - htr_internal_WriteWgtrProperty(s, tree, "total_fl_y"); - htr_internal_WriteWgtrProperty(s, tree, "total_fl_w"); - htr_internal_WriteWgtrProperty(s, tree, "total_fl_h"); - htr_internal_WriteWgtrProperty(s, tree, "parent_w"); - htr_internal_WriteWgtrProperty(s, tree, "parent_h"); + htr_internal_WriteWgtrProperty(s, tree, "fl_scale_x"); + htr_internal_WriteWgtrProperty(s, tree, "fl_scale_y"); + htr_internal_WriteWgtrProperty(s, tree, "fl_scale_w"); + htr_internal_WriteWgtrProperty(s, tree, "fl_scale_h"); + htr_internal_WriteWgtrProperty(s, tree, "fl_parent_w"); + htr_internal_WriteWgtrProperty(s, tree, "fl_parent_h"); } propname = wgtrFirstPropertyName(tree); while(propname) @@ -2723,10 +2723,10 @@ htrFormatElement(pHtSession s, pWgtrNode node, char* id, int flags, int x, int y "%[%STR %]" "}\n", id, - ht_flex(x, ht_get_total_w(node), ht_get_fl_x(node)), - ht_flex(y, ht_get_total_h(node), ht_get_fl_y(node)), - (w > 0), ht_flex(w, ht_get_total_w(node), ht_get_fl_w(node)), - (h > 0), ht_flex(h, ht_get_total_h(node), ht_get_fl_h(node)), + ht_flex_x(x, node), + ht_flex_y(y, node), + (w > 0), ht_flex_w(w, node), + (h > 0), ht_flex_h(h, node), (z > 0), z, (*textcolor), textcolor, (!strcmp(style, "bold")), @@ -2750,9 +2750,9 @@ htrFormatElement(pHtSession s, pWgtrNode node, char* id, int flags, int x, int y int -ht_get_total_w__INTERNAL(pWgtrNode widget) { +ht_get_parent_w__INTERNAL(pWgtrNode widget) { /** Check to see if the value was already cached by a previous call. **/ - int cached_value = widget->parent_w; + int cached_value = widget->fl_parent_w; if (cached_value != -1) { // printf( // "Got total width available to '%s' (%s) from cache: %dpx\n", @@ -2763,7 +2763,7 @@ ht_get_total_w__INTERNAL(pWgtrNode widget) { // DEBUG if (widget->Parent == NULL) { - printf("\nPANIC: Call to ht_get_total_w__INTERNAL() on widget with no parent!\n\n"); + printf("\nPANIC: Call to ht_get_parent_w__INTERNAL() on widget with no parent!\n\n"); wgtrPrint(widget, 1); } @@ -2779,21 +2779,21 @@ ht_get_total_w__INTERNAL(pWgtrNode widget) { /** Check if the parent has a width value. **/ if (parentWidth >= 0 /* && isParentVisual */) { int offset = parent->left + parent->right, ret = parentWidth - offset; - printf("Returning %d-%d=%d\n", parentWidth, offset, ret); - return (widget->parent_w = ret); + // printf("Returning %d-%d=%d\n", parentWidth, offset, ret); + return (widget->fl_parent_w = ret); } else { if (parent->Parent == NULL) { printf("Recursive call would segfault! Guessing %dpx instead.\n", parentWidth); - return (widget->parent_w = parentWidth); + return (widget->fl_parent_w = parentWidth); } - return (widget->parent_w = ht_get_total_w(parent)); + return (widget->fl_parent_w = ht_get_parent_w(parent)); } } int -ht_get_total_h__INTERNAL(pWgtrNode widget) { +ht_get_parent_h__INTERNAL(pWgtrNode widget) { /** Check to see if the value was already cached by a previous call. **/ - int cached_value = widget->parent_h; + int cached_value = widget->fl_parent_h; if (cached_value != -1) { // printf( // "Got total height available to '%s' (%s) from cache: %dpx\n", @@ -2804,7 +2804,7 @@ ht_get_total_h__INTERNAL(pWgtrNode widget) { // DEBUG if (widget->Parent == NULL) { - printf("\nPANIC: Call to ht_get_total_h__INTERNAL() on widget with no parent!\n\n"); + printf("\nPANIC: Call to ht_get_parent_h__INTERNAL() on widget with no parent!\n\n"); wgtrPrint(widget, 1); } @@ -2820,13 +2820,13 @@ ht_get_total_h__INTERNAL(pWgtrNode widget) { /** Check if the parent has a height value. **/ if (parentHeight >= 0 /* && isParentVisual */) { int offset = parent->top + parent->bottom, ret = parentHeight - offset; - printf("Returning %d-%d=%d\n", parentHeight, offset, ret); - return (widget->parent_h = ret); + // printf("Returning %d-%d=%d\n", parentHeight, offset, ret); + return (widget->fl_parent_h = ret); } else { if (parent->Parent == NULL) { printf("Recursive call would segfault! Guessing %dpx instead.\n", parentHeight); - return (widget->parent_h = parentHeight); + return (widget->fl_parent_h = parentHeight); } - return (widget->parent_h = ht_get_total_h__INTERNAL(parent)); + return (widget->fl_parent_h = ht_get_parent_h__INTERNAL(parent)); } } diff --git a/centrallix/htmlgen/htdrv_autolayout.c b/centrallix/htmlgen/htdrv_autolayout.c index 9cc7eb7c4..02d6d7d2a 100644 --- a/centrallix/htmlgen/htdrv_autolayout.c +++ b/centrallix/htmlgen/htdrv_autolayout.c @@ -111,10 +111,10 @@ htalRender(pHtSession s, pWgtrNode tree, int z) "Z-INDEX:%POS; " "}\n", id, - ht_flex(x, ht_get_total_w(tree), ht_get_fl_x(tree)), - ht_flex(y, ht_get_total_h(tree), ht_get_fl_y(tree)), - ht_flex(w, ht_get_total_w(tree), ht_get_fl_w(tree)), - ht_flex(h, ht_get_total_h(tree), ht_get_fl_h(tree)), + ht_flex_x(x, tree), + ht_flex_y(y, tree), + ht_flex_w(w, tree), + ht_flex_h(h, tree), z ); diff --git a/centrallix/htmlgen/htdrv_image.c b/centrallix/htmlgen/htdrv_image.c index c46c66219..b9fe1585f 100644 --- a/centrallix/htmlgen/htdrv_image.c +++ b/centrallix/htmlgen/htdrv_image.c @@ -75,9 +75,9 @@ htimgRender(pHtSession s, pWgtrNode tree, int z) char src[256]; int x=-1,y=-1,w,h; int id, i; - char *text; char fieldname[HT_FIELDNAME_SIZE]; char form[64]; + char* alt_text; char* aspect; if(!(s->Capabilities.Dom0NS || s->Capabilities.Dom1HTML)) @@ -104,9 +104,9 @@ htimgRender(pHtSession s, pWgtrNode tree, int z) } if(wgtrGetPropertyValue(tree,"text",DATA_T_STRING,POD(&ptr)) == 0) - text=nmSysStrdup(ptr); + alt_text=nmSysStrdup(ptr); else - text=nmSysStrdup(""); + alt_text=nmSysStrdup(""); /** Image aspect scaling: stretch or preserve **/ if(wgtrGetPropertyValue(tree,"aspect",DATA_T_STRING,POD(&ptr)) == 0) @@ -122,7 +122,7 @@ htimgRender(pHtSession s, pWgtrNode tree, int z) /*if (!htrCheckAddExpression(s, tree, name, "source") && wgtrGetPropertyValue(tree,"source",DATA_T_STRING,POD(&ptr)) != 0) { mssError(1,"HTIMG","Image widget must have a 'source' property"); - nmSysFree(text); + nmSysFree(alt_text); return -1; }*/ ptr = ""; @@ -144,7 +144,28 @@ htimgRender(pHtSession s, pWgtrNode tree, int z) else form[0]='\0'; - /** Ok, write the style header items. **/ + /** Initialize linkage. **/ + htrAddWgtrObjLinkage_va(s, tree, "img%POS", id); + + /** Initialize image scripts. **/ + htrAddScriptInit_va(s, + "im_init(" + "wgtrGetNodeRef(ns,'%STR&SYM'), " + "{field:'%STR&JSSTR', form:'%STR&JSSTR'}" + ");\n", + name, + fieldname, form + ); + htrAddScriptInclude(s, "/sys/js/htdrv_image.js", 0); + + /** Event Handlers **/ + htrAddEventHandlerFunction(s, "document","MOUSEUP", "img", "im_mouseup"); + htrAddEventHandlerFunction(s, "document","MOUSEDOWN", "img", "im_mousedown"); + htrAddEventHandlerFunction(s, "document","MOUSEOVER", "img", "im_mouseover"); + htrAddEventHandlerFunction(s, "document","MOUSEOUT", "img", "im_mouseout"); + htrAddEventHandlerFunction(s, "document","MOUSEMOVE", "img", "im_mousemove"); + + /** Write the style for the image container div. **/ htrAddStylesheetItem_va(s, "\t#img%POS { " "left:"ht_flex_format"; " @@ -155,70 +176,52 @@ htimgRender(pHtSession s, pWgtrNode tree, int z) "text-align:center; " "}\n", id, - ht_flex(x, ht_get_total_w(tree), ht_get_fl_x(tree)), - ht_flex(y, ht_get_total_h(tree), ht_get_fl_y(tree)), - ht_flex(w, ht_get_total_w(tree), ht_get_fl_w(tree)), - ht_flex(h, ht_get_total_h(tree), ht_get_fl_h(tree)), + ht_flex_x(x, tree), + ht_flex_y(y, tree), + ht_flex_w(w, tree), + ht_flex_h(h, tree), z ); - /** Init image widget (?) **/ - htrAddWgtrObjLinkage_va(s, tree, "img%POS",id); - htrAddScriptInit_va(s, " im_init(wgtrGetNodeRef(ns,'%STR&SYM'), {field:'%STR&JSSTR', form:'%STR&JSSTR'});\n", - name, fieldname, form); - htrAddScriptInclude(s, "/sys/js/htdrv_image.js", 0); - - /** Event Handlers **/ - htrAddEventHandlerFunction(s, "document","MOUSEUP", "img", "im_mouseup"); - htrAddEventHandlerFunction(s, "document","MOUSEDOWN", "img", "im_mousedown"); - htrAddEventHandlerFunction(s, "document","MOUSEOVER", "img", "im_mouseover"); - htrAddEventHandlerFunction(s, "document","MOUSEOUT", "img", "im_mouseout"); - htrAddEventHandlerFunction(s, "document","MOUSEMOVE", "img", "im_mousemove"); - - /** HTML body
element for the base layer. **/ - if (!strcmp(aspect, "stretch")) - { - htrAddBodyItemLayer_va(s, - 0, "img%POS", id, "wimage", - "\n\n", - id, w, h, src); - } - else // "preserve" - { - htrAddBodyItemLayer_va(s, - 0, "img%POS", id, "wimage", - "\n\n", - id, w, h, src); - } + /** Use a style that honors the aspect ratio attribute. **/ + char* style = (strcmp(aspect, "stretch") == 0) + ? /* "stretch" */ + "width:100%; " + "height:100%; " + : /* "preserve" */ + "width:100%; " + "height:auto; " + "max-width:fit-content; " + "max-height:fit-content; " + "display:inline; "; + + /** Write image HTML, including the containing div. **/ + htrAddBodyItemLayer_va(s, 0, + "img%POS", id, "wimage", + "\n\n", + id, + w, + h, + style, + src, + alt_text + ); /** Check for more sub-widgets **/ for (i=0;iChildren));i++) htrRenderWidget(s, xaGetItem(&(tree->Children), i), z+1); - nmSysFree(text); + /** Clean up. **/ + nmSysFree(alt_text); + nmSysFree(aspect); return 0; } diff --git a/centrallix/htmlgen/htdrv_label.c b/centrallix/htmlgen/htdrv_label.c index ea315a9a5..77ea3ffdc 100644 --- a/centrallix/htmlgen/htdrv_label.c +++ b/centrallix/htmlgen/htdrv_label.c @@ -199,13 +199,13 @@ htlblRender(pHtSession s, pWgtrNode tree, int z) /** Ok, write the style header items. **/ htrAddStylesheetItem_va(s, "\t#lbl%POS { " - "POSITION:absolute; " - "VISIBILITY:inherit; " - "LEFT:"ht_flex_format"; " - "TOP:"ht_flex_format"; " - "WIDTH:"ht_flex_format"; " - "%[HEIGHT:"ht_flex_format"; %]" - "Z-INDEX:%POS; " + "position:absolute; " + "visibility:inherit; " + "left:"ht_flex_format"; " + "top:"ht_flex_format"; " + "width:"ht_flex_format"; " + "%[height:"ht_flex_format"; %]" + "z-index:%POS; " "cursor:default; " "%[font-weight:bold; %]" "%[color:%STR&CSSVAL; %]" @@ -217,10 +217,10 @@ htlblRender(pHtSession s, pWgtrNode tree, int z) "%[font-style:italic; %]" "}\n", id, - ht_flex(x, ht_get_total_w(tree), ht_get_fl_x(tree)), - ht_flex(y, ht_get_total_h(tree), ht_get_fl_y(tree)), - ht_flex(w, ht_get_total_w(tree), ht_get_fl_w(tree)), - (!auto_height), ht_flex(h, ht_get_total_h(tree), ht_get_fl_h(tree)), + ht_flex_x(x, tree), + ht_flex_y(y, tree), + ht_flex_w(w, tree), + (!auto_height), ht_flex_h(h, tree), z, (is_bold), (*fgcolor), fgcolor, @@ -244,12 +244,11 @@ htlblRender(pHtSession s, pWgtrNode tree, int z) "padding:0px; " "margin:0px; " "border-spacing:0px; " - "width:"ht_flex_format"; " + "width:100%%; " "}\n", id, align, - !strcmp(valign, "middle"), - ht_flex(w, ht_get_total_w(tree), ht_get_fl_w(tree)) + (strcmp(valign, "middle") == 0) ); htrAddWgtrObjLinkage_va(s, tree, "lbl%POS",id); diff --git a/centrallix/htmlgen/htdrv_pane.c b/centrallix/htmlgen/htdrv_pane.c index 9bd8a6759..6536a9689 100644 --- a/centrallix/htmlgen/htdrv_pane.c +++ b/centrallix/htmlgen/htdrv_pane.c @@ -135,6 +135,8 @@ htpnRender(pHtSession s, pWgtrNode tree, int z) if (!strcmp(ptr,"flat")) style = 2; if (!strcmp(ptr,"bordered")) style = 3; } + + /** Computes styling colors. **/ if (style == 1) /* raised */ { c1 = "white"; @@ -153,7 +155,7 @@ htpnRender(pHtSession s, pWgtrNode tree, int z) strtcpy(bdr,ptr,sizeof(bdr)); } - /** Ok, write the style header items. **/ + /** Write the CSS for borders on the pane dom node. **/ int offset = 0; if (style == 2) { /* flat, the default style, nothing to do */ } else if (style == 0 || style == 1) /* lowered or raised */ @@ -183,24 +185,29 @@ htpnRender(pHtSession s, pWgtrNode tree, int z) ); } + /** Apply the offset to the width and height. **/ + w += offset; + h += offset; + + /** Write the main CSS for the pane DOM node. **/ htrAddStylesheetItem_va(s, "\t#pn%POSmain {" - "POSITION:absolute; " - "VISIBILITY:inherit; " - "OVERFLOW:hidden; " - "LEFT:"ht_flex_format"; " - "TOP:"ht_flex_format"; " - "WIDTH:"ht_flex_format"; " - "HEIGHT:"ht_flex_format"; " - "Z-INDEX:%POS; " - "border-radius: %INTpx;" - "%STR" + "position:absolute; " + "visibility:inherit; " + "overflow:hidden; " + "left:"ht_flex_format"; " + "top:"ht_flex_format"; " + "width:"ht_flex_format"; " + "height:"ht_flex_format"; " + "z-index:%POS; " + "border-radius:%INTpx; " + "%STR " "}\n", id, - ht_flex(x, ht_get_total_w(tree), ht_get_fl_x(tree)), - ht_flex(y, ht_get_total_h(tree), ht_get_fl_y(tree)), - ht_flex(w + offset, ht_get_total_w(tree), ht_get_fl_w(tree)), - ht_flex(h + offset, ht_get_total_h(tree), ht_get_fl_h(tree)), + ht_flex_x(x, tree), + ht_flex_y(y, tree), + ht_flex_w(w, tree), + ht_flex_h(h, tree), z, border_radius, main_bg diff --git a/centrallix/htmlgen/htdrv_textbutton.c b/centrallix/htmlgen/htdrv_textbutton.c index 92c07357b..66b7e0408 100644 --- a/centrallix/htmlgen/htdrv_textbutton.c +++ b/centrallix/htmlgen/htdrv_textbutton.c @@ -2,6 +2,7 @@ #include #include #include +#include #include "ht_render.h" #include "obj.h" #include "cxlib/mtask.h" @@ -75,6 +76,7 @@ httbtnRender(pHtSession s, pWgtrNode tree, int z) char border_color[64]; char image_position[16]; /* top, left, right, bottom */ char image[OBJSYS_MAX_PATH]; + bool has_image; char h_align[16]; int image_width=0, image_height=0, image_margin=0; @@ -137,9 +139,15 @@ httbtnRender(pHtSession s, pWgtrNode tree, int z) /** Image source **/ if (wgtrGetPropertyValue(tree,"image",DATA_T_STRING,POD(&ptr)) != 0) + { strcpy(image, ""); + has_image = false; + } else + { strtcpy(image, ptr, sizeof(image)); + has_image = true; + } /** Image sizing **/ if (wgtrGetPropertyValue(tree,"image_width",DATA_T_INTEGER, POD(&image_width)) != 0) @@ -205,33 +213,39 @@ httbtnRender(pHtSession s, pWgtrNode tree, int z) htrAddScriptInclude(s, "/sys/js/htdrv_textbutton.js", 0); htrAddScriptInclude(s, "/sys/js/ht_utils_layers.js", 0); - /** Initial CSS styles **/ + /** Calculate size adjustment. **/ + const int adj = (2 * box_offset) + 1; + + /** Write CSS for the container that will hold the button. **/ htrAddStylesheetItem_va(s, "\t#tb%POSpane { " - "POSITION:absolute; " - "VISIBILITY:inherit; " - "LEFT:"ht_flex_format"; " - "TOP:"ht_flex_format"; " - "WIDTH:"ht_flex_format"; " - "%[HEIGHT:"ht_flex_format"; %]" - "Z-INDEX:%POS; " - "OVERFLOW:hidden; " + "position:absolute; " + "visibility:inherit; " + "left:"ht_flex_format"; " + "top:"ht_flex_format"; " + "width:"ht_flex_format"; " + "%[height:"ht_flex_format"; %]" + "z-index:%POS; " + "overflow:hidden; " "display:table; " "}\n", id, - ht_flex(x, ht_get_total_w(tree), ht_get_fl_x(tree)), - ht_flex(y, ht_get_total_h(tree), ht_get_fl_y(tree)), - ht_flex(w-1-2*box_offset, ht_get_total_w(tree), ht_get_fl_w(tree)), - (h>=0), ht_flex(h-1-2*box_offset, ht_get_total_h(tree), ht_get_fl_h(tree)), + ht_flex_x(x, tree), + ht_flex_y(y, tree), + ht_flex_w(w - adj, tree), + (h >= 0), ht_flex_h(h - adj, tree), z ); - // CSS button click animation (replaces manual the JS implementation). + + /** Button click animation. **/ if (is_enabled) { htrAddStylesheetItem_va(s, "\t#tb%POSpane:active { transform: translate(1px, 1px); }\n", id ); } + + /** Write CSS for the button content, inside the border. **/ htrAddStylesheetItem_va(s, "\t#tb%POSpane .cell { " "height:100%%; " @@ -260,14 +274,20 @@ httbtnRender(pHtSession s, pWgtrNode tree, int z) bgstyle ); - /** CSS for image on the button **/ - if (image[0] && (image_width || image_height || image_margin)) + /** Write CSS for image on the button. **/ + if (has_image && (image_width != 0 || image_height != 0 || image_margin != 0)) { - htrAddStylesheetItem_va(s, "\t#tb%POSpane img { %[height:%POSpx; %]%[width:%POSpx; %]%[margin:%POSpx;%] }\n", - id, - image_height, image_height, - image_width, image_width, - image_margin, image_margin); + htrAddStylesheetItem_va(s, + "\t#tb%POSpane img { " + "%[height:%POSpx; %]" + "%[width:%POSpx; %]" + "%[margin:%POSpx; %]" + "}\n", + id, + (image_height != 0), image_height, + (image_width != 0), image_width, + (image_margin != 0), image_margin + ); } #if 00 @@ -291,30 +311,56 @@ httbtnRender(pHtSession s, pWgtrNode tree, int z) /** We need two DIVs here because of a long-outstanding Firefox bug :( **/ htrAddBodyItem_va(s, - "
" - "
" - "%[
%]" - "%[%]" + "
" + "
" + "%[
%]" + "%[%]" "%STR&HTE" - "%[%]" - "%[
%]" + "%[%]" + "%[
%]" "
" "
", id, - (image[0] && !strcmp(image_position, "top")), image, - (image[0] && !strcmp(image_position, "left")), image, + (has_image && strcmp(image_position, "top") == 0), image, + (has_image && strcmp(image_position, "left") == 0), image, text, - (image[0] && !strcmp(image_position, "right")), image, - (image[0] && !strcmp(image_position, "bottom")), image + (has_image && strcmp(image_position, "right") == 0), image, + (has_image && strcmp(image_position, "bottom") == 0), image ); /** Script initialization call. **/ //htrAddScriptInit_va(s, " tb_init({layer:wgtrGetNodeRef(ns,'%STR&SYM'), span:document.getElementById(\"tb%POSspan\"), ena:%INT, c1:\"%STR&JSSTR\", c2:\"%STR&JSSTR\", dc1:\"%STR&JSSTR\", top:null, bottom:null, right:null, left:null, width:%INT, height:%INT, tristate:%INT, name:\"%STR&SYM\", text:'%STR&JSSTR'});\n", //name, id, is_enabled, fgcolor1, fgcolor2, disable_color, w, h, is_ts, name, text); - htrAddScriptInit_va(s, " tb_init({layer:wgtrGetNodeRef(ns,'%STR&SYM'), ena:%INT, c1:\"%STR&JSSTR\", c2:\"%STR&JSSTR\", dc1:\"%STR&JSSTR\", top:null, bottom:null, right:null, left:null, width:%INT, height:%INT, tristate:%INT, name:\"%STR&SYM\", text:'%STR&JSSTR'});\n", - name, is_enabled, fgcolor1, fgcolor2, disable_color, w, h, is_ts, name, text); + htrAddScriptInit_va(s, + "tb_init({ " + "layer:wgtrGetNodeRef(ns, '%STR&SYM'), " + "ena:%INT, " + "c1:'%STR&JSSTR', " + "c2:'%STR&JSSTR', " + "dc1:'%STR&JSSTR', " + "top:null, " + "bottom:null, " + "right:null, " + "left:null, " + "width:%INT, " + "height:%INT, " + "tristate:%INT, " + "name:'%STR&SYM', " + "text:'%STR&JSSTR', " + "});\n", + name, + is_enabled, + fgcolor1, + fgcolor2, + disable_color, + w, + h, + is_ts, + name, + text + ); - /** Add the event handling scripts **/ + /** Add event handlers. **/ htrAddEventHandlerFunction(s, "document", "MOUSEDOWN", "tb", "tb_mousedown"); htrAddEventHandlerFunction(s, "document", "MOUSEUP", "tb", "tb_mouseup"); htrAddEventHandlerFunction(s, "document", "MOUSEOVER", "tb", "tb_mouseover"); diff --git a/centrallix/htmlgen/htdrv_treeview.c b/centrallix/htmlgen/htdrv_treeview.c index 05a2bae8f..2e3e44cbe 100644 --- a/centrallix/htmlgen/htdrv_treeview.c +++ b/centrallix/htmlgen/htdrv_treeview.c @@ -174,18 +174,18 @@ httreeRender(pHtSession s, pWgtrNode tree, int z) { htrAddStylesheetItem_va(s, "\t#tv%POSroot { " - "POSITION:absolute; " - "VISIBILITY:%STR; " - "LEFT:"ht_flex_format"; " - "TOP:"ht_flex_format"; " - "WIDTH:"ht_flex_format"; " - "Z-INDEX:%POS; " + "position:absolute; " + "visibility:%STR; " + "left:"ht_flex_format"; " + "top:"ht_flex_format"; " + "width:"ht_flex_format"; " + "z-index:%POS; " "}\n", id, (show_root) ? "inherit" : "hidden", - ht_flex(x, ht_get_total_w(tree), ht_get_fl_x(tree)), - ht_flex(y, ht_get_total_h(tree), ht_get_fl_y(tree)), - ht_flex(w, ht_get_total_w(tree), ht_get_fl_w(tree)), + ht_flex_x(x, tree), + ht_flex_y(y, tree), + ht_flex_w(w, tree), z ); } @@ -221,32 +221,31 @@ httreeRender(pHtSession s, pWgtrNode tree, int z) else { htrAddBodyItem_va(s, - "
" - "" + "" " %STR&HTE" - "
\n", - id, /** Class **/ - id, /** ID **/ + "
\n", + id, /* class */ + id, /* id */ (show_root) ? "inherit" : "hidden", - ht_flex(x, ht_get_total_w(tree), ht_get_fl_x(tree)), - ht_flex(y, ht_get_total_h(tree), ht_get_fl_y(tree)), - ht_flex(w, ht_get_total_w(tree), ht_get_fl_w(tree)), + ht_flex_x(x, tree), + ht_flex_y(y, tree), + ht_flex_w(w, tree), z, (*icon) ? icon : "/sys/images/ico02b.gif", src ); htrAddBodyItemLayer_va(s, HTR_LAYER_F_DYNAMIC, "tv%POSload", id, NULL, ""); - /*htrAddBodyItem_va(s, "
\n",id);*/ } /** Event handler for click-on-url **/ diff --git a/centrallix/include/ht_render.h b/centrallix/include/ht_render.h index 02d32ec6d..63247cfaf 100644 --- a/centrallix/include/ht_render.h +++ b/centrallix/include/ht_render.h @@ -390,43 +390,40 @@ int htruleRegister(char* ruletype, ...); *** *** @param size The original size of the ui element. *** @param total The total size of the ui element's container. - *** @param flex The flexibility of the ui element. It is strongly recomended + *** @param flex The flexibility of the ui element. It is strongly recommended *** to generate this with an ht_get_fl function call. *** @returns Several values to serve as parameters for a qprintf call. ***/ #define ht_flex(size, total, flex) (size), (total), (flex) /** ====[ Macros for getting total container size ]==== **/ -int ht_get_total_w__INTERNAL(pWgtrNode widget); -int ht_get_total_h__INTERNAL(pWgtrNode widget); +int ht_get_parent_w__INTERNAL(pWgtrNode widget); +int ht_get_parent_h__INTERNAL(pWgtrNode widget); -#define ht_get_total_w(widget) ht_get_total_w__INTERNAL(widget) -#define ht_get_total_h(widget) ht_get_total_h__INTERNAL(widget) - -// #define ht_get_total_w(widget) ((widget)->Parent->width - (widget)->Parent->left - (widget)->Parent->right) -// #define ht_get_total_h(widget) ((widget)->Parent->height - (widget)->Parent->top - (widget)->Parent->bottom) +#define ht_get_parent_w(widget) ht_get_parent_w__INTERNAL(widget) +#define ht_get_parent_h(widget) ht_get_parent_h__INTERNAL(widget) /** ====[ Macros for getting total flexibilities ]==== **/ /*** @param widget The widget to be queried. *** @returns The flexibility of the widget in the x direction. ***/ -#define ht_get_fl_x(widget) ((widget)->total_fl_x) +#define ht_get_fl_x(widget) ((widget)->fl_scale_x) /*** @param widget The widget to be queried. *** @returns The flexibility of the widget in the y direction. ***/ -#define ht_get_fl_y(widget) ((widget)->total_fl_y) +#define ht_get_fl_y(widget) ((widget)->fl_scale_y) /*** @param widget The widget to be queried. *** @returns The flexibility of the widget in the width direction. ***/ -#define ht_get_fl_w(widget) ((widget)->total_fl_w) +#define ht_get_fl_w(widget) ((widget)->fl_scale_w) /*** @param widget The widget to be queried. *** @returns The flexibility of the widget in the height direction. ***/ -#define ht_get_fl_h(widget) ((widget)->total_fl_h) +#define ht_get_fl_h(widget) ((widget)->fl_scale_h) /*** @brief A shortcut function to get the flexibility when writing the *** LEFT CSS attribute. @@ -444,22 +441,10 @@ int ht_get_total_h__INTERNAL(pWgtrNode widget); /** ====[ Macros for being lazy ]==== **/ -#define ht_flex_x(x, widget) ht_flex(x, ht_get_total_w(widget), ht_get_fl_x(widget)) -#define ht_flex_y(y, widget) ht_flex(y, ht_get_total_h(widget), ht_get_fl_y(widget)) -#define ht_flex_w(w, widget) ht_flex(w, ht_get_total_w(widget), ht_get_fl_w(widget)) -#define ht_flex_h(h, widget) ht_flex(h, ht_get_total_h(widget), ht_get_fl_h(widget)) - -#define ht_flex_format_all \ - "LEFT:"ht_flex_format"; " \ - "TOP:"ht_flex_format"; " \ - "WIDTH:"ht_flex_format"; " \ - "HEIGHT:"ht_flex_format"; " \ - -#define ht_flex_all(x, y, w, h, widget) \ - ht_flex_x(x, widget), \ - ht_flex_y(y, widget), \ - ht_flex_w(w, widget), \ - ht_flex_h(h, widget) \ +#define ht_flex_x(x, widget) ht_flex(x, ht_get_parent_w(widget), ht_get_fl_x(widget)) +#define ht_flex_y(y, widget) ht_flex(y, ht_get_parent_h(widget), ht_get_fl_y(widget)) +#define ht_flex_w(w, widget) ht_flex(w, ht_get_parent_w(widget), ht_get_fl_w(widget)) +#define ht_flex_h(h, widget) ht_flex(h, ht_get_parent_h(widget), ht_get_fl_h(widget)) // Workaround because -lm isn't passed to my editor and this was the easiest way to fix it. // This code should not appear in a pull request. If you are a code reviewer, remove this @@ -469,4 +454,3 @@ int ht_get_total_h__INTERNAL(pWgtrNode widget); #endif #endif /* _HT_RENDER_H */ - diff --git a/centrallix/include/wgtr.h b/centrallix/include/wgtr.h index d9a89b1dc..fd296ead3 100644 --- a/centrallix/include/wgtr.h +++ b/centrallix/include/wgtr.h @@ -103,9 +103,9 @@ typedef struct _WN int pre_x, pre_y, pre_width, pre_height; /** pre-layout geom. **/ int fl_x, fl_y, fl_width, fl_height;/** Flexibilities as specified by the designer **/ double fx, fy, fw, fh; /** internal flexibility calculations **/ - double total_fl_x, total_fl_y; /** Total flexiblities as calculated for this layout. */ - double total_fl_w, total_fl_h; /** Responsive CSS adjustment weights for width and height */ - int parent_w, parent_h; /** The expected size of the parent container */ + double fl_scale_x, fl_scale_y; /** Scaled x and y flexibilities calculated for this layout. */ + double fl_scale_w, fl_scale_h; /** Scaled w and h flexibilities calculated for this layout. */ + int fl_parent_w, fl_parent_h; /** The expected size of the parent container, used when it flexes. */ int min_width, min_height; /** absolute minimums **/ int x, y, width, height; /** actual geometry **/ int top, bottom, left, right; /** container offsets **/ diff --git a/centrallix/wgtr/wgtr.c b/centrallix/wgtr/wgtr.c index 5723c67eb..0f19ffc41 100755 --- a/centrallix/wgtr/wgtr.c +++ b/centrallix/wgtr/wgtr.c @@ -1306,17 +1306,18 @@ wgtrGetPropertyType(pWgtrNode widget, char* name) pObjProperty prop; ASSERTMAGIC(widget, MGK_WGTR); - if (!strcmp(name, "name")) return DATA_T_STRING; - else if (!strcmp(name, "outer_type")) return DATA_T_STRING; + if (!strcmp(name, "name") || !strcmp(name, "outer_type")) + return DATA_T_STRING; else if (!strcmp(name, "x") || !strcmp(name, "y") || !strcmp(name, "width") || !strcmp(name, "height") || !strcmp(name, "r_x") || !strcmp(name, "r_y") || !strcmp(name, "r_width") || !strcmp(name, "r_height") || !strcmp(name, "fl_x") || !strcmp(name, "fl_y") || !strcmp(name, "fl_width") || !strcmp(name, "fl_height") || - !strcmp(name, "parent_w") || !strcmp(name, "parent_h")) + !strcmp(name, "fl_parent_w") || !strcmp(name, "fl_parent_h")) return DATA_T_INTEGER; - else if (!strcmp(name, "total_fl_x") || !strcmp(name, "total_fl_y") || - !strcmp(name, "total_fl_w") || !strcmp(name, "total_fl_h") || + else if (!strcmp(name, "fl_scale_x") || !strcmp(name, "fl_scale_y") || + !strcmp(name, "fl_scale_w") || !strcmp(name, "fl_scale_h") || !strcmp(name, "fx") || !strcmp(name, "fy") || !strcmp(name, "fw") || !strcmp(name, "fh")) return DATA_T_DOUBLE; + count = xaCount(&(widget->Properties)); for (i=0;iInteger = widget->fl_y; return 0; } if (!strcmp(name+3, "width")) { val->Integer = widget->fl_width; return 0; } if (!strcmp(name+3, "height")) { val->Integer = widget->fl_height; return 0; } - } - else if (!strncmp(name, "parent_", 7)) - { - if (!strcmp(name+7, "w")) { val->Integer = widget->parent_w; return 0; } - if (!strcmp(name+7, "h")) { val->Integer = widget->parent_h; return 0; } + if (!strcmp(name+3, "parent_w")) { val->Integer = widget->fl_parent_w; return 0; } + if (!strcmp(name+3, "parent_h")) { val->Integer = widget->fl_parent_h; return 0; } } } - if (datatype == DATA_T_DOUBLE) + else if (datatype == DATA_T_DOUBLE) { - if (!strncmp(name, "f", 1)) - { - if (!strcmp(name+1, "x")) { val->Double = widget->fx; return 0; } + if (!strncmp(name, "fl_scale_", 9)) + { + if (!strcmp(name+9, "x")) { val->Double = (double)widget->fl_scale_x; return 0; } + else if (!strcmp(name+9, "y")) { val->Double = (double)widget->fl_scale_y; return 0; } + else if (!strcmp(name+9, "w")) { val->Double = (double)widget->fl_scale_w; return 0; } + else if (!strcmp(name+9, "h")) { val->Double = (double)widget->fl_scale_h; return 0; } + } + else if (!strncmp(name, "f", 1)) + { + if (!strcmp(name+1, "x")) { val->Double = widget->fx; return 0; } else if (!strcmp(name+1, "y")) { val->Double = widget->fy; return 0; } else if (!strcmp(name+1, "w")) { val->Double = widget->fw; return 0; } else if (!strcmp(name+1, "h")) { val->Double = widget->fh; return 0; } } - else if (!strncmp(name, "total_fl_", 9)) - { - if (!strcmp(name+9, "x")) { val->Double = (double)widget->total_fl_x; return 0; } - else if (!strcmp(name+9, "y")) { val->Double = (double)widget->total_fl_y; return 0; } - else if (!strcmp(name+9, "w")) { val->Double = (double)widget->total_fl_w; return 0; } - else if (!strcmp(name+9, "h")) { val->Double = (double)widget->total_fl_h; return 0; } - } } else if (datatype == DATA_T_STRING) { @@ -1598,7 +1596,7 @@ wgtrNewNode( char* name, char* type, pObjSession s, node->fl_y = fly; node->fl_width = flwidth; node->fl_height = flheight; - node->parent_h = node->parent_w = -1; + node->fl_parent_h = node->fl_parent_w = -1; node->ObjSession = s; node->Parent = NULL; node->min_height = node->min_width = 0; @@ -2600,5 +2598,3 @@ wgtrGetNamespace(pWgtrNode widget) { return widget->Namespace; } - - From 9da89e3e91a5218427a93d9f4a7968602ca9b2d7 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Fri, 6 Feb 2026 17:18:09 -0700 Subject: [PATCH 070/275] Update testing apps. Clean up some apps. --- centrallix-os/samples/autoscale_test.app | 36 ++++++++++++++++-------- 1 file changed, 25 insertions(+), 11 deletions(-) diff --git a/centrallix-os/samples/autoscale_test.app b/centrallix-os/samples/autoscale_test.app index bcaace5c6..d5965395c 100644 --- a/centrallix-os/samples/autoscale_test.app +++ b/centrallix-os/samples/autoscale_test.app @@ -6,13 +6,13 @@ MyPage "widget/page" textcolor = "#00f8ff"; width = 1000; height = 1000; - + auto "widget/hbox" { x=100; y=50; width=900; height=750; spacing=20; row_height=300; fl_width=100; fl_height=100; - + pane0 "widget/pane" { fl_width=100; fl_height=100; width=190; height=180; bgcolor = "#9cf"; } // x=100; y=50; pane1 "widget/pane" { fl_width=100; fl_height=100; width=130; height=180; bgcolor = "#ccc"; } // x=305; y=50; pane2 "widget/pane" { fl_width=100; fl_height=100; width=80; height=320; bgcolor = "#f99"; } // x=455; y=50; @@ -24,48 +24,62 @@ MyPage "widget/page" pane8 "widget/pane" { fl_width=100; fl_height=100; width=110; height=200; bgcolor = "#fc9"; } // x=615; y=390; pane9 "widget/pane" { fl_width=100; fl_height=100; width=130; height=120; bgcolor = "#cf9"; } // x=745; y=390; } - + // pane0 "widget/pane" { x=100; y=50; width=190; height=180; bgcolor = "#9cf"; } // pane1 "widget/pane" { x=305; y=50; width=130; height=180; bgcolor = "#ccc"; } // pane2 "widget/pane" { x=455; y=50; width=80; height=320; bgcolor = "#f99"; } // pane3 "widget/pane" { x=555; y=50; width=150; height=140; bgcolor = "#9f9"; } - // pane4 "widget/pane" { x=725; y=50; width= 90; height=240; bgcolor = "#99f"; } + // pane4 "widget/pane" { x=725; y=50; width=90; height=240; bgcolor = "#99f"; } // pane5 "widget/pane" { x=80; y=390; width=230; height=100; bgcolor = "#ff9"; } // pane6 "widget/pane" { x=325; y=390; width=80; height=200; bgcolor = "#f9f"; } // pane7 "widget/pane" { x=425; y=390; width=170; height=220; bgcolor = "#9ff"; } // pane8 "widget/pane" { x=615; y=390; width=110; height=200; bgcolor = "#fc9"; } // pane9 "widget/pane" { x=745; y=390; width=130; height=120; bgcolor = "#cf9"; } - + paneA "widget/pane" { x=40; y=680; width=890; height=220; bgcolor = "#620"; } - + + b "widget/button" + { + x=80; y=700; + width=40; height=20; + + type = "text"; + text = "text button"; + bgcolor = "#aee"; + fgcolor1 = "white"; + fgcolor2 = "red"; + disable_color = "grey"; + enabled = yes; + } + // Outline the visible area. top_left0 "widget/pane" { x=0; y=0; width=10; height=10; bgcolor = "#f00"; } top_right0 "widget/pane" { x=990; y=0; width=10; height=10; bgcolor = "#ff0"; } bottom_left0 "widget/pane" { x=0; y=990; width=10; height=10; bgcolor = "#0f0"; } bottom_right0 "widget/pane" { x=990; y=990; width=10; height=10; bgcolor = "#00f"; } - + // Advance markers. top_left1 "widget/pane" { x=100; y=100; width=10; height=10; fl_x=25; fl_y=25; fl_width=25; fl_height=25; bgcolor = "#a00"; } top_right1 "widget/pane" { x=890; y=100; width=10; height=10; fl_x=25; fl_y=25; fl_width=25; fl_height=25; bgcolor = "#aa0"; } bottom_left1 "widget/pane" { x=100; y=890; width=10; height=10; fl_x=25; fl_y=25; fl_width=25; fl_height=25; bgcolor = "#0a0"; } bottom_right1 "widget/pane" { x=890; y=890; width=10; height=10; fl_x=25; fl_y=25; fl_width=25; fl_height=25; bgcolor = "#00a"; } - + // Interior markers. top_left2 "widget/pane" { x=250; y=250; width=10; height=10; fl_x=100; fl_y=100; fl_width=25; fl_height=25; bgcolor = "#700"; } top_right2 "widget/pane" { x=740; y=250; width=10; height=10; fl_x=100; fl_y=100; fl_width=25; fl_height=25; bgcolor = "#770"; } bottom_left2 "widget/pane" { x=250; y=740; width=10; height=10; fl_x=100; fl_y=100; fl_width=25; fl_height=25; bgcolor = "#070"; } bottom_right2 "widget/pane" { x=740; y=740; width=10; height=10; fl_x=100; fl_y=100; fl_width=25; fl_height=25; bgcolor = "#007"; } - + // Deep interior markers. top_left3 "widget/pane" { x=400; y=400; width=10; height=10; fl_x=25; fl_y=25; fl_width=100; fl_height=100; bgcolor = "#500"; } top_right3 "widget/pane" { x=590; y=400; width=10; height=10; fl_x=25; fl_y=25; fl_width=100; fl_height=100; bgcolor = "#550"; } bottom_left3 "widget/pane" { x=400; y=590; width=10; height=10; fl_x=25; fl_y=25; fl_width=100; fl_height=100; bgcolor = "#050"; } bottom_right3 "widget/pane" { x=590; y=590; width=10; height=10; fl_x=25; fl_y=25; fl_width=100; fl_height=100; bgcolor = "#005"; } - + // Center marker. center "widget/pane" { x=450; y=450; width=100; height=100; bgcolor = "orange"; centerer "widget/pane" { x=25; y=25; width=50; height=50; bgcolor = "purple"; } // Debug - } + } } \ No newline at end of file From a74257653f1b983b3e59deb1c2d9bf0684111b35 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Fri, 6 Feb 2026 17:18:38 -0700 Subject: [PATCH 071/275] Add tools to ht_geom_dom1html. Add Math.clamp() and Math.isBetween(). Add getParentSize(), getParentW(), and getParentH(). Refactor getRelativeX/Y/W/H() to call the new getRelative(). Refactor setRelativeX/Y/W/H() to call the new setRelative(). Add fast_setRelativeX/Y(). Add setResponsiveX/Y/W/H() using a new shared setResponsive(). Add responsiveness to moveTo() with the new functions. Fix style guide mistakes. Clean up. --- centrallix-os/sys/js/ht_geom_dom1html.js | 232 ++++++++++++++++++++--- 1 file changed, 204 insertions(+), 28 deletions(-) diff --git a/centrallix-os/sys/js/ht_geom_dom1html.js b/centrallix-os/sys/js/ht_geom_dom1html.js index f137d5dba..71d29db99 100644 --- a/centrallix-os/sys/js/ht_geom_dom1html.js +++ b/centrallix-os/sys/js/ht_geom_dom1html.js @@ -11,34 +11,61 @@ // Cross browser Geometry DOM1HTML +// Add some useful functions to Math that will be needed elsewhere. +// Math.clamp = (min, val, max) => Math.min(Math.max(min, val), max); +// Math.isBetween = (lowerBound, num, upperBound) => lowerBound < num && num < upperBound; + +// Dev debug versions. +Math.clamp = (min, val, max) => + { + if (min > max || isNaN(min) || isNaN(val) || isNaN(max)) + { + console.warn(`Math.clamp(${min}, ${val}, ${max});`); + console.trace(); + } + return Math.min(Math.max(min, val), max); + } +Math.isBetween = (lowerBound, num, upperBound) => + { + if (lowerBound > upperBound || isNaN(lowerBound) || isNaN(num) || isNaN(upperBound)) + console.warn(`Math.isBetween(${lowerBound}, ${num}, ${upperBound});`); + return lowerBound < num && num < upperBound; + } + + + /*** Experimental system for turning off clipping CSS. *** The clip values are still stored and can be queried *** for legacy compatibility, but they will not output *** any clip rectangles or clip paths in the CSS or HTML. ***/ /** Ensure clipping is disabled for a layer / HTML node. **/ -function disableClippingCSS(l) { +function disableClippingCSS(l) + { console.log(`Turning off clipping for ${l.clip.obj.id}.`); l.clip.noclip = true; updateClippingCSS(l); -} + } /** Ensure clipping is enabled for a layer / HTML node. **/ -function enableClippingCSS(l) { +function enableClippingCSS(l) + { l.clip.noclip = false; updateClippingCSS(l); -} + } /** Update clipping without changing any specific values. **/ -function updateClippingCSS(l) { +function updateClippingCSS(l) + { setClipTop(l, getClipTop(l)); -} + } /** Debug function for finding clipped dom nodes. **/ -function getClipped() { +function getClipped() + { return Array - .from(Window.clipped) - .filter(id=>id) + .from(Window.clipped) + .filter(id=>id) .map(id=>document.getElementById(id)); -} + } // Clip Width function getClipWidth(l) @@ -236,43 +263,192 @@ function getpageYOffset() return window.pageYOffset; } -function getRelativeX(l) +/*** Get the size of a DOM node's parent container. + *** + *** @param l The DOM node. + *** @returns The width and height of the parent container. + ***/ +function getParentSize(l) + { + const parentRect = l.parentNode.getBoundingClientRect(); + return { width: parentRect.width, height: parentRect.height }; + } + +/*** Get the width of a DOM node's parent container. + *** + *** @param l The DOM node. + *** @returns The width of the parent container. + ***/ +function getParentW(l) + { + return getParentSize(l).width; + } + +/*** Get the height of a DOM node's parent container. + *** + *** @param l The DOM node. + *** @returns The height of the parent container. + ***/ +function getParentH(l) { - if (l.__pg_left != null) return l.__pg_left; - var left = parseInt(pg_get_style(l,'left')); - l.__pg_left = isNaN(left)?0:left; - return l.__pg_left; + return getParentSize(l).height; } -function setRelativeX(l, value) + +/*** Problem: + *** If the programmer calls setRelativeX() (or a similar function, such as moveTo() or moveBy()), + *** they might be using a value they got from the server, based on the resolution when the page + *** was first loaded. However, they might also be using a value they got dynamically by calling + *** some function to check the actual size of an element. Previously, this distinction did not + *** matter because these values would be the same. However, now that pages can be resized on the + *** client, it does matter. + ***/ + + +/*** We ignore the current value of __pg_left in the following functions even + *** though it might be correct and faster than querying the DOM. However, the + *** layout may have changed since last time, so we always requery the DOM. + ***/ +function getRelative(l, d) { - pg_set_style(l,'left',(l.__pg_left = parseInt(value))); - return l.__pg_left; + const val = parseInt(pg_get_style(l, d, NaN)); + return l['__pg_' + d] = (isNaN(val)) ? 0 : val; } -function getRelativeY(l) +function getRelativeX(l) { return getRelative(l, 'left'); } +function getRelativeY(l) { return getRelative(l, 'top'); } +function getRelativeW(l) { return getRelative(l, 'width'); } +function getRelativeH(l) { return getRelative(l, 'height'); } + +/*** Sets the location of a DOM node relative to its parent container. + *** + *** @param l The DOM node being set. (Assumed to be defined.) + *** @param value The new location. This can be a CSS string. + *** @param {'left'|'top'|'width'|'height'} d The dimension being set. + ***/ +function setRelative(l, value, d) { - if (l.__pg_top != null) return l.__pg_top; - return (l.__pg_top = parseInt(pg_get_style(l,'top'))); + /** Convert the value to a number, if possible. **/ + const parsedValue = parseInt(value); + if (!isNaN(parsedValue)) value = parsedValue; + + pg_set_style(l, d, value); + l['__pg_' + d + '_style'] = value; + return l['__pg_' + d] = parseInt(pg_get_style(l, d)); } -function setRelativeY(l, value) +function setRelativeX(l, value) { return setRelative(l, value, 'left'); } +function setRelativeY(l, value) { return setRelative(l, value, 'top'); } +function setRelativeW(l, value) { return setRelative(l, value, 'width'); } +function setRelativeH(l, value) { return setRelative(l, value, 'height'); } + +/*** Use these functions only in situations where performances is required + *** and you (a) value does not need to be parsed and (b) you do not need + *** the return value of the function. + ***/ +function fast_setRelativeX(l, value) { - pg_set_style(l,'top',(l.__pg_top = parseInt(value))); - return l.__pg_top; + pg_set_style(l, 'left', value); + l['__pg_x_style'] = value; } +function fast_setRelativeY(l, value) + { + pg_set_style(l, 'top', value); + l['__pg_y_style'] = value; + } + +/*** Sets a dimension of a DOM element using coordinates in the server + *** generated adaptive layout. It is RECOMMENDED to call a specific sub- + *** function (aka. setResponsiveX(), setResponsiveY(), etc.) instead of + *** calling this function directly to avoid passing dimension directly. + *** + *** WARNING: Ensure that any value passed is calculated ENTIRELY using + *** values from the server (e.g. widget properties) and no values from + *** real page dimensions are used, as these change when the page is + *** resized after being loaded for the first time. + *** + *** @param l The DOM node being set. (Assumed to be defined.) + *** @param value The new location in server-side px. This value must be + *** parseable as a number. + *** @param {'x'|'y'|'w'|'h'} d The letter for the dimension being set. + ***/ +function setResponsive(l, value, d) { + /** Convert the value to a number, if possible. **/ + const parsedValue = parseInt(value); + if (!isNaN(parsedValue)) value = parsedValue; + + /** Server-layout values are always numbers. **/ + if (typeof(value) !== 'number') + { + console.warn(`setResponsive(${l.id}, ?, '${d}'): Expected value to be a parseable number but got:`, value); + return value; + } + + /** The flexibility specified by the server. **/ + var fl_scale = l['__fl_scale_' + d] ?? wgtrGetServerProperty(l, 'fl_scale_' + d); + if (fl_scale == undefined || fl_scale == null) + { + /** The server did not specify a flexibility, even though one was expected. **/ + const warningMsg = 'setResponsive() - FAIL: Missing ' + ((wgtrIsNode(l)) ? 'wgtr.' : '__') + 'fl_scale_' + d; + console.warn(warningMsg, l); + fl_scale = 0; + } + + /** Inflexible elements don't need to be responsive. **/ + if (fl_scale <= 0) return setRelative(l, value, d); + + /** The parent width expected by the server in the adaptive layout. **/ + var d2 = d; + if (d2 == 'x') d2 = 'w'; + if (d2 == 'y') d2 = 'h'; + + var fl_parent = l['__fl_parent_' + d2] ?? wgtrGetServerProperty(l, 'fl_parent_' + d2); + if (fl_parent == undefined || fl_parent == null) + { + const warningMsg = 'setResponsive() - FAIL: Missing ' + ((wgtrIsNode(l)) ? 'wgtr.' : '__') + 'fl_parent_' + d2; + console.warn(warningMsg, l); + } + + /** Generate and set the CSS. **/ + const css = `calc(${value}px + (100% - ${fl_parent}px) * ${fl_scale})`; + const prop = { x:'left', y:'top', w:'width', h:'height' }[d]; + return setRelative(l, css, prop); +} +/** Call these functions instead of calling setResponsive() directly, which leads to less readable code. **/ +function setResponsiveX(l, value) { return setResponsive(l, value, 'x'); } +function setResponsiveY(l, value) { return setResponsive(l, value, 'y'); } +function setResponsiveW(l, value) { return setResponsive(l, value, 'w'); } +function setResponsiveH(l, value) { return setResponsive(l, value, 'h'); } + +/** Moves a DOM node to a location within the window. **/ function moveToAbsolute(l, x, y) { setPageX(l,x); setPageY(l,y); } -function moveTo(l, x, y) +/*** Moves a DOM node to a location inside it's parent container. + *** + *** @param l The DOM node being moved. + *** @param x The new x coordinate. Can be a CSS string (if responsive is false). + *** @param y The new y coordinate. Can be a CSS string (if responsive is false). + *** @param responsive Whether the given coordinates should be treated as + *** adaptive, 'server-side', coordinates where setResponsive() + *** should be invoked to give them responsive design. + ***/ +function moveTo(l, x, y, responsive = false) { - //pg_set_style_string(this,'position','absolute'); - setRelativeX(l,x); - setRelativeY(l,y); + if (responsive) + { + setResponsiveX(l, x); + setResponsiveY(l, x); + } + else + { + setRelativeX(l, x); + setRelativeY(l, y); + } } From 9612eb4dddbdc82eeed099feba183d18bc0ad86d Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Fri, 6 Feb 2026 17:22:34 -0700 Subject: [PATCH 072/275] Add tools for widget development and debugging. Add support for more edge cases with undefined values to wgtrGetServerProperty(). Add the Log action (and docs). Add the ReloadPage action (and docs). Improve documentation for the Alert widget. --- centrallix-doc/Widgets/widgets.xml | 6 +++++- centrallix-os/sys/js/ht_utils_wgtr.js | 2 +- centrallix-os/sys/js/htdrv_page.js | 12 ++++++++++++ 3 files changed, 18 insertions(+), 2 deletions(-) diff --git a/centrallix-doc/Widgets/widgets.xml b/centrallix-doc/Widgets/widgets.xml index b6b50afde..a8ab43f21 100644 --- a/centrallix-doc/Widgets/widgets.xml +++ b/centrallix-doc/Widgets/widgets.xml @@ -2818,13 +2818,17 @@ osrc1 "widget/osrc" - Sends an alert widget. + Sends an alert widget. Set the 'Message' to specify a text string that should appear in the alert. Closes the page. Starts a new app in a new window. + Logs data to the console (using console.log()), for testing and debugging. Set the 'Message' to specify a text string that should appear in the log. + Loads the page. + + Reloads the page in the user's browser. Note: This event forces a reload, even if the original content could be loaded without one. diff --git a/centrallix-os/sys/js/ht_utils_wgtr.js b/centrallix-os/sys/js/ht_utils_wgtr.js index 1379bacf9..085992ee4 100644 --- a/centrallix-os/sys/js/ht_utils_wgtr.js +++ b/centrallix-os/sys/js/ht_utils_wgtr.js @@ -363,7 +363,7 @@ function wgtrIsUndefined(prop) // wgtrGetServerProperty() - return a server-supplied property value function wgtrGetServerProperty(node, prop_name, def) { - var val = node.__WgtrParams[prop_name]; + var val = node?.__WgtrParams?.[prop_name]; if (typeof val == 'undefined') return def; else if (typeof val == 'object' && val && val.exp) diff --git a/centrallix-os/sys/js/htdrv_page.js b/centrallix-os/sys/js/htdrv_page.js index 1da3ba1e5..85c58c5b5 100755 --- a/centrallix-os/sys/js/htdrv_page.js +++ b/centrallix-os/sys/js/htdrv_page.js @@ -1354,6 +1354,8 @@ function pg_init(l,a,gs,ct) //SETH: ?? ia.Add("Launch", pg_launch); ia.Add("Close", pg_close); ia.Add("Alert", pg_alert); + ia.Add("Log", pg_log); + ia.Add("ReloadPage", pg_reload_page); // Events var ie = window.ifcProbeAdd(ifEvent); @@ -1435,6 +1437,16 @@ function pg_alert(aparam) alert(aparam.Message); } +function pg_log({ Message }) + { + console.log(Message); + } + +function pg_reload_page() + { + window.location.reload(); + } + function pg_reveal_cb(e) { if (e.eventName == 'ObscureOK') From ba4dd5b772d8ce4d7fbd5d9a18a0994ba5a27fd0 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Fri, 6 Feb 2026 17:23:47 -0700 Subject: [PATCH 073/275] Add a warning when using the pane resize action, which breaks responsiveness. --- centrallix-os/sys/js/htdrv_pane.js | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/centrallix-os/sys/js/htdrv_pane.js b/centrallix-os/sys/js/htdrv_pane.js index 9489912e7..598e51feb 100644 --- a/centrallix-os/sys/js/htdrv_pane.js +++ b/centrallix-os/sys/js/htdrv_pane.js @@ -79,12 +79,9 @@ function pn_setbackground(aparam) function pn_action_resize(aparam) { - // I think this code is a better implementation of the following lines: - // var w = (aparam.Width) ?? pg_get_style(this, 'width'); - // var h = (aparam.Height) ?? pg_get_style(this, 'height'); - - var w = aparam.Width?aparam.Width:pg_get_style(this, 'width'); - var h = aparam.Height?aparam.Height:pg_get_style(this, 'height'); + console.warn('Resize action called which will probably break responsiveness.', this, aparam); + const w = (aparam.Width) ?? pg_get_style(this, 'width'); + const h = (aparam.Height) ?? pg_get_style(this, 'height'); resizeTo(this, w, h); } From 83ea0b91a67862c1f318413c0179fe5dcdaa5588 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Fri, 6 Feb 2026 17:28:36 -0700 Subject: [PATCH 074/275] Make the point action responsive. Add htr_action_point() to ht_render.js to handle the point action responsively. Refactor pane and window widgets to use the htr_action_point(). Improve documentation and code clarity for htutil_point(). Improve documentation for the point action. --- centrallix-doc/Widgets/widgets.xml | 2 +- centrallix-os/sys/js/ht_render.js | 35 +++++++++++++++++++++++++ centrallix-os/sys/js/ht_utils_layers.js | 15 ++++++++--- centrallix-os/sys/js/htdrv_pane.js | 4 +-- centrallix-os/sys/js/htdrv_window.js | 4 +-- 5 files changed, 49 insertions(+), 11 deletions(-) diff --git a/centrallix-doc/Widgets/widgets.xml b/centrallix-doc/Widgets/widgets.xml index a8ab43f21..3dbb50a24 100644 --- a/centrallix-doc/Widgets/widgets.xml +++ b/centrallix-doc/Widgets/widgets.xml @@ -629,7 +629,7 @@ checkbox_test "widget/page" Opens the window. If the parameter IsModal is set to 1, then the window becomes modal (only the window's contents are accessible to the user until the window is closed). If the parameter NoClose is set to 1, then the close button in the upper right corner of the window becomes inactive and the window will only close via the Close, SetVisibility, and ToggleVisibility actions. - Makes the window relocate to a side using a triangle (pop over). + Creates a triangular pointer on the edge of the window to point at a given (X,Y) coordinate. Opens a window like a pop-up. diff --git a/centrallix-os/sys/js/ht_render.js b/centrallix-os/sys/js/ht_render.js index 6b80b9ace..8d0163e10 100644 --- a/centrallix-os/sys/js/ht_render.js +++ b/centrallix-os/sys/js/ht_render.js @@ -819,6 +819,41 @@ function htr_stylize_element(element, widget, prefix, defaults) ); } +/*** When a point action is invoked the first time, a ResizeObserver is also + *** created to update the location of the point element if the document is + *** resized. The parameters from invocation of this function are saved and + *** reused to update the point each time a resize occurs. + */ +function htr_action_point(aparam) + { + const updatePoint = () => + { + /** Get the parameters from the resize observer object. **/ + const { X, Y, AtWidget, BorderColor, FillColor } = this.resizeObserver.aparam; + const { p1, p2 } = htutil_point(this, X, Y, AtWidget, BorderColor, FillColor, this.point1, this.point2); + this.point1 = p1; + this.point2 = p2; + } + + if (!this.resizeObserver) + { + /*** There isn't a resize observer yet, so create a new one that will + *** update the point when the document is resized. + *** Note: ResizeObserver provides a list of resized entries to the + *** callback (updatePoint()) and we ignore it because we only care + *** that something has been resized, htutil_point() handles the rest. + ***/ + const resizeObserver = this.resizeObserver = new ResizeObserver(updatePoint); + resizeObserver.observe(document.documentElement); + } + /** I really wanted to write the code below to show off how cleaver I am, but the if statement above is far more readable. **/ + // (!this.resizeObserver) && (this.resizeObserver = new ResizeObserver(updatePoint)).observe(document.documentElement); + + /** Save the parameters, then update the point. **/ + this.resizeObserver.aparam = aparam; + updatePoint(); + } + function htr_alert(obj,maxlevels) { alert(htr_obj_to_text(obj,0,maxlevels)); diff --git a/centrallix-os/sys/js/ht_utils_layers.js b/centrallix-os/sys/js/ht_utils_layers.js index 096754eb5..600db733f 100644 --- a/centrallix-os/sys/js/ht_utils_layers.js +++ b/centrallix-os/sys/js/ht_utils_layers.js @@ -20,6 +20,12 @@ function htutil_tag_images(d,t,l,ml) } } +/*** + *** @param bc BorderColor + *** @param fc FillColor + *** @param p1 Point 1 + *** @param p2 Point 2 + ***/ function htutil_point(wthis, x, y, at, bc, fc, p1, p2) { // Determine x/y to point at @@ -105,6 +111,7 @@ function htutil_point(wthis, x, y, at, bc, fc, p1, p2) } // Set the CSS to enable the point divs + const { top: wtop, left: wleft } = $(wthis).offset(); $(p1).css ({ "position": "absolute", @@ -114,8 +121,8 @@ function htutil_point(wthis, x, y, at, bc, fc, p1, p2) "border-style": "solid", "box-sizing": "border-box", "content": "", - "top": (top + $(wthis).offset().top) + "px", - "left": (left + $(wthis).offset().left) + "px", + "top": (top + wtop) + "px", + "left": (left + wleft) + "px", "border-color": c1, "visibility": "inherit", "z-index": htr_getzindex(wthis) + 1 @@ -129,8 +136,8 @@ function htutil_point(wthis, x, y, at, bc, fc, p1, p2) "border-style": "solid", "box-sizing": "border-box", "content": "", - "top": (top + doffs.y + $(wthis).offset().top) + "px", - "left": (left + doffs.x + $(wthis).offset().left) + "px", + "top": (top + doffs.y + wtop) + "px", + "left": (left + doffs.x + wleft) + "px", "border-color": c2, "visibility": "inherit", "z-index": htr_getzindex(wthis) + 2 diff --git a/centrallix-os/sys/js/htdrv_pane.js b/centrallix-os/sys/js/htdrv_pane.js index 598e51feb..854cee0e0 100644 --- a/centrallix-os/sys/js/htdrv_pane.js +++ b/centrallix-os/sys/js/htdrv_pane.js @@ -87,9 +87,7 @@ function pn_action_resize(aparam) function pn_action_point(aparam) { - var divs = htutil_point(this, aparam.X, aparam.Y, aparam.AtWidget, aparam.BorderColor, aparam.FillColor, this.point1, this.point2); - this.point1 = divs.p1; - this.point2 = divs.p2; + htr_action_point.call(this, aparam); } function pn_init(param) diff --git a/centrallix-os/sys/js/htdrv_window.js b/centrallix-os/sys/js/htdrv_window.js index b551430f4..6cdcf0da9 100644 --- a/centrallix-os/sys/js/htdrv_window.js +++ b/centrallix-os/sys/js/htdrv_window.js @@ -152,9 +152,7 @@ function wn_init(param) function wn_action_point(aparam) { - var divs = htutil_point(this, aparam.X, aparam.Y, aparam.AtWidget, aparam.BorderColor, aparam.FillColor, this.point1, this.point2); - this.point1 = divs.p1; - this.point2 = divs.p2; + htr_action_point.call(this, aparam); } // Popup - pops up a window in the way that a menu might pop up. From c75f3e0aa355a01b451cbf51ec72876da2d1c35b Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Fri, 6 Feb 2026 17:31:33 -0700 Subject: [PATCH 075/275] Make the autolayout widget responsive. Update al_reflow() to create responsive CSS using the setResponsive() functions. Improve documentation for al_childresize(). Optimize and clean up inefficient code. --- centrallix-os/sys/js/htdrv_autolayout.js | 61 ++++++++++++++---------- 1 file changed, 35 insertions(+), 26 deletions(-) diff --git a/centrallix-os/sys/js/htdrv_autolayout.js b/centrallix-os/sys/js/htdrv_autolayout.js index fabace1ca..427f42849 100644 --- a/centrallix-os/sys/js/htdrv_autolayout.js +++ b/centrallix-os/sys/js/htdrv_autolayout.js @@ -9,6 +9,15 @@ // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU Lesser General Public License for more details. +/*** This function works entirely using server-side dimensions. + *** Responsive dimensions are handled elsewhere. + *** + *** @param child The child to be resized. + *** @param oldw The previous width in server-side adaptive coordinates. + *** @param oldh The previous height in server-side adaptive coordinates. + *** @param neww The new width in server-side adaptive coordinates. + *** @param newh The new height in server-side adaptive coordinates. + ***/ function al_childresize(child, oldw, oldh, neww, newh) { if (oldw != neww || oldh != newh) @@ -37,29 +46,27 @@ function al_reflow_buildlist(node, children) } } +/*** Note: + *** This function gets all its values from server properties, so its generated + *** positions are in server layout. Thus, we convert them right before they + *** assigned to allow for responsive values. + ***/ function al_reflow() { // Get configuration var width = wgtrGetServerProperty(this,"width"); var height = wgtrGetServerProperty(this,"height"); - var spacing = wgtrGetServerProperty(this,"spacing"); - if (!spacing) spacing = 0; - var cellsize = wgtrGetServerProperty(this,"cellsize"); - if (!cellsize) cellsize = -1; - var align = wgtrGetServerProperty(this,"align"); - if (!align) align = "left"; - var justify_mode = wgtrGetServerProperty(this,"justify"); - if (!justify_mode) justify_mode = "none"; + var spacing = wgtrGetServerProperty(this,"spacing",0); + // var cellsize = wgtrGetServerProperty(this,"cellsize",-1); // Unused + var align = wgtrGetServerProperty(this,"align","left"); + // var justify_mode = wgtrGetServerProperty(this,"justify","none"); // Unused var type = "vbox"; if (wgtrGetServerProperty(this,"style") == "hbox" || wgtrGetType(this) == "widget/hbox") type = "hbox"; - var column_width; - if (type == "vbox") - column_width = wgtrGetServerProperty(this,"column_width"); + var column_width, row_height; + if (type == "vbox") column_width = wgtrGetServerProperty(this,"column_width"); + else row_height = wgtrGetServerProperty(this,"row_height"); if (!column_width) column_width = width; - var row_height; - if (type == "hbox") - row_height = wgtrGetServerProperty(this,"row_height"); if (!row_height) row_height = height; // Build the child list @@ -87,10 +94,9 @@ function al_reflow() for(var i=0; i width) { if (xo > 0 && row_height > 0 && row_offset + row_height*2 + spacing <= height) @@ -108,6 +114,7 @@ function al_reflow() } else if (type == 'vbox') { + const cheight = wgtrGetServerProperty(child, "height"); if (yo + cheight > height) { if (yo > 0 && column_width > 0 && column_offset + column_width*2 + spacing <= width) @@ -148,10 +155,9 @@ function al_reflow() for(var i=0; i width) { if (xo > 0 && row_height > 0 && row_offset + row_height*2 + spacing <= height) @@ -164,17 +170,19 @@ function al_reflow() } if (child.tagName) { - setRelativeX(child, xo + xalign); - if (wgtrGetServerProperty(child,"r_y") == -1) - setRelativeY(child, row_offset); + setResponsiveX(child, xo + xalign); + const r_y = wgtrGetServerProperty(child, "r_y"); + if (r_y == -1) + setResponsiveY(child, row_offset); else - setRelativeY(child, row_offset + wgtrGetServerProperty(child,"r_y")); + setResponsiveY(child, row_offset + r_y); } xo += cwidth; xo += spacing; } else if (type == 'vbox') { + const cheight = wgtrGetServerProperty(child, "height"); if (yo + cheight > height) { if (yo > 0 && column_width > 0 && column_offset + column_width*2 + spacing <= width) @@ -187,11 +195,12 @@ function al_reflow() } if (child.tagName) { - setRelativeY(child, yo + yalign); - if (wgtrGetServerProperty(child,"r_x") == -1) - setRelativeX(child, column_offset); + setResponsiveY(child, yo + yalign); + const r_x = wgtrGetServerProperty(child, "r_x"); + if (r_x == -1) + setResponsiveX(child, column_offset); else - setRelativeX(child, column_offset + wgtrGetServerProperty(child,"r_x")); + setResponsiveX(child, column_offset + r_x); } yo += cheight; yo += spacing; From db00d6b1aaf2557273f72f85592795fff92d7796 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Fri, 6 Feb 2026 17:39:10 -0700 Subject: [PATCH 076/275] Make the tab widget responsive. Rewrite C & JS code to use responsive styling. Fix a bug that allowed multiple tabs to be selected at once. Fix spelling errors. Clean up. --- centrallix-os/sys/js/htdrv_tab.js | 549 +++++++++++----------- centrallix/htmlgen/htdrv_tab.c | 753 +++++++++++++++++++++--------- 2 files changed, 809 insertions(+), 493 deletions(-) diff --git a/centrallix-os/sys/js/htdrv_tab.js b/centrallix-os/sys/js/htdrv_tab.js index ebab8b6b6..96fd166e8 100644 --- a/centrallix-os/sys/js/htdrv_tab.js +++ b/centrallix-os/sys/js/htdrv_tab.js @@ -9,7 +9,6 @@ // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU Lesser General Public License for more details. - // Sets the value of the current tab (but not the appearance), without // triggering on-change events. function tc_set_tab_unwatched() @@ -27,139 +26,150 @@ function tc_set_tab_unwatched() // Makes the given tab current. function tc_makecurrent() { - var t; - if (this.tabctl.tloc != 4 && htr_getzindex(this.tab) > htr_getzindex(this.tabctl)) return 0; - for(var i=0;i htr_getzindex(t)) return 0; + for(let i = 0; i < tabs.length; i++) { - t = this.tabctl.tabs[i]; - if (t != this && (t.tabctl.tloc == 4 || htr_getzindex(t.tab) > htr_getzindex(this.tab))) + const cur = tabs[i]; + if (cur !== this && (cur.tabctl.tloc === 'None' || htr_getzindex(cur.tab) > htr_getzindex(tab))) { - htr_setzindex(t, htr_getzindex(this.tabctl) - 1); - htr_setvisibility(t, 'hidden'); - if (t.tabctl.tloc != 4) + htr_setzindex(cur, htr_getzindex(t) - 1); + htr_setvisibility(cur, 'hidden'); + if (cur.tabctl.tloc !== 'None') { - htr_setzindex(t.tab, htr_getzindex(this.tabctl) - 1); - t.tab.marker_image.src = '/sys/images/tab_lft3.gif'; - moveBy(t.tab, this.tabctl.xo, this.tabctl.yo); - //setClipItem(t.tab, t.tabctl.cl, getClipItem(t.tab, t.tabctl.cl) + t.tabctl.ci); - if (this.tabctl.inactive_bgColor) htr_setbgcolor(t.tab, this.tabctl.inactive_bgColor); - if (this.tabctl.inactive_bgnd) htr_setbgimage(t.tab, this.tabctl.inactive_bgnd); + htr_setzindex(cur.tab, htr_getzindex(t) - 1); + cur.tab.marker_image.src = '/sys/images/tab_lft3.gif'; + cur.tab.classList.remove('tab_selected'); + // moveBy(cur.tab, t.xo, t.yo); + if (t.inactive_bgColor) htr_setbgcolor(cur.tab, t.inactive_bgColor); + if (t.inactive_bgnd) htr_setbgimage(cur.tab, t.inactive_bgnd); } } } - htr_setzindex(this, htr_getzindex(this.tabctl) + 1); + htr_setzindex(this, htr_getzindex(t) + 1); htr_setvisibility(this,'inherit'); - if (this.tabctl.tloc != 4) + if (tloc !== 'None') { - if (this.tabctl.main_bgColor) htr_setbgcolor(this.tab, this.tabctl.main_bgColor); - if (this.tabctl.main_bgnd) htr_setbgimage(this.tab, this.tabctl.main_bgnd); - htr_setzindex(this.tab, htr_getzindex(this.tabctl) + 1); - this.tab.marker_image.src = '/sys/images/tab_lft2.gif'; - moveBy(this.tab, -this.tabctl.xo, -this.tabctl.yo); - //setClipItem(this.tab, this.tabctl.cl, getClipItem(this.tab, this.tabctl.cl) - this.tabctl.ci); + if (t.main_bgColor) htr_setbgcolor(tab, t.main_bgColor); + if (t.main_bgnd) htr_setbgimage(tab, t.main_bgnd); + htr_setzindex(tab, htr_getzindex(t) + 1); + tab.marker_image.src = '/sys/images/tab_lft2.gif'; + tab.classList.add('tab_selected'); + // moveBy(tab, -t.xo, -t.yo); } this.setTabUnwatched(); - this.tabctl.ifcProbe(ifEvent).Activate("TabChanged", {Selected:this.tabctl.selected, SelectedIndex:this.tabctl.selected_index}); + t.ifcProbe(ifEvent).Activate("TabChanged", { Selected:t.selected, SelectedIndex:t.selected_index }); } -function tc_makenotcurrent(t) +function tc_makenotcurrent(page) { - htr_setzindex(t,htr_getzindex(t.tabctl) - 1); - htr_setvisibility(t,'hidden'); - if (t.tabctl.tloc != 4) + const { tabctl, tab } = page; + + htr_setzindex(page, htr_getzindex(tabctl) - 1); + htr_setvisibility(page, 'hidden'); + + if (tabctl.tloc !== 'None') { - htr_setzindex(t.tab,htr_getzindex(t.tabctl) - 1); - t.tab.marker_image.src = '/sys/images/tab_lft3.gif'; - moveBy(t.tab, t.tabctl.xo, t.tabctl.yo); - //setClipItem(t.tab, t.tabctl.cl, getClipItem(t.tab, t.tabctl.cl) + t.tabctl.ci); - if (t.tabctl.inactive_bgColor) htr_setbgcolor(t.tab, t.tabctl.inactive_bgColor); - if (t.tabctl.inactive_bgnd) htr_setbgimage(t.tab, t.tabctl.inactive_bgnd); + htr_setzindex(page.tab,htr_getzindex(page.tabctl) - 1); + tab.marker_image.src = '/sys/images/tab_lft3.gif'; + tab.classList.remove('tab_selected'); + // moveBy(tab, tabctl.xo, tabctl.yo); + if (tabctl.inactive_bgColor) htr_setbgcolor(tab, tabctl.inactive_bgColor); + if (tabctl.inactive_bgnd) htr_setbgimage(tab, tabctl.inactive_bgnd); } } - -// Adds a new tab to the tab control -function tc_addtab(l_tab, l_page, l, nm, type,fieldname) + +/*** Adds a new tab to the tab control. This function deals with whether or + *** not that tab is selected as LITTLE AS POSSIBLE since that piece of state + *** should be handled elsewhere with functions like tc_makenotcurrent() or + *** tc_makecurrent(). + *** + *** @param l_tab The tab being added. + *** @param l_page The page to which the tab is being added. + *** @param l The layer where this change will occur. + *** @param nm The name of the tab. + ***/ +function tc_addtab(l_tab, l_page, l, nm, type, fieldname) { - var newx; - var newy; - if (!l_tab) l_tab = new Object(); + const tabctl = this, { tabs } = tabctl, { tloc, tab_h, tab_spacing } = l; + + let x, y; + if (!l_tab) l_tab = {}; l_page.tabname = nm; l_page.type = type; l_page.fieldname = fieldname; - l_page.tabindex = this.tabs.length+1; + l_page.tabindex = tabs.length + 1; htr_init_layer(l_page,l,'tc_pn'); ifc_init_widget(l_page); - if (l.tloc != 4) + + /** Calculate the location and flexibility to render the tab. **/ + if (tloc === 'None') + { + x = 0; + y = 0; + } + else { - htr_init_layer(l_tab,l,'tc'); - if (l.tloc == 0 || l.tloc == 1) // top or bottom + htr_init_layer(l_tab, l, 'tc'); + + /** Calculate x coordinate. **/ + if (tloc === 'Top' || tloc === 'Bottom') { - if (this.tabs.length > 0) + if (tabs.length > 0) { - //alert(htr_getphyswidth(this.tabs[this.tabs.length-1])); - newx = getPageX(this.tabs[this.tabs.length-1].tab) + $(this.tabs[this.tabs.length-1].tab).outerWidth() + 1; - if (htr_getvisibility(this.tabs[this.tabs.length-1]) == 'inherit') newx += l.xo; + const previous_tab = tabs[tabs.length - 1].tab; + x = getRelativeX(previous_tab) + $(previous_tab).outerWidth() + tab_spacing; } + else if (l.tab_fl_x) + /** Copy tabctl.style.left to avoid small but noticeable inconsistencies. **/ + setRelativeX(l_tab, tabctl.style.left); else - newx = getPageX(this); + /** Math for inflexible tabs do not suffer from inconsistencies. * */ + x = getRelativeX(tabctl); } - else if (l.tloc == 2) // left - newx = getPageX(this)- htr_getviswidth(l_tab) + 0; - else if (l.tloc == 3) // right - newx = getPageX(this) + htr_getviswidth(this) + 1; + else if (tloc === 'Left') + x = getRelativeX(tabctl) - htr_getviswidth(l_tab); + else if (tloc === 'Right') + x = getRelativeX(tabctl); // + htr_getviswidth(tabctl) // Included in xtoffset (see below) - if (l.tloc == 2 || l.tloc == 3) // left or right + /** Calculate y coordinate. **/ + if (tloc === 'Left' || tloc === 'Right') { - if (this.tabs.length > 0) + if (tabs.length > 0) { - newy = getPageY(this.tabs[this.tabs.length-1].tab) + 26; - if (htr_getvisibility(this.tabs[this.tabs.length-1]) == 'inherit') newy += l.yo; + const previous_tab = tabs[tabs.length - 1].tab; + y = getRelativeY(previous_tab) + tab_h + tab_spacing; } + else if (l.tab_fl_y) + /** Copy tabctl.style.top to avoid small but noticeable inconsistencies. **/ + setRelativeY(l_tab, tabctl.style.top); else - newy = getPageY(this); + /** Math for inflexible tabs do not suffer from inconsistencies. * */ + y = getRelativeY(tabctl); } - else if (l.tloc == 1) // bottom - newy = getPageY(this)+ htr_getvisheight(this) + 1; - else // top - newy = getPageY(this) - 24; - - // Clipping - switch(l.tloc) + else if (tloc === 'Bottom') + y = getRelativeY(tabctl); // + htr_getvisheight(tabctl) // Included in ytoffset (see below) + else // Top + y = getRelativeY(tabctl) - tab_h; + + /** Apply the same tab offsets used on the server. **/ + x += l.xtoffset; + y += l.ytoffset; + + /** Space out tab away from previous tab to account for borders. **/ + if (tabs.length > 0) { - case 0: // top - $(l_tab).css('clip', 'rect(-10px, ' + ($(l_tab).outerWidth()+10) + 'px, 25px, -10px)'); - break; - case 1: // bottom - $(l_tab).css('clip', 'rect(0px, ' + ($(l_tab).outerWidth()+10) + 'px, 35px, -10px)'); - break; - case 2: // left - $(l_tab).css('clip', 'rect(-10px, ' + ($(l_tab).outerWidth()) + 'px, 35px, -10px)'); - break; - case 3: // right - $(l_tab).css('clip', 'rect(-10px, ' + ($(l_tab).outerWidth()+10) + 'px, 35px, 0px)'); - break; + switch (tloc) + { + case 'Top': case 'Bottom': x += 2; break; + case 'Left': case 'Right': y += 2; break; + } } } - else - { - newx = 0; - newy = 0; - } - if (htr_getvisibility(l_page) != 'inherit') - { - if (l.tloc != 4) - { - newx += l.xo; - newy += l.yo; - //setClipItem(l_tab, l.cl, getClipItem(l_tab, l.cl) + l.ci); - if (l.inactive_bgColor) htr_setbgcolor(l_tab, l.inactive_bgColor); - else if (l.main_bgColor) htr_setbgcolor(l_tab, l.main_bgColor); - if (l.inactive_bgnd) htr_setbgimage(l_tab, l.inactive_bgnd); - else if (l.main_bgnd) htr_setbgimage(l_tab, l.main_bgnd); - } - } - else + if (htr_getvisibility(l_page) === 'inherit') { htr_unwatch(l,"selected","tc_selection_changed"); htr_unwatch(l,"selected_index","tc_selection_changed"); @@ -167,49 +177,60 @@ function tc_addtab(l_tab, l_page, l, nm, type,fieldname) l.selected_index = l_page.tabindex; l.current_tab = l_page; l.init_tab = l_page; - pg_addsched_fn(window,"pg_reveal_event",new Array(l_page,l_page,'Reveal'), 0); + pg_addsched_fn(window,"pg_reveal_event",[l_page,l_page,'Reveal'], 0); htr_watch(l,"selected", "tc_selection_changed"); htr_watch(l,"selected_index", "tc_selection_changed"); - if (l.tloc != 4) + if (tloc !== 'None') { if (l.main_bgColor) htr_setbgcolor(l_tab, l.main_bgColor); if (l.main_bgnd) htr_setbgimage(l_tab, l.main_bgnd); } } - if (l.tloc != 4) + + if (tloc !== 'None') { - var images = pg_images(l_tab); - for(var i=0;i this.tabs.length) return o; + if (tabindex < 1 || tabindex > tabs.length) return o; // okay to change tab. - //this.tabs[tabindex-1].makeCurrent(); + //tabs[tabindex-1].makeCurrent(); if (this.selchange_schedid) pg_delsched(this.selchange_schedid); - this.selchange_schedid = pg_addsched_fn(this,"ChangeSelection1", new Array(this.tabs[tabindex-1]), 0); + this.selchange_schedid = pg_addsched_fn(this, "ChangeSelection1", new Array(tabs[tabindex - 1]), 0); return n; } -function tc_action_set_tab(aparam) +function tc_action_set_tab({ Tab, TabIndex }) { - if (aparam.Tab) this.selected = aparam.Tab; - else if (aparam.TabIndex) this.selected_index = parseInt(aparam.TabIndex); + if (Tab) this.selected = Tab; + else if (TabIndex) this.selected_index = parseInt(TabIndex); } function tc_showcontainer() @@ -263,13 +286,13 @@ function tc_showcontainer() function tc_clear_tabs(tabs) { - for(var i=0;i "+vals[j]+" \n"; else - content = "\n
 "+vals[j]+" 
\n"; - tabparent = tc_direct_parent(tabs[i]); + content = + '\n\t' + + '' + + '' + + '
 ' + vals[j] + ' 
\n'; + + tabparent = tc_direct_parent(cur_tab); if(this.tc_layer_cache && this.tc_layer_cache.length >0) newtab = this.tc_layer_cache.pop(); else newtab = htr_new_layer(null,tabparent); - pageparent = tc_direct_parent(tabs[i].tabpage) + pageparent = tc_direct_parent(cur_tab.tabpage) newpage = htr_new_layer(null,pageparent); - newtab.marker_image = tabs[i].marker_image; + newtab.marker_image = cur_tab.marker_image; newtab.marker_image.src = '/sys/images/tab_lft3.gif'; $(newtab).find('span').text(' ' + htutil_encode(vals[j]) + ' '); //htr_write_content(newtab,content); @@ -343,8 +384,6 @@ function tc_updated(p1) htr_setvisibility(newpage,'inherit'); htr_setzindex(newtab,14); this.addTab(newtab,newpage,this,vals[j],'generated',''); - //setClipWidth(newtab,htr_getphyswidth(newtab)); - //setClipHeight(newtab,26); newpage.osrcdata = vals[j]; newpage.recordnumber = j; @@ -354,8 +393,8 @@ function tc_updated(p1) if(targettab) { - this.tabs[targettab].makeCurrent(); - this.tabs[targettab].tc_visible_changed('visible','hidden','inherit'); + tabs[targettab].makeCurrent(); + tabs[targettab].tc_visible_changed('visible','hidden','inherit'); } } } @@ -367,13 +406,20 @@ function tc_init(param) var l = param.layer; htr_init_layer(l,l,'tc'); ifc_init_widget(l); - l.tabs = new Array(); + l.tabs = []; l.addTab = tc_addtab; l.current_tab = null; l.init_tab = null; - l.tloc = param.tloc; - if (tc_tabs == null) tc_tabs = new Array(); + l.do_rendering = param.do_client_rendering; + l.select_x_offset = param.select_x_offset; + l.select_y_offset = param.select_y_offset; + l.xtoffset = param.xtoffset; + l.ytoffset = param.ytoffset; + l.tab_spacing = param.tab_spacing; + l.tab_h = param.tab_h; + if (tc_tabs == null) tc_tabs = []; tc_tabs[tc_tabs.length++] = l; + l.tloc = param.tloc; // Background color/image selection... l.main_bgColor = htr_extract_bgcolor(param.mainBackground); @@ -422,144 +468,99 @@ function tc_init(param) l.ChangeSelection2 = tc_changeselection_2; l.ChangeSelection3 = tc_changeselection_3; - // Movement geometries and clipping for tabs - switch(l.tloc) - { - case 0: // top - l.xo = +1; - l.yo = +2; - l.cl = "bottom"; - l.ci = -2; - break; - case 1: // bottom - l.xo = +1; - l.yo = -2; - l.cl = "top"; - l.ci = +2; - break; - case 2: // left - l.xo = +2; - l.yo = +1; - l.cl = "right"; - l.ci = -2; - break; - case 3: // right - l.xo = -2; - l.yo = +1; - l.cl = "left"; - l.ci = +2; - break; - case 4: // none - l.xo = 0; - l.yo = 0; - l.cl = "bottom"; - l.ci = 0; - break; - } return l; } -function tc_visible_changed(prop,o,n) +/*** Idk what this does... + *** + *** @param prop Unused, for some reason. + *** @param o Unused again... + *** @param n If this is true, it makes this.tab inherit visibility. Otherwise, hidden. + *** @returns nothing... idk what this is doing. + */ +function tc_visible_changed(prop, o, n) { - var t = this.tabctl; - var xo = t.xo; - var yo = t.yo; + const { tabctl: t } = this; + const { tabs, tloc } = t; + + if (tloc === 'None') console.warn("tc_visible_changed() called on tab contol with tab_location = none."); + if(n) htr_setvisibility(this.tab, 'inherit'); else htr_setvisibility(this.tab, 'hidden'); - // which tab should be selected? - if(htr_getvisibility(t.tabs[t.selected_index-1].tab)!='inherit') + + /** This nonsense is why we need goto in js. **/ + const pickSelectedTab = () => { - //try default tab - if(htr_getvisibility(t.init_tab.tab)=='inherit') + // If a visible tab is already selected, we're done. + const selected = tabs[t.selected_index-1]; + if (htr_getvisibility(selected.tab) === 'inherit') return; + + // Try to select the initial tab. + const initial = t.init_tab; + if (htr_getvisibility(initial.tab) === 'inherit') { - // This is forced, so we skip the obscure/reveal checks - t.ChangeSelection3(t.tabs[t.init_tab.tabindex-1]); - //t.tabs[t.init_tab.tabindex-1].makeCurrent(); - } - else //otherwise find first tab not hidden - { - for(var i=0; iCapabilities.Dom0NS && !s->Capabilities.Dom0IE &&(!s->Capabilities.Dom1HTML || !s->Capabilities.Dom2CSS)) { mssError(1,"HTTAB","NS4 or W3C DOM Support required"); return -1; } - - /** Get an id for this. **/ + + /** Reserve the next tab widget ID. **/ id = (HTTAB.idcnt++); - - /** Get name **/ - if (wgtrGetPropertyValue(tree,"name",DATA_T_STRING,POD(&ptr)) != 0) return -1; - strtcpy(name,ptr,sizeof(name)); - - /** Get x,y,w,h of this object **/ - if (wgtrGetPropertyValue(tree,"x",DATA_T_INTEGER,POD(&x)) != 0) x=0; - if (wgtrGetPropertyValue(tree,"y",DATA_T_INTEGER,POD(&y)) != 0) y=0; - if (wgtrGetPropertyValue(tree,"width",DATA_T_INTEGER,POD(&w)) != 0) + + /** Get the tab widget name. **/ + if (wgtrGetPropertyValue(tree, "name", DATA_T_STRING, POD(&ptr)) != 0) return -1; + strtcpy(name, ptr, sizeof(name)); + + /** Get x, y, w, & h of this object. **/ + if (wgtrGetPropertyValue(tree, "x", DATA_T_INTEGER, POD(&x)) != 0) x = 0; + if (wgtrGetPropertyValue(tree, "y", DATA_T_INTEGER, POD(&y)) != 0) y = 0; + if (wgtrGetPropertyValue(tree, "width", DATA_T_INTEGER, POD(&w)) != 0) { - mssError(0,"HTTAB","Tab widget must have a 'width' property"); + mssError(0, "HTTAB", "Tab widget must have a 'width' property"); return -1; } - if (wgtrGetPropertyValue(tree,"height",DATA_T_INTEGER,POD(&h)) != 0) + if (wgtrGetPropertyValue(tree, "height", DATA_T_INTEGER, POD(&h)) != 0) { - mssError(0,"HTTAB","Tab widget must have a 'height' property"); + mssError(0, "HTTAB", "Tab widget must have a 'height' property"); return -1; } - - /** Drop shadow **/ - shadow_offset=0; + + /** Get drop shadow data. **/ + shadow_offset = 0; if (wgtrGetPropertyValue(tree, "shadow_offset", DATA_T_INTEGER, POD(&shadow_offset)) == 0 && shadow_offset > 0) shadow_radius = shadow_offset+1; else @@ -128,25 +125,25 @@ httabRender(pHtSession s, pWgtrNode tree, int z) } if (wgtrGetPropertyValue(tree, "shadow_angle", DATA_T_INTEGER, POD(&shadow_angle)) != 0) shadow_angle = 135; - - /** Border radius, color, and style. **/ - if (wgtrGetPropertyValue(tree,"border_radius",DATA_T_INTEGER,POD(&border_radius)) != 0) - border_radius=0; - if (wgtrGetPropertyValue(tree,"border_color",DATA_T_STRING,POD(&ptr)) != 0) + + /** Get border info (radius, color, and style). **/ + if (wgtrGetPropertyValue(tree, "border_radius", DATA_T_INTEGER, POD(&border_radius)) != 0) + border_radius = 0; + if (wgtrGetPropertyValue(tree, "border_color", DATA_T_STRING, POD(&ptr)) != 0) strcpy(border_color, "#ffffff"); else strtcpy(border_color, ptr, sizeof(border_color)); - if (wgtrGetPropertyValue(tree,"border_style",DATA_T_STRING,POD(&ptr)) != 0) + if (wgtrGetPropertyValue(tree, "border_style", DATA_T_STRING,POD(&ptr)) != 0) strcpy(border_style, "outset"); else strtcpy(border_style, ptr, sizeof(border_style)); if (!strcmp(border_style, "none") || !strcmp(border_style, "hidden")) - border_width=0; + border_width = 0; else - border_width=1; - - /** Which side are the tabs on? **/ - if (wgtrGetPropertyValue(tree,"tab_location",DATA_T_STRING,POD(&ptr)) == 0) + border_width = 1; + + /** Get tab_location. **/ + if (wgtrGetPropertyValue(tree, "tab_location", DATA_T_STRING, POD(&ptr)) == 0) { if (!strcasecmp(ptr,"top")) tloc = Top; else if (!strcasecmp(ptr,"bottom")) tloc = Bottom; @@ -163,209 +160,532 @@ httabRender(pHtSession s, pWgtrNode tree, int z) { tloc = Top; } - - /** How wide should left/right tabs be? **/ - if (wgtrGetPropertyValue(tree,"tab_width",DATA_T_INTEGER,POD(&tab_width)) != 0) + + /** Count the number of tabs. **/ + tab_count = wgtrGetMatchingChildList(tree, "widget/tabpage", children, sizeof(children) / sizeof(pWgtrNode)); + + /** Get the selected tab. **/ + if (wgtrGetPropertyType(tree, "selected") == DATA_T_STRING && + wgtrGetPropertyType(tree, "selected_index") == DATA_T_INTEGER) { - if (tloc == Right || tloc == Left) + mssError(1,"HTTAB","%s: cannot specify both 'selected' and 'selected_index'", name); + return -1; + } + if (wgtrGetPropertyValue(tree, "selected", DATA_T_STRING, POD(&ptr)) == 0) + { + /** Search for the tab with the indicated name. **/ + for (i = 0; i < tab_count; i++) { - mssError(1,"HTTAB","%s: tab_width must be specified with tab_location of left or right", name); + char* tab_name; + wgtrGetPropertyValue(children[i], "name", DATA_T_STRING, POD(&tab_name)); + if (strcmp(ptr, tab_name) == 0) + { + /** sel_idx is 1 based, but i is 0 based. **/ + sel_idx = i + 1; + break; + } + } + if (i >= tab_count) { + mssError(1, "HTTAB", "%s: cannot find tab with name '%s'", name, ptr); + + /** Attempt to give hint. **/ + if (tab_count <= 0) return -1; + char* example_tab_name; + wgtrGetPropertyValue(children[0], "name", DATA_T_STRING, POD(&example_tab_name)); + mssError(0, "HTTAB", "Hint: 'selected' should be a tab name, such as \"%s\".", example_tab_name); + + /** Fail. **/ + return -1; + } + } + else if (wgtrGetPropertyValue(tree, "selected_index", DATA_T_INTEGER, POD(&sel_idx)) == 0) + { + if (sel_idx <= 0) + { + mssError(1, "HTTAB", "Invalid value for 'selected_index': %d.", sel_idx); + if (sel_idx == 0) mssError(0, "HTTAB", "Hint: 'selected_index' is 1-based."); + return -1; + } + if (sel_idx > tab_count) + { + mssError(1, "HTTAB", + "Invalid value for 'selected_index': %d. Tab control only has %d tab%s.", + sel_idx, tab_count, (tab_count == 1) ? "" : "s" + ); return -1; } } else { - if (tab_width < 0) tab_width = 0; + /** No specified selected tab, default to the first one. **/ + sel_idx = 1; } - - /** Which tab is selected? **/ - if (wgtrGetPropertyType(tree,"selected") == DATA_T_STRING && - wgtrGetPropertyValue(tree,"selected",DATA_T_STRING,POD(&ptr)) == 0) + + /** Handle user expressions for the selected tab. **/ + htrCheckAddExpression(s, tree, name, "selected"); + htrCheckAddExpression(s, tree, name, "selected_index"); + + /** Get the background color/image. **/ + htrGetBackground(tree, NULL, s->Capabilities.Dom2CSS, main_bg, sizeof(main_bg)); + + /** Get the inactive tab color/image. **/ + if (htrGetBackground(tree, "inactive", s->Capabilities.Dom2CSS, inactive_bg, sizeof(inactive_bg)) != 0) + strcpy(inactive_bg, main_bg); + + /** Get the text color. **/ + if (wgtrGetPropertyValue(tree, "textcolor", DATA_T_STRING, POD(&ptr)) == 0 + && !strpbrk(ptr, "{};&<>\"\'")) + strtcpy(text_color, ptr, sizeof(text_color)); + else + strcpy(text_color,"black"); + + /** Get the tab spacing and tab height. **/ + /** tab_w and tab_h are left as 0 if unset to tell the front end to calculate them dynamically. **/ + int tab_spacing = 2; /* Default to a 2px gap between tabs. */ + if (wgtrGetPropertyValue(tree, "tab_spacing", DATA_T_INTEGER, POD(&tmp)) == 0) tab_spacing = tmp; + if (wgtrGetPropertyValue(tree, "tab_width", DATA_T_INTEGER, POD(&tmp)) == 0) { - strtcpy(sel,ptr, sizeof(sel)); + if (tmp <= 0) + { + mssError(1, "HTTAB", "%s: 'tab_width' expected positive nonzero int, got %d.", name, tmp); + return -1; + } + tab_w = tmp; } - else + else if (tloc == Right || tloc == Left) { - strcpy(sel,""); + mssError(1, "HTTAB", "%s: 'tab_width' must be specified for 'tab_location' of left or right", name); + return -1; } - if (wgtrGetPropertyValue(tree,"selected_index", DATA_T_INTEGER, POD(&sel_idx)) != 0) + else { - sel_idx = -1; + /** Use a default value, updated client side. */ + tab_w = 80; + is_auto_tab_w = 1; } - if (sel_idx != -1 && *sel != '\0') + if (wgtrGetPropertyValue(tree, "tab_height", DATA_T_INTEGER, POD(&tmp)) == 0) { - mssError(1,"HTTAB","%s: cannot specify both 'selected' and 'selected_index'", name); - return -1; + if (tmp <= 0) + { + mssError(1, "HTTAB", "%s: 'tab_height' expected positive nonzero int, got %d.", name, tmp); + return -1; + } + tab_h = tmp; } - - /** User requesting expression for selected tab? **/ - htrCheckAddExpression(s, tree, name, "selected"); - - /** User requesting expression for selected tab using integer index value? **/ - htrCheckAddExpression(s, tree, name, "selected_index"); - - /** Background color/image? **/ - htrGetBackground(tree, NULL, s->Capabilities.Dom2CSS, main_bg, sizeof(main_bg)); - - /** Inactive tab color/image? **/ - htrGetBackground(tree, "inactive", s->Capabilities.Dom2CSS, inactive_bg, sizeof(inactive_bg)); - - /** Text color? **/ - if (wgtrGetPropertyValue(tree,"textcolor",DATA_T_STRING,POD(&ptr)) == 0) - strtcpy(tab_txt, ptr, sizeof(tab_txt)); else - strcpy(tab_txt,"black"); - if (strpbrk(tab_txt, "{};&<>\"\'")) - strcpy(tab_txt,"black"); - - /** Determine offset to actual tab pages **/ - switch(tloc) { - case Top: xoffset = 0; yoffset = 24; xtoffset = 0; ytoffset = 0; break; - case Bottom: xoffset = 0; yoffset = 0; xtoffset = 0; ytoffset = h; break; - case Right: xoffset = 0; yoffset = 0; xtoffset = w; ytoffset = 0; break; - case Left: xoffset = tab_width; yoffset = 0; xtoffset = 0; ytoffset = 0; break; - case None: xoffset = 0; yoffset = 0; xtoffset = 0; ytoffset = 0; + /** Use default value, no client side calculation available. **/ + tab_h = 24; } - - /** Ok, write the style header items. **/ - htrAddStylesheetItem_va(s,"\t#tc%POSbase { background-position: 0px -24px; %STR }\n", id, main_bg); - - /** DOM Linkages **/ - htrAddWgtrObjLinkage_va(s, tree, "tc%POSbase",id); - - /** Script include **/ + + /** Get macro selection translation values. **/ + /** CHANGE: Code previously used 1, but I think 0 is a better looking default. **/ + int along, out; + if (wgtrGetPropertyValue(tree, "select_translate_along", DATA_T_INTEGER, POD(&along)) != 0) along = 0; + if (wgtrGetPropertyValue(tree, "select_translate_out", DATA_T_INTEGER, POD(&out)) != 0) out = 2; + + /** Determine offset to actual tab pages and offsets for selected tabs. **/ + int select_x_offset = 0, select_y_offset = 0; + switch (tloc) + { + /*** Shift to cover boarder line: + *** Top: ytoffset +1 + *** Bottom: ytoffset -2 + *** Left: xtoffset +1 + *** Right: xtoffset -2 + ***/ + case Top: xoffset = 0; yoffset = tab_h; xtoffset = 0; ytoffset = 0; select_x_offset = -along; select_y_offset = -out; break; + case Bottom: xoffset = 0; yoffset = 0; xtoffset = 0; ytoffset = h-1; select_x_offset = -along; select_y_offset = +out; break; + case Left: xoffset = tab_w; yoffset = 0; xtoffset = 0; ytoffset = 0; select_x_offset = -out; select_y_offset = -along; break; + case Right: xoffset = 0; yoffset = 0; xtoffset = w-1; ytoffset = 0; select_x_offset = +out; select_y_offset = -along; break; + case None: xoffset = 0; yoffset = 0; xtoffset = 0; ytoffset = 0; select_x_offset = 0; select_y_offset = 0; break; + } + + /** Get coordinate-based selection translation values. **/ + if (wgtrGetPropertyValue(tree, "select_translate_x", DATA_T_INTEGER, POD(&tmp)) == 0) select_x_offset = tmp; + if (wgtrGetPropertyValue(tree, "select_translate_y", DATA_T_INTEGER, POD(&tmp)) == 0) select_y_offset = tmp; + + /*** Apply the opposite of the selection offset to all tabs. This + *** prevents the offset from causing the selected tab to appear + *** detached from the tab control. + ***/ + xtoffset -= select_x_offset; + ytoffset -= select_y_offset; + + /** Get the rendering type. **/ + /** Allows the developer to turn off JS client-side widget rendering for testing. **/ + int do_client_rendering = 1; + if (wgtrGetPropertyValue(tree, "rendering", DATA_T_STRING, POD(&ptr)) == 0) + { + if (strcmp(ptr, "server-side") == 0) do_client_rendering = 0; + else if (strcmp(ptr, "client-side") == 0) do_client_rendering = 1; + else + { + mssError(1, "HTTAB", "%s: Unknown value for 'rendering': %s", name, ptr); + mssError(0, "HTTAB", "HINT: Should be either 'server-side' or 'client-size'."); + return -1; + } + } + if (!do_client_rendering && tab_w == 0 && (tloc == Top || tloc == Bottom)) + { + /*** The dev has specified server-side rendering for Top/Bottom tabs + *** with dynamic width. This will probably look broken. + ***/ + mssError(1, "HTTAB", + "%s: 'rendering' value of \"server-side\" will break on tabs " + "with dynamic widths because they cannot be calculated server-side!", + name + ); + mssError(0, "HTTAB", "HINT: Specify 'tab_width' when using \"server-side\" rendering."); + } + + /** Handle DOM linkages. **/ + htrAddWgtrObjLinkage_va(s, tree, "tc%POSctrl", id); + + /** Include the htdrv_tab.js script. **/ htrAddScriptInclude(s, "/sys/js/htdrv_tab.js", 0); - - /** Add a global for the master tabs listing **/ + + /** Send globals variables to the client to avoid needing to hard code them. **/ + const int bufsiz = 96; + char* config_buf = nmSysMalloc(bufsiz); + if (config_buf == NULL) + { + mssError(1, "HTTAB", "%s: nmSysMalloc(%d) failed.", name, bufsiz); + return -1; + } + snprintf( + memset(config_buf, 0, bufsiz), bufsiz, + "{ tlocs: { Top:%d, Bottom:%d, Left:%d, Right:%d, None:%d } }", + Top, Bottom, Left, Right, None + ); + htrAddScriptGlobal(s, "tc_config", config_buf, HTR_F_VALUEALLOC); + /*** TODO: Greg - config_buf is definitely leaked because I can't + *** figure out how long it needs to remain in scope. + ***/ + + /** Add globals for the master tabs listing. **/ htrAddScriptGlobal(s, "tc_tabs", "null", 0); htrAddScriptGlobal(s, "tc_cur_mainlayer", "null", 0); - - /** Event handler for click-on-tab **/ - htrAddEventHandlerFunction(s, "document","MOUSEDOWN","tc","tc_mousedown"); - htrAddEventHandlerFunction(s, "document","MOUSEUP","tc","tc_mouseup"); - htrAddEventHandlerFunction(s, "document","MOUSEMOVE","tc","tc_mousemove"); - htrAddEventHandlerFunction(s, "document","MOUSEOVER","tc","tc_mouseover"); - + + /** Add mouse event handlers. **/ + htrAddEventHandlerFunction(s, "document", "MOUSEDOWN", "tc", "tc_mousedown"); + htrAddEventHandlerFunction(s, "document", "MOUSEUP", "tc", "tc_mouseup"); + htrAddEventHandlerFunction(s, "document", "MOUSEMOVE", "tc", "tc_mousemove"); + htrAddEventHandlerFunction(s, "document", "MOUSEOVER", "tc", "tc_mouseover"); + /** Script initialization call. **/ - htrAddScriptInit_va(s," tc_init({layer:wgtrGetNodeRef(ns,\"%STR&SYM\"), tloc:%INT, mainBackground:\"%STR&JSSTR\", inactiveBackground:\"%STR&JSSTR\"});\n", - name, tloc, main_bg, inactive_bg); - + char tloc_name[8]; + switch (tloc) + { + case Top: strcpy(tloc_name, "Top"); break; + case Bottom: strcpy(tloc_name, "Bottom"); break; + case Left: strcpy(tloc_name, "Left"); break; + case Right: strcpy(tloc_name, "Right"); break; + case None: strcpy(tloc_name, "None"); break; + } + htrAddScriptInit_va(s, + "\ttc_init({" + "layer:wgtrGetNodeRef(ns,'%STR&SYM'), " + "tloc:'%STR', " + "mainBackground:'%STR&JSSTR', " + "inactiveBackground:'%STR&JSSTR', " + "select_x_offset:%INT, " + "select_y_offset:%INT, " + "xtoffset:%INT, " + "ytoffset:%INT, " + "tab_spacing:%INT, " + "tab_w:%INT, " + "tab_h:%INT, " + "do_client_rendering:%STR, " + "});\n", + name, + tloc_name, + main_bg, + inactive_bg, + select_x_offset, + select_y_offset, + xtoffset, + ytoffset, + tab_spacing, + (is_auto_tab_w) ? 0 : tab_w, /* 0 tells the front end that it should recalculate tab_w. */ + tab_h, + (do_client_rendering) ? "true" : "false" + ); + /** Check for tabpages within the tab control, to do the tabs at the top. **/ - tabcnt = wgtrGetMatchingChildList(tree, "widget/tabpage", children, sizeof(children)/sizeof(pWgtrNode)); if (tloc != None) { - for (i=0;i0, tab_width, - is_selected?(z+2):z, - (tloc==Bottom || tloc==Right)?0:border_radius, (tloc==Bottom || tloc==Left)?0:border_radius, (tloc==Top || tloc==Left)?0:border_radius, (tloc==Top || tloc==Right)?0:border_radius, - //(tloc==Top || tloc==Left)?0:border_radius, (tloc==Right)?0:border_radius, border_radius, (tloc==Bottom)?0:border_radius, - border_style, - (tloc!=Bottom)?1:0, (tloc!=Left)?1:0, (tloc!=Top)?1:0, (tloc!=Right)?1:0, - border_color, - sin(shadow_angle*M_PI/180)*shadow_offset, cos(shadow_angle*M_PI/180)*(-shadow_offset), shadow_radius, shadow_color, - (tloc != Right)?"left":"right", - tab_txt, bg - ); - - htrAddBodyItem_va(s, "

%[ %STR&HTE %]%[ %STR&HTE %]

\n", - id, i+1, - tloc == Right, tabname, - is_selected?2:3, - tloc != Right, tabname - ); + case Top: case Bottom: i_offset_x = full_tab_spacing + tab_w; break; + case Right: case Left: i_offset_y = full_tab_spacing + tab_h; break; + case None:; /* Unreachable, but the compiler doesn't believe me. */ } - } - - /** h-2 and w-2 because w3c dom borders add to actual width **/ - htrAddBodyItem_va(s,"
\n", - id, h-border_width*2, w-border_width*2, x+xoffset, y+yoffset, z+1, - border_style, border_color, - (tloc==Top || tloc==Left)?0:border_radius, (tloc==Right)?0:border_radius, border_radius, (tloc==Bottom)?0:border_radius, - sin(shadow_angle*M_PI/180)*shadow_offset, cos(shadow_angle*M_PI/180)*(-shadow_offset), shadow_radius, shadow_color + + /** Calculate tab flex information. **/ + /*** fl_x/y is enough flex to line up with the left/top of the tab + *** control. However, if the tab box changes size, tabs on the + *** right/bottom need to flex enough to handle that, too. + ***/ + double tab_fl_x = ht_get_fl_x(tree), tab_fl_y = ht_get_fl_y(tree); + if (tloc == Right) tab_fl_x += ht_get_fl_w(tree); + else if (tloc == Bottom) tab_fl_y += ht_get_fl_h(tree); + + /** Inject tab_fl values for client-side rendering. **/ + htrAddScriptInit_va(s, + "{" + "const node = wgtrGetNodeRef(ns,'%STR&SYM'); " + "node.tab_fl_x = %DBL; " + "node.tab_fl_y = %DBL; " + "}\n", + name, + tab_fl_x, + tab_fl_y + ); + + /** Loop over each tab. **/ + for (i = 0; i < tab_count; i++) + { + pWgtrNode tab = children[i]; + + /** Check if the tab is selected. **/ + int is_selected = (i == sel_idx - 1); + + /** Get type. **/ + wgtrGetPropertyValue(tab, "type", DATA_T_STRING, POD(&page_type)); + if (type == NULL || strcmp(type, "dynamic") != 0) strcpy(page_type, "static"); + + /** Use the tab title, defaulting to the tab name if it isn't specified. **/ + if (wgtrGetPropertyValue(tab, "title", DATA_T_STRING, POD(&tabname)) != 0) + wgtrGetPropertyValue(tab, "name", DATA_T_STRING, POD(&tabname)); + + /** Write tab CSS styles. **/ + int tab_x = (x + xtoffset) + (i_offset_x * i); + int tab_y = (y + ytoffset) + (i_offset_y * i); + htrAddStylesheetItem_va(s, + "\t#tc%POStab%POS { " + "position:absolute; " + "visibility:inherit; " + "left:"ht_flex_format"; " + "top:"ht_flex_format"; " + "%[width:%POSpx; %]" /* Tab width has 0 flexibility. */ + "%[height:%POSpx; %]" /* Tab height has 0 flexibility. */ + "overflow:hidden; " + "z-index:%POS; " + "cursor:default; " + "border-radius:" + "%POSpx " + "%POSpx " + "%POSpx " + "%POSpx; " + "border-style:%STR&CSSVAL; " + "border-width:%POSpx %POSpx %POSpx %POSpx; " + "border-color:%STR&CSSVAL; " + "box-shadow:%DBLpx %DBLpx %POSpx %STR&CSSVAL; " + "text-align:%STR&CSSVAL; " + "color:%STR&CSSVAL; " + "font-weight:bold; " + "background-position: %INTpx %INTpx; " + "%STR " + "}\n", + id, i + 1, + ht_flex(tab_x, ht_get_parent_w(tree), tab_fl_x), // left + ht_flex(tab_y, ht_get_parent_h(tree), tab_fl_y), // top + (!is_auto_tab_w), tab_w, /* Tab width has 0 flexibility. */ + (tab_h > 0), tab_h, /* Tab height has 0 flexibility. */ + (is_selected) ? (z + 2) : z, + (tloc == Bottom || tloc == Right) ? 0 : border_radius, + (tloc == Bottom || tloc == Left) ? 0 : border_radius, + (tloc == Top || tloc == Left) ? 0 : border_radius, + (tloc == Top || tloc == Right) ? 0 : border_radius, + border_style, + (tloc != Bottom) ? 1 : 0, (tloc != Left) ? 1 : 0, (tloc != Top) ? 1 : 0, (tloc != Right) ? 1 : 0, + border_color, + sin(shadow_angle * M_PI/180) * shadow_offset, cos(shadow_angle * M_PI/180) * (-shadow_offset), shadow_radius, shadow_color, + (tloc != Right) ? "left" : "right", + text_color, + tab_x + 1, tab_y, + (is_selected) ? main_bg : inactive_bg ); - - /** Check for tabpages within the tab control entity, this time to do the pages themselves **/ - for (i=0;i" + "

" + "%[ %STR&HTE %]" + "" + "%[ %STR&HTE %]" + "

" + "
\n", + id, i + 1, (is_selected), + (tloc == Right), tabname, + (is_selected) ? 2 : 3, tab_h, + (tloc != Right), tabname + ); + } + } + + /** Write tab control CSS and HTML. **/ + htrAddStylesheetItem_va(s, + "#tc%POSctrl {" + "position:absolute; " + "overflow:hidden; " + "left:"ht_flex_format"; " + "top:"ht_flex_format"; " + "width:"ht_flex_format"; " + "height:"ht_flex_format"; " + "z-index:%POS; " + "border-width:1px; " + "border-style:%STR&CSSVAL; " + "border-color:%STR&CSSVAL; " + "border-radius:" + "%POSpx " + "%POSpx " + "%POSpx " + "%POSpx; " + "box-shadow:%DBLpx %DBLpx %POSpx %STR&CSSVAL; " + "background-position:%INTpx %INTpx; " + "%STR " + "}\n", + id, + ht_flex_x(x + xoffset, tree), + ht_flex_y(y + yoffset, tree), + ht_flex_w(w - border_width * 2, tree), + ht_flex_h(h - border_width * 2, tree), + z + 1, + border_style, + border_color, + (tloc==Top || tloc==Left) ? 0 : border_radius, + (tloc==Right) ? 0 : border_radius, + border_radius, + (tloc==Bottom) ? 0 : border_radius, + sin(shadow_angle * M_PI/180) * shadow_offset, cos(shadow_angle * M_PI/180) * (-shadow_offset), shadow_radius, shadow_color, + x + xoffset, y + yoffset, + main_bg + ); + htrAddBodyItem_va(s, "
\n", id); + + /** Check for tab pages within the tab control entity, this time to do the pages themselves. **/ + for (i = 0; i < tab_count; i++) { - tabpage_obj = children[i]; - - htrCheckNSTransition(s, tree, tabpage_obj); - + pWgtrNode tab_page_tree = children[i]; + + /** Handle namespace transition. **/ + htrCheckNSTransition(s, tree, tab_page_tree); + /** First, render the tabpage and add stuff for it **/ - wgtrGetPropertyValue(tabpage_obj,"name",DATA_T_STRING,POD(&ptr)); - is_selected = (i+1 == sel_idx || (!*sel && i == 0) || !strcmp(sel,ptr)); - if(wgtrGetPropertyValue(tabpage_obj,"type",DATA_T_STRING,POD(&type)) != 0) - strcpy(page_type,"static"); - else if(!strcmp(type,"static") || !strcmp(type,"dynamic")) - strcpy(page_type,type); - else - strcpy(page_type,"static"); - strcpy(fieldname,""); - if(!strcmp(page_type,"dynamic")) - { - if(wgtrGetPropertyValue(tabpage_obj,"fieldname",DATA_T_STRING,POD(&field)) == 0) - strtcpy(fieldname,field,sizeof(fieldname)); - } - + wgtrGetPropertyValue(tab_page_tree,"name",DATA_T_STRING,POD(&ptr)); + + /** Check if the tab is selected. **/ + int is_selected = (i == sel_idx - 1); + + /** Set type. **/ + wgtrGetPropertyValue(tab_page_tree, "type", DATA_T_STRING, POD(&page_type)); + if (type == NULL || strcmp(type, "dynamic") != 0) strcpy(page_type, "static"); + + /** Set feildname. **/ + if (strcmp(page_type, "dynamic") == 0 && + wgtrGetPropertyValue(tab_page_tree, "fieldname", DATA_T_STRING, POD(&field)) == 0) + strtcpy(fieldname, field, sizeof(fieldname)); + else strcpy(fieldname, ""); + /** Add script initialization to add a new tabpage **/ if (tloc == None) - htrAddScriptInit_va(s," wgtrGetNodeRef('%STR&SYM', '%STR&SYM').addTab(null,wgtrGetContainer(wgtrGetNodeRef(\"%STR&SYM\",\"%STR&SYM\")),wgtrGetNodeRef('%STR&SYM','%STR&SYM'),'%STR&JSSTR','%STR&JSSTR','%STR&JSSTR');\n", + { + htrAddScriptInit_va(s, + "\twgtrGetNodeRef('%STR&SYM', '%STR&SYM')" + ".addTab(null, " + "wgtrGetContainer(wgtrGetNodeRef('%STR&SYM', '%STR&SYM')), " + "wgtrGetNodeRef('%STR&SYM', '%STR&SYM'), " + "'%STR&JSSTR', '%STR&JSSTR', '%STR&JSSTR'" + ");\n", + wgtrGetNamespace(tree), name, + wgtrGetNamespace(tab_page_tree), ptr, wgtrGetNamespace(tree), name, - wgtrGetNamespace(tabpage_obj), ptr, wgtrGetNamespace(tree), name, ptr,page_type,fieldname); + ptr, page_type, fieldname + ); + } else - htrAddScriptInit_va(s," wgtrGetNodeRef('%STR&SYM','%STR&SYM').addTab(htr_subel(wgtrGetParentContainer(wgtrGetNodeRef('%STR&SYM','%STR&SYM')),\"tc%POStab%POS\"),wgtrGetContainer(wgtrGetNodeRef(\"%STR&SYM\",\"%STR&SYM\")),wgtrGetNodeRef('%STR&SYM','%STR&SYM'),'%STR&JSSTR','%STR&JSSTR','%STR&JSSTR');\n", + { + htrAddScriptInit_va(s, + "\twgtrGetNodeRef('%STR&SYM','%STR&SYM')" + ".addTab(" + "htr_subel(" + "wgtrGetParentContainer(wgtrGetNodeRef('%STR&SYM', '%STR&SYM')), " + "'tc%POStab%POS'" + "), " + "wgtrGetContainer(wgtrGetNodeRef('%STR&SYM', '%STR&SYM')), " + "wgtrGetNodeRef('%STR&SYM', '%STR&SYM'), " + "'%STR&JSSTR', '%STR&JSSTR', '%STR&JSSTR'" + ");\n", wgtrGetNamespace(tree), name, wgtrGetNamespace(tree), name, - id, i+1, wgtrGetNamespace(tabpage_obj), ptr, wgtrGetNamespace(tree), name, ptr,page_type,fieldname); - - /** Add named global for the tabpage **/ - subnptr = nmSysStrdup(ptr); - htrAddWgtrObjLinkage_va(s, tabpage_obj, "tc%POSpane%POS", id, i+1); - htrAddWgtrCtrLinkage_va(s, tabpage_obj, "htr_subel(_parentobj, \"tc%POSpane%POS\")", id, i+1); - - /** Add DIV section for the tabpage. **/ - htrAddBodyItem_va(s,"
\n", - id,i+1,is_selected?"inherit":"hidden",w-2,z+2); - - /** Now look for sub-items within the tabpage. **/ - for (j=0;jChildren));j++) - htrRenderWidget(s, xaGetItem(&(tabpage_obj->Children), j), z+3); - - htrAddBodyItem(s, "
\n"); - - nmSysFree(subnptr); - - /** Add the visible property **/ - htrCheckAddExpression(s, tabpage_obj, ptr, "visible"); - - htrCheckNSTransitionReturn(s, tree, tabpage_obj); + id, i + 1, + wgtrGetNamespace(tab_page_tree), ptr, + wgtrGetNamespace(tree), name, + ptr, page_type, fieldname + ); + } + + /** Add named global for the tabpage. **/ + htrAddWgtrObjLinkage_va(s, tab_page_tree, "tc%POSpane%POS", id, i+1); + htrAddWgtrCtrLinkage_va(s, tab_page_tree, "htr_subel(_parentobj, \"tc%POSpane%POS\")", id, i + 1); + + /** Add DIV section to contane the tabpage. **/ + htrAddBodyItem_va(s, + "
\n", + id, i + 1, + (is_selected) ? "inherit" : "hidden", + z + 2 + ); + + /** Handle sub-items within the tabpage. **/ + for (int j = 0; j < xaCount(&(tab_page_tree->Children)); j++) + htrRenderWidget(s, xaGetItem(&(tab_page_tree->Children), j), z+3); + + /** Close the tab page container. */ + htrAddBodyItem(s, "
\n"); + + /** Add the visible property. **/ + htrCheckAddExpression(s, tab_page_tree, ptr, "visible"); + + /** Handle namespace transition. **/ + htrCheckNSTransitionReturn(s, tree, tab_page_tree); } - - /** Need to do other subwidgets (connectors, etc.) now **/ - htrRenderSubwidgets(s, tree, z+1); - + + /** Handle other subwidgets (connectors, etc.). **/ + htrRenderSubwidgets(s, tree, z + 1); + /** End the containing layer. **/ - htrAddBodyItem(s, "
\n"); - + htrAddBodyItem(s, "
\n"); + return 0; } @@ -385,25 +705,20 @@ httabInitialize() { pHtDriver drv; - /** Allocate the driver **/ + /** Tab Control Driver. **/ drv = htrAllocDriver(); - if (!drv) return -1; - - /** Fill in the structure. **/ - strcpy(drv->Name,"DHTML Tab Control Driver"); - strcpy(drv->WidgetName,"tab"); + if (drv == NULL) return -1; + strcpy(drv->Name, "DHTML Tab Control Driver"); + strcpy(drv->WidgetName, "tab"); drv->Render = httabRender; - /*xaAddItem(&(drv->PseudoTypes), "tabpage");*/ - - /** Register. **/ htrRegisterDriver(drv); - htrAddSupport(drv, "dhtml"); + /** Tab Page Driver. **/ drv = htrAllocDriver(); - if (!drv) return -1; - strcpy(drv->Name,"DHTML Tab Page Driver"); - strcpy(drv->WidgetName,"tabpage"); + if (drv == NULL) return -1; + strcpy(drv->Name, "DHTML Tab Page Driver"); + strcpy(drv->WidgetName, "tabpage"); drv->Render = httabRender_page; htrRegisterDriver(drv); htrAddSupport(drv, "dhtml"); From 7cd1fd74f147132900f1adf93fd0b080c129fd7a Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Mon, 9 Feb 2026 10:50:40 -0700 Subject: [PATCH 077/275] Make the clock widget responsive. Remove the moveable attribute. Simplify clock widget event code. Clean up cl_get_time(). --- centrallix-os/samples/clock.app | 3 - centrallix-os/sys/js/htdrv_clock.js | 62 ++++++-------------- centrallix/htmlgen/htdrv_clock.c | 88 +++++++++++++++++++++-------- 3 files changed, 80 insertions(+), 73 deletions(-) diff --git a/centrallix-os/samples/clock.app b/centrallix-os/samples/clock.app index 1a2567ab3..a17ceb2af 100644 --- a/centrallix-os/samples/clock.app +++ b/centrallix-os/samples/clock.app @@ -14,7 +14,6 @@ main "widget/page" shadowx = 2; shadowy = 2; size=1; - moveable="true"; bold="true"; } clock2 "widget/clock" @@ -22,7 +21,6 @@ main "widget/page" background="/sys/images/fade_pixelate_01.gif"; x=15; y=55; width=80; height=20; fgcolor1="white"; - moveable="true"; bold="true"; } clock3 "widget/clock" @@ -33,7 +31,6 @@ main "widget/page" fgcolor1="orange"; fgcolor2="#666666"; // size=3; - moveable="true"; bold="true"; } } diff --git a/centrallix-os/sys/js/htdrv_clock.js b/centrallix-os/sys/js/htdrv_clock.js index d7bec6027..612fdf452 100644 --- a/centrallix-os/sys/js/htdrv_clock.js +++ b/centrallix-os/sys/js/htdrv_clock.js @@ -24,7 +24,6 @@ function cl_init(param){ l.contentLayer = c1; l.hiddenLayer = c2; l.shadowed = param.shadowed; - l.moveable = param.moveable; l.bold = param.bold; l.fgColor1 = param.foreground1; l.fgColor2 = param.foreground2; @@ -57,13 +56,14 @@ function cl_init(param){ } function cl_get_time(l) { - var t = new Date(); - var time = new Object(); - time.hrs = t.getHours(); - time.mins = t.getMinutes(); - time.secs = t.getSeconds(); - time.msecs = t.getMilliseconds(); - time.formated = cl_format_time(l,time); + const t = new Date(); + const time = { + hrs: t.getHours(), + mins: t.getMinutes(), + secs: t.getSeconds(), + msecs: t.getMilliseconds(), + }; + time.formated = cl_format_time(l, time); return time; } @@ -110,46 +110,16 @@ function cl_format_time(l,t) { return timef; } -function cl_mouseup(e) { - if (e.kind == 'cl') { - cn_activate(e.mainlayer, 'MouseUp'); - if (e.mainlayer.moveable) cl_move = false; - } - return EVENT_CONTINUE | EVENT_ALLOW_DEFAULT_ACTION; -} - -function cl_mousedown(e) { - if (e.kind == 'cl') { - cn_activate(e.mainlayer, 'MouseDown'); - if (e.mainlayer.moveable) { - cl_move = true; - cl_xOffset = e.pageX - getPageX(e.mainlayer); - cl_yOffset = e.pageY - getPageY(e.mainlayer); - } - } - return EVENT_CONTINUE | EVENT_ALLOW_DEFAULT_ACTION; -} - -function cl_mouseover(e) { - if (e.kind == 'cl') cn_activate(e.mainlayer, 'MouseOver'); - return EVENT_CONTINUE | EVENT_ALLOW_DEFAULT_ACTION; -} - -function cl_mouseout(e) { - if (e.kind == 'cl') cn_activate(e.mainlayer, 'MouseOut'); - return EVENT_CONTINUE | EVENT_ALLOW_DEFAULT_ACTION; -} - -function cl_mousemove(e) { - if (e.kind == 'cl') { - cn_activate(e.mainlayer, 'MouseMove'); - if (e.mainlayer.moveable && cl_move) - moveToAbsolute(e.mainlayer, - e.pageX - cl_xOffset, - e.pageY - cl_yOffset); - } +// Handle events by passing them on to Centrallix. +function cl_event(e, name) { + if (e && e.kind === 'cl') cn_activate(e.mainlayer, name); return EVENT_CONTINUE | EVENT_ALLOW_DEFAULT_ACTION; } +function cl_mouseup(e) { return cl_event(e, 'MouseUp'); } +function cl_mousedown(e) { return cl_event(e, 'MouseDown'); } +function cl_mouseover(e) { return cl_event(e, 'MouseOver'); } +function cl_mouseout(e) { return cl_event(e, 'MouseOut'); } +function cl_mousemove(e) { return cl_event(e, 'MouseMove'); } // Load indication if (window.pg_scripts) pg_scripts['htdrv_clock.js'] = true; diff --git a/centrallix/htmlgen/htdrv_clock.c b/centrallix/htmlgen/htdrv_clock.c index 26d070321..4799127c0 100644 --- a/centrallix/htmlgen/htdrv_clock.c +++ b/centrallix/htmlgen/htdrv_clock.c @@ -64,7 +64,6 @@ htclRender(pHtSession s, pWgtrNode tree, int z) int shadowx = 0; int shadowy = 0; int size = 0; - int moveable = 0; int bold = 0; int showsecs = 1; int showampm = 1; @@ -142,10 +141,6 @@ htclRender(pHtSession s, pWgtrNode tree, int z) if (wgtrGetPropertyValue(tree,"size",DATA_T_INTEGER,POD(&ptr)) == 0) size = (intptr_t)ptr; - /** Movable? **/ - if (wgtrGetPropertyValue(tree,"moveable",DATA_T_STRING,POD(&ptr)) == 0 && !strcmp(ptr,"true")) - moveable = 1; - /** Show Seconds **/ if (wgtrGetPropertyValue(tree,"seconds",DATA_T_STRING,POD(&ptr)) == 0 && (!strcasecmp(ptr,"false") || !strcasecmp(ptr,"no"))) showsecs = 0; @@ -160,19 +155,39 @@ htclRender(pHtSession s, pWgtrNode tree, int z) else fieldname[0]='\0'; - /** Write Style header items. **/ - htrAddStylesheetItem_va(s,"\t#cl%POSbase { POSITION:absolute; VISIBILITY:inherit; LEFT:%INTpx; TOP:%INTpx; WIDTH:%POSpx; Z-INDEX:%POS; }\n",id,x,y,w,z); - htrAddStylesheetItem_va(s,"\t#cl%POScon1 { POSITION:absolute; VISIBILITY:inherit; LEFT:%INTpx; TOP:%INTpx; WIDTH:%POSpx; Z-INDEX:%POS; }\n",id,0,0,w,z+2); - htrAddStylesheetItem_va(s,"\t#cl%POScon2 { POSITION:absolute; VISIBILITY:hidden; LEFT:%INTpx; TOP:%INTpx; WIDTH:%POSpx; Z-INDEX:%POS; }\n",id,0,0,w,z+2); - - /** Write named global **/ + /** Write style headers. **/ + htrAddStylesheetItem_va(s, + "\t#cl%POSbase { " + "position:absolute; " + "visibility:inherit; " + "left:"ht_flex_format"; " + "top:"ht_flex_format"; " + "width:"ht_flex_format"; " + "z-index:%POS; " + "}\n", + id, + ht_flex_x(x, tree), + ht_flex_y(y, tree), + ht_flex_w(w, tree), + z + ); + htrAddStylesheetItem_va(s, + "\t.cl%POScon { " + "position:absolute; " + "left:0px; " + "top:0px; " + "width:100%%; " + "z-index:%POS; " + "}\n", + id, + 0, + 0, + z + 2 + ); + + /** Setup linkage **/ htrAddWgtrObjLinkage_va(s, tree, "cl%POSbase",id); - /** Other global variables **/ - htrAddScriptGlobal(s, "cl_move", "false", 0); - htrAddScriptGlobal(s, "cl_xOffset", "null", 0); - htrAddScriptGlobal(s, "cl_yOffset", "null", 0); - /** Javascript include files **/ htrAddScriptInclude(s, "/sys/js/htdrv_clock.js", 0); htrAddScriptInclude(s, "/sys/js/ht_utils_string.js", 0); @@ -185,21 +200,46 @@ htclRender(pHtSession s, pWgtrNode tree, int z) htrAddEventHandlerFunction(s, "document","MOUSEMOVE", "cl", "cl_mousemove"); /** Script initialization call. **/ - htrAddScriptInit_va(s, " cl_init({layer:wgtrGetNodeRef(ns,\"%STR&SYM\"), c1:htr_subel(wgtrGetNodeRef(ns,\"%STR&SYM\"),\"cl%POScon1\"), c2:htr_subel(wgtrGetNodeRef(ns,\"%STR&SYM\"),\"cl%POScon2\"), fieldname:\"%STR&JSSTR\", background:\"%STR&JSSTR\", shadowed:%POS, foreground1:\"%STR&JSSTR\", foreground2:\"%STR&JSSTR\", fontsize:%INT, moveable:%INT, bold:%INT, sox:%INT, soy:%INT, showSecs:%INT, showAmPm:%INT, milTime:%INT});\n", + htrAddScriptInit_va(s, + "cl_init({ " + "layer:wgtrGetNodeRef(ns, '%STR&SYM'), " + "c1:htr_subel(wgtrGetNodeRef(ns, '%STR&SYM'), 'cl%POScon1'), " + "c2:htr_subel(wgtrGetNodeRef(ns, '%STR&SYM'), 'cl%POScon2'), " + "fieldname:'%STR&JSSTR', " + "background:'%STR&JSSTR', " + "shadowed:%POS, " + "foreground1:'%STR&JSSTR', " + "foreground2:'%STR&JSSTR', " + "fontsize:%INT, " + "bold:%INT, " + "sox:%INT, " + "soy:%INT, " + "showSecs:%INT, " + "showAmPm:%INT, " + "milTime:%INT, " + "});\n", name, name, id, name, id, - fieldname, main_bg, shadowed, - fgcolor1, fgcolor2, - size, moveable, bold, - shadowx, shadowy, - showsecs, showampm, miltime); + fieldname, + main_bg, + shadowed, + fgcolor1, + fgcolor2, + size, + bold, + shadowx, + shadowy, + showsecs, + showampm, + miltime + ); /** HTML body
element for the base layer. **/ htrAddBodyItem_va(s, "
\n",id); htrAddBodyItem_va(s, "
\n",main_bg,w,h); - htrAddBodyItem_va(s, "
\n",id); - htrAddBodyItem_va(s, "
\n",id); + htrAddBodyItem_va(s, "
\n", id, id); + htrAddBodyItem_va(s, " \n", id, id); htrAddBodyItem(s, "
\n"); /** Check for more sub-widgets **/ From b0b15536f152043cf6790f54a501dd8ef3245fef Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Mon, 9 Feb 2026 11:05:09 -0700 Subject: [PATCH 078/275] Debug and clean up the component widget. Fix a bug where the container div could block mouse events. Add print failure warning when component-decl uses an empty gname value. Add TODOs to improve error handling once dups util code is available. Add comments. Improve formatting. Clean up. --- centrallix/htmlgen/htdrv_component.c | 147 +++++++++++++++-------- centrallix/htmlgen/htdrv_componentdecl.c | 35 +++++- 2 files changed, 128 insertions(+), 54 deletions(-) diff --git a/centrallix/htmlgen/htdrv_component.c b/centrallix/htmlgen/htdrv_component.c index 14988d1a4..c1460c2cf 100644 --- a/centrallix/htmlgen/htdrv_component.c +++ b/centrallix/htmlgen/htdrv_component.c @@ -185,7 +185,6 @@ htcmpRender(pHtSession s, pWgtrNode tree, int z) char sbuf[128]; pStruct params = NULL; pStruct old_params = NULL; - int i; char* path; int is_toplevel; int old_is_dynamic = 0; @@ -275,14 +274,51 @@ htcmpRender(pHtSession s, pWgtrNode tree, int z) params = htcmp_internal_CreateParams(s, tree); /** Any params have expressions? **/ - if (params) + if (params != NULL) { - for(i=0;inSubInf;i++) + for (int i = 0; i < params->nSubInf; i++) { + /** TODO: Israel - Add error handling. **/ htrCheckAddExpression(s, tree, name, params->SubInf[i]->Name); } } + + /** Write styles for the enclosing div. **/ + htrAddStylesheetItem_va(s, + "\t#cmp%POSbase { " + "position:absolute; " + "visibility:inherit; " + "overflow:visible; " + "left:"ht_flex_format"; " + "top:"ht_flex_format"; " + "width:"ht_flex_format"; " + "height:"ht_flex_format"; " + "z-index:%POS; " + "}\n", + id, + ht_flex_x(x, tree), + ht_flex_y(y, tree), + ht_flex_w(w, tree), + ht_flex_h(h, tree), + z + ); + + /** Write enclosing div event CSS. **/ + htrAddStylesheetItem_va(s, + "\t#cmp%POSbase { " + "pointer-events:none; " + "}\n" + "\t#cmp%POSbase > * { " + "pointer-events:auto; " + "}\n", + id, id + ); + + /** Write enclosing div to isolate children. **/ + htrAddWgtrObjLinkage_va(s, tree, "cmp%POSbase", id); + htrAddBodyItem_va(s, "
\n", id); + /** If static mode, load the component **/ if (is_static) { @@ -305,13 +341,27 @@ htcmpRender(pHtSession s, pWgtrNode tree, int z) /** Init component **/ htrAddScriptInit_va(s, - " cmp_init({node:wgtrGetNodeRef(ns,\"%STR&SYM\"), is_static:true, allow_multi:false, auto_destroy:false, width:%INT, height:%INT, xpos:%INT, ypos:%INT});\n", - name, w,h,x,y); + "cmp_init({ " + "node:wgtrGetNodeRef(ns,\"%STR&SYM\"), " + "is_static:true, " + "allow_multi:false, " + "auto_destroy:false, " + "width:%INT, " + "height:%INT, " + "xpos:%INT, " + "ypos:%INT, " + "});\n", + name, + w, + h, + x, + y + ); /** Are there any templates we should use **/ memcpy(&wgtr_params, s->ClientInfo, sizeof(wgtr_params)); memset(wgtr_params.Templates, 0, sizeof(wgtr_params.Templates)); - for(i=0;i\n", id); /** Check param references **/ htcmp_internal_CheckReferences(cmp_tree, params, s->Namespace->DName); @@ -392,9 +418,6 @@ htcmpRender(pHtSession s, pWgtrNode tree, int z) /** Switch the namespace back **/ htrLeaveNamespace(s); - /** End the containing layer. **/ - htrAddBodyItem(s, "
\n"); - /** End Init component **/ htrAddScriptInit_va(s, " cmp_endinit(wgtrGetNodeRef(ns,\"%STR&SYM\"));\n", name); @@ -411,41 +434,68 @@ htcmpRender(pHtSession s, pWgtrNode tree, int z) s->IsDynamic = old_is_dynamic; old_is_dynamic = 0; } + /** Dynamic mode, component is loaded by the client. **/ else { /** Init component **/ htrAddScriptInit_va(s, - " cmp_init({node:wgtrGetNodeRef(ns,\"%STR&SYM\"), is_top:%POS, is_static:false, allow_multi:%POS, auto_destroy:%POS, path:\"%STR&JSSTR\", loader:htr_subel(wgtrGetParentContainer(wgtrGetNodeRef(ns,\"%STR&SYM\")), \"cmp%POS\"), width:%INT, height:%INT, xpos:%INT, ypos:%INT});\n", - name, is_toplevel, allow_multi, auto_destroy, cmp_path, - name, id, - w, h, x, y); + "cmp_init({ " + "node:wgtrGetNodeRef(ns, '%STR&SYM'), " + "is_top:%POS, " + "is_static:false, " + "allow_multi:%POS, " + "auto_destroy:%POS, " + "path:'%STR&JSSTR', " + "loader:htr_subel(wgtrGetParentContainer(wgtrGetNodeRef(ns, '%STR&SYM')), 'cmp%POS'), " + "width:%INT, " + "height:%INT, " + "xpos:%INT, " + "ypos:%INT, " + "});\n", + name, + is_toplevel, + allow_multi, + auto_destroy, + cmp_path, + name, id, + w, + h, + x, + y + ); - /** Add template paths **/ - for(i=0;inSubInf;i++) + for (int i = 0; i < params->nSubInf; i++) { - htrAddScriptInit_va(s, " wgtrGetNodeRef(ns,\"%STR&SYM\").AddParam(\"%STR&SYM\",%[null%]%[\"%STR&HEX\"%]);\n", - name, params->SubInf[i]->Name, !params->SubInf[i]->StrVal, params->SubInf[i]->StrVal, - params->SubInf[i]->StrVal); + htrAddScriptInit_va(s, + "wgtrGetNodeRef(ns, '%STR&SYM').AddParam('%STR&SYM', %[null%]%['%STR&HEX'%]);\n", + name, params->SubInf[i]->Name, !params->SubInf[i]->StrVal, params->SubInf[i]->StrVal, params->SubInf[i]->StrVal + ); } } /** Dynamic mode -- load from client **/ htrAddWgtrCtrLinkage(s, tree, "_parentctr"); htrAddBodyItemLayer_va(s, HTR_LAYER_F_DYNAMIC, "cmp%POS", id, NULL, ""); - htrAddStylesheetItem_va(s,"\t#cmp%POS { POSITION:absolute; VISIBILITY:hidden; LEFT:0px; TOP:0px; WIDTH:0px; HEIGHT:0px; Z-INDEX:0;}\n", id); + htrAddStylesheetItem_va(s,"\t#cmp%POS { position:absolute; visibility:hidden; left:0px; top:0px; width:0px; height:0px; z-index:0;}\n", id); } htrRenderSubwidgets(s, tree, z+1); + + /** End the enclosing div. **/ + htrAddBodyItem(s, "
\n"); rval = 0; @@ -507,4 +557,3 @@ htcmpInitialize() return 0; } - diff --git a/centrallix/htmlgen/htdrv_componentdecl.c b/centrallix/htmlgen/htdrv_componentdecl.c index 546b5cbb3..abd3f0998 100644 --- a/centrallix/htmlgen/htdrv_componentdecl.c +++ b/centrallix/htmlgen/htdrv_componentdecl.c @@ -89,7 +89,7 @@ htcmpdRender(pHtSession s, pWgtrNode tree, int z) int i, j; int rval = 0; int is_visual = 1; - char gbuf[256]; + char gbuf[256] = ""; char* gname; char* xptr; char* yptr; @@ -184,11 +184,37 @@ htcmpdRender(pHtSession s, pWgtrNode tree, int z) gname=""; htrAddWgtrCtrLinkage(s, tree, "_parentctr"); } + + /** Warning message. **/ + if (gname[0] == '\0') + { + fprintf(stderr, + "Warning: No value specified for gname, which is required to " + "be a valid symbol. Expect a printing failure.\n" + ); + } /** Init component **/ - htrAddScriptInit_va(s, " cmpd_init(wgtrGetNodeRef(ns,\"%STR&SYM\"), {vis:%POS, gns:%[\"%STR&SYM\"%]%[null%], gname:'%STR&SYM'%[, expe:'%STR&SYM'%]%[, expa:'%STR&SYM'%]%[, expp:'%STR&SYM'%]%[, applyhint:'%STR&SYM'%]});\n", - name, is_visual, *gbuf, gbuf, !*gbuf, gname, *expose_events_for, expose_events_for, *expose_actions_for, expose_actions_for, - *expose_props_for, expose_props_for, *apply_hints_to, apply_hints_to); + htrAddScriptInit_va(s, + "cmpd_init(wgtrGetNodeRef(ns, '%STR&SYM'), { " + "vis:%POS, " + "gns:%['%STR&SYM'%]%[null%], " + "gname:'%STR&SYM', " + "%[expe:'%STR&SYM', %]" + "%[expa:'%STR&SYM', %]" + "%[expp:'%STR&SYM', %]" + "%[applyhint:'%STR&SYM', %]" + "});\n", + name, + is_visual, + (gbuf[0] != '\0'), gbuf, (gbuf[0] == '\0'), + gname, + (expose_events_for[0] != '\0'), expose_events_for, + (expose_actions_for[0] != '\0'), expose_actions_for, + (expose_props_for[0] != '\0'), expose_props_for, + (apply_hints_to[0] != '\0'), apply_hints_to + ); + #if 0 for (i=0;iChildren));i++) { @@ -427,4 +453,3 @@ htcmpdInitialize() return 0; } - From aac68d9db876d99b0ac2dfeb76693b3210211311 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Mon, 9 Feb 2026 11:17:25 -0700 Subject: [PATCH 079/275] Make the scrollpane widget responsive. Rewrite scrollpane widget C code. Add mouse wheel scrolling to scrollpanes. Add settings to control scrolling in htdrv_scrollpane.js. Add ability to use any widget inside a scrollpane. Add ScrollTo action to scrollpanes. Add Scroll, Wheel, and Click events to scrollpanes. Fix scroll events supposedly existing despite having no code to implement them. Move JS globals to be declared in JS, closer to where they are used. Refactor JS code to use more subfunctions leading to cleaner, clearer logic. Improve event filtering to allow wheel events from children inside the scollpane. Improve code consistency. --- centrallix-doc/Widgets/widgets.xml | 14 +- centrallix-os/sys/js/htdrv_scrollpane.js | 790 ++++++++++++++++------- centrallix/htmlgen/htdrv_scrollpane.c | 531 ++++++++------- 3 files changed, 866 insertions(+), 469 deletions(-) diff --git a/centrallix-doc/Widgets/widgets.xml b/centrallix-doc/Widgets/widgets.xml index 3dbb50a24..a6d917ce4 100644 --- a/centrallix-doc/Widgets/widgets.xml +++ b/centrallix-doc/Widgets/widgets.xml @@ -3394,21 +3394,31 @@ $Version=2$ - Scrolls to a specific location determined by the scroll bar. + Scrolls to a specific location determined by the scroll bar. Specify the 'Percent' attribute to indicate how far to scroll in decimal representation (so 1.00 is 100%, aka. the bottom of the page). Specify 'Offset' how many pixels the content should be offset from the top (specify 100 to scroll the first 100 px of content off the top of the scroll pane). Specify 'RangeStart' and 'RangeEnd' to scroll to within the pixel range (using the same units as offset). Keep in mind that this action will trigger a scroll event to occur. + + This event occurs any time the user scrolls the scroll pane. This includes scrolling by clicking the scroll buttons, clicking on the scroll bar, dragging the scroll thumb, turning the scroll wheel, or when the ScrollTo action is used. This event does not occur when the scroll pane moves because the contained content changed in length, or when the scroll pane is forced to scroll because the available visible area was resized. This event will never occur if the content within the scroll pane is shorter than the available visible area because then the content cannot be scrolled. + This event provides the :Percent attribute, a number from 0 to 100 (the same as the ScrollTo action above) representing the percentage that the user has now scrolled down the page as of the event occuring. This event also provides :Change, representing how much the user's scroll location has changed in the same unit as above (although this value will be negative if the user scrolled up). + + This event occurs when the user moves the mouse pointer while it is over the widget. The event will repeatedly fire each time the pointer moves. + + This event occurs when the user moves the scroll wheel while it is over the widget (or content inside the widget). The event will repeatedly fire each time the pointer moves. + This event occurs when the user presses the mouse button on the widget. This differs from the 'Click' event in that the user must actually press and release the mouse button on the widget for a Click event to fire, whereas simply pressing the mouse button down will cause the MouseDown event to fire. - This event occurs when the user moves the mouse pointer while it is over the widget. The event will repeatedly fire each time the pointer moves. + This event occurs when the user moves the mouse pointer while it is over the widget (or content inside the widget). The event will repeatedly fire each time the pointer moves. This event occurs when the user moves the mouse pointer off of the widget. This event occurs when the user first moves the mouse pointer over the widget. It will not occur again until the user moves the mouse off of the widget and then back over it again. This event occurs when the user releases the mouse button on the widget. + + Note: The Click, Wheel, MouseDown, and MouseUp events provide several pieces of useful information, including :shiftKey, :ctrlKey, :altKey, and :metaKey, which are 1 if the respective key is held down and 0 otherwise. These events also provide :button, a number representing the button number that the user used to execute the event (which appears to always be 0 for wheel). diff --git a/centrallix-os/sys/js/htdrv_scrollpane.js b/centrallix-os/sys/js/htdrv_scrollpane.js index ccbf0dba5..c83dba939 100644 --- a/centrallix-os/sys/js/htdrv_scrollpane.js +++ b/centrallix-os/sys/js/htdrv_scrollpane.js @@ -9,315 +9,615 @@ // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU Lesser General Public License for more details. -function sp_init(param) + +/** ===== Config ===== **/ + +/** Whether to ignore zooming (ctrl + scroll) for scrolling events. **/ +const sp_ignore_zoom = true; + +/*** The overall scroll speed percentage modifier applied any time the scroll + *** wheel is used, in decimal representation (so 1.00 is 100%). + ***/ +const sp_scroll_mod = 1.00; + +/*** The scroll speed percentage modifier applied for fast scrolling (aka. + *** when using the scroll wheel while holding the alt key), using decimal + *** representation (so 1.00 is 100%). + *** + *** Note: Chromium-based browsers often use alt to scroll horizontally, so + *** fast scrolling may not function there. + ***/ +const sp_fast_scroll_mod = 8.00; + +/*** The scroll percentage modifier applied for inverted scrolling (aka. when + *** using the scroll wheel while holding down the shift key), using decimal + *** representation (so 1.00 is 100%). + *** + *** Set this to a positive number to disable inverted scrolling. + ***/ +const sp_inverted_scroll_mod = -1.00; + + + +/** ===== Globals ===== **/ + +/*** If a drag is in progress, stores the target image for the drag. Equals + *** undefined if no drag is in progress. + ***/ +let sp_drag_img = undefined; + +/*** If a button is pressed, stores the target image for the button so that it + *** can be reset when it is no longer pressed. Equals undefined if no button + *** is currently being pressed. + ***/ +let sp_button_img = undefined; + +/*** Stores the mainlayer that the mouse is currently over. Equals undefined if + *** the mouse is not over a scroll pane. + ***/ +let sp_target_mainlayer = undefined; + +/*** True if a click might be in progress. + *** + *** A click requires the user to generate a MouseDown event and a MouseUp + *** event in succession that are both on the scroll pane widget. + ***/ +let sp_click_in_progress = false; + + +/** Event handler to updates the thumb when the scroll pane resizes. **/ +const sp_handle_resize = ({ target: layer }) => layer.UpdateThumb(); +const sp_resize_observer = new ResizeObserver((entries) => entries.forEach(sp_handle_resize)); + +function sp_init({ layer: pane, area_name, thumb_name }) { - var l = param.layer; - var alayer=null; - var tlayer=null; - var ml; - var img; - var i; - if(cx__capabilities.Dom0NS) - { - var layers = pg_layers(l); - for(i=0;i maxBottom) maxBottom = bottom; + } + area.content_height = Math.max(0, Math.round(maxBottom - top)); + + /** Watch for changes in content height. **/ + if (cx__capabilities.Dom0IE) + { + area.runtimeStyle.clip.pane = pane; + // how to watch this in IE? + area.runtimeStyle.clip.onpropertychange = sp_WatchHeight; } else - { - alayer.clip.pane = l; - alayer.clip.watch("height",sp_WatchHeight); - } + { + area.clip.pane = pane; + area.clip.watch("height", sp_WatchHeight); + } + + /** Watch for changes in the size of the scroll pane. **/ + sp_resize_observer.observe(pane); } -/** @returns The height of the scrollpane content (including content outside the visibile area). **/ -// Replaces getClipHeight(area) + getClipTop(area) -function sp_get_content_height(area) { - return getClipHeight(area) + getClipTop(area); -} +/** ========== Getter functions ========== **/ +/** Functions to compute common values needed often in this code. **/ -/** @returns The height of visible area in the scrollpane. **/ -// Replaces getClipHeight(pane) -function sp_get_total_height(pane) { - return parseInt(window.getComputedStyle(pane).height); -} +/** @returns The height of content inside the scroll pane (even if not all of it is visible). **/ +function sp_get_content_height(area) + { + return area.content_height; + } -/** @returns The height of visible area in the scroll bar. **/ -function sp_get_sb_height(pane) { - return sp_get_total_height(pane) - (3*18); -} +/** @returns The height of visible area available to the scroll pane. **/ +function sp_get_available_height(pane) + { + return parseInt(getComputedStyle(pane).height); + } -function sp_action_scrollto(aparam) +/** @returns The height of the content outside the available visible area of the scroll pane. **/ +function sp_get_nonvisible_height(pane) { - var h = sp_get_content_height(this.area); // height of content - var ch = sp_get_total_height(this); - var d = h-ch; // height of non-visible content (max scrollable distance) - if (d < 0) d=0; - if (typeof aparam.Percent != 'undefined') - { - if (aparam.Percent < 0) aparam.Percent = 0; - else if (aparam.Percent > 100) aparam.Percent = 100; - setRelativeY(this.area, -d*aparam.Percent/100); - } - else if (typeof aparam.Offset != 'undefined') - { - if (aparam.Offset < 0) aparam.Offset = 0; - else if (aparam.Offset > d) aparam.Offset = d; - setRelativeY(this.area, -aparam.Offset); - } - else if (typeof aparam.RangeStart != 'undefined' && typeof aparam.RangeEnd != 'undefined') - { - var ny = -getRelativeY(this.area); - if (ny + ch < aparam.RangeEnd) ny = aparam.RangeEnd - ch; - if (ny > aparam.RangeStart) ny = aparam.RangeStart; - if (ny < 0) ny = 0; - if (ny > d) ny = d; - setRelativeY(this.area, -ny); - } - this.UpdateThumb(h); + return sp_get_content_height(pane.area) - sp_get_available_height(pane); } -function sp_WatchHeight(property, oldvalue, newvalue) +/** @returns The height of visible area available to the scroll bar. **/ +function sp_get_scrollbar_height(pane) { - if (cx__capabilities.Dom0IE) - { - newvalue = htr_get_watch_newval(window.event); - } - - // make sure region not offscreen now - newvalue += getClipTop(this.pane.area); - if (getRelativeY(this.pane.area) + newvalue < sp_get_total_height(this.pane)) { - setRelativeY(this.pane.area, sp_get_total_height(this.pane) - newvalue); + /** The up and down buttons and thumb are each 18px. **/ + return sp_get_available_height(pane) - (3*18); } - if (newvalue < sp_get_total_height(this.pane)) setRelativeY(this.pane.area, 0); - this.pane.UpdateThumb(newvalue); - newvalue -= getClipTop(this.pane.area); - this.bottom = this.top + newvalue; /* ns seems to unlink bottom = top + height if you modify clip obj */ - return newvalue; + +/** @returns The distance down that the scroll pane has been scrolled. **/ +function sp_get_scroll_dist(area) + { + return -getRelativeY(area); } -function sp_UpdateThumb(h) + +/*** Update the scroll pane to handle the height of its contained content + *** (aka. its child widgets) changing. + *** + *** @param property Unused + *** @param old_value The old height of the child content (unused). + *** @param new_value The new height of the child content. + ***/ +function sp_WatchHeight(property, old_value, new_value) { - /** 'this' is a spXpane **/ - if(!h) - { /** if h is supplied, it is the soon-to-be clip.height of the spXarea **/ - h=sp_get_content_height(this.area); // height of content - } - var d=h-sp_get_total_height(this); // height of non-visible content (max scrollable distance) - var v=sp_get_sb_height(this); - if(d<=0) - setRelativeY(this.thum, 18); - else - setRelativeY(this.thum, 18+v*(-getRelativeY(this.area)/d)); + const { pane } = this; + const { area } = pane; + + /** Handle legacy Internet Explorer behavior. **/ + if (cx__capabilities.Dom0IE) + new_value = htr_get_watch_newval(window.event); + + /** Update the internal content height value. **/ + area.content_height = new_value; + + /** Get the available height of the visible area. **/ + const available_height = sp_get_available_height(pane); + + /** Scroll to the top if the content is now smaller than the visible area. **/ + if (getRelativeY(area) + new_value < available_height) + setRelativeY(area, available_height - new_value); + if (new_value < available_height) setRelativeY(area, 0); + + /** Update the scroll thumb. **/ + pane.UpdateThumb(); + + return new_value; } -function do_mv() +/** Called when the ScrollTo action is used. **/ +function sp_action_ScrollTo({ Percent, Offset, RangeStart, RangeEnd }) { + const pane = this; + const available = sp_get_available_height(pane); + const nonvisible_height = sp_get_nonvisible_height(pane); // Height of non-visible content. + + /** Ignore the action if all content is visible. **/ + if (nonvisible_height <= 0) return; + + /** Calculate the new location to scroll to. **/ + const new_scroll_height = + (Offset !== undefined) ? Offset : + (Percent !== undefined) ? Math.clamp(0, Percent / 100, 1) * nonvisible_height : + (RangeStart !== undefined && RangeEnd !== undefined) ? + Math.clamp(RangeEnd - available, sp_get_scroll_dist(pane.area), RangeStart) : + 0; /* Fallback default value. */ + + /** Scroll to the new location. **/ + sp_scroll_to(pane, new_scroll_height); + } + +/** Recalculate and update the location of the scroll thumb. **/ +function sp_update_thumb() + { + const pane = this; + const { area, thumb } = pane; - var ti=sp_target_img; - /** not sure why, but it's getting called with a null sp_target_img sometimes... **/ - if(!ti) + /** Get the height of nonvisible content. **/ + const nonvisible_height = sp_get_nonvisible_height(pane); + + /** Handle the case where all content is visible. **/ + if (nonvisible_height <= 0) { + /** All we need to do is to move the scroll thumb to the top. **/ + setRelativeY(thumb, 18); return; } - var h=sp_get_content_height(ti.area); // height of content - var d=h-sp_get_total_height(ti.pane); // height of non-visible content (max scrollable distance) - var incr=sp_mv_incr; - if(d<0) - incr=0; - if (ti.kind=='sp') + + /** Calculate where the scroll thumb should be based on the scroll progress. **/ + let scroll_dist = sp_get_scroll_dist(area); + if (scroll_dist > nonvisible_height) { - var scrolled = -getRelativeY(ti.area); // distance scrolled already - if(incr > 0 && scrolled+incr>d) - incr=d-scrolled; + /** Scroll down to fill the new space at the bottom of the scroll pane. **/ + setRelativeY(area, -nonvisible_height); + scroll_dist = nonvisible_height; + } + const progress = scroll_dist / nonvisible_height; + const progress_scaled = 18 + sp_get_scrollbar_height(pane) * progress; + + /** Set the scroll thumb to the calculated location. **/ + setRelativeY(thumb, progress_scaled); + } - /** if we've scrolled down less than we want to go up, go up the distance we went down **/ - if(incr < 0 && scrolled<-incr) - incr=-scrolled; +/*** Scroll the scroll pane to the specified `scroll_height`. + *** + *** @param pane The affected scroll pane DOM node. + *** @param scroll_height The new height, in pixels, that the content should + *** be scrolled to as a result of this scroll. + ***/ +function sp_scroll_to(pane, scroll_height) + { + /** Ignore undefined target pane. **/ + if (!pane) return; + + /** Don't scroll if there's no content to scroll. **/ + const nonvisible_height = sp_get_nonvisible_height(pane); + if (nonvisible_height < 0) return; + + /** Save the current scroll amount for later. **/ + const scroll_height_old = sp_get_scroll_dist(pane.area); + + /** Clamp the scroll height within the bounds of the scroll bar. **/ + const scroll_height_new = Math.clamp(0, scroll_height, nonvisible_height); + + /** Update the content. **/ + setRelativeY(pane.area, -scroll_height_new); + pane.UpdateThumb(); + + /** Construct the param for the centrallix 'Scroll' event. **/ + const percent_old = (scroll_height_old / nonvisible_height) * 100; + const percent_new = (scroll_height_new / nonvisible_height) * 100; + const param = { Percent: percent_new, Change: percent_new - percent_old }; + + /** Schedule the scroll event to allow the page to repaint first. **/ + setTimeout(() => cn_activate(pane, 'Scroll', param), 0); + } - /*var layers = pg_layers(ti.pane); - for(var i=0;i getPageY(ti.pane)+18+v) new_y=getPageY(ti.pane)+18+v; - if (new_y < getPageY(ti.pane)+18) new_y=getPageY(ti.pane)+18; - setPageY(ti.thum,new_y); - var h=sp_get_content_height(ti.area); - var d=h-sp_get_total_height(ti.pane); - if (d<0) d=0; - var yincr = (((getRelativeY(ti.thum)-18)/v)*-d) - getRelativeY(ti.area); - moveBy(ti.area, 0, yincr); - return EVENT_HALT | EVENT_PREVENT_DEFAULT_ACTION; - } + /** Trigger Centrallix events. **/ + const pane = sp_get_pane(e); + if (pane) cn_activate(pane, 'MouseMove'); + + /** Monitor events on other DOM nodes to detect MouseOut. **/ + if (!pane && sp_target_mainlayer) + { + /** Mouse out has occurred, ending the mouse over. **/ + cn_activate(sp_target_mainlayer, 'MouseOut'); + sp_target_mainlayer = undefined; + } + + /** Check if a drag is in progress (aka. the drag target exists and is a scroll thumb). **/ + const target_img = sp_drag_img; + if (target_img && target_img.kind === 'sp' && target_img.name === 't') + { + const { pane } = target_img; + + /** Get drag_dist: the distance that the scroll bar should move. **/ + const page_y = getPageY(target_img.thumb); + const drag_dist = e.pageY - page_y; + + /** Scale drag_dist to the distance that the content should move. **/ + const scrollbar_height = sp_get_scrollbar_height(pane); + const nonvisible_height = sp_get_nonvisible_height(pane); + const content_drag_dist = (drag_dist / scrollbar_height) * nonvisible_height; + + /** Scroll the content by the required amount to reach the new mouse location. **/ + sp_scroll(target_img.pane, content_drag_dist); + + /** Event handled. **/ + return EVENT_HALT | EVENT_PREVENT_DEFAULT_ACTION; + } + + /** Continue the event. **/ return EVENT_CONTINUE | EVENT_ALLOW_DEFAULT_ACTION; } +/*** Handles mouse up events anywhere on the page. + *** + *** @param e The event that has occurred. + *** @returns An event result (see ht_render.js). + ***/ function sp_mouseup(e) { - if (sp_mv_timeout != null) - { - clearTimeout(sp_mv_timeout); - sp_mv_timeout = null; - sp_mv_incr = 0; - } - if (sp_target_img != null) - { - if (sp_target_img.name != 'b') - pg_set(sp_target_img,'src',htutil_subst_last(sp_target_img.src,"b.gif")); - sp_target_img = null; - } - if (e.kind == 'sp') cn_activate(e.mainlayer, 'MouseUp'); + /** Trigger Centrallix events. **/ + if (e.kind === 'sp') + { + const params = sp_get_event_params(e); + cn_activate(e.mainlayer, 'MouseUp', params); + if (sp_click_in_progress) + cn_activate(e.mainlayer, 'Click', params); + } + + /** A click is no longer in progress. **/ + sp_click_in_progress = false; + + /** Check for an active drag. **/ + if (sp_drag_img) + { + /** End the drag. **/ + sp_drag_img = undefined; + } + + /** Check for a pressed button. **/ + if (sp_button_img) + { + /** Reset the pressed button. **/ + pg_set(sp_button_img, 'src', htutil_subst_last(sp_button_img.src, "b.gif")); + sp_button_img = undefined; + } + + /** Continue the event. **/ return EVENT_CONTINUE | EVENT_ALLOW_DEFAULT_ACTION; } +/*** Handles mouse over events anywhere on the page. + *** + *** @param e The event that has occurred. + *** @returns An event result (see ht_render.js). + ***/ function sp_mouseover(e) { - if (e.kind == 'sp') - { - if (!sp_cur_mainlayer) - { - cn_activate(e.mainlayer, 'MouseOver'); - sp_cur_mainlayer = e.mainlayer; - } - } + /** Check for mouse over on an sp element. **/ + if (sp_target_mainlayer && e.kind === 'sp') + { + /** Begin a mouse over. **/ + cn_activate(e.mainlayer, 'MouseOver'); + sp_target_mainlayer = e.mainlayer; + } + + /** Continue the event. **/ return EVENT_CONTINUE | EVENT_ALLOW_DEFAULT_ACTION; } -// Load indication +/** Indicate loading is complete. **/ if (window.pg_scripts) pg_scripts['htdrv_scrollpane.js'] = true; diff --git a/centrallix/htmlgen/htdrv_scrollpane.c b/centrallix/htmlgen/htdrv_scrollpane.c index e5c061d16..2a4b36154 100644 --- a/centrallix/htmlgen/htdrv_scrollpane.c +++ b/centrallix/htmlgen/htdrv_scrollpane.c @@ -1,15 +1,3 @@ -#include -#include -#include -#include -#include "ht_render.h" -#include "obj.h" -#include "cxlib/mtask.h" -#include "cxlib/xarray.h" -#include "cxlib/xhash.h" -#include "cxlib/mtsession.h" -#include "cxlib/strtcpy.h" - /************************************************************************/ /* Centrallix Application Server System */ /* Centrallix Core */ @@ -42,6 +30,19 @@ /* layer. Can contain most objects, except for framesets. */ /************************************************************************/ +#include +#include +#include +#include + +#include "cxlib/mtask.h" +#include "cxlib/mtsession.h" +#include "cxlib/strtcpy.h" +#include "cxlib/xarray.h" +#include "cxlib/xhash.h" +#include "ht_render.h" +#include "obj.h" + /** globals **/ static struct @@ -57,267 +58,351 @@ int htspaneRender(pHtSession s, pWgtrNode tree, int z) { char* ptr; - char name[64]; - int x,y,w,h; - int id, i; - int visible = 1; - char bcolor[64] = ""; - char bimage[64] = ""; - - if(!s->Capabilities.Dom0NS && !s->Capabilities.Dom0IE &&!(s->Capabilities.Dom1HTML && s->Capabilities.Dom2CSS)) + + if (!(s->Capabilities.Dom1HTML && s->Capabilities.Dom2CSS) && !s->Capabilities.Dom0NS && !s->Capabilities.Dom0IE) { - mssError(1,"HTSPANE","Netscape DOM or W3C DOM1 HTML and DOM2 CSS support required"); + mssError(1, "HTSPANE", "Unsupported browser: W3C DOM1 HTML and DOM2 CSS or IE DOM or Netscape DOM required."); return -1; } - - /** Get an id for this. **/ - id = (HTSPANE.idcnt++); - - /** Get x,y,w,h of this object **/ - if (wgtrGetPropertyValue(tree,"x",DATA_T_INTEGER,POD(&x)) != 0) + + /** Get an id for this scrollpane. **/ + const int id = (HTSPANE.idcnt++); + + /** Get name. **/ + char name[64]; + if (wgtrGetPropertyValue(tree, "name", DATA_T_STRING, POD(&ptr)) != 0) { - mssError(1,"HTSPANE","ScrollPane widget must have an 'x' property"); + mssError(1, "HTSPANE", "widget/scrollpane must have a 'name' property."); return -1; } - if (wgtrGetPropertyValue(tree,"y",DATA_T_INTEGER,POD(&y)) != 0) + strtcpy(name, ptr, sizeof(name)); + + /** Get x, y, w, & h. **/ + int x, y, w, h; + if (wgtrGetPropertyValue(tree, "x", DATA_T_INTEGER, POD(&x)) != 0) { - mssError(1,"HTSPANE","ScrollPane widget must have a 'y' property"); + mssError(1, "HTSPANE", "widget/scrollpane must have an 'x' property."); return -1; } - if (wgtrGetPropertyValue(tree,"width",DATA_T_INTEGER,POD(&w)) != 0) + if (wgtrGetPropertyValue(tree, "y", DATA_T_INTEGER, POD(&y)) != 0) { - mssError(1,"HTSPANE","ScrollPane widget must have a 'width' property"); + mssError(1, "HTSPANE", "widget/scrollpane must have a 'y' property."); return -1; } - if (wgtrGetPropertyValue(tree,"height",DATA_T_INTEGER,POD(&h)) != 0) + if (wgtrGetPropertyValue(tree, "width", DATA_T_INTEGER, POD(&w)) != 0) { - mssError(1,"HTSPANE","ScrollPane widget must have a 'height' property"); + mssError(1, "HTSPANE", "widget/scrollpane must have a 'width' property."); return -1; } - - /** Get name **/ - if (wgtrGetPropertyValue(tree,"name",DATA_T_STRING,POD(&ptr)) != 0) return -1; - strtcpy(name,ptr,sizeof(name)); - - /** Check background color **/ - if (wgtrGetPropertyValue(tree,"bgcolor",DATA_T_STRING,POD(&ptr)) == 0) + if (wgtrGetPropertyValue(tree, "height", DATA_T_INTEGER, POD(&h)) != 0) { - strtcpy(bcolor,ptr,sizeof(bcolor)); + mssError(1, "HTSPANE", "widget/scrollpane must have a 'height' property."); + return -1; } - if (wgtrGetPropertyValue(tree,"background",DATA_T_STRING,POD(&ptr)) == 0) + + /** Get the background color or image. **/ + char background_color[64] = ""; + if (wgtrGetPropertyValue(tree, "bgcolor", DATA_T_STRING,POD(&ptr)) == 0) { - strtcpy(bimage,ptr,sizeof(bimage)); + strtcpy(background_color, ptr, sizeof(background_color)); } - - /** Marked not visible? **/ - if (wgtrGetPropertyValue(tree,"visible",DATA_T_STRING,POD(&ptr)) == 0) + char background_image[64] = ""; + if (wgtrGetPropertyValue(tree, "background", DATA_T_STRING, POD(&ptr)) == 0) { - if (!strcmp(ptr,"false")) visible = 0; + strtcpy(background_image, ptr, sizeof(background_image)); } - - /** Ok, write the style header items. **/ - if (s->Capabilities.Dom0NS) + + /** Get visibility. **/ + int visible = 1; + if (wgtrGetPropertyValue(tree, "visible", DATA_T_STRING, POD(&ptr)) == 0) { - htrAddStylesheetItem_va(s, - "\t#sp%POSpane { " - "POSITION:absolute; " - "VISIBILITY:%STR; " - "LEFT:"ht_flex_format"; " - "TOP:"ht_flex_format"; " - "WIDTH:"ht_flex_format"; " - "HEIGHT:"ht_flex_format"; " - "OVERFLOW: clip; " - "Z-INDEX:%POS; " - "}\n", - id, - (visible) ? "inherit" : "hidden", - ht_flex(x, ht_get_total_w(tree), ht_get_fl_x(tree)), - ht_flex(y, ht_get_total_h(tree), ht_get_fl_y(tree)), - ht_flex(w, ht_get_total_w(tree), ht_get_fl_w(tree)), - ht_flex(h, ht_get_total_h(tree), ht_get_fl_h(tree)), - z - ); - htrAddStylesheetItem_va(s, - "\t#sp%POSarea { " - "POSITION:absolute; " - "VISIBILITY:inherit; " - "LEFT:0px; " - "TOP:0px; " - "WIDTH:"ht_flex_format"; " - "Z-INDEX:%POS; " - "}\n", - id, - ht_flex(w - 18, ht_get_total_w(tree), 1.0), - z + 1 - ); - htrAddStylesheetItem_va(s, - "\t#sp%POSthum { " - "POSITION:absolute; " - "VISIBILITY:inherit; " - "LEFT:"ht_flex_format"; " - "TOP:18px; " - "WIDTH:18px; " - "Z-INDEX:%POS; " - "}\n", - id, - ht_flex(w - 18, tree->width, 1.0), - z + 1 - ); + if (strcmp(ptr, "false") == 0) visible = 0; } - - /** Write globals for internal use **/ - htrAddScriptGlobal(s, "sp_target_img", "null", 0); - htrAddScriptGlobal(s, "sp_click_x","0",0); - htrAddScriptGlobal(s, "sp_click_y","0",0); - htrAddScriptGlobal(s, "sp_thum_y","0",0); - htrAddScriptGlobal(s, "sp_mv_timeout","null",0); - htrAddScriptGlobal(s, "sp_mv_incr","0",0); - htrAddScriptGlobal(s, "sp_cur_mainlayer","null",0); - - /** DOM Linkages **/ - htrAddWgtrObjLinkage_va(s, tree, "sp%POSpane",id); + + /** DOM Linkages. **/ htrAddWgtrCtrLinkage_va(s, tree, "htr_subel(_obj, \"sp%POSarea\")",id); - + htrAddWgtrObjLinkage_va(s, tree, "sp%POSpane",id); + + /** Include scrollpane script and its dependencies. **/ htrAddScriptInclude(s, "/sys/js/htdrv_scrollpane.js", 0); htrAddScriptInclude(s, "/sys/js/ht_utils_string.js", 0); - - htrAddScriptInit_va(s," sp_init({layer:wgtrGetNodeRef(ns,\"%STR&SYM\"), aname:\"sp%POSarea\", tname:\"sp%POSthum\"});\n", name,id,id); - - /** HTML body
elements for the layers. **/ - if(s->Capabilities.Dom0NS) + + /** Init the JS scripts. **/ + htrAddScriptInit_va(s, + "\tsp_init({" + "layer: wgtrGetNodeRef(ns, '%STR&SYM'), " + "area_name: 'sp%POSarea', " + "thumb_name: 'sp%POSthumb', " + "});\n", + name, + id, + id + ); + + /** Write html and styles. **/ + if (s->Capabilities.Dom1HTML) { - htrAddBodyItem_va(s,"
", id, *bcolor, bcolor, *bimage, bimage, w); - htrAddBodyItem(s, "
"); - htrAddBodyItem_va(s,"",h-36); - htrAddBodyItem(s, "
\n"); - htrAddBodyItem_va(s,"
\n
",id,id,w-2,h-2); - } - else if(s->Capabilities.Dom1HTML) - { - //htrAddStylesheetItem_va(s,"\t#sp%dpane { POSITION:absolute; VISIBILITY:%s; LEFT:%dpx; TOP:%dpx; WIDTH:%dpx; HEIGHT:%dpx; clip:rect(0px,%dpx,%dpx,0px); Z-INDEX:%d; }\n",id,visible?"inherit":"hidden",x,y,w,h,w,h, z); - //htrAddStylesheetItem_va(s,"\t#sp%darea { HEIGHT: %dpx; WIDTH:%dpx; }\n",id, h, w-18); - //htrAddStylesheetItem_va(s,"\t#sp%dthum { POSITION:absolute; VISIBILITY:inherit; LEFT:%dpx; TOP:18px; WIDTH:18px; Z-INDEX:%dpx; }\n",id,w-18,z+1); + /** Write the scrollpane. **/ htrAddBodyItem_va(s, - "
\n", id, (visible) ? "inherit" : "hidden", - ht_flex(x, ht_get_total_w(tree), ht_get_fl_x(tree)), - ht_flex(y, ht_get_total_h(tree), ht_get_fl_y(tree)), - ht_flex(w, ht_get_total_w(tree), ht_get_fl_w(tree)), - ht_flex(h, ht_get_total_h(tree), ht_get_fl_h(tree)), + ht_flex_x(x, tree), + ht_flex_y(y, tree), + ht_flex_w(w, tree), + ht_flex_h(h, tree), z ); - htrAddBodyItem_va(s,"", id); - htrAddBodyItem_va(s,"", id); - htrAddBodyItem_va(s,"", id); + + /** Write shared CSS for the following UI elements. **/ htrAddStylesheetItem_va(s, - "\t#sp%POSup { " - "POSITION:absolute; " - "LEFT:"ht_flex_format"; " - "TOP:0px; " + "\t.sp%POS_scroll { " + "position:absolute; " + "left:"ht_flex_format"; " "}\n", id, ht_flex(w - 18, tree->width, 1.0) ); - htrAddStylesheetItem_va(s, - "\t#sp%POSbar { " - "POSITION:absolute; " - "LEFT:"ht_flex_format"; " - "TOP:18px; " - "WIDTH:18px; " - "HEIGHT:"ht_flex_format"; " - "}\n", + + /** Write the up button. **/ + htrAddBodyItem_va(s, + "", + id, + id + ); + + /** Write the scroll bar. **/ + htrAddBodyItem_va(s, + "", + id, id, - ht_flex(w - 18, tree->width, 1.0), ht_flex(h - 36, tree->height, 1.0) ); - htrAddStylesheetItem_va(s, - "\t#sp%POSdown { " - "POSITION:absolute; " - "LEFT:"ht_flex_format"; " - "TOP:"ht_flex_format"; " - "}\n", + + /** Write the down button. **/ + htrAddBodyItem_va(s, + "", + id, id, - ht_flex(w - 18, tree->width, 1.0), ht_flex(h - 18, tree->height, 1.0) ); + + /** Write the scroll thumb. **/ htrAddBodyItem_va(s, - "
" - "" - "
\n", + "" + "
\n", + id, id, - ht_flex(w - 18, tree->width, 1.0), z + 1 ); + + /** Write the scroll area. **/ htrAddBodyItem_va(s, - "
", id, - ht_flex(w - 18, ht_get_total_w(tree), 1.0), - ht_flex(h, ht_get_total_h(tree), 1.0), + ht_flex(w - 18, ht_get_parent_w(tree), 1.0), + ht_flex(h, ht_get_parent_h(tree), 1.0), z + 1 ); } + else if (s->Capabilities.Dom0NS) + { + /** Write CSS for everything. **/ + htrAddStylesheetItem_va(s, + "\t#sp%POSpane { " + "position:absolute; " + "visibility:%STR; " + "left:"ht_flex_format"; " + "top:"ht_flex_format"; " + "width:"ht_flex_format"; " + "height:"ht_flex_format"; " + "overflow:clip; " + "z-index:%POS; " + "}\n", + id, + (visible) ? "inherit" : "hidden", + ht_flex_x(x, tree), + ht_flex_y(y, tree), + ht_flex_w(w, tree), + ht_flex_h(h, tree), + z + ); + htrAddStylesheetItem_va(s, + "\t#sp%POSarea { " + "position:absolute; " + "visibility:inherit; " + "left:0px; " + "top:0px; " + "width:"ht_flex_format"; " + "z-index:%POS; " + "}\n", + id, + ht_flex(w - 18, ht_get_parent_w(tree), 1.0), + z + 1 + ); + htrAddStylesheetItem_va(s, + "\t#sp%POSthumb { " + "position:absolute; " + "visibility:inherit; " + "left:"ht_flex_format"; " + "top:18px; " + "width:18px; " + "z-index:%POS; " + "}\n", + id, + ht_flex(w - 18, tree->width, 1.0), + z + 1 + ); + + /** Write the scrollpane. **/ + htrAddBodyItem_va(s, + "
" + "", + id, + *background_color, background_color, + *background_image, background_image, + w + ); + + htrAddBodyItem_va(s, + /** Write the up button. **/ + "" + + /** Write the scroll bar. **/ + "" + + /** Write the down button. **/ + "" + + /** Close the scrollpane table (see above). **/ + "
" + "" + "
" + "" + "
" + "" + "
\n", + h - 36 + ); + + /** Write the scroll thumb. **/ + htrAddBodyItem_va(s, + "
" + "" + "
\n", + id + ); + + /** Write the scroll area. **/ + htrAddBodyItem_va(s, + "
" + "
", + id, + w - 2, + h - 2 + ); + } else { - mssError(1,"HTSPNE","Browser not supported"); + mssError(1, "HTSPNE", "Browser not supported!!"); } - - /** Add the event handling scripts **/ - htrAddEventHandlerFunction(s, "document","MOUSEDOWN","sp","sp_mousedown"); - htrAddEventHandlerFunction(s, "document","MOUSEMOVE","sp","sp_mousemove"); - htrAddEventHandlerFunction(s, "document","MOUSEUP","sp","sp_mouseup"); - htrAddEventHandlerFunction(s, "document", "MOUSEOVER", "sp","sp_mouseover"); - - /** Do subwidgets **/ - for (i=0;iChildren));i++) - htrRenderWidget(s, xaGetItem(&(tree->Children), i), z+2); - - /** Finish off the last
**/ - if(s->Capabilities.Dom0NS) + + /** Render children/subwidgets. **/ + for (int i = 0; i < xaCount(&(tree->Children)); i++) + htrRenderWidget(s, xaGetItem(&(tree->Children), i), z + 2); + + /** Close the final
s. **/ + if (s->Capabilities.Dom1HTML) { - htrAddBodyItem(s,"
\n"); + htrAddBodyItem(s,"
\n"); } - else if(s->Capabilities.Dom1HTML) + else if (s->Capabilities.Dom0NS) { - htrAddBodyItem(s,"
\n"); + htrAddBodyItem(s,"
\n"); } else { - mssError(1,"HTSPNE","browser not supported"); + mssError(1, "HTSPNE", "Browser not supported!!"); } - + + /** Add the event handling scripts **/ + htrAddEventHandlerFunction(s, "document", "MOUSEDOWN", "sp", "sp_mousedown"); + htrAddEventHandlerFunction(s, "document", "MOUSEMOVE", "sp", "sp_mousemove"); + htrAddEventHandlerFunction(s, "document", "MOUSEUP", "sp", "sp_mouseup"); + htrAddEventHandlerFunction(s, "document", "MOUSEOVER", "sp", "sp_mouseover"); + htrAddEventHandlerFunction(s, "document", "WHEEL", "sp", "sp_wheel"); + return 0; } @@ -328,29 +413,31 @@ int htspaneInitialize() { pHtDriver drv; - - /** Allocate the driver **/ + + /** Allocate the driver **/ drv = htrAllocDriver(); if (!drv) return -1; - + /** Fill in the structure. **/ - strcpy(drv->Name,"HTML ScrollPane Widget Driver"); + strcpy(drv->Name,"HTML Widget/scrollpane Driver"); strcpy(drv->WidgetName,"scrollpane"); drv->Render = htspaneRender; - + /** Events **/ - htrAddEvent(drv,"Click"); - htrAddEvent(drv,"MouseUp"); - htrAddEvent(drv,"MouseDown"); - htrAddEvent(drv,"MouseOver"); - htrAddEvent(drv,"MouseOut"); - htrAddEvent(drv,"MouseMove"); - + htrAddEvent(drv, "Scroll"); + htrAddEvent(drv, "Click"); + htrAddEvent(drv, "Wheel"); + htrAddEvent(drv, "MouseUp"); + htrAddEvent(drv, "MouseDown"); + htrAddEvent(drv, "MouseOver"); + htrAddEvent(drv, "MouseOut"); + htrAddEvent(drv, "MouseMove"); + /** Register. **/ htrRegisterDriver(drv); - + htrAddSupport(drv, "dhtml"); HTSPANE.idcnt = 0; - + return 0; } From c079d6e4580ffce867311684ad346a4c37389d81 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Mon, 9 Feb 2026 11:22:43 -0700 Subject: [PATCH 080/275] Make the button widget responsive. Replace JS animation with a faster, responsive CSS implementation. Remove unnecessary clip rectangles. Fix style issues. --- centrallix-os/sys/js/htdrv_button.js | 3 -- centrallix/htmlgen/htdrv_button.c | 70 ++++++++++++++-------------- 2 files changed, 34 insertions(+), 39 deletions(-) diff --git a/centrallix-os/sys/js/htdrv_button.js b/centrallix-os/sys/js/htdrv_button.js index 6be26b436..2efb27773 100644 --- a/centrallix-os/sys/js/htdrv_button.js +++ b/centrallix-os/sys/js/htdrv_button.js @@ -262,7 +262,6 @@ function gb_setmode(layer,mode) pg_set(layer.img, 'src', newsrc); if(type=='image' || type=='textoverimage') return; } - moveTo(layer,layer.orig_x,layer.orig_y); if(cx__capabilities.Dom2CSS) { layer.style.setProperty('border-width','0px',null); @@ -294,7 +293,6 @@ function gb_setmode(layer,mode) pg_set(layer.img, 'src', newsrc); if(type=='image' || type=='textoverimage' ) return; } - moveTo(layer,layer.orig_x,layer.orig_y); if(cx__capabilities.Dom2CSS) { layer.style.setProperty('border-width','1px',null); @@ -337,7 +335,6 @@ function gb_setmode(layer,mode) pg_set(layer.img, 'src', newsrc); if(type=='image' || type=='textoverimage') return; } - moveTo(layer,layer.orig_x+1,layer.orig_y+1); if(cx__capabilities.Dom2CSS) { layer.style.setProperty('border-width','1px',null); diff --git a/centrallix/htmlgen/htdrv_button.c b/centrallix/htmlgen/htdrv_button.c index 1779b54be..3e3f7c577 100644 --- a/centrallix/htmlgen/htdrv_button.c +++ b/centrallix/htmlgen/htdrv_button.c @@ -152,12 +152,12 @@ htbtnRender(pHtSession s, pWgtrNode tree, int z) { htrAddStylesheetItem_va(s, "\t#gb%POSpane { " - "POSITION:absolute; " - "VISIBILITY:inherit; " - "LEFT:"ht_flex_format"; " - "TOP:"ht_flex_format"; " - "WIDTH:"ht_flex_format"; " - "Z-INDEX:%POS; " + "position:absolute; " + "visibility:inherit; " + "left:"ht_flex_format"; " + "top:"ht_flex_format"; " + "width:"ht_flex_format"; " + "z-index:%POS; " "}\n", id, ht_flex(x, tree->Parent->width, ht_get_fl_x(tree)), @@ -165,6 +165,14 @@ htbtnRender(pHtSession s, pWgtrNode tree, int z) ht_flex(w, tree->Parent->width, ht_get_fl_w(tree)), z ); + + /** Button click animation. **/ + if (is_enabled) { + htrAddStylesheetItem_va(s, + "\t#tb%POSpane:active { transform: translate(1px, 1px); }\n", + id + ); + } htrAddScriptGlobal(s, "gb_cur_img", "null", 0); htrAddScriptGlobal(s, "gb_current", "null", 0); @@ -208,12 +216,12 @@ htbtnRender(pHtSession s, pWgtrNode tree, int z) { htrAddStylesheetItem_va(s, "\t#gb%POSpane2 { " - "POSITION:absolute; " - "VISIBILITY:inherit; " - "LEFT:%POS; " - "TOP:%POS; " - "WIDTH:"ht_flex_format"; " - "Z-INDEX:%POS; " + "position:absolute; " + "visibility:inherit; " + "left:%POS; " + "top:%POS; " + "width:"ht_flex_format"; " + "z-index:%POS; " "}\n", id, 0, @@ -337,26 +345,18 @@ htbtnRender(pHtSession s, pWgtrNode tree, int z) { htrAddStylesheetItem_va(s, "\t#gb%POSpane { " - "POSITION:absolute; " - "VISIBILITY:inherit; " - "OVERFLOW:hidden; " - "LEFT:"ht_flex_format"; " - "TOP:"ht_flex_format"; " - "WIDTH:"ht_flex_format"; " - "CLIP:rect(" - "0, " - ht_flex_format", " - ht_flex_format", " - "0" - "); " - "Z-INDEX:%POS; " + "position:absolute; " + "visibility:inherit; " + "overflow:hidden; " + "left:"ht_flex_format"; " + "top:"ht_flex_format"; " + "width:"ht_flex_format"; " + "z-index:%POS; " "}\n", id, ht_flex(x, tree->Parent->width, ht_get_fl_x(tree)), ht_flex(y, tree->Parent->height, ht_get_fl_y(tree)), ht_flex(w-1-2*box_offset, tree->Parent->width, ht_get_fl_w(tree)), - ht_flex(w-1-2*box_offset+2*clip_offset, tree->Parent->width, ht_get_fl_w(tree)), - ht_flex(h-1-2*box_offset+2*clip_offset, tree->Parent->height, ht_get_fl_h(tree)), z ); htrAddStylesheetItem_va(s,"\t#gb%POSpane2, #gb%POSpane3 { height: "ht_flex_format";}\n",id,id,ht_flex(h-3,tree->Parent->height,ht_get_fl_h(tree))); @@ -366,20 +366,18 @@ htbtnRender(pHtSession s, pWgtrNode tree, int z) { htrAddStylesheetItem_va(s, "\t#gb%POSpane { " - "POSITION:absolute; " - "VISIBILITY:inherit; " - "OVERFLOW:hidden; " - "LEFT:"ht_flex_format"; " - "TOP:"ht_flex_format"; " - "WIDTH:"ht_flex_format"; " - "CLIP:rect(0, "ht_flex_format", auto, 0);" - "Z-INDEX:%POS; " + "position:absolute; " + "visibility:inherit; " + "overflow:hidden; " + "left:"ht_flex_format"; " + "top:"ht_flex_format"; " + "width:"ht_flex_format"; " + "z-index:%POS; " "}\n", id, ht_flex(x, tree->Parent->width, ht_get_fl_x(tree)), ht_flex(y, tree->Parent->height, ht_get_fl_y(tree)), ht_flex(w-1-2*box_offset, tree->Parent->width, ht_get_fl_w(tree)), - ht_flex(w-1-2*box_offset+2*clip_offset, tree->Parent->width, ht_get_fl_w(tree)), z ); } From 00a75594196c43c7ff702563b285e0f16530e3b5 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Mon, 9 Feb 2026 11:44:29 -0700 Subject: [PATCH 081/275] Make the chart widget responsive. Update page generation to produce responsive HTML and CSS. Add JS attributes to tell ChartJS how to resize the widget. --- centrallix-os/sys/js/htdrv_chart.js | 6 +++ centrallix/htmlgen/htdrv_chart.c | 68 ++++++++++++++++++++--------- 2 files changed, 53 insertions(+), 21 deletions(-) diff --git a/centrallix-os/sys/js/htdrv_chart.js b/centrallix-os/sys/js/htdrv_chart.js index 3b6d0abe3..87d7cb9ef 100755 --- a/centrallix-os/sys/js/htdrv_chart.js +++ b/centrallix-os/sys/js/htdrv_chart.js @@ -387,6 +387,12 @@ function cht_init(params) { this.update_soon = false; //see cht_object_available chart_wgt.ChartJsInit(); + + // Set ChartJS options. + const { options } = chart_wgt.chart; + options.responsive = false; + options.maintainAspectRatio = false; + options.resizeDelay = 10; } // Load indication diff --git a/centrallix/htmlgen/htdrv_chart.c b/centrallix/htmlgen/htdrv_chart.c index 073627a20..d421643cf 100644 --- a/centrallix/htmlgen/htdrv_chart.c +++ b/centrallix/htmlgen/htdrv_chart.c @@ -323,27 +323,54 @@ htchtScriptInclude(pHtSession session) void htchtGenHTML(pHtSession session, pWgtrNode tree, int z) { - char buf[32]; - - htchtGetCanvasId(tree, buf, sizeof(buf)); - - htrAddBodyItem_va(session,"
\n", - buf, - buf, - htchtGetWidth(tree), - htchtGetHeight(tree) + /** Get id. **/ + char id[32]; + htchtGetCanvasId(tree, id, sizeof(id)); + + /** Get layout data. **/ + const int x = htchtGetX(tree); + const int y = htchtGetY(tree); + const int w = htchtGetWidth(tree); + const int h = htchtGetHeight(tree); + + /** Write style rules for the container div. **/ + htrAddStylesheetItem_va(session, + "\t#%STR&SYMdiv { " + "position:absolute; " + "visibility:inherit; " + "left:"ht_flex_format"; " + "top:"ht_flex_format"; " + "width:"ht_flex_format"; " + "height:"ht_flex_format"; " + "z-index:%POS; " + "}\n", + id, + ht_flex_x(x, tree), + ht_flex_y(y, tree), + ht_flex_w(w, tree), + ht_flex_h(h, tree), + z ); - - htrAddBodyItem(session,"

CHART HERE

\n"); - htrAddBodyItem(session,"
\n"); - - htrAddStylesheetItem_va(session, "\t#%STR&SYMdiv { POSITION:absolute; VISIBILITY:inherit; LEFT:%INTpx; TOP:%INTpx; WIDTH:%POSpx; HEIGHT:%POSpx; Z-INDEX:%POS; } \n", - buf, - htchtGetX(tree), - htchtGetY(tree), - htchtGetWidth(tree), - htchtGetHeight(tree), - z + + /** Write the canvas HTML. **/ + /*** Israel: Dark magic and sorcery beyond my comprehension somehow + *** cause "CHART HERE" to render as the label for the chart. + ***/ + htrAddBodyItem_va(session, + "
" + "" + "

CHART HERE

" + "" + "
", + id, + id, + w, + h ); } @@ -405,4 +432,3 @@ htchtInitialize() return 0; } - From 30df51aca1358f8dbd4c121162b515e2d3bb78aa Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Mon, 9 Feb 2026 11:46:20 -0700 Subject: [PATCH 082/275] Make the HTML widget responsive. Improve page generation methodology, leading to responsive pages. Improve C code formatting. --- centrallix-os/sys/js/htdrv_html.js | 2 + centrallix/htmlgen/htdrv_html.c | 119 ++++++++++++++++------------- 2 files changed, 68 insertions(+), 53 deletions(-) diff --git a/centrallix-os/sys/js/htdrv_html.js b/centrallix-os/sys/js/htdrv_html.js index 3289d0b61..1300a79a3 100644 --- a/centrallix-os/sys/js/htdrv_html.js +++ b/centrallix-os/sys/js/htdrv_html.js @@ -300,6 +300,8 @@ function ht_init(param) //l.watch('source', ht_sourcechanged); pg_resize(l.parentLayer); + disableClippingCSS(l.parentLayer); + return l; } diff --git a/centrallix/htmlgen/htdrv_html.c b/centrallix/htmlgen/htdrv_html.c index 0b41d7b35..509438673 100644 --- a/centrallix/htmlgen/htdrv_html.c +++ b/centrallix/htmlgen/htdrv_html.c @@ -101,76 +101,52 @@ hthtmlRender(pHtSession s, pWgtrNode tree, int z) { /** Only give x and y if supplied. **/ if (x < 0 || y < 0) - { - htrAddStylesheetItem_va(s,"\t#ht%POSpane { POSITION:relative; VISIBILITY:inherit; WIDTH:"ht_flex_format"; Z-INDEX:%POS; }\n",id,ht_flex(w,ht_get_total_w(tree),ht_get_fl_w(tree)),z); - htrAddStylesheetItem_va(s,"\t#ht%POSpane2 { POSITION:relative; VISIBILITY:hidden; WIDTH:"ht_flex_format"; Z-INDEX:%POS; }\n",id,ht_flex(w,ht_get_total_w(tree),ht_get_fl_w(tree)),z); - htrAddStylesheetItem_va(s,"\t#ht%POSfader { POSITION:relative; VISIBILITY:hidden; WIDTH:"ht_flex_format"; Z-INDEX:%POS; }\n",id,ht_flex(w,ht_get_total_w(tree),ht_get_fl_w(tree)),z+1); - } - else { htrAddStylesheetItem_va(s, - "\t#ht%POSpane { " - "POSITION:absolute; " + "\t#ht%POSpane, #ht%POSpane, #ht%POSfader { " + "POSITION:relative; " "VISIBILITY:inherit; " - "LEFT:"ht_flex_format"; " - "TOP:"ht_flex_format"; " "WIDTH:"ht_flex_format"; " "Z-INDEX:%POS; " "}\n", - id, - ht_flex(x, ht_get_total_w(tree), ht_get_fl_x(tree)), - ht_flex(y, ht_get_total_h(tree), ht_get_fl_y(tree)), - ht_flex(w, ht_get_total_w(tree), ht_get_fl_w(tree)), + id, id, id, + ht_flex_w(w, tree), z ); + } + else + { htrAddStylesheetItem_va(s, - "\t#ht%POSpane2 { " + "\t#ht%POSpane, #ht%POSpane2, #ht%POSfader { " "POSITION:absolute; " - "VISIBILITY:hidden; " + "VISIBILITY:inherit; " "LEFT:"ht_flex_format"; " "TOP:"ht_flex_format"; " "WIDTH:"ht_flex_format"; " "Z-INDEX:%POS; " "}\n", - id, - ht_flex(x, ht_get_total_w(tree), ht_get_fl_x(tree)), - ht_flex(y, ht_get_total_h(tree), ht_get_fl_y(tree)), - ht_flex(w, ht_get_total_w(tree), ht_get_fl_w(tree)), + id, id, id, + ht_flex_x(x, tree), + ht_flex_y(y, tree), + ht_flex_w(w, tree), z ); - htrAddStylesheetItem_va(s, - "\t#ht%POSfader { " - "POSITION:absolute; " - "VISIBILITY:hidden; " - "LEFT:"ht_flex_format"; " - "TOP:"ht_flex_format"; " - "WIDTH:"ht_flex_format"; " - "Z-INDEX:%POS; " - "}\n", - id, - ht_flex(x, ht_get_total_w(tree), ht_get_fl_x(tree)), - ht_flex(y, ht_get_total_h(tree), ht_get_fl_y(tree)), - ht_flex(w, ht_get_total_w(tree), ht_get_fl_w(tree)), - z+1 - ); } if (s->Capabilities.CSS1) { - htrAddStylesheetItem_va(s,"\t#ht%POSpane { overflow:hidden; }\n",id); - htrAddStylesheetItem_va(s,"\t#ht%POSpane2 { overflow:hidden; }\n",id); - htrAddStylesheetItem_va(s,"\t#ht%POSfader { overflow:hidden; }\n",id); + htrAddStylesheetItem_va(s,"\t#ht%POSpane, #ht%POSpane2, #ht%POSfader { overflow:hidden; }\n", id, id, id); htrAddStylesheetItem_va(s,"\t#ht%POSloader { overflow:hidden; visibility:hidden; position:absolute; top:0px; left:0px; width:0px; height:0px; }\n", id); } /** Write named global **/ htrAddWgtrObjLinkage_va(s, tree, "ht%POSpane",id); - htrAddScriptGlobal(s, "ht_fadeobj", "null", 0); - + htrAddScriptGlobal(s, "ht_fadeobj", "null", 0); + htrAddScriptInclude(s, "/sys/js/htdrv_html.js", 0); htrAddScriptInclude(s, "/sys/js/ht_utils_string.js", 0); - + /** Event handler for click-on-link. **/ htrAddEventHandlerFunction(s, "document","CLICK","ht","ht_click"); htrAddEventHandlerFunction(s,"document","MOUSEOVER","ht","ht_mouseover"); @@ -178,16 +154,53 @@ hthtmlRender(pHtSession s, pWgtrNode tree, int z) htrAddEventHandlerFunction(s,"document","MOUSEMOVE","ht", "ht_mousemove"); htrAddEventHandlerFunction(s,"document","MOUSEDOWN","ht", "ht_mousedown"); htrAddEventHandlerFunction(s,"document","MOUSEUP", "ht", "ht_mouseup"); - - /** Script initialization call. **/ - if (s->Capabilities.Dom0NS) - htrAddScriptInit_va(s," ht_init({layer:wgtrGetNodeRef(ns,\"%STR&SYM\"), layer2:htr_subel(wgtrGetParentContainer(wgtrGetNodeRef(ns,\"%STR&SYM\")),\"ht%POSpane2\"), faderLayer:htr_subel(wgtrGetParentContainer(wgtrGetNodeRef(ns,\"%STR&SYM\")),\"ht%POSfader\"), source:\"%STR&JSSTR\", width:%INT, height:%INT, loader:null});\n", - name, name, id, name, id, - src, w,h); + + /** Script initialization call. **/ + if (s->Capabilities.Dom1HTML) + { + htrAddScriptInit_va(s, + "ht_init({" + "layer:wgtrGetNodeRef(ns, '%STR&SYM'), " + "layer2:htr_subel(wgtrGetParentContainer(wgtrGetNodeRef(ns, '%STR&SYM')), 'ht%POSpane2'), " + "faderLayer:htr_subel(wgtrGetParentContainer(wgtrGetNodeRef(ns, '%STR&SYM')), 'ht%POSfader'), " + "source:'%STR&JSSTR', " + "width:%INT, " + "height:%INT, " + "loader:htr_subel(wgtrGetParentContainer(wgtrGetNodeRef(ns, '%STR&SYM')), 'ht%POSloader')" + "});\n", + name, + name, id, + name, id, + src, + w, + h, + name, id + ); + } + else if (s->Capabilities.Dom0NS) + { + htrAddScriptInit_va(s, + "ht_init({" + "layer:wgtrGetNodeRef(ns, '%STR&SYM'), " + "layer2:htr_subel(wgtrGetParentContainer(wgtrGetNodeRef(ns, '%STR&SYM')), 'ht%POSpane2'), " + "faderLayer:htr_subel(wgtrGetParentContainer(wgtrGetNodeRef(ns, '%STR&SYM')), 'ht%POSfader'), " + "source:'%STR&JSSTR', " + "width:%INT, " + "height:%INT, " + "loader:null" + "});\n", + name, + name, id, + name, id, + src, + w, + h + ); + } else - htrAddScriptInit_va(s," ht_init({layer:wgtrGetNodeRef(ns,\"%STR&SYM\"), layer2:htr_subel(wgtrGetParentContainer(wgtrGetNodeRef(ns,\"%STR&SYM\")),\"ht%POSpane2\"), faderLayer:htr_subel(wgtrGetParentContainer(wgtrGetNodeRef(ns,\"%STR&SYM\")),\"ht%POSfader\"), source:\"%STR&JSSTR\", width:%INT, height:%INT, loader:htr_subel(wgtrGetParentContainer(wgtrGetNodeRef(ns,\"%STR&SYM\")), \"ht%POSloader\")});\n", - name, name, id, name, id, - src, w,h, name, id); + { + mssError(1, "HTHTML", "Browser not supported!!"); + } /** HTML body
element for the layer. **/ htrAddBodyItem_va(s,"
",id); @@ -214,14 +227,14 @@ hthtmlRender(pHtSession s, pWgtrNode tree, int z) } /** If source is an objectsystem entry... **/ - if (src[0] && strncmp(src,"http:",5) && strncmp(src,"debug:",6)) + if (src[0] && strncmp(src, "http:", 5) != 0 && strncmp(src, "debug:", 6) != 0) { content_obj = objOpen(s->ObjSession,src,O_RDONLY,0600,"text/html"); if (content_obj) { - while((cnt = objRead(content_obj, sbuf, 159,0,0)) > 0) + while ((cnt = objRead(content_obj, sbuf, 159, 0, 0)) > 0) { - sbuf[cnt]=0; + sbuf[cnt] = 0; htrAddBodyItem(s, sbuf); } objClose(content_obj); From a44cbd0e795fe7a1fa354c3d1e6bc846eef49aa1 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Mon, 9 Feb 2026 12:03:39 -0700 Subject: [PATCH 083/275] Make checkbox widget responsive. Update C to generate responsive CSS rules. Add an error for unexpected 'checked' values. --- centrallix/htmlgen/htdrv_checkbox.c | 31 +++++++++++++++++++++++------ 1 file changed, 25 insertions(+), 6 deletions(-) diff --git a/centrallix/htmlgen/htdrv_checkbox.c b/centrallix/htmlgen/htdrv_checkbox.c index c2f699e91..d5f164716 100644 --- a/centrallix/htmlgen/htdrv_checkbox.c +++ b/centrallix/htmlgen/htdrv_checkbox.c @@ -90,12 +90,29 @@ int htcbRender(pHtSession s, pWgtrNode tree, int z) { /** Write named global **/ htrAddWgtrObjLinkage_va(s, tree, "cb%INTmain", id); - - /** Ok, write the style header items. **/ - htrAddStylesheetItem_va(s,"\t#cb%POSmain { POSITION:absolute; VISIBILITY:inherit; LEFT:%INTpx; TOP:%INTpx; HEIGHT:13px; WIDTH:13px; Z-INDEX:%POS; }\n",id,x,y,z); + + /** Write style header. **/ + htrAddStylesheetItem_va(s, + "\t#cb%POSmain { " + "position:absolute; " + "visibility:inherit; " + "left:"ht_flex_format"; " + "top:"ht_flex_format"; " + "height:13px; " + "width:13px; " + "z-index:%POS; " + "}\n", + id, + ht_flex_x(x, tree), + ht_flex_y(y, tree), + z + ); + + /** Include scripts. **/ htrAddScriptInclude(s,"/sys/js/htdrv_checkbox.js",0); htrAddScriptInclude(s,"/sys/js/ht_utils_hints.js",0); + /** Register event handlers. **/ htrAddEventHandlerFunction(s, "document","MOUSEDOWN", "checkbox", "checkbox_mousedown"); htrAddEventHandlerFunction(s, "document","MOUSEUP", "checkbox", "checkbox_mouseup"); htrAddEventHandlerFunction(s, "document","MOUSEOVER", "checkbox", "checkbox_mouseover"); @@ -105,9 +122,9 @@ int htcbRender(pHtSession s, pWgtrNode tree, int z) { /** Script initialization call. **/ htrAddScriptInit_va(s," checkbox_init({layer:wgtrGetNodeRef(ns,\"%STR&SYM\"), fieldname:\"%STR&JSSTR\", checked:%INT, enabled:%INT, form:\"%STR&JSSTR\"});\n", name, fieldname,checked,enabled,form); - /** HTML body
element for the layers. **/ + /** Write HTML. **/ htrAddBodyItemLayerStart(s, 0, "cb%POSmain", id, NULL); - switch(checked) + switch (checked) { case 1: htrAddBodyItem_va(s," \n",!enabled); @@ -118,8 +135,10 @@ int htcbRender(pHtSession s, pWgtrNode tree, int z) { case -1: /* null */ htrAddBodyItem_va(s," \n",!enabled); break; + default: + fprintf(stderr, "Unexpected value %d for 'checked'.", checked); + break; } - htrAddBodyItemLayerEnd(s, 0); /** Check for more sub-widgets **/ From cc4d154ae9150fe9295ac3df423342decb22e3e5 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Mon, 9 Feb 2026 12:06:09 -0700 Subject: [PATCH 084/275] Update docs. Add docs for new tab functionality. Add docs for colstep_mode attribute on tables. Fix style issues in docs for tables. Clarify docs for label style. --- centrallix-doc/Widgets/widgets.xml | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/centrallix-doc/Widgets/widgets.xml b/centrallix-doc/Widgets/widgets.xml index a6d917ce4..1a0104512 100644 --- a/centrallix-doc/Widgets/widgets.xml +++ b/centrallix-doc/Widgets/widgets.xml @@ -2323,7 +2323,7 @@ MyButton "widget/imagebutton" The color (named or #numeric) of the text in the label when the user hovers the mouse over the label. - (e.g. bold). + 'bold' for bold text, 'italic' for italic text. The text that the label is to display. @@ -3481,7 +3481,7 @@ MyScrollPane "widget/scrollpane"

The tab pages are containers, and as such, controls of various kinds, including other tab controls, can be placed inside the tab pages.

-

Tab pages are added to a tab control by including widgets of type "widget/tabpage" within the "widget/tab" widget in the structure file that defines the application. Any controls to appear inside a particular tab page should be placed inside their respective "widget/tabpage" widgets in the structure file.Only widgets of type "widget/tabpage" should be placed inside a "widget/tab", with the exception of nonvisuals such as connectors.

+

Tab pages are added to a tab control by including widgets of type "widget/tabpage" within the "widget/tab" widget in the structure file that defines the application. Any controls to appear inside a particular tab page should be placed inside their respective "widget/tabpage" widgets in the structure file.Only widgets of type "widget/tabpage" should be placed inside a "widget/tab", except nonvisuals such as connectors.

Tab pages also have a 'visible' property which allows them to be hidden and revealed. This is used if the type is set to dynamic, but can be used manually as well.

@@ -3516,6 +3516,8 @@ MyScrollPane "widget/scrollpane" The location of the tabs: "top" (default), "bottom", "left", "right", or "none". The width of the tabs in pixels. This is optional for tab_locations of "top", "bottom", and "none". + + The height of the tabs in pixels. This is optional for all tab_locations. Defaults to 24px. The color of the text to be used on the tabs to identify them. @@ -3525,7 +3527,15 @@ MyScrollPane "widget/scrollpane" X-coordinate of the upper left corner of the tab control, relative to the container. - Y-coordinate of the upper left corner of the control, relative to its container. + 'client-side' or 'server-side'. This property is intended for developers (although it can give a very small performance boost). A value of "server-side" turns off JS rendering on the client. This does not work for dynamic width tabs (aka. top or bottom tabs with no 'tab_width' property). Defaults to "client-side". + + The amount to translate a selected tab along the side of the tab control. Defaults to 0px. + + The amount to translate a selected tab out and away from the side of the tab control. Defaults to 2px. + + The amount to translate a selected tab in the x direction. If set, overrides the value derived from select_translate_along and/or select_translate_out. + + The amount to translate a selected tab in the y direction. If set, overrides the value derived from select_translate_along and/or select_translate_out. @@ -3609,9 +3619,9 @@ myTabControl "widget/tab" -

A table widget is used to display data in a tabular format. It consists of a header row with column labels, followed by any number of rows containing data.The header may have a different color or image scheme than the rows, and the rows may or may not be configured to alternate between two colors or background images.

+

A table widget is used to display data in a tabular format. It consists of a header row with column labels, followed by any number of rows containing data. The header may have a different color or image scheme than the rows, and the rows may or may not be configured to alternate between two colors or background images.

- Table widgets come in three different flavors: static, dynamicpage, and dynamicrow.Static table widgets are built on the server and write their data directly into the container in which they reside, which is usually a scrollpane widget. Dynamicpage table widgets load their data once they initialize on the client, by activating a query through an ObjectSource nonvisual widget.Dynamicpage table widgets do not support modification, but can be reloaded through an ObjectSource at will.Dynamicrow table widgets, on the other hand, display each row as an individual layer, and thus are modifiable on the client. Dynamicrow table widgets also load their contents through an ObjectSource widget query.As of the time of writing of this document, only static mode and dynamicrow mode were supported. + Table widgets come in three different flavors: static, dynamicpage, and dynamicrow. Static table widgets are built on the server and write their data directly into the container in which they reside, which is usually a scrollpane widget. Dynamicpage table widgets load their data once they initialize on the client, by activating a query through an ObjectSource nonvisual widget. Dynamicpage table widgets do not support modification, but can be reloaded through an ObjectSource at will. Dynamicrow table widgets, on the other hand, display each row as an individual layer, and thus are modifiable on the client. Dynamicrow table widgets also load their contents through an ObjectSource widget query. As of the time of writing of this document, only static mode and dynamicrow mode were supported.

Table widgets allow the selection (keyboard, mouse, and data focus) of individual rows.

@@ -3636,6 +3646,8 @@ myTabControl "widget/tab" The vertical spacing between cells in the table, in pixels. Default is 1. The width of the column separation lines in pixels. Default is 1. + + Either 'full' or 'header'. Default is 'full'. Either "rows" (default) or "properties". In "properties" mode, the table displays one row per attribute, and so only displays the current record in the objectsource. In "rows" mode, the table displays one row per record in the objectsource. From 0b6a8a30a75bfa1deebb9f96287d59e306d11a72 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Mon, 9 Feb 2026 12:09:36 -0700 Subject: [PATCH 085/275] Add new content for testing. Add tab_features.app to show off the new tab features. Add tab_adventure.app to stress test using tabs for a text adventure. Add scrollpane_test.app to test the new scrollpane events and actions. Add several HTML examples for use when testing HTML. --- centrallix-os/samples/scrollpane_test.app | 262 +++++++++ centrallix-os/samples/tab_adventure.app | 413 +++++++++++++ centrallix-os/samples/tab_features.app | 679 ++++++++++++++++++++++ 3 files changed, 1354 insertions(+) create mode 100644 centrallix-os/samples/scrollpane_test.app create mode 100644 centrallix-os/samples/tab_adventure.app create mode 100644 centrallix-os/samples/tab_features.app diff --git a/centrallix-os/samples/scrollpane_test.app b/centrallix-os/samples/scrollpane_test.app new file mode 100644 index 000000000..31db45c6d --- /dev/null +++ b/centrallix-os/samples/scrollpane_test.app @@ -0,0 +1,262 @@ +$Version=2$ +test "widget/page" + { + title = "Test App"; + bgcolor = "#ffffff"; + + x = 0; y = 0; + width = 500; height = 500; + + // Description: + // This page is intended for testing scroll pane functionality, including + // the associated events, actions, etc. It specifically tests the scroll + // pane when used on an HTML widget, allowing us to load long HTML pages + // to test scrolling large amounts of content. + + pane "widget/pane" + { + x = 10; y = 10; + width = 480; height = 480; + + scroll "widget/scrollpane" + { + x = 0; y = 20; + width = 300; height = 300; + bgcolor = "#c0f1ba"; + + // Content. + // html "widget/html" + // { + // x = 0; y = 0; + // width = 300; height = 300; + + // mode = "dynamic"; + // source = "/samples/html_example2_long.html"; + // } + + // Vertical content. + spacer "widget/pane" + { + x = 0; y = 0; + width = 0; height = 2000; + fl_height = 0; + style = flat; + } + a1 "widget/pane" + { + x = 10; y = 0; + width = 250; height = 500; + + bgcolor = "#e6b2c4"; + } + a2 "widget/pane" + { + x = 20; y = 500; + width = 200; height = 500; + + bgcolor = "#e6d2c4"; + } + a3 "widget/pane" + { + x = 30; y = 1000; + width = 150; height = 500; + + bgcolor = "#e6b2c4"; + } + a4 "widget/pane" + { + x = 40; y = 1500; + width = 100; height = 500; + + bgcolor = "#e6d2c4"; + } + + // Horizontal Content. + // Unused because there is no horizontal scrollpane. + // spacer "widget/pane" + // { + // x = 0; y = 0; + // width = 2000; height = 0; + // fl_height = 0; + // style = flat; + // } + // a1 "widget/pane" + // { + // x = 0; y = 10; + // width = 500; height = 250; + + // bgcolor = "#e6b2c4"; + // } + // a2 "widget/pane" + // { + // x = 500; y = 20; + // width = 500; height = 200; + + // bgcolor = "#e6d2c4"; + // } + // a3 "widget/pane" + // { + // x = 1000; y = 30; + // width = 500; height = 150; + + // bgcolor = "#e6b2c4"; + // } + // a4 "widget/pane" + // { + // x = 1500; y = 40; + // width = 500; height = 100; + + // bgcolor = "#e6d2c4"; + // } + + // Ads, testing the Scroll event. + adv "widget/variable" { type = integer; value = runclient(0); } + ad1v "widget/variable" { type = integer; value = runclient(:adv:value); } + ad1c "widget/connector" + { + event = Scroll; + target = test; + action = Alert; + event_condition = runclient(:ad1v:value == 0 and :Percent > 30 and :Change > 0); + Message = runclient("Advertisement!!"); + } + ad1d "widget/connector" + { + event = Scroll; + target = ad1v; + action = SetValue; + event_condition = runclient(:ad1v:value == 0 and :Percent > 30 and :Change > 0); + Value = runclient(1); + } + + ad2v "widget/variable" { type = integer; value = runclient(:adv:value); } + ad2c "widget/connector" + { + event = Scroll; + target = test; + action = Alert; + event_condition = runclient(:ad2v:value == 0 and :Percent > 40 and :Change > 0); + Message = runclient("Advertisement 2!!"); + } + ad2d "widget/connector" + { + event = Scroll; + target = ad2v; + action = SetValue; + event_condition = runclient(:ad2v:value == 0 and :Percent > 40 and :Change > 0); + Value = runclient(1); + } + + ad3v "widget/variable" { type = integer; value = runclient(:adv:value); } + ad3c "widget/connector" + { + event = Scroll; + target = test; + action = Alert; + event_condition = runclient(:ad3v:value == 0 and :Percent > 50 and :Change > 0); + Message = runclient("Advertisement 3!!"); + } + ad3d "widget/connector" + { + event = Scroll; + target = ad3v; + action = SetValue; + event_condition = runclient(:ad3v:value == 0 and :Percent > 50 and :Change > 0); + Value = runclient(1); + } + + // Log events for debugging. + debug_Scroll "widget/connector" + { + event = Scroll; + target = test; + action = Log; + Message = runclient("Scroll " + :Percent + " " + :Change); + } + debug_Wheel "widget/connector" + { + event = Wheel; + target = test; + action = Log; + Message = runclient("Wheel: ctrlKey=" + :ctrlKey + " shiftKey=" + :shiftKey + " altKey=" + :altKey + " metaKey=" + :metaKey + " button=" + :button); + } + debug_Click "widget/connector" + { + event = Click; + target = test; + action = Log; + Message = runclient("Click: ctrlKey=" + :ctrlKey + " shiftKey=" + :shiftKey + " altKey=" + :altKey + " metaKey=" + :metaKey + " button=" + :button); + } + debug_MouseDown "widget/connector" + { + event = MouseDown; + target = test; + action = Log; + Message = runclient("MouseDown: ctrlKey=" + :ctrlKey + " shiftKey=" + :shiftKey + " altKey=" + :altKey + " metaKey=" + :metaKey + " button=" + :button); + } + debug_MouseUp "widget/connector" + { + event = MouseUp; + target = test; + action = Log; + Message = runclient("MouseUp: ctrlKey=" + :ctrlKey + " shiftKey=" + :shiftKey + " altKey=" + :altKey + " metaKey=" + :metaKey + " button=" + :button); + } + debug_MouseOver "widget/connector" + { + event = MouseOver; + target = test; + action = Log; + Message = runclient("MouseOver"); + } + debug_MouseOut "widget/connector" + { + event = MouseOut; + target = test; + action = Log; + Message = runclient("MouseOut"); + } + debug_MouseMove "widget/connector" + { + event = MouseMove; + target = test; + action = Log; + Message = runclient("MouseMove"); + } + } + + button1 "widget/textbutton" + { + x = 5; y = 5; + width = 75; height = 30; + font_size = 18; + + bgcolor="#0c0447"; + text = "To 45%"; + + button1c "widget/connector" + { + event = Click; + target = scroll; + action = ScrollTo; + Percent = 45; + } + } + button2 "widget/textbutton" + { + x = 5; y = 40; + width = 75; height = 30; + font_size = 18; + + bgcolor="#241672"; + text = "To 100px"; + + button2c "widget/connector" + { + event = Click; + target = scroll; + action = ScrollTo; + Offset = 100; + } + } + } + } \ No newline at end of file diff --git a/centrallix-os/samples/tab_adventure.app b/centrallix-os/samples/tab_adventure.app new file mode 100644 index 000000000..a05481949 --- /dev/null +++ b/centrallix-os/samples/tab_adventure.app @@ -0,0 +1,413 @@ +$Version=2$ +FourTabs "widget/page" { + title = "Tab Adventure"; + bgcolor = "#c0c0c0"; + x=0; y=0; width=250; height=300; + + MainTab "widget/tab" { + x = 0; y = 0; width=250; height=300; + tab_location = none; + + bgcolor = "#05091dff"; + inactive_bgcolor = "#01010aff"; + selected_index = 1; + + Scene1 "widget/tabpage" { + height=300; + fl_width = 100; + + Scene1Title "widget/label" { x=10; y=10; width=250; height=32; font_size=32; fgcolor="#fff1df"; text="The Beginning"; } + Scene1Text "widget/label" { + x=10; y=50; width=250; height=80; + font_size=18; fgcolor="#fff1df"; + text=" + You wake up surounded by the ruins of a village. Houses are burned, walls are colapsed, and roves are caved in. + The house you're 'in' doesn't even have a roof, and barely half a wall is still standing. + "; + } + Scene1Ask "widget/label" { x=10; y=130; width=250; height=32; font_size=18; fgcolor="#ffc67cff"; text="What do you do?"; } + + Scene1Option1 "widget/textbutton" { + x = 10; y = 180; width = 50; height = 30; font_size=18; bgcolor="#0c0447ff"; + text = "Get up and investigate the village"; + Scene1Option1C "widget/connector" { event=Click; target=MainTab; action=SetTab; TabIndex=2; } + } + + Scene1Option2 "widget/textbutton" { + x = 70; y = 180; width = 50; height = 30; font_size=18; bgcolor="#0c0447ff"; + text = "Look around the 'house'"; + Scene1Option2C "widget/connector" { event=Click; target=MainTab; action=SetTab; TabIndex=3; } + } + } + + Scene2 "widget/tabpage" { + height=300; + + Scene2Title "widget/label" { x=10; y=10; width=250; height=32; font_size=32; fgcolor="#fff1df"; text="Exploring"; } + Scene2Text "widget/label" { + x=10; y=50; width=250; height=80; + font_size=18; fgcolor="#fff1df"; + text=" + You get up and begin to walk around the village. Everything is in pretty bad shape, but a lot of brick fireplaces + were able to survive decently well. + "; + } + Scene2Ask "widget/label" { x=10; y=130; width=250; height=32; font_size=18; fgcolor="#ffc67cff"; text="What do you do?"; } + + Scene2Option1 "widget/textbutton" { + x = 10; y = 180; width = 50; height = 30; font_size=18; bgcolor="#0c0447ff"; + text = "Leave the village"; + Scene2Option1C "widget/connector" { event=Click; target=MainTab; action=SetTab; TabIndex=6; } + } + + Scene2Option2 "widget/textbutton" { + x = 70; y = 180; width = 50; height = 30; font_size=18; bgcolor="#0c0447ff"; + text = "Investigate a fireplace"; + Scene2Option2C "widget/connector" { event=Click; target=MainTab; action=SetTab; TabIndex=7; } + } + + Scene2Option3 "widget/textbutton" { + x = 130; y = 180; width = 50; height = 30; font_size=18; bgcolor="#0c0447ff"; + text = "Go back to the first house where you woke up."; + Scene2Option3C "widget/connector" { event=Click; target=MainTab; action=SetTab; TabIndex=3; } + } + } + + Scene3 "widget/tabpage" { + height=300; + + Scene3Title "widget/label" { x=10; y=10; width=250; height=32; font_size=32; fgcolor="#fff1df"; text="Look around the house"; } + Scene3Text "widget/label" { + x=10; y=50; width=250; height=80; + font_size=18; fgcolor="#fff1df"; + text=" + You look around the house where you woke up. + "; + } + Scene3Ask "widget/label" { x=10; y=130; width=250; height=32; font_size=18; fgcolor="#ffc67cff"; text=""; } + + Scene3Option1 "widget/textbutton" { + x = 10; y = 180; width = 50; height = 30; font_size=18; bgcolor="#0c0447ff"; + text = "..."; + Scene3Option1C "widget/connector" { event=Click; target=MainTab; action=SetTab; TabIndex=4; } + } + } + + Scene4 "widget/tabpage" { + height=300; + + Scene4Title "widget/label" { x=10; y=10; width=250; height=32; font_size=32; fgcolor="#fff1df"; text="Food!"; } + Scene4Text "widget/label" { + x=10; y=50; width=250; height=80; + font_size=18; fgcolor="#fff1df"; + text=" + You find some scraps of food and realize that you're famished! + The food looks pretty old, though. Maybe it's not a good idea... + "; + } + Scene4Ask "widget/label" { x=10; y=130; width=250; height=32; font_size=18; fgcolor="#ffc67cff"; text="What do you do?"; } + + Scene4Option1 "widget/textbutton" { + x = 10; y = 180; width = 50; height = 30; font_size=18; bgcolor="#0c0447ff"; + text = "Eat the food"; + Scene4Option1C "widget/connector" { event=Click; target=MainTab; action=SetTab; TabIndex=5; } + } + + Scene4Option2 "widget/textbutton" { + x = 70; y = 180; width = 50; height = 30; font_size=18; bgcolor="#0c0447ff"; + text = "Leave it and check out the village"; + Scene4Option2C "widget/connector" { event=Click; target=MainTab; action=SetTab; TabIndex=2; } + } + } + + Scene5 "widget/tabpage" { + height=300; + + Scene5Title "widget/label" { x=10; y=10; width=250; height=32; font_size=32; fgcolor="#fff1df"; text="Bad food..."; } + Scene5Text1 "widget/label" { + x=10; y=50; width=250; height=80; + font_size=18; fgcolor="#fff1df"; + text="You eat the food."; + } + Scene5Text2 "widget/label" { + x=10; y=90; width=250; height=80; + font_size=18; fgcolor="#da2d2dff"; + text="OH NO!!"; + } + Scene5Text3 "widget/label" { + x=10; y=120; width=250; height=80; + font_size=18; fgcolor="#fff1df"; + text="You should not have done that. You feel very sick."; + } + Scene5Ask "widget/label" { x=10; y=150; width=250; height=32; font_size=18; fgcolor="#ffc67cff"; text=". . ."; } + + Scene5Option1 "widget/textbutton" { + x = 10; y = 190; width = 50; height = 30; font_size=18; bgcolor="#0c0447ff"; + text = ". . ."; + Scene5Option1C "widget/connector" { event=Click; target=MainTab; action=SetTab; TabIndex=15; } + } + } + + Scene6 "widget/tabpage" { + height=300; + + Scene6Title "widget/label" { x=10; y=10; width=250; height=32; font_size=32; fgcolor="#fff1df"; text="FREEDOM"; } + Scene6Text "widget/label" { + x=10; y=50; width=250; height=80; + font_size=18; fgcolor="#fff1df"; + text=" + You leave the village. As you get further away from the depressing place, you begin to run. + You sprint across planes and through vallies, never looking back or missing the acursed ruins you left behind. + After a while, though, you suddenly fall off some kind of edge and plumit until everything goes black... + "; + } + + Scene6Option1 "widget/textbutton" { + x = 10; y = 150; width = 75; height = 30; font_size=18; bgcolor="#1a1066ff"; + text = "WHAT?! The writer made the world THAT small?"; + Scene6Option1C "widget/connector" { event=Click; target=MainTab; action=SetTab; TabIndex=15; } + } + } + + Scene7 "widget/tabpage" { + height=300; + + Scene7Title "widget/label" { x=10; y=10; width=250; height=32; font_size=32; fgcolor="#fff1df"; text="Fireplaces"; } + Scene7Text "widget/label" { + x=10; y=50; width=250; height=80; + font_size=18; fgcolor="#fff1df"; + text=" + There's several firepalces around, so you have a few options. + "; + } + + Scene7Option1 "widget/textbutton" { + x = 10; y = 120; width = 50; height = 24; font_size=18; bgcolor="#0c0447ff"; + text = "Sturdy Fireplace"; + Scene7Option1C "widget/connector" { event=Click; target=MainTab; action=SetTab; TabIndex=8; } + } + + Scene7Option2 "widget/textbutton" { + x = 10; y = 150; width = 50; height = 24; font_size=18; bgcolor="#0c0447ff"; + text = "Leaning Fireplace"; + Scene7Option2C "widget/connector" { event=Click; target=MainTab; action=SetTab; TabIndex=10; } + } + + Scene7Option3 "widget/textbutton" { + x = 10; y = 180; width = 50; height = 24; font_size=18; bgcolor="#0c0447ff"; + text = "Crumbling Fireplace"; + Scene7Option3C "widget/connector" { event=Click; target=MainTab; action=SetTab; TabIndex=9; } + } + } + + Scene8 "widget/tabpage" { + height=300; + + Scene8Title "widget/label" { x=10; y=10; width=250; height=32; font_size=32; fgcolor="#fff1df"; text="'Sturdy' Fireplace"; } + Scene8Text "widget/label" { + x=10; y=50; width=250; height=80; + font_size=18; fgcolor="#fff1df"; + text=" + You approach the sturdy fireplace and begin to investigate it. Then, you find a loose brick! + However, as you slowly pull it out, the entire fireplace suddenly topples over onto you. + Guess it wasn't so sturdy after all!! + "; + } + + Scene8Option1 "widget/textbutton" { + x = 10; y = 150; width = 75; height = 30; font_size=18; bgcolor="#660009ff"; + text = "The end"; + Scene8Option1C "widget/connector" { event=Click; target=MainTab; action=SetTab; TabIndex=15; } + } + } + + Scene9 "widget/tabpage" { + height=300; + + Scene9Title "widget/label" { x=10; y=10; width=250; height=32; font_size=32; fgcolor="#fff1df"; text="Crumbling Fireplace"; } + Scene9Text "widget/label" { + x=10; y=50; width=250; height=80; + font_size=18; fgcolor="#fff1df"; + text=" + You approach the crumbling fireplace and realize it's the one in the house where you woke up! + "; + } + + Scene9Option1 "widget/textbutton" { + x = 10; y = 150; width = 75; height = 30; font_size=18; bgcolor="#0c0447ff"; + text = "Neat!"; + Scene9Option1C "widget/connector" { event=Click; target=MainTab; action=SetTab; TabIndex=3; } + } + } + + Scene10 "widget/tabpage" { + height=300; + + Scene10Title "widget/label" { x=10; y=10; width=250; height=32; font_size=32; fgcolor="#fff1df"; text="Leaning Fireplace"; } + Scene10Text "widget/label" { + x=10; y=50; width=250; height=80; + font_size=18; fgcolor="#fff1df"; + text=" + As you investigate the leaning fireplace, you find a loose brick. You carefully slide + the brick out, and behind it you pull out a golden scroll that seems to call to you. + "; + } + Scene10Ask "widget/label" { x=10; y=130; width=250; height=32; font_size=18; fgcolor="#ffc67cff"; text="What do you do?"; } + + Scene10Option1 "widget/textbutton" { + x = 10; y = 180; width = 50; height = 30; font_size=18; bgcolor="#0c0447ff"; + text = "Read it"; + Scene10Option1C "widget/connector" { event=Click; target=MainTab; action=SetTab; TabIndex=11; } + } + + Scene10Option2 "widget/textbutton" { + x = 70; y = 180; width = 50; height = 30; font_size=18; bgcolor="#0c0447ff"; + text = "Yikes! Probably cursed. Put it down."; + Scene10Option2C "widget/connector" { event=Click; target=MainTab; action=SetTab; TabIndex=2; } + } + } + + Scene11 "widget/tabpage" { + height=300; + + Scene11Title "widget/label" { x=10; y=10; width=250; height=32; font_size=32; fgcolor="#fff1df"; text="Leaning Fireplace: Last Chance"; } + Scene11Text "widget/label" { + x=10; y=50; width=250; height=80; + font_size=18; fgcolor="#fff1df"; + text=" + You know, the scroll probably is cursed. + Reading it might not be a good idea! + "; + } + Scene11Ask "widget/label" { x=10; y=130; width=250; height=32; font_size=18; fgcolor="#ffc67cff"; text="What do you do?"; } + + Scene11Option7 "widget/textbutton" { + x = 82; y = 230; width = 25; height = 15; font_size=6; fgcolor="#fcc885"; bgcolor="#580251"; + text = "Read it anyway!"; + Scene11Option7C "widget/connector" { event=Click; target=MainTab; action=SetTab; TabIndex=12; } + } + + Scene11Option1 "widget/textbutton" { + x = 10; y = 180; width = 50; height = 25; font_size=18; bgcolor="#0c0447ff"; + text = "Ok, I'll go investigate the village"; + Scene11Option1C "widget/connector" { event=Click; target=MainTab; action=SetTab; TabIndex=2; } + } + + Scene11Option2 "widget/textbutton" { + x = 70; y = 180; width = 50; height = 25; font_size=18; bgcolor="#0c0447ff"; + text = "Ok, I'll look around the house where I woke up."; + Scene11Option2C "widget/connector" { event=Click; target=MainTab; action=SetTab; TabIndex=3; } + } + + Scene11Option3 "widget/textbutton" { + x = 130; y = 180; width = 50; height = 25; font_size=18; bgcolor="#0c0447ff"; + text = "Ok, I'll go to the sturdy fireplace."; + Scene11Option3C "widget/connector" { event=Click; target=MainTab; action=SetTab; TabIndex=8; } + } + + Scene11Option4 "widget/textbutton" { + x = 10; y = 220; width = 50; height = 25; font_size=18; bgcolor="#0c0447ff"; + text = "Ok, I'll leave the village."; + Scene11Option4C "widget/connector" { event=Click; target=MainTab; action=SetTab; TabIndex=6; } + } + + Scene11Option5 "widget/textbutton" { + x = 70; y = 220; width = 50; height = 25; font_size=18; bgcolor="#1f0757bb"; + text = "Ok, knock myself out."; + Scene11Option5C "widget/connector" { event=Click; target=MainTab; action=SetTab; TabIndex=1; } + } + + Scene11Option6 "widget/textbutton" { + x = 130; y = 220; width = 50; height = 25; font_size=18; bgcolor="#3e0655ff"; + text = "Ok, I'll die."; + Scene11Option6C "widget/connector" { event=Click; target=MainTab; action=SetTab; TabIndex=15; } + } + } + + Scene12 "widget/tabpage" { + height=300; + + Scene12Title "widget/label" { x=10; y=10; width=250; height=32; font_size=32; fgcolor="#fff1df"; text="You really shouldn't read that!"; } + Scene12Text "widget/label" { + x=10; y=50; width=250; height=80; + font_size=18; fgcolor="#fff1df"; + text=" + What? How did you do that! You're not supposed to do that! + "; + } + + Scene12Option1 "widget/textbutton" { + x = 10; y = 120; width = 50; height = 30; font_size=18; bgcolor="#0c0447ff"; + text = "JUST LET ME READ THE SCROLL!!!"; + Scene12Option1C "widget/connector" { event=Click; target=MainTab; action=SetTab; TabIndex=13; } + } + } + + + Scene13 "widget/tabpage" { + height=300; + + Scene13Title "widget/label" { x=10; y=10; width=250; height=32; font_size=32; fgcolor="#fff1df"; text="VICTORY"; } + Scene13Text "widget/label" { + x=10; y=50; width=250; height=80; + font_size=18; fgcolor="#fff1df"; + text=" + Ok... fine. You found the golden scroll and won the game. + Look, I had to make it at least a little bit difficult for you! + "; + } + + Scene13Option1 "widget/textbutton" { + x = 10; y = 120; width = 50; height = 30; font_size=18; bgcolor="#0c0447ff"; + text = "Yay!"; + Scene13Option1C "widget/connector" { event=Click; target=MainTab; action=SetTab; TabIndex=14; } + } + } + + + Scene14 "widget/tabpage" { + height=300; + + Scene14Title "widget/label" { x=10; y=10; width=250; height=32; font_size=32; fgcolor="#fff1df"; text="The End"; } + Scene14Text "widget/label" { + x=10; y=50; width=250; height=80; + font_size=18; fgcolor="#fff1df"; + text=" + Ok... fine. You found the golden scroll and won the game. + Just thought I'd see if I could trick you there hahahah. + "; + } + + Scene14Text2 "widget/label" { + x=10; y=120; width=250; height=80; + font_size=18; fgcolor="#d9e97dff"; + text=" + Thank you for playing! + "; + } + } + + Scene15 "widget/tabpage" { + height=300; + + Scene15Title "widget/label" { x=10; y=10; width=250; height=32; font_size=32; fgcolor="#ff001c"; text="DEATH"; } + Scene15Text "widget/label" { + x=10; y=50; width=250; height=80; + font_size=18; fgcolor="#fff1df"; + text=" + You died... Let's call this a learning experience. + Better luck next time. + "; + } + Scene15Ask "widget/label" { x=10; y=130; width=250; height=32; font_size=18; fgcolor="#ffc67cff"; text="What do you do?"; } + + Scene15Option1 "widget/textbutton" { + x = 10; y = 180; width = 50; height = 30; font_size=18; bgcolor="#0c0447ff"; + text = "Try again?"; + Scene15Option1C "widget/connector" { event=Click; target=MainTab; action=SetTab; TabIndex=1; } + } + + Scene15Option2 "widget/textbutton" { x = 70; y = 180; width = 50; height = 30; font_size=18; bgcolor="#470404ff"; text = "Give up"; } + } + } +} diff --git a/centrallix-os/samples/tab_features.app b/centrallix-os/samples/tab_features.app new file mode 100644 index 000000000..bcde25340 --- /dev/null +++ b/centrallix-os/samples/tab_features.app @@ -0,0 +1,679 @@ +$Version=2$ +TabFeatures "widget/page" + { + x = 0; y = 0; + width = 500; height = 500; + + title = "Tab Features Demonstrated"; + bgcolor = "#b0b0b0"; + + tloc "widget/parameter" { type = "string"; default = "top"; } + w "widget/parameter" { type = "integer"; default = 220; } + h "widget/parameter" { type = "integer"; default = 70; } + + tloc_label "widget/label" + { + x = 2; y = 1; + width = 50; height = 20; + font_size = 16; + + text = "Tab Location:"; + } + + button_top "widget/textbutton" + { + x = 55; y = 1; + width = 27; height = 18; + font_size = 10; + + text = "Top"; + bgcolor="#0c0447ff"; + + button_top_c "widget/connector" + { + event = Click; + target = TabFeatures; + action = LoadPage; + Source = "TabFeatures.app?tloc=top&w=220&h=70"; + } + } + + button_bottom "widget/textbutton" + { + x = 85; y = 1; + width = 27; height = 18; + font_size = 10; + + text = "Bottom"; + bgcolor="#0c0447ff"; + + button_bottom_c "widget/connector" + { + event = Click; + target = TabFeatures; + action = LoadPage; + Source = "TabFeatures.app?tloc=bottom&w=220&h=70"; + } + } + + button_left "widget/textbutton" + { + x = 115; y = 1; + width = 27; height = 18; + font_size = 10; + + text = "Left"; + bgcolor="#0c0447ff"; + + button_left_c "widget/connector" + { + event = Click; + target = TabFeatures; + action = LoadPage; + Source = "TabFeatures.app?tloc=left&w=140&h=90"; + } + } + + button_right "widget/textbutton" + { + x = 145; y = 1; + width = 27; height = 18; + font_size = 10; + + text = "Right"; + bgcolor="#0c0447ff"; + + button_right_c "widget/connector" + { + event = Click; + target = TabFeatures; + action = LoadPage; + Source = "TabFeatures.app?tloc=right&w=140&h=90"; + } + } + + t1 "widget/tab" + { + x = 0; y = 20; + height = 500; width = 500; + + bgcolor = "#c0c0c0"; + inactive_bgcolor = "#a8a8a8"; + selected_index = 2; + tab_location = top; + select_translate_out = 1; + + t11 "widget/tabpage" + { + title = "Spacing Rant"; + + t11l0 "widget/label" { x=20; y=20; width=200; height=40; font_size=24; text="Spacing Rant"; } + + t11t1 "widget/tab" + { + x = 20; y = 60; + width = runserver(:this:w); height = 100; + tab_location = runserver(:this:tloc); + tab_width = 80; + + background = "/sys/images/slate2.gif"; // "/sys/images/4Color.png" + inactive_background = "/sys/images/slate2_dark.gif"; + selected_index = 2; + + t11t11 "widget/tabpage" { title = "Tab 1"; t11t11l "widget/label" { x=10; y=10; width=100; height=32; style=bold; text="10px X 10px"; } } + t11t12 "widget/tabpage" { title = "Tab 2"; t11t12l "widget/label" { x=20; y=30; width=100; height=32; style=bold; text="20px X 30px"; } } + t11t13 "widget/tabpage" { title = "Tab 3"; t11t13l "widget/label" { x=30; y=50; width=100; height=32; style=bold; text="30px X 50px"; } } + t11t14 "widget/tabpage" { title = "Tab 4"; t11t14l "widget/label" { x=40; y=70; width=100; height=32; style=bold; text="40px X 70px"; } } + + t11t1c "widget/connector" + { + event = TabChanged; + action = SetTab; + target = t11t2; + TabIndex = runclient(:t11t1:selected_index); + } + } + + t11t2 "widget/tab" + { + x = 260; y = 60; + width = runserver(:this:w); height = 100; + tab_location = runserver(:this:tloc); + tab_width = 80; + + bgcolor = "#c0c0c0"; + inactive_bgcolor = "#b8b8b8"; + selected = t11t22; + + t11t21 "widget/tabpage" { title = "Tab 1"; t11t21l "widget/label" { x=10; y=10; width=100; height=32; style=bold; text="10px X 10px"; } } + t11t22 "widget/tabpage" { title = "Tab 2"; t11t22l "widget/label" { x=20; y=30; width=100; height=32; style=bold; text="20px X 30px"; } } + t11t23 "widget/tabpage" { title = "Tab 3"; t11t23l "widget/label" { x=30; y=50; width=100; height=32; style=bold; text="30px X 50px"; } } + t11t24 "widget/tabpage" { title = "Tab 4"; t11t24l "widget/label" { x=40; y=70; width=100; height=32; style=bold; text="40px X 70px"; } } + + t11t2c "widget/connector" + { + event = TabChanged; + action = SetTab; + target = t11t1; + TabIndex = runclient(:t11t2:selected_index); + } + } + + t11p "widget/pane" + { + x = 20; y = 180; width=runserver(:this:w); height=100; + + t11p1l "widget/label" { x=10; y=10; width=100; height=32; style=bold; text="10px X 10px"; } + t11p2l "widget/label" { x=20; y=30; width=100; height=32; style=bold; text="20px X 30px"; } + t11p3l "widget/label" { x=30; y=50; width=100; height=32; style=bold; text="30px X 50px"; } + t11p4l "widget/label" { x=40; y=70; width=100; height=32; style=bold; text="40px X 70px"; } + } + } + + t12 "widget/tabpage" + { + title = "Tab Spacing"; + + t12l0 "widget/label" { x=20; y=20; width=400; height=40; font_size=24; text="Tab Spacing"; } + + t12l1 "widget/label" { x=30; y=75; width=runserver(:this:w-20); height=40; font_size=16; style="bold"; text="Default (2px)"; } + t12t1 "widget/tab" + { + x = 20; y = 100; + width = runserver(:this:w); height = runserver(:this:h); + tab_location = runserver(:this:tloc); + tab_width = 80; + + background = "/sys/images/slate2.gif"; + inactive_background = "/sys/images/slate2_dark.gif"; + selected_index = 2; + + t12t11 "widget/tabpage" { title = "First"; t12t11l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Tab One"; } } + t12t12 "widget/tabpage" { title = "Looong Tab"; t12t12l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Tab Two"; } } + t12t13 "widget/tabpage" { title = "S"; t12t13l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Tab Three"; } } + t12t14 "widget/tabpage" { title = "Last Tab"; t12t14l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Tab Four"; } } + + t12t1c "widget/connector" + { + event = TabChanged; + action = SetTab; + target = t12t2; + TabIndex = runclient(:t12t1:selected_index); + } + } + + t12l2 "widget/label" { x=270; y=75; width=runserver(:this:w-20); height=40; font_size=16; style="bold"; text="No Tab Spacing"; } + t12t2 "widget/tab" + { + x = 260; y = 100; + width = runserver(:this:w); height = runserver(:this:h); + tab_location = runserver(:this:tloc); + tab_width = 80; + + background = "/sys/images/slate2.gif"; + inactive_background = "/sys/images/slate2_dark.gif"; + selected = t12t22; + tab_spacing = 0; + + t12t21 "widget/tabpage" { title = "First"; t12t21l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Label One"; } } + t12t22 "widget/tabpage" { title = "Looong Tab"; t12t22l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Label Two"; } } + t12t23 "widget/tabpage" { title = "S"; t12t23l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Label Three"; } } + t12t24 "widget/tabpage" { title = "Last Tab"; t12t24l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Label Four"; } } + + t12t2c "widget/connector" + { + event = TabChanged; + action = SetTab; + target = t12t3; + TabIndex = runclient(:t12t2:selected_index); + } + } + + t12l3 "widget/label" { x=30; y=215; width=runserver(:this:w-20); height=40; font_size=16; style="bold"; text="Tab Spacing 8px"; } + t12t3 "widget/tab" + { + x = 20; y = 240; + width = runserver(:this:w); height = runserver(:this:h); + tab_location = runserver(:this:tloc); + tab_width = 80; + + background = "/sys/images/slate2.gif"; + inactive_background = "/sys/images/slate2_dark.gif"; + selected_index = 2; + tab_spacing = 8; + + t12t31 "widget/tabpage" { title = "First"; t12t31l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Tab One"; } } + t12t32 "widget/tabpage" { title = "Looong Tab"; t12t32l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Tab Two"; } } + t12t33 "widget/tabpage" { title = "S"; t12t33l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Tab Three"; } } + t12t34 "widget/tabpage" { title = "Last Tab"; t12t34l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Tab Four"; } } + + t12t3c "widget/connector" + { + event = TabChanged; + action = SetTab; + target = t12t4; + TabIndex = runclient(:t12t3:selected_index); + } + } + + t12l4 "widget/label" { x=270; y=215; width=runserver(:this:w-20); height=40; font_size=16; style="bold"; text="Tab Spacing 16px"; } + t12t4 "widget/tab" + { + x = 260; y = 240; + width = runserver(:this:w); height = runserver(:this:h); + tab_location = runserver(:this:tloc); + tab_width = 80; + + background = "/sys/images/slate2.gif"; + inactive_background = "/sys/images/slate2_dark.gif"; + selected = t12t42; + tab_spacing = 16; + + t12t41 "widget/tabpage" { title = "First"; t12t41l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Label One"; } } + t12t42 "widget/tabpage" { title = "Looong Tab"; t12t42l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Label Two"; } } + t12t43 "widget/tabpage" { title = "S"; t12t43l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Label Three"; } } + t12t44 "widget/tabpage" { title = "Last Tab"; t12t44l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Label Four"; } } + + t12t4c "widget/connector" + { + event = TabChanged; + action = SetTab; + target = t12t5; + TabIndex = runclient(:t12t4:selected_index); + } + } + + t12l5 "widget/label" { x=30; y=355; width=60; height=20; fl_width = 1; font_size=16; style="bold"; text="Tab Spacing -8px"; } + t12l5a "widget/label" { x=90; y=357; width=runserver(:this:w-80); height=15; font_size=12; style="bold"; fgcolor="red"; text="(Negative values not recomended)"; } + t12t5 "widget/tab" + { + x = 20; y = 380; + width = runserver(:this:w); height = runserver(:this:h); + tab_location = runserver(:this:tloc); + tab_width = 80; + + background = "/sys/images/slate2.gif"; + inactive_background = "/sys/images/slate2_dark.gif"; + selected_index = 2; + tab_spacing = -8; + + t12t51 "widget/tabpage" { title = "First"; t12t51l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Tab One"; } } + t12t52 "widget/tabpage" { title = "Looong Tab"; t12t52l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Tab Two"; } } + t12t53 "widget/tabpage" { title = "S"; t12t53l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Tab Three"; } } + t12t54 "widget/tabpage" { title = "Last Tab"; t12t54l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Tab Four"; } } + + t12t5c "widget/connector" + { + event = TabChanged; + action = SetTab; + target = t12t6; + TabIndex = runclient(:t12t5:selected_index); + } + } + + t12l6 "widget/label" { x=270; y=355; width=70; height=20; fl_width = 1; font_size=16; style="bold"; text="Tab Spacing -16px"; } + t12l6a "widget/label" { x=345; y=357; width=runserver(:this:w-70); height=15; font_size=12; style="bold"; fgcolor="red"; text="(Negative values not recomended)"; } + t12t6 "widget/tab" + { + x = 260; y = 380; + width = runserver(:this:w); height = runserver(:this:h); + tab_location = runserver(:this:tloc); + tab_width = 80; + + background = "/sys/images/slate2.gif"; + inactive_background = "/sys/images/slate2_dark.gif"; + selected = t12t62; + tab_spacing = -16; + + t12t61 "widget/tabpage" { title = "First"; t12t61l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Label One"; } } + t12t62 "widget/tabpage" { title = "Looong Tab"; t12t62l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Label Two"; } } + t12t63 "widget/tabpage" { title = "S"; t12t63l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Label Three"; } } + t12t64 "widget/tabpage" { title = "Last Tab"; t12t64l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Label Four"; } } + + t12t6c "widget/connector" + { + event = TabChanged; + action = SetTab; + target = t12t2; + TabIndex = runclient(:t12t6:selected_index); + } + } + } + + t13 "widget/tabpage" + { + title = "Tab Height"; + + t13l0 "widget/label" { x=20; y=20; width=400; height=40; font_size=24; text="Tab Height"; } + + t13l1 "widget/label" { x=30; y=75; width=runserver(:this:w-20); height=40; font_size=16; style="bold"; text="Default (24px)"; } + t13t1 "widget/tab" + { + x = 20; y = 100; + width = runserver(:this:w); height = runserver(:this:h); + tab_location = runserver(:this:tloc); + tab_width = 80; + + background = "/sys/images/slate2.gif"; + inactive_background = "/sys/images/slate2_dark.gif"; + selected_index = 2; + + t13t11 "widget/tabpage" { title = "First"; t13t11l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Tab One"; } } + t13t12 "widget/tabpage" { title = "Looong Tab"; t13t12l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Tab Two"; } } + t13t13 "widget/tabpage" { title = "S"; t13t13l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Tab Three"; } } + t13t14 "widget/tabpage" { title = "Last Tab"; t13t14l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Tab Four"; } } + + t13t1c "widget/connector" + { + event = TabChanged; + action = SetTab; + target = t13t3; + TabIndex = runclient(:t13t1:selected_index); + } + } + + t13l2 "widget/label" { x=270; y=75; width=runserver(:this:w-20); height=40; font_size=16; style="bold"; text="No Tab Height"; } + t13l2a "widget/label" + { + x = 270; y = 110; + width = runserver(:this:w-20); height = runserver(:this:h - 20); + font_size = 24; style = bold; fgcolor = "red"; + text = "Not allowed"; + } + + t13l2b "widget/label" + { + x = 270; y = 140; + width = runserver(:this:w-20); height = 30; + font_size = 18; style = italic; fgcolor = "red"; + text = "Because I hate fun."; + } + + t13l3 "widget/label" { x=30; y=215; width=runserver(:this:w-20); height=40; font_size=16; style="bold"; text="Tab Height 32px"; } + t13t3 "widget/tab" + { + x = 20; y = 240; + width = runserver(:this:w); height = runserver(:this:h); + tab_location = runserver(:this:tloc); + tab_width = 80; + + background = "/sys/images/slate2.gif"; + inactive_background = "/sys/images/slate2_dark.gif"; + selected_index = 2; + tab_height = 32; + + t13t31 "widget/tabpage" { title = "First"; t13t31l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Tab One"; } } + t13t32 "widget/tabpage" { title = "Looong Tab"; t13t32l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Tab Two"; } } + t13t33 "widget/tabpage" { title = "S"; t13t33l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Tab Three"; } } + t13t34 "widget/tabpage" { title = "Last Tab"; t13t34l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Tab Four"; } } + + t13t3c "widget/connector" + { + event = TabChanged; + action = SetTab; + target = t13t4; + TabIndex = runclient(:t13t3:selected_index); + } + } + + t13l4 "widget/label" { x=270; y=215; width=runserver(:this:w-20); height=40; font_size=16; style="bold"; text="Tab Height 48px"; } + t13t4 "widget/tab" + { + x = 260; y = 240; + width = runserver(:this:w); height = runserver(:this:h); + tab_location = runserver(:this:tloc); + tab_width = 80; + + background = "/sys/images/slate2.gif"; + inactive_background = "/sys/images/slate2_dark.gif"; + selected = t13t42; + tab_height = 48; + + t13t41 "widget/tabpage" { title = "First"; t13t41l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Label One"; } } + t13t42 "widget/tabpage" { title = "Looong Tab"; t13t42l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Label Two"; } } + t13t43 "widget/tabpage" { title = "S"; t13t43l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Label Three"; } } + t13t44 "widget/tabpage" { title = "Last Tab"; t13t44l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Label Four"; } } + + t13t4c "widget/connector" + { + event = TabChanged; + action = SetTab; + target = t13t5; + TabIndex = runclient(:t13t4:selected_index); + } + } + + t13l5 "widget/label" { x=30; y=355; width=60; height=20; font_size=16; style="bold"; text="Tab Height 16px"; } + t13l5a "widget/label" { x=90; y=357; width=runserver(:this:w-80); height=15; font_size=12; style="bold"; fgcolor="red"; text="(Negative values not supported)"; } + t13t5 "widget/tab" + { + x = 20; y = 380; + width = runserver(:this:w); height = runserver(:this:h); + tab_location = runserver(:this:tloc); + tab_width = 80; + + background = "/sys/images/slate2.gif"; + inactive_background = "/sys/images/slate2_dark.gif"; + selected_index = 2; + tab_height = 16; + + t13t51 "widget/tabpage" { title = "First"; t13t51l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Tab One"; } } + t13t52 "widget/tabpage" { title = "Looong Tab"; t13t52l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Tab Two"; } } + t13t53 "widget/tabpage" { title = "S"; t13t53l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Tab Three"; } } + t13t54 "widget/tabpage" { title = "Last Tab"; t13t54l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Tab Four"; } } + + t13t5c "widget/connector" + { + event = TabChanged; + action = SetTab; + target = t13t6; + TabIndex = runclient(:t13t5:selected_index); + } + } + + t13l6 "widget/label" { x=270; y=355; width=60; height=20; font_size=16; style="bold"; text="Tab Spacing 8px"; } + t13l6a "widget/label" { x=335; y=357; width=runserver(:this:w-80); height=15; font_size=12; style="bold"; fgcolor="red"; text="(Negative values not supported)"; } + t13t6 "widget/tab" + { + x = 260; y = 380; + width = runserver(:this:w); height = runserver(:this:h); + tab_location = runserver(:this:tloc); + tab_width = 80; + + background = "/sys/images/slate2.gif"; + inactive_background = "/sys/images/slate2_dark.gif"; + selected = t13t62; + tab_height = 8; + + t13t61 "widget/tabpage" { title = "First"; t13t61l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Label One"; } } + t13t62 "widget/tabpage" { title = "Looong Tab"; t13t62l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Label Two"; } } + t13t63 "widget/tabpage" { title = "S"; t13t63l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Label Three"; } } + t13t64 "widget/tabpage" { title = "Last Tab"; t13t64l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Label Four"; } } + + t13t6c "widget/connector" + { + event = TabChanged; + action = SetTab; + target = t13t1; + TabIndex = runclient(:t13t6:selected_index); + } + } + } + + + t14 "widget/tabpage" + { + title = "Selection Offsets"; + + t14l0 "widget/label" { x=20; y=20; width=400; height=40; font_size=24; text="Selection Offsets"; } + + t14l1 "widget/label" { x=30; y=75; width=220; height=40; font_size=16; style="bold"; text="Default"; } + t14t1 "widget/tab" + { + x = 20; y = 100; + width = runserver(:this:w); height = runserver(:this:h); + tab_location = runserver(:this:tloc); + tab_width = 80; + + background = "/sys/images/slate2.gif"; + inactive_background = "/sys/images/slate2_dark.gif"; + selected_index = 2; + + t14t11 "widget/tabpage" { title = "First"; t14t11l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Tab One"; } } + t14t12 "widget/tabpage" { title = "Looong Tab"; t14t12l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Tab Two"; } } + t14t13 "widget/tabpage" { title = "S"; t14t13l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Tab Three"; } } + t14t14 "widget/tabpage" { title = "Last Tab"; t14t14l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Tab Four"; } } + + t14t1c "widget/connector" + { + event = TabChanged; + action = SetTab; + target = t14t2; + TabIndex = runclient(:t14t1:selected_index); + } + } + + t14l2 "widget/label" { x=270; y=75; width=220; height=40; font_size=16; style="bold"; text="No Translation"; } + t14t2 "widget/tab" + { + x = 260; y = 100; + width = runserver(:this:w); height = runserver(:this:h); + tab_location = runserver(:this:tloc); + tab_width = 80; + + background = "/sys/images/slate2.gif"; + inactive_background = "/sys/images/slate2_dark.gif"; + selected = t14t22; + select_translate_along = 0; + select_translate_out = 0; + + t14t21 "widget/tabpage" { title = "First"; t14t21l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Label One"; } } + t14t22 "widget/tabpage" { title = "Looong Tab"; t14t22l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Label Two"; } } + t14t23 "widget/tabpage" { title = "S"; t14t23l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Label Three"; } } + t14t24 "widget/tabpage" { title = "Last Tab"; t14t24l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Label Four"; } } + + t14t2c "widget/connector" + { + event = TabChanged; + action = SetTab; + target = t14t3; + TabIndex = runclient(:t14t2:selected_index); + } + } + + t14l3 "widget/label" { x=30; y=215; width=220; height=40; font_size=16; style="bold"; text="Along 8"; } + t14t3 "widget/tab" + { + x = 20; y = 240; + width = runserver(:this:w); height = runserver(:this:h); + tab_location = runserver(:this:tloc); + tab_width = 80; + + background = "/sys/images/slate2.gif"; + inactive_background = "/sys/images/slate2_dark.gif"; + selected_index = 2; + select_translate_along = 8; + select_translate_out = 0; + + t14t31 "widget/tabpage" { title = "First"; t14t31l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Tab One"; } } + t14t32 "widget/tabpage" { title = "Looong Tab"; t14t32l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Tab Two"; } } + t14t33 "widget/tabpage" { title = "S"; t14t33l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Tab Three"; } } + t14t34 "widget/tabpage" { title = "Last Tab"; t14t34l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Tab Four"; } } + + t14t3c "widget/connector" + { + event = TabChanged; + action = SetTab; + target = t14t4; + TabIndex = runclient(:t14t3:selected_index); + } + } + + t14l4 "widget/label" { x=270; y=215; width=220; height=40; font_size=16; style="bold"; text="Out 8"; } + t14t4 "widget/tab" + { + x = 260; y = 240; + width = runserver(:this:w); height = runserver(:this:h); + tab_location = runserver(:this:tloc); + tab_width = 80; + + background = "/sys/images/slate2.gif"; + inactive_background = "/sys/images/slate2_dark.gif"; + selected = t14t42; + select_translate_along = 0; + select_translate_out = 8; + + t14t41 "widget/tabpage" { title = "First"; t14t41l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Label One"; } } + t14t42 "widget/tabpage" { title = "Looong Tab"; t14t42l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Label Two"; } } + t14t43 "widget/tabpage" { title = "S"; t14t43l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Label Three"; } } + t14t44 "widget/tabpage" { title = "Last Tab"; t14t44l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Label Four"; } } + + t14t4c "widget/connector" + { + event = TabChanged; + action = SetTab; + target = t14t5; + TabIndex = runclient(:t14t4:selected_index); + } + } + + t14l5 "widget/label" { x=30; y=355; width=30; height=40; font_size=16; style="bold"; text="Along -8"; } + t14l5a "widget/label" { x=67; y=357; width=100; height=40; font_size=12; style="bold"; fgcolor="red"; text="(Negative values not recomended)"; } + t14t5 "widget/tab" + { + x = 20; y = 380; + width = runserver(:this:w); height = runserver(:this:h); + tab_location = runserver(:this:tloc); + tab_width = 80; + + background = "/sys/images/slate2.gif"; + inactive_background = "/sys/images/slate2_dark.gif"; + selected_index = 2; + select_translate_along = -8; + select_translate_out = 0; + + t14t51 "widget/tabpage" { title = "First"; t14t51l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Tab One"; } } + t14t52 "widget/tabpage" { title = "Looong Tab"; t14t52l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Tab Two"; } } + t14t53 "widget/tabpage" { title = "S"; t14t53l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Tab Three"; } } + t14t54 "widget/tabpage" { title = "Last Tab"; t14t54l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Tab Four"; } } + + t14t5c "widget/connector" + { + event = TabChanged; + action = SetTab; + target = t14t6; + TabIndex = runclient(:t14t5:selected_index); + } + } + + t14l6 "widget/label" { x=270; y=355; width=30; height=40; font_size=16; style="bold"; text="Out -8"; } + t14l6a "widget/label" { x=307; y=357; width=100; height=40; font_size=12; style="bold"; fgcolor="red"; text="(Negative values not recomended)"; } + t14t6 "widget/tab" + { + x = 260; y = 380; + width = runserver(:this:w); height = runserver(:this:h); + tab_location = runserver(:this:tloc); + tab_width = 80; + + background = "/sys/images/slate2.gif"; + inactive_background = "/sys/images/slate2_dark.gif"; + selected = t14t62; + select_translate_along = 0; + select_translate_out = -8; + + t14t61 "widget/tabpage" { title = "First"; t14t61l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Label One"; } } + t14t62 "widget/tabpage" { title = "Looong Tab"; t14t62l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Label Two"; } } + t14t63 "widget/tabpage" { title = "S"; t14t63l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Label Three"; } } + t14t64 "widget/tabpage" { title = "Last Tab"; t14t64l "widget/label" { x=10; y=10; width=100; height=32; font_size=18; fgcolor="#00065f"; text="Label Four"; } } + + t14t6c "widget/connector" + { + event = TabChanged; + action = SetTab; + target = t14t1; + TabIndex = runclient(:t14t6:selected_index); + } + } + } + } + } \ No newline at end of file From 44499c35b83e866e50cf29614a2c478bf1284352 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Mon, 9 Feb 2026 12:11:27 -0700 Subject: [PATCH 086/275] Fix a bug in the textbutton widget that broke responsiveness. --- centrallix-os/sys/js/htdrv_textbutton.js | 1 - 1 file changed, 1 deletion(-) diff --git a/centrallix-os/sys/js/htdrv_textbutton.js b/centrallix-os/sys/js/htdrv_textbutton.js index d053453b1..bca2a6595 100644 --- a/centrallix-os/sys/js/htdrv_textbutton.js +++ b/centrallix-os/sys/js/htdrv_textbutton.js @@ -205,7 +205,6 @@ function tb_setmode(layer,mode) switch(mode) { case 0: /* no point no click */ - moveTo(layer,layer.orig_x,layer.orig_y); $(layer).find(".cell").css({'border-style':'solid', 'border-color':'transparent'}); /*if(cx__capabilities.Dom2CSS) { From b291e5a51dba3ca16918b2b02e1d2e0b8dc80018 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Mon, 9 Feb 2026 12:18:56 -0700 Subject: [PATCH 087/275] Make datetime widget responsive. Update C to generate responsive CSS rules. Replace JS .w and .h values with getters that return the current height and width. Add a JS resize handler that updates open datetime dropdowns when the page is resized. --- centrallix-os/sys/js/htdrv_datetime.js | 25 ++++++++++++-- centrallix/htmlgen/htdrv_datetime.c | 45 ++++++++++++++++++++++---- 2 files changed, 61 insertions(+), 9 deletions(-) diff --git a/centrallix-os/sys/js/htdrv_datetime.js b/centrallix-os/sys/js/htdrv_datetime.js index c333f6446..88535c015 100644 --- a/centrallix-os/sys/js/htdrv_datetime.js +++ b/centrallix-os/sys/js/htdrv_datetime.js @@ -163,7 +163,6 @@ function dt_init(param){ htr_init_layer(c2,l,'dt'); //dt_tag_images(l.document, 'dt', l); htutil_tag_images(l,'dt',l,l); - l.w = w; l.h = h; l.bg = htr_extract_bgcolor(bg); l.ubg = bg; l.fg = param.foreground; @@ -200,7 +199,29 @@ function dt_init(param){ else l.form = wgtrFindContainer(l,"widget/form"); if (l.form) l.form.Register(l); - pg_addarea(l, -1, -1, getClipWidth(l)+3, getClipHeight(l)+3, 'dt', 'dt', 3); + + // Setup getters widths and heights. + l.__defineGetter__('w', () => parseInt(getComputedStyle(l).width)); + l.__defineGetter__('h', () => parseInt(getComputedStyle(l).height)); + + /** Setup the hover area. **/ + l.area = pg_addarea(l, -1, -1, l.w + 3, l.h + 3, 'dt', 'dt', 3); + l.area.__defineGetter__('width', () => l.w + 3); + l.area.__defineGetter__('height', () => l.h + 3); + + // Resize date selection dropdown automatically. + const resize_handler = (layer) => + { + if (layer.PaneLayer && htr_getvisibility(layer.PaneLayer) === 'inherit') + { + dt_collapse(layer); + dt_expand(layer); + } + }; + const resize_observer = new ResizeObserver(entries => { + for (const entry of entries) resize_handler(entry.target); + }); + resize_observer.observe(l); // Events ifc_init_widget(l); diff --git a/centrallix/htmlgen/htdrv_datetime.c b/centrallix/htmlgen/htdrv_datetime.c index 703ccbf5f..2161cda7b 100644 --- a/centrallix/htmlgen/htdrv_datetime.c +++ b/centrallix/htmlgen/htdrv_datetime.c @@ -203,10 +203,42 @@ htdtRender(pHtSession s, pWgtrNode tree, int z) else strcpy(fgcolor,"black"); - /** Ok, write the style header items. **/ - htrAddStylesheetItem_va(s,"\t#dt%POSbtn { OVERFLOW:hidden; POSITION:absolute; VISIBILITY:inherit; LEFT:%INTpx; TOP:%INTpx; WIDTH:%POSpx; HEIGHT:%POSpx; Z-INDEX:%POS; cursor:default; border:1px outset #e0e0e0; %STR }\n",id,x,y,w,h,z, bgcolor); - htrAddStylesheetItem_va(s,"\t#dt%POScon1 { OVERFLOW:hidden; POSITION:absolute; VISIBILITY:inherit; LEFT:1px; TOP:1px; WIDTH:%POSpx; HEIGHT:%POSpx; Z-INDEX:%POS; }\n",id,w-20,h-2,z+1); - htrAddStylesheetItem_va(s,"\t#dt%POScon2 { OVERFLOW:hidden; POSITION:absolute; VISIBILITY:hidden; LEFT:1px; TOP:1px; WIDTH:%POSpx; HEIGHT:%POSpx; Z-INDEX:%POS; }\n",id,w-20,h-2,z+1); + /** Write style headers. **/ + htrAddStylesheetItem_va(s, + "\t#dt%POSbtn { " + "overflow:hidden; " + "position:absolute; " + "visibility:inherit; " + "left:"ht_flex_format"; " + "top:"ht_flex_format"; " + "width:"ht_flex_format"; " + "height:"ht_flex_format"; " + "z-index:%POS; " + "cursor:default; " + "border:1px outset #e0e0e0; " + "%STR " + "}\n", + id, + ht_flex_x(x, tree), + ht_flex_y(y, tree), + ht_flex_w(w, tree), + ht_flex_h(h, tree), + z, + bgcolor + ); + htrAddStylesheetItem_va(s, + "\t.dt%POScon { " + "overflow:hidden; " + "position:absolute; " + "left:1px; " + "top:1px; " + "width:calc(100%% - 20px); " + "height:calc(100%% - 2px); " + "z-index:%POS; " + "}\n", + id, + z + 1 + ); /** Write named global **/ htrAddScriptGlobal(s, "dt_current", "null", 0); @@ -246,8 +278,8 @@ htdtRender(pHtSession s, pWgtrNode tree, int z) htrAddBodyItem_va(s," \n",w-2); htrAddBodyItem(s, " \n"); htrAddBodyItem(s, "\n");*/ - htrAddBodyItem_va(s,"
\n",id); - htrAddBodyItem_va(s,"
\n",id); + htrAddBodyItem_va(s,"
\n", id, id); + htrAddBodyItem_va(s,"\n", id, id); htrAddBodyItem(s, "
\n"); /** Add the event handling scripts **/ @@ -301,4 +333,3 @@ htdtInitialize() return 0; } - From 32c24e3994df6bc2897f5f2eb5f724e0f169bbef Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Mon, 9 Feb 2026 12:19:38 -0700 Subject: [PATCH 088/275] Make dropdown widget responsive. Clean up responsive CSS style generation in the C code. Replace numbers for dropdown modes with #define macros. Replace JS .w and .h values with getters that return the current height and width. Add a JS resize handler that updates open dropdowns when the page is resized. Add dd_remove_pane() to delete DOM nodes for the dropdown pane. Fix a DOM node leak in dd_colapse() by calling dd_remove_pane(). Add another resize observer to ensure that HidLayer responds properly. --- centrallix-os/sys/js/htdrv_dropdown.js | 78 +++++++++++++++- centrallix/htmlgen/htdrv_dropdown.c | 120 +++++++++++++++---------- 2 files changed, 147 insertions(+), 51 deletions(-) diff --git a/centrallix-os/sys/js/htdrv_dropdown.js b/centrallix-os/sys/js/htdrv_dropdown.js index b3a23a8db..b3e0734c1 100644 --- a/centrallix-os/sys/js/htdrv_dropdown.js +++ b/centrallix-os/sys/js/htdrv_dropdown.js @@ -390,6 +390,9 @@ function dd_collapse(l) //pg_resize_area(l.area,getClipWidth(l)+1,getClipHeight(l)+1, -1, -1); htr_setvisibility(l.PaneLayer, 'hidden'); dd_current = null; + + /** Remove the pane to avoid leaking DOM nodes. **/ + dd_remove_pane(l); } } @@ -511,6 +514,17 @@ function dd_select_item(l,i,from) moveTo(l.HidLayer, 2, ((l.h-2) - pg_parah)/2); resizeTo(l.HidLayer, l.w, l.h); + // Set up responsive handling. + if (!l.HidLayer.resize_observer) + { + const { HidLayer } = l; + const resize_observer = HidLayer.resize_observer = new ResizeObserver(_ => { + moveTo(HidLayer, 2, ((l.h - 2) - pg_parah) / 2); + resizeTo(HidLayer, l.w, l.h); + }); + resize_observer.observe(l); + } + htr_setvisibility(l.HidLayer, 'inherit'); setClipWidth(l.HidLayer, l.w-21); htr_setvisibility(l.VisLayer, 'hidden'); @@ -775,6 +789,41 @@ function dd_create_pane(l) return p; } +/** Quick and dirty function to remove panes without leaking DOM nodes. **/ +function dd_remove_pane(l) + { + if (!l || !l.PaneLayer) return; + + const p = l.PaneLayer; + + // Function for removing elements. + const remove_node = (n) => { if (n && n.parentNode) n.parentNode.removeChild(n); } + + // Remove item DOM nodes if present. + if (l.Items && l.Items.length) + { + for (let i = 0; i < l.Items.length; i++) + { + remove_node(l.Items[i]); + l.Items[i] = null; + } + l.Items.length = 0; + l.Items = null; + } + + // Remove scrollbar/thumb layers if present. + remove_node(p.ScrLayer); + remove_node(p.BarLayer); + remove_node(p.TmbLayer); + + // Remove the pane root. + remove_node(p); + + // Clear references. + p.ScrLayer = p.BarLayer = p.TmbLayer = p.Items = p.mainlayer = null; + l.PaneLayer = null; + } + /// REPLACE ITEMS IN DROPDOWN function dd_add_items(l,ary) @@ -1194,7 +1243,6 @@ function dd_init(param) l.NumDisplay = param.numDisplay; l.Mode = param.mode; l.SQL = param.sql; - l.popup_width = param.popup_width?param.popup_width:param.width; l.VisLayer = param.c1; l.HidLayer = param.c2; htr_init_layer(l.VisLayer, l, 'ddtxt'); @@ -1244,7 +1292,6 @@ function dd_init(param) l.getfocushandler = dd_getfocus; l.bg = param.background; l.hl = param.highlight; - l.w = param.width; l.h = param.height; l.fieldname = param.fieldname; l.enabled = 'full'; if (l.Mode != 3) @@ -1268,11 +1315,34 @@ function dd_init(param) else if (imgs[i].src.substr(-13,5) == 'white') imgs[i].upimg = true; } - l.area = pg_addarea(l, -1, -1, getClipWidth(l)+3, - getClipHeight(l)+3, 'dd', 'dd', 3); if (l.form) l.form.Register(l); l.init_items = false; + // Setup getters widths and heights. + const width_ratio = param.popup_width / param.width; + l.__defineGetter__('w', () => parseInt(getComputedStyle(l).width)); + l.__defineGetter__('h', () => parseInt(getComputedStyle(l).height)); + l.__defineGetter__('popup_width', () => l.w * width_ratio); + + /** Setup the hover area. **/ + l.area = pg_addarea(l, -1, -1, l.w + 3, l.h + 3, 'dd', 'dd', 3); + l.area.__defineGetter__('width', () => l.w + 3); + l.area.__defineGetter__('height', () => l.h + 3); + + // Resize dropdown automatically. + const resize_handler = (layer) => + { + if (layer.PaneLayer && htr_getvisibility(layer.PaneLayer) === 'inherit') + { + dd_collapse(layer); + dd_expand(layer); + } + }; + const resize_observer = new ResizeObserver(entries => { + for (const entry of entries) resize_handler(entry.target); + }); + resize_observer.observe(l); + // Events var ie = l.ifcProbeAdd(ifEvent); ie.Add("MouseDown"); diff --git a/centrallix/htmlgen/htdrv_dropdown.c b/centrallix/htmlgen/htdrv_dropdown.c index 7f16bcbe5..f2af95d00 100644 --- a/centrallix/htmlgen/htdrv_dropdown.c +++ b/centrallix/htmlgen/htdrv_dropdown.c @@ -46,6 +46,12 @@ static struct { int idcnt; } HTDD; +/** Dropdown modes. **/ +#define HTDD_STATIC 0 +#define HTDD_DYNAMIC_SERVER 1 +#define HTDD_DYNAMIC 2 +#define HTDD_DYNAMIC_CLIENT HTDD_DYNAMIC +#define HTDD_OBJECTSOURCE 3 /* htddRender - generate the HTML code for the page. @@ -144,7 +150,7 @@ int htddRender(pHtSession s, pWgtrNode tree, int z) { if (wgtrGetPropertyValue(tree,"name",DATA_T_STRING,POD(&ptr)) != 0) return -1; strtcpy(name,ptr,sizeof(name)); - /** Ok, write the style header items. **/ + /** Write basic element CSS. **/ htrAddStylesheetItem_va(s, "\t#dd%POSbtn { " "OVERFLOW:hidden; " @@ -160,10 +166,10 @@ int htddRender(pHtSession s, pWgtrNode tree, int z) { "border:1px outset #e0e0e0; " "}\n", id, - ht_flex(x, ht_get_total_w(tree), ht_get_fl_x(tree)), - ht_flex(y, ht_get_total_h(tree), ht_get_fl_y(tree)), - ht_flex(w, ht_get_total_w(tree), ht_get_fl_w(tree)), - ht_flex(h, ht_get_total_h(tree), ht_get_fl_h(tree)), + ht_flex_x(x, tree), + ht_flex_y(y, tree), + ht_flex_w(w, tree), + ht_flex_h(h, tree), z, bgstr ); @@ -171,35 +177,18 @@ int htddRender(pHtSession s, pWgtrNode tree, int z) { htrAddStylesheetItem_va(s,"\t#dd%POSbtn { color: %STR&CSSVAL; }\n",id,textcolor); } htrAddStylesheetItem_va(s, - "\t#dd%POScon1 { " - "OVERFLOW:hidden; " - "POSITION:absolute; " - "VISIBILITY:inherit; " - "LEFT:1px; " - "TOP:1px; " - "WIDTH:1024px; " - "HEIGHT:"ht_flex_format"; " - "Z-INDEX:%POS; " + "\t.dd%POScon { " + "overflow:hidden; " + "position:absolute; " + "left:1px; " + "top:1px; " + "width:1024px; " + "height:"ht_flex_format"; " + "z-index:%POS; " "}\n", id, - ht_flex(h-2, h, 0.0), - z+1 - ); - /** I have no idea why we need dd#con2. It's hidden by default. **/ - htrAddStylesheetItem_va(s, - "\t#dd%POScon2 { " - "OVERFLOW:hidden; " - "POSITION:absolute; " - "VISIBILITY:hidden; " - "LEFT:1px; " - "TOP:1px; " - "WIDTH:1024px; " - "HEIGHT:"ht_flex_format"; " - "Z-INDEX:%POS; " - "}\n", - id, - ht_flex(h-2, h, 0.0), - z+1 + ht_flex(h - 2, h, 0.0), + z + 1 ); htrAddScriptGlobal(s, "dd_current", "null", 0); @@ -228,20 +217,20 @@ int htddRender(pHtSession s, pWgtrNode tree, int z) { /** Get the mode (default to 1, dynamicpage) **/ - mode = 0; + mode = HTDD_STATIC; if (wgtrGetPropertyValue(tree,"mode",DATA_T_STRING,POD(&ptr)) == 0) { - if (!strcmp(ptr,"static")) mode = 0; - else if (!strcmp(ptr,"dynamic_server")) mode = 1; - else if (!strcmp(ptr,"dynamic")) mode = 2; - else if (!strcmp(ptr,"dynamic_client")) mode = 2; - else if (!strcmp(ptr,"objectsource")) mode = 3; + if (strcmp(ptr, "static") == 0) mode = HTDD_STATIC; + else if (strcmp(ptr, "dynamic_server") == 0) mode = HTDD_DYNAMIC_SERVER; + else if (strcmp(ptr, "dynamic") == 0) mode = HTDD_DYNAMIC; + else if (strcmp(ptr, "dynamic_client") == 0) mode = HTDD_DYNAMIC_CLIENT; + else if (strcmp(ptr, "objectsource") == 0) mode = HTDD_OBJECTSOURCE; else { - mssError(1,"HTDD","Dropdown widget has not specified a valid mode."); + mssError(1, "HTDD", "Invalid dropdown widget 'mode' value: \"%s\"", ptr); return -1; } } - sql = 0; + sql = NULL; if (wgtrGetPropertyValue(tree,"sql",DATA_T_STRING,POD(&sql)) != 0 && mode != 0 && mode != 3) { mssError(1, "HTDD", "SQL parameter was not specified for dropdown widget"); return -1; @@ -249,7 +238,43 @@ int htddRender(pHtSession s, pWgtrNode tree, int z) { htrCheckAddExpression(s,tree,name,"sql"); /** Script initialization call. **/ - htrAddScriptInit_va(s," dd_init({layer:wgtrGetNodeRef(ns,\"%STR&SYM\"), c1:htr_subel(wgtrGetNodeRef(ns,\"%STR&SYM\"), \"dd%POScon1\"), c2:htr_subel(wgtrGetNodeRef(ns,\"%STR&SYM\"), \"dd%POScon2\"), background:'%STR&JSSTR', highlight:'%STR&JSSTR', fieldname:'%STR&JSSTR', numDisplay:%INT, mode:%INT, sql:'%STR&JSSTR', width:%INT, height:%INT, form:'%STR&JSSTR', osrc:'%STR&JSSTR', qms:%INT, ivs:%INT, popup_width:%INT});\n", name, name, id, name, id, bgstr, hilight, fieldname, num_disp, mode, sql?sql:"", w, h, form, osrc, query_multiselect, invalid_select_default, pop_w); + htrAddScriptInit_va(s, + "dd_init({ " + "layer:wgtrGetNodeRef(ns, '%STR&SYM'), " + "c1:htr_subel(wgtrGetNodeRef(ns, '%STR&SYM'), 'dd%POScon1'), " + "c2:htr_subel(wgtrGetNodeRef(ns, '%STR&SYM'), 'dd%POScon2'), " + "background:'%STR&JSSTR', " + "highlight:'%STR&JSSTR', " + "fieldname:'%STR&JSSTR', " + "numDisplay:%INT, " + "mode:%INT, " + "sql:'%STR&JSSTR', " + "form:'%STR&JSSTR', " + "osrc:'%STR&JSSTR', " + "qms:%INT, " + "ivs:%INT, " + "width:%INT, " + "height:%INT, " + "popup_width:%INT, " + "});\n", + name, + name, id, + name, id, + bgstr, + hilight, + fieldname, + num_disp, + mode, + (sql != NULL) ? sql : "", + form, + osrc, + query_multiselect, + invalid_select_default, + w, + ht_get_fl_x(tree), + h, + pop_w + ); /** HTML body
element for the layers. **/ htrAddBodyItem_va(s,"
\n" @@ -265,12 +290,12 @@ int htddRender(pHtSession s, pWgtrNode tree, int z) { htrAddBodyItem_va(s," \n",w-2); htrAddBodyItem(s, " \n"); htrAddBodyItem(s, "\n");*/ - htrAddBodyItem_va(s,"
\n",id); - htrAddBodyItem_va(s,"
\n",id); + htrAddBodyItem_va(s,"
\n", id, id); + htrAddBodyItem_va(s,"\n", id, id); htrAddBodyItem(s, "
\n"); /* Read and initialize the dropdown items */ - if (mode == 1) { + if (mode == HTDD_DYNAMIC_SERVER) { /** The result set from this SQL query can take two forms: positional or named. ** For Positional, the params are: label, value, selected, group, hidden. ** For Named, the above names can appear in any order. @@ -362,7 +387,7 @@ int htddRender(pHtSession s, pWgtrNode tree, int z) { objQueryClose(qy); } } - else if(mode==3) { + else if (mode == HTDD_OBJECTSOURCE) { /* get objects from form */ } @@ -373,7 +398,9 @@ int htddRender(pHtSession s, pWgtrNode tree, int z) { subtree = xaGetItem(&(tree->Children), i); if (!strcmp(subtree->Type, "widget/dropdownitem")) subtree->RenderFlags |= HT_WGTF_NOOBJECT; - if (!strcmp(subtree->Type,"widget/dropdownitem") && mode == 0) + + /** Write JS to render dropdown items in static mode. **/ + if (!strcmp(subtree->Type,"widget/dropdownitem") && mode == HTDD_STATIC) { if (wgtrGetPropertyValue(subtree,"label",DATA_T_STRING,POD(&ptr)) != 0) { @@ -459,4 +486,3 @@ int htddInitialize() { return 0; } - From a7d995881db4939455395bfc6826f8a81de231ef Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Mon, 9 Feb 2026 12:22:10 -0700 Subject: [PATCH 089/275] Make editbox widget responsive. Clean up responsive CSS style generation in the C code. Simplify JS to prevent it breaking the responsive CSS. --- centrallix-os/sys/js/htdrv_editbox.js | 4 +- centrallix/htmlgen/htdrv_editbox.c | 68 +++++++++++++++++---------- 2 files changed, 47 insertions(+), 25 deletions(-) diff --git a/centrallix-os/sys/js/htdrv_editbox.js b/centrallix-os/sys/js/htdrv_editbox.js index 160ce0bdf..df6579be7 100644 --- a/centrallix-os/sys/js/htdrv_editbox.js +++ b/centrallix-os/sys/js/htdrv_editbox.js @@ -162,8 +162,10 @@ function eb_setdesc(txt) ({ "z-index":"-1", "color":this.desc_fgcolor?this.desc_fgcolor:"#808080", - "top":($(this).height() - $(this.DescLayer).height())/2 + "px", + "top":"0px", "left":(this.input_width() + ((this.content || this.has_focus)?4:0) + 5) + "px", + "height":"100%", + "align-content":"center", "visibility":"inherit", "white-space":"nowrap", }); diff --git a/centrallix/htmlgen/htdrv_editbox.c b/centrallix/htmlgen/htdrv_editbox.c index ef40c8d8a..f4b85c397 100644 --- a/centrallix/htmlgen/htdrv_editbox.c +++ b/centrallix/htmlgen/htdrv_editbox.c @@ -149,34 +149,36 @@ htebRender(pHtSession s, pWgtrNode tree, int z) box_offset = 0; /** Ok, write the style header items. **/ + const int base_w = w - (2 * box_offset); htrAddStylesheetItem_va(s, "\t#eb%POSbase { " - "POSITION:absolute; " - "VISIBILITY:inherit; " - "LEFT:"ht_flex_format"; " - "TOP:"ht_flex_format"; " - "WIDTH:"ht_flex_format"; " - "Z-INDEX:%POS; " + "position:absolute; " + "visibility:inherit; " "overflow:hidden; " + "left:"ht_flex_format"; " + "top:"ht_flex_format"; " + "width:"ht_flex_format"; " + "z-index:%POS; " "}\n", id, - ht_flex(x, ht_get_total_w(tree), ht_get_fl_x(tree)), - ht_flex(y, ht_get_total_h(tree), ht_get_fl_y(tree)), - ht_flex(w - 2 * box_offset, ht_get_total_w(tree), ht_get_fl_w(tree)), + ht_flex(x, ht_get_parent_w(tree), ht_get_fl_x(tree)), + ht_flex(y, ht_get_parent_h(tree), ht_get_fl_y(tree)), + ht_flex(base_w, ht_get_parent_w(tree), ht_get_fl_w(tree)), z ); htrAddStylesheetItem_va(s, "\t#eb%POScon1 { " - "VISIBILITY:inherit; " - "LEFT:5px; " - "TOP:0px; " - "WIDTH:"ht_flex_format"; " - "Z-INDEX:%POS; " + "position:absolute; " + "visibility:inherit; " + "left:5px; " + "top:0px; " + "width:calc(100%% - 10px); " + "height:100%%; " "border:none; " + "z-index:%POS; " "}\n", id, - ht_flex(w - 10, ht_get_total_w(tree), ht_get_fl_w(tree)), - z+1 + z + 1 ); /** Write named global **/ @@ -200,10 +202,28 @@ htebRender(pHtSession s, pWgtrNode tree, int z) htrAddEventHandlerFunction(s, "document","PASTE", "eb", "eb_paste"); /** Script initialization call. **/ - htrAddScriptInit_va(s, " eb_init({layer:wgtrGetNodeRef(ns,'%STR&SYM'), c1:document.getElementById(\"eb%POScon1\"), form:\"%STR&JSSTR\", fieldname:\"%STR&JSSTR\", isReadOnly:%INT, mainBackground:\"%STR&JSSTR\", tooltip:\"%STR&JSSTR\", desc_fgcolor:\"%STR&JSSTR\", empty_desc:\"%STR&JSSTR\"});\n", - name, id, - form, fieldname, is_readonly, main_bg, - tooltip, descfg, descr); + htrAddScriptInit_va(s, + "eb_init({ " + "layer:wgtrGetNodeRef(ns,'%STR&SYM'), " + "c1:document.getElementById('eb%POScon1'), " + "form:'%STR&JSSTR', " + "fieldname:'%STR&JSSTR', " + "isReadOnly:%INT, " + "mainBackground:'%STR&JSSTR', " + "tooltip:'%STR&JSSTR', " + "desc_fgcolor:'%STR&JSSTR', " + "empty_desc:'%STR&JSSTR', " + "});\n", + name, + id, + form, + fieldname, + is_readonly, + main_bg, + tooltip, + descfg, + descr + ); /** HTML body
element for the base layer. **/ htrAddBodyItem_va(s, "
\n",id); @@ -214,12 +234,12 @@ htebRender(pHtSession s, pWgtrNode tree, int z) else htrAddStylesheetItem_va(s,"\t#eb%POSbase { border-style:solid; border-width:1px; border-color: gray white white gray; %STR }\n",id, main_bg); if (h >= 0) + { htrAddStylesheetItem_va(s, - "\t#eb%POSbase { height:"ht_flex_format"; }\n" - "\t#eb%POScon1 { height:"ht_flex_format"; }\n", - id, ht_flex(h - 2 * box_offset, ht_get_total_h(tree), ht_get_fl_h(tree)), - id, ht_flex(h - 2 * box_offset - 2, ht_get_total_h(tree), ht_get_fl_h(tree)) + "\t#eb%POSbase { height:"ht_flex_format"; }\n", + id, ht_flex(h - (2 * box_offset), ht_get_parent_h(tree), ht_get_fl_h(tree)) ); + } //htrAddBodyItem_va(s, "
 
\n", w-2, h-2); //htrAddBodyItem_va(s, "
\n",id); From bf0987e58ad347f8a26bc5dc422fb5a6b472c486 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Mon, 9 Feb 2026 12:22:35 -0700 Subject: [PATCH 090/275] Make formstatus widget responsive. --- centrallix/htmlgen/htdrv_formstatus.c | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/centrallix/htmlgen/htdrv_formstatus.c b/centrallix/htmlgen/htdrv_formstatus.c index 33258e3c1..b4b0d504c 100644 --- a/centrallix/htmlgen/htdrv_formstatus.c +++ b/centrallix/htmlgen/htdrv_formstatus.c @@ -89,7 +89,22 @@ int htfsRender(pHtSession s, pWgtrNode tree, int z) { htrAddWgtrObjLinkage_va(s, tree, "fs%POSmain", id); /** Ok, write the style header items. **/ - htrAddStylesheetItem_va(s,"\t#fs%POSmain { POSITION:absolute; VISIBILITY:inherit; LEFT:%INTpx; TOP:%INTpx; HEIGHT:13px; WIDTH:%POSpx; Z-INDEX:%POS; }\n",id,x,y,w,z); + htrAddStylesheetItem_va(s, + "\t#fs%POSmain { " + "position:absolute; " + "visibility:inherit; " + "left:"ht_flex_format"; " + "top:"ht_flex_format"; " + "width:"ht_flex_format"; " + "height:13px; " + "z-index:%POS; " + "}\n", + id, + ht_flex_x(x, tree), + ht_flex_y(y, tree), + ht_flex_w(w, tree), + z + ); htrAddScriptInclude(s, "/sys/js/htdrv_formstatus.js", 0); From 615994b62f23c8430885f027616f03d92b78220a Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Mon, 9 Feb 2026 12:24:39 -0700 Subject: [PATCH 091/275] Make imagebutton widget responsive. Update C generation to create responsive CSS for image button widgets. Disable unnecessary clipping in the imagebutton widget. --- centrallix-os/sys/js/htdrv_imagebutton.js | 1 + centrallix/htmlgen/htdrv_imagebutton.c | 18 +++++++++++++++++- 2 files changed, 18 insertions(+), 1 deletion(-) diff --git a/centrallix-os/sys/js/htdrv_imagebutton.js b/centrallix-os/sys/js/htdrv_imagebutton.js index c3aae6b2a..1122a2303 100644 --- a/centrallix-os/sys/js/htdrv_imagebutton.js +++ b/centrallix-os/sys/js/htdrv_imagebutton.js @@ -211,6 +211,7 @@ function ib_init(param) l.img.kind = 'ib'; l.cursrc = param.n; setClipWidth(l, w); + disableClippingCSS(l); l.trigger = ib_trigger; diff --git a/centrallix/htmlgen/htdrv_imagebutton.c b/centrallix/htmlgen/htdrv_imagebutton.c index 64cfe92eb..3f0bb5390 100644 --- a/centrallix/htmlgen/htdrv_imagebutton.c +++ b/centrallix/htmlgen/htdrv_imagebutton.c @@ -137,7 +137,23 @@ htibtnRender(pHtSession s, pWgtrNode tree, int z) button_repeat = htrGetBoolean(tree, "repeat", 0); /** Ok, write the style header items. **/ - htrAddStylesheetItem_va(s,"\t#ib%POSpane { POSITION:absolute; VISIBILITY:inherit; LEFT:%INTpx; TOP:%INTpx; WIDTH:%POSpx; Z-INDEX:%POS; cursor:pointer; }\n",id,x,y,w,z); + htrAddStylesheetItem_va(s, + "\t#ib%POSpane { " + "position:absolute; " + "visibility:inherit; " + "overflow:hidden;" + "left:"ht_flex_format"; " + "top:"ht_flex_format"; " + "width:"ht_flex_format"; " + "z-index:%POS; " + "cursor:pointer; " + "}\n", + id, + ht_flex_x(x, tree), + ht_flex_y(y, tree), + ht_flex_w(w, tree), + z + ); htrAddScriptGlobal(s, "ib_cur_img", "null", 0); htrAddWgtrObjLinkage_va(s, tree, "ib%POSpane", id); From afe93885fa088d1bc9d80fab8f3370037baecd8a Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Mon, 9 Feb 2026 12:27:39 -0700 Subject: [PATCH 092/275] Make menu widget responsive. Update C generation to create responsive CSS. Update C style for script init. Update JS to only modify CSS when it is not provided in C. --- centrallix-os/sys/js/htdrv_menu.js | 10 ++-- centrallix/htmlgen/htdrv_menu.c | 75 +++++++++++++++++++++++++----- 2 files changed, 69 insertions(+), 16 deletions(-) diff --git a/centrallix-os/sys/js/htdrv_menu.js b/centrallix-os/sys/js/htdrv_menu.js index f517e3948..1c25e62a3 100644 --- a/centrallix-os/sys/js/htdrv_menu.js +++ b/centrallix-os/sys/js/htdrv_menu.js @@ -395,19 +395,21 @@ function mn_init(param) menu.objname = param.name; menu.cur_highlight = null; + // Set up sizing. if (cx__capabilities.CSS2) { if (menu.scrollHeight == 0) { - pg_set_style(menu,'height',menu.childNodes[0].scrollHeight); - pg_set_style(menu,'width',menu.childNodes[0].scrollWidth); + if (param.h === -1) pg_set_style(menu, 'height', menu.childNodes[0].scrollHeight); + if (param.w === -1) pg_set_style(menu, 'width', menu.childNodes[0].scrollWidth); } else { - pg_set_style(menu,'height',menu.scrollHeight); - pg_set_style(menu,'width',menu.scrollWidth); + if (param.h === -1) pg_set_style(menu, 'height', menu.scrollHeight); + if (param.w === -1) pg_set_style(menu, 'width', menu.scrollWidth); } } + disableClippingCSS(menu); menu.act_w = getClipWidth(menu.clayer); menu.act_h = getClipHeight(menu.clayer); if ($(menu).css('visibility') == 'hidden' && (!menu.__WgtrParent.style || $(menu.__WgtrParent).css('visibility') == 'inherit')) diff --git a/centrallix/htmlgen/htdrv_menu.c b/centrallix/htmlgen/htdrv_menu.c index a400c885e..331b8bb92 100644 --- a/centrallix/htmlgen/htdrv_menu.c +++ b/centrallix/htmlgen/htdrv_menu.c @@ -284,21 +284,50 @@ htmenuRender(pHtSession s, pWgtrNode menu, int z) is_popup = htrGetBoolean(menu, "popup", 0); if (is_popup < 0) is_popup = 0; - /** Write the main style header item. **/ - htrAddStylesheetItem_va(s,"\t#mn%POSmain { POSITION:absolute; VISIBILITY:%STR; LEFT:%INTpx; TOP:%INTpx; %[HEIGHT:%POSpx; %]%[WIDTH:%POSpx; %]Z-INDEX:%POS; }\n", id,is_popup?"hidden":"inherit", x, y, h != -1, h-2*bx, w != -1, w-2*bx, z); + /** Write styles for the main DOM element. **/ + htrAddStylesheetItem_va(s, + "\t#mn%POSmain { " + "position:absolute; " + "visibility:%STR; " + "left:"ht_flex_format"; " + "top:"ht_flex_format"; " + "%[height:"ht_flex_format"; %]" + "%[width:"ht_flex_format"; %]" + "z-index:%POS; " + "}\n", + id, + (is_popup) ? "hidden" : "inherit", + ht_flex_x(x, menu), + ht_flex_y(y, menu), + (h != -1), ht_flex_h(h - 2 * bx, menu), + (w != -1), ht_flex_w(w - 2 * bx, menu), + z + ); if (shadow_radius > 0) { htrAddStylesheetItem_va(s,"\t#mn%POSmain { box-shadow: %POSpx %POSpx %POSpx %STR&CSSVAL; }\n", id, shadow_offset, shadow_offset, shadow_radius, shadow_color); } - htrAddStylesheetItem_va(s,"\t#mn%POScontent { POSITION:absolute; VISIBILITY: inherit; LEFT:0px; TOP:0px; %[HEIGHT:%POSpx; %]%[WIDTH:%POSpx; %]Z-INDEX:%POS; }\n", id, h != -1, h-2*bx, w != -1, w-2*bx, z+1); if (s->Capabilities.CSS2) htrAddStylesheetItem_va(s,"\t#mn%POSmain { overflow:hidden; border-style: solid; border-width: 1px; border-color: white gray gray white; color:%STR; %STR }\n", id, textcolor, bgstr); - - /** content layer **/ + + /** Write styles for the content container. **/ + htrAddStylesheetItem_va(s, + "\t#mn%POScontent { " + "position:absolute; " + "visibility:inherit; " + "left:0px; " + "top:0px; " + "height:%%100;" + "width:%%100;" + "z-index:%POS; " + "}\n", + id, + z + 1 + ); if (s->Capabilities.CSS2) htrAddStylesheetItem_va(s,"\t#mn%POScontent { overflow:hidden; cursor:default; }\n", id ); - /** highlight bar **/ + /** Write styles for the highlight bar. **/ htrAddStylesheetItem_va(s, "\t#mn%POShigh { POSITION:absolute; VISIBILITY: hidden; LEFT:0px; TOP:0px; Z-INDEX:%POS; }\n", id, z); if (s->Capabilities.CSS2) htrAddStylesheetItem_va(s,"\t#mn%POShigh { overflow:hidden; }\n", id ); @@ -324,10 +353,34 @@ htmenuRender(pHtSession s, pWgtrNode menu, int z) htrAddScriptInclude(s, "/sys/js/htdrv_menu.js", 0); /** Initialization **/ - htrAddScriptInit_va(s," mn_init({layer:wgtrGetNodeRef(ns,\"%STR&SYM\"), clayer:wgtrGetContainer(wgtrGetNodeRef(ns,\"%STR&SYM\")), hlayer:htr_subel(wgtrGetNodeRef(ns,\"%STR&SYM\"), \"mn%POShigh\"), bgnd:\"%STR&JSSTR\", high:\"%STR&JSSTR\", actv:\"%STR&JSSTR\", txt:\"%STR&JSSTR\", w:%INT, h:%INT, horiz:%INT, pop:%INT, name:\"%STR&SYM\"});\n", - name, name, name, id, - bgstr, highlight, active, textcolor, - w, h, is_horizontal, is_popup, name); + htrAddScriptInit_va(s, + "mn_init({ " + "layer:wgtrGetNodeRef(ns, '%STR&SYM'), " + "clayer:wgtrGetContainer(wgtrGetNodeRef(ns,'%STR&SYM')), " + "hlayer:htr_subel(wgtrGetNodeRef(ns,'%STR&SYM'), 'mn%POShigh'), " + "bgnd:'%STR&JSSTR', " + "high:'%STR&JSSTR', " + "actv:'%STR&JSSTR', " + "txt:'%STR&JSSTR', " + "w:%INT, " + "h:%INT, " + "horiz:%INT, " + "pop:%INT, " + "name:'%STR&SYM', " + "});\n", + name, + name, + name, id, + bgstr, + highlight, + active, + textcolor, + w, + h, + is_horizontal, + is_popup, + name + ); /** Event handlers **/ htrAddEventHandlerFunction(s, "document", "MOUSEMOVE", "mn", "mn_mousemove"); @@ -596,5 +649,3 @@ htmenuInitialize() return 0; } - - From 6277f78435d0971538d38339da5d137b7fe24b00 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Mon, 9 Feb 2026 12:28:11 -0700 Subject: [PATCH 093/275] Make objcanvas widget responsive (sort of). Update C generation to create responsive CSS. Update JS to give an error when creating a new layer, which will probably break responsive design. --- centrallix-os/sys/js/htdrv_objcanvas.js | 1 + centrallix/htmlgen/htdrv_objcanvas.c | 23 ++++++++++++++++++++++- 2 files changed, 23 insertions(+), 1 deletion(-) diff --git a/centrallix-os/sys/js/htdrv_objcanvas.js b/centrallix-os/sys/js/htdrv_objcanvas.js index aeaa1fd1a..b32aa93e1 100644 --- a/centrallix-os/sys/js/htdrv_objcanvas.js +++ b/centrallix-os/sys/js/htdrv_objcanvas.js @@ -113,6 +113,7 @@ function oc_add_osrc_object(o) y = parseInt(y); // make and position the layer + console.error("New layer created. This will probably break responsive design."); var l = this.NewLayer(); htr_init_layer(l, this, 'oc'); l.osrc_oid = o.oid; diff --git a/centrallix/htmlgen/htdrv_objcanvas.c b/centrallix/htmlgen/htdrv_objcanvas.c index 6ff6078e8..5a1150533 100644 --- a/centrallix/htmlgen/htdrv_objcanvas.c +++ b/centrallix/htmlgen/htdrv_objcanvas.c @@ -106,7 +106,28 @@ htocRender(pHtSession s, pWgtrNode oc_node, int z) /** Add css item for the layer **/ if (s->Capabilities.CSS2) - htrAddStylesheetItem_va(s,"\t#oc%POSbase { POSITION:absolute; VISIBILITY:inherit; LEFT:%INTpx; TOP:%INTpx; WIDTH:%POSpx; HEIGHT:%POSpx; Z-INDEX:%POS; overflow: hidden; %STR}\n",id,x,y,w,h,z,main_bg); + { + htrAddStylesheetItem_va(s, + "\t#oc%POSbase { " + "position:absolute; " + "visibility:inherit; " + "overflow:hidden; " + "left:"ht_flex_format"; " + "top:"ht_flex_format"; " + "width:"ht_flex_format"; " + "height:"ht_flex_format"; " + "z-index:%POS; " + "%STR " + "}\n", + id, + ht_flex_x(x, oc_node), + ht_flex_y(y, oc_node), + ht_flex_w(w, oc_node), + ht_flex_h(h, oc_node), + z, + main_bg + ); + } else htrAddStylesheetItem_va(s,"\t#oc%POSbase { POSITION:absolute; VISIBILITY:inherit; LEFT:%INT; TOP:%INT; WIDTH:%POS; HEIGHT:%POS; Z-INDEX:%POS; }\n",id,x,y,w,h,z); From a2f1f1bf841a9c0e5ec4812b8613cd005cd760c5 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Mon, 9 Feb 2026 12:31:26 -0700 Subject: [PATCH 094/275] Make radiobutton pannel widget responsive. Update C generation to create responsive CSS. Remove unnecessary clip rectangle CSS styles. Clean up HTML & CSS generation code. Add width and height getters in JS that return the current width and height of the widget, allowing areas to resize properly. --- centrallix-os/sys/js/htdrv_radiobutton.js | 4 +- centrallix/htmlgen/htdrv_radiobutton.c | 191 +++++++++++++++++----- 2 files changed, 149 insertions(+), 46 deletions(-) diff --git a/centrallix-os/sys/js/htdrv_radiobutton.js b/centrallix-os/sys/js/htdrv_radiobutton.js index 5b106deb9..2d5c9eb77 100644 --- a/centrallix-os/sys/js/htdrv_radiobutton.js +++ b/centrallix-os/sys/js/htdrv_radiobutton.js @@ -152,7 +152,9 @@ function add_radiobutton(optionPane, param) { } optionPane.yOffset = getRelativeY(optionPane)+getRelativeY(rb.coverPane)+getRelativeY(rb.borderPane); - pg_addarea(rb, getRelativeX(optionPane), optionPane.yOffset, getClipWidth(optionPane), pg_parah+4, optionPane, 'rb', 3); + optionPane.area = pg_addarea(rb, getRelativeX(optionPane), optionPane.yOffset, getClipWidth(optionPane), pg_parah+4, optionPane, 'rb', 3); + optionPane.area.__defineGetter__('width', () => parseInt(getComputedStyle(optionPane).width)); + optionPane.area.__defineGetter__('height', () => parseInt(getComputedStyle(optionPane).height)); } function rb_getfocus(xo,yo,l,c,n,a,from_kbd) diff --git a/centrallix/htmlgen/htdrv_radiobutton.c b/centrallix/htmlgen/htdrv_radiobutton.c index c1d395c06..d5258ed5e 100644 --- a/centrallix/htmlgen/htdrv_radiobutton.c +++ b/centrallix/htmlgen/htdrv_radiobutton.c @@ -9,6 +9,7 @@ #include "cxlib/xhash.h" #include "cxlib/mtsession.h" #include "cxlib/strtcpy.h" +#include "cxlib/util.h" /************************************************************************/ /* Centrallix Application Server System */ @@ -61,13 +62,9 @@ int htrbRender(pHtSession s, pWgtrNode tree, int z) { char form[64]; pWgtrNode radiobutton_obj, sub_tree; int x=-1,y=-1,w,h; - int top_offset; - int cover_height, cover_width; - int item_spacing; int id, i, j; int is_selected; - int rb_cnt; - int cover_margin; + int raido_button_count; char fieldname[32]; char value[64]; char label[64]; @@ -137,19 +134,74 @@ int htrbRender(pHtSession s, pWgtrNode tree, int z) { htrAddScriptInclude(s, "/sys/js/htdrv_radiobutton.js", 0); htrAddScriptInclude(s, "/sys/js/ht_utils_layers.js", 0); - /** Ok, write the style header items. **/ - top_offset = s->ClientInfo->ParagraphHeight*3/4+1; - cover_height = h-(top_offset+3+2); - cover_width = w-(2*3 +2); - htrAddStylesheetItem_va(s,"\t#rb%POSparent { POSITION:absolute; VISIBILITY:inherit; LEFT:%INTpx; TOP:%INTpx; WIDTH:%POSpx; HEIGHT:%POSpx; Z-INDEX:%POS; CLIP:rect(0px,%POSpx,%POSpx,0px); }\n", - id,x,y,w,h,z,w,h); - htrAddStylesheetItem_va(s,"\t#rb%POSborder { POSITION:absolute; VISIBILITY:inherit; LEFT:%INTpx; TOP:%INTpx; WIDTH:%POSpx; HEIGHT:%POSpx; Z-INDEX:%POS; CLIP:rect(0px,%POSpx,%POSpx,0px); }\n", - id,3,top_offset,w-(2*3),h-(top_offset+3),z+1,w-(2*3),h-(top_offset+3)); - htrAddStylesheetItem_va(s,"\t#rb%POScover { POSITION:absolute; VISIBILITY:inherit; LEFT:%INTpx; TOP:%INTpx; WIDTH:%POSpx; HEIGHT:%POSpx; Z-INDEX:%POS; CLIP:rect(0px,%POSpx,%POSpx,0px); }\n", - id,1,1,cover_width,cover_height,z+2,cover_width,cover_height); - htrAddStylesheetItem_va(s,"\t#rb%POStitle { POSITION:absolute; VISIBILITY:inherit; LEFT:%INTpx; TOP:%INTpx; WIDTH:%POSpx; HEIGHT:%POSpx; Z-INDEX:%POS; }\n", - id,10,1,w/2,s->ClientInfo->ParagraphHeight,z+3); - + /** Write style headers for container DOM nodes. **/ + const int para_height = s->ClientInfo->ParagraphHeight; + fprintf(stderr, "h: %d\n", para_height); + const int top_offset = (para_height * 3) / 4 + 1; + htrAddStylesheetItem_va(s, + "#rb%POSparent { " + "position:absolute; " + "visibility:inherit; " + "overflow:hidden; " + "left:"ht_flex_format"; " + "top:"ht_flex_format"; " + "width:"ht_flex_format"; " + "height:"ht_flex_format"; " + "z-index:%POS; " + "}\n", + id, + ht_flex_x(x, tree), + ht_flex_y(y, tree), + ht_flex_w(w, tree), + ht_flex_h(h, tree), + z + ); + htrAddStylesheetItem_va(s, + "#rb%POSborder { " + "position:absolute; " + "visibility:inherit; " + "overflow:hidden; " + "left:3px; " + "top:%POSpx; " + "width:calc(100%% - 6px); " + "height:calc(100%% - %POSpx); " + "z-index:%POS; " + "}\n", + id, + top_offset, + top_offset + 3, + z + 1 + ); + htrAddStylesheetItem_va(s, + "#rb%POScover { " + "position:absolute; " + "visibility:inherit; " + "overflow:hidden; " + "left:1px; " + "top:1px; " + "width:calc(100%% - 2px); " + "height:calc(100%% - 2px); " + "z-index:%POS; " + "}\n", + id, + z + 2 + ); + htrAddStylesheetItem_va(s, + "#rb%POStitle { " + "position:absolute; " + "visibility:inherit; " + "overflow:hidden; " + "left:10px; " + "top:1px; " + "width:50%%; " + "height:%POSpx; " + "z-index:%POS; " + "}\n", + id, + para_height, + z + 3 + ); + htrAddScriptGlobal(s, "radiobutton", "null", 0); /** DOM linkages **/ @@ -157,27 +209,23 @@ int htrbRender(pHtSession s, pWgtrNode tree, int z) { htrAddWgtrCtrLinkage_va(s, tree, "htr_subel(htr_subel(_obj,\"rb%POSborder\"),\"rb%POScover\")",id,id); /** Loop through each radiobutton and flag it NOOBJECT **/ - rb_cnt = 0; + raido_button_count = 0; for (j=0;jChildren));j++) { radiobutton_obj = xaGetItem(&(tree->Children), j); radiobutton_obj->RenderFlags |= HT_WGTF_NOOBJECT; wgtrGetPropertyValue(radiobutton_obj,"outer_type",DATA_T_STRING,POD(&ptr)); - if (!strcmp(ptr,"widget/radiobutton")) - { - rb_cnt++; - } + if (strcmp(ptr,"widget/radiobutton") == 0) raido_button_count++; } - /* - Now lets loop through and create a style sheet for each optionpane on the - radiobuttonpanel - */ - item_spacing = 12 + s->ClientInfo->ParagraphHeight; - cover_margin = 10; - if (item_spacing*rb_cnt+2*cover_margin > cover_height) - item_spacing = (cover_height-2*cover_margin)/rb_cnt; - if (item_spacing*rb_cnt+2*cover_margin > cover_height) - cover_margin = (cover_height-(item_spacing*rb_cnt))/2; + + /** Compute values for laying out radio buttons. **/ + const int cover_height = h - top_offset - 6; + int item_spacing = para_height + 12; + int cover_margin = 10; + if (item_spacing * raido_button_count + 2*cover_margin > cover_height) + item_spacing = (cover_height-2*cover_margin)/raido_button_count; + if (item_spacing * raido_button_count + 2*cover_margin > cover_height) + cover_margin = (cover_height-(item_spacing*raido_button_count))/2; if (cover_margin < 2) cover_margin = 2; i = 1; for (j=0;jChildren));j++) @@ -186,8 +234,22 @@ int htrbRender(pHtSession s, pWgtrNode tree, int z) { wgtrGetPropertyValue(radiobutton_obj,"outer_type",DATA_T_STRING,POD(&ptr)); if (!strcmp(ptr,"widget/radiobutton")) { - htrAddStylesheetItem_va(s,"\t#rb%POSoption%POS { POSITION:absolute; VISIBILITY:inherit; LEFT:%INTpx; TOP:%INTpx; WIDTH:%POSpx; HEIGHT:%POSpx; Z-INDEX:%POS; CLIP:rect(0px, %POSpx, %POSpx, 0px); }\n", - id,i,7,cover_margin+((i-1)*item_spacing)+3,cover_width-7,item_spacing,z+2,cover_width-7,item_spacing); + htrAddStylesheetItem_va(s, + "#rb%POSoption%POS { " + "position:absolute; " + "visibility:inherit; " + "overflow:hidden; " + "left:7px; " + "top:%INTpx; " + "width:calc(100%% - 7px); " + "height:%POSpx; " + "z-index:%POS; " + "}\n", + id, i, + cover_margin + ((i-1) * item_spacing) + 2, + min(item_spacing, para_height + 4), + z + 2 + ); i++; } } @@ -266,19 +328,58 @@ int htrbRender(pHtSession s, pWgtrNode tree, int z) { if (!strcmp(ptr,"widget/radiobutton")) { /** CSS layers **/ - htrAddStylesheetItem_va(s,"\t#rb%POSbuttonset%POS { POSITION:absolute; VISIBILITY:hidden; LEFT:%INTpx; TOP:%INTpx; WIDTH:%POSpx; HEIGHT:%POSpx; Z-INDEX:%POS; CLIP:rect(0px,%POSpx,%POSpx,0px); CURSOR:pointer; }\n", - id,i,5,2+(s->ClientInfo->ParagraphHeight-12)/2,12,12,z+2,12,12); - htrAddStylesheetItem_va(s,"\t#rb%POSbuttonunset%POS { POSITION:absolute; VISIBILITY:inherit; LEFT:%INTpx; TOP:%INTpx; WIDTH:%POSpx; HEIGHT:%POSpx; Z-INDEX:%POS; CLIP:rect(0px,%POSpx,%POSpx,0px); CURSOR:pointer; }\n", - id,i,5,2+(s->ClientInfo->ParagraphHeight-12)/2,12,12,z+2,12,12); - htrAddStylesheetItem_va(s,"\t#rb%POSvalue%POS { POSITION:absolute; VISIBILITY:hidden; LEFT:%INTpx; TOP:%INTpx; WIDTH:%POSpx; HEIGHT:%POSpx; Z-INDEX:%POS; CLIP:rect(0px,%POSpx,%POSpx,0px); }\n", - id,i,5,5,12,12,z+2,12,12); - htrAddStylesheetItem_va(s,"\t#rb%POSlabel%POS { POSITION:absolute; VISIBILITY:inherit; LEFT:%INTpx; TOP:%INTpx; WIDTH:%POSpx; HEIGHT:%POSpx; Z-INDEX:%POS; CLIP:rect(0px,%POSpx,%POSpx,0px); CURSOR:pointer; }\n", - id,i,27,2,cover_width-(27+1),item_spacing-1,z+2,cover_width-(27+1),item_spacing-1); + htrAddStylesheetItem_va(s, + "#rb%POSbuttonset%POS, " + "#rb%POSbuttonunset%POS { " + "position:absolute; " + "overflow:hidden; " + "left:5px; " + "top:%INTpx; " + "width:12px; " + "height:12px; " + "z-index:%POS; " + "cursor:pointer; " + "}\n", + id, i, + id, i, + (para_height / 2) - 3, + z + 2 + ); + htrAddStylesheetItem_va(s, + "#rb%POSvalue%POS { " + "position:absolute; " + "visibility:hidden; " + "overflow:hidden; " + "left:5px; " + "top:6px; " + "width:12px; " + "height:12px; " + "z-index:%POS; " + "}\n", + id, i, + z + 2 + ); + htrAddStylesheetItem_va(s, + "#rb%POSlabel%POS { " + "position:absolute; " + "visibility:inherit; " + "overflow:hidden; " + "left:27px; " + "top:3px; " + "width:calc(100%% - 27px); " + "height:%POSpx; " + "z-index:%POS; " + "cursor:pointer; " + "}\n", + id, i, + item_spacing - 1, + z + 2 + ); /** Body layers **/ htrAddBodyItem_va(s,"
\n", id, i); - htrAddBodyItem_va(s,"
\n", id, i); - htrAddBodyItem_va(s,"
\n", id, i); + htrAddBodyItem_va(s,"
\n", id, i); + htrAddBodyItem_va(s,"
\n", id, i); wgtrGetPropertyValue(radiobutton_obj,"label",DATA_T_STRING,POD(&ptr)); strtcpy(sbuf2,ptr,sizeof(sbuf2)); From 0e35c681ce894486e0b7945295b55f4657e0e62f Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Mon, 9 Feb 2026 12:35:39 -0700 Subject: [PATCH 095/275] Remove unnecessary width from htdrv_treeview.js. --- centrallix-os/sys/js/htdrv_treeview.js | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/centrallix-os/sys/js/htdrv_treeview.js b/centrallix-os/sys/js/htdrv_treeview.js index b3d4f1873..fb89579fa 100644 --- a/centrallix-os/sys/js/htdrv_treeview.js +++ b/centrallix-os/sys/js/htdrv_treeview.js @@ -38,7 +38,6 @@ function tv_new_layer(width,pdoc,l) else if(cx__capabilities.Dom1HTML) { nl = document.createElement('DIV'); - if (width) nl.style.width = width + 'px'; nl.className = l.divclass; //setClip(0, width, 0, 0); pg_set_style(nl, 'position','absolute'); @@ -1297,7 +1296,7 @@ function tv_mouseover(e) if (e.kind == 'tv') { cn_activate(e.mainlayer, 'MouseOver'); - if (getClipWidth(e.layer) <= getdocWidth(e.layer)+2 && e.layer.link_txt) + if (e.layer.link_txt) e.layer.tipid = pg_tooltip(e.layer.link_txt, e.pageX, e.pageY); } return EVENT_CONTINUE | EVENT_ALLOW_DEFAULT_ACTION; From 03c915337a2d52f4417b2f81320f6357089365c3 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Mon, 9 Feb 2026 12:38:25 -0700 Subject: [PATCH 096/275] Make window widget responsive. Clean up C code for generation and remove dead clutter. Improve readability of wn_do_move(). Add wn_do_move_internal(). Add resize observer to keep windows on screen when the page is resized. --- centrallix-os/sys/js/htdrv_window.js | 118 +++++++++---- centrallix/htmlgen/htdrv_window.c | 249 +++++++++++++++++---------- 2 files changed, 242 insertions(+), 125 deletions(-) diff --git a/centrallix-os/sys/js/htdrv_window.js b/centrallix-os/sys/js/htdrv_window.js index 6cdcf0da9..a0b2367a9 100644 --- a/centrallix-os/sys/js/htdrv_window.js +++ b/centrallix-os/sys/js/htdrv_window.js @@ -136,6 +136,24 @@ function wn_init(param) pg_addsched_fn(window, "pg_reveal_event", [l,l,'Reveal'], 0); } + // Setup responsive movement. + // resize_listener.params stores the params from the last time the window + // was moved, allowing us to reuse them to call wn_do_move_internal(), + // allowing that function to recalculate the window position based on the + // new viewport size. + const resize_listener = l.resize_listener = {}; + resize_listener.handler = () => + { + const { pg_attract, wn_new_x, wn_new_y } = l.resize_listener.params; + wn_do_move_internal(l, pg_attract, wn_new_x, wn_new_y); + }; + resize_listener.params = { + pg_attract: 0, + wn_new_x: getPageX(l), + wn_new_y: getPageY(l), + }; + window.addEventListener('resize', resize_listener.handler); + // force on page... if (getPageY(l) + l.orig_height > getInnerHeight()) { @@ -658,33 +676,71 @@ function wn_setvisibility(aparam) } } -function wn_domove2() - { +/*** This function does movement without worrying about global variables, + *** resize observers, etc. It just takes params and does movement. + *** + *** This function does handle snapping to edges and preventing windows from + *** being moved too far outside the viewport. + *** + *** @param wn_current The window to affect. + *** @param pg_attract The number of pixels from the edge of the viewport at + *** which windows snap to the edge. (Seems to always be 0.) + *** @param wn_new_x The new x coordinate for moving the window. + *** @param wn_new_y The new y coordinate for moving the window. + ***/ +function wn_do_move_internal(wn_current, pg_attract, wn_new_x, wn_new_y) + { + /** Get useful values. **/ + const { innerWidth, innerHeight } = window; + const window_width = getClipWidth(wn_current); + const window_height = getClipHeight(wn_current); + + /** Calculate available width and height, taking the sizes of scrollbars into account. **/ + const available_width = innerWidth - ((document.height - innerHeight - 2 >= 0) ? 15 : 0); + const available_height = innerHeight - ((document.width - innerWidth - 2 >= 0) ? 15 : 0); + let new_x, new_y; + + /** X: Handle snapping to edges. **/ + if (Math.isBetween(-pg_attract, wn_new_x, pg_attract)) new_x = 0; + else if (Math.isBetween(available_width - pg_attract, wn_new_x + window_width, available_width + pg_attract)) + new_x = available_width - window_width; + + /** X: Prevent windows getting lost off the left side of the page. **/ + else if (wn_new_x + window_width < 24) new_x = 24 - window_width; + else if (wn_new_x > available_width - 32) new_x = available_width - 32; + + /** X: Default case, no movement needed. **/ + else new_x = wn_new_x; + + /** Y: Handle snapping to edges. **/ + if (Math.isBetween(-pg_attract, wn_new_y, pg_attract)) new_y = 0; + else if (Math.isBetween(available_height - pg_attract, wn_new_y + window_height, available_height + pg_attract)) + new_y = available_height - window_height; + + /** Y: Prevent windows from going too far off the screen. **/ + else new_y = Math.clamp(0, wn_new_y, available_height - 24); + + /** Move the window to the new location. **/ + moveToAbsolute(wn_current, new_x, new_y); + /** Clicking and dragging a window is not a click. **/ + wn_current.clicked = 0; } -function wn_domove() +function wn_do_move() { - if (wn_current != null) - { - var ha=(document.height-window.innerHeight-2)>=0?15:0; - var va=(document.width-window.innerWidth-2)>=0?15:0; - var newx,newy; - if (wn_newx < pg_attract && wn_newx > -pg_attract) newx = 0; - else if (wn_newx+getClipWidth(wn_current) > window.innerWidth-ha-pg_attract && wn_newx+ getClipWidth(wn_current) < window.innerWidth-ha+pg_attract) - newx = window.innerWidth-ha-pg_get_style(wn_current,'clip.width'); - else if (wn_newx+getClipWidth(wn_current) < 25) newx = 25-pg_get_style(wn_current,'clip.width'); - else if (wn_newx > window.innerWidth-35-ha) newx = window.innerWidth-35-ha; - else newx = wn_newx; - if (wn_newy<0) newy = 0; - else if (wn_newy > window.innerHeight-12-va) newy = window.innerHeight-12-va; - else if (wn_newy < pg_attract) newy = 0; - else if (wn_newy+getClipHeight(wn_current) > window.innerHeight-va-pg_attract && wn_newy+getClipHeight(wn_current) < window.innerHeight-va+pg_attract) - newy = window.innerHeight-va-pg_get_style(wn_current,'clip.height'); - else newy = wn_newy; - moveToAbsolute(wn_current,newx,newy); - wn_current.clicked = 0; - } + /** Dereference globals once for performance. **/ + const { wn_current, pg_attract, wn_new_x, wn_new_y } = window; + + /** No window is selected, so we don't have to move anything. **/ + if (wn_current === null) return true; + + /** Call the unresponsive version. */ + wn_do_move_internal(wn_current, pg_attract, wn_new_x, wn_new_y); + + /** Update params for future resize calls. */ + wn_current.resize_listener.params = { pg_attract, wn_new_x, wn_new_y }; + return true; } @@ -736,8 +792,8 @@ function wn_mousedown(e) wn_current = e.mainlayer; wn_msx = e.pageX; wn_msy = e.pageY; - wn_newx = null; - wn_newy = null; + wn_new_x = null; + wn_new_y = null; wn_moved = 0; if (!cx__capabilities.Dom0IE) wn_windowshade_ns_moz(e.mainlayer); return EVENT_CONTINUE | EVENT_PREVENT_DEFAULT_ACTION; @@ -787,17 +843,17 @@ function wn_mousemove(e) wn_current.clicked = 0; if (wn_current.tid) clearTimeout(wn_current.tid); wn_current.tid = null; - if (wn_newx == null) + if (wn_new_x == null) { - wn_newx = getPageX(wn_current) + e.pageX-wn_msx; - wn_newy = getPageY(wn_current) + e.pageY-wn_msy; + wn_new_x = getPageX(wn_current) + e.pageX-wn_msx; + wn_new_y = getPageY(wn_current) + e.pageY-wn_msy; } else { - wn_newx += (e.pageX - wn_msx); - wn_newy += (e.pageY - wn_msy); + wn_new_x += (e.pageX - wn_msx); + wn_new_y += (e.pageY - wn_msy); } - setTimeout(wn_domove,60); + wn_do_move(); wn_moved = 1; wn_msx = e.pageX; wn_msy = e.pageY; diff --git a/centrallix/htmlgen/htdrv_window.c b/centrallix/htmlgen/htdrv_window.c index a02da42bb..5b6fbcd5d 100644 --- a/centrallix/htmlgen/htdrv_window.c +++ b/centrallix/htmlgen/htdrv_window.c @@ -3,8 +3,10 @@ #include #include #include + #include "ht_render.h" #include "obj.h" +#include "cxlib/util.h" #include "cxlib/mtask.h" #include "cxlib/xarray.h" #include "cxlib/xhash.h" @@ -59,14 +61,11 @@ htwinRender(pHtSession s, pWgtrNode tree, int z) { char* ptr; char name[64]; - pWgtrNode sub_tree; - int x,y,w,h; - int tbw,tbh,bx,by,bw,bh; int id, i; int visible = 1; - char bgnd_style[128] = ""; - char hdr_bgnd_style[128] = ""; - char txtcolor[64] = ""; + char background_style[128] = ""; + char header_background_style[128] = ""; + char text_color[64] = ""; int has_titlebar = 1; char title[128]; int is_dialog_style = 0; @@ -76,7 +75,7 @@ htwinRender(pHtSession s, pWgtrNode tree, int z) int is_toplevel = 0; int is_modal = 0; char icon[128]; - int shadow_offset,shadow_radius,shadow_angle; + int shadow_offset, shadow_radius, shadow_angle; char shadow_color[128]; int border_radius; char border_color[128]; @@ -99,6 +98,7 @@ htwinRender(pHtSession s, pWgtrNode tree, int z) id = (HTWIN.idcnt++); /** Get x,y,w,h of this object **/ + int x, y, w, h; if (wgtrGetPropertyValue(tree,"x",DATA_T_INTEGER,POD(&x)) != 0) x = 0; if (wgtrGetPropertyValue(tree,"y",DATA_T_INTEGER,POD(&y)) != 0) y = 0; if (wgtrGetPropertyValue(tree,"width",DATA_T_INTEGER,POD(&w)) != 0) @@ -156,17 +156,17 @@ htwinRender(pHtSession s, pWgtrNode tree, int z) is_modal = htrGetBoolean(tree, "modal", 0); /** Check background color **/ - htrGetBackground(tree, NULL, 1, bgnd_style, sizeof(bgnd_style)); + htrGetBackground(tree, NULL, 1, background_style, sizeof(background_style)); /** Check header background color/image **/ - if (htrGetBackground(tree, "hdr", 1, hdr_bgnd_style, sizeof(hdr_bgnd_style)) < 0) - strcpy(hdr_bgnd_style, bgnd_style); + if (htrGetBackground(tree, "hdr", 1, header_background_style, sizeof(header_background_style)) < 0) + strcpy(header_background_style, background_style); /** Check title text color. **/ if (wgtrGetPropertyValue(tree,"textcolor",DATA_T_STRING,POD(&ptr)) == 0) - strtcpy(txtcolor,ptr,sizeof(txtcolor)); + strtcpy(text_color, ptr, sizeof(text_color)); else - strcpy(txtcolor,"black"); + strcpy(text_color, "black"); /** Check window title. **/ if (wgtrGetPropertyValue(tree,"title",DATA_T_STRING,POD(&ptr)) == 0) @@ -208,79 +208,95 @@ htwinRender(pHtSession s, pWgtrNode tree, int z) } /** Compute titlebar width & height - includes edge below titlebar. **/ - if (has_titlebar) - { - tbw = w-2; - if (is_dialog_style || !s->Capabilities.Dom0NS) - tbh = 24; - else - tbh = 23; - } - else - { - tbw = w-2; - tbh = 0; - } - - /** Compute window body geometry **/ - if (is_dialog_style) - { - bx = 1; - by = 1+tbh; - bw = w-2; - bh = h-tbh-2; - } - else - { - bx = 2; - bw = w-4; - if (has_titlebar) - { - by = 1+tbh; - bh = h-tbh-3; - } - else - { - by = 2; - bh = h-4; - } - } + int title_bar_height = (has_titlebar) ? ((is_dialog_style) ? 24 : 23) : 0; /** Draw the main window layer and outer edge. **/ - /*htrAddStylesheetItem_va(s,"\t#wn%POSbase { POSITION:absolute; VISIBILITY:%STR; LEFT:%INTpx; TOP:%INTpx; WIDTH:%POSpx; HEIGHT:%POSpx; overflow: hidden; clip:rect(0px, %INTpx, %INTpx, 0px); Z-INDEX:%POS;}\n", - id,visible?"inherit":"hidden",x,y,w-2*box_offset,h-2*box_offset, w, h, z+100);*/ - htrAddStylesheetItem_va(s,"\t#wn%POSbase { POSITION:absolute; VISIBILITY:%STR; LEFT:%INTpx; TOP:%INTpx; WIDTH:%POSpx; HEIGHT:%POSpx; overflow: hidden; Z-INDEX:%POS;}\n", - id,visible?"inherit":"hidden",x,y,w-2*box_offset,h-2*box_offset, z+100); - htrAddStylesheetItem_va(s,"\t#wn%POSbase { border-style: %STR&CSSVAL; border-width: %INTpx; border-color: %STR&CSSVAL; border-radius: %INTpx; }\n", - id, border_style, border_width, border_color, border_radius); + /*** We don't even bother making these styles flex responsively because + *** they will be overwritten by the JS anyway. + ***/ + htrAddStylesheetItem_va(s, + "\t#wn%POSbase { " + "position:absolute; " + "visibility:%STR; " + "left:%INTpx; " + "top:%INTpx; " + "width:%POSpx; " + "height:%POSpx; " + "overflow:hidden; " + "z-index:%POS; " + "border-style:%STR&CSSVAL; " + "border-width:%INTpx; " + "border-color:%STR&CSSVAL; " + "border-radius:%INTpx; " + "}\n", + id, + (visible) ? "inherit" : "hidden", + x, + y, + w - 2 * box_offset, + h - 2 * box_offset, + z + 100, + border_style, + border_width, + border_color, + border_radius + ); if (shadow_radius > 0) { - htrAddStylesheetItem_va(s,"\t#wn%POSbase { box-shadow: %DBLpx %DBLpx %POSpx %STR&CSSVAL; }\n", id, - sin(shadow_angle*M_PI/180)*shadow_offset, cos(shadow_angle*M_PI/180)*(-shadow_offset), shadow_radius, shadow_color); - } - - /** draw titlebar div **/ - if (has_titlebar) - { - htrAddStylesheetItem_va(s,"\t#wn%POStitlebar { POSITION: absolute; VISIBILITY: inherit; LEFT: 0px; TOP: 0px; HEIGHT: %POSpx; WIDTH: 100%%; overflow: hidden; Z-INDEX: %POS; color:%STR&CSSVAL; cursor:default; %STR}\n", id, tbh-1-box_offset, z+1, txtcolor, hdr_bgnd_style); - htrAddStylesheetItem_va(s,"\t#wn%POStitlebar { border-style: solid; border-width: 0px 0px 1px 0px; border-color: gray; }\n", id); + double shadow_angle_radians = (double)shadow_angle * M_PI/180; + htrAddStylesheetItem_va(s, + "\t#wn%POSbase { box-shadow: %DBLpx %DBLpx %POSpx %STR&CSSVAL; }\n", id, + sin(shadow_angle_radians)*shadow_offset, cos(shadow_angle_radians)*(-shadow_offset), shadow_radius, shadow_color + ); } /** inner structure depends on dialog vs. window style **/ + int main_width, main_height, clip_height, dialogue_width; + char* border_color_str; if (is_dialog_style) { /** window inner container -- dialog **/ - htrAddStylesheetItem_va(s,"\t#wn%POSmain { POSITION:absolute; VISIBILITY:inherit; LEFT:0px; TOP:%INTpx; WIDTH: %POSpx; HEIGHT:%POSpx; overflow: hidden; clip:rect(0px, %INTpx, %INTpx, 0px); Z-INDEX:%POS; %STR}\n", - id, tbh?(tbh-1):0, w-2, h-tbh-1, w, h-tbh+1, z+1, bgnd_style); - htrAddStylesheetItem_va(s,"\t#wn%POSmain { border-style: solid; border-width: %POSpx 0px 0px 0px; border-color: white; }\n", id, has_titlebar?1:0); + main_width = w - 2; + main_height = h - title_bar_height - 1; + clip_height = h - title_bar_height + 1; + dialogue_width = 0; + border_color_str = "white"; } else { /** window inner container -- window **/ - htrAddStylesheetItem_va(s,"\t#wn%POSmain { POSITION:absolute; VISIBILITY:inherit; LEFT:0px; TOP:%INTpx; WIDTH: %POSpx; HEIGHT:%POSpx; overflow: hidden; clip:rect(0px, %INTpx, %INTpx, 0px); Z-INDEX:%POS; %STR}\n", - id, tbh?(tbh-1):0, w-2-2*box_offset, h-tbh-(has_titlebar?1:2)-(has_titlebar?1:2)*box_offset, w, h-tbh+(has_titlebar?1:0)-2*box_offset, z+1, bgnd_style); - htrAddStylesheetItem_va(s,"\t#wn%POSmain { border-style: solid; border-width: %POSpx 1px 1px 1px; border-color: gray white white gray; }\n", id, has_titlebar?0:1); + main_width = w - 2 * (box_offset + 1); + main_height = h - title_bar_height - (box_offset + 1) * ((has_titlebar) ? 1 : 2); + clip_height = h - title_bar_height + ((has_titlebar) ? 1 : 0) - 2 * box_offset; + dialogue_width = 1; + border_color_str = "gray white white gray"; } + htrAddStylesheetItem_va(s, + "\t#wn%POSmain { " + "position:absolute; " + "visibility:inherit; " + "left:0px; " + "top:%INTpx; " + "width:%POSpx; " + "height:%POSpx; " + "overflow:hidden; " + "clip:rect(0px, %INTpx, %INTpx, 0px); " + "border-style:solid; " + "border-color:%STR; " + "border-width:%POSpx %POSpx %POSpx %POSpx; " + "z-index:%POS; " + "%STR" + "}\n", + id, + max(title_bar_height - 1, 0), + main_width, + main_height, + w, clip_height, + border_color_str, + (has_titlebar) ? 1 : 0, dialogue_width, dialogue_width, dialogue_width, + z + 1, + background_style + ); /** Write globals for internal use **/ htrAddScriptGlobal(s, "wn_top_z","10000",0); @@ -295,7 +311,7 @@ htwinRender(pHtSession s, pWgtrNode tree, int z) htrAddScriptGlobal(s, "wn_clicked","0",0); /** DOM Linkages **/ - htrAddWgtrObjLinkage_va(s, tree, "wn%POSbase",id); + htrAddWgtrObjLinkage_va(s, tree, "wn%POSbase", id); htrAddWgtrCtrLinkage_va(s, tree, "htr_subel(_obj, \"wn%POSmain\")",id); htrAddScriptInclude(s, "/sys/js/htdrv_window.js", 0); @@ -312,36 +328,81 @@ htwinRender(pHtSession s, pWgtrNode tree, int z) htrAddEventHandlerFunction(s, "document", "MOUSEOUT", "wn", "wn_mouseout"); /** Script initialization call. **/ + htrAddScriptInit_va(s, + "wn_init({ " + "mainlayer:wgtrGetNodeRef(ns, '%STR&SYM'), " + "clayer:wgtrGetContainer(wgtrGetNodeRef(ns, '%STR&SYM')), " + "titlebar:%[htr_subel(wgtrGetNodeRef(ns, '%STR&SYM'), 'wn%POStitlebar')%]%[null%], " + "gshade:%INT, " + "closetype:%INT, " + "toplevel:%INT, " + "modal:%INT, " + "});\n", + name, + name, + has_titlebar, name, id, !has_titlebar, + gshade, + closetype, + is_toplevel, + is_modal + ); + + /** Write HTML for the child window. **/ + htrAddBodyItem_va(s, "
\n", id); if (has_titlebar) { - htrAddScriptInit_va(s," wn_init({mainlayer:wgtrGetNodeRef(ns,'%STR&SYM'), clayer:wgtrGetContainer(wgtrGetNodeRef(ns,'%STR&SYM')), gshade:%INT, closetype:%INT, toplevel:%INT, modal:%INT, titlebar:htr_subel(wgtrGetNodeRef(ns,'%STR&SYM'),'wn%POStitlebar')});\n", - name,name,gshade,closetype, is_toplevel, is_modal, name, id); + /** Write styles and HTML for the title bar. **/ + htrAddStylesheetItem_va(s, + "\t#wn%POStitlebar { " + "position:absolute; " + "visibility:inherit; " + "left:0px; " + "top:0px; " + "height:%POSpx; " + "width:calc(100%% - 4px); " + "overflow:hidden; " + "z-index:%POS; " + "color:%STR&CSSVAL; " + "cursor:default; " + "border-style:solid; " + "border-width:0px 0px 1px 0px; " + "border-color:gray; " + "%STR" + "}\n", + id, + title_bar_height - 1 - box_offset, + z + 1, + text_color, + header_background_style + ); + htrAddBodyItem_va(s, + "
" + "" + "
%STR&HTE
" + "" + "
\n", + id, + icon, + text_color, title + ); } - else - { - htrAddScriptInit_va(s," wn_init({mainlayer:wgtrGetNodeRef(ns,'%STR&SYM'), clayer:wgtrGetNodeRef(ns,'%STR&SYM'), gshade:%INT, closetype:%INT, toplevel:%INT, modal:%INT, titlebar:null});\n", - name,name,gshade,closetype, is_toplevel, is_modal); - } - - /** HTML body
elements for the layers. **/ - htrAddBodyItem_va(s,"
\n",id); - if (has_titlebar) - { - htrAddBodyItem_va(s,"
\n",id); - htrAddBodyItem_va(s,"
 %STR&HTE
\n", - tbh-1, tbw-2, icon, txtcolor, title); - htrAddBodyItem(s, "
\n"); - } - htrAddBodyItem_va(s,"
\n",id); - /** Check for more sub-widgets within the page. **/ + /** Write HTML for child widgets in the window. **/ + htrAddBodyItem_va(s,"
\n",id); for (i=0;iChildren));i++) { - sub_tree = xaGetItem(&(tree->Children), i); - htrRenderWidget(s, sub_tree, z+2); + /** TODO: Israel - Rewrite this using util.h, once its updated from the dups branch. **/ + const pWgtrNode child = xaGetItem(&(tree->Children), i); + const int ret = htrRenderWidget(s, child, z + 2); + if (ret != 0) + { + mssError(0, "HTWIN", + "Failed to render child widget '%s:%s' with error code %d.", + child->Namespace, child->Name, ret + ); + } } - - htrAddBodyItem(s,"
\n"); + htrAddBodyItem(s,"
\n"); return 0; } From 56e114ae3aaed84c9171b3b7cac0d4ed38c8a528 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Mon, 9 Feb 2026 12:40:16 -0700 Subject: [PATCH 097/275] Make active areas responsive. Add resize observer to htdrv_page.js to update areas/boxes when the page is resized. Fix undefined layer edge case in pg_setkbdfocus(). Improve code readability. --- centrallix-os/sys/js/htdrv_page.js | 96 ++++++++++++++++++++++++------ 1 file changed, 77 insertions(+), 19 deletions(-) diff --git a/centrallix-os/sys/js/htdrv_page.js b/centrallix-os/sys/js/htdrv_page.js index 85c58c5b5..3023ea47c 100755 --- a/centrallix-os/sys/js/htdrv_page.js +++ b/centrallix-os/sys/js/htdrv_page.js @@ -51,6 +51,11 @@ function pg_scriptavailable(s) } +/** Quick and dirty resize handling tool. **/ +const resize_handlers = {}; +window.addEventListener('resize', (e) => Object.values(resize_handlers).forEach(f => f(e))); + + //START SECTION: DOM/CSS helper functions ----------------------------------- /** returns an attribute of the element in pixels **/ @@ -1929,7 +1934,9 @@ function pg_findfocusarea(l, xo, yo) function pg_setmousefocus(l, xo, yo) { - var a = pg_findfocusarea(l, xo, yo); + if (!l) return false; + + const a = pg_findfocusarea(l, xo, yo); if (a && a != pg_curarea) { pg_curarea = a; @@ -1937,26 +1944,52 @@ function pg_setmousefocus(l, xo, yo) { if (!pg_curarea.layer.getmousefocushandler || pg_curarea.layer.getmousefocushandler(xo, yo, a.layer, a.cls, a.name, a)) { - // wants mouse focus - var offs = $(pg_curarea.layer).offset(); - //var x = getPageX(pg_curarea.layer)+pg_curarea.x; - //var y = getPageY(pg_curarea.layer)+pg_curarea.y; - var x = offs.left+pg_curarea.x; - var y = offs.top+pg_curarea.y; - - var w = pg_curarea.width; - var h = pg_curarea.height; - if (cx__capabilities.Dom0NS) + // Create a function to handle all box updates with this focus. + const update_box = (area) => { - pg_mkbox(l, x,y,w,h, 1, document.layers.pgtop,document.layers.pgbtm,document.layers.pgrgt,document.layers.pglft, page.mscolor1, page.mscolor2, document.layers.pgktop.zIndex-1); - } - else if (cx__capabilities.Dom1HTML) - { - pg_mkbox(l, x,y,w,h, 1, document.getElementById("pgtop"),document.getElementById("pgbtm"),document.getElementById("pgrgt"),document.getElementById("pglft"), page.mscolor1, page.mscolor2, htr_getzindex(document.getElementById("pgktop"))-1); - } + // Compute layout data. + const offs = $(area.layer).offset(); + const x = area.x + offs.left; + const y = area.y + offs.top; + const w = area.width; + const h = area.height; + + if (cx__capabilities.Dom0NS) + { + pg_mkbox(l, + x, y, w, h, 1, + document.layers.pgtop, + document.layers.pgbtm, + document.layers.pgrgt, + document.layers.pglft, + page.mscolor1, page.mscolor2, + document.layers.pgktop.zIndex - 1 + ); + } + else if (cx__capabilities.Dom1HTML) + { + pg_mkbox(l, + x, y, w, h, 1, + document.getElementById("pgtop"), + document.getElementById("pgbtm"), + document.getElementById("pgrgt"), + document.getElementById("pglft"), + page.mscolor1, page.mscolor2, + htr_getzindex(document.getElementById("pgktop")) - 1 + ); + } + }; + + // Initial update. + update_box(pg_curarea); + + // Responsive updates. + const area = pg_curarea; // Save value so we can create a closure below. + resize_handlers.mouse_focus = () => update_box(area); } } } + if (!a) delete resize_handlers.mouse_focus; } function pg_removekbdfocus(p) @@ -1975,16 +2008,30 @@ function pg_removekbdfocus(p) pg_mkbox(null,0,0,0,0, 1, document.getElementById("pgktop"),document.getElementById("pgkbtm"),document.getElementById("pgkrgt"),document.getElementById("pgklft"), page.kbcolor1, page.kbcolor2, pg_get_style(document.getElementById("pgtop"), 'zIndex')+100); } } + + // Clear resize handling. + delete resize_handlers.mouse_focus; + delete resize_handlers.data_focus; + delete resize_handlers.kbd_focus; + return true; } function pg_setdatafocus(a) { + if (!a) return false; + var x = getPageX(a.layer)+a.x; var y = getPageY(a.layer)+a.y; var w = a.width; var h = a.height; var l = a.layer; + + // Setup resize handling. + resize_handlers.data_focus = () => { + // Recall function to update values. + pg_setdatafocus(a); + }; // hide old data focus box if (l.pg_dttop != null) @@ -2037,6 +2084,8 @@ function pg_setdatafocus(a) function pg_setkbdfocus(l, a, xo, yo) { + if (!l) return false; + var from_kbd = false; if (xo == null && yo == null) { @@ -2068,6 +2117,12 @@ function pg_setkbdfocus(l, a, xo, yo) pg_curkbdarea = a; pg_curkbdlayer = l; + // Setup resize handling. + resize_handlers.kbd_focus = () => { + // Recall function to update values. + pg_setkbdfocus(l, a, xo, yo); + }; + if (pg_curkbdlayer && pg_curkbdlayer.getfocushandler) { v=pg_curkbdlayer.getfocushandler(xo,yo,a.layer,a.cls,a.name,a,from_kbd); @@ -3040,9 +3095,12 @@ function pg_check_resize(l) { if (wgtrGetServerProperty(l, "height") != $(l).height()) { - if (wgtrGetParent(l).childresize) + const parent = wgtrGetParent(l); + if (parent.childresize) { - var geom = wgtrGetParent(l).childresize(l, wgtrGetServerProperty(l, "width"), wgtrGetServerProperty(l, "height"), $(l).width(), $(l).height()); + const width = wgtrGetServerProperty(l, "width"); + const height = wgtrGetServerProperty(l, "height"); + const geom = parent.childresize(l, width, height, $(l).width(), $(l).height()); if (geom) { wgtrSetServerProperty(l, "height", geom.height); From cfc5e47e243384a7249b6cd0a572c62afb58ecb0 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Mon, 9 Feb 2026 12:40:34 -0700 Subject: [PATCH 098/275] Cleanup unused comments. --- centrallix-os/sys/js/htdrv_osrc.js | 2 -- 1 file changed, 2 deletions(-) diff --git a/centrallix-os/sys/js/htdrv_osrc.js b/centrallix-os/sys/js/htdrv_osrc.js index f256cd70e..7e3cdc89f 100644 --- a/centrallix-os/sys/js/htdrv_osrc.js +++ b/centrallix-os/sys/js/htdrv_osrc.js @@ -2330,8 +2330,6 @@ function osrc_open_query_startat() else this.querysize = this.replicasize; this.query_ended = false; - //this.LogStatus(); - //console.log('OSRC ' + this.__WgtrName + ': startat ' + this.startat + ', rowcount ' + this.querysize); this.DoRequest('multiquery', '/', {ls__startat:this.startat, ls__autoclose_sr:1, ls__autofetch:1, ls__objmode:0, ls__notify:this.request_updates, ls__rowcount:this.querysize, ls__sql:this.query, ls__sqlparam:this.EncodeParams()}, osrc_get_qid_startat); } From 1e0d948680c04b98f7a67bea1fabc44376acc3a0 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Mon, 9 Feb 2026 12:41:24 -0700 Subject: [PATCH 099/275] Add error messages to the image widget. Add an error when the offset action is used, warning that it breaks responsive design. Add an error when the scale action is used, warning that it breaks responsive design. --- centrallix-os/sys/js/htdrv_image.js | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/centrallix-os/sys/js/htdrv_image.js b/centrallix-os/sys/js/htdrv_image.js index a4a608022..38d05b6cf 100644 --- a/centrallix-os/sys/js/htdrv_image.js +++ b/centrallix-os/sys/js/htdrv_image.js @@ -146,12 +146,18 @@ function im_set_scale(a, v) function im_action_offset(aparam) { + /** This action is never used anywhere and looks hard to update, so it's deprecated for now. **/ + console.error("The offset action is no longer supported. Using it may break responsive layouts."); + im_set_x.call(this, "xoffset", aparam.X); im_set_y.call(this, "yoffset", aparam.Y); } function im_action_scale(aparam) { + /** This action is never used anywhere and looks hard to update, so it's deprecated for now. **/ + console.error("The scale action is no longer supported. Using it may break responsive layouts."); + im_set_scale.call(this, "scale", aparam.Scale); } From 44bbef46516f03efd2eda13bbf0a5c789db450da Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Mon, 9 Feb 2026 12:58:40 -0700 Subject: [PATCH 100/275] Make table widget back end code responsive. Improve HTML generation C code. Reformat script call to massively improve readability. Reorder attributes to improve code organization. Rename box to scroll thumb for clarity and consistency. Remove code that renamed legacy attributes to their new names (no longer needed). Remove code that wrote unused attributes to the front end. Remove code that read unused attributes which were never used. Remove unused attributes from the httbl_struct struct. Remove unused variables. Add a TODO to investigate some strange looking logic. Add comments with comment anchors for faster code navigation. Add comment explaining where to find more info about comment anchors. Note: This comment will be wrong until the dups branch is merged to add the required info. Clean up code, comments, and formatting. --- centrallix/htmlgen/htdrv_table.c | 565 +++++++++++++++++++------------ 1 file changed, 352 insertions(+), 213 deletions(-) diff --git a/centrallix/htmlgen/htdrv_table.c b/centrallix/htmlgen/htdrv_table.c index 54dc47f41..5876bf658 100644 --- a/centrallix/htmlgen/htdrv_table.c +++ b/centrallix/htmlgen/htdrv_table.c @@ -35,7 +35,7 @@ /* A copy of the GNU General Public License has been included in this */ /* distribution in the file "COPYING". */ /* */ -/* Module: htdrv_table.c */ +/* Module: htdrv_table.c */ /* Author: Greg Beeley (GRB) */ /* Creation: October 29, 1999 */ /* Description: HTML Widget driver for a data-driven table. Has three */ @@ -58,6 +58,10 @@ /* only. Dynamicrow tables use the most client resources. */ /************************************************************************/ +/*** This file uses the optional Comment Anchors VSCode extension, documented + *** with CommentAnchorsExtension.md in centrallix-sysdoc. + ***/ + #define HTTBL_MAX_COLS (64) @@ -92,12 +96,7 @@ typedef struct typedef struct { char name[64]; - char sbuf[160]; - char tbl_bgnd[128]; char hdr_bgnd[128]; - char row_bgnd1[128]; - char row_bgnd2[128]; - char row_bgndhigh[128]; char colsep_bgnd[128]; char textcolor[64]; char textcolorhighlight[64]; @@ -105,34 +104,25 @@ typedef struct char newrow_bgnd[128]; char newrow_textcolor[64]; char osrc[64]; - char row_border[64]; - char row_shadow_color[64]; - int row_shadow; - int row_shadow_radius; - int row_radius; - int x,y,w,h; + httbl_col* col_infs[HTTBL_MAX_COLS]; + int ncols; int id; + int x,y,w,h; int data_mode; /* 0="rows" or 1="properties" */ - int outer_border; - int inner_border; int inner_padding; - httbl_col* col_infs[HTTBL_MAX_COLS]; - int ncols; int windowsize; int min_rowheight; int max_rowheight; int cellhspacing; int cellvspacing; - int followcurrent; int dragcols; int colsep; int colsep_mode; - int gridinemptyrows; + int grid_in_empty_rows; int allow_selection; int show_selection; int initial_selection; int allow_deselection; - int reverse_order; int overlap_scrollbar; /* scrollbar overlaps with table */ int hide_scrollbar; /* don't show scrollbar at all */ int demand_scrollbar; /* only show scrollbar when needed */ @@ -140,20 +130,11 @@ typedef struct int rowcache_size; /* number of rows the table caches for display */ } httbl_struct; + int httblRenderDynamic(pHtSession s, pWgtrNode tree, int z, httbl_struct* t) { - int colid; - char *ptr; - int i; - pWgtrNode sub_tree; - int subcnt = 0; - char *nptr; - int h; - int first_offset = (t->has_header)?(t->min_rowheight + t->cellvspacing):0; - pWgtrNode children[32]; - int detailcnt; - httbl_col* col; + char* ptr; if(!s->Capabilities.Dom0NS && !s->Capabilities.Dom1HTML) { @@ -161,107 +142,279 @@ httblRenderDynamic(pHtSession s, pWgtrNode tree, int z, httbl_struct* t) return -1; } - /** STYLE for the layer **/ - htrAddStylesheetItem_va(s,"\t#tbld%POSpane { POSITION:absolute; VISIBILITY:inherit; LEFT:%INTpx; TOP:%INTpx; WIDTH:%POSpx; Z-INDEX:%POS; } \n",t->id,t->x,t->y,(t->overlap_scrollbar)?(t->w):(t->w-18),z+0); - htrAddStylesheetItem_va(s,"\t#tbld%POSscroll { POSITION:absolute; VISIBILITY:%STR; LEFT:%INTpx; TOP:%INTpx; WIDTH:18px; HEIGHT:%POSpx; Z-INDEX:%POS; }\n",t->id,(t->hide_scrollbar || t->demand_scrollbar)?"hidden":"inherit",t->x+t->w-18,t->y+first_offset,t->h-first_offset,z+0); - htrAddStylesheetItem_va(s,"\t#tbld%POSbox { POSITION:absolute; VISIBILITY:inherit; LEFT:0px; TOP:18px; WIDTH:16px; HEIGHT:16px; Z-INDEX:%POS; BORDER: solid 1px; BORDER-COLOR: white gray gray white; }\n",t->id,z+1); + /** Write CSS for the table base element. **/ + const int content_width = (t->overlap_scrollbar) ? (t->w) : (t->w - 18); + htrAddStylesheetItem_va(s, + "\t#tbld%POSbase { " + "position:absolute; " + "visibility:inherit; " + "left:"ht_flex_format"; " + "top:"ht_flex_format"; " + "width:"ht_flex_format"; " + "height:"ht_flex_format"; " + "z-index:%POS; " + "}\n", + t->id, + ht_flex_x(t->x, tree), + ht_flex_y(t->y, tree), + ht_flex_w(content_width, tree), + ht_flex_h(t->h, tree), + z + 0 + ); + + /** Write CSS for the table scrollbar. **/ + const int row_start_y = (t->has_header) ? (t->min_rowheight + t->cellvspacing) : 0; + htrAddStylesheetItem_va(s, + "\t#tbld%POSscroll { " + "position:absolute; " + "visibility:%STR; " + "left:"ht_flex_format"; " + "top:"ht_flex_format"; " + "width:18px; " + "height:"ht_flex_format"; " + "z-index:%POS; " + "}\n", + t->id, + (t->hide_scrollbar || t->demand_scrollbar) ? "hidden" : "inherit", /** TODO: Greg - This logic looks fishy. Why does `demand_scrollbar = true` hide the scrollbar?? **/ + ht_flex(t->x + t->w - 18, ht_get_parent_w(tree), ht_get_fl_x(tree) + ht_get_fl_w(tree)), + ht_flex_y(t->y + row_start_y, tree), + ht_flex_h(t->h - row_start_y, tree), + z + 0 + ); + + /** Write CSS for the table scroll thumb. **/ + htrAddStylesheetItem_va(s, + "\t#tbld%POSthumb { " + "position:absolute; " + "visibility:inherit; " + "left:0px; " + "top:18px; " + "width:16px; " + "height:16px; " + "z-index:%POS; " + "border:solid 1px; " + "border-color:white gray gray white; " + "}\n", + t->id, + z + 1 + ); + + /** Link to the table base object. **/ + htrAddWgtrObjLinkage_va(s, tree, "tbld%POSbase", t->id); + /** Add globals for scripts. **/ htrAddScriptGlobal(s,"tbld_current","null",0); htrAddScriptGlobal(s,"tbldb_current","null",0); htrAddScriptGlobal(s,"tbldx_current","null",0); htrAddScriptGlobal(s,"tbldb_start","null",0); htrAddScriptGlobal(s,"tbldbdbl_current","null",0); + /** Include scripts. **/ htrAddScriptInclude(s, "/sys/js/htdrv_table.js", 0); htrAddScriptInclude(s, "/sys/js/ht_utils_string.js", 0); - - htrAddWgtrObjLinkage_va(s, tree, "tbld%POSpane",t->id); - - htrAddScriptInit_va(s," tbld_init({tablename:'%STR&SYM', table:wgtrGetNodeRef(ns,\"%STR&SYM\"), scroll:htr_subel(wgtrGetParentContainer(wgtrGetNodeRef(ns,\"%STR&SYM\")),\"tbld%POSscroll\"), boxname:\"tbld%POSbox\", name:\"%STR&SYM\", height:%INT, width:%INT, innerpadding:%INT, innerborder:%INT, windowsize:%INT, min_rowheight:%INT, max_rowheight:%INT, cellhspacing:%INT, cellvspacing:%INT, textcolor:\"%STR&JSSTR\", textcolorhighlight:\"%STR&JSSTR\", titlecolor:\"%STR&JSSTR\", rowbgnd1:\"%STR&JSSTR\", rowbgnd2:\"%STR&JSSTR\", rowbgndhigh:\"%STR&JSSTR\", hdrbgnd:\"%STR&JSSTR\", followcurrent:%INT, dragcols:%INT, colsep:%INT, colsep_mode:%INT, colsep_bgnd:\"%STR&JSSTR\", gridinemptyrows:%INT, reverse_order:%INT, allow_selection:%INT, show_selection:%INT, initial_selection:%INT, allow_deselection:%INT, overlap_sb:%INT, hide_sb:%INT, demand_sb:%INT, osrc:%['%STR&SYM'%]%[null%], dm:%INT, hdr:%INT, newrow_bgnd:\"%STR&JSSTR\", newrow_textcolor:\"%STR&JSSTR\", rcsize:%INT, cols:[", - t->name,t->name,t->name,t->id,t->id,t->name,t->h, - (t->overlap_scrollbar)?t->w:t->w-18, - t->inner_padding,t->inner_border,t->windowsize,t->min_rowheight, t->max_rowheight, - t->cellhspacing, t->cellvspacing,t->textcolor, - t->textcolorhighlight, t->titlecolor,t->row_bgnd1,t->row_bgnd2, - t->row_bgndhigh,t->hdr_bgnd,t->followcurrent,t->dragcols, - t->colsep, t->colsep_mode, t->colsep_bgnd,t->gridinemptyrows, t->reverse_order, - t->allow_selection, t->show_selection, t->initial_selection, t->allow_deselection, - t->overlap_scrollbar, t->hide_scrollbar, t->demand_scrollbar, - *(t->osrc) != '\0', t->osrc, *(t->osrc) == '\0', - t->data_mode, t->has_header, - t->newrow_bgnd, t->newrow_textcolor, - t->rowcache_size); - for(colid=0;colidncols;colid++) + /** Begin writing the js initialization call. **/ + htrAddScriptInit_va(s, "tbld_init({"); + + /** Write identification data. **/ + const int has_osrc = (*(t->osrc) != '\0'); + htrAddScriptInit_va(s, + "name:'%STR&SYM', " + "table:wgtrGetNodeRef(ns, '%STR&SYM'), " + "scroll:htr_subel(" + "wgtrGetParentContainer(wgtrGetNodeRef(ns, '%STR&SYM')), " + "'tbld%POSscroll'" + "), " + "osrc:%['%STR&SYM'%]%[null%], ", + t->name, t->name, t->name, t->id, + has_osrc, t->osrc, !has_osrc + ); + + /** Write layout data. **/ + htrAddScriptInit_va(s, + "height:%INT, " + "width:%INT, " + "innerpadding:%INT, " + "min_rowheight:%INT, " + "max_rowheight:%INT, " + "cellhspacing:%INT, " + "cellvspacing:%INT, ", + t->h, content_width, + t->inner_padding, + t->min_rowheight, t->max_rowheight, + t->cellhspacing, t->cellvspacing + ); + + /** Write selection data. **/ + htrAddScriptInit_va(s, + "allow_selection:%INT, " + "show_selection:%INT, " + "initial_selection:%INT, " + "allow_deselection:%INT, ", + t->allow_selection, + t->show_selection, + t->initial_selection, + t->allow_deselection + ); + + /** Write scrollbar data. **/ + htrAddScriptInit_va(s, + "thumb_name:'tbld%POSthumb', " + "demand_sb:%INT, ", + t->id, + t->demand_scrollbar + ); + + /** Write theme data (colors, backgrounds, etc.). **/ + htrAddScriptInit_va(s, + "textcolor:'%STR&JSSTR', " + "textcolorhighlight:'%STR&JSSTR', " + "titlecolor:'%STR&JSSTR', " + "colsep_bgnd:'%STR&JSSTR', " + "hdrbgnd:'%STR&JSSTR', " + "newrow_bgnd:'%STR&JSSTR', " + "newrow_textcolor:'%STR&JSSTR', ", + t->textcolor, t->textcolorhighlight, + t->titlecolor, t->colsep_bgnd, t->hdr_bgnd, + t->newrow_bgnd, t->newrow_textcolor + ); + + /** Write general row data. **/ + htrAddScriptInit_va(s, + "dm:%INT, " + "hdr:%INT, " + "grid_in_empty_rows:%INT, " + "windowsize:%INT, " + "rcsize:%INT, ", + t->data_mode, + t->has_header, + t->grid_in_empty_rows, + t->windowsize, + t->rowcache_size + ); + + /** Write general column data. **/ + htrAddScriptInit_va(s, + "dragcols:%INT, " + "colsep:%INT, " + "colsep_mode:%INT, ", + t->dragcols, t->colsep, t->colsep_mode + ); + + /** Write the cols array with data for each column. **/ + /** ANCHOR[id=table-column] **/ + htrAddScriptInit_va(s, "cols:["); + for (int colid = 0; colid < t->ncols; colid++) { - col = t->col_infs[colid]; - htrAddScriptInit_va(s,"{name:\"%STR&JSSTR\",ns:\"%STR&JSSTR\",fieldname:\"%STR&JSSTR\",sort_fieldname:\"%STR&JSSTR\",title:\"%STR&JSSTR\",width:%INT,type:\"%STR&JSSTR\",group:%POS,align:\"%STR&JSSTR\",wrap:\"%STR&JSSTR\",caption_fieldname:\"%STR&JSSTR\",caption_textcolor:\"%STR&JSSTR\",image_maxwidth:%POS,image_maxheight:%POS},", - col->wname, - col->wnamespace, - col->fieldname, - col->sort_fieldname, - col->title, - col->width, - col->type, - col->group[0]?1:0, - col->align, - col->wrap, - col->caption_fieldname, - col->caption_textcolor, - col->image_maxwidth, - col->image_maxheight - ); + httbl_col* col = t->col_infs[colid]; + htrAddScriptInit_va(s, + "{ " + "name:'%STR&JSSTR', " + "ns:'%STR&JSSTR', " + "fieldname:'%STR&JSSTR', " + "sort_fieldname:'%STR&JSSTR', " + "title:'%STR&JSSTR', " + "width:%INT, " + "type:'%STR&JSSTR', " + "group:%POS, " + "align:'%STR&JSSTR', " + "wrap:'%STR&JSSTR', " + "caption_fieldname:'%STR&JSSTR', " + "caption_textcolor:'%STR&JSSTR', " + "image_maxwidth:%POS, " + "image_maxheight:%POS, " + " }, ", + col->wname, + col->wnamespace, + col->fieldname, + col->sort_fieldname, + col->title, + col->width, + col->type, + col->group[0] ? 1 : 0, + col->align, + col->wrap, + col->caption_fieldname, + col->caption_textcolor, + col->image_maxwidth, + col->image_maxheight + ); } + /** Null terminate the array, and finish writing the init call. **/ htrAddScriptInit(s,"null]});\n"); - htrAddBodyItem_va(s,"
\n",t->id); + /** Write HTML for the table base container. **/ + htrAddBodyItem_va(s,"
\n",t->id); - detailcnt = wgtrGetMatchingChildList(tree, "widget/table-row-detail", children, sizeof(children)/sizeof(pWgtrNode)); - //for (i=0;iChildren));i++) - for (i=0;iChildren), i); - // + pWgtrNode sub_tree = children[i]; + + /** Only affect table-row-detail widgets. **/ wgtrGetPropertyValue(sub_tree, "outer_type", DATA_T_STRING,POD(&ptr)); - wgtrGetPropertyValue(sub_tree, "name", DATA_T_STRING,POD(&nptr)); - if (strcmp(ptr, "widget/table-row-detail") == 0) { htrCheckNSTransition(s, tree, sub_tree); - if (wgtrGetPropertyValue(sub_tree,"height",DATA_T_INTEGER,POD(&h)) != 0) h = t->min_rowheight; - htrAddStylesheetItem_va(s,"\t#tbld%POSsub%POS { POSITION:absolute; VISIBILITY:hidden; LEFT:0px; TOP:0px; WIDTH:%POSpx; HEIGHT:%POSpx; Z-INDEX:%POS; } \n", - t->id, ++subcnt, t->w-(t->demand_scrollbar?0:18), h, z+1); + /** Write CSS for the table row detail. **/ + int h; + if (wgtrGetPropertyValue(sub_tree, "height", DATA_T_INTEGER, POD(&h)) != 0) h = t->min_rowheight; + htrAddStylesheetItem_va(s, + "\t#tbld%POSsub%POS { " + "position:absolute; " + "visibility:hidden; " + "left:0px; " + "top:0px; " + "width:"ht_flex_format"; " + "height:"ht_flex_format"; " + "z-index:%POS; " + "}\n", + t->id, ++subcnt, + ht_flex_w(t->w - (t->demand_scrollbar ? 0 : 18), tree), + ht_flex_h(h, tree), + z + 1 + ); + + /** Write HTML (including subwidgets). **/ htrAddBodyItem_va(s,"
\n", t->id, subcnt); htrRenderSubwidgets(s, sub_tree, z+2); htrAddBodyItem(s,"
\n"); + + /** Add linkage. **/ htrAddWgtrObjLinkage_va(s, sub_tree, "tbld%POSsub%POS", t->id, subcnt); - htrCheckAddExpression(s, sub_tree, nptr, "display_for"); + + /** Add 'display_for'. **/ + wgtrGetPropertyValue(sub_tree, "name", DATA_T_STRING,POD(&ptr)); + htrCheckAddExpression(s, sub_tree, ptr, "display_for"); htrCheckNSTransitionReturn(s, tree, sub_tree); } - //else if (strcmp(ptr,"widget/table-column") != 0) //got columns earlier - //{ - //htrRenderWidget(s, sub_tree, z+3); - //} } htrRenderSubwidgets(s, tree, z+2); + /** Close the base container. **/ htrAddBodyItem(s,"
\n"); - /** HTML body
element for the scrollbar layer. **/ - htrAddBodyItem_va(s,"
\n",t->id); - htrAddBodyItem(s,"\n"); - htrAddBodyItem(s,"\n"); - htrAddBodyItem_va(s,"\n", t->id, t->h-2*18-first_offset); - htrAddBodyItem(s,"\n"); - htrAddBodyItem(s,"
\n"); - /*htrAddBodyItem_va(s,"
\n",t->id);*/ - htrAddBodyItem_va(s,"
\n",t->id); - htrAddBodyItem(s,"
\n"); - + /** Write HTML for the scrollbar. **/ + htrAddBodyItem_va(s, + "
\n" + "\n" + "\n" + "\n" + "\n" + "
\n" + "
\n" + "
\n", + t->id, t->id, ht_flex_h(t->h - row_start_y - 2*18, tree), t->id + ); + + /** Register event handlers. **/ htrAddEventHandlerFunction(s,"document","MOUSEOVER","tbld","tbld_mouseover"); htrAddEventHandlerFunction(s,"document","MOUSEOUT","tbld","tbld_mouseout"); htrAddEventHandlerFunction(s,"document","MOUSEDOWN","tbld","tbld_mousedown"); @@ -288,14 +441,18 @@ httblRender(pHtSession s, pWgtrNode tree, int z) { pWgtrNode sub_tree; char* ptr; - char* nptr; int n, i; httbl_struct* t; int rval; pWgtrNode children[HTTBL_MAX_COLS]; httbl_col* col; - /** Don't try to render table-column, etc. We do that elsewhere **/ + /*** Only render "widget/table". Other widgets (e.g. table-column or + *** table-row-detail) are rendered elsewhere (see links below). + *** + *** LINK #table-column + *** LINK #table-row-detail + ***/ wgtrGetPropertyValue(tree,"outer_type",DATA_T_STRING,POD(&ptr)); if (strcmp(ptr, "widget/table") != 0) return 0; @@ -304,154 +461,131 @@ httblRender(pHtSession s, pWgtrNode tree, int z) if (!t) return -1; memset(t, 0, sizeof(httbl_struct)); - t->x=-1; - t->y=-1; - - /** Get an id for thit. **/ + /** Get an id. **/ t->id = (HTTBL.idcnt++); - /** Backwards compat for the time being **/ - wgtrRenameProperty(tree, "row_bgcolor1", "row1_bgcolor"); - wgtrRenameProperty(tree, "row_background1", "row1_background"); - wgtrRenameProperty(tree, "row_bgcolor2", "row2_bgcolor"); - wgtrRenameProperty(tree, "row_background2", "row2_background"); - wgtrRenameProperty(tree, "row_bgcolorhighlight", "rowhighlight_bgcolor"); - wgtrRenameProperty(tree, "row_backgroundhighlight", "rowhighlight_background"); - - /** Get x,y,w,h of this object **/ - if (wgtrGetPropertyValue(tree,"x",DATA_T_INTEGER,POD(&(t->x))) != 0) t->x = -1; - if (wgtrGetPropertyValue(tree,"y",DATA_T_INTEGER,POD(&(t->y))) != 0) t->y = -1; - if (wgtrGetPropertyValue(tree,"width",DATA_T_INTEGER,POD(&(t->w))) != 0) t->w = -1; - if (wgtrGetPropertyValue(tree,"height",DATA_T_INTEGER,POD(&(t->h))) != 0) + /** Get name. **/ + if (wgtrGetPropertyValue(tree, "name", DATA_T_STRING, POD(&ptr)) != 0) { - mssError(1,"HTTBL","'height' property is required"); + nmFree(t, sizeof(httbl_struct)); return -1; } - if (wgtrGetPropertyValue(tree,"windowsize",DATA_T_INTEGER,POD(&(t->windowsize))) != 0) t->windowsize = -1; - if (wgtrGetPropertyValue(tree,"rowheight",DATA_T_INTEGER,POD(&n)) == 0) + strtcpy(t->name, ptr, sizeof(t->name)); + + /** Get object source path. **/ + if (wgtrGetPropertyValue(tree, "objectsource", DATA_T_STRING, POD(&ptr)) != 0) + strcpy(t->osrc, ""); + else + strtcpy(t->osrc, ptr, sizeof(t->osrc)); + + /** Get the location, size, and layout data. **/ + if (wgtrGetPropertyValue(tree, "x", DATA_T_INTEGER, POD(&(t->x))) != 0) t->x = -1; + if (wgtrGetPropertyValue(tree, "y", DATA_T_INTEGER, POD(&(t->y))) != 0) t->y = -1; + if (wgtrGetPropertyValue(tree, "width", DATA_T_INTEGER, POD(&(t->w))) != 0) t->w = -1; + if (wgtrGetPropertyValue(tree, "height", DATA_T_INTEGER, POD(&(t->h))) != 0) { - t->min_rowheight = t->max_rowheight = n; + mssError(1,"HTTBL","'height' property is required"); + return -1; } - else + if (wgtrGetPropertyValue(tree, "rowheight", DATA_T_INTEGER, POD(&n)) != 0) { t->min_rowheight = s->ClientInfo->ParagraphHeight + 2; t->max_rowheight = -1; } - wgtrGetPropertyValue(tree,"min_rowheight",DATA_T_INTEGER,POD(&(t->min_rowheight))); - wgtrGetPropertyValue(tree,"max_rowheight",DATA_T_INTEGER,POD(&(t->max_rowheight))); - if (wgtrGetPropertyValue(tree,"cellhspacing",DATA_T_INTEGER,POD(&(t->cellhspacing))) != 0) t->cellhspacing = 1; - if (wgtrGetPropertyValue(tree,"cellvspacing",DATA_T_INTEGER,POD(&(t->cellvspacing))) != 0) t->cellvspacing = 1; - - if (wgtrGetPropertyValue(tree,"colsep",DATA_T_INTEGER,POD(&(t->colsep))) != 0) t->colsep = 1; - if (wgtrGetPropertyValue(tree,"colsep_mode",DATA_T_STRING,POD(&ptr)) == 0) + else { - if (!strcasecmp(ptr, "full")) - t->colsep_mode = 0; - else if (!strcasecmp(ptr, "header")) - t->colsep_mode = 1; + t->min_rowheight = t->max_rowheight = n; } - - if (wgtrGetPropertyValue(tree,"rowcache_size",DATA_T_INTEGER,POD(&(t->rowcache_size))) != 0) t->rowcache_size = 0; - - t->dragcols = htrGetBoolean(tree, "dragcols", 1); - t->gridinemptyrows = htrGetBoolean(tree, "gridinemptyrows", 1); + if (wgtrGetPropertyValue(tree, "inner_padding", DATA_T_INTEGER, POD(&(t->inner_padding))) != 0) t->inner_padding = 0; + if (wgtrGetPropertyValue(tree, "min_rowheight", DATA_T_INTEGER, POD(&(t->min_rowheight))) != 0); /* Keep value from above. */ + if (wgtrGetPropertyValue(tree, "max_rowheight", DATA_T_INTEGER, POD(&(t->max_rowheight))) != 0); /* Keep value from above. */ + if (wgtrGetPropertyValue(tree, "cellhspacing", DATA_T_INTEGER, POD(&(t->cellhspacing))) != 0) t->cellhspacing = 1; + if (wgtrGetPropertyValue(tree, "cellvspacing", DATA_T_INTEGER, POD(&(t->cellvspacing))) != 0) t->cellvspacing = 1; + + /** Get selection data. **/ t->allow_selection = htrGetBoolean(tree, "allow_selection", 1); t->show_selection = htrGetBoolean(tree, "show_selection", 1); - if (wgtrGetPropertyType(tree, "initial_selection") == DATA_T_STRING && wgtrGetPropertyValue(tree,"initial_selection",DATA_T_STRING,POD(&ptr)) == 0 && !strcasecmp(ptr,"noexpand")) + if (wgtrGetPropertyType(tree, "initial_selection") == DATA_T_STRING + && wgtrGetPropertyValue(tree, "initial_selection", DATA_T_STRING, POD(&ptr)) == 0 + && strcasecmp(ptr, "noexpand") == 0) t->initial_selection = 2; else t->initial_selection = htrGetBoolean(tree, "initial_selection", 1); - t->allow_deselection = htrGetBoolean(tree, "allow_deselection", t->initial_selection?0:1); - t->reverse_order = htrGetBoolean(tree, "reverse_order", 0); + t->allow_deselection = htrGetBoolean(tree, "allow_deselection", (t->initial_selection) ? 0 : 1); + /** Get scrollbar data. **/ t->overlap_scrollbar = htrGetBoolean(tree, "overlap_scrollbar", 0); t->hide_scrollbar = htrGetBoolean(tree, "hide_scrollbar", 0); t->demand_scrollbar = htrGetBoolean(tree, "demand_scrollbar", 0); - t->has_header = htrGetBoolean(tree, "titlebar", 1); - - /** Which data mode to use? **/ - if (wgtrGetPropertyValue(tree,"data_mode", DATA_T_STRING, POD(&ptr)) == 0) + + /** Get theme data (colors, backgrounds, etc.). **/ + if (wgtrGetPropertyValue(tree, "textcolor", DATA_T_STRING, POD(&ptr)) == 0) + strtcpy(t->textcolor, ptr, sizeof(t->textcolor)); + if (wgtrGetPropertyValue(tree, "textcolorhighlight", DATA_T_STRING, POD(&ptr)) == 0) + strtcpy(t->textcolorhighlight, ptr, sizeof(t->textcolorhighlight)); + if (wgtrGetPropertyValue(tree, "titlecolor", DATA_T_STRING, POD(&ptr)) == 0) + strtcpy(t->titlecolor, ptr, sizeof(t->titlecolor)); + if (!*t->titlecolor) strcpy(t->titlecolor, t->textcolor); + htrGetBackground(tree, "colsep", !s->Capabilities.Dom0NS, t->colsep_bgnd, sizeof(t->colsep_bgnd)); + htrGetBackground(tree, "hdr", !s->Capabilities.Dom0NS, t->hdr_bgnd, sizeof(t->hdr_bgnd)); + htrGetBackground(tree, "newrow", !s->Capabilities.Dom0NS, t->newrow_bgnd, sizeof(t->newrow_bgnd)); + if (wgtrGetPropertyValue(tree, "textcolornew", DATA_T_STRING, POD(&ptr)) == 0) + strtcpy(t->newrow_textcolor, ptr, sizeof(t->newrow_textcolor)); + + /** Get general row data. **/ + if (wgtrGetPropertyValue(tree, "data_mode", DATA_T_STRING, POD(&ptr)) != 0) + t->data_mode = 0; + else { - if (!strcmp(ptr, "rows")) - t->data_mode = 0; - else if (!strcmp(ptr, "properties")) - t->data_mode = 1; + if (strcasecmp(ptr, "rows") == 0) t->data_mode = 0; + else if (strcasecmp(ptr, "properties") == 0) t->data_mode = 1; + else + { + mssError(1, "TBL", "Invalid value for attribute 'data_mode': %s", ptr); + return -1; + } } + t->has_header = htrGetBoolean(tree, "titlebar", 1); /* Whether to render a header row. */ + t->grid_in_empty_rows = htrGetBoolean(tree, "gridinemptyrows", 1); /* Whether to show the grid in empty rows. */ + if (wgtrGetPropertyValue(tree, "windowsize", DATA_T_INTEGER, POD(&(t->windowsize))) != 0) t->windowsize = -1; + if (wgtrGetPropertyValue(tree, "rowcache_size", DATA_T_INTEGER, POD(&(t->rowcache_size))) != 0) t->rowcache_size = 0; - /** Should we follow the current record around? **/ - t->followcurrent = htrGetBoolean(tree, "followcurrent", 1); - - /** Get name **/ - if (wgtrGetPropertyValue(tree,"name",DATA_T_STRING,POD(&ptr)) != 0) + /** Get general column data. **/ + t->dragcols = htrGetBoolean(tree, "dragcols", 1); + if (wgtrGetPropertyValue(tree, "colsep", DATA_T_INTEGER, POD(&(t->colsep))) != 0) t->colsep = 1; + if (wgtrGetPropertyValue(tree, "colsep_mode", DATA_T_STRING, POD(&ptr)) != 0) + t->colsep_mode = 0; + else { - nmFree(t, sizeof(httbl_struct)); - return -1; + if (strcasecmp(ptr, "full") == 0) t->colsep_mode = 0; + else if (strcasecmp(ptr, "header") == 0) t->colsep_mode = 1; + else + { + mssError(1, "TBL", "Invalid value for attribute 'colsep_mode': %s", ptr); + return -1; + } } - strtcpy(t->name,ptr,sizeof(t->name)); - - if (wgtrGetPropertyValue(tree,"objectsource",DATA_T_STRING,POD(&ptr)) == 0) - strtcpy(t->osrc,ptr,sizeof(t->osrc)); - else - strcpy(t->osrc,""); - - /** Get background color/image for table header **/ - htrGetBackground(tree, NULL, !s->Capabilities.Dom0NS, t->tbl_bgnd, sizeof(t->tbl_bgnd)); - - /** Get background color/image for header row **/ - htrGetBackground(tree, "hdr", !s->Capabilities.Dom0NS, t->hdr_bgnd, sizeof(t->hdr_bgnd)); - - /** Get background color/image for rows **/ - htrGetBackground(tree, "row1", !s->Capabilities.Dom0NS, t->row_bgnd1, sizeof(t->row_bgnd1)); - htrGetBackground(tree, "row2", !s->Capabilities.Dom0NS, t->row_bgnd2, sizeof(t->row_bgnd2)); - htrGetBackground(tree, "rowhighlight", !s->Capabilities.Dom0NS, t->row_bgndhigh, sizeof(t->row_bgndhigh)); - htrGetBackground(tree, "colsep", !s->Capabilities.Dom0NS, t->colsep_bgnd, sizeof(t->colsep_bgnd)); - htrGetBackground(tree, "newrow", !s->Capabilities.Dom0NS, t->newrow_bgnd, sizeof(t->newrow_bgnd)); - - /** Get borders and padding information **/ - wgtrGetPropertyValue(tree,"outer_border",DATA_T_INTEGER,POD(&(t->outer_border))); - wgtrGetPropertyValue(tree,"inner_border",DATA_T_INTEGER,POD(&(t->inner_border))); - wgtrGetPropertyValue(tree,"inner_padding",DATA_T_INTEGER,POD(&(t->inner_padding))); - - /** Row decorations **/ - wgtrGetPropertyValue(tree, "row_border_color", DATA_T_STRING, POD(&t->row_border)); - wgtrGetPropertyValue(tree, "row_shadow_color", DATA_T_STRING, POD(&t->row_shadow_color)); - wgtrGetPropertyValue(tree, "row_shadow_offset", DATA_T_INTEGER, POD(&t->row_shadow)); - wgtrGetPropertyValue(tree, "row_shadow_radius", DATA_T_INTEGER, POD(&t->row_shadow_radius)); - wgtrGetPropertyValue(tree, "row_border_radius", DATA_T_INTEGER, POD(&t->row_radius)); - - /** Text color information **/ - if (wgtrGetPropertyValue(tree,"textcolor",DATA_T_STRING,POD(&ptr)) == 0) - strtcpy(t->textcolor,ptr,sizeof(t->textcolor)); - - /** Text color information **/ - if (wgtrGetPropertyValue(tree,"textcolorhighlight",DATA_T_STRING,POD(&ptr)) == 0) - strtcpy(t->textcolorhighlight,ptr,sizeof(t->textcolorhighlight)); - /** Text color information for "new row" in process of being created **/ - if (wgtrGetPropertyValue(tree,"textcolornew",DATA_T_STRING,POD(&ptr)) == 0) - strtcpy(t->newrow_textcolor,ptr,sizeof(t->newrow_textcolor)); - - /** Title text color information **/ - if (wgtrGetPropertyValue(tree,"titlecolor",DATA_T_STRING,POD(&ptr)) == 0) - strtcpy(t->titlecolor,ptr,sizeof(t->titlecolor)); - if (!*t->titlecolor) strcpy(t->titlecolor,t->textcolor); - - /** Get column data **/ + /** Get specific column data for each column. **/ t->ncols = wgtrGetMatchingChildList(tree, "widget/table-column", children, sizeof(children)/sizeof(pWgtrNode)); for (i=0;incols;i++) { sub_tree = children[i]; + + /** Only read table-column widgets. **/ wgtrGetPropertyValue(sub_tree, "outer_type", DATA_T_STRING,POD(&ptr)); - wgtrGetPropertyValue(sub_tree, "name", DATA_T_STRING,POD(&nptr)); - if (!strcmp(ptr,"widget/table-column") != 0) + if (strcmp(ptr, "widget/table-column") == 0) { + /** Allocate space to store the column data. **/ col = (httbl_col*)nmMalloc(sizeof(httbl_col)); memset(col, 0, sizeof(*col)); + + /** Basic column info. **/ t->col_infs[i] = col; strtcpy(col->wname, wgtrGetName(sub_tree), sizeof(col->wname)); strtcpy(col->wnamespace, wgtrGetNamespace(sub_tree), sizeof(col->wnamespace)); - /** no layer associated with this guy **/ + /** The object system doesn't need to render this widget (we will do that). **/ sub_tree->RenderFlags |= HT_WGTF_NOOBJECT; /** Get column properties **/ @@ -470,8 +604,9 @@ httblRender(pHtSession s, pWgtrNode tree, int z) strtcpy(col->title, ptr, sizeof(col->title)); else strtcpy(col->title, col->fieldname, sizeof(col->title)); - htrCheckAddExpression(s, sub_tree, nptr, "title"); - htrCheckAddExpression(s, sub_tree, nptr, "visible"); + wgtrGetPropertyValue(sub_tree, "name", DATA_T_STRING, POD(&ptr)); + htrCheckAddExpression(s, sub_tree, ptr, "title"); + htrCheckAddExpression(s, sub_tree, ptr, "visible"); if (wgtrGetPropertyValue(sub_tree, "align", DATA_T_STRING,POD(&ptr)) == 0) strtcpy(col->align, ptr, sizeof(col->align)); else @@ -489,7 +624,10 @@ httblRender(pHtSession s, pWgtrNode tree, int z) } } + /** Render the table. **/ rval = httblRenderDynamic(s, tree, z, t); + + /** Clean up. **/ for(i=0;incols;i++) nmFree(t->col_infs[i], sizeof(httbl_col)); nmFree(t, sizeof(httbl_struct)); @@ -505,25 +643,26 @@ httblInitialize() { pHtDriver drv; - /** Allocate the driver **/ + /** Allocate the driver struct. **/ drv = htrAllocDriver(); if (!drv) return -1; - /** Fill in the structure. **/ + /** Initialize driver values. **/ strcpy(drv->Name,"DHTML DataTable Driver"); strcpy(drv->WidgetName,"table"); drv->Render = httblRender; xaAddItem(&(drv->PseudoTypes), "table-column"); xaAddItem(&(drv->PseudoTypes), "table-row-detail"); + /** Add driver events. **/ htrAddEvent(drv,"Click"); htrAddEvent(drv,"DblClick"); - /** Register. **/ + /** Register the driver, with dhtml support. **/ htrRegisterDriver(drv); - htrAddSupport(drv, "dhtml"); + /** Initialize the ID counter. **/ HTTBL.idcnt = 0; return 0; From 2354c9a91f0343518f685a11a42ef9addf285ed8 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Mon, 9 Feb 2026 12:58:50 -0700 Subject: [PATCH 101/275] Make table widget front end code responsive (I think). Add a resize observer to reflow widths and update the rows, scroll thumb, and no data message when the page was resized. Add code to allow changing column width using any row (not just the header row). Rewrite tbld_change_width() to be better in almost every way (might fix some bugs). Rewrite tbl_reflow_width() to be far easier to read (might fix some bugs). Rewrite tbl_apply_row_geom() to be faster and better in general (might fix some bugs). Refactor no data message handling to reduce duplicate code. Rename box to scroll thumb for clarity and consistency. Remove code that stored attributes in the table even though they were never used. Improve code readability by using Math.clamp(). Improve code readability by using some JS best practices. Improve code readability by using the ?. syntax. Reorder some initialization code for more readable grouping. Revise comments to make them more useful. Add a small amount of doc comments. Add some useful comments. Clean up unused comments. Clean up unused logging. Clean up unused comments about unused logging. --- centrallix-os/sys/js/htdrv_table.js | 466 +++++++++++++++------------- 1 file changed, 251 insertions(+), 215 deletions(-) diff --git a/centrallix-os/sys/js/htdrv_table.js b/centrallix-os/sys/js/htdrv_table.js index 19c5c7d5e..328870cf4 100644 --- a/centrallix-os/sys/js/htdrv_table.js +++ b/centrallix-os/sys/js/htdrv_table.js @@ -12,6 +12,31 @@ window.tbld_touches = []; +const tbld_resize_observer = new ResizeObserver((entries) => entries.forEach(({ + contentRect: { width, height }, + target: table +}) => + { + // Set the new size. + table.param_width = width; + table.param_height = height; + + // Update scroll thumb and reflow the columns. + table.UpdateThumb(false); + table.ReflowWidth(width); + table.UpdateNDM($(table).children('#ndm')); + + // Resize all rows. + const { rows } = table; + for (let i = (table.has_header) ? 0 : rows.first; i <= rows.last; i++) + { + const row = rows[i]; + if (!row) continue; + $(row).css({ width: (row.w = width) }); + } + } +)); + function tbld_log_status() { var rowstr = ''; @@ -60,27 +85,33 @@ function tbld_format_cell(cell, color) var bartext = wgtrGetServerProperty(wgtrFindDescendent(this, this.cols[cell.colnum].name, this.cols[cell.colnum].ns), 'bar_textcolor'); if (!bartext) bartext = 'black'; bartext = String(bartext).replace(/[^a-z0-9A-Z#]/g, ""); - var actpct = '' + (100 * ((val < 0)?0:((val > 1)?1:val))) + '%'; - actpct = String(actpct).replace(/[^0-9.%]/g, ""); - var pct = '' + (Math.round(val * 100 / roundto) * roundto) + '%'; + const width_percent = ('' + (100 * Math.clamp(0, val, 1)) + '%').replace(/[^0-9.%]/g, ""); + const percent = '' + (Math.round(val * 100 / roundto) * roundto) + '%'; if (val >= 0.5) { - innertxt = pct + ' '; + innertxt = percent + ' '; outertxt = ''; } else { innertxt = ' '; - outertxt = ' ' + pct; + outertxt = ' ' + percent; } - txt = '
' + - '
' + - htutil_encode(innertxt) + - '
' + - (outertxt?('' + - htutil_encode(outertxt) + - ''):'') + - '
'; + txt = + '
' + + '
' + + htutil_encode(innertxt) + + '
' + + ((outertxt) ? ('= min) - { - ndm.hide(); - } - else - { - ndm.show(); - ndm.text(wgtrGetServerProperty(this,"nodata_message")); - ndm.css({"top":((this.param_height - ndm.height())/2) + "px", "color":wgtrGetServerProperty(this,"nodata_message_textcolor") }); - } + // Redraw the no data message. + var $ndm = $(this).children('#ndm'); + if (max >= min) $ndm.hide(); + else this.UpdateNDM($ndm); // (re)draw the loaded records var selected_position_changed = false; @@ -566,19 +588,12 @@ function tbld_get_selected_geom() return { x:$(obj).offset().left, y:$(obj).offset().top, width:$(obj).width(), height:$(obj).height() }; } - -function tbld_css_height(element, seth) - { - if (seth == null) - { - return parseFloat($(element).css("height")); - } - else - { - $(element).css("height",seth + "px"); - } - } - +function tbld_get_height(node) { + return parseFloat($(node).css("height")); +} +function tbld_set_height(node, new_height) { + $(node).css("height", new_height + "px"); +} function tbld_update_height(row) { @@ -597,8 +612,8 @@ function tbld_update_height(row) h = this.max_rowheight - this.cellvspacing*2; if (h < this.min_rowheight - this.cellvspacing*2) h = this.min_rowheight - this.cellvspacing*2; - if (tbld_css_height(col) != h) - tbld_css_height(col,h); + if (tbld_get_height(col) != h) + tbld_set_height(col, h); if (h > maxheight) maxheight = h; } @@ -617,10 +632,11 @@ function tbld_update_height(row) } // No change? - if (tbld_css_height(row) == maxheight + this.innerpadding*2) + const new_height = maxheight + this.innerpadding*2; + if (tbld_get_height(row) === new_height) return false; - tbld_css_height(row,maxheight + this.innerpadding*2); + tbld_set_height(row, new_height); return true; } @@ -686,7 +702,6 @@ function tbld_format_row(id, selected, do_new) function tbld_bring_into_view(rownum) { - //this.log.push("tbld_bring_into_view(" + rownum + ")"); this.bring_into_view = null; // Clamp the requested row to the available range @@ -939,10 +954,10 @@ function tbld_detail_showcontainer() } } - +/** @param dw The detail widget DOM node. **/ function tbld_update_detail(dw) { - if (dw.display_for && (this.table.initselect !== 2 || (this.table.initselect == 2 && dw.on_new)) /* 2 = noexpand */ && (!dw.on_new || wgtrGetServerProperty(dw, 'show_on_new', 0))) + if (dw.display_for && ((dw.on_new) ? (this.table.initselect !== 2) : wgtrGetServerProperty(dw, 'show_on_new', 0))) { var found=false; for(var j=0; jl.row.w) - // move = l.row.w - rw - colinfo.xoffset - colinfo.width; - if(colinfo.xoffset+colinfo.width+rw+move<0) - move=0-colinfo.xoffset-rw; - if (colinfo.width + move < 3) - move = 3-colinfo.width; - if(l.resizebdr.xoffset+move<0) - move=0-l.resizebdr.xoffset; - //if(getPageX(l.resizebdr) + t.colsep + t.bdr_width*2 + move >= getPageX(t) + t.param_width) - // move = getPageX(t) + t.param_width - getPageX(l.resizebdr) - t.colsep - t.bdr_width*2; + if (col_info_xoffset + col_info_width + rw + move < 0) + move = 0 - col_info_xoffset - rw; + if (col_info_width + move < 3) + move = 3 - col_info_width; + if (resizebdr && resizebdr.xoffset + move < 0) + move = 0 - resizebdr.xoffset; // Figure how much space on the right of this resize handle we're adjusting, too... - var cols_right = t.colcount - l.colnum - 1; - var adj = []; - var total_right_width = 0; - for(var j=l.colnum+1; j= t.rows.first) - { - if (t.ApplyRowGeom(t.rows[i], l.colnum) && t.min_rowheight != t.max_rowheight) + const updated_rows = []; + const { first, last } = rows; + const inflexible_row_height = (t.min_rowheight === t.max_rowheight); + for (let i = 0; i <= last; i++) + { + if (i < first && i !== 0) continue; + + const rowi = rows[i]; + if (!t.ApplyRowGeom(rowi, colnum) || inflexible_row_height) continue; + + // Need to update height of row? + if (!t.UpdateHeight(rowi)) continue; + + for (let j = i + 1; j <= last; j++) + { + const rowj = rows[j]; + if (rowj.positioned) { - // Need to update height of row? - if (t.UpdateHeight(t.rows[i])) - { - for(var j=i+1; j<=t.rows.last; j++) - { - if (t.rows[j].positioned) - { - t.rows[j].positioned = false; - upd_rows.push(t.rows[j]); - } - } - } + rowj.positioned = false; + updated_rows.push(rowj); } } } - if (upd_rows.length) + + if (updated_rows.length) { - t.PositionRows(upd_rows); + t.PositionRows(updated_rows); t.CheckBottom(); } @@ -1397,40 +1410,34 @@ function tbld_change_width(move, compensate) } -function tbld_reflow_width() +function tbld_reflow_width(new_width) { - if (this.hdrrow) - { - var logstr = 'Before reflow widths:'; - var ttl = 0; - for(var i=0; i 0 || this.dragcols) - new_w -= (this.bdr_width*2 + this.colsep); - $(c).width(new_w); - setRelativeX(c, this.cols[j].xoffset); - if (this.cols[j].wrap != 'no') - change_wrapped_cell = true; + const target_col = target_cols[i], this_col = this_cols[i]; + let new_w = this_col.width; // - this.innerpadding*2; + + if (colsep > 0 || dragcols) new_w -= (bdr_width*2 + colsep); + + $(target_col).width(new_w); + fast_setRelativeX(target_col, this_col.xoffset); + + change_wrapped_cell |= (this_col.wrap != 'no'); } return change_wrapped_cell; } @@ -1604,7 +1615,6 @@ function tbld_remove_row(rowobj) } if (this.rows.firstvis > this.rows.lastvis) { - console.log('TABLE ' + this.__WgtrName + ': resetting firstvis/lastvis to null (firstvis > lastvis)'); this.rows.firstvis = null; this.rows.lastvis = null; } @@ -1687,12 +1697,14 @@ function tbld_display_row(rowobj, rowslot) if (!this.rows.lastvis || this.rows.lastvis < rowslot) this.rows.lastvis = rowslot; } - if (getRelativeY(rowobj) < this.scroll_minheight || this.scroll_minheight == null) - this.scroll_minheight = getRelativeY(rowobj); + const rowY = getRelativeY(rowobj); + if (rowY < this.scroll_minheight || this.scroll_minheight == null) + this.scroll_minheight = rowY; if (rowslot < this.scroll_minrec || this.scroll_minrec == null) this.scroll_minrec = rowslot; - if (rowslot == this.rows.lastosrc || (getRelativeY(rowobj) + $(rowobj).height() + this.cellvspacing*2 > this.scroll_maxheight)) - this.scroll_maxheight = getRelativeY(rowobj) + $(rowobj).height() + this.cellvspacing*2; + const rowHeight = $(rowobj).height(); + if (rowslot == this.rows.lastosrc || (rowY + rowHeight + this.cellvspacing*2 > this.scroll_maxheight)) + this.scroll_maxheight = rowY + rowHeight + this.cellvspacing*2; if (rowslot > this.scroll_maxrec) this.scroll_maxrec = rowslot; } @@ -1843,16 +1855,12 @@ function tbld_osrc_dispatch() case 'ScrollTo': this.osrc_busy = true; this.osrc_last_op = item.type; - //this.log.push("Calling ScrollTo(" + item.start + "," + item.end + ") on osrc, stat=" + (this.osrc.pending?'pending':'not-pending')); - //console.log("Calling ScrollTo(" + item.start + "," + item.end + ") on osrc, stat=" + (this.osrc.pending?'pending':'not-pending')); this.osrc.ScrollTo(item.start, item.end); break; case 'MoveToRecord': this.osrc_busy = true; this.osrc_last_op = item.type; - //this.log.push("Calling MoveToRecord(" + item.rownum + ") on osrc, stat=" + (this.osrc.pending?'pending':'not-pending')); - //console.log("Calling MoveToRecord(" + item.rownum + ") on osrc, stat=" + (this.osrc.pending?'pending':'not-pending')); this.osrc.MoveToRecord(item.rownum, this); break; @@ -1934,8 +1942,11 @@ function tbld_init(param) { var t = param.table; var scroll = param.scroll; + + // Initialize table. ifc_init_widget(t); t.table = t; + t.name = param.name; // Debug value. t.param_width = param.width; t.param_height = param.height; t.dragcols = param.dragcols; @@ -1955,12 +1966,15 @@ function tbld_init(param) t.cr = 0; t.is_new = 0; t.rowdivcache = []; - t.followcurrent = param.followcurrent>0?true:false; t.hdr_bgnd = param.hdrbgnd; htr_init_layer(t, t, "tabledynamic"); + + // Initialize scrollbar. t.scrollbar = scroll; htr_init_layer(t.scrollbar, t, "tabledynamic"); t.scrollbar.Click = tbld_bar_click; + + // Initialize scrollbar images. var imgs = pg_images(t.scrollbar); for(var img in imgs) { @@ -1971,29 +1985,23 @@ function tbld_init(param) else if (imgs[img].name == 'd') t.down = imgs[img]; } - t.box=htr_subel(scroll,param.boxname); - htr_init_layer(t.box, t, "tabledynamic"); - t.scrollbar.b=t.box; + + // Initialize scroll thumb. + t.thumb = htr_subel(scroll, param.thumb_name); + htr_init_layer(t.thumb, t, "tabledynamic"); + t.scrollbar.b = t.thumb; + + // Initialize events for scrolling. t.up.Click=tbld_up_click; t.down.Click=tbld_down_click; - t.box.Click = new Function( ); - t.scrollbar.table = t.up.table = t.down.table = t.box.table = t; + t.thumb.Click = new Function(); + t.scrollbar.table = t.up.table = t.down.table = t.thumb.table = t; t.up.subkind='up'; t.down.subkind='down'; - t.box.subkind='box'; + t.thumb.subkind='thumb'; t.scrollbar.subkind='bar'; - /*t.dispatch_queue = {}; - t.dispatch_parallel_max = 1; - t.Dispatch = tbld_dispatch; - t.Request = tbld_request;*/ - t.osrc_request_queue = []; - t.osrc_busy = false; - t.osrc_last_op = null; - //t.log = []; - t.ttf_string = ''; - t.selected_row = null; - t.selected = null; + // Initialize layout data. t.rowheight=param.min_rowheight>0?param.min_rowheight:15; t.min_rowheight = param.min_rowheight; t.max_rowheight = param.max_rowheight; @@ -2004,9 +2012,6 @@ function tbld_init(param) t.textcolorhighlight=param.textcolorhighlight?param.textcolorhighlight:param.textcolor; t.textcolornew=param.newrow_textcolor; t.titlecolor=param.titlecolor; - t.row_bgnd1=param.rowbgnd1?param.rowbgnd1:"bgcolor='white'"; - t.row_bgnd2=param.rowbgnd2?param.rowbgnd2:t.row_bgnd1; - t.row_bgndhigh=param.rowbgndhigh?param.rowbgndhigh:"bgcolor='black'"; t.row_bgndnew=param.newrow_bgnd; t.cols=param.cols; t.colcount=0; @@ -2017,17 +2022,29 @@ function tbld_init(param) else delete t.cols[i]; } - if (param.osrc) - t.osrc = wgtrGetNode(t, param.osrc, "widget/osrc"); - else - t.osrc = wgtrFindContainer(t, "widget/osrc"); - if(!t.osrc || !(t.colcount>0)) + if (t.colcount <= 0) { - alert('table widget requires an objectsource and at least one column'); + alert('The table widget requires at least one column'); return t; } - - // Main table widget methods + + // Initialize ObjectSource values. + t.osrc_request_queue = []; + t.osrc_busy = false; + t.osrc_last_op = null; + t.ttf_string = ''; + t.selected_row = null; + t.selected = null; + t.osrc = (param.osrc) + ? wgtrGetNode(t, param.osrc, "widget/osrc") + : wgtrFindContainer(t, "widget/osrc"); + if (!t.osrc) + { + alert('The table widget requires an ObjectSource'); + return t; + } + + // Bind table widget functions. t.RedrawAll = tbld_redraw_all; t.InstantiateRow = tbld_instantiate_row; t.DisplayRow = tbld_display_row; @@ -2050,7 +2067,7 @@ function tbld_init(param) t.SchedScroll = tbld_sched_scroll; t.CheckBottom = tbld_check_bottom; t.ApplyRowGeom = tbld_apply_row_geom; - t.InitBH = tbld_init_bh; + t.UpdateNDM = tbld_update_ndm; t.OsrcDispatch = tbld_osrc_dispatch; t.OsrcRequest = tbld_osrc_request; t.EndTTF = tbld_end_ttf; @@ -2071,6 +2088,7 @@ function tbld_init(param) t.ObjectModified = tbld_object_modified; t.osrc.Register(t); + // Set the number or records visible in the table at one time. if (param.windowsize > 0) { t.windowsize = param.windowsize; @@ -2090,12 +2108,15 @@ function tbld_init(param) if (t.datamode != 1 && t.windowsize > t.osrc.replicasize) t.windowsize = t.osrc.replicasize; + // Handle header row. t.totalwindowsize = t.windowsize + 1; if (!t.has_header) t.windowsize = t.totalwindowsize; t.firstdatarow = t.has_header?1:0; - // Handle column resizing and columns without widths + /*** Handle columns without widths by assigning a default and resizing other + *** columns proportionally. + ***/ var total_w = 0; for (var i in t.cols) { @@ -2125,11 +2146,10 @@ function tbld_init(param) t.grpby = i; } + // Set some other values. t.maxwindowsize = t.windowsize; t.maxtotalwindowsize = t.totalwindowsize; t.rows = {first:null, last:null, firstvis:null, lastvis:null, lastosrc:null}; - setClipWidth(t, param.width); - setClipHeight(t, param.height); t.subkind='table'; t.bdr_width = (t.colsep > 0)?3:0; t.target_y = null; @@ -2208,6 +2228,7 @@ function tbld_init(param) } } + // Initialize scrollbar values. t.scroll_maxheight = null; t.scroll_maxrec = null; t.scroll_minheight = null; @@ -2220,6 +2241,7 @@ function tbld_init(param) // set working area height and scrollbar size t.UpdateGeom(); + // Initialize the scrollbar. t.scrolldiv = htr_new_layer(t.param_width, t.scrollctr); htr_init_layer(t.scrolldiv, t, "tabledynamic"); t.scrolldiv.subkind = "scrolldiv"; @@ -2238,11 +2260,23 @@ function tbld_init(param) if (window.tbld_mcurrent == undefined) window.tbld_mcurrent = null; + // Handle resizing. + tbld_resize_observer.observe(t); + // No data message - var ndm = document.createElement("div"); - $(ndm).css({"position":"absolute", "width":"100%", "text-align":"center", "left":"0px"}); - $(ndm).attr({"id":"ndm"}); - $(t).append(ndm); + var $ndm = $('
'); + $ndm[0].table = t; + $ndm.text(wgtrGetServerProperty(t, "nodata_message")); + $ndm.css({ + position: 'absolute', + width: '100%', + left: '0px', + textAlign: 'center', + color: wgtrGetServerProperty(t, "nodata_message_textcolor"), + }); + $ndm.show(); + $(t).append($ndm); + t.UpdateNDM($ndm); // Events var ie = t.ifcProbeAdd(ifEvent); @@ -2293,17 +2327,14 @@ function tbld_init(param) } } - t.InitBH(); - return t; } -function tbld_init_bh() +function tbld_update_ndm($ndm) { - var ndm = $(this).children('#ndm'); - ndm.show(); - ndm.text(wgtrGetServerProperty(this,"nodata_message")); - ndm.css({"top":((this.param_height - ndm.height())/2) + "px", "color":wgtrGetServerProperty(this,"nodata_message_textcolor") }); + $ndm.css({ + top: ((this.param_height - $ndm.height()) / 2) + "px", + }); } function tbld_touchstart(e) @@ -2584,7 +2615,9 @@ function tbld_keydown(e) for(var c in row.cols) { var col = row.cols[c]; - if (t.cols[col.colnum].type != 'check' && t.cols[col.colnum].type != 'image' && t.cols[col.colnum].type != 'checkbox') + if (t.cols[col.colnum].type != 'check' && + t.cols[col.colnum].type != 'image' && + t.cols[col.colnum].type != 'checkbox') { if (t.CheckHighlight(col, t.ttf_string)) { @@ -2675,7 +2708,7 @@ function tbld_mousedown(e) ly=ly.cell.row; } } - if (ly.subkind == 'box') + if (ly.subkind == 'thumb') { tbldx_current = ly; tbldx_start = e.pageY; @@ -2828,7 +2861,10 @@ function tbld_mousedown(e) } ly.row.table.osrc.ifcProbe(ifAction).Invoke("OrderObject", {orderobj:neworder}); } - if(ly.subkind=='up' || ly.subkind=='bar' || ly.subkind=='down' || ly.subkind=='box') + if (ly.subkind === 'up' + || ly.subkind === 'bar' + || ly.subkind === 'down' + || ly.subkind === 'thumb') { ly.Click(e); } @@ -2868,9 +2904,9 @@ function tbld_mousemove(e) var t = tbldx_current.table; if (tbldx_tstart + incr < 18) incr = 18 - tbldx_tstart; - if (tbldx_tstart + incr + $(t.box).height() > $(t.scrollbar).height() - 18 - 3) - incr = $(t.scrollbar).height() - 18 - 3 - tbldx_tstart - $(t.box).height(); - setRelativeY(t.box, tbldx_tstart + incr); + if (tbldx_tstart + incr + $(t.thumb).height() > $(t.scrollbar).height() - 18 - 3) + incr = $(t.scrollbar).height() - 18 - 3 - tbldx_tstart - $(t.thumb).height(); + setRelativeY(t.thumb, tbldx_tstart + incr); if (t.thumb_avail > t.thumb_height) { t.SchedScroll((-t.scroll_minheight) - Math.floor((tbldx_tstart + incr - 18)*t.thumb_sh/(t.thumb_avail - t.thumb_height))); @@ -2915,7 +2951,7 @@ function tbld_mouseup(e) if (t.colsep > 0 || t.dragcols) maxw += (t.bdr_width*2 + t.colsep); l.ChangeWidth(maxw-t.cols[l.colnum].width, true); - t.ReflowWidth(); + t.ReflowWidth(t.hdrrow.w); } else { From 467ac3c55ecae7ba19aae2c0a61c57a9b8f2cb48 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Wed, 11 Feb 2026 12:13:08 -0700 Subject: [PATCH 102/275] Improve button layout on radio button panel widgets. Add a spacing attribute to set the space between buttons (with documentation). Reorganize C generation code, greatly reducing unnecessary work and improving code readability and usability. Fix styling failures in htdrv_radiobutton.c. Add comments & clean up. --- centrallix-doc/Widgets/widgets.xml | 4 +- centrallix/htmlgen/htdrv_radiobutton.c | 583 ++++++++++++------------- 2 files changed, 294 insertions(+), 293 deletions(-) diff --git a/centrallix-doc/Widgets/widgets.xml b/centrallix-doc/Widgets/widgets.xml index 1a0104512..6267ffd08 100644 --- a/centrallix-doc/Widgets/widgets.xml +++ b/centrallix-doc/Widgets/widgets.xml @@ -3091,7 +3091,9 @@ my_cmp "widget/component-decl" A color, RGB or named, for the panel background. If neither bgcolor nor background transparent. Height, in pixels, of the panel. - + + The maximum height (in pixels) of space allowed between radio buttons on the panel (default: 10px). + An image to be used for the rectangular border drawn around the radio buttons. The color, RGB or named, of the text within the panel. Default: "black". diff --git a/centrallix/htmlgen/htdrv_radiobutton.c b/centrallix/htmlgen/htdrv_radiobutton.c index d5258ed5e..5946e048c 100644 --- a/centrallix/htmlgen/htdrv_radiobutton.c +++ b/centrallix/htmlgen/htdrv_radiobutton.c @@ -44,99 +44,144 @@ /** globals **/ -static struct { - int idcnt; -} HTRB; +static struct + { + int idcnt; + } + HTRB; /** htrbRender - generate the HTML code for the page. **/ -int htrbRender(pHtSession s, pWgtrNode tree, int z) { - char* ptr; - char name[64]; - char title[64]; - char sbuf2[200]; - //char bigbuf[4096]; - char textcolor[32]; - char main_background[128]; - char outline_background[128]; - char form[64]; - pWgtrNode radiobutton_obj, sub_tree; - int x=-1,y=-1,w,h; - int id, i, j; - int is_selected; - int raido_button_count; - char fieldname[32]; - char value[64]; - char label[64]; - - if(!s->Capabilities.Dom0NS && !s->Capabilities.Dom1HTML) - { - mssError(1,"HTRB","Netscape 4.x or W3C DOM support required"); - return -1; - } - - /** Get an id for this. **/ - id = (HTRB.idcnt++); - - /** Get x,y,w,h of this object **/ - if (wgtrGetPropertyValue(tree,"x",DATA_T_INTEGER,POD(&x)) != 0) x=0; - if (wgtrGetPropertyValue(tree,"y",DATA_T_INTEGER,POD(&y)) != 0) y=0; - if (wgtrGetPropertyValue(tree,"width",DATA_T_INTEGER,POD(&w)) != 0) { - mssError(1,"HTRB","RadioButtonPanel widget must have a 'width' property"); - return -1; - } - if (wgtrGetPropertyValue(tree,"height",DATA_T_INTEGER,POD(&h)) != 0) { - mssError(1,"HTRB","RadioButtonPanel widget must have a 'height' property"); - return -1; - } - - /** Background color/image? **/ - htrGetBackground(tree,NULL,!s->Capabilities.Dom0NS,main_background,sizeof(main_background)); - - /** Text color? **/ - if (wgtrGetPropertyValue(tree,"textcolor",DATA_T_STRING,POD(&ptr)) == 0) - strtcpy(textcolor,ptr,sizeof(textcolor)); - else - strcpy(textcolor,"black"); - - /** Outline color? **/ - htrGetBackground(tree,"outline",!s->Capabilities.Dom0NS,outline_background,sizeof(outline_background)); - - /** Get name **/ - if (wgtrGetPropertyValue(tree,"name",DATA_T_STRING,POD(&ptr)) != 0) return -1; - strtcpy(name,ptr,sizeof(name)); - - /** Get title **/ - if (wgtrGetPropertyValue(tree,"title",DATA_T_STRING,POD(&ptr)) != 0) return -1; - strtcpy(title,ptr,sizeof(title)); - - /** User requesting expression for selected tab? **/ - htrCheckAddExpression(s, tree, name, "value"); - - /** User requesting expression for selected tab using integer index value? **/ - htrCheckAddExpression(s, tree, name, "value_index"); - - /** Get fieldname **/ - if (wgtrGetPropertyValue(tree,"fieldname",DATA_T_STRING,POD(&ptr)) == 0) - { - strtcpy(fieldname,ptr,sizeof(fieldname)); - } - else - { - fieldname[0]='\0'; - } - - if (wgtrGetPropertyValue(tree,"form",DATA_T_STRING,POD(&ptr)) == 0) - strtcpy(form,ptr,sizeof(form)); - else - form[0]='\0'; - - htrAddScriptInclude(s, "/sys/js/htdrv_radiobutton.js", 0); - htrAddScriptInclude(s, "/sys/js/ht_utils_layers.js", 0); - +int htrbRender(pHtSession s, pWgtrNode tree, int z) + { + char* ptr; + + /** Verify required capabilities. **/ + if (!s->Capabilities.Dom0NS && !s->Capabilities.Dom1HTML) + { + mssError(1, "HTRB", "Netscape 4.x or W3C DOM support required"); + return -1; + } + + /** Get an id for this widget. **/ + const int id = (HTRB.idcnt++); + + /** Get x,y,w,h of this object. **/ + int x, y, w, h, spacing; + if (wgtrGetPropertyValue(tree, "x", DATA_T_INTEGER, POD(&x)) != 0) x = 0; + if (wgtrGetPropertyValue(tree, "y", DATA_T_INTEGER, POD(&y)) != 0) y = 0; + if (wgtrGetPropertyValue(tree, "width", DATA_T_INTEGER, POD(&w)) != 0) + { + mssError(1,"HTRB","RadioButtonPanel widget must have a 'width' property"); + return -1; + } + if (wgtrGetPropertyValue(tree, "height", DATA_T_INTEGER, POD(&h)) != 0) + { + mssError(1,"HTRB","RadioButtonPanel widget must have a 'height' property"); + return -1; + } + if (wgtrGetPropertyValue(tree, "spacing", DATA_T_INTEGER, POD(&spacing)) != 0) spacing = 10; + + /** Get the name and title attributes. **/ + char name[64] = "", title[64] = ""; + if (wgtrGetPropertyValue(tree, "name", DATA_T_STRING, POD(&ptr)) != 0) + { + mssError(1, "HTRB", "RadioButtonPanel widget must have a 'name' property"); + return -1; + } + strtcpy(name, ptr, sizeof(name)); + if (wgtrGetPropertyValue(tree, "title", DATA_T_STRING, POD(&ptr)) != 0) + { + mssError(1, "HTRB", "RadioButtonPanel widget must have a 'title' property"); + return -1; + } + strtcpy(title, ptr, sizeof(title)); + + /** Get text color attribute. **/ + char textcolor[32]; + if (wgtrGetPropertyValue(tree, "textcolor", DATA_T_STRING, POD(&ptr)) == 0) + strtcpy(textcolor, ptr, sizeof(textcolor)); + else + strcpy(textcolor, "black"); + + /** Get background attributes. **/ + char main_background[128] = ""; + char outline_background[128] = ""; + htrGetBackground(tree, NULL, !s->Capabilities.Dom0NS, main_background, sizeof(main_background)); + htrGetBackground(tree, "outline", !s->Capabilities.Dom0NS, outline_background, sizeof(outline_background)); + + /** User requesting expression for selected tab? **/ + htrCheckAddExpression(s, tree, name, "value"); + + /** User requesting expression for selected tab using integer index value? **/ + htrCheckAddExpression(s, tree, name, "value_index"); + + /** Get fieldname and form attributes. **/ + char fieldname[32] = "", form[64] = ""; + if (wgtrGetPropertyValue(tree, "fieldname", DATA_T_STRING, POD(&ptr)) == 0) + strtcpy(fieldname, ptr, sizeof(fieldname)); + if (wgtrGetPropertyValue(tree, "form", DATA_T_STRING, POD(&ptr)) == 0) + strtcpy(form, ptr, sizeof(form)); + + + /** Include scripts. **/ + htrAddScriptInclude(s, "/sys/js/htdrv_radiobutton.js", 0); + htrAddScriptInclude(s, "/sys/js/ht_utils_layers.js", 0); + + /** Link DOM node to widget data. **/ + htrAddWgtrObjLinkage_va(s, tree, "rb%POSparent", id); + htrAddWgtrCtrLinkage_va(s, tree, "htr_subel(htr_subel(_obj, 'rb%POSborder'), 'rb%POScover')", id, id); + + /** Script initialization call. **/ + if (strlen(main_background) > 0) + { + htrAddScriptInit_va(s, "{ " + "const parentPane = wgtrGetNodeRef(ns, '%STR&SYM'); " + "const borderPane = htr_subel(parentPane, 'rb%POSborder'); " + "const coverPane = htr_subel(borderPane, 'rb%POScover'); " + "const titlePane = htr_subel(parentPane, 'rb%POStitle'); " + "radiobuttonpanel_init({ " + "parentPane, borderPane, coverPane, titlePane, " + "fieldname:'%STR&JSSTR', " + "mainBackground:'%STR&JSSTR', " + "outlineBackground:'%STR&JSSTR', " + "form:'%STR&JSSTR', " + "}); }\n", + name, id, id, id, + fieldname, + main_background, + outline_background, + form + ); + } + else + { + htrAddScriptInit_va(s, + "radiobuttonpanel_init({ " + "parentPane:wgtrGetNodeRef(ns, '%STR&SYM'), " + "fieldname:'%STR&JSSTR', " + "borderPane:0, " + "coverPane:0, " + "titlePane:0, " + "mainBackground:0, " + "outlineBackground:0, " + "form:'%STR&JSSTR', " + "});\n", + name, + fieldname, + form + ); + } + + /** Add event listenners. **/ + htrAddEventHandlerFunction(s, "document", "MOUSEUP", "radiobutton", "radiobutton_mouseup"); + htrAddEventHandlerFunction(s, "document", "MOUSEDOWN", "radiobutton", "radiobutton_mousedown"); + htrAddEventHandlerFunction(s, "document", "MOUSEOVER", "radiobutton", "radiobutton_mouseover"); + htrAddEventHandlerFunction(s, "document", "MOUSEMOVE", "radiobutton", "radiobutton_mousemove"); + + /** Write style headers for container DOM nodes. **/ const int para_height = s->ClientInfo->ParagraphHeight; - fprintf(stderr, "h: %d\n", para_height); const int top_offset = (para_height * 3) / 4 + 1; htrAddStylesheetItem_va(s, "#rb%POSparent { " @@ -201,216 +246,173 @@ int htrbRender(pHtSession s, pWgtrNode tree, int z) { para_height, z + 3 ); - - htrAddScriptGlobal(s, "radiobutton", "null", 0); - - /** DOM linkages **/ - htrAddWgtrObjLinkage_va(s, tree, "rb%POSparent",id); - htrAddWgtrCtrLinkage_va(s, tree, "htr_subel(htr_subel(_obj,\"rb%POSborder\"),\"rb%POScover\")",id,id); - - /** Loop through each radiobutton and flag it NOOBJECT **/ - raido_button_count = 0; - for (j=0;jChildren));j++) - { - radiobutton_obj = xaGetItem(&(tree->Children), j); - radiobutton_obj->RenderFlags |= HT_WGTF_NOOBJECT; - wgtrGetPropertyValue(radiobutton_obj,"outer_type",DATA_T_STRING,POD(&ptr)); - if (strcmp(ptr,"widget/radiobutton") == 0) raido_button_count++; - } - /** Compute values for laying out radio buttons. **/ - const int cover_height = h - top_offset - 6; - int item_spacing = para_height + 12; - int cover_margin = 10; - if (item_spacing * raido_button_count + 2*cover_margin > cover_height) - item_spacing = (cover_height-2*cover_margin)/raido_button_count; - if (item_spacing * raido_button_count + 2*cover_margin > cover_height) - cover_margin = (cover_height-(item_spacing*raido_button_count))/2; - if (cover_margin < 2) cover_margin = 2; - i = 1; - for (j=0;jChildren));j++) - { - radiobutton_obj = xaGetItem(&(tree->Children), j); - wgtrGetPropertyValue(radiobutton_obj,"outer_type",DATA_T_STRING,POD(&ptr)); - if (!strcmp(ptr,"widget/radiobutton")) - { - htrAddStylesheetItem_va(s, - "#rb%POSoption%POS { " - "position:absolute; " - "visibility:inherit; " - "overflow:hidden; " - "left:7px; " - "top:%INTpx; " - "width:calc(100%% - 7px); " - "height:%POSpx; " - "z-index:%POS; " - "}\n", - id, i, - cover_margin + ((i-1) * item_spacing) + 2, - min(item_spacing, para_height + 4), - z + 2 - ); - i++; - } - } - - /** Script initialization call. **/ - if (strlen(main_background) > 0) { - htrAddScriptInit_va(s, - " var rb = wgtrGetNodeRef(ns, \"%STR&SYM\");\n" - " radiobuttonpanel_init({\n" - " parentPane:rb, fieldname:\"%STR&JSSTR\",\n" - " borderPane:htr_subel(rb,\"rb%POSborder\"),\n" - " coverPane:htr_subel(htr_subel(rb,\"rb%POSborder\"),\"rb%POScover\"),\n" - " titlePane:htr_subel(rb,\"rb%POStitle\"),\n" - " mainBackground:\"%STR&JSSTR\", outlineBackground:\"%STR&JSSTR\", form:\"%STR&JSSTR\"});\n", - name, fieldname, id, id,id, id, main_background, outline_background, form); - } else { - htrAddScriptInit_va(s," radiobuttonpanel_init({parentPane:wgtrGetNodeRef(ns,\"%STR&SYM\"), fieldname:\"%STR&JSSTR\", borderPane:0, coverPane:0, titlePane:0, mainBackground:0, outlineBackground:0, form:\"%STR&JSSTR\"});\n", name, fieldname, form); - } - - htrAddEventHandlerFunction(s, "document", "MOUSEUP", "radiobutton", "radiobutton_mouseup"); - htrAddEventHandlerFunction(s, "document", "MOUSEDOWN", "radiobutton", "radiobutton_mousedown"); - htrAddEventHandlerFunction(s, "document", "MOUSEOVER", "radiobutton", "radiobutton_mouseover"); - htrAddEventHandlerFunction(s, "document", "MOUSEMOVE", "radiobutton", "radiobutton_mousemove"); - - /* - Now lets loop through and add each radiobutton - */ - i = 1; - for (j=0;jChildren));j++) + + /** Write HTML to contain the radio buttons. **/ + htrAddBodyItem_va(s, "
\n", id); + htrAddBodyItem_va(s, "
\n", id); + htrAddBodyItem_va(s, "
\n", id); + + /** Search child array for radio buttons. **/ + XArray radio_buttons; + xaInit(&radio_buttons, tree->Children.nItems); + for (int i = 0; i < tree->Children.nItems; i++) { - sub_tree = xaGetItem(&(tree->Children), j); - wgtrGetPropertyValue(sub_tree,"outer_type",DATA_T_STRING,POD(&ptr)); - if (!strcmp(ptr,"widget/radiobutton")) - { - if (wgtrGetPropertyValue(sub_tree,"value",DATA_T_STRING,POD(&ptr)) == 0) - strtcpy(value, ptr, sizeof(value)); - else - value[0] = '\0'; - if (wgtrGetPropertyValue(sub_tree,"label",DATA_T_STRING,POD(&ptr)) == 0) - strtcpy(label, ptr, sizeof(label)); - else - label[0] = '\0'; - is_selected = htrGetBoolean(sub_tree, "selected", 0); - if (is_selected < 0) is_selected = 0; - htrAddWgtrObjLinkage_va(s,sub_tree,"rb%POSoption%POS",id,i); - wgtrGetPropertyValue(sub_tree,"name",DATA_T_STRING,POD(&ptr)); - htrAddScriptInit_va(s, - " var rbitem = wgtrGetNodeRef('%STR&SYM', '%STR&SYM');\n" - " add_radiobutton(rbitem, {selected:%INT, buttonset:htr_subel(rbitem, \"rb%POSbuttonset%POS\"), buttonunset:htr_subel(rbitem, \"rb%POSbuttonunset%POS\"), value:htr_subel(rbitem, \"rb%POSvalue%POS\"), label:htr_subel(rbitem, \"rb%POSlabel%POS\"), valuestr:\"%STR&JSSTR\", labelstr:\"%STR&JSSTR\"});\n", - wgtrGetNamespace(sub_tree), ptr, - is_selected, - id, i, id, i, - id, i, id, i, - value, label); - i++; - } - else - { - htrRenderWidget(s, sub_tree, z+1); - } + pWgtrNode child = tree->Children.Items[i]; + + /** Mark child as no-object. **/ + child->RenderFlags |= HT_WGTF_NOOBJECT; + + /** Add radio buttons to the array, render other widgets immediately (so we can forget about them). **/ + wgtrGetPropertyValue(child, "outer_type", DATA_T_STRING, POD(&ptr)); + if (strcmp(ptr, "widget/radiobutton") == 0) xaAddItem(&radio_buttons, child); + else htrRenderWidget(s, child, z + 1); } - - /* - Do the HTML layers - */ - htrAddBodyItem_va(s,"
\n", id); - htrAddBodyItem_va(s,"
\n", id); - htrAddBodyItem_va(s,"
\n", id); - - /* Loop through each radio button and do the option pane and sub layers */ - i = 1; - for (j=0;jChildren));j++) + + /** Write style for radio buttons. **/ + const int top_padding = 12; + const int button_height = para_height + 2; + const int content_height = top_padding + (button_height * radio_buttons.nItems) + 8; + for (int i = 0; i < radio_buttons.nItems; i++) { - radiobutton_obj = xaGetItem(&(tree->Children), j); - wgtrGetPropertyValue(radiobutton_obj,"outer_type",DATA_T_STRING,POD(&ptr)); - if (!strcmp(ptr,"widget/radiobutton")) - { - /** CSS layers **/ - htrAddStylesheetItem_va(s, - "#rb%POSbuttonset%POS, " - "#rb%POSbuttonunset%POS { " - "position:absolute; " - "overflow:hidden; " - "left:5px; " - "top:%INTpx; " - "width:12px; " - "height:12px; " - "z-index:%POS; " - "cursor:pointer; " - "}\n", - id, i, - id, i, - (para_height / 2) - 3, - z + 2 - ); - htrAddStylesheetItem_va(s, - "#rb%POSvalue%POS { " - "position:absolute; " - "visibility:hidden; " - "overflow:hidden; " - "left:5px; " - "top:6px; " - "width:12px; " - "height:12px; " - "z-index:%POS; " - "}\n", - id, i, - z + 2 - ); - htrAddStylesheetItem_va(s, - "#rb%POSlabel%POS { " - "position:absolute; " - "visibility:inherit; " - "overflow:hidden; " - "left:27px; " - "top:3px; " - "width:calc(100%% - 27px); " - "height:%POSpx; " - "z-index:%POS; " - "cursor:pointer; " - "}\n", - id, i, - item_spacing - 1, - z + 2 - ); - - /** Body layers **/ - htrAddBodyItem_va(s,"
\n", id, i); - htrAddBodyItem_va(s,"
\n", id, i); - htrAddBodyItem_va(s,"
\n", id, i); - - wgtrGetPropertyValue(radiobutton_obj,"label",DATA_T_STRING,POD(&ptr)); - strtcpy(sbuf2,ptr,sizeof(sbuf2)); - htrAddBodyItem_va(s,"
%STR&HTE
\n", - id, i, textcolor, sbuf2); - - /* use label (from above) as default value if no value given */ - if(wgtrGetPropertyValue(radiobutton_obj,"value",DATA_T_STRING,POD(&ptr))==0) - { - strtcpy(sbuf2,ptr,sizeof(sbuf2)); - } - - htrAddBodyItem_va(s," \n", - id, i, sbuf2); - htrAddBodyItem(s, "
\n"); - i++; - } + pWgtrNode radio_button = radio_buttons.Items[i]; + + /** Store data for the individual radio button. **/ + char value_buf[64] = "", label_buf[64] = ""; + if (wgtrGetPropertyValue(radio_button, "value", DATA_T_STRING, POD(&ptr)) == 0) + strtcpy(value_buf, ptr, sizeof(value_buf)); + if (wgtrGetPropertyValue(radio_button, "label", DATA_T_STRING, POD(&ptr)) == 0) + strtcpy(label_buf, ptr, sizeof(label_buf)); + const int is_selected = (htrGetBoolean(radio_button, "selected", 0) > 0); + wgtrGetPropertyValue(radio_button, "name", DATA_T_STRING, POD(&ptr)); + + /** Create pointers to data. **/ + char* name = ptr; /* Name temporarily stored in the wgtrGetPropertyValue() buffer. */ + char* value = value_buf; + char* label = (label_buf[0] == '\0') ? value_buf : label_buf; + + /** Link the radio button DOM node to widget data. **/ + htrAddWgtrObjLinkage_va(s, radio_button, "rb%POSoption%POS", id, i); + + /** Write the initialization call. **/ + htrAddScriptInit_va(s, "{ " + "const rbitem = wgtrGetNodeRef('%STR&SYM', '%STR&SYM');" + "add_radiobutton(rbitem, { " + "selected:%POS, " + "buttonset:htr_subel(rbitem, 'rb%POSbuttonset%POS'), " + "buttonunset:htr_subel(rbitem, 'rb%POSbuttonunset%POS'), " + "value:htr_subel(rbitem, 'rb%POSvalue%POS'), " + "label:htr_subel(rbitem, 'rb%POSlabel%POS'), " + "valuestr:'%STR&JSSTR', " + "labelstr:'%STR&JSSTR', " + "}); }\n", + wgtrGetNamespace(radio_button), name, + is_selected, + id, i, id, i, + id, i, id, i, + value, label + ); + + /** Write CSS for the radio button container. **/ + const int base_top = top_padding + (button_height * i); + const double percent_space_above = (100.0 / radio_buttons.nItems) * i; + const double content_above = ((double)content_height / radio_buttons.nItems) * i; + htrAddStylesheetItem_va(s, + "#rb%POSoption%POS { " + "position:absolute; " + "visibility:inherit; " + "overflow:hidden; " + "left:7px; " + "top:calc(0px " + "+ %POSpx " + "+ min(%DBL%% - %DBLpx, %POSpx) " + "); " + "width:calc(100%% - 14px); " + "height:%POSpx; " + "z-index:%POS; " + "}\n", + id, i, + base_top, + percent_space_above, content_above, spacing * i, + button_height, + z + 2 + ); + + /** Write CSS for the radio button elements. **/ + htrAddStylesheetItem_va(s, + "#rb%POSbuttonset%POS, " + "#rb%POSbuttonunset%POS { " + "position:absolute; " + "overflow:hidden; " + "left:5px; " + "top:%INTpx; " + "width:12px; " + "height:12px; " + "z-index:%POS; " + "cursor:pointer; " + "}\n", + id, i, + id, i, + (para_height / 2) - 3, + z + 2 + ); + htrAddStylesheetItem_va(s, + "#rb%POSvalue%POS { " + "position:absolute; " + "visibility:hidden; " + "overflow:hidden; " + "left:5px; " + "top:6px; " + "width:12px; " + "height:12px; " + "z-index:%POS; " + "}\n", + id, i, + z + 2 + ); + htrAddStylesheetItem_va(s, + "#rb%POSlabel%POS { " + "position:absolute; " + "visibility:inherit; " + "overflow:hidden; " + "left:27px; " + "top:3px; " + "width:calc(100%% - 27px); " + "height:calc(100%% - 1px); " + "z-index:%POS; " + "cursor:pointer; " + "}\n", + id, i, + z + 2 + ); + + /** Write radio button HTML. **/ + htrAddBodyItem_va(s, "
\n", id, i); + htrAddBodyItem_va(s, " \n", id, i); + htrAddBodyItem_va(s, "
\n", id, i); + htrAddBodyItem_va(s, "
%STR&HTE
\n", id, i, textcolor, label); + htrAddBodyItem_va(s, " \n", id, i, value); + htrAddBodyItem (s, "
\n"); } - - htrAddBodyItem(s, "
\n"); - htrAddBodyItem(s, "
\n"); - htrAddBodyItem_va(s,"
%STR&HTE
\n", id, textcolor, title); - htrAddBodyItem(s, "
\n"); - - return 0; -} + + htrAddBodyItem_va(s, + "
\n" + "
\n" + "
%STR&HTE
\n" + "
\n", + id, textcolor, title + ); + + return 0; + } /** htrbInitialize - register with the ht_render module. **/ int htrbInitialize() { pHtDriver drv; + + /** Initialize globals. */ + HTRB.idcnt = 0; /** Allocate the driver **/ drv = htrAllocDriver(); @@ -430,12 +432,9 @@ int htrbInitialize() { htrAddEvent(drv,"MouseMove"); htrAddEvent(drv,"DataChange"); - /** Register. **/ + /** Register with dhtml support. **/ htrRegisterDriver(drv); - htrAddSupport(drv, "dhtml"); - HTRB.idcnt = 0; - return 0; } From e1f9a634f478d10b74b0b6296580ef58c62a3b50 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Wed, 11 Feb 2026 12:13:47 -0700 Subject: [PATCH 103/275] Clean up some JS for the radio button panel widget. --- centrallix-os/sys/js/htdrv_radiobutton.js | 16 +++++----------- 1 file changed, 5 insertions(+), 11 deletions(-) diff --git a/centrallix-os/sys/js/htdrv_radiobutton.js b/centrallix-os/sys/js/htdrv_radiobutton.js index 2d5c9eb77..2902d7525 100644 --- a/centrallix-os/sys/js/htdrv_radiobutton.js +++ b/centrallix-os/sys/js/htdrv_radiobutton.js @@ -37,7 +37,6 @@ function rb_setvalue(v) { } } this.clearvalue(); - //alert('Warning: "'+v+'" is not in the radio button list.'); } function rb_cb_getvalue(p) { @@ -104,12 +103,8 @@ function add_radiobutton(optionPane, param) { var rb = wgtrGetParent(optionPane); rb.rbCount++; optionPane.valueIndex = rb.rbCount; - /*optionPane.kind = 'radiobutton'; - optionPane.document.layer = optionPane;*/ htr_init_layer(optionPane, rb, 'radiobutton'); - //optionPane.mainlayer = rb; optionPane.optionPane = optionPane; - optionPane.isSelected = param.selected; optionPane.valueStr = param.valuestr; optionPane.labelStr = param.labelstr; @@ -349,8 +344,6 @@ function rb_changemode(){ for (var i=0;i Date: Wed, 11 Feb 2026 12:37:42 -0700 Subject: [PATCH 104/275] Add Easter Eggs for code reviewers to find. --- centrallix-doc/Widgets/widgets.xml | 2 +- centrallix-os/sys/js/ht_geom_dom1html.js | 1 + centrallix/htmlgen/htdrv_dropdown.c | 1 + centrallix/htmlgen/htdrv_radiobutton.c | 1 + centrallix/htmlgen/htdrv_scrollpane.c | 2 +- centrallix/htmlgen/htdrv_tab.c | 3 ++- centrallix/wgtr/apos.c | 2 ++ 7 files changed, 9 insertions(+), 3 deletions(-) diff --git a/centrallix-doc/Widgets/widgets.xml b/centrallix-doc/Widgets/widgets.xml index 6267ffd08..58e5aede8 100644 --- a/centrallix-doc/Widgets/widgets.xml +++ b/centrallix-doc/Widgets/widgets.xml @@ -2824,7 +2824,7 @@ osrc1 "widget/osrc" Starts a new app in a new window. - Logs data to the console (using console.log()), for testing and debugging. Set the 'Message' to specify a text string that should appear in the log. + Logs data to the console (using console.log()), for testing and debugging. Set the 'Message' to specify a text string that should appear in the log. Might be useful for logging Easter Egg #8. Loads the page. diff --git a/centrallix-os/sys/js/ht_geom_dom1html.js b/centrallix-os/sys/js/ht_geom_dom1html.js index 71d29db99..f2687cc3c 100644 --- a/centrallix-os/sys/js/ht_geom_dom1html.js +++ b/centrallix-os/sys/js/ht_geom_dom1html.js @@ -405,6 +405,7 @@ function setResponsive(l, value, d) { var fl_parent = l['__fl_parent_' + d2] ?? wgtrGetServerProperty(l, 'fl_parent_' + d2); if (fl_parent == undefined || fl_parent == null) { + /** I wonder if anyone reviewers will see this: Easter egg #7. **/ const warningMsg = 'setResponsive() - FAIL: Missing ' + ((wgtrIsNode(l)) ? 'wgtr.' : '__') + 'fl_parent_' + d2; console.warn(warningMsg, l); } diff --git a/centrallix/htmlgen/htdrv_dropdown.c b/centrallix/htmlgen/htdrv_dropdown.c index f2af95d00..8f3d586ec 100644 --- a/centrallix/htmlgen/htdrv_dropdown.c +++ b/centrallix/htmlgen/htdrv_dropdown.c @@ -52,6 +52,7 @@ static struct { #define HTDD_DYNAMIC 2 #define HTDD_DYNAMIC_CLIENT HTDD_DYNAMIC #define HTDD_OBJECTSOURCE 3 +#define HTDD_EASTER_EGG_4 4 /* htddRender - generate the HTML code for the page. diff --git a/centrallix/htmlgen/htdrv_radiobutton.c b/centrallix/htmlgen/htdrv_radiobutton.c index 5946e048c..27024d363 100644 --- a/centrallix/htmlgen/htdrv_radiobutton.c +++ b/centrallix/htmlgen/htdrv_radiobutton.c @@ -140,6 +140,7 @@ int htrbRender(pHtSession s, pWgtrNode tree, int z) "const borderPane = htr_subel(parentPane, 'rb%POSborder'); " "const coverPane = htr_subel(borderPane, 'rb%POScover'); " "const titlePane = htr_subel(parentPane, 'rb%POStitle'); " + "const easterEgg2 = 'Easter Egg #2';" "radiobuttonpanel_init({ " "parentPane, borderPane, coverPane, titlePane, " "fieldname:'%STR&JSSTR', " diff --git a/centrallix/htmlgen/htdrv_scrollpane.c b/centrallix/htmlgen/htdrv_scrollpane.c index 2a4b36154..7b012e95e 100644 --- a/centrallix/htmlgen/htdrv_scrollpane.c +++ b/centrallix/htmlgen/htdrv_scrollpane.c @@ -346,7 +346,7 @@ htspaneRender(pHtSession s, pWgtrNode tree, int z) "" /** Close the scrollpane table (see above). **/ - "\n", + " \n", h - 36 ); diff --git a/centrallix/htmlgen/htdrv_tab.c b/centrallix/htmlgen/htdrv_tab.c index 715a5a6e2..75eaefdee 100644 --- a/centrallix/htmlgen/htdrv_tab.c +++ b/centrallix/htmlgen/htdrv_tab.c @@ -491,7 +491,8 @@ httabRender(pHtSession s, pWgtrNode tree, int z) "box-shadow:%DBLpx %DBLpx %POSpx %STR&CSSVAL; " "text-align:%STR&CSSVAL; " "color:%STR&CSSVAL; " - "font-weight:bold; " + "font-weight:bold; /*" + "easter-egg-6:value;*/ " "background-position: %INTpx %INTpx; " "%STR " "}\n", diff --git a/centrallix/wgtr/apos.c b/centrallix/wgtr/apos.c index 06550eda0..ea42c2e63 100644 --- a/centrallix/wgtr/apos.c +++ b/centrallix/wgtr/apos.c @@ -81,6 +81,8 @@ *** XArray: This array also stores its size (nAlloc) and the number of items *** stored (nItems), so you don't have to pass that info separately. *** + *** Easter Egg #1: I wonder if any reviewers will find this... + *** *** SWidgets, CWidgets, and EWidgets: Lines record which widgets start, cross, *** and end on them. These categories are exclusive, so a widget which *** starts on a given line will be in the SWidgets list but it will not be From 1b69670637718d0a82f8fa5a2c064f3a4884633d Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Wed, 11 Feb 2026 12:48:40 -0700 Subject: [PATCH 105/275] Fix a bug in htdrv_radiobutton.js. --- centrallix-os/sys/js/htdrv_radiobutton.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/centrallix-os/sys/js/htdrv_radiobutton.js b/centrallix-os/sys/js/htdrv_radiobutton.js index 2902d7525..9f389ba4a 100644 --- a/centrallix-os/sys/js/htdrv_radiobutton.js +++ b/centrallix-os/sys/js/htdrv_radiobutton.js @@ -384,7 +384,7 @@ function rb_changemode(){ } function radiobuttonpanel_init(param) { - const { parentPane, borderpane, coverpane, titlepane } = param; + const { parentPane, borderPane: borderpane, coverPane: coverpane, titlePane: titlepane } = param; if (cx__capabilities.Dom1HTML) titlepane.styleobj = titlepane.getElementsByTagName('table')[0]; From 59c9fc0f1db819cd3793461e318b4d2f64a12dbf Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Wed, 11 Feb 2026 12:49:04 -0700 Subject: [PATCH 106/275] Tweak size of selection area in htdrv_radiobutton.js. --- centrallix-os/sys/js/htdrv_radiobutton.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/centrallix-os/sys/js/htdrv_radiobutton.js b/centrallix-os/sys/js/htdrv_radiobutton.js index 9f389ba4a..5aca57c55 100644 --- a/centrallix-os/sys/js/htdrv_radiobutton.js +++ b/centrallix-os/sys/js/htdrv_radiobutton.js @@ -147,9 +147,9 @@ function add_radiobutton(optionPane, param) { } optionPane.yOffset = getRelativeY(optionPane)+getRelativeY(rb.coverPane)+getRelativeY(rb.borderPane); - optionPane.area = pg_addarea(rb, getRelativeX(optionPane), optionPane.yOffset, getClipWidth(optionPane), pg_parah+4, optionPane, 'rb', 3); + optionPane.area = pg_addarea(rb, getRelativeX(optionPane), optionPane.yOffset - 1, getClipWidth(optionPane), pg_parah+4, optionPane, 'rb', 3); optionPane.area.__defineGetter__('width', () => parseInt(getComputedStyle(optionPane).width)); - optionPane.area.__defineGetter__('height', () => parseInt(getComputedStyle(optionPane).height)); + optionPane.area.__defineGetter__('height', () => parseInt(getComputedStyle(optionPane).height) + 3); } function rb_getfocus(xo,yo,l,c,n,a,from_kbd) From f2f5d7a8f111e3e576790266d49ab18f133573f6 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Wed, 11 Feb 2026 14:53:24 -0700 Subject: [PATCH 107/275] Fix some inconsistent style issues with generated HTML & CSS. Fix inconsistent CSS rules in the style tag for the document head. Fix inconsistent indentation of head tags. Fix code style mistakes in generation code. Update examples in docs to use correct styling. Update outdated generation techniques. Clean up unused code in the generation process. --- centrallix/htmlgen/ht_render.c | 15 +- centrallix/htmlgen/htdrv_autolayout.c | 20 +-- centrallix/htmlgen/htdrv_button.c | 208 +++++++++++++++++++++---- centrallix/htmlgen/htdrv_calendar.c | 13 +- centrallix/htmlgen/htdrv_chart.c | 2 +- centrallix/htmlgen/htdrv_checkbox.c | 2 +- centrallix/htmlgen/htdrv_clock.c | 6 +- centrallix/htmlgen/htdrv_component.c | 19 ++- centrallix/htmlgen/htdrv_datetime.c | 8 +- centrallix/htmlgen/htdrv_dropdown.c | 39 +++-- centrallix/htmlgen/htdrv_editbox.c | 38 ++++- centrallix/htmlgen/htdrv_fileupload.c | 8 +- centrallix/htmlgen/htdrv_formstatus.c | 2 +- centrallix/htmlgen/htdrv_frameset.c | 2 +- centrallix/htmlgen/htdrv_html.c | 44 ++++-- centrallix/htmlgen/htdrv_image.c | 19 ++- centrallix/htmlgen/htdrv_imagebutton.c | 2 +- centrallix/htmlgen/htdrv_label.c | 28 +++- centrallix/htmlgen/htdrv_map.c | 15 +- centrallix/htmlgen/htdrv_menu.c | 60 ++++++- centrallix/htmlgen/htdrv_multiscroll.c | 45 +++++- centrallix/htmlgen/htdrv_objcanvas.c | 17 +- centrallix/htmlgen/htdrv_osrc.c | 14 +- centrallix/htmlgen/htdrv_page.c | 74 ++++----- centrallix/htmlgen/htdrv_pane.c | 13 +- centrallix/htmlgen/htdrv_radiobutton.c | 16 +- centrallix/htmlgen/htdrv_scrollbar.c | 43 ++++- centrallix/htmlgen/htdrv_scrollpane.c | 10 +- centrallix/htmlgen/htdrv_spinner.c | 12 +- centrallix/htmlgen/htdrv_tab.c | 13 +- centrallix/htmlgen/htdrv_table.c | 8 +- centrallix/htmlgen/htdrv_terminal.c | 22 ++- centrallix/htmlgen/htdrv_textarea.c | 9 -- centrallix/htmlgen/htdrv_textbutton.c | 24 +-- centrallix/htmlgen/htdrv_treeview.c | 20 ++- centrallix/htmlgen/htdrv_window.c | 25 ++- centrallix/utility/iface_html.c | 3 +- 37 files changed, 673 insertions(+), 245 deletions(-) diff --git a/centrallix/htmlgen/ht_render.c b/centrallix/htmlgen/ht_render.c index 871eb258d..915abfdea 100644 --- a/centrallix/htmlgen/ht_render.c +++ b/centrallix/htmlgen/ht_render.c @@ -1811,7 +1811,6 @@ htrRender(void* stream, int (*stream_write)(void*, char*, int, int, int), pObjSe htrAddScriptInit_va(s, "\n var ns = \"%STR&SYM\";\n", /*" var rootname = \"%STR&SYM\";\n", */ s->Namespace->DName /*, s->Namespace->DName */); - /*htrAddStylesheetItem(s, "\tdiv {position:absolute; visibility:inherit; overflow:hidden; }\n");*/ /** Render the top-level widget -- the function that's run * underneath will be dependent upon what the widget @@ -1831,7 +1830,7 @@ htrRender(void* stream, int (*stream_write)(void*, char*, int, int, int), pObjSe #ifdef WGTR_DBG_WINDOW htrAddScriptWgtr_va(s, " wgtrWalk(%STR&SYM);\n", tree->Name); htrAddScriptWgtr(s, " ifcLoadDef(\"net/centrallix/button.ifc\");\n"); - htrAddStylesheetItem(s, "\t#dbgwnd {position: absolute; top: 400; left: 50;}\n"); + htrAddStylesheetItem(s, "\t\t#dbgwnd {position: absolute; top: 400; left: 50;}\n"); htrAddBodyItem(s, "
" "" "
\n"); @@ -1868,12 +1867,12 @@ htrRender(void* stream, int (*stream_write)(void*, char*, int, int, int), pObjSe htrQPrintf(s, "\n" "\n" - " \n" - " \n" - " \n" + "\t\n" + "\t\n" + "\t\n" , cx__version); - htrWrite(s, " \n", -1); + htrWrite(s, "\t\n", -1); /** Write the HTML header items. **/ for(i=0;iPage.HtmlHeader.nItems;i++) { @@ -2700,7 +2699,7 @@ htrFormatElement(pHtSession s, pWgtrNode node, char* id, int flags, int x, int y /** Generate the style CSS **/ htrAddStylesheetItem_va(s, - "\t%STR {" + "\t\t%STR { " "left:"ht_flex_format"; " "top:"ht_flex_format"; " "%[width:"ht_flex_format"; %]" // BUG! diff --git a/centrallix/htmlgen/htdrv_autolayout.c b/centrallix/htmlgen/htdrv_autolayout.c index 02d6d7d2a..f1e62b3d5 100644 --- a/centrallix/htmlgen/htdrv_autolayout.c +++ b/centrallix/htmlgen/htdrv_autolayout.c @@ -100,16 +100,16 @@ htalRender(pHtSession s, pWgtrNode tree, int z) /** Add the stylesheet for the layer **/ htrAddStylesheetItem_va(s, - "\t#al%POSbase { " - "POSITION:absolute; " - "VISIBILITY:inherit; " - "OVERFLOW:visible; " - "LEFT:"ht_flex_format"; " - "TOP:"ht_flex_format"; " - "WIDTH:"ht_flex_format"; " - "HEIGHT:"ht_flex_format"; " - "Z-INDEX:%POS; " - "}\n", + "\t\t#al%POSbase { " + "position:absolute; " + "visibility:inherit; " + "overflow:visible; " + "left:"ht_flex_format"; " + "top:"ht_flex_format"; " + "width:"ht_flex_format"; " + "height:"ht_flex_format"; " + "z-index:%POS; " + "}\n ", id, ht_flex_x(x, tree), ht_flex_y(y, tree), diff --git a/centrallix/htmlgen/htdrv_button.c b/centrallix/htmlgen/htdrv_button.c index 3e3f7c577..0af5a8dfd 100644 --- a/centrallix/htmlgen/htdrv_button.c +++ b/centrallix/htmlgen/htdrv_button.c @@ -151,7 +151,7 @@ htbtnRender(pHtSession s, pWgtrNode tree, int z) if (!strcmp(type,"image") || !strcmp(type,"textoverimage")) { htrAddStylesheetItem_va(s, - "\t#gb%POSpane { " + "\t\t#gb%POSpane { " "position:absolute; " "visibility:inherit; " "left:"ht_flex_format"; " @@ -169,7 +169,9 @@ htbtnRender(pHtSession s, pWgtrNode tree, int z) /** Button click animation. **/ if (is_enabled) { htrAddStylesheetItem_va(s, - "\t#tb%POSpane:active { transform: translate(1px, 1px); }\n", + "\t\t#tb%POSpane:active { " + "transform:translate(1px, 1px); " + "}\n", id ); } @@ -215,19 +217,17 @@ htbtnRender(pHtSession s, pWgtrNode tree, int z) if(!strcmp(type,"textoverimage")) { htrAddStylesheetItem_va(s, - "\t#gb%POSpane2 { " + "\t\t#gb%POSpane2 { " "position:absolute; " "visibility:inherit; " - "left:%POS; " - "top:%POS; " + "left:0px; " + "top:0px; " "width:"ht_flex_format"; " "z-index:%POS; " "}\n", id, - 0, - 0, - ht_flex(w, tree->Parent->width, ht_get_fl_w(tree)), - z+1 + ht_flex_w(w, tree), + z + 1 ); htrAddBodyItem_va(s,"
%STR&HTE
\n",id,h,fgcolor1,text); } @@ -262,13 +262,107 @@ htbtnRender(pHtSession s, pWgtrNode tree, int z) if(s->Capabilities.Dom0NS) { /** Ok, write the style header items. **/ - htrAddStylesheetItem_va(s,"\t#gb%POSpane { POSITION:absolute; VISIBILITY:inherit; LEFT:"ht_flex_format"; TOP:"ht_flex_format"; WIDTH:"ht_flex_format"; Z-INDEX:%POS; }\n",id,ht_flex(x,tree->Parent->width,ht_get_fl_x(tree)),ht_flex(y,tree->Parent->height,ht_get_fl_y(tree)),ht_flex(w,tree->Parent->width,ht_get_fl_w(tree)),z); - htrAddStylesheetItem_va(s,"\t#gb%POSpane2 { POSITION:absolute; VISIBILITY:%STR; LEFT:-1; TOP:-1; WIDTH:"ht_flex_format"; Z-INDEX:%POS; }\n",id,is_enabled?"inherit":"hidden",ht_flex(w,tree->Parent->width,ht_get_fl_w(tree)),z+1); - htrAddStylesheetItem_va(s,"\t#gb%POSpane3 { POSITION:absolute; VISIBILITY:%STR; LEFT:0; TOP:0; WIDTH:"ht_flex_format"; Z-INDEX:%POS; }\n",id,is_enabled?"hidden":"inherit",ht_flex(w-1,tree->Parent->width,ht_get_fl_w(tree)),z+1); - htrAddStylesheetItem_va(s,"\t#gb%POStop { POSITION:absolute; VISIBILITY:%STR; LEFT:0; TOP:0; HEIGHT:1; WIDTH:"ht_flex_format"; Z-INDEX:%POS; }\n",id,is_ts?"hidden":"inherit",ht_flex(w,tree->Parent->width,ht_get_fl_w(tree)),z+2); - htrAddStylesheetItem_va(s,"\t#gb%POSbtm { POSITION:absolute; VISIBILITY:%STR; LEFT:0; TOP:0; HEIGHT:1; WIDTH:"ht_flex_format"; Z-INDEX:%POS; }\n",id,is_ts?"hidden":"inherit",ht_flex(w,tree->Parent->width,ht_get_fl_w(tree)),z+2); - htrAddStylesheetItem_va(s,"\t#gb%POSrgt { POSITION:absolute; VISIBILITY:%STR; LEFT:0; TOP:0; HEIGHT:1; WIDTH:1; Z-INDEX:%POS; }\n",id,is_ts?"hidden":"inherit",z+2); - htrAddStylesheetItem_va(s,"\t#gb%POSlft { POSITION:absolute; VISIBILITY:%STR; LEFT:0; TOP:0; HEIGHT:1; WIDTH:1; Z-INDEX:%POS; }\n",id,is_ts?"hidden":"inherit",z+2); + htrAddStylesheetItem_va(s, + "\t\t#gb%POSpane { " + "position:absolute; " + "visibility:inherit; " + "left:"ht_flex_format"; " + "top:"ht_flex_format"; " + "width:"ht_flex_format"; " + "z-index:%POS; " + "}\n", + id, + ht_flex_x(x, tree), + ht_flex_y(y, tree), + ht_flex_w(w, tree), + z + ); + htrAddStylesheetItem_va(s, + "\t\t#gb%POSpane2 { " + "position:absolute; " + "visibility:%STR; " + "left:-1px; " + "top:-1px; " + "width:"ht_flex_format"; " + "z-index:%POS; " + "}\n", + id, + (is_enabled) ? "inherit" : "hidden", + ht_flex_w(w, tree), + z + 1 + ); + htrAddStylesheetItem_va(s, + "\t\t#gb%POSpane3 { " + "position:absolute; " + "visibility:%STR; " + "left:0px; " + "top:0px; " + "width:"ht_flex_format"; " + "z-index:%POS; " + "}\n", + id, + (is_enabled) ? "hidden" : "inherit", + ht_flex_w(w - 1, tree), + z + 1 + ); + htrAddStylesheetItem_va(s, + "\t\t#gb%POStop { " + "position:absolute; " + "visibility:%STR; " + "left:0px; " + "top:0px; " + "height:1px; " + "width:"ht_flex_format"; " + "z-index:%POS; " + "}\n", + id, + (is_ts) ? "hidden" : "inherit", + ht_flex_w(w, tree), + z + 2 + ); + htrAddStylesheetItem_va(s, + "\t\t#gb%POSbtm { " + "position:absolute; " + "visibility:%STR; " + "left:0px; " + "top:0px; " + "height:1px; " + "width:"ht_flex_format"; " + "z-index:%POS; " + "}\n", + id, + (is_ts) ? "hidden" : "inherit", + ht_flex_w(w, tree), + z + 2 + ); + htrAddStylesheetItem_va(s, + "\t\t#gb%POSrgt { " + "position:absolute; " + "visibility:%STR; " + "left:0px; " + "top:0px; " + "height:1px; " + "width:1px; " + "z-index:%POS; " + "}\n", + id, + (is_ts) ? "hidden" : "inherit", + z + 2 + ); + htrAddStylesheetItem_va(s, + "\t\t#gb%POSlft { " + "position:absolute; " + "visibility:%STR; " + "left:0px; " + "top:0px; " + "height:1px; " + "width:1px; " + "z-index:%POS; " + "}\n", + id, + (is_ts) ? "hidden" : "inherit", + z + 2 + ); /** Script initialization call. **/ htrAddScriptInit_va(s, " gb_init({layer:%STR&SYM, layer2:htr_subel(%STR&SYM, \"gb%POSpane2\"), layer3:htr_subel(%STR&SYM, \"gb%POSpane3\"), top:htr_subel(%STR&SYM, \"gb%POStop\"), bottom:htr_subel(%STR&SYM, \"gb%POSbtm\"), right:htr_subel(%STR&SYM, \"gb%POSrgt\"), left:htr_subel(%STR&SYM, \"gb%POSlft\"), width:%INT, height:%INT, tristate:%INT, name:\"%STR&SYM\", text:'%STR&JSSTR', n:\"%STR&JSSTR\", p:\"%STR&JSSTR\", c:\"%STR&JSSTR\", d:\"%STR&JSSTR\", type:\"%STR&JSSTR\"});\n", @@ -344,7 +438,7 @@ htbtnRender(pHtSession s, pWgtrNode tree, int z) if(h >=0 ) { htrAddStylesheetItem_va(s, - "\t#gb%POSpane { " + "\t\t#gb%POSpane { " "position:absolute; " "visibility:inherit; " "overflow:hidden; " @@ -354,18 +448,30 @@ htbtnRender(pHtSession s, pWgtrNode tree, int z) "z-index:%POS; " "}\n", id, - ht_flex(x, tree->Parent->width, ht_get_fl_x(tree)), - ht_flex(y, tree->Parent->height, ht_get_fl_y(tree)), - ht_flex(w-1-2*box_offset, tree->Parent->width, ht_get_fl_w(tree)), + ht_flex_x(x, tree), + ht_flex_y(y, tree), + ht_flex_w(w - 1 - 2 * box_offset, tree), z ); - htrAddStylesheetItem_va(s,"\t#gb%POSpane2, #gb%POSpane3 { height: "ht_flex_format";}\n",id,id,ht_flex(h-3,tree->Parent->height,ht_get_fl_h(tree))); - htrAddStylesheetItem_va(s,"\t#gb%POSpane { height: "ht_flex_format";}\n",id,ht_flex(h-1-2*box_offset,tree->Parent->height,ht_get_fl_h(tree))); + htrAddStylesheetItem_va(s, + "\t\t#gb%POSpane2, #gb%POSpane3 { " + "height: "ht_flex_format"; " + "}\n", + id, id, + ht_flex_h(h - 3, tree) + ); + htrAddStylesheetItem_va(s, + "\t\t#gb%POSpane { " + "height:"ht_flex_format"; " + "}\n", + id, + ht_flex_h(h - 1 - 2 * box_offset, tree) + ); } else { htrAddStylesheetItem_va(s, - "\t#gb%POSpane { " + "\t\t#gb%POSpane { " "position:absolute; " "visibility:inherit; " "overflow:hidden; " @@ -375,17 +481,57 @@ htbtnRender(pHtSession s, pWgtrNode tree, int z) "z-index:%POS; " "}\n", id, - ht_flex(x, tree->Parent->width, ht_get_fl_x(tree)), - ht_flex(y, tree->Parent->height, ht_get_fl_y(tree)), - ht_flex(w-1-2*box_offset, tree->Parent->width, ht_get_fl_w(tree)), + ht_flex_x(x, tree), + ht_flex_y(y, tree), + ht_flex_w(w - 1 - 2 * box_offset, tree), z ); } - htrAddStylesheetItem_va(s,"\t#gb%POSpane, #gb%POSpane2, #gb%POSpane3 { cursor:default; text-align: center; }\n",id,id,id); - htrAddStylesheetItem_va(s,"\t#gb%POSpane { %STR border-width: 1px; border-style: solid; border-color: white gray gray white; }\n",id,bgstyle); - /*htrAddStylesheetItem_va(s,"\t#gb%dpane { color: %s; }\n",id,fgcolor2);*/ - htrAddStylesheetItem_va(s,"\t#gb%POSpane2 { VISIBILITY: %STR; Z-INDEX: %INT; position: absolute; left:-1px; top: -1px; width:"ht_flex_format"; }\n",id,is_enabled?"inherit":"hidden",z+1,ht_flex(w-3,tree->Parent->width,ht_get_fl_w(tree))); - htrAddStylesheetItem_va(s,"\t#gb%POSpane3 { VISIBILITY: %STR; Z-INDEX: %INT; position: absolute; left:0px; top: 0px; width:"ht_flex_format"; }\n",id,is_enabled?"hidden":"inherit",z+1,ht_flex(w-3,tree->Parent->width,ht_get_fl_w(tree))); + htrAddStylesheetItem_va(s, + "\t\t#gb%POSpane, #gb%POSpane2, #gb%POSpane3 { " + "cursor:default; " + "text-align:center; " + "}\n", + id, id, id + ); + htrAddStylesheetItem_va(s, + "\t\t#gb%POSpane { " + "%STR " + "border-width:1px; " + "border-style:solid; " + "border-color:white gray gray white; " + "}\n", + id, + bgstyle + ); + htrAddStylesheetItem_va(s, + "\t\t#gb%POSpane2 { " + "position:absolute; " + "visibility:%STR; " + "left:-1px; " + "top:-1px; " + "width:"ht_flex_format"; " + "z-index:%INT; " + "}\n", + id, + (is_enabled) ? "inherit" : "hidden", + ht_flex_w(w - 3, tree), + z + 1 + ); + htrAddStylesheetItem_va(s, + "\t\t#gb%POSpane3 { " + "visibility:%STR; " + "position:absolute; " + "left:0px; " + "top:0px; " + "width:"ht_flex_format"; " + "z-index:%INT; " + "}\n", + id, + (is_enabled) ? "hidden" : "inherit", + ht_flex_w(w - 3, tree), + z + 1 + ); if(!strcmp(type,"text")) { diff --git a/centrallix/htmlgen/htdrv_calendar.c b/centrallix/htmlgen/htdrv_calendar.c index 3605135fd..f871ffd1d 100644 --- a/centrallix/htmlgen/htdrv_calendar.c +++ b/centrallix/htmlgen/htdrv_calendar.c @@ -141,7 +141,18 @@ htcaRender(pHtSession s, pWgtrNode tree, int z) strtcpy(name,ptr,sizeof(name)); /** Ok, write the style header items. **/ - htrAddStylesheetItem_va(s,"\t#ca%POSbase { POSITION:absolute; VISIBILITY:inherit; LEFT:%INTpx; TOP:%INTpx; WIDTH:%POSpx; HEIGHT:%POSpx; Z-INDEX:%POS; }\n",id,x,y,w,h,z); + htrAddStylesheetItem_va(s, + "\t\t#ca%POSbase { " + "position:absolute; " + "visibility:inherit; " + "left:%INTpx; " + "top:%INTpx; " + "width:%POSpx; " + "height:%POSpx; " + "z-index:%POS; " + "}\n", + id, x, y, w, h, z + ); /** Script include to get functions **/ htrAddScriptInclude(s, "/sys/js/htdrv_calendar.js", 0); diff --git a/centrallix/htmlgen/htdrv_chart.c b/centrallix/htmlgen/htdrv_chart.c index d421643cf..1f4a40eb4 100644 --- a/centrallix/htmlgen/htdrv_chart.c +++ b/centrallix/htmlgen/htdrv_chart.c @@ -335,7 +335,7 @@ htchtGenHTML(pHtSession session, pWgtrNode tree, int z) /** Write style rules for the container div. **/ htrAddStylesheetItem_va(session, - "\t#%STR&SYMdiv { " + "\t\t#%STR&SYMdiv { " "position:absolute; " "visibility:inherit; " "left:"ht_flex_format"; " diff --git a/centrallix/htmlgen/htdrv_checkbox.c b/centrallix/htmlgen/htdrv_checkbox.c index d5f164716..dbc054e83 100644 --- a/centrallix/htmlgen/htdrv_checkbox.c +++ b/centrallix/htmlgen/htdrv_checkbox.c @@ -93,7 +93,7 @@ int htcbRender(pHtSession s, pWgtrNode tree, int z) { /** Write style header. **/ htrAddStylesheetItem_va(s, - "\t#cb%POSmain { " + "\t\t#cb%POSmain { " "position:absolute; " "visibility:inherit; " "left:"ht_flex_format"; " diff --git a/centrallix/htmlgen/htdrv_clock.c b/centrallix/htmlgen/htdrv_clock.c index 4799127c0..5a4cfd954 100644 --- a/centrallix/htmlgen/htdrv_clock.c +++ b/centrallix/htmlgen/htdrv_clock.c @@ -157,7 +157,7 @@ htclRender(pHtSession s, pWgtrNode tree, int z) /** Write style headers. **/ htrAddStylesheetItem_va(s, - "\t#cl%POSbase { " + "\t\t#cl%POSbase { " "position:absolute; " "visibility:inherit; " "left:"ht_flex_format"; " @@ -172,7 +172,7 @@ htclRender(pHtSession s, pWgtrNode tree, int z) z ); htrAddStylesheetItem_va(s, - "\t.cl%POScon { " + "\t\t.cl%POScon { " "position:absolute; " "left:0px; " "top:0px; " @@ -180,8 +180,6 @@ htclRender(pHtSession s, pWgtrNode tree, int z) "z-index:%POS; " "}\n", id, - 0, - 0, z + 2 ); diff --git a/centrallix/htmlgen/htdrv_component.c b/centrallix/htmlgen/htdrv_component.c index c1460c2cf..6fe5c9a2d 100644 --- a/centrallix/htmlgen/htdrv_component.c +++ b/centrallix/htmlgen/htdrv_component.c @@ -286,7 +286,7 @@ htcmpRender(pHtSession s, pWgtrNode tree, int z) /** Write styles for the enclosing div. **/ htrAddStylesheetItem_va(s, - "\t#cmp%POSbase { " + "\t\t#cmp%POSbase { " "position:absolute; " "visibility:inherit; " "overflow:visible; " @@ -306,10 +306,10 @@ htcmpRender(pHtSession s, pWgtrNode tree, int z) /** Write enclosing div event CSS. **/ htrAddStylesheetItem_va(s, - "\t#cmp%POSbase { " + "\t\t#cmp%POSbase { " "pointer-events:none; " "}\n" - "\t#cmp%POSbase > * { " + "\t\t#cmp%POSbase > * { " "pointer-events:auto; " "}\n", id, id @@ -489,7 +489,18 @@ htcmpRender(pHtSession s, pWgtrNode tree, int z) /** Dynamic mode -- load from client **/ htrAddWgtrCtrLinkage(s, tree, "_parentctr"); htrAddBodyItemLayer_va(s, HTR_LAYER_F_DYNAMIC, "cmp%POS", id, NULL, ""); - htrAddStylesheetItem_va(s,"\t#cmp%POS { position:absolute; visibility:hidden; left:0px; top:0px; width:0px; height:0px; z-index:0;}\n", id); + htrAddStylesheetItem_va(s, + "\t\t#cmp%POS { " + "position:absolute; " + "visibility:hidden; " + "left:0px; " + "top:0px; " + "width:0px; " + "height:0px; " + "z-index:0; " + "}\n", + id + ); } htrRenderSubwidgets(s, tree, z+1); diff --git a/centrallix/htmlgen/htdrv_datetime.c b/centrallix/htmlgen/htdrv_datetime.c index 2161cda7b..9d50625cc 100644 --- a/centrallix/htmlgen/htdrv_datetime.c +++ b/centrallix/htmlgen/htdrv_datetime.c @@ -205,10 +205,10 @@ htdtRender(pHtSession s, pWgtrNode tree, int z) /** Write style headers. **/ htrAddStylesheetItem_va(s, - "\t#dt%POSbtn { " - "overflow:hidden; " + "\t\t#dt%POSbtn { " "position:absolute; " "visibility:inherit; " + "overflow:hidden; " "left:"ht_flex_format"; " "top:"ht_flex_format"; " "width:"ht_flex_format"; " @@ -227,9 +227,9 @@ htdtRender(pHtSession s, pWgtrNode tree, int z) bgcolor ); htrAddStylesheetItem_va(s, - "\t.dt%POScon { " - "overflow:hidden; " + "\t\t.dt%POScon { " "position:absolute; " + "overflow:hidden; " "left:1px; " "top:1px; " "width:calc(100%% - 20px); " diff --git a/centrallix/htmlgen/htdrv_dropdown.c b/centrallix/htmlgen/htdrv_dropdown.c index 8f3d586ec..965ce6f30 100644 --- a/centrallix/htmlgen/htdrv_dropdown.c +++ b/centrallix/htmlgen/htdrv_dropdown.c @@ -153,15 +153,15 @@ int htddRender(pHtSession s, pWgtrNode tree, int z) { /** Write basic element CSS. **/ htrAddStylesheetItem_va(s, - "\t#dd%POSbtn { " - "OVERFLOW:hidden; " - "POSITION:absolute; " - "VISIBILITY:inherit; " - "LEFT:"ht_flex_format"; " - "TOP:"ht_flex_format"; " - "WIDTH:"ht_flex_format"; " - "HEIGHT:"ht_flex_format"; " - "Z-INDEX:%POS; " + "\t\t#dd%POSbtn { " + "position:absolute; " + "visibility:inherit; " + "overflow:hidden; " + "left:"ht_flex_format"; " + "top:"ht_flex_format"; " + "width:"ht_flex_format"; " + "height:"ht_flex_format"; " + "z-index:%POS; " "cursor:default; " "background-color: %STR&CSSVAL; " "border:1px outset #e0e0e0; " @@ -174,21 +174,28 @@ int htddRender(pHtSession s, pWgtrNode tree, int z) { z, bgstr ); - if (*textcolor) { - htrAddStylesheetItem_va(s,"\t#dd%POSbtn { color: %STR&CSSVAL; }\n",id,textcolor); - } + if (*textcolor) + { + htrAddStylesheetItem_va(s, + "\t\t#dd%POSbtn { " + "color:%STR&CSSVAL; " + "}\n", + id, + textcolor + ); + } htrAddStylesheetItem_va(s, - "\t.dd%POScon { " - "overflow:hidden; " + "\t\t.dd%POScon { " "position:absolute; " + "overflow:hidden; " "left:1px; " "top:1px; " "width:1024px; " - "height:"ht_flex_format"; " + "height:%POS; " "z-index:%POS; " "}\n", id, - ht_flex(h - 2, h, 0.0), + h - 2, z + 1 ); diff --git a/centrallix/htmlgen/htdrv_editbox.c b/centrallix/htmlgen/htdrv_editbox.c index f4b85c397..5655e273a 100644 --- a/centrallix/htmlgen/htdrv_editbox.c +++ b/centrallix/htmlgen/htdrv_editbox.c @@ -151,7 +151,7 @@ htebRender(pHtSession s, pWgtrNode tree, int z) /** Ok, write the style header items. **/ const int base_w = w - (2 * box_offset); htrAddStylesheetItem_va(s, - "\t#eb%POSbase { " + "\t\t#eb%POSbase { " "position:absolute; " "visibility:inherit; " "overflow:hidden; " @@ -167,7 +167,7 @@ htebRender(pHtSession s, pWgtrNode tree, int z) z ); htrAddStylesheetItem_va(s, - "\t#eb%POScon1 { " + "\t\t#eb%POScon1 { " "position:absolute; " "visibility:inherit; " "left:5px; " @@ -230,14 +230,40 @@ htebRender(pHtSession s, pWgtrNode tree, int z) /** Use CSS border for drawing **/ if (is_raised) - htrAddStylesheetItem_va(s,"\t#eb%POSbase { border-style:solid; border-width:1px; border-color: white gray gray white; %STR }\n",id, main_bg); + { + htrAddStylesheetItem_va(s, + "\t\t#eb%POSbase { " + "border-style:solid; " + "border-width:1px; " + "border-color: " + "white gray gray white; " + "%STR " + "}\n", + id, + main_bg + ); + } else - htrAddStylesheetItem_va(s,"\t#eb%POSbase { border-style:solid; border-width:1px; border-color: gray white white gray; %STR }\n",id, main_bg); + { + htrAddStylesheetItem_va(s, + "\t\t#eb%POSbase { " + "border-style:solid; " + "border-width:1px; " + "border-color:gray white white gray; " + "%STR " + "}\n", + id, + main_bg + ); + } if (h >= 0) { htrAddStylesheetItem_va(s, - "\t#eb%POSbase { height:"ht_flex_format"; }\n", - id, ht_flex(h - (2 * box_offset), ht_get_parent_h(tree), ht_get_fl_h(tree)) + "\t\t#eb%POSbase { " + "height:"ht_flex_format"; " + "}\n", + id, + ht_flex_h(h - (2 * box_offset), tree) ); } diff --git a/centrallix/htmlgen/htdrv_fileupload.c b/centrallix/htmlgen/htdrv_fileupload.c index a3ed1a5c2..88953e857 100755 --- a/centrallix/htmlgen/htdrv_fileupload.c +++ b/centrallix/htmlgen/htdrv_fileupload.c @@ -94,7 +94,13 @@ htfuRender(pHtSession s, pWgtrNode tree, int z) htrAddScriptInit_va(s, " fu_init({layer:wgtrGetNodeRef(ns,'%STR&SYM'), pane:document.getElementById(\"fu%POSform\"), input:document.getElementById(\"fu%POSinput\"), iframe:document.getElementById(\"fu%POSiframe\"), target:\"%STR&JSSTR\"});\n", name, id, id, id, target); /** style header items **/ - htrAddStylesheetItem_va(s,"#fu%POSbase { POSITION:absolute; VISIBILITY:hidden; }\n", id); + htrAddStylesheetItem_va(s, + "\t\t#fu%POSbase { " + "position:absolute; " + "visibility:hidden; " + "}\n", + id + ); htrAddBodyItem_va(s,"
", id, id, id, id, id, id, id, multiselect?"MULTIPLE":""); /** Check for more sub-widgets **/ diff --git a/centrallix/htmlgen/htdrv_formstatus.c b/centrallix/htmlgen/htdrv_formstatus.c index b4b0d504c..1000a22cd 100644 --- a/centrallix/htmlgen/htdrv_formstatus.c +++ b/centrallix/htmlgen/htdrv_formstatus.c @@ -90,7 +90,7 @@ int htfsRender(pHtSession s, pWgtrNode tree, int z) { /** Ok, write the style header items. **/ htrAddStylesheetItem_va(s, - "\t#fs%POSmain { " + "\t\t#fs%POSmain { " "position:absolute; " "visibility:inherit; " "left:"ht_flex_format"; " diff --git a/centrallix/htmlgen/htdrv_frameset.c b/centrallix/htmlgen/htdrv_frameset.c index 7ed9215d3..6d88a613a 100644 --- a/centrallix/htmlgen/htdrv_frameset.c +++ b/centrallix/htmlgen/htdrv_frameset.c @@ -58,7 +58,7 @@ htsetRender(pHtSession s, pWgtrNode tree, int z) /** Check for a title. **/ if (wgtrGetPropertyValue(tree,"title",DATA_T_STRING,POD(&ptr)) == 0) { - htrAddHeaderItem_va(s," %STR&HTE\n",ptr); + htrAddHeaderItem_va(s, "\t%STR&HTE\n", ptr); } /** Loop through the frames (widget/page items) for geometry data **/ diff --git a/centrallix/htmlgen/htdrv_html.c b/centrallix/htmlgen/htdrv_html.c index 509438673..670af981b 100644 --- a/centrallix/htmlgen/htdrv_html.c +++ b/centrallix/htmlgen/htdrv_html.c @@ -103,11 +103,11 @@ hthtmlRender(pHtSession s, pWgtrNode tree, int z) if (x < 0 || y < 0) { htrAddStylesheetItem_va(s, - "\t#ht%POSpane, #ht%POSpane, #ht%POSfader { " - "POSITION:relative; " - "VISIBILITY:inherit; " - "WIDTH:"ht_flex_format"; " - "Z-INDEX:%POS; " + "\t\t#ht%POSpane, #ht%POSpane, #ht%POSfader { " + "position:relative; " + "visibility:inherit; " + "width:"ht_flex_format"; " + "z-index:%POS; " "}\n", id, id, id, ht_flex_w(w, tree), @@ -117,13 +117,13 @@ hthtmlRender(pHtSession s, pWgtrNode tree, int z) else { htrAddStylesheetItem_va(s, - "\t#ht%POSpane, #ht%POSpane2, #ht%POSfader { " - "POSITION:absolute; " - "VISIBILITY:inherit; " - "LEFT:"ht_flex_format"; " - "TOP:"ht_flex_format"; " - "WIDTH:"ht_flex_format"; " - "Z-INDEX:%POS; " + "\t\t#ht%POSpane, #ht%POSpane2, #ht%POSfader { " + "position:absolute; " + "visibility:inherit; " + "left:"ht_flex_format"; " + "top:"ht_flex_format"; " + "width:"ht_flex_format"; " + "z-index:%POS; " "}\n", id, id, id, ht_flex_x(x, tree), @@ -135,8 +135,24 @@ hthtmlRender(pHtSession s, pWgtrNode tree, int z) if (s->Capabilities.CSS1) { - htrAddStylesheetItem_va(s,"\t#ht%POSpane, #ht%POSpane2, #ht%POSfader { overflow:hidden; }\n", id, id, id); - htrAddStylesheetItem_va(s,"\t#ht%POSloader { overflow:hidden; visibility:hidden; position:absolute; top:0px; left:0px; width:0px; height:0px; }\n", id); + htrAddStylesheetItem_va(s, + "\t\t#ht%POSpane, #ht%POSpane2, #ht%POSfader { " + "overflow:hidden; " + "}\n", + id, id, id + ); + htrAddStylesheetItem_va(s, + "\t\t#ht%POSloader { " + "position:absolute; " + "visibility:hidden; " + "overflow:hidden; " + "top:0px; " + "left:0px; " + "width:0px; " + "height:0px; " + "}\n", + id + ); } /** Write named global **/ diff --git a/centrallix/htmlgen/htdrv_image.c b/centrallix/htmlgen/htdrv_image.c index b9fe1585f..a1c6e6722 100644 --- a/centrallix/htmlgen/htdrv_image.c +++ b/centrallix/htmlgen/htdrv_image.c @@ -56,10 +56,23 @@ htimgSetup(pHtSession s) { /** Global style code for all image widget "img" tags **/ - htrAddStylesheetItem(s, " img.wimage { display:block; position:relative; left:0px; top:0px; }\n"); + htrAddStylesheetItem(s, + "\t\timg.wimage { " + "display:block; " + "position:relative; " + "left:0px; " + "top:0px; " + "}\n" + ); /** Global style code for all image widget "div" containers **/ - htrAddStylesheetItem(s, " div.wimage { visibility:inherit; position:absolute; overflow:hidden; }\n"); + htrAddStylesheetItem(s, + "\t\tdiv.wimage { " + "visibility:inherit; " + "position:absolute; " + "overflow:hidden; " + "}\n" + ); return 0; } @@ -167,7 +180,7 @@ htimgRender(pHtSession s, pWgtrNode tree, int z) /** Write the style for the image container div. **/ htrAddStylesheetItem_va(s, - "\t#img%POS { " + "\t\t#img%POS { " "left:"ht_flex_format"; " "top:"ht_flex_format"; " "width:"ht_flex_format"; " diff --git a/centrallix/htmlgen/htdrv_imagebutton.c b/centrallix/htmlgen/htdrv_imagebutton.c index 3f0bb5390..908947e08 100644 --- a/centrallix/htmlgen/htdrv_imagebutton.c +++ b/centrallix/htmlgen/htdrv_imagebutton.c @@ -138,7 +138,7 @@ htibtnRender(pHtSession s, pWgtrNode tree, int z) /** Ok, write the style header items. **/ htrAddStylesheetItem_va(s, - "\t#ib%POSpane { " + "\t\t#ib%POSpane { " "position:absolute; " "visibility:inherit; " "overflow:hidden;" diff --git a/centrallix/htmlgen/htdrv_label.c b/centrallix/htmlgen/htdrv_label.c index 77ea3ffdc..084bbd97a 100644 --- a/centrallix/htmlgen/htdrv_label.c +++ b/centrallix/htmlgen/htdrv_label.c @@ -198,7 +198,7 @@ htlblRender(pHtSession s, pWgtrNode tree, int z) /** Ok, write the style header items. **/ htrAddStylesheetItem_va(s, - "\t#lbl%POS { " + "\t\t#lbl%POS { " "position:absolute; " "visibility:inherit; " "left:"ht_flex_format"; " @@ -233,12 +233,32 @@ htlblRender(pHtSession s, pWgtrNode tree, int z) ); if (is_link) - htrAddStylesheetItem_va(s,"\t#lbl%POS:hover { %[color:%STR&CSSVAL; %]text-decoration:underline; cursor:pointer; }\n", id, *pfgcolor, pfgcolor); + { + htrAddStylesheetItem_va(s, + "\t\t#lbl%POS:hover { " + "%[color:%STR&CSSVAL; %]" + "text-decoration:underline; " + "cursor:pointer; " + "}\n", + id, + (*pfgcolor), pfgcolor + ); + } if (is_link && *cfgcolor) - htrAddStylesheetItem_va(s,"\t#lbl%POS:active { color:%STR&CSSVAL; text-decoration:underline; cursor:pointer; }\n", id, cfgcolor); + { + htrAddStylesheetItem_va(s, + "\t\t#lbl%POS:active { " + "color:%STR&CSSVAL; " + "text-decoration:underline; " + "cursor:pointer; " + "}\n", + id, + cfgcolor + ); + } htrAddStylesheetItem_va(s, - "\t#lbl%POS p { " + "\t\t#lbl%POS p { " "text-align:%STR&CSSVAL; " "%[position:relative; top:50%%; transform:translateY(-50%%); %]" "padding:0px; " diff --git a/centrallix/htmlgen/htdrv_map.c b/centrallix/htmlgen/htdrv_map.c index 73f0d5518..28f23f3f7 100755 --- a/centrallix/htmlgen/htdrv_map.c +++ b/centrallix/htmlgen/htdrv_map.c @@ -104,7 +104,20 @@ int htmapRender(pHtSession s, pWgtrNode map_node, int z) strtcpy(name, ptr, sizeof(name)); /** Add css item for the layer **/ - htrAddStylesheetItem_va(s, "\t#map%POSbase { POSITION:absolute; VISIBILITY:inherit; LEFT:%INTpx; TOP:%INTpx; WIDTH:%POSpx; HEIGHT:%POSpx; Z-INDEX:%POS; overflow: hidden; %STR}\n", id, x, y, w, h, z, main_bg); + htrAddStylesheetItem_va(s, + "\t\t#map%POSbase { " + "position:absolute; " + "visibility:inherit; " + "overflow:hidden; " + "left:%INTpx; " + "top:%INTpx; " + "width:%POSpx; " + "height:%POSpx; " + "z-index:%POS; " + "%STR " + "}\n", + id, x, y, w, h, z, main_bg + ); htrAddWgtrObjLinkage_va(s, map_node, "map%POSbase", id); diff --git a/centrallix/htmlgen/htdrv_menu.c b/centrallix/htmlgen/htdrv_menu.c index 331b8bb92..75188cba8 100644 --- a/centrallix/htmlgen/htdrv_menu.c +++ b/centrallix/htmlgen/htdrv_menu.c @@ -286,7 +286,7 @@ htmenuRender(pHtSession s, pWgtrNode menu, int z) /** Write styles for the main DOM element. **/ htrAddStylesheetItem_va(s, - "\t#mn%POSmain { " + "\t\t#mn%POSmain { " "position:absolute; " "visibility:%STR; " "left:"ht_flex_format"; " @@ -305,14 +305,34 @@ htmenuRender(pHtSession s, pWgtrNode menu, int z) ); if (shadow_radius > 0) { - htrAddStylesheetItem_va(s,"\t#mn%POSmain { box-shadow: %POSpx %POSpx %POSpx %STR&CSSVAL; }\n", id, shadow_offset, shadow_offset, shadow_radius, shadow_color); + htrAddStylesheetItem_va(s, + "\t\t#mn%POSmain { " + "box-shadow: %POSpx %POSpx %POSpx %STR&CSSVAL; " + "}\n", + id, + shadow_offset, shadow_offset, shadow_radius, shadow_color + ); } if (s->Capabilities.CSS2) - htrAddStylesheetItem_va(s,"\t#mn%POSmain { overflow:hidden; border-style: solid; border-width: 1px; border-color: white gray gray white; color:%STR; %STR }\n", id, textcolor, bgstr); + { + htrAddStylesheetItem_va(s, + "\t\t#mn%POSmain { " + "overflow:hidden; " + "border-style:solid; " + "border-width:1px; " + "border-color:white gray gray white; " + "color:%STR; " + "%STR " + "}\n", + id, + textcolor, + bgstr + ); + } /** Write styles for the content container. **/ htrAddStylesheetItem_va(s, - "\t#mn%POScontent { " + "\t\t#mn%POScontent { " "position:absolute; " "visibility:inherit; " "left:0px; " @@ -325,12 +345,38 @@ htmenuRender(pHtSession s, pWgtrNode menu, int z) z + 1 ); if (s->Capabilities.CSS2) - htrAddStylesheetItem_va(s,"\t#mn%POScontent { overflow:hidden; cursor:default; }\n", id ); + { + htrAddStylesheetItem_va(s, + "\t\t#mn%POScontent { " + "overflow:hidden; " + "cursor:default; " + "}\n", + id + ); + } /** Write styles for the highlight bar. **/ - htrAddStylesheetItem_va(s, "\t#mn%POShigh { POSITION:absolute; VISIBILITY: hidden; LEFT:0px; TOP:0px; Z-INDEX:%POS; }\n", id, z); + htrAddStylesheetItem_va(s, + "\t\t#mn%POShigh { " + "position:absolute; " + "visibility: " + "hidden; " + "left:0px; " + "top:0px; " + "z-index:%POS; " + "}\n", + id, + z + ); if (s->Capabilities.CSS2) - htrAddStylesheetItem_va(s,"\t#mn%POShigh { overflow:hidden; }\n", id ); + { + htrAddStylesheetItem_va(s, + "\t\t#mn%POShigh { " + "overflow:hidden; " + "}\n", + id + ); + } /** Get name **/ if (wgtrGetPropertyValue(menu,"name",DATA_T_STRING,POD(&ptr)) != 0) return -1; diff --git a/centrallix/htmlgen/htdrv_multiscroll.c b/centrallix/htmlgen/htdrv_multiscroll.c index 2db7a3d66..5829fa8be 100644 --- a/centrallix/htmlgen/htdrv_multiscroll.c +++ b/centrallix/htmlgen/htdrv_multiscroll.c @@ -107,12 +107,36 @@ htmsRender(pHtSession s, pWgtrNode tree, int z) /** Ok, write the style header items. **/ if(s->Capabilities.Dom0NS) { - htrAddStylesheetItem_va(s,"\t#ms%POSmain { POSITION:absolute; VISIBILITY:inherit; LEFT:%INTpx; TOP:%INTpx; WIDTH:%POSpx; HEIGHT:%POSpx; Z-INDEX:%POS; }\n",id,x,y,w,h,z); + htrAddStylesheetItem_va(s, + "\t\t#ms%POSmain { " + "position:absolute; " + "visibility:inherit; " + "left:%INTpx; " + "top:%INTpx; " + "width:%POSpx; " + "height:%POSpx; " + "z-index:%POS; " + "}\n", + id, x, y, w, h, z + ); } else if(s->Capabilities.CSS1) { - htrAddStylesheetItem_va(s,"\t#ms%POSmain { POSITION:absolute; VISIBILITY:inherit; overflow:hidden; LEFT:%INTpx; TOP:%INTpx; WIDTH:%POSpx; HEIGHT:%POSpx; Z-INDEX:%POS; }\n",id,x,y,w,h,z); - htrAddStylesheetItem_va(s,"\t#ms%POSmain { %STR}\n",id,main_bg); + htrAddStylesheetItem_va(s, + "\t\t#ms%POSmain { " + "position:absolute; " + "visibility:inherit; " + "overflow:hidden; " + "left:%INTpx; " + "top:%INTpx; " + "width:%POSpx; " + "height:%POSpx; " + "z-index:%POS; " + "%STR " + "}\n", + id, x, y, w, h, z, + main_bg + ); } else { @@ -163,7 +187,20 @@ htmsRender(pHtSession s, pWgtrNode tree, int z) else cy = h - total_h + total_h_accum; total_h_accum += ch; - htrAddStylesheetItem_va(s,"\t#ms%POSpart%POS { POSITION:absolute; VISIBILITY:inherit; overflow:hidden; LEFT:0px; TOP:%INTpx; WIDTH:%POSpx; HEIGHT:%POSpx; Z-INDEX:%POS; CLIP:rect(0px,%INTpx,%INTpx,0px);}\n",id,i,cy,w,ch,z+1,w,ch); + htrAddStylesheetItem_va(s, + "\t\t#ms%POSpart%POS { " + "position:absolute; " + "visibility:inherit; " + "overflow:hidden; " + "left:0px; " + "top:%INTpx; " + "width:%POSpx; " + "height:%POSpx; " + "z-index:%POS; " + "clip:rect(0px, %INTpx, %INTpx, 0px); " + "}\n", + id, i, cy, w, ch, z + 1, w, ch + ); if (wgtrGetPropertyValue(child,"name",DATA_T_STRING,POD(&ptr)) != 0) return -1; if (always_visible && ch == 0) { diff --git a/centrallix/htmlgen/htdrv_objcanvas.c b/centrallix/htmlgen/htdrv_objcanvas.c index 5a1150533..bbd88d22e 100644 --- a/centrallix/htmlgen/htdrv_objcanvas.c +++ b/centrallix/htmlgen/htdrv_objcanvas.c @@ -108,7 +108,7 @@ htocRender(pHtSession s, pWgtrNode oc_node, int z) if (s->Capabilities.CSS2) { htrAddStylesheetItem_va(s, - "\t#oc%POSbase { " + "\t\t#oc%POSbase { " "position:absolute; " "visibility:inherit; " "overflow:hidden; " @@ -129,7 +129,20 @@ htocRender(pHtSession s, pWgtrNode oc_node, int z) ); } else - htrAddStylesheetItem_va(s,"\t#oc%POSbase { POSITION:absolute; VISIBILITY:inherit; LEFT:%INT; TOP:%INT; WIDTH:%POS; HEIGHT:%POS; Z-INDEX:%POS; }\n",id,x,y,w,h,z); + { + htrAddStylesheetItem_va(s, + "\t\t#oc%POSbase { " + "position:absolute; " + "visibility:inherit; " + "left:%INT; " + "top:%INT; " + "width:%POS; " + "height:%POS; " + "z-index:%POS; " + "}\n", + id, x, y, w, h, z + ); + } htrAddWgtrObjLinkage_va(s, oc_node, "oc%POSbase",id); diff --git a/centrallix/htmlgen/htdrv_osrc.c b/centrallix/htmlgen/htdrv_osrc.c index 9ba4bbfd9..5719e7e8e 100644 --- a/centrallix/htmlgen/htdrv_osrc.c +++ b/centrallix/htmlgen/htdrv_osrc.c @@ -250,7 +250,19 @@ htosrcRender(pHtSession s, pWgtrNode tree, int z) htrAddScriptGlobal(s, "osrc_relationships", "[]", 0); /** Ok, write the style header items. **/ - htrAddStylesheetItem_va(s," #osrc%POSloader { overflow:hidden; POSITION:absolute; VISIBILITY:hidden; LEFT:0px; TOP:1px; WIDTH:1px; HEIGHT:1px; Z-INDEX:0; }\n",id); + htrAddStylesheetItem_va(s, + "\t\t#osrc%POSloader { " + "position:absolute; " + "visibility:hidden; " + "overflow:hidden; " + "left:0px; " + "top:1px; " + "width:1px; " + "height:1px; " + "z-index:0; " + "}\n", + id + ); /** Script initialization call. **/ htrAddScriptInit_va(s," osrc_init({loader:wgtrGetNodeRef(ns,\"%STR&SYM\"), readahead:%INT, scrollahead:%INT, replicasize:%INT, sql:\"%STR&JSSTR\", filter:\"%STR&JSSTR\", baseobj:\"%STR&JSSTR\", name:\"%STR&SYM\", autoquery:%INT, requestupdates:%INT, ind_act:%INT, use_having:%INT, qy_reveal_only:%INT, send_updates:%INT, key_objname:\"%STR&JSSTR\", refresh:%INT});\n", diff --git a/centrallix/htmlgen/htdrv_page.c b/centrallix/htmlgen/htdrv_page.c index e79f7b47e..9b91fe72d 100755 --- a/centrallix/htmlgen/htdrv_page.c +++ b/centrallix/htmlgen/htdrv_page.c @@ -103,13 +103,13 @@ htpageRender(pHtSession s, pWgtrNode tree, int z) /** Page icon? **/ if (wgtrGetPropertyValue(tree, "icon", DATA_T_STRING, POD(&ptr)) == 0) { - htrAddHeaderItem_va(s, " \n",ptr); + htrAddHeaderItem_va(s, "\t\n",ptr); } /** Check for a title. **/ - if (wgtrGetPropertyValue(tree,"title",DATA_T_STRING,POD(&ptr)) == 0) + if (wgtrGetPropertyValue(tree, "title", DATA_T_STRING, POD(&ptr)) == 0) { - htrAddHeaderItem_va(s, " %STR&HTE\n",ptr); + htrAddHeaderItem_va(s, "\t%STR&HTE\n", ptr); } /** Check for page load status **/ @@ -324,60 +324,62 @@ htpageRender(pHtSession s, pWgtrNode tree, int z) /** Shutdown **/ htrAddScriptCleanup_va(s, " pg_cleanup();\n"); + /** Add focus box. **/ if(s->Capabilities.HTML40) { - /** Add focus box **/ - htrAddStylesheetItem(s,"\ttd img { display: block; }\n"); - htrAddStylesheetItem(s,"\t#pgtop { POSITION:absolute; VISIBILITY:hidden; LEFT:-1000px;TOP:0px;WIDTH:1152px;HEIGHT:1px; clip:rect(0px,0px,0px,0px); Z-INDEX:1000; overflow:hidden;}\n"); - htrAddStylesheetItem(s,"\t#pgbtm { POSITION:absolute; VISIBILITY:hidden; LEFT:-1000px;TOP:0px;WIDTH:1152px;HEIGHT:1px; clip:rect(0px,0px,0px,0px); Z-INDEX:1000; overflow:hidden;}\n"); - htrAddStylesheetItem(s,"\t#pgrgt { POSITION:absolute; VISIBILITY:hidden; LEFT:0px;TOP:-1000px;WIDTH:1px;HEIGHT:864px; clip:rect(0px,0px,0px,0px); Z-INDEX:1000; overflow:hidden;}\n"); - htrAddStylesheetItem(s,"\t#pglft { POSITION:absolute; VISIBILITY:hidden; LEFT:0px;TOP:-1000px;WIDTH:1px;HEIGHT:864px; clip:rect(0px,0px,0px,0px); Z-INDEX:1000; overflow:hidden;}\n"); - htrAddStylesheetItem(s,"\t#pgtvl { POSITION:absolute; VISIBILITY:hidden; LEFT:0px;TOP:0px;WIDTH:1px;HEIGHT:1px; Z-INDEX:0; }\n"); - htrAddStylesheetItem(s,"\t#pgktop { POSITION:absolute; VISIBILITY:hidden; LEFT:-1000px;TOP:0px;WIDTH:1152px;HEIGHT:1px; clip:rect(0px,0px,0px,0px); Z-INDEX:1000; overflow:hidden;}\n"); - htrAddStylesheetItem(s,"\t#pgkbtm { POSITION:absolute; VISIBILITY:hidden; LEFT:-1000px;TOP:0px;WIDTH:1152px;HEIGHT:1px; clip:rect(0px,0px,0px,0px); Z-INDEX:1000; overflow:hidden;}\n"); - htrAddStylesheetItem(s,"\t#pgkrgt { POSITION:absolute; VISIBILITY:hidden; LEFT:0px;TOP:-1000px;WIDTH:1px;HEIGHT:864px; clip:rect(0px,0px,0px,0px); Z-INDEX:1000; overflow:hidden;}\n"); - htrAddStylesheetItem(s,"\t#pgklft { POSITION:absolute; VISIBILITY:hidden; LEFT:0px;TOP:-1000px;WIDTH:1px;HEIGHT:864px; clip:rect(0px,0px,0px,0px); Z-INDEX:1000; overflow:hidden;}\n"); - htrAddStylesheetItem(s,"\t#pginpt { POSITION:absolute; VISIBILITY:hidden; LEFT:0px; TOP:20px; Z-INDEX:20; }\n"); - htrAddStylesheetItem(s,"\t#pgping { POSITION:absolute; VISIBILITY:hidden; LEFT:0px; TOP:0px; WIDTH:0px; HEIGHT:0px; Z-INDEX:0;}\n"); - htrAddStylesheetItem(s,"\t#pgmsg { POSITION:absolute; VISIBILITY:hidden; LEFT:0px; TOP:0px; WIDTH:0px; HEIGHT:0px; Z-INDEX:0;}\n"); + htrAddStylesheetItem(s, + "\t\ttd img { display: block; }\n" + "\t\t#pgtop { position:absolute; visibility:hidden; left:-1000px; top:0px; width:1152px; height:1px; z-index:1000; clip:rect(0px,0px,0px,0px); overflow:hidden; }\n" + "\t\t#pgbtm { position:absolute; visibility:hidden; left:-1000px; top:0px; width:1152px; height:1px; z-index:1000; clip:rect(0px,0px,0px,0px); overflow:hidden; }\n" + "\t\t#pgrgt { position:absolute; visibility:hidden; left:0px; top:-1000px; width:1px; height:864px; z-index:1000; clip:rect(0px,0px,0px,0px); overflow:hidden; }\n" + "\t\t#pglft { position:absolute; visibility:hidden; left:0px; top:-1000px; width:1px; height:864px; z-index:1000; clip:rect(0px,0px,0px,0px); overflow:hidden; }\n" + "\t\t#pgtvl { position:absolute; visibility:hidden; left:0px; top:0px; width:1px; height:1px; z-index:0; }\n" + "\t\t#pgktop { position:absolute; visibility:hidden; left:-1000px; top:0px; width:1152px; height:1px; z-index:1000; clip:rect(0px,0px,0px,0px); overflow:hidden; }\n" + "\t\t#pgkbtm { position:absolute; visibility:hidden; left:-1000px; top:0px; width:1152px; height:1px; z-index:1000; clip:rect(0px,0px,0px,0px); overflow:hidden; }\n" + "\t\t#pgkrgt { position:absolute; visibility:hidden; left:0px; top:-1000px; width:1px; height:864px; z-index:1000; clip:rect(0px,0px,0px,0px); overflow:hidden; }\n" + "\t\t#pgklft { position:absolute; visibility:hidden; left:0px; top:-1000px; width:1px; height:864px; z-index:1000; clip:rect(0px,0px,0px,0px); overflow:hidden; }\n" + "\t\t#pginpt { position:absolute; visibility:hidden; left:0px; top:20px; z-index:20; }\n" + "\t\t#pgping { position:absolute; visibility:hidden; left:0px; top:0px; width:0px; height:0px; z-index:0; }\n" + "\t\t#pgmsg { position:absolute; visibility:hidden; left:0px; top:0px; width:0px; height:0px; z-index:0; }\n" + ); } else { - /** Add focus box **/ htrAddStylesheetItem(s, - "\t#pgtop { POSITION:absolute; VISIBILITY:hidden; LEFT:0;TOP:0;WIDTH:1152;HEIGHT:1; clip:rect(1,1); Z-INDEX:1000;}\n" - "\t#pgbtm { POSITION:absolute; VISIBILITY:hidden; LEFT:0;TOP:0;WIDTH:1152;HEIGHT:1; clip:rect(1,1); Z-INDEX:1000;}\n" - "\t#pgrgt { POSITION:absolute; VISIBILITY:hidden; LEFT:0;TOP:0;WIDTH:1;HEIGHT:864; clip:rect(1,1); Z-INDEX:1000;}\n" - "\t#pglft { POSITION:absolute; VISIBILITY:hidden; LEFT:0;TOP:0;WIDTH:1;HEIGHT:864; clip:rect(1,1); Z-INDEX:1000;}\n" - "\t#pgtvl { POSITION:absolute; VISIBILITY:hidden; LEFT:0;TOP:0;WIDTH:1;HEIGHT:1; Z-INDEX:0; }\n" - "\t#pgktop { POSITION:absolute; VISIBILITY:hidden; LEFT:0;TOP:0;WIDTH:1152;HEIGHT:1; clip:rect(1,1); Z-INDEX:1000;}\n" - "\t#pgkbtm { POSITION:absolute; VISIBILITY:hidden; LEFT:0;TOP:0;WIDTH:1152;HEIGHT:1; clip:rect(1,1); Z-INDEX:1000;}\n" - "\t#pgkrgt { POSITION:absolute; VISIBILITY:hidden; LEFT:0;TOP:0;WIDTH:1;HEIGHT:864; clip:rect(1,1); Z-INDEX:1000;}\n" - "\t#pgklft { POSITION:absolute; VISIBILITY:hidden; LEFT:0;TOP:0;WIDTH:1;HEIGHT:864; clip:rect(1,1); Z-INDEX:1000;}\n" - "\t#pginpt { POSITION:absolute; VISIBILITY:hidden; LEFT:0; TOP:20; Z-INDEX:20; }\n" - "\t#pgping { POSITION:absolute; VISIBILITY:hidden; LEFT:0; TOP:0; Z-INDEX:0; }\n" - "\t#pgmsg { POSITION:absolute; VISIBILITY:hidden; LEFT:0; TOP:0; Z-INDEX:0; }\n"); + "\t\t#pgtop { position:absolute; visibility:hidden; left:0; top:0; width:1152; height:1; z-index:1000; clip:rect(1,1); }\n" + "\t\t#pgbtm { position:absolute; visibility:hidden; left:0; top:0; width:1152; height:1; z-index:1000; clip:rect(1,1); }\n" + "\t\t#pgrgt { position:absolute; visibility:hidden; left:0; top:0; width:1; height:864; z-index:1000; clip:rect(1,1); }\n" + "\t\t#pglft { position:absolute; visibility:hidden; left:0; top:0; width:1; height:864; z-index:1000; clip:rect(1,1); }\n" + "\t\t#pgtvl { position:absolute; visibility:hidden; left:0; top:0; width:1; height:1; z-index:0; }\n" + "\t\t#pgktop { position:absolute; visibility:hidden; left:0; top:0; width:1152; height:1; z-index:1000; clip:rect(1,1); }\n" + "\t\t#pgkbtm { position:absolute; visibility:hidden; left:0; top:0; width:1152; height:1; z-index:1000; clip:rect(1,1); }\n" + "\t\t#pgkrgt { position:absolute; visibility:hidden; left:0; top:0; width:1; height:864; z-index:1000; clip:rect(1,1); }\n" + "\t\t#pgklft { position:absolute; visibility:hidden; left:0; top:0; width:1; height:864; z-index:1000; clip:rect(1,1); }\n" + "\t\t#pginpt { position:absolute; visibility:hidden; left:0; top:20; z-index:20; }\n" + "\t\t#pgping { position:absolute; visibility:hidden; left:0; top:0; z-index:0; }\n" + "\t\t#pgmsg { position:absolute; visibility:hidden; left:0; top:0; z-index:0; }\n" + ); } if (show == 1) { - htrAddStylesheetItem(s, "\t#pgstat { POSITION:absolute; VISIBILITY:visible; LEFT:0;TOP:0;WIDTH:100%;HEIGHT:99%; Z-INDEX:100000;}\n"); + htrAddStylesheetItem(s, "\t\t#pgstat { position:absolute; visibility:visible; left:0;top:0;width:100%;height:99%; z-index:100000;}\n"); htrAddBodyItemLayerStart(s,0,"pgstat",0, NULL); htrAddBodyItem_va(s, "", bgstr); htrAddBodyItem (s, "
\n"); htrAddBodyItemLayerEnd(s,0); } - htrAddStylesheetItem_va(s, "\thtml { overflow:hidden; }\n"); - htrAddStylesheetItem_va(s, "\tbody { overflow:hidden; %[font-size:%POSpx; %]%[font-family:%STR&CSSVAL; %]}\n", + htrAddStylesheetItem_va(s, "\t\thtml { overflow:hidden; }\n"); + htrAddStylesheetItem_va(s, "\t\tbody { overflow:hidden; %[font-size:%POSpx; %]%[font-family:%STR&CSSVAL; %]}\n", font_size > 0, font_size, *font_name, font_name); - htrAddStylesheetItem(s, "\tpre { font-size:90%; }\n"); + htrAddStylesheetItem(s, "\t\tpre { font-size:90%; }\n"); if (s->Capabilities.Dom0NS) { - htrAddStylesheetItem_va(s, "\ttd { %[font-size:%POSpx; %]%[font-family:%STR&CSSVAL; %]}\n", + htrAddStylesheetItem_va(s, "\t\ttd { %[font-size:%POSpx; %]%[font-family:%STR&CSSVAL; %]}\n", font_size > 0, font_size, *font_name, font_name); - htrAddStylesheetItem_va(s, "\tfont { %[font-size:%POSpx; %]%[font-family:%STR&CSSVAL; %]}\n", + htrAddStylesheetItem_va(s, "\t\tfont { %[font-size:%POSpx; %]%[font-family:%STR&CSSVAL; %]}\n", font_size > 0, font_size, *font_name, font_name); } diff --git a/centrallix/htmlgen/htdrv_pane.c b/centrallix/htmlgen/htdrv_pane.c index 6536a9689..ef64ab7b6 100644 --- a/centrallix/htmlgen/htdrv_pane.c +++ b/centrallix/htmlgen/htdrv_pane.c @@ -162,7 +162,7 @@ htpnRender(pHtSession s, pWgtrNode tree, int z) { offset = -2 * box_offset; htrAddStylesheetItem_va(s, - "\t#pn%POSmain {" + "\t\t#pn%POSmain {" "border-style: solid; " "border-width: 1px; " "border-color: %STR %STR %STR %STR; " @@ -175,7 +175,7 @@ htpnRender(pHtSession s, pWgtrNode tree, int z) { offset = -2 * box_offset; htrAddStylesheetItem_va(s, - "\t#pn%POSmain {" + "\t\t#pn%POSmain {" "border-style: solid;" "border-width: 1px; " "border-color:%STR&CSSVAL; " @@ -191,7 +191,7 @@ htpnRender(pHtSession s, pWgtrNode tree, int z) /** Write the main CSS for the pane DOM node. **/ htrAddStylesheetItem_va(s, - "\t#pn%POSmain {" + "\t\t#pn%POSmain {" "position:absolute; " "visibility:inherit; " "overflow:hidden; " @@ -216,8 +216,11 @@ htpnRender(pHtSession s, pWgtrNode tree, int z) if (shadow_radius > 0) { htrAddStylesheetItem_va(s, - "\t#pn%POSmain { box-shadow: %POSpx %POSpx %POSpx %STR&CSSVAL; }\n", - id, shadow_offset, shadow_offset, shadow_radius, shadow_color + "\t\t#pn%POSmain { " + "box-shadow: %POSpx %POSpx %POSpx %STR&CSSVAL; " + "}\n", + id, + shadow_offset, shadow_offset, shadow_radius, shadow_color ); } diff --git a/centrallix/htmlgen/htdrv_radiobutton.c b/centrallix/htmlgen/htdrv_radiobutton.c index 27024d363..c201a0a16 100644 --- a/centrallix/htmlgen/htdrv_radiobutton.c +++ b/centrallix/htmlgen/htdrv_radiobutton.c @@ -185,7 +185,7 @@ int htrbRender(pHtSession s, pWgtrNode tree, int z) const int para_height = s->ClientInfo->ParagraphHeight; const int top_offset = (para_height * 3) / 4 + 1; htrAddStylesheetItem_va(s, - "#rb%POSparent { " + "\t\t#rb%POSparent { " "position:absolute; " "visibility:inherit; " "overflow:hidden; " @@ -203,7 +203,7 @@ int htrbRender(pHtSession s, pWgtrNode tree, int z) z ); htrAddStylesheetItem_va(s, - "#rb%POSborder { " + "\t\t#rb%POSborder { " "position:absolute; " "visibility:inherit; " "overflow:hidden; " @@ -219,7 +219,7 @@ int htrbRender(pHtSession s, pWgtrNode tree, int z) z + 1 ); htrAddStylesheetItem_va(s, - "#rb%POScover { " + "\t\t#rb%POScover { " "position:absolute; " "visibility:inherit; " "overflow:hidden; " @@ -233,7 +233,7 @@ int htrbRender(pHtSession s, pWgtrNode tree, int z) z + 2 ); htrAddStylesheetItem_va(s, - "#rb%POStitle { " + "\t\t#rb%POStitle { " "position:absolute; " "visibility:inherit; " "overflow:hidden; " @@ -319,7 +319,7 @@ int htrbRender(pHtSession s, pWgtrNode tree, int z) const double percent_space_above = (100.0 / radio_buttons.nItems) * i; const double content_above = ((double)content_height / radio_buttons.nItems) * i; htrAddStylesheetItem_va(s, - "#rb%POSoption%POS { " + "\t\t#rb%POSoption%POS { " "position:absolute; " "visibility:inherit; " "overflow:hidden; " @@ -341,7 +341,7 @@ int htrbRender(pHtSession s, pWgtrNode tree, int z) /** Write CSS for the radio button elements. **/ htrAddStylesheetItem_va(s, - "#rb%POSbuttonset%POS, " + "\t\t#rb%POSbuttonset%POS, " "#rb%POSbuttonunset%POS { " "position:absolute; " "overflow:hidden; " @@ -358,7 +358,7 @@ int htrbRender(pHtSession s, pWgtrNode tree, int z) z + 2 ); htrAddStylesheetItem_va(s, - "#rb%POSvalue%POS { " + "\t\t#rb%POSvalue%POS { " "position:absolute; " "visibility:hidden; " "overflow:hidden; " @@ -372,7 +372,7 @@ int htrbRender(pHtSession s, pWgtrNode tree, int z) z + 2 ); htrAddStylesheetItem_va(s, - "#rb%POSlabel%POS { " + "\t\t#rb%POSlabel%POS { " "position:absolute; " "visibility:inherit; " "overflow:hidden; " diff --git a/centrallix/htmlgen/htdrv_scrollbar.c b/centrallix/htmlgen/htdrv_scrollbar.c index e9b5b65e4..5b304443e 100644 --- a/centrallix/htmlgen/htdrv_scrollbar.c +++ b/centrallix/htmlgen/htdrv_scrollbar.c @@ -163,11 +163,48 @@ htsbRender(pHtSession s, pWgtrNode tree, int z) } /** Ok, write the style header items. **/ - htrAddStylesheetItem_va(s,"\t#sb%POSpane { POSITION:absolute; VISIBILITY:%STR; LEFT:%INTpx; TOP:%INTpx; WIDTH:%POSpx; HEIGHT:%POSpx; clip:rect(0px,%POSpx,%POSpx,0px); Z-INDEX:%POS; }\n",id,visible?"inherit":"hidden",x,y,w,h,w,h, z); + htrAddStylesheetItem_va(s, + "\t\t#sb%POSpane { " + "position:absolute; " + "visibility:%STR; " + "overflow:hidden; " + "left:%INTpx; " + "top:%INTpx; " + "width:%POSpx; " + "height:%POSpx; " + "z-index:%POS; " + "}\n", + id, + (visible) ? "inherit" : "hidden", + x, y, w, h, + z + ); if (is_horizontal) - htrAddStylesheetItem_va(s,"\t#sb%POSthum { POSITION:absolute; VISIBILITY:inherit; LEFT:18px; TOP:0px; WIDTH:18px; Z-INDEX:%POS; }\n",id,z+1); + htrAddStylesheetItem_va(s, + "\t\t#sb%POSthum { " + "position:absolute; " + "visibility:inherit; " + "left:18px; " + "top:0px; " + "width:18px; " + "z-index:%POS; " + "}\n", + id, + z + 1 + ); else - htrAddStylesheetItem_va(s,"\t#sb%POSthum { POSITION:absolute; VISIBILITY:inherit; LEFT:0px; TOP:18px; WIDTH:18px; Z-INDEX:%POS; }\n",id,z+1); + htrAddStylesheetItem_va(s, + "\t\t#sb%POSthum { " + "position:absolute; " + "visibility:inherit; " + "left:0px; " + "top:18px; " + "width:18px; " + "z-index:%POS; " + "}\n", + id, + z + 1 + ); /** Write globals for internal use **/ htrAddScriptGlobal(s, "sb_target_img", "null", 0); diff --git a/centrallix/htmlgen/htdrv_scrollpane.c b/centrallix/htmlgen/htdrv_scrollpane.c index 7b012e95e..84e98fadb 100644 --- a/centrallix/htmlgen/htdrv_scrollpane.c +++ b/centrallix/htmlgen/htdrv_scrollpane.c @@ -167,7 +167,7 @@ htspaneRender(pHtSession s, pWgtrNode tree, int z) /** Write shared CSS for the following UI elements. **/ htrAddStylesheetItem_va(s, - "\t.sp%POS_scroll { " + "\t\t.sp%POS_scroll { " "position:absolute; " "left:"ht_flex_format"; " "}\n", @@ -267,14 +267,14 @@ htspaneRender(pHtSession s, pWgtrNode tree, int z) { /** Write CSS for everything. **/ htrAddStylesheetItem_va(s, - "\t#sp%POSpane { " + "\t\t#sp%POSpane { " "position:absolute; " "visibility:%STR; " + "overflow:hidden; " "left:"ht_flex_format"; " "top:"ht_flex_format"; " "width:"ht_flex_format"; " "height:"ht_flex_format"; " - "overflow:clip; " "z-index:%POS; " "}\n", id, @@ -286,7 +286,7 @@ htspaneRender(pHtSession s, pWgtrNode tree, int z) z ); htrAddStylesheetItem_va(s, - "\t#sp%POSarea { " + "\t\t#sp%POSarea { " "position:absolute; " "visibility:inherit; " "left:0px; " @@ -299,7 +299,7 @@ htspaneRender(pHtSession s, pWgtrNode tree, int z) z + 1 ); htrAddStylesheetItem_va(s, - "\t#sp%POSthumb { " + "\t\t#sp%POSthumb { " "position:absolute; " "visibility:inherit; " "left:"ht_flex_format"; " diff --git a/centrallix/htmlgen/htdrv_spinner.c b/centrallix/htmlgen/htdrv_spinner.c index 7252b86a5..fcb0a7776 100644 --- a/centrallix/htmlgen/htdrv_spinner.c +++ b/centrallix/htmlgen/htdrv_spinner.c @@ -114,12 +114,12 @@ htspnrRender(pHtSession s, pWgtrNode tree, int z) } /** Ok, write the style header items. **/ - htrAddStylesheetItem_va(s,"\t#spnr%POSmain { POSITION:absolute; VISIBILITY:inherit; LEFT:%INT; TOP:%INT; WIDTH:%POS; Z-INDEX:%POS; }\n",id,x,y,w,z); - htrAddStylesheetItem_va(s,"\t#spnr%POSbase { POSITION:absolute; VISIBILITY:inherit; LEFT:%INT; TOP:%INT; WIDTH:%POS; Z-INDEX:%POS; }\n",id,1,1,w-12,z); - htrAddStylesheetItem_va(s,"\t#spnr%POScon1 { POSITION:absolute; VISIBILITY:inherit; LEFT:%INT; TOP:%INT; WIDTH:%POS; Z-INDEX:%POS; }\n",id,1,1,w-2-12,z+1); - htrAddStylesheetItem_va(s,"\t#spnr%POScon2 { POSITION:absolute; VISIBILITY:hidden; LEFT:%INT; TOP:%INT; WIDTH:%POS; Z-INDEX:%POS; }\n",id,1,1,w-2-12,z+1); - htrAddStylesheetItem_va(s,"\t#spnr_button_up { POSITION:absolute; VISIBILITY:inherit; LEFT:%INT; TOP:%INT; WIDTH:%POS; Z-INDEX:%POS; }\n",1+w-12,1,w,z); - htrAddStylesheetItem_va(s,"\t#spnr_button_down { POSITION:absolute; VISIBILITY:inherit; LEFT:%INT; TOP:%INT; WIDTH:%POS; Z-INDEX:%POS; }\n",1+w-12,1+9,w,z); + htrAddStylesheetItem_va(s, "\t\t#spnr%POSmain { position:absolute; visibility:inherit; left:%INT; top:%INT; width:%POS; z-index:%POS; }\n", id, x, y, w, z); + htrAddStylesheetItem_va(s, "\t\t#spnr%POSbase { position:absolute; visibility:inherit; left:%INT; top:%INT; width:%POS; z-index:%POS; }\n", id, 1, 1, w-12, z); + htrAddStylesheetItem_va(s, "\t\t#spnr%POScon1 { position:absolute; visibility:inherit; left:%INT; top:%INT; width:%POS; z-index:%POS; }\n", id, 1, 1, w-2-12, z+1); + htrAddStylesheetItem_va(s, "\t\t#spnr%POScon2 { position:absolute; visibility:hidden; left:%INT; top:%INT; width:%POS; z-index:%POS; }\n", id, 1, 1, w-2-12, z+1); + htrAddStylesheetItem_va(s, "\t\t#spnr_button_up { position:absolute; visibility:inherit; left:%INT; top:%INT; width:%POS; z-index:%POS; }\n", 1+w-12, 1, w, z); + htrAddStylesheetItem_va(s, "\t\t#spnr_button_down { position:absolute; visibility:inherit; left:%INT; top:%INT; width:%POS; z-index:%POS; }\n", 1+w-12, 1+9,w, z); /** DOM Linkage **/ htrAddWgtrObjLinkage_va(s, tree, "spnr%POSmain",id); diff --git a/centrallix/htmlgen/htdrv_tab.c b/centrallix/htmlgen/htdrv_tab.c index 75eaefdee..ba6e02a0f 100644 --- a/centrallix/htmlgen/htdrv_tab.c +++ b/centrallix/htmlgen/htdrv_tab.c @@ -470,14 +470,14 @@ httabRender(pHtSession s, pWgtrNode tree, int z) int tab_x = (x + xtoffset) + (i_offset_x * i); int tab_y = (y + ytoffset) + (i_offset_y * i); htrAddStylesheetItem_va(s, - "\t#tc%POStab%POS { " + "\t\t#tc%POStab%POS { " "position:absolute; " "visibility:inherit; " + "overflow:hidden; " "left:"ht_flex_format"; " "top:"ht_flex_format"; " "%[width:%POSpx; %]" /* Tab width has 0 flexibility. */ "%[height:%POSpx; %]" /* Tab height has 0 flexibility. */ - "overflow:hidden; " "z-index:%POS; " "cursor:default; " "border-radius:" @@ -517,8 +517,11 @@ httabRender(pHtSession s, pWgtrNode tree, int z) ); htrAddStylesheetItem_va(s, - "\t#tc%POStab%POS.tab_selected { transform: translate(%INTpx, %INTpx); }\n", - id, i + 1, select_x_offset, select_y_offset + "\t\t#tc%POStab%POS.tab_selected { " + "transform:translate(%INTpx, %INTpx); " + "}\n", + id, i + 1, + select_x_offset, select_y_offset ); /** Write tab HTML content. **/ @@ -544,7 +547,7 @@ httabRender(pHtSession s, pWgtrNode tree, int z) /** Write tab control CSS and HTML. **/ htrAddStylesheetItem_va(s, - "#tc%POSctrl {" + "\t\t#tc%POSctrl {" "position:absolute; " "overflow:hidden; " "left:"ht_flex_format"; " diff --git a/centrallix/htmlgen/htdrv_table.c b/centrallix/htmlgen/htdrv_table.c index 5876bf658..a7475d3a2 100644 --- a/centrallix/htmlgen/htdrv_table.c +++ b/centrallix/htmlgen/htdrv_table.c @@ -145,7 +145,7 @@ httblRenderDynamic(pHtSession s, pWgtrNode tree, int z, httbl_struct* t) /** Write CSS for the table base element. **/ const int content_width = (t->overlap_scrollbar) ? (t->w) : (t->w - 18); htrAddStylesheetItem_va(s, - "\t#tbld%POSbase { " + "\t\t#tbld%POSbase { " "position:absolute; " "visibility:inherit; " "left:"ht_flex_format"; " @@ -165,7 +165,7 @@ httblRenderDynamic(pHtSession s, pWgtrNode tree, int z, httbl_struct* t) /** Write CSS for the table scrollbar. **/ const int row_start_y = (t->has_header) ? (t->min_rowheight + t->cellvspacing) : 0; htrAddStylesheetItem_va(s, - "\t#tbld%POSscroll { " + "\t\t#tbld%POSscroll { " "position:absolute; " "visibility:%STR; " "left:"ht_flex_format"; " @@ -184,7 +184,7 @@ httblRenderDynamic(pHtSession s, pWgtrNode tree, int z, httbl_struct* t) /** Write CSS for the table scroll thumb. **/ htrAddStylesheetItem_va(s, - "\t#tbld%POSthumb { " + "\t\t#tbld%POSthumb { " "position:absolute; " "visibility:inherit; " "left:0px; " @@ -366,7 +366,7 @@ httblRenderDynamic(pHtSession s, pWgtrNode tree, int z, httbl_struct* t) int h; if (wgtrGetPropertyValue(sub_tree, "height", DATA_T_INTEGER, POD(&h)) != 0) h = t->min_rowheight; htrAddStylesheetItem_va(s, - "\t#tbld%POSsub%POS { " + "\t\t#tbld%POSsub%POS { " "position:absolute; " "visibility:hidden; " "left:0px; " diff --git a/centrallix/htmlgen/htdrv_terminal.c b/centrallix/htmlgen/htdrv_terminal.c index a4a8ec44a..77b01da00 100644 --- a/centrallix/htmlgen/htdrv_terminal.c +++ b/centrallix/htmlgen/htdrv_terminal.c @@ -144,10 +144,24 @@ httermRender(pHtSession s, pWgtrNode tree, int z) htrAddBodyItem_va(s," \n",id); /** write the stylesheet header element **/ - htrAddStylesheetItem_va(s," #term%POSbase { POSITION:absolute; VISIBILITY:inherit; LEFT:%INT; TOP:%INT; WIDTH:%POS; HEIGHT:%POS; Z-INDEX:%POS; }\n",id,x,y,cols*fontsize,rows*fontsize,z); - htrAddStylesheetItem_va(s," #term%POSreader { POSITION:absolute; VISIBILITY:hidden; LEFT:0; TOP:0; WIDTH:1; HEIGHT:1; Z-INDEX:-20; }\n",id); - htrAddStylesheetItem_va(s," #term%POSwriter { POSITION:absolute; VISIBILITY:hidden; LEFT:0; TOP:0; WIDTH:1; HEIGHT:1; Z-INDEX:-20; }\n",id); - htrAddStylesheetItem_va(s," .fixed%POS {font-family: fixed; }\n",id); + htrAddStylesheetItem_va(s, + "\t\t#term%POSbase { " + "position:absolute; " + "visibility:inherit; " + "left:%INTpx; " + "top:%INTpx; " + "width:%POSpx; " + "height:%POS; " + "z-index:%POS; " + "}\n", + id, x, y, + cols * fontsize, + rows * fontsize, + z + ); + htrAddStylesheetItem_va(s, "\t\t#term%POSreader { position:absolute; visibility:hidden; left:0px; top:0px; width:1px; height:1; z-index:-20; }\n", id); + htrAddStylesheetItem_va(s, "\t\t#term%POSwriter { position:absolute; visibility:hidden; left:0px; top:0px; width:1px; height:1; z-index:-20; }\n", id); + htrAddStylesheetItem_va(s, "\t\t.fixed%POS {font-family: fixed; }\n",id); /** init line **/ htrAddScriptInit_va(s," terminal_init({layer:wgtrGetNodeRef(ns,\"%STR&SYM\"), rdr:\"term%POSreader\", wtr:\"term%POSwriter\", fxd:\"fixed%POS\", source:'%STR&JSSTR', rows:%INT, cols:%INT, colors:new Array(", diff --git a/centrallix/htmlgen/htdrv_textarea.c b/centrallix/htmlgen/htdrv_textarea.c index bd10c2efb..66884fd5c 100644 --- a/centrallix/htmlgen/htdrv_textarea.c +++ b/centrallix/htmlgen/htdrv_textarea.c @@ -143,7 +143,6 @@ httxRender(pHtSession s, pWgtrNode tree, int z) x, y, w-2*box_offset, h-2*box_offset, z, "", (char*[]){"border_color","#e0e0e0", "border_style",(is_raised?"outset":"inset"), NULL}, "overflow:hidden; position:absolute;"); - //htrAddStylesheetItem_va(s,"\t#tx%POSbase { POSITION:absolute; VISIBILITY:inherit; LEFT:%INTpx; TOP:%INTpx; WIDTH:%POSpx; Z-INDEX:%INT; overflow:hidden; }\n",id,x,y,w-2*box_offset,z); /** DOM Linkage **/ htrAddWgtrObjLinkage_va(s, tree, "tx%POSbase",id); @@ -171,14 +170,6 @@ httxRender(pHtSession s, pWgtrNode tree, int z) /** HTML body
element for the base layer. **/ htrAddBodyItem_va(s, "
\n"); - htrAddEventHandlerFunction(s, "document", "MOUSEUP", "pg2", "pg_mouseup_ns4"); + mssError(0, "HTPAGE", "Failed to write JS ping init call."); + goto err; } + + /** Write event handling functions. **/ + if (htrAddEventHandlerFunction(s, "document", "CONTEXTMENU", "pg", "pg_contextmenu") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "KEYDOWN", "pg", "pg_keydown") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "KEYPRESS", "pg", "pg_keypress") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "KEYUP", "pg", "pg_keyup") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "MOUSEDOWN", "pg", "pg_mousedown") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "MOUSEMOVE", "pg", "pg_mousemove") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "MOUSEOUT", "pg", "pg_mouseout") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "MOUSEOVER", "pg", "pg_mouseover") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "MOUSEUP", "pg", "pg_mouseup") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "SCROLL", "pg", "pg_scroll") != 0) goto err; + /** Set colors for the focus layers **/ - htrAddScriptInit_va(s, + if (htrAddScriptInit_va(s, "\tpage.kbcolor1 = '%STR&JSSTR';\n" "\tpage.kbcolor2 = '%STR&JSSTR';\n" "\tpage.mscolor1 = '%STR&JSSTR';\n" @@ -470,41 +580,42 @@ htpageRender(pHtSession s, pWgtrNode tree, int z) kbfocus1, kbfocus2, msfocus1, msfocus2, dtfocus1, dtfocus2 - ); - - /** Write code to ensure cursor updating starts. **/ - htrAddScriptInit(s, "\tpg_togglecursor();\n"); - - /** Write event handling functions. **/ - htrAddEventHandlerFunction(s, "document", "KEYDOWN", "pg", "pg_keydown"); - htrAddEventHandlerFunction(s, "document", "KEYUP", "pg", "pg_keyup"); - htrAddEventHandlerFunction(s, "document", "KEYPRESS", "pg", "pg_keypress"); - - /** create the root node of the wgtr **/ - count = xaCount(&(tree->Children)); - for (i=0;iChildren),i), z+1); + mssError(0, "HTPAGE", "Failed to write JS to set focus box colors."); + goto err; } - /** keyboard input for NS4 **/ - if(s->Capabilities.Dom0NS) + /** Write code to ensure cursor updating starts. **/ + if (htrAddScriptInit(s, "\tpg_togglecursor();\n") != 0) { - htrAddScriptInit(s, - "\tsetTimeout(pg_mvpginpt, 1, document.layers.pginpt);\n" - "\tdocument.layers.pginpt.moveTo(window.innerWidth-2, 20);\n" - "\tdocument.layers.pginpt.visibility = 'inherit';\n" - "\tdocument.layers.pginpt.document.tmpform.x.focus();\n" - ); + mssError(0, "HTPAGE", "Failed to write JS call to start cursor updating."); + goto err; } - htrAddScriptInit(s, + /** Render children. **/ + if (htrRenderSubwidgets(s, tree, z) != 0) goto err; + + /** Write JS to signal that the page is done loading. **/ + if (htrAddScriptInit(s, "\tif(typeof(pg_status_close) === 'function') pg_status_close();\n" "\tpg_loadqueue_busy = false;\n" "\tpg_serialized_load_doone();\n" - ); + ) != 0) + { + mssError(0, "HTPAGE", "Failed to write JS to signal that loading is done."); + goto err; + } + /** Success. **/ return 0; + + err: + mssError(0, "HTPAGE", + "Failed to render \"%s\":\"%s\".", + tree->Name, tree->Type + ); + return -1; } /*** htpageInitialize - register with the ht_render module. diff --git a/centrallix/htmlgen/htdrv_pane.c b/centrallix/htmlgen/htdrv_pane.c index b74ee3a2a..7dd415891 100644 --- a/centrallix/htmlgen/htdrv_pane.c +++ b/centrallix/htmlgen/htdrv_pane.c @@ -59,7 +59,6 @@ htpnRender(pHtSession s, pWgtrNode tree, int z) char main_bg[128]; char bdr[64]; int x=-1,y=-1,w,h; - int id; int style = 1; /* 0 = lowered, 1 = raised, 2 = none, 3 = bordered */ char* c1; char* c2; @@ -68,15 +67,16 @@ htpnRender(pHtSession s, pWgtrNode tree, int z) int shadow_offset, shadow_radius; char shadow_color[128]; - if(!s->Capabilities.Dom0NS && !(s->Capabilities.Dom1HTML && s->Capabilities.CSS1)) + /** Get an id for this. **/ + const int id = (HTPN.idcnt++); + + /** Verify browser capabilities. **/ + if (!s->Capabilities.Dom1HTML || !s->Capabilities.Dom2CSS) { - mssError(1,"HTPN","Netscape DOM or W3C DOM1 HTML and CSS support required"); - return -1; + mssError(1, "HTPN", "Unsupported browser: W3C DOM1 HTML and DOM2 CSS support required."); + goto err; } - /** Get an id for this. **/ - id = (HTPN.idcnt++); - /** Get x,y,w,h of this object **/ if (wgtrGetPropertyValue(tree,"x",DATA_T_INTEGER,POD(&x)) != 0) x=0; if (wgtrGetPropertyValue(tree,"y",DATA_T_INTEGER,POD(&y)) != 0) y=0; @@ -123,9 +123,9 @@ htpnRender(pHtSession s, pWgtrNode tree, int z) if (wgtrGetPropertyValue(tree,"name",DATA_T_STRING,POD(&ptr)) != 0) return -1; strtcpy(name,ptr,sizeof(name)); - htrCheckAddExpression(s, tree, name, "enabled"); - htrCheckAddExpression(s, tree, name, "background"); - htrCheckAddExpression(s, tree, name, "bgcolor"); + if (htrCheckAddExpression(s, tree, name, "enabled") < 0) goto err; + if (htrCheckAddExpression(s, tree, name, "background") < 0) goto err; + if (htrCheckAddExpression(s, tree, name, "bgcolor") < 0) goto err; /** Style of pane - raised/lowered **/ if (wgtrGetPropertyValue(tree,"style",DATA_T_STRING,POD(&ptr)) == 0) @@ -161,7 +161,7 @@ htpnRender(pHtSession s, pWgtrNode tree, int z) else if (style == 0 || style == 1) /* lowered or raised */ { offset = -2 * box_offset; - htrAddStylesheetItem_va(s, + if (htrAddStylesheetItem_va(s, "\t\t#pn%POSmain {" "border-style: solid; " "border-width: 1px; " @@ -169,12 +169,19 @@ htpnRender(pHtSession s, pWgtrNode tree, int z) "}\n", id, c1, c2, c2, c1 - ); + ) != 0) + { + mssError(0, "HTPN", + "Failed to write %s pane CSS.", + (style == 0) ? "lowered" : "raised" + ); + goto err; + } } else if (style == 3) /* bordered */ { offset = -2 * box_offset; - htrAddStylesheetItem_va(s, + if (htrAddStylesheetItem_va(s, "\t\t#pn%POSmain {" "border-style: solid;" "border-width: 1px; " @@ -182,7 +189,11 @@ htpnRender(pHtSession s, pWgtrNode tree, int z) "}\n", id, bdr - ); + ) != 0) + { + mssError(0, "HTPN", "Failed to write bordered pane CSS."); + goto err; + } } /** Apply the offset to the width and height. **/ @@ -190,7 +201,7 @@ htpnRender(pHtSession s, pWgtrNode tree, int z) h += offset; /** Write the main CSS for the pane DOM node. **/ - htrAddStylesheetItem_va(s, + if (htrAddStylesheetItem_va(s, "\t\t#pn%POSmain {" "position:absolute; " "visibility:inherit; " @@ -211,53 +222,80 @@ htpnRender(pHtSession s, pWgtrNode tree, int z) z, border_radius, main_bg - ); + ) != 0) + { + mssError(0, "HTPN", "Failed to write main CSS."); + goto err; + } if (shadow_radius > 0) { - htrAddStylesheetItem_va(s, + if (htrAddStylesheetItem_va(s, "\t\t#pn%POSmain { " "box-shadow: %POSpx %POSpx %POSpx %STR&CSSVAL; " "}\n", id, shadow_offset, shadow_offset, shadow_radius, shadow_color - ); + ) != 0) + { + mssError(0, "HTPN", "Failed to write shadow CSS."); + goto err; + } } /** DOM linkages **/ - htrAddWgtrObjLinkage_va(s, tree, "pn%POSmain",id); + if (htrAddWgtrObjLinkage_va(s, tree, "pn%POSmain", id) != 0) goto err; /** Script include call **/ - htrAddScriptInclude(s, "/sys/js/htdrv_pane.js", 0); - htrAddScriptInclude(s, "/sys/js/ht_utils_layers.js", 0); + if (htrAddScriptInclude(s, "/sys/js/ht_utils_layers.js", 0) != 0) goto err; + if (htrAddScriptInclude(s, "/sys/js/htdrv_pane.js", 0) != 0) goto err; /** Event Handlers **/ - htrAddEventHandlerFunction(s, "document","MOUSEUP", "pn", "pn_mouseup"); - htrAddEventHandlerFunction(s, "document","MOUSEDOWN", "pn", "pn_mousedown"); - htrAddEventHandlerFunction(s, "document","MOUSEOVER", "pn", "pn_mouseover"); - htrAddEventHandlerFunction(s, "document","MOUSEOUT", "pn", "pn_mouseout"); - htrAddEventHandlerFunction(s, "document","MOUSEMOVE", "pn", "pn_mousemove"); + if (htrAddEventHandlerFunction(s, "document", "MOUSEDOWN", "pn", "pn_mousedown") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "MOUSEMOVE", "pn", "pn_mousemove") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "MOUSEOUT", "pn", "pn_mouseout") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "MOUSEOVER", "pn", "pn_mouseover") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "MOUSEUP", "pn", "pn_mouseup") != 0) goto err; /** Script initialization call. **/ - htrAddScriptInit_va(s, + if (htrAddScriptInit_va(s, "\tpn_init({" "mainlayer:wgtrGetNodeRef(ns, '%STR&SYM'), " "layer:wgtrGetNodeRef(ns, '%STR&SYM'), " "});\n", name, name - ); + ) != 0) + { + mssError(0, "HTPN", "Failed to write JS init call."); + goto err; + } /** HTML body
element for the base layer. **/ - //htrAddBodyItem_va(s,"
\n",id, w-2, h-2); - htrAddBodyItem_va(s,"
\n", id); + if (htrAddBodyItem_va(s,"
\n", id) != 0) + { + mssError(0, "HTPN", "Failed to write HTML opening tag."); + goto err; + } + + /** Render children. **/ + if (htrRenderSubwidgets(s, tree, z + 1) != 0) goto err; - /** Check for objects within the pane. **/ - htrRenderSubwidgets(s, tree, z+2); + /** Write the end of the container. **/ + if (htrAddBodyItem(s, "
\n") != 0) + { + mssError(0, "HTPN", "Failed to write HTML closing tag."); + goto err; + } - /** End the containing layer. **/ - htrAddBodyItem(s, "
\n"); + /** Success. **/ + return 0; - return 0; + err: + mssError(0, "HTPN", + "Failed to render \"%s\":\"%s\" (id: %d).", + tree->Name, tree->Type, id + ); + return -1; } diff --git a/centrallix/htmlgen/htdrv_parameter.c b/centrallix/htmlgen/htdrv_parameter.c index 09b3fd484..71ef58222 100644 --- a/centrallix/htmlgen/htdrv_parameter.c +++ b/centrallix/htmlgen/htdrv_parameter.c @@ -1,9 +1,11 @@ +#include #include #include #include #include #include "ht_render.h" #include "obj.h" +#include "cxlib/util.h" #include "cxlib/mtask.h" #include "cxlib/xarray.h" #include "cxlib/xhash.h" @@ -55,29 +57,31 @@ htparamRender(pHtSession s, pWgtrNode tree, int z) char paramname[64]; char type[32]; char findcontainer[64]; - int i; - XString xs; - pObjPresentationHints hints; pStruct find_inf; int deploy_to_client; - if(!s->Capabilities.Dom0NS && !s->Capabilities.Dom1HTML ) + /** Verify browser capabilities. **/ + if (!s->Capabilities.Dom1HTML || !s->Capabilities.Dom2CSS) { - mssError(1,"HTPARAM","Netscape DOM or W3C DOM1HTML support required"); - return -1; + mssError(1, "HTPARAM", "Unsupported browser: W3C DOM1 HTML and DOM2 CSS support required."); + goto err; } /** Get name and type **/ if (wgtrGetPropertyValue(tree,"name",DATA_T_STRING,POD(&ptr)) != 0) - return -1; + { + mssError(1, "HTPARAM", "Failed to get name."); + goto err; + } strtcpy(name,ptr,sizeof(name)); if (wgtrGetPropertyValue(tree,"type",DATA_T_STRING,POD(&ptr)) != 0) ptr = "string"; strtcpy(type,ptr,sizeof(type)); - if (objTypeID(type) < 0 && strcmp(type,"object")) + const int datatype = objTypeID(type); + if (datatype < 0 && strcmp(type, "object") != 0) { - mssError(1,"HTPARAM","Invalid parameter data type for '%s'", name); - return -1; + mssError(1, "HTPARAM", "Invalid datatype %d.", datatype); + goto err; } /** Specify name of param (in case param widget name isn't the desired param name) **/ @@ -96,8 +100,8 @@ htparamRender(pHtSession s, pWgtrNode tree, int z) findcontainer[0] = '\0'; /** JavaScript include file **/ - htrAddScriptInclude(s, "/sys/js/htdrv_parameter.js", 0); - htrAddScriptInclude(s, "/sys/js/ht_utils_hints.js", 0); + if (htrAddScriptInclude(s, "/sys/js/ht_utils_hints.js", 0) != 0) goto err; + if (htrAddScriptInclude(s, "/sys/js/htdrv_parameter.js", 0) != 0) goto err; /** Value supplied? **/ if (deploy_to_client) @@ -109,8 +113,12 @@ htparamRender(pHtSession s, pWgtrNode tree, int z) const int has_find_inf = (find_inf != NULL && find_inf->StrVal != NULL && find_inf->StrVal[0] != '\0'); if (deploy_to_client) { + bool successful = false; + XString xs = { AllocLen: 0 }; + pObjPresentationHints hints = NULL; + /** Script init **/ - htrAddScriptInit_va(s, + if (htrAddScriptInit_va(s, "\tpa_init(wgtrGetNodeRef(ns, '%STR&SYM'), { " "name:'%STR&JSSTR', " "type:'%STR&JSSTR', " @@ -119,37 +127,77 @@ htparamRender(pHtSession s, pWgtrNode tree, int z) "});\n", name, paramname, type, findcontainer, (has_find_inf), (has_find_inf) ? find_inf->StrVal : "null", (!has_find_inf) - ); + ) != 0) + { + mssError(0, "HTPARAM", "Failed to write JS init call."); + goto err_deploy; + } + /** Get presentation hints. **/ hints = wgtrWgtToHints(tree); - if (!hints) + if (hints == NULL) { - mssError(0, "HTPARAM", "Error in parameter data"); - return -1; + mssError(0, "HTPARAM", "Failed to get presentation hints."); + goto err_deploy; } - xsInit(&xs); - hntEncodeHints(hints, &xs); - htrAddScriptInit_va(s, + + /** Write presentation hints. **/ + if (check(xsInit(&xs)) != 0) goto err_deploy; + if (hntEncodeHints(hints, &xs) < 0) + { + mssError(0, "HTPARAM", "Failed to encode presentation hints."); + goto err_deploy; + } + if (htrAddScriptInit_va(s, "\tcx_set_hints(wgtrGetNodeRef(ns, '%STR&SYM'), '%STR&JSSTR', 'app');\n", name, xs.String - ); - xsDeInit(&xs); - objFreeHints(hints); + ) != 0) + { + mssError(0, "HTPARAM", "Failed to write JS for presentation hints."); + goto err_deploy; + } - htrAddScriptInit_va(s, "\twgtrGetNodeRef(ns, '%STR&SYM').Verify();\n", name); + if (htrAddScriptInit_va(s, "\twgtrGetNodeRef(ns, '%STR&SYM').Verify();\n", name) != 0) + { + mssError(0, "HTPARAM", "Failed to write JS to verify presentation hints."); + goto err_deploy; + } + + /** Success. **/ + successful = true; + + err_deploy: + /** Clean up. **/ + if (check(xsDeInit(&xs)) != 0) goto err_deploy; + if (objFreeHints(hints) != 0) + { + mssError(0, "HTPARAM", "Failed to free presentation hints."); + goto err_deploy; + } + + /** Handle errors. **/ + if (!successful) goto err; } else { tree->RenderFlags |= HT_WGTF_NORENDER; } + /** Nonvisual widget. **/ tree->RenderFlags |= HT_WGTF_NOOBJECT; - /** Check for more sub-widgets within the param **/ - for (i=0;iChildren));i++) - htrRenderWidget(s, xaGetItem(&(tree->Children), i), z+1); - - return 0; + /** Render children. **/ + if (htrRenderSubwidgets(s, tree, z + 1) != 0) goto err; + + /** Success. **/ + return 0; + + err: + mssError(0, "HTPARAM", + "Failed to render \"%s\":\"%s\".", + tree->Name, tree->Type + ); + return -1; } diff --git a/centrallix/htmlgen/htdrv_radiobutton.c b/centrallix/htmlgen/htdrv_radiobutton.c index ad7d6c664..b84adc5c7 100644 --- a/centrallix/htmlgen/htdrv_radiobutton.c +++ b/centrallix/htmlgen/htdrv_radiobutton.c @@ -1,3 +1,4 @@ +#include #include #include #include @@ -54,18 +55,20 @@ static struct /** htrbRender - generate the HTML code for the page. **/ int htrbRender(pHtSession s, pWgtrNode tree, int z) { + int rval = -1; char* ptr; - - /** Verify required capabilities. **/ - if (!s->Capabilities.Dom0NS && !s->Capabilities.Dom1HTML) - { - mssError(1, "HTRB", "Netscape 4.x or W3C DOM support required"); - return -1; - } + XArray radio_buttons = { nAlloc: 0}; /** Get an id for this widget. **/ const int id = (HTRB.idcnt++); + /** Verify browser capabilities. **/ + if (!s->Capabilities.Dom1HTML || !s->Capabilities.Dom2CSS) + { + mssError(1, "HTRB", "Unsupported browser: W3C DOM1 HTML and DOM2 CSS support required."); + goto end_free; + } + /** Get x,y,w,h of this object. **/ int x, y, w, h, spacing; if (wgtrGetPropertyValue(tree, "x", DATA_T_INTEGER, POD(&x)) != 0) x = 0; @@ -73,12 +76,12 @@ int htrbRender(pHtSession s, pWgtrNode tree, int z) if (wgtrGetPropertyValue(tree, "width", DATA_T_INTEGER, POD(&w)) != 0) { mssError(1,"HTRB","RadioButtonPanel widget must have a 'width' property"); - return -1; + goto end_free; } if (wgtrGetPropertyValue(tree, "height", DATA_T_INTEGER, POD(&h)) != 0) { mssError(1,"HTRB","RadioButtonPanel widget must have a 'height' property"); - return -1; + goto end_free; } if (wgtrGetPropertyValue(tree, "spacing", DATA_T_INTEGER, POD(&spacing)) != 0) spacing = 10; @@ -87,13 +90,13 @@ int htrbRender(pHtSession s, pWgtrNode tree, int z) if (wgtrGetPropertyValue(tree, "name", DATA_T_STRING, POD(&ptr)) != 0) { mssError(1, "HTRB", "RadioButtonPanel widget must have a 'name' property"); - return -1; + goto end_free; } strtcpy(name, ptr, sizeof(name)); if (wgtrGetPropertyValue(tree, "title", DATA_T_STRING, POD(&ptr)) != 0) { mssError(1, "HTRB", "RadioButtonPanel widget must have a 'title' property"); - return -1; + goto end_free; } strtcpy(title, ptr, sizeof(title)); @@ -107,14 +110,14 @@ int htrbRender(pHtSession s, pWgtrNode tree, int z) /** Get background attributes. **/ char main_background[128] = ""; char outline_background[128] = ""; - htrGetBackground(tree, NULL, !s->Capabilities.Dom0NS, main_background, sizeof(main_background)); - htrGetBackground(tree, "outline", !s->Capabilities.Dom0NS, outline_background, sizeof(outline_background)); + if (htrGetBackground(tree, NULL, true, main_background, sizeof(main_background)) != 0) goto end_free; + if (htrGetBackground(tree, "outline", true, outline_background, sizeof(outline_background)) != 0) goto end_free; /** User requesting expression for selected tab? **/ - htrCheckAddExpression(s, tree, name, "value"); + if (htrCheckAddExpression(s, tree, name, "value") < 0) goto end_free; /** User requesting expression for selected tab using integer index value? **/ - htrCheckAddExpression(s, tree, name, "value_index"); + if (htrCheckAddExpression(s, tree, name, "value_index") < 0) goto end_free; /** Get fieldname and form attributes. **/ char fieldname[32] = "", form[64] = ""; @@ -125,17 +128,17 @@ int htrbRender(pHtSession s, pWgtrNode tree, int z) /** Include scripts. **/ - htrAddScriptInclude(s, "/sys/js/htdrv_radiobutton.js", 0); - htrAddScriptInclude(s, "/sys/js/ht_utils_layers.js", 0); + if (htrAddScriptInclude(s, "/sys/js/ht_utils_layers.js", 0) != 0) goto end_free; + if (htrAddScriptInclude(s, "/sys/js/htdrv_radiobutton.js", 0) != 0) goto end_free; /** Link DOM node to widget data. **/ - htrAddWgtrObjLinkage_va(s, tree, "rb%POSparent", id); - htrAddWgtrCtrLinkage_va(s, tree, "htr_subel(htr_subel(_obj, 'rb%POSborder'), 'rb%POScover')", id, id); + if (htrAddWgtrObjLinkage_va(s, tree, "rb%POSparent", id) != 0) goto end_free; + if (htrAddWgtrCtrLinkage_va(s, tree, "htr_subel(htr_subel(_obj, 'rb%POSborder'), 'rb%POScover')", id, id) != 0) goto end_free; /** Script initialization call. **/ if (strlen(main_background) > 0) { - htrAddScriptInit_va(s, "\t{ " + if (htrAddScriptInit_va(s, "\t{ " "const parentPane = wgtrGetNodeRef(ns, '%STR&SYM'); " "const borderPane = htr_subel(parentPane, 'rb%POSborder'); " "const coverPane = htr_subel(borderPane, 'rb%POScover'); " @@ -153,11 +156,15 @@ int htrbRender(pHtSession s, pWgtrNode tree, int z) main_background, outline_background, form - ); + ) != 0) + { + mssError(0, "HTRB", "Failed to write JS init code."); + goto end_free; + } } else { - htrAddScriptInit_va(s, + if (htrAddScriptInit_va(s, "\tradiobuttonpanel_init({ " "parentPane:wgtrGetNodeRef(ns, '%STR&SYM'), " "fieldname:'%STR&JSSTR', " @@ -171,24 +178,37 @@ int htrbRender(pHtSession s, pWgtrNode tree, int z) name, fieldname, form - ); + ) != 0) + { + mssError(0, "HTRB", "Failed to write JS init call."); + goto end_free; + } } /** Add event listenners. **/ - htrAddEventHandlerFunction(s, "document", "MOUSEUP", "radiobutton", "radiobutton_mouseup"); - htrAddEventHandlerFunction(s, "document", "MOUSEDOWN", "radiobutton", "radiobutton_mousedown"); - htrAddEventHandlerFunction(s, "document", "MOUSEOVER", "radiobutton", "radiobutton_mouseover"); - htrAddEventHandlerFunction(s, "document", "MOUSEMOVE", "radiobutton", "radiobutton_mousemove"); + if (htrAddEventHandlerFunction(s, "document", "MOUSEDOWN", "radiobutton", "radiobutton_mousedown") != 0) goto end_free; + if (htrAddEventHandlerFunction(s, "document", "MOUSEMOVE", "radiobutton", "radiobutton_mousemove") != 0) goto end_free; + if (htrAddEventHandlerFunction(s, "document", "MOUSEOVER", "radiobutton", "radiobutton_mouseover") != 0) goto end_free; + if (htrAddEventHandlerFunction(s, "document", "MOUSEUP", "radiobutton", "radiobutton_mouseup") != 0) goto end_free; /** Write style headers for container DOM nodes. **/ const int para_height = s->ClientInfo->ParagraphHeight; const int top_offset = (para_height * 3) / 4 + 1; - htrAddStylesheetItem_va(s, - "\t\t#rb%POSparent { " + if (htrAddStylesheetItem_va(s, + "\t\t.rb%POSall { " "position:absolute; " "visibility:inherit; " "overflow:hidden; " + "}\n", + id, id, id, id + ) != 0) + { + mssError(0, "HTRB", "Failed to write shared CSS."); + goto end_free; + } + if (htrAddStylesheetItem_va(s, + "\t\t#rb%POSparent { " "cursor:default; " "left:"ht_flex_format"; " "top:"ht_flex_format"; " @@ -202,12 +222,13 @@ int htrbRender(pHtSession s, pWgtrNode tree, int z) ht_flex_w(w, tree), ht_flex_h(h, tree), z - ); - htrAddStylesheetItem_va(s, + ) != 0) + { + mssError(0, "HTRB", "Failed to write parent (container) CSS."); + goto end_free; + } + if (htrAddStylesheetItem_va(s, "\t\t#rb%POSborder { " - "position:absolute; " - "visibility:inherit; " - "overflow:hidden; " "left:3px; " "top:%POSpx; " "width:calc(100%% - 6px); " @@ -218,12 +239,13 @@ int htrbRender(pHtSession s, pWgtrNode tree, int z) top_offset, top_offset + 3, z + 1 - ); - htrAddStylesheetItem_va(s, + ) != 0) + { + mssError(0, "HTRB", "Failed to write border CSS."); + goto end_free; + } + if (htrAddStylesheetItem_va(s, "\t\t#rb%POScover { " - "position:absolute; " - "visibility:inherit; " - "overflow:hidden; " "left:1px; " "top:1px; " "width:calc(100%% - 2px); " @@ -232,12 +254,13 @@ int htrbRender(pHtSession s, pWgtrNode tree, int z) "}\n", id, z + 2 - ); - htrAddStylesheetItem_va(s, + ) != 0) + { + mssError(0, "HTRB", "Failed to write cover CSS."); + goto end_free; + } + if (htrAddStylesheetItem_va(s, "\t\t#rb%POStitle { " - "position:absolute; " - "visibility:inherit; " - "overflow:hidden; " "left:10px; " "top:1px; " "width:50%%; " @@ -247,28 +270,46 @@ int htrbRender(pHtSession s, pWgtrNode tree, int z) id, para_height, z + 3 - ); + ) != 0) + { + mssError(0, "HTRB", "Failed to write title CSS."); + goto end_free; + } /** Write HTML to contain the radio buttons. **/ - htrAddBodyItem_va(s, "
\n", id); - htrAddBodyItem_va(s, "
\n", id); - htrAddBodyItem_va(s, "
\n", id); + if (htrAddBodyItem_va(s, + "
" + "
" + "
\n", + id, id, id, id, id, id + ) != 0) + { + mssError(0, "HTRB", "Failed to write HTML for containers."); + goto end_free; + } /** Search child array for radio buttons. **/ - XArray radio_buttons; - xaInit(&radio_buttons, tree->Children.nItems); + if (check(xaInit(&radio_buttons, tree->Children.nItems)) != 0) goto end_free; for (int i = 0; i < tree->Children.nItems; i++) { - pWgtrNode child = tree->Children.Items[i]; + pWgtrNode child = check_ptr(tree->Children.Items[i]); + if (child == NULL) + { + mssError(1, "HTRB", "Child widget #%d/%d is NULL.", i + 1, tree->Children.nItems); + goto end_free; + } /** Mark child as no-object. **/ child->RenderFlags |= HT_WGTF_NOOBJECT; /** Add radio buttons to the array, render other widgets immediately (so we can forget about them). **/ wgtrGetPropertyValue(child, "outer_type", DATA_T_STRING, POD(&ptr)); - if (strcmp(ptr, "widget/radiobutton") == 0) xaAddItem(&radio_buttons, child); - else htrRenderWidget(s, child, z + 1); + if (strcmp(ptr, "widget/radiobutton") == 0) + { + if (check_neg(xaAddItem(&radio_buttons, child)) < 0) goto end_free; + } + else if (htrRenderWidget(s, child, z + 1) != 0) goto end_free; } /** Write style for radio buttons. **/ @@ -294,10 +335,10 @@ int htrbRender(pHtSession s, pWgtrNode tree, int z) char* label = (label_buf[0] == '\0') ? value_buf : label_buf; /** Link the radio button DOM node to widget data. **/ - htrAddWgtrObjLinkage_va(s, radio_button, "rb%POSoption%POS", id, i); + if (htrAddWgtrObjLinkage_va(s, radio_button, "rb%POSoption%POS", id, i) != 0) goto err_option; /** Write the initialization call. **/ - htrAddScriptInit_va(s, "\t{ " + if (htrAddScriptInit_va(s, "\t{ " "const rbitem = wgtrGetNodeRef('%STR&SYM', '%STR&SYM');" "add_radiobutton(rbitem, { " "selected:%POS, " @@ -313,17 +354,18 @@ int htrbRender(pHtSession s, pWgtrNode tree, int z) id, i, id, i, id, i, id, i, value, label - ); + ) != 0) + { + mssError(0, "HTRB", "Failed to write JS add_radiobutton() call."); + goto err_option; + } /** Write CSS for the radio button container. **/ const int base_top = top_padding + (button_height * i); const double percent_space_above = (100.0 / radio_buttons.nItems) * i; const double content_above = ((double)content_height / radio_buttons.nItems) * i; - htrAddStylesheetItem_va(s, + if (htrAddStylesheetItem_va(s, "\t\t#rb%POSoption%POS { " - "position:absolute; " - "visibility:inherit; " - "overflow:hidden; " "left:7px; " "top:calc(0px " "+ %POSpx " @@ -338,10 +380,14 @@ int htrbRender(pHtSession s, pWgtrNode tree, int z) percent_space_above, content_above, spacing * i, button_height, z + 2 - ); + ) != 0) + { + mssError(0, "HTRB", "Failed to write option CSS."); + goto err_option; + } /** Write CSS for the radio button elements. **/ - htrAddStylesheetItem_va(s, + if (htrAddStylesheetItem_va(s, "\t\t#rb%POSbuttonset%POS, " "#rb%POSbuttonunset%POS { " "position:absolute; " @@ -357,8 +403,12 @@ int htrbRender(pHtSession s, pWgtrNode tree, int z) id, i, (para_height / 2) - 3, z + 2 - ); - htrAddStylesheetItem_va(s, + ) != 0) + { + mssError(0, "HTRB", "Failed to write option set CSS."); + goto err_option; + } + if (htrAddStylesheetItem_va(s, "\t\t#rb%POSvalue%POS { " "position:absolute; " "visibility:hidden; " @@ -371,8 +421,12 @@ int htrbRender(pHtSession s, pWgtrNode tree, int z) "}\n", id, i, z + 2 - ); - htrAddStylesheetItem_va(s, + ) != 0) + { + mssError(0, "HTRB", "Failed to write option value CSS."); + goto err_option; + } + if (htrAddStylesheetItem_va(s, "\t\t#rb%POSlabel%POS { " "position:absolute; " "visibility:inherit; " @@ -386,26 +440,68 @@ int htrbRender(pHtSession s, pWgtrNode tree, int z) "}\n", id, i, z + 2 - ); + ) != 0) + { + mssError(0, "HTRB", "Failed to write option label CSS."); + goto err_option; + } /** Write radio button HTML. **/ - htrAddBodyItem_va(s, "
\n", id, i); - htrAddBodyItem_va(s, " \n", id, i); - htrAddBodyItem_va(s, "
\n", id, i); - htrAddBodyItem_va(s, "
%STR&HTE
\n", id, i, textcolor, label); - htrAddBodyItem_va(s, " \n", id, i, value); - htrAddBodyItem (s, "
\n"); + if (htrAddBodyItem_va(s, + "
\n" + " \n" + "
\n" + "
%STR&HTE
\n" + " \n" + "
\n", + id, i, id, + id, i, + id, i, + id, i, textcolor, label, + id, i, value + ) != 0) + { + mssError(0, "HTRB", "Failed to write option HTML."); + goto err_option; + } + + /** Success. **/ + continue; + + err_option: + mssError(0, "HTRB", "Failed to write option #%d/%d.", i + 1, radio_buttons.nItems); + goto end_free; } - htrAddBodyItem_va(s, - "
\n" - "
\n" - "
%STR&HTE
\n" + /** Close divs and write title. **/ + if (htrAddBodyItem_va(s, + "
\n" + "
%STR&HTE
\n" "
\n", id, textcolor, title - ); + ) != 0) + { + mssError(0, "HTRB", "Failed to write title and closing HTML tags."); + goto end_free; + } + + /** Success. **/ + rval = 0; + + end_free: + if (rval != 0) + { + mssError(0, "HTRB", + "Failed to render \"%s\":\"%s\" (id: %d).", + tree->Name, tree->Type, id + ); + return -1; + } + + /** Clean up. **/ + if (radio_buttons.nAlloc != 0) xaDeInit(&radio_buttons); - return 0; + return rval; } diff --git a/centrallix/htmlgen/htdrv_repeat.c b/centrallix/htmlgen/htdrv_repeat.c index b4943abc3..170a3edac 100644 --- a/centrallix/htmlgen/htdrv_repeat.c +++ b/centrallix/htmlgen/htdrv_repeat.c @@ -54,10 +54,18 @@ int htrptRender(pHtSession s, pWgtrNode tree, int z) { /** Render Subwidgets **/ - htrAddWgtrCtrLinkage(s, tree, "_parentctr"); - htrRenderSubwidgets(s,tree,z); + if (htrAddWgtrCtrLinkage(s, tree, "_parentctr") != 0) goto err; + if (htrRenderSubwidgets(s, tree, z) != 0) goto err; - return 0; + /** Success. **/ + return 0; + + err: + mssError(0, "HTRPT", + "Failed to render \"%s\":\"%s\".", + tree->Name, tree->Type + ); + return -1; } int diff --git a/centrallix/htmlgen/htdrv_scrollbar.c b/centrallix/htmlgen/htdrv_scrollbar.c index a56f794b1..743862275 100644 --- a/centrallix/htmlgen/htdrv_scrollbar.c +++ b/centrallix/htmlgen/htdrv_scrollbar.c @@ -58,22 +58,22 @@ htsbRender(pHtSession s, pWgtrNode tree, int z) char* ptr; char name[64]; int x,y,w,h,r; - int id, i, t; int visible = 1; char bcolor[64] = ""; char bimage[64] = ""; int is_horizontal = 0; pExpression code; - if(!s->Capabilities.Dom0NS && !s->Capabilities.Dom0IE && !s->Capabilities.Dom1HTML) + /** Get an id for this. **/ + const int id = (HTSB.idcnt++); + + /** Verify browser capabilities. **/ + if (!s->Capabilities.Dom1HTML || !s->Capabilities.Dom2CSS) { - mssError(1,"HTSB","Netscape 4.x, IE, or W3C DOM support required"); - return -1; + mssError(1, "HTSB", "Unsupported browser: W3C DOM1 HTML and DOM2 CSS support required."); + goto err; } - /** Get an id for this. **/ - id = (HTSB.idcnt++); - /** Which direction? **/ if (wgtrGetPropertyValue(tree,"direction",DATA_T_STRING,POD(&ptr)) == 0) { @@ -85,19 +85,19 @@ htsbRender(pHtSession s, pWgtrNode tree, int z) if (wgtrGetPropertyValue(tree,"x",DATA_T_INTEGER,POD(&x)) != 0) { mssError(1,"HTSB","Scrollbar widget must have an 'x' property"); - return -1; + goto err; } if (wgtrGetPropertyValue(tree,"y",DATA_T_INTEGER,POD(&y)) != 0) { mssError(1,"HTSB","Scrollbar widget must have a 'y' property"); - return -1; + goto err; } if (wgtrGetPropertyValue(tree,"width",DATA_T_INTEGER,POD(&w)) != 0) { if (is_horizontal) { mssError(1,"HTSB","Horizontal scrollbar widgets must have a 'width' property"); - return -1; + goto err; } else { @@ -107,14 +107,14 @@ htsbRender(pHtSession s, pWgtrNode tree, int z) if (is_horizontal && w <= 18*3) { mssError(1,"HTSB","Horizontal scrollbar width must be greater than %d", 18*3); - return -1; + goto err; } if (wgtrGetPropertyValue(tree,"height",DATA_T_INTEGER,POD(&h)) != 0) { if (!is_horizontal) { mssError(1,"HTSB","Vertical scrollbar widgets must have a 'height' property"); - return -1; + goto err; } else { @@ -124,11 +124,15 @@ htsbRender(pHtSession s, pWgtrNode tree, int z) if (!is_horizontal && h <= 18*3) { mssError(1,"HTSB","Vertical scrollbar height must be greater than %d", 18*3); - return -1; + goto err; } /** Get name **/ - if (wgtrGetPropertyValue(tree,"name",DATA_T_STRING,POD(&ptr)) != 0) return -1; + if (wgtrGetPropertyValue(tree, "name", DATA_T_STRING, POD(&ptr)) != 0) + { + mssError(1, "HTSB", "Failed to get widget name."); + goto err; + } strtcpy(name,ptr,sizeof(name)); /** Range of scrollbar (static or dynamic property) **/ @@ -136,6 +140,7 @@ htsbRender(pHtSession s, pWgtrNode tree, int z) r = w; else r = h; + int t; if ((t = wgtrGetPropertyType(tree,"range")) == DATA_T_INTEGER) { wgtrGetPropertyValue(tree,"range",DATA_T_INTEGER,POD(&r)); @@ -163,7 +168,7 @@ htsbRender(pHtSession s, pWgtrNode tree, int z) } /** Ok, write the style header items. **/ - htrAddStylesheetItem_va(s, + if (htrAddStylesheetItem_va(s, "\t\t#sb%POSpane { " "position:absolute; " "visibility:%STR; " @@ -178,52 +183,45 @@ htsbRender(pHtSession s, pWgtrNode tree, int z) (visible) ? "inherit" : "hidden", x, y, w, h, z - ); - if (is_horizontal) - htrAddStylesheetItem_va(s, - "\t\t#sb%POSthum { " - "position:absolute; " - "visibility:inherit; " - "left:18px; " - "top:0px; " - "width:18px; " - "z-index:%POS; " - "}\n", - id, - z + 1 - ); - else - htrAddStylesheetItem_va(s, - "\t\t#sb%POSthum { " - "position:absolute; " - "visibility:inherit; " - "left:0px; " - "top:18px; " - "width:18px; " - "z-index:%POS; " - "}\n", - id, - z + 1 - ); - - /** Write globals for internal use **/ - htrAddScriptGlobal(s, "sb_target_img", "null", 0); - htrAddScriptGlobal(s, "sb_click_x","0",0); - htrAddScriptGlobal(s, "sb_click_y","0",0); - htrAddScriptGlobal(s, "sb_thum_x","0",0); - htrAddScriptGlobal(s, "sb_thum_y","0",0); - htrAddScriptGlobal(s, "sb_mv_timeout","null",0); - htrAddScriptGlobal(s, "sb_mv_incr","0",0); - htrAddScriptGlobal(s, "sb_cur_mainlayer","null",0); - - /** DOM Linkage **/ - htrAddWgtrObjLinkage_va(s, tree, "sb%POSpane",id); - - htrAddScriptInclude(s, "/sys/js/htdrv_scrollbar.js", 0); - htrAddScriptInclude(s, "/sys/js/ht_utils_string.js", 0); + ) != 0) + { + mssError(0, "HTSB", "Failed to write scrollbar pane CSS."); + goto err; + } + if (htrAddStylesheetItem_va(s, + "\t\t#sb%POSthum { " + "position:absolute; " + "visibility:inherit; " + "left:%POSpx; " + "top:%POSpx; " + "width:18px; " + "z-index:%POS; " + "}\n", + id, + (is_horizontal) ? 18 : 0, + (is_horizontal) ? 0 : 18, + z + 1 + ) != 0) + { + mssError(0, "HTSB", "Failed to write scrollbar thumb CSS."); + goto err; + } + + /** Write JS globals, linking, includes, etc. **/ + if (htrAddScriptGlobal(s, "sb_click_x","0", 0) != 0) goto err; + if (htrAddScriptGlobal(s, "sb_click_y","0", 0) != 0) goto err; + if (htrAddScriptGlobal(s, "sb_cur_mainlayer","null", 0) != 0) goto err; + if (htrAddScriptGlobal(s, "sb_mv_incr","0", 0) != 0) goto err; + if (htrAddScriptGlobal(s, "sb_mv_timeout","null", 0) != 0) goto err; + if (htrAddScriptGlobal(s, "sb_target_img", "null", 0) != 0) goto err; + if (htrAddScriptGlobal(s, "sb_thum_x","0", 0) != 0) goto err; + if (htrAddScriptGlobal(s, "sb_thum_y","0", 0) != 0) goto err; + if (htrAddWgtrObjLinkage_va(s, tree, "sb%POSpane", id) != 0) goto err; + if (htrAddScriptInclude(s, "/sys/js/ht_utils_string.js", 0) != 0) goto err; + if (htrAddScriptInclude(s, "/sys/js/htdrv_scrollbar.js", 0) != 0) goto err; /** Script initialization call. **/ - htrAddScriptInit_va(s, + if (htrAddScriptInit_va(s, "\tsb_init({ " "layer:wgtrGetNodeRef(ns, '%STR&SYM'), " "tname:'sb%POSthum', " @@ -231,7 +229,11 @@ htsbRender(pHtSession s, pWgtrNode tree, int z) "range:%INT, " "});\n", name, id, is_horizontal, r - ); + ) != 0) + { + mssError(0, "HTSB", "Failed to write JS init call."); + goto err; + } /** HTML body
elements for the layers. **/ htrAddBodyItem_va(s,"
", id, *bcolor, bcolor, *bimage, bimage, w); @@ -251,19 +253,30 @@ htsbRender(pHtSession s, pWgtrNode tree, int z) /** Add the event handling scripts **/ - htrAddEventHandlerFunction(s, "document","MOUSEDOWN","sb","sb_mousedown"); - htrAddEventHandlerFunction(s, "document","MOUSEMOVE","sb","sb_mousemove"); - htrAddEventHandlerFunction(s, "document","MOUSEUP","sb","sb_mouseup"); - htrAddEventHandlerFunction(s, "document", "MOUSEOVER", "sb","sb_mouseover"); + if (htrAddEventHandlerFunction(s, "document", "MOUSEOVER", "sb", "sb_mouseover") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "MOUSEDOWN", "sb", "sb_mousedown") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "MOUSEMOVE", "sb", "sb_mousemove") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "MOUSEUP", "sb", "sb_mouseup") != 0) goto err; + + /** Render children. **/ + if (htrRenderSubwidgets(s, tree, z + 2) != 0) goto err; - /** Check for more sub-widgets within the scrollbar (visual ones not allowed). **/ - for (i=0;iChildren));i++) - htrRenderWidget(s, xaGetItem(&(tree->Children), i), z+2); + /** Write the closing HTML
tag. **/ + if (htrAddBodyItem(s, "
\n") != 0) + { + mssError(0, "HTSB", "Failed to write HTML closing tag."); + goto err; + } - /** Finish off the last
**/ - htrAddBodyItem(s,"
\n"); + /** Success. **/ + return 0; - return 0; + err: + mssError(0, "HTSB", + "Failed to render \"%s\":\"%s\" (id: %d).", + tree->Name, tree->Type, id + ); + return -1; } diff --git a/centrallix/htmlgen/htdrv_scrollpane.c b/centrallix/htmlgen/htdrv_scrollpane.c index b134f109b..413e8fd64 100644 --- a/centrallix/htmlgen/htdrv_scrollpane.c +++ b/centrallix/htmlgen/htdrv_scrollpane.c @@ -58,16 +58,17 @@ int htspaneRender(pHtSession s, pWgtrNode tree, int z) { char* str; - - if (!(s->Capabilities.Dom1HTML && s->Capabilities.Dom2CSS) && !s->Capabilities.Dom0NS && !s->Capabilities.Dom0IE) - { - mssError(1, "HTSPANE", "Unsupported browser: W3C DOM1 HTML and DOM2 CSS or IE DOM or Netscape DOM required."); - goto err; - } /** Get an id for this scrollpane. **/ const int id = (HTSPANE.idcnt++); + /** Verify browser capabilities. **/ + if (!s->Capabilities.Dom1HTML || !s->Capabilities.Dom2CSS) + { + mssError(1, "HTSPANE", "Unsupported browser: W3C DOM1 HTML and DOM2 CSS support required."); + goto err; + } + /** Get name. **/ char name[64]; if (wgtrGetPropertyValue(tree, "name", DATA_T_STRING, POD(&str)) != 0) @@ -116,286 +117,211 @@ htspaneRender(pHtSession s, pWgtrNode tree, int z) const int visible = htrGetBoolean(tree, "visible", 1); if (visible == -1) goto err; - /** DOM Linkages. **/ - htrAddWgtrCtrLinkage_va(s, tree, "htr_subel(_obj, \"sp%POSarea\")",id); - htrAddWgtrObjLinkage_va(s, tree, "sp%POSpane",id); + /** Link the widget and container to DOM nodes. **/ + if (htrAddWgtrCtrLinkage_va(s, tree, "htr_subel(_obj, 'sp%POSarea')", id) != 0) + { + mssError(0, "HTSPANE", "Failed to add container linkage."); + goto err; + } + if (htrAddWgtrObjLinkage_va(s, tree, "sp%POSpane", id) != 0) + { + mssError(0, "HTSPANE", "Failed to add object linkage."); + goto err; + } /** Include scrollpane script and its dependencies. **/ - htrAddScriptInclude(s, "/sys/js/htdrv_scrollpane.js", 0); - htrAddScriptInclude(s, "/sys/js/ht_utils_string.js", 0); + if (htrAddScriptInclude(s, "/sys/js/ht_utils_string.js", 0) != 0) goto err; + if (htrAddScriptInclude(s, "/sys/js/htdrv_scrollpane.js", 0) != 0) goto err; + + /** Add the event handling scripts **/ + if (htrAddEventHandlerFunction(s, "document", "MOUSEDOWN", "sp", "sp_mousedown") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "MOUSEMOVE", "sp", "sp_mousemove") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "MOUSEOVER", "sp", "sp_mouseover") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "MOUSEUP", "sp", "sp_mouseup") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "WHEEL", "sp", "sp_wheel") != 0) goto err; /** Init the JS scripts. **/ - htrAddScriptInit_va(s, + if (htrAddScriptInit_va(s, "\tsp_init({" "layer: wgtrGetNodeRef(ns, '%STR&SYM'), " "area_name: 'sp%POSarea', " "thumb_name: 'sp%POSthumb', " "});\n", name, id, id - ); - - /** Write html and styles. **/ - if (s->Capabilities.Dom1HTML) + ) != 0) { - /** Write the scrollpane. **/ - htrAddBodyItem_va(s, - "
\n", - id, - (visible) ? "inherit" : "hidden", - ht_flex_x(x, tree), - ht_flex_y(y, tree), - ht_flex_w(w, tree), - ht_flex_h(h, tree), - z - ); - - /** Write shared CSS for the following UI elements. **/ - htrAddStylesheetItem_va(s, - "\t\t.sp%POS_scroll { " - "position:absolute; " - "left:"ht_flex_format"; " - "}\n", - id, - ht_flex(w - 18, tree->width, 1.0) - ); - - /** Write the up button. **/ - htrAddBodyItem_va(s, - "", - id, - id - ); - - /** Write the scroll bar. **/ - htrAddBodyItem_va(s, - "", - id, - id, - ht_flex(h - 36, tree->height, 1.0) - ); - - /** Write the down button. **/ - htrAddBodyItem_va(s, - "", - id, - id, - ht_flex(h - 18, tree->height, 1.0) - ); - - /** Write the scroll thumb. **/ - htrAddBodyItem_va(s, - "
" - "" - "
\n", - id, - id, - z + 1 - ); - - /** Write the scroll area. **/ - htrAddBodyItem_va(s, - "
", - id, - ht_flex(w - 18, ht_get_parent_w(tree), 1.0), - ht_flex(h, ht_get_parent_h(tree), 1.0), - z + 1 - ); + mssError(0, "HTSPANE", "Failed to write JS init call."); + goto err; } - else if (s->Capabilities.Dom0NS) - { - /** Write CSS for everything. **/ - htrAddStylesheetItem_va(s, - "\t\t#sp%POSpane { " + + /** Write the scrollpane. **/ + if (htrAddBodyItem_va(s, + "
\n", + id, + (visible) ? "inherit" : "hidden", + ht_flex_x(x, tree), + ht_flex_y(y, tree), + ht_flex_w(w, tree), + ht_flex_h(h, tree), + z + ) != 0) + { + mssError(0, "HTSPANE", "Failed to write HTML for main scrollpane div."); + goto err; + } + + /** Write shared CSS for the following UI elements. **/ + if (htrAddStylesheetItem_va(s, + "\t\t.sp%POS_scroll { " + "position:absolute; " + "left:"ht_flex_format"; " + "}\n", + id, + ht_flex(w - 18, tree->width, 1.0) + ) != 0) + { + mssError(0, "HTSPANE", "Failed to write shared CSS ui elements."); + goto err; + } + + /** Write the up button. **/ + if (htrAddBodyItem_va(s, + "", + id, + id + ) != 0) + { + mssError(0, "HTSPANE", "Failed to write HTML for the down button."); + goto err; + } + + /** Write the scroll bar. **/ + if (htrAddBodyItem_va(s, + "", + id, + id, + ht_flex(h - 36, tree->height, 1.0) + ) != 0) + { + mssError(0, "HTSPANE", "Failed to write HTML for the scroll bar."); + goto err; + } + + /** Write the down button. **/ + if (htrAddBodyItem_va(s, + "", + id, + id, + ht_flex(h - 18, tree->height, 1.0) + ) != 0) + { + mssError(0, "HTSPANE", "Failed to write HTML for the down button."); + goto err; + } + + /** Write the scroll thumb. **/ + if (htrAddBodyItem_va(s, + "
" + "" + "
\n", + id, + id, + z + 1 + ) != 0) + { + mssError(0, "HTSPANE", "Failed to write HTML for the scroll thumb."); + goto err; + } + + /** Write the scroll area. **/ + if (htrAddBodyItem_va(s, + "
", - id, - *background_color, background_color, - *background_image, background_image, - w - ); - - htrAddBodyItem_va(s, - /** Write the up button. **/ - "
" - - /** Write the scroll bar. **/ - "" - - /** Write the down button. **/ - "" - - /** Close the scrollpane table (see above). **/ - "
" - "" - "
" - "" - "
" - "" - "
\n", - h - 36 - ); - - /** Write the scroll thumb. **/ - htrAddBodyItem_va(s, - "
" - "" - "
\n", - id - ); - - /** Write the scroll area. **/ - htrAddBodyItem_va(s, - "
" - "
", - id, - w - 2, - h - 2 - ); + "'" + ">", + id, + ht_flex(w - 18, ht_get_parent_w(tree), 1.0), + ht_flex(h, ht_get_parent_h(tree), 1.0), + z + 1 + ) != 0) + { + mssError(0, "HTSPANE", "Failed to write HTML for the scroll area."); + goto err; } - /** Render children/subwidgets. **/ - for (int i = 0; i < xaCount(&(tree->Children)); i++) - htrRenderWidget(s, xaGetItem(&(tree->Children), i), z + 2); + /** Render children. **/ + if (htrRenderSubwidgets(s, tree, z + 2) != 0) goto err; /** Close the final
s. **/ - if (s->Capabilities.Dom1HTML) - { - htrAddBodyItem(s,"
\n"); - } - else if (s->Capabilities.Dom0NS) + if (htrAddBodyItem(s,"\n") != 0) { - htrAddBodyItem(s,"
\n"); + mssError(0, "HTSPANE", "Failed to write closing HTML tags."); + goto err; } - /** Add the event handling scripts **/ - htrAddEventHandlerFunction(s, "document", "MOUSEDOWN", "sp", "sp_mousedown"); - htrAddEventHandlerFunction(s, "document", "MOUSEMOVE", "sp", "sp_mousemove"); - htrAddEventHandlerFunction(s, "document", "MOUSEUP", "sp", "sp_mouseup"); - htrAddEventHandlerFunction(s, "document", "MOUSEOVER", "sp", "sp_mouseover"); - htrAddEventHandlerFunction(s, "document", "WHEEL", "sp", "sp_wheel"); - return 0; err: - mssError(0, "HTSPANE", "Failed to render widget/scrollpane."); + mssError(0, "HTTAB", + "Failed to render \"%s\":\"%s\" (id: %d).", + tree->Name, tree->Type, id + ); return -1; } diff --git a/centrallix/htmlgen/htdrv_tab.c b/centrallix/htmlgen/htdrv_tab.c index fe6e300e2..eedb406e4 100644 --- a/centrallix/htmlgen/htdrv_tab.c +++ b/centrallix/htmlgen/htdrv_tab.c @@ -66,7 +66,6 @@ httabRender(pHtSession s, pWgtrNode tree, int z) int sel_idx = -1; int x = -1, y = -1; int w, h; /* width & height of the tab control. */ - int id, tab_count, i; int tab_w = 0, tab_h = 0; int is_auto_tab_w = 0; /* 1 if tab_w should be computed client-side. */ int xoffset, yoffset, xtoffset, ytoffset; @@ -76,18 +75,23 @@ httabRender(pHtSession s, pWgtrNode tree, int z) char border_style[32]; char border_color[64]; int border_width; + + /** Reserve the next tab widget ID. **/ + const int id = (HTTAB.idcnt++); - if(!s->Capabilities.Dom0NS && !s->Capabilities.Dom0IE &&(!s->Capabilities.Dom1HTML || !s->Capabilities.Dom2CSS)) + /** Verify browser capabilities. **/ + if (!s->Capabilities.Dom1HTML || !s->Capabilities.Dom2CSS) { - mssError(1,"HTTAB","NS4 or W3C DOM Support required"); + mssError(1, "HTTAB", "Unsupported browser: W3C DOM1 HTML and DOM2 CSS support required."); goto err; } - /** Reserve the next tab widget ID. **/ - id = (HTTAB.idcnt++); - /** Get the tab widget name. **/ - if (wgtrGetPropertyValue(tree, "name", DATA_T_STRING, POD(&ptr)) != 0) goto err; + if (wgtrGetPropertyValue(tree, "name", DATA_T_STRING, POD(&ptr)) != 0) + { + mssError(1, "HTTAB", "Tab widget has no name?!"); + goto err; + } strtcpy(name, ptr, sizeof(name)); /** Get x, y, w, & h of this object. **/ @@ -95,12 +99,12 @@ httabRender(pHtSession s, pWgtrNode tree, int z) if (wgtrGetPropertyValue(tree, "y", DATA_T_INTEGER, POD(&y)) != 0) y = 0; if (wgtrGetPropertyValue(tree, "width", DATA_T_INTEGER, POD(&w)) != 0) { - mssError(0, "HTTAB", "Tab widget must have a 'width' property"); + mssError(1, "HTTAB", "Tab widget must have a 'width' property"); goto err; } if (wgtrGetPropertyValue(tree, "height", DATA_T_INTEGER, POD(&h)) != 0) { - mssError(0, "HTTAB", "Tab widget must have a 'height' property"); + mssError(1, "HTTAB", "Tab widget must have a 'height' property"); goto err; } @@ -140,11 +144,11 @@ httabRender(pHtSession s, pWgtrNode tree, int z) enum httab_locations tloc = Top; if (wgtrGetPropertyValue(tree, "tab_location", DATA_T_STRING, POD(&ptr)) == 0) { - if (strcasecmp(ptr, "top") == 0) tloc = Top; + if (strcasecmp(ptr, "none") == 0) tloc = None; + else if (strcasecmp(ptr, "top") == 0) tloc = Top; else if (strcasecmp(ptr, "bottom") == 0) tloc = Bottom; else if (strcasecmp(ptr, "left") == 0) tloc = Left; else if (strcasecmp(ptr, "right") == 0) tloc = Right; - else if (strcasecmp(ptr, "none") == 0) tloc = None; else { mssError(1,"HTTAB","%s: '%s' is not a valid tab_location",name,ptr); @@ -153,7 +157,7 @@ httabRender(pHtSession s, pWgtrNode tree, int z) } /** Count the number of tabs. **/ - tab_count = wgtrGetMatchingChildList(tree, "widget/tabpage", children, sizeof(children) / sizeof(pWgtrNode)); + const int tab_count = wgtrGetMatchingChildList(tree, "widget/tabpage", children, sizeof(children) / sizeof(pWgtrNode)); /** Get the selected tab. **/ if (wgtrGetPropertyType(tree, "selected") == DATA_T_STRING && @@ -165,7 +169,7 @@ httabRender(pHtSession s, pWgtrNode tree, int z) if (wgtrGetPropertyValue(tree, "selected", DATA_T_STRING, POD(&ptr)) == 0) { /** Search for the tab with the indicated name. **/ - for (i = 0; i < tab_count; i++) + for (unsigned int i = 0; i < tab_count; i++) { char* tab_name; wgtrGetPropertyValue(children[i], "name", DATA_T_STRING, POD(&tab_name)); @@ -176,8 +180,8 @@ httabRender(pHtSession s, pWgtrNode tree, int z) break; } } - if (i >= tab_count) { - mssError(1, "HTTAB", "%s: cannot find tab with name '%s'", name, ptr); + if (sel_idx == -1) { + mssError(1, "HTTAB", "Failed to find tab named '%s'", ptr); /** Attempt to give hint. **/ if (tab_count > 0) @@ -215,8 +219,8 @@ httabRender(pHtSession s, pWgtrNode tree, int z) } /** Handle user expressions for the selected tab. **/ - htrCheckAddExpression(s, tree, name, "selected"); - htrCheckAddExpression(s, tree, name, "selected_index"); + if (htrCheckAddExpression(s, tree, name, "selected") < 0) goto err; + if (htrCheckAddExpression(s, tree, name, "selected_index") < 0) goto err; /** Get the background colors/images. **/ htrGetBackground(tree, NULL, s->Capabilities.Dom2CSS, main_bg, sizeof(main_bg)); @@ -304,7 +308,7 @@ httabRender(pHtSession s, pWgtrNode tree, int z) xtoffset -= select_x_offset; ytoffset -= select_y_offset; - /** Get the rendering type. **/ + /** Get the rendering type (debugging feature). **/ /** Allows the developer to turn off JS client-side widget rendering for testing. **/ int do_client_rendering = 1; if (wgtrGetPropertyValue(tree, "rendering", DATA_T_STRING, POD(&ptr)) == 0) @@ -313,29 +317,32 @@ httabRender(pHtSession s, pWgtrNode tree, int z) else if (strcmp(ptr, "client-side") == 0) do_client_rendering = 1; else { - mssError(1, "HTTAB", "%s: Unknown value for 'rendering': %s", name, ptr); + mssError(1, "HTTAB", "Unknown value for 'rendering': %s", ptr); mssError(0, "HTTAB", "HINT: Should be either 'server-side' or 'client-size'."); goto err; } } if (!do_client_rendering && tab_w == 0 && (tloc == Top || tloc == Bottom)) { - /*** The dev has specified server-side rendering for Top/Bottom tabs + /*** The widget specifies server-side rendering for Top/Bottom tabs *** with dynamic width. This will probably look broken. ***/ - mssError(1, "HTTAB", - "%s: 'rendering' value of \"server-side\" will break on tabs " - "with dynamic widths because they cannot be calculated server-side!", - name + fprintf(stderr, "WARNING: " + "'rendering' value of \"server-side\" will break on tabs with " + "dynamic widths because they cannot be calculated server-side!" ); - mssError(0, "HTTAB", "HINT: Specify 'tab_width' when using \"server-side\" rendering."); + fprintf(stderr, "HINT: Specify the 'tab_width' attribute or use \"client-side\" rendering."); } - /** Handle DOM linkages. **/ - htrAddWgtrObjLinkage_va(s, tree, "tc%POSctrl", id); + /** Link the widget to the DOM node. **/ + if (htrAddWgtrObjLinkage_va(s, tree, "tc%POSctrl", id) != 0) + { + mssError(0, "HTTAB", "Failed to add object linkage to tab."); + goto err; + } /** Include the htdrv_tab.js script. **/ - htrAddScriptInclude(s, "/sys/js/htdrv_tab.js", 0); + if (htrAddScriptInclude(s, "/sys/js/htdrv_tab.js", 0) != 0) goto err; /** Send globals variables to the client to avoid needing to hard code them. **/ const int bufsiz = 96; @@ -350,20 +357,20 @@ httabRender(pHtSession s, pWgtrNode tree, int z) "{ tlocs: { Top:%d, Bottom:%d, Left:%d, Right:%d, None:%d } }", Top, Bottom, Left, Right, None ); - htrAddScriptGlobal(s, "tc_config", config_buf, HTR_F_VALUEALLOC); + if (htrAddScriptGlobal(s, "tc_config", config_buf, HTR_F_VALUEALLOC) != 0) goto err; /*** TODO: Greg - config_buf is definitely leaked because I can't *** figure out how long it needs to remain in scope. ***/ /** Add globals for the master tabs listing. **/ - htrAddScriptGlobal(s, "tc_tabs", "null", 0); - htrAddScriptGlobal(s, "tc_cur_mainlayer", "null", 0); + if (htrAddScriptGlobal(s, "tc_cur_mainlayer", "null", 0) != 0) goto err; + if (htrAddScriptGlobal(s, "tc_tabs", "null", 0) != 0) goto err; /** Add mouse event handlers. **/ - htrAddEventHandlerFunction(s, "document", "MOUSEDOWN", "tc", "tc_mousedown"); - htrAddEventHandlerFunction(s, "document", "MOUSEUP", "tc", "tc_mouseup"); - htrAddEventHandlerFunction(s, "document", "MOUSEMOVE", "tc", "tc_mousemove"); - htrAddEventHandlerFunction(s, "document", "MOUSEOVER", "tc", "tc_mouseover"); + if (htrAddEventHandlerFunction(s, "document", "MOUSEDOWN", "tc", "tc_mousedown") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "MOUSEMOVE", "tc", "tc_mousemove") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "MOUSEOVER", "tc", "tc_mouseover") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "MOUSEUP", "tc", "tc_mouseup") != 0) goto err; /** Script initialization call. **/ char tloc_name[8]; @@ -375,7 +382,7 @@ httabRender(pHtSession s, pWgtrNode tree, int z) case Right: strcpy(tloc_name, "Right"); break; case None: strcpy(tloc_name, "None"); break; } - htrAddScriptInit_va(s, + if (htrAddScriptInit_va(s, "\ttc_init({" "layer:wgtrGetNodeRef(ns,'%STR&SYM'), " "tloc:'%STR', " @@ -398,7 +405,11 @@ httabRender(pHtSession s, pWgtrNode tree, int z) (is_auto_tab_w) ? 0 : tab_w, /* 0 tells the front end that it should recalculate tab_w. */ tab_h, (do_client_rendering) ? "true" : "false" - ); + ) != 0) + { + mssError(0, "HTTAB", "Failed to write JS script call."); + goto err; + } /** Check for tabpages within the tab control, to do the tabs at the top. **/ if (tloc != None) @@ -450,17 +461,21 @@ httabRender(pHtSession s, pWgtrNode tree, int z) const int parent_h = ht_get_parent_h(tree); /** Inject tab_fl values for client-side rendering. **/ - htrAddScriptInit_va(s, + if (htrAddScriptInit_va(s, "{ " "const node = wgtrGetNodeRef(ns, '%STR&SYM'); " "node.tab_fl_x = %DBL; " "node.tab_fl_y = %DBL; " "}\n", name, tab_fl_x, tab_fl_y - ); + ) != 0) + { + mssError(0, "HTTAB", "Failed to write JS script call."); + goto err; + } /** Loop over each tab. **/ - for (i = 0; i < tab_count; i++) + for (unsigned int i = 0; i < tab_count; i++) { const pWgtrNode tab = children[i]; @@ -472,7 +487,7 @@ httabRender(pHtSession s, pWgtrNode tree, int z) const int is_selected = (i == sel_idx - 1); const int tab_x = (x + xtoffset) + (i_offset_x * i); const int tab_y = (y + ytoffset) + (i_offset_y * i); - htrAddStylesheetItem_va(s, + if (htrAddStylesheetItem_va(s, "\t\t#tc%POStab%POS { " "position:absolute; " "visibility:inherit; " @@ -512,18 +527,26 @@ httabRender(pHtSession s, pWgtrNode tree, int z) text_color, tab_x + 1, tab_y, (is_selected) ? main_bg : inactive_bg - ); + ) != 0) + { + mssError(0, "HTTAB", "Failed to write CSS for tab."); + goto err_tab; + } - htrAddStylesheetItem_va(s, + if (htrAddStylesheetItem_va(s, "\t\t#tc%POStab%POS.tab_selected { " "transform:translate(%INTpx, %INTpx); " "}\n", id, i + 1, select_x_offset, select_y_offset - ); + ) != 0) + { + mssError(0, "HTTAB", "Failed to write CSS for selected tab."); + goto err_tab; + } /** Write tab HTML content. **/ - htrAddBodyItem_va(s, + if (htrAddBodyItem_va(s, "
" "

\n", id); + ) != 0) + { + mssError(0, "HTTAB", "Failed to write CSS for tab control."); + goto err; + } + if (htrAddBodyItem_va(s, "

\n", id) != 0) + { + mssError(0, "HTTAB", "Failed to write HTML for tab control."); + goto err; + } /** Check for tab pages within the tab control entity, this time to do the pages themselves. **/ const char* widget_namespace = wgtrGetNamespace(tree); - for (i = 0; i < tab_count; i++) + for (unsigned int i = 0; i < tab_count; i++) { const pWgtrNode tab_page_tree = children[i]; /** Handle namespace transition. **/ - htrCheckNSTransition(s, tree, tab_page_tree); + if (htrCheckNSTransition(s, tree, tab_page_tree) != 0) + { + mssError(0, "HTTAB", "Failed to transition to namespace while writing tab page."); + goto tab_page_err; + } /** Check if the tab is selected. **/ int is_selected = (i == sel_idx - 1); @@ -626,7 +672,7 @@ httabRender(pHtSession s, pWgtrNode tree, int z) /** Write the addTab() initialization call (in a new scope). **/ const char* tab_page_namespace = wgtrGetNamespace(tab_page_tree); - htrAddScriptInit_va(s, "\t{ " + if (htrAddScriptInit_va(s, "\t{ " "const tabctrl = wgtrGetNodeRef('%STR&SYM', '%STR&SYM'); " "tabctrl" ".addTab({ " @@ -639,14 +685,26 @@ httabRender(pHtSession s, pWgtrNode tree, int z) (tloc != None), id, i + 1, tab_page_namespace, ptr, ptr, page_type, fieldname - ); + ) != 0) + { + mssError(0, "HTTAB", "Failed to write JS to add tab page."); + goto tab_page_err; + } /** Add named global for the tabpage. **/ - htrAddWgtrObjLinkage_va(s, tab_page_tree, "tc%POSpane%POS", id, i+1); - htrAddWgtrCtrLinkage_va(s, tab_page_tree, "htr_subel(_parentobj, \"tc%POSpane%POS\")", id, i + 1); + if (htrAddWgtrObjLinkage_va(s, tab_page_tree, "tc%POSpane%POS", id, i+1) != 0) + { + mssError(0, "HTTAB", "Failed to add object linkage for tab page."); + goto tab_page_err; + } + if (htrAddWgtrCtrLinkage_va(s, tab_page_tree, "htr_subel(_parentobj, \"tc%POSpane%POS\")", id, i + 1) != 0) + { + mssError(0, "HTTAB", "Failed to add container linkage for tab page."); + goto tab_page_err; + } /** Add DIV section to contane the tabpage. **/ - htrAddBodyItem_va(s, + if (htrAddBodyItem_va(s, "
name, t->name, t->name, t->id, (has_osrc), t->osrc, (!has_osrc) - ); + ) != 0) + { + mssError(0, "HTTBL", "Failed to write JS table identification data."); + goto err; + } /** Write layout data. **/ - htrAddScriptInit_va(s, + if (htrAddScriptInit_va(s, "height:%INT, " "width:%INT, " "innerpadding:%INT, " @@ -243,10 +264,14 @@ httblRenderDynamic(pHtSession s, pWgtrNode tree, int z, httbl_struct* t) t->inner_padding, t->min_rowheight, t->max_rowheight, t->cellhspacing, t->cellvspacing - ); + ) != 0) + { + mssError(0, "HTTBL", "Failed to write JS table layout data."); + goto err; + } /** Write selection data. **/ - htrAddScriptInit_va(s, + if (htrAddScriptInit_va(s, "allow_selection:%INT, " "show_selection:%INT, " "initial_selection:%INT, " @@ -255,18 +280,26 @@ httblRenderDynamic(pHtSession s, pWgtrNode tree, int z, httbl_struct* t) t->show_selection, t->initial_selection, t->allow_deselection - ); + ) != 0) + { + mssError(0, "HTTBL", "Failed to write JS table selection data."); + goto err; + } /** Write scrollbar data. **/ - htrAddScriptInit_va(s, + if (htrAddScriptInit_va(s, "thumb_name:'tbld%POSthumb', " "demand_sb:%INT, ", t->id, t->demand_scrollbar - ); + ) != 0) + { + mssError(0, "HTTBL", "Failed to write JS table scrollbar data."); + goto err; + } /** Write theme data (colors, backgrounds, etc.). **/ - htrAddScriptInit_va(s, + if (htrAddScriptInit_va(s, "textcolor:'%STR&JSSTR', " "textcolorhighlight:'%STR&JSSTR', " "titlecolor:'%STR&JSSTR', " @@ -277,10 +310,14 @@ httblRenderDynamic(pHtSession s, pWgtrNode tree, int z, httbl_struct* t) t->textcolor, t->textcolorhighlight, t->titlecolor, t->colsep_bgnd, t->hdr_bgnd, t->newrow_bgnd, t->newrow_textcolor - ); + ) != 0) + { + mssError(0, "HTTBL", "Failed to write JS table theme data."); + goto err; + } /** Write general row data. **/ - htrAddScriptInit_va(s, + if (htrAddScriptInit_va(s, "dm:%INT, " "hdr:%INT, " "grid_in_empty_rows:%INT, " @@ -291,23 +328,35 @@ httblRenderDynamic(pHtSession s, pWgtrNode tree, int z, httbl_struct* t) t->grid_in_empty_rows, t->windowsize, t->rowcache_size - ); + ) != 0) + { + mssError(0, "HTTBL", "Failed to write JS table general row data."); + goto err; + } /** Write general column data. **/ - htrAddScriptInit_va(s, + if (htrAddScriptInit_va(s, "dragcols:%INT, " "colsep:%INT, " "colsep_mode:%INT, ", t->dragcols, t->colsep, t->colsep_mode - ); + ) != 0) + { + mssError(0, "HTTBL", "Failed to write JS table general column data."); + goto err; + } /** Write the cols array with data for each column. **/ /** ANCHOR[id=table-column] **/ - htrAddScriptInit_va(s, "cols:["); + if (htrAddScriptInit_va(s, "cols:[") != 0) + { + mssError(0, "HTTBL", "Failed to write JS for the start of the table columns list."); + goto err; + } for (int colid = 0; colid < t->ncols; colid++) { httbl_col* col = t->col_infs[colid]; - htrAddScriptInit_va(s, + if (htrAddScriptInit_va(s, "{ " "name:'%STR&JSSTR', " "ns:'%STR&JSSTR', " @@ -338,18 +387,33 @@ httblRenderDynamic(pHtSession s, pWgtrNode tree, int z, httbl_struct* t) col->caption_textcolor, col->image_maxwidth, col->image_maxheight - ); + ) != 0) + { + mssError(0, "HTTBL", + "Failed to write JS for table column #%d/%d, aka. \"%s\".", + colid + 1, t->ncols, col->wname + ); + goto err; + } } /** Null terminate the array, and finish writing the init call. **/ - htrAddScriptInit(s,"null]});\n"); + if (htrAddScriptInit(s, "null]});\n") != 0) + { + mssError(0, "HTTBL", "Failed to write JS to finish init call."); + goto err; + } /** Write HTML for the table base container. **/ - htrAddBodyItem_va(s,"
\n",t->id); + if (htrAddBodyItem_va(s, "
\n", t->id) != 0) + { + mssError(0, "HTTBL", "Failed to write HTML opening tag for table container."); + goto err; + } /** Write the table row detail elements. **/ /** ANCHOR[id=table-row-detail] **/ - int subcnt = 0; + int sub_count = 0; pWgtrNode children[32]; /** Warning: Large local variable in stack. **/ const int detail_count = wgtrGetMatchingChildList(tree, "widget/table-row-detail", children, sizeof(children)/sizeof(pWgtrNode)); for (int i = 0; i < detail_count; i++) @@ -360,12 +424,13 @@ httblRenderDynamic(pHtSession s, pWgtrNode tree, int z, httbl_struct* t) wgtrGetPropertyValue(sub_tree, "outer_type", DATA_T_STRING,POD(&ptr)); if (strcmp(ptr, "widget/table-row-detail") == 0) { - htrCheckNSTransition(s, tree, sub_tree); + sub_count++; + if (htrCheckNSTransition(s, tree, sub_tree) != 0) goto err_detail; /** Write CSS for the table row detail. **/ int h; if (wgtrGetPropertyValue(sub_tree, "height", DATA_T_INTEGER, POD(&h)) != 0) h = t->min_rowheight; - htrAddStylesheetItem_va(s, + if (htrAddStylesheetItem_va(s, "\t\t#tbld%POSsub%POS { " "position:absolute; " "visibility:hidden; " @@ -375,34 +440,67 @@ httblRenderDynamic(pHtSession s, pWgtrNode tree, int z, httbl_struct* t) "height:"ht_flex_format"; " "z-index:%POS; " "}\n", - t->id, ++subcnt, + t->id, sub_count, ht_flex_w(t->w - (t->demand_scrollbar ? 0 : 18), tree), ht_flex_h(h, tree), z + 1 - ); + ) != 0) + { + mssError(0, "HTTBL", "Failed to write HTML opening tag for table container."); + goto err_detail; + } /** Write HTML (including subwidgets). **/ - htrAddBodyItem_va(s,"
\n", t->id, subcnt); - htrRenderSubwidgets(s, sub_tree, z+2); - htrAddBodyItem(s,"
\n"); + if (htrAddBodyItem_va(s, "
\n", t->id, sub_count) != 0) + { + mssError(0, "HTTBL", "Failed to write HTML opening tag for table row detail."); + goto err_detail; + } + if (htrRenderSubwidgets(s, sub_tree, z + 2) != 0) + { + mssError(0, "HTTBL", "Failed to write widgets in table row detail."); + goto err_detail; + } + if (htrAddBodyItem(s, "
\n") != 0) + { + mssError(0, "HTTBL", "Failed to write HTML closing tag for table container."); + goto err_detail; + } /** Add linkage. **/ - htrAddWgtrObjLinkage_va(s, sub_tree, "tbld%POSsub%POS", t->id, subcnt); + if (htrAddWgtrObjLinkage_va(s, sub_tree, "tbld%POSsub%POS", t->id, sub_count)) goto err_detail; /** Add 'display_for'. **/ - wgtrGetPropertyValue(sub_tree, "name", DATA_T_STRING,POD(&ptr)); - htrCheckAddExpression(s, sub_tree, ptr, "display_for"); - - htrCheckNSTransitionReturn(s, tree, sub_tree); + if (wgtrGetPropertyValue(sub_tree, "name", DATA_T_STRING, POD(&ptr)) != 0) + { + mssError(1, "HTTBL", "Failed to get name of table row detail widget."); + goto err_detail; + } + if (htrCheckAddExpression(s, sub_tree, ptr, "display_for") < 0) goto err; + + if (htrCheckNSTransitionReturn(s, tree, sub_tree) != 0) goto err; } + + /** Success. **/ + continue; + + err_detail: + mssError(0, "HTTBL", "Failed to write HTML opening tag for table container."); + goto err; } - htrRenderSubwidgets(s, tree, z+2); + + /** Render other children. **/ + if (htrRenderSubwidgets(s, tree, z + 2) != 0) goto err; /** Close the base container. **/ - htrAddBodyItem(s,"
\n"); + if (htrAddBodyItem(s, "
\n") != 0) + { + mssError(0, "HTTBL", "Failed to write HTML closing tag for table container."); + goto err; + } /** Write HTML for the scrollbar. **/ - htrAddBodyItem_va(s, + if (htrAddBodyItem_va(s, "
\n" "\n" "\n" @@ -411,25 +509,38 @@ httblRenderDynamic(pHtSession s, pWgtrNode tree, int z, httbl_struct* t) "
\n" "
\n" "
\n", - t->id, t->id, ht_flex_h(t->h - row_start_y - 2*18, tree), t->id - ); + t->id, + t->id, ht_flex_h(t->h - row_start_y - 2*18, tree), + t->id + ) != 0) + { + mssError(0, "HTTBL", "Failed to write HTML for table scrollbar."); + goto err; + } /** Register event handlers. **/ - htrAddEventHandlerFunction(s,"document","MOUSEOVER","tbld","tbld_mouseover"); - htrAddEventHandlerFunction(s,"document","MOUSEOUT","tbld","tbld_mouseout"); - htrAddEventHandlerFunction(s,"document","MOUSEDOWN","tbld","tbld_mousedown"); - htrAddEventHandlerFunction(s, "document","MOUSEMOVE","tbld","tbld_mousemove"); - htrAddEventHandlerFunction(s, "document","MOUSEUP","tbld","tbld_mouseup"); - htrAddEventHandlerFunction(s, "document","WHEEL","tbld","tbld_wheel"); - htrAddEventHandlerFunction(s, "document","KEYDOWN","tbld","tbld_keydown"); - htrAddEventHandlerFunction(s, "document","TOUCHSTART","tbld","tbld_touchstart"); - htrAddEventHandlerFunction(s, "document","TOUCHEND","tbld","tbld_touchend"); - htrAddEventHandlerFunction(s, "document","TOUCHMOVE","tbld","tbld_touchmove"); - htrAddEventHandlerFunction(s, "document","TOUCHCANCEL","tbld","tbld_touchcancel"); - if (s->Capabilities.Dom1HTML) - htrAddEventHandlerFunction(s, "document", "CONTEXTMENU", "tbld", "tbld_contextmenu"); - - return 0; + if (htrAddEventHandlerFunction(s, "document", "CONTEXTMENU", "tbld", "tbld_contextmenu") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "KEYDOWN", "tbld", "tbld_keydown") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "MOUSEDOWN", "tbld", "tbld_mousedown") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "MOUSEMOVE", "tbld", "tbld_mousemove") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "MOUSEOUT", "tbld", "tbld_mouseout") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "MOUSEOVER", "tbld", "tbld_mouseover") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "MOUSEUP", "tbld", "tbld_mouseup") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "TOUCHCANCEL", "tbld", "tbld_touchcancel") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "TOUCHEND", "tbld", "tbld_touchend") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "TOUCHMOVE", "tbld", "tbld_touchmove") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "TOUCHSTART", "tbld", "tbld_touchstart") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "WHEEL", "tbld", "tbld_wheel") != 0) goto err; + + /** Success. **/ + return 0; + + err: + mssError(0, "HTTBL", + "Failed to render \"%s\":\"%s\" (id: %d).", + tree->Name, tree->Type, t->id + ); + return -1; } diff --git a/centrallix/htmlgen/htdrv_terminal.c b/centrallix/htmlgen/htdrv_terminal.c index 8bce39495..9434a9367 100644 --- a/centrallix/htmlgen/htdrv_terminal.c +++ b/centrallix/htmlgen/htdrv_terminal.c @@ -58,27 +58,24 @@ httermRender(pHtSession s, pWgtrNode tree, int z) { char* ptr; char name[64]; - int id; - pWgtrNode sub_tree; #define MAX_COLORS 8 #define MAX_COLOR_LEN 32 char colors[MAX_COLORS][MAX_COLOR_LEN]={"black","red","green","yellow","blue","purple","aqua","white"}; - int i; XString source; int rows, cols, fontsize, x, y; - /** our first Mozilla-only widget :) **/ - if(!s->Capabilities.Dom1HTML) + /** Get an id for this. **/ + const unsigned id = (HTTERM.idcnt++); + + /** Verify browser capabilities. **/ + if (!s->Capabilities.Dom1HTML || !s->Capabilities.Dom2CSS) { - mssError(1,"HTTERM","W3C DOM Level 1 support required"); - return -1; + mssError(1, "HTTERM", "Unsupported browser: W3C DOM1 HTML and DOM2 CSS support required."); + goto err; } - /** Get an id for this. **/ - id = (HTTERM.idcnt++); - /** read the color specs, leaving the defaults if they don't exist **/ - for(i=0;i element to use as the base **/ - htrAddBodyItem_va(s,"
\n",id); - htrAddBodyItem_va(s," \n",id); - htrAddBodyItem_va(s," \n",id); - - /** write the stylesheet header element **/ - htrAddStylesheetItem_va(s, + if (htrAddBodyItem_va(s, + "
" + "" + "\n", + id, id, id + ) != 0) + { + mssError(0, "HTTERM", "Failed to write HTML base, reader, and writer tags."); + goto err; + } + + /** Write CSS. **/ + if (htrAddStylesheetItem_va(s, "\t\t#term%POSbase { " "position:absolute; " "visibility:inherit; " @@ -158,13 +165,35 @@ httermRender(pHtSession s, pWgtrNode tree, int z) cols * fontsize, rows * fontsize, z - ); - htrAddStylesheetItem_va(s, "\t\t#term%POSreader { position:absolute; visibility:hidden; left:0px; top:0px; width:1px; height:1; z-index:-20; }\n", id); - htrAddStylesheetItem_va(s, "\t\t#term%POSwriter { position:absolute; visibility:hidden; left:0px; top:0px; width:1px; height:1; z-index:-20; }\n", id); - htrAddStylesheetItem_va(s, "\t\t.fixed%POS {font-family: fixed; }\n",id); + ) != 0) + { + mssError(0, "HTTERM", "Failed to write base CSS."); + goto err; + } + if (htrAddStylesheetItem_va(s, + "\t\t#term%POSreader, #term%POSwriter { " + "position:absolute; " + "visibility:hidden; " + "left:0px; " + "top:0px; " + "width:1px; " + "height:1; " + "z-index:-20; " + "}\n", + id + ) != 0) + { + mssError(0, "HTTERM", "Failed to write reader/writer CSS."); + goto err; + } + if (htrAddStylesheetItem_va(s, "\t\t.fixed%POS { font-family: fixed; }\n",id) != 0) + { + mssError(0, "HTTERM", "Failed to write fixed font CSS."); + goto err; + } /** Write script initialization. **/ - htrAddScriptInit_va(s, + if (htrAddScriptInit_va(s, "\tterminal_init({ " "layer:wgtrGetNodeRef(ns, '%STR&SYM'), " "rdr:'term%POSreader', " @@ -176,23 +205,37 @@ httermRender(pHtSession s, pWgtrNode tree, int z) "colors:new Array(", name, id, id, id, source.String, rows, cols - ); - for(i=0;iChildren));i++) + for (unsigned int i = 0u; i < MAX_COLORS; i++) { - sub_tree = xaGetItem(&(tree->Children), i); - htrRenderWidget(s, sub_tree, z+1); + if (htrAddScriptInit_va(s, "'%STR&JSSTR',", colors[i]) != 0) + { + mssError(0, "HTTERM", "Failed to write terminal color #%d/%d: \"%s\"", i + 1, MAX_COLORS, colors[i]); + goto err; + } } - - return 0; + if (htrAddScriptInit(s, ")});\n") != 0) + { + mssError(0, "HTTERM", "Failed to write JS init call end."); + goto err; + } + + /** Render children. **/ + if (htrRenderSubwidgets(s, tree, z + 1) != 0) goto err; + + /** Success. **/ + return 0; + + err: + mssError(0, "HTTERM", + "Failed to render \"%s\":\"%s\" (id: %d).", + tree->Name, tree->Type, id + ); + return -1; } diff --git a/centrallix/htmlgen/htdrv_textarea.c b/centrallix/htmlgen/htdrv_textarea.c index 2c478155a..26de0175b 100644 --- a/centrallix/htmlgen/htdrv_textarea.c +++ b/centrallix/htmlgen/htdrv_textarea.c @@ -60,7 +60,6 @@ httxRender(pHtSession s, pWgtrNode tree, int z) char elementid[16]; //char main_bg[128]; int x=-1,y=-1,w,h; - int id, i; int is_readonly = 0; int is_raised = 0; int mode = 0; /* 0=text, 1=html, 2=wiki */ @@ -69,27 +68,28 @@ httxRender(pHtSession s, pWgtrNode tree, int z) char form[64]; int box_offset; - if(!s->Capabilities.Dom0NS && !s->Capabilities.Dom0IE && !s->Capabilities.Dom2Events) + /** Get an id for this. **/ + const int id = (HTTX.idcnt++); + + /** Verify browser capabilities. **/ + if (!s->Capabilities.Dom1HTML || !s->Capabilities.Dom2CSS) { - mssError(1,"HTTX","Netscape, IE, or Dom2Events support required"); - return -1; + mssError(1, "HTTERM", "Unsupported browser: W3C DOM1 HTML and DOM2 CSS support required."); + goto err; } - /** Get an id for this. **/ - id = (HTTX.idcnt++); - /** Get x,y,w,h of this object **/ if (wgtrGetPropertyValue(tree,"x",DATA_T_INTEGER,POD(&x)) != 0) x=0; if (wgtrGetPropertyValue(tree,"y",DATA_T_INTEGER,POD(&y)) != 0) y=0; if (wgtrGetPropertyValue(tree,"width",DATA_T_INTEGER,POD(&w)) != 0) { mssError(1,"HTTX","Textarea widget must have a 'width' property"); - return -1; + goto err; } if (wgtrGetPropertyValue(tree,"height",DATA_T_INTEGER,POD(&h)) != 0) { mssError(1,"HTTX","Textarea widget must have a 'height' property"); - return -1; + goto err; } /** Maximum characters to accept from the user **/ @@ -107,7 +107,7 @@ httxRender(pHtSession s, pWgtrNode tree, int z) else { mssError(1,"HTTX","Textarea widget 'mode' property must be either 'text','html', or 'wiki'"); - return -1; + goto err; } } @@ -115,7 +115,7 @@ httxRender(pHtSession s, pWgtrNode tree, int z) //htrGetBackground(tree, NULL, 1, main_bg, sizeof(main_bg)); /** Get name **/ - if (wgtrGetPropertyValue(tree,"name",DATA_T_STRING,POD(&ptr)) != 0) return -1; + if (wgtrGetPropertyValue(tree,"name",DATA_T_STRING,POD(&ptr)) != 0) goto err; strtcpy(name,ptr,sizeof(name)); /** Style of Textarea - raised/lowered **/ @@ -139,32 +139,41 @@ httxRender(pHtSession s, pWgtrNode tree, int z) /** Write Style header items. **/ snprintf(elementid, sizeof(elementid), "#tx%dbase", id); - htrFormatElement(s, tree, elementid, 0, - x, y, w-2*box_offset, h-2*box_offset, z, "", - (char*[]){"border_color","#e0e0e0", "border_style",(is_raised?"outset":"inset"), NULL}, - "overflow:hidden; position:absolute;"); - - /** DOM Linkage **/ - htrAddWgtrObjLinkage_va(s, tree, "tx%POSbase",id); - - /** Global for ibeam cursor layer **/ - htrAddScriptGlobal(s, "text_metric", "null", 0); - htrAddScriptGlobal(s, "tx_current", "null", 0); - htrAddScriptGlobal(s, "tx_cur_mainlayer", "null", 0); - - htrAddScriptInclude(s, "/sys/js/htdrv_textarea.js", 0); - htrAddScriptInclude(s, "/sys/js/ht_utils_layers.js", 0); - htrAddScriptInclude(s, "/sys/js/ht_utils_string.js", 0); - htrAddScriptInclude(s, "/sys/js/ht_utils_cursor.js", 0); - - htrAddEventHandlerFunction(s, "document","MOUSEUP", "tx", "tx_mouseup"); - htrAddEventHandlerFunction(s, "document","MOUSEDOWN", "tx","tx_mousedown"); - htrAddEventHandlerFunction(s, "document","MOUSEOVER", "tx", "tx_mouseover"); - htrAddEventHandlerFunction(s, "document","MOUSEMOVE", "tx", "tx_mousemove"); - htrAddEventHandlerFunction(s, "document","PASTE", "tx", "tx_paste"); + const int offset = box_offset * 2; + if (htrFormatElement(s, tree, elementid, 0, + x, y, w - offset, h - offset, z, "", + (char*[]){"border_color","#e0e0e0", "border_style", (is_raised ? "outset" : "inset"), NULL}, + "position:absolute; " + "overflow:hidden; " + ) != 0) + { + mssError(0, "HTTX", "Failed to write styles."); + goto err; + } + + /** Link DOM node to widget data. **/ + if (htrAddWgtrObjLinkage_va(s, tree, "tx%POSbase", id) != 0) goto err; + + /** Write JS globals. **/ + if (htrAddScriptGlobal(s, "text_metric", "null", 0) != 0) goto err; + if (htrAddScriptGlobal(s, "tx_current", "null", 0) != 0) goto err; + if (htrAddScriptGlobal(s, "tx_cur_mainlayer", "null", 0) != 0) goto err; + + /** Write JS script includes. **/ + if (htrAddScriptInclude(s, "/sys/js/ht_utils_cursor.js", 0) != 0) goto err; + if (htrAddScriptInclude(s, "/sys/js/ht_utils_layers.js", 0) != 0) goto err; + if (htrAddScriptInclude(s, "/sys/js/ht_utils_string.js", 0) != 0) goto err; + if (htrAddScriptInclude(s, "/sys/js/htdrv_textarea.js", 0) != 0) goto err; + + /** Register JS event handlers. **/ + if (htrAddEventHandlerFunction(s, "document", "MOUSEDOWN", "tx", "tx_mousedown") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "MOUSEMOVE", "tx", "tx_mousemove") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "MOUSEOVER", "tx", "tx_mouseover") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "MOUSEUP", "tx", "tx_mouseup") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "PASTE", "tx", "tx_paste") != 0) goto err; /** Script initialization call. **/ - htrAddScriptInit_va(s, + if (htrAddScriptInit_va(s, "\ttx_init({ " "layer:wgtrGetNodeRef(ns, '%STR&SYM'), " "fieldname:'%STR&JSSTR', " @@ -173,19 +182,53 @@ httxRender(pHtSession s, pWgtrNode tree, int z) "mode:%INT, " "});\n", name, fieldname, form, is_readonly, mode - ); + ) != 0) + { + mssError(0, "HTTX", "Failed to JS init call."); + goto err; + } + + /** Write HTML container opening tag. **/ + if (htrAddBodyItem_va(s, "
", id) != 0) + { + mssError(0, "HTTX", "Failed to write HTML container opening tag."); + goto err; + } + + /** Write HTML text area opening tag. */ + if (htrAddBodyItem(s, + "
\n") != 0) + { + mssError(0, "HTTX", "Failed to write HTML closing tags."); + goto err; + } - /** End the containing layer. **/ - htrAddBodyItem(s, "
\n"); + /** Success. **/ + return 0; - return 0; + err: + mssError(0, "HTTX", + "Failed to render \"%s\":\"%s\" (id: %d).", + tree->Name, tree->Type, id + ); + return -1; } diff --git a/centrallix/htmlgen/htdrv_textbutton.c b/centrallix/htmlgen/htdrv_textbutton.c index dc01aaf4a..0f0148fe9 100644 --- a/centrallix/htmlgen/htdrv_textbutton.c +++ b/centrallix/htmlgen/htdrv_textbutton.c @@ -65,12 +65,10 @@ httbtnRender(pHtSession s, pWgtrNode tree, int z) char bgstyle[128]; char disable_color[64]; int x,y,w,h; - int id, i; int is_ts = 1; int is_enabled = 1; pExpression code; int box_offset; - //int clip_offset; int border_radius; char border_style[32]; char border_color[64]; @@ -80,30 +78,31 @@ httbtnRender(pHtSession s, pWgtrNode tree, int z) char h_align[16]; int image_width=0, image_height=0, image_margin=0; - if(!s->Capabilities.Dom0NS && !s->Capabilities.Dom0IE && !(s->Capabilities.Dom1HTML && s->Capabilities.Dom2CSS)) + /** Get an id for this. **/ + const int id = (HTTBTN.idcnt++); + + /** Verify browser capabilities. **/ + if (!s->Capabilities.Dom1HTML || !s->Capabilities.Dom2CSS) { - mssError(1,"HTTBTN","Netscape DOM or (W3C DOM1 HTML and W3C DOM2 CSS) support required"); - return -1; + mssError(1, "HTTERM", "Unsupported browser: W3C DOM1 HTML and DOM2 CSS support required."); + goto err; } - /** Get an id for this. **/ - id = (HTTBTN.idcnt++); - /** Get x,y,w,h of this object **/ if (wgtrGetPropertyValue(tree,"x",DATA_T_INTEGER,POD(&x)) != 0) { mssError(1,"HTTBTN","TextButton widget must have an 'x' property"); - return -1; + goto err; } if (wgtrGetPropertyValue(tree,"y",DATA_T_INTEGER,POD(&y)) != 0) { mssError(1,"HTTBTN","TextButton widget must have a 'y' property"); - return -1; + goto err; } if (wgtrGetPropertyValue(tree,"width",DATA_T_INTEGER,POD(&w)) != 0) { mssError(1,"HTTBTN","TextButton widget must have a 'width' property"); - return -1; + goto err; } if (wgtrGetPropertyValue(tree,"height",DATA_T_INTEGER,POD(&h)) != 0) h = -1; if (wgtrGetPropertyType(tree,"enabled") == DATA_T_STRING && wgtrGetPropertyValue(tree,"enabled",DATA_T_STRING,POD(&ptr)) == 0 && ptr) @@ -204,20 +203,20 @@ httbtnRender(pHtSession s, pWgtrNode tree, int z) else strcpy(disable_color,"#808080"); - htrAddScriptGlobal(s, "tb_current", "null", 0); /** DOM Linkages **/ - htrAddWgtrObjLinkage_va(s, tree, "tb%POSpane",id); + if (htrAddWgtrObjLinkage_va(s, tree, "tb%POSpane",id) != 0) goto err; - /** Include the javascript code for the textbutton **/ - htrAddScriptInclude(s, "/sys/js/htdrv_textbutton.js", 0); - htrAddScriptInclude(s, "/sys/js/ht_utils_layers.js", 0); + /** Write JS globals and includes for the textbutton. **/ + if (htrAddScriptGlobal(s, "tb_current", "null", 0) != 0) goto err; + if (htrAddScriptInclude(s, "/sys/js/htdrv_textbutton.js", 0) != 0) goto err; + if (htrAddScriptInclude(s, "/sys/js/ht_utils_layers.js", 0) != 0) goto err; /** Calculate size adjustment. **/ const int adj = (2 * box_offset) + 1; /** Write CSS for the container that will hold the button. **/ - htrAddStylesheetItem_va(s, + if (htrAddStylesheetItem_va(s, "\t\t#tb%POSpane { " "position:absolute; " "visibility:inherit; " @@ -235,18 +234,26 @@ httbtnRender(pHtSession s, pWgtrNode tree, int z) ht_flex_w(w - adj, tree), (h >= 0), ht_flex_h(h - adj, tree), z - ); + ) != 0) + { + mssError(0, "HTTBTN", "Failed to write CSS for main button pane."); + goto err; + } /** Button click animation. **/ if (is_enabled) { - htrAddStylesheetItem_va(s, + if (htrAddStylesheetItem_va(s, "\t\t#tb%POSpane:active { transform: translate(1px, 1px); }\n", id - ); + ) != 0) + { + mssError(0, "HTTBTN", "Failed to write CSS for button click animation."); + goto err; + } } /** Write CSS for the button content, inside the border. **/ - htrAddStylesheetItem_va(s, + if (htrAddStylesheetItem_va(s, "\t\t#tb%POSpane .cell { " "height:100%%; " "width:100%%; " @@ -271,12 +278,16 @@ httbtnRender(pHtSession s, pWgtrNode tree, int z) (is_enabled) ? fgcolor1 : disable_color, (is_enabled), fgcolor2, bgstyle - ); + ) != 0) + { + mssError(0, "HTTBTN", "Failed to write CSS for button content."); + goto err; + } /** Write CSS for image on the button. **/ if (has_image && (image_width != 0 || image_height != 0 || image_margin != 0)) { - htrAddStylesheetItem_va(s, + if (htrAddStylesheetItem_va(s, "\t\t#tb%POSpane img { " "%[height:%POSpx; %]" "%[width:%POSpx; %]" @@ -286,14 +297,15 @@ httbtnRender(pHtSession s, pWgtrNode tree, int z) (image_height != 0), image_height, (image_width != 0), image_width, (image_margin != 0), image_margin - ); + ) != 0) + { + mssError(0, "HTTBTN", "Failed to write CSS for button image."); + goto err; + } } - //htrAddBodyItem_va(s,"
%STR&HTE
\n", id, h-3, id, text); - //htrAddBodyItem(s, "
"); - /** We need two DIVs here because of a long-outstanding Firefox bug :( **/ - htrAddBodyItem_va(s, + if (htrAddBodyItem_va(s, "
" "
" "%[
%]" @@ -309,10 +321,14 @@ httbtnRender(pHtSession s, pWgtrNode tree, int z) text, (has_image && strcmp(image_position, "right") == 0), image, (has_image && strcmp(image_position, "bottom") == 0), image - ); + ) != 0) + { + mssError(0, "HTTBTN", "Failed to write HTML for text button."); + goto err; + } /** Script initialization call. **/ - htrAddScriptInit_va(s, + if (htrAddScriptInit_va(s, "\ttb_init({ " "layer:wgtrGetNodeRef(ns, '%STR&SYM'), " "name:'%STR&SYM', " @@ -334,24 +350,31 @@ httbtnRender(pHtSession s, pWgtrNode tree, int z) fgcolor1, fgcolor2, disable_color, w, h - ); + ) != 0) + { + mssError(0, "HTTBTN", "Failed to write JS init call."); + goto err; + } /** Add event handlers. **/ - htrAddEventHandlerFunction(s, "document", "MOUSEDOWN", "tb", "tb_mousedown"); - htrAddEventHandlerFunction(s, "document", "MOUSEUP", "tb", "tb_mouseup"); - htrAddEventHandlerFunction(s, "document", "MOUSEOVER", "tb", "tb_mouseover"); - htrAddEventHandlerFunction(s, "document", "MOUSEOUT", "tb", "tb_mouseout"); - htrAddEventHandlerFunction(s, "document", "MOUSEMOVE", "tb", "tb_mousemove"); - - /** IE handles dblclick strangely **/ - if (s->Capabilities.Dom0IE) - htrAddEventHandlerFunction(s, "document", "DBLCLICK", "tb", "tb_dblclick"); - - /** Check for more sub-widgets within the textbutton. **/ - for (i=0;iChildren));i++) - htrRenderWidget(s, xaGetItem(&(tree->Children), i), z+3); - - return 0; + if (htrAddEventHandlerFunction(s, "document", "MOUSEDOWN", "tb", "tb_mousedown") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "MOUSEMOVE", "tb", "tb_mousemove") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "MOUSEOUT", "tb", "tb_mouseout") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "MOUSEOVER", "tb", "tb_mouseover") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "MOUSEUP", "tb", "tb_mouseup") != 0) goto err; + + /** Render children. **/ + if (htrRenderSubwidgets(s, tree, z + 1) != 0) goto err; + + /** Success. **/ + return 0; + + err: + mssError(0, "HTTBTN", + "Failed to render \"%s\":\"%s\" (id: %d).", + tree->Name, tree->Type, id + ); + return -1; } diff --git a/centrallix/htmlgen/htdrv_timer.c b/centrallix/htmlgen/htdrv_timer.c index d5182be52..ce8c64620 100644 --- a/centrallix/htmlgen/htdrv_timer.c +++ b/centrallix/htmlgen/htdrv_timer.c @@ -54,17 +54,18 @@ httmRender(pHtSession s, pWgtrNode tree, int z) int auto_reset = 0; int auto_start = 1; - if(!s->Capabilities.Dom0NS && !s->Capabilities.Dom1HTML) + /** Verify browser capabilities. **/ + if (!s->Capabilities.Dom1HTML || !s->Capabilities.Dom2CSS) { - mssError(1,"HTTM","Netscape 4.x or W3C DOM support required"); - return -1; + mssError(1, "HTTERM", "Unsupported browser: W3C DOM1 HTML and DOM2 CSS support required."); + goto err; } /** Get msec for timer countdown **/ if (wgtrGetPropertyValue(tree,"msec",DATA_T_INTEGER,POD(&msec)) != 0) { mssError(1,"HTTM","Timer widget must have 'msec' time specified"); - return -1; + goto err; } /** Get auto reset and auto start settings **/ @@ -72,13 +73,14 @@ httmRender(pHtSession s, pWgtrNode tree, int z) if (wgtrGetPropertyValue(tree,"auto_start",DATA_T_INTEGER,POD(&auto_start)) != 0) auto_start = 1; /** Get name **/ - if (wgtrGetPropertyValue(tree,"name",DATA_T_STRING,POD(&ptr)) != 0) return -1; + if (wgtrGetPropertyValue(tree,"name",DATA_T_STRING,POD(&ptr)) != 0) goto err; strtcpy(name,ptr,sizeof(name)); - htrAddScriptInclude(s, "/sys/js/htdrv_timer.js", 0); + /** Write JS include. **/ + if (htrAddScriptInclude(s, "/sys/js/htdrv_timer.js", 0) != 0) goto err; /** Script initialization call. **/ - htrAddScriptInit_va(s, + if (htrAddScriptInit_va(s, "\ttm_init({ " "node:wgtrGetNodeRef(ns, '%STR&SYM'), " "time:%INT, " @@ -86,12 +88,24 @@ httmRender(pHtSession s, pWgtrNode tree, int z) "autostart:%INT, " "});\n", name, msec, auto_reset, auto_start - ); + ) != 0) + { + mssError(0, "HTTM", "Failed to write JS init call."); + goto err; + } - /** Check for objects within the timer. **/ - htrRenderSubwidgets(s, tree, z+2); + /** Render children. **/ + if (htrRenderSubwidgets(s, tree, z + 2) != 0) goto err; - return 0; + /** Success. **/ + return 0; + + err: + mssError(0, "HTTM", + "Failed to render \"%s\":\"%s\".", + tree->Name, tree->Type + ); + return -1; } diff --git a/centrallix/htmlgen/htdrv_treeview.c b/centrallix/htmlgen/htdrv_treeview.c index 7911264b6..adfe017e8 100644 --- a/centrallix/htmlgen/htdrv_treeview.c +++ b/centrallix/htmlgen/htdrv_treeview.c @@ -69,43 +69,42 @@ httreeRender(pHtSession s, pWgtrNode tree, int z) char hfgcolor[64]; char selected_bg[128]; int x,y,w; - int id, i; int show_root = 1; int show_branches = 1; int show_root_branch = 1; int use_3d_lines; int order_desc = 0; - pWgtrNode sub_tree; - if(!s->Capabilities.Dom0NS && !s->Capabilities.Dom0IE && !(s->Capabilities.Dom1HTML && s->Capabilities.Dom2CSS)) + /** Get an id for this. **/ + const int id = (HTTREE.idcnt++); + + /** Verify browser capabilities. **/ + if (!s->Capabilities.Dom1HTML || !s->Capabilities.Dom2CSS) { - mssError(1,"HTTREE","Netscape DOM or W3C DOM1 HTML and DOM2 CSS support required"); - return -1; + mssError(1, "HTTERM", "Unsupported browser: W3C DOM1 HTML and DOM2 CSS support required."); + goto err; } - /** Get an id for this. **/ - id = (HTTREE.idcnt++); - /** Get x,y,w,h of this object **/ if (wgtrGetPropertyValue(tree,"x",DATA_T_INTEGER,POD(&x)) != 0) { mssError(1,"HTTREE","TreeView widget must have an 'x' property"); - return -1; + goto err; } if (wgtrGetPropertyValue(tree,"y",DATA_T_INTEGER,POD(&y)) != 0) { mssError(1,"HTTREE","TreeView widget must have a 'y' property"); - return -1; + goto err; } if (wgtrGetPropertyValue(tree,"width",DATA_T_INTEGER,POD(&w)) != 0) { mssError(1,"HTTREE","TreeView widget must have a 'width' property"); - return -1; + goto err; } /** Are we showing root of tree or the trunk? **/ show_root = htrGetBoolean(tree, "show_root", 1); - if (show_root < 0) return -1; + if (show_root < 0) goto err; /** How about branches? (branch decorations, etc.) **/ show_branches = htrGetBoolean(tree, "show_branches", 1); @@ -136,7 +135,7 @@ httreeRender(pHtSession s, pWgtrNode tree, int z) } /** Get name **/ - if (wgtrGetPropertyValue(tree,"name",DATA_T_STRING,POD(&ptr)) != 0) return -1; + if (wgtrGetPropertyValue(tree,"name",DATA_T_STRING,POD(&ptr)) != 0) goto err; strtcpy(name,ptr,sizeof(name)); /** Selected item background color **/ @@ -165,31 +164,12 @@ httreeRender(pHtSession s, pWgtrNode tree, int z) if (wgtrGetPropertyValue(tree,"source",DATA_T_STRING,POD(&ptr)) != 0) { mssError(1,"HTTREE","TreeView widget must have a 'source' property"); - return -1; + goto err; } strtcpy(src,ptr,sizeof(src)); - /** Ok, write the style header items. **/ - if (s->Capabilities.Dom0NS) - { - htrAddStylesheetItem_va(s, - "\t\t#tv%POSroot { " - "position:absolute; " - "visibility:%STR; " - "left:"ht_flex_format"; " - "top:"ht_flex_format"; " - "width:"ht_flex_format"; " - "z-index:%POS; " - "}\n", - id, - (show_root) ? "inherit" : "hidden", - ht_flex_x(x, tree), - ht_flex_y(y, tree), - ht_flex_w(w, tree), - z - ); - } - htrAddStylesheetItem_va(s, + /** Write CSS. **/ + if (htrAddStylesheetItem_va(s, "\t\t#tv%POSload { " "position:absolute; " "visibility:hidden; " @@ -198,29 +178,49 @@ httreeRender(pHtSession s, pWgtrNode tree, int z) "top:0px; " "width:0px; " "height:0px; " - "clip-path:inset(0px 0px 0px 0px); " "z-index:0; " "}\n", id - ); - htrAddStylesheetItem_va(s, "\t\tdiv.tv%POS a { %[color:%STR&CSSVAL;%] }\n", id, (*fgcolor), fgcolor); - htrAddStylesheetItem_va(s, "\t\tdiv.tv%POSh a { %[color:%STR&CSSVAL;%] }\n", id, (*hfgcolor), hfgcolor); - htrAddStylesheetItem_va(s, - "\t\t.tv%POS { " - "cursor:pointer; " - "}\n", + ) != 0) + { + mssError(0, "HTTREE", "Failed to write treeview loader CSS."); + goto err; + } + if (htrAddStylesheetItem_va(s, + "\t\tdiv.tv%POS a { %[color:%STR&CSSVAL;%] }\n" + "\t\tdiv.tv%POSh a { %[color:%STR&CSSVAL;%] }\n" + "\t\t.tv%POS { cursor:pointer; }\n", + id, (*fgcolor), fgcolor, + id, (*hfgcolor), hfgcolor, id - ); + ) != 0) + { + mssError(0, "HTTREE", "Failed to write treeview entry CSS."); + goto err; + } + + /** Link the widget to the DOM node. **/ + if (htrAddWgtrObjLinkage_va(s, tree, "tv%POSroot", id) != 0) goto err; /** Write globals for internal use **/ - htrAddScriptGlobal(s, "tv_tgt_layer", "null", 0); - htrAddScriptGlobal(s, "tv_target_img","null",0); - htrAddScriptGlobal(s, "tv_layer_cache","null",0); - htrAddScriptGlobal(s, "tv_alloc_cnt","0",0); - htrAddScriptGlobal(s, "tv_cache_cnt","0",0); + if (htrAddScriptGlobal(s, "tv_alloc_cnt", "0", 0) != 0) goto err; + if (htrAddScriptGlobal(s, "tv_cache_cnt", "0", 0) != 0) goto err; + if (htrAddScriptGlobal(s, "tv_layer_cache", "null", 0) != 0) goto err; + if (htrAddScriptGlobal(s, "tv_target_img", "null", 0) != 0) goto err; + if (htrAddScriptGlobal(s, "tv_tgt_layer", "null", 0) != 0) goto err; - /** DOM Linkage on client **/ - htrAddWgtrObjLinkage_va(s, tree, "tv%POSroot",id); + /** Write JS script includes. **/ + if (htrAddScriptInclude(s, "/sys/js/ht_utils_info.js", 0) != 0) goto err; + if (htrAddScriptInclude(s, "/sys/js/ht_utils_string.js", 0) != 0) goto err; + if (htrAddScriptInclude(s, "/sys/js/htdrv_treeview.js", 0) != 0) goto err; + + /** Add the event handling scripts **/ + if (htrAddEventHandlerFunction(s, "document", "CLICK", "tv", "tv_click") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "MOUSEDOWN", "tv", "tv_mousedown") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "MOUSEMOVE", "tv", "tv_mousemove") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "MOUSEOUT", "tv", "tv_mouseout") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "MOUSEOVER", "tv", "tv_mouseover") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "MOUSEUP", "tv", "tv_mouseup") != 0) goto err; /** Script initialization call. **/ htrAddScriptInit_va(s, "\t{ " @@ -244,72 +244,54 @@ httreeRender(pHtSession s, pWgtrNode tree, int z) icon, selected_bg, order_desc ); - /** Script includes **/ - htrAddScriptInclude(s, "/sys/js/htdrv_treeview.js", 0); - htrAddScriptInclude(s, "/sys/js/ht_utils_string.js", 0); - htrAddScriptInclude(s, "/sys/js/ht_utils_info.js", 0); - - /** HTML body
elements for the layers. **/ - if (s->Capabilities.Dom0NS) + /** Write HTML. **/ + if (htrAddBodyItem_va(s, + "
" + "" + " %STR&HTE" + "
\n", + id, /* class */ + id, /* id */ + (show_root) ? "inherit" : "hidden", + ht_flex_x(x, tree), + ht_flex_y(y, tree), + ht_flex_w(w, tree), + z, + (*icon) ? icon : "/sys/images/ico02b.gif", src + ) != 0) { - htrAddBodyItem_va(s, "
 %STR&HTE
\n", id, id, (*icon)?icon:"/sys/images/ico02b.gif", src); - htrAddBodyItem_va(s, "
\n",id); + mssError(0, "HTTREE", "Failed to write HTML for treeview root."); + goto err; } - else + if (htrAddBodyItemLayer_va(s, HTR_LAYER_F_DYNAMIC, "tv%POSload", id, NULL, "") != 0) { - htrAddBodyItem_va(s, - "
" - "" - " %STR&HTE" - "
\n", - id, /* class */ - id, /* id */ - (show_root) ? "inherit" : "hidden", - ht_flex_x(x, tree), - ht_flex_y(y, tree), - ht_flex_w(w, tree), - z, - (*icon) ? icon : "/sys/images/ico02b.gif", src - ); - htrAddBodyItemLayer_va(s, HTR_LAYER_F_DYNAMIC, "tv%POSload", id, NULL, ""); + mssError(0, "HTTREE", "Failed to write HTML for treeview loader."); + goto err; } - /** Event handler for click-on-url **/ - htrAddEventHandlerFunction(s, "document","CLICK","tv","tv_click"); + /** Render children. **/ + if (htrRenderSubwidgets(s, tree, z + 2) != 0) goto err; - /** Add the event handling scripts **/ - htrAddEventHandlerFunction(s, "document","MOUSEDOWN","tv","tv_mousedown"); - htrAddEventHandlerFunction(s, "document","MOUSEUP","tv","tv_mouseup"); - htrAddEventHandlerFunction(s,"document","MOUSEOVER","tv","tv_mouseover"); - htrAddEventHandlerFunction(s,"document","MOUSEMOVE","tv","tv_mousemove"); - htrAddEventHandlerFunction(s,"document","MOUSEOUT","tv", "tv_mouseout"); - - /** Check for more sub-widgets within the treeview. **/ - for (i=0;iChildren));i++) - { - sub_tree = xaGetItem(&(tree->Children), i); - /*if (wgtrGetPropertyValue(sub_tree, "outer_type", DATA_T_STRING, POD(&ptr)) == 0 && !strcmp(ptr, "widget/osrc-rule")) - { - httree_internal_AddRule(s, tree, name, sub_tree); - } - else - {*/ - htrRenderWidget(s, sub_tree, z+2); - /*}*/ - } + /** Success. **/ + return 0; - return 0; + err: + mssError(0, "HTTM", + "Failed to render \"%s\":\"%s\".", + tree->Name, tree->Type + ); + return -1; } diff --git a/centrallix/htmlgen/htdrv_uawindow.c b/centrallix/htmlgen/htdrv_uawindow.c index e6ba21537..b6cfd90d7 100644 --- a/centrallix/htmlgen/htdrv_uawindow.c +++ b/centrallix/htmlgen/htdrv_uawindow.c @@ -69,9 +69,11 @@ htuawinRender(pHtSession s, pWgtrNode tree, int z) /** Share this window with other references in the same session context? (no) **/ is_shared = htrGetBoolean(tree, "shared", 0); + if (is_shared < 0) goto err; /** Allow multiple instances of the window? (no) **/ is_multi = htrGetBoolean(tree, "multiple_instantiation", 0); + if (is_multi < 0) goto err; /** Routing of actions to windows when there are multiple of them **/ if (wgtrGetPropertyValue(tree, "action_routing", DATA_T_STRING, POD(&ptr)) == 0) @@ -81,13 +83,13 @@ htuawinRender(pHtSession s, pWgtrNode tree, int z) else if (!strcmp(ptr, "all")) action_routing = 2; else { - mssError(1, "HTUAWIN", "Invalid action_routing '%s' for widget '%s'", ptr, name); - return -1; + mssError(1, "HTUAWIN", "Invalid action_routing: \"%s\"", ptr); + goto err; } } /** widget init **/ - htrAddScriptInit_va(s, + if (htrAddScriptInit_va(s, "\tuw_init(wgtrGetNodeRef(ns, '%STR&SYM'), { " "shared:%INT, " "multi:%INT, " @@ -97,18 +99,30 @@ htuawinRender(pHtSession s, pWgtrNode tree, int z) "h:%INT, " "});\n", name, is_shared, is_multi, action_routing, path, width, height - ); + ) != 0) + { + mssError(1, "HTUAWIN", "Failed to write JS init call."); + goto err; + } /** JavaScript include file **/ - htrAddScriptInclude(s, "/sys/js/htdrv_uawindow.js", 0); + if (htrAddScriptInclude(s, "/sys/js/htdrv_uawindow.js", 0) != 0) goto err; - /** object linkages **/ - htrAddWgtrCtrLinkage(s, tree, "_parentctr"); + /** Link the widget to its container. **/ + if (htrAddWgtrCtrLinkage(s, tree, "_parentctr") != 0) goto err; - /** Check for more sub-widgets within the vbl entity. **/ - htrRenderSubwidgets(s, tree, z+2); + /** Render children. **/ + if (htrRenderSubwidgets(s, tree, z + 2) != 0) goto err; - return 0; + /** Success. **/ + return 0; + + err: + mssError(0, "HTUAWIN", + "Failed to render \"%s\":\"%s\".", + tree->Name, tree->Type + ); + return -1; } diff --git a/centrallix/htmlgen/htdrv_variable.c b/centrallix/htmlgen/htdrv_variable.c index 87b34afa5..0766d3b42 100644 --- a/centrallix/htmlgen/htdrv_variable.c +++ b/centrallix/htmlgen/htdrv_variable.c @@ -51,8 +51,7 @@ htvblRender(pHtSession s, pWgtrNode tree, int z) char name[64]; char fieldname[HT_FIELDNAME_SIZE]; char form[64]; - int t; - int i; + int rval = -1; int n = 0; char* vptr = NULL; int is_null = 1; @@ -73,7 +72,7 @@ htvblRender(pHtSession s, pWgtrNode tree, int z) form[0]='\0'; /** Value of label **/ - t = wgtrGetPropertyType(tree,"value"); + int t = wgtrGetPropertyType(tree,"value"); if (t < 0 || t >= OBJ_TYPE_NAMES_CNT) { t = DATA_T_ANY; @@ -95,7 +94,7 @@ htvblRender(pHtSession s, pWgtrNode tree, int z) } /** widget init **/ - htrAddScriptInit_va(s, + if (htrAddScriptInit_va(s, "\tvbl_init(wgtrGetNodeRef(ns, '%STR&SYM'), { " "type:'%STR&JSSTR', " "value:%['%STR&JSSTR'%]%[%INT%]%[null%], " @@ -108,23 +107,38 @@ htvblRender(pHtSession s, pWgtrNode tree, int z) (!is_null && t == DATA_T_INTEGER), n, (is_null), fieldname, form - ); + ) != 0) + { + mssError(1, "HTVBL", "Failed to write JS init call."); + goto end; + } /** JavaScript include file **/ - htrAddScriptInclude(s, "/sys/js/htdrv_variable.js", 0); - htrAddScriptInclude(s, "/sys/js/ht_utils_hints.js", 0); + if (htrAddScriptInclude(s, "/sys/js/ht_utils_hints.js", 0) != 0) goto end; + if (htrAddScriptInclude(s, "/sys/js/htdrv_variable.js", 0) != 0) goto end; /** object linkages **/ - htrAddWgtrCtrLinkage(s, tree, "_parentctr"); + if (htrAddWgtrCtrLinkage(s, tree, "_parentctr") != 0) goto end; /** Check for more sub-widgets within the vbl entity. **/ - htrRenderSubwidgets(s, tree, z+2); + if (htrRenderSubwidgets(s, tree, z + 2) != 0) goto end; - /** Clean up. **/ - if (vptr) - nmSysFree(vptr); + /** Success. **/ + rval = 0; - return 0; + end: + if (rval != 0) + { + mssError(0, "HTVBL", + "Failed to render \"%s\":\"%s\".", + tree->Name, tree->Type + ); + } + + /** Clean up. **/ + if (vptr != NULL) nmSysFree(vptr); + + return rval; } diff --git a/centrallix/htmlgen/htdrv_window.c b/centrallix/htmlgen/htdrv_window.c index e7808fd8a..9dd5ed38d 100644 --- a/centrallix/htmlgen/htdrv_window.c +++ b/centrallix/htmlgen/htdrv_window.c @@ -61,7 +61,6 @@ htwinRender(pHtSession s, pWgtrNode tree, int z) { char* ptr; char name[64]; - int id, i; int visible = 1; char background_style[128] = ""; char header_background_style[128] = ""; @@ -71,7 +70,6 @@ htwinRender(pHtSession s, pWgtrNode tree, int z) int is_dialog_style = 0; int gshade = 0; int closetype = 0; - int box_offset = 1; int is_toplevel = 0; int is_modal = 0; char icon[128]; @@ -82,21 +80,16 @@ htwinRender(pHtSession s, pWgtrNode tree, int z) char border_style[32]; int border_width; - if(!(s->Capabilities.Dom0NS || s->Capabilities.Dom1HTML)) - { - mssError(1,"HTWIN","Netscape DOM support or W3C DOM Level 1 support required"); - return -1; - } + /** Get an id for this. **/ + const int id = (HTWIN.idcnt++); - /** IE puts css box borders inside box width/height **/ - if (!s->Capabilities.CSSBox) + /** Verify browser capabilities. **/ + if (!s->Capabilities.Dom1HTML || !s->Capabilities.Dom2CSS) { - box_offset = 0; + mssError(1, "HTTERM", "Unsupported browser: W3C DOM1 HTML and DOM2 CSS support required."); + goto err; } - /** Get an id for this. **/ - id = (HTWIN.idcnt++); - /** Get x,y,w,h of this object **/ int x, y, w, h; if (wgtrGetPropertyValue(tree,"x",DATA_T_INTEGER,POD(&x)) != 0) x = 0; @@ -214,7 +207,7 @@ htwinRender(pHtSession s, pWgtrNode tree, int z) /*** We don't even bother making these styles flex responsively because *** they will be overwritten by the JS anyway. ***/ - htrAddStylesheetItem_va(s, + if (htrAddStylesheetItem_va(s, "\t\t#wn%POSbase { " "position:absolute; " "visibility:%STR; " @@ -231,20 +224,21 @@ htwinRender(pHtSession s, pWgtrNode tree, int z) "}\n", id, (visible) ? "inherit" : "hidden", - x, - y, - w - 2 * box_offset, - h - 2 * box_offset, + x, y, w, h, z + 100, border_style, border_width, border_color, border_radius - ); + ) != 0) + { + mssError(0, "HTWIN", "Failed to write CSS for window base."); + goto err; + } if (shadow_radius > 0) { double shadow_angle_radians = (double)shadow_angle * M_PI/180; - htrAddStylesheetItem_va(s, + if (htrAddStylesheetItem_va(s, "\t\t#wn%POSbase { " "box-shadow: " "%DBLpx " @@ -256,7 +250,11 @@ htwinRender(pHtSession s, pWgtrNode tree, int z) cos(shadow_angle_radians) * (-shadow_offset), shadow_radius, shadow_color - ); + ) != 0) + { + mssError(0, "HTWIN", "Failed to write CSS for window shadow."); + goto err; + } } /** inner structure depends on dialog vs. window style **/ @@ -274,13 +272,13 @@ htwinRender(pHtSession s, pWgtrNode tree, int z) else { /** window inner container -- window **/ - main_width = w - 2 * (box_offset + 1); - main_height = h - title_bar_height - (box_offset + 1) * ((has_titlebar) ? 1 : 2); - clip_height = h - title_bar_height + ((has_titlebar) ? 1 : 0) - 2 * box_offset; + main_width = w - 2; + main_height = h - title_bar_height - 1 * ((has_titlebar) ? 1 : 2); + clip_height = h - title_bar_height + ((has_titlebar) ? 1 : 0); dialogue_width = 1; border_color_str = "gray white white gray"; } - htrAddStylesheetItem_va(s, + if (htrAddStylesheetItem_va(s, "\t\t#wn%POSmain { " "position:absolute; " "visibility:inherit; " @@ -305,39 +303,42 @@ htwinRender(pHtSession s, pWgtrNode tree, int z) (has_titlebar) ? 1 : 0, dialogue_width, dialogue_width, dialogue_width, z + 1, background_style - ); + ) != 0) + { + mssError(0, "HTWIN", "Failed to write CSS for window main container."); + goto err; + } - /** Write globals for internal use **/ - htrAddScriptGlobal(s, "wn_top_z","10000",0); - htrAddScriptGlobal(s, "wn_list","[]",0); - htrAddScriptGlobal(s, "wn_current","null",0); - htrAddScriptGlobal(s, "wn_newx","null",0); - htrAddScriptGlobal(s, "wn_newy","null",0); - htrAddScriptGlobal(s, "wn_topwin","null",0); - htrAddScriptGlobal(s, "wn_msx","null",0); - htrAddScriptGlobal(s, "wn_msy","null",0); - htrAddScriptGlobal(s, "wn_moved","0",0); - htrAddScriptGlobal(s, "wn_clicked","0",0); + /** Write JS globals and includes. **/ + if (htrAddScriptGlobal(s, "wn_clicked", "0", 0) != 0) goto err; + if (htrAddScriptGlobal(s, "wn_current", "null", 0) != 0) goto err; + if (htrAddScriptGlobal(s, "wn_list", "[]", 0) != 0) goto err; + if (htrAddScriptGlobal(s, "wn_moved", "0", 0) != 0) goto err; + if (htrAddScriptGlobal(s, "wn_msx", "null", 0) != 0) goto err; + if (htrAddScriptGlobal(s, "wn_msy", "null", 0) != 0) goto err; + if (htrAddScriptGlobal(s, "wn_newx", "null", 0) != 0) goto err; + if (htrAddScriptGlobal(s, "wn_newy", "null", 0) != 0) goto err; + if (htrAddScriptGlobal(s, "wn_top_z", "10000", 0) != 0) goto err; + if (htrAddScriptGlobal(s, "wn_topwin", "null", 0) != 0) goto err; + if (htrAddScriptInclude(s, "/sys/js/ht_utils_layers.js", 0) != 0) goto err; + if (htrAddScriptInclude(s, "/sys/js/htdrv_window.js", 0) != 0) goto err; /** DOM Linkages **/ - htrAddWgtrObjLinkage_va(s, tree, "wn%POSbase", id); - htrAddWgtrCtrLinkage_va(s, tree, "htr_subel(_obj, \"wn%POSmain\")",id); - - htrAddScriptInclude(s, "/sys/js/htdrv_window.js", 0); - htrAddScriptInclude(s, "/sys/js/ht_utils_layers.js", 0); + if (htrAddWgtrObjLinkage_va(s, tree, "wn%POSbase", id) != 0) goto err; + if (htrAddWgtrCtrLinkage_va(s, tree, "htr_subel(_obj, 'wn%POSmain')", id) != 0) goto err; /** Event handler for mousedown/up/click/etc **/ - htrAddEventHandlerFunction(s, "document", "MOUSEDOWN", "wn", "wn_mousedown"); - htrAddEventHandlerFunction(s, "document", "MOUSEUP", "wn", "wn_mouseup"); - htrAddEventHandlerFunction(s, "document", "DBLCLICK", "wn", "wn_dblclick"); + if (htrAddEventHandlerFunction(s, "document", "DBLCLICK", "wn", "wn_dblclick") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "MOUSEDOWN", "wn", "wn_mousedown") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "MOUSEUP", "wn", "wn_mouseup") != 0) goto err; /** Mouse move event handler -- when user drags the window **/ - htrAddEventHandlerFunction(s, "document", "MOUSEMOVE", "wn", "wn_mousemove"); - htrAddEventHandlerFunction(s, "document", "MOUSEOVER", "wn", "wn_mouseover"); - htrAddEventHandlerFunction(s, "document", "MOUSEOUT", "wn", "wn_mouseout"); + if (htrAddEventHandlerFunction(s, "document", "MOUSEMOVE", "wn", "wn_mousemove") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "MOUSEOVER", "wn", "wn_mouseover") != 0) goto err; + if (htrAddEventHandlerFunction(s, "document", "MOUSEOUT", "wn", "wn_mouseout") != 0) goto err; /** Script initialization call. **/ - htrAddScriptInit_va(s, + if (htrAddScriptInit_va(s, "\twn_init({ " "mainlayer:wgtrGetNodeRef(ns, '%STR&SYM'), " "clayer:wgtrGetContainer(wgtrGetNodeRef(ns, '%STR&SYM')), " @@ -354,14 +355,22 @@ htwinRender(pHtSession s, pWgtrNode tree, int z) closetype, is_toplevel, is_modal - ); + ) != 0) + { + mssError(0, "HTWIN", "Failed to write JS init call."); + goto err; + } /** Write HTML for the child window. **/ - htrAddBodyItem_va(s, "
\n", id); + if (htrAddBodyItem_va(s, "
\n", id) != 0) + { + mssError(0, "HTWIN", "Failed to write HTML for window container."); + goto err; + } if (has_titlebar) { - /** Write styles and HTML for the title bar. **/ - htrAddStylesheetItem_va(s, + /** Write CSS and HTML for the title bar. **/ + if (htrAddStylesheetItem_va(s, "\t\t#wn%POStitlebar { " "position:absolute; " "visibility:inherit; " @@ -379,12 +388,16 @@ htwinRender(pHtSession s, pWgtrNode tree, int z) "%STR" "}\n", id, - title_bar_height - 1 - box_offset, + title_bar_height - 1, z + 1, text_color, header_background_style - ); - htrAddBodyItem_va(s, + ) != 0) + { + mssError(0, "HTWIN", "Failed to write styles for window title bar."); + goto err; + } + if (htrAddBodyItem_va(s, "
" "" "
%STR&HTE
" @@ -393,27 +406,35 @@ htwinRender(pHtSession s, pWgtrNode tree, int z) id, icon, text_color, title - ); + ) != 0) + { + mssError(0, "HTWIN", "Failed to write HTML for window title bar."); + goto err; + } } - /** Write HTML for child widgets in the window. **/ - htrAddBodyItem_va(s,"
\n",id); - for (i=0;iChildren));i++) + /** Render child widgets inside window container. **/ + if (htrAddBodyItem_va(s,"
\n",id) != 0) { - /** TODO: Israel - Rewrite this using util.h, once its updated from the dups branch. **/ - const pWgtrNode child = xaGetItem(&(tree->Children), i); - const int ret = htrRenderWidget(s, child, z + 2); - if (ret != 0) - { - mssError(0, "HTWIN", - "Failed to render child widget '%s:%s' with error code %d.", - child->Namespace, child->Name, ret - ); - } + mssError(0, "HTWIN", "Failed to write HTML opening tag for window container."); + goto err; + } + if (htrRenderSubwidgets(s, tree, z + 2) != 0) goto err; + if (htrAddBodyItem(s,"
\n") != 0) + { + mssError(0, "HTWIN", "Failed to write HTML closing tag for window container."); + goto err; } - htrAddBodyItem(s,"
\n"); - return 0; + /** Success. **/ + return 0; + + err: + mssError(0, "HTWIN", + "Failed to render \"%s\":\"%s\".", + tree->Name, tree->Type + ); + return -1; } From aac0a42800b41dcdafb21e6feecb24b5a0cffab8 Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Thu, 23 Apr 2026 15:09:35 -0600 Subject: [PATCH 249/275] Update error page. Clean up and reformat error page code. Clear the error after the error page handles it. Fix bug where a malformed page was written after the error page. --- centrallix/htmlgen/ht_render.c | 38 +++++++++++++++++++++++++++------- 1 file changed, 30 insertions(+), 8 deletions(-) diff --git a/centrallix/htmlgen/ht_render.c b/centrallix/htmlgen/ht_render.c index 13b15fc99..7351d4700 100644 --- a/centrallix/htmlgen/ht_render.c +++ b/centrallix/htmlgen/ht_render.c @@ -2164,15 +2164,36 @@ htrRender(void* stream, int (*stream_write)(void*, char*, int, int, int), pObjSe /** Could not render? **/ - if (rval < 0) + if (UNLIKELY(rval < 0)) { - err_xs = xsNew(); - if (err_xs) - { - mssStringError(err_xs); - htrQPrintf(s, "Error

An Error occurred while attempting to render this document


%STR&HTE
\r\n", xsString(err_xs)); - xsFree(err_xs); - } + /** Get the error string. **/ + pXString err_xs = check_ptr(xsNew()); + if (err_xs == NULL) goto end_free; + mssStringError(err_xs); + + /** Write an error HTML for the user. **/ + htrQPrintf(s, + "" + "" + "" + "Error" + "" + "" + "" + "

An Error occurred while attempting to render this document

" + "
" + "
%STR&HTE
" + "" + "\n", + xsString(err_xs) + ); + xsFree(err_xs); + + /** Mark error as recovered. **/ + mssClearError(); + + /** Done writing. **/ + goto end_free; } /** Output the DOCTYPE for browsers supporting HTML 4.0 -- this will make them use HTML 4.0 Strict **/ @@ -2416,6 +2437,7 @@ htrRender(void* stream, int (*stream_write)(void*, char*, int, int, int), pObjSe htrWrite(s, "\n\n",-1); } + end_free: /** Deinitialize the session and page structures **/ for(i=0;iPage.Functions.nItems;i++) { From a81f19b4b52de4850f4d62a4b4ea503e7c2ace3c Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Thu, 23 Apr 2026 16:10:53 -0600 Subject: [PATCH 250/275] Fix bugs and clean up. Fix a bug that caused htrGetBackground() to always return an error. Fix a memory error in the image widget. Fix window widget resizing using its own widget list that sometimes wasn't updated by switching to use the preexisting widget list. Fix label pointer style. Fix the registered name of the MultiScroll widget. Add doc comments to a few functions. Add more comments to clarify code. Improve a couple error and warning messages. Improve ht_get_parent_w/h__INTERNAL() functions with more modern practices. Remove unused id counter in the repeat widget. Add a ... to loading image alt text. Update copyright notices. Remove unused code and comments. Simplify and clarify comments. --- centrallix-os/sys/js/ht_geom_dom1html.js | 18 ++---- centrallix-os/sys/js/htdrv_window.js | 38 ++---------- centrallix/htmlgen/ht_render.c | 74 ++++++++++++++---------- centrallix/htmlgen/htdrv_formbar.c | 2 +- centrallix/htmlgen/htdrv_image.c | 16 ++--- centrallix/htmlgen/htdrv_label.c | 2 +- centrallix/htmlgen/htdrv_multiscroll.c | 2 +- centrallix/htmlgen/htdrv_page.c | 2 +- centrallix/htmlgen/htdrv_repeat.c | 9 --- centrallix/netdrivers/net_http_app.c | 2 +- 10 files changed, 65 insertions(+), 100 deletions(-) diff --git a/centrallix-os/sys/js/ht_geom_dom1html.js b/centrallix-os/sys/js/ht_geom_dom1html.js index 0ebc5afc8..7c76dd875 100644 --- a/centrallix-os/sys/js/ht_geom_dom1html.js +++ b/centrallix-os/sys/js/ht_geom_dom1html.js @@ -11,7 +11,7 @@ // Cross browser Geometry DOM1HTML -// Add some useful functions to Math that will be needed elsewhere. +// Add useful Math functions. Math.clamp = (min, val, max) => Math.min(Math.max(min, val), max); Math.isBetween = (lowerBound, num, upperBound) => (lowerBound < num && num < upperBound); @@ -271,16 +271,6 @@ function getParentH(l) return getParentSize(l).height; } - -/*** Problem: - *** If the programmer calls setRelativeX() (or a similar function, such as moveTo() or moveBy()), - *** they might be using a value they got from the server, based on the resolution when the page - *** was first loaded. However, they might also be using a value they got dynamically by calling - *** some function to check the actual size of an element. Previously, this distinction did not - *** matter because these values would be the same. However, now that pages can be resized on the - *** client, it does matter. - ***/ - /*** We ignore the current value of __pg_left in the following functions even *** though it might be correct and faster than querying the DOM. However, the @@ -329,7 +319,7 @@ function setRelativeH(l, value) { return setRelative(l, value, 'height'); } *** generated adaptive layout. It is RECOMMENDED to call a specific sub- *** function (aka. setResponsiveX(), setResponsiveY(), etc.) instead of *** calling this function directly to avoid passing dimension directly. - *** + *** *** WARNING: Ensure that any value passed is calculated ENTIRELY using *** values from the server (e.g. widget properties) and no values from *** real page dimensions are used, as these change when the page is @@ -348,7 +338,7 @@ function setResponsive(l, value, d) { /** Server-layout values are always numbers. **/ if (typeof(value) !== 'number') { - console.warn(`setResponsive(${l.id}, ?, '${d}'): Expected value to be a parseable number but got:`, value); + console.warn(`setResponsive(${l.id}, ?, '${d}'): Expected a parseable number but got:`, value); return value; } @@ -484,7 +474,7 @@ function getHeight(l) return getClipHeight(l); } -// Copyright (C) 1998-2001 LightSys Technology Services, Inc. +// Copyright (C) 1998-2026 LightSys Technology Services, Inc. // // You may use these files and this library under the terms of the // GNU Lesser General Public License, Version 2.1, contained in the diff --git a/centrallix-os/sys/js/htdrv_window.js b/centrallix-os/sys/js/htdrv_window.js index 83302ad9a..6f8459f79 100644 --- a/centrallix-os/sys/js/htdrv_window.js +++ b/centrallix-os/sys/js/htdrv_window.js @@ -9,14 +9,10 @@ // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU Lesser General Public License for more details. -//$(".wn") - -// An array of all initialized windows on the page. -const wn_windows = []; // Resize listener that updates all windows so they remain on the page by // re-calling wn_do_move_internal() with whatever values were last used. -window.addEventListener('resize', () => wn_windows.forEach((wn) => { +window.addEventListener('resize', () => wn_list.forEach((wn) => { const { pg_attract, wn_new_x, wn_new_y } = wn.resize_data; wn_do_move_internal(wn, pg_attract, wn_new_x, wn_new_y); })); @@ -165,9 +161,6 @@ function wn_init(param) l.showcontainer = wn_showcontainer; if (l.is_modal && l.is_visible) pg_setmodal(l, true); - - // Add the window to the global window list. - wn_windows.push(l); return l; } @@ -550,7 +543,6 @@ function wn_close(l) { if (l.is_modal) pg_setmodal(l, false); if (wn_popped[l.id]) delete wn_popped[l.id]; - //l.is_modal = false; l.no_close = false; l.extended_region = null; if (l.popped_above) @@ -562,7 +554,7 @@ function wn_close(l) { wn_close(l.has_popup); } - if (l.closetype == 0 || !cx__capabilities.Dom0NS) + if (l.closetype == 0) { htr_setvisibility(l,'hidden'); $(l).css({display:"none"}); @@ -571,30 +563,8 @@ function wn_close(l) l.is_visible = 0; } else - { - if(cx__capabilities.Dom0NS) - { - st = new Date(); - var speed = 20; - var duration = 150; - var sizeX = 0; - var sizeY = 0; - if (l.closetype & 1) - { - var toX = Math.ceil(getClipWidth(l)/2); - sizeX = Math.ceil(toX*speed/duration); - } - if (l.closetype & 2) - { - var toY = Math.ceil(getClipHeight(l)/2); - sizeY = Math.ceil(toY*speed/duration); - } - wn_graphical_close(l,speed,sizeX,sizeY); - } - else - { - alert("close type " + l.closetype + " is not implimented for this browser"); - } + { + alert("close type " + l.closetype + " is not implemented for this browser"); } } diff --git a/centrallix/htmlgen/ht_render.c b/centrallix/htmlgen/ht_render.c index 7351d4700..d4b668636 100644 --- a/centrallix/htmlgen/ht_render.c +++ b/centrallix/htmlgen/ht_render.c @@ -28,7 +28,7 @@ /* Centrallix Application Server System */ /* Centrallix Core */ /* */ -/* Copyright (C) 1998-2001 LightSys Technology Services, Inc. */ +/* Copyright (C) 1998-2026 LightSys Technology Services, Inc. */ /* */ /* This program is free software; you can redistribute it and/or modify */ /* it under the terms of the GNU General Public License as published by */ @@ -505,8 +505,14 @@ htrRenderWidget(pHtSession session, pWgtrNode widget, int z) } -/*** htrCheckNSTransition -- check to see if we are transitioning between - *** namespaces, and if so, emit the code to switch the context. +/*** Check to see if we are transitioning when we move from the parent's + *** namespace to the child's namespace. If so, write code to switch the + *** namespace context. + *** + *** @param s The current session. + *** @param parent The parent we are moving away from. + *** @param parent The child of the parent we are moving to. + *** @returns 0 if successful, and -1 if an error occurs. ***/ int htrCheckNSTransition(pHtSession s, pWgtrNode parent, pWgtrNode child) @@ -529,8 +535,14 @@ htrCheckNSTransition(pHtSession s, pWgtrNode parent, pWgtrNode child) } -/*** htrCheckNSTransitionReturn -- check to see if we are transitioning between - *** namespaces, and if so, emit the code to switch the context. +/*** Check to see if we are transitioning when we move from the child's + *** namespace back up to the parent's namespace. If so, write code to + *** switch the namespace context. + *** + *** @param s The current session. + *** @param parent The parent we are returning to. + *** @param parent The child we are moving away from. + *** @returns 0 if successful, and -1 if an error occurs. ***/ int htrCheckNSTransitionReturn(pHtSession s, pWgtrNode parent, pWgtrNode child) @@ -898,7 +910,7 @@ htrAddScriptInit_va(pHtSession s, char* fmt, ... ) /*** TODO: Greg - Can we remove this code? It seems like this is the *** concern of htrRender(), and if it's not, should we remove the - *** line from htrRender() that does this? + *** line from htrRender() that also does the same thing? ***/ if (!s->Namespace->HasScriptInits) { @@ -1104,6 +1116,8 @@ htrAddEventHandlerFunction(pHtSession s, char* event_src, char* event, char* drv /** Look it up? ** (GRB note -- is this slow enough to need an XHashTable?) + ** (Israel note -- idk, but it hasn't been a problem over the + ** past 19 years, so it's probably fine.) **/ cnt = xaCount(&s->Page.EventHandlers); for(i=0;iCapabilities.HTML40 && !s->Capabilities.Dom0IE) htrWrite(s, "\n\n", 17); - /** Write the HTML out... **/ + /** Write HTML header comment & license. **/ htrQPrintf(s, "\n\n" , cx__version); + /** Write the start of the HTML document. **/ htrQPrintf(s, "\n" "\n" "\t\n" @@ -2739,7 +2754,7 @@ htrGetBackground(pWgtrNode tree, char* prefix, int as_style, char* buf, int bufl /** Clean up. **/ if (LIKELY(error_session != NULL)) qpfCloseSession(error_session); - return -1; + return rval; } @@ -3313,9 +3328,9 @@ htrFormatElement(pHtSession s, pWgtrNode node, char* id, int flags, int x, int y (h > 0), ht_flex_h(h, node), (z > 0), z, (*textcolor), textcolor, - (!strcmp(style, "bold")), - (!strcmp(style, "underline")), - (!strcmp(style, "italic")), + (strcmp(style, "bold") == 0), + (strcmp(style, "underline") == 0), + (strcmp(style, "italic") == 0), (*font), font, (font_size > 0), font_size, (*bgcolor), bgcolor, @@ -3341,31 +3356,30 @@ htrFormatElement(pHtSession s, pWgtrNode node, char* id, int flags, int x, int y return 0; } - int ht_get_parent_w__INTERNAL(pWgtrNode widget) { - /** Edge case checks. **/ - if (widget == NULL) + /** Guard segfault. **/ + if (UNLIKELY(widget == NULL)) { mssError(1, "HTR", "Failed to get width on NULL widget.\n"); return -1; } + + /** Check for a cached value. **/ + const int cached_value = widget->fl_parent_w; + if (LIKELY(cached_value != -1)) return cached_value; /** Recursion check. **/ - if (thExcessiveRecursion()) + if (UNLIKELY(thExcessiveRecursion())) { mssError(1, "HTR", "Resource exhaustion in ht_get_parent_w__INTERNAL()"); return 0; } - - /** Check for a cached value. **/ - const int cached_value = widget->fl_parent_w; - if (cached_value != -1) return cached_value; /** Check for a width value on the parent. **/ const pWgtrNode parent = widget->Parent; - if (parent == NULL) + if (UNLIKELY(parent == NULL)) { mssError(1, "HTR", "Failed to get parent width on widget \"%s\":\"%s\" because parent is NULL.\n", @@ -3382,27 +3396,27 @@ ht_get_parent_w__INTERNAL(pWgtrNode widget) int ht_get_parent_h__INTERNAL(pWgtrNode widget) { - /** Edge case checks. **/ - if (widget == NULL) + /** Guard segfault. **/ + if (UNLIKELY(widget == NULL)) { mssError(1, "HTR", "Failed to get height on NULL widget.\n"); return -1; } + + /** Check for a cached value. **/ + const int cached_value = widget->fl_parent_h; + if (LIKELY(cached_value != -1)) return cached_value; /** Recursion check. **/ - if (thExcessiveRecursion()) + if (UNLIKELY(thExcessiveRecursion())) { mssError(1, "HTR", "Resource exhaustion in ht_get_parent_h__INTERNAL()"); return 0; } - - /** Check for a cached value. **/ - const int cached_value = widget->fl_parent_h; - if (cached_value != -1) return cached_value; /** Check for a height value on the parent. **/ const pWgtrNode parent = widget->Parent; - if (parent == NULL) + if (UNLIKELY(parent == NULL)) { mssError(1, "HTR", "Failed to get parent height on widget \"%s\":\"%s\" because parent is NULL.\n", @@ -3414,4 +3428,4 @@ ht_get_parent_h__INTERNAL(pWgtrNode widget) return widget->fl_parent_h = (parentHeight >= 0) ? parentHeight - (parent->top + parent->bottom) /* Height found! */ : ht_get_parent_h__INTERNAL(parent); /* Height not found: search recursively. */ - } \ No newline at end of file + } diff --git a/centrallix/htmlgen/htdrv_formbar.c b/centrallix/htmlgen/htdrv_formbar.c index c5961ccb5..95e82e59d 100644 --- a/centrallix/htmlgen/htdrv_formbar.c +++ b/centrallix/htmlgen/htdrv_formbar.c @@ -14,7 +14,7 @@ /* Centrallix Application Server System */ /* Centrallix Core */ /* */ -/* Copyright (C) 2000-2001 LightSys Technology Services, Inc. */ +/* Copyright (C) 2000-2026 LightSys Technology Services, Inc. */ /* */ /* This program is free software; you can redistribute it and/or modify */ /* it under the terms of the GNU General Public License as published by */ diff --git a/centrallix/htmlgen/htdrv_image.c b/centrallix/htmlgen/htdrv_image.c index 15d4c8f75..3f5ca0e2f 100644 --- a/centrallix/htmlgen/htdrv_image.c +++ b/centrallix/htmlgen/htdrv_image.c @@ -90,8 +90,10 @@ htimgRender(pHtSession s, pWgtrNode tree, int z) int rval = -1; char fieldname[HT_FIELDNAME_SIZE]; char form[64]; - char* alt_text; - char* aspect; + char* alt_text = NULL; + char* aspect = NULL; + char* default_alt_text = ""; + char* default_aspect = "stretch"; /** Get an id for this. **/ const int id = (HTIMG.idcnt++); @@ -119,14 +121,12 @@ htimgRender(pHtSession s, pWgtrNode tree, int z) if(wgtrGetPropertyValue(tree,"text",DATA_T_STRING,POD(&ptr)) == 0) alt_text=nmSysStrdup(ptr); - else - alt_text=nmSysStrdup(""); + if (alt_text == NULL) alt_text = default_alt_text; /** Image aspect scaling: stretch or preserve **/ if(wgtrGetPropertyValue(tree,"aspect",DATA_T_STRING,POD(&ptr)) == 0) aspect=nmSysStrdup(ptr); - else - aspect=nmSysStrdup("stretch"); + if (aspect == NULL) aspect = default_aspect; /** Get name **/ if (wgtrGetPropertyValue(tree,"name",DATA_T_STRING,POD(&ptr)) != 0) goto end; @@ -251,8 +251,8 @@ htimgRender(pHtSession s, pWgtrNode tree, int z) } /** Clean up. **/ - if (alt_text != NULL) nmSysFree(alt_text); - if (aspect != NULL) nmSysFree(aspect); + if (alt_text != NULL && alt_text != default_alt_text) nmSysFree(alt_text); + if (aspect != NULL && aspect != default_aspect) nmSysFree(aspect); return rval; } diff --git a/centrallix/htmlgen/htdrv_label.c b/centrallix/htmlgen/htdrv_label.c index 321ff16c3..31bd0d874 100644 --- a/centrallix/htmlgen/htdrv_label.c +++ b/centrallix/htmlgen/htdrv_label.c @@ -202,7 +202,7 @@ htlblRender(pHtSession s, pWgtrNode tree, int z) "\t\t#lbl%POS { " "position:absolute; " "visibility:inherit; " - "cursor:default; " + "cursor:pointer; " "left:"ht_flex_format"; " "top:"ht_flex_format"; " "width:"ht_flex_format"; " diff --git a/centrallix/htmlgen/htdrv_multiscroll.c b/centrallix/htmlgen/htdrv_multiscroll.c index d3b6adb0c..c9f831dfd 100644 --- a/centrallix/htmlgen/htdrv_multiscroll.c +++ b/centrallix/htmlgen/htdrv_multiscroll.c @@ -302,7 +302,7 @@ htmsInitialize() /** Fill in the structure. **/ strcpy(drv->Name,"DHTML MultiScroll Driver"); - strcpy(drv->WidgetName,"multiscroll"); + strcpy(drv->WidgetName,"MultiScroll"); drv->Render = htmsRender; htrAddEvent(drv,"Click"); diff --git a/centrallix/htmlgen/htdrv_page.c b/centrallix/htmlgen/htdrv_page.c index 7c23b7d71..8919c621d 100755 --- a/centrallix/htmlgen/htdrv_page.c +++ b/centrallix/htmlgen/htdrv_page.c @@ -466,7 +466,7 @@ htpageRender(pHtSession s, pWgtrNode tree, int z) htrAddBodyItem_va(s, "", bgstr); htrAddBodyItem (s, "" - "" + "" "
loading
loading...
\n" ); htrAddBodyItemLayerEnd(s,0); diff --git a/centrallix/htmlgen/htdrv_repeat.c b/centrallix/htmlgen/htdrv_repeat.c index 170a3edac..8cd62a994 100644 --- a/centrallix/htmlgen/htdrv_repeat.c +++ b/centrallix/htmlgen/htdrv_repeat.c @@ -43,13 +43,6 @@ /************************************************************************/ -/** Globals **/ - -static struct - { - int idcnt; - } HTRPT; - int htrptRender(pHtSession s, pWgtrNode tree, int z) { @@ -76,8 +69,6 @@ htrptInitialize() /** Allocate the driver **/ drv = htrAllocDriver(); if (!drv) return -1; - - memset(&HTRPT, 0, sizeof(HTRPT)); /** Fill in structure **/ strcpy(drv->Name,"Repeat Object Driver"); diff --git a/centrallix/netdrivers/net_http_app.c b/centrallix/netdrivers/net_http_app.c index 7ea96d90c..c3a4583f3 100644 --- a/centrallix/netdrivers/net_http_app.c +++ b/centrallix/netdrivers/net_http_app.c @@ -86,7 +86,7 @@ nht_i_GetGeom(pObject target_obj, pNhtConn output) " \n" " \n" " \n" - " \n" + " loading...\n" "
x
x
\n" "
xx
\n" " \n" From 52eda99839151c6448f824c19b56209d8ae16a0d Mon Sep 17 00:00:00 2001 From: Lightning11wins Date: Fri, 24 Apr 2026 10:19:47 -0600 Subject: [PATCH 251/275] Fix many HTML validation errors. --- centrallix-os/sys/js/htdrv_dropdown.js | 30 +++++++++++------------- centrallix-os/sys/js/htdrv_editbox.js | 5 ++-- centrallix-os/sys/js/htdrv_menu.js | 26 ++++++++------------ centrallix-os/sys/js/htdrv_scrollpane.js | 28 ++++++++++++++-------- centrallix/htmlgen/ht_render.c | 10 ++++---- centrallix/htmlgen/htdrv_editbox.c | 4 ++-- centrallix/htmlgen/htdrv_imagebutton.c | 8 +++++-- centrallix/htmlgen/htdrv_menu.c | 4 ++-- centrallix/htmlgen/htdrv_page.c | 15 ++++++++---- centrallix/htmlgen/htdrv_scrollpane.c | 17 ++++++++------ centrallix/htmlgen/htdrv_treeview.c | 10 ++++---- centrallix/netdrivers/net_http_app.c | 1 - 12 files changed, 84 insertions(+), 74 deletions(-) diff --git a/centrallix-os/sys/js/htdrv_dropdown.js b/centrallix-os/sys/js/htdrv_dropdown.js index dd0a6aabc..71ae88770 100644 --- a/centrallix-os/sys/js/htdrv_dropdown.js +++ b/centrallix-os/sys/js/htdrv_dropdown.js @@ -720,9 +720,9 @@ function dd_create_pane(l) moveTo(p.BarLayer, l.popup_width-20, 2); htr_setvisibility(p.BarLayer, 'inherit'); c = ''; - c += ''; - c += ''; - c += ''; + c += ''; + c += ''; + c += ''; c += '
up
trans
down
'; htr_write_content(p.BarLayer, c); //pg_serialized_write(p.BarLayer, c, null); @@ -892,14 +892,14 @@ function dd_add_items(l,ary) function dd_mouseout(e) { var ti=dd_target_img; - if (ti && ti.name == 't' && dd_current) + if (ti && ti.dataset.type === 'trans' && dd_current) return EVENT_HALT | EVENT_PREVENT_DEFAULT_ACTION; } function dd_mousemove(e) { var ti=dd_target_img; - if (ti != null && ti.name == 't' && dd_current && dd_current.enabled!='disabled') + if (ti != null && ti.dataset.type === 'trans' && dd_current && dd_current.enabled !== 'disabled') { var pl=ti.mainlayer.PaneLayer; var v=getClipHeight(pl)-(3*18)-4; @@ -952,8 +952,11 @@ function dd_mouseup(e) } if (dd_target_img != null) { - if (dd_target_img.kind && dd_target_img.kind.substr(0,2) == 'dd' && (dd_target_img.name == 'u' || dd_target_img.name == 'd')) - pg_set(dd_target_img,'src',htutil_subst_last(dd_target_img.src,"b.gif")); + if (dd_target_img.kind && dd_target_img.kind.slice(0, 2) === 'dd' + && (dd_target_img.dataset.type === 'up' || dd_target_img.dataset.type === 'down')) + { + pg_set(dd_target_img, 'src', htutil_subst_last(dd_target_img.src, "b.gif")); + } dd_target_img = null; } if ((e.kind == 'dd' || e.kind == 'ddtxt') && e.mainlayer.enabled != 'disabled') @@ -1007,31 +1010,26 @@ function dd_mousedown(e) } else if (e.kind == 'dd_sc') { - switch(e.layer.name) + switch(e.layer.dataset.type) { - case 'u': + case 'up': pg_set(e.layer,'src','/sys/images/ico13c.gif'); dd_incr = 8; dd_scroll(); dd_timeout = setTimeout(dd_scroll_tm,300); break; - case 'd': + case 'down': pg_set(e.layer, 'src', '/sys/images/ico12c.gif'); dd_incr = -8; dd_scroll(); dd_timeout = setTimeout(dd_scroll_tm,300); break; - case 'b': + case 'thumb': dd_incr = dd_target_img.height+36; if (e.pageY > getPageY(dd_target_img.thum)+9) dd_incr = -dd_incr; dd_scroll(); dd_timeout = setTimeout(dd_scroll_tm,300); break; - case 't': - dd_click_x = e.pageX; - dd_click_y = e.pageY; - dd_thum_y = getPageY(dd_target_img.thum); - break; } } else if ((e.kind == 'dd' || e.kind == 'ddtxt') && e.mainlayer.enabled != 'disabled') diff --git a/centrallix-os/sys/js/htdrv_editbox.js b/centrallix-os/sys/js/htdrv_editbox.js index d033138fa..b75e38855 100644 --- a/centrallix-os/sys/js/htdrv_editbox.js +++ b/centrallix-os/sys/js/htdrv_editbox.js @@ -649,8 +649,9 @@ function eb_init(param) var imgs = pg_images(l); for(var i=0;iCapabilities.HTML40 && (flags & HTR_LAYER_F_DYNAMIC)); - const char* start_tag = (use_iframe) ? "iframe frameBorder='0'" : "div"; + const char* start_tag = (use_iframe) ? "iframe style='border:0'" : "div"; /** Add the starting tag. **/ if (UNLIKELY(qpfPrintf(error_session, id_sbuf, sizeof(id_sbuf), id, cnt) < 0)) @@ -1376,7 +1376,7 @@ htrAddBodyItemLayerEnd(pHtSession s, int flags) { /** Pick a starting tag. **/ const int use_iframe = (s->Capabilities.HTML40 && (flags & HTR_LAYER_F_DYNAMIC)); - const char* end_tag = (use_iframe) ? "iframe frameBorder='0'" : "div"; + const char* end_tag = (use_iframe) ? "iframe" : "div"; /** Add it. **/ if (UNLIKELY(htrAddBodyItem_va(s, "", end_tag) != 0)) @@ -2210,10 +2210,8 @@ htrRender(void* stream, int (*stream_write)(void*, char*, int, int, int), pObjSe goto end_free; } - /** Output the DOCTYPE for browsers supporting HTML 4.0 -- this will make them use HTML 4.0 Strict **/ - /** FIXME: should probably specify the DTD.... **/ - if(s->Capabilities.HTML40 && !s->Capabilities.Dom0IE) - htrWrite(s, "\n\n", 17); + /** Write the DOCTYPE header, enabling HTML 4.0 Strict mode. **/ + htrWrite(s, "\n\n", 17); /** Write HTML header comment & license. **/ htrQPrintf(s, "