2.1 Scatter Plot

This view shows where and how the code clones are distributed in the whole source files. Checkboxes at the upper side of Scatter Plot are used to turn on/off boundary of source files, directory, etc. Refer the manual for the detail of each option.

• Gray vertical and horizontal lines are boundaries of the source files, that is, locations of the end-of-flies.
• Squares drawn by black lines (on the main diagonal line) are directories.
• Black lines (and dots) that located parallel to the main diagonal line are code clones
  • The corresponding orthogonal projections to the horizontal axis and vertical axis are the locations of similar code fragments.

Also, The list of source files are shown in File Table at the left of the Scatter Plot.

2.2 File Table

File Table shows a list of target source files.

For each file, the following informations are shown:

• Index of the file(File ID)
• Path of the file
• Length of the file in token(LEN)
• Count of code clones included in the file(CLN)

On the above of the list, a "common" path of the source files is shown. The common path is a path of the root directory of the files in the list.

You can narrow down the list, by right-click menu.

• Select files by click, CTRL + click, or SHIFT + click -> [Fit Scope to Selected Files] or [Fit Scope to Files Except for Selected Ones]
• Alternatively, [Select Files That Have Clones Between Them] or [Selected Files Under] ? [Fit Scope to Selected Files] or [Fit Scope to Files Except for Selected Ones]

The status of narrowing-down of files can be canceled by menu [Pop Scope]

Tip:	In order to narrow down the file list with more complex selection (for example, keep files under two directories, or keep unselected files), use check boxes at the files in File Table. Refer the manual for operations about these check boxes.

2.3 Source Text

This view shows text of a source file. Code clones are illustrated as highlighted text.

When you select a file by clicking in File Table, text of the file will be shown in the Source Text.

• The area is composed of three views, Map (described in the next sheet), Line Number, and Text.
• Code clones are shown as text with gray background.
• The highlighting of line number shows code clones, but it also shows origin of the code. A highlight at left side means the code is similar to text of the other file. A highlight at the right side means the code is similar to text within the same file.
• Comments and the tokens (of comments or simple getters/setters) removed by a preprocess script are shown in green characters. Reserved words are shown in dark red characters.

2.4 Clone-Set Table

Clone-Set Table shows a list of the detected code clones. A clone set is a set of code fragments, in which any pair of the code fragments is a code clone. For each clone set, ID (Clone-Set ID) and length are shown.

Scope of Clone-Set Table is linked to scope of File Table. That is, if some files are removed from File Table by narrowing down, the enclosed code clones (whose code fragments appear only in these files) will be removed in Clone Set Table. (The reverse is not true. That is, if some code clones are removed from Clone-Set Table, the related files never be removed automatically.)

2.5 Saving Detected Code Clone or Scope

File menu has menu items to save scope and file list.

Saving scope:	A scope is a state of narrow-downing of files and code clones. Scopes are shown in Scope History at the leftmost view.

• Save: from menu [File]-[Open Current Scope As]
• Load: from menu [File]-[Open Clone Data]

Saving file list:
	A file list contains paths of source files in File Table.

• Save: from menu [File]-[Save File List as]
• From menu [File]-[Detect Clones from File List], you can re-detect code clones from the source files that have been beforehand saved as a file list.

Re-detection of clones:
	In order to detect code clones from the source files of current scope with the different detection options, use menu [File]-[Re-Detect Clones].

File Metrics

File metrics will be shown in File Table, by menu [Metrics]-[Show File Metrics].

NBR (neighbor):	Count of files that have a code-clone fragment between the file.
RSA (ratio of similarity between another files):
	Ratio (percentage) of tokens that are covered by a code clone between the file and one of the other files. If a file has a RSA value close to 100%, then it is possible that the file was created by copying a file.
RSI (ratio of similarity within the file):
	Ratio (percentage) of tokens that are covered by a code clone enclosed within the file. If a file has a RSI value close to 100%, then it is possible that the file contains a series of the similar functions or methods.
CVR (coverage):	Ratio (percentage) of tokens that are covered by any code clone. By definition, max(RSA, RSI) <= CVR <= RSA+RSI
RNR (ratio of non-repeated code):
	Ratio of non-repeated code. 1 - (ratio of tokens appears in repetition in the text) If the value is near to zero, the code is repetition of simple statements and/or defenitions.

From menu [Metrics]-[Filter File by Metrics], You can narrow down the file list by the minimum and maximum values of a metric.

Tip:	By default, when you perform narrowing down of file list after showing file metrics, the metrics value will disappear from File Table. In order to make GemX re-calculate and show file metrics automatically after such narrowing-down, add check mark to [Calc File Metrics Always] in the dialog shown by menu [Preferences]-[GemX Prererences].

Clone Set Metrics

Clone-set metrics will be shown by menu [Metrics]-[Show Clone-Set Metrics].

LEN (length):	Length (in token) of a code fragment of the code clone
POP (population):
	Count of code fragments of the code clone
NIF:	Count of source files that include one or more code fragments of the code clone. By definition, NIF <= POP (This metric is imported from Gemini, developed by Yoshiki Higo, Osaka Univ..)
RAD (radius):	Range of the source code fragments of a code clone in the directory hierarchy. (When all the code fragments of the code clone are located in one source file, the value is 0.)
RNR (ratio of non-repeated tokens):
	Ratio (percentage) of tokens that are not included in repeated part of a code fragment of the code clone.
TKS (token set size):
	Size of a set of tokens of a code fragment of the code clone. If a code clone has a extremely small TKS value, then the code fragment is a simple statement, such as a series of declaration of variables.
LOOP, COND, McCabe:
	LOOP is defined as count of loops in a code fragment, COND is defined as count of conditional branches, and McCabe is defined as the sum of them. In order to focus attention on complex code, select code clones with the higher values of these metrics.

You can do filtering of code clones from menu [Metrics]-[Filter Clone Set by Metrics].

When clone-set metrics are calculated, each clone in scatter plot will be colored by RNR metric value (by default).

Tip:	Just like file metrics, the clone-set metrics can be automatically re-calculated and shown by menu [Preferences]-[GemX Preferences].

Line-based Metrics

Line-based metrics will be shown by menu [Metrics]-[Show Line-based Metrics].

LOC:	Raw line count of the soure file.
SLOC:	Count of lines, in case of excluding lines whithout any valid tokens. Here, the "tokens" are specific to CCFinderX. (For example, definitions of simple getters/setters in Java source file will be entirely neglected by CCFinderX.) Such neglected characters are shown in green color in Source Text view.
CLOC:	Count of lines including at least one token of a code fragment of a code clone.
CVRL:	Ratio of the lines including a token of a code fragment of a code clone. CVRL = CLOC / SLOC.