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

Provide aliases to function "long names". #258

Merged
merged 2 commits into from
Jul 1, 2023
Merged

Provide aliases to function "long names". #258

merged 2 commits into from
Jul 1, 2023

Conversation

cjordan
Copy link
Collaborator

@cjordan cjordan commented Jul 1, 2023

Hi @simonrw, I hope this finds you well.

I have a (hopefully) simple PR here. I copy+pasted the longnam.h file already in the repo and ran a macro over it, which allows fitsio-sys users to use the "long names" of the fitsio functions. I quickly tested on another local repo and it appears to work. Not sure what's up with ffourl, but I'd consider that function a pretty esoteric one.

Let me know what you think, cheers.

@coveralls
Copy link

coveralls commented Jul 1, 2023

Coverage Status

coverage: 76.716%. remained the same when pulling 384fea6 on aliases into 26901ac on main.

@simonrw
Copy link
Owner

simonrw commented Jul 1, 2023

Hi, thanks for adding this. I'm not sure I agree with this code being in this crate - this crate is meant to be a minimal ffi wrapper of the original c lib, with "value-adds" in fitsio, but I do realise that fitsio-sys is a pain to work with as it is. As such I'd like to merge this PR as it clearly adds value 🎉

Would it be possible to crate a follow-on PR that provides a means to autogenerate this file, that we can integrate into the build.rs system? I would like this crate to be 100% autogeneratable from the C source code.

@simonrw simonrw merged commit c3d02a7 into main Jul 1, 2023
@simonrw simonrw deleted the aliases branch July 1, 2023 10:25
@cjordan
Copy link
Collaborator Author

cjordan commented Jul 3, 2023

Thanks for merging. I'm thinking about how to generate that file automatically; I think I have a solution, but I'll need some "idle time" to try it out.

This was referenced Jul 22, 2024
simonrw added a commit that referenced this pull request Jul 26, 2024
## 🤖 New release
* `fitsio`: 0.21.2 -> 0.21.3
* `fitsio-sys`: 0.5.2 -> 0.5.3
* `fitsio-derive`: 0.2.0 -> 0.2.1

<details><summary><i><b>Changelog</b></i></summary><p>

## `fitsio`
<blockquote>

##
[0.21.3](fitsio-v0.21.2...fitsio-v0.21.3)
- 2024-07-26

### Added
- POC header comment API design
([#332](#332))

### Other
- Add TSHORT types for i16 and u16
- Add clippy feature
- Merge branch 'main' into main
- Pin minimal serde version
- Update criterion requirement from 0.3.5 to 0.5.1 in /fitsio
- Fix nightly compile errors
- Use TBYTE for *8 reads
([#277](#277))
- Allow/fix warnings that are blocking CI
</blockquote>

## `fitsio-sys`
<blockquote>

##
[0.5.3](fitsio-sys-v0.5.2...fitsio-sys-v0.5.3)
- 2024-07-26

### Other
- Fix clippy warnings
- Update bindgen requirement from 0.66 to 0.69 in /fitsio-sys
- Include new changelog for fitsio-sys
- Provide aliases to function "long names".
- Update bindgen requirement from 0.63 to 0.66 in /fitsio-sys
### Added

* Added aliases for cfitsio short names
([#258](#258))

### Changed
### Removed
</blockquote>

## `fitsio-derive`
<blockquote>

##
[0.2.1](fitsio-derive-v0.2.0...fitsio-derive-v0.2.1)
- 2024-07-26

### Other
- Rename myself
- Specify required patch versions for all deps.
</blockquote>


</p></details>

---
This PR was generated with
[release-plz](https://github.com/MarcoIeni/release-plz/).

---------

Co-authored-by: Simon Walker <s.r.walker101@googlemail.com>
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.

3 participants