← Back to branch summary

~ubuntu-branches/ubuntu/precise/kompozer/precise

« back to all changes in this revision

Viewing changes to mozilla/extensions/xmlterm/base/README

  • Committer: Bazaar Package Importer
  • Author(s): Anthony Yarusso
  • Date: 2007-08-27 01:11:03 UTC
  • Revision ID: james.westby@ubuntu.com-20070827011103-2jgf4s6532gqu2ka
Tags: upstream-0.7.10
Import upstream version 0.7.10

Show diffs side-by-side

added added

removed removed

Lines of Context:
mozilla/extensions/xmlterm/base/README
 
1
 base --- core source code for XMLterm and LineTerm
 
2
 
 
3
XMLterm may be invoked in one of two ways:
 
4
 1. By loading "-chrome chrome://xmlterm/content/xmlterm.xul" in mozilla, or
 
5
 2. By running the stand-alone executable "../geckoterm/xmlterm".
 
6
The diagram below shows the control-flow/layering hierarchy for both ways
 
7
of invoking XMLterm.
 
8
 
 
9
              XMLterm control-flow/layering hierarchy
 
10
              =======================================
 
11
  
 
12
          mozilla-executable               geckoterm-executable
 
13
                 |                                 |
 
14
       ../ui/content/xmlterm.xul                   |
 
15
                 |                                 |
 
16
       ../ui/content/xmlterm.html       ../ui/content/xmlterm.html
 
17
                 |                                 |
 
18
          mozXMLTermShell              ../geckoterm/mozGeckoTerm
 
19
                 |                              |        |
 
20
                 +--------------+---------------+        |
 
21
                                |                  mozSimpleContainer
 
22
                          mozXMLTerminal
 
23
                                |
 
24
            +-------------------+--------------------+
 
25
            |                   |                    |
 
26
     mozXMLTermSession    mozLineTermAux      mozXMLTermListeners
 
27
            |                   |                    |
 
28
            |                   |                    |
 
29
      (rendering...)       (LineTerm)           (user input)
 
30
                       (pseudo-TTY/shell)
 
31
 
 
32
 
 
33
15 Mar 2000
 
34
============================================================================
 
35
FILES:
 
36
 
 
37
The core source code for XMLterm in this directory consists of two distinct
 
38
families of files, those with names that begin with the prefix "moz" and all
 
39
the other files. The former are the Mozilla-specific portions of XMLterm,
 
40
written in C++. The remaining files constitute the Mozilla-independent portion
 
41
of XMLterm, referred to as "LineTerm".
 
42
 
 
43
============================================================================
 
44
LINETERM:
 
45
 
 
46
LineTerm is a line-oriented terminal program, in some respects similar in
 
47
functionality to the GNU Readline package. It is completely independent of the
 
48
Mozilla source code, is written in plain C, and dually licensed under GPL and
 
49
MPL.
 
50
 
 
51
============================================================================
 
52
INTERFACES:
 
53
 
 
54
lineterm.h              Plain C interface to LineTerm
 
55
                          (used by mozLineTerm)
 
56
 
 
57
mozILineTerm.idl        Scriptable XPCOM/XPCONNECT interface to LineTerm
 
58
                          (not used at the moment)
 
59
 
 
60
mozILineTermAux.h       XPCOM interface to LineTerm, with extra features
 
61
                          (used by mozXMLTerminal)
 
62
 
 
63
mozIXMLTermShell.h      Scriptable XPCOM/XPCONNECT interface to XMLterm
 
64
                          (used by the Javascript glue code in the XMLterm
 
65
                           start page at ../ui/content/xmlterm.html)
 
66
 
 
67
mozIXMLTerminal.h       XPCOM interface to XMLterm
 
68
                          (used by mozXMLTermShell, ../geckoterm/mozGeckoterm)
 
69
 
 
70
mozIXMLTermStream.h     XPCOM interface for displaying HTML/XML streams in
 
71
                          IFRAMES (used by mozXMLTermSession)
 
72
 
 
73
 
 
74
IMPLEMENTATIONS:
 
75
 
 
76
 
 
77
mozLineTerm.h
 
78
mozLineTermcpp             Implementation of mozILineTerm, mozILineTermAux
 
79
                             Uses LineTerm to access shell
 
80
 
 
81
mozXMLTermShell.h
 
82
mozXMLTermShell.cpp        Implementation of mozIXMLTermShell
 
83
                             Uses mozIXMLTerminal to create XMLterm
 
84
 
 
85
mozXMLTerminal.h
 
86
mozXMLTerminal.cpp         Implementation of mozIXMLTerminal,
 
87
                                             nsIWebProgressListener, and
 
88
                                             nsIObserver
 
89
                             Uses mozILineTermAux to create LineTerm
 
90
                             Uses mozXMLTermListeners to capture user input
 
91
                             Uses mozXMLTermSession to display input/output
 
92
 
 
93
mozXMLTermListeners.h
 
94
mozXMLTermListeners.cpp    Implementations of nsIDOMKeyListener,
 
95
                                              nsIDOMTextListener,
 
96
                                              nsIDOMMouseListener,
 
97
                                              nsIDOMDragListener
 
98
 
 
99
mozXMLTermStream.h
 
100
mozXMLTermStreamcpp        Implementation of mozIXMLTermStream
 
101
 
 
102
 
 
103
CLASSES:
 
104
 
 
105
 
 
106
mozXMLTermSession.h/cpp    Class to manage session input/output display
 
107
                             (used by mozXMLTerminal)
 
108
                             Uses mozIXMLTermStream to display streams
 
109
 
 
110
mozXMLTermUtils.h/cpp      Abstract class for static utility functions
 
111
                             (for use by all classes)
 
112
 
 
113
============================================================================
 
114
The following are dually licensed under MPL and GPL:
 
115
 
 
116
LineTerm package:
 
117
 
 
118
lineterm.h        Public interface to LineTerm
 
119
 
 
120
ltermPrivate.h    Private common header file
 
121
 
 
122
ltermManager.c    LineTerm manager
 
123
ltermIO.c         Overlapping I/O functions
 
124
ltermInput.c      Input handler
 
125
ltermOutput.c     Output handler
 
126
ltermEscape.c     Escape sequence handler
 
127
 
 
128
Low-level packages:
 
129
 
 
130
ptystream.h
 
131
ptystream.c       Stream-like interface to Unix pseudo-TTY
 
132
 
 
133
tracelog.h
 
134
tracelog.c        Simple tracing/logging diagnostic library
 
135
 
 
136
unistring.h
 
137
unistring.c       Simple Unicode manipulation library
 
138
 
 
139
============================================================================