premiere
/
premiere-libtorrent
2
2
Fork 1
Code Issues Pull Requests Releases Wiki Activity
premiere-libtorrent/docs/gen_todo.py

142 lines
3.8 KiB
Python
Raw Normal View History

add gen_todo.py script. include todo.html and mark up some todos in the code with priority
2013-01-21 00:21:53 +01:00
import glob
import os
paths = ['src/*.cpp', 'src/kademlia/*.cpp', 'include/libtorrent/*.hpp', 'include/libtorrent/kademlia/*.hpp', 'include/libtorrent/aux_/*.hpp', 'include/libtorrent/extensions/*.hpp']
fix docs generation for stats counters
2014-07-30 04:00:14 +02:00
os.system('(cd .. ; ctags %s 2>/dev/null)' % ' '.join(paths))
add gen_todo.py script. include todo.html and mark up some todos in the code with priority
2013-01-21 00:21:53 +01:00
files = []
for p in paths:
fix docs generation for stats counters
2014-07-30 04:00:14 +02:00
files.extend(glob.glob(os.path.join('..', p)))
add gen_todo.py script. include todo.html and mark up some todos in the code with priority
2013-01-21 00:21:53 +01:00
items = []
# keeps 20 non-comment lines, used to get more context around
# todo-items
context = []
added some documentation
2013-09-01 19:34:05 +02:00
priority_count = [0, 0, 0, 0, 0]
prioritize some more todo mark-ups
2013-01-21 02:40:59 +01:00
generate proper html escape sequencies
2013-01-21 00:28:06 +01:00
def html_sanitize(s):
ret = ''
for i in s:
if i == '<': ret += '&lt;'
elif i == '>': ret += '&gt;'
elif i == '&': ret += '&amp;'
else: ret += i
return ret
add gen_todo.py script. include todo.html and mark up some todos in the code with priority
2013-01-21 00:21:53 +01:00
for f in files:
h = open(f)
state = ''
line_no = 0
context_lines = 0
for l in h:
line_no += 1
line = l.strip()
if 'TODO:' in line and line.startswith('//'):
line = line.split('TODO:')[1].strip()
state = 'todo'
items.append({})
items[-1]['location'] = '%s:%d' % (f, line_no)
items[-1]['priority'] = 0
if line[0] in '0123456789':
items[-1]['priority'] = int(line[0])
merged changes from RC_1_0
2014-09-01 09:16:31 +02:00
if int(line[0]) > 5:
print 'priority too high: ' + line
sys.exit(1)
add gen_todo.py script. include todo.html and mark up some todos in the code with priority
2013-01-21 00:21:53 +01:00
line = line[1:].strip()
items[-1]['todo'] = line
prioritize some more todo mark-ups
2013-01-21 02:40:59 +01:00
prio = items[-1]['priority']
land libtorrent_aio branch in trunk
2014-07-06 21:18:00 +02:00
if prio >= 0 and prio <= 4: priority_count[prio] += 1
add gen_todo.py script. include todo.html and mark up some todos in the code with priority
2013-01-21 00:21:53 +01:00
continue
if state == '':
generate proper html escape sequencies
2013-01-21 00:28:06 +01:00
context.append(html_sanitize(l))
add gen_todo.py script. include todo.html and mark up some todos in the code with priority
2013-01-21 00:21:53 +01:00
if len(context) > 20: context.pop(0)
continue
if state == 'todo':
if line.strip().startswith('//'):
items[-1]['todo'] += '\n'
items[-1]['todo'] += line[2:].strip()
else:
state = 'context'
generate proper html escape sequencies
2013-01-21 00:28:06 +01:00
items[-1]['context'] = ''.join(context) + '<div style="background: #ffff00" width="100%">' + html_sanitize(l) + '</div>';
add gen_todo.py script. include todo.html and mark up some todos in the code with priority
2013-01-21 00:21:53 +01:00
context_lines = 1
fix the source context for todo-items
2013-01-21 17:25:43 +01:00
context.append(html_sanitize(l))
if len(context) > 20: context.pop(0)
add gen_todo.py script. include todo.html and mark up some todos in the code with priority
2013-01-21 00:21:53 +01:00
continue
if state == 'context':
generate proper html escape sequencies
2013-01-21 00:28:06 +01:00
items[-1]['context'] += html_sanitize(l)
add gen_todo.py script. include todo.html and mark up some todos in the code with priority
2013-01-21 00:21:53 +01:00
context_lines += 1
fix the source context for todo-items
2013-01-21 17:25:43 +01:00
context.append(html_sanitize(l))
if len(context) > 20: context.pop(0)
add gen_todo.py script. include todo.html and mark up some todos in the code with priority
2013-01-21 00:21:53 +01:00
if context_lines > 30: state = ''
h.close()
items.sort(key = lambda x: x['priority'], reverse = True)
#for i in items:
# print '\n\n', i['todo'], '\n'
# print i['location'], '\n'
# print 'prio: ', i['priority'], '\n'
# if 'context' in i:
# print i['context'], '\n'
clean up the root directory by moving parsing scripts into the tools directory
2013-06-14 18:49:06 +02:00
out = open('todo.html', 'w+')
add gen_todo.py script. include todo.html and mark up some todos in the code with priority
2013-01-21 00:21:53 +01:00
out.write('''<html><head>
<script type="text/javascript">
/* <![CDATA[ */
var expanded = -1
function expand(id) {
if (expanded != -1) {
var ctx = document.getElementById(expanded);
ctx.style.display = "none";
// if we're expanding the field that's already
// expanded, just collapse it
var no_expand = id == expanded;
expanded = -1;
if (no_expand) return;
}
var ctx = document.getElementById(id);
ctx.style.display = "table-row";
expanded = id;
}
/* ]]> */
</script>
</head><body>
<h1>libtorrent todo-list</h1>
land libtorrent_aio branch in trunk
2014-07-06 21:18:00 +02:00
<span style="color: #f00">%d urgent</span>
prioritize some more todo mark-ups
2013-01-21 02:40:59 +01:00
<span style="color: #f77">%d important</span>
<span style="color: #3c3">%d relevant</span>
<span style="color: #77f">%d feasible</span>
<span style="color: #999">%d notes</span>
<table width="100%%" border="1" style="border-collapse: collapse;">''' % \
land libtorrent_aio branch in trunk
2014-07-06 21:18:00 +02:00
(priority_count[4], priority_count[3], priority_count[2], priority_count[1], priority_count[0]))
prioritize some more todo mark-ups
2013-01-21 02:40:59 +01:00
land libtorrent_aio branch in trunk
2014-07-06 21:18:00 +02:00
prio_colors = [ '#ccc', '#ccf', '#cfc', '#fcc', '#f44']
add gen_todo.py script. include todo.html and mark up some todos in the code with priority
2013-01-21 00:21:53 +01:00
index = 0
for i in items:
if not 'context' in i: i['context'] = ''
prioritize some more todo mark-ups
2013-01-21 02:40:59 +01:00
out.write('<tr style="background: %s"><td>relevance&nbsp;%d</td><td><a href="javascript:expand(%d)">%s</a></td><td>%s</td></tr>' \
% (prio_colors[i['priority']], i['priority'], index, i['location'], i['todo'].replace('\n', ' ')))
add gen_todo.py script. include todo.html and mark up some todos in the code with priority
2013-01-21 00:21:53 +01:00
out.write('<tr id="%d" style="display: none;" colspan="3"><td colspan="3"><h2>%s</h2><h4>%s</h4><pre style="background: #f6f6f6; border: solid 1px #ddd;">%s</pre></td></tr>' \
% (index, i['todo'], i['location'], i['context']))
index += 1
out.write('</table></body></html>')
out.close()