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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
#
# 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.
#
"""
FileLayout module. This is the base class for the FileLayout interface. The
default implementation stores everything in the same directory.
"""
from Synopsis import Util, AST
from Synopsis.Formatters import TOC
from Tags import *
import os, os.path, sys, stat, string, re
class FileLayout (TOC.Linker):
"""Base class for naming files.
You may derive from this class an
reimplement any methods you like. The default implementation stores
everything in the same directory (specified by -o)."""
def init(self, processor):
self.processor = processor
self.base = self.processor.output
if not os.path.exists(self.base):
if processor.verbose: print "Warning: Output directory does not exist. Creating."
try:
os.makedirs(self.base, 0755)
except EnvironmentError, reason:
print "ERROR: Creating directory:",reason
sys.exit(2)
elif not os.path.isdir(self.base):
print "ERROR: Output must be a directory."
sys.exit(1)
if os.path.isfile(processor.stylesheet):
self.copy_file(processor.stylesheet, 'style.css')
else:
print "ERROR: stylesheet %s doesn't exist"%processor.stylesheet
sys.exit(1)
def copy_file(self, src, dest):
"""Copies file if newer. The file named by orig_name is compared to
<output>/<new_name>, and if newer or new_name doesn't exist, it is copied."""
dest = os.path.join(self.base, dest)
try:
filetime = os.stat(src)[stat.ST_MTIME]
if (not os.path.exists(dest)
or filetime > os.stat(dest)[stat.ST_MTIME]):
Util.open(dest).write(open(src, 'r').read())
except EnvironmentError, reason:
import traceback
traceback.print_exc()
print "ERROR: ", reason
sys.exit(2)
def _check_main(self, filename):
"""Checks whether the given filename is the main index view or not. If
it is, then it returns the filename from index(), else it returns
it unchanged"""
if filename == self.processor.main_view: return self.index()
return filename
def scope(self, scope):
"""Return the filename of a scoped name (class or module).
The default implementation is to join the names with '-' and append
".html" Additionally, special characters are Util.quoted in URL-style"""
if not len(scope): return self._check_main(self.special('global'))
return Util.quote(string.join(scope,'-')) + '.html'
def _strip_filename(self, file):
if len(file) and file[-1] == '/': file = file[:-1]
return file
def file_index(self, file):
"""Return the filename for the index of an input file.
Default implementation is to join the path with '-', prepend "_file-"
and append ".html" """
file = self._strip_filename(file)
return '_file-%s.html'%file.replace(os.sep, '-')
def file_source(self, file):
"""Return the filename for the source of an input file.
Default implementation is to join the path with '-', prepend "_source-"
and append ".html" """
file = self._strip_filename(file)
return "_source-"+file.replace(os.sep, '-')+".html"
def file_details(self, file):
"""Return the filename for the details of an input file.
Default implementation is to join the path with '-', prepend
"_filedetail-" and append ".html" """
file = self._strip_filename(file)
return "_filedetail-"+file.replace(os.sep, '-')+".html"
def index(self):
"""Return the name of the main index file. Default is index.html"""
return "index.html"
def special(self, name):
"""Return the name of a special file (tree, etc). Default is
_name.html"""
return self._check_main('_%s.html'%name)
def scoped_special(self, name, scope, ext=".html"):
"""Return the name of a special type of scope file. Default is to join
the scope with '-' and prepend '-'+name"""
return "_%s-%s%s"%(name, Util.quote(string.join(scope, '-')), ext)
def xref(self, page):
"""Return the name of the xref file for the given page"""
return '_xref%d.html'%page
def module_tree(self):
"""Return the name of the module tree index. Default is
_modules.html"""
return "_modules.html"
def module_index(self, scope):
"""Return the name of the index of the given module. Default is to
join the name with '-', prepend "_module_" and append ".html" """
# Prefer module index for frames
if self.processor.using_module_index:
return Util.quote('_module_' + string.join(scope, '-')) + '.html'
# Fall back to the scope view
return self.scope(scope)
def link(self, decl):
"""Create a link to the named declaration. This method may have to
deal with the directory layout."""
if isinstance(decl, AST.Scope):
# This is a class or module, so it has its own file
return self.scope(decl.name())
# Assume parent scope is class or module, and this is a <A> name in it
filename = self.scope(decl.name()[:-1])
anchor = escape(decl.name()[-1].replace(' ','-'))
return filename + '#' + anchor
class NestedFileLayout (FileLayout):
"""generates a structured file system instead of a flat one"""
def scope(self, scope):
"""Return the filename of a scoped name (class or module).
One subdirectory per scope"""
prefix = 'Scopes'
if not len(scope):
return self._check_main(prefix + '/global.html')
else: return Util.quote(prefix + '/' + string.join(scope, '/')) + '.html'
def file_index(self, file):
"""Return the filename for the index of an input file.
Default implementation is to join the path with '-', prepend "_file-"
and append ".html" """
file = self._strip_filename(file)
return 'File/%s.html'%file
def file_source(self, file):
"""Return the filename for the source of an input file.
Default implementation is to join the path with '-', prepend "_source-"
and append ".html" """
file = self._strip_filename(file)
return 'Source/%s.html'%file
def file_details(self, file):
"""Return the filename for the details of an input file.
Returns the filename nested in the FileDetails directory and with
.html appended."""
file = self._strip_filename(file)
return 'FileDetails/%s.html'%file
def special(self, name):
"""Return the name of a special file (tree, etc)."""
return self._check_main(name + '.html')
def scoped_special(self, name, scope, ext='.html'):
"""Return the name of a special type of scope file"""
return Util.quote(name + '/' + string.join(scope, '/')) + ext
def xref(self, page):
"""Return the name of the xref file for the given page"""
return 'XRef/xref%d.html'%page
def module_tree(self):
"""Return the name of the module tree index"""
return 'Modules.html'
def module_index(self, scope):
"""Return the name of the index of the given module"""
return Util.quote('Modules/%s'%string.join(scope, '/')) + '.html'
|
