SourceLister.h

#ifndef ROSE_BinaryAnalysis_ModelChecker_SourceLister_H
#define ROSE_BinaryAnalysis_ModelChecker_SourceLister_H
#include <featureTests.h>
#ifdef ROSE_ENABLE_MODEL_CHECKER

#include <Rose/BinaryAnalysis/ModelChecker/Types.h>

#include <boost/filesystem.hpp>
#include <boost/format.hpp>
#include <Rose/SourceLocation.h>

namespace Rose {
namespace BinaryAnalysis {
namespace ModelChecker {

class SourceLister {
public:
    using Ptr = SourceListerPtr;

    struct Settings {
        std::vector<boost::filesystem::path> directories;
        boost::format currentLineFormat{"|       ==> %06d  %s"};
        boost::format contextLineFormat{"|           %06d  %s"};
        size_t leadingContext = 3;
        size_t trailingContext = 3;
    };

private:
    mutable SAWYER_THREAD_TRAITS::Mutex mutex_;         // protects the following data members
    Sawyer::Container::Map<boost::filesystem::path, std::shared_ptr<Sawyer::Container::LineVector>> cache_;
    Settings settings_;

protected:
    SourceLister();
    explicit SourceLister(const Settings&);

public:
    static Ptr instance();
    static Ptr instance(const Settings&);
    boost::format currentLineFormat() const;
    void currentLineFormat(const boost::format&);
    boost::format contextLineFormat() const;
    void contextLineFormat(const boost::format&);
    size_t leadingContext() const;
    void leadingContext(size_t);
    size_t trailingContext() const;
    void trailingContext(size_t);
    std::vector<boost::filesystem::path> directories() const;
    void directories(const std::vector<boost::filesystem::path>&);
    void appendDirectory(const boost::filesystem::path&);

    bool list(std::ostream&, const SourceLocation&, const std::string &prefix);

private:
    // Decompose a path into search components. For instance, the path "/foo/bar/baz.c" will return
    //   /foo/bar/baz.c
    //   foo/bar/baz.c
    //   bar/baz.c
    //   baz.c
    static std::vector<boost::filesystem::path> decompose(const boost::filesystem::path&);

    // Find a readable file by searching in the specified directory for each of the file names. Returns
    // the path found, or empty.
    static boost::filesystem::path findFile(const boost::filesystem::path &dir, const std::vector<boost::filesystem::path> &names);
};

} // namespace
} // namespace
} // namespace

#endif
#endif