diff -r 509e4801c378 -r 22878952f6e2 srcanamdw/codescanner/scripts/todocomments.py --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/srcanamdw/codescanner/scripts/todocomments.py Thu Feb 18 12:29:02 2010 +0530 @@ -0,0 +1,66 @@ +# ################################################################# +# Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: +# +# * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. +# * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. +# * Neither the name of Nokia Corporation nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, +# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS +# BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.# +# +# todocomments.py +# +# Checks : "To do" comments. +# +# Reason : "To do" comments in code suggest that it is not finished. +# +# ################################################################# + +script = CScript("todocomments") +script.iReString = r""" + /(/|\*) # "//" or "/*" + .*(t|T)(o|O)(d|D)(o|O) # skip to Todo + """ +script.iFileExts = ["h", "cpp", "c"] +script.iCategory = KCategoryCodeReviewGuides +script.iIgnore = KIgnoreQuotes +script.iSeverity = KSeverityLow + +def todocommentcodecompare(lines, currentline, rematch, filename): + m = rematch.search(lines[currentline]) + if m: + line = lines[currentline] + i = 0 + inCommentBlock = 0 + + while i < len(line): + if not inCommentBlock: + if (line[i] == "/"): + if (line[i + 1] == "/"): + return 1 + elif (line[i + 1] == "*"): + inCommentBlock = 1 + i += 2 + continue + else: + endIndex = line[i:].find("*/") + if (endIndex <> -1): + inCommentBlock = 0 + # note, that first character is ignored in comments as can be direction to the in-source documentation tool + if (line[i+1:i + endIndex + 2].lower().find("todo") <> -1): + return 1 + i += endIndex + 2 + continue + else: + return 1 + i += 1 + return 0 + +script.iCompare = todocommentcodecompare +scanner.AddScript(script)