blob: 9c11547a152395914d116090eae1d3dbe1433809 [file] [log] [blame]
Damien Martin-Guillerezf88f4d82015-09-25 13:56:55 +00001// Copyright 2014 The Bazel Authors. All rights reserved.
Han-Wen Nienhuysd08b27f2015-02-25 16:45:20 +01002//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14package com.google.devtools.build.lib.syntax;
15
Klaas Boesche0ec13b92015-11-06 12:16:03 +000016import com.google.common.base.Optional;
Han-Wen Nienhuysd08b27f2015-02-25 16:45:20 +010017import com.google.common.collect.ImmutableList;
Klaas Boesche0ec13b92015-11-06 12:16:03 +000018import com.google.devtools.build.lib.syntax.compiler.DebugInfo;
19import com.google.devtools.build.lib.syntax.compiler.LoopLabels;
20import com.google.devtools.build.lib.syntax.compiler.VariableScope;
21
22import net.bytebuddy.implementation.bytecode.ByteCodeAppender;
Han-Wen Nienhuysd08b27f2015-02-25 16:45:20 +010023
Francois-Rene Rideau5dcdbf92015-02-19 18:36:17 +000024import java.util.ArrayList;
Francois-Rene Rideau5dcdbf92015-02-19 18:36:17 +000025import java.util.List;
Han-Wen Nienhuysd08b27f2015-02-25 16:45:20 +010026
27/**
28 * Syntax node for a function definition.
29 */
30public class FunctionDefStatement extends Statement {
31
Florian Weikert6f864c32015-07-23 11:26:39 +000032 private final Identifier ident;
Laurent Le Brun4baefdc2015-09-04 11:27:46 +000033 private final FunctionSignature.WithValues<Expression, Expression> signature;
Han-Wen Nienhuysd08b27f2015-02-25 16:45:20 +010034 private final ImmutableList<Statement> statements;
Laurent Le Brun4baefdc2015-09-04 11:27:46 +000035 private final ImmutableList<Parameter<Expression, Expression>> parameters;
Han-Wen Nienhuysd08b27f2015-02-25 16:45:20 +010036
Florian Weikert6f864c32015-07-23 11:26:39 +000037 public FunctionDefStatement(Identifier ident,
Laurent Le Brun4baefdc2015-09-04 11:27:46 +000038 Iterable<Parameter<Expression, Expression>> parameters,
39 FunctionSignature.WithValues<Expression, Expression> signature,
40 Iterable<Statement> statements) {
Han-Wen Nienhuysd08b27f2015-02-25 16:45:20 +010041 this.ident = ident;
Laurent Le Brun4baefdc2015-09-04 11:27:46 +000042 this.signature = signature;
Han-Wen Nienhuysd08b27f2015-02-25 16:45:20 +010043 this.statements = ImmutableList.copyOf(statements);
Laurent Le Brun4baefdc2015-09-04 11:27:46 +000044 this.parameters = ImmutableList.copyOf(parameters);
Han-Wen Nienhuysd08b27f2015-02-25 16:45:20 +010045 }
46
47 @Override
Florian Weikert90a15962015-09-11 13:43:10 +000048 void doExec(Environment env) throws EvalException, InterruptedException {
Laurent Le Brun4baefdc2015-09-04 11:27:46 +000049 List<Expression> defaultExpressions = signature.getDefaultValues();
Francois-Rene Rideau5dcdbf92015-02-19 18:36:17 +000050 ArrayList<Object> defaultValues = null;
51 ArrayList<SkylarkType> types = null;
52
53 if (defaultExpressions != null) {
Ulf Adams07dba942015-03-05 14:47:37 +000054 defaultValues = new ArrayList<>(defaultExpressions.size());
Francois-Rene Rideau5dcdbf92015-02-19 18:36:17 +000055 for (Expression expr : defaultExpressions) {
56 defaultValues.add(expr.eval(env));
Han-Wen Nienhuysd08b27f2015-02-25 16:45:20 +010057 }
58 }
Francois-Rene Rideau89312fb2015-09-10 18:53:03 +000059 env.update(
60 ident.getName(),
61 new UserDefinedFunction(
62 ident,
63 FunctionSignature.WithValues.<Object, SkylarkType>create(
64 signature.getSignature(), defaultValues, types),
65 statements,
66 env.getGlobals()));
Han-Wen Nienhuysd08b27f2015-02-25 16:45:20 +010067 }
68
69 @Override
70 public String toString() {
Laurent Le Brun4baefdc2015-09-04 11:27:46 +000071 return "def " + ident + "(" + signature + "):\n";
Han-Wen Nienhuysd08b27f2015-02-25 16:45:20 +010072 }
73
Florian Weikert6f864c32015-07-23 11:26:39 +000074 public Identifier getIdent() {
Han-Wen Nienhuysd08b27f2015-02-25 16:45:20 +010075 return ident;
76 }
77
78 public ImmutableList<Statement> getStatements() {
79 return statements;
80 }
81
Laurent Le Brun4baefdc2015-09-04 11:27:46 +000082 public ImmutableList<Parameter<Expression, Expression>> getParameters() {
83 return parameters;
84 }
85
86 public FunctionSignature.WithValues<Expression, Expression> getSignature() {
87 return signature;
Han-Wen Nienhuysd08b27f2015-02-25 16:45:20 +010088 }
89
90 @Override
91 public void accept(SyntaxTreeVisitor visitor) {
92 visitor.visit(this);
93 }
94
95 @Override
Francois-Rene Rideau5dcdbf92015-02-19 18:36:17 +000096 void validate(final ValidationEnvironment env) throws EvalException {
Laurent Le Brun8d966f72015-04-15 18:47:34 +000097 ValidationEnvironment localEnv = new ValidationEnvironment(env);
Laurent Le Brun4baefdc2015-09-04 11:27:46 +000098 FunctionSignature sig = signature.getSignature();
Francois-Rene Rideau5dcdbf92015-02-19 18:36:17 +000099 FunctionSignature.Shape shape = sig.getShape();
100 ImmutableList<String> names = sig.getNames();
Laurent Le Brun4baefdc2015-09-04 11:27:46 +0000101 List<Expression> defaultExpressions = signature.getDefaultValues();
Francois-Rene Rideau5dcdbf92015-02-19 18:36:17 +0000102
103 int positionals = shape.getPositionals();
104 int mandatoryPositionals = shape.getMandatoryPositionals();
105 int namedOnly = shape.getNamedOnly();
106 int mandatoryNamedOnly = shape.getMandatoryNamedOnly();
107 boolean starArg = shape.hasStarArg();
Francois-Rene Rideau5dcdbf92015-02-19 18:36:17 +0000108 boolean kwArg = shape.hasKwArg();
109 int named = positionals + namedOnly;
110 int args = named + (starArg ? 1 : 0) + (kwArg ? 1 : 0);
111 int startOptionals = mandatoryPositionals;
112 int endOptionals = named - mandatoryNamedOnly;
Francois-Rene Rideau5dcdbf92015-02-19 18:36:17 +0000113
114 int j = 0; // index for the defaultExpressions
115 for (int i = 0; i < args; i++) {
116 String name = names.get(i);
Laurent Le Brun2e78d612015-04-15 09:06:46 +0000117 if (startOptionals <= i && i < endOptionals) {
118 defaultExpressions.get(j++).validate(env);
Han-Wen Nienhuysd08b27f2015-02-25 16:45:20 +0100119 }
Laurent Le Brun964d8d52015-04-13 12:15:04 +0000120 localEnv.declare(name, getLocation());
Han-Wen Nienhuysd08b27f2015-02-25 16:45:20 +0100121 }
122 for (Statement stmts : statements) {
123 stmts.validate(localEnv);
124 }
Han-Wen Nienhuysd08b27f2015-02-25 16:45:20 +0100125 }
Klaas Boesche0ec13b92015-11-06 12:16:03 +0000126
127 @Override
128 ByteCodeAppender compile(
129 VariableScope scope, Optional<LoopLabels> loopLabels, DebugInfo debugInfo) {
130 throw new UnsupportedOperationException(
131 "Skylark does not support nested function definitions"
132 + " and the current entry point for the compiler is UserDefinedFunction.");
133 }
Han-Wen Nienhuysd08b27f2015-02-25 16:45:20 +0100134}