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 | #include "StringType.h" |
| 18 | |
Andreas Huber | 6755e9d | 2017-04-06 11:09:07 -0700 | [diff] [blame] | 19 | #include "HidlTypeAssertion.h" |
| 20 | |
Iliyan Malchev | a72e0d2 | 2016-09-09 11:03:08 -0700 | [diff] [blame] | 21 | #include <hidl-util/Formatter.h> |
Andreas Huber | c9410c7 | 2016-07-28 12:18:40 -0700 | [diff] [blame] | 22 | |
| 23 | namespace android { |
| 24 | |
Timur Iskhakov | 63f3990 | 2017-08-29 15:47:29 -0700 | [diff] [blame] | 25 | StringType::StringType(Scope* parent) : Type(parent) {} |
Andreas Huber | c9410c7 | 2016-07-28 12:18:40 -0700 | [diff] [blame] | 26 | |
Yifan Hong | abf73ee | 2016-12-05 18:47:00 -0800 | [diff] [blame] | 27 | bool StringType::isString() const { |
| 28 | return true; |
| 29 | } |
| 30 | |
Timur Iskhakov | 5dc72fe | 2017-09-07 23:13:44 -0700 | [diff] [blame] | 31 | bool StringType::deepCanCheckEquality(std::unordered_set<const Type*>* /* visited */) const { |
Yifan Hong | c6752dc | 2016-12-20 14:00:14 -0800 | [diff] [blame] | 32 | return true; |
| 33 | } |
| 34 | |
Steven Moreland | 0ecc7b8 | 2017-07-19 12:59:23 -0700 | [diff] [blame] | 35 | std::string StringType::typeName() const { |
| 36 | return "string"; |
| 37 | } |
| 38 | |
Steven Moreland | 979e099 | 2016-09-07 09:18:08 -0700 | [diff] [blame] | 39 | std::string StringType::getCppType(StorageMode mode, |
Steven Moreland | 979e099 | 2016-09-07 09:18:08 -0700 | [diff] [blame] | 40 | bool specifyNamespaces) const { |
Steven Moreland | 979e099 | 2016-09-07 09:18:08 -0700 | [diff] [blame] | 41 | const std::string base = |
| 42 | std::string(specifyNamespaces ? "::android::hardware::" : "") |
| 43 | + "hidl_string"; |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 44 | |
| 45 | switch (mode) { |
| 46 | case StorageMode_Stack: |
| 47 | return base; |
| 48 | |
| 49 | case StorageMode_Argument: |
| 50 | return "const " + base + "&"; |
| 51 | |
| 52 | case StorageMode_Result: |
| 53 | return "const " + base + "*"; |
| 54 | } |
| 55 | } |
| 56 | |
Yifan Hong | 4ed1347 | 2016-11-02 10:44:11 -0700 | [diff] [blame] | 57 | std::string StringType::getJavaType(bool /* forInitializer */) const { |
Andreas Huber | 2831d51 | 2016-08-15 09:33:47 -0700 | [diff] [blame] | 58 | return "String"; |
| 59 | } |
| 60 | |
| 61 | std::string StringType::getJavaSuffix() const { |
| 62 | return "String"; |
| 63 | } |
| 64 | |
Zhuoyao Zhang | c5ea9f5 | 2016-10-06 15:05:39 -0700 | [diff] [blame] | 65 | std::string StringType::getVtsType() const { |
| 66 | return "TYPE_STRING"; |
| 67 | } |
| 68 | |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 69 | void StringType::emitReaderWriter( |
| 70 | Formatter &out, |
| 71 | const std::string &name, |
| 72 | const std::string &parcelObj, |
| 73 | bool parcelObjIsPointer, |
| 74 | bool isReader, |
| 75 | ErrorMode mode) const { |
Iliyan Malchev | 549e259 | 2016-08-10 08:59:12 -0700 | [diff] [blame] | 76 | const std::string parentName = "_hidl_" + name + "_parent"; |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 77 | out << "size_t " << parentName << ";\n\n"; |
| 78 | |
| 79 | const std::string parcelObjDeref = |
| 80 | parcelObj + (parcelObjIsPointer ? "->" : "."); |
| 81 | |
| 82 | if (isReader) { |
Martijn Coenen | 6a082c6 | 2017-01-11 12:47:02 +0100 | [diff] [blame] | 83 | out << "_hidl_err = " |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 84 | << parcelObjDeref |
Martijn Coenen | b2a861c | 2017-04-18 15:54:25 -0700 | [diff] [blame] | 85 | << "readBuffer(" |
| 86 | << "sizeof(*" |
| 87 | << name |
| 88 | << "), &" |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 89 | << parentName |
Martijn Coenen | 6a082c6 | 2017-01-11 12:47:02 +0100 | [diff] [blame] | 90 | << ", " |
| 91 | << " reinterpret_cast<const void **>(" |
| 92 | << "&" << name |
| 93 | << "));\n\n"; |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 94 | |
Martijn Coenen | 6a082c6 | 2017-01-11 12:47:02 +0100 | [diff] [blame] | 95 | handleError(out, mode); |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 96 | } else { |
Iliyan Malchev | 549e259 | 2016-08-10 08:59:12 -0700 | [diff] [blame] | 97 | out << "_hidl_err = " |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 98 | << parcelObjDeref |
| 99 | << "writeBuffer(&" |
| 100 | << name |
| 101 | << ", sizeof(" |
| 102 | << name |
| 103 | << "), &" |
| 104 | << parentName |
| 105 | << ");\n"; |
| 106 | |
| 107 | handleError(out, mode); |
| 108 | } |
| 109 | |
| 110 | emitReaderWriterEmbedded( |
| 111 | out, |
Andreas Huber | f9d49f1 | 2016-09-12 14:58:36 -0700 | [diff] [blame] | 112 | 0 /* depth */, |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 113 | name, |
Yifan Hong | be2a373 | 2016-10-05 13:33:41 -0700 | [diff] [blame] | 114 | name /* sanitizedName */, |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 115 | isReader /* nameIsPointer */, |
| 116 | parcelObj, |
| 117 | parcelObjIsPointer, |
| 118 | isReader, |
| 119 | mode, |
| 120 | parentName, |
| 121 | "0 /* parentOffset */"); |
| 122 | } |
| 123 | |
| 124 | void StringType::emitReaderWriterEmbedded( |
| 125 | Formatter &out, |
Andreas Huber | f9d49f1 | 2016-09-12 14:58:36 -0700 | [diff] [blame] | 126 | size_t /* depth */, |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 127 | const std::string &name, |
Yifan Hong | be2a373 | 2016-10-05 13:33:41 -0700 | [diff] [blame] | 128 | const std::string & /*sanitizedName*/, |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 129 | bool nameIsPointer, |
| 130 | const std::string &parcelObj, |
| 131 | bool parcelObjIsPointer, |
| 132 | bool isReader, |
| 133 | ErrorMode mode, |
| 134 | const std::string &parentName, |
| 135 | const std::string &offsetText) const { |
| 136 | emitReaderWriterEmbeddedForTypeName( |
| 137 | out, |
| 138 | name, |
| 139 | nameIsPointer, |
| 140 | parcelObj, |
| 141 | parcelObjIsPointer, |
| 142 | isReader, |
| 143 | mode, |
| 144 | parentName, |
| 145 | offsetText, |
Andreas Huber | 8a82ff7 | 2016-08-04 10:29:39 -0700 | [diff] [blame] | 146 | "::android::hardware::hidl_string", |
Yifan Hong | 244e82d | 2016-11-11 11:13:57 -0800 | [diff] [blame] | 147 | "" /* childName */, |
| 148 | "::android::hardware"); |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 149 | } |
| 150 | |
Andreas Huber | 85eabdb | 2016-08-25 11:24:49 -0700 | [diff] [blame] | 151 | void StringType::emitJavaFieldInitializer( |
| 152 | Formatter &out, const std::string &fieldName) const { |
Nirav Atre | 66842a9 | 2018-06-28 18:14:13 -0700 | [diff] [blame] | 153 | emitJavaFieldDefaultInitialValue(out, "String " + fieldName); |
| 154 | } |
| 155 | |
| 156 | void StringType::emitJavaFieldDefaultInitialValue( |
| 157 | Formatter &out, const std::string &declaredFieldName) const { |
| 158 | out << declaredFieldName << " = new String();\n"; |
Andreas Huber | 85eabdb | 2016-08-25 11:24:49 -0700 | [diff] [blame] | 159 | } |
| 160 | |
| 161 | void StringType::emitJavaFieldReaderWriter( |
| 162 | Formatter &out, |
Andreas Huber | 4c865b7 | 2016-09-14 15:26:27 -0700 | [diff] [blame] | 163 | size_t /* depth */, |
Andreas Huber | 709b62d | 2016-09-19 11:21:18 -0700 | [diff] [blame] | 164 | const std::string &parcelName, |
Andreas Huber | 85eabdb | 2016-08-25 11:24:49 -0700 | [diff] [blame] | 165 | const std::string &blobName, |
| 166 | const std::string &fieldName, |
| 167 | const std::string &offset, |
| 168 | bool isReader) const { |
| 169 | if (isReader) { |
Martijn Coenen | b2a861c | 2017-04-18 15:54:25 -0700 | [diff] [blame] | 170 | out << fieldName |
| 171 | << " = " |
| 172 | << blobName |
| 173 | << ".getString(" |
| 174 | << offset |
| 175 | << ");\n"; |
| 176 | |
Andreas Huber | 709b62d | 2016-09-19 11:21:18 -0700 | [diff] [blame] | 177 | out << "\n" |
| 178 | << parcelName |
| 179 | << ".readEmbeddedBuffer(\n"; |
Andreas Huber | 85eabdb | 2016-08-25 11:24:49 -0700 | [diff] [blame] | 180 | |
| 181 | out.indent(); |
| 182 | out.indent(); |
| 183 | |
Martijn Coenen | 011bb06 | 2017-01-13 11:09:41 +0100 | [diff] [blame] | 184 | // hidl_string's embedded buffer is never null(able), because it defaults to a |
| 185 | // buffer containing an empty string. |
Nirav Atre | 66842a9 | 2018-06-28 18:14:13 -0700 | [diff] [blame] | 186 | out << "(" << getJavaTypeCast(fieldName) << ").getBytes().length + 1,\n" |
Martijn Coenen | b2a861c | 2017-04-18 15:54:25 -0700 | [diff] [blame] | 187 | << blobName |
Andreas Huber | 85eabdb | 2016-08-25 11:24:49 -0700 | [diff] [blame] | 188 | << ".handle(),\n" |
| 189 | << offset |
Martijn Coenen | 011bb06 | 2017-01-13 11:09:41 +0100 | [diff] [blame] | 190 | << " + 0 /* offsetof(hidl_string, mBuffer) */," |
| 191 | << "false /* nullable */);\n\n"; |
Andreas Huber | 85eabdb | 2016-08-25 11:24:49 -0700 | [diff] [blame] | 192 | |
| 193 | out.unindent(); |
| 194 | out.unindent(); |
| 195 | |
Andreas Huber | 85eabdb | 2016-08-25 11:24:49 -0700 | [diff] [blame] | 196 | return; |
| 197 | } |
| 198 | |
| 199 | out << blobName |
| 200 | << ".putString(" |
| 201 | << offset |
| 202 | << ", " |
| 203 | << fieldName |
| 204 | << ");\n"; |
| 205 | } |
| 206 | |
Andreas Huber | 881227d | 2016-08-02 14:20:21 -0700 | [diff] [blame] | 207 | bool StringType::needsEmbeddedReadWrite() const { |
| 208 | return true; |
| 209 | } |
| 210 | |
| 211 | bool StringType::resultNeedsDeref() const { |
| 212 | return true; |
| 213 | } |
| 214 | |
Steven Moreland | 6ec9eb9 | 2018-02-16 14:21:49 -0800 | [diff] [blame] | 215 | void StringType::emitVtsTypeDeclarations(Formatter& out) const { |
Zhuoyao Zhang | ae83dcd | 2016-11-29 12:48:28 -0800 | [diff] [blame] | 216 | out << "type: " << getVtsType() << "\n"; |
Zhuoyao Zhang | 5158db4 | 2016-08-10 10:25:20 -0700 | [diff] [blame] | 217 | } |
| 218 | |
Andreas Huber | 6755e9d | 2017-04-06 11:09:07 -0700 | [diff] [blame] | 219 | static HidlTypeAssertion assertion("hidl_string", 16 /* size */); |
Andreas Huber | 85eabdb | 2016-08-25 11:24:49 -0700 | [diff] [blame] | 220 | void StringType::getAlignmentAndSize(size_t *align, size_t *size) const { |
| 221 | *align = 8; // hidl_string |
Andreas Huber | 6755e9d | 2017-04-06 11:09:07 -0700 | [diff] [blame] | 222 | *size = assertion.size(); |
Andreas Huber | 85eabdb | 2016-08-25 11:24:49 -0700 | [diff] [blame] | 223 | } |
| 224 | |
Andreas Huber | c9410c7 | 2016-07-28 12:18:40 -0700 | [diff] [blame] | 225 | } // namespace android |
| 226 | |