Roslyn Adventures: Metaprogramming with StackExchange.Precompilation

In this article we’ll wrap the StringBuilderInterpolationOptimizer from my previous article into an StackExchange.Precompiltion module, and use it to optimize an existing C# project.

First things first, we start off with an empty console project, to which we add some sample StringBuilder.Append calls, passing interpolated strings as parameters:

Now, let's add the StackExchange.Precompilation.Build package to our demo project, and make sure it still builds. This package replaces csc.exe with a custom and hookable compiler, which is basically a wrapper around the roslyn API. Unfortunately, roslyn doesn't expose any hooks for adding custom processing from the command line (yet). Luckily the API let's you do all kinds of crazy stuff, it even comes with a parser for the csc.exe command line arguments...

After this package is successfully installed, you should see the precompiler executable being called instead of csc.exe in the build output window:

Next, we need to build the compilation module that can be loaded into the compilation. So we create an empty class library, and install the StackExchange.Precompilation.Metaprogramming package (contains all the required base types).

After we’ve pulled in the SyntaxTree rewriter from the last article, we can implement the hook. The interface we need to implement is ICompileModule. We want to implement the BeforeCompilation method, which allows us to inspect and modify our compilation before any IL is emitted. Inside this method we have full access to all syntax trees in the compilation and their semantic model. Note that CSharpCompilation is immutable, so we have to replace the one in the compilation context with the modified one:

All that’s left to do now is to wire up our shiny new compile module, so it's picked up as by the compiler. This is done in the app.config (or web.config for ASP.NET project) file of the console application:

The modified build script forwards the project’s config file to the compiler (this is especially useful when it needs to actually precompile razor views, but this is out of scope of this post). Also, be sure to add the precompilation module as a project reference to the console application.

After everything is set up correctly, a quick build and decompilation can verify that the emitted assembly contains optimized string builder calls:

The sources for this demo, along with commits reflecting the described steps, can be found on GitHub.

P.S. a useful trick for debugging your compilation module is to add a Debugger.Launch() call to attach your current VS instance to the currently executing compilation.