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 COMPOUND_TYPE_H_ |
| 18 | |
| 19 | #define COMPOUND_TYPE_H_ |
| 20 | |
Timur Iskhakov | 505316c | 2017-08-05 03:38:59 +0000 | [diff] [blame] | 21 | #include "Reference.h" |
Andreas Huber | c9410c7 | 2016-07-28 12:18:40 -0700 | [diff] [blame] | 22 | #include "Scope.h" |
| 23 | |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 24 | #include <vector> |
Andreas Huber | c9410c7 | 2016-07-28 12:18:40 -0700 | [diff] [blame] | 25 | |
| 26 | namespace android { |
| 27 | |
Andreas Huber | c9410c7 | 2016-07-28 12:18:40 -0700 | [diff] [blame] | 28 | struct CompoundType : public Scope { |
| 29 | enum Style { |
| 30 | STYLE_STRUCT, |
| 31 | STYLE_UNION, |
Nirav Atre | 0ab8265 | 2018-06-04 11:49:14 -0700 | [diff] [blame] | 32 | STYLE_SAFE_UNION, |
Andreas Huber | c9410c7 | 2016-07-28 12:18:40 -0700 | [diff] [blame] | 33 | }; |
| 34 | |
Timur Iskhakov | 565b013 | 2017-09-06 18:07:11 -0700 | [diff] [blame] | 35 | CompoundType(Style style, const char* localName, const FQName& fullName, |
| 36 | const Location& location, Scope* parent); |
Andreas Huber | c9410c7 | 2016-07-28 12:18:40 -0700 | [diff] [blame] | 37 | |
Yifan Hong | 27e85db | 2016-11-09 15:45:52 -0800 | [diff] [blame] | 38 | Style style() const; |
| 39 | |
Timur Iskhakov | cec46c4 | 2017-08-09 00:22:02 -0700 | [diff] [blame] | 40 | void setFields(std::vector<NamedReference<Type>*>* fields); |
Andreas Huber | c9410c7 | 2016-07-28 12:18:40 -0700 | [diff] [blame] | 41 | |
Andreas Huber | f630bc8 | 2016-09-09 14:52:25 -0700 | [diff] [blame] | 42 | bool isCompoundType() const override; |
| 43 | |
Timur Iskhakov | 5dc72fe | 2017-09-07 23:13:44 -0700 | [diff] [blame] | 44 | bool deepCanCheckEquality(std::unordered_set<const Type*>* visited) const override; |
Yifan Hong | c6752dc | 2016-12-20 14:00:14 -0800 | [diff] [blame] | 45 | |
Steven Moreland | 0ecc7b8 | 2017-07-19 12:59:23 -0700 | [diff] [blame] | 46 | std::string typeName() const override; |
| 47 | |
Timur Iskhakov | b58f418 | 2017-08-29 15:19:24 -0700 | [diff] [blame] | 48 | std::vector<const Reference<Type>*> getReferences() const override; |
Timur Iskhakov | 33431e6 | 2017-08-21 17:31:23 -0700 | [diff] [blame] | 49 | |
Timur Iskhakov | cec46c4 | 2017-08-09 00:22:02 -0700 | [diff] [blame] | 50 | status_t validate() const override; |
| 51 | status_t validateUniqueNames() const; |
Nirav Atre | 0ab8265 | 2018-06-04 11:49:14 -0700 | [diff] [blame] | 52 | status_t validateSubTypeNames() const; |
Timur Iskhakov | cec46c4 | 2017-08-09 00:22:02 -0700 | [diff] [blame] | 53 | |
Steven Moreland | 979e099 | 2016-09-07 09:18:08 -0700 | [diff] [blame] | 54 | std::string getCppType(StorageMode mode, |
Steven Moreland | 979e099 | 2016-09-07 09:18:08 -0700 | [diff] [blame] | 55 | bool specifyNamespaces) const override; |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 56 | |
Yifan Hong | 4ed1347 | 2016-11-02 10:44:11 -0700 | [diff] [blame] | 57 | std::string getJavaType(bool forInitializer) const override; |
Andreas Huber | 85eabdb | 2016-08-25 11:24:49 -0700 | [diff] [blame] | 58 | |
Zhuoyao Zhang | c5ea9f5 | 2016-10-06 15:05:39 -0700 | [diff] [blame] | 59 | std::string getVtsType() const override; |
| 60 | |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 61 | void emitReaderWriter( |
| 62 | Formatter &out, |
| 63 | const std::string &name, |
| 64 | const std::string &parcelObj, |
| 65 | bool parcelObjIsPointer, |
| 66 | bool isReader, |
| 67 | ErrorMode mode) const override; |
| 68 | |
| 69 | void emitReaderWriterEmbedded( |
| 70 | Formatter &out, |
Andreas Huber | f9d49f1 | 2016-09-12 14:58:36 -0700 | [diff] [blame] | 71 | size_t depth, |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 72 | const std::string &name, |
Yifan Hong | be2a373 | 2016-10-05 13:33:41 -0700 | [diff] [blame] | 73 | const std::string &sanitizedName, |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 74 | bool nameIsPointer, |
| 75 | const std::string &parcelObj, |
| 76 | bool parcelObjIsPointer, |
| 77 | bool isReader, |
| 78 | ErrorMode mode, |
| 79 | const std::string &parentName, |
| 80 | const std::string &offsetText) const override; |
| 81 | |
Yifan Hong | bf459bc | 2016-08-23 16:50:37 -0700 | [diff] [blame] | 82 | void emitResolveReferences( |
| 83 | Formatter &out, |
| 84 | const std::string &name, |
| 85 | bool nameIsPointer, |
| 86 | const std::string &parcelObj, |
| 87 | bool parcelObjIsPointer, |
| 88 | bool isReader, |
| 89 | ErrorMode mode) const override; |
| 90 | |
| 91 | void emitResolveReferencesEmbedded( |
| 92 | Formatter &out, |
| 93 | size_t depth, |
| 94 | const std::string &name, |
| 95 | const std::string &sanitizedName, |
| 96 | bool nameIsPointer, |
| 97 | const std::string &parcelObj, |
| 98 | bool parcelObjIsPointer, |
| 99 | bool isReader, |
| 100 | ErrorMode mode, |
| 101 | const std::string &parentName, |
| 102 | const std::string &offsetText) const override; |
| 103 | |
Andreas Huber | 85eabdb | 2016-08-25 11:24:49 -0700 | [diff] [blame] | 104 | void emitJavaReaderWriter( |
| 105 | Formatter &out, |
| 106 | const std::string &parcelObj, |
| 107 | const std::string &argName, |
| 108 | bool isReader) const override; |
| 109 | |
| 110 | void emitJavaFieldInitializer( |
| 111 | Formatter &out, const std::string &fieldName) const override; |
| 112 | |
Nirav Atre | 66842a9 | 2018-06-28 18:14:13 -0700 | [diff] [blame] | 113 | void emitJavaFieldDefaultInitialValue( |
| 114 | Formatter &out, const std::string &declaredFieldName) const override; |
| 115 | |
Andreas Huber | 85eabdb | 2016-08-25 11:24:49 -0700 | [diff] [blame] | 116 | void emitJavaFieldReaderWriter( |
| 117 | Formatter &out, |
Andreas Huber | 4c865b7 | 2016-09-14 15:26:27 -0700 | [diff] [blame] | 118 | size_t depth, |
Andreas Huber | 709b62d | 2016-09-19 11:21:18 -0700 | [diff] [blame] | 119 | const std::string &parcelName, |
Andreas Huber | 85eabdb | 2016-08-25 11:24:49 -0700 | [diff] [blame] | 120 | const std::string &blobName, |
| 121 | const std::string &fieldName, |
| 122 | const std::string &offset, |
| 123 | bool isReader) const override; |
| 124 | |
Steven Moreland | 6ec9eb9 | 2018-02-16 14:21:49 -0800 | [diff] [blame] | 125 | void emitTypeDeclarations(Formatter& out) const override; |
Timur Iskhakov | fd3f250 | 2017-09-05 16:25:02 -0700 | [diff] [blame] | 126 | void emitTypeForwardDeclaration(Formatter& out) const override; |
Steven Moreland | 6ec9eb9 | 2018-02-16 14:21:49 -0800 | [diff] [blame] | 127 | void emitPackageTypeDeclarations(Formatter& out) const override; |
Steven Moreland | 09c6ebe | 2018-10-09 10:15:48 -0700 | [diff] [blame] | 128 | void emitPackageTypeHeaderDefinitions(Formatter& out) const override; |
Steven Moreland | 6ec9eb9 | 2018-02-16 14:21:49 -0800 | [diff] [blame] | 129 | void emitPackageHwDeclarations(Formatter& out) const override; |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 130 | |
Steven Moreland | 6ec9eb9 | 2018-02-16 14:21:49 -0800 | [diff] [blame] | 131 | void emitTypeDefinitions(Formatter& out, const std::string& prefix) const override; |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 132 | |
Steven Moreland | 6ec9eb9 | 2018-02-16 14:21:49 -0800 | [diff] [blame] | 133 | void emitJavaTypeDeclarations(Formatter& out, bool atTopLevel) const override; |
Andreas Huber | 85eabdb | 2016-08-25 11:24:49 -0700 | [diff] [blame] | 134 | |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 135 | bool needsEmbeddedReadWrite() const override; |
Timur Iskhakov | 5dc72fe | 2017-09-07 23:13:44 -0700 | [diff] [blame] | 136 | bool deepNeedsResolveReferences(std::unordered_set<const Type*>* visited) const override; |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 137 | bool resultNeedsDeref() const override; |
| 138 | |
Steven Moreland | 6ec9eb9 | 2018-02-16 14:21:49 -0800 | [diff] [blame] | 139 | void emitVtsTypeDeclarations(Formatter& out) const override; |
| 140 | void emitVtsAttributeType(Formatter& out) const override; |
Zhuoyao Zhang | 5158db4 | 2016-08-10 10:25:20 -0700 | [diff] [blame] | 141 | |
Timur Iskhakov | 5dc72fe | 2017-09-07 23:13:44 -0700 | [diff] [blame] | 142 | bool deepIsJavaCompatible(std::unordered_set<const Type*>* visited) const override; |
| 143 | bool deepContainsPointer(std::unordered_set<const Type*>* visited) const override; |
Andreas Huber | 70a59e1 | 2016-08-16 12:57:01 -0700 | [diff] [blame] | 144 | |
Andreas Huber | 85eabdb | 2016-08-25 11:24:49 -0700 | [diff] [blame] | 145 | void getAlignmentAndSize(size_t *align, size_t *size) const; |
| 146 | |
Howard Chen | ecfb451 | 2017-11-21 18:28:53 +0800 | [diff] [blame] | 147 | bool containsInterface() const; |
Andreas Huber | c9410c7 | 2016-07-28 12:18:40 -0700 | [diff] [blame] | 148 | private: |
Nirav Atre | 0ab8265 | 2018-06-04 11:49:14 -0700 | [diff] [blame] | 149 | |
| 150 | struct Layout { |
| 151 | size_t offset; |
| 152 | size_t align; |
| 153 | size_t size; |
| 154 | |
| 155 | Layout() : offset(0), align(1), size(0) {} |
| 156 | static size_t getPad(size_t offset, size_t align); |
| 157 | }; |
| 158 | |
| 159 | struct CompoundLayout { |
| 160 | Layout overall; |
| 161 | Layout innerStruct; |
| 162 | Layout discriminator; |
| 163 | }; |
| 164 | |
Andreas Huber | c9410c7 | 2016-07-28 12:18:40 -0700 | [diff] [blame] | 165 | Style mStyle; |
Timur Iskhakov | 7fa79f6 | 2017-08-09 11:04:54 -0700 | [diff] [blame] | 166 | std::vector<NamedReference<Type>*>* mFields; |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 167 | |
Nirav Atre | 0ab8265 | 2018-06-04 11:49:14 -0700 | [diff] [blame] | 168 | void emitLayoutAsserts(Formatter& out, const Layout& localLayout, |
| 169 | const std::string& localLayoutName) const; |
| 170 | |
| 171 | void emitInvalidSubTypeNamesError(const std::string& subTypeName, |
| 172 | const Location& location) const; |
| 173 | |
| 174 | void emitSafeUnionTypeDefinitions(Formatter& out) const; |
| 175 | void emitSafeUnionTypeConstructors(Formatter& out) const; |
| 176 | void emitSafeUnionTypeDeclarations(Formatter& out) const; |
| 177 | std::unique_ptr<ScalarType> getUnionDiscriminatorType() const; |
| 178 | |
Steven Moreland | 5add34d | 2018-11-08 16:31:30 -0800 | [diff] [blame] | 179 | void emitSafeUnionUnknownDiscriminatorError(Formatter& out, const std::string& value, |
| 180 | bool fatal) const; |
Nirav Atre | e3cae85 | 2018-07-16 12:19:16 -0700 | [diff] [blame] | 181 | |
Nirav Atre | 64868d3 | 2018-07-15 19:15:18 -0700 | [diff] [blame] | 182 | void emitSafeUnionCopyAndAssignDefinition(Formatter& out, |
| 183 | const std::string& parameterName, |
| 184 | bool isCopyConstructor, |
| 185 | bool usesMoveSemantics) const; |
| 186 | |
Nirav Atre | 71ce008 | 2018-08-01 15:39:49 -0700 | [diff] [blame] | 187 | struct SafeUnionEnumElement { |
| 188 | std::string fieldName; |
| 189 | std::string fieldTypeName; |
| 190 | }; |
| 191 | |
| 192 | std::vector<SafeUnionEnumElement> getSafeUnionEnumElements(bool useCppTypeName) const; |
| 193 | |
Nirav Atre | 0ab8265 | 2018-06-04 11:49:14 -0700 | [diff] [blame] | 194 | CompoundLayout getCompoundAlignmentAndSize() const; |
| 195 | |
Nirav Atre | ca7a502 | 2018-06-29 20:43:49 -0700 | [diff] [blame] | 196 | void emitSafeUnionReaderWriterForInterfaces( |
| 197 | Formatter &out, |
| 198 | const std::string &name, |
| 199 | const std::string &parcelObj, |
| 200 | bool parcelObjIsPointer, |
| 201 | bool isReader, |
| 202 | ErrorMode mode) const; |
| 203 | |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 204 | void emitStructReaderWriter( |
| 205 | Formatter &out, const std::string &prefix, bool isReader) const; |
Chih-Hung Hsieh | 8c90cc5 | 2017-08-03 14:51:13 -0700 | [diff] [blame] | 206 | void emitResolveReferenceDef(Formatter& out, const std::string& prefix, bool isReader) const; |
Andreas Huber | c9410c7 | 2016-07-28 12:18:40 -0700 | [diff] [blame] | 207 | |
| 208 | DISALLOW_COPY_AND_ASSIGN(CompoundType); |
| 209 | }; |
| 210 | |
Andreas Huber | c9410c7 | 2016-07-28 12:18:40 -0700 | [diff] [blame] | 211 | } // namespace android |
| 212 | |
| 213 | #endif // COMPOUND_TYPE_H_ |
| 214 | |