#ifndef COMPOUND_STATUS_H # define COMPOUND_STATUS_H # include # include # include # include # include # include # include # include # include # include /* Status characteristics */ typedef enum { STATUS_UNKNOWN = -1, STATUS_NORMAL = 0, STATUS_ERROR = 1 } StatusCharacteristics; typedef enum { /* Settlement. */ ARGUE_RESULT_FINALISED = 0b01, ARGUE_RESULT_UNSETTLED = -0b01, /* Nature. */ ARGUE_RESULT_POSITIVE = 0b10, ARGUE_RESULT_NEGATIVE = -0b10, } ArgueResult; /* Indicated the exact location where the "issue" was occurred at. */ typedef struct { char *file; int line; char *func; } Location; # define __HERE__ (Location){ \ .file = (char *)__FILE__, \ .line = __LINE__, \ .func = (char *)__func__ \ } # define __GLOBAL__ (Location){ \ .file = (char *)__FILE__, \ .line = __LINE__, \ .func = (char *)"(GLOBAL)" \ } /* Common return type for reporting functions that require to give more information about the procedure. */ typedef struct _Status { char *identity; int value; /* Traditional returning data "int". Only used when the function called and received legacy functions that uses "int" as the returning type that wish to have place to hold the value. Otherwise, the function would just return the structure Status. */ char *description; int characteristic; Location loc; struct _Status *prev; } Status; # define DEFSTATUS(i, v, d, c, p)\ static const Status i = {\ .identity = nameof(i),\ .value = v,\ .description = d,\ .characteristic = c,\ .loc = __GLOBAL__,\ .prev = (Status *)p\ } /* {value "description" characteristic prev} "%d \"%s\" %d %p" */ /* line, func, file */ // # define LOCATION_LITERALISE_FORMAT "at line %d, in %s, %s" /* file, line, func */ # define LOCATION_LITERALISE_FORMAT "at %s:%d, in function `%s\'" # define LOCATION_LITERALISE_FORMAT_LENGTH 20 /* value, description, characteristic, prev */ // # define STATUS_LITERALISE_FORMAT "%d \"%s\" %d %p" /* identity, prev->identity, value, characteristic, description, */ // # define STATUS_LITERALISE_FORMAT "%s (prev: %s): $=%d @=%d\n\t\"%s\"\n\t%s" // MaximumLiteralisationLengthExceeded (prev: MaximumLengthExceeded): $=1 @=1 /* MaximumLengthExceeded: "Buffer was too long." predecessor= value=(1) characteristic=[1] at line 40, in Main, /home/william/Documents/Projects/Compound/test.c */ // identity, description, prev->identity, value, characteristic, # define STATUS_LITERALISE_FORMAT \ "%s: \"%s\"\n\tpredecessor=<%s> value=(%d) characteristic=[%d]\n\t%s\n" typedef enum { REPORT_SENDING_PRIORITY_ALL = 0, // Highest level; least value. REPORT_SENDING_PRIORITY_FATAL, REPORT_SENDING_PRIORITY_EXCEPTIONAL, REPORT_SENDING_PRIORITY_CRITICAL, REPORT_SENDING_PRIORITY_MAJOR, REPORT_SENDING_PRIORITY_NORMAL, REPORT_SENDING_PRIORITY_MINOR, REPORT_SENDING_PRIORITY_DEBUG, REPORT_SENDING_PRIORITY_NONE, // Lowest level, greatest value. } ReportSendingPriority; typedef enum { REPORT_SENDING_TASK_STATUS_FINISHED = 0, REPORT_SENDING_TASK_STATUS_PENDING, REPORT_SENDING_TASK_STATUS_PROCEEDING, REPORT_SENDING_TASK_STATUS_PAUSED, REPORT_SENDING_TASK_STATUS_NOTFOUND } ReportSendingTaskStatus; /* "Report" recollects essential informations, included but not limited to Status and others for making an report for debugging and such. */ typedef struct { Status status; char *initiator; time_t time; ReportSendingPriority priority; ReportSendingTaskStatus taskprint_status; FILE *dest; // The destination where the report is sending to. } Report; /* DATETIME [PRIORITY] STATUSNAME (ORIGINATOR): STATUS.DESCRIPTION at LOCATION.FILE:LOCATION.LINE, LOCATION.FUNC at LOCATION.FILE:LOCATION.LINE, LOCATION.FUNC at LOCATION.FILE:LOCATION.LINE, LOCATION.FUNC at LOCATION.FILE:LOCATION.LINE, LOCATION.FUNC Fri 10 May 03:02:37 CST 2024 [EXCEPTIONAL] InvalidParameter (Nullity): Given buffer was unavailable. at /external/Documents/Projects/Compound/Status/src/status.c:104, Report_Literalise at /external/Documents/Projects/Compound/Status/src/status.c:114, ReportSender_Send at /external/Documents/Projects/Compound/Status/src/status.c:69, _throw !!!!at /external/Documents/Projects/Compound/Array/src/array.c:16, array_create at /external/Documents/Projects/Compound/test.c:24, main */ # define REPORT_LITERALISE_HEADER_FORMAT "%s [%s] %s (%s): %s" # define REPORT_LITERALISE_CHAINS_FORMAT " at %s:%d, %s" # define REPORT_LITERALISE_CHAINS_EXCLAIM_FORMAT "!!!!at %s:%d, %s" typedef enum { REPORT_SENDER_RESULT_FINISHED, REPORT_SENDER_RESULT_PROGRESSING, REPORT_SENDER_RESULT_PENDING } ReportSenderResult; typedef struct { thrd_t thread; Report *report; // The report for sending. time_t elapsed; // The individual elapsed time for each report. (Array) ReportSenderResult result; bool successful; } ReportSender; typedef int (*ReportSendingTask)(Report *rep); typedef int ReportSendingTaskID; typedef struct { ReportSendingTask *tasks; // Array Ref int sendercount; int finishedcount; int *results; // Array } ReportSendingManager; // typedef thrd_start_t ArgueStart; // typedef struct { // ArgueStart handler; // void *external_param; // } ArgueStartParam; // /* Argument levels (qualities) */ // typedef enum { // ARGUMENT_NONE = 0, // ARGUMENT_MINOR, // ARGUMENT_NORMAL, // ARGUMENT_MAJOR, // ARGUMENT_CRITICAL, // ARGUMENT_SEVERE, // ARGUMENT_ALL, // } ArgumentLevel; // typedef struct { // ReportSender stream; // ArgueStartParam handler; // Obsolete? // ArgumentLevel level; // bool muted; // } Argument; // typedef struct { // Argument *members; // int (*announcer) (Argument); // } ArgumentAnnouncer; # define STATUS_BUFFER_MAXIMUM_LENGTH UINT32_MAX Status Location_Literalise(Location *inst, char *buff); bool Location_Equals(Location lc1, Location lc2); Status Status_Literalise(Status *inst, char *buff); bool Status_Equal(Status *stat1, Status *stat2); void StatusUtils_Dump(Status *inst, Status *store, int idx); bool StatusUtils_HasPrev(Status inst); bool StatusUtils_IsOkay(Status inst); bool StatusUtils_IsValid(Status inst); bool StatusUtils_IsRecursive(Status inst); int StatusUtils_Depth(Status *inst); Status Report_Create(Report *inst, Status *stat, FILE *dest, char *initiator, int priority); Status Report_CopyOf(Report *inst, Report *other); Status Report_Literalise(Report *inst, char *buff); void Report_Delete(Report *inst); bool Report_Equals(Report repo1, Report repo2); Status ReportSender_Create(ReportSender *inst, Report *report); Status ReportSender_Send(ReportSender *inst, ReportSendingTask task); // ReportSendingTaskStatus // ReportSender_GetStatus(ReportSender *inst); ReportSendingTaskID ReportSenderManager_AppendTask(ReportSendingManager *inst, ReportSendingTask task); Status ReportSenderManager_RemoveTask(ReportSendingManager *inst, ReportSendingTaskID taskid); // Status // arguestarter_create(ArgueStartParam *inst, void *external_param); // Status // arguestarter_constr(ArgueStartParam *inst, ArgueStart argue_start, // void *external_param); // Status // arguestarter_start(ArgueStartParam *inst); // bool // arguestarter_equal(ArgueStartParam *inst1, ArgueStartParam *inst2); // Status arguestarter_current(void); // Status arguestarter_sleep(const struct timespec *time_point, // struct timespec *remaining); // void arguestarter_exit(int code) __attribute__ ((__noreturn__)); // Status arguestarter_join(ArgueStart thrd); // Status // argument_create(Argument *inst, ReportSender *streams, ArgueStartParam handler, // int level, bool muted); // ---------------------ELEMENTARY------------------------- DEFSTATUS(UnknownStatus, -1, "An unknown status.", STATUS_UNKNOWN, NULL); DEFSTATUS(NormalStatus, 0, "A normal status.", STATUS_NORMAL, NULL); DEFSTATUS(ErrorStatus, 1, "An error status.", STATUS_ERROR, NULL); // ----------------------EXTENDED-------------------------- DEFSTATUS(MemoryViolation, 1, "Illegal access on certain memory address.", STATUS_ERROR, &ErrorStatus); DEFSTATUS(NullPointerAccounted, 1, "An involving null pointer was not accepted.", STATUS_ERROR, &MemoryViolation); DEFSTATUS(InvalidObject, 1, "An invalid object was presented.", STATUS_ERROR, &ErrorStatus); DEFSTATUS(UnavailableObject, 1, "An unavailable object was presented.", STATUS_ERROR, &ErrorStatus); DEFSTATUS(InstanceStillAlive, 1, "Given instance was yet alive.", STATUS_ERROR, &ErrorStatus); DEFSTATUS(InstanceNotAlive, 1, "Given instance for reallocation was not alive.", STATUS_ERROR, &ErrorStatus); DEFSTATUS(InvalidParameter, 1, "An invalid parameter was presented.", STATUS_ERROR, &InvalidObject); DEFSTATUS(InsufficientMemory, 1, "Not enough room for further memory allocations.", STATUS_ERROR, &ErrorStatus); DEFSTATUS(ArithmeticError, 1, "An arithmetic error occurred.", STATUS_ERROR, &ErrorStatus); DEFSTATUS(IntegerOverFlow, 1, "An integer had overflowed.", STATUS_ERROR, &ArithmeticError); DEFSTATUS(RuntimeError, 1, "A runtime error occurred.", STATUS_ERROR, &ErrorStatus); DEFSTATUS(ArrayLengthError, 1, "Given array length does not meet the requirement.", STATUS_ERROR, &ErrorStatus); DEFSTATUS(VariableFormatMismatch, 1, "Given format does not match with given subjects.", STATUS_ERROR, &ErrorStatus); DEFSTATUS(ImprecisionError, 1, "Precision was not enough for handling the calculation.", STATUS_ERROR, &RuntimeError); // ---------------------USER DEFINED----------------------- DEFSTATUS(UnavailableInstance, 1, "An unavailable instance was given for initialisation.", STATUS_ERROR, &NullPointerAccounted); DEFSTATUS(RecreationOnInstanceStillAlive, 1, "Given instance was still alive, yet, was sent for another session of recreation.", STATUS_ERROR, &InstanceStillAlive); DEFSTATUS(UnavailableParameter, 1, "An unavailable instance was given as a parameter.", STATUS_ERROR, &UnavailableInstance); DEFSTATUS(InvalidReportTask, 1, "An unavailable or illegal report task was given.", STATUS_ERROR, &InvalidParameter); DEFSTATUS(UnableToThrowError, 1, "Unable to report an exceptional situation.", STATUS_ERROR, &RuntimeError); DEFSTATUS(ReadWriteError, 1, "Error occurred during IO session.", STATUS_ERROR, &RuntimeError); DEFSTATUS(FileNotFound, 1, "Target file was unavailable and unable to find.", STATUS_ERROR, &ReadWriteError); DEFSTATUS(InvalidFileName, 1, "Given file name was invalid.", STATUS_ERROR, &ReadWriteError); DEFSTATUS(UnavailableFileName, 1, "Given file name was unavailable.", STATUS_ERROR, &UnavailableObject); DEFSTATUS(UnavailableFileAccessMode, 1, "Given file accessing mode was unavailable.", STATUS_ERROR, &UnavailableObject); DEFSTATUS(InsufficientAccessPermission, 1, "Given permission does not suffice to access.", STATUS_ERROR, &ReadWriteError); DEFSTATUS(ReportThrown, 1, "This function has thrown a report, following instructions aborted.", STATUS_ERROR, &RuntimeError); DEFSTATUS(ReportMessageTooLong, 1, "Given message is too long.", STATUS_ERROR, &ArrayLengthError); DEFSTATUS(MaximumLengthExceeded, 1, "Maximum length had exceeded", STATUS_ERROR, &ArrayLengthError); DEFSTATUS(MaximumLiteralisationLengthExceeded, 1, "Literalisation was too long", STATUS_ERROR, &MaximumLengthExceeded); DEFSTATUS(UnavailableBuffer, 1, "Given buffer was unavailable.", STATUS_ERROR, &UnavailableInstance); DEFSTATUS(InvalidLiteralisingBuffer, 1, "Given buffer does not have a good integrity on its length.", STATUS_ERROR, &InvalidObject); // ======================================================== /* Throw the report created with $e if $e is abnormal, commented with $c. */ # define ensure(e, c) { \ Status stat = e; \ solve(!(StatusUtils_IsOkay(stat)), { \ Report rep = stamp(error(stat, c), (char *)__func__); \ (void)throw(rep); \ return ReportThrown; \ }) \ } /* Throw the report created with $s if $e is abnormal, commented with $c. */ # define match(s, e, c) { \ Status stat = s; \ solve(!(StatusUtils_IsOkay(e)), { \ Report rep = stamp(error(stat, c), (char *)__func__); \ (void)throw(rep); \ return ReportThrown; \ }) \ } /* Add location parameter requirement in order to give proper information * before throwing the report out. */ # define throw(report) __throw(report, __HERE__) /* Useless in C, only for human to see. Probably rewrite this in Classify. */ # define throws(e) ReportSendingTaskID __throw(Report report, Location loc); Report catch(ReportSendingTaskID taskid); int HANDLER(void *report); #endif /* COMPOUND_STATUS_H */