adlint 1.18.6 → 2.0.0

data/share/doc/users_guide_ja.texi

@@ -2,7 +2,7 @@
 @setfilename users_guide_ja.info
 @documentlanguage ja
 @documentencoding utf-8
-@settitle AdLint 1.18.6 利用者ガイド
+@settitle AdLint 2.0.0 利用者ガイド
 
 @copying
 Copyright (C) 2010-2012, OGIS-RI Co.,Ltd.
@@ -651,14 +651,14 @@ Options:
 
 @verbatim
 % adlint -t adlint_traits.yml -o . -p 1 -l adlint_files.txt
-../intro_demo.c:6:9:warning:W0492:同じ識別子名 `i' が構造体/共用体のメンバの他に、ラベル、タグ、または通常の識別子としても使われています。
-../intro_demo.c:12:13:warning:W0027:ポインタ型の変数に対して比較演算が行われています。
-../intro_demo.c:16:14:warning:W0422:値が NULL になることがあるポインタに対して間接参照が行われています。
-../intro_demo.c:31:13:warning:W0613:この制御式の値は常に偽になります。
+../intro_demo.c:6:9:warning:c_builtin:W0492:UNC:X99:同じ識別子名 `i' が構造体/共用体のメンバの他に、ラベル、タグ、または通常の識別子としても使われています。
+../intro_demo.c:12:13:warning:c_builtin:W0027:UNC:X99:ポインタ型の変数に対して比較演算が行われています。
+../intro_demo.c:16:14:warning:c_builtin:W0422:UNC:X99:値が NULL になることがあるポインタに対して間接参照が行われています。
+../intro_demo.c:31:13:warning:c_builtin:W0613:UNC:X99:この制御式の値は常に偽になります。
 ...snip...
-../intro_demo.c:55:9:warning:W9001:この文には制御が到達しません。
-../intro_demo.c:2:1:warning:W0071:インクルードされている "../useless_header.h" の内容は翻訳単位の中で全く参照されていません。削除することができます。
-../intro_demo.c:61:19:warning:W0628:関数 `int bar(void)' が定義されていますが、このプロジェクトでは使われていません。
+../intro_demo.c:55:9:warning:c_builtin:W9001:UNC:X99:この文には制御が到達しません。
+../intro_demo.c:2:1:warning:c_builtin:W0071:UNC:X99:インクルードされている "../useless_header.h" の内容は翻訳単位の中で全く参照されていません。削除することができます。
+../intro_demo.c:61:19:warning:c_builtin:W0628:UNC:X99:関数 `int bar(void)' が定義されていますが、このプロジェクトでは使われていません。
 @end verbatim
 
 @subsection ヘルプメッセージ
@@ -715,13 +715,13 @@ Options:
 
 @verbatim
 % adlint_sma -t adlint_traits.yml -o . -p 1 ../intro_demo.c
-../intro_demo.c:6:9:warning:W0492:同じ識別子名 `i' が構造体/共用体のメンバの他に、ラベル、タグ、または通常の識別子としても使われています。
-../intro_demo.c:12:13:warning:W0027:ポインタ型の変数に対して比較演算が行われています。
-../intro_demo.c:16:14:warning:W0422:値が NULL になることがあるポインタに対して間接参照が行われています。
-../intro_demo.c:31:13:warning:W0613:この制御式の値は常に偽になります。
+../intro_demo.c:6:9:warning:c_builtin:W0492:UNC:X99:同じ識別子名 `i' が構造体/共用体のメンバの他に、ラベル、タグ、または通常の識別子としても使われています。
+../intro_demo.c:12:13:warning:c_builtin:W0027:UNC:X99:ポインタ型の変数に対して比較演算が行われています。
+../intro_demo.c:16:14:warning:c_builtin:W0422:UNC:X99:値が NULL になることがあるポインタに対して間接参照が行われています。
+../intro_demo.c:31:13:warning:c_builtin:W0613:UNC:X99:この制御式の値は常に偽になります。
 ...snip...
-../intro_demo.c:55:9:warning:W9001:この文には制御が到達しません。
-../intro_demo.c:2:1:warning:W0071:インクルードされている "../useless_header.h" の内容は翻訳単位の中で全く参照されていません。削除することができます。
+../intro_demo.c:55:9:warning:c_builtin:W9001:UNC:X99:この文には制御が到達しません。
+../intro_demo.c:2:1:warning:c_builtin:W0071:UNC:X99:インクルードされている "../useless_header.h" の内容は翻訳単位の中で全く参照されていません。削除することができます。
 @end verbatim
 
 @subsection ヘルプメッセージ
@@ -781,7 +781,7 @@ intro_demo.c.met.csv
 
 @verbatim
 % adlint_cma -t adlint_traits.yml -o . intro_demo.c.met.csv
-../intro_demo.c:61:19:warning:W0628:関数 `int bar(void)' が定義されていますが、このプロジェクトでは使われていません。
+../intro_demo.c:61:19:warning:c_builtin:W0628:UNC:X99:関数 `int bar(void)' が定義されていますが、このプロジェクトでは使われていません。
 @end verbatim
 
 @subsection ヘルプメッセージ
@@ -889,6 +889,7 @@ Command, @command{adlint_sma}}、@ref{AdLint CMA Command, @command{adlint_cma}}
 @section 特性ファイル
 
 @menu
+* グローバル特性:Global Traits.
 * プロジェクト特性:Project Traits.
 * コンパイラ特性:Compiler Traits.
 * リンカ特性:Linker Traits.
@@ -914,6 +915,57 @@ adlint_all.bat  adlint_cinit.h  adlint_pinit.h
 @end verbatim
 
 
+@node Global Traits
+@subsection グローバル特性
+
+グローバル特性は、特性ファイルのルート項目で設定します。
+
+@multitable @columnfractions .01 .3 .1
+@headitem No. @tab 項目名 @tab 形式 @tab 内容
+@item 1
+@cindex version
+@anchor{global_traits:version}
+@tab
+@code{version}
+@tab
+文字列
+@tab
+特性ファイルフォーマットのバージョンを表します。この項目は編集してはいけません
+。
+@item 2
+@cindex exam_packages
+@anchor{global_traits:exam_packages}
+@tab
+@code{exam_packages}
+@tab
+文字列の配列
+@tab
+静的解析に用いるソースコード検査パッケージの名前を列挙します。
+
+@code{"c_builtin"} は AdLint 本体に組み込み済みの検査パッケージ名です。
+また、今後さまざまな用途に特化したオプションのソースコード検査パッケージを開発
+する予定です。
+
+例えば、@code{adlint-exam-c_ansi} という、ソースコードが ANSI C に準拠している
+かを検査するパッケージをインストールした場合、@code{exam_packages} を下記のよう
+に編集して解析することができます。
+
+以下の場合は、ANSI C 準拠の検査パッケージのみが実行されます。
+@example
+exam_packages:
+  - "c_ansi"
+@end example
+
+以下の場合は、AdLint 組み込みの検査パッケージと、ANSI C 準拠の検査パッケージが実
+行されます。
+@example
+exam_packages:
+  - "c_builtin"
+  - "c_ansi"
+@end example
+@end multitable
+
+
 @node Project Traits
 @subsection プロジェクト特性
 
@@ -1353,14 +1405,127 @@ extension_substitution:
 メッセージ本文の言語を指定します。(現時点では) @code{"en_US"} か @code{"ja_JP"}
 が指定可能です。
 @item 2
+@cindex message_traits:message_with_class
+@anchor{message_traits:message_with_class}
+@tab
+@code{message_with_class}
+@tab
+真偽値
+@tab
+@code{true} の場合、@ref{Message File, メッセージファイル}に出力するメッセージ
+レコードに、ソースコード検査パッケージ名、カテゴリ、深刻度のフィールドを追加し
+ます。
+@item 3
+@cindex message_traits:warn_only_files_in
+@anchor{message_traits:warn_only_files_in}
+@tab
+@code{warn_only_files_in}
+@tab
+文字列
+@tab
+@b{AdLint 2.0.0 では、この項目による設定は未サポートです。}
+
+解析対象プロジェクトのルートとなるディレクトリパス名を指定します。
+
+ディレクトリパス名を指定した場合は、そのディレクトリ配下のソースコードについて
+のみ、警告メッセージを出力します。
+省略した場合は、システムヘッダやサードパーティーライブラリのヘッダなど、解析対
+象ソースコードがインクルードする全てのファイルについて、警告メッセージを出力し
+ます。
+@item 4
+@cindex message_traits:individual_selection
+@anchor{message_traits:individual_selection}
+@tab
+@code{individual_selection}
+@tab
+真偽値
+@tab
+@b{AdLint 2.0.0 では、この項目による設定は未サポートです。}
+
+解析対象ソースコード内の注釈によるコードチェックの選択機能を有効化します。
+
+@code{true} の場合、注釈によるコードチェックの選択が可能になります。
+@item 5
+@cindex message_traits:exclusion:categories
+@anchor{message_traits:exclusion:categories}
+@tab
+@code{exclusion:categories}
+@tab
+文字列の配列
+@tab
+@b{AdLint 2.0.0 では、この項目による設定は未サポートです。}
+
+@ref{global_traits:exam_packages, exam_packages} で指定したソースコード検査パッ
+ケージ中のコードチェック機能で、実行を除外するものをメッセージのカテゴリにより
+指定します。
+@item 6
+@cindex message_traits:exclusion:severities
+@anchor{message_traits:exclusion:severities}
+@tab
+@code{exclusion:severities}
+@tab
+正規表現を表す文字列
+@tab
+@b{AdLint 2.0.0 では、この項目による設定は未サポートです。}
+
+@ref{global_traits:exam_packages, exam_packages} で指定したソースコード検査パッ
+ケージ中のコードチェック機能で、実行を除外するものをメッセージの深刻度により指
+定します。
+@item 7
+@cindex message_traits:exclusion:messages
+@anchor{message_traits:exclusion:messages}
+@tab
+@code{exclusion:messages}
+@tab
+メッセージ ID と文字列のマップ
+@tab
+@b{AdLint 2.0.0 では、この項目による設定は未サポートです。}
+
+@ref{global_traits:exam_packages, exam_packages} で指定したソースコード検査パッ
+ケージ中のコードチェック機能で、実行を除外するものをメッセージ ID により指定し
+ます。
+
+メッセージ ID は、ソースコード検査パッケージをまたいでユニークではない場合があ
+るため、文字列として該当するメッセージ ID が含まれるソースコード検査パッケージ
+名も指定してください。
+@item 8
+@cindex message_traits:inclusion:messages
+@anchor{message_traits:inclusion:messages}
+@tab
+@code{inclusion:messages}
+@tab
+メッセージ ID と文字列のマップ
+@tab
+@b{AdLint 2.0.0 では、この項目による設定は未サポートです。}
+
+@code{exclusion} セクションの設定内容により除外しましたが、メッセージ ID 指定で
+特定のコードチェック機能を含める場合に指定します。
+
+例えば、@ref{message_traits:exclusion:categories, exclusion:categories} でカテ
+ゴリ指定により除外したコードチェック機能群のうち、特定のもののみを実行したい場
+合を想定した項目です。
+@item 9
 @cindex message_traits:change_list
 @anchor{message_traits:change_list}
 @tab
 @code{change_list}
 @tab
-メッセージ ID と文字列のマップ
+メッセージ ID と変更内容のマップ
 @tab
-特定メッセージの本文を変更する場合に指定します。
+特定メッセージの定義情報を変更する場合に指定します。
+
+例えば、@code{"c_builtin"} パッケージの @code{W9999} メッセージを変更する場合、
+下記のように設定します。
+
+@example
+change_list:
+  W9999:
+    package: "c_builtin"
+    classes:
+      - "新しいカテゴリ名1:深刻度1"
+      - "新しいカテゴリ名2:深刻度2"
+    format: "新しいメッセージフォーマット。"
+@end example
 @end multitable
 
 
@@ -1536,12 +1701,21 @@ macro_value
 @anchor{pp_tokens}
 pp_tokens : c_pp_tokens
 
+@anchor{exam_package_name}
+exam_package_name : 任意の文字列
+
 @anchor{message_id}
 message_id
   : 'W' [0-9]@{4@}
   | 'E' [0-9]@{4@}
   | 'C' [0-9]@{4@}
 
+@anchor{message_category}
+message_category : [A-Z]@{3@}
+
+@anchor{message_severity}
+message_severity : [A-Z][0-9]@{2@}
+
 @anchor{message_text}
 message_text : 任意の文字列
 @end example
@@ -2124,7 +2298,10 @@ error_record
   : @ref{error_line} @ref{new_line} @ref{context_line_list}
 
 @anchor{error_line}
-error_line
+error_line (in case of @ref{message_traits:message_with_class, message_with_class} == true)
+  : 'E' ',' @ref{file_path} ',' @ref{line_no} ',' @ref{column_no} ',' @ref{exam_package_name} ',' @ref{message_id} ',' @ref{message_category} ',' @ref{message_severity} ',' @ref{message_text}
+
+error_line (in case of @ref{message_traits:message_with_class, message_with_class} != true)
   : 'E' ',' @ref{file_path} ',' @ref{line_no} ',' @ref{column_no} ',' @ref{message_id} ',' @ref{message_text}
 
 @anchor{warning_record}
@@ -2132,7 +2309,10 @@ warning_record
   : @ref{warning_line} @ref{new_line} @ref{context_line_list}
 
 @anchor{warning_line}
-warning_line
+warning_line (in case of @ref{message_traits:message_with_class, message_with_class} == true)
+  : 'W' ',' @ref{file_path} ',' @ref{line_no} ',' @ref{column_no} ',' @ref{exam_package_name} ',' @ref{message_id} ',' @ref{message_category} ',' @ref{message_severity} ',' @ref{message_text}
+
+warning_line (in case of @ref{message_traits:message_with_class, message_with_class} != true)
   : 'W' ',' @ref{file_path} ',' @ref{line_no} ',' @ref{column_no} ',' @ref{message_id} ',' @ref{message_text}
 
 @anchor{context_line_list}
@@ -2141,7 +2321,10 @@ context_line_list
   | @ref{context_line} @ref{new_line} @ref{context_line_list}
 
 @anchor{context_line}
-context_line
+context_line (in case of @ref{message_traits:message_with_class, message_with_class} == true)
+  : 'C' ',' @ref{file_path} ',' @ref{line_no} ',' @ref{column_no} ',' @ref{exam_package_name} ',' @ref{message_id} ',' @ref{message_category} ',' @ref{message_severity} ',' @ref{message_text}
+
+context_line (in case of @ref{message_traits:message_with_class, message_with_class} != true)
   : 'C' ',' @ref{file_path} ',' @ref{line_no} ',' @ref{column_no} ',' @ref{message_id} ',' @ref{message_text}
 @end example
 

data/share/sample/bison-2.5/adlint/adlint_traits.yml

@@ -21,7 +21,15 @@
 
 # Schema version of the traits file.
 # DO NOT EDIT MANUALLY!
-version: "1.0.0"
+version: "2.0.0"
+
+# List of names of source code examination packages.
+#
+# "c_builtin" is a builtin source code examination package for C language.
+# You can install optional examination packages and append (or replace) this
+# list to specify which examination packages are to be run.
+exam_packages:
+  - "c_builtin"
 
 #
 # Project specific traits section
@@ -218,8 +226,53 @@ message_traits:
   # Please help to translate the message catalog into your language.
   language: "ja_JP"
 
+  # Output messages with category and severity information?
+  message_with_class: false
+
+  # Warn only files in the specified directory.  If omitted, all files (such as
+  # system headers or 3rd-party library headers) will be warned.
+  warn_only_files_in: "../bison-2.5"
+
+  # Enable translation-unit specific code check selection?
+  individual_selection: true
+
+  # Project-wide code check exclusion settings.
+  # Ex.
+  #   exclusion:
+  #     categories:
+  #       - "REL"
+  #       - "PRT"
+  #     severities: "[ABC][5-9][0-9]"
+  #     messages:
+  #       W0001: "c_builtin"
+  #       W0002: "c_ansi"
+  exclusion:
+
+  # Project-wide code check inclusion settings.
+  # Ex.
+  #   inclusion:
+  #     messages:
+  #       W0001: "c_builtin"
+  #       W0002: "c_ansi"
+  inclusion:
+
   # Message text replacement.
   # Ex.
   #   change_list:
-  #     W9999: "Your custom message for the warning of #9999."
+  #     W9999:
+  #       package: "c_builtin"
+  #       classes:
+  #         - "REL:A10"
+  #         - "PRT:B20"
+  #       format: "Your custom message for the warning of W9999."
+  #     X9999:
+  #       package: "core"
+  #       classes:
+  #         - "ERR:X99"
+  #       format: "Your custom message for the warning of X9999."
+  #     E9999:
+  #       package: "core"
+  #       classes:
+  #         - "ERR:X99"
+  #       format: "Your custom message for the warning of E9999."
   change_list:

data/share/sample/bison-2.5/adlint/lib/adlint_traits.yml

@@ -21,7 +21,15 @@
 
 # Schema version of the traits file.
 # DO NOT EDIT MANUALLY!
-version: "1.0.0"
+version: "2.0.0"
+
+# List of names of source code examination packages.
+#
+# "c_builtin" is a builtin source code examination package for C language.
+# You can install optional examination packages and append (or replace) this
+# list to specify which examination packages are to be run.
+exam_packages:
+  - "c_builtin"
 
 #
 # Project specific traits section
@@ -231,8 +239,45 @@ message_traits:
   # Please help to translate the message catalog into your language.
   language: "ja_JP"
 
+  # Output messages with category and severity information?
+  message_with_class: false
+
+  # Warn only files in the specified directory.  If omitted, all files (such as
+  # system headers or 3rd-party library headers) will be warned.
+  warn_only_files_in: "../../bison-2.5"
+
+  # Enable translation-unit specific code check selection?
+  individual_selection: true
+
+  # Project-wide code check exclusion settings.
+  # Ex.
+  #   exclusion:
+  #     categories:
+  #       - "REL"
+  #       - "PRT"
+  #     severities: "[ABC][5-9][0-9]"
+  #     messages:
+  #       W0001: "c_builtin"
+  #       W0002: "c_ansi"
+  exclusion:
+
   # Message text replacement.
   # Ex.
   #   change_list:
-  #     W9999: "Your custom message for the warning of #9999."
+  #     W9999:
+  #       package: "c_builtin"
+  #       classes:
+  #         - "REL:A10"
+  #         - "PRT:B20"
+  #       format: "Your custom message for the warning of W9999."
+  #     X9999:
+  #       package: "core"
+  #       classes:
+  #         - "ERR:X99"
+  #       format: "Your custom message for the warning of X9999."
+  #     E9999:
+  #       package: "core"
+  #       classes:
+  #         - "ERR:X99"
+  #       format: "Your custom message for the warning of E9999."
   change_list:

data/share/sample/bison-2.5/adlint/src/adlint_traits.yml

@@ -21,7 +21,15 @@
 
 # Schema version of the traits file.
 # DO NOT EDIT MANUALLY!
-version: "1.0.0"
+version: "2.0.0"
+
+# List of names of source code examination packages.
+#
+# "c_builtin" is a builtin source code examination package for C language.
+# You can install optional examination packages and append (or replace) this
+# list to specify which examination packages are to be run.
+exam_packages:
+  - "c_builtin"
 
 #
 # Project specific traits section
@@ -232,8 +240,45 @@ message_traits:
   # Please help to translate the message catalog into your language.
   language: "ja_JP"
 
+  # Output messages with category and severity information?
+  message_with_class: false
+
+  # Warn only files in the specified directory.  If omitted, all files (such as
+  # system headers or 3rd-party library headers) will be warned.
+  warn_only_files_in: "../../bison-2.5"
+
+  # Enable translation-unit specific code check selection?
+  individual_selection: true
+
+  # Project-wide code check exclusion settings.
+  # Ex.
+  #   exclusion:
+  #     categories:
+  #       - "REL"
+  #       - "PRT"
+  #     severities: "[ABC][5-9][0-9]"
+  #     messages:
+  #       W0001: "c_builtin"
+  #       W0002: "c_ansi"
+  exclusion:
+
   # Message text replacement.
   # Ex.
   #   change_list:
-  #     W9999: "Your custom message for the warning of #9999."
+  #     W9999:
+  #       package: "c_builtin"
+  #       classes:
+  #         - "REL:A10"
+  #         - "PRT:B20"
+  #       format: "Your custom message for the warning of W9999."
+  #     X9999:
+  #       package: "core"
+  #       classes:
+  #         - "ERR:X99"
+  #       format: "Your custom message for the warning of X9999."
+  #     E9999:
+  #       package: "core"
+  #       classes:
+  #         - "ERR:X99"
+  #       format: "Your custom message for the warning of E9999."
   change_list: