[2bb4a01] | 1 | // |
---|
| 2 | // Cforall Version 1.0.0 Copyright (C) 2015 University of Waterloo |
---|
| 3 | // |
---|
| 4 | // The contents of this file are covered under the licence agreement in the |
---|
| 5 | // file "LICENCE" distributed with Cforall. |
---|
| 6 | // |
---|
| 7 | // Decl.hpp -- |
---|
| 8 | // |
---|
| 9 | // Author : Aaron B. Moss |
---|
| 10 | // Created On : Thu May 9 10:00:00 2019 |
---|
| 11 | // Last Modified By : Aaron B. Moss |
---|
| 12 | // Last Modified On : Thu May 9 10:00:00 2019 |
---|
| 13 | // Update Count : 1 |
---|
| 14 | // |
---|
| 15 | |
---|
| 16 | #pragma once |
---|
| 17 | |
---|
[d76c588] | 18 | #include <iosfwd> |
---|
[a300e4a] | 19 | #include <string> // for string, to_string |
---|
| 20 | #include <unordered_map> |
---|
[2bb4a01] | 21 | #include <vector> |
---|
| 22 | |
---|
[a300e4a] | 23 | #include "FunctionSpec.hpp" |
---|
[2bb4a01] | 24 | #include "Fwd.hpp" // for UniqueId |
---|
| 25 | #include "LinkageSpec.hpp" |
---|
| 26 | #include "Node.hpp" // for ptr, readonly |
---|
| 27 | #include "ParseNode.hpp" |
---|
| 28 | #include "StorageClasses.hpp" |
---|
[9e1d485] | 29 | #include "TypeVar.hpp" |
---|
[2bb4a01] | 30 | #include "Visitor.hpp" |
---|
[a300e4a] | 31 | #include "Parser/ParseNode.h" // for DeclarationNode::Aggregate |
---|
[2bb4a01] | 32 | |
---|
[f3cc5b6] | 33 | // Must be included in *all* AST classes; should be #undef'd at the end of the file |
---|
[41b24c8] | 34 | #define MUTATE_FRIEND template<typename node_t> friend node_t * mutate(const node_t * node); |
---|
[f3cc5b6] | 35 | |
---|
[2bb4a01] | 36 | namespace ast { |
---|
[a300e4a] | 37 | |
---|
[2bb4a01] | 38 | /// Base declaration class |
---|
| 39 | class Decl : public ParseNode { |
---|
| 40 | public: |
---|
| 41 | std::string name; |
---|
| 42 | Storage::Classes storage; |
---|
| 43 | Linkage::Spec linkage; |
---|
| 44 | UniqueId uniqueId = 0; |
---|
| 45 | bool extension = false; |
---|
| 46 | |
---|
[14cebb7a] | 47 | Decl( const CodeLocation& loc, const std::string& name, Storage::Classes storage, |
---|
[2bb4a01] | 48 | Linkage::Spec linkage ) |
---|
| 49 | : ParseNode( loc ), name( name ), storage( storage ), linkage( linkage ) {} |
---|
| 50 | |
---|
| 51 | Decl* set_extension( bool ex ) { extension = ex; return this; } |
---|
| 52 | |
---|
| 53 | /// Ensures this node has a unique ID |
---|
| 54 | void fixUniqueId(); |
---|
| 55 | /// Get canonical declaration for unique ID |
---|
| 56 | static readonly<Decl> fromId( UniqueId id ); |
---|
| 57 | |
---|
[23f99e1] | 58 | const Decl * accept( Visitor & v ) const override = 0; |
---|
[2bb4a01] | 59 | private: |
---|
[23f99e1] | 60 | Decl * clone() const override = 0; |
---|
[f3cc5b6] | 61 | MUTATE_FRIEND |
---|
[2bb4a01] | 62 | }; |
---|
| 63 | |
---|
| 64 | /// Typed declaration base class |
---|
| 65 | class DeclWithType : public Decl { |
---|
| 66 | public: |
---|
| 67 | /// Represents the type with all types and typedefs expanded. |
---|
| 68 | /// This field is generated by SymTab::Validate::Pass2 |
---|
| 69 | std::string mangleName; |
---|
[14cebb7a] | 70 | /// Stores the scope level at which the variable was declared. |
---|
[2bb4a01] | 71 | /// Used to access shadowed identifiers. |
---|
| 72 | int scopeLevel = 0; |
---|
| 73 | |
---|
| 74 | std::vector<ptr<Attribute>> attributes; |
---|
[a300e4a] | 75 | Function::Specs funcSpec; |
---|
[2bb4a01] | 76 | ptr<Expr> asmName; |
---|
| 77 | bool isDeleted = false; |
---|
| 78 | |
---|
[14cebb7a] | 79 | DeclWithType( const CodeLocation& loc, const std::string& name, Storage::Classes storage, |
---|
[2bb4a01] | 80 | Linkage::Spec linkage, std::vector<ptr<Attribute>>&& attrs, Function::Specs fs ) |
---|
[14cebb7a] | 81 | : Decl( loc, name, storage, linkage ), mangleName(), attributes( std::move(attrs) ), |
---|
[a300e4a] | 82 | funcSpec(fs), asmName() {} |
---|
[14cebb7a] | 83 | |
---|
[a300e4a] | 84 | std::string scopedMangleName() const { return mangleName + "_" + std::to_string(scopeLevel); } |
---|
| 85 | |
---|
| 86 | /// Get type of this declaration. May be generated by subclass |
---|
[6d51bd7] | 87 | virtual const Type * get_type() const = 0; |
---|
[a300e4a] | 88 | /// Set type of this declaration. May be verified by subclass |
---|
[23f99e1] | 89 | virtual void set_type(Type *) = 0; |
---|
[a300e4a] | 90 | |
---|
[23f99e1] | 91 | const DeclWithType * accept( Visitor & v ) const override = 0; |
---|
[a300e4a] | 92 | private: |
---|
[23f99e1] | 93 | DeclWithType * clone() const override = 0; |
---|
[f3cc5b6] | 94 | MUTATE_FRIEND |
---|
[a300e4a] | 95 | }; |
---|
| 96 | |
---|
[77a3f41] | 97 | /// Object declaration `Foo foo = 42;` |
---|
| 98 | class ObjectDecl final : public DeclWithType { |
---|
| 99 | public: |
---|
| 100 | ptr<Type> type; |
---|
| 101 | ptr<Init> init; |
---|
| 102 | ptr<Expr> bitfieldWidth; |
---|
| 103 | |
---|
[f474e91] | 104 | ObjectDecl( const CodeLocation & loc, const std::string & name, const Type * type, |
---|
[2a8f0c1] | 105 | const Init * init = nullptr, Storage::Classes storage = {}, |
---|
| 106 | Linkage::Spec linkage = Linkage::C, const Expr * bitWd = nullptr, |
---|
| 107 | std::vector< ptr<Attribute> > && attrs = {}, Function::Specs fs = {} ) |
---|
[14cebb7a] | 108 | : DeclWithType( loc, name, storage, linkage, std::move(attrs), fs ), type( type ), |
---|
[77a3f41] | 109 | init( init ), bitfieldWidth( bitWd ) {} |
---|
[14cebb7a] | 110 | |
---|
[77a3f41] | 111 | const Type* get_type() const override { return type; } |
---|
[23f99e1] | 112 | void set_type( Type * ty ) override { type = ty; } |
---|
[77a3f41] | 113 | |
---|
[23f99e1] | 114 | const DeclWithType * accept( Visitor& v ) const override { return v.visit( this ); } |
---|
[77a3f41] | 115 | private: |
---|
[23f99e1] | 116 | ObjectDecl * clone() const override { return new ObjectDecl{ *this }; } |
---|
[f3cc5b6] | 117 | MUTATE_FRIEND |
---|
[23f99e1] | 118 | }; |
---|
| 119 | |
---|
[8a5530c] | 120 | /// Object declaration `int foo()` |
---|
[23f99e1] | 121 | class FunctionDecl : public DeclWithType { |
---|
| 122 | public: |
---|
| 123 | ptr<FunctionType> type; |
---|
| 124 | ptr<CompoundStmt> stmts; |
---|
[d76c588] | 125 | std::vector< ptr<Expr> > withExprs; |
---|
[23f99e1] | 126 | |
---|
| 127 | FunctionDecl( const CodeLocation & loc, const std::string &name, FunctionType * type, |
---|
| 128 | CompoundStmt * stmts, Storage::Classes storage = {}, Linkage::Spec linkage = Linkage::C, |
---|
| 129 | std::vector<ptr<Attribute>>&& attrs = {}, Function::Specs fs = {}) |
---|
| 130 | : DeclWithType( loc, name, storage, linkage, std::move(attrs), fs ), type( type ), |
---|
| 131 | stmts( stmts ) {} |
---|
| 132 | |
---|
[8a5530c] | 133 | const Type * get_type() const override; |
---|
| 134 | void set_type(Type * t) override; |
---|
[23f99e1] | 135 | |
---|
| 136 | bool has_body() const { return stmts; } |
---|
| 137 | |
---|
| 138 | const DeclWithType * accept( Visitor &v ) const override { return v.visit( this ); } |
---|
| 139 | private: |
---|
| 140 | FunctionDecl * clone() const override { return new FunctionDecl( *this ); } |
---|
[f3cc5b6] | 141 | MUTATE_FRIEND |
---|
[77a3f41] | 142 | }; |
---|
| 143 | |
---|
[360b2e13] | 144 | /// Base class for named type aliases |
---|
| 145 | class NamedTypeDecl : public Decl { |
---|
| 146 | public: |
---|
| 147 | ptr<Type> base; |
---|
[54e41b3] | 148 | std::vector<ptr<TypeDecl>> params; |
---|
[360b2e13] | 149 | std::vector<ptr<DeclWithType>> assertions; |
---|
| 150 | |
---|
[e0115286] | 151 | NamedTypeDecl( const CodeLocation& loc, const std::string& name, Storage::Classes storage, |
---|
[360b2e13] | 152 | Type* b, Linkage::Spec spec = Linkage::Cforall ) |
---|
[54e41b3] | 153 | : Decl( loc, name, storage, spec ), base( b ), params(), assertions() {} |
---|
[360b2e13] | 154 | |
---|
| 155 | /// Produces a name for the kind of alias |
---|
| 156 | virtual std::string typeString() const = 0; |
---|
| 157 | |
---|
| 158 | private: |
---|
| 159 | NamedTypeDecl* clone() const override = 0; |
---|
[f3cc5b6] | 160 | MUTATE_FRIEND |
---|
[360b2e13] | 161 | }; |
---|
| 162 | |
---|
| 163 | /// Cforall type variable: `dtype T` |
---|
| 164 | class TypeDecl final : public NamedTypeDecl { |
---|
| 165 | public: |
---|
[9e1d485] | 166 | TypeVar::Kind kind; |
---|
[360b2e13] | 167 | bool sized; |
---|
| 168 | ptr<Type> init; |
---|
| 169 | |
---|
| 170 | /// Data extracted from a type decl |
---|
| 171 | struct Data { |
---|
[9e1d485] | 172 | TypeVar::Kind kind; |
---|
[360b2e13] | 173 | bool isComplete; |
---|
| 174 | |
---|
[9e1d485] | 175 | Data() : kind( (TypeVar::Kind)-1 ), isComplete( false ) {} |
---|
[d76c588] | 176 | Data( const TypeDecl * d ) : kind( d->kind ), isComplete( d->sized ) {} |
---|
[9e1d485] | 177 | Data( TypeVar::Kind k, bool c ) : kind( k ), isComplete( c ) {} |
---|
[d76c588] | 178 | Data( const Data & d1, const Data & d2 ) |
---|
[360b2e13] | 179 | : kind( d1.kind ), isComplete( d1.isComplete || d2.isComplete ) {} |
---|
| 180 | |
---|
[d76c588] | 181 | bool operator== ( const Data & o ) const { |
---|
[360b2e13] | 182 | return kind == o.kind && isComplete == o.isComplete; |
---|
| 183 | } |
---|
[d76c588] | 184 | bool operator!= ( const Data & o ) const { return !(*this == o); } |
---|
[360b2e13] | 185 | }; |
---|
| 186 | |
---|
[e0115286] | 187 | TypeDecl( const CodeLocation& loc, const std::string& name, Storage::Classes storage, Type* b, |
---|
[9e1d485] | 188 | TypeVar::Kind k, bool s, Type* i = nullptr ) |
---|
[8a5530c] | 189 | : NamedTypeDecl( loc, name, storage, b ), kind( k ), sized( k == TypeVar::Ttype || s ), |
---|
[9e1d485] | 190 | init( i ) {} |
---|
[360b2e13] | 191 | |
---|
| 192 | std::string typeString() const override; |
---|
| 193 | /// Produces a name for generated code |
---|
| 194 | std::string genTypeString() const; |
---|
| 195 | |
---|
[9e1d485] | 196 | /// convenience accessor to match Type::isComplete() |
---|
| 197 | bool isComplete() { return sized; } |
---|
| 198 | |
---|
[23f99e1] | 199 | const Decl * accept( Visitor & v ) const override { return v.visit( this ); } |
---|
[360b2e13] | 200 | private: |
---|
[23f99e1] | 201 | TypeDecl * clone() const override { return new TypeDecl{ *this }; } |
---|
[f3cc5b6] | 202 | MUTATE_FRIEND |
---|
[360b2e13] | 203 | }; |
---|
| 204 | |
---|
[d76c588] | 205 | std::ostream & operator<< ( std::ostream &, const TypeDecl::Data & ); |
---|
| 206 | |
---|
[360b2e13] | 207 | /// C-style typedef `typedef Foo Bar` |
---|
| 208 | class TypedefDecl final : public NamedTypeDecl { |
---|
| 209 | public: |
---|
[e0115286] | 210 | TypedefDecl( const CodeLocation& loc, const std::string& name, Storage::Classes storage, |
---|
[360b2e13] | 211 | Type* b, Linkage::Spec spec = Linkage::Cforall ) |
---|
| 212 | : NamedTypeDecl( loc, name, storage, b, spec ) {} |
---|
| 213 | |
---|
| 214 | std::string typeString() const override { return "typedef"; } |
---|
| 215 | |
---|
[23f99e1] | 216 | const Decl * accept( Visitor & v ) const override { return v.visit( this ); } |
---|
[360b2e13] | 217 | private: |
---|
[23f99e1] | 218 | TypedefDecl * clone() const override { return new TypedefDecl{ *this }; } |
---|
[f3cc5b6] | 219 | MUTATE_FRIEND |
---|
[360b2e13] | 220 | }; |
---|
| 221 | |
---|
[a300e4a] | 222 | /// Aggregate type declaration base class |
---|
| 223 | class AggregateDecl : public Decl { |
---|
| 224 | public: |
---|
| 225 | std::vector<ptr<Decl>> members; |
---|
[54e41b3] | 226 | std::vector<ptr<TypeDecl>> params; |
---|
[a300e4a] | 227 | std::vector<ptr<Attribute>> attributes; |
---|
| 228 | bool body = false; |
---|
| 229 | readonly<AggregateDecl> parent = {}; |
---|
| 230 | |
---|
[14cebb7a] | 231 | AggregateDecl( const CodeLocation& loc, const std::string& name, |
---|
[a300e4a] | 232 | std::vector<ptr<Attribute>>&& attrs = {}, Linkage::Spec linkage = Linkage::Cforall ) |
---|
[54e41b3] | 233 | : Decl( loc, name, Storage::Classes{}, linkage ), members(), params(), |
---|
[a300e4a] | 234 | attributes( std::move(attrs) ) {} |
---|
[14cebb7a] | 235 | |
---|
[a300e4a] | 236 | AggregateDecl* set_body( bool b ) { body = b; return this; } |
---|
| 237 | |
---|
[ed3935da] | 238 | /// Produces a name for the kind of aggregate |
---|
| 239 | virtual std::string typeString() const = 0; |
---|
| 240 | |
---|
[f3cc5b6] | 241 | private: |
---|
| 242 | AggregateDecl * clone() const override = 0; |
---|
| 243 | MUTATE_FRIEND |
---|
[a300e4a] | 244 | }; |
---|
| 245 | |
---|
| 246 | /// struct declaration `struct Foo { ... };` |
---|
| 247 | class StructDecl final : public AggregateDecl { |
---|
| 248 | public: |
---|
| 249 | DeclarationNode::Aggregate kind; |
---|
| 250 | |
---|
[14cebb7a] | 251 | StructDecl( const CodeLocation& loc, const std::string& name, |
---|
| 252 | DeclarationNode::Aggregate kind = DeclarationNode::Struct, |
---|
[a300e4a] | 253 | std::vector<ptr<Attribute>>&& attrs = {}, Linkage::Spec linkage = Linkage::Cforall ) |
---|
| 254 | : AggregateDecl( loc, name, std::move(attrs), linkage ), kind( kind ) {} |
---|
| 255 | |
---|
| 256 | bool is_coroutine() { return kind == DeclarationNode::Coroutine; } |
---|
| 257 | bool is_monitor() { return kind == DeclarationNode::Monitor; } |
---|
| 258 | bool is_thread() { return kind == DeclarationNode::Thread; } |
---|
| 259 | |
---|
[23f99e1] | 260 | const Decl * accept( Visitor & v ) const override { return v.visit( this ); } |
---|
[ed3935da] | 261 | |
---|
| 262 | std::string typeString() const override { return "struct"; } |
---|
| 263 | |
---|
[a300e4a] | 264 | private: |
---|
[23f99e1] | 265 | StructDecl * clone() const override { return new StructDecl{ *this }; } |
---|
[f3cc5b6] | 266 | MUTATE_FRIEND |
---|
[a300e4a] | 267 | }; |
---|
| 268 | |
---|
| 269 | /// union declaration `union Foo { ... };` |
---|
| 270 | class UnionDecl final : public AggregateDecl { |
---|
| 271 | public: |
---|
[14cebb7a] | 272 | UnionDecl( const CodeLocation& loc, const std::string& name, |
---|
[a300e4a] | 273 | std::vector<ptr<Attribute>>&& attrs = {}, Linkage::Spec linkage = Linkage::Cforall ) |
---|
| 274 | : AggregateDecl( loc, name, std::move(attrs), linkage ) {} |
---|
| 275 | |
---|
[23f99e1] | 276 | const Decl * accept( Visitor& v ) const override { return v.visit( this ); } |
---|
[ed3935da] | 277 | |
---|
| 278 | std::string typeString() const override { return "union"; } |
---|
| 279 | |
---|
[a300e4a] | 280 | private: |
---|
[23f99e1] | 281 | UnionDecl * clone() const override { return new UnionDecl{ *this }; } |
---|
[f3cc5b6] | 282 | MUTATE_FRIEND |
---|
[a300e4a] | 283 | }; |
---|
| 284 | |
---|
| 285 | /// enum declaration `enum Foo { ... };` |
---|
| 286 | class EnumDecl final : public AggregateDecl { |
---|
| 287 | public: |
---|
[14cebb7a] | 288 | EnumDecl( const CodeLocation& loc, const std::string& name, |
---|
[a300e4a] | 289 | std::vector<ptr<Attribute>>&& attrs = {}, Linkage::Spec linkage = Linkage::Cforall ) |
---|
| 290 | : AggregateDecl( loc, name, std::move(attrs), linkage ), enumValues() {} |
---|
| 291 | |
---|
| 292 | /// gets the integer value for this enumerator, returning true iff value found |
---|
[9d6e7fa9] | 293 | bool valueOf( const Decl * enumerator, long long& value ) const; |
---|
[a300e4a] | 294 | |
---|
[23f99e1] | 295 | const Decl * accept( Visitor & v ) const override { return v.visit( this ); } |
---|
[ed3935da] | 296 | |
---|
| 297 | std::string typeString() const override { return "enum"; } |
---|
| 298 | |
---|
[a300e4a] | 299 | private: |
---|
[23f99e1] | 300 | EnumDecl * clone() const override { return new EnumDecl{ *this }; } |
---|
[f3cc5b6] | 301 | MUTATE_FRIEND |
---|
[a300e4a] | 302 | |
---|
| 303 | /// Map from names to enumerator values; kept private for lazy initialization |
---|
| 304 | mutable std::unordered_map< std::string, long long > enumValues; |
---|
| 305 | }; |
---|
| 306 | |
---|
| 307 | /// trait declaration `trait Foo( ... ) { ... };` |
---|
| 308 | class TraitDecl final : public AggregateDecl { |
---|
| 309 | public: |
---|
[14cebb7a] | 310 | TraitDecl( const CodeLocation& loc, const std::string& name, |
---|
[a300e4a] | 311 | std::vector<ptr<Attribute>>&& attrs = {}, Linkage::Spec linkage = Linkage::Cforall ) |
---|
| 312 | : AggregateDecl( loc, name, std::move(attrs), linkage ) {} |
---|
| 313 | |
---|
[23f99e1] | 314 | const Decl * accept( Visitor & v ) const override { return v.visit( this ); } |
---|
[ed3935da] | 315 | |
---|
| 316 | std::string typeString() const override { return "trait"; } |
---|
| 317 | |
---|
[a300e4a] | 318 | private: |
---|
[23f99e1] | 319 | TraitDecl * clone() const override { return new TraitDecl{ *this }; } |
---|
[f3cc5b6] | 320 | MUTATE_FRIEND |
---|
[2bb4a01] | 321 | }; |
---|
| 322 | |
---|
[23f99e1] | 323 | class AsmDecl : public Decl { |
---|
| 324 | public: |
---|
| 325 | ptr<AsmStmt> stmt; |
---|
| 326 | |
---|
| 327 | AsmDecl( const CodeLocation & loc, AsmStmt *stmt ) |
---|
| 328 | : Decl( loc, "", {}, {} ), stmt(stmt) {} |
---|
| 329 | |
---|
| 330 | const AsmDecl * accept( Visitor &v ) const override { return v.visit( this ); } |
---|
| 331 | private: |
---|
| 332 | AsmDecl *clone() const override { return new AsmDecl( *this ); } |
---|
[f3cc5b6] | 333 | MUTATE_FRIEND |
---|
[23f99e1] | 334 | }; |
---|
| 335 | |
---|
| 336 | class StaticAssertDecl : public Decl { |
---|
| 337 | public: |
---|
[112fe04] | 338 | ptr<Expr> cond; |
---|
[23f99e1] | 339 | ptr<ConstantExpr> msg; // string literal |
---|
| 340 | |
---|
| 341 | StaticAssertDecl( const CodeLocation & loc, const Expr * condition, const ConstantExpr * msg ) |
---|
[112fe04] | 342 | : Decl( loc, "", {}, {} ), cond( condition ), msg( msg ) {} |
---|
[23f99e1] | 343 | |
---|
| 344 | const StaticAssertDecl * accept( Visitor &v ) const override { return v.visit( this ); } |
---|
| 345 | private: |
---|
| 346 | StaticAssertDecl * clone() const override { return new StaticAssertDecl( *this ); } |
---|
[f3cc5b6] | 347 | MUTATE_FRIEND |
---|
[23f99e1] | 348 | }; |
---|
[e0115286] | 349 | |
---|
[2bb4a01] | 350 | } |
---|
| 351 | |
---|
[f3cc5b6] | 352 | #undef MUTATE_FRIEND |
---|
| 353 | |
---|
[2bb4a01] | 354 | // Local Variables: // |
---|
| 355 | // tab-width: 4 // |
---|
| 356 | // mode: c++ // |
---|
| 357 | // compile-command: "make install" // |
---|
| 358 | // End: // |
---|