Thuban/UI/application.py

# Copyright (C) 2001, 2002, 2003 by Intevation GmbH
# Authors:
# Jan-Oliver Wagner <[email protected]>
# Bernhard Herzog <[email protected]>
#
# This program is free software under the GPL (>=v2)
# Read the file COPYING coming with Thuban for details.

"""
Thuban's application object.
"""

__version__ = "$Revision$"

import sys, os
import os.path
from tempfile import mktemp

import traceback

from wxPython.wx import *

from Thuban.Lib.connector import Publisher

from Thuban import _
from Thuban.Model.session import create_empty_session
from Thuban.Model.save import save_session
from Thuban.Model.load import load_session
from Thuban.Model.messages import MAPS_CHANGED

import view
import tree
import mainwindow

from messages import SESSION_REPLACED


class ThubanApplication(wxApp, Publisher):

    """
    Thuban's application class.

    All wxWindows programs have to have an instance of an application
    class derived from wxApp. In Thuban the application class holds
    references to the main window and the session.
    """

    def OnInit(self):
        self.splash = self.splash_screen()
        if self.splash is not None:
            self.splash.Show()
        self.read_startup_files()
        self.top = self.CreateMainWindow()
        self.SetTopWindow(self.top)
        if self.splash is None:
            self.ShowMainWindow()
        self.session = None
        self.create_session()
        return True

    def OnExit(self):
        """Clean up code.

        Extend this in derived classes if needed.
        """
        self.session.Destroy()
        self.session = None
        Publisher.Destroy(self)

    def read_startup_files(self):
        """Read the startup files."""
        # for now the startup file is ~/.thuban/thubanstart.py
        if os.name == 'nt':
            # This should result in something like the user directory ...
            guess = os.path.dirname(os.path.dirname(os.path.dirname(mktemp())))
            dir = os.path.join(guess, ".thuban")
            if not os.path.isdir(dir):
                os.mkdir(dir)
        else:
            dir =os.path.expanduser("~/.thuban")
        if os.path.isdir(dir):
            sys.path.append(dir)
            try:
                import thubanstart
            except ImportError:
                tb = sys.exc_info()[2]
                try:
                    if tb.tb_next is not None:
                        # The ImportError exception was raised from
                        # inside the thubanstart module.
                        sys.stderr.write(_("Cannot import the thubanstart"
                                         " module\n"))
                        traceback.print_exc(None, sys.stderr)
                    else:
                        # There's no thubanstart module.
                        sys.stderr.write(_("No thubanstart module available\n"))
                finally:
                    # make sure we delete the traceback object,
                    # otherwise there's be circular references involving
                    # the current stack frame
                    del tb
            except:
                sys.stderr.write(_("Cannot import the thubanstart module\n"))
                traceback.print_exc(None, sys.stderr)
        else:
            # There's no .thuban directory
            sys.stderr.write(_("No ~/.thuban directory\n"))

    def splash_screen(self):
        """Create and return a splash screen.

        This method is called by OnInit to determine whether the
        application should have a splashscreen. If the application
        should display a splash screen override this method in a derived
        class and have it create and return the wxSplashScreen instance.
        The implementation of this method in the derived class should
        also arranged for ShowMainWindow to be called.

        The default implementation simply returns None so that no splash
        screen is shown and ShowMainWindow will be called automatically.
        """
        return None

    def ShowMainWindow(self):
        """Show the main window

        Normally this method is automatically called by OnInit to show
        the main window. However, if the splash_screen method has
        returned a splashscreen it is expected that the derived class
        also arranges for ShowMainWindow to be called at the appropriate
        time.
        """
        self.top.Show(True)

    def CreateMainWindow(self):
        """Create and return the main window for the application.

        Override this in subclasses to instantiate the Thuban mainwindow
        with different parameters or to use a different class for the
        main window.
        """
        msg = (_("This is the wxPython-based Graphical User Interface"
               " for exploring geographic data"))
        return mainwindow.MainWindow(NULL, -1, "Thuban", self, None,
                                     initial_message = msg,
                                     size = (600, 400))

    def Session(self):
        """Return the application's session object"""
        return self.session

    def SetSession(self, session):
        """Make session the new session.

        Issue SESSION_REPLACED after self.session has become the new
        session. After the session has been assigned call
        self.subscribe_session() with the new session and
        self.unsubscribe_session with the old one.
        """
        oldsession = self.session
        self.session = session
        self.subscribe_session(self.session)
        self.issue(SESSION_REPLACED)
        self.maps_changed()
        if oldsession is not None:
            self.unsubscribe_session(oldsession)
            oldsession.Destroy()

    def subscribe_session(self, session):
        """Subscribe to some of the sessions channels.

        Extend this method in derived classes if you need additional
        channels.
        """
        session.Subscribe(MAPS_CHANGED, self.maps_changed)

    def unsubscribe_session(self, session):
        """Unsubscribe from the sessions channels.

        Extend this method in derived classes if you subscribed to
        additional channels in subscribe_session().
        """
        session.Unsubscribe(MAPS_CHANGED, self.maps_changed)

    def create_session(self):
        """Create a default session.

        Override this method in derived classes to instantiate the
        session differently or to use a different session class. Don't
        subscribe to channels here yet. Do that in the
        subscribe_session() method.
        """
        self.SetSession(create_empty_session())

    def OpenSession(self, filename):
        """Open the session in the file named filename"""
        # Make sure we deal with an absolute pathname. Otherwise we can
        # get problems when saving because the saving code expects an
        # absolute directory name
        filename = os.path.abspath(filename)
        session = load_session(filename)
        session.SetFilename(filename)
        session.UnsetModified()
        self.SetSession(session)

    def SaveSession(self):
        save_session(self.session, self.session.filename)

    def maps_changed(self, *args):
        if self.session.HasMaps():
            self.top.SetMap(self.session.Maps()[0])
        else:
            self.top.SetMap(None)
1	bh	401	# Copyright (C) 2001, 2002, 2003 by Intevation GmbH
2	bh	6	# Authors:
3			# Jan-Oliver Wagner <[email protected]>
4	bh	189	# Bernhard Herzog <[email protected]>
5	bh	6	#
6			# This program is free software under the GPL (>=v2)
7			# Read the file COPYING coming with Thuban for details.
8
9			"""
10			Thuban's application object.
11			"""
12
13			__version__ = "$Revision$"
14
15	bh	189	import sys, os
16	frank	1133	import os.path
17			from tempfile import mktemp
18
19	bh	189	import traceback
20
21	bh	6	from wxPython.wx import *
22
23			from Thuban.Lib.connector import Publisher
24
25	jan	374	from Thuban import _
26	bh	6	from Thuban.Model.session import create_empty_session
27			from Thuban.Model.save import save_session
28			from Thuban.Model.load import load_session
29	bh	242	from Thuban.Model.messages import MAPS_CHANGED
30	bh	6
31			import view
32			import tree
33	bh	215	import mainwindow
34	bh	6
35	jonathan	503	from messages import SESSION_REPLACED
36	bh	6
37
38
39			class ThubanApplication(wxApp, Publisher):
40
41			"""
42			Thuban's application class.
43
44			All wxWindows programs have to have an instance of an application
45			class derived from wxApp. In Thuban the application class holds
46	bh	535	references to the main window and the session.
47	bh	6	"""
48
49			def OnInit(self):
50	bh	401	self.splash = self.splash_screen()
51			if self.splash is not None:
52			self.splash.Show()
53	bh	189	self.read_startup_files()
54	bh	401	self.top = self.CreateMainWindow()
55			self.SetTopWindow(self.top)
56			if self.splash is None:
57			self.ShowMainWindow()
58	bh	6	self.session = None
59			self.create_session()
60	jonathan	518	return True
61	bh	6
62	bh	251	def OnExit(self):
63			"""Clean up code.
64
65			Extend this in derived classes if needed.
66			"""
67			self.session.Destroy()
68	bh	765	self.session = None
69	bh	251	Publisher.Destroy(self)
70
71	bh	189	def read_startup_files(self):
72			"""Read the startup files."""
73			# for now the startup file is ~/.thuban/thubanstart.py
74	frank	1133	if os.name == 'nt':
75			# This should result in something like the user directory ...
76			guess = os.path.dirname(os.path.dirname(os.path.dirname(mktemp())))
77			dir = os.path.join(guess, ".thuban")
78			if not os.path.isdir(dir):
79			os.mkdir(dir)
80			else:
81			dir =os.path.expanduser("~/.thuban")
82	bh	189	if os.path.isdir(dir):
83			sys.path.append(dir)
84			try:
85			import thubanstart
86			except ImportError:
87			tb = sys.exc_info()[2]
88			try:
89			if tb.tb_next is not None:
90			# The ImportError exception was raised from
91			# inside the thubanstart module.
92	jan	374	sys.stderr.write(_("Cannot import the thubanstart"
93	bh	671	" module\n"))
94	bh	189	traceback.print_exc(None, sys.stderr)
95			else:
96			# There's no thubanstart module.
97	jan	374	sys.stderr.write(_("No thubanstart module available\n"))
98	bh	189	finally:
99			# make sure we delete the traceback object,
100			# otherwise there's be circular references involving
101			# the current stack frame
102			del tb
103			except:
104	jan	374	sys.stderr.write(_("Cannot import the thubanstart module\n"))
105	bh	189	traceback.print_exc(None, sys.stderr)
106			else:
107			# There's no .thuban directory
108	jan	374	sys.stderr.write(_("No ~/.thuban directory\n"))
109	bh	189
110	bh	401	def splash_screen(self):
111			"""Create and return a splash screen.
112
113			This method is called by OnInit to determine whether the
114			application should have a splashscreen. If the application
115			should display a splash screen override this method in a derived
116			class and have it create and return the wxSplashScreen instance.
117			The implementation of this method in the derived class should
118			also arranged for ShowMainWindow to be called.
119
120			The default implementation simply returns None so that no splash
121			screen is shown and ShowMainWindow will be called automatically.
122			"""
123			return None
124
125			def ShowMainWindow(self):
126			"""Show the main window
127
128			Normally this method is automatically called by OnInit to show
129			the main window. However, if the splash_screen method has
130			returned a splashscreen it is expected that the derived class
131			also arranges for ShowMainWindow to be called at the appropriate
132			time.
133			"""
134	jonathan	518	self.top.Show(True)
135	bh	535
136	bh	235	def CreateMainWindow(self):
137			"""Create and return the main window for the application.
138
139			Override this in subclasses to instantiate the Thuban mainwindow
140			with different parameters or to use a different class for the
141			main window.
142			"""
143	jan	374	msg = (_("This is the wxPython-based Graphical User Interface"
144			" for exploring geographic data"))
145	bh	535	return mainwindow.MainWindow(NULL, -1, "Thuban", self, None,
146	jonathan	934	initial_message = msg,
147			size = (600, 400))
148	bh	235
149	bh	219	def Session(self):
150			"""Return the application's session object"""
151			return self.session
152
153	bh	6	def SetSession(self, session):
154	bh	219	"""Make session the new session.
155
156	jonathan	503	Issue SESSION_REPLACED after self.session has become the new
157	bh	242	session. After the session has been assigned call
158			self.subscribe_session() with the new session and
159			self.unsubscribe_session with the old one.
160	bh	219	"""
161	bh	6	oldsession = self.session
162			self.session = session
163	bh	242	self.subscribe_session(self.session)
164	jonathan	503	self.issue(SESSION_REPLACED)
165	bh	242	self.maps_changed()
166	bh	6	if oldsession is not None:
167	bh	242	self.unsubscribe_session(oldsession)
168	bh	6	oldsession.Destroy()
169
170	bh	242	def subscribe_session(self, session):
171			"""Subscribe to some of the sessions channels.
172
173			Extend this method in derived classes if you need additional
174			channels.
175			"""
176			session.Subscribe(MAPS_CHANGED, self.maps_changed)
177
178			def unsubscribe_session(self, session):
179			"""Unsubscribe from the sessions channels.
180
181			Extend this method in derived classes if you subscribed to
182			additional channels in subscribe_session().
183			"""
184			session.Unsubscribe(MAPS_CHANGED, self.maps_changed)
185
186	bh	6	def create_session(self):
187	bh	242	"""Create a default session.
188
189			Override this method in derived classes to instantiate the
190			session differently or to use a different session class. Don't
191			subscribe to channels here yet. Do that in the
192			subscribe_session() method.
193			"""
194	bh	6	self.SetSession(create_empty_session())
195
196			def OpenSession(self, filename):
197	bh	592	"""Open the session in the file named filename"""
198			# Make sure we deal with an absolute pathname. Otherwise we can
199			# get problems when saving because the saving code expects an
200			# absolute directory name
201			filename = os.path.abspath(filename)
202	bh	6	session = load_session(filename)
203			session.SetFilename(filename)
204			session.UnsetModified()
205			self.SetSession(session)
206
207			def SaveSession(self):
208			save_session(self.session, self.session.filename)
209
210	bh	242	def maps_changed(self, *args):
211	bh	6	if self.session.HasMaps():
212			self.top.SetMap(self.session.Maps()[0])
213			else:
214			self.top.SetMap(None)
Name	Value
svn:eol-style	native
svn:keywords	Author Date Id Revision