FrontendMain.h

Go to the documentation of this file.

/*********************************************************\
 *  File: FrontendMain.h                                 *
 *
 *  Copyright (C) 2002-2012 The PixelLight Team (http://www.pixellight.org/)
 *
 *  This file is part of PixelLight.
 *
 *  PixelLight is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Lesser General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  PixelLight is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with PixelLight. If not, see <http://www.gnu.org/licenses/>.
\*********************************************************/


#ifndef __PLCORE_FRONTENDMAIN_H__
#define __PLCORE_FRONTENDMAIN_H__
#pragma once


//[-------------------------------------------------------]
//[ Includes                                              ]
//[-------------------------------------------------------]
#include "PLCore/Main.h"
#include "PLCore/Runtime.h"
#include "PLCore/ModuleMain.h"
#include "PLCore/Frontend/Frontend.h"
#include "PLCore/Frontend/FrontendContext.h"


//[-------------------------------------------------------]
//[ Macros                                                ]
//[-------------------------------------------------------]
/**
*  @brief
*    Defines a default frontend for a module inside a plugin library
*
*  @param[in] ModuleName
*    Module name
*  @param[in] ApplicationClass
*    Name of the application RTTI class to use (must be derived from "PLCore::FrontendApplication")
*
*  @remarks
*    Use this when you don't want to care about the program entry point.
*/
#define pl_module_application(ModuleName, ApplicationClass) \
    int PLMain(const PLCore::String &sExecutableFilename, const PLCore::Array<PLCore::String> &lstArguments) \
    { \
        /* Scan PL-runtime directory for compatible plugins and load them in as well as scan for compatible data and register it */ \
        if (PLCore::Runtime::ScanDirectoryPluginsAndData()) { \
            /* Setup the frontend context */ \
            PLCore::FrontendContext cFrontendContext; \
            cFrontendContext.SetExecutableFilename(sExecutableFilename); \
            cFrontendContext.SetArguments(lstArguments); \
            cFrontendContext.SetName(ModuleName); \
            cFrontendContext.SetFrontendParameters(PLCore::String("ApplicationClass=\"") + ApplicationClass + '\"'); \
    \
            /* Run the frontend */ \
            return PLCore::Frontend::Run(cFrontendContext); \
        } else { \
            /* Error! */ \
            return -1; \
        } \
    } \
    \
    pl_module_plugin(ModuleName)

/**
*  @brief
*    Defines a frontend for a module inside a plugin library
*
*  @param[in] ModuleName
*    Module name
*  @param[in] ApplicationClass
*    Name of the application RTTI class to use (must be derived from "PLCore::FrontendApplication")
*  @param[in] FrontendClass
*    Name of the frontend implementation RTTI class to use (e.g. "PLFrontendOS::Frontend")
*
*  @remarks
*    Use this when you don't want to care about the program entry point.
*/
#define pl_module_application_frontend(ModuleName, ApplicationClass, FrontendClass) \
    int PLMain(const PLCore::String &sExecutableFilename, const PLCore::Array<PLCore::String> &lstArguments) \
    { \
        /* Scan PL-runtime directory for compatible plugins and load them in as well as scan for compatible data and register it */ \
        if (PLCore::Runtime::ScanDirectoryPluginsAndData()) { \
            /* Setup the frontend context */ \
            PLCore::FrontendContext cFrontendContext; \
            cFrontendContext.SetExecutableFilename(sExecutableFilename); \
            cFrontendContext.SetArguments(lstArguments); \
            cFrontendContext.SetName(ModuleName); \
            cFrontendContext.SetFrontendParameters(PLCore::String("ApplicationClass=\"") + ApplicationClass + '\"'); \
            cFrontendContext.SetFrontendImplementation(FrontendClass); \
    \
            /* Run the frontend */ \
            return PLCore::Frontend::Run(cFrontendContext); \
        } else { \
            /* Error! */ \
            return -1; \
        } \
    } \
    \
    pl_module_plugin(ModuleName)


#endif // __PLCORE_FRONTENDMAIN_H__