context.cpp

/***************************************************************************
 * This file is part of the KDE project
 * copyright (C) 2005 by Sebastian Sauer (mail@dipe.org)
 * copyright (C) 2005 by Tobi Krebs (tobi.krebs@gmail.com)
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 * This program 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
 * Library General Public License for more details.
 * You should have received a copy of the GNU Library General Public License
 * along with this program; see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 ***************************************************************************/
 
#include "context.h"
#include "action.h"
#include "macro.h"
#include "macroitem.h"
#include "exception.h"
 
//#include <tqtimer.h>
#include <kdebug.h>
 
using namespace KoMacro;
 
namespace KoMacro {

    class Context::Private
    {
        public:

            TDESharedPtr<Macro> macro;

            TQValueList<TDESharedPtr<MacroItem > > items;

            TDESharedPtr<MacroItem> macroitem;

            TQMap<TQString, TDESharedPtr<Variable > > variables;

            Exception* exception;

            explicit Private(TDESharedPtr<Macro> m)
                : macro(m) // remember the macro
                , items(m->items()) // set d-pointer children to macro children
                , exception(0) // no exception yet.
            {
            }

            ~Private()
            {
                delete exception;
            }
    };
 
}
//Constructor with initialization of our Private.object (d-pointer)
Context::Context(TDESharedPtr<Macro> macro)
    : TQObject()
    , d( new Private(macro) ) // create the private d-pointer instance.
{
}
 
//Destructor.
Context::~Context()
{
    delete d;
}
 
//return if we have (d-pointer) variables
bool Context::hasVariable(const TQString& name) const
{
    //Use TQMap?s contains to check if a variable with name exists
    return d->variables.contains(name);
}
 
//return variable with name or throw an exception if none is found in variables
TDESharedPtr<Variable> Context::variable(const TQString& name) const
{
    //Use TQMap?s contains to check if a variable with name exists in context   
    if (d->variables.contains(name)) {
        //return it
        return d->variables[name];
    }
    //if there is a macroitem try to get variable from it 
    if(d->macroitem.data()) {
        TDESharedPtr<Variable> v = d->macroitem->variable(name, true);
        if(v.data()) {
            return v;
        }
    }
    //none found throw exception
    throw Exception(TQString("Variable name='%1' does not exist.").arg(name));
}
 
//return a map of our (d-pointer) variables
Variable::Map Context::variables() const
{
    return d->variables;
}
 
//set a variable
void Context::setVariable(const TQString& name, TDESharedPtr<Variable> variable)
{
    //debuging infos
    kdDebug() << TQString("KoMacro::Context::setVariable name='%1' variable='%2'").arg(name).arg(variable->toString()) << endl;
    //Use TQMap?s replace to set/replace the variable named name
    d->variables.replace(name, variable);
}
 
//return the associated Macro
TDESharedPtr<Macro> Context::macro() const
{
    return d->macro;
}
 
//return the currently selected MacroItem
TDESharedPtr<MacroItem> Context::macroItem() const
{
    return d->macroitem;
}
 
//return if this context had an exception
bool Context::hadException() const
{
    return d->exception != 0;
}
 
//return the (d-pointer) exception
Exception* Context::exception() const
{
    return d->exception;
}
 
//try to activate all action?s in this context
void Context::activate(TQValueList<TDESharedPtr<MacroItem > >::ConstIterator it)
{
    //debuging infos
    kdDebug() << "Context::activate()" << endl;
    //TQ_ASSIGN(d->macro);
 
    //set end to constEnd
    TQValueList<TDESharedPtr<MacroItem > >::ConstIterator end(d->items.constEnd());
    //loop through actions
    for(;it != end; ++it) {
        // fetch the MacroItem we are currently pointing to.
        d->macroitem = TDESharedPtr<MacroItem>(*it);
        //skip empty macroitems
        if(! d->macroitem.data()) {
            kdDebug() << "Context::activate() Skipping empty MacroItem" << endl;
            continue;
        }
 
        // fetch the Action, the MacroItem points to.
        TDESharedPtr<Action> action = d->macroitem->action();
        //skip macroitems without an action
        if(! action.data()) {
            kdDebug() << "Context::activate() Skipping MacroItem with no action" << endl;
            continue;
        }
 
        try {
            // activate the action
            action->activate(this);
        }
        //catch exceptions
        catch(Exception& e) {
            //create a new exception from caugth one and set internal exception 
            d->exception = new Exception(e);
            //add new tracemessages
            //the macro name
            d->exception->addTraceMessage( TQString("macro=%1").arg(d->macro->name()) );
            //the action name
            d->exception->addTraceMessage( TQString("action=%1").arg(action->name()) );
            //and all variables wich belong to the action/macro
            TQStringList variables = action->variableNames();
            for(TQStringList::Iterator vit = variables.begin(); vit != variables.end(); ++vit) {
                TDESharedPtr<Variable> v = d->macroitem->variable(*vit, true);
                d->exception->addTraceMessage( TQString("%1=%2").arg(*vit).arg(v->toString()) );
            }
            return; // abort execution
        }
    }
 
    // The run is done. So, let's remove the currently selected item to
    // outline, that we did the job and there stays no dangling item.
    d->macroitem = TDESharedPtr<MacroItem>(0);
}
 
//try to activated an context
void Context::activate(TDESharedPtr<Context> context)
{
    //setup context
    delete d->exception; d->exception = 0;
    
    if(context->hadException()) {
        // if the context in which this context should run in already had an exception,
        // we adopt this exception and abort the execution. 
        d->exception = new Exception( *context->exception() );
        return;
    }
 
    // Merge the passed context into this context
    Variable::Map variables = context->variables();
    //copy variables
    Variable::Map::ConstIterator it, end( variables.constEnd() );
    for( it = variables.constBegin(); it != end; ++it)
        setVariable(it.key(), it.data());
    
    //activate copied context.
    activate(d->items.constBegin());
}
 
//try to continue activation of a context
void Context::activateNext()
{   
    //setup/clear context,
    //allows us to continue activation even when an exception happend before
    delete d->exception; d->exception = 0;
 
    if(! d->macroitem) { // if no MacroItem is defined, we don't need to try to continue execution
        return;
    }
 
    //find the macroitem from which to continue
    TQValueList<TDESharedPtr<MacroItem > >::ConstIterator it = d->items.find(d->macroitem);
    if (it != d->items.constEnd()) {
        activate(++it); // try to continue the execution.
    }
}
 
#include "context.moc"