Skip to content

Document and use the fact that SingletonIndex::SetGlobalInstance always returns true #4162

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thewtex merged 4 commits into from
Sep 5, 2023
Merged

Document and use the fact that SingletonIndex::SetGlobalInstance always returns true #4162

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5c14067
STYLE: Use `insert_or_assign` in SingletonIndex SetGlobalInstancePrivate
N-Dekker Aug 19, 2023
eadc465
STYLE: Let `SetGlobalInstancePrivate` return `void`, instead of `true`
N-Dekker Aug 19, 2023
9da299b
DOC: Document that `SetGlobalInstance` always returns true
N-Dekker Aug 19, 2023
6ec6328
STYLE: Let `Singleton` assume that SetGlobalInstance always returns true
N-Dekker Aug 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 7 additions & 10 deletions Modules/Core/Common/include/itkSingleton.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ class ITKCommon_EXPORT SingletonIndex
}


// returns true if the globalName has not been registered yet.
// Returns true.
//
// It is assumed that the global will remain valid until the start
// of globals being destroyed.
Expand All @@ -70,7 +70,8 @@ class ITKCommon_EXPORT SingletonIndex
std::function<void(void *)> func,
std::function<void()> deleteFunc)
{
return this->SetGlobalInstancePrivate(globalName, global, func, deleteFunc);
this->SetGlobalInstancePrivate(globalName, global, func, deleteFunc);
return true;
}

/** Set/Get the pointer to GlobalSingleton.
Expand All @@ -90,9 +91,9 @@ class ITKCommon_EXPORT SingletonIndex
// work, and could use some type of Holder<T> class for intrinsic types
void *
GetGlobalInstancePrivate(const char * globalName);
// If globalName is already registered than false is return,
// otherwise global is added to the singleton index under globalName
bool

// global is added or set to the singleton index under globalName
void
SetGlobalInstancePrivate(const char * globalName,
void * global,
std::function<void(void *)> func,
Expand All @@ -119,11 +120,7 @@ Singleton(const char * globalName, std::function<void(void *)> func, std::functi
if (instance == nullptr)
{
instance = new T;
if (!SingletonIndex::GetInstance()->SetGlobalInstance<T>(globalName, instance, func, deleteFunc))
{
delete instance;
instance = nullptr;
}
SingletonIndex::GetInstance()->SetGlobalInstance<T>(globalName, instance, func, deleteFunc);
}
return instance;
}
Expand Down
8 changes: 3 additions & 5 deletions Modules/Core/Common/src/itkSingleton.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,17 +96,15 @@ SingletonIndex::GetGlobalInstancePrivate(const char * globalName)
return std::get<0>(it->second);
}

// If globalName is already registered remove it from map,
// If globalName is already registered, set its global as specified,
// otherwise global is added to the singleton index under globalName
bool
void
SingletonIndex::SetGlobalInstancePrivate(const char * globalName,
void * global,
std::function<void(void *)> func,
std::function<void()> deleteFunc)
{
m_GlobalObjects.erase(globalName);
m_GlobalObjects.insert(std::make_pair(globalName, std::make_tuple(global, func, deleteFunc)));
return true;
m_GlobalObjects.insert_or_assign(globalName, std::make_tuple(global, func, deleteFunc));
}

SingletonIndex *
Expand Down