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 <utils/Errors.h> |
Steven Moreland | 979e099 | 2016-09-07 09:18:08 -0700 | [diff] [blame] | 23 | #include <set> |
Timur Iskhakov | cec46c4 | 2017-08-09 00:22:02 -0700 | [diff] [blame] | 24 | #include <string> |
Timur Iskhakov | 458ca36 | 2017-09-12 23:16:03 -0700 | [diff] [blame] | 25 | #include <unordered_map> |
Timur Iskhakov | 33431e6 | 2017-08-21 17:31:23 -0700 | [diff] [blame] | 26 | #include <unordered_set> |
Timur Iskhakov | cec46c4 | 2017-08-09 00:22:02 -0700 | [diff] [blame] | 27 | #include <vector> |
Andreas Huber | c9410c7 | 2016-07-28 12:18:40 -0700 | [diff] [blame] | 28 | |
Steven Moreland | 073269e | 2018-05-17 15:45:26 -0700 | [diff] [blame] | 29 | #include "DocComment.h" |
Timur Iskhakov | 505316c | 2017-08-05 03:38:59 +0000 | [diff] [blame] | 30 | #include "Reference.h" |
| 31 | |
Andreas Huber | c9410c7 | 2016-07-28 12:18:40 -0700 | [diff] [blame] | 32 | namespace android { |
| 33 | |
Steven Moreland | bf71421 | 2017-10-27 18:29:01 -0700 | [diff] [blame] | 34 | // TODO(b/65200821): remove |
| 35 | // HACK because no no type can depend or see AST |
| 36 | extern std::string gCurrentCompileName; |
| 37 | |
Timur Iskhakov | 891a866 | 2017-08-25 21:53:48 -0700 | [diff] [blame] | 38 | struct ConstantExpression; |
Andreas Huber | c9410c7 | 2016-07-28 12:18:40 -0700 | [diff] [blame] | 39 | struct Formatter; |
Steven Moreland | 979e099 | 2016-09-07 09:18:08 -0700 | [diff] [blame] | 40 | struct FQName; |
Timur Iskhakov | 891a866 | 2017-08-25 21:53:48 -0700 | [diff] [blame] | 41 | struct ScalarType; |
Timur Iskhakov | 63f3990 | 2017-08-29 15:47:29 -0700 | [diff] [blame] | 42 | struct Scope; |
Andreas Huber | c9410c7 | 2016-07-28 12:18:40 -0700 | [diff] [blame] | 43 | |
Steven Moreland | 073269e | 2018-05-17 15:45:26 -0700 | [diff] [blame] | 44 | struct Type : DocCommentable { |
Timur Iskhakov | 63f3990 | 2017-08-29 15:47:29 -0700 | [diff] [blame] | 45 | Type(Scope* parent); |
Andreas Huber | c9410c7 | 2016-07-28 12:18:40 -0700 | [diff] [blame] | 46 | virtual ~Type(); |
| 47 | |
Andreas Huber | 709b62d | 2016-09-19 11:21:18 -0700 | [diff] [blame] | 48 | virtual bool isArray() const; |
Martijn Coenen | 99e6beb | 2016-12-01 15:48:42 +0100 | [diff] [blame] | 49 | virtual bool isBinder() const; |
Yifan Hong | abf73ee | 2016-12-05 18:47:00 -0800 | [diff] [blame] | 50 | virtual bool isBitField() const; |
Martijn Coenen | 99e6beb | 2016-12-01 15:48:42 +0100 | [diff] [blame] | 51 | virtual bool isCompoundType() const; |
| 52 | virtual bool isEnum() const; |
Yifan Hong | abf73ee | 2016-12-05 18:47:00 -0800 | [diff] [blame] | 53 | virtual bool isHandle() const; |
Martijn Coenen | 99e6beb | 2016-12-01 15:48:42 +0100 | [diff] [blame] | 54 | virtual bool isInterface() const; |
| 55 | virtual bool isNamedType() const; |
Steven Moreland | 397b5e1 | 2017-06-08 14:02:26 -0700 | [diff] [blame] | 56 | virtual bool isMemory() const; |
Martijn Coenen | 99e6beb | 2016-12-01 15:48:42 +0100 | [diff] [blame] | 57 | virtual bool isPointer() const; |
| 58 | virtual bool isScope() const; |
Yifan Hong | abf73ee | 2016-12-05 18:47:00 -0800 | [diff] [blame] | 59 | virtual bool isScalar() const; |
| 60 | virtual bool isString() const; |
| 61 | virtual bool isTemplatedType() const; |
Martijn Coenen | 99e6beb | 2016-12-01 15:48:42 +0100 | [diff] [blame] | 62 | virtual bool isTypeDef() const; |
Andreas Huber | 709b62d | 2016-09-19 11:21:18 -0700 | [diff] [blame] | 63 | virtual bool isVector() const; |
Andreas Huber | 8d3ac0c | 2016-08-04 14:49:23 -0700 | [diff] [blame] | 64 | |
Timur Iskhakov | dbaed33 | 2017-08-31 16:33:41 -0700 | [diff] [blame] | 65 | // Resolves the type by unwrapping typedefs |
| 66 | Type* resolve(); |
| 67 | virtual const Type* resolve() const; |
| 68 | |
Timur Iskhakov | 33431e6 | 2017-08-21 17:31:23 -0700 | [diff] [blame] | 69 | // All types defined in this type. |
Timur Iskhakov | b58f418 | 2017-08-29 15:19:24 -0700 | [diff] [blame] | 70 | std::vector<Type*> getDefinedTypes(); |
| 71 | virtual std::vector<const Type*> getDefinedTypes() const; |
Timur Iskhakov | 33431e6 | 2017-08-21 17:31:23 -0700 | [diff] [blame] | 72 | |
| 73 | // All types referenced in this type. |
Timur Iskhakov | b58f418 | 2017-08-29 15:19:24 -0700 | [diff] [blame] | 74 | std::vector<Reference<Type>*> getReferences(); |
| 75 | virtual std::vector<const Reference<Type>*> getReferences() const; |
Timur Iskhakov | 33431e6 | 2017-08-21 17:31:23 -0700 | [diff] [blame] | 76 | |
Timur Iskhakov | 891a866 | 2017-08-25 21:53:48 -0700 | [diff] [blame] | 77 | // All constant expressions referenced in this type. |
Timur Iskhakov | b58f418 | 2017-08-29 15:19:24 -0700 | [diff] [blame] | 78 | std::vector<ConstantExpression*> getConstantExpressions(); |
| 79 | virtual std::vector<const ConstantExpression*> getConstantExpressions() const; |
Timur Iskhakov | 891a866 | 2017-08-25 21:53:48 -0700 | [diff] [blame] | 80 | |
Timur Iskhakov | 40731af | 2017-08-24 14:18:35 -0700 | [diff] [blame] | 81 | // All types referenced in this type that must have completed |
| 82 | // definiton before being referenced. |
Timur Iskhakov | b58f418 | 2017-08-29 15:19:24 -0700 | [diff] [blame] | 83 | std::vector<Reference<Type>*> getStrongReferences(); |
| 84 | virtual std::vector<const Reference<Type>*> getStrongReferences() const; |
Timur Iskhakov | 40731af | 2017-08-24 14:18:35 -0700 | [diff] [blame] | 85 | |
Timur Iskhakov | 33431e6 | 2017-08-21 17:31:23 -0700 | [diff] [blame] | 86 | // Proceeds recursive pass |
| 87 | // Makes sure to visit each node only once. |
| 88 | status_t recursivePass(const std::function<status_t(Type*)>& func, |
| 89 | std::unordered_set<const Type*>* visited); |
| 90 | status_t recursivePass(const std::function<status_t(const Type*)>& func, |
| 91 | std::unordered_set<const Type*>* visited) const; |
| 92 | |
Timur Iskhakov | cec46c4 | 2017-08-09 00:22:02 -0700 | [diff] [blame] | 93 | // Recursive tree pass that completes type declarations |
| 94 | // that depend on super types |
| 95 | virtual status_t resolveInheritance(); |
| 96 | |
Timur Iskhakov | cec46c4 | 2017-08-09 00:22:02 -0700 | [diff] [blame] | 97 | // Recursive tree pass that validates all type-related |
| 98 | // syntax restrictions |
| 99 | virtual status_t validate() const; |
| 100 | |
Timur Iskhakov | 40731af | 2017-08-24 14:18:35 -0700 | [diff] [blame] | 101 | // Recursive tree pass checkAcyclic return type. |
| 102 | // Stores cycle end for nice error messages. |
| 103 | struct CheckAcyclicStatus { |
| 104 | CheckAcyclicStatus(status_t status, const Type* cycleEnd = nullptr); |
| 105 | |
| 106 | status_t status; |
| 107 | |
| 108 | // If a cycle is found, stores the end of cycle. |
| 109 | // While going back in recursion, this is used to stop printing the cycle. |
| 110 | const Type* cycleEnd; |
| 111 | }; |
| 112 | |
| 113 | // Recursive tree pass that ensures that type definitions and references |
Timur Iskhakov | 458ca36 | 2017-09-12 23:16:03 -0700 | [diff] [blame] | 114 | // are acyclic and builds reversed topological order of the types. |
Timur Iskhakov | 40731af | 2017-08-24 14:18:35 -0700 | [diff] [blame] | 115 | // If some cases allow using of incomplete types, these cases are to be |
| 116 | // declared in Type::getStrongReferences. |
Timur Iskhakov | 458ca36 | 2017-09-12 23:16:03 -0700 | [diff] [blame] | 117 | CheckAcyclicStatus topologicalOrder(std::unordered_map<const Type*, size_t>* reversedOrder, |
| 118 | std::unordered_set<const Type*>* stack) const; |
Timur Iskhakov | 40731af | 2017-08-24 14:18:35 -0700 | [diff] [blame] | 119 | |
Timur Iskhakov | 041fdfe | 2017-09-06 15:56:01 -0700 | [diff] [blame] | 120 | // Checks following C++ restriction on forward declaration: |
| 121 | // inner struct could be forward declared only inside its parent. |
Timur Iskhakov | 458ca36 | 2017-09-12 23:16:03 -0700 | [diff] [blame] | 122 | status_t checkForwardReferenceRestrictions(const Reference<Type>& ref) const; |
Timur Iskhakov | 041fdfe | 2017-09-06 15:56:01 -0700 | [diff] [blame] | 123 | |
Andreas Huber | 737080b | 2016-08-02 15:38:04 -0700 | [diff] [blame] | 124 | virtual const ScalarType *resolveToScalarType() const; |
Andreas Huber | c9410c7 | 2016-07-28 12:18:40 -0700 | [diff] [blame] | 125 | |
Steven Moreland | 0ecc7b8 | 2017-07-19 12:59:23 -0700 | [diff] [blame] | 126 | virtual std::string typeName() const = 0; |
Steven Moreland | 30bb6a8 | 2016-11-30 09:18:34 -0800 | [diff] [blame] | 127 | |
Andreas Huber | 8d3ac0c | 2016-08-04 14:49:23 -0700 | [diff] [blame] | 128 | bool isValidEnumStorageType() const; |
Steven Moreland | 9df5244 | 2016-12-12 08:51:14 -0800 | [diff] [blame] | 129 | virtual bool isElidableType() const; |
Timur Iskhakov | 5dc72fe | 2017-09-07 23:13:44 -0700 | [diff] [blame] | 130 | |
Yifan Hong | c6752dc | 2016-12-20 14:00:14 -0800 | [diff] [blame] | 131 | virtual bool canCheckEquality() const; |
Timur Iskhakov | 5dc72fe | 2017-09-07 23:13:44 -0700 | [diff] [blame] | 132 | bool canCheckEquality(std::unordered_set<const Type*>* visited) const; |
| 133 | virtual bool deepCanCheckEquality(std::unordered_set<const Type*>* visited) const; |
Andreas Huber | 8d3ac0c | 2016-08-04 14:49:23 -0700 | [diff] [blame] | 134 | |
Timur Iskhakov | 35930c4 | 2017-08-28 18:49:54 -0700 | [diff] [blame] | 135 | // Marks that package proceeding is completed |
| 136 | // Post parse passes must be proceeded during owner package parsing |
| 137 | void setPostParseCompleted(); |
| 138 | |
Timur Iskhakov | 63f3990 | 2017-08-29 15:47:29 -0700 | [diff] [blame] | 139 | Scope* parent(); |
Timur Iskhakov | 041fdfe | 2017-09-06 15:56:01 -0700 | [diff] [blame] | 140 | const Scope* parent() const; |
Timur Iskhakov | 63f3990 | 2017-08-29 15:47:29 -0700 | [diff] [blame] | 141 | |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 142 | enum StorageMode { |
| 143 | StorageMode_Stack, |
| 144 | StorageMode_Argument, |
Martijn Coenen | ac58789 | 2016-11-17 15:14:19 +0100 | [diff] [blame] | 145 | StorageMode_Result, |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 146 | }; |
Yifan Hong | 3b320f8 | 2016-11-01 15:15:54 -0700 | [diff] [blame] | 147 | |
Steven Moreland | e30ee9b | 2017-05-09 13:31:01 -0700 | [diff] [blame] | 148 | // specifyNamespaces: whether to specify namespaces for built-in types |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 149 | virtual std::string getCppType( |
Steven Moreland | 979e099 | 2016-09-07 09:18:08 -0700 | [diff] [blame] | 150 | StorageMode mode, |
Yifan Hong | 3b320f8 | 2016-11-01 15:15:54 -0700 | [diff] [blame] | 151 | bool specifyNamespaces) const; |
| 152 | |
| 153 | std::string decorateCppName( |
| 154 | const std::string &name, |
| 155 | StorageMode mode, |
Steven Moreland | 979e099 | 2016-09-07 09:18:08 -0700 | [diff] [blame] | 156 | bool specifyNamespaces) const; |
| 157 | |
Yifan Hong | 3b320f8 | 2016-11-01 15:15:54 -0700 | [diff] [blame] | 158 | std::string getCppStackType(bool specifyNamespaces = true) const; |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 159 | |
Yifan Hong | 3b320f8 | 2016-11-01 15:15:54 -0700 | [diff] [blame] | 160 | std::string getCppResultType(bool specifyNamespaces = true) const; |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 161 | |
Yifan Hong | 3b320f8 | 2016-11-01 15:15:54 -0700 | [diff] [blame] | 162 | std::string getCppArgumentType(bool specifyNamespaces = true) const; |
Andreas Huber | 4c865b7 | 2016-09-14 15:26:27 -0700 | [diff] [blame] | 163 | |
Nirav Atre | ca7a502 | 2018-06-29 20:43:49 -0700 | [diff] [blame] | 164 | std::string getCppTypeCast(const std::string& objName, |
| 165 | bool specifyNamespaces = true) const; |
| 166 | |
Yifan Hong | 4ed1347 | 2016-11-02 10:44:11 -0700 | [diff] [blame] | 167 | // For an array type, dimensionality information will be accumulated at the |
| 168 | // end of the returned string. |
Andreas Huber | 4c865b7 | 2016-09-14 15:26:27 -0700 | [diff] [blame] | 169 | // if forInitializer == true, actual dimensions are included, i.e. [3][5], |
| 170 | // otherwise (and by default), they are omitted, i.e. [][]. |
Yifan Hong | 4ed1347 | 2016-11-02 10:44:11 -0700 | [diff] [blame] | 171 | virtual std::string getJavaType(bool forInitializer = false) const; |
Andreas Huber | 4c865b7 | 2016-09-14 15:26:27 -0700 | [diff] [blame] | 172 | |
Nirav Atre | 66842a9 | 2018-06-28 18:14:13 -0700 | [diff] [blame^] | 173 | // Identical to getJavaType() for most types, except: primitives, in which |
| 174 | // case the wrapper type is returned, and generics (such as ArrayList<?>), |
| 175 | // where the type specialization is omitted to facilitate use of |
| 176 | // instanceof or class.isInstance(). |
| 177 | virtual std::string getJavaTypeClass() const; |
| 178 | |
| 179 | virtual std::string getJavaTypeCast(const std::string& objName) const; |
Andreas Huber | 2831d51 | 2016-08-15 09:33:47 -0700 | [diff] [blame] | 180 | virtual std::string getJavaSuffix() const; |
| 181 | |
Zhuoyao Zhang | c5ea9f5 | 2016-10-06 15:05:39 -0700 | [diff] [blame] | 182 | virtual std::string getVtsType() const; |
Zhuoyao Zhang | e966784 | 2017-01-19 12:35:32 -0800 | [diff] [blame] | 183 | virtual std::string getVtsValueName() const; |
Zhuoyao Zhang | c5ea9f5 | 2016-10-06 15:05:39 -0700 | [diff] [blame] | 184 | |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 185 | enum ErrorMode { |
| 186 | ErrorMode_Ignore, |
| 187 | ErrorMode_Goto, |
| 188 | ErrorMode_Break, |
Andreas Huber | 737080b | 2016-08-02 15:38:04 -0700 | [diff] [blame] | 189 | ErrorMode_Return, |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 190 | }; |
| 191 | virtual void emitReaderWriter( |
| 192 | Formatter &out, |
| 193 | const std::string &name, |
| 194 | const std::string &parcelObj, |
| 195 | bool parcelObjIsPointer, |
| 196 | bool isReader, |
| 197 | ErrorMode mode) const; |
| 198 | |
| 199 | virtual void emitReaderWriterEmbedded( |
| 200 | Formatter &out, |
Andreas Huber | f9d49f1 | 2016-09-12 14:58:36 -0700 | [diff] [blame] | 201 | size_t depth, |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 202 | const std::string &name, |
Yifan Hong | be2a373 | 2016-10-05 13:33:41 -0700 | [diff] [blame] | 203 | const std::string &sanitizedName, |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 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) const; |
| 211 | |
Yifan Hong | bf459bc | 2016-08-23 16:50:37 -0700 | [diff] [blame] | 212 | virtual void emitResolveReferences( |
| 213 | Formatter &out, |
| 214 | const std::string &name, |
| 215 | bool nameIsPointer, |
| 216 | const std::string &parcelObj, |
| 217 | bool parcelObjIsPointer, |
| 218 | bool isReader, |
| 219 | ErrorMode mode) const; |
| 220 | |
| 221 | virtual void emitResolveReferencesEmbedded( |
| 222 | Formatter &out, |
| 223 | size_t depth, |
| 224 | const std::string &name, |
| 225 | const std::string &sanitizedName, |
| 226 | bool nameIsPointer, |
| 227 | const std::string &parcelObj, |
| 228 | bool parcelObjIsPointer, |
| 229 | bool isReader, |
| 230 | ErrorMode mode, |
| 231 | const std::string &parentName, |
| 232 | const std::string &offsetText) const; |
| 233 | |
Yifan Hong | f5cc2f7 | 2017-01-04 18:02:34 -0800 | [diff] [blame] | 234 | virtual void emitDump( |
| 235 | Formatter &out, |
| 236 | const std::string &streamName, |
| 237 | const std::string &name) const; |
| 238 | |
Yifan Hong | e45b530 | 2017-02-22 10:49:07 -0800 | [diff] [blame] | 239 | virtual void emitJavaDump( |
| 240 | Formatter &out, |
| 241 | const std::string &streamName, |
| 242 | const std::string &name) const; |
| 243 | |
Yifan Hong | 00f4717 | 2016-09-30 14:40:45 -0700 | [diff] [blame] | 244 | virtual bool useParentInEmitResolveReferencesEmbedded() const; |
| 245 | |
Yifan Hong | 244e82d | 2016-11-11 11:13:57 -0800 | [diff] [blame] | 246 | virtual bool useNameInEmitReaderWriterEmbedded(bool isReader) const; |
| 247 | |
Andreas Huber | 2831d51 | 2016-08-15 09:33:47 -0700 | [diff] [blame] | 248 | virtual void emitJavaReaderWriter( |
| 249 | Formatter &out, |
| 250 | const std::string &parcelObj, |
| 251 | const std::string &argName, |
| 252 | bool isReader) const; |
| 253 | |
Andreas Huber | 85eabdb | 2016-08-25 11:24:49 -0700 | [diff] [blame] | 254 | virtual void emitJavaFieldInitializer( |
| 255 | Formatter &out, |
| 256 | const std::string &fieldName) const; |
| 257 | |
Nirav Atre | 66842a9 | 2018-06-28 18:14:13 -0700 | [diff] [blame^] | 258 | virtual void emitJavaFieldDefaultInitialValue( |
| 259 | Formatter &out, |
| 260 | const std::string &declaredFieldName) const; |
| 261 | |
Andreas Huber | 85eabdb | 2016-08-25 11:24:49 -0700 | [diff] [blame] | 262 | virtual void emitJavaFieldReaderWriter( |
| 263 | Formatter &out, |
Andreas Huber | 4c865b7 | 2016-09-14 15:26:27 -0700 | [diff] [blame] | 264 | size_t depth, |
Andreas Huber | 709b62d | 2016-09-19 11:21:18 -0700 | [diff] [blame] | 265 | const std::string &parcelName, |
Andreas Huber | 85eabdb | 2016-08-25 11:24:49 -0700 | [diff] [blame] | 266 | const std::string &blobName, |
| 267 | const std::string &fieldName, |
| 268 | const std::string &offset, |
| 269 | bool isReader) const; |
| 270 | |
Steven Moreland | 6ec9eb9 | 2018-02-16 14:21:49 -0800 | [diff] [blame] | 271 | virtual void emitTypeDeclarations(Formatter& out) const; |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 272 | |
Steven Moreland | 8e61c5a | 2017-11-17 15:55:28 -0800 | [diff] [blame] | 273 | virtual void emitGlobalTypeDeclarations(Formatter& out) const; |
| 274 | |
Timur Iskhakov | fd3f250 | 2017-09-05 16:25:02 -0700 | [diff] [blame] | 275 | // Emit scope C++ forward declaration. |
| 276 | // There is no need to forward declare interfaces, as |
| 277 | // they are always declared in global scope in dedicated file. |
| 278 | virtual void emitTypeForwardDeclaration(Formatter& out) const; |
| 279 | |
Andreas Huber | e3f769a | 2016-10-10 10:54:44 -0700 | [diff] [blame] | 280 | // Emit any declarations pertaining to this type that have to be |
| 281 | // at global scope, i.e. enum class operators. |
Steven Moreland | 4b8f7a1 | 2017-11-17 15:39:54 -0800 | [diff] [blame] | 282 | // For android.hardware.foo@1.0::*, this will be in namespace |
| 283 | // android::hardware::foo::V1_0 |
Steven Moreland | 6ec9eb9 | 2018-02-16 14:21:49 -0800 | [diff] [blame] | 284 | virtual void emitPackageTypeDeclarations(Formatter& out) const; |
Andreas Huber | e3f769a | 2016-10-10 10:54:44 -0700 | [diff] [blame] | 285 | |
Yifan Hong | 244e82d | 2016-11-11 11:13:57 -0800 | [diff] [blame] | 286 | // Emit any declarations pertaining to this type that have to be |
| 287 | // at global scope for transport, e.g. read/writeEmbeddedTo/FromParcel |
Steven Moreland | 4b8f7a1 | 2017-11-17 15:39:54 -0800 | [diff] [blame] | 288 | // For android.hardware.foo@1.0::*, this will be in namespace |
| 289 | // android::hardware::foo::V1_0 |
Steven Moreland | 6ec9eb9 | 2018-02-16 14:21:49 -0800 | [diff] [blame] | 290 | virtual void emitPackageHwDeclarations(Formatter& out) const; |
Yifan Hong | 244e82d | 2016-11-11 11:13:57 -0800 | [diff] [blame] | 291 | |
Steven Moreland | 6ec9eb9 | 2018-02-16 14:21:49 -0800 | [diff] [blame] | 292 | virtual void emitTypeDefinitions(Formatter& out, const std::string& prefix) const; |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 293 | |
Steven Moreland | 6ec9eb9 | 2018-02-16 14:21:49 -0800 | [diff] [blame] | 294 | virtual void emitJavaTypeDeclarations(Formatter& out, bool atTopLevel) const; |
Andreas Huber | 2831d51 | 2016-08-15 09:33:47 -0700 | [diff] [blame] | 295 | |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 296 | virtual bool needsEmbeddedReadWrite() const; |
| 297 | virtual bool resultNeedsDeref() const; |
| 298 | |
Timur Iskhakov | 5dc72fe | 2017-09-07 23:13:44 -0700 | [diff] [blame] | 299 | bool needsResolveReferences() const; |
| 300 | bool needsResolveReferences(std::unordered_set<const Type*>* visited) const; |
| 301 | virtual bool deepNeedsResolveReferences(std::unordered_set<const Type*>* visited) const; |
| 302 | |
Zhuoyao Zhang | 5158db4 | 2016-08-10 10:25:20 -0700 | [diff] [blame] | 303 | // Generates type declaration for vts proto file. |
| 304 | // TODO (b/30844146): make it a pure virtual method. |
Steven Moreland | 6ec9eb9 | 2018-02-16 14:21:49 -0800 | [diff] [blame] | 305 | virtual void emitVtsTypeDeclarations(Formatter& out) const; |
Zhuoyao Zhang | 864c771 | 2016-08-16 15:35:28 -0700 | [diff] [blame] | 306 | // Generates type declaration as attribute of method (return value or method |
| 307 | // argument) or attribute of compound type for vts proto file. |
Steven Moreland | 6ec9eb9 | 2018-02-16 14:21:49 -0800 | [diff] [blame] | 308 | virtual void emitVtsAttributeType(Formatter& out) const; |
Zhuoyao Zhang | 5158db4 | 2016-08-10 10:25:20 -0700 | [diff] [blame] | 309 | |
Andreas Huber | 70a59e1 | 2016-08-16 12:57:01 -0700 | [diff] [blame] | 310 | // Returns true iff this type is supported through the Java backend. |
Timur Iskhakov | 5dc72fe | 2017-09-07 23:13:44 -0700 | [diff] [blame] | 311 | bool isJavaCompatible() const; |
| 312 | bool isJavaCompatible(std::unordered_set<const Type*>* visited) const; |
| 313 | virtual bool deepIsJavaCompatible(std::unordered_set<const Type*>* visited) const; |
| 314 | // Returns true iff type contains pointer |
| 315 | // (excluding methods and inner types). |
| 316 | bool containsPointer() const; |
| 317 | bool containsPointer(std::unordered_set<const Type*>* visited) const; |
| 318 | virtual bool deepContainsPointer(std::unordered_set<const Type*>* visited) const; |
| 319 | |
Andreas Huber | 85eabdb | 2016-08-25 11:24:49 -0700 | [diff] [blame] | 320 | virtual void getAlignmentAndSize(size_t *align, size_t *size) const; |
| 321 | |
Andreas Huber | 019d21d | 2016-10-03 12:59:47 -0700 | [diff] [blame] | 322 | virtual void appendToExportedTypesVector( |
| 323 | std::vector<const Type *> *exportedTypes) const; |
| 324 | |
Steven Moreland | 6ec9eb9 | 2018-02-16 14:21:49 -0800 | [diff] [blame] | 325 | virtual void emitExportedHeader(Formatter& out, bool forJava) const; |
Andreas Huber | 019d21d | 2016-10-03 12:59:47 -0700 | [diff] [blame] | 326 | |
Timur Iskhakov | ff5e64a | 2017-09-11 14:56:18 -0700 | [diff] [blame] | 327 | virtual bool isNeverStrongReference() const; |
| 328 | |
| 329 | protected: |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 330 | void handleError(Formatter &out, ErrorMode mode) const; |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 331 | |
| 332 | void emitReaderWriterEmbeddedForTypeName( |
| 333 | Formatter &out, |
| 334 | const std::string &name, |
| 335 | bool nameIsPointer, |
| 336 | const std::string &parcelObj, |
| 337 | bool parcelObjIsPointer, |
| 338 | bool isReader, |
| 339 | ErrorMode mode, |
| 340 | const std::string &parentName, |
| 341 | const std::string &offsetText, |
| 342 | const std::string &typeName, |
Yifan Hong | 244e82d | 2016-11-11 11:13:57 -0800 | [diff] [blame] | 343 | const std::string &childName, |
| 344 | const std::string &funcNamespace) const; |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 345 | |
Andreas Huber | 2831d51 | 2016-08-15 09:33:47 -0700 | [diff] [blame] | 346 | void emitJavaReaderWriterWithSuffix( |
| 347 | Formatter &out, |
| 348 | const std::string &parcelObj, |
| 349 | const std::string &argName, |
| 350 | bool isReader, |
| 351 | const std::string &suffix, |
| 352 | const std::string &extra) const; |
| 353 | |
Yifan Hong | f5cc2f7 | 2017-01-04 18:02:34 -0800 | [diff] [blame] | 354 | void emitDumpWithMethod( |
| 355 | Formatter &out, |
| 356 | const std::string &streamName, |
| 357 | const std::string &methodName, |
| 358 | const std::string &name) const; |
| 359 | |
Timur Iskhakov | 35930c4 | 2017-08-28 18:49:54 -0700 | [diff] [blame] | 360 | private: |
| 361 | bool mIsPostParseCompleted = false; |
Timur Iskhakov | 63f3990 | 2017-08-29 15:47:29 -0700 | [diff] [blame] | 362 | Scope* const mParent; |
Timur Iskhakov | 35930c4 | 2017-08-28 18:49:54 -0700 | [diff] [blame] | 363 | |
Andreas Huber | c9410c7 | 2016-07-28 12:18:40 -0700 | [diff] [blame] | 364 | DISALLOW_COPY_AND_ASSIGN(Type); |
| 365 | }; |
| 366 | |
Yifan Hong | bf459bc | 2016-08-23 16:50:37 -0700 | [diff] [blame] | 367 | /* Base type for VectorType and RefType. */ |
| 368 | struct TemplatedType : public Type { |
Timur Iskhakov | 505316c | 2017-08-05 03:38:59 +0000 | [diff] [blame] | 369 | void setElementType(const Reference<Type>& elementType); |
Timur Iskhakov | 24e605b | 2017-08-30 14:02:55 -0700 | [diff] [blame] | 370 | const Type* getElementType() const; |
Timur Iskhakov | cec46c4 | 2017-08-09 00:22:02 -0700 | [diff] [blame] | 371 | |
Timur Iskhakov | 3f1d26e | 2017-08-30 15:35:53 -0700 | [diff] [blame] | 372 | virtual std::string templatedTypeName() const = 0; |
| 373 | std::string typeName() const override; |
| 374 | |
Timur Iskhakov | 33431e6 | 2017-08-21 17:31:23 -0700 | [diff] [blame] | 375 | bool isTemplatedType() const override; |
| 376 | |
Timur Iskhakov | 24e605b | 2017-08-30 14:02:55 -0700 | [diff] [blame] | 377 | virtual bool isCompatibleElementType(const Type* elementType) const = 0; |
Timur Iskhakov | 33431e6 | 2017-08-21 17:31:23 -0700 | [diff] [blame] | 378 | |
Timur Iskhakov | b58f418 | 2017-08-29 15:19:24 -0700 | [diff] [blame] | 379 | std::vector<const Reference<Type>*> getReferences() const override; |
Timur Iskhakov | 33431e6 | 2017-08-21 17:31:23 -0700 | [diff] [blame] | 380 | |
Timur Iskhakov | cec46c4 | 2017-08-09 00:22:02 -0700 | [diff] [blame] | 381 | virtual status_t validate() const override; |
| 382 | |
Steven Moreland | 6ec9eb9 | 2018-02-16 14:21:49 -0800 | [diff] [blame] | 383 | void emitVtsTypeDeclarations(Formatter& out) const override; |
| 384 | void emitVtsAttributeType(Formatter& out) const override; |
Timur Iskhakov | 33431e6 | 2017-08-21 17:31:23 -0700 | [diff] [blame] | 385 | |
Timur Iskhakov | cec46c4 | 2017-08-09 00:22:02 -0700 | [diff] [blame] | 386 | protected: |
Timur Iskhakov | 63f3990 | 2017-08-29 15:47:29 -0700 | [diff] [blame] | 387 | TemplatedType(Scope* parent); |
Timur Iskhakov | 505316c | 2017-08-05 03:38:59 +0000 | [diff] [blame] | 388 | Reference<Type> mElementType; |
| 389 | |
| 390 | private: |
Yifan Hong | bf459bc | 2016-08-23 16:50:37 -0700 | [diff] [blame] | 391 | DISALLOW_COPY_AND_ASSIGN(TemplatedType); |
| 392 | }; |
| 393 | |
Andreas Huber | c9410c7 | 2016-07-28 12:18:40 -0700 | [diff] [blame] | 394 | } // namespace android |
| 395 | |
| 396 | #endif // TYPE_H_ |
| 397 | |