1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
#
# Copyright (C) 2000 Stephen Davies
# Copyright (C) 2000 Stefan Seefeld
# All rights reserved.
# Licensed to the public under the terms of the GNU LGPL (>= 2),
# see the file COPYING for details.
#
from Synopsis import config
from Synopsis.Processor import Parameter
from Synopsis import AST
from Synopsis.Formatters.TOC import TOC
from Synopsis.Formatters.HTML.View import View
from Synopsis.Formatters.HTML.Tags import *
from Synopsis.Formatters.HTML.Parts import *
import time, os
class Scope(View):
"""A module for creating a view for each Scope with summaries and
details. This module is highly modular, using the classes from
ASTFormatter to do the actual formatting. The classes to use may be
controlled via the config script, resulting in a very configurable output.
@see ASTFormatter The ASTFormatter module
@see Config.Formatters.HTML.ScopeViews Config for ScopeViews
"""
parts = Parameter([Heading(),
Summary(),
Inheritance(),
Detail()],
'')
def register(self, processor):
View.register(self, processor)
for part in self.parts: part.register(self)
self.__scopes = []
self.__toc = None
def get_toc(self, start):
"""Returns the TOC for the whole AST starting at start"""
if self.__toc: return self.__toc
self.__toc = TOC(self.processor.file_layout)
start.accept(self.__toc)
return self.__toc
def filename(self):
"""since Scope generates a whole file hierarchy, this method
returns the current filename, which may change over the lifetime
of this object"""
return self.__filename
def title(self):
"""since Scope generates a while file hierarchy, this method
returns the current title, which may change over the lifetime
of this object"""
return self.__title
def scope(self):
"""return the current scope processed by this object"""
return self.__scope
def process(self, start):
"""Creates a view for every Scope"""
self.__scopes = [start]
while self.__scopes:
scope = self.__scopes.pop(0)
self.process_scope(scope)
# Queue child scopes
for child in self.processor.sorter.children():
if isinstance(child, AST.Scope):
self.__scopes.append(child)
def register_filenames(self, start):
"""Registers a view for every Scope"""
self.__scopes = [start]
while self.__scopes:
scope = self.__scopes.pop(0)
filename = self.processor.file_layout.scope(scope.name())
self.processor.register_filename(filename, self, scope)
self.processor.sorter.set_scope(scope)
# Queue child scopes
for child in self.processor.sorter.children():
if isinstance(child, AST.Scope):
self.__scopes.append(child)
def process_scope(self, scope):
"""Creates a view for the given scope"""
details = {} # A hash of lists of detailed children by type
sections = [] # a list of detailed sections
# Open file and setup scopes
self.__scope = scope.name()
self.__filename = self.processor.file_layout.scope(self.__scope)
self.__title = escape(string.join(self.__scope))
self.start_file()
# Write heading
self.write(self.processor.navigation_bar(self.filename()))
# Loop throught all the view Parts
for part in self.parts:
part.process(scope)
self.end_file()
def end_file(self):
"""Overrides end_file to provide synopsis logo"""
self.write('\n')
now = time.strftime(r'%c', time.localtime(time.time()))
logo = href('http://synopsis.fresco.org', 'synopsis')
self.write(div('logo', 'Generated on ' + now + ' by \n<br/>\n' + logo))
View.end_file(self)
|
