PS04File

PS04File — Base class for files

Synopsis


#include <PS04-file.h>


            PS04File;
enum        PS04FileMode;
PS04File*   ps04_file_new_with_name         (const char *fname);
void        ps04_file_create                (PS04File *self,
                                             GError **error);
void        ps04_file_open                  (PS04File *self,
                                             PS04FileMode mode,
                                             GError **error);
void        ps04_file_close                 (PS04File *self);
const char* ps04_file_get_filename          (const PS04File *self);
gsize       ps04_file_get_size              (const PS04File *self,
                                             GError **error);
gboolean    ps04_file_has_filename          (const PS04File *self);
gboolean    ps04_file_is_open               (const PS04File *self);
void        ps04_file_seek                  (PS04File *self,
                                             long offset );
void        ps04_file_set_filename          (PS04File *self,
                                             const char *fname);

Object Hierarchy


  GObject
   +----PS04Stream
         +----PS04File
               +----PS04AudioTrack
               +----PS04ProjectFile
               +----PS04RhythmFile

Description

The PS04File class is the base class for files on the PS-04 memory card, offering basic operations like ps04_file_open(), ps04_file_close(), ps04_file_read(), and ps04_file_set_filename().

Details

PS04File

typedef struct _PS04File PS04File;

enum PS04FileMode

typedef enum {
  PS04_FILE_MODE_READ,
  PS04_FILE_MODE_WRITE
} PS04FileMode;

ps04_file_new_with_name ()

PS04File*   ps04_file_new_with_name         (const char *fname);

Creates a new file object with the specified filename. Note that nothing is done with the disk yet.

fname : The name of the file.
Returns : a new PS04File.

ps04_file_create ()

void        ps04_file_create                (PS04File *self,
                                             GError **error);

self :
error :

ps04_file_open ()

void        ps04_file_open                  (PS04File *self,
                                             PS04FileMode mode,
                                             GError **error);

Opens the file. If an error occurs, error is set within the PS04_ERROR domain.

self : A PS04File.
mode : The mode in which the file should be opened (read or write).
error : A placeholder for a GError, or NULL.

ps04_file_close ()

void        ps04_file_close                 (PS04File *self);

Closes an open file.

self : A PS04File.

ps04_file_get_filename ()

const char* ps04_file_get_filename          (const PS04File *self);

Gets the name of the file.

self : A PS04File.
Returns : a const string.

ps04_file_get_size ()

gsize       ps04_file_get_size              (const PS04File *self,
                                             GError **error);

Gets the disk size of the file. It doesn't need to be open.

self : A PS04File.
error : A placeholder for a GError, or NULL.
Returns : the file size in bytes.

ps04_file_has_filename ()

gboolean    ps04_file_has_filename          (const PS04File *self);

self :
Returns :

ps04_file_is_open ()

gboolean    ps04_file_is_open               (const PS04File *self);

Checks if the file is open.

self : A PS04File.
Returns : TRUE if the file is open, otherwise FALSE.

ps04_file_seek ()

void        ps04_file_seek                  (PS04File *self,
                                             long offset );

self :
Param2 :

ps04_file_set_filename ()

void        ps04_file_set_filename          (PS04File *self,
                                             const char *fname);

self :
fname :