SourcePosition.hpp

Go to the documentation of this file.

//
//  CeresEngine - A game development framework
//
//  Created by Rogiel Sulzbach.
//  Copyright (c) 2018-2022 Rogiel Sulzbach. All rights reserved.
//
 
#pragma once
 
#include "CeresEngine/DataTypes.hpp"
 
#include "CeresEngine/Foundation/SmartPtr.hpp"
#include "CeresEngine/Foundation/String.hpp"
 
#include <memory>
 
namespace CeresEngine::ShaderCompiler {
 
    struct SourceOrigin {
        String filename;
        Int32 lineOffset;
    };
 
    using SourceOriginPtr = SPtr<SourceOrigin>;
 
    // This class stores the position in a source code file.
    class SourcePosition {
    private:
        UInt32 mRow = 0;
        UInt32 mColumn = 0;
 
        SourceOriginPtr mOrigin;
 
    public:
        // Invalid source position.
        static const SourcePosition ignore;
 
        SourcePosition() = default;
        SourcePosition(UInt32 row, UInt32 column, const SourceOriginPtr& origin = nullptr);
 
    public:
        // Returns the source position as string in the format "Row:Column", e.g. "75:10".
        [[nodiscard]] String toString(bool printFilename = true) const;
 
        // Increases the row by 1 and sets the column to 0.
        void increaseRow();
 
        // Increases the column by 1.
        void increaseColumn();
 
        // Returns true if this is a valid source position. False if row and column are 0.
        [[nodiscard]] bool isValid() const;
 
        // Reset the source position to (0:0).
        void reset();
 
        // Makes a strict-weak-order comparison between the two source positions.
        bool operator<(const SourcePosition& rhs) const;
 
        // Returns the row of the source position, beginning with 1.
        [[nodiscard]] inline UInt32 getRow() const { return mRow; }
 
        // Returns the column of the source position, beginning with 1.
        [[nodiscard]] inline UInt32 getColumn() const { return mColumn; }
 
        // Sets the new source origin.
        inline void setOrigin(const SourceOriginPtr& origin) { mOrigin = origin; }
 
        // Returns the current origin.
        [[nodiscard]] inline const SourceOrigin* getOrigin() const { return mOrigin.get(); }
 
        // Equivalent to a call to 'IsValid()'.
        inline explicit operator bool() const { return isValid(); }
    };
 
} // namespace CeresEngine::ShaderCompiler