Grid Application Toolkit A simple API for Grid Applications

Menu Home API-Specification API-Overview Status C Reference Manual Download Java Java-Reference General GridLab - WP-1 Links

GATStatus.c Go to the documentation of this file. /** @file GATStatus.c * Source file for the GATStatus class. * * The GATStatus class provides a set of routines to maintain a flexible and * uniform way to store, retrieve and manage errors and related information, * which occured during a call to the GAT API. * * An instance of this class represents an error or an information message * from a GAT operation or from an underlying adaptor. instances of this class * are used to provide an audit trail which the application user can use to * trace the sequence of events which happened in any particular GAT operation; * this may then be used by the application, adaptor or service developers or * providers to debug problems. * Since the GAT Engine and adaptors may do several independent operations each * of which may have associated errors or status messages, a GATStatus instance * forms a node in a tree of GATStatus instances, rather than the more normal * parent-child process of a try-catch type error mechanism. * * @date Tue Sep 30 2003 * * @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATStatus.c,v 1.29 2004/05/12 18:56:01 hartmutkaiser Exp $ * * Copyright (C) Hartmut Kaiser * This file is part of the GAT Engine. * Contributed by Hartmut Kaiser <hartmutkaiser [at] t-online [dot] de>. * * Use, modification and distribution is subject to the Gridlab Software * License. (See accompanying file GLlicense.txt or copy at * http://www.gridlab.org/GLlicense.txt) */ #if defined(sccs) static const char *rcsid = "$Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATStatus.c,v 1.29 2004/05/12 18:56:01 hartmutkaiser Exp $"; #endif #include <assert.h> #include <stdlib.h> #include <string.h> #include <stdio.h> #include "GATInternal.h" #include "GATType.h" #include "GATErrors.h" #include "GATObject.h" #include "GATContext.h" #include "GATStatus.h" #include "GATXdsWrapper.h" #include "GATList.h" #include "GATSelf.h" /* * Define the type specific interface functions for the GATList_GATStatus list */ GATLIST_IMPLEMENT(extern, GATStatus, GATList_GATStatus, GATType_GATStatus) /* * Define the vtable for this object */ GATOBJECT_DEFINE_VTABLE(GATStatus); GATSERIALISABLE_DEFINE_VTABLE(GATStatus); /* * Declare the converters to/from GATObject */ GATOBJECT_DEFINE_CONVERTERS(GATStatus); GATOBJECT_DEFINE_CONVERTERS_QUALIFIED(extern, GATList_GATStatus, GATType_GATList); /* * The GATStatus_S structure holds the internal representation of a GATStatus * instance. */ struct GATStatus_S { GATStatus_vtable *GATObject__vtable; /* the vtable of this structure */ GATStatus_ISerialisable_vtable *GATSerialisable__vtable; GATBool isdirty; GATResult statuscode; /* the actual error/status code */ char filename[FILENAME_MAX]; /* file name, where the status was created */ GATuint32 linenumber; /* line number, where the status was created */ GATList_String messages; /* a list of related message */ GATStatus_const parent; /* the parent GATStatus, may be 0 (zero) */ GATList_GATStatus children; /* a list of attached GATStatus children */ }; /* Static function prototypes */ static GATResult GATStatus_DeSerialise_Create(GATContext context, GATObject stream, GATResult code, GATList_String messages, GATList_GATStatus children, char const *filename, GATuint32 lineno, GATStatus *new_object); static GATResult GATStatus_SetParent(GATStatus status, GATStatus_const parent); static void GATStatus_TraceLevel(FILE *fp, GATStatus_const status, int level); /* file scope variables */ static GATStatus_vtable GATStatus__vtable = { GATStatus_GetType, GATStatus_Destroy, GATStatus_Equals, GATStatus_Clone, GATStatus_GetInterface }; static GATStatus_ISerialisable_vtable GATStatus_ISerialisable__vtable = { GATStatus_Serialise, GATStatus_DeSerialise, GATStatus_GetIsDirty, }; /* External functions */ /** GATStatus_Register_GATSerialisable * The GATStatus_Register_GATSerialisable function registers the serialization * vtable with the GAT engine to allow generic object creation. * This function is called by the GAT engine, there is no need to use it * directly. */ GATResult GATStatus_Register_GATSerialisable(void) { return GATObject_Register_GATSerialisable(GATType_GATStatus, &GATStatus_ISerialisable__vtable); } /* Helper API for GATStatus based error diagnostics and error propagation */ /** GATCreateStatus * * The function GATCreateStatus is a helper function used for creating and * assigning a GATStatus object to the function local GATStatus. It is used * for newly diagnosed errors. * * @param name The function name of the function, where the error/diagnostic * occured. * @param status The function local status object to which the newly created * error/diagnostic should be added. * @param code The GATResult code of the error/diagnostic to be added. * @param context The GATContext to which the GATStatus to be propagated is * associated with. * * @return The provided GATResult code from the code parameter. */ GATResult GATCreateStatus(char const *name, GATStatus *status, GATResult result_code, GATContext context, char const *filename, GATuint32 lineno) { GATResult retval = GAT_SUCCESS; if (GAT_FAILED(result_code)) { if (NULL != name && NULL != status) { if (NULL == *status) { *status = GATStatus_Create(name, filename, lineno); } if (NULL != *status) { GATStatus new_status = NULL; if (GAT_SUCCESS != GATContext_GetCurrentStatus(context, &new_status) || NULL == new_status) { new_status = GATStatus_Create_Code(result_code, filename, lineno); if (NULL == new_status) { retval = GAT_MEMORYFAILURE; } } if (NULL != new_status) { retval = GATStatus_AddChild(*status, new_status); if (GAT_SUCCESS == retval) { retval = result_code; } GATStatus_Destroy(&new_status); } } else { retval = GAT_MEMORYFAILURE; } } else { retval = GAT_INVALID_PARAMETER; } } else { retval = result_code; } return retval; } /** GATPropagateStatus * * The function GATPropagateStatus is used for taking the current status from * the given context and append it to the function local GATStatus. It is used * for error/diagnostics propagation purposes. * * @param name The function name of the function, where the error/diagnostic * occured. * @param status The function local status object to which the newly created * error/diagnostic should be added. * @param code The GATResult code of the error/diagnostic to be added. * @param context The GATContext to which the GATStatus to be propagated is * associated with. * * @return The provided GATResult code from the code parameter. */ GATResult GATPropagateStatus(char const *name, GATStatus *status, GATResult result_code, GATContext context) { /* This function is depreciated and was completely replaced by the GATCreateStatus function */ return GATCreateStatus(name, status, result_code, context, NULL, 0); } /* GATStatus API */ /** GATStatus GATStatus_Create(char const *message) * @brief Create a new GATStatus object * * The function @c GATStatus_Create creates a new GATStatus object and * associates with it the given message. The status code stored internally is * initialized to @c #GAT_SUCCESS. * * @param message The message to associate initially with the newly created * GATStatus. * * @return Returns a handle to the newly created GATStatus object. * returns 0 (zero) if an error occurs. */ GATStatus GATStatus_Create(char const *message, char const *filename, GATuint32 lineno) { GATStatus status = (GATStatus) malloc(sizeof(struct GATStatus_S)); if (NULL != status) { status->GATObject__vtable = &GATStatus__vtable; status->GATSerialisable__vtable = &GATStatus_ISerialisable__vtable; status->isdirty = GATFalse; status->statuscode = GAT_SUCCESS; status->parent = NULL; status->children = NULL; /* list of children is created lazily */ if (NULL != filename) { strncpy(status->filename, filename, FILENAME_MAX); status->filename[FILENAME_MAX-1] = '\0'; } else { status->filename[0] = '\0'; } status->linenumber = lineno; status->messages = GATList_String_Create(); if (NULL != status->messages) { GATList_String_Iterator end = GATList_String_End(status->messages); GATList_String_Iterator new_msg = GATList_String_Insert(status->messages, end, message); if (NULL == new_msg) { GATList_String_Destroy(&status->messages); free(status); status = NULL; } } } return status; } /** GATStatus GATStatus_Create_Code(GATResult code) * @brief Create a new GATStatus object * * The function @c GATStatus_Create_Code creates a new GATStatus object and * associates with it the given status code. * * @param code The status code to associate initially with the newly created * GATStatus. * * @return Returns a handle to the newly created GATStatus object. * returns 0 (zero) if an error occurs. */ GATStatus GATStatus_Create_Code(GATResult code, char const *filename, GATuint32 lineno) { GATStatus status = (GATStatus) malloc(sizeof(struct GATStatus_S)); if (NULL != status) { status->GATObject__vtable = &GATStatus__vtable; status->GATSerialisable__vtable = &GATStatus_ISerialisable__vtable; status->isdirty = GATFalse; status->statuscode = code; status->parent = NULL; status->children = NULL; /* list of children is created lazily */ if (NULL != filename) { strncpy(status->filename, filename, FILENAME_MAX); status->filename[FILENAME_MAX-1] = '\0'; } else { status->filename[0] = '\0'; } status->linenumber = lineno; status->messages = GATList_String_Create(); if (NULL == status->messages) { GATStatus_Destroy(&status); } } return status; } /** void GATStatus_Destroy(GATStatus *status) * @brief Delete an existing GATStatus object * * The function GATStatus_Destroy destroys this GATStatus object and all of * the contained data (such as the GATStatus list of children and the list * of attached message strings). * * @param status The GATStatus object to be destroyed. If this parameter is 0 * (zero) the function does nothing, but returns @c #GAT_SUCCESS. */ void GATStatus_Destroy(GATStatus *status) { if (NULL != status && NULL != *status) { GATList_String_Destroy(&(*status)->messages); GATList_GATStatus_Destroy(&(*status)->children); free(*status); *status = NULL; } } /** GATType GATStatus_GetType(GATStatus_const status) * @brief Return the type of the GATStatus * * The function @c GATStatus_GetType always returns GATType_GATStatus. * * @param object The object to inspect * * @return Returns always @c #GATType_GATStatus. */ GATType GATStatus_GetType(GATStatus_const status) { GAT_UNUSED_PARAMETER(status); return GATType_GATStatus; } /** int GATStatus_Clone(GATStatus_const status, GATStatus *new_status) * @brief Clones a GATStatus object. * * The function GATStatus_Clone makes a exact copy of the given @c #GATStatus * object. * * @param status The object to clone * @param new_Status The pointer, through which the result is to be * returned. * * @return An error type. */ GATResult GATStatus_Clone(GATStatus_const status, GATStatus *new_object) { GATResult retval = GAT_INVALID_PARAMETER; if (NULL != status && NULL != new_object) { GATStatus new_status = (GATStatus) malloc(sizeof(struct GATStatus_S)); if (NULL == new_status) { retval = GAT_MEMORYFAILURE; } else { new_status->GATObject__vtable = &GATStatus__vtable; new_status->GATSerialisable__vtable = &GATStatus_ISerialisable__vtable; new_status->isdirty = status->isdirty; new_status->statuscode = status->statuscode; new_status->parent = status->parent; new_status->children = NULL; new_status->messages = NULL; strcpy(new_status->filename, status->filename); new_status->linenumber = status->linenumber; retval = GATList_String_Clone(status->messages, &new_status->messages); if (GAT_SUCCESS == retval && NULL != status->children) { GATList_GATStatus_Iterator it = GATList_GATStatus_Begin(status->children); GATList_GATStatus_Iterator end = GATList_GATStatus_End(status->children); for (/**/; it != end; it = GATList_GATStatus_Next(it)) { retval = GATStatus_AddChild(new_status, *GATList_GATStatus_Get(it)); if (GAT_SUCCESS != retval) { break; } } } } if (GAT_SUCCESS != retval) { GATStatus_Destroy(&new_status); } *new_object = new_status; } return retval; } /** int GATStatus_Equals(GATStatus_const lhs, GATStatus_const rhs, GATBool *isequal) * @brief Compare two GATStatus objects * * The function GATStatus_Equals compares the two given GATStatus objects and * returns the outcome of this comparision. * * @param lhs The first list to compare * @param rhs The second list to compare * @param isequal The pointer to the GATBool variable, which should receive * the result if the comparision * * @return An error code. */ GATResult GATStatus_Equals(GATStatus_const lhs, GATStatus_const rhs, GATBool *isequal) { GATResult retval = GAT_INVALID_PARAMETER; if (NULL != lhs && NULL != rhs && NULL != isequal) { *isequal = GATTrue; if (lhs->statuscode != rhs->statuscode || strcmp(lhs->filename, rhs->filename) || lhs->linenumber != rhs->linenumber) { *isequal = GATFalse; } else { retval = GATList_String_Equals(lhs->messages, rhs->messages, isequal); if (GAT_SUCCESS == retval && GATTrue == *isequal) { if (NULL != lhs->children && NULL != rhs->children) { retval = GATList_GATStatus_Equals(lhs->children, rhs->children, isequal); } else if (NULL == lhs->children && NULL == rhs->children) { *isequal = GATTrue; retval = GAT_SUCCESS; } else { *isequal = GATFalse; retval = GAT_SUCCESS; } } } } return retval; } /** GATResult GATStatus_GetInterface(GATStatus_const file, GATInterface iftype, void const **ifp) * @brief Get an interface supported by a GATObject * * The function GATStatus_GetInterface allows to get a pointer to an * additional interface supported by this GATStatus. * * @param object The object to be asked for the new interface. * @param iftype The interface the object is to be asked for. * @param ifp The pointer, through which the result is to be returned. * * @return An error type. */ GATResult GATStatus_GetInterface(GATStatus_const object, GATInterface iftype, void const **ifp) { GATResult retval = GAT_INVALID_PARAMETER; if (NULL != ifp) { *ifp = NULL; if (GATInterface_ISerialisable == iftype) { *ifp = (void const *) &object->GATSerialisable__vtable; retval = GAT_SUCCESS; } else { retval = GAT_NO_INTERFACE; } } return retval; } /* GATAdvertiseable API */ /** GATResult GATStatus_Serialise(GATStatus object, GATObject stream, GATBool clear_dirty) * @brief Serialise a GATStatus object * * The function GATStatus_Serialise serialises the given GATStatus object into the * given stream. * * @param object The GATStatus object to serialise. * @param stream The stream interface to use for the serialisation. * @param clear_dirty If the clear_dirty parameter is set to GATTrue, the * internal dirty flag of this object is to be reset (no used here) * * @return An error code. */ GATResult GATStatus_Serialise(GATStatus object, GATObject stream, GATBool clear_dirty) { GATResult retval = GAT_INVALID_HANDLE; if (NULL != object) { retval = GATXds_SerialiseObject(GATStatus_ToGATObject(object), stream, clear_dirty, 0, "uint32 uint32 object object string uint32", GATSTATUS_VERSION1, object->statuscode, object->messages, clear_dirty, object->children, clear_dirty, object->filename, object->linenumber); if (GAT_SUCCEEDED(retval) && clear_dirty) { object->isdirty = GATFalse; } } return retval; } /** GATStatus_VersionCallback * * The function GATStatus_VersionCallback is used as a callback function * during the de-serialisation of a GATStatus. It should be provided to test, * whether the de-serialised version matches the expected version. * * @param version The version number, which was de-serialised from the stream. * * @return This function should return GATTrue, if the version matches the * expected value (version is valid), GATFalse otherwise. * * @remark This function is called from the GAT engine, there is no need to * call it directly. */ static GATBool GATStatus_VersionCallback(GATuint32 version) { GATBool retval = GATFalse; if ((version & ~GATSTATUS_MINOR_MASK) <= GATSTATUS_LASTVERSION) { retval = GATTrue; } return retval; } /** GATStatus_DeSerialiseCallback * * The function GATStatus_DeSerialiseCallback is used as a callback function * during the de-serialisation of a GATStatus. It should be provided for the * instantiation of the new GATStatus object based on the already de-serialised * data items and the de-serialisation of the associated CPI provider data for * the given object. * * @param context The GAT context to be used for object construction. * @param stream The stream interface to use for the serialisation. * @param object The pointer to the variable, which should receive the newly * constructed object. * @param version The version of the saved data read from the input stream. * @param args This parameter is the pointer to the va_list containing * pointers to the already de-serialised data items accordingly to the * format string, provided during the call to the * GATStatus_DeSerialise function. * * @return An error code. * * @remark This function is called from the GAT engine, there is no need to * call it directly. */ static GATResult GATStatus_DeSerialiseCallback(GATContext context, GATObject stream, GATObject *new_object, GATuint32 version, va_list args) { /* the version was eaten already */ GATuint32 *code = va_arg(args, GATuint32 *); GATList_String *messages = va_arg(args, GATList_String *); GATList_GATStatus *children = va_arg(args, GATList_GATStatus *); char const **filename = va_arg(args, char const **); GATuint32 *lineno = va_arg(args, GATuint32 *); GATStatus object = NULL; /* construct the new object */ GATResult retval = GATStatus_DeSerialise_Create(context, stream, *code, *messages, *children, *filename, *lineno, &object); if (GAT_SUCCESS == retval) { if (NULL != object) { *new_object = GATStatus_ToGATObject(object); } else { GATStatus_Destroy(&object); retval = GAT_INVALID_PARAMETER; } } return retval; } /** GATStatus GATStatus_DeSerialise(GATContext context, GATObject stream, GATBool clear_dirty) * @brief De-serialise a GATStatus object * * The function GATStatus_DeSerialise de-serialises a streamed GATStatus object * from the given stream It constructs a new instance of the de-serialised * object. * * @param context The GAT context to be used for object construction. * @param stream The stream interface to use for the serialisation. * @param result The pointer to a variable, which receives the status code of * the operation. * * @return The newly constructed GATStatus object. */ GATStatus GATStatus_DeSerialise(GATContext context, GATObject stream, GATResult *result) { GAT_USES_STATUS(context, "GATStatus_DeSerialise"); GATObject object = NULL; /* the new object will be created here */ /* we must provide all instance data items to be de-serialised for this GATStatus object accordingly to the provided format string */ GATuint32 version = 0; GATResult code = 0; /* the actual error/status code */ GATList_String messages = NULL; GATList_GATStatus children = NULL; char *filename = NULL; GATuint32 lineno = 0; /* read the data */ GAT_CREATE_STATUS(GATXds_DeSerialiseObject(context, stream, GATStatus_DeSerialiseCallback, GATStatus_VersionCallback, &object, "uint32 uint32 object object string uint32", &version, &code, &messages, &children, &filename, &lineno)); free(filename); GATList_String_Destroy(&messages); GATList_GATStatus_Destroy(&children); if (NULL != result) { *result = GAT_RETURN_STATUS(); } else { GAT_STORE_STATUS(); } return GATObject_ToGATStatus(object); } /** GATStatus_GetIsDirty * * The function GATStatus_GetIsDirty retrieves the status of the dirty flag of * this GATStatus object. * * @param file The GATStatus object to inspect for its dirty status. * @param isdirty The pointer to a variable, which receives the dirty status. * * @return An error code. */ GATResult GATStatus_GetIsDirty(GATStatus_const object, GATBool *isdirty) { GATResult retval = GAT_INVALID_HANDLE; if (NULL != object) { if (NULL != isdirty) { *isdirty = object->isdirty; retval = GAT_SUCCESS; } else { retval = GAT_INVALID_PARAMETER; } } return retval; } /* GATStatus API functions */ /** int GATStatus_SetStatusCode(GATStatus status, int code) * @brief Set the statuscode to be associated with the GATStatus object * * The function GATStatus_SetStatusCode associates a new status code with * the GATStatus object under inspection. * * @param status The GATStatus object, which associated status code * should be set. * @param code The new status code to be associated with the GATStatus * object. * * @return Returns @c #GAT_SUCCESS if the given status parameter is a * valid GATStatus object. If the given parameter was * not a valid GATStatus object, then @c #GAT_INVALID_HANDLE * is returned. */ GATResult GATStatus_SetStatusCode(GATStatus status, int code) { GATResult result = GAT_INVALID_HANDLE; if (NULL != status) { status->statuscode = code; result = GAT_SUCCESS; } return result; } /** int GATStatus_GetStatusCode(GATStatus status) * @brief Get the statuscode associated with the GATStatus object * * The function GATStatus_GetStatusCode returns the statuscode, which * was associated with the GATSTatus object with a call of the * @c #GATStatus_SetStatusCode function. * * @param status The GATStatus object, which associated status code * should be returned. * * @return The statuscode associated with the GATStatus object. If the * GATStatus under inspection was not a valid GATStatus (but not * equal zero), then @c #GAT_INVALID_HANDLE is returned. */ GATResult GATStatus_GetStatusCode(GATStatus_const status) { GATResult result = GAT_INVALID_HANDLE; if (NULL != status) { result = status->statuscode; } return result; } /** int GATStatus_AddChild(GATStatus status, GATStatus child) * @brief Adds a child to the list of children * * The function GATStatus_AddChild adds a GATStatus to the list of * children of this status object. Please note, that there is no test * to avoid cyclic hierarchies, so you'll have ensure, that a GATStatus * object is @b not inserted into a GATStatus hierarchy twice. * * @param status The GATStatus object, which should get the child added. * @param child The GATStatus object to be added as the child. * * @returns The function returns @c #GAT_SUCCESS, if the child was * successfully added to the list of children. If the status * parameter wasn't a valid GATStatus object, then the value * @c #GAT_INVALID_HANDLE is returned. */ GATResult GATStatus_AddChild(GATStatus status, GATStatus child) { GATResult result = GAT_INVALID_HANDLE; if (NULL != status && NULL != child) { if (NULL == status->children) { /* no children attached so far, create the list */ status->children = GATList_GATStatus_Create(); if (NULL == status->children) { result = GAT_MEMORYFAILURE; } } /* if there isn't a valid child list at this point, then something went wrong */ if (NULL != status->children) { /* add the given GATStatus as the last child to this */ GATList_GATStatus_Iterator end = GATList_GATStatus_End(status->children); GATList_GATStatus_Iterator item = GATList_GATStatus_Insert(status->children, end, child); if (NULL != item) { /* set back pointer to the parent */ GATStatus new_child = *GATList_GATStatus_Get(item); new_child->parent = status; result = GAT_SUCCESS; } } } return result; } /** GATList_GATStatus_const GATStatus_GetChildren(GATStatus status) * @brief Get the list of associated children * * The function GATStatus_GetChildren returns the list of children * associated with the given GATStatus. * * @param status The GATStatus object, for which the list of children is to * be returned. * * @return The function returns the handle of a GATList_GATStatus object, * which holds the GATStatus objects associated as children. If the * status parameter does not represent a valid GATStatus object or if * there aren't any associated children, then 0 (zero) is returned. */ GATList_GATStatus_const GATStatus_GetChildren(GATStatus_const status) { GATList_GATStatus result = NULL; if (NULL != status) { result = status->children; } return result; } /** int GATStatus_AddMessage(GATStatus status, char const *message) * @brief Add a message to the GATStatus object * * The function GATStatus_AddMessage adds a message to the list of * messages associated with this GATStatus object. * * @param status The GATStatus object the message has to be * associated with. * @param message The character string to be associated with the * GATStatus object. Note, that actually a copy of this string * is stored inside the GATStatus object. * * @return If the message was added successfully to the list of associated * messages of this GATSTatus, the function will return @c #GAT_SUCCESS. * If the status parameter does not represent a valid GATStatus object * the function returns @c #GAT_INVALID_HANDLE. */ GATResult GATStatus_AddMessage(GATStatus status, char const *message) { GATResult result = GAT_INVALID_HANDLE; if (NULL != status) { GATList_String_Iterator item = GATList_String_Insert( status->messages, GATList_String_End(status->messages), message); result = (NULL == item) ? GAT_MEMORYFAILURE : GAT_SUCCESS; } return result; } /** GATList_String_const GATStatus_GetMessages(GATStatus status) * @brief get the list of associated messages * * The function GATStatus_GetMessages returns the list of associated messages. * * @param status The GATStatus object, for which the list of messages is to * be returned. * * @return The function returns the handle of a GATList_String object, * which holds the messages associated with this object. If the * status parameter does not represent a valid GATStatus object, * then 0 (zero) is returned. */ GATList_String_const GATStatus_GetMessages(GATStatus_const status) { GATList_String result = NULL; if (NULL != status) { result = status->messages; } return result; } /** GATStatus GATStatus_GetParent(GATStatus status) * @brief Get the parent status of this GATStatus object * * The function GATStatus_GetParent returns the GATStatus object, which is the * direct parent of this status object. This is meaningful especially because, * different GATStatus objects may be organized in a hierarchical way. * * @param status The GATStatus object, for which the direct parent is to be * returned * * @return The function returns the GATStatus, which is stored as the direct * parent of this status object. If the status parameter does not * represent a valid GATStatus object, then 0 (zero) is returned. */ GATStatus_const GATStatus_GetParent(GATStatus_const status) { GATStatus_const result = NULL; if (NULL != status) { result = status->parent; } return result; } /** GATStatus_Trace * * The function GATStatus_Trace prints out to stderr the content of the given * GATStatus object. * * @param status The object for which to print the error information. */ void GATStatus_Trace(GATStatus_const status) { if (NULL != status) { fprintf(stderr, "GAT error backtrace:\n"); GATStatus_TraceLevel(stderr, status, 0); fprintf(stderr, "\n"); fflush(stderr); } } /* Local functions */ /** GATStatus_DeSerialise_Create * * The function GATStatus_DeSerialise_Create creates a new GATStatus object. * * @param context The GAT context to use for creation of the GATStatus object. * @param stream The object from which the adaptor should read the streamed * instance data. * @param code The status code of the new object. * @param messages The list of messages associated with the new created object. * @param children The list of child GATStatus objects associated with the * new object. * @param new_object The pointer to the variable, which should receive the * newly constructed GATStatus object. * * @return An error code. */ static GATResult GATStatus_DeSerialise_Create(GATContext context, GATObject stream, GATResult code, GATList_String messages, GATList_GATStatus children, char const *filename, GATuint32 lineno, GATStatus *object) { GAT_USES_STATUS(context, "GATStatus_DeSerialise_Create"); GATStatus new_object = (GATStatus) malloc(sizeof(struct GATStatus_S)); if(NULL != new_object) { memset(new_object, 0, sizeof(struct GATStatus_S)); new_object->GATObject__vtable = &GATStatus__vtable; new_object->GATSerialisable__vtable = &GATStatus_ISerialisable__vtable; new_object->isdirty = GATFalse; new_object->statuscode = code; strcpy(new_object->filename, filename); new_object->linenumber = lineno; GAT_CREATE_STATUS(GATList_String_Clone(messages, &new_object->messages)); /* set the new object as the parent for the childlist */ if (GAT_SUCCEEDED(GAT_CURRENT_STATUS()) && NULL != children) { GAT_CREATE_STATUS(GATList_GATStatus_Clone(children, &new_object->children)); if (NULL != new_object->children) { GATList_GATStatus_Iterator it = GATList_GATStatus_Begin(new_object->children); GATList_GATStatus_Iterator end = GATList_GATStatus_End(new_object->children); for (/**/; it != end && GAT_SUCCEEDED(GAT_CURRENT_STATUS()); it = GATList_GATStatus_Next(it)) { GATStatus *child = GATList_GATStatus_Get(it); GAT_CREATE_STATUS_IF(NULL == child, GAT_FAIL); GAT_CREATE_STATUS(GATStatus_SetParent(new_object, *child)); } } } } else { GAT_CREATE_STATUS(GAT_MEMORYFAILURE); } if (GAT_SUCCEEDED(GAT_CURRENT_STATUS())) { if (NULL != new_object) { *object = new_object; } else { GATStatus_Destroy(&new_object); GAT_CREATE_STATUS(GAT_INVALID_PARAMETER); } } else { GATStatus_Destroy(&new_object); } return GAT_RETURN_STATUS(); } /** GATStatus_SetParent * * */ static GATResult GATStatus_SetParent(GATStatus status, GATStatus_const parent) { GATResult retval = GAT_INVALID_HANDLE; if (NULL != status) { status->parent = parent; retval = GAT_SUCCESS; } return retval; } /** GATStatus_TraceLevel * */ static void GATStatus_TraceLevel(FILE *fp, GATStatus_const status, int level) { int code = GATStatus_GetStatusCode(status); char fmt[32]; char buffer[4096]; GATuint32 written = 0; GATResult retval = GAT_SUCCESS; if (GAT_SUCCESS != code) { retval = GATSelf_ResolveErrorMessage(code, buffer, sizeof(buffer), &written); } /* prepare indentation format string */ memset(fmt, 0, sizeof(fmt)); sprintf(fmt, "%%%d.%ds", level, level); /* print out the status code */ if (GAT_SUCCESS != code) { fprintf(fp, fmt, ""); /* indent */ if (strlen(status->filename) > 0) { fprintf(fp, "Statuscode: 0x%x (%s) at (%s): %d\n", code, GAT_SUCCEEDED(retval) ? buffer : "unknown status code", status->filename, status->linenumber); } else { fprintf(fp, "Statuscode: 0x%x (%s)\n", code, GAT_SUCCEEDED(retval) ? buffer : "unknown status code"); } } /* print out all attached messages */ { GATList_String_const messages = GATStatus_GetMessages(status); GATList_String_Iterator msg = GATList_String_Begin(messages); GATList_String_Iterator msg_end = GATList_String_End(messages); int i; GATBool first = GATTrue; for (i = 0; msg != msg_end; msg = GATList_String_Next(msg), ++i) { fprintf(fp, fmt, ""); /* indent */ if (GAT_SUCCESS == code && GATTrue == first) { /* this is the routine name */ fprintf(fp, "Routine: %s\n", GATList_String_Get(msg)); first = GATFalse; } else { fprintf(fp, " %s\n", GATList_String_Get(msg)); } } } /* print out the information for all attached children */ { GATList_GATStatus_const children = GATStatus_GetChildren(status); if (NULL != children) { GATList_GATStatus_Iterator it = GATList_GATStatus_Begin(children); GATList_GATStatus_Iterator end = GATList_GATStatus_End(children); int j; for (j = 0; it != end; it = GATList_GATStatus_Next(it), ++j) { GATStatus child = *GATList_GATStatus_Get(it); /* ensure the consistency of the hierarchy */ assert(GATStatus_GetParent(child) == status); /* print out all the information of this child */ GATStatus_TraceLevel(fp, child, level + 1); } } } }