[Patch] BaseTools: Fix a bug for ExpandMacros to support mixed case ENV var

[Patch] BaseTools: Fix a bug for ExpandMacros to support mixed case ENV var

[Yonghong Zhu]

os.environ contains all environment variables uppercase on Windows which
cause the key in the self.MacroDictionary is uppercase, but the real
variable name maybe mixed case, eg:WINSDK81x86, then we can't find the
variable in the self.MacroDictionary.

Cc: Liming Gao <liming.gao@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Yonghong Zhu <yonghong.zhu@intel.com>
---
 BaseTools/Source/Python/Common/ToolDefClassObject.py | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/BaseTools/Source/Python/Common/ToolDefClassObject.py b/BaseTools/Source/Python/Common/ToolDefClassObject.py
index 5dd505c..a71c616 100644
--- a/BaseTools/Source/Python/Common/ToolDefClassObject.py
+++ b/BaseTools/Source/Python/Common/ToolDefClassObject.py
@@ -234,17 +234,20 @@ class ToolDefClassObject(object):
     # @param Value:   The string with unreplaced macros
     #
     # @retval Value:  The string which has been replaced with real value
     #
     def ExpandMacros(self, Value):
+        # os.environ contains all environment variables uppercase on Windows which cause the key in the self.MacroDictionary is uppercase, but Ref may not
         EnvReference = gEnvRefPattern.findall(Value)
         for Ref in EnvReference:
-            if Ref not in self.MacroDictionary:
+            if Ref not in self.MacroDictionary and Ref.upper() not in self.MacroDictionary:
                 Value = Value.replace(Ref, "")
             else:
-                Value = Value.replace(Ref, self.MacroDictionary[Ref])
- 
+                if Ref in self.MacroDictionary:
+                    Value = Value.replace(Ref, self.MacroDictionary[Ref])
+                else:
+                    Value = Value.replace(Ref, self.MacroDictionary[Ref.upper()])
 
         MacroReference = gMacroRefPattern.findall(Value)
         for Ref in MacroReference:
             if Ref not in self.MacroDictionary:
                 return False, Ref
-- 
2.6.1.windows.1

Re: [Patch] BaseTools: Fix a bug for ExpandMacros to support mixed case ENV var

[Gao, Liming]

Reviewed-by: Liming Gao <liming.gao@intel.com>

> -----Original Message-----
> From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf Of
> Yonghong Zhu
> Sent: Friday, October 28, 2016 12:43 PM
> To: edk2-devel@lists.01.org
> Cc: Gao, Liming <liming.gao@intel.com>
> Subject: [edk2] [Patch] BaseTools: Fix a bug for ExpandMacros to support
> mixed case ENV var
> 
> os.environ contains all environment variables uppercase on Windows which
> cause the key in the self.MacroDictionary is uppercase, but the real
> variable name maybe mixed case, eg:WINSDK81x86, then we can't find the
> variable in the self.MacroDictionary.
> 
> Cc: Liming Gao <liming.gao@intel.com>
> Contributed-under: TianoCore Contribution Agreement 1.0
> Signed-off-by: Yonghong Zhu <yonghong.zhu@intel.com>
> ---
>  BaseTools/Source/Python/Common/ToolDefClassObject.py | 9 ++++++---
>  1 file changed, 6 insertions(+), 3 deletions(-)
> 
> diff --git a/BaseTools/Source/Python/Common/ToolDefClassObject.py
> b/BaseTools/Source/Python/Common/ToolDefClassObject.py
> index 5dd505c..a71c616 100644
> --- a/BaseTools/Source/Python/Common/ToolDefClassObject.py
> +++ b/BaseTools/Source/Python/Common/ToolDefClassObject.py
> @@ -234,17 +234,20 @@ class ToolDefClassObject(object):
>      # @param Value:   The string with unreplaced macros
>      #
>      # @retval Value:  The string which has been replaced with real value
>      #
>      def ExpandMacros(self, Value):
> +        # os.environ contains all environment variables uppercase on Windows
> which cause the key in the self.MacroDictionary is uppercase, but Ref may
> not
>          EnvReference = gEnvRefPattern.findall(Value)
>          for Ref in EnvReference:
> -            if Ref not in self.MacroDictionary:
> +            if Ref not in self.MacroDictionary and Ref.upper() not in
> self.MacroDictionary:
>                  Value = Value.replace(Ref, "")
>              else:
> -                Value = Value.replace(Ref, self.MacroDictionary[Ref])
> -
> +                if Ref in self.MacroDictionary:
> +                    Value = Value.replace(Ref, self.MacroDictionary[Ref])
> +                else:
> +                    Value = Value.replace(Ref, self.MacroDictionary[Ref.upper()])
> 
>          MacroReference = gMacroRefPattern.findall(Value)
>          for Ref in MacroReference:
>              if Ref not in self.MacroDictionary:
>                  return False, Ref
> --
> 2.6.1.windows.1
> 
> _______________________________________________
> edk2-devel mailing list
> edk2-devel@lists.01.org
> https://lists.01.org/mailman/listinfo/edk2-devel