file.h File Reference

Go to the source code of this file.

Functions
int	fopen (const char *filename, const char *mode, bool cache=false, const char *filename_ex="")
	create a new file or to open an existing file. More...
void	fclose (int id, const char *mode="r")
	close a file More...
bool	feof (int id)
	is current position on file at the end More...
const char *	fgets (int id)
	read string on a file until found '\n' or eof More...
void	fprintf (int id, const char *str)
	write a string into a file More...
long	fsize (int id, const char *mode="r")
	get file size More...
long	fpos (int id, const char *mode="r")
	get current position on a file More...
void	fseek (int id, int finalPos, const char *mode="r")
	Changes position in file. More...
bool	fexist (const char *filename)
	is this file exist on drive More...
bool	fadd (const char *filename, const char *mode, bool cache=true, const char *filename_ex="", const char *archive_type="zip", const char *password="")
bool	faddzip (const char *zipfilename, const const char *password="")
bool	fremove (const char *filename)
const char *	ftostring (const char *filename, const char *encode="utf8")
	Open file and allocate buffer to string, no drop file pointer. More...
bool	fdel (const char *filename)
	delete file from disk. More...
const char *	fread (int id, int len)
	read string start from current position until len count. More...
const char *	freadf (const char *filename, int seekpos, int len)
	read file start from seekpos until len count. More...
const char *	fgetsf (const char *filename, int line_nb)
	read string on a file until found '\n' and at line number count. More...
int	fsizef (const char *filename)
	get file size More...
const char *	ftointernalstorage (const char *filename)

Detailed Description

Example Read File

{
        set($fp, fopen("credit-utf-8.txt","r") )
        while(1) procedure( if(feof($fp)==true) break() >> addstring($msg_utf_8,fgets($fp)) )
        fclose($fp,"r")
}function(init)
text(720, 0, "credit-utf-8.txt UTF-8",100,0,0,255)
text(280,30,"$msg_utf_8")

Example Write File

{
        set($fp, fopen("test.txt","w") )
        fprintf( $fp, "Hello World\n" )
        fprintf( $fp, "This is write text to file.\n" )
        fclose($fp, "w")
}function(init)
ifelse($ret!=-1,text(10,10, "Please see output -> test.txt"),text(10,10, "Error! -> test.txt"))

Definition in file file.h.

Function Documentation

fadd()

bool fadd	(	const char *	filename,
		const char *	mode,
		bool	cache = true,
		const char *	filename_ex = "",
		const char *	archive_type = "zip",
		const char *	password = ""
	)

Adds an archive to the file system.
After calling this, the Engine will also search and open files directly from this archive. This is useful for hiding data from the end user, speeding up file access and making it possible to access for example Quake3 .pk3 files, which are just renamed .zip files.
By default: supports ZIP, PAK, TAR, PNK, and directories as archives.
Supports AES-encrypted zip files, and the advanced compression techniques lzma and bzip2.

Parameters

filename	Filename of the archive to add to the file system.
mode	must be "r"
cache	allocate to system memory before reading.
filename_ex	is a new name of file, in case download from cloud e.g. google drive, dropbox
archive_type	support archive type follows: (default is "zip") "zip" "gzip" "pak" "tar"
password	archive password

Returns

true was successed, false was failed

faddzip()

bool faddzip	(	const char *	zipfilename,
		const const char *	password = ""
	)

Adds ZIP archive to the file system.
After calling this, the Engine will also search and open files directly from this archive. This is useful for hiding data from the end user, speeding up file access.
By default: supports ZIP only!!!.
Supports AES-encrypted zip files, and the advanced compression techniques lzma and bzip2.

Parameters

zipfilename	ZIP Filename of the archive to add to the file system.
password	archive password

Returns

true was successed, false was failed

fclose()

void fclose	(	int	id,
		const char *	mode = "r"
	)

close a file

Parameters

id	file id
mode	default is "r", should be same mode to fopen() call

fdel()

bool fdel

(

const char *

filename

)

delete file from disk.

Parameters

filename

Filename of the file on disk.

Returns

true was successed, false was failed

feof()

bool feof

(

int

id

)

is current position on file at the end

Parameters

id

file id

Returns

true is end, false is not

fexist()

bool fexist

(

const char *

filename

)

is this file exist on drive

Parameters

filename

is a string literal, which you will use to name your file

Returns

true is end, false is not

fgets()

const char* fgets

(

int

id

)

read string on a file until found '\n' or eof

Parameters

id

file id

Returns

string

fgetsf()

const char* fgetsf	(	const char *	filename,
		int	line_nb
	)

read string on a file until found '\n' and at line number count.

Parameters

filename	is a string literal, which you will use to operation.
line_nb	line number count, zero based.

Returns

string, empty is otherwise.

fopen()

int fopen	(	const char *	filename,
		const char *	mode,
		bool	cache = false,
		const char *	filename_ex = ""
	)

create a new file or to open an existing file.

Parameters

filename	is a string literal, which you will use to name your file
mode	can have one of the following values: r : Opens an existing text file for reading purpose. w : Opens a text file for writing. If it does not exist, then a new file is created. Here your program will start writing content from the beginning of the file. wa : Opens a text file for writing in appending mode. If it does not exist, then a new file is created. Here your program will start appending content in the existing file content.
cache	allocate to system memory before reading.
filename_ex	is a new name of file, in case download from cloud e.g. google drive, dropbox

Returns

id of file, > -1 was successed, -1 was failed

fpos()

long fpos	(	int	id,
		const char *	mode = "r"
	)

get current position on a file

Parameters

id	file id
mode	default is "r", should be same mode to fopen() call

Returns

current position

fprintf()

void fprintf	(	int	id,
		const char *	str
	)

write a string into a file

Parameters

id	file id
str	string that put on a file

fread()

const char* fread	(	int	id,
		int	len
	)

read string start from current position until len count.

Parameters

id	file id
len	size of read.

Returns

string

freadf()

const char* freadf	(	const char *	filename,
		int	seekpos,
		int	len
	)

read file start from seekpos until len count.

Parameters

filename	is a string literal, which you will use to operation.
seekpos	start position to read.
len	size of read.

Returns

string, empty is otherwise.

fremove()

bool fremove

(

const char *

filename

)

Removes an archive from the file system.
This will close the archive and free any file handles, but will not close resources which have already been loaded and are now cached, for example textures and meshes.

Parameters

filename

Filename of the archive to add to the file system.

Returns

true was successed, false was failed

fseek()

void fseek	(	int	id,
		int	finalPos,
		const char *	mode = "r"
	)

Changes position in file.

Parameters

id	file id
finalPos	Destination position in the file.
mode	default is "r", should be same mode to fopen() call

fsize()

long fsize	(	int	id,
		const char *	mode = "r"
	)

get file size

Parameters

id	file id
mode	default is "r", should be same mode to fopen() call

Returns

file size

fsizef()

int fsizef

(

const char *

filename

)

get file size

Parameters

filename

is a string literal, which you will use to operation.

Returns

file size

ftointernalstorage()

const char* ftointernalstorage

(

const char *

filename

)

copy file to internal storage, purpose for read or shrare file.
may this only support for mobile devices.
win32, psp, psvita, ps2 is not thing to do.

Parameters

filename

is a string literal, which you will use to operation.

Returns

new file path on internal storage, empty is otherwise.

ftostring()

const char* ftostring	(	const char *	filename,
		const char *	encode = "utf8"
	)

Open file and allocate buffer to string, no drop file pointer.

Parameters

filename	is a string literal, which you will use to name your file
encode	force encoding string to. default: utf8, (ascii for binary file) auto ascii utf8 utf16 utf32 wchar

Returns

string buffer, no need drop buffer