ucc gui user manual-0410 - cssecsse.usc.edu/csse/affiliate/private/ucc/april2013/ucc_gui_user... ·...
TRANSCRIPT
UCC GUI USER MANUAL
Table of Contents
Counting: ................................................................................................................................ 2
New File Extensions (-‐extFile): .............................................................................................. 14
The Menu Bar: ...................................................................................................................... 18 File Menu:-‐ .................................................................................................................................... 18 Help Menu:-‐ .................................................................................................................................. 18
Debug Mode ......................................................................................................................... 19
Counting: Scenario 1: To count the lines of code in Code files etc:
1. Double click the UCC executable to load the Software and see the interface as shown below:
2. Click on the ‘Add File button’.
3. Select the file to be counted. 4. Click on ‘Start’.
Scenario 2: To count the lines of code of when baseline files are in a folder
1. In the List options choose the type of files (C/C++ or Java or CSS etc) to be considered for counting from the folder.
2. Click on Add Folder
3. Select the folder containing the files to be added for counting 4. Click on Start to start the process of counting.
Scenario 3: To generate the report in a Text File (ascii) rather than a .CSV file.
1. Using Add File or Add Folder selects the file or folder to be counted.
OR
2. Check the –ascii checkbox
3. Click on Start
Scenario 4: To generate the report without displaying complex matrices. Note: You may reduce computation time by doing selecting this option.
1. Using Add File or Add Folder select the file or folder to be counted.
OR
2. Check the –nocomplex checkbox
3. Click on Start
Scenario 5: To avoid processing duplicates:
1. Using Add File or Add Folder select the file or folder to be counted.
OR
2. Check the –nodup checkbox
3. Click on Start
Scenario 6: To count files specifying a threshold percentage for duplicate files:
1. Using Add File or Add Folder select the file or folder to be counted.
OR
2. Check the –tdup checkbox and specify a percentage in the range 0-‐100
3. Click on Start
Scenario 7: To count files specifying the maximum number of characters allowed in a logical SLOC:
1. Using Add File or Add Folder select the file or folder to be counted.
OR
2. Check the –trunc checkbox and specify a percentage in the maximum characters(default
10,000)
3. Click on Start
Scenario 8: To Generate Reports using Legacy Format: Note: Use this option to retain the output files formats supported by Difftool, CodeCount ToolRelease 2007.07 and earlier versions. By default, the new output files formats with new fields are applied.
1. Using Add File or Add Folder select the file or folder to be counted.
OR
2. Check the –nolegacy checkbox
3. Click on Start
Note: You may use a combination of scenario 3,4 and 5 to Generate the Report as per requirement. For example: To Generate Report in ASCII format without displaying complex matrices:
1. Using Add File or Add Folder select the file or folder to be counted.
OR
2. Check the –ascii and -‐nocomplex checkbox
3. Click on Start
Differencing: For differencing please make sure that the Differencing checkbox is checked. Scenario 1: To find the difference between two files:
1. Check the Differencing checkbox. As soon the box is checked another widget with list of file types pops up.
2. Add Baseline A file to the left ‘Files to Count’ widget and Baseline B file to the right ‘Files to Count’ Widget.
3. Click on Start
4. The output generates the following file:
a. Baseline-‐A-‐Java_outfile.csv
b. Baseline-‐B-‐Java_outfile.csv
c. Baseline-‐A-‐outfile_cplx.csv
d. Baseline-‐B-‐outfile_cplx.csv
e. MatchedPairs.csv
f. Outfile_diff_result.csv
5. The output will display the file: ‘Baseline-‐A-‐Java_outfile.csv’ by default. The dropdown box of the generated result may be used to view the other files generated.
Scenario 2: To find the difference between files in two directories:
1. Select the required type or language from the list box.
2. Click on ‘Add Folder’ to add the required files from the folder.
3. Repeat 2 for Baseline B files for the right hand side. 4. Click on Start
5. To browse through all the output files generated please click on the drop down box in
the window that shows the Report Generated.
Scenario 3: To find the difference between baselines specifying the threshold of a modified line:
1. Select the required file types or language from the list box.
2. Click on ‘Add Folder’ to add the required files from the folder.
3. Repeat 2 for Baseline B files for the right hand side. 4. Check the –t# checkbox and specify the percentage(defaults to 60).
5. Click on Start
6. To browse through all the output files generated please click on the drop down box in
the window that shows the Report Generated.
Scenario 4: To find the difference between baselines specifying the threshold for duplicate files: (The maximum percent difference between two files of the same name in a baseline to be considered duplicates)
1. Select the required file types or language from the list box.
2. Click on ‘Add Folder’ to add the required files from the folder.
3. Repeat 2 for Baseline B files for the right hand side. 4. Check the –tdup# checkbox and specify the percentage(defaults to 60).
5. Click on Start
6. To browse through all the output files generated please click on the drop down box in
the window that shows the Report Generated.
To find the difference between baselines specifying the maximum number of characters in a logical SLOC:
1. Select the required file types or languages from the list box.
2. Click on ‘Add Folder’ to add the required files from the folder.
3. Repeat 2 for Baseline B files for the right hand side. 4. Check the –trunc# checkbox and specify the percentage(defaults to 10000).
5. Click on Start
6. To browse through all the output files generated please click on the drop down box in
the window that shows the Report Generated.
New File Extensions (-‐extFile): To add a new file extension:
1. Check the –extFile to open a new Dialog box.
2. Now in the Add Extension Text box enter the new extension and the counter you want it to associate with.
3. Click the Add Button
4. Click Ok to close the dialog and add the extension.
To delete the new file extension:
1) Check the –extFile to open a new Dialog box
2) Choose the extension you want to delete
3) Click on the Delete button.
4) Click OK to delete the extension.
To get Help on File extensions:
1) Check the –extFile top open a new Dialog box
2) Click on the File Extension button to display the Help Dialog
3) Click OK after having viewed the Help Section.
The Menu Bar:
File Menu:-‐ To Open any File in UCC:
1. Click on File option in the menu bar
2. Click on File Open
3. Select the file you want to open.
To view File Extensions:
1. Click on File option from the menu bar
2. Click on Extensions.
To exit the application:
1. Click on File option from the menu bar
2. Click on Exit.
Help Menu:-‐ To view the User Manual:-‐
1. Click on Help from the menu bar
2. Click on User Manual
To view general information about UCC, like version etc:
1. Click on help from the menu bar
2. Click on About
Debug Mode The GUI version of UCC is based on QT framework, when we need to debug the GUCC, we must
firstly download the QT library from the QT project website, the setup the IDE (QT-‐Creator, Visual Studio and so on)
Window platform (Visual Studio + QT) Step1: Go to website http://qt-‐project.org/downloads to download the QT application framework. Qt 5.0.2 for Windows 32-‐bit (VS 2010, 485 MB) Step2: Install Microsoft Visual Studio 2010 Step3: Download QT version studio add-‐in. Go to website http://qt-‐project.org/downloads, download Visual Studio Add-‐in 1.2.0 for Qt5. Step4: Download the source code of GUCC project Step5: Open Microsoft Visual Studio, if the add-‐in was successfully installed, the QT drop-‐down menu will appear at the middle of menu bar of Visual Studio.
Step6: Click Qt5-‐>Open Qt Project File (.pro)…, select GUCC to open
Step7: Open Qt5-‐> Qt Project Settings
Step8: In Qt Modules, select Core, Widgets and GUI.
Step9: Select Build-‐>Build Solution
Step10: When GUCC project is successful built, select Debug-‐>Start Debugging or Start Without Debugging
Step11: The debug mode of GUCC project is opened.
