Improve target language symbol tables for Java and C#, using different scopes for the constants interface, module class and intermediary class rather than incorrectly putting all the symbols into one scope

git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk@11857 626c5289-ae23-0410-ae9c-e8d60b6d4f22

CHANGES.current

@@ -1,6 +1,17 @@
 Version 1.3.41 (in progress)
 ============================
 
+2010-02-13: wsfulton
+            [C#, Java] Fix incorrect multiply defined symbol name error when an enum item
+            and class name have the same name, as reported by Nathan Krieger. Example:
+
+              class Vector {};
+              namespace Text {
+                enum Preference { Vector };
+              }
+
+            This also fixes other incorrect corner case target language symbol name clashes.
+
 2010-02-11: wsfulton
             Add the -debug-lsymbols option for displaying the target language layer symbols.
 

Examples/test-suite/common.mk

@@ -305,6 +305,7 @@ CPP_TEST_CASES += \
 	static_const_member_2 \
 	struct_initialization_cpp \
 	struct_value \
+	symbol_clash \
 	template \
 	template_arg_replace \
 	template_arg_scope \

Examples/test-suite/symbol_clash.i

@@ -0,0 +1,28 @@
+%module symbol_clash
+
+// ::Vector and ::Text::Vector were incorrectly clashing in the target language symbol tables
+
+#if defined(SWIGJAVA) || defined(SWIGCSHARP)
+
+#if defined(SWIGJAVA)
+%include "enumtypeunsafe.swg"
+#elif defined(SWIGCSHARP)
+%include "enumsimple.swg"
+#endif
+
+%inline %{
+class Vector
+{
+};
+
+namespace Text
+{
+  enum Preference
+  {
+    Raster,
+    Vector
+  };
+}
+%}
+
+#endif

Source/Modules/csharp.cxx

@@ -330,6 +330,10 @@ public:
 	module_class_name = Copy(Getattr(n, "name"));
     }
 
+    // module class and intermediary classes are always created
+    addSymbol(imclass_name, n);
+    addSymbol(module_class_name, n);
+
     imclass_class_code = NewString("");
     proxy_class_def = NewString("");
     proxy_class_code = NewString("");
@@ -671,7 +675,7 @@ public:
   virtual int nativeWrapper(Node *n) {
     String *wrapname = Getattr(n, "wrap:name");
 
-    if (!addSymbol(wrapname, n))
+    if (!addSymbol(wrapname, n, imclass_name))
       return SWIG_ERROR;
 
     if (Getattr(n, "type")) {
@@ -711,7 +715,7 @@ public:
     String *overloaded_name = getOverloadedName(n);
 
     if (!Getattr(n, "sym:overloaded")) {
-      if (!addSymbol(Getattr(n, "sym:name"), n))
+      if (!addSymbol(Getattr(n, "sym:name"), n, imclass_name))
 	return SWIG_ERROR;
     }
 
@@ -1309,11 +1313,13 @@ public:
     String *return_type = NewString("");
     String *constants_code = NewString("");
 
-    if (!addSymbol(symname, n))
-      return SWIG_ERROR;
-
     bool is_enum_item = (Cmp(nodeType(n), "enumitem") == 0);
 
+    const String *itemname = (proxy_flag && wrapping_member_flag) ? variable_name : symname;
+    String *scope = proxy_flag && wrapping_member_flag ? proxy_class_name : module_class_name;
+    if (!addSymbol(itemname, n, scope))
+      return SWIG_ERROR;
+
     // The %csconst feature determines how the constant value is obtained
     int const_feature_flag = GetFlag(n, "feature:cs:const");
 
@@ -1354,7 +1360,6 @@ public:
     const String *outattributes = Getattr(n, "tmap:cstype:outattributes");
     if (outattributes)
       Printf(constants_code, "  %s\n", outattributes);
-    const String *itemname = (proxy_flag && wrapping_member_flag) ? variable_name : symname;
 
     const String *methodmods = Getattr(n, "feature:cs:methodmodifiers");
     methodmods = methodmods ? methodmods : (is_public(n) ? public_string : protected_string);

Source/Modules/java.cxx

@@ -47,6 +47,7 @@ class JAVA:public Language {
 
   String *imclass_name;		// intermediary class name
   String *module_class_name;	// module class name
+  String *constants_interface_name;	// constants interface name
   String *imclass_class_code;	// intermediary class code
   String *proxy_class_def;
   String *proxy_class_code;
@@ -114,6 +115,7 @@ public:
       member_func_flag(false),
       imclass_name(NULL),
       module_class_name(NULL),
+      constants_interface_name(NULL),
       imclass_class_code(NULL),
       proxy_class_def(NULL),
       proxy_class_code(NULL),
@@ -338,6 +340,11 @@ public:
       else
 	module_class_name = Copy(Getattr(n, "name"));
     }
+    constants_interface_name = NewStringf("%sConstants", module_class_name);
+
+    // module class and intermediary classes are always created
+    addSymbol(imclass_name, n);
+    addSymbol(module_class_name, n);
 
     imclass_class_code = NewString("");
     proxy_class_def = NewString("");
@@ -501,12 +508,12 @@ public:
 	Printf(f_module, "extends %s ", module_baseclass);
       if (Len(module_interfaces) > 0) {
 	if (Len(module_class_constants_code) != 0)
-	  Printv(f_module, "implements ", Getattr(n, "name"), "Constants, ", module_interfaces, " ", NIL);
+	  Printv(f_module, "implements ", constants_interface_name, ", ", module_interfaces, " ", NIL);
 	else
 	  Printv(f_module, "implements ", module_interfaces, " ", NIL);
       } else {
 	if (Len(module_class_constants_code) != 0)
-	  Printv(f_module, "implements ", Getattr(n, "name"), "Constants ", NIL);
+	  Printv(f_module, "implements ", constants_interface_name, " ", NIL);
       }
       Printf(f_module, "{\n");
 
@@ -526,7 +533,7 @@ public:
 
     // Generate the Java constants interface
     if (Len(module_class_constants_code) != 0) {
-      String *filen = NewStringf("%s%sConstants.java", SWIG_output_directory(), module_class_name);
+      String *filen = NewStringf("%s%s.java", SWIG_output_directory(), constants_interface_name);
       File *f_module = NewFile(filen, "w", SWIG_output_files());
       if (!f_module) {
 	FileErrorDisplay(filen);
@@ -545,7 +552,7 @@ public:
       if (module_imports)
 	Printf(f_module, "%s\n", module_imports);
 
-      Printf(f_module, "public interface %sConstants {\n", module_class_name);
+      Printf(f_module, "public interface %s {\n", constants_interface_name);
 
       // Write out all the global constants
       Printv(f_module, module_class_constants_code, NIL);
@@ -610,6 +617,8 @@ public:
     imclass_class_modifiers = NULL;
     Delete(module_class_name);
     module_class_name = NULL;
+    Delete(constants_interface_name);
+    constants_interface_name = NULL;
     Delete(module_class_code);
     module_class_code = NULL;
     Delete(module_baseclass);
@@ -739,7 +748,7 @@ public:
   virtual int nativeWrapper(Node *n) {
     String *wrapname = Getattr(n, "wrap:name");
 
-    if (!addSymbol(wrapname, n))
+    if (!addSymbol(wrapname, n, imclass_name))
       return SWIG_ERROR;
 
     if (Getattr(n, "type")) {
@@ -781,7 +790,7 @@ public:
     bool is_destructor = (Cmp(Getattr(n, "nodeType"), "destructor") == 0);
 
     if (!Getattr(n, "sym:overloaded")) {
-      if (!addSymbol(Getattr(n, "sym:name"), n))
+      if (!addSymbol(Getattr(n, "sym:name"), n, imclass_name))
 	return SWIG_ERROR;
     }
 
@@ -1348,11 +1357,13 @@ public:
     String *return_type = NewString("");
     String *constants_code = NewString("");
 
-    if (!addSymbol(symname, n))
-      return SWIG_ERROR;
-
     bool is_enum_item = (Cmp(nodeType(n), "enumitem") == 0);
 
+    const String *itemname = (proxy_flag && wrapping_member_flag) ? variable_name : symname;
+    String *scope = proxy_flag && wrapping_member_flag ? proxy_class_name : constants_interface_name;
+    if (!addSymbol(itemname, n, scope))
+      return SWIG_ERROR;
+
     // The %javaconst feature determines how the constant value is obtained
     int const_feature_flag = GetFlag(n, "feature:java:const");
 
@@ -1387,7 +1398,6 @@ public:
       Setattr(n, "value", new_value);
     }
 
-    const String *itemname = (proxy_flag && wrapping_member_flag) ? variable_name : symname;
     const String *methodmods = Getattr(n, "feature:java:methodmodifiers");
     methodmods = methodmods ? methodmods : (is_public(n) ? public_string : protected_string);