+++ /dev/null
-/** @file\r
- \r
- The file is used to create, update PcdCode 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.awt.event.ItemEvent;\r
-import java.awt.event.ItemListener;\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.PcdCoded.PcdCodedIdentification;\r
-import org.tianocore.frameworkwizard.module.Identifications.PcdCoded.PcdVector;\r
-import org.tianocore.frameworkwizard.packaging.PackageIdentification;\r
-import org.tianocore.frameworkwizard.workspace.WorkspaceTools;\r
-\r
-/**\r
- * The class is used to create, update PcdCoded section of the MSA file\r
- * \r
- * It extends IDialog\r
- * \r
- */\r
-public class PCDsDlg extends IDialog implements ItemListener {\r
-\r
- // /\r
- // / Define class Serial Version UID\r
- // /\r
- private static final long serialVersionUID = 2227717658188438696L;\r
-\r
- //\r
- // Define class members\r
- //\r
- private JPanel jContentPane = null;\r
-\r
- private JLabel jLabelItemType = null;\r
-\r
- private JLabel jLabelC_Name = null;\r
-\r
- private JComboBox jComboBoxItemType = null;\r
-\r
- private JComboBox jComboBoxCName = null;\r
-\r
- private JLabel jLabelDefaultValue = null;\r
-\r
- private JTextField jTextFieldDefaultValue = null;\r
-\r
- private StarLabel jStarLabel1 = null;\r
-\r
- private StarLabel jStarLabel2 = null;\r
-\r
- private StarLabel jStarLabel3 = null;\r
-\r
- private JLabel jLabelHelpText = null;\r
-\r
- private JTextArea jTextAreaHelpText = null;\r
-\r
- private JScrollPane jScrollPane = null;\r
-\r
- private JLabel jLabelTokenSpaceGuid = null;\r
-\r
- private JTextField jTextFieldTokenSpaceGuid = null;\r
-\r
- private JLabel jLabelFeatureFlag = null;\r
-\r
- private JTextField jTextFieldFeatureFlag = null;\r
-\r
- private JLabel jLabelArch = null;\r
-\r
- private ArchCheckBox jArchCheckBox = null;\r
-\r
- private JButton jButtonOk = null;\r
-\r
- private JButton jButtonCancel = null;\r
-\r
- private JScrollPane jScrollPaneHelpText = null;\r
-\r
- private JLabel jLabelUsage = null;\r
-\r
- private JComboBox jComboBoxUsage = null;\r
-\r
- //\r
- // Not used by UI\r
- //\r
- private PcdCodedIdentification id = null;\r
-\r
- private EnumerationData ed = new EnumerationData();\r
-\r
- private WorkspaceTools wt = new WorkspaceTools();\r
-\r
- private PcdVector pcd = wt.getAllPcdDeclarationsFromWorkspace();\r
-\r
- /**\r
- * This method initializes jComboBoxItemType\r
- * \r
- * @return javax.swing.JComboBox jComboBoxItemType\r
- * \r
- */\r
- private JComboBox getJComboBoxItemType() {\r
- if (jComboBoxItemType == null) {\r
- jComboBoxItemType = new JComboBox();\r
- jComboBoxItemType.setBounds(new java.awt.Rectangle(168, 37, 320, 20));\r
- jComboBoxItemType.setPreferredSize(new java.awt.Dimension(320, 20));\r
- }\r
- return jComboBoxItemType;\r
- }\r
-\r
- /**\r
- * This method initializes jTextFieldC_Name\r
- * \r
- * @return javax.swing.JTextField jTextFieldC_Name\r
- * \r
- */\r
- private JComboBox getJComboBoxCName() {\r
- if (jComboBoxCName == null) {\r
- jComboBoxCName = new JComboBox();\r
- jComboBoxCName.setBounds(new java.awt.Rectangle(168, 12, 320, 20));\r
- jComboBoxCName.setPreferredSize(new java.awt.Dimension(320, 20));\r
- jComboBoxCName.addItemListener(this);\r
- }\r
- return jComboBoxCName;\r
- }\r
-\r
- /**\r
- * This method initializes jTextFieldDefaultValue\r
- * \r
- * @return javax.swing.JTextField jTextFieldDefaultValue\r
- * \r
- */\r
- private JTextField getJTextFieldDefaultValue() {\r
- if (jTextFieldDefaultValue == null) {\r
- jTextFieldDefaultValue = new JTextField();\r
- jTextFieldDefaultValue.setBounds(new java.awt.Rectangle(168, 62, 320, 20));\r
- jTextFieldDefaultValue.setPreferredSize(new java.awt.Dimension(320, 20));\r
- }\r
- return jTextFieldDefaultValue;\r
- }\r
-\r
- /**\r
- * This method initializes jTextAreaHelpText\r
- * \r
- * @return javax.swing.JTextArea\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
- */\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, 112));\r
- jScrollPaneHelpText.setViewportView(getJTextAreaHelpText());\r
- }\r
- return jScrollPaneHelpText;\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 jTextFieldTokenSpaceGuid\r
- * \r
- * @return javax.swing.JTextField\r
- */\r
- private JTextField getJTextFieldTokenSpaceGuid() {\r
- if (jTextFieldTokenSpaceGuid == null) {\r
- jTextFieldTokenSpaceGuid = new JTextField();\r
- jTextFieldTokenSpaceGuid.setBounds(new java.awt.Rectangle(168, 62, 320, 20));\r
- jTextFieldTokenSpaceGuid.setPreferredSize(new java.awt.Dimension(320, 20));\r
- jTextFieldTokenSpaceGuid.setVisible(false);\r
- }\r
- return jTextFieldTokenSpaceGuid;\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, 182, 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 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, 212, 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, 212, 90, 20));\r
- jButtonCancel.setText("Cancel");\r
- jButtonCancel.addActionListener(this);\r
- }\r
- return jButtonCancel;\r
- }\r
-\r
- /**\r
- * This method initializes jComboBoxUsage \r
- * \r
- * @return javax.swing.JComboBox \r
- */\r
- private JComboBox getJComboBoxUsage() {\r
- if (jComboBoxUsage == null) {\r
- jComboBoxUsage = new JComboBox();\r
- jComboBoxUsage.setBounds(new java.awt.Rectangle(168, 87, 320, 20));\r
- jComboBoxUsage.setPreferredSize(new java.awt.Dimension(320, 20));\r
- }\r
- return jComboBoxUsage;\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, 280);\r
- this.setContentPane(getJScrollPane());\r
- this.setTitle("Pcd Coded");\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 inPcdCodedId\r
- * \r
- */\r
- private void init(PcdCodedIdentification inPcdCodedId, ModuleIdentification mid) {\r
- init();\r
- this.id = inPcdCodedId;\r
- \r
- //\r
- // Init arch with module's arch\r
- //\r
- this.jArchCheckBox.setEnabledItems(wt.getModuleArch(mid));\r
- \r
- //\r
- // Get defined pcds from dependent packages\r
- //\r
- Vector<PackageIdentification> vpid = wt.getPackageDependenciesOfModule(mid);\r
- if (vpid.size() <= 0) {\r
- Log.wrn("Init Pcd", "This module hasn't defined any package dependency, so there is no pcd can be added");\r
- }\r
-\r
- pcd = wt.getAllPcdDeclarationsFromPackages(wt.getPackageDependenciesOfModule(mid));\r
- for (int index = 0; index < pcd.size(); index++) {\r
- jComboBoxCName.addItem(pcd.getPcd(index));\r
- }\r
-\r
- if (this.id != null) {\r
- for (int index = 0; index < this.jComboBoxCName.getItemCount(); index++) {\r
- if (this.jComboBoxCName.getItemAt(index).toString().equals(id.getName())) {\r
- this.jComboBoxCName.setSelectedIndex(index);\r
- break;\r
- }\r
- }\r
- this.jTextFieldTokenSpaceGuid.setText(id.getGuid());\r
- this.jTextFieldDefaultValue.setText(id.getValue());\r
- this.jComboBoxUsage.setSelectedItem(id.getUsage());\r
- this.jTextAreaHelpText.setText(id.getHelp());\r
- this.jComboBoxItemType.setSelectedItem(id.getType());\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 inPcdCodedId\r
- * @param iFrame\r
- * \r
- */\r
- public PCDsDlg(PcdCodedIdentification inPcdCodedId, IFrame iFrame, ModuleIdentification mid) {\r
- super(iFrame, true);\r
- init(inPcdCodedId, 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.jTextFieldDefaultValue.setEnabled(!isView);\r
- this.jComboBoxItemType.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
- jLabelUsage = new JLabel();\r
- jLabelUsage.setBounds(new java.awt.Rectangle(12, 87, 168, 20));\r
- jLabelUsage.setText("Usge");\r
- jStarLabel1 = new StarLabel();\r
- jStarLabel1.setLocation(new java.awt.Point(2, 12));\r
- jLabelC_Name = new JLabel();\r
- jLabelC_Name.setText("PCD C Name");\r
- jLabelC_Name.setBounds(new java.awt.Rectangle(12, 12, 168, 20));\r
-\r
- jStarLabel2 = new StarLabel();\r
- jStarLabel2.setLocation(new java.awt.Point(2, 37));\r
- jLabelItemType = new JLabel();\r
- jLabelItemType.setText("PCD Item Type");\r
- jLabelItemType.setBounds(new java.awt.Rectangle(12, 37, 168, 20));\r
-\r
- jLabelDefaultValue = new JLabel();\r
- jLabelDefaultValue.setText("Default Value");\r
- jLabelDefaultValue.setBounds(new java.awt.Rectangle(12, 62, 168, 20));\r
-\r
- jStarLabel3 = new StarLabel();\r
- jStarLabel3.setLocation(new java.awt.Point(2, 112));\r
- jLabelHelpText = new JLabel();\r
- jLabelHelpText.setText("Help Text");\r
- jLabelHelpText.setBounds(new java.awt.Rectangle(12, 112, 168, 20));\r
-\r
- jLabelFeatureFlag = new JLabel();\r
- jLabelFeatureFlag.setText("Feature Flag Expression");\r
- jLabelFeatureFlag.setBounds(new java.awt.Rectangle(12, 182, 168, 20));\r
- jLabelFeatureFlag.setEnabled(false);\r
-\r
- jLabelTokenSpaceGuid = new JLabel();\r
- jLabelTokenSpaceGuid.setText("Token Space C Name");\r
- jLabelTokenSpaceGuid.setVisible(false);\r
-\r
- jLabelArch = new JLabel();\r
- jLabelArch.setText("Supported Architectures");\r
- jLabelArch.setBounds(new java.awt.Rectangle(12, 157, 168, 20));\r
- jArchCheckBox = new ArchCheckBox();\r
- jArchCheckBox.setPreferredSize(new java.awt.Dimension(320, 20));\r
- jArchCheckBox.setBounds(new java.awt.Rectangle(168, 157, 320, 20));\r
-\r
- // Hidden field\r
- jLabelTokenSpaceGuid.setBounds(new java.awt.Rectangle(12, 62, 140, 20));\r
-\r
- jContentPane = new JPanel();\r
- jContentPane.setLayout(null);\r
- jContentPane.setPreferredSize(new java.awt.Dimension(485, 235));\r
-\r
- jContentPane.add(jStarLabel1, null);\r
- jContentPane.add(jLabelC_Name, null);\r
- jContentPane.add(getJComboBoxCName(), null);\r
- jContentPane.add(jStarLabel2, null);\r
- jContentPane.add(jLabelItemType, null);\r
- jContentPane.add(getJComboBoxItemType(), null);\r
- jContentPane.add(jLabelDefaultValue, null);\r
- jContentPane.add(getJTextFieldDefaultValue(), null);\r
- jContentPane.add(jStarLabel3, 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
- // Hidden\r
- jContentPane.add(getJTextFieldTokenSpaceGuid(), null);\r
- jContentPane.add(jLabelTokenSpaceGuid, null);\r
- jContentPane.add(getJButtonOk(), null);\r
- jContentPane.add(getJButtonCancel(), null);\r
- jContentPane.add(jLabelUsage, null);\r
- jContentPane.add(getJComboBoxUsage(), null);\r
- }\r
- return jContentPane;\r
- }\r
-\r
- /**\r
- * This method initializes Usage type, Item type and Datum type\r
- * \r
- */\r
- private void initFrame() {\r
- Tools.generateComboBoxByVector(jComboBoxUsage, ed.getVPcdUsage());\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
- getCurrentPcdCoded();\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 C_Name\r
- //\r
- if (this.jComboBoxCName.getSelectedItem() == null) {\r
- Log.wrn("Update Pcd", "Please select one Pcd Name");\r
- return false;\r
- }\r
-\r
- if (!isEmpty(this.jComboBoxCName.getSelectedItem().toString())) {\r
- if (!DataValidation.isC_NameType(this.jComboBoxCName.getSelectedItem().toString())) {\r
- Log.wrn("Update PcdCoded", "Incorrect data type for C Name");\r
- return false;\r
- }\r
- }\r
-\r
- //\r
- // Check TokenSpaceGuid\r
- //\r
- if (!isEmpty(this.jTextFieldTokenSpaceGuid.getText())) {\r
- if (!DataValidation.isC_NameType(this.jTextFieldTokenSpaceGuid.getText())) {\r
- Log.wrn("Update PcdCoded",\r
- "Incorrect data type for the selected pcd entry, please check the datatype specified in the spd file");\r
- return false;\r
- }\r
- }\r
-\r
- //\r
- // Check DefaultValue\r
- //\r
- if (!isEmpty(this.jTextFieldDefaultValue.getText())) {\r
- if (!DataValidation.isDefaultValueType(this.jTextFieldDefaultValue.getText())) {\r
- Log.wrn("Update PcdCoded", "Incorrect data type for Default Value");\r
- return false;\r
- }\r
- }\r
-\r
- //\r
- // Check HelpText\r
- //\r
- if (isEmpty(this.jTextAreaHelpText.getText())) {\r
- Log.wrn("Update PcdCoded", "Help Text should not be empty");\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 PcdCoded", "Incorrect data type for Feature Flag");\r
- return false;\r
- }\r
- }\r
-\r
- return true;\r
- }\r
-\r
- private PcdCodedIdentification getCurrentPcdCoded() {\r
- String arg0 = this.jComboBoxCName.getSelectedItem().toString();\r
- String arg1 = this.jTextFieldTokenSpaceGuid.getText();\r
-\r
- String arg2 = this.jTextFieldFeatureFlag.getText();\r
- Vector<String> arg3 = this.jArchCheckBox.getSelectedItemsVector();\r
-\r
- String arg4 = this.jTextFieldDefaultValue.getText();\r
- String arg5 = this.jTextAreaHelpText.getText();\r
- String arg6 = this.jComboBoxItemType.getSelectedItem().toString();\r
- String arg7 = this.jComboBoxUsage.getSelectedItem().toString();\r
- if (arg7.equals(DataType.EMPTY_SELECT_ITEM)) {\r
- arg7 = "";\r
- }\r
-\r
- id = new PcdCodedIdentification(arg0, arg1, arg2, arg3, arg4, arg5, arg6, arg7);\r
- return id;\r
- }\r
-\r
- public PcdCodedIdentification getId() {\r
- return id;\r
- }\r
-\r
- public void setId(PcdCodedIdentification id) {\r
- this.id = id;\r
- }\r
-\r
- /*\r
- * (non-Javadoc)\r
- * \r
- * @see java.awt.event.ItemListener#itemStateChanged(java.awt.event.ItemEvent)\r
- * \r
- * Reflesh the frame when selected item changed\r
- * \r
- */\r
- public void itemStateChanged(ItemEvent arg0) {\r
- int index = this.jComboBoxCName.getSelectedIndex();\r
- if (arg0.getSource() == this.jComboBoxCName && arg0.getStateChange() == ItemEvent.SELECTED) {\r
- if (pcd.getPcd(index).getGuidCName() == null || isEmpty(pcd.getPcd(index).getGuidCName())\r
- || pcd.getPcd(index).getType() == null || pcd.getPcd(index).getHelp() == null\r
- || isEmpty(pcd.getPcd(index).getHelp())) {\r
- Log.wrn("select pcd entry when editing msa",\r
- "The selected value is defined incorrectly.\r\nPlease check it in the spd file");\r
- } else {\r
- this.jTextFieldTokenSpaceGuid.setText(pcd.getPcd(index).getGuidCName());\r
- Tools.generateComboBoxByVector(this.jComboBoxItemType, pcd.getPcd(index).getType());\r
- this.jTextAreaHelpText.setText(pcd.getPcd(index).getHelp());\r
- this.jTextAreaHelpText.setSelectionStart(0);\r
- this.jTextAreaHelpText.setSelectionEnd(0);\r
- }\r
- }\r
- }\r
-}\r