AtomicGameEngine/Source/ToolCore/Command/Command.h

//
// Copyright (c) 2014-2016 THUNDERBEAST GAMES LLC
//
// 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 <Atomic/Core/Object.h>

using namespace Atomic;

namespace ToolCore
{

ATOMIC_EVENT(E_COMMANDERROR, CommandError)
{
    ATOMIC_PARAM(P_MESSAGE, Message);      // string
}


ATOMIC_EVENT(E_COMMANDFINISHED, CommandFinished)
{

}

class Command : public Object
{
    ATOMIC_OBJECT(Command, Object)

public:

    Command(Context* context);
    virtual ~Command();

    /// Parse a command from given arguments and startIndex, return false on failure with errorMsg set
    bool Parse(const Vector<String>& arguments, unsigned startIndex, String& errorMsg);

    virtual void Run() = 0;

    virtual void Finished();

    virtual void Error(const String& errorMsg);

    virtual void Cancel() {}

    virtual bool RequiresProjectLoad() { return true; }

    virtual bool RequiresNETService() { return false; }

    /// Loads project into ToolSystem returning true on success
    bool LoadProject();

    /// Returns the project path specified by the --project common argument
    virtual const String& GetProjectPath() const { return projectPath_; }

    virtual bool RequiresLicenseValidation() { return false; }

protected:

    virtual bool ParseInternal(const Vector<String>& arguments, unsigned startIndex, String& errorMsg) = 0;

    void ParseCommonArguments(const Vector<String>& arguments, String &errorMsg);

    float timeOut_;    

    String projectPath_;

};

}