AtomicGameEngine/Source/Atomic/Engine/Application.h

//
// Copyright (c) 2008-2017 the Urho3D project.
//
// 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

#include "../Core/Context.h"
#include "../Core/Main.h"
#include "../Engine/Engine.h"

namespace Atomic
{

class Engine;

/// Base class for creating applications which initialize the Urho3D engine and run a main loop until exited.
class ATOMIC_API Application : public Object
{
    ATOMIC_OBJECT(Application, Object);

public:
    /// Construct. Parse default engine parameters from the command line, and create the engine in an uninitialized state.
    Application(Context* context);

    /// Setup before engine initialization. This is a chance to eg. modify the engine parameters. Call ErrorExit() to terminate without initializing the engine. Called by Application.
    virtual void Setup() { }

    /// Setup after engine initialization and before running the main loop. Call ErrorExit() to terminate without running the main loop. Called by Application.
    virtual void Start() { }

    /// Cleanup after the main loop. Called by Application.
    virtual void Stop() { }

    /// Initialize the engine and run the main loop, then return the application exit code. Catch out-of-memory exceptions while running.
    int Run();
    /// Show an error message (last log message if empty), terminate the main loop, and set failure exit code.
    void ErrorExit(const String& message = String::EMPTY);

    // ATOMIC BEGIN

    static bool GetAutoMetrics() { return autoMetrics_;  }
    static void SetAutoMetrics(bool value) { autoMetrics_ = value;  }

    // ATOMIC END

protected:
    /// Handle log message.
    void HandleLogMessage(StringHash eventType, VariantMap& eventData);

    /// Urho3D engine.
    SharedPtr<Engine> engine_;
    /// Engine parameters map.
    VariantMap engineParameters_;
    /// Collected startup error log messages.
    String startupErrors_;
    /// Application exit code.
    int exitCode_;

    // ATOMIC BEGIN

    static bool autoMetrics_;

    // ATOMIC END
};

// Macro for defining a main function which creates a Context and the application, then runs it
#ifndef IOS
#define ATOMIC_DEFINE_APPLICATION_MAIN(className) \
int RunApplication() \
{ \
    Atomic::SharedPtr<Atomic::Context> context(new Atomic::Context()); \
    Atomic::SharedPtr<className> application(new className(context)); \
    return application->Run(); \
} \
ATOMIC_DEFINE_MAIN(RunApplication());
#else
// On iOS we will let this function exit, so do not hold the context and application in SharedPtr's
#define ATOMIC_DEFINE_APPLICATION_MAIN(className) \
int RunApplication() \
{ \
    Atomic::Context* context = new Atomic::Context(); \
    className* application = new className(context); \
    return application->Run(); \
} \
ATOMIC_DEFINE_MAIN(RunApplication());
#endif

}