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