기본 콘텐츠로 건너뛰기

[ DSL ] Domain Specific Language - #2 DSL Authoring 솔루션 만들어 보기

  아직 명확하게 DSL 특정 지우기에는 시기상조이기는 하지만 Visual Studio 에서 제공하는 DSL Tools 기능을 이용해서 솔루션을 만들어서 아주 간단하게 실체를 확인해 보도록 하자.

DSL Authoring Solution

  DSL 을 사용할 수 있도록 DSL 자체를 구성하는 작업을 "DSL Authoring" 이라고 한다. 즉, 배포된 DSL을 이용할 수 있도록 DSL 의 Shape, Connector 등의 기본 요소들을 구성하는 단계라고 보면 된다.

  이 작업을 위해서는 사용할 Visual Studio 버전에 맞는 "Visual Studio SDK" 가 미리 설치되어 있어야 한다. 설치가 되어 있다면 Visual Studio에서 새 프로젝트를 추가할 때 아래의 그림과 같이 "확장성" 부분이 있는 것을 볼 수 있다.


  "Domain-Specific Language Designer" 는 DSL 구성을 위한 프로젝트들로 구성된 솔루션을 만드는 템플릿이다. 프로젝트 이름과 위치를 설정한 후에 확인 버튼을 눌러서 계속 진행하면 프로젝트를 구성하기 위한 마법사가 진행된다.


  DSL 에 대한 Template 은 "Minimal"을 선택하고, DSL 이름은 "IssueStateModels" 라고 지정하도록 한다.

  위의 그림과 같이 DSL 을 구성하기 위한 여러 개의 템플릿들이 존재하는 것을 볼 수 있다. MSDN 에는 템플릿들에 대해서 아래의 표와 같이 설명하고 있다.

Template
Features
Description
Class Diagrams
  • Compartment shapes
  • Class inheritance
  • Relationship inheritance
  • Shape inheritance
  • Relationship properties
Use this solution template if your domain-specific language includes entities and relationships that have properties. This template creates a domain-specific language that resembles UML class diagrams. The main entities are classes and interfaces, together with association, generalization, and implementation relationships. A class or interface appears as a box that contains a list of attributes.
Component Diagrams
  • Ports
Use this solution template if your domain-specific language includes components, that is, parts of a software system. This template creates a domain-specific language that resembles UML component diagrams. The main entities are components and ports, which appear as small shapes on the outside of components.
Task Flow Diagrams
  • Image and geometry shapes
  • Swimlanes
Use this solution template if your domain-specific language includes workflows, states, or sequences. This template creates a domain-specific language that resembles UML activity diagrams. The main entity is an activity, and the main relationship is a transition between activities. The template includes several other elements such as start state, final state, and a synchronization bar.
Minimal Language
  • One class and shape
  • One relationship and connector
Use this solution template if your domain-specific language does not resemble the other templates. This template creates a domain-specific language that has two classes and one relationship, which are represented in the Toolbox as Box and Line. The class and the relationship each have an example string property.
Minimal WinForm Designer
  • A small model.
  • A Windows Form that displays the model.
Use this template if you want to build an application in which a DSL is bound to a Windows Form, rather than a graphical designer.
The form that acts as the user interface for the language is in the folder Dsl\UI.
You should build the project before opening the form designer.
Minimal WPF Designer
  • A small model
  • A Windows Presentation Foundation user interface that displays the model
Use this template if you want to build an application in which a DSL is bound to a WPF user interface, rather than a graphical designer.
The designer for the user interface is in the folder Dsl\UI.
You should build the project before opening the UI designer.
DSL Library
  • A minimal library
Use this template if you want to build a partial DSL definition that can be imported into other DSL definitions.

  위의 템플릿 설명에 따라서 작성하려고 하는 DSL 에 가장 근접하게 지원을 하는 템플릿을 선택하여 사용하면 된다. "다음" 버튼을 누르면 아래의 그림과 같이 새로운 모델을 생성했을 때 사용할 확장자를 결정하는 마법사 페이지가 나타난다.


  IssueStateModel 이라고 솔루션을 정했으므로 확장자는 위와 같이 "iss" 라고 임의로 정하도록 한다. "다음" 버튼을 누르면 아래의 그림과 같이 설정관련 마법사 페이지를 볼 수 있다.


  각각 새롭게 만든 DSL 을 의미하는 프로덕트의 이름과 회사명, Root Namespace 등을 임의대로 지정하고 "다음" 버튼을 누르면 아래의 그림과 같이 서명을 어떻게 할 것인지를 설정하는 마법사 화면이 나타난다.


  생성된 DSL 솔루션은 패키지 형태로 배포가 될 것이기 때문에 서명 처리가 필요한데, 별도의 서명 키가 없다면 새로 생성하도록 한다. "다음" 버튼을 누르면 전체 요약이 아래의 그림과 같이 보여진다.


  이제 "마침" 버튼을 누르면 아래의 그림과 같이 템플릿을 기준으로 생성된 솔루션과 DSL Designer 화면이 열려있는 것을 확인할 수 있다.

 

  왼쪽의 그림은 DSL 디자이너에 표현된 것들 중에서 왼쪽은 클래스와 연결선들, 오른쪽은 모양과 컨넥터들을 정의한 것들을 보여주고 있다. 오른쪽의 그림은 DSL Explorer 와 속성 창으로 DSL 모델과 모양들에 대한 구성과 각 항목들에 대한 속성들을 볼 수 있다. 그리고 두 번째 그림은 생성된 프로젝트로 DSL 이라는 프로젝트는 DSL Definition 을 위한 프로젝트이고, DSLPackage는 설치를 위한 패키지 프로젝트로 두 개의 프로젝트가 생성된 것을 확인할 수 있다.

  이렇게 생성된 프로젝트에 대해서 처리할 작업 대상은 아래와 같이 정리할 수 있다.
  • Issue State Designer - 작성된 DSL 을 이용할 사용자들이 사용할 수 있는 모델 정의 및 디자인
  • Code Generators - 모델에 따라서 코드를 생성할 수 있도록 하는 코드 템플릿
  • Serializer - 디자인된 모델을 파일 (*.iss) 로 저장하고 로드할 수 있도록 Serializer를 구성 (디자이너 뿐만 아니라 Generator 에서도 사용할 수 있도록)
  여기서 잠깐 정리하고 넘어가야 하는 것이 있다. 바로 "DSL 솔루션은 뭘까?" 라는 것이다.


위에서 확인한 것과 같이 "DSL", "DSLPackage" 라는 두 개의 프로젝트가 생성된 것을 알 수 있다. 이 중에서 DSL 프로젝트는 다음과 같은 기능을 제공해야 한다.
   * DSL 을 파일로 저장/로드 할 수 있는 Serializer/Deserializer 를 제공해야 한다.    * DSL Authoring 결과를 사용하는 어플리케이션에서 DSL 과 다이어그램에 대한 처리가 가능하도록 관련된 클래스들이 제공되어야 한다.    * DSL 이 처리될 때 코드를 생성할 수 있는 텍스트 템플릿을 구성할 수 있도록 지시 처리기를 제공해야 한다.    * Visual Studio 에서 DSL 을 편집할 수 있도록 필수적인 컴포넌트들을 제공해야 한다.
DSLPackage 프로젝트는 Visual Studio에서 DSL이 동작할 수 있도록 코드를 제공해야 한다. 그리고 다른 패키지 프로젝트와 동일한 기능들을 제공해야 한다.
   * 디자이너에서 열리는 DSL 파일 확장자 (*.iss)를 인식할 수 있도록 문서 처리기를 제공해야 한다.    * DSL 디자이너와 연동되는 메뉴 커맨드를 제공해야 한다.    * 새로운 DSL 인스턴스를 생성할 수 있도록 Item Template 을 제공해야 한다.
상기와 같이 각 프로젝트에는 "GeneratedCode" 라는 이름의 폴더가 존재한다. 이 폴더에는 확장자가 *.tt인 텍스트 템플릿 파일들이 존재한다. 이 파일들에 연결된 서브 항목을 열어보면 생성된 코드를 볼 수 있다. 대부분은 DSL Tools 가 설정된 폴더 밑에 있는 "TextTemplates" 파일을 Including 하는 형식으로 구성되어 있다. 모든 생성된 파일들은 "Dsl\DslDefinition.dsl" 로 부터 자동 생성된 것이다. 따라서 이 파일들을 수정해서 안 된다. 이후에 다시 생성되면 수정된 내용이 유실되기 때문이다.  이런 경우는 partial class 처리를 해서 수정된 내용을 유지할 수 있도록 하여야 한다.

  앞으로 하나씩 솔루션을 변경해서 원하는 기능들을 추가할 것이다. 지금은 단순히 F5를 눌러서 제대로 동작하는지만 검토해 보도록 한다. 당연한 말이지만 이 솔루션은 Visual Studio의 기능을 확장하는 것이기 때문에 Visual Studio 가 실행된다. 그리고 아래의 그림과 같이 DSL Model을 사용할 수 있도록 기본 솔루션이 생성되어 열린 것을 확인할 수 있다. 그리고 "Sample.iss" 와 "Test.iss" 파일이 존재한다. 이 파일들을 열어 보면 DSL 디자이너 화면이 나타나는 것을 볼 수 있다. ToolBox 를 열어 보면 DSL Authoring에서 구성한 요소들을 볼 수 있다.


  다음 게시 글에서는 실제로 DSL 을 정의하는 것부터 진행하도록 한다.

댓글