mapgen-handle.cpp File Reference

#include "C4Include.h"
#include "landscape/C4MapScript.h"
#include "landscape/C4MapCreatorS2.h"
#include "script/C4ScriptHost.h"
#include "object/C4DefList.h"
#include "object/C4Def.h"
#include "script/C4Aul.h"
#include "lib/StdMeshLoader.h"
#include "mape/cpp-handles/material-handle.h"
#include "mape/cpp-handles/texture-handle.h"
#include "mape/cpp-handles/log-handle.h"
#include "mape/cpp-handles/mapgen-handle.h"

Include dependency graph for mapgen-handle.cpp:

Go to the source code of this file.

Classes
struct	_C4MapgenHandle

Macros
#define	HANDLE_TO_MATERIAL_MAP(handle)   (reinterpret_cast<C4MaterialMap*>(handle))
#define	HANDLE_TO_TEXTURE_MAP(handle)   (reinterpret_cast<C4TextureMap*>(handle))
#define	HANDLE_TO_GROUP(handle)   (reinterpret_cast<C4Group*>(handle))

Functions
void	c4_mapgen_handle_init_script_engine ()
void	c4_mapgen_handle_deinit_script_engine ()
void	c4_mapgen_handle_set_map_library (C4GroupHandle *group_handle)
C4MapgenHandle *	c4_mapgen_handle_new_script (const char *filename, const char *source, C4MaterialMapHandle *material_map, C4TextureMapHandle *texture_map, unsigned int map_width, unsigned int map_height)
C4MapgenHandle *	c4_mapgen_handle_new (const char *filename, const char *source, const char *script_path, C4MaterialMapHandle *material_map, C4TextureMapHandle *texture_map, unsigned int map_width, unsigned int map_height)
void	c4_mapgen_handle_free (C4MapgenHandle *mapgen)
const unsigned char *	c4_mapgen_handle_get_map (C4MapgenHandle *mapgen)
unsigned int	c4_mapgen_handle_get_width (C4MapgenHandle *mapgen)
unsigned int	c4_mapgen_handle_get_height (C4MapgenHandle *mapgen)
unsigned int	c4_mapgen_handle_get_rowstride (C4MapgenHandle *mapgen)
const char *	c4_mapgen_handle_get_error (C4MapgenHandle *mapgen)

---

Class Documentation

_C4MapgenHandle

struct _C4MapgenHandle

Definition at line 57 of file mapgen-handle.cpp.

Collaboration diagram for _C4MapgenHandle:

Class Members
BYTE *	data
StdCopyStrBuf	error_message
unsigned int	height
unsigned int	rowstride
unsigned int	width

Macro Definition Documentation

HANDLE_TO_GROUP

#define HANDLE_TO_GROUP

(

handle

)

(reinterpret_cast<C4Group*>(handle))

Definition at line 32 of file mapgen-handle.cpp.

HANDLE_TO_MATERIAL_MAP

#define HANDLE_TO_MATERIAL_MAP

(

handle

)

(reinterpret_cast<C4MaterialMap*>(handle))

Definition at line 30 of file mapgen-handle.cpp.

HANDLE_TO_TEXTURE_MAP

#define HANDLE_TO_TEXTURE_MAP

(

handle

)

(reinterpret_cast<C4TextureMap*>(handle))

Definition at line 31 of file mapgen-handle.cpp.

Function Documentation

c4_mapgen_handle_deinit_script_engine()

void c4_mapgen_handle_deinit_script_engine

(

)

Definition at line 71 of file mapgen-handle.cpp.

{
    MapScript.Clear();
    GameScript.Clear();
    ScriptEngine.Clear();
}

References C4MapScriptHost::Clear(), C4AulScriptEngine::Clear(), C4GameScriptHost::Clear(), GameScript, MapScript, and ScriptEngine.

Referenced by c4_mapgen_handle_new(), c4_mapgen_handle_new_script(), and mape_mapgen_deinit().

Here is the call graph for this function:

Here is the caller graph for this function:

c4_mapgen_handle_free()

void c4_mapgen_handle_free

(

C4MapgenHandle *

mapgen

)

Definition at line 289 of file mapgen-handle.cpp.

{
    delete[] mapgen->data;
    delete mapgen;
}

c4_mapgen_handle_get_error()

const char* c4_mapgen_handle_get_error

(

C4MapgenHandle *

mapgen

)

Definition at line 318 of file mapgen-handle.cpp.

{
    if(mapgen->data != nullptr)
        return nullptr;
    return mapgen->error_message.getData();
}

Referenced by mape_mapgen_render().

Here is the caller graph for this function:

c4_mapgen_handle_get_height()

unsigned int c4_mapgen_handle_get_height

(

C4MapgenHandle *

mapgen

)

Definition at line 306 of file mapgen-handle.cpp.

{
    assert(mapgen->data != nullptr);
    return mapgen->height;
}

c4_mapgen_handle_get_map()

const unsigned char* c4_mapgen_handle_get_map

(

C4MapgenHandle *

mapgen

)

Definition at line 295 of file mapgen-handle.cpp.

{
    return reinterpret_cast<unsigned char*>(mapgen->data);
}

c4_mapgen_handle_get_rowstride()

unsigned int c4_mapgen_handle_get_rowstride

(

C4MapgenHandle *

mapgen

)

Definition at line 312 of file mapgen-handle.cpp.

{
    assert(mapgen->data != nullptr);
    return mapgen->rowstride;
}

c4_mapgen_handle_get_width()

unsigned int c4_mapgen_handle_get_width

(

C4MapgenHandle *

mapgen

)

Definition at line 300 of file mapgen-handle.cpp.

{
    assert(mapgen->data != nullptr);
    return mapgen->width;
}

c4_mapgen_handle_init_script_engine()

void c4_mapgen_handle_init_script_engine

(

)

Definition at line 65 of file mapgen-handle.cpp.

{
    InitCoreFunctionMap(&ScriptEngine);
    ::MapScript.InitFunctionMap(&ScriptEngine);
}

References InitCoreFunctionMap(), C4MapScriptHost::InitFunctionMap(), MapScript, and ScriptEngine.

Referenced by c4_mapgen_handle_new(), c4_mapgen_handle_new_script(), and mape_mapgen_init().

Here is the call graph for this function:

Here is the caller graph for this function:

c4_mapgen_handle_new()

C4MapgenHandle* c4_mapgen_handle_new	(	const char *	filename,
		const char *	source,
		const char *	script_path,
		C4MaterialMapHandle *	material_map,
		C4TextureMapHandle *	texture_map,
		unsigned int	map_width,
		unsigned int	map_height
	)

Definition at line 174 of file mapgen-handle.cpp.

{
    try
    {
        C4SLandscape landscape;
        landscape.Default();
 
        landscape.MapWdt.Set(map_width, 0, map_width, map_width);
        landscape.MapHgt.Set(map_height, 0, map_height, map_height);
        landscape.MapPlayerExtend = 0;
 
        C4MapCreatorS2 mapgen(
            &landscape,
            HANDLE_TO_TEXTURE_MAP(texture_map),
            HANDLE_TO_MATERIAL_MAP(material_map),
            1
        );
 
        C4MCParser parser(&mapgen);
        parser.ParseMemFile(source, filename);
 
        C4MCMap* map = mapgen.GetMap(nullptr);
        if(!map) throw std::runtime_error("No map definition in source file");
 
        // Setup the script engine if there is an algo=script overlay in the
        // Landscape.txt file
        if(HasAlgoScript(mapgen.GetMap(nullptr)))
        {
            // Re-initialize script engine. Otherwise, we get a warning when the user
            // changes the value of a constant, since it is defined already from the
            // previous map rendering.  Note that we do not need to re-load the map library.
            c4_mapgen_handle_deinit_script_engine();
            c4_mapgen_handle_init_script_engine();
 
            if(script_path == nullptr)
                throw std::runtime_error("For algo=script overlays to work, save the file first at the location of the Script.c file");
 
            gchar* dirname = g_path_get_dirname(script_path);
            gchar* basename = g_path_get_basename(script_path);
 
            C4Group File;
            if(!File.Open(dirname))
            {
                StdStrBuf error_msg = FormatString("Failed to open directory '%s': %s", dirname, File.GetError());
                g_free(dirname);
                g_free(basename);
                throw std::runtime_error(error_msg.getData());
            }
 
            // get scripts
            File.ResetSearch();
            if(!File.FindNextEntry(basename, (char*)nullptr))
            {
                g_free(dirname);
                g_free(basename);
                StdStrBuf error_msg = FormatString("Failed to load '%s': No such file", script_path);
                throw std::runtime_error(error_msg.getData());
            }
 
            c4_log_handle_clear();
            GameScript.Load(File, basename, nullptr, nullptr);
            g_free(dirname);
            g_free(basename);
 
            const char* parse_error = c4_log_handle_get_first_log_message();
            if(parse_error)
                throw std::runtime_error(parse_error);
 
            // Link script engine (resolve includes/appends, generate code)
            c4_log_handle_clear();
            ScriptEngine.Link(&::Definitions);
            if(c4_log_handle_get_n_log_messages() > 1)
                throw std::runtime_error(c4_log_handle_get_first_log_message());
        }
 
        c4_log_handle_clear();
        int32_t out_width, out_height;
        BYTE* array = mapgen.RenderBuf(nullptr, out_width, out_height);
 
        // Don't show any map if there was a script runtime error
        const char* runtime_error = c4_log_handle_get_first_log_message();
        if(runtime_error)
        {
            delete[] array;
            throw std::runtime_error(runtime_error);
        }
 
        C4MapgenHandle* handle = new C4MapgenHandle;
        handle->width = map_width;
        handle->height = map_height;
        handle->rowstride = out_width;
        handle->error_message = nullptr;
        handle->data = array;
        return handle;
    }
    catch(const C4MCParserErr& err)
    {
        C4MapgenHandle* handle = new C4MapgenHandle;
        handle->width = 0;
        handle->height = 0;
        handle->error_message.Copy(err.Msg);
        handle->data = nullptr;
        return handle;
    }
    catch(const std::exception& ex)
    {
        C4MapgenHandle* handle = new C4MapgenHandle;
        handle->width = 0;
        handle->height = 0;
        handle->error_message.Copy(ex.what());
        handle->data = nullptr;
        return handle;
    }
}

References c4_log_handle_clear(), c4_log_handle_get_first_log_message(), c4_log_handle_get_n_log_messages(), c4_mapgen_handle_deinit_script_engine(), c4_mapgen_handle_init_script_engine(), C4SLandscape::Default(), Definitions, C4Group::FindNextEntry(), FormatString(), GameScript, StdStrBuf::getData(), C4Group::GetError(), C4MapCreatorS2::GetMap(), HANDLE_TO_MATERIAL_MAP, HANDLE_TO_TEXTURE_MAP, C4AulScriptEngine::Link(), C4GameScriptHost::Load(), C4SLandscape::MapHgt, C4SLandscape::MapPlayerExtend, C4SLandscape::MapWdt, C4MCParserErr::Msg, C4Group::Open(), C4MCParser::ParseMemFile(), C4MapCreatorS2::RenderBuf(), C4Group::ResetSearch(), ScriptEngine, C4SVal::Set(), and _C4MapgenHandle::width.

Referenced by mape_mapgen_render().

Here is the call graph for this function:

Here is the caller graph for this function:

c4_mapgen_handle_new_script()

C4MapgenHandle* c4_mapgen_handle_new_script	(	const char *	filename,
		const char *	source,
		C4MaterialMapHandle *	material_map,
		C4TextureMapHandle *	texture_map,
		unsigned int	map_width,
		unsigned int	map_height
	)

Definition at line 98 of file mapgen-handle.cpp.

{
    // Re-initialize script engine. Otherwise, we get a warning when the user
    // changes the value of a constant, since it is defined already from the
    // previous map rendering.  Note that we do not need to re-load the map library.
    c4_mapgen_handle_deinit_script_engine();
    c4_mapgen_handle_init_script_engine();
 
    try
    {
        // TODO: Could also re-use an existing CSurface8,
        // saving unnecessary malloc/free between map renderings
        C4SLandscape landscape;
        landscape.Default();
 
        landscape.MapWdt.Set(map_width, 0, map_width, map_width);
        landscape.MapHgt.Set(map_height, 0, map_height, map_height);
        landscape.MapPlayerExtend = 0;
 
        c4_log_handle_clear();
        ::MapScript.LoadData(filename, source, nullptr);
        // If InitializeMap() returns false, the map creator wants to
        // call a fallback in the scenario script. This crashes if no
        // scenario script is loaded, so simply load an empty script
        // here:
        ::GameScript.LoadData("Script.c", "", nullptr);
 
        const char* parse_error = c4_log_handle_get_first_log_message();
        if(parse_error)
            throw std::runtime_error(parse_error);
 
        // Link script engine (resolve includes/appends, generate code)
        c4_log_handle_clear();
        ScriptEngine.Link(&::Definitions);
        if(c4_log_handle_get_n_log_messages() > 1)
            throw std::runtime_error(c4_log_handle_get_first_log_message());
 
        // Generate map, fail if return error occurs
        c4_log_handle_clear();
        std::unique_ptr<CSurface8> out_ptr_fg, out_ptr_bg;
        const bool result = ::MapScript.InitializeMap(
            &landscape,
            HANDLE_TO_TEXTURE_MAP(texture_map),
            HANDLE_TO_MATERIAL_MAP(material_map),
            1,
            &out_ptr_fg, &out_ptr_bg);
 
        // Don't show any map if there was a script runtime error
        const char* runtime_error = c4_log_handle_get_first_log_message();
        if(runtime_error)
            throw std::runtime_error(runtime_error);
 
        if(!result)
            throw std::runtime_error("No InitializeMap() function present in the script, or it returns false");
 
        C4MapgenHandle* handle = new C4MapgenHandle;
        handle->width = out_ptr_fg->Wdt;
        handle->height = out_ptr_fg->Hgt;
        handle->rowstride = out_ptr_fg->Wdt;
        handle->error_message = nullptr;
        handle->data = out_ptr_fg->Bits;
        out_ptr_fg->ReleaseBuffer();
 
        return handle;
    }
    catch(const std::exception& ex)
    {
        C4MapgenHandle* handle = new C4MapgenHandle;
        handle->width = 0;
        handle->height = 0;
        handle->error_message.Copy(ex.what());
        handle->data = nullptr;
        return handle;
    }
}

References c4_log_handle_clear(), c4_log_handle_get_first_log_message(), c4_log_handle_get_n_log_messages(), c4_mapgen_handle_deinit_script_engine(), c4_mapgen_handle_init_script_engine(), C4SLandscape::Default(), Definitions, GameScript, HANDLE_TO_MATERIAL_MAP, HANDLE_TO_TEXTURE_MAP, C4MapScriptHost::InitializeMap(), C4AulScriptEngine::Link(), C4MapScriptHost::LoadData(), C4GameScriptHost::LoadData(), C4SLandscape::MapHgt, C4SLandscape::MapPlayerExtend, MapScript, C4SLandscape::MapWdt, ScriptEngine, C4SVal::Set(), and _C4MapgenHandle::width.

Referenced by mape_mapgen_render().

Here is the call graph for this function:

Here is the caller graph for this function:

c4_mapgen_handle_set_map_library()

void c4_mapgen_handle_set_map_library

(

C4GroupHandle *

group_handle

)

Definition at line 78 of file mapgen-handle.cpp.

{
    ::Definitions.Clear();
 
    C4Def* libmap = new C4Def;
    libmap->id = C4ID(std::string("Library_Map"));
    libmap->SetName(libmap->id.ToString());
    libmap->Category = C4D_StaticBack;
    FakeSkeletonLoader loader;
    if(!libmap->Load(*HANDLE_TO_GROUP(group_handle), loader, C4D_Load_Script, nullptr, nullptr))
    {
        fprintf(stderr, "Failed to load Library_Map script\n");
        delete libmap;
    }
    else
    {
        ::Definitions.Add(libmap, false);
    }
}

References C4DefList::Add(), C4D_Load_Script, C4D_StaticBack, C4Def::Category, C4DefList::Clear(), Definitions, HANDLE_TO_GROUP, C4Def::id, C4Def::Load(), C4PropList::SetName(), and C4ID::ToString().

Referenced by mape_mapgen_set_root_group().

Here is the call graph for this function:

Here is the caller graph for this function: