/* * Copyright (C) 2016 The Android Open Source Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ #include "FQName.h" #include #include #include #include #include namespace android { FQName::FQName() : mIsIdentifier(false) {} bool FQName::parse(const std::string& s, FQName* into) { return into->setTo(s); } FQName::FQName(const std::string& package, const std::string& version, const std::string& name, const std::string& valueName) { size_t majorVer, minorVer; CHECK(parseVersion(version, &majorVer, &minorVer)); CHECK(setTo(package, majorVer, minorVer, name, valueName)) << string(); } bool FQName::setTo(const std::string& package, size_t majorVer, size_t minorVer, const std::string& name, const std::string& valueName) { mPackage = package; mMajor = majorVer; mMinor = minorVer; mName = name; mValueName = valueName; FQName other; if (!parse(string(), &other)) return false; if ((*this) != other) return false; mIsIdentifier = other.isIdentifier(); return true; } bool FQName::isIdentifier() const { return mIsIdentifier; } bool FQName::isFullyQualified() const { return !mPackage.empty() && !version().empty() && !mName.empty(); } bool FQName::isValidValueName() const { return mIsIdentifier || (!mName.empty() && !mValueName.empty()); } bool FQName::isInterfaceName() const { return !mName.empty() && mName[0] == 'I' && mName.find('.') == std::string::npos; } static inline bool isIdentStart(char a) { return ('a' <= a && a <= 'z') || ('A' <= a && a <= 'Z') || a == '_'; } static inline bool isLeadingDigit(char a) { return '1' <= a && a <= '9'; } static inline bool isDigit(char a) { return '0' <= a && a <= '9'; } static inline bool isIdentBody(char a) { return isIdentStart(a) || isDigit(a); } // returns pointer to end of [a-zA-Z_][a-zA-Z0-9_]* static const char* eatIdent(const char* l, const char* end) { if (!(l < end && isIdentStart(*l++))) return nullptr; while (l < end && isIdentBody(*l)) l++; return l; } // returns pointer to end of (\.)* static const char* eatPackage(const char* l, const char* end) { if ((l = eatIdent(l, end)) == nullptr) return nullptr; while (l < end && *l == '.') { l++; if ((l = eatIdent(l, end)) == nullptr) return nullptr; } return l; } // returns pointer to end of [1-9][0-9]*|0 static const char* eatNumber(const char* l, const char* end) { if (!(l < end)) return nullptr; if (*l == '0') return l + 1; if (!isLeadingDigit(*l++)) return nullptr; while (l < end && isDigit(*l)) l++; return l; } bool FQName::setTo(const std::string &s) { clear(); if (s.empty()) return false; const char* l = s.c_str(); const char* end = l + s.size(); // android.hardware.foo@10.12::IFoo.Type:MY_ENUM_VALUE // S ES ES E S ES E // // S - start pointer // E - end pointer struct StartEnd { const char* start = nullptr; const char* end = nullptr; std::string string() { if (start == nullptr) return std::string(); return std::string(start, end - start); } }; StartEnd package, major, minor, name, type; if (l < end && isIdentStart(*l)) { package.start = l; if ((package.end = l = eatPackage(l, end)) == nullptr) return false; } if (l < end && *l == '@') { l++; major.start = l; if ((major.end = l = eatNumber(l, end)) == nullptr) return false; if (!(l < end && *l++ == '.')) return false; minor.start = l; if ((minor.end = l = eatNumber(l, end)) == nullptr) return false; } if (l < end && *l == ':') { l++; if (l < end && *l == ':') { l++; name.start = l; if ((name.end = l = eatPackage(l, end)) == nullptr) return false; if (l < end && *l++ == ':') { type.start = l; if ((type.end = l = eatIdent(l, end)) == nullptr) return false; } } else { type.start = l; if ((type.end = l = eatIdent(l, end)) == nullptr) return false; } } if (l < end) return false; CHECK((major.start == nullptr) == (minor.start == nullptr)); // if we only parse a package, consider this to be a name if (name.start == nullptr && major.start == nullptr) { name.start = package.start; name.end = package.end; package.start = package.end = nullptr; } // failures after this goto fail to clear mName = name.string(); mPackage = package.string(); mValueName = type.string(); if (major.start != nullptr) { if (!parseVersion(major.string(), minor.string(), &mMajor, &mMinor)) goto fail; } else if (mPackage.empty() && mValueName.empty() && name.end == eatIdent(name.start, name.end)) { // major.start == nullptr mIsIdentifier = true; } if (!mValueName.empty() && mName.empty()) goto fail; if (!mPackage.empty() && version().empty()) goto fail; return true; fail: clear(); return false; } std::string FQName::getRelativeFQName(const FQName& relativeTo) const { if (relativeTo.mPackage != mPackage) { return string(); } // Package is the same std::string out; if (relativeTo.version() != version()) { out.append(atVersion()); if (!mName.empty() && !version().empty()) { out.append("::"); } } if (!mName.empty()) { out.append(mName); if (!mValueName.empty()) { out.append(":"); out.append(mValueName); } } return out; } const std::string& FQName::package() const { return mPackage; } std::string FQName::version() const { if (!hasVersion()) { return ""; } return std::to_string(mMajor) + "." + std::to_string(mMinor); } std::string FQName::sanitizedVersion() const { if (!hasVersion()) { return ""; } return "V" + std::to_string(mMajor) + "_" + std::to_string(mMinor); } std::string FQName::atVersion() const { std::string v = version(); return v.empty() ? "" : ("@" + v); } void FQName::clear() { mIsIdentifier = false; mPackage.clear(); clearVersion(); mName.clear(); mValueName.clear(); } void FQName::clearVersion(size_t* majorVer, size_t* minorVer) { *majorVer = *minorVer = 0; } bool FQName::parseVersion(const std::string& majorStr, const std::string& minorStr, size_t* majorVer, size_t* minorVer) { bool versionParseSuccess = ::android::base::ParseUint(majorStr, majorVer) && ::android::base::ParseUint(minorStr, minorVer); if (!versionParseSuccess) { LOG(ERROR) << "numbers in " << majorStr << "." << minorStr << " are out of range."; } return versionParseSuccess; } bool FQName::parseVersion(const std::string& v, size_t* majorVer, size_t* minorVer) { if (v.empty()) { clearVersion(majorVer, minorVer); return true; } std::vector vs = base::Split(v, "."); if (vs.size() != 2) return false; return parseVersion(vs[0], vs[1], majorVer, minorVer); } bool FQName::setVersion(const std::string& v) { return parseVersion(v, &mMajor, &mMinor); } void FQName::clearVersion() { clearVersion(&mMajor, &mMinor); } bool FQName::parseVersion(const std::string& majorStr, const std::string& minorStr) { return parseVersion(majorStr, minorStr, &mMajor, &mMinor); } const std::string& FQName::name() const { return mName; } std::vector FQName::names() const { std::vector res {}; std::istringstream ss(name()); std::string s; while (std::getline(ss, s, '.')) { res.push_back(s); } return res; } const std::string& FQName::valueName() const { return mValueName; } FQName FQName::typeName() const { return FQName(mPackage, version(), mName); } void FQName::applyDefaults( const std::string &defaultPackage, const std::string &defaultVersion) { // package without version is not allowed. CHECK(mPackage.empty() || !version().empty()); if (mPackage.empty()) { mPackage = defaultPackage; } if (version().empty()) { CHECK(setVersion(defaultVersion)); } } std::string FQName::string() const { std::string out; out.append(mPackage); out.append(atVersion()); if (!mName.empty()) { if (!mPackage.empty() || !version().empty()) { out.append("::"); } out.append(mName); if (!mValueName.empty()) { out.append(":"); out.append(mValueName); } } return out; } bool FQName::operator<(const FQName &other) const { return string() < other.string(); } bool FQName::operator==(const FQName &other) const { return string() == other.string(); } bool FQName::operator!=(const FQName &other) const { return !(*this == other); } const std::string& FQName::getInterfaceName() const { CHECK(isInterfaceName()) << mName; return mName; } std::string FQName::getInterfaceBaseName() const { // cut off the leading 'I'. return getInterfaceName().substr(1); } std::string FQName::getInterfaceAdapterName() const { return "A" + getInterfaceBaseName(); } std::string FQName::getInterfaceHwName() const { return "IHw" + getInterfaceBaseName(); } std::string FQName::getInterfaceProxyName() const { return "BpHw" + getInterfaceBaseName(); } std::string FQName::getInterfaceStubName() const { return "BnHw" + getInterfaceBaseName(); } std::string FQName::getInterfacePassthroughName() const { return "Bs" + getInterfaceBaseName(); } FQName FQName::getInterfaceProxyFqName() const { return FQName(package(), version(), getInterfaceProxyName()); } FQName FQName::getInterfaceAdapterFqName() const { return FQName(package(), version(), getInterfaceAdapterName()); } FQName FQName::getInterfaceStubFqName() const { return FQName(package(), version(), getInterfaceStubName()); } FQName FQName::getInterfacePassthroughFqName() const { return FQName(package(), version(), getInterfacePassthroughName()); } FQName FQName::getTypesForPackage() const { return FQName(package(), version(), "types"); } FQName FQName::getPackageAndVersion() const { return FQName(package(), version(), ""); } FQName FQName::getTopLevelType() const { auto idx = mName.find('.'); if (idx == std::string::npos) { return *this; } return FQName(mPackage, version(), mName.substr(0, idx)); } std::string FQName::tokenName() const { std::vector components = getPackageAndVersionComponents(true /* sanitized */); if (!mName.empty()) { std::vector nameComponents = base::Split(mName, "."); components.insert(components.end(), nameComponents.begin(), nameComponents.end()); } return base::Join(components, "_"); } std::string FQName::cppNamespace() const { std::vector components = getPackageAndVersionComponents(true /* sanitized */); return "::" + base::Join(components, "::"); } std::string FQName::cppLocalName() const { std::vector components = base::Split(mName, "."); return base::Join(components, "::") + (mValueName.empty() ? "" : ("::" + mValueName)); } std::string FQName::cppName() const { std::string out = cppNamespace(); std::vector components = base::Split(name(), "."); out += "::"; out += base::Join(components, "::"); if (!mValueName.empty()) { out += "::" + mValueName; } return out; } std::string FQName::javaPackage() const { std::vector components = getPackageAndVersionComponents(true /* sanitized */); return base::Join(components, "."); } std::string FQName::javaName() const { return javaPackage() + "." + name() + (mValueName.empty() ? "" : ("." + mValueName)); } std::vector FQName::getPackageComponents() const { return base::Split(package(), "."); } std::vector FQName::getPackageAndVersionComponents(bool sanitized) const { CHECK(hasVersion()) << string() << ": getPackageAndVersionComponents expects version."; std::vector components = getPackageComponents(); if (sanitized) { components.push_back(sanitizedVersion()); } else { components.push_back(version()); } return components; } bool FQName::hasVersion() const { return mMajor > 0; } std::pair FQName::getVersion() const { return {mMajor, mMinor}; } FQName FQName::withVersion(size_t major, size_t minor) const { FQName ret(*this); ret.mMajor = major; ret.mMinor = minor; return ret; } size_t FQName::getPackageMajorVersion() const { CHECK(hasVersion()) << "FQName: No version exists at getPackageMajorVersion(). " << "Did you check hasVersion()?"; return mMajor; } size_t FQName::getPackageMinorVersion() const { CHECK(hasVersion()) << "FQName: No version exists at getPackageMinorVersion(). " << "Did you check hasVersion()?"; return mMinor; } bool FQName::endsWith(const FQName &other) const { std::string s1 = string(); std::string s2 = other.string(); size_t pos = s1.rfind(s2); if (pos == std::string::npos || pos + s2.size() != s1.size()) { return false; } // A match is only a match if it is preceded by a "boundary", i.e. // we perform a component-wise match from the end. // "az" is not a match for "android.hardware.foo@1.0::IFoo.bar.baz", // "baz", "bar.baz", "IFoo.bar.baz", "@1.0::IFoo.bar.baz" are. if (pos == 0) { // matches "android.hardware.foo@1.0::IFoo.bar.baz" return true; } if (s1[pos - 1] == '.') { // matches "baz" and "bar.baz" return true; } if (s1[pos - 1] == ':') { // matches "IFoo.bar.baz" return true; } if (s1[pos] == '@') { // matches "@1.0::IFoo.bar.baz" return true; } return false; } bool FQName::inPackage(const std::string &package) const { std::vector components = getPackageComponents(); std::vector inComponents = base::Split(package, "."); if (inComponents.size() > components.size()) { return false; } for (size_t i = 0; i < inComponents.size(); i++) { if (inComponents[i] != components[i]) { return false; } } return true; } FQName FQName::downRev() const { FQName ret(*this); CHECK(ret.mMinor > 0); ret.mMinor--; return ret; } FQName FQName::upRev() const { FQName ret(*this); ret.mMinor++; CHECK(ret.mMinor > 0); return ret; } } // namespace android