OperationModule.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 OperationModule.cc
 *
 * Definition of OperationModule class.
 *
 * @author Jussi Nykänen 2004 (nykanen-no.spam-cs.tut.fi)
 * @note rating: yellow
 * @note reviewed 7 September 2004 by pj, jn, jm, ao
 */
 
#include <string>
 
#include "OperationModule.hh"
#include "FileSystem.hh"
 
using std::string;
 
/// Property file extension.
const string OperationModule::PROPERTY_FILE_EXTENSION = ".opp";
/// Behavior file extension.
const string OperationModule::BEHAVIOR_FILE_EXTENSION = ".opb";
/// Source file extension.
const string OperationModule::BEHAVIOR_SOURCE_FILE_EXTENSION = ".cc";
 
/**
 * Constructor.
 *
 * @param name The name of the module.
 * @param path The path of the module.
 */
OperationModule::OperationModule(
    const std::string& name, 
    const std::string& path) : path_(path), name_(name) {
}
 
/**
 * Copy constructor.
 *
 * @param om The module to be copied.
 */
OperationModule::OperationModule(const OperationModule& om) {
    name_ = om.name();
    path_ = FileSystem::directoryOfPath(om.propertiesModule());
}
 
/**
 * Destructor.
 */
OperationModule::~OperationModule() {
}
 
/**
 * Assignment operator.
 *
 * @param om Module to be assigned.
 */
OperationModule&
OperationModule::operator=(const OperationModule& om) {
    name_ = om.name();
    path_ = FileSystem::directoryOfPath(om.propertiesModule());
    return *this;
}
 
/**
 * Checks whether OperationModule has behavior definition file.
 *
 * @return True if OperationModule has behavior definition file.
 */
bool
OperationModule::definesBehavior() const {
    return (FileSystem::fileExists(
                path_ + FileSystem::DIRECTORY_SEPARATOR + behaviorFileName()));
}
 
/**
 * Returns the name of the behavior module.
 *
 * @return The name of the behavior module.
 * @exception FileNotFound If behavior module is not found.
 */
string
OperationModule::behaviorModule() const {
    if (!definesBehavior()) {
        std::string method = "OperationModule::behaviorModule()";
        std::string msg = "Behavior file not found: " + behaviorFileName();
        throw FileNotFound(__FILE__, __LINE__, method, msg);
    }
 
    return path_ + FileSystem::DIRECTORY_SEPARATOR + behaviorFileName();
}
 
/**
 * Returns the name of the properties module.
 *
 * @return The name of the properties module.
 */
string
OperationModule::propertiesModule() const {
    return path_ + FileSystem::DIRECTORY_SEPARATOR + propertyFileName();
}
 
/**
 * Checks whether module has behavior source file.
 *
 * @return True if module has behavior source file.
 */
bool
OperationModule::hasBehaviorSource() const {
    return (FileSystem::fileExists(
                path_ + FileSystem::DIRECTORY_SEPARATOR + 
                behaviorSourceFileName()));
}
 
/**
 * Returns the name of the behavior source code file.
 *
 * @return The name of the behavior source code file.
 * @exception FileNotFound If behavior source file not found.
 */
string
OperationModule::behaviorSourceModule() const {
    if (!hasBehaviorSource()) {
        std::string method = "OperationModule::behaviorSourceModule()";
        std::string msg = "Behavior source file not found.";
        throw FileNotFound(__FILE__, __LINE__, method, msg);
    }
 
    return path_ + FileSystem::DIRECTORY_SEPARATOR + behaviorSourceFileName();
}
 
/**
 * Returns the name of the module.
 *
 * @return The name of the module.
 */
std::string
OperationModule::name() const {
    return name_;
}
 
/**
 * Returns the name of the behavior file name.
 *
 * @return The name of the behavior file name. 
 */
std::string
OperationModule::behaviorFileName() const {
    return name_ + BEHAVIOR_FILE_EXTENSION;
}
 
/**
 * Returns the name of the properties file.
 *
 * @return The name of the properties file.
 */
std::string
OperationModule::propertyFileName() const {
    return name_ + PROPERTY_FILE_EXTENSION;
}
 
/**
 * Returns the name of the code file.
 *
 * @return The name of the code file.
 */
std::string
OperationModule::behaviorSourceFileName() const {
    return name_ + BEHAVIOR_SOURCE_FILE_EXTENSION;
}
 
//////////////////////////////////////////////////////////////////////////////
// NullOperationModule
//////////////////////////////////////////////////////////////////////////////
 
NullOperationModule NullOperationModule::instance_;
 
/** 
 * Constructor.
 */
NullOperationModule::NullOperationModule() : OperationModule("<NULL>", "") {
}
 
/**
 * Destructor.
 */
NullOperationModule::~NullOperationModule() {
}
 
/**
 * Writes a message to error log and aborts the program.
 *
 * @return Never returns.
 */
string
NullOperationModule::name() const {
    abortWithError("name()");
    return "";
}
 
/**
 * Writes a message to error log and aborts the program.
 *
 * @return Never returns.
 */
bool
NullOperationModule::definesBehavior() const {
    abortWithError("definesBehavior()");
    return false;
}
 
/**
 * Writes a message to error log and aborts the program.
 *
 * @return Never returns.
 * @exception FileNotFound If behavior module is not found.
 */
string
NullOperationModule::behaviorModule() const {
    abortWithError("behaviorModule()");
    return "";
}
 
/**
 * Writes a message to error log and aborts the program.
 *
 * @return Never returns.
 */
string
NullOperationModule::propertiesModule() const {
    
    abortWithError("propertiesModule()");
    return "";
}
 
/**
 * Writes a message to error log and aborts the program. 
 *
 * @return Never returns.
 */
bool
NullOperationModule::hasBehaviorSource() const {
    abortWithError("hasBehaviorSource()");
    return false;
}
 
/**
 * Writes a message to error log and aborts the program. 
 *
 * @return Never returns.
 * @exception FileNotFound Doesn't throw.
 */
string
NullOperationModule::behaviorSourceModule() const {
    abortWithError("behaviorSourceModule()");
    return "";
}