BaseTools: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / BaseTools / Source / Python / Common / BuildToolError.py

## @file\r
# Standardized Error Handling infrastructures.\r
#\r
# Copyright (c) 2007 - 2016, Intel Corporation. All rights reserved.<BR>\r
# SPDX-License-Identifier: BSD-2-Clause-Patent\r
#\r
\r
FILE_OPEN_FAILURE = 1\r
FILE_WRITE_FAILURE = 2\r
FILE_PARSE_FAILURE = 3\r
FILE_READ_FAILURE = 4\r
FILE_CREATE_FAILURE = 5\r
FILE_CHECKSUM_FAILURE = 6\r
FILE_COMPRESS_FAILURE = 7\r
FILE_DECOMPRESS_FAILURE = 8\r
FILE_MOVE_FAILURE = 9\r
FILE_DELETE_FAILURE = 10\r
FILE_COPY_FAILURE = 11\r
FILE_POSITIONING_FAILURE = 12\r
FILE_ALREADY_EXIST = 13\r
FILE_NOT_FOUND = 14\r
FILE_TYPE_MISMATCH = 15\r
FILE_CASE_MISMATCH = 16\r
FILE_DUPLICATED = 17\r
FILE_UNKNOWN_ERROR = 0x0FFF\r
\r
OPTION_UNKNOWN = 0x1000\r
OPTION_MISSING = 0x1001\r
OPTION_CONFLICT = 0x1002\r
OPTION_VALUE_INVALID = 0x1003\r
OPTION_DEPRECATED = 0x1004\r
OPTION_NOT_SUPPORTED = 0x1005\r
OPTION_UNKNOWN_ERROR = 0x1FFF\r
\r
PARAMETER_INVALID = 0x2000\r
PARAMETER_MISSING = 0x2001\r
PARAMETER_UNKNOWN_ERROR =0x2FFF\r
\r
FORMAT_INVALID = 0x3000\r
FORMAT_NOT_SUPPORTED = 0x3001\r
FORMAT_UNKNOWN = 0x3002\r
FORMAT_UNKNOWN_ERROR = 0x3FFF\r
\r
RESOURCE_NOT_AVAILABLE = 0x4000\r
RESOURCE_ALLOCATE_FAILURE = 0x4001\r
RESOURCE_FULL = 0x4002\r
RESOURCE_OVERFLOW = 0x4003\r
RESOURCE_UNDERRUN = 0x4004\r
RESOURCE_UNKNOWN_ERROR = 0x4FFF\r
\r
ATTRIBUTE_NOT_AVAILABLE = 0x5000\r
ATTRIBUTE_GET_FAILURE = 0x5001\r
ATTRIBUTE_SET_FAILURE = 0x5002\r
ATTRIBUTE_UPDATE_FAILURE = 0x5003\r
ATTRIBUTE_ACCESS_DENIED = 0x5004\r
ATTRIBUTE_UNKNOWN_ERROR = 0x5FFF\r
\r
IO_NOT_READY = 0x6000\r
IO_BUSY = 0x6001\r
IO_TIMEOUT = 0x6002\r
IO_UNKNOWN_ERROR = 0x6FFF\r
\r
COMMAND_FAILURE = 0x7000\r
\r
PERMISSION_FAILURE = 0x8000\r
\r
CODE_ERROR = 0xC0DE\r
\r
AUTOGEN_ERROR = 0xF000\r
PARSER_ERROR = 0xF001\r
BUILD_ERROR = 0xF002\r
GENFDS_ERROR = 0xF003\r
ECC_ERROR = 0xF004\r
EOT_ERROR = 0xF005\r
PREBUILD_ERROR = 0xF007\r
POSTBUILD_ERROR = 0xF008\r
DDC_ERROR = 0xF009\r
WARNING_AS_ERROR = 0xF006\r
MIGRATION_ERROR = 0xF010\r
PCD_VALIDATION_INFO_ERROR = 0xF011\r
PCD_VARIABLE_ATTRIBUTES_ERROR = 0xF012\r
PCD_VARIABLE_INFO_ERROR = 0xF016\r
PCD_VARIABLE_ATTRIBUTES_CONFLICT_ERROR = 0xF013\r
PCD_STRUCTURE_PCD_INVALID_FIELD_ERROR = 0xF014\r
PCD_STRUCTURE_PCD_ERROR = 0xF015\r
ERROR_STATEMENT = 0xFFFD\r
ABORT_ERROR = 0xFFFE\r
UNKNOWN_ERROR = 0xFFFF\r
\r
## Error message of each error code\r
gErrorMessage = {\r
    FILE_NOT_FOUND          :   "File/directory not found in workspace",\r
    FILE_OPEN_FAILURE       :   "File open failure",\r
    FILE_WRITE_FAILURE      :   "File write failure",\r
    FILE_PARSE_FAILURE      :   "File parse failure",\r
    FILE_READ_FAILURE       :   "File read failure",\r
    FILE_CREATE_FAILURE     :   "File create failure",\r
    FILE_CHECKSUM_FAILURE   :   "Invalid checksum of file",\r
    FILE_COMPRESS_FAILURE   :   "File compress failure",\r
    FILE_DECOMPRESS_FAILURE :   "File decompress failure",\r
    FILE_MOVE_FAILURE       :   "File move failure",\r
    FILE_DELETE_FAILURE     :   "File delete failure",\r
    FILE_COPY_FAILURE       :   "File copy failure",\r
    FILE_POSITIONING_FAILURE:   "Failed to seeking position",\r
    FILE_ALREADY_EXIST      :   "File or directory already exists",\r
    FILE_TYPE_MISMATCH      :   "Incorrect file type",\r
    FILE_CASE_MISMATCH      :   "File name case mismatch",\r
    FILE_DUPLICATED         :   "Duplicated file found",\r
    FILE_UNKNOWN_ERROR      :   "Unknown error encountered on file",\r
\r
    OPTION_UNKNOWN          :   "Unknown option",\r
    OPTION_MISSING          :   "Missing option",\r
    OPTION_CONFLICT         :   "Conflict options",\r
    OPTION_VALUE_INVALID    :   "Invalid value of option",\r
    OPTION_DEPRECATED       :   "Deprecated option",\r
    OPTION_NOT_SUPPORTED    :   "Unsupported option",\r
    OPTION_UNKNOWN_ERROR    :   "Unknown error when processing options",\r
\r
    PARAMETER_INVALID       :   "Invalid parameter",\r
    PARAMETER_MISSING       :   "Missing parameter",\r
    PARAMETER_UNKNOWN_ERROR :   "Unknown error in parameters",\r
\r
    FORMAT_INVALID          :   "Invalid syntax/format",\r
    FORMAT_NOT_SUPPORTED    :   "Not supported syntax/format",\r
    FORMAT_UNKNOWN          :   "Unknown format",\r
    FORMAT_UNKNOWN_ERROR    :   "Unknown error in syntax/format ",\r
\r
    RESOURCE_NOT_AVAILABLE  :   "Not available",\r
    RESOURCE_ALLOCATE_FAILURE :   "Allocate failure",\r
    RESOURCE_FULL           :   "Full",\r
    RESOURCE_OVERFLOW       :   "Overflow",\r
    RESOURCE_UNDERRUN       :   "Underrun",\r
    RESOURCE_UNKNOWN_ERROR  :   "Unknown error",\r
\r
    ATTRIBUTE_NOT_AVAILABLE :   "Not available",\r
    ATTRIBUTE_GET_FAILURE   :   "Failed to retrieve",\r
    ATTRIBUTE_SET_FAILURE   :   "Failed to set",\r
    ATTRIBUTE_UPDATE_FAILURE:   "Failed to update",\r
    ATTRIBUTE_ACCESS_DENIED :   "Access denied",\r
    ATTRIBUTE_UNKNOWN_ERROR :   "Unknown error when accessing",\r
\r
    COMMAND_FAILURE         :   "Failed to execute command",\r
\r
    IO_NOT_READY            :   "Not ready",\r
    IO_BUSY                 :   "Busy",\r
    IO_TIMEOUT              :   "Timeout",\r
    IO_UNKNOWN_ERROR        :   "Unknown error in IO operation",\r
\r
    ERROR_STATEMENT         :   "!error statement",\r
    UNKNOWN_ERROR           :   "Unknown error",\r
}\r
\r
## Exception indicating a fatal error\r
class FatalError(Exception):\r
    pass\r
\r
if __name__ == "__main__":\r
    pass\r