{"id":5797,"date":"2020-08-14T07:00:53","date_gmt":"2020-08-14T14:00:53","guid":{"rendered":"http:\/\/writeasync.net\/?p=5797"},"modified":"2020-08-09T19:22:15","modified_gmt":"2020-08-10T02:22:15","slug":"cross-platform-without-complexity-finishing-up","status":"publish","type":"post","link":"http:\/\/writeasync.net\/?p=5797","title":{"rendered":"Cross-platform without complexity: finishing up"},"content":{"rendered":"

Our cross-platform project has interoperable C++ and .NET code<\/a>. However, the command line and IDE experience still only accounts for the C++ side.<\/p>\n

Let’s start with the IDE. First, a bit of bad news — there doesn’t seem to be a good way to seamlessly combine the CMake native project and the .NET projects in a single Visual Studio instance. The “Open Folder<\/a>” experience will detect the .csproj and .cs files and allow you to open and edit them. For build and test purposes, though, it will only use the info from CMakeLists.txt. But all is not lost — this is where SlnGen<\/a> comes in.<\/p>\n

SlnGen is a VS solution generator. Rather than hand-editing and maintaining files yourself, you can point slngen<\/code> at a *proj<\/code> file and it will automatically create a .sln<\/code> with all the project references transitively resolved. Due to some Win32 dependencies (registry, etc.), it won’t work on Linux, but neither does Visual Studio so we can live with that. Here is a helpful sln.cmd<\/code> script that will ensure the generated file goes into the ignored .vs<\/code> folder and sets up the right configuration:<\/p>\n

\r\n@echo off\r\nsetlocal\r\n\r\npushd %~dp0\r\nset ROOT_PATH=%CD%\r\n\r\nset BUILD_TYPE=%~1\r\nif NOT DEFINED BUILD_TYPE set BUILD_TYPE=Debug\r\nif \/i "%BUILD_TYPE%" == "Debug" goto :Gen\r\nif \/i "%BUILD_TYPE%" == "Release" goto :Gen\r\nset ERR_MSG=Usage: %0 [build_type]\r\nset EXIT_CODE=1\r\ngoto :Quit\r\n\r\n:Gen\r\nslngen.exe -c %BUILD_TYPE% -d .vs dirs.proj\r\nset EXIT_CODE=%ERRORLEVEL%\r\nif NOT "%EXIT_CODE%" == "0" set ERR_MSG=slngen.exe failed.\r\n\r\n:Quit\r\npopd\r\nif NOT "%EXIT_CODE%" == "0" echo %ERR_MSG%\r\nexit \/b %EXIT_CODE%\r\n<\/pre>\n
Simple! Now we have one-click VS integration for our .NET projects.<\/p>\n
The final step is to ensure the existing command line build script can also invoke the dotnet<\/code> commands. Now that we have two different build steps, we can add some command line arguments to control the behavior (--no-cpp<\/code> to skip the C++ part and --no-cs<\/code> to skip the C# part). The main changes for build.cmd<\/code> are as follows:<\/p>\n
\r\n:MakeCS\r\nif "%NO_CS%" == "1" goto :Quit\r\n\r\ncd "%ROOT_PATH%"\r\n\r\nset DOTNET_BUILD_ARGS=build -c %BUILD_TYPE%\r\n\r\nif "%VERBOSE%" == "1" set DOTNET_BUILD_ARGS=%DOTNET_BUILD_ARGS% -v d\r\n\r\necho == dotnet.exe %DOTNET_BUILD_ARGS%\r\ndotnet.exe %DOTNET_BUILD_ARGS%\r\nset EXIT_CODE=%ERRORLEVEL%\r\nset ERR_MSG=dotnet build failed.\r\nif NOT "%EXIT_CODE%" == "0" goto :Quit\r\n\r\nif "%NO_TEST%" == "1" goto :Quit\r\n\r\nset DOTNET_TEST_ARGS=test -c %BUILD_TYPE%\r\n\r\nif "%VERBOSE%" == "1" set DOTNET_TEST_ARGS=%DOTNET_TEST_ARGS% -v d\r\n\r\necho == dotnet.exe %DOTNET_TEST_ARGS%\r\ndotnet.exe %DOTNET_TEST_ARGS%\r\nset EXIT_CODE=%ERRORLEVEL%\r\nset ERR_MSG=dotnet test failed.\r\n<\/pre>\n
Given that lack of GOTO in Bash<\/a>, the build.sh<\/code> changes require wrapping the C++ build steps in a function. Really, that’s an improvement though. The rest of the changes are pretty much equivalent to the Windows script:<\/p>\n
\r\n[[ $NO_CS -eq 1 ]] && quit 'Done' 0\r\n\r\ncd "${ROOT_PATH}"\r\n\r\nDOTNET_BUILD_ARGS="build -c ${BUILD_TYPE}"\r\n\r\n[[ $VERBOSE -eq 1 ]] && DOTNET_BUILD_ARGS="${DOTNET_BUILD_ARGS} -v d"\r\n\r\necho == dotnet $DOTNET_BUILD_ARGS\r\ndotnet $DOTNET_BUILD_ARGS\r\nEXIT_CODE=$?\r\n[[ $EXIT_CODE -ne 0 ]] && quit 'dotnet build failed' $EXIT_CODE\r\n\r\n[[ $NO_TEST -eq 1 ]] && quit 'Done' 0\r\n\r\nDOTNET_TEST_ARGS="test -c ${BUILD_TYPE}"\r\n\r\n[[ $VERBOSE -eq 1 ]] && DOTNET_TEST_ARGS="${DOTNET_TEST_ARGS} -v d"\r\n\r\necho == dotnet $DOTNET_TEST_ARGS\r\ndotnet $DOTNET_TEST_ARGS\r\nEXIT_CODE=$?\r\n[[ $EXIT_CODE -ne 0 ]] && quit 'dotnet test failed' $EXIT_CODE\r\n<\/pre>\n
GitHub repo with all changes: CMakeSampleVS<\/a><\/p>\n
This concludes our cross-platform code exploration. Hopefully this can serve as an example of how to provide a solid multi-OS development experience without accidental<\/em> complexity<\/a> at the very least.<\/p>\n","protected":false},"excerpt":{"rendered":"
Our cross-platform project has interoperable C++ and .NET code. However, the command line and IDE experience still only accounts for the C++ side. Let’s start with the IDE. First, a bit of bad news — there doesn’t seem to be… <\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[107,31],"tags":[],"class_list":["post-5797","post","type-post","status-publish","format-standard","hentry","category-cross-platform","category-scripts"],"_links":{"self":[{"href":"http:\/\/writeasync.net\/index.php?rest_route=\/wp\/v2\/posts\/5797","targetHints":{"allow":["GET"]}}],"collection":[{"href":"http:\/\/writeasync.net\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/writeasync.net\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/writeasync.net\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"http:\/\/writeasync.net\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=5797"}],"version-history":[{"count":1,"href":"http:\/\/writeasync.net\/index.php?rest_route=\/wp\/v2\/posts\/5797\/revisions"}],"predecessor-version":[{"id":5798,"href":"http:\/\/writeasync.net\/index.php?rest_route=\/wp\/v2\/posts\/5797\/revisions\/5798"}],"wp:attachment":[{"href":"http:\/\/writeasync.net\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=5797"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/writeasync.net\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=5797"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/writeasync.net\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=5797"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}