기본 콘텐츠로 건너뛰기

[VSIX] Visual Studio 확장에 대해서... #3 Command 추가

이전 글에서 단순한 설정 파일을 추가하는 ItemTemplate 프로젝트를 구성해 보았다. 이번에는 이와 연관되어 INI 파일을 처리할 수 있도록 MENU 를 추가하고 MENU에 따른 Command 를 구성해 보도록 한다.

Add a simple command with menu

Command 를 추가하기 위해서는 Visual Studio와 연계할 수 있는 Command ID를 설정하는 작업을 처리하여야 한다. 패키지 프로젝트를 선택하고 "PkgCmdID.cs" 라는 이름의 클래스 파일을 추가하고 내부의 내용을 아래의 그림과 같이 설정하도록 한다.


클래스의 이름은 PkgCmdIDList 라고 지정한다.
그리고 패키지 클래스 (예제에서는 FDTWorksToolPackage.cs) 에 아래와 같이 특성을 지정해 준다.


위의 특성은 다음과 같은 의미를 가지고 있다.

  • ProvideMenuResource - 이 패키지가 어떤 메뉴 리소스로 표현될 것인지를 Shell에서 알려주는 역할을 담당한다.
  • ProvideAutoLoad - 패키지가 솔루션이 존재하고 모두 완전히 로드된 후에 로드되어야 한다는 것을 알려주는 역할을 담당한다.
이제 Menu 와 Command 를 연결하기 위한 파일을 또 하나 추가하여야 한다. 파일의 이름은 패키지 이름을 사용하여 "FDTWorksTool.vsct" 라고 추가하도록 한다. 그리고 아래의 그림과 같이 기본적인 구성을 하도록 한다.


이제 솔루션을 닫고 일반 텍스트 에디터에서 패키지 프로젝트 파일 (FDTWorksTool.csproj) 을 열고 위에서 추가한 FDTWorksTool.vsct 파일을 지정하고 있는 <ItemGroup> 요소를 찾으면 아래의 그림과 같이 설정되어 있는 것을 확인할 수 있다.


위의 구조를 아래의 구조와 같이 변경하도록 한다.


위의 구성은 다음과 같은 의미를 갖는다.
  • VSCTCompile - VSCT 컴파일러를 통해서 해당 파일이 컴파일 되어야 한다는 것을 설정한다.
  • ResourceName - 위에서 패키지 클래스에 지정한 특성인 "ProvideMenuResource" 에 지정한 리소스 명을 똑같이 지정하여 사용할 수 있도록 설정한다.

Create the menu

이제 다시 솔루션을 열고 패키지 프로젝트에 생성해 놓았던 vsct 파일을 구성하여야 하는데 아래의 개념적인 구조를 알아보고 진행하도록 하자.


위의 내용을 보면 뭔가 굉장히 복잡(?)스럽다. 그러나 몇 가지 규칙을 정리하면 그나마 위안이 된다.
  • guid - 그룹 또는 메뉴 그룹을 식별하기 위한 식별 코드라고 이해하면 된다. 즉, 부모의 guid를 자식 요소들에서 같이 사용한다는 뜻이다.
    • Commands, Groups, Menus, Buttons, Symbols 와 같이 그룹으로 처리하고 싶은 경우에 설정한다.
    • 설정한 guid 는 반드시 이후에 확인할 Symbols 섹션에 정의가 되어 있어야 한다.
    • 위의 예제에서는 패키지 내부에서 사용할 모든 요소들이 guidFDTWorksToolCmdSet 이라는 guid 값으로 묶여서 사용된다.
  • id - 각 항목을 식별하기 위한 코드라고 생각하면 된다.
    • guid로 묶인 항목들 중에서 개별 항목을 식별할 수 있는 값으로 반드시 특정 GuidSymbol 값들 중에 하나로 지정되어야 한다.
    • 설정한 id 는 이후에 확인할 GuidSymbol 섹션에 IDSymbol 태그로 정의가 되어있어야 한다.
이제 개념적인 것을 확인해 보았으니 아래와 같이 완전한 vsct 파일을 구성해 보도록 한다.

<?xml version="1.0" encoding="utf-8"?>
<CommandTable xmlns="http://schemas.microsoft.com/VisualStudio/2005-10-18/CommandTable"
       xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <!-- Visual Studio 에서 제공하는 모든 명령들에 대한 ID 들을 참조 -->
    <Extern href="stdidcmd.h"/>
    <!-- Shell 에서 제공하는 모든 명령들에 대한 ID 들을 참조 -->
    <Extern href="vsshlids.h"/>

    <!-- 패키지 Command 정의 -->
    <Commands package="guidFDTWorksToolPkg">
        <Menus>
     <!-- Main Item Menu Group 밑으로 표시될 서브 메뉴 정의 -->
     <Menu guid="guidFDTWorksToolCmdSet"
    id="FDTWorksToolSubMenu"
    priority="0x0000"
    type="Menu">
  <Parent guid="guidFDTWorksToolCmdSet"
   id="mainItemMenuGroup"/>
  <Strings>
      <ButtonText>FDTWorks</ButtonText>
  </Strings>
     </Menu>
 </Menus>

 <Groups>
     <!-- 항목 컨텍스트 메뉴 그룹 정의 (Shell 연결) -->
     <Group guid="guidFDTWorksToolCmdSet"
     id="mainItemMenuGroup"
     priority="0x0600">
  <Parent guid="guidSHLMainMenu"
   id="IDM_VS_CTXT_ITEMNODE"/>
     </Group>
     <!-- 서브 메뉴 밑으로 연결된 메뉴 그룹 정의 (FDTWorksToolSubMenu 연결) -->
     <Group guid="guidFDTWorksToolCmdSet"
     id="FDTWorksToolSubMenuGroup"
     priority="0x0600">
  <Parent guid="guidFDTWorksToolCmdSet"
   id="FDTWorksToolSubMenu"/>
     </Group>
 </Groups>

 <Buttons>
     <!-- 서브 메뉴 그룹에 추가될 버튼 정의 (FDTWorksToolSubMenuGroup 연결) -->
     <Button guid="guidFDTWorksToolCmdSet"
             id="cmdidGenerateIni"
      priority="0x0100"
      type="Button">
  <Parent guid="guidFDTWorksToolCmdSet"
   id="FDTWorksToolSubMenuGroup" />
  <Strings>
         <ButtonText>Generate Ini</ButtonText>
  </Strings>
     </Button>
 </Buttons>
    </Commands>

    <Symbols>
        <!-- 패키지 식별 GUID (Guids.cs 연계) -->
 <GuidSymbol name="guidFDTWorksToolPkg"
        value="{4cd5ac46-6001-41e5-ad03-da2dcaf9a4bb}" />

    <!-- 그룹과 메뉴 명령 식별 GUID (Guids.cs 연계) -->
 <GuidSymbol name="guidFDTWorksToolCmdSet"
      value="{25af2767-aa7e-4922-a723-622c4f8d18b6}">
     <IDSymbol name="mainItemMenuGroup"
        value="0x1020" />
       <IDSymbol name="FDTWorksToolSubMenu"
        value="0x2020"/>
     <IDSymbol name="FDTWorksToolSubMenuGroup"
        value="0x1021" />
     <IDSymbol name="cmdidGenerateIni"
        value="0x0100" />
        </GuidSymbol>
    </Symbols>
</CommandTable>

위의 내용을 보면 우선 가장 아래 부분에 사용할 Symbols 섹션을 통해서 guid 와 id 로 사용될 값들이 지정된 것을 볼 수 있다.
  • GuidSymbol / FDTWorksToolPkg - 패키지 자체의 guid 를 의미한다. 값은 패키지가 생성될 때 자동으로 생성된 Guids.cs 파일에 상수로 저장된 값을 사용한다.
  • GuidSymbol / FDTWorksToolCmdSet - 메뉴 및 명령 처리에 사용할 guid를 의미한다. 값은 패키지가 생성될 때 자동으로 생성된 Guids.cs 파일에 상수로 저장된 값을 사용한다.
그리고 IDSymbol 중에서 vsct 파일에 내부적으로 정의되지 않고 사용된 cmdidGenerateIni 의 값인 0x0100 은 위에서 만들었던 PkgCmdID.cs 파일에 정의된 값을 사용하는 것이다.

나머지 Menus, Groups, Buttons 는 각각 Parent 요소를 가지고 있고, 이를 통해서 자신이 누구의 밑으로 위치해야 하는지를 연결하게 된다. 위의 vsct 파일에서는 가장 최상위가 guidSHLMainMenu 로 IDM_VS_CTXT_ITEMNODE (Visual Studio 가 제공하는 항목 처리용 Context 메뉴) 가 되고 그 밑으로 패키지에서 사용하는 Group 과 Menu, Button 이 연결되어 표시되게 된다.

guidSHLMainMenu 값은 vsct 파일의 상단에 정의한 두 개의 헤더 파일 내에 정의되어 있는 값이다. 이와 관련해서 좀 더 상셍한 정보는 MSDN을 통해서 확인하면 된다.

여기까지 작업을 하고 F5 나 Ctrl + F5 로 실행을 해 보면 아래의 그림과 같이 프로젝트 내의 특정 항목을 선택하고 마우스 오른쪽 버튼을 눌러 나오는 컨텍스트 메뉴에 패키지에서 구성한 메뉴가 보이는 것을 확인할 수 있다.


위의 그림에서 확인되는 것과 같이 프로젝트 내에서 특정한 항목 (여기서는 Programs.cs) 을 선택하고 컨텍스트 메뉴를 호출하면 "FDTWorks" 와 "Generate Ini" 메뉴가 보이는 것을 확인할 수 있다.

Connecting the action

현재까지는 단순히 눈에만 보이는 메뉴 구조가 완성되었을 뿐이다. 실제 메뉴를 통해서 연계되어 동작할 코드는 없으므로 처리를 추가하여야 한다.

우선 패키지 클래스 (FDTWorksToolPackage.cs) 의 Initialize 메서드에 아래의 그림과 같이 Command 를 생성하고 등록하는 코드를 구성하도록 한다.


메뉴 서비스와 연동되는 작업은 위의 코드로 구성되었기 때문에 위의 코드에서 지정한 것과 같이 메뉴가 눌렸을 때 호출될 이벤트 콜백 메서드를 작성하여야 한다.

이 콜백 메서드에서는 EnvDTE (Visual Studio IDE) 에서 선택된 항목 (컨텍스트 메뉴를 보여주기 위해서) 의 이름과 전체 경로를 메시지 박스로 처리하는 것을 샘플로 사용할 것이다. 따라서 이 기능을 위해서는 다음과 같은 작업이 진행되어야 한다.

  • GetService 메서드를 통해서 DTE 인스턴스를 가져온다.
  • 인스턴스를 통해서 현재 선택된 항목 (Multiple 선택 가능) 들을 가져온다.
  • 해당 항목의 프로젝트 구성항목 (ProjectItem) 을 가져온다.
  • 만일 null 이라면 제외하고 그렇지 않다면 전체 경로를 제공하는 속성을 가져온다.
  • 속성이 null 이 아니라면 경로를 가져와서 메시지 박스를 처리한다.
위의 처리를 구현한 코드는 아래의 그림과 같다.


다시 실행을 해서 패키지에서 추가한 메뉴를 클릭하면 아래의 그림과 같이 콜백이 실행된 결과를 확인할 수 있다.



단순하지만 패키지를 운영할 때 기능들을 특정 메뉴 밑으로 구성하는 처리 등을 할 경우는 위와 같이 설정을 조정해서 운영하면 된다.

댓글