microsoft/Terminal

Investigate include order issue with `InputBuffer`, `readData`

Open

#4,262 opened on Jan 16, 2020

View on GitHub
 (1 comment) (0 reactions) (0 assignees)C++ (3,212 forks)batch import
Area-CodeHealthHelp WantedIssue-TaskPriority-3Product-Conhost

Repository metrics

Stars
 (35,764 stars)
PR merge metrics
 (Avg merge 27d 19h) (24 merged PRs in 30d)

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

Research direction
Trace the include order between InputBuffer.hpp and readData.hpp to resolve the circular dependency or forward declaration issue.
Tech stack
cpp
Domain
cli
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C++
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65