diff options
Diffstat (limited to 'tools/lldb-mi/MIUtilSingletonHelper.h')
| -rw-r--r-- | tools/lldb-mi/MIUtilSingletonHelper.h | 115 |
1 files changed, 58 insertions, 57 deletions
diff --git a/tools/lldb-mi/MIUtilSingletonHelper.h b/tools/lldb-mi/MIUtilSingletonHelper.h index ad36366830b7..a06a74296d03 100644 --- a/tools/lldb-mi/MIUtilSingletonHelper.h +++ b/tools/lldb-mi/MIUtilSingletonHelper.h @@ -8,18 +8,18 @@ //===----------------------------------------------------------------------===// //++ -// File: MIUtilSingletonHelper.h +// File: MIUtilSingletonHelper.h // -// Overview: Contains template functions to aid the initialisation and -// shutdown of MI modules. MI modules (or components) can -// use other MI modules to help them achieve their one task -// (Modules only do one task). +// Overview: Contains template functions to aid the initialisation and +// shutdown of MI modules. MI modules (or components) can +// use other MI modules to help them achieve their one task +// (Modules only do one task). // -// Environment: Compilers: Visual C++ 12. -// gcc (Ubuntu/Linaro 4.8.1-10ubuntu9) 4.8.1 -// Libraries: See MIReadmetxt. +// Environment: Compilers: Visual C++ 12. +// gcc (Ubuntu/Linaro 4.8.1-10ubuntu9) 4.8.1 +// Libraries: See MIReadmetxt. // -// Copyright: None. +// Copyright: None. //-- #pragma once @@ -32,64 +32,65 @@ namespace MI #include "MICmnResources.h" //++ ============================================================================ -// Details: Short cut helper function to simplify repeated initialisation of -// MI components (singletons) required by a client module. -// Type: Template method. -// Args: vErrorResrcId - (R) The string resource ID error message identifier to place in errMsg. -// vwrbOk - (RW) On input True = Try to initalise MI driver module. -// On output True = MI driver module initialise successfully. -// vwrErrMsg - (W) MI driver module initialise error description on failure. -// Return: MIstatus::success - Functional succeeded. -// MIstatus::failure - Functional failed. -// Authors: Aidan Dodds 17/03/2014. -// Changes: None. +// Details: Short cut helper function to simplify repeated initialisation of +// MI components (singletons) required by a client module. +// Type: Template method. +// Args: vErrorResrcId - (R) The string resource ID error message identifier to place in errMsg. +// vwrbOk - (RW) On input True = Try to initalise MI driver module. +// On output True = MI driver module initialise successfully. +// vwrErrMsg - (W) MI driver module initialise error description on failure. +// Return: MIstatus::success - Functional succeeded. +// MIstatus::failure - Functional failed. +// Authors: Aidan Dodds 17/03/2014. +// Changes: None. //-- -template< typename T > -bool ModuleInit( const MIint vErrorResrcId, bool & vwrbOk, CMIUtilString & vwrErrMsg ) +template <typename T> +bool +ModuleInit(const MIint vErrorResrcId, bool &vwrbOk, CMIUtilString &vwrErrMsg) { - if( vwrbOk && !T::Instance().Initialize() ) - { - vwrbOk = MIstatus::failure; - vwrErrMsg = CMIUtilString::Format( MIRSRC( vErrorResrcId ), T::Instance().GetErrorDescription().c_str() ); - } + if (vwrbOk && !T::Instance().Initialize()) + { + vwrbOk = MIstatus::failure; + vwrErrMsg = CMIUtilString::Format(MIRSRC(vErrorResrcId), T::Instance().GetErrorDescription().c_str()); + } - return vwrbOk; + return vwrbOk; } //++ ============================================================================ -// Details: Short cut helper function to simplify repeated shutodown of -// MI components (singletons) required by a client module. -// Type: Template method. -// Args: vErrorResrcId - (R) The string resource ID error message identifier -// to place in errMsg. -// vwrbOk - (W) If not already false make false on module -// shutdown failure. -// vwrErrMsg - (RW) Append to existing error description string MI -// driver module initialise error description on -// failure. -// Return: True - Module shutdown succeeded. -// False - Module shutdown failed. -// Authors: Aidan Dodds 17/03/2014. -// Changes: None. +// Details: Short cut helper function to simplify repeated shutodown of +// MI components (singletons) required by a client module. +// Type: Template method. +// Args: vErrorResrcId - (R) The string resource ID error message identifier +// to place in errMsg. +// vwrbOk - (W) If not already false make false on module +// shutdown failure. +// vwrErrMsg - (RW) Append to existing error description string MI +// driver module initialise error description on +// failure. +// Return: True - Module shutdown succeeded. +// False - Module shutdown failed. +// Authors: Aidan Dodds 17/03/2014. +// Changes: None. //-- -template< typename T > -bool ModuleShutdown( const MIint vErrorResrcId, bool & vwrbOk, CMIUtilString & vwrErrMsg ) +template <typename T> +bool +ModuleShutdown(const MIint vErrorResrcId, bool &vwrbOk, CMIUtilString &vwrErrMsg) { - bool bOk = MIstatus::success; + bool bOk = MIstatus::success; - if( !T::Instance().Shutdown() ) - { - const bool bMoreThanOneError( !vwrErrMsg.empty() ); - bOk = MIstatus::failure; - if( bMoreThanOneError ) - vwrErrMsg += ", "; - vwrErrMsg += CMIUtilString::Format( MIRSRC( vErrorResrcId ), T::Instance().GetErrorDescription().c_str() ); - } - - vwrbOk = bOk ? vwrbOk : MIstatus::failure; + if (!T::Instance().Shutdown()) + { + const bool bMoreThanOneError(!vwrErrMsg.empty()); + bOk = MIstatus::failure; + if (bMoreThanOneError) + vwrErrMsg += ", "; + vwrErrMsg += CMIUtilString::Format(MIRSRC(vErrorResrcId), T::Instance().GetErrorDescription().c_str()); + } - return bOk; + vwrbOk = bOk ? vwrbOk : MIstatus::failure; + + return bOk; } } // namespace MI - |