]> git.decadent.org.uk Git - ion3.git/blob - doc/ionnotes/index.html
27c31f27432c4c0de6e432f8242e1460eed81db1
[ion3.git] / doc / ionnotes / index.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2
3 <!--Converted with LaTeX2HTML 2002-2-1 (1.71)
4 original version by:  Nikos Drakos, CBLU, University of Leeds
5 * revised and updated by:  Marcus Hennecke, Ross Moore, Herb Swan
6 * with significant contributions from:
7   Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
8 <HTML>
9 <HEAD>
10 <TITLE>Ion: Notes for the module and patch writer</TITLE>
11 <META NAME="description" CONTENT="Ion: Notes for the module and patch writer">
12 <META NAME="keywords" CONTENT="ionnotes">
13 <META NAME="resource-type" CONTENT="document">
14 <META NAME="distribution" CONTENT="global">
15
16 <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
17 <META NAME="Generator" CONTENT="LaTeX2HTML v2002-2-1">
18 <META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
19
20 <LINK REL="STYLESHEET" HREF="ionnotes.css">
21
22 <LINK REL="next" HREF="node1.html">
23 </HEAD>
24
25 <BODY >
26
27 <DIV CLASS="navigation"><!--Navigation Panel-->
28 <A NAME="tex2html11"
29   HREF="node1.html">
30 <IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A> 
31 <A NAME="tex2html5"
32   HREF="http://iki.fi/tuomov/ion/">
33 <IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A> 
34 <IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev_g.png"> 
35 <A NAME="tex2html7"
36   HREF="node1.html">
37 <IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A> 
38 <A NAME="tex2html9"
39   HREF="node8.html">
40 <IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index" SRC="index.png"></A> 
41 <BR>
42 <B> Next:</B> <A NAME="tex2html12"
43   HREF="node1.html">Contents</A>
44 <B> Up:</B> <A NAME="tex2html6"
45   HREF="http://iki.fi/tuomov/ion/">Ion homepage</A>
46  &nbsp; <B>  <A NAME="tex2html8"
47   HREF="node1.html">Contents</A></B> 
48  &nbsp; <B>  <A NAME="tex2html10"
49   HREF="node8.html">Index</A></B> 
50 <BR>
51 <BR></DIV>
52 <!--End of Navigation Panel-->
53
54 <P>
55 <H1 ALIGN="CENTER">Ion: Notes for the module and patch writer</H1>
56 <DIV CLASS="author_info">
57
58 <P ALIGN="CENTER"><STRONG>Tuomo Valkonen</STRONG></P>
59 <P ALIGN="CENTER"><I>tuomov at iki.fi</I></P>
60 </DIV>
61
62 <P>
63 Ion: Notes for the module and patch writer
64 <BR>
65 Copyright &#169;  2003-2004 Tuomo Valkonen.
66
67 <P>
68 This document is free; you can redistribute it and/or modify
69 it under the terms of the GNU General Public License as published by
70 the Free Software Foundation; either version 2 of the License, or
71 (at your option) any later version.
72
73 <P>
74 This document is distributed in the hope that it will be useful,
75 but WITHOUT ANY WARRANTY; without even the implied warranty of
76 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
77 section entitled ''GNU General Public License'' for more details.
78
79 <P>
80
81 <P><P>
82 <BR>
83
84 <P>
85
86 <H3>Abstract:</H3>
87 <DIV CLASS="ABSTRACT">
88     This document is an unorganized collection of notes for
89     those who want to write modules or patches to Ion.
90 </DIV>
91 <P>
92
93 <P>
94 <BR><HR>
95 <!--Table of Child-Links-->
96 <A NAME="CHILD_LINKS"></A>
97
98 <UL CLASS="ChildLinks">
99 <LI><A NAME="tex2html13"
100   HREF="node1.html">Contents</A>
101 <LI><A NAME="tex2html14"
102   HREF="node2.html"><SPAN CLASS="arabic">1</SPAN> Class and object hierarchies</A>
103 <UL>
104 <LI><A NAME="tex2html15"
105   HREF="node2.html#SECTION00021000000000000000"><SPAN CLASS="arabic">1</SPAN>.<SPAN CLASS="arabic">1</SPAN> Class hierarchy</A>
106 <LI><A NAME="tex2html16"
107   HREF="node2.html#SECTION00022000000000000000"><SPAN CLASS="arabic">1</SPAN>.<SPAN CLASS="arabic">2</SPAN> Object hierarchies: WRegion parents and managers</A>
108 <UL>
109 <LI><A NAME="tex2html17"
110   HREF="node2.html#SECTION00022100000000000000"><SPAN CLASS="arabic">1</SPAN>.<SPAN CLASS="arabic">2</SPAN>.<SPAN CLASS="arabic">1</SPAN> Parent-child relations</A>
111 <LI><A NAME="tex2html18"
112   HREF="node2.html#SECTION00022200000000000000"><SPAN CLASS="arabic">1</SPAN>.<SPAN CLASS="arabic">2</SPAN>.<SPAN CLASS="arabic">2</SPAN> Manager-managed relations</A>
113 </UL>
114 <LI><A NAME="tex2html19"
115   HREF="node2.html#SECTION00023000000000000000"><SPAN CLASS="arabic">1</SPAN>.<SPAN CLASS="arabic">3</SPAN> Summary</A>
116 </UL>
117 <BR>
118 <LI><A NAME="tex2html20"
119   HREF="node3.html"><SPAN CLASS="arabic">2</SPAN> Object system implementation</A>
120 <LI><A NAME="tex2html21"
121   HREF="node4.html"><SPAN CLASS="arabic">3</SPAN> The Lua interface</A>
122 <UL>
123 <LI><A NAME="tex2html22"
124   HREF="node4.html#SECTION00041000000000000000"><SPAN CLASS="arabic">3</SPAN>.<SPAN CLASS="arabic">1</SPAN> Supported types</A>
125 <LI><A NAME="tex2html23"
126   HREF="node4.html#SECTION00042000000000000000"><SPAN CLASS="arabic">3</SPAN>.<SPAN CLASS="arabic">2</SPAN> Exporting functions</A>
127 <LI><A NAME="tex2html24"
128   HREF="node4.html#SECTION00043000000000000000"><SPAN CLASS="arabic">3</SPAN>.<SPAN CLASS="arabic">3</SPAN> Calling Lua functions and code</A>
129 <LI><A NAME="tex2html25"
130   HREF="node4.html#SECTION00044000000000000000"><SPAN CLASS="arabic">3</SPAN>.<SPAN CLASS="arabic">4</SPAN> Miscellaneous notes</A>
131 </UL>
132 <BR>
133 <LI><A NAME="tex2html26"
134   HREF="node5.html"><SPAN CLASS="arabic">4</SPAN> Miscellaneous design notes</A>
135 <UL>
136 <LI><A NAME="tex2html27"
137   HREF="node5.html#SECTION00051000000000000000"><SPAN CLASS="arabic">4</SPAN>.<SPAN CLASS="arabic">1</SPAN> Destroying WObj:s</A>
138 <LI><A NAME="tex2html28"
139   HREF="node5.html#SECTION00052000000000000000"><SPAN CLASS="arabic">4</SPAN>.<SPAN CLASS="arabic">2</SPAN> The types <TT>char*</TT> and <TT>const char*</TT> as function
140   parameters and return values</A>
141 </UL>
142 <BR>
143 <LI><A NAME="tex2html29"
144   HREF="node6.html"><SPAN CLASS="arabic">5</SPAN> C coding style</A>
145 <UL>
146 <LI><A NAME="tex2html30"
147   HREF="node6.html#SECTION00061000000000000000"><SPAN CLASS="arabic">5</SPAN>.<SPAN CLASS="arabic">1</SPAN> Whitespace</A>
148 <LI><A NAME="tex2html31"
149   HREF="node6.html#SECTION00062000000000000000"><SPAN CLASS="arabic">5</SPAN>.<SPAN CLASS="arabic">2</SPAN> Braces</A>
150 <LI><A NAME="tex2html32"
151   HREF="node6.html#SECTION00063000000000000000"><SPAN CLASS="arabic">5</SPAN>.<SPAN CLASS="arabic">3</SPAN> Names</A>
152 <LI><A NAME="tex2html33"
153   HREF="node6.html#SECTION00064000000000000000"><SPAN CLASS="arabic">5</SPAN>.<SPAN CLASS="arabic">4</SPAN> Miscellaneous</A>
154 </UL>
155 <BR>
156 <LI><A NAME="tex2html34"
157   HREF="node7.html">A. The GNU General Public License</A>
158 <UL>
159 <LI><A NAME="tex2html35"
160   HREF="node7.html#SECTION00071000000000000000">Appendix: How to Apply These Terms to Your New Programs</A>
161 </UL>
162 <BR>
163 <LI><A NAME="tex2html36"
164   HREF="node8.html">Index</A>
165 <LI><A NAME="tex2html37"
166   HREF="node9.html">About this document ...</A>
167 </UL>
168 <!--End of Table of Child-Links-->
169 <BR><HR>
170
171 </BODY>
172 </HTML>