Merge pull request #4015 from mansellan/3994

VB6 - rewrite files in-place

Author: retailcoder

Rubberduck.Parsing/Rewriter/MemberAttributesRewriter.cs

@@ -32,16 +32,25 @@ public override void Rewrite()
             if(!IsDirty) { return; }
 
             var component = Module.Parent;
+            var vbeKind = component.VBE.Kind;
             if (component.Type == ComponentType.Document)
             {
                 // can't re-import a document module
                 return;
             }
 
-            var file = _exporter.Export(component);
+            var file = vbeKind == VBEKind.Embedded
+                ? _exporter.Export(component)
+                : component.GetFileName(1);    
+
             var content = Rewriter.GetText();
             File.WriteAllText(file, content);
 
+            if (vbeKind == VBEKind.Standalone)
+            {
+                return;
+            }
+
             var components = component.Collection;
             components.Remove(component);
             components.ImportSourceFile(file);

Rubberduck.Parsing/VBA/AttributeParser.cs

@@ -35,7 +35,12 @@ public AttributeParser(IModuleExporter exporter, Func<IVBAPreprocessor> preproce
         public (IParseTree tree, ITokenStream tokenStream, IDictionary<Tuple<string, DeclarationType>, Attributes> attributes) Parse(QualifiedModuleName module, CancellationToken cancellationToken)
         {
             cancellationToken.ThrowIfCancellationRequested();
-            var path = _exporter.Export(_projectsProvider.Component(module));
+            var component = _projectsProvider.Component(module);
+
+            var path = component.VBE.Kind == VBEKind.Embedded
+                ? _exporter.Export(component)
+                : component.GetFileName(1); 
+
             if (!File.Exists(path))
             {
                 // a document component without any code wouldn't be exported (file would be empty anyway).

Rubberduck.VBEEditor/Extensions/IDEExtensions.cs

@@ -69,6 +69,7 @@
     <Compile Include="SafeComWrappers\SafeComWrapper.cs" />
     <Compile Include="SafeComWrappers\SafeRedirectedEventedComWrapper.cs" />
     <Compile Include="SafeComWrappers\VB\Abstract\IHostApplication.cs" />
+    <Compile Include="SafeComWrappers\VB\Enums\VBEKind.cs" />
     <Compile Include="Utility\UiContext.cs" />
     <Compile Include="VBERuntime\IVBERuntime.cs" />
     <Compile Include="VBERuntime\Settings\IVBESettings.cs" />
@@ -168,7 +169,6 @@
     <Compile Include="Extensions\StringExtensions.cs" />
     <Compile Include="SubClassingWindowEventArgs.cs" />
     <Compile Include="Extensions\ComponentTypeExtensions.cs" />
-    <Compile Include="Extensions\IDEExtensions.cs" />
     <Compile Include="VBEEditorText.Designer.cs">
       <AutoGen>True</AutoGen>
       <DesignTime>True</DesignTime>

Rubberduck.VBEEditor/Rubberduck.VBEditor.csproj

@@ -20,7 +20,8 @@ public interface IVBComponent : ISafeComWrapper, IEquatable<IVBComponent>
         void Activate();
         void Export(string path);
         string ExportAsSourceFile(string folder, bool tempFile = false);
-
+        int FileCount { get; }
+        string GetFileName(short index);
         IVBProject ParentProject { get; }
 
         QualifiedModuleName QualifiedModuleName { get; }

Rubberduck.VBEEditor/SafeComWrappers/VB/Abstract/IVBComponent.cs

@@ -5,6 +5,7 @@ namespace Rubberduck.VBEditor.SafeComWrappers.Abstract
     // ReSharper disable once InconsistentNaming
     public interface IVBE : ISafeComWrapper, IEquatable<IVBE>
     {
+        VBEKind Kind { get; }
         string Version { get; }
         object HardReference { get; }
         IWindow ActiveWindow { get; }

Rubberduck.VBEEditor/SafeComWrappers/VB/Abstract/IVBE.cs

@@ -0,0 +1,17 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace Rubberduck.VBEditor.SafeComWrappers
+{
+    public enum VBEKind
+    {
+        /// <summary>Embedded VB editor (Visual Basic for Applications).</summary>
+        Embedded,
+
+        /// <summary>Standalone VB editor (Visual Basic).</summary>
+        Standalone
+    }
+}

Rubberduck.VBEEditor/SafeComWrappers/VB/Enums/VBEKind.cs

@@ -96,109 +96,24 @@ public bool HasDesigner
         /// <param name="tempFile">True if a unique temp file name should be generated. WARNING: filenames generated with this flag are not persisted.</param>
         public string ExportAsSourceFile(string folder, bool tempFile = false)
         {
-            var fullPath = tempFile
-                ? Path.Combine(folder, Path.GetRandomFileName())
-                : Path.Combine(folder, SafeName + Type.FileExtension());
-            switch (Type)
-            {
-                case ComponentType.UserForm:
-                    ExportUserFormModule(fullPath);
-                    break;
-                case ComponentType.Document:
-                    ExportDocumentModule(fullPath);
-                    break;
-                default:
-                    Export(fullPath);
-                    break;
-            }
-
-            return fullPath;
+            throw new NotSupportedException("Export as source file is not supported in VB6");
         }
 
         public IVBProject ParentProject => Collection.Parent;
 
-        private void ExportUserFormModule(string path)
-        {
-            // VBIDE API inserts an extra newline when exporting a UserForm module.
-            // this issue causes forms to always be treated as "modified" in source control, which causes conflicts.
-            // we need to remove the extra newline before the file gets written to its output location.
-
-            int legitEmptyLineCount;
-            using (var codeModule = CodeModule)
-            {
-                var visibleCode = codeModule.Content().Split(new[] { Environment.NewLine }, StringSplitOptions.None);
-                legitEmptyLineCount = visibleCode.TakeWhile(string.IsNullOrWhiteSpace).Count();
-            }
-
-            var tempFile = ExportToTempFile();
-            var tempFilePath = Directory.GetParent(tempFile).FullName;
-            var fileEncoding = System.Text.Encoding.Default;    //We use the current ANSI codepage because that is what the VBE does.
-            var contents = File.ReadAllLines(tempFile, fileEncoding);
-            var nonAttributeLines = contents.TakeWhile(line => !line.StartsWith("Attribute")).Count();
-            var attributeLines = contents.Skip(nonAttributeLines).TakeWhile(line => line.StartsWith("Attribute")).Count();
-            var declarationsStartLine = nonAttributeLines + attributeLines + 1;
-
-            var emptyLineCount = contents.Skip(declarationsStartLine - 1)
-                                         .TakeWhile(string.IsNullOrWhiteSpace)
-                                         .Count();
-
-            var code = contents;
-            if (emptyLineCount > legitEmptyLineCount)
-            {
-                code = contents.Take(declarationsStartLine).Union(
-                       contents.Skip(declarationsStartLine + emptyLineCount - legitEmptyLineCount))
-                               .ToArray();
-            }
-            File.WriteAllLines(path, code, fileEncoding);
+        public int FileCount => IsWrappingNullReference ? 0 : Target.FileCount;
 
-            // LINQ hates this search, therefore, iterate the long way
-            foreach (string line in contents)
+        public string GetFileName(short index)
+        {
+            if (IsWrappingNullReference)
             {
-                if (line.Contains("OleObjectBlob"))
-                {
-                    var binaryFileName = line.Trim().Split('"')[1];
-                    var destPath = Directory.GetParent(path).FullName;
-                    if (File.Exists(Path.Combine(tempFilePath, binaryFileName)) && !destPath.Equals(tempFilePath))
-                    {
-                        System.Diagnostics.Debug.WriteLine(Path.Combine(destPath, binaryFileName));
-                        if (File.Exists(Path.Combine(destPath, binaryFileName)))
-                        {
-                            try
-                            {
-                                File.Delete(Path.Combine(destPath, binaryFileName));
-                            }
-                            catch (Exception)
-                            {
-                                // Meh?
-                            }
-                        }
-                        File.Copy(Path.Combine(tempFilePath, binaryFileName), Path.Combine(destPath, binaryFileName));
-                    }
-                    break;
-                }
+                return null;
             }
-        }
-
-        private void ExportDocumentModule(string path)
-        {
-            using (var codeModule = CodeModule)
+            if (index < 1 || index > FileCount) // 1-based indexing from VB
             {
-                var lineCount = codeModule.CountOfLines;
-                if (lineCount > 0)
-                {
-                    //One cannot reimport document modules as such in the VBE; so we simply export and import the contents of the code pane.
-                    //Because of this, it is OK, and actually preferable, to use the default UTF8 encoding.
-                    var text = codeModule.GetLines(1, lineCount);
-                    File.WriteAllText(path, text, Encoding.UTF8);
-                }
+                throw new ArgumentOutOfRangeException(nameof(index));
             }
-        }
-
-        private string ExportToTempFile()
-        {
-            var path = Path.Combine(Path.GetTempPath(), SafeName + Type.FileExtension());
-            Export(path);
-            return path;
+            return Target.FileNames[index];
         }
 
         public override bool Equals(ISafeComWrapper<VB.VBComponent> other)