BranchDeclaration.h

Go to the documentation of this file.

/*
 * Souffle - A Datalog Compiler
 * Copyright (c) 2020 The Souffle Developers. All rights reserved
 * Licensed under the Universal Permissive License v 1.0 as shown at:
 * - https://opensource.org/licenses/UPL
 * - <souffle root>/licenses/SOUFFLE-UPL.txt
 */
 
/************************************************************************
 *
 * @file BranchDeclaration.h
 *
 * Defines the wrapper for a single branch in ADT declaration.
 *
 ***********************************************************************/
 
#pragma once
 
#include "ast/Attribute.h"
#include "ast/Node.h"
#include "parser/SrcLocation.h"
#include "souffle/utility/ContainerUtil.h"
#include "souffle/utility/StreamUtil.h"
#include "souffle/utility/tinyformat.h"
#include <iosfwd>
#include <string>
#include <utility>
#include <vector>
 
namespace souffle::ast {
 
/**
 * @class BranchDeclaration
 * @brief Wrapper for the single branch declaration (product type) inside ADT declaration.
 *
 * @param constructor An entity used to create a variant type. Can be though of as a name of the branch.
 * @param fields Branch arguments and their types.
 *
 * A branch declaration corresponds to a product type and forms a part of ADT declaration.
 * Currently it's required for all the branches to have unique names.
 */
class BranchDeclaration : public Node {
public:
    BranchDeclaration(std::string constructor, VecOwn<Attribute> fields, SrcLocation loc = {})
            : Node(std::move(loc)), constructor(std::move(constructor)), fields(std::move(fields)){};
 
    const std::string& getConstructor() const {
        return constructor;
    }
 
    std::vector<Attribute*> getFields() {
        return toPtrVector(fields);
    }
 
    BranchDeclaration* clone() const override {
        return new BranchDeclaration(constructor, souffle::clone(fields), getSrcLoc());
    }
 
protected:
    void print(std::ostream& os) const override {
        os << tfm::format("%s {%s}", constructor, join(fields, ", "));
    }
 
private:
    std::string constructor;
    VecOwn<Attribute> fields;
};
 
}  // namespace souffle::ast