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
.core
.control
.model
.LogLevelType
;
24 import org
.eclipse
.linuxtools
.internal
.lttng2
.core
.control
.model
.TraceLogLevel
;
25 import org
.eclipse
.linuxtools
.internal
.lttng2
.ui
.views
.control
.messages
.Messages
;
26 import org
.eclipse
.linuxtools
.internal
.lttng2
.ui
.views
.control
.model
.ITraceControlComponent
;
27 import org
.eclipse
.linuxtools
.internal
.lttng2
.ui
.views
.control
.model
.impl
.BaseEventComponent
;
28 import org
.eclipse
.linuxtools
.internal
.lttng2
.ui
.views
.control
.model
.impl
.TargetNodeComponent
;
29 import org
.eclipse
.linuxtools
.internal
.lttng2
.ui
.views
.control
.model
.impl
.TraceControlContentProvider
;
30 import org
.eclipse
.linuxtools
.internal
.lttng2
.ui
.views
.control
.model
.impl
.TraceControlLabelProvider
;
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
;
48 * A composite for collecting information about UST events to be enabled.
51 * @author Bernd Hufmann
53 public class EnableUstEventsComposite
extends Composite
implements IEnableUstEvents
{
55 // ------------------------------------------------------------------------
57 // ------------------------------------------------------------------------
59 private enum GroupEnum
{ TRACEPOINTS
, WILDCARD
, LOGLEVEL
};
61 // ------------------------------------------------------------------------
63 // ------------------------------------------------------------------------
66 * A button to enable/disable the tracepoints group
68 private Button fTracepointsActivateButton
;
70 * A tree viewer for diplaying and selection of available tracepoints.
72 private CheckboxTreeViewer fTracepointsViewer
;
74 * A button to enable/disable the wildcard group
76 private Button fWildcardActivateButton
;
78 * A Text field for the event's wildcard.
80 private Text fWildcardText
;
82 * A button to enable/disable the log level group
84 private Button fLogLevelActivateButton
;
86 * A Text field for the event name for the log level enablement.
88 private Text fLogLevelEventNameText
;
90 * A Combo box for selecting the log level.
92 private CCombo fLogLevelCombo
;
94 * A button for selecting the log level (range 0 to level).
96 private Button fLogLevelButton
;
98 * A button for selecting the specified log level only.
100 private Button fLogLevelOnlyButton
;
102 * The referenced trace provider group containing the UST providers
103 * component which contains a list of available tracepoints.
105 private TraceProviderGroup fProviderGroup
;
107 * The flag indicating that tracepoints are selected.
109 private boolean fIsTracepoints
;
111 * The flag indicating that all tracepoints (across providers) are selected.
113 private boolean fIsAllTracepoints
;
115 * The list of tracepoints to be enabled.
117 private List
<String
> fSelectedEvents
;
119 * The flag indicating that all wildcard are selected..
121 private boolean fIsWildcard
;
123 * The wildcard if wildcard is selected.
125 private String fWildcard
;
127 *The flag indicating that all log level are selected.
129 private boolean fIsLogLevel
;
131 * The event name for the log level enablement.
133 private String fLogLevelEventName
;
135 * The type of the log level (loglevel or loglevel-only)
137 private LogLevelType fLogLevelType
;
139 * The actual selected log level.
141 private TraceLogLevel fLogLevel
;
143 // ------------------------------------------------------------------------
145 // ------------------------------------------------------------------------
148 * @param parent - a parent composite
149 * @Param style - a compsite style
150 * @param providerGroup - the trace provider group
152 public EnableUstEventsComposite(Composite parent
, int style
, TraceProviderGroup providerGroup
) {
153 super(parent
, style
);
154 fProviderGroup
= providerGroup
;
157 // ------------------------------------------------------------------------
159 // ------------------------------------------------------------------------
163 * @see org.eclipse.linuxtools.internal.lttng2.ui.views.control.dialogs.IEnableUstEvents#isTracepoints()
166 public boolean isTracepoints() {
167 return fIsTracepoints
;
172 * @see org.eclipse.linuxtools.internal.lttng2.ui.views.control.dialogs.IEnableUstEvents#isAllTracePoints()
175 public boolean isAllTracePoints() {
176 return fIsAllTracepoints
;
181 * @see org.eclipse.linuxtools.internal.lttng2.ui.views.control.dialogs.IEnableUstEvents#getEventNames()
184 public List
<String
> getEventNames() {
185 return new ArrayList
<String
>(fSelectedEvents
);
190 * @see org.eclipse.linuxtools.internal.lttng2.ui.views.control.dialogs.IEnableUstEvents#isWildcard()
193 public boolean isWildcard() {
199 * @see org.eclipse.linuxtools.internal.lttng2.ui.views.control.dialogs.IEnableUstEvents#getWildcard()
202 public String
getWildcard() {
203 return "\"" + fWildcard
+ "\""; //$NON-NLS-1$//$NON-NLS-2$
208 * @see org.eclipse.linuxtools.internal.lttng2.ui.views.control.dialogs.IEnableUstEvents#isLogLevel()
211 public boolean isLogLevel() {
217 * @see org.eclipse.linuxtools.internal.lttng2.ui.views.control.dialogs.IEnableUstEvents#getLogLevelType()
220 public LogLevelType
getLogLevelType() {
221 return fLogLevelType
;
226 * @see org.eclipse.linuxtools.internal.lttng2.ui.views.control.dialogs.IEnableUstEvents#getLogLevel()
229 public TraceLogLevel
getLogLevel() {
235 * @see org.eclipse.linuxtools.internal.lttng2.ui.views.control.dialogs.IEnableUstEvents#getLogLevelEventName()
238 public String
getLogLevelEventName() {
239 return fLogLevelEventName
;
242 // ------------------------------------------------------------------------
244 // ------------------------------------------------------------------------
246 public void createContent() {
249 createTracepointsGroup();
252 createWildCardGroup();
255 createLogLevelGroup();
257 // Set default enablements
258 setEnablements(GroupEnum
.TRACEPOINTS
);
262 * Validates the UST composite input data.
263 * @return true if configured data is valid and can be retrieved.
265 public boolean isValid() {
267 fIsTracepoints
= fTracepointsActivateButton
.getSelection();
268 fIsWildcard
= fWildcardActivateButton
.getSelection();
269 fIsLogLevel
= fLogLevelActivateButton
.getSelection();
271 // initialize tracepoint fields
272 fIsAllTracepoints
= false;
273 fSelectedEvents
= new ArrayList
<String
>();
274 if (fIsTracepoints
) {
275 fIsAllTracepoints
= fTracepointsViewer
.getChecked(fProviderGroup
);
276 Set
<String
> set
= new HashSet
<String
>();
277 Object
[] checkedElements
= fTracepointsViewer
.getCheckedElements();
278 for (int i
= 0; i
< checkedElements
.length
; i
++) {
279 ITraceControlComponent component
= (ITraceControlComponent
)checkedElements
[i
];
280 if (!set
.contains(component
.getName()) && (component
instanceof BaseEventComponent
)) {
281 set
.add(component
.getName());
282 fSelectedEvents
.add(component
.getName());
287 // initialize log level event name string
288 fLogLevelType
= LogLevelType
.LOGLEVEL_NONE
;
289 fLogLevelEventName
= null;
292 if (fLogLevelButton
.getSelection()) {
293 fLogLevelType
= LogLevelType
.LOGLEVEL
;
294 } else if (fLogLevelOnlyButton
.getSelection()) {
295 fLogLevelType
= LogLevelType
.LOGLEVEL_ONLY
;
298 String temp
= fLogLevelEventNameText
.getText();
299 if (!temp
.matches("^[\\s]{0,}$") && !temp
.matches("^[a-zA-Z0-9\\-\\_]{1,}$")) { //$NON-NLS-1$ //$NON-NLS-2$
300 MessageDialog
.openError(getShell(),
301 Messages
.TraceControl_EnableEventsDialogTitle
,
302 Messages
.TraceControl_InvalidLogLevelEventNameError
+ " (" + temp
+ ") \n"); //$NON-NLS-1$ //$NON-NLS-2$
307 if(!temp
.matches("\\s*")) { //$NON-NLS-1$
308 fLogLevelEventName
= temp
;
311 TraceLogLevel
[] levels
= TraceLogLevel
.values();
312 int id
= fLogLevelCombo
.getSelectionIndex();
315 MessageDialog
.openError(getShell(),
316 Messages
.TraceControl_EnableEventsDialogTitle
,
317 Messages
.TraceControl_InvalidLogLevel
+ " (" + temp
+ ") \n"); //$NON-NLS-1$ //$NON-NLS-2$
321 fLogLevel
= levels
[id
];
325 // initialize wildcard with the event name string
328 String tempWildcard
= fWildcardText
.getText();
329 if (!tempWildcard
.matches("^[\\s]{0,}$") && !tempWildcard
.matches("^[a-zA-Z0-9\\-\\_\\*]{1,}$")) { //$NON-NLS-1$ //$NON-NLS-2$
330 MessageDialog
.openError(getShell(),
331 Messages
.TraceControl_EnableEventsDialogTitle
,
332 Messages
.TraceControl_InvalidWildcardError
+ " (" + tempWildcard
+ ") \n"); //$NON-NLS-1$ //$NON-NLS-2$
337 if(!tempWildcard
.matches("\\s*")) { //$NON-NLS-1$
338 fWildcard
= tempWildcard
;
342 // validation successful -> call super.okPressed()
346 // ------------------------------------------------------------------------
348 // ------------------------------------------------------------------------
351 * Creates tracepoints group.
353 private void createTracepointsGroup() {
354 Group tpMainGroup
= new Group(this, SWT
.SHADOW_NONE
);
355 tpMainGroup
.setText(Messages
.TraceControl_EnableEventsTracepointGroupName
);
356 GridLayout layout
= new GridLayout(2, false);
357 tpMainGroup
.setLayout(layout
);
358 GridData data
= new GridData(GridData
.FILL_BOTH
);
359 tpMainGroup
.setLayoutData(data
);
361 Composite buttonComposite
= new Composite(tpMainGroup
, SWT
.NONE
);
362 layout
= new GridLayout(1, true);
363 buttonComposite
.setLayout(layout
);
364 data
= new GridData(SWT
.BEGINNING
, SWT
.CENTER
, false, true);
365 buttonComposite
.setLayoutData(data
);
367 fTracepointsActivateButton
= new Button(buttonComposite
, SWT
.RADIO
);
368 fTracepointsActivateButton
.setText(Messages
.TraceControl_EnableGroupSelectionName
);
369 data
= new GridData(GridData
.FILL_HORIZONTAL
);
370 fTracepointsActivateButton
.setLayoutData(data
);
371 fTracepointsActivateButton
.addSelectionListener(new SelectionAdapter() {
373 public void widgetSelected(SelectionEvent e
) {
374 setEnablements(GroupEnum
.TRACEPOINTS
);
378 Group tpGroup
= new Group(tpMainGroup
, SWT
.SHADOW_NONE
);
379 layout
= new GridLayout(1, true);
380 tpGroup
.setLayout(layout
);
381 data
= new GridData(GridData
.FILL_BOTH
);
382 tpGroup
.setLayoutData(data
);
384 fTracepointsViewer
= new CheckboxTreeViewer(tpGroup
, SWT
.MULTI
| SWT
.H_SCROLL
| SWT
.V_SCROLL
);
385 fTracepointsViewer
.getTree().setToolTipText(Messages
.TraceControl_EnableEventsTracepointTreeTooltip
);
386 fTracepointsViewer
.setContentProvider(new UstContentProvider());
388 fTracepointsViewer
.setLabelProvider(new UstLabelProvider());
389 fTracepointsViewer
.addCheckStateListener(new UstCheckStateListener());
391 fTracepointsViewer
.setInput(fProviderGroup
.getParent());
392 fTracepointsViewer
.getTree().setLayoutData(new GridData(GridData
.FILL_BOTH
));
396 * Creates wildcard group.
398 private void createWildCardGroup() {
399 Group wildcardMainGroup
= new Group(this, SWT
.SHADOW_NONE
);
400 wildcardMainGroup
.setText(Messages
.TraceControl_EnableEventsWildcardGroupName
);
401 GridLayout layout
= new GridLayout(2, false);
402 wildcardMainGroup
.setLayout(layout
);
403 GridData data
= new GridData(GridData
.FILL_HORIZONTAL
);
404 wildcardMainGroup
.setLayoutData(data
);
406 Composite buttonComposite
= new Composite(wildcardMainGroup
, SWT
.NONE
);
407 layout
= new GridLayout(1, false);
408 buttonComposite
.setLayout(layout
);
409 data
= new GridData(SWT
.BEGINNING
, SWT
.CENTER
, false, true);
410 buttonComposite
.setLayoutData(data
);
412 fWildcardActivateButton
= new Button(buttonComposite
, SWT
.RADIO
);
413 fWildcardActivateButton
.setText(Messages
.TraceControl_EnableGroupSelectionName
);
414 fWildcardActivateButton
.setSelection(false);
415 data
= new GridData(GridData
.FILL_HORIZONTAL
);
416 fWildcardActivateButton
.setLayoutData(data
);
417 fWildcardActivateButton
.addSelectionListener(new SelectionAdapter() {
419 public void widgetSelected(SelectionEvent e
) {
420 setEnablements(GroupEnum
.WILDCARD
);
424 Group wildcardGroup
= new Group(wildcardMainGroup
, SWT
.SHADOW_NONE
);
425 layout
= new GridLayout(3, true);
426 wildcardGroup
.setLayout(layout
);
427 data
= new GridData(GridData
.FILL_HORIZONTAL
);
428 wildcardGroup
.setLayoutData(data
);
430 Label wildcardLabel
= new Label(wildcardGroup
, SWT
.LEFT
);
431 wildcardLabel
.setText(Messages
.TraceControl_EnableEventsWildcardLabel
);
432 data
= new GridData(GridData
.FILL_HORIZONTAL
);
433 data
.horizontalSpan
= 1;
434 wildcardLabel
.setLayoutData(data
);
436 fWildcardText
= new Text(wildcardGroup
, SWT
.LEFT
);
437 fWildcardText
.setToolTipText(Messages
.TraceControl_EnableEventsWildcardTooltip
);
438 data
= new GridData(GridData
.FILL_HORIZONTAL
);
439 data
.horizontalSpan
= 2;
440 fWildcardText
.setLayoutData(data
);
444 * Creates log level group.
446 private void createLogLevelGroup() {
447 Group logLevelMainGroup
= new Group(this, SWT
.SHADOW_NONE
);
448 logLevelMainGroup
.setText(Messages
.TraceControl_EnableEventsLogLevelGroupName
);
449 GridLayout layout
= new GridLayout(2, false);
450 logLevelMainGroup
.setLayout(layout
);
451 GridData data
= new GridData(GridData
.FILL_HORIZONTAL
);
452 logLevelMainGroup
.setLayoutData(data
);
454 Composite buttonComposite
= new Composite(logLevelMainGroup
, SWT
.NONE
);
455 layout
= new GridLayout(1, false);
456 buttonComposite
.setLayout(layout
);
457 data
= new GridData(SWT
.BEGINNING
, SWT
.CENTER
, false, true);
458 buttonComposite
.setLayoutData(data
);
460 fLogLevelActivateButton
= new Button(buttonComposite
, SWT
.RADIO
);
461 fLogLevelActivateButton
.setText(Messages
.TraceControl_EnableGroupSelectionName
);
462 fLogLevelActivateButton
.setSelection(false);
463 data
= new GridData(GridData
.FILL_HORIZONTAL
);
464 fLogLevelActivateButton
.setLayoutData(data
);
465 fLogLevelActivateButton
.addSelectionListener(new SelectionAdapter() {
467 public void widgetSelected(SelectionEvent e
) {
468 setEnablements(GroupEnum
.LOGLEVEL
);
472 Group logLevelGroup
= new Group(logLevelMainGroup
, SWT
.SHADOW_NONE
);
473 layout
= new GridLayout(3, true);
474 logLevelGroup
.setLayout(layout
);
475 logLevelGroup
.setLayoutData(new GridData(GridData
.FILL_HORIZONTAL
));
477 Label logLevelEventNameLabel
= new Label(logLevelGroup
, SWT
.LEFT
);
478 logLevelEventNameLabel
.setText(Messages
.TraceControl_EnableEventsEventNameLabel
);
480 data
= new GridData(GridData
.FILL_BOTH
);
481 data
.horizontalSpan
= 1;
482 logLevelEventNameLabel
.setLayoutData(data
);
484 fLogLevelEventNameText
= new Text(logLevelGroup
, SWT
.LEFT
);
485 fLogLevelEventNameText
.setToolTipText(Messages
.TraceControl_EnableEventsLoglevelEventNameTooltip
);
486 data
= new GridData(GridData
.FILL_BOTH
);
487 data
.horizontalSpan
= 2;
488 fLogLevelEventNameText
.setLayoutData(data
);
490 TraceLogLevel
[] levels
= TraceLogLevel
.values();
492 String
[] levelNames
= new String
[levels
.length
- 1];
494 for (int i
= 0; i
< levels
.length
; i
++) {
495 if (levels
[i
] != TraceLogLevel
.LEVEL_UNKNOWN
) {
496 levelNames
[k
++] = levels
[i
].getInName();
500 fLogLevelCombo
= new CCombo(logLevelGroup
, SWT
.READ_ONLY
);
501 fLogLevelCombo
.setItems(levelNames
);
502 fLogLevelCombo
.setToolTipText(Messages
.TraceControl_EnableEventsLogLevelTooltip
);
503 data
= new GridData(GridData
.FILL_HORIZONTAL
);
504 data
.horizontalSpan
= 4;
505 fLogLevelCombo
.setLayoutData(data
);
507 fLogLevelButton
= new Button(logLevelGroup
, SWT
.RADIO
);
508 fLogLevelButton
.setText(Messages
.TraceControl_EnableEventsLogLevelTypeName
);
509 fLogLevelButton
.setToolTipText(Messages
.TraceControl_EnableEventsLogLevelTypeTooltip
);
510 data
= new GridData(GridData
.FILL_BOTH
);
511 fLogLevelButton
.setLayoutData(data
);
513 fLogLevelOnlyButton
= new Button(logLevelGroup
, SWT
.RADIO
);
514 fLogLevelOnlyButton
.setText(Messages
.TraceControl_EnableEventsLogLevelOnlyTypeName
);
515 fLogLevelOnlyButton
.setToolTipText(Messages
.TraceControl_EnableEventsLogLevelOnlyTypeTooltip
);
516 data
= new GridData(GridData
.FILL_BOTH
);
517 fLogLevelButton
.setLayoutData(data
);
521 * Enable/selects widgets depending on the group specified.
522 * @param group - group to enable.
524 private void setEnablements(GroupEnum group
) {
526 // Enable/disable trace point items
527 fTracepointsActivateButton
.setSelection(group
== GroupEnum
.TRACEPOINTS
);
528 fTracepointsViewer
.getTree().setEnabled(group
== GroupEnum
.TRACEPOINTS
);
530 // Enable/disable wildcard items
531 fWildcardActivateButton
.setSelection(group
== GroupEnum
.WILDCARD
);
532 fWildcardText
.setEnabled(group
== GroupEnum
.WILDCARD
);
534 // Enable/disable log level items
535 fLogLevelActivateButton
.setSelection(group
== GroupEnum
.LOGLEVEL
);
536 fLogLevelEventNameText
.setEnabled(group
== GroupEnum
.LOGLEVEL
);
537 fLogLevelCombo
.setEnabled(group
== GroupEnum
.LOGLEVEL
);
538 fLogLevelButton
.setEnabled(group
== GroupEnum
.LOGLEVEL
);
539 fLogLevelOnlyButton
.setEnabled(group
== GroupEnum
.LOGLEVEL
);
542 // ------------------------------------------------------------------------
544 // ------------------------------------------------------------------------
546 * Content provider for the tracepoints tree.
548 final static public class UstContentProvider
extends TraceControlContentProvider
{
550 public Object
[] getChildren(Object parentElement
) {
551 if (parentElement
instanceof TargetNodeComponent
) {
552 List
<ITraceControlComponent
> children
= ((ITraceControlComponent
)parentElement
).getChildren(TraceProviderGroup
.class);
553 return (ITraceControlComponent
[]) children
.toArray(new ITraceControlComponent
[children
.size()]);
555 if (parentElement
instanceof TraceProviderGroup
) {
556 List
<ITraceControlComponent
> children
= ((ITraceControlComponent
)parentElement
).getChildren(UstProviderComponent
.class);
557 return (ITraceControlComponent
[]) children
.toArray(new ITraceControlComponent
[children
.size()]);
559 if (parentElement
instanceof ITraceControlComponent
) {
560 return ((ITraceControlComponent
)parentElement
).getChildren();
562 return new Object
[0];
567 * Content label for the tracepoints tree.
569 final static public class UstLabelProvider
extends TraceControlLabelProvider
{
571 public Image
getImage(Object element
) {
575 public String
getText(Object element
) {
576 if ((element
!= null) && (element
instanceof TraceProviderGroup
)) {
577 return Messages
.TraceControl_EnableEventsTracepointTreeAllLabel
;
580 if ((element
!= null) && (element
instanceof UstProviderComponent
)) {
581 return Messages
.TraceControl_EnableEventsTracepointTreeAllLabel
+ " - " + ((UstProviderComponent
)element
).getName(); //$NON-NLS-1$
583 return super.getText(element
);
588 * Check state listener for the tracepoints tree.
590 final public class UstCheckStateListener
implements ICheckStateListener
{
592 public void checkStateChanged(CheckStateChangedEvent event
) {
593 if (event
.getChecked()) {
594 if (event
.getElement() instanceof TraceProviderGroup
) {
595 fTracepointsViewer
.setSubtreeChecked(event
.getElement(), true);
597 if (event
.getElement() instanceof UstProviderComponent
) {
598 fTracepointsViewer
.setSubtreeChecked(event
.getElement(), true);
601 if (event
.getElement() instanceof TraceProviderGroup
) {
602 fTracepointsViewer
.setSubtreeChecked(event
.getElement(), true);
604 if (event
.getElement() instanceof UstProviderComponent
) {
605 ITraceControlComponent component
= (ITraceControlComponent
) event
.getElement();
606 fTracepointsViewer
.setSubtreeChecked(event
.getElement(), false);
607 fTracepointsViewer
.setChecked(component
.getParent(), false);
609 ITraceControlComponent component
= (ITraceControlComponent
) event
.getElement();
610 fTracepointsViewer
.setChecked(component
.getParent(), false);
611 fTracepointsViewer
.setChecked(component
.getParent().getParent(), false);