plank_File.h

/*
 -------------------------------------------------------------------------------
 This file is part of the Plink, Plonk, Plank libraries
  by Martin Robinson
 
 http://code.google.com/p/pl-nk/
 
 Copyright University of the West of England, Bristol 2011-14
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 
 * Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
 * 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.
 * Neither the name of University of the West of England, Bristol nor 
   the names of its contributors may be used to endorse or promote products
   derived from this software without specific prior written permission.
 
 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 UNIVERSITY OF THE WEST OF ENGLAND, BRISTOL 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. 
 
 This software makes use of third party libraries. For more information see:
 doc/license.txt included in the distribution.
 -------------------------------------------------------------------------------
 */

#ifndef PLANK_TEXT_H
#define PLANK_TEXT_H

#include "../containers/plank_DynamicArray.h"
#include "plank_Path.h"

PLANK_BEGIN_C_LINKAGE

typedef struct PlankMulitFileReader* PlankMulitFileReaderRef; // would prefer to move this declaration

typedef struct PlankFile* PlankFileRef; 

#define PLANKFILE_READ                  (1 << 0)

#define PLANKFILE_WRITE                 (1 << 1)

#define PLANKFILE_BINARY                (1 << 2)

#define PLANKFILE_APPEND                (1 << 3)

#define PLANKFILE_NEW                   (1 << 4)

#define PLANKFILE_BIGENDIAN             (1 << 5)

#define PLANKFILE_OWNMULTI              (1 << 6)


#if PLANK_BIGENDIAN
    #define PLANKFILE_NATIVEENDIAN      PLANKFILE_BIGENDIAN
#elif PLANK_LITTLEENDIAN
    #define PLANKFILE_NATIVEENDIAN      (0)
#endif

#define PLANKFILE_DYNAMICARRAYOWNED     (1 << 6)

#define PLANKFILE_MASK                  (PLANKFILE_READ | PLANKFILE_WRITE | PLANKFILE_BINARY | PLANKFILE_APPEND | PLANKFILE_NEW)

#define PLANKFILE_ALL                   (PLANKFILE_MASK | PLANKFILE_BIGENDIAN)

#define PLANKFILE_STATUS_EOF                1
#define PLANKFILE_STATUS_ISPOSITIONABLE     2

#define PLANKFILE_STREAMTYPE_UNKNOWN        0
#define PLANKFILE_STREAMTYPE_FILE           1
#define PLANKFILE_STREAMTYPE_MEMORY         2
#define PLANKFILE_STREAMTYPE_DYNAMICARRAY   3
#define PLANKFILE_STREAMTYPE_NETWORK        4
#define PLANKFILE_STREAMTYPE_MULTI          5
#define PLANKFILE_STREAMTYPE_OTHER          999

#define PLANKFILE_SETPOSITION_ABSOLUTE       SEEK_SET
#define PLANKFILE_SETPOSITION_RELATIVE       SEEK_CUR
#define PLANKFILE_SETPOSITION_RELATIVEEND    SEEK_END

PlankResult pl_FileErase (const char* filepath);

PlankB pl_FileExists (const char* filepath, const PlankB isDirectory);
PlankResult pl_FileMakeDirectory (const char* filepath);


typedef PlankResult (*PlankFileOpenFunction)(PlankFileRef);
typedef PlankResult (*PlankFileCloseFunction)(PlankFileRef);
typedef PlankResult (*PlankFileClearFunction)(PlankFileRef);
typedef PlankResult (*PlankFileGetStatusFunction)(PlankFileRef, int, int*);
typedef PlankResult (*PlankFileReadFunction)(PlankFileRef, PlankP ptr, int, int*);
typedef PlankResult (*PlankFileWriteFunction)(PlankFileRef, const void*, const int);
typedef PlankResult (*PlankFileSetPositionFunction)(PlankFileRef, PlankLL, int);
typedef PlankResult (*PlankFileGetPositionFunction)(PlankFileRef, PlankLL*);

PlankFileRef pl_File_CreateAndInit();

PlankFileRef pl_File_Create();

PlankResult pl_File_Init (PlankFileRef p);

PlankResult pl_File_DeInit (PlankFileRef p);

PlankResult pl_File_Destroy (PlankFileRef p);

PlankResult pl_File_SetFunction (PlankFileRef p, 
                                 PlankFileOpenFunction openFunction, 
                                 PlankFileCloseFunction closeFunction,
                                 PlankFileClearFunction clearFunction,
                                 PlankFileGetStatusFunction statusFunction,
                                 PlankFileReadFunction readFunction,
                                 PlankFileWriteFunction writeFunction,
                                 PlankFileSetPositionFunction setPosFunction,
                                 PlankFileGetPositionFunction getPosFunction);

PlankResult pl_File_Open (PlankFileRef p, const char* filepath, const int mode);

PlankResult pl_File_OpenTextRead (PlankFileRef p, const char* filepath, const PlankB andWrite);

PlankResult pl_File_OpenTextWrite (PlankFileRef p, const char* filepath, const PlankB andRead, const PlankB replaceExistingFile);

PlankResult pl_File_OpenBinaryRead (PlankFileRef p, const char* filepath, const PlankB andWrite, const PlankB isBigEndian);

PlankResult pl_File_OpenBinaryWrite (PlankFileRef p, const char* filepath, const PlankB andRead, const PlankB replaceExistingFile, const PlankB isBigEndian);

PlankResult pl_File_OpenBinaryNativeEndianRead (PlankFileRef p, const char* filepath, const PlankB andWrite);

PlankResult pl_File_OpenBinaryNativeEndianWrite (PlankFileRef p, const char* filepath, const PlankB andRead, const PlankB replaceExistingFile);

PlankResult pl_File_OpenMemory (PlankFileRef p, void* memory, const PlankLL size, const int mode);

PlankResult pl_File_OpenDynamicArray (PlankFileRef p, PlankDynamicArrayRef memory, const int mode);

PlankResult pl_File_OpenMulti (PlankFileRef p, PlankMulitFileReaderRef multi, const int mode);

PlankResult pl_File_Copy (PlankFileRef p, PlankFileRef source, const PlankLL size);

PlankResult pl_File_Clear (PlankFileRef p);

PlankB pl_File_IsBigEndian (PlankFileRef p);

PlankB pl_File_IsLittleEndian (PlankFileRef p);

PlankB pl_File_IsNativeEndian (PlankFileRef p);

PlankB pl_File_IsPositionable (PlankFileRef p);

PlankResult pl_File_Close (PlankFileRef p);

PlankResult pl_File_SetPosition (PlankFileRef p, const PlankLL position);

PlankResult pl_File_OffsetPosition (PlankFileRef p, const PlankLL offset);

PlankResult pl_File_ResetPosition (PlankFileRef p);

PlankResult pl_File_SetPositionEnd (PlankFileRef p);

PlankB pl_File_IsValid (PlankFileRef p);

PlankB pl_File_IsEOF (PlankFileRef p);

PlankResult pl_File_SetEOF (PlankFileRef p);

PlankResult pl_File_GetPosition (PlankFileRef p, PlankLL* position);

PlankResult pl_File_SetMode (PlankFileRef p, const int mode);

PlankResult pl_File_GetMode (PlankFileRef p, int* mode);

PlankResult pl_File_GetStreamType (PlankFileRef p, int* type);

PlankResult pl_File_SetEndian (PlankFileRef p, const PlankB isBigEndian);

PlankResult pl_File_Read (PlankFileRef p, PlankP data, const int maximumBytes, int* bytesRead);

PlankResult pl_File_ReadC (PlankFileRef p, char* data);

PlankResult pl_File_ReadS (PlankFileRef p, short* data);

PlankResult pl_File_ReadI (PlankFileRef p, int* data);

PlankResult pl_File_ReadI24 (PlankFileRef p, PlankI24* data);


//PlankResult pl_File_ReadL (PlankFileRef p, PlankL* data);

PlankResult pl_File_ReadLL (PlankFileRef p, PlankLL* data);

PlankResult pl_File_ReadUC (PlankFileRef p, unsigned char* data);

PlankResult pl_File_ReadUS (PlankFileRef p, unsigned short* data);

PlankResult pl_File_ReadUI (PlankFileRef p, unsigned int* data);

PlankResult pl_File_ReadUI24 (PlankFileRef p, PlankUI24* data);

PlankResult pl_File_ReadUL (PlankFileRef p, PlankUL* data);

PlankResult pl_File_ReadULL (PlankFileRef p, PlankULL* data);

PlankResult pl_File_ReadF (PlankFileRef p, float* data);

PlankResult pl_File_ReadD (PlankFileRef p, double* data);

PlankResult pl_File_ReadFourCharCode (PlankFileRef p, PlankFourCharCode* data);

PlankResult pl_File_ReadGUID (PlankFileRef p, PlankGUIDRef guid);


PlankResult pl_File_ReadPascalString255 (PlankFileRef p, PlankPascalString255* string);


PlankResult pl_File_ReadLine (PlankFileRef p, char* text, const int maximumLength);

PlankResult pl_File_SkipBytes (PlankFileRef p, const int numBytes);


PlankResult pl_File_Write (PlankFileRef p, const void* data, const int maximumBytes);

PlankResult pl_File_WriteDynamicArray (PlankFileRef p, PlankDynamicArrayRef array);

PlankResult pl_File_WriteZeros (PlankFileRef p, const int numBytes);

PlankResult pl_File_WriteC (PlankFileRef p, char data);

PlankResult pl_File_WriteS (PlankFileRef p, short data);

PlankResult pl_File_WriteI (PlankFileRef p, int data);

PlankResult pl_File_WriteI24 (PlankFileRef p, PlankI24 data);

//PlankResult pl_File_WriteL (PlankFileRef p, PlankL data);

PlankResult pl_File_WriteLL (PlankFileRef p, PlankLL data);

PlankResult pl_File_WriteUC (PlankFileRef p, unsigned char data);

PlankResult pl_File_WriteUS (PlankFileRef p, unsigned short data);

PlankResult pl_File_WriteUI (PlankFileRef p, unsigned int data);

PlankResult pl_File_WriteUI24 (PlankFileRef p, PlankUI24 data);

PlankResult pl_File_WriteUL (PlankFileRef p, PlankUL data);

PlankResult pl_File_WriteULL (PlankFileRef p, PlankULL data);

PlankResult pl_File_WriteF (PlankFileRef p, float data);

PlankResult pl_File_WriteD (PlankFileRef p, double data);

PlankResult pl_File_WriteFourCharCode (PlankFileRef p, PlankFourCharCode data);

PlankResult pl_File_WriteGUID (PlankFileRef p, const PlankGUID* guid);


PlankResult pl_File_WriteString (PlankFileRef p, const char* text);

PlankResult pl_File_WriteLine (PlankFileRef p, const char* text);

PlankResult pl_File_WritePascalString255 (PlankFileRef p, PlankPascalString255* string);

PlankResult pl_FileDefaultOpenCallback (PlankFileRef p);
PlankResult pl_FileDefaultCloseCallback (PlankFileRef p);
PlankResult pl_FileDefaultGetStatusCallback (PlankFileRef p, int type, int* status);
PlankResult pl_FileDefaultReadCallback (PlankFileRef p, PlankP ptr, int maximumBytes, int* bytesRead);
PlankResult pl_FileDefaultWriteCallback (PlankFileRef p, const void* data, const int maximumBytes);
PlankResult pl_FileDefaultSetPositionCallback (PlankFileRef p, PlankLL offset, int code);
PlankResult pl_FileDefaultGetPositionCallback (PlankFileRef p, PlankLL* position);



PLANK_END_C_LINKAGE

#if !DOXYGEN
typedef struct PlankFile
{
    void *stream; // must be first?
    PlankUS mode;
    PlankUS type;
    PlankLL size;
    PlankLL position;
    char path[PLANKPATH_MAXLENGTH];
        
    PlankFileOpenFunction           openFunction;
    PlankFileCloseFunction          closeFunction;
    PlankFileClearFunction          clearFunction;
    PlankFileGetStatusFunction      statusFunction;
    PlankFileReadFunction           readFunction;
    PlankFileWriteFunction          writeFunction;
    PlankFileSetPositionFunction    setPositionFunction;
    PlankFileGetPositionFunction    getPositionFunction;
} PlankFile;
#endif



#endif // PLANK_TEXT_H