From 1be2ed90a20618d71ddf34b8a07d038da0b36854 Mon Sep 17 00:00:00 2001
From: Hess Chen <hesheng.chen@intel.com>
Date: Fri, 15 Aug 2014 03:06:48 +0000
Subject: There is a limitation on WINDOWS OS for the length of entire file
 path can’t be larger than 255. There is an OS API provided by Microsoft to
 add “\\?\” before the path header to support the long file path. Enable this
 feature on basetools.
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Hess Chen <hesheng.chen@intel.com>
Reviewed-by: Yingke Liu <yingke.d.liu@intel.com>

git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@15809 6f19259b-4bc3-4df7-8a09-765794883524
---
 .../Source/Python/Common/LongFilePathSupport.py    | 59 ++++++++++++++++++++++
 1 file changed, 59 insertions(+)
 create mode 100644 BaseTools/Source/Python/Common/LongFilePathSupport.py

(limited to 'BaseTools/Source/Python/Common/LongFilePathSupport.py')

diff --git a/BaseTools/Source/Python/Common/LongFilePathSupport.py b/BaseTools/Source/Python/Common/LongFilePathSupport.py
new file mode 100644
index 0000000000..72dde20503
--- /dev/null
+++ b/BaseTools/Source/Python/Common/LongFilePathSupport.py
@@ -0,0 +1,59 @@
+## @file
+# Override built in function file.open to provide support for long file path
+#
+# Copyright (c) 2014, Intel Corporation. All rights reserved.<BR>
+# This program and the accompanying materials
+# are licensed and made available under the terms and conditions of the BSD License
+# which accompanies this distribution.  The full text of the license may be found at
+# http://opensource.org/licenses/bsd-license.php
+#
+# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+#
+
+import os
+import platform
+import shutil
+
+##
+# OpenLongPath
+# Convert a file path to a long file path
+#
+def LongFilePath(FileName):
+    FileName = os.path.normpath(FileName)
+    if platform.system() == 'Windows':
+        if FileName.startswith('\\\\?\\'):
+            return FileName
+        if FileName.startswith('\\\\'):
+            return '\\\\?\\UNC\\' + FileName[2:]
+        if os.path.isabs(FileName):
+            return '\\\\?\\' + FileName
+    return FileName
+
+##
+# OpenLongFilePath
+# wrap open to support opening a long file path
+#
+def OpenLongFilePath(FileName, Mode='r', Buffer= -1):
+    return open(LongFilePath(FileName), Mode, Buffer)
+
+##
+# CopyLongFilePath
+# wrap copyfile to support copy a long file path
+#
+def CopyLongFilePath(src, dst):
+    with open(LongFilePath(src), 'rb') as fsrc:
+        with open(LongFilePath(dst), 'wb') as fdst:
+            shutil.copyfileobj(fsrc, fdst)
+
+## Convert a python unicode string to a normal string
+#
+# Convert a python unicode string to a normal string
+# UniToStr(u'I am a string') is 'I am a string'
+#
+# @param Uni:  The python unicode string
+#
+# @retval:     The formatted normal string
+#
+def UniToStr(Uni):
+    return repr(Uni)[2:-1]
-- 
cgit v1.2.3