File: FramesIndex.py

package info (click to toggle)
synopsis 0.8.0-5
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 10,112 kB
  • ctags: 12,996
  • sloc: cpp: 34,254; ansic: 33,620; python: 10,975; sh: 7,261; xml: 6,369; makefile: 773; asm: 445
file content (81 lines) | stat: -rw-r--r-- 3,160 bytes parent folder | download | duplicates (2)
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
#
# 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.Processor import Parameter
from Synopsis.Formatters.HTML.View import View, Format
from Synopsis.Formatters.HTML.Tags import *

import os

class FramesFormat(Format):

   def view_header(self, os, title, body, headextra, view):

      os.write('<?xml version="1.0"?>\n')
      os.write('<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"\n')
      os.write('    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">\n')
      os.write('<html xmlns="http://www.w3.org/1999/xhtml" lang="en">')
      os.write('<!-- ' + view.filename() + ' -->\n')
      os.write('<!-- this view was generated by ' + view.__class__.__name__ + ' -->\n')
      os.write("<head>\n")
      os.write('<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type"/>')
      os.write(entity('title','Synopsis - '+ title) + '\n')
      css = self.prefix + 'style.css'
      os.write(solotag('link', type='text/css', rel='stylesheet', href=css) + '\n')
      os.write(headextra)
      os.write("</head>\n%s\n"%body)

class FramesIndex(View):
   """A class that creates an index with frames"""

   template = Parameter(FramesFormat(), 'the object that provides the html template for the view')

   def register(self, processor):

      View.register(self, processor)
      processor.set_main_view(self.filename())

   def filename(self): return self.processor.file_layout.index()

   def title(self): return self.processor.title

   def process(self, start):
      """Creates a frames index file"""

      me = self.filename()
      # TODO use project name..
      self.start_file(body='')
      fcontents = rel(me, self.processor.contents_view)
      findex = rel(me, self.processor.index_view)
      # Find something to link to
      fglobal = findex
      decls = [start]
      while decls:
         decl = decls.pop(0)
         entry = self.processor.toc[decl.name()]
         if entry:
            fglobal = rel(me, entry.link)
            break
         if hasattr(decl, 'declarations'):
            # Depth-first search
            decls = decl.declarations() + decls
      frame1 = solotag('frame', name='contents', src=fcontents)
      frame2 = solotag('frame', name='index', src=findex)
      frame3 = solotag('frame', name='main', src=fglobal)
      frameset1 = entity('frameset', frame1+frame2, rows="30%,*")
      noframes = 'This document was configured to use frames.'
      noframes = noframes + '<ul>'
      noframes = noframes + entity('li', href(fcontents, 'The default Contents frame'))
      noframes = noframes + entity('li', href(findex, 'The default Index frame'))
      noframes = noframes + entity('li', href(fglobal, 'The default Main frame'))
      noframes = noframes + '</ul>'
      noframes = entity('body', noframes + 'Generated by Synopsis.')
      noframes = entity('noframes', noframes)
      frameset2 = entity('frameset', frameset1+frame3+noframes, cols="200,*")
      self.write(frameset2)
      self.end_file(body='')