Roslyn을 이용해 C# 문법 변형하기 (1)

많은 사람들이 기대했던 것과는 다르게,

Can I use Roslyn for compile time code rewriting?
; http://stackoverflow.com/questions/7833954/can-i-use-roslyn-for-compile-time-code-rewriting

아쉽지만 rosyln은 소스 코드를 재작성할 수 있는 plug-in을 허용하지 않습니다. 이에 대해서는 로슬린 wiki에서도 공식적으로 밝히고 있습니다.

.NET Compiler Platform ("Roslyn") FAQ
; https://github.com/dotnet/roslyn/wiki/FAQ

대신, 컴파일 전 pre-build 단계를 하나 둬서 그때 roslyn을 사용해 기존 소스 코드를 자유롭게 재성성하라는 것입니다. 실제로 이런 식으로 WPF의 DependencyProperty 정의를 처리하는 방법을 다음의 글에서 보여주고 있습니다.

In bed with Roslyn
; http://www.mindscapehq.com/blog/index.php/2011/10/20/in-bed-with-roslyn/

---

물론, 자신만의 csc.exe 컴파일러를 만들 수 있으므로 roslyn 소스코드를 이용하면 어느 정도의 재미있는 놀이가 가능합니다. 지난번 글에서 로슬린 컴파일도 해봤으니,

C# 6.0 오픈 소스 컴파일러 Roslyn - 빌드 및 테스트 방법
; https://www.sysnet.pe.kr/2/0/10812

이번엔 간단한 변형을 한번 해보겠습니다. 일단, 테스트 용으로 소스 코드 파일을 하나 만들고,

// Program.cs
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace ConsoleApplication1
{
    class Program
    {
        static void Main(string[] args)
        {
            Console.WriteLine("TEST2");
        }
    }
}

이것을 csc 프로젝트의 F5 디버깅 모드로 실행하면 다음과 같이 흐름이 진행되는 것을 볼 수 있습니다.

[csc.csproj]

    Microsoft.CodeAnalysis.CSharp.CommandLine.Program.Main
        Microsoft.CodeAnalysis.BuildTasks.BuildClient.RunWithConsoleOutput
            Microsoft.CodeAnalysis.CSharp.CommandLine.Csc.Run
                Roslyn.Utilities.ConsoleUtil.RunWithOutput
                    
[CSharpCodeAnalysis.csproj]

                    Microsoft.CodeAnalysis.CommonCompiler.Run
                        Microsoft.CodeAnalysis.CommonCompiler.RunCore
                            Microsoft.CodeAnalysis.CSharp.CSharpCompiler.CreateCompilation
                                Microsoft.CodeAnalysis.CSharp.CSharpCompiler.ParseFile

따라서 개별 C# 파일 하나 당 "Microsoft.CodeAnalysis.CSharp.CSharpCompiler.ParseFile" 메서드 한번이 불려집니다. ParseFile 메서드를 보면,

private static SyntaxTree ParseFile(
    CSharpParseOptions parseOptions,
    CSharpParseOptions scriptParseOptions,
    SourceText content,
    CommandLineSourceFile file)
{
    var tree = SyntaxFactory.ParseSyntaxTree(
        content,
        file.IsScript ? scriptParseOptions : parseOptions,
        file.Path);

    // prepopulate line tables.
    // we will need line tables anyways and it is better to not wait until we are in emit
    // where things run sequentially.
    bool isHiddenDummy;
    tree.GetMappedLineSpanAndVisibility(default(TextSpan), out isHiddenDummy);

    return tree;
}

ParseSyntaxTree로 반환된 tree 인스턴스는 Microsoft.CodeAnalysis.SyntaxTree 타입입니다. 오~~~ 왠지 낯이 익는데요. ^^

Roslyn 맛보기 - Syntax Analysis (Roslyn Syntax API)
; https://www.sysnet.pe.kr/2/0/1157

그사이 버전업이 되면서 바뀐 것을 감안해 다음과 같이 테스트 해볼 수도 있을 것입니다.

private static SyntaxTree ParseFile(
    CSharpParseOptions parseOptions,
    CSharpParseOptions scriptParseOptions,
    SourceText content,
    CommandLineSourceFile file)
{
    var tree = SyntaxFactory.ParseSyntaxTree(
        content,
        file.IsScript ? scriptParseOptions : parseOptions,
        file.Path);

    // 소스 코드에 "namespace ConsoleApplication1"라는 문자열이 포함되었으면,
    // 기존 입력된 소스 코드를 무시하고 완전히 새로운 소스코드로 변경
    string txt = content.ToString();
    if (txt.IndexOf("namespace ConsoleApplication1") != -1)
    {
        Syntax.CompilationUnitSyntax tree2 = SyntaxFactory.ParseCompilationUnit(
                        @"using System;
        using System.Collections.Generic;
        using System.Linq;

        namespace HelloWorld
        {
            class Program
            {
                static void Main(string[] args)
                {
                    Console.WriteLine(""Hello, World!"");
                }
            }
        }");

        tree = tree2.SyntaxTree;
    }

    // prepopulate line tables.
    // we will need line tables anyways and it is better to not wait until we are in emit
    // where things run sequentially.
    bool isHiddenDummy;
    tree.GetMappedLineSpanAndVisibility(default(TextSpan), out isHiddenDummy);

    return tree;
}

빌드한 후 새롭게 바뀐 csc.exe로 이 글의 예제인 Program.cs 파일을 컴파일해 보면,

E:\ConsoleApplication1>E:\roslyn\Binaries\Debug\csc program.cs
Microsoft (R) Visual C# Compiler version 42.42.42.42
Copyright (C) Microsoft Corporation. All rights reserved.

error CS2041: Invalid output name: Name cannot be empty.

오류가 발생하는 군요. 왜냐하면 SyntaxFactory.ParseCompilationUnit 컴파일해서 나온 SyntaxTree에는 파일명 정보가 없어서 그런 듯 합니다. 따라서, /out 옵션으로 명시해 주어야 합니다.

E:\ConsoleApplication1>E:\roslyn\Binaries\Debug\csc program.cs /out:program.exe
Microsoft (R) Visual C# Compiler version 42.42.42.42
Copyright (C) Microsoft Corporation. All rights reserved.

이렇게 컴파일된 Program.cs 파일은 원래는 Console.WriteLine("TEST2"); 코드에 의해 "TEST2"를 출력해야 하지만, 컴파일이 가로채어졌으므로 Console.WriteLine(""Hello, World!""); 코드의 영향으로 "Hello, World!"가 출력됩니다.

E:\ConsoleApplication1>program.exe
Hello, World!

결국 우리는, SyntaxTree를 생성해 내는 roslyn 내부의 작업에서 적절한 순간만 찾아서 변형해주면 어떠한 작업도 가능한 것입니다.

---

이건 혹시나 싶어 적어두는 건데, 테스트하다가 xaml 코드에 대해 다음과 같은 컴파일 오류로 RoslynLight 솔루션 빌드에 실패하는 경우가 있었습니다.

'Method not found: 'Boolean System.Type.IsAssignableFzom(System.Type)'. Line 0 Position 0.'    SyntaxVisualizerControl E:\roslyn\src\Tools\Source\SyntaxVisualizer\SyntaxVisualizerControl\SyntaxVisualizerControl.xaml    

"E:\roslyn\src\RoslynLight.sln" (default target) (1) ->
"E:\roslyn\src\Tools\Source\SyntaxVisualizer\SyntaxVisualizerControl\SyntaxVisualizerControl.csproj" (default target) (35) ->
(MarkupCompilePass1 target) ->
  E:\roslyn\src\Tools\Source\SyntaxVisualizer\SyntaxVisualizerControl\SyntaxVisualizerControl.xaml : error MC1000: Unknown build error, 'Method not found: 'Boolean System.Type.IsAssignableFzom(System.Type)'. Line 0 Position 0.'  [E:\roslyn\src\Tools\Source\SyntaxVisualizer\SyntaxVisualizerControl\SyntaxVisualizerControl.csproj]

이 오류가 참... 기가 막히는 부분이 있는데 잘 보시면 원래의 메서드 명은 IsAssignableFrom인데, IsAssignableFzom을 찾고 있습니다.

일단 이 오류 발생한 이후부터는 Visual Studio 2013조차도 WPF 프로젝트 빌드 시 모든 .xaml 파일에 대해 컴파일 오류가 납니다. 참고로, xaml 파일은 csc.exe 컴파일 전에 "MarkupCompilePass1"이라는 MSBuild Task 단계를 거칩니다. 일례로, csproj 파일을 다음과 같이 구성해 주면 csc 컴파일 단계까지 안 가고 markup compile만 해볼 수 있습니다.

<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
  <UsingTask 
    TaskName="Microsoft.Build.Tasks.Windows.MarkupCompilePass1" 
    AssemblyFile="C:\Program Files\Reference Assemblies\Microsoft\Framework\v3.0\PresentationBuildTasks.dll" />
  <Target Name="MarkupCompilePass1Task">
    <MarkupCompilePass1 
      AssemblyName="WPFMSBuildSample"
      Language="C#"
      OutputType="WinExe"
      OutputPath="obj\Debug\"
      ApplicationMarkup="App.xaml"
      PageMarkup="MainWindow.xaml;"
      SourceCodeFiles="MainWindow.xaml.cs"
      References="C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETFramework\v3.5\Profile\Client\System.dll;C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETFramework\v3.5\Profile\Client\PresentationCore.dll;C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETFramework\v3.5\Profile\Client\PresentationFramework.dll;C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETFramework\v3.5\Profile\Client\WindowsBase.dll" />
  </Target>
</Project>

암튼, 바로 저 단계에서 빌드 실패가 발생하는 것인데... 결국 원인을 못 찾았습니다. 하지만, 재부팅하는 것으로 해결을 했습니다. ^^;

---

[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]

[최초 등록일: 6/21/2015]
[최종 수정일: 7/10/2021]


이 저작물은 크리에이티브 커먼즈 코리아 저작자표시-비영리-변경금지 2.0 대한민국 라이센스에 따라 이용하실 수 있습니다.

by SeongTae Jeong, mailto:techsharer at outlook.com