ValueReplacer.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 ValueReplacer.cc
 *
 * Definition of ValueReplacer class.
 *
 * @author Mikael Lepistö 2003 (tmlepist-no.spam-cs.tut.fi)
 *
 * @note rating: yellow
 */
 
#include <set>
#include <iterator>
 
#include "ValueReplacer.hh"
#include "BinaryStream.hh"
#include "SafePointer.hh"
#include "SafePointable.hh"
#include "Exception.hh"
 
namespace TPEF {
 
std::set<ValueReplacer*> ValueReplacer::replacements_;
BinaryStream* ValueReplacer::stream_ = NULL;
 
/**
 * Constructor
 *
 * @param obj Object whole key is used for replacing bytes in stream.
 */
ValueReplacer::ValueReplacer(const SafePointable* obj) :
    reference_(obj) {
 
    assert(stream_ != NULL);
    assert(obj != NULL);
 
    try {
        streamPosition_ = stream_->writePosition();
    } catch (UnreachableStream const& e) {
        bool replacerConstructorBadStream = false;
        assert(replacerConstructorBadStream);
    }
}
 
/**
 * Copy constructor
 *
 * @para replacer Replacer which is copied.
 */
ValueReplacer::ValueReplacer(const ValueReplacer& replacer) :
    streamPosition_(replacer.streamPosition_),
    reference_(replacer.reference_) {
}
 
/**
 * Destructor
 */
ValueReplacer::~ValueReplacer() {
}
 
/**
 * Does replacement or set it to be done later.
 *
 * @exception UnreachableStream Writing can't be done, because of bad stream.
 * @exception WritePastEOF If replacer tried to write past end of file.
 */
void
ValueReplacer::resolve() {
    if(!tryToReplace()) {
        addReplacement(clone());
    }
}
 
/**
 * Initializes ValueReplacer for writing.
 *
 * Sets stream which we want write to and clears up key table of reference
 * manager so there won't be any keys with wrong values.
 *
 * @param stream Stream where replacements are done.
 */
void
ValueReplacer::initialize(BinaryStream& stream) {
    stream_ = &stream;
    assert(stream_ != NULL);
    replacements_.clear();
}
 
/**
 * Tries to do those replacement which couldn't do while writing.
 *
 * Deletes all remaining replacer instances after replacements were done.
 * When method is runned and no exceptions are thrown method cleans up
 * key tables of reference manager and unset's BinaryStream where
 * replacements were written. So initilize() method must be called again
 * before starting new writing. If MissingKeys exception is thrown,
 * then those replacements are not freed, which could not be done before.
 * Keys can be added and finalize may be called again.
 *
 * @exception MissingKeys If ReferenceManager doesn't contain needed keys.
 * @exception UnreachableStream Writing can't be done, because of bad stream.
 * @exception WritePastEOF If replacer tried to write past end of file.
 */
void
ValueReplacer::finalize() {
    while (!replacements_.empty()) {
        ValueReplacer* replacer = *(replacements_.begin());
 
        if(!replacer->tryToReplace()) {
            throw MissingKeys(
                __FILE__, __LINE__, __func__,
                "Can't replace object because of missing key.");
        }
 
        delete replacer;
        replacements_.erase(replacer);
    }
 
    stream_ = NULL;
}
 
/**
 * Adds a replacement object for later writing.
 *
 * @param replacer Replacement that should be done later.
 */
void
ValueReplacer::addReplacement(ValueReplacer* replacer) {
  replacements_.insert(replacements_.end(),replacer);
}
 
/**
 * Returns stream where to write.
 *
 * @return Stream where to write reference.
 */
BinaryStream&
ValueReplacer::stream() {
    return *stream_;
}
 
/**
 * Returns referenced object.
 *
 * @return Referenced object.
 */
const SafePointable*
ValueReplacer::reference() const {
    return reference_;
}
 
/**
 * Stream position where to write reference.
 *
 * @return Position where to write reference.
 */
unsigned int
ValueReplacer::streamPosition() const {
    return streamPosition_;
}
 
}