thing.c

//*****************************************************************************
// Class: thing
// File Name: thing.c
//
// Copyright (c) 2018 - Allen Cummings, RealmsMUD, All rights reserved. See
//                      the accompanying LICENSE file for details.
//
// Description: Thing is the base object for all basic lib objects contained
//              within the base Realms object library. It provides access to
//              dictionaries and the message parser as well as integration
//              with the various lib modules.
//
//*****************************************************************************
private nosave string LibDirectory = "lib";

//-----------------------------------------------------------------------------
// Method: has
// Description: This method returns true if the Thing being queried has been
//              integrated with one of the core library modules.
//
// Parameters: service - the module to check for
//
// Returns: true if this 'thing' uses the queried module
//-----------------------------------------------------------------------------
public int has(string service)
{
    int ret = 0;
    
    if(service && stringp(service) && (member(inherit_list(this_object()),
       sprintf("%s/modules/%s.c", LibDirectory, service)) > -1))
    {
        ret = 1;
    }
    else if (service && stringp(service) && (member(inherit_list(this_object()),
        sprintf("%s/core/%s.c", LibDirectory, service)) > -1))
    {
        ret = 1;
    }
    return ret;
}

//-----------------------------------------------------------------------------
// Method: getService
// Description: This method returns the module object for the queried service
//              if it has been integrated with this instance of Thing.
//
// Parameters: service - the module to check for
//
// Returns: the module object if this 'thing' uses the queried module
//-----------------------------------------------------------------------------
protected object getService(string service)
{
    object ret = 0;
    if(has(service))
    {
        ret = this_object();
    }
    else if(function_exists("isRealizationOf", this_object()))
    {
        ret = call_other(this_object(), "isRealizationOf", service);
    }

    return ret;
}

//-----------------------------------------------------------------------------
// Method: getDictionary
// Description: This method returns the dictionary object for the queried
//              service or null if the dictionary does not exist. It will load
//              the dictionary blueprint if it is not already loaded by the
//              driver.
//
// Parameters: service - the dictioary to check for
//
// Returns: the dictionary object if it's a valid dictionary.
//-----------------------------------------------------------------------------
protected object getDictionary(string service)
{
    object ret = 0;
    
    if(service && stringp(service))
    {
        string dictionary = sprintf("/lib/dictionaries/%sDictionary.c", 
            service);
        if(file_size(dictionary) > -1)
        {
            ret = load_object(dictionary);
        }
    }
    return ret;
}

//-----------------------------------------------------------------------------
// Method: getMessageParser
// Description: This method returns the core lib message parser object. It will 
//              load the message parser blueprint if it is not already loaded 
//              by the driver.
//
// Returns: the core lib message parser object
//-----------------------------------------------------------------------------
protected object getMessageParser()
{
    object ret = 0;
    string parser = sprintf("/%s/core/messageParser.c", LibDirectory);
    if(file_size(parser) > -1)
    {
        ret = load_object(parser);
    }
    return ret;
}