Merge branch 'nick/orber/recursive_types/OTP-8868' into maint-r14

* nick/orber/recursive_types/OTP-8868:
  Support for recursive unions and structs. Break loop if recursive TypeCode.
  Added basic tests for recursive uinions and structs.
  Removed test code.
  Added partial support for recursive IDL types.

Conflicts:
	lib/ic/doc/src/notes.xml
	lib/ic/vsn.mk
	lib/orber/vsn.mk

9 files changed, 215 insertions, 25 deletions

diff --git a/lib/orber/doc/src/ch_idl_to_erlang_mapping.xml b/lib/orber/doc/src/ch_idl_to_erlang_mapping.xml
index a97ad65f0e..964ae3e92d 100644
--- a/lib/orber/doc/src/ch_idl_to_erlang_mapping.xml
+++ b/lib/orber/doc/src/ch_idl_to_erlang_mapping.xml
@@ -4,7 +4,7 @@
 <chapter>
   <header>
     <copyright>
-      <year>1997</year><year>2009</year>
+      <year>1997</year><year>2010</year>
       <holder>Ericsson AB. All Rights Reserved.</holder>
     </copyright>
     <legalnotice>
@@ -445,7 +445,19 @@ void op(in myEnum a);</cell>
     <section>
       <title>Struct Data Type</title>
       <p>A <c>struct</c> may have Basic, Template, Scoped Names and Constructed 
-        types as members.</p>
+        types as members. By using forward declaration we can define a recursive struct:</p>
+      <code type="none"><![CDATA[
+struct myStruct; // Forward declaration
+typedef sequence<myStruct> myStructSeq;
+struct myStruct {
+    myStructSeq chain;
+};
+
+// Deprecated definition (anonymous) not supported by IC
+struct myStruct {
+    sequence<myStruct> chain;
+};
+      ]]></code>
     </section>
 
     <section>
@@ -510,6 +522,25 @@ union LongUnion2 switch(long) {
   default: boolean DefaultValue; 
 };
       </code>
+      <p>In the same way as structs, unions can be recursive if forward
+         declaration is used (anonymous types is deprecated and not supported):</p>
+      <code type="none"><![CDATA[
+// Forward declaration
+union myUnion;
+typedef sequence<myUnion>myUnionSeq;
+union myUnion switch (long) {
+    case 1 : myUnionSeq chain;
+    default: boolean DefaultValue;
+};
+      ]]></code>
+
+    <note>
+      <p>Recursive types (union and struct) require Light IFR. I.e. the
+         IC option {light_ifr, true} is used and that Orber is configured in such a way that
+         Light IFR is activated. Recursive TypeCode is currently not supported, which is
+         why these cannot be encapsulated in an any data type.</p>
+    </note>
+
     </section>
     <warning>
       <p>Every field in, for example, a struct must be initiated. Otherwise
@@ -890,7 +921,7 @@ attribute long RWAttribute;
       object internal state with its object reference. The object internal state is
       an Erlang term which has a format defined by the user.</p>
     <note>
-      <p>It is is not always the case that the internal state will be the first parameter, as stubs can use their own object reference as the first parameter (see the IC documentation).</p>
+      <p>It is not always the case that the internal state will be the first parameter, as stubs can use their own object reference as the first parameter (see the IC documentation).</p>
     </note>
     <p>A function call will invoke an operation. The first
       parameter of the function should be the object reference and then
diff --git a/lib/orber/doc/src/notes.xml b/lib/orber/doc/src/notes.xml
index 6eda16a517..1e2cdd05ba 100644
--- a/lib/orber/doc/src/notes.xml
+++ b/lib/orber/doc/src/notes.xml
@@ -33,6 +33,36 @@
   </header>
 
   <section>
+    <title>Orber 3.6.19</title>
+
+    <section>
+      <title>Improvements and New Features</title>
+      <list type="bulleted">
+        <item>
+          <p>
+            Partial support for recursive structs and unions. 
+            Only available for the erl_corba backend and requires
+            that Light IFR is used. I.e. the IC option {light_ifr, true}
+            and that Orber is configured in such a way that Light IFR
+            is activated. Recursive TypeCode is currently not supported.</p>
+          <p>
+            Own Id: OTP-8868 Aux Id: seq11633</p>
+        </item>
+      </list>
+    </section>
+    <section>
+      <title>Fixed Bugs and Malfunctions</title>
+      <list type="bulleted">
+        <item>
+          <p>The SSL option {ssl_imp, old} was not used if ssl_generation was
+             set to 2. Only R14B was affected by this.</p>
+          <p>Own Id: OTP-8994 Aux Id:seq11747</p>
+        </item>
+      </list>
+    </section>
+  </section>
+
+  <section>
     <title>Orber 3.6.18</title>
     <section>
       <title>Fixed Bugs and Malfunctions</title>
diff --git a/lib/orber/src/cdr_decode.erl b/lib/orber/src/cdr_decode.erl
index 9d30098940..36ef6ce02f 100644
--- a/lib/orber/src/cdr_decode.erl
+++ b/lib/orber/src/cdr_decode.erl
@@ -2,7 +2,7 @@
 %%
 %% %CopyrightBegin%
 %% 
-%% Copyright Ericsson AB 1997-2009. All Rights Reserved.
+%% Copyright Ericsson AB 1997-2010. All Rights Reserved.
 %% 
 %% The contents of this file are subject to the Erlang Public License,
 %% Version 1.1, (the "License"); you may not use this file except in
@@ -898,9 +898,13 @@ dec_sequence_struct(Version, Message, N, TypeCodeList, Len, ByteOrder, Buff, C,
     {Seq, Rest2, Len2, NewC2} = dec_sequence_struct(Version, Rest1, N - 1,  TypeCodeList, Len1, ByteOrder, 
 						    Buff, NewC, Name),
     {[list_to_tuple([Name |Struct]) | Seq], Rest2, Len2, NewC2}.
-dec_sequence_union(_, Message, 0, _DiscrTC, _Default, _ElementList, Len, _ByteOrder, _Buff, C, _Name) ->
+
+
+dec_sequence_union(_, Message, 0, _DiscrTC, _Default, _ElementList,
+		   Len, _ByteOrder, _Buff, C, _Name) ->
     {[], Message, Len, C};
-dec_sequence_union(Version, Message, N, DiscrTC, Default, ElementList, Len, ByteOrder, Buff, C, Name) ->
+dec_sequence_union(Version, Message, N, DiscrTC, Default, ElementList,
+		   Len, ByteOrder, Buff, C, Name) when is_list(ElementList) ->
 
     {Label, Rest1, Len1, NewC} = dec_type(DiscrTC, Version, Message, Len, ByteOrder, Buff, C),
     Result = dec_union(Version, stringify_enum(DiscrTC, Label), ElementList, Default, 
@@ -916,7 +920,20 @@ dec_sequence_union(Version, Message, N, DiscrTC, Default, ElementList, Len, Byte
 						   DiscrTC, Default, ElementList, 
 						   Len2, ByteOrder, 
 						   Buff, NewC3, Name),
-    {[{Name, Label, Value} | Seq], Rest3, Len3, NewC4}.
+    {[{Name, Label, Value} | Seq], Rest3, Len3, NewC4};
+dec_sequence_union(Version, Message, N, _DiscrTC, _Default, Module,
+		   Len, ByteOrder, Buff, C, Name) when is_atom(Module) ->
+    case catch Module:tc() of
+	{tk_union, _, _, DiscrTC, Default, ElementList} ->
+	    dec_sequence_union(Version, Message, N, DiscrTC, Default, ElementList,
+			       Len, ByteOrder, Buff, C, Name);
+	What ->
+	    orber:dbg("[~p] ~p:dec_sequence_union(~p). Union module doesn't exist or incorrect.", 
+		      [?LINE, ?MODULE, What], ?DEBUG_LEVEL),
+	    corba:raise(#'MARSHAL'{completion_status=?COMPLETED_MAYBE})
+    end.
+   
+ 
 
 %% A special case; when something is encapsulated (i.e. sent as octet-sequence)
 %% we sometimes don not want the result to be converted to a list.
@@ -993,14 +1010,16 @@ dec_wstring(Version, Message, Len, ByteOrder, Buff, C) ->
 %% Func: dec_union/9
 %%-----------------------------------------------------------------
 %% ## NEW IIOP 1.2 ##
-dec_union(Version, ?SYSTEM_TYPE, Name, DiscrTC, Default, ElementList, Bytes, Len, ByteOrder, Buff, C) ->
+dec_union(Version, ?SYSTEM_TYPE, Name, DiscrTC, Default, ElementList, Bytes,
+	  Len, ByteOrder, Buff, C) ->
     {Label, Rest1, Len1, NewC} = dec_type(DiscrTC, Version, Bytes, Len, ByteOrder, Buff, C),
     {Value, Rest2, Len2, NewC3} = dec_union(Version, Label, ElementList, Default, 
 					    Rest1, Len1, ByteOrder, Buff, NewC),
     {{Name, Label, Value}, Rest2, Len2, NewC3};
 
 
-dec_union(Version, IFRId, _, DiscrTC, Default, ElementList, Bytes, Len, ByteOrder, Buff, C) ->
+dec_union(Version, IFRId, _, DiscrTC, Default, ElementList, Bytes, Len, 
+	  ByteOrder, Buff, C) when is_list(ElementList) ->
     {Label, Rest1, Len1, NewC} = dec_type(DiscrTC, Version, Bytes, Len, ByteOrder, Buff, C),
     Result = dec_union(Version, stringify_enum(DiscrTC, Label), ElementList, Default, 
 				     Rest1, Len1, ByteOrder, Buff, NewC),
@@ -1012,7 +1031,20 @@ dec_union(Version, IFRId, _, DiscrTC, Default, ElementList, Bytes, Len, ByteOrde
 		    X
 	    end,
     Name = ifrid_to_name(IFRId, ?IFR_UnionDef),
-    {{Name, Label, Value}, Rest2, Len2, NewC3}.
+    {{Name, Label, Value}, Rest2, Len2, NewC3};
+dec_union(Version, IFRId, _, _DiscrTC, _Default, Module, Bytes, Len, 
+	  ByteOrder, Buff, C) when is_atom(Module) ->
+    case catch Module:tc() of
+	{tk_union, _, Name, DiscrTC, Default, ElementList} ->
+	    dec_union(Version, IFRId, Name, DiscrTC, Default, ElementList, Bytes, Len, 
+		      ByteOrder, Buff, C);
+	What ->
+	    orber:dbg("[~p] ~p:dec_union(~p). Union module doesn't exist or incorrect.", 
+		      [?LINE, ?MODULE, What], ?DEBUG_LEVEL),
+	    corba:raise(#'MARSHAL'{completion_status=?COMPLETED_MAYBE})
+    end.
+   
+    
 
 dec_union(_, _, [], Default,  Message, Len, _, _Buff, C) when Default < 0 ->
     {undefined, Message, Len, C};
@@ -1047,7 +1079,16 @@ dec_struct1(_, [], Message, Len, _ByteOrder, _, C) ->
 dec_struct1(Version, [{_ElemName, ElemType} | TypeCodeList], Message, Len, ByteOrder, Buff, C) ->
     {Element, Rest, Len1, NewC} = dec_type(ElemType, Version, Message, Len, ByteOrder, Buff, C),
     {Struct, Rest1, Len2, NewC2} = dec_struct1(Version, TypeCodeList, Rest, Len1, ByteOrder, Buff, NewC),
-    {[Element |Struct], Rest1, Len2, NewC2}.
+    {[Element |Struct], Rest1, Len2, NewC2};
+dec_struct1(Version, Module, Message, Len, ByteOrder, Buff, C) ->
+    case catch Module:tc() of
+	{tk_struct, _, _, TypeCodeList} ->
+	    dec_struct1(Version, TypeCodeList, Message, Len, ByteOrder, Buff, C);
+	What ->
+	    orber:dbg("[~p] ~p:dec_struct1(~p). Struct module doesn't exist or incorrect.", 
+		      [?LINE, ?MODULE, What], ?DEBUG_LEVEL),
+	    corba:raise(#'MARSHAL'{completion_status=?COMPLETED_MAYBE})
+    end.
 
 ifrid_to_name([], Type) ->
     orber:dbg("[~p] ~p:ifrid_to_name([], ~p). No Id supplied.", 
@@ -1232,7 +1273,9 @@ get_user_exception_type(TypeId) ->
 %%-----------------------------------------------------------------
 dec_type_code(Version, Message, Len, ByteOrder, Buff, C) ->
     {TypeNo, Message1, Len1, NewC} = dec_type('tk_ulong', Version, Message, Len, ByteOrder, Buff, C),
-    dec_type_code(TypeNo, Version, Message1, Len1, ByteOrder, Buff, NewC).
+    TC = dec_type_code(TypeNo, Version, Message1, Len1, ByteOrder, Buff, NewC),
+    erase(orber_indirection),
+    TC.
 
 %%-----------------------------------------------------------------
 %% Func: dec_type_code/5
@@ -1441,13 +1484,22 @@ dec_type_code(33, Version, Message, Len, ByteOrder, Buff, C) ->
 					{"name", {'tk_string', 0}}]},
 		 Version, Rest1, 1, ByteOrder1, Buff, C+1+Ex),
     {{'tk_local_interface', RepId, Name}, Message1, Len1, NewC};
-dec_type_code(16#ffffffff, Version, Message, Len, ByteOrder, Buff, C) ->  %% placeholder
+dec_type_code(16#ffffffff, Version, Message, Len, ByteOrder, Buff, C) ->
     {Indirection, Message1, Len1, NewC} =
 	dec_type('tk_long', Version, Message, Len, ByteOrder, Buff, C),
     Position = C+Indirection,
-    <<_:Position/binary, SubBuff/binary>> = Buff,
-    {TC, _, _, _} = dec_type_code(Version, SubBuff, Position, ByteOrder, Buff, Position),
-    {TC, Message1, Len1, NewC};
+    case put(orber_indirection, Position) of
+	Position ->
+%%	    {{'none', Indirection}, Message1, Len1, NewC};
+            %% Recursive TypeCode. Break the loop.
+ 	    orber:dbg("[~p] cdr_decode:dec_type_code(~p); Recursive TC not supported.", 
+ 		      [?LINE,Position], ?DEBUG_LEVEL),
+ 	    corba:raise(#'MARSHAL'{completion_status=?COMPLETED_NO});
+	_ ->
+	    <<_:Position/binary, SubBuff/binary>> = Buff,
+	    {TC, _, _, _} = dec_type_code(Version, SubBuff, Position, ByteOrder, Buff, Position),
+	    {TC, Message1, Len1, NewC}
+    end;
 dec_type_code(Type, _, _, _, _, _, _) -> 
     orber:dbg("[~p] cdr_decode:dec_type_code(~p); No match.", 
 			    [?LINE, Type], ?DEBUG_LEVEL),
diff --git a/lib/orber/src/cdr_encode.erl b/lib/orber/src/cdr_encode.erl
index 3ecb8833f5..eaf3c5b7dc 100644
--- a/lib/orber/src/cdr_encode.erl
+++ b/lib/orber/src/cdr_encode.erl
@@ -2,7 +2,7 @@
 %%
 %% %CopyrightBegin%
 %% 
-%% Copyright Ericsson AB 1997-2009. All Rights Reserved.
+%% Copyright Ericsson AB 1997-2010. All Rights Reserved.
 %% 
 %% The contents of this file are subject to the Erlang Public License,
 %% Version 1.1, (the "License"); you may not use this file except in
@@ -815,11 +815,21 @@ enc_wstring(Env, String, MaxLength, Bytes, Len) ->
 %%-----------------------------------------------------------------
 %% Func: enc_union/5
 %%-----------------------------------------------------------------
-enc_union(Env, {_, Label, Value}, DiscrTC, Default, TypeCodeList, Bytes, Len) ->
+enc_union(Env, {_, Label, Value}, DiscrTC, Default, TypeCodeList, 
+	  Bytes, Len) when is_list(TypeCodeList) ->
     {ByteSequence, Len1} = enc_type(DiscrTC, Env, Label, Bytes, Len),
     Label2 = stringify_enum(DiscrTC,Label),
     enc_union2(Env, {Label2, Value},TypeCodeList, Default, 
-	      ByteSequence, Len1, undefined).
+	       ByteSequence, Len1, undefined);
+enc_union(Env, Value, _DiscrTC, _Default, Module, Bytes, Len) when is_atom(Module) ->
+    case catch Module:tc() of
+	{tk_union, _, _, DiscrTC, Default, ElementList} ->
+	    enc_union(Env, Value, DiscrTC, Default, ElementList, Bytes, Len);
+	What ->
+	    orber:dbg("[~p] ~p:enc_union(~p). Union module doesn't exist or incorrect.", 
+		      [?LINE, ?MODULE, What], ?DEBUG_LEVEL),
+	    corba:raise(#'MARSHAL'{completion_status=?COMPLETED_MAYBE})
+    end.  
 
 enc_union2(_Env, _What, [], Default, Bytes, Len, _) when Default < 0 ->
     {Bytes, Len};
@@ -840,9 +850,19 @@ stringify_enum(_, Label) ->
 %%-----------------------------------------------------------------
 %% Func: enc_struct/4
 %%-----------------------------------------------------------------
-enc_struct(Env, Struct, TypeCodeList, Bytes, Len) ->
+enc_struct(Env, Struct, TypeCodeList, Bytes, Len) when is_list(TypeCodeList) ->
     [_Name | StructList] = tuple_to_list(Struct),
-    enc_struct1(Env, StructList, TypeCodeList, Bytes, Len).
+    enc_struct1(Env, StructList, TypeCodeList, Bytes, Len);
+enc_struct(Env, Struct, Module, Bytes, Len) ->
+    [Module | StructList] = tuple_to_list(Struct),
+    case catch Module:tc() of
+	{tk_struct, _, _, TypeCodeList} ->
+	    enc_struct1(Env, StructList, TypeCodeList, Bytes, Len);
+	What ->
+	    orber:dbg("[~p] ~p:enc_struct([], ~p). Struct module doesn't exist or incorrect.", 
+		      [?LINE, ?MODULE, What], ?DEBUG_LEVEL),
+	    corba:raise(#'MARSHAL'{completion_status=?COMPLETED_MAYBE})
+    end.
 
 enc_struct1(_Env, [], [], Bytes, Len) ->
     {Bytes, Len};
diff --git a/lib/orber/test/Makefile b/lib/orber/test/Makefile
index 4601e84d2c..5495735318 100644
--- a/lib/orber/test/Makefile
+++ b/lib/orber/test/Makefile
@@ -120,7 +120,11 @@ GEN_MOD_TEST_SERVER = \
 	orber_test_server_uni \
 	orber_test_server_uni_d \
 	orber_test_timeout_server \
-	orber_parent_inherrit
+	orber_parent_inherrit \
+	orber_test_server_rec_struct \
+	orber_test_server_rec_struct_seq \
+	orber_test_server_rec_union \
+	orber_test_server_rec_union_seq
 
 GEN_HRL_TEST_SERVER = \
 	oe_orber_test_server.hrl \
diff --git a/lib/orber/test/orber_test_lib.erl b/lib/orber/test/orber_test_lib.erl
index a694dc58c4..b95cf4b0ec 100644
--- a/lib/orber/test/orber_test_lib.erl
+++ b/lib/orber/test/orber_test_lib.erl
@@ -1280,6 +1280,22 @@ test_coding(Obj, Local) ->
     ?match({'EXCEPTION',{'MARSHAL',_,_,_}}, 
           orber_test_server:
 		 testing_iiop_server_marshal(Obj, "string")),
+    
+    RecS = #orber_test_server_rec_struct{chain = [#orber_test_server_rec_struct{chain = []}]},
+    ?match(RecS, orber_test_server:testing_iiop_rec_struct(Obj, RecS)),
+    
+    RecU = #orber_test_server_rec_union{label = 'RecursiveType', 
+					value = [#orber_test_server_rec_union{label = 'RecursiveType',
+									      value = []}]},
+    ?match(RecU, orber_test_server:testing_iiop_rec_union(Obj, RecU)),
+
+%%     RecA1 = #any{typecode = unsupported, value = RecS},
+%%     RecA2 = #any{typecode = unsupported, value = RecU},
+%%     ?match(RecA1, 
+%% 	   orber_test_server:testing_iiop_rec_any(Obj, RecA1)),    
+%%     ?match(RecA2, 
+%% 	   orber_test_server:testing_iiop_rec_any(Obj, RecA2)),    
+
     ok.
 
 %%--------------- Testing Post- & Pre-cond -------------------
diff --git a/lib/orber/test/orber_test_server.idl b/lib/orber/test/orber_test_server.idl
index a88211c941..438c10e19b 100644
--- a/lib/orber/test/orber_test_server.idl
+++ b/lib/orber/test/orber_test_server.idl
@@ -28,7 +28,7 @@ module orber_parent {
 };
 
 module orber_test { 
- 
+
   // interface server
   interface server : orber_parent::inherrit {
     typedef string array[2];
@@ -89,6 +89,23 @@ module orber_test {
     const fixed52 fixed52negconst2 = -123.00d;
     const fixed52 fixed52negconst3 = -023.00d;
 
+    struct rec_struct; // Forward declaration
+    typedef sequence<rec_struct> rec_struct_seq;
+    struct rec_struct {
+	rec_struct_seq chain;
+    };
+    
+    
+    union rec_union; // Forward declaration
+    typedef sequence<rec_union>rec_union_seq;
+    
+    enum MyEnum {RecursiveType, NameType};
+    
+    union rec_union switch (MyEnum) {
+    case RecursiveType : rec_union_seq chain;
+    case NameType :  string aName;
+    };
+    
     void stop_normal();
 
     void stop_brutal();
@@ -123,6 +140,12 @@ module orber_test {
     void testing_iiop_context();
     void testing_iiop_server_marshal(inout StrLength6 Str);
 
+    // Recursive types
+    any testing_iiop_rec_any(in any RecType);
+    rec_struct testing_iiop_rec_struct(in rec_struct RecS);
+    rec_union testing_iiop_rec_union(in rec_union RecU);
+
+
     oneway void testing_iiop_oneway_delay(in long Time);
     void testing_iiop_twoway_delay(in long Time);
 
diff --git a/lib/orber/test/orber_test_server_impl.erl b/lib/orber/test/orber_test_server_impl.erl
index 35296cb619..10a9caf242 100644
--- a/lib/orber/test/orber_test_server_impl.erl
+++ b/lib/orber/test/orber_test_server_impl.erl
@@ -1,7 +1,7 @@
 %%
 %% %CopyrightBegin%
 %% 
-%% Copyright Ericsson AB 1999-2009. All Rights Reserved.
+%% Copyright Ericsson AB 1999-2010. All Rights Reserved.
 %% 
 %% The contents of this file are subject to the Erlang Public License,
 %% Version 1.1, (the "License"); you may not use this file except in
@@ -55,6 +55,9 @@
 	 testing_iiop_void/2,
 	 testing_iiop_context/2,
 	 testing_iiop_server_marshal/3,
+	 testing_iiop_rec_any/3,
+	 testing_iiop_rec_struct/3,
+	 testing_iiop_rec_union/3,
 	 relay_call/3,
 	 relay_cast/3,
 	 %% Testing pseudo calls.
@@ -197,6 +200,16 @@ testing_iiop_context(_Self, State) ->
 testing_iiop_server_marshal(_Self, State, _String) ->
     {reply, {ok, false}, State}.
 
+testing_iiop_rec_any(_Self, State, RAny) ->
+    {reply, RAny, State}.
+
+testing_iiop_rec_struct(_Self, State, RecS) ->
+    {reply, RecS, State}.
+
+testing_iiop_rec_union(_Self, State, RecU) ->
+    {reply, RecU, State}.
+
+
 testing_iiop_oneway_delay(_Self, State, Time) ->
     timer:sleep(Time),
     {noreply, State}.
diff --git a/lib/orber/vsn.mk b/lib/orber/vsn.mk
index 584a52ab84..be7e3489af 100644
--- a/lib/orber/vsn.mk
+++ b/lib/orber/vsn.mk
@@ -1 +1,2 @@
-ORBER_VSN = 3.6.18
+ORBER_VSN = 3.6.19
+