diff options
author | Ian Campbell <ian.campbell@citrix.com> | 2012-01-31 16:34:38 +0000 |
---|---|---|
committer | Ian Campbell <ian.campbell@citrix.com> | 2012-01-31 16:34:38 +0000 |
commit | a6beb5286e7ca1d478ef391396be49b4f6d2ca35 (patch) | |
tree | e649090f00988dde2ca2b569980a1b8f5f330131 /tools/libxl/idl.txt | |
parent | 15873321439d3588e0276c7cfddb0a11f71c897d (diff) | |
download | xen-a6beb5286e7ca1d478ef391396be49b4f6d2ca35.tar.gz xen-a6beb5286e7ca1d478ef391396be49b4f6d2ca35.tar.bz2 xen-a6beb5286e7ca1d478ef391396be49b4f6d2ca35.zip |
libxl: Rename libxl IDL infrastructure.
Originally libxltypes.py provided the infrastructure and libxl.idl provided the
specific types.
In 23887:a543e10211f7 libxl.idl became libxl_types.idl (to allow for
libxl_types_internal.idl) which means we now have libxl_types.FOO and
libxltypes.FOO providing different things and annoying people in tab
completion.
Rename the infrastructure as idl.
Signed-off-by: Ian Campbell <ian.campbell@citrix.com>
Acked-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
Committed-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
Diffstat (limited to 'tools/libxl/idl.txt')
-rw-r--r-- | tools/libxl/idl.txt | 50 |
1 files changed, 25 insertions, 25 deletions
diff --git a/tools/libxl/idl.txt b/tools/libxl/idl.txt index 6f2d05bf26..adf872d6be 100644 --- a/tools/libxl/idl.txt +++ b/tools/libxl/idl.txt @@ -1,10 +1,10 @@ -libxltypes IDL --------------- +libxl IDL +--------- Each type in the libxl interface is represented by an object of type -libxltypes.Type (or a subclass thereof). Every local variable defined -by the .idl file must be an instance of libxltypes.Type (e.g. you may -not define Python functions or any other construct other than defining +idl.Type (or a subclass thereof). Every local variable defined by +the .idl file must be an instance of idl.Type (e.g. you may not +define Python functions or any other construct other than defining variables) The name of the type must be passed as the first argument to the @@ -16,9 +16,9 @@ The Type.typename contains the C name of the type _including_ the namespace element while Type.rawname is always set to the 'base' name of the type. -The libxltypes.Type base class has several other properties which -apply to all types. The properties are set by passing a named -parameter to the constructor. +The idl.Type base class has several other properties which apply +to all types. The properties are set by passing a named parameter to +the constructor. Type.namespace: (default: "libxl_") @@ -28,12 +28,12 @@ Type.namespace: (default: "libxl_") If the typename is not None then the namespace is prepended to the type. -Type.passby: (default: libxltypes.PASS_BY_VALUE) +Type.passby: (default: idl.PASS_BY_VALUE) Defines the manner in which a type should be passed to C functions. Valid values for this fields are: - libxltypes.PASS_BY_VALUE - libxltypes.PASS_BY_REFERENCE + idl.PASS_BY_VALUE + idl.PASS_BY_REFERENCE Type.dispose_fn: (default: typename + "_dispose" or None if type == None) @@ -57,12 +57,12 @@ Type.autogenerate_json: (default: True) Other simple type-Classes ------------------------- -libxltype.Builtin +idl.Builtin Instances of this class represent types which are predefined within the system. -libxltype.UInt +idl.UInt Instances of this class represent the standard uint<N>_t types. @@ -72,12 +72,12 @@ libxltype.UInt Complex type-Classes -------------------- -libxltype.Enumeration +idl.Enumeration A class representing an enumeration (named integer values). The values are available in the list Enumeration.values. Each - element in the list is of type libxltype.EnumerationValue. + element in the list is of type idl.EnumerationValue. Each EnumerationValue has the following properties: @@ -95,37 +95,37 @@ libxltype.Enumeration and any namespace (e.g. "VALUE") EnumerationValue.value The integer value associated with this name. -libxltype.Aggregate +idl.Aggregate Base class for type-Classes which contain a number of other types (e.g. structs and unions). The contained types are available in the list Aggregate.fields. Each - element in the list is of type libxltype.Field representing a member - of the aggregate. + element in the list is of type idl.Field representing a member of the + aggregate. Each field has the following properties: - Field.type The type of the member (a libxltypes.Type). + Field.type The type of the member (a idl.Type). Field.name The name of the member (can be None for anonymous fields). Field.const Boolean, true if the member is const. -libxltype.Struct +idl.Struct - A subclass of libxltype.Aggregate representing the C struct type. + A subclass of idl.Aggregate representing the C struct type. Struct.kind == "struct" -libxltype.Union +idl.Union - A subclass of libxltype.Aggregate representing the C union type. + A subclass of idl.Aggregate representing the C union type. Union.kind == "union" -libxltype.KeyedUnion +idl.KeyedUnion - A subclass of libxltype.Aggregate which represents the C union type + A subclass of idl.Aggregate which represents the C union type where the currently valid member of the union can be determined based upon another member in the containing type. |