tResourceManager Class Reference

resource manager: fetches and caches resources from repositories or arbitrary URIs More...

#include <tResourceManager.h>

List of all members.

Static Public Member Functions
static tResource *	GetResource (const char *file, int typeID)
	When finished, this will be the preferred way to load a resource.
static int	RegisterResourceType (tNewResourceFunc func)
	Register a resource type.
static tString	locateResource (const char *file, const char *uri="")
	Return the position of the resource in the cache.
static FILE *	openResource (const char *pathname, const char *uri="")
	opens a resource
static tString &	AccessRepoServer ()
	server determined resource repository
static tString &	AccessRepoClient ()
	client determined resource repository
static void	RegisterLoader ()
	register a resource component loader

---

Detailed Description

resource manager: fetches and caches resources from repositories or arbitrary URIs

Definition at line 10 of file tResourceManager.h.

---

Member Function Documentation

tResource * tResourceManager::GetResource	(	const char *	file,
		int	typeID
	)			[static]

When finished, this will be the preferred way to load a resource.

Parameters:

	file	the full path to the file
	typeID	the unique identifier for the resource type, which is in turn returned from RegisterResourceType

See also:

RegisterResourceType

Definition at line 21 of file tResourceManager.cpp.

References NULL.

{
    // stub
    return NULL;
}

int tResourceManager::RegisterResourceType

(

tNewResourceFunc

func

)

[static]

Register a resource type.

Parameters:

func

a function that returns a new instance of the resource

Returns:

the unique identifier for the function. Use this in subsequence calls to GetResource.

When you create a new resource type, you must register a function that will instantiate that new type. Later on you'll call tResourceManager to instantiate the type for a resource that's needed and you'll need to know the identifier returned from this method.

Definition at line 27 of file tResourceManager.cpp.

                                                                {
    // stub
    return 0;
}

tString tResourceManager::locateResource	(	const char *	file,
		const char *	uri = ""
	)			[static]

Return the position of the resource in the cache.

Definition at line 140 of file tResourceManager.cpp.

References AccessRepoClient(), AccessRepoServer(), con, free, tPath::GetReadPath(), tPathResource::GetWritePath(), malloc, myFetch(), NULL, pos, tDirectories::Resource(), and rv.

Referenced by tXmlParserNamespace::tXmlResource::LoadFile(), tXmlParserNamespace::tXmlParser::LoadWithoutParsing(), tXmlParserNamespace::tXmlParser::LoadWithParsing(), openResource(), and RInclude().

                                                                          {
    tString filepath, a_uri = tString(), savepath;
    int rv;

    char * to_free = NULL; // string to delete later

    {
        char const *pos, *posb;
        char *nf;
        size_t l;

        // Step 1: If 'file' has an open paren, cut everything after it off
        if ( (pos = strchr(file, '(')) ) {
            l = (size_t)(pos - file);
            nf = (char*)malloc((l + 1) * sizeof(char));
            strncpy(nf, file, l);
            nf[l] = '\0';
            file = nf;
            to_free = nf;

            // Step 2: Extract URI, if any
            ++pos;
            if ( (posb = strchr(pos, ')')) ) {
                l = (size_t)(posb - pos);
                nf = (char*)malloc((l + 1) * sizeof(char));
                strncpy(nf, pos, l);
                nf[l] = '\0';
                a_uri << nf << ';';
                free( nf );
            }
        }
    }
    // Validate paths and determine detination savepath
    if (!file || file[0] == '\0') {
        con << tOutput( "$resource_no_filename" );
        return (tString) NULL;
    }
    if (file[0] == '/' || file[0] == '\\') {
        con << tOutput( "$resource_abs_path" );
        return (tString) NULL;
    }
    savepath = tDirectories::Resource().GetWritePath(file);
    if (savepath == "") {
        con << tOutput( "$resource_no_writepath" );
        return (tString) NULL;
    }

    // Do we have this file locally ?
    filepath = tDirectories::Resource().GetReadPath(file);

    if (filepath != "")
    {
        if ( NULL != to_free )
            free( to_free );
        return filepath;
    }

    // Some sort of File not found
    if (uri && strcmp("0", uri))
        a_uri << uri << ';';

    // add repositories to uri
    if ( AccessRepoServer().Len() > 2 )
        a_uri << AccessRepoServer() << file << ';';

    if ( AccessRepoClient().Len() > 2 && AccessRepoClient() != AccessRepoServer() )
        a_uri << AccessRepoClient() << file << ';';

    con << tOutput( "$resource_not_cached", file );

    rv = myFetch((const char *)a_uri, file, (const char *)savepath);

    if ( NULL != to_free )
        free( to_free );

    if (rv)
        return (tString) NULL;
    return savepath;
}

Here is the call graph for this function:

Here is the caller graph for this function:

FILE * tResourceManager::openResource	(	const char *	pathname,
		const char *	uri = ""
	)			[static]

opens a resource

Definition at line 220 of file tResourceManager.cpp.

References tString::Len(), locateResource(), and NULL.

Referenced by tXmlParserNamespace::tXmlParser::LoadWithoutParsing(), tXmlParserNamespace::tXmlParser::LoadWithParsing(), and tXmlParserNamespace::myxmlParserInputBufferCreateFilenameFunc().

                                                                      {
    tString filepath;
    filepath = locateResource(file, uri);
    if ( filepath.Len() <= 1 )
        return NULL;
    return fopen((const char *)filepath, "r");
}

Here is the call graph for this function:

Here is the caller graph for this function:

tString & tResourceManager::AccessRepoServer

(

)

[static]

server determined resource repository

Definition at line 37 of file tResourceManager.cpp.

Referenced by locateResource().

{
    static tString resRepoServer("http://resource.armagetronad.net/resource/");
    return resRepoServer;
}

Here is the caller graph for this function:

tString & tResourceManager::AccessRepoClient

(

)

[static]

client determined resource repository

Definition at line 45 of file tResourceManager.cpp.

Referenced by locateResource().

{
    static tString resRepoClient("http://resource.armagetronad.net/resource/");
    return resRepoClient;
}

Here is the caller graph for this function:

void tResourceManager::RegisterLoader

(

)

[static]

register a resource component loader

Definition at line 17 of file tResourceManager.cpp.

{
}

---

The documentation for this class was generated from the following files:

• src/tools/tResourceManager.h
• src/tools/tResourceManager.cpp

---