file_for_patch.h

//file_for_patch.h
// patch demo file tool
//
/*
 This is the HDiffPatch copyright.

 Copyright (c) 2012-2019 HouSisong All Rights Reserved.

 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation
 files (the "Software"), to deal in the Software without
 restriction, including without limitation the rights to use,
 copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the
 Software is furnished to do so, subject to the following
 conditions:

 The above copyright notice and this permission notice shall be
 included in all copies of the Software.

 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 OTHER DEALINGS IN THE SOFTWARE.
 */
#ifndef HPatch_file_for_patch_h
#define HPatch_file_for_patch_h
#include <stdio.h>  //fprintf
#include <stdlib.h> // malloc free
#include <errno.h>  //errno
#ifdef _WIN32
#   include <wchar.h>
#endif
#include "dirDiffPatch/dir_patch/dir_patch_types.h"
#if (_HPATCH_IS_USED_errno)
#   define  _set_errno_new(v) do {errno=v;} while(0)
#else
#   define  _set_errno_new(v)
#endif

#   define  set_ferr(_saved_errno,_throw_errno) /*save new errno*/\
                        do { if (_throw_errno) _saved_errno=_throw_errno; } while(0)

#if (_HPATCH_IS_USED_errno)
#   define  __mix_ferr_(_saved_errno,_throw_errno,_is_log) /*only save first errno*/ do { \
                        if (((_saved_errno)!=(_throw_errno))&&(_throw_errno)){ \
                            if (!(_saved_errno)) _saved_errno=_throw_errno; \
                            if (_is_log) LOG_ERRNO(_throw_errno); } } while(0)
#   define  _update_ferr(fe)        do { int v=errno;      __mix_ferr_(fe,v,1); } while(0)
#   define  _update_ferrv(fe,v)     do { _set_errno_new(v); __mix_ferr_(fe,v,1);  } while(0)
#   define  mix_ferr(_saved_errno,_throw_errno)     __mix_ferr_(_saved_errno,_throw_errno,0)
#else
#   define  _update_ferr(fe)        do { fe=hpatch_TRUE; } while(0)
#   define  _update_ferrv(fe,v)     _update_ferr(fe)
#   define  mix_ferr(_saved_errno,_throw_errno)     set_ferr(_saved_errno,_throw_errno)
#endif

#if ( __linux__ )
# ifndef _IS_NEED_BLOCK_DEV
#   define _IS_NEED_BLOCK_DEV 1
# endif
#endif

#ifndef _IS_USED_WIN32_UTF8_WAPI
#   if (defined(_WIN32) && defined(_MSC_VER))
#       define _IS_USED_WIN32_UTF8_WAPI 1 // used utf8 string + wchar_t API
#   endif
#endif
#if (_IS_USED_WIN32_UTF8_WAPI)
#   define _hpatch_kMultiBytePage CP_UTF8
#elif defined(_WIN32)
#   define _hpatch_kMultiBytePage CP_ACP
#endif
#ifdef __cplusplus
extern "C" {
#endif

typedef unsigned char TByte;
#define hpatch_kFileIOBestMaxSize  (1<<20)
#define hpatch_kPathMaxSize  (1024*4)
    
hpatch_inline static
hpatch_BOOL hpatch_getIsDirName(const char* path_utf8){
    size_t len=strlen(path_utf8);
    return (len>0)&&(path_utf8[len-1]==kPatch_dirSeparator);
}

hpatch_inline static const char* findUntilEnd(const char* str,char c){
    const char* result=strchr(str,c);
    return (result!=0)?result:(str+strlen(str));
}


#define _path_noEndDirSeparator(dst_path,src_path)  \
    char  dst_path[hpatch_kPathMaxSize];      \
    {   size_t len=strlen(src_path);   \
        if (len>=hpatch_kPathMaxSize) { _set_errno_new(ENAMETOOLONG); return hpatch_FALSE;} /* error */ \
        if ((len>0)&&(src_path[len-1]==kPatch_dirSeparator)) --len; /* without '/' */\
        memcpy(dst_path,src_path,len); \
        dst_path[len]='\0';  } /* safe */


#ifdef _WIN32
int _utf8FileName_to_w(const char* fileName_utf8,wchar_t* out_fileName_w,size_t out_wSize);
int _wFileName_to_utf8(const wchar_t* fileName_w,char* out_fileName_utf8,size_t out_bSize);
hpatch_BOOL _wFileNames_to_utf8(const wchar_t** fileNames_w,size_t fileCount,
                                char** out_fileNames_utf8,size_t out_byteSize);
#endif

#if (_IS_USED_WIN32_UTF8_WAPI)
void SetDefaultStringLocale(); //for some locale Path character encoding view
#endif

hpatch_inline static
hpatch_BOOL hpatch_getIsSamePath(const char* xPath_utf8,const char* yPath_utf8){
    _path_noEndDirSeparator(xPath,xPath_utf8);
    {   _path_noEndDirSeparator(yPath,yPath_utf8);
        if (0==strcmp(xPath,yPath)){
            return hpatch_TRUE;
        }else{
            // WARING!!! better return getCanonicalPath(xPath)==getCanonicalPath(yPath);
            return hpatch_FALSE;
        }
    }
}

int hpatch_printPath_utf8(const char* pathTxt_utf8);
int hpatch_printStdErrPath_utf8(const char* pathTxt_utf8);

    typedef enum hpatch_TPathType{
        kPathType_notExist,
        kPathType_file,
        kPathType_dir,
    } hpatch_TPathType;
    
    
hpatch_BOOL _hpatch_getPathStat_noEndDirSeparator(const char* path_utf8,hpatch_TPathType* out_type,
                                                  hpatch_StreamPos_t* out_fileSize,size_t* out_st_mode);
    
hpatch_inline static
hpatch_BOOL hpatch_getPathStat(const char* path_utf8,hpatch_TPathType* out_type,
                        hpatch_StreamPos_t* out_fileSize){
    if (!hpatch_getIsDirName(path_utf8)){
        return _hpatch_getPathStat_noEndDirSeparator(path_utf8,out_type,out_fileSize,0);
    }else{//dir name
        _path_noEndDirSeparator(path,path_utf8);
        return _hpatch_getPathStat_noEndDirSeparator(path,out_type,out_fileSize,0);
    }
}
hpatch_inline static
hpatch_BOOL hpatch_isPathNotExist(const char* pathName){
    hpatch_TPathType type;
    if (pathName==0) { _set_errno_new(EINVAL); return hpatch_FALSE; }
    if (!hpatch_getPathStat(pathName,&type,0)) return hpatch_FALSE;
    return (kPathType_notExist==type);
}
hpatch_inline static
hpatch_BOOL hpatch_isPathExist(const char* pathName){
    hpatch_TPathType type;
    if (pathName==0) { _set_errno_new(EINVAL); return hpatch_FALSE; }
    if (!hpatch_getPathStat(pathName,&type,0)) return hpatch_FALSE;
    return (kPathType_notExist!=type);
}

hpatch_inline static
hpatch_BOOL  hpatch_getFileSize(const char* fileName_utf8,hpatch_StreamPos_t* out_fileSize){
    hpatch_TPathType   type;
    if (!hpatch_getPathStat(fileName_utf8,&type,out_fileSize)) return hpatch_FALSE;
    return (type==kPathType_file);
}
    
hpatch_BOOL hpatch_getTempPathName(const char* path_utf8,char* out_tempPath_utf8,char* out_tempPath_end);
hpatch_BOOL hpatch_renamePath(const char* oldPath_utf8,const char* newPath_utf8);
hpatch_BOOL hpatch_removeFile(const char* fileName_utf8);
#if (_IS_NEED_DIR_DIFF_PATCH)
hpatch_BOOL hpatch_removeDir(const char* dirName_utf8);
hpatch_BOOL hpatch_moveFile(const char* oldPath_utf8,const char* newPath_utf8);
hpatch_BOOL hpatch_makeNewDir(const char* dirName_utf8);
#endif
hpatch_BOOL hpatch_getIsExecuteFile(const char* fileName);
hpatch_BOOL hpatch_setIsExecuteFile(const char* fileName);

typedef FILE* hpatch_FileHandle;

hpatch_BOOL hpatch_getIsAtty(hpatch_FileHandle fileHandle); //is device?

typedef struct hpatch_TFileStreamInput{
    hpatch_TStreamInput base;
    hpatch_FileHandle   m_file;
    hpatch_StreamPos_t  m_fpos;
    hpatch_StreamPos_t  m_offset;
    hpatch_FileError_t  fileError;
} hpatch_TFileStreamInput;

hpatch_inline
static void hpatch_TFileStreamInput_init(hpatch_TFileStreamInput* self){
    memset(self,0,sizeof(hpatch_TFileStreamInput));
}
hpatch_BOOL hpatch_TFileStreamInput_open(hpatch_TFileStreamInput* self,const char* fileName_utf8);
hpatch_BOOL hpatch_TFileStreamInput_setOffset(hpatch_TFileStreamInput* self,hpatch_StreamPos_t offset);
hpatch_BOOL hpatch_TFileStreamInput_close(hpatch_TFileStreamInput* self);

typedef struct hpatch_TFileStreamOutput{ //is hpatch_TFileStreamInput !
    hpatch_TStreamOutput base; //is hpatch_TStreamInput + write
    hpatch_FileHandle   m_file;
    hpatch_StreamPos_t  m_fpos;
    hpatch_StreamPos_t  m_offset; //now not used
    hpatch_FileError_t  fileError; // 0: no error; other: saved errno value;
    //
    hpatch_BOOL         is_random_out;
    hpatch_BOOL         is_in_readModel;
    hpatch_StreamPos_t  out_length;
} hpatch_TFileStreamOutput;

hpatch_inline
static void hpatch_TFileStreamOutput_init(hpatch_TFileStreamOutput* self){
    memset(self,0,sizeof(hpatch_TFileStreamOutput));
}
hpatch_BOOL hpatch_TFileStreamOutput_open(hpatch_TFileStreamOutput* self,const char* fileName_utf8,
                                          hpatch_StreamPos_t max_file_length);
hpatch_inline static
void hpatch_TFileStreamOutput_setRandomOut(hpatch_TFileStreamOutput* self,hpatch_BOOL is_random_out){
    self->is_random_out=is_random_out;
}

hpatch_BOOL hpatch_TFileStreamOutput_flush(hpatch_TFileStreamOutput* self);
hpatch_BOOL hpatch_TFileStreamOutput_close(hpatch_TFileStreamOutput* self);

hpatch_BOOL hpatch_TFileStreamOutput_reopen(hpatch_TFileStreamOutput* self,const char* fileName_utf8,
                                            hpatch_StreamPos_t max_file_length);
hpatch_BOOL hpatch_TFileStreamOutput_truncate(hpatch_TFileStreamOutput* self,hpatch_StreamPos_t new_file_length);
    
#ifdef __cplusplus
}
#endif
#endif