Compile NVDA with the Windows 10 SDK #7568

michaelDCurran · 2017-09-05T05:32:46Z

Summary of the issue:

Currently NVDA is specifically compiled with Windows SDK 7.1A which was the last windows SDK version to support XP. Newer versions of Visual Studio have contained a special re-packaged Windows SDK 7.1a for this purpose. However, this SDK may lack particular features (E.g. static analysis) or optimizations, and will not take advantage of APIs only available on newer Operating Systems.

Description of how this pull request fixes the issue:

This PR upgrades to SCons 3.0, which now detects and uses Visual Studio 2017. Our sconscripts specifically check for VS 2017 and will no longer run on anything lower.
This PR also removes the use of Windows SDK 7.1a, thereby falling back to the latest SDK available on the system; This will be the latest Windows 10 SDK.
This PR also changes the _WIN32_WINNT define to be WIN7 (rather than XP), which allows the use of features available on at most Windows 7. The linker now also no longer receives /subsystem or /machine arguments, which now means binaries will default to being suitable for Windows 7 at a minimum, and CPU features such as SSE2 will be used.
There were some calls to GetVersion which is now deprecated. These were either removed (as they were only checking for Vista anyway), or changed to the now recommended versionHelper macros.

Testing performed:

NVDA executed on a Windows 7 SP1 machine, tested speak typed characters, read a page in Internet Explorer.

Known issues with pull request:

None

Change log entry:

No user visible change.
Changes for Developers:

NVDA is now compiled with Visual Studio 2017 and the Windows 10 SDK.

…Helper macros, and remove a pre-vista TSF check.

josephsl · 2017-09-05T06:05:24Z

Hi,

When I try to compile this from source, Command prompt and powerShell says MIDL.EXE is not a recognized command or an operable program. Thanks.

michaelDCurran · 2017-09-05T06:32:42Z

It compiled fine on my machine, and on appveyor. It will require Visual Studio 2015 community as usual. Also In the VS 2015 community installer, check that you have The latest Windows 10 SDK and tools. Specifically: - Programming Languages: -- Visual C++ -- * Common Tools for Visual C++ 2015 - Windows and web development: -- Universal Windows App Development Tools: -- * Tools (1.4.1) and Windows 10 SDK (10.0.14393) You may also want to clean your git working directory as well. Once Scons 3.0 is released we'll move to Visual Studio 2017 as well.

josephsl · 2017-09-05T07:07:02Z

Yep.

Note to others: do NOT (ever) uninstall whatever SDK that comes with Visual studio Community, otherwise build failures may result.

Thanks.

…aster

michaelDCurran · 2017-09-19T05:19:17Z

@feerrenrut: another review please. This now also upgrades to SCons 3.0 official and switches to Visual Studio 2017 for compilation. This completes the switch to more modern tools.

LeonarddeR · 2017-09-19T06:13:20Z

@michaelDCurran: Could you please review the sconscript for nvdahelper/localWin10 There is now some obsolete stuff in there which can be removed.

LeonarddeR · 2017-09-19T06:19:45Z

I also have the following error

link /nologo /incremental:no /WX/subsystem:windows,6.01 /release /OPT:REF /export:DllGetClassObject,private /export:DllCanUnloadNow,private /export:GetProxyDllInfo,private /manifest:embed /manifestinput:build\x86_64\ISimpleDOM.manifest /dll /out:build\x86_64\ISimpleDOM.dll /implib:build\x86_64\ISimpleDOM.lib rpcrt4.lib oleaut32.lib ole32.lib /PDB:build\x86_64\ISimpleDOM.dll.pdb /DEBUG build\x86_64\iSimpleDOMNode_i.obj build\x86_64\iSimpleDOMNode_p.obj build\x86_64\iSimpleDOMNode_data.obj
LINK : warning LNK4044: unrecognized option '/WX/subsystem:windows,6.01'; ignored
   Creating library build\x86_64\ISimpleDOM.lib and object build\x86_64\ISimpleDOM.exp
iSimpleDOMNode_data.obj : error LNK2001: unresolved external symbol iSimpleDOMNode_ProxyFileInfo
build\x86_64\ISimpleDOM.dll : fatal error LNK1120: 1 unresolved externals
scons: building terminated because of errors.

josephsl · 2017-09-19T06:30:55Z

Hi, also, this means I can safely merge #7520 into this PR to be done by Mick, so no need for me to even submit my own branch. Thanks. From: Leonard de Ruijter [mailto:notifications@github.com] Sent: Monday, September 18, 2017 11:13 PM To: nvaccess/nvda <nvda@noreply.github.com> Cc: Joseph Lee <joseph.lee22590@gmail.com>; Comment <comment@noreply.github.com> Subject: Re: [nvaccess/nvda] Compile NVDA with the Windows 10 SDK (#7568) @michaelDCurran <https://github.com/michaeldcurran> : Could you please review the sconscript for nvdahelper/localWin10 There is now some obsolete stuff in there which can be removed. — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#7568 (comment)> , or mute the thread <https://github.com/notifications/unsubscribe-auth/AHgLkAE0Vv2GxWZOE1hMlfSF2L5vb0bCks5sj1uBgaJpZM4PMdXL> .

…t and /I to MIDLFLAGS as this was dropping /x64 which is needed for compiling when 64 bit.

…e can compile nvdaHelperLocalWin10 using the same infrastructure as nvdaHelperRemote and nvdaHelperLocal etc, except that rather than /mt, /ZW should be used. This removes a great deal of code from the nvdaHelperLocalWin10 sconscript. # Please enter the commit message for your changes. Lines starting

michaelDCurran · 2017-09-19T10:37:38Z

I've now reordered things so that the localWin10 sconscript no longer needs to copy much of archBuild_sconscript.

michaelDCurran · 2017-09-19T10:38:38Z

Found and fixed this error as well. I'm surprised this used to work pre Win10 sdk.

LeonarddeR · 2017-10-04T05:56:18Z

It looks like SCons now has officially moved to github. Would it be possible to use the official repo as a submodule?
https://github.com/SConsProject/scons

michaelDCurran · 2017-10-04T07:37:19Z

Err... this didn't exist when I looked a few weeks ago. Must have just happened? But certainly, if it is official, then yes I'll switch it.

LeonarddeR · 2017-10-04T10:39:32Z

@michaelDCurran commented on 4 okt. 2017 09:37 CEST:

Err... this didn't exist when I looked a few weeks ago. Must have just
happened?

Probably, yes.

But certainly, if it is official, then yes I'll switch it.

It is now mentioned on the website as their primary development platform.

…erting the user to the fact they may need to run git submodule update --init

michaelDCurran · 2017-10-09T03:59:45Z

Actually, this was too early. Give it another week. master now reset to before this pr. I read the date wrong ;)

LeonarddeR · 2017-10-09T08:49:13Z

Hmm, Github still thinks this is merged.

michaelDCurran · 2017-10-09T09:33:59Z

Yep. Doesn't seem there is any way to fix that. Can't reopen the pr either. Even though I reset master to the commit before.

LeonarddeR · 2017-10-17T09:44:25Z

nvdaHelper/localWin10/sconscript


 # UWP dlls can only be dynamically linked with the CRT,
 # but some systems might not have this version of the CRT.
 # Therefore, we must include it.
-vcRedist = os.path.join(progFilesX86, r"Microsoft Visual Studio 14.0\VC\redist\onecore\x86\Microsoft.VC140.CRT")
+vcRedist = os.path.join(progFilesX86, r"Microsoft Visual Studio\2017\Community\VC\Redist\MSVC\14.11.25415\onecore\x86\Microsoft.VC141.CRT")


Would it be possible to get rid of the 14.11.25415 part here by using glob and only use the most recent version available? One problem I see with the current approach is that Appveyor silently updates its Visual Studio 2017 image to a newer build of VS, which might bundle a newer version of the redistributable. Strange enough, when I updated to Visual Studio 2017.4, i lost 14.11.25415 and have now 14.11.25325.

* Switch to using SCons 3.0 from a git mirror we manage. * Compile NVDA with the Windows 10 SDK, replace GetVersion with versionHelper macros, and remove a pre-vista TSF check. * Instruct appveyor to use its Visual Studio 2017 image * Update readme to mention Visual Studio 2017 * iSimpleDOMNode_sconscript: don't lose existing flags when adding c_ext and /I to MIDLFLAGS as this was dropping /x64 which is needed for compiling when 64 bit. * nvdaHelper sconscripts: now we are always using the Windows 10 SDK, we can compile nvdaHelperLocalWin10 using the same infrastructure as nvdaHelperRemote and nvdaHelperLocal etc, except that rather than /mt, /ZW should be used. This removes a great deal of code from the nvdaHelperLocalWin10 sconscript. * Readme.md: update VS 2017 section with extra needed dependency * Clarify error message when VC++ 14.1 is missing. * Ensure that all Python directories exist, eitherwise raise an error alerting the user to the fact they may need to run git submodule update --init * nvdaHelperLocalWin10 sconscript: search versioned directories from newest to oldest to find the vc restributables.

michaelDCurran · 2017-10-18T19:01:47Z

I was able to reproduce this once upgrading VS 2017. I fixed this before it was merged to master.

* Remove import of no longer existing windowsSdk tool from sconscript. * Style

jackylin516888 · 2021-01-11T07:33:16Z

is it ok to build with vs2019 professional on windows 10 os?

michaelDCurran added 2 commits August 31, 2017 20:59

Compile NVDA with the Windows 10 SDK, replace GetVersion with version…

4e08aae

…Helper macros, and remove a pre-vista TSF check.

Merge branch 'master' into win10sdk

3537626

michaelDCurran requested a review from feerrenrut September 5, 2017 05:32

michaelDCurran added 2 commits September 8, 2017 13:51

Switch to using SCons from a git mirror we manage. Currently latest m…

badbecb

…aster

Explicitly use Visual Studio 2017 when compiling NVDA

bbf9605

feerrenrut approved these changes Sep 11, 2017

View reviewed changes

michaelDCurran added 3 commits September 19, 2017 11:18

Update to Scons 3.0 official

d8827ac

Instruct appveyor to use its Visual Studio 2017 image

ec9e97c

Merge branch 'master' into win10sdk

0b6c836

michaelDCurran requested a review from feerrenrut September 19, 2017 05:19

Update readme to mention Visual Studio 2017

cea3f70

michaelDCurran added 2 commits September 19, 2017 20:16

iSimpleDOMNode_sconscript: don't lose existing flags when adding c_ex…

becad32

…t and /I to MIDLFLAGS as this was dropping /x64 which is needed for compiling when 64 bit.

This was referenced Sep 19, 2017

Upgrade SCons to 3.0.0 #7520

Closed

Upgrade NVDA codebase to Python 3 #7105

Closed

feerrenrut approved these changes Oct 3, 2017

View reviewed changes

michaelDCurran added a commit that referenced this pull request Oct 3, 2017

Incubates #7568

b39b2bc

nvaccessAuto added the incubating label Oct 3, 2017

nvaccessAuto assigned michaelDCurran Oct 3, 2017

michaelDCurran added 3 commits October 9, 2017 12:30

Readme.md: update VS 2017 section with extra needed dependency

1df61e6

Clarify error message when VC++ 14.1 is missing.

912529b

Ensure that all Python directoris exist, eitherwise raise an error al…

6798472

…erting the user to the fact they may need to run git submodule update --init

michaelDCurran merged commit 9c3beaa into master Oct 9, 2017

nvaccessAuto removed the incubating label Oct 9, 2017

nvaccessAuto added this to the 2017.4 milestone Oct 9, 2017

michaelDCurran added the incubating label Oct 9, 2017

LeonarddeR reviewed Oct 17, 2017

View reviewed changes

JulienCochuyt mentioned this pull request Nov 13, 2018

Allow building with other Visual Studio 2017 editions (eg. Professional) #8939

Closed

lukaszgo1 mentioned this pull request Sep 29, 2019

Fix-up of: "Compile NVDA with the Windows 10 SDK (#7568)" #10298

Merged

michaelDCurran pushed a commit that referenced this pull request Sep 30, 2019

Fix-up of: "Compile NVDA with the Windows 10 SDK (#7568)" (#10298)

27edd27

* Remove import of no longer existing windowsSdk tool from sconscript. * Style

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Compile NVDA with the Windows 10 SDK #7568

Compile NVDA with the Windows 10 SDK #7568

michaelDCurran commented Sep 5, 2017 •

edited

josephsl commented Sep 5, 2017

michaelDCurran commented Sep 5, 2017 via email

josephsl commented Sep 5, 2017

michaelDCurran commented Sep 19, 2017

LeonarddeR commented Sep 19, 2017

LeonarddeR commented Sep 19, 2017

josephsl commented Sep 19, 2017 via email

michaelDCurran commented Sep 19, 2017 via email

michaelDCurran commented Sep 19, 2017 via email

LeonarddeR commented Oct 4, 2017

michaelDCurran commented Oct 4, 2017 via email

LeonarddeR commented Oct 4, 2017

michaelDCurran commented Oct 9, 2017

LeonarddeR commented Oct 9, 2017

michaelDCurran commented Oct 9, 2017 via email

LeonarddeR Oct 17, 2017

michaelDCurran commented Oct 18, 2017 via email

jackylin516888 commented Jan 11, 2021

Compile NVDA with the Windows 10 SDK #7568

Compile NVDA with the Windows 10 SDK #7568

Conversation

michaelDCurran commented Sep 5, 2017 • edited

Summary of the issue:

Description of how this pull request fixes the issue:

Testing performed:

Known issues with pull request:

Change log entry:

josephsl commented Sep 5, 2017

michaelDCurran commented Sep 5, 2017 via email

josephsl commented Sep 5, 2017

michaelDCurran commented Sep 19, 2017

LeonarddeR commented Sep 19, 2017

LeonarddeR commented Sep 19, 2017

josephsl commented Sep 19, 2017 via email

michaelDCurran commented Sep 19, 2017 via email

michaelDCurran commented Sep 19, 2017 via email

LeonarddeR commented Oct 4, 2017

michaelDCurran commented Oct 4, 2017 via email

LeonarddeR commented Oct 4, 2017

michaelDCurran commented Oct 9, 2017

LeonarddeR commented Oct 9, 2017

michaelDCurran commented Oct 9, 2017 via email

LeonarddeR Oct 17, 2017

Choose a reason for hiding this comment

michaelDCurran commented Oct 18, 2017 via email

jackylin516888 commented Jan 11, 2021

michaelDCurran commented Sep 5, 2017 •

edited