epanet-plus 0.2.1__cp311-cp311-macosx_11_0_arm64.whl

epanet-src/util/cstr_helper.c

@@ -0,0 +1,59 @@
+/*
+ ******************************************************************************
+ Project:      OWA EPANET
+ Version:      2.3
+ Module:       util/cstr_helper.c
+ Description:  Provides C string helper functions
+ Authors:      see AUTHORS
+ Copyright:    see AUTHORS
+ License:      see LICENSE
+ Last Updated: 04/02/2019
+ ******************************************************************************
+*/
+
+#include <stdlib.h>
+#include <string.h>
+
+#include "cstr_helper.h"
+
+
+int cstr_duplicate(char **dest, const char *source)
+// Duplicates source string
+{
+    size_t size = 1 + strlen(source);
+    *dest = (char *) calloc(size, sizeof(char));
+
+    if (*dest == NULL)
+        return -1;
+    else {
+#ifdef _MSC_VER
+        strncpy_s(*dest, size, source, size);
+#else
+        strncpy(*dest, source, size);
+#endif
+    }
+    return 0;
+}
+
+
+bool cstr_isvalid(const char *element_id)
+// Determines if invalid characters are present in an element id string
+{
+    const char *invalid_chars = " \";";
+
+    // if invalid char is present a pointer to it is returned else NULL
+    if (strpbrk(element_id, invalid_chars))
+        return false;
+    else
+        return true;
+}
+
+
+bool cstr_isnullterm(const char *source)
+// Determines if the string passed is null terminated or not
+{
+    if (strchr(source, '\0'))
+        return true;
+    else
+        return false;
+}

epanet-src/util/cstr_helper.h

@@ -0,0 +1,38 @@
+/*
+ ******************************************************************************
+ Project:      OWA EPANET
+ Version:      2.3
+ Module:       util/cstr_helper.h
+ Description:  Provides C string helper functions
+ Authors:      see AUTHORS
+ Copyright:    see AUTHORS
+ License:      see LICENSE
+ Last Updated: 04/02/2019
+ ******************************************************************************
+*/
+
+#ifndef CSTR_HELPER_H_
+#define CSTR_HELPER_H_
+
+
+#include <stdbool.h>
+
+
+#if defined(__cplusplus)
+extern "C" {
+#endif
+
+
+int cstr_duplicate(char **dest, const char *source);
+
+bool cstr_isvalid(const char *element_id);
+
+bool cstr_isnullterm(const char *source);
+
+
+#if defined(__cplusplus)
+}
+#endif
+
+
+#endif /* CSTR_HELPER_H_ */

epanet-src/util/errormanager.c

@@ -0,0 +1,92 @@
+/*
+ ******************************************************************************
+ Project:      OWA EPANET
+ Version:      2.3
+ Module:       util/errormanager.c
+ Description:  Provides a simple interface for managing errors
+ Authors:      see AUTHORS
+ Copyright:    see AUTHORS
+ License:      see LICENSE
+ Last Updated: 08/02/2023
+ ******************************************************************************
+*/
+
+//#ifdef _WIN32
+//#define _CRTDBG_MAP_ALLOC
+//#include <stdlib.h>
+//#include <crtdbg.h>
+//#else
+#include <stdlib.h>
+//#endif
+#include <string.h>
+
+#include "errormanager.h"
+
+
+typedef struct error_s {
+    int error_status;
+	void (*p_msg_lookup)(int, char*, int);
+} error_handle_t;
+
+
+error_handle_t *create_error_manager(void (*p_error_message)(int, char*, int))
+//
+// Purpose: Constructs a new error handle.
+//
+{
+	error_handle_t *error_handle;
+	error_handle = (error_handle_t*)calloc(1, sizeof(error_handle_t));
+	if (error_handle == NULL) return NULL;
+
+	error_handle->p_msg_lookup = p_error_message;
+
+	return error_handle;
+}
+
+void delete_error_manager(error_handle_t *error_handle)
+//
+// Purpose: Destroys the error handle.
+//
+{
+	free(error_handle);
+}
+
+int set_error(error_handle_t *error_handle, int error_code)
+//
+// Purpose: Sets an error code in the handle.
+//
+{
+	// If the error code is 0 no action is taken and 0 is returned.
+	// This is a feature not a bug.
+	if (error_code)
+		error_handle->error_status = error_code;
+
+	return error_code;
+}
+
+int check_error(error_handle_t *error_handle, char **error_message)
+//
+// Purpose: Returns the error message or NULL.
+//
+// Note: Caller must free memory allocated by check_error
+//
+{   int error_code = error_handle->error_status;
+	char *temp = NULL;
+
+	if (error_code != 0) {
+		temp = (char*) calloc(ERR_MAXMSG + 1, sizeof(char));
+
+		if (temp)
+			error_handle->p_msg_lookup(error_code, temp, ERR_MAXMSG);
+	}
+    *error_message = temp;
+	return error_code;
+}
+
+void clear_error(error_handle_t *error_handle)
+//
+// Purpose: Clears the error from the handle.
+//
+{
+	error_handle->error_status = 0;
+}

epanet-src/util/errormanager.h

@@ -0,0 +1,39 @@
+/*
+ ******************************************************************************
+ Project:      OWA EPANET
+ Version:      2.3
+ Module:       util/errormanager.h
+ Description:  Provides a simple interface for managing errors
+ Authors:      see AUTHORS
+ Copyright:    see AUTHORS
+ License:      see LICENSE
+ Last Updated: 04/02/2019
+ ******************************************************************************
+*/
+
+#ifndef ERRORMANAGER_H_
+#define ERRORMANAGER_H_
+
+#define ERR_MAXMSG 256
+
+
+#if defined(__cplusplus)
+extern "C" {
+#endif
+
+// Forward declaration
+typedef struct error_s error_handle_t;
+
+error_handle_t* create_error_manager(void (*p_error_message)(int, char*, int));
+void delete_error_manager(error_handle_t* error_handle);
+
+int set_error(error_handle_t* error_handle, int error_code);
+int check_error(error_handle_t* error_handle, char **error_message);
+void clear_error(error_handle_t* error_handle);
+
+
+#if defined(__cplusplus)
+}
+#endif
+
+#endif /* ERRORMANAGER_H_ */

epanet-src/util/filemanager.c

@@ -0,0 +1,212 @@
+/*
+ ******************************************************************************
+ Project:      OWA EPANET
+ Version:      2.3
+ Module:       util/filemanager.c
+ Description:  Provides a simple interface for managing files
+ Authors:      see AUTHORS
+ Copyright:    see AUTHORS
+ License:      see LICENSE
+ Last Updated: 08/02/2023
+ ******************************************************************************
+*/
+
+
+// MSVC ONLY
+#ifdef _DEBUG
+    #define _CRTDBG_MAP_ALLOC
+    #include <stdlib.h>
+    #include <crtdbg.h>
+#else
+    #include <stdlib.h>
+#endif
+
+#include <stdarg.h>
+
+#include "filemanager.h"
+
+
+typedef struct file_s {
+    char *filename;    // Assumes this is a null terminated string
+    FILE *file;
+} file_handle_t;
+
+
+// local (private) functions
+int _fopen(FILE **f, const char *name, const char *mode);
+int _get_temp_filename(char **tempname);
+
+
+file_handle_t *create_file_manager() {
+
+    file_handle_t *file_handle;
+    file_handle = (file_handle_t *)calloc(1, sizeof(file_handle_t));
+    if (file_handle == NULL) return NULL;
+
+	file_handle->filename = NULL;
+	file_handle->file = NULL;
+
+    return file_handle;
+}
+
+void delete_file_manager(file_handle_t *file_handle) {
+
+	if (file_handle->file != NULL)
+		close_file(file_handle);
+
+	free(file_handle->filename);
+	free(file_handle);
+}
+
+
+int get_filename(file_handle_t *file_handle, char **filename)
+//
+// BE AWARE: The memory allocated here must be freed by the caller
+//
+{
+    return cstr_duplicate(filename, file_handle->filename);
+}
+
+
+int open_file(file_handle_t *file_handle, const char *filename, const char *file_mode) {
+    int error = 0;
+
+    if (filename == NULL)
+        _get_temp_filename(&(file_handle->filename));
+    else
+        cstr_duplicate(&(file_handle->filename), filename);
+
+    if (file_mode == NULL)
+        error = -1;
+    else {
+        error = _fopen(&(file_handle->file), file_handle->filename, file_mode);
+    }
+
+    return error;
+}
+
+int seek_file(file_handle_t *file_handle, F_OFF offset, int whence)
+{
+#ifdef _MSC_VER // Windows (32-bit and 64-bit)
+#define FSEEK64 _fseeki64
+#else         // Other platforms
+#define FSEEK64 fseeko
+#endif
+
+    return FSEEK64(file_handle->file, offset, whence);
+}
+
+F_OFF tell_file(file_handle_t *file_handle)
+{
+#ifdef _MSC_VER // Windows (32-bit and 64-bit)
+#define FTELL64 _ftelli64
+#else         // Other platforms
+#define FTELL64 ftello
+#endif
+
+    return FTELL64(file_handle->file);
+}
+
+// Read and write to a binary file
+size_t read_file(void *ptr, size_t size, size_t nmemb, file_handle_t *file_handle)
+{
+    return fread(ptr, size, nmemb, file_handle->file);
+}
+
+size_t write_file(const void * ptr, size_t size, size_t count, file_handle_t *file_handle)
+{
+    return fwrite(ptr, size, count, file_handle->file);
+}
+
+
+// print and get from a text file
+int printf_file(file_handle_t *file_handle, const char *format, ... )
+{
+    int error = 0;
+    va_list args;
+
+    va_start(args, format);
+    error = vfprintf(file_handle->file, format, args);
+    va_end(args);
+
+    return error;
+}
+
+int gets_file(char *str, int num, file_handle_t *file_handle)
+{
+    fgets(str, num, file_handle->file);
+    return 0;
+}
+
+
+int close_file(file_handle_t *file_handle) {
+    int error = 0;
+
+    if (file_handle->file != NULL) {
+        error = fclose(file_handle->file);
+        file_handle->file = NULL;
+    }
+    return error;
+}
+
+int remove_file(file_handle_t *file_handle) {
+    return remove(file_handle->filename);
+}
+
+
+bool is_valid(file_handle_t *file_handle)
+{
+	if ((file_handle->filename == NULL && file_handle->file == NULL) ||
+		(cstr_isnullterm(file_handle->filename) && file_handle != NULL))
+		return true;
+	else
+		return false;
+}
+
+
+int _fopen(FILE **f, const char *name, const char *mode)
+//
+//  Purpose: Substitute for fopen_s on platforms where it doesn't exist
+//  Note: fopen_s is part of C++11 standard
+//
+{
+    int ret = 0;
+
+#ifdef _MSC_VER
+    ret = (int)fopen_s(f, name, mode);
+#else
+    *f = fopen(name, mode);
+    if (!*f)
+        ret = -1;
+#endif
+    return ret;
+}
+
+int _get_temp_filename(char **tempname)
+{
+    int error = 0;
+
+#ifdef _MSC_VER
+    char *name = NULL;
+
+    // --- use Windows _tempnam function to get a pointer to an
+    //     unused file name that begins with "en"
+    if ((name = _tempnam(name, "en")) == NULL) {
+        error = -1;
+        return error;
+    }
+    else
+        cstr_duplicate(tempname, name);
+
+    // --- free the pointer returned by _tempnam
+    if (name)
+        free(name);
+
+    // --- for non-Windows systems:
+#else
+    // --- use system function mkstemp() to create a temporary file name
+    cstr_duplicate(tempname, "enXXXXXX");
+    error = mkstemp(*tempname);
+#endif
+    return error;
+}

epanet-src/util/filemanager.h

@@ -0,0 +1,81 @@
+/*
+ ******************************************************************************
+ Project:      OWA EPANET
+ Version:      2.3
+ Module:       util/filemanager.h
+ Description:  Provides a simple interface for managing files
+ Authors:      see AUTHORS
+ Copyright:    see AUTHORS
+ License:      see LICENSE
+ Last Updated: 04/01/2019
+ ******************************************************************************
+*/
+
+#ifndef FILEMANAGER_H_
+#define FILEMANAGER_H_
+
+
+#include <stdio.h>
+#include <stdarg.h>
+
+#include "cstr_helper.h"
+
+
+// F_OFF Must be a 8 byte / 64 bit integer for large file support
+#ifdef _MSC_VER // Windows (32-bit and 64-bit)
+#define F_OFF __int64
+#else         // Other platforms
+#define F_OFF off_t
+#endif
+
+#define FILE_MAXNAME 259
+
+
+#if defined(__cplusplus)
+extern "C" {
+#endif
+
+// Forward declariation of file_handle_t
+typedef struct file_s file_handle_t;
+
+
+file_handle_t *create_file_manager();
+
+void delete_file_manager(file_handle_t *file_handle);
+
+
+int get_filename(file_handle_t *file_handle, char **filename);
+
+
+int open_file(file_handle_t *file_handle, const char *filename, const char *file_mode);
+
+int seek_file(file_handle_t *file_handle, F_OFF offset, int whence);
+
+F_OFF tell_file(file_handle_t *file_handle);
+
+
+// Functions for working with binary files
+size_t read_file(void *ptr, size_t size, size_t nmemb, file_handle_t *file_handle);
+
+size_t write_file(const void *ptr, size_t size, size_t count, file_handle_t *file_handle);
+
+
+// Functions for working with text files
+int printf_file(file_handle_t *file_handle, const char *format, ... );
+
+int gets_file(char *str, int num, file_handle_t *file_handle);
+
+
+int close_file(file_handle_t *file_handle);
+
+int remove_file(file_handle_t *file_handle);
+
+
+bool is_valid(file_handle_t *file_handle);
+
+
+#if defined(__cplusplus)
+}
+#endif
+
+#endif /* FILEMANAGER_H_ */