starred/terminal
1
0
Fork 0
mirror of https://github.com/microsoft/terminal.git synced 2026-02-04 05:35:20 +00:00
Code Issues 19.0k Packages Projects Releases 20 Wiki Activity

using namespace in header files #1123

New Issue
Closed
opened 2026-01-30 22:17:01 +00:00 by claunia · 12 comments
claunia commented 2026-01-30 22:17:01 +00:00
Owner
Copy Link

Originally created by @dlong11 on GitHub (May 15, 2019).

Currently, the repo has a handful of header files that are including "using namespace ...." . This violates Cpp Core Guideline SF.7

  • src/host/ft_host/precomp.h
  • src/host/globals.h
  • src/host/renderData.hpp
  • src/host/renderFontDefaults.hpp
  • src/host/screenInfo.hpp
  • src/host/selection.hpp

If it is decided to fix these, it might be best to tackle these in separate PRs. My guess is removing these will cause lots of other file modifications.

Originally created by @dlong11 on GitHub (May 15, 2019). Currently, the repo has a handful of header files that are including "using namespace ...." . This violates Cpp Core Guideline [SF.7](http://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#sf7-dont-write-using-namespace-at-global-scope-in-a-header-file) - src/host/ft_host/precomp.h - src/host/globals.h - src/host/renderData.hpp - src/host/renderFontDefaults.hpp - src/host/screenInfo.hpp - src/host/selection.hpp If it is decided to fix these, it might be best to tackle these in separate PRs. My guess is removing these will cause lots of other file modifications.
claunia added the Help WantedProduct-ConhostIssue-BugNeeds-Tag-FixArea-Build labels 2026-01-30 22:17:01 +00:00
claunia commented 2026-01-30 22:17:03 +00:00
Author
Owner
Copy Link

@zadjii-msft commented on GitHub (May 15, 2019):

Summoning @adiviness

@zadjii-msft commented on GitHub (May 15, 2019): Summoning @adiviness
claunia commented 2026-01-30 22:17:04 +00:00
Author
Owner
Copy Link

@adiviness commented on GitHub (May 15, 2019):

Yup, we shouldn't be doing that. These all seem pretty straightforward to fix.

@adiviness commented on GitHub (May 15, 2019): Yup, we shouldn't be doing that. These all seem pretty straightforward to fix.
claunia commented 2026-01-30 22:17:04 +00:00
Author
Owner
Copy Link

@MelulekiDube commented on GitHub (May 17, 2019):

Is anyone working on this,

I feel I wanted to take a shot at it.

@MelulekiDube commented on GitHub (May 17, 2019): Is anyone working on this, I feel I wanted to take a shot at it.
claunia commented 2026-01-30 22:17:05 +00:00
Author
Owner
Copy Link

@DHowett-MSFT commented on GitHub (May 17, 2019):

@MelulekiDube Take a shot at it! Nobody internally has claimed it.

@DHowett-MSFT commented on GitHub (May 17, 2019): @MelulekiDube Take a shot at it! Nobody internally has claimed it.
claunia commented 2026-01-30 22:17:05 +00:00
Author
Owner
Copy Link

@MelulekiDube commented on GitHub (May 17, 2019):

Thanks, @DHowett-MSFT will get working on it.

@MelulekiDube commented on GitHub (May 17, 2019): Thanks, @DHowett-MSFT will get working on it.
claunia commented 2026-01-30 22:17:06 +00:00
Author
Owner
Copy Link

@MelulekiDube commented on GitHub (May 19, 2019):

Hello Anyone,

I wanted to check on something. From the readings that I have done, they suggest limiting the using namespace ..... directive into a particular function that wants to use names from that namespace.

I wanted to check before investing a lot of time doing this if this would be the desired solution. Or should I rather just put the using directives on the top of the .cpp files.

I had already started using the latter suggestion where the using directive is limited into a function or some limited scope.

@MelulekiDube commented on GitHub (May 19, 2019): Hello Anyone, I wanted to check on something. From the readings that I have done, they suggest limiting the ```using namespace .....``` directive into a particular function that wants to use names from that namespace. I wanted to check before investing a lot of time doing this if this would be the desired solution. Or should I rather just put the using directives on the top of the .cpp files. I had already started using the latter suggestion where the ```using``` directive is limited into a function or some limited scope.
claunia commented 2026-01-30 22:17:06 +00:00
Author
Owner
Copy Link

@adiviness commented on GitHub (May 20, 2019):

Using a namespace in a cpp file or in a class declaration or function is fine, but using a namespace in a header is what we want to avoid.

@adiviness commented on GitHub (May 20, 2019): Using a namespace in a cpp file or in a class declaration or function is fine, but using a namespace in a header is what we want to avoid.
claunia commented 2026-01-30 22:17:06 +00:00
Author
Owner
Copy Link

@dlong11 commented on GitHub (May 22, 2019):

@MelulekiDube As @adiviness stated - using namespace in a header is should be avoided. SF.7: Don’t write using namespace at global scope in a header file

It is debatable whether the practice of using namespace in cpp files is a "good" practice. The core guidelines rule here is SF.6: Use using namespace directives for transition, for foundation libraries (such as std), or within a local scope (only) The gray area here is what is a "foundation library".

Some C++ projects prohibit the use of using namespace xxxx in cpp files because this makes all names from a namespace available in the file. If you end up adding a lot of "using namespace" in your cpp file you have a greater chance of running into a name collision. And other potential time-bombs.

After looking at some of the windows terminal code - I think some of the use of using namespace in cpp files could be reduced to using . (instead of bringing in the whole namespace)

I also believe that nested C++ namespaces are completely broken are error-prone. Here is a good rationale for this thinking. This is my personal opinion :)

@dlong11 commented on GitHub (May 22, 2019): @MelulekiDube As @adiviness stated - using namespace in a header is should be avoided. [SF.7: Don’t write using namespace at global scope in a header file](http://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#sf7-dont-write-using-namespace-at-global-scope-in-a-header-file) It is debatable whether the practice of using namespace in cpp files is a "good" practice. The core guidelines rule here is [SF.6: Use using namespace directives for transition, for foundation libraries (such as std), or within a local scope (only) ](http://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#sf6-use-using-namespace-directives-for-transition-for-foundation-libraries-such-as-std-or-within-a-local-scope-only) The gray area here is what is a "foundation library". Some C++ projects prohibit the use of using namespace xxxx in cpp files because this makes all names from a namespace available in the file. If you end up adding a lot of "using namespace" in your cpp file you have a greater chance of running into a name collision. And other potential time-bombs. After looking at some of the windows terminal code - I think some of the use of using namespace in cpp files could be reduced to using <specific object>. (instead of bringing in the whole namespace) I also believe that _nested_ C++ namespaces are completely broken are error-prone. Here is a good [rationale](https://abseil.io/tips/153) for this thinking. This is my personal opinion :)
claunia commented 2026-01-30 22:17:07 +00:00
Author
Owner
Copy Link

@MelulekiDube commented on GitHub (May 22, 2019):

@dlong11 I think I share the same sentiment with you in that some of the files are using only a specific name from the namespace and in this case, we can reduce using namespace with using that particular name. I will just make everything else follow this and ensure that the changes I had already made are consistent with this.

@dlong11 and @adiviness Thanks for the responses.

@MelulekiDube commented on GitHub (May 22, 2019): @dlong11 I think I share the same sentiment with you in that some of the files are using only a specific name from the namespace and in this case, we can reduce ```using namespace``` with using that particular name. I will just make everything else follow this and ensure that the changes I had already made are consistent with this. @dlong11 and @adiviness Thanks for the responses.
claunia commented 2026-01-30 22:17:07 +00:00
Author
Owner
Copy Link

@dlong11 commented on GitHub (May 23, 2019):

@MelulekiDube This issue is just for using namespace in header files. If you plan to fix using namespace in cpp files, you may want to separate this work and log another issue. This way you can get the terminal team's opinion. My comments about using namespace in cpp files where my opinion and you should verify the terminal team agrees.

This may save you some headaches if the team decides the current practice is OK and the cpp changes are not needed. @adiviness Sound right to you?

@dlong11 commented on GitHub (May 23, 2019): @MelulekiDube This issue is just for using namespace in header files. If you plan to fix using namespace in cpp files, you may want to separate this work and log another issue. This way you can get the terminal team's opinion. My comments about using namespace in cpp files where my opinion and you should verify the terminal team agrees. This may save you some headaches if the team decides the current practice is OK and the cpp changes are not needed. @adiviness Sound right to you?
claunia commented 2026-01-30 22:17:07 +00:00
Author
Owner
Copy Link

@MelulekiDube commented on GitHub (May 23, 2019):

@dlong11 I am not fixing using namespaces in the cpp files I was talking about how to add the removed using namespaces from the headerfiles to the actual cpp file. However, for the most part, I ended up following the style that was there already on the cpp files as most already had using namespace directives.

@MelulekiDube commented on GitHub (May 23, 2019): @dlong11 I am not fixing using namespaces in the cpp files I was talking about how to add the removed using namespaces from the headerfiles to the actual cpp file. However, for the most part, I ended up following the style that was there already on the cpp files as most already had using namespace directives.
claunia commented 2026-01-30 22:17:07 +00:00
Author
Owner
Copy Link

@adiviness commented on GitHub (May 23, 2019):

Yes, cleaning up the usage of using in the headers is my understanding here. I'm reviewing the associated PR now, thanks for making these changes @MelulekiDube!

@adiviness commented on GitHub (May 23, 2019): Yes, cleaning up the usage of `using` in the headers is my understanding here. I'm reviewing the associated PR now, thanks for making these changes @MelulekiDube!
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
⛺ Reserved
A11yCO
A11yMAS
A11ySev1
A11ySev2
A11ySev3
A11yTTValidated
A11yUsable
A11yVoiceAccess
A11yWCAG
Area-Accessibility
Area-AtlasEngine
Area-AzureShell
Area-Build
Area-Build
Area-Chat
Area-CmdPal
Area-CodeHealth
Area-Commandline
Area-CookedRead
Area-DefApp
Area-Extensibility
Area-Fonts
Area-GroupPolicy
Area-i18n
Area-Input
Area-Interaction
Area-Interop
Area-Localization
Area-Output
Area-Performance
Area-Portable
Area-Quality
Area-Remoting
Area-Rendering
Area-Schema
Area-Server
Area-Settings
Area-SettingsUI
Area-ShellExtension
Area-ShellExtension
Area-ShellExtension
Area-Suggestions
Area-Suggestions
Area-TerminalConnection
Area-TerminalControl
Area-Theming
Area-UserInterface
Area-VT
Area-Windowing
Area-WPFControl
AutoMerge
Blocking-Ingestion
Culprit-Centennial
Culprit-WinUI
Disability-All
Disability-Blind
Disability-LowVision
Disability-Mobility
External-Blocked-WinUI3
Fixed
Gathering-Data
good first issue
HCL-E+D
HCL-WindowsTerminal
Help Wanted
Impact-Compatibility
Impact-Compliance
Impact-Correctness
Impact-Visual
In-PR
InclusionBacklog
InclusionBacklog-Windows TerminalWin32
InclusionCommitted-202206
Issue-Bug
Issue-Docs
Issue-Feature
Issue-Feature
Issue-Question
Issue-Samples
Issue-Scenario
Issue-Task
Needs-Attention
Needs-Author-Feedback
Needs-Bisect
Needs-Discussion
Needs-Repro
Needs-Tag-Fix
Needs-Tag-Fix
Needs-Triage
No-Recent-Activity
Priority-0
Priority-1
Priority-2
Priority-3
Product-Cmd.exe
Product-Colortool
Product-Colortool
Product-Colortool
Product-Conhost
Product-Conpty
Product-Meta
Product-Powershell
Product-Terminal
Product-WSL
pull-request
Mirrored from GitHub Pull Request
 Resolution-Answered
Resolution-By-Design
Resolution-Duplicate
Resolution-External
Resolution-Fix-Available
Resolution-Fix-Committed
Resolution-No-Repro
Resolution-Won't-Fix
Severity-Blocking
Severity-Crash
Severity-DataLoss
spam
this-will-be-a-breaking-change
Tracking-External
WindowsTerminal_Win32
Work-Item
zAskModeBug
zInbox-Bug
No Label Area-Build Help Wanted Issue-Bug Needs-Tag-Fix Product-Conhost
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
claunia
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/terminal#1123
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?