Timings reporter, hooks and fixes.

Author: bensku

src/main/java/ch/njol/skript/lang/TriggerItem.java

@@ -27,6 +27,8 @@
 import org.eclipse.jdt.annotation.Nullable;
 
 import ch.njol.skript.Skript;
+import ch.njol.skript.timings.Timing;
+import ch.njol.skript.timings.Timings;
 import ch.njol.util.StringUtils;
 
 /**
@@ -86,9 +88,14 @@ protected TriggerItem walk(final Event e) {
 	public final static boolean walk(final TriggerItem start, final Event e) {
 		assert start != null && e != null;
 		TriggerItem i = start;
+		Timing timing = null;
 		try {
+			if (Timings.enabled())
+				timing = Timings.start(e);
+			
 			while (i != null)
 				i = i.walk(e);
+			
 			return true;
 		} catch (final StackOverflowError err) {
 			final Trigger t = start.getTrigger();
@@ -99,6 +106,9 @@ public final static boolean walk(final TriggerItem start, final Event e) {
 		} catch (final Exception ex) {
 			if (ex.getStackTrace().length != 0) // empty exceptions have already been printed
 				Skript.exception(ex, i);
+		} finally {
+			assert timing != null;
+			timing.stop(); // Whatever happened, end the timing
 		}
 		return false;
 	}

src/main/java/ch/njol/skript/timings/Timing.java

@@ -31,6 +31,9 @@
 
 import com.google.common.collect.Lists;
 
+/**
+ * Timing for certain action.
+ */
 public class Timing {
 
 	public class Capture {
@@ -89,8 +92,13 @@ protected Timing() {
 		inProgress = new HashMap<Thread,Capture>();
 	}
 
+	/**
+	 * Starts timing measurement for caller thread.
+	 * @return Timing for chaining
+	 */
 	public Timing start() {
 		Thread current = Thread.currentThread();
+		assert current != null;
 		if (inProgress.containsKey(current)) {
 			inProgress.get(current).stop();
 			inProgress.remove(current);
@@ -103,4 +111,58 @@ public Timing start() {
 
 		return this;
 	}
+	
+	/**
+	 * Stops timing measurements for caller thread if it was in progress.
+	 */
+	public void stop() {
+		Thread current = Thread.currentThread();
+		assert current != null;
+		if (inProgress.containsKey(current)) {
+			inProgress.get(current).stop();
+			inProgress.remove(current);
+		}
+	}
+	
+	/**
+	 * Pauses timing measurement for caller thread until {@link #unpause()} is called.
+	 * @return Timing for chaining.
+	 */
+	public Timing pause() {
+		Thread current = Thread.currentThread();
+		assert current != null;
+		if (inProgress.containsKey(current)) {
+			inProgress.get(current).pause();
+		}
+		
+		return this;
+	}
+	
+	/**
+	 * Unpauses timing measurement for caller thread if it was paused.
+	 * @return Timing for chaining.
+	 */
+	public Timing unpause() {
+		Thread current = Thread.currentThread();
+		assert current != null;
+		if (inProgress.containsKey(current)) {
+			inProgress.get(current).unpause();
+		}
+		
+		return this;
+	}
+	
+	/**
+	 * Gets list of captures for given thread. Very expensive to call.
+	 * @param thread
+	 * @return Captures for given thread
+	 */
+	public List<Capture> getCaptures(Thread thread) {
+		List<Capture> ret = new ArrayList<Capture>();
+		for (Capture c : captures)
+			if (c.isOf(thread))
+				ret.add(c);
+		
+		return ret;
+	}
 }

src/main/java/ch/njol/skript/timings/TimingReporter.java

@@ -0,0 +1,70 @@
+/*
+ *   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-2016 Peter Güttinger and contributors
+ * 
+ */
+
+package ch.njol.skript.timings;
+
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+import java.util.Map.Entry;
+
+import ch.njol.skript.localization.Language;
+import ch.njol.skript.timings.Timing.Capture;
+
+/**
+ * Creates timing reports.
+ */
+public class TimingReporter {
+	
+	public static String generateReport() {
+		Map<Object,Timing> timings = Timings.timings;
+		StringBuilder sb = new StringBuilder();
+		
+		sb.append(String.format(Language.get("timings.start"), ((Timings.disableTime - Timings.enableTime)) / 1000000000));
+		Map<String,Long> results = parseTimings();
+		Iterator<Entry<String, Long>> it = results.entrySet().iterator();
+		while (it.hasNext()) {
+			Entry<String, Long> entry = it.next();
+			long time = entry.getValue();
+			sb.append(entry.getKey() + ": " + time + " (" + (time / 1000000000) + "ms)");
+		}
+		
+		return sb.toString();
+	}
+	
+	@SuppressWarnings("null")
+	public static Map<String,Long> parseTimings() {
+		Map<String,Long> ret = new HashMap<String,Long>();
+		
+		Iterator<Entry<Object, Timing>> it = Timings.timings.entrySet().iterator();
+		while (it.hasNext()) {
+			Entry<Object, Timing> entry = it.next();
+			List<Capture> captures = entry.getValue().getCaptures(Thread.currentThread());
+			long time = 0;
+			for (Capture c : captures)
+				time += c.result();
+			ret.put(entry.toString(), time);
+		}
+		
+		return ret;
+	}
+}

src/main/java/ch/njol/skript/timings/Timings.java

@@ -31,20 +31,60 @@
  */
 public class Timings {
 
-	private static Map<String,Timing> timings = new HashMap<String,Timing>();
+	protected static Map<Object,Timing> timings = new HashMap<Object,Timing>();
+	private static volatile boolean enabled;
+	protected static volatile long enableTime;
+	protected static volatile long disableTime;
 
-	public static Timing of(String name) {
+	public static Timing of(Object ref) {
 		Timing timing;
 		synchronized (timings) {
-			if (timings.containsKey(name)) {
-				timing = timings.get(name);
+			if (timings.containsKey(ref)) {
+				timing = timings.get(ref);
 			} else {
 				timing = new Timing();
-				timings.put(name, timing);
+				timings.put(ref, timing);
 			}
 		}
 
 		assert timing != null;
 		return timing;
 	}
+	
+	public static boolean enabled() {
+		return enabled;
+	}
+	
+	public static void enable() {
+		enabled = true;
+		enableTime = System.nanoTime();
+	}
+	
+	public static void disable() {
+		enabled = false;
+		disableTime = System.nanoTime();
+	}
+	
+	public static Timing start(Object ref) {
+		Timing timing = of(ref);
+		timing.start();
+		return timing;
+	}
+	
+	public static void stop(Object ref) {
+		Timing timing = of(ref);
+		timing.stop();
+	}
+	
+	public static Timing pause(Object ref) {
+		Timing timing = of(ref);
+		timing.pause();
+		return timing;
+	}
+	
+	public static Timing unpause(Object ref) {
+		Timing timing = of(ref);
+		timing.unpause();
+		return timing;
+	}
 }

src/main/resources/lang/english.lang

@@ -1027,4 +1027,8 @@ types:
 io exceptions:
 	unknownhostexception: Cannot connect to %s
 	accessdeniedexception: Access denied for %s
+# -- Timings Reports --
+timings:
+	start: "Skript timings for %s seconds:"
+