Enumerations

Enums
enum	idl_result_t {   IDL_RESULT_SUCCESS = 0 ,   IDL_RESULT_ERROR_UNKNOWN = 1 ,   IDL_RESULT_ERROR_OUT_OF_MEMORY = 2 ,   IDL_RESULT_ERROR_INVALID_ARG = 3 ,   IDL_RESULT_ERROR_FILE_CREATE = 4 ,   IDL_RESULT_ERROR_COMPILATION = 5 ,   IDL_RESULT_ERROR_NOT_SUPPORTED = 6 ,   IDL_RESULT_MAX_ENUM = 0x7FFFFFFF }
	Result codes. More...
enum	idl_status_t {   IDL_STATUS_W1001 = 1001 ,   IDL_STATUS_W1002 = 1002 ,   IDL_STATUS_E2001 = 2001 ,   IDL_STATUS_E2002 = 2002 ,   IDL_STATUS_E2003 = 2003 ,   IDL_STATUS_E2004 = 2004 ,   IDL_STATUS_E2005 = 2005 ,   IDL_STATUS_E2006 = 2006 ,   IDL_STATUS_E2007 = 2007 ,   IDL_STATUS_E2008 = 2008 ,   IDL_STATUS_E2009 = 2009 ,   IDL_STATUS_E2010 = 2010 ,   IDL_STATUS_E2011 = 2011 ,   IDL_STATUS_E2012 = 2012 ,   IDL_STATUS_E2013 = 2013 ,   IDL_STATUS_E2014 = 2014 ,   IDL_STATUS_E2015 = 2015 ,   IDL_STATUS_E2016 = 2016 ,   IDL_STATUS_E2017 = 2017 ,   IDL_STATUS_E2018 = 2018 ,   IDL_STATUS_E2019 = 2019 ,   IDL_STATUS_E2020 = 2020 ,   IDL_STATUS_E2021 = 2021 ,   IDL_STATUS_E2022 = 2022 ,   IDL_STATUS_E2023 = 2023 ,   IDL_STATUS_E2024 = 2024 ,   IDL_STATUS_E2025 = 2025 ,   IDL_STATUS_E2026 = 2026 ,   IDL_STATUS_E2027 = 2027 ,   IDL_STATUS_E2028 = 2028 ,   IDL_STATUS_E2029 = 2029 ,   IDL_STATUS_E2030 = 2030 ,   IDL_STATUS_E2031 = 2031 ,   IDL_STATUS_E2032 = 2032 ,   IDL_STATUS_E2033 = 2033 ,   IDL_STATUS_E2034 = 2034 ,   IDL_STATUS_E2035 = 2035 ,   IDL_STATUS_E2036 = 2036 ,   IDL_STATUS_E2037 = 2037 ,   IDL_STATUS_E2038 = 2038 ,   IDL_STATUS_E2039 = 2039 ,   IDL_STATUS_E2040 = 2040 ,   IDL_STATUS_E2041 = 2041 ,   IDL_STATUS_E2042 = 2042 ,   IDL_STATUS_E2043 = 2043 ,   IDL_STATUS_E2044 = 2044 ,   IDL_STATUS_E2045 = 2045 ,   IDL_STATUS_E2046 = 2046 ,   IDL_STATUS_E2047 = 2047 ,   IDL_STATUS_E2048 = 2048 ,   IDL_STATUS_E2049 = 2049 ,   IDL_STATUS_E2050 = 2050 ,   IDL_STATUS_E2051 = 2051 ,   IDL_STATUS_E2052 = 2052 ,   IDL_STATUS_E2053 = 2053 ,   IDL_STATUS_E2054 = 2054 ,   IDL_STATUS_E2055 = 2055 ,   IDL_STATUS_E2056 = 2056 ,   IDL_STATUS_E2057 = 2057 ,   IDL_STATUS_E2058 = 2058 ,   IDL_STATUS_E2059 = 2059 ,   IDL_STATUS_E2060 = 2060 ,   IDL_STATUS_E2061 = 2061 ,   IDL_STATUS_E2062 = 2062 ,   IDL_STATUS_E2063 = 2063 ,   IDL_STATUS_E2064 = 2064 ,   IDL_STATUS_E2065 = 2065 ,   IDL_STATUS_E2066 = 2066 ,   IDL_STATUS_E2067 = 2067 ,   IDL_STATUS_E2068 = 2068 ,   IDL_STATUS_E2069 = 2069 ,   IDL_STATUS_E2070 = 2070 ,   IDL_STATUS_E2071 = 2071 ,   IDL_STATUS_E2072 = 2072 ,   IDL_STATUS_E2073 = 2073 ,   IDL_STATUS_E2074 = 2074 ,   IDL_STATUS_E2075 = 2075 ,   IDL_STATUS_E2076 = 2076 ,   IDL_STATUS_E2077 = 2077 ,   IDL_STATUS_E2078 = 2078 ,   IDL_STATUS_E2079 = 2079 ,   IDL_STATUS_E2080 = 2080 ,   IDL_STATUS_E2081 = 2081 ,   IDL_STATUS_E2082 = 2082 ,   IDL_STATUS_E2083 = 2083 ,   IDL_STATUS_E2084 = 2084 ,   IDL_STATUS_E2085 = 2085 ,   IDL_STATUS_E2086 = 2086 ,   IDL_STATUS_E2087 = 2087 ,   IDL_STATUS_E2088 = 2088 ,   IDL_STATUS_E2089 = 2089 ,   IDL_STATUS_E2090 = 2090 ,   IDL_STATUS_E2091 = 2091 ,   IDL_STATUS_E2092 = 2092 ,   IDL_STATUS_E2093 = 2093 ,   IDL_STATUS_E2094 = 2094 ,   IDL_STATUS_E2095 = 2095 ,   IDL_STATUS_E2096 = 2096 ,   IDL_STATUS_E2097 = 2097 ,   IDL_STATUS_E2098 = 2098 ,   IDL_STATUS_E2099 = 2099 ,   IDL_STATUS_E2100 = 2100 ,   IDL_STATUS_E2101 = 2101 ,   IDL_STATUS_E2102 = 2102 ,   IDL_STATUS_E2103 = 2103 ,   IDL_STATUS_E2104 = 2104 ,   IDL_STATUS_E2105 = 2105 ,   IDL_STATUS_E2106 = 2106 ,   IDL_STATUS_E2107 = 2107 ,   IDL_STATUS_E2108 = 2108 ,   IDL_STATUS_E2109 = 2109 ,   IDL_STATUS_E2110 = 2110 ,   IDL_STATUS_E2111 = 2111 ,   IDL_STATUS_E2112 = 2112 ,   IDL_STATUS_E2113 = 2113 ,   IDL_STATUS_E2114 = 2114 ,   IDL_STATUS_E2115 = 2115 ,   IDL_STATUS_E2116 = 2116 ,   IDL_STATUS_E2117 = 2117 ,   IDL_STATUS_E2118 = 2118 ,   IDL_STATUS_E2119 = 2119 ,   IDL_STATUS_E2120 = 2120 ,   IDL_STATUS_E2121 = 2121 ,   IDL_STATUS_E2122 = 2122 ,   IDL_STATUS_E2123 = 2123 ,   IDL_STATUS_E2124 = 2124 ,   IDL_STATUS_E2125 = 2125 ,   IDL_STATUS_E2126 = 2126 ,   IDL_STATUS_E2127 = 2127 ,   IDL_STATUS_MAX_ENUM = 0x7FFFFFFF }
	Compilation statuses. More...
enum	idl_generator_t {   IDL_GENERATOR_C = 0 ,   IDL_GENERATOR_JAVA_SCRIPT = 3 ,   IDL_GENERATOR_MAX_ENUM = 0x7FFFFFFF }
	Generation language. More...

Enumeration Type Documentation

idl_generator_t

enum idl_generator_t

Generation language.

Note

Enumeration possible languages for generating interfaces and wrapping C libraries for other languages.

Enumerator
IDL_GENERATOR_C	C generator.
IDL_GENERATOR_JAVA_SCRIPT	JavaScript generator (generates Embind bindings)
IDL_GENERATOR_MAX_ENUM	Max value of enum (not used)

idl_result_t

enum idl_result_t

Result codes.

Enumeration of result codes.

Enumerator
IDL_RESULT_SUCCESS	Indicates success (this is not an error).
IDL_RESULT_ERROR_UNKNOWN	Unknown error.
IDL_RESULT_ERROR_OUT_OF_MEMORY	Out of memory.
IDL_RESULT_ERROR_INVALID_ARG	Invalid argument.
IDL_RESULT_ERROR_FILE_CREATE	Failed to create file.
IDL_RESULT_ERROR_COMPILATION	Compilation failed.
IDL_RESULT_ERROR_NOT_SUPPORTED	Not supporeted.
IDL_RESULT_MAX_ENUM	Max value of enum (not used)

idl_status_t

enum idl_status_t

Compilation statuses.

This enumeration contains warnings and errors that may occur during compilation.

Enumerator
IDL_STATUS_W1001	Missing 'author' attribute.
IDL_STATUS_W1002	Missing 'copyright' attribute.
IDL_STATUS_E2001	Unexpected character.
IDL_STATUS_E2002	Tabs are not allowed.
IDL_STATUS_E2003	The name or type must start with a capital letter.
IDL_STATUS_E2004	There can only be one api declaration.
IDL_STATUS_E2005	There is no documentation in the declaration.
IDL_STATUS_E2006	Documentation cannot be an empty string.
IDL_STATUS_E2007	The brief should only be listed once in the documentation.
IDL_STATUS_E2008	The detail should only be listed once in the documentation.
IDL_STATUS_E2009	The copyright should only be listed once in the documentation.
IDL_STATUS_E2010	The license should only be listed once in the documentation.
IDL_STATUS_E2011	Unknown error.
IDL_STATUS_E2012	The .idl file must start with the 'api' element.
IDL_STATUS_E2013	Attribute cannot be duplicated.
IDL_STATUS_E2014	The attribute is not valid in the context of use.
IDL_STATUS_E2015	Unknown attribute.
IDL_STATUS_E2016	Attribute must specify at least one argument.
IDL_STATUS_E2017	Argument in attribute 'platform' is not allowed.
IDL_STATUS_E2018	Argument in attribute 'platform' cannot be duplicated.
IDL_STATUS_E2019	Inline documentation only [detail] description is allowed.
IDL_STATUS_E2020	Invalid attribute in documentation.
IDL_STATUS_E2021	It is acceptable to use either documentation or inline documentation, but not both.
IDL_STATUS_E2022	Constants can only be added to an enumeration type.
IDL_STATUS_E2023	The 'value' attribute must specify the value in the argument.
IDL_STATUS_E2024	The 'value' attribute must contain only one value.
IDL_STATUS_E2025	The 'value' attribute must specify an integer.
IDL_STATUS_E2026	An enumeration must contain at least one constant.
IDL_STATUS_E2027	Fields can only be added to a structured type.
IDL_STATUS_E2028	The 'type' attribute must specify the type in the argument.
IDL_STATUS_E2029	The 'type' attribute must contain only one type.
IDL_STATUS_E2030	Symbol redefinition.
IDL_STATUS_E2031	Enumeration constants can only be specified as integers or enum consts.
IDL_STATUS_E2032	Symbol definition not found.
IDL_STATUS_E2033	A constant cannot refer to itself when evaluated.
IDL_STATUS_E2034	Constants can only refer to other constants when evaluated.
IDL_STATUS_E2035	Declaration is not a type.
IDL_STATUS_E2036	Enumeration constant can only be of type 'Int32'.
IDL_STATUS_E2037	Identifiers are case sensitive.
IDL_STATUS_E2038	Constant cannot go beyond the range of 'Int32' [-2147483648, 2147483647].
IDL_STATUS_E2039	Constant was duplicated.
IDL_STATUS_E2040	Cyclic dependence of constant.
IDL_STATUS_E2041	Could not find file for import.
IDL_STATUS_E2042	Failed to open file.
IDL_STATUS_E2043	Methods can only be added to a interface type.
IDL_STATUS_E2044	Arguments can only be added to a method, function or callback.
IDL_STATUS_E2045	Out of memory.
IDL_STATUS_E2046	Static method cannot include argument' with attribute 'this'.
IDL_STATUS_E2047	Constructor cannot include argument with attribute 'this'.
IDL_STATUS_E2048	Method must include one argument with the 'this' attribute.
IDL_STATUS_E2049	The 'get' attribute must specify a reference to the method in the argument.
IDL_STATUS_E2050	The 'set' attribute must specify a reference to the method in the argument.
IDL_STATUS_E2051	Argument of method cannot be of type 'Void'.
IDL_STATUS_E2052	The property must contain at least the 'get' attribute or the 'set' attribute or both.
IDL_STATUS_E2053	Getter must be a method.
IDL_STATUS_E2054	A property getter cannot reference a method from another interface.
IDL_STATUS_E2055	If the getter method is static, then the property must also be static, and vice versa.
IDL_STATUS_E2056	A static getter method must not have arguments.
IDL_STATUS_E2057	A getter method must have one argument.
IDL_STATUS_E2058	Getter method cannot return 'Void'.
IDL_STATUS_E2059	Setter must be a method.
IDL_STATUS_E2060	If the setter method is static, then the property must also be static, and vice versa.
IDL_STATUS_E2061	A property setter cannot reference a method from another interface.
IDL_STATUS_E2062	A static setter method must have one argument.
IDL_STATUS_E2063	A setter method must have two arguments.
IDL_STATUS_E2064	The return type of the getter method is different from the argument type of the setter method.
IDL_STATUS_E2065	The property type does not match the return type of the getter method.
IDL_STATUS_E2066	The property type does not match the setter method argument type.
IDL_STATUS_E2067	Failed to create file.
IDL_STATUS_E2068	Field 'of struct cannot be of type 'Void'.
IDL_STATUS_E2069	The handle type must be specified.
IDL_STATUS_E2070	The handle type must be struct.
IDL_STATUS_E2071	The structure specified in the handle type must be marked with the 'handle' attribute.
IDL_STATUS_E2072	It is not possible to add the 'noerror' attribute to the constant because the enum does not have the 'errorcode' attribute.
IDL_STATUS_E2073	Function argument cannot be marked with the 'this' attribute.
IDL_STATUS_E2074	Argument of function cannot be of type 'Void'.
IDL_STATUS_E2075	The 'cname' attribute must specify a string in the argument.
IDL_STATUS_E2076	The 'array' attribute must specify a size in the argument.
IDL_STATUS_E2077	Fixed size array of structure must be of size 1 or more.
IDL_STATUS_E2078	The 'array' attribute of the must point to a field of the structure or set fixed size value.
IDL_STATUS_E2079	The reference to the dynamic size array is located outside the visibility of the structure.
IDL_STATUS_E2080	The 'array' attribute for array must point to an integer field for a dynamic array.
IDL_STATUS_E2081	An struct must contain at least one field.
IDL_STATUS_E2082	There can be only one argument with the 'userdata' attribute.
IDL_STATUS_E2083	Callback argument cannot be marked with the 'this' attribute.
IDL_STATUS_E2084	There can be only one argument with the 'result' attribute.
IDL_STATUS_E2085	The function to convert an error code to a string must return a string and take one argument (the error code).
IDL_STATUS_E2086	The method for incrementing the reference counter ('refinc' attribute) of an object must be non-static and take one argument 'this'.
IDL_STATUS_E2087	The method for destroy of an object must be non-static and take one argument 'this'.
IDL_STATUS_E2088	There can only be one method to increment reference counter.
IDL_STATUS_E2089	There can only be one method to destroy object.
IDL_STATUS_E2090	Events can only be added to a interface type.
IDL_STATUS_E2091	The event must contain at least the 'get' attribute or the 'set' attribute or both.
IDL_STATUS_E2092	Event getter from refers to a method from another interface.
IDL_STATUS_E2093	If the getter method is static, then the event must also be static, and vice versa.
IDL_STATUS_E2094	Static getter for event must have no arguments or one argument 'userdata'.
IDL_STATUS_E2095	Getter for event must have one arguments or two arguments 'this' and 'userdata'.
IDL_STATUS_E2096	Event setter from refers to a method from another interface.
IDL_STATUS_E2097	If the setter method is static, then the event must also be static, and vice versa.
IDL_STATUS_E2098	Static setter for event must have one argument or setter and 'userdata' arguments.
IDL_STATUS_E2099	Setter for event must have two arguments 'this' and 'setter' or three arguments 'this', 'setter' and 'userdata'.
IDL_STATUS_E2100	The event type does not match the return type of the getter method.
IDL_STATUS_E2101	The event type does not match the setter method argument type.
IDL_STATUS_E2102	The argument of a method, function, or callback cannot be a fixed-size array.
IDL_STATUS_E2103	The reference to the dynamic size array is located outside the visibility of the method.
IDL_STATUS_E2104	The 'array' attribute of the must point to a argument of the method.
IDL_STATUS_E2105	The reference to the dynamic size array is located outside the visibility of the function.
IDL_STATUS_E2106	The 'array' attribute of the must point to a argument of the function.
IDL_STATUS_E2107	The reference to the dynamic size array is located outside the visibility of the callback.
IDL_STATUS_E2108	The 'array' attribute of the must point to a argument of the callback.
IDL_STATUS_E2109	The 'tokenizer' attribute must specify a indices string in the argument.
IDL_STATUS_E2110	The 'version' attribute must specify a semver in the argument.
IDL_STATUS_E2111	The declaration does not have a brief ('brief' attribute) or detailed description ('detail' attribute).
IDL_STATUS_E2112	The 'datasize' attribute must specify a size in the argument.
IDL_STATUS_E2113	The 'datasize' attribute of the must point to a field of the structure.
IDL_STATUS_E2114	The 'datasize' attribute of the must point to an integer field to specify the buffer size.
IDL_STATUS_E2115	The 'datasize' attribute of the must point to a argument of the method.
IDL_STATUS_E2116	The 'datasize' attribute of the must point to a argument of the function.
IDL_STATUS_E2117	The 'datasize' attribute of the must point to a argument of the callback.
IDL_STATUS_E2118	The reference to the size buffer is located outside the visibility of the structure.
IDL_STATUS_E2119	The 'datasize' attribute is only applicable to fields of type "Data" or "ConstData".
IDL_STATUS_E2120	The reference to the size buffer is located outside the visibility of the callback.
IDL_STATUS_E2121	The 'datasize' attribute is only applicable to arg of type "Data" or "ConstData".
IDL_STATUS_E2122	The reference to the size buffer is located outside the visibility of the function.
IDL_STATUS_E2123	The reference to the size buffer is located outside the visibility of the method.
IDL_STATUS_E2124	Can only specify either the 'datasize' or 'array' attribute, but not both.
IDL_STATUS_E2125	Cannot contain attribute 'errorcode'.
IDL_STATUS_E2126	The 'refinc' attribute can only contain a method.
IDL_STATUS_E2127	The 'destroy' attribute can only contain a method.
IDL_STATUS_MAX_ENUM	Max value of enum (not used)