include/comma/ast/SignatureSet.h

Go to the documentation of this file.

//===-- ast/SignatureSet.h ------------------------------------ -*- C++ -*-===//
//
// This file is distributed under the MIT license. See LICENSE.txt for details.
//
// Copyright (C) 2009, Stephen Wilson
//
//===----------------------------------------------------------------------===//
//
// The following class provides a container for the set of signatures associated
// with a particular model.  Note that is class is not a member of the Ast
// hierarchy.
//
// SignatureSet's are populated by specifying the direct signatures (those
// signatures which are explicitly named in the declaration of the associated
// model).  Recursively, the SignatureSet's associated with the direct
// signatures are then consulted to obtain the set of indirect signatures.
//
//===----------------------------------------------------------------------===//

#ifndef COMMA_AST_SIGNATURESET_HDR_GUARD
#define COMMA_AST_SIGNATURESET_HDR_GUARD

#include "comma/ast/AstBase.h"

#include "llvm/ADT/SetVector.h"

namespace comma {

class SignatureType;
class Model;

class SignatureSet {

    typedef llvm::SetVector<SignatureType*> SignatureTable;

    SignatureTable directSignatures;
    SignatureTable allSignatures;

    ModelDecl *associatedModel;

public:
    SignatureSet(ModelDecl *model)
        : associatedModel(model) { }

    bool addDirectSignature(SignatureType *signature);

    bool contains(SignatureType *signature) const {
        return allSignatures.count(signature);
    }

    bool isDirect(SignatureType *signature) const {
        return directSignatures.count(signature);
    }

    bool isIndirect(SignatureType *signature) const {
        return contains(signature) && !isDirect(signature);
    }

    unsigned numSignatures() const { return allSignatures.size(); }

    unsigned size() const { return numSignatures(); }

    unsigned numDirectSignatures() const { return directSignatures.size(); }

    unsigned numIndirectSignatures() const {
        return numSignatures() - numDirectSignatures();
    }

    // Returns the model which owns this set.
    const ModelDecl *getAssociatedModel() const { return associatedModel; }
    ModelDecl *getAssociatedModel() { return associatedModel; }

    typedef SignatureTable::iterator iterator;
    typedef SignatureTable::const_iterator const_iterator;

    iterator beginDirect() { return directSignatures.begin(); }
    iterator endDirect()   { return directSignatures.end(); }

    const_iterator beginDirect() const { return directSignatures.begin(); }
    const_iterator endDirect()   const { return directSignatures.end(); }

    iterator begin() { return allSignatures.begin(); }
    iterator end()   { return allSignatures.end(); }

    const_iterator begin() const { return allSignatures.begin(); }
    const_iterator end()   const { return allSignatures.end(); }
};

} // End comma namespace

#endif

---