Git Product home page Git Product logo

simple_matching_engine's Introduction

Simple Exchange

Build Status

Description

This matching engine reads orders from a pipe then matches incoming orders in JSON form.

Building instructions

Prerequisites

  • CMake 3.2 and newer
  • Compiler with support for C++14
  • git - for downloading external resources
  • Doxygen for docs (Graphviz for more graphs in docs, PlantUML for more UML diagrams, PlantUML needs java)
  • clang-tools for static analysis and formatting
  • cppcheck for another static analysis

Prerequisites on Linux

  • Arch Linux: sudo pacman -S cmake g++ graphviz git clang clang-tools-extra cppcheck java-runtime-common cppcheck

    • download plantuml.jar and have it somewhere where PATH points to
  • Ubuntu 16.04: sudo apt-get install cmake g++ graphviz plantuml git clang clang-tidy clang-format cppcheck

Prerequisites on Windows

Two ways, which were tested:

  • msys2 based

    • Minimal: pacman -S cmake g++ git
    • Additional software pacman -S clang mingw-w64-x86_64-clang-tools-extra mingw-w64-x86_64-clang-analyzer doxygen
    • For graphs in documentation install Graphviz (to c:\Program Files\Graphviz, so scripts can find it) and add its bin subdirectory to PATH, install java (have its bin directory on PATH), download PlantUML jar file and have it on PATH.
  • Microsoft Visual Studio

    • Install cmake
    • Install git
    • For additional features install clang with tools, doxygen, graphviz, plantuml, java and add them to the PATH (not tested)

Prerequisites on macOS

  • macOS Sierra brew install llvm doxygen cppcheck graphviz

Build on Linux & macOS

Standard Makefiles:

mkdir build ; cd build
cmake ..
make -j8

Ninja build witch clang, build all+doc and install it to dist folder:

mkdir build ; cd build
cmake -GNinja -DCMAKE_CXX_COMPILER="clang++" ..
ninja all doc install

Release build which will install itself into /usr after sudo make install

mkdir build ; cd build
cmake .. -DCMAKE_INSTALL_PREFIX="/usr" -DCMAKE_BUILD_TYPE="Release"
make -j8 all
sudo make install

Build on windows

Build on windows using MSYS2 + ninja

On windows you should prefer Ninja since it is much faster than make (but has no color in shell).

With gcc:

mkdir build ; cd build
cmake -GNinja ..
ninja install

You can use cmake -G "MSYS Makefiles" .. if you want to use make.

Build on Windows using Microsoft Visual Studio 14

First you may wan to change project name in main CMakeLists.txt. Just go to the folder with the project and create new directory and create project files with this:

mkdir buildmsvc
cd buildmsvc
cmake -G "Visual Studio 14 2015" ..

and you can now open a .sln file with Visual Studio. You need to right click on executable target and Set as StartUp project. To really see the console window you want to do Start without debugging, since when run in debug mode only, console widow is closed too fast.

Targets

Note: Availability of some targets depends on availability certain executables (e.g. clang-format for format target)

  • Build
    • all (the default if no target is provided)
    • clean
    • install - install binaries into CMAKE_INSTALL_PREFIX
    • exampleApp - build exampleApp binary
    • exampleApp-run - build, install and run exampleApp binary (for your convenience)
    • exampleApp-gdb - build, install and run exampleApp binary in gdb (for your convenience)
    • run - alias for exampleApp-run (in order to keep it short)
  • Testing
    • check - run whole test suite (see test/CMakeLists.txt)
    • checkVerbose - run whole test suite (see test/CMakeLists.txt), but more verbose
    • unit - build and run unit tests only (see test/CMakeLists.txt)
    • unitall - same as previous, only prints even successful unit tests results
  • Releases
    • package - builds packages (zip,deb,rpm,windows installer depending on OS)
  • Miscellaneous
    • doc - build documentation (if doxygen is available)
      • docs can be found in build_dir/doc/doc/index.html
      • if you want them to be a part of install package, uncomment section at the end of doc/CMakeLists.txt
    • format - run clang-format on all source files (.clang-format in root directory of a project is used)
    • gdb - run target executable with gdb (does not work from ninja, needs gdb)
  • Static analysis
    • tidy - run clang static analysis on all sources
    • cppcheck - call cppcheck on all files (another static analysis)
  • External
    • update - update all external sources/projects

CMAKE variables

  • -DCMAKE_INSTALL_PREFIX - location for installation
  • -DVERSION_HOST - build machine name, see version.h.in
  • -DCMAKE_BUILD_TYPE - for build type
  • -DMEASURE_ALL=ON/OFF - Measure time of all compilations, best used with single threaded build. Needs time command (unix).
  • -DUSE_GOLD_LINKER=ON/OFF - whether to link with Gold linker.

License

Copyright (c) 2019 Bitwyre Technologies LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

simple_matching_engine's People

Contributors

dendisuhubdy avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.