BaseTools: add error check for "#image" for idf file format

[mirror_edk2.git] / BaseTools / Source / Python / AutoGen / IdfClassObject.py

## @file\r
# This file is used to collect all defined strings in Image Definition files\r
#\r
# Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>\r
# This program and the accompanying materials\r
# are licensed and made available under the terms and conditions of the BSD License\r
# which accompanies this distribution.  The full text of the license may be found at\r
# http://opensource.org/licenses/bsd-license.php\r
#\r
# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
##\r
# Import Modules\r
#\r
import Common.EdkLogger as EdkLogger\r
import StringIO\r
from Common.BuildToolError import *\r
from Common.String import GetLineNo\r
from Common.Misc import PathClass\r
from Common.LongFilePathSupport import LongFilePath\r
import re\r
import os\r
\r
IMAGE_TOKEN = re.compile('IMAGE_TOKEN *\(([A-Z0-9_]+) *\)', re.MULTILINE | re.UNICODE)\r
\r
#\r
# Value of different image information block types\r
#\r
EFI_HII_IIBT_END               = 0x00\r
EFI_HII_IIBT_IMAGE_1BIT        = 0x10\r
EFI_HII_IIBT_IMAGE_1BIT_TRANS  = 0x11\r
EFI_HII_IIBT_IMAGE_4BIT        = 0x12\r
EFI_HII_IIBT_IMAGE_4BIT_TRANS  = 0x13\r
EFI_HII_IIBT_IMAGE_8BIT        = 0x14\r
EFI_HII_IIBT_IMAGE_8BIT_TRANS  = 0x15\r
EFI_HII_IIBT_IMAGE_24BIT       = 0x16\r
EFI_HII_IIBT_IMAGE_24BIT_TRANS = 0x17\r
EFI_HII_IIBT_IMAGE_JPEG        = 0x18\r
EFI_HII_IIBT_IMAGE_PNG         = 0x19\r
EFI_HII_IIBT_DUPLICATE         = 0x20\r
EFI_HII_IIBT_SKIP2             = 0x21\r
EFI_HII_IIBT_SKIP1             = 0x22\r
EFI_HII_IIBT_EXT1              = 0x30\r
EFI_HII_IIBT_EXT2              = 0x31\r
EFI_HII_IIBT_EXT4              = 0x32\r
\r
#\r
# Value of HII package type\r
#\r
EFI_HII_PACKAGE_TYPE_ALL           = 0x00\r
EFI_HII_PACKAGE_TYPE_GUID          = 0x01\r
EFI_HII_PACKAGE_FORMS              = 0x02\r
EFI_HII_PACKAGE_STRINGS            = 0x04\r
EFI_HII_PACKAGE_FONTS              = 0x05\r
EFI_HII_PACKAGE_IMAGES             = 0x06\r
EFI_HII_PACKAGE_SIMPLE_FONTS       = 0x07\r
EFI_HII_PACKAGE_DEVICE_PATH        = 0x08\r
EFI_HII_PACKAGE_KEYBOARD_LAYOUT    = 0x09\r
EFI_HII_PACKAGE_ANIMATIONS         = 0x0A\r
EFI_HII_PACKAGE_END                = 0xDF\r
EFI_HII_PACKAGE_TYPE_SYSTEM_BEGIN  = 0xE0\r
EFI_HII_PACKAGE_TYPE_SYSTEM_END    = 0xFF\r
\r
class IdfFileClassObject(object):\r
    def __init__(self, FileList = []):\r
        self.FileList = FileList\r
        self.ImageFilesDict = {}\r
        self.ImageIDList = []\r
        if len(self.FileList) > 0:\r
            self.LoadIdfFiles(FileList)\r
\r
    def LoadIdfFiles(self, FileList):\r
        if len(FileList) > 0:\r
            for File in FileList:\r
                self.LoadIdfFile(File)\r
\r
    def LoadIdfFile(self, File = None):\r
        if File == None:\r
            EdkLogger.error("Image Definition File Parser", PARSER_ERROR, 'No Image definition file is given.')\r
        self.File = File\r
\r
        try:\r
            IdfFile = open(LongFilePath(File.Path), mode='r')\r
            FileIn = IdfFile.read()\r
            IdfFile.close()\r
        except:\r
            EdkLogger.error("build", FILE_OPEN_FAILURE, ExtraData=File)\r
\r
        ImageFileList = []\r
        for Line in FileIn.splitlines():\r
            Line = Line.strip()\r
            Line = self.StripComments(Line)\r
            if len(Line) == 0:\r
                continue\r
\r
            LineNo = GetLineNo(FileIn, Line, False)\r
            if not Line.startswith('#image '):\r
                EdkLogger.error("Image Definition File Parser", PARSER_ERROR, 'The %s in Line %s of File %s is invalid.' % (Line, LineNo, File.Path))\r
\r
            if Line.find('#image ') >= 0:\r
                LineDetails = Line.split()\r
                Len = len(LineDetails)\r
                if Len != 3 and Len != 4:\r
                    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
                if Len == 4 and LineDetails[2] != 'TRANSPARENT':\r
                    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
                MatchString = re.match('^[a-zA-Z][a-zA-Z0-9_]*$', LineDetails[1], re.UNICODE)\r
                if MatchString == None or MatchString.end(0) != len(LineDetails[1]):\r
                    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
                if LineDetails[1] not in self.ImageIDList:\r
                    self.ImageIDList.append(LineDetails[1])\r
                else:\r
                    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
                if Len == 4:\r
                    ImageFile = ImageFileObject(LineDetails[Len-1], LineDetails[1], True)\r
                else:\r
                    ImageFile = ImageFileObject(LineDetails[Len-1], LineDetails[1], False)\r
                ImageFileList.append(ImageFile)\r
        if ImageFileList:\r
            self.ImageFilesDict[File] = ImageFileList\r
\r
    def StripComments(self, Line):\r
        Comment = '//'\r
        CommentPos = Line.find(Comment)\r
        while CommentPos >= 0:\r
        # if there are non matched quotes before the comment header\r
        # then we are in the middle of a string\r
        # but we need to ignore the escaped quotes and backslashes.\r
            if ((Line.count('"', 0, CommentPos) - Line.count('\\"', 0, CommentPos)) & 1) == 1:\r
                CommentPos = Line.find (Comment, CommentPos + 1)\r
            else:\r
                return Line[:CommentPos].strip()\r
        return Line.strip()\r
\r
    def ImageDecoder(self, File):\r
        pass\r
\r
def SearchImageID(ImageFileObject, FileList):\r
    if FileList == []:\r
        return ImageFileObject\r
\r
    for File in FileList:\r
        if os.path.isfile(File):\r
            Lines = open(File, 'r')\r
            for Line in Lines:\r
                ImageIdList = IMAGE_TOKEN.findall(Line)\r
                for ID in ImageIdList:\r
                    EdkLogger.debug(EdkLogger.DEBUG_5, "Found ImageID identifier: " + ID)\r
                    ImageFileObject.SetImageIDReferenced(ID)\r
\r
class ImageFileObject(object):\r
    def __init__(self, FileName, ImageID, TransParent = False):\r
        self.FileName = FileName\r
        self.File = ''\r
        self.ImageID = ImageID\r
        self.TransParent = TransParent\r
        self.Referenced = False\r
\r
    def SetImageIDReferenced(self, ImageID):\r
        if ImageID == self.ImageID:\r
            self.Referenced = True\r