BaseTools/Scripts/PackageDocumentTools/plugins/EdkPlugins/basemodel/message.py

   1 ## @file
   2 #
   3 # Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>
   4 #
   5 # This program and the accompanying materials are licensed and made available
   6 # under the terms and conditions of the BSD License which accompanies this
   7 # distribution. The full text of the license may be found at
   8 # http://opensource.org/licenses/bsd-license.php
   9 #
  10 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12 #
  13
  14 def GetEdkLogger():
  15     import logging
  16     return logging.getLogger('edk')
  17
  18 class EdkException(Exception):
  19     def __init__(self, message, fName=None, fNo=None):
  20         self._message = message
  21         ErrorMsg(message, fName, fNo)
  22
  23     def GetMessage(self):
  24         return '[EDK Failure]: %s' %self._message
  25
  26 def ErrorMsg(mess, fName=None, fNo=None):
  27     GetEdkLogger().error(NormalMessage('#ERR#', mess, fName, fNo))
  28
  29 def LogMsg(mess, fName=None, fNo=None):
  30     GetEdkLogger().info(NormalMessage('@LOG@', mess, fName, fNo))
  31
  32 def WarnMsg(mess, fName=None, fNo=None):
  33     GetEdkLogger().warning(NormalMessage('!WAR!', mess, fName, fNo))
  34
  35 def NormalMessage(type, mess, fName=None, fNo=None):
  36     strMsg = type
  37
  38     if fName != None:
  39         strMsg += ' %s' % fName.replace('/', '\\')
  40         if fNo != None:
  41             strMsg += '(%d):' % fNo
  42         else:
  43             strMsg += ' :'
  44
  45     if fName == None and fNo == None:
  46         strMsg += ' '
  47     strMsg += mess
  48
  49     return strMsg
  50
  51
  52