src/blfwk/DataTarget.h

/*
 * Copyright (c) 2013-14, Freescale Semiconductor, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * o Redistributions of source code must retain the above copyright notice, this list
 *   of conditions and the following disclaimer.
 *
 * o Redistributions in binary form must reproduce the above copyright notice, this
 *   list of conditions and the following disclaimer in the documentation and/or
 *   other materials provided with the distribution.
 *
 * o Neither the name of Freescale Semiconductor, Inc. nor the names of its
 *   contributors may be used to endorse or promote products derived from this
 *   software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
#if !defined(_DataTarget_h_)
#define _DataTarget_h_

#include "stdafx.h"
#include "DataSource.h"

namespace blfwk
{
// Forward declaration
class DataSource;

class DataTarget
{
public:
    struct AddressRange
    {
        uint32_t m_begin;
        uint32_t m_end;
    };

public:
    DataTarget()
        : m_source(0)
    {
    }

    virtual ~DataTarget() {}
    virtual bool isBounded() { return false; }
    virtual uint32_t getBeginAddress() { return 0; }
    virtual uint32_t getEndAddress() { return 0; }
    virtual DataTarget::AddressRange getRangeForSegment(DataSource &source, DataSource::Segment &segment) = 0;

    inline void setSource(DataSource *source) { m_source = source; }
    inline DataSource *getSource() const { return m_source; }
protected:
    DataSource *m_source; 
};

class ConstantDataTarget : public DataTarget
{
public:
    ConstantDataTarget(uint32_t start)
        : DataTarget()
        , m_begin(start)
        , m_end(0)
        , m_hasEnd(false)
    {
    }

    ConstantDataTarget(uint32_t start, uint32_t end)
        : DataTarget()
        , m_begin(start)
        , m_end(end)
        , m_hasEnd(true)
    {
    }

    virtual bool isBounded() { return m_hasEnd; }
    virtual uint32_t getBeginAddress() { return m_begin; }
    virtual uint32_t getEndAddress() { return m_end; }
    virtual DataTarget::AddressRange getRangeForSegment(DataSource &source, DataSource::Segment &segment);

protected:
    uint32_t m_begin; 
    uint32_t m_end;   
    bool m_hasEnd;    
};

class NaturalDataTarget : public DataTarget
{
public:
    NaturalDataTarget()
        : DataTarget()
    {
    }

    virtual bool isBounded() { return true; }
    virtual DataTarget::AddressRange getRangeForSegment(DataSource &source, DataSource::Segment &segment);
};

}; // namespace blfwk

#endif // _DataTarget_h_