file.h

Go to the documentation of this file.

 
 
 
#pragma once
 
#include <cx/cx.h>
#include <cx/fs/fs.h>
#include <cx/fs/fileobj.h>
 
CX_C_BEGIN
 
// Internal function - use fileClose() macro instead
_At_(*file, _Pre_maybenull_ _Post_null_)
_meta_inline bool _fileClose(_Inout_ File** file)
{
    bool ret = fileCloseHandle(*file);
    objRelease(file);
    return ret;
}
 
#define fileClose(pfile) (unused_noeval(&((*(pfile))->_is_File)), _fileClose((File**)(pfile)))
 
typedef File FSFile;
 
_Ret_opt_valid_ FSFile* fsOpen(_In_opt_ strref path, flags_t flags);
 
_meta_inline bool fsRead(_Inout_ FSFile* file, _Out_writes_bytes_to_(sz, *bytesread) void* buf,
                         size_t sz, _Out_ _Deref_out_range_(0, sz) size_t* bytesread)
{
    if (!file) {
        *bytesread = 0;
        return false;
    }
    return fileRead(file, buf, sz, bytesread);
}
 
_meta_inline bool fsWrite(_Inout_ FSFile* file, _In_reads_bytes_(sz) const void* buf, size_t sz,
                          _Out_opt_ _Deref_out_range_(0, sz) size_t* byteswritten)
{
    if (!file) {
        if (byteswritten)
            *byteswritten = 0;
        return false;
    }
    return fileWrite(file, buf, sz, byteswritten);
}
 
_meta_inline bool fsWriteString(_Inout_ FSFile* file, _In_opt_ strref str,
                                _Out_opt_ size_t* byteswritten)
{
    if (!file) {
        if (byteswritten)
            *byteswritten = 0;
        return false;
    }
    return fileWriteString(file, str, byteswritten);
}
 
_meta_inline int64 fsTell(_Inout_ FSFile* file)
{
    if (!file)
        return -1;
    return fileTell(file);
}
 
_meta_inline int64 fsSeek(_Inout_ FSFile* file, int64 off, FSSeekType seektype)
{
    if (!file)
        return -1;
    return fileSeek(file, off, seektype);
}
 
_meta_inline bool fsFlush(_Inout_ FSFile* file)
{
    if (!file)
        return false;
    return fileFlush(file);
}
 
 
CX_C_END