#
# 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 import AST, Util
from Synopsis.Formatters.HTML.View import View
from Synopsis.Formatters.HTML.Tags import *

import os, urllib

link = None
try:
   link = Util._import("Synopsis.Parsers.Cxx.link")
except ImportError:
   print "Warning: unable to import link module. Continuing..."

class Source(View):
   """A module for creating a view for each file with hyperlinked source"""

   prefix = Parameter('', 'prefix to the syntax files')
   toc_in = Parameter([], 'obsolete, to be removed in a later release')
   external_url = Parameter(None, 'base url to use for external links (if None the toc will be used')
   
   def register(self, processor):

      View.register(self, processor)
      self.__toclist = map(lambda x: ''+x, self.toc_in)

   def filename(self):
      """since Source 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 Source generates a while file hierarchy, this method returns the current title,
      which may change over the lifetime of this object"""

      return self.__title

   def process(self, start):
      """Creates a view for every file"""

      # Get the TOC
      self.toc = self.processor.get_toc(start)
      # create a view for each main file
      for file in self.processor.ast.files().values():
         if file.is_main():
            self.process_node(file)

   def register_filenames(self, start):
      """Registers a view for every source file"""

      for file in self.processor.ast.files().values():
         if file.is_main():
            filename = file.filename()
            #filename = os.path.join(self.processor.output, filename)
            filename = self.processor.file_layout.file_source(filename)
            self.processor.register_filename(filename, self, file)
	     
   def process_node(self, file):
      """Creates a view for the given file"""

      # Start view
      filename = file.filename()
      self.__filename = self.processor.file_layout.file_source(filename)
      self.rel_url = rel(self.filename(), '')

      source = file.filename()
      self.__title = source

      self.start_file()
      self.write(self.processor.navigation_bar(self.filename()))
      self.write('File: '+entity('b', self.__title))

      if not link:
         # No link module..
         self.write('link module for highlighting source unavailable')
         try:
            self.write(open(file.full_filename(),'r').read())
         except IOError, e:
            self.write("An error occurred:"+ str(e))
      else:
         self.write('<br/><div class="file-all">\n')

         # Call link module
         f_out = os.path.join(self.processor.output, self.__filename) + '-temp'
         f_in = file.full_filename()
         f_link = os.path.join(self.prefix, source)
         try:
            lookup = self.external_url and self.external_ref or self.lookup_symbol
            link.link(lookup, f_in, f_out, f_link)

         except link.error, msg:
            print "An error occurred:",msg

         try:
            self.write(open(f_out,'r').read())
            os.unlink(f_out)

         except IOError, e:
            self.write("An error occurred:"+ str(e))
         self.write("</div>")

      self.end_file()

   def lookup_symbol(self, name):
      e = self.toc.lookup(tuple(name))
      return e and self.rel_url + e.link or ''

   def external_ref(self, name):
      return self.external_url + urllib.quote('::'.join(name))