slang_rs.h revision 129fd8228cd04592a20c3d5009805a23585f2479 
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_H_  // NOLINT
18#define _FRAMEWORKS_COMPILE_SLANG_SLANG_RS_H_
19
20#include "slang.h"
21
22#include <list>
23#include <string>
24#include <utility>
25#include <vector>
26
27#include "llvm/ADT/StringMap.h"
28
29#include "slang_rs_reflect_utils.h"
30#include "slang_version.h"
31
32namespace slang {
33  class RSContext;
34  class RSExportRecordType;
35
36class SlangRS : public Slang {
37 private:
38  // Context for Renderscript
39  RSContext *mRSContext;
40
41  bool mAllowRSPrefix;
42
43  unsigned int mTargetAPI;
44
45  bool mIsFilterscript;
46
47  // Custom diagnostic identifiers
48  unsigned mDiagErrorInvalidOutputDepParameter;
49  unsigned mDiagErrorODR;
50  unsigned mDiagErrorTargetAPIRange;
51
52  // Collect generated filenames (without the .java) for dependency generation
53  std::vector<std::string> mGeneratedFileNames;
54
55  // FIXME: Should be std::list<RSExportable *> here. But currently we only
56  //        check ODR on record type.
57  //
58  // ReflectedDefinitions maps record type name to a pair:
59  //  <its RSExportRecordType instance,
60  //   the first file contains this record type definition>
61  typedef std::pair<RSExportRecordType*, const char*> ReflectedDefinitionTy;
62  typedef llvm::StringMap<ReflectedDefinitionTy> ReflectedDefinitionListTy;
63  ReflectedDefinitionListTy ReflectedDefinitions;
64
65  bool reflectToJava(const std::string &OutputPathBase,
66                     const std::string &RSPackageName,
67                     bool EmbedBitcodeInJava);
68
69  bool generateJavaBitcodeAccessor(const std::string &OutputPathBase,
70                                   const std::string &PackageName,
71                                   const std::string *LicenseNote);
72
73  // CurInputFile is the pointer to a char array holding the input filename
74  // and is valid before compile() ends.
75  bool checkODR(const char *CurInputFile);
76
77  // Returns true if this is a Filterscript file.
78  static bool isFilterscript(const char *Filename);
79
80 protected:
81  virtual void initDiagnostic();
82  virtual void initPreprocessor();
83  virtual void initASTContext();
84
85  virtual clang::ASTConsumer
86  *createBackend(const clang::CodeGenOptions& CodeGenOpts,
87                 llvm::raw_ostream *OS,
88                 Slang::OutputType OT);
89
90
91 public:
92  static bool IsRSHeaderFile(const char *File);
93  // FIXME: Determine whether a location is in RS header (i.e., one of the RS
94  //        built-in APIs) should only need its names (we need a "list" of RS
95  //        built-in APIs).
96  static bool IsLocInRSHeaderFile(const clang::SourceLocation &Loc,
97                                  const clang::SourceManager &SourceMgr);
98
99  SlangRS();
100
101  // Compile bunch of RS files given in the llvm-rs-cc arguments. Return true if
102  // all given input files are successfully compiled without errors.
103  //
104  // @IOFiles - List of pairs of <input file path, output file path>.
105  //
106  // @DepFiles - List of pairs of <output dep. file path, dependent bitcode
107  //             target>. If @OutputDep is true, this parameter must be given
108  //             with the same number of pairs given in @IOFiles.
109  //
110  // @IncludePaths - User-defined include paths.
111  //
112  // @AdditionalDepTargets - User-defined files added to the dependencies.
113  //
114  // @OutputType - See Slang::OutputType.
115  //
116  // @BitcodeStorage - See BitCodeStorageType in slang_rs_reflect_util.cpp.
117  //
118  // @AllowRSPrefix - true to allow user-defined function prefixed with 'rs'.
119  //
120  // @OutputDep - true if output dependecies file for each input file.
121  //
122  // @JavaReflectionPathBase - The path base for storing reflection files.
123  //
124  // @EmitDebug - true to allow debug metadata emission
125  //
126  // @OptimizationLevel - code generation optimization level: None is recommended for
127  //                      interactive debugging. The default is Aggresive.
128  //
129  // @JavaReflectionPackageName - The package name given by user in command
130  //                              line. This may override the package name
131  //                              specified in the .rs using #pragma.
132  //
133  // @RSPackageName - The RS package name supplied by the command line. This
134  //                  can override the default value of
135  //                  "android.renderscript" used by the normal APIs.
136  //
137  bool compile(const std::list<std::pair<const char*, const char*> > &IOFiles,
138               const std::list<std::pair<const char*, const char*> > &DepFiles,
139               const std::vector<std::string> &IncludePaths,
140               const std::vector<std::string> &AdditionalDepTargets,
141               Slang::OutputType OutputType, BitCodeStorageType BitcodeStorage,
142               bool AllowRSPrefix, bool OutputDep,
143               unsigned int TargetAPI, bool EmitDebug,
144               llvm::CodeGenOpt::Level OptimizationLevel,
145               const std::string &JavaReflectionPathBase,
146               const std::string &JavaReflectionPackageName,
147               const std::string &RSPackageName);
148
149  virtual void reset();
150
151  virtual ~SlangRS();
152
153  virtual void makeModuleVisible(clang::Module *Mod,
154                                 clang::Module::NameVisibilityKind Visibility,
155                                 clang::SourceLocation ImportLoc,
156                                 bool Complain = false) { }
157
158  virtual clang::GlobalModuleIndex *loadGlobalModuleIndex(
159      clang::SourceLocation TriggerLoc) { }
160
161  virtual bool lookupMissingImports(llvm::StringRef Name,
162                                    clang::SourceLocation TriggerLoc) { }
163};
164}  // namespace slang
165
166#endif  // _FRAMEWORKS_COMPILE_SLANG_SLANG_RS_H_  NOLINT
167