Tools/Source/MigrationTools/org/tianocore/migration/SourceFileReplacer.java

   1 /** @file
   2
   3  Copyright (c) 2006, Intel Corporation
   4  All rights reserved. This program and the accompanying materials
   5  are licensed and made available under the terms and conditions of the BSD License
   6  which accompanies this distribution.  The full text of the license may be found at
   7  http://opensource.org/licenses/bsd-license.php
   8
   9  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12  **/
  13 package org.tianocore.migration;
  14
  15 import java.io.*;
  16 import java.util.*;
  17 import java.util.regex.Matcher;
  18 import java.util.regex.Pattern;
  19
  20 public class SourceFileReplacer {
  21         SourceFileReplacer(String path, ModuleInfo moduleinfo, Database database, UI fp) {
  22                 modulepath = path;
  23                 mi = moduleinfo;
  24                 db = database;
  25                 ui = fp;
  26         }
  27         private String modulepath;
  28         private ModuleInfo mi;
  29         private Database db;
  30         private UI ui;
  31         private boolean showdetails = false;
  32
  33         private class r8tor9 {
  34                 r8tor9(String r8, String r9) {
  35                         r8thing = r8;
  36                         r9thing = r9;
  37                 }
  38                 public String r8thing;
  39                 public String r9thing;
  40         }
  41
  42         // these sets are used only for printing log of the changes in current file
  43         private Set<r8tor9> filefunc = new HashSet<r8tor9>();
  44         private Set<r8tor9> filemacro = new HashSet<r8tor9>();
  45         private Set<r8tor9> fileguid = new HashSet<r8tor9>();
  46         private Set<r8tor9> fileppi = new HashSet<r8tor9>();
  47         private Set<r8tor9> fileprotocol = new HashSet<r8tor9>();
  48         private Set<String> filer8only = new HashSet<String>();
  49
  50         private String r8only = "EfiLibInstallDriverBinding " +
  51                         "EfiLibInstallAllDriverProtocols " +
  52                         "EfiLibCompareLanguage " +
  53                         "BufToHexString " +
  54                         "EfiStrTrim " +                                                 //is the r8only lib going to be enlarged????  Caution !!!!
  55                         "EfiValueToHexStr " +
  56                         "HexStringToBuf " +
  57                         "IsHexDigit " +
  58                         "NibbleToHexChar " +
  59                         "GetHob " +
  60                         "GetHobListSize " +
  61                         "GetHobVersion " +
  62                         "GetHobBootMode " +
  63                         "GetCpuHobInfo " +
  64                         "GetDxeCoreHobInfo " +
  65                         "GetNextFirmwareVolumeHob " +
  66                         "GetNextGuidHob " +
  67                         "GetPalEntryHobInfo " +
  68                         "GetIoPortSpaceAddressHobInfo ";
  69
  70         public void flush() throws Exception {
  71                 PrintWriter outfile;
  72                 String outname = null;
  73                 String inname = null;
  74                 if (ui.yesOrNo("Changes will be made to the Source Code.  View details?")) {
  75                         showdetails = true;
  76                 }
  77
  78                 Iterator<String> di = mi.localmodulesources.iterator();
  79                 while (di.hasNext()) {
  80                         inname = di.next();
  81                         if (inname.contains(".c") || inname.contains(".C")) {
  82                                 if (inname.contains(".C")) {
  83                                         outname = inname.replaceFirst(".C", ".c");
  84                                 } else {
  85                                         outname = inname;
  86                                 }
  87                                 ui.println("\nModifying file: " + inname);
  88                                 Common.string2file(sourcefilereplace(modulepath + File.separator + "temp" + File.separator + inname), modulepath + File.separator + "result" + File.separator + outname);
  89                                 /*
  90                                 Common.ensureDir(modulepath + File.separator + "result" + File.separator + outname);
  91                                 outfile = new PrintWriter(new BufferedWriter(new FileWriter(modulepath + File.separator + "result" + File.separator + outname)));
  92                                 outfile.append(sourcefilereplace(modulepath + File.separator + "temp" + File.separator + inname));
  93                                 outfile.flush();
  94                                 outfile.close();
  95                                 */
  96                         } else if (inname.contains(".h") || inname.contains(".H") || inname.contains(".dxs") || inname.contains(".uni")) {
  97                                 if (inname.contains(".H")) {
  98                                         outname = inname.replaceFirst(".H", ".h");
  99                                 } else {
 100                                         outname = inname;
 101                                 }
 102                                 ui.println("\nCopying file: " + inname);
 103                                 Common.string2file(Common.file2string(modulepath + File.separator + "temp" + File.separator + inname), modulepath + File.separator + "result" + File.separator + outname);
 104                                 /*
 105                                 Common.ensureDir(modulepath + File.separator + "result" + File.separator + outname);
 106                                 outfile = new PrintWriter(new BufferedWriter(new FileWriter(modulepath + File.separator + "result" + File.separator + outname)));
 107                                 outfile.append(Common.file2string(modulepath + File.separator + "temp" + File.separator + inname));
 108                                 outfile.flush();
 109                                 outfile.close();
 110                                 */
 111                         }
 112                 }
 113
 114                 if (!mi.hashr8only.isEmpty()) {
 115                         addr8only();
 116                 }
 117         }
 118
 119         private void addr8only() throws Exception {
 120                 String paragraph = null;
 121                 String line = Common.file2string(Database.defaultpath + File.separator + "R8Lib.c");
 122                 Common.ensureDir(modulepath + File.separator + "result" + File.separator + "R8Lib.c");
 123                 PrintWriter outfile1 = new PrintWriter(new BufferedWriter(new FileWriter(modulepath + File.separator + "result" + File.separator + "R8Lib.c")));
 124                 PrintWriter outfile2 = new PrintWriter(new BufferedWriter(new FileWriter(modulepath + File.separator + "result" + File.separator + "R8Lib.h")));
 125                 Pattern ptnr8only = Pattern.compile("////#?(\\w*)?.*?R8_(\\w*).*?////~", Pattern.DOTALL);
 126                 Matcher mtrr8only = ptnr8only.matcher(line);
 127                 Matcher mtrr8onlyhead;
 128                 while (mtrr8only.find()) {
 129                         if (mi.hashr8only.contains(mtrr8only.group(2))) {
 130                                 paragraph = mtrr8only.group();
 131                                 outfile1.append(paragraph + "\n\n");
 132                                 if (mtrr8only.group(1).length() != 0) {
 133                                         mi.hashrequiredr9libs.add(mtrr8only.group(1));
 134                                 }
 135                                 //generate R8lib.h
 136                                 while ((mtrr8onlyhead = Func.ptnbrace.matcher(paragraph)).find()) {
 137                                         paragraph = mtrr8onlyhead.replaceAll(";");
 138                                 }
 139                                 outfile2.append(paragraph + "\n\n");
 140                         }
 141                 }
 142                 outfile1.flush();
 143                 outfile1.close();
 144                 outfile2.flush();
 145                 outfile2.close();
 146
 147                 mi.localmodulesources.add("R8Lib.h");
 148                 mi.localmodulesources.add("R8Lib.c");
 149         }
 150
 151         // Caution : if there is @ in file , it will be replaced with \n , so is you use Doxygen ... God Bless you!
 152         private String sourcefilereplace(String filename) throws Exception {
 153                 BufferedReader rd = new BufferedReader(new FileReader(filename));
 154                 StringBuffer wholefile = new StringBuffer();
 155                 String line;
 156                 String r8thing;
 157                 String r9thing;
 158                 r8tor9 temp;
 159                 boolean addr8 = false;
 160
 161                 Pattern pat = Pattern.compile("g?(BS|RT)(\\s*->\\s*)([a-zA-Z_]\\w*)", Pattern.MULTILINE);                                       // ! only two level () bracket allowed !
 162                 //Pattern ptnpei = Pattern.compile("\\(\\*\\*?PeiServices\\)[.-][>]?\\s*(\\w*[#$]*)(\\s*\\(([^\\(\\)]*(\\([^\\(\\)]*\\))?[^\\(\\)]*)*\\))", Pattern.MULTILINE);
 163
 164                 while ((line = rd.readLine()) != null) {
 165                         wholefile.append(line + "\n");
 166                 }
 167                 line = wholefile.toString();
 168
 169                 // replace BS -> gBS , RT -> gRT
 170                 Matcher mat = pat.matcher(line);
 171                 if (mat.find()) {                                                                                               // add a library here
 172                         ui.println("Converting all BS->gBS, RT->gRT");
 173                         line = mat.replaceAll("g$1$2$3");                                                       //unknown correctiveness
 174                 }
 175                 mat.reset();
 176                 while (mat.find()) {
 177                         if (mat.group(1).matches("BS")) {
 178                                 mi.hashrequiredr9libs.add("UefiBootServicesTableLib");
 179                         }
 180                         if (mat.group(1).matches("RT")) {
 181                                 mi.hashrequiredr9libs.add("UefiRuntimeServicesTableLib");
 182                         }
 183                 }
 184                 /*
 185                 // remove EFI_DRIVER_ENTRY_POINT
 186                 Pattern patentrypoint = Pattern.compile("EFI_DRIVER_ENTRY_POINT[^\\}]*\\}");
 187                 Matcher matentrypoint = patentrypoint.matcher(line);
 188                 if (matentrypoint.find()) {
 189                         ui.println("Deleting Entry_Point");
 190                         line = matentrypoint.replaceAll("");
 191                 }
 192                 */
 193                 // start replacing names
 194                 Iterator<String> it;
 195                 // Converting non-locla function
 196                 it = mi.hashnonlocalfunc.iterator();
 197                 while (it.hasNext()) {
 198                         r8thing = it.next();
 199                         if (r8thing.matches("EfiInitializeDriverLib")) {                                        //s
 200                                 mi.hashrequiredr9libs.add("UefiBootServicesTableLib");                  //p
 201                                 mi.hashrequiredr9libs.add("UefiRuntimeServicesTableLib");               //e
 202                         } else if (r8thing.matches("DxeInitializeDriverLib")) {                         //c
 203                                 mi.hashrequiredr9libs.add("UefiBootServicesTableLib");                  //i
 204                                 mi.hashrequiredr9libs.add("UefiRuntimeServicesTableLib");               //a
 205                                 mi.hashrequiredr9libs.add("DxeServicesTableLib");                               //l
 206                         } else {                                                                                                                        //
 207                                 mi.hashrequiredr9libs.add(db.getR9Lib(r8thing));                                // add a library here
 208                         }
 209
 210                         if ((r9thing = db.getR9Func(r8thing)) != null) {
 211                                 if (!r8thing.equals(r9thing)) {
 212                                         if (line.contains(r8thing)) {
 213                                                 line = line.replaceAll(r8thing, r9thing);
 214                                                 filefunc.add(new r8tor9(r8thing, r9thing));
 215                                                 Iterator<r8tor9> rt = filefunc.iterator();
 216                                                 while (rt.hasNext()) {
 217                                                         temp = rt.next();
 218                                                         if (r8only.contains(temp.r8thing)) {
 219                                                                 filer8only.add(r8thing);
 220                                                                 mi.hashr8only.add(r8thing);
 221                                                                 addr8 = true;
 222                                                         }
 223                                                 }
 224                                         }
 225                                 }
 226                         }
 227                 }                                                                                                                       //is any of the guids changed?
 228                 if (addr8 == true) {
 229                         line = line.replaceFirst("\\*/\n", "\\*/\n#include \"R8Lib.h\"\n");
 230                 }
 231
 232                 // Converting macro
 233                 it = mi.hashnonlocalmacro.iterator();
 234                 while (it.hasNext()) {                                          //macros are all assumed MdePkg currently
 235                         r8thing = it.next();
 236                         //mi.hashrequiredr9libs.add(db.getR9Lib(r8thing));
 237                         if ((r9thing = db.getR9Macro(r8thing)) != null) {
 238                                 if (line.contains(r8thing)) {
 239                                         line = line.replaceAll(r8thing, r9thing);
 240                                         filemacro.add(new r8tor9(r8thing, r9thing));
 241                                 }
 242                         }
 243                 }
 244
 245                 // Converting guid
 246                 replaceGuid(line, mi.guid, "guid", fileguid);
 247                 replaceGuid(line, mi.ppi, "ppi", fileppi);
 248                 replaceGuid(line, mi.protocol, "protocol", fileprotocol);
 249
 250                 // Converting Pei
 251                 // First , find all (**PeiServices)-> or (*PeiServices). with arg "PeiServices" , change name and add #%
 252                 Pattern ptnpei = Pattern.compile("\\(\\*\\*?PeiServices\\)[.-][>]?\\s*(\\w*)(\\s*\\(\\s*PeiServices\\s*,\\s*)", Pattern.MULTILINE);
 253                 if (mi.moduletype.contains("PEIM")) {
 254                         Matcher mtrpei = ptnpei.matcher(line);
 255                         while (mtrpei.find()) {                                                                         // ! add a library here !
 256                                 line = mtrpei.replaceAll("PeiServices$1#%$2");
 257                                 mi.hashrequiredr9libs.add("PeiServicesLib");
 258                         }
 259                         mtrpei.reset();
 260                         if (line.contains("PeiServicesCopyMem")) {
 261                                 line = line.replaceAll("PeiServicesCopyMem#%", "CopyMem");
 262                                 mi.hashrequiredr9libs.add("BaseMemoryLib");
 263                         }
 264                         if (line.contains("PeiServicesSetMem")) {
 265                                 line = line.replaceAll("PeiServicesSetMem#%", "SetMem");
 266                                 mi.hashrequiredr9libs.add("BaseMemoryLib");
 267                         }
 268
 269                         // Second , find all #% to drop the arg "PeiServices"
 270                         Pattern ptnpeiarg = Pattern.compile("#%+(\\s*\\(+\\s*)PeiServices\\s*,\\s*", Pattern.MULTILINE);
 271                         Matcher mtrpeiarg = ptnpeiarg.matcher(line);
 272                         while (mtrpeiarg.find()) {
 273                                 line = mtrpeiarg.replaceAll("$1");
 274                         }
 275                 }
 276
 277                 Matcher mtrmac;
 278                 mtrmac = Pattern.compile("EFI_IDIV_ROUND\\((.*), (.*)\\)").matcher(line);
 279                 if (mtrmac.find()) {
 280                         line = mtrmac.replaceAll("\\($1 \\/ $2 \\+ \\(\\(\\(2 \\* \\($1 \\% $2\\)\\) \\< $2\\) \\? 0 \\: 1\\)\\)");
 281                 }
 282                 mtrmac = Pattern.compile("EFI_MIN\\((.*), (.*)\\)").matcher(line);
 283                 if (mtrmac.find()) {
 284                         line = mtrmac.replaceAll("\\(\\($1 \\< $2\\) \\? $1 \\: $2\\)");
 285                 }
 286                 mtrmac = Pattern.compile("EFI_MAX\\((.*), (.*)\\)").matcher(line);
 287                 if (mtrmac.find()) {
 288                         line = mtrmac.replaceAll("\\(\\($1 \\> $2\\) \\? $1 \\: $2\\)");
 289                 }
 290                 mtrmac = Pattern.compile("EFI_UINTN_ALIGNED\\((.*)\\)").matcher(line);
 291                 if (mtrmac.find()) {
 292                         line = mtrmac.replaceAll("\\(\\(\\(UINTN\\) $1\\) \\& \\(sizeof \\(UINTN\\) \\- 1\\)\\)");
 293                 }
 294                 if (line.contains("EFI_UINTN_ALIGN_MASK")) {
 295                         line = line.replaceAll("EFI_UINTN_ALIGN_MASK", "(sizeof (UINTN) - 1)");
 296                 }
 297
 298                 show(filefunc, "function");
 299                 show(filemacro, "macro");
 300                 show(fileguid, "guid");
 301                 show(fileppi, "ppi");
 302                 show(fileprotocol, "protocol");
 303                 if (!filer8only.isEmpty()) {
 304                         ui.println("Converting r8only : " + filer8only);
 305                 }
 306
 307                 filefunc.clear();
 308                 filemacro.clear();
 309                 fileguid.clear();
 310                 fileppi.clear();
 311                 fileprotocol.clear();
 312                 filer8only.clear();
 313
 314                 return line;
 315         }
 316
 317         private void show(Set<r8tor9> hash, String sh) {
 318                 Iterator<r8tor9> it = hash.iterator();
 319                 r8tor9 temp;
 320                 if (showdetails) {
 321                         if (!hash.isEmpty()) {
 322                                 ui.print("Converting " + sh + " : ");
 323                                 while (it.hasNext()) {
 324                                         temp = it.next();
 325                                         ui.print("[" + temp.r8thing + "->" + temp.r9thing + "] ");
 326                                 }
 327                                 ui.println("");
 328                         }
 329                 }
 330         }
 331
 332         private void replaceGuid(String line, Set<String> hash, String kind, Set<r8tor9> filehash) {
 333                 Iterator<String> it;
 334                 String r8thing;
 335                 String r9thing;
 336                 it = hash.iterator();
 337                 while (it.hasNext()) {
 338                         r8thing = it.next();
 339                         if ((r9thing = db.getR9Guidname(r8thing)) != null) {
 340                                 if (!r8thing.equals(r9thing)) {
 341                                         if (line.contains(r8thing)) {
 342                                                 line = line.replaceAll(r8thing, r9thing);
 343                                                 filehash.add(new r8tor9(r8thing, r9thing));
 344                                         }
 345                                 }
 346                         }
 347                 }
 348         }
 349 }