/*
* This file is part of Skript.
*
* Skript is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Skript is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Skript. If not, see <http://www.gnu.org/licenses/>.
*
*
* Copyright 2011-2014 Peter Güttinger
*
*/
package ch.njol.skript.lang;
import java.lang.reflect.Array;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Iterator;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Map.Entry;
import java.util.NoSuchElementException;
import java.util.TreeMap;
import org.bukkit.event.Event;
import org.eclipse.jdt.annotation.Nullable;
import ch.njol.skript.Skript;
import ch.njol.skript.SkriptAPIException;
import ch.njol.skript.classes.Arithmetic;
import ch.njol.skript.classes.Changer;
import ch.njol.skript.classes.Changer.ChangeMode;
import ch.njol.skript.classes.Changer.ChangerUtils;
import ch.njol.skript.classes.ClassInfo;
import ch.njol.skript.classes.Comparator.Relation;
import ch.njol.skript.lang.SkriptParser.ParseResult;
import ch.njol.skript.lang.util.SimpleExpression;
import ch.njol.skript.registrations.Classes;
import ch.njol.skript.registrations.Comparators;
import ch.njol.skript.registrations.Converters;
import ch.njol.skript.util.StringMode;
import ch.njol.skript.util.Utils;
import ch.njol.skript.variables.Variables;
import ch.njol.util.Checker;
import ch.njol.util.Kleenean;
import ch.njol.util.Pair;
import ch.njol.util.StringUtils;
import ch.njol.util.coll.CollectionUtils;
import ch.njol.util.coll.iterator.EmptyIterator;
/**
* @author Peter Güttinger
*/
public class Variable<T> implements Expression<T> {
public final static String SEPARATOR = "::";
public final static String LOCAL_VARIABLE_TOKEN = "_";
/**
* The name of this variable, excluding the local variable token, but including the list variable token '::*'.
*/
private final VariableString name;
private final Class<T> superType;
final Class<? extends T>[] types;
final boolean local;
private final boolean list;
@Nullable
private final Variable<?> source;
@SuppressWarnings("unchecked")
private Variable(final VariableString name, final Class<? extends T>[] types, final boolean local, final boolean list, final @Nullable Variable<?> source) {
assert name != null;
assert types != null && types.length > 0;
assert name.isSimple() || name.getMode() == StringMode.VARIABLE_NAME;
this.local = local;
this.list = list;
this.name = name;
this.types = types;
this.superType = (Class<T>) Utils.getSuperType(types);
this.source = source;
}
/**
* Checks whether a string is a valid variable name. This is used to verify variable names as well as command and function arguments.
*
* @param name The name to test
* @param allowListVariable Whether to allow a list variable
* @param printErrors Whether to print errors when they are encountered
* @return true if the name is valid, false otherwise.
*/
public final static boolean isValidVariableName(String name, final boolean allowListVariable, final boolean printErrors) {
name = name.startsWith(LOCAL_VARIABLE_TOKEN) ? "" + name.substring(LOCAL_VARIABLE_TOKEN.length()).trim() : "" + name.trim();
if (!allowListVariable && name.contains(SEPARATOR)) {
if (printErrors)
Skript.error("List variables are not allowed here (error in variable {" + name + "})");
return false;
} else if (name.startsWith(SEPARATOR) || name.endsWith(SEPARATOR)) {
if (printErrors)
Skript.error("A variable's name must neither start nor end with the separator '" + SEPARATOR + "' (error in variable {" + name + "})");
return false;
} else if (name.contains("*") && (!allowListVariable || name.indexOf("*") != name.length() - 1 || !name.endsWith(SEPARATOR + "*"))) {
if (printErrors) {
if (name.indexOf("*") == 0)
Skript.error("[2.0] Local variables now start with an underscore, e.g. {_local variable}. The asterisk is reserved for list variables. (error in variable {" + name + "})");
else
Skript.error("A variable's name must not contain any asterisks except at the end after '" + SEPARATOR + "' to denote a list variable, e.g. {variable" + SEPARATOR + "*} (error in variable {" + name + "})");
}
return false;
} else if (name.contains(SEPARATOR + SEPARATOR)) {
if (printErrors)
Skript.error("A variable's name must not contain the separator '" + SEPARATOR + "' multiple times in a row (error in variable {" + name + "})");
return false;
}
return true;
}
/**
* Prints errors
*/
@Nullable
public static <T> Variable<T> newInstance(String name, final Class<? extends T>[] types) {
// if (name.startsWith(LOCAL_VARIABLE_TOKEN) && name.contains(SEPARATOR)) {
// Skript.error("Local variables cannot be lists, i.e. must not contain the separator '" + SEPARATOR + "' (error in variable {" + name + "})");
// return null;
// } else
name = "" + name.trim();
if (!isValidVariableName(name, true, true))
return null;
final VariableString vs = VariableString.newInstance(name.startsWith(LOCAL_VARIABLE_TOKEN) ? "" + name.substring(LOCAL_VARIABLE_TOKEN.length()).trim() : name, StringMode.VARIABLE_NAME);
if (vs == null)
return null;
return new Variable<T>(vs, types, name.startsWith(LOCAL_VARIABLE_TOKEN), name.endsWith(SEPARATOR + "*"), null);
}
@Override
public boolean init(final Expression<?>[] exprs, final int matchedPattern, final Kleenean isDelayed, final ParseResult parseResult) {
throw new UnsupportedOperationException();
}
public boolean isLocal() {
return local;
}
public boolean isList() {
return list;
}
@Override
public boolean isSingle() {
return !list;
}
@Override
public Class<? extends T> getReturnType() {
return superType;
}
@Override
public String toString(final @Nullable Event e, final boolean debug) {
if (e != null)
return Classes.toString(get(e));
return "{" + (local ? "_" : "") + StringUtils.substring(name.toString(e, debug), 1, -1) + "}" + (debug ? "(as " + superType.getName() + ")" : "");
}
@Override
public String toString() {
return toString(null, false);
}
@Override
public <R> Variable<R> getConvertedExpression(final Class<R>... to) {
return new Variable<R>(name, to, local, list, this);
}
/**
* Gets the value of this variable as stored in the variables map.
*/
@Nullable
private Object getRaw(final Event e) {
final String n = name.toString(e).toLowerCase(Locale.ENGLISH);
if (n.endsWith(Variable.SEPARATOR + "*") != list) // prevents e.g. {%expr%} where "%expr%" ends with "::*" from returning a Map
return null;
final Object val = Variables.getVariable(n, e, local);
if (val == null)
return Variables.getVariable((local ? LOCAL_VARIABLE_TOKEN : "") + name.getDefaultVariableName().toLowerCase(Locale.ENGLISH), e, false);
return val;
}
@SuppressWarnings("unchecked")
@Nullable
private Object get(final Event e) {
final Object val = getRaw(e);
if (!list)
return val;
if (val == null)
return Array.newInstance(types[0], 0);
final List<Object> l = new ArrayList<Object>();
for (final Entry<String, ?> v : ((Map<String, ?>) val).entrySet()) {
if (v.getKey() != null && v.getValue() != null) {
if (v.getValue() instanceof Map)
l.add(((Map<String, ?>) v.getValue()).get(null));
else
l.add(v.getValue());
}
}
return l.toArray();
}
public Iterator<Pair<String, Object>> variablesIterator(final Event e) {
if (!list)
throw new SkriptAPIException("Looping a non-list variable");
final String name = StringUtils.substring(this.name.toString(e), 0, -1).toLowerCase(Locale.ENGLISH);
final Object val = Variables.getVariable(name + "*", e, local);
if (val == null)
return new EmptyIterator<Pair<String, Object>>();
assert val instanceof TreeMap;
// temporary list to prevent CMEs
@SuppressWarnings("unchecked")
final Iterator<String> keys = new ArrayList<String>(((Map<String, Object>) val).keySet()).iterator();
return new Iterator<Pair<String, Object>>() {
@Nullable
private String key;
@Nullable
private Object next = null;
@Override
public boolean hasNext() {
if (next != null)
return true;
while (keys.hasNext()) {
key = keys.next();
if (key != null) {
next = Variables.getVariable(name + key, e, local);
if (next != null && !(next instanceof TreeMap))
return true;
}
}
next = null;
return false;
}
@Override
public Pair<String, Object> next() {
if (!hasNext())
throw new NoSuchElementException();
final Pair<String, Object> n = new Pair<String, Object>(key, next);
next = null;
return n;
}
@Override
public void remove() {
throw new UnsupportedOperationException();
}
};
}
@Override
public Iterator<T> iterator(final Event e) {
if (!list)
throw new SkriptAPIException("");
final String name = StringUtils.substring(this.name.toString(e), 0, -1).toLowerCase(Locale.ENGLISH);
final Object val = Variables.getVariable(name + "*", e, local);
if (val == null)
return new EmptyIterator<T>();
assert val instanceof TreeMap;
// temporary list to prevent CMEs
@SuppressWarnings("unchecked")
final Iterator<String> keys = new ArrayList<String>(((Map<String, Object>) val).keySet()).iterator();
return new Iterator<T>() {
@Nullable
private String key;
@Nullable
private T next = null;
@Override
public boolean hasNext() {
if (next != null)
return true;
while (keys.hasNext()) {
key = keys.next();
if (key != null) {
next = Converters.convert(Variables.getVariable(name + key, e, local), types);
if (next != null && !(next instanceof TreeMap))
return true;
}
}
next = null;
return false;
}
@Override
public T next() {
if (!hasNext())
throw new NoSuchElementException();
final T n = next;
assert n != null;
next = null;
return n;
}
@Override
public void remove() {
throw new UnsupportedOperationException();
}
};
}
@Nullable
private T getConverted(final Event e) {
assert !list;
return Converters.convert(get(e), types);
}
private T[] getConvertedArray(final Event e) {
assert list;
return Converters.convertArray((Object[]) get(e), types, superType);
}
private final void set(final Event e, final @Nullable Object value) {
Variables.setVariable("" + name.toString(e).toLowerCase(Locale.ENGLISH), value, e, local);
}
private final void setIndex(final Event e, final String index, final @Nullable Object value) {
assert list;
final String s = name.toString(e).toLowerCase(Locale.ENGLISH);
assert s.endsWith("::*") : s + "; " + name;
Variables.setVariable(s.substring(0, s.length() - 1) + index.toLowerCase(Locale.ENGLISH), value, e, local);
}
@SuppressWarnings("unchecked")
@Override
public Class<?>[] acceptChange(final ChangeMode mode) {
if (!list && mode == ChangeMode.SET)
return CollectionUtils.array(Object.class);
return CollectionUtils.array(Object[].class);
}
@SuppressWarnings({"unchecked", "rawtypes"})
@Override
public void change(final Event e, final @Nullable Object[] delta, final ChangeMode mode) throws UnsupportedOperationException {
switch (mode) {
case DELETE:
set(e, null);
break;
case SET:
assert delta != null;
if (list) {
set(e, null);
int i = 1;
for (final Object d : delta) {
if (d instanceof Object[]) {
for (int j = 0; j < ((Object[]) d).length; j++)
setIndex(e, "" + i + SEPARATOR + j, ((Object[]) d)[j]);
} else {
setIndex(e, "" + i, d);
}
i++;
}
} else {
// final ClassInfo<?> ci = delta == null ? null : Classes.getSuperClassInfo(delta.getClass());
// if (ci != null && ci.getSerializeAs() != null) {
// set(e, Converters.convert(delta, ci.getSerializeAs()));
// } else {
set(e, delta[0]);
// }
}
break;
case RESET:
final Object x = getRaw(e);
if (x == null)
return;
for (final Object o : x instanceof Map ? ((Map<?, ?>) x).values() : Arrays.asList(x)) {
final Class<?> c = o.getClass();
assert c != null;
final ClassInfo<?> ci = Classes.getSuperClassInfo(c);
final Changer<?> changer = ci.getChanger();
if (changer != null && changer.acceptChange(ChangeMode.RESET) != null) {
final Object[] one = (Object[]) Array.newInstance(o.getClass(), 1);
one[0] = o;
((Changer) changer).change(one, null, ChangeMode.RESET);
}
}
break;
case ADD:
case REMOVE:
case REMOVE_ALL:
assert delta != null;
if (list) {
final Map<String, Object> o = (Map<String, Object>) getRaw(e);
if (mode == ChangeMode.REMOVE) {
if (o == null)
return;
final ArrayList<String> rem = new ArrayList<String>(); // prevents CMEs
for (final Object d : delta) {
for (final Entry<String, Object> i : o.entrySet()) {
if (Relation.EQUAL.is(Comparators.compare(i.getValue(), d))) {
rem.add(i.getKey());
break;
}
}
}
for (final String r : rem) {
assert r != null;
setIndex(e, r, null);
}
} else if (mode == ChangeMode.REMOVE_ALL) {
if (o == null)
return;
final ArrayList<String> rem = new ArrayList<String>(); // prevents CMEs
for (final Entry<String, Object> i : o.entrySet()) {
for (final Object d : delta) {
if (Relation.EQUAL.is(Comparators.compare(i.getValue(), d)))
rem.add(i.getKey());
}
}
for (final String r : rem) {
assert r != null;
setIndex(e, r, null);
}
} else {
assert mode == ChangeMode.ADD;
int i = 1;
for (final Object d : delta) {
if (o != null)
while (o.containsKey("" + i))
i++;
setIndex(e, "" + i, d);
i++;
}
}
} else {
Object o = get(e);
ClassInfo<?> ci;
if (o == null) {
ci = null;
} else {
final Class<?> c = o.getClass();
assert c != null;
ci = Classes.getSuperClassInfo(c);
}
Arithmetic a = null;
final Changer<?> changer;
final Class<?>[] cs;
if (o == null || ci == null || (a = ci.getMath()) != null) {
boolean changed = false;
for (final Object d : delta) {
if (o == null || ci == null) {
final Class<?> c = d.getClass();
assert c != null;
ci = Classes.getSuperClassInfo(c);
if (ci.getMath() != null)
o = d;
changed = true;
continue;
}
final Class<?> r = ci.getMathRelativeType();
assert a != null && r != null : ci;
final Object diff = Converters.convert(d, r);
if (diff != null) {
if (mode == ChangeMode.ADD)
o = a.add(o, diff);
else
o = a.subtract(o, diff);
changed = true;
}
}
if (changed)
set(e, o);
} else if ((changer = ci.getChanger()) != null && (cs = changer.acceptChange(mode)) != null) {
final Object[] one = (Object[]) Array.newInstance(o.getClass(), 1);
one[0] = o;
final Class<?>[] cs2 = new Class<?>[cs.length];
for (int i = 0; i < cs.length; i++)
cs2[i] = cs[i].isArray() ? cs[i].getComponentType() : cs[i];
final ArrayList<Object> l = new ArrayList<Object>();
for (final Object d : delta) {
final Object d2 = Converters.convert(d, cs2);
if (d2 != null)
l.add(d2);
}
ChangerUtils.change(changer, one, l.toArray(), mode);
}
}
break;
}
}
@Override
@Nullable
public T getSingle(final Event e) {
if (list)
throw new SkriptAPIException("Invalid call to getSingle");
return getConverted(e);
}
@Override
public T[] getArray(final Event e) {
return getAll(e);
}
@SuppressWarnings("unchecked")
@Override
public T[] getAll(final Event e) {
if (list)
return getConvertedArray(e);
final T o = getConverted(e);
if (o == null) {
final T[] r = (T[]) Array.newInstance(superType, 0);
assert r != null;
return r;
}
final T[] one = (T[]) Array.newInstance(superType, 1);
one[0] = o;
return one;
}
@Override
public boolean isLoopOf(final String s) {
return s.equalsIgnoreCase("var") || s.equalsIgnoreCase("variable") || s.equalsIgnoreCase("value") || s.equalsIgnoreCase("index");
}
public boolean isIndexLoop(final String s) {
return s.equalsIgnoreCase("index");
}
@Override
public boolean check(final Event e, final Checker<? super T> c, final boolean negated) {
return SimpleExpression.check(getAll(e), c, negated, getAnd());
}
@Override
public boolean check(final Event e, final Checker<? super T> c) {
return SimpleExpression.check(getAll(e), c, false, getAnd());
}
@Override
public boolean getAnd() {
return true;
}
@Override
public boolean setTime(final int time) {
return false;
}
@Override
public int getTime() {
return 0;
}
@Override
public boolean isDefault() {
return false;
}
@Override
public Expression<?> getSource() {
final Variable<?> s = source;
return s == null ? this : s;
}
@Override
public Expression<? extends T> simplify() {
return this;
}
}