//////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////
//
// copyright            : (C) 2008 by Eran Ifrah
// file name            : environmentconfig.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.
//
//////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////
#ifndef __environmentconfig__
#define __environmentconfig__

#include "configurationtoolbase.h"
#include "archive.h"
#include "evnvarlist.h"
#include <wx/utils.h>
#include "macros.h"
#include <wx/thread.h>

class EnvSetter;

/// A helper class that makes sure that escpaed $ signs
/// are kept unharmed
class WXDLLIMPEXP_SDK DollarEscaper
{
    wxString &m_str;
public:
    DollarEscaper(wxString &str) ;
    
    ~DollarEscaper() ;
};


class WXDLLIMPEXP_SDK EnvironmentConfig : public ConfigurationToolBase
{
    // Allow access to Apply/UnApply Env
    friend class EnvSetter;
    
    wxStringMap_t     m_envSnapshot;
    wxCriticalSection m_cs;
    int               m_envApplied;
    
protected:
    wxString    DoExpandVariables(const wxString &in);
    void        ApplyEnv(wxStringMap_t *overrideMap, const wxString &project, const wxString &config);
    void        UnApplyEnv();

public:
    static EnvironmentConfig* Instance();
    static void Release();
    bool        Load();
    wxString    ExpandVariables(const wxString &in, bool applyEnvironment);
    EvnVarList  GetSettings();
    void        SetSettings(EvnVarList &vars);
    /**
     * @brief return a list of the environment variabels as defined by the user
     * in the global environment table + workspace + project (this function only return the names of the variable, not its value)
     */
    wxArrayString GetActiveSetEnvNames(bool includeWorkspace = true, const wxString &project = wxEmptyString);
    
private:
    EnvironmentConfig();
    virtual ~EnvironmentConfig();

public:
    virtual wxString GetRootName();
};

class EnvSetter
{
    EnvironmentConfig *m_env;
    wxString           m_envName;
    wxString           m_oldEnvValue;
    bool               m_restoreOldValue;
    
public:
    EnvSetter(wxStringMap_t *om = NULL) 
        : m_env(EnvironmentConfig::Instance())
        , m_restoreOldValue(false) 
    {
        m_env->ApplyEnv(om, wxEmptyString, wxEmptyString);
    }

    EnvSetter(EnvironmentConfig *conf, wxStringMap_t *om = NULL) 
        : m_env(EnvironmentConfig::Instance())
        , m_restoreOldValue(false) 
    {
        wxUnusedVar(conf);
        m_env->ApplyEnv(om, wxEmptyString, wxEmptyString);
    }
    EnvSetter(EnvironmentConfig *conf, wxStringMap_t *om, const wxString &project, const wxString &buildConfig) 
        : m_env(EnvironmentConfig::Instance())
        , m_restoreOldValue(false) 
    {
        wxUnusedVar(conf);
        m_env->ApplyEnv(om, project, buildConfig);
    }
    
    EnvSetter(const wxString &var, const wxString &value) 
        : m_env(NULL) 
    {
        m_envName = var;
        // keep old value
        m_restoreOldValue = ::wxGetEnv(m_envName, &m_oldEnvValue);
        ::wxSetEnv(m_envName, value);
    }
    
    ~EnvSetter() {
        if (m_env) {
            m_env->UnApplyEnv();
            m_env = NULL;
        }
        
        if ( m_restoreOldValue ) {
            // restore old env variable value
            ::wxSetEnv(m_envName, m_oldEnvValue);
            
        } else if ( !m_envName.IsEmpty() ) {
            // we applied a single evn variable without old value
            // uset it
            ::wxUnsetEnv( m_envName );
        }
    }
};
#endif // __environmentconfig__
