Microsoft MVP성태의 닷넷 이야기
.NET Framework: 520. Roslyn을 이용해 C# 문법 변형하기 (1) [링크 복사], [링크+제목 복사],
조회: 17983
글쓴 사람
정성태 (techsharer at outlook.com)
홈페이지
첨부 파일
 

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

질문: Can I rewrite source code within the compiler pipeline?

답변: Roslyn does not provide a plug-in architecture throughout the compiler pipeline so that at each stage you can affect syntax parsed, semantic analysis, optimization algorithms, code emission, etc. However, you can use a pre-build rule to analyze and generate different code that MSBuild then feeds to csc.exe or vbc.exe. You can use Roslyn to parse code and semantically analyze it, and then rewrite the trees, change references, etc. Then compile the result as a new compilation.


대신, 컴파일 전 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>

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




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







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

Creative Commons License
이 저작물은 크리에이티브 커먼즈 코리아 저작자표시-비영리-변경금지 2.0 대한민국 라이센스에 따라 이용하실 수 있습니다.
by SeongTae Jeong, mailto:techsharer at outlook.com

비밀번호

댓글 작성자
 




... 61  62  63  64  [65]  66  67  68  69  70  71  72  73  74  75  ...
NoWriterDateCnt.TitleFile(s)
12023정성태9/18/201912753.NET Framework: 860. ServicePointManager.DefaultConnectionLimit와 HttpClient의 관계파일 다운로드1
12022정성태9/12/201915834개발 환경 구성: 458. C# 8.0 (Preview) 신규 문법을 위한 개발 환경 구성 [3]
12021정성태9/12/201927803도서: 시작하세요! C# 8.0 프로그래밍 [4]
12020정성태9/11/201914551VC++: 134. SYSTEMTIME 값 기준으로 특정 시간이 지났는지를 판단하는 함수
12019정성태9/11/20199883Linux: 23. .NET Core + 리눅스 환경에서 Environment.CurrentDirectory 접근 시 주의 사항
12018정성태9/11/20198861오류 유형: 567. IIS - Unrecognized attribute 'targetFramework'. Note that attribute names are case-sensitive. (D:\lowSite4\web.config line 11)
12017정성태9/11/201911941오류 유형: 566. 비주얼 스튜디오 - Failed to register URL "http://localhost:6879/" for site "..." application "/". Error description: Access is denied. (0x80070005)
12016정성태9/5/201912874오류 유형: 565. git fetch - warning: 'C:\ProgramData/Git/config' has a dubious owner: '(unknown)'.
12015정성태9/3/201916774개발 환경 구성: 457. 윈도우 응용 프로그램의 Socket 연결 시 time-out 시간 제어
12014정성태9/3/201911222개발 환경 구성: 456. 명령행에서 AWS, Azure 등의 원격 저장소에 파일 관리하는 방법 - cyberduck/duck 소개
12013정성태8/28/201914020개발 환경 구성: 455. 윈도우에서 (테스트) 인증서 파일 만드는 방법 [3]
12012정성태8/28/201917930.NET Framework: 859. C# - HttpListener를 이용한 HTTPS 통신 방법
12011정성태8/27/201916139사물인터넷: 57. C# - Rapsberry Pi Zero W와 PC 간 Bluetooth 통신 예제 코드파일 다운로드1
12010정성태8/27/201911365VS.NET IDE: 138. VSIX - DTE.ItemOperations.NewFile 메서드에서 템플릿 이름을 다국어로 설정하는 방법
12009정성태8/26/201911950.NET Framework: 858. C#/Windows - Clipboard(Ctrl+C, Ctrl+V)가 동작하지 않는다면?파일 다운로드1
12008정성태8/26/201911743.NET Framework: 857. UWP 앱에서 SQL Server 데이터베이스 연결 방법
12007정성태8/24/201910883.NET Framework: 856. .NET Framework 버전을 올렸을 때 오류가 발생할 수 있는 상황
12006정성태8/23/201914109디버깅 기술: 129. guidgen - Encountered an improper argument. 오류 해결 방법 (및 windbg 분석) [1]
12005정성태8/13/201912065.NET Framework: 855. 닷넷 (및 VM 계열 언어) 코드의 성능 측정 시 주의할 점 [2]파일 다운로드1
12004정성태8/12/201919857.NET Framework: 854. C# - 32feet.NET을 이용한 PC 간 Bluetooth 통신 예제 코드 [14]
12003정성태8/12/201912587오류 유형: 564. Visual C++ 컴파일 오류 - fatal error C1090: PDB API call failed, error code '3'
12002정성태8/12/201911577.NET Framework: 853. Excel Sheet를 WinForm에서 사용하는 방법 - 두 번째 이야기 [5]
12001정성태8/10/201916092.NET Framework: 852. WPF/WinForm에서 UWP의 기능을 이용해 Bluetooth 기기와 Pairing하는 방법 [1]
12000정성태8/9/201914969.NET Framework: 851. WinForm/WPF에서 Console 창을 띄워 출력하는 방법파일 다운로드1
11999정성태8/1/201910700오류 유형: 563. C# - .NET Core 2.0 이하의 Unix Domain Socket 사용 시 System.IndexOutOfRangeException 오류
11998정성태7/30/201911916오류 유형: 562. .NET Remoting에서 서비스 호출 시 SYN_SENT로 남는 현상파일 다운로드1
... 61  62  63  64  [65]  66  67  68  69  70  71  72  73  74  75  ...