Handle module entry point special case for self-relocated modules. (Replace reference...

[mirror_edk2.git] / Tools / Source / MigrationTools / org / tianocore / migration / SourceFileReplacer.java

/** @file\r
 \r
 Copyright (c) 2006, Intel Corporation\r
 All rights reserved. This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
 http://opensource.org/licenses/bsd-license.php\r
 \r
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
 **/\r
package org.tianocore.migration;\r
\r
import java.io.*;\r
import java.util.*;\r
import java.util.regex.Matcher;\r
import java.util.regex.Pattern;\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
        "BuildStackHob",\r
        "BuildBspStoreHob",\r
        "BuildMemoryAllocationHob"\r
        };\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 wholeline;\r
        }\r
        \r
        public boolean recognize(String filename) {\r
            return filename.contains(".h") || filename.contains(".H") || filename.contains(".uni");\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
            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
            boolean addr8 = false;\r
            // remove EFI_DRIVER_ENTRY_POINT\r
            wholeline = wholeline.replaceAll("(EFI_[A-Z]+_ENTRY_POINT\\s*\\(\\s*" + mi.entrypoint + "\\s*\\)\\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
            // start replacing names\r
            String r8thing;\r
            String r9thing;\r
            Iterator<String> it;\r
            // Converting non-locla function\r
            it = mi.hashnonlocalfunc.iterator();\r
            while (it.hasNext()) {\r
                r8thing = it.next();\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
                            wholeline = wholeline.replaceAll(r8thing, 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
            \r
            // Converting macro\r
            it = mi.hashnonlocalmacro.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
                        wholeline = wholeline.replaceAll(r8thing, r9thing);\r
                        filemacro.add(new r8tor9(r8thing, r9thing));\r
                    }\r
                }\r
            }\r
\r
            // Converting guid\r
            replaceGuid(wholeline, mi.guid, "guid", fileguid);\r
            replaceGuid(wholeline, mi.ppi, "ppi", fileppi);\r
            replaceGuid(wholeline, mi.protocol, "protocol", fileprotocol);\r
\r
            // Converting Pei\r
            // First , find all (**PeiServices)-> or (*PeiServices). with arg "PeiServices" , change name and add #%\r
            Pattern ptnpei = Pattern.compile("\\(\\*\\*?PeiServices\\)[.-][>]?\\s*(\\w*)(\\s*\\(\\s*PeiServices\\s*,\\s*)", Pattern.MULTILINE);\r
            if (mi.getModuleType().matches("PEIM")) {\r
            //if (mi.moduletype.contains("PEIM")) {\r
                Matcher mtrpei = ptnpei.matcher(wholeline);\r
                while (mtrpei.find()) {                                        // ! add a library here !\r
                    wholeline = mtrpei.replaceAll("PeiServices$1#%$2");\r
                    mi.hashrequiredr9libs.add("PeiServicesLib");\r
                }\r
                mtrpei.reset();\r
                if (wholeline.contains("PeiServicesCopyMem")) {\r
                    wholeline = wholeline.replaceAll("PeiServicesCopyMem#%", "CopyMem");\r
                    mi.hashrequiredr9libs.add("BaseMemoryLib");\r
                }\r
                if (wholeline.contains("PeiServicesSetMem")) {\r
                    wholeline = wholeline.replaceAll("PeiServicesSetMem#%", "SetMem");\r
                    mi.hashrequiredr9libs.add("BaseMemoryLib");\r
                }\r
\r
                // Second , find all #% to drop the arg "PeiServices"\r
                Pattern ptnpeiarg = Pattern.compile("#%+(\\s*\\(+\\s*)PeiServices\\s*,\\s*", Pattern.MULTILINE);\r
                Matcher mtrpeiarg = ptnpeiarg.matcher(wholeline);\r
                while (mtrpeiarg.find()) {\r
                    wholeline = mtrpeiarg.replaceAll("$1");\r
                }\r
            }\r
            \r
            wholeline = hobLibFuncDropStatus(wholeline);\r
            \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
\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 hobLibFuncDropStatus(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
            ptnhobstatus = Pattern.compile("(Status\\s*=\\s*)?" + specialhoblibfunc[i] + "(.*?\\)\\s*;)", Pattern.DOTALL);\r
            mtrhobstatus = ptnhobstatus.matcher(templine);\r
            if (mtrhobstatus.find()) {\r
                templine = mtrhobstatus.replaceAll(specialhoblibfunc[i] + mtrhobstatus.group(2) + "\n  //Migration comments: R9 Hob-building library functions will assert if build failure.\n  Status = EFI_SUCCESS;");\r
            }\r
        }\r
        return templine;\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.modulepath + File.separator, "");\r
        String tempinpath = mi.modulepath + File.separator + "temp" + 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.localmodulesources, this);\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