linesu.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"
#include "./linesu.h"
 
 
#define LF  0x0A 
#define VT  0x0B 
#define FF  0x0C 
#define CR  0x0D 
#define NEL 0x85 
#define LS  0x2028 
#define PS  0x2029 
 
static const void* s_vpMagicNumber = (void*)"lines_u";
 
typedef struct{
    const void* vpValidate; 
    exception* spException; 
    void* vpMem; 
    uint32_t* uipInput; 
    aint uiLength; 
    void* vpVecLines; 
    line_u* spLines; 
    aint uiLineCount; 
    aint uiIterator; 
} lines_u;
 
static void vInputLines(lines_u* spCtx);
static abool bFindLine(line_u* spLines, aint uiLineCount, aint uiCharIndex, aint* uipLine);
 
void* vpLinesuCtor(exception* spEx, const uint32_t* uipInput, aint uiLength){
    if(bExValidate(spEx)){
        if(!uipInput || !uiLength){
            XTHROW(spEx, "input is NULL or empty");
        }
        // get the context
        void* vpMem = vpMemCtor(spEx);
        lines_u* spCtx = (lines_u*)vpMemAlloc(vpMem, sizeof(lines_u));
        memset((void*)spCtx, 0, sizeof(lines_u));
        spCtx->uipInput = (uint32_t*)vpMemAlloc(vpMem, ((sizeof(uint32_t) * uiLength)));
        memcpy((void*)spCtx->uipInput, (void*)uipInput, (sizeof(uint32_t) * uiLength));
        spCtx->uiLength = uiLength;
        spCtx->vpMem = vpMem;
        spCtx->spException = spEx;
        spCtx->vpVecLines = vpVecCtor(vpMem, sizeof(line_u), 512);
 
        // compute lines
        vInputLines(spCtx);
        spCtx->vpValidate = s_vpMagicNumber;
        return (void*)spCtx;
    }else{
        vExContext();
    }
    return NULL;
}
 
void vLinesuDtor(void* vpCtx){
    lines_u* spCtx = (lines_u*)vpCtx;
    if(vpCtx){
        if(spCtx->vpValidate == s_vpMagicNumber){
            // otherwise, just free what was allocated explicitly
            void* vpMem = spCtx->vpMem;
            memset(vpCtx, 0, sizeof(lines_u));
            vMemDtor(vpMem);
        }else{
            vExContext();
        }
    }
}
 
abool bLinesuFindLine(void* vpCtx, aint uiOffset, aint* uipLine, aint* uipRelOffset){
    abool bReturn = APG_FAILURE;
    lines_u* spCtx = (lines_u*)vpCtx;
    if(vpCtx && (spCtx->vpValidate == s_vpMagicNumber)){
        if(!uipLine || !uipRelOffset){
            XTHROW(spCtx->spException, "line and relative offset pointers cannot be NULL");
        }
        if(bFindLine(spCtx->spLines, spCtx->uiLineCount, uiOffset, uipLine)){
            *uipRelOffset = uiOffset - spCtx->spLines[*uipLine].uiCharIndex;
            bReturn = APG_SUCCESS;
        }
    }else{
        vExContext();
    }
    return bReturn;
}
 
line_u* spLinesuFirst(void* vpCtx){
    lines_u* spCtx = (lines_u*)vpCtx;
    if(vpCtx && (spCtx->vpValidate == s_vpMagicNumber)){
        spCtx->uiIterator = 1;
        return spCtx->spLines;
    }
    vExContext();
    return NULL;
}
line_u* spLinesuNext(void* vpCtx){
    lines_u* spCtx = (lines_u*)vpCtx;
    if(vpCtx && (spCtx->vpValidate == s_vpMagicNumber)){
        if(spCtx->uiIterator < spCtx->uiLineCount){
            return &spCtx->spLines[spCtx->uiIterator++];
        }
        return NULL;
    }
    vExContext();
    return NULL;
}
 
aint uiLinesuCount(void* vpCtx){
    lines_u* spCtx = (lines_u*)vpCtx;
    if(vpCtx && (spCtx->vpValidate == s_vpMagicNumber)){
        return spCtx->uiLineCount;
    }
    vExContext();
    return 0;
}
 
aint uiLinesuLength(void* vpCtx){
    lines_u* spCtx = (lines_u*)vpCtx;
    if(vpCtx && (spCtx->vpValidate == s_vpMagicNumber)){
        return spCtx->uiLength;
    }
    vExContext();
    return 0;
}
 
static abool bFindLine(line_u* spLines, aint uiLineCount, aint uiCharIndex, aint* uipLine) {
    abool bReturn = APG_FAILURE;
    if (!spLines || !uiLineCount) {
        goto fail;
    }
    aint ui;
    line_u* spThis;
    if (uiLineCount < 5) {
        // linear search
        for (ui = 0; ui < uiLineCount; ui += 1) {
            spThis = &spLines[ui];
            if ((uiCharIndex >= spThis->uiCharIndex) && (uiCharIndex < (spThis->uiCharIndex + spThis->uiLineLength))) {
                *uipLine = ui;
                goto success;
            }
        }
        goto fail;
    } else {
        // binary search (https://en.wikipedia.org/wiki/Binary_search_algorithm)
        aint uiL = 0;
        aint uiR = uiLineCount - 1;
        aint uiM;
        while (uiL < uiR) {
            uiM = uiL + (uiR - uiL) / 2;
            spThis = &spLines[uiM];
            if (uiCharIndex >= (spThis->uiCharIndex + spThis->uiLineLength)) {
                uiL = uiM + 1;
                continue;
            }
            if (uiCharIndex < spThis->uiCharIndex) {
                uiR = uiM - 1;
                continue;
            }
            *uipLine = uiM;
            goto success;
        }
        if (uiL == uiR) {
            spThis = &spLines[uiL];
            if ((uiCharIndex >= spThis->uiCharIndex) && (uiCharIndex < (spThis->uiCharIndex + spThis->uiLineLength))) {
                *uipLine = uiL;
                goto success;
            }
        }
        goto fail;
    }
    success: bReturn = APG_SUCCESS;
    fail: ;
    return bReturn;
}
 
static void vInputLines(lines_u* spCtx) {
    aint uiLineIndex = 0;
    aint uiCharIndex = 0;
    aint uiTextLength = 0;
    uint32_t uiChar;
    line_u sLine;
    void* vpVec = spCtx->vpVecLines;
    uint32_t* uipInput = spCtx->uipInput;
    aint uiLen = spCtx->uiLength;
    vVecClear(vpVec);
    while (uiCharIndex < uiLen) {
        uiChar = uipInput[uiCharIndex];
        if (uiChar == LF || uiChar == VT || uiChar == FF || uiChar == NEL || uiChar == LS || uiChar == PS ) {
            // LF line ending
            sLine.uiLineIndex = uiLineIndex;
            sLine.uiCharIndex = uiCharIndex - uiTextLength;
            sLine.uiTextLength = uiTextLength;
            sLine.uiLineLength = uiTextLength + 1;
            uiCharIndex += 1;
            sLine.uiaLineEnd[0] = uiChar;
            sLine.uiaLineEnd[1] = 0;
            sLine.uiaLineEnd[2] = 0;
            vpVecPush(vpVec, (void*) &sLine);
            uiLineIndex += 1;
            uiTextLength = 0;
        } else if (uiChar == CR) {
            sLine.uiLineIndex = uiLineIndex;
            sLine.uiCharIndex = uiCharIndex - uiTextLength;
            sLine.uiTextLength = uiTextLength;
            if ((uiCharIndex < (uiLen - 1)) && (uipInput[uiCharIndex + 1] == LF)) {
                // CRLF line ending
                sLine.uiLineLength = uiTextLength + 2;
                sLine.uiaLineEnd[0] = CR;
                sLine.uiaLineEnd[1] = LF;
                sLine.uiaLineEnd[2] = 0;
                uiCharIndex += 2;
            } else {
                // CR line ending
                sLine.uiLineLength = uiTextLength + 1;
                sLine.uiaLineEnd[0] = CR;
                sLine.uiaLineEnd[1] = 0;
                sLine.uiaLineEnd[2] = 0;
                uiCharIndex += 1;
            }
            vpVecPush(vpVec, (void*) &sLine);
            uiLineIndex += 1;
            uiTextLength = 0;
        } else {
            uiTextLength += 1;
            uiCharIndex += 1;
        }
    }
    if (uiTextLength > 0) {
        // last line had no line ending
        sLine.uiLineIndex = uiLineIndex;
        sLine.uiCharIndex = uiCharIndex - uiTextLength;
        sLine.uiTextLength = uiTextLength;
        sLine.uiLineLength = uiTextLength;
        sLine.uiaLineEnd[0] = 0;
        sLine.uiaLineEnd[1] = 0;
        sLine.uiaLineEnd[2] = 0;
        vpVecPush(vpVec, (void*) &sLine);
    }
    spCtx->spLines = (line_u*) vpVecFirst(spCtx->vpVecLines);
    spCtx->uiLineCount = uiVecLen(spCtx->vpVecLines);
}