Home | History | Annotate | Download | only in hidl 
      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 
     17 #ifndef ANNOTATION_H_
     18 
     19 #define ANNOTATION_H_
     20 
     21 #include <android-base/macros.h>
     22 #include <map>
     23 #include <string>
     24 #include <vector>
     25 
     26 #include "ConstantExpression.h"
     27 
     28 namespace android {
     29 
     30 struct Formatter;
     31 
     32 struct AnnotationParam {
     33     virtual ~AnnotationParam() {}
     34 
     35     const std::string& getName() const;
     36 
     37     virtual std::vector<std::string> getValues() const = 0;
     38     virtual std::string getSingleValue() const = 0;
     39 
     40     /* Returns unquoted version of getSingleValue */
     41     std::string getSingleString() const;
     42 
     43     /* Returns value interpretted as a boolean */
     44     bool getSingleBool() const;
     45 
     46     std::vector<ConstantExpression*> getConstantExpressions();
     47     virtual std::vector<const ConstantExpression*> getConstantExpressions() const;
     48 
     49    protected:
     50     const std::string mName;
     51 
     52     AnnotationParam(const std::string& name);
     53 };
     54 
     55 struct StringAnnotationParam : AnnotationParam {
     56     StringAnnotationParam(const std::string& name, std::vector<std::string>* values);
     57 
     58     std::vector<std::string> getValues() const override;
     59     std::string getSingleValue() const override;
     60 
     61    private:
     62     std::vector<std::string>* const mValues;
     63 };
     64 
     65 struct ConstantExpressionAnnotationParam : AnnotationParam {
     66     ConstantExpressionAnnotationParam(const std::string& name,
     67                                       std::vector<ConstantExpression*>* values);
     68 
     69     std::vector<std::string> getValues() const override;
     70     std::string getSingleValue() const override;
     71 
     72     std::vector<const ConstantExpression*> getConstantExpressions() const override;
     73 
     74    private:
     75     std::vector<ConstantExpression*>* const mValues;
     76 };
     77 
     78 using AnnotationParamVector = std::vector<AnnotationParam*>;
     79 
     80 struct Annotation {
     81     Annotation(const char *name, AnnotationParamVector *params);
     82 
     83     std::string name() const;
     84     const AnnotationParamVector &params() const;
     85     const AnnotationParam *getParam(const std::string &name) const;
     86 
     87     std::vector<ConstantExpression*> getConstantExpressions();
     88     std::vector<const ConstantExpression*> getConstantExpressions() const;
     89 
     90     void dump(Formatter &out) const;
     91 
     92    private:
     93     std::string mName;
     94     AnnotationParamVector *mParams;
     95 
     96     DISALLOW_COPY_AND_ASSIGN(Annotation);
     97 };
     98 
     99 }  // namespace android
    100 
    101 #endif  // ANNOTATION_H_
    102