adepke/red

General Purpose C++ Application Framework Library

Red Framework

Open source collection of C++ modules built to interest a wide variety of programming focuses. The modules provide high and low level abstractions to make software development smoother, leaving the platform-dependent and management code to the library. This project is not a replacement for more developed libraries such as Boost, but it makes attempts at providing unique and useful constructs for programmers.

Build Status	System(s)
	Windows 10 (MSVS 2017)
	Ubuntu 14.04.3 (gcc 4.8.4/clang 5.0.0) OSX (XCode 8.3 clang)

Building

Building is simplified into platform specific build scripts. For Windows systems, execute Build.bat, while on *nix systems, use Build.sh. These will generate a Build folder in the project root to store all intermediates and binaries. Running these scripts without any arguments will default to 64 bit builds without debugging information.

Customizing the Build

You can customize the build with the following set of commandline arguments. Note: If you want to specify one of these arguments, you must specify all preceding arguments. Any arguments not specified after will resort to defaults. Order does matter.

[Argument 1] Release | Debug

Changes whether or not debugging information should be included in the build.

[Argument 2] x86 | x64

Changes the target system architecture.

[Argument 3*] coverage

Changes whether or not code coverage data should be included in the build.

[Argument 3**] HASNUGET

* *nix build script only, used mainly by CI for code coverage statistics.

** Windows build script only, use this if you have NuGet in your PATH and don't need to download it.

Requirements

Windows

• Microsoft Visual Studio 2017 15.2 or Later

*nix

• CMake 3.1 or Later
• Compiler With C++14 or Later Support

Contributing

This is an open source project that is open to any public submissions that fall within the loosely held style guide of the project. Until an official guide is written, potential contributors can look over the code provided and do their best to get a sense of the structure and style. As for work environments, Microsoft Visual Studio is the native development suite for work on the library and will always be supported. It is unknown whether or not other IDEs will be natively supported in the future.

Note

When contributing, make sure to submit your line endings as LF. This can be done in Windows by setting your git configuration variable core.autocrlf to true. For non-DOS systems that natively use LF line endings, set it to input.

red's Issues

[Network|BSD] Attempts to Connect to Non-Local Computers Times Out

When attempting to connect to a computer not in the local network, the connect always returns a timeout failure. Connecting to computers listening on the local network does work by connecting to the private IP.

[Build][Coverage] Coverage is Inaccurate

Coverage reports are inaccurate and generated very poorly. This needs to be immediately addressed and proper report generation needs to be implemented.

[Hardware] Determine Hardware Specs Once Lazily and Store for Future Fetches

This is a big optimization to the Hardware module, which would benefit multiple calls to fetching information about the platform's hardware. To do this, I could store a component of data in a static type, and just return that type's value every call after the initial.

[Build] Need for Platform Specific Makefile Targets

Currently, all files are compiled when the makefile is executed, this needs to be changed to only include the platform specific module internals.

[Core] Need for More Platform Preprocessing

More preprocessing of the platform needs to be added to the core module.

[Network] Add Send and Receive Timeout Functions

Currently all blocking network functions will stall the calling thread until they have finished, without any regard for a task timeout. Leverage the kernel flags SO_RCVTIMEO and SO_SNDTIMEO for setting timeouts.

[Network] CMake Base Include Sweep Misses Source Files

This issue directly refers to the file AsyncTask.cpp not being included into CMake builds. This is because only headers are included in the initial include sweep. Add another search component to the base sweep to include *.cpp files as well.

[Network] Add SetBroadcastsEnabled() to Sockets

In Berkeley sockets, the SO_BROADCAST flag is required to perform multicast send operations. Set this flag on or off in a member method SetBroadcastsEnabled().

Code is Not Standardized

Many portions of the code are not standardized, a strict style guide is needed.

[Thread] Need for Thread Wrapper Class With Scheduling Priority Functionality

Standard C++ threading doesn't include a scheduling priorities solution. Implement a wrapper class to enable this feature on Windows and POSIX platforms.

[Network] Need for Asynchronous Functionality

All network functions are blocking at the moment, async functionality is necessary for effective parallel I/O communications.

[Function] Cannot Distinguish Between Lambda And Function Pointer

Construction or assignment with Function type is not fully working, causing a large performance impact when using function pointers. The compiler defaults to thinking passed in function pointers are of lambda type, not causing a failure, but causing substantial execution overhead through unnecessary memory access, allocation, and deallocation.

[Test] Measure the Result of Unit Tests in CI Builds

Currently, the continuous integration runs the unit tests, but never considers the outcome to be a component of the result of the build. This should be changed to fail the build if a test does not pass.

[Network] IPv6 Support

IPv6 is growing in popularity, so portable support for it is needed. This should be fairly easy to implement and will end up mostly a mirror of the current BSD IPv4 implementation.

[Build] Need for Unified Build and Test System

The build system is strewn all over, and too many differences exist between the Windows and Unix builders. This issue is specifically referring to the CMake system for Unix builds, which is missing a solid, feature packed, and dynamically adjustable foundation that the Visual Studio solution provides. A way to conditionally export coverage data in Unix builds for Travis is required too.

[Network] Sockets Represent More Than One System Socket, Creating Issues With Multiple Connections

Each socket can represent many connected sockets, while instead they should represent an individual system socket, letting the subsystem manage them.

[Matrix] Empty

Self explanatory.

[Test] Build GTest from the Git Submodule in Windows Builds

NuGet's Google Test binaries lack certain preprocessor definitions required to use std::tuple instead of std::tr1::tuple, which currently causes a massive array of deprecation warnings. Building from the git submodule source code will fix this issue.

[Build] Fix Improper CMake Regex Matching Syntax

Improper syntax in the CMakeLists file, this needs to be addressed immediately. Implement proper regex matching syntax.

[Network] Need to Add Multicast Functionality

[Quaternion] Missing Essential Functionality

No common mathematical operations exist for the Quaternion type. Also, division does not currently work.