From f7496d717357b9af78414d19679b073403812340 Mon Sep 17 00:00:00 2001 From: Liming Gao Date: Thu, 5 Jul 2018 17:40:04 +0800 Subject: BaseTools: Clean up source files 1. Do not use tab characters 2. No trailing white space in one line 3. All files must end with CRLF Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Liming Gao Cc: Yonghong Zhu Reviewed-by: Yonghong Zhu --- BaseTools/Source/Python/Ecc/MetaDataParser.py | 48 +++++++++++++-------------- 1 file changed, 24 insertions(+), 24 deletions(-) (limited to 'BaseTools/Source/Python/Ecc/MetaDataParser.py') diff --git a/BaseTools/Source/Python/Ecc/MetaDataParser.py b/BaseTools/Source/Python/Ecc/MetaDataParser.py index 82ede3eb33..6060d67581 100644 --- a/BaseTools/Source/Python/Ecc/MetaDataParser.py +++ b/BaseTools/Source/Python/Ecc/MetaDataParser.py @@ -1,7 +1,7 @@ ## @file # This file is used to define common parser functions for meta-data # -# Copyright (c) 2008 - 2014, Intel Corporation. All rights reserved.
+# Copyright (c) 2008 - 2018, Intel Corporation. All rights reserved.
# 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 @@ -87,16 +87,16 @@ def GetTableList(FileModelList, Table, Db): # @param FileName: FileName of the comment # def ParseHeaderCommentSection(CommentList, FileName = None): - + Abstract = '' Description = '' Copyright = '' License = '' EndOfLine = "\n" STR_HEADER_COMMENT_START = "@file" - + # - # used to indicate the state of processing header comment section of dec, + # used to indicate the state of processing header comment section of dec, # inf files # HEADER_COMMENT_NOT_STARTED = -1 @@ -117,11 +117,11 @@ def ParseHeaderCommentSection(CommentList, FileName = None): if _IsCopyrightLine(Line): Last = Index break - + for Item in CommentList: Line = Item[0] LineNo = Item[1] - + if not Line.startswith('#') and Line: SqlStatement = """ select ID from File where FullPath like '%s'""" % FileName ResultSet = EccGlobalData.gDb.TblFile.Exec(SqlStatement) @@ -131,14 +131,14 @@ def ParseHeaderCommentSection(CommentList, FileName = None): Comment = CleanString2(Line)[1] Comment = Comment.strip() # - # if there are blank lines between License or Description, keep them as they would be + # if there are blank lines between License or Description, keep them as they would be # indication of different block; or in the position that Abstract should be, also keep it # as it indicates that no abstract # if not Comment and HeaderCommentStage not in [HEADER_COMMENT_LICENSE, \ HEADER_COMMENT_DESCRIPTION, HEADER_COMMENT_ABSTRACT]: continue - + if HeaderCommentStage == HEADER_COMMENT_NOT_STARTED: if Comment.startswith(STR_HEADER_COMMENT_START): HeaderCommentStage = HEADER_COMMENT_ABSTRACT @@ -152,39 +152,39 @@ def ParseHeaderCommentSection(CommentList, FileName = None): if not Comment: Abstract = '' HeaderCommentStage = HEADER_COMMENT_DESCRIPTION - elif _IsCopyrightLine(Comment): + elif _IsCopyrightLine(Comment): Copyright += Comment + EndOfLine HeaderCommentStage = HEADER_COMMENT_COPYRIGHT - else: + else: Abstract += Comment + EndOfLine HeaderCommentStage = HEADER_COMMENT_DESCRIPTION elif HeaderCommentStage == HEADER_COMMENT_DESCRIPTION: # # in case there is no description - # - if _IsCopyrightLine(Comment): + # + if _IsCopyrightLine(Comment): Copyright += Comment + EndOfLine HeaderCommentStage = HEADER_COMMENT_COPYRIGHT else: - Description += Comment + EndOfLine + Description += Comment + EndOfLine elif HeaderCommentStage == HEADER_COMMENT_COPYRIGHT: - if _IsCopyrightLine(Comment): + if _IsCopyrightLine(Comment): Copyright += Comment + EndOfLine else: # # Contents after copyright line are license, those non-copyright lines in between - # copyright line will be discarded + # copyright line will be discarded # if LineNo > Last: if License: License += EndOfLine License += Comment + EndOfLine - HeaderCommentStage = HEADER_COMMENT_LICENSE + HeaderCommentStage = HEADER_COMMENT_LICENSE else: if not Comment and not License: continue License += Comment + EndOfLine - + if not Copyright.strip(): SqlStatement = """ select ID from File where FullPath like '%s'""" % FileName ResultSet = EccGlobalData.gDb.TblFile.Exec(SqlStatement) @@ -198,19 +198,19 @@ def ParseHeaderCommentSection(CommentList, FileName = None): for Result in ResultSet: Msg = 'Header comment section must have license information' EccGlobalData.gDb.TblReport.Insert(ERROR_DOXYGEN_CHECK_FILE_HEADER, Msg, "File", Result[0]) - + if not Abstract.strip() or Abstract.find('Component description file') > -1: SqlStatement = """ select ID from File where FullPath like '%s'""" % FileName ResultSet = EccGlobalData.gDb.TblFile.Exec(SqlStatement) for Result in ResultSet: Msg = 'Header comment section must have Abstract information.' EccGlobalData.gDb.TblReport.Insert(ERROR_DOXYGEN_CHECK_FILE_HEADER, Msg, "File", Result[0]) - + return Abstract.strip(), Description.strip(), Copyright.strip(), License.strip() ## _IsCopyrightLine -# check whether current line is copyright line, the criteria is whether there is case insensitive keyword "Copyright" -# followed by zero or more white space characters followed by a "(" character +# check whether current line is copyright line, the criteria is whether there is case insensitive keyword "Copyright" +# followed by zero or more white space characters followed by a "(" character # # @param LineContent: the line need to be checked # @return: True if current line is copyright line, False else @@ -218,11 +218,11 @@ def ParseHeaderCommentSection(CommentList, FileName = None): def _IsCopyrightLine (LineContent): LineContent = LineContent.upper() Result = False - + ReIsCopyrightRe = re.compile(r"""(^|\s)COPYRIGHT *\(""", re.DOTALL) if ReIsCopyrightRe.search(LineContent): Result = True - + return Result @@ -232,7 +232,7 @@ def _IsCopyrightLine (LineContent): # Remove spaces # # @param Line: The string to be cleaned -# @param CommentCharacter: Comment char, used to ignore comment content, +# @param CommentCharacter: Comment char, used to ignore comment content, # default is DataType.TAB_COMMENT_SPLIT # def CleanString2(Line, CommentCharacter='#', AllowCppStyleComment=False): -- cgit v1.2.3