jyapayne/swig
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Escape < and > in HTML since unescaped instances confuse htmldoc and cause it

Browse source 
to mangle the "one HTML page" version of the manual.


git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk@9662 626c5289-ae23-0410-ae9c-e8d60b6d4f22
This commit is contained in:
Olly Betts 2007-03-26 01:12:09 +00:00
commit 8d304ae602
9 changed files with 81 additions and 81 deletions
Download patch file Download diff file Expand all files Collapse all files

110
Doc/Manual/Allegrocl.html
View file

@ -760,14 +760,14 @@ namespace car {
</p> </p>
<div class="code"> <div class="code">
<pre> <pre>
#define A 1 => (swig-defconstant "A" 1) #define A 1 =&gt; (swig-defconstant "A" 1)
#define B 'c' => (swig-defconstant "B" #\c) #define B 'c' =&gt; (swig-defconstant "B" #\c)
#define C B => (swig-defconstant "C" #\c) #define C B =&gt; (swig-defconstant "C" #\c)
#define D 1.0e2 => (swig-defconstant "D" 1.0d2) #define D 1.0e2 =&gt; (swig-defconstant "D" 1.0d2)
#define E 2222 => (swig-defconstant "E" 2222) #define E 2222 =&gt; (swig-defconstant "E" 2222)
#define F (unsigned int)2222 => no code generated #define F (unsigned int)2222 =&gt; no code generated
#define G 1.02e2f => (swig-defconstant "G" 1.02f2) #define G 1.02e2f =&gt; (swig-defconstant "G" 1.02f2)
#define H foo => no code generated #define H foo =&gt; no code generated
</pre> </pre>
</div> </div>
@ -789,13 +789,13 @@ namespace car {
<div class="code"> <div class="code">
<pre> <pre>
#define I A + E => (swig-defconstant "I" (+ 1 2222)) #define I A + E =&gt; (swig-defconstant "I" (+ 1 2222))
#define J 1|2 => (swig-defconstant "J" (logior 1 2)) #define J 1|2 =&gt; (swig-defconstant "J" (logior 1 2))
#define Y 1 + 2 * 3 + 4 => (swig-defconstant "Y" (* (+ 1 2) (+ 3 4))) #define Y 1 + 2 * 3 + 4 =&gt; (swig-defconstant "Y" (* (+ 1 2) (+ 3 4)))
#define Y1 (1 + 2) * (3 + 4) => (swig-defconstant "Y1" (* (+ 1 2) (+ 3 4))) #define Y1 (1 + 2) * (3 + 4) =&gt; (swig-defconstant "Y1" (* (+ 1 2) (+ 3 4)))
#define Y2 1 * 2 + 3 * 4 => (swig-defconstant "Y2" (* 1 (+ 2 3) 4)) ;; WRONG #define Y2 1 * 2 + 3 * 4 =&gt; (swig-defconstant "Y2" (* 1 (+ 2 3) 4)) ;; WRONG
#define Y3 (1 * 2) + (3 * 4) => (swig-defconstant "Y3" (* 1 (+ 2 3) 4)) ;; WRONG #define Y3 (1 * 2) + (3 * 4) =&gt; (swig-defconstant "Y3" (* 1 (+ 2 3) 4)) ;; WRONG
#define Z 1 + 2 - 3 + 4 * 5 => (swig-defconstant "Z" (* (+ 1 (- 2 3) 4) 5)) ;; WRONG #define Z 1 + 2 - 3 + 4 * 5 =&gt; (swig-defconstant "Z" (* (+ 1 (- 2 3) 4) 5)) ;; WRONG
</pre> </pre>
</div> </div>
<p> <p>
@ -863,20 +863,20 @@ namespace nnn {
<div class="targetlang"> <div class="targetlang">
<pre> <pre>
user> (load "globalvar.dll") user&gt; (load "globalvar.dll")
; Foreign loading globalvar.dll. ; Foreign loading globalvar.dll.
t t
user> (load "globalvar.cl") user&gt; (load "globalvar.cl")
; Loading c:\mikel\src\swig\test\globalvar.cl ; Loading c:\mikel\src\swig\test\globalvar.cl
t t
user> user&gt;
globalvar> (globalvar.nnn::global_var) globalvar&gt; (globalvar.nnn::global_var)
2 2
globalvar> (globalvar.nnn::glob_float) globalvar&gt; (globalvar.nnn::glob_float)
2.0 2.0
globalvar> (setf (globalvar.nnn::glob_float) 3.0) globalvar&gt; (setf (globalvar.nnn::glob_float) 3.0)
3.0 3.0
globalvar> (globalvar.nnn::glob_float) globalvar&gt; (globalvar.nnn::glob_float)
3.0 3.0
</pre> </pre>
</div> </div>
@ -1215,10 +1215,10 @@ class A {
typedef A Foo; typedef A Foo;
A *xxx(int i); /* sets A->x = A->y = i */ A *xxx(int i); /* sets A-&gt;x = A-&gt;y = i */
Foo *yyy(int i); /* sets Foo->x = Foo->y = i */ Foo *yyy(int i); /* sets Foo-&gt;x = Foo-&gt;y = i */
int zzz(A *inst = 0); /* return inst->x + inst->y */ int zzz(A *inst = 0); /* return inst-&gt;x + inst-&gt;y */
</pre> </pre>
</div> </div>
@ -1258,22 +1258,22 @@ int zzz(A *inst = 0); /* return inst->x + inst->y */
</p> </p>
<div class="targetlang"> <div class="targetlang">
<pre> <pre>
CL-USER> (load "synonym.dll") CL-USER&gt; (load "synonym.dll")
; Foreign loading synonym.dll. ; Foreign loading synonym.dll.
t t
CL-USER> (load "synonym.cl") CL-USER&gt; (load "synonym.cl")
; Loading c:\mikel\src\swig\test\synonym.cl ; Loading c:\mikel\src\swig\test\synonym.cl
t t
CL-USER> CL-USER&gt;
synonym> (setf a (xxx 3)) synonym&gt; (setf a (xxx 3))
#&lt;A nil #x3261a0 @ #x207299da&gt; #&lt;A nil #x3261a0 @ #x207299da&gt;
synonym> (setf foo (yyy 10)) synonym&gt; (setf foo (yyy 10))
#&lt;A nil #x3291d0 @ #x2072e982&gt; #&lt;A nil #x3291d0 @ #x2072e982&gt;
synonym> (zzz a) synonym&gt; (zzz a)
6 6
synonym> (zzz foo) synonym&gt; (zzz foo)
20 20
synonym> synonym&gt;
</pre> </pre>
</div> </div>
@ -1326,7 +1326,7 @@ class A {
}; };
float xxx(int i, int x = 0); /* return i * x */ float xxx(int i, int x = 0); /* return i * x */
float xxx(A *inst, int x); /* return x + A->x + A->y */ float xxx(A *inst, int x); /* return x + A-&gt;x + A-&gt;y */
</pre> </pre>
</div> </div>
@ -1443,21 +1443,21 @@ EXPORT float ACL___xxx__SWIG_2 (A *larg1, int larg2) {
</p> </p>
<div class="targetlang"> <div class="targetlang">
<pre> <pre>
overload> (setf a (new_A)) overload&gt; (setf a (new_A))
#&lt;A nil #x329268 @ #x206cf612&gt; #&lt;A nil #x329268 @ #x206cf612&gt;
overload> (setf (A_x a) 10) overload&gt; (setf (A_x a) 10)
10 10
overload> (setf (A_y a) 20) overload&gt; (setf (A_y a) 20)
20 20
overload> (xxx 1) overload&gt; (xxx 1)
0.0 0.0
overload> (xxx 3 10) overload&gt; (xxx 3 10)
30.0 30.0
overload> (xxx a 1) overload&gt; (xxx a 1)
31.0 31.0
overload> (xxx a 2) overload&gt; (xxx a 2)
32.0 32.0
overload> overload&gt;
</pre> </pre>
</div> </div>
@ -1506,17 +1506,17 @@ overload>
%rename(__logand_assign__) *::operator&amp;=; %rename(__logand_assign__) *::operator&amp;=;
%rename(__logior_assign__) *::operator|=; %rename(__logior_assign__) *::operator|=;
%rename(__lshift__) *::operator<<; %rename(__lshift__) *::operator&lt;&lt;;
%rename(__lshift_assign__) *::operator<<=; %rename(__lshift_assign__) *::operator&lt;&lt;=;
%rename(__rshift__) *::operator>>; %rename(__rshift__) *::operator&gt;&gt;;
%rename(__rshift_assign__) *::operator>>=; %rename(__rshift_assign__) *::operator&gt;&gt;=;
%rename(__eq__) *::operator==; %rename(__eq__) *::operator==;
%rename(__ne__) *::operator!=; %rename(__ne__) *::operator!=;
%rename(__lt__) *::operator<; %rename(__lt__) *::operator&lt;;
%rename(__gt__) *::operator>; %rename(__gt__) *::operator&gt;;
%rename(__lte__) *::operator<=; %rename(__lte__) *::operator&lt;=;
%rename(__gte__) *::operator>=; %rename(__gte__) *::operator&gt;=;
%rename(__and__) *::operator&amp;&amp;; %rename(__and__) *::operator&amp;&amp;;
%rename(__or__) *::operator||; %rename(__or__) *::operator||;
@ -1529,8 +1529,8 @@ overload>
%rename(__comma__) *::operator,(); %rename(__comma__) *::operator,();
%rename(__comma__) *::operator,() const; %rename(__comma__) *::operator,() const;
%rename(__member_ref__) *::operator->; %rename(__member_ref__) *::operator-&gt;;
%rename(__member_func_ref__) *::operator->*; %rename(__member_func_ref__) *::operator-&gt;*;
%rename(__funcall__) *::operator(); %rename(__funcall__) *::operator();
%rename(__aref__) *::operator[]; %rename(__aref__) *::operator[];
@ -1599,11 +1599,11 @@ bool B___eq__(B const *inst, int const x)
</p> </p>
<div class="targetlang"> <div class="targetlang">
<pre> <pre>
opoverload> (B___eq__ x1 x2) opoverload&gt; (B___eq__ x1 x2)
nil nil
opoverload> (B___eq__ x1 3) opoverload&gt; (B___eq__ x1 3)
nil nil
opoverload> opoverload&gt;
</pre> </pre>
</div> </div>

2
Doc/Manual/CSharp.html
View file

@ -1485,7 +1485,7 @@ and usage from C++
Container container; Container container;
Element element(20); Element element(20);
container.setElement(&amp;element); container.setElement(&amp;element);
cout &lt;&lt; "element.value: " &lt;&lt; container.getElement()->value &lt;&lt; endl; cout &lt;&lt; "element.value: " &lt;&lt; container.getElement()-&gt;value &lt;&lt; endl;
</pre> </pre>
</div> </div>

12
Doc/Manual/Extending.html
View file

@ -2869,13 +2869,13 @@ functionWrapper : void delete_Shape(Shape *self)
action : delete arg1; action : delete arg1;
functionWrapper : void Shape_x_set(Shape *self,double x) functionWrapper : void Shape_x_set(Shape *self,double x)
action : if (arg1) (arg1)->x = arg2; action : if (arg1) (arg1)-&gt;x = arg2;
functionWrapper : double Shape_x_get(Shape *self) functionWrapper : double Shape_x_get(Shape *self)
action : result = (double) ((arg1)->x); action : result = (double) ((arg1)-&gt;x);
functionWrapper : void Shape_y_set(Shape *self,double y) functionWrapper : void Shape_y_set(Shape *self,double y)
action : if (arg1) (arg1)->y = arg2; action : if (arg1) (arg1)-&gt;y = arg2;
... ...
</pre> </pre>
</div> </div>
@ -2975,7 +2975,7 @@ virtual int functionWrapper(Node *n) {
.... ....
/* write the wrapper function definition */ /* write the wrapper function definition */
Printv(wrapper->def,"RETURN_TYPE ", wname, "(ARGS) {",NIL); Printv(wrapper-&gt;def,"RETURN_TYPE ", wname, "(ARGS) {",NIL);
/* if any additional local variable needed, add them now */ /* if any additional local variable needed, add them now */
... ...
@ -3005,13 +3005,13 @@ virtual int functionWrapper(Node *n) {
.... ....
/* Close the function(ok) */ /* Close the function(ok) */
Printv(wrapper->code, "return ALL_OK;\n", NIL); Printv(wrapper-&gt;code, "return ALL_OK;\n", NIL);
/* add the failure cleanup code */ /* add the failure cleanup code */
... ...
/* Close the function(error) */ /* Close the function(error) */
Printv(wrapper->code, "return ERROR;\n", "}\n", NIL); Printv(wrapper-&gt;code, "return ERROR;\n", "}\n", NIL);
/* final substititions if applicable */ /* final substititions if applicable */
... ...

8
Doc/Manual/Java.html
View file

@ -3936,7 +3936,7 @@ Let's consider an example:
int array[4]; int array[4];
void populate(int x[]) { void populate(int x[]) {
int i; int i;
for (i=0; i<4; i++) for (i=0; i&lt;4; i++)
x[i] = 100 + i; x[i] = 100 + i;
} }
</pre> </pre>
@ -4083,7 +4083,7 @@ In Java, you would use the functions like this:
<div class="code"> <div class="code">
<pre> <pre>
SWIGTYPE_p_int array = example.new_intArray(10000000); // Array of 10-million integers SWIGTYPE_p_int array = example.new_intArray(10000000); // Array of 10-million integers
for (int i=0; i<10000; i++) { // Set some values for (int i=0; i&lt;10000; i++) { // Set some values
example.intArray_setitem(array,i,i); example.intArray_setitem(array,i,i);
} }
int sum = example.sumitems(array,10000); int sum = example.sumitems(array,10000);
@ -4112,7 +4112,7 @@ For instance, you will be able to do this in Java:
<div class="code"> <div class="code">
<pre> <pre>
intArray array = new intArray(10000000); // Array of 10-million integers intArray array = new intArray(10000000); // Array of 10-million integers
for (int i=0; i<10000; i++) { // Set some values for (int i=0; i&lt;10000; i++) { // Set some values
array.setitem(i,i); array.setitem(i,i);
} }
int sum = example.sumitems(array.cast(),10000); int sum = example.sumitems(array.cast(),10000);
@ -6672,7 +6672,7 @@ and usage from C++
Container container; Container container;
Element element(20); Element element(20);
container.setElement(&amp;element); container.setElement(&amp;element);
cout &lt;&lt; "element.value: " &lt;&lt; container.getElement()->value &lt;&lt; endl; cout &lt;&lt; "element.value: " &lt;&lt; container.getElement()-&gt;value &lt;&lt; endl;
</pre> </pre>
</div> </div>

2
Doc/Manual/Lisp.html
View file

@ -126,7 +126,7 @@ As we mentioned earlier the ideal way to use SWIG is to use interface
<div class="code"><pre> <div class="code"><pre>
#define y 5 #define y 5
#define x (y >> 1) #define x (y &gt;&gt; 1)
typedef int days; typedef int days;

2
Doc/Manual/Lua.html
View file

@ -107,7 +107,7 @@ extern int Example_Init(LuaState* L); // declare the wrapped module
int main(int argc,char* argv[]) int main(int argc,char* argv[])
{ {
lua_State *L; lua_State *L;
if (argc<2) if (argc&lt;2)
{ {
printf("%s: &lt;filename.lua&gt;\n",argv[0]); printf("%s: &lt;filename.lua&gt;\n",argv[0]);
return 0; return 0;

10
Doc/Manual/Perl5.html
View file

@ -1247,8 +1247,8 @@ The following C++ operators are currently supported by the Perl module:
<li>operator== </li> <li>operator== </li>
<li>operator!= </li> <li>operator!= </li>
<li>operator% </li> <li>operator% </li>
<li>operator> </li> <li>operator&gt; </li>
<li>operator< </li> <li>operator&lt; </li>
<li>operator and </li> <li>operator and </li>
<li>operator or </li> <li>operator or </li>
</ul> </ul>
@ -2924,11 +2924,11 @@ sub set_transform
{ {
my ($im, $x) = @_; my ($im, $x) = @_;
my $a = new_mat44(); my $a = new_mat44();
for (my $i = 0; $i < 4, $i++) for (my $i = 0; $i &lt; 4, $i++)
{ {
for (my $j = 0; $j < 4, $j++) for (my $j = 0; $j &lt; 4, $j++)
{ {
mat44_set($a, $i, $j, $x->[i][j]) mat44_set($a, $i, $j, $x-&gt;[i][j])
} }
} }
example.set_transform($im, $a); example.set_transform($im, $a);

14
Doc/Manual/Python.html
View file

@ -1971,7 +1971,7 @@ public:
int main() { int main() {
A *a = new A(); A *a = new A();
a->ref(); // 'a' is ref here a-&gt;ref(); // 'a' is ref here
B *b1 = new B(a); // 'a' is ref here B *b1 = new B(a); // 'a' is ref here
if (1 + 1 == 2) { if (1 + 1 == 2) {
@ -1980,7 +1980,7 @@ int main() {
} }
delete b1; // 'a' is unref, but not deleted delete b1; // 'a' is unref, but not deleted
a->unref(); // 'a' is unref and deleted a-&gt;unref(); // 'a' is unref and deleted
} }
</pre> </pre>
</div> </div>
@ -2004,8 +2004,8 @@ counted objects, you use the "ref" and "unref" features, or
%module example %module example
... ...
%feature("ref") RCObj "$this->ref();" %feature("ref") RCObj "$this-&gt;ref();"
%feature("unref") RCObj "$this->unref();" %feature("unref") RCObj "$this-&gt;unref();"
%include "rcobj.h" %include "rcobj.h"
%include "A.h" %include "A.h"
@ -2021,8 +2021,8 @@ or, using the directive form:
%module example %module example
... ...
%ref RCObj "$this->ref();" %ref RCObj "$this-&gt;ref();"
%unref RCObj "$this->unref();" %unref RCObj "$this-&gt;unref();"
%include "rcobj.h" %include "rcobj.h"
%include "A.h" %include "A.h"
@ -2058,7 +2058,7 @@ exit # 'a' is released, SWIG unref 'a'
</div> </div>
<p> <p>
Note that the user doesn't explicitly need to call 'a->ref()' nor 'a->unref()' Note that the user doesn't explicitly need to call 'a-&gt;ref()' nor 'a-&gt;unref()'
(as neither 'delete a'). Instead, SWIG take cares of executing the "ref" (as neither 'delete a'). Instead, SWIG take cares of executing the "ref"
and "unref" codes as needed. If the user doesn't specify the and "unref" codes as needed. If the user doesn't specify the
"ref/unref" features, SWIG will produce a code equivalent to define "ref/unref" features, SWIG will produce a code equivalent to define

2
Doc/Manual/Ruby.html
View file

@ -1302,7 +1302,7 @@ irb(main):003:0&gt; <b>puts foo.value</b></pre>
<pre>foo = Foo.new <pre>foo = Foo.new
begin begin
foo.test() foo.test()
rescue CustomError => e rescue CustomError =&gt; e
puts "Caught custom error" puts "Caught custom error"
end </pre> end </pre>
</div> </div>