| 1 |
#!/usr/bin/env python |
| 2 |
# -*- coding: utf-8 -*- |
| 3 |
|
| 4 |
# #################################################################### |
| 5 |
# Copyright (C) 2005-2019 by the FIFE team |
| 6 |
# http://www.fifengine.net |
| 7 |
# This file is part of FIFE. |
| 8 |
# |
| 9 |
# FIFE is free software; you can redistribute it and/or |
| 10 |
# modify it under the terms of the GNU Lesser General Public |
| 11 |
# License as published by the Free Software Foundation; either |
| 12 |
# version 2.1 of the License, or (at your option) any later version. |
| 13 |
# |
| 14 |
# This library is distributed in the hope that it will be useful, |
| 15 |
# but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 16 |
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 17 |
# Lesser General Public License for more details. |
| 18 |
# |
| 19 |
# You should have received a copy of the GNU Lesser General Public |
| 20 |
# License along with this library; if not, write to the |
| 21 |
# Free Software Foundation, Inc., |
| 22 |
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
| 23 |
# #################################################################### |
| 24 |
|
| 25 |
import sys, re, os |
| 26 |
|
| 27 |
try: |
| 28 |
from os.shutil import copyfile |
| 29 |
|
| 30 |
except ImportError: |
| 31 |
def copyfile(src,dest): |
| 32 |
srcf = open(src) |
| 33 |
destf = open(dest,"w") |
| 34 |
destf.write( srcf.read() ) |
| 35 |
destf.close() |
| 36 |
srcf.close() |
| 37 |
|
| 38 |
|
| 39 |
if '.' not in sys.path: |
| 40 |
sys.path.append('.') |
| 41 |
from utils.util_scripts.path import path |
| 42 |
from _allowed_dependencies import ALLOWED_MODULE_DEPS |
| 43 |
|
| 44 |
_S = os.path.sep |
| 45 |
ROOTDIRNAME = 'engine%score' % _S |
| 46 |
FILE_DEPS_OUT = 'doc%sdependencies%sfiledeps' % (_S, _S) |
| 47 |
DIR_DEPS_OUT = 'doc%sdependencies%sdirdeps' % (_S, _S) |
| 48 |
MODULE_DEPS_OUT = 'doc%sdependencies%smoduledeps' % (_S, _S) |
| 49 |
SKIPPED_PROVIDERS = [] |
| 50 |
SKIPPED_USERS = [] |
| 51 |
|
| 52 |
reInc = re.compile('#include "(.*?)"') |
| 53 |
|
| 54 |
def add_to_dictset(d, key, val): |
| 55 |
try: |
| 56 |
d[key].add(val) |
| 57 |
except KeyError: |
| 58 |
d[key] = set([val]) |
| 59 |
|
| 60 |
# return error string in case of possible error |
| 61 |
unknown_modules = [] |
| 62 |
def check_dep_error(allowed_deps, user, provider): |
| 63 |
global unknown_modules |
| 64 |
|
| 65 |
msg = '' |
| 66 |
try: |
| 67 |
if not provider in allowed_deps[user]: |
| 68 |
msg = 'Illegal dependency between %s -> %s, % s can use only:\n' % (user, provider, user) |
| 69 |
for d in allowed_deps[user]: |
| 70 |
msg += ' %s\n' % d |
| 71 |
except KeyError: |
| 72 |
print unknown_modules |
| 73 |
if user not in unknown_modules: |
| 74 |
msg = 'Unknown module %s found in static check\n' % user |
| 75 |
msg += ' please adjust dep_analyzer script to match new structure' |
| 76 |
unknown_modules.append(user) |
| 77 |
return msg |
| 78 |
|
| 79 |
def get_file2inc(sources): |
| 80 |
file2inc = {} |
| 81 |
for f in sources: |
| 82 |
inComment = False |
| 83 |
for line in open(f): |
| 84 |
if not inComment and line.find('/*') != -1: |
| 85 |
inComment = True |
| 86 |
continue |
| 87 |
elif inComment: |
| 88 |
if line.find('*/') != -1: |
| 89 |
inComment = False |
| 90 |
continue |
| 91 |
elif line.strip().startswith('//'): |
| 92 |
continue |
| 93 |
m = reInc.search(line) |
| 94 |
if m: |
| 95 |
add_to_dictset(file2inc, f, m.group(1).replace( '/', _S )) |
| 96 |
|
| 97 |
return file2inc |
| 98 |
|
| 99 |
def fill_dep_infos(file2inc, fileUser2provider, dirUser2provider, moduleUser2provider, unknownIncludes, dirclusters): |
| 100 |
for f, incs in file2inc.items(): |
| 101 |
#if f.find('engine.cpp') != -1: |
| 102 |
# import pdb; pdb.set_trace() |
| 103 |
skip = False |
| 104 |
for user in SKIPPED_USERS: |
| 105 |
if f.find(user) != -1: |
| 106 |
skip = True |
| 107 |
break |
| 108 |
if skip: |
| 109 |
continue |
| 110 |
|
| 111 |
for i in incs: |
| 112 |
user = str(f.dirname()).replace(ROOTDIRNAME + _S, '') |
| 113 |
header = path((f.dirname() / path(i)).abspath().split(ROOTDIRNAME + _S)[1]) |
| 114 |
if not header.isfile(): |
| 115 |
header = path(ROOTDIRNAME) + _S + path(i) |
| 116 |
if not header.isfile(): |
| 117 |
add_to_dictset(unknownIncludes, str(f), str(i)) |
| 118 |
continue |
| 119 |
provider = str(header.dirname()).replace(ROOTDIRNAME + _S, '') |
| 120 |
skip = False |
| 121 |
for skipped in SKIPPED_PROVIDERS: |
| 122 |
if header.find(skipped) != -1: |
| 123 |
skip = True |
| 124 |
break |
| 125 |
if skip: |
| 126 |
continue |
| 127 |
add_to_dictset(dirUser2provider, user, provider) |
| 128 |
usermodule = user.split(_S)[0] |
| 129 |
providermodule = provider.split(_S)[0] |
| 130 |
userfile = user.split(_S)[-1].split('.')[0] |
| 131 |
providerfile = provider.split(_S)[-1].split('.')[0] |
| 132 |
|
| 133 |
add_to_dictset(dirclusters, usermodule, user) |
| 134 |
add_to_dictset(dirclusters, providermodule, provider) |
| 135 |
add_to_dictset(moduleUser2provider, usermodule, providermodule) |
| 136 |
add_to_dictset(fileUser2provider, userfile, providerfile) |
| 137 |
|
| 138 |
def write_dot_file(fname, contents): |
| 139 |
lines = [] |
| 140 |
a = lines.append |
| 141 |
a('digraph "source tree" {') |
| 142 |
a(' overlap=scale;') |
| 143 |
a(' size="8,10";') |
| 144 |
a(' ratio="fill";') |
| 145 |
a(' fontsize="16";') |
| 146 |
a(' fontname="Helvetica";') |
| 147 |
a(' clusterrank="local";') |
| 148 |
if type(contents) in (list, tuple): |
| 149 |
lines += contents |
| 150 |
else: |
| 151 |
lines.append(contents) |
| 152 |
a('}') |
| 153 |
open(fname, 'w').write('\n'.join(lines)) |
| 154 |
|
| 155 |
def get_cluster_str(ind, elements, label): |
| 156 |
lines = [] |
| 157 |
a = lines.append |
| 158 |
a('subgraph cluster_%d {' % ind) |
| 159 |
a(' style=filled;') |
| 160 |
a(' color=lightgrey;') |
| 161 |
a(' node [style=filled,color=white];') |
| 162 |
a(' %s' % '; '.join('"%s"' % d for d in elements)) |
| 163 |
a(' label = "%s";' % label) |
| 164 |
a('}') |
| 165 |
return '\n'.join(lines) |
| 166 |
|
| 167 |
def run_dot(basename,type): |
| 168 |
dotname = basename + ".dot" |
| 169 |
outname = basename + "." + type |
| 170 |
|
| 171 |
dotchanged = True |
| 172 |
|
| 173 |
try: |
| 174 |
olddot = open(dotname + "~").read() |
| 175 |
dotchanged = olddot != open(dotname).read() |
| 176 |
dotchanged = dotchanged or not os.path.exists(outname) |
| 177 |
except IOError: pass |
| 178 |
if not dotchanged and type != "png": |
| 179 |
return |
| 180 |
print "Generating: ",outname |
| 181 |
cmd = 'dot -T%(type)s %(dotname)s > %(outname)s' % locals() |
| 182 |
os.system(cmd) |
| 183 |
copyfile(dotname,dotname + "~") |
| 184 |
|
| 185 |
def analyze(write_postscript=False): |
| 186 |
root = path(ROOTDIRNAME) |
| 187 |
headers = list(root.walkfiles('*.h')) |
| 188 |
sources = headers + list(root.walkfiles('*.cpp')) |
| 189 |
file2inc = get_file2inc(sources) |
| 190 |
|
| 191 |
moduleUser2provider = {} |
| 192 |
dirUser2provider = {} |
| 193 |
fileUser2provider = {} |
| 194 |
unknownIncludes = {} |
| 195 |
dirclusters = {} |
| 196 |
fill_dep_infos(file2inc, fileUser2provider, dirUser2provider, moduleUser2provider, unknownIncludes, dirclusters) |
| 197 |
|
| 198 |
# write module dep graph |
| 199 |
out = [] |
| 200 |
illegalModuleDeps = [] |
| 201 |
for user, providers in sorted(moduleUser2provider.items()): |
| 202 |
for provider in sorted(providers): |
| 203 |
if user != provider: |
| 204 |
out.append(' "' + user + '" -> "' + provider + '"') |
| 205 |
msg = check_dep_error(ALLOWED_MODULE_DEPS, user, provider) |
| 206 |
if msg: |
| 207 |
illegalModuleDeps.append(msg) |
| 208 |
write_dot_file('%s.dot' % MODULE_DEPS_OUT, out) |
| 209 |
if write_postscript: |
| 210 |
run_dot(MODULE_DEPS_OUT, "ps") |
| 211 |
run_dot(MODULE_DEPS_OUT,"png") |
| 212 |
|
| 213 |
# write dir dep graph |
| 214 |
out = [] |
| 215 |
for cluster, subdirs in sorted(dirclusters.items()): |
| 216 |
out.append(get_cluster_str(len(out), sorted(subdirs), cluster)) |
| 217 |
for user, providers in sorted(dirUser2provider.items()): |
| 218 |
for provider in sorted(providers): |
| 219 |
if user != provider: |
| 220 |
out.append(' "' + user + '" -> "' + provider + '"') |
| 221 |
write_dot_file('%s.dot' % DIR_DEPS_OUT, out) |
| 222 |
if write_postscript: |
| 223 |
run_dot(DIR_DEPS_OUT, "ps") |
| 224 |
|
| 225 |
# write file dep graph |
| 226 |
out = [] |
| 227 |
for user, providers in sorted(file2inc.items()): |
| 228 |
for provider in sorted(providers): |
| 229 |
if user != provider: |
| 230 |
out.append(' "' + user + '" -> "' + provider + '"') |
| 231 |
write_dot_file('%s.dot' % FILE_DEPS_OUT, out) |
| 232 |
# os.system('dot -Tps %s.dot > %s.ps' % (MODULE_DEPS_OUT, MODULE_DEPS_OUT)) |
| 233 |
|
| 234 |
# write raw dep info |
| 235 |
#out = [] |
| 236 |
#for f, file2inc |
| 237 |
result = '\n'.join(illegalModuleDeps) |
| 238 |
if result: |
| 239 |
print result |
| 240 |
else: |
| 241 |
print "no dependency analyzer errors found" |
| 242 |
return result |
| 243 |
|
| 244 |
|
| 245 |
_ANALYZE_FN_ = analyze |
| 246 |
|
| 247 |
if __name__ == '__main__': |
| 248 |
analyze(True) |