From 1a097f8c490d5eb42df0df2abfeaa3401433471a Mon Sep 17 00:00:00 2001 From: Adriaan de Groot Date: Mon, 18 Jun 2018 10:56:10 -0400 Subject: [PATCH] Style: run modulesystem through the style guide --- .../modulesystem/CppJobModule.cpp | 7 ++-- src/libcalamaresui/modulesystem/Module.cpp | 25 ++++-------- src/libcalamaresui/modulesystem/Module.h | 10 ++++- .../modulesystem/ModuleManager.cpp | 26 +++++------- .../modulesystem/ProcessJobModule.cpp | 13 ++---- .../modulesystem/PythonJobModule.cpp | 9 ++--- .../modulesystem/PythonJobModule.h | 3 +- .../modulesystem/PythonQtViewModule.cpp | 40 +++++++++---------- .../modulesystem/PythonQtViewModule.h | 3 +- .../modulesystem/ViewModule.cpp | 3 +- 10 files changed, 61 insertions(+), 78 deletions(-) diff --git a/src/libcalamaresui/modulesystem/CppJobModule.cpp b/src/libcalamaresui/modulesystem/CppJobModule.cpp index 9799066e7..3a48e29f2 100644 --- a/src/libcalamaresui/modulesystem/CppJobModule.cpp +++ b/src/libcalamaresui/modulesystem/CppJobModule.cpp @@ -26,7 +26,8 @@ #include #include -namespace Calamares { +namespace Calamares +{ Module::Type @@ -55,7 +56,7 @@ CppJobModule::loadSelf() return; } - CppJob *cppJob = pf->create< Calamares::CppJob >(); + CppJob* cppJob = pf->create< Calamares::CppJob >(); if ( !cppJob ) { cDebug() << Q_FUNC_INFO << m_loader->errorString(); @@ -68,7 +69,7 @@ CppJobModule::loadSelf() cppJob->setModuleInstanceKey( instanceKey() ); cppJob->setConfigurationMap( m_configurationMap ); - m_job = Calamares::job_ptr( static_cast< Calamares::Job * >( cppJob ) ); + m_job = Calamares::job_ptr( static_cast< Calamares::Job* >( cppJob ) ); m_loaded = true; cDebug() << "CppJobModule" << instanceKey() << "loading complete."; } diff --git a/src/libcalamaresui/modulesystem/Module.cpp b/src/libcalamaresui/modulesystem/Module.cpp index 9b3be877f..c820b98b3 100644 --- a/src/libcalamaresui/modulesystem/Module.cpp +++ b/src/libcalamaresui/modulesystem/Module.cpp @@ -71,8 +71,7 @@ Module::fromDescriptor( const QVariantMap& moduleDescriptor, QString typeString = moduleDescriptor.value( "type" ).toString(); QString intfString = moduleDescriptor.value( "interface" ).toString(); - if ( typeString.isEmpty() || - intfString.isEmpty() ) + if ( typeString.isEmpty() || intfString.isEmpty() ) { cError() << "Bad module descriptor format" << instanceId; return nullptr; @@ -80,9 +79,7 @@ Module::fromDescriptor( const QVariantMap& moduleDescriptor, if ( ( typeString == "view" ) || ( typeString == "viewmodule" ) ) { if ( intfString == "qtplugin" ) - { m.reset( new ViewModule() ); - } else if ( intfString == "pythonqt" ) { #ifdef WITH_PYTHONQT @@ -97,13 +94,9 @@ Module::fromDescriptor( const QVariantMap& moduleDescriptor, else if ( typeString == "job" ) { if ( intfString == "qtplugin" ) - { m.reset( new CppJobModule() ); - } else if ( intfString == "process" ) - { m.reset( new ProcessJobModule() ); - } else if ( intfString == "python" ) { #ifdef WITH_PYTHON @@ -121,8 +114,8 @@ Module::fromDescriptor( const QVariantMap& moduleDescriptor, if ( !m ) { cError() << "Bad module type (" << typeString - << ") or interface string (" << intfString - << ") for module " << instanceId; + << ") or interface string (" << intfString + << ") for module " << instanceId; return nullptr; } @@ -168,8 +161,7 @@ Module::loadConfigurationFile( const QString& configFileName ) //throws YAML::Ex { configFilesByPriority.append( QDir( QDir::currentPath() ).absoluteFilePath( - QString( "src/modules/%1/%2" ).arg( m_name ) - .arg( configFileName ) ) ); + QString( "src/modules/%1/%2" ).arg( m_name ).arg( configFileName ) ) ); } configFilesByPriority.append( @@ -201,8 +193,8 @@ Module::loadConfigurationFile( const QString& configFileName ) //throws YAML::Ex m_configurationMap = CalamaresUtils::yamlMapToVariant( doc ).toMap(); m_emergency = m_maybe_emergency - && m_configurationMap.contains( EMERGENCY ) - && m_configurationMap[ EMERGENCY ].toBool(); + && m_configurationMap.contains( EMERGENCY ) + && m_configurationMap[ EMERGENCY ].toBool(); return; } else @@ -228,8 +220,7 @@ Module::instanceId() const QString Module::instanceKey() const { - return QString( "%1@%2" ).arg( m_name ) - .arg( m_instanceId ); + return QString( "%1@%2" ).arg( m_name ).arg( m_instanceId ); } @@ -297,9 +288,7 @@ Module::initFrom( const QVariantMap& moduleDescriptor ) m_name = moduleDescriptor.value( "name" ).toString(); if ( moduleDescriptor.contains( EMERGENCY ) ) - { m_maybe_emergency = moduleDescriptor[ EMERGENCY ].toBool(); - } } } //ns diff --git a/src/libcalamaresui/modulesystem/Module.h b/src/libcalamaresui/modulesystem/Module.h index 4fd0020f8..18c2e4cbe 100644 --- a/src/libcalamaresui/modulesystem/Module.h +++ b/src/libcalamaresui/modulesystem/Module.h @@ -147,7 +147,10 @@ public: * @brief isLoaded reports on the loaded status of a module. * @return true if the module's loading phase has finished, otherwise false. */ - bool isLoaded() const { return m_loaded; } + bool isLoaded() const + { + return m_loaded; + } /** * @brief loadSelf initialized the module. @@ -164,7 +167,10 @@ public: * are not run (in the common case where there is only * one exec block, this doesn't really matter). */ - bool isEmergency() const { return m_emergency; } + bool isEmergency() const + { + return m_emergency; + } /** * @brief jobs returns any jobs exposed by this module. diff --git a/src/libcalamaresui/modulesystem/ModuleManager.cpp b/src/libcalamaresui/modulesystem/ModuleManager.cpp index 375d15158..ed1e52f9f 100644 --- a/src/libcalamaresui/modulesystem/ModuleManager.cpp +++ b/src/libcalamaresui/modulesystem/ModuleManager.cpp @@ -60,10 +60,8 @@ ModuleManager::ModuleManager( const QStringList& paths, QObject* parent ) ModuleManager::~ModuleManager() { // The map is populated with Module::fromDescriptor(), which allocates on the heap. - for( auto moduleptr : m_loadedModulesByInstanceKey ) - { + for ( auto moduleptr : m_loadedModulesByInstanceKey ) delete moduleptr; - } } @@ -119,14 +117,12 @@ ModuleManager::doInit() else { cWarning() << "Cannot cd into module directory " - << path << "/" << subdir; + << path << "/" << subdir; } } } else - { cDebug() << "ModuleManager bad search path" << path; - } } // At this point m_availableModules is filled with whatever was found in the // search paths. @@ -182,10 +178,10 @@ ModuleManager::loadModules() { QStringList failedModules; Settings::InstanceDescriptionList customInstances = - Settings::instance()->customModuleInstances(); + Settings::instance()->customModuleInstances(); const auto modulesSequence = Settings::instance()->modulesSequence(); - for ( const auto &modulePhase : modulesSequence ) + for ( const auto& modulePhase : modulesSequence ) { ModuleAction currentAction = modulePhase.first; @@ -197,7 +193,7 @@ ModuleManager::loadModules() QString instanceId; QString configFileName; if ( moduleEntrySplit.length() < 1 || - moduleEntrySplit.length() > 2 ) + moduleEntrySplit.length() > 2 ) { cError() << "Wrong module entry format for module" << moduleEntry; failedModules.append( moduleEntry ); @@ -208,10 +204,10 @@ ModuleManager::loadModules() configFileName = QString( "%1.conf" ).arg( moduleName ); if ( !m_availableDescriptorsByModuleName.contains( moduleName ) || - m_availableDescriptorsByModuleName.value( moduleName ).isEmpty() ) + m_availableDescriptorsByModuleName.value( moduleName ).isEmpty() ) { cError() << "Module" << moduleName << "not found in module search paths." - << Logger::DebugList( m_paths ); + << Logger::DebugList( m_paths ); failedModules.append( moduleName ); continue; } @@ -221,9 +217,7 @@ ModuleManager::loadModules() int found = findCustomInstance( customInstances, moduleName, instanceId ); if ( found > -1 ) - { configFileName = customInstances[ found ].value( "config" ); - } else //ought to be a custom instance, but cannot find instance entry { cError() << "Custom instance" << moduleEntry << "not found in custom instances section."; @@ -254,9 +248,7 @@ ModuleManager::loadModules() } if ( thisModule && thisModule->isLoaded() ) - { cDebug() << "Module" << instanceKey << "already loaded."; - } else { thisModule = @@ -318,10 +310,10 @@ ModuleManager::checkDependencies() forever { for ( auto it = m_availableDescriptorsByModuleName.begin(); - it != m_availableDescriptorsByModuleName.end(); ++it ) + it != m_availableDescriptorsByModuleName.end(); ++it ) { foreach ( const QString& depName, - (*it).value( "requiredModules" ).toStringList() ) + ( *it ).value( "requiredModules" ).toStringList() ) { if ( !m_availableDescriptorsByModuleName.contains( depName ) ) { diff --git a/src/libcalamaresui/modulesystem/ProcessJobModule.cpp b/src/libcalamaresui/modulesystem/ProcessJobModule.cpp index d8e171977..9037d85a6 100644 --- a/src/libcalamaresui/modulesystem/ProcessJobModule.cpp +++ b/src/libcalamaresui/modulesystem/ProcessJobModule.cpp @@ -22,7 +22,8 @@ #include -namespace Calamares { +namespace Calamares +{ Module::Type @@ -68,23 +69,17 @@ ProcessJobModule::initFrom( const QVariantMap& moduleDescriptor ) m_workingPath = directory.absolutePath(); if ( !moduleDescriptor.value( "command" ).toString().isEmpty() ) - { m_command = moduleDescriptor.value( "command" ).toString(); - } m_secondsTimeout = 30; if ( moduleDescriptor.contains( "timeout" ) && - !moduleDescriptor.value( "timeout" ).isNull() ) - { + !moduleDescriptor.value( "timeout" ).isNull() ) m_secondsTimeout = moduleDescriptor.value( "timeout" ).toInt(); - } m_runInChroot = false; if ( moduleDescriptor.contains( "chroot" )&& - !moduleDescriptor.value( "chroot" ).isNull() ) - { + !moduleDescriptor.value( "chroot" ).isNull() ) m_runInChroot = moduleDescriptor.value( "chroot" ).toBool(); - } } diff --git a/src/libcalamaresui/modulesystem/PythonJobModule.cpp b/src/libcalamaresui/modulesystem/PythonJobModule.cpp index 586eb6e27..7099a3f72 100644 --- a/src/libcalamaresui/modulesystem/PythonJobModule.cpp +++ b/src/libcalamaresui/modulesystem/PythonJobModule.cpp @@ -23,7 +23,8 @@ #include -namespace Calamares { +namespace Calamares +{ Module::Type @@ -46,9 +47,7 @@ PythonJobModule::loadSelf() if ( m_loaded ) return; - m_job = Calamares::job_ptr( new PythonJob( m_scriptFileName, - m_workingPath, - m_configurationMap ) ); + m_job = Calamares::job_ptr( new PythonJob( m_scriptFileName, m_workingPath, m_configurationMap ) ); m_loaded = true; } @@ -68,9 +67,7 @@ PythonJobModule::initFrom( const QVariantMap& moduleDescriptor ) m_workingPath = directory.absolutePath(); if ( !moduleDescriptor.value( "script" ).toString().isEmpty() ) - { m_scriptFileName = moduleDescriptor.value( "script" ).toString(); - } } diff --git a/src/libcalamaresui/modulesystem/PythonJobModule.h b/src/libcalamaresui/modulesystem/PythonJobModule.h index 78678bcf8..38b10be83 100644 --- a/src/libcalamaresui/modulesystem/PythonJobModule.h +++ b/src/libcalamaresui/modulesystem/PythonJobModule.h @@ -23,7 +23,8 @@ #include "UiDllMacro.h" -namespace Calamares { +namespace Calamares +{ class UIDLLEXPORT PythonJobModule : public Module { diff --git a/src/libcalamaresui/modulesystem/PythonQtViewModule.cpp b/src/libcalamaresui/modulesystem/PythonQtViewModule.cpp index b667b6a81..9d0aa95e2 100644 --- a/src/libcalamaresui/modulesystem/PythonQtViewModule.cpp +++ b/src/libcalamaresui/modulesystem/PythonQtViewModule.cpp @@ -40,7 +40,8 @@ static QPointer< GlobalStorage > s_gs = nullptr; static QPointer< Utils > s_utils = nullptr; -namespace Calamares { +namespace Calamares +{ Module::Type PythonQtViewModule::type() const @@ -98,20 +99,21 @@ PythonQtViewModule::loadSelf() cala.addObject( "utils", s_utils ); // Append configuration object, in module PythonQt.calamares - cala.addVariable("configuration", m_configurationMap); + cala.addVariable( "configuration", m_configurationMap ); // Basic stdout/stderr handling QObject::connect( PythonQt::self(), &PythonQt::pythonStdOut, - []( const QString& message ) - { - cDebug() << "PythonQt OUT>" << message; - } ); + []( const QString& message ) + { + cDebug() << "PythonQt OUT>" << message; + } + ); QObject::connect( PythonQt::self(), &PythonQt::pythonStdErr, - []( const QString& message ) - { - cDebug() << "PythonQt ERR>" << message; - } ); - + []( const QString& message ) + { + cDebug() << "PythonQt ERR>" << message; + } + ); } QDir workingDir( m_workingPath ); @@ -137,8 +139,8 @@ PythonQtViewModule::loadSelf() // Construct empty Python module with the given name PythonQtObjectPtr cxt = - PythonQt::self()-> - createModuleFromScript( name() ); + PythonQt::self()-> + createModuleFromScript( name() ); if ( cxt.isNull() ) { cDebug() << "Cannot load PythonQt context from file" @@ -149,11 +151,11 @@ PythonQtViewModule::loadSelf() } static const QLatin1Literal calamares_module_annotation( - "_calamares_module_typename = ''\n" - "def calamares_module(viewmodule_type):\n" - " global _calamares_module_typename\n" - " _calamares_module_typename = viewmodule_type.__name__\n" - " return viewmodule_type\n"); + "_calamares_module_typename = ''\n" + "def calamares_module(viewmodule_type):\n" + " global _calamares_module_typename\n" + " _calamares_module_typename = viewmodule_type.__name__\n" + " return viewmodule_type\n" ); // Load in the decorator PythonQt::self()->evalScript( cxt, calamares_module_annotation ); @@ -191,9 +193,7 @@ PythonQtViewModule::initFrom( const QVariantMap& moduleDescriptor ) m_workingPath = directory.absolutePath(); if ( !moduleDescriptor.value( "script" ).toString().isEmpty() ) - { m_scriptFileName = moduleDescriptor.value( "script" ).toString(); - } } PythonQtViewModule::PythonQtViewModule() diff --git a/src/libcalamaresui/modulesystem/PythonQtViewModule.h b/src/libcalamaresui/modulesystem/PythonQtViewModule.h index 327e24269..cc6899599 100644 --- a/src/libcalamaresui/modulesystem/PythonQtViewModule.h +++ b/src/libcalamaresui/modulesystem/PythonQtViewModule.h @@ -22,7 +22,8 @@ #include "UiDllMacro.h" #include "Module.h" -namespace Calamares { +namespace Calamares +{ class ViewStep; diff --git a/src/libcalamaresui/modulesystem/ViewModule.cpp b/src/libcalamaresui/modulesystem/ViewModule.cpp index 492d58fda..473ec6457 100644 --- a/src/libcalamaresui/modulesystem/ViewModule.cpp +++ b/src/libcalamaresui/modulesystem/ViewModule.cpp @@ -27,7 +27,8 @@ #include #include -namespace Calamares { +namespace Calamares +{ Module::Type