SourceLocations.h

#ifndef ROSE_BinaryAnalysis_SourceLocations_H
#define ROSE_BinaryAnalysis_SourceLocations_H
#include <featureTests.h>
#ifdef ROSE_ENABLE_BINARY_ANALYSIS

#include <Rose/SourceLocation.h>

#include <boost/filesystem.hpp>
#include <boost/serialization/access.hpp>
#include <Sawyer/IntervalMap.h>
#include <Sawyer/Map.h>
#include <Sawyer/Optional.h>
#include <Sawyer/Synchronization.h>
#include <set>
#include <string>

namespace Rose {
namespace BinaryAnalysis {

class SourceLocations {
public:
    typedef Sawyer::Container::IntervalMap<AddressInterval, SourceLocation> AddressToSource;
    typedef Sawyer::Container::Map<SourceLocation, AddressIntervalSet> SourceToAddress;

private:
    mutable SAWYER_THREAD_TRAITS::Mutex mutex_;         // protects the following data members
    AddressToSource addrToSrc_;
    SourceToAddress srcToAddr_;

private:
#ifdef ROSE_HAVE_BOOST_SERIALIZATION_LIB
    friend class boost::serialization::access;

    template<class S>
    void serialize(S &s, const unsigned /*version*/) {
        s & BOOST_SERIALIZATION_NVP(addrToSrc_);
        s & BOOST_SERIALIZATION_NVP(srcToAddr_);
    }
#endif

public:
    SourceLocations() {}

    SourceLocations(const SourceLocations&);
    SourceLocations& operator=(const SourceLocations&);
    void insert(const SourceLocation&, rose_addr_t);
    void insert(const SourceLocation&, const AddressInterval&);
    void insert(const SourceLocation&, const AddressIntervalSet&);
    void erase(const SourceLocation&, rose_addr_t);
    void erase(const SourceLocation&, const AddressInterval&);
    void erase(const SourceLocation&, const AddressIntervalSet&);
    void erase(rose_addr_t);
    void erase(const AddressInterval&);
    void erase(const AddressIntervalSet&);
    void erase(const SourceLocation&);

    void clear();

    void insertFromDebug(SgNode *ast);

    void fillHoles(size_t maxHoleSize = 64);

    SourceLocation get(rose_addr_t) const;
    SourceLocation operator()(rose_addr_t va) const {
        return get(va);
    }
    AddressIntervalSet get(const SourceLocation&) const;

    Sawyer::Optional<rose_addr_t> firstAddress(const SourceLocation&) const;
    Sawyer::Optional<rose_addr_t> operator()(const SourceLocation &loc) const {
        return firstAddress(loc);
    }
    std::set<boost::filesystem::path> allFileNames() const;

    SourceLocation nextSourceLocation(const SourceLocation &current = SourceLocation()) const;

    void printSrcToAddr(std::ostream&, const std::string &prefix = "") const;
    void print(std::ostream&, const std::string &prefix = "") const;
    void printAddrToSrc(std::ostream&, const std::string &prefix = "") const;

private:
    // Non-synchronized erasing of a link between source code and binary address.
    void eraseNS(const SourceLocation&, rose_addr_t);
    void eraseNS(rose_addr_t va);
};

std::ostream& operator<<(std::ostream&, const SourceLocations&);

} // namespace
} // namespace

#endif
#endif