Debug custom dll that is being referenced in visual studio macro

Question

I previously asked: Add dll reference to visual studio macros

the idea of creating the macros in my language (C#) makes it easier to create the macros. The problem is that I cannot debug the dll

To solve the problem I have tried:

1. I placed myClassLibrary.pdb next to myClassLibrary.dll hoping I where going to be able to debug the methods in the dll by steping in to them.

2. Created a WCF service. Because I did not knew how to reference the service from vba I reference it from the class library. The problem is that I need to use variables such as DTE.ActiveDocument and those variables are not serializable meaning I could not pass them to the wcf service.

the idea of working in C# is very nice but not being able to debug and see what is going on makes it somewhat difficult. I might have to go to my older option where I created my code on C# compiled then decompiled into vba with reflector.

---

Edit

I think I am close on getting a solution. I thought why not create the macro in a console application? I am able to get the active document text but not able to change it.

        EnvDTE80.DTE2 MyDte;
        MyDte = (EnvDTE80.DTE2)System.Runtime.InteropServices.Marshal.GetActiveObject( "VisualStudio.DTE.10.0" );
        Console.WriteLine( "The Edition is " + MyDte.Edition );

        Console.ReadLine( );

        // write to the console the text that is selected. "sometimes it does not work don't know why"
        Console.WriteLine(
            MyDte.ActiveDocument.Selection.Text
        );

note I added the following references plus the onces that vba macros have:

Answer 1

I have yet another answer which is even better!

The only reason why I created the addin is because I needed a reference of the DTE. Why not reference the dte that I need.

The the algorithm is as follow:

1. Use class Ide to get the DTE of whatever instance of visual studio.

2. Once you have that dte create the macro.

Here is the Ide class:

public class Ide
{        
    [DllImport("ole32.dll")]
    private static extern void CreateBindCtx(int reserved, out IBindCtx ppbc);

    [DllImport("ole32.dll")]
    private static extern void GetRunningObjectTable(int reserved, out IRunningObjectTable prot);

    public static DTE2 GetDte(string solutionName)
    {
        DTE2 dte = null;

        GetDte((displayName, x) =>
        {
            if (System.IO.Path.GetFileName(x.Solution.FullName).Contains(solutionName))
            {
                dte = x;
                return false; // we found it stop seraching
            }
            else
            {
                return true; // continue searching
            }

        });

        return dte;
    }

    public static DTE2 GetDte(int processId)
    {
        DTE2 dte = null;

        GetDte((displayName, x) =>
        {
            if (displayName.Contains(processId.ToString()))
            {
                dte = x;
                return false; // stop searching we found matching dte
            }
            else
            {
                return true; // continue searching
            }
        });

        return dte;
    }

    public static List<DTE2> GetAllDte()
    {
        List<DTE2> list = new List<DTE2>();
        GetDte((displayName, x) =>
        {
            list.Add(x);
            return true; // continue serching we want all dte's
        });
        return list;
    }

    private static void GetDte(Func<string, DTE2, bool> foo)
    {
        Dictionary<string, string> dtesProcessIds = new Dictionary<string, string>();

        //rot entry for visual studio running under current process.            
        IRunningObjectTable rot;
        GetRunningObjectTable(0, out rot);
        IEnumMoniker enumMoniker;
        rot.EnumRunning(out enumMoniker);
        enumMoniker.Reset();
        IntPtr fetched = IntPtr.Zero;
        IMoniker[] moniker = new IMoniker[1];
        while (enumMoniker.Next(1, moniker, fetched) == 0)
        {
            IBindCtx bindCtx;
            CreateBindCtx(0, out bindCtx);
            string displayName;
            moniker[0].GetDisplayName(bindCtx, null, out displayName);
            object comObject;
            rot.GetObject(moniker[0], out comObject);

            if (comObject != null)
            {
                DTE2 dteCurrent = null;
                try
                {
                    dteCurrent = (EnvDTE80.DTE2)comObject;

                    // if solution is not open continue
                    // this will cause an exception if it is not open
                    var temp = dteCurrent.Solution.IsOpen;

                    string solName = dteCurrent.Solution.FullName;

                    // if there is an instance of visual studio with no solution open continue                        
                    if (string.IsNullOrEmpty(solName))
                    {
                        continue;
                    }

                    // avoid adding duplicate ide's
                    if (dtesProcessIds.ContainsKey(displayName) == false)
                    {
                        dtesProcessIds.Add(displayName, displayName);
                    }
                    else
                    {
                        continue;
                    }

                }
                catch (System.Runtime.InteropServices.COMException e)
                {
                    continue;
                }
                catch (Exception e)
                {
                    continue;
                }
                if (dteCurrent != null)
                {
                    var cont = foo(displayName, dteCurrent);

                    if (cont == false)
                        return;
                }
            }

        }
    }
}

then if I have an instance of visual studio runing that contains a solution with the name ConsoleApp1 then I will be able to do:

 var dte = Ide.GetDte("ConsoleApp1");
 dte.ActiveDocument.Selection.Insert("My macro is working!");

and the text My macro is working! will be inserted in the active document. make sure there is an active document though

Answer 2

Using DLL's from other publishers is easy. But it's important to understand the code. I use IlSpy. Its free and to use. It decompiles the dll to view all methodes, classes and namespaces.

Answer 3

Finally here is the solution:

On the following steps I will describe how it will be possible to debug the dll that will be executed by a macro.

If you want to be able to do something like:

(Note I am debuging a macro on c# on visual studio!!!)

1. Create a new Solution in visual studio

2. Now add a new class library Project to that solution. (This is the class that will execute the macros)

3. Add the references EnvDTE, EbvDTE100, EnvDTE80, EnvDTE90, EnvDTE90a. Basically the same references that visual studio macros have:

4. Create a method that will execute the macro you plan to use on the class library.

      namespace ClassLibrary1
      {
          public static class Class1
          {
              public static void Macro1(EnvDTE80.DTE2 DTE)
              {
                  // make sure an active text document is open before calling this method
                  DTE.ActiveDocument.Selection.Insert("Hello World!!!");
              }
          }
      }
   

5. Add another project (Visual Studio Add-in)

6. Follow the wizzard leave the defaults except on page 4 select:

7. Continue selecting the default options on the wizard until the project is created:

8. Set that project as the startup project so that when we press f5 the addin runs.

9. Add a reference from MyAddin1 to the class library

10. Once we have that reference we should be able to execute the macro from the addin. In order to do so open Connect.cs and navigate to the method Exec add ClassLibrary1.Class1.Macro1(_applicationObject); so it looks like:

11. Add a break point at the start of the Exec method so we can debug it.

12. Execute MyAddin1 by pressing F5. A new instance of visual studio should open.

13. On the new instance of visual studio open any solution. In this case I am opening the same solution again>

14. Got to tools then click on MyAddin1 but make sure a document is open:

15. Once you click on my addin you should hit the breakpoint!

15. NOTE! For some reason I had to comment the line ClassLibrary1.Class1.Macro1(_applicationObject);

So I comment out that line and on that line I placed:

 var textDoc = (TextDocument)(_applicationObject.ActiveDocument.Object(string.Empty));
 textDoc.Selection.Insert("Hello world");

finally when I click on MyAddin1 located on tools Hello world will be inserted!

---

Once I know the macro is running fine I could export the class to a class library and have the macro call the method on the dll instead of the plug in.

Answer 4

The way to debug visual studio add-ins is to open another visual studio instance and attach to the one that will activate your add-in. It is described here. Also make sure that the add-in is built on the local machine and pdbs are available otherwise it will not hit your breakpoints.

Answer 5

Tono,

Have you referenced your dll for the wcf application and made it a debug version?

From: http://msdn.microsoft.com/en-us/library/ms164704.aspx:

No matter how you start debugging, make sure that you build the Debug version of the DLL first and make sure that the Debug version is in the location where the application expects to find it. This may seem obvious, but if you forget this step, the application might find a different version of the DLL and load it. The program will then continue to run, while you wonder why your breakpoint was never hit. When you are debugging, you can verify which DLLs your program has loaded by opening the debugger's Modules window. The Modules window lists each DLL or EXE loaded in the process you are debugging. For more information, see How to: Use the Modules Window.

---

If you are attempting to debug a referenced dll, this SO article might be of assistance here: How to debug a referenced dll (having pdb)

~JOL