source: src/Parser/ParseNode.h@ 12a1013

ADT ast-experimental enum forall-pointer-decay jacob/cs343-translation new-ast-unique-expr pthread-emulation qualifiedEnum
Last change on this file since 12a1013 was 6e50a6b, checked in by Michael Brooks <mlbrooks@…>, 4 years ago

Implementing language-provided syntax for (array) dimensions.

Former z(i) and Z(N) macros are eliminated.
  • Property mode set to 100644
File size: 20.6 KB
Line 
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// ParseNode.h --
8//
9// Author : Rodolfo G. Esteves
10// Created On : Sat May 16 13:28:16 2015
11// Last Modified By : Peter A. Buhr
12// Last Modified On : Fri Mar 12 15:19:04 2021
13// Update Count : 897
14//
15
16#pragma once
17
18#include <algorithm> // for move
19#include <cassert> // for assert, assertf
20#include <iosfwd> // for ostream
21#include <iterator> // for back_insert_iterator
22#include <list> // for list
23#include <memory> // for unique_ptr, pointer_traits
24#include <string> // for string
25
26#include "Common/CodeLocation.h" // for CodeLocation
27#include "Common/SemanticError.h" // for SemanticError
28#include "Common/UniqueName.h" // for UniqueName
29#include "Common/utility.h" // for maybeClone, maybeBuild
30#include "SynTree/LinkageSpec.h" // for Spec
31#include "SynTree/Declaration.h" // for Aggregate
32#include "SynTree/Expression.h" // for Expression, ConstantExpr (ptr only)
33#include "SynTree/Label.h" // for Label
34#include "SynTree/Statement.h" // for Statement, BranchStmt, BranchStmt:...
35#include "SynTree/Type.h" // for Type, Type::FuncSpecifiers, Type::...
36
37class Attribute;
38class Declaration;
39struct DeclarationNode;
40class DeclarationWithType;
41class Initializer;
42class ExpressionNode;
43struct StatementNode;
44
45//##############################################################################
46
47typedef CodeLocation YYLTYPE;
48#define YYLTYPE_IS_DECLARED 1 /* alert the parser that we have our own definition */
49
50extern YYLTYPE yylloc;
51
52class ParseNode {
53 public:
54 ParseNode() {};
55 virtual ~ParseNode() { delete next; delete name; };
56 virtual ParseNode * clone() const = 0;
57
58 ParseNode * get_next() const { return next; }
59 ParseNode * set_next( ParseNode * newlink ) { next = newlink; return this; }
60
61 ParseNode * get_last() {
62 ParseNode * current;
63 for ( current = this; current->get_next() != nullptr; current = current->get_next() );
64 return current;
65 }
66 ParseNode * set_last( ParseNode * newlast ) {
67 if ( newlast != nullptr ) get_last()->set_next( newlast );
68 return this;
69 }
70
71 virtual void print( __attribute__((unused)) std::ostream & os, __attribute__((unused)) int indent = 0 ) const {}
72 virtual void printList( std::ostream & os, int indent = 0 ) const {
73 print( os, indent );
74 if ( next ) next->print( os, indent );
75 }
76
77 static int indent_by;
78
79 ParseNode * next = nullptr;
80 const std::string * name = nullptr;
81 CodeLocation location = yylloc;
82}; // ParseNode
83
84//##############################################################################
85
86class InitializerNode : public ParseNode {
87 public:
88 InitializerNode( ExpressionNode *, bool aggrp = false, ExpressionNode * des = nullptr );
89 InitializerNode( InitializerNode *, bool aggrp = false, ExpressionNode * des = nullptr );
90 InitializerNode( bool isDelete );
91 ~InitializerNode();
92 virtual InitializerNode * clone() const { assert( false ); return nullptr; }
93
94 ExpressionNode * get_expression() const { return expr; }
95
96 InitializerNode * set_designators( ExpressionNode * des ) { designator = des; return this; }
97 ExpressionNode * get_designators() const { return designator; }
98
99 InitializerNode * set_maybeConstructed( bool value ) { maybeConstructed = value; return this; }
100 bool get_maybeConstructed() const { return maybeConstructed; }
101
102 bool get_isDelete() const { return isDelete; }
103
104 InitializerNode * next_init() const { return kids; }
105
106 void print( std::ostream & os, int indent = 0 ) const;
107 void printOneLine( std::ostream & ) const;
108
109 virtual Initializer * build() const;
110 private:
111 ExpressionNode * expr;
112 bool aggregate;
113 ExpressionNode * designator; // may be list
114 InitializerNode * kids;
115 bool maybeConstructed;
116 bool isDelete;
117}; // InitializerNode
118
119//##############################################################################
120
121class ExpressionNode final : public ParseNode {
122 public:
123 ExpressionNode( Expression * expr = nullptr ) : expr( expr ) {}
124 virtual ~ExpressionNode() {}
125 virtual ExpressionNode * clone() const override { return expr ? static_cast<ExpressionNode*>((new ExpressionNode( expr->clone() ))->set_next( maybeClone( get_next() ) )) : nullptr; }
126
127 bool get_extension() const { return extension; }
128 ExpressionNode * set_extension( bool exten ) { extension = exten; return this; }
129
130 virtual void print( std::ostream & os, __attribute__((unused)) int indent = 0 ) const override {
131 os << expr.get();
132 }
133 void printOneLine( __attribute__((unused)) std::ostream & os, __attribute__((unused)) int indent = 0 ) const {}
134
135 template<typename T>
136 bool isExpressionType() const { return nullptr != dynamic_cast<T>(expr.get()); }
137
138 Expression * build() const { return const_cast<ExpressionNode *>(this)->expr.release(); }
139
140 std::unique_ptr<Expression> expr; // public because of lifetime implications
141 private:
142 bool extension = false;
143}; // ExpressionNode
144
145template< typename T >
146struct maybeBuild_t< Expression, T > {
147 static inline Expression * doit( const T * orig ) {
148 if ( orig ) {
149 Expression * p = orig->build();
150 p->set_extension( orig->get_extension() );
151 p->location = orig->location;
152 return p;
153 } else {
154 return nullptr;
155 } // if
156 }
157};
158
159// Must harmonize with OperName.
160enum class OperKinds {
161 // diadic
162 SizeOf, AlignOf, OffsetOf, Plus, Minus, Exp, Mul, Div, Mod, Or, And,
163 BitOr, BitAnd, Xor, Cast, LShift, RShift, LThan, GThan, LEThan, GEThan, Eq, Neq,
164 Assign, AtAssn, ExpAssn, MulAssn, DivAssn, ModAssn, PlusAssn, MinusAssn, LSAssn, RSAssn, AndAssn, ERAssn, OrAssn,
165 Index, Range,
166 // monadic
167 UnPlus, UnMinus, AddressOf, PointTo, Neg, BitNeg, Incr, IncrPost, Decr, DecrPost,
168 Ctor, Dtor,
169}; // OperKinds
170
171struct LabelNode {
172 std::list< Label > labels;
173};
174
175Expression * build_constantInteger( std::string & str ); // these 4 routines modify the string
176Expression * build_constantFloat( std::string & str );
177Expression * build_constantChar( std::string & str );
178Expression * build_constantStr( std::string & str );
179Expression * build_field_name_FLOATING_FRACTIONconstant( const std::string & str );
180Expression * build_field_name_FLOATING_DECIMALconstant( const std::string & str );
181Expression * build_field_name_FLOATINGconstant( const std::string & str );
182Expression * build_field_name_fraction_constants( Expression * fieldName, ExpressionNode * fracts );
183
184NameExpr * build_varref( const std::string * name );
185DimensionExpr * build_dimensionref( const std::string * name );
186
187Expression * build_cast( DeclarationNode * decl_node, ExpressionNode * expr_node );
188Expression * build_keyword_cast( AggregateDecl::Aggregate target, ExpressionNode * expr_node );
189Expression * build_virtual_cast( DeclarationNode * decl_node, ExpressionNode * expr_node );
190Expression * build_fieldSel( ExpressionNode * expr_node, Expression * member );
191Expression * build_pfieldSel( ExpressionNode * expr_node, Expression * member );
192Expression * build_offsetOf( DeclarationNode * decl_node, NameExpr * member );
193Expression * build_and( ExpressionNode * expr_node1, ExpressionNode * expr_node2 );
194Expression * build_and_or( ExpressionNode * expr_node1, ExpressionNode * expr_node2, bool kind );
195Expression * build_unary_val( OperKinds op, ExpressionNode * expr_node );
196Expression * build_unary_ptr( OperKinds op, ExpressionNode * expr_node );
197Expression * build_binary_val( OperKinds op, ExpressionNode * expr_node1, ExpressionNode * expr_node2 );
198Expression * build_binary_ptr( OperKinds op, ExpressionNode * expr_node1, ExpressionNode * expr_node2 );
199Expression * build_cond( ExpressionNode * expr_node1, ExpressionNode * expr_node2, ExpressionNode * expr_node3 );
200Expression * build_tuple( ExpressionNode * expr_node = nullptr );
201Expression * build_func( ExpressionNode * function, ExpressionNode * expr_node );
202Expression * build_compoundLiteral( DeclarationNode * decl_node, InitializerNode * kids );
203
204//##############################################################################
205
206struct TypeData;
207
208struct DeclarationNode : public ParseNode {
209 // These enumerations must harmonize with their names in DeclarationNode.cc.
210 enum BasicType { Void, Bool, Char, Int, Int128,
211 Float, Double, LongDouble, uuFloat80, uuFloat128,
212 uFloat16, uFloat32, uFloat32x, uFloat64, uFloat64x, uFloat128, uFloat128x, NoBasicType };
213 static const char * basicTypeNames[];
214 enum ComplexType { Complex, NoComplexType, Imaginary }; // Imaginary unsupported => parse, but make invisible and print error message
215 static const char * complexTypeNames[];
216 enum Signedness { Signed, Unsigned, NoSignedness };
217 static const char * signednessNames[];
218 enum Length { Short, Long, LongLong, NoLength };
219 static const char * lengthNames[];
220 enum BuiltinType { Valist, AutoType, Zero, One, NoBuiltinType };
221 static const char * builtinTypeNames[];
222
223 static DeclarationNode * newStorageClass( Type::StorageClasses );
224 static DeclarationNode * newFuncSpecifier( Type::FuncSpecifiers );
225 static DeclarationNode * newTypeQualifier( Type::Qualifiers );
226 static DeclarationNode * newBasicType( BasicType );
227 static DeclarationNode * newComplexType( ComplexType );
228 static DeclarationNode * newSignedNess( Signedness );
229 static DeclarationNode * newLength( Length );
230 static DeclarationNode * newBuiltinType( BuiltinType );
231 static DeclarationNode * newForall( DeclarationNode * );
232 static DeclarationNode * newFromTypedef( const std::string * );
233 static DeclarationNode * newFromGlobalScope();
234 static DeclarationNode * newQualifiedType( DeclarationNode *, DeclarationNode * );
235 static DeclarationNode * newFunction( const std::string * name, DeclarationNode * ret, DeclarationNode * param, StatementNode * body );
236 static DeclarationNode * newAggregate( AggregateDecl::Aggregate kind, const std::string * name, ExpressionNode * actuals, DeclarationNode * fields, bool body );
237 static DeclarationNode * newEnum( const std::string * name, DeclarationNode * constants, bool body );
238 static DeclarationNode * newEnumConstant( const std::string * name, ExpressionNode * constant );
239 static DeclarationNode * newName( const std::string * );
240 static DeclarationNode * newFromTypeGen( const std::string *, ExpressionNode * params );
241 static DeclarationNode * newTypeParam( TypeDecl::Kind, const std::string * );
242 static DeclarationNode * newTrait( const std::string * name, DeclarationNode * params, DeclarationNode * asserts );
243 static DeclarationNode * newTraitUse( const std::string * name, ExpressionNode * params );
244 static DeclarationNode * newTypeDecl( const std::string * name, DeclarationNode * typeParams );
245 static DeclarationNode * newPointer( DeclarationNode * qualifiers, OperKinds kind );
246 static DeclarationNode * newArray( ExpressionNode * size, DeclarationNode * qualifiers, bool isStatic );
247 static DeclarationNode * newVarArray( DeclarationNode * qualifiers );
248 static DeclarationNode * newBitfield( ExpressionNode * size );
249 static DeclarationNode * newTuple( DeclarationNode * members );
250 static DeclarationNode * newTypeof( ExpressionNode * expr, bool basetypeof = false );
251 static DeclarationNode * newAttribute( const std::string *, ExpressionNode * expr = nullptr ); // gcc attributes
252 static DeclarationNode * newDirectiveStmt( StatementNode * stmt ); // gcc external directive statement
253 static DeclarationNode * newAsmStmt( StatementNode * stmt ); // gcc external asm statement
254 static DeclarationNode * newStaticAssert( ExpressionNode * condition, Expression * message );
255
256 DeclarationNode();
257 ~DeclarationNode();
258 DeclarationNode * clone() const override;
259
260 DeclarationNode * addQualifiers( DeclarationNode * );
261 void checkQualifiers( const TypeData *, const TypeData * );
262 void checkSpecifiers( DeclarationNode * );
263 DeclarationNode * copySpecifiers( DeclarationNode * );
264 DeclarationNode * addType( DeclarationNode * );
265 DeclarationNode * addTypedef();
266 DeclarationNode * addAssertions( DeclarationNode * );
267 DeclarationNode * addName( std::string * );
268 DeclarationNode * addAsmName( DeclarationNode * );
269 DeclarationNode * addBitfield( ExpressionNode * size );
270 DeclarationNode * addVarArgs();
271 DeclarationNode * addFunctionBody( StatementNode * body, ExpressionNode * with = nullptr );
272 DeclarationNode * addOldDeclList( DeclarationNode * list );
273 DeclarationNode * setBase( TypeData * newType );
274 DeclarationNode * copyAttribute( DeclarationNode * attr );
275 DeclarationNode * addPointer( DeclarationNode * qualifiers );
276 DeclarationNode * addArray( DeclarationNode * array );
277 DeclarationNode * addNewPointer( DeclarationNode * pointer );
278 DeclarationNode * addNewArray( DeclarationNode * array );
279 DeclarationNode * addParamList( DeclarationNode * list );
280 DeclarationNode * addIdList( DeclarationNode * list ); // old-style functions
281 DeclarationNode * addInitializer( InitializerNode * init );
282 DeclarationNode * addTypeInitializer( DeclarationNode * init );
283
284 DeclarationNode * cloneType( std::string * newName );
285 DeclarationNode * cloneBaseType( DeclarationNode * newdecl );
286
287 DeclarationNode * appendList( DeclarationNode * node ) {
288 return (DeclarationNode *)set_last( node );
289 }
290
291 virtual void print( __attribute__((unused)) std::ostream & os, __attribute__((unused)) int indent = 0 ) const override;
292 virtual void printList( __attribute__((unused)) std::ostream & os, __attribute__((unused)) int indent = 0 ) const override;
293
294 Declaration * build() const;
295 Type * buildType() const;
296
297 LinkageSpec::Spec get_linkage() const { return linkage; }
298 DeclarationNode * extractAggregate() const;
299 bool has_enumeratorValue() const { return (bool)enumeratorValue; }
300 ExpressionNode * consume_enumeratorValue() const { return const_cast<DeclarationNode *>(this)->enumeratorValue.release(); }
301
302 bool get_extension() const { return extension; }
303 DeclarationNode * set_extension( bool exten ) { extension = exten; return this; }
304
305 bool get_inLine() const { return inLine; }
306 DeclarationNode * set_inLine( bool inL ) { inLine = inL; return this; }
307
308 DeclarationNode * get_last() { return (DeclarationNode *)ParseNode::get_last(); }
309
310 struct Variable_t {
311// const std::string * name;
312 TypeDecl::Kind tyClass;
313 DeclarationNode * assertions;
314 DeclarationNode * initializer;
315 };
316 Variable_t variable;
317
318 struct Attr_t {
319// const std::string * name;
320 ExpressionNode * expr;
321 DeclarationNode * type;
322 };
323 Attr_t attr;
324
325 struct StaticAssert_t {
326 ExpressionNode * condition;
327 Expression * message;
328 };
329 StaticAssert_t assert;
330
331 BuiltinType builtin = NoBuiltinType;
332
333 TypeData * type = nullptr;
334
335 bool inLine = false;
336 Type::FuncSpecifiers funcSpecs;
337 Type::StorageClasses storageClasses;
338
339 ExpressionNode * bitfieldWidth = nullptr;
340 std::unique_ptr<ExpressionNode> enumeratorValue;
341 bool hasEllipsis = false;
342 LinkageSpec::Spec linkage;
343 Expression * asmName = nullptr;
344 std::list< Attribute * > attributes;
345 InitializerNode * initializer = nullptr;
346 bool extension = false;
347 std::string error;
348 StatementNode * asmStmt = nullptr;
349 StatementNode * directiveStmt = nullptr;
350
351 static UniqueName anonymous;
352}; // DeclarationNode
353
354Type * buildType( TypeData * type );
355
356static inline Type * maybeMoveBuildType( const DeclarationNode * orig ) {
357 Type * ret = orig ? orig->buildType() : nullptr;
358 delete orig;
359 return ret;
360}
361
362//##############################################################################
363
364struct StatementNode final : public ParseNode {
365 StatementNode() { stmt = nullptr; }
366 StatementNode( Statement * stmt ) : stmt( stmt ) {}
367 StatementNode( DeclarationNode * decl );
368 virtual ~StatementNode() {}
369
370 virtual StatementNode * clone() const final { assert( false ); return nullptr; }
371 Statement * build() const { return const_cast<StatementNode *>(this)->stmt.release(); }
372
373 virtual StatementNode * add_label( const std::string * name, DeclarationNode * attr = nullptr ) {
374 stmt->get_labels().emplace_back( * name, nullptr, attr ? std::move( attr->attributes ) : std::list< Attribute * > {} );
375 delete attr;
376 delete name;
377 return this;
378 }
379
380 virtual StatementNode * append_last_case( StatementNode * );
381
382 virtual void print( std::ostream & os, __attribute__((unused)) int indent = 0 ) const override {
383 os << stmt.get() << std::endl;
384 }
385
386 std::unique_ptr<Statement> stmt;
387}; // StatementNode
388
389Statement * build_expr( ExpressionNode * ctl );
390
391struct IfCtrl {
392 IfCtrl( DeclarationNode * decl, ExpressionNode * condition ) :
393 init( decl ? new StatementNode( decl ) : nullptr ), condition( condition ) {}
394
395 StatementNode * init;
396 ExpressionNode * condition;
397};
398
399struct ForCtrl {
400 ForCtrl( ExpressionNode * expr, ExpressionNode * condition, ExpressionNode * change ) :
401 init( new StatementNode( build_expr( expr ) ) ), condition( condition ), change( change ) {}
402 ForCtrl( DeclarationNode * decl, ExpressionNode * condition, ExpressionNode * change ) :
403 init( new StatementNode( decl ) ), condition( condition ), change( change ) {}
404
405 StatementNode * init;
406 ExpressionNode * condition;
407 ExpressionNode * change;
408};
409
410Expression * build_if_control( IfCtrl * ctl, std::list< Statement * > & init );
411Statement * build_if( IfCtrl * ctl, StatementNode * then_stmt, StatementNode * else_stmt );
412Statement * build_switch( bool isSwitch, ExpressionNode * ctl, StatementNode * stmt );
413Statement * build_case( ExpressionNode * ctl );
414Statement * build_default();
415Statement * build_while( IfCtrl * ctl, StatementNode * stmt );
416Statement * build_do_while( ExpressionNode * ctl, StatementNode * stmt );
417Statement * build_for( ForCtrl * forctl, StatementNode * stmt );
418Statement * build_branch( BranchStmt::Type kind );
419Statement * build_branch( std::string * identifier, BranchStmt::Type kind );
420Statement * build_computedgoto( ExpressionNode * ctl );
421Statement * build_return( ExpressionNode * ctl );
422Statement * build_throw( ExpressionNode * ctl );
423Statement * build_resume( ExpressionNode * ctl );
424Statement * build_resume_at( ExpressionNode * ctl , ExpressionNode * target );
425Statement * build_try( StatementNode * try_stmt, StatementNode * catch_stmt, StatementNode * finally_stmt );
426Statement * build_catch( CatchStmt::Kind kind, DeclarationNode *decl, ExpressionNode *cond, StatementNode *body );
427Statement * build_finally( StatementNode * stmt );
428Statement * build_compound( StatementNode * first );
429StatementNode * maybe_build_compound( StatementNode * first );
430Statement * build_asm( bool voltile, Expression * instruction, ExpressionNode * output = nullptr, ExpressionNode * input = nullptr, ExpressionNode * clobber = nullptr, LabelNode * gotolabels = nullptr );
431Statement * build_directive( std::string * directive );
432SuspendStmt * build_suspend( StatementNode *, SuspendStmt::Type = SuspendStmt::None);
433WaitForStmt * build_waitfor( ExpressionNode * target, StatementNode * stmt, ExpressionNode * when );
434WaitForStmt * build_waitfor( ExpressionNode * target, StatementNode * stmt, ExpressionNode * when, WaitForStmt * existing );
435WaitForStmt * build_waitfor_timeout( ExpressionNode * timeout, StatementNode * stmt, ExpressionNode * when );
436WaitForStmt * build_waitfor_timeout( ExpressionNode * timeout, StatementNode * stmt, ExpressionNode * when, StatementNode * else_stmt, ExpressionNode * else_when );
437Statement * build_with( ExpressionNode * exprs, StatementNode * stmt );
438
439//##############################################################################
440
441template< typename SynTreeType, typename NodeType, template< typename, typename...> class Container, typename... Args >
442void buildList( const NodeType * firstNode, Container< SynTreeType *, Args... > & outputList ) {
443 SemanticErrorException errors;
444 std::back_insert_iterator< Container< SynTreeType *, Args... > > out( outputList );
445 const NodeType * cur = firstNode;
446
447 while ( cur ) {
448 try {
449 SynTreeType * result = dynamic_cast< SynTreeType * >( maybeBuild< typename std::pointer_traits< decltype(cur->build())>::element_type >( cur ) );
450 if ( result ) {
451 result->location = cur->location;
452 * out++ = result;
453 } else {
454 SemanticError( cur->location, "type specifier declaration in forall clause is currently unimplemented." );
455 } // if
456 } catch( SemanticErrorException & e ) {
457 errors.append( e );
458 } // try
459 cur = dynamic_cast< NodeType * >( cur->get_next() );
460 } // while
461 if ( ! errors.isEmpty() ) {
462 throw errors;
463 } // if
464}
465
466// in DeclarationNode.cc
467void buildList( const DeclarationNode * firstNode, std::list< Declaration * > & outputList );
468void buildList( const DeclarationNode * firstNode, std::list< DeclarationWithType * > & outputList );
469void buildTypeList( const DeclarationNode * firstNode, std::list< Type * > & outputList );
470
471template< typename SynTreeType, typename NodeType >
472void buildMoveList( const NodeType * firstNode, std::list< SynTreeType * > & outputList ) {
473 buildList( firstNode, outputList );
474 delete firstNode;
475}
476
477// in ParseNode.cc
478std::ostream & operator<<( std::ostream & out, const ParseNode * node );
479
480// Local Variables: //
481// tab-width: 4 //
482// mode: c++ //
483// compile-command: "make install" //
484// End: //
Note: See TracBrowser for help on using the repository browser.