IoIntf.h

Go to the documentation of this file.

/*
 *     ____             _________                __                _     
 *    / __ \___  ____ _/ /_  __(_)___ ___  ___  / /   ____  ____ _(_)____
 *   / /_/ / _ \/ __ `/ / / / / / __ `__ \/ _ \/ /   / __ \/ __ `/ / ___/
 *  / _, _/  __/ /_/ / / / / / / / / / / /  __/ /___/ /_/ / /_/ / / /__  
 * /_/ |_|\___/\__,_/_/ /_/ /_/_/ /_/ /_/\___/_____/\____/\__, /_/\___/  
 *                                                       /____/          
 *
 *                  Barracuda Embedded Web-Server
 *
 ****************************************************************************
 *                            HEADER
 *
 *   $Id: IoIntf.h 5978 2026-09-11 16:13:48Z wini $
 *
 *   COPYRIGHT:  Real Time Logic LLC, 2006-2018
 *
 *   This software is copyrighted by and is the sole property of Real
 *   Time Logic LLC.  All rights, title, ownership, or other interests in
 *   the software remain the property of Real Time Logic LLC.  This
 *   software may only be used in accordance with the terms and
 *   conditions stipulated in the corresponding license agreement under
 *   which the software has been supplied.  Any unauthorized use,
 *   duplication, transmission, distribution, or disclosure of this
 *   software is expressly forbidden.
 *                                                                        
 *   This Copyright notice may not be removed or modified without prior
 *   written consent of Real Time Logic LLC.
 *                                                                         
 *   Real Time Logic LLC. reserves the right to modify this software
 *   without notice.
 *
 *               http://www.realtimelogic.com
 ****************************************************************************
 *
 *
 */
 
#ifndef __IoIntf_h
#define __IoIntf_h
 
#include "GenPrimT.h"
#include "ThreadLib.h"
 
#define IOINTF_OK 0
 
#define IOINTF_EOF 1
 
 
#define IOINTF_INVALIDNAME -11
 
#define IOINTF_NOTFOUND -12
 
#define IOINTF_EXIST -13
 
#define IOINTF_ENOENT -14
 
#define IOINTF_NOACCESS -15
 
#define IOINTF_NOTEMPTY -16
 
#define IOINTF_NOSPACE -17
 
#define IOINTF_IOERROR -18
 
#define IOINTF_MEM -19
 
#define IOINTF_LOCKED -20
 
 
#define IOINTF_NOIMPLEMENTATION -50
 
#define IOINTF_BUFTOOSMALL -51
 
 
#define IOINTF_NOZIPLIB -100
 
#define IOINTF_NOTCOMPRESSED -101
 
#define IOINTF_ZIPERROR -102
 
 
 
#define IOINTF_NOAESLIB -200
 
#define IOINTF_AES_NO_SUPPORT -201
#define IOINTF_NO_PASSWORD -202
 
#define IOINTF_WRONG_PASSWORD -203
 
#define IOINTF_AES_WRONG_AUTH -204
 
#define IOINTF_AES_COMPROMISED -205
 
/* (Forward) Declarations
 */ 
 
#ifndef __DOXYGEN__
struct IoIntf;
typedef struct IoIntf* IoIntfPtr;
struct DirIntf;
typedef struct DirIntf* DirIntfPtr;
struct ResIntf;
typedef struct ResIntf* ResIntfPtr;
#endif
 
typedef struct
{
      BaTime lastModified;
      BaFileSize size;
      BaBool isDir;
} IoStat;
 
#define OpenRes_READ 1
 
#define OpenRes_WRITE 2
 
#define OpenRes_APPEND 4
 
 
 
 
#ifdef __cplusplus
extern "C" {
#endif
 
BA_API int IoIntf_setPassword(
   IoIntfPtr o, const char* password, size_t passwordLen);
 
 
BA_API int IoIntf_setPasswordProp(
   IoIntfPtr o, BaBool passwordRequired, BaBool passwordBin);
 
BA_API char* IoIntf_getAbspath(IoIntfPtr o, const char* path);
 
 
BA_API int IoIntf_getType(IoIntfPtr o,const char** type,const char** platform);
 
BA_API int IoIntf_isEncrypted(
   IoIntfPtr o,const char* name,BaBool* isEncrypted);
 
 
BA_API void IoIntf_destructor(IoIntfPtr o);
 
 
typedef ResIntfPtr (*IoIntf_InflateGzip)(
   IoIntfPtr io, const char* name, int* status, const char** ecode);
 
 
typedef ResIntfPtr (*IoIntf_DeflateGzip)(
   ResIntfPtr resPtr, const char* name, ThreadMutex* m,
   BaFileSize* size, BaBool* isCompressed);
 
 
#ifdef __cplusplus
}
#endif 
 
/* Required API methods
 */
 
typedef int (*IoIntf_Property)(IoIntfPtr o,const char* name,void* a,void* b);
 
typedef DirIntfPtr (*IoIntf_OpenDir)(IoIntfPtr o, const char* dirname,
                                   int* status, const char** ecode);
 
typedef int (*IoIntf_Stat)(IoIntfPtr o, const char* name, IoStat* st);
 
typedef ResIntfPtr (*IoIntf_OpenRes)(IoIntfPtr o, const char* name,
                                     U32 mode, int* status,
                                     const char** ecode);
 
typedef int (*IoIntf_CloseDir)(IoIntfPtr o, DirIntfPtr* dirIntf);
 
typedef ResIntfPtr (*IoIntf_OpenResGzip)(IoIntfPtr o, const char* name,
                                         ThreadMutex* m, BaFileSize* size,
                                         int* status, const char** ecode);
 
typedef int (*IoIntf_MkDir)(IoIntfPtr o, const char* name, const char** ecode);
 
typedef int (*IoIntf_Rename)(IoIntfPtr o, const char* from, const char* to,
                           const char** ecode);
typedef int (*IoIntf_Remove)(IoIntfPtr o,const char* name, const char** ecode);
 
typedef int (*IoIntf_RmDir)(IoIntfPtr o, const char* name, const char** ecode);
 
typedef int (*IoIntf_SeekAndRead)(
   ResIntfPtr super, BaFileSize offset,void* buf,size_t maxSize,size_t* size);
 
/* Called by I/O when terminating if property:attach is set */
typedef void (*IoIntf_OnTerminate)(IoIntfPtr o, IoIntfPtr io);
 
typedef struct IoIntf
{
      IoIntf_Property propertyFp;
 
      IoIntf_CloseDir closeDirFp;
 
      IoIntf_MkDir mkDirFp;
 
      IoIntf_Rename renameFp;
 
      IoIntf_OpenDir openDirFp;
 
      IoIntf_OpenRes openResFp;
 
      IoIntf_OpenResGzip openResGzipFp;
 
      IoIntf_Remove removeFp;
 
      IoIntf_RmDir rmDirFp;
 
      IoIntf_Stat statFp;
 
      /* Called by I/O when terminating if property:attach is set */
      struct IoIntf* attachedIo;
      IoIntf_OnTerminate onTerminate;
} IoIntf;
 
 
/* Constructor for Read And Write resource collections.
 */
#define IoIntf_constructorRW(o, property, closeDir, mkDir, rename,\
                             openDir, openRes, openResGzip, rm,\
                             rmDir, st) do {\
   (o)->propertyFp=property;\
   (o)->closeDirFp=closeDir;\
   (o)->mkDirFp=mkDir;\
   (o)->renameFp=rename;\
   (o)->openDirFp=openDir;\
   (o)->openResFp=openRes;\
   (o)->openResGzipFp=openResGzip;\
   (o)->removeFp=rm;\
   (o)->rmDirFp=rmDir;\
   (o)->statFp=st;\
   (o)->attachedIo=0;\
   (o)->onTerminate=0;\
} while(0)
 
 
 
/* Constructor for Read Only resource collections.
 */
#define IoIntf_constructorR(o, property, closeDir, openDir,\
                            openRes, openResGzip, st) do {\
   (o)->propertyFp=property;\
   (o)->closeDirFp=closeDir;\
   (o)->mkDirFp=0;\
   (o)->renameFp=0;\
   (o)->openDirFp=openDir;\
   (o)->openResFp=openRes;\
   (o)->openResGzipFp=openResGzip;\
   (o)->removeFp=0;\
   (o)->rmDirFp=0;\
   (o)->statFp=st;\
   (o)->attachedIo=0;\
   (o)->onTerminate=0;\
} while(0)
 
 
 
typedef int (*DirIntf_Read)(DirIntfPtr o);
 
typedef const char* (*DirIntf_GetName)(DirIntfPtr o);
 
typedef int (*DirIntf_Stat)(DirIntfPtr o, IoStat* st);
 
typedef struct DirIntf
{
      DirIntf_Read readFp;
      DirIntf_GetName getNameFp;
      DirIntf_Stat statFp;
}DirIntf;
 
 
#define DirIntf_constructor(o, read, getName, st) do {\
  (o)->readFp=read;\
  (o)->getNameFp=getName;\
  (o)->statFp=st;\
}while(0)
 
typedef int (*ResIntf_Read)(
   ResIntfPtr o, void* buf, size_t maxSize, size_t* size);
typedef int (*ResIntf_Write)(ResIntfPtr o, const void* buf, size_t size); 
typedef int (*ResIntf_Seek)(ResIntfPtr o, BaFileSize offset);
typedef int (*ResIntf_Flush)(ResIntfPtr o);
typedef int (*ResIntf_Close)(ResIntfPtr o);
 
 
typedef struct ResIntf
{
      ResIntf_Read readFp;
      ResIntf_Write writeFp;
      ResIntf_Seek seekFp;
      ResIntf_Flush flushFp;
      ResIntf_Close closeFp;
}ResIntf;
 
#define ResIntf_constructor(o, read, write, seek, flush, close) do {\
  (o)->readFp=read;\
  (o)->writeFp=write;\
  (o)->seekFp=seek;\
  (o)->flushFp=flush;\
  (o)->closeFp=close;\
}while(0)
 /* end of IO */ 
 
#endif