SourceArea.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 "SourcePosition.hpp"
 
#include "CeresEngine/DataTypes.hpp"
 
namespace CeresEngine::ShaderCompiler {
 
    class Token;
    struct AST;
 
    // Source area structure with position and length.
    class SourceArea {
    public:
        // Invalid source area.
        static const SourceArea ignore;
 
        SourceArea() = default;
        SourceArea(const SourceArea&) = default;
        SourceArea& operator=(const SourceArea&) = default;
 
        SourceArea(const SourcePosition& pos, UInt32 length, UInt32 offset = 0);
 
        // Returns ture if this is a valid source area. False if the position is invalid or the length is 0.
        [[nodiscard]] bool isValid() const;
 
        // Updates the source area from the specified other area.
        void update(const SourceArea& area);
 
        // Updates the source area length from the specified identifier.
        void update(const String& lengthFromIdent);
 
        // Updates the source area from the specified token.
        void update(const Token& token);
 
        // Updates the source area from the specified AST node.
        void update(const AST& ast);
 
        // Sets the new offset of the marker pointer.
        void offset(UInt32 offset);
 
        // Sets the new offset of the marker pointer by a source position.
        void offset(const SourcePosition& pos);
 
        // Returns the offset of the marker pointer (e.g. "^~~~") clamped to the range [0, length).
        [[nodiscard]] UInt32 getOffset() const;
 
        // Returns the start position of the source area.
        [[nodiscard]] inline const SourcePosition& getPosition() const { return mPos; }
 
        // Returns the length of the source area.
        [[nodiscard]] inline UInt32 getLength() const { return mLength; }
 
    private:
        SourcePosition mPos;
        UInt32 mLength = 0;
        UInt32 mOffset = 0;
    };
 
} // namespace CeresEngine::ShaderCompiler