file_util.h

Go to the documentation of this file.

/*!**********************************************************************
*
* @copyright Copyright (C) 2016 Siemens Aktiengesellschaft.\n
*            All rights reserved.
*
*************************************************************************
*
* @file     file_util.h
* @date     Oct 5, 2016
* @brief    File utility module header file.
*
* This utility includes the functions for file handling.
*
************************************************************************/

#ifndef FILE_UTIL_H_
#define FILE_UTIL_H_

#include "mcl/mcl_common.h"

#include <sys/stat.h>
#include <sys/types.h>
#include <stdio.h>

typedef struct stat mcl_stat_t;

E_MCL_ERROR_CODE file_util_fopen(const char *file_name, const char *mode, void **file_descriptor);

E_MCL_ERROR_CODE file_util_fopen_without_log(const char *file_name, const char *mode, void **file_descriptor);

E_MCL_ERROR_CODE file_util_fclose(void *file_descriptor);

E_MCL_ERROR_CODE file_util_fclose_without_log(void *file_descriptor);

E_MCL_ERROR_CODE file_util_fwrite(const void *data, mcl_size_t size, mcl_size_t count, void *file_descriptor);

E_MCL_ERROR_CODE file_util_fwrite_without_log(const void *data, mcl_size_t size, mcl_size_t count, void *file_descriptor);

void file_util_fread(void *data, mcl_size_t size, mcl_size_t count, void *file_descriptor, mcl_size_t *actual_count);

E_MCL_ERROR_CODE file_util_fputs(const char *data, void *file_descriptor);

E_MCL_ERROR_CODE file_util_fgets(char *data, mcl_size_t data_size, void *file_descriptor);

E_MCL_ERROR_CODE file_util_fstat(void *file_descriptor, mcl_stat_t *file_attributes);

E_MCL_ERROR_CODE file_util_fflush(void *file_descriptor);

E_MCL_ERROR_CODE file_util_fflush_without_log(void *file_descriptor);

mcl_bool_t file_util_check_if_regular_file(const mcl_stat_t *file_attributes);

#endif //FILE_UTIL_H_