Files
swift-mirror/lib/Parse/ParseDecl.cpp
Chris Lattner 80caaa7d87 remove support for anonymous oneof types, which cause issues for mangling
and are more of a theoretically good idea than an actually useful idea.

This is the first half of rdar://10157535


Swift SVN r818
2011-11-01 23:20:23 +00:00

710 lines
23 KiB
C++

//===--- ParseDecl.cpp - Swift Language Parser for Declarations -----------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2015 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
//
// Declaration Parsing and AST Building
//
//===----------------------------------------------------------------------===//
#include "Lexer.h"
#include "Parser.h"
#include "swift/AST/Diagnostics.h"
#include "llvm/ADT/PointerUnion.h"
#include "llvm/ADT/SmallPtrSet.h"
#include "llvm/ADT/Twine.h"
using namespace swift;
/// parseTranslationUnit - Main entrypoint for the parser.
/// translation-unit:
/// stmt-brace-item*
TranslationUnit *Parser::parseTranslationUnit() {
// Prime the lexer.
consumeToken();
SourceLoc FileStartLoc = Tok.getLoc();
TranslationUnit *TU =
new (Context) TranslationUnit(L.getModuleName(), Context);
CurDeclContext = TU;
// Parse the body of the file.
SmallVector<ExprStmtOrDecl, 128> Items;
parseBraceItemList(Items, true);
// Process the end of the translation unit.
SourceLoc FileEnd = Tok.getLoc();
// First thing, we transform the body into a brace expression.
TU->Body = BraceStmt::create(Context, FileStartLoc, Items, FileEnd);
// Do a prepass over the declarations to make sure they have basic sanity and
// to find the list of top-level value declarations.
for (auto Elt : TU->Body->getElements()) {
if (!Elt.is<Decl*>()) continue;
Decl *D = Elt.get<Decl*>();
// If any top-level value decl has an unresolved type, then it is erroneous.
// It is not valid to have something like "var x = 4" at the top level, all
// types must be explicit here.
ValueDecl *VD = dyn_cast<ValueDecl>(D);
if (VD == 0) continue;
// FIXME: This can be better handled in the various ActOnDecl methods when
// they get passed in a parent context decl.
// Verify that values have a type specified.
if (false && VD->Ty->is<DependentType>()) {
diagnose(VD->getLocStart(), diag::top_level_decl_without_type);
// FIXME: Should mark the decl as invalid.
VD->Ty = TupleType::getEmpty(Context);
}
}
// Verify that any forward declared types were ultimately defined.
// TODO: Move this to name binding!
SmallVector<TypeAliasDecl*, 8> UnresolvedTypeList;
for (TypeAliasDecl *Decl : ScopeInfo.getUnresolvedTypeList()) {
if (Decl->UnderlyingTy.isNull())
UnresolvedTypeList.push_back(Decl);
}
TU->UnresolvedTypesForParser = Context.AllocateCopy(UnresolvedTypeList);
TU->UnresolvedScopedTypesForParser =
Context.AllocateCopy(ScopeInfo.getUnresolvedScopedTypeList());
return TU;
}
static bool isInfixAttr(Token &Tok, Associativity &Assoc) {
if (Tok.getText() == "infix_left") {
Assoc = Associativity::Left;
return true;
} else if (Tok.getText() == "infix_right") {
Assoc = Associativity::Right;
return true;
} else if (Tok.getText() == "infix") {
Assoc = Associativity::None;
return true;
} else {
return false;
}
}
/// parseAttribute
/// attribute:
/// 'infix' '=' numeric_constant
/// 'infix_left' '=' numeric_constant
/// 'infix_right' '=' numeric_constant
/// 'unary'
bool Parser::parseAttribute(DeclAttributes &Attributes) {
// infix attributes.
Associativity Assoc;
if (Tok.is(tok::identifier) && isInfixAttr(Tok, Assoc)) {
if (Attributes.isInfix())
diagnose(Tok, diag::duplicate_attribute, Tok.getText());
consumeToken(tok::identifier);
// The default precedence is 100.
Attributes.Infix = InfixData(100, Assoc);
if (consumeIf(tok::equal)) {
SourceLoc PrecLoc = Tok.getLoc();
StringRef Text = Tok.getText();
if (!parseToken(tok::numeric_constant, diag::expected_precedence_value)){
long long Value;
if (Text.getAsInteger(10, Value) || Value > 255 || Value < 0)
diagnose(PrecLoc, diag::invalid_precedence, Text);
else
Attributes.Infix = InfixData(Value, Assoc);
} else {
// FIXME: I'd far rather that we describe this in terms of some
// list structure in the caller. This feels too ad hoc.
skipUntil(tok::r_square, tok::comma);
}
}
return false;
}
if (Tok.is(tok::identifier))
diagnose(Tok, diag::unknown_attribute, Tok.getText());
else
diagnose(Tok, diag::expected_attribute_name);
skipUntil(tok::r_square);
return true;
}
/// parsePresentAttributeList
/// attribute-list:
/// attribute-list-present?
///
/// attribute-list-present:
/// '[' ']'
/// '[' attribute (',' attribute)* ']'
void Parser::parseAttributeListPresent(DeclAttributes &Attributes) {
Attributes.LSquareLoc = consumeToken(tok::l_square);
// If this is an empty attribute list, consume it and return.
if (Tok.is(tok::r_square)) {
Attributes.RSquareLoc = consumeToken(tok::r_square);
return;
}
bool HadError = parseAttribute(Attributes);
while (Tok.is(tok::comma)) {
consumeToken(tok::comma);
HadError |= parseAttribute(Attributes);
}
Attributes.RSquareLoc = Tok.getLoc();
if (consumeIf(tok::r_square))
return;
// Otherwise, there was an error parsing the attribute list. If we already
// reported an error, skip to a ], otherwise report the error.
if (!HadError)
parseToken(tok::r_square, diag::expected_in_attribute_list, tok::r_square);
else {
skipUntil(tok::r_square);
consumeIf(tok::r_square);
}
}
/// parseDeclImport - Parse an 'import' declaration, returning null (and doing
/// no token skipping) on error.
///
/// decl-import:
/// 'import' attribute-list? identifier ('.' identifier)*
///
Decl *Parser::parseDeclImport() {
SourceLoc ImportLoc = consumeToken(tok::kw_import);
DeclAttributes Attributes;
parseAttributeList(Attributes);
SmallVector<std::pair<Identifier, SourceLoc>, 8> ImportPath(1);
ImportPath.back().second = Tok.getLoc();
if (parseIdentifier(ImportPath.back().first,diag::decl_expected_module_name))
return 0;
while (consumeIf(tok::period)) {
ImportPath.push_back(std::make_pair(Identifier(), Tok.getLoc()));
if (parseIdentifier(ImportPath.back().first,
diag::expected_identifier_in_decl, "import"))
return 0;
}
if (!Attributes.empty())
diagnose(Attributes.LSquareLoc, diag::import_attributes);
return new (Context) ImportDecl(ImportLoc, Context.AllocateCopy(ImportPath),
CurDeclContext);
}
/// parseVarName
/// var-name:
/// identifier
/// '(' ')'
/// '(' name (',' name)* ')'
bool Parser::parseVarName(DeclVarName &Name) {
// Single name case.
if (Tok.is(tok::identifier) || Tok.is(tok::oper)) {
SourceLoc IdLoc = Tok.getLoc();
Identifier Id = Context.getIdentifier(Tok.getText());
consumeToken();
Name = DeclVarName(Id, IdLoc);
return false;
}
if (Tok.isNot(tok::l_paren) && Tok.isNot(tok::l_paren_space)) {
diagnose(Tok, diag::expected_lparen_var_name);
return true;
}
SourceLoc LPLoc = consumeToken();
SmallVector<DeclVarName*, 8> ChildNames;
if (Tok.isNot(tok::r_paren)) {
do {
DeclVarName *Elt = new (Context) DeclVarName();
if (parseVarName(*Elt)) return true;
ChildNames.push_back(Elt);
} while (consumeIf(tok::comma));
}
SourceLoc RPLoc = Tok.getLoc();
if (parseToken(tok::r_paren, diag::expected_rparen_var_name))
diagnose(LPLoc, diag::opening_paren);
Name = DeclVarName(LPLoc, Context.AllocateCopy(ChildNames), RPLoc);
return false;
}
/// parseDeclTypeAlias
/// decl-typealias:
/// 'typealias' identifier ':' type
TypeAliasDecl *Parser::parseDeclTypeAlias() {
SourceLoc TypeAliasLoc = consumeToken(tok::kw_typealias);
Identifier Id;
Type Ty;
if (parseIdentifier(Id, diag::expected_identifier_in_decl, "typealias") ||
parseToken(tok::colon, diag::expected_colon_in_typealias) ||
parseType(Ty, diag::expected_type_in_typealias))
return 0;
return ScopeInfo.addTypeAliasToScope(TypeAliasLoc, Id, Ty);
}
/// AddElementNamesForVarDecl - This recursive function walks a name specifier
/// adding ElementRefDecls for the named subcomponents and checking that types
/// match up correctly.
void Parser::actOnVarDeclName(const DeclVarName *Name,
SmallVectorImpl<unsigned> &AccessPath,
VarDecl *VD,
SmallVectorImpl<Parser::ExprStmtOrDecl> &Decls) {
if (Name->isSimple()) {
// If this is a leaf name, create a ElementRefDecl with the specified
// access path.
Type Ty = ElementRefDecl::getTypeForPath(VD->Ty, AccessPath);
// If the type of the path is obviously invalid, diagnose it now and refuse
// to create the decl. The most common result here is DependentType, which
// allows type checking to resolve this later.
if (Ty.isNull()) {
diagnose(Name->getLocation(), diag::invalid_index_in_var_name_path,
Name->getIdentifier(), VD->Ty);
return;
}
// Create the decl for this name and add it to the current scope.
ElementRefDecl *ERD =
new (Context) ElementRefDecl(VD, Name->getLocation(),
Name->getIdentifier(),
Context.AllocateCopy(AccessPath), Ty,
CurDeclContext);
Decls.push_back(ERD);
ScopeInfo.addToScope(ERD);
return;
}
AccessPath.push_back(0);
unsigned Index = 0;
for (auto Element : Name->getElements()) {
AccessPath.back() = Index++;
actOnVarDeclName(Element, AccessPath, VD, Decls);
}
AccessPath.pop_back();
}
/// parseDeclVar - Parse a 'var' declaration, returning null (and doing no
/// token skipping) on error.
///
/// decl-var:
/// 'var' attribute-list? var-name value-specifier
bool Parser::parseDeclVar(SmallVectorImpl<ExprStmtOrDecl> &Decls) {
SourceLoc VarLoc = consumeToken(tok::kw_var);
DeclAttributes Attributes;
parseAttributeList(Attributes);
DeclVarName VarName;
if (parseVarName(VarName)) return true;
Type Ty;
NullablePtr<Expr> Init;
if (parseValueSpecifier(Ty, Init, /*single*/ false))
return true;
if (Ty.isNull())
Ty = DependentType::get(Context);
// Note that we enter the declaration into the current scope. Since var's are
// not allowed to be recursive, they are entered after its initializer is
// parsed. This does mean that stuff like this is different than C:
// var x = 1; { var x = x+1; assert(x == 2); }
if (VarName.isSimple()) {
VarDecl *VD = new (Context) VarDecl(VarLoc, VarName.getIdentifier(), Ty,
Init.getPtrOrNull(), Attributes,
CurDeclContext);
ScopeInfo.addToScope(VD);
Decls.push_back(VD);
return false;
}
// Copy the name into the ASTContext heap.
DeclVarName *TmpName = new (Context) DeclVarName(VarName);
VarDecl *VD = new (Context) VarDecl(VarLoc, TmpName, Ty, Init.getPtrOrNull(),
Attributes, CurDeclContext);
Decls.push_back(VD);
// If there is a more interesting name presented here, then we need to walk
// through it and synthesize the decls that reference the var elements as
// appropriate.
SmallVector<unsigned, 8> AccessPath;
actOnVarDeclName(VD->NestedName, AccessPath, VD, Decls);
return false;
}
/// parseDeclVarSimple - This just parses a reduced case of decl-var.
///
/// decl-var-simple:
/// 'var' attribute-list? any-identifier value-specifier
///
VarDecl *Parser::parseDeclVarSimple() {
SourceLoc CurLoc = Tok.getLoc();
SmallVector<ExprStmtOrDecl, 2> Decls;
if (parseDeclVar(Decls)) return 0;
if (Decls.size() == 1 && Decls[0].is<Decl*>())
if (Decl *D = Decls[0].get<Decl*>())
if (VarDecl *VD = dyn_cast<VarDecl>(D))
return VD;
// FIXME: "here" requires a lot more context.
diagnose(CurLoc, diag::non_simple_var);
return 0;
}
/// parseDeclFunc - Parse a 'func' declaration, returning null on error. The
/// caller handles this case and does recovery as appropriate. If AllowScoped
/// is true, we parse both productions.
///
/// decl-func:
/// 'func' attribute-list? identifier type stmt-brace?
/// decl-func-scoped:
/// 'func' attribute-list? type-identifier '::' identifier type stmt-brace?
///
FuncDecl *Parser::parseDeclFunc(bool AllowScoped) {
SourceLoc FuncLoc = consumeToken(tok::kw_func);
DeclAttributes Attributes;
// FIXME: Implicitly add immutable attribute.
parseAttributeList(Attributes);
Type ReceiverTy;
Identifier Name;
SourceLoc TypeNameLoc = Tok.getLoc();
if (parseIdentifier(Name, diag::expected_identifier_in_decl, "func"))
return 0;
// If this is method syntax, the first name is the receiver type. Parse the
// actual function name.
if (AllowScoped && consumeIf(tok::coloncolon)) {
// Look up the type name.
ReceiverTy = ScopeInfo.lookupOrInsertTypeName(Name, TypeNameLoc);
if (parseIdentifier(Name, diag::expected_identifier_in_decl, "func"))
return 0;
}
// We force first type of a func declaration to be a tuple for consistency.
if (Tok.isNot(tok::l_paren) && Tok.isNot(tok::l_paren_space)) {
diagnose(Tok, diag::func_decl_without_paren);
return 0;
}
Type FuncTy;
if (parseType(FuncTy))
return 0;
// If the parsed type is not spelled as a function type (i.e., has no '->' in
// it), then it is implicitly a function that returns ().
if (!isa<FunctionType>(FuncTy.getPointer()))
FuncTy = FunctionType::get(FuncTy, TupleType::getEmpty(Context), Context);
// If a receiver type was specified, install the first type as the receiver,
// as a tuple with element named 'this'. This turns "int->int" on FooTy into
// "(this : FooTy)->(int->int)".
if (!ReceiverTy.isNull()) {
TupleTypeElt ReceiverElt(ReceiverTy, Context.getIdentifier("this"));
FuncTy = FunctionType::get(TupleType::get(ReceiverElt, Context),
FuncTy, Context);
}
// Enter the arguments for the function into a new function-body scope. We
// need this even if there is no function body to detect argument name
// duplication.
FuncExpr *FE = 0;
{
Scope FnBodyScope(this);
FE = actOnFuncExprStart(FuncLoc, FuncTy);
// Establish the new context.
ContextChange CC(*this, FE);
// Then parse the expression.
NullablePtr<Stmt> Body;
// Check to see if we have a "{" which is a brace expr.
if (Tok.is(tok::l_brace)) {
ParseResult<BraceStmt> Body = parseStmtBrace(diag::invalid_diagnostic);
if (Body.isSuccess())
FE->setBody(Body.get());
else // FIXME: Should do some sort of error recovery here.
FE = 0;
} else {
// Note, we just discard FE here. It is bump pointer allocated, so this
// is fine (if suboptimal).
FE = 0;
}
}
// Create the decl for the func and add it to the parent scope.
FuncDecl *FD = new (Context) FuncDecl(FuncLoc, Name, FuncTy, FE, Attributes,
CurDeclContext);
ScopeInfo.addToScope(FD);
return FD;
}
/// parseDeclOneOf - Parse a 'oneof' declaration, returning null (and doing no
/// token skipping) on error.
///
/// decl-oneof:
/// 'oneof' attribute-list identifier oneof-body
///
Decl *Parser::parseDeclOneOf() {
SourceLoc OneOfLoc = consumeToken(tok::kw_oneof);
DeclAttributes Attributes;
parseAttributeList(Attributes);
SourceLoc NameLoc = Tok.getLoc();
Identifier OneOfName;
Type OneOfType;
if (parseIdentifier(OneOfName, diag::expected_identifier_in_decl, "oneof"))
return 0;
TypeAliasDecl *TAD = ScopeInfo.addTypeAliasToScope(NameLoc, OneOfName,Type());
if (parseDeclOneOfBody(OneOfLoc, Attributes, OneOfType, TAD))
return 0;
return TAD;
}
/// oneof-body:
/// '{' oneof-element (',' oneof-element)* '}'
/// oneof-element:
/// identifier
/// identifier ':' type
///
/// If TypeName is specified, it is the type that the constructors should be
/// built with, so that they preserve the name of the oneof decl that contains
/// this.
bool Parser::parseDeclOneOfBody(SourceLoc OneOfLoc, const DeclAttributes &Attrs,
Type &Result, TypeAliasDecl *TypeName) {
SourceLoc LBLoc = Tok.getLoc();
if (parseToken(tok::l_brace, diag::expected_lbrace_oneof_type))
return true;
SmallVector<OneOfElementInfo, 8> ElementInfos;
// Parse the comma separated list of oneof elements.
while (Tok.is(tok::identifier)) {
OneOfElementInfo ElementInfo;
ElementInfo.Name = Tok.getText();
ElementInfo.NameLoc = Tok.getLoc();
ElementInfo.EltType = 0;
consumeToken(tok::identifier);
// See if we have a type specifier for this oneof element. If so, parse it.
if (consumeIf(tok::colon) &&
parseType(ElementInfo.EltType, diag::expected_type_oneof_element)) {
skipUntil(tok::r_brace);
return true;
}
ElementInfos.push_back(ElementInfo);
// Require comma separation.
if (!consumeIf(tok::comma))
break;
}
// FIXME: Helper for matching punctuation.
if (parseToken(tok::r_brace, diag::expected_rbrace_oneof_type))
diagnose(LBLoc, diag::opening_brace);
Result = actOnOneOfType(OneOfLoc, Attrs, ElementInfos, TypeName);
return false;
}
OneOfType *Parser::actOnOneOfType(SourceLoc OneOfLoc,
const DeclAttributes &Attrs,
ArrayRef<OneOfElementInfo> Elts,
TypeAliasDecl *PrettyTypeName) {
// No attributes are valid on oneof types at this time.
if (!Attrs.empty())
diagnose(Attrs.LSquareLoc, diag::oneof_attributes);
llvm::SmallPtrSet<const char *, 16> SeenSoFar;
SmallVector<OneOfElementDecl *, 16> EltDecls;
// If we have a PrettyTypeName to use, use it. Otherwise, just assign the
// constructors a temporary dummy type.
Type TmpTy = TupleType::getEmpty(Context);
if (PrettyTypeName)
TmpTy = PrettyTypeName->getAliasType();
for (const OneOfElementInfo &Elt : Elts) {
Identifier NameI = Context.getIdentifier(Elt.Name);
// If this was multiply defined, reject it.
if (!SeenSoFar.insert(NameI.get())) {
diagnose(Elt.NameLoc, diag::duplicate_oneof_element, Elt.Name);
// FIXME: Do we care enough to make this efficient?
for (unsigned I = 0, N = EltDecls.size(); I != N; ++I) {
if (EltDecls[I]->Name == NameI) {
diagnose(EltDecls[I]->getLocStart(), diag::previous_definition,
NameI);
break;
}
}
// Don't copy this element into NewElements.
continue;
}
Type EltTy = TmpTy;
if (Type ArgTy = Elt.EltType)
if (PrettyTypeName)
EltTy = FunctionType::get(ArgTy, EltTy, Context);
// Create a decl for each element, giving each a temporary type.
EltDecls.push_back(new (Context) OneOfElementDecl(Elt.NameLoc, NameI,
EltTy, Elt.EltType,
CurDeclContext));
}
OneOfType *Result = OneOfType::getNew(OneOfLoc, EltDecls, CurDeclContext);
for (OneOfElementDecl *D : EltDecls)
D->Context = Result;
if (PrettyTypeName) {
// If we have a pretty name for this, complete it to its actual type.
assert(PrettyTypeName->UnderlyingTy.isNull() &&
"Not an incomplete decl to complete!");
PrettyTypeName->UnderlyingTy = Result;
} else {
// Now that the oneof type is created, we can go back and give proper types
// to each element decl.
for (OneOfElementDecl *Elt : EltDecls) {
Type EltTy = Result;
// If the OneOf Element takes a type argument, then it is actually a
// function that takes the type argument and returns the OneOfType.
if (Type ArgTy = Elt->ArgumentType)
EltTy = FunctionType::get(ArgTy, EltTy, Context);
Elt->Ty = EltTy;
}
}
return Result;
}
/// parseDeclStruct - Parse a 'struct' declaration, returning null (and doing no
/// token skipping) on error. A 'struct' is just syntactic sugar for a oneof
/// with a single element.
///
/// decl-struct:
/// 'struct' attribute-list identifier { type-tuple-body? }
///
bool Parser::parseDeclStruct(SmallVectorImpl<ExprStmtOrDecl> &Decls) {
SourceLoc StructLoc = consumeToken(tok::kw_struct);
DeclAttributes Attributes;
parseAttributeList(Attributes);
Identifier StructName;
if (parseIdentifier(StructName, diag::expected_identifier_in_decl, "struct"))
return true;
SourceLoc LBLoc = Tok.getLoc();
Type BodyTy;
if (parseToken(tok::l_brace, diag::expected_lbrace_struct) ||
parseTypeTupleBody(LBLoc, BodyTy))
return true;
// FIXME: add helper for matching punctuation.
if (parseToken(tok::r_brace, diag::expected_rbrace_struct)) {
diagnose(LBLoc, diag::opening_brace);
return true;
}
// The type is required to be syntactically a tuple type.
if (!isa<TupleType>(BodyTy.getPointer())) {
// FIXME: Fairly unfriendly diagnostic, here.
diagnose(StructLoc, diag::struct_not_tuple);
// FIXME: Should set this as an erroroneous decl.
return true;
}
// Get the TypeAlias for the name that we'll eventually have. This ensures
// that the constructors generated have the pretty name for the type instead
// of the raw oneof.
TypeAliasDecl *TAD = ScopeInfo.addTypeAliasToScope(StructLoc, StructName,
Type());
Decls.push_back(TAD);
// The 'struct' is syntactically fine, invoke the semantic actions for the
// syntactically expanded oneof type. Struct declarations are just sugar for
// other existing constructs.
Parser::OneOfElementInfo ElementInfo;
ElementInfo.Name = StructName.str();
ElementInfo.NameLoc = StructLoc;
ElementInfo.EltType = BodyTy;
OneOfType *OneOfTy = actOnOneOfType(StructLoc, Attributes, ElementInfo, TAD);
assert(OneOfTy->hasSingleElement() && "Somehow isn't a struct?");
// In addition to defining the oneof declaration, structs also inject their
// constructor into the global scope.
assert(OneOfTy->Elements.size() == 1 && "Struct has exactly one element");
ScopeInfo.addToScope(OneOfTy->getElement(0));
Decls.push_back(OneOfTy->getElement(0));
return false;
}
/// parseDeclProtocol - Parse a 'protocol' declaration, returning null (and
/// doing no token skipping) on error.
///
/// decl-protocol:
/// 'protocol' attribute-list identifier protocol-body
///
Decl *Parser::parseDeclProtocol() {
SourceLoc ProtocolLoc = consumeToken(tok::kw_protocol);
DeclAttributes Attributes;
parseAttributeList(Attributes);
SourceLoc NameLoc = Tok.getLoc();
Identifier ProtocolName;
if (parseIdentifier(ProtocolName,
diag::expected_identifier_in_decl, "protocol"))
return 0;
TypeAliasDecl *TAD = ScopeInfo.addTypeAliasToScope(NameLoc, ProtocolName,
Type());
Type ProtocolType;
if (parseTypeProtocolBody(ProtocolLoc, Attributes, ProtocolType, TAD))
return 0;
return TAD;
}