Fixes compilation

Author: Tom Kail

Assets/Editor.meta

@@ -0,0 +1,118 @@
+using UnityEngine;
+using UnityEditor;
+using System.Collections.Generic;
+using System.Linq;
+
+namespace Ink.UnityIntegration {
+
+	[CustomEditor(typeof(InkLibrary))]
+	public class InkLibraryEditor : Editor {
+
+		#pragma warning disable
+		protected InkLibrary data;
+		
+		public void OnEnable() {
+			data = (InkLibrary) target;
+		}
+		
+		protected override void OnHeaderGUI () {
+			GUILayout.BeginHorizontal();
+			GUILayout.Space(38f);
+			GUILayout.BeginVertical();
+			GUILayout.Space(19f);
+			GUILayout.BeginHorizontal();
+
+			GUILayoutUtility.GetRect(10f, 10f, 16f, 16f, EditorStyles.layerMaskField);
+			GUILayout.FlexibleSpace();
+
+
+            EditorGUI.BeginDisabledGroup(InkCompiler.compiling);
+			if (GUILayout.Button(new GUIContent("Rebuild Library", "Rebuilds the ink library. Do this if you're getting unusual errors"), EditorStyles.miniButton)) {
+				InkLibrary.Rebuild();
+			}
+			EditorGUI.EndDisabledGroup();
+
+			GUILayout.EndHorizontal();
+			GUILayout.EndVertical();
+			GUILayout.EndHorizontal();
+
+			Rect lastRect = GUILayoutUtility.GetLastRect();
+			Rect rect = new Rect(lastRect.x, lastRect.y, lastRect.width, lastRect.height);
+			Rect iconRect = new Rect(rect.x + 6f, rect.y + 6f, 32f, 32f);
+			GUI.DrawTexture(iconRect, InkBrowserIcons.inkFileIconLarge);
+
+			Rect titleRect = new Rect(rect.x + 44f, rect.y + 6f, rect.width - 44f - 38f - 4f, 16f);
+			titleRect.yMin -= 2f;
+			titleRect.yMax += 2f;
+			GUI.Label(titleRect, "Ink Library", EditorStyles.largeLabel);
+			
+			Rect infoRect = titleRect;
+			infoRect.y += titleRect.height;
+			GUI.Label(infoRect, "Caches information about ink files in your project", EditorStyles.miniLabel);
+		}
+
+		public override void OnInspectorGUI() {
+			serializedObject.Update();
+
+
+			EditorGUILayout.Toggle("HasLockedUnityCompilation", InkCompiler.hasLockedUnityCompilation);
+			if(GUILayout.Button("Unlock")) {
+				EditorApplication.UnlockReloadAssemblies();
+			}
+			#if UNITY_2019_4_OR_NEWER
+			if(GUILayout.Button("AllowAutoRefresh")) {
+				AssetDatabase.AllowAutoRefresh();
+			}
+			#endif
+
+			if(InkCompiler.compiling) {
+				Rect r = EditorGUILayout.BeginVertical();
+				EditorGUI.ProgressBar(r, InkCompiler.GetEstimatedCompilationProgress(), "Compiling...");
+				GUILayout.Space(EditorGUIUtility.singleLineHeight);
+				EditorGUILayout.EndVertical();
+				GUILayout.Space(EditorGUIUtility.standardVerticalSpacing);
+			} else {
+				var filesRequiringRecompile = InkLibrary.GetFilesRequiringRecompile();
+				if(filesRequiringRecompile.Any()) {
+					var files = string.Join("\n", filesRequiringRecompile.Select(x => x.filePath).ToArray());
+					if(EditorApplication.isPlaying && InkSettings.Instance.delayInPlayMode) {
+                        EditorGUILayout.HelpBox("Some Ink files marked to compile on exiting play mode.\n"+files, MessageType.Info);
+                    } else {
+                        EditorGUILayout.HelpBox("Some Ink files marked to compile automatically are not compiled! Check they don't have compile errors, or else try compiling now.\n"+files, MessageType.Warning);
+                    }
+				}  else {
+					EditorGUILayout.HelpBox("All Ink files marked to compile automatically are compiled", MessageType.Info);
+				}
+			}
+			EditorGUI.BeginDisabledGroup(InkCompiler.compiling);
+			if (GUILayout.Button(new GUIContent("Recompile All", "Recompiles all files marked to compile automatically."))) {
+				InkEditorUtils.RecompileAll();
+			}
+
+            if(EditorApplication.isPlaying && InkSettings.Instance.delayInPlayMode) {
+                var filesRequiringRecompile = InkLibrary.GetFilesRequiringRecompile();
+                if(filesRequiringRecompile.Any()) {
+                    var files = string.Join("\n", filesRequiringRecompile.Select(x => x.filePath).ToArray());
+                    if (GUILayout.Button(new GUIContent("Recompile Pending", "Recompiles all files marked to compile on exiting play mode."))) {
+                        InkEditorUtils.RecompileAll();
+                    }
+                }
+            }
+
+			EditorGUI.EndDisabledGroup();
+
+			EditorGUI.BeginDisabledGroup(true);
+			EditorGUILayout.PropertyField(serializedObject.FindProperty("inkLibrary"), true);
+			EditorGUILayout.PropertyField(serializedObject.FindProperty("pendingCompilationStack"), true);
+			EditorGUILayout.PropertyField(serializedObject.FindProperty("compilationStack"), true);
+			EditorGUI.EndDisabledGroup();
+			
+            if (GUILayout.Button(new GUIContent("Clear Compilation Stacks"))) {
+                InkLibrary.ClearCompilationStacks();
+            }
+			if(GUI.changed && target != null)         
+				EditorUtility.SetDirty(target);
+			serializedObject.ApplyModifiedProperties();
+	    }
+	}
+}

Assets/Editor/InkLibraryEditor.cs

@@ -0,0 +1,31 @@
+using UnityEngine;
+using UnityEditor;
+using System.Collections.Generic;
+using System.Linq;
+
+namespace Ink.UnityIntegration {
+	public class InkLibraryEditorWindow : EditorWindow {
+
+		#pragma warning disable
+		Editor inkLibraryEditor;
+
+		[MenuItem("Window/Ink Library Editor Window")]
+		static void Init() {
+			var window = (InkLibraryEditorWindow)EditorWindow.GetWindow(typeof(InkLibraryEditorWindow));
+			window.titleContent = new GUIContent("Ink Library Window");
+			window.Show();
+		}
+
+		public void OnEnable() {
+			inkLibraryEditor = Editor.CreateEditor(InkLibrary.Instance);
+		}
+
+		void OnInspectorUpdate() {
+			Repaint();
+		}
+
+		public void OnGUI() {
+			inkLibraryEditor.OnInspectorGUI();
+	    }
+	}
+}

Assets/Editor/InkLibraryEditor.cs.meta

@@ -115,8 +115,9 @@ private static void Update () {
 					if(InkLibrary.NumFilesInCompilingStackInState(CompilationStackItem.State.Queued) == 0) {
 						DelayedComplete();
 					} else {
-						// Debug.LogWarning("Ignorable InkCompiler warning!\nThe ink compiler has hit a fallback state where TryCompileNextFileInStack had to be called in Update. We'd like to fix this properly but don't have enough information on the bug.");
-						// TryCompileNextFileInStack();
+						// We used to avoid calling this here in favour of calling it CompileInkThreaded but it seems that it doesn't run when called there, for some reason.
+						// If someone can make this work please let me know!
+						TryCompileNextFileInStack();
 					}
 				}
 			}
@@ -267,8 +268,7 @@ private static void CompileInkInternal (InkFile inkFile, bool immediate) {
 				immediate = immediate
 			};
 
-			InkLibrary.Instance.compilationStack.Add(pendingFile);
-			InkLibrary.SaveToFile();
+			InkLibrary.AddToCompilationStack(pendingFile);
 
 			TryCompileNextFileInStack();
 		}
@@ -294,7 +294,6 @@ private static void TryCompileNextFileInStack () {
 					ThreadPool.QueueUserWorkItem(CompileInkThreaded, fileToCompile);
 				}
 			} else {
-				// Debug.Log("TryCompileNextFileInStack COMPILING ALREADY "+fileToCompile);
 			}
 		}
 
@@ -349,7 +348,11 @@ private static void CompileInkThreaded(object itemObj) {
 			}
 
 			CompleteCompilingFile(item);
-			TryCompileNextFileInStack();
+
+			// This doesn't seem to execute when called in a thread, and I apparently don't have a bloody clue how threads work.
+			// If someone can make this work, I'd rather that TryCompileNextFileInStack ran directly after CompileInkThreaded finishes.
+			// I couldn't make it work, so I've put TryCompileNextFileInStack in Update instead. Bleh!
+			// TryCompileNextFileInStack();
 		}
 
 		// When all files in stack have been compiled. This is called via update because Process events run in another thread.
@@ -434,8 +437,7 @@ private static void DelayedComplete () {
 				Debug.Log(outputLog);
 			}
 
-			InkLibrary.Instance.compilationStack.Clear();
-			InkLibrary.SaveToFile();
+			InkLibrary.ClearCompilationStack();
 
 			#if !UNITY_EDITOR_LINUX
 			EditorUtility.ClearProgressBar();

Assets/Editor/InkLibraryEditorWindow.cs

@@ -55,7 +55,7 @@ public static InkLibrary Instance {
 		// If InkSettings' delayInPlayMode option is true, dirty files are added here when they're changed in play mode
 		// This ensures they're remembered when you exit play mode and can be compiled
 		public List<string> pendingCompilationStack = new List<string>();
-		// The state of files currently being compiled. You can ignore this!
+		// The state of files currently being compiled.
 		public List<InkCompiler.CompilationStackItem> compilationStack = new List<InkCompiler.CompilationStackItem>();
 
         public int Count {
@@ -121,7 +121,6 @@ static void BuildLookupDictionary () {
 			foreach(var inkFile in Instance.inkLibrary) {
                 Instance.inkLibraryDictionary.Add(inkFile.inkAsset, inkFile);
             }
-			Debug.Log("Dictionary Created with "+Instance.inkLibrary.Count+" values");
         }
 
 		/// <summary>
@@ -434,12 +433,28 @@ public static void RebuildInkFileConnections () {
 
 
 
+        public static void AddToCompilationStack (InkCompiler.CompilationStackItem compilationStackItem) {
+			if(!InkLibrary.Instance.compilationStack.Contains(compilationStackItem)) {
+				InkLibrary.Instance.compilationStack.Add(compilationStackItem);
+				SaveToFile();
+			}
+		}
+
+        public static void ClearCompilationStack () {
+			if(InkLibrary.Instance.compilationStack.Count != 0) {
+				InkLibrary.Instance.compilationStack.Clear();
+				SaveToFile();
+			}
+        }
+
+
         public static void AddToPendingCompilationStack (string filePath) {
 			if(!InkLibrary.Instance.pendingCompilationStack.Contains(filePath)) {
 				InkLibrary.Instance.pendingCompilationStack.Add(filePath);
 				SaveToFile();
 			}
 		}
+
         public static void RemoveFromPendingCompilationStack (InkFile inkFile) {
             bool anyChange = false;
 			anyChange = InkLibrary.Instance.pendingCompilationStack.Remove(inkFile.filePath) || anyChange;