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 | 84f89de | 2016-07-28 15:39:51 -0700 | [diff] [blame] | 17 | #include "FQName.h" |
| 18 | |
Iliyan Malchev | a72e0d2 | 2016-09-09 11:03:08 -0700 | [diff] [blame] | 19 | #include <hidl-util/StringHelper.h> |
Andreas Huber | 84f89de | 2016-07-28 15:39:51 -0700 | [diff] [blame] | 20 | #include <android-base/logging.h> |
Iliyan Malchev | 800273d | 2016-09-02 15:25:07 -0700 | [diff] [blame] | 21 | #include <iostream> |
Andreas Huber | 84f89de | 2016-07-28 15:39:51 -0700 | [diff] [blame] | 22 | #include <regex> |
Iliyan Malchev | 800273d | 2016-09-02 15:25:07 -0700 | [diff] [blame] | 23 | #include <sstream> |
Andreas Huber | 84f89de | 2016-07-28 15:39:51 -0700 | [diff] [blame] | 24 | |
| 25 | #define RE_COMPONENT "[a-zA-Z_][a-zA-Z_0-9]*" |
| 26 | #define RE_PATH RE_COMPONENT "([.]" RE_COMPONENT ")*" |
| 27 | #define RE_VERSION "@[0-9]+[.][0-9]+" |
| 28 | |
| 29 | static const std::regex kRE1("(" RE_PATH ")(" RE_VERSION ")?::(" RE_PATH ")"); |
| 30 | static const std::regex kRE2("(" RE_VERSION ")::(" RE_PATH ")"); |
Andreas Huber | da51b8e | 2016-07-28 16:00:57 -0700 | [diff] [blame] | 31 | static const std::regex kRE3("(" RE_PATH ")(" RE_VERSION ")"); |
Yifan Hong | b44a6c8 | 2016-09-22 15:50:18 -0700 | [diff] [blame] | 32 | static const std::regex kRE4("(" RE_COMPONENT ")([.]" RE_COMPONENT ")+"); |
| 33 | static const std::regex kRE5("(" RE_COMPONENT ")"); |
| 34 | |
| 35 | static const std::regex kRE6("(" RE_PATH ")(" RE_VERSION ")?::(" RE_PATH "):(" RE_COMPONENT ")"); |
| 36 | static const std::regex kRE7("(" RE_VERSION ")::(" RE_PATH "):(" RE_COMPONENT ")"); |
| 37 | static const std::regex kRE8("(" RE_PATH "):(" RE_COMPONENT ")"); |
Andreas Huber | 84f89de | 2016-07-28 15:39:51 -0700 | [diff] [blame] | 38 | |
| 39 | namespace android { |
| 40 | |
Andreas Huber | da51b8e | 2016-07-28 16:00:57 -0700 | [diff] [blame] | 41 | FQName::FQName() |
Yifan Hong | b44a6c8 | 2016-09-22 15:50:18 -0700 | [diff] [blame] | 42 | : mValid(false), mIsIdentifier(false) { |
Andreas Huber | da51b8e | 2016-07-28 16:00:57 -0700 | [diff] [blame] | 43 | } |
| 44 | |
Andreas Huber | 84f89de | 2016-07-28 15:39:51 -0700 | [diff] [blame] | 45 | FQName::FQName(const std::string &s) |
Yifan Hong | b44a6c8 | 2016-09-22 15:50:18 -0700 | [diff] [blame] | 46 | : mValid(false), mIsIdentifier(false) { |
Andreas Huber | 84f89de | 2016-07-28 15:39:51 -0700 | [diff] [blame] | 47 | setTo(s); |
| 48 | } |
| 49 | |
Andreas Huber | 68f2459 | 2016-07-29 14:53:48 -0700 | [diff] [blame] | 50 | FQName::FQName( |
| 51 | const std::string &package, |
| 52 | const std::string &version, |
Yifan Hong | b44a6c8 | 2016-09-22 15:50:18 -0700 | [diff] [blame] | 53 | const std::string &name, |
| 54 | const std::string &valueName) |
Andreas Huber | 68f2459 | 2016-07-29 14:53:48 -0700 | [diff] [blame] | 55 | : mValid(true), |
Yifan Hong | b44a6c8 | 2016-09-22 15:50:18 -0700 | [diff] [blame] | 56 | mIsIdentifier(false), |
Andreas Huber | 68f2459 | 2016-07-29 14:53:48 -0700 | [diff] [blame] | 57 | mPackage(package), |
| 58 | mVersion(version), |
Yifan Hong | b44a6c8 | 2016-09-22 15:50:18 -0700 | [diff] [blame] | 59 | mName(name), |
| 60 | mValueName(valueName) { |
Andreas Huber | 68f2459 | 2016-07-29 14:53:48 -0700 | [diff] [blame] | 61 | } |
| 62 | |
Yifan Hong | f24fa85 | 2016-09-23 11:03:15 -0700 | [diff] [blame^] | 63 | FQName::FQName(const FQName& other) |
| 64 | : mValid(other.mValid), |
| 65 | mIsIdentifier(other.mIsIdentifier), |
| 66 | mPackage(other.mPackage), |
| 67 | mVersion(other.mVersion), |
| 68 | mName(other.mName), |
| 69 | mValueName(other.mValueName) { |
| 70 | } |
| 71 | |
Andreas Huber | 84f89de | 2016-07-28 15:39:51 -0700 | [diff] [blame] | 72 | bool FQName::isValid() const { |
| 73 | return mValid; |
| 74 | } |
| 75 | |
Yifan Hong | b44a6c8 | 2016-09-22 15:50:18 -0700 | [diff] [blame] | 76 | bool FQName::isIdentifier() const { |
| 77 | return mIsIdentifier; |
| 78 | } |
| 79 | |
Andreas Huber | 68f2459 | 2016-07-29 14:53:48 -0700 | [diff] [blame] | 80 | bool FQName::isFullyQualified() const { |
| 81 | return !mPackage.empty() && !mVersion.empty() && !mName.empty(); |
| 82 | } |
| 83 | |
Yifan Hong | b44a6c8 | 2016-09-22 15:50:18 -0700 | [diff] [blame] | 84 | bool FQName::isValidValueName() const { |
| 85 | return mIsIdentifier |
| 86 | || (!mName.empty() && !mValueName.empty()); |
| 87 | } |
| 88 | |
Andreas Huber | 84f89de | 2016-07-28 15:39:51 -0700 | [diff] [blame] | 89 | bool FQName::setTo(const std::string &s) { |
| 90 | mPackage.clear(); |
| 91 | mVersion.clear(); |
| 92 | mName.clear(); |
| 93 | |
| 94 | mValid = true; |
| 95 | |
| 96 | std::smatch match; |
| 97 | if (std::regex_match(s, match, kRE1)) { |
| 98 | CHECK_EQ(match.size(), 6u); |
| 99 | |
| 100 | mPackage = match.str(1); |
| 101 | mVersion = match.str(3); |
| 102 | mName = match.str(4); |
| 103 | } else if (std::regex_match(s, match, kRE2)) { |
| 104 | CHECK_EQ(match.size(), 4u); |
| 105 | |
| 106 | mVersion = match.str(1); |
| 107 | mName = match.str(2); |
| 108 | } else if (std::regex_match(s, match, kRE3)) { |
Andreas Huber | da51b8e | 2016-07-28 16:00:57 -0700 | [diff] [blame] | 109 | CHECK_EQ(match.size(), 4u); |
| 110 | |
| 111 | mPackage = match.str(1); |
| 112 | mVersion = match.str(3); |
| 113 | } else if (std::regex_match(s, match, kRE4)) { |
Andreas Huber | 84f89de | 2016-07-28 15:39:51 -0700 | [diff] [blame] | 114 | mName = match.str(0); |
Yifan Hong | b44a6c8 | 2016-09-22 15:50:18 -0700 | [diff] [blame] | 115 | } else if (std::regex_match(s, match, kRE5)) { |
| 116 | mIsIdentifier = true; |
| 117 | mName = match.str(0); |
| 118 | } else if (std::regex_match(s, match, kRE6)) { |
| 119 | CHECK_EQ(match.size(), 7u); |
| 120 | |
| 121 | mPackage = match.str(1); |
| 122 | mVersion = match.str(3); |
| 123 | mName = match.str(4); |
| 124 | mValueName = match.str(6); |
| 125 | } else if (std::regex_match(s, match, kRE7)) { |
| 126 | CHECK_EQ(match.size(), 5u); |
| 127 | |
| 128 | mVersion = match.str(1); |
| 129 | mName = match.str(2); |
| 130 | mValueName = match.str(4); |
| 131 | } else if (std::regex_match(s, match, kRE8)) { |
| 132 | CHECK_EQ(match.size(), 4u); |
| 133 | |
| 134 | mName = match.str(1); |
| 135 | mValueName = match.str(3); |
Andreas Huber | 84f89de | 2016-07-28 15:39:51 -0700 | [diff] [blame] | 136 | } else { |
| 137 | mValid = false; |
| 138 | } |
| 139 | |
Yifan Hong | b44a6c8 | 2016-09-22 15:50:18 -0700 | [diff] [blame] | 140 | // mValueName must go with mName. |
| 141 | if (!mValueName.empty()) { |
| 142 | CHECK(!mName.empty()); |
| 143 | } |
| 144 | |
Andreas Huber | 84f89de | 2016-07-28 15:39:51 -0700 | [diff] [blame] | 145 | return isValid(); |
| 146 | } |
| 147 | |
| 148 | std::string FQName::package() const { |
| 149 | return mPackage; |
| 150 | } |
| 151 | |
| 152 | std::string FQName::version() const { |
| 153 | return mVersion; |
| 154 | } |
| 155 | |
| 156 | std::string FQName::name() const { |
| 157 | return mName; |
| 158 | } |
| 159 | |
Iliyan Malchev | 800273d | 2016-09-02 15:25:07 -0700 | [diff] [blame] | 160 | std::vector<std::string> FQName::names() const { |
| 161 | std::vector<std::string> res {}; |
| 162 | std::istringstream ss(name()); |
| 163 | std::string s; |
| 164 | while (std::getline(ss, s, '.')) { |
| 165 | res.push_back(s); |
| 166 | } |
| 167 | return res; |
| 168 | } |
| 169 | |
Yifan Hong | b44a6c8 | 2016-09-22 15:50:18 -0700 | [diff] [blame] | 170 | std::string FQName::valueName() const { |
| 171 | return mValueName; |
| 172 | } |
| 173 | |
| 174 | FQName FQName::typeName() const { |
| 175 | return FQName(mPackage, mVersion, mName); |
| 176 | } |
| 177 | |
Andreas Huber | 84f89de | 2016-07-28 15:39:51 -0700 | [diff] [blame] | 178 | void FQName::applyDefaults( |
| 179 | const std::string &defaultPackage, |
| 180 | const std::string &defaultVersion) { |
| 181 | if (mPackage.empty()) { |
| 182 | mPackage = defaultPackage; |
| 183 | } |
| 184 | |
| 185 | if (mVersion.empty()) { |
| 186 | mVersion = defaultVersion; |
| 187 | } |
| 188 | } |
| 189 | |
Andreas Huber | 68f2459 | 2016-07-29 14:53:48 -0700 | [diff] [blame] | 190 | std::string FQName::string() const { |
Andreas Huber | 84f89de | 2016-07-28 15:39:51 -0700 | [diff] [blame] | 191 | CHECK(mValid); |
| 192 | |
Andreas Huber | 5345ec2 | 2016-07-29 13:33:27 -0700 | [diff] [blame] | 193 | std::string out; |
Andreas Huber | 84f89de | 2016-07-28 15:39:51 -0700 | [diff] [blame] | 194 | out.append(mPackage); |
| 195 | out.append(mVersion); |
Andreas Huber | da51b8e | 2016-07-28 16:00:57 -0700 | [diff] [blame] | 196 | if (!mName.empty()) { |
| 197 | if (!mPackage.empty() || !mVersion.empty()) { |
| 198 | out.append("::"); |
| 199 | } |
| 200 | out.append(mName); |
Yifan Hong | b44a6c8 | 2016-09-22 15:50:18 -0700 | [diff] [blame] | 201 | |
| 202 | if (!mValueName.empty()) { |
| 203 | out.append(":"); |
| 204 | out.append(mValueName); |
| 205 | } |
Andreas Huber | 84f89de | 2016-07-28 15:39:51 -0700 | [diff] [blame] | 206 | } |
Andreas Huber | 84f89de | 2016-07-28 15:39:51 -0700 | [diff] [blame] | 207 | |
| 208 | return out; |
| 209 | } |
| 210 | |
Andreas Huber | da51b8e | 2016-07-28 16:00:57 -0700 | [diff] [blame] | 211 | void FQName::print() const { |
| 212 | if (!mValid) { |
| 213 | LOG(INFO) << "INVALID"; |
| 214 | return; |
| 215 | } |
| 216 | |
Andreas Huber | 68f2459 | 2016-07-29 14:53:48 -0700 | [diff] [blame] | 217 | LOG(INFO) << string(); |
| 218 | } |
| 219 | |
| 220 | bool FQName::operator<(const FQName &other) const { |
| 221 | return string() < other.string(); |
Andreas Huber | da51b8e | 2016-07-28 16:00:57 -0700 | [diff] [blame] | 222 | } |
| 223 | |
Andreas Huber | d2943e1 | 2016-08-05 11:59:31 -0700 | [diff] [blame] | 224 | bool FQName::operator==(const FQName &other) const { |
| 225 | return string() == other.string(); |
| 226 | } |
| 227 | |
Steven Moreland | 197d56c | 2016-09-09 10:03:58 -0700 | [diff] [blame] | 228 | std::string FQName::getInterfaceBaseName() const { |
| 229 | CHECK(names().size() == 1) << "Must be a top level type"; |
| 230 | CHECK(!mName.empty() && mName[0] == 'I') << mName; |
| 231 | |
| 232 | // cut off the leading 'I'. |
| 233 | return mName.substr(1); |
| 234 | } |
| 235 | |
Steven Moreland | 9c38761 | 2016-09-07 09:54:26 -0700 | [diff] [blame] | 236 | const FQName FQName::getTopLevelType() const { |
| 237 | auto idx = mName.find('.'); |
| 238 | |
| 239 | if (idx == std::string::npos) { |
| 240 | return *this; |
| 241 | } |
| 242 | |
| 243 | return FQName(mPackage, mVersion, mName.substr(0, idx)); |
| 244 | } |
| 245 | |
| 246 | std::string FQName::tokenName() const { |
| 247 | std::vector<std::string> components; |
| 248 | getPackageAndVersionComponents(&components, true /* cpp_compatible */); |
| 249 | |
| 250 | std::vector<std::string> nameComponents; |
Steven Moreland | af44014 | 2016-09-07 10:09:11 -0700 | [diff] [blame] | 251 | StringHelper::SplitString(mName, '.', &nameComponents); |
Steven Moreland | 9c38761 | 2016-09-07 09:54:26 -0700 | [diff] [blame] | 252 | |
| 253 | components.insert(components.end(), nameComponents.begin(), nameComponents.end()); |
| 254 | |
Steven Moreland | af44014 | 2016-09-07 10:09:11 -0700 | [diff] [blame] | 255 | return StringHelper::JoinStrings(components, "_"); |
Steven Moreland | 9c38761 | 2016-09-07 09:54:26 -0700 | [diff] [blame] | 256 | } |
| 257 | |
Andreas Huber | 0e00de4 | 2016-08-03 09:56:02 -0700 | [diff] [blame] | 258 | std::string FQName::cppNamespace() const { |
| 259 | std::vector<std::string> components; |
| 260 | getPackageAndVersionComponents(&components, true /* cpp_compatible */); |
| 261 | |
| 262 | std::string out = "::"; |
Steven Moreland | af44014 | 2016-09-07 10:09:11 -0700 | [diff] [blame] | 263 | out += StringHelper::JoinStrings(components, "::"); |
Andreas Huber | 0e00de4 | 2016-08-03 09:56:02 -0700 | [diff] [blame] | 264 | |
| 265 | return out; |
| 266 | } |
| 267 | |
Steven Moreland | 979e099 | 2016-09-07 09:18:08 -0700 | [diff] [blame] | 268 | std::string FQName::cppLocalName() const { |
| 269 | std::vector<std::string> components; |
Steven Moreland | af44014 | 2016-09-07 10:09:11 -0700 | [diff] [blame] | 270 | StringHelper::SplitString(mName, '.', &components); |
Steven Moreland | 979e099 | 2016-09-07 09:18:08 -0700 | [diff] [blame] | 271 | |
Yifan Hong | b44a6c8 | 2016-09-22 15:50:18 -0700 | [diff] [blame] | 272 | return StringHelper::JoinStrings(components, "::") |
| 273 | + (mValueName.empty() ? "" : ("::" + mValueName)); |
Steven Moreland | 979e099 | 2016-09-07 09:18:08 -0700 | [diff] [blame] | 274 | } |
| 275 | |
Andreas Huber | 0e00de4 | 2016-08-03 09:56:02 -0700 | [diff] [blame] | 276 | std::string FQName::cppName() const { |
| 277 | std::string out = cppNamespace(); |
| 278 | |
| 279 | std::vector<std::string> components; |
Steven Moreland | af44014 | 2016-09-07 10:09:11 -0700 | [diff] [blame] | 280 | StringHelper::SplitString(name(), '.', &components); |
Andreas Huber | 0e00de4 | 2016-08-03 09:56:02 -0700 | [diff] [blame] | 281 | out += "::"; |
Steven Moreland | af44014 | 2016-09-07 10:09:11 -0700 | [diff] [blame] | 282 | out += StringHelper::JoinStrings(components, "::"); |
Yifan Hong | b44a6c8 | 2016-09-22 15:50:18 -0700 | [diff] [blame] | 283 | if (!mValueName.empty()) { |
| 284 | out += "::" + mValueName; |
| 285 | } |
Andreas Huber | 0e00de4 | 2016-08-03 09:56:02 -0700 | [diff] [blame] | 286 | |
| 287 | return out; |
| 288 | } |
| 289 | |
Andreas Huber | 2831d51 | 2016-08-15 09:33:47 -0700 | [diff] [blame] | 290 | std::string FQName::javaPackage() const { |
| 291 | std::vector<std::string> components; |
| 292 | getPackageAndVersionComponents(&components, true /* cpp_compatible */); |
| 293 | |
Steven Moreland | af44014 | 2016-09-07 10:09:11 -0700 | [diff] [blame] | 294 | return StringHelper::JoinStrings(components, "."); |
Andreas Huber | 2831d51 | 2016-08-15 09:33:47 -0700 | [diff] [blame] | 295 | } |
| 296 | |
| 297 | std::string FQName::javaName() const { |
Yifan Hong | b44a6c8 | 2016-09-22 15:50:18 -0700 | [diff] [blame] | 298 | return javaPackage() + "." + name() |
| 299 | + (mValueName.empty() ? "" : ("." + mValueName)); |
Andreas Huber | 2831d51 | 2016-08-15 09:33:47 -0700 | [diff] [blame] | 300 | } |
| 301 | |
Andreas Huber | 0e00de4 | 2016-08-03 09:56:02 -0700 | [diff] [blame] | 302 | void FQName::getPackageComponents(std::vector<std::string> *components) const { |
Steven Moreland | af44014 | 2016-09-07 10:09:11 -0700 | [diff] [blame] | 303 | StringHelper::SplitString(package(), '.', components); |
Andreas Huber | 0e00de4 | 2016-08-03 09:56:02 -0700 | [diff] [blame] | 304 | } |
| 305 | |
| 306 | void FQName::getPackageAndVersionComponents( |
| 307 | std::vector<std::string> *components, |
| 308 | bool cpp_compatible) const { |
| 309 | getPackageComponents(components); |
| 310 | |
Andreas Huber | 0e00de4 | 2016-08-03 09:56:02 -0700 | [diff] [blame] | 311 | if (!cpp_compatible) { |
Martijn Coenen | a21f149 | 2016-09-08 15:55:14 +0200 | [diff] [blame] | 312 | components->push_back(getPackageMajorVersion() + |
| 313 | "." + getPackageMinorVersion()); |
Andreas Huber | 0e00de4 | 2016-08-03 09:56:02 -0700 | [diff] [blame] | 314 | return; |
| 315 | } |
| 316 | |
Andreas Huber | 0e00de4 | 2016-08-03 09:56:02 -0700 | [diff] [blame] | 317 | // Form "Vmajor_minor". |
| 318 | std::string versionString = "V"; |
Martijn Coenen | a21f149 | 2016-09-08 15:55:14 +0200 | [diff] [blame] | 319 | versionString.append(getPackageMajorVersion()); |
Andreas Huber | 0e00de4 | 2016-08-03 09:56:02 -0700 | [diff] [blame] | 320 | versionString.append("_"); |
Martijn Coenen | a21f149 | 2016-09-08 15:55:14 +0200 | [diff] [blame] | 321 | versionString.append(getPackageMinorVersion()); |
Andreas Huber | 0e00de4 | 2016-08-03 09:56:02 -0700 | [diff] [blame] | 322 | |
| 323 | components->push_back(versionString); |
| 324 | } |
| 325 | |
Martijn Coenen | a21f149 | 2016-09-08 15:55:14 +0200 | [diff] [blame] | 326 | std::string FQName::getPackageMajorVersion() const { |
| 327 | const std::string packageVersion = version(); |
| 328 | CHECK(packageVersion[0] == '@'); |
| 329 | const size_t dotPos = packageVersion.find('.'); |
| 330 | CHECK(dotPos != std::string::npos); |
| 331 | return packageVersion.substr(1, dotPos - 1); |
| 332 | } |
| 333 | |
| 334 | std::string FQName::getPackageMinorVersion() const { |
| 335 | const std::string packageVersion = version(); |
| 336 | CHECK(packageVersion[0] == '@'); |
| 337 | const size_t dotPos = packageVersion.find('.'); |
| 338 | CHECK(dotPos != std::string::npos); |
| 339 | return packageVersion.substr(dotPos + 1); |
| 340 | } |
| 341 | |
Andreas Huber | 39fa718 | 2016-08-19 14:27:33 -0700 | [diff] [blame] | 342 | bool FQName::endsWith(const FQName &other) const { |
| 343 | std::string s1 = string(); |
| 344 | std::string s2 = other.string(); |
| 345 | |
| 346 | size_t pos = s1.rfind(s2); |
| 347 | if (pos == std::string::npos || pos + s2.size() != s1.size()) { |
| 348 | return false; |
| 349 | } |
| 350 | |
| 351 | if (pos > 0) { |
| 352 | // A match is only a match if it is preceded by a "boundary", i.e. |
| 353 | // we perform a component-wise match from the end. |
| 354 | // "az" is not a match for "android.hardware.foo@1.0::IFoo.bar.baz", |
| 355 | // "baz", "bar.baz", "IFoo.bar.baz" are. |
| 356 | |
| 357 | char separator = s1[pos - 1]; |
| 358 | if (separator != '.' && separator != ':') { |
| 359 | return false; |
| 360 | } |
| 361 | } |
| 362 | |
| 363 | return true; |
| 364 | } |
| 365 | |
Andreas Huber | 84f89de | 2016-07-28 15:39:51 -0700 | [diff] [blame] | 366 | } // namespace android |
| 367 | |