ContentsFigure.cc

Go to the documentation of this file.

/*
    Copyright (c) 2002-2009 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 ContentsFigure.cc
 *
 * Definition of ContentsFigure class.
 *
 * @author Ari Metsähalme 2003 (ari.metsahalme-no.spam-tut.fi)
 * @note rating: yellow
 * @note reviewed Jul 22 2004 by tr, ml, jm, am
 */
 
#include <vector>
 
#include "Application.hh"
#include "ContentsFigure.hh"
#include "UnitContainerFigure.hh"
#include "BusContainerFigure.hh"
#include "SocketContainerFigure.hh"
#include "MachineCanvasLayoutConstraints.hh"
 
using std::vector;
 
/**
 * The Constructor.
 */
ContentsFigure::ContentsFigure():
    Figure(), units_(NULL), buses_(NULL), sockets_(NULL) {
}
 
/**
 * The Destructor.
 */
ContentsFigure::~ContentsFigure() {
}
 
/**
 * Overloaded implementation allows only addition of certain types of
 * Figures for layout purposes.
 *
 * These are UnitContainerFigure, BusContainerFigure and
 * SocketContainerFigure.
 *
 * @param figure Child figure to add.
 */
void
ContentsFigure::addChild(Figure* figure) {
 
    Figure::addChild(figure);
 
    UnitContainerFigure* units = dynamic_cast<UnitContainerFigure*>(figure);
    if (units != NULL) {
    units_ = units;
    return;
    }
 
    BusContainerFigure* buses = dynamic_cast<BusContainerFigure*>(figure);
    if (buses != NULL) {
    buses_ = buses;
    return;
    }
 
    SocketContainerFigure* sockets =
    dynamic_cast<SocketContainerFigure*>(figure);
    if (sockets != NULL) {
    sockets_ = sockets;
    return;
    }
 
    // added a non supported type of a child figure
    assert(false);
}
 
/**
 * Draws figure on a given device context.
 *
 * Figure::draw() is overridden to enseure that the containers are drawn
 * in the correct order. (sockets over busses)
 *
 * @param dc Device context to draw figures on.
 */
void
ContentsFigure::draw(wxDC* dc) {
    if (units_ != NULL) {
        units_->draw(dc);
    }
    if (buses_ != NULL) {
        buses_->draw(dc);
    }
    if (sockets_ != NULL) {
        sockets_->draw(dc);
    }
}
 
/**
 * Lays out the subcontainers.
 *
 * @param dc Device context.
 */
void
ContentsFigure::layoutChildren(wxDC* dc) {
 
    int containerX =
    location_.x + MachineCanvasLayoutConstraints::VIEW_LEFT_MARGIN;
    int containerY =
    location_.y + MachineCanvasLayoutConstraints::VIEW_MARGIN;
 
    // first layout units if there are any
 
    if (units_ != NULL) {
    units_->setLocation(wxPoint(containerX, containerY));
    units_->layout(dc);
    containerY += units_->bounds().GetHeight() +
        MachineCanvasLayoutConstraints::CONNECTIONS_SPACE;
    }
 
    // then layout buses
 
    if (buses_ != NULL) {
 
    buses_->setLocation(
        wxPoint(containerX,
            containerY + MachineCanvasLayoutConstraints::BUS_SPACE));
 
    if (units_ != NULL && units_->bounds().GetWidth() >
        MachineCanvasLayoutConstraints::BUS_MIN_WIDTH) {
        buses_->setWidth(units_->bounds().GetWidth());
    } else {
        buses_->setWidth(MachineCanvasLayoutConstraints::BUS_MIN_WIDTH);
    }
    
    buses_->layout(dc);
    }
 
    // layout sockets
 
    if (sockets_ != NULL) {
 
    sockets_->setLocation(wxPoint(containerX, containerY));
 
    if (buses_ != NULL) {
        sockets_->setHeight(buses_->bounds().GetHeight() +
                MachineCanvasLayoutConstraints::BUS_SPACE);
        sockets_->setWidth(buses_->bounds().GetWidth() +
                MachineCanvasLayoutConstraints::BUS_SPACE);
    } else if (units_ != NULL) {
        sockets_->setWidth(units_->bounds().GetWidth() +
                   MachineCanvasLayoutConstraints::BUS_SPACE);
    }       
    
    sockets_->layout(dc);
 
    if (buses_ != NULL) {
        buses_->setWidth(sockets_->bounds().GetWidth());
        buses_->layout(dc);
    }
    }
}
 
/**
 * Calculates and sets the size of the container.
 * 
 * Depends on the sizes of the child containers: height will be equal
 * to the size of the unit container plus the height of the socket or
 * the bus container, whichever is higher. Width will be equal to the
 * width of the unit container, or the socket container if it is
 * wider.
 */
void
ContentsFigure::layoutSelf(wxDC*) {
 
    int width = 0;
    int height = 0;
 
    if (units_ != NULL) {
    width = units_->bounds().GetWidth();
    height = units_->bounds().GetHeight();
    }
    
    int higher = 0;
 
    if (sockets_ != NULL) {
    higher = sockets_->bounds().GetHeight();
    if (sockets_->bounds().GetWidth() > width) {
        width = sockets_->bounds().GetWidth();
    }
    }
    
    if (buses_ != NULL) {
    if (buses_->bounds().GetHeight() > higher) {
        higher = buses_->bounds().GetHeight();
    }
    if (buses_->bounds().GetWidth() > width) {
        width = buses_->bounds().GetWidth();
    }
    }
 
    height += higher + MachineCanvasLayoutConstraints::VIEW_MARGIN * 2;
    width += MachineCanvasLayoutConstraints::VIEW_MARGIN * 2;
 
    if (units_ != NULL && (buses_ != NULL || sockets_ != NULL)) {
    height += MachineCanvasLayoutConstraints::CONNECTIONS_SPACE;
    }
 
    size_.SetWidth(width);
    size_.SetHeight(height);
}