CGRS.idl

Go to the documentation of this file.

#ifndef _INCLUDED_CRGS_IDL
#define _INCLUDED_CRGS_IDL
#include "xpcom.idl"

module CGRS
{
  interface GenericAttribute;
  interface GenericMethod;
  interface GenericValue;
  interface GenericInterface;
  interface StringValue;
  interface WStringValue;
  interface ShortValue;
  interface LongValue;
  interface LongLongValue;
  interface UShortValue;
  interface ULongValue;
  interface ULongLongValue;
  interface FloatValue;
  interface DoubleValue;
  interface BooleanValue;
  interface CharValue;
  interface OctetValue;
  interface SequenceValue;
  interface SequenceType;
  interface EnumValue;
  interface EnumType;
  interface ObjectValue;

  typedef sequence<GenericValue> ValueSequence;

  exception CGRSError {};
  interface GenericType;

  interface GenericsService
    : XPCOM::IObject
  {
    void loadGenericModule(in string aModulePath) raises(CGRSError);

    GenericValue getBootstrapByName(in string aBootstrapName) raises(CGRSError);

    GenericInterface getInterfaceByName(in string aInterfaceName) raises(CGRSError);

    StringValue makeString(in string val);

    WStringValue makeWString(in wstring val);

    ShortValue makeShort(in short val);

    LongValue makeLong(in long val);

    LongLongValue makeLongLong(in long long val);

    UShortValue makeUShort(in unsigned short val);

    ULongValue makeULong(in unsigned long val);

    ULongLongValue makeULongLong(in unsigned long long val);

    FloatValue makeFloat(in float val);

    DoubleValue makeDouble(in double val);

    BooleanValue makeBoolean(in boolean val);

    CharValue makeChar(in char val);

    OctetValue makeOctet(in octet val);

    SequenceValue makeSequence(in GenericType innerType);

    EnumValue makeEnumFromString(in EnumType etype,
                                 in string name);

    EnumValue makeEnumFromIndex(in EnumType etype,
                                in long index);

    GenericValue makeObject(in XPCOM::IObject value);

    GenericValue makeVoid();
  };
#pragma terminal-interface

  interface GenericInterface
    : XPCOM::IObject
  {
    readonly attribute long baseCount;

    GenericInterface getBase(in long aBaseNumber) raises(CGRSError);

    readonly attribute long attributeCount;

    GenericAttribute getAttributeByIndex(in long aAttributeNumber) raises(CGRSError);

    GenericAttribute getAttributeByName(in string aAttributeName) raises(CGRSError);

    readonly attribute long operationCount;

    GenericMethod getOperationByIndex(in long aOperationNumber) raises(CGRSError);

    GenericMethod getOperationByName(in string aOperationName) raises(CGRSError);
  };
#pragma terminal-interface

  interface GenericType
    : XPCOM::IObject
  {
    readonly attribute string asString;
  };

  interface SequenceType
    : GenericType
  {
    readonly attribute GenericType innerType;
  };
#pragma terminal-interface

  interface EnumType
    : GenericType
  {
    readonly attribute long maxIndex;

    string indexToName(in long index) raises(CGRSError);

    long nameToIndex(in string name) raises(CGRSError);
  };
#pragma terminal-interface

  interface GenericValue
    : XPCOM::IObject
  {
    readonly attribute GenericType typeOfValue;
  };

  interface StringValue
    : GenericValue
  {
    attribute string asString;
  };
#pragma terminal-interface

  interface WStringValue
    : GenericValue
  {
    attribute wstring asWString;
  };
#pragma terminal-interface

  interface ShortValue
    : GenericValue
  {
    attribute short asShort;
  };
#pragma terminal-interface

  interface LongValue
    : GenericValue
  {
    attribute long asLong;
  };
#pragma terminal-interface

  interface LongLongValue
    : GenericValue
  {
    attribute long long asLongLong;
  };
#pragma terminal-interface

  interface UShortValue
    : GenericValue
  {
    attribute unsigned short asUShort;
  };
#pragma terminal-interface

  interface ULongValue
    : GenericValue
  {
    attribute unsigned long asULong;
  };
#pragma terminal-interface

  interface ULongLongValue
    : GenericValue
  {
    attribute unsigned long long asULongLong;
  };
#pragma terminal-interface

  interface FloatValue
    : GenericValue
  {
    attribute float asFloat;
  };
#pragma terminal-interface

  interface DoubleValue
    : GenericValue
  {
    attribute double asDouble;
  };
#pragma terminal-interface

  interface BooleanValue
    : GenericValue
  {
    attribute boolean asBoolean;
  };
#pragma terminal-interface

  interface CharValue
    : GenericValue
  {
    attribute char asChar;
  };
#pragma terminal-interface

  interface OctetValue
    : GenericValue
  {
    attribute octet asOctet;
  };
#pragma terminal-interface

  interface ObjectValue
    : GenericValue
  {
    attribute XPCOM::IObject asObject;
  };
#pragma terminal-interface

  interface CallbackObjectValue
    : GenericValue
  {
    GenericValue invokeOnInterface(in string interfaceName, in string methodName,
                                   in ValueSequence inValues, out ValueSequence outValues,
                                   out boolean wasException);
  };
#pragma user-callback

  interface SequenceValue
    : GenericValue
  {
    readonly attribute long valueCount;

    GenericValue getValueByIndex(in long index) raises(CGRSError);

    void appendValue(in GenericValue v) raises(CGRSError);
  };
#pragma terminal-interface

  interface EnumValue
    : GenericValue
  {
    attribute string asString;

    attribute long asLong;
  };
#pragma terminal-interface

  interface GenericAttribute
    : XPCOM::IObject
  {
    readonly attribute boolean isReadonly;

    readonly attribute string name;

    readonly attribute GenericType type;

    readonly attribute GenericMethod getter;

    readonly attribute GenericMethod setter;
  };
#pragma terminal-interface

  interface GenericParameter
    : XPCOM::IObject
  {
    readonly attribute boolean isIn;

    readonly attribute boolean isOut;

    readonly attribute string name;

    readonly attribute GenericType type;
  };
#pragma terminal-interface

  typedef sequence<GenericParameter> ParameterSequence;

  interface GenericMethod
    : XPCOM::IObject
  {
    readonly attribute ParameterSequence parameters;

    readonly attribute GenericType returnType;

    GenericValue invoke(in ObjectValue invokeOn, in ValueSequence inValues, out ValueSequence outValues, out boolean wasException);
  };
#pragma terminal-interface
};
#endif