forked from qt-creator/qt-creator
d363c8101b
Add another option to allow deletion of unused objects on the fly. This option should be used with care. It is recommended to run without -d (or --delete) beforehand and check the results. Anyhow, when deletion is wanted it processes as usual, renames the original objects.map to objects.map~ and recreates the objects.map without the objects that could be deleted. Change-Id: I3898e8b9998e33461140bf4c75887a32d106f22c Reviewed-by: Robert Loehning <robert.loehning@qt.io>
211 lines
7.5 KiB
Python
Executable File
211 lines
7.5 KiB
Python
Executable File
#!/usr/bin/env python
|
|
|
|
############################################################################
|
|
#
|
|
# Copyright (C) 2019 The Qt Company Ltd.
|
|
# Contact: https://www.qt.io/licensing/
|
|
#
|
|
# This file is part of Qt Creator.
|
|
#
|
|
# Commercial License Usage
|
|
# Licensees holding valid commercial Qt licenses may use this file in
|
|
# accordance with the commercial license agreement provided with the
|
|
# Software or, alternatively, in accordance with the terms contained in
|
|
# a written agreement between you and The Qt Company. For licensing terms
|
|
# and conditions see https://www.qt.io/terms-conditions. For further
|
|
# information use the contact form at https://www.qt.io/contact-us.
|
|
#
|
|
# GNU General Public License Usage
|
|
# Alternatively, this file may be used under the terms of the GNU
|
|
# General Public License version 3 as published by the Free Software
|
|
# Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
|
|
# included in the packaging of this file. Please review the following
|
|
# information to ensure the GNU General Public License requirements will
|
|
# be met: https://www.gnu.org/licenses/gpl-3.0.html.
|
|
#
|
|
############################################################################
|
|
|
|
import os
|
|
import platform
|
|
import sys
|
|
import tokenize
|
|
from optparse import OptionParser
|
|
from toolfunctions import checkDirectory
|
|
from toolfunctions import getFileContent
|
|
|
|
objMap = None
|
|
lastToken = [None, None]
|
|
stopTokens = ('OP', 'NAME', 'NUMBER', 'ENDMARKER')
|
|
|
|
def parseCommandLine():
|
|
global directory, onlyRemovable, sharedFolders, deleteObjects
|
|
parser = OptionParser("\n%prog [OPTIONS] [DIRECTORY]")
|
|
parser.add_option("-o", "--only-removable", dest="onlyRemovable",
|
|
action="store_true", default=False,
|
|
help="list removable objects only")
|
|
parser.add_option("-d", "--delete", dest="delete",
|
|
action="store_true", default=False)
|
|
parser.add_option("-s", dest="sharedFolders",
|
|
action="store", type="string", default="",
|
|
help="comma-separated list of shared folders")
|
|
(options, args) = parser.parse_args()
|
|
if len(args) == 0:
|
|
directory = os.path.abspath(".")
|
|
elif len(args) == 1:
|
|
directory = os.path.abspath(args[0])
|
|
else:
|
|
print "\nERROR: Too many arguments\n"
|
|
parser.print_help()
|
|
sys.exit(1)
|
|
onlyRemovable = options.onlyRemovable
|
|
deleteObjects = options.delete
|
|
sharedFolders = map(os.path.abspath, options.sharedFolders.split(','))
|
|
|
|
def collectObjects():
|
|
global objMap
|
|
data = getFileContent(objMap)
|
|
return map(lambda x: x.strip().split("\t", 1)[0], data.strip().splitlines())
|
|
|
|
def handleStringsWithTrailingBackSlash(origStr):
|
|
try:
|
|
while True:
|
|
index = origStr.index("\\\n")
|
|
origStr = origStr[:index] + origStr[index+2:].lstrip()
|
|
except:
|
|
return origStr
|
|
|
|
def handle_token(tokenType, token, (startRow, startCol), (endRow, endCol), line):
|
|
global useCounts, lastToken, stopTokens
|
|
|
|
if tokenize.tok_name[tokenType] == 'STRING':
|
|
# concatenate strings followed directly by other strings
|
|
if lastToken[0] == 'STRING':
|
|
token = "'" + lastToken[1][1:-1] + str(token)[1:-1] + "'"
|
|
# store the new string as lastToken after removing potential trailing backslashes
|
|
# (including their following indentation)
|
|
lastToken = ['STRING' , handleStringsWithTrailingBackSlash(str(token))]
|
|
# if a stop token occurs check the potential string before it
|
|
elif tokenize.tok_name[tokenType] in stopTokens:
|
|
if lastToken[0] == 'STRING':
|
|
for obj in useCounts:
|
|
useCounts[obj] += lastToken[1].count("'%s'" % obj)
|
|
useCounts[obj] += lastToken[1].count('"%s"' % obj)
|
|
# store the stop token as lastToken
|
|
lastToken = [tokenize.tok_name[tokenType], str(token)]
|
|
|
|
def handleDataFiles(openFile, separator):
|
|
global useCounts
|
|
# ignore header line
|
|
openFile.readline()
|
|
for line in openFile:
|
|
currentTokens = line.split(separator)
|
|
for token in currentTokens:
|
|
stripped = token.strip().strip('"')
|
|
if stripped in useCounts:
|
|
useCounts[stripped] = useCounts[stripped] + 1
|
|
|
|
def findUsages():
|
|
global directory, objMap, sharedFolders
|
|
suffixes = (".py", ".csv", ".tsv")
|
|
directories = [directory]
|
|
# avoid folders that will be processed anyhow
|
|
for shared in sharedFolders:
|
|
skip = False
|
|
tmpS = shared + "/"
|
|
for folder in directories:
|
|
tmpD = folder + "/"
|
|
if platform.system() in ('Microsoft', 'Windows'):
|
|
tmpS = tmpS.lower()
|
|
tmpD = tmpD.lower()
|
|
if tmpS.startswith(tmpD):
|
|
skip = True
|
|
break
|
|
if not skip:
|
|
directories.append(shared)
|
|
|
|
for directory in directories:
|
|
for root, dirnames, filenames in os.walk(directory):
|
|
for filename in filter(lambda x: x.endswith(suffixes), filenames):
|
|
currentFile = open(os.path.join(root, filename))
|
|
if filename.endswith(".py"):
|
|
tokenize.tokenize(currentFile.readline, handle_token)
|
|
elif filename.endswith(".csv"):
|
|
handleDataFiles(currentFile, ",")
|
|
elif filename.endswith(".tsv"):
|
|
handleDataFiles(currentFile, "\t")
|
|
currentFile.close()
|
|
currentFile = open(objMap)
|
|
tokenize.tokenize(currentFile.readline, handle_token)
|
|
currentFile.close()
|
|
|
|
def printResult():
|
|
global useCounts, onlyRemovable
|
|
print
|
|
if onlyRemovable:
|
|
if min(useCounts.values()) > 0:
|
|
print "All objects are used once at least.\n"
|
|
return False
|
|
print "Unused objects:\n"
|
|
for obj in filter(lambda x: useCounts[x] == 0, useCounts):
|
|
print "%s" % obj
|
|
return True
|
|
else:
|
|
outFormat = "%3d %s"
|
|
for obj,useCount in useCounts.iteritems():
|
|
print outFormat % (useCount, obj)
|
|
print
|
|
return None
|
|
|
|
def deleteRemovable():
|
|
global useCounts, objMap
|
|
|
|
deletable = filter(lambda x: useCounts[x] == 0, useCounts)
|
|
if len(deletable) == 0:
|
|
print("Nothing to delete - leaving objects.map untouched")
|
|
return
|
|
|
|
data = ''
|
|
with open(objMap, "r") as objMapFile:
|
|
data = objMapFile.read()
|
|
|
|
objMapBackup = objMap + '~'
|
|
if os.path.exists(objMapBackup):
|
|
os.unlink(objMapBackup)
|
|
os.rename(objMap, objMapBackup)
|
|
|
|
count = 0
|
|
with open(objMap, "w") as objMapFile:
|
|
for line in data.splitlines():
|
|
try:
|
|
obj = line.split('\t')[0]
|
|
if obj in deletable:
|
|
count += 1
|
|
continue
|
|
objMapFile.write(line + '\n')
|
|
except:
|
|
print("Something's wrong in line '%s'" % line)
|
|
|
|
print("Deleted %d items, old objects.map has been moved to objects.map~" % count)
|
|
return count > 0
|
|
|
|
def main():
|
|
global useCounts, objMap, deleteObjects
|
|
objMap = checkDirectory(directory)
|
|
useCounts = dict.fromkeys(collectObjects(), 0)
|
|
findUsages()
|
|
atLeastOneRemovable = printResult()
|
|
deletedAtLeastOne = deleteObjects and deleteRemovable()
|
|
|
|
mssg = None
|
|
if atLeastOneRemovable:
|
|
mssg = "\nAfter removing the listed objects you should re-run this tool\n"
|
|
if deletedAtLeastOne:
|
|
mssg = "\nYou should re-run this tool\n"
|
|
if mssg:
|
|
print(mssg + "to find objects that might have been referenced only by removed objects.\n")
|
|
return 0
|
|
|
|
if __name__ == '__main__':
|
|
parseCommandLine()
|
|
sys.exit(main())
|