From b280fb58bac85b39ffa18e9ae22d1dd8ddfee86b Mon Sep 17 00:00:00 2001
From: Andy McFadden
Date: Thu, 16 Jul 2020 10:35:14 -0700
Subject: [PATCH] Rename PluginDll dir to PluginDllCache
The new name is more indicative of the purpose of the directory.
Updated the docs to point out that you can delete the contents any
time you want, so long as SourceGen isn't running at the time.
Also, change the default column widths for the exporter.
---
.gitignore | 2 +-
SourceGen/MainController.cs | 2 +-
SourceGen/RuntimeData/Help/advanced.html | 7 +++++--
SourceGen/Sandbox/PluginDllCache.cs | 4 ++--
4 files changed, 9 insertions(+), 6 deletions(-)
diff --git a/.gitignore b/.gitignore
index 19a8890..8fcd2b8 100644
--- a/.gitignore
+++ b/.gitignore
@@ -5,7 +5,7 @@
# 6502bench-specific stuff
SourceGen/SourceGen-settings
-SourceGen/PluginDll
+SourceGen/PluginDllCache
DIST_Debug
DIST_release
diff --git a/SourceGen/MainController.cs b/SourceGen/MainController.cs
index d8f7698..0e16c2f 100644
--- a/SourceGen/MainController.cs
+++ b/SourceGen/MainController.cs
@@ -1425,7 +1425,7 @@ namespace SourceGen {
typeof(ClipLineFormat),
(int)ClipLineFormat.AssemblerSource);
- int[] rightWidths = new int[] { 9, 8, 11, 100 };
+ int[] rightWidths = new int[] { 16, 8, 18, 100 };
Exporter.ActiveColumnFlags colFlags = Exporter.ActiveColumnFlags.None;
if (format == ClipLineFormat.Disassembly) {
diff --git a/SourceGen/RuntimeData/Help/advanced.html b/SourceGen/RuntimeData/Help/advanced.html
index 8c5900a..1e8db88 100644
--- a/SourceGen/RuntimeData/Help/advanced.html
+++ b/SourceGen/RuntimeData/Help/advanced.html
@@ -210,9 +210,9 @@ While plugins can use CommonUtil directly, they should avoid doing so. The
APIs there are not guaranteed to be stable, so plugins that rely on them
may break in a subsequent release of SourceGen.
-PluginDll Directory
+PluginDllCache Directory
-Extension scripts are compiled into .DLLs, and saved in the PluginDll
+
Extension scripts are compiled into .DLLs, and saved in the PluginDllCache
directory, which lives next to the application executable and RuntimeData.
If the extension script is the same age or older than the DLL, SourceGen
will continue to use the existing DLL.
@@ -225,6 +225,9 @@ would look like "PROJ_MyProject_MyScript.dll".
The PluginCommon and CommonUtil DLLs will be copied into the directory, so
that code in the sandbox has access to them.
+The contents of the directory are generated as needed, and can be deleted
+entirely whenever SourceGen isn't running.
+
Sandboxing
Extension scripts are executed in an App Domain sandbox. App domains are
diff --git a/SourceGen/Sandbox/PluginDllCache.cs b/SourceGen/Sandbox/PluginDllCache.cs
index 93ad26c..990b5c9 100644
--- a/SourceGen/Sandbox/PluginDllCache.cs
+++ b/SourceGen/Sandbox/PluginDllCache.cs
@@ -25,7 +25,7 @@ using PluginCommon;
namespace SourceGen.Sandbox {
///
- /// This manages the PluginDll directory, which holds the compiled form of the extension
+ /// This manages the PluginDllCache directory, which holds the compiled form of the extension
/// scripts. When a script is requested, this checks to see if the compiled form
/// already exists. If not, or the script source file is newer than the DLL file, the
/// compiler is executed.
@@ -37,7 +37,7 @@ namespace SourceGen.Sandbox {
/// the locks will be cleared when the AppDomain is unloaded.
///
public static class PluginDllCache {
- private const string PLUGIN_DIR_NAME = "PluginDll";
+ private const string PLUGIN_DIR_NAME = "PluginDllCache";
///
/// List of assemblies for the CompilerParameters.ReferencedAssemblies argument.