Andreas Huber | 1aec397 | 2016-08-26 09:26:32 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2016 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
Andreas Huber | c9410c7 | 2016-07-28 12:18:40 -0700 | [diff] [blame] | 17 | #ifndef TYPE_H_ |
| 18 | |
| 19 | #define TYPE_H_ |
| 20 | |
| 21 | #include <android-base/macros.h> |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 22 | #include <string> |
| 23 | #include <utils/Errors.h> |
Andreas Huber | 7c5ddfb | 2016-09-29 13:45:22 -0700 | [diff] [blame] | 24 | #include <vector> |
Steven Moreland | 979e099 | 2016-09-07 09:18:08 -0700 | [diff] [blame] | 25 | #include <set> |
Andreas Huber | c9410c7 | 2016-07-28 12:18:40 -0700 | [diff] [blame] | 26 | |
| 27 | namespace android { |
| 28 | |
Andreas Huber | 7c5ddfb | 2016-09-29 13:45:22 -0700 | [diff] [blame] | 29 | struct Annotation; |
Andreas Huber | c9410c7 | 2016-07-28 12:18:40 -0700 | [diff] [blame] | 30 | struct Formatter; |
Andreas Huber | 737080b | 2016-08-02 15:38:04 -0700 | [diff] [blame] | 31 | struct ScalarType; |
Steven Moreland | 979e099 | 2016-09-07 09:18:08 -0700 | [diff] [blame] | 32 | struct FQName; |
Andreas Huber | c9410c7 | 2016-07-28 12:18:40 -0700 | [diff] [blame] | 33 | |
| 34 | struct Type { |
| 35 | Type(); |
| 36 | virtual ~Type(); |
| 37 | |
Andreas Huber | 709b62d | 2016-09-19 11:21:18 -0700 | [diff] [blame] | 38 | virtual bool isArray() const; |
Martijn Coenen | 99e6beb | 2016-12-01 15:48:42 +0100 | [diff] [blame] | 39 | virtual bool isBinder() const; |
Yifan Hong | abf73ee | 2016-12-05 18:47:00 -0800 | [diff] [blame] | 40 | virtual bool isBitField() const; |
Martijn Coenen | 99e6beb | 2016-12-01 15:48:42 +0100 | [diff] [blame] | 41 | virtual bool isCompoundType() const; |
| 42 | virtual bool isEnum() const; |
Yifan Hong | abf73ee | 2016-12-05 18:47:00 -0800 | [diff] [blame] | 43 | virtual bool isHandle() const; |
Martijn Coenen | 99e6beb | 2016-12-01 15:48:42 +0100 | [diff] [blame] | 44 | virtual bool isInterface() const; |
| 45 | virtual bool isNamedType() const; |
| 46 | virtual bool isPointer() const; |
| 47 | virtual bool isScope() const; |
Yifan Hong | abf73ee | 2016-12-05 18:47:00 -0800 | [diff] [blame] | 48 | virtual bool isScalar() const; |
| 49 | virtual bool isString() const; |
| 50 | virtual bool isTemplatedType() const; |
Martijn Coenen | 99e6beb | 2016-12-01 15:48:42 +0100 | [diff] [blame] | 51 | virtual bool isTypeDef() const; |
Andreas Huber | 709b62d | 2016-09-19 11:21:18 -0700 | [diff] [blame] | 52 | virtual bool isVector() const; |
Andreas Huber | 8d3ac0c | 2016-08-04 14:49:23 -0700 | [diff] [blame] | 53 | |
Andreas Huber | 737080b | 2016-08-02 15:38:04 -0700 | [diff] [blame] | 54 | virtual const ScalarType *resolveToScalarType() const; |
Andreas Huber | c9410c7 | 2016-07-28 12:18:40 -0700 | [diff] [blame] | 55 | |
Steven Moreland | 30bb6a8 | 2016-11-30 09:18:34 -0800 | [diff] [blame] | 56 | virtual std::string typeName() const; |
| 57 | |
Andreas Huber | 8d3ac0c | 2016-08-04 14:49:23 -0700 | [diff] [blame] | 58 | bool isValidEnumStorageType() const; |
Steven Moreland | 9df5244 | 2016-12-12 08:51:14 -0800 | [diff] [blame] | 59 | virtual bool isElidableType() const; |
Yifan Hong | c6752dc | 2016-12-20 14:00:14 -0800 | [diff] [blame] | 60 | virtual bool canCheckEquality() const; |
Andreas Huber | 8d3ac0c | 2016-08-04 14:49:23 -0700 | [diff] [blame] | 61 | |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 62 | enum StorageMode { |
| 63 | StorageMode_Stack, |
| 64 | StorageMode_Argument, |
Martijn Coenen | ac58789 | 2016-11-17 15:14:19 +0100 | [diff] [blame] | 65 | StorageMode_Result, |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 66 | }; |
Yifan Hong | 3b320f8 | 2016-11-01 15:15:54 -0700 | [diff] [blame] | 67 | |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 68 | virtual std::string getCppType( |
Steven Moreland | 979e099 | 2016-09-07 09:18:08 -0700 | [diff] [blame] | 69 | StorageMode mode, |
Yifan Hong | 3b320f8 | 2016-11-01 15:15:54 -0700 | [diff] [blame] | 70 | bool specifyNamespaces) const; |
| 71 | |
| 72 | std::string decorateCppName( |
| 73 | const std::string &name, |
| 74 | StorageMode mode, |
Steven Moreland | 979e099 | 2016-09-07 09:18:08 -0700 | [diff] [blame] | 75 | bool specifyNamespaces) const; |
| 76 | |
| 77 | /* gets all hidl-defined types used when this item is |
| 78 | * printed using getCppType or getJavaType. Examples: |
| 79 | * |
| 80 | * vec<vec<vec<IFoo>>>: IFoo is added to the set |
| 81 | * (the hypothetical type pair) |
| 82 | * pair<IFoo, IBar>: IFoo and IBar are added to the set |
| 83 | * int32_t: nothing is added to the set |
| 84 | * string: nothing is added to the set |
| 85 | * IFoo: IFoo is added to the set |
| 86 | */ |
| 87 | virtual void addNamedTypesToSet(std::set<const FQName> &set) const = 0; |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 88 | |
Yifan Hong | 3b320f8 | 2016-11-01 15:15:54 -0700 | [diff] [blame] | 89 | std::string getCppStackType(bool specifyNamespaces = true) const; |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 90 | |
Yifan Hong | 3b320f8 | 2016-11-01 15:15:54 -0700 | [diff] [blame] | 91 | std::string getCppResultType(bool specifyNamespaces = true) const; |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 92 | |
Yifan Hong | 3b320f8 | 2016-11-01 15:15:54 -0700 | [diff] [blame] | 93 | std::string getCppArgumentType(bool specifyNamespaces = true) const; |
Andreas Huber | 4c865b7 | 2016-09-14 15:26:27 -0700 | [diff] [blame] | 94 | |
Yifan Hong | 4ed1347 | 2016-11-02 10:44:11 -0700 | [diff] [blame] | 95 | // For an array type, dimensionality information will be accumulated at the |
| 96 | // end of the returned string. |
Andreas Huber | 4c865b7 | 2016-09-14 15:26:27 -0700 | [diff] [blame] | 97 | // if forInitializer == true, actual dimensions are included, i.e. [3][5], |
| 98 | // otherwise (and by default), they are omitted, i.e. [][]. |
Yifan Hong | 4ed1347 | 2016-11-02 10:44:11 -0700 | [diff] [blame] | 99 | virtual std::string getJavaType(bool forInitializer = false) const; |
Andreas Huber | 4c865b7 | 2016-09-14 15:26:27 -0700 | [diff] [blame] | 100 | |
Andreas Huber | 85eabdb | 2016-08-25 11:24:49 -0700 | [diff] [blame] | 101 | virtual std::string getJavaWrapperType() const; |
Andreas Huber | 2831d51 | 2016-08-15 09:33:47 -0700 | [diff] [blame] | 102 | virtual std::string getJavaSuffix() const; |
| 103 | |
Zhuoyao Zhang | c5ea9f5 | 2016-10-06 15:05:39 -0700 | [diff] [blame] | 104 | virtual std::string getVtsType() const; |
Zhuoyao Zhang | e966784 | 2017-01-19 12:35:32 -0800 | [diff] [blame] | 105 | virtual std::string getVtsValueName() const; |
Zhuoyao Zhang | c5ea9f5 | 2016-10-06 15:05:39 -0700 | [diff] [blame] | 106 | |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 107 | enum ErrorMode { |
| 108 | ErrorMode_Ignore, |
| 109 | ErrorMode_Goto, |
| 110 | ErrorMode_Break, |
Andreas Huber | 737080b | 2016-08-02 15:38:04 -0700 | [diff] [blame] | 111 | ErrorMode_Return, |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 112 | }; |
| 113 | virtual void emitReaderWriter( |
| 114 | Formatter &out, |
| 115 | const std::string &name, |
| 116 | const std::string &parcelObj, |
| 117 | bool parcelObjIsPointer, |
| 118 | bool isReader, |
| 119 | ErrorMode mode) const; |
| 120 | |
| 121 | virtual void emitReaderWriterEmbedded( |
| 122 | Formatter &out, |
Andreas Huber | f9d49f1 | 2016-09-12 14:58:36 -0700 | [diff] [blame] | 123 | size_t depth, |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 124 | const std::string &name, |
Yifan Hong | be2a373 | 2016-10-05 13:33:41 -0700 | [diff] [blame] | 125 | const std::string &sanitizedName, |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 126 | bool nameIsPointer, |
| 127 | const std::string &parcelObj, |
| 128 | bool parcelObjIsPointer, |
| 129 | bool isReader, |
| 130 | ErrorMode mode, |
| 131 | const std::string &parentName, |
| 132 | const std::string &offsetText) const; |
| 133 | |
Yifan Hong | bf459bc | 2016-08-23 16:50:37 -0700 | [diff] [blame] | 134 | virtual void emitResolveReferences( |
| 135 | Formatter &out, |
| 136 | const std::string &name, |
| 137 | bool nameIsPointer, |
| 138 | const std::string &parcelObj, |
| 139 | bool parcelObjIsPointer, |
| 140 | bool isReader, |
| 141 | ErrorMode mode) const; |
| 142 | |
| 143 | virtual void emitResolveReferencesEmbedded( |
| 144 | Formatter &out, |
| 145 | size_t depth, |
| 146 | const std::string &name, |
| 147 | const std::string &sanitizedName, |
| 148 | bool nameIsPointer, |
| 149 | const std::string &parcelObj, |
| 150 | bool parcelObjIsPointer, |
| 151 | bool isReader, |
| 152 | ErrorMode mode, |
| 153 | const std::string &parentName, |
| 154 | const std::string &offsetText) const; |
| 155 | |
Yifan Hong | f5cc2f7 | 2017-01-04 18:02:34 -0800 | [diff] [blame] | 156 | virtual void emitDump( |
| 157 | Formatter &out, |
| 158 | const std::string &streamName, |
| 159 | const std::string &name) const; |
| 160 | |
Yifan Hong | e45b530 | 2017-02-22 10:49:07 -0800 | [diff] [blame] | 161 | virtual void emitJavaDump( |
| 162 | Formatter &out, |
| 163 | const std::string &streamName, |
| 164 | const std::string &name) const; |
| 165 | |
Yifan Hong | 00f4717 | 2016-09-30 14:40:45 -0700 | [diff] [blame] | 166 | virtual bool useParentInEmitResolveReferencesEmbedded() const; |
| 167 | |
Yifan Hong | 244e82d | 2016-11-11 11:13:57 -0800 | [diff] [blame] | 168 | virtual bool useNameInEmitReaderWriterEmbedded(bool isReader) const; |
| 169 | |
Andreas Huber | 2831d51 | 2016-08-15 09:33:47 -0700 | [diff] [blame] | 170 | virtual void emitJavaReaderWriter( |
| 171 | Formatter &out, |
| 172 | const std::string &parcelObj, |
| 173 | const std::string &argName, |
| 174 | bool isReader) const; |
| 175 | |
Andreas Huber | 85eabdb | 2016-08-25 11:24:49 -0700 | [diff] [blame] | 176 | virtual void emitJavaFieldInitializer( |
| 177 | Formatter &out, |
| 178 | const std::string &fieldName) const; |
| 179 | |
| 180 | virtual void emitJavaFieldReaderWriter( |
| 181 | Formatter &out, |
Andreas Huber | 4c865b7 | 2016-09-14 15:26:27 -0700 | [diff] [blame] | 182 | size_t depth, |
Andreas Huber | 709b62d | 2016-09-19 11:21:18 -0700 | [diff] [blame] | 183 | const std::string &parcelName, |
Andreas Huber | 85eabdb | 2016-08-25 11:24:49 -0700 | [diff] [blame] | 184 | const std::string &blobName, |
| 185 | const std::string &fieldName, |
| 186 | const std::string &offset, |
| 187 | bool isReader) const; |
| 188 | |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 189 | virtual status_t emitTypeDeclarations(Formatter &out) const; |
| 190 | |
Andreas Huber | e3f769a | 2016-10-10 10:54:44 -0700 | [diff] [blame] | 191 | // Emit any declarations pertaining to this type that have to be |
| 192 | // at global scope, i.e. enum class operators. |
| 193 | virtual status_t emitGlobalTypeDeclarations(Formatter &out) const; |
| 194 | |
Yifan Hong | 244e82d | 2016-11-11 11:13:57 -0800 | [diff] [blame] | 195 | // Emit any declarations pertaining to this type that have to be |
| 196 | // at global scope for transport, e.g. read/writeEmbeddedTo/FromParcel |
| 197 | virtual status_t emitGlobalHwDeclarations(Formatter &out) const; |
| 198 | |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 199 | virtual status_t emitTypeDefinitions( |
| 200 | Formatter &out, const std::string prefix) const; |
| 201 | |
Andreas Huber | 85eabdb | 2016-08-25 11:24:49 -0700 | [diff] [blame] | 202 | virtual status_t emitJavaTypeDeclarations( |
| 203 | Formatter &out, bool atTopLevel) const; |
Andreas Huber | 2831d51 | 2016-08-15 09:33:47 -0700 | [diff] [blame] | 204 | |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 205 | virtual bool needsEmbeddedReadWrite() const; |
Yifan Hong | bf459bc | 2016-08-23 16:50:37 -0700 | [diff] [blame] | 206 | virtual bool needsResolveReferences() const; |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 207 | virtual bool resultNeedsDeref() const; |
| 208 | |
Zhuoyao Zhang | 5158db4 | 2016-08-10 10:25:20 -0700 | [diff] [blame] | 209 | // Generates type declaration for vts proto file. |
| 210 | // TODO (b/30844146): make it a pure virtual method. |
| 211 | virtual status_t emitVtsTypeDeclarations(Formatter &out) const; |
Zhuoyao Zhang | 864c771 | 2016-08-16 15:35:28 -0700 | [diff] [blame] | 212 | // Generates type declaration as attribute of method (return value or method |
| 213 | // argument) or attribute of compound type for vts proto file. |
| 214 | virtual status_t emitVtsAttributeType(Formatter &out) const; |
Zhuoyao Zhang | 5158db4 | 2016-08-10 10:25:20 -0700 | [diff] [blame] | 215 | |
Andreas Huber | 70a59e1 | 2016-08-16 12:57:01 -0700 | [diff] [blame] | 216 | // Returns true iff this type is supported through the Java backend. |
| 217 | virtual bool isJavaCompatible() const; |
| 218 | |
Andreas Huber | 85eabdb | 2016-08-25 11:24:49 -0700 | [diff] [blame] | 219 | virtual void getAlignmentAndSize(size_t *align, size_t *size) const; |
| 220 | |
Andreas Huber | 7c5ddfb | 2016-09-29 13:45:22 -0700 | [diff] [blame] | 221 | void setAnnotations(std::vector<Annotation *> *annotations); |
| 222 | const std::vector<Annotation *> &annotations() const; |
| 223 | |
Andreas Huber | 019d21d | 2016-10-03 12:59:47 -0700 | [diff] [blame] | 224 | virtual void appendToExportedTypesVector( |
| 225 | std::vector<const Type *> *exportedTypes) const; |
| 226 | |
Andreas Huber | 1c50727 | 2016-10-05 14:33:21 -0700 | [diff] [blame] | 227 | virtual status_t emitExportedHeader(Formatter &out, bool forJava) const; |
Andreas Huber | 019d21d | 2016-10-03 12:59:47 -0700 | [diff] [blame] | 228 | |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 229 | protected: |
| 230 | void handleError(Formatter &out, ErrorMode mode) const; |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 231 | |
| 232 | void emitReaderWriterEmbeddedForTypeName( |
| 233 | Formatter &out, |
| 234 | const std::string &name, |
| 235 | bool nameIsPointer, |
| 236 | const std::string &parcelObj, |
| 237 | bool parcelObjIsPointer, |
| 238 | bool isReader, |
| 239 | ErrorMode mode, |
| 240 | const std::string &parentName, |
| 241 | const std::string &offsetText, |
| 242 | const std::string &typeName, |
Yifan Hong | 244e82d | 2016-11-11 11:13:57 -0800 | [diff] [blame] | 243 | const std::string &childName, |
| 244 | const std::string &funcNamespace) const; |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 245 | |
Andreas Huber | 2831d51 | 2016-08-15 09:33:47 -0700 | [diff] [blame] | 246 | void emitJavaReaderWriterWithSuffix( |
| 247 | Formatter &out, |
| 248 | const std::string &parcelObj, |
| 249 | const std::string &argName, |
| 250 | bool isReader, |
| 251 | const std::string &suffix, |
| 252 | const std::string &extra) const; |
| 253 | |
Yifan Hong | f5cc2f7 | 2017-01-04 18:02:34 -0800 | [diff] [blame] | 254 | void emitDumpWithMethod( |
| 255 | Formatter &out, |
| 256 | const std::string &streamName, |
| 257 | const std::string &methodName, |
| 258 | const std::string &name) const; |
| 259 | |
Andreas Huber | c9410c7 | 2016-07-28 12:18:40 -0700 | [diff] [blame] | 260 | private: |
Andreas Huber | 7c5ddfb | 2016-09-29 13:45:22 -0700 | [diff] [blame] | 261 | std::vector<Annotation *> *mAnnotations; |
| 262 | |
Andreas Huber | c9410c7 | 2016-07-28 12:18:40 -0700 | [diff] [blame] | 263 | DISALLOW_COPY_AND_ASSIGN(Type); |
| 264 | }; |
| 265 | |
Yifan Hong | bf459bc | 2016-08-23 16:50:37 -0700 | [diff] [blame] | 266 | /* Base type for VectorType and RefType. */ |
| 267 | struct TemplatedType : public Type { |
| 268 | void setElementType(Type *elementType); |
Yifan Hong | abf73ee | 2016-12-05 18:47:00 -0800 | [diff] [blame] | 269 | Type *getElementType() const; |
| 270 | bool isTemplatedType() const override; |
Steven Moreland | 30bb6a8 | 2016-11-30 09:18:34 -0800 | [diff] [blame] | 271 | virtual bool isCompatibleElementType(Type *elementType) const = 0; |
Zhuoyao Zhang | e966784 | 2017-01-19 12:35:32 -0800 | [diff] [blame] | 272 | status_t emitVtsTypeDeclarations(Formatter &out) const override; |
| 273 | status_t emitVtsAttributeType(Formatter &out) const override; |
Yifan Hong | bf459bc | 2016-08-23 16:50:37 -0700 | [diff] [blame] | 274 | protected: |
| 275 | TemplatedType(); |
| 276 | Type *mElementType; |
| 277 | private: |
| 278 | DISALLOW_COPY_AND_ASSIGN(TemplatedType); |
| 279 | }; |
| 280 | |
Andreas Huber | c9410c7 | 2016-07-28 12:18:40 -0700 | [diff] [blame] | 281 | } // namespace android |
| 282 | |
| 283 | #endif // TYPE_H_ |
| 284 | |