Description Patrick Tasse 2011-02-25 13:17:12 EST

Build Identifier: 

Submitting a patch to implement searching, filtering, highlighting and bookmarking in the TMF events table.

Searching, filtering and highlighting use the filter model in TMF to match conditions against a trace event.

In the case where the events table was extended to provide customized columns, the column name is used by the filter model and the column title must match exactly the field label name as defined in the event content.

In the case of the default events table (e.g. as used by the Events view), internal field ids are used to match the default column content.

A header row is added at the top of the table. The header row can be used to set either search or filter conditions. It is possible to toggle between the two states by double-clicking on the header row icon or by context menu.

Searching and filtering is triggered by entering a regular expression in one of the columns in the header row. Multiple conditions can be combined by entering data in more than one column.

Searching will dim all non-matching events with a different background color. Matching events will have a decorator in the left margin. A progress monitor indicates when search is ongoing. Searching can be stopped with the ESC key and cleared with the DEL key. The user can navigate to the next matching event with the ENTER key and to the previous matching event with the Shift-ENTER key. Wrapping is enabled.

Filtering will first clear the table and refill it with matching events one by one. A status row will appear before and after the filtered events indicating how many events matched the filter and how many events were processed. The status row updates itself at regular intervals while filtering is ongoing. Filtering can be stopped with the ESC key and cleared with the DEL key.

The events table context menu contains actions to set a pre-defined workspace filter (ie. a filter created in the Filters view) and to clear all filters in the table.

The events table will automatically highlight event rows with customized background and foreground colors. The color settings are defined in the Colors view. The priority of conditions in the Colors view is respected and the event will use the color setting of the first matching condition. The events table automatically reflects any changes applied in the Colors view.

The user can apply a bookmark to any event in the table by either double-clicking the left margin, selecting Add bookmark in the context menu displayed by right-clicking on the left margin, or using the Add Bookmark action in the Edit menu.

The bookmark dialog will open allowing the user to name the bookmark. The event row will be decorated with a bookmark icon in the left margin, and the bookmark will be added in the standard Eclipse Bookmarks view.

Double-clicking on a bookmark in the Bookmarks view will open the event editor (or bring it to top if it is already open) and select the corresponding event. If the trace is opened by this action, the event selection is delayed until the trace indexing reaches the bookmark event rank.

A bookmark can be deleted by selecting Remove Bookmark in the left margin context menu or Delete in the Bookmarks view.

In this implementation, all matching events at filtering are stored in a cache without any limit on the memory used. It is therefore possible to exhaust the heap memory when filtering a very large trace with a condition that matches many trace events. This should be addressed in a future enhancement.


Reproducible: Always