Building (User)

Table of Contents

• Principles
• Use in your project
  • macOS
  • Linux
  • Windows

This is the guide to follow if you just want to use the libraries in your project, without running the test suite.
If you want to contribute or run the test suite, check the Building (Contributor) page.

Principles

• Libraries always meant to be compiled together with your existing project
• All libraries do not require any build system (you're free to use your favorite!)
• For the above reasons you don't really build the libraries
• You add or use them to your project just as another source file

Use in your project

• Add the SC.cpp unity build file to your build system of choice (if any!).
• Headers in Libraries/**SomeLibrary**/*.h are public.
  
• Headers in Libraries/**SomeLibrary**/[Internal | Tests] are NOT public.

Note

Libraries assume you're not using the C++ Standard Library to ensure peak C++ sanity in your project.
If you really need you can:

• #define SC_COMPILER_ENABLE_STD_CPP=1 to use the C++ Standard Library
• But remember you can always Disable the C++ standard library with a few flags

macOS

• Add SC.cpp (located in project root) to your build
• Include any public header located at Libraries/**SomeLibrary**/SomeHeader.h
• Link:
  • CoreFoundation.framework
  • CoreServices.framework

Linux

• Add SC.cpp (located in project root) to your build
• Include any public header located at Libraries/**SomeLibrary**/SomeHeader.h
• Link:
  • libdl (-ldl)
  • libpthread (-lpthread)

Windows

• Add SC.cpp (located in project root) to your build
• Include any public header located at Libraries/**SomeLibrary**/SomeHeader.h

Note

on Windows the following libraries are already implicitly linked through #pragma comment(lib, ...)

• Ws2_32.lib
• ntdll.lib
• Rstrtmgr.lib
• shlwapi.lib