QtCreatorの重複コード検索プラグイン

コードの重複は、変更の導入、ソーステキストの理解、およびそれらのさらなるメンテナンスを複雑にします。 重複を避け、コードの品質とそのリファクタリングを評価するために、一部のIDEには重複コードフラグメントを見つけるためのツールが組み込まれています。 プラグインは他のIDE用に作成されています。 ただし、これまでのところ、QtCreator開発環境には組み込みツールや再試行検索プラグインがありませんでした。
この記事では、このIDEの自動重複検索タスクに対する2つのソリューションについて説明します。サードパーティのユーティリティ統合ツールを使用することと、QtCreatorを使用するC ++プログラマに役立つ開発プラグインを使用することです。

1サードパーティの重複コード検索ユーティリティの統合

サードパーティユーティリティの統合メカニズムは、QtCreatorの機能を拡張する強力な手段です。 セットアッププロセスの詳細は、 マニュアルに記載されています 。 simianコンソールユーティリティ-Similarity Analyzer （プラグインでも使用されます）は、重複検索ツールとして選択されました。 QtCreatorに統合するには、次の手順を完了する必要があります。
1.アプリケーションをインストールします。
Windows：
Windowsシステムの場合は、exeアプリケーションを使用します（ 作成者のサイトからダウンロードページ 。必要なディレクトリ（D：/ Development / Simianなど）にあるアプリケーションでアーカイブを解凍します。
Unixベース：
Unixシステム（JREをサポート）で実行するには、simianもJavaアプリケーションとして実装されます。 一部のUnixシステムでは、パッケージシステムからsimianをインストールできます（ Arch Linuxなど ）。 このアプリケーションのシステムにパッケージがない場合は、リンクからアプリケーションと共にアーカイブをダウンロードし、必要なディレクトリ（たとえば、/ usr / share / java / simian /）に解凍し、PATHディレクトリにファイル「simian」（たとえば、/ usr / bin）を作成する必要があります「アプリケーション起動スクリプトを含む：

#!/bin/bash java -jar /usr/share/java/simian/simian.jar $@ 

最後に、このファイルを実行するように設定する必要があります。
2. QtCreatorへの外部ツールの追加
[ 環境設定]セクションの[ 外部ツール ]タブで、新しいカテゴリとユーティリティ（ カテゴリの追加、ツールの追加 ）を追加します。下のスクリーンショットに例を示します。


[実行可能ファイル]フィールドで、プログラムの実行可能ファイルへのパスを指定し（Unixベースのシステムの場合は「simian」と入力）、[ 引数]フィールドで起動引数を指定します。

-failOnDuplication- -includes = ** / *。cpp -includes = ** / *。h -includes = *。cpp -includes = *。h

[ 作業ディレクトリ]フィールドで、現在のプロジェクトのディレクトリのテンプレートを指定します。

％{CurrentProject：Path}

これらの設定により、ユーティリティは、プロジェクトディレクトリおよびすべてのサブディレクトリで、拡張子が.cppおよび.hのすべてのファイルで重複を検索します。
これで、[外部ツール]メニューに新しいタブが表示されました。


[ チェック ]メニュー項目を選択すると、 simianユーティリティが起動し 、その出力がメッセージパネルにリダイレクトされ、見つかった重複に関する情報（番号、ファイル、行）が表示されます。 起動引数でオプションを使用する場合

-reportDuplicateText +

、重複するコードも表示されます。 simianの起動オプションの完全なリストはにあります。
しかし、このソリューションは、ユーティリティの起動のみを自動化しました。 繰り返しファイルを開き、必要な行を検索するには、「手動で」必要でした。 そして、他のプラグインやIDEのようにしたかったです。エントリをダブルクリックすると、ソースファイルが開き、目的の行にジャンプして、繰り返しテキストが強調表示されます。 次に、プラグインを作成することにしました。

2 QtCreatorの重複コード検索プラグイン

私はプラグイン開発の経験がなく、QtCreatorとQt Creator Extensions Systemの TODOプラグインの記事は不可欠なヘルプを提供しました。 エディターでファイルを開き、ToDoプラグインのソースコードの目的の行に移動するコードを見つけました。 一般に、QtCreatorのプラグインを作成するためのドキュメントでは、事態は非常に悪いです。 繰り返しのテキストを強調表示する問題の解決策を比較的長い間探しました。 コードカバレッジテストによるカバレッジの程度を評価するためのプラグインのソースコードで答えを見つけました。 私の意見では、QtCreatorのプラグインを作成する際の主な助けは、ソースを調べることです。 Qt Project Webサイトのプラグインギャラリーには、ほとんどのサードパーティプラグインへのリンクが含まれています。 わかりにくい質問は、freenode.netのircチャネル＃qt-creatorでも確認できます。 プラグインのアイデアがある場合は、必ずそれを実装してみてください。 プラグインを書くことは刺激的な経験です。

2.1プラグインの組み立てとインストール

2.1.1ソースの取得とQtCreatorの構築

IDE自体とそのプラグインの両方をビルドするには、QtCreatorのソースコードが必要です。 また、Qt、QtCreatorが既にインストールされており、必要なすべてのシステム変数が設定されていることを前提としています。 ソースとアセンブリを取得する手順については、記事「 Build Qt Creator from git」を参照してください。 この手順を正常に完了すると、ソースが配置されているqt-creatorと、アセンブルされたQtCreatorが配置されているqt-creator-buildの2つのディレクトリが作成されます。
小さな余談：
したがって、インストールされたQtディストリビューションの構成の1つ（「インストール済み」と呼びます）とソースからアセンブルされた2つのQtCreator'aができます（「アセンブル済み」と呼びます）。 将来的には、「組み立てられた」作成者専用のプラグインを作成することをすぐに予約します。 実際には、QtCreatorの新しいバージョン（ソースから取得）用にコンパイルされたプラグインのバイナリファイルを使用しようとすると、依存関係の解決エラーが発生します。


この場合、 CoreおよびProjectExplorerプラグインはQtCreatorと同じバージョンである必要があります。 ディストリビューションのQtCreatorがMicrosoft Visual Studio C ++コンパイラコンパイラを使用してアセンブルされるという事実にも注意する価値があります。 したがって、QtとともにインストールされたQtCreatorのプラグインをビルドするには、QtCreatorの特定のリビジョン（AboutウィンドウのFromRevision行）のソースコードを取得する必要があり、MSVCのQtバージョンも必要です。 MSVCコンパイラーによってコンパイルされたQtCreatorのアセンブリについてはこれ以上説明しません。ソースからQtCreatorの最新バージョンを収集する（将来使用する）と想定しています。 プラグインを開発している場合は、2つのQtCreatorアセンブリも必要になります（上記のように必ずしも異なる必要はありませんが、同じものを2つ持つことができます）。 1つはプラグインを開発して組み立て、もう1つはコピーしてテストします。 ヒント：プラグインを開発するとき、表示されるウィンドウでアセンブルされるとき、プラグインがテストされているQtCreatora exeファイルを選択すると、プラグインを含むQtCreatorが自動的に起動します。


ただし、プラグインに戻りましょう。

2.1.2ソースの取得とSimianプラグインの構築

開発されたプラグインのソースはSourceforge.net：QtCreator Similarity Analysis Pluginで入手できます。 ソースとともにアーカイブをダウンロードするか、gitリポジトリからダウンロードできます。 その後、「インストール済み」のQtCreatorでプロジェクト（simian.pro）を開きます。 simian.proプロジェクトファイルでは、コンピューター上のソースディレクトリとQtCreatorアセンブリへのパスを示す2行を変更する必要があります。

 ## set the QTC_SOURCE environment variable to override the setting here QTCREATOR_SOURCES = $$(QTC_SOURCE) isEmpty(QTCREATOR_SOURCES):QTCREATOR_SOURCES=D:/Sources/QtCreator/qt-creator ## set the QTC_BUILD environment variable to override the setting here IDE_BUILD_TREE = $$(QTC_BUILD) isEmpty(IDE_BUILD_TREE):IDE_BUILD_TREE=D:/Sources/QtCreator/qt-creator-build 

別の方法：システム変数QTC_SOURCEおよびQTC_BUILDを設定します。

プラグインのリリースバージョン（Ctrl + R）をアセンブルします。これは、正常なアセンブルフェーズの後、次の場所にコピーされます。

D：\ Sources \ QtCreator \ qt-creator-build \ lib \ qtcreator \ plugins \ SnaSoftware

simian.proプロジェクトファイルの次の行では、プラグインをSnaSoftwareフォルダーにコピーします。

PROVIDER = SnaSoftware

この場合、「プロバイダー」は「プラグインプロバイダー」を意味します。 この行をコメントアウトすると、プラグインは「QtProject」ディレクトリにコピーされますが、これは完全に正しいとは限りません（QtCreatorの一部であるプラグインはこのディレクトリにあります）。 したがって、値PROVIDERとして、Habréでの私のニックネームが使用されました。
これで、ビジネスでプラグインを試すことができます。

2.2プラグインの使用

2.2.1初期設定と起動

設定でプロジェクトを使用してフォルダーにプラグインを設定する前に、 simianユーティリティの実行可能ファイルへのパスを指定する必要があります。
Windowsでは 、このため、表示されるSimianセクションの設定ダイアログボックス（[ ツール ] -> [オプション] ）で、ファイル選択ダイアログ（[ Simian実行可能パス]領域の [ 参照... ]ボタンを使用してユーティリティexeファイルを選択します。プログラムディレクトリへのパスも入力できます。 simianをPATHシステム変数に追加してから、 Executableフィールドで拡張子なしでexeファイルの名前を指定するだけです（たとえば、コンソールで起動するために、 simian-2.3.34.exeファイルの名前をsimian.exeに変更し、 PATH変数にプログラムへのパスを含めます） サルのテキストを使用したテキストフィールド）。
Unixベースのシステムでは、セクション1のsimianユーティリティをインストールする手順を既に完了している場合は、実行可能スクリプトの名前「simian」を入力するだけで済みます（PATHディレクトリにある必要があります）。
設定を保存した後（[ OK]または[ 適用 ]ボタン）、プラグインを使用できます。 これを行うには、既存のプロジェクトを開くか、新しいプロジェクトを作成して、繰り返しの検索を開始します。 プラグインのインストール後に表示されるメニュー項目[ ツール ] -> [類似点の検索 ]を選択するか、[ Simian ] パネルタブのボタンをクリックすると、検索が開始されます。 アプリケーションの設定を変更しない場合、デフォルト設定で起動します。
プラグインをテストするには、新しいGUI Qtプロジェクトを作成し、そのヘッダーファイルに2つの関数を宣言し、その実装で同じコード行の6（ しきい値設定のデフォルト値が6であるため）で構成される同じコードを記述します。

  int one; int two; int three; int four; int five; int six; 

QtCreatorメニューで[ツール]-> [類似点の検索 ]アクションを選択します（この場合、作成されたプロジェクトがアクティブである必要があります）。 ソースを分析すると、プラグインの結果を出力するためのパネル（出力パネル）が表示されます。ここには、重複が見つかったファイルへのリンクがあり、これらのファイルをクリックしてエディターで開き、繰り返しの断片が色で強調表示されます：


プラグインを使用すると、フラグメントの完全一致だけでなく、フラグメント内のさまざまな種類のフラグメントを検索することもできます。 これを行うには、重複コード検索パラメーターを追加で構成する必要があります。

2.2.2高度なセットアップ

重複コード検索設定は、 Simian Behaviorグループにあります。

[ オプション ]ダイアログボックスで設定を変更し、現在のプロジェクトのディレクトリに保存すると、 simian.ini設定テキストファイルが作成されます。 現在のプロジェクトにデフォルト設定が使用されている場合、このファイルは作成されません。 このアプローチはプロジェクトディレクトリに1つのファイルを追加しますが、単純なコピーにより設定の移植性の問題を解決します（次回設定ウィンドウを開くと、プラグインはこのファイルの存在を確認してそこから設定をロードします、またはそのようなファイルがない場合はデフォルト設定をロードします）。
プラグインを使用すると、検索の重大度を調整できます。 ごくまれに、コピーされたテキストが将来変更されないままになることがあります。文字列、デジタル定数、および変数名の値が変更されます。 ただし、通常、コード構造は変更されません。 オプションを変更することにより、特定のプロジェクトの最適な設定またはコードの品質（許容される再現性）の要件を決定できます。同じ極には、最小しきい値（2行）とすべてのオプションが有効な設定があります（繰り返しの検索時に定数値を変更できます）。識別子など）、および他の-最も許容可能なしきい値と無効化された設定オプション（コードの正確な構文一致に対応するため、繰り返しと見なされます） 使用されるオプションとその説明を表に示します：

オプション	説明
しきい値	フラグメントを繰り返しとしてカウントするために一致する必要がある行数（2〜99）。
大文字と小文字を区別しない	大文字と小文字を区別しない文字定数を比較します（「A」は「a」と同等です）
文字を無視する	文字定数を完全に無視します（「A」は「Z」と同等です）
文字列の大文字小文字を無視	大文字と小文字を区別しない文字列を比較します（「foo」は「FOO」と同等です）
文字列を無視	行の内容を無視します（ "foo"は "bar"と同等です）
番号を無視	数値定数の値を無視します（1は2.5に等しい）
識別子のケースを無視	大文字と小文字を区別しない識別子名を比較する（int foo; int FOOと同等;）
識別子のケースを無視	識別子名を無視する（int foo; int barと同等;）
修飾子を無視	修飾子を無視する（パブリック、プライベート、静的など）
中括弧を無視する	中括弧を無視
重複するブロックを無視	重複するブロックを無視
バランス角括弧	行を折り返すときに角括弧を含める
バランス括弧	括弧を改行に入れる

個人的に提示された設定のうち、完全に明確ではありません： 重複するブロック 、 バランス角括弧 、 バランス括弧を 無視するため、読者による宿題としての理解を残すことができます。

おわりに

しかし、プログラミングでは、専門的な活動と同様に、常に開発する必要があります。 同時に、私の意見では、新しいテクノロジー、デザインパターン、プログラミングテクニックを勉強するだけでなく、インストゥルメンタルツールを改善する価値もあります。 お気に入りのIDEを見て、別のIDEと比較するだけで十分な場合があります（異なるプログラミング言語向けであっても）。 自分にとって新しい興味深い機能に気付いたので、既存のプラグインの中から探してみる価値があるかもしれません。自分で何かを実装したいと思うかもしれません。 QtCreatorプラグインシステムに関するドキュメントが徐々に作成され、さらに便利で便利なツールが自由に使えるようになることを願っています。 次の記事では、既存のプラグイン（上記のプラグインを作成する過程で出会った人）の中で最も興味深く有用なプラグインの概要を説明します。
プラグインの開発計画：
1. Unixベースのシステムでプラグインをビルドおよびテストします。 この記事では、「理論上」機能するはずのUnixシステムの手順のみを説明していますが、実際にはテストされていません。
2.インターフェイス機能の拡張（「リストを折りたたむ/展開する」ボタン、ファイル数/繰り返しの行順、設定内のテキストを強調表示する色の設定など）。
3.検査結果に関するレポートを含むHTMLファイル生成を追加します。
4.使用するものを選択して、他の重複コード検索ユーティリティを追加します。

チケットシステムまたは機能リクエスト/バグレポートフォーラムセクションに、すべての要望、発言、エラーメッセージを記入してください。
UPD：記事のテキストに従ってテストケースのスクリーンショットとテキストを提供しました（コメントの説明を参照）