[インデックス 16621] ファイルの概要

このコミットは、Notepad++ の Go 言語シンタックスハイライト定義ファイルに delete キーワードを追加するものです。これにより、Notepad++ が Go 言語の delete キーワードを正しく認識し、ハイライト表示できるようになります。

コミット

commit f0f97c1f47377a735b13dac32af9222905821d67
Author: ChaiShushan <chaishushan@gmail.com>
Date:   Mon Jun 24 13:28:10 2013 +1000

    misc/notepadplus: add missing delete keyword
    
    In general the description should describe what is added or fixed, not how it was done (the code does this), but in this case the cause was delete was missing, so the fix is to add it.
    
    Fixes #5759.
    
    R=adg
    CC=dave, dominik.honnef, gobot, golang-dev
    https://golang.org/cl/10476043

GitHub上でのコミットページへのリンク

https://github.com/golang/go/commit/f0f97c1f47377a735b13dac32af9222905821d67

元コミット内容

misc/notepadplus: add missing delete keyword

このコミットは、Notepad++ の Go 言語定義に delete キーワードが欠落していたため、それを追加するものです。コミットメッセージには、「通常、説明は追加または修正された内容を記述すべきであり、どのように行われたか（コードがそれを行う）ではないが、このケースでは delete が欠落していたことが原因であるため、修正はそれを追加することである」と述べられています。これは、この変更が特定の機能追加やバグ修正というよりも、既存の定義の不備を補完する性質のものであることを示唆しています。

Fixes #5759. という記述から、このコミットが Go プロジェクトのイシュートラッカーで報告された問題 #5759 を解決するものであることがわかります。

変更の背景

この変更の背景には、Notepad++ というテキストエディタにおける Go 言語のシンタックスハイライトの不完全性がありました。Go 言語には組み込み関数として delete が存在しますが、Notepad++ の当時の Go 言語定義ファイルにはこのキーワードが含まれていなかったため、エディタ上で delete が他のキーワードと同様にハイライト表示されず、コードの可読性が損なわれていました。

Go 言語の delete 関数は、マップから要素を削除するために使用される重要な組み込み関数です。プログラマーがコードを記述する際に、エディタが言語のキーワードを適切にハイライトすることは、構文エラーの早期発見やコード構造の理解に不可欠です。この欠落は、Go 言語開発者にとってNotepad++の利便性を低下させる要因となっていました。

このコミットは、Go プロジェクトのイシュートラッカーで報告された問題（#5759）に対応する形で実施されました。これは、Go 言語のツールやエコシステムを改善するための継続的な取り組みの一環であり、開発者がより快適にGo言語を扱えるようにするための細かな改善が積み重ねられていることを示しています。

前提知識の解説

Notepad++

Notepad++ は、Microsoft Windows で動作するフリーのソースコードエディタおよびメモ帳の代替ソフトウェアです。多くのプログラミング言語に対応しており、シンタックスハイライト、コード折りたたみ、オートコンプリートなどの機能を提供します。シンタックスハイライトは、キーワード、コメント、文字列などを異なる色で表示することで、コードの可読性を向上させる機能です。Notepad++ は、ユーザーがカスタム言語定義ファイル（XML形式）を作成・編集することで、新しい言語のサポートや既存の言語定義のカスタマイズを可能にしています。

シンタックスハイライト

シンタックスハイライトとは、プログラミング言語のソースコードやマークアップ言語のテキストを、その構文要素（キーワード、演算子、文字列、コメントなど）に応じて異なる色やスタイルで表示する機能です。これにより、コードの構造が視覚的に明確になり、可読性が大幅に向上します。また、タイプミスや構文エラーの発見にも役立ちます。

Go言語の delete 関数

Go言語には、組み込み関数として delete が存在します。この関数は、マップ（map 型）から指定されたキーとそれに対応する値を削除するために使用されます。

delete 関数の基本的な構文:

delete(m, key)

• m: 要素を削除するマップ。
• key: 削除する要素のキー。

delete 関数は、指定されたキーが存在しない場合でもエラーにはなりません。

例:

package main

import "fmt"

func main() {
    // マップの作成
    m := make(map[string]int)
    m["apple"] = 10
    m["banana"] = 20
    m["cherry"] = 30

    fmt.Println("Original map:", m) // Original map: map[apple:10 banana:20 cherry:30]

    // "banana" を削除
    delete(m, "banana")
    fmt.Println("Map after deleting banana:", m) // Map after deleting banana: map[apple:10 cherry:30]

    // 存在しないキーを削除してもエラーにならない
    delete(m, "grape")
    fmt.Println("Map after deleting grape (non-existent):", m) // Map after deleting grape (non-existent): map[apple:10 cherry:30]
}

delete は Go 言語の基本的な操作の一部であり、マップを扱う上で頻繁に使用されるため、シンタックスハイライトの対象となるべき重要なキーワードです。

XML (Extensible Markup Language)

XML は、マークアップ言語を作成するためのルールを定義するマークアップ言語です。データを構造化して表現するために使用され、人間にも機械にも読みやすい形式です。Notepad++ の言語定義ファイルは XML 形式で記述されており、<KeyWord> タグなどを用いて言語のキーワードを定義します。

技術的詳細

このコミットは、Notepad++ の Go 言語シンタックスハイライト定義を更新するために、2つのXMLファイルを変更しています。

1. misc/notepadplus/go.xml: このファイルは、Notepad++ の Go 言語定義の主要な部分を構成していると考えられます。変更内容は、<KeyWord name="delete" /> という行を既存のキーワードリストに追加することです。これは、Notepad++ が Go 言語の delete を認識し、デフォルトのキーワードとしてハイライトするための直接的な指示となります。

   変更前:

   		<KeyWord name="copy" />
   		<KeyWord name="default" /> 
   		<KeyWord name="defer" /> 
   		<KeyWord name="else" />
   

   変更後:

   		<KeyWord name="copy" />
   		<KeyWord name="default" /> 
   		<KeyWord name="defer" /> 
   		<KeyWord name="delete" /> 
   		<KeyWord name="else" />
   

   defer と else の間に delete が追加されています。

2. misc/notepadplus/userDefineLang.xml: このファイルは、Notepad++ のユーザー定義言語（User Defined Language: UDL）の設定に関連している可能性があります。UDL は、Notepad++ が標準でサポートしていない言語や、既存の言語定義をユーザーがカスタマイズしたい場合に使用されます。このファイルでは、Words1 という属性に、Go 言語の主要なキーワードがスペース区切りで列挙されています。このリストに delete が追加されています。

   変更前:

               <Keywords name="Words1">append bool break byte cap case chan close complex complex128 complex64 const continue copy default defer else error fallthrough false float32 float64 for func go goto if iota imag import int int16 int32 int64 int8 interface len make map new nil package panic print println range real recover return rune select string struct switch true type uint uint16 uint32 uint64 uint8 uintptr var</Keywords>
   

   変更後:

               <Keywords name="Words1">append bool break byte cap case chan close complex complex128 complex64 const continue copy default defer delete else error fallthrough false float32 float64 for func go goto if iota imag import int int16 int32 int64 int8 interface len make map new nil package panic print println range real recover return rune select string struct switch true type uint uint16 uint32 uint64 uint8 uintptr var</Keywords>
   

   defer の直後に delete が追加されています。

これらの変更により、Notepad++ は Go 言語の delete キーワードを正しく認識し、シンタックスハイライトの対象として扱うようになります。これは、Notepad++ を Go 言語の開発環境として使用しているユーザーにとって、コードの可読性と開発体験を向上させる小さな、しかし重要な改善です。

コアとなるコードの変更箇所

diff --git a/misc/notepadplus/go.xml b/misc/notepadplus/go.xml
index 237ef6b4b2..29031be0ea 100644
--- a/misc/notepadplus/go.xml
+++ b/misc/notepadplus/go.xml
@@ -17,6 +17,7 @@
 		<KeyWord name="copy" />
 		<KeyWord name="default" /> 
 		<KeyWord name="defer" /> 
+		<KeyWord name="delete" /> 
 		<KeyWord name="else" />
 		<KeyWord name="error" />
 		<KeyWord name="fallthrough" /> 
diff --git a/misc/notepadplus/userDefineLang.xml b/misc/notepadplus/userDefineLang.xml
index 2954aad488..a3312965ee 100644
--- a/misc/notepadplus/userDefineLang.xml
+++ b/notepadplus/userDefineLang.xml
@@ -11,7 +11,7 @@
             <Keywords name="Folder-"></Keywords>
             <Keywords name="Operators">( ) [ ] { } ... . , _ &amp; ^ %  &gt; &lt; ! = + - *  | :</Keywords>
             <Keywords name="Comment"> 1/* 2*/ 0//</Keywords>
-            <Keywords name="Words1">append bool break byte cap case chan close complex complex128 complex64 const continue copy default defer else error fallthrough false float32 float64 for func go goto if iota imag import int int16 int32 int64 int8 interface len make map new nil package panic print println range real recover return rune select string struct switch true type uint uint16 uint32 uint64 uint8 uintptr var</Keywords>
+            <Keywords name="Words1">append bool break byte cap case chan close complex complex128 complex64 const continue copy default defer delete else error fallthrough false float32 float64 for func go goto if iota imag import int int16 int32 int64 int8 interface len make map new nil package panic print println range real recover return rune select string struct switch true type uint uint16 uint32 uint64 uint8 uintptr var</Keywords>
             <Keywords name="Words2"></Keywords>
             <Keywords name="Words3"></Keywords>
             <Keywords name="Words4"></Keywords>

コアとなるコードの解説

このコミットは、Notepad++ の Go 言語シンタックスハイライト定義を更新するために、2つのXMLファイルに非常にシンプルな変更を加えています。

1. misc/notepadplus/go.xml の変更: このファイルは、Notepad++ が Go 言語の組み込みキーワードを認識するために使用する主要な定義ファイルです。変更点として、<KeyWord name="delete" /> という新しいXML要素が追加されています。これは、Notepad++ に対して「delete という文字列をキーワードとして認識し、それに応じたシンタックスハイライトを適用しなさい」という指示を与えています。この行が追加されたことで、Notepad++ は delete を他の Go 言語のキーワード（例: copy, default, defer, else など）と同様に扱うようになります。

2. misc/notepadplus/userDefineLang.xml の変更: このファイルは、Notepad++ のユーザー定義言語（UDL）の設定に関連する可能性があります。特に、<Keywords name="Words1"> という属性は、特定の言語の主要なキーワードのリストを保持しています。このコミットでは、この Words1 属性の値に delete という文字列が追加されています。この変更は、Notepad++ が delete をキーワードとして認識するためのもう一つの設定ポイントであると考えられます。go.xml と userDefineLang.xml の両方を変更することで、Notepad++ の異なる設定メカニズムを通じて delete キーワードの認識を確実にしていると推測されます。

これらの変更は、Notepad++ の Go 言語シンタックスハイライトの正確性を向上させ、Go 言語開発者が delete 関数を使用する際に、エディタが適切にキーワードをハイライト表示するようにするためのものです。これにより、コードの可読性が向上し、開発体験が改善されます。

関連リンク

• Go プロジェクトのイシュートラッカー: https://github.com/golang/go/issues/5759
• Go CL (Code Review): https://golang.org/cl/10476043

参考にした情報源リンク

• Notepad++ 公式サイト: https://notepad-plus-plus.org/
• Go 言語公式ドキュメント: https://go.dev/
• Go 言語の delete 関数に関するドキュメント (Go 1.2 のドキュメントを参照): https://go.dev/doc/go1.2#delete (コミットが2013年であるため、当時のGoのバージョンに合わせた情報源が適切)
• XML (Extensible Markup Language) の基本
• シンタックスハイライトの概念