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 | 3599d92 | 2016-08-09 10:42:57 -0700 | [diff] [blame] | 17 | #include "Annotation.h" |
| 18 | |
Steven Moreland | db1b1b6 | 2017-01-10 09:50:55 -0800 | [diff] [blame] | 19 | #include <android-base/logging.h> |
Iliyan Malchev | a72e0d2 | 2016-09-09 11:03:08 -0700 | [diff] [blame] | 20 | #include <hidl-util/Formatter.h> |
Yifan Hong | 932464e | 2017-03-30 15:40:22 -0700 | [diff] [blame] | 21 | #include <hidl-util/StringHelper.h> |
Andreas Huber | 3599d92 | 2016-08-09 10:42:57 -0700 | [diff] [blame] | 22 | #include <vector> |
| 23 | |
| 24 | namespace android { |
| 25 | |
Timur Iskhakov | 7a85dc2 | 2017-08-10 19:06:41 -0700 | [diff] [blame] | 26 | AnnotationParam::AnnotationParam(const std::string& name) : mName(name) {} |
Steven Moreland | d537ab0 | 2016-09-12 10:32:01 -0700 | [diff] [blame] | 27 | |
Timur Iskhakov | 7a85dc2 | 2017-08-10 19:06:41 -0700 | [diff] [blame] | 28 | const std::string& AnnotationParam::getName() const { |
Steven Moreland | d537ab0 | 2016-09-12 10:32:01 -0700 | [diff] [blame] | 29 | return mName; |
| 30 | } |
| 31 | |
Timur Iskhakov | cec46c4 | 2017-08-09 00:22:02 -0700 | [diff] [blame] | 32 | status_t AnnotationParam::evaluate() { |
| 33 | return OK; |
| 34 | } |
| 35 | |
| 36 | status_t AnnotationParam::validate() const { |
| 37 | return OK; |
| 38 | } |
| 39 | |
Steven Moreland | db1b1b6 | 2017-01-10 09:50:55 -0800 | [diff] [blame] | 40 | std::string AnnotationParam::getSingleString() const { |
| 41 | std::string value = getSingleValue(); |
| 42 | |
| 43 | CHECK(value.size() >= 2 && value[0] == '"' && value[value.size() - 1] == '"') |
| 44 | << mName << " must be a string"; |
| 45 | |
| 46 | // unquote string |
| 47 | value = value.substr(1, value.size() - 2); |
| 48 | |
| 49 | return value; |
| 50 | } |
| 51 | |
| 52 | bool AnnotationParam::getSingleBool() const { |
| 53 | std::string value = getSingleString(); |
| 54 | |
| 55 | if (value == "true") { |
| 56 | return true; |
| 57 | } else if (value == "false") { |
| 58 | return false; |
| 59 | } |
| 60 | |
| 61 | CHECK(false) << mName << " must be of boolean value (true/false)."; |
| 62 | return false; |
| 63 | } |
| 64 | |
Timur Iskhakov | 7a85dc2 | 2017-08-10 19:06:41 -0700 | [diff] [blame] | 65 | StringAnnotationParam::StringAnnotationParam(const std::string& name, |
| 66 | std::vector<std::string>* values) |
| 67 | : AnnotationParam(name), mValues(values) {} |
| 68 | |
| 69 | std::vector<std::string> StringAnnotationParam::getValues() const { |
| 70 | return *mValues; |
Andreas Huber | 3599d92 | 2016-08-09 10:42:57 -0700 | [diff] [blame] | 71 | } |
| 72 | |
Timur Iskhakov | 7a85dc2 | 2017-08-10 19:06:41 -0700 | [diff] [blame] | 73 | std::string StringAnnotationParam::getSingleValue() const { |
| 74 | CHECK_EQ(mValues->size(), 1u) << mName << " requires one value but has multiple"; |
| 75 | return mValues->at(0); |
| 76 | } |
| 77 | |
| 78 | ConstantExpressionAnnotationParam::ConstantExpressionAnnotationParam( |
| 79 | const std::string& name, std::vector<ConstantExpression*>* values) |
| 80 | : AnnotationParam(name), mValues(values) {} |
| 81 | |
Timur Iskhakov | cec46c4 | 2017-08-09 00:22:02 -0700 | [diff] [blame] | 82 | std::string convertToString(const ConstantExpression* value) { |
| 83 | return value->value() + " /* " + value->description() + " */"; |
| 84 | } |
| 85 | |
Timur Iskhakov | 7a85dc2 | 2017-08-10 19:06:41 -0700 | [diff] [blame] | 86 | std::vector<std::string> ConstantExpressionAnnotationParam::getValues() const { |
| 87 | std::vector<std::string> ret; |
Timur Iskhakov | cec46c4 | 2017-08-09 00:22:02 -0700 | [diff] [blame] | 88 | for (const auto* value : *mValues) { |
| 89 | ret.push_back(convertToString(value)); |
Timur Iskhakov | 7a85dc2 | 2017-08-10 19:06:41 -0700 | [diff] [blame] | 90 | }; |
Timur Iskhakov | 7a85dc2 | 2017-08-10 19:06:41 -0700 | [diff] [blame] | 91 | return ret; |
| 92 | } |
| 93 | |
| 94 | std::string ConstantExpressionAnnotationParam::getSingleValue() const { |
| 95 | CHECK_EQ(mValues->size(), 1u) << mName << " requires one value but has multiple"; |
| 96 | return convertToString(mValues->at(0)); |
| 97 | } |
| 98 | |
Timur Iskhakov | cec46c4 | 2017-08-09 00:22:02 -0700 | [diff] [blame] | 99 | status_t ConstantExpressionAnnotationParam::evaluate() { |
| 100 | for (auto* value : *mValues) { |
| 101 | value->evaluate(); |
| 102 | } |
| 103 | return AnnotationParam::evaluate(); |
Timur Iskhakov | 7a85dc2 | 2017-08-10 19:06:41 -0700 | [diff] [blame] | 104 | } |
| 105 | |
| 106 | Annotation::Annotation(const char* name, AnnotationParamVector* params) |
| 107 | : mName(name), mParams(params) {} |
| 108 | |
Andreas Huber | 3599d92 | 2016-08-09 10:42:57 -0700 | [diff] [blame] | 109 | std::string Annotation::name() const { |
| 110 | return mName; |
| 111 | } |
| 112 | |
Zhuoyao Zhang | 5158db4 | 2016-08-10 10:25:20 -0700 | [diff] [blame] | 113 | const AnnotationParamVector &Annotation::params() const { |
Steven Moreland | d537ab0 | 2016-09-12 10:32:01 -0700 | [diff] [blame] | 114 | return *mParams; |
| 115 | } |
| 116 | |
Andreas Huber | 019d21d | 2016-10-03 12:59:47 -0700 | [diff] [blame] | 117 | const AnnotationParam *Annotation::getParam(const std::string &name) const { |
Steven Moreland | d537ab0 | 2016-09-12 10:32:01 -0700 | [diff] [blame] | 118 | for (auto *i: *mParams) { |
| 119 | if (i->getName() == name) { |
| 120 | return i; |
| 121 | } |
| 122 | } |
| 123 | |
| 124 | return nullptr; |
Zhuoyao Zhang | 5158db4 | 2016-08-10 10:25:20 -0700 | [diff] [blame] | 125 | } |
| 126 | |
Timur Iskhakov | cec46c4 | 2017-08-09 00:22:02 -0700 | [diff] [blame] | 127 | status_t Annotation::evaluate() { |
| 128 | for (auto* param : *mParams) { |
| 129 | status_t err = param->evaluate(); |
| 130 | if (err != OK) return err; |
| 131 | } |
| 132 | return OK; |
| 133 | } |
| 134 | |
| 135 | status_t Annotation::validate() const { |
| 136 | for (const auto* param : *mParams) { |
| 137 | status_t err = param->validate(); |
| 138 | if (err != OK) return err; |
| 139 | } |
| 140 | return OK; |
| 141 | } |
| 142 | |
Andreas Huber | 3599d92 | 2016-08-09 10:42:57 -0700 | [diff] [blame] | 143 | void Annotation::dump(Formatter &out) const { |
| 144 | out << "@" << mName; |
| 145 | |
Steven Moreland | d537ab0 | 2016-09-12 10:32:01 -0700 | [diff] [blame] | 146 | if (mParams->size() == 0) { |
Andreas Huber | 3599d92 | 2016-08-09 10:42:57 -0700 | [diff] [blame] | 147 | return; |
| 148 | } |
| 149 | |
| 150 | out << "("; |
| 151 | |
Steven Moreland | d537ab0 | 2016-09-12 10:32:01 -0700 | [diff] [blame] | 152 | for (size_t i = 0; i < mParams->size(); ++i) { |
Andreas Huber | 3599d92 | 2016-08-09 10:42:57 -0700 | [diff] [blame] | 153 | if (i > 0) { |
| 154 | out << ", "; |
| 155 | } |
| 156 | |
Steven Moreland | d537ab0 | 2016-09-12 10:32:01 -0700 | [diff] [blame] | 157 | const AnnotationParam* param = mParams->at(i); |
Andreas Huber | 3599d92 | 2016-08-09 10:42:57 -0700 | [diff] [blame] | 158 | |
Steven Moreland | d537ab0 | 2016-09-12 10:32:01 -0700 | [diff] [blame] | 159 | out << param->getName() << "="; |
| 160 | |
Timur Iskhakov | 7a85dc2 | 2017-08-10 19:06:41 -0700 | [diff] [blame] | 161 | const std::vector<std::string>& values = param->getValues(); |
| 162 | if (values.size() > 1) { |
Andreas Huber | 3599d92 | 2016-08-09 10:42:57 -0700 | [diff] [blame] | 163 | out << "{"; |
| 164 | } |
| 165 | |
Timur Iskhakov | 7a85dc2 | 2017-08-10 19:06:41 -0700 | [diff] [blame] | 166 | out << StringHelper::JoinStrings(values, ", "); |
Andreas Huber | 3599d92 | 2016-08-09 10:42:57 -0700 | [diff] [blame] | 167 | |
Timur Iskhakov | 7a85dc2 | 2017-08-10 19:06:41 -0700 | [diff] [blame] | 168 | if (values.size() > 1) { |
Andreas Huber | 3599d92 | 2016-08-09 10:42:57 -0700 | [diff] [blame] | 169 | out << "}"; |
| 170 | } |
| 171 | } |
| 172 | |
| 173 | out << ")"; |
| 174 | } |
| 175 | |
| 176 | } // namespace android |
| 177 | |