gamepad.cpp

Go to the documentation of this file.

/*
 * gamepad.cpp
 *
 * Copyright (C) 2008,2009  Thomas A. Vaughan
 * 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 <organization> 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 THOMAS A. VAUGHAN ''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 THOMAS A. VAUGHAN 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.
 *
 *
 * Provides canonical gamepad input.
 * Basically a mapping layer on top of the SDL joystick API.
 */

// includes --------------------------------------------------------------------
#include "gamepad.h"            // always include our own header first

#include "util/file.h"


namespace gamepad {


////////////////////////////////////////////////////////////////////////////////
//
//      static helper methods
//
////////////////////////////////////////////////////////////////////////////////

static smart_ptr<i18n::Manager>
createLocaleMgr
(
IN const char * locale,
IN nstream::Folder * dir,
IN const char * fileroot,
IN const char * importantId
)
{
        ASSERT(locale, "null");
        ASSERT(dir, "null");
        ASSERT(fileroot, "null");
        ASSERT(importantId, "null");

        // create locale manager (empty)
        smart_ptr<i18n::Manager> mgr = i18n::Manager::create(locale);
        ASSERT(mgr, "failed to create base locale manager");

        // get the stream manager
        smart_ptr<nstream::Manager> fsMgr = dir->getManager();
        ASSERT(fsMgr, "Failed to create filesystem named stream manager");

        // construct relative path to config file...
        std::string temp, relpath;
        appendPath("strings", locale, temp);
        appendPath(temp.c_str(), fileroot, relpath);
        relpath += ".txt";
        //DPRINTF("Relative path: %s", relpath.c_str());

        // open this file
        smart_ptr<nstream::Stream> stream;
        try {
                stream = nstream::openNamedStream(fsMgr, relpath.c_str());
        } catch (std::exception& e) {
                DPRINTF("Exception: %s", e.what());
        }

        if (!stream) {
                DPRINTF("Unable to open stream at path: '%s'", relpath.c_str());
                return NULL;    // file does not exist--not in locale?
        }

        // read locale information from stream
        mgr->parseStrings(stream);

        // verify important id exists
        if (!mgr->getString(importantId)) {
                DPRINTF("Found file '%s', but does not contain id '%s'",
                    relpath.c_str(), importantId);
                return NULL;    // incomplete or empty stream?
        }

        // okay...
        return mgr;
}


////////////////////////////////////////////////////////////////////////////////
//
//      public API
//
////////////////////////////////////////////////////////////////////////////////

smart_ptr<i18n::Manager>
getConfigLocaleMgr
(
IN const char * locale,
IN const char * defaultLocale,
IN nstream::Folder * dataDirectory
)
{
        ASSERT_THROW(locale || defaultLocale,
            "At least one locale (primary or backup) should be non-null!");
        ASSERT(dataDirectory, "null");

        // save some duplicate lookups
        if (!strcmp(locale, defaultLocale)) {
                defaultLocale = NULL;
        }

        smart_ptr<i18n::Manager> mgr;
        if (locale) {
                DPRINTF("Trying requested locale: '%s'", locale);
                mgr = createLocaleMgr(locale, dataDirectory, "config",
                    "buttonPress");
        }

        if (!mgr && defaultLocale) {
                DPRINTF("Falling back to default locale: '%s'", defaultLocale);
                mgr = createLocaleMgr(defaultLocale, dataDirectory,
                    "config", "buttonPress");
        }

        ASSERT_THROW(mgr, "Failed to create locale manager for gamepad " <<
            "configuration.  Bad data directory?  " << dataDirectory);

        return mgr;
}



smart_ptr<i18n::Manager>
getTypeLocaleMgr
(
IN const Type * type,
IN const char * locale,
IN const char * defaultLocale,
IN nstream::Folder * dataDirectory
)
{
        ASSERT(type, "null");
        ASSERT_THROW(locale || defaultLocale,
            "Either the primary or backup locale should be non-null!");
        ASSERT(dataDirectory, "null");

        // save some duplicate lookups
        if (locale && defaultLocale && !strcmp(locale, defaultLocale)) {
                defaultLocale = NULL;
        }

        // get the root
        const char * fileroot = type->getName();
        //DPRINTF("Looking up locale manager for gamepad type '%s'", fileroot);

        smart_ptr<i18n::Manager> mgr;
        if (locale) {
                mgr = createLocaleMgr(locale, dataDirectory, fileroot,
                    "friendlyName");
        }

        if (!mgr && defaultLocale) {
                mgr = createLocaleMgr(defaultLocale, dataDirectory, fileroot,
                    "friendlyName");
        }

        ASSERT_THROW(mgr, "Failed to create locale manager for gamepad '" <<
            fileroot << "'.  Bad data directory?  " << dataDirectory);

        return mgr;
}



};      // gamepad namespace