// Taken from formal/01-11-01.txt
//CORBA 2.5 - OMG IDL Summary File
//Object Management Group, Inc.

// Superceded enumerations have been ifdefed out, since they
// usually conflict with the current definition. Superceded
// structures remain, to allow support for older GIOP versions.

#pragma prefix "omg.org"

module CORBA {
	typedef sequence<octet> OctetSeq;
	typedef TypeCode TypeCode;
};

module IOP{

	// Standard Protocol Profile tag values 
	typedef unsigned long	ProfileId;
	const ProfileId		TAG_INTERNET_IOP = 0;
	const ProfileId		TAG_MULTIPLE_COMPONENTS = 1;

	struct TaggedProfile {
		ProfileId		tag;
		sequence <octet>	profile_data;
	};
	// an Interoperable Object Reference is a sequence of
	// object-specific protocol profiles, plus a type ID.
	struct IOR {
		string				type_id;
		sequence <TaggedProfile>	profiles;
	};
	// Standard way of representing multicomponent profiles.
	// This would be encapsulated in a TaggedProfile.
	typedef unsigned long ComponentId;
	struct TaggedComponent {
		ComponentId		tag;
		sequence <octet>	component_data;
	};
	typedef sequence <TaggedComponent> 	MultipleComponentProfile;

	const ComponentId	TAG_ORB_TYPE = 0;
	const ComponentId	TAG_CODE_SETS = 1;
	const ComponentId	TAG_POLICIES = 2;	
	const ComponentId	TAG_ALTERNATE_IIOP_ADDRESS = 3;
	const ComponentId	TAG_ASSOCIATION_OPTIONS = 13;
	const ComponentId	TAG_SEC_NAME = 14;
	const ComponentId	TAG_SPKM_1_SEC_MECH = 15;
	const ComponentId	TAG_SPKM_2_SEC_MECH = 16;
	const ComponentId	TAG_KerberosV5_SEC_MECH = 17;
	const ComponentId	TAG_CSI_ECMA_Secret_SEC_MECH = 18;
	const ComponentId	TAG_CSI_ECMA_Hybrid_SEC_MECH = 19;
	const ComponentId	TAG_SSL_SEC_TRANS = 20;
	const ComponentId	TAG_CSI_ECMA_Public_SEC_MECH = 21;
	const ComponentId	TAG_GENERIC_SEC_MECH = 22;
	const ComponentId	TAG_JAVA_CODEBASE = 25;

	const ComponentId 	TAG_COMPLETE_OBJECT_KEY = 5;
	const ComponentId	TAG_ENDPOINT_ID_POSITION = 6;
	const ComponentId	TAG_LOCATION_POLICY = 12;
	const ComponentId	TAG_DCE_STRING_BINDING = 100;
	const ComponentId	TAG_DCE_BINDING_NAME = 101;
	const ComponentId	TAG_DCE_NO_PIPES = 102;
	const ComponentId	TAG_DCE_SEC_MECH = 103; // Security Service

	typedef unsigned long		ServiceId;
	struct ServiceContext {
		ServiceId		context_id;
		sequence <octet>	context_data;
	};
	typedef sequence <ServiceContext>	ServiceContextList;
	const ServiceId		TransactionService = 0;
	const ServiceId		CodeSets = 1;
	const ServiceId		ChainBypassCheck = 2;
	const ServiceId		ChainBypassInfo = 3;
	const ServiceId		LogicalThreadId = 4;
	const ServiceId		BI_DIR_IIOP = 5;
	const ServiceId		SendingContextRunTime = 6;
	const ServiceId		INVOCATION_POLICIES = 7;
	const ServiceId		FORWARDED_IDENTITY = 8;
	const ServiceId		UnknownExceptionInfo = 9;

#if 0
	//XXX: adding it here leads to cyclic imports
	//since it inherits from Fnorb.orb.CORBA.Object
	//XXX: local 
	interface Codec {
		exception InvalidTypeForEncoding {};
		exception FormatMismatch {};
		exception TypeMismatch {};
		CORBA::OctetSeq encode (in any data) 
			raises (InvalidTypeForEncoding);
		any decode (in CORBA::OctetSeq data)
			raises (FormatMismatch);
		CORBA::OctetSeq encode_value (in any data)
			raises (InvalidTypeForEncoding);
		any decode_value (
			in CORBA::OctetSeq data, 
			in CORBA::TypeCode tc)
			raises (FormatMismatch, TypeMismatch);
	};

	typedef short EncodingFormat;
	const EncodingFormat ENCODING_CDR_ENCAPS = 0;
	struct Encoding {
		EncodingFormat format;
		octet major_version;
		octet minor_version;
	};
	//XXX: local 
	interface CodecFactory {
		exception UnknownEncoding {};
		Codec create_codec (in Encoding enc) 
			raises (UnknownEncoding);
	};
#endif
};

module CONV_FRAME {							// IDL
	typedef unsigned long CodeSetId;
		struct CodeSetComponent {
			CodeSetId	native_code_set;
			sequence<CodeSetId>	conversion_code_sets;
		};
	struct CodeSetComponentInfo {

		CodeSetComponent 	ForCharData;
		CodeSetComponent 	ForWcharData;
	};
};


module GIOP { // IDL extended for version 1.1 and 1.2
	struct Version {
		octet			major;
		octet			minor;
	};

#ifdef GIOP_1_1

	// GIOP 1.1
	enum MsgType_1_1 { 
	 	Request, Reply, CancelRequest,
		LocateRequest, LocateReply,
		CloseConnection, MessageError,
		Fragment	 // GIOP 1.1 addition
	};

#else

	// GIOP 1.0 
	enum MsgType_1_0 { // Renamed from MsgType
	 	Request, Reply, CancelRequest,
		LocateRequest, LocateReply,
		CloseConnection, MessageError
	};

#endif // GIOP_1_1

	// GIOP 1.0
	struct MessageHeader_1_0 { // Renamed from MessageHeader
 		char			magic [4];
		Version			GIOP_version;
 		boolean			byte_order;		 	
		octet			message_type;
 		unsigned long		message_size;
	};
	// GIOP 1.1
	struct MessageHeader_1_1 {
 		char		magic [4];
		Version		GIOP_version;
		octet		flags;	// GIOP 1.1 change
 		octet		message_type;
 		unsigned long	message_size;
	};				
	// GIOP 1.2
	typedef MessageHeader_1_1 MessageHeader_1_2;

	// GIOP 1.0
	struct RequestHeader_1_0 { // Renamed from RequestHeader
		IOP::ServiceContextList		service_context;
		unsigned long			request_id;
		boolean				response_expected;
		sequence <octet>		object_key;
		string				operation;
		Principal			requesting_principal;
	};
	// GIOP 1.1
	struct RequestHeader_1_1 {
		IOP::ServiceContextList		service_context;
		unsigned long			request_id;
		boolean				response_expected;
	 	octet 				reserved[3]; // Added in GIOP 1.1
		sequence <octet>		object_key;
		string				operation;
		Principal			requesting_principal;
	};

	// GIOP 1.2
	typedef short	AddressingDisposition;
	const short	KeyAddr = 0;
	const short	ProfileAddr = 1;
	const short	ReferenceAddr = 2;
	struct IORAddressingInfo {
		unsigned long	selected_profile_index;
		IOP::IOR	ior;
	};

	union TargetAddress switch (AddressingDisposition) {
		case KeyAddr:		sequence <octet> object_key;
		case ProfileAddr:	IOP::TaggedProfile profile;
		case ReferenceAddr:	IORAddressingInfo ior;
	};

	struct RequestHeader_1_2 {
		unsigned long		request_id;
		octet			response_flags;
		octet			reserved[3];
		TargetAddress		target;
		string				operation;
		IOP::ServiceContextList		service_context;
		// Principal not in GIOP 1.2
	};


#ifdef GIOP_1_0
	// GIOP 1.0 and 1.1
	enum ReplyStatusType_1_0 { // Renamed from ReplyStatusType
		NO_EXCEPTION,
		USER_EXCEPTION,
		SYSTEM_EXCEPTION,
		LOCATION_FORWARD
	};
#endif
	// GIOP 1.2
	enum ReplyStatusType_1_2 {
		NO_EXCEPTION,
		USER_EXCEPTION,
		SYSTEM_EXCEPTION,
		LOCATION_FORWARD,
		LOCATION_FORWARD_PERM,	// new value for 1.2
		NEEDS_ADDRESSING_MODE	// new value for 1.2
	};
	typedef ReplyStatusType_1_2 ReplyStatusType;

	// GIOP 1.0
	struct ReplyHeader_1_0 { // Renamed from ReplyHeader
		IOP::ServiceContextList	service_context;
		unsigned long 		request_id;
		ReplyStatusType		reply_status;
	};
	// GIOP 1.1
	typedef ReplyHeader_1_0 ReplyHeader_1_1;
	// Same Header contents for 1.0 and 1.1


	struct ReplyHeader_1_2 {
		unsigned long		request_id;
		ReplyStatusType_1_2	reply_status;
		IOP::ServiceContextList	service_context;
	};

	struct SystemExceptionReplyBody {
		string 		exception_id;
		unsigned long 	minor_code_value;
		unsigned long 	completion_status;
	};

	struct CancelRequestHeader {
		unsigned long	request_id;
	};

	// GIOP 1.0
	struct LocateRequestHeader_1_0 {
		// Renamed LocationRequestHeader
		unsigned long		request_id;
		sequence <octet>	object_key;
	};
	// GIOP 1.1
	 typedef LocateRequestHeader_1_0 LocateRequestHeader_1_1;
	// Same Header contents for 1.0 and 1.1
	// GIOP 1.2
	struct LocateRequestHeader_1_2 {
		unsigned long				request_id;
		TargetAddress				target;
	};

#ifdef GIOP_1_0
	// GIOP 1.0 and 1.1
	enum LocateStatusType_1_0 {// Renamed from LocateStatusType
		UNKNOWN_OBJECT,
		OBJECT_HERE,
		OBJECT_FORWARD
	};
#endif
	// GIOP 1.2
	enum LocateStatusType_1_2 {
		UNKNOWN_OBJECT,
		OBJECT_HERE,
		OBJECT_FORWARD,
		OBJECT_FORWARD_PERM,		// new value for GIOP 1.2
		LOC_SYSTEM_EXCEPTION,		// new value for GIOP 1.2
		LOC_NEEDS_ADDRESSING_MODE	// new value for GIOP 1.2
	};
	typedef LocateStatusType_1_2 LocateStatusType;

	// GIOP 1.0
	struct LocateReplyHeader_1_0 {// Renamed from LocateReplyHeader
		unsigned long		request_id;
		LocateStatusType	locate_status;
	};
	// GIOP 1.1
	typedef LocateReplyHeader_1_0 LocateReplyHeader_1_1;
	// same Header contents for 1.0 and 1.1

	struct LocateReplyHeader_1_2 {
		unsigned long		request_id;
		LocateStatusType_1_2	locate_status;
	};

	// GIOP 1.2
	struct FragmentHeader_1_2 {
		unsigned long request_id;
	};
};

module IIOP {				// IDL extended for version 1.1 and 1.2
	struct Version {
		octet	major;
		octet	minor;
	};
	struct ProfileBody_1_0 {// renamed from ProfileBody
		Version			iiop_version;
		string			host;
		unsigned short		port;
		sequence <octet>	object_key;
	};
	struct ProfileBody_1_1 {// also used for 1.2
		Version			iiop_version;
		string			host;
		unsigned short		port;
		sequence <octet>	object_key;
		// Added in 1.1 unchanged for 1.2
	 	sequence <IOP::TaggedComponent> components; 
	};
					
	struct ListenPoint {
		string		host;
		unsigned short	 port;
	};
	typedef sequence<ListenPoint> ListenPointList;
	struct BiDirIIOPServiceContext {
		ListenPointList listen_points;
	};
};

#if 0
// XXX: notyet, CORBA::PolicyType
// Self contained module for Bi-directional GIOP policy
module BiDirPolicy {
	typedef unsigned short BidirectionalPolicyValue;
	const BidirectionalPolicyValue NORMAL = 0;
	const BidirectionalPolicyValue BOTH = 1;
	const CORBA::PolicyType BIDIRECTIONAL_POLICY_TYPE = 37;
	interface BidirectionalPolicy : CORBA::Policy {
		readonly attribute BidirectionalPolicyValue value;
	};
};
#endif