← Back to branch summary

~azzar1/unity/add-show-desktop-key

« back to all changes in this revision

Viewing changes to www/plugins/console/__init__.py

  • Committer: mattgiuca
  • Date: 2008-01-29 23:52:19 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:329
Converted Console from an "app" into a "plugin". It can now be plugged in to
any app.
Added "plugins" directory in www. Added "console" plugin. This contains all of
the functionality of what was previously the console app, but modularized so
it can be imported by another app.

apps/console: Removed most of the logic (moved to plugins/console). Replaced
with a simple import of the console plugin. Should behave exactly the same.
apps/tutorial: As proof of concept, imported the console plugin. It now
appears at the bottom of the page (yet to make it have "pop up" behaviour).

Show diffs side-by-side

added added

removed removed

Lines of Context:
www/plugins/console/__init__.py
 
1
# IVLE
 
2
# Copyright (C) 2007-2008 The University of Melbourne
 
3
#
 
4
# This program is free software; you can redistribute it and/or modify
 
5
# it under the terms of the GNU General Public License as published by
 
6
# the Free Software Foundation; either version 2 of the License, or
 
7
# (at your option) any later version.
 
8
#
 
9
# This program is distributed in the hope that it will be useful,
 
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
12
# GNU General Public License for more details.
 
13
#
 
14
# You should have received a copy of the GNU General Public License
 
15
# along with this program; if not, write to the Free Software
 
16
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
17
 
 
18
# Plugin: console
 
19
# Author: Matt Giuca
 
20
# Date: 30/1/2008
 
21
 
 
22
# Console plugin. This "mini-app" can be plugged in to another application.
 
23
# It exposes two functions: "present" and "insert_scripts_styles".
 
24
# These should both be called at the appropriate time by the implementing
 
25
# application. See docs on these functions for details.
 
26
 
 
27
from common import util
 
28
 
 
29
def insert_scripts_styles(scripts, styles):
 
30
    """Given 2 lists of strings: scripts and styles. These lists are lists of
 
31
    pathnames, as expected on the "scripts" and "styles" attributes of a
 
32
    Request object.
 
33
    This function appends new strings to the ends of each list, as required by
 
34
    this plugin. It does not add duplicates.
 
35
    """
 
36
    _append_if_absent(scripts,
 
37
        "media/common/json2.js",
 
38
        "media/common/md5.js",
 
39
        "media/common/util.js",
 
40
        "media/console/console.js")
 
41
    _append_if_absent(styles,
 
42
        "media/console/console.css")
 
43
 
 
44
def present(req):
 
45
    """Writes the HTML for this plugin into a request stream.
 
46
    May utilise other properties of the Request object in generating the HTML.
 
47
    """
 
48
    req.write("""<div id="console_body">
 
49
  <div id="console_output">
 
50
  </div>
 
51
  <div id="console_input">
 
52
   <div id="console_inputArea">
 
53
   </div>
 
54
   <label id="console_prompt">&gt;&gt;&gt;&nbsp;</label>
 
55
   <input id="console_inputText"
 
56
     type="text" size="80" onkeypress="catch_input(event.keyCode)" />
 
57
  </div>
 
58
</div>
 
59
""")
 
60
 
 
61
def _append_if_absent(list, *values):
 
62
    """Appends an arbitray number of values to a list, but omits values that
 
63
    are already contained within the list."""
 
64
    for value in values:
 
65
        if not value in list:
 
66
            list.append(value)