/*

 * Copyright (c) 1997, 2009, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

/*

 * This file contains OMG IDL from  CORBA V2.0, July 1995.

 * It also contains the TypeCode creation APIs in CORBA::ORB

 **/

#pragma prefix "omg.org"

//#pragma javaPackage org.omg

module CORBA {

    typedef string Identifier;

    typedef string ScopedName;

    typedef string RepositoryId;

    enum DefinitionKind {

	dk_none, dk_all,

	dk_Attribute, dk_Constant, dk_Exception, dk_Interface,

	dk_Module, dk_Operation, dk_Typedef,

	dk_Alias, dk_Struct, dk_Union, dk_Enum,

	dk_Primitive, dk_String, dk_Sequence, dk_Array,

	dk_Repository,

	dk_Wstring, dk_Fixed,

	dk_Value, dk_ValueBox, dk_ValueMember, // orbos 98-01-18: Objects By Value

	dk_Native

    };

    interface IRObject

    /**

      An IRObject IDL interface represents the most generic interface

      from which all other Interface Repository interfaces are derived,

      even the Repository itself.

     */

    {

	// read interface

	readonly attribute DefinitionKind def_kind;

	// write interface

	void destroy ();

    };

    typedef string VersionSpec;

    interface Contained;

    interface Repository;

    interface Container;

    interface Contained : IRObject

    /**

       The Contained Interface is inherited by all Interface Repository

       interfaces that are contained by other objects.

     */

    {

	// read/write interface

	attribute RepositoryId id;

	attribute Identifier name;

	attribute VersionSpec version;

	// read interface

	readonly attribute Container defined_in;

	readonly attribute ScopedName absolute_name;

	readonly attribute Repository containing_repository;

	struct Description {

	    DefinitionKind kind;

	    any value;

	};

	Description describe ();

	// write interface

	void move (

	    in Container new_container,

	    in Identifier new_name,

	    in VersionSpec new_version

	    );

    };

    interface ModuleDef;

    interface ConstantDef;

    interface IDLType;

    interface StructDef;

    interface UnionDef;

    interface EnumDef;

    interface AliasDef;

    interface InterfaceDef;

    interface ExceptionDef;

    interface ValueDef;		// orbos 98-01-18: Objects By Value

    interface ValueMemberDef;	// orbos 98-01-18: Objects By Value

    interface ValueBoxDef;	// orbos 98-01-18: Objects By Value

    interface NativeDef;

    typedef sequence <InterfaceDef> InterfaceDefSeq;

    typedef sequence <Contained> ContainedSeq;

    struct StructMember {

	Identifier name;

	TypeCode type;

	IDLType type_def;

    };

    typedef sequence <StructMember> StructMemberSeq;

    struct UnionMember {

	Identifier name;

	any label;

	TypeCode type;

	IDLType type_def;

    };

    typedef sequence <UnionMember> UnionMemberSeq;

    typedef sequence <Identifier> EnumMemberSeq;

    // orbos 98-01-18: Objects By Value -- begin

    typedef short Visibility;	

    const Visibility PRIVATE_MEMBER = 0; 

    const Visibility PUBLIC_MEMBER = 1;

    struct ValueMember {

        Identifier name;

	RepositoryId id;

	RepositoryId defined_in;

	VersionSpec version;

        TypeCode type;

        IDLType type_def;

        Visibility access;

    };

    typedef sequence <ValueMember> ValueMemberSeq;

    struct Initializer {

        StructMemberSeq members;

    };

    typedef sequence <Initializer> InitializerSeq;

    typedef sequence <ValueDef> ValueDefSeq;

    // orbos 98-01-18: Objects By Value -- end

    interface Container : IRObject

    /**

      The Container interface is used to form a containment hierarchy

      in the Interface Repository. A Container can contain any number

      of objects derived from the Contained interface.

    */

    {

	// read interface

	Contained lookup ( in ScopedName search_name);

	ContainedSeq contents (

	    in DefinitionKind limit_type,

	    in boolean exclude_inherited

	    );

	ContainedSeq lookup_name (

	    in Identifier search_name,

	    in long levels_to_search,

	    in DefinitionKind limit_type,

	    in boolean exclude_inherited

	    );

	struct Description {

	    Contained contained_object;

	    DefinitionKind kind;

	    any value;

	};

	typedef sequence<Description> DescriptionSeq;

	DescriptionSeq describe_contents (

	    in DefinitionKind limit_type,

	    in boolean exclude_inherited,

	    in long max_returned_objs

	    );

	// write interface

	ModuleDef create_module (

	    in RepositoryId id,

	    in Identifier name,

	    in VersionSpec version

	    );

	ConstantDef create_constant (

	    in RepositoryId id,

	    in Identifier name,

	    in VersionSpec version,

	    in IDLType type,

	    in any value

	    );

	StructDef create_struct (

	    in RepositoryId id,

	    in Identifier name,

	    in VersionSpec version,

	    in StructMemberSeq members

	    );

	UnionDef create_union (

	    in RepositoryId id,

	    in Identifier name,

	    in VersionSpec version,

	    in IDLType discriminator_type,

	    in UnionMemberSeq members

	    );

	EnumDef create_enum (

	    in RepositoryId id,

	    in Identifier name,

	    in VersionSpec version,

	    in EnumMemberSeq members

	    );

	AliasDef create_alias (

	    in RepositoryId id,

	    in Identifier name,

	    in VersionSpec version,

	    in IDLType original_type

	    );

        ExceptionDef create_exception (

            in RepositoryId    id,

            in Identifier      name,

            in VersionSpec     version,

            in StructMemberSeq members

        );

	InterfaceDef create_interface (

	    in RepositoryId id,

	    in Identifier name,

	    in VersionSpec version,

	    in boolean is_abstract,

	    in InterfaceDefSeq base_interfaces

	    );

	// orbos 98-01-18: Objects By Value

	ValueDef create_value(

	    in RepositoryId id,

	    in Identifier name,

	    in VersionSpec version,

	    in boolean is_custom,

	    in boolean is_abstract,

	    in octet flags,	// must be 0

	    in ValueDef base_value,

	    in boolean has_safe_base,

	    in ValueDefSeq abstract_base_values,

	    in InterfaceDefSeq supported_interfaces,

	    in InitializerSeq initializers

	    );

	// orbos 98-01-18: Objects By Value

	ValueBoxDef create_value_box(

	    in RepositoryId id,

	    in Identifier name,

	    in VersionSpec version,

	    in IDLType original_type_def

	    );

	NativeDef create_native(

	    in RepositoryId id,

	    in Identifier name,

	    in VersionSpec version

	    );

    };

    interface IDLType : IRObject

    /**

       The IDLType interface is an abstract interface inherited by all

       IR objects that represent the OMG IDL types. It provides access

       to the TypeCode describing the type, and is used in defining the

       other interfaces wherever definitions of IDLType must be referenced.

    */

    {

	readonly attribute TypeCode type;

    };

    interface PrimitiveDef;

    interface StringDef;

    interface SequenceDef;

    interface ArrayDef;

    enum PrimitiveKind {

	pk_null, pk_void, pk_short, pk_long, pk_ushort, pk_ulong,

	pk_float, pk_double, pk_boolean, pk_char, pk_octet,

	pk_any, pk_TypeCode, pk_Principal, pk_string, pk_objref

    };

    interface Repository : Container

    /**

      Repository is an interface that provides global access to the

      Interface Repository. Repository objects can contain constants,

      typedefs, exceptions, interfaces, and modules.

    */

    {

	// read interface

	Contained lookup_id (in RepositoryId search_id);

	PrimitiveDef get_primitive (in PrimitiveKind kind);

	// write interface

	StringDef create_string (in unsigned long bound);

	SequenceDef create_sequence (

	    in unsigned long bound,

	    in IDLType element_type

	    );

	ArrayDef create_array (

	    in unsigned long length,

	    in IDLType element_type

	    );

    };

    interface ModuleDef : Container, Contained

    /**

      A ModuleDef can contain constants, typedefs, exceptions, interfaces,

      and other module objects.

    */

    {

    };

    struct ModuleDescription {

	Identifier name;

	RepositoryId id;

	RepositoryId defined_in;

	VersionSpec version;

    };

    interface ConstantDef : Contained

    /**

      A ConstantDef object defines a named constant.

    */

    {

	readonly attribute TypeCode type;

	attribute IDLType type_def;

	attribute any value;

    };

    struct ConstantDescription {

	Identifier name;

	RepositoryId id;

	RepositoryId defined_in;

	VersionSpec version;

	TypeCode type;

	any value;

    };

    interface TypedefDef : Contained, IDLType

    /**

      TypedefDef is an abstract interface used as a base interface for

      all named non-object types(structures, unions, enumerations,

      aliases). The TypedefDef interface is not inherited by the definition

      objects for the primitive or anonymous types.

    */

    {

    };

    struct TypeDescription {

	Identifier name;

	RepositoryId id;

	RepositoryId defined_in;

	VersionSpec version;

	TypeCode type;

    };

    interface StructDef : TypedefDef, Container

    /**

       A StructDef represents an OMG IDL structure definition.

    */

    {

	attribute StructMemberSeq members;

    };

    interface UnionDef : TypedefDef, Container

    /**

       A UnionDef represents an OMG IDL union definition.

     */

    {

	readonly attribute TypeCode discriminator_type;

	attribute IDLType discriminator_type_def;

	attribute UnionMemberSeq members;

    };

    interface EnumDef : TypedefDef

    /**

      A EnumDef represents an OMG IDL enum definition.

     */

    {

	attribute EnumMemberSeq members;

    };

    interface AliasDef : TypedefDef

    /**

       An AliasDef represents an OMG IDL typedef that aliases other

       definition.

    */

    {

	attribute IDLType original_type_def;

    };

    interface PrimitiveDef: IDLType

    /**

      A PrimitiveDef represents one of the IDL primitive types. As

      primitive types are unnamed, this interface is not derived from

      TypedefDef or Contained.

     */

    {

	readonly attribute PrimitiveKind kind;

    };

    interface StringDef : IDLType

    /**

      A StringDef represents an OMG IDL string type. As string

      types are anonymous, this interface is not derived from TypedefDef

      or Contained.

    */

    {

	attribute unsigned long bound;

    };

    interface SequenceDef : IDLType

    /**

      A SequenceDef represents an OMG IDL sequence type. As sequence

      types are anonymous, this interface is not derived from TypedefDef

      or Contained.

     */

    {

	attribute unsigned long bound;

	readonly attribute TypeCode element_type;

	attribute IDLType element_type_def;

    };

    interface ArrayDef : IDLType

    /**

      An ArrayDef represents an OMG IDL array type. As array

      types are anonymous, this interface is not derived from TypedefDef

      or Contained.

    */

    {

	attribute unsigned long length;

	readonly attribute TypeCode element_type;

	attribute IDLType element_type_def;

    };

    interface ExceptionDef : Contained, Container

    /**

      An ExceptionDef represents an exception definition.

    */

    {

	readonly attribute TypeCode type;

	attribute StructMemberSeq members;

    };

    struct ExceptionDescription {

	Identifier name;

	RepositoryId id;

	RepositoryId defined_in;

	VersionSpec version;

	TypeCode type;

    };

    enum AttributeMode {ATTR_NORMAL, ATTR_READONLY};

    interface AttributeDef : Contained

    /**

      An AttributeDef represents the information that defines an

      attribute of an interface.

    */

    {

	readonly attribute TypeCode type;

	attribute IDLType type_def;

	attribute AttributeMode mode;

    };