Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "CDT/Better Debugging (GSoC project)"

< CDT
(Detailed Project Description)
(Detailed Project Description)
Line 24: Line 24:
 
Displaying an object as a human-readable string will be done via ''Formatters''.
 
Displaying an object as a human-readable string will be done via ''Formatters''.
  
Successful completion of this project will implement default at least following formatters:
+
Successful completion of this project will implement at least following default formatters:
* Basic STL containers
+
* All STL containers
** vector<T> will be displayed as
+
** '''vector''', '''set''', '''multiset''' and '''list''' will display all items formatted in following way: {item1, item2, ... , itemN}.
 +
** '''stack''' will display all items formatted in following way: (item1, item2, ... , itemN], where item1 is stack top and itemN is stack bottom.
 +
** '''queue''' and '''deque''' will display all items formatted in following way: (item1, item2, ... , itemN), where item1 is front of the queue and itemN is back of the queue.
 +
** '''priority_queue''' will display all items formatted in following way: (top:item1 other: {item2, ... , itemN}), where item1 is top of the queue and items 2..N are remaining queued items.
 +
** '''map''', '''multimap''' as {key1->value1, key2->value2, ... , keyN->valueN}.
 +
** '''bitset''' like (0111 1110 10)
 +
 
 +
Of course, all formatters will be applied recursively, thus:
 +
<source lang="cpp">
 +
vector<int> row1, row2;
 +
row1.push_back(1);
 +
row1.push_back(2);
 +
row2.push_back(3);
 +
row2.push_back(4);
 +
 
 +
vector< vector<int> > matrix;
 +
matrix.push_back(row1);
 +
matrix.push_back(row2);
 +
</source>
 +
should display matrix as {{1, 2}, {3, 4}}.
  
 
== Schedule of Code and Deliverables ==
 
== Schedule of Code and Deliverables ==

Revision as of 22:17, 27 March 2009

This page contains detailed description of "Better Debugging Environment" project for Google Summer of Code.

Summary

The goal of this project is to create more user-friendly debugging environment. This includes (but hopefully is not limited to):

  • Default formatter for STL container types (map, vector, queue, priority_queue, ...)
  • Default formatter for user structures.
  • Support for custom formatters.
  • Viewing variable content by simply hovering mouse over it.
  • Fixing usability issues (see below).

Detailed Project Description

This projects is intended to make debugging with CDT at least as comfortable as with Microsoft Visual Studio.

One of main parts of this project is to provide users with more readable representation of their data.

For example, when user watches on a vector<int> variable he/she expects to see not details of internal implementation of vector, but its contents:

vector<int> v;
for (int i = 0; i < 5; i++)
    v.push_back(i);

should display value of v as {0, 1, 2, 3, 4}.

Displaying an object as a human-readable string will be done via Formatters.

Successful completion of this project will implement at least following default formatters:

  • All STL containers
    • vector, set, multiset and list will display all items formatted in following way: {item1, item2, ... , itemN}.
    • stack will display all items formatted in following way: (item1, item2, ... , itemN], where item1 is stack top and itemN is stack bottom.
    • queue and deque will display all items formatted in following way: (item1, item2, ... , itemN), where item1 is front of the queue and itemN is back of the queue.
    • priority_queue will display all items formatted in following way: (top:item1 other: {item2, ... , itemN}), where item1 is top of the queue and items 2..N are remaining queued items.
    • map, multimap as {key1->value1, key2->value2, ... , keyN->valueN}.
    • bitset like (0111 1110 10)

Of course, all formatters will be applied recursively, thus:

vector<int> row1, row2;
row1.push_back(1);
row1.push_back(2);
row2.push_back(3);
row2.push_back(4);
 
vector< vector<int> > matrix;
matrix.push_back(row1);
matrix.push_back(row2);

should display matrix as {{1, 2}, {3, 4}}.

Schedule of Code and Deliverables

Back to the top