--- /dev/null
+/** @file\r
+ \r
+ The file is used to create, update Hob section of the MSA file\r
+ \r
+ Copyright (c) 2006, Intel Corporation\r
+ All rights reserved. This program and the accompanying materials\r
+ are licensed and made available under the terms and conditions of the BSD License\r
+ which accompanies this distribution. The full text of the license may be found at\r
+ http://opensource.org/licenses/bsd-license.php\r
+ \r
+ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+ \r
+ **/\r
+package org.tianocore.frameworkwizard.module.ui.dialog;\r
+\r
+import java.awt.event.ActionEvent;\r
+import java.util.Vector;\r
+\r
+import javax.swing.JButton;\r
+import javax.swing.JComboBox;\r
+import javax.swing.JLabel;\r
+import javax.swing.JPanel;\r
+import javax.swing.JScrollPane;\r
+import javax.swing.JTextField;\r
+import javax.swing.JTextArea;\r
+\r
+import org.tianocore.frameworkwizard.common.DataType;\r
+import org.tianocore.frameworkwizard.common.DataValidation;\r
+import org.tianocore.frameworkwizard.common.EnumerationData;\r
+import org.tianocore.frameworkwizard.common.Log;\r
+import org.tianocore.frameworkwizard.common.Tools;\r
+import org.tianocore.frameworkwizard.common.ui.ArchCheckBox;\r
+import org.tianocore.frameworkwizard.common.ui.IDialog;\r
+import org.tianocore.frameworkwizard.common.ui.IFrame;\r
+import org.tianocore.frameworkwizard.common.ui.StarLabel;\r
+import org.tianocore.frameworkwizard.module.Identifications.ModuleIdentification;\r
+import org.tianocore.frameworkwizard.module.Identifications.Hobs.HobsIdentification;\r
+import org.tianocore.frameworkwizard.packaging.PackageIdentification;\r
+import org.tianocore.frameworkwizard.workspace.WorkspaceTools;\r
+\r
+/**\r
+ * The class is used to create, update Hob of the MSA file \r
+ * \r
+ * It extends IDialog\r
+ * \r
+ */\r
+public class HobsDlg extends IDialog {\r
+\r
+ // /\r
+ // / Define class Serial Version UID\r
+ // /\r
+ private static final long serialVersionUID = -553473437579358325L;\r
+\r
+ //\r
+ // Define class members\r
+ //\r
+ private JPanel jContentPane = null;\r
+\r
+ private JLabel jLabelC_Name = null;\r
+\r
+ private JComboBox jComboBoxGuidC_Name = null;\r
+\r
+ private JLabel jLabelUsage = null;\r
+\r
+ private JLabel jLabelHobType = null;\r
+\r
+ private JComboBox jComboBoxUsage = null;\r
+\r
+ private JComboBox jComboBoxHobType = null;\r
+\r
+ private StarLabel jStarLabel1 = null;\r
+\r
+ private StarLabel jStarLabel2 = null;\r
+\r
+ private StarLabel jStarLabel3 = null;\r
+\r
+ private JLabel jLabelArch = null;\r
+\r
+ private JScrollPane jScrollPane = null;\r
+\r
+ private JLabel jLabelFeatureFlag = null;\r
+\r
+ private JTextField jTextFieldFeatureFlag = null;\r
+\r
+ private JLabel jLabelHelpText = null;\r
+\r
+ private JTextArea jTextAreaHelpText = null;\r
+\r
+ private JScrollPane jScrollPaneHelpText = null;\r
+\r
+ private ArchCheckBox jArchCheckBox = null;\r
+\r
+ private JButton jButtonOk = null;\r
+\r
+ private JButton jButtonCancel = null;\r
+\r
+ //\r
+ // Not used by UI\r
+ //\r
+ private HobsIdentification id = null;\r
+\r
+ private EnumerationData ed = new EnumerationData();\r
+\r
+ private WorkspaceTools wt = new WorkspaceTools();\r
+\r
+ /**\r
+ * This method initializes jTextField\r
+ * \r
+ * @return javax.swing.JTextField jTextFieldC_Name\r
+ * \r
+ */\r
+ private JComboBox getJComboBoxGuidC_Name() {\r
+ if (jComboBoxGuidC_Name == null) {\r
+ jComboBoxGuidC_Name = new JComboBox();\r
+ jComboBoxGuidC_Name.setBounds(new java.awt.Rectangle(168, 12, 320, 20));\r
+ jComboBoxGuidC_Name.setPreferredSize(new java.awt.Dimension(320, 20));\r
+ jComboBoxGuidC_Name.setToolTipText("Select the GUID C Name of the Hob");\r
+ }\r
+ return jComboBoxGuidC_Name;\r
+ }\r
+\r
+ /**\r
+ * This method initializes jComboBoxHobType\r
+ * \r
+ * @return javax.swing.JComboBox jComboBoxHobType\r
+ * \r
+ */\r
+ private JComboBox getJComboBoxHobType() {\r
+ if (jComboBoxHobType == null) {\r
+ jComboBoxHobType = new JComboBox();\r
+ jComboBoxHobType.setBounds(new java.awt.Rectangle(168, 37, 320, 20));\r
+ jComboBoxHobType.setPreferredSize(new java.awt.Dimension(320, 20));\r
+ jComboBoxHobType\r
+ .setToolTipText("<html><table>"\r
+ + "<tr><td>PHIT</td><td>EFI_HOB_TYPE_HANDOFF</td></tr>"\r
+ + "<tr><td>MEMORY_ALLOCATION</td><td>EFI_HOB_TYPE_MEMORY_ALLOCATION and $BaseName</td></tr>"\r
+ + "<tr><td>RESOURCE_DESCRIPTOR</td><td>EFI_HOB_TYPE_RESOURCE_DESCRIPTOR</td></tr>"\r
+ + "<tr><td>GUID_EXTENTION</td><td>EFI_HOB_TYPE_GUID_EXTENSION and BaseName of GUID</td></tr>"\r
+ + "<tr><td>FIRMWARE_VOLUME</td><td>EFI_HOB_TYPE_FV</td></tr>"\r
+ + "<tr><td>CPU</td><td>EFI_HOB_TYPE_CPU</td></tr>"\r
+ + "<tr><td>POOL</td><td>EFI_HOB_TYPE_PEI_MEMORY_POOL</td></tr>"\r
+ + "<tr><td>CAPSULE_VOLUME</td><td>EFI_HOB_TYPE_CV</td></tr>"\r
+ + "</table></html>");\r
+ }\r
+ return jComboBoxHobType;\r
+ }\r
+\r
+ /**\r
+ * This method initializes jComboBoxUsage\r
+ * \r
+ * @return javax.swing.JComboBox jComboBoxUsage\r
+ * \r
+ */\r
+ private JComboBox getJComboBoxUsage() {\r
+ if (jComboBoxUsage == null) {\r
+ jComboBoxUsage = new JComboBox();\r
+ jComboBoxUsage.setBounds(new java.awt.Rectangle(168, 62, 320, 20));\r
+ jComboBoxUsage.setPreferredSize(new java.awt.Dimension(320, 20));\r
+ jComboBoxUsage\r
+ .setToolTipText("<html><table>"\r
+ + "<tr><td>ALWAYS_CONSUMED</td><td>HOB must be present in the system</td></tr>"\r
+ + "<tr><td>SOMETIMES_CONSUMED</td><td>HOB will be used if it's present</td></tr>"\r
+ + "<tr><td>ALWAYS_PRODUCED</td><td>HOB is always produced</td></tr>"\r
+ + "<tr><td>SOMETIMES_PRODUCED</td><td>HOB will sometimes be produced by the module</td></tr>"\r
+ + "</table></html>");\r
+ }\r
+ return jComboBoxUsage;\r
+ }\r
+\r
+ /**\r
+ * This method initializes jScrollPane\r
+ * \r
+ * @return javax.swing.JScrollPane\r
+ */\r
+ private JScrollPane getJScrollPane() {\r
+ if (jScrollPane == null) {\r
+ jScrollPane = new JScrollPane();\r
+ jScrollPane.setViewportView(getJContentPane());\r
+ }\r
+ return jScrollPane;\r
+ }\r
+\r
+ /**\r
+ * This method initializes jTextFieldFeatureFlag\r
+ * \r
+ * @return javax.swing.JTextField\r
+ */\r
+ private JTextField getJTextFieldFeatureFlag() {\r
+ if (jTextFieldFeatureFlag == null) {\r
+ jTextFieldFeatureFlag = new JTextField();\r
+ jTextFieldFeatureFlag.setBounds(new java.awt.Rectangle(168, 157, 320, 20));\r
+ jTextFieldFeatureFlag.setPreferredSize(new java.awt.Dimension(320, 20));\r
+ jTextFieldFeatureFlag.setToolTipText("Postfix expression that must evaluate to TRUE or FALSE");\r
+ jTextFieldFeatureFlag.setEnabled(false);\r
+ }\r
+ return jTextFieldFeatureFlag;\r
+ }\r
+\r
+ /**\r
+ * This method initializes jTextFieldHelpText\r
+ * \r
+ * @return javax.swing.JTextField\r
+ * \r
+ */\r
+ private JTextArea getJTextAreaHelpText() {\r
+ if (jTextAreaHelpText == null) {\r
+ jTextAreaHelpText = new JTextArea();\r
+ jTextAreaHelpText.setLineWrap(true);\r
+ jTextAreaHelpText.setWrapStyleWord(true);\r
+ }\r
+ return jTextAreaHelpText;\r
+ }\r
+\r
+ /**\r
+ * This method initializes jScrollPaneHelpText\r
+ * \r
+ * @return javax.swing.JScrollPane\r
+ */\r
+ private JScrollPane getJScrollPaneHelpText() {\r
+ if (jScrollPaneHelpText == null) {\r
+ jScrollPaneHelpText = new JScrollPane();\r
+ jScrollPaneHelpText.setHorizontalScrollBarPolicy(javax.swing.JScrollPane.HORIZONTAL_SCROLLBAR_NEVER);\r
+ jScrollPaneHelpText.setSize(new java.awt.Dimension(320, 40));\r
+ jScrollPaneHelpText.setPreferredSize(new java.awt.Dimension(320, 40));\r
+ jScrollPaneHelpText.setLocation(new java.awt.Point(168, 87));\r
+ jScrollPaneHelpText.setViewportView(getJTextAreaHelpText());\r
+ }\r
+ return jScrollPaneHelpText;\r
+ }\r
+\r
+ /**\r
+ * This method initializes jButtonOk\r
+ * \r
+ * @return javax.swing.JButton\r
+ * \r
+ */\r
+ private JButton getJButtonOk() {\r
+ if (jButtonOk == null) {\r
+ jButtonOk = new JButton();\r
+ jButtonOk.setBounds(new java.awt.Rectangle(290, 187, 90, 20));\r
+ jButtonOk.setText("Ok");\r
+ jButtonOk.addActionListener(this);\r
+ }\r
+ return jButtonOk;\r
+ }\r
+\r
+ /**\r
+ * This method initializes jButtonCancel\r
+ * \r
+ * @return javax.swing.JButton\r
+ * \r
+ */\r
+ private JButton getJButtonCancel() {\r
+ if (jButtonCancel == null) {\r
+ jButtonCancel = new JButton();\r
+ jButtonCancel.setBounds(new java.awt.Rectangle(390, 187, 90, 20));\r
+ jButtonCancel.setText("Cancel");\r
+ jButtonCancel.addActionListener(this);\r
+ }\r
+ return jButtonCancel;\r
+ }\r
+\r
+ public static void main(String[] args) {\r
+\r
+ }\r
+\r
+ /**\r
+ * This method initializes this\r
+ * \r
+ */\r
+ private void init() {\r
+ this.setSize(505, 260);\r
+ this.setContentPane(getJScrollPane());\r
+ this.setTitle("Hobs");\r
+ initFrame();\r
+ this.setViewMode(false);\r
+ this.centerWindow();\r
+ }\r
+\r
+ /**\r
+ * This method initializes this Fill values to all fields if these values are\r
+ * not empty\r
+ * \r
+ * @param inHobsId\r
+ * \r
+ */\r
+ private void init(HobsIdentification inHobsId, ModuleIdentification mid) {\r
+ init();\r
+ this.id = inHobsId;\r
+ \r
+ //\r
+ // Init arch with module's arch\r
+ //\r
+ this.jArchCheckBox.setEnabledItems(wt.getModuleArch(mid));\r
+ \r
+ //\r
+ // Get defined guids from dependent packages\r
+ //\r
+ Vector<PackageIdentification> vpid = wt.getPackageDependenciesOfModule(mid);\r
+ if (vpid.size() <= 0) {\r
+ Log\r
+ .wrn("Init Guid",\r
+ "This module hasn't defined any package dependency, so there is no guid value can be added for hob");\r
+ }\r
+ //\r
+ // Init guids drop down list\r
+ //\r
+ Tools\r
+ .generateComboBoxByVector(jComboBoxGuidC_Name,\r
+ wt.getAllGuidDeclarationsFromPackages(vpid, EnumerationData.GUID_TYPE_HOB));\r
+\r
+\r
+ if (this.id != null) {\r
+ this.jComboBoxGuidC_Name.setSelectedItem(id.getName());\r
+ this.jComboBoxHobType.setSelectedItem(id.getType());\r
+ this.jComboBoxUsage.setSelectedItem(id.getUsage());\r
+ this.jTextAreaHelpText.setText(id.getHelp());\r
+ this.jTextFieldFeatureFlag.setText(id.getFeatureFlag());\r
+ this.jArchCheckBox.setSelectedItems(id.getSupArchList());\r
+ }\r
+ }\r
+\r
+ /**\r
+ * This is the override edit constructor\r
+ * \r
+ * @param inHobsIdentification\r
+ * @param iFrame\r
+ * \r
+ */\r
+ public HobsDlg(HobsIdentification inHobsIdentification, IFrame iFrame, ModuleIdentification mid) {\r
+ super(iFrame, true);\r
+ init(inHobsIdentification, mid);\r
+ }\r
+\r
+ /**\r
+ * Disable all components when the mode is view\r
+ * \r
+ * @param isView\r
+ * true - The view mode; false - The non-view mode\r
+ * \r
+ */\r
+ public void setViewMode(boolean isView) {\r
+ if (isView) {\r
+ this.jComboBoxGuidC_Name.setEnabled(!isView);\r
+ this.jComboBoxUsage.setEnabled(!isView);\r
+ this.jComboBoxHobType.setEnabled(!isView);\r
+ }\r
+ }\r
+\r
+ /**\r
+ * This method initializes jContentPane\r
+ * \r
+ * @return javax.swing.JPanel jContentPane\r
+ * \r
+ */\r
+ public JPanel getJContentPane() {\r
+ if (jContentPane == null) {\r
+ jStarLabel1 = new StarLabel();\r
+ jStarLabel1.setLocation(new java.awt.Point(2, 12));\r
+ jLabelC_Name = new JLabel();\r
+ jLabelC_Name.setText("Hob's Guid C Name");\r
+ jLabelC_Name.setBounds(new java.awt.Rectangle(12, 12, 155, 20));\r
+\r
+ jStarLabel2 = new StarLabel();\r
+ jStarLabel2.setLocation(new java.awt.Point(2, 37));\r
+ jLabelHobType = new JLabel();\r
+ jLabelHobType.setText("Hob Type");\r
+ jLabelHobType.setBounds(new java.awt.Rectangle(12, 37, 155, 20));\r
+\r
+ jStarLabel3 = new StarLabel();\r
+ jStarLabel3.setLocation(new java.awt.Point(2, 62));\r
+ jLabelUsage = new JLabel();\r
+ jLabelUsage.setText("Usage");\r
+ jLabelUsage.setBounds(new java.awt.Rectangle(12, 62, 155, 20));\r
+\r
+ jLabelHelpText = new JLabel();\r
+ jLabelHelpText.setBounds(new java.awt.Rectangle(12, 87, 155, 20));\r
+ jLabelHelpText.setText("Help Text");\r
+\r
+ jLabelFeatureFlag = new JLabel();\r
+ jLabelFeatureFlag.setBounds(new java.awt.Rectangle(12, 157, 155, 20));\r
+ jLabelFeatureFlag.setText("Feature Flag Expression");\r
+ jLabelFeatureFlag.setEnabled(false);\r
+\r
+ jLabelArch = new JLabel();\r
+ jLabelArch.setBounds(new java.awt.Rectangle(12, 132, 155, 20));\r
+ jLabelArch.setText("Supported Architectures");\r
+ jArchCheckBox = new ArchCheckBox();\r
+ jArchCheckBox.setBounds(new java.awt.Rectangle(168, 132, 320, 20));\r
+ jArchCheckBox.setPreferredSize(new java.awt.Dimension(320, 20));\r
+\r
+ jContentPane = new JPanel();\r
+ jContentPane.setLayout(null);\r
+ jContentPane.setPreferredSize(new java.awt.Dimension(485, 215));\r
+\r
+ jContentPane.add(jStarLabel1, null);\r
+ jContentPane.add(jLabelC_Name, null);\r
+ jContentPane.add(getJComboBoxGuidC_Name(), null);\r
+ jContentPane.add(jStarLabel2, null);\r
+ jContentPane.add(jLabelHobType, null);\r
+ jContentPane.add(getJComboBoxHobType(), null);\r
+ jContentPane.add(jStarLabel3, null);\r
+ jContentPane.add(jLabelUsage, null);\r
+ jContentPane.add(getJComboBoxUsage(), null);\r
+ jContentPane.add(jLabelHelpText, null);\r
+ jContentPane.add(getJScrollPaneHelpText(), null);\r
+ jContentPane.add(jLabelFeatureFlag, null);\r
+ jContentPane.add(getJTextFieldFeatureFlag(), null);\r
+ jContentPane.add(jLabelArch, null);\r
+ jContentPane.add(jArchCheckBox, null);\r
+ jContentPane.add(getJButtonOk(), null);\r
+ jContentPane.add(getJButtonCancel(), null);\r
+ }\r
+ return jContentPane;\r
+ }\r
+\r
+ /**\r
+ * This method initializes Usage type and Hob type\r
+ * \r
+ */\r
+ private void initFrame() {\r
+ Tools.generateComboBoxByVector(jComboBoxUsage, ed.getVHobUsage());\r
+ Tools.generateComboBoxByVector(jComboBoxHobType, ed.getVHobType());\r
+ }\r
+\r
+ /*\r
+ * (non-Javadoc)\r
+ * \r
+ * @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)\r
+ * \r
+ * Override actionPerformed to listen all actions\r
+ * \r
+ */\r
+ public void actionPerformed(ActionEvent arg0) {\r
+ if (arg0.getSource() == jButtonOk) {\r
+ if (checkAdd()) {\r
+ getCurrentHobs();\r
+ this.returnType = DataType.RETURN_TYPE_OK;\r
+ this.setVisible(false);\r
+ }\r
+ }\r
+\r
+ if (arg0.getSource() == jButtonCancel) {\r
+ this.returnType = DataType.RETURN_TYPE_CANCEL;\r
+ this.setVisible(false);\r
+ }\r
+ }\r
+\r
+ /**\r
+ * Data validation for all fields\r
+ * \r
+ * @retval true - All datas are valid\r
+ * @retval false - At least one data is invalid\r
+ * \r
+ */\r
+ public boolean checkAdd() {\r
+ //\r
+ // Check if all fields have correct data types\r
+ //\r
+ \r
+ //\r
+ // Check Name\r
+ //\r
+ if (this.jComboBoxGuidC_Name.getSelectedItem() == null) {\r
+ Log.wrn("Update Guids", "Please select one Hob Name");\r
+ return false;\r
+ }\r
+ //\r
+ // Check Name\r
+ //\r
+ if (isEmpty(this.jComboBoxGuidC_Name.getSelectedItem().toString())) {\r
+ Log.wrn("Update Hobs", "Hob Guid C Name must be entered!");\r
+ return false;\r
+ }\r
+\r
+ if (!isEmpty(this.jComboBoxGuidC_Name.getSelectedItem().toString())) {\r
+ if (!DataValidation.isC_NameType(this.jComboBoxGuidC_Name.getSelectedItem().toString())) {\r
+ Log.wrn("Update Hobs", "Incorrect data type for Hob Name");\r
+ return false;\r
+ }\r
+ }\r
+\r
+ //\r
+ // Check FeatureFlag\r
+ //\r
+ if (!isEmpty(this.jTextFieldFeatureFlag.getText())) {\r
+ if (!DataValidation.isFeatureFlag(this.jTextFieldFeatureFlag.getText())) {\r
+ Log.wrn("Update Hobs", "Incorrect data type for Feature Flag");\r
+ return false;\r
+ }\r
+ }\r
+\r
+ return true;\r
+ }\r
+\r
+ private HobsIdentification getCurrentHobs() {\r
+ String arg0 = this.jComboBoxGuidC_Name.getSelectedItem().toString();\r
+ String arg1 = this.jComboBoxHobType.getSelectedItem().toString();\r
+ String arg2 = this.jComboBoxUsage.getSelectedItem().toString();\r
+\r
+ String arg3 = this.jTextFieldFeatureFlag.getText();\r
+ Vector<String> arg4 = this.jArchCheckBox.getSelectedItemsVector();\r
+ String arg5 = this.jTextAreaHelpText.getText();\r
+ id = new HobsIdentification(arg0, arg1, arg2, arg3, arg4, arg5);\r
+ return id;\r
+ }\r
+\r
+ public HobsIdentification getId() {\r
+ return id;\r
+ }\r
+\r
+ public void setId(HobsIdentification id) {\r
+ this.id = id;\r
+ }\r
+}\r
projects / mirror_edk2.git / blobdiff