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