Fixed conflicts

Author: nnarain

.gitmodules

@@ -0,0 +1,9 @@
+[submodule "tests/test_runner/test_roms"]
+	path = tests/test_runner/test_roms
+	url = https://github.com/nnarain/gb-test-roms.git
+[submodule "src/tools/gbdebugger/src/external/imgui"]
+	path = src/tools/gbdebugger/src/external/imgui
+	url = https://github.com/Flix01/imgui.git
+[submodule "src/tools/gbdebugger/src/external/imgui-sfml"]
+	path = src/tools/gbdebugger/src/external/imgui-sfml
+	url = https://github.com/eliasdaler/imgui-sfml.git

.travis.yml

@@ -7,6 +7,11 @@ os:
 compiler:
 - g++
 
+addons:
+  apt:
+    packages:
+      - lcov
+
 before_install:
 - git clone --depth=1 https://github.com/nnarain/travis-ci-scripts.git ~/scripts
 - cd ~/scripts/ && ./bootstrap && cd -
@@ -19,20 +24,25 @@ install:
 
 script:
 - mkdir build && cd build
-- cmake .. -DBUILD_EXAMPLE="OFF" -DBUILD_DOCS="ON" -DCMAKE_BUILD_TYPE=Release
-- make && make check
+- cmake .. -DCMAKE_BUILD_TYPE=Debug -DBUILD_TESTS=ON -DWITH_COVERAGE=ON -DBUILD_DOCS="ON"
+- make
+- make check
+- make run_test_roms
 - cd ..
 
 after_success:
-- ./scripts/travis_deploy_docs $TRAVIS_BRANCH $GITHUB_API_TOKEN
+- "./scripts/travis_deploy_docs $TRAVIS_BRANCH $GITHUB_API_TOKEN"
 - cd build
 - make package
 - export ARTIFACTS=$(ls -d1 $PWD/*.tar.gz)
 
+- ../scripts/coverage
+- bash <(curl -s https://codecov.io/bash) || echo "Codecov did not collect coverage reports"
+
 deploy:
   provider: releases
   api_key:
-    secure: d/qxX3lQXZg8gzABz8+IonCqCDbQSA0TCefBMnzZETvkKuZSCk7HoUxt1yVUPaybHSEP06uqyKI0qar7o48K2SLR3AakhmpUAfmrNRlCFYSzrUUag0vJXVsKR24g5T0aYQj8IHcYwWGQZ9/pZRcuCjtKee60ey40g3LzSO8/mRH7+96uAORLh5HsY1JvFJ/q1cnZQKG2+WNX8cw78NvTDzZb7zyeNiPLNmjvG6Hqys/qp2icSui6vLPKzaNm9r8mutk0tUdYY/RxsFt3auzkDeRGYLJyeRtM+OuIya7CmB5bsEi7AhwnFsTOfKL76Fpi7plKZ3nFUpjb3vIWb1M55ZIe2xd5qhzYTcG5NEOBVehcz+7WS7wlzlivrY9jrXQgMeJY/aBH5XsWRzL0i0fQt6NHF+gr2jOrDoHEPYTeBzoQEe8xX7f5IoHAxcn592UD3wno1K058WWb4wiXVITqhldJdDtRAIR9LQ1M7ieZiz/L6yf7/ScR5+HOkvkz/ipoCPKPR4CEikMq8loJDaJNv3OlV+I4XWh/yQR+Q4gSpZ/nizASgJIoOWI2OXGrTrassVfJeR8OmNQ9piuiUUxjdK8Z0SOPKphxVlKsyDpbVZ2vb+lfqLV8gl/t20/L1a1ZQhbWHK3XvQsuoHK2R1SKI/MOoF6DeQ7jRont8UMhoeE=
+    secure: tkje4Q6TX/nuFFvyEnpltnaonPlf17Mcjxg8+Lb8QjH+3bF4E1emGZ+TYyl1oHtW8ePAFQjudEUtYPdPJayLJ/5iNtofMS5s7OPTB3cuhAFBcseHaTxzaHcLDHDmDqyQGtq3kOc7fxV0qRtGHrPVSRXRM7GaswIfCLxNkrOGUNR0qfZ3vNLrEy78kgR9HaUwCrA9IC7Esbgv6FFy4PKO+fOv7mowgjfvBw3piaL1yDBPKioKKE6g/NZRXdjOQxhwFnB2Z5JRM+qVuJwbJd3QGCFX0AJMSNnf3j+dy6tPsi/gzmWUuibjqFC7mvOVv32nU1CixLRV8t+Eo7Nz37/5+fPIMzkQmSpSdvMyfigL9jYz8ue3ZFeTRTLyradJJTA7A8tUIFwR+j/0hJuW/ahxppj7Sade70jDq+gLkghbpELQRU4GE/+7E+AYeQ8dCIl7boJNASoGXXBnDogj8n1oKwEAhNttUJ+L2yR7u99j6KpQhYCBo9tW+C+piwYrULtG9/oWnwfQbAuzcUnJzHk6U19XQBI1hoOETHBn3/1Wzsaj3aldZEDU8sybUhzy9ZUt3Ux9v3GdaW+TGbblMHkhIJte9pJWS3iq5H6FUbnFw8nV61XoAYE574FcRD5ovn1/gi/AJuAWuTV5szHlFzRZEULdJXVmmayQ3nmdEU0yM/I=
   file: "${ARTIFACTS}"
   skip_cleanup: true
   on:

CMakeLists.txt

@@ -11,156 +11,12 @@ set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_CURRENT_SOURCE_DIR}/cmake/Mo
 
 project(gameboycore)
 
-# test endianness of system
-include(TestBigEndian)
+option(BUILD_DOCS "Build documentation" OFF)
 
-test_big_endian(IS_BIG_ENDIAN)
+set(CMAKE_MODULE_PATH ${CMAKE_PREFIX_PATH} "${CMAKE_SOURCE_DIR}/cmake/")
+set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake/Modules/")
 
-if(IS_BIG_ENDIAN)
-    message("-- Setting __BIGENDIAN__")
-    set(ENDIAN "__BIGENDIAN__")
-else(IS_BIG_ENDIAN)
-    message("-- Setting __LITTLEENDIAN__")
-    set(ENDIAN "__LITTLEENDIAN__")
-endif(IS_BIG_ENDIAN)
-
-# Core sources for Gameboy emulation
-set(GAMEBOYCORE_API_HEADERS
-	include/gameboycore/gameboycore_api.h
-	include/gameboycore/gameboycore.h
-	include/gameboycore/cpu.h
-	include/gameboycore/mmu.h
-	include/gameboycore/gpu.h
-	include/gameboycore/apu.h
-	include/gameboycore/joypad.h
-	include/gameboycore/link.h
-	include/gameboycore/link_cable.h
-	include/gameboycore/pixel.h
-	include/gameboycore/sprite.h
-)
-
-set(GAMEBOYCORE_HEADERS
-	${GAMEBOYCORE_API_HEADERS}
-	include/gameboycore/alu.h
-	include/gameboycore/tileram.h
-	include/gameboycore/tilemap.h
-	include/gameboycore/oam.h
-	include/gameboycore/tile.h
-	include/gameboycore/timer.h
-	include/gameboycore/interrupt_provider.h
-	include/gameboycore/palette.h
-	include/gameboycore/detail/audio/square_wave_channel.h
-	include/gameboycore/detail/audio/wave_channel.h
-	include/gameboycore/detail/audio/noise_channel.h
-	include/gameboycore/channel.h
-	include/gameboycore/memorymap.h
-	include/gameboycore/mbc.h
-	include/gameboycore/mbc1.h
-	include/gameboycore/mbc2.h
-	include/gameboycore/mbc3.h
-	include/gameboycore/mbc5.h
-	include/gameboycore/rtc.h
-	include/gameboycore/cartinfo.h
-	include/gameboycore/opcodeinfo.h
-	include/gameboycore/opcode_cycles.h
-	src/core/bitutil.h
-	src/core/shiftrotate.h
-)
-
-set(GAMEBOYCORE
-    src/core/gameboycore.cpp
-    src/core/cpu.cpp
-    src/core/mmu.cpp
-	src/core/gpu.cpp
-	src/core/apu.cpp
-	src/core/joypad.cpp
-	src/core/link.cpp
-	src/core/link_cable.cpp
-	src/core/mbc.cpp
-	src/core/mbc1.cpp
-	src/core/mbc2.cpp
-	src/core/mbc3.cpp
-	src/core/mbc5.cpp
-	src/core/alu.cpp
-    src/core/cartinfo.cpp
-	src/core/shiftrotate.cpp
-	src/core/opcodeinfo.cpp
-	src/core/tileram.cpp
-	src/core/tilemap.cpp
-	src/core/oam.cpp
-	src/core/timer.cpp
-)
-
-# compiler specific flags
-if(CMAKE_COMPILER_IS_GNUCC OR CMAKE_COMPILER_IS_GNUCXX)
-	set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -std=c++11 -Wno-format-security")
-elseif(MSVC)
-	set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /W3 -D_CRT_SECURE_NO_WARNINGS")
-endif()
-
-include(version-config)
-generate_version_info()
-
-include_directories(
-    include/
-	${CMAKE_BINARY_DIR}
-)
-
-add_definitions(
-    -D${ENDIAN}
-)
-
-# Gameboy Core Library
-add_library(${PROJECT_NAME} SHARED
-    ${GAMEBOYCORE}
-	${GAMEBOYCORE_HEADERS}
-)
-set_target_properties(${PROJECT_NAME} PROPERTIES
-	COMPILE_FLAGS "-DGAMEBOYCORE_EXPORT"
-)
-
-add_library(${PROJECT_NAME}-s STATIC
-    ${GAMEBOYCORE}
-	${GAMEBOYCORE_HEADERS}
-)
-set_target_properties(${PROJECT_NAME}-s PROPERTIES
-	COMPILE_FLAGS "-DGAMEBOYCORE_STATIC"
-)
-
-# example
-if(NOT DEFINED BUILD_EXAMPLE)
-	set(BUILD_EXAMPLE "ON")
-endif(NOT DEFINED BUILD_EXAMPLE)
-
-if(BUILD_EXAMPLE STREQUAL "ON")
-	add_subdirectory(src/example)
-endif(BUILD_EXAMPLE STREQUAL "ON")
-
-# Tests
-if(NOT DEFINED BUILD_TESTS)
-	set(BUILD_TESTS "ON")
-endif(NOT DEFINED BUILD_TESTS)
-
-if(BUILD_TESTS STREQUAL "ON")
-	enable_testing()
-	add_subdirectory(tests)
-endif(BUILD_TESTS STREQUAL "ON")
-
-# install core
-install(
-	TARGETS ${PROJECT_NAME} ${PROJECT_NAME}-s
-	ARCHIVE DESTINATION lib
-	LIBRARY DESTINATION lib
-	RUNTIME DESTINATION bin
-	COMPONENT development
-)
-
-# install headers
-install(
-	FILES ${GAMEBOYCORE_API_HEADERS}
-	DESTINATION include/gameboycore
-	COMPONENT development
-)
+add_subdirectory(src)
 
 # Installation
 include(get-version-config)
@@ -186,11 +42,7 @@ set(CPACK_COMPONENT_PROGRAMS_DISPLAY_NAME "Programs")
 include(CPack)
 
 # documentation
-if(NOT DEFINED BUILD_DOCS)
-	set(BUILD_DOCS "OFF")
-endif(NOT DEFINED BUILD_DOCS)
-
-if(BUILD_DOCS STREQUAL "ON")
+if(BUILD_DOCS)
     find_package(Doxygen)
     if(DOXYGEN_FOUND)
         configure_file(docs/Doxyfile.in ${CMAKE_BINARY_DIR}/Doxyfile @ONLY)
@@ -200,4 +52,4 @@ if(BUILD_DOCS STREQUAL "ON")
             COMMENT "Building documentation"
         )
     endif(DOXYGEN_FOUND)
-endif(BUILD_DOCS STREQUAL "ON")
+endif(BUILD_DOCS)

README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://travis-ci.org/nnarain/gameboycore.svg?branch=develop)](https://travis-ci.org/nnarain/gameboycore)
 [![Build status](https://ci.appveyor.com/api/projects/status/jkrjhds3i67o5k76/branch/develop?svg=true)](https://ci.appveyor.com/project/nnarain/gameboycore/branch/develop)
-[![GitHub issues](https://img.shields.io/github/issues/nnarain/gameboycore.svg)](https://github.com/nnarain/gameboycore/issues)
+[![codecov](https://codecov.io/gh/nnarain/gameboycore/branch/master/graph/badge.svg)](https://codecov.io/gh/nnarain/gameboycore)
 [![GitHub release](https://img.shields.io/github/release/nnarain/gameboycore.svg)](https://github.com/nnarain/gameboycore/releases)
 
 GameboyCore is a Gameboy/Gameboy Color emulator library written in C++.
@@ -20,25 +20,59 @@ GameboyCore running as:
 
 The above application are somewhat incomplete however they all demonstrate GameboyCore working for the given environment.
 
-Examples
+Building
 --------
 
-The GameboyCore repo includes an [example project](https://github.com/nnarain/gameboycore/tree/master/src/example).
+The `GameboyCore` library does not have any dependencies and can be compiled using any C++11 compiler. The tools contained in this repo, however, do have additional dependencies that need to be installed. All dependencies should be findable by CMake.
 
-Build
------
+Fetch source:
 
-**Build Options**
+```bash
+git clone https://github.com/nnarain/gameboycore
+cd gameboycore
+git submodule update --init --recursive
+```
 
-* `BUILD_DOCS`
-* `BUILD_EXAMPLE`
-* `BUILD_TESTS`
+To build the library, simply run `cmake`.
 
-~~~~~~~~~~~~~~~~~~~~~~~~~~{.sh}
-cd path/to/project/
+```bash
 mkdir build && cd build
-cmake .. -DBUILD_EXAMPLE="<ON/OFF>"
-make
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+cmake ..
+cmake --build . --target gameboycore
+```
+
+**Building Tests**
+
+Install `gtest` and build with `BUILD_TESTS=ON`. Optionally you can setup benchmarks by installing `google-benchmark`.
+
+```bash
+cmake .. -DBUILD_TESTS=ON
+cmake --build . --target check
+cmake --build . --target bench
+```
+
+A few test ROMs can be run as well.
+
+```bash
+cmake --build . --target run_test_roms
+```
+
+Only the test ROMs that print to the serial port are run. Of course any test ROM can be run with the debugger tool.
+
+
+**Building Tools**
+
+Enable building tools by specifying `BUILD_TOOLS=ON`. If building tools is enabled, all will be built by default. Disable building tools with `WITH_<tool name>=OFF`.
+
+All tools are compiled with the latest C++ standard.
+
+Debugger:
+
+* Used for running Gameboy ROMs and inspecting the core
+* Depends on SFML
+
+RomInfo
+
+* Used for printing the information in the ROM header
+
 
-Note: Building the example required SFML to be findable by CMake.