PasteComponentCmd.cc

Go to the documentation of this file.

/*
    Copyright (c) 2002-2010 Tampere University.
 
    This file is part of TTA-Based Codesign Environment (TCE).
 
    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.
 */
/**
 * @file PasteComponentCmd.cc
 *
 * Implementation of PasteComponentCmd class.
 *
 * @author Veli-Pekka Jääskeläinen 2004 (vjaaskel-no.spam-cs.tut.fi)
 * @author Pekka Jääskeläinen 2010 (pjaaskel-no.spam-cs.tut.fi)
 */
 
#include <wx/docview.h>
#include <boost/format.hpp>
 
#include "Application.hh"
#include "PasteComponentCmd.hh"
#include "MDFView.hh"
#include "MDFDocument.hh"
#include "ProDeConstants.hh"
#include "ProDeClipboard.hh"
#include "Machine.hh"
#include "Conversion.hh"
#include "WxConversion.hh"
#include "ProDeTextGenerator.hh"
#include "InformationDialog.hh"
#include "ObjectState.hh"
 
#include "Socket.hh"
#include "FunctionUnit.hh"
#include "Bus.hh"
#include "RegisterFile.hh"
#include "ImmediateUnit.hh"
#include "ControlUnit.hh"
#include "Guard.hh"
 
using std::string;
using boost::format;
using namespace TTAMachine;
 
/**
 * The Constructor.
 */
PasteComponentCmd::PasteComponentCmd():
    EditorCommand(ProDeConstants::CMD_NAME_PASTE) {
}
 
 
 
/**
 * Executes the command.
 *
 * Copies descriptor of a component from the clipboard and adds
 * corresponding component to the machine
 *
 * @return True, if the command was succesfully executed, false otherwise.
 */
bool
PasteComponentCmd::Do() {
 
    ProDeClipboard* clipboard = ProDeClipboard::instance();
    ObjectState* contents = clipboard->copyContents();
 
    MDFDocument* document =
    dynamic_cast<MDFDocument*>(view()->GetDocument());
    assert(document != NULL);
    Machine* machine = document->getModel()->getMachine();
    assert(machine != NULL);
 
    document->getModel()->pushToStack();
 
    if (contents->name() == Socket::OSNAME_SOCKET) {
        // socket
        Machine::SocketNavigator navigator = machine->socketNavigator();
        Socket* socket = new Socket(contents);
        paste(*machine, socket, navigator);
        contents->setAttribute(Socket::OSKEY_NAME, socket->name());
        // Socket can be pasted only if the target machine has busses with
        // the same names as the busses where the copied socket was connected
        // to.
        try {
            socket->loadState(contents);
        } catch (ObjectStateLoadingException& e) {
            wxString message =
                _T("The socket cannot be pasted to this machine.\n\n");
            message.Append(WxConversion::toWxString(e.errorMessage()));
            InformationDialog dialog(parentWindow(), message);
            dialog.ShowModal();
            delete socket;
            return false;
        }
 
    } else if (contents->name() == FunctionUnit::OSNAME_FU) {
        // function unit
        Machine::FunctionUnitNavigator navigator =
            machine->functionUnitNavigator();
        TTAMachine::FunctionUnit* copiedFU = new FunctionUnit(contents);
        std::string fuName = copiedFU->name();
        paste(*machine, copiedFU, navigator);
        
        // cannot copy address space from one machien to another.
        if (clipboard->sourceMachine() == machine) {
            TTAMachine::FunctionUnit& original = 
                *navigator.item(fuName);
            // need to do this after paste() as the FU must be registered to
            // the machine before the address space can be set
            if (original.hasAddressSpace()) {
                copiedFU->setAddressSpace(original.addressSpace());
            }
        } 
    } else if (contents->name() == ImmediateUnit::OSNAME_IMMEDIATE_UNIT) {
        // immediate unit
        Machine::ImmediateUnitNavigator navigator =
            machine->immediateUnitNavigator();
        paste(*machine, new ImmediateUnit(contents), navigator);
 
    } else if (contents->name() == RegisterFile::OSNAME_REGISTER_FILE) {
        // register file
        Machine::RegisterFileNavigator navigator =
            machine->registerFileNavigator();
        paste(*machine, new RegisterFile(contents), navigator);
 
    } else if (contents->name() == Bus::OSNAME_BUS) {
        // register file
        Machine::BusNavigator navigator =
            machine->busNavigator();
        TTAMachine::Bus* copiedBus = new Bus(contents);
 
        // cannot copy guards from one machine into another
        // plus additional check if oroginal bus has been deleted
        if (clipboard->sourceMachine() == machine && 
            navigator.hasItem(copiedBus->name())) {
 
            TTAMachine::Bus& original = 
                *navigator.item(copiedBus->name());
    
            // register the bus to the machine, possibly rename it to
            // avoid name clashes
            paste(*machine, copiedBus, navigator);
    
            // also copy the guards from the original Bus 
            assert(copiedBus->guardCount() == 0);
            for (int i = 0; i < original.guardCount(); ++i) {
                original.guard(i)->copyTo(*copiedBus);
            }
        } else {
            // register the bus as above
            paste(*machine, copiedBus, navigator);
            assert(copiedBus->guardCount() == 0);
        }
    } else if (contents->name() == ControlUnit::OSNAME_CONTROL_UNIT) {
        // control unit
        if (machine->controlUnit() != NULL) {
            // Target machine already contained a control unit.
            // Display error message and pop the machine from undo stack.
            ProDeTextGenerator* generator = ProDeTextGenerator::instance();
            format fmt =
                generator->text(ProDeTextGenerator::MSG_ERROR_ONE_GCU);
            string title = fmt.str();
            wxString message = WxConversion::toWxString(title);
            InformationDialog info(parentWindow(), message);
            info.ShowModal();
            document->getModel()->popFromStack();
            delete contents;
            return false;
        } else {
            // Paste control unit.
            ControlUnit* gcu = new ControlUnit(contents);
            gcu->setMachine(*machine);
        }
    } else {
        // Unknown component type.
        assert(false);
    }
 
    delete contents;
 
    document->getModel()->notifyObservers();
 
    return false;
}
 
 
/**
 * Returns command identifier of this command.
 *
 * @return ID for this command to be used in menus and toolbars.
 */
int
PasteComponentCmd::id() const {
    return ProDeConstants::COMMAND_PASTE;
}
 
 
/**
 * Creates and returns a new instance of this command.
 *
 * @return Newly created instance of this command.
 */
PasteComponentCmd*
PasteComponentCmd::create() const {
    return new PasteComponentCmd();
}
 
 
 
/**
 * Returns path to the command's icon file.
 *
 * @return Full path to the command's icon file.
 */
string
PasteComponentCmd::icon() const {
    return ProDeConstants::CMD_ICON_PASTE;
}
 
 
 
/**
 * Returns true when the command is executable, false when not.
 *
 * This command is executable when a document is open and the
 * clipboard is not empty.
 *
 * @return True, if the command is executable.
 */
bool
PasteComponentCmd::isEnabled() {
 
    // check that a document is open
    wxDocManager* manager = wxGetApp().docManager();
    MDFView* mdfView = dynamic_cast<MDFView*>(manager->GetCurrentView());
    if (mdfView == NULL) {
        return false;
    }
 
    // check that the clipboard is not empty
    ProDeClipboard* clipboard = ProDeClipboard::instance();
    if (clipboard->isEmpty()) {
        return false;
    }
    return true;
}