aboutsummaryrefslogtreecommitdiff
path: root/Source/Modules/lua.cxx
blob: b1c219139e65f47ee58388a8028c9f8fc7fdee5e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
/* -----------------------------------------------------------------------------
 * lua.cxx
 *
 *     Lua wrapper module.
 *
 * Author(s) : Mark Gossage (mark@gossage.cjb.net)
 *
 * Copyright (C) 1999-2000.  The University of Chicago
 * See the file LICENSE for information on usage and redistribution.
 * ----------------------------------------------------------------------------- */

/* NEW LANGUAGE NOTE:
 * ver001
   this is simply a copy of tcl8.cxx, which has been renamed
 * ver002
   all non essential code commented out, program now does virtually nothing
   it prints to stderr the list of functions to wrap, but does not create
   the XXX_wrap.c file
 * ver003
   added back top(), still prints the list of fns to stderr
   but now creates a rather empty XXX_wrap.c with some basic boilerplate code
 * ver004
   very basic version of functionWrapper()
   also uncommented usage_string() to keep compiler happy
   this will start producing proper looking code soon (I hope)
   produced the wrapper code, but without any type conversion (in or out)
   generates a few warning because of no wrappering
   does not generate SWIG_init()
   reason for this is that lua.swg is empty
   we will need to add code into this to make it work
 * ver005/6
   massive rework, basing work on the pike module instead of tcl
   (pike module it only 1/3 of the size)(though not as complete)
 * ver007
   added simple type checking
 * ver008
   INPUT, OUTPUT, INOUT typemaps handled (though not all types yet)
 * ver009
   class support: ok for basic types, but methods still TDB
   (code is VERY messed up & needs to be cleaned)


*/

char cvsroot_lua_cxx[] = "$Header$";

#include "swigmod.h"

/* NEW LANGUAGE NOTE:***********************************************
 most of the default options are handled by SWIG
 you can add new ones here
 (though for now I have not bothered)
NEW LANGUAGE NOTE:END ************************************************/
static const char *usage = (char*)"\
Lua Options (available with -lua)\n\
     (coming soon.)\n\n";
//     -ldflags        - Print runtime libraries to link with\n_
//     -prefix name    - Set a prefix to be appended to all names\n_
//     -namespace      - Build module into a Tcl 8 namespace. \n_
//     -pkgversion     - Set package version.\n\n";


/* NEW LANGUAGE NOTE:***********************************************
 To add a new language, you need to derive your class from
 Language and the overload various virtual functions
 (more on this as I figure it out)
NEW LANGUAGE NOTE:END ************************************************/

class LUA : public Language {
private:

  File *f_runtime;
  File *f_header;
  File *f_wrappers;
  File *f_init;
  File *f_initbeforefunc;
  String *PrefixPlusUnderscore;
  String *s_cmd_tab;				// table of command names
  String *s_var_tab;				// table of global variables
  String *s_const_tab;				// table of global constants
  String *s_methods_tab;			// table of class methods
  String *s_attr_tab;				// table of class atributes

  int have_constructor;
  int have_destructor;
  String* destructor_action;
  String* class_name;


public:

  /* ---------------------------------------------------------------------
   * LUA()
   *
   * Initialize member data
   * --------------------------------------------------------------------- */

  LUA() {
    f_runtime = 0;
    f_header = 0;
    f_wrappers = 0;
    f_init = 0;
    f_initbeforefunc = 0;
    PrefixPlusUnderscore = 0;

    s_cmd_tab=s_var_tab=s_const_tab=0;

  }

/* NEW LANGUAGE NOTE:***********************************************
 This is called to initalise the system & read any command line args
 most of this is boilerplate code, except the command line args
 which depends upon what args your code supports
NEW LANGUAGE NOTE:END ************************************************/
  /* ---------------------------------------------------------------------
   * main()
   *
   * Parse command line options and initializes variables.
   * --------------------------------------------------------------------- */

  virtual void main(int argc, char *argv[]) {

    /* Set location of SWIG library */
    SWIG_library_directory("lua");

    /* Look for certain command line options */
    for (int i = 1; i < argc; i++) {
      if (argv[i]) {
        if (strcmp (argv[i], "-help") == 0) {	// usage flags
	      fputs(usage,stderr);
	    }
      }
    }

/* NEW LANGUAGE NOTE:***********************************************
 This is the boilerplate code, setting a few #defines
 and which lib directory to use
 the SWIG_library_directory() is also boilerplate code
 but it always seems to be the first line of code
NEW LANGUAGE NOTE:END ************************************************/
    /* Add a symbol to the parser for conditional compilation */
    Preprocessor_define("SWIGLUA 1", 0);

    /* Set language-specific configuration file */
    SWIG_config_file("lua.swg");

    /* Set typemap language */
    SWIG_typemap_lang("lua");

    /* Enable overloaded methods support */
    allow_overloading();
  }




/* NEW LANGUAGE NOTE:***********************************************
 After calling main, SWIG parses the code to wrap (I believe)
 then calls top()
 in this is more boilerplate code to set everything up
 and a call to Language::top()
 which begins the code generations by calling the member fns
 after all that is more boilerplate code to close all down
 (overall there is virtually nothing here that needs to be edited
 just use as is)
NEW LANGUAGE NOTE:END ************************************************/
  /* ---------------------------------------------------------------------
   * top()
   * --------------------------------------------------------------------- */

  virtual int top(Node *n) {
    /* Get the module name */
    String *module = Getattr(n, "name");

    /* Get the output file name */
    String *outfile = Getattr(n, "outfile");

    /* Open the output file */
    f_runtime = NewFile(outfile, "w");
    if (!f_runtime) {
      FileErrorDisplay(outfile);
      SWIG_exit(EXIT_FAILURE);
    }
    f_init = NewString("");
    f_header = NewString("");
    f_wrappers = NewString("");
    f_initbeforefunc = NewString("");

    /* Register file targets with the SWIG file handler */
    Swig_register_filebyname("header", f_header);
    Swig_register_filebyname("wrapper", f_wrappers);
    Swig_register_filebyname("runtime", f_runtime);
    Swig_register_filebyname("init", f_init);
    Swig_register_filebyname("initbeforefunc", f_initbeforefunc);

/* NEW LANGUAGE NOTE:***********************************************
 s_cmd_tab,s_var_tab & s_const_tab hold the names of the fns for
 registering with SWIG.
 These will be filled in when the functions/variables are wrapped &
 then added to the end of the wrappering code
 just before it is written to file
NEW LANGUAGE NOTE:END ************************************************/
    // Initialize some variables for the object interface
    s_cmd_tab        = NewString("");
    s_var_tab        = NewString("");
//    s_methods_tab    = NewString("");
    s_const_tab      = NewString("");

    /* Standard stuff for the SWIG runtime section */
    Swig_banner(f_runtime);
//    if (NoInclude) {
//      Printf(f_runtime, "#define SWIG_NOINCLUDE\n");
//    }

    String *init_name = NewStringf("%(title)s_Init",module);
    Printf(f_header, "#define SWIG_init    %s\n", init_name);
    Printf(f_header, "#define SWIG_name    \"%s\"\n", module);
    /* SWIG_import is a special function name for importing within Lua5.1 */
    Printf(f_header, "#define SWIG_import  luaopen_%s\n\n", module);

    Printf(s_cmd_tab,   "\nstatic const struct luaL_reg swig_commands[] = {\n");
    Printf(s_var_tab,   "\nstatic swig_lua_var_info swig_variables[] = {\n");
    Printf(s_const_tab, "\nstatic swig_lua_const_info swig_constants[] = {\n");
    Printf(f_wrappers,"#ifdef __cplusplus\nextern \"C\" {\n#endif\n");

    /* Change naming scheme for constructors and destructors */
//    Swig_name_register("construct","%c_create");
//    Swig_name_register("destroy","%c_destroy");

    /* %init code inclusion, effectively in the SWIG_init function */
    Printf(f_init,"#ifdef __cplusplus\nextern \"C\"\n#endif\n");
    Printf(f_init, "void SWIG_init_user(lua_State* L)\n{\n");
    Language::top(n);
    Printf(f_init, "}\n" );

    Printf(f_wrappers,"#ifdef __cplusplus\n}\n#endif\n");

    // Done.  Close up the module & write to the wrappers
    Printv(s_cmd_tab,   tab4, "{0,0}\n", "};\n",NIL);
    Printv(s_var_tab,   tab4, "{0,0,0}\n", "};\n",NIL);
    Printv(s_const_tab, tab4, "{0,0,0,0,0,0}\n", "};\n", NIL);
    Printv(f_wrappers, s_cmd_tab, s_var_tab, s_const_tab,NIL);
    SwigType_emit_type_table(f_runtime, f_wrappers);

    //
    /* Close the initialization function */
//    Printf(f_init, "}\n");

/* NEW LANGUAGE NOTE:***********************************************
 this basically combines several of the strings together
 and then writes it all to a file
NEW LANGUAGE NOTE:END ************************************************/
    /* Close all of the files */
    Delete(s_cmd_tab);
    Delete(s_var_tab);
    Delete(s_const_tab);
    Dump(f_header, f_runtime);
    Dump(f_wrappers, f_runtime);
    Dump(f_initbeforefunc, f_runtime);
    Wrapper_pretty_print(f_init, f_runtime);
    Delete(f_header);
    Delete(f_wrappers);
    Delete(f_init);
    Delete(f_initbeforefunc);
    Close(f_runtime);
    Delete(f_runtime);

    /* Done */
    return SWIG_OK;
  }

  /* ------------------------------------------------------------
   * importDirective()
   * ------------------------------------------------------------ */

  virtual int importDirective(Node *n) {
    return Language::importDirective(n);
  }

/* NEW LANGUAGE NOTE:***********************************************
 This is it!
 you get this one right, and most of your work is done
 but its going to take soem file to get it working right
 quite a bit of this is generally boilerplate code
 (or stuff I dont understand)
 that which matters will have extra added comments
NEW LANGUAGE NOTE:END ************************************************/
  /* ---------------------------------------------------------------------
   * functionWrapper()
   *
   * Create a function declaration and register it with the interpreter.
   * --------------------------------------------------------------------- */

  virtual int functionWrapper(Node *n) {

    String  *name  = Getattr(n,"name");
    String  *iname = Getattr(n,"sym:name");
    SwigType *d    = Getattr(n,"type");
    ParmList *l    = Getattr(n,"parms");

    Parm *p;
    String *tm;
    int i;
//    int returnval=0;	// number of arguments returned

    String *overname = 0;
    if (Getattr(n,"sym:overloaded")) {
      overname = Getattr(n,"sym:overname");
    } else {
      if (!addSymbol(iname,n)) return SWIG_ERROR;
    }

/* NEW LANGUAGE NOTE:***********************************************
   the wrapper object holds all the wrappering code
    we need to add a couple of local variables
NEW LANGUAGE NOTE:END ************************************************/
    Wrapper *f = NewWrapper();
    Wrapper_add_local(f,"SWIG_arg", "int SWIG_arg = -1");


    String *wname = Swig_name_wrapper(iname);
    if (overname) {
      Append(wname,overname);
    }

/* NEW LANGUAGE NOTE:***********************************************
   the format of a lua fn is:
     static int wrap_XXX(lua_State* L){...}
   this line adds this into the wrappering code
NEW LANGUAGE NOTE:END ************************************************/
    Printv(f->def,
	   "static int ", wname, "(lua_State* L) {",
	   NIL);

/* NEW LANGUAGE NOTE:***********************************************
   this prints the list of args, eg for a C fn
   int gcd(int x,int y);
   it will print
     int arg1;
     int arg2;
     int result;
NEW LANGUAGE NOTE:END ************************************************/
    /* Write code to extract function parameters. */
    emit_args(d, l, f);

    /* Attach the standard typemaps */
    emit_attach_parmmaps(l,f);
    Setattr(n,"wrap:parms",l);

    /* Get number of required and total arguments */
    int num_arguments = emit_num_arguments(l);
    int num_required  = emit_num_required(l);
    int varargs = emit_isvarargs(l);

    /* Which input argument to start with? */
//    int start = (current == MEMBER_FUNC || current == MEMBER_VAR || current == DESTRUCTOR) ? 1 : 0;

    /* Offset to skip over the attribute name */
    // int offset = (current == MEMBER_VAR) ? 1 : 0;

/* NEW LANGUAGE NOTE:***********************************************
   from here on in, it gets rather hairy
   this is the code to convert from the scripting language to C/C++
   some of the stuff will refer to the typemaps code written in your swig file
   (lua.swg), and some is done in the code here
   I suppose you could do all the conversion on C, but it would be a nightmare to do
NEW LANGUAGE NOTE:END ************************************************/
    /* Generate code for argument marshalling */
//    String *description = NewString("");
/* NEW LANGUAGE NOTE:***********************************************
   argument_check is a new feature I added to check types of arguments:
   eg for int gcd(int,int)
   I want to check that arg1 & arg2 really are integers
NEW LANGUAGE NOTE:END ************************************************/
    String *argument_check = NewString("");
    String *argument_parse = NewString("");
    String *checkfn=NULL;
//    String *numoutputs=NULL;
    char source[64];
    for (i = 0, p = l; i < num_arguments; i++) {

      while (checkAttribute(p,"tmap:in:numinputs","0")) {
	    p = Getattr(p,"tmap:in:next");
      }

      SwigType *pt = Getattr(p,"type");
      String   *ln = Getattr(p,"lname");

	    /* Look for an input typemap */
	    sprintf(source, "%d", i+1);
	    if ((tm = Getattr(p,"tmap:in"))) {
           Replaceall(tm, "$source", source);
	       Replaceall(tm, "$target", ln);
	       Replaceall(tm, "$input", source);
	       Setattr(p, "emit:input", source);

/* NEW LANGUAGE NOTE:***********************************************
   look for a 'checkfn' typemap
   this an additional parameter added to the in typemap
   if found the type will be tested for
   this will result in code either in the
   argument_check or argument_parse string
NEW LANGUAGE NOTE:END ************************************************/
		   if ((checkfn=Getattr(p,"tmap:in:checkfn"))){
				if (i<num_required)
				{
					Printf(argument_check,"if(!%s(L,%s))",checkfn,source);
				}
				else
				{
					Printf(argument_check,"if(lua_gettop(L)>=%s && !%s(L,%s))",source,checkfn,source);
				}
				Printf(argument_check," SWIG_fail_arg(%s);\n",source);
	       }
/* NEW LANGUAGE NOTE:***********************************************
   lua states the number of arguments passed to a function using the fn
   lua_gettop()
   we can use this to deal with default arguments
NEW LANGUAGE NOTE:END ************************************************/
		   if (i<num_required){
		       Printf(argument_parse, "%s\n", tm);
	       }
	       else
	       {
			   Printf(argument_parse,"if(lua_gettop(L)>=%s){%s}\n",source,tm);
		   }
	       p = Getattr(p,"tmap:in:next");
	       continue;
	     } else {
/* NEW LANGUAGE NOTE:***********************************************
		   // why is this code not called when I dont have a typemap?
		   // instead of giving a warning, no code is generated
NEW LANGUAGE NOTE:END ************************************************/
	       Swig_warning(WARN_TYPEMAP_IN_UNDEF, input_file, line_number,
		       "Unable to use type %s as a function argument.\n",SwigType_str(pt,0));
	      break;
	    }

      p = nextSibling(p);
    }

    // add all argcheck code
    Printv(f->code,argument_check,argument_parse,NIL);

    /* Check for trailing varargs */
    if (varargs) {
      if (p && (tm = Getattr(p,"tmap:in"))) {
	Replaceall(tm,"$input", "varargs");
	Printv(f->code,tm,"\n",NIL);
      }
    }

    /* Insert constraint checking code */
    for (p = l; p;) {
      if ((tm = Getattr(p,"tmap:check"))) {
	Replaceall(tm,"$target",Getattr(p,"lname"));
	Printv(f->code,tm,"\n",NIL);
	p = Getattr(p,"tmap:check:next");
      } else {
	p = nextSibling(p);
      }
    }

    /* Insert cleanup code */
    String *cleanup = NewString("");
    for (p = l; p;) {
      if ((tm = Getattr(p,"tmap:freearg"))) {
	Replaceall(tm,"$source",Getattr(p,"lname"));
	Printv(cleanup,tm,"\n",NIL);
	p = Getattr(p,"tmap:freearg:next");
      } else {
	p = nextSibling(p);
      }
    }

    /* Insert argument output code */
    String *outarg = NewString("");
    for (p = l; p;) {
      if ((tm = Getattr(p,"tmap:argout"))) {
//	    // managing the number of returning variables
//        if (numoutputs=Getattr(p,"tmap:argout:numoutputs")){
//			int i=GetInt(p,"tmap:argout:numoutputs");
//			printf("got argout:numoutputs of %d\n",i);
//			returnval+=GetInt(p,"tmap:argout:numoutputs");
//        }
//        else returnval++;
  	    Replaceall(tm,"$source",Getattr(p,"lname"));
	    Replaceall(tm,"$target","result");
	    Replaceall(tm,"$arg",Getattr(p,"emit:input"));
	    Replaceall(tm,"$input",Getattr(p,"emit:input"));
	    Printv(outarg,tm,"\n",NIL);
	    p = Getattr(p,"tmap:argout:next");
      } else {
	    p = nextSibling(p);
      }
    }

    /* Emit the function call */
    emit_action(n,f);

/* NEW LANGUAGE NOTE:***********************************************
FIXME:
returns 1 if there is a void return type
this is because there is a typemap for void
NEW LANGUAGE NOTE:END ************************************************/
      Printv(f->code,"SWIG_arg=0;\n",NIL);
    // Return value if necessary
    if ((tm = Swig_typemap_lookup_new("out",n,"result",0))) {
      // managing the number of returning variables
//      if (numoutputs=Getattr(tm,"numoutputs")){
//		int i=GetInt(tm,"numoutputs");
//		printf("return numoutputs %d\n",i);
//		returnval+=GetInt(tm,"numoutputs");
//      }
//        else returnval++;
      Replaceall(tm,"$source", "result");
 	  if (GetFlag(n,"feature:new")) {
	    Replaceall(tm,"$owner","1");
	  } else {
	    Replaceall(tm,"$owner","0");
	  }
      Printf(f->code,"%s\n", tm);
//      returnval++;
    } else {
      Swig_warning(WARN_TYPEMAP_OUT_UNDEF, input_file, line_number,
		   "Unable to use return type %s in function %s.\n", SwigType_str(d,0), name);
    }

    /* Output argument output code */
    Printv(f->code,outarg,NIL);

    /* Output cleanup code */
    Printv(f->code,cleanup,NIL);

    /* Look to see if there is any newfree cleanup code */
    if (GetFlag(n,"feature:new")) {
      if ((tm = Swig_typemap_lookup_new("newfree",n,"result",0))) {
	Replaceall(tm,"$source","result");
	Printf(f->code,"%s\n",tm);
      }
    }

    /* See if there is any return cleanup code */
    if ((tm = Swig_typemap_lookup_new("ret", n, "result", 0))) {
      Replaceall(tm,"$source","result");
      Printf(f->code,"%s\n",tm);
    }


    /* Close the function */
    Printv(f->code, "return SWIG_arg;\n",NIL);
    // add the failure cleanup code:
    Printv(f->code, "\nfail:\n",NIL);
    Printv(f->code, "$cleanup","lua_error(L);\n",NIL);
    Printv(f->code, "return SWIG_arg;\n",NIL);
    Printf(f->code, "}\n");

    /* Substitute the cleanup code */
    Replaceall(f->code,"$cleanup",cleanup);

    /* Substitute the function name */
    Replaceall(f->code,"$symname",iname);
    Replaceall(f->code,"$result","resultobj");

    /* Dump the function out */
    Wrapper_print(f,f_wrappers);

    Setattr(n,"wrap:name", wname);	// you need this to make the overloading work

/* NEW LANGUAGE NOTE:***********************************************
register the function in SWIG
different language mappings seem to use different ideas
NEW LANGUAGE NOTE:END ************************************************/
    /* Now register the function with the interpreter. */
    if (!Getattr(n,"sym:overloaded")) {
//      add_method(n, iname, wname, description);
      Printv(s_cmd_tab, tab4, "{ \"", iname, "\", ", Swig_name_wrapper(iname), "},\n", NIL);
//      Printv(s_cmd_tab, tab4, "{ SWIG_prefix \"", iname, "\", (swig_wrapper_func) ", Swig_name_wrapper(iname), "},\n", NIL);
    } else {
//      Setattr(n,"wrap:name", wname);
      if (!Getattr(n,"sym:nextSibling")) {
	dispatchFunction(n);
      }
    }

    Delete(argument_check);
    Delete(argument_parse);

    Delete(cleanup);
    Delete(outarg);
//    Delete(description);
    Delete(wname);
    DelWrapper(f);

    return SWIG_OK;
  }

  /* ------------------------------------------------------------
   * dispatchFunction()
   *
   * Emit overloading dispatch function
   * ------------------------------------------------------------ */

/* NEW LANGUAGE NOTE:***********************************************
This is an extra function used for overloading of functions
it checks the args & then calls the relevant fn
nost of the real work in again typemaps:
look for %typecheck(SWIG_TYPECHECK_*) in the .swg file
NEW LANGUAGE NOTE:END ************************************************/
  void dispatchFunction(Node *n) {
    /* Last node in overloaded chain */

    int maxargs;
    String *tmp = NewString("");
    String *dispatch = Swig_overload_dispatch(n,"return %s(L);",&maxargs);

    /* Generate a dispatch wrapper for all overloaded functions */

    Wrapper *f       = NewWrapper();
    String  *symname = Getattr(n,"sym:name");
    String  *wname   = Swig_name_wrapper(symname);

//Printf(stdout,"Swig_overload_dispatch %s %s '%s' %d\n",symname,wname,dispatch,maxargs);

    Printv(f->def,
	   "static int ", wname, "(lua_State* L) {",
	   NIL);
    Wrapper_add_local(f,"argc","int argc");
    Printf(tmp,"int argv[%d]={1", maxargs+1);
    for(int i=1;i<=maxargs;i++)
    {
		Printf(tmp,",%d",i+1);
	}
	Printf(tmp,"}");
    Wrapper_add_local(f,"argv",tmp);
    Printf(f->code,"argc = lua_gettop(L);\n");

    Replaceall(dispatch,"$args","self,args");
    Printv(f->code,dispatch,"\n",NIL);
    Printf(f->code,"lua_pushstring(L,\"No matching function for overloaded '%s'\");\n", symname);
    Printf(f->code,"lua_error(L);return 0;\n");
    Printv(f->code,"}\n",NIL);
    Wrapper_print(f,f_wrappers);
    //add_method(symname,wname,0);
	Printv(s_cmd_tab, tab4, "{ \"", symname, "\",", wname, "},\n", NIL);

    DelWrapper(f);
    Delete(dispatch);
    Delete(tmp);
    Delete(wname);
  }


  /* ------------------------------------------------------------
   * variableWrapper()
   * ------------------------------------------------------------ */

  virtual int variableWrapper(Node *n) {
/* NEW LANGUAGE NOTE:***********************************************
FIXME
this is mainly guesswork
Language::variableWrapper(n) will generate two wrapper fns
Foo_get & Foo_set by calling functionWrapper()
so we will just add these into the variable lists
ideally we should not have reghistered these as functions,
only WRT this variable
will look into this later
NEW LANGUAGE NOTE:END ************************************************/
//    String *name  = Getattr(n,"name");
    String *iname = Getattr(n,"sym:name");
//   Swig_warning(WARN_TYPEMAP_IN_UNDEF, input_file, line_number,
//	   "variableWrapper %s : %s : %s \n",iname,Swig_name_set(iname),Swig_name_get(iname));
	   int result=Language::variableWrapper(n);
	   if (!GetFlag(n,"feature:immutable")) {
         Printv(s_var_tab, tab4, "{ \"", iname, "\", ", Swig_name_wrapper(Swig_name_get(iname)),
      			", ", Swig_name_wrapper(Swig_name_set(iname)),"},\n", NIL);
       }
       else { //imutable
         Printv(s_var_tab, tab4, "{ \"", iname, "\", ", Swig_name_wrapper(Swig_name_get(iname)),
      			", ","0","},\n", NIL);
       }
//      Printf(s_var_tab,"%s{ \"%s\", (swig_wrapper_func)%s, (swig_wrapper_func)%s },\n",
//      					tab4,iname,iname,iname);
//      Printv(s_var_tab, tab4, "{ \"", iname, "\", (swig_wrapper_func) ", Swig_name_wrapper(iname), "},\n", NIL);

	   return result;
     //return Language::variableWrapper(n);


  }

  /* ------------------------------------------------------------
   * constantWrapper()
   * ------------------------------------------------------------ */

  virtual int constantWrapper(Node *n) {
    String *name      = Getattr(n,"name");
    String *iname     = Getattr(n,"sym:name");
    SwigType *type    = Getattr(n,"type");
    String   *value   = Getattr(n,"value");
    String *tm;

    if (!addSymbol(iname,n)) return SWIG_ERROR;

    /* Special hook for member pointer */
    if (SwigType_type(type) == T_MPOINTER) {
      String *wname = Swig_name_wrapper(iname);
      Printf(f_wrappers, "static %s = %s;\n", SwigType_str(type,wname), value);
      value = Char(wname);
    }
    if ((tm = Swig_typemap_lookup_new("consttab",n,name,0))) {
      Replaceall(tm,"$source",value);
      Replaceall(tm,"$target",name);
      Replaceall(tm,"$value",value);
      Printf(s_const_tab,"%s,\n", tm);
    } else if ((tm = Swig_typemap_lookup_new("constcode", n, name, 0))) {
      Replaceall(tm,"$source", value);
      Replaceall(tm,"$target", name);
      Replaceall(tm,"$value",value);
      Printf(f_init, "%s\n", tm);
    } else {
      Swig_warning(WARN_TYPEMAP_CONST_UNDEF,
		   input_file, line_number, "Unsupported constant value.\n");
      return SWIG_NOWRAP;
    }
    return SWIG_OK;
  }
#if 0
  virtual int constantWrapper(Node *n) {
/* NEW LANGUAGE NOTE:***********************************************
FIXME
NEW LANGUAGE NOTE:END ************************************************/
//     return Language::constantWrapper(n);

    Swig_require(&n, "*sym:name", "type", "value", NIL);

    String *symname = Getattr(n, "sym:name");
    SwigType *type  = Getattr(n, "type");
    String *value   = Getattr(n, "value");

    /* Special hook for member pointer */
    if (SwigType_type(type) == T_MPOINTER) {
      String *wname = Swig_name_wrapper(symname);
      Printf(f_header, "static %s = %s;\n", SwigType_str(type, wname), value);
      value = wname;
    }

    /* Perform constant typemap substitution */
    String *tm = Swig_typemap_lookup_new("constant", n, value, 0);
    if (tm) {
      Replaceall(tm, "$source", value);
      Replaceall(tm, "$target", symname);
      Replaceall(tm, "$symname", symname);
      Replaceall(tm, "$value", value);
      Printf(f_init, "%s\n", tm);
    } else {
      Swig_warning(WARN_TYPEMAP_CONST_UNDEF, input_file, line_number,
		   "Unsupported constant value %s = %s\n", SwigType_str(type, 0), value);
    }

    Swig_restore(&n);

    return SWIG_OK;
//  }
#endif

  /* ------------------------------------------------------------
   * nativeWrapper()
   * ------------------------------------------------------------ */

  virtual int nativeWrapper(Node *n) {
       return Language::nativeWrapper(n);
/*    String *name     = Getattr(n,"sym:name");
    String *wrapname = Getattr(n,"wrap:name");

    if (!addSymbol(wrapname,n)) return SWIG_ERROR;

    add_method(n, name, wrapname,0);
    return SWIG_OK;*/
  }

  /* ------------------------------------------------------------
   * enumDeclaration()
   * ------------------------------------------------------------ */

  virtual int enumDeclaration(Node *n) {
    return Language::enumDeclaration(n);
  }

  /* ------------------------------------------------------------
   * enumvalueDeclaration()
   * ------------------------------------------------------------ */

  virtual int enumvalueDeclaration(Node *n) {
    return Language::enumvalueDeclaration(n);
  }

  /* ------------------------------------------------------------
   * classDeclaration()
   * ------------------------------------------------------------ */

  virtual int classDeclaration(Node *n) {
    return Language::classDeclaration(n);
  }

  /* ------------------------------------------------------------
   * classHandler()
   * ------------------------------------------------------------ */

    virtual int classHandler(Node *n) {

    String     *mangled_classname = 0;
    String     *real_classname = 0;

    have_constructor = 0;
    have_destructor = 0;
    destructor_action = 0;

    class_name = Getattr(n,"sym:name");
    if (!addSymbol(class_name,n)) return SWIG_ERROR;

    real_classname = Getattr(n,"name");
    mangled_classname = Swig_name_mangle(real_classname);

    s_attr_tab = NewString("");
    Printf(s_attr_tab, "static swig_lua_attribute swig_");
    Printv(s_attr_tab, mangled_classname, "_attributes[] = {\n", NIL);

    s_methods_tab = NewString("");
    Printf(s_methods_tab,"static swig_lua_method swig_");
    Printv(s_methods_tab, mangled_classname, "_methods[] = {\n", NIL);

  // Generate normal wrappers
    Language::classHandler(n);

    SwigType *t = Copy(Getattr(n,"name"));
    SwigType_add_pointer(t);

    // Catch all: eg. a class with only static functions and/or variables will not have 'remembered'
    SwigType_remember(t);
    String *wrap_class = NewStringf("&_wrap_class_%s", mangled_classname);
    SwigType_remember_clientdata(t,wrap_class);

    String *rt = Copy(Getattr(n,"classtype"));
    SwigType_add_pointer(rt);

    // Register the class structure with the type checker
    //    Printf(f_init,"SWIG_TypeClientData(SWIGTYPE%s, (void *) &_wrap_class_%s);\n", SwigType_manglestr(t), mangled_classname);
    if (have_destructor) {
      Printv(f_wrappers, "static void swig_delete_", class_name, "(void *obj) {\n", NIL);
      if (destructor_action) {
	Printv(f_wrappers, SwigType_str(rt,"arg1"), " = (", SwigType_str(rt,0), ") obj;\n", NIL);
	Printv(f_wrappers, destructor_action, NIL);
      } else {
	if (CPlusPlus) {
	  Printv(f_wrappers,"    delete (", SwigType_str(rt,0), ") obj;\n",NIL);
	} else {
	  Printv(f_wrappers,"    free((char *) obj);\n",NIL);
	}
      }
      Printf(f_wrappers,"}\n");
    }

    Printf(s_methods_tab, "    {0,0}\n};\n");
    Printv(f_wrappers,s_methods_tab,NIL);

    Printf(s_attr_tab, "    {0,0,0}\n};\n");
    Printv(f_wrappers,s_attr_tab,NIL);

	Delete(s_methods_tab);
	Delete(s_attr_tab);

    // Handle inheritance

    String *base_class = NewString("");

    List *baselist = Getattr(n,"bases");
    if (baselist && Len(baselist)) {
      Iterator b;
      int index = 0;
      b = First(baselist);
      while (b.item) {
	String *bname = Getattr(b.item, "name");
	if ((!bname) || GetFlag(b.item,"feature:ignore") || (!Getattr(b.item,"module"))) {
	  b = Next(b);
	  continue;
	}
/*        if( itcl ) {
          have_base_classes = 1;
          Printv( base_classes, bname, " ", NIL );
          Printv( base_class_init , "    ", bname, "Ptr::constructor $ptr\n", NIL );
        }*/
	String *bmangle = Swig_name_mangle(bname);
	//	Printv(f_wrappers,"extern swig_class _wrap_class_", bmangle, ";\n", NIL);
	Printf(base_class,"&_wrap_class_%s",bmangle);
	// Put code to register base classes in init function

//	Printf(f_init,"/* Register base : %s */\n", bmangle);
//	Printf(f_init,"swig_%s_bases[%d] = (swig_class *) SWIG_TypeQuery(\"%s *\")->clientdata;\n",  mangled_classname, index, SwigType_namestr(bname));
	b = Next(b);
	index++;
	Putc(',',base_class);
	Delete(bmangle);
      }
    }
/*    List *baselist = Getattr(n,"bases");
    if (baselist && Len(baselist)) {
      Node *base = First(baselist);
      while (base) {
	String *bname = Getattr(base, "name");
	if ((!bname) || GetFlag(base,"feature:ignore") || (!Getattr(base,"module"))) {
	  base = Next(baselist);
	  continue;
	}
	String *bmangle = Swig_name_mangle(bname);
	Printv(f_wrappers,"extern swig_class _wrap_class_", bmangle, ";\n", NIL);
	Printf(base_class,"&_wrap_class_%s",bmangle);
	base = Next(baselist);
	Putc(',',base_class);
	Delete(bmangle);
      }
    }*/

    Printv(f_wrappers,"static swig_lua_class *swig_",mangled_classname,"_bases[] = {", base_class,"0};\n", NIL);
    Delete(base_class);

    Printv(f_wrappers, "swig_lua_class _wrap_class_", mangled_classname, " = { \"", class_name,
	   "\", &SWIGTYPE", SwigType_manglestr(t), ",",NIL);

    if (have_constructor) {
      Printf(f_wrappers,"%s", Swig_name_wrapper(Swig_name_construct(class_name)));
    } else {
      Printf(f_wrappers,"0");
    }
    if (have_destructor) {
      Printv(f_wrappers, ", swig_delete_", class_name,NIL);
    } else {
      Printf(f_wrappers,",0");
    }
    Printv(f_wrappers, ", swig_", mangled_classname, "_methods, swig_", mangled_classname, "_attributes, swig_", mangled_classname,"_bases };\n\n", NIL);
//    Printv(s_cmd_tab, tab4, "{ SWIG_prefix \"", class_name, "\", (swig_wrapper_func) SWIG_ObjectConstructor, &_wrap_class_", mangled_classname, "},\n", NIL);
    Delete(t);
    Delete(mangled_classname);
    return SWIG_OK;
  }

  /* ------------------------------------------------------------
   * memberfunctionHandler()
   * ------------------------------------------------------------ */

  virtual int memberfunctionHandler(Node *n) {
    String *name  = Getattr(n,"name");
    String *iname = GetChar(n,"sym:name");

    String  *realname, *rname;

    Language::memberfunctionHandler(n);

    realname = iname ? iname : name;
    rname = Swig_name_wrapper(Swig_name_member(class_name, realname));
    if (!Getattr(n,"sym:nextSibling")) {
      Printv(s_methods_tab, tab4, "{\"", realname, "\", ", rname, "}, \n", NIL);
    }
    Delete(rname);
    return SWIG_OK;
  }

  /* ------------------------------------------------------------
   * membervariableHandler()
   * ------------------------------------------------------------ */

  virtual int membervariableHandler(Node *n) {
    String   *symname = Getattr(n,"sym:name");
    String   *rname;

    Language::membervariableHandler(n);
    Printv(s_attr_tab, tab4, "{ \"", symname, "\",", NIL);
    rname = Swig_name_wrapper(Swig_name_get(Swig_name_member(class_name,symname)));
    Printv(s_attr_tab, rname, ", ", NIL);
    Delete(rname);
    if (!GetFlag(n,"feature:immutable")) {
      rname = Swig_name_wrapper(Swig_name_set(Swig_name_member(class_name,symname)));
      Printv(s_attr_tab, rname, "},\n",NIL);
      Delete(rname);
    } else {
      Printf(s_attr_tab, "0 },\n");
    }
    return SWIG_OK;
  }

  /* ------------------------------------------------------------
   * constructorHandler()
   *
   * Method for adding C++ member constructor
   * ------------------------------------------------------------ */

   virtual int constructorHandler(Node *n) {
    Language::constructorHandler(n);
    have_constructor = 1;
    return SWIG_OK;
  }

  /* ------------------------------------------------------------
   * destructorHandler()
   * ------------------------------------------------------------ */

  virtual int destructorHandler(Node *n) {
    Language::destructorHandler(n);
    have_destructor = 1;
    destructor_action = Getattr(n,"wrap:action");
    return SWIG_OK;
  }

  /* -----------------------------------------------------------------------
   * staticmemberfunctionHandler()
   *
   * Wrap a static C++ function
   * ---------------------------------------------------------------------- */

  virtual int staticmemberfunctionHandler(Node *n) {
    return Language::staticmemberfunctionHandler(n);
  }

  /* ------------------------------------------------------------
   * memberconstantHandler()
   *
   * Create a C++ constant
   * ------------------------------------------------------------ */

  virtual int memberconstantHandler(Node *n) {
    return constantWrapper(n);
//    current = NO_CPP;
//    return SWIG_OK;
  }

  /* ---------------------------------------------------------------------
   * staticmembervariableHandler()
   * --------------------------------------------------------------------- */

  virtual int staticmembervariableHandler(Node *n) {
    return Language::staticmembervariableHandler(n);
  }
};

/* NEW LANGUAGE NOTE:***********************************************
 in order to add you language into swig, you need to make the following changes:
 - write this file (obviously)
 - add into the makefile (not 100% clear on how to do this)
 - edit swigmain.cxx to add your module

near the top of swigmain.cxx, look for this code & add you own codes
======= begin change ==========
extern "C" {
  Language *swig_tcl(void);
  Language *swig_python(void);
  //etc,etc,etc...
  Language *swig_lua(void);	// this is my code
}

  //etc,etc,etc...

swig_module  modules[] = {
  {"-guile",     swig_guile,     "Guile"},
  {"-java",      swig_java,      "Java"},
  //etc,etc,etc...
  {"-Lua",       swig_lua,       "Lua"},	// this is my code
  {NULL, NULL, NULL}	// this must come at the end of the list
};
======= end change ==========

This is all that is needed

NEW LANGUAGE NOTE:END ************************************************/

/* -----------------------------------------------------------------------------
 * swig_lua()    - Instantiate module
 * ----------------------------------------------------------------------------- */

extern "C" Language *
swig_lua(void) {
  return new LUA();
}