I/O functions with filename storing, able to track current line in opened file. All standard stdio functions working with files (not stdin, stdout, stderr) should be replaced by their equivalents from XIO library. More...

#include "global_defs.h"
#include "system/system.hh"
#include <map>

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	xfile
	XFILE structure holds additional info to generic FILE. More...

class	Xio

Macros
#define	LINE_SIZE 65536

Typedefs

typedef struct xfile	XFILE
	XFILE structure holds additional info to generic FILE. More...

Functions

char *	xio_getfname (FILE *f)
	XIO library extensions. More...

char *	xio_getfmode (FILE *f)
	Get file mode from file stream. More...

int	xio_getlinesread (FILE *f)
	Get number of read lines from stream. More...

char *	xio_getfulldescription (FILE *f)
	Get pointer to string with full file description. More...


FILE *	xfopen (const char fname, const char mode)
	File access. More...

FILE *	xfopen (const std::string &fname, const char *mode)

int	xfclose (FILE *stream)
	Close file (function) More...

int	xfflush (FILE *f)
	Flush stream (function) More...

FILE *	xfreopen (const char filename, const char mode, FILE *stream)
	Reopen stream with different file or mode. More...


int	xfprintf (FILE out, const char fmt,...)
	Formatted input/output. More...

int	xfscanf (FILE in, const char fmt,...)
	FSCANF WITH ERROR HANDLING. More...


char *	xfgets (char s, int n, FILE in)
	Character input/output. More...

int	xfgetc (FILE *f)
	Get character from stream (function) More...

int	xgetc (FILE *f)
	Get character from stream (function) More...

int	xungetc (int c, FILE *f)
	Unget character from stream (function) More...


size_t	xfread (void ptr, size_t size, size_t count, FILE stream)
	Direct input/output. More...

size_t	xfwrite (const void ptr, size_t size, size_t count, FILE stream)
	Write block of data to stream, handle errors. More...


void	xrewind (FILE *f)
	File positioning. More...


int	xfeof (FILE *f)
	Error-handling. More...

Detailed Description

I/O functions with filename storing, able to track current line in opened file. All standard stdio functions working with files (not stdin, stdout, stderr) should be replaced by their equivalents from XIO library.

Please make a following refer to Flow123d on your project site if you use the program for any purpose, especially for academic research: Flow123d, Research Centre: Advanced Remedial Technologies, Technical University of Liberec, Czech Republic

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License version 3 as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 021110-1307, USA.

$Id$ $Revision$ $LastChangedBy$ $LastChangedDate$

Date: 6.4.2010

Author: Jiri Jenicek

Definition in file xio.h.

Macro Definition Documentation

#define LINE_SIZE 65536

Definition at line 51 of file xio.h.

Typedef Documentation

typedef struct xfile XFILE

XFILE structure holds additional info to generic FILE.

Function Documentation

int xfclose ( FILE * stream )

Close file (function)

Parameters

[in,out] stream pointer to FILE structure

Returns: same as ISO C fclose()

Definition at line 309 of file xio.cc.

Here is the caller graph for this function:

int xfeof ( FILE * f )

Error-handling.

Check End-of-File indicator (function)

Error-handling.

Parameters

[in] f pointer to FILE structure

Returns: same as ISO C feof()

Definition at line 645 of file xio.cc.

int xfflush ( FILE * f )

Flush stream (function)

Parameters

[in,out] f pointer to FILE structure

Returns: same as ISO C fflush()

Definition at line 287 of file xio.cc.

int xfgetc ( FILE * f )

Get character from stream (function)

Parameters

[in,out] f pointer to FILE structure

Returns: same as ISO C fgetc()

Definition at line 448 of file xio.cc.

Here is the caller graph for this function:

char* xfgets	(	char *	s,
		int	n,
		FILE *	in
	)

Character input/output.

Get string from stream (function)

Character input/output.

Parameters

[out]	s	Pointer to an array of chars where the string read is stored
[in]	n	Maximum number of characters to be read (including the final null-character)
[in,out]	in	Pointer to a FILE

Returns: same as ISO C fgets()

Definition at line 580 of file xio.cc.

Here is the caller graph for this function:

FILE* xfopen	(	const char *	fname,
		const char *	mode
	)

File access.

Open file (function)

File access.

Parameters

[in]	fname	filename to open
[in]	mode	opening mode

Returns: same as ISO C fopen()

Definition at line 258 of file xio.cc.

FILE* xfopen	(	const std::string &	fname,
		const char *	mode
	)

Definition at line 246 of file xio.cc.

Here is the caller graph for this function:

int xfprintf	(	FILE *	out,
		const char *	fmt,
			...
	)

Formatted input/output.

Write formatted output to stream (function)

Formatted input/output.

Definition at line 395 of file xio.cc.

Here is the caller graph for this function:

size_t xfread	(	void *	ptr,
		size_t	size,
		size_t	count,
		FILE *	stream
	)

Direct input/output.

Read block of data from stream (function)

Direct input/output.

Parameters

[out]	ptr	Pointer to a block of memory with a minimum size of (size*count) bytes.
[in]	size	Size in bytes of each element to be read.
[in]	count	Number of elements, each one with a size of size bytes.
[in,out]	stream	Pointer to a FILE object that specifies an input stream.

Returns: same as ISO C fread()

Definition at line 535 of file xio.cc.

FILE* xfreopen	(	const char *	filename,
		const char *	mode,
		FILE *	stream
	)

Reopen stream with different file or mode.

Parameters

[in]	filename	Name of the file to be opened
[in]	mode	File access mode
[in,out]	stream	Pointer to a FILE object that identifies the stream to be reopened

Returns: Same as ISO C freopen()

Definition at line 348 of file xio.cc.

int xfscanf	(	FILE *	in,
		const char *	fmt,
			...
	)

FSCANF WITH ERROR HANDLING.

Read formatted data from stream (function)

Definition at line 412 of file xio.cc.

size_t xfwrite	(	const void *	ptr,
		size_t	size,
		size_t	count,
		FILE *	stream
	)

Write block of data to stream, handle errors.

Write block of data to stream (function)

Parameters

[in]	ptr	Pointer to a block of memory with a minimum size of (size*count) bytes.
[in]	size	Size in bytes of each element to be written.
[in]	count	Number of elements, each one with a size of size bytes.
[in,out]	stream	Pointer to a FILE object that specifies an output stream.

Returns: same as ISO C fwrite()

Definition at line 558 of file xio.cc.

int xgetc ( FILE * f )

Get character from stream (function)

Parameters

[in,out] f pointer to FILE structure

Returns: same as ISO C getc()

Definition at line 431 of file xio.cc.

char* xio_getfmode ( FILE * f )

Get file mode from file stream.

Parameters

[in] f pointer to FILE structure

Returns: pointer to file opening mode if OK, NULL if file stream is not known

Definition at line 143 of file xio.cc.

char* xio_getfname ( FILE * f )

XIO library extensions.

Get file name from file stream

XIO library extensions.

Parameters

[in] f pointer to FILE structure

Returns: pointer to file name if OK, NULL if file stream is not known

Definition at line 120 of file xio.cc.

Here is the caller graph for this function:

char* xio_getfulldescription ( FILE * f )

Get pointer to string with full file description.

Get pointer to string with full file description

Parameters

[in] f pointer to FILE structure

Returns: pointer to string with description, null terminated, no LF

Definition at line 189 of file xio.cc.

int xio_getlinesread ( FILE * f )

Get number of read lines from stream.

Parameters

[in] f pointer to FILE structure

Returns: number of lines read if OK, -1 if file stream is not known

Definition at line 166 of file xio.cc.

void xrewind ( FILE * f )

File positioning.

Set position indicator to the beginning (function)

File positioning.

Parameters

[in,out] f pointer to FILE structure

Definition at line 619 of file xio.cc.

int xungetc	(	int	c,
		FILE *	f
	)

Unget character from stream (function)

Parameters

[in]	c	character to push back
[in,out]	f	pointer to FILE structure with INPUT stream

Returns: same as ISO C ungetc()

Definition at line 482 of file xio.cc.

Classes

Macros

Typedefs

Functions

Detailed Description

Macro Definition Documentation

Typedef Documentation

Function Documentation