Damien Martin-Guillerez | f88f4d8 | 2015-09-25 13:56:55 +0000 | [diff] [blame] | 1 | // Copyright 2014 The Bazel Authors. All rights reserved. |
Han-Wen Nienhuys | d08b27f | 2015-02-25 16:45:20 +0100 | [diff] [blame] | 2 | // |
| 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. |
| 14 | package com.google.devtools.build.lib.syntax; |
| 15 | |
tomlu | a155b53 | 2017-11-08 20:12:47 +0100 | [diff] [blame] | 16 | import com.google.common.base.Preconditions; |
Francois-Rene Rideau | 5dcdbf9 | 2015-02-19 18:36:17 +0000 | [diff] [blame] | 17 | import javax.annotation.Nullable; |
| 18 | |
Han-Wen Nienhuys | d08b27f | 2015-02-25 16:45:20 +0100 | [diff] [blame] | 19 | /** |
Googler | 73d942f | 2019-10-03 12:31:02 -0700 | [diff] [blame] | 20 | * Syntax node for an argument to a function. |
Francois-Rene Rideau | 5dcdbf9 | 2015-02-19 18:36:17 +0000 | [diff] [blame] | 21 | * |
Googler | 73d942f | 2019-10-03 12:31:02 -0700 | [diff] [blame] | 22 | * <p>Arguments may be of four forms, as in {@code f(expr, id=expr, *expr, **expr)}. These are |
| 23 | * represented by the subclasses Positional, Keyword, Star, and StarStar. |
Han-Wen Nienhuys | d08b27f | 2015-02-25 16:45:20 +0100 | [diff] [blame] | 24 | */ |
Googler | 4ace465 | 2019-09-16 07:47:08 -0700 | [diff] [blame] | 25 | public abstract class Argument extends Node { |
Han-Wen Nienhuys | d08b27f | 2015-02-25 16:45:20 +0100 | [diff] [blame] | 26 | |
adonovan | 07b15e6 | 2020-04-09 18:32:33 -0700 | [diff] [blame^] | 27 | protected final Expression value; |
Googler | 73d942f | 2019-10-03 12:31:02 -0700 | [diff] [blame] | 28 | |
| 29 | Argument(Expression value) { |
| 30 | this.value = Preconditions.checkNotNull(value); |
Han-Wen Nienhuys | d08b27f | 2015-02-25 16:45:20 +0100 | [diff] [blame] | 31 | } |
| 32 | |
Googler | 73d942f | 2019-10-03 12:31:02 -0700 | [diff] [blame] | 33 | public final Expression getValue() { |
| 34 | return value; |
Han-Wen Nienhuys | d08b27f | 2015-02-25 16:45:20 +0100 | [diff] [blame] | 35 | } |
| 36 | |
adonovan | 07b15e6 | 2020-04-09 18:32:33 -0700 | [diff] [blame^] | 37 | @Override |
| 38 | public int getEndOffset() { |
| 39 | return value.getEndOffset(); |
| 40 | } |
| 41 | |
Googler | 73d942f | 2019-10-03 12:31:02 -0700 | [diff] [blame] | 42 | /** Return the name of this argument's parameter, or null if it is not a Keyword argument. */ |
| 43 | @Nullable |
| 44 | public String getName() { |
| 45 | return null; |
Francois-Rene Rideau | 5dcdbf9 | 2015-02-19 18:36:17 +0000 | [diff] [blame] | 46 | } |
| 47 | |
Googler | 73d942f | 2019-10-03 12:31:02 -0700 | [diff] [blame] | 48 | /** Syntax node for a positional argument, {@code f(expr)}. */ |
| 49 | public static final class Positional extends Argument { |
Googler | e0c5e62 | 2019-08-09 15:10:14 -0700 | [diff] [blame] | 50 | Positional(Expression value) { |
Francois-Rene Rideau | 5dcdbf9 | 2015-02-19 18:36:17 +0000 | [diff] [blame] | 51 | super(value); |
| 52 | } |
adonovan | 07b15e6 | 2020-04-09 18:32:33 -0700 | [diff] [blame^] | 53 | |
| 54 | @Override |
| 55 | public int getStartOffset() { |
| 56 | return value.getStartOffset(); |
| 57 | } |
Francois-Rene Rideau | 5dcdbf9 | 2015-02-19 18:36:17 +0000 | [diff] [blame] | 58 | } |
| 59 | |
Googler | 73d942f | 2019-10-03 12:31:02 -0700 | [diff] [blame] | 60 | /** Syntax node for a keyword argument, {@code f(id=expr)}. */ |
| 61 | public static final class Keyword extends Argument { |
| 62 | |
| 63 | // Unlike in Python, keyword arguments in Bazel BUILD files |
| 64 | // are about 10x more numerous than positional arguments. |
Francois-Rene Rideau | 5dcdbf9 | 2015-02-19 18:36:17 +0000 | [diff] [blame] | 65 | |
adonovan | 07b15e6 | 2020-04-09 18:32:33 -0700 | [diff] [blame^] | 66 | final Identifier id; |
Francois-Rene Rideau | 5dcdbf9 | 2015-02-19 18:36:17 +0000 | [diff] [blame] | 67 | |
adonovan | 07b15e6 | 2020-04-09 18:32:33 -0700 | [diff] [blame^] | 68 | Keyword(Identifier id, Expression value) { |
Francois-Rene Rideau | 5dcdbf9 | 2015-02-19 18:36:17 +0000 | [diff] [blame] | 69 | super(value); |
adonovan | 07b15e6 | 2020-04-09 18:32:33 -0700 | [diff] [blame^] | 70 | this.id = id; |
Francois-Rene Rideau | 5dcdbf9 | 2015-02-19 18:36:17 +0000 | [diff] [blame] | 71 | } |
| 72 | |
Googler | 73d942f | 2019-10-03 12:31:02 -0700 | [diff] [blame] | 73 | public Identifier getIdentifier() { |
adonovan | 07b15e6 | 2020-04-09 18:32:33 -0700 | [diff] [blame^] | 74 | return id; |
Googler | 73d942f | 2019-10-03 12:31:02 -0700 | [diff] [blame] | 75 | } |
| 76 | |
brandjon | e2ffd5d | 2017-06-27 18:14:54 +0200 | [diff] [blame] | 77 | @Override |
| 78 | public String getName() { |
adonovan | 07b15e6 | 2020-04-09 18:32:33 -0700 | [diff] [blame^] | 79 | return id.getName(); |
| 80 | } |
| 81 | |
| 82 | @Override |
| 83 | public int getStartOffset() { |
| 84 | return id.getStartOffset(); |
Taras Tsugrii | 3694136 | 2018-06-08 16:31:53 -0700 | [diff] [blame] | 85 | } |
Francois-Rene Rideau | 5dcdbf9 | 2015-02-19 18:36:17 +0000 | [diff] [blame] | 86 | } |
| 87 | |
Googler | 73d942f | 2019-10-03 12:31:02 -0700 | [diff] [blame] | 88 | /** Syntax node for an argument of the form {@code f(*expr)}. */ |
| 89 | public static final class Star extends Argument { |
adonovan | 07b15e6 | 2020-04-09 18:32:33 -0700 | [diff] [blame^] | 90 | private final int starOffset; |
| 91 | |
| 92 | Star(int starOffset, Expression value) { |
Francois-Rene Rideau | 5dcdbf9 | 2015-02-19 18:36:17 +0000 | [diff] [blame] | 93 | super(value); |
adonovan | 07b15e6 | 2020-04-09 18:32:33 -0700 | [diff] [blame^] | 94 | this.starOffset = starOffset; |
| 95 | } |
| 96 | |
| 97 | @Override |
| 98 | public int getStartOffset() { |
| 99 | return starOffset; |
Francois-Rene Rideau | 5dcdbf9 | 2015-02-19 18:36:17 +0000 | [diff] [blame] | 100 | } |
Francois-Rene Rideau | 5dcdbf9 | 2015-02-19 18:36:17 +0000 | [diff] [blame] | 101 | } |
| 102 | |
Googler | 73d942f | 2019-10-03 12:31:02 -0700 | [diff] [blame] | 103 | /** Syntax node for an argument of the form {@code f(**expr)}. */ |
| 104 | public static final class StarStar extends Argument { |
adonovan | 07b15e6 | 2020-04-09 18:32:33 -0700 | [diff] [blame^] | 105 | private final int starStarOffset; |
| 106 | |
| 107 | StarStar(int starStarOffset, Expression value) { |
Francois-Rene Rideau | 5dcdbf9 | 2015-02-19 18:36:17 +0000 | [diff] [blame] | 108 | super(value); |
adonovan | 07b15e6 | 2020-04-09 18:32:33 -0700 | [diff] [blame^] | 109 | this.starStarOffset = starStarOffset; |
| 110 | } |
| 111 | |
| 112 | @Override |
| 113 | public int getStartOffset() { |
| 114 | return starStarOffset; |
Francois-Rene Rideau | 5dcdbf9 | 2015-02-19 18:36:17 +0000 | [diff] [blame] | 115 | } |
laurentlb | 1e5352d | 2018-11-06 12:25:55 -0800 | [diff] [blame] | 116 | } |
| 117 | |
brandjon | e2ffd5d | 2017-06-27 18:14:54 +0200 | [diff] [blame] | 118 | @Override |
Googler | 73d942f | 2019-10-03 12:31:02 -0700 | [diff] [blame] | 119 | public void accept(NodeVisitor visitor) { |
| 120 | visitor.visit(this); |
| 121 | } |
Han-Wen Nienhuys | d08b27f | 2015-02-25 16:45:20 +0100 | [diff] [blame] | 122 | } |