Restructuring for better separation of Tool packages.

[mirror_edk2.git] / Tools / Java / Source / FrameworkWizard / src / org / tianocore / frameworkwizard / module / ui / dialog / ProtocolsDlg.java

/** @file\r
 \r
 The file is used to create, update Protocol of 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.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.Protocols.ProtocolsIdentification;\r
import org.tianocore.frameworkwizard.packaging.PackageIdentification;\r
import org.tianocore.frameworkwizard.workspace.WorkspaceTools;\r
\r
/**\r
 * The class is used to create, update Protocol of MSA file\r
 * \r
 * It extends IDialog\r
 * \r
 */\r
public class ProtocolsDlg extends IDialog implements ItemListener {\r
\r
    // /\r
    // / Define class Serial Version UID\r
    // /\r
    private static final long serialVersionUID = -9084913640747858848L;\r
\r
    //\r
    // Define class members\r
    //\r
    private JPanel jContentPane = null;\r
\r
    private JLabel jLabelC_Name = null;\r
\r
    private JLabel jLabelFeatureFlag = null;\r
\r
    private JTextField jTextFieldFeatureFlag = 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 JLabel jLabelProtocolType = null;\r
\r
    private JLabel jLabelArch = null;\r
\r
    private JScrollPane jScrollPane = null;\r
\r
    private JComboBox jComboBoxProtocolType = null;\r
\r
    private JComboBox jComboBoxCName = 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 ProtocolsIdentification id = null;\r
\r
    private WorkspaceTools wt = new WorkspaceTools();\r
\r
    private EnumerationData ed = new EnumerationData();\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 jComboBoxUsage\r
     * \r
     * @return javax.swing.JComboBox jComboBoxUsage\r
     * \r
     */\r
    private JComboBox getJComboBoxProtocolUsage() {\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><tr><td colspan=2 align=center><b>Protocol</b></td></tr>"\r
                                          + "<tr><td>ALWAYS_CONSUMED</td><td>Module always consumes the protocol</td></tr>"\r
                                          + "<tr><td>SOMETIMES_CONSUMES</td><td>Module sometimes consumes the protocol</td></tr>"\r
                                          + "<tr><td>ALWAYS_PRODUCED</td><td>Module always produces the protocol</td></tr>"\r
                                          + "<tr><td>SOMETIMES_PRODUCED</td><td>Module sometimes produces the protocol</td></tr>"\r
                                          + "<tr><td>TO_START</td><td>The protocol is consumed by a Driver Binding protocol <b>Start</b><br>function.  The protocol is used in EFI 1.10 driver model</td></tr>"\r
                                          + "<tr><td>BY_START</td><td>Protocol is produced by a Driver Binding protocol <b>Start</b><br>function. The protocol is used in EFI 1.10 driver model</td></tr>"\r
                                          + "<tr><td colspan=2 align=center><b>Protocol Notify</b></td></tr>"\r
                                          + "<tr><td>SOMETIMES_CONSUMED</td><td>Module will consume the protocol if it is produced.<br>Consumption is defined by executing the protocol notify<br>function.</td></tr></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 jComboBoxProtocolType\r
     * \r
     * @return javax.swing.JComboBox\r
     */\r
    private JComboBox getJComboBoxProtocolType() {\r
        if (jComboBoxProtocolType == null) {\r
            jComboBoxProtocolType = new JComboBox();\r
            jComboBoxProtocolType.setBounds(new java.awt.Rectangle(168, 12, 320, 20));\r
            jComboBoxProtocolType.setPreferredSize(new java.awt.Dimension(320, 20));\r
            jComboBoxProtocolType.addItemListener(this);\r
            jComboBoxProtocolType\r
                                 .setToolTipText("<html>Select Protocol Type<br>Protocol Notify is a register protocol notify mechanism.");\r
        }\r
        return jComboBoxProtocolType;\r
    }\r
\r
    /**\r
     * This method initializes jComboBoxCName\r
     * \r
     * @return javax.swing.JComboBox\r
     */\r
    private JComboBox getJComboBoxCName() {\r
        if (jComboBoxCName == null) {\r
            jComboBoxCName = new JComboBox();\r
            jComboBoxCName.setBounds(new java.awt.Rectangle(168, 37, 320, 20));\r
            jComboBoxCName.setPreferredSize(new java.awt.Dimension(320, 20));\r
            jComboBoxCName.setToolTipText("Select Guid C Name of the Protocol");\r
\r
        }\r
        return jComboBoxCName;\r
    }\r
\r
    /**\r
     * This method initializes jTextAreaHelpText\r
     * \r
     * @return javax.swing.JTextArea\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
     */\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
        // Width must be 20 larger than Content Pane PreferredSize width for MSFT\r
        // Height must be 45 larger than ContentPane PreferredSize height for MSFT\r
        this.setSize(505, 260);\r
        this.setContentPane(getJScrollPane());\r
        this.setTitle("Protocols");\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 inProtocolsId\r
     * \r
     */\r
    private void init(ProtocolsIdentification inProtocolsId, ModuleIdentification mid) {\r
        init();\r
        this.id = inProtocolsId;\r
        \r
        //\r
        // Init arch with module's arch\r
        //\r
        this.jArchCheckBox.setEnabledItems(wt.getModuleArch(mid));\r
        \r
        //\r
        // Get defined protocols from dependent packages\r
        //\r
        Vector<PackageIdentification> vpid = wt.getPackageDependenciesOfModule(mid);\r
        if (vpid.size() <= 0) {\r
            Log.wrn("Init Protocol", "This module hasn't defined any package dependency, so there is no protocol can be added");\r
        }\r
\r
        Tools.generateComboBoxByVector(this.jComboBoxCName,\r
                                       wt.getAllProtocolDeclarationsFromPackages(wt.getPackageDependenciesOfModule(mid)));\r
\r
        if (this.id != null) {\r
            this.jComboBoxCName.setSelectedItem(id.getName());\r
            this.jComboBoxProtocolType.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 inProtocolsIdentification\r
     * @param iFrame\r
     * \r
     */\r
    public ProtocolsDlg(ProtocolsIdentification inProtocolsIdentification, IFrame iFrame, ModuleIdentification mid) {\r
        super(iFrame, true);\r
        init(inProtocolsIdentification, 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.jComboBoxUsage.setEnabled(!isView);\r
            this.jTextFieldFeatureFlag.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
            jLabelProtocolType = new JLabel();\r
            jLabelProtocolType.setBounds(new java.awt.Rectangle(12, 12, 155, 20));\r
            jLabelProtocolType.setText("Select Protocol Type");\r
\r
            jStarLabel2 = new StarLabel();\r
            jStarLabel2.setLocation(new java.awt.Point(2, 37));\r
            jLabelC_Name = new JLabel();\r
            jLabelC_Name.setText("Protocol Guid C Name");\r
            jLabelC_Name.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.setText("Feature Flag Expression");\r
            jLabelFeatureFlag.setBounds(new java.awt.Rectangle(12, 157, 155, 20));\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(jLabelProtocolType, null);\r
            jContentPane.add(getJComboBoxProtocolType(), null);\r
            jContentPane.add(jStarLabel2, null);\r
            jContentPane.add(jLabelC_Name, null);\r
            jContentPane.add(getJComboBoxCName(), null);\r
            jContentPane.add(jStarLabel3, null);\r
            jContentPane.add(jLabelUsage, null);\r
            jContentPane.add(getJComboBoxProtocolUsage(), 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\r
     * \r
     */\r
    private void initFrame() {\r
        Tools.generateComboBoxByVector(jComboBoxProtocolType, ed.getVProtocolType());\r
        Tools.generateComboBoxByVector(jComboBoxUsage, ed.getVProtocolUsage());\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
                getCurrentProtocols();\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.jComboBoxCName.getSelectedItem() == null) {\r
            Log.wrn("Update protocols", "Please select one Protocol/ProtocolNotify 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 Protocols", "Incorrect data type for Protocol/ProtocolNotify 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 Protocols", "Incorrect data type for Feature Flag");\r
                return false;\r
            }\r
        }\r
\r
        return true;\r
    }\r
\r
    private ProtocolsIdentification getCurrentProtocols() {\r
        String arg0 = this.jComboBoxCName.getSelectedItem().toString();\r
        String arg1 = this.jComboBoxProtocolType.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 ProtocolsIdentification(arg0, arg1, arg2, arg3, arg4, arg5);\r
        return 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
\r
    public void itemStateChanged(ItemEvent arg0) {\r
        if (arg0.getSource() == this.jComboBoxProtocolType && arg0.getStateChange() == ItemEvent.SELECTED) {\r
            if (this.jComboBoxProtocolType.getSelectedItem().toString().equals(ed.getVProtocolType().get(0))) {\r
                Tools.generateComboBoxByVector(this.jComboBoxUsage, ed.getVProtocolUsage());\r
            } else {\r
                Tools.generateComboBoxByVector(this.jComboBoxUsage, ed.getVProtocolNotifyUsage());\r
            }\r
        }\r
    }\r
\r
    public ProtocolsIdentification getId() {\r
        return id;\r
    }\r
\r
    public void setId(ProtocolsIdentification id) {\r
        this.id = id;\r
    }\r
}\r