]> git.proxmox.com Git - mirror_edk2.git/blame - Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/HobsDlg.java
1. Fix EDKT321 A module's all top level elements' arch should be in range of the...
[mirror_edk2.git] / Tools / Source / FrameworkWizard / src / org / tianocore / frameworkwizard / module / ui / dialog / HobsDlg.java
CommitLineData
06a19cee 1/** @file\r
2 \r
9e857952 3 The file is used to create, update Hob section of the MSA file\r
06a19cee 4 \r
5 Copyright (c) 2006, Intel Corporation\r
6 All rights reserved. This program and the accompanying materials\r
7 are licensed and made available under the terms and conditions of the BSD License\r
8 which accompanies this distribution. The full text of the license may be found at\r
9 http://opensource.org/licenses/bsd-license.php\r
10 \r
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
13 \r
14 **/\r
15package org.tianocore.frameworkwizard.module.ui.dialog;\r
16\r
17import java.awt.event.ActionEvent;\r
18import java.util.Vector;\r
19\r
20import javax.swing.JButton;\r
21import javax.swing.JComboBox;\r
22import javax.swing.JLabel;\r
23import javax.swing.JPanel;\r
24import javax.swing.JScrollPane;\r
25import javax.swing.JTextField;\r
5101eff9 26import javax.swing.JTextArea;\r
06a19cee 27\r
28import org.tianocore.frameworkwizard.common.DataType;\r
29import org.tianocore.frameworkwizard.common.DataValidation;\r
30import org.tianocore.frameworkwizard.common.EnumerationData;\r
31import org.tianocore.frameworkwizard.common.Log;\r
32import org.tianocore.frameworkwizard.common.Tools;\r
33import org.tianocore.frameworkwizard.common.ui.ArchCheckBox;\r
34import org.tianocore.frameworkwizard.common.ui.IDialog;\r
35import org.tianocore.frameworkwizard.common.ui.IFrame;\r
36import org.tianocore.frameworkwizard.common.ui.StarLabel;\r
e08433ef 37import org.tianocore.frameworkwizard.module.Identifications.ModuleIdentification;\r
06a19cee 38import org.tianocore.frameworkwizard.module.Identifications.Hobs.HobsIdentification;\r
39import org.tianocore.frameworkwizard.workspace.WorkspaceTools;\r
40\r
41/**\r
9e857952 42 * The class is used to create, update Hob of the MSA file \r
43 * \r
44 * It extends IDialog\r
5101eff9 45 * \r
46 */\r
06a19cee 47public class HobsDlg extends IDialog {\r
48\r
a929458e 49 // /\r
50 // / Define class Serial Version UID\r
51 // /\r
52 private static final long serialVersionUID = -553473437579358325L;\r
06a19cee 53\r
a929458e 54 //\r
55 // Define class members\r
56 //\r
57 private JPanel jContentPane = null;\r
06a19cee 58\r
a929458e 59 private JLabel jLabelC_Name = null;\r
06a19cee 60\r
a929458e 61 private JComboBox jComboBoxGuidC_Name = null;\r
06a19cee 62\r
a929458e 63 private JLabel jLabelUsage = null;\r
06a19cee 64\r
a929458e 65 private JLabel jLabelHobType = null;\r
06a19cee 66\r
a929458e 67 private JComboBox jComboBoxUsage = null;\r
06a19cee 68\r
a929458e 69 private JComboBox jComboBoxHobType = null;\r
06a19cee 70\r
a929458e 71 private StarLabel jStarLabel1 = null;\r
06a19cee 72\r
a929458e 73 private StarLabel jStarLabel2 = null;\r
06a19cee 74\r
a929458e 75 private StarLabel jStarLabel3 = null;\r
06a19cee 76\r
a929458e 77 private JLabel jLabelArch = null;\r
06a19cee 78\r
a929458e 79 private JScrollPane jScrollPane = null;\r
06a19cee 80\r
a929458e 81 private JLabel jLabelFeatureFlag = null;\r
06a19cee 82\r
a929458e 83 private JTextField jTextFieldFeatureFlag = null;\r
06a19cee 84\r
a929458e 85 private JLabel jLabelHelpText = null;\r
06a19cee 86\r
a929458e 87 private JTextArea jTextAreaHelpText = null;\r
06a19cee 88\r
a929458e 89 private JScrollPane jScrollPaneHelpText = null;\r
06a19cee 90\r
a929458e 91 private ArchCheckBox jArchCheckBox = null;\r
06a19cee 92\r
a929458e 93 private JButton jButtonOk = null;\r
06a19cee 94\r
a929458e 95 private JButton jButtonCancel = null;\r
06a19cee 96\r
a929458e 97 //\r
98 // Not used by UI\r
99 //\r
100 private HobsIdentification id = null;\r
101\r
102 private EnumerationData ed = new EnumerationData();\r
103\r
104 private WorkspaceTools wt = new WorkspaceTools();\r
105\r
106 /**\r
107 * This method initializes jTextField\r
108 * \r
109 * @return javax.swing.JTextField jTextFieldC_Name\r
110 * \r
111 */\r
112 private JComboBox getJComboBoxGuidC_Name() {\r
113 if (jComboBoxGuidC_Name == null) {\r
114 jComboBoxGuidC_Name = new JComboBox();\r
3f62225f 115 jComboBoxGuidC_Name.setBounds(new java.awt.Rectangle(168, 12, 320, 20));\r
a929458e 116 jComboBoxGuidC_Name.setPreferredSize(new java.awt.Dimension(320, 20));\r
117 jComboBoxGuidC_Name.setToolTipText("Select the GUID C Name of the Hob");\r
118 }\r
119 return jComboBoxGuidC_Name;\r
120 }\r
06a19cee 121\r
a929458e 122 /**\r
123 * This method initializes jComboBoxHobType\r
124 * \r
125 * @return javax.swing.JComboBox jComboBoxHobType\r
126 * \r
127 */\r
128 private JComboBox getJComboBoxHobType() {\r
129 if (jComboBoxHobType == null) {\r
130 jComboBoxHobType = new JComboBox();\r
3f62225f 131 jComboBoxHobType.setBounds(new java.awt.Rectangle(168, 37, 320, 20));\r
a929458e 132 jComboBoxHobType.setPreferredSize(new java.awt.Dimension(320, 20));\r
133 jComboBoxHobType\r
134 .setToolTipText("<html><table>"\r
135 + "<tr><td>PHIT</td><td>EFI_HOB_TYPE_HANDOFF</td></tr>"\r
136 + "<tr><td>MEMORY_ALLOCATION</td><td>EFI_HOB_TYPE_MEMORY_ALLOCATION and $BaseName</td></tr>"\r
137 + "<tr><td>RESOURCE_DESCRIPTOR</td><td>EFI_HOB_TYPE_RESOURCE_DESCRIPTOR</td></tr>"\r
138 + "<tr><td>GUID_EXTENTION</td><td>EFI_HOB_TYPE_GUID_EXTENSION and BaseName of GUID</td></tr>"\r
139 + "<tr><td>FIRMWARE_VOLUME</td><td>EFI_HOB_TYPE_FV</td></tr>"\r
140 + "<tr><td>CPU</td><td>EFI_HOB_TYPE_CPU</td></tr>"\r
141 + "<tr><td>POOL</td><td>EFI_HOB_TYPE_PEI_MEMORY_POOL</td></tr>"\r
142 + "<tr><td>CAPSULE_VOLUME</td><td>EFI_HOB_TYPE_CV</td></tr>"\r
143 + "</table></html>");\r
144 }\r
145 return jComboBoxHobType;\r
146 }\r
06a19cee 147\r
a929458e 148 /**\r
149 * This method initializes jComboBoxUsage\r
150 * \r
151 * @return javax.swing.JComboBox jComboBoxUsage\r
152 * \r
153 */\r
154 private JComboBox getJComboBoxUsage() {\r
155 if (jComboBoxUsage == null) {\r
156 jComboBoxUsage = new JComboBox();\r
3f62225f 157 jComboBoxUsage.setBounds(new java.awt.Rectangle(168, 62, 320, 20));\r
a929458e 158 jComboBoxUsage.setPreferredSize(new java.awt.Dimension(320, 20));\r
159 jComboBoxUsage\r
160 .setToolTipText("<html><table>"\r
161 + "<tr><td>ALWAYS_CONSUMED</td><td>HOB must be present in the system</td></tr>"\r
162 + "<tr><td>SOMETIMES_CONSUMED</td><td>HOB will be used if it's present</td></tr>"\r
163 + "<tr><td>ALWAYS_PRODUCED</td><td>HOB is always produced</td></tr>"\r
164 + "<tr><td>SOMETIMES_PRODUCED</td><td>HOB will sometimes be produced by the module</td></tr>"\r
165 + "</table></html>");\r
166 }\r
167 return jComboBoxUsage;\r
168 }\r
06a19cee 169\r
a929458e 170 /**\r
171 * This method initializes jScrollPane\r
172 * \r
173 * @return javax.swing.JScrollPane\r
174 */\r
175 private JScrollPane getJScrollPane() {\r
176 if (jScrollPane == null) {\r
177 jScrollPane = new JScrollPane();\r
178 jScrollPane.setViewportView(getJContentPane());\r
179 }\r
180 return jScrollPane;\r
06a19cee 181 }\r
a929458e 182\r
183 /**\r
184 * This method initializes jTextFieldFeatureFlag\r
185 * \r
186 * @return javax.swing.JTextField\r
187 */\r
188 private JTextField getJTextFieldFeatureFlag() {\r
189 if (jTextFieldFeatureFlag == null) {\r
190 jTextFieldFeatureFlag = new JTextField();\r
21b42c66 191 jTextFieldFeatureFlag.setBounds(new java.awt.Rectangle(168, 157, 320, 20));\r
a929458e 192 jTextFieldFeatureFlag.setPreferredSize(new java.awt.Dimension(320, 20));\r
193 jTextFieldFeatureFlag.setToolTipText("Postfix expression that must evaluate to TRUE or FALSE");\r
21b42c66 194 jTextFieldFeatureFlag.setEnabled(false);\r
a929458e 195 }\r
196 return jTextFieldFeatureFlag;\r
06a19cee 197 }\r
a929458e 198\r
199 /**\r
200 * This method initializes jTextFieldHelpText\r
201 * \r
202 * @return javax.swing.JTextField\r
203 * \r
204 */\r
205 private JTextArea getJTextAreaHelpText() {\r
206 if (jTextAreaHelpText == null) {\r
207 jTextAreaHelpText = new JTextArea();\r
208 jTextAreaHelpText.setLineWrap(true);\r
209 jTextAreaHelpText.setWrapStyleWord(true);\r
210 }\r
211 return jTextAreaHelpText;\r
06a19cee 212 }\r
a929458e 213\r
214 /**\r
215 * This method initializes jScrollPaneHelpText\r
216 * \r
217 * @return javax.swing.JScrollPane\r
218 */\r
219 private JScrollPane getJScrollPaneHelpText() {\r
220 if (jScrollPaneHelpText == null) {\r
221 jScrollPaneHelpText = new JScrollPane();\r
222 jScrollPaneHelpText.setHorizontalScrollBarPolicy(javax.swing.JScrollPane.HORIZONTAL_SCROLLBAR_NEVER);\r
223 jScrollPaneHelpText.setSize(new java.awt.Dimension(320, 40));\r
224 jScrollPaneHelpText.setPreferredSize(new java.awt.Dimension(320, 40));\r
3f62225f 225 jScrollPaneHelpText.setLocation(new java.awt.Point(168, 87));\r
a929458e 226 jScrollPaneHelpText.setViewportView(getJTextAreaHelpText());\r
227 }\r
228 return jScrollPaneHelpText;\r
06a19cee 229 }\r
a929458e 230\r
231 /**\r
232 * This method initializes jButtonOk\r
233 * \r
234 * @return javax.swing.JButton\r
235 * \r
236 */\r
237 private JButton getJButtonOk() {\r
238 if (jButtonOk == null) {\r
239 jButtonOk = new JButton();\r
3f62225f 240 jButtonOk.setBounds(new java.awt.Rectangle(290, 187, 90, 20));\r
a929458e 241 jButtonOk.setText("Ok");\r
242 jButtonOk.addActionListener(this);\r
243 }\r
244 return jButtonOk;\r
06a19cee 245 }\r
a929458e 246\r
247 /**\r
248 * This method initializes jButtonCancel\r
249 * \r
250 * @return javax.swing.JButton\r
251 * \r
252 */\r
253 private JButton getJButtonCancel() {\r
254 if (jButtonCancel == null) {\r
255 jButtonCancel = new JButton();\r
3f62225f 256 jButtonCancel.setBounds(new java.awt.Rectangle(390, 187, 90, 20));\r
a929458e 257 jButtonCancel.setText("Cancel");\r
258 jButtonCancel.addActionListener(this);\r
259 }\r
260 return jButtonCancel;\r
06a19cee 261 }\r
a929458e 262\r
263 public static void main(String[] args) {\r
264\r
06a19cee 265 }\r
a929458e 266\r
267 /**\r
268 * This method initializes this\r
269 * \r
270 */\r
271 private void init() {\r
3f62225f 272 this.setSize(505, 260);\r
a929458e 273 this.setContentPane(getJScrollPane());\r
274 this.setTitle("Hobs");\r
275 initFrame();\r
276 this.setViewMode(false);\r
277 this.centerWindow();\r
06a19cee 278 }\r
a929458e 279\r
280 /**\r
281 * This method initializes this Fill values to all fields if these values are\r
282 * not empty\r
283 * \r
284 * @param inHobsId\r
285 * \r
286 */\r
e08433ef 287 private void init(HobsIdentification inHobsId, ModuleIdentification mid) {\r
a929458e 288 init();\r
289 this.id = inHobsId;\r
e08433ef 290 \r
291 //\r
292 // Init arch with module's arch\r
293 //\r
294 this.jArchCheckBox.setEnabledItems(wt.getModuleArch(mid));\r
295 \r
a929458e 296 if (this.id != null) {\r
297 this.jComboBoxGuidC_Name.setSelectedItem(id.getName());\r
298 this.jComboBoxHobType.setSelectedItem(id.getType());\r
299 this.jComboBoxUsage.setSelectedItem(id.getUsage());\r
300 this.jTextAreaHelpText.setText(id.getHelp());\r
301 this.jTextFieldFeatureFlag.setText(id.getFeatureFlag());\r
302 this.jArchCheckBox.setSelectedItems(id.getSupArchList());\r
303 }\r
06a19cee 304 }\r
a929458e 305\r
306 /**\r
307 * This is the override edit constructor\r
308 * \r
309 * @param inHobsIdentification\r
310 * @param iFrame\r
311 * \r
312 */\r
e08433ef 313 public HobsDlg(HobsIdentification inHobsIdentification, IFrame iFrame, ModuleIdentification mid) {\r
a929458e 314 super(iFrame, true);\r
e08433ef 315 init(inHobsIdentification, mid);\r
06a19cee 316 }\r
a929458e 317\r
318 /**\r
319 * Disable all components when the mode is view\r
320 * \r
321 * @param isView\r
322 * true - The view mode; false - The non-view mode\r
323 * \r
324 */\r
325 public void setViewMode(boolean isView) {\r
326 if (isView) {\r
327 this.jComboBoxGuidC_Name.setEnabled(!isView);\r
328 this.jComboBoxUsage.setEnabled(!isView);\r
329 this.jComboBoxHobType.setEnabled(!isView);\r
330 }\r
5101eff9 331 }\r
a929458e 332\r
333 /**\r
334 * This method initializes jContentPane\r
335 * \r
336 * @return javax.swing.JPanel jContentPane\r
337 * \r
338 */\r
339 public JPanel getJContentPane() {\r
340 if (jContentPane == null) {\r
341 jStarLabel1 = new StarLabel();\r
3f62225f 342 jStarLabel1.setLocation(new java.awt.Point(2, 12));\r
a929458e 343 jLabelC_Name = new JLabel();\r
344 jLabelC_Name.setText("Hob's Guid C Name");\r
3f62225f 345 jLabelC_Name.setBounds(new java.awt.Rectangle(12, 12, 155, 20));\r
a929458e 346\r
347 jStarLabel2 = new StarLabel();\r
3f62225f 348 jStarLabel2.setLocation(new java.awt.Point(2, 37));\r
a929458e 349 jLabelHobType = new JLabel();\r
350 jLabelHobType.setText("Hob Type");\r
3f62225f 351 jLabelHobType.setBounds(new java.awt.Rectangle(12, 37, 155, 20));\r
a929458e 352\r
353 jStarLabel3 = new StarLabel();\r
3f62225f 354 jStarLabel3.setLocation(new java.awt.Point(2, 62));\r
a929458e 355 jLabelUsage = new JLabel();\r
356 jLabelUsage.setText("Usage");\r
3f62225f 357 jLabelUsage.setBounds(new java.awt.Rectangle(12, 62, 155, 20));\r
a929458e 358\r
359 jLabelHelpText = new JLabel();\r
3f62225f 360 jLabelHelpText.setBounds(new java.awt.Rectangle(12, 87, 155, 20));\r
a929458e 361 jLabelHelpText.setText("Help Text");\r
362\r
363 jLabelFeatureFlag = new JLabel();\r
21b42c66 364 jLabelFeatureFlag.setBounds(new java.awt.Rectangle(12, 157, 155, 20));\r
a929458e 365 jLabelFeatureFlag.setText("Feature Flag Expression");\r
21b42c66 366 jLabelFeatureFlag.setEnabled(false);\r
a929458e 367\r
368 jLabelArch = new JLabel();\r
21b42c66 369 jLabelArch.setBounds(new java.awt.Rectangle(12, 132, 155, 20));\r
a929458e 370 jLabelArch.setText("Supported Architectures");\r
371 jArchCheckBox = new ArchCheckBox();\r
21b42c66 372 jArchCheckBox.setBounds(new java.awt.Rectangle(168, 132, 320, 20));\r
a929458e 373 jArchCheckBox.setPreferredSize(new java.awt.Dimension(320, 20));\r
374\r
375 jContentPane = new JPanel();\r
376 jContentPane.setLayout(null);\r
3f62225f 377 jContentPane.setPreferredSize(new java.awt.Dimension(485, 215));\r
a929458e 378\r
379 jContentPane.add(jStarLabel1, null);\r
380 jContentPane.add(jLabelC_Name, null);\r
381 jContentPane.add(getJComboBoxGuidC_Name(), null);\r
382 jContentPane.add(jStarLabel2, null);\r
383 jContentPane.add(jLabelHobType, null);\r
384 jContentPane.add(getJComboBoxHobType(), null);\r
385 jContentPane.add(jStarLabel3, null);\r
386 jContentPane.add(jLabelUsage, null);\r
387 jContentPane.add(getJComboBoxUsage(), null);\r
388 jContentPane.add(jLabelHelpText, null);\r
389 jContentPane.add(getJScrollPaneHelpText(), null);\r
390 jContentPane.add(jLabelFeatureFlag, null);\r
391 jContentPane.add(getJTextFieldFeatureFlag(), null);\r
392 jContentPane.add(jLabelArch, null);\r
393 jContentPane.add(jArchCheckBox, null);\r
394 jContentPane.add(getJButtonOk(), null);\r
395 jContentPane.add(getJButtonCancel(), null);\r
396 }\r
397 return jContentPane;\r
5101eff9 398 }\r
a929458e 399\r
400 /**\r
401 * This method initializes Usage type and Hob type\r
402 * \r
403 */\r
404 private void initFrame() {\r
405 Tools.generateComboBoxByVector(jComboBoxUsage, ed.getVHobUsage());\r
406 Tools.generateComboBoxByVector(jComboBoxHobType, ed.getVHobType());\r
407 Tools.generateComboBoxByVector(jComboBoxGuidC_Name, wt.getAllGuidDeclarationsFromWorkspace());\r
06a19cee 408 }\r
409\r
a929458e 410 /*\r
411 * (non-Javadoc)\r
412 * \r
413 * @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)\r
414 * \r
415 * Override actionPerformed to listen all actions\r
416 * \r
417 */\r
418 public void actionPerformed(ActionEvent arg0) {\r
419 if (arg0.getSource() == jButtonOk) {\r
420 if (checkAdd()) {\r
421 getCurrentHobs();\r
422 this.returnType = DataType.RETURN_TYPE_OK;\r
423 this.setVisible(false);\r
424 }\r
425 }\r
426\r
427 if (arg0.getSource() == jButtonCancel) {\r
428 this.returnType = DataType.RETURN_TYPE_CANCEL;\r
429 this.setVisible(false);\r
430 }\r
5101eff9 431 }\r
06a19cee 432\r
a929458e 433 /**\r
434 * Data validation for all fields\r
435 * \r
436 * @retval true - All datas are valid\r
437 * @retval false - At least one data is invalid\r
438 * \r
439 */\r
440 public boolean checkAdd() {\r
441 //\r
442 // Check if all fields have correct data types\r
443 //\r
444\r
445 //\r
446 // Check Name\r
447 //\r
448 if (isEmpty(this.jComboBoxGuidC_Name.getSelectedItem().toString())) {\r
623db5ca 449 Log.wrn("Update Hobs", "Hob Guid C Name must be entered!");\r
a929458e 450 return false;\r
451 }\r
452\r
453 if (!isEmpty(this.jComboBoxGuidC_Name.getSelectedItem().toString())) {\r
454 if (!DataValidation.isC_NameType(this.jComboBoxGuidC_Name.getSelectedItem().toString())) {\r
455 Log.wrn("Update Hobs", "Incorrect data type for Hob Name");\r
456 return false;\r
457 }\r
458 }\r
459\r
460 //\r
461 // Check FeatureFlag\r
462 //\r
463 if (!isEmpty(this.jTextFieldFeatureFlag.getText())) {\r
464 if (!DataValidation.isFeatureFlag(this.jTextFieldFeatureFlag.getText())) {\r
465 Log.wrn("Update Hobs", "Incorrect data type for Feature Flag");\r
466 return false;\r
467 }\r
468 }\r
469\r
470 return true;\r
06a19cee 471 }\r
472\r
a929458e 473 private HobsIdentification getCurrentHobs() {\r
474 String arg0 = this.jComboBoxGuidC_Name.getSelectedItem().toString();\r
475 String arg1 = this.jComboBoxHobType.getSelectedItem().toString();\r
476 String arg2 = this.jComboBoxUsage.getSelectedItem().toString();\r
477\r
478 String arg3 = this.jTextFieldFeatureFlag.getText();\r
479 Vector<String> arg4 = this.jArchCheckBox.getSelectedItemsVector();\r
480 String arg5 = this.jTextAreaHelpText.getText();\r
481 id = new HobsIdentification(arg0, arg1, arg2, arg3, arg4, arg5);\r
482 return id;\r
06a19cee 483 }\r
484\r
a929458e 485 public HobsIdentification getId() {\r
486 return id;\r
06a19cee 487 }\r
5101eff9 488\r
a929458e 489 public void setId(HobsIdentification id) {\r
490 this.id = id;\r
491 }\r
06a19cee 492}\r