]>
Commit | Line | Data |
---|---|---|
333ba578 YZ |
1 | ## @file\r |
2 | # This file is used to collect all defined strings in Image Definition files\r | |
3 | #\r | |
4 | # Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>\r | |
5 | # This program and the accompanying materials\r | |
6 | # are licensed and made available under the terms and conditions of the BSD License\r | |
7 | # which accompanies this distribution. The full text of the license may be found at\r | |
8 | # http://opensource.org/licenses/bsd-license.php\r | |
9 | #\r | |
10 | # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
11 | # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
12 | \r | |
13 | ##\r | |
14 | # Import Modules\r | |
15 | #\r | |
16 | import Common.EdkLogger as EdkLogger\r | |
17 | import StringIO\r | |
18 | from Common.BuildToolError import *\r | |
19 | from Common.String import GetLineNo\r | |
20 | from Common.Misc import PathClass\r | |
21 | from Common.LongFilePathSupport import LongFilePath\r | |
22 | import re\r | |
23 | import os\r | |
1f26f5fd | 24 | from Common.GlobalData import gIdentifierPattern\r |
333ba578 YZ |
25 | \r |
26 | IMAGE_TOKEN = re.compile('IMAGE_TOKEN *\(([A-Z0-9_]+) *\)', re.MULTILINE | re.UNICODE)\r | |
27 | \r | |
28 | #\r | |
29 | # Value of different image information block types\r | |
30 | #\r | |
31 | EFI_HII_IIBT_END = 0x00\r | |
32 | EFI_HII_IIBT_IMAGE_1BIT = 0x10\r | |
33 | EFI_HII_IIBT_IMAGE_1BIT_TRANS = 0x11\r | |
34 | EFI_HII_IIBT_IMAGE_4BIT = 0x12\r | |
35 | EFI_HII_IIBT_IMAGE_4BIT_TRANS = 0x13\r | |
36 | EFI_HII_IIBT_IMAGE_8BIT = 0x14\r | |
37 | EFI_HII_IIBT_IMAGE_8BIT_TRANS = 0x15\r | |
38 | EFI_HII_IIBT_IMAGE_24BIT = 0x16\r | |
39 | EFI_HII_IIBT_IMAGE_24BIT_TRANS = 0x17\r | |
40 | EFI_HII_IIBT_IMAGE_JPEG = 0x18\r | |
41 | EFI_HII_IIBT_IMAGE_PNG = 0x19\r | |
42 | EFI_HII_IIBT_DUPLICATE = 0x20\r | |
43 | EFI_HII_IIBT_SKIP2 = 0x21\r | |
44 | EFI_HII_IIBT_SKIP1 = 0x22\r | |
45 | EFI_HII_IIBT_EXT1 = 0x30\r | |
46 | EFI_HII_IIBT_EXT2 = 0x31\r | |
47 | EFI_HII_IIBT_EXT4 = 0x32\r | |
48 | \r | |
49 | #\r | |
50 | # Value of HII package type\r | |
51 | #\r | |
52 | EFI_HII_PACKAGE_TYPE_ALL = 0x00\r | |
53 | EFI_HII_PACKAGE_TYPE_GUID = 0x01\r | |
54 | EFI_HII_PACKAGE_FORMS = 0x02\r | |
55 | EFI_HII_PACKAGE_STRINGS = 0x04\r | |
56 | EFI_HII_PACKAGE_FONTS = 0x05\r | |
57 | EFI_HII_PACKAGE_IMAGES = 0x06\r | |
58 | EFI_HII_PACKAGE_SIMPLE_FONTS = 0x07\r | |
59 | EFI_HII_PACKAGE_DEVICE_PATH = 0x08\r | |
60 | EFI_HII_PACKAGE_KEYBOARD_LAYOUT = 0x09\r | |
61 | EFI_HII_PACKAGE_ANIMATIONS = 0x0A\r | |
62 | EFI_HII_PACKAGE_END = 0xDF\r | |
63 | EFI_HII_PACKAGE_TYPE_SYSTEM_BEGIN = 0xE0\r | |
64 | EFI_HII_PACKAGE_TYPE_SYSTEM_END = 0xFF\r | |
65 | \r | |
66 | class IdfFileClassObject(object):\r | |
67 | def __init__(self, FileList = []):\r | |
68 | self.FileList = FileList\r | |
69 | self.ImageFilesDict = {}\r | |
70 | self.ImageIDList = []\r | |
71 | if len(self.FileList) > 0:\r | |
72 | self.LoadIdfFiles(FileList)\r | |
73 | \r | |
74 | def LoadIdfFiles(self, FileList):\r | |
75 | if len(FileList) > 0:\r | |
76 | for File in FileList:\r | |
77 | self.LoadIdfFile(File)\r | |
78 | \r | |
79 | def LoadIdfFile(self, File = None):\r | |
4231a819 | 80 | if File is None:\r |
333ba578 YZ |
81 | EdkLogger.error("Image Definition File Parser", PARSER_ERROR, 'No Image definition file is given.')\r |
82 | self.File = File\r | |
83 | \r | |
84 | try:\r | |
85 | IdfFile = open(LongFilePath(File.Path), mode='r')\r | |
86 | FileIn = IdfFile.read()\r | |
87 | IdfFile.close()\r | |
88 | except:\r | |
89 | EdkLogger.error("build", FILE_OPEN_FAILURE, ExtraData=File)\r | |
90 | \r | |
91 | ImageFileList = []\r | |
92 | for Line in FileIn.splitlines():\r | |
93 | Line = Line.strip()\r | |
94 | Line = self.StripComments(Line)\r | |
95 | if len(Line) == 0:\r | |
96 | continue\r | |
97 | \r | |
31bf6304 YZ |
98 | LineNo = GetLineNo(FileIn, Line, False)\r |
99 | if not Line.startswith('#image '):\r | |
100 | EdkLogger.error("Image Definition File Parser", PARSER_ERROR, 'The %s in Line %s of File %s is invalid.' % (Line, LineNo, File.Path))\r | |
101 | \r | |
333ba578 YZ |
102 | if Line.find('#image ') >= 0:\r |
103 | LineDetails = Line.split()\r | |
333ba578 YZ |
104 | Len = len(LineDetails)\r |
105 | if Len != 3 and Len != 4:\r | |
106 | EdkLogger.error("Image Definition File Parser", PARSER_ERROR, 'The format is not match #image IMAGE_ID [TRANSPARENT] ImageFileName in Line %s of File %s.' % (LineNo, File.Path))\r | |
107 | if Len == 4 and LineDetails[2] != 'TRANSPARENT':\r | |
108 | EdkLogger.error("Image Definition File Parser", PARSER_ERROR, 'Please use the keyword "TRANSPARENT" to describe the transparency setting in Line %s of File %s.' % (LineNo, File.Path))\r | |
1f26f5fd | 109 | MatchString = gIdentifierPattern.match(LineDetails[1])\r |
bfc8f566 | 110 | if MatchString is None:\r |
333ba578 YZ |
111 | EdkLogger.error('Image Definition File Parser', FORMAT_INVALID, 'The Image token name %s defined in Idf file %s contains the invalid character.' % (LineDetails[1], File.Path))\r |
112 | if LineDetails[1] not in self.ImageIDList:\r | |
113 | self.ImageIDList.append(LineDetails[1])\r | |
114 | else:\r | |
115 | EdkLogger.error("Image Definition File Parser", PARSER_ERROR, 'The %s in Line %s of File %s is already defined.' % (LineDetails[1], LineNo, File.Path))\r | |
116 | if Len == 4:\r | |
117 | ImageFile = ImageFileObject(LineDetails[Len-1], LineDetails[1], True)\r | |
118 | else:\r | |
119 | ImageFile = ImageFileObject(LineDetails[Len-1], LineDetails[1], False)\r | |
120 | ImageFileList.append(ImageFile)\r | |
121 | if ImageFileList:\r | |
122 | self.ImageFilesDict[File] = ImageFileList\r | |
123 | \r | |
124 | def StripComments(self, Line):\r | |
125 | Comment = '//'\r | |
126 | CommentPos = Line.find(Comment)\r | |
127 | while CommentPos >= 0:\r | |
128 | # if there are non matched quotes before the comment header\r | |
129 | # then we are in the middle of a string\r | |
130 | # but we need to ignore the escaped quotes and backslashes.\r | |
131 | if ((Line.count('"', 0, CommentPos) - Line.count('\\"', 0, CommentPos)) & 1) == 1:\r | |
132 | CommentPos = Line.find (Comment, CommentPos + 1)\r | |
133 | else:\r | |
134 | return Line[:CommentPos].strip()\r | |
135 | return Line.strip()\r | |
136 | \r | |
137 | def ImageDecoder(self, File):\r | |
138 | pass\r | |
139 | \r | |
140 | def SearchImageID(ImageFileObject, FileList):\r | |
141 | if FileList == []:\r | |
142 | return ImageFileObject\r | |
143 | \r | |
144 | for File in FileList:\r | |
145 | if os.path.isfile(File):\r | |
146 | Lines = open(File, 'r')\r | |
147 | for Line in Lines:\r | |
148 | ImageIdList = IMAGE_TOKEN.findall(Line)\r | |
149 | for ID in ImageIdList:\r | |
150 | EdkLogger.debug(EdkLogger.DEBUG_5, "Found ImageID identifier: " + ID)\r | |
151 | ImageFileObject.SetImageIDReferenced(ID)\r | |
152 | \r | |
153 | class ImageFileObject(object):\r | |
154 | def __init__(self, FileName, ImageID, TransParent = False):\r | |
155 | self.FileName = FileName\r | |
156 | self.File = ''\r | |
157 | self.ImageID = ImageID\r | |
158 | self.TransParent = TransParent\r | |
159 | self.Referenced = False\r | |
160 | \r | |
161 | def SetImageIDReferenced(self, ImageID):\r | |
162 | if ImageID == self.ImageID:\r | |
163 | self.Referenced = True\r |