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 23 class PayloadField : public PacketField { 24 public: 25 PayloadField(std::string modifier, ParseLocation loc); 26 27 static const std::string kFieldType; 28 29 virtual const std::string& GetFieldType() const override; 30 31 void SetSizeField(const SizeField* size_field); 32 33 virtual Size GetSize() const override; 34 35 virtual std::string GetDataType() const override; 36 37 virtual void GenExtractor(std::ostream& s, int num_leading_bits, bool for_struct) const override; 38 39 virtual std::string GetGetterFunctionName() const override; 40 41 virtual void GenGetter(std::ostream& s, Size start_offset, Size end_offset) const override; 42 43 virtual std::string GetBuilderParameterType() const override; 44 45 virtual bool BuilderParameterMustBeMoved() const override; 46 47 virtual void GenBuilderParameterFromView(std::ostream& s) const override; 48 49 virtual bool HasParameterValidator() const override; 50 51 virtual void GenParameterValidator(std::ostream&) const override; 52 53 virtual void GenInserter(std::ostream&) const override; 54 55 virtual void GenValidator(std::ostream&) const override; 56 57 virtual void GenStringRepresentation(std::ostream& s, std::string accessor) const override; 58 59 virtual std::string GetRustDataType() const override; 60 61 void GenRustGetter(std::ostream& s, Size start_offset, Size end_offset) const override; 62 63 void GenRustWriter(std::ostream& s, Size start_offset, Size end_offset) const override; 64 GenBoundsCheck(std::ostream &,Size,Size,std::string)65 void GenBoundsCheck(std::ostream&, Size, Size, std::string) const override{}; 66 67 // Payload fields can only be dynamically sized. 68 const SizeField* size_field_; 69 // Only used if the size of the payload is based on another field. 70 std::string size_modifier_; 71 }; 72