level.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_LEVEL_H__
# define __JO_LEVEL_H__
 
#ifdef JO_COMPILE_WITH_LEVEL_SUPPORT
 
# include "level_format.h"

# define JO_LEVEL_MAX_COPIES                (16)

typedef struct
{
    unsigned char                   *data;          // The file
    unsigned int                    size;
    const jo_level_directory_entry  *directory;
    unsigned int                    section_count;
    const char                      *strings;       // STRS section (JO_NULL: none)
    unsigned int                    strings_size;
    void                            *copies[JO_LEVEL_MAX_COPIES];
    unsigned int                    copy_count;
}                                   jo_level;

jo_level                            *jo_level_load(const char * const filename);

void                                jo_level_free(jo_level * const level);

const jo_level_directory_entry      *jo_level_find_section(const jo_level * const level, const unsigned int id);

const void                          *jo_level_section_data(const jo_level * const level, const unsigned int id);

const void                          *jo_level_get_header(jo_level * const level, const unsigned int id, const unsigned int size,
                                                         const void * const defaults);

const void                          *jo_level_get_records(jo_level * const level, const unsigned int id, const unsigned int size,
                                                          const void * const defaults, unsigned int * const count);

const void                          *jo_level_get_array(const jo_level * const level, const unsigned int id, const unsigned int offset);

const char                          *jo_level_string(const jo_level * const level, const unsigned int offset);

# define JO_LEVEL_HEADER(LEVEL, ID, NAME)   ({ static const jo_level_##NAME##_header __defaults = JO_LEVEL_##ID##_HEADER_DEFAULTS; \
                                               (const jo_level_##NAME##_header *)jo_level_get_header((LEVEL), JO_LEVEL_SECTION_##ID, \
                                               sizeof(jo_level_##NAME##_header), &__defaults); })

# define JO_LEVEL_RECORDS(LEVEL, ID, NAME, COUNT) ({ static const jo_level_##NAME##_record __defaults = JO_LEVEL_##ID##_RECORD_DEFAULTS; \
                                               (const jo_level_##NAME##_record *)jo_level_get_records((LEVEL), JO_LEVEL_SECTION_##ID, \
                                               sizeof(jo_level_##NAME##_record), &__defaults, (COUNT)); })
 
#endif /* !JO_COMPILE_WITH_LEVEL_SUPPORT */
 
#endif /* !__JO_LEVEL_H__ */
 
/*
** END OF FILE
*/