Posting to the new list in case this got missed
Reviewed-by: Samer El-Haj-Mahmoud <el...@hp.com>
>From 839512c7d9e74c2de0234299538220968826a4b7 Mon Sep 17 00:00:00 2001
From: Cecil Sheng <cecil.sh...@hp.com>
Date: Mon, 6 Jul 2015 12:15:59 +0800
Subject: [PATCH] BaseTools: Nested !include support in DSC and FDF files.
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Cecil Sheng <cecil.sh...@hp.com>
---
BaseTools/Source/Python/GenFds/FdfParser.py | 98 ++++++++++++++++++----
.../Source/Python/Workspace/MetaFileParser.py | 12 +--
2 files changed, 91 insertions(+), 19 deletions(-)
diff --git a/BaseTools/Source/Python/GenFds/FdfParser.py
b/BaseTools/Source/Python/GenFds/FdfParser.py
index 83d3e19..664bf8e 100644
--- a/BaseTools/Source/Python/GenFds/FdfParser.py
+++ b/BaseTools/Source/Python/GenFds/FdfParser.py
@@ -2,6 +2,7 @@
# parse FDF file
#
# Copyright (c) 2007 - 2014, Intel Corporation. All rights reserved.<BR>
+# Copyright (c) 2015, Hewlett Packard Enterprise Development, L.P.<BR>
#
# This program and the accompanying materials
# are licensed and made available under the terms and conditions of the BSD
License
@@ -81,16 +82,31 @@ RegionSizeGuidPattern =
re.compile("\s*(?P<base>\w+\.\w+)\s*\|\s*(?P<size>\w+\.\
RegionOffsetPcdPattern = re.compile("\s*(?P<base>\w+\.\w+)\s*$")
ShortcutPcdPattern =
re.compile("\s*\w+\s*=\s*(?P<value>(?:0x|0X)?[a-fA-F0-9]+)\s*\|\s*(?P<name>\w+\.\w+)\s*")
-IncludeFileList = []
+AllIncludeFileList = []
+
+# Get the closest parent
+def GetParentAtLine (Line):
+ for Profile in AllIncludeFileList:
+ if Profile.IsLineInFile(Line):
+ return Profile
+ return None
+
+# Check include loop
+def IsValidInclude (File, Line):
+ for Profile in AllIncludeFileList:
+ if Profile.IsLineInFile(Line) and Profile.FileName == File:
+ return False
+
+ return True
def GetRealFileLine (File, Line):
InsertedLines = 0
- for Profile in IncludeFileList:
- if Line >= Profile.InsertStartLineNumber and Line <
Profile.InsertStartLineNumber + Profile.InsertAdjust +
len(Profile.FileLinesList):
- return (Profile.FileName, Line - Profile.InsertStartLineNumber + 1)
- if Line >= Profile.InsertStartLineNumber + Profile.InsertAdjust +
len(Profile.FileLinesList):
- InsertedLines += Profile.InsertAdjust + len(Profile.FileLinesList)
+ for Profile in AllIncludeFileList:
+ if Profile.IsLineInFile(Line):
+ return Profile.GetLineInFile(Line)
+ elif Line >= Profile.InsertStartLineNumber and Profile.Level == 1:
+ InsertedLines += Profile.GetTotalLines()
return (File, Line - InsertedLines)
@@ -111,6 +127,7 @@ class Warning (Exception):
FileLineTuple = GetRealFileLine(File, Line)
self.FileName = FileLineTuple[0]
self.LineNumber = FileLineTuple[1]
+ self.OriginalLineNumber = Line
self.Message = Str
self.ToolName = 'FdfParser'
@@ -157,6 +174,38 @@ class IncludeFileProfile :
self.InsertStartLineNumber = None
self.InsertAdjust = 0
+ self.IncludeFileList = []
+ self.Level = 1 # first level include file
+
+ def GetTotalLines(self):
+ TotalLines = self.InsertAdjust + len(self.FileLinesList)
+
+ for Profile in self.IncludeFileList:
+ TotalLines += Profile.GetTotalLines()
+
+ return TotalLines
+
+ def IsLineInFile(self, Line):
+ if Line >= self.InsertStartLineNumber and Line <
self.InsertStartLineNumber + self.GetTotalLines():
+ return True
+
+ return False
+
+ def GetLineInFile(self, Line):
+ if not self.IsLineInFile (Line):
+ return (self.FileName, -1)
+
+ InsertedLines = self.InsertStartLineNumber
+
+ for Profile in self.IncludeFileList:
+ if Profile.IsLineInFile(Line):
+ return Profile.GetLineInFile(Line)
+ elif Line >= Profile.InsertStartLineNumber:
+ InsertedLines += Profile.GetTotalLines()
+
+ return (self.FileName, Line - InsertedLines + 1)
+
+
## The FDF content class that used to record file data when parsing FDF
#
@@ -306,10 +355,12 @@ class FdfParser:
# Reset file data buffer to the initial state
#
# @param self The object pointer
+ # @param DestLine Optional new destination line number.
+ # @param DestOffset Optional new destination offset.
#
- def Rewind(self):
- self.CurrentLineNumber = 1
- self.CurrentOffsetWithinLine = 0
+ def Rewind(self, DestLine = 1, DestOffset = 0):
+ self.CurrentLineNumber = DestLine
+ self.CurrentOffsetWithinLine = DestOffset
## __UndoOneChar() method
#
@@ -565,10 +616,12 @@ class FdfParser:
# @param self The object pointer
#
def PreprocessIncludeFile(self):
-
+ # nested include support
+ Processed = False
while self.__GetNextToken():
if self.__Token == '!include':
+ Processed = True
IncludeLine = self.CurrentLineNumber
IncludeOffset = self.CurrentOffsetWithinLine - len('!include')
if not self.__GetNextToken():
@@ -612,12 +665,19 @@ class FdfParser:
raise Warning("The include file does not exist
under below directories: \n%s\n%s\n%s\n"%(os.path.dirname(self.FileName),
PlatformDir, GlobalData.gWorkspace),
self.FileName,
self.CurrentLineNumber)
+ if not IsValidInclude (IncludedFile1.Path,
self.CurrentLineNumber):
+ raise Warning("The include file {0} is causing a include
loop.\n".format (IncludedFile1.Path), self.FileName, self.CurrentLineNumber)
+
IncFileProfile = IncludeFileProfile(IncludedFile1.Path)
CurrentLine = self.CurrentLineNumber
CurrentOffset = self.CurrentOffsetWithinLine
# list index of the insertion, note that line number is
'CurrentLine + 1'
InsertAtLine = CurrentLine
+ ParentProfile = GetParentAtLine (CurrentLine)
+ if ParentProfile != None:
+ ParentProfile.IncludeFileList.insert(0, IncFileProfile)
+ IncFileProfile.Level = ParentProfile.Level + 1
IncFileProfile.InsertStartLineNumber = InsertAtLine + 1
# deal with remaining portions after "!include filename", if
exists.
if self.__GetNextToken():
@@ -633,13 +693,17 @@ class FdfParser:
self.CurrentLineNumber += 1
InsertAtLine += 1
- IncludeFileList.append(IncFileProfile)
+ # reversely sorted to better determine error in file
+ AllIncludeFileList.insert(0, IncFileProfile)
# comment out the processed include file statement
TempList = list(self.Profile.FileLinesList[IncludeLine - 1])
TempList.insert(IncludeOffset, '#')
self.Profile.FileLinesList[IncludeLine - 1] = ''.join(TempList)
-
+ if Processed: # Nested and back-to-back support
+ self.Rewind(DestLine = IncFileProfile.InsertStartLineNumber -
1)
+ Processed = False
+ # Preprocess done.
self.Rewind()
def __GetIfListCurrentItemStat(self, IfList):
@@ -1322,9 +1386,15 @@ class FdfParser:
except Warning, X:
self.__UndoToken()
- FileLineTuple = GetRealFileLine(self.FileName,
self.CurrentLineNumber)
#'\n\tGot Token: \"%s\" from File %s\n' % (self.__Token,
FileLineTuple[0]) + \
- X.Message += ' near line %d, column %d: %s' \
+ # At this point, the closest parent would be the included file
itself
+ Profile = GetParentAtLine(X.OriginalLineNumber)
+ if Profile != None:
+ X.Message += ' near line %d, column %d: %s' \
+ % (X.LineNumber, 0, Profile.FileLinesList[X.LineNumber-1])
+ else:
+ FileLineTuple = GetRealFileLine(self.FileName,
self.CurrentLineNumber)
+ X.Message += ' near line %d, column %d: %s' \
% (FileLineTuple[1], self.CurrentOffsetWithinLine + 1,
self.Profile.FileLinesList[self.CurrentLineNumber -
1][self.CurrentOffsetWithinLine :].rstrip('\n').rstrip('\r'))
raise
diff --git a/BaseTools/Source/Python/Workspace/MetaFileParser.py
b/BaseTools/Source/Python/Workspace/MetaFileParser.py
index eb02b66..fe1f7fd 100644
--- a/BaseTools/Source/Python/Workspace/MetaFileParser.py
+++ b/BaseTools/Source/Python/Workspace/MetaFileParser.py
@@ -2,6 +2,7 @@
# This file is used to parse meta files
#
# Copyright (c) 2008 - 2015, Intel Corporation. All rights reserved.<BR>
+# Copyright (c) 2015, Hewlett Packard Enterprise Development, L.P.<BR>
# This program and the accompanying materials
# are licensed and made available under the terms and conditions of the BSD
License
# which accompanies this distribution. The full text of the license may be
found at
@@ -1010,11 +1011,6 @@ class DscParser(MetaFileParser):
File=self.MetaFile, Line=self._LineIndex + 1,
ExtraData=self._CurrentLine)
self._DirectiveStack.append((ItemType, self._LineIndex + 1,
self._CurrentLine))
- elif self._From > 0:
- EdkLogger.error('Parser', FORMAT_INVALID,
- "No '!include' allowed in included file",
- ExtraData=self._CurrentLine, File=self.MetaFile,
- Line=self._LineIndex + 1)
#
# Model, Value1, Value2, Value3, Arch, ModuleType, BelongsToItem=-1,
BelongsToFile=-1,
@@ -1479,6 +1475,12 @@ class DscParser(MetaFileParser):
Parser = DscParser(IncludedFile1, self._FileType,
IncludedFileTable,
Owner=Owner, From=Owner)
+ # Does not allow lower level included file to include upper level
included file
+ if Parser._From != Owner and int(Owner) > int (Parser._From):
+ EdkLogger.error('parser', FILE_ALREADY_EXIST,
File=self._FileWithError,
+ Line=self._LineIndex + 1, ExtraData="{0} is already
included at a higher level.".format(IncludedFile1))
+
+
# set the parser status with current status
Parser._SectionName = self._SectionName
Parser._SectionType = self._SectionType
--
1.9.5.msysgit.1
From: Sheng, Cecil (HPS SW)
Sent: Tuesday, August 18, 2015 1:14 AM
To: edk2-de...@lists.sourceforge.net
Cc: El-Haj-Mahmoud, Samer <samer.el-haj-mahm...@hp.com>; Liu, Yingke D
<yingke.d....@intel.com>
Subject: [edk2] [PATCH] BaseTools: Add support for nested !include in FDF and
DSC files Also added code to detect include loops and enhanced error reporting
for included files
Hi,
Sorry for the delayed update. Please review the attachment for changes to
support nested include in DSC and FDF files. The performance impact in previous
patch has been addressed.
Sincerely,
Cecil Sheng
ISS Firmware Development
HP Servers
_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
