inspector.hpp

Go to the documentation of this file.

//  inspector header  --------------------------------------------------------//

//  Copyright Beman Dawes 2002.
//  Copyright Rene Rivera 2004.
//  Distributed under the Boost Software License, Version 1.0.
//  (See accompanying file LICENSE_1_0.txt or copy at
//  http://www.boost.org/LICENSE_1_0.txt)

#ifndef BOOST_INSPECTOR_HPP
#define BOOST_INSPECTOR_HPP

#include <string>
#include <iostream>
#include <set>
#include <boost/filesystem/path.hpp>

using std::string;
using boost::filesystem::path;

namespace boost
{
namespace inspect
{
typedef std::set< string > string_set;

class inspector
{
public:
    virtual ~inspector() {}

    virtual const char* name() const = 0;  // example: "tab-check"
    virtual const char* desc() const = 0;  // example: "verify no tabs"

    // always called:
    virtual void inspect (
        const string& library_name,  // "filesystem"
        const path& full_path ) {}   // "c:/foo/boost/filesystem/path.hpp"

    // called only for registered leaf() signatures:
    virtual void inspect (
        const string& library_name,  // "filesystem"
        const path& full_path,       // "c:/foo/boost/filesystem/path.hpp"
        const string& contents ) {}  // contents of file

    // called after all paths visited, but still in time to call error():
    virtual void close() {}

    // callback used by constructor to register leaf() signature.
    // Signature can be a full file name (Jamfile) or partial (.cpp)
    void register_signature ( const string& signature );
    const string_set& signatures() const
    {
        return m_signatures;
    }

    // report error callback (from inspect(), close() ):
    void error (
        const string& library_name,
        const path& full_path,
        const string& msg );

private:
    string_set m_signatures;
};

// for inspection of source code of one form or other
class source_inspector : public inspector
{
public:
    // registers the basic set of known source signatures
    source_inspector();
};

// for inspection of hypertext, specifically html
class hypertext_inspector : public inspector
{
public:
    // registers the set of known html source signatures
    hypertext_inspector();
};

inline string relative_to ( const path& src_arg, const path& base_arg )
{
    path src ( src_arg );
    src.normalize();
    path base ( base_arg );
    base.normalize();
    string::size_type pos ( base.string().size() );
    return src.string().substr (
               pos + ( pos < src.string().size() ? 1 : 0 ) );
}

string impute_library ( const path& full_dir_path );

}
}

#endif // BOOST_INSPECTOR_HPP