DLL.c

/*
    Copyright (C) 2020,2021 TMax-Electronics.de
   
    This file is part of the MidiStick Firmware.

    the MidiStick Firmware is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    the MidiStick Firmware is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with the MidiStick Firmware.  If not, see <https://www.gnu.org/licenses/>.
*/

#include <xc.h>
#include <stdint.h>

#include "DLL.h"
#include "ADSREngine.h"

typedef struct{
    uint32_t nextUID;
} HeadData;

DLLObject * createNewDll(){
    DLLObject * head = malloc(sizeof(DLLObject));
    HeadData * headData = malloc(sizeof(HeadData));
    headData->nextUID = 0;
    head->uid = 0;
    head->data = (void*) headData;
    head->next = head;
    head->prev = head;
    return head;
}

void DLL_clear(DLLObject * listHead){
    DLLObject * currObject = listHead->next;
    while(currObject != listHead){
        currObject = currObject->next;
        DLL_remove(currObject->prev);
    }
}

uint32_t DLL_add(void * data, DLLObject * listHead){
    //allocate memory for new object
    DLLObject * newObject = malloc(sizeof(DLLObject));
    
    //relink objects
    listHead->prev->next = newObject;
    newObject->prev = listHead->prev;
    listHead->prev = newObject;
    newObject->next = listHead;
    
    //set new object's data
    newObject->uid = ((HeadData*) listHead->data)->nextUID++;
    newObject->data = data;
    
    return newObject->uid;
}

void * DLL_find(void * dataPtr, DLLObject * listHead){
    DLLObject * currObject = listHead->next;
    while(currObject != listHead){
        if(currObject->data == dataPtr) return currObject->data; //target object found
        currObject = currObject->next;
    }
    return 0; //object not found
}

void * DLL_get(uint16_t index, DLLObject * listHead){
    DLLObject * currObject = listHead->next;
    if(currObject == listHead) return 0;
    uint16_t currIndex = 0;
    for(; currIndex < index; currIndex ++){
        currObject = listHead->next;
        if(currObject == listHead) return 0;
    }
    return currObject->data;
}

unsigned DLL_isEmpty(DLLObject * listHead){
    return listHead->next == listHead;
}

/*void removeListEntry(void * targetDataPtr, DLLObject * listHead){
    DLLObject * currObject = listHead->next;
    while(currObject->data != targetDataPtr){
        currObject = currObject.next;
        if(currObject == listHead) return;
    }
    removeListEntry(currObject);
}*/

void DLL_remove(DLLObject * target){
    
    //UART_print("removed 0x%08x from a DLL\r\n", target);
    target->prev->next = target->next;
    target->next->prev = target->prev;
    free(target);
}

void DLL_pop(DLLObject * listHead){
    DLL_remove(listHead->next);
}

void DLL_moveToEnd(DLLObject * currObject, DLLObject * listHead){
    currObject->prev->next = currObject->next;
    currObject->next->prev = currObject->prev;
    
    listHead->prev->next = currObject;
    currObject->prev = listHead->prev;
    listHead->prev = currObject;
    currObject->next = listHead;
} 

void DLL_dump(DLLObject * listHead){
    UART_sendString("\r\nDLL Dump:", 1);
    UART_print("Head (%d) : 0x%08x  (data: 0x%08x)\r\n", listHead->uid, listHead, listHead->data);
    DLLObject * currObject = listHead->next;
    while(currObject != listHead){
        UART_print("%d: 0x%08x (data: 0x%08x)\r\n", currObject->uid, currObject, currObject->data);
        currObject = currObject->next;
    }
    UART_sendString("-------------\r\n", 1);
}