FileIo.h File Reference

File read-write library for Eve application, support a unique interface for every platform. More...

#include <stdio.h>
#include <stdlib.h>
#include <string.h>

Go to the source code of this file.

Macros
#define	FileIO_Append(M, ...)

Enumerations
enum	_FILEIO_E_FOPEN { FILEIO_E_FOPEN_READ , FILEIO_E_FOPEN_WRITE , FILEIO_E_FOPEN_APPEND }
enum	_FILEIO_E_FRESULT { FILEIO_E_FRESULT_OK , FILEIO_E_FRESULT_FAIL , FILEIO_E_FRESULT_EOF }

Functions
int	FileIO_File_Close ()
int	FileIO_File_Seek (unsigned long offset)
int	FileIO_File_Tell ()
int	FileIO_File_Open (const char *filePath, enum _FILEIO_E_FOPEN e)
int	FileIO_File_Read (char *buffer, long bytes)
int	FileIO_File_Write (const char *buffer, long buffersize)
int	FileIO_File_List (char *path)
int	FileIO_File_To_Buffer (const char *file, char *buff, long offset, int size, int *ByteCount)
	Read a whole file to a buffer.
void	FileIO_Buffer_To_File (const char *txt, const char *buffer, unsigned long buffersize)
	Write a buffer to file.
char *	FileIO_Read_Line ()

Detailed Description

File read-write library for Eve application, support a unique interface for every platform.

Author

Tuan Nguyen tuan..nosp@m.nguy.nosp@m.en@br.nosp@m.tchi.nosp@m.p.com

Date

2019

MIT License

Copyright (c) [2019] [Bridgetek Pte Ltd (BRTChip)]

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 or substantial portions 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.

Definition in file FileIo.h.

Macro Definition Documentation

FileIO_Append

#define FileIO_Append	(		M,
			...
	)

Value:

{                                                   \
    int num = sprintf(msg, M, ##__VA_ARGS__);       \
    FileIO_File_Write(msg, num);                    \
}

Definition at line 45 of file FileIo.h.

{                                                   \
    int num = sprintf(msg, M, ##__VA_ARGS__);       \
    FileIO_File_Write(msg, num);                    \
}

Enumeration Type Documentation

_FILEIO_E_FOPEN

enum _FILEIO_E_FOPEN

Enumerator
FILEIO_E_FOPEN_READ
FILEIO_E_FOPEN_WRITE
FILEIO_E_FOPEN_APPEND

Definition at line 39 of file FileIo.h.

                     {
    FILEIO_E_FOPEN_READ, FILEIO_E_FOPEN_WRITE, FILEIO_E_FOPEN_APPEND
};

_FILEIO_E_FRESULT

enum _FILEIO_E_FRESULT

Enumerator
FILEIO_E_FRESULT_OK
FILEIO_E_FRESULT_FAIL
FILEIO_E_FRESULT_EOF

Definition at line 42 of file FileIo.h.

                      {
    FILEIO_E_FRESULT_OK, FILEIO_E_FRESULT_FAIL, FILEIO_E_FRESULT_EOF
};

Function Documentation

FileIO_Buffer_To_File()

void FileIO_Buffer_To_File	(	const char *	txt,
		const char *	buffer,
		unsigned long	buffersize
	)

Write a buffer to file.

Parameters

txt	File to write
buffer	Buffer to write
buffersize	Buffer size

Note

File open mode: FILEIO_E_FOPEN_READ | FILEIO_E_FOPEN_WRITE | FILEIO_E_FOPEN_APPEND

Definition at line 566 of file FileIo.c.

                                                                                          {
    if (-1 == FileIO_File_Open(txt, FILEIO_E_FOPEN_WRITE)) {
        printf("Error open file\n");
        return;
    }
    FileIO_File_Write(buffer, buffersize);
    FileIO_File_Close();
}

FileIO_File_Close()

int FileIO_File_Close

(

)

Definition at line 505 of file FileIo.c.

{ return 0; };

FileIO_File_List()

int FileIO_File_List

(

char *

path

)

Definition at line 511 of file FileIo.c.

{ return 0; };

FileIO_File_Open()

int FileIO_File_Open	(	const char *	filePath,
		enum _FILEIO_E_FOPEN	e
	)

Definition at line 508 of file FileIo.c.

{ return 0; };

FileIO_File_Read()

int FileIO_File_Read	(	char *	buffer,
		long	bytes
	)

Definition at line 509 of file FileIo.c.

{ return 0; };

FileIO_File_Seek()

int FileIO_File_Seek

(

unsigned long

offset

)

Definition at line 506 of file FileIo.c.

{ return 0; };

FileIO_File_Tell()

int FileIO_File_Tell

(

)

Definition at line 507 of file FileIo.c.

{ return 0; };

FileIO_File_To_Buffer()

int FileIO_File_To_Buffer	(	const char *	file,
		char *	buff,
		long	offset,
		int	size,
		int *	byteCount
	)

Read a whole file to a buffer.

Parameters

file	File to read
buff	Result buffer
offset	Offset where to read
size	Number of byte to read
byteCount	Result of number of byte read

Returns

int 1 on successful

Definition at line 525 of file FileIo.c.

                                                                                               {
    int fileSize = 0;
    int numRead = 0;
 
    fileSize = FileIO_File_Open(file, FILEIO_E_FOPEN_READ);
    numRead = fileSize - offset;
 
    if (offset >= fileSize) {
        return 0;
    }
 
    if (0 >= fileSize) {
        return 0;
    }
 
    if (size > 0 && size < numRead) {
        numRead = size;
    }
 
    // seek file pointer to offset
    FileIO_File_Seek(offset);
 
    FileIO_File_Read(buff, numRead);
 
    FileIO_File_Close();
 
    if (byteCount) {
        *byteCount = numRead;
    }
 
    return 1;
}

FileIO_File_Write()

int FileIO_File_Write	(	const char *	buffer,
		long	buffersize
	)

Definition at line 510 of file FileIo.c.

{ return 0; };

FileIO_Read_Line()

char * FileIO_Read_Line

(

)

Definition at line 512 of file FileIo.c.

{ return 0; };