This dialog window provides users with the ability to modify existing or to setup new so–called file filter configurations. Such a file filter configuration consists of all in all three different types of information. These are general information used by the program as well as file search information and information needed to analyze the file content. But before continue reading please take a closer look at figure below.
Figure above shows that dialog window File Filter Configuration is split into two areas. At left users can find the list of already existing file filter configurations. This list is named Groups. At the right the dialog presents the controls showing the data of currently selected file filter configuration.
Below list Groups, users can find three buttons allowing managing existing file filter configurations. These buttons as well as their behavior should be explained now.
[Add] | This button appends a new entry at the Groups list. Users can then provide the name of this new group directly inside the list. Pressing keyboard button [ENTER] finalizes entering the new group name. Please note pressing keyboard button [INS] also adds a new group entry. |
[Edit] | This button is used to modify the name of an existing group. Clicking this button opens an edit box inside the list and users can then type a new name. Alternatively, pressing keyboard button [F2] is also possible to open an edit box for currently selected group item. |
[Delete] | This button simply removes currently selected group including all its data. Keyboard button [DEL] can be used instead. |
At the dialog window’s right side a set of controls can be found showing the information of currently selected file filter configuration. Explaining the meaning of these controls is task of following paragraphs.
Each file filter configuration provides a Description as well as a Tooltip as its general information. The meaning of these data should be explained now.
Description | Here users can provide a short description about this particular file filter configuration which is for example used when a report is created. |
Tooltip | Here users can provide an explaining text which is shown as tooltip when the main window’s File Filter Configuration combo–box is focused. Please note if no tooltip is set then this combo–box uses an alternative tooltip consisting of group name and file search pattern. |
Each file filter configuration provides just Pattern as file search information. See below for more details.
Pattern | Here users can declare a set of file extensions belonging to this file filter configuration. Please note each file extension has to be separated by a space or a comma or a semicolon. Additionally, keep in mind that program Line Counter tries to “normalize” each provided file extension. Normalizing means in this case that after leaving this control, each provided file extension is adjusted to *.ext. For more information about known issues according to file pattern please see here. |
File Analyzing Information are represented by all other available data fields. These data are generally split into information about Literals and information about Comment Schemes. Please see following explanations for more information.
Literals are generally known as String Literals and as Character Literals. To enable counting of those literal types users simply provide the corresponding information. This means in turn, leaving out these data suppresses a counting of belonging literals. See below for more details how to provide literal information. Please keep in mind the following explanations fit to String Literals and Character Literals as well.
Marker | This field allows providing a value that indicates the start and the end marker of a literal. Usually such a literal marker consists of just one character. But inputting a string marker is also supported and will be handled by program Line Counter accordingly. In common programming languages, such as C++, String Literals are enclosed in double quotes and Character Literals are surrounded by single quotes. |
Escape | This field allows providing a value that indicates the so–called escape sequence. This escape value is important because otherwise counting of literals may cause a wrong result. To clarify what is meant by this escape value, an example seems to be necessary. Assuming an analyzed C++ file contains a string like "Hello, \"World\"!", then this string can be counted in different ways depending on the settings of Marker and Escape. In case of the Marker is set to " and Escape is set to \ then the number of counted strings is one, as expected. But in case of a missing or wrongly set Escape value the number of counted strings is two, one hit for "Hello, \" and another hit for "!". |
The major reason of program Line Counter is counting the comment lines inside a particular code file. But comments can vary in different file types. Therefore, group–box Comment Schemes provides users with the possibility to manage such comment types. Generally, group–box Comment Schemes is split into a set of management buttons and a list showing currently configured comment schemes. Please note every single comment scheme can be adjusted in a separate dialog box. For more information about this dialog window please see section Comment Scheme Configuration.
[Add] | This button appends a new Comment Scheme entry to the list of existing Comment Schemes. After clicking this button the dialog box Comment Scheme Configuration is automatically opened. Pressing keyboard button [INS] also adds a new Comment Scheme entry. |
[Edit] | This button is used to modify an existing Comment Scheme entry. Clicking this button also opens dialog box Comment Scheme Configuration. Alternatively, pressing keyboard button [ENTER] is also possible to open this dialog window. |
[Delete] | This button simply removes currently selected Comment Scheme entry. Keyboard button [DEL] can be used instead. |
See also:
Copyright © plexdata.de