Skip to content
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.

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

PTP symbol naming #1037

Merged
merged 12 commits into from
Oct 8, 2024
Merged

PTP symbol naming #1037

merged 12 commits into from
Oct 8, 2024

Conversation

axxel
Copy link
Contributor

@axxel axxel commented Oct 7, 2024

This is a whole bunch of rather trivial renaming patches with the goals to:

  • increase internal consistency
  • increase consistency with specification
  • increase readability

If I didn't screw up, this is only changing names of symbols and fixes whitespace where affected. It does not change the
behavior of the code in any way.

The terms ObjectCompressedSize and ThumbCompressedSize come from the PTP
specification. But I find them to be overly verbose because there is no
other size than this "compressed" size.

Other places like the CameraFileInfoFile struct also use the term "size"
instead of "compressed_size" for the same thing.
There are lots of other symbols like GetDevicePropValue that use the short
version "PropValue" already. Also the variables of this type are also most
often called "propval".
The PTPDeviceInfo struct contains information about the Operations, Events,
DeviceProperties, ImageFormats and CaptureFormats. With 3 of those 5 the
variables contained the additional "Supported" string, which does not add
any discriminating value and only makes for very long and therefore less
readable code lines and it is inconsistent.

Also use the term "DeviceProps" here as well for brevity and consistency.
The "_len"-suffix to denote the length of an array of values is more
readable than the "nrof"-prefix and also used 3 times more often in the
rest of the code base.

Also replace the params->deviceproperties name with params->dpd_cache to
make it clearer what it actually is: an array of cached DevicePropDesc
structs.
... to be consistent with specification and also with the names of
similar symbols in the rest of the code.
camlibs/ptp2/ptp-pack.c Dismissed Show dismissed Hide dismissed
camlibs/ptp2/ptp-pack.c Dismissed Show dismissed Hide dismissed
@msmeissn msmeissn merged commit 0720269 into gphoto:master Oct 8, 2024
5 checks passed
@axxel axxel deleted the ptp-naming branch October 10, 2024 20:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants