OpenWalnut  1.4.0
WGEShaderCodeInjector.h
1 //---------------------------------------------------------------------------
2 //
3 // Project: OpenWalnut ( http://www.openwalnut.org )
4 //
5 // Copyright 2009 OpenWalnut Community, BSV@Uni-Leipzig and CNCF@MPI-CBS
6 // For more information see http://www.openwalnut.org/copying
7 //
8 // This file is part of OpenWalnut.
9 //
10 // OpenWalnut is free software: you can redistribute it and/or modify
11 // it under the terms of the GNU Lesser General Public License as published by
12 // the Free Software Foundation, either version 3 of the License, or
13 // (at your option) any later version.
14 //
15 // OpenWalnut is distributed in the hope that it will be useful,
16 // but WITHOUT ANY WARRANTY; without even the implied warranty of
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 // GNU Lesser General Public License for more details.
19 //
20 // You should have received a copy of the GNU Lesser General Public License
21 // along with OpenWalnut. If not, see <http://www.gnu.org/licenses/>.
22 //
23 //---------------------------------------------------------------------------
24 
25 #ifndef WGESHADERCODEINJECTOR_H
26 #define WGESHADERCODEINJECTOR_H
27 
28 #include <string>
29 
30 #include "WGEShaderPreprocessor.h"
31 
32 
33 
34 /**
35  * This preprocessor is able to inject code into a shader. It therefore replaces a specified keyword with code.
36  */
38 {
39 public:
40  /**
41  * Shortcut for a shared_ptr.
42  */
43  typedef boost::shared_ptr< WGEShaderCodeInjector > SPtr;
44 
45  /**
46  * Shortcut for a const shared_ptr.
47  */
48  typedef boost::shared_ptr< WGEShaderCodeInjector > ConstSPtr;
49 
50  /**
51  * Default constructor.
52  *
53  * \param keyword this is replaced by the custom code if existing.
54  */
55  explicit WGEShaderCodeInjector( std::string keyword );
56 
57  /**
58  * Destructor.
59  */
60  virtual ~WGEShaderCodeInjector();
61 
62  /**
63  * Process the whole code. It is not allowed to modify some internal state in this function because it might be called by several shaders.
64  *
65  * \param code the code to process
66  * \param file the filename of the shader currently processed. Should be used for debugging output.
67  *
68  * \return the resulting new code
69  */
70  virtual std::string process( const std::string& file, const std::string& code ) const;
71 
72  /**
73  * Define the code that replaces the keyword.
74  *
75  * \param code the code.
76  */
77  void setCode( std::string code );
78 protected:
79 private:
80  /**
81  * the custom code.
82  */
83  std::string m_code;
84 
85  /**
86  * What to replace.
87  */
88  std::string m_keyword;
89 };
90 
91 #endif // WGESHADERCODEINJECTOR_H
92