Interface.h revision 3ce7214bd94cc880601d4dd459a37264633452a2
11aec397b1fdea7db4120dbe55b6995bb2a9d9138Andreas Huber/* 21aec397b1fdea7db4120dbe55b6995bb2a9d9138Andreas Huber * Copyright (C) 2016 The Android Open Source Project 31aec397b1fdea7db4120dbe55b6995bb2a9d9138Andreas Huber * 41aec397b1fdea7db4120dbe55b6995bb2a9d9138Andreas Huber * Licensed under the Apache License, Version 2.0 (the "License"); 51aec397b1fdea7db4120dbe55b6995bb2a9d9138Andreas Huber * you may not use this file except in compliance with the License. 61aec397b1fdea7db4120dbe55b6995bb2a9d9138Andreas Huber * You may obtain a copy of the License at 71aec397b1fdea7db4120dbe55b6995bb2a9d9138Andreas Huber * 81aec397b1fdea7db4120dbe55b6995bb2a9d9138Andreas Huber * http://www.apache.org/licenses/LICENSE-2.0 91aec397b1fdea7db4120dbe55b6995bb2a9d9138Andreas Huber * 101aec397b1fdea7db4120dbe55b6995bb2a9d9138Andreas Huber * Unless required by applicable law or agreed to in writing, software 111aec397b1fdea7db4120dbe55b6995bb2a9d9138Andreas Huber * distributed under the License is distributed on an "AS IS" BASIS, 121aec397b1fdea7db4120dbe55b6995bb2a9d9138Andreas Huber * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 131aec397b1fdea7db4120dbe55b6995bb2a9d9138Andreas Huber * See the License for the specific language governing permissions and 141aec397b1fdea7db4120dbe55b6995bb2a9d9138Andreas Huber * limitations under the License. 151aec397b1fdea7db4120dbe55b6995bb2a9d9138Andreas Huber */ 161aec397b1fdea7db4120dbe55b6995bb2a9d9138Andreas Huber 17c9410c7e62a33fd7599b2f3e025093a2d171577eAndreas Huber#ifndef INTERFACE_H_ 18c9410c7e62a33fd7599b2f3e025093a2d171577eAndreas Huber 19c9410c7e62a33fd7599b2f3e025093a2d171577eAndreas Huber#define INTERFACE_H_ 20c9410c7e62a33fd7599b2f3e025093a2d171577eAndreas Huber 216f2f2c026b0b6e372194794e171208a91d74f852Steven Moreland#include <vector> 224b80bc4402ec88504265e6fdbcdb8a803d67eb64Timur Iskhakov 23505316c499a4dbb95f6567e8531fb6f1e74c3dedTimur Iskhakov#include "Reference.h" 24505316c499a4dbb95f6567e8531fb6f1e74c3dedTimur Iskhakov#include "Scope.h" 25505316c499a4dbb95f6567e8531fb6f1e74c3dedTimur Iskhakov 26c9410c7e62a33fd7599b2f3e025093a2d171577eAndreas Hubernamespace android { 27c9410c7e62a33fd7599b2f3e025093a2d171577eAndreas Huber 28c9410c7e62a33fd7599b2f3e025093a2d171577eAndreas Huberstruct Method; 2910fe0b55e774903fe37b658458053527da8b5a53Yifan Hongstruct InterfaceAndMethod; 30c9410c7e62a33fd7599b2f3e025093a2d171577eAndreas Huber 31c9410c7e62a33fd7599b2f3e025093a2d171577eAndreas Huberstruct Interface : public Scope { 323ce7214bd94cc880601d4dd459a37264633452a2Steven Moreland enum { 333ce7214bd94cc880601d4dd459a37264633452a2Steven Moreland /////////////////// Flag(s) - DO NOT CHANGE 343ce7214bd94cc880601d4dd459a37264633452a2Steven Moreland FLAG_ONEWAY = 0x00000001, 353ce7214bd94cc880601d4dd459a37264633452a2Steven Moreland }; 363ce7214bd94cc880601d4dd459a37264633452a2Steven Moreland 37565b0137b2ad0e8e239d38e92c025f096de62f2dTimur Iskhakov Interface(const char* localName, const FQName& fullName, const Location& location, 38565b0137b2ad0e8e239d38e92c025f096de62f2dTimur Iskhakov Scope* parent, const Reference<Type>& superType); 39c9410c7e62a33fd7599b2f3e025093a2d171577eAndreas Huber 4014ee6749f12bcd43477fe8110fbec38e15376b40Steven Moreland bool addMethod(Method *method); 41ffa913993fb527b44053c11f139689d3267748ecYifan Hong bool addAllReservedMethods(); 42c9410c7e62a33fd7599b2f3e025093a2d171577eAndreas Huber 43b40ef02ca14e507a5a5b878c90eaac52ffe64fd9Martijn Coenen bool isElidableType() const override; 44a2723d26427f7db19777dfed330047253e7a4e1bAndreas Huber bool isInterface() const override; 45295ad30bf6212c16accc5095601b2a71d44b4c8bAndreas Huber bool isBinder() const override; 46c89340422f53046bfe24ff3e529161f9194120f8Yifan Hong bool isIBase() const { return fqName() == gIBaseFqName; } 4730bb6a869be0f3f82497b7b11c71ec9d47652ed0Steven Moreland std::string typeName() const override; 48c9410c7e62a33fd7599b2f3e025093a2d171577eAndreas Huber 49505316c499a4dbb95f6567e8531fb6f1e74c3dedTimur Iskhakov const Interface* superType() const; 50c9410c7e62a33fd7599b2f3e025093a2d171577eAndreas Huber 51fe95aa243eb53df9cb46ca74192e760d7520b611Yifan Hong // Super type chain to root type. 52fe95aa243eb53df9cb46ca74192e760d7520b611Yifan Hong // First element is superType(). 53fe95aa243eb53df9cb46ca74192e760d7520b611Yifan Hong std::vector<const Interface *> superTypeChain() const; 5410fe0b55e774903fe37b658458053527da8b5a53Yifan Hong // Super type chain to root type, including myself. 5510fe0b55e774903fe37b658458053527da8b5a53Yifan Hong // First element is this. 5610fe0b55e774903fe37b658458053527da8b5a53Yifan Hong std::vector<const Interface *> typeChain() const; 5710fe0b55e774903fe37b658458053527da8b5a53Yifan Hong 5810fe0b55e774903fe37b658458053527da8b5a53Yifan Hong // user defined methods (explicit definition in HAL files) 5910fe0b55e774903fe37b658458053527da8b5a53Yifan Hong const std::vector<Method *> &userDefinedMethods() const; 6010fe0b55e774903fe37b658458053527da8b5a53Yifan Hong // HIDL reserved methods (every interface has these implicitly defined) 6110fe0b55e774903fe37b658458053527da8b5a53Yifan Hong const std::vector<Method *> &hidlReservedMethods() const; 6210fe0b55e774903fe37b658458053527da8b5a53Yifan Hong // the sum of userDefinedMethods() and hidlReservedMethods(). 6310fe0b55e774903fe37b658458053527da8b5a53Yifan Hong std::vector<Method *> methods() const; 6410fe0b55e774903fe37b658458053527da8b5a53Yifan Hong 6510fe0b55e774903fe37b658458053527da8b5a53Yifan Hong // userDefinedMethods() for all super type + methods() 6610fe0b55e774903fe37b658458053527da8b5a53Yifan Hong // The order will be as follows (in the transaction code order): 6710fe0b55e774903fe37b658458053527da8b5a53Yifan Hong // great-great-...-great-grand parent->userDefinedMethods() 6810fe0b55e774903fe37b658458053527da8b5a53Yifan Hong // ... 6910fe0b55e774903fe37b658458053527da8b5a53Yifan Hong // parent->userDefinedMethods() 7010fe0b55e774903fe37b658458053527da8b5a53Yifan Hong // this->userDefinedMethods() 7110fe0b55e774903fe37b658458053527da8b5a53Yifan Hong // this->hidlReservedMethods() 7210fe0b55e774903fe37b658458053527da8b5a53Yifan Hong std::vector<InterfaceAndMethod> allMethodsFromRoot() const; 73881227d860c59471eee31d39946e96ce2daa35d6Andreas Huber 74f1b902d10bd2d71ad7f4769620678101821fd5d1Timur Iskhakov // allMethodsFromRoot for parent 75f1b902d10bd2d71ad7f4769620678101821fd5d1Timur Iskhakov std::vector<InterfaceAndMethod> allSuperMethodsFromRoot() const; 76f1b902d10bd2d71ad7f4769620678101821fd5d1Timur Iskhakov 77eefe4f2405c3cb0f1d164bdb748e5d0ded3624f9Yifan Hong // aliases for corresponding methods in this->fqName() 784078631353d6d34db21c890d1870e796eca6ea38Steven Moreland std::string getBaseName() const; 799a6da7a784bea068b1f3fc3758c9cfc785183693Steven Moreland std::string getAdapterName() const; 80eefe4f2405c3cb0f1d164bdb748e5d0ded3624f9Yifan Hong std::string getProxyName() const; 81eefe4f2405c3cb0f1d164bdb748e5d0ded3624f9Yifan Hong std::string getStubName() const; 82eefe4f2405c3cb0f1d164bdb748e5d0ded3624f9Yifan Hong std::string getPassthroughName() const; 83eefe4f2405c3cb0f1d164bdb748e5d0ded3624f9Yifan Hong std::string getHwName() const; 8451a6509db3078657a2401069c37515504b40c12cYifan Hong FQName getProxyFqName() const; 8551a6509db3078657a2401069c37515504b40c12cYifan Hong FQName getStubFqName() const; 8651a6509db3078657a2401069c37515504b40c12cYifan Hong FQName getPassthroughFqName() const; 87158655a90308d8e5f03dc28b8330d5b0cce038f0Yifan Hong 884c865b72b320a46f326a335cfd326b66b0e10f67Andreas Huber std::string getCppType( 894c865b72b320a46f326a335cfd326b66b0e10f67Andreas Huber StorageMode mode, 904c865b72b320a46f326a335cfd326b66b0e10f67Andreas Huber bool specifyNamespaces) const override; 91881227d860c59471eee31d39946e96ce2daa35d6Andreas Huber 924ed1347cd29e6e07acad368891bb03078c798abaYifan Hong std::string getJavaType(bool forInitializer) const override; 93a588b23323213c525bf34dc0562679195afe611eZhuoyao Zhang std::string getVtsType() const override; 942831d5145675ead9f2fb767bf5fe4ae56b88349fAndreas Huber 95b58f4185934a93fc511c03a8a970b31c5ea0dfcaTimur Iskhakov std::vector<const Reference<Type>*> getReferences() const override; 96b58f4185934a93fc511c03a8a970b31c5ea0dfcaTimur Iskhakov std::vector<const Reference<Type>*> getStrongReferences() const override; 9733431e6cd425c6cd179080442a8616e2baa20aaeTimur Iskhakov 98b58f4185934a93fc511c03a8a970b31c5ea0dfcaTimur Iskhakov std::vector<const ConstantExpression*> getConstantExpressions() const override; 99891a866402345777c7e746cf8d0e4ffd0bd28ca2Timur Iskhakov 100cec46c48853a8c1246656d0095a9faa3fad5c4f9Timur Iskhakov status_t resolveInheritance() override; 101cec46c48853a8c1246656d0095a9faa3fad5c4f9Timur Iskhakov status_t validate() const override; 102cec46c48853a8c1246656d0095a9faa3fad5c4f9Timur Iskhakov status_t validateUniqueNames() const; 103cec46c48853a8c1246656d0095a9faa3fad5c4f9Timur Iskhakov 104881227d860c59471eee31d39946e96ce2daa35d6Andreas Huber void emitReaderWriter( 105881227d860c59471eee31d39946e96ce2daa35d6Andreas Huber Formatter &out, 106881227d860c59471eee31d39946e96ce2daa35d6Andreas Huber const std::string &name, 107881227d860c59471eee31d39946e96ce2daa35d6Andreas Huber const std::string &parcelObj, 108881227d860c59471eee31d39946e96ce2daa35d6Andreas Huber bool parcelObjIsPointer, 109881227d860c59471eee31d39946e96ce2daa35d6Andreas Huber bool isReader, 110881227d860c59471eee31d39946e96ce2daa35d6Andreas Huber ErrorMode mode) const override; 111881227d860c59471eee31d39946e96ce2daa35d6Andreas Huber 1124b8f7a11f794d9b4899af92a856b4a03b80b31e8Steven Moreland status_t emitPackageTypeDeclarations(Formatter& out) const override; 1138c90cc59bf93bd0c08970b4488067a33015d4a1cChih-Hung Hsieh status_t emitTypeDefinitions(Formatter& out, const std::string& prefix) const override; 114f5cc2f74e86504f7904a0a24e7fcc00fa19cd579Yifan Hong 115ecfb4517ff68c59294f1ddc99513aef7b6dc2f24Howard Chen void getAlignmentAndSize(size_t* align, size_t* size) const override; 1162831d5145675ead9f2fb767bf5fe4ae56b88349fAndreas Huber void emitJavaReaderWriter( 1172831d5145675ead9f2fb767bf5fe4ae56b88349fAndreas Huber Formatter &out, 1182831d5145675ead9f2fb767bf5fe4ae56b88349fAndreas Huber const std::string &parcelObj, 1192831d5145675ead9f2fb767bf5fe4ae56b88349fAndreas Huber const std::string &argName, 1202831d5145675ead9f2fb767bf5fe4ae56b88349fAndreas Huber bool isReader) const override; 1212831d5145675ead9f2fb767bf5fe4ae56b88349fAndreas Huber 122864c771ca4ec8a01e31c7c243625b7a5f6316768Zhuoyao Zhang status_t emitVtsAttributeType(Formatter &out) const override; 123864c771ca4ec8a01e31c7c243625b7a5f6316768Zhuoyao Zhang 124864c771ca4ec8a01e31c7c243625b7a5f6316768Zhuoyao Zhang status_t emitVtsAttributeDeclaration(Formatter &out) const; 125864c771ca4ec8a01e31c7c243625b7a5f6316768Zhuoyao Zhang status_t emitVtsMethodDeclaration(Formatter &out) const; 1265158db484e5ab302368f191d75d5b1334c270e52Zhuoyao Zhang 12769e7c70e72dff0734d542b737ba8bb1178244218Steven Moreland bool hasOnewayMethods() const; 12869e7c70e72dff0734d542b737ba8bb1178244218Steven Moreland 1295dc72fe4f6f1d2c03c75307a9bd80f055f752ed3Timur Iskhakov bool deepIsJavaCompatible(std::unordered_set<const Type*>* visited) const override; 13070a59e1dc3dcf32f791d2dd7966111d4adf32ecaAndreas Huber 131ff5e64ae0c65b80e2baa4a95b9ae9ee894b60080Timur Iskhakov bool isNeverStrongReference() const override; 132ff5e64ae0c65b80e2baa4a95b9ae9ee894b60080Timur Iskhakov 133505316c499a4dbb95f6567e8531fb6f1e74c3dedTimur Iskhakov private: 1340344e61434d7af537cbf33c86b47ec165593f7ddTimur Iskhakov Reference<Type> mSuperType; 135505316c499a4dbb95f6567e8531fb6f1e74c3dedTimur Iskhakov 136505316c499a4dbb95f6567e8531fb6f1e74c3dedTimur Iskhakov std::vector<Method*> mUserMethods; 137505316c499a4dbb95f6567e8531fb6f1e74c3dedTimur Iskhakov std::vector<Method*> mReservedMethods; 138505316c499a4dbb95f6567e8531fb6f1e74c3dedTimur Iskhakov 139505316c499a4dbb95f6567e8531fb6f1e74c3dedTimur Iskhakov bool fillPingMethod(Method* method) const; 140505316c499a4dbb95f6567e8531fb6f1e74c3dedTimur Iskhakov bool fillDescriptorChainMethod(Method* method) const; 141505316c499a4dbb95f6567e8531fb6f1e74c3dedTimur Iskhakov bool fillGetDescriptorMethod(Method* method) const; 142505316c499a4dbb95f6567e8531fb6f1e74c3dedTimur Iskhakov bool fillHashChainMethod(Method* method) const; 143505316c499a4dbb95f6567e8531fb6f1e74c3dedTimur Iskhakov bool fillSyspropsChangedMethod(Method* method) const; 144505316c499a4dbb95f6567e8531fb6f1e74c3dedTimur Iskhakov bool fillLinkToDeathMethod(Method* method) const; 145505316c499a4dbb95f6567e8531fb6f1e74c3dedTimur Iskhakov bool fillUnlinkToDeathMethod(Method* method) const; 146505316c499a4dbb95f6567e8531fb6f1e74c3dedTimur Iskhakov bool fillSetHALInstrumentationMethod(Method* method) const; 147505316c499a4dbb95f6567e8531fb6f1e74c3dedTimur Iskhakov bool fillGetDebugInfoMethod(Method* method) const; 148505316c499a4dbb95f6567e8531fb6f1e74c3dedTimur Iskhakov bool fillDebugMethod(Method* method) const; 149c9410c7e62a33fd7599b2f3e025093a2d171577eAndreas Huber 150c9410c7e62a33fd7599b2f3e025093a2d171577eAndreas Huber DISALLOW_COPY_AND_ASSIGN(Interface); 151c9410c7e62a33fd7599b2f3e025093a2d171577eAndreas Huber}; 152c9410c7e62a33fd7599b2f3e025093a2d171577eAndreas Huber 15310fe0b55e774903fe37b658458053527da8b5a53Yifan Hong// An interface / method tuple. 15410fe0b55e774903fe37b658458053527da8b5a53Yifan Hongstruct InterfaceAndMethod { 15510fe0b55e774903fe37b658458053527da8b5a53Yifan Hong InterfaceAndMethod(const Interface *iface, Method *method) 15610fe0b55e774903fe37b658458053527da8b5a53Yifan Hong : mInterface(iface), 15710fe0b55e774903fe37b658458053527da8b5a53Yifan Hong mMethod(method) {} 15810fe0b55e774903fe37b658458053527da8b5a53Yifan Hong Method *method() const { return mMethod; } 15910fe0b55e774903fe37b658458053527da8b5a53Yifan Hong const Interface *interface() const { return mInterface; } 160505316c499a4dbb95f6567e8531fb6f1e74c3dedTimur Iskhakov 161505316c499a4dbb95f6567e8531fb6f1e74c3dedTimur Iskhakov private: 16210fe0b55e774903fe37b658458053527da8b5a53Yifan Hong // do not own these objects. 16310fe0b55e774903fe37b658458053527da8b5a53Yifan Hong const Interface *mInterface; 16410fe0b55e774903fe37b658458053527da8b5a53Yifan Hong Method *mMethod; 16510fe0b55e774903fe37b658458053527da8b5a53Yifan Hong}; 16610fe0b55e774903fe37b658458053527da8b5a53Yifan Hong 167c9410c7e62a33fd7599b2f3e025093a2d171577eAndreas Huber} // namespace android 168c9410c7e62a33fd7599b2f3e025093a2d171577eAndreas Huber 169c9410c7e62a33fd7599b2f3e025093a2d171577eAndreas Huber#endif // INTERFACE_H_ 170c9410c7e62a33fd7599b2f3e025093a2d171577eAndreas Huber 171