[.Net] C# Syntax Highlighting 에디터를 위한 ScintillaNET 사용하는 방법

샘플 코드는 본문 하단에 첨부되어 있습니다.

구문 강조(Syntax Highlighting)란?

ScintillaNET를 소개하기에 앞서, Syntax Highlighting에 대해 먼저 설명하겠습니다. 프로그래밍을 위한 컴파일러 텍스트 편집기 또는 일반 텍스트 에디터(notepad++)를 보면, 구문 강조 및 가독성을 위한 하이라이팅 기능이 탑재되어 있습니다.

이 구문 강조 기능은 바로 아래 그림과 같습니다.

티스토리 에디터의 Syntax Highlighting 기능

단어만 봐서는 뭘까 싶겠지만, 그림을 보면 누구나 다 아는 것일 겁니다. 프로그래밍 언어에 상관없이 거의 모든 에디터는 Syntax Highlighting 기능을 지원하고 있습니다.

ScintillaNET 이란?

블로그처럼 웹 페이지에서 사용할 수 있는 Syntax Highlighting 컴포넌트는 여러 가지가 있는데요. 그중에서도 highlight.js가 유명하죠.

출처: highlight.js 홈페이지

인터넷에 설치 방법이나 사용 방법이 많이 나와 있어, 적용 및 사용 방법이 쉬운 편입니다. 그런데, 윈도우 응용 프로그램에 해당 기능을 추가하는 것은 정말 까다로운 일입니다. 기본적으로 MFC나 C# 모두 이런 에디터 컨트롤을 제공하지 않기 때문이죠(물론 이런 기능이 필요한 일도 거의 없지만요).

하지만 윈도우 응용 프로그램을 위한 라이브러리가 따로 있습니다. 바로, Scintilla인데요. Scintilla는 무료 소스 코드 에디터 컴포넌트로, 개인이나 상용 목적으로 사용이 가능합니다. 그리고 .Net에서 사용할 수 있게 Wrapping 된 것이 ScintillaNET이죠.

Scintilla 홈페이지: https://www.scintilla.org/index.html

Scintilla and SciTE

ScintillaNET GitHub: https://github.com/jacobslusser/ScintillaNET

GitHub - jacobslusser/ScintillaNET: A Windows Forms control, wrapper, and bindings for the Scintilla text editor.

ScintillaNET 적용 모습

그럼 ScintillaNET을 적용하면 어떤 모습인지 먼저 보겠습니다. 아래 이미지와 애니메이션은 티스토리 에디터의 색상을 맞춘 모습입니다.

Tistory HTML Editor 색상으로 맞춘 모습

HTML 색상이 입혀진 ScintillaNET

C# Windows Forms 프로젝트에서 ScintillaNET 준비하기

Windows Forms 앱 선택 후 ExamScintillaNET 이름의 프로젝트를 생성합니다.

프로젝트 생성하기

프로젝트 생성 후 NuGet 패키지 관리 메뉴를 선택합니다.

NuGet 패키지 관리 메뉴 클릭

NuGet 패키지 화면에서 ScintillaNET을 검색하고, 최신 버전을 설치합니다.

NuGet에서 프로젝트에 ScintillaNET 설치하기

Form 디자인 화면에서 도구 상자의 목록을 보면 Scintilla 컴포넌트가 추가되어 있습니다.

도구 상자의 Scitilla 컴포넌트 사용

만약, 목록에 Scintilla 컴포넌트가 없다면 항목 선택 메뉴에서 아래와 같이 수동으로 추가할 수 있습니다. Scintilla dll은 프로젝트 폴더의 packages 폴더 안에 dll이 있습니다.

수동으로 Scintilla dll 추가하기

여기까지 C# Windows Forms 앱에 ScintillaNET을 준비하는 과정이었습니다.

ScintillaNET CPP 스타일로 색상 설정하기

그럼, 이제 구문에 따른 색상을 적용해 보도록 하겠습니다.

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Windows.Forms;
using ScintillaNET;

namespace ExamScintillaNET
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();

            scintilla1.Margins[0].Type = MarginType.Number;
            scintilla1.Margins[0].Width = 35;

            scintilla1.StyleResetDefault();
            scintilla1.Styles[Style.Default].Font = "Consolas";
            scintilla1.Styles[Style.Default].Size = 14;
            scintilla1.StyleClearAll();

            // CPP Lexer Style 설정
            scintilla1.Styles[Style.Cpp.Default].ForeColor = Color.Silver;
            scintilla1.Styles[Style.Cpp.Comment].ForeColor = Color.FromArgb(0, 128, 0);
            scintilla1.Styles[Style.Cpp.CommentLine].ForeColor = Color.FromArgb(0, 128, 0);
            scintilla1.Styles[Style.Cpp.CommentLineDoc].ForeColor = Color.FromArgb(128, 128, 128);
            scintilla1.Styles[Style.Cpp.Number].ForeColor = Color.Olive;
            scintilla1.Styles[Style.Cpp.Word].ForeColor = Color.Blue;
            scintilla1.Styles[Style.Cpp.Word2].ForeColor = Color.Blue;
            scintilla1.Styles[Style.Cpp.String].ForeColor = Color.FromArgb(163, 21, 21);
            scintilla1.Styles[Style.Cpp.Character].ForeColor = Color.FromArgb(163, 21, 21);
            scintilla1.Styles[Style.Cpp.Verbatim].ForeColor = Color.FromArgb(163, 21, 21);
            scintilla1.Styles[Style.Cpp.StringEol].BackColor = Color.Pink;
            scintilla1.Styles[Style.Cpp.Operator].ForeColor = Color.Purple;
            scintilla1.Styles[Style.Cpp.Preprocessor].ForeColor = Color.Maroon;
            scintilla1.Lexer = Lexer.Cpp;

            // keywords 설정
            scintilla1.SetKeywords(0, "abstract as base break case catch checked continue default delegate do else event explicit extern false finally fixed for foreach goto if implicit in interface internal is lock namespace new null object operator out override params private protected public readonly ref return sealed sizeof stackalloc switch this throw true try typeof unchecked unsafe using virtual while");
            scintilla1.SetKeywords(1, "bool byte char class const decimal double enum float int long sbyte short static string struct uint ulong ushort void");
        }
    }
}

위 코드는 아래와 같이 동작합니다.

예제 코드를 적용한 색상

원하는 스타일이 있다면 위 코드를 참고하여 색상을 변경하면 되겠습니다. 또는 인터넷에 검색하면 특정 언어에 대한 템플릿 색상을 구현해 놓은 곳도 있어, 해당 샘플 코드를 참고하면 도움이 됩니다.

자세한 내용은 아래 첨부된 샘플 코드를 참고하세요 :)

ExamScintillaNET.zip

2.49MB