UT_SourceLocation.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        UT_SourceLocation.h ( VEX Library, C++)
 *
 * COMMENTS:
 *   A structure to keep track of source locations.
 */

#ifndef __UT_SourceLocation__
#define __UT_SourceLocation__

#include "UT_API.h"
#include "UT_StringHolder.h"

class UT_API UT_SourceLocation
{
public:
    UT_SourceLocation(
            const UT_StringHolder &source = UT_StringHolder::theEmptyString,
            int line = 0, int column_start = 0, int column_end = 0)
        : mySource(source),
          myLine(line),
          myColumnStart(column_start),
          myColumnEnd(column_end)
    {
    }

    int64 getMemoryUsage(bool inclusive) const
    {
        int64 mem = inclusive ? sizeof(*this) : 0;
        mem += mySource.getMemoryUsage(false);
        return mem;
    }

    bool operator==(const UT_SourceLocation &other) const
    {
        return (mySource == other.mySource &&
                myLine == other.myLine &&
                myColumnStart == other.myColumnStart &&
                myColumnEnd == other.myColumnEnd);
    }
    bool operator!=(const UT_SourceLocation &other) const
    { return !(*this == other); }

    const UT_StringHolder&source() const
                         { return mySource; }
    void                 setSource(const UT_StringHolder &source)
                         { mySource = source; }
    int                  line() const
                         { return myLine; }
    void                 setLine(int line)
                         { myLine = line; }
    int                  columnStart() const
                         { return myColumnStart; }
    void                 setColumnStart(int col)
                         { myColumnStart = col; }
    int                  columnEnd() const
                         { return myColumnEnd; }
    void                 setColumnEnd(int col)
                         { myColumnEnd = col; }

private:
    UT_StringHolder      mySource;
    int                  myLine;
    int                  myColumnStart, myColumnEnd;
};

UT_API std::ostream &
operator<<(std::ostream &os, const UT_SourceLocation &loc);

#endif // __UT_SourceLocation__