OpenWalnut  1.4.0
WGEShaderCodeInjector.h
00001 //---------------------------------------------------------------------------
00002 //
00003 // Project: OpenWalnut ( http://www.openwalnut.org )
00004 //
00005 // Copyright 2009 OpenWalnut Community, BSV@Uni-Leipzig and CNCF@MPI-CBS
00006 // For more information see http://www.openwalnut.org/copying
00007 //
00008 // This file is part of OpenWalnut.
00009 //
00010 // OpenWalnut is free software: you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as published by
00012 // the Free Software Foundation, either version 3 of the License, or
00013 // (at your option) any later version.
00014 //
00015 // OpenWalnut is distributed in the hope that it will be useful,
00016 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00018 // GNU Lesser General Public License for more details.
00019 //
00020 // You should have received a copy of the GNU Lesser General Public License
00021 // along with OpenWalnut. If not, see <http://www.gnu.org/licenses/>.
00022 //
00023 //---------------------------------------------------------------------------
00024 
00025 #ifndef WGESHADERCODEINJECTOR_H
00026 #define WGESHADERCODEINJECTOR_H
00027 
00028 #include <string>
00029 
00030 #include "WGEShaderPreprocessor.h"
00031 
00032 
00033 
00034 /**
00035  * This preprocessor is able to inject code into a shader. It therefore replaces a specified keyword with code.
00036  */
00037 class WGEShaderCodeInjector: public WGEShaderPreprocessor
00038 {
00039 public:
00040     /**
00041      * Shortcut for a shared_ptr.
00042      */
00043     typedef boost::shared_ptr< WGEShaderCodeInjector > SPtr;
00044 
00045     /**
00046      * Shortcut for a const shared_ptr.
00047      */
00048     typedef boost::shared_ptr< WGEShaderCodeInjector > ConstSPtr;
00049 
00050     /**
00051      * Default constructor.
00052      *
00053      * \param keyword this is replaced by the custom code if existing.
00054      */
00055     explicit WGEShaderCodeInjector( std::string keyword );
00056 
00057     /**
00058      * Destructor.
00059      */
00060     virtual ~WGEShaderCodeInjector();
00061 
00062     /**
00063      * Process the whole code. It is not allowed to modify some internal state in this function because it might be called by several shaders.
00064      *
00065      * \param code the code to process
00066      * \param file the filename of the shader currently processed. Should be used for debugging output.
00067      *
00068      * \return the resulting new code
00069      */
00070     virtual std::string process( const std::string& file, const std::string& code ) const;
00071 
00072     /**
00073      * Define the code that replaces the keyword.
00074      *
00075      * \param code the code.
00076      */
00077     void setCode( std::string code );
00078 protected:
00079 private:
00080     /**
00081      * the custom code.
00082      */
00083     std::string m_code;
00084 
00085     /**
00086      * What to replace.
00087      */
00088     std::string m_keyword;
00089 };
00090 
00091 #endif  // WGESHADERCODEINJECTOR_H
00092