[fixes]

+ Exception when adding a linked ref when there aren't any existing linked refs to an object reference (fixes issue #6) + Potentially sending synced object changed events twice for object references when they change cells + Exception when importing an object reference depending on another form import + Some windows using FormClosing event instead of FormClosed for cleanup + BatchImport becoming unresponsive while performing imports (applying imports is now threaded) [changes] + Generalized how windows (Windows Forms) are handled and accessed [adds] + Debug string (Name) to ImportTarget for logging issues to a specific target + Initial code to handle rendering workshop build volumes/sandboxes/border markers/etc
ForsakenShell · Dec 19, 2019 · 597da97 · 597da97
1 parent 40c2aa5
commit 597da97
Show file tree

Hide file tree

Showing 45 changed files with 726 additions and 490 deletions.
diff --git a/AnnexTheCommonwealth/BorderEnabler.cs b/AnnexTheCommonwealth/BorderEnabler.cs
@@ -318,7 +318,7 @@ public void BuildSegmentsFromSubDivisionEdgeFlags( float approximateNodeLength,
         {
             DebugLog.OpenIndentLevel( new [] { this.GetType().ToString(), "BuildSegmentsFromSubDivisionEdgeFlags()", this.GetEditorID( Engine.Plugin.TargetHandle.WorkingOrLastFullRequired ), "approximateNodeLength = " + approximateNodeLength, "slopeAllowance = " + slopeAllowance, "updateMapUIData = " + updateMapUIData, this.ToString() } );
 
-            var m = GodObject.Windows.GetMainWindow();
+            var m = GodObject.Windows.GetWindow<GUIBuilder.Windows.Main>();
             m.PushStatusMessage();
             m.StartSyncTimer();
             var tStart = m.SyncTimerElapsed();

diff --git a/AnnexTheCommonwealth/SubDivision.cs b/AnnexTheCommonwealth/SubDivision.cs
@@ -1025,7 +1025,7 @@ public void BuildSegmentsFromEdgeFlags( float approximateNodeLength, float slope
         {
             DebugLog.OpenIndentLevel( new [] { this.GetType().ToString(), "BuildSegmentsFromEdgeFlags()", this.GetEditorID( Engine.Plugin.TargetHandle.WorkingOrLastFullRequired ) } );
 
-            var m = GodObject.Windows.GetMainWindow();
+            var m = GodObject.Windows.GetWindow<GUIBuilder.Windows.Main>();
             m.PushStatusMessage();
             m.StartSyncTimer();
             var tStart = m.SyncTimerElapsed();

diff --git a/Engine/Plugin/Collection.cs b/Engine/Plugin/Collection.cs
@@ -358,7 +358,7 @@ IXHandle                        CreateNewChildForm()
             }
 
             // Add the form to the container
-            var resObject = AddFromRecord( wf, resHandle );
+            var resObject = AddFromRecord( pForm, resHandle );
             if( resObject == null )
             {
                 DebugLog.WriteError( this.GetType().ToString(), "CreateNewChildForm()", string.Format( "Unable to add new child \"{0}\" Form to parent \"{1}\" Form in {4} :: 0x{2} - \"{3}\"", _Association.Signature, pForm.Signature, pForm.GetFormID( Engine.Plugin.TargetHandle.Master ).ToString( "X8" ), pForm.GetEditorID( Engine.Plugin.TargetHandle.LastValid ), wf.Filename ) );
@@ -866,7 +866,7 @@ public List<TSync>              ToList<TSync>( int loadOrderFilter = -1, bool tr
 
         protected bool                  LoadFromEx( Interface.IXHandle source, ElementHandle handle )
         {
-            var m = GodObject.Windows.GetMainWindow();
+            var m = GodObject.Windows.GetWindow<GUIBuilder.Windows.Main>();
             m.PushItemOfItems();
             m.StartSyncTimer();
             var tStart = m.SyncTimerElapsed();
@@ -984,7 +984,7 @@ public bool                     LoadAllForms()
 
             //DebugLog.OpenIndentLevel( new [] { "LoadAllForms()", string.Format( "ParentForm :: {0}", ( ParentForm == null ? "plugins" : ParentForm.ToString() ) ) } );
 
-            var m = GodObject.Windows.GetMainWindow();
+            var m = GodObject.Windows.GetWindow<GUIBuilder.Windows.Main>();
             m.PushStatusMessage();
             m.SetCurrentStatusMessage( string.Format( "Plugin.LoadingSigFormsFromAncestor".Translate(), _Association.Signature, ( ParentForm == null ? "Plugin.PluginFiles".Translate() : ParentForm.ExtraInfoFor() ) ) );
             m.StartSyncTimer();
@@ -1045,7 +1045,7 @@ public bool                     PostLoad()
             if( !_FullLoadComplete ) return false;
             if( _FullPostLoadComplete ) return true;
 
-            var m = GodObject.Windows.GetMainWindow();
+            var m = GodObject.Windows.GetWindow<GUIBuilder.Windows.Main>();
             m.PushStatusMessage();
             m.PushItemOfItems();
             m.SetCurrentStatusMessage( string.Format( "Plugin.PostLoadReferenceOfSig".Translate(), _Association.Signature ) );

diff --git a/Engine/Plugin/Collections/Cells.cs b/Engine/Plugin/Collections/Cells.cs
@@ -52,7 +52,7 @@ protected override void Dispose( bool disposing )
         public Plugin.Forms.Cell GetByGrid( Vector2i coords )
         {
             //DebugLog.OpenIndentLevel( new [] { this.GetType().ToString(), "GetByGrid()", "coords = " + coords.ToString(), "Worldspace = " + Worldspace.ToStringNullSafe() } );
-            var m = GodObject.Windows.GetMainWindow();
+            var m = GodObject.Windows.GetWindow<GUIBuilder.Windows.Main>();
             //m.PushStatusMessage();
             //m.StartSyncTimer();
             //var tStart = m.SyncTimerElapsed();

diff --git a/Engine/Plugin/Form.cs b/Engine/Plugin/Form.cs
@@ -773,6 +773,9 @@ public ICollection              CollectionFor( ClassAssociation association )
         public virtual string           ExtraInfo                   { get { return Signature; } }
 
         bool _SupressObjectDataChangedEvent = false;
+
+        public bool                     ObjectDataChangedEventsSupressed { get { return _SupressObjectDataChangedEvent; } }
+
         public void                     SupressObjectDataChangedEvents() { _SupressObjectDataChangedEvent = true; }
 
         public void                     ResumeObjectDataChangedEvents( bool sendevent )
@@ -819,7 +822,7 @@ public List<Form>               References
         {
             get
             {
-                var m = GodObject.Windows.GetMainWindow();
+                var m = GodObject.Windows.GetWindow<GUIBuilder.Windows.Main>();
                 m.PushStatusMessage();
                 m.PushItemOfItems();
                 m.SetCurrentStatusMessage( string.Format( "Plugin.LoadingReferencesOf".Translate(), GetFormID( Engine.Plugin.TargetHandle.Master ).ToString( "X8" ), GetEditorID( Engine.Plugin.TargetHandle.WorkingOrLastFullRequired ) ) );

diff --git a/Engine/Plugin/Forms/Fields/ObjectReference/LinkedRefs.cs b/Engine/Plugin/Forms/Fields/ObjectReference/LinkedRefs.cs
@@ -202,6 +202,8 @@ public bool                     Add( TargetHandle target, uint refID, uint keywo
         int                             AddEx( uint refID, uint keywordFormID )
         {
             // New element in form
+            if( _LinkedReferences == null )
+                _LinkedReferences = new List<ElementHandle>();
             var index = _LinkedReferences.Count;
             var lrh = Form.WorkingFileHandle.AddArrayItem<ElementHandle>( XPath, "", "" );
             if( !lrh.IsValid() )

diff --git a/Engine/Plugin/Forms/ObjectReference.cs b/Engine/Plugin/Forms/ObjectReference.cs
@@ -141,6 +141,9 @@ bool UpdateContainerCellHandle( Cell cell )
 
         public void CheckForBackgroundCellChange( bool sendObjectDataChangedEvent )
         {
+            if( ObjectDataChangedEventsSupressed )
+                return;
+
             DebugLog.OpenIndentLevel( new [] { this.GetType().ToString(), "CheckForBackgroundCellChange()", this.ToStringNullSafe() } );
 
             // Changing position and some record flags will trigger XeLib to update the cell container,

diff --git a/Engine/Plugin/Interface/ISyncedGUIObject.cs b/Engine/Plugin/Interface/ISyncedGUIObject.cs
@@ -50,7 +50,9 @@ public interface ISyncedGUIObject
         string                          ExtraInfo                   { get; }
 
         event EventHandler              ObjectDataChanged;
-
+
+        bool                            ObjectDataChangedEventsSupressed { get; }
+
         void                            SupressObjectDataChangedEvents();
         void                            ResumeObjectDataChangedEvents( bool sendevent );
         void                            SendObjectDataChangedEvent( object sender );

diff --git a/Engine/Plugin/PapyrusScript.cs b/Engine/Plugin/PapyrusScript.cs
@@ -344,6 +344,9 @@ public virtual bool             ObjectChecked( bool checkedValue )
         public event EventHandler       ObjectDataChanged;
 
         bool                            _SupressObjectDataChangedEvent = false;
+
+        public bool ObjectDataChangedEventsSupressed { get { return _SupressObjectDataChangedEvent; } }
+
         public void                     SupressObjectDataChangedEvents()
         {
             _SupressObjectDataChangedEvent = true;

diff --git a/GUIBuilder.csproj b/GUIBuilder.csproj
@@ -133,6 +133,7 @@
     <Compile Include="Extensions\GenRenderTransform.cs" />
     <Compile Include="Extensions\GenStream.cs" />
     <Compile Include="Extensions\GenString.cs" />
+    <Compile Include="GUIBuilder\Windows\IEnableControlForm.cs" />
     <Compile Include="GUIBuilder\Windows\PluginSelector.cs">
       <SubType>Form</SubType>
     </Compile>

diff --git a/GUIBuilder/BorderBatch.cs b/GUIBuilder/BorderBatch.cs
@@ -41,7 +41,7 @@ public static bool ImportNIFs( string guiBuilderImportFile, bool enableControlsO
 
             var result = false;
 
-            var m = GodObject.Windows.GetMainWindow();
+            var m = GodObject.Windows.GetWindow<GUIBuilder.Windows.Main>();
             m.PushStatusMessage();
             var tStart = m.SyncTimerElapsed();
 
@@ -131,7 +131,7 @@ public static bool ImportNIFs( string guiBuilderImportFile, bool enableControlsO
 
             //DebugLog.Write( "GUIBuilder.BorderBatch.CreateNIFs() :: Start (Workshop)" );
 
-            var m = GodObject.Windows.GetMainWindow();
+            var m = GodObject.Windows.GetWindow<GUIBuilder.Windows.Main>();
             m.PushStatusMessage();
             m.StartSyncTimer();
             var tStart = m.SyncTimerElapsed();
@@ -191,7 +191,7 @@ public static bool ImportNIFs( string guiBuilderImportFile, bool enableControlsO
 
             //DebugLog.Write( "\nGUIBuilder.BorderBatch.CreateNIFs() :: Start (Sub-Division)" );
 
-            var m = GodObject.Windows.GetMainWindow();
+            var m = GodObject.Windows.GetWindow<GUIBuilder.Windows.Main>();
             m.PushStatusMessage();
             m.StartSyncTimer();
             var tStart = m.SyncTimerElapsed();

diff --git a/GUIBuilder/FormImport/FormTarget.cs b/GUIBuilder/FormImport/FormTarget.cs
@@ -27,9 +27,9 @@ public Engine.Plugin.Form Form
             set { Value = value; }
         }
 
-        public FormTarget( ImportBase parent, Type formType, uint formID, string editorID ) : base( parent, formType, formID, editorID ) {}
-        public FormTarget( ImportBase parent, Type formType, Engine.Plugin.Form form ) : base( parent, formType, form ) {}
-        public FormTarget( ImportBase parent, Type formType ) : base( parent, formType ) {}
+        public FormTarget( string name, ImportBase parent, Type formType, uint formID, string editorID ) : base( name, parent, formType, formID, editorID ) {}
+        public FormTarget( string name, ImportBase parent, Type formType, Engine.Plugin.Form form ) : base( name, parent, formType, form ) {}
+        public FormTarget( string name, ImportBase parent, Type formType ) : base( name, parent, formType ) {}
         //public FormTarget( ImportBase parent ) : base( parent ) {}
 
         protected override void ResolveValue()

diff --git a/GUIBuilder/FormImport/ImportBase.cs b/GUIBuilder/FormImport/ImportBase.cs
@@ -84,8 +84,8 @@ protected                       ImportBase( string signature, uint recordFlags,
                 _RecordFlags = recordFlags;
                 _FailOnApplyIfUnresolved = failOnApplyIfUnresolved;
                 _Target = classType == typeof( Engine.Plugin.Forms.ObjectReference )
-                    ? new ObjectReferenceTarget( this, targetForm, null, null )
-                    : new FormTarget( this, classType, targetForm );
+                    ? new ObjectReferenceTarget( "Target Ref", this, targetForm, null, null )
+                    : new FormTarget( "Target Form", this, classType, targetForm );
                 resolved = _Target.Resolve( failOnApplyIfUnresolved );
                 if( ( failOnApplyIfUnresolved )&( !resolved ) )
                     throw new Exception( string.Format(
@@ -130,7 +130,7 @@ protected                       ImportBase( string signature, uint recordFlags,
                 _Signature = signature;
                 _RecordFlags = recordFlags;
                 _FailOnApplyIfUnresolved = failOnApplyIfUnresolved;
-                _Target = new ScriptTarget( this, classType, targetScript );
+                _Target = new ScriptTarget( "Target Ref Script", this, classType, targetScript );
                 resolved = _Target.Resolve( failOnApplyIfUnresolved );
                 if( ( failOnApplyIfUnresolved )&( !resolved ) )
                     throw new Exception( string.Format(
@@ -176,8 +176,8 @@ protected                       ImportBase( string signature, uint recordFlags,
                 _RecordFlags = recordFlags;
                 _FailOnApplyIfUnresolved = failOnApplyIfUnresolved;
                 _Target = classType == typeof( Engine.Plugin.Forms.ObjectReference )
-                    ? new ObjectReferenceTarget( this, targetForm, worldspace, cell )
-                    : new FormTarget( this, classType, targetForm );
+                    ? new ObjectReferenceTarget( "Target Ref", this, targetForm, worldspace, cell )
+                    : new FormTarget( "Target Form", this, classType, targetForm );
                 resolved = _Target.Resolve( failOnApplyIfUnresolved );
                 if( ( failOnApplyIfUnresolved )&( !resolved ) )
                     throw new Exception( string.Format(
@@ -212,8 +212,8 @@ protected                       ImportBase( string signature, uint recordFlags,
                 _RecordFlags = recordFlags;
                 _FailOnApplyIfUnresolved = failOnApplyIfUnresolved;
                 _Target = classType == typeof( Engine.Plugin.Forms.ObjectReference )
-                    ? new ObjectReferenceTarget( this )
-                    : new FormTarget( this, classType );
+                    ? new ObjectReferenceTarget( "Target Ref", this )
+                    : new FormTarget( "Target Form", this, classType );
                 //_Target = new FormTarget( this, classType );
                 resolved = ParseImport( importData );
                 if( ( failOnApplyIfUnresolved )&( !resolved ) )
@@ -648,6 +648,8 @@ public string                   ExtraInfo
         public event EventHandler       ObjectDataChanged;
         bool                           _SupressEvents = false;
 
+        public bool ObjectDataChangedEventsSupressed { get { return _SupressEvents; } }
+
         public void                     SupressObjectDataChangedEvents()
         {
             _SupressEvents = true;
@@ -741,6 +743,7 @@ public bool                     Apply( GUIBuilder.Windows.BatchImport importWind
                 AddErrorMessage( ErrorTypes.Import, "Import in error state, cannot Apply()" );
                 goto localAbort;
             }
+            /*
             if(
                 ( _FailOnApplyIfUnresolved )&
                 ( !Resolve( _FailOnApplyIfUnresolved ) )
@@ -749,6 +752,15 @@ public bool                     Apply( GUIBuilder.Windows.BatchImport importWind
                 AddErrorMessage( ErrorTypes.Import, "Resolve() errors, cannot Apply()" );
                 goto localAbort;
             }
+            */
+            // Target may not resolve if this is a new form
+            _Target.Resolve( false );
+            // All reference forms must resolve, however
+            if( !ResolveReferenceForms( true ) )
+            {
+                AddErrorMessage( ErrorTypes.Import, "Resolve() errors, cannot Apply()" );
+                goto localAbort;
+            }
 
             if( TargetForm == null )
             {
@@ -787,16 +799,17 @@ public bool                     Apply( GUIBuilder.Windows.BatchImport importWind
             {
                 AddErrorMessage( ErrorTypes.Import, "An unexpected exception has occured applying import!", e );
             }
+
+            ResumeObjectDataChangedEvents( true );
+
             if( result )
             {
                 var refr = TargetForm as Engine.Plugin.Forms.ObjectReference;
-                if( refr != null ) refr.CheckForBackgroundCellChange( false );
+                if( refr != null ) refr.CheckForBackgroundCellChange( true );
             }
             else
                 DebugLog.WriteError( this.GetType().ToString(), "Apply()", "Unable to apply import to the target form!" );
 
-            ResumeObjectDataChangedEvents( true );
-
         localAbort:
             DebugLog.CloseIndentLevel( "result", result.ToString() );
             return result;
@@ -871,15 +884,23 @@ public override string          ToString()
             return string.Format( "[Signature = \"{0}\" :: Target = {1}]", Signature, DisplayIDInfo() );
         }
 
+        /// <summary>
+        /// Open the import dialog and wait for it to exit.
+        /// DO NOT CALL THIS FROM THE MAIN UI THREAD!
+        /// </summary>
+        /// <param name="importForms">Forms to import</param>
+        /// <param name="enableControlsOnClose">Enable all forms when the dialog closes</param>
+        /// <param name="allImportsMatchTarget">All import targets match import data on close</param>
+        /// <returns></returns>
         public static bool              ShowImportDialog( List<ImportBase> importForms, bool enableControlsOnClose, ref bool allImportsMatchTarget )
         {
             if( importForms.NullOrEmpty() ) return false;
-
-            DebugLog.OpenIndentLevel( new [] { "GUIBuilder.FormImport.ImportBase", "ShowImportDialog()" } );
+            if( System.Threading.Thread.CurrentThread.ManagedThreadId == 1 )
+                throw new Exception( "Cannot show BatchImportWindow from main thread!" );
 
             #region Import window
-            
-            var bbiw = new GUIBuilder.Windows.BatchImport();
+
+            var bbiw = GodObject.Windows.GetWindow<GUIBuilder.Windows.BatchImport>();
             bbiw.EnableControlsOnClose = enableControlsOnClose;
             bbiw.ImportForms = importForms;
             bbiw.ShowDialog();
@@ -888,7 +909,6 @@ public static bool              ShowImportDialog( List<ImportBase> importForms,
 
             #endregion
 
-            DebugLog.CloseIndentLevel();
             return true;
         }
 

diff --git a/GUIBuilder/FormImport/ImportBorderEnablerReference.cs b/GUIBuilder/FormImport/ImportBorderEnablerReference.cs
@@ -70,22 +70,22 @@ public                          ImportBorderEnablerReference( AnnexTheCommonweal
             if( !Target.IsResolved )
                 Target.EditorID = newEditorID;
             NewEditorID     = newEditorID;
-            ftWorldspace    = new FormTarget( this, typeof( Engine.Plugin.Forms.Worldspace ), worldspace );
-            ftCell          = new FormTarget( this, typeof( Engine.Plugin.Forms.Cell ), cell );
+            ftWorldspace    = new FormTarget( "Worldspace", this, typeof( Engine.Plugin.Forms.Worldspace ), worldspace );
+            ftCell          = new FormTarget( "Cell", this, typeof( Engine.Plugin.Forms.Cell ), cell );
             Position        = new Vector3f( position );
-            stSubDivision   = new ScriptTarget( this, typeof( AnnexTheCommonwealth.SubDivision ), subdivision );
-            stNeighbour     = new ScriptTarget( this, typeof( AnnexTheCommonwealth.SubDivision ), neighbour );
+            stSubDivision   = new ScriptTarget( "SubDivision", this, typeof( AnnexTheCommonwealth.SubDivision ), subdivision );
+            stNeighbour     = new ScriptTarget( "Neighbour", this, typeof( AnnexTheCommonwealth.SubDivision ), neighbour );
 
             DumpImport();
         }
 
         public                          ImportBorderEnablerReference( string[] importData )
             : base( IMPORT_SIGNATURE, TARGET_RECORD_FLAGS, false, typeof( AnnexTheCommonwealth.BorderEnabler ), importData )
         {
-            ftWorldspace      = new FormTarget( this, typeof( Engine.Plugin.Forms.Worldspace ) );
-            ftCell            = new FormTarget( this, typeof( Engine.Plugin.Forms.Cell ) );
-            stSubDivision     = new ScriptTarget( this, typeof( AnnexTheCommonwealth.SubDivision ) );
-            stNeighbour       = new ScriptTarget( this, typeof( AnnexTheCommonwealth.SubDivision ) );
+            ftWorldspace      = new FormTarget( "Worldspace", this, typeof( Engine.Plugin.Forms.Worldspace ) );
+            ftCell            = new FormTarget( "Cell", this, typeof( Engine.Plugin.Forms.Cell ) );
+            stSubDivision     = new ScriptTarget( "SubDivision", this, typeof( AnnexTheCommonwealth.SubDivision ) );
+            stNeighbour       = new ScriptTarget( "Neighbour", this, typeof( AnnexTheCommonwealth.SubDivision ) );
             DumpImport();
         }