cpp_generator.h

Go to the documentation of this file.

/*
 * Copyright (c) 2013-2016:  G-CSC, Goethe University Frankfurt
 * Author: Torbjörn Klatt
 * 
 * This file is part of UG4.
 * 
 * UG4 is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License version 3 (as published by the
 * Free Software Foundation) with the following additional attribution
 * requirements (according to LGPL/GPL v3 §7):
 * 
 * (1) The following notice must be displayed in the Appropriate Legal Notices
 * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (2) The following notice must be displayed at a prominent place in the
 * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (3) The following bibliography is recommended for citation and must be
 * preserved in all covered files:
 * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
 *   parallel geometric multigrid solver on hierarchically distributed grids.
 *   Computing and visualization in science 16, 4 (2013), 151-164"
 * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
 *   flexible software system for simulating pde based models on high performance
 *   computers. Computing and visualization in science 16, 4 (2013), 165-179"
 * 
 * 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 Lesser General Public License for more details.
 */
 
#ifndef __UG__REGDOCU__CPP_GENERATOR_H
#define __UG__REGDOCU__CPP_GENERATOR_H
 
#include <vector> // std::vector
#include <map>    // std::map
#include <set>    // std::set
#include <string> // std::string
 
#ifdef UG_BRIDGE
# include "bridge/bridge.h"
#endif
#include "registry/registry.h"
#include "registry/class_helper.h"
#include "class_hierarchy_provider.h"
 
namespace ug
{
namespace DocuGen
{
 
using namespace std;
 
 
class CppGenerator
{
  public:
    CppGenerator( const string dir, ClassHierarchyProvider &chp, bool silent=false );
    ~CppGenerator();
    
    void generate_cpp_files();
    
  private:
 
    void generate_class_group();
    void generate_global_functions();
    
 
    void generate_class_docu();
    void generate_class_cpp();
    
 
    void generate_class_constructors();
    void generate_class_public_methods();
    void generate_class_public_members();
    
 
    template< class TEntity >
    void write_brief_detail_docu( const TEntity &entity );
    template< class TFunction >
    void write_parameter_docu( const TFunction &function );
    template< class TFunction >
    void write_generic_function( const TFunction &function, bool constant=false );
    void write_group_definitions();
    
 
    template< class TFunction >
    string generate_parameter_list( const TFunction &func );
    string generate_return_value( const bridge::ExportedFunctionBase &method );
    
 
    inline string name_to_id( const string& str );
    string parameter_to_string( const bridge::ParameterInfo &par, const int i ) const;
    inline string sanitize_parameter_name( const string &param ) const;
    inline string sanitize_docstring( const string &docstring, bool is_brief=false );
    inline string sanitize_docu( const string &param_docu ) const;
    vector<string> split_group_hieararchy( const string group );
    string write_group_namespaces( vector<string> group_hierarchy, bool is_global_func=false );
    
  private:
    string m_output_dir;
    
    bridge::Registry &mr_reg;
    ClassHierarchyProvider &mr_chp;
    
    bridge::IExportedClass *m_curr_class;
    bridge::ClassGroupDesc *m_curr_group;
    string m_curr_group_name;
    bool m_is_plugin;
    bool m_is_global;
    
    map<string, string> m_written_classes;
    
    fstream m_curr_file;
    
    bool m_silent;
};
 
// end group apps_ugdocu
 
} // end namespace DocuGen
} // end namespace ug
 
#endif  // __UG__REGDOCU__CPP_GENERATOR_H