IOS: Use less ambiguous names for classes #9504
Conversation
|
On an unrelated note, I noticed there were a few device classes that could potentially be marked |
|
Yeah, most of them are in older code. That can be done in a follow-up PR -- this one is already large enough :P |
There was a problem hiding this comment.
Pretty verbose diff, but thats expected on such a change. And it reads nicer I'd say, especially when theres a Device class inside a Device namespace and other Device subclasses using the -Device suffix already...
It feels a bit weird that you left the WFS stuff, but I don't insist on the changes if you had good reason to leave them (plus OH0 threw me off before I noticed we already had a OH0Device as well).
Source/Core/Core/IOS/WFS/WFSI.h
Outdated
| @@ -32,8 +32,6 @@ class ARCUnpacker | |||
| std::vector<u8> m_whole_file; | |||
| }; | |||
|
|
|||
| namespace Device | |||
| { | |||
| class WFSI : public Device | |||
There was a problem hiding this comment.
Do we want to name this one WFSIDevice for consistency?
There was a problem hiding this comment.
Oh whoops, I forgot to rename this. I left the USB classes alone to avoid having everything called a "device" in the USB code (considering we have IOS devices and lots of USB devices there...) For WFS, I don't think there's any particular reason not to use the suffix.
Source/Core/Core/IOS/WFS/WFSSRV.h
Outdated
| @@ -29,8 +29,6 @@ enum | |||
| WFS_FILE_IS_OPENED = -10032, // Cannot perform operation on an opened file. | |||
| }; | |||
|
|
|||
| namespace Device | |||
| { | |||
| class WFSSRV : public Device | |||
There was a problem hiding this comment.
Do we want to name this one WFSSRVDevice for consistency?
Some of the device names can be ambiguous and require fully or partly qualifying the name (e.g. IOS::HLE::FS::) in a somewhat verbose way. Additionally, insufficiently qualified names are prone to breaking. Consider the example of IOS::HLE::FS:: (namespace) and IOS::HLE::Device::FS (class). If we use FS::Foo in a file that doesn't know about the class, everything will work fine. However, as soon as Device::FS is declared via a header include or even just forward declared, that code will cease to compile because FS:: now resolves to Device::FS if FS::Foo was used in the Device namespace. It also leads to having to write IOS::ES:: to access ES types and utilities even for code that is already under the IOS namespace. The fix for this is simple: rename the device classes and give them a "device" suffix in their names if the existing ones may be ambiguous. This makes it clear whether we're referring to the device class or to something else. This is not any longer to type, considering it lets us get rid of the Device namespace, which is now wholly unnecessary. There are no functional changes in this commit. A future commit will fix unnecessarily qualified names.
leoetlino
force-pushed
the
ios-class-name-cleanup
branch
from
db783d1
to
522cb6b
Compare
Some of the device names can be ambiguous and require fully or partly
qualifying the name (e.g. IOS::HLE::FS::) in a somewhat verbose way.
Additionally, insufficiently qualified names are prone to breaking.
Consider the example of IOS::HLE::FS:: (namespace) and
IOS::HLE::Device::FS (class). If we use FS::Foo in a file that doesn't
know about the class, everything will work fine. However, as soon as
Device::FS is declared via a header include or even just forward
declared, that code will cease to compile because FS:: now resolves
to Device::FS if FS::Foo was used in the Device namespace.
It also leads to having to write IOS::ES:: to access ES types and
utilities even for code that is already under the IOS namespace.
The fix for this is simple: rename the device classes and give them
a "device" suffix in their names if the existing ones may be ambiguous.
This makes it clear whether we're referring to the device class or to
something else.
This is not any longer to type, considering it lets us get rid of the
Device namespace, which is now wholly unnecessary.
There are no functional changes in this commit.
A future commit will fix unnecessarily qualified names.