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 | 5345ec2 | 2016-07-29 13:33:27 -0700 | [diff] [blame] | 38 | virtual bool isScope() const; |
Andreas Huber | a2723d2 | 2016-07-29 15:36:07 -0700 | [diff] [blame] | 39 | virtual bool isInterface() const; |
Andreas Huber | 8d3ac0c | 2016-08-04 14:49:23 -0700 | [diff] [blame] | 40 | virtual bool isEnum() const; |
| 41 | virtual bool isTypeDef() const; |
Andreas Huber | 295ad30 | 2016-08-16 11:35:00 -0700 | [diff] [blame] | 42 | virtual bool isBinder() const; |
Andreas Huber | 39fa718 | 2016-08-19 14:27:33 -0700 | [diff] [blame] | 43 | virtual bool isNamedType() const; |
Andreas Huber | f630bc8 | 2016-09-09 14:52:25 -0700 | [diff] [blame] | 44 | virtual bool isCompoundType() const; |
Andreas Huber | 709b62d | 2016-09-19 11:21:18 -0700 | [diff] [blame] | 45 | virtual bool isArray() const; |
| 46 | virtual bool isVector() const; |
Andreas Huber | 8d3ac0c | 2016-08-04 14:49:23 -0700 | [diff] [blame] | 47 | |
Andreas Huber | 737080b | 2016-08-02 15:38:04 -0700 | [diff] [blame] | 48 | virtual const ScalarType *resolveToScalarType() const; |
Andreas Huber | c9410c7 | 2016-07-28 12:18:40 -0700 | [diff] [blame] | 49 | |
Andreas Huber | 8d3ac0c | 2016-08-04 14:49:23 -0700 | [diff] [blame] | 50 | bool isValidEnumStorageType() const; |
| 51 | |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 52 | enum StorageMode { |
| 53 | StorageMode_Stack, |
| 54 | StorageMode_Argument, |
Martijn Coenen | ac58789 | 2016-11-17 15:14:19 +0100 | [diff] [blame] | 55 | StorageMode_Result, |
| 56 | StorageMode_Compound // when stored in a compound type |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 57 | }; |
Yifan Hong | 3b320f8 | 2016-11-01 15:15:54 -0700 | [diff] [blame] | 58 | |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 59 | virtual std::string getCppType( |
Steven Moreland | 979e099 | 2016-09-07 09:18:08 -0700 | [diff] [blame] | 60 | StorageMode mode, |
Yifan Hong | 3b320f8 | 2016-11-01 15:15:54 -0700 | [diff] [blame] | 61 | bool specifyNamespaces) const; |
| 62 | |
| 63 | std::string decorateCppName( |
| 64 | const std::string &name, |
| 65 | StorageMode mode, |
Steven Moreland | 979e099 | 2016-09-07 09:18:08 -0700 | [diff] [blame] | 66 | bool specifyNamespaces) const; |
| 67 | |
| 68 | /* gets all hidl-defined types used when this item is |
| 69 | * printed using getCppType or getJavaType. Examples: |
| 70 | * |
| 71 | * vec<vec<vec<IFoo>>>: IFoo is added to the set |
| 72 | * (the hypothetical type pair) |
| 73 | * pair<IFoo, IBar>: IFoo and IBar are added to the set |
| 74 | * int32_t: nothing is added to the set |
| 75 | * string: nothing is added to the set |
| 76 | * IFoo: IFoo is added to the set |
| 77 | */ |
| 78 | virtual void addNamedTypesToSet(std::set<const FQName> &set) const = 0; |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 79 | |
Yifan Hong | 3b320f8 | 2016-11-01 15:15:54 -0700 | [diff] [blame] | 80 | std::string getCppStackType(bool specifyNamespaces = true) const; |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 81 | |
Yifan Hong | 3b320f8 | 2016-11-01 15:15:54 -0700 | [diff] [blame] | 82 | std::string getCppResultType(bool specifyNamespaces = true) const; |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 83 | |
Yifan Hong | 3b320f8 | 2016-11-01 15:15:54 -0700 | [diff] [blame] | 84 | std::string getCppArgumentType(bool specifyNamespaces = true) const; |
Andreas Huber | 4c865b7 | 2016-09-14 15:26:27 -0700 | [diff] [blame] | 85 | |
Martijn Coenen | ac58789 | 2016-11-17 15:14:19 +0100 | [diff] [blame] | 86 | std::string getCppCompoundType(bool specifyNamespaces = true) const; |
| 87 | |
Yifan Hong | 4ed1347 | 2016-11-02 10:44:11 -0700 | [diff] [blame] | 88 | // For an array type, dimensionality information will be accumulated at the |
| 89 | // end of the returned string. |
Andreas Huber | 4c865b7 | 2016-09-14 15:26:27 -0700 | [diff] [blame] | 90 | // if forInitializer == true, actual dimensions are included, i.e. [3][5], |
| 91 | // otherwise (and by default), they are omitted, i.e. [][]. |
Yifan Hong | 4ed1347 | 2016-11-02 10:44:11 -0700 | [diff] [blame] | 92 | virtual std::string getJavaType(bool forInitializer = false) const; |
Andreas Huber | 4c865b7 | 2016-09-14 15:26:27 -0700 | [diff] [blame] | 93 | |
Andreas Huber | 85eabdb | 2016-08-25 11:24:49 -0700 | [diff] [blame] | 94 | virtual std::string getJavaWrapperType() const; |
Andreas Huber | 2831d51 | 2016-08-15 09:33:47 -0700 | [diff] [blame] | 95 | virtual std::string getJavaSuffix() const; |
| 96 | |
Zhuoyao Zhang | c5ea9f5 | 2016-10-06 15:05:39 -0700 | [diff] [blame] | 97 | virtual std::string getVtsType() const; |
| 98 | |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 99 | enum ErrorMode { |
| 100 | ErrorMode_Ignore, |
| 101 | ErrorMode_Goto, |
| 102 | ErrorMode_Break, |
Andreas Huber | 737080b | 2016-08-02 15:38:04 -0700 | [diff] [blame] | 103 | ErrorMode_Return, |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 104 | }; |
| 105 | virtual void emitReaderWriter( |
| 106 | Formatter &out, |
| 107 | const std::string &name, |
| 108 | const std::string &parcelObj, |
| 109 | bool parcelObjIsPointer, |
| 110 | bool isReader, |
| 111 | ErrorMode mode) const; |
| 112 | |
| 113 | virtual void emitReaderWriterEmbedded( |
| 114 | Formatter &out, |
Andreas Huber | f9d49f1 | 2016-09-12 14:58:36 -0700 | [diff] [blame] | 115 | size_t depth, |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 116 | const std::string &name, |
Yifan Hong | be2a373 | 2016-10-05 13:33:41 -0700 | [diff] [blame] | 117 | const std::string &sanitizedName, |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 118 | bool nameIsPointer, |
| 119 | const std::string &parcelObj, |
| 120 | bool parcelObjIsPointer, |
| 121 | bool isReader, |
| 122 | ErrorMode mode, |
| 123 | const std::string &parentName, |
| 124 | const std::string &offsetText) const; |
| 125 | |
Yifan Hong | bf459bc | 2016-08-23 16:50:37 -0700 | [diff] [blame] | 126 | virtual void emitResolveReferences( |
| 127 | Formatter &out, |
| 128 | const std::string &name, |
| 129 | bool nameIsPointer, |
| 130 | const std::string &parcelObj, |
| 131 | bool parcelObjIsPointer, |
| 132 | bool isReader, |
| 133 | ErrorMode mode) const; |
| 134 | |
| 135 | virtual void emitResolveReferencesEmbedded( |
| 136 | Formatter &out, |
| 137 | size_t depth, |
| 138 | const std::string &name, |
| 139 | const std::string &sanitizedName, |
| 140 | bool nameIsPointer, |
| 141 | const std::string &parcelObj, |
| 142 | bool parcelObjIsPointer, |
| 143 | bool isReader, |
| 144 | ErrorMode mode, |
| 145 | const std::string &parentName, |
| 146 | const std::string &offsetText) const; |
| 147 | |
Yifan Hong | 00f4717 | 2016-09-30 14:40:45 -0700 | [diff] [blame] | 148 | virtual bool useParentInEmitResolveReferencesEmbedded() const; |
| 149 | |
Yifan Hong | 244e82d | 2016-11-11 11:13:57 -0800 | [diff] [blame] | 150 | virtual bool useNameInEmitReaderWriterEmbedded(bool isReader) const; |
| 151 | |
Andreas Huber | 2831d51 | 2016-08-15 09:33:47 -0700 | [diff] [blame] | 152 | virtual void emitJavaReaderWriter( |
| 153 | Formatter &out, |
| 154 | const std::string &parcelObj, |
| 155 | const std::string &argName, |
| 156 | bool isReader) const; |
| 157 | |
Andreas Huber | 85eabdb | 2016-08-25 11:24:49 -0700 | [diff] [blame] | 158 | virtual void emitJavaFieldInitializer( |
| 159 | Formatter &out, |
| 160 | const std::string &fieldName) const; |
| 161 | |
| 162 | virtual void emitJavaFieldReaderWriter( |
| 163 | Formatter &out, |
Andreas Huber | 4c865b7 | 2016-09-14 15:26:27 -0700 | [diff] [blame] | 164 | size_t depth, |
Andreas Huber | 709b62d | 2016-09-19 11:21:18 -0700 | [diff] [blame] | 165 | const std::string &parcelName, |
Andreas Huber | 85eabdb | 2016-08-25 11:24:49 -0700 | [diff] [blame] | 166 | const std::string &blobName, |
| 167 | const std::string &fieldName, |
| 168 | const std::string &offset, |
| 169 | bool isReader) const; |
| 170 | |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 171 | virtual status_t emitTypeDeclarations(Formatter &out) const; |
| 172 | |
Andreas Huber | e3f769a | 2016-10-10 10:54:44 -0700 | [diff] [blame] | 173 | // Emit any declarations pertaining to this type that have to be |
| 174 | // at global scope, i.e. enum class operators. |
| 175 | virtual status_t emitGlobalTypeDeclarations(Formatter &out) const; |
| 176 | |
Yifan Hong | 244e82d | 2016-11-11 11:13:57 -0800 | [diff] [blame] | 177 | // Emit any declarations pertaining to this type that have to be |
| 178 | // at global scope for transport, e.g. read/writeEmbeddedTo/FromParcel |
| 179 | virtual status_t emitGlobalHwDeclarations(Formatter &out) const; |
| 180 | |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 181 | virtual status_t emitTypeDefinitions( |
| 182 | Formatter &out, const std::string prefix) const; |
| 183 | |
Andreas Huber | 85eabdb | 2016-08-25 11:24:49 -0700 | [diff] [blame] | 184 | virtual status_t emitJavaTypeDeclarations( |
| 185 | Formatter &out, bool atTopLevel) const; |
Andreas Huber | 2831d51 | 2016-08-15 09:33:47 -0700 | [diff] [blame] | 186 | |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 187 | virtual bool needsEmbeddedReadWrite() const; |
Yifan Hong | bf459bc | 2016-08-23 16:50:37 -0700 | [diff] [blame] | 188 | virtual bool needsResolveReferences() const; |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 189 | virtual bool resultNeedsDeref() const; |
| 190 | |
Zhuoyao Zhang | 5158db4 | 2016-08-10 10:25:20 -0700 | [diff] [blame] | 191 | // Generates type declaration for vts proto file. |
| 192 | // TODO (b/30844146): make it a pure virtual method. |
| 193 | virtual status_t emitVtsTypeDeclarations(Formatter &out) const; |
Zhuoyao Zhang | 864c771 | 2016-08-16 15:35:28 -0700 | [diff] [blame] | 194 | // Generates type declaration as attribute of method (return value or method |
| 195 | // argument) or attribute of compound type for vts proto file. |
| 196 | virtual status_t emitVtsAttributeType(Formatter &out) const; |
Zhuoyao Zhang | 5158db4 | 2016-08-10 10:25:20 -0700 | [diff] [blame] | 197 | |
Andreas Huber | 70a59e1 | 2016-08-16 12:57:01 -0700 | [diff] [blame] | 198 | // Returns true iff this type is supported through the Java backend. |
| 199 | virtual bool isJavaCompatible() const; |
| 200 | |
Andreas Huber | 85eabdb | 2016-08-25 11:24:49 -0700 | [diff] [blame] | 201 | virtual void getAlignmentAndSize(size_t *align, size_t *size) const; |
| 202 | |
Andreas Huber | 7c5ddfb | 2016-09-29 13:45:22 -0700 | [diff] [blame] | 203 | void setAnnotations(std::vector<Annotation *> *annotations); |
| 204 | const std::vector<Annotation *> &annotations() const; |
| 205 | |
Andreas Huber | 019d21d | 2016-10-03 12:59:47 -0700 | [diff] [blame] | 206 | virtual void appendToExportedTypesVector( |
| 207 | std::vector<const Type *> *exportedTypes) const; |
| 208 | |
Andreas Huber | 1c50727 | 2016-10-05 14:33:21 -0700 | [diff] [blame] | 209 | virtual status_t emitExportedHeader(Formatter &out, bool forJava) const; |
Andreas Huber | 019d21d | 2016-10-03 12:59:47 -0700 | [diff] [blame] | 210 | |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 211 | protected: |
| 212 | void handleError(Formatter &out, ErrorMode mode) const; |
| 213 | void handleError2(Formatter &out, ErrorMode mode) const; |
| 214 | |
| 215 | void emitReaderWriterEmbeddedForTypeName( |
| 216 | Formatter &out, |
| 217 | const std::string &name, |
| 218 | bool nameIsPointer, |
| 219 | const std::string &parcelObj, |
| 220 | bool parcelObjIsPointer, |
| 221 | bool isReader, |
| 222 | ErrorMode mode, |
| 223 | const std::string &parentName, |
| 224 | const std::string &offsetText, |
| 225 | const std::string &typeName, |
Yifan Hong | 244e82d | 2016-11-11 11:13:57 -0800 | [diff] [blame] | 226 | const std::string &childName, |
| 227 | const std::string &funcNamespace) const; |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 228 | |
Andreas Huber | 2831d51 | 2016-08-15 09:33:47 -0700 | [diff] [blame] | 229 | void emitJavaReaderWriterWithSuffix( |
| 230 | Formatter &out, |
| 231 | const std::string &parcelObj, |
| 232 | const std::string &argName, |
| 233 | bool isReader, |
| 234 | const std::string &suffix, |
| 235 | const std::string &extra) const; |
| 236 | |
Andreas Huber | c9410c7 | 2016-07-28 12:18:40 -0700 | [diff] [blame] | 237 | private: |
Andreas Huber | 7c5ddfb | 2016-09-29 13:45:22 -0700 | [diff] [blame] | 238 | std::vector<Annotation *> *mAnnotations; |
| 239 | |
Andreas Huber | c9410c7 | 2016-07-28 12:18:40 -0700 | [diff] [blame] | 240 | DISALLOW_COPY_AND_ASSIGN(Type); |
| 241 | }; |
| 242 | |
Yifan Hong | bf459bc | 2016-08-23 16:50:37 -0700 | [diff] [blame] | 243 | /* Base type for VectorType and RefType. */ |
| 244 | struct TemplatedType : public Type { |
| 245 | void setElementType(Type *elementType); |
| 246 | protected: |
| 247 | TemplatedType(); |
| 248 | Type *mElementType; |
| 249 | private: |
| 250 | DISALLOW_COPY_AND_ASSIGN(TemplatedType); |
| 251 | }; |
| 252 | |
Andreas Huber | c9410c7 | 2016-07-28 12:18:40 -0700 | [diff] [blame] | 253 | } // namespace android |
| 254 | |
| 255 | #endif // TYPE_H_ |
| 256 | |