backup.h

Go to the documentation of this file.

/*
** Jo Sega Saturn Engine
** Copyright (c) 2012-2026, Johannes Fetz (johannesfetz@gmail.com)
** All rights reserved.
**
** Redistribution and use in source and binary forms, with or without
** modification, are permitted provided that the following conditions are met:
**     * Redistributions of source code must retain the above copyright
**       notice, this list of conditions and the following disclaimer.
**     * Redistributions in binary form must reproduce the above copyright
**       notice, this list of conditions and the following disclaimer in the
**       documentation and/or other materials provided with the distribution.
**     * Neither the name of the Johannes Fetz nor the
**       names of its contributors may be used to endorse or promote products
**       derived from this software without specific prior written permission.
**
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
** ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
** WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
** DISCLAIMED. IN NO EVENT SHALL Johannes Fetz BE LIABLE FOR ANY
** DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
** (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
** LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
** ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
** SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
 
#ifndef __JO_BACKUP_H__
# define __JO_BACKUP_H__
 
# ifdef JO_COMPILE_WITH_BACKUP_SUPPORT

# define JO_BACKUP_MAX_FILENAME_LENGTH      (12)

# define JO_BACKUP_MAX_FILE                 (255)

# define JO_BACKUP_MAX_COMMENT_LENGTH       (10)

typedef enum
{
    JoInternalMemoryBackup = 0,
    JoCartridgeMemoryBackup = 1,
    JoExternalDeviceBackup = 2
}                   jo_backup_device;

typedef enum
{
    JoBackupStatusOk = 0,
    JoBackupStatusWriteProtect = 1,
    JoBackupStatusOutOfMemory = 2,
    JoBackupStatusNotFound = 3,
    JoBackupStatusNoMatch = 4,
    JoBackupStatusBroken = 5,
    JoBackupStatusUnknown = 6
}                   jo_backup_status;

typedef struct
{
    jo_backup_device            backup_device;
    char                        *fname;
    char                        *comment;
    void                        *contents;
    unsigned int                content_size;
 
    /* ▲ Fields bellow are optional ▲ */
 
    unsigned short              partition_number;
 
    jo_language                 language;
    /* OR */
    unsigned char               language_num;
 
    unsigned int                save_timestamp;
    /* OR */
    jo_datetime                 save_datetime;
}                               jo_backup;

bool                jo_backup_mount(const jo_backup_device backup_device);

bool                jo_backup_unmount(const jo_backup_device backup_device);

bool                jo_backup_read_device(const jo_backup_device backup_device, jo_list * const filenames);

bool                jo_backup_file_exists(const jo_backup_device backup_device, const char * const fname);

bool                jo_backup_format_device(const jo_backup_device backup_device);

void                jo_backup_init_file(jo_backup * file);

bool                jo_backup_save(jo_backup * file);

static  __jo_force_inline bool          jo_backup_save_file_contents(const jo_backup_device backup_device, char * const fname, char * const comment,
                                                 void *contents, unsigned int content_size)
{
    jo_backup                           bkp;
 
    jo_backup_init_file(&bkp);
    bkp.backup_device = backup_device;
    bkp.fname = fname;
    bkp.comment = comment;
    bkp.contents = contents;
    bkp.content_size = content_size;
    return (jo_backup_save(&bkp));
}

bool                jo_backup_delete_file(const jo_backup_device backup_device, const char * const fname);

bool                jo_backup_get_file_last_modified_date(const jo_backup_device backup_device, const char * const fname, jo_datetime *datetime);

bool                jo_backup_get_file_size(const jo_backup_device backup_device, const char * const fname, unsigned int* const num_bytes, unsigned int* const num_blocks);

bool                jo_backup_get_file_info(const jo_backup_device backup_device, const char * const fname, char* const comment, unsigned char* const language_num, unsigned int* const date, unsigned int* const num_bytes, unsigned int* const num_blocks);

unsigned char       *jo_backup_load_file_comment(const jo_backup_device backup_device, const char * const fname);

void                *jo_backup_load_file_contents(const jo_backup_device backup_device, const char * const fname, unsigned int *length);

unsigned short      jo_backup_get_file_partition(const jo_backup_device backup_device, const char * const fname);

int                 jo_backup_get_free_block_count(const jo_backup_device backup_device);

int                 jo_backup_get_total_block_count(const jo_backup_device backup_device);

jo_backup_status    jo_backup_get_last_status(const jo_backup_device backup_device);
 
#endif /* !JO_COMPILE_WITH_BACKUP_SUPPORT */
 
#endif /* !__JO_BACKUP_H__ */
 
/*
** END OF FILE
*/