1 /*
2  * Copyright 2019 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 #pragma once
18 
19 #include "fields/packet_field.h"
20 #include "fields/size_field.h"
21 #include "parse_location.h"
22 #include "type_def.h"
23 
24 class VectorField : public PacketField {
25  public:
26   VectorField(std::string name, int element_size, std::string size_modifier, ParseLocation loc);
27 
28   VectorField(std::string name, TypeDef* type_def, std::string size_modifier, ParseLocation loc);
29 
30   static const std::string kFieldType;
31 
32   virtual const std::string& GetFieldType() const override;
33 
34   virtual Size GetSize() const override;
35 
36   virtual Size GetBuilderSize() const override;
37 
38   virtual Size GetStructSize() const override;
39 
40   virtual std::string GetDataType() const override;
41 
42   virtual void GenExtractor(std::ostream& s, int num_leading_bits, bool for_struct) const override;
43 
44   virtual std::string GetGetterFunctionName() const override;
45 
46   virtual void GenGetter(std::ostream& s, Size start_offset, Size end_offset) const override;
47 
48   virtual std::string GetBuilderParameterType() const override;
49 
50   virtual bool BuilderParameterMustBeMoved() const override;
51 
52   virtual bool GenBuilderMember(std::ostream& s) const override;
53 
54   virtual bool HasParameterValidator() const override;
55 
56   virtual void GenParameterValidator(std::ostream& s) const override;
57 
58   virtual void GenInserter(std::ostream& s) const override;
59 
60   virtual void GenValidator(std::ostream&) const override;
61 
62   void SetSizeField(const SizeField* size_field);
63 
64   const std::string& GetSizeModifier() const;
65 
66   virtual bool IsContainerField() const override;
67 
68   virtual const PacketField* GetElementField() const override;
69 
70   virtual void GenStringRepresentation(std::ostream& s, std::string accessor) const override;
71 
72   const std::string name_;
73 
74   const PacketField* element_field_{nullptr};
75 
76   const Size element_size_{};
77 
78   // Size is always in bytes, unless it is a count.
79   const SizeField* size_field_{nullptr};
80 
81   // Size modifier is only used when size_field_ is of type SIZE and is not used with COUNT.
82   std::string size_modifier_{""};
83 };
84