//////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////
//
// copyright            : (C) 2014 Eran Ifrah
// file name            : CMakeGenerator.h
//
// -------------------------------------------------------------------------
// A
//              _____           _      _     _ _
//             /  __ \         | |    | |   (_) |
//             | /  \/ ___   __| | ___| |    _| |_ ___
//             | |    / _ \ / _  |/ _ \ |   | | __/ _ )
//             | \__/\ (_) | (_| |  __/ |___| | ||  __/
//              \____/\___/ \__,_|\___\_____/_|\__\___|
//
//                                                  F i l e
//
//    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.
//
//////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////

/* ************************************************************************ */
/*                                                                          */
/* CMakePlugin for Codelite                                                 */
/* Copyright (C) 2013 Jiří Fatka <ntsfka@gmail.com>                         */
/*                                                                          */
/* 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 3 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, see <http://www.gnu.org/licenses/>.     */
/*                                                                          */
/* ************************************************************************ */

#ifndef CMAKE_GENERATOR_H_
#define CMAKE_GENERATOR_H_

/* ************************************************************************ */
/* INCLUDES                                                                 */
/* ************************************************************************ */

// CodeLite
#include "workspace.h"
#include "project.h"
#include "build_config.h"
#include "compiler.h"

/* ************************************************************************ */
/* CLASSES                                                                  */
/* ************************************************************************ */

/**
 * @brief The CMakeLists.txt generator.
 */
class CMakeGenerator
{
    size_t m_counter;
    wxString m_userBlock1;
    wxString m_userBlock2;
    wxString m_userBlock3;

protected:
    void ExpandOptions(const wxString& options, wxString& content, wxArrayString& arrVars, wxArrayString& arrOut,
        const wxString& indent = wxEmptyString);

    wxString Prefix(ProjectPtr project);

    /**
     * @brief Generate CMakeLists.txt file for given project
     * @param project Project.
     */
    wxString GenerateProject(ProjectPtr project, bool topProject, const wxString& configName = wxEmptyString);

    /**
     * @brief Check if filename exists and asks if user want it overwrite if
     * exists.
     *
     * @param filename Tested filename.
     *
     * @return If file can be written.
     */
    bool CheckExists(const wxFileName& filename);

    bool IsCustomCMakeLists(const wxFileName& fn);

    /**
     * @brief extract from the CMakeLists.txt file the user code blocks
     */
    void ReadUserCode(const wxString& content);

    /**
     * @brief read until we reach the end of user block
     */
    void ReadUntilEndOfUserBlock(wxArrayString& lines, wxString& content);

    void AddUserCodeSection(wxString& content, const wxString& sectionPrefix, const wxString& sectionCode = "");
    
    /**
     * @brief add pre|post build commands to the generated CMakeLists.txt file
     * @param buildType can be POST_BUILD, PRE_BUILD or PRE_LINK string
     * @param commands list of commands to run
     * @param content the CMakeLists.txt file content [output]
     */
    void AddBuildCommands(const wxString& buildType,
                          const BuildCommandList& commands,
                          ProjectPtr project,
                          wxString& content);

public:
    CMakeGenerator();
    ~CMakeGenerator();

    /**
     * @brief Generate CMakeLists.txt for workspace.
     *
     * Creates a base CMakeLists.txt file that adds only projects
     * (like subdirectories) that have CMakeLists.txt. Others are
     * ignored.
     *
     * @param workspace Exported workspace.
     */
    bool Generate(ProjectPtr project);

    /**
     * @brief check if a we can generate a CMakeLists.txt
     */
    bool CanGenerate(ProjectPtr project);
};

/* ************************************************************************ */

#endif // CMAKE_GENERATOR_H_
