Change the naming scheme for class field members

I'm not a fan of Hungarian notation, but C++ kind of needs it with its
implicit `this`. And of all the common options for this, I find
suffixing members with an underscore the least offensive one.
This commit is contained in:
Robbert van der Helm
2022-01-01 21:07:17 +01:00
parent e0ab24e645
commit 0b9a16cf40
169 changed files with 2448 additions and 2405 deletions
@@ -23,7 +23,7 @@
Vst3ComponentHandlerProxyImpl::Vst3ComponentHandlerProxyImpl(
Vst3Bridge& bridge,
Vst3ComponentHandlerProxy::ConstructArgs&& args) noexcept
: Vst3ComponentHandlerProxy(std::move(args)), bridge(bridge) {
: Vst3ComponentHandlerProxy(std::move(args)), bridge_(bridge) {
// The lifecycle of this object is managed together with that of the plugin
// object instance this host context got passed to
}
@@ -32,15 +32,16 @@ tresult PLUGIN_API
Vst3ComponentHandlerProxyImpl::queryInterface(const Steinberg::TUID _iid,
void** obj) {
const tresult result = Vst3ComponentHandlerProxy::queryInterface(_iid, obj);
bridge.logger.log_query_interface("In IComponentHandler::queryInterface()",
result, Steinberg::FUID::fromTUID(_iid));
bridge_.logger_.log_query_interface(
"In IComponentHandler::queryInterface()", result,
Steinberg::FUID::fromTUID(_iid));
return result;
}
tresult PLUGIN_API
Vst3ComponentHandlerProxyImpl::beginEdit(Steinberg::Vst::ParamID id) {
return bridge.send_message(YaComponentHandler::BeginEdit{
return bridge_.send_message(YaComponentHandler::BeginEdit{
.owner_instance_id = owner_instance_id(), .id = id});
}
@@ -51,7 +52,7 @@ tresult PLUGIN_API Vst3ComponentHandlerProxyImpl::performEdit(
// `IEditController::setParamNormalized()` after this `performEdit()`,
// so we need to be able to receive that
// `IEditController::setParamNormalized()` on the same thread.
return bridge.send_mutually_recursive_message(
return bridge_.send_mutually_recursive_message(
YaComponentHandler::PerformEdit{
.owner_instance_id = owner_instance_id(),
.id = id,
@@ -60,26 +61,26 @@ tresult PLUGIN_API Vst3ComponentHandlerProxyImpl::performEdit(
tresult PLUGIN_API
Vst3ComponentHandlerProxyImpl::endEdit(Steinberg::Vst::ParamID id) {
return bridge.send_message(YaComponentHandler::EndEdit{
return bridge_.send_message(YaComponentHandler::EndEdit{
.owner_instance_id = owner_instance_id(), .id = id});
}
tresult PLUGIN_API
Vst3ComponentHandlerProxyImpl::restartComponent(int32 flags) {
return bridge.send_mutually_recursive_message(
return bridge_.send_mutually_recursive_message(
YaComponentHandler::RestartComponent{
.owner_instance_id = owner_instance_id(), .flags = flags});
}
tresult PLUGIN_API Vst3ComponentHandlerProxyImpl::setDirty(TBool state) {
return bridge.send_message(YaComponentHandler2::SetDirty{
return bridge_.send_message(YaComponentHandler2::SetDirty{
.owner_instance_id = owner_instance_id(), .state = state});
}
tresult PLUGIN_API
Vst3ComponentHandlerProxyImpl::requestOpenEditor(Steinberg::FIDString name) {
if (name) {
return bridge.send_message(YaComponentHandler2::RequestOpenEditor{
return bridge_.send_message(YaComponentHandler2::RequestOpenEditor{
.owner_instance_id = owner_instance_id(), .name = name});
} else {
std::cerr << "WARNING: Null pointer passed to "
@@ -90,12 +91,12 @@ Vst3ComponentHandlerProxyImpl::requestOpenEditor(Steinberg::FIDString name) {
}
tresult PLUGIN_API Vst3ComponentHandlerProxyImpl::startGroupEdit() {
return bridge.send_message(YaComponentHandler2::StartGroupEdit{
return bridge_.send_message(YaComponentHandler2::StartGroupEdit{
.owner_instance_id = owner_instance_id()});
}
tresult PLUGIN_API Vst3ComponentHandlerProxyImpl::finishGroupEdit() {
return bridge.send_message(YaComponentHandler2::FinishGroupEdit{
return bridge_.send_message(YaComponentHandler2::FinishGroupEdit{
.owner_instance_id = owner_instance_id()});
}
@@ -108,13 +109,13 @@ Vst3ComponentHandlerProxyImpl::createContextMenu(
// parameter being zero' was a typo and that they mean passign a null
// pointer.
CreateContextMenuResponse response =
bridge.send_message(YaComponentHandler3::CreateContextMenu{
bridge_.send_message(YaComponentHandler3::CreateContextMenu{
.owner_instance_id = owner_instance_id(),
.param_id = (paramID ? std::optional(*paramID) : std::nullopt)});
if (response.context_menu_args) {
return new Vst3ContextMenuProxyImpl(
bridge, std::move(*response.context_menu_args));
bridge_, std::move(*response.context_menu_args));
} else {
return nullptr;
}
@@ -125,7 +126,7 @@ tresult PLUGIN_API Vst3ComponentHandlerProxyImpl::requestBusActivation(
Steinberg::Vst::BusDirection dir,
int32 index,
TBool state) {
return bridge.send_message(
return bridge_.send_message(
YaComponentHandlerBusActivation::RequestBusActivation{
.owner_instance_id = owner_instance_id(),
.type = type,
@@ -138,7 +139,7 @@ tresult PLUGIN_API Vst3ComponentHandlerProxyImpl::start(
ProgressType type,
const Steinberg::tchar* optionalDescription,
ID& outID) {
const StartResponse response = bridge.send_message(YaProgress::Start{
const StartResponse response = bridge_.send_message(YaProgress::Start{
.owner_instance_id = owner_instance_id(),
.type = type,
.optional_description =
@@ -155,20 +156,20 @@ tresult PLUGIN_API Vst3ComponentHandlerProxyImpl::start(
tresult PLUGIN_API
Vst3ComponentHandlerProxyImpl::update(ID id,
Steinberg::Vst::ParamValue normValue) {
return bridge.send_message(
return bridge_.send_message(
YaProgress::Update{.owner_instance_id = owner_instance_id(),
.id = id,
.norm_value = normValue});
}
tresult PLUGIN_API Vst3ComponentHandlerProxyImpl::finish(ID id) {
return bridge.send_message(
return bridge_.send_message(
YaProgress::Finish{.owner_instance_id = owner_instance_id(), .id = id});
}
tresult PLUGIN_API Vst3ComponentHandlerProxyImpl::notifyUnitSelection(
Steinberg::Vst::UnitID unitId) {
return bridge.send_message(YaUnitHandler::NotifyUnitSelection{
return bridge_.send_message(YaUnitHandler::NotifyUnitSelection{
.owner_instance_id = owner_instance_id(), .unit_id = unitId});
}
@@ -178,7 +179,7 @@ tresult PLUGIN_API Vst3ComponentHandlerProxyImpl::notifyProgramListChange(
// NOTE: When a plugin calls this, Ardour will fetch the new program names
// with `IUnitInfo::getProgramName()`. TEOTE requires this to be
// called from the same thread.
return bridge.send_mutually_recursive_message(
return bridge_.send_mutually_recursive_message(
YaUnitHandler::NotifyProgramListChange{
.owner_instance_id = owner_instance_id(),
.list_id = listId,
@@ -186,6 +187,6 @@ tresult PLUGIN_API Vst3ComponentHandlerProxyImpl::notifyProgramListChange(
}
tresult PLUGIN_API Vst3ComponentHandlerProxyImpl::notifyUnitByBusChange() {
return bridge.send_message(YaUnitHandler2::NotifyUnitByBusChange{
return bridge_.send_message(YaUnitHandler2::NotifyUnitByBusChange{
.owner_instance_id = owner_instance_id()});
}
@@ -75,5 +75,5 @@ class Vst3ComponentHandlerProxyImpl : public Vst3ComponentHandlerProxy {
tresult PLUGIN_API notifyUnitByBusChange() override;
private:
Vst3Bridge& bridge;
Vst3Bridge& bridge_;
};
@@ -21,14 +21,15 @@
Vst3ConnectionPointProxyImpl::Vst3ConnectionPointProxyImpl(
Vst3Bridge& bridge,
Vst3ConnectionPointProxy::ConstructArgs&& args) noexcept
: Vst3ConnectionPointProxy(std::move(args)), bridge(bridge) {}
: Vst3ConnectionPointProxy(std::move(args)), bridge_(bridge) {}
tresult PLUGIN_API
Vst3ConnectionPointProxyImpl::queryInterface(const Steinberg::TUID _iid,
void** obj) {
const tresult result = Vst3ConnectionPointProxy::queryInterface(_iid, obj);
bridge.logger.log_query_interface("In IConnectionPoint::queryInterface()",
result, Steinberg::FUID::fromTUID(_iid));
bridge_.logger_.log_query_interface("In IConnectionPoint::queryInterface()",
result,
Steinberg::FUID::fromTUID(_iid));
return result;
}
@@ -56,7 +57,7 @@ Vst3ConnectionPointProxyImpl::notify(Steinberg::Vst::IMessage* message) {
// need to use our mutual recursion mechanism. Luckily only Ardour uses
// connection proxies, so if this ends up breaking something it will
// only affect Ardour.
return bridge.send_mutually_recursive_message(
return bridge_.send_mutually_recursive_message(
YaConnectionPoint::Notify{.instance_id = owner_instance_id(),
.message_ptr = YaMessagePtr(*message)});
} else {
@@ -37,5 +37,5 @@ class Vst3ConnectionPointProxyImpl : public Vst3ConnectionPointProxy {
tresult PLUGIN_API notify(Steinberg::Vst::IMessage* message) override;
private:
Vst3Bridge& bridge;
Vst3Bridge& bridge_;
};
@@ -21,7 +21,7 @@
Vst3ContextMenuProxyImpl::Vst3ContextMenuProxyImpl(
Vst3Bridge& bridge,
Vst3ContextMenuProxy::ConstructArgs&& args) noexcept
: Vst3ContextMenuProxy(std::move(args)), bridge(bridge) {
: Vst3ContextMenuProxy(std::move(args)), bridge_(bridge) {
bridge.register_context_menu(*this);
}
@@ -31,24 +31,25 @@ Vst3ContextMenuProxyImpl::~Vst3ContextMenuProxyImpl() noexcept {
// NOTE: This can actually throw (e.g. out of memory or the socket got
// closed). But if that were to happen, then we wouldn't be able to
// recover from it anyways.
bridge.send_message(
bridge_.send_message(
Vst3ContextMenuProxy::Destruct{.owner_instance_id = owner_instance_id(),
.context_menu_id = context_menu_id()});
bridge.unregister_context_menu(*this);
bridge_.unregister_context_menu(*this);
}
tresult PLUGIN_API
Vst3ContextMenuProxyImpl::queryInterface(const Steinberg::TUID _iid,
void** obj) {
const tresult result = Vst3ContextMenuProxy::queryInterface(_iid, obj);
bridge.logger.log_query_interface("In IContextMenu::queryInterface()",
result, Steinberg::FUID::fromTUID(_iid));
bridge_.logger_.log_query_interface("In IContextMenu::queryInterface()",
result,
Steinberg::FUID::fromTUID(_iid));
return result;
}
int32 PLUGIN_API Vst3ContextMenuProxyImpl::getItemCount() {
return bridge.send_message(
return bridge_.send_message(
YaContextMenu::GetItemCount{.owner_instance_id = owner_instance_id(),
.context_menu_id = context_menu_id()});
}
@@ -60,11 +61,11 @@ tresult PLUGIN_API Vst3ContextMenuProxyImpl::getItem(
// XXX: Should the plugin be able to get targets created by the host this
// way? We'll just assume that this function won't ever be called by
// the plugin (but we'll implement a basic version anyways).
if (index < 0 || index >= static_cast<int32>(items.size())) {
if (index < 0 || index >= static_cast<int32>(items_.size())) {
return Steinberg::kInvalidArgument;
} else {
item = items[index];
*target = context_menu_targets[item.tag];
item = items_[index];
*target = context_menu_targets_[item.tag];
return Steinberg::kResultOk;
}
@@ -75,7 +76,7 @@ Vst3ContextMenuProxyImpl::addItem(const Steinberg::Vst::IContextMenuItem& item,
Steinberg::Vst::IContextMenuTarget* target) {
// TODO: I haven't come across a plugin that adds its own items, so this
// hasn't been tested yet
const tresult result = bridge.send_message(YaContextMenu::AddItem{
const tresult result = bridge_.send_message(YaContextMenu::AddItem{
.owner_instance_id = owner_instance_id(),
.context_menu_id = context_menu_id(),
.item = item,
@@ -85,8 +86,8 @@ Vst3ContextMenuProxyImpl::addItem(const Steinberg::Vst::IContextMenuItem& item,
: std::nullopt)});
if (result == Steinberg::kResultOk) {
items.push_back(item);
context_menu_targets[item.tag] = target;
items_.push_back(item);
context_menu_targets_[item.tag] = target;
}
return result;
@@ -95,21 +96,21 @@ Vst3ContextMenuProxyImpl::addItem(const Steinberg::Vst::IContextMenuItem& item,
tresult PLUGIN_API Vst3ContextMenuProxyImpl::removeItem(
const Steinberg::Vst::IContextMenuItem& item,
Steinberg::Vst::IContextMenuTarget* /*target*/) {
const tresult result = bridge.send_message(
const tresult result = bridge_.send_message(
YaContextMenu::RemoveItem{.owner_instance_id = owner_instance_id(),
.context_menu_id = context_menu_id(),
.item = item});
if (result == Steinberg::kResultOk) {
items.erase(
items_.erase(
std::remove_if(
items.begin(), items.end(),
items_.begin(), items_.end(),
[&](const Steinberg::Vst::IContextMenuItem& candidate_item) {
// They didn't implement `operator==` on the struct
return candidate_item.tag == item.tag;
}),
items.end());
context_menu_targets.erase(item.tag);
items_.end());
context_menu_targets_.erase(item.tag);
}
return result;
@@ -120,7 +121,7 @@ tresult PLUGIN_API Vst3ContextMenuProxyImpl::popup(Steinberg::UCoord x,
// NOTE: This requires mutual recursion, because REAPER will call
// `getState()` whle the context menu is open, and `getState()` also
// has to be handled from the GUi thread
return bridge.send_mutually_recursive_message(
return bridge_.send_mutually_recursive_message(
YaContextMenu::Popup{.owner_instance_id = owner_instance_id(),
.context_menu_id = context_menu_id(),
.x = x,
@@ -57,14 +57,14 @@ class Vst3ContextMenuProxyImpl : public Vst3ContextMenuProxy {
*/
std::unordered_map<int32,
Steinberg::IPtr<Steinberg::Vst::IContextMenuTarget>>
context_menu_targets;
context_menu_targets_;
private:
Vst3Bridge& bridge;
Vst3Bridge& bridge_;
/**
* The items passed when to `addItem` calls made by the plugin. This way we
* can call these same targets later.
*/
std::vector<Steinberg::Vst::IContextMenuItem> items;
std::vector<Steinberg::Vst::IContextMenuItem> items_;
};
@@ -24,7 +24,7 @@
Vst3HostContextProxyImpl::Vst3HostContextProxyImpl(
Vst3Bridge& bridge,
Vst3HostContextProxy::ConstructArgs&& args) noexcept
: Vst3HostContextProxy(std::move(args)), bridge(bridge) {
: Vst3HostContextProxy(std::move(args)), bridge_(bridge) {
// The lifecycle of this object is managed together with that of the plugin
// object instance this host context got passed to
}
@@ -33,8 +33,8 @@ tresult PLUGIN_API
Vst3HostContextProxyImpl::queryInterface(const Steinberg::TUID _iid,
void** obj) {
const tresult result = Vst3HostContextProxy::queryInterface(_iid, obj);
bridge.logger.log_query_interface("In FUnknown::queryInterface()", result,
Steinberg::FUID::fromTUID(_iid));
bridge_.logger_.log_query_interface("In FUnknown::queryInterface()", result,
Steinberg::FUID::fromTUID(_iid));
return result;
}
@@ -43,7 +43,7 @@ tresult PLUGIN_API
Vst3HostContextProxyImpl::getName(Steinberg::Vst::String128 name) {
if (name) {
const GetNameResponse response =
bridge.send_message(YaHostApplication::GetName{
bridge_.send_message(YaHostApplication::GetName{
.owner_instance_id = owner_instance_id()});
std::copy(response.name.begin(), response.name.end(), name);
@@ -51,7 +51,7 @@ Vst3HostContextProxyImpl::getName(Steinberg::Vst::String128 name) {
return response.result;
} else {
bridge.logger.log(
bridge_.logger_.log(
"WARNING: Null pointer passed to 'IHostApplication::getName()'");
return Steinberg::kInvalidArgument;
}
@@ -86,8 +86,8 @@ Vst3HostContextProxyImpl::createInstance(Steinberg::TUID /*cid*/,
}
const Steinberg::FUID uid = Steinberg::FUID::fromTUID(_iid);
bridge.logger.log_query_interface("In IHostApplication::createInstance()",
response, uid);
bridge_.logger_.log_query_interface("In IHostApplication::createInstance()",
response, uid);
return response;
}
@@ -95,12 +95,12 @@ Vst3HostContextProxyImpl::createInstance(Steinberg::TUID /*cid*/,
tresult PLUGIN_API
Vst3HostContextProxyImpl::isPlugInterfaceSupported(const Steinberg::TUID _iid) {
if (_iid) {
return bridge.send_message(
return bridge_.send_message(
YaPlugInterfaceSupport::IsPlugInterfaceSupported{
.owner_instance_id = owner_instance_id(),
.iid = *reinterpret_cast<const Steinberg::TUID*>(&_iid)});
} else {
bridge.logger.log(
bridge_.logger_.log(
"WARNING: Null pointer passed to "
"'IPlugInterfaceSupport::isPlugInterfaceSupported()'");
return Steinberg::kInvalidArgument;
@@ -42,5 +42,5 @@ class Vst3HostContextProxyImpl : public Vst3HostContextProxy {
isPlugInterfaceSupported(const Steinberg::TUID _iid) override;
private:
Vst3Bridge& bridge;
Vst3Bridge& bridge_;
};
@@ -21,7 +21,7 @@
Vst3PlugFrameProxyImpl::Vst3PlugFrameProxyImpl(
Vst3Bridge& bridge,
Vst3PlugFrameProxy::ConstructArgs&& args) noexcept
: Vst3PlugFrameProxy(std::move(args)), bridge(bridge) {
: Vst3PlugFrameProxy(std::move(args)), bridge_(bridge) {
// The lifecycle of this object is managed together with that of the plugin
// object instance this host context got passed to
}
@@ -29,8 +29,9 @@ Vst3PlugFrameProxyImpl::Vst3PlugFrameProxyImpl(
tresult PLUGIN_API
Vst3PlugFrameProxyImpl::queryInterface(const Steinberg::TUID _iid, void** obj) {
const tresult result = Vst3PlugFrameProxy::queryInterface(_iid, obj);
bridge.logger.log_query_interface("In IPlugFrame::queryInterface()", result,
Steinberg::FUID::fromTUID(_iid));
bridge_.logger_.log_query_interface("In IPlugFrame::queryInterface()",
result,
Steinberg::FUID::fromTUID(_iid));
return result;
}
@@ -46,12 +47,12 @@ Vst3PlugFrameProxyImpl::resizeView(Steinberg::IPlugView* /*view*/,
// Resize the editor wrapper window in advance. We will do another
// resize automatically on `IPlugView::onSize()`, but this should make
// resizes look a bit smoother.
bridge.maybe_resize_editor(owner_instance_id(), *newSize);
bridge_.maybe_resize_editor(owner_instance_id(), *newSize);
// We have to use this special sending function here so we can handle
// calls to `IPlugView::onSize()` from this same thread (the UI thread).
// See the docstring for more information.
return bridge.send_mutually_recursive_message(YaPlugFrame::ResizeView{
return bridge_.send_mutually_recursive_message(YaPlugFrame::ResizeView{
.owner_instance_id = owner_instance_id(), .new_size = *newSize});
} else {
std::cerr
@@ -35,5 +35,5 @@ class Vst3PlugFrameProxyImpl : public Vst3PlugFrameProxy {
Steinberg::ViewRect* newSize) override;
private:
Vst3Bridge& bridge;
Vst3Bridge& bridge_;
};