environment_initialization.cpp File Reference

#include <corecrt_internal_traits.h>
#include <stdlib.h>
#include <string.h>

Include dependency graph for environment_initialization.cpp:

Go to the source code of this file.

Functions
char ***__cdecl	__p__environ ()
wchar_t ***__cdecl	__p__wenviron ()
static _Ret_opt_z_ char **&	get_environment_nolock (char) throw ()
static _Ret_opt_z_ wchar_t **&	get_environment_nolock (wchar_t) throw ()
static _Ret_opt_z_ char **&__cdecl	get_initial_environment (char) throw ()
static _Ret_opt_z_ wchar_t **&__cdecl	get_initial_environment (wchar_t) throw ()
static __crt_state_management::dual_state_global< char ** > &	get_dual_state_environment_nolock (char) throw ()
static __crt_state_management::dual_state_global< wchar_t ** > &	get_dual_state_environment_nolock (wchar_t) throw ()
template<typename Character >
static size_t const	count_variables_in_environment_block (Character *const environment_block) throw ()
template<typename Character >
static void	free_environment (Character **const environment) throw ()
template<typename Character >
static Character **const	create_environment (Character *const environment_block) throw ()
static void	pre_initialize (char) throw ()
template<typename Character >
static int __cdecl	common_initialize_environment_nolock () throw ()
int __cdecl	_initialize_narrow_environment ()
int __cdecl	_initialize_wide_environment ()
template<typename Character >
static void __cdecl	uninitialize_environment_internal (Character **&environment) throw ()
void __cdecl	__dcrt_uninitialize_environments_nolock ()
template<typename Character >
static int __cdecl	initialize_environment_by_cloning_nolock () throw ()
template<typename Character >
static _Deref_ret_opt_z_ Character **__cdecl	common_get_or_create_environment_nolock () throw ()
char **__cdecl	__dcrt_get_or_create_narrow_environment_nolock ()
wchar_t **__cdecl	__dcrt_get_or_create_wide_environment_nolock ()
template<typename Character >
static Character **__cdecl	common_get_initial_environment () throw ()
char **__cdecl	_get_initial_narrow_environment ()
wchar_t **__cdecl	_get_initial_wide_environment ()

Variables
char **	__dcrt_initial_narrow_environment = nullptr
wchar_t **	__dcrt_initial_wide_environment = nullptr
__crt_state_management::dual_state_global< char ** >	_environ_table
__crt_state_management::dual_state_global< wchar_t ** >	_wenviron_table
static void	pre_initialize (wchar_t)

Function Documentation

__dcrt_get_or_create_narrow_environment_nolock()

char **__cdecl __dcrt_get_or_create_narrow_environment_nolock

(

void

)

Definition at line 306 of file environment_initialization.cpp.

{
    return common_get_or_create_environment_nolock<char>();
}

__dcrt_get_or_create_wide_environment_nolock()

wchar_t **__cdecl __dcrt_get_or_create_wide_environment_nolock

(

void

)

Definition at line 311 of file environment_initialization.cpp.

{
    return common_get_or_create_environment_nolock<wchar_t>();
}

__dcrt_uninitialize_environments_nolock()

void __cdecl __dcrt_uninitialize_environments_nolock

(

void

)

Definition at line 216 of file environment_initialization.cpp.

{
    _environ_table .uninitialize(uninitialize_environment_internal<char>);
    _wenviron_table.uninitialize(uninitialize_environment_internal<wchar_t>);
 
    free_environment(__dcrt_initial_narrow_environment);
    free_environment(__dcrt_initial_wide_environment);
}

Referenced by uninitialize_environment().

__p__environ()

char ***__cdecl __p__environ

(

void

)

Definition at line 30 of file environment_initialization.cpp.

{ return &_environ_table.value();  }

Referenced by getenv(), and Test__environ().

__p__wenviron()

wchar_t ***__cdecl __p__wenviron

(

void

)

Definition at line 31 of file environment_initialization.cpp.

{ return &_wenviron_table.value(); }

Referenced by _wgetenv(), and Test__wenviron().

_get_initial_narrow_environment()

char **__cdecl _get_initial_narrow_environment

(

void

)

Definition at line 328 of file environment_initialization.cpp.

{
    return common_get_initial_environment<char>();
}

Referenced by call_main< decltype(main)>().

_get_initial_wide_environment()

wchar_t **__cdecl _get_initial_wide_environment

(

void

)

Definition at line 333 of file environment_initialization.cpp.

{
    return common_get_initial_environment<wchar_t>();
}

Referenced by call_main< decltype(wmain)>().

_initialize_narrow_environment()

int __cdecl _initialize_narrow_environment

(

void

)

Definition at line 192 of file environment_initialization.cpp.

{
    return common_initialize_environment_nolock<char>();
}

_initialize_wide_environment()

int __cdecl _initialize_wide_environment

(

void

)

Definition at line 197 of file environment_initialization.cpp.

{
    return common_initialize_environment_nolock<wchar_t>();
}

common_get_initial_environment()

template<typename Character >

static Character **__cdecl common_get_initial_environment ( ) throw ( )

static

Definition at line 317 of file environment_initialization.cpp.

{
    Character**& initial_environment = get_initial_environment(Character());
    if (!initial_environment)
    {
        initial_environment = common_get_or_create_environment_nolock<Character>();
    }
 
    return initial_environment;
}

common_get_or_create_environment_nolock()

template<typename Character >

static _Deref_ret_opt_z_ Character **__cdecl common_get_or_create_environment_nolock ( ) throw ( )

static

Definition at line 279 of file environment_initialization.cpp.

{
    typedef __crt_char_traits<Character> traits;
    typedef typename traits::other_char_type other_char_type;
 
    // Check to see if the required environment already exists:
    Character** const existing_environment = get_environment_nolock(Character());
    if (existing_environment)
        return existing_environment;
 
    // Check to see if the other environment exists.  We will only initialize
    // the environment here if the other environment was already initialized.
    other_char_type** const other_environment = get_environment_nolock(other_char_type());
    if (!other_environment)
        return nullptr;
 
    if (common_initialize_environment_nolock<Character>() != 0)
    {
        if (initialize_environment_by_cloning_nolock<Character>() != 0)
        {
            return nullptr;
        }
    }
 
    return get_environment_nolock(Character());
}

common_initialize_environment_nolock()

template<typename Character >

static int __cdecl common_initialize_environment_nolock ( ) throw ( )

static

Definition at line 167 of file environment_initialization.cpp.

{
    typedef __crt_char_traits<Character> traits;
 
    // We only initialize the environment once.  Once the environment has been
    // initialized, all updates and modifications go through the other functions
    // that manipulate the environment.
    if (get_environment_nolock(Character()))
        return 0;
 
    pre_initialize(Character());
 
    __crt_unique_heap_ptr<Character> const os_environment(traits::get_environment_from_os());
    if (!os_environment)
        return -1;
 
    __crt_unique_heap_ptr<Character*> crt_environment(create_environment(os_environment.get()));
    if (!crt_environment)
        return -1;
 
    get_initial_environment(Character()) = crt_environment.get();
    get_dual_state_environment_nolock(Character()).initialize(crt_environment.detach());
    return 0;
}

count_variables_in_environment_block()

template<typename Character >

static size_t const count_variables_in_environment_block ( Character *const  environment_block ) throw ( )

static

Definition at line 56 of file environment_initialization.cpp.

{
    typedef __crt_char_traits<Character> traits;
 
    // Count the number of variables in the environment block, ignoring drive
    // letter settings, which begin with '=':
    size_t count = 0;
 
    Character* it = environment_block;
    while (*it != '\0')
    {
        if (*it != '=')
            ++count;
 
        // This advances the iterator to the next string:
        it += traits::tcslen(it) + 1;
    }
 
    return count;
}

Referenced by create_environment().

create_environment()

template<typename Character >

static Character **const create_environment ( Character *const  environment_block ) throw ( )

static

Definition at line 109 of file environment_initialization.cpp.

{
    typedef __crt_char_traits<Character> traits;
 
    size_t const variable_count = count_variables_in_environment_block(environment_block);
 
    __crt_unique_heap_ptr<Character*> environment(_calloc_crt_t(Character*, variable_count + 1));
    if (!environment)
        return nullptr;
 
    Character*  source_it = environment_block;
    Character** result_it = environment.get();
 
    while (*source_it != '\0')
    {
        size_t const required_count = traits::tcslen(source_it) + 1;
 
        // Don't copy drive letter settings, which start with '=':
        if (*source_it != '=')
        {
            __crt_unique_heap_ptr<Character> variable(_calloc_crt_t(Character, required_count));
            if (!variable)
            {
                free_environment(environment.detach());
                return nullptr;
            }
 
            _ERRCHECK(traits::tcscpy_s(variable.get(), required_count, source_it));
            *result_it++ = variable.detach();
        }
 
        // This advances the iterator to the next string:
        source_it += required_count;
    }
 
    // The sequence of pointers is already null-terminated; return it:
    return environment.detach();
}

Referenced by common_initialize_environment_nolock().

free_environment()

template<typename Character >

static void free_environment ( Character **const  environment ) throw ( )

static

Definition at line 90 of file environment_initialization.cpp.

{
    if (!environment)
        return;
 
    for (Character** it = environment; *it; ++it)
        _free_crt(*it);
 
    _free_crt(environment);
}

Referenced by __dcrt_uninitialize_environments_nolock(), create_environment(), and uninitialize_environment_internal().

get_dual_state_environment_nolock() [1/2]

static __crt_state_management::dual_state_global< char ** > & get_dual_state_environment_nolock ( char  ) throw ( )

static

Definition at line 48 of file environment_initialization.cpp.

{ return _environ_table;  }

Referenced by common_initialize_environment_nolock().

get_dual_state_environment_nolock() [2/2]

static __crt_state_management::dual_state_global< wchar_t ** > & get_dual_state_environment_nolock ( wchar_t  ) throw ( )

static

Definition at line 49 of file environment_initialization.cpp.

{ return _wenviron_table; }

get_environment_nolock() [1/2]

static _Ret_opt_z_ char **& get_environment_nolock ( char  ) throw ( )

static

Definition at line 37 of file environment_initialization.cpp.

{ return _environ_table.value();  }

Referenced by common_get_or_create_environment_nolock(), common_initialize_environment_nolock(), and initialize_environment_by_cloning_nolock().

get_environment_nolock() [2/2]

static _Ret_opt_z_ wchar_t **& get_environment_nolock ( wchar_t  ) throw ( )

static

Definition at line 40 of file environment_initialization.cpp.

{ return _wenviron_table.value(); }

get_initial_environment() [1/2]

static _Ret_opt_z_ char **&__cdecl get_initial_environment ( char  ) throw ( )

static

Definition at line 43 of file environment_initialization.cpp.

{ return __dcrt_initial_narrow_environment; }

Referenced by common_get_initial_environment(), common_initialize_environment_nolock(), and uninitialize_environment_internal().

get_initial_environment() [2/2]

static _Ret_opt_z_ wchar_t **&__cdecl get_initial_environment ( wchar_t  ) throw ( )

static

Definition at line 46 of file environment_initialization.cpp.

{ return __dcrt_initial_wide_environment;   }

initialize_environment_by_cloning_nolock()

template<typename Character >

static int __cdecl initialize_environment_by_cloning_nolock ( ) throw ( )

static

Definition at line 241 of file environment_initialization.cpp.

{
    typedef __crt_char_traits<Character> traits;
    typedef typename traits::other_char_type other_char_type;
 
    other_char_type** const other_environment = get_environment_nolock(other_char_type());
    if (!other_environment)
        return -1;
 
    for (other_char_type** it = other_environment; *it; ++it)
    {
        size_t const required_count = __crt_compute_required_transform_buffer_count(CP_ACP, *it);
        if (required_count == 0)
            return -1;
 
        __crt_unique_heap_ptr<Character> buffer(_calloc_crt_t(Character, required_count));
        if (!buffer)
            return -1;
 
        size_t const actual_count = __crt_transform_string(CP_ACP, *it, buffer.get(), required_count);
        if (actual_count == 0)
            return -1;
 
        // Ignore a failed attempt to set a variable; continue with the rest...
        traits::set_variable_in_environment_nolock(buffer.detach(), 0);
    }
 
    return 0;
}

pre_initialize()

static void pre_initialize ( char  ) throw ( )

static

Definition at line 157 of file environment_initialization.cpp.

{ __acrt_initialize_multibyte(); }

uninitialize_environment_internal()

template<typename Character >

static void __cdecl uninitialize_environment_internal ( Character **&  environment ) throw ( )

static

Definition at line 206 of file environment_initialization.cpp.

{
    if (environment == get_initial_environment(Character()))
    {
        return;
    }
 
    free_environment(environment);
}

Variable Documentation

__dcrt_initial_narrow_environment

char** __dcrt_initial_narrow_environment = nullptr

Definition at line 24 of file environment_initialization.cpp.

Referenced by __dcrt_uninitialize_environments_nolock(), and get_initial_environment().

__dcrt_initial_wide_environment

wchar_t** __dcrt_initial_wide_environment = nullptr

Definition at line 25 of file environment_initialization.cpp.

Referenced by __dcrt_uninitialize_environments_nolock(), and get_initial_environment().

_environ_table

__crt_state_management::dual_state_global<char**> _environ_table

Definition at line 27 of file environment_initialization.cpp.

Referenced by __dcrt_uninitialize_environments_nolock(), __p__environ(), common_putenv_nolock(), common_set_variable_in_environment_nolock(), get_dual_state_environment_nolock(), get_environment(), get_environment_nolock(), get_other_environment(), and other_environment_exists().

_wenviron_table

__crt_state_management::dual_state_global<wchar_t**> _wenviron_table

Definition at line 28 of file environment_initialization.cpp.

Referenced by __dcrt_uninitialize_environments_nolock(), __p__wenviron(), common_putenv_nolock(), common_set_variable_in_environment_nolock(), get_dual_state_environment_nolock(), get_environment(), get_environment_nolock(), get_other_environment(), and other_environment_exists().

pre_initialize

void pre_initialize(wchar_t) ( wchar_t  )

static

Definition at line 158 of file environment_initialization.cpp.

{ /* no-op */                    }

Referenced by common_initialize_environment_nolock().