Roslyn을 이용해 C# 문법 변형하기 (2)
Pre build 단계를 거치는 것도 좋겠지만, 역시나 geek스러운 사람들이 원하는 것은 컴파일 시 변형입니다. 이에 대해 좋은 사례를 아래의 블로그에서 찾을 수 있습니다.
Adventures in Roslyn: Adding crazily powerful operator overloading to C# 6
; https://smellegantcode.wordpress.com/2014/04/24/adventures-in-roslyn-adding-crazily-powerful-operator-overloading-to-c-6/
위의 글을 정리해 보면.
원래 다음과 같이 배열을 연결하는 '+' 연산 기능은 C#에 없는데,
class Program
{
static void Main(string[] args)
{
var nums1 = new[] { 1, 2, 3 };
var nums2 = new[] { 4, 5 };
var nums3 = nums1 + nums2;
}
}
'+' 연산자가 사용된 피연산자에 대해 '확장 메서드'를 정의해 둔다면,
using System.Collections.Generic;
using System.Linq;
public static class EnumerableOperatorExtension
{
public static IEnumerable<T> Addition<T>(this IEnumerable<T> left, IEnumerable<T> right)
{
return left.Concat(right);
}
}
class Program
{
static void Main(string[] args)
{
var nums1 = new[] { 1, 2, 3 };
var nums2 = new[] { 4, 5 };
var nums3 = nums1 + nums2;
}
}
어차피 '+' 연산자의 메서드 명이 "Addition"이기 때문에 그것과 연결지어 컴파일을 가능하게 만들자는 의도입니다. 이를 위해 수정한 곳은, Compilers / CSharp / CSharpCodeAnalysis 프로젝트의 Binder_Operators.cs 파일입니다.
// E:\roslyn\src\Compilers\CSharp\Portable\Binder\Binder_Operators.cs
private BoundExpression BindSimpleBinaryOperator(BinaryExpressionSyntax node, DiagnosticBag diagnostics,
BoundExpression left, BoundExpression right, ref int compoundStringLength)
{
// ...[생략]...
LookupResultKind resultKind;
ImmutableArray<MethodSymbol> originalUserDefinedOperators;
var best = this.BinaryOperatorOverloadResolution(kind, left, right, node, diagnostics, out resultKind, out originalUserDefinedOperators);
// However, as an implementation detail, we never "fail to find an applicable
// operator" during overload resolution if we have x == null, etc. We always
// find at least the reference conversion object == object; the overload resolution
// code does not reject that. Therefore what we should do is only bind
// "x == null" as a nullable-to-null comparison if overload resolution chooses
// the reference conversion.
BoundExpression resultLeft = left;
BoundExpression resultRight = right;
MethodSymbol resultMethod = null;
ConstantValue resultConstant = null;
BinaryOperatorKind resultOperatorKind;
TypeSymbol resultType;
bool hasErrors;
if (!best.HasValue)
{
resultOperatorKind = kind;
resultType = CreateErrorType();
hasErrors = true;
}
else
{
// ...[생략]...
}
// ...[생략]...
}
BinaryOperatorOverloadResolution 메서드에서 '+' 연산자에 대해 overload된 연산자를 못 찾게 되어 실패를 반환하기 때문에 if (!best.HasValue) 절에서 한번 더 다음과 같이 확장 메서드에서 찾아 보는 코드를 추가합니다.
if (!best.HasValue)
{
string methodName = Enum.GetName(typeof(BinaryOperatorKind), kind);
var methodCall = MakeInvocationExpression(node, left, methodName, ImmutableArray.Create(right), diagnostics);
if (methodCall != null && !methodCall.HasAnyErrors)
{
return methodCall;
}
resultOperatorKind = kind;
resultType = CreateErrorType();
hasErrors = true;
}
사실, 저는 이 예제에서 '문법 확장'의 흥미로움보다는 이런 변화가 Visual Studio의 에디터에서도 일관되게 적용된다는 점이 마음에 듭니다. "
Adventures in Roslyn: Adding crazily powerful operator overloading to C# 6" 글에서도 설명하고 있지만 Addition 확장 메서드가 없는 경우 다음과 같이 Visual Studio 코드 에디터에서 올바르지 않다는 적색선(red squiggle)이 보이지만,
Addition 확장 메서드를 추가하면 이렇게 사라집니다.
그런데, 직접 제가 현재 버전의 RoslynLight.sln 빌드로 해보니까 아쉽지만 다음과 같이 적색선이 보입니다. (물론, 컴파일은 잘 됩니다.)
이유를 대충 분석해 보면, Process Explorer를 통해 devenv.exe내에 로드된 "Microsoft.CodeAnalysis.CSharp.dll"의 경로가 원래의 Visual Studio가 쓰던 것이기 때문입니다.
C:\Windows\assembly\NativeImages_v4.0.30319_32\Microsoft.C1d3c2215#\a1f942b3d6393e8b6c1d6a89f416f941\Microsoft.CodeAnalysis.CSharp.ni.dll
즉, GAC가 아닌 "%LOCALAPPDATA%\Microsoft\VisualStudio\14.0Roslyn\Extensions\MSOpenTech\OpenSourceDebug\0.7" 폴더에 우리가 새롭게 빌드한 "Microsoft.CodeAnalysis.CSharp.dll" 어셈블리를 로드해야만 적색선이 안 보일텐데, 그렇지 않은 것입니다.
그렇긴 해도 과거의 어느 시점에는 저것이 통합되었다는 것을 의미하니... 아마도 정식 버전에서는 어떻게 바뀌는 지 두고 봐야 할 것 같습니다. ^^
"
Adventures in Roslyn: Adding crazily powerful operator overloading to C# 6" 글에서 시도한 것은 어찌 보면 C# 6.0의 새로운 기능으로 추가된,
New Language Features in C# 6
; https://github.com/dotnet/roslyn/wiki/New-Language-Features-in-C%23-6
"Extension Add methods in collection initializers"라는 것과 다소 유사한 원칙을 따릅니다.
이 외에도 "Daniel Earwicker" 씨가 설명한 문법 변형 관련된 글이 2개가 더 있으니 관심있으신 분은 참고하세요. ^^
Adventures in Roslyn: A new kind of managed lvalue pointer
; https://smellegantcode.wordpress.com/2014/04/27/adventures-in-roslyn-a-new-kind-of-managed-lvalue-pointer/
Adventures in Roslyn: Using pointer syntax as a shorthand for IEnumerable
; https://smellegantcode.wordpress.com/2014/04/26/adventures-in-roslyn-using-pointer-syntax-as-a-shorthand-for-ienumerable/
그나저나, 이런 시도도 있었군요. ^^
Fody/Fody
; https://github.com/Fody/Fody
Manipulating the IL of an assembly as part of a build requires a significant amount of plumbing code. This plumbing code involves knowledge of both the MSBuild and Visual Studio APIs. Fody attempts to eliminate that plumbing code through an extensible add-in model.
로슬린 소스 코드 중에는 자동 생성되는 코드들이 있으므로 해당 파일을 직접 수정하는 것에 유의해야 합니다. 가령 이름에 ".Generated."라고 붙은 것들이 있는데요.
E:\roslyn\Binaries\Obj\CSharpCodeAnalysis\Debug\Syntax.xml.Generated.cs
이런 경우 "E:\roslyn\src\Compilers\CSharp\Portable\Syntax\Syntax.xml" 파일로부터 자동 생성되는 것들이기 때문에 변경하고 싶다면 syntax.xml을 변경해야 합니다.
그럼, 어떻게 자동생성되는지 과정을 한번 찾아 볼까요? ^^
우선 Syntax.xml 파일을 담고 있는 프로젝트 파일의 내용을 보면 다음과 같이 VSL.Imports.targets 파일과 CSharpSyntaxGeneratorToolPath 항목을 정의하고 있습니다.
============== E:\roslyn\src\Compilers\CSharp\Portable\CSharpCodeAnalysis.csproj ==============
<?xml version="1.0" encoding="utf-8"?>
<!-- Copyright (c) Microsoft. All Rights Reserved. Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information. -->
<Project ToolsVersion="4.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
<!-- ...[생략]... -->
<CSharpSyntaxGeneratorToolPath>$(OutDir)CSharpSyntaxGenerator.exe</CSharpSyntaxGeneratorToolPath>
<!-- ...[생략]... -->
<ImportGroup Label="Targets">
<Import Project="..\..\..\Tools\Microsoft.CodeAnalysis.Toolset.Open\Targets\VSL.Imports.targets" />
<Import Project="..\..\..\..\build\VSL.Imports.Closed.targets" />
<Import Project="$(SolutionDir)\.nuget\NuGet.targets" Condition="Exists('$(SolutionDir)\.nuget\NuGet.targets')" />
</ImportGroup>
</Project>
VSL.Imports.targets 파일을 보면 이것은 다시 내부에 GenerateCompilerInternals.targets을 포함합니다.
============== E:\roslyn\src\Tools\Microsoft.CodeAnalysis.Toolset.Open\Targets\VSL.Imports.targets ==============
<Project DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
<!-- ...[생략]... -->
<Import Project="GenerateCompilerInternals.targets" />
<!-- ...[생략]... -->
</Project>
GenerateCompilerInternals.targets을 보면 이제 수수께끼가 풀립니다.
============== E:\roslyn\src\Tools\Microsoft.CodeAnalysis.Toolset.Open\Targets\GenerateCompilerInternals.targets ==============
<!-- ...[생략]... -->
<Target
Name="GenerateSyntaxModel"
Inputs="@(SyntaxDefinition);$(VBSyntaxGeneratorToolPath);$(CSharpSyntaxGeneratorToolPath)"
Outputs="@(SyntaxDefinition -> '$(IntermediateOutputPath)%(Filename)%(Extension).Generated$(DefaultLanguageSourceExtension)')"
Condition="'$(Language)' == 'VB' or '$(Language)' == 'C#'"
>
<PropertyGroup>
<SyntaxGenerator Condition="'$(Language)' == 'VB'">$(MonoPrefix) "$(VBSyntaxGeneratorToolPath)"</SyntaxGenerator>
<SyntaxGenerator Condition="'$(Language)' == 'C#'">$(MonoPrefix) "$(CSharpSyntaxGeneratorToolPath)"</SyntaxGenerator>
<GeneratedSyntaxModel>@(SyntaxDefinition -> '$(IntermediateOutputPath)%(Filename)%(Extension).Generated$(DefaultLanguageSourceExtension)')</GeneratedSyntaxModel>
</PropertyGroup>
<Exec
Command='$(SyntaxGenerator) @(SyntaxDefinition) $(GeneratedSyntaxModel)'
Outputs="$(GeneratedSyntaxModel)"
>
<Output TaskParameter="Outputs" ItemName="FileWrites" />
</Exec>
</Target>
<!-- ...[생략]... -->
테스트를 위해 위의 <Exec /> 부분을 주석처리하면 Syntax.xml 파일을 변경해도 Syntax.xml.Generated.cs 파일의 내용이 변경되지 않습니다.
[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]