slang_rs_context.h revision 796e7b1400d3f3f7c07496d88bb48129ea925bb9 
1/*
2 * Copyright 2010-2012, 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 _FRAMEWORKS_COMPILE_SLANG_SLANG_RS_CONTEXT_H_  // NOLINT
18#define _FRAMEWORKS_COMPILE_SLANG_SLANG_RS_CONTEXT_H_
19
20#include <cstdio>
21#include <list>
22#include <map>
23#include <string>
24
25#include "clang/Lex/Preprocessor.h"
26#include "clang/AST/Mangle.h"
27
28#include "llvm/ADT/OwningPtr.h"
29#include "llvm/ADT/StringSet.h"
30#include "llvm/ADT/StringMap.h"
31
32#include "slang_pragma_recorder.h"
33
34namespace llvm {
35  class LLVMContext;
36  class DataLayout;
37}   // namespace llvm
38
39namespace clang {
40  class VarDecl;
41  class ASTContext;
42  class TargetInfo;
43  class FunctionDecl;
44  class SourceManager;
45}   // namespace clang
46
47namespace slang {
48  class RSExportable;
49  class RSExportVar;
50  class RSExportFunc;
51  class RSExportForEach;
52  class RSExportType;
53
54class RSContext {
55  typedef llvm::StringSet<> NeedExportVarSet;
56  typedef llvm::StringSet<> NeedExportFuncSet;
57  typedef llvm::StringSet<> NeedExportTypeSet;
58
59 public:
60  typedef std::list<RSExportable*> ExportableList;
61  typedef std::list<RSExportVar*> ExportVarList;
62  typedef std::list<RSExportFunc*> ExportFuncList;
63  typedef std::list<RSExportForEach*> ExportForEachList;
64  typedef llvm::StringMap<RSExportType*> ExportTypeMap;
65
66 private:
67  clang::Preprocessor &mPP;
68  clang::ASTContext &mCtx;
69  PragmaList *mPragmas;
70  unsigned int mTargetAPI;
71  std::vector<std::string> *mGeneratedFileNames;
72
73  llvm::DataLayout *mDataLayout;
74  llvm::LLVMContext &mLLVMContext;
75
76  ExportableList mExportables;
77
78  NeedExportTypeSet mNeedExportTypes;
79
80  std::string *mLicenseNote;
81  std::string mReflectJavaPackageName;
82  std::string mReflectJavaPathName;
83
84  std::string mRSPackageName;
85
86  int version;
87
88  bool mIsCompatLib;
89
90  llvm::OwningPtr<clang::MangleContext> mMangleCtx;
91
92  bool processExportVar(const clang::VarDecl *VD);
93  bool processExportFunc(const clang::FunctionDecl *FD);
94  bool processExportType(const llvm::StringRef &Name);
95
96  void cleanupForEach();
97
98  ExportVarList mExportVars;
99  ExportFuncList mExportFuncs;
100  ExportForEachList mExportForEach;
101  ExportTypeMap mExportTypes;
102
103 public:
104  RSContext(clang::Preprocessor &PP,
105            clang::ASTContext &Ctx,
106            const clang::TargetInfo &Target,
107            PragmaList *Pragmas,
108            unsigned int TargetAPI,
109            std::vector<std::string> *GeneratedFileNames);
110
111  inline clang::Preprocessor &getPreprocessor() const { return mPP; }
112  inline clang::ASTContext &getASTContext() const { return mCtx; }
113  inline clang::MangleContext &getMangleContext() const {
114    return *mMangleCtx;
115  }
116  inline const llvm::DataLayout *getDataLayout() const { return mDataLayout; }
117  inline llvm::LLVMContext &getLLVMContext() const { return mLLVMContext; }
118  inline const clang::SourceManager *getSourceManager() const {
119    return &mPP.getSourceManager();
120  }
121  inline clang::DiagnosticsEngine *getDiagnostics() const {
122    return &mPP.getDiagnostics();
123  }
124  inline unsigned int getTargetAPI() const {
125    return mTargetAPI;
126  }
127
128  inline void setLicenseNote(const std::string &S) {
129    mLicenseNote = new std::string(S);
130  }
131  inline const std::string *getLicenseNote() const { return mLicenseNote; }
132
133  inline void addExportType(const std::string &S) {
134    mNeedExportTypes.insert(S);
135  }
136
137  inline void setReflectJavaPackageName(const std::string &S) {
138    mReflectJavaPackageName = S;
139  }
140  inline const std::string &getReflectJavaPackageName() const {
141    return mReflectJavaPackageName;
142  }
143
144  inline void setRSPackageName(const std::string &S) {
145    mRSPackageName = S;
146  }
147  inline const std::string &getRSPackageName() const {
148    return mRSPackageName;
149  }
150
151  bool processExport();
152  inline void newExportable(RSExportable *E) {
153    if (E != NULL)
154      mExportables.push_back(E);
155  }
156  typedef ExportableList::iterator exportable_iterator;
157  exportable_iterator exportable_begin() {
158    return mExportables.begin();
159  }
160  exportable_iterator exportable_end() {
161    return mExportables.end();
162  }
163
164  typedef ExportVarList::const_iterator const_export_var_iterator;
165  const_export_var_iterator export_vars_begin() const {
166    return mExportVars.begin();
167  }
168  const_export_var_iterator export_vars_end() const {
169    return mExportVars.end();
170  }
171  inline bool hasExportVar() const {
172    return !mExportVars.empty();
173  }
174
175  typedef ExportFuncList::const_iterator const_export_func_iterator;
176  const_export_func_iterator export_funcs_begin() const {
177    return mExportFuncs.begin();
178  }
179  const_export_func_iterator export_funcs_end() const {
180    return mExportFuncs.end();
181  }
182  inline bool hasExportFunc() const { return !mExportFuncs.empty(); }
183
184  typedef ExportForEachList::const_iterator const_export_foreach_iterator;
185  const_export_foreach_iterator export_foreach_begin() const {
186    return mExportForEach.begin();
187  }
188  const_export_foreach_iterator export_foreach_end() const {
189    return mExportForEach.end();
190  }
191  inline bool hasExportForEach() const { return !mExportForEach.empty(); }
192
193  typedef ExportTypeMap::iterator export_type_iterator;
194  typedef ExportTypeMap::const_iterator const_export_type_iterator;
195  export_type_iterator export_types_begin() { return mExportTypes.begin(); }
196  export_type_iterator export_types_end() { return mExportTypes.end(); }
197  const_export_type_iterator export_types_begin() const {
198    return mExportTypes.begin();
199  }
200  const_export_type_iterator export_types_end() const {
201    return mExportTypes.end();
202  }
203  inline bool hasExportType() const { return !mExportTypes.empty(); }
204  export_type_iterator findExportType(const llvm::StringRef &TypeName) {
205    return mExportTypes.find(TypeName);
206  }
207  const_export_type_iterator findExportType(const llvm::StringRef &TypeName)
208      const {
209    return mExportTypes.find(TypeName);
210  }
211
212  // Insert the specified Typename/Type pair into the map. If the key already
213  // exists in the map, return false and ignore the request, otherwise insert it
214  // and return true.
215  bool insertExportType(const llvm::StringRef &TypeName, RSExportType *Type);
216
217  bool reflectToJava(const std::string &OutputPathBase,
218                     const std::string &RSPackageName,
219                     const std::string &InputFileName,
220                     const std::string &OutputBCFileName,
221                     bool EmbedBitcodeInJava);
222
223  int getVersion() const { return version; }
224  void setVersion(int v) {
225    version = v;
226  }
227
228  bool isCompatLib() const { return mIsCompatLib; }
229
230  void addPragma(const std::string &T, const std::string &V) {
231    mPragmas->push_back(make_pair(T, V));
232  }
233
234  // Report an error or a warning to the user.
235  template <unsigned N>
236  clang::DiagnosticBuilder Report(clang::DiagnosticsEngine::Level Level,
237                                             const char (&Message)[N]) {
238  clang::DiagnosticsEngine *DiagEngine = getDiagnostics();
239  return DiagEngine->Report(DiagEngine->getCustomDiagID(Level, Message));
240}
241
242  template <unsigned N>
243  clang::DiagnosticBuilder Report(clang::DiagnosticsEngine::Level Level,
244                                             const clang::SourceLocation Loc,
245                                             const char (&Message)[N]) {
246  clang::DiagnosticsEngine *DiagEngine = getDiagnostics();
247  const clang::SourceManager *SM = getSourceManager();
248  return DiagEngine->Report(clang::FullSourceLoc(Loc, *SM),
249                            DiagEngine->getCustomDiagID(Level, Message));
250}
251
252  // Utility functions to report errors and warnings to make the calling code
253  // easier to read.
254  template <unsigned N>
255  clang::DiagnosticBuilder ReportError(const char (&Message)[N]) {
256    return Report<N>(clang::DiagnosticsEngine::Error, Message);
257  }
258
259  template <unsigned N>
260  clang::DiagnosticBuilder ReportError(const clang::SourceLocation Loc,
261                                       const char (&Message)[N]) {
262    return Report<N>(clang::DiagnosticsEngine::Error, Loc, Message);
263  }
264
265  template <unsigned N>
266  clang::DiagnosticBuilder ReportWarning(const char (&Message)[N]) {
267    return Report<N>(clang::DiagnosticsEngine::Warning, Message);
268  }
269
270  template <unsigned N>
271  clang::DiagnosticBuilder ReportWarning(const clang::SourceLocation Loc,
272                                         const char (&Message)[N]) {
273    return Report<N>(clang::DiagnosticsEngine::Warning, Loc, Message);
274  }
275
276  ~RSContext();
277};
278
279}   // namespace slang
280
281#endif  // _FRAMEWORKS_COMPILE_SLANG_SLANG_RS_CONTEXT_H_  NOLINT
282