Skip to content

Commit

Permalink
*** Major class name refactoring: Rename Configuration class to `Co…
Browse files Browse the repository at this point in the history 
…nfigFile`. This is to better match documentation term `Configuration File` and match the parent container class named `ConfigManager`.
  • Loading branch information
@end2endzone
end2endzone committed Dec 24, 2023
1 parent fe763c1 commit c128c4c
Show file tree
Hide file tree
Showing 25 changed files with 234 additions and 234 deletions.
6 changes: 3 additions & 3 deletions src/api/sa_cfgmgr.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ using namespace shellanything;

size_t sa_cfgmgr_get_configuration_count()
{
Configuration::ConfigurationPtrList configs = ConfigManager::GetInstance().GetConfigurations();
ConfigFile::ConfigFilePtrList configs = ConfigManager::GetInstance().GetConfigFiles();
size_t count = configs.size();
return count;
}
Expand All @@ -40,10 +40,10 @@ sa_error_t sa_cfgmgr_get_configuration_element(size_t index, sa_configuration_t*
{
if (configuration == NULL)
return SA_ERROR_INVALID_ARGUMENTS;
Configuration::ConfigurationPtrList configs = ConfigManager::GetInstance().GetConfigurations();
ConfigFile::ConfigFilePtrList configs = ConfigManager::GetInstance().GetConfigFiles();
if (configs.empty() || index > (configs.size() - 1))
return SA_ERROR_VALUE_OUT_OF_BOUNDS;
shellanything::Configuration* config_element = configs[index];
shellanything::ConfigFile* config_element = configs[index];
*configuration = AS_TYPE_CONFIGURATION(config_element);
return SA_ERROR_SUCCESS;
}
Expand Down
8 changes: 4 additions & 4 deletions src/api/sa_configuration.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
*********************************************************************************/

#include "shellanything/sa_configuration.h"
#include "Configuration.h"
#include "ConfigFile.h"
#include "sa_private_casting.h"
#include "sa_string_private.h"

Expand All @@ -42,7 +42,7 @@ sa_error_t sa_configuration_load_file_buffer(const char* path, char* error_buffe
return SA_ERROR_INVALID_ARGUMENTS;

std::string tmp_error;
shellanything::Configuration* config = shellanything::Configuration::LoadFile(path, tmp_error);
shellanything::ConfigFile* config = shellanything::ConfigFile::LoadFile(path, tmp_error);

// Check for error
if (config == NULL)
Expand All @@ -62,7 +62,7 @@ sa_error_t sa_configuration_load_file_string(const char* path, sa_string_t* erro
return SA_ERROR_INVALID_ARGUMENTS;

std::string tmp_error;
shellanything::Configuration* config = shellanything::Configuration::LoadFile(path, tmp_error);
shellanything::ConfigFile* config = shellanything::ConfigFile::LoadFile(path, tmp_error);

// Check for error
if (config == NULL)
Expand All @@ -80,7 +80,7 @@ sa_boolean sa_configuration_is_valid_config_file(const char* path)
{
if (path == NULL)
return 0;
bool valid = shellanything::Configuration::IsValidConfigFile(path);
bool valid = shellanything::ConfigFile::IsValidConfigFile(path);
if (valid)
return 1;
return 0;
Expand Down
12 changes: 6 additions & 6 deletions src/api/sa_private_casting.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,19 +92,19 @@ sa_menu_t AS_TYPE_MENU(shellanything::Menu* object)
sa_menu_t my_type; my_type.opaque = (void*)(object); return my_type;
}

const shellanything::Configuration* AS_CLASS_CONFIGURATION(sa_configuration_immutable_t* object)
const shellanything::ConfigFile* AS_CLASS_CONFIGURATION(sa_configuration_immutable_t* object)
{
return (const shellanything::Configuration*)(object->opaque);
return (const shellanything::ConfigFile*)(object->opaque);
}
shellanything::Configuration* AS_CLASS_CONFIGURATION(sa_configuration_t* object)
shellanything::ConfigFile* AS_CLASS_CONFIGURATION(sa_configuration_t* object)
{
return (shellanything::Configuration*)(object->opaque);
return (shellanything::ConfigFile*)(object->opaque);
}
sa_configuration_immutable_t AS_TYPE_CONFIGURATION(const shellanything::Configuration* object)
sa_configuration_immutable_t AS_TYPE_CONFIGURATION(const shellanything::ConfigFile* object)
{
sa_configuration_immutable_t my_type; my_type.opaque = (void*)(object); return my_type;
}
sa_configuration_t AS_TYPE_CONFIGURATION(shellanything::Configuration* object)
sa_configuration_t AS_TYPE_CONFIGURATION(shellanything::ConfigFile* object)
{
sa_configuration_t my_type; my_type.opaque = (void*)(object); return my_type;
}
Expand Down
10 changes: 5 additions & 5 deletions src/api/sa_private_casting.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
#include "SelectionContext.h"
#include "Icon.h"
#include "Menu.h"
#include "Configuration.h"
#include "ConfigFile.h"
#include "Validator.h"
#include "PropertyStore.h"

Expand All @@ -58,10 +58,10 @@ shellanything::Menu* AS_CLASS_MENU(sa_menu_t* object);
sa_menu_immutable_t AS_TYPE_MENU(const shellanything::Menu* object);
sa_menu_t AS_TYPE_MENU(shellanything::Menu* object);

const shellanything::Configuration* AS_CLASS_CONFIGURATION(sa_configuration_immutable_t* object);
shellanything::Configuration* AS_CLASS_CONFIGURATION(sa_configuration_t* object);
sa_configuration_immutable_t AS_TYPE_CONFIGURATION(const shellanything::Configuration* object);
sa_configuration_t AS_TYPE_CONFIGURATION(shellanything::Configuration* object);
const shellanything::ConfigFile* AS_CLASS_CONFIGURATION(sa_configuration_immutable_t* object);
shellanything::ConfigFile* AS_CLASS_CONFIGURATION(sa_configuration_t* object);
sa_configuration_immutable_t AS_TYPE_CONFIGURATION(const shellanything::ConfigFile* object);
sa_configuration_t AS_TYPE_CONFIGURATION(shellanything::ConfigFile* object);

const shellanything::Validator* AS_CLASS_VALIDATOR(sa_validator_immutable_t* object);
shellanything::Validator* AS_CLASS_VALIDATOR(sa_validator_t* object);
Expand Down
4 changes: 2 additions & 2 deletions src/core/CMakeLists.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ set(SHELLANYTHING_CORE_HEADER_FILES ""
${CMAKE_SOURCE_DIR}/src/core/ActionStop.h
${CMAKE_SOURCE_DIR}/src/core/App.h
${CMAKE_SOURCE_DIR}/src/core/BaseAction.h
${CMAKE_SOURCE_DIR}/src/core/Configuration.h
${CMAKE_SOURCE_DIR}/src/core/ConfigFile.h
${CMAKE_SOURCE_DIR}/src/core/ConfigManager.h
${CMAKE_SOURCE_DIR}/src/core/SelectionContext.h
${CMAKE_SOURCE_DIR}/src/core/DefaultSettings.h
Expand Down Expand Up @@ -41,7 +41,7 @@ add_library(sa.core SHARED
ActionStop.cpp
App.cpp
BaseAction.cpp
Configuration.cpp
ConfigFile.cpp
ConfigManager.cpp
SelectionContext.cpp
DefaultSettings.cpp
Expand Down
64 changes: 32 additions & 32 deletions src/core/Configuration.cpp → src/core/ConfigFile.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
* SOFTWARE.
*********************************************************************************/

#include "Configuration.h"
#include "ConfigFile.h"
#include "SelectionContext.h"
#include "ActionProperty.h"
#include "ObjectFactory.h"
Expand All @@ -47,7 +47,7 @@ using namespace tinyxml2;

namespace shellanything
{
static Configuration* gUpdatingConfiguration = NULL;
static ConfigFile* gUpdatingConfigFile = NULL;

std::string GetXmlEncoding(XMLDocument& doc, std::string& error)
{
Expand Down Expand Up @@ -96,28 +96,28 @@ namespace shellanything
return encoding;
}

Configuration::Configuration() :
ConfigFile::ConfigFile() :
mFileModifiedDate(0),
mDefaults(NULL)
{
}

Configuration::~Configuration()
ConfigFile::~ConfigFile()
{
DeleteChildren();
}

Configuration* Configuration::GetUpdatingConfiguration()
ConfigFile* ConfigFile::GetUpdatingConfigFile()
{
return gUpdatingConfiguration;
return gUpdatingConfigFile;
}

void Configuration::SetUpdatingConfiguration(Configuration* configuration)
void ConfigFile::SetUpdatingConfigFile(ConfigFile* config_file)
{
gUpdatingConfiguration = configuration;
gUpdatingConfigFile = config_file;
}

Configuration* Configuration::LoadFile(const std::string& path, std::string& error)
ConfigFile* ConfigFile::LoadFile(const std::string& path, std::string& error)
{
error = "";

Expand Down Expand Up @@ -208,7 +208,7 @@ namespace shellanything
return NULL;
}

Configuration* config = new Configuration();
ConfigFile* config = new ConfigFile();
config->SetFilePath(path);
config->SetFileModifiedDate(file_modified_date);

Expand Down Expand Up @@ -290,7 +290,7 @@ namespace shellanything
return config;
}

bool Configuration::IsValidConfigFile(const std::string& path)
bool ConfigFile::IsValidConfigFile(const std::string& path)
{
std::string file_extension = ra::filesystem::GetFileExtention(path);
file_extension = ra::strings::Uppercase(file_extension);
Expand All @@ -317,29 +317,29 @@ namespace shellanything
return true;
}

const std::string& Configuration::GetFilePath() const
const std::string& ConfigFile::GetFilePath() const
{
return mFilePath;
}

void Configuration::SetFilePath(const std::string& file_path)
void ConfigFile::SetFilePath(const std::string& file_path)
{
mFilePath = file_path;
}

const uint64_t& Configuration::GetFileModifiedDate() const
const uint64_t& ConfigFile::GetFileModifiedDate() const
{
return mFileModifiedDate;
}

void Configuration::SetFileModifiedDate(const uint64_t& file_modified_date)
void ConfigFile::SetFileModifiedDate(const uint64_t& file_modified_date)
{
mFileModifiedDate = file_modified_date;
}

void Configuration::Update(const SelectionContext& context)
void ConfigFile::Update(const SelectionContext& context)
{
SetUpdatingConfiguration(this);
SetUpdatingConfigFile(this);

//run callbacks of each plugins
//for each plugins
Expand All @@ -365,10 +365,10 @@ namespace shellanything
child->Update(context);
}

SetUpdatingConfiguration(NULL);
SetUpdatingConfigFile(NULL);
}

void Configuration::ApplyDefaultSettings()
void ConfigFile::ApplyDefaultSettings()
{
if (mDefaults && mDefaults->GetActions().size() > 0)
{
Expand Down Expand Up @@ -405,7 +405,7 @@ namespace shellanything
}
}

Menu* Configuration::FindMenuByCommandId(const uint32_t& command_id)
Menu* ConfigFile::FindMenuByCommandId(const uint32_t& command_id)
{
//for each child
Menu::MenuPtrList children = GetMenus();
Expand All @@ -420,7 +420,7 @@ namespace shellanything
return NULL;
}

Menu* Configuration::FindMenuByName(const std::string& name, FIND_BY_NAME_FLAGS flags)
Menu* ConfigFile::FindMenuByName(const std::string& name, FIND_BY_NAME_FLAGS flags)
{
//for each child
Menu::MenuPtrList children = GetMenus();
Expand All @@ -435,7 +435,7 @@ namespace shellanything
return NULL;
}

uint32_t Configuration::AssignCommandIds(const uint32_t& first_command_id)
uint32_t ConfigFile::AssignCommandIds(const uint32_t& first_command_id)
{
uint32_t nextCommandId = first_command_id;

Expand All @@ -450,42 +450,42 @@ namespace shellanything
return nextCommandId;
}

void Configuration::AddPlugin(Plugin* plugin)
void ConfigFile::AddPlugin(Plugin* plugin)
{
mPlugins.push_back(plugin);
plugin->SetParentConfiguration(this);
plugin->SetParentConfigFile(this);
}

const Plugin::PluginPtrList& Configuration::GetPlugins() const
const Plugin::PluginPtrList& ConfigFile::GetPlugins() const
{
return mPlugins;
}

Menu::MenuPtrList Configuration::GetMenus()
Menu::MenuPtrList ConfigFile::GetMenus()
{
return mMenus;
}

void Configuration::SetDefaultSettings(DefaultSettings* defaults)
void ConfigFile::SetDefaultSettings(DefaultSettings* defaults)
{
if (mDefaults)
delete mDefaults;

mDefaults = defaults;
}

const DefaultSettings* Configuration::GetDefaultSettings() const
const DefaultSettings* ConfigFile::GetDefaultSettings() const
{
return mDefaults;
}

void Configuration::AddMenu(Menu* menu)
void ConfigFile::AddMenu(Menu* menu)
{
mMenus.push_back(menu);
menu->SetParentConfiguration(this);
menu->SetParentConfigFile(this);
}

void Configuration::DeleteChildren()
void ConfigFile::DeleteChildren()
{
// Delete menus
for (size_t i = 0; i < mMenus.size(); i++)
Expand All @@ -508,7 +508,7 @@ namespace shellanything
mPlugins.clear();
}

void Configuration::DeleteChild(Menu* menu)
void ConfigFile::DeleteChild(Menu* menu)
{
delete menu;
}
Expand Down
Loading

0 comments on commit c128c4c

Please sign in to comment.