src/blfwk/SourceFile.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(_SourceFile_h_)
#define _SourceFile_h_

#include <string>
#include <iostream>
#include <fstream>
#include "smart_ptr.h"
#include "DataSource.h"
#include "DataTarget.h"
#include "StringMatcher.h"
#include "OptionContext.h"

namespace blfwk
{
class SourceFile
{
public:
    // \brief Factory function that creates the correct subclass of SourceFile.
    static SourceFile *openFile(const std::string &path);

    enum source_file_t
    {
        kBinarySourceFile,   
        kELFSourceFile,      
        kIntelHexSourceFile, 
        kSBSourceFile,       
        kSRecordSourceFile   
    };

public:
    SourceFile(const std::string &path, source_file_t filetype);

    virtual ~SourceFile();

    inline void setOptions(OptionContext *context) { m_options = context; }
    inline const OptionContext *getOptions() const { return m_options; }
    inline source_file_t getFileType() const { return m_filetype; }
    inline const std::string &getPath() const { return m_path; }
    unsigned getSize() const { return m_size; }

    virtual void open();

    virtual void close();

    virtual bool isOpen() const { return (bool)m_stream && const_cast<std::ifstream *>(m_stream.get())->is_open(); }


    virtual bool supportsNamedSections() const = 0;
    virtual bool supportsNamedSymbols() const = 0;


    virtual DataSource *createDataSource() = 0;

    virtual DataSource *createDataSource(StringMatcher &matcher) { return NULL; }
    virtual DataSource *createDataSource(const std::string &section);


    virtual bool hasEntryPoint() = 0;

    virtual uint32_t getEntryPointAddress() { return 0; }


    virtual DataTarget *createDataTargetForSection(const std::string &section) { return NULL; }
    virtual DataTarget *createDataTargetForSymbol(const std::string &symbol) { return NULL; }
    virtual DataTarget *createDataTargetForEntryPoint();


    virtual bool hasSymbol(const std::string &name) { return false; }
    virtual uint32_t getSymbolValue(const std::string &name) { return 0; }
    virtual unsigned getSymbolSize(const std::string &name) { return 0; }

protected:
    std::string m_path;                 
    smart_ptr<std::ifstream> m_stream;  
    smart_ptr<OptionContext> m_options; 
    source_file_t m_filetype;           
    unsigned m_size;                    

    inline std::ifstream *getStream() { return m_stream; }
};

class BinarySourceFile : public SourceFile
{
public:
    BinarySourceFile(const std::string &path, source_file_t sourceFileType = kBinarySourceFile);


    virtual bool supportsNamedSections() const { return false; }
    virtual bool supportsNamedSymbols() const { return false; }


    virtual DataSource *createDataSource();


    void guessEntryPointAndStackPointer();

    virtual bool hasEntryPoint() { return m_entry_point != 0xffffffff; }
    virtual uint32_t getEntryPointAddress() { return m_entry_point; }
    uint32_t getStackPointer() { return m_stack_pointer; }

protected:
    uint32_t m_entry_point;
    uint32_t m_stack_pointer;
};

}; // namespace blfwk

#endif // _SourceFile_h_