slang_rs_export_foreach.h revision c17e198ffcd37bfc57e3add1f6eee952ae2a2eab
15baf6324a97430016026419deaef246ad75430fcStephen Hines/* 29999ec3aa0c4d7a6befd3a300dc07f0cea91cb6cStephen Hines * Copyright 2011-2012, The Android Open Source Project 35baf6324a97430016026419deaef246ad75430fcStephen Hines * 45baf6324a97430016026419deaef246ad75430fcStephen Hines * Licensed under the Apache License, Version 2.0 (the "License"); 55baf6324a97430016026419deaef246ad75430fcStephen Hines * you may not use this file except in compliance with the License. 65baf6324a97430016026419deaef246ad75430fcStephen Hines * You may obtain a copy of the License at 75baf6324a97430016026419deaef246ad75430fcStephen Hines * 85baf6324a97430016026419deaef246ad75430fcStephen Hines * http://www.apache.org/licenses/LICENSE-2.0 95baf6324a97430016026419deaef246ad75430fcStephen Hines * 105baf6324a97430016026419deaef246ad75430fcStephen Hines * Unless required by applicable law or agreed to in writing, software 115baf6324a97430016026419deaef246ad75430fcStephen Hines * distributed under the License is distributed on an "AS IS" BASIS, 125baf6324a97430016026419deaef246ad75430fcStephen Hines * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 135baf6324a97430016026419deaef246ad75430fcStephen Hines * See the License for the specific language governing permissions and 145baf6324a97430016026419deaef246ad75430fcStephen Hines * limitations under the License. 155baf6324a97430016026419deaef246ad75430fcStephen Hines */ 165baf6324a97430016026419deaef246ad75430fcStephen Hines 17593a894650e81be54173106ec266f0311cebebd3Stephen Hines#ifndef _FRAMEWORKS_COMPILE_SLANG_SLANG_RS_EXPORT_FOREACH_H_ // NOLINT 18593a894650e81be54173106ec266f0311cebebd3Stephen Hines#define _FRAMEWORKS_COMPILE_SLANG_SLANG_RS_EXPORT_FOREACH_H_ 195baf6324a97430016026419deaef246ad75430fcStephen Hines 205baf6324a97430016026419deaef246ad75430fcStephen Hines#include "llvm/ADT/StringRef.h" 215baf6324a97430016026419deaef246ad75430fcStephen Hines#include "llvm/Support/raw_ostream.h" 225baf6324a97430016026419deaef246ad75430fcStephen Hines 235baf6324a97430016026419deaef246ad75430fcStephen Hines#include "clang/AST/Decl.h" 245baf6324a97430016026419deaef246ad75430fcStephen Hines 255baf6324a97430016026419deaef246ad75430fcStephen Hines#include "slang_assert.h" 265baf6324a97430016026419deaef246ad75430fcStephen Hines#include "slang_rs_context.h" 27593a894650e81be54173106ec266f0311cebebd3Stephen Hines#include "slang_rs_exportable.h" 28593a894650e81be54173106ec266f0311cebebd3Stephen Hines#include "slang_rs_export_type.h" 295baf6324a97430016026419deaef246ad75430fcStephen Hines 305baf6324a97430016026419deaef246ad75430fcStephen Hinesnamespace clang { 315baf6324a97430016026419deaef246ad75430fcStephen Hines class FunctionDecl; 325baf6324a97430016026419deaef246ad75430fcStephen Hines} // namespace clang 335baf6324a97430016026419deaef246ad75430fcStephen Hines 345baf6324a97430016026419deaef246ad75430fcStephen Hinesnamespace slang { 355baf6324a97430016026419deaef246ad75430fcStephen Hines 36593a894650e81be54173106ec266f0311cebebd3Stephen Hines// Base class for reflecting control-side forEach (currently for root() 37593a894650e81be54173106ec266f0311cebebd3Stephen Hines// functions that fit appropriate criteria) 38593a894650e81be54173106ec266f0311cebebd3Stephen Hinesclass RSExportForEach : public RSExportable { 395baf6324a97430016026419deaef246ad75430fcStephen Hines private: 405baf6324a97430016026419deaef246ad75430fcStephen Hines std::string mName; 41593a894650e81be54173106ec266f0311cebebd3Stephen Hines RSExportRecordType *mParamPacketType; 42b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines RSExportType *mInType; 43b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines RSExportType *mOutType; 44593a894650e81be54173106ec266f0311cebebd3Stephen Hines size_t numParams; 455baf6324a97430016026419deaef246ad75430fcStephen Hines 467b51b55e4467605a599e868a0dde7cb95c5ab76eStephen Hines unsigned int mSignatureMetadata; 474ccf75e55fe460a8daa49247d7e5a797329c71a6Stephen Hines 48b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines const clang::ParmVarDecl *mIn; 49b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines const clang::ParmVarDecl *mOut; 50b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines const clang::ParmVarDecl *mUsrData; 51b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines const clang::ParmVarDecl *mX; 52b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines const clang::ParmVarDecl *mY; 53b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines const clang::ParmVarDecl *mZ; 54b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines const clang::ParmVarDecl *mAr; 55b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines 56c17e198ffcd37bfc57e3add1f6eee952ae2a2eabStephen Hines bool mDummyRoot; 57c17e198ffcd37bfc57e3add1f6eee952ae2a2eabStephen Hines 58b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines // TODO(all): Add support for LOD/face when we have them 59c17e198ffcd37bfc57e3add1f6eee952ae2a2eabStephen Hines RSExportForEach(RSContext *Context, const llvm::StringRef &Name) 60593a894650e81be54173106ec266f0311cebebd3Stephen Hines : RSExportable(Context, RSExportable::EX_FOREACH), 61b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines mName(Name.data(), Name.size()), mParamPacketType(NULL), mInType(NULL), 627b51b55e4467605a599e868a0dde7cb95c5ab76eStephen Hines mOutType(NULL), numParams(0), mSignatureMetadata(0), 634ccf75e55fe460a8daa49247d7e5a797329c71a6Stephen Hines mIn(NULL), mOut(NULL), mUsrData(NULL), 64c17e198ffcd37bfc57e3add1f6eee952ae2a2eabStephen Hines mX(NULL), mY(NULL), mZ(NULL), mAr(NULL), mDummyRoot(false) { 655baf6324a97430016026419deaef246ad75430fcStephen Hines return; 665baf6324a97430016026419deaef246ad75430fcStephen Hines } 675baf6324a97430016026419deaef246ad75430fcStephen Hines 68b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines bool validateAndConstructParams(RSContext *Context, 69b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines const clang::FunctionDecl *FD); 70b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines 715baf6324a97430016026419deaef246ad75430fcStephen Hines public: 72593a894650e81be54173106ec266f0311cebebd3Stephen Hines static RSExportForEach *Create(RSContext *Context, 73593a894650e81be54173106ec266f0311cebebd3Stephen Hines const clang::FunctionDecl *FD); 74593a894650e81be54173106ec266f0311cebebd3Stephen Hines 75c17e198ffcd37bfc57e3add1f6eee952ae2a2eabStephen Hines static RSExportForEach *CreateDummyRoot(RSContext *Context); 76c17e198ffcd37bfc57e3add1f6eee952ae2a2eabStephen Hines 77593a894650e81be54173106ec266f0311cebebd3Stephen Hines inline const std::string &getName() const { 78593a894650e81be54173106ec266f0311cebebd3Stephen Hines return mName; 79593a894650e81be54173106ec266f0311cebebd3Stephen Hines } 80593a894650e81be54173106ec266f0311cebebd3Stephen Hines 81593a894650e81be54173106ec266f0311cebebd3Stephen Hines inline size_t getNumParameters() const { 82593a894650e81be54173106ec266f0311cebebd3Stephen Hines return numParams; 83593a894650e81be54173106ec266f0311cebebd3Stephen Hines } 84593a894650e81be54173106ec266f0311cebebd3Stephen Hines 85b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines inline bool hasIn() const { 86b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines return (mIn != NULL); 87b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines } 88b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines 89b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines inline bool hasOut() const { 90b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines return (mOut != NULL); 91b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines } 92b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines 93b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines inline bool hasUsrData() const { 94b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines return (mUsrData != NULL); 95b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines } 96b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines 97b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines inline const RSExportType *getInType() const { 98b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines return mInType; 99b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines } 100b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines 101b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines inline const RSExportType *getOutType() const { 102b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines return mOutType; 103b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines } 104b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines 105b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines inline const RSExportRecordType *getParamPacketType() const { 106b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines return mParamPacketType; 107b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines } 108593a894650e81be54173106ec266f0311cebebd3Stephen Hines 1097b51b55e4467605a599e868a0dde7cb95c5ab76eStephen Hines inline unsigned int getSignatureMetadata() const { 1107b51b55e4467605a599e868a0dde7cb95c5ab76eStephen Hines return mSignatureMetadata; 1114ccf75e55fe460a8daa49247d7e5a797329c71a6Stephen Hines } 1124ccf75e55fe460a8daa49247d7e5a797329c71a6Stephen Hines 113c17e198ffcd37bfc57e3add1f6eee952ae2a2eabStephen Hines inline bool isDummyRoot() const { 114c17e198ffcd37bfc57e3add1f6eee952ae2a2eabStephen Hines return mDummyRoot; 115c17e198ffcd37bfc57e3add1f6eee952ae2a2eabStephen Hines } 116c17e198ffcd37bfc57e3add1f6eee952ae2a2eabStephen Hines 117593a894650e81be54173106ec266f0311cebebd3Stephen Hines typedef RSExportRecordType::const_field_iterator const_param_iterator; 1185baf6324a97430016026419deaef246ad75430fcStephen Hines 119593a894650e81be54173106ec266f0311cebebd3Stephen Hines inline const_param_iterator params_begin() const { 120593a894650e81be54173106ec266f0311cebebd3Stephen Hines slangAssert((mParamPacketType != NULL) && 121593a894650e81be54173106ec266f0311cebebd3Stephen Hines "Get parameter from export foreach having no parameter!"); 122593a894650e81be54173106ec266f0311cebebd3Stephen Hines return mParamPacketType->fields_begin(); 123593a894650e81be54173106ec266f0311cebebd3Stephen Hines } 124b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines 125593a894650e81be54173106ec266f0311cebebd3Stephen Hines inline const_param_iterator params_end() const { 126593a894650e81be54173106ec266f0311cebebd3Stephen Hines slangAssert((mParamPacketType != NULL) && 127593a894650e81be54173106ec266f0311cebebd3Stephen Hines "Get parameter from export foreach having no parameter!"); 128593a894650e81be54173106ec266f0311cebebd3Stephen Hines return mParamPacketType->fields_end(); 1295baf6324a97430016026419deaef246ad75430fcStephen Hines } 1305baf6324a97430016026419deaef246ad75430fcStephen Hines 1315baf6324a97430016026419deaef246ad75430fcStephen Hines inline static bool isInitRSFunc(const clang::FunctionDecl *FD) { 1325baf6324a97430016026419deaef246ad75430fcStephen Hines if (!FD) { 1335baf6324a97430016026419deaef246ad75430fcStephen Hines return false; 1345baf6324a97430016026419deaef246ad75430fcStephen Hines } 1355baf6324a97430016026419deaef246ad75430fcStephen Hines const llvm::StringRef Name = FD->getName(); 1365baf6324a97430016026419deaef246ad75430fcStephen Hines static llvm::StringRef FuncInit("init"); 1375baf6324a97430016026419deaef246ad75430fcStephen Hines return Name.equals(FuncInit); 1385baf6324a97430016026419deaef246ad75430fcStephen Hines } 1395baf6324a97430016026419deaef246ad75430fcStephen Hines 1405baf6324a97430016026419deaef246ad75430fcStephen Hines inline static bool isRootRSFunc(const clang::FunctionDecl *FD) { 1415baf6324a97430016026419deaef246ad75430fcStephen Hines if (!FD) { 1425baf6324a97430016026419deaef246ad75430fcStephen Hines return false; 1435baf6324a97430016026419deaef246ad75430fcStephen Hines } 1445baf6324a97430016026419deaef246ad75430fcStephen Hines const llvm::StringRef Name = FD->getName(); 1455baf6324a97430016026419deaef246ad75430fcStephen Hines static llvm::StringRef FuncRoot("root"); 1465baf6324a97430016026419deaef246ad75430fcStephen Hines return Name.equals(FuncRoot); 1475baf6324a97430016026419deaef246ad75430fcStephen Hines } 1485baf6324a97430016026419deaef246ad75430fcStephen Hines 149688e64b2d56e4218c680b9d6523c5de672f55757Stephen Hines inline static bool isDtorRSFunc(const clang::FunctionDecl *FD) { 150688e64b2d56e4218c680b9d6523c5de672f55757Stephen Hines if (!FD) { 151688e64b2d56e4218c680b9d6523c5de672f55757Stephen Hines return false; 152688e64b2d56e4218c680b9d6523c5de672f55757Stephen Hines } 153688e64b2d56e4218c680b9d6523c5de672f55757Stephen Hines const llvm::StringRef Name = FD->getName(); 154688e64b2d56e4218c680b9d6523c5de672f55757Stephen Hines static llvm::StringRef FuncDtor(".rs.dtor"); 155688e64b2d56e4218c680b9d6523c5de672f55757Stephen Hines return Name.equals(FuncDtor); 156688e64b2d56e4218c680b9d6523c5de672f55757Stephen Hines } 157688e64b2d56e4218c680b9d6523c5de672f55757Stephen Hines 1589999ec3aa0c4d7a6befd3a300dc07f0cea91cb6cStephen Hines static bool isGraphicsRootRSFunc(int targetAPI, 1599999ec3aa0c4d7a6befd3a300dc07f0cea91cb6cStephen Hines const clang::FunctionDecl *FD); 1609999ec3aa0c4d7a6befd3a300dc07f0cea91cb6cStephen Hines 161f736d5a12269e7e74740b130cdca98d9839b31e6Stephen Hines static bool isRSForEachFunc(int targetAPI, const clang::FunctionDecl *FD); 162593a894650e81be54173106ec266f0311cebebd3Stephen Hines 1639999ec3aa0c4d7a6befd3a300dc07f0cea91cb6cStephen Hines inline static bool isSpecialRSFunc(int targetAPI, 1649999ec3aa0c4d7a6befd3a300dc07f0cea91cb6cStephen Hines const clang::FunctionDecl *FD) { 1659999ec3aa0c4d7a6befd3a300dc07f0cea91cb6cStephen Hines return isGraphicsRootRSFunc(targetAPI, FD) || isInitRSFunc(FD) || 1669999ec3aa0c4d7a6befd3a300dc07f0cea91cb6cStephen Hines isDtorRSFunc(FD); 1675baf6324a97430016026419deaef246ad75430fcStephen Hines } 1685baf6324a97430016026419deaef246ad75430fcStephen Hines 169f736d5a12269e7e74740b130cdca98d9839b31e6Stephen Hines static bool validateSpecialFuncDecl(int targetAPI, 170fbfd7f5fd97458b6b23437556025ac1d55e98fd4Stephen Hines clang::DiagnosticsEngine *DiagEngine, 1715baf6324a97430016026419deaef246ad75430fcStephen Hines const clang::FunctionDecl *FD); 172593a894650e81be54173106ec266f0311cebebd3Stephen Hines}; // RSExportForEach 1735baf6324a97430016026419deaef246ad75430fcStephen Hines 1745baf6324a97430016026419deaef246ad75430fcStephen Hines} // namespace slang 1755baf6324a97430016026419deaef246ad75430fcStephen Hines 176593a894650e81be54173106ec266f0311cebebd3Stephen Hines#endif // _FRAMEWORKS_COMPILE_SLANG_SLANG_RS_EXPORT_FOREACH_H_ NOLINT 177