Compare commits

...

12 commits

Author SHA1 Message Date
Dustin L. Howett 20250c233d Migrate spelling-0.0.19 changes from main 2020-11-13 13:16:30 -08:00
Michael Niksa 39023426ff safety check on alpha test. 2020-11-13 13:16:30 -08:00
Michael Niksa 9ea43bace0 corrupt the alphas for v1 only 2020-11-13 13:15:13 -08:00
Michael Niksa 2b9f6388cf Add theoretical v2 tests too. 2020-11-13 13:12:28 -08:00
Michael Niksa c340ab5e7b holy v1 tests, batman 2020-11-13 12:00:41 -08:00
Michael Niksa 42e198e967 so much pain. 2020-11-13 11:40:45 -08:00
Michael Niksa a6816df2b5 add these miserable tests for direct read. 2020-11-11 16:50:52 -08:00
Michael Niksa 3aee3992ba update notes and update read function 2020-11-05 16:41:23 -08:00
Michael Niksa 1b3a5e671b Two more tests that make me sad about chv1 2020-11-05 16:17:01 -08:00
Michael Niksa 18b91c20ef Add some more tests to discover behaviors. 2020-11-05 15:59:53 -08:00
Michael Niksa 3b7544770b Make the font be a differentiator in the test. 2020-11-04 10:36:05 -08:00
Michael Niksa 93b95420ac Alias tests. 2020-11-04 10:36:05 -08:00
36 changed files with 1659 additions and 480913 deletions

View file

@ -1,25 +0,0 @@
<details>
<summary>
:pencil2: Contributor please read this
</summary>
By default the command suggestion will generate a file named based on your commit. That's generally ok as long as you add the file to your commit. Someone can reorganize it later.
:warning: The command is written for posix shells. You can copy the contents of each `perl` command excluding the outer `'` marks and dropping any `'"`/`"'` quotation mark pairs into a file and then run `perl file.pl` from the root of the repository to run the code. Alternatively, you can manually insert the items...
If the listed items are:
* ... **misspelled**, then please *correct* them instead of using the command.
* ... *names*, please add them to `.github/actions/spell-check/dictionary/names.txt`.
* ... APIs, you can add them to a file in `.github/actions/spell-check/dictionary/`.
* ... just things you're using, please add them to an appropriate file in `.github/actions/spell-check/expect/`.
* ... tokens you only need in one place and shouldn't *generally be used*, you can add an item in an appropriate file in `.github/actions/spell-check/patterns/`.
See the `README.md` in each directory for more information.
:microscope: You can test your commits **without** *appending* to a PR by creating a new branch with that extra change and pushing it to your fork. The [:check-spelling](https://github.com/marketplace/actions/check-spelling) action will run in response to your **push** -- it doesn't require an open pull request. By using such a branch, you can limit the number of typos your peers see you make. :wink:
</details>
#### :warning: Reviewers
At present, the action that triggered this message will not show its :x: in this PR unless the branch is within this repository.
Thus, you **should** make sure that this comment has been addressed before encouraging the merge bot to merge this PR.

View file

@ -1,69 +0,0 @@
ACCEPTFILES
ACCESSDENIED
alignof
bitfield
bitfields
CLASSNOTAVAILABLE
COLORPROPERTY
CXICON
CYICON
environstrings
EXPCMDFLAGS
EXPCMDSTATE
fullkbd
futex
GETDESKWALLPAPER
GETHIGHCONTRAST
Hashtable
HIGHCONTRASTON
HIGHCONTRASTW
href
IAsync
IBind
IBox
IClass
IComparable
ICustom
IDialog
IDirect
IExplorer
IInheritable
IMap
IObject
IStorage
LCID
llabs
lround
LSHIFT
NCHITTEST
NCLBUTTONDBLCLK
NCRBUTTONDBLCLK
NOAGGREGATION
NOREDIRECTIONBITMAP
oaidl
ocidl
otms
OUTLINETEXTMETRICW
PAGESCROLL
RETURNCMD
rfind
roundf
RSHIFT
rx
serializer
SIZENS
spsc
sregex
STDCPP
strchr
syscall
THEMECHANGED
tmp
tx
UPDATEINIFILE
userenv
wcstoui
wsregex
XDocument
XElement
XParse

View file

@ -1,782 +0,0 @@
snow
ghost-white
ghostwhite
white-smoke
whitesmoke
gainsboro
floral-white
floralwhite
old-lace
oldlace
linen
antique-white
antiquewhite
papaya-whip
papayawhip
blanched-almond
blanchedalmond
bisque
peach-puff
peachpuff
navajo-white
navajowhite
moccasin
cornsilk
ivory
lemon-chiffon
lemonchiffon
seashell
honeydew
mint-cream
mintcream
azure
alice-blue
aliceblue
lavender
lavender-blush
lavenderblush
misty-rose
mistyrose
white
black
dark-slate-gray
darkslategray
dark-slate-grey
darkslategrey
dim-gray
dimgray
dim-grey
dimgrey
slate-gray
slategray
slate-grey
slategrey
light-slate-gray
lightslategray
light-slate-grey
lightslategrey
gray
grey
xray
x11gray
xrey
x11grey
web-gray
webgray
web-grey
webgrey
light-grey
lightgrey
light-gray
lightgray
midnight-blue
midnightblue
navy
navy-blue
navyblue
cornflower-blue
cornflowerblue
dark-slate-blue
darkslateblue
slate-blue
slateblue
medium-slate-blue
mediumslateblue
light-slate-blue
lightslateblue
medium-blue
mediumblue
royal-blue
royalblue
blue
dodger-blue
dodgerblue
deep-sky-blue
deepskyblue
sky-blue
skyblue
light-sky-blue
lightskyblue
steel-blue
steelblue
light-steel-blue
lightsteelblue
light-blue
lightblue
powder-blue
powderblue
pale-turquoise
paleturquoise
dark-turquoise
darkturquoise
medium-turquoise
mediumturquoise
turquoise
cyan
aqua
light-cyan
lightcyan
cadet-blue
cadetblue
medium-aquamarine
mediumaquamarine
aquamarine
dark-green
darkgreen
dark-olive-green
darkolivegreen
dark-sea-green
darkseagreen
sea-green
seagreen
medium-sea-green
mediumseagreen
light-sea-green
lightseagreen
pale-green
palegreen
spring-green
springgreen
lawn-green
lawngreen
green
lime
xreen
x11green
web-green
webgreen
chartreuse
medium-spring-green
mediumspringgreen
green-yellow
greenyellow
lime-green
limegreen
yellow-green
yellowgreen
forest-green
forestgreen
olive-drab
olivedrab
dark-khaki
darkkhaki
khaki
pale-goldenrod
palegoldenrod
light-goldenrod-yellow
lightgoldenrodyellow
light-yellow
lightyellow
yellow
gold
light-goldenrod
lightgoldenrod
goldenrod
dark-goldenrod
darkgoldenrod
rosy-brown
rosybrown
indian-red
indianred
saddle-brown
saddlebrown
sienna
peru
burlywood
beige
wheat
sandy-brown
sandybrown
tan
chocolate
firebrick
brown
dark-salmon
darksalmon
salmon
light-salmon
lightsalmon
orange
dark-orange
darkorange
coral
light-coral
lightcoral
tomato
orange-red
orangered
red
hot-pink
hotpink
deep-pink
deeppink
pink
light-pink
lightpink
pale-violet-red
palevioletred
maroon
xaroon
x11maroon
web-maroon
webmaroon
medium-violet-red
mediumvioletred
violet-red
violetred
magenta
fuchsia
violet
plum
orchid
medium-orchid
mediumorchid
dark-orchid
darkorchid
dark-violet
darkviolet
blue-violet
blueviolet
purple
xurple
x11purple
web-purple
webpurple
medium-purple
mediumpurple
thistle
snow1
snow2
snow3
snow4
seashell1
seashell2
seashell3
seashell4
antiquewhite1
antiquewhite2
antiquewhite3
antiquewhite4
bisque1
bisque2
bisque3
bisque4
peachpuff1
peachpuff2
peachpuff3
peachpuff4
navajowhite1
navajowhite2
navajowhite3
navajowhite4
lemonchiffon1
lemonchiffon2
lemonchiffon3
lemonchiffon4
cornsilk1
cornsilk2
cornsilk3
cornsilk4
ivory1
ivory2
ivory3
ivory4
honeydew1
honeydew2
honeydew3
honeydew4
lavenderblush1
lavenderblush2
lavenderblush3
lavenderblush4
mistyrose1
mistyrose2
mistyrose3
mistyrose4
azure1
azure2
azure3
azure4
slateblue1
slateblue2
slateblue3
slateblue4
royalblue1
royalblue2
royalblue3
royalblue4
blue1
blue2
blue3
blue4
dodgerblue1
dodgerblue2
dodgerblue3
dodgerblue4
steelblue1
steelblue2
steelblue3
steelblue4
deepskyblue1
deepskyblue2
deepskyblue3
deepskyblue4
skyblue1
skyblue2
skyblue3
skyblue4
lightskyblue1
lightskyblue2
lightskyblue3
lightskyblue4
slategray1
slategray2
slategray3
slategray4
lightsteelblue1
lightsteelblue2
lightsteelblue3
lightsteelblue4
lightblue1
lightblue2
lightblue3
lightblue4
lightcyan1
lightcyan2
lightcyan3
lightcyan4
paleturquoise1
paleturquoise2
paleturquoise3
paleturquoise4
cadetblue1
cadetblue2
cadetblue3
cadetblue4
turquoise1
turquoise2
turquoise3
turquoise4
cyan1
cyan2
cyan3
cyan4
darkslategray1
darkslategray2
darkslategray3
darkslategray4
aquamarine1
aquamarine2
aquamarine3
aquamarine4
darkseagreen1
darkseagreen2
darkseagreen3
darkseagreen4
seagreen1
seagreen2
seagreen3
seagreen4
palegreen1
palegreen2
palegreen3
palegreen4
springgreen1
springgreen2
springgreen3
springgreen4
green1
green2
green3
green4
chartreuse1
chartreuse2
chartreuse3
chartreuse4
olivedrab1
olivedrab2
olivedrab3
olivedrab4
darkolivegreen1
darkolivegreen2
darkolivegreen3
darkolivegreen4
khaki1
khaki2
khaki3
khaki4
lightgoldenrod1
lightgoldenrod2
lightgoldenrod3
lightgoldenrod4
lightyellow1
lightyellow2
lightyellow3
lightyellow4
yellow1
yellow2
yellow3
yellow4
gold1
gold2
gold3
gold4
goldenrod1
goldenrod2
goldenrod3
goldenrod4
darkgoldenrod1
darkgoldenrod2
darkgoldenrod3
darkgoldenrod4
rosybrown1
rosybrown2
rosybrown3
rosybrown4
indianred1
indianred2
indianred3
indianred4
sienna1
sienna2
sienna3
sienna4
burlywood1
burlywood2
burlywood3
burlywood4
wheat1
wheat2
wheat3
wheat4
tan1
tan2
tan3
tan4
chocolate1
chocolate2
chocolate3
chocolate4
firebrick1
firebrick2
firebrick3
firebrick4
brown1
brown2
brown3
brown4
salmon1
salmon2
salmon3
salmon4
lightsalmon1
lightsalmon2
lightsalmon3
lightsalmon4
orange1
orange2
orange3
orange4
darkorange1
darkorange2
darkorange3
darkorange4
coral1
coral2
coral3
coral4
tomato1
tomato2
tomato3
tomato4
orangered1
orangered2
orangered3
orangered4
red1
red2
red3
red4
deeppink1
deeppink2
deeppink3
deeppink4
hotpink1
hotpink2
hotpink3
hotpink4
pink1
pink2
pink3
pink4
lightpink1
lightpink2
lightpink3
lightpink4
palevioletred1
palevioletred2
palevioletred3
palevioletred4
maroon1
maroon2
maroon3
maroon4
violetred1
violetred2
violetred3
violetred4
magenta1
magenta2
magenta3
magenta4
orchid1
orchid2
orchid3
orchid4
plum1
plum2
plum3
plum4
mediumorchid1
mediumorchid2
mediumorchid3
mediumorchid4
darkorchid1
darkorchid2
darkorchid3
darkorchid4
purple1
purple2
purple3
purple4
mediumpurple1
mediumpurple2
mediumpurple3
mediumpurple4
thistle1
thistle2
thistle3
thistle4
gray0
grey0
gray1
grey1
gray2
grey2
gray3
grey3
gray4
grey4
gray5
grey5
gray6
grey6
gray7
grey7
gray8
grey8
gray9
grey9
gray10
grey10
gray11
grey11
gray12
grey12
gray13
grey13
gray14
grey14
gray15
grey15
gray16
grey16
gray17
grey17
gray18
grey18
gray19
grey19
gray20
grey20
gray21
grey21
gray22
grey22
gray23
grey23
gray24
grey24
gray25
grey25
gray26
grey26
gray27
grey27
gray28
grey28
gray29
grey29
gray30
grey30
gray31
grey31
gray32
grey32
gray33
grey33
gray34
grey34
gray35
grey35
gray36
grey36
gray37
grey37
gray38
grey38
gray39
grey39
gray40
grey40
gray41
grey41
gray42
grey42
gray43
grey43
gray44
grey44
gray45
grey45
gray46
grey46
gray47
grey47
gray48
grey48
gray49
grey49
gray50
grey50
gray51
grey51
gray52
grey52
gray53
grey53
gray54
grey54
gray55
grey55
gray56
grey56
gray57
grey57
gray58
grey58
gray59
grey59
gray60
grey60
gray61
grey61
gray62
grey62
gray63
grey63
gray64
grey64
gray65
grey65
gray66
grey66
gray67
grey67
gray68
grey68
gray69
grey69
gray70
grey70
gray71
grey71
gray72
grey72
gray73
grey73
gray74
grey74
gray75
grey75
gray76
grey76
gray77
grey77
gray78
grey78
gray79
grey79
gray80
grey80
gray81
grey81
gray82
grey82
gray83
grey83
gray84
grey84
gray85
grey85
gray86
grey86
gray87
grey87
gray88
grey88
gray89
grey89
gray90
grey90
gray91
grey91
gray92
grey92
gray93
grey93
gray94
grey94
gray95
grey95
gray96
grey96
gray97
grey97
gray98
grey98
gray99
grey99
gray100
grey100
dark-grey
darkgrey
dark-gray
darkgray
dark-blue
darkblue
dark-cyan
darkcyan
dark-magenta
darkmagenta
dark-red
darkred
light-green
lightgreen
crimson
indigo
olive
rebecca-purple
rebeccapurple
silver
teal

File diff suppressed because it is too large Load diff

View file

@ -1,3 +0,0 @@
powf
sqrtf
isnan

View file

@ -1,7 +0,0 @@
autogenerated
CPPCORECHECK
Debian
filepath
inplace
KEYBDINPUT
WINVER

50
.github/actions/spelling/advice.md vendored Normal file
View file

@ -0,0 +1,50 @@
<!-- markdownlint-disable MD033 MD041 -->
<details>
<summary>
:pencil2: Contributor please read this
</summary>
By default the command suggestion will generate a file named based on your commit. That's generally ok as long as you add the file to your commit. Someone can reorganize it later.
:warning: The command is written for posix shells. You can copy the contents of each `perl` command excluding the outer `'` marks and dropping any `'"`/`"'` quotation mark pairs into a file and then run `perl file.pl` from the root of the repository to run the code. Alternatively, you can manually insert the items...
If the listed items are:
* ... **misspelled**, then please *correct* them instead of using the command.
* ... *names*, please add them to `.github/actions/spelling/allow/names.txt`.
* ... APIs, you can add them to a file in `.github/actions/spelling/allow/`.
* ... just things you're using, please add them to an appropriate file in `.github/actions/spelling/expect/`.
* ... tokens you only need in one place and shouldn't *generally be used*, you can add an item in an appropriate file in `.github/actions/spelling/patterns/`.
See the `README.md` in each directory for more information.
:microscope: You can test your commits **without** *appending* to a PR by creating a new branch with that extra change and pushing it to your fork. The [check-spelling](https://github.com/marketplace/actions/check-spelling) action will run in response to your **push** -- it doesn't require an open pull request. By using such a branch, you can limit the number of typos your peers see you make. :wink:
<details><summary>:clamp: If you see a bunch of garbage</summary>
If it relates to a ...
<details><summary>well-formed pattern</summary>
See if there's a [pattern](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns) that would match it.
If not, try writing one and adding it to a `patterns/{file}.txt`.
Patterns are Perl 5 Regular Expressions - you can [test](
https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your lines.
Note that patterns can't match multiline strings.
</details>
<details><summary>binary-ish string</summary>
Please add a file path to the `excludes.txt` file instead of just accepting the garbage.
File paths are Perl 5 Regular Expressions - you can [test](
https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your files.
`^` refers to the file's path from the root of the repository, so `^README\.md$` would exclude [README.md](
../tree/HEAD/README.md) (on whichever branch you're using).
</details>
</details>
</details>

View file

@ -1,6 +1,6 @@
# Dictionaries are lists of words to accept unconditionally
# Allow files are lists of words to accept unconditionally
While check spelling will complain about a whitelisted word
While check spelling will complain about an expected word
which is no longer present, you can include things here even if
they are not otherwise present in the repository.
@ -8,11 +8,11 @@ E.g., you could include a list of system APIs here, or potential
contributors (so that if a future commit includes their name,
it'll be accepted).
### Files
## Files
| File | Description |
| ---- | ----------- |
| [Dictionary](dictionary.txt) | Primary US English dictionary |
| [Allow](allow.txt) | Supplements to the dictionary |
| [Chinese](chinese.txt) | Chinese words |
| [Japanese](japanese.txt) | Japanese words |
| [Microsoft](microsoft.txt) | Microsoft brand items |

View file

@ -0,0 +1,77 @@
apc
calt
ccmp
changelog
cybersecurity
Apc
clickable
clig
copyable
dalet
dcs
Dcs
dialytika
dje
downside
downsides
dze
dzhe
Enum'd
Fitt
formattings
ftp
fvar
geeksforgeeks
ghe
gje
hostname
hostnames
hyperlink
hyperlinking
hyperlinks
img
It'd
kje
liga
lje
locl
lorem
Llast
Lmid
Lorigin
maxed
mkmk
mru
noreply
nje
ogonek
ok'd
overlined
postmodern
ptys
qof
qps
rclt
reimplementation
reserialization
reserialize
reserializes
rlig
runtimes
shcha
slnt
Sos
timestamped
TLDR
tokenizes
tonos
tshe
uiatextrange
UIs
und
unregister
versioned
We'd
wildcards
yeru
zhe

194
.github/actions/spelling/allow/apis.txt vendored Normal file
View file

@ -0,0 +1,194 @@
ACCEPTFILES
ACCESSDENIED
alignas
alignof
APPLYTOSUBMENUS
bitfield
bitfields
BUILDBRANCH
BUILDMSG
BUILDNUMBER
BYPOSITION
charconv
CLASSNOTAVAILABLE
cmdletbinding
COLORPROPERTY
colspan
COMDLG
comparand
cstdint
CXICON
CYICON
dataobject
dcomp
DERR
dlldata
DONTADDTORECENT
DWORDLONG
enumset
environstrings
EXPCMDFLAGS
EXPCMDSTATE
filetime
FILTERSPEC
FORCEFILESYSTEM
FORCEMINIMIZE
frac
fullkbd
futex
GETDESKWALLPAPER
GETHIGHCONTRAST
Hashtable
HIGHCONTRASTON
HIGHCONTRASTW
hotkeys
href
hrgn
IActivation
IApp
IAppearance
IAsync
IBind
IBox
IClass
IComparable
IComparer
IConnection
ICustom
IDialog
IDirect
IExplorer
IFACEMETHOD
IFile
IInheritable
IMap
IObject
iosfwd
IPackage
IPeasant
isspace
ISetup
IStorage
istream
IStringable
ITab
ITaskbar
IUri
IVirtual
KEYSELECT
LCID
llabs
llu
localtime
lround
LSHIFT
MENUCOMMAND
MENUDATA
MENUINFO
memicmp
mptt
mov
msappx
MULTIPLEUSE
NCHITTEST
NCLBUTTONDBLCLK
NCRBUTTONDBLCLK
NIF
NIN
NOAGGREGATION
NOASYNC
NOCHANGEDIR
NOPROGRESS
NOREDIRECTIONBITMAP
NOREPEAT
NOTIFYBYPOS
NOTIFYICON
NOTIFYICONDATA
ntprivapi
oaidl
ocidl
ODR
offsetof
osver
OSVERSIONINFOEXW
otms
OUTLINETEXTMETRICW
overridable
PAGESCROLL
PICKFOLDERS
pmr
rcx
REGCLS
RETURNCMD
rfind
roundf
RSHIFT
schandle
semver
serializer
SETVERSION
SHELLEXECUTEINFOW
shobjidl
SHOWMINIMIZED
SHOWTIP
SINGLEUSE
SIZENS
smoothstep
snprintf
spsc
sregex
SRWLOC
SRWLOCK
STDCPP
STDMETHOD
strchr
strcpy
streambuf
strtoul
Stubless
Subheader
Subpage
syscall
TASKBARCREATED
TBPF
THEMECHANGED
tlg
tmp
tolower
toupper
TTask
TVal
UChar
UPDATEINIFILE
userenv
wcsstr
wcstoui
winmain
wmemcmp
wpc
wsregex
wwinmain
xchg
XDocument
XElement
xfacet
xhash
XIcon
xiosbase
xlocale
xlocbuf
xlocinfo
xlocmes
xlocmon
xlocnum
xloctime
XMax
xmemory
XParse
xpath
xstddef
xstring
xtree
xutility
YIcon
YMax

View file

@ -0,0 +1,117 @@
alice
aliceblue
antiquewhite
blanchedalmond
blueviolet
burlywood
cadetblue
cornflowerblue
cornsilk
cyan
darkblue
darkcyan
darkgoldenrod
darkgray
darkgreen
darkgrey
darkkhaki
darkmagenta
darkolivegreen
darkorange
darkorchid
darkred
darksalmon
darkseagreen
darkslateblue
darkslategray
darkslategrey
darkturquoise
darkviolet
deeppink
deepskyblue
dimgray
dimgrey
dodgerblue
firebrick
floralwhite
forestgreen
gainsboro
ghostwhite
greenyellow
hotpink
indian
indianred
lavenderblush
lawngreen
lemonchiffon
lightblue
lightcoral
lightcyan
lightgoldenrod
lightgoldenrodyellow
lightgray
lightgreen
lightgrey
lightpink
lightsalmon
lightseagreen
lightskyblue
lightslateblue
lightslategray
lightslategrey
lightsteelblue
lightyellow
limegreen
mediumaquamarine
mediumblue
mediumorchid
mediumpurple
mediumseagreen
mediumslateblue
mediumspringgreen
mediumturquoise
mediumvioletred
midnightblue
mintcream
mistyrose
navajo
navajowhite
navyblue
oldlace
olivedrab
orangered
palegoldenrod
palegreen
paleturquoise
palevioletred
papayawhip
peachpuff
peru
powderblue
rebecca
rebeccapurple
rosybrown
royalblue
saddlebrown
sandybrown
seagreen
sienna
skyblue
slateblue
slategray
slategrey
springgreen
steelblue
violetred
webgray
webgreen
webgrey
webmaroon
webpurple
whitesmoke
xaroon
xray
xreen
xrey
xurple
yellowgreen

View file

@ -1,8 +1,10 @@
Consolas
emoji
emojis
Extralight
Gabriola
Iosevka
MDL
Monofur
Segoe
wght

11
.github/actions/spelling/allow/math.txt vendored Normal file
View file

@ -0,0 +1,11 @@
atan
CPrime
HBar
HPrime
isnan
LPrime
LStep
powf
RSub
sqrtf
ULP

View file

@ -1,19 +1,45 @@
ACLs
ADMINS
advapi
altform
altforms
appendwttlogging
appx
appxbundle
appxerror
appxmanifest
ATL
backplating
bitmaps
BOMs
CPLs
cpptools
cppvsdbg
CPRs
cryptbase
DACL
DACLs
diffs
disposables
dotnetfeed
DTDs
DWINRT
enablewttlogging
Intelli
IVisual
LKG
LOCKFILE
Lxss
mfcribbon
microsoft
microsoftonline
MSAA
msixbundle
MSVC
muxc
netcore
osgvsowi
PFILETIME
pgc
pgo
pgosweep
@ -21,20 +47,32 @@ powerrename
powershell
propkey
pscustomobject
QWORD
regedit
robocopy
SACLs
sdkddkver
Shobjidl
Skype
SRW
sxs
Sysinternals
sysnative
systemroot
taskkill
tasklist
tdbuildteamid
unvirtualized
VCRT
vcruntime
Virtualization
visualstudio
vscode
VSTHRD
winsdkver
wlk
wslpath
wtl
wtt
wttlog
Xamarin

View file

@ -12,24 +12,31 @@ ekg
ethanschoonover
Firefox
Gatta
glsl
Gravell
Grie
Griese
Hernan
Howett
Illhardt
iquilezles
jantari
jerrysh
Kaiyu
kimwalisch
KMehrain
KODELIFE
Kodelife
Kourosh
kowalczyk
leonmsft
Lepilleur
lhecker
lukesampson
Manandhar
mbadolato
Mehrain
menger
mgravell
michaelniksa
michkap
@ -43,7 +50,10 @@ nvaccess
nvda
oising
oldnewthing
opengl
osgwiki
pabhojwa
panos
paulcam
pauldotknopf
PGP
@ -51,11 +61,14 @@ Pham
Rincewind
rprichard
Schoonover
shadertoy
Somuah
sonph
sonpham
stakx
thereses
Walisch
Wellons
Wirt
Wojciech
zadjii

View file

@ -1,3 +1,4 @@
(?:(?i)\.png$)
(?:^|/)dirs$
(?:^|/)go\.mod$
(?:^|/)go\.sum$
@ -35,7 +36,6 @@ SUMS$
\.pbxproj$
\.pdf$
\.pem$
\.png$
\.psd$
\.runsettings$
\.sig$
@ -54,11 +54,26 @@ SUMS$
\.zip$
^consolegit2gitfilters\.json$
^dep/
^oss/
^doc/reference/master-sequence-list.csv$
^doc/reference/UTF8-torture-test\.txt$
^oss/
^src/host/ft_uia/run\.bat$
^src/host/runft\.bat$
^src/host/runut\.bat$
^src/interactivity/onecore/BgfxEngine\.
^src/renderer/wddmcon/WddmConRenderer\.
^src/terminal/adapter/ut_adapter/run\.bat$
^src/terminal/parser/delfuzzpayload\.bat$
^src/terminal/parser/ft_fuzzer/run\.bat$
^src/terminal/parser/ft_fuzzer/VTCommandFuzzer\.cpp$
^src/terminal/parser/ft_fuzzwrapper/run\.bat$
^src/terminal/parser/ut_parser/run\.bat$
^src/tools/integrity/packageuwp/ConsoleUWP\.appxSources$
^src/tools/lnkd/lnkd\.bat$
^src/tools/pixels/pixels\.bat$
^src/tools/texttests/fira\.txt$
^src/tools/U8U16Test/(?:fr|ru|zh)\.txt$
^\.github/actions/spell-check/
^src/types/ut_types/UtilsTests.cpp$
^\.github/actions/spelling/
^\.gitignore$
^\XamlStyler.json$

View file

@ -1,3 +1,9 @@
AAAa
AAAAA
AAAAAAAAAAAAA
AAAAAABBBBBBCCC
AAAAABBBBBBCCC
abcd
abcd
abcde
abcdef
@ -5,12 +11,20 @@ ABCDEFG
ABCDEFGH
ABCDEFGHIJ
abcdefghijk
ABCDEFGHIJKLMNO
abcdefghijklmnop
ABCDEFGHIJKLMNOPQRST
abcdefghijklmnopqrstuvwxyz
ABCG
ABE
BBGGRR
abf
BBBBB
BBBBBBBB
BBBBBBBBBBBBBBDDDD
BBBBBCCC
BBBBCCCCC
BBGGRR
CCE
EFG
EFGh
QQQQQQQQQQABCDEFGHIJ
@ -31,3 +45,4 @@ ZYXWVUT
ZZBBZ
ZZZBB
ZZZBZ
ZZZZZ

View file

@ -1,6 +1,7 @@
http
td
www
easyrgb
php
ecma
rapidtables
WCAG
@ -10,6 +11,9 @@ robertelder
kovidgoyal
leonerd
fixterms
uk
winui
appshellintegration
mdtauk
cppreference
gfycat
Guake

View file

@ -4,7 +4,8 @@ https://www\.itscj\.ipsj\.or\.jp/iso-ir/[-0-9]+\.pdf
https://www\.vt100\.net/docs/[-a-zA-Z0-9#_\/.]*
https://www.w3.org/[-a-zA-Z0-9?&=\/_#]*
https://(?:(?:www\.|)youtube\.com|youtu.be)/[-a-zA-Z0-9?&=]*
https://[a-z-]+\.githubusercontent\.com/[-a-zA-Z0-9?&=_\/.]*
https://(?:[a-z-]+\.|)github(?:usercontent|)\.com/[-a-zA-Z0-9?%&=_\/.]*
https://www.xfree86.org/[-a-zA-Z0-9?&=\/_#]*
[Pp]ublicKeyToken="?[0-9a-fA-F]{16}"?
(?:[{"]|UniqueIdentifier>)[0-9a-fA-F]{8}-(?:[0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}(?:[}"]|</UniqueIdentifier)
(?:0[Xx]|\\x|U\+|#)[a-f0-9A-FGgRr]{2,}[Uu]?[Ll]{0,2}\b
@ -15,9 +16,12 @@ Scro\&ll
:\\windows\\syste\b
TestUtils::VerifyExpectedString\(tb, L"[^"]+"
(?:hostSm|mach)\.ProcessString\(L"[^"]+"
\b([A-Za-z])\1{3,}\b
\b([A-Za-z])\g{-1}{3,}\b
0x[0-9A-Za-z]+
Base64::s_(?:En|De)code\(L"[^"]+"
VERIFY_ARE_EQUAL\(L"[^"]+"
"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789\+/"
std::memory_order_[\w]+
D2DERR_SHADER_COMPILE_FAILED
TIL_FEATURE_[0-9A-Z_]+
vcvars\w*

22
.github/actions/spelling/reject.txt vendored Normal file
View file

@ -0,0 +1,22 @@
^attache$
^attacher$
^attachers$
^spae$
^spaebook$
^spaecraft$
^spaed$
^spaedom$
^spaeing$
^spaeings$
^spae-man$
^spaeman$
^spaer$
^Spaerobee$
^spaes$
^spaewife$
^spaewoman$
^spaework$
^spaewright$
^wether$
^wethers$
^wetherteg$

View file

@ -1,20 +0,0 @@
name: Spell checking
on:
push:
schedule:
# * is a special character in YAML so you have to quote this string
- cron: '15 * * * *'
jobs:
build:
name: Spell checking
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2.0.0
with:
fetch-depth: 5
- uses: check-spelling/check-spelling@0.0.16-alpha
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
bucket: .github/actions
project: spell-check

20
.github/workflows/spelling2.yml vendored Normal file
View file

@ -0,0 +1,20 @@
# spelling.yml is blocked per https://github.com/check-spelling/check-spelling/security/advisories/GHSA-g86g-chm8-7r2p
name: Spell checking
on:
pull_request_target:
push:
jobs:
spelling:
name: Spell checking
runs-on: ubuntu-latest
steps:
- name: checkout-merge
if: "contains(github.event_name, 'pull_request')"
uses: actions/checkout@v2
with:
ref: refs/pull/${{github.event.pull_request.number}}/merge
- name: checkout
if: "!contains(github.event_name, 'pull_request')"
uses: actions/checkout@v2
- uses: check-spelling/check-spelling@v0.0.19

View file

@ -47,6 +47,7 @@ class AliasTests
TEST_METHOD_PROPERTY(L"Data:bUnicode", L"{FALSE, TRUE}")
TEST_METHOD_PROPERTY(L"Data:bSetFirst", L"{FALSE, TRUE}")
END_TEST_METHOD()
};
// Caller must free ppsz if not null.

View file

@ -3,8 +3,6 @@
#include "precomp.h"
#include <thread>
#include "..\..\interactivity\onecore\SystemConfigurationProvider.hpp"
// some assumptions have been made on this value. only change it if you have a good reason to.
@ -13,6 +11,7 @@
using WEX::Logging::Log;
using namespace WEX::Common;
using namespace WEX::TestExecution;
// This class is intended to test:
// FlushConsoleInputBuffer
@ -21,6 +20,7 @@ using namespace WEX::Common;
// WriteConsoleInput
// GetNumberOfConsoleInputEvents
// GetNumberOfConsoleMouseButtons
// ReadConsoleA
class InputTests
{
BEGIN_TEST_CLASS(InputTests)
@ -54,6 +54,44 @@ class InputTests
BEGIN_TEST_METHOD(TestVtInputGeneration)
TEST_METHOD_PROPERTY(L"IsolationLevel", L"Method")
END_TEST_METHOD();
BEGIN_TEST_METHOD(TestCookedAliasProcessing)
TEST_METHOD_PROPERTY(L"TestTimeout", L"00:01:00")
END_TEST_METHOD()
BEGIN_TEST_METHOD(TestCookedTextEntry)
TEST_METHOD_PROPERTY(L"TestTimeout", L"00:01:00")
END_TEST_METHOD()
BEGIN_TEST_METHOD(TestCookedAlphaPermutations)
TEST_METHOD_PROPERTY(L"TestTimeout", L"00:01:00")
TEST_METHOD_PROPERTY(L"Data:inputcp", L"{437, 932}")
TEST_METHOD_PROPERTY(L"Data:outputcp", L"{437, 932}")
TEST_METHOD_PROPERTY(L"Data:inputmode", L"{487, 481}") // 487 is 0x1e7, 481 is 0x1e1 (ENABLE_LINE_INPUT on/off)
TEST_METHOD_PROPERTY(L"Data:outputmode", L"{7}")
TEST_METHOD_PROPERTY(L"Data:font", L"{Consolas, MS Gothic}")
END_TEST_METHOD()
BEGIN_TEST_METHOD(TestReadCharByChar)
TEST_METHOD_PROPERTY(L"Data:readmode", L"{cooked, raw, direct}")
//TEST_METHOD_PROPERTY(L"TestTimeout", L"00:01:00")
END_TEST_METHOD()
BEGIN_TEST_METHOD(TestReadLeadTrailString)
TEST_METHOD_PROPERTY(L"Data:readmode", L"{cooked, raw, direct}")
//TEST_METHOD_PROPERTY(L"TestTimeout", L"00:01:00")
END_TEST_METHOD()
BEGIN_TEST_METHOD(TestReadChangeCodepageInMiddle)
TEST_METHOD_PROPERTY(L"Data:readmode", L"{cooked, raw, direct}")
//TEST_METHOD_PROPERTY(L"TestTimeout", L"00:01:00")
END_TEST_METHOD()
BEGIN_TEST_METHOD(TestReadChangeCodepageBetweenBytes)
TEST_METHOD_PROPERTY(L"Data:readmode", L"{cooked, raw, direct}")
TEST_METHOD_PROPERTY(L"IsolationLevel", L"Method")
//TEST_METHOD_PROPERTY(L"TestTimeout", L"00:01:00")
END_TEST_METHOD()
};
void VerifyNumberOfInputRecords(const HANDLE hConsoleInput, _In_ DWORD nInputs)
@ -716,3 +754,836 @@ void InputTests::RawReadUnpacksCoalescedInputRecords()
VERIFY_WIN32_BOOL_SUCCEEDED(GetNumberOfConsoleInputEvents(hIn, &eventCount));
VERIFY_ARE_EQUAL(eventCount, static_cast<DWORD>(0));
}
static std::vector<INPUT_RECORD> _stringToInputs(std::wstring_view wstr)
{
std::vector<INPUT_RECORD> result;
for (const auto& wch : wstr)
{
INPUT_RECORD ir = { 0 };
ir.EventType = KEY_EVENT;
ir.Event.KeyEvent.bKeyDown = TRUE;
ir.Event.KeyEvent.dwControlKeyState = 0;
ir.Event.KeyEvent.uChar.UnicodeChar = wch;
ir.Event.KeyEvent.wRepeatCount = 1;
ir.Event.KeyEvent.wVirtualKeyCode = VkKeyScanW(wch);
ir.Event.KeyEvent.wVirtualScanCode = gsl::narrow<WORD>(MapVirtualKeyW(ir.Event.KeyEvent.wVirtualKeyCode, MAPVK_VK_TO_VSC));
result.emplace_back(ir);
ir.Event.KeyEvent.bKeyDown = FALSE;
result.emplace_back(ir);
}
return result;
}
static HRESULT _sendStringToInput(HANDLE in, std::wstring_view wstr)
{
auto records = _stringToInputs(wstr);
DWORD written;
RETURN_IF_WIN32_BOOL_FALSE(WriteConsoleInputW(in, records.data(), gsl::narrow<DWORD>(records.size()), &written));
return S_OK;
}
// Routine Description:
// - Reads data from the standard input with a 5 second timeout
// Arguments:
// - in - The standard input handle
// - buf - The buffer to use. On in, this is the max size we'll read. On out, it's resized to fit.
// - async - Whether to read async, default to true. Reading async will put a 5 second timeout on the read.
// Return Value:
// - S_OK or an error from ReadConsole/threading timeout.
static HRESULT _readStringFromInput(HANDLE in, std::string& buf, bool async = true)
{
DWORD read = 0;
if (async)
{
auto tryRead = std::async(std::launch::async, [&] {
return _readStringFromInput(in, buf, false); // just re-enter ourselves on the other thread as sync.
});
if (std::future_status::ready != tryRead.wait_for(std::chrono::seconds{ 5 }))
{
// Shove something into the input to unstick it then fail.
_sendStringToInput(in, L"a\r\n");
RETURN_NTSTATUS(STATUS_TIMEOUT);
// If somehow this still isn't enough to unstick the thread, be sure to set
// the whole test timeout is 1 min in the parameters/metadata at the top.
}
else
{
return tryRead.get();
}
}
else
{
RETURN_IF_WIN32_BOOL_FALSE(ReadConsoleA(in, buf.data(), gsl::narrow<DWORD>(buf.size()), &read, nullptr));
// If we successfully read, then resize to fit the buffer.
buf.resize(read);
return S_OK;
}
}
static HRESULT _readStringFromInputDirect(HANDLE in, std::string& buf, bool async = true)
{
if (async)
{
auto tryRead = std::async(std::launch::async, [&] {
return _readStringFromInputDirect(in, buf, false); // just re-enter ourselves on the other thread as sync.
});
if (std::future_status::ready != tryRead.wait_for(std::chrono::seconds{ 5 }))
{
// Shove something into the input to unstick it then fail.
_sendStringToInput(in, L"a\r\n");
RETURN_NTSTATUS(STATUS_TIMEOUT);
// If somehow this still isn't enough to unstick the thread, be sure to set
// the whole test timeout is 1 min in the parameters/metadata at the top.
}
else
{
return tryRead.get();
}
}
else
{
const auto originalSize = buf.size();
buf.clear();
std::vector<INPUT_RECORD> ir;
DWORD read = 0;
do
{
ir.clear();
ir.resize(originalSize - buf.size());
RETURN_IF_WIN32_BOOL_FALSE(ReadConsoleInputA(in, ir.data(), gsl::narrow_cast<DWORD>(ir.size()), &read));
for (const auto& r : ir)
{
if (r.EventType == KEY_EVENT)
{
if (!r.Event.KeyEvent.bKeyDown)
{
buf.push_back(r.Event.KeyEvent.uChar.AsciiChar);
}
}
}
ir.clear();
} while (originalSize > buf.size());
return S_OK;
}
}
void InputTests::TestCookedAliasProcessing()
{
const auto in = GetStdInputHandle();
DWORD originalInMode = 0;
VERIFY_WIN32_BOOL_SUCCEEDED(GetConsoleMode(in, &originalInMode));
DWORD originalCodepage = GetConsoleCP();
auto restoreInModeOnExit = wil::scope_exit([&] {
SetConsoleMode(in, originalInMode);
SetConsoleCP(originalCodepage);
});
const DWORD testInMode = ENABLE_ECHO_INPUT | ENABLE_LINE_INPUT | ENABLE_PROCESSED_INPUT;
VERIFY_WIN32_BOOL_SUCCEEDED(SetConsoleMode(in, testInMode));
auto modulePath = wil::GetModuleFileNameW<std::wstring>(nullptr);
std::filesystem::path path{ modulePath };
auto fileName = path.filename();
auto exeName = fileName.wstring();
VERIFY_WIN32_BOOL_SUCCEEDED(AddConsoleAliasW(L"foo", L"echo bar$Techo baz$Techo bam", exeName.data()));
std::wstring commandWritten = L"foo\r\n";
std::queue<std::string> commandExpected;
commandExpected.push("echo bar\r");
commandExpected.push("echo baz\r");
commandExpected.push("echo bam\r");
VERIFY_SUCCEEDED(_sendStringToInput(in, commandWritten));
std::string buf;
while (!commandExpected.empty())
{
buf.resize(500);
VERIFY_SUCCEEDED(_readStringFromInput(in, buf));
auto actual = buf;
auto expected = commandExpected.front();
commandExpected.pop();
VERIFY_ARE_EQUAL(expected, actual);
}
}
void InputTests::TestCookedTextEntry()
{
const auto in = GetStdInputHandle();
DWORD originalInMode = 0;
VERIFY_WIN32_BOOL_SUCCEEDED(GetConsoleMode(in, &originalInMode));
DWORD originalCodepage = GetConsoleCP();
auto restoreInModeOnExit = wil::scope_exit([&] {
SetConsoleMode(in, originalInMode);
SetConsoleCP(originalCodepage);
});
const DWORD testInMode = ENABLE_ECHO_INPUT | ENABLE_LINE_INPUT | ENABLE_PROCESSED_INPUT;
VERIFY_WIN32_BOOL_SUCCEEDED(SetConsoleMode(in, testInMode));
std::wstring commandWritten = L"foo\r\n";
std::queue<std::string> commandExpected;
commandExpected.push("foo\r\n");
VERIFY_SUCCEEDED(_sendStringToInput(in, commandWritten));
std::string buf;
while (!commandExpected.empty())
{
buf.resize(500);
VERIFY_SUCCEEDED(_readStringFromInput(in, buf));
auto actual = buf;
auto expected = commandExpected.front();
commandExpected.pop();
VERIFY_ARE_EQUAL(expected, actual);
}
}
// Greek letters, lowercase...
const std::array<std::wstring, 4> wide = {
L"\u03b1", // alpha
L"\u03b2", // beta
// no gamma because it doesn't translate to 437
L"\u03b4", // delta
L"\u03b5" //epsilon
};
const std::array<std::string, 4> char437 = {
"\xe0",
"\xe1",
"\xeb",
"\xee"
};
const std::array<std::string, 4> char932 = {
"\x83\xbf",
"\x83\xc0",
"\x83\xc2",
"\x83\xc3"
};
const std::wstring widecrlf = L"\r\n";
const std::string crlf = "\r\n";
enum class ReadMode
{
Cooked, // ReadConsoleA with ENABLE_LINE_INPUT
Raw, // ReadConsoleA without ENABLE_LINE_INPUT
Direct // ReadConsoleInputA
};
static HRESULT _readString(HANDLE in, ReadMode mode, std::string& buf, bool async = true)
{
switch (mode)
{
case ReadMode::Cooked:
case ReadMode::Raw:
return _readStringFromInput(in, buf, async);
case ReadMode::Direct:
return _readStringFromInputDirect(in, buf, async);
default:
VERIFY_FAIL(L"Not supported");
return E_NOTIMPL;
}
}
void InputTests::TestCookedAlphaPermutations()
{
DWORD inputcp, outputcp, inputmode, outputmode;
String font;
VERIFY_SUCCEEDED_RETURN(TestData::TryGetValue(L"inputcp", inputcp), L"Get input cp");
VERIFY_SUCCEEDED_RETURN(TestData::TryGetValue(L"outputcp", outputcp), L"Get output cp");
VERIFY_SUCCEEDED_RETURN(TestData::TryGetValue(L"inputmode", inputmode), L"Get input mode");
VERIFY_SUCCEEDED_RETURN(TestData::TryGetValue(L"outputmode", outputmode), L"Get output mode");
VERIFY_SUCCEEDED_RETURN(TestData::TryGetValue(L"font", font), L"Get font");
std::wstring wstrFont{ font };
if (wstrFont == L"MS Gothic")
{
// MS Gothic... but in full width characters and the katakana representation...
// MS GOSHIKKU romanized...
wstrFont = L"\xff2d\xff33\x0020\x30b4\x30b7\x30c3\x30af";
}
const auto in = GetStdInputHandle();
const auto out = GetStdOutputHandle();
Log::Comment(L"Backup original modes and codepages and font.");
DWORD originalInMode, originalOutMode, originalInputCP, originalOutputCP;
CONSOLE_FONT_INFOEX originalFont = { 0 };
originalFont.cbSize = sizeof(originalFont);
VERIFY_WIN32_BOOL_SUCCEEDED(GetConsoleMode(in, &originalInMode));
VERIFY_WIN32_BOOL_SUCCEEDED(GetConsoleMode(out, &originalOutMode));
originalInputCP = GetConsoleCP();
originalOutputCP = GetConsoleOutputCP();
VERIFY_WIN32_BOOL_SUCCEEDED(GetCurrentConsoleFontEx(out, FALSE, &originalFont));
auto restoreModesOnExit = wil::scope_exit([&] {
SetConsoleMode(in, originalInMode);
SetConsoleMode(out, originalOutMode);
SetConsoleCP(originalInputCP);
SetConsoleOutputCP(originalOutputCP);
SetCurrentConsoleFontEx(out, FALSE, &originalFont);
});
Log::Comment(L"Apply our modes and codepages and font.");
VERIFY_WIN32_BOOL_SUCCEEDED(SetConsoleMode(in, inputmode));
VERIFY_WIN32_BOOL_SUCCEEDED(SetConsoleMode(out, outputmode));
if (GetACP() != 932 && !Common::_isV2 && inputcp == 932)
{
Log::Comment(L"The v1 console cannot switch to Japanese unless the system ACP is 932");
Log::Comment(L"Set it in the regional control panel legacy settings and reboot first.");
VERIFY_FAIL(L"System state invalid for v1 test. Must be in Japanese (Japan) legacy locale.");
}
VERIFY_WIN32_BOOL_SUCCEEDED(SetConsoleCP(inputcp));
VERIFY_WIN32_BOOL_SUCCEEDED(SetConsoleOutputCP(outputcp));
auto ourFont = originalFont;
wmemcpy_s(ourFont.FaceName, ARRAYSIZE(ourFont.FaceName), wstrFont.data(), wstrFont.size());
VERIFY_WIN32_BOOL_SUCCEEDED(SetCurrentConsoleFontEx(out, FALSE, &ourFont));
const wchar_t alpha = wide[0][0];
const std::string alpha437 = char437[0];
const std::string alpha932 = char932[0];
std::string expected = inputcp == 932 ? alpha932 : alpha437;
std::wstring sendInput;
sendInput.append(&alpha, 1);
// If we're in line input, we have to send a newline and we'll get one back.
if (WI_IsFlagSet(inputmode, ENABLE_LINE_INPUT))
{
expected.append(crlf);
sendInput.append(widecrlf);
}
Log::Comment(L"send the string");
VERIFY_SUCCEEDED(_sendStringToInput(in, sendInput));
Log::Comment(L"receive the string");
std::string recvInput;
recvInput.resize(500); // excessively big
VERIFY_SUCCEEDED(_readStringFromInput(in, recvInput));
// corruption magic
// In MS Gothic, alpha is full width (2 columns)
// In Consolas, alpha is half width (1 column)
// Alpha itself is an ambiguous character, meaning the console finds the width
// by asking the font.
// Unfortunately, there's some code mixed up in the cooked read for a long time where
// the width is used as a predictor of how many bytes it will consume.
// In this specific combination of using a font where the ambiguous alpha is half width,
// the output code page doesn't support double bytes, and the input code page does...
// The result is stomped with a null as the conversion fails thinking it doesn't have enough space.
// Also, we're not maintaining this font corruption going forward. So test it for v1 only.
if (!Common::_isV2 && wstrFont == L"Consolas" && inputcp == 932 && outputcp == 437)
{
VERIFY_IS_GREATER_THAN_OR_EQUAL(recvInput.size(), 1);
VERIFY_ARE_EQUAL('\x00', recvInput[0]);
if (WI_IsFlagSet(inputmode, ENABLE_LINE_INPUT))
{
VERIFY_IS_GREATER_THAN_OR_EQUAL(recvInput.size(), 3);
VERIFY_ARE_EQUAL('\r', recvInput[1]);
VERIFY_ARE_EQUAL('\n', recvInput[2]);
}
}
// end corruption magic
else
{
VERIFY_ARE_EQUAL(expected, recvInput);
}
}
void _unifiedReadTest(std::function<void(HANDLE, ReadMode)> fn)
{
String readmode;
VERIFY_SUCCEEDED_RETURN(TestData::TryGetValue(L"readmode", readmode), L"Get read mode");
ReadMode rm = ReadMode::Raw;
if (readmode == L"cooked")
{
rm = ReadMode::Cooked;
}
else if (readmode == L"raw")
{
rm = ReadMode::Raw;
}
else if (readmode == L"direct")
{
rm = ReadMode::Direct;
}
else
{
VERIFY_FAIL(L"Read mode not implemented on test.");
}
const auto in = GetStdInputHandle();
DWORD originalInMode = 0;
VERIFY_WIN32_BOOL_SUCCEEDED(GetConsoleMode(in, &originalInMode));
DWORD originalCodepage = GetConsoleCP();
auto restoreInModeOnExit = wil::scope_exit([&] {
SetConsoleMode(in, originalInMode);
SetConsoleCP(originalCodepage);
});
const DWORD testInMode = rm == ReadMode::Raw ? 0 : ENABLE_ECHO_INPUT | ENABLE_LINE_INPUT | ENABLE_PROCESSED_INPUT;
VERIFY_WIN32_BOOL_SUCCEEDED(SetConsoleMode(in, testInMode));
Log::Comment(L"Set the codepage to Japanese");
if (GetACP() != 932 && !Common::_isV2)
{
Log::Comment(L"The v1 console cannot switch to Japanese unless the system ACP is 932");
Log::Comment(L"Set it in the regional control panel legacy settings and reboot first.");
VERIFY_FAIL(L"System state invalid for v1 test. Must be in Japanese (Japan) legacy locale.");
}
VERIFY_WIN32_BOOL_SUCCEEDED(SetConsoleCP(932));
Log::Comment(L"Flush out the read queue.");
VERIFY_WIN32_BOOL_SUCCEEDED(FlushConsoleInputBuffer(in));
Log::Comment(L"Write something into the read queue.");
std::wstring sendInput;
sendInput.append(wide[0]);
sendInput.append(wide[1]);
sendInput.append(wide[2]);
sendInput.append(wide[3]);
sendInput.append(L"\r\n"); // send a newline to finish the line since we're in ENABLE_LINE_INPUT mode
Log::Comment(L"send the string");
VERIFY_SUCCEEDED(_sendStringToInput(in, sendInput));
fn(in, rm);
}
std::wstring _stringToHexString(const std::string& str)
{
std::wstring ret;
for (auto& ch : str)
{
ret.append(fmt::format(L"{:#04x} ", (byte)ch));
}
return ret;
}
void _readVersusExpected(const HANDLE in, const ReadMode mode, const std::string& expected, size_t readSize)
{
// Print expected up here so if it horks, we can at least know what we asked for to debug/fix the test.
Log::Comment(fmt::format(L"Expected: {}", _stringToHexString(expected)).c_str());
std::string recvInput;
recvInput.resize(readSize);
VERIFY_SUCCEEDED(_readString(in, mode, recvInput));
Log::Comment(fmt::format(L"Actual : {}", _stringToHexString(recvInput)).c_str());
VERIFY_ARE_EQUAL(expected, recvInput);
}
// TODO tests:
// - ensure leftover bytes are lost when read off a different handle?!
void InputTests::TestReadCharByChar()
{
_unifiedReadTest([isv2 = Common::_isV2](HANDLE in, ReadMode mode) -> void {
Log::Comment(L"Read byte by byte, should leave trailing each time.");
if (!isv2)
{
std::string expectedInput;
expectedInput = char932[0][0];
if (mode != ReadMode::Direct)
{
// this is an artifact of resizing our string to the `lpNumberOfCharsRead`
// which can be longer than the buffer we gave. `ReadConsoleA` appears to
// do this either to signal there are more or as a mistake that was never
// matched up on API review.
expectedInput.append(1, '\0');
}
_readVersusExpected(in, mode, expectedInput, 1);
// TODO: CHv1 completely loses the trailing byte.
expectedInput[0] = char932[1][0];
_readVersusExpected(in, mode, expectedInput, 1);
// TODO: CHv1 completely loses the trailing byte.
expectedInput[0] = char932[2][0];
_readVersusExpected(in, mode, expectedInput, 1);
// TODO: CHv1 completely loses the trailing byte.
expectedInput[0] = char932[3][0];
_readVersusExpected(in, mode, expectedInput, 1);
// TODO: CHv1 completely loses the trailing byte.
expectedInput = crlf[0];
_readVersusExpected(in, mode, expectedInput, 1);
if (mode != ReadMode::Raw) // Raw mode will not return the \n.
{
expectedInput = crlf[1];
_readVersusExpected(in, mode, expectedInput, 1);
}
}
else
{
Log::Comment(L"Should see lead/trail alternating and then the crlf");
std::string expectedInput;
expectedInput = char932[0][0];
_readVersusExpected(in, mode, expectedInput, expectedInput.size());
expectedInput = char932[0][1];
_readVersusExpected(in, mode, expectedInput, expectedInput.size());
expectedInput = char932[1][0];
_readVersusExpected(in, mode, expectedInput, expectedInput.size());
expectedInput = char932[1][1];
_readVersusExpected(in, mode, expectedInput, expectedInput.size());
expectedInput = char932[2][0];
_readVersusExpected(in, mode, expectedInput, expectedInput.size());
expectedInput = char932[2][1];
_readVersusExpected(in, mode, expectedInput, expectedInput.size());
expectedInput = char932[3][0];
_readVersusExpected(in, mode, expectedInput, expectedInput.size());
expectedInput = char932[3][1];
_readVersusExpected(in, mode, expectedInput, expectedInput.size());
expectedInput = crlf[0];
_readVersusExpected(in, mode, expectedInput, expectedInput.size());
if (mode != ReadMode::Raw) // Raw mode doesn't return \n.
{
expectedInput = crlf[1];
_readVersusExpected(in, mode, expectedInput, expectedInput.size());
}
}
});
}
void InputTests::TestReadLeadTrailString()
{
_unifiedReadTest([isv2 = Common::_isV2](HANDLE in, ReadMode mode) -> void {
Log::Comment(L"Read byte by byte, should attach trailing to the remaining string.");
if (!isv2)
{
std::string expectedInput;
expectedInput = char932[0][0];
if (mode != ReadMode::Direct)
{
// this is an artifact of resizing our string to the `lpNumberOfCharsRead`
// which can be longer than the buffer we gave. `ReadConsoleA` appears to
// do this either to signal there are more or as a mistake that was never
// matched up on API review.
expectedInput.append(1, '\0');
}
_readVersusExpected(in, mode, expectedInput, 1);
Log::Comment(L"Read everything else");
// TODO: CHv1 completely loses the trailing byte.
expectedInput.clear();
if (mode != ReadMode::Raw)
{
// Direct mode can successfully return the trailing byte...
// but in v1... only when the read length is > 1 record total.
// Since this is the "string remaining" test... that's >1 record.
// (as opposed to the char-by-char test where Direct loses it just like
// Cooked and Raw do.)
if (mode == ReadMode::Direct)
{
expectedInput.append(1, char932[0][1]);
}
expectedInput.append(char932[1]);
expectedInput.append(char932[2]);
expectedInput.append(char932[3]);
expectedInput.append(1, crlf[0]);
expectedInput.append(1, crlf[1]);
}
else
{
// Raw mode messes up completely here and just returns the UTF-16 characters.
// oh and a null at the end for fun. and it loses the \n.
expectedInput.append(1, LOBYTE(wide[1][0]));
expectedInput.append(1, HIBYTE(wide[1][0]));
expectedInput.append(1, LOBYTE(wide[2][0]));
expectedInput.append(1, HIBYTE(wide[2][0]));
expectedInput.append(1, LOBYTE(wide[3][0]));
expectedInput.append(1, HIBYTE(wide[3][0]));
expectedInput.append(1, crlf[0]);
expectedInput.append(1, '\0');
}
// The test helper is authored such that direct mode will keep retrying
// to read until it gets every record requested because there's a high
// potential for other events (focus, mouse) to drop into the queue
// for random reasons.
// As such, we can read to excess on cooked/raw, but we have to read
// to the exact expected length for direct.
if (mode != ReadMode::Direct)
{
_readVersusExpected(in, mode, expectedInput, 100);
}
else
{
// We can't read too far for direct because we have to loop
// to get all the right key records and we'll end up in an infinite wait.
_readVersusExpected(in, mode, expectedInput, 9);
}
}
else
{
Log::Comment(L"Should see just lead byte.");
std::string expectedInput;
expectedInput = char932[0][0];
_readVersusExpected(in, mode, expectedInput, expectedInput.size());
Log::Comment(L"Read everything else. Trailing byte stitched to front of results.");
expectedInput = char932[0][1];
expectedInput.append(char932[1]);
expectedInput.append(char932[2]);
expectedInput.append(char932[3]);
expectedInput.append(1, crlf[0]);
if (mode != ReadMode::Raw) // Raw mode doesn't return \n.
{
expectedInput.append(1, crlf[1]);
}
_readVersusExpected(in, mode, expectedInput, expectedInput.size());
}
});
}
void InputTests::TestReadChangeCodepageInMiddle()
{
_unifiedReadTest([isv2 = Common::_isV2](HANDLE in, ReadMode mode) -> void {
if (!isv2)
{
Log::Comment(L"Read only part of it including leaving behind a trailing byte.");
std::string expectedInput;
expectedInput = char932[0];
// The following two only happen if you switch part way through...
expectedInput.append(char932[1].data(), 1);
// this is an artifact of resizing our string to the `lpNumberOfCharsRead`
// which can be longer than the buffer we gave. `ReadConsoleA` appears to
// do this either to signal there are more or as a mistake that was never
// matched up on API review.
if (mode != ReadMode::Direct)
{
expectedInput.append(1, '\0');
}
if (mode == ReadMode::Raw)
{
// throw on two null bytes for funsies.
expectedInput.append(1, '\0');
expectedInput.append(1, '\0');
}
_readVersusExpected(in, mode, expectedInput, 3); // two bytes of first alpha and then a lead byte of the second one.
Log::Comment(L"Set the codepage to English");
Log::Comment(L"Changing codepage should discard all partial bytes!");
VERIFY_WIN32_BOOL_SUCCEEDED(SetConsoleCP(437));
Log::Comment(L"Read the rest of it and validate that it was re-encoded as English");
expectedInput.clear();
if (mode == ReadMode::Direct)
{
expectedInput.append(char437[2]);
}
expectedInput.append(char437[3]);
if (mode != ReadMode::Raw)
{
expectedInput.append(crlf);
}
else
{
// why do we get a ?... I mean why are we getting any of this weirdness.
expectedInput.append(1, '?');
}
if (mode != ReadMode::Direct)
{
_readVersusExpected(in, mode, expectedInput, 490);
}
else
{
// We can't read too far for direct because we have to loop
// to get all the right key records and we'll end up in an infinite wait.
_readVersusExpected(in, mode, expectedInput, 4);
}
}
else
{
Log::Comment(L"Read the first whole character and a lead byte of the second (3 bytes)");
std::string expectedInput;
expectedInput = char932[0];
expectedInput.append(1, char932[1][0]);
_readVersusExpected(in, mode, expectedInput, expectedInput.size());
Log::Comment(L"Set the codepage to English");
Log::Comment(L"Changing codepage should discard all partial bytes!");
VERIFY_WIN32_BOOL_SUCCEEDED(SetConsoleCP(437));
Log::Comment(L"Read everything else. Trailing byte should be gone and not stitched to front of results.");
expectedInput.clear();
expectedInput.append(char437[2]);
expectedInput.append(char437[3]);
expectedInput.append(1, crlf[0]);
if (mode != ReadMode::Raw) // Raw mode doesn't return \n.
{
expectedInput.append(1, crlf[1]);
}
_readVersusExpected(in, mode, expectedInput, expectedInput.size());
}
});
}
void InputTests::TestReadChangeCodepageBetweenBytes()
{
_unifiedReadTest([isv2 = Common::_isV2](HANDLE in, ReadMode mode) -> void {
if (!isv2)
{
Log::Comment(L"Read only part of it including leaving behind a trailing byte.");
std::string expectedInput;
expectedInput = char932[0];
if (mode == ReadMode::Raw)
{
// throw on two null bytes for funsies.
expectedInput.append(1, '\0');
expectedInput.append(1, '\0');
}
_readVersusExpected(in, mode, expectedInput, 2); // two bytes of first alpha
Log::Comment(L"Set the codepage to English");
Log::Comment(L"Changing codepage should discard all partial bytes!");
VERIFY_WIN32_BOOL_SUCCEEDED(SetConsoleCP(437));
Log::Comment(L"Read the rest of it and validate that it was re-encoded as English");
expectedInput.clear();
// TODO: I believe v2 shouldn't lose this character by switching codepages.
if (mode == ReadMode::Direct)
{
expectedInput.append(char437[1]);
}
expectedInput.append(char437[2]);
if (mode == ReadMode::Raw)
{
// an infix question mark? in the raw read? for no sensible reason?
// YEP.
expectedInput.append(1, '?');
}
expectedInput.append(char437[3]);
if (mode != ReadMode::Raw)
{
expectedInput.append(crlf);
}
if (mode != ReadMode::Direct)
{
_readVersusExpected(in, mode, expectedInput, 490);
}
else
{
// We can't read too far for direct because we have to loop
// to get all the right key records and we'll end up in an infinite wait.
_readVersusExpected(in, mode, expectedInput, 5);
}
}
else
{
Log::Comment(L"Read the first two whole characters (4 bytes)");
std::string expectedInput;
expectedInput = char932[0];
expectedInput.append(char932[1]);
_readVersusExpected(in, mode, expectedInput, expectedInput.size());
Log::Comment(L"Set the codepage to English");
Log::Comment(L"Changing codepage should discard all partial bytes! But there shouldn't be any partials!");
VERIFY_WIN32_BOOL_SUCCEEDED(SetConsoleCP(437));
Log::Comment(L"Read everything else.");
expectedInput.clear();
expectedInput.append(char437[2]);
expectedInput.append(char437[3]);
expectedInput.append(1, crlf[0]);
if (mode != ReadMode::Raw) // Raw mode doesn't return \n.
{
expectedInput.append(1, crlf[1]);
}
_readVersusExpected(in, mode, expectedInput, expectedInput.size());
}
});
}

View file

@ -185,7 +185,7 @@ bool Common::TestBufferSetup()
// to the default output buffer at the same time.
_hConsole = CreateConsoleScreenBuffer(GENERIC_READ | GENERIC_WRITE,
0 /*dwShareMode*/,
FILE_SHARE_READ | FILE_SHARE_WRITE /*dwShareMode*/, // needed to read cooked
nullptr /*lpSecurityAttributes*/,
CONSOLE_TEXTMODE_BUFFER,
nullptr /*lpReserved*/);

View file

@ -21,6 +21,7 @@
#include <algorithm>
#include <atomic>
#include <deque>
#include <future>
#include <list>
#include <memory>
#include <map>