]> git.proxmox.com Git - mirror_edk2.git/blobdiff - Tools/Java/Source/MigrationTools/org/tianocore/migration/SourceFileReplacer.java
Coding Style
[mirror_edk2.git] / Tools / Java / Source / MigrationTools / org / tianocore / migration / SourceFileReplacer.java
index b8d37c3bb6eba234c46e20c0db61d007b9aa574e..488e055211dcdffe883858ceb3b08af3dc4dd2a3 100644 (file)
  **/\r
 package org.tianocore.migration;\r
 \r
-import java.io.*;\r
-import java.util.*;\r
+import java.io.BufferedWriter;\r
+import java.io.File;\r
+import java.io.FileWriter;\r
+import java.io.PrintWriter;\r
+import java.util.HashSet;\r
+import java.util.Iterator;\r
+import java.util.Set;\r
 import java.util.regex.Matcher;\r
 import java.util.regex.Pattern;\r
 \r
 import org.tianocore.UsageTypes;\r
 \r
 public final class SourceFileReplacer implements Common.ForDoAll {\r
-    private static final SourceFileReplacer SFReplacer = new SourceFileReplacer();\r
-    private ModuleInfo mi;\r
-    private static final Set<Common.Laplace> Laplaces = new HashSet<Common.Laplace>();\r
-\r
-    // these sets are used only for printing log of the changes in current file\r
-    private static final Set<r8tor9> filefunc = new HashSet<r8tor9>();\r
-    private static final Set<r8tor9> filemacro = new HashSet<r8tor9>();\r
-    private static final Set<r8tor9> fileguid = new HashSet<r8tor9>();\r
-    private static final Set<r8tor9> fileppi = new HashSet<r8tor9>();\r
-    private static final Set<r8tor9> fileprotocol = new HashSet<r8tor9>();\r
-    private static final Set<String> filer8only = new HashSet<String>();\r
-    \r
-    private static final String[] specialhoblibfunc = {\r
-        "BuildModuleHob",\r
-        "BuildResourceDescriptorHob",\r
-        "BuildFvHob",\r
-        "BuildCpuHob",\r
-        "BuildGuidDataHob",\r
-        "BuildStackHob",\r
-        "BuildBspStoreHob",\r
-        "BuildMemoryAllocationHob"\r
-        };\r
-    private static final String[] peiserviceslibfunc = {\r
-        "InstallPpi",\r
-        "ReInstallPpi",\r
-        "LocatePpi",\r
-        "NotifyPpi",\r
-        "GetBootMode",\r
-        "SetBootMode",\r
-        "GetHobList",\r
-        "CreateHob",\r
-        "FfsFindNextVolume",\r
-        "FfsFindNextFile",\r
-        "FfsFindSectionData",\r
-        "InstallPeiMemory",\r
-        "AllocatePages",\r
-        "AllocatePool",\r
-        "PeiResetSystem"\r
-    };\r
-    //---------------------------------------inner classes---------------------------------------//\r
-    private static class r8tor9 {\r
-        r8tor9(String r8, String r9) {\r
-            r8thing = r8;\r
-            r9thing = r9;\r
-        }\r
-        public String r8thing;\r
-        public String r9thing;\r
-    }\r
-    \r
-    private class IdleLaplace extends Common.Laplace {\r
-        public String operation(String wholeline) {\r
-            return replaceLibrary (wholeline, mi.hashmacro);\r
-        }\r
-        \r
-        public boolean recognize(String filename) {\r
-            return filename.contains(".h") || filename.contains(".H") || filename.contains(".uni") ||\r
-                   filename.contains(".s") || filename.contains(".S") || filename.contains(".asm") ||\r
-                   (!filename.contains(".inf") && filename.contains(".i"));\r
-        }\r
-\r
-        public String namechange(String oldname) {\r
-            if (oldname.contains(".H")) {\r
-                return oldname.replaceFirst(".H", ".h");\r
-            } else {\r
-                return oldname;\r
-            }\r
-        }\r
-    }\r
-    private class DxsLaplace extends Common.Laplace {\r
-        public String operation(String wholeline) {\r
-            wholeline = replaceMacro(wholeline, mi.hashnonlocalmacro);\r
-            if (mi.getModuleType().equals("PEIM")) {\r
-                return addincludefile(wholeline, "\\<PeimDepex.h\\>");\r
-            } else {\r
-                return addincludefile(wholeline, "\\<DxeDepex.h\\>");\r
-            }\r
-        }\r
-        \r
-        public boolean recognize(String filename) {\r
-            return filename.contains(".dxs");\r
-        }\r
-\r
-        public String namechange(String oldname) {\r
-            return oldname;\r
-        }\r
-    }\r
-    \r
-    private class CLaplace extends Common.Laplace {\r
-        public  String operation(String wholeline) {\r
-            // remove EFI_DRIVER_ENTRY_POINT\r
-            wholeline = wholeline.replaceAll("(EFI_[A-Z]+_ENTRY_POINT\\s*\\(\\s*\\w(\\w|\\d)*\\s*\\))", MigrationTool.MIGRATIONCOMMENT + " $1");\r
-            // redefine module entry point for some self-relocated modules\r
-            wholeline = wholeline.replaceAll (mi.entrypoint + "([^{]*?})", "_ModuleEntryPoint" + "$1");\r
-            // remove R8 library contractor\r
-            wholeline = wholeline.replaceAll ("(\\b(?:Efi|Dxe)InitializeDriverLib\\b)", MigrationTool.MIGRATIONCOMMENT + " $1");\r
-            // Add Library Class for potential reference of gBS, gRT & gDS.\r
-            if (Common.find (wholeline, "\\bg?BS\\b")) {\r
-                mi.hashrequiredr9libs.add("UefiBootServicesTableLib");\r
-            }\r
-            if (Common.find (wholeline, "\\bg?RT\\b")) {\r
-                mi.hashrequiredr9libs.add ("UefiRuntimeServicesTableLib");\r
-            }\r
-            if (Common.find (wholeline, "\\bgDS\\b")) {\r
-                mi.hashrequiredr9libs.add ("DxeServicesTableLib");\r
-            }\r
-\r
-            wholeline = replaceLibrary (wholeline, mi.hashnonlocalfunc);\r
-            wholeline = replaceLibrary (wholeline, mi.hashmacro);\r
-            // Converting macro\r
-            wholeline = replaceMacro (wholeline, mi.hashnonlocalmacro);\r
-\r
-            // Converting guid\r
-            replaceGuid(wholeline, mi.guids, "guid", fileguid);\r
-            replaceGuid(wholeline, mi.ppis, "ppi", fileppi);\r
-            replaceGuid(wholeline, mi.protocols, "protocol", fileprotocol);\r
-\r
-            // Converting Pei\r
-            if (mi.getModuleType().matches("PEIM")) {\r
-                //\r
-                // Try to remove PeiServicesTablePointer;\r
-                // \r
-                wholeline = dropPeiServicesPointer (wholeline);\r
-                //\r
-                // Drop the possible return Status of Hob building function.\r
-                // \r
-                wholeline = drophobLibReturnStatus (wholeline);\r
-            }\r
-            //\r
-            // Expand obsolete R8 macro.\r
-            // \r
-            wholeline = replaceObsoleteMacro (wholeline);\r
-\r
-            show(filefunc, "function");\r
-            show(filemacro, "macro");\r
-            show(fileguid, "guid");\r
-            show(fileppi, "ppi");\r
-            show(fileprotocol, "protocol");\r
-            if (!filer8only.isEmpty()) {\r
-                MigrationTool.ui.println("Converting r8only : " + filer8only);\r
-            }\r
-\r
-            filefunc.clear();\r
-            filemacro.clear();\r
-            fileguid.clear();\r
-            fileppi.clear();\r
-            fileprotocol.clear();\r
-            filer8only.clear();\r
-\r
-            return wholeline;\r
-        }\r
-        \r
-        public boolean recognize(String filename) {\r
-            return filename.contains(".c") || filename.contains(".C");\r
-        }\r
-\r
-        public String namechange(String oldname) {\r
-            if (oldname.contains(".C")) {\r
-                return oldname.replaceFirst(".C", ".c");\r
-            } else {\r
-                return oldname;\r
-            }\r
-        }\r
-    }\r
-    //---------------------------------------inner classes---------------------------------------//\r
-\r
-    //-------------------------------------process functions-------------------------------------//\r
-    private static final String addincludefile(String wholeline, String hfile) {\r
-        return wholeline.replaceFirst("(\\*/\\s)", "$1\n#include " + hfile + "\n");\r
-    }\r
-    \r
-    private static final void show(Set<r8tor9> hash, String sh) {\r
-        Iterator<r8tor9> it = hash.iterator();\r
-        r8tor9 temp;\r
-        if (!hash.isEmpty()) {\r
-            MigrationTool.ui.print("Converting " + sh + " : ");\r
-            while (it.hasNext()) {\r
-                temp = it.next();\r
-                MigrationTool.ui.print("[" + temp.r8thing + "->" + temp.r9thing + "] ");\r
-            }\r
-            MigrationTool.ui.println("");\r
-        }\r
-    }\r
-\r
-    private static final void replaceGuid(String line, Set<String> hash, String kind, Set<r8tor9> filehash) {\r
-        Iterator<String> it;\r
-        String r8thing;\r
-        String r9thing;\r
-        it = hash.iterator();\r
-        while (it.hasNext()) {\r
-            r8thing = it.next();\r
-            if ((r9thing = MigrationTool.db.getR9Guidname(r8thing)) != null) {\r
-                if (!r8thing.equals(r9thing)) {\r
-                    if (line.contains(r8thing)) {\r
-                        line = line.replaceAll(r8thing, r9thing);\r
-                        filehash.add(new r8tor9(r8thing, r9thing));\r
-                    }\r
-                }\r
-            }\r
-        }\r
-    }\r
-\r
-    private final String dropPeiServicesPointer (String wholeline) {\r
-        String peiServicesTablePointer;\r
-        String peiServicesTableCaller;\r
-        String regPeiServices;\r
-        Pattern ptnPei;\r
-        Matcher mtrPei;\r
-\r
-        peiServicesTablePointer = "\\w(?:\\w|[0-9]|->)*";\r
-        peiServicesTableCaller  = "\\(\\*\\*?\\s*(" + peiServicesTablePointer + ")\\s*\\)[.-]>?\\s*";\r
-        for (int i = 0; i < peiserviceslibfunc.length; i++) {\r
-            regPeiServices  = peiServicesTableCaller + peiserviceslibfunc[i] + "\\s*\\(\\s*\\1\\s*,(\\t| )*"; \r
-            ptnPei = Pattern.compile (regPeiServices);\r
-            mtrPei = ptnPei.matcher (wholeline);\r
-            if (mtrPei.find()) {\r
-                wholeline = mtrPei.replaceAll("PeiServices" + peiserviceslibfunc[i] + " (");\r
-                mi.hashrequiredr9libs.add("PeiServicesLib");\r
-            }\r
-        }\r
-        regPeiServices = peiServicesTableCaller + "(CopyMem|SetMem)" + "\\s*\\((\\t| )*";\r
-        ptnPei = Pattern.compile (regPeiServices);\r
-        mtrPei = ptnPei.matcher (wholeline);\r
-        if (mtrPei.find()) {\r
-            wholeline = mtrPei.replaceAll("$2 (");\r
-            mi.hashrequiredr9libs.add("BaseMemoryLib");\r
-        }\r
-\r
-        ptnPei = Pattern.compile("#%+(\\s*\\(+\\s*)" + peiServicesTablePointer + "\\s*,\\s*", Pattern.MULTILINE);\r
-        mtrPei = ptnPei.matcher(wholeline);\r
-        while (mtrPei.find()) {\r
-            wholeline = mtrPei.replaceAll("$1");\r
-        }\r
-\r
-        return wholeline;\r
-    }\r
-\r
-    private final String drophobLibReturnStatus (String wholeline) {        // or use regex to find pattern "Status = ..."\r
-        Pattern ptnhobstatus;\r
-        Matcher mtrhobstatus;\r
-        String templine = wholeline;\r
-        for (int i = 0; i < specialhoblibfunc.length; i++) {\r
-            do {\r
-                ptnhobstatus = Pattern.compile("((?:\t| )*)(\\w(?:\\w|\\d)*)\\s*=\\s*" + specialhoblibfunc[i] + "(.*?;)", Pattern.DOTALL);\r
-                mtrhobstatus = ptnhobstatus.matcher(templine);\r
-                if (!mtrhobstatus.find()) {\r
-                    break;\r
-                }\r
-                String captureIndent = mtrhobstatus.group(1);\r
-                String captureStatus = mtrhobstatus.group(2);\r
-                String replaceString = captureIndent + specialhoblibfunc[i] + mtrhobstatus.group(3) + "\n";\r
-                replaceString += captureIndent + MigrationTool.MIGRATIONCOMMENT +  "R9 Hob-building library functions will assert if build failure.\n";\r
-                replaceString += captureIndent + captureStatus + " = EFI_SUCCESS;";\r
-                templine = mtrhobstatus.replaceFirst(replaceString);\r
-            } while (true);\r
-        }\r
-        return templine;\r
-    }\r
-\r
-    private final String replaceMacro (String wholeline, Set<String> symbolSet) {\r
-        String r8thing;\r
-        String r9thing;\r
-        Iterator<String> it;\r
-\r
-        it = symbolSet.iterator();\r
-        while (it.hasNext()) {                        //macros are all assumed MdePkg currently\r
-            r8thing = it.next();\r
-            //mi.hashrequiredr9libs.add(MigrationTool.db.getR9Lib(r8thing));        \r
-            if ((r9thing = MigrationTool.db.getR9Macro(r8thing)) != null) {\r
-                if (wholeline.contains(r8thing)) {\r
-                    String findString = "(?<!(?:\\d|\\w))" + r8thing + "(?!(?:\\d|\\w))";\r
-                    wholeline = wholeline.replaceAll(findString, r9thing);\r
-                    filemacro.add(new r8tor9(r8thing, r9thing));\r
-                }\r
-            }\r
-        }\r
-        return wholeline;\r
-    }\r
-\r
-    private final String replaceLibrary (String wholeline, Set<String> symbolSet) {\r
-        boolean addr8 = false;\r
-        // start replacing names\r
-        String r8thing;\r
-        String r9thing;\r
-        Iterator<String> it;\r
-        // Converting non-locla function\r
-        it = symbolSet.iterator();\r
-        while (it.hasNext()) {\r
-            r8thing = it.next();\r
-            mi.addLibraryClass(MigrationTool.db.getR9Lib(r8thing), UsageTypes.ALWAYS_CONSUMED);\r
-            //mi.hashrequiredr9libs.add(MigrationTool.db.getR9Lib(r8thing));            // add a library here\r
\r
-            r8tor9 temp;\r
-            if ((r9thing = MigrationTool.db.getR9Func(r8thing)) != null) {\r
-                if (!r8thing.equals(r9thing)) {\r
-                    if (wholeline.contains(r8thing)) {\r
-                       String findString = "(?<!(?:\\d|\\w))" + r8thing + "(?!(?:\\d|\\w))";\r
-                        wholeline = wholeline.replaceAll(findString, r9thing);\r
-                        filefunc.add(new r8tor9(r8thing, r9thing));\r
-                        Iterator<r8tor9> rt = filefunc.iterator();\r
-                        while (rt.hasNext()) {\r
-                            temp = rt.next();\r
-                            if (MigrationTool.db.r8only.contains(temp.r8thing)) {\r
-                                filer8only.add(r8thing);\r
-                                mi.hashr8only.add(r8thing);\r
-                                addr8 = true;\r
-                            }\r
-                        }\r
-                    }\r
-                }\r
-            }\r
-        }                                                            //is any of the guids changed?\r
-        if (addr8 == true) {\r
-            wholeline = addincludefile(wholeline, "\"R8Lib.h\"");\r
-        }\r
-        return wholeline;\r
-    }\r
-\r
-    private final String replaceObsoleteMacro (String wholeline) {\r
-        Matcher mtrmac;\r
-        mtrmac = Pattern.compile("EFI_IDIV_ROUND\\((.*), (.*)\\)").matcher(wholeline);\r
-        if (mtrmac.find()) {\r
-            wholeline = mtrmac.replaceAll("\\($1 \\/ $2 \\+ \\(\\(\\(2 \\* \\($1 \\% $2\\)\\) \\< $2\\) \\? 0 \\: 1\\)\\)");\r
-        }\r
-        mtrmac = Pattern.compile("EFI_MIN\\((.*), (.*)\\)").matcher(wholeline);\r
-        if (mtrmac.find()) {\r
-            wholeline = mtrmac.replaceAll("\\(\\($1 \\< $2\\) \\? $1 \\: $2\\)");\r
-        }\r
-        mtrmac = Pattern.compile("EFI_MAX\\((.*), (.*)\\)").matcher(wholeline);\r
-        if (mtrmac.find()) {\r
-            wholeline = mtrmac.replaceAll("\\(\\($1 \\> $2\\) \\? $1 \\: $2\\)");\r
-        }\r
-        mtrmac = Pattern.compile("EFI_UINTN_ALIGNED\\((.*)\\)").matcher(wholeline);\r
-        if (mtrmac.find()) {\r
-            wholeline = mtrmac.replaceAll("\\(\\(\\(UINTN\\) $1\\) \\& \\(sizeof \\(UINTN\\) \\- 1\\)\\)");\r
-        }\r
-        if (wholeline.contains("EFI_UINTN_ALIGN_MASK")) {\r
-            wholeline = wholeline.replaceAll("EFI_UINTN_ALIGN_MASK", "(sizeof (UINTN) - 1)");\r
-        }\r
-        return wholeline;\r
-    }\r
-\r
-    private final void addr8only() throws Exception {\r
-        String paragraph = null;\r
-        String line = Common.file2string(MigrationTool.db.DatabasePath + File.separator + "R8Lib.c");\r
-        PrintWriter outfile1 = new PrintWriter(new BufferedWriter(new FileWriter(MigrationTool.ModuleInfoMap.get(mi) + File.separator + "Migration_" + mi.modulename + File.separator + "R8Lib.c")));\r
-        PrintWriter outfile2 = new PrintWriter(new BufferedWriter(new FileWriter(MigrationTool.ModuleInfoMap.get(mi) + File.separator + "Migration_" + mi.modulename + File.separator + "R8Lib.h")));\r
-        Pattern ptnr8only = Pattern.compile("////#?(\\w*)?(.*?R8_(\\w*).*?)////~", Pattern.DOTALL);\r
-        Matcher mtrr8only = ptnr8only.matcher(line);\r
-        Matcher mtrr8onlyhead;\r
-        \r
-        //add head comment\r
-        Matcher mtrr8onlyheadcomment = Critic.PTN_NEW_HEAD_COMMENT.matcher(line);\r
-        if (mtrr8onlyheadcomment.find()) {\r
-            outfile1.append(mtrr8onlyheadcomment.group() + "\n\n");\r
-            outfile2.append(mtrr8onlyheadcomment.group() + "\n\n");\r
-        }\r
-        \r
-        //add functions body\r
-        while (mtrr8only.find()) {\r
-            if (mi.hashr8only.contains(mtrr8only.group(3))) {\r
-                paragraph = mtrr8only.group(2);\r
-                outfile1.append(paragraph + "\n\n");\r
-                if (mtrr8only.group(1).length() != 0) {\r
-                    mi.hashrequiredr9libs.add(mtrr8only.group(1));\r
-                }\r
-                //generate R8lib.h\r
-                while ((mtrr8onlyhead = Func.ptnbrace.matcher(paragraph)).find()) {\r
-                    paragraph = mtrr8onlyhead.replaceAll(";");\r
-                }\r
-                outfile2.append(paragraph + "\n\n");\r
-            }\r
-        }\r
-        outfile1.flush();\r
-        outfile1.close();\r
-        outfile2.flush();\r
-        outfile2.close();\r
-        \r
-        mi.localmodulesources.add("R8Lib.h");\r
-        mi.localmodulesources.add("R8Lib.c");\r
-    }\r
-    //-------------------------------------process functions-------------------------------------//\r
-    \r
-    //-----------------------------------ForDoAll-----------------------------------//\r
-    public void run(String filepath) throws Exception {\r
-        String inname = filepath.replace(mi.temppath + File.separator, "");\r
-        String tempinpath = mi.temppath + File.separator;\r
-        String tempoutpath = MigrationTool.ModuleInfoMap.get(mi) + File.separator + "Migration_" + mi.modulename + File.separator;\r
-\r
-        Iterator<Common.Laplace> itLaplace = Laplaces.iterator();\r
-        while (itLaplace.hasNext()) {\r
-            Common.Laplace lap = itLaplace.next();\r
-            if (lap.recognize(inname)) {\r
-                MigrationTool.ui.println("\nHandling file: " + inname);\r
-                lap.transform(tempinpath + inname, tempoutpath + lap.namechange(inname));\r
-            }\r
-        }\r
-    }\r
-    \r
-    public boolean filter(File dir) {\r
-        return true;\r
-    }\r
-    //-----------------------------------ForDoAll-----------------------------------//\r
-    \r
-    private final void setModuleInfo(ModuleInfo moduleinfo) {\r
-        mi = moduleinfo;\r
-    }\r
-    \r
-    private final void start() throws Exception {\r
-        Laplaces.add(new DxsLaplace());\r
-        Laplaces.add(new CLaplace());\r
-        Laplaces.add(new IdleLaplace());\r
-        \r
-        Common.toDoAll(mi.temppath, this, Common.FILE);\r
-        \r
-        if (!mi.hashr8only.isEmpty()) {\r
-            addr8only();\r
-        }\r
-        \r
-        Laplaces.clear();\r
-    }\r
-    \r
-    public static final void fireAt(ModuleInfo moduleinfo) throws Exception {\r
-        SFReplacer.setModuleInfo(moduleinfo);\r
-        SFReplacer.start();\r
-    }\r
+       private static final SourceFileReplacer SFReplacer = new SourceFileReplacer();\r
+\r
+       private ModuleInfo mi;\r
+\r
+       private static final Set<Common.Laplace> Laplaces = new HashSet<Common.Laplace>();\r
+\r
+       // these sets are used only for printing log of the changes in current file\r
+       private static final Set<r8tor9> filefunc = new HashSet<r8tor9>();\r
+\r
+       private static final Set<r8tor9> filemacro = new HashSet<r8tor9>();\r
+\r
+       private static final Set<r8tor9> fileguid = new HashSet<r8tor9>();\r
+\r
+       private static final Set<r8tor9> fileppi = new HashSet<r8tor9>();\r
+\r
+       private static final Set<r8tor9> fileprotocol = new HashSet<r8tor9>();\r
+\r
+       private static final Set<String> filer8only = new HashSet<String>();\r
+\r
+       private static final String[] specialhoblibfunc = { "BuildModuleHob",\r
+                       "BuildResourceDescriptorHob", "BuildFvHob", "BuildCpuHob",\r
+                       "BuildGuidDataHob", "BuildStackHob", "BuildBspStoreHob",\r
+                       "BuildMemoryAllocationHob" };\r
+\r
+       private static final String[] peiserviceslibfunc = { "InstallPpi",\r
+                       "ReInstallPpi", "LocatePpi", "NotifyPpi", "GetBootMode",\r
+                       "SetBootMode", "GetHobList", "CreateHob", "FfsFindNextVolume",\r
+                       "FfsFindNextFile", "FfsFindSectionData", "InstallPeiMemory",\r
+                       "AllocatePages", "AllocatePool", "PeiResetSystem" };\r
+\r
+       // ---------------------------------------inner\r
+       // classes---------------------------------------//\r
+       private static class r8tor9 {\r
+               r8tor9(String r8, String r9) {\r
+                       r8thing = r8;\r
+                       r9thing = r9;\r
+               }\r
+\r
+               public String r8thing;\r
+\r
+               public String r9thing;\r
+       }\r
+\r
+       private class IdleLaplace extends Common.Laplace {\r
+               public String operation(String wholeline) {\r
+                       return replaceLibrary(wholeline, mi.hashmacro);\r
+               }\r
+\r
+               public boolean recognize(String filename) {\r
+                       return filename.contains(".h") || filename.contains(".H")\r
+                                       || filename.contains(".uni") || filename.contains(".s")\r
+                                       || filename.contains(".S") || filename.contains(".asm")\r
+                                       || (!filename.contains(".inf") && filename.contains(".i"));\r
+               }\r
+\r
+               public String namechange(String oldname) {\r
+                       if (oldname.contains(".H")) {\r
+                               return oldname.replaceFirst(".H", ".h");\r
+                       } else {\r
+                               return oldname;\r
+                       }\r
+               }\r
+       }\r
+\r
+       private class DxsLaplace extends Common.Laplace {\r
+               public String operation(String wholeline) {\r
+                       wholeline = replaceMacro(wholeline, mi.hashnonlocalmacro);\r
+                       if (mi.getModuleType().equals("PEIM")) {\r
+                               return addincludefile(wholeline, "\\<PeimDepex.h\\>");\r
+                       } else {\r
+                               return addincludefile(wholeline, "\\<DxeDepex.h\\>");\r
+                       }\r
+               }\r
+\r
+               public boolean recognize(String filename) {\r
+                       return filename.contains(".dxs");\r
+               }\r
+\r
+               public String namechange(String oldname) {\r
+                       return oldname;\r
+               }\r
+       }\r
+\r
+       private class CLaplace extends Common.Laplace {\r
+               public String operation(String wholeline) {\r
+                       // remove EFI_DRIVER_ENTRY_POINT\r
+                       wholeline = wholeline.replaceAll(\r
+                                       "(EFI_[A-Z]+_ENTRY_POINT\\s*\\(\\s*\\w(\\w|\\d)*\\s*\\))",\r
+                                       MigrationTool.MIGRATIONCOMMENT + " $1");\r
+                       // redefine module entry point for some self-relocated modules\r
+                       wholeline = wholeline.replaceAll(mi.entrypoint + "([^{]*?})",\r
+                                       "_ModuleEntryPoint" + "$1");\r
+                       // remove R8 library contractor\r
+                       wholeline = wholeline.replaceAll(\r
+                                       "(\\b(?:Efi|Dxe)InitializeDriverLib\\b)",\r
+                                       MigrationTool.MIGRATIONCOMMENT + " $1");\r
+                       // Add Library Class for potential reference of gBS, gRT & gDS.\r
+                       if (Common.find(wholeline, "\\bg?BS\\b")) {\r
+                               mi.hashrequiredr9libs.add("UefiBootServicesTableLib");\r
+                       }\r
+                       if (Common.find(wholeline, "\\bg?RT\\b")) {\r
+                               mi.hashrequiredr9libs.add("UefiRuntimeServicesTableLib");\r
+                       }\r
+                       if (Common.find(wholeline, "\\bgDS\\b")) {\r
+                               mi.hashrequiredr9libs.add("DxeServicesTableLib");\r
+                       }\r
+\r
+                       wholeline = replaceLibrary(wholeline, mi.hashnonlocalfunc);\r
+                       wholeline = replaceLibrary(wholeline, mi.hashmacro);\r
+                       // Converting macro\r
+                       wholeline = replaceMacro(wholeline, mi.hashnonlocalmacro);\r
+\r
+                       // Converting guid\r
+                       replaceGuid(wholeline, mi.guids, "guid", fileguid);\r
+                       replaceGuid(wholeline, mi.ppis, "ppi", fileppi);\r
+                       replaceGuid(wholeline, mi.protocols, "protocol", fileprotocol);\r
+\r
+                       // Converting Pei\r
+                       if (mi.getModuleType().matches("PEIM")) {\r
+                               //\r
+                               // Try to remove PeiServicesTablePointer;\r
+                               // \r
+                               wholeline = dropPeiServicesPointer(wholeline);\r
+                               //\r
+                               // Drop the possible return Status of Hob building function.\r
+                               // \r
+                               wholeline = drophobLibReturnStatus(wholeline);\r
+                       }\r
+                       //\r
+                       // Expand obsolete R8 macro.\r
+                       // \r
+                       wholeline = replaceObsoleteMacro(wholeline);\r
+\r
+                       show(filefunc, "function");\r
+                       show(filemacro, "macro");\r
+                       show(fileguid, "guid");\r
+                       show(fileppi, "ppi");\r
+                       show(fileprotocol, "protocol");\r
+                       if (!filer8only.isEmpty()) {\r
+                               MigrationTool.ui.println("Converting r8only : " + filer8only);\r
+                       }\r
+\r
+                       filefunc.clear();\r
+                       filemacro.clear();\r
+                       fileguid.clear();\r
+                       fileppi.clear();\r
+                       fileprotocol.clear();\r
+                       filer8only.clear();\r
+\r
+                       return wholeline;\r
+               }\r
+\r
+               public boolean recognize(String filename) {\r
+                       return filename.contains(".c") || filename.contains(".C");\r
+               }\r
+\r
+               public String namechange(String oldname) {\r
+                       if (oldname.contains(".C")) {\r
+                               return oldname.replaceFirst(".C", ".c");\r
+                       } else {\r
+                               return oldname;\r
+                       }\r
+               }\r
+       }\r
+\r
+       // ---------------------------------------inner\r
+       // classes---------------------------------------//\r
+\r
+       // -------------------------------------process\r
+       // functions-------------------------------------//\r
+       private static final String addincludefile(String wholeline, String hfile) {\r
+               return wholeline.replaceFirst("(\\*/\\s)", "$1\n#include " + hfile\r
+                               + "\n");\r
+       }\r
+\r
+       private static final void show(Set<r8tor9> hash, String sh) {\r
+               Iterator<r8tor9> it = hash.iterator();\r
+               r8tor9 temp;\r
+               if (!hash.isEmpty()) {\r
+                       MigrationTool.ui.print("Converting " + sh + " : ");\r
+                       while (it.hasNext()) {\r
+                               temp = it.next();\r
+                               MigrationTool.ui.print("[" + temp.r8thing + "->" + temp.r9thing\r
+                                               + "] ");\r
+                       }\r
+                       MigrationTool.ui.println("");\r
+               }\r
+       }\r
+\r
+       private static final void replaceGuid(String line, Set<String> hash,\r
+                       String kind, Set<r8tor9> filehash) {\r
+               Iterator<String> it;\r
+               String r8thing;\r
+               String r9thing;\r
+               it = hash.iterator();\r
+               while (it.hasNext()) {\r
+                       r8thing = it.next();\r
+                       if ((r9thing = MigrationTool.db.getR9Guidname(r8thing)) != null) {\r
+                               if (!r8thing.equals(r9thing)) {\r
+                                       if (line.contains(r8thing)) {\r
+                                               line = line.replaceAll(r8thing, r9thing);\r
+                                               filehash.add(new r8tor9(r8thing, r9thing));\r
+                                       }\r
+                               }\r
+                       }\r
+               }\r
+       }\r
+\r
+       private final String dropPeiServicesPointer(String wholeline) {\r
+               String peiServicesTablePointer;\r
+               String peiServicesTableCaller;\r
+               String regPeiServices;\r
+               Pattern ptnPei;\r
+               Matcher mtrPei;\r
+\r
+               peiServicesTablePointer = "\\w(?:\\w|[0-9]|->)*";\r
+               peiServicesTableCaller = "\\(\\*\\*?\\s*(" + peiServicesTablePointer\r
+                               + ")\\s*\\)[.-]>?\\s*";\r
+               for (int i = 0; i < peiserviceslibfunc.length; i++) {\r
+                       regPeiServices = peiServicesTableCaller + peiserviceslibfunc[i]\r
+                                       + "\\s*\\(\\s*\\1\\s*,(\\t| )*";\r
+                       ptnPei = Pattern.compile(regPeiServices);\r
+                       mtrPei = ptnPei.matcher(wholeline);\r
+                       if (mtrPei.find()) {\r
+                               wholeline = mtrPei.replaceAll("PeiServices"\r
+                                               + peiserviceslibfunc[i] + " (");\r
+                               mi.hashrequiredr9libs.add("PeiServicesLib");\r
+                       }\r
+               }\r
+               regPeiServices = peiServicesTableCaller + "(CopyMem|SetMem)"\r
+                               + "\\s*\\((\\t| )*";\r
+               ptnPei = Pattern.compile(regPeiServices);\r
+               mtrPei = ptnPei.matcher(wholeline);\r
+               if (mtrPei.find()) {\r
+                       wholeline = mtrPei.replaceAll("$2 (");\r
+                       mi.hashrequiredr9libs.add("BaseMemoryLib");\r
+               }\r
+\r
+               ptnPei = Pattern.compile("#%+(\\s*\\(+\\s*)" + peiServicesTablePointer\r
+                               + "\\s*,\\s*", Pattern.MULTILINE);\r
+               mtrPei = ptnPei.matcher(wholeline);\r
+               while (mtrPei.find()) {\r
+                       wholeline = mtrPei.replaceAll("$1");\r
+               }\r
+\r
+               return wholeline;\r
+       }\r
+\r
+       private final String drophobLibReturnStatus(String wholeline) { // or use\r
+                                                                                                                                       // regex to\r
+                                                                                                                                       // find\r
+                                                                                                                                       // pattern\r
+                                                                                                                                       // "Status =\r
+                                                                                                                                       // ..."\r
+               Pattern ptnhobstatus;\r
+               Matcher mtrhobstatus;\r
+               String templine = wholeline;\r
+               for (int i = 0; i < specialhoblibfunc.length; i++) {\r
+                       do {\r
+                               ptnhobstatus = Pattern.compile(\r
+                                               "((?:\t| )*)(\\w(?:\\w|\\d)*)\\s*=\\s*"\r
+                                                               + specialhoblibfunc[i] + "(.*?;)",\r
+                                               Pattern.DOTALL);\r
+                               mtrhobstatus = ptnhobstatus.matcher(templine);\r
+                               if (!mtrhobstatus.find()) {\r
+                                       break;\r
+                               }\r
+                               String captureIndent = mtrhobstatus.group(1);\r
+                               String captureStatus = mtrhobstatus.group(2);\r
+                               String replaceString = captureIndent + specialhoblibfunc[i]\r
+                                               + mtrhobstatus.group(3) + "\n";\r
+                               replaceString += captureIndent\r
+                                               + MigrationTool.MIGRATIONCOMMENT\r
+                                               + "R9 Hob-building library functions will assert if build failure.\n";\r
+                               replaceString += captureIndent + captureStatus\r
+                                               + " = EFI_SUCCESS;";\r
+                               templine = mtrhobstatus.replaceFirst(replaceString);\r
+                       } while (true);\r
+               }\r
+               return templine;\r
+       }\r
+\r
+       private final String replaceMacro(String wholeline, Set<String> symbolSet) {\r
+               String r8thing;\r
+               String r9thing;\r
+               Iterator<String> it;\r
+\r
+               it = symbolSet.iterator();\r
+               while (it.hasNext()) { // macros are all assumed MdePkg currently\r
+                       r8thing = it.next();\r
+                       // mi.hashrequiredr9libs.add(MigrationTool.db.getR9Lib(r8thing));\r
+                       if ((r9thing = MigrationTool.db.getR9Macro(r8thing)) != null) {\r
+                               if (wholeline.contains(r8thing)) {\r
+                                       String findString = "(?<!(?:\\d|\\w))" + r8thing\r
+                                                       + "(?!(?:\\d|\\w))";\r
+                                       wholeline = wholeline.replaceAll(findString, r9thing);\r
+                                       filemacro.add(new r8tor9(r8thing, r9thing));\r
+                               }\r
+                       }\r
+               }\r
+               return wholeline;\r
+       }\r
+\r
+       private final String replaceLibrary(String wholeline, Set<String> symbolSet) {\r
+               boolean addr8 = false;\r
+               // start replacing names\r
+               String r8thing;\r
+               String r9thing;\r
+               Iterator<String> it;\r
+               // Converting non-locla function\r
+               it = symbolSet.iterator();\r
+               while (it.hasNext()) {\r
+                       r8thing = it.next();\r
+                       mi.addLibraryClass(MigrationTool.db.getR9Lib(r8thing),\r
+                                       UsageTypes.ALWAYS_CONSUMED);\r
+                       // mi.hashrequiredr9libs.add(MigrationTool.db.getR9Lib(r8thing)); //\r
+                       // add a library here\r
+\r
+                       r8tor9 temp;\r
+                       if ((r9thing = MigrationTool.db.getR9Func(r8thing)) != null) {\r
+                               if (!r8thing.equals(r9thing)) {\r
+                                       if (wholeline.contains(r8thing)) {\r
+                                               String findString = "(?<!(?:\\d|\\w))" + r8thing\r
+                                                               + "(?!(?:\\d|\\w))";\r
+                                               wholeline = wholeline.replaceAll(findString, r9thing);\r
+                                               filefunc.add(new r8tor9(r8thing, r9thing));\r
+                                               Iterator<r8tor9> rt = filefunc.iterator();\r
+                                               while (rt.hasNext()) {\r
+                                                       temp = rt.next();\r
+                                                       if (MigrationTool.db.r8only.contains(temp.r8thing)) {\r
+                                                               filer8only.add(r8thing);\r
+                                                               mi.hashr8only.add(r8thing);\r
+                                                               addr8 = true;\r
+                                                       }\r
+                                               }\r
+                                       }\r
+                               }\r
+                       }\r
+               } // is any of the guids changed?\r
+               if (addr8 == true) {\r
+                       wholeline = addincludefile(wholeline, "\"R8Lib.h\"");\r
+               }\r
+               return wholeline;\r
+       }\r
+\r
+       private final String replaceObsoleteMacro(String wholeline) {\r
+               Matcher mtrmac;\r
+               mtrmac = Pattern.compile("EFI_IDIV_ROUND\\((.*), (.*)\\)").matcher(\r
+                               wholeline);\r
+               if (mtrmac.find()) {\r
+                       wholeline = mtrmac\r
+                                       .replaceAll("\\($1 \\/ $2 \\+ \\(\\(\\(2 \\* \\($1 \\% $2\\)\\) \\< $2\\) \\? 0 \\: 1\\)\\)");\r
+               }\r
+               mtrmac = Pattern.compile("EFI_MIN\\((.*), (.*)\\)").matcher(wholeline);\r
+               if (mtrmac.find()) {\r
+                       wholeline = mtrmac\r
+                                       .replaceAll("\\(\\($1 \\< $2\\) \\? $1 \\: $2\\)");\r
+               }\r
+               mtrmac = Pattern.compile("EFI_MAX\\((.*), (.*)\\)").matcher(wholeline);\r
+               if (mtrmac.find()) {\r
+                       wholeline = mtrmac\r
+                                       .replaceAll("\\(\\($1 \\> $2\\) \\? $1 \\: $2\\)");\r
+               }\r
+               mtrmac = Pattern.compile("EFI_UINTN_ALIGNED\\((.*)\\)").matcher(\r
+                               wholeline);\r
+               if (mtrmac.find()) {\r
+                       wholeline = mtrmac\r
+                                       .replaceAll("\\(\\(\\(UINTN\\) $1\\) \\& \\(sizeof \\(UINTN\\) \\- 1\\)\\)");\r
+               }\r
+               if (wholeline.contains("EFI_UINTN_ALIGN_MASK")) {\r
+                       wholeline = wholeline.replaceAll("EFI_UINTN_ALIGN_MASK",\r
+                                       "(sizeof (UINTN) - 1)");\r
+               }\r
+               return wholeline;\r
+       }\r
+\r
+       private final void addr8only() throws Exception {\r
+               String paragraph = null;\r
+               String line = Common.file2string(MigrationTool.db.DatabasePath\r
+                               + File.separator + "R8Lib.c");\r
+               PrintWriter outfile1 = new PrintWriter(new BufferedWriter(\r
+                               new FileWriter(MigrationTool.ModuleInfoMap.get(mi)\r
+                                               + File.separator + "Migration_" + mi.modulename\r
+                                               + File.separator + "R8Lib.c")));\r
+               PrintWriter outfile2 = new PrintWriter(new BufferedWriter(\r
+                               new FileWriter(MigrationTool.ModuleInfoMap.get(mi)\r
+                                               + File.separator + "Migration_" + mi.modulename\r
+                                               + File.separator + "R8Lib.h")));\r
+               Pattern ptnr8only = Pattern.compile(\r
+                               "////#?(\\w*)?(.*?R8_(\\w*).*?)////~", Pattern.DOTALL);\r
+               Matcher mtrr8only = ptnr8only.matcher(line);\r
+               Matcher mtrr8onlyhead;\r
+\r
+               // add head comment\r
+               Matcher mtrr8onlyheadcomment = Critic.PTN_NEW_HEAD_COMMENT\r
+                               .matcher(line);\r
+               if (mtrr8onlyheadcomment.find()) {\r
+                       outfile1.append(mtrr8onlyheadcomment.group() + "\n\n");\r
+                       outfile2.append(mtrr8onlyheadcomment.group() + "\n\n");\r
+               }\r
+\r
+               // add functions body\r
+               while (mtrr8only.find()) {\r
+                       if (mi.hashr8only.contains(mtrr8only.group(3))) {\r
+                               paragraph = mtrr8only.group(2);\r
+                               outfile1.append(paragraph + "\n\n");\r
+                               if (mtrr8only.group(1).length() != 0) {\r
+                                       mi.hashrequiredr9libs.add(mtrr8only.group(1));\r
+                               }\r
+                               // generate R8lib.h\r
+                               while ((mtrr8onlyhead = Func.ptnbrace.matcher(paragraph))\r
+                                               .find()) {\r
+                                       paragraph = mtrr8onlyhead.replaceAll(";");\r
+                               }\r
+                               outfile2.append(paragraph + "\n\n");\r
+                       }\r
+               }\r
+               outfile1.flush();\r
+               outfile1.close();\r
+               outfile2.flush();\r
+               outfile2.close();\r
+\r
+               mi.localmodulesources.add("R8Lib.h");\r
+               mi.localmodulesources.add("R8Lib.c");\r
+       }\r
+\r
+       // -------------------------------------process\r
+       // functions-------------------------------------//\r
+\r
+       // -----------------------------------ForDoAll-----------------------------------//\r
+       public void run(String filepath) throws Exception {\r
+               String inname = filepath.replace(mi.temppath + File.separator, "");\r
+               String tempinpath = mi.temppath + File.separator;\r
+               String tempoutpath = MigrationTool.ModuleInfoMap.get(mi)\r
+                               + File.separator + "Migration_" + mi.modulename\r
+                               + File.separator;\r
+\r
+               Iterator<Common.Laplace> itLaplace = Laplaces.iterator();\r
+               while (itLaplace.hasNext()) {\r
+                       Common.Laplace lap = itLaplace.next();\r
+                       if (lap.recognize(inname)) {\r
+                               MigrationTool.ui.println("\nHandling file: " + inname);\r
+                               lap.transform(tempinpath + inname, tempoutpath\r
+                                               + lap.namechange(inname));\r
+                       }\r
+               }\r
+       }\r
+\r
+       public boolean filter(File dir) {\r
+               return true;\r
+       }\r
+\r
+       // -----------------------------------ForDoAll-----------------------------------//\r
+\r
+       private final void setModuleInfo(ModuleInfo moduleinfo) {\r
+               mi = moduleinfo;\r
+       }\r
+\r
+       private final void start() throws Exception {\r
+               Laplaces.add(new DxsLaplace());\r
+               Laplaces.add(new CLaplace());\r
+               Laplaces.add(new IdleLaplace());\r
+\r
+               Common.toDoAll(mi.temppath, this, Common.FILE);\r
+\r
+               if (!mi.hashr8only.isEmpty()) {\r
+                       addr8only();\r
+               }\r
+\r
+               Laplaces.clear();\r
+       }\r
+\r
+       public static final void fireAt(ModuleInfo moduleinfo) throws Exception {\r
+               SFReplacer.setModuleInfo(moduleinfo);\r
+               SFReplacer.start();\r
+       }\r
 }\r