The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
/* Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#define C_LUCY_RAMFILEHANDLE
#include "Lucy/Util/ToolSet.h"

#include "Lucy/Store/RAMFileHandle.h"
#include "Lucy/Store/RAMFile.h"
#include "Lucy/Store/FileWindow.h"

RAMFileHandle*
RAMFH_open(String *path, uint32_t flags, RAMFile *file) {
    RAMFileHandle *self = (RAMFileHandle*)Class_Make_Obj(RAMFILEHANDLE);
    return RAMFH_do_open(self, path, flags, file);
}

RAMFileHandle*
RAMFH_do_open(RAMFileHandle *self, String *path, uint32_t flags,
              RAMFile *file) {
    bool must_create
        = (flags & (FH_CREATE | FH_EXCLUSIVE)) == (FH_CREATE | FH_EXCLUSIVE)
          ? true : false;
    bool can_create
        = (flags & (FH_CREATE | FH_WRITE_ONLY)) == (FH_CREATE | FH_WRITE_ONLY)
          ? true : false;

    FH_do_open((FileHandle*)self, path, flags);
    RAMFileHandleIVARS *const ivars = RAMFH_IVARS(self);

    // Obtain a RAMFile.
    if (file) {
        if (must_create) {
            Err_set_error(Err_new(Str_newf("File '%o' exists, but FH_EXCLUSIVE flag supplied", path)));
            DECREF(self);
            return NULL;
        }
        ivars->ram_file = (RAMFile*)INCREF(file);
    }
    else if (can_create) {
        ivars->ram_file = RAMFile_new(NULL, false);
    }
    else {
        Err_set_error(Err_new(Str_newf("Must supply either RAMFile or FH_CREATE | FH_WRITE_ONLY")));
        DECREF(self);
        return NULL;
    }

    // Prevent writes to to the RAMFile if FH_READ_ONLY was specified.
    if (flags & FH_READ_ONLY) {
        RAMFile_Set_Read_Only(ivars->ram_file, true);
    }

    ivars->contents = (ByteBuf*)INCREF(RAMFile_Get_Contents(ivars->ram_file));
    ivars->len      = BB_Get_Size(ivars->contents);

    return self;
}

void
RAMFH_Destroy_IMP(RAMFileHandle *self) {
    RAMFileHandleIVARS *const ivars = RAMFH_IVARS(self);
    DECREF(ivars->ram_file);
    DECREF(ivars->contents);
    SUPER_DESTROY(self, RAMFILEHANDLE);
}

bool
RAMFH_Window_IMP(RAMFileHandle *self, FileWindow *window, int64_t offset,
                 int64_t len) {
    RAMFileHandleIVARS *const ivars = RAMFH_IVARS(self);
    int64_t end = offset + len;
    if (!(ivars->flags & FH_READ_ONLY)) {
        Err_set_error(Err_new(Str_newf("Can't read from write-only handle")));
        return false;
    }
    else if (offset < 0) {
        Err_set_error(Err_new(Str_newf("Can't read from negative offset %i64",
                                       offset)));
        return false;
    }
    else if (end > ivars->len) {
        Err_set_error(Err_new(Str_newf("Tried to read past EOF: offset %i64 + request %i64 > len %i64",
                                       offset, len, ivars->len)));
        return false;
    }
    else {
        char *const buf = BB_Get_Buf(ivars->contents) + offset;
        FileWindow_Set_Window(window, buf, offset, len);
        return true;
    }
}

bool
RAMFH_Release_Window_IMP(RAMFileHandle *self, FileWindow *window) {
    UNUSED_VAR(self);
    FileWindow_Set_Window(window, NULL, 0, 0);
    return true;
}

bool
RAMFH_Read_IMP(RAMFileHandle *self, char *dest, int64_t offset, size_t len) {
    RAMFileHandleIVARS *const ivars = RAMFH_IVARS(self);
    int64_t end = offset + len;
    if (!(ivars->flags & FH_READ_ONLY)) {
        Err_set_error(Err_new(Str_newf("Can't read from write-only handle")));
        return false;
    }
    else if (offset < 0) {
        Err_set_error(Err_new(Str_newf("Can't read from a negative offset %i64",
                                       offset)));
        return false;
    }
    else if (end > ivars->len) {
        Err_set_error(Err_new(Str_newf("Attempt to read %u64 bytes starting at %i64 goes past EOF %u64",
                                       (uint64_t)len, offset, ivars->len)));
        return false;
    }
    else {
        const char *const source = BB_Get_Buf(ivars->contents) + offset;
        memcpy(dest, source, len);
        return true;
    }
}

bool
RAMFH_Write_IMP(RAMFileHandle *self, const void *data, size_t len) {
    RAMFileHandleIVARS *const ivars = RAMFH_IVARS(self);
    if (ivars->flags & FH_READ_ONLY) {
        Err_set_error(Err_new(Str_newf("Attempt to write to read-only RAMFile")));
        return false;
    }
    BB_Cat_Bytes(ivars->contents, data, len);
    ivars->len += len;
    return true;
}

bool
RAMFH_Grow_IMP(RAMFileHandle *self, int64_t len) {
    RAMFileHandleIVARS *const ivars = RAMFH_IVARS(self);
    if (len > INT32_MAX) {
        Err_set_error(Err_new(Str_newf("Can't support RAM files of size %i64 (> %i32)",
                                       len, (int32_t)INT32_MAX)));
        return false;
    }
    else if (ivars->flags & FH_READ_ONLY) {
        Err_set_error(Err_new(Str_newf("Can't grow read-only RAMFile '%o'",
                                       ivars->path)));
        return false;
    }
    else {
        BB_Grow(ivars->contents, (size_t)len);
        return true;
    }
}

RAMFile*
RAMFH_Get_File_IMP(RAMFileHandle *self) {
    return RAMFH_IVARS(self)->ram_file;
}

int64_t
RAMFH_Length_IMP(RAMFileHandle *self) {
    return RAMFH_IVARS(self)->len;
}

bool
RAMFH_Close_IMP(RAMFileHandle *self) {
    UNUSED_VAR(self);
    return true;
}