msglog.c

Go to the documentation of this file.

/*  *************************************************************************************
    Copyright (c) 2021, Lowell D. Thomas
    All rights reserved.
    
    This file is part of APG Version 7.0.
    APG Version 7.0 may be used under the terms of the BSD 2-Clause License.
    
    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions are met:
    
    1. Redistributions of source code must retain the above copyright notice, this
       list of conditions and the following disclaimer.
    
    2. Redistributions in binary form must reproduce the above copyright notice,
       this list of conditions and the following disclaimer in the documentation
       and/or other materials provided with the distribution.
    
    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
    DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
    FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
    DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
    SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
    OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    
*   *************************************************************************************/
#include "../library/lib.h"
 
static const void* s_vpMagicNumber = (void*)"msglog";
 
typedef struct {
    const void *vpValidate; 
    exception* spException; 
    void *vpMem; 
    aint uiMsgCount; 
    void *vpVecMsgs; 
    void *vpVecIndexes; 
    aint uiNext; 
} msgs;
 
void* vpMsgsCtor(exception* spEx) {
    if(bExValidate(spEx)){
        void* vpMem = vpMemCtor(spEx);
        msgs *spCtx = (msgs*) vpMemAlloc(vpMem, sizeof(msgs));
        memset((void*) spCtx, 0, sizeof(msgs));
        spCtx->vpMem = vpMem;
        spCtx->spException = spEx;
        spCtx->vpVecMsgs = vpVecCtor(vpMem, sizeof(char), 1024); // 16 messages of average 64 characters
        spCtx->vpVecIndexes = vpVecCtor(vpMem, sizeof(aint), 16); // 16 messages
        spCtx->vpValidate = s_vpMagicNumber;
        return (void*) spCtx;
    }else{
        vExContext();
    }
    return NULL;
}
 
void vMsgsDtor(void *vpCtx) {
    msgs *spCtx = (msgs*) vpCtx;
    if(vpCtx){
        if(spCtx->vpValidate == s_vpMagicNumber){
            void* vpMem = spCtx->vpMem;
            memset(vpCtx, 0, sizeof(msgs));
            vMemDtor(vpMem);
        }else{
            vExContext();
        }
    }
}
 
abool bMsgsValidate(void *vpCtx){
    msgs *spCtx = (msgs*) vpCtx;
    if (spCtx && (spCtx->vpValidate == s_vpMagicNumber)) {
        return APG_TRUE;
    }
    return APG_FALSE;
}
 
void vMsgsClear(void *vpCtx) {
    msgs *spCtx = (msgs*) vpCtx;
    if (spCtx && (spCtx->vpValidate == s_vpMagicNumber)) {
        vVecClear(spCtx->vpVecMsgs);
        vVecClear(spCtx->vpVecIndexes);
        spCtx->uiNext = 0;
        spCtx->uiMsgCount = 0;
    }else{
        vExContext();
    }
}
 
void vMsgsLog(void *vpCtx, const char *cpMsg) {
    msgs *spCtx = (msgs*) vpCtx;
    if (spCtx && (spCtx->vpValidate == s_vpMagicNumber)) {
        if(!cpMsg || !cpMsg[0]){
            XTHROW(spCtx->spException, "NULL or empty messages not allowed");
        }
        // push the message & its index
        aint uiIndex = uiVecLen(spCtx->vpVecMsgs);
        vpVecPushn(spCtx->vpVecMsgs, (void*) cpMsg, (aint) (strlen(cpMsg) + 1));
        vpVecPush(spCtx->vpVecIndexes, (void*) &uiIndex);
        spCtx->uiMsgCount++;
    }else{
        vExContext();
    }
}
 
const char* cpMsgsFirst(void *vpCtx) {
    char *cpReturn = NULL;
    msgs *spCtx = (msgs*) vpCtx;
    if (spCtx && (spCtx->vpValidate == s_vpMagicNumber)) {
        if (spCtx->uiMsgCount) {
            cpReturn = (char*) vpVecFirst(spCtx->vpVecMsgs);
            spCtx->uiNext = 1;
        }
    }else{
        vExContext();
    }
    return cpReturn;
}
 
const char* cpMsgsNext(void *vpCtx) {
    char *cpReturn = NULL;
    msgs *spCtx = (msgs*) vpCtx;
    if (spCtx && (spCtx->vpValidate == s_vpMagicNumber)) {
        if (spCtx->uiMsgCount && spCtx->uiNext && (spCtx->uiNext < spCtx->uiMsgCount)) {
            aint *uipIndex = (aint*) vpVecAt(spCtx->vpVecIndexes, spCtx->uiNext);
            if (uipIndex) {
                char *cpMsg = (char*) vpVecAt(spCtx->vpVecMsgs, *uipIndex);
                if (cpMsg) {
                    cpReturn = cpMsg;
                    spCtx->uiNext++;
                } else {
                    // this should never happen
                    XTHROW(spCtx->spException, "unable to retrieve a saved message");
                }
            } // else {end of messages}
        }
    }else{
        vExContext();
    }
    return cpReturn;
}
 
aint uiMsgsCount(void *vpCtx) {
    aint uiReturn = 0;
    msgs *spCtx = (msgs*) vpCtx;
    if (spCtx && (spCtx->vpValidate == s_vpMagicNumber)) {
        uiReturn = spCtx->uiMsgCount;
    }else{
        vExContext();
    }
    return uiReturn;
}