microsoft / microsoft/terminal
Investigate include order issue with `InputBuffer`, `readData`
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 105k
- Forks
- 9.6k
- Avg merge
- 3d 17h
- Merged PRs (30d)
- 29
Description
Found in #4213.
I had to fwddecl InputBuffer, because I think there's a include order problem with in InputBuffer.hpp and readData.hpp.
readData.hpp uses InputBuffer in a bunch of places, but doesn't include it first
InputBuffer.hpp includes readData.hpp before it defines InputBuffer
So if you try to
#include ".../host/inputBuffer.hpp"
You'll get a compilation error, because it'll include readData, which will assume InputBuffer is defined, which it isn't yet.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with host/InputBuffer.hpp and readData.hpp, then reproduce the compilation failure from a direct include of InputBuffer.hpp. Check the include order and dependencies between these headers. Done means the direct include compiles without requiring a forward declaration of InputBuffer.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- cli
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100