1 /**********************************************************************
2 * Copyright (c) 2012 Ericsson
4 * All rights reserved. This program and the accompanying materials are
5 * made available under the terms of the Eclipse Public License v1.0 which
6 * accompanies this distribution, and is available at
7 * http://www.eclipse.org/legal/epl-v10.html
10 * Bernd Hufmann - Initial API and implementation
11 **********************************************************************/
12 package org
.eclipse
.linuxtools
.internal
.lttng2
.ui
.views
.control
.dialogs
;
14 import java
.util
.ArrayList
;
15 import java
.util
.HashSet
;
16 import java
.util
.List
;
19 import org
.eclipse
.jface
.dialogs
.MessageDialog
;
20 import org
.eclipse
.jface
.viewers
.CheckStateChangedEvent
;
21 import org
.eclipse
.jface
.viewers
.CheckboxTreeViewer
;
22 import org
.eclipse
.jface
.viewers
.ICheckStateListener
;
23 import org
.eclipse
.linuxtools
.internal
.lttng2
.ui
.views
.control
.Messages
;
24 import org
.eclipse
.linuxtools
.internal
.lttng2
.ui
.views
.control
.TraceControlContentProvider
;
25 import org
.eclipse
.linuxtools
.internal
.lttng2
.ui
.views
.control
.TraceControlLabelProvider
;
26 import org
.eclipse
.linuxtools
.internal
.lttng2
.ui
.views
.control
.model
.ITraceControlComponent
;
27 import org
.eclipse
.linuxtools
.internal
.lttng2
.ui
.views
.control
.model
.LogLevelType
;
28 import org
.eclipse
.linuxtools
.internal
.lttng2
.ui
.views
.control
.model
.TraceLogLevel
;
29 import org
.eclipse
.linuxtools
.internal
.lttng2
.ui
.views
.control
.model
.impl
.BaseEventComponent
;
30 import org
.eclipse
.linuxtools
.internal
.lttng2
.ui
.views
.control
.model
.impl
.TargetNodeComponent
;
31 import org
.eclipse
.linuxtools
.internal
.lttng2
.ui
.views
.control
.model
.impl
.TraceProviderGroup
;
32 import org
.eclipse
.linuxtools
.internal
.lttng2
.ui
.views
.control
.model
.impl
.UstProviderComponent
;
33 import org
.eclipse
.swt
.SWT
;
34 import org
.eclipse
.swt
.custom
.CCombo
;
35 import org
.eclipse
.swt
.events
.SelectionAdapter
;
36 import org
.eclipse
.swt
.events
.SelectionEvent
;
37 import org
.eclipse
.swt
.graphics
.Image
;
38 import org
.eclipse
.swt
.layout
.GridData
;
39 import org
.eclipse
.swt
.layout
.GridLayout
;
40 import org
.eclipse
.swt
.widgets
.Button
;
41 import org
.eclipse
.swt
.widgets
.Composite
;
42 import org
.eclipse
.swt
.widgets
.Group
;
43 import org
.eclipse
.swt
.widgets
.Label
;
44 import org
.eclipse
.swt
.widgets
.Text
;
47 * <b><u>EnableUstEventsComposite</u></b>
49 * A composite for collecting information about UST events to be enabled.
52 public class EnableUstEventsComposite
extends Composite
implements IEnableUstEvents
{
54 // ------------------------------------------------------------------------
56 // ------------------------------------------------------------------------
58 private enum GroupEnum
{ TRACEPOINTS
, WILDCARD
, LOGLEVEL
};
60 // ------------------------------------------------------------------------
62 // ------------------------------------------------------------------------
65 * A button to enable/disable the tracepoints group
67 private Button fTracepointsActivateButton
;
69 * A tree viewer for diplaying and selection of available tracepoints.
71 private CheckboxTreeViewer fTracepointsViewer
;
73 * A button to enable/disable the wildcard group
75 private Button fWildcardActivateButton
;
77 * A Text field for the event's wildcard.
79 private Text fWildcardText
;
81 * A button to enable/disable the log level group
83 private Button fLogLevelActivateButton
;
85 * A Text field for the event name for the log level enablement.
87 private Text fLogLevelEventNameText
;
89 * A Combo box for selecting the log level.
91 private CCombo fLogLevelCombo
;
93 * A button for selecting the log level (range 0 to level).
95 private Button fLogLevelButton
;
97 * A button for selecting the specified log level only.
99 private Button fLogLevelOnlyButton
;
101 * The referenced trace provider group containing the UST providers
102 * component which contains a list of available tracepoints.
104 private TraceProviderGroup fProviderGroup
;
106 * The flag indicating that tracepoints are selected.
108 private boolean fIsTracepoints
;
110 * The flag indicating that all tracepoints (across providers) are selected.
112 private boolean fIsAllTracepoints
;
114 * The list of tracepoints to be enabled.
116 private List
<String
> fSelectedEvents
;
118 * The flag indicating that all wildcard are selected..
120 private boolean fIsWildcard
;
122 * The wildcard if wildcard is selected.
124 private String fWildcard
;
126 *The flag indicating that all log level are selected.
128 private boolean fIsLogLevel
;
130 * The event name for the log level enablement.
132 private String fLogLevelEventName
;
134 * The type of the log level (loglevel or loglevel-only)
136 private LogLevelType fLogLevelType
;
138 * The actual selected log level.
140 private TraceLogLevel fLogLevel
;
142 // ------------------------------------------------------------------------
144 // ------------------------------------------------------------------------
147 * @param parent - a parent composite
148 * @Param style - a compsite style
149 * @param providerGroup - the trace provider group
151 public EnableUstEventsComposite(Composite parent
, int style
, TraceProviderGroup providerGroup
) {
152 super(parent
, style
);
153 fProviderGroup
= providerGroup
;
156 // ------------------------------------------------------------------------
158 // ------------------------------------------------------------------------
162 * @see org.eclipse.linuxtools.internal.lttng2.ui.views.control.dialogs.IEnableUstEvents#isTracepoints()
165 public boolean isTracepoints() {
166 return fIsTracepoints
;
171 * @see org.eclipse.linuxtools.internal.lttng2.ui.views.control.dialogs.IEnableUstEvents#isAllTracePoints()
174 public boolean isAllTracePoints() {
175 return fIsAllTracepoints
;
180 * @see org.eclipse.linuxtools.internal.lttng2.ui.views.control.dialogs.IEnableUstEvents#getEventNames()
183 public List
<String
> getEventNames() {
184 return new ArrayList
<String
>(fSelectedEvents
);
189 * @see org.eclipse.linuxtools.internal.lttng2.ui.views.control.dialogs.IEnableUstEvents#isWildcard()
192 public boolean isWildcard() {
198 * @see org.eclipse.linuxtools.internal.lttng2.ui.views.control.dialogs.IEnableUstEvents#getWildcard()
201 public String
getWildcard() {
202 return "\"" + fWildcard
+ "\""; //$NON-NLS-1$//$NON-NLS-2$
207 * @see org.eclipse.linuxtools.internal.lttng2.ui.views.control.dialogs.IEnableUstEvents#isLogLevel()
210 public boolean isLogLevel() {
216 * @see org.eclipse.linuxtools.internal.lttng2.ui.views.control.dialogs.IEnableUstEvents#getLogLevelType()
219 public LogLevelType
getLogLevelType() {
220 return fLogLevelType
;
225 * @see org.eclipse.linuxtools.internal.lttng2.ui.views.control.dialogs.IEnableUstEvents#getLogLevel()
228 public TraceLogLevel
getLogLevel() {
234 * @see org.eclipse.linuxtools.internal.lttng2.ui.views.control.dialogs.IEnableUstEvents#getLogLevelEventName()
237 public String
getLogLevelEventName() {
238 return fLogLevelEventName
;
241 // ------------------------------------------------------------------------
243 // ------------------------------------------------------------------------
245 public void createContent() {
248 createTracepointsGroup();
251 createWildCardGroup();
254 createLogLevelGroup();
256 // Set default enablements
257 setEnablements(GroupEnum
.TRACEPOINTS
);
261 * Validates the UST composite input data.
262 * @return true if configured data is valid and can be retrieved.
264 public boolean isValid() {
266 fIsTracepoints
= fTracepointsActivateButton
.getSelection();
267 fIsWildcard
= fWildcardActivateButton
.getSelection();
268 fIsLogLevel
= fLogLevelActivateButton
.getSelection();
270 // initialize tracepoint fields
271 fIsAllTracepoints
= false;
272 fSelectedEvents
= new ArrayList
<String
>();
273 if (fIsTracepoints
) {
274 fIsAllTracepoints
= fTracepointsViewer
.getChecked(fProviderGroup
);
275 Set
<String
> set
= new HashSet
<String
>();
276 Object
[] checkedElements
= fTracepointsViewer
.getCheckedElements();
277 for (int i
= 0; i
< checkedElements
.length
; i
++) {
278 ITraceControlComponent component
= (ITraceControlComponent
)checkedElements
[i
];
279 if (!set
.contains(component
.getName()) && (component
instanceof BaseEventComponent
)) {
280 set
.add(component
.getName());
281 fSelectedEvents
.add(component
.getName());
286 // initialize log level event name string
287 fLogLevelType
= LogLevelType
.LOGLEVEL_NONE
;
288 fLogLevelEventName
= null;
291 if (fLogLevelButton
.getSelection()) {
292 fLogLevelType
= LogLevelType
.LOGLEVEL
;
293 } else if (fLogLevelOnlyButton
.getSelection()) {
294 fLogLevelType
= LogLevelType
.LOGLEVEL_ONLY
;
297 String temp
= fLogLevelEventNameText
.getText();
298 if (!temp
.matches("^[\\s]{0,}$") && !temp
.matches("^[a-zA-Z0-9\\-\\_]{1,}$")) { //$NON-NLS-1$ //$NON-NLS-2$
299 MessageDialog
.openError(getShell(),
300 Messages
.TraceControl_EnableEventsDialogTitle
,
301 Messages
.TraceControl_InvalidLogLevelEventNameError
+ " (" + temp
+ ") \n"); //$NON-NLS-1$ //$NON-NLS-2$
306 if(!temp
.matches("\\s*")) { //$NON-NLS-1$
307 fLogLevelEventName
= temp
;
310 TraceLogLevel
[] levels
= TraceLogLevel
.values();
311 int id
= fLogLevelCombo
.getSelectionIndex();
314 MessageDialog
.openError(getShell(),
315 Messages
.TraceControl_EnableEventsDialogTitle
,
316 Messages
.TraceControl_InvalidLogLevel
+ " (" + temp
+ ") \n"); //$NON-NLS-1$ //$NON-NLS-2$
320 fLogLevel
= levels
[id
];
324 // initialize wildcard with the event name string
327 String tempWildcard
= fWildcardText
.getText();
328 if (!tempWildcard
.matches("^[\\s]{0,}$") && !tempWildcard
.matches("^[a-zA-Z0-9\\-\\_\\*]{1,}$")) { //$NON-NLS-1$ //$NON-NLS-2$
329 MessageDialog
.openError(getShell(),
330 Messages
.TraceControl_EnableEventsDialogTitle
,
331 Messages
.TraceControl_InvalidWildcardError
+ " (" + tempWildcard
+ ") \n"); //$NON-NLS-1$ //$NON-NLS-2$
336 if(!tempWildcard
.matches("\\s*")) { //$NON-NLS-1$
337 fWildcard
= tempWildcard
;
341 // validation successful -> call super.okPressed()
345 // ------------------------------------------------------------------------
347 // ------------------------------------------------------------------------
350 * Creates tracepoints group.
352 private void createTracepointsGroup() {
353 Group tpMainGroup
= new Group(this, SWT
.SHADOW_NONE
);
354 tpMainGroup
.setText(Messages
.TraceControl_EnableEventsTracepointGroupName
);
355 GridLayout layout
= new GridLayout(2, false);
356 tpMainGroup
.setLayout(layout
);
357 GridData data
= new GridData(GridData
.FILL_BOTH
);
358 tpMainGroup
.setLayoutData(data
);
360 Composite buttonComposite
= new Composite(tpMainGroup
, SWT
.NONE
);
361 layout
= new GridLayout(1, true);
362 buttonComposite
.setLayout(layout
);
363 data
= new GridData(SWT
.BEGINNING
, SWT
.CENTER
, false, true);
364 buttonComposite
.setLayoutData(data
);
366 fTracepointsActivateButton
= new Button(buttonComposite
, SWT
.RADIO
);
367 fTracepointsActivateButton
.setText(Messages
.TraceControl_EnableGroupSelectionName
);
368 data
= new GridData(GridData
.FILL_HORIZONTAL
);
369 fTracepointsActivateButton
.setLayoutData(data
);
370 fTracepointsActivateButton
.addSelectionListener(new SelectionAdapter() {
372 public void widgetSelected(SelectionEvent e
) {
373 setEnablements(GroupEnum
.TRACEPOINTS
);
377 Group tpGroup
= new Group(tpMainGroup
, SWT
.SHADOW_NONE
);
378 layout
= new GridLayout(1, true);
379 tpGroup
.setLayout(layout
);
380 data
= new GridData(GridData
.FILL_BOTH
);
381 tpGroup
.setLayoutData(data
);
383 fTracepointsViewer
= new CheckboxTreeViewer(tpGroup
, SWT
.MULTI
| SWT
.H_SCROLL
| SWT
.V_SCROLL
);
384 fTracepointsViewer
.getTree().setToolTipText(Messages
.TraceControl_EnableEventsTracepointTreeTooltip
);
385 fTracepointsViewer
.setContentProvider(new UstContentProvider());
387 fTracepointsViewer
.setLabelProvider(new UstLabelProvider());
388 fTracepointsViewer
.addCheckStateListener(new UstCheckStateListener());
390 fTracepointsViewer
.setInput(fProviderGroup
.getParent());
391 fTracepointsViewer
.getTree().setLayoutData(new GridData(GridData
.FILL_BOTH
));
395 * Creates wildcard group.
397 private void createWildCardGroup() {
398 Group wildcardMainGroup
= new Group(this, SWT
.SHADOW_NONE
);
399 wildcardMainGroup
.setText(Messages
.TraceControl_EnableEventsWildcardGroupName
);
400 GridLayout layout
= new GridLayout(2, false);
401 wildcardMainGroup
.setLayout(layout
);
402 GridData data
= new GridData(GridData
.FILL_HORIZONTAL
);
403 wildcardMainGroup
.setLayoutData(data
);
405 Composite buttonComposite
= new Composite(wildcardMainGroup
, SWT
.NONE
);
406 layout
= new GridLayout(1, false);
407 buttonComposite
.setLayout(layout
);
408 data
= new GridData(SWT
.BEGINNING
, SWT
.CENTER
, false, true);
409 buttonComposite
.setLayoutData(data
);
411 fWildcardActivateButton
= new Button(buttonComposite
, SWT
.RADIO
);
412 fWildcardActivateButton
.setText(Messages
.TraceControl_EnableGroupSelectionName
);
413 fWildcardActivateButton
.setSelection(false);
414 data
= new GridData(GridData
.FILL_HORIZONTAL
);
415 fWildcardActivateButton
.setLayoutData(data
);
416 fWildcardActivateButton
.addSelectionListener(new SelectionAdapter() {
418 public void widgetSelected(SelectionEvent e
) {
419 setEnablements(GroupEnum
.WILDCARD
);
423 Group wildcardGroup
= new Group(wildcardMainGroup
, SWT
.SHADOW_NONE
);
424 layout
= new GridLayout(3, true);
425 wildcardGroup
.setLayout(layout
);
426 data
= new GridData(GridData
.FILL_HORIZONTAL
);
427 wildcardGroup
.setLayoutData(data
);
429 Label wildcardLabel
= new Label(wildcardGroup
, SWT
.LEFT
);
430 wildcardLabel
.setText(Messages
.TraceControl_EnableEventsWildcardLabel
);
431 data
= new GridData(GridData
.FILL_HORIZONTAL
);
432 data
.horizontalSpan
= 1;
433 wildcardLabel
.setLayoutData(data
);
435 fWildcardText
= new Text(wildcardGroup
, SWT
.LEFT
);
436 fWildcardText
.setToolTipText(Messages
.TraceControl_EnableEventsWildcardTooltip
);
437 data
= new GridData(GridData
.FILL_HORIZONTAL
);
438 data
.horizontalSpan
= 2;
439 fWildcardText
.setLayoutData(data
);
443 * Creates log level group.
445 private void createLogLevelGroup() {
446 Group logLevelMainGroup
= new Group(this, SWT
.SHADOW_NONE
);
447 logLevelMainGroup
.setText(Messages
.TraceControl_EnableEventsLogLevelGroupName
);
448 GridLayout layout
= new GridLayout(2, false);
449 logLevelMainGroup
.setLayout(layout
);
450 GridData data
= new GridData(GridData
.FILL_HORIZONTAL
);
451 logLevelMainGroup
.setLayoutData(data
);
453 Composite buttonComposite
= new Composite(logLevelMainGroup
, SWT
.NONE
);
454 layout
= new GridLayout(1, false);
455 buttonComposite
.setLayout(layout
);
456 data
= new GridData(SWT
.BEGINNING
, SWT
.CENTER
, false, true);
457 buttonComposite
.setLayoutData(data
);
459 fLogLevelActivateButton
= new Button(buttonComposite
, SWT
.RADIO
);
460 fLogLevelActivateButton
.setText(Messages
.TraceControl_EnableGroupSelectionName
);
461 fLogLevelActivateButton
.setSelection(false);
462 data
= new GridData(GridData
.FILL_HORIZONTAL
);
463 fLogLevelActivateButton
.setLayoutData(data
);
464 fLogLevelActivateButton
.addSelectionListener(new SelectionAdapter() {
466 public void widgetSelected(SelectionEvent e
) {
467 setEnablements(GroupEnum
.LOGLEVEL
);
471 Group logLevelGroup
= new Group(logLevelMainGroup
, SWT
.SHADOW_NONE
);
472 layout
= new GridLayout(3, true);
473 logLevelGroup
.setLayout(layout
);
474 logLevelGroup
.setLayoutData(new GridData(GridData
.FILL_HORIZONTAL
));
476 Label logLevelEventNameLabel
= new Label(logLevelGroup
, SWT
.LEFT
);
477 logLevelEventNameLabel
.setText(Messages
.TraceControl_EnableEventsEventNameLabel
);
479 data
= new GridData(GridData
.FILL_BOTH
);
480 data
.horizontalSpan
= 1;
481 logLevelEventNameLabel
.setLayoutData(data
);
483 fLogLevelEventNameText
= new Text(logLevelGroup
, SWT
.LEFT
);
484 fLogLevelEventNameText
.setToolTipText(Messages
.TraceControl_EnableEventsLoglevelEventNameTooltip
);
485 data
= new GridData(GridData
.FILL_BOTH
);
486 data
.horizontalSpan
= 2;
487 fLogLevelEventNameText
.setLayoutData(data
);
489 TraceLogLevel
[] levels
= TraceLogLevel
.values();
491 String
[] levelNames
= new String
[levels
.length
- 1];
493 for (int i
= 0; i
< levels
.length
; i
++) {
494 if (levels
[i
] != TraceLogLevel
.LEVEL_UNKNOWN
) {
495 levelNames
[k
++] = levels
[i
].getInName();
499 fLogLevelCombo
= new CCombo(logLevelGroup
, SWT
.READ_ONLY
);
500 fLogLevelCombo
.setItems(levelNames
);
501 fLogLevelCombo
.setToolTipText(Messages
.TraceControl_EnableEventsLogLevelTooltip
);
502 data
= new GridData(GridData
.FILL_HORIZONTAL
);
503 data
.horizontalSpan
= 4;
504 fLogLevelCombo
.setLayoutData(data
);
506 fLogLevelButton
= new Button(logLevelGroup
, SWT
.RADIO
);
507 fLogLevelButton
.setText(Messages
.TraceControl_EnableEventsLogLevelTypeName
);
508 fLogLevelButton
.setToolTipText(Messages
.TraceControl_EnableEventsLogLevelTypeTooltip
);
509 data
= new GridData(GridData
.FILL_BOTH
);
510 fLogLevelButton
.setLayoutData(data
);
512 fLogLevelOnlyButton
= new Button(logLevelGroup
, SWT
.RADIO
);
513 fLogLevelOnlyButton
.setText(Messages
.TraceControl_EnableEventsLogLevelOnlyTypeName
);
514 fLogLevelOnlyButton
.setToolTipText(Messages
.TraceControl_EnableEventsLogLevelOnlyTypeTooltip
);
515 data
= new GridData(GridData
.FILL_BOTH
);
516 fLogLevelButton
.setLayoutData(data
);
520 * Enable/selects widgets depending on the group specified.
521 * @param group - group to enable.
523 private void setEnablements(GroupEnum group
) {
525 // Enable/disable trace point items
526 fTracepointsActivateButton
.setSelection(group
== GroupEnum
.TRACEPOINTS
);
527 fTracepointsViewer
.getTree().setEnabled(group
== GroupEnum
.TRACEPOINTS
);
529 // Enable/disable wildcard items
530 fWildcardActivateButton
.setSelection(group
== GroupEnum
.WILDCARD
);
531 fWildcardText
.setEnabled(group
== GroupEnum
.WILDCARD
);
533 // Enable/disable log level items
534 fLogLevelActivateButton
.setSelection(group
== GroupEnum
.LOGLEVEL
);
535 fLogLevelEventNameText
.setEnabled(group
== GroupEnum
.LOGLEVEL
);
536 fLogLevelCombo
.setEnabled(group
== GroupEnum
.LOGLEVEL
);
537 fLogLevelButton
.setEnabled(group
== GroupEnum
.LOGLEVEL
);
538 fLogLevelOnlyButton
.setEnabled(group
== GroupEnum
.LOGLEVEL
);
541 // ------------------------------------------------------------------------
543 // ------------------------------------------------------------------------
545 * Content provider for the tracepoints tree.
547 final static public class UstContentProvider
extends TraceControlContentProvider
{
549 public Object
[] getChildren(Object parentElement
) {
550 if (parentElement
instanceof TargetNodeComponent
) {
551 List
<ITraceControlComponent
> children
= ((ITraceControlComponent
)parentElement
).getChildren(TraceProviderGroup
.class);
552 return (ITraceControlComponent
[]) children
.toArray(new ITraceControlComponent
[children
.size()]);
554 if (parentElement
instanceof TraceProviderGroup
) {
555 List
<ITraceControlComponent
> children
= ((ITraceControlComponent
)parentElement
).getChildren(UstProviderComponent
.class);
556 return (ITraceControlComponent
[]) children
.toArray(new ITraceControlComponent
[children
.size()]);
558 if (parentElement
instanceof ITraceControlComponent
) {
559 return ((ITraceControlComponent
)parentElement
).getChildren();
561 return new Object
[0];
566 * Content label for the tracepoints tree.
568 final static public class UstLabelProvider
extends TraceControlLabelProvider
{
570 public Image
getImage(Object element
) {
574 public String
getText(Object element
) {
575 if ((element
!= null) && (element
instanceof TraceProviderGroup
)) {
576 return Messages
.TraceControl_EnableEventsTracepointTreeAllLabel
;
579 if ((element
!= null) && (element
instanceof UstProviderComponent
)) {
580 return Messages
.TraceControl_EnableEventsTracepointTreeAllLabel
+ " - " + ((UstProviderComponent
)element
).getName(); //$NON-NLS-1$
582 return super.getText(element
);
587 * Check state listener for the tracepoints tree.
589 final public class UstCheckStateListener
implements ICheckStateListener
{
591 public void checkStateChanged(CheckStateChangedEvent event
) {
592 if (event
.getChecked()) {
593 if (event
.getElement() instanceof TraceProviderGroup
) {
594 fTracepointsViewer
.setSubtreeChecked(event
.getElement(), true);
596 if (event
.getElement() instanceof UstProviderComponent
) {
597 fTracepointsViewer
.setSubtreeChecked(event
.getElement(), true);
600 if (event
.getElement() instanceof TraceProviderGroup
) {
601 fTracepointsViewer
.setSubtreeChecked(event
.getElement(), true);
603 if (event
.getElement() instanceof UstProviderComponent
) {
604 ITraceControlComponent component
= (ITraceControlComponent
) event
.getElement();
605 fTracepointsViewer
.setSubtreeChecked(event
.getElement(), false);
606 fTracepointsViewer
.setChecked(component
.getParent(), false);
608 ITraceControlComponent component
= (ITraceControlComponent
) event
.getElement();
609 fTracepointsViewer
.setChecked(component
.getParent(), false);
610 fTracepointsViewer
.setChecked(component
.getParent().getParent(), false);