コードクローン関連ツール

コードクローンとは、ソースコード中の全く同じあるいは類似したコードの断片です。コードクローンが存在するソースコードは、保守が困難になることが指摘されています。特に、大規模なソフトウェアにおいては、コードクローン問題は深刻であり、手作業では、ソースコード中にコードクローンが存在するかどうかをチェックすることすら困難です。
われわれ研究グループでは、このような大規模なソフトウェアを対象とした、コードクローン対策を研究してきています。本ページは、その成果であるツール類を紹介しています。

関連手法・研究・技術

CloneWarrior

大杉直樹氏（奈良先端科学技術大学院大学情報科学研究科ソフトウェア工学講座）によって開発された、コードクローンを追跡して、ソースコードを修正することを目的とするGUIベースのコードクローン分析ツール。
詳細は、CloneWarrior Webサイトを参照。

ソースコード中の同一あるいは類似したコード断片を、コードクローンと呼びます。コードクローンが発生する主な原因は、開発者がソースコードをコピー＆ペーストすることですが、実行時のパフォーマンスを求めて意図的に繰り返しコードを書くこともあり、エラー処理などの定型処理もコードクローンとなります。また、コード生成ツール（パーザージェネレータ等）によって生成されたソースファイルもコードクローンを含むことがあります。

コードクローンの存在は、特に大規模なソフトウェアにおいて、ソフトウェアの保守を困難にします。コードクローンであるコード断片に誤りが含まれていた場合には、そのコードクローンのコード断片について、修正を行う必要があります。機能拡張や機能変更のためにソースコードを修正する場合も同様で、コードクローンがあればそのすべてのコード断片について修正を行う必要があります。

実際に、20年以上保守されているあるソフトウェアからコードクローンを検出したケーススタディにおいては、全部で約2000個あるモジュール（ソースファイル）の半数にコードクローンが含まれていました。特に、長いコードクローン（そのコードクローンが含む個々のソースコード断片の行数が多いもの）は、ソフトウェアの保守に悪影響を与えていることもわかりました。

現実的には、ソフトウェアを開発する上でコードクローンの発生は避けられない問題です。複数の開発者が開発すれば、ほぼ確実に定型処理が重複して記述されることになります。また、一度ソフトウェアを開発して初めてわかるような、繰り返して用いられる処理もあります。発見されたコードクローンを取り除く（まとめる）ことが常に可能であるとは限らず、プログラミング言語に適切な機能（構造化例外処理や汎用型、オブジェクト指向、アスペクト指向）が無い場合には、単一のルーチンとしてまとめることができないコードクローンもあります。

現在、大規模なソフトウェアのソースコードからコードクローンを検出する手法、コードクローンに対処するための手法が盛んに研究されています。

散布図（スキャッタープロット）

クローンメトリクス

クローンクラス（互いに同じまたは類似しているソースコード断片の集合）を計測対象とするメトリクス

モジュール（ソースファイル）を計測対象とするメトリクス

よくある質問

A1: 現在、諸般の事情のため、CCFinder/Geminiの配布は厳密な管理の下におかれています。研究に協力して頂けるという条件付きで配布しております。詳細は以下の連絡先にどうぞ。
mail to: y-higo AT ist DOT osaka-u DOT ac DOT jp

Q2: 論文[Kamiya2002]で、CCFinderの実行時間の計測は何回か実行した平均ですか？アルゴリズムの複雑さの評価としては、接尾辞木（suffix tree)の節点の数や深さで評価する方がよいのではないですか？

A2: 実行時間は、PCを再起動した直後にCCFinderを実行して計測しました。何度か実行してみて、ディスクキャッシュが最も大きく影響していると分ったので、時間計測はこの方法で行いました。接尾辞木の節点の数で評価する方法は、一見、客観的に見えるかも知れませんが、以下の理由により採用しませんでした。（１）何が節点になるかは検出アルゴリズムによって違うためあまり参考にならない、（２）接尾辞木を操作している時間は検出アルゴリズム全体からみてそれほど大きな割合を占めていない。

発表

報道など

[受賞] 第7回プログラミングおよびプログラミング言語ワークショップ(PPL2005) 発表賞（一般の部）受賞。
プレゼンテーション

[その他] 2004年度第２回未踏ソフトウェア創造事業に「コードクローン検出ツールCCFinderNexGenの開発」が採択される。(2004/12/22)
Webページ, 公表資料

[Award] International Conference on Software Maintenance(ICSM) 2002併設ワークショップWorkshop on Detection of Software Cloneにおいて、CCFinderがClones Award 2002の1つに選ばれる。(2002/10/02)

[新聞記事] "阪大『修正点、１００倍速く検索』　", 日経産業新聞　2002年5月17日（金）日刊　８面, 2002.5.17.

[新聞記事] "コンピュータソフト『コピー部分高速検出法』阪大教授ら開発", 讀賣新聞　2002年5月8日（水）朝刊　総合２面, 2002.5.2.

論文

[Higo2004-3] Yoshiki Higo, Toshihiro Kamiya, Shinji Kusumoto, Katsuro Inoue, "ARIES: Refactoring Support Environment Based on Code Clone Analysis", The 8th IASTED International Conference on Software Engineering and Applications(SEA 2004), pp.222-229, Cambridge, USA (November 9-11, 2004).

[Kamiya2004] 神谷年洋, "コードクローンとは、コードクローンが引き起こす問題、その対策の現状", 電子情報通信学会誌 Vol. 87, No. 9, pp. 791-797 (2004-9).

[Sasaki2004] 佐々木亨, 肥後芳樹, 神谷年洋, 楠本真二, 井上克郎, "プログラム変更支援を目的としたコードクローン情報付加ツールの実装と評価", 電子情報通信学会論文誌, Vol. J87-D-I, No. 9, pp. 868-870 (2004-9).

[Higo2004-2] 肥後芳樹, 神谷年洋, 楠本真二, 井上克郎, "コードクローン情報を用いたリファクタリング支援ツール", 電子情報通信学会技術研究報告, SS2004-1, Vol.104, No.7, pp.1-6 (2004-5).

[Higo2004] 肥後芳樹, 植田泰士, 神谷年洋, 楠本真二, 井上克郎, "コードクローン解析に基づくリファクタリングの試み", 情報処理学会論文誌, no. 45, vol. 5, pp. 1357-1366 (2004-5).

[Kusumoto2003] 楠本真二, 神谷年洋, 井上克郎, "コードクローン解析ツール(CCFinder & Gemini)", 日立GPジャーナル 2003年第4号, pp. 47-49 (2003-12).

[Izumida2003] 泉田聡介, 植田泰士, 神谷年洋, 楠本真二, 井上克郎, "ソフトウェア保守のための類似コード片検索ツール", 電子情報通信学会論文誌 D-I, Vol. J86-D-I, No. 12, pp. 906-908 (2003-12).

[Ueda2003] 植田泰士, 神谷年洋, 楠本真二, 井上克郎, "開発保守支援を目指したコードクローン分析環境", 電子情報通信学会論文誌 D-I, Vol. J86-D-I, No. 12, pp. 863-871 (2003-12).

[Monden2003] 門田暁人, 佐藤慎一, 神谷年洋, 松本健一, "コードクローンに基づくレガシーソフトウェアの品質の分析", 情報処理学会論文誌, vol. 44, No. 8, pp. 2178-2188 (2003-8).

[Higo2003] 肥後芳樹, 神谷年洋, 楠本真二, 井上克郎, "類似コード片を用いたリファクタリングの試み", 情報処理学会研究報告 2003-SE-143, pp. 29-36, (2003-7-17).

[Ueda2002-3] Yasushi Ueda, Yoshiki Higo, Toshihiro Kamiya, Shinji Kusumoto, and Katsuro Inoue"Gemini: Code Clone Analysis Tool," Proc. of 2002 International Symposium on Empirical Software Engineering (ISESE2002), vol.2, pp.31-32, Nara-ken New Public Hall, Nara, Japan, (October 3-4, 2002).

[Ueda2002-2] Yasushi Ueda, Toshihiro Kamiya, Shinji Kusumoto, and Katsuro Inoue, "On Detection of Gapped Code Clones using Gap Locations," Proc. of the 9th Asia Pacific Software Engineering Conference (APSEC2002), pp.327-336, Gold Coast, Queensland, Australia, (December 4-6, 2002).

[Kamiya2002] Toshihiro Kamiya, Shinji Kusumoto, and Katsuro Inoue, "CCFinder: A Multi-Linguistic Token-based Code Clone Detection System for Large Scale Source Code," IEEE Trans. Software Engineering, vol. 28, no. 7, pp. 654-670, (2002-7).

[Monden2002] A. Monden, D. Nakae, T. Kamiya, S. Sato, and K. Matsumoto, "Software quality analysis by code clones in industrial legacy software," Proc. of the 8th IEEE Symposium on Software Metrics (METRICS2002), pp. 87-94, Ottawa, Canada, (June 4-7, 2002).

[Ueda2002] Yasushi Ueda, Toshihiro Kamiya, Shinji Kusumoto, and Katsuro Inoue, "Gemini: Maitenance Support Environment Based on Code Clone Analysis," Proc. of the 8th IEEE Symposium on Software Metrics (METRICS2002), pp. 67-76, Ottawa, Canada, (June 4-7, 2002).

[Inoue2001] 井上克郎, 神谷年洋, 楠本真二, "コードクローン検出法," コンピュータソフトウェア, Vol.18, No.5, pp.47-54, (2001-9).

[Ueda2001] 植田泰士, 神谷年洋, 楠本真二, 井上克郎: "クローン検出ツールを用いたソースコード分析ツールの試作", 電子情報通信学会技術研究報告, SS2001-14, Vol.101, No.240, pp.17-24, (2001-7).

[Yamamoto2001] 山本哲男, 松下誠, 神谷年洋, 井上克郎: "クローン検出ツールを用いたソフトウェアシステムの類似度調査", 電子情報通信学会技術研究報告, SS2001-15, Vol.101, No.240, pp.25-32, (2001-7).

[Kamiya2001-3] Toshihiro Kamiya, Fumiaki Ohata, Kazuhiro Kondou, Shinji Kusumoto, and Katuro Inoue: "Maintenance support tools for Java programs: CCFinder and JAAT", Proc. of The 23rd Int'l Conf. on Software Eng. (ICSE'2001), pp. 837-838, Toronto, Canada, (May, 2001).

[Kamiya2001-2] 神谷年洋, "コードクローンの検出手法," 情報処理学会ソフトウェア工学研究会　ウィンターワークショップ・イン・金沢論文集, pp.21-22, (2001-1).

[Kamiya2001] 神谷年洋, 楠本真二, 井上克郎: "コードクローン検出における新手法の提案及び評価実験", 電子情報通信学会技術研究報告、SS2000-42～52, Vol.100, No.570, pp. 41-48, (2001-1).

[Nakae2001] 中江大海, 神谷年洋, 門田暁人, 加藤裕史, 佐藤慎一, 井上克郎, "レガシーソフトウェアを対象とするクローンコード分析," 電子情報通信学会技術研究報告, ソフトウェアサイエンス研究会, Vol. 100, No. 570, SS2000-49, pp. 57-64, (2001-1).

参考文献

[Baker1992] B.S. Baker, "A Program for Identifying Duplicated Code", Proc. Computing Science and Statistics: 24th Symposium on the Interface, 24, pp. 49-57 Mar. 1992.

[Baker1995] B.S. Baker, "On finding Duplication and Near-Duplication in Large Software System", Proc. Second IEEE Working Conf. on Reverse Eng., pp. 86-95 Jul. 1995.

[Balazinska1999] M. Balazinska, E. Merlo, M. Dagenais, B. Lague, and K.A. Kontogiannis, "Measuring Clone Based Reengineering Opportunities", Proc. 6th IEEE Int'l Symposium on Software Metrics (METRICS '99), pp. 292-303, Boca Raton, Florida, Nov. 1999.

[Baxter1998] I.D. Baxter, A. Yahin, L. Moura, M. Sant'Anna, and L. Bier, "Clone Detection Using Abstract Syntax Trees", Proc. IEEE Int'l Conf. on Software Maintenance (ICSM) '98, pp. 368-377, Bethesda, Maryland, Nov. 1998.

[Burd2002] Elizabeth Burd, John Bailey, "Evaluating Clone Detection Tools for Use during Preventative Maintenance," Proc. 2nd IEEE International Workshop on Source Code Analysis and Manipulation (SCAM) 2002, pp. 36-43. Montreal, Canada, Oct. 2002.

[Ducasse1999] S. Ducasse, M. Rieger, and S. Demeyer. "A Language Independent Approach for Detecting Duplicated Code", Proc. IEEE Int'l Conf. on Software Maintenance (ICSM) '99, pp. 109-118. Oxford, England. Aug. 1999.

[Fowler1999] Martin Fowler. Refactoring: improving the design of existing code. Addison Wesley. 1999.

[Kontogiannis1996] K. Kontogiannis, R. DeMori, E. Merlo, M. Galler, and M.Bernstein, "Pattern Matching Techniques for Clone Detection," Journal of Automated Software Engineering, Kluwer Academic Publishers, Vol. 3. pp.77-108, 1996.

[Imai2002] T. Imai, Y. Kataoka, and T. Fukaya, "Evaluating software maintenance cost using functional redundancy metrics," In Proc. 26th International Computer Software and Applications Conference (compsac 2002), pp.299-306, 2002.

[Johnson1994] J. H. Johnson, "Substring Matching for Clone Detection and Change Tracking", Proc. IEEE Int'l Conf. on Software Maintenance (ICSM) '94, pp. 120-126. Victoria, British Columbia, Canada. Sep. 1994.

[Mayrand1996] J. Mayland, C. Leblanc, and E. M. Merlo. "Experiment on the Automatic Detection of Function Clones in a Software System Using Metrics", Proc. IEEE Int'l Conf. on Software Maintenance (ICSM) '96, pp. 244-253, Monterey, California, Nov. 1996.