tyler.durden/audk
1
0
Fork 0
mirror of https://github.com/acidanthera/audk.git synced 2025-07-29 16:44:10 +02:00
Code Issues Packages Projects Releases Wiki Activity

BaseTools: Trim: Add header/footer for ASL include

Browse Source 
When including one ASL file in another, add a header / footer to the
included file to easily tell where the included file starts and ends.

Signed-off-by: Joey Vagedes <joey.vagedes@gmail.com>
This commit is contained in:
Joey Vagedes 2024-06-27 11:22:29 -07:00 committed by mergify[bot]
parent 90d861f63d
commit 95ee7f3ef7
1 changed files with 28 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
BaseTools/Source/Python/Trim/Trim.py
View File

@ -248,6 +248,23 @@ def TrimPreprocessedVfr(Source, Target):
except: except:
EdkLogger.error("Trim", FILE_OPEN_FAILURE, ExtraData=Target) EdkLogger.error("Trim", FILE_OPEN_FAILURE, ExtraData=Target)
# Create a banner to indicate the start and
# end of the included ASL file. Banner looks like:-
#
# /*************************************
# * @param *
# *************************************/
#
# @param Pathname File pathname to be included in the banner
#
def AddIncludeHeader(Pathname):
StartLine = "/*" + '*' * (len(Pathname) + 4)
EndLine = '*' * (len(Pathname) + 4) + "*/"
Banner = '\n' + StartLine
Banner += '\n' + ('{0} {1} {0}'.format('*', Pathname))
Banner += '\n' + EndLine + '\n'
return Banner
## Read the content ASL file, including ASL included, recursively ## Read the content ASL file, including ASL included, recursively
# #
# @param Source File to be read # @param Source File to be read
@ -276,16 +293,18 @@ def DoInclude(Source, Indent='', IncludePathList=[], LocalSearchPath=None, Inclu
try: try:
with open(IncludeFile, "r") as File: with open(IncludeFile, "r") as File:
F = File.readlines() F = File.readlines()
except: except Exception:
with codecs.open(IncludeFile, "r", encoding='utf-8') as File: with codecs.open(IncludeFile, "r", encoding='utf-8') as File:
F = File.readlines() F = File.readlines()
break break
else: else:
EdkLogger.error("Trim", "Failed to find include file %s" % Source) EdkLogger.error("Trim", FILE_NOT_FOUND, ExtraData="Failed to find include file %s" % Source)
return [] return []
except: except Exception as e:
EdkLogger.error("Trim", FILE_OPEN_FAILURE, ExtraData=Source) if str(e) == str(FILE_NOT_FOUND):
return [] raise
else:
EdkLogger.error("Trim", FILE_OPEN_FAILURE, ExtraData=Source)
# avoid A "include" B and B "include" A # avoid A "include" B and B "include" A
@ -312,7 +331,9 @@ def DoInclude(Source, Indent='', IncludePathList=[], LocalSearchPath=None, Inclu
LocalSearchPath = os.path.dirname(IncludeFile) LocalSearchPath = os.path.dirname(IncludeFile)
CurrentIndent = Indent + Result[0][0] CurrentIndent = Indent + Result[0][0]
IncludedFile = Result[0][1] IncludedFile = Result[0][1]
NewFileContent.append(AddIncludeHeader(IncludedFile+" --START"))
NewFileContent.extend(DoInclude(IncludedFile, CurrentIndent, IncludePathList, LocalSearchPath,IncludeFileList,filetype)) NewFileContent.extend(DoInclude(IncludedFile, CurrentIndent, IncludePathList, LocalSearchPath,IncludeFileList,filetype))
NewFileContent.append(AddIncludeHeader(IncludedFile+" --END"))
NewFileContent.append("\n") NewFileContent.append("\n")
elif filetype == "ASM": elif filetype == "ASM":
Result = gIncludePattern.findall(Line) Result = gIncludePattern.findall(Line)
@ -324,7 +345,9 @@ def DoInclude(Source, Indent='', IncludePathList=[], LocalSearchPath=None, Inclu
IncludedFile = IncludedFile.strip() IncludedFile = IncludedFile.strip()
IncludedFile = os.path.normpath(IncludedFile) IncludedFile = os.path.normpath(IncludedFile)
NewFileContent.append(AddIncludeHeader(IncludedFile+" --START"))
NewFileContent.extend(DoInclude(IncludedFile, '', IncludePathList, LocalSearchPath,IncludeFileList,filetype)) NewFileContent.extend(DoInclude(IncludedFile, '', IncludePathList, LocalSearchPath,IncludeFileList,filetype))
NewFileContent.append(AddIncludeHeader(IncludedFile+" --END"))
NewFileContent.append("\n") NewFileContent.append("\n")
gIncludedAslFile.pop() gIncludedAslFile.pop()