+++ /dev/null
-/** @file\r
- \r
- The file is used to create, update Variables 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
-\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.Variables.VariablesIdentification;\r
-import org.tianocore.frameworkwizard.packaging.PackageIdentification;\r
-import org.tianocore.frameworkwizard.workspace.WorkspaceTools;\r
-\r
-/**\r
- * The class is used to create, update Variables section of the MSA file\r
- * \r
- * It extends IDialog\r
- * \r
- */\r
-public class VariablesDlg extends IDialog {\r
-\r
- // /\r
- // / Define class Serial Version UID\r
- // /\r
- private static final long serialVersionUID = -6998982978030439446L;\r
-\r
- //\r
- // Define class members\r
- //\r
- private JPanel jContentPane = null;\r
-\r
- private JLabel jLabelVariableName = null;\r
-\r
- private JTextField jTextFieldVariableName = null;\r
-\r
- private JLabel jLabelUsage = null;\r
-\r
- private JComboBox jComboBoxUsage = null;\r
-\r
- private StarLabel jStarLabel1 = null;\r
-\r
- private StarLabel jStarLabel2 = null;\r
-\r
- private StarLabel jStarLabel3 = null;\r
-\r
- private JScrollPane jScrollPane = null;\r
-\r
- private JLabel jLabelGuidCName = null;\r
-\r
- private JComboBox jComboBoxGuidC_Name = null;\r
-\r
- private JTextField jTextFieldFeatureFlag = null;\r
-\r
- private JLabel jLabelFeatureFlag = null;\r
-\r
- private JLabel jLabelArch = 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 VariablesIdentification id = null;\r
-\r
- private EnumerationData ed = new EnumerationData();\r
-\r
- private WorkspaceTools wt = new WorkspaceTools();\r
-\r
- /**\r
- * This method initializes jTextFieldString\r
- * \r
- * @return javax.swing.JTextField jTextFieldString\r
- * \r
- */\r
- private JTextField getJTextFieldString() {\r
- if (jTextFieldVariableName == null) {\r
- jTextFieldVariableName = new JTextField();\r
- jTextFieldVariableName.setSize(new java.awt.Dimension(320, 20));\r
- jTextFieldVariableName.setPreferredSize(new java.awt.Dimension(320, 20));\r
- jTextFieldVariableName.setLocation(new java.awt.Point(168, 12));\r
- jTextFieldVariableName.setToolTipText("Enter a string; the tool will convert to Unicode hex");\r
- }\r
- return jTextFieldVariableName;\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>The module requires the variable entry to be set</td></tr>"\r
- + "<tr><td>SOMETIMES_CONSUMED</td><td>The module will use the variable entry if it is set.</td></tr>"\r
- + "<tr><td>ALWAYS_PRODUCED</td><td>The module will always write the variable.</td></tr>"\r
- + "<tr><td>SOMETIMES_PRODUCED</td><td>The module will sometimes write the variable.</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 jTextFieldFeatureFlag\r
- * \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
- jTextAreaHelpText.setToolTipText("Enter information on how to use this Variable.");\r
- }\r
- return jTextAreaHelpText;\r
- }\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 jComboBoxGuidC_Name\r
- * \r
- * @return javax.swing.JComboBox jComboBoxGuidC_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, 37, 320, 20));\r
- jComboBoxGuidC_Name.setPreferredSize(new java.awt.Dimension(320, 20));\r
- jComboBoxGuidC_Name.setToolTipText("Select the GUID C Name of the Variable.");\r
- }\r
- return jComboBoxGuidC_Name;\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("Variables");\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 inVariablesId\r
- * \r
- */\r
- private void init(VariablesIdentification inVariablesId, ModuleIdentification mid) {\r
- init();\r
- this.id = inVariablesId;\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 variable");\r
- }\r
- //\r
- // Init guids drop down list\r
- //\r
- Tools\r
- .generateComboBoxByVector(jComboBoxGuidC_Name,\r
- wt.getAllGuidDeclarationsFromPackages(vpid, EnumerationData.GUID_TYPE_EFI_VARIABLE));\r
-\r
- if (this.id != null) {\r
- this.jTextFieldVariableName.setText(id.getName());\r
- this.jComboBoxGuidC_Name.setSelectedItem(id.getGuid());\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 inVariablesIdentification\r
- * @param iFrame\r
- * \r
- */\r
- public VariablesDlg(VariablesIdentification inVariablesIdentification, IFrame iFrame, ModuleIdentification mid) {\r
- super(iFrame, true);\r
- init(inVariablesIdentification, 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.jTextFieldVariableName.setEnabled(!isView);\r
- this.jComboBoxUsage.setEnabled(!isView);\r
- }\r
- }\r
-\r
- /**\r
- * This method initializes jContentPane\r
- * \r
- * @return javax.swing.JPanel jContentPane\r
- * \r
- */\r
- private JPanel getJContentPane() {\r
- if (jContentPane == null) {\r
- jStarLabel1 = new StarLabel();\r
- jStarLabel1.setLocation(new java.awt.Point(2, 12));\r
- jLabelVariableName = new JLabel();\r
- jLabelVariableName.setText("Variable Name");\r
- jLabelVariableName.setBounds(new java.awt.Rectangle(12, 12, 168, 20));\r
-\r
- jStarLabel2 = new StarLabel();\r
- jStarLabel2.setLocation(new java.awt.Point(2, 37));\r
- jLabelGuidCName = new JLabel();\r
- jLabelGuidCName.setBounds(new java.awt.Rectangle(12, 37, 168, 20));\r
- jLabelGuidCName.setText("Variable Guid C Name");\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, 168, 20));\r
-\r
- jLabelHelpText = new JLabel();\r
- jLabelHelpText.setBounds(new java.awt.Rectangle(12, 87, 168, 20));\r
- jLabelHelpText.setText("Help Text");\r
-\r
- jLabelFeatureFlag = new JLabel();\r
- jLabelFeatureFlag.setText("Feature Flag Expression");\r
- jLabelFeatureFlag.setBounds(new java.awt.Rectangle(12, 157, 168, 20));\r
- jLabelFeatureFlag.setEnabled(false);\r
-\r
- jLabelArch = new JLabel();\r
- jLabelArch.setBounds(new java.awt.Rectangle(12, 132, 168, 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(jLabelVariableName, null);\r
- jContentPane.add(getJTextFieldString(), null);\r
- jContentPane.add(jStarLabel2, null);\r
- jContentPane.add(jLabelGuidCName, null);\r
- jContentPane.add(getJComboBoxGuidC_Name(), 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
- * (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
- getCurrentVariables();\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
- * This method initializes Usage type\r
- * \r
- */\r
- private void initFrame() {\r
- Tools.generateComboBoxByVector(jComboBoxUsage, ed.getVPpiUsage());\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 VariableName\r
- //\r
- if (isEmpty(this.jTextFieldVariableName.getText())) {\r
- Log.wrn("Update Variables", "Variable Name must be entered!");\r
- return false;\r
- }\r
- \r
- //\r
- // Check Guid Value\r
- //\r
- if (this.jComboBoxGuidC_Name.getSelectedItem() == null) {\r
- Log.wrn("Update Guids", "Please select one Varibale Guid value");\r
- return false;\r
- }\r
-\r
- //\r
- // Check FeatureFlag\r
- //\r
- if (!isEmpty(this.jTextFieldFeatureFlag.getText())) {\r
- if (!DataValidation.isFeatureFlag(this.jTextFieldFeatureFlag.getText())) {\r
- Log.wrn("Update Variables", "Incorrect data type for Feature Flag");\r
- return false;\r
- }\r
- }\r
-\r
- return true;\r
- }\r
-\r
- private VariablesIdentification getCurrentVariables() {\r
- String arg0 = this.jTextFieldVariableName.getText();\r
- String arg1 = this.jComboBoxGuidC_Name.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
-\r
- id = new VariablesIdentification(arg0, arg1, arg2, arg3, arg4, arg5);\r
- return id;\r
- }\r
-\r
- public VariablesIdentification getId() {\r
- return id;\r
- }\r
-\r
- public void setId(VariablesIdentification id) {\r
- this.id = id;\r
- }\r
-}\r
projects / mirror_edk2.git / blobdiff