story.cpp

Go to the documentation of this file.

/*
 * story.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.
 *
 *
 * Implementation of basic story object.  See story.h
 */

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

#include <iostream>
#include <fstream>

#include "common/wave_ex.h"
#include "perf/perf.h"
#include "util/token_stream.h"


namespace story {


static const char * s_storyFilename             = "story.data";


// interface destructor implementation
Story::~Story(void) throw() { }


//
//      static helper methods
//

class StoryImpl : public Story {
public:
        // constructor, destructor ---------------------------------------------
        ~StoryImpl(void) throw() { }

        // public class methods ------------------------------------------------
        void initialize(IN const char * locale,
                                IN const char * story_dir,
                                IN std::istream& stream);

        // story::Story class interface methods --------------------------------
        const char * getUuid(void) const throw() { return m_uuid.c_str(); }
        const char * getTitle(void) const throw() { return m_title.c_str(); }
        const char * getStartingMapId(void) const throw() {
                                return m_startingMapId.c_str(); }
        std::string getObjectPath(IN const char * objectType,
                                IN const char * objectId) const;
        smart_ptr<i18n::Manager> getI18nManager(IN const char * path);

private:

        // private data members ------------------------------------------------
        std::string             m_uuid;
        std::string             m_title;
        std::string             m_startingMapId;
        std::string             m_storyDir;     // root directory
        std::string             m_locale;
        smart_ptr<nstream::Manager> m_nstreamMgr; // filesystem manager
};



void
StoryImpl::initialize
(
IN const char * locale,
IN const char * story_dir,
IN std::istream& stream
)
{
        perf::Timer timer("story::initialize");
        ASSERT(locale, "null");
        ASSERT(story_dir, "null");
        ASSERT(stream.good(), "bad?");

        m_locale = locale;

        // remember where we are
        m_storyDir = story_dir;

        // create named stream manager
        // TODO: this should be passed in!  Assuming local filesystem for now.
        m_nstreamMgr = nstream::getFilesystemManager(story_dir);
        ASSERT_THROW(m_nstreamMgr,
            "Failed to create a named stream manager for local directory: " <<
            story_dir);

        // does the directory already end with a slash?
        int len = m_storyDir.length();
        if (len < 1) {
                WAVE_EX(wex);
                wex << "Invalid story directory: " << story_dir;
        }
        if ('/' != story_dir[len - 1]) {
                // append a trailing slash
                m_storyDir += "/";
        }

        // start
        expectToken(stream, "{");

        // parse stream
        expectToken(stream, "uuid");
        getNextToken(stream, m_uuid);
        DPRINTF("Loading story with uuid='%s'", m_uuid.c_str());

        expectToken(stream, "title");
        getNextToken(stream, m_title);
        DPRINTF("title = '%s'", m_title.c_str());

        expectToken(stream, "startingMapId");
        getNextToken(stream, m_startingMapId);
        DPRINTF("Starting map has id='%s'", m_startingMapId.c_str());

        // that's it
        expectToken(stream, "}");
}



//
//      StoryImpl -- story::Story class interface methods
//

std::string
StoryImpl::getObjectPath
(
IN const char * objectType,
IN const char * objectId
)
const
{
        ASSERT(objectType, "null");
        ASSERT(objectId, "null");

        // construct full pathname
        std::string full_path = m_storyDir;     // definitely ends with '/'
        full_path += objectType;
        full_path += "/";
        full_path += objectId;

        return full_path;
}



smart_ptr<i18n::Manager>
StoryImpl::getI18nManager
(
IN const char * path
)
{
        ASSERT(path, "null");
        ASSERT(m_nstreamMgr, "null");

        // construct full relative path
        std::string relpath = "strings/";
        relpath += m_locale;
        relpath += "/";
        relpath += path;

        // get a named stream to the appropriate file
        smart_ptr<nstream::Stream> stream =
            nstream::openNamedStream(m_nstreamMgr, relpath.c_str());
        ASSERT(stream, "null");         // above call should throw on error

        smart_ptr<i18n::Manager> mgr = i18n::Manager::create(m_locale.c_str());
        ASSERT(mgr, "null");

        mgr->parseStrings(stream);

        return mgr;
}



//
//      public API
//

smart_ptr<Story>
Story::create
(
IN const char * locale,
IN const char * story_dir
)
{
        ASSERT(locale, "null");
        ASSERT(story_dir, "null");

        // construct filename, open story file
        std::string filename = story_dir;
        filename += "/";
        filename += s_storyFilename;

        DPRINTF("Attempting to load story from '%s'...", filename.c_str());
        std::ifstream stream(filename.c_str());
        if (!stream.good()) {
                WAVE_EX(wex);
                wex << "Failed to load story from file '" << filename << "'.";
                wex << "  Bad directory '" << story_dir << "'?";
        }
        expectToken(stream, "story");

        // create story object from file
        smart_ptr<StoryImpl> local = new StoryImpl;
        ASSERT(local, "out of memory");
        local->initialize(locale, story_dir, stream);

        return local;
}



};      // story namespace