Tools/Java/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/ModuleExterns.java

   1 /** @file
   2
   3  The file is used to create, update DataHub of MSA/MBD file
   4
   5  Copyright (c) 2006, Intel Corporation
   6  All rights reserved. This program and the accompanying materials
   7  are licensed and made available under the terms and conditions of the BSD License
   8  which accompanies this distribution.  The full text of the license may be found at
   9  http://opensource.org/licenses/bsd-license.php
  10
  11  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14  **/
  15 package org.tianocore.frameworkwizard.module.ui;
  16
  17 import java.awt.Dimension;
  18 import java.awt.event.ActionEvent;
  19 import java.awt.event.ComponentEvent;
  20 import java.awt.event.ItemListener;
  21 import java.awt.event.MouseEvent;
  22 import java.util.Vector;
  23
  24 import javax.swing.JButton;
  25 import javax.swing.JPanel;
  26 import javax.swing.JScrollPane;
  27 import javax.swing.JTable;
  28 import javax.swing.ListSelectionModel;
  29 import javax.swing.event.ListSelectionEvent;
  30
  31 import org.tianocore.ExternsDocument;
  32 import org.tianocore.ExternsDocument.Externs;
  33 import org.tianocore.ExternsDocument.Externs.Extern;
  34 import org.tianocore.ModuleSurfaceAreaDocument.ModuleSurfaceArea;
  35 import org.tianocore.frameworkwizard.common.DataType;
  36 import org.tianocore.frameworkwizard.common.EnumerationData;
  37 import org.tianocore.frameworkwizard.common.IDefaultTableModel;
  38 import org.tianocore.frameworkwizard.common.Log;
  39 import org.tianocore.frameworkwizard.common.Tools;
  40 import org.tianocore.frameworkwizard.common.Identifications.OpeningModuleType;
  41 import org.tianocore.frameworkwizard.common.ui.IFrame;
  42 import org.tianocore.frameworkwizard.common.ui.IInternalFrame;
  43 import org.tianocore.frameworkwizard.module.Identifications.Externs.ExternsIdentification;
  44 import org.tianocore.frameworkwizard.module.Identifications.Externs.ExternsVector;
  45 import org.tianocore.frameworkwizard.module.ui.dialog.ExternsDlg;
  46
  47 /**
  48  The class is used to create, update DataHub of MSA/MBD file
  49  It extends IInternalFrame
  50
  51
  52
  53  **/
  54 public class ModuleExterns extends IInternalFrame implements ItemListener {
  55
  56     ///
  57     /// Define class Serial Version UID
  58     ///
  59     private static final long serialVersionUID = -7382008402932047191L;
  60
  61     //
  62     //Define class members
  63     //
  64     private JPanel jContentPane = null;
  65
  66     private JButton jButtonAdd = null;
  67
  68     private JButton jButtonRemove = null;
  69
  70     private JButton jButtonUpdate = null;
  71
  72     private JScrollPane jScrollPane = null;
  73
  74     private JScrollPane jScrollPaneTable = null;
  75
  76     private JTable jTable = null;
  77
  78     //
  79     // Not used by UI
  80     //
  81     private OpeningModuleType omt = null;
  82
  83     private ModuleSurfaceArea msa = null;
  84
  85     private ExternsDocument.Externs externs = null;
  86
  87     private ExternsIdentification id = null;
  88
  89     private ExternsVector vid = new ExternsVector();
  90
  91     private IDefaultTableModel model = null;
  92
  93     private int selectedRow = -1;
  94
  95     private IFrame parentFrame = null;
  96
  97     /**
  98      This method initializes jButtonAdd
  99
 100      @return javax.swing.JButton jButtonAdd
 101
 102      **/
 103     private JButton getJButtonAdd() {
 104         if (jButtonAdd == null) {
 105             jButtonAdd = new JButton();
 106             jButtonAdd.setBounds(new java.awt.Rectangle(230, 195, 90, 20));
 107             jButtonAdd.setText("Add");
 108             jButtonAdd.addActionListener(this);
 109             jButtonAdd.setPreferredSize(new java.awt.Dimension(90, 20));
 110         }
 111         return jButtonAdd;
 112     }
 113
 114     /**
 115      This method initializes jButtonRemove
 116
 117      @return javax.swing.JButton jButtonRemove
 118
 119      **/
 120     private JButton getJButtonRemove() {
 121         if (jButtonRemove == null) {
 122             jButtonRemove = new JButton();
 123             jButtonRemove.setBounds(new java.awt.Rectangle(400, 195, 90, 20));
 124             jButtonRemove.setText("Remove");
 125             jButtonRemove.addActionListener(this);
 126             jButtonRemove.setPreferredSize(new java.awt.Dimension(90, 20));
 127         }
 128         return jButtonRemove;
 129     }
 130
 131     /**
 132      This method initializes jButtonUpdate
 133
 134      @return javax.swing.JButton jButtonUpdate
 135
 136      **/
 137     private JButton getJButtonUpdate() {
 138         if (jButtonUpdate == null) {
 139             jButtonUpdate = new JButton();
 140             jButtonUpdate.setBounds(new java.awt.Rectangle(315, 195, 90, 20));
 141             jButtonUpdate.setPreferredSize(new java.awt.Dimension(90, 20));
 142             jButtonUpdate.setText("Edit");
 143             jButtonUpdate.addActionListener(this);
 144         }
 145         return jButtonUpdate;
 146     }
 147
 148     /**
 149      This method initializes jScrollPane
 150
 151      @return javax.swing.JScrollPane
 152      */
 153     private JScrollPane getJScrollPane() {
 154         if (jScrollPane == null) {
 155             jScrollPane = new JScrollPane();
 156             jScrollPane.setViewportView(getJContentPane());
 157         }
 158         return jScrollPane;
 159     }
 160
 161     /**
 162      This method initializes jScrollPaneTable
 163
 164      @return javax.swing.JScrollPane
 165      **/
 166     private JScrollPane getJScrollPaneTable() {
 167         if (jScrollPaneTable == null) {
 168             jScrollPaneTable = new JScrollPane();
 169             jScrollPaneTable.setBounds(new java.awt.Rectangle(15, 10, 470, 420));
 170             jScrollPaneTable.setPreferredSize(new Dimension(470, 420));
 171             jScrollPaneTable.setViewportView(getJTable());
 172         }
 173         return jScrollPaneTable;
 174     }
 175
 176     /**
 177      This method initializes jTable
 178
 179      @return javax.swing.JTable
 180      **/
 181     private JTable getJTable() {
 182         if (jTable == null) {
 183             jTable = new JTable();
 184             model = new IDefaultTableModel();
 185             jTable = new JTable(model);
 186             jTable.setRowHeight(20);
 187
 188             model.addColumn("Type");
 189             model.addColumn("Name");
 190             model.addColumn("Value");
 191
 192             jTable.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
 193             jTable.getSelectionModel().addListSelectionListener(this);
 194             jTable.getModel().addTableModelListener(this);
 195             jTable.addMouseListener(this);
 196         }
 197         return jTable;
 198     }
 199
 200     /**
 201      This method initializes this
 202
 203      **/
 204     private void init() {
 205         this.setSize(500, 515);
 206         this.setContentPane(getJScrollPane());
 207         this.setTitle("Externs");
 208     }
 209
 210     /**
 211      This method initializes this
 212      Fill values to all fields if these values are not empty
 213
 214      @param inPackageDependencies
 215
 216      **/
 217     private void init(Externs inExterns) {
 218         init();
 219         this.externs = inExterns;
 220
 221         if (this.externs != null) {
 222             //
 223             // Get specification
 224             //
 225             if (this.externs.getSpecificationList().size() > 0) {
 226                 for (int index = 0; index < this.externs.getSpecificationList().size(); index++) {
 227                     String arg0 = externs.getSpecificationList().get(index);
 228                     String arg1 = EnumerationData.EXTERNS_SPECIFICATION;
 229
 230                     id = new ExternsIdentification(arg0, arg1);
 231                     vid.addExterns(id);
 232                 }
 233             }
 234
 235             //
 236             // Get Externs list
 237             //
 238             if (this.externs.getExternList().size() > 0) {
 239                 for (int index = 0; index < this.externs.getExternList().size(); index++) {
 240                     //
 241                     // Get common data
 242                     //
 243                     String featureFlag = externs.getExternList().get(index).getFeatureFlag();
 244                     Vector<String> arch = Tools
 245                                                .convertListToVector(externs.getExternList().get(index).getSupArchList());
 246
 247                     //
 248                     // Get Image data
 249                     //
 250                     if (this.externs.getExternList().get(index).getModuleEntryPoint() != null
 251                         || this.externs.getExternList().get(index).getModuleUnloadImage() != null) {
 252                         String moduleEntryPoint = this.externs.getExternList().get(index).getModuleEntryPoint();
 253                         String moduleUnloadImage = this.externs.getExternList().get(index).getModuleUnloadImage();
 254                         String type = EnumerationData.EXTERNS_IMAGE;
 255                         id = new ExternsIdentification(moduleEntryPoint, moduleUnloadImage, type, featureFlag, arch);
 256                     }
 257
 258                     //
 259                     // Get Library Data
 260                     //
 261                     if (this.externs.getExternList().get(index).getConstructor() != null
 262                         || this.externs.getExternList().get(index).getDestructor() != null) {
 263                         String constructor = this.externs.getExternList().get(index).getConstructor();
 264                         String destructor = this.externs.getExternList().get(index).getDestructor();
 265                         String type = EnumerationData.EXTERNS_LIBRARY;
 266                         id = new ExternsIdentification(constructor, destructor, type, featureFlag, arch);
 267                     }
 268
 269                     //
 270                     // Get Driver Data
 271                     //
 272                     if (this.externs.getExternList().get(index).getDriverBinding() != null) {
 273                         String driverBinding = this.externs.getExternList().get(index).getDriverBinding();
 274                         String componentName = this.externs.getExternList().get(index).getComponentName();
 275                         String driverConfig = this.externs.getExternList().get(index).getDriverConfig();
 276                         String driverDiag = this.externs.getExternList().get(index).getDriverDiag();
 277                         String type = EnumerationData.EXTERNS_DRIVER;
 278                         id = new ExternsIdentification(driverBinding, componentName, driverConfig, driverDiag, type,
 279                                                        featureFlag, arch);
 280                     }
 281
 282                     //
 283                     // Get Call Back Data
 284                     //
 285                     if (this.externs.getExternList().get(index).getSetVirtualAddressMapCallBack() != null
 286                         || this.externs.getExternList().get(index).getExitBootServicesCallBack() != null) {
 287                         String virtualAddressMap = this.externs.getExternList().get(index)
 288                                                                .getSetVirtualAddressMapCallBack();
 289                         String exitBootServices = this.externs.getExternList().get(index).getExitBootServicesCallBack();
 290                         String type = EnumerationData.EXTERNS_CALL_BACK;
 291                         id = new ExternsIdentification(virtualAddressMap, exitBootServices, type, featureFlag, arch);
 292                     }
 293
 294                     //
 295                     // Add id to vector
 296                     //
 297                     vid.addExterns(id);
 298                 }
 299             }
 300         }
 301         showTable();
 302     }
 303
 304     /**
 305      This is the default constructor
 306
 307      **/
 308     public ModuleExterns() {
 309         super();
 310         init();
 311         this.setVisible(true);
 312     }
 313
 314     /**
 315      This is the override edit constructor
 316
 317      @param inExterns The input data of ExternsDocument.Externs
 318
 319      **/
 320     public ModuleExterns(OpeningModuleType inOmt, IFrame iFrame) {
 321         super();
 322         this.omt = inOmt;
 323         this.msa = omt.getXmlMsa();
 324         this.parentFrame = iFrame;
 325         init(msa.getExterns());
 326         this.setVisible(true);
 327     }
 328
 329     /**
 330      This method initializes jContentPane
 331
 332      @return javax.swing.JPanel jContentPane
 333
 334      **/
 335     private JPanel getJContentPane() {
 336         if (jContentPane == null) {
 337             jContentPane = new JPanel();
 338             jContentPane.setLayout(null);
 339             jContentPane.setPreferredSize(new java.awt.Dimension(490, 490));
 340
 341             jContentPane.add(getJButtonAdd(), null);
 342             jContentPane.add(getJButtonRemove(), null);
 343             jContentPane.add(getJButtonUpdate(), null);
 344             jContentPane.add(getJScrollPaneTable(), null);
 345         }
 346         return jContentPane;
 347     }
 348
 349     private void showEdit(int index) {
 350         ExternsDlg dlg = new ExternsDlg(vid.getExterns(index), this.parentFrame, omt.getId());
 351         int result = dlg.showDialog();
 352         if (result == DataType.RETURN_TYPE_OK) {
 353             if (index == -1) {
 354                 this.vid.addExterns(dlg.getId());
 355             } else {
 356                 this.vid.setExterns(dlg.getId(), index);
 357             }
 358             this.showTable();
 359             this.save();
 360             dlg.dispose();
 361         }
 362         if (result == DataType.RETURN_TYPE_CANCEL) {
 363             dlg.dispose();
 364         }
 365     }
 366
 367     /**
 368      Clear all table rows
 369
 370      **/
 371     private void clearAll() {
 372         if (model != null) {
 373             for (int index = model.getRowCount() - 1; index >= 0; index--) {
 374                 model.removeRow(index);
 375             }
 376         }
 377     }
 378
 379     /**
 380      Read content of vector and put then into table
 381
 382      **/
 383     private void showTable() {
 384         clearAll();
 385
 386         if (vid.size() > 0) {
 387             for (int index = 0; index < vid.size(); index++) {
 388                 int line = 1;
 389
 390                 //
 391                 // For Specification
 392                 //
 393                 if (vid.getExterns(index).getType().equals(EnumerationData.EXTERNS_SPECIFICATION)) {
 394                     line = 1;
 395                 }
 396
 397                 //
 398                 // For Image
 399                 //
 400                 if (vid.getExterns(index).getType().equals(EnumerationData.EXTERNS_IMAGE)) {
 401                     line = 2;
 402                 }
 403
 404                 //
 405                 // For Library
 406                 //
 407                 if (vid.getExterns(index).getType().equals(EnumerationData.EXTERNS_LIBRARY)) {
 408                     line = 2;
 409                 }
 410
 411                 //
 412                 // For Driver
 413                 //
 414                 if (vid.getExterns(index).getType().equals(EnumerationData.EXTERNS_DRIVER)) {
 415                     line = 4;
 416                 }
 417
 418                 //
 419                 // For Call Back
 420                 //
 421                 if (vid.getExterns(index).getType().equals(EnumerationData.EXTERNS_CALL_BACK)) {
 422                     line = 2;
 423                 }
 424
 425                 model.addRow(vid.toStringVector(index));
 426                 jTable.setRowHeight(index, line * 18);
 427             }
 428         }
 429         this.jTable.repaint();
 430         this.jTable.updateUI();
 431     }
 432
 433     /* (non-Javadoc)
 434      * @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
 435      *
 436      * Override actionPerformed to listen all actions
 437      *
 438      */
 439     public void actionPerformed(ActionEvent arg0) {
 440         if (arg0.getSource() == jButtonAdd) {
 441             showEdit(-1);
 442         }
 443         if (arg0.getSource() == jButtonUpdate) {
 444             if (this.selectedRow < 0) {
 445                 Log.wrn("Update Externs", "Please select one record first.");
 446                 return;
 447             }
 448             showEdit(selectedRow);
 449         }
 450
 451         if (arg0.getSource() == jButtonRemove) {
 452             if (jTable.isEditing()) {
 453                 jTable.getCellEditor().stopCellEditing();
 454             }
 455             if (selectedRow > -1) {
 456                 this.model.removeRow(selectedRow);
 457                 this.vid.removeExterns(selectedRow);
 458                 selectedRow = -1;
 459                 this.save();
 460             }
 461         }
 462     }
 463
 464     /**
 465      Save all components of Externs
 466      if exists externs, set the value directly
 467      if not exists externs, new an instance first
 468
 469      **/
 470     public void save() {
 471         try {
 472             int count = this.vid.size();
 473
 474             //
 475             // Save pcd and flash map information first
 476             //
 477             Externs ex = Externs.Factory.newInstance();
 478             if (this.externs != null) {
 479                 if (this.externs.getPcdIsDriver() != null) {
 480                     ex.setPcdIsDriver(this.externs.getPcdIsDriver());
 481                 }
 482                 if (this.externs.getTianoR8FlashMapH()) {
 483                     ex.setTianoR8FlashMapH(this.externs.getTianoR8FlashMapH());
 484                 }
 485             }
 486             this.externs = ex;
 487
 488             //
 489             // Save externs
 490             //
 491             if (count > 0) {
 492                 for (int index = 0; index < count; index++) {
 493                     //
 494                     // Save specfication
 495                     //
 496                     if (vid.getExterns(index).getType().equals(EnumerationData.EXTERNS_SPECIFICATION)) {
 497                         if (!isEmpty(vid.getExterns(index).getName0())) {
 498                             this.externs.addNewSpecification();
 499                             this.externs.setSpecificationArray(externs.getSpecificationList().size() - 1,
 500                                                                vid.getExterns(index).getName0());
 501                             continue;
 502                         }
 503                     }
 504
 505                     Extern e = Extern.Factory.newInstance();
 506                     //
 507                     // Save image
 508                     //
 509                     if (vid.getExterns(index).getType().equals(EnumerationData.EXTERNS_IMAGE)) {
 510                         if (!isEmpty(vid.getExterns(index).getName0()) || !isEmpty(vid.getExterns(index).getName1())) {
 511                             e = Extern.Factory.newInstance();
 512                             if (!isEmpty(vid.getExterns(index).getName0())) {
 513                                 e.setModuleEntryPoint(vid.getExterns(index).getName0());
 514                             }
 515                             if (!isEmpty(vid.getExterns(index).getName1())) {
 516                                 e.setModuleUnloadImage(vid.getExterns(index).getName1());
 517                             }
 518                         }
 519                     }
 520
 521                     //
 522                     // Save library
 523                     //
 524                     if (vid.getExterns(index).getType().equals(EnumerationData.EXTERNS_LIBRARY)) {
 525                         if (!isEmpty(vid.getExterns(index).getName0()) || !isEmpty(vid.getExterns(index).getName1())) {
 526                             e = Extern.Factory.newInstance();
 527                             if (!isEmpty(vid.getExterns(index).getName0())) {
 528                                 e.setConstructor(vid.getExterns(index).getName0());
 529                             }
 530                             if (!isEmpty(vid.getExterns(index).getName1())) {
 531                                 e.setDestructor(vid.getExterns(index).getName1());
 532                             }
 533                         }
 534                     }
 535
 536                     //
 537                     // Save call back
 538                     //
 539                     if (vid.getExterns(index).getType().equals(EnumerationData.EXTERNS_CALL_BACK)) {
 540                         if (!isEmpty(vid.getExterns(index).getName0()) || !isEmpty(vid.getExterns(index).getName1())) {
 541                             e = Extern.Factory.newInstance();
 542                             if (!isEmpty(vid.getExterns(index).getName0())) {
 543                                 e.setSetVirtualAddressMapCallBack(vid.getExterns(index).getName0());
 544                             }
 545                             if (!isEmpty(vid.getExterns(index).getName1())) {
 546                                 e.setExitBootServicesCallBack(vid.getExterns(index).getName1());
 547                             }
 548                         }
 549                     }
 550
 551                     //
 552                     // Save driver
 553                     //
 554                     if (vid.getExterns(index).getType().equals(EnumerationData.EXTERNS_DRIVER)) {
 555                         if (!isEmpty(vid.getExterns(index).getName0()) || !isEmpty(vid.getExterns(index).getName1())
 556                             || !isEmpty(vid.getExterns(index).getName2()) || !isEmpty(vid.getExterns(index).getName3())) {
 557                             e = Extern.Factory.newInstance();
 558                             if (!isEmpty(vid.getExterns(index).getName0())) {
 559                                 e.setDriverBinding(vid.getExterns(index).getName0());
 560                             }
 561                             if (!isEmpty(vid.getExterns(index).getName1())) {
 562                                 e.setComponentName(vid.getExterns(index).getName1());
 563                             }
 564                             if (!isEmpty(vid.getExterns(index).getName2())) {
 565                                 e.setDriverConfig(vid.getExterns(index).getName2());
 566                             }
 567                             if (!isEmpty(vid.getExterns(index).getName3())) {
 568                                 e.setDriverDiag(vid.getExterns(index).getName3());
 569                             }
 570                         }
 571                     }
 572
 573                     //
 574                     // Save common data
 575                     //
 576                     if (!isEmpty(vid.getExterns(index).getFeatureFlag())) {
 577                         e.setFeatureFlag(vid.getExterns(index).getFeatureFlag());
 578                     }
 579                     if (vid.getExterns(index).getSupArchList() != null
 580                         && vid.getExterns(index).getSupArchList().size() > 0) {
 581                         e.setSupArchList(vid.getExterns(index).getSupArchList());
 582                     }
 583
 584                     this.externs.addNewExtern();
 585                     this.externs.setExternArray(this.externs.getExternList().size() - 1, e);
 586                 }
 587             }
 588
 589             this.msa.setExterns(externs);
 590             this.omt.setSaved(false);
 591         } catch (Exception e) {
 592             Log.wrn("Update Externs", e.getMessage());
 593             Log.err("Update Externs", e.getMessage());
 594         }
 595     }
 596
 597     /* (non-Javadoc)
 598      * @see javax.swing.event.ListSelectionListener#valueChanged(javax.swing.event.ListSelectionEvent)
 599      *
 600      */
 601     public void valueChanged(ListSelectionEvent arg0) {
 602         if (arg0.getValueIsAdjusting()) {
 603             return;
 604         }
 605         ListSelectionModel lsm = (ListSelectionModel) arg0.getSource();
 606         if (lsm.isSelectionEmpty()) {
 607             return;
 608         } else {
 609             selectedRow = lsm.getMinSelectionIndex();
 610         }
 611     }
 612
 613     /* (non-Javadoc)
 614      * @see java.awt.event.MouseListener#mouseClicked(java.awt.event.MouseEvent)
 615      *
 616      */
 617     public void mouseClicked(MouseEvent arg0) {
 618         if (arg0.getClickCount() == 2) {
 619             if (this.selectedRow < 0) {
 620                 return;
 621             } else {
 622                 showEdit(selectedRow);
 623             }
 624         }
 625     }
 626
 627     /* (non-Javadoc)
 628      * @see java.awt.event.ComponentListener#componentResized(java.awt.event.ComponentEvent)
 629      *
 630      * Override componentResized to resize all components when frame's size is changed
 631      */
 632     public void componentResized(ComponentEvent arg0) {
 633         int intCurrentWidth = this.getJContentPane().getWidth();
 634         int intCurrentHeight = this.getJContentPane().getHeight();
 635         int intPreferredWidth = this.getJContentPane().getPreferredSize().width;
 636         int intPreferredHeight = this.getJContentPane().getPreferredSize().height;
 637
 638         Tools.resizeComponent(this.jScrollPaneTable, intCurrentWidth, intCurrentHeight, intPreferredWidth,
 639                               intPreferredHeight);
 640         Tools.relocateComponent(this.jButtonAdd, intCurrentWidth, intCurrentHeight, intPreferredWidth,
 641                                 intPreferredHeight, DataType.SPACE_TO_RIGHT_FOR_ADD_BUTTON,
 642                                 DataType.SPACE_TO_BOTTOM_FOR_ADD_BUTTON);
 643         Tools.relocateComponent(this.jButtonRemove, intCurrentWidth, intCurrentHeight, intPreferredWidth,
 644                                 intPreferredHeight, DataType.SPACE_TO_RIGHT_FOR_REMOVE_BUTTON,
 645                                 DataType.SPACE_TO_BOTTOM_FOR_REMOVE_BUTTON);
 646         Tools.relocateComponent(this.jButtonUpdate, intCurrentWidth, intCurrentHeight, intPreferredWidth,
 647                                 intPreferredHeight, DataType.SPACE_TO_RIGHT_FOR_UPDATE_BUTTON,
 648                                 DataType.SPACE_TO_BOTTOM_FOR_UPDATE_BUTTON);
 649     }
 650 }