Config navigation syntax.

src/main/java/ch/njol/skript/SkriptConfig.java

@@ -40,7 +40,7 @@
 
 /**
  * Important: don't save values from the config, a '/skript reload config/configs/all' won't work correctly otherwise!
- * 
+ *
  * @author Peter Güttinger
  */
 @SuppressWarnings("unused")
@@ -80,18 +80,18 @@ public static EventRegistry<Event> eventRegistry() {
 	@Nullable
 	static Config mainConfig;
 	static Collection<Config> configs = new ArrayList<>();
-	
+
 	static final Option<String> version = new Option<>("version", Skript.getVersion().toString())
 			.optional(true);
-	
+
 	public static final Option<String> language = new Option<>("language", "english")
 			.optional(true)
 			.setter(s -> {
 				if (!Language.load(s)) {
 					Skript.error("No language file found for '" + s + "'!");
 				}
 			});
-	
+
 	public static final Option<Boolean> checkForNewVersion = new Option<>("check for new version", false)
 			.setter(t -> {
 				SkriptUpdater updater = Skript.getInstance().getUpdater();
@@ -147,10 +147,10 @@ public static EventRegistry<Event> eventRegistry() {
 
 	// everything handled by Variables
 	public static final OptionSection databases = new OptionSection("databases");
-	
+
 	public static final Option<Boolean> usePlayerUUIDsInVariableNames = new Option<>("use player UUIDs in variable names", false); // TODO change to true later (as well as in the default config)
 	public static final Option<Boolean> enablePlayerVariableFix = new Option<>("player variable fix", true);
-	
+
 	@SuppressWarnings("null")
 	private static final DateFormat shortDateFormat = DateFormat.getDateTimeInstance(DateFormat.SHORT, DateFormat.SHORT);
 	public static final Option<DateFormat> dateFormat = new Option<>("date format", shortDateFormat, s -> {
@@ -163,17 +163,17 @@ public static EventRegistry<Event> eventRegistry() {
 		}
 		return null;
 	});
-	
+
 	public static String formatDate(final long timestamp) {
 		final DateFormat f = dateFormat.value();
 		synchronized (f) {
 			return "" + f.format(timestamp);
 		}
 	}
-	
+
 	public static final Option<Verbosity> verbosity = new Option<>("verbosity", Verbosity.NORMAL, new EnumParser<>(Verbosity.class, "verbosity"))
 			.setter(SkriptLogger::setVerbosity);
-	
+
 	public static final Option<EventPriority> defaultEventPriority = new Option<>("plugin priority", EventPriority.NORMAL, s -> {
 		try {
 			return EventPriority.valueOf(s.toUpperCase(Locale.ENGLISH));
@@ -189,14 +189,14 @@ public static String formatDate(final long timestamp) {
 	public static final Option<Boolean> listenCancelledByDefault = new Option<>("listen to cancelled events by default", false)
 			.optional(true);
 
-	
+
 	/**
 	 * Maximum number of digits to display after the period for floats and doubles
 	 */
 	public static final Option<Integer> numberAccuracy = new Option<>("number accuracy", 2);
-	
+
 	public static final Option<Integer> maxTargetBlockDistance = new Option<>("maximum target block distance", 100);
-	
+
 	public static final Option<Boolean> caseSensitive = new Option<>("case sensitive", false);
 	public static final Option<Boolean> allowFunctionsBeforeDefs = new Option<>("allow function calls before definations", false)
 			.optional(true);
@@ -206,19 +206,19 @@ public static String formatDate(final long timestamp) {
 	public static final Option<Boolean> disableVariableStartingWithExpressionWarnings =
 		new Option<>("disable starting a variable's name with an expression warnings", false);
 	public static final Option<Boolean> disableUnreachableCodeWarnings = new Option<>("disable unreachable code warnings", false);
-	
+
 	@Deprecated
 	public static final Option<Boolean> enableScriptCaching = new Option<>("enable script caching", false)
 			.optional(true);
-	
+
 	public static final Option<Boolean> keepConfigsLoaded = new Option<>("keep configs loaded", false)
 			.optional(true);
-	
+
 	public static final Option<Boolean> addonSafetyChecks = new Option<>("addon safety checks", false)
 			.optional(true);
-	
+
 	public static final Option<Boolean> apiSoftExceptions = new Option<>("soft api exceptions", false);
-	
+
 	public static final Option<Boolean> enableTimings = new Option<>("enable timings", false)
 			.setter(t -> {
 				if (!Skript.classExists("co.aikar.timings.Timings")) { // Check for Timings
@@ -238,7 +238,7 @@ public static String formatDate(final long timestamp) {
 					Skript.info("Timings support enabled!");
 				SkriptTimings.setEnabled(t); // Config option will be used
 			});
-	
+
 	public static final Option<String> parseLinks = new Option<>("parse links in chat messages", "disabled")
 			.setter(t -> {
 				try {
@@ -268,7 +268,7 @@ public static String formatDate(final long timestamp) {
 
 	public static final Option<Boolean> caseInsensitiveCommands = new Option<>("case-insensitive commands", false)
 		.optional(true);
-	
+
 	public static final Option<Boolean> colorResetCodes = new Option<>("color codes reset formatting", true)
 			.setter(t -> {
 				try {
@@ -281,7 +281,7 @@ public static String formatDate(final long timestamp) {
 	public static final Option<String> scriptLoaderThreadSize = new Option<>("script loader thread size", "0")
 			.setter(s -> {
 				int asyncLoaderSize;
-				
+
 				if (s.equalsIgnoreCase("processor count")) {
 					asyncLoaderSize = Runtime.getRuntime().availableProcessors();
 				} else {
@@ -292,17 +292,17 @@ public static String formatDate(final long timestamp) {
 						return;
 					}
 				}
-				
+
 				ScriptLoader.setAsyncLoaderSize(asyncLoaderSize);
 			})
 			.optional(true);
-	
+
 	public static final Option<Boolean> allowUnsafePlatforms = new Option<>("allow unsafe platforms", false)
 			.optional(true);
 
 	public static final Option<Boolean> keepLastUsageDates = new Option<>("keep command last usage dates", false)
 			.optional(true);
-	
+
 	public static final Option<Boolean> loadDefaultAliases = new Option<>("load default aliases", true)
 			.optional(true);
 
@@ -367,10 +367,10 @@ private static void userDisableHooks(Class<? extends Hook<?>> hookClass, boolean
 		return mainConfig;
 	}
 
-	/**
-	 * Reloads the main config file.
-	 */
+	// also used for reloading
 	static void load() {
+		if (mainConfig != null)
+			mainConfig.invalidate(); // todo
 		try {
 			File configFile = new File(Skript.getInstance().getDataFolder(), "config.sk");
 
@@ -392,7 +392,7 @@ static void load() {
 			}
 			SkriptConfig.mainConfig = mainConfig;
 
-			String configVersion = mainConfig.get(version.key);
+			String configVersion = mainConfig.getValue(version.key);
 			if (configVersion == null || Skript.getVersion().compareTo(new Version(configVersion)) != 0) {
 				if (!mainConfig.getMainNode().isValid()) {
 					Skript.error("Your config is outdated, but cannot be updated because it contains errors.");

src/main/java/ch/njol/skript/classes/data/DefaultConverters.java

@@ -3,6 +3,8 @@
 import ch.njol.skript.Skript;
 import ch.njol.skript.aliases.ItemType;
 import ch.njol.skript.command.Commands;
+import ch.njol.skript.config.Config;
+import ch.njol.skript.config.Node;
 import ch.njol.skript.entity.EntityData;
 import ch.njol.skript.entity.EntityType;
 import ch.njol.skript.entity.XpOrbData;
@@ -37,6 +39,7 @@
 import org.jetbrains.annotations.UnknownNullability;
 import org.skriptlang.skript.lang.converter.Converter;
 import org.skriptlang.skript.lang.converter.Converters;
+import org.skriptlang.skript.lang.script.Script;
 
 public class DefaultConverters {
 
@@ -267,6 +270,10 @@ public void setAmount(Number amount) {
 
 		Converters.registerConverter(String.class, World.class, Bukkit::getWorld);
 
+		// Script -> Config & Node
+		Converters.registerConverter(Script.class, Config.class, Script::getConfig);
+		Converters.registerConverter(Config.class, Node.class, Config::getMainNode);
+
 //		// Entity - String (UUID) // Very slow, thus disabled for now
 //		Converters.registerConverter(String.class, Entity.class, new Converter<String, Entity>() {
 //

src/main/java/ch/njol/skript/classes/data/SkriptClasses.java

@@ -12,6 +12,8 @@
 import ch.njol.skript.Skript;
 import ch.njol.skript.ScriptLoader;
 import ch.njol.skript.SkriptCommand;
+import ch.njol.skript.config.Config;
+import ch.njol.skript.config.Node;
 import ch.njol.skript.aliases.Aliases;
 import ch.njol.skript.aliases.ItemData;
 import ch.njol.skript.aliases.ItemType;
@@ -677,6 +679,63 @@ public String toVariableNameString(VisualEffect e) {
 				.serializer(new YggdrasilSerializer<GameruleValue>())
 		);
 
+		Classes.registerClass(new ClassInfo<>(Config.class, "config")
+			.user("configs?")
+			.name("Config")
+			.description("A configuration (or code) loaded by Skript, such as the config.sk or aliases.",
+				"Configs can be reloaded or navigated to find options.")
+			.usage("")
+			.examples("the skript config")
+			.since("INSERT VERSION")
+			.parser(new Parser<Config>() {
+
+				@Override
+				public boolean canParse(ParseContext context) {
+					return false;
+				}
+
+				@Override
+				public String toString(Config config, int flags) {
+					@Nullable File file = config.getFile();
+					if (file == null)
+						return config.getFileName();
+					return Skript.getInstance().getDataFolder().getAbsoluteFile().toPath()
+						.relativize(file.toPath().toAbsolutePath()).toString();
+				}
+
+				@Override
+				public String toVariableNameString(Config config) {
+					return this.toString(config, 0);
+				}
+			}));
+
+		Classes.registerClass(new ClassInfo<>(Node.class, "node")
+			.user("nodes?")
+			.name("Node")
+			.description("A node (entry) from a script config file.",
+				"This may have navigable children.")
+			.usage("")
+			.examples("the current script")
+			.since("INSERT VERSION")
+			.parser(new Parser<Node>() {
+
+				@Override
+				public boolean canParse(ParseContext context) {
+					return false;
+				}
+
+				@Override
+				public String toString(Node node, int flags) {
+					return node.getPath();
+				}
+
+				@Override
+				public String toVariableNameString(Node node) {
+					return this.toString(node, 0);
+				}
+
+			}));
+
 		Classes.registerClass(new ClassInfo<>(Script.class, "script")
 				.user("scripts?")
 				.name("Script")

src/main/java/ch/njol/skript/config/Config.java

@@ -23,13 +23,16 @@
 import java.util.Set;
 
 import ch.njol.skript.log.SkriptLogger;
+import org.jetbrains.annotations.ApiStatus;
+import org.jetbrains.annotations.NotNull;
+import org.skriptlang.skript.util.Validated;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
 /**
  * Represents a config file.
  */
-public class Config implements Comparable<Config>, AnyNamed {
+public class Config implements Comparable<Config>, Validated, NodeNavigator, AnyNamed {
 
 	/**
 	 * One level of the indentation, e.g. a tab or 4 spaces.
@@ -52,6 +55,7 @@ public class Config implements Comparable<Config>, AnyNamed {
 
 	String fileName;
 	@Nullable Path file = null;
+	private final Validated validator = Validated.validator();
 
 	public Config(InputStream source, String fileName, @Nullable File file,
 				  boolean simple, boolean allowEmptySections, String defaultSeparator) throws IOException {
@@ -173,13 +177,10 @@ public String getFileName() {
 	 * @throws IOException If the file could not be written to.
 	 */
 	public void save(File file) throws IOException {
-		separator = defaultSeparator;
-		PrintWriter writer = new PrintWriter(file, StandardCharsets.UTF_8);
-		try {
-			main.save(writer);
-		} finally {
+		this.separator = defaultSeparator;
+		try (final PrintWriter writer = new PrintWriter(file, StandardCharsets.UTF_8)) {
+			this.main.save(writer);
 			writer.flush();
-			writer.close();
 		}
 	}
 
@@ -231,7 +232,7 @@ public boolean updateNodes(@NotNull Config newer) {
 			SectionNode newParent = node.getParent();
 			Preconditions.checkNotNull(newParent);
 
-			SectionNode parent = getNode(newParent.getPath());
+			SectionNode parent = getNode(newParent.getPathSteps());
 			Preconditions.checkNotNull(parent);
 
 			int index = node.getIndex();
@@ -404,6 +405,37 @@ public int compareTo(@Nullable Config other) {
 		return fileName.compareTo(other.fileName);
 	}
 
+	@Override
+	public void invalidate() {
+		this.validator.invalidate();
+	}
+
+	@Override
+	public boolean valid() {
+		return validator.valid();
+	}
+
+	@Override
+	public @NotNull Node getCurrentNode() {
+		return main;
+	}
+
+	@Override
+	public @Nullable Node getNodeAt(@NotNull String @NotNull ... steps) {
+		return main.getNodeAt(steps);
+	}
+
+	@NotNull
+	@Override
+	public Iterator<Node> iterator() {
+		return main.iterator();
+	}
+
+	@Override
+	public @Nullable Node get(String step) {
+		return main.get(step);
+	}
+
 	/**
 	 * @return The name of this config (excluding path and file extensions)
 	 */

src/main/java/ch/njol/skript/config/EntryNode.java

@@ -2,6 +2,7 @@
 
 import java.util.Map.Entry;
 
+import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
 /**
@@ -46,4 +47,9 @@ String save_i() {
 		return key + config.getSaveSeparator() + value;
 	}
 
+	@Override
+	public @Nullable Node get(String step) {
+		return null;
+	}
+
 }