xrb_datafilelocation.hpp

// ///////////////////////////////////////////////////////////////////////////
// xrb_datafilelocation.hpp by Victor Dods, created 2006/07/15
// ///////////////////////////////////////////////////////////////////////////
// Unless a different license was explicitly granted in writing by the
// copyright holder (Victor Dods), this software is freely distributable under
// the terms of the GNU General Public License, version 2.  Any works deriving
// from this work must also be released under the GNU GPL.  See the included
// file LICENSE for details.
// ///////////////////////////////////////////////////////////////////////////

#if !defined(_XRB_DATAFILELOCATION_HPP_)
#define _XRB_DATAFILELOCATION_HPP_

#include "xrb.hpp"

#include <iostream>
#include <string>

namespace Xrb
{

class DataFileLocation
{
public:

    static DataFileLocation const ms_invalid;

    DataFileLocation (std::string const &path, Uint32 line)
        :
        m_path(path),
        m_line(line)
    {
        assert(IsValid());
    }

    inline bool IsValid () const
    {
        return !m_path.empty() && m_line > 0;
    }
    inline std::string const &Path () const
    {
        assert(IsValid() && "can't use DataFileLocation::ms_invalid in this manner");
        return m_path;
    }
    inline Uint32 Line () const
    {
        assert(IsValid() && "can't use DataFileLocation::ms_invalid in this manner");
        return m_line;
    }
    std::string Text () const;

private:

    // for use only by the constructor of ms_invalid
    DataFileLocation ()
        :
        m_path(),
        m_line(0)
    { }

    std::string m_path;
    Uint32 m_line;
}; // end of class DataFileLocation

std::ostream &operator << (std::ostream &stream, DataFileLocation const &file_location);

} // end of namespace Xrb

#endif // !defined(_XRB_DATAFILELOCATION_HPP_)

---