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
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.
13 package org
.tianocore
.migration
;
17 import java
.util
.regex
.Matcher
;
18 import java
.util
.regex
.Pattern
;
20 public class SourceFileReplacer
{
21 SourceFileReplacer(String path
, ModuleInfo moduleinfo
, Database database
, UI fp
) {
27 private String modulepath
;
28 private ModuleInfo mi
;
31 private boolean showdetails
= false;
33 private class r8tor9
{
34 r8tor9(String r8
, String r9
) {
38 public String r8thing
;
39 public String r9thing
;
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
>();
50 private String r8only
= "EfiLibInstallDriverBinding " +
51 "EfiLibInstallAllDriverProtocols " +
52 "EfiLibCompareLanguage " +
64 "GetDxeCoreHobInfo " +
65 "GetNextFirmwareVolumeHob " +
67 "GetPalEntryHobInfo " +
68 "GetIoPortSpaceAddressHobInfo ";
70 public void flush() throws Exception
{
73 if (ui
.yesOrNo("Change Source Code is to be doing . See details ?")) {
76 File tempdir
= new File(modulepath
+ File
.separator
+ "result" + File
.separator
);
77 if (!tempdir
.exists()) tempdir
.mkdir();
78 String
[] list
= new File(modulepath
+ File
.separator
+ "temp").list(); //what I change is the non-local .h commented-out files
79 for (int i
= 0 ; i
< list
.length
; i
++) {
80 if (list
[i
].contains(".c")) {
81 ui
.println("\nModifying file : " + list
[i
]);
82 outfile
= new PrintWriter(new BufferedWriter(new FileWriter(modulepath
+ File
.separator
+ "result" + File
.separator
+ list
[i
])));
83 outfile
.append(sourcefilereplace(modulepath
+ File
.separator
+ "temp" + File
.separator
+ list
[i
]));
87 if (list
[i
].contains(".h")) {
89 } else if (list
[i
].contains(".C")) {
90 temp
= list
[i
].replaceFirst(".C", ".c");
91 } else if (list
[i
].contains(".H")) {
92 temp
= list
[i
].replaceFirst(".H", ".h");
96 ui
.println("\nCopying file : " + temp
);
97 outfile
= new PrintWriter(new BufferedWriter(new FileWriter(modulepath
+ File
.separator
+ "result" + File
.separator
+ temp
)));
98 outfile
.append(sourcefiletostring(modulepath
+ File
.separator
+ "temp" + File
.separator
+ list
[i
]));
104 if (!mi
.hashr8only
.isEmpty()) {
109 private void addr8only() throws Exception
{
110 String paragraph
= null;
111 String line
= sourcefiletostring(Database
.defaultpath
+ File
.separator
+ "R8Lib.c");
112 PrintWriter outfile1
= new PrintWriter(new BufferedWriter(new FileWriter(modulepath
+ File
.separator
+ "result" + File
.separator
+ "R8Lib.c")));
113 PrintWriter outfile2
= new PrintWriter(new BufferedWriter(new FileWriter(modulepath
+ File
.separator
+ "result" + File
.separator
+ "R8Lib.h")));
114 //outfile1.append("#include \"R8Lib.h\"\n\n");
115 //outfile2.append("#include \"R8Lib.h\"\n\n");
116 Pattern ptnr8only
= Pattern
.compile("////#?(\\w*)?.*?R8_(\\w*).*?////~", Pattern
.DOTALL
);
117 Matcher mtrr8only
= ptnr8only
.matcher(line
);
118 Matcher mtrr8onlyhead
;
119 while (mtrr8only
.find()) {
120 if (mi
.hashr8only
.contains(mtrr8only
.group(2))) {
121 paragraph
= mtrr8only
.group();
122 outfile1
.append(paragraph
+ "\n\n");
123 if (mtrr8only
.group(1).length() != 0) {
124 mi
.hashrequiredr9libs
.add(mtrr8only
.group(1));
127 while ((mtrr8onlyhead
= Func
.ptnbrace
.matcher(paragraph
)).find()) {
128 paragraph
= mtrr8onlyhead
.replaceAll(";");
130 outfile2
.append(paragraph
+ "\n\n");
139 private String
sourcefiletostring(String filename
) throws Exception
{
140 BufferedReader rd
= new BufferedReader(new FileReader(filename
));
141 StringBuffer wholefile
= new StringBuffer();
143 while ((line
= rd
.readLine()) != null) {
144 wholefile
.append(line
+ "\n");
146 return wholefile
.toString();
149 // Caution : if there is @ in file , it will be replaced with \n , so is you use Doxygen ... God Bless you!
150 private String
sourcefilereplace(String filename
) throws Exception
{
151 BufferedReader rd
= new BufferedReader(new FileReader(filename
));
152 StringBuffer wholefile
= new StringBuffer();
157 boolean addr8
= false;
159 Pattern pat
= Pattern
.compile("g?(BS|RT)(\\s*->\\s*)([a-zA-Z_]\\w*)", Pattern
.MULTILINE
); // ! only two level () bracket allowed !
160 //Pattern ptnpei = Pattern.compile("\\(\\*\\*?PeiServices\\)[.-][>]?\\s*(\\w*[#$]*)(\\s*\\(([^\\(\\)]*(\\([^\\(\\)]*\\))?[^\\(\\)]*)*\\))", Pattern.MULTILINE);
162 while ((line
= rd
.readLine()) != null) {
163 wholefile
.append(line
+ "\n");
165 line
= wholefile
.toString();
167 // replace BS -> gBS , RT -> gRT
168 Matcher mat
= pat
.matcher(line
);
169 if (mat
.find()) { // add a library here
170 ui
.println("Converting all BS->gBS,RT->gRT");
171 line
= mat
.replaceAll("g$1$2$3"); //unknown correctiveness
175 if (mat
.group(1).matches("BS")) {
176 mi
.hashrequiredr9libs
.add("UefiBootServicesTableLib");
178 if (mat
.group(1).matches("RT")) {
179 mi
.hashrequiredr9libs
.add("UefiRuntimeServicesTableLib");
183 // remove EFI_DRIVER_ENTRY_POINT
184 Pattern patentrypoint = Pattern.compile("EFI_DRIVER_ENTRY_POINT[^\\}]*\\}");
185 Matcher matentrypoint = patentrypoint.matcher(line);
186 if (matentrypoint.find()) {
187 ui.println("Deleting Entry_Point");
188 line = matentrypoint.replaceAll("");
191 // start replacing names
193 // Converting non-locla function
194 it
= mi
.hashnonlocalfunc
.iterator();
195 while (it
.hasNext()) {
197 if (r8thing
.matches("EfiInitializeDriverLib")) { //s
198 mi
.hashrequiredr9libs
.add("UefiBootServicesTableLib"); //p
199 mi
.hashrequiredr9libs
.add("UefiRuntimeServicesTableLib"); //e
200 } else if (r8thing
.matches("DxeInitializeDriverLib")) { //c
201 mi
.hashrequiredr9libs
.add("UefiBootServicesTableLib"); //i
202 mi
.hashrequiredr9libs
.add("UefiRuntimeServicesTableLib"); //a
203 mi
.hashrequiredr9libs
.add("DxeServicesTableLib"); //l
205 mi
.hashrequiredr9libs
.add(db
.getR9Lib(r8thing
)); // add a library here
208 if ((r9thing
= db
.getR9Func(r8thing
)) != null) {
209 if (!r8thing
.equals(r9thing
)) {
210 if (line
.contains(r8thing
)) {
211 line
= line
.replaceAll(r8thing
, r9thing
);
212 filefunc
.add(new r8tor9(r8thing
, r9thing
));
213 Iterator
<r8tor9
> rt
= filefunc
.iterator();
214 while (rt
.hasNext()) {
216 if (r8only
.contains(temp
.r8thing
)) {
217 mi
.localmodulesources
.add("R8Lib.h");
218 mi
.localmodulesources
.add("R8Lib.c");
219 filer8only
.add(r8thing
);
220 mi
.hashr8only
.add(r8thing
);
227 } //is any of the guids changed?
229 line
= line
.replaceFirst("\\*/\n", "\\*/\n#include \"R8Lib.h\"\n");
233 it
= mi
.hashnonlocalmacro
.iterator();
234 while (it
.hasNext()) { //macros are all assumed MdePkg currently
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
));
246 replaceGuid(line
, mi
.guid
, "guid", fileguid
);
247 replaceGuid(line
, mi
.ppi
, "ppi", fileppi
);
248 replaceGuid(line
, mi
.protocol
, "protocol", fileprotocol
);
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");
260 if (line
.contains("PeiServicesCopyMem")) {
261 line
= line
.replaceAll("PeiServicesCopyMem#%", "CopyMem");
262 mi
.hashrequiredr9libs
.add("BaseMemoryLib");
264 if (line
.contains("PeiServicesSetMem")) {
265 line
= line
.replaceAll("PeiServicesSetMem#%", "SetMem");
266 mi
.hashrequiredr9libs
.add("BaseMemoryLib");
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");
278 mtrmac
= Pattern
.compile("EFI_IDIV_ROUND\\((.*), (.*)\\)").matcher(line
);
280 line
= mtrmac
.replaceAll("\\($1 \\/ $2 \\+ \\(\\(\\(2 \\* \\($1 \\% $2\\)\\) \\< $2\\) \\? 0 \\: 1\\)\\)");
282 mtrmac
= Pattern
.compile("EFI_MIN\\((.*), (.*)\\)").matcher(line
);
284 line
= mtrmac
.replaceAll("\\(\\($1 \\< $2\\) \\? $1 \\: $2\\)");
286 mtrmac
= Pattern
.compile("EFI_MAX\\((.*), (.*)\\)").matcher(line
);
288 line
= mtrmac
.replaceAll("\\(\\($1 \\> $2\\) \\? $1 \\: $2\\)");
290 mtrmac
= Pattern
.compile("EFI_UINTN_ALIGNED\\((.*)\\)").matcher(line
);
292 line
= mtrmac
.replaceAll("\\(\\(\\(UINTN\\) $1\\) \\& \\(sizeof \\(UINTN\\) \\- 1\\)\\)");
294 if (line
.contains("EFI_UINTN_ALIGN_MASK")) {
295 line
= line
.replaceAll("EFI_UINTN_ALIGN_MASK", "(sizeof (UINTN) - 1)");
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
);
311 fileprotocol
.clear();
317 private void show(Set
<r8tor9
> hash
, String sh
) {
318 Iterator
<r8tor9
> it
= hash
.iterator();
321 if (!hash
.isEmpty()) {
322 ui
.print("Converting " + sh
+ " : ");
323 while (it
.hasNext()) {
325 ui
.print("[" + temp
.r8thing
+ "->" + temp
.r9thing
+ "] ");
332 private void replaceGuid(String line
, Set
<String
> hash
, String kind
, Set
<r8tor9
> filehash
) {
336 it
= hash
.iterator();
337 while (it
.hasNext()) {
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
));