Improve SDK check error messages
cover Improve SDK check error messages
From: Timo Mueller <[email protected]>
Hi,
these are some minor changes to improve the display of the SDK check error messages on the property and preference pages.
The 'lifetime' of the error messages has been changed slightly. If an SDK check failed the error message will now only be shown until the user changes the settings (typing, selecting). If he does so a new message is shown asking him to revalidate changes by clicking apply again.
01..02: Refining error messages
03..05: Clear error message when user changes the settings
Best regards,
Timo
Timo Mueller (5):
plugins/sdk.ide: Rephrase error messages plugins/sdk.ide: Add new error message for unselected target arch plugins/sdk.ide: Fix setting layout of parent composite plugins/sdk.ide: Relay events from child widgets to the parent
composite
plugins/sdk.ide: Inform user that the settings have to revalidated
.../src/org/yocto/sdk/ide/YoctoProfileSetting.java | 1 - .../yocto/sdk/ide/YoctoProjectSpecificSetting.java | 1 - .../src/org/yocto/sdk/ide/YoctoSDKChecker.java | 6 ++++ .../org/yocto/sdk/ide/YoctoSDKMessages.properties | 7 ++-- .../src/org/yocto/sdk/ide/YoctoUISetting.java | 40 +++++++++++++++++++--- .../ide/preferences/YoctoSDKPreferencePage.java | 28 ++++++++++++++- .../preferences/YoctoSDKProjectPropertyPage.java | 32 ++++++++++++++++- 7 files changed, 104 insertions(+), 11 deletions(-)
Signature · 1 line
1.7.11.7
PATCH 1/5 plugins/sdk.ide: Rephrase error messages
From: Timo Mueller <[email protected]>
--- .../src/org/yocto/sdk/ide/YoctoSDKMessages.properties | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/YoctoSDKMessages.properties +2 -2
@@ -20,14 +20,14 @@ Poky.SDK.Target.Empty.Advice = You need specify Target Architecture before build Poky.Sysroot.Empty = Specified Sysroot Location is empty. Poky.Sysroot.Empty.Advice = You need specify Sysroot Location before building any project. Poky.Sysroot.Nonexist = Specified Sysroot Location does not exist. -Poky.Qemu.Kernel.Empty.Advice = You need specify a valid Sysroot Location before building any project. +Poky.Sysroot.Nonexist.Advice = You need specify a valid Sysroot Location before building any project. Poky.Qemu.Kernel.Empty = Specified QEMU kernel location is emtpy. Poky.Qemu.Kernel.Empty.Advice = You need specify QEMU kernel image file Location before building any project. Poky.Qemu.Kernel.Nonexist = Specified QEMU kernel image file does not exist. Poky.Qemu.Kernel.Empty.Advice = You need specify a valid QEMU kernel image file before building any project. Poky.ADT.Sysroot.Wrongversion = The ADT version you're using is too old. Poky.ADT.Sysroot.Wrongversion.Advice = OECORE related items are not found in environment setup files.\nPlease upgrade to our latest ADT Version! -Poky.Env.Script.Nonexist = Specified Build Tree Toolchain Root does not contain any toolchain yet. +Poky.Env.Script.Nonexist = Specified toolchain directory does not contain a toolchain generated with meta-ide-support. Poky.Env.Script.Nonexist.Advice = Please run "bitbake meta-ide-support" to build the toolchain. Poky.Toolchain.No.Sysroot = Specified Toolchain Root Location does not contain a sysroot directory. Poky.Toolchain.No.Sysroot.Advice = Please install a valid toolchain sysroot.
Signature · 1 line
1.7.11.7
PATCH 2/5 plugins/sdk.ide: Add new error message for unselected target arch
From: Timo Mueller <[email protected]>
If the toolchain location contains environment scripts but no target architecture is selected show an appropriate error message.
--- .../org.yocto.sdk.ide/src/org/yocto/sdk/ide/YoctoSDKChecker.java | 6 ++++++ .../src/org/yocto/sdk/ide/YoctoSDKMessages.properties | 2 ++ 2 files changed, 8 insertions(+)
plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/YoctoSDKChecker.java +6 -0
@@ -31,6 +31,8 @@ public class YoctoSDKChecker { "Poky.SDK.Location.Nonexist", true), SDK_TARGET_EMPTY( "Poky.SDK.Target.Empty", true), + SDK_NO_TARGET_SELECTED( + "Poky.SDK.No.Target.Selected", false), SYSROOT_EMPTY( "Poky.Sysroot.Empty", true), SYSROOT_NONEXIST(
@@ -130,6 +132,10 @@ public class YoctoSDKChecker { } } + if (elem.getStrTarget().isEmpty() && elem.getStrTargetsArray().length > 0) { + return SDKCheckResults.SDK_NO_TARGET_SELECTED; + } + if (elem.getIntTargetIndex() < 0 || elem.getStrTarget().isEmpty()) { //if this is poky tree mode, prompt user whether bitbake meta-ide-support is executed? if (elem.getEnumPokyMode() == YoctoUIElement.PokyMode.POKY_TREE_MODE)
plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/YoctoSDKMessages.properties +2 -0
@@ -17,6 +17,8 @@ Poky.SDK.Location.Nonexist = Specified SDK toolchain directory does not exist. Poky.SDK.Location.Nonexist.Advice = Please specify a valid toolchain directory. Poky.SDK.Target.Empty = Specified location does not contain environment script file. Poky.SDK.Target.Empty.Advice = You need specify Target Architecture before building any project. +Poky.SDK.No.Target.Selected = Target Architecture is not defined. +Poky.SDK.No.Target.Selected.Advice = Please choose a Target Architecture. Poky.Sysroot.Empty = Specified Sysroot Location is empty. Poky.Sysroot.Empty.Advice = You need specify Sysroot Location before building any project. Poky.Sysroot.Nonexist = Specified Sysroot Location does not exist.
Signature · 1 line
1.7.11.7
PATCH 3/5 plugins/sdk.ide: Fix setting layout of parent composite
From: Timo Mueller <[email protected]>
The layout of the parent composite is set in every yocto settings element. Depending on the order in which the elements are added to the composite this may lead to different layouts being used.
Layout of the composite is now set in the preference/property pages instead of setting this in every child component.
--- .../org.yocto.sdk.ide/src/org/yocto/sdk/ide/YoctoProfileSetting.java | 1 - .../src/org/yocto/sdk/ide/YoctoProjectSpecificSetting.java | 1 - plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/YoctoUISetting.java | 1 - .../src/org/yocto/sdk/ide/preferences/YoctoSDKPreferencePage.java | 2 ++ .../src/org/yocto/sdk/ide/preferences/YoctoSDKProjectPropertyPage.java | 2 ++ 5 files changed, 4 insertions(+), 3 deletions(-)
plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/YoctoProfileSetting.java +0 -1
@@ -60,7 +60,6 @@ public class YoctoProfileSetting { public void createComposite(Composite composite) { GridData gd = new GridData(SWT.FILL, SWT.CENTER, true, false); GridLayout layout = new GridLayout(2, false); - composite.setLayout(layout); Group storeYoctoConfigurationsGroup = new Group (composite, SWT.NONE); layout = new GridLayout(1, false);
plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/YoctoProjectSpecificSetting.java +0 -1
@@ -41,7 +41,6 @@ public class YoctoProjectSpecificSetting { public void createComposite(Composite composite) { GridData gd = new GridData(SWT.FILL, SWT.CENTER, true, false); GridLayout layout = new GridLayout(2, false); - composite.setLayout(layout); Group storeYoctoConfigurationsGroup = new Group (composite, SWT.NONE); layout = new GridLayout(2, false);
plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/YoctoUISetting.java +0 -1
@@ -184,7 +184,6 @@ public class YoctoUISetting { { GridData gd = new GridData(SWT.FILL, SWT.CENTER, true, false); GridLayout layout = new GridLayout(2, false); - composite.setLayout(layout); Group crossCompilerGroup= new Group(composite, SWT.NONE); layout= new GridLayout(2, false);
plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/preferences/YoctoSDKPreferencePage.java +2 -0
@@ -22,6 +22,7 @@ import org.eclipse.jface.dialogs.MessageDialog; import org.eclipse.jface.preference.IPreferenceStore; import org.eclipse.jface.preference.PreferencePage; import org.eclipse.swt.SWT; +import org.eclipse.swt.layout.GridLayout; import org.eclipse.swt.widgets.Composite; import org.eclipse.swt.widgets.Control; import org.eclipse.ui.IWorkbench;
@@ -76,6 +77,7 @@ public class YoctoSDKPreferencePage extends PreferencePage implements IWorkbench protected Control createContents(Composite parent) { initializeDialogUnits(parent); final Composite composite= new Composite(parent, SWT.NONE); + composite.setLayout(new GridLayout(2, false)); yoctoProfileSetting.createComposite(composite); yoctoUISetting.createComposite(composite);
plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/preferences/YoctoSDKProjectPropertyPage.java +2 -0
@@ -16,6 +16,7 @@ import org.eclipse.core.resources.IProject; import org.eclipse.core.runtime.IAdaptable; import org.eclipse.jface.dialogs.Dialog; import org.eclipse.swt.SWT; +import org.eclipse.swt.layout.GridLayout; import org.eclipse.swt.widgets.Composite; import org.eclipse.swt.widgets.Control; import org.eclipse.ui.IWorkbenchPropertyPage;
@@ -64,6 +65,7 @@ public class YoctoSDKProjectPropertyPage extends PropertyPage implements initializeDialogUnits(parent); final Composite composite = new Composite(parent, SWT.NONE); + composite.setLayout(new GridLayout(2, false)); yoctoProfileSetting.createComposite(composite); yoctoProjectSpecificSetting.createComposite(composite);
Signature · 1 line
1.7.11.7
PATCH 4/5 plugins/sdk.ide: Relay events from child widgets to the parent composite
From: Timo Mueller <[email protected]>
If the content of the YoctoUISettings changes, because a contained widget reports a modify or selection event, an corresponding event is triggered on the parent composite. UI elements containing the YoctoUISettings can now register listeners and be notified when the content changes.
--- .../src/org/yocto/sdk/ide/YoctoUISetting.java | 38 +++++++++++++++++++--- 1 file changed, 34 insertions(+), 4 deletions(-)
plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/YoctoUISetting.java +34 -4
@@ -31,6 +31,7 @@ import org.eclipse.swt.widgets.Composite; import org.eclipse.swt.widgets.Control; import org.eclipse.swt.widgets.DirectoryDialog; import org.eclipse.swt.widgets.Display; +import org.eclipse.swt.widgets.Event; import org.eclipse.swt.widgets.FileDialog; import org.eclipse.swt.widgets.Group; import org.eclipse.swt.widgets.Label;
@@ -48,6 +49,8 @@ public class YoctoUISetting { private ModifyListener fModifyListener; private YoctoUIElement yoctoUIElement; + private Group crossCompilerGroup; + private Button btnSDKRoot; private Button btnQemu; private Button btnPokyRoot;
@@ -79,15 +82,43 @@ public class YoctoUISetting { public void widgetSelected(SelectionEvent e) { controlChanged(e.widget); + relayEvent(e); + } + + private void relayEvent(SelectionEvent e) { + Event event = new Event(); + event.data = e.data; + event.detail = e.detail; + event.display = e.display; + event.doit = e.doit; + event.height = e.height; + event.item = e.item; + event.stateMask = e.stateMask; + event.text = e.text; + event.time = e.time; + event.widget = e.widget; + event.width = e.width; + event.x = e.x; + event.y = e.y; + crossCompilerGroup.getParent().notifyListeners(SWT.Selection, event); } - }; + }; fModifyListener= new ModifyListener() { public void modifyText(ModifyEvent e) { controlModified(e.widget); + relayEvent(e); } - }; + private void relayEvent(ModifyEvent e) { + Event event = new Event(); + event.data = e.data; + event.display = e.display; + event.time = e.time; + event.widget = e.widget; + crossCompilerGroup.getParent().notifyListeners(SWT.Modify, event); + } + }; } private Control addControls(Control fControl, final String sKey, String sValue)
@@ -185,7 +216,7 @@ public class YoctoUISetting { GridData gd = new GridData(SWT.FILL, SWT.CENTER, true, false); GridLayout layout = new GridLayout(2, false); - Group crossCompilerGroup= new Group(composite, SWT.NONE); + crossCompilerGroup = new Group(composite, SWT.NONE); layout= new GridLayout(2, false); crossCompilerGroup.setLayout(layout); gd= new GridData(SWT.FILL, SWT.CENTER, true, false);
@@ -521,5 +552,4 @@ public class YoctoUISetting { } } - }
Signature · 1 line
1.7.11.7
PATCH 5/5 plugins/sdk.ide: Inform user that the settings have to revalidated
From: Timo Mueller <[email protected]>
If the last validation resulted in an error and the user made changes to the settings the error message is replaced by a message asking the user to revalidate.
--- .../org/yocto/sdk/ide/YoctoSDKMessages.properties | 1 + .../src/org/yocto/sdk/ide/YoctoUISetting.java | 1 + .../ide/preferences/YoctoSDKPreferencePage.java | 26 ++++++++++++++++++- .../preferences/YoctoSDKProjectPropertyPage.java | 30 +++++++++++++++++++++- 4 files changed, 56 insertions(+), 2 deletions(-)
plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/YoctoSDKMessages.properties +1 -0
@@ -37,6 +37,7 @@ Poky.Toolchain.Host.Mismatch = Toolchain and host arch mismatch. Poky.Toolchain.Host.Mismatch.Advice = Make sure you use 32bit toolchain for 32bit host and same for 64bit machines! Default.Advice = \nDo IDE-wide settings from Window > Preferences > Yocto Project ADT\nOr do Project-wide settings from Project > Change Yocto Project Settings. +Poky.SDK.Revalidation.Message = Please apply the changes to revalidate. Poky.SDK.Error.Origin.Wizard = Yocto Wizard Configuration Error: Poky.SDK.Error.Origin.Menu = Yocto Menu Configuration Error:
plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/YoctoUISetting.java +1 -0
@@ -300,6 +300,7 @@ public class YoctoUISetting { btnPokyRoot.addSelectionListener(fSelectionListener); btnQemu.addSelectionListener(fSelectionListener); btnDevice.addSelectionListener(fSelectionListener); + targetArchCombo.addSelectionListener(fSelectionListener); textRootLoc.addModifyListener(fModifyListener); textKernelLoc.addModifyListener(fModifyListener); textQemuOption.addModifyListener(fModifyListener);
plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/preferences/YoctoSDKPreferencePage.java +25 -1
@@ -25,6 +25,8 @@ import org.eclipse.swt.SWT; import org.eclipse.swt.layout.GridLayout; import org.eclipse.swt.widgets.Composite; import org.eclipse.swt.widgets.Control; +import org.eclipse.swt.widgets.Event; +import org.eclipse.swt.widgets.Listener; import org.eclipse.ui.IWorkbench; import org.eclipse.ui.IWorkbenchPreferencePage; import org.yocto.sdk.ide.YoctoProfileElement;
@@ -44,10 +46,13 @@ public class YoctoSDKPreferencePage extends PreferencePage implements IWorkbench private static final String NEW_DIALOG_MESSAGE = "Preferences.Profile.New.Dialog.Message"; private static final String UPDATE_DIALOG_TITLE = "Preferences.Profile.Update.Dialog.Title"; private static final String UPDATE_DIALOG_MESSAGE = "Preferences.Profile.Update.Dialog.Message"; + private static final String REVALIDATION_MESSAGE = "Poky.SDK.Revalidation.Message"; private YoctoProfileSetting yoctoProfileSetting; private YoctoUISetting yoctoUISetting; + private Listener changeListener; + public YoctoSDKPreferencePage() { //super(GRID); IPreferenceStore defaultStore = YoctoSDKPlugin.getDefault().getPreferenceStore();
@@ -66,6 +71,16 @@ public class YoctoSDKPreferencePage extends PreferencePage implements IWorkbench YoctoProfileElement profileElement = new YoctoProfileElement(profiles, selectedProfile); this.yoctoProfileSetting = new YoctoProfileSetting(profileElement, this, true); + + changeListener = new Listener() { + @Override + public void handleEvent(Event event) { + if (getErrorMessage() != null) { + setErrorMessage(null); + setMessage(YoctoSDKMessages.getString(REVALIDATION_MESSAGE), INFORMATION); + } + } + }; } /*
@@ -82,6 +97,9 @@ public class YoctoSDKPreferencePage extends PreferencePage implements IWorkbench yoctoProfileSetting.createComposite(composite); yoctoUISetting.createComposite(composite); + composite.addListener(SWT.Modify, changeListener); + composite.addListener(SWT.Selection, changeListener); + SDKCheckResults result = yoctoUISetting.validateInput(SDKCheckRequestFrom.Preferences, false); if (result != SDKCheckResults.SDK_PASS) { }
@@ -94,7 +112,7 @@ public class YoctoSDKPreferencePage extends PreferencePage implements IWorkbench * @see IPreferencePage#performOk() */ public boolean performOk() { - setErrorMessage(null); + clearMessages(); SDKCheckResults result = yoctoUISetting.validateInput(SDKCheckRequestFrom.Preferences, false); if (result != SDKCheckResults.SDK_PASS) {
@@ -130,6 +148,12 @@ public class YoctoSDKPreferencePage extends PreferencePage implements IWorkbench return super.performOk(); } + private void clearMessages() { + setErrorMessage(null); + setMessage(null); + setTitle(getTitle()); + } + /* * @see PreferencePage#performDefaults() */
plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/preferences/YoctoSDKProjectPropertyPage.java +29 -1
@@ -19,6 +19,8 @@ import org.eclipse.swt.SWT; import org.eclipse.swt.layout.GridLayout; import org.eclipse.swt.widgets.Composite; import org.eclipse.swt.widgets.Control; +import org.eclipse.swt.widgets.Event; +import org.eclipse.swt.widgets.Listener; import org.eclipse.ui.IWorkbenchPropertyPage; import org.eclipse.ui.dialogs.PropertyPage; import org.yocto.sdk.ide.YoctoProfileElement;
@@ -26,6 +28,7 @@ import org.yocto.sdk.ide.YoctoProfileSetting; import org.yocto.sdk.ide.YoctoProjectSpecificSetting; import org.yocto.sdk.ide.YoctoSDKChecker.SDKCheckRequestFrom; import org.yocto.sdk.ide.YoctoSDKChecker.SDKCheckResults; +import org.yocto.sdk.ide.YoctoSDKMessages; import org.yocto.sdk.ide.YoctoSDKPlugin; import org.yocto.sdk.ide.YoctoSDKUtils; import org.yocto.sdk.ide.YoctoUIElement;
@@ -34,11 +37,27 @@ import org.yocto.sdk.ide.YoctoUISetting; public class YoctoSDKProjectPropertyPage extends PropertyPage implements IWorkbenchPropertyPage { + private static final String REVALIDATION_MESSAGE = "Poky.SDK.Revalidation.Message"; + private YoctoProfileSetting yoctoProfileSetting; private YoctoProjectSpecificSetting yoctoProjectSpecificSetting; private YoctoUISetting yoctoUISetting; private IProject project = null; + private Listener changeListener; + + public YoctoSDKProjectPropertyPage() { + changeListener = new Listener() { + @Override + public void handleEvent(Event event) { + if (getErrorMessage() != null) { + setErrorMessage(null); + setMessage(YoctoSDKMessages.getString(REVALIDATION_MESSAGE), INFORMATION); + } + } + }; + } + @Override protected Control createContents(Composite parent) { IProject project = getProject();
@@ -86,6 +105,9 @@ public class YoctoSDKProjectPropertyPage extends PropertyPage implements yoctoUISetting.setUIFormEnabledState(false); } + composite.addListener(SWT.Modify, changeListener); + composite.addListener(SWT.Selection, changeListener); + Dialog.applyDialogFont(composite); return composite; }
@@ -120,7 +142,7 @@ public class YoctoSDKProjectPropertyPage extends PropertyPage implements */ @Override public boolean performOk() { - setErrorMessage(null); + clearMessages(); IProject project = getProject();
@@ -144,6 +166,12 @@ public class YoctoSDKProjectPropertyPage extends PropertyPage implements return super.performOk(); } + private void clearMessages() { + setErrorMessage(null); + setMessage(null); + setTitle(getTitle()); + } + public void switchProfile(String selectedProfile) { YoctoUIElement profileElement = YoctoSDKUtils.getElemFromStore(YoctoSDKPlugin.getProfilePreferenceStore(selectedProfile));
Signature · 1 line
1.7.11.7
Zhang, Jessica
AppliedMerged to eclipse-poky master.
Thanks,
Jessica
-----Original Message-----
From: [email protected] [mailto:[email protected]] On Behalf Of Timo Mueller
Sent: Tuesday, March 05, 2013 12:29 AM
To: [email protected]
Cc: Timo Mueller
Subject: [yocto] [PATCH 0/5][eclipse-poky] Improve SDK check error messages
From: Timo Mueller <[email protected]>
Hi,
these are some minor changes to improve the display of the SDK check error messages on the property and preference pages.
The 'lifetime' of the error messages has been changed slightly. If an SDK check failed the error message will now only be shown until the user changes the settings (typing, selecting). If he does so a new message is shown asking him to revalidate changes by clicking apply again.
01..02: Refining error messages
03..05: Clear error message when user changes the settings
Best regards,
Timo
Timo Mueller (5):
plugins/sdk.ide: Rephrase error messages plugins/sdk.ide: Add new error message for unselected target arch plugins/sdk.ide: Fix setting layout of parent composite plugins/sdk.ide: Relay events from child widgets to the parent
composite
plugins/sdk.ide: Inform user that the settings have to revalidated
.../src/org/yocto/sdk/ide/YoctoProfileSetting.java | 1 - .../yocto/sdk/ide/YoctoProjectSpecificSetting.java | 1 - .../src/org/yocto/sdk/ide/YoctoSDKChecker.java | 6 ++++ .../org/yocto/sdk/ide/YoctoSDKMessages.properties | 7 ++-- .../src/org/yocto/sdk/ide/YoctoUISetting.java | 40 +++++++++++++++++++--- .../ide/preferences/YoctoSDKPreferencePage.java | 28 ++++++++++++++- .../preferences/YoctoSDKProjectPropertyPage.java | 32 ++++++++++++++++- 7 files changed, 104 insertions(+), 11 deletions(-)
--
1.7.11.7
_______________________________________________
yocto mailing list
[email protected]
https://lists.yoctoproject.org/listinfo/yocto