mirror of
https://github.com/dart-lang/sdk
synced 2024-09-05 08:24:39 +00:00
8198 lines
410 KiB
TeX
8198 lines
410 KiB
TeX
\documentclass{article}
|
|
\usepackage{epsfig}
|
|
\usepackage{color}
|
|
\usepackage{dart}
|
|
\usepackage{bnf}
|
|
\usepackage{hyperref}
|
|
\usepackage{lmodern}
|
|
\usepackage[T1]{fontenc}
|
|
\newcommand{\code}[1]{{\sf #1}}
|
|
\title{Dart Programming Language Specification \\
|
|
{5th edition draft}\\
|
|
{\large Version 1.15.0}}
|
|
|
|
% For information about Location Markers (and in particular the
|
|
% commands \LMHash and \LMLabel), see the long comment at the
|
|
% end of this file.
|
|
|
|
% CHANGES
|
|
% =======
|
|
% Significant changes to the specification.
|
|
%
|
|
% 1.15
|
|
% - Change how language specification describes control flow.
|
|
% - Object initialization now specifies initialization order correctly.
|
|
% - Specifies that leaving an await-for loop must wait for the subscription
|
|
% to be canceled.
|
|
% - An await-for loop only pauses the subscription if it does something async.
|
|
% - Assert statements may now also include a "message" operand.
|
|
% - The Null type is now considered a subtype of all types in most cases.
|
|
% - Specify what NEWLINE means in multiline strings.
|
|
% - Specified the FutureOf type.
|
|
%
|
|
% 1.14
|
|
% - The call "C()" where "C" is a class name, is a now compile-time error.
|
|
% - Changed description of rewrites that depended on a function literal.
|
|
% In many cases, the rewrite wasn't safe for asynchronous code.
|
|
% - Removed generalized tear-offs.
|
|
% - Allow "rethrow" to also end a switch case. Allow braces around switch cases.
|
|
% - Allow using '=' as default-value separator for named parameters.
|
|
% - Make it a compile-time error if a library includes the same part twice.
|
|
% - Now more specific about the return types of sync*/async/async* functions
|
|
% in relation to return statements.
|
|
% - Allow Unicode surrogate values in String literals.
|
|
% - Make an initializing formal's value accessible in the initializer list.
|
|
% - Allow any expression in assert statements (was only conditionalExpression).
|
|
% - Allow trailing commas in argument and parameter lists.
|
|
%
|
|
% 1.11 - ECMA 408 - 4th Edition
|
|
% - Specify that potentially constant expressions must be valid expressions
|
|
% if the parameters are non-constant.
|
|
% - Make "??" a compile-time constant operator.
|
|
% - Having multiple unnamed libraries no longer causes warnings.
|
|
% - Specify null-aware operators for static methods.
|
|
%
|
|
% 1.10
|
|
% - Allow mixins to have super-classes and super-calls.
|
|
% - Specify static type checking for the implicit for-in iterator variable.
|
|
% - Specify static types for a number of expressions where it was missing.
|
|
% - Make calls on the exact type "Function" not cause warnings.
|
|
% - Specify null-aware behavior of "e?.v++" and similar expressions.
|
|
% - Specify that `package:` URIs are treated in an implementation dependent way.
|
|
% - Require warning if for-in is used on object with no "iterator" member.
|
|
%
|
|
% 1.9 - ECMA-408 - 3rd Edition
|
|
%
|
|
|
|
\begin{document}
|
|
\maketitle
|
|
\tableofcontents
|
|
|
|
|
|
\newpage
|
|
|
|
\pagestyle{myheadings}
|
|
\markright{Dart Programming Language Specification}
|
|
|
|
% begin Ecma boilerplate
|
|
\section{Scope}
|
|
\LMLabel{ecmaScope}
|
|
|
|
\LMHash{}
|
|
This Ecma standard specifies the syntax and semantics of the Dart programming language. It does not specify the APIs of the Dart libraries except where those library elements are essential to the correct functioning of the language itself (e.g., the existence of class \cd{Object} with methods such as \cd{noSuchMethod}, \cd{runtimeType}).
|
|
|
|
\section{Conformance}
|
|
\LMLabel{ecmaConformance}
|
|
|
|
\LMHash{}
|
|
A conforming implementation of the Dart programming language must provide and support all the APIs (libraries, types, functions, getters, setters, whether top-level, static, instance or local) mandated in this specification.
|
|
|
|
\LMHash{}
|
|
A conforming implementation is permitted to provide additional APIs, but not additional syntax, except for experimental features in support of null-aware cascades that are likely to be introduced in the next revision of this specification.
|
|
|
|
\section{Normative References}
|
|
\LMLabel{ecmaNormativeReferences}
|
|
|
|
\LMHash{}
|
|
The following referenced documents are indispensable for the application of this document. For dated references, only the edition cited applies. For undated references, the latest edition of the referenced document (including any amendments) applies.
|
|
|
|
\begin{enumerate}
|
|
\item
|
|
The Unicode Standard, Version 5.0, as amended by Unicode 5.1.0, or successor.
|
|
\item
|
|
Dart API Reference, https://api.dartlang.org/
|
|
\end{enumerate}
|
|
|
|
|
|
\section{Terms and Definitions}
|
|
\LMLabel{ecmaTermsAndDefinitions}
|
|
|
|
\LMHash{}
|
|
Terms and definitions used in this specification are given in the body of the specification proper. Such terms are highlighted in italics when they are introduced, e.g., `we use the term {\em verbosity} to refer to the property of excess verbiage'.
|
|
% End Ecma Boilerplate
|
|
|
|
|
|
\section{Notation}
|
|
\LMLabel{notation}
|
|
|
|
\LMHash{}
|
|
We distinguish between normative and non-normative text. Normative text defines the rules of Dart. It is given in this font. At this time, non-normative text includes:
|
|
\begin{itemize}
|
|
\item[Rationale] Discussion of the motivation for language design decisions appears in italics. \rationale{Distinguishing normative from non-normative helps clarify what part of the text is binding and what part is merely expository.}
|
|
\item[Commentary] Comments such as ``\commentary{The careful reader will have noticed that the name Dart has four characters}'' serve to illustrate or clarify the specification, but are redundant with the normative text. \commentary{The difference between commentary and rationale can be subtle.} \rationale{ Commentary is more general than rationale, and may include illustrative examples or clarifications. }
|
|
\item[Open questions] (\Q{in this font}). Open questions are points that are unsettled in the mind of the author(s) of the specification; expect them (the questions, not the authors; precision is important in a specification) to be eliminated in the final specification. \Q{Should the text at the end of the previous bullet be rationale or commentary?}
|
|
\end{itemize}
|
|
|
|
\LMHash{}
|
|
Reserved words and built-in identifiers (\ref{identifierReference}) appear in {\bf bold}.
|
|
|
|
\commentary{
|
|
Examples would be \SWITCH{} or \CLASS{}.
|
|
}
|
|
|
|
|
|
\LMHash{}
|
|
Grammar productions are given in a common variant of EBNF. The left hand side of a production ends with a colon. On the right hand side, alternation is represented by vertical bars, and sequencing by spacing. As in PEGs, alternation gives priority to the left. Optional elements of a production are suffixed by a question mark like so: \code{anElephant?}. Appending a star to an element of a production means it may be repeated zero or more times. Appending a plus sign to a production means it occurs one or more times. Parentheses are used for grouping. Negation is represented by prefixing an element of a production with a tilde. Negation is similar to the not combinator of PEGs, but it consumes input if it matches. In the context of a lexical production it consumes a single character if there is one; otherwise, a single token if there is one.
|
|
|
|
\commentary{ An example would be:}
|
|
|
|
\begin{grammar}
|
|
{\sf
|
|
{\bf AProduction:}AnAlternative;
|
|
AnotherAlternative;
|
|
OneThing After Another;
|
|
ZeroOrMoreThings*;
|
|
OneOrMoreThings+;
|
|
AnOptionalThing?;
|
|
(Some Grouped Things);
|
|
\~{}NotAThing;
|
|
A\_LEXICAL\_THING
|
|
.
|
|
}
|
|
\end{grammar}
|
|
|
|
% need a match anything or a production that does that, so we can correct bugs wrt use
|
|
% ~. ~ does not actually parse stuff - it just looks ahead and checks. To get the effect of
|
|
% parsing anything but X, one needs ~X ANYTHING, not just ~X. There are bugs in the
|
|
% grammar related to this.
|
|
% The alternative is to define ~X as anything but X, or to introduce an anythingBut(X)
|
|
% combinator, such as !X
|
|
|
|
\LMHash{}
|
|
Both syntactic and lexical productions are represented this way. Lexical productions are distinguished by their names. The names of lexical productions consist exclusively of upper case characters and underscores. As always, within grammatical productions, whitespace and comments between elements of the production are implicitly ignored unless stated otherwise.
|
|
Punctuation tokens appear in quotes.
|
|
|
|
\LMHash{}
|
|
Productions are embedded, as much as possible, in the discussion of the constructs they represent.
|
|
|
|
\LMHash{}
|
|
A list $x_1, \ldots, x_n$ denotes any list of $n$ elements of the form $x_i, 1 \le i \le n$. Note that $n$ may be zero, in which case the list is empty. We use such lists extensively throughout this specification.
|
|
|
|
\LMHash{}
|
|
The notation $[x_1, \ldots, x_n/y_1, \ldots, y_n]E$ denotes a copy of $E$ in which all occurrences of $y_i, 1 \le i \le n$ have been replaced with $x_i$.
|
|
|
|
\LMHash{}
|
|
We sometimes abuse list or map literal syntax, writing $[o_1, \ldots, o_n]$ (respectively $\{k_1: o_1, \ldots, k_n: o_n\}$) where the $o_i$ and $k_i$ may be objects rather than expressions. The intent is to denote a list (respectively map) object whose elements are the $o_i$ (respectively, whose keys are the $k_i$ and values are the $o_i$).
|
|
|
|
\LMHash{}
|
|
The specifications of operators often involve statements such as $x$ $op$ $y$ is equivalent to the method invocation $x.op(y)$. Such specifications should be understood as a shorthand for:
|
|
\begin{itemize}
|
|
\item
|
|
$x$ $op$ $y$ is equivalent to the method invocation $x.op^\prime(y)$, assuming the class of $x$ actually declared a non-operator method named $op^\prime$ defining the same function as the operator $op$.
|
|
\end{itemize}
|
|
|
|
\rationale{This circumlocution is required because x.op(y), where op is an operator, is not legal syntax. However, it is painfully verbose, and we prefer to state this rule once here, and use a concise and clear notation across the specification.
|
|
}
|
|
|
|
\LMHash{}
|
|
When the specification refers to the order given in the program, it means the order of the program source code text, scanning left-to-right and top-to-bottom.
|
|
|
|
\LMHash{}
|
|
When the specification refers to a {\em fresh variable}, it means a variable with a name that doesn't occur anywhere in the current program.
|
|
When the specification introduces a fresh variable bound to a value, the fresh variable is implicitly bound in a surrounding scope.
|
|
|
|
\LMHash{}
|
|
References to otherwise unspecified names of program entities (such as classes or functions) are interpreted as the names of members of the Dart core library.
|
|
|
|
\commentary{
|
|
Examples would be the classes \code{Object} and \code{Type} representing the root of the class hierarchy and the reification of runtime types respectively.
|
|
}
|
|
|
|
\section{Overview}
|
|
\LMLabel{overview}
|
|
|
|
\LMHash{}
|
|
Dart is a class-based, single-inheritance, pure object-oriented programming language. Dart is optionally typed (\ref{types}) and supports reified generics. The run-time type of every object is represented as an instance of class \code{Type} which can be obtained by calling the getter \code{runtimeType} declared in class \code{Object}, the root of the Dart class hierarchy.
|
|
|
|
\LMHash{}
|
|
Dart programs may be statically checked. The static checker will report some violations of the type rules, but such violations do not abort compilation or preclude execution.
|
|
|
|
\LMHash{}
|
|
Dart programs may be executed in one of two modes: production mode or checked mode. In production mode, static type annotations (\ref{staticTypes}) have absolutely no effect on execution with the exception of reflection and structural type tests.
|
|
|
|
\commentary{
|
|
Reflection, by definition, examines the program structure. If we provide reflective access to the type of a declaration, or to source code, it will inevitably produce results that depend on the types used in the underlying code.
|
|
|
|
Type tests also examine the types in a program explicitly. Nevertheless, in most cases, these will not depend on type annotations. The exceptions to this rule are type tests involving function types. Function types are structural, and so depend on the types declared for their parameters and on their return types.
|
|
}
|
|
|
|
\LMHash{}
|
|
In checked mode, assignments are dynamically checked, and certain violations of the type system throw exceptions at run time.
|
|
|
|
\commentary{
|
|
The coexistence between optional typing and reification is based on the following:
|
|
\begin{enumerate}
|
|
\item Reified type information reflects the types of objects at runtime and may always be queried by dynamic typechecking constructs (the analogs of instanceOf, casts, typecase etc. in other languages). Reified type information includes class declarations, the runtime type (aka class) of an object, and type arguments to constructors.
|
|
\item Static type annotations determine the types of variables and function declarations (including methods and constructors).
|
|
\item Production mode respects optional typing. Static type annotations do not affect runtime behavior.
|
|
\item Checked mode utilizes static type annotations and dynamic type information aggressively yet selectively to provide early error detection during development.
|
|
\end{enumerate}
|
|
}
|
|
|
|
\LMHash{}
|
|
Dart programs are organized in a modular fashion into units called {\em libraries} (\ref{librariesAndScripts}). Libraries are units of encapsulation and may be mutually recursive.
|
|
|
|
\commentary{However they are not first class. To get multiple copies of a library running simultaneously, one needs to spawn an isolate.
|
|
}
|
|
|
|
\subsection{Scoping}
|
|
\LMLabel{scoping}
|
|
|
|
\LMHash{}
|
|
A {\em namespace} is a mapping of names denoting declarations to actual declarations. Let $NS$ be a namespace. We say that a name $n$ {\em is in }$NS$ if $n$ is a key of $NS$. We say a declaration $d$ {\em is in }$NS$ if a key of $NS$ maps to $d$.
|
|
|
|
\LMHash{}
|
|
A scope $S_0$ induces a namespace $NS_0$ that maps the simple name of each variable, type or function declaration $d$ declared in $S_0$ to $d$. Labels are not included in the induced namespace of a scope; instead they have their own dedicated namespace.
|
|
|
|
\commentary{
|
|
It is therefore impossible, e.g., to define a class that declares a method and a getter with the same name in Dart.
|
|
Similarly one cannot declare a top-level function with the same name as a library variable or a class.
|
|
}
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if there is more than one entity with the same name declared in the same scope.
|
|
|
|
\commentary{
|
|
In some cases, the name of the declaration differs from the identifier used to declare it. Setters have names that are distinct from the corresponding getters because they always have an = automatically added at the end, and unary minus has the special name unary-.
|
|
}
|
|
|
|
\LMHash{}
|
|
Dart is lexically scoped. Scopes may nest. A name or declaration $d$ is {\em available in scope} $S$ if $d$ is in the namespace induced by $S$ or if $d$ is available in the lexically enclosing scope of $S$. We say that a name or declaration $d$ is {\em in scope} if $d$ is available in the current scope.
|
|
|
|
|
|
\LMHash{}
|
|
If a declaration $d$ named $n$ is in the namespace induced by a scope $S$, then $d$ {\em hides} any declaration named $n$ that is available in the lexically enclosing scope of $S$.
|
|
|
|
\commentary {
|
|
A consequence of these rules is that it is possible to hide a type with a method or variable.
|
|
Naming conventions usually prevent such abuses. Nevertheless,the following program is legal:
|
|
}
|
|
|
|
\begin{dartCode}
|
|
\CLASS{} HighlyStrung \{
|
|
String() => "?";
|
|
\}
|
|
\end{dartCode}
|
|
|
|
\LMHash{}
|
|
Names may be introduced into a scope by declarations within the scope or by other mechanisms such as imports or inheritance.
|
|
|
|
\rationale{
|
|
The interaction of lexical scoping and inheritance is a subtle one. Ultimately, the question is whether lexical scoping takes precedence over inheritance or vice versa. Dart chooses the former.
|
|
|
|
Allowing inherited names to take precedence over locally declared names can create unexpected situations as code evolves. Specifically, the behavior of code in a subclass can change without warning if a new name is introduced in a superclass. Consider:
|
|
}
|
|
|
|
\begin{dartCode}
|
|
\LIBRARY{} L1;
|
|
\CLASS{} S \{\}
|
|
|
|
\LIBRARY{} L2;
|
|
\IMPORT{} `L1.dart';
|
|
foo() => 42;
|
|
\CLASS{} C \EXTENDS{} S\{ bar() => foo();\}
|
|
\end{dartCode}
|
|
|
|
\rationale{Now assume a method \code{foo()} is added to \code{S}. }
|
|
|
|
\begin{dartCode}
|
|
\LIBRARY{} L1;
|
|
\CLASS{} S \{foo() => 91;\}
|
|
\end{dartCode}
|
|
|
|
\rationale{
|
|
If inheritance took precedence over the lexical scope, the behavior of \code{C} would change in an unexpected way. Neither the author of \code{S} nor the author of \code{C} are necessarily aware of this. In Dart, if there is a lexically visible method \code{foo()}, it will always be called.
|
|
|
|
Now consider the opposite scenario. We start with a version of \code{S} that contains \code{foo()}, but do not declare \code{foo()} in library \code{L2}. Again, there is a change in behavior - but the author of \code{L2} is the one who introduced the discrepancy that effects their code, and the new code is lexically visible. Both these factors make it more likely that the problem will be detected.
|
|
|
|
These considerations become even more important if one introduces constructs such as nested classes, which might be considered in future versions of the language.
|
|
|
|
Good tooling should of course endeavor to inform programmers of such situations (discreetly). For example, an identifier that is both inherited and lexically visible could be highlighted (via underlining or colorization). Better yet, tight integration of source control with language aware tools would detect such changes when they occur.
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
\subsection{Privacy}
|
|
\LMLabel{privacy}
|
|
|
|
\LMHash{}
|
|
Dart supports two levels of privacy: {\em public} and {\em private}. A declaration is {\em private} iff its name is private, otherwise it is {\em public.} A name $q$ is private iff any one of the identifiers that comprise $q$ is private, otherwise it is {\em public.} An identifier is private iff it
|
|
begins with an underscore (the \_ character) otherwise it is {\em public.}
|
|
|
|
\LMHash{}
|
|
A declaration $m$ is {\em accessible to library $L$} if $m$ is declared in $L$ or if $m$ is public.
|
|
|
|
\commentary{
|
|
This means private declarations may only be accessed within the library in which they are declared.
|
|
}
|
|
|
|
\LMHash{}
|
|
Privacy applies only to declarations within a library, not to library declarations themselves.
|
|
|
|
\rationale{Libraries do not reference each other by name and so the idea of a private library is meaningless.
|
|
Thus, if the name of a library begins with an underscore, it has no effect on the accessibility of the library or its members.
|
|
}
|
|
|
|
\rationale{Privacy is, at this point, a static notion tied to a particular piece of code (a library). It is designed to support software engineering concerns rather than security concerns. Untrusted code should always run in an another isolate. It is possible that libraries will become first class objects and privacy will be a dynamic notion tied to a library instance.
|
|
|
|
Privacy is indicated by the name of a declaration - hence privacy and naming are not orthogonal. This has the advantage that both humans and machines can recognize access to private declarations at the point of use without knowledge of the context from which the declaration is derived.}
|
|
|
|
\subsection{Concurrency}
|
|
\LMLabel{concurrency}
|
|
|
|
\LMHash{}
|
|
Dart code is always single threaded. There is no shared-state concurrency in Dart. Concurrency is supported via actor-like entities called {\em isolates}.
|
|
|
|
\LMHash{}
|
|
An isolate is a unit of concurrency. It has its own memory and its own thread of control. Isolates communicate by message passing (\ref{sendingMessages}). No state is ever shared between isolates. Isolates are created by spawning (\ref{spawningAnIsolate}).
|
|
|
|
|
|
\section{Errors and Warnings}
|
|
\LMLabel{errorsAndWarnings}
|
|
|
|
\LMHash{}
|
|
This specification distinguishes between several kinds of errors.
|
|
|
|
\LMHash{}
|
|
{\em Compile-time errors} are errors that preclude execution. A compile-time error must be reported by a Dart compiler before the erroneous code is executed.
|
|
|
|
\rationale{A Dart implementation has considerable freedom as to when compilation takes place. Modern programming language implementations often interleave compilation and execution, so that compilation of a method may be delayed, e.g., until it is first invoked. Consequently, compile-time errors in a method $m$ may be reported as late as the time of $m$'s first invocation.
|
|
|
|
As a web language, Dart is often loaded directly from source, with no intermediate binary representation. In the interests of rapid loading, Dart implementations may choose to avoid full parsing of method bodies, for example. This can be done by tokenizing the input and checking for balanced curly braces on method body entry. In such an implementation, even syntax errors will be detected only when the method needs to be executed, at which time it will be compiled (JITed).
|
|
|
|
In a development environment a compiler should of course report compilation errors eagerly so as to best serve the programmer.
|
|
}
|
|
|
|
\LMHash{}
|
|
If an uncaught compile-time error occurs within the code of a running isolate $A$, $A$ is immediately suspended. The only circumstance where a compile-time error could be caught would be via code run reflectively, where the mirror system can catch it.
|
|
|
|
\rationale{Typically, once a compile-time error is thrown and $A$ is suspended, $A$ will then be terminated. However, this depends on the overall environment.
|
|
A Dart engine runs in the context of an {\em embedder},
|
|
a program that interfaces between the engine and the surrounding computing environment. The embedder will often be a web browser, but need not be; it may be a C++ program on the server for example. When an isolate fails with a compile-time error as described above, control returns to the embedder, along with an exception describing the problem. This is necessary so that the embedder can clean up resources etc. It is then the embedder's decision whether to terminate the isolate or not.
|
|
}
|
|
|
|
\LMHash{}
|
|
{\em Static warnings} are those errors reported by the static checker. They have no effect on execution. Many, but not all, static warnings relate to types, in which case they are known as {\em static type warnings.} Static warnings must be provided by Dart compilers used during development such as those incorporated in IDEs or otherwise intended to be used by developers for developing code. Compilers that are part of runtime execution environments such as virtual machines should not issue static warnings.
|
|
|
|
\LMHash{}
|
|
{\em Dynamic type errors} are type errors reported in checked mode.
|
|
|
|
\LMHash{}
|
|
{\em Run-time errors} are exceptions thrown during execution. Whenever we say that an exception $ex$ is {\em thrown}, it acts like an expression had {\em thrown} (\ref{completion}) with $ex$ as exception object and with a stack trace corresponding to the current system state. When we say that {\em a} $C$ {\em is thrown}, where $C$ is a class, we mean that an instance of class $C$ is thrown.
|
|
|
|
\LMHash{}
|
|
If an uncaught exception is thrown by a running isolate $A$, $A$ is immediately suspended.
|
|
|
|
\section{Variables}
|
|
\LMLabel{variables}
|
|
|
|
\LMHash{}
|
|
Variables are storage locations in memory.
|
|
|
|
\begin{grammar}
|
|
{\bf variableDeclaration:}
|
|
declaredIdentifier (`,' identifier)*
|
|
.
|
|
|
|
{\bf declaredIdentifier:}
|
|
metadata finalConstVarOrType identifier
|
|
.
|
|
|
|
{\bf finalConstVarOrType:}\FINAL{} type?;
|
|
\CONST{} type?;
|
|
varOrType
|
|
.
|
|
|
|
{\bf varOrType:}\VAR{};
|
|
type
|
|
.
|
|
|
|
{\bf initializedVariableDeclaration:}
|
|
declaredIdentifier (`=' expression)? (`,' initializedIdentifier)* % could do top level here
|
|
.
|
|
|
|
{\bf initializedIdentifier:}
|
|
identifier (`=' expression)? % could do top-level here
|
|
.
|
|
|
|
{\bf initializedIdentifierList:}
|
|
initializedIdentifier (`,' initializedIdentifier)*
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
A variable that has not been initialized has the initial value \NULL{} (\ref{null}).
|
|
|
|
\LMHash{}
|
|
A variable declared at the top-level of a library is referred to as either a {\em library variable} or simply a top-level variable.
|
|
|
|
\LMHash{}
|
|
A {\em static variable} is a variable that is not associated with a particular instance, but rather with an entire library or class. Static variables include library variables and class variables. Class variables are variables whose declaration is immediately nested inside a class declaration and includes the modifier \STATIC{}. A library variable is implicitly static. It is a compile-time error to preface a top-level variable declaration with the built-in identifier (\ref{identifierReference}) \STATIC{}.
|
|
|
|
\LMHash{}
|
|
Static variable declarations are initialized lazily. When a static variable $v$ is read, iff it has not yet been assigned, it is set to the result of evaluating its initializer. The precise rules are given in section \ref{evaluationOfImplicitVariableGetters}.
|
|
|
|
\rationale{The lazy semantics are given because we do not want a language where one tends to define expensive initialization computations, causing long application startup times. This is especially crucial for Dart, which must support the coding of client applications.
|
|
}
|
|
|
|
\LMHash{}
|
|
A {\em final variable} is a variable whose binding is fixed upon initialization; a final variable $v$ will always refer to the same object after $v$ has been initialized. The declaration of a final variable must include the modifier \FINAL{}.
|
|
|
|
\LMHash{}
|
|
It is a static warning if a final instance variable that has been initialized at its point of declaration is also initialized in a constructor.
|
|
% It is a static warning if a final instance variable that has been initialized by means of an initializing formal of a constructor is also initialized elsewhere in the same constructor.
|
|
It is a compile-time error if a local variable $v$ is final and $v$ is not initialized at its point of declaration.
|
|
|
|
\commentary{
|
|
|
|
A library or static variable is guaranteed to have an initializer at its declaration by the grammar.
|
|
|
|
Attempting to assign to a final variable anywhere except in its declaration or in a constructor header will cause a runtime error to be thrown as discussed below. The assignment will also give rise to a static warning. Any repeated assignment to a final variable will also lead to a runtime error.
|
|
|
|
Taken as a whole, the rules ensure that any attempt to execute multiple assignments to a final variable will yield static warnings and repeated assignments will fail dynamically.
|
|
}
|
|
|
|
\LMHash{}
|
|
A {\em constant variable} is a variable whose declaration includes the modifier \CONST{}. A constant variable is always implicitly final. A constant variable must be initialized to a compile-time constant (\ref{constants}) or a compile-time error occurs.
|
|
|
|
\LMHash{}
|
|
We say that a variable $v$ is {\em potentially mutated} in some scope $s$ if $v$ is not final or constant and an assignment to $v$ occurs in $s$.
|
|
|
|
\LMHash{}
|
|
If a variable declaration does not explicitly specify a type, the type of the declared variable(s) is \DYNAMIC{}, the unknown type (\ref{typeDynamic}).
|
|
|
|
\LMHash{}
|
|
A variable is {\em mutable} if it is not final.
|
|
Static and instance variable declarations always induce implicit getters. If the variable is mutable it also introduces an implicit setter.
|
|
The scope into which the implicit getters and setters are introduced depends on the kind of variable declaration involved.
|
|
|
|
\LMHash{}
|
|
A library variable introduces a getter into the top level scope of the enclosing library. A static class variable introduces a static getter into the immediately enclosing class. An instance variable introduces an instance getter into the immediately enclosing class.
|
|
|
|
\LMHash{}
|
|
A mutable library variable introduces a setter into the top level scope of the enclosing library. A mutable static class variable introduces a static setter into the immediately enclosing class. A mutable instance variable introduces an instance setter into the immediately enclosing class.
|
|
|
|
\LMHash{}
|
|
Local variables are added to the innermost enclosing scope. They do not induce getters and setters. A local variable may only be referenced at a source code location that is after its initializer, if any, is complete, or a compile-time error occurs. The error may be reported either at the point where the premature reference occurs, or at the variable declaration.
|
|
|
|
\rationale {
|
|
We allow the error to be reported at the declaration to allow implementations to avoid an extra processing phase.
|
|
}
|
|
|
|
\commentary{
|
|
The example below illustrates the expected behavior. A variable $x$ is declared at the library level, and another $x$ is declared inside the function $f$.
|
|
}
|
|
|
|
\begin{dartCode}
|
|
\VAR{} x = 0;
|
|
|
|
f(y) \{
|
|
\VAR{} z = x; // compile-time error
|
|
if (y) \{
|
|
x = x + 1; // two compile time errors
|
|
print(x); // compile time error
|
|
\}
|
|
\VAR{} x = x++; // compile time error
|
|
print(x);
|
|
\}
|
|
\end{dartCode}
|
|
|
|
\commentary{
|
|
The declaration inside $f$ hides the enclosing one. So all references to $x$ inside $f$ refer to the inner declaration of $x$. However, many of these references are illegal, because they appear before the declaration. The assignment to $z$ is one such case. The assignment to $x$ in the \IF{} statement suffers from multiple problems. The right hand side reads $x$ before its declaration, and the left hand side assigns to $x$ before its declaration. Each of these are, independently, compile time errors. The print statement inside the \IF{} is also illegal.
|
|
|
|
The inner declaration of $x$ is itself erroneous because its right hand side attempts to read $x$ before the declaration has terminated. The left hand side is not, technically, a reference or an assignment but a declaration and so is legal. The last print statement is perfectly legal as well.
|
|
}
|
|
|
|
\commentary {
|
|
As another example \code{\VAR{} x = 3, y = x;} is legal, because \code{x} is referenced after its initializer.
|
|
|
|
A particularly perverse example involves a local variable name shadowing a type. This is possible because Dart has a single namespace for types, functions and variables.
|
|
}
|
|
|
|
\begin{dartCode}
|
|
\CLASS{} C \{\}
|
|
perverse() \{
|
|
\VAR{} v = \NEW{} C(); // compile-time error
|
|
C aC; // compile-time error
|
|
\VAR{} C = 10;
|
|
\}
|
|
|
|
\commentary {
|
|
Inside \cd{perverse()}, \cd{C} denotes a local variable. The type \cd{C} is hidden by the variable of the same name. The attempt to instantiate \cd{C} causes a compile-time error because it references a local variable prior to its declaration. Similarly, for the declaration of \cd{aC} (even though it is only a type annotation).
|
|
}
|
|
|
|
\rationale{
|
|
As a rule, type annotations are ignored in production mode. However, we do
|
|
not want to allow programs to compile legally in one mode and not another, and in this extremely odd situation, that consideration takes precedence.
|
|
}
|
|
|
|
\end{dartCode}
|
|
|
|
% the grammar does not support local getters and setters. The local var discussion does not seem to mention getters and setters based semantics. It simply discusses the creation of the variable, not its access. Access is either assignment or identifiers. Identifiers ignore the getter story.
|
|
|
|
\LMHash{}
|
|
The following rules apply to all static and instance variables.
|
|
|
|
\LMHash{}
|
|
A variable declaration of one of the forms \code{$T$ $v$;}, \code{$T$ $v$ = $e$;} , \code{\CONST{} $T$ $v$ = $e$;}, \code{\FINAL{} $T$ $v$;} or \code{\FINAL{} $T$ $v$ = $e$;} always induces an implicit getter function (\ref{getters}) with signature
|
|
|
|
$T$ \GET{} $v$
|
|
|
|
whose invocation evaluates as described below (\ref{evaluationOfImplicitVariableGetters}).
|
|
|
|
|
|
\LMHash{}
|
|
A variable declaration of one of the forms \code{\VAR{} $v$;}, \code{\VAR{} $v$ = $e$;} , \code{\CONST{} $v$ = $e$;}, \code{\FINAL{} $v$;} or \code{\FINAL{} $v$ = $e$;} always induces an implicit getter function with signature
|
|
|
|
\GET{} $v$
|
|
|
|
whose invocation evaluates as described below (\ref{evaluationOfImplicitVariableGetters}).
|
|
|
|
\LMHash{}
|
|
A non-final variable declaration of the form \code{{} $T$ $v$;} or the form \code{$T$ $v$ = $e$;} always induces an implicit setter function (\ref{setters}) with signature
|
|
|
|
\VOID{} \SET{} $v=(T$ $x)$
|
|
|
|
whose execution sets the value of $v$ to the incoming argument $x$.
|
|
|
|
\LMHash{}
|
|
A non-final variable declaration of the form \code{\VAR{} $v$;} or the form \code{\VAR{} $v$ = $e$;} always induces an implicit setter function with signature
|
|
|
|
\SET{} $v=(x)$
|
|
|
|
whose execution sets the value of $v$ to the incoming argument $x$.
|
|
|
|
|
|
\subsection{Evaluation of Implicit Variable Getters}
|
|
\LMLabel{evaluationOfImplicitVariableGetters}
|
|
|
|
\LMHash{}
|
|
Let $d$ be the declaration of a static or instance variable $v$. If $d$ is an instance variable, then the invocation of the implicit getter of $v$ evaluates to the value stored in $v$.
|
|
If $d$ is a static or library variable then the implicit getter method of $v$ executes as follows:
|
|
\begin{itemize}
|
|
\item {\bf Non-constant variable declaration with initializer}. If $d$ is of one of the forms \code{\VAR{} $v$ = $e$;} , \code{$T$ $v$ = $e$;} , \code{\FINAL{} $v$ = $e$;} , \code{\FINAL{} $T$ $v$ = $e$;}, \code{\STATIC{} $v$ = $e$; }, \code{\STATIC{} $T$ $v$ = $e$; }, \code{\STATIC{} \FINAL{} $v$ = $e$; } or \code{\STATIC{} \FINAL{} $T$ $v$ = $e$;} and no value has yet been stored into $v$ then the initializer expression $e$ is evaluated. If, during the evaluation of $e$, the getter for $v$ is invoked, a \code{CyclicInitializationError} is thrown. If the evaluation succeeded yielding an object $o$, let $r = o$, otherwise let $r = \NULL{}$. In any case, $r$ is stored into $v$. The result of executing the getter is $r$.
|
|
\item {\bf Constant variable declaration}. If $d$ is of one of the forms \code{\CONST{} $v$ = $e$; } , \code{\CONST{} $T$ $v$ = $e$; }, \code{\STATIC{} \CONST{} $v$ = $e$; } or \code{\STATIC{} \CONST{} $T$ $v$ = $e$;} the result of the getter is the value of the compile time constant $e$. \commentary{Note that a compile time constant cannot depend on itself, so no cyclic references can occur.}
|
|
Otherwise
|
|
\item {\bf Variable declaration without initializer}. The result of executing the getter method is the value stored in $v$.
|
|
\end{itemize}
|
|
|
|
|
|
|
|
|
|
|
|
\section{Functions}
|
|
\LMLabel{functions}
|
|
|
|
\LMHash{}
|
|
Functions abstract over executable actions.
|
|
|
|
\begin{grammar}
|
|
{\bf functionSignature:}
|
|
metadata returnType? identifier formalParameterList
|
|
.
|
|
|
|
{\bf returnType:}
|
|
\VOID{};
|
|
type
|
|
.
|
|
|
|
{\bf functionBody:} \ASYNC{}? `={\escapegrammar \gt}' expression `{\escapegrammar ;}';
|
|
(\ASYNC{} $|$ \ASYNC* $|$ \SYNC*)? block
|
|
.
|
|
|
|
{\bf block:}
|
|
`\{' statements `\}'
|
|
.
|
|
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
Functions include function declarations (\ref{functionDeclarations}), methods (\ref{instanceMethods}, \ref{staticMethods}), getters (\ref{getters}), setters (\ref{setters}), constructors (\ref{constructors}) and function literals (\ref{functionExpressions}).
|
|
|
|
\LMHash{}
|
|
All functions have a signature and a body. The signature describes the formal parameters of the function, and possibly its name and return type. A function body is either:
|
|
\begin{itemize}
|
|
\item A block statement (\ref{blocks}) containing the statements (\ref{statements}) executed by the function, optionally marked with one of the modifiers: \ASYNC, \ASYNC* or \SYNC*.
|
|
|
|
\commentary{
|
|
Because Dart is optionally typed, we cannot guarantee that a function that does not return a value will not be used in the context of an expression. Therefore, every function must return a value. A function body that ends without doing a throw or return will cause the function to return \NULL{}, as will a \RETURN{} without an expression. For generator functions, the situation is more subtle. See further discussion in section \ref{return}.
|
|
}
|
|
|
|
OR
|
|
\item of the form \code{=> $e$} or the form \code{\ASYNC{} => $e$}, which both return the value of the expression $e$ as if by a \code{return $e$}. \commentary{The other modifiers do not apply here, because they apply only to generators, discussed below, and generators do not allow to return a value, values are added to the generated stream or iterable using \YIELD{} instead.}
|
|
Let $R$ be the static type of $e$
|
|
and let $T$ be the actual return type (\ref{actualTypeOfADeclaration})
|
|
of the function that has this body.
|
|
It is a static warning if $T$ is not \VOID{} and either
|
|
the function is synchronous and the static type of $R$ is not assignable to $T$,
|
|
or the function is asynchronous and \code{Future<$flatten${$R$}>}
|
|
is not assignable to $T$.
|
|
|
|
\end{itemize}
|
|
|
|
\LMHash{}
|
|
A function is {\em asynchronous} if its body is marked with the \ASYNC{} or \ASYNC* modifier. Otherwise the function is {\em synchronous}. A function is a {\em generator} if its body is marked with the \SYNC* or \ASYNC* modifier.
|
|
|
|
\commentary{
|
|
Whether a function is synchronous or asynchronous is orthogonal to whether it is a generator or not. Generator functions are a sugar for functions that produce collections in a systematic way, by lazily applying a function that {\em generates} individual elements of a collection. Dart provides such a sugar in both the synchronous case, where one returns an iterable, and in the asynchronous case, where one returns a stream. Dart also allows both synchronous and asynchronous functions that produce a single value.
|
|
}
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if an \ASYNC, \ASYNC* or \SYNC* modifier is attached to the body of a setter or constructor.
|
|
|
|
\rationale{
|
|
An asynchronous setter would be of little use, since setters can only be used in the context of an assignment (\ref{assignment}), and an assignment expression always evaluates to the value of the assignment's right hand side. If the setter actually did its work asynchronously, one might imagine that one would return a future that resolved to the assignment's right hand side after the setter did its work. However, this would require dynamic tests at every assignment, and so would be prohibitively expensive.
|
|
|
|
An asynchronous constructor would, by definition, never return an instance of the class it purports to construct, but instead return a future. Calling such a beast via \NEW{} would be very confusing. If you need to produce an object asynchronously, use a method.
|
|
|
|
One could allow modifiers for factories. A factory for \code{Future} could be modified by \ASYNC{}, a factory for \code{Stream} could be modified by \ASYNC* and a factory for \code{Iterable} could be modified by \SYNC*. No other scenario makes sense because the object returned by the factory would be of the wrong type. This situation is very unusual so it is not worth making an exception to the general rule for constructors in order to allow it.
|
|
}
|
|
\LMHash{}
|
|
It is a static warning if the declared return type of a function marked \ASYNC{} is not a supertype of \code{Future<\mbox{$T$}>} for some type $T$.
|
|
It is a static warning if the declared return type of a function marked \SYNC* is not a supertype of \code{Iterable<\mbox{$T$}>} for some type $T$.
|
|
It is a static warning if the declared return type of a function marked \ASYNC* is not a supertype of \code{Stream<\mbox{$T$}>} for some type $T$.
|
|
|
|
\subsection{Function Declarations}
|
|
\LMLabel{functionDeclarations}
|
|
|
|
\LMHash{}
|
|
A {\em function declaration} is a function that is neither a member of a class nor a function literal. Function declarations include {\em library functions}, which are function declarations
|
|
%(including getters and setters)
|
|
at the top level of a library, and {\em local functions}, which are function declarations declared inside other functions. Library functions are often referred to simply as top-level functions.
|
|
|
|
\LMHash{}
|
|
A function declaration consists of an identifier indicating the function's name, possibly prefaced by a return type. The function name is followed by a signature and body. For getters, the signature is empty. The body is empty for functions that are external.
|
|
|
|
\LMHash{}
|
|
The scope of a library function is the scope of the enclosing library. The scope of a local function is described in section \ref{localFunctionDeclaration}. In both cases, the name of the function is in scope in its formal parameter scope (\ref{formalParameters}).
|
|
|
|
%A function declaration of the form $T_0$ $id(T_1$ $a_1, \ldots, T_n$ $a_n, [T_{n+1}$ $x_{n+1} = d_1, \ldots, T_{n+k}$ $x_{n+k} = d_k])\{s\}$ is equivalent to a variable declaration of the form \code{\FINAL{} $F$ $id$ = $(T_1$ $a_1, \ldots, T_n$ $a_n, [T_{n+1}$ $x_{n+1} = d_1, \ldots, T_{n+k}$ $x_{n+k}= d_k])\{s\}$}, where $F$ is the function type alias (\ref{typedef}) \code{\TYPEDEF{} $T_0$ $F(T_1$ $a_1, \ldots, T_n$ $a_n, [T_{n+1}$ $x_{n+1}, \ldots, T_{n+k}$ $x_{n+k}])$}. Likewise, a function declaration of the form $id(T_1$ $a_1, \ldots, T_n$ $a_n, [T_{n+1}$ $x_{n+1} = d_1, \ldots, T_{n+k}$ $x_{n+k} = d_k])\{s\}$ is equivalent to a variable declaration of the form \code{\FINAL{} $F$ $id$ = $(T_1$ $a_1, \ldots, T_n$ $a_n, [T_{n+1}$ $x_{n+1} = d_1, \ldots, T_{n+k}$ $x_{n+k} = d_k])\{s\}$}, where $F$ is the function type alias \code{\TYPEDEF{} $F(T_1$ $a_1, \ldots, T_n$ $a_n, [T_{n+1}$ $x_{n+1}, \ldots, T_{n+k}$ $x_{n+k}])$}.
|
|
|
|
%\Q{We need to cover library getters as well.}
|
|
|
|
%\Q{ The definition in terms of variables is untrue, because the code would be illegal. The initializer cannot refer to the function name in this case. I believe the best fix is to relax this
|
|
%requirement in the case of closures. See bug 315.
|
|
%}
|
|
|
|
%\commentary{
|
|
%Some obvious conclusions:
|
|
|
|
%A function declaration of the form $id(T_1$ $a_1, \ldots, T_n$ $a_n, [T_{n+1}$ $x_{n+1} = d_1, \ldots, T_{n+k}$ $x_{n+k} = d_k]) => e$ is equivalent to a variable declaration of the form \code{\FINAL{} $id$ = ($(T_1$ $a_1, \ldots, T_n$ $a_n, [T_{n+1}$ $x_{n+1} = d_1, \ldots, T_{n+k}$ $x_{n+k} = d_k])=> e$}.
|
|
|
|
%A function literal of the form $(T_1$ $a_1, \ldots, T_n$ $a_n, [T_{n+1}$ $x_{n+1} = d_1, \ldots, T_{n+k}$ $x_{n+k} = d_k]) => e$ is equivalent to a function literal of the form \code{$(T_1$ $a_1, \ldots, T_n$ $a_n, [T_{n+1}$ $x_{n+1} = d_1, \ldots, T_{n+k}$ $x_{n+k} = d_k])\{$ \RETURN{} $e$;\}}.
|
|
%}
|
|
|
|
%A function declaration of the form $T_0$ $id(T_1$ $a_1, \ldots, T_n$ $a_n, \{T_{n+1}$ $x_{n+1} : d_1, \ldots, T_{n+k}$ $x_{n+k} : d_k\})\{s\}$ is equivalent to a variable declaration of the form \code{\FINAL{} $F$ $id$ = $(T_1$ $a_1, \ldots, T_n$ $a_n, \{T_{n+1}$ $x_{n+1} : d_1, \ldots, T_{n+k}$ $x_{n+k} : d_k\})\{s\}$}, where $F$ is the function type alias (\ref{typedef}) \code{\TYPEDEF{} $T_0$ $F(T_1$ $a_1, \ldots, T_n$ $a_n, \{T_{n+1}$ $x_{n+1}, \ldots, T_{n+k}$ $x_{n+k}]\}$}. Likewise, a function declaration of the form $id(T_1$ $a_1, \ldots, T_n$ $a_n, \{T_{n+1}$ $x_{n+1} : d_1, \ldots, T_{n+k}$ $x_{n+k} : d_k\})\{s\}$ is equivalent to a variable declaration of the form \code{\FINAL{} $F$ $id$ = $(T_1$ $a_1, \ldots, T_n$ $a_n, \{T_{n+1}$ $x_{n+1} : d_1, \ldots, T_{n+k}$ $x_{n+k} : d_k\})\{s\}$}, where $F$ is the function type alias \code{\TYPEDEF{} $F(T_1$ $a_1, \ldots, T_n$ $a_n, \{T_{n+1}$ $x_{n+1}, \ldots, T_{n+k}$ $x_{n+k}\})$}.
|
|
|
|
\LMHash{}
|
|
It is a compile-time error to preface a function declaration with the built-in identifier \STATIC{}.
|
|
|
|
\LMHash{}
|
|
When we say that a function $f_1$ {\em forwards} to another function $f_2$, we mean that invoking $f_1$ causes $f_2$ to be executed with the same arguments and/or receiver as $f_1$, and returns the result of executing $f_2$ to the caller of $f_1$, unless $f_2$ throws an exception, in which case $f_1$ throws the same exception. Furthermore, we only use the term for synthetic functions introduced by the specification.
|
|
|
|
|
|
\subsection{Formal Parameters}
|
|
\LMLabel{formalParameters}
|
|
|
|
\LMHash{}
|
|
Every function includes a {\em formal parameter list}, which consists of a list of required positional parameters (\ref{requiredFormals}), followed by any optional parameters (\ref{optionalFormals}). The optional parameters may be specified either as a set of named parameters or as a list of positional parameters, but not both.
|
|
|
|
\LMHash{}
|
|
The formal parameter list of a function introduces a new scope known as the function's {\em formal parameter scope}. The formal parameter scope of a function $f$ is enclosed in the scope where $f$ is declared. Every formal parameter introduces a local variable into the formal parameter scope. However, the scope of a function's signature is the function's enclosing scope, not the formal parameter scope.
|
|
|
|
\LMHash{}
|
|
The body of a function introduces a new scope known as the function's {\em body scope}. The body scope of a function $f$ is enclosed in the scope introduced by the formal parameter scope of $f$.
|
|
|
|
|
|
%The formal parameter scope of a function maps the name of each formal parameter $p$ to the value $p$ is bound to.
|
|
|
|
% The formal parameters of a function are processed in the enclosing scope of the function.
|
|
% \commentary{this means that the parameters themselves may not be referenced within the formal parameter list.}
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if a formal parameter is declared as a constant variable (\ref{variables}).
|
|
|
|
\begin{grammar}
|
|
{\bf formalParameterList:}
|
|
`(' `)';
|
|
`(' normalFormalParameters `,'? `)';
|
|
`(' normalFormalParameters `,' optionalFormalParameters `)';
|
|
`(' optionalFormalParameters `)'
|
|
.
|
|
%\end{grammar}
|
|
%}
|
|
|
|
%\begin{grammar}
|
|
%formalParameterList:
|
|
% '(' restFormalParameter? ')';
|
|
% '(' namedFormalParameters ')';
|
|
% '(' normalFormalParameters normalFormalParameterTail? ')'
|
|
% .
|
|
|
|
{\bf normalFormalParameters:}
|
|
normalFormalParameter (`,' normalFormalParameter)*
|
|
.
|
|
|
|
{\bf optionalFormalParameters:}
|
|
optionalPositionalFormalParameters;
|
|
namedFormalParameters
|
|
.
|
|
|
|
{\bf optionalPositionalFormalParameters:}
|
|
`[' defaultFormalParameter (`,' defaultFormalParameter)* `,'? `]'
|
|
.
|
|
{\bf namedFormalParameters:}
|
|
`\{' defaultNamedParameter (`,' defaultNamedParameter)* `,'? `\}'
|
|
.
|
|
\end{grammar}
|
|
|
|
Formal parameter lists allow an optional trailing comma after the last parameter ($`,'?$). A parameter list with such a trailing comma is equivalent in all ways to the same parameter list without the trailing comma. All parameter lists in this specification are shown without a trailing comma, but the rules and semantics apply equally to the corresponding parameter list with a trailing comma.
|
|
|
|
%Formal parameters are always \FINAL{}.
|
|
%\Q{We're awaiting some data on whether enforcing this would cause widespread pain.}
|
|
%A formal parameter is always considered to be initialized. \rationale{This is because it will always be initialized by the call - even if it is optional.}
|
|
|
|
|
|
\subsubsection{Required Formals}
|
|
\LMLabel{requiredFormals}
|
|
|
|
\LMHash{}
|
|
A {\em required formal parameter} may be specified in one of three ways:
|
|
\begin{itemize}
|
|
\item By means of a function signature that names the parameter and describes its type as a function type (\ref{functionTypes}). It is a compile-time error if any default values are specified in the signature of such a function type.% explain what the type is in this case? Where is this described in general?
|
|
\item As an initializing formal, which is only valid as a parameter to a generative constructor (\ref{generativeConstructors}). % do we need to say this, or anything more?
|
|
\item Via an ordinary variable declaration (\ref{variables}).
|
|
\end{itemize}
|
|
|
|
\begin{grammar}
|
|
{\bf normalFormalParameter:}functionFormalParameter;
|
|
fieldFormalParameter;
|
|
simpleFormalParameter
|
|
.
|
|
|
|
{\bf functionFormalParameter:}
|
|
metadata \COVARIANT{}? returnType? identifier formalParameterList
|
|
.
|
|
|
|
{\bf simpleFormalParameter:}
|
|
metadata \COVARIANT{}? finalConstVarOrType? identifier;
|
|
.
|
|
|
|
{\bf fieldFormalParameter:}
|
|
metadata finalConstVarOrType? \THIS{} `{\escapegrammar .}' identifier formalParameterList?
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
It is possible to include the modifier \COVARIANT{} in some forms of parameter declarations.
|
|
This modifier has no effect.
|
|
|
|
\rationale{
|
|
The modifier \COVARIANT{} is used in strong mode.
|
|
The modifier is allowed here even though it has no effect, such that source code can be used in both contexts.
|
|
}
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if the modifier \COVARIANT{} occurs on a parameter of a function which is not an instance method, instance setter, or instance operator.
|
|
|
|
%\subsubsection{Rest Formals}
|
|
%\LMLabel{restFormals}
|
|
|
|
%A rest formal $R$ must be the last parameter in a formal parameter list. If a type $T$ is specified for $R$, it signifies that the type of $R$ is $T[]$.
|
|
|
|
%\begin{grammar}
|
|
%restFormalParameter:
|
|
% finalConstVarOrType? '{\escapegrammar ...}' identifier
|
|
%\end{grammar}
|
|
|
|
\subsubsection{Optional Formals}
|
|
\LMLabel{optionalFormals}
|
|
|
|
\LMHash{}
|
|
Optional parameters may be specified and provided with default values.
|
|
|
|
\begin{grammar}
|
|
{\bf defaultFormalParameter:}
|
|
normalFormalParameter (`=' expression)?
|
|
.
|
|
|
|
{\bf defaultNamedParameter:}normalFormalParameter (`=' expression)?;
|
|
normalFormalParameter ( `{\escapegrammar :}' expression)?
|
|
.
|
|
\end{grammar}
|
|
|
|
A {\bf defaultNamedParameter} on the form:
|
|
\begin{code}
|
|
normalFormalParameter : expression
|
|
\end{code}
|
|
is equivalent to one on the form:
|
|
\begin{code}
|
|
normalFormalParameter = expression
|
|
\end{code}
|
|
The colon-syntax is included only for backwards compatibility.
|
|
It is deprecated and will be removed in a later version of the language specification.
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if the default value of an optional parameter is not a compile-time constant (\ref{constants}). If no default is explicitly specified for an optional parameter an implicit default of \NULL{} is provided.
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if the name of a named optional parameter begins with an `\_' character.
|
|
|
|
\rationale{
|
|
The need for this restriction is a direct consequence of the fact that naming and privacy are not orthogonal.
|
|
If we allowed named parameters to begin with an underscore, they would be considered private and inaccessible to callers from outside the library where it was defined. If a method outside the library overrode a method with a private optional name, it would not be a subtype of the original method. The static checker would of course flag such situations, but the consequence would be that adding a private named formal would break clients outside the library in a way they could not easily correct.
|
|
}
|
|
|
|
\subsection{Type of a Function}
|
|
\LMLabel{typeOfAFunction}
|
|
|
|
\LMHash{}
|
|
If a function does not declare a return type explicitly, its return type is \DYNAMIC{} (\ref{typeDynamic}), unless it is a constructor function, in which case its return type is the immediately enclosing class.
|
|
|
|
\LMHash{}
|
|
Let $F$ be a function with required formal parameters $T_1$ $p_1 \ldots, T_n$ $p_n$, return type $T_0$ and no optional parameters. Then the type of $F$ is $(T_1 ,\ldots, T_n) \rightarrow T_0$.
|
|
|
|
\LMHash{}
|
|
Let $F$ be a function with required formal parameters $T_1$ $p_1 \ldots, T_n$ $p_n$, return type $T_0$ and positional optional parameters $T_{n+1}$ $p_{n+1}, \ldots, T_{n+k}$ $ p_{n+k}$. Then the type of $F$ is $(T_1 ,\ldots, T_n, [T_{n+1}$ $p_{n+1}, \ldots, T_{n+k}$ $p_{n+k}]) \rightarrow T_0$.
|
|
|
|
\LMHash{}
|
|
Let $F$ be a function with required formal parameters $T_1$ $p_1 \ldots, T_n$ $p_n$, return type $T_0$ and named optional parameters $T_{n+1}$ $p_{n+1}, \ldots, T_{n+k}$ $ p_{n+k}$. Then the type of $F$ is $(T_1 ,\ldots, T_n, \{T_{n+1}$ $p_{n+1}, \ldots, T_{n+k}$ $p_{n+k}\}) \rightarrow T_0$.
|
|
|
|
\LMHash{}
|
|
The run time type of a function object always implements the class \cd{Function}.
|
|
|
|
\commentary{
|
|
One cannot assume, based on the above, that given a function \cd{f}, \cd{f.runtimeType} will actually be \cd{Function}, or that any two distinct function objects necessarily have the same runtime type.
|
|
}
|
|
|
|
\rationale{
|
|
It is up to the implementation to choose an appropriate representation for functions.
|
|
For example, consider that a closure produced via property extraction treats equality different from ordinary closures, and is therefore likely a different class. Implementations may also use different classes for functions based on arity and or type. Arity may be implicitly affected by whether a function is an instance method (with an implicit receiver parameter) or not. The variations are manifold, and so this specification only guarantees that function objects are instances of some class that is considered to implement \cd{Function}.
|
|
|
|
}
|
|
|
|
\subsection{External Functions}
|
|
\LMLabel{externalFunctions}
|
|
|
|
\LMHash{}
|
|
An {\em external function} is a function whose body is provided separately from its declaration. An external function may be a top-level function (\ref{librariesAndScripts}), a method (\ref{instanceMethods}, \ref{staticMethods}), a getter (\ref{getters}), a setter (\ref{setters}) or a non-redirecting constructor (\ref{generativeConstructors}, \ref{factories}). External functions are introduced via the built-in identifier \EXTERNAL{} (\ref{identifierReference}) followed by the function signature.
|
|
|
|
\rationale{
|
|
External functions allow us to introduce type information for code that is not statically known to the Dart compiler.
|
|
}
|
|
|
|
\commentary{
|
|
Examples of external functions might be foreign functions (defined in C, or Javascript etc.), primitives of the implementation (as defined by the Dart runtime), or code that was dynamically generated but whose interface is statically known. However, an abstract method is different from an external function, as it has {\em no} body.
|
|
}
|
|
|
|
\LMHash{}
|
|
An external function is connected to its body by an implementation specific mechanism. Attempting to invoke an external function that has not been connected to its body will throw a \code{NoSuchMethodError} or some subclass thereof.
|
|
|
|
\LMHash{}
|
|
The actual syntax is given in sections \ref{classes} and \ref{librariesAndScripts} below.
|
|
|
|
\section{Classes}
|
|
\LMLabel{classes}
|
|
|
|
\LMHash{}
|
|
A {\em class} defines the form and behavior of a set of objects which are its {\em instances}. Classes may be defined by class declarations as described below, or via mixin applications (\ref{mixinApplication}).
|
|
|
|
\begin{grammar}
|
|
{\bf classDefinition:}
|
|
metadata \ABSTRACT{}? \CLASS{} identifier typeParameters? (superclass mixins?)? interfaces? \\
|
|
`\{' (metadata classMemberDefinition)* `\}';
|
|
|
|
metadata \ABSTRACT{}? \CLASS{} mixinApplicationClass
|
|
.
|
|
|
|
{\bf mixins:}
|
|
\WITH{} typeList
|
|
.
|
|
|
|
{\bf classMemberDefinition:}declaration `{\escapegrammar ;}' ;
|
|
methodSignature functionBody
|
|
.
|
|
|
|
{\bf methodSignature:}constructorSignature initializers?;
|
|
factoryConstructorSignature;
|
|
% This doesn't work: `static @override foo() => 42`, but `functionSignature` starts with metadata. https://github.com/dart-lang/sdk/issues/29614
|
|
\STATIC{}? functionSignature;
|
|
\STATIC{}? getterSignature;
|
|
\STATIC{}? setterSignature;
|
|
operatorSignature
|
|
.
|
|
|
|
{\bf declaration:}constantConstructorSignature (redirection $|$ initializers)?;
|
|
constructorSignature (redirection $|$ initializers)?;
|
|
\EXTERNAL{} constantConstructorSignature;
|
|
\EXTERNAL{} constructorSignature;
|
|
((\EXTERNAL{} \STATIC{}?))? getterSignature;
|
|
((\EXTERNAL{} \STATIC{}?))? setterSignature;
|
|
\EXTERNAL{}? operatorSignature;
|
|
% This doesn't work: `static @override foo() => 42`, but `functionSignature` starts with metadata. https://github.com/dart-lang/sdk/issues/29614
|
|
((\EXTERNAL{} \STATIC{}?))? functionSignature;
|
|
\STATIC{} (\FINAL{} $|$ \CONST{}) type? staticFinalDeclarationList;
|
|
% \CONST{} type? staticFinalDeclarationList;
|
|
\FINAL{} type? initializedIdentifierList;
|
|
(\STATIC{} $|$ \COVARIANT{})? (\VAR{} $|$ type) initializedIdentifierList
|
|
.
|
|
|
|
{\bf staticFinalDeclarationList:}
|
|
staticFinalDeclaration (`,' staticFinalDeclaration)*
|
|
.
|
|
|
|
{\bf staticFinalDeclaration:}
|
|
identifier `=' expression
|
|
.
|
|
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
It is possible to include the modifier \COVARIANT{} in some forms of declarations.
|
|
This modifier has no effect.
|
|
|
|
\rationale{
|
|
The modifier \COVARIANT{} is used in strong mode.
|
|
The modifier is allowed here even though it has no effect, such that source code can be used in both contexts.
|
|
}
|
|
|
|
\LMHash{}
|
|
A class has constructors, instance members and static members. The instance members of a class are its instance methods, getters, setters and instance variables. The static members of a class are its static methods, getters, setters and static variables. The members of a class are its static and instance members.
|
|
|
|
\LMHash{}
|
|
A class has several scopes:
|
|
\begin{itemize}
|
|
\item A {\em type-parameter scope}, which is empty if the class is not generic (\ref{generics}). The enclosing scope of the type-parameter scope of a class is the enclosing scope of the class declaration.
|
|
\item A {\em static scope}. The enclosing scope of the static scope of a class is the type parameter scope (\ref{generics}) of the class.
|
|
\item An {\em instance scope}.
|
|
The enclosing scope of a class' instance scope is the class' static scope.
|
|
\end{itemize}
|
|
|
|
\LMHash{}
|
|
The enclosing scope of an instance member declaration is the instance scope of the class in which it is declared.
|
|
|
|
\LMHash{}
|
|
The enclosing scope of a static member declaration is the static scope of the class in which it is declared.
|
|
|
|
|
|
\LMHash{}
|
|
Every class has a single superclass except class \code{Object} which has no superclass. A class may implement a number of interfaces
|
|
%, either
|
|
by declaring them in its implements clause (\ref{superinterfaces}).
|
|
% or via interface injection declarations (\ref{interfaceInjection}) outside the class declaration
|
|
|
|
|
|
\LMHash{}
|
|
An {\em abstract class} is
|
|
%either
|
|
a class that is explicitly declared with the \ABSTRACT{} modifier, either by means of a class declaration or via a type alias (\ref{typedef}) for a mixin application (\ref{mixinApplication}). A {\em concrete class} is a class that is not abstract.
|
|
%, or a class that declares at least one abstract method (\ref{abstractInstanceMembers}).
|
|
|
|
\rationale{
|
|
%The abstract modifier for classes is intended to be used in scenarios where an abstract class $A$ inherits from another abstract class $B$. In such a situation, it may be that A$ $itself does not declare any abstract methods. In the absence of an abstract modifier on the class, the class would be interpreted as a concrete class. However, w
|
|
We want different behavior for concrete classes and abstract classes. If $A$ is intended to be abstract, we want the static checker to warn about any attempt to instantiate $A$, and we do not want the checker to complain about unimplemented methods in $A$. In contrast, if $A$ is intended to be concrete, the checker should warn about all unimplemented methods, but allow clients to instantiate it freely.
|
|
}
|
|
|
|
\LMHash{}
|
|
The {\em interface of class $C$} is an implicit interface that declares instance members that correspond to the instance members declared by $C$, and whose direct superinterfaces are the direct superinterfaces of $C$ (\ref{superinterfaces}). When a class name appears as a type, that name denotes the interface of the class.
|
|
|
|
% making an exception for the setters generated for final fields is tempting but problematic.
|
|
% If a super type defines a setter, it will be overridden yet have no impact on the interface.
|
|
% Maybe the final field hides the setter in scope?
|
|
% I think the original rules were best.
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if a class declares two members of the same name.
|
|
%, except that a getter and a setter may be declared with the same name provided both are instance members or both are static members.
|
|
It is a compile-time error if a class has an instance member and a static member with the same name.
|
|
% It is a compile-time error if a generic (\ref{generics}) class declares a member with the same name as one of its type parameters.
|
|
|
|
\commentary{Here are simple examples, that illustrate the difference between ``has a member'' and ``declares a member''. For example, \code{B} {\em declares} one member named \code{f}, but {\em has} two such members. The rules of inheritance determine what members a class has.
|
|
}
|
|
|
|
\begin{dartCode}
|
|
\CLASS{} A \{
|
|
\VAR{} i = 0;
|
|
\VAR{} j;
|
|
f(x) => 3;
|
|
\}
|
|
|
|
\CLASS{} B \EXTENDS{} A \{
|
|
int i = 1; // getter i and setter i= override versions from A
|
|
\STATIC{} j; // compile-time error: static getter \& setter conflict with
|
|
//instance getter \& setter
|
|
|
|
/* compile-time error: static method conflicts with instance method */
|
|
\STATIC{} f(x) => 3;
|
|
\}
|
|
\end{dartCode}
|
|
|
|
\LMHash{}
|
|
It is a compile time error if a class $C$ declares a member with the same name as $C$. It is a compile time error if a generic class declares a type variable with the same name as the class or any of its members or constructors.
|
|
|
|
\subsection{Instance Methods}
|
|
\LMLabel{instanceMethods}
|
|
|
|
\LMHash{}
|
|
Instance methods are functions (\ref{functions}) whose declarations are immediately contained within a class declaration and that are not declared \STATIC{}. The instance methods of a class $C$ are those instance methods declared by $C$ and the instance methods inherited by $C$ from its superclass.
|
|
|
|
%make these warnings if possible
|
|
|
|
\LMHash{}
|
|
It is a static warning if an instance method $m_1$ overrides (\ref{inheritanceAndOverriding}) an instance member $m_2$ and $m_1$ has a greater number of required parameters than $m_2$. It is a static warning if an instance method $m_1$ overrides an instance member $m_2$ and $m_1$ has fewer positional parameters than $m_2$. It is a static warning if an instance method $m_1$ overrides an instance member $m_2$ and $m_1$ does not declare all the named parameters declared by $m_2$.
|
|
|
|
% not quite right. It should be ok to override a method that requires N parameters with one that requires M < N but accepts the others as optional.
|
|
|
|
\LMHash{}
|
|
It is a static warning if an instance method $m_1$ overrides an instance member $m_2$ and the type of $m_1$ is not a subtype of the type of $m_2$. It is a static warning if an instance method $m_1$ overrides an instance member $m_2$, the signature of $m_2$ explicitly specifies a default value for a formal parameter $p$ and the signature of $m_1$ implies a different default value for $p$. It is a static warning if a class $C$ declares an instance method named $n$ and has a setter named $n=$. It is a static warning if a class $C$ declares an instance method named $n$ and an accessible static member named $n$ is declared in a superclass of $C$.
|
|
|
|
% Works. If the name is public, no issue. If it's private, if a subclass has a conflicting inst var, it either is in the same lib and will be flagged, or is in another and is not an issue.
|
|
|
|
|
|
\subsubsection{Operators}
|
|
\LMLabel{operators}
|
|
|
|
\LMHash{}
|
|
{\em Operators} are instance methods with special names.
|
|
|
|
\begin{grammar}
|
|
{\bf operatorSignature:}
|
|
returnType? \OPERATOR{} operator formalParameterList
|
|
.
|
|
|
|
{\bf operator:}`\~{}';
|
|
binaryOperator;
|
|
`[' `]' ;
|
|
`[' `]' `='
|
|
.
|
|
|
|
{\bf binaryOperator:}multiplicativeOperator;
|
|
additiveOperator;
|
|
shiftOperator;
|
|
relationalOperator;
|
|
`==';
|
|
bitwiseOperator
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
An operator declaration is identified using the built-in identifier (\ref{identifierReference}) \OPERATOR{}.
|
|
|
|
\LMHash{}
|
|
The following names are allowed for user-defined operators: \code{<, >, <=, >=, ==, -, +, /, \~{}/, *, \%, $|$, \^{}, \&, $<<$, $>>$, []=, [], \~{}.}
|
|
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if the arity of the user-declared operator \code{[]=} is not 2. It is a compile-time error if the arity of a user-declared operator with one of the names: \code{ <, >, <=, >=, ==, -, +, \~{}/, /, *, \%, $|$, \^{}, \&, $<<$, $>>$, []} is not 1. It is a compile-time error if the arity of the user-declared operator \code{-} is not 0 or 1.
|
|
|
|
\commentary{
|
|
The \code{-} operator is unique in that two overloaded versions are permitted. If the operator has no arguments, it denotes unary minus. If it has an argument, it denotes binary subtraction.
|
|
}
|
|
|
|
\LMHash{}
|
|
The name of the unary operator \code{-} is \code{unary-}.
|
|
|
|
\rationale{
|
|
This device allows the two methods to be distinguished for purposes of method lookup, override and reflection.
|
|
}
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if the arity of the user-declared operator \code{ \~{}} is not 0.
|
|
|
|
\LMHash{}
|
|
It is a compile-time error to declare an optional parameter in an operator.
|
|
|
|
\LMHash{}
|
|
It is a static warning if the return type of the user-declared operator \code{[]=} is explicitly declared and not \VOID{}.
|
|
|
|
% add rationale: return in []= methods will have no effect, a the expression always returns its second argument (the RHS of the assignment, for consistency with assignment in general). So it's best to enforce this by declaring the method to be void, even though the expression that uses it returns an object with the type of the RHS, as described in \ref{assignment}.
|
|
|
|
|
|
\subsection{Getters}
|
|
\LMLabel{getters}
|
|
|
|
\LMHash{}
|
|
Getters are functions (\ref{functions}) that are used to retrieve the values of object properties.
|
|
|
|
\begin{grammar}
|
|
{\bf getterSignature:}
|
|
returnType? \GET{} identifier
|
|
.
|
|
\end{grammar}
|
|
|
|
%\Q{Why does a getter have a formal parameter list at all?}
|
|
|
|
\LMHash{}
|
|
If no return type is specified, the return type of the getter is \DYNAMIC{}.
|
|
|
|
\LMHash{}
|
|
A getter definition that is prefixed with the \STATIC{} modifier defines a static getter. Otherwise, it defines an instance getter. The name of the getter is given by the identifier in the definition. The effect of a static getter declaration in class $C$ is to add an instance getter with the same name and signature to the \code{Type} object for class $C$ that forwards (\ref{functionDeclarations}) to the static getter.
|
|
|
|
%It is a compile-time error if a getter`s formal parameter list is not empty.
|
|
|
|
\LMHash{}
|
|
The instance getters of a class $C$ are those instance getters declared by $C$, either implicitly or explicitly, and the instance getters inherited by $C$ from its superclass. The static getters of a class $C$ are those static getters declared by $C$.
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if a class has both a getter and a method with the same name. This restriction holds regardless of whether the getter is defined explicitly or implicitly, or whether the getter or the method are inherited or not.
|
|
|
|
\commentary{
|
|
This implies that a getter can never override a method, and a method can never override a getter or an instance variable.
|
|
}
|
|
|
|
\LMHash{}
|
|
It is a static warning if the return type of a getter is \VOID.
|
|
It is a static warning if a getter $m_1$ overrides (\ref{inheritanceAndOverriding}) a getter
|
|
$m_2$ and the type of $m_1$ is not a subtype of the type of $m_2$.
|
|
|
|
\LMHash{}
|
|
It is a static warning if a class declares a static getter named $v$ and also has a non-static setter named $v=$. It is a static warning if a class $C$ declares an instance getter named $v$ and an accessible static member named $v$ or $v=$ is declared in a superclass of $C$. These warnings must be issued regardless of whether the getters or setters are declared explicitly or implicitly.
|
|
|
|
\subsection{Setters}
|
|
\LMLabel{setters}
|
|
|
|
\LMHash{}
|
|
Setters are functions (\ref{functions}) that are used to set the values of object properties.
|
|
|
|
% what about top level ones? Same for getters
|
|
|
|
\begin{grammar}
|
|
{\bf setterSignature:}
|
|
returnType? \SET{} identifier formalParameterList
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
If no return type is specified, the return type of the setter is \DYNAMIC{}.
|
|
|
|
\LMHash{}
|
|
A setter definition that is prefixed with the \STATIC{} modifier defines a static setter. Otherwise, it defines an instance setter. The name of a setter is obtained by appending the string `=' to the identifier given in its signature. The effect of a static setter declaration in class $C$ is to add an instance setter with the same name and signature to the \code{Type} object for class $C$ that forwards (\ref{functionDeclarations}) to the static setter.
|
|
|
|
\commentary{Hence, a setter name can never conflict with, override or be overridden by a getter or method.}
|
|
|
|
\LMHash{}
|
|
The instance setters of a class $C$ are those instance setters declared by $C$ either implicitly or explicitly, and the instance setters inherited by $C$ from its superclass. The static setters of a class $C$ are those static setters declared by $C$.
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if a setter's formal parameter list does not consist of exactly one required formal parameter $p$. \rationale{We could enforce this via the grammar, but we'd have to specify the evaluation rules in that case.}
|
|
|
|
%It is a compile-time error if a class has both a setter and a method with the same name. This restriction holds regardless of whether the setter is defined explicitly or implicitly, or whether the setter or the method are inherited or not.
|
|
|
|
\LMHash{}
|
|
It is a static warning if a setter declares a return type other than \VOID{}.
|
|
It is a static warning if a setter $m_1$ overrides (\ref{inheritanceAndOverriding}) a setter $m_2$ and the type of $m_1$ is not a subtype of the type of $m_2$. It is a static warning if a class has a setter named $v=$ with argument type $T$ and a getter named $v$ with return type $S$, and $T$ may not be assigned to $S$.
|
|
|
|
\LMHash{}
|
|
It is a static warning if a class declares a static setter named $v=$ and also has a non-static member named $v$. It is a static warning if a class $C$ declares an instance setter named $v=$ and an accessible static member named $v=$ or $v$ is declared in a superclass of $C$.
|
|
|
|
\LMHash{}
|
|
These warnings must be issued regardless of whether the getters or setters are declared explicitly or implicitly.
|
|
|
|
\subsection{Abstract Instance Members}
|
|
\LMLabel{abstractInstanceMembers}
|
|
|
|
\LMHash{}
|
|
An {\em abstract method} (respectively, {\em abstract getter} or {\em abstract setter)} is an instance method, getter or setter that is not declared \EXTERNAL{} and does not provide an implementation. A {\em concrete method} (respectively, {\em concrete getter} or {\em concrete setter)} is an instance method, getter or setter that is not abstract.
|
|
%The declaration of an abstract method is prefixed by the built-in identifier (\ref{identifierReference}) \ABSTRACT{}.
|
|
|
|
\rationale{
|
|
Earlier versions of Dart required that abstract members be identified by prefixing them with the modifier \ABSTRACT{}. The elimination of this requirement is motivated by the desire to use abstract classes as interfaces. Every Dart class induces an implicit interface.
|
|
|
|
Using an abstract class instead of an interface has important advantages. An abstract class can provide default implementations; it can also provide static methods, obviating the need for service classes such as \code{Collections} or \code{Lists}, whose entire purpose is to group utilities related to a given type.
|
|
|
|
Eliminating the requirement for an explicit modifier on members makes abstract classes more concise, making abstract classes an attractive substitute for interface declarations.
|
|
}
|
|
|
|
\commentary {Invoking an abstract method, getter or setter results in an invocation of \cd{noSuchMethod} exactly as if the declaration did not exist, unless a suitable member $a$ is available in a superclass, in which case $a$ is invoked. The normative specification for this appears under the definitions of lookup for methods, getters and setters.
|
|
}
|
|
|
|
% so does an abstract method override a method in a superclass or not? Does the superclass method get inherited or not? This generally makes the spec inconsistent, as there is no simple answer.
|
|
% For example - if we say it does not override, then the superclass member is inherited, in which case the rules for warning break down, and also there is question of whether there are two definitions of the same name.
|
|
% But if we do override, method lookup rules break down. So several things need revisiting.
|
|
|
|
\rationale{
|
|
The purpose of an abstract method is to provide a declaration for purposes such as type checking and reflection. In classes used as mixins, it is often useful to introduce such declarations for methods that the mixin expects will be provided by the superclass the mixin is applied to.
|
|
}
|
|
%always results in a run-time error. This must be \code{NoSuchMethodError} or an instance of a subclass of \code{NoSuchMethodError}, such as \code{AbstractMethodError}.
|
|
|
|
\LMHash{}
|
|
It is a static warning if an abstract member $m$ is declared or inherited in a concrete class $C$ unless:
|
|
\begin{itemize}
|
|
\item $m$ overrides a concrete member, or
|
|
\item $C$ has a \cd{noSuchMethod()} method distinct from the one declared in class \cd{Object}.
|
|
\end{itemize}
|
|
|
|
\rationale {
|
|
We wish to warn if one declares a concrete class with abstract members. However, code like the following should work without warnings:
|
|
}
|
|
|
|
\begin{dartCode}
|
|
class Base \{
|
|
int get one => 1;
|
|
\}
|
|
|
|
abstract class Mix \{
|
|
int get one;
|
|
int get two => one + one;
|
|
\}
|
|
|
|
class C extends Base with Mix \{ \}
|
|
\end{dartCode}
|
|
|
|
\rationale{At run time, the concrete method \cd{one} declared in \cd{Base} will be executed, and no problem should arise. Therefore no warning should be issued and so we suppress warnings if a corresponding concrete member exists in the hierarchy. }
|
|
|
|
\subsection{Instance Variables}
|
|
\LMLabel{instanceVariables}
|
|
|
|
\LMHash{}
|
|
Instance variables are variables whose declarations are immediately contained within a class declaration and that are not declared \STATIC{}. The instance variables of a class $C$ are those instance variables declared by $C$ and the instance variables inherited by $C$ from its superclass.
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if an instance variable is declared to be constant.
|
|
|
|
\rationale{
|
|
The notion of a constant instance variable is subtle and confusing to programmers.
|
|
An instance variable is intended to vary per instance. A constant instance variable would have the same value for all instances, and as such is already a dubious idea.
|
|
|
|
The language could interpret const instance variable declarations as instance getters that return a constant. However, a constant instance variable could not be treated as a true compile time constant, as its getter would be subject to overriding.
|
|
|
|
Given that the value does not depend on the instance, it is better to use a static class variable.
|
|
An instance getter for it can always be defined manually if desired.
|
|
}
|
|
|
|
|
|
%An instance variable declaration of one of the forms \code{$T$ $v$;}, \code{\FINAL{} $T$ $v$;} , \code{$T$ $v$ = $e$;} , \code{\CONST{} $T$ $v$ = $e$;} or \code{\FINAL{} $T$ $v$ = $e$;} always induces an implicit getter function (\ref{getters}) with signature
|
|
|
|
%$T$ \GET{} $v$
|
|
|
|
%whose invocation evaluates to the value stored in $v$.
|
|
|
|
%An instance variable declaration of one of the forms \code{\VAR{} $v$;}, \code{\FINAL{} $v$;}, \code{\VAR{} $v$ = $e$;} , \code{\CONST{} $v$ = $e$;} or \code{\FINAL{} $v$ = $e$;} always induces an implicit getter function with signature
|
|
|
|
%\GET{} $v$
|
|
|
|
%whose invocation evaluates to the value stored in $v$.
|
|
|
|
%\commentary{Getters are introduced for all instance and static variables (\ref{staticVariables}), regardless of whether they are const/final or not.}
|
|
|
|
%A non-final instance variable declaration of the form \code{$T$ $v$;} or the form \code{$T$ $v$ = $e$;} always induces an implicit setter function (\ref{setters}) with signature
|
|
|
|
%\VOID{} \SET{} $v=(T$ $x)$
|
|
|
|
%whose execution sets the value of $v$ to the incoming argument $x$.
|
|
|
|
%A non-final instance variable declaration of the form \code{\VAR{} $v$;} or the form \code{\VAR{} $v$ = $e$;} always induces an implicit setter function with signature
|
|
|
|
%\SET{} $v=(x)$
|
|
|
|
%whose execution sets the value of $v$ to the incoming argument $x$.
|
|
|
|
% It is a compile-time error/warning if a class $C$ declares a final instance variable $v$ and $C$ inherits a setter $v=$.
|
|
|
|
|
|
\subsection{Constructors}
|
|
\LMLabel{constructors}
|
|
|
|
\LMHash{}
|
|
A {\em constructor} is a special function that is used in instance creation expressions (\ref{instanceCreation}) to obtain objects, typically by creating or initializing them.
|
|
Constructors may be generative (\ref{generativeConstructors}) or they may be factories (\ref{factories}).
|
|
|
|
\LMHash{}
|
|
A {\em constructor name} always begins with the name of its immediately enclosing class, and may optionally be followed by a dot and an identifier $id$. It is a compile-time error if $id$ is the name of a member declared in the immediately enclosing class. It is a compile-time error if the name of a constructor is not a constructor name.
|
|
|
|
|
|
% In what scope do constructors go? The simple names of named constructors go in the static scope of the class. Unnamed ones go nowhere, but we use the class name to refer to them; the class name could also in the static scope of the class as well to prevent weird errors, or we could ban it explicitly and avoiding duplication. Similarly, the instance scope could contain the constructor names and class name, or we could have special rules to prevent collisions between instance members and constructors or the class.
|
|
|
|
% The enclosing scope of a generative constructor is the instance scope of the class in which it is declared (but what about redirecting?)
|
|
|
|
\LMHash{}
|
|
Iff no constructor is specified for a class $C$, it implicitly has a default constructor \code{C() : \SUPER{}() \{\}}, unless $C$ is class \code{Object}.
|
|
|
|
\subsubsection{Generative Constructors}
|
|
\LMLabel{generativeConstructors}
|
|
|
|
\LMHash{}
|
|
A {\em generative constructor} consists of a constructor name, a constructor parameter list, and either a redirect clause or an initializer list and an optional body.
|
|
|
|
\begin{grammar}
|
|
{\bf constructorSignature:}
|
|
identifier (`{\escapegrammar .}' identifier)? formalParameterList
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
A {\em constructor parameter list} is a parenthesized, comma-separated list of formal constructor parameters. A {\em formal constructor parameter} is either a formal parameter (\ref{formalParameters}) or an initializing formal. An {\em initializing formal} has the form \code{\THIS{}.$id$}, where $id$ is the name of an instance variable of the immediately enclosing class. It is a compile-time error if $id$ is not an instance variable of the immediately enclosing class. It is a compile-time error if an initializing formal is used by a function other than a non-redirecting generative constructor.
|
|
|
|
\LMHash{}
|
|
If an explicit type is attached to the initializing formal, that is its static type.
|
|
Otherwise, the type of an initializing formal named $id$ is $T_{id}$, where $T_{id}$ is the type of the instance variable named $id$ in the immediately enclosing class.
|
|
It is a static warning if the static type of $id$ is not assignable to $T_{id}$.
|
|
|
|
\LMHash{}
|
|
Initializing formals constitute an exception to the rule that every formal parameter introduces a local variable into the formal parameter scope (\ref{formalParameters}).
|
|
When the formal parameter list of a non-redirecting generative constructor contains any initializing formals, a new scope is introduced, the {\em formal parameter initializer scope}, which is the current scope of the initializer list of the constructor, and which is enclosed in the scope where the constructor is declared.
|
|
Each initializing formal in the formal parameter list introduces a final local variable into the formal parameter initializer scope, but not into the formal parameter scope; every other formal parameter introduces a local variable into both the formal parameter scope and the formal parameter initializer scope.
|
|
|
|
\commentary{
|
|
This means that formal parameters, including initializing formals, must have distinct names, and that initializing formals are in scope for the initializer list, but they are not in scope for the body of the constructor.
|
|
When a formal parameter introduces a local variable into two scopes, it is still one variable and hence one storage location.
|
|
The type of the constructor is defined in terms of its formal parameters, including the initializing formals.
|
|
}
|
|
|
|
\LMHash{}
|
|
Initializing formals are executed during the execution of generative constructors detailed below.
|
|
Executing an initializing formal \code{\THIS{}.$id$} causes the instance variable $id$ of the immediately surrounding class to be assigned the value of the corresponding actual parameter,
|
|
unless $id$ is a final variable that has already been initialized, in which case a runtime error occurs.
|
|
|
|
\commentary{
|
|
The above rule allows initializing formals to be used as optional parameters:
|
|
}
|
|
|
|
\begin{dartCode}
|
|
class A \{
|
|
int x;
|
|
A([this.x]);
|
|
\}
|
|
\end{dartCode}
|
|
|
|
\commentary{is legal, and has the same effect as}
|
|
|
|
\begin{dartCode}
|
|
class A \{
|
|
int x;
|
|
A([int x]): this.x = x;
|
|
\}
|
|
\end{dartCode}
|
|
|
|
\LMHash{}
|
|
A {\em fresh instance} is an instance whose identity is distinct from any previously allocated instance of its class. A generative constructor always operates on a fresh instance of its immediately enclosing class.
|
|
|
|
\commentary{
|
|
The above holds if the constructor is actually run, as it is by \NEW{}. If a constructor $c$ is referenced by \CONST{}, $c$ may not be run; instead, a canonical object may be looked up. See the section on instance creation (\ref{instanceCreation}).
|
|
}
|
|
|
|
\LMHash{}
|
|
If a generative constructor $c$ is not a redirecting constructor and no body is provided, then $c$ implicitly has an empty body \code{\{\}}.
|
|
|
|
|
|
\paragraph{Redirecting Constructors}
|
|
\LMLabel{redirectingConstructors}
|
|
|
|
\LMHash{}
|
|
A generative constructor may be {\em redirecting}, in which case its only action is to invoke another generative constructor. A redirecting constructor has no body; instead, it has a redirect clause that specifies which constructor the invocation is redirected to, and with what arguments.
|
|
|
|
\begin{grammar}
|
|
{\bf redirection:}
|
|
`{\escapegrammar :}' \THIS{} (`{\escapegrammar .}' identifier)? arguments
|
|
.
|
|
\end{grammar}
|
|
|
|
%\Q{We now have generative constructors with no bodies as well.}
|
|
|
|
\paragraph{Initializer Lists}
|
|
\LMLabel{initializerLists}
|
|
|
|
\LMHash{}
|
|
An initializer list begins with a colon, and consists of a comma-separated list of individual {\em initializers}. There are two kinds of initializers.
|
|
\begin{itemize}
|
|
\item A {\em superinitializer} identifies a {\em superconstructor} - that is, a specific constructor of the superclass. Execution of the superinitializer causes the initializer list of the superconstructor to be executed.
|
|
|
|
\item An {\em instance variable initializer} assigns a value to an individual instance variable.
|
|
\end{itemize}
|
|
|
|
\begin{grammar}
|
|
{\bf initializers:}
|
|
`{\escapegrammar :}' superCallOrFieldInitializer (`,' superCallOrFieldInitializer)*
|
|
.
|
|
|
|
|
|
{\bf superCallOrFieldInitializer:}\SUPER{} arguments;
|
|
\SUPER{} `{\escapegrammar .}' identifier arguments;
|
|
fieldInitializer
|
|
.
|
|
|
|
{\bf fieldInitializer:}
|
|
(\THIS{} `{\escapegrammar .}')? identifier `=' conditionalExpression cascadeSection*
|
|
.
|
|
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
Let $k$ be a generative constructor.
|
|
Then $k$ may include at most one superinitializer in its initializer list or a compile-time error occurs.
|
|
If no superinitializer is provided, an implicit superinitializer of the form \SUPER{}() is added at the end of $k$'s initializer list,
|
|
unless the enclosing class is class \code{Object}.
|
|
It is a compile-time error if more than one initializer corresponding to a given instance variable appears in $k$'s initializer list.
|
|
It is a compile-time error if $k$'s initializer list contains an initializer for a variable that is initialized by means of an initializing formal of $k$.
|
|
It is a compile-time error if $k$'s initializer list contains an initializer for a final variable $f$ whose declaration includes an initialization expression.
|
|
It is a compile-time error if $k$ includes an initializing formal for a final variable $f$ whose declaration includes an initialization expression.
|
|
|
|
\LMHash{}
|
|
Each final instance variable $f$ declared in the immediately enclosing class must have an initializer in $k$'s initializer list unless it has already been initialized by one of the following means:
|
|
\begin{itemize}
|
|
\item Initialization at the declaration of $f$.
|
|
\item Initialization by means of an initializing formal of $k$.
|
|
\end{itemize}
|
|
|
|
or a static warning occurs. It is a compile-time error if $k$'s initializer list contains an initializer for a variable that is not an instance variable declared in the immediately surrounding class.
|
|
|
|
|
|
\commentary{The initializer list may of course contain an initializer for any instance variable declared by the immediately surrounding class, even if it is not final.
|
|
}
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if a generative constructor of class \code{Object} includes a superinitializer.
|
|
|
|
\LMHash{}
|
|
Execution of a generative constructor $k$ of type $T$ to initialize a fresh instance $i$
|
|
is always done with respect to a set of bindings for its formal parameters
|
|
and the type parameters of the immediately enclosing class bound to a set of actual type arguments of $T$, $V_1, \ldots , V_m$.
|
|
|
|
\commentary{These bindings are usually determined by the instance creation expression that invoked the constructor (directly or indirectly). However, they may also be determined by a reflective call.
|
|
}
|
|
|
|
\LMHash{}
|
|
If $k$ is redirecting then its redirect clause has the form
|
|
|
|
\THIS{}$.g(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$
|
|
|
|
where $g$ identifies another generative constructor of the immediately surrounding class. Then execution of $k$ to initialize $i$ proceeds by evaluating the argument list $(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$, and then executing $g$ to initialize $i$ with respect to the bindings resulting from the evaluation of $(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$ and with \THIS{} bound to $i$ and the type parameters of the immediately enclosing class bound to $V_1, \ldots , V_m$.
|
|
|
|
\LMHash{}
|
|
Otherwise, execution proceeds as follows:
|
|
|
|
\LMHash{}
|
|
The instance variable declarations of the immediately enclosing class are visited in the order they appear in the program text.
|
|
For each such declaration $d$, if $d$ has the form \code{$finalConstVarOrType$ $v$ = $e$; }
|
|
then $e$ is evaluated to an object $o$
|
|
and the instance variable $v$ of $i$ is bound to $o$.
|
|
|
|
\LMHash{}
|
|
Any initializing formals declared in $k$'s parameter list are executed in the order they appear in the program text.
|
|
% In fact, this order is unobservable; this could be done any time prior to running the body, since
|
|
% these only effect \THIS{}.
|
|
Then, the initializers of $k$'s initializer list are executed to initialize $i$
|
|
in the order they appear in the program.
|
|
|
|
\rationale {We could observe the order by side effecting external routines called. So we need to specify the order.}
|
|
|
|
\LMHash{}
|
|
Then if any instance variable of $i$ declared by the immediately enclosing class
|
|
is not yet bound to a value,
|
|
all such variables are initialized with the \NULL{} value.
|
|
|
|
\LMHash{}
|
|
Then, unless the enclosing class is \code{Object}, the explicitly specified or
|
|
implicitly added superinitializer (\ref{initializerLists}) is executed to
|
|
further initialize $i$.
|
|
|
|
\commentary{
|
|
The super constructor call can be written anywhere
|
|
in the initializer list of $k$,
|
|
but the actual call always happens after all initializers have been processed.
|
|
It is not equivalent to moving the super call to the end of the initializer list
|
|
because the argument expressions may have visible side effects
|
|
which must happen in the order the expressions occur in the program text.
|
|
}
|
|
|
|
\LMHash{}
|
|
After the superinitializer has completed, the body of $k$ is executed in a scope where \THIS{} is bound to $i$.
|
|
|
|
\rationale{
|
|
This process ensures that no uninitialized final instance variable is ever seen by code.
|
|
Note that \THIS{} is not in scope on the right hand side of an initializer (see \ref{this}) so no instance method can execute during initialization:
|
|
an instance method cannot be directly invoked, nor can \THIS{} be passed into any other code being invoked in the initializer.
|
|
}
|
|
|
|
\LMHash{}
|
|
During the execution of a generative constructor to initialize an instance $i$,
|
|
execution of an initializer of the form \code{\THIS{}.$v$ = $e$}
|
|
proceeds as follows:
|
|
|
|
\LMHash{}
|
|
First, the expression $e$ is evaluated to an object $o$.
|
|
Then, the instance variable $v$ of $i$ is bound to $o$.
|
|
In checked mode, it is a dynamic type error if $o$ is not \NULL{} and the interface of the class of $o$ is not a subtype of the actual type of the instance variable $v$.
|
|
|
|
\LMHash{}
|
|
An initializer of the form \code{$v$ = $e$} is equivalent to an initializer of the form \code{\THIS{}.$v$ = $e$}.
|
|
|
|
\LMHash{}
|
|
Execution of a superinitializer of the form
|
|
|
|
\SUPER{}$(a_1, \ldots, a_n, x_{n+1}: a_{n+1}, \ldots, x_{n+k}: a_{n+k})$
|
|
|
|
(respectively \SUPER{}$.id(a_1, \ldots, a_n, x_{n+1}: a_{n+1}, \ldots, x_{n+k}: a_{n+k})$
|
|
|
|
proceeds as follows:
|
|
|
|
\LMHash{}
|
|
First, the argument list $(a_1, \ldots, a_n, x_{n+1}: a_{n+1}, \ldots, x_{n+k}: a_{n+k})$ is evaluated.
|
|
|
|
\LMHash{}
|
|
Then, after the remainder of the initializer list of $k$ has been executed,
|
|
the superconstructor is executed as follows:
|
|
|
|
\LMHash{}
|
|
Let $C$ be the class in which the superinitializer appears and let $S$ be the superclass of $C$. If $S$ is generic (\ref{generics}), let $U_1, \ldots, U_m$ be the actual type arguments passed to $S$ in the superclass clause of $C$.
|
|
|
|
\LMHash{}
|
|
The generative constructor $S$ (respectively $S.id$) of $S$ is executed
|
|
to initialize $i$ with respect to the bindings that resulted from the evaluation of
|
|
$(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$,
|
|
and the type parameters (if any) of class $S$ bound to $U_1, \ldots, U_m$.
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if class $S$ does not declare a generative constructor named $S$ (respectively $S.id$).
|
|
|
|
\subsubsection{Factories}
|
|
\LMLabel{factories}
|
|
|
|
\LMHash{}
|
|
A {\em factory} is a constructor prefaced by the built-in identifier (\ref{identifierReference}) \FACTORY{}.
|
|
|
|
\begin{grammar}
|
|
{\bf factoryConstructorSignature:}
|
|
\FACTORY{} identifier (`{\escapegrammar .}' identifier)? formalParameterList
|
|
.
|
|
\end{grammar}
|
|
|
|
|
|
%The enclosing scope of a factory constructor is the static scope \ref{} of the class in which it is declared.
|
|
|
|
\LMHash{}
|
|
The {\em return type} of a factory whose signature is of the form \FACTORY{} $M$ or the form \FACTORY{} $M.id$ is $M$ if $M$ is not a generic type; otherwise the return type is $M <T_1, \ldots, T_n>$ where $T_1, \ldots, T_n$ are the type parameters of the enclosing class
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if $M$ is not the name of the immediately enclosing class.
|
|
|
|
\LMHash{}
|
|
In checked mode, it is a dynamic type error if a factory returns a non-null object whose type is not a subtype of its actual (\ref{actualTypeOfADeclaration}) return type.
|
|
|
|
\rationale{It seems useless to allow a factory to return null. But it is more uniform to allow it, as the rules currently do.}
|
|
|
|
\rationale{Factories address classic weaknesses associated with constructors in other languages.
|
|
Factories can produce instances that are not freshly allocated: they can come from a cache. Likewise, factories can return instances of different classes.
|
|
}
|
|
|
|
\paragraph{Redirecting Factory Constructors}
|
|
\LMLabel{redirectingFactoryConstructors}
|
|
|
|
\LMHash{}
|
|
A {\em redirecting factory constructor} specifies a call to a constructor of another class that is to be used whenever the redirecting constructor is called.
|
|
|
|
\begin{grammar}
|
|
{\bf redirectingFactoryConstructorSignature:}
|
|
\CONST{}? \FACTORY{} identifier (`{\escapegrammar .}' identifier)? formalParameterList `=' type (`{\escapegrammar .}' identifier)?
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
Calling a redirecting factory constructor $k$ causes the constructor $k^\prime$ denoted by $type$ (respectively, $type.identifier$) to be called with the actual arguments passed to $k$, and returns the result of $k^\prime$ as the result of $k$. The resulting constructor call is governed by the same rules as an instance creation expression using \NEW{} (\ref{instanceCreation}).
|
|
|
|
\commentary{
|
|
It follows that if $type$ or $type.id$ are not defined, or do not refer to a class or constructor, a dynamic error occurs, as with any other undefined constructor call. The same holds if $k$ is called with fewer required parameters or more positional parameters than $k^\prime$ expects, or if $k$ is called with a named parameter that is not declared by $k^\prime$.
|
|
}
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if $k$ explicitly specifies a default value for an optional parameter.\commentary{
|
|
Default values specified in $k$ would be ignored, since it is the {\em actual} parameters that are passed to $k^\prime$. Hence, default values are disallowed.
|
|
}
|
|
|
|
\LMHash{}
|
|
It is a run-time error if a redirecting factory constructor redirects to itself, either directly or indirectly via a sequence of redirections. %does not redirect to a non-redirecting factory constructor or to a generative constructor in a finite number of steps.
|
|
|
|
% Make this a runtime error so deferred loading works
|
|
|
|
\rationale{
|
|
If a redirecting factory $F_1$ redirects to another redirecting factory $F_2$ and $F_2$ then redirects to $F_1$, then both $F_1$ and $F_2$ are ill-defined. Such cycles are therefore illegal.
|
|
}
|
|
|
|
|
|
\LMHash{}
|
|
It is a static warning if $type$ does not denote a class accessible in the current scope; if $type$ does denote such a class $C$ it is a static warning if the referenced constructor (be it $type$ or $type.id$) is not a constructor of $C$.
|
|
|
|
\commentary{
|
|
Note that it is not possible to modify the arguments being passed to $k'$.
|
|
}
|
|
% but we have the same issue with other redirecting constructors, no?)
|
|
\rationale{
|
|
At first glance, one might think that ordinary factory constructors could simply create instances of other classes and return them, and that redirecting factories are unnecessary. However, redirecting factories have several advantages:
|
|
\begin{itemize}
|
|
\item An abstract class may provide a constant constructor that utilizes the constant constructor of another class.
|
|
\item A redirecting factory constructors avoids the need for forwarders to repeat the default values for formal parameters in their signatures.
|
|
%\item A generic factory class that aggregates factory constructors for types it does not implement can still have its type arguments passed correctly.
|
|
\end{itemize}
|
|
|
|
%An example of the latter point:
|
|
%}
|
|
|
|
|
|
%\begin{dartCode}
|
|
%\CLASS{} W<T> \IMPLEMENTS{} A<T> { W(w) {...} ...}
|
|
%\CLASS{} X<T> \IMPLEMENTS{} A<T> { X(x) {...} ...}
|
|
%\CLASS{} Y<T> \IMPLEMENTS{} A<T> { Y(y) {...} ...}
|
|
%\CLASS{} Z<T> \IMPLEMENTS{} A<T> { Z(z) {...} ...}
|
|
|
|
|
|
%\CLASS{} F<T> { // note that F does not implement A
|
|
% \STATIC{} F<T> idw(w) => \NEW{} W<T>(w); // illegal - T not in scope in idw
|
|
% \FACTORY{} F.idx(x) => \NEW{} X<T>(x);
|
|
% \FACTORY{} F.idy(y) => \NEW{} Y<T>(y);
|
|
% \STATIC{} F idz(z) => \NEW{} Z(z); // does not capture the type argument
|
|
%}
|
|
|
|
%\CLASS{} A<T>{
|
|
% \FACTORY{} A.idw(w) => F<T>.idw(w);
|
|
%// illegal - cannot pass type parameter to static method
|
|
% \FACTORY{} A.idx(x) $=> \NEW{} $F<T>.idx(x); // works, but allocates a gratuitous instance of F
|
|
% \FACTORY{} A.idy(y) = Y<T>; // works
|
|
% \FACTORY{} A.idz(z) => F.idz(z); // wrong - returns Z<Dynamic>; no way to pass type argument
|
|
}
|
|
%\end{dartCode}
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if $k$ is prefixed with the \CONST{} modifier but $k^\prime$ is not a constant constructor (\ref{constantConstructors}).
|
|
|
|
\LMHash{}
|
|
It is a static warning if the function type of $k^\prime$ is not a subtype of the type of $k$.
|
|
|
|
\commentary{
|
|
This implies that the resulting object conforms to the interface of the immediately enclosing class of $k$.
|
|
}
|
|
|
|
\LMHash{}
|
|
It is a static type warning if any of the type arguments to $k^\prime$ are not subtypes of the bounds of the corresponding formal type parameters of $type$.
|
|
|
|
|
|
\subsubsection{Constant Constructors}
|
|
\LMLabel{constantConstructors}
|
|
|
|
\LMHash{}
|
|
A {\em constant constructor} may be used to create compile-time constant (\ref{constants}) objects. A constant constructor is prefixed by the reserved word \CONST{}.
|
|
|
|
\begin{grammar}
|
|
{\bf constantConstructorSignature:}
|
|
\CONST{} qualified formalParameterList
|
|
.
|
|
\end{grammar}
|
|
|
|
|
|
%\commentary{Spell out subtleties: a constant constructor call within the initializer of a constant constructor is treated as a ordinary constructor call (a new), because the arguments cannot be assumed constant anymore. In practice, this means two versions are compiled and analyzed. One for new and one for const.}
|
|
|
|
% \Q{How to specify?}
|
|
|
|
\commentary{All the work of a constant constructor must be handled via its initializers.}
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if a constant constructor is declared by a class that has a non-final instance variable.
|
|
|
|
\commentary{
|
|
The above refers to both locally declared and inherited instance variables.
|
|
}
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if a constant constructor is declared by a class $C$ if any instance variable declared in $C$ is initialized with an expression that is not a constant expression.
|
|
|
|
\commentary {
|
|
A superclass of $C$ cannot declare such an initializer either, because it must necessarily declare constant constructor as well (unless it is \code{Object}, which declares no instance variables).
|
|
}
|
|
|
|
\LMHash{}
|
|
The superinitializer that appears, explicitly or implicitly, in the initializer list of a constant constructor must specify a constant constructor of the superclass of the immediately enclosing class or a compile-time error occurs.
|
|
|
|
\LMHash{}
|
|
Any expression that appears within the initializer list of a constant constructor must be a potentially constant expression, or a compile-time error occurs.
|
|
|
|
\LMHash{}
|
|
A {\em potentially constant expression} is an expression $e$ that would be a valid constant expression if all formal parameters of $e$'s immediately enclosing constant constructor were treated as compile-time constants that were guaranteed to evaluate to an integer, boolean or string value as required by their immediately enclosing superexpression, <em>and</em> where $e$ is also a valid expression if all the formal parameters are treated as non-constant variables.
|
|
|
|
\commentary{
|
|
Note that a parameter that is not used in a superexpression that is restricted to certain types can be a constant of any type. For example}
|
|
|
|
\begin{dartCode}
|
|
\CLASS{} A \{
|
|
\FINAL{} m;
|
|
\CONST{} A(this.m);
|
|
\}
|
|
\end{dartCode}
|
|
|
|
\commentary{can be instantiated via \cd{\CONST{} A(\CONST []);}}
|
|
|
|
|
|
|
|
\commentary{
|
|
The difference between a potentially constant expression and a compile-time constant expression (\ref{const}) deserves some explanation.
|
|
|
|
The key issue is whether one treats the formal parameters of a constructor as compile-time constants.
|
|
|
|
If a constant constructor is invoked from a constant object expression, the actual arguments will be required to be compile-time constants. Therefore, if we were assured that constant constructors were always invoked from constant object expressions, we could assume that the formal parameters of a constructor were compile-time constants.
|
|
|
|
However, constant constructors can also be invoked from ordinary instance creation expressions (\ref{new}), and so the above assumption is not generally valid.
|
|
|
|
Nevertheless, the use of the formal parameters of a constant constructor within the constructor is of considerable utility. The concept of potentially constant expressions is introduced to facilitate limited use of such formal parameters. Specifically, we allow the usage of the formal parameters of a constant constructor for expressions that involve built-in operators, but not for constant objects, lists and maps. This allows for constructors such as:
|
|
}
|
|
|
|
\begin{dartCode}
|
|
\CLASS{} C \{
|
|
\FINAL{} x; \FINAL{} y; \FINAL{} z;
|
|
\CONST{} C(p, q): x = q, y = p + 100, z = p + q;
|
|
% what about
|
|
% \CONST{} C(p, q): x = q, y = p + 100, z = p + 'foo';
|
|
% perhaps moot. Current spec says that would be ok; type checker can worry, as can execution, which is at compile time anyway
|
|
\}
|
|
\end{dartCode}
|
|
|
|
\commentary{
|
|
The assignment to \code{x} is allowed under the assumption that \code{q} is a compile-time constant (even though \code{q} is not, in general a compile-time constant). The assignment to \code{y} is similar, but raises additional questions. In this case, the superexpression of \code{p} is \code{p + 100}, and it requires that \code{p} be a numeric compile-time constant for the entire expression to be considered constant. The wording of the specification allows us to assume that \code{p} evaluates to an integer. A similar argument holds for \code{p} and \code{q} in the assignment to \code{z}.
|
|
|
|
However, the following constructors are disallowed:
|
|
}
|
|
|
|
\begin{dartCode}
|
|
\CLASS{} D \{
|
|
\FINAL{} w;
|
|
\CONST{} D.makeList(p): w = \CONST{} [p]; // compile-time error
|
|
\CONST{} D.makeMap(p): w = \CONST{} \{``help'': q\}; // compile-time error
|
|
\CONST{} D.makeC(p): w = \CONST{} C(p, 12); // compile-time error
|
|
\}
|
|
\end{dartCode}
|
|
|
|
\commentary{
|
|
The problem is not that the assignments to \code{w} are not potentially constant; they are. However, all these run afoul of the rules for constant lists (\ref{lists}), maps (\ref{maps}) and objects (\ref{const}), all of which independently require their subexpressions to be constant expressions.
|
|
}
|
|
|
|
\rationale{
|
|
All of the illegal constructors of \code{D} above could not be sensibly invoked via \NEW{}, because an expression that must be constant cannot depend on a formal parameter, which may or may not be constant. In contrast, the legal examples make sense regardless of whether the constructor is invoked via \CONST{} or via \NEW{}.
|
|
|
|
Careful readers will of course worry about cases where the actual arguments to \code{C()} are constants, but are not numeric. This is precluded by the following rule, combined with the rules for evaluating constant objects (\ref{const}).
|
|
}
|
|
|
|
\LMHash{}
|
|
When invoked from a constant object expression, a constant constructor must throw an exception if any of its actual parameters is a value that would prevent one of the potentially constant expressions within it from being a valid compile-time constant.
|
|
|
|
%Discuss External Constructors in ne subsubsection here
|
|
|
|
\subsection{Static Methods}
|
|
\LMLabel{staticMethods}
|
|
|
|
\LMHash{}
|
|
{\em Static methods} are functions, other than getters or setters, whose declarations are immediately contained within a class declaration and that are declared \STATIC{}. The static methods of a class $C$ are those static methods declared by $C$.
|
|
|
|
\LMHash{}
|
|
The effect of a static method declaration in class $C$ is to add an instance method with the same name and signature to the \code{Type} object for class $C$ that forwards (\ref{functionDeclarations}) to the static method.
|
|
|
|
\rationale{
|
|
Inheritance of static methods has little utility in Dart. Static methods cannot be overridden. Any required static function can be obtained from its declaring library, and there is no need to bring it into scope via inheritance. Experience shows that developers are confused by the idea of inherited methods that are not instance methods.
|
|
|
|
Of course, the entire notion of static methods is debatable, but it is retained here because so many programmers are familiar with it. Dart static methods may be seen as functions of the enclosing library.
|
|
}
|
|
|
|
\LMHash{}
|
|
It is a static warning if a class $C$ declares a static method named $n$ and has a setter named $n=$.
|
|
%It is a static warning if a class has a static method with the same name as a static member of one of its superclasses.
|
|
|
|
%\rationale{
|
|
%This last restriction makes classes more brittle with respect to changes in the class hierarchy. It stems from a general observation that shadowing of names in the same scope is questionable and should elicit a warning.
|
|
%}
|
|
%\commentary{
|
|
%There is no hiding of static methods, or of static variables.
|
|
%}
|
|
|
|
|
|
\subsection{Static Variables}
|
|
\LMLabel{staticVariables}
|
|
|
|
\LMHash{}
|
|
{\em Static variables} are variables whose declarations are immediately contained within a class declaration and that are declared \STATIC{}. The static variables of a class $C$ are those static variables declared by $C$.
|
|
|
|
%A static variable declaration of one of the forms \code{\STATIC{} $T$ $v$;}, \code{\STATIC{} $T$ $v$ = $e$;} , \code{\STATIC{} \CONST{} $T$ $v$ = $e$;} or \code{\STATIC{} \FINAL{} $T$ $v$ = $e$;} always induces an implicit static getter function (\ref{getters}) with signature
|
|
|
|
%\STATIC{} $T$ \GET{} $v$
|
|
|
|
%whose invocation evaluates as described below (\ref{evaluationOfStaticVariableGetters}).%to the value stored in $v$.
|
|
|
|
|
|
%A static variable declaration of one of the forms \code{\STATIC{} \VAR{} $v$;}, \code{\STATIC{} \VAR{} $v$ = $e$;} , \code{\STATIC{} \CONST{} $v$ = $e$;} or \code{\STATIC{} \FINAL{} $v$ = $e$;} always induces an implicit static getter function with signature
|
|
|
|
%\STATIC{} \GET{} $v$
|
|
|
|
%whose invocation evaluates as described below (\ref{evaluationOfStaticVariableGetters}).%to the value stored in $v$.
|
|
|
|
%A non-final static variable declaration of the form \code{\STATIC{} $T$ $v$;} or the form \code{\STATIC{} $T$ $v$ = $e$;} always induces an implicit static setter function (\ref{setters}) with signature
|
|
|
|
%\STATIC{} \VOID{} \SET{} $v=(T$ $x)$
|
|
|
|
%whose execution sets the value of $v$ to the incoming argument $x$.
|
|
|
|
%A static variable declaration of the form \code{\STATIC{} \VAR{} $v$;} or the form \code{\STATIC{} \VAR{} $v$ = $e$;} always induces an implicit static setter function with signature
|
|
|
|
%\STATIC{} \SET{} $v=(x)$
|
|
|
|
%whose execution sets the value of $v$ to the incoming argument $x$.
|
|
|
|
%Extrernal static functions, getters, setters
|
|
|
|
%\subsubsection{Evaluation of Implicit Static Variable Getters}
|
|
%\LMLabel{evaluationOfStaticVariableGetters}
|
|
|
|
%Let $d$ be the declaration of a static variable $v$. The implicit getter method of $v$ executes as follows:
|
|
%\begin{itemize}
|
|
%\item If $d$ is of one of the forms \code{\STATIC{} \VAR{} $v$ = $e$;} , \code{\STATIC{} $T$ $v$ = $e$; }, \code{\STATIC{} \FINAL{} $v$ = $e$; } or \code{\STATIC{} \FINAL{} $T$ $v$ = $e$;} and no value has yet been stored into $v$ then the initializer expression $e$ is evaluated. If, during the evaluation of $e$, the getter for $v$ is referenced, a \code{CyclicInitializationError} is thrown. If the evaluation succeeded yielding an object $o$, let $r = o$, otherwise let $r = \NULL{}$. In any case, $r$ is stored into $v$. The result of executing the getter is $r$.
|
|
%\item If $d$ is of one of the forms \code{\STATIC{} \CONST{} $v$ = $e$; } or \code{\STATIC{} \CONST{} $T$ $v$ = $e$;} the result of the getter is the value of the compile time constant $e$.
|
|
%Otherwise
|
|
%\item The result of executing the getter method is the value stored in $v$.
|
|
%\end{itemize}
|
|
|
|
|
|
|
|
\subsection{Superclasses}
|
|
\LMLabel{superclasses}
|
|
|
|
\LMHash{}
|
|
The superclass of a class $C$ that has a with clause \code{\WITH{} $M_1, \ldots, M_k$} and an extends clause \code{\EXTENDS{} S} is the application of mixin (\ref{mixins}) $M_k* \cdots * M_1$ to S. If no \WITH{} clause is specified then the \EXTENDS{} clause of a class $C$ specifies its superclass. If no \EXTENDS{} clause is specified, then either:
|
|
\begin{itemize}
|
|
\item $C$ is \code{Object}, which has no superclass. OR
|
|
\item Class $C$ is deemed to have an \EXTENDS{} clause of the form \code{\EXTENDS{} Object}, and the rules above apply.
|
|
\end{itemize}
|
|
|
|
\LMHash{}
|
|
It is a compile-time error to specify an \EXTENDS{} clause for class \code{Object}.
|
|
|
|
\begin{grammar}
|
|
{\bf superclass:}
|
|
\EXTENDS{} type
|
|
.
|
|
\end{grammar}
|
|
|
|
%The superclass clause of a class C is processed within the enclosing scope of the static scope of C.
|
|
%\commentary{
|
|
%This means that in a generic class, the type parameters of the generic are available in the superclass clause.
|
|
%}
|
|
|
|
\LMHash{}
|
|
The scope of the \EXTENDS{} and \WITH{} clauses of a class $C$ is the type-parameter scope of $C$.
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if the \EXTENDS{} clause of a class $C$ specifies a type variable (\ref{generics}), a type alias (\ref{typedef}), an enumerated type (\ref{enums}), a malformed type, or a deferred type (\ref{staticTypes}) as a superclass.
|
|
It is a compile-time error if the \EXTENDS{} clause of a class $C$ specifies type \DYNAMIC{} as a superinterface.
|
|
|
|
\commentary{ The type parameters of a generic class are available in the lexical scope of the superclass clause, potentially shadowing classes in the surrounding scope. The following code is therefore illegal and should cause a compile-time error:
|
|
}
|
|
|
|
\begin{dartCode}
|
|
class T \{\}
|
|
|
|
/* Compilation error: Attempt to subclass a type parameter */
|
|
class G<T> extends T \{\}
|
|
|
|
\end{dartCode}
|
|
|
|
|
|
\LMHash{}
|
|
A class $S$ is {\em a superclass} of a class $C$ iff either:
|
|
\begin{itemize}
|
|
\item $S$ is the superclass of $C$, or
|
|
\item $S$ is a superclass of a class $S^{\prime}$ and $S^{\prime}$ is a superclass of $C$.
|
|
\end{itemize}
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if a class $C$ is a superclass of itself.
|
|
|
|
|
|
|
|
|
|
\subsubsection{Inheritance and Overriding}
|
|
\LMLabel{inheritanceAndOverriding}
|
|
|
|
|
|
%A class $C$ {\em inherits} any accessible instance members of its superclass that are not overridden by members declared in $C$.
|
|
|
|
\LMHash{}
|
|
Let $C$ be a class, let $A$ be a superclass of $C$, and let $S_1 \ldots S_k$ be superclasses of $C$ that are also subclasses of $A$. $C$ {\em inherits} all accessible instance members of $A$ that have not been overridden by a declaration in $C$ or in at least one of $S_1 \ldots S_k$.
|
|
|
|
\rationale {
|
|
It would be more attractive to give a purely local definition of inheritance, that depended only on the members of the direct superclass $S$. However, a class $C$ can inherit a member $m$ that is not a member of its superclass $S$. This can occur when the member $m$ is private
|
|
to the library $L_1$ of $C$, whereas $S$ comes from a different library $L_2$, but
|
|
the superclass chain of $S$ includes a class declared in $L_1$.
|
|
}
|
|
|
|
\LMHash{}
|
|
A class may override instance members that would otherwise have been inherited from its superclass.
|
|
|
|
\LMHash{}
|
|
Let $C = S_0$ be a class declared in library $L$, and let $\{S_1 \ldots S_k\}$ be the set of all superclasses of $C$, where $S_i$ is the superclass of $S_{i-1}$ for $i \in 1 .. k$.
|
|
Let $C$ declare a member $m$, and let $m^\prime$ be a member of $S_j, j \in 1 .. k$, that has the same name as $m$, such that $m^\prime$ is accessible to $L$.
|
|
Then $m$ overrides $m^\prime$ if $m^\prime$ is not already overridden by a member of at least one of $S_1 \ldots S_{j-1}$ and neither $m$ nor $m^\prime$ are instance variables.
|
|
|
|
%Let $C$ be a class declared in library $L$, with superclass $S$ and let $C$ declare an instance member $m$, and assume $S$ declares an instance member $m^\prime$ with the same name as $m$. Then $m$ {\em overrides} $m^\prime$ iff $m^\prime$ is accessible (\ref{privacy}) to $L$, $m$ has the same name as $m^\prime$ and neither $m$ nor $m^\prime$ are fields.
|
|
|
|
\commentary{Instance variables never override each other. The getters and setters induced by instance variables do.}
|
|
|
|
\rationale{Again, a local definition of overriding would be preferable, but fails to account for library privacy.
|
|
}
|
|
|
|
\LMHash{}
|
|
Whether an override is legal or not is described elsewhere in this specification (see \ref{instanceMethods}, \ref{getters} and \ref{setters}).
|
|
|
|
\commentary{For example getters may not legally override methods and vice versa. Setters never override methods or getters, and vice versa, because their names always differ.
|
|
}
|
|
|
|
\rationale{
|
|
It is nevertheless convenient to define the override relation between members in this way, so that we can concisely describe the illegal cases.
|
|
}
|
|
|
|
\commentary{
|
|
Note that instance variables do not participate in the override relation, but the getters and setters they induce do. Also, getters don't override setters and vice versa. Finally, static members never override anything.
|
|
}
|
|
|
|
\LMHash{}
|
|
It is a static warning if a non-abstract class inherits an abstract method.
|
|
|
|
\commentary {
|
|
For convenience, here is a summary of the relevant rules. Remember that this is not normative. The controlling language is in the relevant sections of the specification.
|
|
|
|
\begin{enumerate}
|
|
|
|
\item There is only one namespace for getters, setters, methods and constructors (\ref{scoping}).
|
|
An instance or static variable $f$ introduces a getter $f$ and a non-final instance or static variable $f$ also introduces a setter $f=$ (\ref{instanceVariables}, \ref{staticVariables}).
|
|
When we speak of members here, we mean accessible instance or static variables, getters, setters, and methods (\ref{classes}).
|
|
\item You cannot have two members with the same name in the same class - be they declared or inherited (\ref{scoping}, \ref{classes}).
|
|
\item Static members are never inherited.
|
|
\item It is a warning if you have an static member named $m$ in your class or any superclass (even though it is not inherited) and an instance member of the same name (\ref{instanceMethods}, \ref{getters}, \ref{setters}).
|
|
\item It is a warning if you have a static setter $v=$, and an instance member $v$ (\ref{setters}).
|
|
\item It is a warning if you have a static getter $v$ and an instance setter $v=$ (\ref{getters}).
|
|
\item If you define an instance member named $m$, and your superclass has an instance member of the same name, they override each other. This may or may not be legal.
|
|
\item \label{typeSigAssignable}
|
|
If two members override each other, it is a static warning if their type signatures are not assignable to each other (\ref{instanceMethods}, \ref{getters}, \ref{setters}) (and since these are function types, this means the same as "subtypes of each other").
|
|
\item \label{requiredParams}
|
|
If two members override each other, it is a static warning if the overriding member has more required parameters than the overridden one (\ref{instanceMethods}).
|
|
\item \label{optionalPositionals}
|
|
If two members override each other, it is a static warning if the overriding member has fewer positional parameters than the overridden one (\ref{instanceMethods}).
|
|
\item \label{namedParams}
|
|
If two members override each other, it is a static warning if the overriding member does not have all the named parameters that the overridden one has (\ref{instanceMethods}).
|
|
\item Setters, getters and operators never have optional parameters of any kind; it's a compile-time error (\ref{operators}, \ref{getters}, \ref{setters}).
|
|
\item It is a compile-time error if a member has the same name as its enclosing class (\ref{classes}).
|
|
\item A class has an implicit interface (\ref{classes}).
|
|
\item Superinterface members are not inherited by a class, but are inherited by its implicit interface. Interfaces have their own inheritance rules (\ref{interfaceInheritanceAndOverriding}).
|
|
\item A member is abstract if it has no body and is not labeled \EXTERNAL{} (\ref{abstractInstanceMembers}, \ref{externalFunctions}).
|
|
\item A class is abstract iff it is explicitly labeled \ABSTRACT{}.% or if it declares (not just inherits) an abstract member (\ref{classes}).
|
|
\item It is a static warning if a concrete class has an abstract member (declared or inherited).
|
|
\item It is a static warning and a dynamic error to call a non-factory constructor of an abstract class (\ref{new}).
|
|
\item If a class defines an instance member named $m$, and any of its superinterfaces have a member named $m$, the interface of the class overrides $m$.
|
|
\item An interface inherits all members of its superinterfaces that are not overridden and not members of multiple superinterfaces.
|
|
\item If multiple superinterfaces of an interface define a member with the same name $m$, then at most one member is inherited. That member (if it exists) is the one whose type is a subtype of all the others. If there is no such member, then:
|
|
\begin{itemize}
|
|
\item A static warning is given.
|
|
\item If possible the interface gets a member named $m$ that has the minimum number of required parameters among all the members in the superinterfaces, the maximal number of positionals, and the superset of named parameters. The types of these are all \DYNAMIC{}. If this is impossible then no member $m$ appears in the interface.
|
|
\end{itemize} (\ref{interfaceInheritanceAndOverriding})
|
|
\item Rule \ref{typeSigAssignable} applies to interfaces as well as classes (\ref{interfaceInheritanceAndOverriding}).
|
|
\item It is a static warning if a concrete class does not have an implementation for a method in any of its superinterfaces unless it has a \cd{noSuchMethod} method (\ref{superinterfaces}).
|
|
\item The identifier of a named constructor cannot be the same as the name of a member declared (as opposed to inherited) in the same class (\ref{constructors}).
|
|
\end{enumerate}
|
|
}
|
|
|
|
|
|
%Can we have abstract getters and setters?
|
|
|
|
\subsection{ Superinterfaces}
|
|
\LMLabel{superinterfaces}
|
|
% what about rules about classes that fail to implement their interfaces?
|
|
|
|
\LMHash{}
|
|
A class has a set of direct superinterfaces. This set includes the interface of its superclass and the interfaces specified in the \IMPLEMENTS{} clause of the class.
|
|
% and any superinterfaces specified by interface injection (\ref{interfaceInjection}). \Q{The latter needs to be worded carefully - when do interface injection clauses execute and in what scope?}
|
|
|
|
\begin{grammar}
|
|
{\bf interfaces:}
|
|
\IMPLEMENTS{} typeList
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
The scope of the \IMPLEMENTS{} clause of a class $C$ is the type-parameter scope of $C$.
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if the \IMPLEMENTS{} clause of a class $C$ specifies a type variable (\ref{generics}), a type alias (\ref{typedef}), an enumerated type (\ref{enums}), a malformed type, or a deferred type (\ref{staticTypes}) as a superinterface.
|
|
It is a compile-time error if the \IMPLEMENTS{} clause of a class $C$ specifies type \DYNAMIC{} as a superinterface.
|
|
It is a compile-time error if the \IMPLEMENTS{} clause of a class $C$ specifies a type $T$ as a superinterface more than once.
|
|
It is a compile-time error if the superclass of a class $C$ is specified as a superinterface of $C$.
|
|
|
|
\rationale{
|
|
One might argue that it is harmless to repeat a type in the superinterface list, so why make it an error? The issue is not so much that the situation described in program source is erroneous, but that it is pointless. As such, it is an indication that the programmer may very well have meant to say something else - and that is a mistake that should be called to her or his attention. Nevertheless, we could simply issue a warning; and perhaps we should and will. That said, problems like these are local and easily corrected on the spot, so we feel justified in taking a harder line.
|
|
}
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if the interface of a class $C$ is a superinterface of itself.
|
|
|
|
\LMHash{}
|
|
Let $C$ be a concrete class that does not have a \code{noSuchMethod()} method distinct from the one declared in class \cd{Object}.
|
|
It is a static warning if the implicit interface of $C$ includes an instance member $m$ of type $F$ and $C$ does not declare or inherit a corresponding non-abstract instance member $m$ of type $F'$ such that $F' <: F$.
|
|
|
|
\commentary{A class does not inherit members from its superinterfaces. However, its implicit interface does.
|
|
}
|
|
|
|
|
|
\rationale {
|
|
We choose to issue these warnings only for concrete classes; an abstract class might legitimately be designed with the expectation that concrete subclasses will implement part of the interface.
|
|
We also disable these warnings if a \code{noSuchMethod()} declaration is present or inherited from any class other than \cd{Object}. In such cases, the supported interface is going to be implemented via \code{noSuchMethod()} and no actual declarations of the implemented interface's members are needed. This allows proxy classes for specific types to be implemented without provoking type warnings.
|
|
}
|
|
|
|
|
|
\LMHash{}
|
|
It is a static warning if the implicit interface of a class $C$ includes an instance member $m$ of type $F$ and $C$ declares or inherits a corresponding instance member $m$ of type $F'$ if $F'$ is not a subtype of $F$.
|
|
|
|
\rationale{
|
|
However, if a class does explicitly declare a member that conflicts with its superinterface, this always yields a static warning.
|
|
|
|
}
|
|
%It is a static warning if an imported superinterface of a class $C$ declares private members.
|
|
|
|
% Should we ignore unimplemented private members?
|
|
|
|
%\rationale{This last rule is problematic. As code evolves in one library ($L_1$) it may add private members to a class $I_1$ implemented or inherited in another library $L_2$ breaking $L_1$. This is a direct result of coupling an interface based type system with library based privacy. We are considering alternative semantics that might help resolve this issue.
|
|
%}
|
|
|
|
%\commentary{However, it is perfectly acceptable if a type mentioned in the implements clause is mentioned as a superinterface in an interface injection clause.
|
|
%}
|
|
|
|
%\rationale{We disallow repetition of a type in a given implements clause, as that is a localized mistake. However, separate clauses (that is the original class and various injections) may evolve separately over time, and we don't want to cause breakage. For example
|
|
|
|
%class C implements I1 {...}; // class declaration
|
|
|
|
|
|
%somewhere someone realizes that C could implement I2 class C implements I2; // injection
|
|
|
|
%later, the author of C decides to support I2
|
|
|
|
%class C implements I1, I2 {...}; // class declaration
|
|
|
|
%this should not cause breakage.
|
|
%}
|
|
|
|
% \rationale{This avoids the issues with so-called miranda methods etc. }
|
|
|
|
|
|
\section{Interfaces}
|
|
\LMLabel{interfaces}
|
|
|
|
\LMHash{}
|
|
An {\em interface} defines how one may interact with an object. An interface has methods, getters and setters and a set of superinterfaces.
|
|
|
|
\subsection{Superinterfaces}
|
|
\LMLabel{interfaceSuperinterfaces}
|
|
|
|
\LMHash{}
|
|
An interface has a set of direct superinterfaces.
|
|
|
|
\LMHash{}
|
|
An interface $J$ is a superinterface of an interface $I$ iff either $J$ is a direct superinterface of $I$ or $J$ is a superinterface of a direct superinterface of $I$.
|
|
|
|
|
|
|
|
|
|
\subsubsection{Inheritance and Overriding}
|
|
\LMLabel{interfaceInheritanceAndOverriding}
|
|
|
|
\LMHash{}
|
|
Let $J$ be an interface and $K$ be a library. We define $inherited(J, K)$ to be the set of members $m$ such that all of the following hold:
|
|
\begin{itemize}
|
|
\item $m$ is accessible to $K$ and
|
|
\item $A$ is a direct superinterface of $J$ and either
|
|
\begin{itemize}
|
|
\item $A$ declares a member $m$ or
|
|
\item $m$ is a member of $inherited(A, K)$.
|
|
\end{itemize}
|
|
\item $m$ is not overridden by $J$.
|
|
\end{itemize}
|
|
|
|
\LMHash{}
|
|
Furthermore, we define $overrides(J, K)$ to be the set of members $m^\prime$ such that all of the following hold:
|
|
\begin{itemize}
|
|
\item $J$ is the implicit interface of a class $C$.
|
|
\item $C$ declares a member $m$.
|
|
\item $m^\prime$ has the same name as $m$.
|
|
\item $m^\prime$ is accessible to $K$.
|
|
\item $A$ is a direct superinterface of $J$ and either
|
|
\begin{itemize}
|
|
\item $A$ declares a member $m^\prime$ or
|
|
\item $m^\prime$ is a member of $inherited(A, K)$.
|
|
\end{itemize}
|
|
\end{itemize}
|
|
|
|
|
|
\LMHash{}
|
|
Let $I$ be the implicit interface of a class $C$ declared in library $L$. $I$ {\em inherits} all members of $inherited(I, L)$ and $I$ {\em overrides} $m^\prime$ if $m^\prime \in overrides(I, L)$.
|
|
|
|
\LMHash{}
|
|
All the static warnings pertaining to the overriding of instance members given in section \ref{classes} above hold for overriding between interfaces as well.
|
|
|
|
\LMHash{}
|
|
It is a static warning if $m$ is a method and $m^\prime$ is a getter, or if $m$ is a getter and $m^\prime$ is a method.
|
|
|
|
|
|
|
|
%Let $I = S_0$ be the implicit interface of a class $C$ declared in library $L$, and let $\{S_1 \ldots S_k\}$ be the set of all superinterfaces of $I$.
|
|
|
|
%Let $I$ be the implicit interface of a class $C$. $I$ inherits any instance members of its superinterfaces that are not overridden by members declared in $C$.
|
|
|
|
% tighten definition? do we need chain as for classes? Definition for interface override?
|
|
|
|
\LMHash{}
|
|
However, if the above rules would cause multiple members $m_1, \ldots, m_k$ with the same name $n$ to be inherited (because identically named members existed in several superinterfaces) then at most one member is inherited.
|
|
|
|
\LMHash{}
|
|
If some but not all of the $m_i, 1 \le i \le k$ are getters none of the $m_i$ are inherited, and a static warning is issued.
|
|
|
|
\LMHash{}
|
|
Otherwise, if the static types $T_1, \ldots, T_k$ of the members $m_1, \ldots, m_k$ are not identical, then there must be a member $m_x$ such that $T_x <: T_i, 1 \le x \le k$ for all $i \in 1..k$, or a static type warning occurs. The member that is inherited is $m_x$, if it exists; otherwise:
|
|
let $numberOfPositionals(f)$ denote the number of positional parameters of a function $f$, and let $numberOfRequiredParams(f)$ denote the number of required parameters of a function $f$. Furthermore, let $s$ denote the set of all named parameters of the $m_1, \ldots, m_k$. Then let
|
|
|
|
$h = max(numberOfPositionals(m_i)), $
|
|
|
|
$r = min(numberOfRequiredParams(m_i)), i \in 1..k$.
|
|
|
|
\LMHash{}
|
|
Then $I$ has a method named $n$, with $r$ required parameters of type \DYNAMIC{}, $h$ positional parameters of type \DYNAMIC{}, named parameters $s$ of type \DYNAMIC{} and return type \DYNAMIC{}.
|
|
|
|
|
|
|
|
\commentary{The only situation where the runtime would be concerned with this would be during reflection, if a mirror attempted to obtain the signature of an interface member.
|
|
}
|
|
|
|
\rationale{
|
|
The current solution is a tad complex, but is robust in the face of type annotation changes. Alternatives: (a) No member is inherited in case of conflict. (b) The first m is selected (based on order of superinterface list) (c) Inherited member chosen at random.
|
|
|
|
(a) means that the presence of an inherited member of an interface varies depending on type signatures. (b) is sensitive to irrelevant details of the declaration and (c) is liable to give unpredictable results between implementations or even between different compilation sessions.
|
|
}
|
|
|
|
% Need warnings if overrider conflicts with overriddee either because signatures are incompatible or because done is a method and one is a getter or setter.
|
|
|
|
\section{Mixins}
|
|
\LMLabel{mixins}
|
|
|
|
|
|
\LMHash{}
|
|
A mixin describes the difference between a class and its superclass. A mixin is always derived from an existing class declaration.
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if a declared or derived mixin explicitly declares a constructor which is not a factory constructor.
|
|
|
|
\rationale{
|
|
This restriction is temporary. We expect to remove it in later versions of Dart.
|
|
|
|
The restriction on constructors simplifies the construction of mixin applications because the process of creating instances is simpler.
|
|
}
|
|
|
|
\subsection{Mixin Application}
|
|
\LMLabel{mixinApplication}
|
|
|
|
\LMHash{}
|
|
A mixin may be applied to a superclass, yielding a new class.
|
|
Mixin application occurs when a mixin is mixed into a class declaration via its \WITH{} clause.
|
|
The mixin application may be used to extend a class per section (\ref{classes}); alternately, a class may be defined as a mixin application as described in this section.
|
|
It is a compile-time error if the \WITH{} clause of a mixin application $C$ includes a type variable (\ref{generics}), a type alias (\ref{typedef}), an enumerated type (\ref{enums}), a malformed type, or a deferred type (\ref{staticTypes}).
|
|
|
|
\begin{grammar}
|
|
{\bf mixinApplicationClass:}
|
|
identifier typeParameters? `=' mixinApplication `{\escapegrammar ;}' .
|
|
|
|
{\bf mixinApplication:}
|
|
type mixins interfaces?
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
A mixin application of the form \code{$S$ \WITH{} $M$;} defines a class $C$ with superclass $S$.
|
|
|
|
\LMHash{}
|
|
A mixin application of the form \code{$S$ \WITH{} $M_1, \ldots, M_k$;} defines a class $C$ whose superclass is the application of the mixin composition (\ref{mixinComposition}) $M_{k-1} * \ldots * M_1$ to $S$.
|
|
|
|
\LMHash{}
|
|
In both cases above, $C$ declares the same instance members as $M$ (respectively, $M_k$).
|
|
If any of the instance variables of $M$ (respectively, $M_k$) have initializers, they are executed in the scope of $M$ (respectively, $M_k$) to initialize the corresponding instance variables of $C$.
|
|
|
|
\LMHash{}
|
|
Let $L_M$ be the library in which $M$ is declared.
|
|
For each generative constructor named $q_i(T_{i1}$ $ a_{i1}, \ldots , T_{ik_i}$ $ a_{ik_i}), i \in 1..n$ of $S$ that is accessible to $L_M$, $C$ has an implicitly declared constructor named
|
|
$q'_i = [C/S]q_i$ of the form
|
|
|
|
$q'_i(a_{i1}, \ldots , a_{ik_i}):\SUPER(a_{i1}, \ldots , a_{ik_i});$.
|
|
|
|
%super.id
|
|
|
|
\LMHash{}
|
|
If the mixin application declares support for interfaces, the resulting class implements those interfaces.
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if $S$ is an enumerated type (\ref{enums}) or a malformed type. It is a compile-time error if $M$ (respectively, any of $M_1, \ldots, M_k$) is an enumerated type (\ref{enums}) or a malformed type. It is a compile time error if a well formed mixin cannot be derived from $M$ (respectively, from each of $M_1, \ldots, M_k$).
|
|
|
|
\LMHash{}
|
|
Let $K$ be a class declaration with the same constructors, superclass and interfaces as $C$, and the instance members declared by $M$ (respectively $M_1, \ldots, M_k$). It is a static warning if the declaration of $K$ would cause a static warning. It is a compile-time error if the declaration of $K$ would cause a compile-time error.
|
|
|
|
\commentary{
|
|
If, for example, $M$ declares an instance member $im$ whose type is at odds with the type of a member of the same name in $S$, this will result in a static warning just as if we had defined $K$ by means of an ordinary class declaration extending $S$, with a body that included $im$.
|
|
|
|
}
|
|
|
|
\LMHash{}
|
|
The effect of a class definition of the form \code{\CLASS{} $C$ = $M$; } or the form \code{\CLASS{} $C<T_1, \ldots, T_n>$ = $M$; } in library $L$ is to introduce the name $C$ into the scope of $L$, bound to the class (\ref{classes}) defined by the mixin application $M$. The name of the class is also set to $C$. Iff the class is prefixed by the built-in identifier \ABSTRACT{}, the class being defined is an abstract class.
|
|
|
|
Let $M_A$ be a mixin derived from a class $M$ with direct superclass $S_{static}$, e.g., as defined by the class declaration \code{class M extends S$_{static}$ \{ \ldots \}}.
|
|
|
|
Let $A$ be an application of $M_A$. It is a static warning if the superclass of $A$ is not a subtype of $S_{static}$.
|
|
|
|
Let $C$ be a class declaration that includes $M_A$ in a with clause. It is a static warning if $C$ does not implement, directly or indirectly, all the direct superinterfaces of $M$.
|
|
|
|
|
|
\subsection{Mixin Composition}
|
|
\LMLabel{mixinComposition}
|
|
|
|
\rationale{
|
|
Dart does not directly support mixin composition, but the concept is useful when defining how the superclass of a class with a mixin clause is created.
|
|
}
|
|
|
|
\LMHash{}
|
|
The {\em composition of two mixins}, $M_1<T_1 \ldots T_{k_{M_1}}>$ and $M_2<U_1 \ldots U_{k_{M_2}}>$, written $M_1<T_1 \ldots T_{k_{M_1}}> * M_2<U_1 \ldots U_{k_{M_2}}>$ defines an anonymous mixin such that for any class $S<V_1 \ldots V_{k_S}>$, the application of
|
|
|
|
$M_1<T_1 \ldots T_{k_{M_1}}> * M_2<U_1 \ldots U_{k_{M_2}}>$
|
|
|
|
to $S<V_1 \ldots V_{k_S}>$ is equivalent to
|
|
|
|
\begin{dartCode}
|
|
\ABSTRACT{} \CLASS{} $Id_1<T_1 \ldots T_{k_{M_1}}, U_1 \ldots U_{k_{M_2}}, V_1 \ldots V_{k_S}> = $
|
|
$Id_2<U_1 \ldots U_{k_{M_2}}, V_1 \ldots V_{k_S}>$ \WITH{} $M_1 <T_1 \ldots T_{k_{M_1}}>$;
|
|
\end{dartCode}
|
|
|
|
where $Id_2$ denotes
|
|
|
|
\begin{dartCode}
|
|
\ABSTRACT{} \CLASS{} $Id_2<U_1 \ldots U_{k_{M_2}}, V_1 \ldots V_{k_S}> =$
|
|
$S<V_1 \ldots V_{k_S}>$ \WITH{} $M_2<U_1 \ldots U_{k_{M_2}}>$;
|
|
\end{dartCode}
|
|
|
|
and $Id_1$ and $Id_2$ are unique identifiers that do not exist anywhere in the program.
|
|
|
|
\rationale{
|
|
The classes produced by mixin composition are regarded as abstract because they cannot be instantiated independently. They are only introduced as anonymous superclasses of ordinary class declarations and mixin applications. Consequently, no warning is given if a mixin composition includes abstract members, or incompletely implements an interface.
|
|
}
|
|
|
|
\LMHash{}
|
|
Mixin composition is associative.
|
|
|
|
|
|
\commentary{
|
|
Note that any subset of $M_1$, $M_2$ and $S$ may or may not be generic. For any non-generic declaration, the corresponding type parameters may be elided, and if no type parameters remain in the derived declarations $Id_1$ and/or $Id_2$ then the those declarations need not be generic either.
|
|
}
|
|
|
|
|
|
\section{Enums}
|
|
\LMLabel{enums}
|
|
|
|
\LMHash{}
|
|
An {\em enumerated type}, or {\em enum}, is used to represent a fixed number of constant values.
|
|
|
|
\begin{grammar}
|
|
{\bf enumType:}
|
|
metadata \ENUM{} id `\{' id [`,' id]* [`,'] `\}'
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
The declaration of an enum of the form \code{metadata \ENUM{} E \{ id$_0$, \ldots id$_{n-1}$\};}
|
|
has the same effect as a class declaration
|
|
|
|
\begin{dartCode}
|
|
metadata \CLASS{} E \{
|
|
\FINAL{} int index;
|
|
\CONST{} E(\THIS{}.index);
|
|
\STATIC{} \CONST{} E id$_0$ = \CONST{} E(0);
|
|
$\ldots$
|
|
\STATIC{} \CONST{} E id$_{n-1}$ = const E(n - 1);
|
|
\STATIC{} \CONST{} List<E> values = const <E>[id$_0 \ldots $ id$_{n-1}$];
|
|
String toString() => \{ 0: `E.id$_0$', $\ldots$, n-1: `E.id$_{n-1}$'\}[index]
|
|
\}
|
|
\end{dartCode}
|
|
|
|
\commentary {
|
|
It is also a compile-time error to subclass, mix-in or implement an enum or to explicitly instantiate an enum. These restrictions are given in normative form in sections \ref{superclasses}, \ref{superinterfaces}, \ref{mixinApplication} and \ref{instanceCreation} as appropriate.
|
|
}
|
|
|
|
\section{Generics}
|
|
\LMLabel{generics}
|
|
|
|
\LMHash{}
|
|
A class declaration (\ref{classes}) or type alias (\ref{typedef})
|
|
$G$ may be {\em generic}, that is, $G$ may have formal type parameters declared. A generic declaration induces a family of declarations, one for each set of actual type parameters provided in the program.
|
|
|
|
\begin{grammar}
|
|
{\bf typeParameter:}
|
|
metadata identifier (\EXTENDS{} type)?
|
|
.
|
|
{\bf typeParameters:}
|
|
`<' typeParameter (`,' typeParameter)* `>'
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
A type parameter $T$ may be suffixed with an \EXTENDS{} clause that specifies the {\em upper bound} for $T$. If no \EXTENDS{} clause is present, the upper bound is \code{Object}. It is a static type warning if a type parameter is a supertype of its upper bound. The bounds of type variables are a form of type annotation and have no effect on execution in production mode.
|
|
|
|
\LMHash{}
|
|
Type parameters are declared in the type-parameter scope of a class.
|
|
The type parameters of a generic $G$ are in scope in the bounds of all of the type parameters of $G$. The type parameters of a generic class declaration $G$ are also in scope in the \EXTENDS{} and \IMPLEMENTS{} clauses of $G$ (if these exist) and in the body of $G$. However, a type parameter is considered to be a malformed type when referenced by a static member.
|
|
|
|
\rationale{
|
|
The restriction is necessary since a type variable has no meaning in the context of a static member, because statics are shared among all instantiations of a generic. However, a type variable may be referenced from an instance initializer, even though \THIS{} is not available.
|
|
}
|
|
|
|
\commentary{
|
|
Because type parameters are in scope in their bounds, we support F-bounded quantification (if you don't know what that is, don't ask). This enables typechecking code such as:
|
|
}
|
|
|
|
\begin{dartCode}
|
|
\CLASS{} Ordered<T> \{
|
|
operator > (T x);
|
|
\}
|
|
|
|
\CLASS{} Sorter<T \EXTENDS{} Ordered<T$>>$ \{
|
|
sort(List<T> l) {... l[n] < l[n+1] ...}
|
|
\}
|
|
|
|
\end{dartCode}
|
|
|
|
\commentary{
|
|
Even where type parameters are in scope there are numerous restrictions at this time:
|
|
\begin{itemize}
|
|
\item A type parameter cannot be used to name a constructor in an instance creation expression (\ref{instanceCreation}).
|
|
\item A type parameter cannot be used as a superclass or superinterface (\ref{superclasses}, \ref{superinterfaces}, \ref{interfaceSuperinterfaces}).
|
|
\item A type parameter cannot be used as a generic type.
|
|
\end{itemize}
|
|
|
|
The normative versions of these are given in the appropriate sections of this specification. Some of these restrictions may be lifted in the future.
|
|
}
|
|
|
|
%The {\em induced type set}, $S$, of a parameterized type $T$ is the set consisting of
|
|
%\begin{itemize}
|
|
%\item The supertypes of any type in $S$.
|
|
%\item The type arguments of any parameterized type in $S$.
|
|
%\end{itemize}
|
|
|
|
%Let $P$ be the instantiation of a generic type with its own type parameters. It is a compile-time error if the induced type set of $P$ is not finite.
|
|
|
|
%\rationale {A typical recursive type declaration such as}
|
|
|
|
%\begin{dartCode}
|
|
%\CLASS{} B<S> \{\}
|
|
%\CLASS{} D<T> \EXTENDS{} B<D<T$>>$ \{\}
|
|
%\end{dartCode}
|
|
|
|
%\rationale{
|
|
%poses no problem under this rule. The instantiation \cd{D<T>} has an induced
|
|
%set consisting of: \cd{B<D<T$>>$, Object, D<T>, T}. However, the following variant
|
|
%}
|
|
|
|
%\begin{dartCode}
|
|
%\CLASS{} B<S> \{\}
|
|
%\CLASS{} D<T> \EXTENDS{} B<D<D<T$>>>$ \{\}
|
|
%\end{dartCode}
|
|
|
|
%\rationale{
|
|
%is disallowed. Consider again the instantiation \cd{D<T>}. It leads to the
|
|
%superclass \cd{B<D<D<T$>>>$}, and so adds \cd{D<D$< $T$>>$} to the induced set. The latter in turn leads to \cd{B<D<D<D<T$>>>>$} and \cd{D<D<D<T$>>>$}
|
|
%and so on ad infinitum.}
|
|
|
|
%\commentary{
|
|
%The above requirement does not preclude the use of arbitrary recursive types in the body of a generic class. }
|
|
%A generic has a type parameter scope. The enclosing scope of a type parameter scope of a generic G is the enclosing scope of G.
|
|
|
|
|
|
%class T {...}
|
|
|
|
%class G<T> extends T;
|
|
|
|
%By current rules, this is illegal. Make sure we preserve this.
|
|
|
|
|
|
%\subsection{Interface Injection}
|
|
%\LMLabel{interfaceInjection}
|
|
|
|
%An {\em interface injection declaration} causes a pre-existing class $S$ to be considered a subinterface of another interface $I$. It is a static type warning if $S$ is not a structural subtype of $I$. However, the subinterface relations implied by the interface injection declaration are considered to hold by both the typechecker and the runtime, regardless.
|
|
|
|
%\begin{grammar}
|
|
%classInterfaceInjection:
|
|
%class qualified typeParameters? interfaces `{\escapegrammar ;}'
|
|
% .
|
|
|
|
|
|
%interfaceInterfaceInjection:
|
|
%interface qualified typeParameters? superinterfaces `{\escapegrammar ;}'
|
|
%.
|
|
%\end{grammar}
|
|
|
|
%\rationale{Since subinterface relations can be tested dynamically via \IS{}, interface injection is not just a directive to the static checker. The dynamic relations implied must hold regardless of whether a static typecheck has succeeded, or has been performed at all. This makes sense from the perspective of preserving programmer intent. The injection describes a nominal type relation that the programmer wishes to hold. Just as a supertype mentioned within a class declaration is considered a supertype even though type errors might arise among (say) overridden and overriding methods, so it must be that the relation implied by an injection holds regardless of type errors.
|
|
%In addition, this decision helps to produce meaningful and localized error messages. Any errors are reported at the point of injection rather than at program points that rely on the relation (a well known problem with structural subtyping in OO systems).
|
|
%}
|
|
|
|
%\Q{When does an interface injection take effect? When the containing library is loaded?
|
|
%What is the scope of such a declaration? Is it global, or only in the scope of the containing library? The scope of such a declaration is global.
|
|
%An injection must be at top level. Who has the right to inject an interface $I$ into another class $C$? Anybody? But since this affects dynamic behavior, is this a weird security issue?
|
|
%The current theory is that there is no security within an isolate, and one can never refer to a type from another isolate, so supposedly not an issue. This assumption (no mutually suspicious code in the same isolate) is suspect but it seems there is nothing to be done at this point.
|
|
%If libs are first class, they get created dynamically in order, and new libs might modify the type relations among other libs types - but then it is clear when that happened and order is ok.
|
|
%}
|
|
|
|
%It is a compile-time error if a type $T$ appears more than once in the implements or eextends clause of an interface injection.
|
|
|
|
|
|
\section{Metadata}
|
|
\LMLabel{metadata}
|
|
|
|
\LMHash{}
|
|
Dart supports metadata which is used to attach user defined annotations to program structures.
|
|
|
|
\begin{grammar}
|
|
{\bf metadata:}
|
|
(`@' qualified ({\escapegrammar `.'} identifier)? (arguments)?)*
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
Metadata consists of a series of annotations, each of which begin with the character @, followed by a constant expression that starts with an identifier. It is a compile time error if the expression is not one of the following:
|
|
\begin{itemize}
|
|
\item A reference to a compile-time constant variable.
|
|
\item A call to a constant constructor.
|
|
\end{itemize}
|
|
|
|
\LMHash{}
|
|
Metadata is associated with the abstract syntax tree of the program construct $p$ that immediately follows the metadata, assuming $p$ is not itself metadata or a comment. Metadata can be retrieved at runtime via a reflective call, provided the annotated program construct $p$ is accessible via reflection.
|
|
|
|
\commentary{
|
|
Obviously, metadata can also be retrieved statically by parsing the program and evaluating the constants via a suitable interpreter. In fact many if not most uses of metadata are entirely static.
|
|
}
|
|
|
|
\rationale{
|
|
It is important that no runtime overhead be incurred by the introduction of metadata that is not actually used. Because metadata only involves constants, the time at which it is computed is irrelevant so that implementations may skip the metadata during ordinary parsing and execution and evaluate it lazily.
|
|
}
|
|
|
|
\commentary{
|
|
It is possible to associate metadata with constructs that may not be accessible via reflection, such as local variables (though it is conceivable that in the future, richer reflective libraries might provide access to these as well). This is not as useless as it might seem. As noted above, the data can be retrieved statically if source code is available.
|
|
}
|
|
|
|
\LMHash{}
|
|
Metadata can appear before a library, part header, class, typedef, type parameter, constructor, factory, function, parameter, or variable declaration and before an import, export or part directive.
|
|
|
|
\LMHash{}
|
|
The constant expression given in an annotation is type checked and evaluated in the scope surrounding the declaration being annotated.
|
|
|
|
|
|
\section{Expressions}
|
|
\LMLabel{expressions}
|
|
|
|
\LMHash{}
|
|
\label{evaluation}
|
|
An {\em expression} is a fragment of Dart code that can be evaluated at run time.
|
|
Evaluating an expression either {\em produces a value} (an object),
|
|
or it {\em throws} an exception object and an associated stack trace.
|
|
In the former case, we also say that the expression {\em evaluates to a value}.
|
|
|
|
\LMHash{}
|
|
Every expression has an associated static type (\ref{staticTypes}).
|
|
Every value has an associated dynamic type (\ref{dynamicTypeSystem}).
|
|
|
|
\LMHash{}
|
|
If evaluation of one expression, $e$, is defined in terms of evaluation of another expression, typically a subexpression of $e$,
|
|
and the evaluation of the other expression throws an exception and a stack trace,
|
|
the evaluation of $e$ stops at that point and throws the same exception object and stack trace.
|
|
|
|
\begin{grammar}
|
|
|
|
{\bf expression:}assignableExpression assignmentOperator expression;
|
|
conditionalExpression cascadeSection*;
|
|
throwExpression
|
|
.
|
|
|
|
|
|
{\bf expressionWithoutCascade:}assignableExpression assignmentOperator expressionWithoutCascade;
|
|
conditionalExpression;
|
|
throwExpressionWithoutCascade
|
|
.
|
|
|
|
{\bf expressionList:}
|
|
expression (`,' expression)* %should these be top level expressions?
|
|
.
|
|
\end{grammar}
|
|
|
|
\begin{grammar}
|
|
{\bf primary:}thisExpression;
|
|
\SUPER{} unconditionalAssignableSelector;
|
|
functionExpression;
|
|
literal;
|
|
identifier;
|
|
newExpression;
|
|
constObjectExpression;
|
|
`(' expression `)'
|
|
.
|
|
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
An expression $e$ may always be enclosed in parentheses, but this never has any semantic effect on $e$.
|
|
|
|
\commentary{
|
|
Sadly, it may have an effect on the surrounding expression. Given a class $C$ with static method $m => 42$, $C.m()$ returns 42, but $(C).m()$ produces a \code{NoSuchMethodError}. This anomaly can be corrected by removing the restrictions on calling the members of instances of \code{Type}. This issue may be addressed in future versions of Dart.
|
|
}
|
|
|
|
\subsubsection{Object Identity}
|
|
\LMLabel{objectIdentity}
|
|
|
|
\LMHash{}
|
|
The predefined Dart function \cd{identical()} is defined such that \code{identical($c_1$, $c_2$)} iff:
|
|
\begin{itemize}
|
|
\item $c_1$ evaluates to either \NULL{} or an instance of \code{bool} and \code{$c_1$ == $c_2$}, OR
|
|
\item $c_1$ and $c_2$ are instances of \code{int} and \code{$c_1$ == $c_2$}, OR
|
|
\item $c_1$ and $c_2$ are constant strings and \code{$c_1$ == $c_2$}, OR
|
|
\item $c_1$ and $c_2$ are instances of \cd{double} and one of the following holds:
|
|
\begin{itemize}
|
|
\item $c_1$ and $c_2$ are non-zero and \code{$c_1$ == $c_2$}.
|
|
\item Both $c_1$ and $c_2$ are $+0.0$.
|
|
\item Both $c_1$ and $c_2$ are $-0.0$.
|
|
\item Both $c_1$ and $c_2$ represent a NaN value with the same underlying bit pattern.
|
|
\end{itemize}
|
|
OR
|
|
\item $c_1$ and $c_2$ are constant lists that are defined to be identical in the specification of literal list expressions (\ref{lists}), OR
|
|
\item $c_1$ and $c_2$ are constant maps that are defined to be identical in the specification of literal map expressions (\ref{maps}), OR
|
|
\item $c_1$ and $c_2$ are constant objects of the same class $C$ and the value of each instance variable of $c_1$ is identical to the value of the corresponding instance variable of $c_2$. OR
|
|
\item $c_1$ and $c_2$ are the same object.
|
|
\end{itemize}
|
|
|
|
\commentary{
|
|
The definition of \cd{identity} for doubles differs from that of equality in that a NaN is identical to itself, and that negative and positive zero are distinct.
|
|
}
|
|
|
|
\rationale{
|
|
The definition of equality for doubles is dictated by the IEEE 754 standard, which posits that NaNs do not obey the law of reflexivity. Given that hardware implements these rules, it is necessary to support them for reasons of efficiency.
|
|
|
|
The definition of identity is not constrained in the same way. Instead, it assumes that bit-identical doubles are identical.
|
|
|
|
The rules for identity make it impossible for a Dart programmer to observe whether a boolean or numerical value is boxed or unboxed.
|
|
}
|
|
|
|
|
|
\subsection{Constants}
|
|
\LMLabel{constants}
|
|
|
|
\LMHash{}
|
|
A {\em constant expression} is an expression whose value can never change, and that can be evaluated entirely at compile time.
|
|
|
|
\LMHash{}
|
|
A constant expression is one of the following:
|
|
\begin{itemize}
|
|
\item A literal number (\ref{numbers}).
|
|
\item A literal boolean (\ref{booleans}).
|
|
\item A literal string (\ref{strings}) where any interpolated expression (\ref{stringInterpolation}) is a compile-time constant that evaluates to a numeric, string or boolean value or to \NULL{}.
|
|
\rationale{It would be tempting to allow string interpolation where the interpolated value is any compile-time constant. However, this would require running the \code{toString()} method for constant objects, which could contain arbitrary code.}
|
|
\item A literal symbol (\ref{symbols}).
|
|
\item \NULL{} (\ref{null}).
|
|
\item A qualified reference to a static constant variable (\ref{variables}) that is not qualified by a deferred prefix.
|
|
\commentary {For example, If class C declares a constant static variable v, C.v is a constant. The same is true if C is accessed via a prefix p; p.C.v is a constant unless p is a deferred prefix.
|
|
}
|
|
\item An identifier expression that denotes a constant variable.
|
|
\item A simple or qualified identifier denoting a class or type alias that is not qualified by a deferred prefix.
|
|
\commentary {For example, If C is a class or typedef, C is a constant, and if C is imported with a prefix p, p.C is a constant unless p is a deferred prefix.
|
|
}
|
|
\item A constant constructor invocation (\ref{const}) that is not qualified by a deferred prefix.
|
|
\item A constant list literal (\ref{lists}).
|
|
\item A constant map literal (\ref{maps}).
|
|
\item A simple or qualified identifier denoting a top-level function (\ref{functions}) or a static method (\ref{staticMethods}) that is not qualified by a deferred prefix.
|
|
\item A parenthesized expression \code{($e$)} where $e$ is a constant expression.
|
|
\item An expression of the form \code{identical($e_1$, $e_2$)} where $e_1$ and $e_2$ are constant expressions and \code{identical()} is statically bound to the predefined dart function \code{identical()} discussed above (\ref{objectIdentity}).
|
|
\item An expression of one of the forms \code{$e_1$ == $e_2$} or \code{$e_1$ != $e_2$} where $e_1$ and $e_2$ are constant expressions that evaluate to a numeric, string or boolean value or to \NULL{}.
|
|
\item An expression of one of the forms \code{!$e$}, \code{$e_1$ \&\& $e_2$} or \code{$e_1 || e_2$}, where $e$, $e_1$ and $e_2$ are constant expressions that evaluate to a boolean value.
|
|
\item An expression of one of the forms \~{}$e$, $e_1$ \^{} $e_2$, \code{$e_1$ \& $e_2$}, $e_1 | e_2$, $e_1 >> e_2$ or $e_1 << e_2$, where $e$, $e_1$ and $e_2$ are constant expressions that evaluate to an integer value or to \NULL{}.
|
|
\item An expression of the form \code{$e_1 + e_2$} where $e_1$ and $e_2$ are constant expressions that evaluate to a numeric or string value or to \NULL{}.
|
|
\item An expression of one of the forms \code{$-e$}, \code{$e_1$ - $e_2$}, \code{$e_1$ * $e_2$}, \code{$e_1$ / $e_2$,} \code{$e_1$ \~{}/ $e_2$}, \code{$e_1 > e_2$}, \code{$e_1 < e_2$}, \code{$e_1$ >= $e_2$}, \code{$e_1$ <= $e_2$} or \code{$e_1$ \% $e_2$}, where $e$, $e_1$ and $e_2$ are constant expressions that evaluate to a numeric value or to \NULL{}.
|
|
\item An expression of the form \code{$e_1$?$e_2$:$e3$} where $e_1$, $e_2$ and $e_3$ are constant expressions and $e_1$ evaluates to a boolean value.
|
|
\item An expression of the form \code{$e_1 ?? e_2$} where $e_1$ and $e_2$ are constant expressions.
|
|
\item An expression of the form \code{$e$.length} where $e$ is a constant expression that evaluates to a string value.
|
|
\end{itemize}
|
|
|
|
% null in all the expressions
|
|
|
|
% designed so constants do not depend on check diode being on or not.
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if an expression is required to be a constant expression but its evaluation would throw an exception.
|
|
|
|
% so, checked mode? analyzers? editor/development compilers?
|
|
\commentary{
|
|
Note that there is no requirement that every constant expression evaluate correctly. Only when a constant expression is required (e.g., to initialize a constant variable, or as a default value of a formal parameter, or as metadata) do we insist that a constant expression actually be evaluated successfully at compile time.
|
|
|
|
The above is not dependent on program control-flow. The mere presence of a required compile time constant whose evaluation would fail within a program is an error. This also holds recursively: since compound constants are composed out of constants, if any subpart of a constant would throw an exception when evaluated, that is an error.
|
|
|
|
On the other hand, since implementations are free to compile code late, some compile-time errors may manifest quite late.
|
|
}
|
|
|
|
\begin{dartCode}
|
|
\CONST{} x = 1 ~/ 0;
|
|
\FINAL{} y = 1 ~/ 0;
|
|
|
|
\CLASS{} K \{
|
|
m1() \{
|
|
\VAR{} z = \FALSE{};
|
|
\IF{} (z) \{\RETURN{} x; \}
|
|
\ELSE{} \{ \RETURN{} 2;\}
|
|
\}
|
|
|
|
m2() \{
|
|
\IF{} (\TRUE{}) \{\RETURN{} y; \}
|
|
\ELSE{} \{ \RETURN{} 3;\}
|
|
\}
|
|
\}
|
|
\end{dartCode}
|
|
|
|
\commentary{An implementation is free to immediately issue a compilation error for \code{x}, but it is not required to do so. It could defer errors if it does not immediately compile the declarations that reference \code{x}. For example, it could delay giving a compilation error about the method \code{m1} until the first invocation of \code{m1}. However, it could not choose to execute \code{m1}, see that the branch that refers to \code{x} is not taken and return 2 successfully.
|
|
|
|
The situation with respect to an invocation \code{m2} is different. Because \code{y} is not a compile-time constant (even though its value is), one need not give a compile-time error upon compiling \code{m2}. An implementation may run the code, which will cause the getter for \code{y} to be invoked. At that point, the initialization of \code{y} must take place, which requires the initializer to be compiled, which will cause a compilation error.
|
|
}
|
|
|
|
\rationale{
|
|
The treatment of \NULL{} merits some discussion. Consider \code{\NULL{} + 2}. This expression always causes an error. We could have chosen not to treat it as a constant expression (and in general, not to allow \NULL{} as a subexpression of numeric or boolean constant expressions). There are two arguments for including it:
|
|
\begin{enumerate}
|
|
\item It is constant. We can evaluate it at compile-time.
|
|
\item It seems more useful to give the error stemming from the evaluation explicitly.
|
|
\end{enumerate}
|
|
}
|
|
|
|
\rationale {
|
|
One might reasonably ask why $e_1? e_1: e_3$ and $e_1?? e_2$ have constant forms. For example, if $e_1$ is known statically, why do we need to test it?.
|
|
The answer is that there are contexts where $e_1$ is a variable. In particular, constant constructor initializers such as
|
|
|
|
\code{\CONST{} C(foo) : \THIS.foo = foo ?? someDefaultValue;}
|
|
}
|
|
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if the value of a compile-time constant expression depends on itself.
|
|
|
|
\commentary{
|
|
As an example, consider:
|
|
}
|
|
|
|
\begin{dartCode}
|
|
\CLASS{} CircularConsts\{
|
|
// Illegal program - mutually recursive compile-time constants
|
|
\STATIC{} \CONST{} i = j; // a compile-time constant
|
|
\STATIC{} \CONST{} j = i; // a compile-time constant
|
|
\}
|
|
\end{dartCode}
|
|
|
|
|
|
\begin{grammar}
|
|
{\bf literal:}nullLiteral;
|
|
booleanLiteral;
|
|
numericLiteral;
|
|
stringLiteral;
|
|
symbolLiteral;
|
|
mapLiteral;
|
|
listLiteral
|
|
.
|
|
\end{grammar}
|
|
|
|
|
|
|
|
\subsection{Null}
|
|
\LMLabel{null}
|
|
|
|
\LMHash{}
|
|
The reserved word \NULL{} evaluates to the {\em null object}.
|
|
%\Q{Any methods, such as \code{isNull}?}
|
|
|
|
\begin{grammar}
|
|
{\bf nullLiteral:}
|
|
\NULL{}
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
The null object is the sole instance of the built-in class \code{Null}. Attempting to instantiate \code{Null} causes a run-time error. It is a compile-time error for a class to extend, mix in or implement \code{Null}.
|
|
The \code{Null} class extends the \code{Object} class and declares no methods except those also declared by \code{Object}.
|
|
|
|
\LMHash{}
|
|
The static type of \NULL{} is the \code{Null} type.
|
|
|
|
|
|
\subsection{Numbers}
|
|
\LMLabel{numbers}
|
|
|
|
\LMHash{}
|
|
A {\em numeric literal} is either a decimal or hexadecimal integer of arbitrary size, or a decimal double.
|
|
|
|
\begin{grammar}
|
|
{\bf numericLiteral:}NUMBER;
|
|
HEX\_NUMBER
|
|
.
|
|
|
|
{\bf NUMBER:} DIGIT+ (`{\escapegrammar.}' DIGIT+)? EXPONENT?;
|
|
{`\escapegrammar .}' DIGIT+ EXPONENT?
|
|
.
|
|
|
|
{\bf EXPONENT:}
|
|
(`e' $|$ `E') ('+' $|$ `-`)? DIGIT+
|
|
.
|
|
|
|
{\bf HEX\_NUMBER:}`0x' HEX\_DIGIT+;
|
|
`0X' HEX\_DIGIT+
|
|
.
|
|
|
|
{\bf HEX\_DIGIT:}`a'{\escapegrammar ..}'f';
|
|
`A'{\escapegrammar ..}'F';
|
|
DIGIT
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
If a numeric literal begins with the prefix `0x' or `0X',
|
|
it denotes the integer represented by the hexadecimal numeral
|
|
following `0x' (respectively `0X').
|
|
Otherwise, if the numeric literal contains only decimal digits,
|
|
it denotes an integer represented as a decimal numeral.
|
|
In either case the literal evaluates to an instance of the class \code{int}
|
|
with the integer value represented by that numeral.
|
|
Otherwise, the numeric literal contains either a decimal point or an exponent part
|
|
and it evaluates to a an instance of the `double` class
|
|
representing a 64 bit double precision floating point number
|
|
as specified by the IEEE 754 standard.
|
|
|
|
\LMHash{}
|
|
In principle, the range of integers supported by a Dart implementations is unlimited. In practice, it is limited by available memory. Implementations may also be limited by other considerations.
|
|
|
|
\commentary{
|
|
For example, implementations may choose to limit the range to facilitate efficient compilation to Javascript. These limitations should be relaxed as soon as technologically feasible.
|
|
}
|
|
|
|
\LMHash{}
|
|
It is a compile-time error for a class to extend, mix in or implement \code{int}.
|
|
It is a compile-time error for a class to extend, mix in or implement \code{double}.
|
|
It is a compile-time error for any class other than \code{int} and \code{double} to extend, mix in or implement \code{num}.
|
|
|
|
\LMHash{}
|
|
An {\em integer literal} is either a hexadecimal integer literal or a decimal integer literal.
|
|
The static type of an integer literal is \code{int}.
|
|
|
|
\LMHash{}
|
|
A {\em literal double} is a numeric literal that is not an integer literal. The static type of a literal double is \code{double}.
|
|
|
|
\subsection{Booleans}
|
|
\LMLabel{booleans}
|
|
|
|
\LMHash{}
|
|
The reserved words \TRUE{} and \FALSE{} evaluate to objects {\em true} and {\em false} that represent the boolean values true and false respectively.
|
|
They are the {\em boolean literals}.
|
|
|
|
\begin{grammar}
|
|
{\bf booleanLiteral:}\TRUE{};
|
|
\FALSE{}
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
Both {\em true} and {\em false} are instances of the built-in class \code{bool},
|
|
and there are no other objects that implement \code{bool}.
|
|
It is a compile-time error for a class to extend, mix in or implement \code{bool}.
|
|
|
|
\LMHash{}
|
|
Invoking the getter \code{runtimeType} on a boolean value returns the \code{Type} object that is the value of the expression \code{bool}. The static type of a boolean literal is \code{bool}.
|
|
|
|
\subsubsection{Boolean Conversion}
|
|
\LMLabel{booleanConversion}
|
|
|
|
\LMHash{}
|
|
{\em Boolean conversion} maps any object $o$ into a boolean. Boolean conversion is defined by the function application
|
|
|
|
\begin{dartCode}
|
|
(bool v)\{
|
|
\ASSERT{}(v != \NULL{});
|
|
% \IF{} (\NULL{} == v) \{ \THROW{} \NEW{} AssertionError('null is not a bool')\};
|
|
\RETURN{} identical(v, \TRUE{});
|
|
\}(o)
|
|
\end{dartCode}
|
|
|
|
\rationale{
|
|
Boolean conversion is used as part of control-flow constructs and boolean expressions. Ideally, one would simply insist that control-flow decisions be based exclusively on booleans. This is straightforward in a statically typed setting. In a dynamically typed language, it requires a dynamic check. Sophisticated virtual machines can minimize the penalty involved. Alas, Dart must be compiled into Javascript. Boolean conversion allows this to be done efficiently.
|
|
|
|
At the same time, this formulation differs radically from Javascript, where most numbers and objects are interpreted as \TRUE{}. Dart's approach prevents usages such \code{\IF{} (a-b) ... ; }because it does not agree with the low level conventions whereby non-null objects or non-zero numbers are treated as \TRUE{}. Indeed, there is no way to derive \TRUE{} from a non-boolean object via boolean conversion, so this kind of low level hackery is nipped in the bud.
|
|
|
|
Dart also avoids the strange behaviors that can arise due to the interaction of boolean conversion with autoboxing in Javascript. A notorious example is the situation where \FALSE{} can be interpreted as \TRUE{}. In Javascript, booleans are not objects, and instead are autoboxed into objects where ``needed''. If \FALSE{} gets autoboxed into an object, that object can be coerced into \TRUE{} (as it is a non-null object).
|
|
}
|
|
|
|
\commentary{Because boolean conversion requires its parameter to be a boolean, any construct that makes use of boolean conversion will cause a dynamic type error in checked mode if the value to be converted is not a boolean.
|
|
}
|
|
|
|
\subsection{Strings}
|
|
\LMLabel{strings}
|
|
|
|
\LMHash{}
|
|
A {\em string} is a sequence of UTF-16 code units.
|
|
|
|
\rationale{
|
|
This decision was made for compatibility with web browsers and Javascript. Earlier versions of the specification required a string to be a sequence of valid Unicode code points. Programmers should not depend on this distinction.
|
|
}
|
|
|
|
\begin{grammar}
|
|
{\bf stringLiteral:}(multilineString $|$ singleLineString)+
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
A string can be a sequence of single line strings and multiline strings.
|
|
|
|
\begin{grammar}
|
|
{\bf singleLineString:}`{\escapegrammar \code{"}}' stringContentDQ* `{\escapegrammar \code{"}}';
|
|
`{\escapegrammar \code{'}}' stringContentSQ* `{\escapegrammar \code{'}}';
|
|
`r' `{\escapegrammar \code{'}}' (\~{}( `{\escapegrammar \code{'}}' $|$ NEWLINE ))* `{\escapegrammar \code{'}}';
|
|
`r' `{\escapegrammar \code{"}}' (\~{}( `{\escapegrammar \code{"}}' $|$ NEWLINE ))* `{\escapegrammar \code{"}}'
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
A single line string is delimited by either matching single quotes or matching double quotes.
|
|
|
|
\commentary{
|
|
Hence, `abc' and ``abc'' are both legal strings, as are `He said ``To be or not to be'' did he not?' and ``He said `To be or not to be' didn't he''. However ``This ` is not a valid string, nor is `this''.
|
|
}
|
|
|
|
\commentary{The grammar ensures that a single line string cannot span more than one line of source code, unless it includes an interpolated expression that spans multiple lines.
|
|
}
|
|
|
|
\LMHash{}
|
|
Adjacent strings are implicitly concatenated to form a single string literal.
|
|
|
|
|
|
\commentary{Here is an example}
|
|
|
|
\begin{dartCode}
|
|
print("A string" "and then another"); // prints: A stringand then another
|
|
\end{dartCode}
|
|
|
|
\rationale{Dart also supports the operator + for string concatenation.
|
|
|
|
The + operator on Strings requires a String argument. It does not coerce its argument into a string. This helps avoid puzzlers such as
|
|
}
|
|
|
|
\begin{dartCode}
|
|
print("A simple sum: 2 + 2 = " +
|
|
2 + 2);
|
|
\end{dartCode}
|
|
|
|
\rationale{ which this prints 'A simple sum: 2 + 2 = 22' rather than 'A simple sum: 2 + 2 = 4'.
|
|
However, the use of the concatenation operation is still discouraged for efficiency reasons. Instead, the recommended Dart idiom is to use string interpolation.
|
|
}
|
|
|
|
\begin{dartCode}
|
|
print("A simple sum: 2 + 2 = \$\{2+2\}");
|
|
\end{dartCode}
|
|
|
|
|
|
\rationale{String interpolation works well for most cases. The main situation where it is not fully satisfactory is for string literals that are too large to fit on a line. Multiline strings can be useful, but in some cases, we want to visually align the code. This can be expressed by writing smaller strings separated by whitespace, as shown here:}
|
|
|
|
|
|
|
|
|
|
\begin{dartCode}
|
|
'Imagine this is a very long string that does not fit on a line. What shall we do? '
|
|
'Oh what shall we do? '
|
|
'We shall split it into pieces '
|
|
'like so'.
|
|
\end{dartCode}
|
|
|
|
|
|
|
|
|
|
|
|
\begin{grammar}
|
|
{\bf multilineString:}`{\escapegrammar \texttt{"""}}' stringContentTDQ* `{\escapegrammar \texttt{"""}}';
|
|
`{\escapegrammar \code{'}\code{'}\code{'}}' stringContentTSQ* `{\escapegrammar \code{'}\code{'}\code{'}}';
|
|
`r' `{\escapegrammar \texttt{"""}}' (\~{} `{\escapegrammar \texttt{"""}}')* `{\escapegrammar \texttt{"""}}';
|
|
`r' `{\escapegrammar \code{'}\code{'}\code{'}}' (\~{} `{\escapegrammar \code{'}\code{'}\code{'}}')* `{\escapegrammar \code{'}\code{'}\code{'}}'
|
|
.
|
|
|
|
|
|
{\bf ESCAPE\_SEQUENCE:}`$\backslash$ n';
|
|
`$\backslash$ r';
|
|
`$\backslash$ f';
|
|
`$\backslash$ b';
|
|
`$\backslash$ t';
|
|
`$\backslash$ v';
|
|
`$\backslash$ x' HEX\_DIGIT HEX\_DIGIT;
|
|
`$\backslash$ u' HEX\_DIGIT HEX\_DIGIT HEX\_DIGIT HEX\_DIGIT;
|
|
`$\backslash$ u\{' HEX\_DIGIT\_SEQUENCE `\}'
|
|
.
|
|
|
|
{\bf HEX\_DIGIT\_SEQUENCE:}
|
|
HEX\_DIGIT HEX\_DIGIT? HEX\_DIGIT? HEX\_DIGIT? HEX\_DIGIT? HEX\_DIGIT?
|
|
.
|
|
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
Multiline strings are delimited by either matching triples of single quotes or matching triples of double quotes. If the first line of a multiline string consists solely of the whitespace characters defined by the production {\em WHITESPACE} \ref{lexicalRules}), possibly prefixed by $\backslash$, then that line is ignored, including the line break at its end.
|
|
|
|
\rationale{
|
|
The idea is to ignore a whitespace-only first line of a multiline string, where whitespace is defined as tabs, spaces and the final line break. These can be represented directly, but since for most characters prefixing by backslash is an identity in a non-raw string, we allow those forms as well.
|
|
}
|
|
|
|
% could be clearer. Is the first line in """\t
|
|
% """ ignored not. It depends if we mean whitespace before escapes are interpreted,
|
|
% or after, or both. See https://code.google.com/p/dart/issues/detail?id=23020
|
|
|
|
\LMHash{}
|
|
Strings support escape sequences for special characters. The escapes are:
|
|
\begin{itemize}
|
|
\item $\backslash$n for newline, equivalent to $\backslash$x0A.
|
|
\item $\backslash$r for carriage return, equivalent to $\backslash$x0D.
|
|
\item $\backslash$f for form feed, equivalent to $\backslash$x0C.
|
|
\item $\backslash$b for backspace, equivalent to $\backslash$x08.
|
|
\item $\backslash$t for tab, equivalent to $\backslash$x09.
|
|
\item $\backslash$v for vertical tab, equivalent to $\backslash$x0B
|
|
\item $\backslash$x $HEX\_DIGIT_1$ $HEX\_DIGIT_2$, equivalent to
|
|
|
|
$\backslash$u\{$HEX\_DIGIT_1$ $HEX\_DIGIT_2$\}.
|
|
\item $\backslash$u $HEX\_DIGIT_1$ $HEX\_DIGIT_2$ $HEX\_DIGIT_3$ $HEX\_DIGIT_4$, equivalent to $\backslash$u\{$HEX\_DIGIT_1$ $HEX\_DIGIT_2$ $HEX\_DIGIT_3$ $HEX\_DIGIT_4$\}.
|
|
\item $\backslash$u\{$HEX\_DIGIT\_SEQUENCE$\} is the Unicode code point represented by the $HEX\_DIGIT\_SEQUENCE$. It is a compile-time error if the value of the $HEX\_DIGIT\_SEQUENCE$ is not a valid Unicode code point.
|
|
\item \$ indicating the beginning of an interpolated expression.
|
|
\item Otherwise, $\backslash k$ indicates the character $k$ for any $k$ not in $\{n, r, f, b, t, v, x, u\}$.
|
|
\end{itemize}
|
|
|
|
\LMHash{}
|
|
Any string may be prefixed with the character `r', indicating that it is a {\em raw string}, in which case no escapes or interpolations are recognized.
|
|
|
|
\LMHash{}
|
|
Line breaks in a multiline string are represented by the {\em NEWLINE} production.
|
|
A line break introduces a single newline character into the string value.
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if a non-raw string literal contains a character sequence of the form $\backslash$x that is not followed by a sequence of two hexadecimal digits. It is a compile-time error if a non-raw string literal contains a character sequence of the form $\backslash$u that is not followed by either a sequence of four hexadecimal digits, or by curly brace delimited sequence of hexadecimal digits.
|
|
|
|
|
|
|
|
\begin{grammar}
|
|
{\bf stringContentDQ:}\~{}( `$\backslash$' $|$ `{\escapegrammar \texttt{"}}' $|$ `\$' $|$ NEWLINE );
|
|
`$\backslash$' \~{}( NEWLINE );
|
|
stringInterpolation
|
|
.
|
|
|
|
{\bf stringContentSQ:}\~{}( `$\backslash$' $|$ `{\escapegrammar \texttt{'}}' $|$ `\$' $|$ NEWLINE );
|
|
`$\backslash$' \~{}( NEWLINE );
|
|
stringInterpolation
|
|
.
|
|
|
|
|
|
{\bf stringContentTDQ:}\~{}( `$\backslash$' $|$ `{\escapegrammar \texttt{"""}}' $|$ `\$');
|
|
stringInterpolation
|
|
.
|
|
|
|
{\bf stringContentTSQ:}\~{}( `$\backslash$' $|$ `{\escapegrammar \code{'}\code{'}\code{'}}' $|$ `\$');
|
|
stringInterpolation
|
|
.
|
|
|
|
{\bf NEWLINE:}$\backslash$ n;
|
|
$\backslash$ r;
|
|
$\backslash$ r $\backslash$ n
|
|
.
|
|
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
All string literals evaluate to instances of the built-in class \code{String}.
|
|
It is a compile-time error for a class to extend, mix in or implement \code{String}.
|
|
The static type of a string literal is \code{String}.
|
|
|
|
\subsubsection{String Interpolation}
|
|
\LMLabel{stringInterpolation}
|
|
|
|
\LMHash{}
|
|
It is possible to embed expressions within non-raw string literals, such that these expressions are evaluated, and the resulting values are converted into strings and concatenated with the enclosing string. This process is known as {\em string interpolation}.
|
|
|
|
\begin{grammar}
|
|
{\bf stringInterpolation:}`\$' IDENTIFIER\_NO\_DOLLAR;
|
|
`\$' `\{' expression `\}' % could be top level expression, no?
|
|
.
|
|
\end{grammar}
|
|
|
|
\commentary{The reader will note that the expression inside the interpolation could itself include strings, which could again be interpolated recursively.
|
|
}
|
|
|
|
\LMHash{}
|
|
An unescaped \$ character in a string signifies the beginning of an interpolated expression. The \$ sign may be followed by either:
|
|
\begin{itemize}
|
|
\item A single identifier $id$ that must not contain the \$ character.
|
|
\item An expression $e$ delimited by curly braces.
|
|
\end{itemize}
|
|
|
|
\LMHash{}
|
|
The form \code{\$id} is equivalent to the form \code{\$\{id\}}.
|
|
An interpolated string, $s$, with content `\code{$s_0$\$\{$e_1$\}$s_1\ldots{}s_{n-1}\$\{e_n\}s_{n}$}' (where any of $s_0 \ldots{} s_n$ can be empty)
|
|
is evaluated by evaluating each expression $e_i$ ($1 \le i \le n$) in to a string $r_i$ in the order they occur in the source text, as follows:
|
|
\begin{itemize}
|
|
\item{} Evaluate $e_i$ to an object $o_i$.
|
|
\item{} Invoke the \code{toString} method on $o_i$ with no arguments, and let
|
|
$r_i$ be the returned value.
|
|
\item{} If $r_i$ is not an instance of the built-in type \code{String}, throw an \code{Error}.
|
|
\end{itemize}
|
|
Finally, the result of the evaluation of $s$ is the concatenation of the strings $s_0$, $r_1$, \ldots{}, $r_n$, and $s_n$.
|
|
|
|
\subsection{Symbols}
|
|
\LMLabel{symbols}
|
|
|
|
\LMHash{}
|
|
A {\em symbol literal} denotes the name of a declaration in a Dart program.
|
|
|
|
\begin{grammar}
|
|
{\bf symbolLiteral:}
|
|
`\#' (operator $|$ (identifier (`{\escapegrammar .}' identifier)*)) .
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
A symbol literal \code{\#$id$} where $id$ does not begin with an underscore ('\code{\_}') is equivalent to the expression \code{\CONST{} Symbol('$id$')}.
|
|
|
|
\LMHash{}
|
|
A symbol literal \code{\#\_$id$} evaluates to the object that would be returned by the call \code{MirrorSystem.getSymbol("\_$id$", \metavar{libraryMirror})} where \metavar{libraryMirror} is an instance of the class \code{LibraryMirror} defined in the library \code{dart:mirrors}, reflecting the current library.
|
|
|
|
\rationale{
|
|
One may well ask what is the motivation for introducing literal symbols? In some languages, symbols are canonicalized whereas strings are not. However literal strings are already canonicalized in Dart. Symbols are slightly easier to type compared to strings and their use can become strangely addictive, but this is not nearly sufficient justification for adding a literal form to the language. The primary motivation is related to the use of reflection and a web specific practice known as minification.
|
|
|
|
Minification compresses identifiers consistently throughout a program in order to reduce download size. This practice poses difficulties for reflective programs that refer to program declarations via strings. A string will refer to an identifier in the source, but the identifier will no longer be used in the minified code, and reflective code using these would fail. Therefore, Dart reflection uses objects of type \code{Symbol} rather than strings. Instances of \code{Symbol} are guaranteed to be stable with repeat to minification. Providing a literal form for symbols makes reflective code easier to read and write. The fact that symbols are easy to type and can often act as convenient substitutes for enums are secondary benefits.
|
|
}
|
|
|
|
\LMHash{}
|
|
The static type of a symbol literal is \code{Symbol}.
|
|
|
|
\subsection{Lists}
|
|
\LMLabel{lists}
|
|
|
|
\LMHash{}
|
|
A {\em list literal} denotes a list, which is an integer indexed collection of objects.
|
|
|
|
\begin{grammar}
|
|
{\bf listLiteral:}
|
|
\CONST{}? typeArguments? `[' (expressionList `,'?)? `]'
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
A list may contain zero or more objects. The number of elements in a list is its size. A list has an associated set of indices. An empty list has an empty set of indices. A non-empty list has the index set $\{0 \ldots n -1\}$ where $n$ is the size of the list. It is a runtime error to attempt to access a list using an index that is not a member of its set of indices.
|
|
|
|
|
|
\LMHash{}
|
|
If a list literal begins with the reserved word \CONST{}, it is a {\em constant list literal} which is a compile-time constant (\ref{constants}) and therefore evaluated at compile-time. Otherwise, it is a {\em run-time list literal} and it is evaluated at run-time. Only run-time list literals can be mutated
|
|
after they are created. Attempting to mutate a constant list literal will result in a dynamic error.
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if an element of a constant list literal is not a compile-time constant. It is a compile-time error if the type argument of a constant list literal includes a type parameter.
|
|
\rationale{The binding of a type parameter is not known at compile-time, so we cannot use type parameters inside compile-time constants.}
|
|
|
|
\LMHash{}
|
|
The value of a constant list literal \CONST{} $<E>[e_1\ldots e_n]$ is an object $a$ whose class implements the built-in class $List<E>$. The $i$th element of $a$ is $v_{i+1}$, where $v_i$ is the value of the compile-time expression $e_i$. The value of a constant list literal \CONST{} $[e_1 \ldots e_n]$ is defined as the value of the constant list literal \CONST{}$ < \DYNAMIC{}>[e_1\ldots e_n]$.
|
|
|
|
\LMHash{}
|
|
Let $list_1 =$ \CONST{} $<V>[e_{11} \ldots e_{1n}]$ and $list_2 =$ \CONST{} $<U>[e_{21} \ldots e_{2n}]$ be two constant list literals and let the elements of $list_1$ and $list_2$ evaluate to $o_{11} \ldots o_{1n}$ and $o_{21} \ldots o_{2n}$ respectively. Iff \code{identical($o_{1i}$, $o_{2i}$)} for $i \in 1.. n$ and $V = U$ then \code{identical($list_1$, $list_2$)}.
|
|
|
|
\commentary{In other words, constant list literals are canonicalized.}
|
|
|
|
\LMHash{}
|
|
A run-time list literal $<E>[e_1 \ldots e_n]$ is evaluated as follows:
|
|
\begin{itemize}
|
|
\item
|
|
First, the expressions $e_1 \ldots e_n$ are evaluated in order they appear in the program, producing objects $o_1 \ldots o_n$.
|
|
\item A fresh instance (\ref{generativeConstructors}) $a$, of size $n$, whose class implements the built-in class $List<E>$ is allocated.
|
|
\item
|
|
The operator \code{[]=} is invoked on $a$ with first argument $i$ and second argument
|
|
%The $i$th element of $a$ is set to
|
|
$o_{i+1}, 0 \le i < n$.
|
|
\item
|
|
The result of the evaluation is $a$.
|
|
\end{itemize}
|
|
|
|
|
|
\commentary{
|
|
Note that this document does not specify an order in which the elements are set. This allows for parallel assignments into the list if an implementation so desires. The order can only be observed in checked mode (and may not be relied upon): if element $i$ is not a subtype of the element type of the list, a dynamic type error will occur when $a[i]$ is assigned $o_{i-1}$.
|
|
}
|
|
|
|
\LMHash{}
|
|
A runtime list literal $[e_1 \ldots e_n]$ is evaluated as $< \DYNAMIC{}>[e_1\ldots e_n]$.
|
|
|
|
|
|
\commentary{
|
|
There is no restriction precluding nesting of list literals. It follows from the rules above that
|
|
$<List<int>>[[1, 2, 3], [4, 5, 6]]$ is a list with type parameter $List<int>$, containing two lists with type parameter \DYNAMIC{}.
|
|
}
|
|
|
|
\LMHash{}
|
|
The static type of a list literal of the form \CONST{}$ <E>[e_1\ldots e_n]$ or the form $<E>[e_1 \ldots e_n]$ is $List<E>$. The static type a list literal of the form \CONST{} $[e_1 \ldots e_n$] or the form $[e_1\ldots e_n$] is $List< \DYNAMIC{}>$.
|
|
|
|
\rationale{
|
|
It is tempting to assume that the type of the list literal would be computed based on the types of its elements. However, for mutable lists this may be unwarranted. Even for constant lists, we found this behavior to be problematic. Since compile-time is often actually runtime, the runtime system must be able to perform a complex least upper bound computation to determine a reasonably precise type. It is better to leave this task to a tool in the IDE. It is also much more uniform (and therefore predictable and understandable) to insist that whenever types are unspecified they are assumed to be the unknown type \DYNAMIC{}.
|
|
}
|
|
|
|
%Invoking the getter \code{runtimeType} on a list literal returns the \code{Type} object that is the value of the expression \code{List}. The static type of a list literal is \code{List}.
|
|
% what about generics?
|
|
|
|
\subsection{Maps}
|
|
\LMLabel{maps}
|
|
|
|
\LMHash{}
|
|
A {\em map literal} denotes a map object.
|
|
|
|
\begin{grammar}
|
|
{\bf mapLiteral:}
|
|
\CONST{}? typeArguments? `\{' (mapLiteralEntry (`,' mapLiteralEntry)* `,'?)? `\}'
|
|
.
|
|
|
|
{\bf mapLiteralEntry:}
|
|
% identifier `{\escapegrammar :}' expression;
|
|
expression `{\escapegrammar :}' expression
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
A {\em map literal} consists of zero or more entries. Each entry has a {\em key} and a {\em value}. Each key and each value is denoted by an expression.
|
|
|
|
\LMHash{}
|
|
If a map literal begins with the reserved word \CONST{}, it is a {\em constant map literal} which is a compile-time constant (\ref{constants}) and therefore evaluated at compile-time. Otherwise, it is a {\em run-time map literal} and it is evaluated at run-time. Only run-time map literals can be mutated
|
|
after they are created. Attempting to mutate a constant map literal will result in a dynamic error.
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if either a key or a value of an entry in a constant map literal is not a compile-time constant. It is a compile-time error if the key of an entry in a constant map literal is an instance of a class that implements the operator $==$ unless the key is a
|
|
%symbol,
|
|
string, an integer, a literal symbol or the result of invoking a constant constructor of class \cd{Symbol}.
|
|
It is a compile-time error if the type arguments of a constant map literal include a type parameter.
|
|
|
|
\LMHash{}
|
|
The value of a constant map literal \CONST{}$ <K, V>\{k_1:e_1\ldots k_n :e_n\}$ is an object $m$ whose class implements the built-in class $Map<K, V>$. The entries of $m$ are $u_i:v_i, i \in 1 .. n$, where $u_i$ is the value of the compile-time expression $k_i$ and $v_i$ is the value of the compile-time expression $e_i$. The value of a constant map literal \CONST{} $\{k_1:e_1\ldots k_n :e_n\}$ is defined as the value of a constant map literal \CONST{} $<\DYNAMIC{}, \DYNAMIC{}>\{k_1:e_1\ldots k_n :e_n\}$.
|
|
|
|
\LMHash{}
|
|
Let $map_1 =$ \CONST{}$ <K, V>\{k_{11}:e_{11} \ldots k_{1n} :e_{1n}\}$ and $map_2 =$ \CONST{}$ <J, U>\{k_{21}:e_{21} \ldots k_{2n} :e_{2n}\}$ be two constant map literals. Let the keys of $map_1$ and $map_2$ evaluate to $s_{11} \ldots s_{1n}$ and $s_{21} \ldots s_{2n}$ respectively, and let the elements of $map_1$ and $map_2$ evaluate to $o_{11} \ldots o_{1n}$ and $o_{21} \ldots o_{2n}$ respectively. Iff \code{identical($o_{1i}$, $o_{2i}$)} and \code{identical($s_{1i}$, $s_{2i}$)} for $i \in 1.. n$, and $K = J, V = U$ then \code{identical($map_1$, $map_2$)}.
|
|
|
|
\commentary{In other words, constant map literals are canonicalized.}
|
|
|
|
\LMHash{}
|
|
A runtime map literal $<K, V>\{k_1:e_1\ldots k_n :e_n\}$ is evaluated as follows:
|
|
\begin{itemize}
|
|
\item
|
|
For each $i \in 1..n$ in numeric order,
|
|
first the expression $k_i$ is evaluated producing object $u_i$,
|
|
and then $e_i$ is evaluated producing object $o_i$.
|
|
This produces all the objects $u_1, o_1\ldots u_n, o_n$.
|
|
\item A fresh instance (\ref{generativeConstructors}) $m$ whose class implements the built-in class $Map<K, V>$ is allocated.
|
|
\item
|
|
The operator \code{[]=} is invoked on $m$ with first argument $u_i$ and second argument $o_i$ for each $i \in 1.. n$.
|
|
\item
|
|
The result of the evaluation is $m$.
|
|
\end{itemize}
|
|
|
|
|
|
\LMHash{}
|
|
A runtime map literal $\{k_1:e_1\ldots k_n :e_n\}$ is evaluated as
|
|
|
|
$<\DYNAMIC{}, \DYNAMIC{}>\{k_1:e_1\ldots k_n :e_n\}$.
|
|
|
|
\LMHash{}
|
|
Iff all the keys in a map literal are compile-time constants, it is a static warning if the values of any two keys in a map literal are equal.
|
|
|
|
\LMHash{}
|
|
A map literal is ordered: iterating over the keys and/or values of the maps always happens in the
|
|
order the keys appeared in the source code.
|
|
|
|
\commentary{
|
|
Of course, if a key repeats, the order is defined by first occurrence, but the value is defined by the last.
|
|
}
|
|
|
|
\LMHash{}
|
|
The static type of a map literal of the form \CONST{}$ <K, V>\{k_1:e_1\ldots k_n :e_n\}$ or the form $<K, V>\{k_1:e_1\ldots k_n :e_n\}$ is $Map<K, V>$. The static type a map literal of the form \CONST{}$\{k_1:e_1\ldots k_n :e_n\}$ or the form $\{k_1:e_1\ldots k_n :e_n\}$ is $Map<\DYNAMIC{}, \DYNAMIC{}>$.
|
|
|
|
|
|
\subsection{Throw}
|
|
\LMLabel{throw}
|
|
|
|
\LMHash{}
|
|
The {\em throw expression} is used to throw an exception.
|
|
|
|
\begin{grammar}
|
|
{\bf throwExpression:}
|
|
\THROW{} expression
|
|
.
|
|
|
|
{\bf throwExpressionWithoutCascade:}
|
|
\THROW{} expressionWithoutCascade
|
|
.
|
|
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
Evaluation of a throw expression of the form \code{\THROW{} $e$;} proceeds as follows:
|
|
|
|
\LMHash{}
|
|
The expression $e$ is evaluated to a value $v$ (\ref{evaluation}).
|
|
|
|
\commentary{
|
|
There is no requirement that the expression $e$ evaluate to any special kind of object.
|
|
}
|
|
|
|
\LMHash{}
|
|
If $v$ is the null value (\ref{null}), then a \code{NullThrownError} is thrown.
|
|
Otherwise let $t$ be a stack trace corresponding to the current execution state,
|
|
and the \THROW{} statement throws with $v$ as exception object
|
|
and $t$ as stack trace (\ref{evaluation}).
|
|
|
|
\LMHash{}
|
|
If $v$ is an instance of class \code{Error} or a subclass thereof,
|
|
and it is the first time that \code{Error} object is thrown,
|
|
the stack trace $t$ is stored on $v$ so that it will be returned
|
|
by the $v$'s \code{stackTrace} getter
|
|
|
|
\commentary{
|
|
If the same \code{Error} object is thrown more than once, its \code{stackTrace} getter will return the stack trace from the {\em first} time it was thrown.
|
|
}
|
|
|
|
\LMHash{}
|
|
The static type of a throw expression is $\bot$.
|
|
|
|
|
|
\subsection{ Function Expressions}
|
|
\LMLabel{functionExpressions}
|
|
|
|
\LMHash{}
|
|
A {\em function literal} is an object that encapsulates an executable unit of code.
|
|
|
|
\begin{grammar}
|
|
{\bf functionExpression:}
|
|
formalParameterList functionBody
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
The class of a function literal implements the built-in class \code{Function}.
|
|
%Invoking the getter \code{runtimeType} on a function literal returns the \code{Type} object that is the value of the expression \code{Function}.
|
|
% not necessarily
|
|
|
|
|
|
%Q{Can anyone implement it? Then we should define things via call}
|
|
|
|
\LMHash{}
|
|
The static type of a function literal of the form
|
|
|
|
$(T_1$ $a_1, \ldots, T_n$ $a_n, [T_{n+1}$ $x_{n+1} = d_1, \ldots, T_{n+k}$ $x_{n+k} = d_k]) => e$
|
|
is
|
|
|
|
$(T_1 \ldots, T_n, [T_{n+1}$ $x_{n+1}, \ldots, T_{n+k}$ $x_{n+k}]) \rightarrow T_0$, where $T_0$ is the static type of $e$.
|
|
|
|
\LMHash{}
|
|
The static type of a function literal of the form
|
|
|
|
$(T_1$ $a_1, \ldots, T_n$ $a_n, [T_{n+1}$ $x_{n+1} = d_1, \ldots, T_{n+k}$ $x_{n+k} = d_k])$ \ASYNC{} $=> e$
|
|
is $(T_1 \ldots, T_n, [T_{n+1}$ $x_{n+1}, \ldots, T_{n+k}$ $x_{n+k}]) \rightarrow Future<flatten(T_0)>$, where $T_0$ is the static type of $e$ and $flatten(T)$ is defined as follows:
|
|
|
|
If $T = Future<S>$ then $flatten(T) = flatten(S)$.
|
|
|
|
Otherwise if $T <: Future$ then let $S$ be a type such that $T << Future<S>$ and for all $R$, if $T << Future<R>$ then $S << R$.
|
|
|
|
\rationale{
|
|
This ensures that $Future<S>$ is the most specific instantiation of \cd{Future} that is a super type of $T$.
|
|
}
|
|
|
|
Then $flatten(T) = S$.
|
|
|
|
In any other circumstance, $flatten(T) = T$.
|
|
|
|
|
|
|
|
\rationale{
|
|
We collapse multiple layers of futures into one. If $e$ evaluates to a future $f$, the future will not invoke its \code{then()} callback until f completes to a non-future value, and so the result of an await is never a future, and the result of an async function will never have type \code{Future$<X>$} where $X$ itself is an invocation of \code{Future}.
|
|
|
|
The exception to that would be a type $X$ that extended or implemented \code{Future}. In that case, only one unwrapping takes place. As an example of why this is done, consider
|
|
|
|
\cd{\CLASS{} C<T> \IMPLEMENTS{} Future<C<C<T>>> \ldots }
|
|
|
|
Here, a naive definition of $flatten$ diverges; there is not even a fixed point. A more sophisticated definition of $flatten$ is possible, but the existing rule deals with most realistic examples while remaining relatively simple to understand.
|
|
|
|
}
|
|
|
|
|
|
\LMHash{}
|
|
The static type of a function literal of the form
|
|
|
|
$(T_1$ $a_1, \ldots, T_n$ $a_n, \{T_{n+1}$ $x_{n+1} = d_1, \ldots, T_{n+k}$ $x_{n+k} = d_k\}) => e$
|
|
is
|
|
|
|
$(T_1 \ldots, T_n, \{T_{n+1}$ $x_{n+1}, \ldots, T_{n+k}$ $x_{n+k}\}) \rightarrow T_0$, where $T_0$ is the static type of $e$.
|
|
|
|
\LMHash{}
|
|
The static type of a function literal of the form
|
|
|
|
$(T_1$ $a_1, \ldots, T_n$ $a_n, \{T_{n+1}$ $x_{n+1} = d_1, \ldots, T_{n+k}$ $x_{n+k} = d_k\})$ \ASYNC{} $=> e$
|
|
|
|
is $(T_1 \ldots, T_n, \{T_{n+1}$ $x_{n+1}, \ldots, T_{n+k}$ $x_{n+k}\}) \rightarrow Future<flatten(T_0)>$, where $T_0$ is the static type of $e$.
|
|
|
|
\LMHash{}
|
|
The static type of a function literal of the form
|
|
|
|
$(T_1$ $a_1, \ldots, T_n$ $a_n, [T_{n+1}$ $x_{n+1} = d_1, \ldots, T_{n+k}$ $x_{n+k}= d_k])\{s\}$
|
|
|
|
is $(T_1 \ldots, T_n, [T_{n+1}$ $x_{n+1}, \ldots, T_{n+k}$ $x_{n+k}]) \rightarrow \DYNAMIC{}$.
|
|
|
|
\LMHash{}
|
|
The static type of a function literal of the form
|
|
|
|
$(T_1$ $a_1, \ldots, T_n$ $a_n, [T_{n+1}$ $x_{n+1} = d_1, \ldots, T_{n+k}$ $x_{n+k}= d_k])$ $ \ASYNC{}$ $\{s\}$
|
|
is $(T_1 \ldots, T_n, [T_{n+1}$ $x_{n+1}, \ldots, T_{n+k}$ $x_{n+k}]) \rightarrow Future$.
|
|
|
|
\LMHash{}
|
|
The static type of a function literal of the form
|
|
|
|
$(T_1$ $a_1, \ldots, T_n$ $a_n, [T_{n+1}$ $x_{n+1} = d_1, \ldots, T_{n+k}$ $x_{n+k}= d_k])$ $ \ASYNC*{}$ $\{s\}$
|
|
is $(T_1 \ldots, T_n, [T_{n+1}$ $x_{n+1}, \ldots, T_{n+k}$ $x_{n+k}]) \rightarrow Stream$.
|
|
|
|
\LMHash{}
|
|
The static type of a function literal of the form
|
|
|
|
$(T_1$ $a_1, \ldots, T_n$ $a_n, [T_{n+1}$ $x_{n+1} = d_1, \ldots, T_{n+k}$ $x_{n+k}= d_k])$ $ \SYNC*{}$ $\{s\}$
|
|
is $(T_1 \ldots, T_n, [T_{n+1}$ $x_{n+1}, \ldots, T_{n+k}$ $x_{n+k}]) \rightarrow Iterable$.
|
|
|
|
|
|
\LMHash{}
|
|
The static type of a function literal of the form
|
|
|
|
$(T_1$ $a_1, \ldots, T_n$ $a_n, [T_{n+1}$ $x_{n+1} = d_1, \ldots, T_{n+k}$ $x_{n+k}= d_k])\{s\}$
|
|
|
|
is $(T_1 \ldots, T_n, [T_{n+1}$ $x_{n+1}, \ldots, T_{n+k}$ $x_{n+k}]) \rightarrow \DYNAMIC{}$.
|
|
|
|
|
|
\LMHash{}
|
|
The static type of a function literal of the form
|
|
|
|
$(T_1$ $a_1, \ldots, T_n$ $a_n, \{T_{n+1}$ $x_{n+1} = d_1, \ldots, T_{n+k}$ $x_{n+k} = d_k\})$ $\ASYNC{}$ $\{s\}$
|
|
|
|
is $(T_1 \ldots, T_n, \{T_{n+1}$ $x_{n+1}, \ldots, T_{n+k}$ $x_{n+k}\}) \rightarrow Future{}$.
|
|
|
|
\LMHash{}
|
|
The static type of a function literal of the form
|
|
|
|
$(T_1$ $a_1, \ldots, T_n$ $a_n, \{T_{n+1}$ $x_{n+1} = d_1, \ldots, T_{n+k}$ $x_{n+k} = d_k\})$ $\ASYNC*{}$ $\{s\}$
|
|
|
|
is $(T_1 \ldots, T_n, \{T_{n+1}$ $x_{n+1}, \ldots, T_{n+k}$ $x_{n+k}\}) \rightarrow Stream{}$.
|
|
|
|
\LMHash{}
|
|
The static type of a function literal of the form
|
|
|
|
$(T_1$ $a_1, \ldots, T_n$ $a_n, \{T_{n+1}$ $x_{n+1} = d_1, \ldots, T_{n+k}$ $x_{n+k} = d_k\})$ $\SYNC*{}$ $\{s\}$
|
|
|
|
is $(T_1 \ldots, T_n, \{T_{n+1}$ $x_{n+1}, \ldots, T_{n+k}$ $x_{n+k}\}) \rightarrow Iterable{}$.
|
|
|
|
\LMHash{}
|
|
In all of the above cases, whenever $T_i, 1 \le i \le n+k$, is not specified, it is considered to have been specified as \DYNAMIC{}.
|
|
|
|
|
|
\subsection{ This}
|
|
\LMLabel{this}
|
|
|
|
\LMHash{}
|
|
The reserved word \THIS{} denotes the target of the current instance member invocation.
|
|
|
|
\begin{grammar}
|
|
{\bf thisExpression:}
|
|
\THIS{}
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
The static type of \THIS{} is the interface of the immediately enclosing class.
|
|
|
|
\commentary{
|
|
We do not support self-types at this point.
|
|
}
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if \THIS{} appears, implicitly or explicitly, in a top-level function or variable initializer, in a factory constructor, or in a static method or variable initializer, or in the initializer of an instance variable.
|
|
|
|
\subsection{ Instance Creation}
|
|
\LMLabel{instanceCreation}
|
|
|
|
\LMHash{}
|
|
Instance creation expressions invoke constructors to produce instances.
|
|
|
|
%It is a compile-time error if any of the type arguments to a constructor of a generic type invoked by a new expression or a constant object expression do not denote types in the enclosing lexical scope.
|
|
|
|
%It is a compile-time error if a constructor of a non-generic type invoked by a new expression or a constant object expression is passed any type arguments. It is a compile-time error if a constructor of a generic type with $n$ type parameters invoked by a new expression or a constant object expression is passed $m$ type arguments where $m \ne n$, or if any of its type arguments is misconstructed (\ref{parameterizedTypes}).
|
|
|
|
\LMHash{}
|
|
It is a static type warning if
|
|
the type $T$ in an instance creation expression of one of the forms
|
|
|
|
\NEW{} $T.id(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$,
|
|
|
|
\NEW{} $T(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$,
|
|
|
|
\CONST{} $T.id(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$,
|
|
|
|
\CONST{} $T(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$ is malformed (\ref{dynamicTypeSystem}) or malbounded (\ref{parameterizedTypes}).
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if the type $T$ in an instance creation expression of one of the forms
|
|
|
|
\NEW{} $T.id(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$,
|
|
|
|
\NEW{} $T(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$,
|
|
|
|
\CONST{} $T.id(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$,
|
|
|
|
\CONST{} $T(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$
|
|
|
|
is an enumerated type (\ref{enums}).
|
|
%any of the type arguments to a constructor of a generic type $G$ invoked by a new expression or a constant object expression are not subtypes of the bounds of the corresponding formal type parameters of $G$.
|
|
|
|
|
|
\subsubsection{ New}
|
|
\LMLabel{new}
|
|
|
|
\LMHash{}
|
|
The {\em new expression} invokes a constructor (\ref{constructors}).
|
|
|
|
\begin{grammar}
|
|
{\bf newExpression:}
|
|
\NEW{} type (`{\escapegrammar .}' identifier)? arguments
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
Let $e$ be a new expression of the form
|
|
|
|
\NEW{} $T.id(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$ or the form
|
|
|
|
\NEW{} $T(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$.
|
|
|
|
%It is a runtime type error if
|
|
%the type $T$ is malformed.
|
|
%It is a static warning if $T$ is a malformed type.
|
|
|
|
%not a class accessible in the current scope, optionally followed by type arguments.
|
|
|
|
\LMHash{}
|
|
If $T$ is a class or parameterized type accessible in the current scope then:
|
|
\begin{itemize}
|
|
\item
|
|
If $e$ is of the form \NEW{} $T.id(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$ it is a static warning if $T.id$ is not the name of a constructor declared by the type $T$. If $e$ is of the form \NEW{} $T(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$ it is a static warning if the type $T$ does not declare a constructor with the same name as the declaration of $T$.
|
|
\end{itemize}
|
|
|
|
\LMHash{}
|
|
If $T$ is a parameterized type (\ref{parameterizedTypes}) $S<U_1, \ldots, U_m>$, let $R = S$.
|
|
%It is a
|
|
%compile-time CHANGED
|
|
%runtime type
|
|
%error if $S$ is not a generic (\ref{generics}) type with $m$ type parameters.
|
|
If $T$ is not a parameterized type, let $R = T$.
|
|
Furthermore, if $e$ is of the form \NEW{} $T.id(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$ then let $q$ be the constructor $T.id$, otherwise let $q$ be the constructor $T$.
|
|
|
|
\LMHash{}
|
|
If $R$ is a generic with $l = m$ type parameters then
|
|
\begin{itemize}
|
|
\item If $T$ is not a parameterized type, then for $ i \in 1 .. l$, let $V_i = \DYNAMIC{}$.
|
|
\item If $T$ is a parameterized type then let $V_i = U_i$ for $ i \in 1 .. m$.
|
|
\end{itemize}
|
|
|
|
\LMHash{}
|
|
If $R$ is a generic with $l \ne m$ type parameters then for $ i \in 1 .. l$, let $V_i = \DYNAMIC{}$. In any other case, let $V_i = U_i$ for $ i \in 1 .. m$.
|
|
|
|
\LMHash{}
|
|
Evaluation of $e$ proceeds as follows:
|
|
|
|
\LMHash{}
|
|
First, the argument list $(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$ is evaluated.
|
|
|
|
\LMHash{}
|
|
If $T$ is a deferred type with prefix $p$, then if $p$ has not been successfully loaded, a dynamic error occurs.
|
|
|
|
\LMHash{}
|
|
Then, if $q$ is a non-factory constructor of an abstract class then an \code{AbstractClassInstantiationError} is thrown.
|
|
|
|
\LMHash{}
|
|
If $T$ is malformed or if $T$ is a type variable a dynamic error occurs.
|
|
In checked mode, if $T$ or any of its superclasses is malbounded a dynamic error occurs.
|
|
Otherwise, if $q$ is not defined or not accessible, a \code{NoSuchMethodError} is thrown.
|
|
If $q$ has fewer than $n$ positional parameters or more than $n$ required parameters,
|
|
or if $q$ lacks any of the named parameters $\{ x_{n+1}, \ldots, x_{n+k}\}$ a \code{NoSuchMethodError} is thrown.
|
|
|
|
\LMHash{}
|
|
Otherwise, if $q$ is a generative constructor (\ref{generativeConstructors}), then:
|
|
|
|
\commentary{Note that at this point we are assured that the number of actual type arguments match the number of formal type parameters.}
|
|
|
|
\LMHash{}
|
|
A fresh instance (\ref{generativeConstructors}), $i$, of class $R$ is allocated.
|
|
Then $q$ is executed to initialize $i$ with respect to the bindings that resulted from the evaluation of the argument list, and, if $R$ is a generic class, with its type parameters bound to $V_1 \ldots V_m$.
|
|
|
|
If execution of $q$ completes normally (\ref{completion}), $e$ evaluates to $i$.
|
|
Otherwise execution of $q$ throws an exception object $x$ and stack trace $t$,
|
|
and then evaluation of $e$ also throws exception object $x$ and stack trace $t$
|
|
(\ref{evaluation}).
|
|
|
|
\LMHash{}
|
|
Otherwise, $q$ is a factory constructor (\ref{factories}). Then:
|
|
|
|
\LMHash{}
|
|
If $q$ is a redirecting factory constructor of the form $T(p_1, \ldots, p_{n+k}) = c;$ or of the form $T.id(p_1, \ldots, p_{n+k}) = c;$ then the result of the evaluation of $e$ is equivalent to evaluating the expression
|
|
|
|
$[V_1, \ldots, V_m/T_1, \ldots, T_m]($\code{\NEW{} $c(a_1, \ldots, a_n, x_{n+1}: a_{n+1}, \ldots, x_{n+k}: a_{n+k}))$}. If evaluation of $q$ causes $q$ to be re-evaluated cyclically, with only factory constructor redirections in-between, a runtime error occurs.
|
|
% Used to not have the "in-between" clause, which would disallow a factory constructor redirecting to another constructor which conditionally calls the original factory constructor again with different arguments.
|
|
|
|
|
|
\LMHash{}
|
|
Otherwise, the body of $q$ is executed with respect to the bindings that resulted from the evaluation of the argument list, and with the type parameters (if any) of $q$ bound to the actual type arguments $V_1, \ldots, V_l$.
|
|
If this execution returns a value (\ref{completion}),
|
|
then $e$ evaluates to the returned value.
|
|
Otherwise, if the execution completes normally or returns with no value,
|
|
then $e$ evaluates to \NULL.
|
|
Otherwise the execution throws an exception $x$ and stack trace $t$,
|
|
and then evaluation of $e$ also throws $x$ and $t$ (\ref{evaluation}).
|
|
|
|
\LMHash{}
|
|
It is a static warning if $q$ is a constructor of an abstract class and $q$ is not a factory constructor.
|
|
|
|
\commentary{The above gives precise meaning to the idea that instantiating an abstract class leads to a warning.
|
|
A similar clause applies to constant object creation in the next section.
|
|
}
|
|
|
|
\rationale{In particular, a factory constructor can be declared in an abstract class and used safely, as it will either produce a valid instance or lead to a warning inside its own declaration.
|
|
}
|
|
|
|
\LMHash{}
|
|
The static type of an instance creation expression of either the form
|
|
|
|
\NEW{} $T.id(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$
|
|
|
|
or the form
|
|
|
|
\NEW{} $T(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$
|
|
|
|
is $T$.
|
|
It is a static warning if the static type of $a_i, 1 \le i \le n+ k$ may not be assigned to the type of the corresponding formal parameter of the constructor $T.id$ (respectively $T$).
|
|
|
|
|
|
|
|
\subsubsection{ Const}
|
|
\LMLabel{const}
|
|
|
|
\LMHash{}
|
|
A {\em constant object expression} invokes a constant constructor (\ref{constantConstructors}).
|
|
|
|
\begin{grammar}
|
|
{\bf constObjectExpression:}
|
|
\CONST{} type ('{\escapegrammar .}' identifier)? arguments
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
Let $e$ be a constant object expression of the form
|
|
|
|
\CONST{} $T.id(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$
|
|
|
|
or the form \CONST{} $T(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$. It is a compile-time error if $T$ does not denote a class accessible in the current scope. It is a compile-time error if $T$ is a deferred type (\ref{staticTypes}).
|
|
|
|
\commentary{In particular, $T$ may not be a type variable.}
|
|
|
|
\LMHash{}
|
|
If $T$ is a parameterized type, it is a compile-time error if $T$ includes a type variable among its type arguments.
|
|
|
|
\LMHash{}
|
|
If $e$ is of the form \CONST{} $T.id(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$ it is a compile-time error if $T.id$ is not the name of a constant constructor declared by the type $T$. If $e$ is of the form \CONST{} $T(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$ it is a compile-time error if the type $T$ does not declare a constant constructor with the same name as the declaration of $T$.
|
|
|
|
\LMHash{}
|
|
In all of the above cases, it is a compile-time error if $a_i, i\in 1 .. n + k$, is not a compile-time constant expression.
|
|
|
|
%If $T$ is a parameterized type (\ref{parameterizedTypes}) $S<U_1, \ldots, U_m>$, let $R = S$. It is a compile-time error if $T$ is malformed. If $T$ is not a parameterized type, let $R = T$.
|
|
%Finally,
|
|
% If $T$ is a generic with $l$ retype parameters, then for all $ i \in 1 .. l$, let $V_i = \DYNAMIC{}$.
|
|
|
|
\LMHash{}
|
|
Evaluation of $e$ proceeds as follows:
|
|
|
|
\LMHash{}
|
|
First, if $e$ is of the form
|
|
|
|
\CONST{} $T.id(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$
|
|
|
|
then let $i$ be the value of the expression
|
|
|
|
\NEW{} $T.id(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$.
|
|
|
|
\LMHash{}
|
|
Otherwise, $e$ must be of the form
|
|
|
|
\CONST{} $T(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$,
|
|
|
|
in which case let $i$ be the result of evaluating
|
|
|
|
\NEW{} $T(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$.
|
|
|
|
\LMHash{}
|
|
Then:
|
|
\begin{itemize}
|
|
\item If during execution of the program, a constant object expression has already evaluated to an instance $j$ of class $R$ with type arguments $V_i, 1 \le i \le m$, then:
|
|
\begin{itemize}
|
|
\item For each instance variable $f$ of $i$, let $v_{if}$ be the value of the instance variable $f$ in $i$, and let $v_{jf}$ be the value of the instance variable $f$ in $j$.
|
|
If \code{identical($v_{if}$, $v_{jf}$)} for all instance variables $f$ in $i$ then the value of $e$ is $j$, otherwise the value of $e$ is $i$.
|
|
\end{itemize}
|
|
\item Otherwise the value of $e$ is $i$.
|
|
\end{itemize}
|
|
|
|
\commentary{
|
|
In other words, constant objects are canonicalized.
|
|
In order to determine if an object is actually new, one has to compute it; then it can be compared to any cached instances.
|
|
If an equivalent object exists in the cache, we throw away the newly created object and use the cached one.
|
|
Objects are equivalent if they have identical type arguments and identical instance variables.
|
|
Since the constructor cannot induce any side effects, the execution of the constructor is unobservable.
|
|
The constructor need only be executed once per call site, at compile-time.
|
|
}
|
|
|
|
\LMHash{}
|
|
The static type of a constant object expression of either the form
|
|
|
|
\CONST{} $T.id(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$
|
|
|
|
or the form
|
|
|
|
\CONST{} $T(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$
|
|
|
|
is $T$. It is a static warning if the static type of $a_i, 1 \le i \le n+ k$ may not be assigned to the type of the corresponding formal parameter of the constructor $T.id$ (respectively $T$).
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if evaluation of a constant object results in an uncaught exception being thrown.
|
|
|
|
\commentary{
|
|
To see how such situations might arise, consider the following examples:
|
|
}
|
|
|
|
\begin{dartCode}
|
|
\CLASS{} A \{
|
|
\FINAL{} x;
|
|
\CONST{} A(p): x = p * 10;
|
|
\}
|
|
|
|
\CONST{} A("x"); // compile-time error
|
|
\CONST{} A(5); // legal
|
|
|
|
|
|
\CLASS{} IntPair \{
|
|
\CONST{} IntPair(\THIS{}.x, \THIS{}.y);
|
|
\FINAL{} int x;
|
|
\FINAL{} int y;
|
|
\OPERATOR *(v) => \NEW{} IntPair(x*v, y*v);
|
|
\}
|
|
|
|
\CONST{} A(\CONST{} IntPair(1,2)); // compile-time error: illegal in a subtler way
|
|
\end{dartCode}
|
|
|
|
\commentary{
|
|
Due to the rules governing constant constructors, evaluating the constructor \code{A()} with the argument \code{"x"} or the argument \code{\CONST{} IntPair(1, 2)} would cause it to throw an exception, resulting in a compile-time error.
|
|
}
|
|
|
|
|
|
\LMHash{}
|
|
Given an instance creation expression of the form \CONST{} $q(a_1, \ldots , a_n)$ it is a static warning if $q$ is a constructor of an abstract class (\ref{abstractInstanceMembers}) but $q$ is not a factory constructor.
|
|
|
|
|
|
\subsection{ Spawning an Isolate}
|
|
\LMLabel{spawningAnIsolate}
|
|
|
|
\LMHash{}
|
|
Spawning an isolate is accomplished via what is syntactically an ordinary library call, invoking one of the functions \code{spawnUri()} or \code{spawn()} defined in the \code{dart:isolate} library. However, such calls have the semantic effect of creating a new isolate with its own memory and thread of control.
|
|
|
|
\LMHash{}
|
|
An isolate's memory is finite, as is the space available to its thread's call stack. It is possible for a running isolate to exhaust its memory or stack, resulting in a run-time error that cannot be effectively caught, which will force the isolate to be suspended.
|
|
|
|
\commentary{
|
|
As discussed in section \ref{errorsAndWarnings}, the handling of a suspended isolate is the responsibility of the embedder.
|
|
}
|
|
|
|
|
|
|
|
\subsection{ Function Invocation}
|
|
\LMLabel{functionInvocation}
|
|
|
|
\LMHash{}
|
|
Function invocation occurs in the following cases: when a function expression (\ref{functionExpressions}) is invoked (\ref{functionExpressionInvocation}), when a method (\ref{methodInvocation}), getter (\ref{topLevelGetterInvocation}, \ref{propertyExtraction}) or setter (\ref{assignment}) is invoked or when a constructor is invoked (either via instance creation (\ref{instanceCreation}), constructor redirection (\ref{redirectingConstructors}) or super initialization). The various kinds of function invocation differ as to how the function to be invoked, $f$, is determined, as well as whether \THIS{} (\ref{this}) is bound. Once $f$ has been determined, the formal parameters of $f$ are bound to corresponding actual arguments. When the body of $f$ is executed it will be executed with the aforementioned bindings.
|
|
|
|
\LMHash{}
|
|
Executing a body of the form \code{=> $e$} is equivalent to executing a body of the form \code{\{ return $e$; \}}.
|
|
Execution a body of the form \code{async => $e$} is equivalent to executing a body of the form \code{async \{ return $e$; \}}.
|
|
|
|
\LMHash{}
|
|
If $f$ is synchronous and is not a generator (\ref{functions}) then execution of the body of $f$ begins immediately.
|
|
If the execution of the body of $f$ returns a value, $v$, (\ref{completion}), the invocation evaluates to $v$.
|
|
If the execution completes normally or it returns without a value, the invocation evaluates to \NULL (\ref{null}).
|
|
If the execution throws an exception object and stack trace, the invocation throws the same exception object and stack trace (\ref{evaluation}).
|
|
|
|
\commentary{
|
|
A complete function body can never break or contine (\ref{completion})
|
|
because a \BREAK{} or \CONTINUE{} statement must always occur inside the statement that is the target of the \BREAK{} or \CONTINUE{}.
|
|
This means that a function body can only either complete normally, throw, or return. Completing normally or returning without a value is treated the same as returning \NULL, so the result of executing a function body can always be used as the result of evaluating an expression, either by evaluating to a value or by the evaluation throwing.
|
|
}
|
|
|
|
|
|
\LMHash{}
|
|
If $f$ is marked \SYNC* (\ref{functions}), then a fresh instance $i$ implementing the built-in class \code{Iterable} is associated with the invocation and immediately returned.
|
|
|
|
\commentary{
|
|
A Dart implementation will need to provide a specific implementation of \code{Iterable} that will be returned by \SYNC* methods. A typical strategy would be to produce an instance of a subclass of class \code{IterableBase} defined in \code{dart:core}. The only method that needs to be added by the Dart implementation in that case is \code{iterator}.
|
|
}
|
|
|
|
\LMHash{}
|
|
The iterable implementation must comply with the contract of \code{Iterable} and should not take any steps identified as exceptionally efficient in that contract.
|
|
|
|
\commentary {
|
|
The contract explicitly mentions a number of situations where certain iterables could be more efficient than normal. For example, by precomputing their length. Normal iterables must iterate over their elements to determine their length. This is certainly true in the case of a synchronous generator, where each element is computed by a function. It would not be acceptable to pre-compute the results of the generator and cache them, for example.
|
|
}
|
|
|
|
\LMHash{}
|
|
When iteration over the iterable is started, by getting an iterator $j$ from the iterable and calling \code{moveNext()}, execution of the body of $f$ will begin. When execution of the body of $f$ completes (\ref{completion},
|
|
\begin{itemize}
|
|
\item If it returns without a value or it completes normally (\ref{completion}), $j$ is positioned after its last element, so that its current value is \code{null} and the current call to \code{moveNext()} on $j$ returns false, as must all further calls.
|
|
\item If it throws an exception object $e$ and stack trace $t$ then the current value of $j$ is \NULL and the current call to \code{moveNext()} throws $e$ and $t$ as well. Further calls to \code{moveNext()} must return false.
|
|
\end{itemize}
|
|
|
|
Each iterator starts a separate computation. If the \SYNC* function is impure, the sequence of values yielded by each iterator may differ.
|
|
|
|
\commentary{
|
|
One can derive more than one iterator from a given iterable. Note that operations on the iterable itself can create distinct iterators. An example would be \code{length}. It is conceivable that different iterators might yield sequences of different length. The same care needs to be taken when writing \SYNC* functions as when
|
|
writing an \code{Iterator} class. In particular, it should handle multiple
|
|
simultaneous iterators gracefully. If the iterator depends on external state
|
|
that might change, it should check that the state is still valid after every
|
|
yield (and maybe throw a \code{ConcurrentModificationError} if it isn't).
|
|
}
|
|
|
|
\LMHash{}
|
|
Each iterator runs with its own shallow copies of all local variables; in particular, each iterator has the same initial arguments, even if their bindings are modified by the function.
|
|
\commentary{
|
|
Two executions of an iterator interact only via state outside the function.
|
|
}
|
|
% The alternative would be to cache the results of an iterator in the iterable, and check the cache at each \YIELD{}. This would have strange issues as well. The yielded value might differ from the expression in the yield. And it is a potential memory leak as the cache is kept alive by any iterator.
|
|
|
|
\LMHash{}
|
|
If $f$ is marked \ASYNC{} (\ref{functions}), then a fresh instance (\ref{generativeConstructors}) $o$ implementing the built-in class \code{Future} is associated with the invocation and immediately returned to the caller. The body of $f$ is scheduled for execution at some future time. The future $o$ will be completed when execution of the body of $f$ completes (\ref{completion}). If execution of the body returns a value, $o$ is completed with that value, if it completes normally or returns without a value, $o$ is completed with the \NULL{} value, and if it throws an exception $e$ and stack trace $t$, $o$ is completed with the error $e$ and stack trace $t$.
|
|
|
|
\LMHash{}
|
|
If $f$ is marked \ASYNC* (\ref{functions}), then a fresh instance $s$ implementing the built-in class \code{Stream} is associated with the invocation and immediately returned. When $s$ is listened to, execution of the body of $f$ will begin.
|
|
When execution of the body of $f$ completes:
|
|
\begin{itemize}
|
|
\item If it completes normally or returns with no value (\ref{completion}), then if $s$ has been canceled then its cancellation future is completed with \NULL{} (\ref{null}).
|
|
\item If it throws an exception object $e$ and stack trace $t$:
|
|
\begin{itemize}
|
|
\item If $s$ has been canceled then its cancellation future is completed with error $e$ and stack trace $t$.
|
|
\item otherwise the error $e$ and stack trace $t$ are emitted by $s$.
|
|
\end{itemize}
|
|
\item $s$ is closed.
|
|
\end{itemize}
|
|
\commentary{
|
|
The body of an asynchronous generator function cannot break, continue or return a value (\ref{completion}). The first two are only allowed in contexts that will handle the break or continue, and return statements with an expression are not allowed in generator functions.
|
|
}
|
|
|
|
\rationale{
|
|
When an asynchronous generator's stream has been canceled, cleanup will occur in the \FINALLY{} clauses (\ref{try}) inside the generator. We choose to direct any exceptions that occur at this time to the cancellation future rather than have them be lost.
|
|
}
|
|
|
|
%\LMHash{}
|
|
%When a stream is canceled, the implementation must wait for the cancelation future returned by \cd{cancell()} to complete before proceeding.
|
|
|
|
\subsubsection{ Actual Argument List Evaluation}
|
|
\LMLabel{actualArguments}
|
|
|
|
\LMHash{}
|
|
Function invocation involves evaluation of the list of actual arguments to the function and binding of the results to the function's formal parameters.
|
|
|
|
\begin{grammar}
|
|
{\bf arguments:}
|
|
`(' (argumentList `,'?)? `)'
|
|
.
|
|
|
|
{\bf argumentList:}
|
|
namedArgument (`,' namedArgument)*;
|
|
% expressionList ',' spreadArgument;
|
|
expressionList (`,' namedArgument)*
|
|
% spreadArgument
|
|
.
|
|
|
|
{\bf namedArgument:}
|
|
label expression % could be top level expression?
|
|
.
|
|
\end{grammar}
|
|
|
|
Argument lists allow an optional trailing comma after the last argument ($`,'?$). An argument list with such a trailing comma is equivalent in all ways to the same parameter list without the trailing comma. All argument lists in this specification are shown without a trailing comma, but the rules and semantics apply equally to the corresponding argument list with a trailing comma.
|
|
|
|
\LMHash{}
|
|
Evaluation of an actual argument list of the form
|
|
|
|
$(a_1, \ldots, a_m, q_1: a_{m+1}, \ldots, q_l: a_{m+l})$
|
|
|
|
proceeds as follows:
|
|
|
|
\LMHash{}
|
|
The arguments $a_1, \ldots, a_{m+l}$ are evaluated in the order they appear in the program, producing objects $o_1, \ldots, o_{m+l}$.
|
|
|
|
\commentary{Simply stated, an argument list consisting of $m$ positional arguments and $l$ named arguments is evaluated from left to right.
|
|
}
|
|
|
|
|
|
\subsubsection{ Binding Actuals to Formals}
|
|
\LMLabel{bindingActualsToFormals}
|
|
|
|
\LMHash{}
|
|
Let $f$ be a function with $h$ required parameters, let $p_1 \ldots p_n$ be the positional parameters of $f$ and let $p_{h+1}, \ldots, p_{h+k}$ be the optional parameters declared by $f$.
|
|
|
|
\LMHash{}
|
|
An evaluated actual argument list $o_1 \ldots o_{m+l}$ derived from an actual argument list of the form $(a_1, \ldots, a_m, q_1: a_{m+1}, \ldots, q_l: a_{m+l})$ is bound to the formal parameters of $f$ as follows:
|
|
|
|
\commentary{
|
|
We have an argument list consisting of $m$ positional arguments and $l$ named arguments. We have a function with $h$ required parameters and $k$ optional parameters. The number of positional arguments must be at least as large as the number of required parameters, and no larger than the number of positional parameters. All named arguments must have a corresponding named parameter. You may not provide a given named argument more than once. If an optional parameter has no corresponding argument, it gets its default value. In checked mode, all arguments must belong to subtypes of the type of their corresponding formal.
|
|
}
|
|
|
|
\commentary{
|
|
If $l > 0$, then it is necessarily the case that $n = h$, because a method cannot have both optional positional parameters and named parameters.
|
|
}
|
|
|
|
|
|
\LMHash{}
|
|
If $m < h$, or $m > n$, a \cd{NoSuchMethodError} is thrown. Furthermore, each $q_i, 1 \le i \le l$, must have a corresponding named parameter in the set $\{p_{n+1}, \ldots, p_{n +k}\}$ or a \cd{NoSuchMethodError} is thrown. Then $p_i$ is bound to $o_i, i \in 1.. m$, and $q_j$ is bound to $o_{m+j}, j \in 1.. l$. All remaining formal parameters of $f$ are bound to their default values.
|
|
|
|
\commentary{All of these remaining parameters are necessarily optional and thus have default values.}
|
|
|
|
\LMHash{}
|
|
In checked mode, it is a dynamic type error if $o_i$ is not \NULL{} and the actual type (\ref{actualTypeOfADeclaration}) of $p_i$ is not a supertype of the type of $o_i, i \in 1.. m$. In checked mode, it is a dynamic type error if $o_{m+j}$ is not \NULL{} and the actual type (\ref{actualTypeOfADeclaration}) of $q_j$ is not a supertype of the type of $o_{m+j}, j \in 1.. l$.
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if $q_i = q_j$ for any $i \ne j$.
|
|
|
|
\LMHash{}
|
|
Let $T_i$ be the static type of $a_i$, let $S_i$ be the type of $p_i, i \in 1 .. h+k$ and let $S_q$ be the type of the named parameter $q$ of $f$. It is a static warning if $T_j$ may not be assigned to $S_j, j \in 1..m$. It is a static warning if $m < h$ or if $m > n$. Furthermore, each $q_i, 1 \le i \le l$, must have a corresponding named parameter in the set $\{p_{n+1}, \ldots, p_{n +k}\}$ or a static warning occurs. It is a static warning if $T_{m+j}$ may not be assigned to $S_{q_j}, j \in 1 .. l$.
|
|
|
|
\subsubsection{ Unqualified Invocation}
|
|
\LMLabel{unqualifiedInvocation}
|
|
|
|
\LMHash{}
|
|
An unqualified function invocation $i$ has the form
|
|
|
|
$id(a_1, \ldots, a_n, x_{n+1}: a_{n+1}, \ldots, x_{n+k}: a_{n+k})$,
|
|
|
|
where $id$ is an identifier.
|
|
|
|
\LMHash{}
|
|
If there exists a lexically visible declaration named $id$, let $f_{id}$ be the innermost such declaration. Then:
|
|
\begin{itemize}
|
|
\item
|
|
If $id$ is a type literal, then $i$ is interpreted as a function expression invocation (ref{functionExpressionInvociation}) with $(id)$ as the expression $e_f$.
|
|
\commentary{
|
|
The expression $(id)$ where $id$ is a type literal always evaluates to an instance of class \code{Type} which is not a function. This ensures that a runtime error occurs when trying to call a type literal.
|
|
}
|
|
\item
|
|
If $f_{id}$ is a prefix object, a compile-time error occurs.
|
|
\item
|
|
If $f_{id}$ is a local function, a library function, a library or static getter or a variable then $i$ is interpreted as a function expression invocation (\ref{functionExpressionInvocation}).
|
|
\item
|
|
Otherwise, if $f_{id}$ is a static method of the enclosing class $C$, $i$ is equivalent to $C.id(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$.
|
|
\item Otherwise, $f_{id}$ is considered equivalent to the ordinary method invocation $\THIS{}.id(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$.
|
|
\end{itemize}
|
|
|
|
\LMHash{}
|
|
Otherwise, if $i$ occurs inside a top level or static function (be it function, method, getter, or setter) or variable initializer, evaluation of $i$ causes a \cd{NoSuchMethodError} to be thrown.
|
|
|
|
\LMHash{}
|
|
If $i$ does not occur inside a top level or static function, $i$ is equivalent to $\THIS{}.id(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$.
|
|
|
|
|
|
% Should also say:
|
|
% It is a static warning if $i$ occurs inside a top level or static function (be it function, method, getter, or setter) or variable initializer and there is no lexically visible declaration named $id$ in scope.
|
|
|
|
|
|
|
|
|
|
|
|
\subsubsection{ Function Expression Invocation}
|
|
\LMLabel{functionExpressionInvocation}
|
|
|
|
\LMHash{}
|
|
A function expression invocation $i$ has the form
|
|
|
|
$e_f(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$,
|
|
|
|
where $e_f$ is an expression. If $e_f$ is an identifier $id$, then $id$ must necessarily denote a local function, a library function, a library or static getter or a variable as described above, or $i$ is not considered a function expression invocation.
|
|
If $e_f$ is a type literal, then it is equivalent to the expression $(e_f)$.
|
|
|
|
\commentary{
|
|
The expression $(e_f)$ where $e_f$ is a type literal always evaluates to an instance of class \code{Type} which is not a function. This ensures that a runtime error occurs when trying to call a type literal.
|
|
}
|
|
|
|
If $e_f$ is a property extraction expression (\ref{propertyExtraction}), then $i$ isn't a function expression invocation and is instead recognized as an ordinary method invocation (\ref{ordinaryInvocation}).
|
|
|
|
\commentary{
|
|
\code{$a.b(x)$} is parsed as a method invocation of method \code{$b()$} on object \code{$a$}, not as an invocation of getter \code{$b$} on \code{$a$} followed by a function call \code{$(a.b)(x)$}. If a method or getter \code{$b$} exists, the two will be equivalent. However, if \code{$b$} is not defined on \code{$a$}, the resulting invocation of \code{noSuchMethod()} would differ. The \code{Invocation} passed to \code{noSuchMethod()} would describe a call to a method \code{$b$} with argument \code{$x$} in the former case, and a call to a getter \code{$b$} (with no arguments) in the latter.
|
|
}
|
|
|
|
\LMHash{}
|
|
Otherwise:
|
|
|
|
A function expression invocation $e_f(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$ is equivalent to $e_f.call(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$.
|
|
|
|
\commentary{
|
|
The implication of this definition, and the other definitions involving the method \code{call()}, is that user defined types can be used as function values provided they define a \CALL{} method. The method \CALL{} is special in this regard. The signature of the \CALL{} method determines the signature used when using the object via the built-in invocation syntax.
|
|
}
|
|
|
|
\LMHash{}
|
|
It is a static warning if the static type $F$ of $e_f$ may not be assigned to a function type. If $F$ is not a function type, the static type of $i$ is \DYNAMIC{}. Otherwise
|
|
the static type of $i$ is the declared return type of $F$.
|
|
%\item Let $T_i$ be the static type of $a_i, i \in 1 .. n+k$. It is a static warning if $F$ is not a supertype of $(T_1, \ldots, T_n, [T_{n+1}$ $x_{n+1}, \ldots, T_{n+k}$ $x_{n+k}]) \to \bot$.
|
|
%\end{itemize}
|
|
|
|
\subsection{ Lookup}
|
|
\LMLabel{lookup}
|
|
|
|
\subsubsection{Method Lookup}
|
|
\LMLabel{methodLookup}
|
|
|
|
\LMHash{}
|
|
The result of a lookup of a method $m$ in object $o$ with respect to library $L$ is the result of a lookup of method $m$ in class $C$ with respect to library $L$, where $C$ is the class of $o$.
|
|
|
|
\LMHash{}
|
|
The result of a lookup of method $m$ in class $C$ with respect to library $L$ is:
|
|
If $C$ declares a concrete instance method named $m$ that is accessible to $L$, then that method is the result of the lookup, and we say that the method was {\em looked up in $C$}. Otherwise, if $C$ has a superclass $S$, then the result of the lookup is the result of looking up $m$ in $S$ with respect to $L$. Otherwise, we say that the method lookup has failed.
|
|
|
|
\rationale {
|
|
The motivation for skipping abstract members during lookup is largely to allow smoother mixin composition.
|
|
}
|
|
|
|
|
|
\subsubsection{ Getter and Setter Lookup}
|
|
\LMLabel{getterAndSetterLookup}
|
|
|
|
\LMHash{}
|
|
The result of a lookup of a getter (respectively setter) $m$ in object $o$ with respect to library $L$ is the result of looking up getter (respectively setter) $m$ in class $C$ with respect to $L$, where $C$ is the class of $o$.
|
|
|
|
\LMHash{}
|
|
The result of a lookup of a getter (respectively setter) $m$ in class $C$ with respect to library $L$ is:
|
|
If $C$ declares a concrete instance getter (respectively setter) named $m$ that is accessible to $L$, then that getter (respectively setter) is the result of the lookup, and we say that the getter (respectively setter) was {\em looked up in $C$}. Otherwise, if $C$ has a superclass $S$, then the result of the lookup is the result of looking up getter (respectively setter) $m$ in $S$ with respect to $L$. Otherwise, we say that the lookup has failed.
|
|
|
|
\rationale {
|
|
The motivation for skipping abstract members during lookup is largely to allow smoother mixin composition.
|
|
}
|
|
|
|
|
|
\subsection{ Top level Getter Invocation}
|
|
\LMLabel{topLevelGetterInvocation}
|
|
|
|
\LMHash{}
|
|
Evaluation of a top-level getter invocation $i$ of the form $m$, where $m$ is an identifier, proceeds as follows:
|
|
|
|
\LMHash{}
|
|
The getter function $m$ is invoked. The value of $i$ is the result returned by the call to the getter function.
|
|
\commentary{
|
|
Note that the invocation is always defined. Per the rules for identifier references, an identifier will not be treated as a top-level getter invocation unless the getter $i$ is defined.
|
|
}
|
|
|
|
\LMHash{}
|
|
The static type of $i$ is the declared return type of $m$.
|
|
|
|
\subsection{ Method Invocation}
|
|
\LMLabel{methodInvocation}
|
|
|
|
\LMHash{}
|
|
Method invocation can take several forms as specified below.
|
|
|
|
\subsubsection{Ordinary Invocation}
|
|
\LMLabel{ordinaryInvocation}
|
|
|
|
\LMHash{}
|
|
An ordinary method invocation can be {\em conditional} or {\em unconditional}.
|
|
|
|
\LMHash{}
|
|
Evaluation of a {\em conditional ordinary method invocation} $i$ of the form
|
|
|
|
\LMHash{}
|
|
$e?.m(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$
|
|
|
|
\LMHash{}
|
|
proceeds as follows:
|
|
|
|
\LMHash{}
|
|
If $e$ is a type literal, $i$ is equivalent to \code{$e$.$m$($a_1$, \ldots , $a_n$, $x_{n+1}$: $a_{n+1}$, \ldots , $x_{n+k}$: $a_{n+k}$)}.
|
|
|
|
\LMHash{}
|
|
Otherwise, evaluate $e$ to an object $o$.
|
|
If $o$ is the null value, $i$ evaluates to the null value.
|
|
Otherwise let $v$ be a fresh variable bound to $o$ and evaluate
|
|
\code{$v$.$m$($a_1$, $\ldots$ , $a_n$, $x_{n+1}$: $a_{n+1}$, $\ldots$ , $x_{n+k}$: $a_{n+k}$))} to a value $r$, and then $e$ evaluates to $r$.
|
|
|
|
|
|
\LMHash{}
|
|
The static type of $i$ is the same as the static type of $e.m(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$. Exactly the same static warnings that would be caused by $e.m(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$ are also generated in the case of $e?.m(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$.
|
|
|
|
\LMHash{}
|
|
An {\em unconditional ordinary method invocation} $i$ has the form
|
|
|
|
$e.m(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$.
|
|
|
|
\LMHash{}
|
|
Evaluation of an unconditional ordinary method invocation $i$ of the form
|
|
|
|
$e.m(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$
|
|
|
|
proceeds as follows:
|
|
|
|
\LMHash{}
|
|
First, the expression $e$ is evaluated to a value $o$. Next, the argument list $(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$ is evaluated yielding actual argument objects $o_1, \ldots , o_{n+k}$. Let $f$ be the result of looking up (\ref{methodLookup}) method $m$ in $o$ with respect to the current library $L$.
|
|
|
|
\LMHash{}
|
|
Let $p_1 \ldots p_h$ be the required parameters of $f$, let $p_1 \ldots p_m$ be the positional parameters of $f$ and let $p_{h+1}, \ldots, p_{h+l}$ be the optional parameters declared by $f$.
|
|
|
|
\commentary{
|
|
We have an argument list consisting of $n$ positional arguments and $k$ named arguments. We have a function with $h$ required parameters and $l$ optional parameters. The number of positional arguments must be at least as large as the number of required parameters, and no larger than the number of positional parameters. All named arguments must have a corresponding named parameter.
|
|
}
|
|
|
|
\LMHash{}
|
|
If $n < h$, or $n > m$, the method lookup has failed. Furthermore, each $x_i, n+1 \le i \le n+k$, must have a corresponding named parameter in the set $\{p_{m+1}, \ldots, p_{h+l}\}$ or the method lookup also fails. If $o$ is an instance of \code{Type} but $e$ is not a constant type literal, then if $m$ is a method that forwards (\ref{functionDeclarations}) to a static method, method lookup fails. Otherwise method lookup has succeeded.
|
|
|
|
\LMHash{}
|
|
If the method lookup succeeded, the body of $f$ is executed with respect to the bindings that resulted from the evaluation of the argument list, and with \THIS{} bound to $o$. The value of $i$ is the value returned after $f$ is executed.
|
|
|
|
\LMHash{}
|
|
If the method lookup has failed, then let $g$ be the result of looking up getter (\ref{getterAndSetterLookup}) $m$ in $o$ with respect to $L$.
|
|
If $o$ is an instance of \code{Type} but $e$ is not a constant type literal, then if $g$ is a getter that forwards to a static getter, getter lookup fails.
|
|
If the getter lookup succeeded, let $v_g$ be the value of the getter invocation $e.m$. Then the value of $i$ is the result of invoking
|
|
the static method \code{Function.apply()} with arguments $v.g, [o_1, \ldots , o_n], \{\#x_{n+1}: o_{n+1}, \ldots , \#x_{n+k}: o_{n+k}\}$.
|
|
|
|
\LMHash{}
|
|
If getter lookup has also failed, then a new instance $im$ of the predefined class \code{Invocation} is created, such that:
|
|
\begin{itemize}
|
|
\item \code{im.isMethod} evaluates to \code{\TRUE{}}.
|
|
\item \code{im.memberName} evaluates to the symbol \code{m}.
|
|
\item \code{im.positionalArguments} evaluates to an immutable list with the same values as \code{[$o_1, \ldots, o_n$]}.
|
|
\item \code{im.namedArguments} evaluates to an immutable map with the same keys and values as \code{\{$\#x_{n+1}: o_{n+1}, \ldots, \#x_{n+k} : o_{n+k}$\}}.
|
|
\end{itemize}
|
|
|
|
\LMHash{}
|
|
Then the method \code{noSuchMethod()} is looked up in $v_o$ and invoked with argument $im$, and the result of this invocation is the result of evaluating $i$. However, if the implementation found cannot be invoked with a single positional argument, the implementation of \code{noSuchMethod()} in class \code{Object} is invoked on $v_o$ with argument $im'$, where $im'$ is an instance of \code{Invocation} such that :
|
|
\begin{itemize}
|
|
\item \code{im'.isMethod} evaluates to \code{\TRUE{}}.
|
|
\item \code{im'.memberName} evaluates to \code{\#noSuchMethod}.
|
|
\item \code{im'.positionalArguments} evaluates to an immutable list whose sole element is $im$.
|
|
\item \code{im'.namedArguments} evaluates to the value of \code{\CONST{} \{\}}.
|
|
\end{itemize}
|
|
|
|
and the result of the latter invocation is the result of evaluating $i$.
|
|
|
|
\rationale {
|
|
It is possible to bring about such a situation by overriding \code{noSuchMethod()} with the wrong number of arguments:}
|
|
|
|
\begin{code}
|
|
\CLASS{} Perverse \{
|
|
noSuchMethod(x,y) => x + y;
|
|
\}
|
|
|
|
\NEW{} Perverse.unknownMethod();
|
|
\end{code}
|
|
|
|
\commentary{Notice that the wording carefully avoids re-evaluating the receiver $o$ and the arguments $a_i$. }
|
|
|
|
\LMHash{}
|
|
Let $T$ be the static type of $o$. It is a static type warning if $T$ does not have an accessible (\ref{privacy}) instance member named $m$ unless either:
|
|
\begin{itemize}
|
|
\item
|
|
$T$ or a superinterface of $T$ is annotated with an annotation denoting a constant identical to the constant \code{@proxy} defined in \code{dart:core}. Or
|
|
\item $T$ is \code{Type}, $e$ is a constant type literal and the class corresponding to $e$ has a static getter named $m$.
|
|
\item $T$ is \code{Function} and $m$ is \CALL. \rationale {The type \code{Function} is treated as if it has a \code{call} method for any possible signature of \CALL. The expectation is that any concrete subclass of \code{Function} will implement \CALL. Note that a warning will be issue if this is not the case. Furthermore, any use of \CALL{} on a subclass of \code{Function} that fails to implement \CALL{} will also provoke a warning, as this exemption is limited to type \code{Function}, and does not apply to its subtypes.
|
|
}
|
|
\end{itemize}
|
|
|
|
\LMHash{}
|
|
If $T.m$ exists, it is a static type warning if the type $F$ of $T.m$ may not be assigned to a function type. If $T.m$ does not exist, or if $F$ is not a function type, the static type of $i$ is \DYNAMIC{}; otherwise the static type of $i$ is the declared return type of $F$.
|
|
|
|
\LMHash{}
|
|
It is a compile-time error to invoke any of the methods of class \cd{Object} on a prefix object (\ref{imports}) or on a constant type literal that is immediately followed by the token `.'.
|
|
|
|
|
|
\subsubsection{Cascaded Invocations}
|
|
\LMLabel{cascadedInvocations}
|
|
|
|
\LMHash{}
|
|
A {\em cascaded method invocation} has the form \code{$e$..\metavar{suffix}}
|
|
where $e$ is an expression and \metavar{suffix} is a sequence of operator, method, getter or setter invocations.
|
|
|
|
\begin{grammar}
|
|
{\bf cascadeSection:}
|
|
`{\escapegrammar ..}' (cascadeSelector arguments*) (assignableSelector arguments*)* (assignmentOperator expressionWithoutCascade)?
|
|
.
|
|
|
|
{\bf cascadeSelector:}`[' expression `]';
|
|
identifier
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
Evaluation of a cascaded method invocation expression $e$ of the form \code{$e$..\metavar{suffix}} proceeds as follows:
|
|
|
|
Evaluate $e$ to an object $o$.
|
|
Let $t$ be a fresh variable bound to $o$.
|
|
Evaluate \code{$t$.\metavar{suffix}} to an object.
|
|
Then $e$ evaluates to $o$.
|
|
|
|
\rationale{
|
|
With the introduction of null-aware conditional assignable expressions (\ref{assignableExpressions}), it would make sense to extend cascades with a null-aware conditional form as well. One might define \code{$e$?..\metavar{suffix}} to be equivalent to the expression \code{$t$ == null ? null : $t$.\metavar{suffix}} where $t$ is a fresh variable bound to the value of $e$.
|
|
|
|
The present specification has not added such a construct, in the interests of simplicity and rapid language evolution. However, Dart implementations may experiment with such constructs, as noted in section \ref{ecmaConformance}.
|
|
}
|
|
|
|
\subsubsection{Super Invocation}
|
|
\LMLabel{superInvocation}
|
|
|
|
\LMHash{}
|
|
A super method invocation $i$ has the form
|
|
|
|
$\SUPER{}.m(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$.
|
|
|
|
\LMHash{}
|
|
Evaluation of $i$ proceeds as follows:
|
|
|
|
\LMHash{}
|
|
First, the argument list $(a_1, \ldots , a_n, x_{n+1}: a_{n+1}, \ldots , x_{n+k}: a_{n+k})$ is evaluated producing actual argument objects $o_1, \ldots , o_{n+k}$. Let $g$ be the method currently executing, and let $C$ be the class in which $g$ was looked up (\ref{methodLookup}). Let $S_{dynamic}$ be the superclass of $C$, and let $f$ be the result of looking up method (\ref{methodLookup}) $m$ in $S_{dynamic}$ with respect to the current library $L$.
|
|
Let $p_1 \ldots p_h$ be the required parameters of $f$, let $p_1 \ldots p_m$ be the positional parameters of $f$ and let $p_{h+1}, \ldots, p_{h+l}$ be the optional parameters declared by $f$.
|
|
|
|
\LMHash{}
|
|
If $n < h$, or $n > m$, the method lookup has failed. Furthermore, each $x_i, n+1 \le i \le n+k$, must have a corresponding named parameter in the set $\{p_{m+1}, \ldots, p_{h+l}\}$ or the method lookup also fails. Otherwise method lookup has succeeded.
|
|
|
|
\LMHash{}
|
|
If the method lookup succeeded, the body of $f$ is executed with respect to the bindings that resulted from the evaluation of the argument list, and with \THIS{} bound to the current value of \THIS{}. The value of $i$ is the value returned after $f$ is executed.
|
|
|
|
\LMHash{}
|
|
If the method lookup has failed, then let $g$ be the result of looking up getter (\ref{getterAndSetterLookup}) $m$ in $S_{dynamic}$ with respect to $L$. If the getter lookup succeeded, let $v_g$ be the value of the getter invocation $\SUPER{}.m$. Then the value of $i$ is the result of invoking
|
|
the static method \code{Function.apply()} with arguments $v_g, [o_1, \ldots , o_n], \{x_{n+1} = o_{n+1}, \ldots , x_{n+k} = o_{n+k}\}$.
|
|
|
|
\LMHash{}
|
|
If getter lookup has also failed, then a new instance $im$ of the predefined class \code{Invocation} is created, such that :
|
|
\begin{itemize}
|
|
\item \code{im.isMethod} evaluates to \code{\TRUE{}}.
|
|
\item \code{im.memberName} evaluates to the symbol \code{m}.
|
|
\item \code{im.positionalArguments} evaluates to an immutable list with the same values as \code{[$o_1, \ldots, o_n$]}.
|
|
\item \code{im.namedArguments} evaluates to an immutable map with the same keys and values as \code{\{$\#x_{n+1}: o_{n+1}, \ldots, \#x_{n+k} : o_{n+k}$\}}.
|
|
\end{itemize}
|
|
Then the method \code{noSuchMethod()} is looked up in $S_{dynamic}$ and invoked on \THIS{} with argument $im$, and the result of this invocation is the result of evaluating $i$. However, if the implementation found cannot be invoked with a single positional argument, the implementation of \code{noSuchMethod()} in class \code{Object} is invoked on \THIS{} with argument $im'$, where $im'$ is an instance of \code{Invocation} such that :
|
|
\begin{itemize}
|
|
\item \code{im'.isMethod} evaluates to \code{\TRUE{}}.
|
|
\item \code{im'.memberName} evaluates to \code{\#noSuchMethod}.
|
|
\item \code{im'.positionalArguments} evaluates to an immutable list whose sole element is $im$.
|
|
\item \code{im'.namedArguments} evaluates to the value of \code{\CONST{} \{\}}.
|
|
\end{itemize}
|
|
|
|
and the result of this latter invocation is the result of evaluating $i$.
|
|
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if a super method invocation occurs in a top-level function or variable initializer, in an instance variable initializer or initializer list, in class \code{Object}, in a factory constructor or in a static method or variable initializer.
|
|
|
|
\LMHash{}
|
|
Let $S_{static}$ be the superclass of the immediately enclosing class. It is a static type warning if $S_{static}$ does not have an accessible (\ref{privacy}) instance member named $m$ unless $S_{static}$ or a superinterface of $S_{static}$ is annotated with an annotation denoting a constant identical to the constant \code{@proxy} defined in \code{dart:core}. If $S_{static}.m$ exists, it is a static type warning if the type $F$ of $S_{static}.m$ may not be assigned to a function type. If $S_{static}.m$ does not exist, or if $F$ is not a function type, the static type of $i$ is \DYNAMIC{}; otherwise the static type of $i$ is the declared return type of $F$.
|
|
% The following is not needed because it is specified in 'Binding Actuals to Formals"
|
|
%Let $T_i$ be the static type of $a_i, i \in 1 .. n+k$. It is a static warning if $F$ is not a supertype of $(T_1, \ldots, t_n, \{T_{n+1}$ $x_{n+1}, \ldots, T_{n+k}$ $x_{n+k}\}) \to \bot$.
|
|
|
|
|
|
|
|
|
|
\subsubsection{Sending Messages}
|
|
\LMLabel{sendingMessages}
|
|
|
|
\LMHash{}
|
|
Messages are the sole means of communication among isolates. Messages are sent by invoking specific methods in the Dart libraries; there is no specific syntax for sending a message.
|
|
|
|
\commentary{In other words, the methods supporting sending messages embody primitives of Dart that are not accessible to ordinary code, much like the methods that spawn isolates.
|
|
}
|
|
|
|
|
|
|
|
\subsection{ Property Extraction}
|
|
\LMLabel{propertyExtraction}
|
|
|
|
\LMHash{}
|
|
{\em Property extraction} allows for a member or constructor to be accessed as a property rather than a function.
|
|
A property extraction can be either:
|
|
\begin{enumerate}
|
|
\item A {\em closurization} which converts a method or constructor into a closure. Or
|
|
\item A {\em getter invocation} which returns the result of invoking of a getter method.
|
|
\end{enumerate}
|
|
|
|
|
|
\commentary{Closures derived from members via closurization are colloquially known as tear-offs}
|
|
|
|
Property extraction can be either {\em conditional} or {\em unconditional}.
|
|
|
|
\LMHash{}
|
|
Evaluation of a {\em conditional property extraction expression} $e$
|
|
of the form \code{$e_1$?.\metavar{id}} proceeds as follows:
|
|
|
|
\LMHash{}
|
|
If $e_1$ is a type literal, $e$ is equivalent to \code{$e_1$.$m$}.
|
|
|
|
\LMHash{}
|
|
Otherwise evaluate $e_1$ to an object $o$.
|
|
If $o$ is the null value, $e$ evaluates to the null value.
|
|
Otherwise let $x$ be a fresh variable bound to $o$
|
|
and evaluate \code{$x$.\metavar{id}} to a value $r$.
|
|
Then $e$ evaluates to $r$.
|
|
|
|
|
|
The static type of $e$ is the same as the static type of \code{$e_1$.\metavar{id}}. Let $T$ be the static type of $e_1$ and let $y$ be a fresh variable of type $T$. Exactly the same static warnings that would be caused by \code{$y$.\metavar{id}} are also generated in the case of \code{$e_1$?.\metavar{id}}.
|
|
|
|
\LMHash{}
|
|
Unconditional property extraction has one of two syntactic forms: $e.m$ (\ref{getterAccessAndMethodExtraction}) or $\SUPER.m$ (\ref{superGetterAccessAndMethodClosurization}), where $e$ is an expression and $m$ is an identifier.
|
|
|
|
\subsubsection{Getter Access and Method Extraction}
|
|
\LMLabel{getterAccessAndMethodExtraction}
|
|
|
|
\LMHash{}
|
|
Evaluation of a property extraction $i$ of the form $e.m$ proceeds as follows:
|
|
|
|
\LMHash{}
|
|
First, the expression $e$ is evaluated to an object $o$. Let $f$ be the result of looking up (\ref{methodLookup}) method (\ref{instanceMethods}) $m$ in $o$ with respect to the current library $L$. If $o$ is an instance of \code{Type} but $e$ is not a constant type literal, then if $f$ is a method that forwards (\ref{functionDeclarations}) to a static method, method lookup fails. If method lookup succeeds then $i$ evaluates to the closurization of method $f$ on object $o$ (\ref{ordinaryMemberClosurization}).
|
|
|
|
\commentary {
|
|
Note that $f$ is never an abstract method, because method lookup skips abstract methods. Hence, if $m$ refers to an abstract method, we will continue to the next step. However, since methods and getters never override each other, getter lookup will necessarily fail as well, and \cd{noSuchMethod()} will ultimately be invoked. The regrettable implication is that the error will refer to a missing getter rather than an attempt to closurize an abstract method.
|
|
}
|
|
|
|
\LMHash{}
|
|
Otherwise, $i$ is a getter invocation. Let $f$ be the result of looking up
|
|
(\ref{getterAndSetterLookup}) getter (\ref{getters}) $m$ in $o$ with respect to $L$. If $o$ is an instance of \code{Type} but $e$ is not a constant type literal, then if $f$ is a getter that forwards to a static getter, getter lookup fails. Otherwise, the body of $f$ is executed with \THIS{} bound to $o$. The value of $i$ is the result returned by the call to the getter function.
|
|
|
|
\LMHash{}
|
|
If the getter lookup has failed, then a new instance $im$ of the predefined class \code{Invocation} is created, such that :
|
|
\begin{itemize}
|
|
\item \code{im.isGetter} evaluates to \code{\TRUE{}}.
|
|
\item \code{im.memberName} evaluates to the symbol \code{m}.
|
|
\item \code{im.positionalArguments} evaluates to the value of \code{\CONST{} []}.
|
|
\item \code{im.namedArguments} evaluates to the value of \code{\CONST{} \{\}}.
|
|
\end{itemize}
|
|
Then the method \code{noSuchMethod()} is looked up in $o$ and invoked with argument $im$, and the result of this invocation is the result of evaluating $i$. However, if the implementation found cannot be invoked with a single positional argument, the implementation of \code{noSuchMethod()} in class \code{Object} is invoked on $o$ with argument $im'$, where $im'$ is an instance of \code{Invocation} such that :
|
|
\begin{itemize}
|
|
\item \code{im'.isMethod} evaluates to \code{\TRUE{}}.
|
|
\item \code{im'.memberName} evaluates to \code{\#noSuchMethod}.
|
|
\item \code{im'.positionalArguments} evaluates to an immutable list whose sole element is $im$.
|
|
\item \code{im'.namedArguments} evaluates to the value of \code{\CONST{} \{\}}.
|
|
\end{itemize}
|
|
|
|
and the result of this latter invocation is the result of evaluating $i$.
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if $m$ is a member of class \cd{Object} and $e$ is either a prefix object (\ref{imports}) or a constant type literal.
|
|
|
|
\commentary {
|
|
This precludes \code{int.toString} but not \code{(int).toString} because in the latter case, $e$ is a parenthesized expression.
|
|
}
|
|
|
|
\LMHash{}
|
|
Let $T$ be the static type of $e$. It is a static type warning if $T$ does not have a method or getter named $m$ unless either:
|
|
\begin{itemize}
|
|
\item
|
|
$T$ or a superinterface of $T$ is annotated with an annotation denoting a constant identical to the constant \code{@proxy} defined in \code{dart:core}. Or
|
|
\item $T$ is \code{Type}, $e$ is a constant type literal and the class corresponding to $e$ has a static method or getter named $m$.
|
|
\end{itemize}
|
|
|
|
\LMHash{}
|
|
The static type of $i$ is:
|
|
\begin{itemize}
|
|
\item The declared return type of $T.m$, if $T$ has an accessible instance getter named $m$.
|
|
\item The declared return type of $m$, if $T$ is \code{Type}, $e$ is a constant type literal and the class corresponding to $e$ declares an accessible static getter named $m$.
|
|
\item The static type of function $T.m$ if $T$ has an accessible instance method named $m$.
|
|
\item The static type of function $m$, if $T$ is \code{Type}, $e$ is a constant type literal and the class corresponding to $e$ declares an accessible static method named $m$.
|
|
\item The type \DYNAMIC{} otherwise.
|
|
\end{itemize}
|
|
|
|
|
|
\subsubsection{Super Getter Access and Method Closurization}
|
|
\LMLabel{superGetterAccessAndMethodClosurization}
|
|
|
|
\LMHash{}
|
|
Evaluation of a property extraction $i$ of the form $\SUPER.m$ proceeds as follows:
|
|
|
|
\LMHash{}
|
|
Let $g$ be the method currently executing, and let $C$ be the class in which $g$ was looked up. Let $S_{dynamic}$ be the superclass of $C$. Let $f$ be the result of looking up method $m$ in $S_{dynamic}$ with respect to the current library $L$. If method lookup succeeds then $i$ evaluates to the closurization of method $f$ with respect to superclass $S_{dynamic}$ (\ref{superClosurization}).
|
|
|
|
\LMHash{}
|
|
Otherwise, $i$ is a getter invocation. Let $f$ be the result of looking up getter $m$ in $S_{dynamic}$ with respect to $L$. The body of $f$ is executed with \THIS{} bound to the current value of \THIS{}. The value of $i$ is the result returned by the call to the getter function.
|
|
|
|
\LMHash{}
|
|
If the getter lookup has failed, then a new instance $im$ of the predefined class \code{Invocation} is created, such that :
|
|
\begin{itemize}
|
|
\item \code{im.isGetter} evaluates to \code{\TRUE{}}.
|
|
\item \code{im.memberName} evaluates to the symbol \code{m}.
|
|
\item \code{im.positionalArguments} evaluates to the value of \code{\CONST{} []}.
|
|
\item \code{im.namedArguments} evaluates to the value of \code{\CONST{} \{\}}.
|
|
\end{itemize}
|
|
Then the method \code{noSuchMethod()} is looked up in $S_{dynamic}$ and invoked with argument $im$, and the result of this invocation is the result of evaluating $i$. However, if the implementation found cannot be invoked with a single positional argument, the implementation of \code{noSuchMethod()} in class \code{Object} is invoked on \THIS{} with argument $im'$, where $im'$ is an instance of \code{Invocation} such that :
|
|
\begin{itemize}
|
|
\item \code{im'.isMethod} evaluates to \code{\TRUE{}}.
|
|
\item \code{im'.memberName} evaluates to \code{\#noSuchMethod}.
|
|
\item \code{im'.positionalArguments} evaluates to an immutable list whose sole element is $im$.
|
|
\item \code{im'.namedArguments} evaluates to the value of \code{\CONST{} \{\}}.
|
|
\end{itemize}
|
|
and the result of this latter invocation is the result of evaluating $i$.
|
|
|
|
\LMHash{}
|
|
Let $S_{static}$ be the superclass of the immediately enclosing class. It is a static type warning if $S_{static}$ does not have an accessible instance method or getter named $m$.
|
|
|
|
The static type of $i$ is:
|
|
\begin{itemize}
|
|
\item The declared return type of $S_{static}.m$, if $S_{static}$ has an accessible instance getter named $m$.
|
|
\item The static type of function $S_{static}.m$ if $S_{static}$ has an accessible instance method named $m$.
|
|
\item The type \DYNAMIC{} otherwise.
|
|
\end{itemize}
|
|
|
|
|
|
\subsubsection{Ordinary Member Closurization}
|
|
\LMLabel{ordinaryMemberClosurization}
|
|
|
|
\LMHash{}
|
|
Let $o$ be an object, and let $u$ be a fresh final variable bound to $o$.
|
|
The {\em closurization of method $f$ on object $o$} is defined to be equivalent to:
|
|
\begin{itemize}
|
|
%\item $(a) \{\RETURN{}$ $u$ $op$ $a;$\} if $f$ is named $op$ and $op$ is one of \code{<, >, <=, >=, ==, -, +, /, \~{}/, *, \%, $|$, \^{}, \&, $<<$, $>>$} (this precludes closurization of unary -).
|
|
%\item $() \{\RETURN{}$ \~{} $u;$\} if $f$ is named \~{}.
|
|
%\item $(a) \{\RETURN{}$ $u[a];$\} if $f$ is named $[]$.
|
|
%\item $(a, b) \{\RETURN{}$ $u[a] = b;$\} if $f$ is named $[]=$.
|
|
\item
|
|
\begin{dartCode}
|
|
$(r_1, \ldots, r_n, \{p_1 = d_1, \ldots , p_k = d_k\})$ \{
|
|
\RETURN{} $ u.m(r_1, \ldots, r_n, p_1: p_1, \ldots, p_k: p_k);$
|
|
\}
|
|
\end{dartCode}
|
|
if $f$ is named $m$ and has required parameters $r_1, \ldots, r_n$, and named parameters $p_1, \ldots, p_k$ with defaults $d_1, \ldots, d_k$.
|
|
\item
|
|
\begin{dartCode}
|
|
$(r_1, \ldots, r_n, [p_1 = d_1, \ldots , p_k = d_k])$\{
|
|
\RETURN{} $u.m(r_1, \ldots, r_n, p_1, \ldots, p_k)$;
|
|
\}
|
|
\end{dartCode}
|
|
if $f$ is named $m$ and has required parameters $r_1, \ldots, r_n$, and optional positional parameters $p_1, \ldots, p_k$ with defaults $d_1, \ldots, d_k$.
|
|
\end{itemize}
|
|
|
|
\LMHash{}
|
|
Except that iff \code{identical($o_1, o_2$)} then \cd{$o_1.m$ == $o_2.m$}.
|
|
%\item The static type of the property extraction is the static type of function $T.m$, where $T$ is the static type of $e$, if $T.m$ is defined. Otherwise the static type of $e.m$ is \DYNAMIC{}.
|
|
|
|
\commentary{
|
|
There is no guarantee that \cd{identical($o_1.m, o_2.m$)}. Dart implementations are not required to canonicalize these or any other closures.
|
|
}
|
|
% local functions that have a closure extracted are always different
|
|
|
|
\rationale{
|
|
The special treatment of equality in this case facilitates the use of extracted property functions in APIs where callbacks such as event listeners must often be registered and later unregistered. A common example is the DOM API in web browsers.
|
|
}
|
|
|
|
\subsubsection{Super Closurization}
|
|
\LMLabel{superClosurization}
|
|
|
|
\LMHash{}
|
|
The {\em closurization of method $f$ with respect to superclass $S$} is defined to be equivalent to:
|
|
|
|
\LMHash{}
|
|
\begin{itemize}
|
|
%\item $(a) \{\RETURN{}$ \SUPER{} $op$ $a;$\} if $f$ is named $op$ and $op$ is one of \code{<, >, <=, >=, ==, -, +, /, \~{}/, *, \%, $|$, \^{}, \&, $<<$, $>>$}.
|
|
%\item $() \{\RETURN{}$ \~{}\SUPER;\} if $f$ is named \~{}.
|
|
%\item $(a) \{\RETURN{}$ $\SUPER[a];$\} if $f$ is named $[]$.
|
|
%\item $(a, b) \{\RETURN{}$ $\SUPER[a] = b;$\} if $f$ is named $[]=$.
|
|
\item
|
|
\begin{dartCode}
|
|
$(r_1, \ldots, r_n, \{p_1 = d_1, \ldots , p_k = d_k\})$ \{
|
|
\RETURN{} \SUPER$.m(r_1, \ldots, r_n, p_1: p_1, \ldots, p_k: p_k);$
|
|
\}
|
|
\end{dartCode}
|
|
if $f$ is named $m$ and has required parameters $r_1, \ldots, r_n$, and named parameters $p_1, \ldots, p_k$ with defaults $d_1, \ldots, d_k$.
|
|
\item
|
|
\begin{dartCode}
|
|
$(r_1, \ldots, r_n, [p_1 = d_1, \ldots , p_k = d_k])$\{
|
|
\RETURN{} \SUPER$.m(r_1, \ldots, r_n, p_1, \ldots, p_k)$;
|
|
\}
|
|
\end{dartCode}
|
|
if $f$ is named $m$ and has required parameters $r_1, \ldots, r_n$, and optional positional parameters $p_1, \ldots, p_k$ with defaults $d_1, \ldots, d_k$.
|
|
\end{itemize}
|
|
|
|
\LMHash{}
|
|
Except that iff two closurizations were created by code declared in the same class with identical bindings of \THIS{} then \cd{\SUPER$_1.m$ == \SUPER$_2.m$}.
|
|
|
|
|
|
\subsection{ Assignment}
|
|
\LMLabel{assignment}
|
|
|
|
\LMHash{}
|
|
An assignment changes the value associated with a mutable variable or property.
|
|
|
|
\begin{grammar}
|
|
{\bf assignmentOperator:}`=' ;
|
|
compoundAssignmentOperator
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
Evaluation of an assignment $a$ of the form $v$ \code{=} $e$ proceeds as follows:
|
|
|
|
|
|
%If there is neither a local variable declaration with name $v$ nor a setter declaration with name $v=$ in the lexical scope enclosing $a$, then:
|
|
%\begin{itemize}
|
|
% \item If $a$ occurs inside a top level or static function (be it function, method, getter, or setter) or variable initializer, evaluation of $a$ causes $e$ to be evaluated, after which a \code{NoSuchMethodError} is thrown.
|
|
% \item Otherwise, the assignment is equivalent to the assignment \code{ \THIS{}.$v$ = $e$}.
|
|
% \end{itemize}
|
|
|
|
%Otherwise
|
|
|
|
\LMHash{}
|
|
Let $d$ be the innermost declaration whose name is $v$ or $v=$, if it exists.
|
|
It is a compile-time error if $d$ denotes a prefix object.
|
|
|
|
\LMHash{}
|
|
If $d$ is the declaration of a local variable, the expression $e$ is evaluated to an object $o$. Then, the variable $v$ is bound to $o$ unless $v$ is \FINAL{} or \CONST{}, in which case a dynamic error occurs.
|
|
If no error occurs, the value of the assignment expression is $o$.
|
|
|
|
% add local functions per bug 23218
|
|
|
|
\LMHash{}
|
|
If $d$ is the declaration of a library variable, top level getter or top level setter, the expression $e$ is evaluated to an object $o$. Then the setter $v=$ is invoked with its formal parameter bound to $o$. The value of the assignment expression is $o$.
|
|
|
|
\LMHash{}
|
|
Otherwise, if $d$ is the declaration of a static variable, static getter or static setter in class $C$, then the assignment is equivalent to the assignment \code{$C.v$ = $e$}.
|
|
|
|
\LMHash{}
|
|
Otherwise, If $a$ occurs inside a top level or static function (be it function, method, getter, or setter) or variable initializer, evaluation of $a$ causes $e$ to be evaluated, after which a \code{NoSuchMethodError} is thrown.
|
|
|
|
\LMHash{}
|
|
Otherwise, the assignment is equivalent to the assignment \code{ \THIS{}.$v$ = $e$}.
|
|
|
|
\LMHash{}
|
|
In checked mode, it is a dynamic type error if $o$ is not \NULL{} and the interface of the class of $o$ is not a subtype of the actual type (\ref{actualTypeOfADeclaration}) of $v$.
|
|
|
|
\LMHash{}
|
|
It is a static type warning if the static type of $e$ may not be assigned to the static type of $v$. The static type of the expression $v$ \code{=} $e$ is the static type of $e$.
|
|
|
|
\LMHash{}
|
|
Evaluation of an assignment $a$ of the form \code{$e_1$?.$v$ = $e_2$}
|
|
proceeds as follows:
|
|
|
|
\LMHash
|
|
If $e_1$ is a type literal, $a$ is equivalent to \code{$e_1$.$v$ = $e_2$}.
|
|
|
|
\LMHash{}
|
|
Otherwise evaluate $e_1$ to an object $o$.
|
|
If $o$ is the null value, $a$ evaluates to the null value.
|
|
Otherwise let $x$ be a fresh variable bound to $o$
|
|
and evaluate \code{$x$.$v$ = $e_2$} to an object $r$.
|
|
Then $a$ evaluates to $r$.
|
|
|
|
\LMHash{}
|
|
The static type of $a$ is the static type of $e_2$. Let $T$ be the static type of $e_1$ and let $y$ be a fresh variable of type $T$. Exactly the same static warnings that would be caused by \code{$y$.$v$ = $e_2$} are also generated in the case of \code{$e_1$?.$v$ = $e_2$}.
|
|
|
|
\LMHash{}
|
|
Evaluation of an assignment of the form \code{$e_1$.$v$ = $e_2$} proceeds as follows:
|
|
|
|
\LMHash{}
|
|
The expression $e_1$ is evaluated to an object $o_1$. Then, the expression $e_2$ is evaluated to an object $o_2$. Then, the setter $v=$ is looked up (\ref{getterAndSetterLookup}) in $o_1$ with respect to the current library. If $o_1$ is an instance of \code{Type} but $e_1$ is not a constant type literal, then if $v=$ is a setter that forwards (\ref{functionDeclarations}) to a static setter, setter lookup fails. Otherwise, the body of $v=$ is executed with its formal parameter bound to $o_2$ and \THIS{} bound to $o_1$.
|
|
|
|
\LMHash{}
|
|
If the setter lookup has failed, then a new instance $im$ of the predefined class \code{Invocation} is created, such that :
|
|
\begin{itemize}
|
|
\item \code{im.isSetter} evaluates to \code{\TRUE{}}.
|
|
\item \code{im.memberName} evaluates to the symbol \code{v=}.
|
|
\item \code{im.positionalArguments} evaluates to an immutable list with the same values as \code{[$o_2$]}.
|
|
\item \code{im.namedArguments} evaluates to the value of \code{\CONST{} \{\}}.
|
|
\end{itemize}
|
|
|
|
\LMHash{}
|
|
Then the method \code{noSuchMethod()} is looked up in $o_1$ and invoked with argument $im$.
|
|
However, if the implementation found cannot be invoked with a single positional argument, the implementation of \code{noSuchMethod()} in class \code{Object} is invoked on $o_1$ with argument $im'$, where $im'$ is an instance of \code{Invocation} such that :
|
|
\begin{itemize}
|
|
\item \code{im'.isMethod} evaluates to \code{\TRUE{}}.
|
|
\item \code{im'.memberName} evaluates to \code{\#noSuchMethod}.
|
|
\item \code{im'.positionalArguments} evaluates to an immutable list whose sole element is $im$.
|
|
\item \code{im'.namedArguments} evaluates to the value of \code{\CONST{} \{\}}.
|
|
\end{itemize}
|
|
|
|
\LMHash{}
|
|
The value of the assignment expression is $o_2$ irrespective of whether setter lookup has failed or succeeded.
|
|
|
|
\LMHash{}
|
|
In checked mode, it is a dynamic type error if $o_2$ is not \NULL{} and the interface of the class of $o_2$ is not a subtype of the actual type of $e_1.v$.
|
|
|
|
\LMHash{}
|
|
Let $T$ be the static type of $e_1$. It is a static type warning if $T$ does not have an accessible instance setter named $v=$ unless either:
|
|
\begin{itemize}
|
|
\item $T$ or a superinterface of $T$ is annotated with an annotation denoting a constant identical to the constant \code{@proxy} defined in \code{dart:core}. Or
|
|
\item $T$ is \code{Type}, $e_1$ is a constant type literal and the class corresponding to $e_1$ has a static setter named $v=$.
|
|
\end{itemize}
|
|
|
|
|
|
|
|
\LMHash{}
|
|
It is a static type warning if the static type of $e_2$ may not be assigned to the static type of the formal parameter of the setter $v=$. The static type of the expression $e_1.v$ \code{=} $e_2$ is the static type of $e_2$.
|
|
|
|
\LMHash{}
|
|
Evaluation of an assignment of the form $\SUPER.v$ \code{=} $e$ proceeds as follows:
|
|
|
|
\LMHash{}
|
|
Let $g$ be the method currently executing, and let $C$ be the class in which $g$ was looked up. Let $S_{dynamic}$ be the superclass of $C$.
|
|
The expression $e$ is evaluated to an object $o$. Then, the setter $v=$ is looked up (\ref{getterAndSetterLookup}) in $S_{dynamic}$ with respect to the current library. The body of $v=$ is executed with its formal parameter bound to $o$ and \THIS{} bound to \THIS{}.
|
|
|
|
\LMHash{}
|
|
If the setter lookup has failed, then a new instance $im$ of the predefined class \code{Invocation} is created, such that :
|
|
\begin{itemize}
|
|
\item \code{im.isSetter} evaluates to \code{\TRUE{}}.
|
|
\item \code{im.memberName} evaluates to the symbol \code{v=}.
|
|
\item \code{im.positionalArguments} evaluates to an immutable list with the same values as \code{[$o$]}.
|
|
\item \code{im.namedArguments} evaluates to the value of \code{\CONST{} \{\}}.
|
|
\end{itemize}
|
|
|
|
\LMHash{}
|
|
Then the method \code{noSuchMethod()} is looked up in $S_{dynamic}$ and invoked with argument $im$.
|
|
However, if the implementation found cannot be invoked with a single positional argument, the implementation of \code{noSuchMethod()} in class \code{Object} is invoked on \THIS{} with argument $im'$, where $im'$ is an instance of \code{Invocation} such that :
|
|
\begin{itemize}
|
|
\item \code{im'.isMethod} evaluates to \code{\TRUE{}}.
|
|
\item \code{im'.memberName} evaluates to \code{\#noSuchMethod}.
|
|
\item \code{im'.positionalArguments} evaluates to an immutable list whose sole element is $im$.
|
|
\item \code{im'.namedArguments} evaluates to the value of \code{\CONST{} \{\}}.
|
|
\end{itemize}
|
|
|
|
\LMHash{}
|
|
The value of the assignment expression is $o$ irrespective of whether setter lookup has failed or succeeded.
|
|
|
|
\LMHash{}
|
|
In checked mode, it is a dynamic type error if $o$ is not \NULL{} and the interface of the class of $o$ is not a subtype of the actual type of $S.v$.
|
|
|
|
\LMHash{}
|
|
Let $S_{static}$ be the superclass of the immediately enclosing class. It is a static type warning if $S_{static}$ does not have an accessible instance setter named $v=$ unless $S_{static}$ or a superinterface of $S_{static}$ is annotated with an annotation denoting a constant identical to the constant \code{@proxy} defined in \code{dart:core}.
|
|
|
|
\LMHash{}
|
|
It is a static type warning if the static type of $e$ may not be assigned to the static type of the formal parameter of the setter $v=$. The static type of the expression $\SUPER.v$ \code{=} $e$ is the static type of $e$.
|
|
|
|
\LMHash{}
|
|
Evaluation of an assignment $e$ of the form \code{$e_1$[$e_2$] = $e_3$}
|
|
proceeds as follows:
|
|
|
|
\LMHash{}
|
|
Evaluate $e_1$ to an object $a$, then evaluate $e_2$ to an object $i$, and finally evaluate $e_3$ to an object $v$.
|
|
Call the method \code{[]=} on $a$ with $i$ as first argument and $v$ as second argument.
|
|
Then $e$ evaluates to $v$.
|
|
|
|
\LMHash{}
|
|
The static type of the expression \code{$e_1$[$e_2$] = $e_3$} is the static type of $e_3$.
|
|
|
|
\LMHash{}
|
|
An assignment of the form \code{\SUPER[$e_1$] = $e_2$} is equivalent to the expression \code{\SUPER.[$e_1$] = $e_2$}. The static type of the expression \code{\SUPER[$e_1$] = $e_2$} is the static type of $e_2$.
|
|
|
|
|
|
% Should we add: It is a dynamic error if $e_1$ evaluates to an constant list or map.
|
|
|
|
\LMHash{}
|
|
It is a static warning if an assignment of the form $v = e$ occurs inside a top level or static function (be it function, method, getter, or setter) or variable initializer and there is neither a local variable declaration with name $v$ nor setter declaration with name $v=$ in the lexical scope enclosing the assignment.
|
|
|
|
\LMHash{}
|
|
It is a compile-time error to invoke any of the setters of class \cd{Object} on a prefix object (\ref{imports}) or on a constant type literal that is immediately followed by the token `.'.
|
|
|
|
|
|
|
|
\subsubsection{Compound Assignment}
|
|
\LMLabel{compoundAssignment}
|
|
|
|
\LMHash{}
|
|
Evaluation of a compound assignment $a$ of the form \code{$v$ ??= $e$}
|
|
proceeds as follows:
|
|
|
|
\LMHash{}
|
|
Evaluate $v$ to an object $o$.
|
|
If $o$ is not the null value, $a$ evaluates to $o$.
|
|
Otherwise evaluate \code{$v$ = $e$} to a value $r$,
|
|
and then $a$ evaluates to $r$.
|
|
|
|
\LMHash{}
|
|
Evaluation of a compound assignment, $a$ of the form \code{$C$.$v$ ??= $e$}, where $C$ is a type literal, proceeds as follow:
|
|
|
|
\LMHash{}
|
|
Evaluate \code{$C$.$v$} to an object $o$.
|
|
If $o$ is not the null value, $a$ evaluates to $o$.
|
|
Otherwise evaluate \code{$C$.$v$ = $e$} to a value $r$,
|
|
and then $a$ evaluates to $r$.
|
|
|
|
\commentary {
|
|
The two rules above also apply when the variable v or the type C is prefixed.
|
|
}
|
|
|
|
\LMHash{}
|
|
Evaluation of a compound assignment $a$ of the form \code{$e_1$.$v$ ??= $e_2$}
|
|
proceeds as follows:
|
|
|
|
\LMHash{}
|
|
Evaluate $e_1$ to an object $u$.
|
|
Let $x$ be a fresh variable bound to $u$.
|
|
Evaluate \code{$x$.$v$} to an object $o$.
|
|
If $o$ is not the null value, $a$ evaluates to $o$.
|
|
Otherwise evaluate \code{$x$.$v$ = $e_2$} to an object $r$,
|
|
and then $a$ evaluates to $r$.
|
|
|
|
\LMHash{}
|
|
Evaluation of a compound assignment $a$ of the form \code{$e_1$[$e_2$] ??= $e_3$}
|
|
proceeds as follows:
|
|
|
|
\LMHash{}
|
|
Evaluate $e_1$ to an object $u$ and then evaluate $e_2$ to an object $i$.
|
|
Call the \code{[]} method on $u$ with argument $i$, and let $o$ be the returned value.
|
|
If $o$ is not the null value, $a$ evaluates to $o$.
|
|
Otherwise evaluate $e_3$ to an object $v$
|
|
and then call the \code{[]=} method on $u$ with $i$ as first argument and $v$ as second argument.
|
|
Then $a$ evaluates to $v$.
|
|
|
|
\LMHash{}
|
|
Evaluation of a compound assignment $a$ of the form \code{\SUPER.$v$ ??= $e$}
|
|
proceeds as follows:
|
|
|
|
\LMHash{}
|
|
Evaluate \code{\SUPER.$v$} to an object $o$.
|
|
If $o$ is not the null value then $a$ evaluates to $o$.
|
|
Otherwise evaluate \code{\SUPER.$v$ = $e$} to an object $r$,
|
|
and then $a$ evaluates to $r$.
|
|
|
|
\LMHash{}
|
|
Evaluation of a compound assignment $a$ of the form \code{$e_1$?.$v$ ??= $e_2$}
|
|
proceeds as follows:
|
|
|
|
\LMHash{}
|
|
Evaluate $e_1$ to an object $u$ and let $x$ be a fresh variable bound to $u$.
|
|
Evaluate \code{$x$.$v$} to an object $o$.
|
|
If $o$ is not the null value then $a$ evaluates to $o$.
|
|
Otherwise evaluate \code{$x$.$v$ = $e_2$} to an object $r$,
|
|
and then $a$ evaluates to $r$.
|
|
|
|
% But what about C?.v ??= e
|
|
|
|
\LMHash{}
|
|
A compound assignment of the form $C?.v$ {\em ??=} $e_2$ is equivalent to the expression $C.v$ {\em ??=} $e$.
|
|
|
|
\LMHash{}
|
|
The static type of a compound assignment of the form $v$ {\em ??=} $e$ is the least upper bound of the static type of $v$ and the static type of $e$. Exactly the same static warnings that would be caused by $v = e$ are also generated in the case of $v$ {\em ??=} $e$.
|
|
|
|
\LMHash{}
|
|
The static type of a compound assignment of the form $C.v$ {\em ??=} $e$ is the least upper bound of the static type of $C.v$ and the static type of $e$. Exactly the same static warnings that would be caused by $C.v = e$ are also generated in the case of $C.v$ {\em ??=} $e$.
|
|
|
|
\LMHash{}
|
|
The static type of a compound assignment of the form $e_1.v$ {\em ??=} $e_2$ is the least upper bound of the static type of $e_1.v$ and the static type of $e_2$. Let $T$ be the static type of $e_1$ and let $z$ be a fresh variable of type $T$. Exactly the same static warnings that would be caused by $z.v = e_2$ are also generated in the case of $e_1.v$ {\em ??=} $e_2$.
|
|
|
|
\LMHash{}
|
|
The static type of a compound assignment of the form $e_1[e_2]$ {\em ??=} $e_3$ is the least upper bound of the static type of $e_1[e_2]$ and the static type of $e_3$. Exactly the same static warnings that would be caused by $e_1[e_2] = e_3$ are also generated in the case of $e_1[e_2]$ {\em ??=} $e_3$.
|
|
|
|
\LMHash{}
|
|
The static type of a compound assignment of the form $\SUPER.v$ {\em ??=} $e$ is the least upper bound of the static type of $\SUPER.v$ and the static type of $e$. Exactly the same static warnings that would be caused by $\SUPER.v = e$ are also generated in the case of $\SUPER.v$ {\em ??=} $e$.
|
|
|
|
\LMHash{}
|
|
For any other valid operator $op$, a compound assignment of the form \code{$v$ $op$= $e$} is equivalent to \code{$v$ = $v$ $op$ $e$}. A compound assignment of the form \code{$C$.$v$ $op$= $e$} is equivalent to \code{$C$.$v$ = $C$.$v$ $op$ $e$}.
|
|
|
|
\LMHash{}
|
|
Evaluation of a compound assignment $a$ of the form \code{$e_1$.$v$ $op$= $e_2$} proceeds as follows:
|
|
Evaluate $e_1$ to an object $u$ and let $x$ be a fresh variable bound to $u$.
|
|
Evaluate \code{$x$.$v$ = $x$.$v$ $op$ $e_2$} to an object $r$
|
|
and then $a$ evaluates to $r$.
|
|
|
|
\LMHash{}
|
|
Evaluation of s compound assignment $a$ of the form \code{$e_1$[$e_2$] $op$= $e_3$} proceeds as follows:
|
|
Evaluate $e_1$ to an object $u$ and evaluate $e_2$ to an object $v$.
|
|
Let $a$ and $i$ be fresh variables bound to $u$ and $v$ respectively.
|
|
Evaluate \code{$a$[$i$] = $a$[$i$] $op$ $e_3$} to an object $r$,
|
|
and then $a$ evaluates to $r$.
|
|
|
|
\LMHash{}
|
|
Evaluation of a compound assignment $a$ of the form \code{$e_1$?.$v$ $op$ = $e_2$} proceeds as follows:
|
|
|
|
\LMHash{}
|
|
Evaluate $e_1$ to an object $u$.
|
|
If $u$ is the null value, then $a$ evaluates to the null value.
|
|
Otherwise let $x$ be a fresh variable bound to $u$.
|
|
Evaluate \code{$x$.$v$ $op$= $e_2$} to an object $r$.
|
|
Then $a$ evaluates to $r$.
|
|
|
|
\LMHash{}
|
|
The static type of \code{$e_1$?.$v$ $op$= $e_2$} is the static type of \code{$e_1$.$v$ $op$ $e_2$}. Exactly the same static warnings that would be caused by \code{$e_1$.$v$ $op$= $e_2$} are also generated in the case of \code{$e_1$?.$v$ $op$= $e_2$}.
|
|
|
|
\LMHash{}
|
|
A compound assignment of the form $C?.v$ $op = e_2$ is equivalent to the expression
|
|
$C.v$ $op = e_2$.
|
|
|
|
\begin{grammar}
|
|
{\bf compoundAssignmentOperator:}`*=';
|
|
`/=';
|
|
`\~{}/=';
|
|
`\%=';
|
|
`+=';
|
|
`-=';
|
|
`{\escapegrammar \lt \lt}=';
|
|
`{\escapegrammar \gt \gt}=';
|
|
`\&=';
|
|
`\^{}=';
|
|
`$|$=';
|
|
`??=';
|
|
.
|
|
\end{grammar}
|
|
|
|
|
|
\subsection{ Conditional}
|
|
\LMLabel{conditional}
|
|
|
|
\LMHash{}
|
|
A {\em conditional expression} evaluates one of two expressions based on a boolean condition.
|
|
|
|
\begin{grammar}
|
|
{\bf conditionalExpression:}
|
|
ifNullExpression (`?' expressionWithoutCascade `{\escapegrammar :}' expressionWithoutCascade)?
|
|
. % the first branches could top level expressions, it seems, but certainly NOT the second
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
Evaluation of a conditional expression $c$ of the form $e_1 ? e_2 : e_3$ proceeds as follows:
|
|
|
|
\LMHash{}
|
|
First, $e_1$ is evaluated to an object $o_1$. Then, $o_1$ is subjected to boolean conversion (\ref{booleanConversion}) producing an object $r$. If $r$ is \TRUE, then the value of $c$ is the result of evaluating the expression $e_2$. Otherwise the value of $c$ is the result of evaluating the expression $e_3$.
|
|
|
|
\LMHash{}
|
|
If all of the following hold:
|
|
\begin{itemize}
|
|
\item $e_1$ shows that a variable $v$ has type $T$.
|
|
\item $v$ is not potentially mutated in $e_2$ or within a closure.
|
|
\item If the variable $v$ is accessed by a closure in $e_2$ then the variable $v$ is not potentially mutated anywhere in the scope of $v$.
|
|
\end{itemize}
|
|
|
|
then the type of $v$ is known to be $T$ in $e_2$.
|
|
|
|
|
|
\LMHash{}
|
|
It is a static type warning if the static type of $e_1$ may not be assigned to \code{bool}. The static type of $c$ is the least upper bound (\ref{leastUpperBounds}) of the static type of $e_2$ and the static type of $e_3$.
|
|
|
|
|
|
\subsection{If-null Expressions}
|
|
\label{ifNull}
|
|
|
|
\LMHash{}
|
|
An {\em if-null expression}evaluates an expression and if the result is \NULL, evaluates another.
|
|
|
|
\begin{grammar}
|
|
{\bf ifNullExpression:}
|
|
logicalOrExpression (`??' logicalOrExpression)*
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
Evaluation of an if-null expression $e$ of the form \code{$e_1$ ?? $e_2$}
|
|
proceeds as follows:
|
|
|
|
\LMHash{}
|
|
Evaluate $e_1$ to an object $o$.
|
|
If $o$ is not the null value, then $e$ evaluates to $o$.
|
|
Otherwise evaluate $e_2$ to an object $r$,
|
|
and then $e$ evaluates to $r$.
|
|
|
|
\LMHash{}
|
|
The static type of $e$ is the least upper bound (\ref{leastUpperBounds}) of the static type of $e_1$ and the static type of $e_2$.
|
|
|
|
|
|
\subsection{ Logical Boolean Expressions}
|
|
\LMLabel{logicalBooleanExpressions}
|
|
|
|
\LMHash{}
|
|
The logical boolean expressions combine boolean objects using the boolean conjunction and disjunction operators.
|
|
|
|
\begin{grammar}
|
|
{\bf logicalOrExpression:}
|
|
logicalAndExpression (`$||$' logicalAndExpression)*
|
|
.
|
|
|
|
|
|
{\bf logicalAndExpression:}
|
|
equalityExpression (`\&\&' equalityExpression)*
|
|
% bitwiseOrExpression (`\&\&' bitwiseOrExpression)*
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
A {\em logical boolean expression} is either an equality expression (\ref{equality}), or an invocation of a logical boolean operator on an expression $e_1$ with argument $e_2$.
|
|
|
|
\LMHash{}
|
|
Evaluation of a logical boolean expression $b$ of the form $e_1 || e_2$ causes the evaluation of $e_1$ which is then subjected to boolean conversion, producing an object $o_1$; if $o_1$ is \TRUE, the result of evaluating $b$ is \TRUE, otherwise $e_2$ is evaluated to an object $o_2$, which is then subjected to boolean conversion (\ref{booleanConversion}) producing an object $r$, which is the value of $b$.
|
|
|
|
\LMHash{}
|
|
Evaluation of a logical boolean expression $b$ of the form $e_1 \&\& e_2$ causes the evaluation of $e_1$ which is then subjected to boolean conversion, producing an object $o_1$; if $o_1$ is not \TRUE, the result of evaluating $b$ is \FALSE, otherwise $e_2$ is evaluated to an object $o_2$, which is then subjected to boolean conversion evaluating to an object $r$, which is the value of $b$.
|
|
|
|
\LMHash{}
|
|
A logical boolean expression $b$ of the form $e_1 \&\& e_2$ shows that a variable $v$ has type
|
|
$T$ if all of the following conditions hold:
|
|
\begin{itemize}
|
|
\item Either $e_1$ shows that $v$ has type $T$ or $e_2$ shows that $v$ has type $T$.
|
|
\item $v$ is a local variable or formal parameter.
|
|
\item The variable $v$ is not mutated in $e_2$ or within a closure.
|
|
\end{itemize}
|
|
|
|
\LMHash{}
|
|
Furthermore, if all of the following hold:
|
|
\begin{itemize}
|
|
\item $e_1$ shows that $v$ has type $T$.
|
|
\item $v$ is not mutated in either $e_1$, $e_2$ or within a closure.
|
|
\item If the variable $v$ is accessed by a closure in $e_2$ then the variable $v$ is not potentially mutated anywhere in the scope of $v$.
|
|
\end{itemize}
|
|
then the type of $v$ is known to be $T$ in $e_2$.
|
|
|
|
\LMHash{}
|
|
It is a static warning if the static type of $e_1$ may not be assigned to \cd{bool} or if the static type of $e_2$ may not be assigned to \cd{bool}. The static type of a logical boolean expression is \code{bool}.
|
|
|
|
|
|
\subsection{ Equality}
|
|
\LMLabel{equality}
|
|
|
|
\LMHash{}
|
|
Equality expressions test objects for equality.
|
|
|
|
\begin{grammar}
|
|
{\bf equalityExpression:}relationalExpression (equalityOperator relationalExpression)?;
|
|
\SUPER{} equalityOperator relationalExpression
|
|
.
|
|
|
|
{\bf equalityOperator:}`==';
|
|
`!='
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
An {\em equality expression} is either a relational expression (\ref{relationalExpressions}), or an invocation of an equality operator on either \SUPER{} or an expression $e_1$, with argument $e_2$.
|
|
|
|
|
|
\LMHash{}
|
|
Evaluation of an equality expression $ee$ of the form \code{$e_1$ == $e_2$} proceeds as follows:
|
|
\begin{itemize}
|
|
\item The expression $e_1$ is evaluated to an object $o_1$.
|
|
\item The expression $e_2$ is evaluated to an object $o_2$.
|
|
\item If either $o_1$ or $o_2$ is \NULL{}, then $ee$ evaluates to \TRUE{} if both $o_1$ and $o_2$ are \NULL{} and to \FALSE{} otherwise. Otherwise,
|
|
\item $ee$ is equivalent to the method invocation \code{$o_1$.==($o_2$)}.
|
|
\end{itemize}
|
|
|
|
|
|
\LMHash{}
|
|
Evaluation of an equality expression $ee$ of the form \code{\SUPER{} == $e$} proceeds as follows:
|
|
\begin{itemize}
|
|
\item The expression $e$ is evaluated to an object $o$.
|
|
\item If either \THIS{} or $o$ is \NULL{}, then $ee$ evaluates to evaluates to \TRUE{} if both \THIS{} and $o$ are \NULL{} and to \FALSE{} otherwise. Otherwise,
|
|
\item $ee$ is equivalent to the method invocation \code{\SUPER{}.==($o$)}.
|
|
\end{itemize}
|
|
|
|
\commentary{As a result of the above definition, user defined \code{==} methods can assume that their argument is non-null, and avoid the standard boiler-plate prelude:
|
|
|
|
\code{if (identical(\NULL{}, arg)) return \FALSE{};}
|
|
|
|
Another implication is that there is never a need to use \code{identical()} to test against \NULL{}, nor should anyone ever worry about whether to write \NULL{} == $e$ or $e$ == \NULL{}.
|
|
}
|
|
|
|
\LMHash{}
|
|
An equality expression of the form \code{$e_1$ != $e_2$} is equivalent to the expression \code{!($e_1$ == $e_2$)}. An equality expression of the form \code{\SUPER{} != $e$} is equivalent to the expression \code{!(\SUPER{} == $e$)}.
|
|
|
|
|
|
|
|
%The expression $e_1$ is evaluated to an object $o_1$; then the expression $e_2$ is evaluated to an object $o_2$. Next, if $o_1$ and $o_2$ are the same object, then $ee$ evaluates to \TRUE{}, otherwise $ee$ evaluates to \FALSE{}.
|
|
|
|
|
|
\LMHash{}
|
|
The static type of an equality expression is \code{bool}.
|
|
|
|
|
|
\subsection{ Relational Expressions}
|
|
\LMLabel{relationalExpressions}
|
|
|
|
\LMHash{}
|
|
Relational expressions invoke the relational operators on objects.
|
|
|
|
\begin{grammar}
|
|
{\bf relationalExpression:}bitwiseOrExpression (typeTest $|$ typeCast $|$ relationalOperator bitwiseOrExpression)?;
|
|
\SUPER{} relationalOperator bitwiseOrExpression
|
|
.
|
|
|
|
|
|
{\bf relationalOperator:}`{\escapegrammar \gt=}';
|
|
`{\escapegrammar \gt}';
|
|
`{\escapegrammar \lt}=';
|
|
`{\escapegrammar \lt}'
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
A {\em relational expression} is either a bitwise expression (\ref{bitwiseExpressions}), or an invocation of a relational operator on either \SUPER{} or an expression $e_1$, with argument $e_2$.
|
|
|
|
\LMHash{}
|
|
A relational expression of the form $e_1$ $op$ $e_2$ is equivalent to the method invocation \code{$e_1$.$op$($e_2$)}. A relational expression of the form \SUPER{} $op$ $e_2$ is equivalent to the method invocation \code{\SUPER{}.$op$($e_2$)}.
|
|
|
|
\subsection{ Bitwise Expressions}
|
|
\LMLabel{bitwiseExpressions}
|
|
|
|
\LMHash{}
|
|
Bitwise expressions invoke the bitwise operators on objects.
|
|
|
|
\begin{grammar}
|
|
{\bf bitwiseOrExpression:}bitwiseXorExpression (`$|$' bitwiseXorExpression)*;
|
|
\SUPER{} (`$|$' bitwiseXorExpression)+
|
|
.
|
|
|
|
{\bf bitwiseXorExpression:}bitwiseAndExpression (`\^{}' bitwiseAndExpression)*;
|
|
\SUPER{} (`\^{}' bitwiseAndExpression)+
|
|
.
|
|
|
|
{\bf bitwiseAndExpression:}shiftExpression (`\&' shiftExpression)*;
|
|
\SUPER{} (`\&' shiftExpression)+
|
|
.
|
|
|
|
{\bf bitwiseOperator:}`\&';
|
|
`\^{}';
|
|
`$|$'
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
A {\em bitwise expression} is either a shift expression (\ref{shift}), or an invocation of a bitwise operator on either \SUPER{} or an expression $e_1$, with argument $e_2$.
|
|
|
|
\LMHash{}
|
|
A bitwise expression of the form $e_1$ $op$ $e_2$ is equivalent to the method invocation $e_1.op(e_2)$.
|
|
A bitwise expression of the form \code{\SUPER{} $op$ $e_2$} is equivalent to the method invocation \code{\SUPER{}.op($e_2$)}.
|
|
|
|
\commentary{
|
|
It should be obvious that the static type rules for these expressions are defined by the equivalence above - ergo, by the type rules for method invocation and the signatures of the operators on the type $e_1$. The same holds in similar situations throughout this specification.
|
|
}
|
|
|
|
|
|
\subsection{ Shift}
|
|
\LMLabel{shift}
|
|
|
|
\LMHash{}
|
|
Shift expressions invoke the shift operators on objects.
|
|
|
|
\begin{grammar}
|
|
{\bf shiftExpression:}additiveExpression (shiftOperator additiveExpression)*;
|
|
\SUPER{} (shiftOperator additiveExpression)+
|
|
.
|
|
|
|
{\bf shiftOperator:}`{\escapegrammar \lt\lt'};
|
|
`{\escapegrammar \gt \gt}'
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
A {\em shift expression} is either an additive expression (\ref{additiveExpressions}), or an invocation of a shift operator on either \SUPER{} or an expression $e_1$, with argument $e_2$.
|
|
|
|
\LMHash{}
|
|
A shift expression of the form $e_1$ $op$ $e_2$ is equivalent to the method invocation \code{$e_1$.$op$($e_2$)}. A shift expression of the form \SUPER{} $op$ $e_2$ is equivalent to the method invocation \code{\SUPER{}.$op$($e_2$)}.
|
|
|
|
\commentary{
|
|
Note that this definition implies left-to-right evaluation order among shift expressions:
|
|
|
|
$e_1 << e_2 << e_3$
|
|
|
|
is evaluated as $(e_1 << e_2 ).<< (e_3)$ which is equivalent to $(e_1 << e_2) << e_3$.
|
|
The same holds for additive and multiplicative expressions.
|
|
}
|
|
|
|
\subsection{ Additive Expressions}
|
|
\LMLabel{additiveExpressions}
|
|
|
|
\LMHash{}
|
|
Additive expressions invoke the addition operators on objects.
|
|
|
|
\begin{grammar}
|
|
{\bf additiveExpression:}multiplicativeExpression (additiveOperator multiplicativeExpression)*;
|
|
\SUPER{} (additiveOperator multiplicativeExpression)+
|
|
.
|
|
|
|
{\bf additiveOperator:}`+';
|
|
`-'
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
An {\em additive expression} is either a multiplicative expression (\ref{multiplicativeExpressions}), or an invocation of an additive operator on either \SUPER{} or an expression $e_1$, with argument $e_2$.
|
|
|
|
\LMHash{}
|
|
An additive expression of the form $e_1$ $op$ $e_2$ is equivalent to the method invocation \code{$e_1$.$op$($e_2$)}. An additive expression of the form \SUPER{} $op$ $e_2$ is equivalent to the method invocation \code{\SUPER{}.$op$($e_2$)}.
|
|
|
|
\LMHash{}
|
|
The static type of an additive expression is usually determined by the signature given in the declaration of the operator used. However, invocations of the operators \cd{+} and \cd{-} of class \cd{int} are treated specially by the typechecker. The static type of an expression $e_1 + e_2$ where $e_1$ has static type \cd{int} is \cd{int} if the static type of $e_2$ is \cd{int}, and \cd{double} if the static type of $e_2$ is \cd{double}. The static type of an expression $e_1 - e_2$ where $e_1$ has static type \cd{int} is \cd{int} if the static type of $e_2$ is \cd{int}, and \cd{double} if the static type of $e_2$ is \cd{double}.
|
|
|
|
|
|
\subsection{ Multiplicative Expressions}
|
|
\LMLabel{multiplicativeExpressions}
|
|
|
|
\LMHash{}
|
|
Multiplicative expressions invoke the multiplication operators on objects.
|
|
|
|
\begin{grammar}
|
|
{\bf multiplicativeExpression:}unaryExpression (multiplicativeOperator unaryExpression)*;
|
|
\SUPER{} (multiplicativeOperator unaryExpression)+
|
|
.
|
|
|
|
{\bf multiplicativeOperator:}`*';
|
|
`/';
|
|
`\%';
|
|
`\~{}/'
|
|
.
|
|
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
A {\em multiplicative expression} is either a unary expression (\ref{unaryExpressions}), or an invocation of a multiplicative operator on either \SUPER{} or an expression $e_1$, with argument $e_2$.
|
|
|
|
\LMHash{}
|
|
A multiplicative expression of the form $e_1$ $op$ $e_2$ is equivalent to the method invocation \code{$e_1$.$op$($e_2$)}. A multiplicative expression of the form \SUPER{} $op$ $e_2$ is equivalent to the method invocation \code{\SUPER{}.$op$($e_2$)}.
|
|
|
|
\LMHash{}
|
|
The static type of an multiplicative expression is usually determined by the signature given in the declaration of the operator used. However, invocations of the operators \cd{*}, \cd{\%} and \cd{\~{}/} of class \cd{int} are treated specially by the typechecker. The static type of an expression $e_1 * e_2$ where $e_1$ has static type \cd{int} is \cd{int} if the static type of $e_2$ is \cd{int}, and \cd{double} if the static type of $e_2$ is \cd{double}. The static type of an expression $e_1 \% e_2$ where $e_1$ has static type \cd{int} is \cd{int} if the static type of $e_2$ is \cd{int}, and \cd{double} if the static type of $e_2$ is \cd{double}. The static type of an expression \cd{$e_1$ \~{}/ $e_2$} where $e_1$ has static type \cd{int} is \cd{int} if the static type of $e_2$ is \cd{int}.
|
|
|
|
\subsection{ Unary Expressions}
|
|
\LMLabel{unaryExpressions}
|
|
|
|
\LMHash{}
|
|
Unary expressions invoke unary operators on objects.
|
|
|
|
\begin{grammar}
|
|
{\bf unaryExpression:}prefixOperator unaryExpression;
|
|
awaitExpression;
|
|
postfixExpression;
|
|
(minusOperator $|$ tildeOperator) \SUPER{};
|
|
incrementOperator assignableExpression
|
|
.
|
|
|
|
{\bf prefixOperator:}minusOperator;
|
|
negationOperator;
|
|
tildeOperator
|
|
.
|
|
|
|
|
|
{\bf minusOperator:}`-'; .
|
|
|
|
|
|
{\bf negationOperator:}`!' ;
|
|
.
|
|
|
|
{\bf tildeOperator:} `\~{}'
|
|
.
|
|
|
|
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
A {\em unary expression} is either a postfix expression (\ref{postfixExpressions}), an await expression (\ref{awaitExpressions}) or an invocation of a prefix operator on an expression or an invocation of a unary operator on either \SUPER{} or an expression $e$.
|
|
|
|
\LMHash{}
|
|
The expression $!e$ is equivalent to the expression $e?$ $ \FALSE{} :\TRUE{}$.
|
|
|
|
\LMHash{}
|
|
Evaluation of an expression of the form \code{++$e$} is equivalent to \code{$e$ += 1}. Evaluation of an expression of the form \code{-{}-$e$} is equivalent to \code{$e$ -= 1}.
|
|
|
|
%The expression $-e$ is equivalent to the method invocation \code{$e$.-()}. The expression \code{-\SUPER{}} is equivalent to the method invocation \code{\SUPER{}.-()}.
|
|
|
|
\LMHash{}
|
|
An expression of the form \code{$op$ $e$} is equivalent to the method invocation \code{$e.op()$}. An expression of the form \code{$op$ \SUPER{}} is equivalent to the method invocation (\ref{superInvocation}) \code{\SUPER{}.$op()$}.
|
|
|
|
\subsection{ Await Expressions}
|
|
\LMLabel{awaitExpressions}
|
|
|
|
\LMHash{}
|
|
An {\em await expression} allows code to yield control until an asynchronous operation (\ref{functions}) completes.
|
|
|
|
\begin{grammar}
|
|
{\bf awaitExpression:}
|
|
\AWAIT{} unaryExpression
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
Evaluation of an await expression $a$ of the form \AWAIT{} $e$ proceeds as follows:
|
|
First, the expression $e$ is evaluated to an object $o$.
|
|
|
|
\LMHash{}
|
|
% NOTICE: Removed the requirement that an error thrown by $e$ is caught in a
|
|
% future. There is no reason $var x = e; await x;$ and $await e$ should behave
|
|
% differently, and no implementation actually implemented it.
|
|
Then, if $o$ is not an instance of \code{Future}, then let $f$ be the result of creating a new object using the constructor \code{Future.value()} with $o$ as its argument; otherwise let $f$ be $o$.
|
|
|
|
\LMHash{}
|
|
Next, the stream associated with the innermost enclosing asynchronous for loop (\ref{asynchronousFor-in}), if any, is paused. The current invocation of the function body immediately enclosing $a$ is suspended until after $f$ completes. At some time after $f$ is completed, control returns to the current invocation. If $f$ has completed with an error $x$ and stack trace $t$, $a$ throws $x$ and $t$ (\ref{evaluation}). If $f$ completes with a value $v$, $a$ evaluates to $v$.
|
|
|
|
%Otherwise, the value of $a$ is the value of $e$. If evaluation of $e$ raises an exception $x$, $a$ raises $x$.
|
|
|
|
\commentary{
|
|
It is a compile-time error if the function immediately enclosing $a$ is not declared asynchronous. However, this error is simply a syntax error, because in the context of a normal function, \AWAIT{} has no special meaning.
|
|
% TODO(lrn): Update this, it's not actually correct,
|
|
% the expression "await(expr)" is valid non-async syntax *and* a valid
|
|
% async await expression.
|
|
}
|
|
|
|
\rationale{
|
|
An await expression has no meaning in a synchronous function. If such a function were to suspend waiting for a future, it would no longer be synchronous.
|
|
}
|
|
|
|
\commentary{
|
|
It is not a static warning if the type of $e$ is not a subtype of \code{Future}. Tools may choose to give a hint in such cases.
|
|
}
|
|
|
|
\LMHash{}
|
|
The static type of $a$ is $flatten(T)$ (the $flatten$ function is defined in section \ref{functionExpressions}) where $T$ is the static type of $e$.
|
|
|
|
|
|
|
|
\subsection{ Postfix Expressions}
|
|
\LMLabel{postfixExpressions}
|
|
|
|
\LMHash{}
|
|
Postfix expressions invoke the postfix operators on objects.
|
|
|
|
\begin{grammar}
|
|
{\bf postfixExpression:}assignableExpression postfixOperator;
|
|
primary selector*
|
|
.
|
|
|
|
{\bf postfixOperator:}
|
|
incrementOperator
|
|
.
|
|
|
|
{\bf selector:}assignableSelector;
|
|
arguments
|
|
.
|
|
|
|
{\bf incrementOperator:}`++';
|
|
`-{}-'
|
|
.
|
|
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
A {\em postfix expression} is either a primary expression, a function, method or getter invocation, or an invocation of a postfix operator on an expression $e$.
|
|
|
|
\LMHash{}
|
|
Evaluation of a postfix expression $e$ of the form \code{$v$++}, where $v$ is an identifier, proceeds as follows:
|
|
|
|
\LMHash{}
|
|
Evaluate $v$ to an object $r$ and let $y$ be a fresh variable bound to $r$.
|
|
Evaluate \code{$v$ = $y$ + 1}.
|
|
Then $e$ evaluates to $r$.
|
|
|
|
\LMHash{}
|
|
The static type of such an expression is the static type of $v$.
|
|
|
|
\rationale{
|
|
The above ensures that if $v$ is a variable, the getter gets called exactly once.
|
|
Likewise in the cases below.
|
|
}
|
|
|
|
\LMHash{}
|
|
Evaluation of a postfix expression $e$ of the form \code{$C$.$v$++}
|
|
proceeds as follows:
|
|
|
|
\LMHash{}
|
|
Evaluate \code{$C$.$v$} to a value $r$
|
|
and let $y$ be a fresh variable bound to $r$.
|
|
Evaluate \code{$C$.$v$ = $y$ + 1}.
|
|
Then $e$ evaluates to $r$.
|
|
|
|
\LMHash{}
|
|
The static type of such an expression is the static type of \code{$C$.$v$}.
|
|
|
|
|
|
\LMHash{}
|
|
Evaluation of a postfix expression $e$ of the form \code{$e_1$.$v$++}
|
|
proceeds as follows:
|
|
|
|
\LMHash{}
|
|
Evaluate $e_1$ to an object $u$ and let $x$ be a fresh variable bound to $u$.
|
|
Evaluate \code{$x$.$v$} to a value $r$
|
|
and let $y$ be a fresh variable bound to $r$.
|
|
Evaluate \code{$x$.$v$ = $y$ + 1}.
|
|
Then $e$ evaluates to $r$.
|
|
|
|
\LMHash{}
|
|
The static type of such an expression is the static type of \code{$e_1$.$v$}.
|
|
|
|
|
|
\LMHash{}
|
|
Evaluation of a postfix expression $e$ of the form \code{$e_1$[$e_2$]++}
|
|
proceeds as follows:
|
|
|
|
\LMHash{}
|
|
Evaluate $e_1$ to an object $u$ and $e_2$ to an object $v$.
|
|
Let $a$ and $i$ be fresh variables bound to $u$ and $v$ respectively.
|
|
Evaluate \code{$a$[$i$]} to an object $r$
|
|
and let $y$ be a fresh variable bound to $r$.
|
|
Evaluate \code{$a$[$i$] = $y$ + 1}.
|
|
Then $e$ evaluates to $r$.
|
|
|
|
\LMHash{}
|
|
The static type of such an expression is the static type of \code{$e_1$[$e_2$]}.
|
|
|
|
|
|
\LMHash{}
|
|
Evaluation of a postfix expression $e$ of the form \code{$v$-{}-}, where $v$ is an identifier, proceeds as follows:
|
|
|
|
\LMHash{}
|
|
Evaluate the expression $v$ to an object $r$
|
|
and let $y$ be a fresh variable bound to $r$.
|
|
Evaluate \code{$v$ = $y$ - 1}.
|
|
Then $e$ evaluates to $r$.
|
|
|
|
\LMHash{}
|
|
The static type of such an expression is the static type of $v$.
|
|
|
|
|
|
\LMHash{}
|
|
Evaluation of a postfix expression $e$ of the form \code{$C$.$v$-{}-}
|
|
proceeds as follows:
|
|
|
|
\LMHash{}
|
|
Evaluate \code{$C$.$v$} to a value $r$
|
|
and let $y$ be a fresh variable bound to $r$.
|
|
Evaluate \code{$C$.$v$ = $y$ - 1}.
|
|
Then $e$ evaluates to $r$.
|
|
|
|
\LMHash{}
|
|
The static type of such an expression is the static type of \code{$C$.$v$}.
|
|
|
|
|
|
\LMHash{}
|
|
Evaluation of a postfix expression of the form \code{$e_1$.$v$-{}-}
|
|
proceeds as follows:
|
|
|
|
\LMHash{}
|
|
Evaluate $e_1$ to an object $u$ and let $x$ be a fresh variable bound to $u$.
|
|
Evaluate \code{$x$.$v$} to a value $r$
|
|
and let $y$ be a fresh variable bound to $r$.
|
|
Evaluate \code{$x$.$v$ = $y$ - 1}.
|
|
Then $e$ evaluates to $r$.
|
|
|
|
|
|
\LMHash{}
|
|
The static type of such an expression is the static type of \code{$e_1$.$v$}.
|
|
|
|
|
|
\LMHash{}
|
|
Evaluation of a postfix expression $e$ of the form \code{$e_1$[$e_2$]-{}-}
|
|
proceeds as follows:
|
|
|
|
\LMHash{}
|
|
Evaluate $e_1$ to an object $u$ and $e_2$ to an object $v$.
|
|
Let $a$ and $i$ be fresh variables bound to $u$ and $v$ respectively.
|
|
Evaluate \code{$a$[$i$]} to an object $r$
|
|
and let $y$ be a fresh variable bound to $r$.
|
|
Evaluate \code{$a$[$i$] = $y$ - 1}.
|
|
Then $e$ evaluates to $r$.
|
|
|
|
\LMHash{}
|
|
The static type of such an expression is the static type of \code{$e_1$[$e_2$]}.
|
|
|
|
\LMHash{}
|
|
Evaluation of a postfix expression $e$ of the form \code{$e_1$?.$v$++}
|
|
where $e_1$ is not a type literal, proceeds as follows:
|
|
|
|
\LMHash{}
|
|
If $e_1$ is a type literal, $e$ is equivalent to \code{$e_1$.$v$++}.
|
|
|
|
\LMHash{}
|
|
Otherwise evaluate $e_1$ to an object $u$.
|
|
if $u$ is the null value, $e$ evaluates to the null value.
|
|
Otherwise let $x$ be a fresh variable bound to $u$.
|
|
Evaluate \code{$x$.$v$++} to an object $o$.
|
|
Then $e$ evaluates to $o$.
|
|
|
|
\LMHash{}
|
|
The static type of such an expression is the static type of \code{$e_1$.$v$}.
|
|
|
|
\LMHash{}
|
|
Evaluation of a postfix expression $e$ of the form \code{$e_1$?.$v$-{}-}
|
|
where $e_1$ is not a type literal, proceeds as follows:
|
|
|
|
If $e_1$ is a type literal, $e$ is equivalent to \code{$e_1$.$v$-{}-}.
|
|
|
|
Otherwise evaluate $e_1$ to an object $u$.
|
|
If $u$ is the null value, $e$ evaluates to the null value.
|
|
Otherwise let $x$ be a fresh variable bound to $u$.
|
|
Evaluate \code{$x$.$v$-{}-} to an object $o$.
|
|
Then $e$ evaluates to $o$.
|
|
|
|
|
|
\LMHash{}
|
|
The static type of such an expression is the static type of \code{$e_1$.$v$}.
|
|
|
|
|
|
\subsection{ Assignable Expressions}
|
|
\LMLabel{assignableExpressions}
|
|
|
|
\LMHash{}
|
|
Assignable expressions are expressions that can appear on the left hand side of an assignment.
|
|
This section describes how to evaluate these expressions when they do not constitute the complete left hand side of an assignment.
|
|
|
|
\rationale{
|
|
Of course, if assignable expressions always appeared {\em as} the left hand side, one would have no need for their value, and the rules for evaluating them would be unnecessary. However, assignable expressions can be subexpressions of other expressions and therefore must be evaluated.
|
|
}
|
|
|
|
|
|
|
|
\begin{grammar}
|
|
|
|
{\bf assignableExpression:}primary (arguments* assignableSelector)+;
|
|
\SUPER{} unconditionalAssignableSelector;
|
|
identifier
|
|
.
|
|
|
|
{\bf unconditionalAssignableSelector:}`[' expression `]'; % again, could be top level
|
|
`{\escapegrammar .}' identifier
|
|
.
|
|
|
|
{\bf assignableSelector:}
|
|
unconditionalAssignableSelector;
|
|
`{\escapegrammar ?.}' identifier
|
|
.
|
|
|
|
\end{grammar}
|
|
|
|
|
|
\LMHash{}
|
|
An {\em assignable expression} is either:
|
|
\begin{itemize}
|
|
\item An identifier.
|
|
\item An invocation (possibly conditional) of a getter (\ref{getters}) or list access operator on an expression $e$.
|
|
\item An invocation of a getter or list access operator on \SUPER{}.
|
|
\end{itemize}
|
|
|
|
|
|
\LMHash{}
|
|
An assignable expression of the form $id$ is evaluated as an identifier expression (\ref{identifierReference}).
|
|
|
|
%An assignable expression of the form $e.id(a_1, \ldots, a_n)$ is evaluated as a method invocation (\ref{methodInvocation}).
|
|
|
|
\LMHash{}
|
|
An assignable expression of the form $e.id$ or $e?.id$ is evaluated as a property extraction (\ref{propertyExtraction}).
|
|
|
|
\LMHash{}
|
|
An assignable expression of the form \code{$e_1$[$e_2$]} is evaluated as a method invocation of the operator method \code{[]} on $e_1$ with argument $e_2$.
|
|
|
|
\LMHash{}
|
|
An assignable expression of the form \code{\SUPER{}.id} is evaluated as a property extraction.
|
|
|
|
\LMHash{}
|
|
An assignable expression of the form \code{\SUPER{}[$e_2$]} is equivalent to the method invocation \code{\SUPER{}.[]($e_2$)}.
|
|
|
|
\subsection{ Identifier Reference}
|
|
\LMLabel{identifierReference}
|
|
|
|
\LMHash{}
|
|
An {\em identifier expression} consists of a single identifier; it provides access to an object via an unqualified name.
|
|
|
|
\begin{grammar}
|
|
{\bf identifier:}
|
|
IDENTIFIER
|
|
.
|
|
|
|
{\bf IDENTIFIER\_NO\_DOLLAR:}
|
|
IDENTIFIER\_START\_NO\_DOLLAR IDENTIFIER\_PART\_NO\_DOLLAR*
|
|
.
|
|
|
|
{\bf IDENTIFIER:}
|
|
IDENTIFIER\_START IDENTIFIER\_PART*
|
|
.
|
|
|
|
{\bf BUILT\_IN\_IDENTIFIER:}\ABSTRACT{};
|
|
\AS{};
|
|
\COVARIANT{};
|
|
\DEFERRED{};
|
|
\DYNAMIC{};
|
|
\EXPORT{};
|
|
\EXTERNAL{};
|
|
\FACTORY{};
|
|
\GET{};
|
|
\IMPLEMENTS{};
|
|
\IMPORT{};
|
|
\LIBRARY{};
|
|
\OPERATOR{};
|
|
\PART{};
|
|
\SET{};
|
|
\STATIC{};
|
|
\TYPEDEF{}
|
|
.
|
|
|
|
{\bf IDENTIFIER\_START:}IDENTIFIER\_START\_NO\_DOLLAR;
|
|
`\$'
|
|
.
|
|
|
|
{\bf IDENTIFIER\_START\_NO\_DOLLAR:}LETTER;
|
|
`\_'
|
|
.
|
|
|
|
{\bf IDENTIFIER\_PART\_NO\_DOLLAR:}IDENTIFIER\_START\_NO\_DOLLAR;
|
|
DIGIT
|
|
.
|
|
|
|
{\bf IDENTIFIER\_PART:}IDENTIFIER\_START;
|
|
DIGIT
|
|
.
|
|
|
|
{\bf qualified:}
|
|
identifier (`{\escapegrammar .}' identifier)?
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
A built-in identifier is one of the identifiers produced by the production {\em BUILT\_IN\_IDENTIFIER}.
|
|
It is a compile-time error if a built-in identifier is used as the declared name of a prefix, class, type parameter or type alias.
|
|
It is a compile-time error to use a built-in identifier other than \DYNAMIC{} in a type annotation or type parameter.
|
|
|
|
\rationale{
|
|
Built-in identifiers are identifiers that are used as keywords in Dart, but are not reserved words in Javascript. To minimize incompatibilities when porting Javascript code to Dart, we do not make these into reserved words. A built-in identifier may not be used to name a class or type. In other words, they are treated as reserved words when used as types. This eliminates many confusing situations without causing compatibility problems. After all, a Javascript program has no type declarations or annotations so no clash can occur. Furthermore, types should begin with an uppercase letter (see the appendix) and so no clash should occur in any Dart user program anyway.
|
|
}
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if any of the identifiers \ASYNC, \AWAIT{} or \YIELD{} is used as an identifier in a function body marked with either \ASYNC{}, \ASYNC* or \SYNC*.
|
|
|
|
\rationale{
|
|
For compatibility reasons, new constructs cannot rely upon new reserved words or even built-in identifiers. However, the constructs above are only usable in contexts that require special markers introduced concurrently with these constructs, so no old code could use them. Hence the restriction, which treats these names as reserved words in a limited context.
|
|
}
|
|
|
|
\LMHash{}
|
|
Evaluation of an identifier expression $e$ of the form $id$ proceeds as follows:
|
|
|
|
|
|
\LMHash{}
|
|
Let $d$ be the innermost declaration in the enclosing lexical scope whose name is $id$ or $id=$. If no such declaration exists in the lexical scope, let $d$ be the declaration of the inherited member named $id$ if it exists.
|
|
%If no such member exists, let $d$ be the declaration of the static member name $id$ declared in a superclass of the current class, if it exists.
|
|
|
|
\begin{itemize}
|
|
\item if $d$ is a prefix $p$, a compile-time error occurs unless the token immediately following $d$ is \code{'.'}.
|
|
\item If $d$ is a class or type alias $T$, the value of $e$ is an instance of class \code{Type} (or a subclass thereof) reifying $T$.
|
|
\item If $d$ is a type parameter $T$, then the value of $e$ is the value of the actual type argument corresponding to $T$ that was passed to the generative constructor that created the current binding of \THIS{}. If, however, $e$ occurs inside a static member, a compile-time error occurs.
|
|
|
|
%\commentary{ We are assured that \THIS{} is well defined, because if we were in a static member the reference to $T$ is a compile-time error (\ref{generics}.)}
|
|
%\item If $d$ is a library variable then:
|
|
% \begin{itemize}
|
|
% \item If $d$ is of one of the forms \code{\VAR{} $v$ = $e_i$;} , \code{$T$ $v$ = $e_i$;} , \code{\FINAL{} $v$ = $e_i$;} or \code{\FINAL{} $T$ $v$ = $e_i$;} and no value has yet been stored into $v$ then the initializer expression $e_i$ is evaluated. If, during the evaluation of $e_i$, the getter for $v$ is referenced, a \code{CyclicInitializationError} is thrown. If the evaluation succeeded yielding an object $o$, let $r = o$, otherwise let $r = \NULL{}$. In any case, $r$ is stored into $v$. The value of $e$ is $r$.
|
|
\item If $d$ is a constant variable of one of the forms \code{\CONST{} $v$ = $e$;} or \code{\CONST{} $T$ $v$ = $e$;} then the value $id$ is the value of the compile-time constant $e$.
|
|
% Otherwise
|
|
% \item $e$ evaluates to the current binding of $id$.
|
|
% \end{itemize}
|
|
\item If $d$ is a local variable or formal parameter then $e$ evaluates to the current binding of $id$.
|
|
%\item If $d$ is a library variable, local variable, or formal parameter, then $e$ evaluates to the current binding of $id$. \commentary{This case also applies if d is a library or local function declaration, as these are equivalent to function-valued variable declarations.}
|
|
\item If $d$ is a static method, top-level function or local function then $e$ evaluates to the function defined by $d$.
|
|
\item If $d$ is the declaration of a static variable, static getter or static setter declared in class $C$, then $e$ is equivalent to the property extraction (\ref{propertyExtraction}) $C.id$.
|
|
\item If $d$ is the declaration of a library variable, top-level getter or top-level setter, then $e$ is equivalent to the top level getter invocation (\ref{topLevelGetterInvocation}) $id$.
|
|
\item Otherwise, if $e$ occurs inside a top level or static function (be it function, method, getter, or setter) or variable initializer, evaluation of $e$ causes a \code{NoSuchMethod} to be thrown.
|
|
\item Otherwise, $e$ is equivalent to the property extraction (\ref{propertyExtraction}) \THIS{}.$id$.
|
|
% This implies that referring to an undefined static getter by simple name is an error, whereas doing so by qualified name is only a warning. Same with assignments. Revise?
|
|
\end{itemize}
|
|
|
|
\LMHash{}
|
|
The static type of $e$ is determined as follows:
|
|
|
|
\begin{itemize}
|
|
\item If $d$ is a class, type alias or type parameter the static type of $e$ is \code{Type}.
|
|
\item If $d$ is a local variable or formal parameter the static type of $e$ is the type of the variable $id$, unless $id$ is known to have some type $T$, in which case the static type of $e$ is $T$, provided that $T$ is more specific than any other type $S$ such that $v$ is known to have type $S$.
|
|
\item If $d$ is a static method, top-level function or local function the static type of $e$ is the function type defined by $d$.
|
|
\item If $d$ is the declaration of a static variable, static getter or static setter declared in class $C$, the static type of $e$ is the static type of the getter invocation (\ref{propertyExtraction}) $C.id$.
|
|
\item If $d$ is the declaration of a library variable, top-level getter or top-level setter, the static type of $e$ is the static type of the top level getter invocation $id$.
|
|
\item Otherwise, if $e$ occurs inside a top level or static function (be it function, method, getter, or setter) or variable initializer, the static type of $e$ is \DYNAMIC{}.
|
|
\item Otherwise, the static type of $e$ is the type of the property extraction (\ref{propertyExtraction}) \THIS{}.$id$.
|
|
\end{itemize}
|
|
|
|
\commentary{Note that if one declares a setter, we bind to the corresponding getter even if it does not exist.}
|
|
|
|
\rationale{
|
|
This prevents situations where one uses uncorrelated setters and getters. The intent is to prevent errors when a getter in a surrounding scope is used accidentally.
|
|
}
|
|
|
|
\LMHash{}
|
|
It is a static warning if an identifier expression $id$ occurs inside a top level or static function (be it function, method, getter, or setter) or variable initializer and there is no declaration $d$ with name $id$ in the lexical scope enclosing the expression.
|
|
|
|
\subsection{ Type Test}
|
|
\LMLabel{typeTest}
|
|
|
|
\LMHash{}
|
|
The {\em is-expression} tests if an object is a member of a type.
|
|
|
|
\begin{grammar}
|
|
{\bf typeTest:}
|
|
isOperator type
|
|
.
|
|
|
|
|
|
{\bf isOperator:}
|
|
\IS{} `!'?
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
Evaluation of the is-expression \code{$e$ \IS{} $T$} proceeds as follows:
|
|
|
|
\LMHash{}
|
|
The expression $e$ is evaluated to a value $v$. Then, if $T$ is a malformed or deferred type (\ref{staticTypes}), a dynamic error occurs. Otherwise, if the interface of the class of $v$ is a subtype of $T$, the is-expression evaluates to \TRUE. Otherwise it evaluates to \FALSE.
|
|
|
|
\commentary{It follows that \code{$e$ \IS{} Object} is always true. This makes sense in a language where everything is an object.
|
|
|
|
Also note that \code{\NULL{} \IS{} $T$} is false unless $T = \code{Object}$, $T = \code{\DYNAMIC{}}$ or $T = \code{Null}$. The former two are useless, as is anything of the form \code{$e$ \IS{} Object} or \code{$e$ \IS{} \DYNAMIC{}}. Users should test for a null value directly rather than via type tests.
|
|
}
|
|
|
|
\LMHash{}
|
|
The is-expression \code{$e$ \IS{}! $T$} is equivalent to \code{!($e$ \IS{} $T$)}.
|
|
|
|
% Add flow dependent types
|
|
|
|
|
|
\LMHash{}
|
|
Let $v$ be a local variable or a formal parameter. An is-expression of the form \code{$v$ \IS{} $T$} shows that $v$ has type $T$ iff $T$ is more specific than the type $S$ of the expression $v$ and both $T \ne \DYNAMIC{}$ and $S \ne \DYNAMIC{}$.
|
|
|
|
\rationale{
|
|
The motivation for the ``shows that v has type T" relation is to reduce spurious warnings thereby enabling a more natural coding style.
|
|
The rules in the current specification are deliberately kept simple.
|
|
It would be upwardly compatible to refine these rules in the future; such a refinement would accept more code without warning, but not reject any code now warning-free.
|
|
|
|
The rule only applies to locals and parameters, as instance or static variables could be modified via side-effecting functions or methods that are not accessible to a local analysis.
|
|
|
|
It is pointless to deduce a weaker type than what is already known.
|
|
Furthermore, this would lead to a situation where multiple types are associated with a variable at a given point, which complicates the specification.
|
|
Hence the requirement that $T << S$ (we use $<<$ rather than subtyping because subtyping is not a partial order).
|
|
|
|
We do not want to refine the type of a variable of type \DYNAMIC{}, as this could lead to more warnings rather than fewer.
|
|
The opposite requirement, that $T \ne \DYNAMIC{}$ is a safeguard lest $S$ ever be $\bot$.
|
|
}
|
|
|
|
\LMHash{}
|
|
The static type of an is-expression is \code{bool}.
|
|
|
|
|
|
\subsection{ Type Cast}
|
|
\LMLabel{typeCast}
|
|
|
|
\LMHash{}
|
|
The {\em cast expression} ensures that an object is a member of a type.
|
|
|
|
\begin{grammar}
|
|
{\bf typeCast:}
|
|
asOperator type
|
|
.
|
|
|
|
|
|
{\bf asOperator:}
|
|
\AS{}
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
Evaluation of the cast expression \code{$e$ \AS{} $T$} proceeds as follows:
|
|
|
|
\LMHash{}
|
|
The expression $e$ is evaluated to a value $v$. Then, if $T$ is a malformed or deferred type (\ref{staticTypes}), a dynamic error occurs. Otherwise, if the interface of the class of $v$ is a subtype of $T$, the cast expression evaluates to $v$. Otherwise, if $v$ is \NULL{}, the cast expression evaluates to $v$.
|
|
In all other cases, a \code{CastError} is thrown.
|
|
|
|
\LMHash{}
|
|
The static type of a cast expression \code{$e$ \AS{} $T$} is $T$.
|
|
|
|
\section{Statements}
|
|
\LMLabel{statements}
|
|
|
|
\LMHash{}
|
|
A {\em statement} is a fragment of Dart code that can be executed at runtime. Statements, unlike expressions, do not evaluate to a value, but are instead executed for their effect on the program state and control flow.
|
|
|
|
\label{completion}
|
|
Execution of a statement {\em completes} in one of five ways: either it {\em completes normally}, it {\em breaks} or it {\em continues} (either to a label or without a label), it {\em returns} (with or without a value), or it {\em throws} an exception object and an associated stack trace.
|
|
|
|
In the description of statement execution, the default is that the execution
|
|
completes normally unless otherwise stated.
|
|
|
|
If the execution of a statement, $s$, is defined in terms of executing
|
|
another statement,
|
|
and the execution of that other statement does not complete normally,
|
|
then, unless otherwise stated, the execution of $s$ stops
|
|
at that point and completes in the same way.
|
|
\commentary{
|
|
For example, if execution of the body of a \DO{} loop returns a value, so does execution of the \DO{} loop statement itself.
|
|
}
|
|
|
|
If the execution of a statement is defined in terms of evaluating an expression
|
|
and the evaluation of that expression throws,
|
|
then, unless otherwise stated, the execution of the statement stops
|
|
at that point and throws the same exception object and stack trace.
|
|
\commentary{
|
|
For example, if evaluation of the condition expression of an \IF{} statement throws,
|
|
then so does execution of the \IF{} statement. Likewise, if evaluation of the expression of a \RETURN{} statement throws, so does execution of the \RETURN{} statement.
|
|
}
|
|
|
|
\LMHash{}
|
|
|
|
\begin{grammar}
|
|
{\bf statements:}
|
|
statement*
|
|
.
|
|
|
|
|
|
{\bf statement:}
|
|
label* nonLabelledStatement
|
|
.
|
|
|
|
{\bf nonLabelledStatement:}block;
|
|
localVariableDeclaration;
|
|
forStatement;
|
|
whileStatement;
|
|
doStatement;
|
|
switchStatement;
|
|
ifStatement;
|
|
rethrowStatement;
|
|
tryStatement;
|
|
breakStatement;
|
|
continueStatement;
|
|
returnStatement;
|
|
yieldStatement;
|
|
yieldEachStatement;
|
|
expressionStatement;
|
|
assertStatement;
|
|
localFunctionDeclaration
|
|
.
|
|
\end{grammar}
|
|
|
|
\subsection{Blocks}
|
|
\LMLabel{blocks}
|
|
|
|
\LMHash{}
|
|
A {\em block statement} supports sequencing of code.
|
|
|
|
\LMHash{}
|
|
Execution of a block statement $\{s_1, \ldots, s_n\}$ proceeds as follows:
|
|
|
|
\LMHash{}
|
|
For $i \in 1 .. n, s_i$ is executed.
|
|
|
|
\LMHash{}
|
|
A block statement introduces a new scope, which is nested in the lexically enclosing scope in which the block statement appears.
|
|
|
|
|
|
\subsection{Expression Statements}
|
|
\LMLabel{expressionStatements}
|
|
|
|
\LMHash{}
|
|
An {\em expression statement} consists of an expression other than a non-constant map literal (\ref{maps}) that has no explicit type arguments.
|
|
|
|
\rationale{
|
|
The restriction on maps is designed to resolve an ambiguity in the grammar, when a statement begins with \{.
|
|
}
|
|
|
|
\begin{grammar}
|
|
{\bf expressionStatement:}
|
|
expression? `{\escapegrammar ;}'
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
Execution of an expression statement \code{$e$;} proceeds by evaluating $e$.
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if a non-constant map literal that has no explicit type arguments appears in a place where a statement is expected.
|
|
|
|
\subsection{Local Variable Declaration}
|
|
\LMLabel{localVariableDeclaration}
|
|
|
|
|
|
\LMHash{}
|
|
A {\em variable declaration statement }declares a new local variable.
|
|
|
|
\begin{grammar}
|
|
{\bf localVariableDeclaration:}
|
|
initializedVariableDeclaration `{\escapegrammar ;}'
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
Executing a variable declaration statement of one of the forms \VAR{} $v = e;$, $T$ $v = e; $, \CONST{} $v = e;$, \CONST{} $T$ $v = e;$, \FINAL{} $v = e;$ or \FINAL{} $T$ $v = e;$ proceeds as follows:
|
|
|
|
\LMHash{}
|
|
The expression $e$ is evaluated to an object $o$. Then, the variable $v$ is set to $o$.
|
|
|
|
\LMHash{}
|
|
A variable declaration statement of the form \VAR{} $v;$ is equivalent to \VAR{} $v = \NULL{};$. A variable declaration statement of the form $T$ $v;$ is equivalent to $T$ $v = \NULL{};$.
|
|
|
|
\commentary{
|
|
This holds regardless of the type $T$. For example, \code{int i;} does not cause \code{i} to be initialized to zero. Instead, \code{i} is initialized to \NULL{}, just as if we had written \VAR{} \code{i;} or \code{Object i;} or \code{Collection<String> i;}.
|
|
}
|
|
|
|
\rationale{
|
|
To do otherwise would undermine the optionally typed nature of Dart, causing type annotations to modify program behavior.
|
|
}
|
|
|
|
%A variable declaration statement of one of the forms $T$ $v;$, $T$ $v = e;$, \CONST{} $T$ $v = e;$, or \FINAL{} $T$ $v = e;$ causes a new getter named $v$ with static return type $T$ to be added to the innermost enclosing scope at the point following the variable declaration statement. The result of executing this getter is the value stored in $v$.
|
|
|
|
%A variable declaration statement \VAR{} $v;$, \VAR{} $v = e;$, \CONST{} $v = e;$ or \FINAL{} $v = e;$ causes a new getter named $v$ with static return type \DYNAMIC{} to be added to the innermost enclosing scope at the point following the variable declaration statement. The result of executing this getter is the value stored in $v$.
|
|
|
|
%A variable declaration statement of one of the forms $T$ $v;$, or $T$ $v = e;$ causes a new setter named $v=$ with argument type $T$ to be added to the innermost enclosing scope at the point following the variable declaration statement. The effect of executing this setter is to store its argument in $v$.
|
|
|
|
%A variable declaration statement \VAR{} $v;$, \VAR{} $v = e;$, \CONST{} $v = e;$ or \FINAL{} $v = e;$ causes a new setter named $v=$ with argument type \DYNAMIC{} to be added to the innermost enclosing scope at the point following the variable declaration statement. The effect of executing this setter is to store its argument in $v$.
|
|
|
|
%\rationale{
|
|
%The use of getters and setters here is a device to help make the specification more uniform. Introducing getters and setters for local variables has no performance consequences, since they can never be overridden, and so can always be optimized away. It is not possible to declare a local getter or setter explicitly, since there is little reason to ever do so.
|
|
%}
|
|
|
|
|
|
\subsection{Local Function Declaration}
|
|
\LMLabel{localFunctionDeclaration}
|
|
|
|
\LMHash{}
|
|
A function declaration statement declares a new local function (\ref{functionDeclarations}).
|
|
|
|
\begin{grammar}
|
|
{\bf localFunctionDeclaration:}
|
|
functionSignature functionBody
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
A function declaration statement of one of the forms $id$ $signature$ $\{ statements \}$ or $T$ $id$ $signature$ $\{ statements \}$ causes a new function named $id$ to be added to the innermost enclosing scope. It is a compile-time error to reference a local function before its declaration.
|
|
|
|
|
|
\commentary{ This implies that local functions can be directly recursive, but not mutually recursive. Consider these examples:
|
|
}
|
|
|
|
\begin{dartCode}
|
|
f(x) => x++; // a top level function
|
|
top() \{ // another top level function
|
|
f(3); // illegal
|
|
f(x) => x > 0? x*f(x-1): 1; // recursion is legal
|
|
g1(x) => h(x, 1); // error: h is not declared yet
|
|
h(x, n) => x > 1? h(x-1, n*x): n; // again, recursion is fine
|
|
g2(x) => h(x, 1); // legal
|
|
|
|
p1(x) => q(x,x); // illegal
|
|
q1(a, b)$ =>$ a > 0 ? p1(a-1): b; // fine
|
|
|
|
q2(a, b) => a > 0 ? p2(a-1): b; // illegal
|
|
p1(x) => q2(x,x); // fine
|
|
\}
|
|
\end{dartCode}
|
|
|
|
\commentary{
|
|
There is no way to write a pair of mutually recursive local functions, because one always has to come before the other is declared. These cases are quite rare, and can always be managed by defining a pair of variables first, then assigning them appropriate closures:
|
|
}
|
|
|
|
\begin{dartCode}
|
|
top2() \{ // a top level function
|
|
\VAR{} p, q;
|
|
p = (x) => q(x,x);
|
|
q = (a, b) => a > 0 ? p(a-1): b;
|
|
|
|
\}
|
|
\end{dartCode}
|
|
|
|
\rationale{
|
|
The rules for local functions differ slightly from those for local variables in that a function can be accessed within its declaration but a variable can only be accessed after its declaration. This is because recursive functions are useful whereas recursively defined variables are almost always errors. It therefore makes sense to harmonize the rules for local functions with those for functions in general rather than with the rules for local variables.
|
|
}
|
|
|
|
% elaborate on function identity and equality, runtime type. Likewsie in function expressions (closures) and declarations
|
|
|
|
\subsection{If}
|
|
\LMLabel{if}
|
|
|
|
\LMHash{}
|
|
The {\em if statement} allows for conditional execution of statements.
|
|
|
|
\begin{grammar}
|
|
{\bf ifStatement:}
|
|
\IF{} `(' expression `)' statement ( \ELSE{} statement)?
|
|
.
|
|
\end{grammar}
|
|
|
|
Execution of an if statement of the form \code {\IF{} (}$b$\code{)}$s_1$ \code{\ELSE{} } $s_2$ proceeds as follows:
|
|
|
|
\LMHash{}
|
|
First, the expression $b$ is evaluated to an object $o$. Then, $o$ is subjected to boolean conversion (\ref{booleanConversion}), producing an object $r$. If $r$ is \TRUE{}, then the statement $\{s_1\}$ is executed, otherwise statement $\{s_2\}$ is executed.
|
|
|
|
\commentary {
|
|
Put another way, \code {\IF{} (}$b$\code{)}$s_1$ \code{\ELSE{} } $s_2$ is equivalent to
|
|
\code {\IF{} (}$b$\code{)}$\{s_1\}$ \code{\ELSE{} } $\{s_2\}$
|
|
}
|
|
|
|
\rationale {
|
|
The reason for this equivalence is to catch errors such as
|
|
}
|
|
\begin{dartCode}
|
|
\VOID{} main() \{
|
|
\IF{} (somePredicate)
|
|
\VAR{} v = 2;
|
|
print(v);
|
|
\}
|
|
\end{dartCode}
|
|
|
|
\rationale {
|
|
Under reasonable scope rules such code is problematic. If we assume that \code{v} is declared in the scope of the method \code{main()}, then when \code{somePredicate} is false, \code{v} will be uninitialized when accessed. The cleanest approach would be to require a block following the test, rather than an arbitrary statement. However, this goes against long standing custom, undermining Dart's goal of familiarity. Instead, we choose to insert a block, introducing a scope, around the statement following the predicate (and similarly for \ELSE{} and loops). This will cause both a warning and a runtime error in the case above. Of course, if there is a declaration of \code{v} in the surrounding scope, programmers might still be surprised. We expect tools to highlight cases of shadowing to help avoid such situations.
|
|
}
|
|
|
|
\LMHash{}
|
|
It is a static type warning if the type of the expression $b$ may not be assigned to \code{bool}.
|
|
|
|
\LMHash{}
|
|
If:
|
|
\begin{itemize}
|
|
\item $b$ shows that a variable $v$ has type $T$.
|
|
\item $v$ is not potentially mutated in $s_1$ or within a closure.
|
|
\item If the variable $v$ is accessed by a closure in $s_1$ then the variable $v$ is not potentially mutated anywhere in the scope of $v$.
|
|
\end{itemize}
|
|
then the type of $v$ is known to be $T$ in $s_1$.
|
|
|
|
\LMHash{}
|
|
An if statement of the form \code {\IF{} (}$b$\code{)}$s_1$ is equivalent to the if statement
|
|
|
|
\code {\IF{} (}$b$\code{)}$s_1$ \code{\ELSE{} \{\}}.
|
|
|
|
|
|
|
|
\subsection{For}
|
|
\LMLabel{for}
|
|
|
|
\LMHash{}
|
|
The {\em for statement} supports iteration.
|
|
|
|
\begin{grammar}
|
|
{\bf forStatement:}
|
|
\AWAIT? \FOR{} `(' forLoopParts `)' statement
|
|
.
|
|
|
|
{\bf forLoopParts:}forInitializerStatement expression? `{\escapegrammar ;}' expressionList?;
|
|
declaredIdentifier \IN{} expression;
|
|
identifier \IN{} expression
|
|
.
|
|
|
|
{\bf forInitializerStatement:}localVariableDeclaration;
|
|
expression? `{\escapegrammar ;}'
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
The for statement has three forms - the traditional for loop and two forms of the for-in statement - synchronous and asynchronous.
|
|
|
|
\subsubsection{For Loop}
|
|
\LMLabel{forLoop}
|
|
|
|
|
|
\LMHash{}
|
|
Execution of a for statement of the form \code{ \FOR{} (\VAR{} $v$ = $e_0$ ; $c$; $e$) $s$} proceeds as follows:
|
|
|
|
\LMHash{}
|
|
If $c$ is empty then let $c^\prime$ be \TRUE{} otherwise let $c^\prime$ be $c$.
|
|
|
|
\LMHash{}
|
|
First the variable declaration statement \VAR{} $v = e_0$ is executed. Then:
|
|
\begin{enumerate}
|
|
\item
|
|
\label{beginFor}
|
|
If this is the first iteration of the for loop, let $v^\prime$ be $v$. Otherwise, let $v^\prime$ be the variable $v^{\prime\prime}$ created in the previous execution of step \ref{allocateFreshVar}.
|
|
\item
|
|
The expression $[v^\prime/v]c$ is evaluated and subjected to boolean conversion (\ref{booleans}). If the result is \FALSE{}, the for loop completes normally. Otherwise, execution continues at step
|
|
\ref{beginIteration}.
|
|
\item
|
|
\label{beginIteration}
|
|
The statement $[v^\prime/v]\{s\}$ is executed.
|
|
|
|
If this execution completes normally, continues without a label,
|
|
or continues to a label (\ref{labels}) that prefixes this \FOR{} statement (\ref{completion}),
|
|
then execution of the statement is treated as if it had completed normally.
|
|
|
|
\label{allocateFreshVar}
|
|
Let $v^{\prime\prime}$ be a fresh variable. $v^{\prime\prime}$ is bound to the value of $v^\prime$.
|
|
\item
|
|
The expression $[v^{\prime\prime}/v]e$ is evaluated, and the process recurses at step
|
|
\ref{beginFor}.
|
|
\end{enumerate}
|
|
|
|
\rationale{
|
|
The definition above is intended to prevent the common error where users create a closure inside a for loop, intending to close over the current binding of the loop variable, and find (usually after a painful process of debugging and learning) that all the created closures have captured the same value - the one current in the last iteration executed.
|
|
|
|
Instead, each iteration has its own distinct variable. The first iteration uses the variable created by the initial declaration. The expression executed at the end of each iteration uses a fresh variable $v^{\prime\prime}$, bound to the value of the current iteration variable, and then modifies $v^{\prime\prime}$ as required for the next iteration.
|
|
}
|
|
|
|
\LMHash{}
|
|
It is a static warning if the static type of $c$ may not be assigned to \cd{bool}.
|
|
|
|
%A for statement of the form \code{ \FOR{} ($d$ ; $c$; $e$) $s$} is equivalent to the following code:
|
|
|
|
%\code{
|
|
%\{$d$;
|
|
%\WHILE{} ($c$) \{
|
|
% \{$s$\}
|
|
% $e$;
|
|
%\}\}
|
|
%}
|
|
|
|
%If $c$ is empty, it is interpreted as \TRUE{}.
|
|
|
|
\subsubsection{For-in}
|
|
\LMLabel{for-in}
|
|
|
|
\LMHash{}
|
|
A for statement of the form \code{ \FOR{} ($finalConstVarOrType?$ id \IN{} $e$) $s$} is equivalent to the following code:
|
|
|
|
\begin{dartCode}
|
|
var n0 = $e$.iterator;
|
|
\WHILE{} (n0.moveNext()) \{
|
|
$finalConstVarOrType?$ id = n0.current;
|
|
$s$
|
|
\}
|
|
\end{dartCode}
|
|
where \code{n0} is an identifier that does not occur anywhere in the program, except that for purposes of static typechecking, it is checked under the assumption that $n0$ is declared to be of type $T$, where $T$ is the static type of $e.iterator$.
|
|
|
|
\subsubsection{Asynchronous For-in}
|
|
\LMLabel{asynchronousFor-in}
|
|
|
|
\LMHash{}
|
|
A for-in statement may be asynchronous. The asynchronous form is designed to iterate over streams. An asynchronous for loop is distinguished by the keyword \AWAIT{} immediately preceding the keyword \FOR.
|
|
|
|
\LMHash{}
|
|
Execution of a for-in statement, $f$, of the form \code{\AWAIT{} \FOR{} (finalConstVarOrType? $id$ \IN{} $e$) $s$} proceeds as follows:
|
|
|
|
\LMHash{}
|
|
The expression $e$ is evaluated to an object $o$.
|
|
It is a dynamic error if $o$ is not an instance of a class that implements \code{Stream}.
|
|
|
|
\LMHash{}
|
|
The stream associated with the innermost enclosing asynchronous for loop, if any, is paused.
|
|
The stream $o$ is listened to, producing a stream subscription $u$,
|
|
and execution of the asynchronous for-in loop is suspended
|
|
until a stream event is available.
|
|
\commentary{
|
|
This allows other asynchronous events to execute while this loop is waiting for stream events.
|
|
}
|
|
|
|
Pausing an asynchronous for loop means pausing the associated stream subscription.
|
|
A stream subscription is paused by calling its \code{pause} method.
|
|
If the subscription is already paused, an implementation may omit further calls to \code{pause}.
|
|
|
|
\commentary{
|
|
The \code{pause} call can throw, although that should never happen for a correctly implemented stream.
|
|
}
|
|
|
|
\LMHash{}
|
|
For each {\em data event} from $u$,
|
|
the statement $s$ is executed with $id$ bound to the value of the current data event.
|
|
|
|
\LMHash{}
|
|
\commentary{
|
|
Either execution of $s$ is completely synchronous, or it contains an
|
|
asynchronous construct (\AWAIT{}, \AWAIT{} \FOR{}, \YIELD{} or \YIELD*)
|
|
which will pause the stream subscription of its surrounding asynchronous loop.
|
|
This ensures that no other event of $u$ occurs before execution of $s$ is complete, if $o$ is a correctly implemented stream.
|
|
If $o$ doesn't act as a valid stream, for example by not respecting pause requests, the behavior of the asynchronous loop may become unpredictable.
|
|
}
|
|
|
|
\LMHash{}
|
|
If execution of $s$ continues without a label, or to a label (\ref{labels}) that prefixes the asynchronous for statement (\ref{completion}), then the execution of $s$ is treated as if it had completed normally.
|
|
|
|
If execution of $s$ otherwise does not complete normally, the subscription $u$ is canceled by evaluating \code{\AWAIT{} $v$.cancel()} where $v$ is a fresh variable referencing the stream subscription $u$.
|
|
If that evaluation throws,
|
|
execution of $f$ throws the same exception and stack trace.
|
|
Otherwise execution of $f$ completes in the same way as the execution of $s$.
|
|
% Notice: The previous specification was unclear about what happened when
|
|
% a subscripton is canceled. This text is explicit, and existing
|
|
% implementations may not properly await the cancel call.
|
|
Otherwise the execution of $f$ is suspended again, waiting for the next stream subscription event, and $u$ is resumed if it has been paused.
|
|
\commentary{
|
|
The \code{resume} call can throw, in which case the asynchronous for
|
|
loop also throws. That should never happen for a correctly implemented stream.
|
|
}
|
|
|
|
\LMHash{}
|
|
On an {\em error event} from $u$,
|
|
with error object $e$ and stack trace $st$,
|
|
the subscription $u$ is canceled by evaluating \code{\AWAIT{} v.cancel()}
|
|
where $v$ is a fresh variable referencing the stream subscription $u$.
|
|
If that evaluation throws,
|
|
execution of $f$ throws the same exception object and stack trace.
|
|
Otherwise execution of $f$ throws with $e$ as exception object and $st$ as stack trace.
|
|
|
|
\LMHash{}
|
|
When $u$ is done, execution of $f$ completes normally.
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if an asynchronous for-in statement appears inside a synchronous function (\ref{functions}). It is a compile-time error if a traditional for loop (\ref{forLoop}) is prefixed by the \AWAIT{} keyword.
|
|
|
|
\rationale{An asynchronous loop would make no sense within a synchronous function, for the same reasons that an await expression makes no sense in a synchronous function.}
|
|
|
|
|
|
\subsection{While}
|
|
\LMLabel{while}
|
|
|
|
\LMHash{}
|
|
The while statement supports conditional iteration, where the condition is evaluated prior to the loop.
|
|
|
|
\begin{grammar}
|
|
{\bf whileStatement:}
|
|
\WHILE{} `(' expression `)' statement % could do top level here, and in for
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
Execution of a while statement of the form \code{\WHILE{} ($e$) $s$;} proceeds as follows:
|
|
|
|
\LMHash{}
|
|
The expression $e$ is evaluated to an object $o$. Then, $o$ is subjected to boolean conversion (\ref{booleanConversion}), producing an object $r$.
|
|
|
|
\LMHash{}
|
|
If $r$ is \FALSE{}, then execution of the while statement completes normally
|
|
(\ref{completion}).
|
|
|
|
\LMHash{}
|
|
Otherwise $r$ is \TRUE{} and then the statement $\{s\}$ is executed.
|
|
If that execution completes normally or it continues with no label or to a label (\ref{labels}) that prefixes the \WHILE{} statement (\ref{completion}), then the while statement is re-executed.
|
|
If the execution breaks without a label, execution of the while statement completes normally.
|
|
\commentary{
|
|
If the execution breaks with a label that prefixes the \WHILE{} statement,
|
|
it does end execution of the loop, but the break itself is handled by the surrounding labeled statement (\ref{labels}).
|
|
}
|
|
|
|
\LMHash{}
|
|
It is a static type warning if the static type of $e$ may not be assigned to \code{bool}.
|
|
|
|
|
|
\subsection{Do}
|
|
\LMLabel{do}
|
|
|
|
\LMHash{}
|
|
The do statement supports conditional iteration, where the condition is evaluated after the loop.
|
|
|
|
\begin{grammar}
|
|
{\bf doStatement:}
|
|
\DO{} statement \WHILE{} `(' expression `)' `{\escapegrammar ;}'% could do top level here
|
|
.
|
|
\end{grammar}
|
|
|
|
|
|
\LMHash{}
|
|
Execution of a do statement of the form \code{\DO{} $s$ \WHILE{} ($e$);} proceeds as follows:
|
|
|
|
\LMHash{}
|
|
The statement $\{s\}$ is executed.
|
|
If that execution continues with no label, or to a label (\ref{labels}) that prefixes the do statement (\ref{completion}), then the execution of $s$ is treated as if it had completed normally.
|
|
|
|
\LMHash{}
|
|
Then, the expression $e$ is evaluated to an object $o$. Then, $o$ is subjected to boolean conversion (\ref{booleanConversion}), producing an object $r$.
|
|
If $r$ is \FALSE{}, execution of the do statement completes normally (\ref{completion}).
|
|
If $r$ is \TRUE{}, then the do statement is re-executed.
|
|
|
|
\LMHash{}
|
|
It is a static type warning if the static type of $e$ may not be assigned to \code{bool}.
|
|
|
|
\subsection{Switch}
|
|
\LMLabel{switch}
|
|
|
|
\LMHash{}
|
|
The {\em switch statement} supports dispatching control among a large number of cases.
|
|
|
|
\begin{grammar}
|
|
{\bf switchStatement:}
|
|
\SWITCH{} `(' expression `)' `\{' switchCase* defaultCase? `\}'% could do top level here and in cases
|
|
.
|
|
|
|
|
|
{\bf switchCase:}
|
|
label* \CASE{} expression `{\escapegrammar :}' statements
|
|
.
|
|
|
|
{\bf defaultCase:}
|
|
label* \DEFAULT{} `{\escapegrammar :}' statements
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
Given a switch statement of the form
|
|
|
|
\begin{dartCode}
|
|
\SWITCH{} ($e$) \{
|
|
$label_{11} \ldots label_{1j_1}$ \CASE{} $e_1: s_1$
|
|
$\ldots$
|
|
$label_{n1} \ldots label_{nj_n}$ \CASE{} $e_n: s_n$
|
|
$label_{(n+1)1} \ldots label_{(n+1)j_{n+1}}$ \DEFAULT{}: $s_{n+1}$
|
|
\}
|
|
\end{dartCode}
|
|
|
|
or the form
|
|
|
|
\begin{dartCode}
|
|
\SWITCH{} ($e$) \{
|
|
$label_{11} \ldots label_{1j_1}$ \CASE{} $e_1: s_1$
|
|
$\ldots$
|
|
$label_{n1} \ldots label_{nj_n}$ \CASE{} $e_n: s_n$
|
|
\}
|
|
\end{dartCode}
|
|
|
|
it is a compile-time error if the expressions $e_k$ are not compile-time constants for all $k \in 1..n$. It is a compile-time error if the values of the expressions $e_k$ are not either:
|
|
\begin{itemize}
|
|
\item instances of the same class $C$, for all $k \in 1..n$, or
|
|
\item instances of a class that implements \cd{int}, for all $k \in 1..n$, or
|
|
\item instances of a class that implements \cd{String}, for all $k \in 1..n$.
|
|
\end{itemize}
|
|
|
|
\commentary{In other words, all the expressions in the cases evaluate to constants of the exact same user defined class or are of certain known types. Note that the values of the expressions are known at compile-time, and are independent of any static type annotations.
|
|
}
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if the class $C$ has an implementation of the operator $==$ other than the one inherited from \code{Object} unless the value of the expression is a string, an integer, literal symbol or the result of invoking a constant constructor of class \cd{Symbol}.
|
|
|
|
\rationale{
|
|
The prohibition on user defined equality allows us to implement the switch efficiently for user defined types. We could formulate matching in terms of identity instead with the same efficiency. However, if a type defines an equality operator, programmers would find it quite surprising that equal objects did not match.
|
|
|
|
}
|
|
|
|
\commentary{
|
|
The \SWITCH{} statement should only be used in very limited situations (e.g., interpreters or scanners).
|
|
}
|
|
|
|
\LMHash{}
|
|
Execution of a switch statement of the form
|
|
|
|
\begin{dartCode}
|
|
\SWITCH{} ($e$) \{
|
|
$label_{11} \ldots label_{1j_1}$ \CASE{} $e_1: s_1$
|
|
$\ldots$
|
|
$label_{n1} \ldots label_{nj_n}$ \CASE{} $e_n: s_n$
|
|
$label_{(n+1)1} \ldots label_{(n+1)j_{n+1}}$ \DEFAULT{}: $s_{n+1}$
|
|
\}
|
|
\end{dartCode}
|
|
|
|
or the form
|
|
|
|
\begin{dartCode}
|
|
\SWITCH{} ($e$) \{
|
|
$label_{11} \ldots label_{1j_1}$ \CASE{} $e_1: s_1$
|
|
$\ldots$
|
|
$label_{n1} \ldots label_{nj_n}$ \CASE{} $e_n: s_n$
|
|
\}
|
|
\end{dartCode}
|
|
|
|
proceeds as follows:
|
|
|
|
\LMHash{}
|
|
The statement \code{\VAR{} $id$ = $e$;} is evaluated, where $id$ is a fresh variable. In checked mode, it is a run time error if the value of $e$ is not an instance of the same class as the constants $e_1 \ldots e_n$.
|
|
|
|
\commentary{Note that if there are no case clauses ($n = 0$), the type of $e$ does not matter.}
|
|
|
|
\LMHash{}
|
|
Next, the case clause \CASE{} $e_{1}$: $s_{1}$ is matched against $id$, if $n > 0$. Otherwise if there is a \DEFAULT{} clause, the case statements $s_{n+1}$ are executed (\ref{case-execute}).
|
|
|
|
\LMHash{}
|
|
Matching of a \CASE{} clause \CASE{} $e_{k}: s_{k}$ of a switch statement
|
|
|
|
\begin{dartCode}
|
|
\SWITCH{} ($e$) \{
|
|
$label_{11} \ldots label_{1j_1}$ \CASE{} $e_1: s_1$
|
|
$\ldots$
|
|
$label_{n1} \ldots label_{nj_n}$ \CASE{} $e_n: s_n$
|
|
$label_{(n+1)1} \ldots label_{(n+1)j_{n+1}}$ \DEFAULT{}: $s_{n+1}$
|
|
\}
|
|
\end{dartCode}
|
|
|
|
against the value of a variable $id$ proceeds as follows:
|
|
|
|
\LMHash{}
|
|
The expression \code{$e_k$ == $id$} is evaluated to an object $o$ which is then subjected to boolean conversion evaluating to a value $v$.
|
|
If $v$ is not \TRUE{} the following case, \CASE{} $e_{k+1}: s_{k+1}$ is matched against $id$ if $k < n$. If $k = n$, then the \DEFAULT{} clause's statements are executed (\ref{case-execute}).
|
|
If $v$ is \TRUE{}, let $h$ be the smallest number such that $h \ge k$ and $s_h$ is non-empty. If no such $h$ exists, let $h = n + 1$. The case statements $s_h$ are then executed (\ref{case-execute}).
|
|
|
|
\LMHash{}
|
|
Matching of a \CASE{} clause \CASE{} $e_{k}: s_{k}$ of a switch statement
|
|
|
|
\begin{dartCode}
|
|
\SWITCH{} ($e$) \{
|
|
$label_{11} \ldots label_{1j_1}$ \CASE{} $e_1: s_1$
|
|
$\ldots$
|
|
$label_{n1} \ldots label_{nj_n}$ \CASE{} $e_n: s_n$
|
|
\}
|
|
\end{dartCode}
|
|
|
|
against the value of a variable $id$ proceeds as follows:
|
|
|
|
\LMHash{}
|
|
The expression \code{$e_k$ == $id$} is evaluated to an object $o$ which is then subjected to boolean conversion evaluating to a value $v$.
|
|
If $v$ is not \TRUE{} the following case, \CASE{} $e_{k+1}: s_{k+1}$ is matched against $id$ if $k < n$.
|
|
If $v$ is \TRUE{}, let $h$ be the smallest integer such that $h \ge k$ and $s_h$ is non-empty. If such a $h$ exists, the case statements $s_h$ are executed (\ref{case-execute}). Otherwise the switch statement completes normally (
|
|
ref{completion}).
|
|
|
|
|
|
\LMHash{}
|
|
It is a static warning if the type of $e$ may not be assigned to the type of $e_k$.
|
|
Let $s$ be the last statement of the statement sequence $s_k$.
|
|
If $s$ is a non-empty block statement, let $s$ instead be the last statement of the block statement.
|
|
It is a static warning $s$ is not a \BREAK{}, \CONTINUE{}, \RETHROW{} or \RETURN{} statement or an expression statement where the expression is a \THROW{} expression.
|
|
|
|
\rationale{
|
|
The behavior of switch cases intentionally differs from the C tradition. Implicit fall through is a known cause of programming errors and therefore disallowed. Why not simply break the flow implicitly at the end of every case, rather than requiring explicit code to do so? This would indeed be cleaner. It would also be cleaner to insist that each case have a single (possibly compound) statement. We have chosen not to do so in order to facilitate porting of switch statements from other languages. Implicitly breaking the control flow at the end of a case would silently alter the meaning of ported code that relied on fall-through, potentially forcing the programmer to deal with subtle bugs. Our design ensures that the difference is immediately brought to the coder's attention. The programmer will be notified at compile-time if they forget to end a case with a statement that terminates the straight-line control flow. We could make this warning a compile-time error, but refrain from doing so because do not wish to force the programmer to deal with this issue immediately while porting code. If developers ignore the warning and run their code, a run time error will prevent the program from misbehaving in hard-to-debug ways (at least with respect to this issue).
|
|
|
|
The sophistication of the analysis of fall-through is another issue. For now, we have opted for a very straightforward syntactic requirement. There are obviously situations where code does not fall through, and yet does not conform to these simple rules, e.g.:
|
|
}
|
|
|
|
\begin{dartCode}
|
|
\SWITCH{} (x) \{
|
|
\CASE{} 1: \TRY{} \{ $\ldots$ \RETURN{};\} \FINALLY{} \{ $\ldots$ \RETURN{};\}
|
|
\}
|
|
\end{dartCode}
|
|
|
|
\rationale{
|
|
Very elaborate code in a case clause is probably bad style in any case, and such code can always be refactored.
|
|
}
|
|
|
|
\LMHash{}
|
|
It is a static warning if all of the following conditions hold:
|
|
\begin{itemize}
|
|
\item The switch statement does not have a default clause.
|
|
\item The static type of $e$ is an enumerated typed with elements $id_1, \ldots, id_n$.
|
|
\item The sets $\{e_1, \ldots, e_k\} $ and $\{id_1, \ldots, id_n\}$ are not the same.
|
|
\end{itemize}
|
|
|
|
\commentary{
|
|
In other words, a warning will be issued if a switch statement over an enum is not exhaustive.
|
|
}
|
|
|
|
\LMHash{}
|
|
\subsubsection{Switch case statements}
|
|
\LMLabel{case-execute}
|
|
|
|
\LMHash{}
|
|
Execution of the case statements $s_h$ of a switch statement
|
|
|
|
\begin{dartCode}
|
|
\SWITCH{} ($e$) \{
|
|
$label_{11} \ldots label_{1j_1}$ \CASE{} $e_1: s_1$
|
|
$\ldots$
|
|
$label_{n1} \ldots label_{nj_n}$ \CASE{} $e_n: s_n$
|
|
\}
|
|
\end{dartCode}
|
|
|
|
or a switch statement
|
|
|
|
\begin{dartCode}
|
|
\SWITCH{} ($e$) \{
|
|
$label_{11} \ldots label_{1j_1}$ \CASE{} $e_1: s_1$
|
|
$\ldots$
|
|
$label_{n1} \ldots label_{nj_n}$ \CASE{} $e_n: s_n$
|
|
$label_{(n+1)1} \ldots label_{(n+1)j_{n+1}}$ \DEFAULT{}: $s_{n+1}$
|
|
\}
|
|
\end{dartCode}
|
|
|
|
proceeds as follows:
|
|
|
|
\LMHash{}
|
|
Execute $\{s_h\}$.
|
|
If this execution completes normally,
|
|
and if $s_h$ is not the statements of the last case of the switch
|
|
($h = n$ if there is no \DEFAULT{} clause,
|
|
$h = n+1$ if there is a \DEFAULT{} clause),
|
|
then the execution of the switch case throws an error.
|
|
Otherwise $s_h$ are the last statements of the switch case,
|
|
and execution of the switch case completes normally.
|
|
|
|
\commentary{
|
|
In other words, there is no implicit fall-through between non-empty cases. The last case in a switch (default or otherwise) can `fall-through' to the end of the statement.
|
|
}
|
|
|
|
If execution of $\{s_h\}$ breaks with no label (\ref{completion}), then the execution of the switch statement completes normally.
|
|
|
|
If execution of $\{s_h\}$ continues to a label (\ref{completion}), and the label is $label_{ij}$, where $1 \le i \le n+1$ if the \SWITCH{} statement has a \DEFAULT{}, or $1 \le i \le n$ if there is no \DEFAULT{}, and where $1 \le j \le j_{i}$, then
|
|
let $h$ be the smallest number such that $h \ge i$ and $s_h$ is non-empty. If no such $h$ exists, let $h = n + 1$ if the \SWITCH{} statement has a \DEFAULT{}, otherwise let $h = n$.
|
|
The case statements $s_h$ are then executed (\ref{case-execute}).
|
|
|
|
If execution of $\{s_h\}$ completes in any other way, execution of the \SWITCH{} statement completes in the same way.
|
|
|
|
|
|
\subsection{ Rethrow}
|
|
\LMLabel{rethrow}
|
|
|
|
|
|
\LMHash{}
|
|
The {\em rethrow statement} is used to re-throw an exception and its associated stack trace.
|
|
|
|
\begin{grammar}
|
|
{\bf rethrowStatement:}
|
|
\RETHROW{} `{\escapegrammar ;}'
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
Execution of a \code{\RETHROW{}} statement proceeds as follows:
|
|
|
|
\LMHash{}
|
|
Let $f$ be the immediately enclosing function, and let \code{\ON{} $T$ \CATCH{} ($p_1$, $p_2$)} be the immediately enclosing catch clause (\ref{try}).
|
|
|
|
\rationale{
|
|
A \RETHROW{} statement always appears inside a \CATCH{} clause, and any \CATCH{} clause is semantically equivalent to some \CATCH{} clause of the form \code{\ON{} $T$ \CATCH{} (p1, p2)}. So we can assume that the \RETHROW{} is enclosed in a \CATCH{} clause of that form.
|
|
}
|
|
|
|
\LMHash{}
|
|
The \RETHROW{} statement {\em throws} (\ref{completion}) with $p_1$ as the exception object and $p_2$ as the stack trace.
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if a \code{\RETHROW{}} statement is not enclosed within an \ON-\CATCH{} clause.
|
|
|
|
|
|
\subsection{ Try}
|
|
\LMLabel{try}
|
|
|
|
\LMHash{}
|
|
The try statement supports the definition of exception handling code in a structured way.
|
|
|
|
\begin{grammar}
|
|
{\bf tryStatement:}
|
|
\TRY{} block (onPart+ finallyPart? $|$ finallyPart)
|
|
.
|
|
|
|
{\bf onPart:}catchPart block;
|
|
\ON{} type catchPart? block
|
|
.
|
|
|
|
{\bf catchPart:}
|
|
\CATCH{} `(' identifier (`,' identifier)? `)'
|
|
.
|
|
|
|
{\bf finallyPart:}
|
|
\FINALLY{} block
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
A try statement consists of a block statement, followed by at least one of:
|
|
\begin{enumerate}
|
|
\item
|
|
A set of \ON{}-\CATCH{} clauses, each of which specifies (either explicitly or implicitly) the type of exception object to be handled, one or two exception parameters, and a block statement.
|
|
\item
|
|
A \FINALLY{} clause, which consists of a block statement.
|
|
\end{enumerate}
|
|
|
|
\rationale{
|
|
The syntax is designed to be upward compatible with existing Javascript programs. The \ON{} clause can be omitted, leaving what looks like a Javascript catch clause.
|
|
}
|
|
|
|
\LMHash{}
|
|
A try statement of the form \code{\TRY{} $s_1$ $on-catch_1 \ldots on-catch_n$;} is equivalent to the statement \code{\TRY{} $s_1$ $on-catch_1 \ldots on-catch_n$ \FINALLY{} $\{\}$}.
|
|
|
|
\LMHash{}
|
|
An \ON{}-\CATCH{} clause of the form \code{\ON{} $T$ \CATCH{} ($p_1$) $s$} is equivalent to an \ON{}-\CATCH{} clause \code{\ON{} $T$ \CATCH{} ($p_1$, $p_2$) $s$} where $p_2$ is a fresh identifier.
|
|
|
|
\LMHash{}
|
|
An \ON{}-\CATCH{} clause of the form \code{\ON{} $T$ $s$} is equivalent to an \ON{}-\CATCH{} clause \code{\ON{} $T$ \CATCH{} ($p_1$, $p_2$) $s$} where $p_1$ and $p_2$ are fresh identifiers.
|
|
|
|
\LMHash{}
|
|
An \ON{}-\CATCH{} clause of the form \code{\CATCH{} ($p$) $s$} is equivalent to an \ON{}-\CATCH{} clause \code{\ON{} \DYNAMIC{} \CATCH{} ($p$, $p_2$) $s$} where $p_2$ is a fresh identifier.
|
|
|
|
An \ON{}-\CATCH{} clause of the form \code{\CATCH{} ($p_1$, $p_2$) $s$} is equivalent to an \ON{}-\CATCH{} clause \code{\ON{} \DYNAMIC{} \CATCH{} ($p_1$, $p_2$) $s$}.
|
|
|
|
\LMHash{}
|
|
An \ON{}-\CATCH{} clause of the form \code{\ON{} $T$ \CATCH{} ($p_1$, $p_2$) $s$} introduces a new scope $CS$ in which final local variables specified by $p_1$ and $p_2$ are defined. The statement $s$ is enclosed within $CS$. The static type of $p_1$ is $T$ and the static type of $p_2$ is \code{StackTrace}.
|
|
|
|
\LMHash{}
|
|
Execution of a \TRY{} statement $s$ on the form:
|
|
\begin{dartCode}
|
|
\TRY{} $b$
|
|
\ON{} $T_1$ \CATCH{} ($e_1$, $t_1$) $c_1$
|
|
\ldots{}
|
|
\ON{} $T_n$ \CATCH{} ($e_n$, $t_n$) $c_n$
|
|
\FINALLY{} $f$
|
|
\end{dartCode}
|
|
proceeds as follows:
|
|
|
|
\LMHash{}
|
|
First $b$ is executed.
|
|
If execution of $b$ throws (\ref{completion}) with exception object $e$ and stack trace $t$, then $e$ and $t$ are matched against the \ON{}-\CATCH{} clauses to yield a new completion (\ref{on-catch}).
|
|
|
|
Then, even if execution of $b$ did not complete normally or matching against the \ON{}-\CATCH{} clauses did not complete normally, the $f$ block is executed.
|
|
|
|
If execution of $f$ does not complete normally,
|
|
execution of the \TRY{} statement completes in the same way.
|
|
Otherwise if execution of $b$ threw (\ref{completion}), the \TRY{} statement completes in the same way as the matching against the \ON{}-\CATCH{} clauses.
|
|
Otherwise the \TRY{} statement completes in the same way as the execution of $b$.
|
|
|
|
\LMHash{}
|
|
If $T_1$ is a malformed or deferred type (\ref{staticTypes}), then performing a match causes a run time error.
|
|
It is a static warning if $T_i$, $1 \le i \le n$ is a deferred or malformed type.
|
|
|
|
\subsubsection{\ON{}-\CATCH{} clauses}
|
|
\LMLabel{on-catch}
|
|
|
|
\LMHash{}
|
|
Matching an exception object $e$ and stack trace $t$ against a (potentially empty) sequence of \ON{}-\CATCH{} clauses on the form
|
|
\begin{dartCode}
|
|
\ON{} $T_1$ \CATCH{} ($e_1$, $st_1$) \{ $s_1$ \}
|
|
\ldots
|
|
\ON{} $T_n$ \CATCH{} ($e_n$, $st_n$) \{ $s_n$ \}
|
|
\end{dartCode}
|
|
proceeds as follows:
|
|
|
|
\LMHash{}
|
|
If there are no \ON{}-\CATCH{} clauses ($n = 0$), matching throws the exception object $e$ and stack trace $t$ (\ref{completion}).
|
|
|
|
\LMHash{}
|
|
Otherwise the exception is matched against the first clause.
|
|
|
|
\LMHash{}
|
|
Otherwise, if the type of $e$ is a subtype of $T_1$, then the first clause matches, and then $e_1$ is bound to the exception object $e$ and $t_1$ is bound to the stack trace $t$, and $s_1$ is executed in this scope.
|
|
The matching completes in the same way as this execution.
|
|
|
|
\LMHash{}
|
|
Otherwise, if the first clause did not match $e$, $e$ and $t$ are recursively matched against the remaining \ON{}-\CATCH{} clauses:
|
|
\begin{dartCode}
|
|
\ON{} $T_2$ \CATCH{} ($e_2$, $t_2$) \{ $s_2$ \}
|
|
\ldots
|
|
\ON{} $T_n$ \CATCH{} ($e_n$, $t_n$) \{ $s_n$ \}
|
|
\end{dartCode}
|
|
|
|
|
|
\subsection{ Return}
|
|
\LMLabel{return}
|
|
|
|
\LMHash{}
|
|
The {\em return statement} returns a result to the caller of a synchronous function, completes the future associated with an asynchronous function or terminates the stream or iterable associated with a generator (\ref{functions}).
|
|
|
|
|
|
\begin{grammar}
|
|
{\bf returnStatement:}
|
|
\RETURN{} expression? `{\escapegrammar ;}' % could do top level here
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
Executing a return statement \code{\RETURN{} $e$;} proceeds as follows:
|
|
|
|
\LMHash{}
|
|
First the expression $e$ is evaluated, producing an object $o$.
|
|
Then the return statement returns the value $o$ (\ref{completion}).
|
|
|
|
\LMHash{}
|
|
Let $T$ be the static type of $e$ and let $f$ be the immediately enclosing function.
|
|
|
|
\LMHash{}
|
|
It is a static type warning if the body of $f$ is marked \ASYNC{} and the type \code{Future<$flatten$(T)>} (\ref{functionExpressions}) may not be assigned to the declared return type of $f$. Otherwise, it is a static type warning if $T$ may not be assigned to the declared return type of $f$.
|
|
|
|
\LMHash{}
|
|
Let $S$ be the runtime type of $o$. In checked mode:
|
|
\begin{itemize}
|
|
\item If the body of $f$ is marked \ASYNC{} (\ref{functions})
|
|
it is a dynamic type error if $o$ is not \NULL{} (\ref{null}),
|
|
the actual return type (\ref{actualTypeOfADeclaration}) of $f$ is not \VOID,
|
|
and \code{Future<$flatten$(S)>} is not a subtype of the actual return type of $f$.
|
|
% TODO(lrn): The "void foo() async { return e }" case is somewhat speculative.
|
|
% When we disallow "return e" in a void function, we might also want to revisit
|
|
% this rule. Currently it also covers the "void foo() async => e;" case, which
|
|
% we might want to allow.
|
|
\item Otherwise, it is a dynamic type error if $o$ is not \NULL{},
|
|
the actual return type of $f$ is not \VOID{},
|
|
and the runtime type of $o$ is not a subtype of the actual return type of $f$.
|
|
\end{itemize}
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if a return statement of the form \code{\RETURN{} $e$;} appears in a generative constructor (\ref{generativeConstructors}).
|
|
|
|
\rationale{
|
|
It is quite easy to forget to add the factory prefix for a constructor, accidentally converting a factory into a generative constructor. The static checker may detect a type mismatch in some, but not all, of these cases. The rule above helps catch such errors, which can otherwise be very hard to recognize. There is no real downside to it, as returning a value from a generative constructor is meaningless.
|
|
}
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if a return statement of the form \code{\RETURN{} $e$;} appears in a generator function.
|
|
|
|
\rationale{
|
|
In the case of a generator function, the value returned by the function is the iterable or stream associated with it, and individual elements are added to that iterable using yield statements, and so returning a value makes no sense.
|
|
}
|
|
|
|
\LMHash{}
|
|
Let $f$ be the function immediately enclosing a return statement of the form \RETURN{}; It is a static warning $f$ is neither a generator nor a generative constructor and either:
|
|
\begin{itemize}
|
|
\item $f$ is synchronous and the return type of $f$ may not be assigned to \VOID{} (\ref{typeVoid}) or,
|
|
\item $f$ is asynchronous and the return type of $f$ may not be assigned to \code{Future<Null>}.
|
|
\end{itemize}
|
|
|
|
\commentary{
|
|
Hence, a static warning will not be issued if $f$ has no declared return type, since the return type would be \DYNAMIC{} and \DYNAMIC{} may be assigned to \VOID{} and to \code{Future<Null>}. However, any synchronous non-generator function that declares a return type must return an expression explicitly.
|
|
}
|
|
\rationale{This helps catch situations where users forget to return a value in a return statement.}
|
|
|
|
\rationale{ An asynchronous non-generator always returns a future of some sort. If no expression is given, the future will be completed with \NULL{} and this motivates the requirement above.} \commentary{Leaving the return type of a function marked \ASYNC{} blank will be interpreted as \DYNAMIC{} as always, and cause no type error. Using \code{Future} or \code{Future<Object>} is acceptable as well, but any other type will cause a warning, since \NULL{} has no subtypes.}
|
|
|
|
\LMHash{}
|
|
Executing a return statement with no expression, \code{\RETURN;} returns with no value (\ref{completion}).
|
|
|
|
|
|
\LMHash{}
|
|
It is a static warning if a function contains both one or more explicit return statements of the form \code{\RETURN;} and one or more return statements of the form \code{\RETURN{} $e$;}.
|
|
|
|
|
|
\subsection{ Labels}
|
|
\LMLabel{labels}
|
|
|
|
\LMHash{}
|
|
A {\em label} is an identifier followed by a colon. A {\em labeled statement} is a statement prefixed by a label $L$. A {\em labeled case clause} is a case clause within a switch statement (\ref{switch}) prefixed by a label $L$.
|
|
|
|
\rationale{The sole role of labels is to provide targets for the break (\ref{break}) and continue (\ref{continue}) statements.}
|
|
|
|
%\Q{Are labels in a separate namespace? Bug 49774299}
|
|
|
|
\begin{grammar}
|
|
{\bf label:}
|
|
identifier `{\escapegrammar :}'
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
Execution a labeled statement $s$, $label: s_l$, consists of executing $s_l$.
|
|
If execution of $s_l$ breaks to the label $label$ (\ref{completion}),
|
|
then execution of $s$ completes normally,
|
|
otherwise execution of $s$ completes in the same ways as the execution of $s_l$.
|
|
|
|
\LMHash{}
|
|
The namespace of labels is distinct from the one used for types, functions and variables.
|
|
|
|
\LMHash{}
|
|
The scope of a label that labels a statement $s$ is $s$. The scope of a label that labels a case clause of a switch statement $s$ is $s$.
|
|
|
|
\rationale{Labels should be avoided by programmers at all costs. The motivation for including labels in the language is primarily making Dart a better target for code generation.
|
|
}
|
|
|
|
|
|
\subsection{ Break}
|
|
\LMLabel{break}
|
|
|
|
\LMHash{}
|
|
The {\em break statement} consists of the reserved word \BREAK{} and an optional label (\ref{labels}).
|
|
|
|
\begin{grammar}
|
|
{\bf breakStatement:}
|
|
\BREAK{} identifier? `{\escapegrammar ;}'
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
Let $s_b$ be a \BREAK{} statement. If $s_b$ is of the form \code{\BREAK{} $L$;}, then let $s_E$ be the innermost labeled statement with label $L$ enclosing $s_b$. If $s_b$ is of the form \code{\BREAK{};}, then let $s_E$ be the innermost \DO{} (\ref{do}), \FOR{} (\ref{for}), \SWITCH{} (\ref{switch}) or \WHILE{} (\ref{while}) statement enclosing $s_b$. It is a compile-time error if no such statement $s_E$ exists within the innermost function in which $s_b$ occurs.
|
|
|
|
\LMHash{}
|
|
Execution of a \BREAK{} statement \code{\BREAK{} $L$;} breaks to the label $L$ (\ref{completion}).
|
|
|
|
Execution of a \BREAK{} statement \code{\BREAK{};} breaks without a label (\ref{completion}).
|
|
|
|
|
|
\subsection{ Continue}
|
|
\LMLabel{continue}
|
|
|
|
\LMHash{}
|
|
The {\em continue statement} consists of the reserved word \CONTINUE{} and an optional label (\ref{labels}).
|
|
|
|
\begin{grammar}
|
|
{\bf continueStatement:}
|
|
\CONTINUE{} identifier? `{\escapegrammar ;}'
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
Let $s_c$ be a \CONTINUE{} statement. If $s_c$ is of the form \code{\CONTINUE{} $L$;}, then let $s_E$ be the innermost labeled \DO{} (\ref{do}), \FOR{} (\ref{for}) or \WHILE{} (\ref{while}) statement or case clause with label $L$ enclosing $s_c$. If $s_c$ is of the form \code{\CONTINUE{};} then let $s_E$ be the innermost \DO{} (\ref{do}), \FOR{} (\ref{for}) or \WHILE{} (\ref{while}) statement enclosing $s_c$. It is a compile-time error if no such statement or case clause $s_E$ exists within the innermost function in which $s_c$ occurs.
|
|
|
|
Execution of a \CONTINUE{} statement \code{\CONTINUE{} $L$;} continues to the label $L$ (\ref{completion}).
|
|
|
|
Execution of a \CONTINUE{} statement \code{\CONTINUE{};} continues without a label (\ref{completion}).
|
|
|
|
|
|
\subsection{ Yield and Yield-Each}
|
|
\LMLabel{yieldAndYieldEach}
|
|
|
|
\subsubsection{ Yield}
|
|
\LMLabel{yield}
|
|
|
|
\LMHash{}
|
|
The {\em yield statement} adds an element to the result of a generator function (\ref{functions}).
|
|
|
|
\begin{grammar}
|
|
{\bf yieldStatement:}
|
|
\YIELD{} expression `{\escapegrammar ;}'
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
Execution of a statement $s$ of the form \code{\YIELD{} $e$;} proceeds as follows:
|
|
|
|
\LMHash{}
|
|
First, the expression $e$ is evaluated to an object $o$. If the enclosing function $m$ is marked \ASYNC* (\ref{functions}) and the stream $u$ associated with $m$ has been paused, then the nearest enclosing asynchronous for loop (\ref{asynchronousFor-in}), if any, is paused and execution of $m$ is suspended until $u$ is resumed or canceled.
|
|
|
|
\LMHash{}
|
|
Next, $o$ is added to the iterable or stream associated with the immediately enclosing function.
|
|
|
|
\LMHash{}
|
|
If the enclosing function $m$ is marked \ASYNC* and the stream $u$ associated with $m$ has been canceled, then the \YIELD{} statement returns without a value (\ref{completion}), otherwise it completes normally.
|
|
|
|
\rationale{
|
|
The stream associated with an asynchronous generator could be canceled by any code with a reference to that stream at any point where the generator was passivated. Such a cancellation constitutes an irretrievable error for the generator. At this point, the only plausible action for the generator is to clean up after itself via its \FINALLY{} clauses.
|
|
}
|
|
|
|
\LMHash{}
|
|
Otherwise, if the enclosing function $m$ is marked \ASYNC* (\ref{functions}) then the enclosing function may suspend, in which case the nearest enclosing asynchronous for loop (\ref{asynchronousFor-in}), if any, is paused first.
|
|
|
|
\rationale {
|
|
If a \YIELD{} occurred inside an infinite loop and the enclosing function never suspended, there might not be an opportunity for consumers of the enclosing stream to run and access the data in the stream. The stream might then accumulate an unbounded number of elements. Such a situation is untenable. Therefore, we allow the enclosing function to be suspended when a new value is added to its associated stream. However, it is not essential (and in fact, can be quite costly) to suspend the function on every \YIELD{}. The implementation is free to decide how often to suspend the enclosing function. The only requirement is that consumers are not blocked indefinitely.
|
|
}
|
|
|
|
|
|
\LMHash{}
|
|
If the enclosing function $m$ is marked \SYNC* (\ref{functions}) then:
|
|
\begin{itemize}
|
|
\item
|
|
Execution of the function $m$ immediately enclosing $s$ is suspended until the nullary method \code{moveNext()} is invoked upon the iterator used to initiate the current invocation of $m$.
|
|
\item
|
|
The current call to \code{moveNext()} returns \TRUE.
|
|
\end{itemize}
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if a yield statement appears in a function that is not a generator function.
|
|
|
|
\LMHash{}
|
|
Let $T$ be the static type of $e$ and let $f$ be the immediately enclosing function. It is a static type warning if either:
|
|
\begin{itemize}
|
|
\item
|
|
the body of $f$ is marked \ASYNC* and the type \code{Stream<T>} may not be assigned to the declared return type of $f$.
|
|
\item
|
|
the body of $f$ is marked \SYNC* and the type \code{Iterable<T>} may not be assigned to the declared return type of $f$.
|
|
\end{itemize}
|
|
|
|
|
|
\subsubsection{ Yield-Each}
|
|
\LMLabel{yieldEach}
|
|
|
|
\LMHash{}
|
|
The {\em yield-each statement} adds a series of values to the result of a generator function (\ref{functions}).
|
|
|
|
\begin{grammar}
|
|
{\bf yieldEachStatement:}
|
|
\YIELD* expression `{\escapegrammar ;}'
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
Execution of a statement $s$ of the form \code{\YIELD* $e$;} proceeds as follows:
|
|
|
|
\LMHash{}
|
|
First, the expression $e$ is evaluated to an object $o$.
|
|
|
|
\LMHash{}
|
|
If the immediately enclosing function $m$ is marked \SYNC* (\ref{functions}), then:
|
|
\begin{enumerate}
|
|
\item It is a dynamic error if the class of $o$ does not implement \code{Iterable}. Otherwise
|
|
\item The method \cd{iterator} is invoked upon $o$ returning an object $i$.
|
|
\item \label{moveNext} The \cd{moveNext} method of $i$ is invoked on it with no arguments. If \cd{moveNext} returns \FALSE{} execution of $s$ is complete. Otherwise
|
|
\item The getter \cd{current} is invoked on $i$. If the invocation throws (\ref{evaluation}), execution of $s$ throws the same exception object and stack trace (\ref{completion}). Otherwise, the result $x$ of the getter invocation is added to the iterable associated with $m$.
|
|
Execution of the function $m$ immediately enclosing $s$ is suspended until the nullary method \code{moveNext()} is invoked upon the iterator used to initiate the current invocation of $m$, at which point execution of $s$ continues at \ref{moveNext}.
|
|
\item
|
|
The current call to \code{moveNext()} returns \TRUE.
|
|
\end{enumerate}
|
|
|
|
\LMHash{}
|
|
If $m$ is marked \ASYNC* (\ref{functions}), then:
|
|
\begin{itemize}
|
|
\item It is a dynamic error if the class of $o$ does not implement \code{Stream}. Otherwise
|
|
\item The nearest enclosing asynchronous for loop (\ref{asynchronousFor-in}), if any, is paused.
|
|
\item The $o$ stream is listened to, creating a subscription $s$, and for each event $x$, or error $e$ with stack trace $t$, of $s$:
|
|
\begin{itemize}
|
|
\item
|
|
If the stream $u$ associated with $m$ has been paused, then execution of $m$ is suspended until $u$ is resumed or canceled.
|
|
\item
|
|
If the stream $u$ associated with $m$ has been canceled,
|
|
then $s$ is canceled by evaluating \code{\AWAIT{} v.cancel()} where $v$ is a fresh variable referencing the stream subscription $s$.
|
|
Then, if the cancel completed normally, the stream execution of $s$ returns without a value (\ref{completion}).
|
|
\item
|
|
Otherwise, $x$, or $e$ with $t$, are added to the stream associated with $m$ in the order they appear in $o$. The function $m$ may suspend.
|
|
\end{itemize}
|
|
\item If the stream $o$ is done, execution of $s$ completes normally.
|
|
\end{itemize}
|
|
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if a yield-each statement appears in a function that is not a generator function.
|
|
|
|
\LMHash{}
|
|
Let $T$ be the static type of $e$ and let $f$ be the immediately enclosing function. It is a static type warning if $T$ may not be assigned to the declared return type of $f$. If $f$ is synchronous it is a static type warning if $T$ may not be assigned to \code{Iterable}. If $f$ is asynchronous it is a static type warning if $T$ may not be assigned to \code{Stream}.
|
|
|
|
|
|
\subsection{ Assert}
|
|
\LMLabel{assert}
|
|
|
|
\LMHash{}
|
|
An {\em assert statement} is used to disrupt normal execution if a given boolean condition does not hold.
|
|
|
|
\begin{grammar}
|
|
{\bf assertStatement:}
|
|
assert `(' expression ( `,` expression )? `)' `{\escapegrammar ;}'
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
An assert statement on the form \code{\ASSERT($e$);)} is equivalent to a statment on the form \code{\ASSERT($e$, null);}.
|
|
|
|
\LMHash{}
|
|
The assert statement has no effect in production mode. In checked mode, execution of an assert statement \code{\ASSERT{}($c$, $e$);} proceeds as follows:
|
|
|
|
\LMHash{}
|
|
The expression $c$ is evaluated to an object $o$. If the class of $o$ is a subtype of \code{Function} then let $r$ be the result of invoking $o$ with no arguments. Otherwise, let $r$ be $o$.
|
|
It is a dynamic type error if $o$ is not of type \code{bool} or of type \code{Function}, or if $r$ is not of type \code{bool}.
|
|
If $r$ is \FALSE{}, we say that the assertion failed.
|
|
If $r$ is \TRUE{}, we say that the assertion succeeded.
|
|
If the assertion succeeded, execution of the assert statement completes normally (\ref{completion}).
|
|
If the assertion failed, $e$ is evaluated to an object $m$.
|
|
Then the execution of the assert statement throws (\ref{completion}) an \code{AssertionError} containing $m$ and with a stack trace corresponding to the current execution state at the \ASSERT{} statement.
|
|
|
|
\LMHash{}
|
|
It is a static type warning if the type of $e$ may not be assigned to either \code{bool} or $() \rightarrow$ \code{bool}.
|
|
|
|
\rationale{Why is this a statement, not a built in function call? Because it is handled magically so it has no effect and no overhead in production mode. Also, in the absence of final methods. one could not prevent it being overridden (though there is no real harm in that). It cannot be viewed as a function call that is being optimized away because the argument might have side effects.
|
|
}
|
|
|
|
%If a lexically visible declaration named \code{assert} is in scope, an assert statement
|
|
%\code{\ASSERT{} (e); }
|
|
%is interpreted as an expression statement \code{(assert(e));} .
|
|
|
|
%\rationale{
|
|
%Since \ASSERT{} is a built-in identifier, one might define a function or method with this name.
|
|
%It is impossible to distinguish as \ASSERT{} statement from a method invocation in such a situation.
|
|
%One could choose to always interpret such code as an \ASSERT{} statement. Or we could choose to give priority to any lexically visible user defined function. The former can cause rather puzzling situations, e.g.,}
|
|
|
|
%\begin{dartCode}
|
|
% assert(bool b)\{print('My Personal Assertion \$b');\}
|
|
|
|
% assert\_puzzler() \{
|
|
% (assert(\TRUE{})); // prints true
|
|
% assert(\TRUE{}); // would do nothing
|
|
% (assert(\FALSE{})); // prints false
|
|
% assert(\FALSE{}); // would throw if asserts enabled, or do nothing otherwise
|
|
% \}
|
|
|
|
%\end{dartCode}
|
|
|
|
%\rationale{therefore, we opt for the second option. Alternately, one could insist that assert be a reserved word, which may have an undesirable effect with respect to compatibility of Javascript code ported to Dart.}
|
|
|
|
\section{Libraries and Scripts}
|
|
\LMLabel{librariesAndScripts}
|
|
|
|
\LMHash{}
|
|
A Dart program consists of one or more libraries, and may be built out of one or more {\em compilation units}. A compilation unit may be a library or a part (\ref{parts}).
|
|
|
|
\LMHash{}
|
|
A library consists of (a possibly empty) set of imports, a set of exports, and a set of top-level declarations. A top-level declaration is either a class (\ref{classes}), a type alias declaration (\ref{typedef}), a function (\ref{functions}) or a variable declaration (\ref{variables}). The members of a library $L$ are those top level declarations given within $L$.
|
|
|
|
\begin{grammar}
|
|
{\bf topLevelDefinition:}classDefinition;
|
|
enumType;
|
|
% classDefinitionOrInterfaceInjection;
|
|
% interfaceDefinitionOrInterfaceInjection;
|
|
% mixinApplication;
|
|
typeAlias;
|
|
\EXTERNAL{}? functionSignature `{\escapegrammar ;}';
|
|
\EXTERNAL{}? getterSignature `{\escapegrammar ;}';
|
|
\EXTERNAL{}? setterSignature `{\escapegrammar ;}';
|
|
functionSignature functionBody;
|
|
returnType? \GET{} identifier functionBody;
|
|
returnType? \SET{} identifier formalParameterList functionBody;
|
|
(\FINAL{} $|$ \CONST{}) type? staticFinalDeclarationList `{\escapegrammar ;}';
|
|
variableDeclaration `{\escapegrammar ;}'
|
|
.
|
|
|
|
{\bf getOrSet:} \GET{};
|
|
\SET{}
|
|
.
|
|
|
|
% classDefinitionOrInterfaceInjection:
|
|
% classDefinition;
|
|
% classInterfaceInjection
|
|
% .
|
|
|
|
%interfaceDefinitionOrInterfaceInjection:
|
|
% interfaceDefinition;
|
|
% interfaceInterfaceInjection
|
|
% .
|
|
|
|
{\bf libraryDefinition:}
|
|
% library '\{' libraryBody '\}'
|
|
scriptTag? libraryName? importOrExport* partDirective* topLevelDefinition*
|
|
.
|
|
|
|
{\bf scriptTag:}
|
|
`\#!' {\escapegrammar (\~{}NEWLINE)*} NEWLINE
|
|
.
|
|
|
|
{\bf libraryName:}
|
|
metadata \LIBRARY{} identifier (`{\escapegrammar .}' identifier)* `{\escapegrammar ;}'
|
|
.
|
|
|
|
{\bf importOrExport:}libraryImport ;
|
|
libraryExport
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
Libraries may be {\em explicitly named} or {\em implicitly named}. An explicitly named library begins with the word \LIBRARY{} (possibly prefaced with any applicable metadata annotations), followed by a qualified identifier that gives the name of the library.
|
|
|
|
\commentary{
|
|
Technically, each dot and identifier is a separate token and so spaces between them are acceptable. However, the actual library name is the concatenation of the simple identifiers and dots and contains no spaces.
|
|
}
|
|
|
|
\LMHash{}
|
|
An implicitly named library has the empty string as its name.
|
|
|
|
\rationale{
|
|
The name of a library is used to tie it to separately compiled parts of the library (called parts) and can be used for printing and, more generally, reflection. The name may be relevant for further language evolution.
|
|
}
|
|
|
|
\commentary{
|
|
Libraries intended for widespread use should avoid name collisions. Dart's \code{pub} package management system provides a mechanism for doing so. Each pub package is guaranteed a unique name, effectively enforcing a global namespace.
|
|
}
|
|
|
|
\LMHash{}
|
|
A library may optionally begin with a {\em script tag}. Script tags are intended for use with scripts (\ref{scripts}). A script tag can be used to identify the interpreter of the script to whatever computing environment the script is embedded in. The script tag must appear before any whitespace or comments. A script tag begins with the characters \#! and ends at the end of the line. Any characters that follow \#! in the script tag are ignored by the Dart implementation.
|
|
|
|
\LMHash{}
|
|
Libraries are units of privacy. A private declaration declared within a library $L$ can only be accessed by code within $L$. Any attempt to access a private member declaration from outside $L$ will cause a method, getter or setter lookup failure.
|
|
|
|
\commentary{Since top level privates are not imported, using the top level privates of another library is never possible. }
|
|
|
|
\LMHash{}
|
|
The {\em public namespace} of library $L$ is the mapping that maps the simple name of each public top-level member $m$ of $L$ to $m$.
|
|
The scope of a library $L$ consists of the names introduced by all top-level declarations declared in $L$, and the names added by $L$'s imports (\ref{imports}).
|
|
|
|
|
|
\subsection{Imports}
|
|
\LMLabel{imports}
|
|
|
|
\LMHash{}
|
|
An {\em import} specifies a library to be used in the scope of another library.
|
|
\begin{grammar}
|
|
{\bf libraryImport:}
|
|
metadata importSpecification
|
|
.
|
|
|
|
{\bf importSpecification:}
|
|
\IMPORT{} uri (\AS{} identifier)? combinator* `{\escapegrammar ;}';
|
|
\IMPORT{} uri \DEFERRED{} \AS{} identifier combinator* `{\escapegrammar ;}'
|
|
.
|
|
|
|
{\bf combinator:}\SHOW{} identifierList;
|
|
\HIDE{} identifierList
|
|
.
|
|
|
|
{\bf identifierList:}
|
|
identifier (, identifier)*
|
|
\end{grammar}
|
|
|
|
|
|
\LMHash{}
|
|
An import specifies a URI $x$ where the declaration of an imported library is to be found.
|
|
|
|
\LMHash{}
|
|
Imports may be {\em deferred} or {\em immediate}. A deferred import is distinguished by the appearance of the built-in identifier \DEFERRED{} after the URI. Any import that is not deferred is immediate.
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if the specified URI of an immediate import does not refer to a library declaration. The interpretation of URIs is described in section \ref{uris} below.
|
|
|
|
\LMHash{}
|
|
It is a static warning if the specified URI of a deferred import does not refer to a library declaration.
|
|
|
|
\rationale{
|
|
One cannot detect the problem at compile time because compilation often occurs during execution and one does not know what the URI refers to. However the development environment should detect the problem.
|
|
}
|
|
|
|
|
|
\LMHash{}
|
|
The {\em current library} is the library currently being compiled. The import modifies the namespace of the current library in a manner that is determined by the imported library and by the optional elements of the import.
|
|
|
|
\LMHash{}
|
|
An immediate import directive $I$ may optionally include a prefix clause of the form \code{\AS{} $id$} used to prefix names imported by $I$. A deferred import must include a prefix clause or a compile time error occurs. It is a compile-time error if a prefix used in a deferred import is used in another import clause.
|
|
|
|
\LMHash{}
|
|
An import directive $I$ may optionally include a namespace combinator clauses used to restrict the set of names imported by $I$. Currently, two namespace combinators are supported: \HIDE{} and \SHOW{}.
|
|
|
|
\LMHash{}
|
|
Let $I$ be an import directive that refers to a URI via the string $s_1$. Evaluation of $I$ proceeds as follows:
|
|
|
|
\LMHash{}
|
|
If $I$ is a deferred import, no evaluation takes place. Instead, a mapping of the name of the prefix, $p$ to a {\em deferred prefix object} is added to the scope of the current library $L$.
|
|
The deferred prefix object has the following methods:
|
|
|
|
\begin{itemize}
|
|
\item \code{loadLibrary}. This method returns a future $f$. When called, the method causes an immediate import $I'$ to be executed at some future time, where $I'$ is derived from $I$ by eliding the word \DEFERRED{} and adding a \HIDE{} \code{loadLibrary} combinator clause. When $I'$ executes without error, $f$ completes successfully. If $I'$ executes without error, we say that the call to \code{loadLibrary} has succeeded, otherwise we say the call has failed.
|
|
\item For every top level function $f$ named $id$ in the imported library $B$, a corresponding method named $id$ with the same signature as $f$. Calling the method results in a runtime error.
|
|
\item For every top level getter $g$ named $id$ in $B$, a corresponding getter named $id$ with the same signature as $g$. Calling the method results in a runtime error.
|
|
\item For every top level setter $s$ named $id$ in $B$, a corresponding setter named $id$ with the same signature as $s$. Calling the method results in a runtime error.
|
|
\item For every type $T$ named $id$ in $B$, a corresponding getter named $id$ with return type \code{Type}. Calling the method results in a runtime error.
|
|
\end{itemize}
|
|
|
|
\rationale {
|
|
The purpose of adding members of $B$ to $p$ is to ensure that any warnings issued when using $p$ are correct, and no spurious warnings are generated. In fact, at runtime we cannot add these members until $B$ is loaded; but any such invocations will fail at runtime as specified by virtue of being completely absent.
|
|
}
|
|
%But this is still a lie detectable by reflection. Probably revise so the type of p has these members but p does not.
|
|
|
|
The static type of the prefix object $p$ is a unique interface type that has those members whose names and signatures are listed above.
|
|
|
|
\LMHash{}
|
|
After a call succeeds, the name $p$ is mapped to a non-deferred prefix object as described below. In addition, the prefix object also supports the \code{loadLibrary} method, and so it is possible to call \code{loadLibrary} again. If a call fails, nothing happens, and one again has the option to call \code{loadLibrary} again. Whether a repeated call to \code{loadLibrary} succeeds will vary as described below.
|
|
|
|
\LMHash{}
|
|
The effect of a repeated call to \code{$p$.loadLibrary} is as follows:
|
|
\begin{itemize}
|
|
\item
|
|
If another call to \code{$p$.loadLibrary} has already succeeded, the repeated call also succeeds.
|
|
Otherwise,
|
|
\item
|
|
If another call to to \code{$p$.loadLibrary} has failed:
|
|
\begin{itemize}
|
|
\item
|
|
If the failure is due to a compilation error, the repeated call fails for the same reason.
|
|
\item
|
|
If the failure is due to other causes, the repeated call behaves as if no previous call had been made.
|
|
\end{itemize}
|
|
\end{itemize}
|
|
|
|
\commentary{
|
|
In other words, one can retry a deferred load after a network failure or because a file is absent, but once one finds some content and loads it, one can no longer reload.
|
|
|
|
We do not specify what value the future returned resolves to.
|
|
}
|
|
|
|
\LMHash{}
|
|
If $I$ is an immediate import then, first
|
|
|
|
\begin{itemize}
|
|
\item
|
|
If the URI that is the value of $s_1$ has not yet been accessed by an import or export (\ref{exports}) directive in the current isolate then the contents of the URI are compiled to yield a library $B$. \commentary{Because libraries may have mutually recursive imports, care must be taken to avoid an infinite regress.
|
|
}
|
|
\item Otherwise, the contents of the URI denoted by $s_1$ have been compiled into a library $B$ within the current isolate.
|
|
\end{itemize}
|
|
|
|
|
|
\LMHash{}
|
|
Let $NS_0$ be the exported namespace (\ref{exports}) of $B$. Then, for each combinator clause $C_i, i \in 1..n$ in $I$:
|
|
\begin{itemize}
|
|
\item If $C_i$ is of the form
|
|
|
|
\code{\SHOW{} $id_1, \ldots, id_k$}
|
|
|
|
then let $NS_i = \SHOW{}([id_1, \ldots, id_k], NS_{i-1}$)
|
|
|
|
where $show(l,n)$ takes a list of identifiers $l$ and a namespace $n$, and produces a namespace that maps each name in $l$ to the same element that $n$ does. Furthermore, for each name $x$ in $l$, if $n$ defines the name $x=$ then the new namespace maps $x=$ to the same element that $n$ does. Otherwise the resulting mapping is undefined.
|
|
|
|
\item If $C_i$ is of the form
|
|
|
|
\code{\HIDE{} $id_1, \ldots, id_k$}
|
|
|
|
then let $NS_i = \HIDE{}([id_1, \ldots, id_k], NS_{i-1}$)
|
|
|
|
where $hide(l, n)$ takes a list of identifiers $l$ and a namespace $n$, and produces a namespace that is identical to $n$ except that for each name $k$ in $l$, $k$ and $k=$ are undefined.
|
|
\end{itemize}
|
|
|
|
\LMHash{}
|
|
Next, if $I$ includes a prefix clause of the form \AS{} $p$, let $NS = NS_n \cup \{p: prefixObject(NS_n)\}$ where $prefixObject(NS_n)$ is a {\em prefix object} for the namespace $NS_n$, which is an object that has the following members:
|
|
|
|
\begin{itemize}
|
|
\item For every top level function $f$ named $id$ in $NS_n$, a corresponding method with the same name and signature as $f$ that forwards (\ref{functionDeclarations}) to $f$.
|
|
\item For every top level getter with the same name and signature as $g$ named $id$ in $NS_n$, a corresponding getter that forwards to $g$.
|
|
\item For every top level setter $s$ with the same name and signature as named $id$ in $NS_n$, a corresponding setter that forwards to $s$.
|
|
\item For every type $T$ named $id$ in $NS_n$, a corresponding getter named $id$ with return type \code{Type}, that, when invoked, returns the type object for $T$.
|
|
\end{itemize}
|
|
|
|
\LMHash{}
|
|
Otherwise, let $NS = NS_n$.
|
|
It is a compile-time error if the current library declares a top-level member named $p$.
|
|
|
|
The static type of the prefix object $p$ is a unique interface type that has those members whose names and signatures are listed above.
|
|
% What is the static type of a prefix object. Need to state that is a(n anonymous) type that has members with the same names as signatures as above.
|
|
|
|
% This is problematic, because it implies that p.T would be available even in a scope that declared p. We really need to think of p as a single object with properties p.T etc., except it isn't really that
|
|
% either. After all, p isn't actually available as a stand alone name.
|
|
|
|
\LMHash{}
|
|
Then, for each entry mapping key $k$ to declaration $d$ in $NS$, $d$ is made available in the top level scope of $L$ under the name $k$ unless either:
|
|
\begin{itemize}
|
|
\item
|
|
a top-level declaration with the name $k$ exists in $L$, OR
|
|
\item a prefix clause of the form \AS{} $k$ is used in $L$.
|
|
\end{itemize}
|
|
|
|
\rationale{The greatly increases the chance that a member can be added to a library without breaking its importers.}
|
|
|
|
\LMHash{}
|
|
A {\em system library} is a library that is part of the Dart implementation. Any other library is a {\em non-system library}. If a name $N$ is referenced by a library $L$ and $N$ would be introduced into the top level scope of $L$ by
|
|
imports of two libraries, $L_1$ and $L_2$, and the exported namespace of $L_1$ binds $N$ to a declaration originating in a system library:
|
|
|
|
%an import of a system library and an import of a non-system library:
|
|
\begin{itemize}
|
|
\item The import of $L_1$ is implicitly extended by a \code{\HIDE{} $N$} clause.
|
|
\item A static warning is issued.
|
|
\end{itemize}
|
|
|
|
\rationale {
|
|
Whereas normal conflicts are resolved at deployment time, the functionality of \code{dart:} libraries is injected into an application at run time, and may vary over time as browsers are upgraded. Thus, conflicts with \code{dart:} libraries can arise at runtime, outside the developer's control. To avoid breaking deployed applications in this way, conflicts with the \code{dart:} libraries are treated specially.
|
|
|
|
It is recommended that tools that deploy Dart code produce output in which all imports use show clauses to ensure that additions to the namespace of a library never impact deployed code.
|
|
}
|
|
|
|
\LMHash{}
|
|
If a name $N$ is referenced by a library $L$ and $N$ is introduced into the top level scope of $L$ by more than one import, and not all the imports denote the same declaration, then:
|
|
\begin{itemize}
|
|
\item A static warning occurs.
|
|
\item If $N$ is referenced as a function, getter or setter, a \code{NoSuchMethodError} is thrown.
|
|
\item If $N$ is referenced as a type, it is treated as a malformed type.
|
|
|
|
\end{itemize}
|
|
|
|
\LMHash{}
|
|
We say that the namespace $NS$ {\em has been imported into} $L$.
|
|
|
|
\commentary{
|
|
It is neither an error nor a warning if $N$ is introduced by two or more imports but never referred to.
|
|
}
|
|
|
|
\rationale{
|
|
The policy above makes libraries more robust in the face of additions made to their imports.
|
|
|
|
A clear distinction needs to be made between this approach, and seemingly similar policies with respect to classes or interfaces. The use of a class or interface, and of its members, is separate from its declaration. The usage and declaration may occur in widely separated places in the code, and may in fact be authored by different people or organizations. It is important that errors are given at the offending declaration so that the party that receives the error can respond to it a meaningful way.
|
|
|
|
In contrast a library comprises both imports and their usage; the library is under the control of a single party and so any problem stemming from the import can be resolved even if it is reported at the use site.
|
|
|
|
%On a related note, the provenance of the conflicting elements is not considered. An element that is imported via distinct paths may conflict with itself. This avoids variants of the well known "diamond" problem.
|
|
}
|
|
|
|
\LMHash{}
|
|
It is a static warning to import two different libraries with the same name unless their name is the empty string.
|
|
|
|
\commentary{
|
|
A widely disseminated library should be given a name that will not conflict with other such libraries. The preferred mechanism for this is using pub, the Dart package manager, which provides a global namespace for libraries, and conventions that leverage that namespace.
|
|
}
|
|
|
|
\commentary{Note that no errors or warnings are given if one hides or shows a name that is not in a namespace.}
|
|
\rationale{
|
|
This prevents situations where removing a name from a library would cause breakage of a client library.
|
|
}
|
|
|
|
\LMHash{}
|
|
The dart core library \code{dart:core} is implicitly imported into every dart library other than itself via an import clause of the form
|
|
|
|
\code{\IMPORT{} `dart:core';}
|
|
|
|
unless the importing library explicitly imports \code{dart:core}.
|
|
|
|
\commentary{
|
|
Any import of \code{dart:core}, even if restricted via \SHOW{}, \HIDE{} or \AS{}, preempts the automatic import.
|
|
}
|
|
|
|
\rationale{
|
|
It would be nice if there was nothing special about \code{dart:core}. However, its use is pervasive, which leads to the decision to import it automatically. However, some library $L$ may wish to define entities with names used by \code{dart:core} (which it can easily do, as the names declared by a library take precedence). Other libraries may wish to use $L$ and may want to use members of $L$ that conflict with the core library without having to use a prefix and without encountering warnings. The above rule makes this possible, essentially canceling \code{dart:core}'s special treatment by means of yet another special rule.
|
|
}
|
|
|
|
\subsection{Exports}
|
|
\LMLabel{exports}
|
|
|
|
\LMHash{}
|
|
A library $L$ exports a namespace (\ref{scoping}), meaning that the declarations in the namespace are made available to other libraries if they choose to import $L$ (\ref{imports}). The namespace that $L$ exports is known as its {\em exported namespace}.
|
|
|
|
\begin{grammar}
|
|
{\bf libraryExport:}
|
|
metadata \EXPORT{} uri combinator* `{\escapegrammar ;}'
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
An export specifies a URI $x$ where the declaration of an exported library is to be found. It is a compile-time error if the specified URI does not refer to a library declaration.
|
|
|
|
\LMHash{}
|
|
We say that a name {\em is exported by a library} (or equivalently, that a library {\em exports a name}) if the name is in the library's exported namespace. We say that a declaration {\em is exported by a library} (or equivalently, that a library {\em exports a declaration}) if the declaration is in the library's exported namespace.
|
|
|
|
\LMHash{}
|
|
A library always exports all names and all declarations in its public namespace. In addition, a library may choose to re-export additional libraries via {\em export directives}, often referred to simply as {\em exports}.
|
|
|
|
\LMHash{}
|
|
Let $E$ be an export directive that refers to a URI via the string $s_1$. Evaluation of $E$ proceeds as follows:
|
|
|
|
\LMHash{}
|
|
First,
|
|
|
|
\begin{itemize}
|
|
\item
|
|
If the URI that is the value of $s_1$ has not yet been accessed by an import or export directive in the current isolate then the contents of the URI are compiled to yield a library $B$.
|
|
\item Otherwise, the contents of the URI denoted by $s_1$ have been compiled into a library $B$ within the current isolate.
|
|
\end{itemize}
|
|
|
|
|
|
\LMHash{}
|
|
Let $NS_0$ be the exported namespace of $B$. Then, for each combinator clause $C_i, i \in 1..n$ in $E$:
|
|
\begin{itemize}
|
|
\item If $C_i$ is of the form \code{\SHOW{} $id_1, \ldots, id_k$} then let
|
|
|
|
$NS_i = \SHOW{}([id_1, \ldots, id_k], NS_{i-1}$).
|
|
\item If $C_i$ is of the form \code{\HIDE{} $id_1, \ldots, id_k$}
|
|
|
|
then let $NS_i = \HIDE{}([id_1, \ldots, id_k], NS_{i-1}$).
|
|
\end{itemize}
|
|
|
|
\LMHash{}
|
|
For each
|
|
entry mapping key $k$ to declaration $d$ in $NS_n$ an entry mapping $k$ to $d$ is added to the exported namespace of $L$ unless a top-level declaration with the name $k$ exists in $L$.
|
|
|
|
\LMHash{}
|
|
If a name $N$ is referenced by a library $L$ and $N$ would be introduced into the exported namespace of $L$ by exports of two libraries, $L_1$ and $L_2$, and the exported namespace of $L_1$ binds $N$ to a declaration originating in a system library:
|
|
%an export of a system library and an export of a non-system library:
|
|
\begin{itemize}
|
|
\item The export of $L_1$ is implicitly extended by a \code{\HIDE{} $N$} clause.
|
|
\item A static warning is issued.
|
|
\end{itemize}
|
|
|
|
\rationale{
|
|
See the discussion in section \ref{imports} for the reasoning behind this rule.
|
|
}
|
|
|
|
\LMHash{}
|
|
We say that $L$ {\em re-exports library } $B$, and also that $L$ {\em re-exports namespace } $NS_n$. When no confusion can arise, we may simply state that $L$ {\em re-exports }$B$, or that $L$ {\em re-exports }$NS_n$.
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if a name $N$ is re-exported by a library $L$ and $N$ is introduced into the export namespace of $L$ by more than one export, unless all exports refer to same declaration for the name $N$. It is a static warning to export two different libraries with the same name unless their name is the empty string.
|
|
|
|
|
|
|
|
\subsection{Parts}
|
|
\LMLabel{parts}
|
|
|
|
\LMHash{}
|
|
A library may be divided into {\em parts}, each of which can be stored in a separate location. A library identifies its parts by listing them via \PART{} directives.
|
|
|
|
\LMHash{}
|
|
A {\em part directive} specifies a URI where a Dart compilation unit that should be incorporated into the current library may be found.
|
|
|
|
\begin{grammar}
|
|
{\bf partDirective:}
|
|
metadata \PART{} uri `{\escapegrammar ;}'
|
|
.
|
|
|
|
{\bf partHeader:}
|
|
metadata \PART{} \OF{} identifier (`{\escapegrammar .}' identifier)* `{\escapegrammar ;}'
|
|
.
|
|
{\bf partDeclaration:}
|
|
partHeader topLevelDefinition* EOF
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
A {\em part header} begins with \PART{} \OF{} followed by the name of the library the part belongs to. A part declaration consists of a part header followed by a sequence of top-level declarations.
|
|
|
|
\LMHash{}
|
|
Compiling a part directive of the form \code{\PART{} $s$;} causes the Dart system to attempt to compile the contents of the URI that is the value of $s$. The top-level declarations at that URI are then compiled by the Dart compiler in the scope of the current library. It is a compile-time error if the contents of the URI are not a valid part declaration. It is a static warning if the referenced part declaration $p$ names a library other than the current library as the library to which $p$ belongs.
|
|
|
|
\LMHash{}
|
|
It's a compile-time error if the same library contains two part directives with the same URI.
|
|
|
|
\subsection{Scripts}
|
|
\LMLabel{scripts}
|
|
|
|
\LMHash{}
|
|
A {\em script} is a library whose exported namespace (\ref{exports}) includes
|
|
a top-level function declaration named \code{main}
|
|
that has either zero, one or two required arguments.
|
|
|
|
A script $S$ is executed as follows:
|
|
|
|
\LMHash{}
|
|
First, $S$ is compiled as a library as specified above.
|
|
Then, the top-level function defined by \code{main}
|
|
in the exported namespace of $S$ is invoked (\ref{functionInvocation})
|
|
as follows:
|
|
If \code{main} can be be called with with two positional arguments,
|
|
it is invoked with the following two actual arguments:
|
|
\begin{enumerate}
|
|
\item An object whose runtime type implements \code{List<String>}.
|
|
\item An object specified when the current isolate $i$ was created,
|
|
for example through the invocation of \code{Isolate.spawnUri} that spawned $i$,
|
|
or \NULL{} if no such object was supplied.
|
|
\end{enumerate}
|
|
If \code{main} cannot be called with two positional arguments,
|
|
but it can be called with one positional argument,
|
|
it is invoked with an object whose runtime type implements \code{List<String>}
|
|
as the only argument.
|
|
If \code{main} cannot be called with one or two positional arguments,
|
|
it is invoked with no arguments.
|
|
|
|
\commentary{
|
|
Note that if \code{main} requires more than two positional arguments,
|
|
the library is not considered a script.
|
|
}
|
|
|
|
\commentary{
|
|
A Dart program will typically be executed by executing a script.
|
|
}
|
|
|
|
\LMHash{}
|
|
If a non-script library is provided where a script is expected,
|
|
it precludes execution.
|
|
As such, it should be reported as a compile-time error,
|
|
even if that library compiles successfully as a non-script library.
|
|
|
|
\subsection{URIs}
|
|
\LMLabel{uris}
|
|
|
|
\LMHash{}
|
|
URIs are specified by means of string literals:
|
|
|
|
\begin{grammar}
|
|
{\bf uri:}
|
|
stringLiteral
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if the string literal $x$ that describes a URI is not a compile-time constant, or if $x$ involves string interpolation.
|
|
|
|
\LMHash{}
|
|
This specification does not discuss the interpretation of URIs, with the following exceptions.
|
|
|
|
\rationale{
|
|
The interpretation of URIs is mostly left to the surrounding computing environment. For example, if Dart is running in a web browser, that browser will likely interpret some URIs. While it might seem attractive to specify, say, that URIs are interpreted with respect to a standard such as IETF RFC 3986, in practice this will usually depend on the browser and cannot be relied upon.
|
|
}
|
|
|
|
\LMHash{}
|
|
A URI of the form \code{dart:$s$} is interpreted as a reference to a system library (\ref{imports}) $s$.
|
|
|
|
\LMHash{}
|
|
A URI of the form \code{package:$s$} is interpreted in an implementation specific manner.
|
|
|
|
\rationale{
|
|
The intent is that, during development, Dart programmers can rely on a package manager to find elements of their program.
|
|
}
|
|
|
|
\LMHash{}
|
|
Otherwise, any relative URI is interpreted as relative to the location of the current library. All further interpretation of URIs is implementation dependent.
|
|
|
|
\commentary{This means it is dependent on the embedder.}
|
|
|
|
|
|
\section{Types}
|
|
\LMLabel{types}
|
|
|
|
\LMHash{}
|
|
Dart supports optional typing based on interface types.
|
|
|
|
\rationale{The type system is unsound, due to the covariance of generic types. This is a deliberate choice (and undoubtedly controversial). Experience has shown that sound type rules for generics fly in the face of programmer intuition. It is easy for tools to provide a sound type analysis if they choose, which may be useful for tasks like refactoring.
|
|
}
|
|
|
|
\subsection{Static Types}
|
|
\LMLabel{staticTypes}
|
|
|
|
\LMHash{}
|
|
Static type annotations are used in variable declarations (\ref{variables}) (including formal parameters (\ref{formalParameters})), in the return types of functions (\ref{functions}) and in the bounds of type variables. Static type annotations are used during static checking and when running programs in checked mode. They have no effect whatsoever in production mode.
|
|
|
|
\begin{grammar}
|
|
{\bf type:}
|
|
typeName typeArguments?
|
|
.
|
|
|
|
{\bf typeName:}
|
|
qualified
|
|
.
|
|
|
|
{\bf typeArguments:}
|
|
`<' typeList `>'
|
|
.
|
|
|
|
{\bf typeList:}
|
|
type (`,' type)*
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
A Dart implementation must provide a static checker that detects and reports exactly those situations this specification identifies as static warnings and only those situations. However:
|
|
\begin{itemize}
|
|
\item Running the static checker on a program $P$ is not required for compiling and running $P$.
|
|
\item Running the static checker on a program $P$ must not prevent successful compilation of $P$ nor may it prevent the execution of $P$, regardless of whether any static warnings occur.
|
|
\end{itemize}
|
|
|
|
\commentary{Nothing precludes additional tools that implement alternative static analyses (e.g., interpreting the existing type annotations in a sound manner such as either non-variant generics, or inferring declaration based variance from the actual declarations). However, using these tools must not preclude successful compilation and execution of Dart code.
|
|
}
|
|
|
|
%\Q{Should we do something with respect to non-nullable types?}
|
|
|
|
\LMHash{}
|
|
A type $T$ is {\em malformed} iff:
|
|
\begin{itemize}
|
|
\item $T$ has the form $id$ or the form $prefix.id$, and in the enclosing lexical scope, the name $id$ (respectively $prefix.id$) does not denote a type.
|
|
\item $T$ denotes a type variable in the enclosing lexical scope, but occurs in the signature or body of a static member.
|
|
\item $T$ is a parameterized type of the form $G<S_1, \ldots , S_n>$, and $G$ is malformed.
|
|
\item $T$ denotes declarations that were imported from multiple imports clauses.
|
|
%Either $G$ or $S_i, i \in 1.. n$ are malformed.
|
|
% \item $G$ is not a generic type with $n$ type parameters.
|
|
% \item Let $T_i$ be the type parameters of $G$ (if any) and let $B_i$ be the bound of $T_i, i \in 1.. n$, and $S_i$ is not a subtype of $[S_1, \ldots, S_n/T_1, \ldots, T_n]B_i, i \in 1.. n$.
|
|
% \end{itemize}
|
|
\end{itemize}
|
|
|
|
\LMHash{}
|
|
Any use of a malformed type gives rise to a static warning. A malformed type is then interpreted as \DYNAMIC{} by the static type checker and the runtime unless explicitly specified otherwise.
|
|
|
|
\rationale{
|
|
This ensures that the developer is spared a series of cascading warnings as the malformed type interacts with other types.
|
|
}
|
|
|
|
\LMHash{}
|
|
A type $T$ is {\em deferred} iff it is of the form $p.T$ where $p$ is a deferred prefix.
|
|
It is a static warning to use a deferred type in a type annotation, type test, type cast or as a type parameter. However, all other static warnings must be issued under the assumption that all deferred libraries have successfully been loaded.
|
|
|
|
% Now, when passed to a generic, p.T also has to be treated as dynamic - otherwise we have to fail immediately. Where do we say that? And how does this fit with idea that as a type object it fails? Should we say that the accessor on p returns dynamic instead of failing? Do we distinguish its use in a constructor vs its use in an annotation? It's not that we evaluate type objects in constructor args - these cannot represent parameterized types.
|
|
|
|
|
|
\subsubsection{Type Promotion}
|
|
\LMLabel{typePromotion}
|
|
|
|
\LMHash{}
|
|
The static type system ascribes a static type to every expression. In some cases, the types of local variables and formal parameters may be promoted from their declared types based on control flow.
|
|
|
|
\LMHash{}
|
|
We say that a variable $v$ is known to have type $T$ whenever we allow the type of $v$ to be promoted. The exact circumstances when type promotion is allowed are given in the relevant sections of the specification (\ref{logicalBooleanExpressions}, \ref{conditional} and \ref{if}).
|
|
|
|
\LMHash{}
|
|
Type promotion for a variable $v$ is allowed only when we can deduce that such promotion is valid based on an analysis of certain boolean expressions. In such cases, we say that the boolean expression $b$ shows that $v$ has type $T$. As a rule, for all variables $v$ and types $T$, a boolean expression does not show that $v$ has type $T$. Those situations where an expression does show that a variable has a type are mentioned explicitly in the relevant sections of this specification (\ref{typeTest} and \ref{logicalBooleanExpressions}).
|
|
|
|
|
|
\subsection{Dynamic Type System}
|
|
\LMLabel{dynamicTypeSystem}
|
|
|
|
\LMHash{}
|
|
A Dart implementation must support execution in both {\em production mode} and {\em checked mode}. Those dynamic checks specified as occurring specifically in checked mode must be performed iff the code is executed in checked mode.
|
|
|
|
\commentary{
|
|
Note that this is the case even if the deferred type belongs to a prefix that has already been loaded. This is regrettable, since it strongly discourages the use of type annotations that involve deferred types because Dart programmers use checked mode much of the time.
|
|
|
|
In practice, many scenarios involving deferred loading involve deferred loading of classes that implement eagerly loaded interfaces, so the situation is often less onerous than it seems. The current semantics were adopted based on considerations of ease of implementation.
|
|
|
|
Clearly, if a deferred type has not yet been loaded, it is impossible to do a correct subtype test involving it, and one would expect a dynamic failure, as is the case with type tests and casts. By the same token, one would expect checked mode to work seamlessly once a type had been loaded. We hope to adopt these semantics in the future; such a change would be upwardly compatible.
|
|
|
|
}
|
|
|
|
%It is a run-time type error to access an undeclared type outside .
|
|
|
|
\LMHash{}
|
|
%It is a dynamic type error if a malformed type is used in a subtype test.
|
|
In checked mode, it is a dynamic type error if a deferred, malformed or malbounded (\ref{parameterizedTypes})
|
|
type is used in a subtype test.
|
|
|
|
%In production mode, an undeclared type is treated as an instance of type \DYNAMIC{}.
|
|
|
|
\commentary{Consider the following program}
|
|
|
|
\begin{dartCode}
|
|
\TYPEDEF{} F(bool x);
|
|
f(foo x) => x;
|
|
main() \{
|
|
if (f is F) \{
|
|
print("yoyoma");
|
|
\}
|
|
\}
|
|
\end{dartCode}
|
|
|
|
\commentary{
|
|
The type of the formal parameter of $f$ is $foo$, which is undeclared in the lexical scope. This will lead to a static type warning. At runtime the program will print \cd{yoyoma}, because $foo$ is treated as \DYNAMIC{}.
|
|
%fail when executing the type test on the first line of $main()$ because it leads to a subtype comparison involving a malformed type ($foo$).
|
|
|
|
As another example take}
|
|
|
|
\begin{dartCode}
|
|
\VAR{} i;
|
|
i j; // a variable j of type i (supposedly)
|
|
main() \{
|
|
j = 'I am not an i';
|
|
\}
|
|
\end{dartCode}
|
|
|
|
\commentary{
|
|
Since $i$ is not a type, a static warning will be issue at the declaration of $j$. However, the program can be executed without incident in production mode because he undeclared type $i$ is treated as \DYNAMIC{}. However, in checked mode, the implicit subtype test at the assignment will trigger an error at runtime.
|
|
}
|
|
|
|
|
|
\commentary{
|
|
Here is an example involving malbounded types:
|
|
}
|
|
|
|
\begin{dartCode}
|
|
\CLASS{} I<T \EXTENDS{} num> \{\}
|
|
\CLASS{} J \{\}
|
|
|
|
\CLASS{} A<T> \IMPLEMENTS{} J, I<T> // type warning: T is not a subtype of num
|
|
\{ ...
|
|
\}
|
|
\end{dartCode}
|
|
|
|
\commentary{Given the declarations above, the following}
|
|
|
|
\begin{dartCode}
|
|
I x = \NEW{} A<String>();
|
|
\end{dartCode}
|
|
|
|
\commentary{
|
|
will cause a dynamic type error in checked mode, because the assignment requires a subtype test A<String> <: I. To show that this holds, we need to show that A<String> $<<$ I<String>, but I<String> is a malbounded type, causing the dynamic error. No error is thrown in production mode. Note that
|
|
}
|
|
|
|
\begin{dartCode}
|
|
J x = \NEW{} A<String>();
|
|
\end{dartCode}
|
|
|
|
\commentary{
|
|
does not cause a dynamic error, as there is no need to test against \code{I<String>} in this case.
|
|
Similarly, in production mode
|
|
}
|
|
|
|
\begin{dartCode}
|
|
A x = \NEW{} A<String>();
|
|
bool b = x is I;
|
|
\end{dartCode}
|
|
|
|
\commentary{
|
|
\code{b} is bound to \TRUE, but in checked mode the second line causes a dynamic type error.
|
|
}
|
|
|
|
|
|
|
|
\subsection{Type Declarations}
|
|
\LMLabel{typeDeclarations}
|
|
|
|
\subsubsection{Typedef}
|
|
\LMLabel{typedef}
|
|
|
|
\LMHash{}
|
|
A {\em type alias} declares a name for a type expression.
|
|
|
|
|
|
\begin{grammar}
|
|
|
|
{\bf typeAlias:}
|
|
metadata \TYPEDEF{} typeAliasBody
|
|
.
|
|
|
|
{\bf typeAliasBody:}
|
|
functionTypeAlias
|
|
.
|
|
|
|
{\bf functionTypeAlias:}
|
|
functionPrefix typeParameters? formalParameterList `{\escapegrammar ;}'
|
|
.
|
|
|
|
{\bf functionPrefix:}
|
|
returnType? identifier
|
|
.
|
|
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
The effect of a type alias of the form \code{\TYPEDEF{} $T$ $id (T_1$ $p_1, \ldots, T_n$ $p_n, [T_{n+1}$ $p_{n+1}, \ldots, T_{n+k}$ $p_{n+k}])$} declared in a library $L$ is to introduce the name $id$ into the scope of $L$, bound to the function type $(T_1, \ldots, T_n, [T_{n+1}$ $p_{n+1}, \ldots, T_{n+k}$ $p_{n+k}]) \rightarrow T$.
|
|
The effect of a type alias of the form \code{\TYPEDEF{} $T$ $id (T_1$ $p_1, \ldots, T_n$ $p_n, \{T_{n+1}$ $p_{n+1}, \ldots, T_{n+k}$ $p_{n+k}\})$} declared in a library $L$ is to introduce the name $id$ into the scope of $L$, bound to the function type $(T_1, \ldots, T_n, \{T_{n+1}$ $p_{n+1}, \ldots, T_{n+k}$ $p_{n+k}\}) \rightarrow T$.
|
|
In either case, iff no return type is specified, it is taken to be \DYNAMIC{}. Likewise, if a type annotation is omitted on a formal parameter, it is taken to be \DYNAMIC{}.
|
|
|
|
\LMHash{}
|
|
It is a compile-time error if any default values are specified in the signature of a function type alias.
|
|
%A typedef may only refer to itself via the bounds of its generic parameters.
|
|
Any self reference in a typedef, either directly, or recursively via another typedef, is a compile time error.
|
|
%via a chain of references that does not include a class declaration.
|
|
|
|
|
|
|
|
\subsection{Interface Types}
|
|
\LMLabel{interfaceTypes}
|
|
|
|
\LMHash{}
|
|
The implicit interface of class $I$ is a direct supertype of the implicit interface of class $J$ iff:
|
|
\begin{itemize}
|
|
\item
|
|
If $I$ is \code{Object}, and $J$ has no \EXTENDS{} clause% and no interface injection declaration has extended $J.
|
|
\item
|
|
If $I$ is listed in the \EXTENDS{} clause of $J$% or an interface injection declaration has extended $J$ with $I$
|
|
.
|
|
\item If $I$ is listed in the \IMPLEMENTS{} clause of $J$
|
|
|
|
\item If $I$ is listed in the \WITH{} clause of $J$
|
|
|
|
\item If $J$ is a mixin application (\ref{mixinApplication}) of the mixin of $I$.
|
|
\end{itemize}
|
|
|
|
%\Q{Can wacky stuff happen with interface injection, e.g., a direct superinterface becomes indirect? What about side effects - loading order can affect type relationships.
|
|
%}
|
|
|
|
\LMHash{}
|
|
A type $T$ is more specific than a type $S$, written $T << S$, if one of the following conditions is met:
|
|
\begin{itemize}
|
|
\item $T$ is $S$.
|
|
\item $T$ is $\bot$.
|
|
\item $T$ is \code{Null} and $S$ is not $\bot$.
|
|
\item $S$ is \DYNAMIC{}.
|
|
\item $S$ is a direct supertype of $T$.
|
|
\item $T$ is a type parameter and $S$ is the upper bound of $T$.
|
|
\item $T$ is a type parameter and $S$ is \cd{Object}.
|
|
\item $T$ is of the form $I<T_1, \ldots, T_n>$ and $S$ is of the form $I<S_1, \ldots, S_n>$ and:
|
|
$T_i << S_i, 1 \le i \le n$
|
|
\item $T$ and $S$ are both function types, and $T << S$ under the rules of section \ref{functionTypes}.
|
|
\item $T$ is a function type and $S$ is \cd{Function}.
|
|
\item $T << U$ and $U << S$.
|
|
\end{itemize}
|
|
|
|
\LMHash{}
|
|
$<<$ is a partial order on types.
|
|
$T$ is a subtype of $S$, written $T <: S$, iff $[\bot/\DYNAMIC{}]T << S$.
|
|
|
|
\rationale{
|
|
Note that $<:$ is not a partial order on types, it is only binary relation on types. This is because $<:$ is not transitive. If it was, the subtype rule would have a cycle. For example:
|
|
$List <: List<String>$ and $List<int> <: List$, but $List<int>$ is not a subtype of $List<String>$.
|
|
Although $<:$ is not a partial order on types, it does contain a partial order, namely $<<$. This means that, barring raw types, intuition about classical subtype rules does apply.
|
|
}
|
|
|
|
\commentary{
|
|
The \code{Null} type is more specific than all non-$\bot$ types, even though
|
|
it doesn't actually extend or implement those types.
|
|
The other types are effectively treated as if they are {\em nullable},
|
|
which makes \NULL{} assignable to them.
|
|
}
|
|
|
|
\LMHash{}
|
|
$S$ is a supertype of $T$, written $S :> T$, iff $T$ is a subtype of $S$.
|
|
|
|
\commentary{The supertypes of an interface are its direct supertypes and their supertypes. }
|
|
|
|
\LMHash{}
|
|
An interface type $T$ may be assigned to a type $S$, written $T \Longleftrightarrow S$, iff either $T <: S$, $S <: T$.
|
|
|
|
\rationale{This rule may surprise readers accustomed to conventional typechecking. The intent of the $\Longleftrightarrow$ relation is not to ensure that an assignment is correct. Instead, it aims to only flag assignments that are almost certain to be erroneous, without precluding assignments that may work.
|
|
|
|
For example, assigning a value of static type Object to a variable with static type String, while not guaranteed to be correct, might be fine if the runtime value happens to be a string.
|
|
}
|
|
|
|
\subsection{Function Types}
|
|
\LMLabel{functionTypes}
|
|
|
|
\LMHash{}
|
|
Function types come in two variants:
|
|
\begin{enumerate}
|
|
\item
|
|
The types of functions that only have positional parameters. These have the general form $(T_1, \ldots, T_n, [T_{n+1} \ldots, T_{n+k}]) \rightarrow T$.
|
|
\item
|
|
The types of functions with named parameters. These have the general form $(T_1, \ldots, T_n, \{T_{x_1}$ $x_1 \ldots, T_{x_k}$ $x_k\}) \rightarrow T$.
|
|
\end{enumerate}
|
|
|
|
%$(T_1, \ldots T_n) \rightarrow T$ is a subtype of $(S_1, \ldots, S_n, ) \rightarrow S$, if all of the following conditions are met:
|
|
%\begin{enumerate}
|
|
%\item Either
|
|
%\begin{itemize}
|
|
%\item $S$ is \VOID{}, Or
|
|
%\item $T \Longleftrightarrow S$.
|
|
%\end{itemize}
|
|
%\item$ \forall i \in 1 .. n, T_i \Longleftrightarrow S_i$.
|
|
%\end{enumerate}
|
|
|
|
\LMHash{}
|
|
%A function type $(T_1, \ldots T_n, [T_{n+1} \ldots, T_{n+k}]) \rightarrow T$ is a subtype of the
|
|
% the line below revises the rule to be more liberal
|
|
A function type $(T_1, \ldots T_{k}, [T_{k+1} \ldots, T_{n+m}]) \rightarrow T$ is a subtype of the
|
|
function type $(S_1, \ldots, S_{k+j}, [S_{k+j+1} \ldots, S_{n}]) \rightarrow S$, if all of the following conditions are met:
|
|
\begin{enumerate}
|
|
\item Either
|
|
\begin{itemize}
|
|
\item $S$ is \VOID{}, Or
|
|
\item $T \Longleftrightarrow S$.
|
|
\end{itemize}
|
|
\item $\forall i \in 1 .. n, T_i \Longleftrightarrow S_i$.
|
|
\end{enumerate}
|
|
|
|
|
|
\LMHash{}
|
|
A function type $(T_1, \ldots T_n, \{T_{x_1}$ $x_1, \ldots, T_{x_k}$ $x_k\}) \rightarrow T$ is a subtype of the function type $(S_1, \ldots, S_n, \{S_{y_1}$ $y_1, \ldots, S_{y_m}$ $y_m\}) \rightarrow S$, if all of the following conditions are met:
|
|
\begin{enumerate}
|
|
\item Either
|
|
\begin{itemize}
|
|
\item $S$ is \VOID{}, Or
|
|
\item $T \Longleftrightarrow S$.
|
|
\end{itemize}
|
|
\item $\forall i \in 1 .. n, T_i \Longleftrightarrow S_i$.
|
|
\item $k \ge m$ and $y_i \in \{x_1, \ldots, x_k\}, i \in 1 .. m$.
|
|
%\{x_1, \ldots, x_k\}$ is a superset of $\{y_1, \ldots, y_m\}$.
|
|
\item For all $y_i \in \{y_1, \ldots, y_m\}, y_i = x_j \Rightarrow T_{x_j} \Longleftrightarrow S_{y_i}$
|
|
\end{enumerate}
|
|
|
|
%In addition, a function type $(T_1, \ldots, Tn, [T_{n+1} x_{n+1}, \ldots, T_{n+k} x_{n+k}]) \rightarrow T$ is a subtype of the function type $(T_1, \ldots, T_n, T_{n+1} , [T_{n+2} x_{n+2}, \ldots, T_{n+k} x_{n+k}]) \rightarrow T$.
|
|
|
|
%\rationale{This second rule is attractive to web developers, who are used to this sort of flexibility from Javascript. However, it may be costly to implement efficiently.} \Q{Should we do this or not?}
|
|
|
|
%We write $(T_1, \ldots, T_n) \rightarrow T$ as a shorthand for the type $(T_1, \ldots, T_n, []) \rightarrow T$.
|
|
|
|
%The rules above need to be sanity checked, but the intent is that we view functions with rest parameters as having type $(T_1, ..., T_n, [\_{Tn+1}[] \_]) \rightarrow T$, where \_ is some magical identifier. Then the rules above may cover everything.
|
|
% This is wrong - from the outside, the type takes an unbounded sequence of types, not a list. This can be modeled as $(T_1, \ldots, T_n, [T_{n+1}, \_ \ldots, T_{n+k} \_]) \rightarrow T$ for some finite $k$.
|
|
|
|
\LMHash{}
|
|
In addition, the following subtype rules apply:
|
|
|
|
|
|
$(T_1, \ldots, T_n, []) \rightarrow T <: (T_1, \ldots, T_n) \rightarrow T$.
|
|
|
|
$(T_1, \ldots, T_n) \rightarrow T <: (T_1, \ldots, T_n, \{\}) \rightarrow T$.
|
|
|
|
$(T_1, \ldots, T_n, \{\}) \rightarrow T <: (T_1, \ldots, T_n) \rightarrow T$.
|
|
|
|
$(T_1, \ldots, T_n) \rightarrow T <: (T_1, \ldots, T_n, []) \rightarrow T$.
|
|
|
|
\rationale{
|
|
The naive reader might conclude that, since it is not legal to declare a function with an empty optional parameter list, these rules are pointless. However, they induce useful relationships between function types that declare no optional parameters and those that do.
|
|
}
|
|
|
|
\LMHash{}
|
|
A function type $T$ may be assigned to a function type $S$, written $T \Longleftrightarrow S$, iff $T <: S$.
|
|
|
|
\LMHash{}
|
|
% ensure that Object and dynamic may be assign dot a function type
|
|
A function is always an instance of some class that implements the class \code{Function} and implements a \CALL{} method with the same signature as the function. All function types are subtypes of \code{Function}.
|
|
If a type $I$ includes an instance method named \CALL{}, and the type of \CALL{} is the function type $F$, then $I$ is considered to be more specific than $F$. It is a static warning if a concrete class implements \cd{Function} and does not have a concrete method named \CALL{} unless that class has an implementation of \cd{noSuchMethod()} distinct from the one declared in class \cd{Object}.
|
|
|
|
|
|
|
|
|
|
%\commentary{Need to specify how a function values dynamic type is derived from its static signature.}
|
|
|
|
\LMHash{}
|
|
A function type $(T_1, \ldots T_{k}, [T_{k+1} \ldots, T_{n+m}]) \rightarrow T$ is more specific than the
|
|
function type $(S_1, \ldots, S_{k+j}, [S_{k+j+1} \ldots, S_{n}]) \rightarrow S$, if all of the following conditions are met:
|
|
\begin{enumerate}
|
|
\item Either
|
|
\begin{itemize}
|
|
\item $S$ is \VOID{}, Or
|
|
\item $T << S$.
|
|
\end{itemize}
|
|
\item $\forall i \in 1 .. n, T_i << S_i$.
|
|
\end{enumerate}
|
|
|
|
|
|
\LMHash{}
|
|
A function type $(T_1, \ldots T_n, \{T_{x_1}$ $x_1, \ldots, T_{x_k}$ $x_k\}) \rightarrow T$ is more specific than the function type $(S_1, \ldots, S_n, \{S_{y_1}$ $y_1, \ldots, S_{y_m}$ $y_m\}) \rightarrow S$, if all of the following conditions are met:
|
|
\begin{enumerate}
|
|
\item Either
|
|
\begin{itemize}
|
|
\item $S$ is \VOID{}, Or
|
|
\item $T << S$.
|
|
\end{itemize}
|
|
\item $\forall i \in 1 .. n, T_i << S_i$.
|
|
\item $k \ge m$ and $y_i \in \{x_1, \ldots, x_k\}, i \in 1 .. m$.
|
|
%\{x_1, \ldots, x_k\}$ is a superset of $\{y_1, \ldots, y_m\}$.
|
|
\item For all $y_i \in \{y_1, \ldots, y_m\}, y_i = x_j \Rightarrow T_j << S_i$
|
|
\end{enumerate}
|
|
|
|
\LMHash{}
|
|
Furthermore, if $F$ is a function type, $F << \code{Function}$.
|
|
|
|
|
|
\subsection{Type \DYNAMIC{}}
|
|
\LMLabel{typeDynamic}
|
|
|
|
\LMHash{}
|
|
The type \DYNAMIC{} denotes the unknown type.
|
|
|
|
\LMHash{}
|
|
If no static type annotation has been provided the type system assumes the declaration has the unknown type. If a generic type is used but type arguments are not provided, then the type arguments default to the unknown type.
|
|
|
|
\commentary{This means that given a generic declaration $G<T_1, \ldots, T_n>$, the type $G$ is equivalent to $G< \DYNAMIC{}, \ldots, \DYNAMIC{}>$.
|
|
}
|
|
|
|
\LMHash{}
|
|
Type \DYNAMIC{} has methods for every possible identifier and arity, with every possible combination of named parameters. These methods all have \DYNAMIC{} as their return type, and their formal parameters all have type \DYNAMIC{}.
|
|
Type \DYNAMIC{} has properties for every possible identifier. These properties all have type \DYNAMIC{}.
|
|
|
|
\rationale{From a usability perspective, we want to ensure that the checker does not issue errors everywhere an unknown type is used. The definitions above ensure that no secondary errors are reported when accessing an unknown type.
|
|
|
|
The current rules say that missing type arguments are treated as if they were the type \DYNAMIC{}. An alternative is to consider them as meaning \code{Object}. This would lead to earlier error detection in checked mode, and more aggressive errors during static typechecking. For example:
|
|
|
|
(1) \code{typedAPI(G\lt{String}\gt g)\{...\}}
|
|
|
|
|
|
(2) \code{typedAPI(new G()); }
|
|
|
|
|
|
Under the alternative rules, (2) would cause a runtime error in checked mode. This seems desirable from the perspective of error localization. However, when a dynamic error is thrown at (2), the only way to keep running is rewriting (2) into
|
|
|
|
(3) \code{typedAPI(new G\lt{String}\gt());}
|
|
|
|
This forces users to write type information in their client code just because they are calling a typed API. We do not want to impose this on Dart programmers, some of which may be blissfully unaware of types in general, and genericity in particular.
|
|
|
|
What of static checking? Surely we would want to flag (2) when users have explicitly asked for static typechecking? Yes, but the reality is that the Dart static checker is likely to be running in the background by default. Engineering teams typically desire a ``clean build'' free of warnings and so the checker is designed to be extremely charitable. Other tools can interpret the type information more aggressively and warn about violations of conventional (and sound) static type discipline.
|
|
}
|
|
|
|
\LMHash{}
|
|
The name \DYNAMIC{} denotes a \cd{Type} object even though \DYNAMIC{} is not a class.
|
|
|
|
\LMHash{}
|
|
The built-in type declaration \code{FutureOr},
|
|
which is declared in the library \code{dart:async},
|
|
defines a generic type with one type parameter (\ref{generics}).
|
|
If the \code{FutureOr} type, optionally followed by type arguments,
|
|
is used as a type, it denotes the \DYNAMIC{} type.
|
|
As such, the \code{FutureOr} type cannot be used where \DYNAMIC{} cannot be
|
|
used as a type.
|
|
If the type arguments applied to \code{FutureOr} would issue static warnings
|
|
if applied to a normal generic class with one type parameter,
|
|
the same warnings are issued for \code{FutureOr},
|
|
even though the type arguments are otherwise ignored.
|
|
The name \code{FutureOr} as an expression
|
|
denotes the same \cd{Type} object as \DYNAMIC{}.
|
|
|
|
\rationale{
|
|
The \code{FutureOr} type is reserved for future use,
|
|
for cases where a value can be either an instance of the type \metavar{type}
|
|
or the type \code{Future<\metavar{type}>}. Such cases occur naturally
|
|
in asynchronous code.
|
|
Using \code{FutureOr} instead of \DYNAMIC{} will allow some tools
|
|
to provide a more precise type analysis.
|
|
}
|
|
%\rationale {
|
|
%Type objects reify the runtime types of instances. No instance ever has type \DYNAMIC{}.
|
|
%}
|
|
|
|
\subsection{Type Void}
|
|
\LMLabel{typeVoid}
|
|
|
|
\LMHash{}
|
|
The special type \VOID{} may only be used as the return type of a function: it is a compile-time error to use \VOID{} in any other context.
|
|
|
|
\commentary{
|
|
For example, as a type argument, or as the type of a variable or parameter
|
|
|
|
Void is not an interface type.
|
|
|
|
The only subtype relations that pertain to void are therefore:
|
|
\begin{itemize}
|
|
\item
|
|
$\VOID{} <: \VOID{}$ (by reflexivity)
|
|
\item
|
|
$\bot <: \VOID{}$ (as bottom is a subtype of all types).
|
|
\item
|
|
$\VOID{} <: \DYNAMIC{}$ (as \DYNAMIC{} is a supertype of all types)
|
|
\end{itemize}
|
|
|
|
The analogous rules also hold for the $<<$ relation for similar reasons.
|
|
|
|
Hence, the static checker will issue warnings if one attempts to access a member of the result of a void method invocation (even for members of \NULL{}, such as \code{==}). Likewise, passing the result of a void method as a parameter or assigning it to a variable will cause a warning unless the variable/formal parameter has type dynamic.
|
|
|
|
On the other hand, it is possible to return the result of a void method from within a void method. One can also return \NULL{}; or a value of type \DYNAMIC{}. Returning any other result will cause a type warning. In checked mode, a dynamic type error would arise if a non-null object was returned from a void method (since no object has runtime type \DYNAMIC{}).
|
|
}
|
|
|
|
\commentary {The name \VOID{} does not denote a \cd{Type} object.}
|
|
|
|
\rationale {
|
|
It is syntacticly illegal to use \VOID{} as an expression, and it would make no sense to do so.
|
|
Type objects reify the runtime types of instances. No instance ever has type \VOID{}.
|
|
}
|
|
|
|
|
|
|
|
\subsection{Parameterized Types}
|
|
\LMLabel{parameterizedTypes}
|
|
|
|
\LMHash{}
|
|
A {\em parameterized type} is an invocation of a generic type declaration.
|
|
|
|
\LMHash{}
|
|
Let $T$ be a parameterized type $G<S_1, \ldots, S_n>$. If $G$ is not a generic type, the type arguments $S_i$, $1 \le i \le n$ are discarded. If $G$ has $m \ne n$ type parameters, $T$ is treated as as a parameterized type with $m$ arguments, all of which are \DYNAMIC{}.
|
|
|
|
\commentary{In short, any arity mismatch results in all type arguments being dropped, and replaced with the correct number of type arguments, all set to \DYNAMIC{}. Of course, a static warning will be issued.
|
|
}
|
|
|
|
\LMHash{}
|
|
Otherwise, let
|
|
$T_i$ be the type parameters of $G$ and let $B_i$ be the bound of $T_i, i \in 1.. n$,. $T$ is {\em malbounded} iff either $S_i$ is malbounded or $S_i$ is not a subtype of $[S_1, \ldots, S_n/T_1, \ldots, T_n]B_i, i \in 1.. n$.
|
|
|
|
\commentary{
|
|
Note, that, in checked mode, it is a dynamic type error if a malbounded type is used in a type test as specified in \ref{dynamicTypeSystem}.
|
|
}
|
|
|
|
\LMHash{}
|
|
Any use of a malbounded type gives rise to a static warning.
|
|
|
|
\LMHash{}
|
|
If $S$ is the static type of a member $m$ of $G$, then the static type of the member $m$ of $G<A_1, \ldots, A_n>$ is $[A_1, \ldots, A_n/T_1, \ldots, T_n]S$ where $T_1, \ldots, T_n$ are the formal type parameters of $G$. Let $B_i$, be the bounds of $T_i, 1 \le i \le n$. It is a static type warning if $A_i$ is not a subtype of $[A_1, \ldots, A_n/T_1, \ldots, T_n]B_i, i \in 1..n$. It is a static type warning if $G$ is not a generic type with exactly $n$ type parameters.
|
|
|
|
|
|
|
|
|
|
|
|
\subsubsection{Actual Type of Declaration}
|
|
\LMLabel{actualTypeOfADeclaration}
|
|
|
|
\LMHash{}
|
|
A type $T$ {\em depends on a type parameter} $U$ iff:
|
|
\begin{itemize}
|
|
\item $T$ is $U$.
|
|
\item $T$ is a parameterized type, and one of the type arguments of $T$ depends on $U$.
|
|
\end{itemize}
|
|
|
|
\LMHash{}
|
|
Let $T$ be the declared type of a declaration $d$, as it appears in the program source. The {\em actual type} of $d$ is
|
|
|
|
\begin{itemize}
|
|
\item $[A_1, \ldots, A_n/U_1, \ldots, U_n]T$ if $d$ depends on type parameters $U_1, \ldots, U_n$, and $A_i$ is the value of $U_i, 1 \le i \le n$.
|
|
\item $T$ otherwise.
|
|
\end{itemize}
|
|
|
|
\subsubsection{Least Upper Bounds}
|
|
\LMLabel{leastUpperBounds}
|
|
|
|
\LMHash{}
|
|
% does this diverge in some cases?
|
|
Given two interfaces $I$ and $J$,
|
|
let $S_I$ be the set of superinterfaces of $I$,
|
|
let $S_J$ be the set of superinterfaces of $J$
|
|
and let $S = (\{I\} \cup S_I) \cap (\{J\} \cup S_J)$.
|
|
Furthermore,
|
|
we define $S_n = \{T | T \in S \wedge depth(T) = n\}$ for any finite $n$
|
|
where $depth(T)$ is the number of steps in the longest inheritance path
|
|
from $T$ to \code{Object}.
|
|
%TODO(lrn): Specify that "inheritance path" is a path in the superinterface graph.
|
|
Let $q$ be the largest number such that $S_q$ has cardinality one,
|
|
which must exist because $S_0$ is $\{\code{Object}\}$.
|
|
The least upper bound of $I$ and $J$ is the sole element of $S_q$.
|
|
|
|
\LMHash{}
|
|
The least upper bound of \DYNAMIC{} and any type $T$ is \DYNAMIC{}.
|
|
The least upper bound of \VOID{} and any type $T \ne \DYNAMIC{}$ is \VOID{}.
|
|
The least upper bound of $\bot$ and any type $T$ is $T$.
|
|
Let $U$ be a type variable with upper bound $B$. The least upper bound of $U$ and a type $T \ne \bot$ is the least upper bound of $B$ and $T$.
|
|
|
|
\LMHash{}
|
|
The least upper bound operation is commutative and idempotent,
|
|
but it is not associative.
|
|
|
|
% Function types
|
|
|
|
\LMHash{}
|
|
The least upper bound of a function type and an interface type $T$ is the least upper bound of \cd{Function} and $T$.
|
|
Let $F$ and $G$ be function types. If $F$ and $G$ differ in their number of required parameters, then the least upper bound of $F$ and $G$ is \cd{Function}. Otherwise:
|
|
\begin{itemize}
|
|
\item If
|
|
|
|
$F= (T_1 \ldots T_r, [T_{r+1}, \ldots, T_n]) \longrightarrow T_0$,
|
|
|
|
$G= (S_1 \ldots S_r, [S_{r+1}, \ldots, S_k]) \longrightarrow S_0$
|
|
|
|
where $k \le n$ then the least upper bound of $F$ and $G$ is
|
|
|
|
$(L_1 \ldots L_r, [L_{r+1}, \ldots, L_k]) \longrightarrow L_0$
|
|
|
|
where $L_i$ is the least upper bound of $T_i$ and $S_i, i \in 0..k$.
|
|
\item If
|
|
|
|
$F= (T_1 \ldots T_r, [T_{r+1}, \ldots, T_n]) \longrightarrow T_0$,
|
|
|
|
$G= (S_1 \ldots S_r, \{ \ldots \}) \longrightarrow S_0$
|
|
|
|
then the least upper bound of $F$ and $G$ is
|
|
|
|
$(L_1 \ldots L_r) \longrightarrow L_0$
|
|
|
|
where $L_i$
|
|
is the least upper bound of $T_i$ and $S_i, i \in 0..r$.
|
|
\item If
|
|
|
|
$F= (T_1 \ldots T_r, \{T_{r+1}$ $p_{r+1}, \ldots, T_f$ $p_f\}) \longrightarrow T_0$,
|
|
|
|
$G= (S_1 \ldots S_r, \{ S_{r+1}$ $q_{r+1}, \ldots, S_g$ $q_g\}) \longrightarrow S_0$
|
|
|
|
then let $\{x_m, \ldots x_n\} = \{p_{r+1}, \ldots, p_f\} \cap \{q_{r+1}, \ldots, q_g\}$ and let $X_j$ be the least upper bound of the types of $x_j$ in $F$ and $G, j \in m..n$. Then
|
|
the least upper bound of $F$ and $G$ is
|
|
|
|
$(L_1 \ldots L_r, \{ X_m$ $x_m, \ldots, X_n$ $x_n\}) \longrightarrow L_0$
|
|
|
|
where $L_i$ is the least upper bound of $T_i$ and $S_i, i \in 0..r$
|
|
\end{itemize}
|
|
|
|
|
|
\section{Reference}
|
|
\LMLabel{reference}
|
|
|
|
\subsection{Lexical Rules}
|
|
\LMLabel{lexicalRules}
|
|
|
|
\LMHash{}
|
|
Dart source text is represented as a sequence of Unicode code points. This sequence is first converted into a sequence of tokens according to the lexical rules given in this specification. At any point in the tokenization process, the longest possible token is recognized.
|
|
|
|
\subsubsection{Reserved Words}
|
|
\LMLabel{reservedWords}
|
|
|
|
\LMHash{}
|
|
A {\em reserved word} may not be used as an identifier; it is a compile-time error if a reserved word is used where an identifier is expected.
|
|
|
|
\ASSERT{}, \BREAK{}, \CASE{}, \CATCH{}, \CLASS{}, \CONST{}, \CONTINUE{}, \DEFAULT{}, \DO{}, \ELSE{}, \ENUM{}, \EXTENDS{}, \FALSE{}, \FINAL{}, \FINALLY{}, \FOR{}, \IF{}, \IN{}, \IS{}, \NEW{}, \NULL{}, \RETHROW, \RETURN{}, \SUPER{}, \SWITCH{}, \THIS{}, \THROW{}, \TRUE{}, \TRY{}, \VAR{}, \VOID{}, \WHILE{}, \WITH{}.
|
|
|
|
|
|
|
|
%\Q{Unicode characters.}
|
|
|
|
\begin{grammar}
|
|
{\bf LETTER:}`a' {\escapegrammar ..} `z';
|
|
`A' {\escapegrammar ..}`Z'
|
|
.
|
|
|
|
{\bf DIGIT:}
|
|
`0' {\escapegrammar ..} `9'
|
|
.
|
|
|
|
{\bf WHITESPACE:}
|
|
(`$\backslash$t' $|$ ` ' $|$ NEWLINE)+
|
|
.
|
|
\end{grammar}
|
|
|
|
\subsubsection{Comments}
|
|
\LMLabel{comments}
|
|
|
|
\LMHash{}
|
|
{\em Comments} are sections of program text that are used for documentation.
|
|
|
|
\begin{grammar}{\bf SINGLE\_LINE\_COMMENT:}
|
|
`//' \~{}(NEWLINE)* (NEWLINE)?
|
|
.
|
|
|
|
{\bf MULTI\_LINE\_COMMENT:}
|
|
`/*' (MULTI\_LINE\_COMMENT $|$ \~{} `*/')* `*/'
|
|
.
|
|
\end{grammar}
|
|
|
|
\LMHash{}
|
|
Dart supports both single-line and multi-line comments. A {\em single line comment} begins with the token \code{//}. Everything between \code{//} and the end of line must be ignored by the Dart compiler unless the comment is a documentation comment. .
|
|
|
|
\LMHash{}
|
|
A {\em multi-line comment} begins with the token \code{/*} and ends with the token \code{*/}. Everything between \code{/}* and \code{*}/ must be ignored by the Dart compiler unless the comment is a documentation comment. Comments may nest.
|
|
|
|
\LMHash{}
|
|
{\em Documentation comments} are comments that begin with the tokens \code{///} or \code{/**}. Documentation comments are intended to be processed by a tool that produces human readable documentation.
|
|
|
|
|
|
\LMHash{}
|
|
The scope of a documentation comment immediately preceding the declaration of a class $C$ is the instance scope of $C$.
|
|
|
|
\LMHash{}
|
|
The scope of a documentation comment immediately preceding the declaration of a function $f$ is the scope in force at the very beginning of the body of $f$.
|
|
|
|
|
|
|
|
|
|
|
|
%\subsection{Grammar}
|
|
%\LMLabel{grammar}
|
|
\subsection{Operator Precedence}
|
|
\LMLabel{operatorPrecedence}
|
|
|
|
\LMHash{}
|
|
Operator precedence is given implicitly by the grammar.
|
|
|
|
\commentary{The following non-normative table may be helpful
|
|
\newline
|
|
|
|
\begin{tabular}{| r | r | r | r |}
|
|
\hline
|
|
Description & Operator & Associativity & Precedence \\
|
|
\hline
|
|
Unary postfix & ., ?., e++, e--, e1[e2], e1() , () & None & 16 \\
|
|
\hline
|
|
Unary prefix & -e, !e, \~{}e, ++e, --e & None & 15\\
|
|
\hline
|
|
Multiplicative & *, /, \~/, \% & Left & 14\\
|
|
\hline
|
|
Additive & +, - & Left & 13\\
|
|
\hline
|
|
Shift & $<<$, $>>$& Left & 12\\
|
|
\hline
|
|
Bitwise AND & \& & Left & 11\\
|
|
\hline
|
|
Bitwise XOR & \^{} & Left & 10\\
|
|
\hline
|
|
Bitwise Or & $|$ & Left & 9\\
|
|
\hline
|
|
Relational & <, >, $<=$, $>=$, \AS{}, \IS{}, \IS{}! & None & 8\\
|
|
\hline
|
|
Equality & ==, != & None & 7\\
|
|
\hline
|
|
Logical AND & \&\& & Left & 6\\
|
|
\hline
|
|
Logical Or & $||$ & Left & 5\\
|
|
\hline
|
|
If-null & ?? & Left & 4\\
|
|
\hline
|
|
Conditional & e1? e2: e3 & Right & 3\\
|
|
\hline
|
|
Cascade & .. & Left & 2\\
|
|
\hline
|
|
Assignment & =, *=, /=, +=, -= ,\&=, \^{}= etc. & Right & 1\\
|
|
\hline
|
|
\end{tabular}
|
|
}
|
|
%\subsection{Glossary}
|
|
%\LMLabel{glossary}
|
|
|
|
%\bibliographystyle{alpha}
|
|
%\bibliography{/users/gilad/research/bibs/master}
|
|
\section*{Appendix: Naming Conventions}
|
|
\LMLabel{namingConventions}
|
|
|
|
\commentary{
|
|
The following naming conventions are customary in Dart programs.
|
|
\begin{itemize}
|
|
\item The names of compile time constant variables never use lower case letters. If they consist of multiple words, those words are separated by underscores. Examples: PI, I\_AM\_A\_CONSTANT.
|
|
\item The names of functions (including getters, setters, methods and local or library functions) and non-constant variables begin with a lowercase letter. If the name consists of multiple words, each word (except the first) begins with an uppercase letter. No other uppercase letters are used. Examples: camlCase, dart4TheWorld
|
|
\item The names of types (including classes and type aliases) begin with an upper case letter. If the name consists of multiple words, each word begins with an uppercase letter. No other uppercase letters are used. Examples: CamlCase, Dart4TheWorld.
|
|
\item The names of type variables are short (preferably single letter). Examples: T, S, K, V , E.
|
|
\item The names of libraries or library prefixes never use upper case letters. If they consist of multiple words, those words are separated by underscores. Example: my\_favorite\_library.
|
|
\end{itemize}
|
|
}
|
|
|
|
|
|
\end{document}
|
|
|
|
[Text after \end{document} is ignored, hence we do not need "%"]
|
|
----------------------------------------------------------------------
|
|
|
|
* On Location Markers
|
|
|
|
This is a description of location markers, giving some information
|
|
about the underlying motivation and rationale, the actual
|
|
implementation, and the relevant tool support.
|
|
|
|
** What is a Location Marker?
|
|
|
|
In order to support more fine-grained update propagation from this
|
|
language specification to artifacts that depend on it, location
|
|
markers have been added. The idea is that each logical unit (section,
|
|
subsection, etc) and each paragraph containing normative text should
|
|
be addressable using these markers, such that source code (compilers
|
|
and other tools, tests, etc.) can contain location markers, and the
|
|
corresponding location in the spec may be looked up using standard
|
|
document viewer search features.
|
|
|
|
An SHA1 hash value of the text is associated with each location
|
|
marker, such that changes in the text will incur changes in this hash
|
|
value. Consequently, source code in tools/tests that depend on
|
|
specific parts of the spec may be flagged for revision by checking
|
|
whether these hash values have changed: If a given test T depends on
|
|
a paragraph with hash value V in the spec, and the search for V fails
|
|
in a new version of the spec, then that paragraph has changed and T
|
|
should be revisited and possible revised.
|
|
|
|
As a result, the search for parts of source code and similar artifacts
|
|
in likely need of updates because of spec changes can be performed
|
|
mechanically, which should help ensure that the conformance of all
|
|
artifacts depending on this spec is maintained more easily, and hence
|
|
more consistently. Note that it makes no difference whether the need
|
|
for an update has arisen in a very recent version of the spec or it
|
|
has existed for a long time, because the hash value just remains
|
|
different as long as the text is different from what it was when the
|
|
location marker was harvested from the spec.
|
|
|
|
** LaTeX Commands Supporting Location Markers
|
|
|
|
Concretely, this is based on the commands \LMHash and \LMLabel.
|
|
\LMHash{V} is used to add the text V in the margin, intended to mark
|
|
a paragraph of normative text with the SHA1 hash value of the text, V.
|
|
\LMLabel{L} has the effect of \label{L}, and moreover it shows the
|
|
text sec:L in the margin. In order to indicate a dependency on a
|
|
section or subsection an \LMLabel location marker is used, and in
|
|
order to indicate a dependency on a specific paragraph, the hash value
|
|
of that paragraph is used.
|
|
|
|
In this file, each normative paragraph has had the command \LMHash{}
|
|
added at the beginning, such that each of these paragraphs can be
|
|
decorated with their hash value. Similarly, all \section{}s,
|
|
\subsection{}s, \subsubsection{}s, and \paragraph{}s have had
|
|
their \label commands changed to \LMLabel, such that they are
|
|
decorated with logical names.
|
|
|
|
** Rationale
|
|
|
|
The design of location markers was proposed by Erik Ernst and
|
|
developed through discussions with several others, in particular Gilad
|
|
Bracha and Lars Bak. Some discussions along the way that gave rise to
|
|
the given design are outlined below.
|
|
|
|
The basic idea is that a hash value based on the actual text will
|
|
serve well to identify a piece of text, because it will change
|
|
whenever the text changes, and it remains the same if the text is
|
|
moved to a different location; in other words, it characterizes the
|
|
text itself, independently of the rest of the document. Hence:
|
|
|
|
- references to specific paragraphs in the spec are easy to create:
|
|
copy the marker and paste it into the source code (but see below
|
|
why this uses an extra indirection as far as possible)
|
|
|
|
- such references would be robust in the sense that they depend on
|
|
the actual text alone, i.e., they would not be invalidated by
|
|
updates to section numbers, relocation of the paragraph, or
|
|
updates to text in different paragraphs; as Lars mentioned, we
|
|
should use a "stripped" version of the text, removing comments,
|
|
normalizing white space, etc., which would make the refs even more
|
|
robust in case of "inessential" changes
|
|
|
|
- artifacts depending on a given part of the spec that was
|
|
changed could easily be pointed out: After an update to a
|
|
part of the spec, that artifact would hold a marker associated
|
|
with a hash value which does not any more occur in the spec,
|
|
maintainers of the artifact would then receive a notification
|
|
("test1773 depends on a part of the spec that was updated").
|
|
Nice tool support would show them the paragraph in the most recent
|
|
version of the spec as well as the old version that the artifact
|
|
used to depend on, and a comparison of the two would help
|
|
clarifying what needs fixing because of this change, if anything.
|
|
|
|
However, there is a conflict in this scenario: Lars pointed out that
|
|
it is very inconvenient to have to create a lot of revision control
|
|
commits (e.g., new versions of tests), just because a large number of
|
|
artifacts depend on a specific hash value that changed, if that change
|
|
has no real impact on each of those artifacts. The obvious solution
|
|
to this problem would be to use symbolic names and keep the actual
|
|
hash values out of the primary artifacts.
|
|
|
|
This approach has been used for \section{}s, \subsection{}s, etc., by
|
|
using their labels as location markers. For instance, dependency on
|
|
\subsubsection{New} would be marked as a dependency on 'sec:new',
|
|
which will (most likely) exist with the same label in the spec for a
|
|
long time. To detect a need for updates, the hash value associated
|
|
with \subsubsection{New} from the date of the latest check of this
|
|
kind to the dependent artifact should be compared with the current
|
|
hash value for the same \subsubsection{}: The artifact should be
|
|
revisited iff those hash values differ. As an easy approximation to
|
|
this scheme, the hash values for all location markers would be
|
|
computed for each spec update, and the location markers that have new
|
|
hash values should cause revisits to all artifacts depending on that
|
|
location marker.
|
|
|
|
The symbolic location markers on larger units like \section{}
|
|
etc. enable location marking in a hierarchical fashion: Dependencies
|
|
on a \subsubsection{} or on a \section{} can be chosen according to
|
|
the actual needs with each dependent artifact. In general, fine
|
|
granularity helps avoiding false positives, where an update somewhere
|
|
in a large unit will flag too many dependent artifacts for revisits.
|
|
In contrast, coarse granularity enables other artifacts to declare the
|
|
actual dependencies when small units would be impractical because the
|
|
artifact depends on so many of them. But there is a problem at the
|
|
bottom of this hierarchy, namely with paragraphs.
|
|
|
|
It would be very inconvenient to have to invent a logical name for
|
|
every paragraph. Similarly, using a simple paragraph numbering would
|
|
be unstable (add one new paragraph in the beginning of a section, and
|
|
all the rest have new numbers, creating a massive flood of false
|
|
update alerts, or, even worse, corrupting the declared dependencies in
|
|
artifacts because they point to the wrong paragraphs).
|
|
|
|
Hence, paragraphs have no other label than their actual hash value.
|
|
Artifacts that depend on very specific elements in the spec may
|
|
declare so by using an actual hash value for a given paragraph, and in
|
|
return they pay in terms of potential updates to the marker when that
|
|
paragraph changes, even in cases where the actual change makes no
|
|
difference for that particular artifact. This choice of granularity
|
|
vs. stability is up to the creator of each artifact.
|
|
|
|
** Maintenance of this document
|
|
|
|
The invariant that each normative paragraph is associated with a line
|
|
containing the text \LMHash{} should be maintained. Extra occurrences
|
|
of \LMHash{} can be added if needed, e.g., in order to make
|
|
individual \item{}s in itemized lists addressable. Each \LM.. command
|
|
must occur on a separate line. \LMHash{} must occur immediately
|
|
before the associated paragraph, and \LMLabel must occur immediately
|
|
after the associated \section{}, \subsection{} etc.
|
|
|
|
----------------------------------------------------------------------
|