ObjectStore.h

Go to the documentation of this file.

#pragma once

#include "Object.h"
#include "Error.h"
#include <Storage/Partition.h>

namespace IFS
{
struct ObjRef {
    uint32_t offset{0}; 
    Object::ID id{0};
    uint8_t handle{0};  
    uint8_t storenum{0};  
    uint8_t readCount{0}; 
    uint8_t refCount{0};  

    ObjRef()
    {
    }

    ObjRef(const ObjRef& parent, Object::ID objID)
    {
        storenum = parent.storenum;
        id = objID;
    }

    ObjRef(uint32_t fileid)
    {
        storenum = fileid >> 16;
        id = fileid & 0xffff;
    }

    ~ObjRef()
    {
        assert(refCount == 0);
    }

    uint32_t fileID() const
    {
        return (storenum << 16) | id;
    }
};

struct FWObjDesc {
    Object obj; 
    ObjRef ref; 

    FWObjDesc()
    {
    }

    FWObjDesc(const ObjRef& objRef) : ref(objRef)
    {
    }

    FWObjDesc(uint32_t fileid) : ref(fileid)
    {
    }

    uint32_t nextOffset() const
    {
        return ref.offset + obj.sizeAligned();
    }

    // Move to next object location
    void next()
    {
        ref.offset = nextOffset();
        ++ref.id;
    }

    uint32_t contentOffset() const
    {
        return ref.offset + obj.contentOffset();
    }

    uint32_t childTableOffset() const
    {
        return ref.offset + obj.childTableOffset();
    }
};

class IObjectStore
{
public:
    virtual ~IObjectStore()
    {
    }

    virtual int initialise() = 0;

    virtual int mounted(const FWObjDesc& od) = 0;

    virtual bool isMounted() = 0;

    virtual int open(FWObjDesc& od) = 0;

    virtual int openChild(const FWObjDesc& parent, const FWObjDesc& child, FWObjDesc& od) = 0;

    virtual int readHeader(FWObjDesc& od) = 0;

    virtual int readChildHeader(const FWObjDesc& parent, FWObjDesc& child) = 0;

    virtual int readContent(const FWObjDesc& od, uint32_t offset, uint32_t size, void* buffer) = 0;

    virtual int close(FWObjDesc& od) = 0;

    virtual Storage::Partition& getPartition() = 0;
};

} // namespace IFS