SourceCode.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 "AST/SourceArea.hpp"
 
#include "CeresEngine/DataTypes.hpp"
 
#include "CeresEngine/Foundation/SmartPtr.hpp"
#include "CeresEngine/Foundation/String.hpp"
#include "CeresEngine/Foundation/Container/Vector.hpp"
 
#include <istream>
#include <memory>
 
namespace CeresEngine::ShaderCompiler {
 
    // Source code stream class.
    class SourceCode {
    protected:
        SPtr<std::istream> mStream;
        String mCurrentLine;
        Vector<String> mLines;
        SourcePosition mPosition;
 
    protected:
        SourceCode() = default;
 
    public:
        SourceCode(const SPtr<std::istream>& stream);
 
        // Returns true if this is a valid source code stream.
        [[nodiscard]] bool isValid() const;
 
        // Returns the next character from the source.
        [[nodiscard]] char next();
 
        // Fetches the line with the marker string of the specified source position.
        bool fetchLineMarker(const SourceArea& area, String& line, String& marker);
 
        // Sets the new source origin for the current source position (see "Pos()").
        void nextSourceOrigin(const String& filename, Int32 lineOffset);
 
        // Ignores the current character.
        inline void ignore() { (void)next(); }
 
        // Returns the current source position.
        [[nodiscard]] inline const SourcePosition& getPosition() const { return mPosition; }
 
        // Returns the current source line.
        [[nodiscard]] inline const String& getLine() const { return mCurrentLine; }
 
        // Returns the filename of the current source position (see SourcePosition::GetOrigin).
        [[nodiscard]] String getFilename() const;
 
    protected:
        // Returns the line (if it has already been read) by the zero-based line index.
        [[nodiscard]] String getLine(std::size_t lineIndex) const;
    };
 
    using SourceCodePtr = SPtr<SourceCode>;
 
} // namespace CeresEngine::ShaderCompiler