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

[modem]: Use pre-generated command declarations to improve IDE navigation #685

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

david-cermak
Copy link
Collaborator

@david-cermak david-cermak commented Nov 1, 2024

Use generated AT command definitions for IDE navigation

  • Simplifies AT macro definitions
  • Replaces variadic template C++ perfect forwarding with macro based delegation
  • Used pre-generated commands by default
  • Option to use in-place macro evaluation (for esp_modem developers)

Task list

  • Add CI check to test consistency
  • Update docs generation
  • Make config option (for esp-modem developers) to use in-place generic headers
  • Add docs to the generation scripts **/generate/*.inc and to the documentation
    (split the commands into groups -- maybe in a separate PR)

How to review this PR

  • Review changes in components CMakeLists.txt and Kconfig (for adding two options useful for "component developer" vs "component user")
  • Review *.inc files -- primary sources of AT command APIs and helper macros
  • Review **/generate/*.(hpp|cpp) -- generic (templates) of using the AT command prototypes and implemenations
  • Briefly review **/command/*.(hpp|cpp) -- generated output, used in "component user" mode
  • Review generation scripts, github actions

@david-cermak david-cermak self-assigned this Nov 1, 2024
Copy link

@github-advanced-security github-advanced-security bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

clang-tidy found more than 20 potential problems in the proposed changes. Check the Files changed tab for more details.

@david-cermak david-cermak marked this pull request as ready for review November 6, 2024 16:42
@david-cermak david-cermak force-pushed the fix/modem_generate_code branch 9 times, most recently from a024fda to 09506d0 Compare November 7, 2024 06:06
@david-cermak david-cermak force-pushed the fix/modem_generate_code branch from 09506d0 to 3d328f7 Compare November 7, 2024 07:31
@david-cermak david-cermak changed the title [modem]: Use pre-generated header to improve IDE naviagion [modem]: Use pre-generated header to improve IDE navigation Nov 7, 2024
@david-cermak david-cermak changed the title [modem]: Use pre-generated header to improve IDE navigation [modem]: Use pre-generated command declarations to improve IDE navigation Nov 7, 2024
@david-cermak
Copy link
Collaborator Author

  • bump to v2.0.0 after this change (might break someones customization)
  • invite public contributors to review this change

@david-cermak
Copy link
Collaborator Author

@diplfranzhoepfinger PTAL, too.

@diplfranzhoepfinger
Copy link
Contributor

@diplfranzhoepfinger PTAL, too.

Yes. IDE Navigation in Espressif IDE is a nightmare in esp-modem.
I will have a look to this.

Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants