genesis-3d_engine/Engine/foundation/interface/interfacebase.h

/****************************************************************************
Copyright (c) 2008, Radon Labs GmbH
Copyright (c) 2011-2013,WebJet Business Division,CYOU
 
http://www.genesis-3d.com.cn

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
****************************************************************************/

#pragma once
//------------------------------------------------------------------------------
/**
    @class Interface::InterfaceBase
    
    Base class for interfaces. An interface is the frontend of a fat thread,
    visible from all threads in the Nebula3 application. Other threads can
    send messages to the Interface singleton which will dispatch the
    messages to handlers running in the thread context.
*/
#include "messaging/asyncport.h"
#include "util/stringatom.h"

//------------------------------------------------------------------------------
namespace Interface
{
class InterfaceBase : public Messaging::AsyncPort
{
    __DeclareClass(InterfaceBase);
public:
    /// constructor
    InterfaceBase();
    /// destructor
    virtual ~InterfaceBase();
    
    /// attach a handler to the port (call before open!)
    virtual void AttachHandler(const GPtr<Messaging::Handler>& h);
    /// open the async port
    virtual void Open();

    /// get the company name
    const Util::StringAtom& GetCompanyName() const;
    /// get the application name
    const Util::StringAtom& GetAppName() const;
    /// get the root directory
    const Util::StringAtom& GetRootDirectory() const;
    
private:
    /// set the company name
    void SetCompanyName(const Util::StringAtom& companyName);
    /// set the application name
    void SetAppName(const Util::StringAtom& appName);
    /// set the root directory (default is home:)
    void SetRootDirectory(const Util::StringAtom& dir);

    Util::StringAtom rootDirectory;
    Util::StringAtom companyName;
    Util::StringAtom appName;
};

//------------------------------------------------------------------------------
/**
*/
inline void
InterfaceBase::SetCompanyName(const Util::StringAtom& n)
{
    this->companyName = n;
}

//------------------------------------------------------------------------------
/**
*/
inline const Util::StringAtom&
InterfaceBase::GetCompanyName() const
{
    return this->companyName;
}

//------------------------------------------------------------------------------
/**
*/
inline void
InterfaceBase::SetAppName(const Util::StringAtom& n)
{
    this->appName = n;
}

//------------------------------------------------------------------------------
/**
*/
inline const Util::StringAtom&
InterfaceBase::GetAppName() const
{
    return this->appName;
}

//------------------------------------------------------------------------------
/**
*/
inline void
InterfaceBase::SetRootDirectory(const Util::StringAtom& d)
{
    this->rootDirectory = d;
}

//------------------------------------------------------------------------------
/**
*/
inline const Util::StringAtom&
InterfaceBase::GetRootDirectory() const
{
    return this->rootDirectory;
}

} // namespace Interface
//------------------------------------------------------------------------------