| // Copyright 2014 The Bazel Authors. All rights reserved. | |
| // | |
| // Licensed under the Apache License, Version 2.0 (the "License"); | |
| // you may not use this file except in compliance with the License. | |
| // You may obtain a copy of the License at | |
| // | |
| // http://www.apache.org/licenses/LICENSE-2.0 | |
| // | |
| // Unless required by applicable law or agreed to in writing, software | |
| // distributed under the License is distributed on an "AS IS" BASIS, | |
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
| // See the License for the specific language governing permissions and | |
| // limitations under the License. | |
| package com.google.devtools.build.lib.syntax; | |
| import com.google.common.base.Preconditions; | |
| import com.google.common.collect.ImmutableList; | |
| import java.util.List; | |
| import java.util.RandomAccess; | |
| import net.starlark.java.annot.StarlarkBuiltin; | |
| import net.starlark.java.annot.StarlarkDocumentationCategory; | |
| /** | |
| * A Sequence is a finite iterable sequence of Starlark values, such as a list or tuple. | |
| * | |
| * <p>Sequences implement the read-only operations of the {@link List} interface, but not its update | |
| * operations, similar to {@code ImmutableList}. The specification of {@code List} governs how such | |
| * methods behave and in particular how they report errors. Subclasses of sequence may define ad-hoc | |
| * mutator methods, such as {@link StarlarkList#extend}, exposed to Starlark, or Java, or both. | |
| * | |
| * <p>In principle, subclasses of Sequence could also define the standard update operations of List, | |
| * but there appears to be little demand, and doing so carries some risk of obscuring unintended | |
| * mutations to Starlark values that would currently cause the program to crash. | |
| */ | |
| @StarlarkBuiltin( | |
| name = "sequence", | |
| documented = false, | |
| category = StarlarkDocumentationCategory.BUILTIN, | |
| doc = "common type of lists and tuples.") | |
| public interface Sequence<E> | |
| extends StarlarkValue, List<E>, RandomAccess, StarlarkIndexable, StarlarkIterable<E> { | |
| @Override | |
| default boolean truth() { | |
| return !isEmpty(); | |
| } | |
| /** Returns an ImmutableList object with the current underlying contents of this Sequence. */ | |
| default ImmutableList<E> getImmutableList() { | |
| return ImmutableList.copyOf(this); | |
| } | |
| /** Retrieves an entry from a Sequence. */ | |
| @Override | |
| default E getIndex(StarlarkSemantics semantics, Object key) throws EvalException { | |
| int index = Starlark.toInt(key, "sequence index"); | |
| return get(EvalUtils.getSequenceIndex(index, size())); | |
| } | |
| @Override | |
| default boolean containsKey(StarlarkSemantics semantics, Object key) throws EvalException { | |
| return contains(key); | |
| } | |
| /** | |
| * Returns the slice of this sequence, {@code this[start:stop:step]}. <br> | |
| * For positive strides ({@code step > 0}), {@code 0 <= start <= stop <= size()}. <br> | |
| * For negative strides ({@code step < 0}), {@code -1 <= stop <= start < size()}. <br> | |
| * The caller must ensure that the start and stop indices are valid and that step is non-zero. | |
| */ | |
| Sequence<E> getSlice(Mutability mu, int start, int stop, int step); | |
| /** | |
| * Casts a non-null Starlark value {@code x} to a {@code Sequence<T>}, after checking that each | |
| * element is an instance of {@code elemType}. On error, it throws an EvalException whose message | |
| * includes {@code what}, ideally a string literal, as a description of the role of {@code x}. | |
| */ | |
| public static <T> Sequence<T> cast(Object x, Class<T> elemType, String what) | |
| throws EvalException { | |
| Preconditions.checkNotNull(x); | |
| if (!(x instanceof Sequence)) { | |
| throw Starlark.errorf("for %s, got %s, want sequence", what, Starlark.type(x)); | |
| } | |
| int i = 0; | |
| for (Object elem : (Sequence) x) { | |
| if (!elemType.isAssignableFrom(elem.getClass())) { | |
| throw Starlark.errorf( | |
| "at index %d of %s, got element of type %s, want %s", | |
| i, what, Starlark.type(elem), Starlark.classType(elemType)); | |
| } | |
| } | |
| @SuppressWarnings("unchecked") // safe | |
| Sequence<T> result = (Sequence) x; | |
| return result; | |
| } | |
| /** Like {@link #cast}, but if x is None, returns an immutable empty list. */ | |
| public static <T> Sequence<T> noneableCast(Object x, Class<T> type, String what) | |
| throws EvalException { | |
| return x == Starlark.NONE ? StarlarkList.empty() : cast(x, type, what); | |
| } | |
| } |