From 84adefa331c4159d432d22840663c38f155cd4c1 Mon Sep 17 00:00:00 2001 From: Erlang/OTP Date: Fri, 20 Nov 2009 14:54:40 +0000 Subject: The R13B03 release. --- lib/orber/doc/src/orber_tc.xml | 258 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 258 insertions(+) create mode 100644 lib/orber/doc/src/orber_tc.xml (limited to 'lib/orber/doc/src/orber_tc.xml') diff --git a/lib/orber/doc/src/orber_tc.xml b/lib/orber/doc/src/orber_tc.xml new file mode 100644 index 0000000000..5d7f6368dd --- /dev/null +++ b/lib/orber/doc/src/orber_tc.xml @@ -0,0 +1,258 @@ + + + + +
+ + 1998 + 2007 + Ericsson AB, 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 + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + The Initial Developer of the Original Code is Ericsson AB. + + + orber_tc + Lars Thorsén + Lars Thorsén + + Lars Thorsén + + 1998-04-20 + A +
+ orber_tc + Help functions for IDL typecodes + +

This module contains some functions that gives support in creating + IDL typecodes that can be used in for example the any types typecode field. + For the simple types it is meaningless to use this API but the functions exist + to get the interface complete.

+

The type TC used below describes an IDL type and is a tuple according + to the to the Erlang language mapping.

+ + + + null() -> TC + void() -> TC + short() -> TC + unsigned_short() -> TC + long() -> TC + unsigned_long() -> TC + long_long() -> TC + unsigned_long_long() -> TC + wchar() -> TC + float() -> TC + double() -> TC + boolean() -> TC + char() -> TC + octet() -> TC + any() -> TC + typecode() -> TC + principal() -> TC + Return the IDL typecode + +

These functions return the IDL typecodes for simple types.

+ + + + object_reference(Id, Name) -> TC + Return the object_reference IDL typecode + + Id = string() + the repository ID + Name = string() + the type name of the object + + +

Function returns the IDL typecode for object_reference.

+ + + + struct(Id, Name, ElementList) -> TC + Return the struct IDL typecode + + Id = string() + the repository ID + Name = string() + the type name of the struct + ElementList = [{MemberName, TC}] + a list of the struct elements + MemberName = string() + the element name + + +

Function returns the IDL typecode for struct.

+ + + + union(Id, Name, DiscrTC, Default, ElementList) -> TC + Return the union IDL typecode + + Id = string() + the repository ID + Name = string() + the type name of the union + DiscrTC = TC + the typecode for the unions discriminant + Default = integer() + a value that indicates which tuple in the element list that is default (value < 0 means no default) + ElementList = [{Label, MemberName, TC}] + a list of the union elements + Label = term() + the label value should be of the DiscrTCtype + MemberName = string() + the element name + + +

Function returns the IDL typecode for union.

+ + + + enum(Id, Name, ElementList) -> TC + Return the enum IDL typecode + + Id = string() + the repository ID + Name = string() + the type name of the enum + ElementList = [MemberName] + a list of the enums elements + MemberName = string() + the element name + + +

Function returns the IDL typecode for enum.

+ + + + string(Length) -> TC + Return the string IDL typecode + + Length = integer() + the length of the string (0 means unbounded) + + +

Function returns the IDL typecode for string.

+ + + + wstring(Length) -> TC + Return the wstring IDL typecode + + Length = integer() + the length of the wstring (0 means unbounded) + + +

Function returns the IDL typecode for wstring.

+ + + + fixed(Digits, Scale) -> TC + Return the fixed IDL typecode + + Digits = Scale = integer() + the digits and scale parameters of a Fixed type + + +

Function returns the IDL typecode for fixed.

+ + + + sequence(ElemTC, Length) -> TC + Return the sequence IDL typecode + + ElemTC = TC + the typecode for the sequence elements + Length = integer() + the length of the sequence (0 means unbounded) + + +

Function returns the IDL typecode for sequence.

+ + + + array(ElemTC, Length) -> TC + Return the array IDL typecode + + ElemTC = TC + the typecode for the array elements + Length = integer() + the length of the array + + +

Function returns the IDL typecode for array.

+ + + + alias(Id, Name, AliasTC) -> TC + Return the alias IDL typecode + + Id = string() + the repository ID + Name = string() + the type name of the alias + AliasTC = TC + the typecode for the type which the alias refer to + + +

Function returns the IDL typecode for alias.

+ + + + exception(Id, Name, ElementList) -> TC + Return the exception IDL typecode + + Id = string() + the repository ID + Name = string() + the type name of the exception + ElementList = [{MemberName, TC}] + a list of the exception elements + MemberName = string() + the element name + + +

Function returns the IDL typecode for exception.

+ + + + get_tc(Object) -> TC + get_tc(Id) -> TC + Fetch typecode + + Object = record() + an IDL specified struct, union or exception + Id = string() + the repository ID + + +

If the get_tc/1 gets a record that is and IDL specified + struct, union or exception as a parameter it returns the + typecode.

+

If the parameter is a repository ID it uses the Interface Repository + to get the typecode.

+ + + + check_tc(TC) -> boolean() + Check syntax of an IDL typecode + +

Function checks the syntax of an IDL typecode.

+ + + + + + -- cgit v1.2.3