apps/elftosb/common/SourceFile.h

/*
 * File:    SourceFile.h
 *
 * Copyright (c) Freescale Semiconductor, Inc. All rights reserved.
 * See included license file for license details.
 */
#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 elftosb
{
class SourceFile
{
public:
    // \brief Factory function that creates the correct subclass of SourceFile.
    static SourceFile *openFile(const std::string &path);

public:
    SourceFile(const std::string &path);

    virtual ~SourceFile();

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


    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; 

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

class BinarySourceFile : public SourceFile
{
public:
    BinarySourceFile(const std::string &path)
        : SourceFile(path)
    {
    }


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

    virtual DataSource *createDataSource();

    virtual bool hasEntryPoint() { return false; }
};

}; // namespace elftosb

#endif // _SourceFile_h_