module_maker.h

Go to the documentation of this file.

/*
 *  OGF/Graphite: Geometry and Graphics Programming Library + Utilities
 *  Copyright (C) 2000 Bruno Levy
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 *  If you modify this software, you should include a notice giving the
 *  name of the person performing the modification, the date of modification,
 *  and the reason for such modification.
 *
 *  Contact: Bruno Levy
 *
 *     levy@loria.fr
 *
 *     ISA Project
 *     LORIA, INRIA Lorraine, 
 *     Campus Scientifique, BP 239
 *     54506 VANDOEUVRE LES NANCY CEDEX 
 *     FRANCE
 *
 *  Note that the GNU General Public License does not permit incorporating
 *  the Software into proprietary programs. 
 */
 
#ifndef H_OGF_DEVEL_TYPES_MODULE_MAKER_H
#define H_OGF_DEVEL_TYPES_MODULE_MAKER_H
 
#include <OGF/devel/common/common.h>
#include <OGF/basic/os/text_utils.h>
 
namespace OGF {
 
    class DEVEL_API ModuleMaker {
    public:
        ModuleMaker();
 
        bool create_module(
            const std::string& module_name,
            const std::string& author_name
        );
 
        void create_file(
            const std::string& module_name,
            const std::string& subdirectory,
            const std::string& file_name,
            const std::string& header_skel = "devel/file.h.skel", 
            const std::string& source_skel = "devel/file.cpp.skel"
        );
 
        void create_class(
            const std::string& module_name,
            const std::string& subdirectory,
            const std::string& class_name,
            const std::string& header_skel = "devel/class.h.skel", 
            const std::string& source_skel = "devel/class.cpp.skel"
        );
 
 
        bool create_gom_class(
            const std::string& module_name,
            const std::string& subdirectory, 
            const std::string& base_class_name,
            const std::string& class_name,
            const std::string& header_skel = "devel/gom_class.h.skel", 
            const std::string& source_skel = "devel/gom_class.cpp.skel"
        );
 
        bool create_gom_class(
            const std::string& module_name,
            const std::string& subdirectory, 
            const std::string& base_class_name,
            const std::string& class_name,
            const std::string& header_skel,
            const std::string& source_skel,
            TextUtils::Environment& env
        );
 
        void create_commands(
            const std::string& module_name, 
            const std::string& grob_class_name, 
            const std::string& commands_name
        );
 
        void create_shader(
            const std::string& module_name,
            const std::string& grob_class_name,
            const std::string& shader_name,
            const std::string& base_class_name = ""
        );
 
        void create_tool(
            const std::string& module_name,
            const std::string& grob_class_name,
            const std::string& tool_name,
            const std::string& base_class_name = ""
        );
 
        void create_grob(
            const std::string& module_name,
            const std::string& grob_name,
            const std::string& file_extension = "",
            const std::string& base_class_name = "OGF::Grob"
        );
 
   protected:
 
        bool set_module(const std::string& module_name, bool check = true);
 
        void set_module_name(TextUtils::Environment& env);
 
        bool create_file_from_skel(
            const std::string& file_name,
            const std::string& skel_name,
            const TextUtils::Environment& env,
            bool insert_header = false 
        );
 
        bool create_directory(
            const std::string& dir_name
        );
 
        std::string class_name_to_file_name(const std::string& class_name);
 
        std::string file_name_to_include_guard(const std::string& file_name);
 
        bool insert(
            const std::string& file_name,
            const std::string& insertion_point,
            const std::string& line
        );
 
        void add_directory_to_cmake(const std::string& directory);
 
 
        void touch_root_cmake();
        
   private:
        std::string project_root_;
        std::string package_;
        std::string package_path_;
        std::string author_;
    };
 
}
 
#endif