]>
git.proxmox.com Git - mirror_edk2.git/blob - BaseTools/Source/Python/Common/String.py
2 # This file is used to define common string related functions used in parsing process
4 # Copyright (c) 2007 ~ 2008, 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
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.
21 import EdkLogger
as EdkLogger
23 from GlobalData
import *
24 from BuildToolError
import *
28 # Get a value list from a string with multiple values splited with SplitTag
29 # The default SplitTag is DataType.TAB_VALUE_SPLIT
30 # 'AAA|BBB|CCC' -> ['AAA', 'BBB', 'CCC']
32 # @param String: The input string to be splitted
33 # @param SplitTag: The split key, default is DataType.TAB_VALUE_SPLIT
34 # @param MaxSplit: The max number of split values, default is -1
36 # @retval list() A list for splitted string
38 def GetSplitValueList(String
, SplitTag
= DataType
.TAB_VALUE_SPLIT
, MaxSplit
= -1):
39 return map(lambda l
: l
.strip(), String
.split(SplitTag
, MaxSplit
))
43 # Find a key's all arches in dict, add the new arch to the list
44 # If not exist any arch, set the arch directly
46 # @param Dict: The input value for Dict
47 # @param Key: The input value for Key
48 # @param Arch: The Arch to be added or merged
50 def MergeArches(Dict
, Key
, Arch
):
51 if Key
in Dict
.keys():
52 Dict
[Key
].append(Arch
)
54 Dict
[Key
] = Arch
.split()
58 # Parse a string with format "DEFINE <VarName> = <PATH>"
59 # Generate a map Defines[VarName] = PATH
60 # Return False if invalid format
62 # @param String: String with DEFINE statement
63 # @param Arch: Supportted Arch
64 # @param Defines: DEFINE statement to be parsed
66 # @retval 0 DEFINE statement found, and valid
67 # @retval 1 DEFINE statement found, but not valid
68 # @retval -1 DEFINE statement not found
70 def GenDefines(String
, Arch
, Defines
):
71 if String
.find(DataType
.TAB_DEFINE
+ ' ') > -1:
72 List
= String
.replace(DataType
.TAB_DEFINE
+ ' ', '').split(DataType
.TAB_EQUAL_SPLIT
)
74 Defines
[(CleanString(List
[0]), Arch
)] = CleanString(List
[1])
83 # Parse a string with format "!include <Filename>"
84 # Return the file path
85 # Return False if invalid format or NOT FOUND
87 # @param String: String with INCLUDE statement
88 # @param IncludeFiles: INCLUDE statement to be parsed
89 # @param Arch: Supportted Arch
94 def GenInclude(String
, IncludeFiles
, Arch
):
95 if String
.upper().find(DataType
.TAB_INCLUDE
.upper() + ' ') > -1:
96 IncludeFile
= CleanString(String
[String
.upper().find(DataType
.TAB_INCLUDE
.upper() + ' ') + len(DataType
.TAB_INCLUDE
+ ' ') : ])
97 MergeArches(IncludeFiles
, IncludeFile
, Arch
)
102 ## GetLibraryClassesWithModuleType
104 # Get Library Class definition when no module type defined
106 # @param Lines: The content to be parsed
107 # @param Key: Reserved
108 # @param KeyValues: To store data after parsing
109 # @param CommentCharacter: Comment char, used to ignore comment content
111 # @retval True Get library classes successfully
113 def GetLibraryClassesWithModuleType(Lines
, Key
, KeyValues
, CommentCharacter
):
114 newKey
= SplitModuleType(Key
)
115 Lines
= Lines
.split(DataType
.TAB_SECTION_END
, 1)[1]
116 LineList
= Lines
.splitlines()
117 for Line
in LineList
:
118 Line
= CleanString(Line
, CommentCharacter
)
119 if Line
!= '' and Line
[0] != CommentCharacter
:
120 KeyValues
.append([CleanString(Line
, CommentCharacter
), newKey
[1]])
128 # @param Lines: The content to be parsed
129 # @param Key: Reserved
130 # @param KeyValues: To store data after parsing
131 # @param CommentCharacter: Comment char, used to ignore comment content
133 # @retval True Get Dynamic Pcds successfully
135 def GetDynamics(Lines
, Key
, KeyValues
, CommentCharacter
):
137 # Get SkuId Name List
139 SkuIdNameList
= SplitModuleType(Key
)
141 Lines
= Lines
.split(DataType
.TAB_SECTION_END
, 1)[1]
142 LineList
= Lines
.splitlines()
143 for Line
in LineList
:
144 Line
= CleanString(Line
, CommentCharacter
)
145 if Line
!= '' and Line
[0] != CommentCharacter
:
146 KeyValues
.append([CleanString(Line
, CommentCharacter
), SkuIdNameList
[1]])
152 # Split ModuleType out of section defien to get key
153 # [LibraryClass.Arch.ModuleType|ModuleType|ModuleType] -> [ 'LibraryClass.Arch', ['ModuleType', 'ModuleType', 'ModuleType'] ]
155 # @param Key: String to be parsed
157 # @retval ReturnValue A list for module types
159 def SplitModuleType(Key
):
160 KeyList
= Key
.split(DataType
.TAB_SPLIT
)
166 # Fill in for moduletype
170 KeyValue
= KeyList
[0]
172 KeyValue
= KeyValue
+ DataType
.TAB_SPLIT
+ KeyList
[1]
173 ReturnValue
.append(KeyValue
)
174 ReturnValue
.append(GetSplitValueList(KeyList
[2]))
178 ## Replace macro in strings list
180 # This method replace macros used in a given string list. The macros are
181 # given in a dictionary.
183 # @param StringList StringList to be processed
184 # @param MacroDefinitions The macro definitions in the form of dictionary
185 # @param SelfReplacement To decide whether replace un-defined macro to ''
187 # @retval NewList A new string list whose macros are replaced
189 def ReplaceMacros(StringList
, MacroDefinitions
={}, SelfReplacement
= False):
191 for String
in StringList
:
192 if type(String
) == type(''):
193 NewList
.append(ReplaceMacro(String
, MacroDefinitions
, SelfReplacement
))
195 NewList
.append(String
)
199 ## Replace macro in string
201 # This method replace macros used in given string. The macros are given in a
204 # @param String String to be processed
205 # @param MacroDefinitions The macro definitions in the form of dictionary
206 # @param SelfReplacement To decide whether replace un-defined macro to ''
208 # @retval string The string whose macros are replaced
210 def ReplaceMacro(String
, MacroDefinitions
={}, SelfReplacement
= False):
212 while MacroDefinitions
:
213 MacroUsed
= gMacroPattern
.findall(String
)
214 # no macro found in String, stop replacing
215 if len(MacroUsed
) == 0:
218 for Macro
in MacroUsed
:
219 if Macro
not in MacroDefinitions
:
221 String
= String
.replace("$(%s)" % Macro
, '')
223 String
= String
.replace("$(%s)" % Macro
, MacroDefinitions
[Macro
])
224 # in case there's macro not defined
225 if String
== LastString
:
233 # Create a normal path
234 # And replace DFEINE in the path
236 # @param Path: The input value for Path to be converted
237 # @param Defines: A set for DEFINE statement
239 # @retval Path Formatted path
241 def NormPath(Path
, Defines
= {}):
242 IsRelativePath
= False
245 IsRelativePath
= True
247 # Replace with Define
250 Path
= ReplaceMacro(Path
, Defines
)
252 # To local path format
254 Path
= os
.path
.normpath(Path
)
256 if IsRelativePath
and Path
[0] != '.':
257 Path
= os
.path
.join('.', Path
)
263 # Remove comments in a string
266 # @param Line: The string to be cleaned
267 # @param CommentCharacter: Comment char, used to ignore comment content, default is DataType.TAB_COMMENT_SPLIT
269 # @retval Path Formatted path
271 def CleanString(Line
, CommentCharacter
= DataType
.TAB_COMMENT_SPLIT
, AllowCppStyleComment
=False):
277 # Replace R8's comment character
279 if AllowCppStyleComment
:
280 Line
= Line
.replace(DataType
.TAB_COMMENT_R8_SPLIT
, CommentCharacter
)
284 Line
= Line
.split(CommentCharacter
, 1)[0];
286 # remove whitespace again
292 ## GetMultipleValuesOfKeyFromLines
294 # Parse multiple strings to clean comment and spaces
295 # The result is saved to KeyValues
297 # @param Lines: The content to be parsed
298 # @param Key: Reserved
299 # @param KeyValues: To store data after parsing
300 # @param CommentCharacter: Comment char, used to ignore comment content
302 # @retval True Successfully executed
304 def GetMultipleValuesOfKeyFromLines(Lines
, Key
, KeyValues
, CommentCharacter
):
305 Lines
= Lines
.split(DataType
.TAB_SECTION_END
, 1)[1]
306 LineList
= Lines
.split('\n')
307 for Line
in LineList
:
308 Line
= CleanString(Line
, CommentCharacter
)
309 if Line
!= '' and Line
[0] != CommentCharacter
:
316 # Parse a DEFINE statement to get defined value
319 # @param String: The content to be parsed
320 # @param Key: The key of DEFINE statement
321 # @param CommentCharacter: Comment char, used to ignore comment content
323 # @retval string The defined value
325 def GetDefineValue(String
, Key
, CommentCharacter
):
326 String
= CleanString(String
)
327 return String
[String
.find(Key
+ ' ') + len(Key
+ ' ') : ]
329 ## GetSingleValueOfKeyFromLines
331 # Parse multiple strings as below to get value of each definition line
334 # The result is saved to Dictionary
336 # @param Lines: The content to be parsed
337 # @param Dictionary: To store data after parsing
338 # @param CommentCharacter: Comment char, be used to ignore comment content
339 # @param KeySplitCharacter: Key split char, between key name and key value. Key1 = Value1, '=' is the key split char
340 # @param ValueSplitFlag: Value split flag, be used to decide if has multiple values
341 # @param ValueSplitCharacter: Value split char, be used to split multiple values. Key1 = Value1|Value2, '|' is the value split char
343 # @retval True Successfully executed
345 def GetSingleValueOfKeyFromLines(Lines
, Dictionary
, CommentCharacter
, KeySplitCharacter
, ValueSplitFlag
, ValueSplitCharacter
):
346 Lines
= Lines
.split('\n')
354 # Handle DEFINE and SPEC
356 if Line
.find(DataType
.TAB_INF_DEFINES_DEFINE
+ ' ') > -1:
357 if '' in DefineValues
:
358 DefineValues
.remove('')
359 DefineValues
.append(GetDefineValue(Line
, DataType
.TAB_INF_DEFINES_DEFINE
, CommentCharacter
))
361 if Line
.find(DataType
.TAB_INF_DEFINES_SPEC
+ ' ') > -1:
363 SpecValues
.remove('')
364 SpecValues
.append(GetDefineValue(Line
, DataType
.TAB_INF_DEFINES_SPEC
, CommentCharacter
))
370 LineList
= Line
.split(KeySplitCharacter
, 1)
371 if len(LineList
) >= 2:
372 Key
= LineList
[0].split()
373 if len(Key
) == 1 and Key
[0][0] != CommentCharacter
:
375 # Remove comments and white spaces
377 LineList
[1] = CleanString(LineList
[1], CommentCharacter
)
379 Value
= map(string
.strip
, LineList
[1].split(ValueSplitCharacter
))
381 Value
= CleanString(LineList
[1], CommentCharacter
).splitlines()
383 if Key
[0] in Dictionary
:
384 if Key
[0] not in Keys
:
385 Dictionary
[Key
[0]] = Value
388 Dictionary
[Key
[0]].extend(Value
)
390 Dictionary
[DataType
.TAB_INF_DEFINES_MACRO
][Key
[0]] = Value
[0]
392 if DefineValues
== []:
396 Dictionary
[DataType
.TAB_INF_DEFINES_DEFINE
] = DefineValues
397 Dictionary
[DataType
.TAB_INF_DEFINES_SPEC
] = SpecValues
401 ## The content to be parsed
403 # Do pre-check for a file before it is parsed
407 # @param FileName: Used for error report
408 # @param FileContent: File content to be parsed
409 # @param SupSectionTag: Used for error report
411 def PreCheck(FileName
, FileContent
, SupSectionTag
):
415 for Line
in FileContent
.splitlines():
420 Line
= CleanString(Line
)
423 # Remove commented line
425 if Line
.find(DataType
.TAB_COMMA_SPLIT
) == 0:
430 if Line
.find('$') > -1:
431 if Line
.find('$(') < 0 or Line
.find(')') < 0:
432 EdkLogger
.error("Parser", FORMAT_INVALID
, Line
=LineNo
, File
=FileName
, RaiseError
= EdkLogger
.IsRaiseError
)
437 if Line
.find('[') > -1 or Line
.find(']') > -1:
439 # Only get one '[' or one ']'
441 if not (Line
.find('[') > -1 and Line
.find(']') > -1):
442 EdkLogger
.error("Parser", FORMAT_INVALID
, Line
=LineNo
, File
=FileName
, RaiseError
= EdkLogger
.IsRaiseError
)
445 # Regenerate FileContent
447 NewFileContent
= NewFileContent
+ Line
+ '\r\n'
450 EdkLogger
.error("Parser", FORMAT_INVALID
, Line
=LineNo
, File
=FileName
, RaiseError
= EdkLogger
.IsRaiseError
)
452 return NewFileContent
456 # Check if the Filename is including ExtName
457 # Return True if it exists
458 # Raise a error message if it not exists
460 # @param CheckFilename: Name of the file to be checked
461 # @param ExtName: Ext name of the file to be checked
462 # @param ContainerFilename: The container file which describes the file to be checked, used for error report
463 # @param SectionName: Used for error report
464 # @param Line: The line in container file which defines the file to be checked
466 # @retval True The file type is correct
468 def CheckFileType(CheckFilename
, ExtName
, ContainerFilename
, SectionName
, Line
, LineNo
= -1):
469 if CheckFilename
!= '' and CheckFilename
!= None:
470 (Root
, Ext
) = os
.path
.splitext(CheckFilename
)
471 if Ext
.upper() != ExtName
.upper():
472 ContainerFile
= open(ContainerFilename
, 'r').read()
474 LineNo
= GetLineNo(ContainerFile
, Line
)
475 ErrorMsg
= "Invalid %s. '%s' is found, but '%s' file is needed" % (SectionName
, CheckFilename
, ExtName
)
476 EdkLogger
.error("Parser", PARSER_ERROR
, ErrorMsg
, Line
=LineNo
,
477 File
=ContainerFilename
, RaiseError
= EdkLogger
.IsRaiseError
)
483 # Check if the file exists
484 # Return True if it exists
485 # Raise a error message if it not exists
487 # @param CheckFilename: Name of the file to be checked
488 # @param WorkspaceDir: Current workspace dir
489 # @param ContainerFilename: The container file which describes the file to be checked, used for error report
490 # @param SectionName: Used for error report
491 # @param Line: The line in container file which defines the file to be checked
493 # @retval The file full path if the file exists
495 def CheckFileExist(WorkspaceDir
, CheckFilename
, ContainerFilename
, SectionName
, Line
, LineNo
= -1):
497 if CheckFilename
!= '' and CheckFilename
!= None:
498 CheckFile
= WorkspaceFile(WorkspaceDir
, CheckFilename
)
499 if not os
.path
.isfile(CheckFile
):
500 ContainerFile
= open(ContainerFilename
, 'r').read()
502 LineNo
= GetLineNo(ContainerFile
, Line
)
503 ErrorMsg
= "Can't find file '%s' defined in section '%s'" % (CheckFile
, SectionName
)
504 EdkLogger
.error("Parser", PARSER_ERROR
, ErrorMsg
,
505 File
=ContainerFilename
, Line
= LineNo
, RaiseError
= EdkLogger
.IsRaiseError
)
511 # Find the index of a line in a file
513 # @param FileContent: Search scope
514 # @param Line: Search key
516 # @retval int Index of the line
517 # @retval -1 The line is not found
519 def GetLineNo(FileContent
, Line
, IsIgnoreComment
= True):
520 LineList
= FileContent
.splitlines()
521 for Index
in range(len(LineList
)):
522 if LineList
[Index
].find(Line
) > -1:
524 # Ignore statement in comment
527 if LineList
[Index
].strip()[0] == DataType
.TAB_COMMENT_SPLIT
:
535 # Raise a parser error
537 # @param Line: String which has error
538 # @param Section: Used for error report
539 # @param File: File which has the string
540 # @param Format: Correct format
542 def RaiseParserError(Line
, Section
, File
, Format
= '', LineNo
= -1):
544 LineNo
= GetLineNo(open(os
.path
.normpath(File
), 'r').read(), Line
)
545 ErrorMsg
= "Invalid statement '%s' is found in section '%s'" % (Line
, Section
)
547 Format
= "Correct format is " + Format
548 EdkLogger
.error("Parser", PARSER_ERROR
, ErrorMsg
, File
=File
, Line
=LineNo
, ExtraData
=Format
, RaiseError
= EdkLogger
.IsRaiseError
)
552 # Return a full path with workspace dir
554 # @param WorkspaceDir: Workspace dir
555 # @param Filename: Relative file name
557 # @retval string A full path
559 def WorkspaceFile(WorkspaceDir
, Filename
):
560 return os
.path
.join(NormPath(WorkspaceDir
), NormPath(Filename
))
564 # Revmove '"' which startswith and endswith string
566 # @param String: The string need to be splited
568 # @retval String: The string after removed '""'
570 def SplitString(String
):
571 if String
.startswith('\"'):
573 if String
.endswith('\"'):
578 ## Convert To Sql String
580 # 1. Replace "'" with "''" in each item of StringList
582 # @param StringList: A list for strings to be converted
584 def ConvertToSqlString(StringList
):
585 return map(lambda s
: s
.replace("'", "''") , StringList
)
587 ## Convert To Sql String
589 # 1. Replace "'" with "''" in the String
591 # @param String: A String to be converted
593 def ConvertToSqlString2(String
):
594 return String
.replace("'", "''")
597 # Remove comment block
599 def RemoveBlockComment(Lines
):
600 IsFindBlockComment
= False
601 IsFindBlockCode
= False
608 # Remove comment block
610 if Line
.find(DataType
.TAB_COMMENT_R8_START
) > -1:
611 ReservedLine
= GetSplitValueList(Line
, DataType
.TAB_COMMENT_R8_START
, 1)[0]
612 IsFindBlockComment
= True
613 if Line
.find(DataType
.TAB_COMMENT_R8_END
) > -1:
614 Line
= ReservedLine
+ GetSplitValueList(Line
, DataType
.TAB_COMMENT_R8_END
, 1)[1]
616 IsFindBlockComment
= False
617 if IsFindBlockComment
:
621 NewLines
.append(Line
)
625 # Get String of a List
627 def GetStringOfList(List
, Split
= ' '):
628 if type(List
) != type([]):
632 Str
= Str
+ Item
+ Split
637 # Get HelpTextList from HelpTextClassList
639 def GetHelpTextList(HelpTextClassList
):
641 if HelpTextClassList
:
642 for HelpText
in HelpTextClassList
:
643 if HelpText
.String
.endswith('\n'):
644 HelpText
.String
= HelpText
.String
[0: len(HelpText
.String
) - len('\n')]
645 List
.extend(HelpText
.String
.split('\n'))
649 def StringToArray(String
):
650 if isinstance(String
, unicode):
652 return "{0x00, 0x00}"
653 return "{%s, 0x00, 0x00}" % ", ".join(["0x%02x, 0x00" % ord(C
) for C
in String
])
654 elif String
.startswith('L"'):
655 if String
== "L\"\"":
656 return "{0x00, 0x00}"
658 return "{%s, 0x00, 0x00}" % ", ".join(["0x%02x, 0x00" % ord(C
) for C
in String
[2:-1]])
659 elif String
.startswith('"'):
663 return "{%s, 0x00}" % ", ".join(["0x%02x" % ord(C
) for C
in String
[1:-1]])
665 return '{%s, 0}' % ', '.join(String
.split())
667 def StringArrayLength(String
):
668 if isinstance(String
, unicode):
669 return (len(String
) + 1) * 2 + 1;
670 elif String
.startswith('L"'):
671 return (len(String
) - 3 + 1) * 2
672 elif String
.startswith('"'):
673 return (len(String
) - 2 + 1)
675 return len(String
.split()) + 1
677 def RemoveDupOption(OptionString
, Which
="/I", Against
=None):
678 OptionList
= OptionString
.split()
682 for Index
in range(len(OptionList
)):
683 Opt
= OptionList
[Index
]
684 if not Opt
.startswith(Which
):
686 if len(Opt
) > len(Which
):
687 Val
= Opt
[len(Which
):]
691 OptionList
[Index
] = ""
693 ValueList
.append(Val
)
694 return " ".join(OptionList
)
698 # This acts like the main() function for the script, unless it is 'import'ed into another
701 if __name__
== '__main__':