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