BaseTools: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / BaseTools / Source / Python / UPT / Xml / XmlParserMisc.py

## @file\r
# This file is used to parse a xml file of .PKG file\r
#\r
# Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>\r
#\r
# SPDX-License-Identifier: BSD-2-Clause-Patent\r
#\r
\r
'''\r
XmlParserMisc\r
'''\r
from Object.POM.CommonObject import TextObject\r
from Logger.StringTable import ERR_XML_PARSER_REQUIRED_ITEM_MISSING\r
from Logger.ToolError import PARSER_ERROR\r
import Logger.Log as Logger\r
\r
## ConvertVariableName()\r
# Convert VariableName to be L"string",\r
# input of UCS-2 format Hex Array or L"string" (C style.) could be converted successfully,\r
# others will not.\r
#\r
# @param VariableName: string need to be converted\r
# @retval: the L quoted string converted if success, else None will be returned\r
#\r
def ConvertVariableName(VariableName):\r
    VariableName = VariableName.strip()\r
    #\r
    # check for L quoted string\r
    #\r
    if VariableName.startswith('L"') and VariableName.endswith('"'):\r
        return VariableName\r
\r
    #\r
    # check for Hex Array, it should be little endian even number of hex numbers\r
    #\r
    ValueList = VariableName.split(' ')\r
    if len(ValueList)%2 == 1:\r
        return None\r
\r
    TransferedStr = ''\r
\r
    Index = 0\r
\r
    while Index < len(ValueList):\r
        FirstByte = int(ValueList[Index], 16)\r
        SecondByte = int(ValueList[Index + 1], 16)\r
        if SecondByte != 0:\r
            return None\r
\r
        if FirstByte not in range(0x20, 0x7F):\r
            return None\r
        TransferedStr += ('%c')%FirstByte\r
        Index = Index + 2\r
\r
    return 'L"' + TransferedStr + '"'\r
\r
## IsRequiredItemListNull\r
#\r
# Check if a required XML section item/attribue is NULL\r
#\r
# @param ItemList:     The list of items to be checked\r
# @param XmlTreeLevel: The error message tree level\r
#\r
def IsRequiredItemListNull(ItemDict, XmlTreeLevel):\r
    for Key in ItemDict:\r
        if not ItemDict[Key]:\r
            Msg = "->".join(Node for Node in XmlTreeLevel)\r
            ErrorMsg = ERR_XML_PARSER_REQUIRED_ITEM_MISSING % (Key, Msg)\r
            Logger.Error('\nUPT', PARSER_ERROR, ErrorMsg, RaiseError=True)\r
\r
## Get help text\r
#\r
# @param HelpText\r
#\r
def GetHelpTextList(HelpText):\r
    HelpTextList = []\r
    for HelT in HelpText:\r
        HelpTextObj = TextObject()\r
        HelpTextObj.SetLang(HelT.Lang)\r
        HelpTextObj.SetString(HelT.HelpText)\r
        HelpTextList.append(HelpTextObj)\r
    return HelpTextList\r
\r
## Get Prompt text\r
#\r
# @param Prompt\r
#\r
def GetPromptList(Prompt):\r
    PromptList = []\r
    for SubPrompt in Prompt:\r
        PromptObj = TextObject()\r
        PromptObj.SetLang(SubPrompt.Lang)\r
        PromptObj.SetString(SubPrompt.Prompt)\r
        PromptList.append(PromptObj)\r
    return PromptList\r