Will McVicker | efd970d | 2019-09-25 15:28:30 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2015, 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 | |
Adam Lesinski | ffa1686 | 2014-01-23 18:17:42 -0800 | [diff] [blame] | 17 | #include "aidl_language.h" |
Jiyong Park | 1deecc3 | 2018-07-17 01:14:41 +0900 | [diff] [blame] | 18 | #include "aidl_typenames.h" |
Jiyong Park | e5c4529 | 2020-05-26 19:06:24 +0900 | [diff] [blame] | 19 | #include "parser.h" |
Christopher Wiley | f690be5 | 2015-09-14 15:19:10 -0700 | [diff] [blame] | 20 | |
Adam Lesinski | ffa1686 | 2014-01-23 18:17:42 -0800 | [diff] [blame] | 21 | #include <stdio.h> |
Adam Lesinski | ffa1686 | 2014-01-23 18:17:42 -0800 | [diff] [blame] | 22 | #include <stdlib.h> |
Christopher Wiley | 4a2884b | 2015-10-07 11:27:45 -0700 | [diff] [blame] | 23 | #include <string.h> |
Jiyong Park | 68bc77a | 2018-07-19 19:00:45 +0900 | [diff] [blame] | 24 | #include <algorithm> |
Jiyong Park | 1deecc3 | 2018-07-17 01:14:41 +0900 | [diff] [blame] | 25 | #include <iostream> |
Jiyong Park | 68bc77a | 2018-07-19 19:00:45 +0900 | [diff] [blame] | 26 | #include <set> |
| 27 | #include <sstream> |
Casey Dahlin | dd69181 | 2015-09-09 17:59:06 -0700 | [diff] [blame] | 28 | #include <string> |
Jiyong Park | 1deecc3 | 2018-07-17 01:14:41 +0900 | [diff] [blame] | 29 | #include <utility> |
Christopher Wiley | f690be5 | 2015-09-14 15:19:10 -0700 | [diff] [blame] | 30 | |
Steven Moreland | 1c4ba20 | 2018-08-09 10:49:54 -0700 | [diff] [blame] | 31 | #include <android-base/parsedouble.h> |
Roshan Pius | 9d7810a | 2016-07-28 08:57:50 -0700 | [diff] [blame] | 32 | #include <android-base/parseint.h> |
Elliott Hughes | 0a62067 | 2015-12-04 13:53:18 -0800 | [diff] [blame] | 33 | #include <android-base/strings.h> |
Christopher Wiley | d76067c | 2015-10-19 17:00:13 -0700 | [diff] [blame] | 34 | |
Dan Willemsen | 609ba6d | 2019-12-30 10:44:00 -0800 | [diff] [blame] | 35 | #include "aidl_language_y-module.h" |
Christopher Wiley | 4a2884b | 2015-10-07 11:27:45 -0700 | [diff] [blame] | 36 | #include "logging.h" |
Adam Lesinski | ffa1686 | 2014-01-23 18:17:42 -0800 | [diff] [blame] | 37 | |
Will McVicker | d7d18df | 2019-09-12 13:40:50 -0700 | [diff] [blame] | 38 | #include "aidl.h" |
| 39 | |
Casey Dahlin | 07b9dde | 2015-09-10 19:13:49 -0700 | [diff] [blame] | 40 | #ifdef _WIN32 |
| 41 | int isatty(int fd) |
| 42 | { |
| 43 | return (fd == 0); |
| 44 | } |
| 45 | #endif |
| 46 | |
Christopher Wiley | 4a2884b | 2015-10-07 11:27:45 -0700 | [diff] [blame] | 47 | using android::aidl::IoDelegate; |
Christopher Wiley | d76067c | 2015-10-19 17:00:13 -0700 | [diff] [blame] | 48 | using android::base::Join; |
Christopher Wiley | 8aa4d9f | 2015-11-16 19:10:45 -0800 | [diff] [blame] | 49 | using android::base::Split; |
Casey Dahlin | dd69181 | 2015-09-09 17:59:06 -0700 | [diff] [blame] | 50 | using std::cerr; |
Jiyong Park | 1deecc3 | 2018-07-17 01:14:41 +0900 | [diff] [blame] | 51 | using std::pair; |
Jiyong Park | 68bc77a | 2018-07-19 19:00:45 +0900 | [diff] [blame] | 52 | using std::set; |
Christopher Wiley | 4a2884b | 2015-10-07 11:27:45 -0700 | [diff] [blame] | 53 | using std::string; |
| 54 | using std::unique_ptr; |
Jiyong Park | ccf00f8 | 2018-07-17 01:39:23 +0900 | [diff] [blame] | 55 | using std::vector; |
Adam Lesinski | ffa1686 | 2014-01-23 18:17:42 -0800 | [diff] [blame] | 56 | |
Jeongik Cha | 047c5ee | 2019-08-07 23:16:49 +0900 | [diff] [blame] | 57 | namespace { |
Jeongik Cha | 997281d | 2020-01-16 15:23:59 +0900 | [diff] [blame] | 58 | bool IsJavaKeyword(const char* str) { |
Jeongik Cha | 047c5ee | 2019-08-07 23:16:49 +0900 | [diff] [blame] | 59 | static const std::vector<std::string> kJavaKeywords{ |
| 60 | "abstract", "assert", "boolean", "break", "byte", "case", "catch", |
| 61 | "char", "class", "const", "continue", "default", "do", "double", |
| 62 | "else", "enum", "extends", "final", "finally", "float", "for", |
| 63 | "goto", "if", "implements", "import", "instanceof", "int", "interface", |
| 64 | "long", "native", "new", "package", "private", "protected", "public", |
| 65 | "return", "short", "static", "strictfp", "super", "switch", "synchronized", |
| 66 | "this", "throw", "throws", "transient", "try", "void", "volatile", |
| 67 | "while", "true", "false", "null", |
| 68 | }; |
| 69 | return std::find(kJavaKeywords.begin(), kJavaKeywords.end(), str) != kJavaKeywords.end(); |
| 70 | } |
Jeongik Cha | 997281d | 2020-01-16 15:23:59 +0900 | [diff] [blame] | 71 | |
Jeongik Cha | 9118025 | 2020-07-31 15:43:11 +0900 | [diff] [blame] | 72 | inline std::string CapitalizeFirstLetter(const std::string& str) { |
| 73 | CHECK(str.size() > 0) << "Input cannot be empty."; |
| 74 | std::ostringstream out; |
| 75 | out << static_cast<char>(toupper(str[0])) << str.substr(1); |
| 76 | return out.str(); |
| 77 | } |
| 78 | |
Jeongik Cha | 997281d | 2020-01-16 15:23:59 +0900 | [diff] [blame] | 79 | void AddHideComment(CodeWriter* writer) { |
| 80 | writer->Write("/* @hide */\n"); |
| 81 | } |
| 82 | |
| 83 | inline bool HasHideComment(const std::string& comment) { |
| 84 | return std::regex_search(comment, std::regex("@hide\\b")); |
| 85 | } |
Jeongik Cha | 047c5ee | 2019-08-07 23:16:49 +0900 | [diff] [blame] | 86 | } // namespace |
| 87 | |
Devin Moore | df93ebb | 2020-03-25 14:03:35 -0700 | [diff] [blame] | 88 | AidlLocation::AidlLocation(const std::string& file, Point begin, Point end, Source source) |
| 89 | : file_(file), begin_(begin), end_(end), source_(source) {} |
Steven Moreland | 46e9da8 | 2018-07-27 15:45:29 -0700 | [diff] [blame] | 90 | |
| 91 | std::ostream& operator<<(std::ostream& os, const AidlLocation& l) { |
Devin Moore | 5de18ed | 2020-04-02 13:52:29 -0700 | [diff] [blame] | 92 | os << l.file_; |
| 93 | if (l.LocationKnown()) { |
| 94 | os << ":" << l.begin_.line << "." << l.begin_.column << "-"; |
| 95 | if (l.begin_.line != l.end_.line) { |
| 96 | os << l.end_.line << "."; |
| 97 | } |
| 98 | os << l.end_.column; |
Steven Moreland | 46e9da8 | 2018-07-27 15:45:29 -0700 | [diff] [blame] | 99 | } |
Steven Moreland | 46e9da8 | 2018-07-27 15:45:29 -0700 | [diff] [blame] | 100 | return os; |
| 101 | } |
| 102 | |
| 103 | AidlNode::AidlNode(const AidlLocation& location) : location_(location) {} |
| 104 | |
Mathew Inwood | adb7467 | 2019-11-29 14:01:53 +0000 | [diff] [blame] | 105 | std::string AidlNode::PrintLine() const { |
Andrei Onea | 8714b02 | 2019-02-01 18:55:54 +0000 | [diff] [blame] | 106 | std::stringstream ss; |
| 107 | ss << location_.file_ << ":" << location_.begin_.line; |
| 108 | return ss.str(); |
| 109 | } |
| 110 | |
Mathew Inwood | adb7467 | 2019-11-29 14:01:53 +0000 | [diff] [blame] | 111 | std::string AidlNode::PrintLocation() const { |
| 112 | std::stringstream ss; |
| 113 | ss << location_.file_ << ":" << location_.begin_.line << ":" << location_.begin_.column << ":" |
| 114 | << location_.end_.line << ":" << location_.end_.column; |
| 115 | return ss.str(); |
| 116 | } |
| 117 | |
Steven Moreland | 0cea4aa | 2020-04-20 21:06:02 -0700 | [diff] [blame] | 118 | const std::vector<AidlAnnotation::Schema>& AidlAnnotation::AllSchemas() { |
| 119 | static const std::vector<Schema> kSchemas{ |
| 120 | {AidlAnnotation::Type::NULLABLE, "nullable", {}}, |
| 121 | {AidlAnnotation::Type::UTF8_IN_CPP, "utf8InCpp", {}}, |
| 122 | {AidlAnnotation::Type::VINTF_STABILITY, "VintfStability", {}}, |
| 123 | {AidlAnnotation::Type::UNSUPPORTED_APP_USAGE, |
| 124 | "UnsupportedAppUsage", |
| 125 | {{"expectedSignature", "String"}, |
| 126 | {"implicitMember", "String"}, |
| 127 | {"maxTargetSdk", "int"}, |
| 128 | {"publicAlternatives", "String"}, |
| 129 | {"trackingBug", "long"}}}, |
| 130 | {AidlAnnotation::Type::JAVA_STABLE_PARCELABLE, "JavaOnlyStableParcelable", {}}, |
| 131 | {AidlAnnotation::Type::HIDE, "Hide", {}}, |
Jiyong Park | bf5fd5c | 2020-06-05 19:48:05 +0900 | [diff] [blame] | 132 | {AidlAnnotation::Type::BACKING, "Backing", {{"type", "String"}}}, |
| 133 | {AidlAnnotation::Type::JAVA_PASSTHROUGH, "JavaPassthrough", {{"annotation", "String"}}}, |
Jiyong Park | 43113fb | 2020-07-20 16:26:19 +0900 | [diff] [blame] | 134 | {AidlAnnotation::Type::JAVA_DEBUG, "JavaDebug", {}}, |
Jeongik Cha | d0a1027 | 2020-08-06 16:33:36 +0900 | [diff] [blame] | 135 | {AidlAnnotation::Type::JAVA_ONLY_IMMUTABLE, "JavaOnlyImmutable", {}}, |
Devin Moore | c7e47a3 | 2020-08-07 10:55:25 -0700 | [diff] [blame] | 136 | {AidlAnnotation::Type::FIXED_SIZE, "FixedSize", {}}, |
Jiyong Park | 27fd7fd | 2020-08-27 16:25:09 +0900 | [diff] [blame] | 137 | {AidlAnnotation::Type::DESCRIPTOR, "Descriptor", {{"value", "String"}}}, |
Jiyong Park | bf5fd5c | 2020-06-05 19:48:05 +0900 | [diff] [blame] | 138 | }; |
Steven Moreland | 0cea4aa | 2020-04-20 21:06:02 -0700 | [diff] [blame] | 139 | return kSchemas; |
| 140 | } |
Jiyong Park | 68bc77a | 2018-07-19 19:00:45 +0900 | [diff] [blame] | 141 | |
Steven Moreland | 0cea4aa | 2020-04-20 21:06:02 -0700 | [diff] [blame] | 142 | std::string AidlAnnotation::TypeToString(Type type) { |
| 143 | for (const Schema& schema : AllSchemas()) { |
| 144 | if (type == schema.type) return schema.name; |
| 145 | } |
| 146 | AIDL_FATAL(AIDL_LOCATION_HERE) << "Unrecognized type: " << static_cast<size_t>(type); |
| 147 | __builtin_unreachable(); |
| 148 | } |
Andrei Onea | 9445fc6 | 2019-06-27 18:11:59 +0100 | [diff] [blame] | 149 | |
| 150 | AidlAnnotation* AidlAnnotation::Parse( |
| 151 | const AidlLocation& location, const string& name, |
| 152 | std::map<std::string, std::shared_ptr<AidlConstantValue>>* parameter_list) { |
Steven Moreland | 0cea4aa | 2020-04-20 21:06:02 -0700 | [diff] [blame] | 153 | const Schema* schema = nullptr; |
| 154 | for (const Schema& a_schema : AllSchemas()) { |
| 155 | if (a_schema.name == name) { |
| 156 | schema = &a_schema; |
| 157 | } |
| 158 | } |
| 159 | |
| 160 | if (schema == nullptr) { |
Jiyong Park | 68bc77a | 2018-07-19 19:00:45 +0900 | [diff] [blame] | 161 | std::ostringstream stream; |
Steven Moreland | 46e9da8 | 2018-07-27 15:45:29 -0700 | [diff] [blame] | 162 | stream << "'" << name << "' is not a recognized annotation. "; |
Jiyong Park | 68bc77a | 2018-07-19 19:00:45 +0900 | [diff] [blame] | 163 | stream << "It must be one of:"; |
Steven Moreland | 0cea4aa | 2020-04-20 21:06:02 -0700 | [diff] [blame] | 164 | for (const Schema& s : AllSchemas()) { |
| 165 | stream << " " << s.name; |
Jiyong Park | 68bc77a | 2018-07-19 19:00:45 +0900 | [diff] [blame] | 166 | } |
| 167 | stream << "."; |
Steven Moreland | 46e9da8 | 2018-07-27 15:45:29 -0700 | [diff] [blame] | 168 | AIDL_ERROR(location) << stream.str(); |
| 169 | return nullptr; |
Jiyong Park | 68bc77a | 2018-07-19 19:00:45 +0900 | [diff] [blame] | 170 | } |
Andrei Onea | 9445fc6 | 2019-06-27 18:11:59 +0100 | [diff] [blame] | 171 | if (parameter_list == nullptr) { |
Steven Moreland | 0cea4aa | 2020-04-20 21:06:02 -0700 | [diff] [blame] | 172 | return new AidlAnnotation(location, *schema, {}); |
Andrei Onea | 9445fc6 | 2019-06-27 18:11:59 +0100 | [diff] [blame] | 173 | } |
| 174 | |
Steven Moreland | 0cea4aa | 2020-04-20 21:06:02 -0700 | [diff] [blame] | 175 | return new AidlAnnotation(location, *schema, std::move(*parameter_list)); |
Jiyong Park | 68bc77a | 2018-07-19 19:00:45 +0900 | [diff] [blame] | 176 | } |
| 177 | |
Andrei Onea | 9445fc6 | 2019-06-27 18:11:59 +0100 | [diff] [blame] | 178 | AidlAnnotation::AidlAnnotation( |
Steven Moreland | 0cea4aa | 2020-04-20 21:06:02 -0700 | [diff] [blame] | 179 | const AidlLocation& location, const Schema& schema, |
Andrei Onea | 9445fc6 | 2019-06-27 18:11:59 +0100 | [diff] [blame] | 180 | std::map<std::string, std::shared_ptr<AidlConstantValue>>&& parameters) |
Steven Moreland | 0cea4aa | 2020-04-20 21:06:02 -0700 | [diff] [blame] | 181 | : AidlNode(location), schema_(schema), parameters_(std::move(parameters)) {} |
Andrei Onea | 9445fc6 | 2019-06-27 18:11:59 +0100 | [diff] [blame] | 182 | |
| 183 | bool AidlAnnotation::CheckValid() const { |
Andrei Onea | 9445fc6 | 2019-06-27 18:11:59 +0100 | [diff] [blame] | 184 | for (const auto& name_and_param : parameters_) { |
| 185 | const std::string& param_name = name_and_param.first; |
| 186 | const std::shared_ptr<AidlConstantValue>& param = name_and_param.second; |
Will McVicker | d7d18df | 2019-09-12 13:40:50 -0700 | [diff] [blame] | 187 | if (!param->CheckValid()) { |
| 188 | AIDL_ERROR(this) << "Invalid value for parameter " << param_name << " on annotation " |
| 189 | << GetName() << "."; |
| 190 | return false; |
| 191 | } |
Steven Moreland | 0cea4aa | 2020-04-20 21:06:02 -0700 | [diff] [blame] | 192 | auto parameter_mapping_it = schema_.supported_parameters.find(param_name); |
| 193 | if (parameter_mapping_it == schema_.supported_parameters.end()) { |
Andrei Onea | 9445fc6 | 2019-06-27 18:11:59 +0100 | [diff] [blame] | 194 | std::ostringstream stream; |
| 195 | stream << "Parameter " << param_name << " not supported "; |
Devin Moore | decaf29 | 2020-04-30 09:16:40 -0700 | [diff] [blame] | 196 | stream << "for annotation " << GetName() << ". "; |
Andrei Onea | 9445fc6 | 2019-06-27 18:11:59 +0100 | [diff] [blame] | 197 | stream << "It must be one of:"; |
Steven Moreland | 0cea4aa | 2020-04-20 21:06:02 -0700 | [diff] [blame] | 198 | for (const auto& kv : schema_.supported_parameters) { |
Andrei Onea | 9445fc6 | 2019-06-27 18:11:59 +0100 | [diff] [blame] | 199 | stream << " " << kv.first; |
| 200 | } |
| 201 | AIDL_ERROR(this) << stream.str(); |
| 202 | return false; |
| 203 | } |
| 204 | AidlTypeSpecifier type{AIDL_LOCATION_HERE, parameter_mapping_it->second, false, nullptr, ""}; |
Will McVicker | d7d18df | 2019-09-12 13:40:50 -0700 | [diff] [blame] | 205 | const std::string param_value = param->ValueString(type, AidlConstantValueDecorator); |
Andrei Onea | 9445fc6 | 2019-06-27 18:11:59 +0100 | [diff] [blame] | 206 | // Assume error on empty string. |
| 207 | if (param_value == "") { |
| 208 | AIDL_ERROR(this) << "Invalid value for parameter " << param_name << " on annotation " |
| 209 | << GetName() << "."; |
| 210 | return false; |
| 211 | } |
| 212 | } |
| 213 | return true; |
| 214 | } |
| 215 | |
| 216 | std::map<std::string, std::string> AidlAnnotation::AnnotationParams( |
| 217 | const ConstantValueDecorator& decorator) const { |
| 218 | std::map<std::string, std::string> raw_params; |
Andrei Onea | 9445fc6 | 2019-06-27 18:11:59 +0100 | [diff] [blame] | 219 | for (const auto& name_and_param : parameters_) { |
| 220 | const std::string& param_name = name_and_param.first; |
| 221 | const std::shared_ptr<AidlConstantValue>& param = name_and_param.second; |
Devin Moore | decaf29 | 2020-04-30 09:16:40 -0700 | [diff] [blame] | 222 | if (schema_.supported_parameters.find(param_name) == schema_.supported_parameters.end()) { |
| 223 | std::ostringstream stream; |
| 224 | stream << "Parameter " << param_name << " not supported "; |
| 225 | stream << "for annotation " << GetName() << ". "; |
| 226 | stream << "It must be one of:"; |
| 227 | for (const auto& kv : schema_.supported_parameters) { |
| 228 | stream << " " << kv.first; |
| 229 | } |
| 230 | AIDL_ERROR(this) << stream.str(); |
| 231 | continue; |
| 232 | } |
Steven Moreland | 0cea4aa | 2020-04-20 21:06:02 -0700 | [diff] [blame] | 233 | AidlTypeSpecifier type{AIDL_LOCATION_HERE, schema_.supported_parameters.at(param_name), false, |
| 234 | nullptr, ""}; |
Will McVicker | d7d18df | 2019-09-12 13:40:50 -0700 | [diff] [blame] | 235 | if (!param->CheckValid()) { |
| 236 | AIDL_ERROR(this) << "Invalid value for parameter " << param_name << " on annotation " |
| 237 | << GetName() << "."; |
Devin Moore | decaf29 | 2020-04-30 09:16:40 -0700 | [diff] [blame] | 238 | continue; |
Will McVicker | d7d18df | 2019-09-12 13:40:50 -0700 | [diff] [blame] | 239 | } |
| 240 | |
| 241 | raw_params.emplace(param_name, param->ValueString(type, decorator)); |
Andrei Onea | 9445fc6 | 2019-06-27 18:11:59 +0100 | [diff] [blame] | 242 | } |
| 243 | return raw_params; |
| 244 | } |
Steven Moreland | 46e9da8 | 2018-07-27 15:45:29 -0700 | [diff] [blame] | 245 | |
Daniel Norman | 37d43dd | 2019-09-09 17:22:34 -0700 | [diff] [blame] | 246 | std::string AidlAnnotation::ToString(const ConstantValueDecorator& decorator) const { |
| 247 | if (parameters_.empty()) { |
| 248 | return "@" + GetName(); |
| 249 | } else { |
| 250 | vector<string> param_strings; |
| 251 | for (const auto& [name, value] : AnnotationParams(decorator)) { |
| 252 | param_strings.emplace_back(name + "=" + value); |
| 253 | } |
| 254 | return "@" + GetName() + "(" + Join(param_strings, ", ") + ")"; |
| 255 | } |
| 256 | } |
| 257 | |
Andrei Onea | 9445fc6 | 2019-06-27 18:11:59 +0100 | [diff] [blame] | 258 | static const AidlAnnotation* GetAnnotation(const vector<AidlAnnotation>& annotations, |
Steven Moreland | 0cea4aa | 2020-04-20 21:06:02 -0700 | [diff] [blame] | 259 | AidlAnnotation::Type type) { |
Andrei Onea | 9445fc6 | 2019-06-27 18:11:59 +0100 | [diff] [blame] | 260 | for (const auto& a : annotations) { |
Steven Moreland | 0cea4aa | 2020-04-20 21:06:02 -0700 | [diff] [blame] | 261 | if (a.GetType() == type) { |
Andrei Onea | 9445fc6 | 2019-06-27 18:11:59 +0100 | [diff] [blame] | 262 | return &a; |
| 263 | } |
| 264 | } |
| 265 | return nullptr; |
| 266 | } |
| 267 | |
Steven Moreland | 46e9da8 | 2018-07-27 15:45:29 -0700 | [diff] [blame] | 268 | AidlAnnotatable::AidlAnnotatable(const AidlLocation& location) : AidlNode(location) {} |
| 269 | |
Jiyong Park | 68bc77a | 2018-07-19 19:00:45 +0900 | [diff] [blame] | 270 | bool AidlAnnotatable::IsNullable() const { |
Steven Moreland | 0cea4aa | 2020-04-20 21:06:02 -0700 | [diff] [blame] | 271 | return GetAnnotation(annotations_, AidlAnnotation::Type::NULLABLE); |
Jiyong Park | 68bc77a | 2018-07-19 19:00:45 +0900 | [diff] [blame] | 272 | } |
| 273 | |
Jiyong Park | 68bc77a | 2018-07-19 19:00:45 +0900 | [diff] [blame] | 274 | bool AidlAnnotatable::IsUtf8InCpp() const { |
Steven Moreland | 0cea4aa | 2020-04-20 21:06:02 -0700 | [diff] [blame] | 275 | return GetAnnotation(annotations_, AidlAnnotation::Type::UTF8_IN_CPP); |
Jiyong Park | 68bc77a | 2018-07-19 19:00:45 +0900 | [diff] [blame] | 276 | } |
| 277 | |
Steven Moreland | a57d0a6 | 2019-07-30 09:41:14 -0700 | [diff] [blame] | 278 | bool AidlAnnotatable::IsVintfStability() const { |
Steven Moreland | 0cea4aa | 2020-04-20 21:06:02 -0700 | [diff] [blame] | 279 | return GetAnnotation(annotations_, AidlAnnotation::Type::VINTF_STABILITY); |
Steven Moreland | a57d0a6 | 2019-07-30 09:41:14 -0700 | [diff] [blame] | 280 | } |
| 281 | |
Jeongik Cha | d0a1027 | 2020-08-06 16:33:36 +0900 | [diff] [blame] | 282 | bool AidlAnnotatable::IsJavaOnlyImmutable() const { |
| 283 | return GetAnnotation(annotations_, AidlAnnotation::Type::JAVA_ONLY_IMMUTABLE); |
Jeongik Cha | 36f76c3 | 2020-07-28 00:25:52 +0900 | [diff] [blame] | 284 | } |
| 285 | |
Devin Moore | c7e47a3 | 2020-08-07 10:55:25 -0700 | [diff] [blame] | 286 | bool AidlAnnotatable::IsFixedSize() const { |
| 287 | return GetAnnotation(annotations_, AidlAnnotation::Type::FIXED_SIZE); |
| 288 | } |
| 289 | |
Andrei Onea | 9445fc6 | 2019-06-27 18:11:59 +0100 | [diff] [blame] | 290 | const AidlAnnotation* AidlAnnotatable::UnsupportedAppUsage() const { |
Steven Moreland | 0cea4aa | 2020-04-20 21:06:02 -0700 | [diff] [blame] | 291 | return GetAnnotation(annotations_, AidlAnnotation::Type::UNSUPPORTED_APP_USAGE); |
Jiyong Park | a6605ab | 2018-11-11 14:30:21 +0900 | [diff] [blame] | 292 | } |
| 293 | |
Jiyong Park | bf5fd5c | 2020-06-05 19:48:05 +0900 | [diff] [blame] | 294 | const AidlAnnotation* AidlAnnotatable::JavaPassthrough() const { |
| 295 | return GetAnnotation(annotations_, AidlAnnotation::Type::JAVA_PASSTHROUGH); |
| 296 | } |
| 297 | |
Daniel Norman | 716d311 | 2019-09-10 13:11:56 -0700 | [diff] [blame] | 298 | const AidlTypeSpecifier* AidlAnnotatable::BackingType(const AidlTypenames& typenames) const { |
Steven Moreland | 0cea4aa | 2020-04-20 21:06:02 -0700 | [diff] [blame] | 299 | auto annotation = GetAnnotation(annotations_, AidlAnnotation::Type::BACKING); |
Daniel Norman | 85aed54 | 2019-08-21 12:01:14 -0700 | [diff] [blame] | 300 | if (annotation != nullptr) { |
| 301 | auto annotation_params = annotation->AnnotationParams(AidlConstantValueDecorator); |
| 302 | if (auto it = annotation_params.find("type"); it != annotation_params.end()) { |
| 303 | const string& type = it->second; |
Steven Moreland | e7d5d08 | 2020-05-21 20:29:02 +0000 | [diff] [blame] | 304 | |
| 305 | AIDL_FATAL_IF(type.size() < 2, this) << type; |
| 306 | AIDL_FATAL_IF(type[0] != '"', this) << type; |
| 307 | AIDL_FATAL_IF(type[type.length() - 1] != '"', this) << type; |
| 308 | string unquoted_type = type.substr(1, type.length() - 2); |
| 309 | |
Daniel Norman | 716d311 | 2019-09-10 13:11:56 -0700 | [diff] [blame] | 310 | AidlTypeSpecifier* type_specifier = |
Steven Moreland | e7d5d08 | 2020-05-21 20:29:02 +0000 | [diff] [blame] | 311 | new AidlTypeSpecifier(AIDL_LOCATION_HERE, unquoted_type, false, nullptr, ""); |
Daniel Norman | 716d311 | 2019-09-10 13:11:56 -0700 | [diff] [blame] | 312 | type_specifier->Resolve(typenames); |
| 313 | return type_specifier; |
Daniel Norman | 85aed54 | 2019-08-21 12:01:14 -0700 | [diff] [blame] | 314 | } |
| 315 | } |
| 316 | return nullptr; |
| 317 | } |
| 318 | |
Jeongik Cha | 88f95a8 | 2020-01-15 13:02:16 +0900 | [diff] [blame] | 319 | bool AidlAnnotatable::IsStableApiParcelable(Options::Language lang) const { |
Steven Moreland | 0cea4aa | 2020-04-20 21:06:02 -0700 | [diff] [blame] | 320 | return lang == Options::Language::JAVA && |
| 321 | GetAnnotation(annotations_, AidlAnnotation::Type::JAVA_STABLE_PARCELABLE); |
Jeongik Cha | 82317dd | 2019-02-27 20:26:11 +0900 | [diff] [blame] | 322 | } |
| 323 | |
Makoto Onuki | 78a1c1c | 2020-03-04 16:57:23 -0800 | [diff] [blame] | 324 | bool AidlAnnotatable::IsHide() const { |
Steven Moreland | 0cea4aa | 2020-04-20 21:06:02 -0700 | [diff] [blame] | 325 | return GetAnnotation(annotations_, AidlAnnotation::Type::HIDE); |
Makoto Onuki | 78a1c1c | 2020-03-04 16:57:23 -0800 | [diff] [blame] | 326 | } |
| 327 | |
Jiyong Park | 43113fb | 2020-07-20 16:26:19 +0900 | [diff] [blame] | 328 | bool AidlAnnotatable::IsJavaDebug() const { |
| 329 | return GetAnnotation(annotations_, AidlAnnotation::Type::JAVA_DEBUG); |
| 330 | } |
| 331 | |
Jiyong Park | 27fd7fd | 2020-08-27 16:25:09 +0900 | [diff] [blame] | 332 | std::string AidlAnnotatable::GetDescriptor() const { |
| 333 | auto annotation = GetAnnotation(annotations_, AidlAnnotation::Type::DESCRIPTOR); |
| 334 | if (annotation != nullptr) { |
| 335 | auto params = annotation->AnnotationParams(AidlConstantValueDecorator); |
| 336 | if (auto it = params.find("value"); it != params.end()) { |
| 337 | const string& value = it->second; |
| 338 | |
| 339 | AIDL_FATAL_IF(value.size() < 2, this) << value; |
| 340 | AIDL_FATAL_IF(value[0] != '"', this) << value; |
| 341 | AIDL_FATAL_IF(value[value.length() - 1] != '"', this) << value; |
| 342 | std::string unquoted_value = value.substr(1, value.length() - 2); |
| 343 | return unquoted_value; |
| 344 | } |
| 345 | } |
| 346 | return ""; |
| 347 | } |
| 348 | |
Steven Moreland | 7e4b950 | 2020-02-20 18:10:42 -0800 | [diff] [blame] | 349 | void AidlAnnotatable::DumpAnnotations(CodeWriter* writer) const { |
| 350 | if (annotations_.empty()) return; |
| 351 | |
| 352 | writer->Write("%s\n", AidlAnnotatable::ToString().c_str()); |
| 353 | } |
| 354 | |
Devin Moore | 24f6857 | 2020-02-26 13:20:59 -0800 | [diff] [blame] | 355 | bool AidlAnnotatable::CheckValid(const AidlTypenames&) const { |
Steven Moreland | 0cea4aa | 2020-04-20 21:06:02 -0700 | [diff] [blame] | 356 | std::set<AidlAnnotation::Type> supported_annotations = GetSupportedAnnotations(); |
Andrei Onea | 9445fc6 | 2019-06-27 18:11:59 +0100 | [diff] [blame] | 357 | for (const auto& annotation : GetAnnotations()) { |
| 358 | if (!annotation.CheckValid()) { |
| 359 | return false; |
| 360 | } |
Steven Moreland | 0cea4aa | 2020-04-20 21:06:02 -0700 | [diff] [blame] | 361 | |
| 362 | std::vector<std::string> supported_annot_strings; |
| 363 | for (AidlAnnotation::Type type : supported_annotations) { |
| 364 | supported_annot_strings.push_back(AidlAnnotation::TypeToString(type)); |
| 365 | } |
| 366 | |
| 367 | if (supported_annotations.find(annotation.GetType()) == supported_annotations.end()) { |
Devin Moore | 24f6857 | 2020-02-26 13:20:59 -0800 | [diff] [blame] | 368 | AIDL_ERROR(this) << "'" << annotation.GetName() |
| 369 | << "' is not a supported annotation for this node. " |
Steven Moreland | 0cea4aa | 2020-04-20 21:06:02 -0700 | [diff] [blame] | 370 | << "It must be one of: " |
| 371 | << android::base::Join(supported_annot_strings, ", "); |
Devin Moore | 24f6857 | 2020-02-26 13:20:59 -0800 | [diff] [blame] | 372 | return false; |
| 373 | } |
Andrei Onea | 9445fc6 | 2019-06-27 18:11:59 +0100 | [diff] [blame] | 374 | } |
Steven Moreland | a57d0a6 | 2019-07-30 09:41:14 -0700 | [diff] [blame] | 375 | |
Andrei Onea | 9445fc6 | 2019-06-27 18:11:59 +0100 | [diff] [blame] | 376 | return true; |
| 377 | } |
| 378 | |
Jiyong Park | 68bc77a | 2018-07-19 19:00:45 +0900 | [diff] [blame] | 379 | string AidlAnnotatable::ToString() const { |
| 380 | vector<string> ret; |
| 381 | for (const auto& a : annotations_) { |
Daniel Norman | 37d43dd | 2019-09-09 17:22:34 -0700 | [diff] [blame] | 382 | ret.emplace_back(a.ToString(AidlConstantValueDecorator)); |
Jiyong Park | 68bc77a | 2018-07-19 19:00:45 +0900 | [diff] [blame] | 383 | } |
| 384 | std::sort(ret.begin(), ret.end()); |
| 385 | return Join(ret, " "); |
| 386 | } |
| 387 | |
Steven Moreland | 46e9da8 | 2018-07-27 15:45:29 -0700 | [diff] [blame] | 388 | AidlTypeSpecifier::AidlTypeSpecifier(const AidlLocation& location, const string& unresolved_name, |
| 389 | bool is_array, |
Jiyong Park | 1deecc3 | 2018-07-17 01:14:41 +0900 | [diff] [blame] | 390 | vector<unique_ptr<AidlTypeSpecifier>>* type_params, |
Steven Moreland | 46e9da8 | 2018-07-27 15:45:29 -0700 | [diff] [blame] | 391 | const string& comments) |
| 392 | : AidlAnnotatable(location), |
Jeongik Cha | df76dc7 | 2019-11-28 00:08:47 +0900 | [diff] [blame] | 393 | AidlParameterizable<unique_ptr<AidlTypeSpecifier>>(type_params), |
Steven Moreland | 46e9da8 | 2018-07-27 15:45:29 -0700 | [diff] [blame] | 394 | unresolved_name_(unresolved_name), |
Casey Dahlin | f7a421c | 2015-10-05 17:24:28 -0700 | [diff] [blame] | 395 | is_array_(is_array), |
Jeongik Cha | 1a7ab64 | 2019-07-29 17:31:02 +0900 | [diff] [blame] | 396 | comments_(comments), |
| 397 | split_name_(Split(unresolved_name, ".")) {} |
Casey Dahlin | f2d23f7 | 2015-10-02 16:19:19 -0700 | [diff] [blame] | 398 | |
Steven Moreland | 3f658cf | 2018-08-20 13:40:54 -0700 | [diff] [blame] | 399 | AidlTypeSpecifier AidlTypeSpecifier::ArrayBase() const { |
| 400 | AIDL_FATAL_IF(!is_array_, this); |
Jeongik Cha | df76dc7 | 2019-11-28 00:08:47 +0900 | [diff] [blame] | 401 | // Declaring array of generic type cannot happen, it is grammar error. |
| 402 | AIDL_FATAL_IF(IsGeneric(), this); |
Steven Moreland | 3f658cf | 2018-08-20 13:40:54 -0700 | [diff] [blame] | 403 | |
Steven Moreland | 0d9c26e | 2020-01-22 08:52:08 -0800 | [diff] [blame] | 404 | AidlTypeSpecifier array_base = *this; |
| 405 | array_base.is_array_ = false; |
| 406 | return array_base; |
Steven Moreland | 3f658cf | 2018-08-20 13:40:54 -0700 | [diff] [blame] | 407 | } |
| 408 | |
Jeongik Cha | 997281d | 2020-01-16 15:23:59 +0900 | [diff] [blame] | 409 | bool AidlTypeSpecifier::IsHidden() const { |
| 410 | return HasHideComment(GetComments()); |
| 411 | } |
| 412 | |
Jiyong Park | 1deecc3 | 2018-07-17 01:14:41 +0900 | [diff] [blame] | 413 | string AidlTypeSpecifier::ToString() const { |
| 414 | string ret = GetName(); |
| 415 | if (IsGeneric()) { |
| 416 | vector<string> arg_names; |
| 417 | for (const auto& ta : GetTypeParameters()) { |
Jiyong Park | ccf00f8 | 2018-07-17 01:39:23 +0900 | [diff] [blame] | 418 | arg_names.emplace_back(ta->ToString()); |
| 419 | } |
Jiyong Park | 1deecc3 | 2018-07-17 01:14:41 +0900 | [diff] [blame] | 420 | ret += "<" + Join(arg_names, ",") + ">"; |
Jiyong Park | ccf00f8 | 2018-07-17 01:39:23 +0900 | [diff] [blame] | 421 | } |
Jiyong Park | 1deecc3 | 2018-07-17 01:14:41 +0900 | [diff] [blame] | 422 | if (IsArray()) { |
| 423 | ret += "[]"; |
| 424 | } |
| 425 | return ret; |
Jiyong Park | ccf00f8 | 2018-07-17 01:39:23 +0900 | [diff] [blame] | 426 | } |
| 427 | |
Jiyong Park | 02da742 | 2018-07-16 16:00:26 +0900 | [diff] [blame] | 428 | string AidlTypeSpecifier::Signature() const { |
| 429 | string ret = ToString(); |
| 430 | string annotations = AidlAnnotatable::ToString(); |
| 431 | if (annotations != "") { |
| 432 | ret = annotations + " " + ret; |
| 433 | } |
| 434 | return ret; |
| 435 | } |
| 436 | |
Daniel Norman | 716d311 | 2019-09-10 13:11:56 -0700 | [diff] [blame] | 437 | bool AidlTypeSpecifier::Resolve(const AidlTypenames& typenames) { |
Steven Moreland | 9731c63 | 2019-08-13 10:21:08 -0700 | [diff] [blame] | 438 | CHECK(!IsResolved()); |
Steven Moreland | cb1bcd7 | 2020-04-29 16:30:35 -0700 | [diff] [blame] | 439 | AidlTypenames::ResolvedTypename result = typenames.ResolveTypename(unresolved_name_); |
| 440 | if (result.is_resolved) { |
| 441 | fully_qualified_name_ = result.canonical_name; |
Jeongik Cha | 1a7ab64 | 2019-07-29 17:31:02 +0900 | [diff] [blame] | 442 | split_name_ = Split(fully_qualified_name_, "."); |
Jiyong Park | ccf00f8 | 2018-07-17 01:39:23 +0900 | [diff] [blame] | 443 | } |
Steven Moreland | cb1bcd7 | 2020-04-29 16:30:35 -0700 | [diff] [blame] | 444 | return result.is_resolved; |
Casey Dahlin | 70078e6 | 2015-09-30 17:01:30 -0700 | [diff] [blame] | 445 | } |
| 446 | |
Steven Moreland | 0cea4aa | 2020-04-20 21:06:02 -0700 | [diff] [blame] | 447 | std::set<AidlAnnotation::Type> AidlTypeSpecifier::GetSupportedAnnotations() const { |
Devin Moore | 24f6857 | 2020-02-26 13:20:59 -0800 | [diff] [blame] | 448 | // kHide and kUnsupportedAppUsage are both method return annotations |
| 449 | // which we don't distinguish from other type specifiers. |
Steven Moreland | 0cea4aa | 2020-04-20 21:06:02 -0700 | [diff] [blame] | 450 | return {AidlAnnotation::Type::NULLABLE, AidlAnnotation::Type::UTF8_IN_CPP, |
Jiyong Park | bf5fd5c | 2020-06-05 19:48:05 +0900 | [diff] [blame] | 451 | AidlAnnotation::Type::UNSUPPORTED_APP_USAGE, AidlAnnotation::Type::HIDE, |
| 452 | AidlAnnotation::Type::JAVA_PASSTHROUGH}; |
Devin Moore | 24f6857 | 2020-02-26 13:20:59 -0800 | [diff] [blame] | 453 | } |
| 454 | |
Jeongik Cha | db0f59e | 2018-11-01 18:11:21 +0900 | [diff] [blame] | 455 | bool AidlTypeSpecifier::CheckValid(const AidlTypenames& typenames) const { |
Devin Moore | 24f6857 | 2020-02-26 13:20:59 -0800 | [diff] [blame] | 456 | if (!AidlAnnotatable::CheckValid(typenames)) { |
Andrei Onea | 9445fc6 | 2019-06-27 18:11:59 +0100 | [diff] [blame] | 457 | return false; |
| 458 | } |
Jiyong Park | 1d2df7d | 2018-07-23 15:22:50 +0900 | [diff] [blame] | 459 | if (IsGeneric()) { |
| 460 | const string& type_name = GetName(); |
Jeongik Cha | e74c86d | 2019-12-12 16:54:03 +0900 | [diff] [blame] | 461 | |
| 462 | auto& types = GetTypeParameters(); |
| 463 | // TODO(b/136048684) Disallow to use primitive types only if it is List or Map. |
| 464 | if (type_name == "List" || type_name == "Map") { |
| 465 | if (std::any_of(types.begin(), types.end(), [](auto& type_ptr) { |
| 466 | return AidlTypenames::IsPrimitiveTypename(type_ptr->GetName()); |
| 467 | })) { |
Devin Moore | 7b8d5c9 | 2020-03-17 14:14:08 -0700 | [diff] [blame] | 468 | AIDL_ERROR(this) << "A generic type cannot have any primitive type parameters."; |
Jeongik Cha | e74c86d | 2019-12-12 16:54:03 +0900 | [diff] [blame] | 469 | return false; |
| 470 | } |
| 471 | } |
Steven Moreland | 0d9c26e | 2020-01-22 08:52:08 -0800 | [diff] [blame] | 472 | const auto defined_type = typenames.TryGetDefinedType(type_name); |
Jeongik Cha | df76dc7 | 2019-11-28 00:08:47 +0900 | [diff] [blame] | 473 | const auto parameterizable = |
Steven Moreland | 0d9c26e | 2020-01-22 08:52:08 -0800 | [diff] [blame] | 474 | defined_type != nullptr ? defined_type->AsParameterizable() : nullptr; |
| 475 | const bool is_user_defined_generic_type = |
Jeongik Cha | df76dc7 | 2019-11-28 00:08:47 +0900 | [diff] [blame] | 476 | parameterizable != nullptr && parameterizable->IsGeneric(); |
Steven Moreland | 0d9c26e | 2020-01-22 08:52:08 -0800 | [diff] [blame] | 477 | const size_t num_params = GetTypeParameters().size(); |
Jiyong Park | 1d2df7d | 2018-07-23 15:22:50 +0900 | [diff] [blame] | 478 | if (type_name == "List") { |
Steven Moreland | 0d9c26e | 2020-01-22 08:52:08 -0800 | [diff] [blame] | 479 | if (num_params > 1) { |
Jeongik Cha | db0f59e | 2018-11-01 18:11:21 +0900 | [diff] [blame] | 480 | AIDL_ERROR(this) << " List cannot have type parameters more than one, but got " |
| 481 | << "'" << ToString() << "'"; |
Jiyong Park | 1d2df7d | 2018-07-23 15:22:50 +0900 | [diff] [blame] | 482 | return false; |
| 483 | } |
| 484 | } else if (type_name == "Map") { |
Steven Moreland | 0d9c26e | 2020-01-22 08:52:08 -0800 | [diff] [blame] | 485 | if (num_params != 0 && num_params != 2) { |
Jeongik Cha | db0f59e | 2018-11-01 18:11:21 +0900 | [diff] [blame] | 486 | AIDL_ERROR(this) << "Map must have 0 or 2 type parameters, but got " |
| 487 | << "'" << ToString() << "'"; |
Jiyong Park | 1d2df7d | 2018-07-23 15:22:50 +0900 | [diff] [blame] | 488 | return false; |
| 489 | } |
Steven Moreland | 0d9c26e | 2020-01-22 08:52:08 -0800 | [diff] [blame] | 490 | if (num_params == 2) { |
Jeongik Cha | e48d994 | 2020-01-02 17:39:00 +0900 | [diff] [blame] | 491 | const string& key_type = GetTypeParameters()[0]->GetName(); |
| 492 | if (key_type != "String") { |
| 493 | AIDL_ERROR(this) << "The type of key in map must be String, but it is " |
| 494 | << "'" << key_type << "'"; |
| 495 | return false; |
| 496 | } |
| 497 | } |
Steven Moreland | 0d9c26e | 2020-01-22 08:52:08 -0800 | [diff] [blame] | 498 | } else if (is_user_defined_generic_type) { |
Jeongik Cha | df76dc7 | 2019-11-28 00:08:47 +0900 | [diff] [blame] | 499 | const size_t allowed = parameterizable->GetTypeParameters().size(); |
Steven Moreland | 0d9c26e | 2020-01-22 08:52:08 -0800 | [diff] [blame] | 500 | if (num_params != allowed) { |
Jeongik Cha | df76dc7 | 2019-11-28 00:08:47 +0900 | [diff] [blame] | 501 | AIDL_ERROR(this) << type_name << " must have " << allowed << " type parameters, but got " |
Steven Moreland | 0d9c26e | 2020-01-22 08:52:08 -0800 | [diff] [blame] | 502 | << num_params; |
Jeongik Cha | df76dc7 | 2019-11-28 00:08:47 +0900 | [diff] [blame] | 503 | return false; |
| 504 | } |
| 505 | } else { |
| 506 | AIDL_ERROR(this) << type_name << " is not a generic type."; |
| 507 | return false; |
Jiyong Park | 1d2df7d | 2018-07-23 15:22:50 +0900 | [diff] [blame] | 508 | } |
| 509 | } |
Jeongik Cha | db0f59e | 2018-11-01 18:11:21 +0900 | [diff] [blame] | 510 | |
Steven Moreland | 11cb945 | 2020-01-21 16:56:58 -0800 | [diff] [blame] | 511 | const bool is_generic_string_list = GetName() == "List" && IsGeneric() && |
| 512 | GetTypeParameters().size() == 1 && |
| 513 | GetTypeParameters()[0]->GetName() == "String"; |
| 514 | if (IsUtf8InCpp() && (GetName() != "String" && !is_generic_string_list)) { |
| 515 | AIDL_ERROR(this) << "@utf8InCpp can only be used on String, String[], and List<String>."; |
| 516 | return false; |
| 517 | } |
| 518 | |
Jeongik Cha | db0f59e | 2018-11-01 18:11:21 +0900 | [diff] [blame] | 519 | if (GetName() == "void") { |
| 520 | if (IsArray() || IsNullable() || IsUtf8InCpp()) { |
| 521 | AIDL_ERROR(this) << "void type cannot be an array or nullable or utf8 string"; |
| 522 | return false; |
| 523 | } |
| 524 | } |
| 525 | |
| 526 | if (IsArray()) { |
Steven Moreland | 0d9c26e | 2020-01-22 08:52:08 -0800 | [diff] [blame] | 527 | const auto defined_type = typenames.TryGetDefinedType(GetName()); |
| 528 | if (defined_type != nullptr && defined_type->AsInterface() != nullptr) { |
Jeongik Cha | db0f59e | 2018-11-01 18:11:21 +0900 | [diff] [blame] | 529 | AIDL_ERROR(this) << "Binder type cannot be an array"; |
| 530 | return false; |
| 531 | } |
| 532 | } |
| 533 | |
| 534 | if (IsNullable()) { |
| 535 | if (AidlTypenames::IsPrimitiveTypename(GetName()) && !IsArray()) { |
| 536 | AIDL_ERROR(this) << "Primitive type cannot get nullable annotation"; |
| 537 | return false; |
| 538 | } |
Steven Moreland | 0d9c26e | 2020-01-22 08:52:08 -0800 | [diff] [blame] | 539 | const auto defined_type = typenames.TryGetDefinedType(GetName()); |
| 540 | if (defined_type != nullptr && defined_type->AsEnumDeclaration() != nullptr && !IsArray()) { |
Daniel Norman | ee8674f | 2019-09-20 16:07:00 -0700 | [diff] [blame] | 541 | AIDL_ERROR(this) << "Enum type cannot get nullable annotation"; |
| 542 | return false; |
| 543 | } |
Jeongik Cha | db0f59e | 2018-11-01 18:11:21 +0900 | [diff] [blame] | 544 | } |
Jiyong Park | 1d2df7d | 2018-07-23 15:22:50 +0900 | [diff] [blame] | 545 | return true; |
| 546 | } |
| 547 | |
Steven Moreland | 860b194 | 2018-08-16 14:59:28 -0700 | [diff] [blame] | 548 | std::string AidlConstantValueDecorator(const AidlTypeSpecifier& /*type*/, |
| 549 | const std::string& raw_value) { |
| 550 | return raw_value; |
| 551 | } |
| 552 | |
Steven Moreland | 46e9da8 | 2018-07-27 15:45:29 -0700 | [diff] [blame] | 553 | AidlVariableDeclaration::AidlVariableDeclaration(const AidlLocation& location, |
| 554 | AidlTypeSpecifier* type, const std::string& name) |
Steven Moreland | 541788d | 2020-05-21 22:05:52 +0000 | [diff] [blame] | 555 | : AidlVariableDeclaration(location, type, name, AidlConstantValue::Default(*type)) { |
| 556 | default_user_specified_ = false; |
| 557 | } |
Steven Moreland | 9ea10e3 | 2018-07-19 15:26:09 -0700 | [diff] [blame] | 558 | |
Steven Moreland | 46e9da8 | 2018-07-27 15:45:29 -0700 | [diff] [blame] | 559 | AidlVariableDeclaration::AidlVariableDeclaration(const AidlLocation& location, |
| 560 | AidlTypeSpecifier* type, const std::string& name, |
| 561 | AidlConstantValue* default_value) |
Steven Moreland | 541788d | 2020-05-21 22:05:52 +0000 | [diff] [blame] | 562 | : AidlNode(location), |
| 563 | type_(type), |
| 564 | name_(name), |
| 565 | default_user_specified_(true), |
| 566 | default_value_(default_value) {} |
Steven Moreland | 9ea10e3 | 2018-07-19 15:26:09 -0700 | [diff] [blame] | 567 | |
Jeongik Cha | db0f59e | 2018-11-01 18:11:21 +0900 | [diff] [blame] | 568 | bool AidlVariableDeclaration::CheckValid(const AidlTypenames& typenames) const { |
Steven Moreland | 2529432 | 2018-08-07 18:13:55 -0700 | [diff] [blame] | 569 | bool valid = true; |
Jeongik Cha | db0f59e | 2018-11-01 18:11:21 +0900 | [diff] [blame] | 570 | valid &= type_->CheckValid(typenames); |
Jiyong Park | 1d2df7d | 2018-07-23 15:22:50 +0900 | [diff] [blame] | 571 | |
Steven Moreland | 54be7bd | 2019-12-05 11:17:53 -0800 | [diff] [blame] | 572 | if (type_->GetName() == "void") { |
| 573 | AIDL_ERROR(this) << "Declaration " << name_ |
| 574 | << " is void, but declarations cannot be of void type."; |
| 575 | valid = false; |
| 576 | } |
| 577 | |
Jeongik Cha | db0f59e | 2018-11-01 18:11:21 +0900 | [diff] [blame] | 578 | if (default_value_ == nullptr) return valid; |
Steven Moreland | 2529432 | 2018-08-07 18:13:55 -0700 | [diff] [blame] | 579 | valid &= default_value_->CheckValid(); |
Steven Moreland | 9ea10e3 | 2018-07-19 15:26:09 -0700 | [diff] [blame] | 580 | |
Steven Moreland | 2529432 | 2018-08-07 18:13:55 -0700 | [diff] [blame] | 581 | if (!valid) return false; |
Steven Moreland | 9ea10e3 | 2018-07-19 15:26:09 -0700 | [diff] [blame] | 582 | |
Steven Moreland | 860b194 | 2018-08-16 14:59:28 -0700 | [diff] [blame] | 583 | return !ValueString(AidlConstantValueDecorator).empty(); |
Steven Moreland | 9ea10e3 | 2018-07-19 15:26:09 -0700 | [diff] [blame] | 584 | } |
Steven Moreland | 5557f1c | 2018-07-02 13:50:23 -0700 | [diff] [blame] | 585 | |
| 586 | string AidlVariableDeclaration::ToString() const { |
Jeongik Cha | 3271ffa | 2018-12-04 15:19:20 +0900 | [diff] [blame] | 587 | string ret = type_->Signature() + " " + name_; |
Steven Moreland | 541788d | 2020-05-21 22:05:52 +0000 | [diff] [blame] | 588 | if (default_value_ != nullptr && default_user_specified_) { |
Steven Moreland | 860b194 | 2018-08-16 14:59:28 -0700 | [diff] [blame] | 589 | ret += " = " + ValueString(AidlConstantValueDecorator); |
Steven Moreland | 9ea10e3 | 2018-07-19 15:26:09 -0700 | [diff] [blame] | 590 | } |
| 591 | return ret; |
Steven Moreland | 5557f1c | 2018-07-02 13:50:23 -0700 | [diff] [blame] | 592 | } |
| 593 | |
Jiyong Park | 02da742 | 2018-07-16 16:00:26 +0900 | [diff] [blame] | 594 | string AidlVariableDeclaration::Signature() const { |
| 595 | return type_->Signature() + " " + name_; |
| 596 | } |
| 597 | |
Steven Moreland | 860b194 | 2018-08-16 14:59:28 -0700 | [diff] [blame] | 598 | std::string AidlVariableDeclaration::ValueString(const ConstantValueDecorator& decorator) const { |
Jiyong Park | a468e2a | 2018-08-29 21:25:18 +0900 | [diff] [blame] | 599 | if (default_value_ != nullptr) { |
Will McVicker | d7d18df | 2019-09-12 13:40:50 -0700 | [diff] [blame] | 600 | return default_value_->ValueString(GetType(), decorator); |
Jiyong Park | a468e2a | 2018-08-29 21:25:18 +0900 | [diff] [blame] | 601 | } else { |
| 602 | return ""; |
| 603 | } |
Steven Moreland | 2529432 | 2018-08-07 18:13:55 -0700 | [diff] [blame] | 604 | } |
| 605 | |
Steven Moreland | 46e9da8 | 2018-07-27 15:45:29 -0700 | [diff] [blame] | 606 | AidlArgument::AidlArgument(const AidlLocation& location, AidlArgument::Direction direction, |
| 607 | AidlTypeSpecifier* type, const std::string& name) |
| 608 | : AidlVariableDeclaration(location, type, name), |
Casey Dahlin | fd6fb48 | 2015-09-30 14:48:18 -0700 | [diff] [blame] | 609 | direction_(direction), |
Steven Moreland | 5557f1c | 2018-07-02 13:50:23 -0700 | [diff] [blame] | 610 | direction_specified_(true) {} |
Casey Dahlin | c378c99 | 2015-09-29 16:50:40 -0700 | [diff] [blame] | 611 | |
Steven Moreland | 46e9da8 | 2018-07-27 15:45:29 -0700 | [diff] [blame] | 612 | AidlArgument::AidlArgument(const AidlLocation& location, AidlTypeSpecifier* type, |
| 613 | const std::string& name) |
| 614 | : AidlVariableDeclaration(location, type, name), |
Casey Dahlin | fd6fb48 | 2015-09-30 14:48:18 -0700 | [diff] [blame] | 615 | direction_(AidlArgument::IN_DIR), |
Steven Moreland | 5557f1c | 2018-07-02 13:50:23 -0700 | [diff] [blame] | 616 | direction_specified_(false) {} |
Casey Dahlin | c378c99 | 2015-09-29 16:50:40 -0700 | [diff] [blame] | 617 | |
Jiyong Park | 02da742 | 2018-07-16 16:00:26 +0900 | [diff] [blame] | 618 | string AidlArgument::GetDirectionSpecifier() const { |
Casey Dahlin | c378c99 | 2015-09-29 16:50:40 -0700 | [diff] [blame] | 619 | string ret; |
Casey Dahlin | c378c99 | 2015-09-29 16:50:40 -0700 | [diff] [blame] | 620 | if (direction_specified_) { |
| 621 | switch(direction_) { |
| 622 | case AidlArgument::IN_DIR: |
Devin Moore | eccdb90 | 2020-03-24 16:22:40 -0700 | [diff] [blame] | 623 | ret += "in"; |
Casey Dahlin | c378c99 | 2015-09-29 16:50:40 -0700 | [diff] [blame] | 624 | break; |
| 625 | case AidlArgument::OUT_DIR: |
Devin Moore | eccdb90 | 2020-03-24 16:22:40 -0700 | [diff] [blame] | 626 | ret += "out"; |
Casey Dahlin | c378c99 | 2015-09-29 16:50:40 -0700 | [diff] [blame] | 627 | break; |
| 628 | case AidlArgument::INOUT_DIR: |
Devin Moore | eccdb90 | 2020-03-24 16:22:40 -0700 | [diff] [blame] | 629 | ret += "inout"; |
Casey Dahlin | c378c99 | 2015-09-29 16:50:40 -0700 | [diff] [blame] | 630 | break; |
| 631 | } |
| 632 | } |
Casey Dahlin | c378c99 | 2015-09-29 16:50:40 -0700 | [diff] [blame] | 633 | return ret; |
| 634 | } |
Casey Dahlin | bc7a50a | 2015-09-28 19:20:50 -0700 | [diff] [blame] | 635 | |
Jiyong Park | 02da742 | 2018-07-16 16:00:26 +0900 | [diff] [blame] | 636 | string AidlArgument::ToString() const { |
Devin Moore | eccdb90 | 2020-03-24 16:22:40 -0700 | [diff] [blame] | 637 | if (direction_specified_) { |
| 638 | return GetDirectionSpecifier() + " " + AidlVariableDeclaration::ToString(); |
| 639 | } else { |
| 640 | return AidlVariableDeclaration::ToString(); |
| 641 | } |
Jiyong Park | 02da742 | 2018-07-16 16:00:26 +0900 | [diff] [blame] | 642 | } |
| 643 | |
| 644 | std::string AidlArgument::Signature() const { |
Steven Moreland | 46e9da8 | 2018-07-27 15:45:29 -0700 | [diff] [blame] | 645 | class AidlInterface; |
| 646 | class AidlInterface; |
| 647 | class AidlParcelable; |
| 648 | class AidlStructuredParcelable; |
| 649 | class AidlParcelable; |
| 650 | class AidlStructuredParcelable; |
Devin Moore | eccdb90 | 2020-03-24 16:22:40 -0700 | [diff] [blame] | 651 | if (direction_specified_) { |
| 652 | return GetDirectionSpecifier() + " " + AidlVariableDeclaration::Signature(); |
| 653 | } else { |
| 654 | return AidlVariableDeclaration::Signature(); |
| 655 | } |
Jiyong Park | 02da742 | 2018-07-16 16:00:26 +0900 | [diff] [blame] | 656 | } |
| 657 | |
Steven Moreland | 46e9da8 | 2018-07-27 15:45:29 -0700 | [diff] [blame] | 658 | AidlMember::AidlMember(const AidlLocation& location) : AidlNode(location) {} |
| 659 | |
Steven Moreland | 46e9da8 | 2018-07-27 15:45:29 -0700 | [diff] [blame] | 660 | AidlConstantDeclaration::AidlConstantDeclaration(const AidlLocation& location, |
| 661 | AidlTypeSpecifier* type, const std::string& name, |
| 662 | AidlConstantValue* value) |
| 663 | : AidlMember(location), type_(type), name_(name), value_(value) {} |
Steven Moreland | 693640b | 2018-07-19 13:46:27 -0700 | [diff] [blame] | 664 | |
Jeongik Cha | db0f59e | 2018-11-01 18:11:21 +0900 | [diff] [blame] | 665 | bool AidlConstantDeclaration::CheckValid(const AidlTypenames& typenames) const { |
Steven Moreland | 2529432 | 2018-08-07 18:13:55 -0700 | [diff] [blame] | 666 | bool valid = true; |
Jeongik Cha | db0f59e | 2018-11-01 18:11:21 +0900 | [diff] [blame] | 667 | valid &= type_->CheckValid(typenames); |
Steven Moreland | 2529432 | 2018-08-07 18:13:55 -0700 | [diff] [blame] | 668 | valid &= value_->CheckValid(); |
| 669 | if (!valid) return false; |
Steven Moreland | 693640b | 2018-07-19 13:46:27 -0700 | [diff] [blame] | 670 | |
Steven Moreland | 2529432 | 2018-08-07 18:13:55 -0700 | [diff] [blame] | 671 | const static set<string> kSupportedConstTypes = {"String", "int"}; |
| 672 | if (kSupportedConstTypes.find(type_->ToString()) == kSupportedConstTypes.end()) { |
| 673 | AIDL_ERROR(this) << "Constant of type " << type_->ToString() << " is not supported."; |
Steven Moreland | 693640b | 2018-07-19 13:46:27 -0700 | [diff] [blame] | 674 | return false; |
| 675 | } |
| 676 | |
Will McVicker | d7d18df | 2019-09-12 13:40:50 -0700 | [diff] [blame] | 677 | return true; |
Christopher Wiley | d6bdd8d | 2016-05-03 11:23:13 -0700 | [diff] [blame] | 678 | } |
| 679 | |
Jiyong Park | a428d21 | 2018-08-29 22:26:30 +0900 | [diff] [blame] | 680 | string AidlConstantDeclaration::ToString() const { |
| 681 | return "const " + type_->ToString() + " " + name_ + " = " + |
| 682 | ValueString(AidlConstantValueDecorator); |
| 683 | } |
| 684 | |
| 685 | string AidlConstantDeclaration::Signature() const { |
| 686 | return type_->Signature() + " " + name_; |
| 687 | } |
| 688 | |
Steven Moreland | 46e9da8 | 2018-07-27 15:45:29 -0700 | [diff] [blame] | 689 | AidlMethod::AidlMethod(const AidlLocation& location, bool oneway, AidlTypeSpecifier* type, |
| 690 | const std::string& name, std::vector<std::unique_ptr<AidlArgument>>* args, |
Jiyong Park | b034bf0 | 2018-07-30 17:44:33 +0900 | [diff] [blame] | 691 | const std::string& comments) |
| 692 | : AidlMethod(location, oneway, type, name, args, comments, 0, true) { |
| 693 | has_id_ = false; |
| 694 | } |
| 695 | |
| 696 | AidlMethod::AidlMethod(const AidlLocation& location, bool oneway, AidlTypeSpecifier* type, |
| 697 | const std::string& name, std::vector<std::unique_ptr<AidlArgument>>* args, |
Jiyong Park | b034bf0 | 2018-07-30 17:44:33 +0900 | [diff] [blame] | 698 | const std::string& comments, int id, bool is_user_defined) |
Steven Moreland | 46e9da8 | 2018-07-27 15:45:29 -0700 | [diff] [blame] | 699 | : AidlMember(location), |
| 700 | oneway_(oneway), |
Casey Dahlin | f4a9311 | 2015-10-05 16:58:09 -0700 | [diff] [blame] | 701 | comments_(comments), |
| 702 | type_(type), |
| 703 | name_(name), |
Casey Dahlin | f4a9311 | 2015-10-05 16:58:09 -0700 | [diff] [blame] | 704 | arguments_(std::move(*args)), |
Jiyong Park | b034bf0 | 2018-07-30 17:44:33 +0900 | [diff] [blame] | 705 | id_(id), |
| 706 | is_user_defined_(is_user_defined) { |
Casey Dahlin | f4a9311 | 2015-10-05 16:58:09 -0700 | [diff] [blame] | 707 | has_id_ = true; |
| 708 | delete args; |
Christopher Wiley | ad33927 | 2015-10-05 19:11:58 -0700 | [diff] [blame] | 709 | for (const unique_ptr<AidlArgument>& a : arguments_) { |
| 710 | if (a->IsIn()) { in_arguments_.push_back(a.get()); } |
| 711 | if (a->IsOut()) { out_arguments_.push_back(a.get()); } |
| 712 | } |
Casey Dahlin | f4a9311 | 2015-10-05 16:58:09 -0700 | [diff] [blame] | 713 | } |
| 714 | |
Jeongik Cha | 997281d | 2020-01-16 15:23:59 +0900 | [diff] [blame] | 715 | bool AidlMethod::IsHidden() const { |
| 716 | return HasHideComment(GetComments()); |
| 717 | } |
Casey Dahlin | f2d23f7 | 2015-10-02 16:19:19 -0700 | [diff] [blame] | 718 | |
Jiyong Park | 02da742 | 2018-07-16 16:00:26 +0900 | [diff] [blame] | 719 | string AidlMethod::Signature() const { |
| 720 | vector<string> arg_signatures; |
| 721 | for (const auto& arg : GetArguments()) { |
Jiyong Park | 309668e | 2018-07-28 16:55:44 +0900 | [diff] [blame] | 722 | arg_signatures.emplace_back(arg->GetType().ToString()); |
Jiyong Park | 02da742 | 2018-07-16 16:00:26 +0900 | [diff] [blame] | 723 | } |
Jiyong Park | 309668e | 2018-07-28 16:55:44 +0900 | [diff] [blame] | 724 | return GetName() + "(" + Join(arg_signatures, ", ") + ")"; |
| 725 | } |
| 726 | |
| 727 | string AidlMethod::ToString() const { |
| 728 | vector<string> arg_strings; |
| 729 | for (const auto& arg : GetArguments()) { |
| 730 | arg_strings.emplace_back(arg->Signature()); |
| 731 | } |
Steven Moreland | 4ee6863 | 2018-12-14 15:52:46 -0800 | [diff] [blame] | 732 | string ret = (IsOneway() ? "oneway " : "") + GetType().Signature() + " " + GetName() + "(" + |
| 733 | Join(arg_strings, ", ") + ")"; |
Jiyong Park | ed65bf4 | 2018-08-28 15:43:27 +0900 | [diff] [blame] | 734 | if (HasId()) { |
| 735 | ret += " = " + std::to_string(GetId()); |
| 736 | } |
| 737 | return ret; |
Jiyong Park | 02da742 | 2018-07-16 16:00:26 +0900 | [diff] [blame] | 738 | } |
| 739 | |
Steven Moreland | 46e9da8 | 2018-07-27 15:45:29 -0700 | [diff] [blame] | 740 | AidlDefinedType::AidlDefinedType(const AidlLocation& location, const std::string& name, |
Jiyong Park | 1813218 | 2020-06-08 20:24:40 +0900 | [diff] [blame] | 741 | const std::string& comments, const std::string& package) |
| 742 | : AidlAnnotatable(location), |
| 743 | name_(name), |
| 744 | comments_(comments), |
| 745 | package_(package), |
| 746 | split_package_(package.empty() ? std::vector<std::string>() |
| 747 | : android::base::Split(package, ".")) {} |
Steven Moreland | 787b043 | 2018-07-03 09:00:58 -0700 | [diff] [blame] | 748 | |
Devin Moore | 24f6857 | 2020-02-26 13:20:59 -0800 | [diff] [blame] | 749 | bool AidlDefinedType::CheckValid(const AidlTypenames& typenames) const { |
| 750 | if (!AidlAnnotatable::CheckValid(typenames)) { |
| 751 | return false; |
| 752 | } |
| 753 | |
| 754 | return true; |
| 755 | } |
| 756 | |
Jeongik Cha | 997281d | 2020-01-16 15:23:59 +0900 | [diff] [blame] | 757 | bool AidlDefinedType::IsHidden() const { |
| 758 | return HasHideComment(GetComments()); |
| 759 | } |
| 760 | |
Steven Moreland | 787b043 | 2018-07-03 09:00:58 -0700 | [diff] [blame] | 761 | std::string AidlDefinedType::GetCanonicalName() const { |
| 762 | if (package_.empty()) { |
| 763 | return GetName(); |
| 764 | } |
| 765 | return GetPackage() + "." + GetName(); |
| 766 | } |
| 767 | |
Steven Moreland | a5d9c5c | 2020-02-21 16:01:09 -0800 | [diff] [blame] | 768 | void AidlDefinedType::DumpHeader(CodeWriter* writer) const { |
| 769 | if (this->IsHidden()) { |
| 770 | AddHideComment(writer); |
| 771 | } |
| 772 | DumpAnnotations(writer); |
| 773 | } |
| 774 | |
Jiyong Park | 1813218 | 2020-06-08 20:24:40 +0900 | [diff] [blame] | 775 | AidlParcelable::AidlParcelable(const AidlLocation& location, const std::string& name, |
| 776 | const std::string& package, const std::string& comments, |
Jeongik Cha | df76dc7 | 2019-11-28 00:08:47 +0900 | [diff] [blame] | 777 | const std::string& cpp_header, std::vector<std::string>* type_params) |
Jiyong Park | 1813218 | 2020-06-08 20:24:40 +0900 | [diff] [blame] | 778 | : AidlDefinedType(location, name, comments, package), |
Jeongik Cha | df76dc7 | 2019-11-28 00:08:47 +0900 | [diff] [blame] | 779 | AidlParameterizable<std::string>(type_params), |
Christopher Wiley | 8aa4d9f | 2015-11-16 19:10:45 -0800 | [diff] [blame] | 780 | cpp_header_(cpp_header) { |
| 781 | // Strip off quotation marks if we actually have a cpp header. |
| 782 | if (cpp_header_.length() >= 2) { |
| 783 | cpp_header_ = cpp_header_.substr(1, cpp_header_.length() - 2); |
| 784 | } |
Casey Dahlin | 59401da | 2015-10-09 18:16:45 -0700 | [diff] [blame] | 785 | } |
Jeongik Cha | df76dc7 | 2019-11-28 00:08:47 +0900 | [diff] [blame] | 786 | template <typename T> |
| 787 | AidlParameterizable<T>::AidlParameterizable(const AidlParameterizable& other) { |
| 788 | // Copying is not supported if it has type parameters. |
| 789 | // It doesn't make a problem because only ArrayBase() makes a copy, |
| 790 | // and it can be called only if a type is not generic. |
| 791 | CHECK(!other.IsGeneric()); |
| 792 | } |
| 793 | |
| 794 | template <typename T> |
| 795 | bool AidlParameterizable<T>::CheckValid() const { |
| 796 | return true; |
| 797 | }; |
| 798 | |
| 799 | template <> |
| 800 | bool AidlParameterizable<std::string>::CheckValid() const { |
| 801 | if (!IsGeneric()) { |
| 802 | return true; |
| 803 | } |
| 804 | std::unordered_set<std::string> set(GetTypeParameters().begin(), GetTypeParameters().end()); |
| 805 | if (set.size() != GetTypeParameters().size()) { |
| 806 | AIDL_ERROR(this->AsAidlNode()) << "Every type parameter should be unique."; |
| 807 | return false; |
| 808 | } |
| 809 | return true; |
| 810 | } |
Casey Dahlin | 59401da | 2015-10-09 18:16:45 -0700 | [diff] [blame] | 811 | |
Steven Moreland | 0cea4aa | 2020-04-20 21:06:02 -0700 | [diff] [blame] | 812 | std::set<AidlAnnotation::Type> AidlParcelable::GetSupportedAnnotations() const { |
Jeongik Cha | 36f76c3 | 2020-07-28 00:25:52 +0900 | [diff] [blame] | 813 | return {AidlAnnotation::Type::VINTF_STABILITY, AidlAnnotation::Type::UNSUPPORTED_APP_USAGE, |
Jiyong Park | bf5fd5c | 2020-06-05 19:48:05 +0900 | [diff] [blame] | 814 | AidlAnnotation::Type::JAVA_STABLE_PARCELABLE, AidlAnnotation::Type::HIDE, |
Jeongik Cha | d0a1027 | 2020-08-06 16:33:36 +0900 | [diff] [blame] | 815 | AidlAnnotation::Type::JAVA_PASSTHROUGH, AidlAnnotation::Type::JAVA_ONLY_IMMUTABLE}; |
Devin Moore | 24f6857 | 2020-02-26 13:20:59 -0800 | [diff] [blame] | 816 | } |
| 817 | |
| 818 | bool AidlParcelable::CheckValid(const AidlTypenames& typenames) const { |
| 819 | if (!AidlDefinedType::CheckValid(typenames)) { |
Andrei Onea | 9445fc6 | 2019-06-27 18:11:59 +0100 | [diff] [blame] | 820 | return false; |
| 821 | } |
Jeongik Cha | df76dc7 | 2019-11-28 00:08:47 +0900 | [diff] [blame] | 822 | if (!AidlParameterizable<std::string>::CheckValid()) { |
| 823 | return false; |
| 824 | } |
Jeongik Cha | 82317dd | 2019-02-27 20:26:11 +0900 | [diff] [blame] | 825 | |
| 826 | return true; |
| 827 | } |
| 828 | |
Jeongik Cha | 997281d | 2020-01-16 15:23:59 +0900 | [diff] [blame] | 829 | void AidlParcelable::Dump(CodeWriter* writer) const { |
Steven Moreland | a5d9c5c | 2020-02-21 16:01:09 -0800 | [diff] [blame] | 830 | DumpHeader(writer); |
Jiyong Park | 02da742 | 2018-07-16 16:00:26 +0900 | [diff] [blame] | 831 | writer->Write("parcelable %s ;\n", GetName().c_str()); |
| 832 | } |
| 833 | |
Steven Moreland | 5557f1c | 2018-07-02 13:50:23 -0700 | [diff] [blame] | 834 | AidlStructuredParcelable::AidlStructuredParcelable( |
Jiyong Park | 1813218 | 2020-06-08 20:24:40 +0900 | [diff] [blame] | 835 | const AidlLocation& location, const std::string& name, const std::string& package, |
Jiyong Park | a6605ab | 2018-11-11 14:30:21 +0900 | [diff] [blame] | 836 | const std::string& comments, std::vector<std::unique_ptr<AidlVariableDeclaration>>* variables) |
| 837 | : AidlParcelable(location, name, package, comments, "" /*cpp_header*/), |
Steven Moreland | 46e9da8 | 2018-07-27 15:45:29 -0700 | [diff] [blame] | 838 | variables_(std::move(*variables)) {} |
Steven Moreland | 5557f1c | 2018-07-02 13:50:23 -0700 | [diff] [blame] | 839 | |
Jeongik Cha | 997281d | 2020-01-16 15:23:59 +0900 | [diff] [blame] | 840 | void AidlStructuredParcelable::Dump(CodeWriter* writer) const { |
Steven Moreland | a5d9c5c | 2020-02-21 16:01:09 -0800 | [diff] [blame] | 841 | DumpHeader(writer); |
Jiyong Park | 02da742 | 2018-07-16 16:00:26 +0900 | [diff] [blame] | 842 | writer->Write("parcelable %s {\n", GetName().c_str()); |
| 843 | writer->Indent(); |
| 844 | for (const auto& field : GetFields()) { |
Jeongik Cha | 997281d | 2020-01-16 15:23:59 +0900 | [diff] [blame] | 845 | if (field->GetType().IsHidden()) { |
| 846 | AddHideComment(writer); |
| 847 | } |
Jiyong Park | a468e2a | 2018-08-29 21:25:18 +0900 | [diff] [blame] | 848 | writer->Write("%s;\n", field->ToString().c_str()); |
Jiyong Park | 02da742 | 2018-07-16 16:00:26 +0900 | [diff] [blame] | 849 | } |
| 850 | writer->Dedent(); |
| 851 | writer->Write("}\n"); |
| 852 | } |
| 853 | |
Steven Moreland | 0cea4aa | 2020-04-20 21:06:02 -0700 | [diff] [blame] | 854 | std::set<AidlAnnotation::Type> AidlStructuredParcelable::GetSupportedAnnotations() const { |
Jeongik Cha | 36f76c3 | 2020-07-28 00:25:52 +0900 | [diff] [blame] | 855 | return {AidlAnnotation::Type::VINTF_STABILITY, |
| 856 | AidlAnnotation::Type::UNSUPPORTED_APP_USAGE, |
| 857 | AidlAnnotation::Type::HIDE, |
| 858 | AidlAnnotation::Type::JAVA_PASSTHROUGH, |
| 859 | AidlAnnotation::Type::JAVA_DEBUG, |
Devin Moore | c7e47a3 | 2020-08-07 10:55:25 -0700 | [diff] [blame] | 860 | AidlAnnotation::Type::JAVA_ONLY_IMMUTABLE, |
| 861 | AidlAnnotation::Type::FIXED_SIZE}; |
Devin Moore | 24f6857 | 2020-02-26 13:20:59 -0800 | [diff] [blame] | 862 | } |
| 863 | |
Jeongik Cha | db0f59e | 2018-11-01 18:11:21 +0900 | [diff] [blame] | 864 | bool AidlStructuredParcelable::CheckValid(const AidlTypenames& typenames) const { |
Daniel Norman | 85aed54 | 2019-08-21 12:01:14 -0700 | [diff] [blame] | 865 | bool success = true; |
Devin Moore | 24f6857 | 2020-02-26 13:20:59 -0800 | [diff] [blame] | 866 | if (!AidlParcelable::CheckValid(typenames)) { |
| 867 | return false; |
| 868 | } |
Jeongik Cha | 13066da | 2020-08-06 15:43:19 +0900 | [diff] [blame] | 869 | std::set<std::string> fieldnames; |
Jeongik Cha | db0f59e | 2018-11-01 18:11:21 +0900 | [diff] [blame] | 870 | for (const auto& v : GetFields()) { |
Daniel Norman | 85aed54 | 2019-08-21 12:01:14 -0700 | [diff] [blame] | 871 | success = success && v->CheckValid(typenames); |
Jeongik Cha | 9118025 | 2020-07-31 15:43:11 +0900 | [diff] [blame] | 872 | bool duplicated; |
Jeongik Cha | d0a1027 | 2020-08-06 16:33:36 +0900 | [diff] [blame] | 873 | if (IsJavaOnlyImmutable()) { |
| 874 | success = success && typenames.CanBeJavaOnlyImmutable(v->GetType()); |
Jeongik Cha | 9118025 | 2020-07-31 15:43:11 +0900 | [diff] [blame] | 875 | duplicated = !fieldnames.emplace(CapitalizeFirstLetter(v->GetName())).second; |
| 876 | } else { |
Devin Moore | c7e47a3 | 2020-08-07 10:55:25 -0700 | [diff] [blame] | 877 | if (IsFixedSize()) { |
| 878 | success = success && typenames.CanBeFixedSize(v->GetType()); |
| 879 | if (!success) { |
| 880 | AIDL_ERROR(v) << "The @FixedSize parcelable '" << this->GetName() << "' has a " |
| 881 | << "non-fixed size field named " << v->GetName() << "."; |
| 882 | } |
| 883 | } |
Jeongik Cha | 9118025 | 2020-07-31 15:43:11 +0900 | [diff] [blame] | 884 | duplicated = !fieldnames.emplace(v->GetName()).second; |
Jeongik Cha | 36f76c3 | 2020-07-28 00:25:52 +0900 | [diff] [blame] | 885 | } |
Jeongik Cha | 13066da | 2020-08-06 15:43:19 +0900 | [diff] [blame] | 886 | |
Jeongik Cha | 9118025 | 2020-07-31 15:43:11 +0900 | [diff] [blame] | 887 | if (duplicated) { |
Jeongik Cha | 13066da | 2020-08-06 15:43:19 +0900 | [diff] [blame] | 888 | AIDL_ERROR(this) << "The parcelable '" << this->GetName() << "' has duplicate field name '" |
Jeongik Cha | 9118025 | 2020-07-31 15:43:11 +0900 | [diff] [blame] | 889 | << v->GetName() << "'" |
Jeongik Cha | d0a1027 | 2020-08-06 16:33:36 +0900 | [diff] [blame] | 890 | << (IsJavaOnlyImmutable() ? " after capitalizing the first letter" : ""); |
Jeongik Cha | 13066da | 2020-08-06 15:43:19 +0900 | [diff] [blame] | 891 | return false; |
| 892 | } |
Jeongik Cha | db0f59e | 2018-11-01 18:11:21 +0900 | [diff] [blame] | 893 | } |
Jeongik Cha | 36f76c3 | 2020-07-28 00:25:52 +0900 | [diff] [blame] | 894 | |
Daniel Norman | 85aed54 | 2019-08-21 12:01:14 -0700 | [diff] [blame] | 895 | return success; |
Jeongik Cha | db0f59e | 2018-11-01 18:11:21 +0900 | [diff] [blame] | 896 | } |
| 897 | |
Jeongik Cha | 047c5ee | 2019-08-07 23:16:49 +0900 | [diff] [blame] | 898 | // TODO: we should treat every backend all the same in future. |
Steven Moreland | d59e317 | 2020-05-11 16:42:09 -0700 | [diff] [blame] | 899 | bool AidlTypeSpecifier::LanguageSpecificCheckValid(const AidlTypenames& typenames, |
| 900 | Options::Language lang) const { |
Steven Moreland | 0185d9b | 2020-05-15 23:21:22 +0000 | [diff] [blame] | 901 | if (lang == Options::Language::NDK && IsArray() && GetName() == "IBinder") { |
| 902 | AIDL_ERROR(this) << "The NDK backend does not support array of IBinder"; |
| 903 | return false; |
| 904 | } |
Steven Moreland | d59e317 | 2020-05-11 16:42:09 -0700 | [diff] [blame] | 905 | if (lang == Options::Language::NDK && IsArray() && IsNullable()) { |
Steven Moreland | 0185d9b | 2020-05-15 23:21:22 +0000 | [diff] [blame] | 906 | if (GetName() == "ParcelFileDescriptor") { |
| 907 | AIDL_ERROR(this) << "The NDK backend does not support nullable array of ParcelFileDescriptor"; |
| 908 | return false; |
| 909 | } |
| 910 | |
Steven Moreland | d59e317 | 2020-05-11 16:42:09 -0700 | [diff] [blame] | 911 | const auto defined_type = typenames.TryGetDefinedType(GetName()); |
| 912 | if (defined_type != nullptr && defined_type->AsParcelable() != nullptr) { |
| 913 | AIDL_ERROR(this) << "The NDK backend does not support nullable array of parcelable"; |
| 914 | return false; |
| 915 | } |
| 916 | } |
Steven Moreland | c8a4ca8 | 2020-01-21 17:50:08 -0800 | [diff] [blame] | 917 | if (this->GetName() == "FileDescriptor" && lang == Options::Language::NDK) { |
| 918 | AIDL_ERROR(this) << "FileDescriptor isn't supported with the NDK."; |
| 919 | return false; |
| 920 | } |
Jeongik Cha | 047c5ee | 2019-08-07 23:16:49 +0900 | [diff] [blame] | 921 | if (this->IsGeneric()) { |
| 922 | if (this->GetName() == "List") { |
| 923 | if (this->GetTypeParameters().size() != 1) { |
| 924 | AIDL_ERROR(this) << "List must have only one type parameter."; |
| 925 | return false; |
| 926 | } |
| 927 | if (lang == Options::Language::CPP) { |
Devin Moore | 2ac52f9 | 2020-03-23 15:39:36 -0700 | [diff] [blame] | 928 | const string& contained_type = this->GetTypeParameters()[0]->GetName(); |
| 929 | if (!(contained_type == "String" || contained_type == "IBinder")) { |
| 930 | AIDL_ERROR(this) << "List<" << contained_type |
| 931 | << "> is not supported. List in cpp supports only String and IBinder."; |
Jeongik Cha | 047c5ee | 2019-08-07 23:16:49 +0900 | [diff] [blame] | 932 | return false; |
| 933 | } |
Jeongik Cha | 08ca218 | 2019-11-21 14:01:13 +0900 | [diff] [blame] | 934 | } else if (lang == Options::Language::JAVA) { |
| 935 | const string& contained_type = this->GetTypeParameters()[0]->GetName(); |
| 936 | if (AidlTypenames::IsBuiltinTypename(contained_type)) { |
| 937 | if (contained_type != "String" && contained_type != "IBinder" && |
| 938 | contained_type != "ParcelFileDescriptor") { |
Devin Moore | 2ac52f9 | 2020-03-23 15:39:36 -0700 | [diff] [blame] | 939 | AIDL_ERROR(this) << "List<" << contained_type |
| 940 | << "> is not supported. List in Java supports only String, IBinder, " |
| 941 | "and ParcelFileDescriptor."; |
Jeongik Cha | 08ca218 | 2019-11-21 14:01:13 +0900 | [diff] [blame] | 942 | return false; |
| 943 | } |
| 944 | } |
Jeongik Cha | 047c5ee | 2019-08-07 23:16:49 +0900 | [diff] [blame] | 945 | } |
Jeongik Cha | bb55b5e | 2020-01-07 23:11:26 +0900 | [diff] [blame] | 946 | } |
| 947 | } |
Devin Moore | 6a01ca1 | 2020-08-28 10:24:19 -0700 | [diff] [blame^] | 948 | |
| 949 | if (this->IsArray()) { |
| 950 | if (this->GetName() == "List" || this->GetName() == "Map" || |
| 951 | this->GetName() == "CharSequence") { |
| 952 | AIDL_ERROR(this) << this->GetName() << "[] is not supported."; |
Jeongik Cha | bb55b5e | 2020-01-07 23:11:26 +0900 | [diff] [blame] | 953 | return false; |
Jeongik Cha | 047c5ee | 2019-08-07 23:16:49 +0900 | [diff] [blame] | 954 | } |
| 955 | } |
Devin Moore | 6a01ca1 | 2020-08-28 10:24:19 -0700 | [diff] [blame^] | 956 | |
| 957 | if (lang != Options::Language::JAVA) { |
| 958 | if (this->GetName() == "List" && !this->IsGeneric()) { |
| 959 | AIDL_ERROR(this) << "Currently, only the Java backend supports non-generic List."; |
| 960 | return false; |
| 961 | } |
| 962 | if (this->GetName() == "Map" || this->GetName() == "CharSequence") { |
| 963 | AIDL_ERROR(this) << "Currently, only Java backend supports " << this->GetName() << "."; |
| 964 | return false; |
Jeongik Cha | 08ca218 | 2019-11-21 14:01:13 +0900 | [diff] [blame] | 965 | } |
| 966 | } |
| 967 | |
Jeongik Cha | 047c5ee | 2019-08-07 23:16:49 +0900 | [diff] [blame] | 968 | return true; |
| 969 | } |
| 970 | |
| 971 | // TODO: we should treat every backend all the same in future. |
Steven Moreland | d59e317 | 2020-05-11 16:42:09 -0700 | [diff] [blame] | 972 | bool AidlParcelable::LanguageSpecificCheckValid(const AidlTypenames& /*typenames*/, |
| 973 | Options::Language lang) const { |
Jeongik Cha | 047c5ee | 2019-08-07 23:16:49 +0900 | [diff] [blame] | 974 | if (lang != Options::Language::JAVA) { |
Steven Moreland | 0d9c26e | 2020-01-22 08:52:08 -0800 | [diff] [blame] | 975 | const AidlParcelable* unstructured_parcelable = this->AsUnstructuredParcelable(); |
| 976 | if (unstructured_parcelable != nullptr) { |
| 977 | if (unstructured_parcelable->GetCppHeader().empty()) { |
| 978 | AIDL_ERROR(unstructured_parcelable) |
Jeongik Cha | 047c5ee | 2019-08-07 23:16:49 +0900 | [diff] [blame] | 979 | << "Unstructured parcelable must have C++ header defined."; |
| 980 | return false; |
| 981 | } |
| 982 | } |
| 983 | } |
| 984 | return true; |
| 985 | } |
| 986 | |
| 987 | // TODO: we should treat every backend all the same in future. |
Steven Moreland | d59e317 | 2020-05-11 16:42:09 -0700 | [diff] [blame] | 988 | bool AidlStructuredParcelable::LanguageSpecificCheckValid(const AidlTypenames& typenames, |
| 989 | Options::Language lang) const { |
| 990 | if (!AidlParcelable::LanguageSpecificCheckValid(typenames, lang)) { |
Jeongik Cha | 047c5ee | 2019-08-07 23:16:49 +0900 | [diff] [blame] | 991 | return false; |
| 992 | } |
| 993 | for (const auto& v : this->GetFields()) { |
Steven Moreland | d59e317 | 2020-05-11 16:42:09 -0700 | [diff] [blame] | 994 | if (!v->GetType().LanguageSpecificCheckValid(typenames, lang)) { |
Jeongik Cha | 047c5ee | 2019-08-07 23:16:49 +0900 | [diff] [blame] | 995 | return false; |
| 996 | } |
| 997 | } |
| 998 | return true; |
| 999 | } |
| 1000 | |
Daniel Norman | 85aed54 | 2019-08-21 12:01:14 -0700 | [diff] [blame] | 1001 | AidlEnumerator::AidlEnumerator(const AidlLocation& location, const std::string& name, |
Daniel Norman | 2e4112d | 2019-10-03 10:22:35 -0700 | [diff] [blame] | 1002 | AidlConstantValue* value, const std::string& comments) |
| 1003 | : AidlNode(location), name_(name), value_(value), comments_(comments) {} |
Daniel Norman | 85aed54 | 2019-08-21 12:01:14 -0700 | [diff] [blame] | 1004 | |
| 1005 | bool AidlEnumerator::CheckValid(const AidlTypeSpecifier& enum_backing_type) const { |
| 1006 | if (GetValue() == nullptr) { |
| 1007 | return false; |
| 1008 | } |
| 1009 | if (!GetValue()->CheckValid()) { |
| 1010 | return false; |
| 1011 | } |
Will McVicker | d7d18df | 2019-09-12 13:40:50 -0700 | [diff] [blame] | 1012 | if (GetValue()->ValueString(enum_backing_type, AidlConstantValueDecorator).empty()) { |
Daniel Norman | 85aed54 | 2019-08-21 12:01:14 -0700 | [diff] [blame] | 1013 | AIDL_ERROR(this) << "Enumerator type differs from enum backing type."; |
| 1014 | return false; |
| 1015 | } |
| 1016 | return true; |
| 1017 | } |
| 1018 | |
| 1019 | string AidlEnumerator::ValueString(const AidlTypeSpecifier& backing_type, |
| 1020 | const ConstantValueDecorator& decorator) const { |
Will McVicker | d7d18df | 2019-09-12 13:40:50 -0700 | [diff] [blame] | 1021 | return GetValue()->ValueString(backing_type, decorator); |
Daniel Norman | 85aed54 | 2019-08-21 12:01:14 -0700 | [diff] [blame] | 1022 | } |
| 1023 | |
| 1024 | AidlEnumDeclaration::AidlEnumDeclaration(const AidlLocation& location, const std::string& name, |
| 1025 | std::vector<std::unique_ptr<AidlEnumerator>>* enumerators, |
Jiyong Park | 1813218 | 2020-06-08 20:24:40 +0900 | [diff] [blame] | 1026 | const std::string& package, const std::string& comments) |
Daniel Norman | 2e4112d | 2019-10-03 10:22:35 -0700 | [diff] [blame] | 1027 | : AidlDefinedType(location, name, comments, package), enumerators_(std::move(*enumerators)) {} |
Daniel Norman | 85aed54 | 2019-08-21 12:01:14 -0700 | [diff] [blame] | 1028 | |
| 1029 | void AidlEnumDeclaration::SetBackingType(std::unique_ptr<const AidlTypeSpecifier> type) { |
| 1030 | backing_type_ = std::move(type); |
| 1031 | } |
| 1032 | |
Steven Moreland | 59e53e4 | 2019-11-26 20:38:08 -0800 | [diff] [blame] | 1033 | bool AidlEnumDeclaration::Autofill() { |
Daniel Norman | b28684e | 2019-10-17 15:31:39 -0700 | [diff] [blame] | 1034 | const AidlEnumerator* previous = nullptr; |
| 1035 | for (const auto& enumerator : enumerators_) { |
| 1036 | if (enumerator->GetValue() == nullptr) { |
| 1037 | if (previous == nullptr) { |
Devin Moore | df93ebb | 2020-03-25 14:03:35 -0700 | [diff] [blame] | 1038 | enumerator->SetValue( |
| 1039 | std::unique_ptr<AidlConstantValue>(AidlConstantValue::Integral(GetLocation(), "0"))); |
Daniel Norman | b28684e | 2019-10-17 15:31:39 -0700 | [diff] [blame] | 1040 | } else { |
Steven Moreland | 59e53e4 | 2019-11-26 20:38:08 -0800 | [diff] [blame] | 1041 | auto prev_value = std::unique_ptr<AidlConstantValue>( |
| 1042 | AidlConstantValue::ShallowIntegralCopy(*previous->GetValue())); |
| 1043 | if (prev_value == nullptr) { |
| 1044 | return false; |
| 1045 | } |
Daniel Norman | b28684e | 2019-10-17 15:31:39 -0700 | [diff] [blame] | 1046 | enumerator->SetValue(std::make_unique<AidlBinaryConstExpression>( |
Devin Moore | df93ebb | 2020-03-25 14:03:35 -0700 | [diff] [blame] | 1047 | GetLocation(), std::move(prev_value), "+", |
| 1048 | std::unique_ptr<AidlConstantValue>(AidlConstantValue::Integral(GetLocation(), "1")))); |
Daniel Norman | b28684e | 2019-10-17 15:31:39 -0700 | [diff] [blame] | 1049 | } |
| 1050 | } |
| 1051 | previous = enumerator.get(); |
| 1052 | } |
Steven Moreland | 59e53e4 | 2019-11-26 20:38:08 -0800 | [diff] [blame] | 1053 | return true; |
Daniel Norman | b28684e | 2019-10-17 15:31:39 -0700 | [diff] [blame] | 1054 | } |
| 1055 | |
Steven Moreland | 0cea4aa | 2020-04-20 21:06:02 -0700 | [diff] [blame] | 1056 | std::set<AidlAnnotation::Type> AidlEnumDeclaration::GetSupportedAnnotations() const { |
| 1057 | return {AidlAnnotation::Type::VINTF_STABILITY, AidlAnnotation::Type::BACKING, |
Jiyong Park | bf5fd5c | 2020-06-05 19:48:05 +0900 | [diff] [blame] | 1058 | AidlAnnotation::Type::HIDE, AidlAnnotation::Type::JAVA_PASSTHROUGH}; |
Devin Moore | 24f6857 | 2020-02-26 13:20:59 -0800 | [diff] [blame] | 1059 | } |
| 1060 | |
| 1061 | bool AidlEnumDeclaration::CheckValid(const AidlTypenames& typenames) const { |
| 1062 | if (!AidlDefinedType::CheckValid(typenames)) { |
| 1063 | return false; |
| 1064 | } |
Daniel Norman | 85aed54 | 2019-08-21 12:01:14 -0700 | [diff] [blame] | 1065 | if (backing_type_ == nullptr) { |
| 1066 | AIDL_ERROR(this) << "Enum declaration missing backing type."; |
| 1067 | return false; |
| 1068 | } |
| 1069 | bool success = true; |
| 1070 | for (const auto& enumerator : enumerators_) { |
| 1071 | success = success && enumerator->CheckValid(GetBackingType()); |
| 1072 | } |
| 1073 | return success; |
| 1074 | } |
| 1075 | |
Jeongik Cha | 997281d | 2020-01-16 15:23:59 +0900 | [diff] [blame] | 1076 | void AidlEnumDeclaration::Dump(CodeWriter* writer) const { |
Steven Moreland | a5d9c5c | 2020-02-21 16:01:09 -0800 | [diff] [blame] | 1077 | DumpHeader(writer); |
Daniel Norman | 37d43dd | 2019-09-09 17:22:34 -0700 | [diff] [blame] | 1078 | writer->Write("enum %s {\n", GetName().c_str()); |
Daniel Norman | 85aed54 | 2019-08-21 12:01:14 -0700 | [diff] [blame] | 1079 | writer->Indent(); |
| 1080 | for (const auto& enumerator : GetEnumerators()) { |
Daniel Norman | 85aed54 | 2019-08-21 12:01:14 -0700 | [diff] [blame] | 1081 | writer->Write("%s = %s,\n", enumerator->GetName().c_str(), |
| 1082 | enumerator->ValueString(GetBackingType(), AidlConstantValueDecorator).c_str()); |
| 1083 | } |
| 1084 | writer->Dedent(); |
| 1085 | writer->Write("}\n"); |
| 1086 | } |
| 1087 | |
Jeongik Cha | 047c5ee | 2019-08-07 23:16:49 +0900 | [diff] [blame] | 1088 | // TODO: we should treat every backend all the same in future. |
Steven Moreland | d59e317 | 2020-05-11 16:42:09 -0700 | [diff] [blame] | 1089 | bool AidlInterface::LanguageSpecificCheckValid(const AidlTypenames& typenames, |
| 1090 | Options::Language lang) const { |
Jeongik Cha | 047c5ee | 2019-08-07 23:16:49 +0900 | [diff] [blame] | 1091 | for (const auto& m : this->GetMethods()) { |
Steven Moreland | d59e317 | 2020-05-11 16:42:09 -0700 | [diff] [blame] | 1092 | if (!m->GetType().LanguageSpecificCheckValid(typenames, lang)) { |
Jeongik Cha | 047c5ee | 2019-08-07 23:16:49 +0900 | [diff] [blame] | 1093 | return false; |
| 1094 | } |
| 1095 | for (const auto& arg : m->GetArguments()) { |
Steven Moreland | d59e317 | 2020-05-11 16:42:09 -0700 | [diff] [blame] | 1096 | if (!arg->GetType().LanguageSpecificCheckValid(typenames, lang)) { |
Jeongik Cha | 047c5ee | 2019-08-07 23:16:49 +0900 | [diff] [blame] | 1097 | return false; |
| 1098 | } |
| 1099 | } |
| 1100 | } |
| 1101 | return true; |
| 1102 | } |
| 1103 | |
Steven Moreland | 46e9da8 | 2018-07-27 15:45:29 -0700 | [diff] [blame] | 1104 | AidlInterface::AidlInterface(const AidlLocation& location, const std::string& name, |
Casey Dahlin | fb7da2e | 2015-10-08 17:26:09 -0700 | [diff] [blame] | 1105 | const std::string& comments, bool oneway, |
Casey Dahlin | d40e2fe | 2015-11-24 14:06:52 -0800 | [diff] [blame] | 1106 | std::vector<std::unique_ptr<AidlMember>>* members, |
Jiyong Park | 1813218 | 2020-06-08 20:24:40 +0900 | [diff] [blame] | 1107 | const std::string& package) |
Steven Moreland | acd5347 | 2018-12-14 10:17:26 -0800 | [diff] [blame] | 1108 | : AidlDefinedType(location, name, comments, package) { |
Casey Dahlin | d40e2fe | 2015-11-24 14:06:52 -0800 | [diff] [blame] | 1109 | for (auto& member : *members) { |
| 1110 | AidlMember* local = member.release(); |
| 1111 | AidlMethod* method = local->AsMethod(); |
Steven Moreland | 693640b | 2018-07-19 13:46:27 -0700 | [diff] [blame] | 1112 | AidlConstantDeclaration* constant = local->AsConstantDeclaration(); |
| 1113 | |
| 1114 | CHECK(method == nullptr || constant == nullptr); |
Casey Dahlin | d40e2fe | 2015-11-24 14:06:52 -0800 | [diff] [blame] | 1115 | |
| 1116 | if (method) { |
Steven Moreland | 8c70ba9 | 2018-12-17 10:20:31 -0800 | [diff] [blame] | 1117 | method->ApplyInterfaceOneway(oneway); |
Casey Dahlin | d40e2fe | 2015-11-24 14:06:52 -0800 | [diff] [blame] | 1118 | methods_.emplace_back(method); |
Steven Moreland | 693640b | 2018-07-19 13:46:27 -0700 | [diff] [blame] | 1119 | } else if (constant) { |
| 1120 | constants_.emplace_back(constant); |
Casey Dahlin | d40e2fe | 2015-11-24 14:06:52 -0800 | [diff] [blame] | 1121 | } else { |
Steven Moreland | 46e9da8 | 2018-07-27 15:45:29 -0700 | [diff] [blame] | 1122 | AIDL_FATAL(this) << "Member is neither method nor constant!"; |
Casey Dahlin | d40e2fe | 2015-11-24 14:06:52 -0800 | [diff] [blame] | 1123 | } |
| 1124 | } |
| 1125 | |
| 1126 | delete members; |
Casey Dahlin | fb7da2e | 2015-10-08 17:26:09 -0700 | [diff] [blame] | 1127 | } |
| 1128 | |
Jeongik Cha | 997281d | 2020-01-16 15:23:59 +0900 | [diff] [blame] | 1129 | void AidlInterface::Dump(CodeWriter* writer) const { |
Steven Moreland | a5d9c5c | 2020-02-21 16:01:09 -0800 | [diff] [blame] | 1130 | DumpHeader(writer); |
Jiyong Park | 02da742 | 2018-07-16 16:00:26 +0900 | [diff] [blame] | 1131 | writer->Write("interface %s {\n", GetName().c_str()); |
| 1132 | writer->Indent(); |
| 1133 | for (const auto& method : GetMethods()) { |
Jeongik Cha | 997281d | 2020-01-16 15:23:59 +0900 | [diff] [blame] | 1134 | if (method->IsHidden()) { |
| 1135 | AddHideComment(writer); |
| 1136 | } |
Jiyong Park | 309668e | 2018-07-28 16:55:44 +0900 | [diff] [blame] | 1137 | writer->Write("%s;\n", method->ToString().c_str()); |
Jiyong Park | 02da742 | 2018-07-16 16:00:26 +0900 | [diff] [blame] | 1138 | } |
Jiyong Park | a428d21 | 2018-08-29 22:26:30 +0900 | [diff] [blame] | 1139 | for (const auto& constdecl : GetConstantDeclarations()) { |
Jeongik Cha | 997281d | 2020-01-16 15:23:59 +0900 | [diff] [blame] | 1140 | if (constdecl->GetType().IsHidden()) { |
| 1141 | AddHideComment(writer); |
| 1142 | } |
Jiyong Park | a428d21 | 2018-08-29 22:26:30 +0900 | [diff] [blame] | 1143 | writer->Write("%s;\n", constdecl->ToString().c_str()); |
| 1144 | } |
Jiyong Park | 02da742 | 2018-07-16 16:00:26 +0900 | [diff] [blame] | 1145 | writer->Dedent(); |
| 1146 | writer->Write("}\n"); |
| 1147 | } |
| 1148 | |
Steven Moreland | 0cea4aa | 2020-04-20 21:06:02 -0700 | [diff] [blame] | 1149 | std::set<AidlAnnotation::Type> AidlInterface::GetSupportedAnnotations() const { |
| 1150 | return {AidlAnnotation::Type::VINTF_STABILITY, AidlAnnotation::Type::UNSUPPORTED_APP_USAGE, |
Jiyong Park | 27fd7fd | 2020-08-27 16:25:09 +0900 | [diff] [blame] | 1151 | AidlAnnotation::Type::HIDE, AidlAnnotation::Type::JAVA_PASSTHROUGH, |
| 1152 | AidlAnnotation::Type::DESCRIPTOR}; |
Devin Moore | 24f6857 | 2020-02-26 13:20:59 -0800 | [diff] [blame] | 1153 | } |
| 1154 | |
Jeongik Cha | db0f59e | 2018-11-01 18:11:21 +0900 | [diff] [blame] | 1155 | bool AidlInterface::CheckValid(const AidlTypenames& typenames) const { |
Devin Moore | 24f6857 | 2020-02-26 13:20:59 -0800 | [diff] [blame] | 1156 | if (!AidlDefinedType::CheckValid(typenames)) { |
Andrei Onea | 9445fc6 | 2019-06-27 18:11:59 +0100 | [diff] [blame] | 1157 | return false; |
| 1158 | } |
Jeongik Cha | db0f59e | 2018-11-01 18:11:21 +0900 | [diff] [blame] | 1159 | // Has to be a pointer due to deleting copy constructor. No idea why. |
| 1160 | map<string, const AidlMethod*> method_names; |
| 1161 | for (const auto& m : GetMethods()) { |
Jeongik Cha | db0f59e | 2018-11-01 18:11:21 +0900 | [diff] [blame] | 1162 | if (!m->GetType().CheckValid(typenames)) { |
| 1163 | return false; |
| 1164 | } |
| 1165 | |
Jeongik Cha | 649e8a7 | 2020-03-27 17:47:40 +0900 | [diff] [blame] | 1166 | // TODO(b/156872582): Support it when ParcelableHolder supports every backend. |
| 1167 | if (m->GetType().GetName() == "ParcelableHolder") { |
| 1168 | AIDL_ERROR(m) << "ParcelableHolder cannot be a return type"; |
| 1169 | return false; |
| 1170 | } |
Steven Moreland | acd5347 | 2018-12-14 10:17:26 -0800 | [diff] [blame] | 1171 | if (m->IsOneway() && m->GetType().GetName() != "void") { |
Jeongik Cha | db0f59e | 2018-11-01 18:11:21 +0900 | [diff] [blame] | 1172 | AIDL_ERROR(m) << "oneway method '" << m->GetName() << "' cannot return a value"; |
| 1173 | return false; |
| 1174 | } |
| 1175 | |
| 1176 | set<string> argument_names; |
| 1177 | for (const auto& arg : m->GetArguments()) { |
| 1178 | auto it = argument_names.find(arg->GetName()); |
| 1179 | if (it != argument_names.end()) { |
| 1180 | AIDL_ERROR(m) << "method '" << m->GetName() << "' has duplicate argument name '" |
| 1181 | << arg->GetName() << "'"; |
| 1182 | return false; |
| 1183 | } |
| 1184 | argument_names.insert(arg->GetName()); |
| 1185 | |
| 1186 | if (!arg->GetType().CheckValid(typenames)) { |
| 1187 | return false; |
| 1188 | } |
| 1189 | |
Jeongik Cha | 649e8a7 | 2020-03-27 17:47:40 +0900 | [diff] [blame] | 1190 | // TODO(b/156872582): Support it when ParcelableHolder supports every backend. |
| 1191 | if (arg->GetType().GetName() == "ParcelableHolder") { |
| 1192 | AIDL_ERROR(arg) << "ParcelableHolder cannot be an argument type"; |
| 1193 | return false; |
| 1194 | } |
Steven Moreland | acd5347 | 2018-12-14 10:17:26 -0800 | [diff] [blame] | 1195 | if (m->IsOneway() && arg->IsOut()) { |
Jeongik Cha | db0f59e | 2018-11-01 18:11:21 +0900 | [diff] [blame] | 1196 | AIDL_ERROR(m) << "oneway method '" << m->GetName() << "' cannot have out parameters"; |
| 1197 | return false; |
| 1198 | } |
Jeongik Cha | 047c5ee | 2019-08-07 23:16:49 +0900 | [diff] [blame] | 1199 | const bool can_be_out = typenames.CanBeOutParameter(arg->GetType()); |
| 1200 | if (!arg->DirectionWasSpecified() && can_be_out) { |
| 1201 | AIDL_ERROR(arg) << "'" << arg->GetType().ToString() |
| 1202 | << "' can be an out type, so you must declare it as in, out, or inout."; |
| 1203 | return false; |
| 1204 | } |
| 1205 | |
| 1206 | if (arg->GetDirection() != AidlArgument::IN_DIR && !can_be_out) { |
| 1207 | AIDL_ERROR(arg) << "'" << arg->ToString() << "' can only be an in parameter."; |
| 1208 | return false; |
| 1209 | } |
| 1210 | |
| 1211 | // check that the name doesn't match a keyword |
Jeongik Cha | 997281d | 2020-01-16 15:23:59 +0900 | [diff] [blame] | 1212 | if (IsJavaKeyword(arg->GetName().c_str())) { |
Jeongik Cha | 047c5ee | 2019-08-07 23:16:49 +0900 | [diff] [blame] | 1213 | AIDL_ERROR(arg) << "Argument name is a Java or aidl keyword"; |
| 1214 | return false; |
| 1215 | } |
| 1216 | |
| 1217 | // Reserve a namespace for internal use |
| 1218 | if (android::base::StartsWith(arg->GetName(), "_aidl")) { |
| 1219 | AIDL_ERROR(arg) << "Argument name cannot begin with '_aidl'"; |
| 1220 | return false; |
| 1221 | } |
Jeongik Cha | db0f59e | 2018-11-01 18:11:21 +0900 | [diff] [blame] | 1222 | } |
| 1223 | |
| 1224 | auto it = method_names.find(m->GetName()); |
| 1225 | // prevent duplicate methods |
| 1226 | if (it == method_names.end()) { |
| 1227 | method_names[m->GetName()] = m.get(); |
| 1228 | } else { |
| 1229 | AIDL_ERROR(m) << "attempt to redefine method " << m->GetName() << ":"; |
| 1230 | AIDL_ERROR(it->second) << "previously defined here."; |
| 1231 | return false; |
| 1232 | } |
| 1233 | |
Paul Trautrim | b77048c | 2020-01-21 16:39:32 +0900 | [diff] [blame] | 1234 | static set<string> reserved_methods{"asBinder()", "getInterfaceHash()", "getInterfaceVersion()", |
Jeongik Cha | db0f59e | 2018-11-01 18:11:21 +0900 | [diff] [blame] | 1235 | "getTransactionName(int)"}; |
| 1236 | |
| 1237 | if (reserved_methods.find(m->Signature()) != reserved_methods.end()) { |
Devin Moore | 097a3ab | 2020-03-11 16:08:44 -0700 | [diff] [blame] | 1238 | AIDL_ERROR(m) << " method " << m->Signature() << " is reserved for internal use."; |
Jeongik Cha | db0f59e | 2018-11-01 18:11:21 +0900 | [diff] [blame] | 1239 | return false; |
| 1240 | } |
| 1241 | } |
Steven Moreland | 4d12f9a | 2018-10-31 14:30:55 -0700 | [diff] [blame] | 1242 | |
| 1243 | bool success = true; |
| 1244 | set<string> constant_names; |
| 1245 | for (const std::unique_ptr<AidlConstantDeclaration>& constant : GetConstantDeclarations()) { |
| 1246 | if (constant_names.count(constant->GetName()) > 0) { |
Devin Moore | 097a3ab | 2020-03-11 16:08:44 -0700 | [diff] [blame] | 1247 | AIDL_ERROR(constant) << "Found duplicate constant name '" << constant->GetName() << "'"; |
Steven Moreland | 4d12f9a | 2018-10-31 14:30:55 -0700 | [diff] [blame] | 1248 | success = false; |
| 1249 | } |
| 1250 | constant_names.insert(constant->GetName()); |
| 1251 | success = success && constant->CheckValid(typenames); |
| 1252 | } |
| 1253 | |
| 1254 | return success; |
Jeongik Cha | db0f59e | 2018-11-01 18:11:21 +0900 | [diff] [blame] | 1255 | } |
| 1256 | |
Jiyong Park | 27fd7fd | 2020-08-27 16:25:09 +0900 | [diff] [blame] | 1257 | std::string AidlInterface::GetDescriptor() const { |
| 1258 | std::string annotatedDescriptor = AidlAnnotatable::GetDescriptor(); |
| 1259 | if (annotatedDescriptor != "") { |
| 1260 | return annotatedDescriptor; |
| 1261 | } |
| 1262 | return GetCanonicalName(); |
| 1263 | } |
| 1264 | |
Steven Moreland | 46e9da8 | 2018-07-27 15:45:29 -0700 | [diff] [blame] | 1265 | AidlImport::AidlImport(const AidlLocation& location, const std::string& needed_class) |
| 1266 | : AidlNode(location), needed_class_(needed_class) {} |