PdfTools_Toolbox_PtxSys.h

Go to the documentation of this file.

/******************************************************************************
 *
 * File:            PdfTools_Toolbox_PtxSys.h
 *
 * Description:     Sytem declaration file
 *
 * Author:          PDF Tools AG
 *
 * Copyright:       Copyright (C) 2024 - 2024 PDF Tools AG, Switzerland
 *                  All rights reserved.
 *
 * Notice:          By downloading and using this artifact, you accept PDF Tools AG's
 *                  [license agreement](https://www.pdf-tools.com/license-agreement/),
 *                  [privacy policy](https://www.pdf-tools.com/privacy-policy/),
 *                  and allow PDF Tools AG to track your usage data.
 *
 * Classification:  CONFIDENTIAL
 *
 *****************************************************************************/
 
#ifndef PDFTOOLS_TOOLBOX_PTXSYS_H__
#define PDFTOOLS_TOOLBOX_PTXSYS_H__
 
#include <stdarg.h>
#ifndef NO_FILE_STREAM_DESCRIPTOR
#include <stdio.h>
#endif
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#ifdef _UNICODE
#define PtxSys_PathStreamDescriptor_Create PtxSys_PathStreamDescriptor_CreateW
#else
#define PtxSys_PathStreamDescriptor_Create PtxSys_PathStreamDescriptor_CreateA
#endif
 
typedef pos_t(STDCALL* TGetLength)(void* handle);
typedef int(STDCALL* TSeek)(void* handle, pos_t iPos);
typedef pos_t(STDCALL* TTell)(void* handle);
typedef size_t(STDCALL* TRead)(void* handle, void* pData, size_t nSize);
typedef size_t(STDCALL* TWrite)(void* handle, const void* pData, size_t nSize);
typedef void(STDCALL* TRelease)(void* handle);
 
typedef struct TPtxSys_StreamDescriptor
{
    TGetLength pfGetLength;
 
    TSeek pfSeek;
 
    TTell pfTell;
 
    TRead pfRead;
 
    TWrite pfWrite;
 
    TRelease pfRelease;
 
    void* m_handle;
} TPtxSys_StreamDescriptor;
 
#ifndef NO_FILE_STREAM_DESCRIPTOR
/******************************************************************************
 * Stream descriptor for FILE*
 * (always use binary mode to fopen file!)
 *****************************************************************************/
 
static pos_t STDCALL PtxSysFILEPtrGetLength__(void* handle)
{
    pos_t iPos, nLen;
    iPos = ftell((FILE*)handle);
    if (iPos == -1)
        return -1;
    if (fseek((FILE*)handle, 0L, SEEK_END) != 0)
        return -1;
    nLen = ftell((FILE*)handle);
    if (fseek((FILE*)handle, (long)iPos, SEEK_SET) != 0)
        return -1;
    return nLen;
}
 
static int STDCALL PtxSysFILEPtrSeek__(void* handle, pos_t iPos)
{
    return fseek((FILE*)handle, (long)iPos, SEEK_SET) == 0 ? 1 : 0;
}
 
static pos_t STDCALL PtxSysFILEPtrTell__(void* handle) { return ftell((FILE*)handle); }
 
static size_t STDCALL PtxSysFILEPtrRead__(void* handle, void* pData, size_t nSize)
{
    size_t nRead = fread(pData, 1, nSize, (FILE*)handle);
    if (nRead != nSize && ferror((FILE*)handle) != 0)
        return (size_t)-1;
    return nRead;
}
 
static size_t STDCALL PtxSysFILEPtrWrite__(void* handle, const void* pData, size_t nSize)
{
    if (fwrite(pData, 1, nSize, (FILE*)handle) != nSize)
        return (size_t)-1;
    return nSize;
}
 
static void STDCALL PtxSysFILEPtrRelease__(void* handle) { fclose((FILE*)handle); }
 
static void PtxSysCreateFILEStreamDescriptor(TPtxSys_StreamDescriptor* pDescriptor, FILE* handle, int bCloseOnRelease)
{
    pDescriptor->m_handle    = handle;
    pDescriptor->pfGetLength = &PtxSysFILEPtrGetLength__;
    pDescriptor->pfSeek      = &PtxSysFILEPtrSeek__;
    pDescriptor->pfTell      = &PtxSysFILEPtrTell__;
    pDescriptor->pfRead      = &PtxSysFILEPtrRead__;
    pDescriptor->pfWrite     = &PtxSysFILEPtrWrite__;
    pDescriptor->pfRelease   = bCloseOnRelease ? &PtxSysFILEPtrRelease__ : NULL; // NOLINT(modernize-use-nullptr)
}
#endif // NO_FILE_STREAM_DESCRIPTOR
 
/******************************************************************************
 * Path Stream Descriptor convenience function
 *****************************************************************************/
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL
PtxSys_PathStreamDescriptor_CreateA(TPtxSys_StreamDescriptor* pDescriptor, const char* szPath, BOOL bIsReadOnly);
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL
PtxSys_PathStreamDescriptor_CreateW(TPtxSys_StreamDescriptor* pDescriptor, const WCHAR* szPath, BOOL bIsReadOnly);
PDFTOOLS_TOOLBOX_EXPORT void PDFTOOLS_TOOLBOX_CALL
PtxSys_PathStreamDescriptor_Close(TPtxSys_StreamDescriptor* pDescriptor);
 
/******************************************************************************
 * Stream Descriptor for memory streams
 *****************************************************************************/
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL
PtxSys_MemoryStreamDescriptor_Create(TPtxSys_StreamDescriptor* pDescriptor);
 
PDFTOOLS_TOOLBOX_EXPORT void PDFTOOLS_TOOLBOX_CALL
PtxSys_MemoryStreamDescriptor_Close(TPtxSys_StreamDescriptor* pDescriptor);
 
/******************************************************************************
 * Stream Descriptor
 *****************************************************************************/
PDFTOOLS_TOOLBOX_EXPORT pos_t PDFTOOLS_TOOLBOX_CALL
PtxSys_StreamDescriptor_GetLength(TPtxSys_StreamDescriptor* pStreamDescriptor);
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL
PtxSys_StreamDescriptor_Seek(TPtxSys_StreamDescriptor* pStreamDescriptor, pos_t iPos);
PDFTOOLS_TOOLBOX_EXPORT pos_t PDFTOOLS_TOOLBOX_CALL
PtxSys_StreamDescriptor_Tell(TPtxSys_StreamDescriptor* pStreamDescriptor);
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL
PtxSys_StreamDescriptor_Read(TPtxSys_StreamDescriptor* pStreamDescriptor, void* pData, size_t nSize);
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL
PtxSys_StreamDescriptor_Write(TPtxSys_StreamDescriptor* pStreamDescriptor, const void* pData, size_t nSize);
PDFTOOLS_TOOLBOX_EXPORT void PDFTOOLS_TOOLBOX_CALL
PtxSys_StreamDescriptor_Release(TPtxSys_StreamDescriptor* pStreamDescriptor);
 
#ifdef __cplusplus
}
#endif
 
#endif /* PDFTOOLS_TOOLBOX_PTXSYS_H__ */