slang_rs.h revision 12fc283f4108fd6f7f0164c121ff2f6fb5044225 
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 generateJavaBitcodeAccessor(const std::string &OutputPathBase,
66                                   const std::string &PackageName,
67                                   const std::string *LicenseNote);
68
69  // CurInputFile is the pointer to a char array holding the input filename
70  // and is valid before compile() ends.
71  bool checkODR(const char *CurInputFile);
72
73  // Returns true if this is a Filterscript file.
74  static bool isFilterscript(const char *Filename);
75
76 protected:
77  virtual void initDiagnostic();
78  virtual void initPreprocessor();
79  virtual void initASTContext();
80
81  virtual clang::ASTConsumer
82  *createBackend(const clang::CodeGenOptions& CodeGenOpts,
83                 llvm::raw_ostream *OS,
84                 Slang::OutputType OT);
85
86
87 public:
88  static bool IsRSHeaderFile(const char *File);
89  // FIXME: Determine whether a location is in RS header (i.e., one of the RS
90  //        built-in APIs) should only need its names (we need a "list" of RS
91  //        built-in APIs).
92  static bool IsLocInRSHeaderFile(const clang::SourceLocation &Loc,
93                                  const clang::SourceManager &SourceMgr);
94
95  SlangRS();
96
97  // Compile bunch of RS files given in the llvm-rs-cc arguments. Return true if
98  // all given input files are successfully compiled without errors.
99  //
100  // @IOFiles - List of pairs of <input file path, output file path>.
101  //
102  // @DepFiles - List of pairs of <output dep. file path, dependent bitcode
103  //             target>. If @OutputDep is true, this parameter must be given
104  //             with the same number of pairs given in @IOFiles.
105  //
106  // @IncludePaths - User-defined include paths.
107  //
108  // @AdditionalDepTargets - User-defined files added to the dependencies.
109  //
110  // @OutputType - See Slang::OutputType.
111  //
112  // @BitcodeStorage - See BitCodeStorageType in slang_rs_reflect_util.cpp.
113  //
114  // @AllowRSPrefix - true to allow user-defined function prefixed with 'rs'.
115  //
116  // @OutputDep - true if output dependecies file for each input file.
117  //
118  // @JavaReflectionPathBase - The path base for storing reflection files.
119  //
120  // @EmitDebug - true to allow debug metadata emission
121  //
122  // @OptimizationLevel - code generation optimization level: None is recommended for
123  //                      interactive debugging. The default is Aggresive.
124  //
125  // @JavaReflectionPackageName - The package name given by user in command
126  //                              line. This may override the package name
127  //                              specified in the .rs using #pragma.
128  //
129  // @RSPackageName - The RS package name supplied by the command line. This
130  //                  can override the default value of
131  //                  "android.renderscript" used by the normal APIs.
132  //
133  bool compile(const std::list<std::pair<const char*, const char*> > &IOFiles,
134               const std::list<std::pair<const char*, const char*> > &DepFiles,
135               const std::vector<std::string> &IncludePaths,
136               const std::vector<std::string> &AdditionalDepTargets,
137               Slang::OutputType OutputType, BitCodeStorageType BitcodeStorage,
138               bool AllowRSPrefix, bool OutputDep,
139               unsigned int TargetAPI, bool EmitDebug,
140               llvm::CodeGenOpt::Level OptimizationLevel,
141               const std::string &JavaReflectionPathBase,
142               const std::string &JavaReflectionPackageName,
143               const std::string &RSPackageName);
144
145  virtual void reset();
146
147  virtual ~SlangRS();
148
149  virtual void makeModuleVisible(clang::Module *Mod,
150                                 clang::Module::NameVisibilityKind Visibility,
151                                 clang::SourceLocation ImportLoc,
152                                 bool Complain = false) { }
153
154  virtual clang::GlobalModuleIndex *loadGlobalModuleIndex(
155      clang::SourceLocation TriggerLoc) { }
156
157  virtual bool lookupMissingImports(llvm::StringRef Name,
158                                    clang::SourceLocation TriggerLoc) { }
159};
160}  // namespace slang
161
162#endif  // _FRAMEWORKS_COMPILE_SLANG_SLANG_RS_H_  NOLINT
163