50 lines
2.2 KiB
C++
50 lines
2.2 KiB
C++
/* -*- C++ -*-
|
|
* Serene programming language.
|
|
*
|
|
* Copyright (c) 2019-2021 Sameer Rahmani <lxsameer@gnu.org>
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
* SOFTWARE.
|
|
*/
|
|
|
|
#ifndef READER_SEMANTICS_H
|
|
#define READER_SEMANTICS_H
|
|
|
|
#include "serene/context.h"
|
|
#include "serene/errors/error.h"
|
|
#include "serene/exprs/expression.h"
|
|
|
|
namespace serene::reader {
|
|
using AnalyzeResult = Result<exprs::Ast, std::vector<exprs::ErrorPtr>>;
|
|
/// The entry point to the Semantic analysis phase. It calls the `analyze`
|
|
/// method of each node in the given AST and creates a new AST that contains a
|
|
/// more comprehensive set of nodes in a semantically correct AST. If the
|
|
/// `analyze` method of a node return a `nullptr` value as the `success` result
|
|
/// (Checkout the `Result` type in `utils.h`) then the original node will be
|
|
/// used instead. Also please note that in **Serene** Semantic errors
|
|
/// represented as AST nodes as well. So you should expect an `analyze` method
|
|
/// of a node to return a `Result<node>::Success(Error...)` in case of a
|
|
/// semantic error.
|
|
///
|
|
/// \param ctx The semantic analysis context
|
|
/// \param inputAst The raw AST to analyze and possibly rewrite.
|
|
AnalyzeResult analyze(serene::SereneContext &ctx, exprs::Ast &tree);
|
|
}; // namespace serene::reader
|
|
|
|
#endif
|