WLED icon indicating copy to clipboard operation
WLED copied to clipboard

WLED_DISABLE_2D does not compile

Open ingDIY opened this issue 6 months ago β€’ 1 comments

the compilation fails with tons of errors if you try to compile using WLED_DISABLE_2D

  • message: enclosing class of constexpr non-static member function 'bool Segment::is2D() const' is not a literal type
  • LineNumber: 766

to reproduce the issue you can Run Build Task with this example environment:

[env:test_2D-on]
extends = env:esp32dev
build_flags = ${env:esp32dev.build_flags}
  -D WLED_MAX_BUTTONS=1
  -D BTNPIN=-1

it will compile, while running this:

[env:test_2D-off]
extends = env:esp32dev
build_flags = ${env:esp32dev.build_flags}
  -D WLED_MAX_BUTTONS=1
  -D BTNPIN=-1
  -D WLED_DISABLE_2D

fails.

Summary by CodeRabbit

  • Refactor
    • Internal improvements to method declarations for better compatibility; no visible impact to end-user functionality.

ingDIY avatar Jun 17 '25 23:06 ingDIY

Walkthrough

The update modifies the Segment class in wled00/FX.h by removing the constexpr qualifier from the is2D() method in configurations where 2D support is disabled. The method remains inline and returns false, with no other functional or structural changes to the code.

Changes

File(s) Change Summary
wled00/FX.h Removed constexpr from Segment::is2D() method when 2D is disabled.

πŸ“œ Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL Plan: Pro

πŸ“₯ Commits

Reviewing files that changed from the base of the PR and between d2d5c423b768001e38f5cb3637bb8d34cf86b046 and 83cd35d9f0a35ab52aa1a1a859680214eee3f189.

πŸ“’ Files selected for processing (1)
  • wled00/FX.h (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (20)
  • GitHub Check: wled_build / Build Environments (esp32s3_4M_qspi)
  • GitHub Check: wled_build / Build Environments (lolin_s2_mini)
  • GitHub Check: wled_build / Build Environments (esp32dev)
  • GitHub Check: wled_build / Build Environments (esp32c3dev)
  • GitHub Check: wled_build / Build Environments (esp32s3dev_16MB_opi)
  • GitHub Check: wled_build / Build Environments (esp01_1m_full_compat)
  • GitHub Check: wled_build / Build Environments (usermods)
  • GitHub Check: wled_build / Build Environments (esp32_wrover)
  • GitHub Check: wled_build / Build Environments (esp32dev_V4)
  • GitHub Check: wled_build / Build Environments (esp32s3dev_8MB_opi)
  • GitHub Check: wled_build / Build Environments (esp8266_2m_compat)
  • GitHub Check: wled_build / Build Environments (esp01_1m_full)
  • GitHub Check: wled_build / Build Environments (nodemcuv2_compat)
  • GitHub Check: wled_build / Build Environments (nodemcuv2_160)
  • GitHub Check: wled_build / Build Environments (esp32_eth)
  • GitHub Check: wled_build / Build Environments (esp8266_2m_160)
  • GitHub Check: wled_build / Build Environments (esp01_1m_full_160)
  • GitHub Check: wled_build / Build Environments (nodemcuv2)
  • GitHub Check: wled_build / Build Environments (esp8266_2m)
  • GitHub Check: wled_build / Test cdata.js
πŸ”‡ Additional comments (1)
wled00/FX.h (1)

766-766: Correct removal of constexpr; verify no callers depend on it being a constant expression

Dropping constexpr is the right fixβ€”the Segment type is non-literal, so the earlier declaration broke the build under WLED_DISABLE_2D.

Just to be safe, confirm that no if constexpr (...) sites or other constexpr contexts still expect is2D() to be usable at compile time.

#!/bin/bash
# Search for compile-time uses of is2D() that would now fail.
rg -n $'if constexpr\\([^)]*is2D' || true
✨ Finishing Touches
  • [ ] πŸ“ Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❀️ Share
πŸͺ§ Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar Jun 17 '25 23:06 coderabbitai[bot]

confirmed, fix is working. @blazoncek any objections to merging this?

DedeHai avatar Jun 18 '25 16:06 DedeHai

Do we know how common it is for people to use WLED_DISABLE_2D? Should we have a build env to confirm that works as expected? Maybe not actually release that bin, just part of our testing

@blazoncek

netmindz avatar Jun 18 '25 18:06 netmindz

Back in 2022 (when implementing 2D) I wanted to keep binary small to fit OTA on ESP01 with 1M flash. It has grown beyond that even with 2D disabled.

My suggestion is to completely remove WLED_DISABLE_2D conditional compile.

blazoncek avatar Jun 18 '25 20:06 blazoncek

I am all for removing the compile flag. It seems quite a few people are using this flag for some reason. @ingDIY are you using this flag or just something you discovered by accident?

DedeHai avatar Jun 20 '25 07:06 DedeHai

I am all for removing the compile flag. It seems quite a few people are using this flag for some reason. @ingDIY are you using this flag or just something you discovered by accident?

Hello! I am currently using WLED_DISABLE_2D. All my LEDs are running in single strips, 1D only, so I enabled this option just to remove all 2D effects from the list. If you think it's better to remove this flag, it's ok also for me.

ingDIY avatar Jun 20 '25 08:06 ingDIY