Audacious  $Id:Doxyfile42802007-03-2104:39:00Znenolod$
Functions
vfs_common.c File Reference

Common code for various VFS-stream related operations. More...

#include <glib.h>
#include <glib/gprintf.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "config.h"
#include "vfs.h"

Go to the source code of this file.

Functions

EXPORT int vfs_fputc (int c, VFSFile *stream)
 Writes a character to a stream.
EXPORT char * vfs_fgets (char *s, int n, VFSFile *stream)
 Reads a string of characters from a stream, ending in newline or EOF.
EXPORT int vfs_fputs (const char *s, VFSFile *stream)
 Writes a string to a VFS stream.
EXPORT int vfs_vfprintf (VFSFile *stream, char const *format, va_list args)
 Writes a formatted string to a VFS stream via a va_list of args.
EXPORT int vfs_fprintf (VFSFile *stream, char const *format,...)
 Writes a formatted string to a VFS stream.
EXPORT void vfs_file_get_contents (const char *filename, void **buf, int64_t *size)
 Gets contents of the file into a buffer.
EXPORT bool_t vfs_fget_le16 (uint16_t *value, VFSFile *stream)
 Reads an unsigned 16-bit Little Endian value from the stream into native endian format.
EXPORT bool_t vfs_fget_le32 (uint32_t *value, VFSFile *stream)
 Reads an unsigned 32-bit Little Endian value from the stream into native endian format.
EXPORT bool_t vfs_fget_le64 (uint64_t *value, VFSFile *stream)
 Reads an unsigned 64-bit Little Endian value from the stream into native endian format.
EXPORT bool_t vfs_fget_be16 (uint16_t *value, VFSFile *stream)
 Reads an unsigned 16-bit Big Endian value from the stream into native endian format.
EXPORT bool_t vfs_fget_be32 (uint32_t *value, VFSFile *stream)
 Reads an unsigned 32-bit Big Endian value from the stream into native endian format.
EXPORT bool_t vfs_fget_be64 (uint64_t *value, VFSFile *stream)
 Reads an unsigned 64-bit Big Endian value from the stream into native endian format.
EXPORT bool_t vfs_fput_le16 (uint16_t value, VFSFile *stream)
 Writes an unsigned 16-bit native endian value into the stream as a Little Endian value.
EXPORT bool_t vfs_fput_le32 (uint32_t value, VFSFile *stream)
 Writes an unsigned 32-bit native endian value into the stream as a Big Endian value.
EXPORT bool_t vfs_fput_le64 (uint64_t value, VFSFile *stream)
 Writes an unsigned 64-bit native endian value into the stream as a Big Endian value.
EXPORT bool_t vfs_fput_be16 (uint16_t value, VFSFile *stream)
 Writes an unsigned 16-bit native endian value into the stream as a Big Endian value.
EXPORT bool_t vfs_fput_be32 (uint32_t value, VFSFile *stream)
 Writes an unsigned 32-bit native endian value into the stream as a Big Endian value.
EXPORT bool_t vfs_fput_be64 (uint64_t value, VFSFile *stream)
 Writes an unsigned 64-bit native endian value into the stream as a Big Endian value.

Detailed Description

Common code for various VFS-stream related operations.

Routines for string reading and writing and functions for reading and writing endianess-dependant integer values.

Definition in file vfs_common.c.


Function Documentation

EXPORT bool_t vfs_fget_be16 ( uint16_t *  value,
VFSFile stream 
)

Reads an unsigned 16-bit Big Endian value from the stream into native endian format.

Parameters:
valuePointer to the variable to read the value into.
streamA VFSFile object representing the stream.
Returns:
TRUE if read was succesful, FALSE if there was an error.

Definition at line 257 of file vfs_common.c.

EXPORT bool_t vfs_fget_be32 ( uint32_t *  value,
VFSFile stream 
)

Reads an unsigned 32-bit Big Endian value from the stream into native endian format.

Parameters:
valuePointer to the variable to read the value into.
streamA VFSFile object representing the stream.
Returns:
TRUE if read was succesful, FALSE if there was an error.

Definition at line 273 of file vfs_common.c.

EXPORT bool_t vfs_fget_be64 ( uint64_t *  value,
VFSFile stream 
)

Reads an unsigned 64-bit Big Endian value from the stream into native endian format.

Parameters:
valuePointer to the variable to read the value into.
streamA VFSFile object representing the stream.
Returns:
TRUE if read was succesful, FALSE if there was an error.

Definition at line 289 of file vfs_common.c.

EXPORT bool_t vfs_fget_le16 ( uint16_t *  value,
VFSFile stream 
)

Reads an unsigned 16-bit Little Endian value from the stream into native endian format.

Parameters:
valuePointer to the variable to read the value into.
streamA VFSFile object representing the stream.
Returns:
TRUE if read was succesful, FALSE if there was an error.

Definition at line 208 of file vfs_common.c.

EXPORT bool_t vfs_fget_le32 ( uint32_t *  value,
VFSFile stream 
)

Reads an unsigned 32-bit Little Endian value from the stream into native endian format.

Parameters:
valuePointer to the variable to read the value into.
streamA VFSFile object representing the stream.
Returns:
TRUE if read was succesful, FALSE if there was an error.

Definition at line 224 of file vfs_common.c.

EXPORT bool_t vfs_fget_le64 ( uint64_t *  value,
VFSFile stream 
)

Reads an unsigned 64-bit Little Endian value from the stream into native endian format.

Parameters:
valuePointer to the variable to read the value into.
streamA VFSFile object representing the stream.
Returns:
TRUE if read was succesful, FALSE if there was an error.

Definition at line 240 of file vfs_common.c.

EXPORT char* vfs_fgets ( char *  s,
int  n,
VFSFile stream 
)

Reads a string of characters from a stream, ending in newline or EOF.

Parameters:
sA buffer to put the string in.
nThe amount of characters to read.
streamA VFSFile object representing the stream.
Returns:
The string on success, or NULL.

Definition at line 65 of file vfs_common.c.

EXPORT void vfs_file_get_contents ( const char *  filename,
void **  buf,
int64_t *  size 
)

Gets contents of the file into a buffer.

Buffer of filesize bytes is allocated by this function as necessary.

Parameters:
filenameURI of the file to read in.
bufPointer to a pointer variable of buffer.
sizePointer to gsize variable that will hold the amount of read data e.g. filesize.

Definition at line 151 of file vfs_common.c.

Referenced by art_get_data(), and vfs_async_file_get_contents_worker().

EXPORT int vfs_fprintf ( VFSFile stream,
char const *  format,
  ... 
)

Writes a formatted string to a VFS stream.

Parameters:
streamA VFSFile object representing the stream.
formatA printf-style format string.
...Optional list of arguments.
Returns:
The amount of bytes written.

Definition at line 130 of file vfs_common.c.

EXPORT bool_t vfs_fput_be16 ( uint16_t  value,
VFSFile stream 
)

Writes an unsigned 16-bit native endian value into the stream as a Big Endian value.

Parameters:
valueValue to write into the stream.
streamA VFSFile object representing the stream.
Returns:
TRUE if read was succesful, FALSE if there was an error.

Definition at line 348 of file vfs_common.c.

EXPORT bool_t vfs_fput_be32 ( uint32_t  value,
VFSFile stream 
)

Writes an unsigned 32-bit native endian value into the stream as a Big Endian value.

Parameters:
valueValue to write into the stream.
streamA VFSFile object representing the stream.
Returns:
TRUE if read was succesful, FALSE if there was an error.

Definition at line 362 of file vfs_common.c.

EXPORT bool_t vfs_fput_be64 ( uint64_t  value,
VFSFile stream 
)

Writes an unsigned 64-bit native endian value into the stream as a Big Endian value.

Parameters:
valueValue to write into the stream.
streamA VFSFile object representing the stream.
Returns:
TRUE if read was succesful, FALSE if there was an error.

Definition at line 376 of file vfs_common.c.

EXPORT bool_t vfs_fput_le16 ( uint16_t  value,
VFSFile stream 
)

Writes an unsigned 16-bit native endian value into the stream as a Little Endian value.

Parameters:
valueValue to write into the stream.
streamA VFSFile object representing the stream.
Returns:
TRUE if read was succesful, FALSE if there was an error.

Definition at line 306 of file vfs_common.c.

EXPORT bool_t vfs_fput_le32 ( uint32_t  value,
VFSFile stream 
)

Writes an unsigned 32-bit native endian value into the stream as a Big Endian value.

Parameters:
valueValue to write into the stream.
streamA VFSFile object representing the stream.
Returns:
TRUE if read was succesful, FALSE if there was an error.

Definition at line 320 of file vfs_common.c.

EXPORT bool_t vfs_fput_le64 ( uint64_t  value,
VFSFile stream 
)

Writes an unsigned 64-bit native endian value into the stream as a Big Endian value.

Parameters:
valueValue to write into the stream.
streamA VFSFile object representing the stream.
Returns:
TRUE if read was succesful, FALSE if there was an error.

Definition at line 334 of file vfs_common.c.

EXPORT int vfs_fputc ( int  c,
VFSFile stream 
)

Writes a character to a stream.

Parameters:
cA character to write to the stream.
streamA VFSFile object representing the stream.
Returns:
The character on success, or EOF.

Definition at line 46 of file vfs_common.c.

EXPORT int vfs_fputs ( const char *  s,
VFSFile stream 
)

Writes a string to a VFS stream.

Parameters:
sA string to write to the stream.
streamA VFSFile object representing the stream.
Returns:
The amount of bytes written.

Definition at line 97 of file vfs_common.c.

Referenced by vfs_vfprintf().

EXPORT int vfs_vfprintf ( VFSFile stream,
char const *  format,
va_list  args 
)

Writes a formatted string to a VFS stream via a va_list of args.

Parameters:
streamA VFSFile object representing the stream.
formatA printf-style format string.
argsA va_list of args to use.
Returns:
value The amount of bytes written.

Definition at line 112 of file vfs_common.c.

Referenced by vfs_fprintf().