BaseTools/Source/Python/Common/Identification.py

   1 ## @file
   2 # This file is used to define the identification of INF/DEC/DSC files
   3 #
   4 # Copyright (c) 2007, Intel Corporation
   5 # All rights reserved. This program and the accompanying materials
   6 # are licensed and made available under the terms and conditions of the BSD License
   7 # which accompanies this 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 ## Identification
  14 #
  15 # This class defined basic Identification information structure which is used by INF/DEC/DSC files
  16 #
  17 # @param object:          Inherited from object class
  18 #
  19 # @var FileName:          To store data for Filename
  20 # @var FileFullPath:      To store data for full path of the file
  21 # @var FileRelativePath:  To store data for relative path of the file
  22 # @var RunStatus:       Status of build system running
  23 #
  24 class Identification(object):
  25     def __init__(self):
  26         self.FileName = ''
  27         self.FileFullPath = ''
  28         self.FileRelativePath = ''
  29         self.PackagePath = ''
  30
  31     ## GetFileName
  32     #
  33     # Reserved
  34     #
  35     def GetFileName(self, FileFullPath, FileRelativePath):
  36         pass
  37
  38     ## GetFileName
  39     #
  40     # Reserved
  41     #
  42     def GetFileFullPath(self, FileName, FileRelativePath):
  43         pass
  44
  45     ## GetFileName
  46     #
  47     # Reserved
  48     #
  49     def GetFileRelativePath(self, FileName, FileFullPath):
  50         pass
  51
  52 ##
  53 #
  54 # This acts like the main() function for the script, unless it is 'import'ed into another
  55 # script.
  56 #
  57 if __name__ == '__main__':
  58     id = Identification()