CA Library Implementation - Revision history

Manus: Manus moved page User:Stefan/Code Analysis/Library Implementation to CA Library Implementation without leaving a redirect

2014-06-03T23:21:24Z

Manus moved page User:Stefan/Code Analysis/Library Implementation to CA Library Implementation without leaving a redirect

Manus at 23:21, 3 June 2014

2014-06-03T23:21:01Z

Stefan: new name

2014-03-20T14:08:24Z

new name

Stefan: "EVE" -> "EiffelStudio"

2014-03-20T09:28:38Z

"EVE" -> "EiffelStudio"

Stefan: /* Rule checking */

2014-03-12T15:50:55Z

‎Rule checking

Stefan: /* Example: Rule # 2: Unused argument */

2014-03-11T11:52:53Z

‎Example: Rule # 2: Unused argument

Show changes

Stefan: Example: Self-comparison

2014-03-09T16:37:38Z

Example: Self-comparison

Show changes

Stefan: lang

2014-03-09T14:41:18Z

lang

Stefan: /* Rule checking */ Checking Standard Rules

2014-03-07T17:55:55Z

‎Rule checking: Checking Standard Rules

Stefan: + class diagram

2014-03-07T12:33:13Z

+ class diagram

@@ Line 1: / Line 1: @@
-<center><small>[[User:Stefan/Code Analysis/Adding New Rules|&lt;&lt; 6. Adding New Rules]] | [[User:Stefan/Code Analysis/UI Implementation|8. UI Implementation &gt; &gt;]]</small></center>
+[[Category:Code Analysis]]
-----
-<br />
 The code for Inspector Eiffel is located at three different places in the EiffelStudio source:

@@ Line 3: / Line 3: @@
 <br />
-The code for Code Analysis is located at three different places in the EiffelStudio source:
+The code for Inspector Eiffel is located at three different places in the EiffelStudio source:
 # The framework—by far the largest part, with the rule checking, the rules, the control flow graph functionality, and more—is represented as a ''library'';
 # The graphical user interface can be found in the ''interface'' cluster of EiffelStudio;
 # The command-line interface for code analysis is a single class in the ''tty'' cluster of EiffelStudio.
-The whole '''code analysis framework''' is located in the '''library ''code_analysis'''''.
+The whole '''Inspector Eiffel framework''' is located in the '''library ''code_analysis'''''.
 == Class Relations ==

@@ Line 3: / Line 3: @@
 <br />
-The code for Code Analysis is located at three different places in the ''EVE'' source:
+The code for Code Analysis is located at three different places in the EiffelStudio source:
 # The framework—by far the largest part, with the rule checking, the rules, the control flow graph functionality, and more—is represented as a ''library'';
-# The graphical user interface can be found in the ''interface'' cluster of ''EVE'';
+# The graphical user interface can be found in the ''interface'' cluster of EiffelStudio;
-# The command-line interface for code analysis is a single class in the ''tty'' cluster of ''EVE''.
+# The command-line interface for code analysis is a single class in the ''tty'' cluster of EiffelStudio.
 The whole '''code analysis framework''' is located in the '''library ''code_analysis'''''.

@@ Line 33: / Line 33: @@
 Then, to start analyzing simply call <e>{CA_CODE_ANALYZER}.analyze</e>.
-== Rule checking ==
+== Rule Checking ==
 In the GUI we want to be able to continue to work while the code analyzer is running. Analyzing larger sets of classes (such as whole libraries) can take from several seconds to several minutes. For this reason the code analyzer uses an ''asynchronous task'', <e>{CA_RULE_CHECKING_TASK}</e>. In <e>{CA_CODE_ANALYZER}.analyze</e> this task (<e>l_task</e>) is invoked as follows:

@@ Line 4: / Line 4: @@
 The code for Code Analysis is located at three different places in the ''EVE'' source:
-# The framework—the by far largest part, with the rule checking, the rules, the control flow graph functionality, and more—is represented as a ''library'';
+# The framework—by far the largest part, with the rule checking, the rules, the control flow graph functionality, and more—is represented as a ''library'';
 # The graphical user interface can be found in the ''interface'' cluster of ''EVE'';
 # The command-line interface for code analysis is a single class in the ''tty'' cluster of ''EVE''.

← Older revision	Revision as of 23:21, 3 June 2014
(No difference)

← Older revision		Revision as of 17:55, 7 March 2014
Line 105:		Line 105:

	In the <e>rescue</e> clause all possible exceptions are caught and recorded. In case of such an exception it then proceeds to the next class.		In the <e>rescue</e> clause all possible exceptions are caught and recorded. In case of such an exception it then proceeds to the next class.
		+
		+	=== Checking ''Standard'' Rules ===
		+
		+	The relatively large class <e>{CA_ALL_RULES_CHECKER}</e> is responsible for checking ''standard rules''. It does this in a straightforward way. It is a subclass of <e>{AST_ITERATOR}</e>, a realization of a visitor on the AST.
		+
		+	Rules can register their actions with <e>{CA_ALL_RULES_CHECKER}</e> by calling a procedure like <e>add_bin_lt_pre_action (a_action: attached PROCEDURE [ANY, TUPLE [BIN_LT_AS]])</e> or <e>add_if_post_action (a_action: attached PROCEDURE [ANY, TUPLE [IF_AS]])</e>. These "pre" and "post" actions exist for many other types of AST nodes as well. All the registered actions are stored in <e>ACTION_SEQUENCE</e> variables:
		+	<e>
		+	if_pre_actions, if_post_actions: ACTION_SEQUENCE [TUPLE [IF_AS]]
		+
		+	add_if_post_action (a_action: attached PROCEDURE [ANY, TUPLE [IF_AS]])
		+	do
		+	if_post_actions.extend (a_action)
		+	end
		+
		+	-- And similar for all other relevant AST nodes...
		+	</e>
		+
		+	The corresponding visitor procedures are redefined. This is done is the following way:
		+	<e>
		+	process_if_as (a_if: IF_AS)
		+	do
		+	if_pre_actions.call ([a_if])
		+	Precursor (a_if)
		+	if_post_actions.call ([a_if])
		+	end
		+
		+	-- And similar for all other relevant AST nodes...
		+	</e>
		+
		+	Since the actual iteration over the AST is done in the ancestor we need only very little code to analyze a class:
		+	<e>
		+	feature {CA_RULE_CHECKING_TASK} -- Execution Commands
		+
		+	run_on_class (a_class_to_check: CLASS_C)
		+	-- Check all rules that have added their agents.
		+	local
		+	l_ast: CLASS_AS
		+	do
		+	last_run_successful := False
		+	l_ast := a_class_to_check.ast
		+	class_pre_actions.call ([l_ast])
		+	process_class_as (l_ast)
		+	class_post_actions.call ([l_ast])
		+	last_run_successful := True
		+	end
		+	</e>
		+
		+	This code analyzes a class for all active ''standard'' rules. <e>class_pre_actions</e> and <e>class_post_actions</e> are action sequences that are identical to those for the AST nodes. <e>process_class_as</e>, which is implemented in <e>{AST_ITERATOR}</e> will recursively visit all relevant AST nodes and execute their action sequences.

← Older revision		Revision as of 12:33, 7 March 2014
Line 9:		Line 9:

	The whole '''code analysis framework''' is located in the '''library ''code_analysis'''''.		The whole '''code analysis framework''' is located in the '''library ''code_analysis'''''.
		+
		+	== Class Relations ==
		+
		+	The following diagram shows an overview of the relations between the classes of the code analysis framework. All classes are located in the ''code_analysis'' library except for <e>CLASS_C</e> (EiffelStudio), <e>ROTA_TIMED_TASK_I</e> (''ecosystem'' cluster), <e>EWB_CODE_ANALYSIS</e> (command-line interface), and <e>ES_CODE_ANALYSIS_BENCH_HELPER</e> (GUI).
		+
		+	[[File:CA Framework Diagram.png\|thumb\|center\|800px\|The most interesting classes of the code analysis framework.]]

	== Interface ==		== Interface ==