BaseTools/UPT: Replace os.linesep with '\r\n' when generating UNI files.

Replace os.linesep with '\r\n' when generating UNI files to make sure all files are under DOS format.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Hess Chen <hesheng.chen@intel.com>
Reviewed-by: Gao, Liming <liming.gao@intel.com>
git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@16041 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/BaseTools/Source/Python/UPT/GenMetaFile/GenDecFile.py b/BaseTools/Source/Python/UPT/GenMetaFile/GenDecFile.py
index d886958f97f1cd2d850380e3c9cf3c79cc76e4f0..80b32ae5e70341f66661694d6a0ea26ef7cdc481 100644 (file)
--- a/BaseTools/Source/Python/UPT/GenMetaFile/GenDecFile.py
+++ b/BaseTools/Source/Python/UPT/GenMetaFile/GenDecFile.py
@@ -582,20 +582,17 @@ def GenPackageUNIEncodeFile(PackageObject, UniFileHeader = '', Encoding=TAB_ENCO
     ContainerFile = os.path.normpath(os.path.join(os.path.dirname(PackageObject.GetFullPath()), \r
                                                   (PackageObject.GetBaseName() + '.uni')))\r
     \r
     ContainerFile = os.path.normpath(os.path.join(os.path.dirname(PackageObject.GetFullPath()), \r
                                                   (PackageObject.GetBaseName() + '.uni')))\r
     \r

-    Content = UniFileHeader + os.linesep\r
-    Content += os.linesep\r
+    Content = UniFileHeader + '\r\n'\r
+    Content += '\r\n'\r

     \r
     \r

-    Content += FormatUniEntry('#string ' + TAB_DEC_PACKAGE_ABSTRACT, PackageObject.GetAbstract(), ContainerFile) \\r
-    + os.linesep\r
+    Content += FormatUniEntry('#string ' + TAB_DEC_PACKAGE_ABSTRACT, PackageObject.GetAbstract(), ContainerFile) + '\r\n'\r

         \r
     Content += FormatUniEntry('#string ' + TAB_DEC_PACKAGE_DESCRIPTION, PackageObject.GetDescription(), ContainerFile) \\r
         \r
     Content += FormatUniEntry('#string ' + TAB_DEC_PACKAGE_DESCRIPTION, PackageObject.GetDescription(), ContainerFile) \\r

-    + os.linesep\r
+    + '\r\n'\r

     \r
     \r

-    Content += FormatUniEntry('#string ' + TAB_DEC_BINARY_ABSTRACT, BinaryAbstract, ContainerFile) \\r
-    + os.linesep\r
+    Content += FormatUniEntry('#string ' + TAB_DEC_BINARY_ABSTRACT, BinaryAbstract, ContainerFile) + '\r\n'\r

     \r
     \r

-    Content += FormatUniEntry('#string ' + TAB_DEC_BINARY_DESCRIPTION, BinaryDescription, ContainerFile) \\r
-    + os.linesep\r
+    Content += FormatUniEntry('#string ' + TAB_DEC_BINARY_DESCRIPTION, BinaryDescription, ContainerFile) + '\r\n'\r

     \r
     PromptGenList = []\r
     HelpTextGenList = []    \r
     \r
     PromptGenList = []\r
     HelpTextGenList = []    \r


@@ -612,7 +609,7 @@ def GenPackageUNIEncodeFile(PackageObject, UniFileHeader = '', Encoding=TAB_ENCO
             if (PcdPromptStrName, Lang) not in PromptGenList:\r
                 TokenValueList.append((Lang, PromptStr))\r
                 PromptGenList.append((PcdPromptStrName, Lang))\r
             if (PcdPromptStrName, Lang) not in PromptGenList:\r
                 TokenValueList.append((Lang, PromptStr))\r
                 PromptGenList.append((PcdPromptStrName, Lang))\r

-        PromptString = FormatUniEntry(PcdPromptStrName, TokenValueList, ContainerFile) + os.linesep\r
+        PromptString = FormatUniEntry(PcdPromptStrName, TokenValueList, ContainerFile) + '\r\n'\r

         if PromptString not in Content:\r
             Content += PromptString\r
             \r
         if PromptString not in Content:\r
             Content += PromptString\r
             \r


@@ -628,7 +625,7 @@ def GenPackageUNIEncodeFile(PackageObject, UniFileHeader = '', Encoding=TAB_ENCO
             if (PcdHelpStrName, Lang) not in HelpTextGenList:\r
                 TokenValueList.append((Lang, HelpStr))\r
                 HelpTextGenList.append((PcdHelpStrName, Lang))\r
             if (PcdHelpStrName, Lang) not in HelpTextGenList:\r
                 TokenValueList.append((Lang, HelpStr))\r
                 HelpTextGenList.append((PcdHelpStrName, Lang))\r

-        HelpTextString = FormatUniEntry(PcdHelpStrName, TokenValueList, ContainerFile) + os.linesep\r
+        HelpTextString = FormatUniEntry(PcdHelpStrName, TokenValueList, ContainerFile) + '\r\n'\r

         if HelpTextString not in Content:\r
             Content += HelpTextString\r
             \r
         if HelpTextString not in Content:\r
             Content += HelpTextString\r
             \r


@@ -639,7 +636,7 @@ def GenPackageUNIEncodeFile(PackageObject, UniFileHeader = '', Encoding=TAB_ENCO
                 PcdErrStrName = '#string ' + TAB_STR_TOKENCNAME + TAB_UNDERLINE_SPLIT + Pcd.GetTokenSpaceGuidCName() \\r
                     + TAB_UNDERLINE_SPLIT + TAB_STR_TOKENERR \\r
                     + TAB_UNDERLINE_SPLIT + ErrorNo[2:]\r
                 PcdErrStrName = '#string ' + TAB_STR_TOKENCNAME + TAB_UNDERLINE_SPLIT + Pcd.GetTokenSpaceGuidCName() \\r
                     + TAB_UNDERLINE_SPLIT + TAB_STR_TOKENERR \\r
                     + TAB_UNDERLINE_SPLIT + ErrorNo[2:]\r

-                PcdErrString = FormatUniEntry(PcdErrStrName, PcdError.GetErrorMessageList(), ContainerFile) + os.linesep\r
+                PcdErrString = FormatUniEntry(PcdErrStrName, PcdError.GetErrorMessageList(), ContainerFile) + '\r\n'\r

                 if PcdErrString not in Content:\r
                     Content += PcdErrString\r
                     \r
                 if PcdErrString not in Content:\r
                     Content += PcdErrString\r
                     \r

diff --git a/BaseTools/Source/Python/UPT/GenMetaFile/GenInfFile.py b/BaseTools/Source/Python/UPT/GenMetaFile/GenInfFile.py
index 0daa96af25f03c410b9b3d391339986f83d143ca..2a11204f7d203ac9859a6fc2265786fc473f12fd 100644 (file)
--- a/BaseTools/Source/Python/UPT/GenMetaFile/GenInfFile.py
+++ b/BaseTools/Source/Python/UPT/GenMetaFile/GenInfFile.py
@@ -230,22 +230,22 @@ def GenModuleUNIEncodeFile(ModuleObject, UniFileHeader='', Encoding=DT.TAB_ENCOD
     if not os.path.exists(os.path.dirname(ModuleObject.GetFullPath())):\r
         os.makedirs(os.path.dirname(ModuleObject.GetFullPath()))\r
 \r
     if not os.path.exists(os.path.dirname(ModuleObject.GetFullPath())):\r
         os.makedirs(os.path.dirname(ModuleObject.GetFullPath()))\r
 \r

-    Content = UniFileHeader + os.linesep\r
-    Content += DT.END_OF_LINE\r
+    Content = UniFileHeader + '\r\n'\r
+    Content += '\r\n'\r

 \r
 \r

-    Content += FormatUniEntry('#string ' + DT.TAB_INF_ABSTRACT, ModuleObject.GetAbstract(), ContainerFile) + os.linesep\r
+    Content += FormatUniEntry('#string ' + DT.TAB_INF_ABSTRACT, ModuleObject.GetAbstract(), ContainerFile) + '\r\n'\r

 \r
     Content += FormatUniEntry('#string ' + DT.TAB_INF_DESCRIPTION, ModuleObject.GetDescription(), ContainerFile) \\r
 \r
     Content += FormatUniEntry('#string ' + DT.TAB_INF_DESCRIPTION, ModuleObject.GetDescription(), ContainerFile) \\r

-    + os.linesep\r
+            + '\r\n'\r

 \r
     BinaryAbstractString = FormatUniEntry('#string ' + DT.TAB_INF_BINARY_ABSTRACT, BinaryAbstract, ContainerFile)\r
     if BinaryAbstractString:\r
 \r
     BinaryAbstractString = FormatUniEntry('#string ' + DT.TAB_INF_BINARY_ABSTRACT, BinaryAbstract, ContainerFile)\r
     if BinaryAbstractString:\r

-        Content += BinaryAbstractString + os.linesep\r
+        Content += BinaryAbstractString + '\r\n'\r

 \r
     BinaryDescriptionString = FormatUniEntry('#string ' + DT.TAB_INF_BINARY_DESCRIPTION, BinaryDescription, \\r
                                              ContainerFile)\r
     if BinaryDescriptionString:\r
 \r
     BinaryDescriptionString = FormatUniEntry('#string ' + DT.TAB_INF_BINARY_DESCRIPTION, BinaryDescription, \\r
                                              ContainerFile)\r
     if BinaryDescriptionString:\r

-        Content += BinaryDescriptionString + os.linesep\r
+        Content += BinaryDescriptionString + '\r\n'\r

 \r
     if not os.path.exists(ContainerFile):\r
         File = codecs.open(ContainerFile, 'wb', Encoding)\r
 \r
     if not os.path.exists(ContainerFile):\r
         File = codecs.open(ContainerFile, 'wb', Encoding)\r

diff --git a/BaseTools/Source/Python/UPT/Library/CommentGenerating.py b/BaseTools/Source/Python/UPT/Library/CommentGenerating.py
index 1cf919a96bae46309c0040f45b4c83d32a83b973..9c6e3aad9fcdeadd9ff74dc94ac35b7501fce3b7 100644 (file)
--- a/BaseTools/Source/Python/UPT/Library/CommentGenerating.py
+++ b/BaseTools/Source/Python/UPT/Library/CommentGenerating.py
@@ -129,45 +129,45 @@ def GenHeaderCommentSection(Abstract, Description, Copyright, License, IsBinaryH
     if isinstance(Description, unicode):\r
         Description = ConvertSpecialUnicodes(Description)\r
     if IsBinaryHeader:\r
     if isinstance(Description, unicode):\r
         Description = ConvertSpecialUnicodes(Description)\r
     if IsBinaryHeader:\r

-        Content += CommChar * 2 + TAB_SPACE_SPLIT + TAB_BINARY_HEADER_COMMENT + END_OF_LINE\r
+        Content += CommChar * 2 + TAB_SPACE_SPLIT + TAB_BINARY_HEADER_COMMENT + '\r\n'\r

     elif CommChar == TAB_COMMENT_EDK1_SPLIT:\r
         Content += CommChar + TAB_SPACE_SPLIT + TAB_COMMENT_EDK1_START + TAB_STAR + TAB_SPACE_SPLIT +\\r
     elif CommChar == TAB_COMMENT_EDK1_SPLIT:\r
         Content += CommChar + TAB_SPACE_SPLIT + TAB_COMMENT_EDK1_START + TAB_STAR + TAB_SPACE_SPLIT +\\r

-         TAB_HEADER_COMMENT + END_OF_LINE\r
+         TAB_HEADER_COMMENT + '\r\n'\r

     else:\r
     else:\r

-        Content += CommChar * 2 + TAB_SPACE_SPLIT + TAB_HEADER_COMMENT + END_OF_LINE\r
+        Content += CommChar * 2 + TAB_SPACE_SPLIT + TAB_HEADER_COMMENT + '\r\n'\r

     if Abstract:\r
     if Abstract:\r

-        Abstract = Abstract.rstrip(END_OF_LINE)\r
-        Content += CommChar + TAB_SPACE_SPLIT + (END_OF_LINE + CommChar + TAB_SPACE_SPLIT).join(GetSplitValueList\\r
-                                                                                                (Abstract, END_OF_LINE))\r
-        Content += END_OF_LINE + CommChar + END_OF_LINE\r
+        Abstract = Abstract.rstrip('\r\n')\r
+        Content += CommChar + TAB_SPACE_SPLIT + ('\r\n' + CommChar + TAB_SPACE_SPLIT).join(GetSplitValueList\\r
+                                                                                                (Abstract, '\n'))\r
+        Content += '\r\n' + CommChar + '\r\n'\r

     else:\r
     else:\r

-        Content += CommChar + END_OF_LINE\r
+        Content += CommChar + '\r\n'\r

 \r
     if Description:\r
 \r
     if Description:\r

-        Description = Description.rstrip(END_OF_LINE)\r
-        Content += CommChar + TAB_SPACE_SPLIT + (END_OF_LINE + CommChar + TAB_SPACE_SPLIT).join(GetSplitValueList\\r
-                                                  (Description, END_OF_LINE))\r
-        Content += END_OF_LINE + CommChar + END_OF_LINE        \r
+        Description = Description.rstrip('\r\n')\r
+        Content += CommChar + TAB_SPACE_SPLIT + ('\r\n' + CommChar + TAB_SPACE_SPLIT).join(GetSplitValueList\\r
+                                                  (Description, '\n'))\r
+        Content += '\r\n' + CommChar + '\r\n'\r

   \r
     #\r
     # There is no '#\n' line to separate multiple copyright lines in code base \r
     #\r
     if Copyright:\r
   \r
     #\r
     # There is no '#\n' line to separate multiple copyright lines in code base \r
     #\r
     if Copyright:\r

-        Copyright = Copyright.rstrip(END_OF_LINE)\r
-        Content += CommChar + TAB_SPACE_SPLIT + (END_OF_LINE + CommChar + TAB_SPACE_SPLIT).join\\r
-        (GetSplitValueList(Copyright, END_OF_LINE))\r
-        Content += END_OF_LINE + CommChar + END_OF_LINE\r
+        Copyright = Copyright.rstrip('\r\n')\r
+        Content += CommChar + TAB_SPACE_SPLIT + ('\r\n' + CommChar + TAB_SPACE_SPLIT).join\\r
+        (GetSplitValueList(Copyright, '\n'))\r
+        Content += '\r\n' + CommChar + '\r\n'\r

 \r
     if License:\r
 \r
     if License:\r

-        License = License.rstrip(END_OF_LINE)\r
-        Content += CommChar + TAB_SPACE_SPLIT + (END_OF_LINE + CommChar + TAB_SPACE_SPLIT).join(GetSplitValueList\\r
-                                                  (License, END_OF_LINE))\r
-        Content += END_OF_LINE + CommChar + END_OF_LINE\r
+        License = License.rstrip('\r\n')\r
+        Content += CommChar + TAB_SPACE_SPLIT + ('\r\n' + CommChar + TAB_SPACE_SPLIT).join(GetSplitValueList\\r
+                                                  (License, '\n'))\r
+        Content += '\r\n' + CommChar + '\r\n'\r

     \r
     if CommChar == TAB_COMMENT_EDK1_SPLIT:\r
     \r
     if CommChar == TAB_COMMENT_EDK1_SPLIT:\r

-        Content += CommChar + TAB_SPACE_SPLIT + TAB_STAR + TAB_COMMENT_EDK1_END + END_OF_LINE\r
+        Content += CommChar + TAB_SPACE_SPLIT + TAB_STAR + TAB_COMMENT_EDK1_END + '\r\n'\r

     else:\r
     else:\r

-        Content += CommChar * 2 + END_OF_LINE\r
+        Content += CommChar * 2 + '\r\n'\r

     \r
     return Content\r
 \r
     \r
     return Content\r
 \r

diff --git a/BaseTools/Source/Python/UPT/Library/UniClassObject.py b/BaseTools/Source/Python/UPT/Library/UniClassObject.py
index d542dc5dc86c4c116bb7077842a3358106f909c0..563b82c6889c8b9b2d1b5d1b3ced43eda02c487c 100644 (file)
--- a/BaseTools/Source/Python/UPT/Library/UniClassObject.py
+++ b/BaseTools/Source/Python/UPT/Library/UniClassObject.py
@@ -245,9 +245,9 @@ def FormatUniEntry(StrTokenName, TokenValueList, ContainerFile):
         for SubValue in ValueList:\r
             if SubValue.strip():\r
                 SubValueContent += \\r
         for SubValue in ValueList:\r
             if SubValue.strip():\r
                 SubValueContent += \\r

-                ' ' * (PreFormatLength + len('#language en-US    ')) + '\"%s\\n\"' % SubValue.strip() + os.linesep\r
-        SubValueContent = SubValueContent[(PreFormatLength + len('#language en-US    ')):SubValueContent.rfind('\\n')] \\r
-        + '\"' + os.linesep\r
+                ' ' * (PreFormatLength + len('#language en-US ')) + '\"%s\\n\"' % SubValue.strip() + '\r\n'\r
+        SubValueContent = SubValueContent[(PreFormatLength + len('#language en-US ')):SubValueContent.rfind('\\n')] \\r
+        + '\"' + '\r\n'\r

         SubContent += ' '*PreFormatLength + '#language %-5s ' % Lang + SubValueContent\r
     if SubContent:\r
         SubContent = StrTokenName + ' '*(PreFormatLength - len(StrTokenName)) + SubContent[PreFormatLength:]\r
         SubContent += ' '*PreFormatLength + '#language %-5s ' % Lang + SubValueContent\r
     if SubContent:\r
         SubContent = StrTokenName + ' '*(PreFormatLength - len(StrTokenName)) + SubContent[PreFormatLength:]\r


@@ -289,7 +289,7 @@ class StringDefClassObject(object):
     def UpdateValue(self, Value = None):\r
         if Value != None:\r
             if self.StringValue:\r
     def UpdateValue(self, Value = None):\r
         if Value != None:\r
             if self.StringValue:\r

-                self.StringValue = self.StringValue  + os.linesep + Value\r
+                self.StringValue = self.StringValue + '\r\n' + Value\r

             else:\r
                 self.StringValue = Value\r
             self.StringValueByteList = UniToHexList(self.StringValue)\r
             else:\r
                 self.StringValue = Value\r
             self.StringValueByteList = UniToHexList(self.StringValue)\r


@@ -452,7 +452,7 @@ class UniFileClassObject(object):
             if not Line.startswith(DT.TAB_COMMENT_EDK1_SPLIT) and HeaderStart and not HeaderEnd:\r
                 HeaderEnd = True\r
             if Line.startswith(DT.TAB_COMMENT_EDK1_SPLIT) and HeaderStart and not HeaderEnd and FirstGenHeader:\r
             if not Line.startswith(DT.TAB_COMMENT_EDK1_SPLIT) and HeaderStart and not HeaderEnd:\r
                 HeaderEnd = True\r
             if Line.startswith(DT.TAB_COMMENT_EDK1_SPLIT) and HeaderStart and not HeaderEnd and FirstGenHeader:\r

-                self.UniFileHeader += Line + os.linesep\r
+                self.UniFileHeader += Line + '\r\n'\r

                 continue\r
         \r
         #\r
                 continue\r
         \r
         #\r


@@ -498,11 +498,11 @@ class UniFileClassObject(object):
                 if FileIn[LineCount].strip().startswith('#language'):\r
                     Line = Line + FileIn[LineCount]\r
                     FileIn[LineCount-1] = Line\r
                 if FileIn[LineCount].strip().startswith('#language'):\r
                     Line = Line + FileIn[LineCount]\r
                     FileIn[LineCount-1] = Line\r

-                    FileIn[LineCount] = os.linesep\r
+                    FileIn[LineCount] = '\r\n'\r

                     LineCount -= 1\r
                     for Index in xrange (LineCount + 1, len (FileIn) - 1):\r
                         if (Index == len(FileIn) -1):\r
                     LineCount -= 1\r
                     for Index in xrange (LineCount + 1, len (FileIn) - 1):\r
                         if (Index == len(FileIn) -1):\r

-                            FileIn[Index] = os.linesep\r
+                            FileIn[Index] = '\r\n'\r

                         else:\r
                             FileIn[Index] = FileIn[Index + 1]\r
                     continue\r
                         else:\r
                             FileIn[Index] = FileIn[Index + 1]\r
                     continue\r


@@ -858,12 +858,12 @@ class UniFileClassObject(object):
                                 Value = Value + Lines[IndexJ].strip()[1:-1]\r
                             CombineToken = False\r
                         else:\r
                                 Value = Value + Lines[IndexJ].strip()[1:-1]\r
                             CombineToken = False\r
                         else:\r

-                            Value = Value + Lines[IndexJ].strip()[1:-1] + os.linesep\r
+                            Value = Value + Lines[IndexJ].strip()[1:-1] + '\r\n'\r

                     else:\r
                         IndexI = IndexJ\r
                         break\r
                     else:\r
                         IndexI = IndexJ\r
                         break\r

-                if Value.endswith(os.linesep):\r
-                    Value = Value[: Value.rfind(os.linesep)]\r
+                if Value.endswith('\r\n'):\r
+                    Value = Value[: Value.rfind('\r\n')]\r

                 Language = GetLanguageCode(Language, self.IsCompatibleMode, self.File)\r
                 self.AddStringToList(Name, Language, Value)\r
                 continue\r
                 Language = GetLanguageCode(Language, self.IsCompatibleMode, self.File)\r
                 self.AddStringToList(Name, Language, Value)\r
                 continue\r