From ebf9a784a9f7f4148a669dbb39e7cd50df779a14 Mon Sep 17 00:00:00 2001 From: James Rowe Date: Thu, 11 Jan 2018 19:21:20 -0700 Subject: Massive removal of unused modules --- .gitmodules | 12 - CMakeLists.txt | 23 +- CMakeModules/CopyCitraQt5Deps.cmake | 2 +- dist/citra-qt.6 | 40 - dist/citra.6 | 49 - dist/citra.desktop | 14 - dist/citra.icns | Bin 211056 -> 0 bytes dist/citra.ico | Bin 370070 -> 0 bytes dist/citra.svg | 2 - dist/citra.xml | 59 - dist/doc-icon.png | Bin 7768 -> 0 bytes dist/icons/checked.png | Bin 451 -> 0 bytes dist/icons/failed.png | Bin 428 -> 0 bytes dist/icons/icons.qrc | 6 - dist/qt_themes/qdarkstyle/rc/Hmovetoolbar.png | Bin 220 -> 0 bytes dist/qt_themes/qdarkstyle/rc/Hsepartoolbar.png | Bin 172 -> 0 bytes dist/qt_themes/qdarkstyle/rc/Vmovetoolbar.png | Bin 228 -> 0 bytes dist/qt_themes/qdarkstyle/rc/Vsepartoolbar.png | Bin 187 -> 0 bytes dist/qt_themes/qdarkstyle/rc/branch_closed-on.png | Bin 147 -> 0 bytes dist/qt_themes/qdarkstyle/rc/branch_closed.png | Bin 160 -> 0 bytes dist/qt_themes/qdarkstyle/rc/branch_open-on.png | Bin 150 -> 0 bytes dist/qt_themes/qdarkstyle/rc/branch_open.png | Bin 166 -> 0 bytes dist/qt_themes/qdarkstyle/rc/checkbox_checked.png | Bin 492 -> 0 bytes .../qdarkstyle/rc/checkbox_checked_disabled.png | Bin 491 -> 0 bytes .../qdarkstyle/rc/checkbox_checked_focus.png | Bin 252 -> 0 bytes .../qdarkstyle/rc/checkbox_indeterminate.png | Bin 493 -> 0 bytes .../rc/checkbox_indeterminate_disabled.png | Bin 492 -> 0 bytes .../qdarkstyle/rc/checkbox_indeterminate_focus.png | Bin 249 -> 0 bytes .../qt_themes/qdarkstyle/rc/checkbox_unchecked.png | Bin 464 -> 0 bytes .../qdarkstyle/rc/checkbox_unchecked_disabled.png | Bin 464 -> 0 bytes .../qdarkstyle/rc/checkbox_unchecked_focus.png | Bin 240 -> 0 bytes dist/qt_themes/qdarkstyle/rc/close-hover.png | Bin 598 -> 0 bytes dist/qt_themes/qdarkstyle/rc/close-pressed.png | Bin 598 -> 0 bytes dist/qt_themes/qdarkstyle/rc/close.png | Bin 586 -> 0 bytes dist/qt_themes/qdarkstyle/rc/down_arrow.png | Bin 165 -> 0 bytes .../qdarkstyle/rc/down_arrow_disabled.png | Bin 166 -> 0 bytes dist/qt_themes/qdarkstyle/rc/left_arrow.png | Bin 166 -> 0 bytes .../qdarkstyle/rc/left_arrow_disabled.png | Bin 166 -> 0 bytes dist/qt_themes/qdarkstyle/rc/radio_checked.png | Bin 940 -> 0 bytes .../qdarkstyle/rc/radio_checked_disabled.png | Bin 972 -> 0 bytes .../qdarkstyle/rc/radio_checked_focus.png | Bin 846 -> 0 bytes dist/qt_themes/qdarkstyle/rc/radio_unchecked.png | Bin 728 -> 0 bytes .../qdarkstyle/rc/radio_unchecked_disabled.png | Bin 760 -> 0 bytes .../qdarkstyle/rc/radio_unchecked_focus.png | Bin 646 -> 0 bytes dist/qt_themes/qdarkstyle/rc/right_arrow.png | Bin 160 -> 0 bytes .../qdarkstyle/rc/right_arrow_disabled.png | Bin 160 -> 0 bytes dist/qt_themes/qdarkstyle/rc/sizegrip.png | Bin 129 -> 0 bytes .../qdarkstyle/rc/stylesheet-branch-end.png | Bin 224 -> 0 bytes .../qdarkstyle/rc/stylesheet-branch-more.png | Bin 182 -> 0 bytes dist/qt_themes/qdarkstyle/rc/stylesheet-vline.png | Bin 239 -> 0 bytes dist/qt_themes/qdarkstyle/rc/transparent.png | Bin 195 -> 0 bytes dist/qt_themes/qdarkstyle/rc/undock.png | Bin 578 -> 0 bytes dist/qt_themes/qdarkstyle/rc/up_arrow.png | Bin 158 -> 0 bytes dist/qt_themes/qdarkstyle/rc/up_arrow_disabled.png | Bin 159 -> 0 bytes dist/qt_themes/qdarkstyle/style.qrc | 46 - dist/qt_themes/qdarkstyle/style.qss | 1268 -- externals/CMakeLists.txt | 37 - externals/json/README.md | 7 - externals/json/json.hpp | 14516 ------------------- src/CMakeLists.txt | 9 +- src/audio_core/CMakeLists.txt | 44 - src/audio_core/audio_core.cpp | 61 - src/audio_core/audio_core.h | 31 - src/audio_core/codec.cpp | 127 - src/audio_core/codec.h | 51 - src/audio_core/hle/common.h | 34 - src/audio_core/hle/dsp.cpp | 172 - src/audio_core/hle/dsp.h | 595 - src/audio_core/hle/filter.cpp | 117 - src/audio_core/hle/filter.h | 117 - src/audio_core/hle/mixers.cpp | 210 - src/audio_core/hle/mixers.h | 61 - src/audio_core/hle/pipe.cpp | 177 - src/audio_core/hle/pipe.h | 63 - src/audio_core/hle/source.cpp | 349 - src/audio_core/hle/source.h | 149 - src/audio_core/interpolate.cpp | 76 - src/audio_core/interpolate.h | 49 - src/audio_core/null_sink.h | 34 - src/audio_core/sdl2_sink.cpp | 147 - src/audio_core/sdl2_sink.h | 34 - src/audio_core/sink.h | 45 - src/audio_core/sink_details.cpp | 42 - src/audio_core/sink_details.h | 29 - src/audio_core/time_stretch.cpp | 143 - src/audio_core/time_stretch.h | 60 - src/citra/CMakeLists.txt | 35 - src/citra/citra.cpp | 175 - src/citra/citra.rc | 17 - src/citra/config.cpp | 160 - src/citra/config.h | 24 - src/citra/default_ini.h | 179 - src/citra/emu_window/emu_window_sdl2.cpp | 177 - src/citra/emu_window/emu_window_sdl2.h | 59 - src/citra/resource.h | 16 - src/citra_qt/CMakeLists.txt | 116 - src/citra_qt/Info.plist | 40 - src/citra_qt/bootmanager.cpp | 310 - src/citra_qt/bootmanager.h | 162 - src/citra_qt/citra-qt.rc | 19 - src/citra_qt/configuration/config.cpp | 326 - src/citra_qt/configuration/config.h | 30 - src/citra_qt/configuration/configure.ui | 147 - src/citra_qt/configuration/configure_audio.cpp | 77 - src/citra_qt/configuration/configure_audio.h | 30 - src/citra_qt/configuration/configure_audio.ui | 73 - src/citra_qt/configuration/configure_debug.cpp | 26 - src/citra_qt/configuration/configure_debug.h | 28 - src/citra_qt/configuration/configure_debug.ui | 109 - src/citra_qt/configuration/configure_dialog.cpp | 28 - src/citra_qt/configuration/configure_dialog.h | 28 - src/citra_qt/configuration/configure_general.cpp | 47 - src/citra_qt/configuration/configure_general.h | 28 - src/citra_qt/configuration/configure_general.ui | 199 - src/citra_qt/configuration/configure_graphics.cpp | 115 - src/citra_qt/configuration/configure_graphics.h | 28 - src/citra_qt/configuration/configure_graphics.ui | 207 - src/citra_qt/configuration/configure_input.cpp | 199 - src/citra_qt/configuration/configure_input.h | 69 - src/citra_qt/configuration/configure_input.ui | 592 - src/citra_qt/configuration/configure_system.cpp | 77 - src/citra_qt/configuration/configure_system.h | 38 - src/citra_qt/configuration/configure_system.ui | 278 - src/citra_qt/configuration/configure_web.cpp | 102 - src/citra_qt/configuration/configure_web.h | 40 - src/citra_qt/configuration/configure_web.ui | 190 - src/citra_qt/debugger/graphics/graphics.cpp | 77 - src/citra_qt/debugger/graphics/graphics.h | 41 - .../graphics/graphics_breakpoint_observer.cpp | 27 - .../graphics/graphics_breakpoint_observer.h | 33 - .../debugger/graphics/graphics_breakpoints.cpp | 213 - .../debugger/graphics/graphics_breakpoints.h | 46 - .../debugger/graphics/graphics_breakpoints_p.h | 36 - .../debugger/graphics/graphics_cmdlists.cpp | 259 - src/citra_qt/debugger/graphics/graphics_cmdlists.h | 61 - .../debugger/graphics/graphics_surface.cpp | 713 - src/citra_qt/debugger/graphics/graphics_surface.h | 118 - .../debugger/graphics/graphics_tracing.cpp | 177 - src/citra_qt/debugger/graphics/graphics_tracing.h | 33 - .../debugger/graphics/graphics_vertex_shader.cpp | 622 - .../debugger/graphics/graphics_vertex_shader.h | 88 - src/citra_qt/debugger/profiler.cpp | 224 - src/citra_qt/debugger/profiler.h | 27 - src/citra_qt/debugger/registers.cpp | 190 - src/citra_qt/debugger/registers.h | 42 - src/citra_qt/debugger/registers.ui | 40 - src/citra_qt/debugger/wait_tree.cpp | 417 - src/citra_qt/debugger/wait_tree.h | 187 - src/citra_qt/game_list.cpp | 422 - src/citra_qt/game_list.h | 101 - src/citra_qt/game_list_p.h | 143 - src/citra_qt/hotkeys.cpp | 90 - src/citra_qt/hotkeys.h | 64 - src/citra_qt/hotkeys.ui | 46 - src/citra_qt/main.cpp | 877 -- src/citra_qt/main.h | 174 - src/citra_qt/main.ui | 201 - src/citra_qt/ui_settings.cpp | 10 - src/citra_qt/ui_settings.h | 56 - src/citra_qt/util/spinbox.cpp | 278 - src/citra_qt/util/spinbox.h | 86 - src/citra_qt/util/util.cpp | 26 - src/citra_qt/util/util.h | 14 - src/network/CMakeLists.txt | 18 - src/network/network.cpp | 50 - src/network/network.h | 25 - src/network/packet.cpp | 263 - src/network/packet.h | 166 - src/network/room.cpp | 497 - src/network/room.h | 101 - src/network/room_member.cpp | 490 - src/network/room_member.h | 182 - src/web_service/CMakeLists.txt | 16 - src/web_service/telemetry_json.cpp | 86 - src/web_service/telemetry_json.h | 59 - src/web_service/verify_login.cpp | 28 - src/web_service/verify_login.h | 24 - src/web_service/web_backend.cpp | 140 - src/web_service/web_backend.h | 39 - src/yuzu/CMakeLists.txt | 116 + src/yuzu/Info.plist | 40 + src/yuzu/bootmanager.cpp | 310 + src/yuzu/bootmanager.h | 162 + src/yuzu/citra-qt.rc | 19 + src/yuzu/configuration/config.cpp | 326 + src/yuzu/configuration/config.h | 30 + src/yuzu/configuration/configure.ui | 147 + src/yuzu/configuration/configure_audio.cpp | 77 + src/yuzu/configuration/configure_audio.h | 30 + src/yuzu/configuration/configure_audio.ui | 73 + src/yuzu/configuration/configure_debug.cpp | 26 + src/yuzu/configuration/configure_debug.h | 28 + src/yuzu/configuration/configure_debug.ui | 109 + src/yuzu/configuration/configure_dialog.cpp | 28 + src/yuzu/configuration/configure_dialog.h | 28 + src/yuzu/configuration/configure_general.cpp | 47 + src/yuzu/configuration/configure_general.h | 28 + src/yuzu/configuration/configure_general.ui | 199 + src/yuzu/configuration/configure_graphics.cpp | 115 + src/yuzu/configuration/configure_graphics.h | 28 + src/yuzu/configuration/configure_graphics.ui | 207 + src/yuzu/configuration/configure_input.cpp | 199 + src/yuzu/configuration/configure_input.h | 69 + src/yuzu/configuration/configure_input.ui | 592 + src/yuzu/configuration/configure_system.cpp | 77 + src/yuzu/configuration/configure_system.h | 38 + src/yuzu/configuration/configure_system.ui | 278 + src/yuzu/configuration/configure_web.cpp | 102 + src/yuzu/configuration/configure_web.h | 40 + src/yuzu/configuration/configure_web.ui | 190 + src/yuzu/debugger/graphics/graphics.cpp | 77 + src/yuzu/debugger/graphics/graphics.h | 41 + .../graphics/graphics_breakpoint_observer.cpp | 27 + .../graphics/graphics_breakpoint_observer.h | 33 + .../debugger/graphics/graphics_breakpoints.cpp | 213 + src/yuzu/debugger/graphics/graphics_breakpoints.h | 46 + .../debugger/graphics/graphics_breakpoints_p.h | 36 + src/yuzu/debugger/graphics/graphics_cmdlists.cpp | 259 + src/yuzu/debugger/graphics/graphics_cmdlists.h | 61 + src/yuzu/debugger/graphics/graphics_surface.cpp | 713 + src/yuzu/debugger/graphics/graphics_surface.h | 118 + src/yuzu/debugger/graphics/graphics_tracing.cpp | 177 + src/yuzu/debugger/graphics/graphics_tracing.h | 33 + .../debugger/graphics/graphics_vertex_shader.cpp | 622 + .../debugger/graphics/graphics_vertex_shader.h | 88 + src/yuzu/debugger/profiler.cpp | 224 + src/yuzu/debugger/profiler.h | 27 + src/yuzu/debugger/registers.cpp | 190 + src/yuzu/debugger/registers.h | 42 + src/yuzu/debugger/registers.ui | 40 + src/yuzu/debugger/wait_tree.cpp | 417 + src/yuzu/debugger/wait_tree.h | 187 + src/yuzu/game_list.cpp | 422 + src/yuzu/game_list.h | 101 + src/yuzu/game_list_p.h | 143 + src/yuzu/hotkeys.cpp | 90 + src/yuzu/hotkeys.h | 64 + src/yuzu/hotkeys.ui | 46 + src/yuzu/main.cpp | 877 ++ src/yuzu/main.h | 174 + src/yuzu/main.ui | 201 + src/yuzu/ui_settings.cpp | 10 + src/yuzu/ui_settings.h | 56 + src/yuzu/util/spinbox.cpp | 278 + src/yuzu/util/spinbox.h | 86 + src/yuzu/util/util.cpp | 26 + src/yuzu/util/util.h | 14 + src/yuzu_cmd/CMakeLists.txt | 35 + src/yuzu_cmd/citra.cpp | 175 + src/yuzu_cmd/citra.rc | 17 + src/yuzu_cmd/config.cpp | 160 + src/yuzu_cmd/config.h | 24 + src/yuzu_cmd/default_ini.h | 179 + src/yuzu_cmd/emu_window/emu_window_sdl2.cpp | 177 + src/yuzu_cmd/emu_window/emu_window_sdl2.h | 59 + src/yuzu_cmd/resource.h | 16 + 256 files changed, 10863 insertions(+), 32146 deletions(-) delete mode 100644 dist/citra-qt.6 delete mode 100644 dist/citra.6 delete mode 100644 dist/citra.desktop delete mode 100644 dist/citra.icns delete mode 100644 dist/citra.ico delete mode 100644 dist/citra.svg delete mode 100644 dist/citra.xml delete mode 100644 dist/doc-icon.png delete mode 100644 dist/icons/checked.png delete mode 100644 dist/icons/failed.png delete mode 100644 dist/icons/icons.qrc delete mode 100644 dist/qt_themes/qdarkstyle/rc/Hmovetoolbar.png delete mode 100644 dist/qt_themes/qdarkstyle/rc/Hsepartoolbar.png delete mode 100644 dist/qt_themes/qdarkstyle/rc/Vmovetoolbar.png delete mode 100644 dist/qt_themes/qdarkstyle/rc/Vsepartoolbar.png delete mode 100644 dist/qt_themes/qdarkstyle/rc/branch_closed-on.png delete mode 100644 dist/qt_themes/qdarkstyle/rc/branch_closed.png delete mode 100644 dist/qt_themes/qdarkstyle/rc/branch_open-on.png delete mode 100644 dist/qt_themes/qdarkstyle/rc/branch_open.png delete mode 100644 dist/qt_themes/qdarkstyle/rc/checkbox_checked.png delete mode 100644 dist/qt_themes/qdarkstyle/rc/checkbox_checked_disabled.png delete mode 100644 dist/qt_themes/qdarkstyle/rc/checkbox_checked_focus.png delete mode 100644 dist/qt_themes/qdarkstyle/rc/checkbox_indeterminate.png delete mode 100644 dist/qt_themes/qdarkstyle/rc/checkbox_indeterminate_disabled.png delete mode 100644 dist/qt_themes/qdarkstyle/rc/checkbox_indeterminate_focus.png delete mode 100644 dist/qt_themes/qdarkstyle/rc/checkbox_unchecked.png delete mode 100644 dist/qt_themes/qdarkstyle/rc/checkbox_unchecked_disabled.png delete mode 100644 dist/qt_themes/qdarkstyle/rc/checkbox_unchecked_focus.png delete mode 100644 dist/qt_themes/qdarkstyle/rc/close-hover.png delete mode 100644 dist/qt_themes/qdarkstyle/rc/close-pressed.png delete mode 100644 dist/qt_themes/qdarkstyle/rc/close.png delete mode 100644 dist/qt_themes/qdarkstyle/rc/down_arrow.png delete mode 100644 dist/qt_themes/qdarkstyle/rc/down_arrow_disabled.png delete mode 100644 dist/qt_themes/qdarkstyle/rc/left_arrow.png delete mode 100644 dist/qt_themes/qdarkstyle/rc/left_arrow_disabled.png delete mode 100644 dist/qt_themes/qdarkstyle/rc/radio_checked.png delete mode 100644 dist/qt_themes/qdarkstyle/rc/radio_checked_disabled.png delete mode 100644 dist/qt_themes/qdarkstyle/rc/radio_checked_focus.png delete mode 100644 dist/qt_themes/qdarkstyle/rc/radio_unchecked.png delete mode 100644 dist/qt_themes/qdarkstyle/rc/radio_unchecked_disabled.png delete mode 100644 dist/qt_themes/qdarkstyle/rc/radio_unchecked_focus.png delete mode 100644 dist/qt_themes/qdarkstyle/rc/right_arrow.png delete mode 100644 dist/qt_themes/qdarkstyle/rc/right_arrow_disabled.png delete mode 100644 dist/qt_themes/qdarkstyle/rc/sizegrip.png delete mode 100644 dist/qt_themes/qdarkstyle/rc/stylesheet-branch-end.png delete mode 100644 dist/qt_themes/qdarkstyle/rc/stylesheet-branch-more.png delete mode 100644 dist/qt_themes/qdarkstyle/rc/stylesheet-vline.png delete mode 100644 dist/qt_themes/qdarkstyle/rc/transparent.png delete mode 100644 dist/qt_themes/qdarkstyle/rc/undock.png delete mode 100644 dist/qt_themes/qdarkstyle/rc/up_arrow.png delete mode 100644 dist/qt_themes/qdarkstyle/rc/up_arrow_disabled.png delete mode 100644 dist/qt_themes/qdarkstyle/style.qrc delete mode 100644 dist/qt_themes/qdarkstyle/style.qss delete mode 100644 externals/json/README.md delete mode 100644 externals/json/json.hpp delete mode 100644 src/audio_core/CMakeLists.txt delete mode 100644 src/audio_core/audio_core.cpp delete mode 100644 src/audio_core/audio_core.h delete mode 100644 src/audio_core/codec.cpp delete mode 100644 src/audio_core/codec.h delete mode 100644 src/audio_core/hle/common.h delete mode 100644 src/audio_core/hle/dsp.cpp delete mode 100644 src/audio_core/hle/dsp.h delete mode 100644 src/audio_core/hle/filter.cpp delete mode 100644 src/audio_core/hle/filter.h delete mode 100644 src/audio_core/hle/mixers.cpp delete mode 100644 src/audio_core/hle/mixers.h delete mode 100644 src/audio_core/hle/pipe.cpp delete mode 100644 src/audio_core/hle/pipe.h delete mode 100644 src/audio_core/hle/source.cpp delete mode 100644 src/audio_core/hle/source.h delete mode 100644 src/audio_core/interpolate.cpp delete mode 100644 src/audio_core/interpolate.h delete mode 100644 src/audio_core/null_sink.h delete mode 100644 src/audio_core/sdl2_sink.cpp delete mode 100644 src/audio_core/sdl2_sink.h delete mode 100644 src/audio_core/sink.h delete mode 100644 src/audio_core/sink_details.cpp delete mode 100644 src/audio_core/sink_details.h delete mode 100644 src/audio_core/time_stretch.cpp delete mode 100644 src/audio_core/time_stretch.h delete mode 100644 src/citra/CMakeLists.txt delete mode 100644 src/citra/citra.cpp delete mode 100644 src/citra/citra.rc delete mode 100644 src/citra/config.cpp delete mode 100644 src/citra/config.h delete mode 100644 src/citra/default_ini.h delete mode 100644 src/citra/emu_window/emu_window_sdl2.cpp delete mode 100644 src/citra/emu_window/emu_window_sdl2.h delete mode 100644 src/citra/resource.h delete mode 100644 src/citra_qt/CMakeLists.txt delete mode 100644 src/citra_qt/Info.plist delete mode 100644 src/citra_qt/bootmanager.cpp delete mode 100644 src/citra_qt/bootmanager.h delete mode 100644 src/citra_qt/citra-qt.rc delete mode 100644 src/citra_qt/configuration/config.cpp delete mode 100644 src/citra_qt/configuration/config.h delete mode 100644 src/citra_qt/configuration/configure.ui delete mode 100644 src/citra_qt/configuration/configure_audio.cpp delete mode 100644 src/citra_qt/configuration/configure_audio.h delete mode 100644 src/citra_qt/configuration/configure_audio.ui delete mode 100644 src/citra_qt/configuration/configure_debug.cpp delete mode 100644 src/citra_qt/configuration/configure_debug.h delete mode 100644 src/citra_qt/configuration/configure_debug.ui delete mode 100644 src/citra_qt/configuration/configure_dialog.cpp delete mode 100644 src/citra_qt/configuration/configure_dialog.h delete mode 100644 src/citra_qt/configuration/configure_general.cpp delete mode 100644 src/citra_qt/configuration/configure_general.h delete mode 100644 src/citra_qt/configuration/configure_general.ui delete mode 100644 src/citra_qt/configuration/configure_graphics.cpp delete mode 100644 src/citra_qt/configuration/configure_graphics.h delete mode 100644 src/citra_qt/configuration/configure_graphics.ui delete mode 100644 src/citra_qt/configuration/configure_input.cpp delete mode 100644 src/citra_qt/configuration/configure_input.h delete mode 100644 src/citra_qt/configuration/configure_input.ui delete mode 100644 src/citra_qt/configuration/configure_system.cpp delete mode 100644 src/citra_qt/configuration/configure_system.h delete mode 100644 src/citra_qt/configuration/configure_system.ui delete mode 100644 src/citra_qt/configuration/configure_web.cpp delete mode 100644 src/citra_qt/configuration/configure_web.h delete mode 100644 src/citra_qt/configuration/configure_web.ui delete mode 100644 src/citra_qt/debugger/graphics/graphics.cpp delete mode 100644 src/citra_qt/debugger/graphics/graphics.h delete mode 100644 src/citra_qt/debugger/graphics/graphics_breakpoint_observer.cpp delete mode 100644 src/citra_qt/debugger/graphics/graphics_breakpoint_observer.h delete mode 100644 src/citra_qt/debugger/graphics/graphics_breakpoints.cpp delete mode 100644 src/citra_qt/debugger/graphics/graphics_breakpoints.h delete mode 100644 src/citra_qt/debugger/graphics/graphics_breakpoints_p.h delete mode 100644 src/citra_qt/debugger/graphics/graphics_cmdlists.cpp delete mode 100644 src/citra_qt/debugger/graphics/graphics_cmdlists.h delete mode 100644 src/citra_qt/debugger/graphics/graphics_surface.cpp delete mode 100644 src/citra_qt/debugger/graphics/graphics_surface.h delete mode 100644 src/citra_qt/debugger/graphics/graphics_tracing.cpp delete mode 100644 src/citra_qt/debugger/graphics/graphics_tracing.h delete mode 100644 src/citra_qt/debugger/graphics/graphics_vertex_shader.cpp delete mode 100644 src/citra_qt/debugger/graphics/graphics_vertex_shader.h delete mode 100644 src/citra_qt/debugger/profiler.cpp delete mode 100644 src/citra_qt/debugger/profiler.h delete mode 100644 src/citra_qt/debugger/registers.cpp delete mode 100644 src/citra_qt/debugger/registers.h delete mode 100644 src/citra_qt/debugger/registers.ui delete mode 100644 src/citra_qt/debugger/wait_tree.cpp delete mode 100644 src/citra_qt/debugger/wait_tree.h delete mode 100644 src/citra_qt/game_list.cpp delete mode 100644 src/citra_qt/game_list.h delete mode 100644 src/citra_qt/game_list_p.h delete mode 100644 src/citra_qt/hotkeys.cpp delete mode 100644 src/citra_qt/hotkeys.h delete mode 100644 src/citra_qt/hotkeys.ui delete mode 100644 src/citra_qt/main.cpp delete mode 100644 src/citra_qt/main.h delete mode 100644 src/citra_qt/main.ui delete mode 100644 src/citra_qt/ui_settings.cpp delete mode 100644 src/citra_qt/ui_settings.h delete mode 100644 src/citra_qt/util/spinbox.cpp delete mode 100644 src/citra_qt/util/spinbox.h delete mode 100644 src/citra_qt/util/util.cpp delete mode 100644 src/citra_qt/util/util.h delete mode 100644 src/network/CMakeLists.txt delete mode 100644 src/network/network.cpp delete mode 100644 src/network/network.h delete mode 100644 src/network/packet.cpp delete mode 100644 src/network/packet.h delete mode 100644 src/network/room.cpp delete mode 100644 src/network/room.h delete mode 100644 src/network/room_member.cpp delete mode 100644 src/network/room_member.h delete mode 100644 src/web_service/CMakeLists.txt delete mode 100644 src/web_service/telemetry_json.cpp delete mode 100644 src/web_service/telemetry_json.h delete mode 100644 src/web_service/verify_login.cpp delete mode 100644 src/web_service/verify_login.h delete mode 100644 src/web_service/web_backend.cpp delete mode 100644 src/web_service/web_backend.h create mode 100644 src/yuzu/CMakeLists.txt create mode 100644 src/yuzu/Info.plist create mode 100644 src/yuzu/bootmanager.cpp create mode 100644 src/yuzu/bootmanager.h create mode 100644 src/yuzu/citra-qt.rc create mode 100644 src/yuzu/configuration/config.cpp create mode 100644 src/yuzu/configuration/config.h create mode 100644 src/yuzu/configuration/configure.ui create mode 100644 src/yuzu/configuration/configure_audio.cpp create mode 100644 src/yuzu/configuration/configure_audio.h create mode 100644 src/yuzu/configuration/configure_audio.ui create mode 100644 src/yuzu/configuration/configure_debug.cpp create mode 100644 src/yuzu/configuration/configure_debug.h create mode 100644 src/yuzu/configuration/configure_debug.ui create mode 100644 src/yuzu/configuration/configure_dialog.cpp create mode 100644 src/yuzu/configuration/configure_dialog.h create mode 100644 src/yuzu/configuration/configure_general.cpp create mode 100644 src/yuzu/configuration/configure_general.h create mode 100644 src/yuzu/configuration/configure_general.ui create mode 100644 src/yuzu/configuration/configure_graphics.cpp create mode 100644 src/yuzu/configuration/configure_graphics.h create mode 100644 src/yuzu/configuration/configure_graphics.ui create mode 100644 src/yuzu/configuration/configure_input.cpp create mode 100644 src/yuzu/configuration/configure_input.h create mode 100644 src/yuzu/configuration/configure_input.ui create mode 100644 src/yuzu/configuration/configure_system.cpp create mode 100644 src/yuzu/configuration/configure_system.h create mode 100644 src/yuzu/configuration/configure_system.ui create mode 100644 src/yuzu/configuration/configure_web.cpp create mode 100644 src/yuzu/configuration/configure_web.h create mode 100644 src/yuzu/configuration/configure_web.ui create mode 100644 src/yuzu/debugger/graphics/graphics.cpp create mode 100644 src/yuzu/debugger/graphics/graphics.h create mode 100644 src/yuzu/debugger/graphics/graphics_breakpoint_observer.cpp create mode 100644 src/yuzu/debugger/graphics/graphics_breakpoint_observer.h create mode 100644 src/yuzu/debugger/graphics/graphics_breakpoints.cpp create mode 100644 src/yuzu/debugger/graphics/graphics_breakpoints.h create mode 100644 src/yuzu/debugger/graphics/graphics_breakpoints_p.h create mode 100644 src/yuzu/debugger/graphics/graphics_cmdlists.cpp create mode 100644 src/yuzu/debugger/graphics/graphics_cmdlists.h create mode 100644 src/yuzu/debugger/graphics/graphics_surface.cpp create mode 100644 src/yuzu/debugger/graphics/graphics_surface.h create mode 100644 src/yuzu/debugger/graphics/graphics_tracing.cpp create mode 100644 src/yuzu/debugger/graphics/graphics_tracing.h create mode 100644 src/yuzu/debugger/graphics/graphics_vertex_shader.cpp create mode 100644 src/yuzu/debugger/graphics/graphics_vertex_shader.h create mode 100644 src/yuzu/debugger/profiler.cpp create mode 100644 src/yuzu/debugger/profiler.h create mode 100644 src/yuzu/debugger/registers.cpp create mode 100644 src/yuzu/debugger/registers.h create mode 100644 src/yuzu/debugger/registers.ui create mode 100644 src/yuzu/debugger/wait_tree.cpp create mode 100644 src/yuzu/debugger/wait_tree.h create mode 100644 src/yuzu/game_list.cpp create mode 100644 src/yuzu/game_list.h create mode 100644 src/yuzu/game_list_p.h create mode 100644 src/yuzu/hotkeys.cpp create mode 100644 src/yuzu/hotkeys.h create mode 100644 src/yuzu/hotkeys.ui create mode 100644 src/yuzu/main.cpp create mode 100644 src/yuzu/main.h create mode 100644 src/yuzu/main.ui create mode 100644 src/yuzu/ui_settings.cpp create mode 100644 src/yuzu/ui_settings.h create mode 100644 src/yuzu/util/spinbox.cpp create mode 100644 src/yuzu/util/spinbox.h create mode 100644 src/yuzu/util/util.cpp create mode 100644 src/yuzu/util/util.h create mode 100644 src/yuzu_cmd/CMakeLists.txt create mode 100644 src/yuzu_cmd/citra.cpp create mode 100644 src/yuzu_cmd/citra.rc create mode 100644 src/yuzu_cmd/config.cpp create mode 100644 src/yuzu_cmd/config.h create mode 100644 src/yuzu_cmd/default_ini.h create mode 100644 src/yuzu_cmd/emu_window/emu_window_sdl2.cpp create mode 100644 src/yuzu_cmd/emu_window/emu_window_sdl2.h create mode 100644 src/yuzu_cmd/resource.h diff --git a/.gitmodules b/.gitmodules index 87d156035..07479dd78 100644 --- a/.gitmodules +++ b/.gitmodules @@ -4,12 +4,6 @@ [submodule "boost"] path = externals/boost url = https://github.com/yuzu-emu/ext-boost.git -[submodule "nihstro"] - path = externals/nihstro - url = https://github.com/neobrain/nihstro.git -[submodule "soundtouch"] - path = externals/soundtouch - url = https://github.com/citra-emu/ext-soundtouch.git [submodule "catch"] path = externals/catch url = https://github.com/philsquared/Catch.git @@ -22,12 +16,6 @@ [submodule "fmt"] path = externals/fmt url = https://github.com/fmtlib/fmt.git -[submodule "enet"] - path = externals/enet - url = https://github.com/lsalzman/enet -[submodule "cpr"] - path = externals/cpr - url = https://github.com/whoshuu/cpr.git [submodule "lz4"] path = externals/lz4 url = http://github.com/lz4/lz4.git diff --git a/CMakeLists.txt b/CMakeLists.txt index b2fd0ca81..5dd11b6a4 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -4,7 +4,7 @@ list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/CMakeModules") list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/externals/cmake-modules") include(DownloadExternals) -project(citra) +project(yuzu) option(ENABLE_SDL2 "Enable the SDL2 frontend" ON) option(CITRA_USE_BUNDLED_SDL2 "Download bundled SDL2 binaries" OFF) @@ -14,17 +14,6 @@ option(CITRA_USE_BUNDLED_QT "Download bundled Qt binaries" OFF) option(YUZU_USE_BUNDLED_UNICORN "Download bundled Unicorn binaries" OFF) -option(ENABLE_WEB_SERVICE "Enable web services (telemetry, etc.)" ON) -option(CITRA_USE_BUNDLED_CURL "FOR MINGW ONLY: Download curl configured against winssl instead of openssl" OFF) -if (ENABLE_WEB_SERVICE AND CITRA_USE_BUNDLED_CURL AND WINDOWS AND MSVC) - message("Turning off use bundled curl as msvc can compile curl on cpr") - SET(CITRA_USE_BUNDLED_CURL OFF CACHE BOOL "" FORCE) -endif() -if (ENABLE_WEB_SERVICE AND NOT CITRA_USE_BUNDLED_CURL AND MINGW) - message(AUTHOR_WARNING "Turning on CITRA_USE_BUNDLED_CURL. Override it only if you know what you are doing.") - SET(CITRA_USE_BUNDLED_CURL ON CACHE BOOL "" FORCE) -endif() - if(NOT EXISTS ${CMAKE_SOURCE_DIR}/.git/hooks/pre-commit) message(STATUS "Copying pre-commit hook") file(COPY hooks/pre-commit @@ -154,7 +143,6 @@ if(CMAKE_SYSTEM_NAME STREQUAL "Linux") add_definitions(-D_FILE_OFFSET_BITS=64) endif() -add_definitions(-DSINGLETHREADED) # CMake seems to only define _DEBUG on Windows set_property(DIRECTORY APPEND PROPERTY COMPILE_DEFINITIONS $<$:_DEBUG> $<$>:NDEBUG>) @@ -163,11 +151,6 @@ set_property(DIRECTORY APPEND PROPERTY # System imported libraries # ====================== -find_package(PNG QUIET) -if (NOT PNG_FOUND) - message(STATUS "libpng not found. Some debugging features have been disabled.") -endif() - find_package(Boost 1.63.0 QUIET) if (NOT Boost_FOUND) message(STATUS "Boost 1.63.0 or newer not found, falling back to externals") @@ -264,10 +247,6 @@ if (ENABLE_QT) find_package(Qt5 REQUIRED COMPONENTS Widgets OpenGL ${QT_PREFIX_HINT}) endif() -if (ENABLE_WEB_SERVICE) - add_definitions(-DENABLE_WEB_SERVICE) -endif() - # Platform-specific library requirements # ====================================== diff --git a/CMakeModules/CopyCitraQt5Deps.cmake b/CMakeModules/CopyCitraQt5Deps.cmake index 05f58cf9a..342d0b915 100644 --- a/CMakeModules/CopyCitraQt5Deps.cmake +++ b/CMakeModules/CopyCitraQt5Deps.cmake @@ -13,5 +13,5 @@ function(copy_citra_Qt5_deps target_dir) Qt5OpenGL$<$:d>.* Qt5Widgets$<$:d>.* ) - windows_copy_files(citra-qt ${Qt5_PLATFORMS_DIR} ${PLATFORMS} qwindows$<$:d>.*) + windows_copy_files(yuzu ${Qt5_PLATFORMS_DIR} ${PLATFORMS} qwindows$<$:d>.*) endfunction(copy_citra_Qt5_deps) diff --git a/dist/citra-qt.6 b/dist/citra-qt.6 deleted file mode 100644 index d09e96b5d..000000000 --- a/dist/citra-qt.6 +++ /dev/null @@ -1,40 +0,0 @@ -.Dd November 22 2016 -.Dt citra-qt 6 -.Os -.Sh NAME -.Nm Citra-Qt -.Nd Nintendo 3DS Emulator/Debugger (Qt) -.Sh SYNOPSIS -.Nm citra-qt -.Op Ar file -.Sh DESCRIPTION -Citra is an experimental open-source Nintendo 3DS emulator/debugger. -.Pp -.Nm citra-qt -is the Qt implementation. -.Sh FILES -.Bl -tag -width Ds -.It Pa $XDG_DATA_HOME/citra-emu -Emulator storage. -.It Pa $XDG_CONFIG_HOME/citra-emu -Configuration files. -.El -.Sh AUTHORS -This document is made available to you under the CC-BY license. -.Pp -Citra is made by a team of volunteers. These contributors are listed - at <\fBhttps://github.com/citra-emu/citra/contributors\fR>. -.Pp -.Sh SEE ALSO -.Bl -tag -width Ds -.It Xr citra 6 -The SDL frontend of the application -.El -.Pp -Resources are available for this project: -.Bl -tag -width Ds -.It <\fBhttps://citra-emu.org\fR> -The main homepage of the project. -.It <\fBhttps://github.com/citra-emu/citra\fR> -The main source code repository for the Citra emulator. -.Pp diff --git a/dist/citra.6 b/dist/citra.6 deleted file mode 100644 index 72483b1dd..000000000 --- a/dist/citra.6 +++ /dev/null @@ -1,49 +0,0 @@ -.Dd November 22 2016 -.Dt citra 6 -.Os -.Sh NAME -.Nm Citra -.Nd Nintendo 3DS Emulator/Debugger (SDL) -.Sh SYNOPSIS -.Nm citra -.Op Ar options -.Op Ar file -.Sh OPTIONS -.Bl -tag -width Ds -.It Fl g Ar port , Fl Fl gdbport Ar port -Starts the GDB stub on the specified port -.It Fl h , Fl Fl help -Shows syntax help and exits -.It Fl v , Fl Fl version -Describes the installed version and exits -.Sh DESCRIPTION -Citra is an experimental open-source Nintendo 3DS emulator/debugger. -.Pp -.Nm citra -is the Simple DirectMedia Layer (SDL) implementation. -.Sh FILES -.Bl -tag -width Ds -.It Pa $XDG_DATA_HOME/citra-emu -Emulator storage. -.It Pa $XDG_CONFIG_HOME/citra-emu -Configuration files. -.El -.Sh AUTHORS -This document is made available to you under the CC-BY license. -.Pp -Citra is made by a team of volunteers. These contributors are listed - at <\fBhttps://github.com/citra-emu/citra/contributors\fR>. -.Pp -.Sh SEE ALSO -.Bl -tag -width Ds -.It Xr citra-qt 6 -The Qt frontend of the application -.El -.Pp -Resources are available for this project: -.Bl -tag -width Ds -.It <\fBhttps://citra-emu.org\fR> -The main homepage of the project. -.It <\fBhttps://github.com/citra-emu/citra\fR> -The main source code repository for the Citra emulator. -.Pp diff --git a/dist/citra.desktop b/dist/citra.desktop deleted file mode 100644 index 1300d62c2..000000000 --- a/dist/citra.desktop +++ /dev/null @@ -1,14 +0,0 @@ -[Desktop Entry] -Version=1.0 -Type=Application -Name=Citra -GenericName=3DS Emulator -GenericName[fr]=Émulateur 3DS -Comment=Nintendo 3DS video game console emulator -Comment[fr]=Émulateur de console de jeu Nintendo 3DS -Icon=citra -TryExec=citra-qt -Exec=citra-qt %f -Categories=Game;Emulator;Qt; -MimeType=application/x-ctr-3dsx;application/x-ctr-cci;application/x-ctr-cia;application/x-ctr-cxi; -Keywords=3DS;Nintendo; diff --git a/dist/citra.icns b/dist/citra.icns deleted file mode 100644 index ef7bf4e6e..000000000 Binary files a/dist/citra.icns and /dev/null differ diff --git a/dist/citra.ico b/dist/citra.ico deleted file mode 100644 index 2c408b935..000000000 Binary files a/dist/citra.ico and /dev/null differ diff --git a/dist/citra.svg b/dist/citra.svg deleted file mode 100644 index b6abc1ccf..000000000 --- a/dist/citra.svg +++ /dev/null @@ -1,2 +0,0 @@ - -image/svg+xml diff --git a/dist/citra.xml b/dist/citra.xml deleted file mode 100644 index 6d47c8760..000000000 --- a/dist/citra.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - Nintendo 3DS homebrew executable - Exécutable non-officiel pour Nintendo 3DS  - 3DSX - - - - - - - Nintendo 3DS cartridge image - Image de cartouche Nintendo 3DS - CCI - CTR Cart Image - - - - - - - - Nintendo 3DS executable - Exécutable Nintendo 3DS - CXI - CTR eXecutable Image - - - - - - - Nintendo 3DS importable archive - Archive installable Nintendo 3DS - CIA - CTR Importable Archive - - - - - - Nintendo 3DS icon and metadata - Icône et métadonnées Nintendo 3DS - SMDH - System Menu Data Header - - - - - - Nintendo 3DS banner - Bannière Nintendo 3DS - CBMD - CTR Banner Model Data - - - - diff --git a/dist/doc-icon.png b/dist/doc-icon.png deleted file mode 100644 index 9b5773214..000000000 Binary files a/dist/doc-icon.png and /dev/null differ diff --git a/dist/icons/checked.png b/dist/icons/checked.png deleted file mode 100644 index c277e6b40..000000000 Binary files a/dist/icons/checked.png and /dev/null differ diff --git a/dist/icons/failed.png b/dist/icons/failed.png deleted file mode 100644 index ac10f174a..000000000 Binary files a/dist/icons/failed.png and /dev/null differ diff --git a/dist/icons/icons.qrc b/dist/icons/icons.qrc deleted file mode 100644 index f0c44862f..000000000 --- a/dist/icons/icons.qrc +++ /dev/null @@ -1,6 +0,0 @@ - - - checked.png - failed.png - - diff --git a/dist/qt_themes/qdarkstyle/rc/Hmovetoolbar.png b/dist/qt_themes/qdarkstyle/rc/Hmovetoolbar.png deleted file mode 100644 index cead99ed1..000000000 Binary files a/dist/qt_themes/qdarkstyle/rc/Hmovetoolbar.png and /dev/null differ diff --git a/dist/qt_themes/qdarkstyle/rc/Hsepartoolbar.png b/dist/qt_themes/qdarkstyle/rc/Hsepartoolbar.png deleted file mode 100644 index 7f183c8b3..000000000 Binary files a/dist/qt_themes/qdarkstyle/rc/Hsepartoolbar.png and /dev/null differ diff --git a/dist/qt_themes/qdarkstyle/rc/Vmovetoolbar.png b/dist/qt_themes/qdarkstyle/rc/Vmovetoolbar.png deleted file mode 100644 index 512edcecd..000000000 Binary files a/dist/qt_themes/qdarkstyle/rc/Vmovetoolbar.png and /dev/null differ diff --git a/dist/qt_themes/qdarkstyle/rc/Vsepartoolbar.png b/dist/qt_themes/qdarkstyle/rc/Vsepartoolbar.png deleted file mode 100644 index d9dc1561b..000000000 Binary files a/dist/qt_themes/qdarkstyle/rc/Vsepartoolbar.png and /dev/null differ diff --git a/dist/qt_themes/qdarkstyle/rc/branch_closed-on.png b/dist/qt_themes/qdarkstyle/rc/branch_closed-on.png deleted file mode 100644 index d081e9b3b..000000000 Binary files a/dist/qt_themes/qdarkstyle/rc/branch_closed-on.png and /dev/null differ diff --git a/dist/qt_themes/qdarkstyle/rc/branch_closed.png b/dist/qt_themes/qdarkstyle/rc/branch_closed.png deleted file mode 100644 index d652159a3..000000000 Binary files a/dist/qt_themes/qdarkstyle/rc/branch_closed.png and /dev/null differ diff --git a/dist/qt_themes/qdarkstyle/rc/branch_open-on.png b/dist/qt_themes/qdarkstyle/rc/branch_open-on.png deleted file mode 100644 index ec372b27d..000000000 Binary files a/dist/qt_themes/qdarkstyle/rc/branch_open-on.png and /dev/null differ diff --git a/dist/qt_themes/qdarkstyle/rc/branch_open.png b/dist/qt_themes/qdarkstyle/rc/branch_open.png deleted file mode 100644 index 66f8e1ac6..000000000 Binary files a/dist/qt_themes/qdarkstyle/rc/branch_open.png and /dev/null differ diff --git a/dist/qt_themes/qdarkstyle/rc/checkbox_checked.png b/dist/qt_themes/qdarkstyle/rc/checkbox_checked.png deleted file mode 100644 index 830cfee65..000000000 Binary files a/dist/qt_themes/qdarkstyle/rc/checkbox_checked.png and /dev/null differ diff --git a/dist/qt_themes/qdarkstyle/rc/checkbox_checked_disabled.png b/dist/qt_themes/qdarkstyle/rc/checkbox_checked_disabled.png deleted file mode 100644 index cb63cc2fa..000000000 Binary files a/dist/qt_themes/qdarkstyle/rc/checkbox_checked_disabled.png and /dev/null differ diff --git a/dist/qt_themes/qdarkstyle/rc/checkbox_checked_focus.png b/dist/qt_themes/qdarkstyle/rc/checkbox_checked_focus.png deleted file mode 100644 index 671be273b..000000000 Binary files a/dist/qt_themes/qdarkstyle/rc/checkbox_checked_focus.png and /dev/null differ diff --git a/dist/qt_themes/qdarkstyle/rc/checkbox_indeterminate.png b/dist/qt_themes/qdarkstyle/rc/checkbox_indeterminate.png deleted file mode 100644 index 41024f768..000000000 Binary files a/dist/qt_themes/qdarkstyle/rc/checkbox_indeterminate.png and /dev/null differ diff --git a/dist/qt_themes/qdarkstyle/rc/checkbox_indeterminate_disabled.png b/dist/qt_themes/qdarkstyle/rc/checkbox_indeterminate_disabled.png deleted file mode 100644 index abdc01d90..000000000 Binary files a/dist/qt_themes/qdarkstyle/rc/checkbox_indeterminate_disabled.png and /dev/null differ diff --git a/dist/qt_themes/qdarkstyle/rc/checkbox_indeterminate_focus.png b/dist/qt_themes/qdarkstyle/rc/checkbox_indeterminate_focus.png deleted file mode 100644 index 415f9b6e1..000000000 Binary files a/dist/qt_themes/qdarkstyle/rc/checkbox_indeterminate_focus.png and /dev/null differ diff --git a/dist/qt_themes/qdarkstyle/rc/checkbox_unchecked.png b/dist/qt_themes/qdarkstyle/rc/checkbox_unchecked.png deleted file mode 100644 index 2159aca9a..000000000 Binary files a/dist/qt_themes/qdarkstyle/rc/checkbox_unchecked.png and /dev/null differ diff --git a/dist/qt_themes/qdarkstyle/rc/checkbox_unchecked_disabled.png b/dist/qt_themes/qdarkstyle/rc/checkbox_unchecked_disabled.png deleted file mode 100644 index ade721e81..000000000 Binary files a/dist/qt_themes/qdarkstyle/rc/checkbox_unchecked_disabled.png and /dev/null differ diff --git a/dist/qt_themes/qdarkstyle/rc/checkbox_unchecked_focus.png b/dist/qt_themes/qdarkstyle/rc/checkbox_unchecked_focus.png deleted file mode 100644 index e4258cc47..000000000 Binary files a/dist/qt_themes/qdarkstyle/rc/checkbox_unchecked_focus.png and /dev/null differ diff --git a/dist/qt_themes/qdarkstyle/rc/close-hover.png b/dist/qt_themes/qdarkstyle/rc/close-hover.png deleted file mode 100644 index 657943a66..000000000 Binary files a/dist/qt_themes/qdarkstyle/rc/close-hover.png and /dev/null differ diff --git a/dist/qt_themes/qdarkstyle/rc/close-pressed.png b/dist/qt_themes/qdarkstyle/rc/close-pressed.png deleted file mode 100644 index 937d00598..000000000 Binary files a/dist/qt_themes/qdarkstyle/rc/close-pressed.png and /dev/null differ diff --git a/dist/qt_themes/qdarkstyle/rc/close.png b/dist/qt_themes/qdarkstyle/rc/close.png deleted file mode 100644 index bc0f57610..000000000 Binary files a/dist/qt_themes/qdarkstyle/rc/close.png and /dev/null differ diff --git a/dist/qt_themes/qdarkstyle/rc/down_arrow.png b/dist/qt_themes/qdarkstyle/rc/down_arrow.png deleted file mode 100644 index e271f7f90..000000000 Binary files a/dist/qt_themes/qdarkstyle/rc/down_arrow.png and /dev/null differ diff --git a/dist/qt_themes/qdarkstyle/rc/down_arrow_disabled.png b/dist/qt_themes/qdarkstyle/rc/down_arrow_disabled.png deleted file mode 100644 index 5805d9842..000000000 Binary files a/dist/qt_themes/qdarkstyle/rc/down_arrow_disabled.png and /dev/null differ diff --git a/dist/qt_themes/qdarkstyle/rc/left_arrow.png b/dist/qt_themes/qdarkstyle/rc/left_arrow.png deleted file mode 100644 index f808d2d72..000000000 Binary files a/dist/qt_themes/qdarkstyle/rc/left_arrow.png and /dev/null differ diff --git a/dist/qt_themes/qdarkstyle/rc/left_arrow_disabled.png b/dist/qt_themes/qdarkstyle/rc/left_arrow_disabled.png deleted file mode 100644 index f5b9af8a3..000000000 Binary files a/dist/qt_themes/qdarkstyle/rc/left_arrow_disabled.png and /dev/null differ diff --git a/dist/qt_themes/qdarkstyle/rc/radio_checked.png b/dist/qt_themes/qdarkstyle/rc/radio_checked.png deleted file mode 100644 index 235e6b0ba..000000000 Binary files a/dist/qt_themes/qdarkstyle/rc/radio_checked.png and /dev/null differ diff --git a/dist/qt_themes/qdarkstyle/rc/radio_checked_disabled.png b/dist/qt_themes/qdarkstyle/rc/radio_checked_disabled.png deleted file mode 100644 index bf0051ede..000000000 Binary files a/dist/qt_themes/qdarkstyle/rc/radio_checked_disabled.png and /dev/null differ diff --git a/dist/qt_themes/qdarkstyle/rc/radio_checked_focus.png b/dist/qt_themes/qdarkstyle/rc/radio_checked_focus.png deleted file mode 100644 index 700c6b525..000000000 Binary files a/dist/qt_themes/qdarkstyle/rc/radio_checked_focus.png and /dev/null differ diff --git a/dist/qt_themes/qdarkstyle/rc/radio_unchecked.png b/dist/qt_themes/qdarkstyle/rc/radio_unchecked.png deleted file mode 100644 index 9a4def65c..000000000 Binary files a/dist/qt_themes/qdarkstyle/rc/radio_unchecked.png and /dev/null differ diff --git a/dist/qt_themes/qdarkstyle/rc/radio_unchecked_disabled.png b/dist/qt_themes/qdarkstyle/rc/radio_unchecked_disabled.png deleted file mode 100644 index 6ece890e7..000000000 Binary files a/dist/qt_themes/qdarkstyle/rc/radio_unchecked_disabled.png and /dev/null differ diff --git a/dist/qt_themes/qdarkstyle/rc/radio_unchecked_focus.png b/dist/qt_themes/qdarkstyle/rc/radio_unchecked_focus.png deleted file mode 100644 index 564e022d3..000000000 Binary files a/dist/qt_themes/qdarkstyle/rc/radio_unchecked_focus.png and /dev/null differ diff --git a/dist/qt_themes/qdarkstyle/rc/right_arrow.png b/dist/qt_themes/qdarkstyle/rc/right_arrow.png deleted file mode 100644 index 9b0a4e6a7..000000000 Binary files a/dist/qt_themes/qdarkstyle/rc/right_arrow.png and /dev/null differ diff --git a/dist/qt_themes/qdarkstyle/rc/right_arrow_disabled.png b/dist/qt_themes/qdarkstyle/rc/right_arrow_disabled.png deleted file mode 100644 index 5c0bee402..000000000 Binary files a/dist/qt_themes/qdarkstyle/rc/right_arrow_disabled.png and /dev/null differ diff --git a/dist/qt_themes/qdarkstyle/rc/sizegrip.png b/dist/qt_themes/qdarkstyle/rc/sizegrip.png deleted file mode 100644 index 350583aaa..000000000 Binary files a/dist/qt_themes/qdarkstyle/rc/sizegrip.png and /dev/null differ diff --git a/dist/qt_themes/qdarkstyle/rc/stylesheet-branch-end.png b/dist/qt_themes/qdarkstyle/rc/stylesheet-branch-end.png deleted file mode 100644 index cb5d3b51f..000000000 Binary files a/dist/qt_themes/qdarkstyle/rc/stylesheet-branch-end.png and /dev/null differ diff --git a/dist/qt_themes/qdarkstyle/rc/stylesheet-branch-more.png b/dist/qt_themes/qdarkstyle/rc/stylesheet-branch-more.png deleted file mode 100644 index 62711409d..000000000 Binary files a/dist/qt_themes/qdarkstyle/rc/stylesheet-branch-more.png and /dev/null differ diff --git a/dist/qt_themes/qdarkstyle/rc/stylesheet-vline.png b/dist/qt_themes/qdarkstyle/rc/stylesheet-vline.png deleted file mode 100644 index 87536cce1..000000000 Binary files a/dist/qt_themes/qdarkstyle/rc/stylesheet-vline.png and /dev/null differ diff --git a/dist/qt_themes/qdarkstyle/rc/transparent.png b/dist/qt_themes/qdarkstyle/rc/transparent.png deleted file mode 100644 index 483df2513..000000000 Binary files a/dist/qt_themes/qdarkstyle/rc/transparent.png and /dev/null differ diff --git a/dist/qt_themes/qdarkstyle/rc/undock.png b/dist/qt_themes/qdarkstyle/rc/undock.png deleted file mode 100644 index 88691d779..000000000 Binary files a/dist/qt_themes/qdarkstyle/rc/undock.png and /dev/null differ diff --git a/dist/qt_themes/qdarkstyle/rc/up_arrow.png b/dist/qt_themes/qdarkstyle/rc/up_arrow.png deleted file mode 100644 index abcc72452..000000000 Binary files a/dist/qt_themes/qdarkstyle/rc/up_arrow.png and /dev/null differ diff --git a/dist/qt_themes/qdarkstyle/rc/up_arrow_disabled.png b/dist/qt_themes/qdarkstyle/rc/up_arrow_disabled.png deleted file mode 100644 index b9c8e3b53..000000000 Binary files a/dist/qt_themes/qdarkstyle/rc/up_arrow_disabled.png and /dev/null differ diff --git a/dist/qt_themes/qdarkstyle/style.qrc b/dist/qt_themes/qdarkstyle/style.qrc deleted file mode 100644 index ac14bc501..000000000 --- a/dist/qt_themes/qdarkstyle/style.qrc +++ /dev/null @@ -1,46 +0,0 @@ - - - rc/up_arrow_disabled.png - rc/Hmovetoolbar.png - rc/stylesheet-branch-end.png - rc/branch_closed-on.png - rc/stylesheet-vline.png - rc/branch_closed.png - rc/branch_open-on.png - rc/transparent.png - rc/right_arrow_disabled.png - rc/sizegrip.png - rc/close.png - rc/close-hover.png - rc/close-pressed.png - rc/down_arrow.png - rc/Vmovetoolbar.png - rc/left_arrow.png - rc/stylesheet-branch-more.png - rc/up_arrow.png - rc/right_arrow.png - rc/left_arrow_disabled.png - rc/Hsepartoolbar.png - rc/branch_open.png - rc/Vsepartoolbar.png - rc/down_arrow_disabled.png - rc/undock.png - rc/checkbox_checked_disabled.png - rc/checkbox_checked_focus.png - rc/checkbox_checked.png - rc/checkbox_indeterminate.png - rc/checkbox_indeterminate_focus.png - rc/checkbox_unchecked_disabled.png - rc/checkbox_unchecked_focus.png - rc/checkbox_unchecked.png - rc/radio_checked_disabled.png - rc/radio_checked_focus.png - rc/radio_checked.png - rc/radio_unchecked_disabled.png - rc/radio_unchecked_focus.png - rc/radio_unchecked.png - - - style.qss - - diff --git a/dist/qt_themes/qdarkstyle/style.qss b/dist/qt_themes/qdarkstyle/style.qss deleted file mode 100644 index c8e50312a..000000000 --- a/dist/qt_themes/qdarkstyle/style.qss +++ /dev/null @@ -1,1268 +0,0 @@ -/* - * The MIT License (MIT) - * - * Copyright (c) <2013-2014> - * - * 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. - */ -QToolTip -{ - border: 1px solid #76797C; - background-color: rgb(90, 102, 117);; - color: white; - padding: 5px; - opacity: 200; -} - -QWidget -{ - color: #eff0f1; - background-color: #31363b; - selection-background-color:#3daee9; - selection-color: #eff0f1; - background-clip: border; - border-image: none; - border: 0px transparent black; - outline: 0; -} - -QWidget:item:hover -{ - background-color: #18465d; - color: #eff0f1; -} - -QWidget:item:selected -{ - background-color: #18465d; -} - -QCheckBox -{ - spacing: 5px; - outline: none; - color: #eff0f1; - margin-bottom: 2px; -} - -QCheckBox:disabled -{ - color: #76797C; -} - -QCheckBox::indicator, -QGroupBox::indicator -{ - width: 18px; - height: 18px; -} -QGroupBox::indicator -{ - margin-left: 2px; -} - -QCheckBox::indicator:unchecked -{ - image: url(:/qss_icons/rc/checkbox_unchecked.png); -} - -QCheckBox::indicator:unchecked:hover, -QCheckBox::indicator:unchecked:focus, -QCheckBox::indicator:unchecked:pressed, -QGroupBox::indicator:unchecked:hover, -QGroupBox::indicator:unchecked:focus, -QGroupBox::indicator:unchecked:pressed -{ - border: none; - image: url(:/qss_icons/rc/checkbox_unchecked_focus.png); -} - -QCheckBox::indicator:checked -{ - image: url(:/qss_icons/rc/checkbox_checked.png); -} - -QCheckBox::indicator:checked:hover, -QCheckBox::indicator:checked:focus, -QCheckBox::indicator:checked:pressed, -QGroupBox::indicator:checked:hover, -QGroupBox::indicator:checked:focus, -QGroupBox::indicator:checked:pressed -{ - border: none; - image: url(:/qss_icons/rc/checkbox_checked_focus.png); -} - - -QCheckBox::indicator:indeterminate -{ - image: url(:/qss_icons/rc/checkbox_indeterminate.png); -} - -QCheckBox::indicator:indeterminate:focus, -QCheckBox::indicator:indeterminate:hover, -QCheckBox::indicator:indeterminate:pressed -{ - image: url(:/qss_icons/rc/checkbox_indeterminate_focus.png); -} - -QCheckBox::indicator:checked:disabled, -QGroupBox::indicator:checked:disabled -{ - image: url(:/qss_icons/rc/checkbox_checked_disabled.png); -} - -QCheckBox::indicator:unchecked:disabled, -QGroupBox::indicator:unchecked:disabled -{ - image: url(:/qss_icons/rc/checkbox_unchecked_disabled.png); -} - -QRadioButton -{ - spacing: 5px; - outline: none; - color: #eff0f1; - margin-bottom: 2px; -} - -QRadioButton:disabled -{ - color: #76797C; -} -QRadioButton::indicator -{ - width: 21px; - height: 21px; -} - -QRadioButton::indicator:unchecked -{ - image: url(:/qss_icons/rc/radio_unchecked.png); -} - - -QRadioButton::indicator:unchecked:hover, -QRadioButton::indicator:unchecked:focus, -QRadioButton::indicator:unchecked:pressed -{ - border: none; - outline: none; - image: url(:/qss_icons/rc/radio_unchecked_focus.png); -} - -QRadioButton::indicator:checked -{ - border: none; - outline: none; - image: url(:/qss_icons/rc/radio_checked.png); -} - -QRadioButton::indicator:checked:hover, -QRadioButton::indicator:checked:focus, -QRadioButton::indicator:checked:pressed -{ - border: none; - outline: none; - image: url(:/qss_icons/rc/radio_checked_focus.png); -} - -QRadioButton::indicator:checked:disabled -{ - outline: none; - image: url(:/qss_icons/rc/radio_checked_disabled.png); -} - -QRadioButton::indicator:unchecked:disabled -{ - image: url(:/qss_icons/rc/radio_unchecked_disabled.png); -} - - -QMenuBar -{ - background-color: #31363b; - color: #eff0f1; -} - -QMenuBar::item -{ - background: transparent; -} - -QMenuBar::item:selected -{ - background: transparent; - border: 1px solid #76797C; -} - -QMenuBar::item:pressed -{ - border: 1px solid #76797C; - background-color: #3daee9; - color: #eff0f1; - margin-bottom:-1px; - padding-bottom:1px; -} - -QMenu -{ - border: 1px solid #76797C; - color: #eff0f1; - margin: 2px; -} - -QMenu::icon -{ - margin: 5px; -} - -QMenu::item -{ - padding: 5px 30px 5px 30px; - margin-left: 5px; - border: 1px solid transparent; /* reserve space for selection border */ -} - -QMenu::item:selected -{ - color: #eff0f1; -} - -QMenu::separator { - height: 2px; - background: lightblue; - margin-left: 10px; - margin-right: 5px; -} - -QMenu::indicator { - width: 18px; - height: 18px; -} - -/* non-exclusive indicator = check box style indicator - (see QActionGroup::setExclusive) */ -QMenu::indicator:non-exclusive:unchecked { - image: url(:/qss_icons/rc/checkbox_unchecked.png); -} - -QMenu::indicator:non-exclusive:unchecked:selected { - image: url(:/qss_icons/rc/checkbox_unchecked_disabled.png); -} - -QMenu::indicator:non-exclusive:checked { - image: url(:/qss_icons/rc/checkbox_checked.png); -} - -QMenu::indicator:non-exclusive:checked:selected { - image: url(:/qss_icons/rc/checkbox_checked_disabled.png); -} - -/* exclusive indicator = radio button style indicator (see QActionGroup::setExclusive) */ -QMenu::indicator:exclusive:unchecked { - image: url(:/qss_icons/rc/radio_unchecked.png); -} - -QMenu::indicator:exclusive:unchecked:selected { - image: url(:/qss_icons/rc/radio_unchecked_disabled.png); -} - -QMenu::indicator:exclusive:checked { - image: url(:/qss_icons/rc/radio_checked.png); -} - -QMenu::indicator:exclusive:checked:selected { - image: url(:/qss_icons/rc/radio_checked_disabled.png); -} - -QMenu::right-arrow { - margin: 5px; - image: url(:/qss_icons/rc/right_arrow.png) -} - - -QWidget:disabled -{ - color: #454545; - background-color: #31363b; -} - -QAbstractItemView -{ - alternate-background-color: #31363b; - color: #eff0f1; - border: 1px solid 3A3939; - border-radius: 2px; -} - -QWidget:focus, QMenuBar:focus -{ - border: 1px solid #3daee9; -} - -QTabWidget:focus, QCheckBox:focus, QRadioButton:focus, QSlider:focus -{ - border: none; -} - -QLineEdit -{ - background-color: #232629; - padding: 5px; - border-style: solid; - border: 1px solid #76797C; - border-radius: 2px; - color: #eff0f1; -} - -QAbstractItemView QLineEdit -{ - padding: 0; -} - -QGroupBox { - border:1px solid #76797C; - border-radius: 2px; - margin-top: 20px; -} - -QGroupBox::title { - subcontrol-origin: margin; - subcontrol-position: top center; - padding-left: 10px; - padding-right: 10px; - padding-top: 10px; -} - -QAbstractScrollArea -{ - border-radius: 2px; - border: 1px solid #76797C; - background-color: transparent; -} - -QScrollBar:horizontal -{ - height: 15px; - margin: 3px 15px 3px 15px; - border: 1px transparent #2A2929; - border-radius: 4px; - background-color: #2A2929; -} - -QScrollBar::handle:horizontal -{ - background-color: #605F5F; - min-width: 5px; - border-radius: 4px; -} - -QScrollBar::add-line:horizontal -{ - margin: 0px 3px 0px 3px; - border-image: url(:/qss_icons/rc/right_arrow_disabled.png); - width: 10px; - height: 10px; - subcontrol-position: right; - subcontrol-origin: margin; -} - -QScrollBar::sub-line:horizontal -{ - margin: 0px 3px 0px 3px; - border-image: url(:/qss_icons/rc/left_arrow_disabled.png); - height: 10px; - width: 10px; - subcontrol-position: left; - subcontrol-origin: margin; -} - -QScrollBar::add-line:horizontal:hover,QScrollBar::add-line:horizontal:on -{ - border-image: url(:/qss_icons/rc/right_arrow.png); - height: 10px; - width: 10px; - subcontrol-position: right; - subcontrol-origin: margin; -} - - -QScrollBar::sub-line:horizontal:hover, QScrollBar::sub-line:horizontal:on -{ - border-image: url(:/qss_icons/rc/left_arrow.png); - height: 10px; - width: 10px; - subcontrol-position: left; - subcontrol-origin: margin; -} - -QScrollBar::up-arrow:horizontal, QScrollBar::down-arrow:horizontal -{ - background: none; -} - - -QScrollBar::add-page:horizontal, QScrollBar::sub-page:horizontal -{ - background: none; -} - -QScrollBar:vertical -{ - background-color: #2A2929; - width: 15px; - margin: 15px 3px 15px 3px; - border: 1px transparent #2A2929; - border-radius: 4px; -} - -QScrollBar::handle:vertical -{ - background-color: #605F5F; - min-height: 5px; - border-radius: 4px; -} - -QScrollBar::sub-line:vertical -{ - margin: 3px 0px 3px 0px; - border-image: url(:/qss_icons/rc/up_arrow_disabled.png); - height: 10px; - width: 10px; - subcontrol-position: top; - subcontrol-origin: margin; -} - -QScrollBar::add-line:vertical -{ - margin: 3px 0px 3px 0px; - border-image: url(:/qss_icons/rc/down_arrow_disabled.png); - height: 10px; - width: 10px; - subcontrol-position: bottom; - subcontrol-origin: margin; -} - -QScrollBar::sub-line:vertical:hover,QScrollBar::sub-line:vertical:on -{ - - border-image: url(:/qss_icons/rc/up_arrow.png); - height: 10px; - width: 10px; - subcontrol-position: top; - subcontrol-origin: margin; -} - - -QScrollBar::add-line:vertical:hover, QScrollBar::add-line:vertical:on -{ - border-image: url(:/qss_icons/rc/down_arrow.png); - height: 10px; - width: 10px; - subcontrol-position: bottom; - subcontrol-origin: margin; -} - -QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical -{ - background: none; -} - - -QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical -{ - background: none; -} - -QTextEdit -{ - background-color: #232629; - color: #eff0f1; - border: 1px solid #76797C; -} - -QPlainTextEdit -{ - background-color: #232629;; - color: #eff0f1; - border-radius: 2px; - border: 1px solid #76797C; -} - -QHeaderView::section -{ - background-color: #76797C; - color: #eff0f1; - padding: 5px; - border: 1px solid #76797C; -} - -QSizeGrip { - image: url(:/qss_icons/rc/sizegrip.png); - width: 12px; - height: 12px; -} - - -QMainWindow::separator -{ - background-color: #31363b; - color: white; - padding-left: 4px; - spacing: 2px; - border: 1px dashed #76797C; -} - -QMainWindow::separator:hover -{ - - background-color: #787876; - color: white; - padding-left: 4px; - border: 1px solid #76797C; - spacing: 2px; -} - - -QMenu::separator -{ - height: 1px; - background-color: #76797C; - color: white; - padding-left: 4px; - margin-left: 10px; - margin-right: 5px; -} - - -QFrame -{ - border-radius: 2px; - border: 1px solid #76797C; -} - -QFrame[frameShape="0"] -{ - border-radius: 2px; - border: 1px transparent #76797C; -} - -QStackedWidget -{ - border: 1px transparent black; -} - -QToolBar { - border: 1px transparent #393838; - background: 1px solid #31363b; - font-weight: bold; -} - -QToolBar::handle:horizontal { - image: url(:/qss_icons/rc/Hmovetoolbar.png); -} -QToolBar::handle:vertical { - image: url(:/qss_icons/rc/Vmovetoolbar.png); -} -QToolBar::separator:horizontal { - image: url(:/qss_icons/rc/Hsepartoolbar.png); -} -QToolBar::separator:vertical { - image: url(:/qss_icons/rc/Vsepartoolbar.png); -} -QToolButton#qt_toolbar_ext_button { - background: #58595a -} - -QPushButton -{ - color: #eff0f1; - background-color: #31363b; - border-width: 1px; - border-color: #76797C; - border-style: solid; - padding: 5px; - border-radius: 2px; - outline: none; -} - -QPushButton:disabled -{ - background-color: #31363b; - border-width: 1px; - border-color: #454545; - border-style: solid; - padding-top: 5px; - padding-bottom: 5px; - padding-left: 10px; - padding-right: 10px; - border-radius: 2px; - color: #454545; -} - -QPushButton:focus { - background-color: #3daee9; - color: white; -} - -QPushButton:pressed -{ - background-color: #3daee9; - padding-top: -15px; - padding-bottom: -17px; -} - -QComboBox -{ - selection-background-color: #3daee9; - border-style: solid; - border: 1px solid #76797C; - border-radius: 2px; - padding: 5px; - min-width: 75px; -} - -QPushButton:checked{ - background-color: #76797C; - border-color: #6A6969; -} - -QComboBox:hover,QPushButton:hover,QAbstractSpinBox:hover,QLineEdit:hover,QTextEdit:hover,QPlainTextEdit:hover,QAbstractView:hover,QTreeView:hover -{ - border: 1px solid #3daee9; - color: #eff0f1; -} - -QComboBox:on -{ - padding-top: 3px; - padding-left: 4px; - selection-background-color: #4a4a4a; -} - -QComboBox QAbstractItemView -{ - background-color: #232629; - border-radius: 2px; - border: 1px solid #76797C; - selection-background-color: #18465d; -} - -QComboBox::drop-down -{ - subcontrol-origin: padding; - subcontrol-position: top right; - width: 15px; - - border-left-width: 0px; - border-left-color: darkgray; - border-left-style: solid; - border-top-right-radius: 3px; - border-bottom-right-radius: 3px; -} - -QComboBox::down-arrow -{ - image: url(:/qss_icons/rc/down_arrow_disabled.png); -} - -QComboBox::down-arrow:on, QComboBox::down-arrow:hover, -QComboBox::down-arrow:focus -{ - image: url(:/qss_icons/rc/down_arrow.png); -} - -QAbstractSpinBox { - padding: 5px; - border: 1px solid #76797C; - background-color: #232629; - color: #eff0f1; - border-radius: 2px; - min-width: 75px; -} - -QAbstractSpinBox:up-button -{ - background-color: transparent; - subcontrol-origin: border; - subcontrol-position: center right; -} - -QAbstractSpinBox:down-button -{ - background-color: transparent; - subcontrol-origin: border; - subcontrol-position: center left; -} - -QAbstractSpinBox::up-arrow,QAbstractSpinBox::up-arrow:disabled,QAbstractSpinBox::up-arrow:off { - image: url(:/qss_icons/rc/up_arrow_disabled.png); - width: 10px; - height: 10px; -} -QAbstractSpinBox::up-arrow:hover -{ - image: url(:/qss_icons/rc/up_arrow.png); -} - - -QAbstractSpinBox::down-arrow,QAbstractSpinBox::down-arrow:disabled,QAbstractSpinBox::down-arrow:off -{ - image: url(:/qss_icons/rc/down_arrow_disabled.png); - width: 10px; - height: 10px; -} -QAbstractSpinBox::down-arrow:hover -{ - image: url(:/qss_icons/rc/down_arrow.png); -} - - -QLabel -{ - border: 0px solid black; -} - -QTabWidget{ - border: 0px transparent black; -} - -QTabWidget::pane { - border: 1px solid #76797C; - padding: 5px; - margin: 0px; -} - -QTabWidget::tab-bar { - left: 5px; /* move to the right by 5px */ -} - -QTabBar -{ - qproperty-drawBase: 0; - border-radius: 3px; -} - -QTabBar:focus -{ - border: 0px transparent black; -} - -QTabBar::close-button { - image: url(:/qss_icons/rc/close.png); - background: transparent; -} - -QTabBar::close-button:hover -{ - image: url(:/qss_icons/rc/close-hover.png); - background: transparent; -} - -QTabBar::close-button:pressed { - image: url(:/qss_icons/rc/close-pressed.png); - background: transparent; -} - -/* TOP TABS */ -QTabBar::tab:top { - color: #eff0f1; - border: 1px solid #76797C; - border-bottom: 1px transparent black; - background-color: #31363b; - padding: 5px; - min-width: 50px; - border-top-left-radius: 2px; - border-top-right-radius: 2px; -} - -QTabBar::tab:top:!selected -{ - color: #eff0f1; - background-color: #54575B; - border: 1px solid #76797C; - border-bottom: 1px transparent black; - border-top-left-radius: 2px; - border-top-right-radius: 2px; -} - -QTabBar::tab:top:!selected:hover { - background-color: #3daee9; -} - -/* BOTTOM TABS */ -QTabBar::tab:bottom { - color: #eff0f1; - border: 1px solid #76797C; - border-top: 1px transparent black; - background-color: #31363b; - padding: 5px; - border-bottom-left-radius: 2px; - border-bottom-right-radius: 2px; - min-width: 50px; -} - -QTabBar::tab:bottom:!selected -{ - color: #eff0f1; - background-color: #54575B; - border: 1px solid #76797C; - border-top: 1px transparent black; - border-bottom-left-radius: 2px; - border-bottom-right-radius: 2px; -} - -QTabBar::tab:bottom:!selected:hover { - background-color: #3daee9; -} - -/* LEFT TABS */ -QTabBar::tab:left { - color: #eff0f1; - border: 1px solid #76797C; - border-left: 1px transparent black; - background-color: #31363b; - padding: 5px; - border-top-right-radius: 2px; - border-bottom-right-radius: 2px; - min-height: 50px; -} - -QTabBar::tab:left:!selected -{ - color: #eff0f1; - background-color: #54575B; - border: 1px solid #76797C; - border-left: 1px transparent black; - border-top-right-radius: 2px; - border-bottom-right-radius: 2px; -} - -QTabBar::tab:left:!selected:hover { - background-color: #3daee9; -} - - -/* RIGHT TABS */ -QTabBar::tab:right { - color: #eff0f1; - border: 1px solid #76797C; - border-right: 1px transparent black; - background-color: #31363b; - padding: 5px; - border-top-left-radius: 2px; - border-bottom-left-radius: 2px; - min-height: 50px; -} - -QTabBar::tab:right:!selected -{ - color: #eff0f1; - background-color: #54575B; - border: 1px solid #76797C; - border-right: 1px transparent black; - border-top-left-radius: 2px; - border-bottom-left-radius: 2px; -} - -QTabBar::tab:right:!selected:hover { - background-color: #3daee9; -} - -QTabBar QToolButton::right-arrow:enabled { - image: url(:/qss_icons/rc/right_arrow.png); - } - - QTabBar QToolButton::left-arrow:enabled { - image: url(:/qss_icons/rc/left_arrow.png); - } - -QTabBar QToolButton::right-arrow:disabled { - image: url(:/qss_icons/rc/right_arrow_disabled.png); - } - - QTabBar QToolButton::left-arrow:disabled { - image: url(:/qss_icons/rc/left_arrow_disabled.png); - } - - -QDockWidget { - background: #31363b; - border: 1px solid #403F3F; - titlebar-close-icon: url(:/qss_icons/rc/close.png); - titlebar-normal-icon: url(:/qss_icons/rc/undock.png); -} - -QDockWidget::close-button, QDockWidget::float-button { - border: 1px solid transparent; - border-radius: 2px; - background: transparent; -} - -QDockWidget::close-button:hover, QDockWidget::float-button:hover { - background: rgba(255, 255, 255, 10); -} - -QDockWidget::close-button:pressed, QDockWidget::float-button:pressed { - padding: 1px -1px -1px 1px; - background: rgba(255, 255, 255, 10); -} - -QTreeView, QListView -{ - border: 1px solid #76797C; - background-color: #232629; -} - -QTreeView:branch:selected, QTreeView:branch:hover -{ - background: url(:/qss_icons/rc/transparent.png); -} - -QTreeView::branch:has-siblings:!adjoins-item { - border-image: url(:/qss_icons/rc/transparent.png); -} - -QTreeView::branch:has-siblings:adjoins-item { - border-image: url(:/qss_icons/rc/transparent.png); -} - -QTreeView::branch:!has-children:!has-siblings:adjoins-item { - border-image: url(:/qss_icons/rc/transparent.png); -} - -QTreeView::branch:has-children:!has-siblings:closed, -QTreeView::branch:closed:has-children:has-siblings { - image: url(:/qss_icons/rc/branch_closed.png); -} - -QTreeView::branch:open:has-children:!has-siblings, -QTreeView::branch:open:has-children:has-siblings { - image: url(:/qss_icons/rc/branch_open.png); -} - -QTreeView::branch:has-children:!has-siblings:closed:hover, -QTreeView::branch:closed:has-children:has-siblings:hover { - image: url(:/qss_icons/rc/branch_closed-on.png); - } - -QTreeView::branch:open:has-children:!has-siblings:hover, -QTreeView::branch:open:has-children:has-siblings:hover { - image: url(:/qss_icons/rc/branch_open-on.png); - } - -QListView::item:!selected:hover, QTreeView::item:!selected:hover { - background: #18465d; - outline: 0; - color: #eff0f1 -} - -QListView::item:selected:hover, QTreeView::item:selected:hover { - background: #287399; - color: #eff0f1; -} - -QSlider::groove:horizontal { - border: 1px solid #565a5e; - height: 4px; - background: #565a5e; - margin: 0px; - border-radius: 2px; -} - -QSlider::handle:horizontal { - background: #232629; - border: 1px solid #565a5e; - width: 16px; - height: 16px; - margin: -8px 0; - border-radius: 9px; -} - -QSlider::groove:vertical { - border: 1px solid #565a5e; - width: 4px; - background: #565a5e; - margin: 0px; - border-radius: 3px; -} - -QSlider::handle:vertical { - background: #232629; - border: 1px solid #565a5e; - width: 16px; - height: 16px; - margin: 0 -8px; - border-radius: 9px; -} - -QToolButton { - background-color: transparent; - border: 1px transparent #76797C; - border-radius: 2px; - margin: 3px; - padding: 5px; -} - -QToolButton[popupMode="1"] { /* only for MenuButtonPopup */ - padding-right: 20px; /* make way for the popup button */ - border: 1px #76797C; - border-radius: 5px; -} - -QToolButton[popupMode="2"] { /* only for InstantPopup */ - padding-right: 10px; /* make way for the popup button */ - border: 1px #76797C; -} - - -QToolButton:hover, QToolButton::menu-button:hover { - background-color: transparent; - border: 1px solid #3daee9; - padding: 5px; -} - -QToolButton:checked, QToolButton:pressed, - QToolButton::menu-button:pressed { - background-color: #3daee9; - border: 1px solid #3daee9; - padding: 5px; -} - -/* the subcontrol below is used only in the InstantPopup or DelayedPopup mode */ -QToolButton::menu-indicator { - image: url(:/qss_icons/rc/down_arrow.png); - top: -7px; left: -2px; /* shift it a bit */ -} - -/* the subcontrols below are used only in the MenuButtonPopup mode */ -QToolButton::menu-button { - border: 1px transparent #76797C; - border-top-right-radius: 6px; - border-bottom-right-radius: 6px; - /* 16px width + 4px for border = 20px allocated above */ - width: 16px; - outline: none; -} - -QToolButton::menu-arrow { - image: url(:/qss_icons/rc/down_arrow.png); -} - -QToolButton::menu-arrow:open { - border: 1px solid #76797C; -} - -QPushButton::menu-indicator { - subcontrol-origin: padding; - subcontrol-position: bottom right; - left: 8px; -} - -QTableView -{ - border: 1px solid #76797C; - gridline-color: #31363b; - background-color: #232629; -} - - -QTableView, QHeaderView -{ - border-radius: 0px; -} - -QTableView::item:pressed, QListView::item:pressed, QTreeView::item:pressed { - background: #18465d; - color: #eff0f1; -} - -QTableView::item:selected:active, QTreeView::item:selected:active, QListView::item:selected:active { - background: #287399; - color: #eff0f1; -} - - -QHeaderView -{ - background-color: #31363b; - border: 1px transparent; - border-radius: 0px; - margin: 0px; - padding: 0px; - -} - -QHeaderView::section { - background-color: #31363b; - color: #eff0f1; - padding: 5px; - border: 1px solid #76797C; - border-radius: 0px; - text-align: center; -} - -QHeaderView::section::vertical::first, QHeaderView::section::vertical::only-one -{ - border-top: 1px solid #76797C; -} - -QHeaderView::section::vertical -{ - border-top: transparent; -} - -QHeaderView::section::horizontal::first, QHeaderView::section::horizontal::only-one -{ - border-left: 1px solid #76797C; -} - -QHeaderView::section::horizontal -{ - border-left: transparent; -} - - -QHeaderView::section:checked - { - color: white; - background-color: #334e5e; - } - - /* style the sort indicator */ -QHeaderView::down-arrow { - image: url(:/qss_icons/rc/down_arrow.png); -} - -QHeaderView::up-arrow { - image: url(:/qss_icons/rc/up_arrow.png); -} - - -QTableCornerButton::section { - background-color: #31363b; - border: 1px transparent #76797C; - border-radius: 0px; -} - -QToolBox { - padding: 5px; - border: 1px transparent black; -} - -QToolBox::tab { - color: #eff0f1; - background-color: #31363b; - border: 1px solid #76797C; - border-bottom: 1px transparent #31363b; - border-top-left-radius: 5px; - border-top-right-radius: 5px; -} - -QToolBox::tab:selected { /* italicize selected tabs */ - font: italic; - background-color: #31363b; - border-color: #3daee9; - } - -QStatusBar::item { - border: 0px transparent dark; - } - - -QFrame[height="3"], QFrame[width="3"] { - background-color: #76797C; -} - - -QSplitter::handle { - border: 1px dashed #76797C; -} - -QSplitter::handle:hover { - background-color: #787876; - border: 1px solid #76797C; -} - -QSplitter::handle:horizontal { - width: 1px; -} - -QSplitter::handle:vertical { - height: 1px; -} - -QProgressBar { - border: 1px solid #76797C; - border-radius: 5px; - text-align: center; -} - -QProgressBar::chunk { - background-color: #05B8CC; -} - -QDateEdit -{ - selection-background-color: #3daee9; - border-style: solid; - border: 1px solid #3375A3; - border-radius: 2px; - padding: 1px; - min-width: 75px; -} - -QDateEdit:on -{ - padding-top: 3px; - padding-left: 4px; - selection-background-color: #4a4a4a; -} - -QDateEdit QAbstractItemView -{ - background-color: #232629; - border-radius: 2px; - border: 1px solid #3375A3; - selection-background-color: #3daee9; -} - -QDateEdit::drop-down -{ - subcontrol-origin: padding; - subcontrol-position: top right; - width: 15px; - border-left-width: 0px; - border-left-color: darkgray; - border-left-style: solid; - border-top-right-radius: 3px; - border-bottom-right-radius: 3px; -} - -QDateEdit::down-arrow -{ - image: url(:/qss_icons/rc/down_arrow_disabled.png); -} - -QDateEdit::down-arrow:on, QDateEdit::down-arrow:hover, -QDateEdit::down-arrow:focus -{ - image: url(:/qss_icons/rc/down_arrow.png); -} diff --git a/externals/CMakeLists.txt b/externals/CMakeLists.txt index 347641c10..ec3c70779 100644 --- a/externals/CMakeLists.txt +++ b/externals/CMakeLists.txt @@ -38,15 +38,6 @@ target_include_directories(lz4_static INTERFACE ./lz4/lib) add_library(microprofile INTERFACE) target_include_directories(microprofile INTERFACE ./microprofile) -# Nihstro -add_library(nihstro-headers INTERFACE) -target_include_directories(nihstro-headers INTERFACE ./nihstro/include) - -# SoundTouch -add_subdirectory(soundtouch) -# The SoundTouch target doesn't export the necessary include paths as properties by default -target_include_directories(SoundTouch INTERFACE ./soundtouch/include) - # Unicorn add_library(unicorn-headers INTERFACE) target_include_directories(unicorn-headers INTERFACE ./unicorn/include) @@ -58,31 +49,3 @@ if (ARCHITECTURE_x86_64) target_include_directories(xbyak INTERFACE ./xbyak/xbyak) target_compile_definitions(xbyak INTERFACE XBYAK_NO_OP_NAMES) endif() - -# ENet -add_subdirectory(enet) -target_include_directories(enet INTERFACE ./enet/include) - -if (ENABLE_WEB_SERVICE) - # msys installed curl is configured to use openssl, but that isn't portable - # since it relies on having the bundled certs install in the home folder for SSL - # by default on mingw, download the precompiled curl thats linked against windows native ssl - if (MINGW AND CITRA_USE_BUNDLED_CURL) - download_bundled_external("curl/" "curl-7_55_1" CURL_PREFIX) - set(CURL_PREFIX "${CMAKE_BINARY_DIR}/externals/curl-7_55_1") - set(CURL_FOUND YES) - set(CURL_INCLUDE_DIR "${CURL_PREFIX}/include" CACHE PATH "Path to curl headers") - set(CURL_LIBRARY "${CURL_PREFIX}/lib/libcurldll.a" CACHE PATH "Path to curl library") - set(CURL_DLL_DIR "${CURL_PREFIX}/lib/" CACHE PATH "Path to curl.dll") - set(USE_SYSTEM_CURL ON CACHE BOOL "") - endif() - # CPR - set(BUILD_TESTING OFF CACHE BOOL "") - set(BUILD_CPR_TESTS OFF CACHE BOOL "") - add_subdirectory(cpr) - target_include_directories(cpr INTERFACE ./cpr/include) - - # JSON - add_library(json-headers INTERFACE) - target_include_directories(json-headers INTERFACE ./json) -endif() diff --git a/externals/json/README.md b/externals/json/README.md deleted file mode 100644 index 764d5a1c0..000000000 --- a/externals/json/README.md +++ /dev/null @@ -1,7 +0,0 @@ -JSON for Modern C++ -=================== - -This is a mirror providing the single required header file. - -The original repository can be found at - https://github.com/nlohmann/json/commit/21d23982cafe826cae088b2bb37cb40c8e7a81fe diff --git a/externals/json/json.hpp b/externals/json/json.hpp deleted file mode 100644 index 1bde08ced..000000000 --- a/externals/json/json.hpp +++ /dev/null @@ -1,14516 +0,0 @@ -/* - __ _____ _____ _____ - __| | __| | | | JSON for Modern C++ -| | |__ | | | | | | version 2.1.1 -|_____|_____|_____|_|___| https://github.com/nlohmann/json - -Licensed under the MIT License . -Copyright (c) 2013-2017 Niels Lohmann . - -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. -*/ - -#ifndef NLOHMANN_JSON_HPP -#define NLOHMANN_JSON_HPP - -#include // all_of, copy, fill, find, for_each, none_of, remove, reverse, transform -#include // array -#include // assert -#include // and, not, or -#include // lconv, localeconv -#include // isfinite, labs, ldexp, signbit -#include // nullptr_t, ptrdiff_t, size_t -#include // int64_t, uint64_t -#include // abort, strtod, strtof, strtold, strtoul, strtoll, strtoull -#include // memcpy, strlen -#include // forward_list -#include // function, hash, less -#include // initializer_list -#include // hex -#include // istream, ostream -#include // advance, begin, back_inserter, bidirectional_iterator_tag, distance, end, inserter, iterator, iterator_traits, next, random_access_iterator_tag, reverse_iterator -#include // numeric_limits -#include // locale -#include // map -#include // addressof, allocator, allocator_traits, unique_ptr -#include // accumulate -#include // stringstream -#include // getline, stoi, string, to_string -#include // add_pointer, conditional, decay, enable_if, false_type, integral_constant, is_arithmetic, is_base_of, is_const, is_constructible, is_convertible, is_default_constructible, is_enum, is_floating_point, is_integral, is_nothrow_move_assignable, is_nothrow_move_constructible, is_pointer, is_reference, is_same, is_scalar, is_signed, remove_const, remove_cv, remove_pointer, remove_reference, true_type, underlying_type -#include // declval, forward, make_pair, move, pair, swap -#include // vector - -// exclude unsupported compilers -#if defined(__clang__) - #if (__clang_major__ * 10000 + __clang_minor__ * 100 + __clang_patchlevel__) < 30400 - #error "unsupported Clang version - see https://github.com/nlohmann/json#supported-compilers" - #endif -#elif defined(__GNUC__) - #if (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__) < 40900 - #error "unsupported GCC version - see https://github.com/nlohmann/json#supported-compilers" - #endif -#endif - -// disable float-equal warnings on GCC/clang -#if defined(__clang__) || defined(__GNUC__) || defined(__GNUG__) - #pragma GCC diagnostic push - #pragma GCC diagnostic ignored "-Wfloat-equal" -#endif - -// disable documentation warnings on clang -#if defined(__clang__) - #pragma GCC diagnostic push - #pragma GCC diagnostic ignored "-Wdocumentation" -#endif - -// allow for portable deprecation warnings -#if defined(__clang__) || defined(__GNUC__) || defined(__GNUG__) - #define JSON_DEPRECATED __attribute__((deprecated)) -#elif defined(_MSC_VER) - #define JSON_DEPRECATED __declspec(deprecated) -#else - #define JSON_DEPRECATED -#endif - -// allow to disable exceptions -#if (defined(__cpp_exceptions) || defined(__EXCEPTIONS) || defined(_CPPUNWIND)) && not defined(JSON_NOEXCEPTION) - #define JSON_THROW(exception) throw exception - #define JSON_TRY try - #define JSON_CATCH(exception) catch(exception) -#else - #define JSON_THROW(exception) std::abort() - #define JSON_TRY if(true) - #define JSON_CATCH(exception) if(false) -#endif - -// manual branch prediction -#if defined(__clang__) || defined(__GNUC__) || defined(__GNUG__) - #define JSON_LIKELY(x) __builtin_expect(!!(x), 1) - #define JSON_UNLIKELY(x) __builtin_expect(!!(x), 0) -#else - #define JSON_LIKELY(x) x - #define JSON_UNLIKELY(x) x -#endif - -/*! -@brief namespace for Niels Lohmann -@see https://github.com/nlohmann -@since version 1.0.0 -*/ -namespace nlohmann -{ - -/*! -@brief unnamed namespace with internal helper functions - -This namespace collects some functions that could not be defined inside the -@ref basic_json class. - -@since version 2.1.0 -*/ -namespace detail -{ -//////////////// -// exceptions // -//////////////// - -/*! -@brief general exception of the @ref basic_json class - -Extension of std::exception objects with a member @a id for exception ids. - -@note To have nothrow-copy-constructible exceptions, we internally use - std::runtime_error which can cope with arbitrary-length error messages. - Intermediate strings are built with static functions and then passed to - the actual constructor. - -@since version 3.0.0 -*/ -class exception : public std::exception -{ - public: - /// returns the explanatory string - virtual const char* what() const noexcept override - { - return m.what(); - } - - /// the id of the exception - const int id; - - protected: - exception(int id_, const char* what_arg) - : id(id_), m(what_arg) - {} - - static std::string name(const std::string& ename, int id) - { - return "[json.exception." + ename + "." + std::to_string(id) + "] "; - } - - private: - /// an exception object as storage for error messages - std::runtime_error m; -}; - -/*! -@brief exception indicating a parse error - -This excpetion is thrown by the library when a parse error occurs. Parse -errors can occur during the deserialization of JSON text as well as when -using JSON Patch. - -Member @a byte holds the byte index of the last read character in the input -file. - -@note For an input with n bytes, 1 is the index of the first character - and n+1 is the index of the terminating null byte or the end of - file. This also holds true when reading a byte vector (CBOR or - MessagePack). - -Exceptions have ids 1xx. - -name / id | example massage | description ------------------------------- | --------------- | ------------------------- -json.exception.parse_error.101 | parse error at 2: unexpected end of input; expected string literal | This error indicates a syntax error while deserializing a JSON text. The error message describes that an unexpected token (character) was encountered, and the member @a byte indicates the error position. -json.exception.parse_error.102 | parse error at 14: missing or wrong low surrogate | JSON uses the `\uxxxx` format to describe Unicode characters. Code points above above 0xFFFF are split into two `\uxxxx` entries ("surrogate pairs"). This error indicates that the surrogate pair is incomplete or contains an invalid code point. -json.exception.parse_error.103 | parse error: code points above 0x10FFFF are invalid | Unicode supports code points up to 0x10FFFF. Code points above 0x10FFFF are invalid. -json.exception.parse_error.104 | parse error: JSON patch must be an array of objects | [RFC 6902](https://tools.ietf.org/html/rfc6902) requires a JSON Patch document to be a JSON document that represents an array of objects. -json.exception.parse_error.105 | parse error: operation must have string member 'op' | An operation of a JSON Patch document must contain exactly one "op" member, whose value indicates the operation to perform. Its value must be one of "add", "remove", "replace", "move", "copy", or "test"; other values are errors. -json.exception.parse_error.106 | parse error: array index '01' must not begin with '0' | An array index in a JSON Pointer ([RFC 6901](https://tools.ietf.org/html/rfc6901)) may be `0` or any number wihtout a leading `0`. -json.exception.parse_error.107 | parse error: JSON pointer must be empty or begin with '/' - was: 'foo' | A JSON Pointer must be a Unicode string containing a sequence of zero or more reference tokens, each prefixed by a `/` character. -json.exception.parse_error.108 | parse error: escape character '~' must be followed with '0' or '1' | In a JSON Pointer, only `~0` and `~1` are valid escape sequences. -json.exception.parse_error.109 | parse error: array index 'one' is not a number | A JSON Pointer array index must be a number. -json.exception.parse_error.110 | parse error at 1: cannot read 2 bytes from vector | When parsing CBOR or MessagePack, the byte vector ends before the complete value has been read. -json.exception.parse_error.112 | parse error at 1: error reading CBOR; last byte: 0xf8 | Not all types of CBOR or MessagePack are supported. This exception occurs if an unsupported byte was read. -json.exception.parse_error.113 | parse error at 2: expected a CBOR string; last byte: 0x98 | While parsing a map key, a value that is not a string has been read. - -@since version 3.0.0 -*/ -class parse_error : public exception -{ - public: - /*! - @brief create a parse error exception - @param[in] id the id of the exception - @param[in] byte_ the byte index where the error occurred (or 0 if - the position cannot be determined) - @param[in] what_arg the explanatory string - @return parse_error object - */ - static parse_error create(int id, size_t byte_, const std::string& what_arg) - { - std::string w = exception::name("parse_error", id) + "parse error" + - (byte_ != 0 ? (" at " + std::to_string(byte_)) : "") + - ": " + what_arg; - return parse_error(id, byte_, w.c_str()); - } - - /*! - @brief byte index of the parse error - - The byte index of the last read character in the input file. - - @note For an input with n bytes, 1 is the index of the first character - and n+1 is the index of the terminating null byte or the end of - file. This also holds true when reading a byte vector (CBOR or - MessagePack). - */ - const size_t byte; - - private: - parse_error(int id_, size_t byte_, const char* what_arg) - : exception(id_, what_arg), byte(byte_) - {} -}; - -/*! -@brief exception indicating errors with iterators - -Exceptions have ids 2xx. - -name / id | example massage | description ------------------------------------ | --------------- | ------------------------- -json.exception.invalid_iterator.201 | iterators are not compatible | The iterators passed to constructor @ref basic_json(InputIT first, InputIT last) are not compatible, meaning they do not belong to the same container. Therefore, the range (@a first, @a last) is invalid. -json.exception.invalid_iterator.202 | iterator does not fit current value | In an erase or insert function, the passed iterator @a pos does not belong to the JSON value for which the function was called. It hence does not define a valid position for the deletion/insertion. -json.exception.invalid_iterator.203 | iterators do not fit current value | Either iterator passed to function @ref erase(IteratorType first, IteratorType last) does not belong to the JSON value from which values shall be erased. It hence does not define a valid range to delete values from. -json.exception.invalid_iterator.204 | iterators out of range | When an iterator range for a primitive type (number, boolean, or string) is passed to a constructor or an erase function, this range has to be exactly (@ref begin(), @ref end()), because this is the only way the single stored value is expressed. All other ranges are invalid. -json.exception.invalid_iterator.205 | iterator out of range | When an iterator for a primitive type (number, boolean, or string) is passed to an erase function, the iterator has to be the @ref begin() iterator, because it is the only way to address the stored value. All other iterators are invalid. -json.exception.invalid_iterator.206 | cannot construct with iterators from null | The iterators passed to constructor @ref basic_json(InputIT first, InputIT last) belong to a JSON null value and hence to not define a valid range. -json.exception.invalid_iterator.207 | cannot use key() for non-object iterators | The key() member function can only be used on iterators belonging to a JSON object, because other types do not have a concept of a key. -json.exception.invalid_iterator.208 | cannot use operator[] for object iterators | The operator[] to specify a concrete offset cannot be used on iterators belonging to a JSON object, because JSON objects are unordered. -json.exception.invalid_iterator.209 | cannot use offsets with object iterators | The offset operators (+, -, +=, -=) cannot be used on iterators belonging to a JSON object, because JSON objects are unordered. -json.exception.invalid_iterator.210 | iterators do not fit | The iterator range passed to the insert function are not compatible, meaning they do not belong to the same container. Therefore, the range (@a first, @a last) is invalid. -json.exception.invalid_iterator.211 | passed iterators may not belong to container | The iterator range passed to the insert function must not be a subrange of the container to insert to. -json.exception.invalid_iterator.212 | cannot compare iterators of different containers | When two iterators are compared, they must belong to the same container. -json.exception.invalid_iterator.213 | cannot compare order of object iterators | The order of object iterators cannot be compared, because JSON objects are unordered. -json.exception.invalid_iterator.214 | cannot get value | Cannot get value for iterator: Either the iterator belongs to a null value or it is an iterator to a primitive type (number, boolean, or string), but the iterator is different to @ref begin(). - -@since version 3.0.0 -*/ -class invalid_iterator : public exception -{ - public: - static invalid_iterator create(int id, const std::string& what_arg) - { - std::string w = exception::name("invalid_iterator", id) + what_arg; - return invalid_iterator(id, w.c_str()); - } - - private: - invalid_iterator(int id_, const char* what_arg) - : exception(id_, what_arg) - {} -}; - -/*! -@brief exception indicating executing a member function with a wrong type - -Exceptions have ids 3xx. - -name / id | example message | description ------------------------------ | --------------- | ------------------------- -json.exception.type_error.301 | cannot create object from initializer list | To create an object from an initializer list, the initializer list must consist only of a list of pairs whose first element is a string. When this constraint is violated, an array is created instead. -json.exception.type_error.302 | type must be object, but is array | During implicit or explicit value conversion, the JSON type must be compatible to the target type. For instance, a JSON string can only be converted into string types, but not into numbers or boolean types. -json.exception.type_error.303 | incompatible ReferenceType for get_ref, actual type is object | To retrieve a reference to a value stored in a @ref basic_json object with @ref get_ref, the type of the reference must match the value type. For instance, for a JSON array, the @a ReferenceType must be @ref array_t&. -json.exception.type_error.304 | cannot use at() with string | The @ref at() member functions can only be executed for certain JSON types. -json.exception.type_error.305 | cannot use operator[] with string | The @ref operator[] member functions can only be executed for certain JSON types. -json.exception.type_error.306 | cannot use value() with string | The @ref value() member functions can only be executed for certain JSON types. -json.exception.type_error.307 | cannot use erase() with string | The @ref erase() member functions can only be executed for certain JSON types. -json.exception.type_error.308 | cannot use push_back() with string | The @ref push_back() and @ref operator+= member functions can only be executed for certain JSON types. -json.exception.type_error.309 | cannot use insert() with | The @ref insert() member functions can only be executed for certain JSON types. -json.exception.type_error.310 | cannot use swap() with number | The @ref swap() member functions can only be executed for certain JSON types. -json.exception.type_error.311 | cannot use emplace_back() with string | The @ref emplace_back() member function can only be executed for certain JSON types. -json.exception.type_error.313 | invalid value to unflatten | The @ref unflatten function converts an object whose keys are JSON Pointers back into an arbitrary nested JSON value. The JSON Pointers must not overlap, because then the resulting value would not be well defined. -json.exception.type_error.314 | only objects can be unflattened | The @ref unflatten function only works for an object whose keys are JSON Pointers. -json.exception.type_error.315 | values in object must be primitive | The @ref unflatten function only works for an object whose keys are JSON Pointers and whose values are primitive. - -@since version 3.0.0 -*/ -class type_error : public exception -{ - public: - static type_error create(int id, const std::string& what_arg) - { - std::string w = exception::name("type_error", id) + what_arg; - return type_error(id, w.c_str()); - } - - private: - type_error(int id_, const char* what_arg) - : exception(id_, what_arg) - {} -}; - -/*! -@brief exception indicating access out of the defined range - -Exceptions have ids 4xx. - -name / id | example message | description -------------------------------- | --------------- | ------------------------- -json.exception.out_of_range.401 | array index 3 is out of range | The provided array index @a i is larger than @a size-1. -json.exception.out_of_range.402 | array index '-' (3) is out of range | The special array index `-` in a JSON Pointer never describes a valid element of the array, but the index past the end. That is, it can only be used to add elements at this position, but not to read it. -json.exception.out_of_range.403 | key 'foo' not found | The provided key was not found in the JSON object. -json.exception.out_of_range.404 | unresolved reference token 'foo' | A reference token in a JSON Pointer could not be resolved. -json.exception.out_of_range.405 | JSON pointer has no parent | The JSON Patch operations 'remove' and 'add' can not be applied to the root element of the JSON value. -json.exception.out_of_range.406 | number overflow parsing '10E1000' | A parsed number could not be stored as without changing it to NaN or INF. - -@since version 3.0.0 -*/ -class out_of_range : public exception -{ - public: - static out_of_range create(int id, const std::string& what_arg) - { - std::string w = exception::name("out_of_range", id) + what_arg; - return out_of_range(id, w.c_str()); - } - - private: - out_of_range(int id_, const char* what_arg) - : exception(id_, what_arg) - {} -}; - -/*! -@brief exception indicating other errors - -Exceptions have ids 5xx. - -name / id | example message | description ------------------------------- | --------------- | ------------------------- -json.exception.other_error.501 | unsuccessful: {"op":"test","path":"/baz", "value":"bar"} | A JSON Patch operation 'test' failed. The unsuccessful operation is also printed. -json.exception.other_error.502 | invalid object size for conversion | Some conversions to user-defined types impose constraints on the object size (e.g. std::pair) - -@since version 3.0.0 -*/ -class other_error : public exception -{ - public: - static other_error create(int id, const std::string& what_arg) - { - std::string w = exception::name("other_error", id) + what_arg; - return other_error(id, w.c_str()); - } - - private: - other_error(int id_, const char* what_arg) - : exception(id_, what_arg) - {} -}; - - - -/////////////////////////// -// JSON type enumeration // -/////////////////////////// - -/*! -@brief the JSON type enumeration - -This enumeration collects the different JSON types. It is internally used to -distinguish the stored values, and the functions @ref basic_json::is_null(), -@ref basic_json::is_object(), @ref basic_json::is_array(), -@ref basic_json::is_string(), @ref basic_json::is_boolean(), -@ref basic_json::is_number() (with @ref basic_json::is_number_integer(), -@ref basic_json::is_number_unsigned(), and @ref basic_json::is_number_float()), -@ref basic_json::is_discarded(), @ref basic_json::is_primitive(), and -@ref basic_json::is_structured() rely on it. - -@note There are three enumeration entries (number_integer, number_unsigned, and -number_float), because the library distinguishes these three types for numbers: -@ref basic_json::number_unsigned_t is used for unsigned integers, -@ref basic_json::number_integer_t is used for signed integers, and -@ref basic_json::number_float_t is used for floating-point numbers or to -approximate integers which do not fit in the limits of their respective type. - -@sa @ref basic_json::basic_json(const value_t value_type) -- create a JSON -value with the default value for a given type - -@since version 1.0.0 -*/ -enum class value_t : uint8_t -{ - null, ///< null value - object, ///< object (unordered set of name/value pairs) - array, ///< array (ordered collection of values) - string, ///< string value - boolean, ///< boolean value - number_integer, ///< number value (signed integer) - number_unsigned, ///< number value (unsigned integer) - number_float, ///< number value (floating-point) - discarded ///< discarded by the the parser callback function -}; - -/*! -@brief comparison operator for JSON types - -Returns an ordering that is similar to Python: -- order: null < boolean < number < object < array < string -- furthermore, each type is not smaller than itself - -@since version 1.0.0 -*/ -inline bool operator<(const value_t lhs, const value_t rhs) noexcept -{ - static constexpr std::array order = {{ - 0, // null - 3, // object - 4, // array - 5, // string - 1, // boolean - 2, // integer - 2, // unsigned - 2, // float - } - }; - - // discarded values are not comparable - if (lhs == value_t::discarded or rhs == value_t::discarded) - { - return false; - } - - return order[static_cast(lhs)] < - order[static_cast(rhs)]; -} - - -///////////// -// helpers // -///////////// - -// alias templates to reduce boilerplate -template -using enable_if_t = typename std::enable_if::type; - -template -using uncvref_t = typename std::remove_cv::type>::type; - -// implementation of C++14 index_sequence and affiliates -// source: https://stackoverflow.com/a/32223343 -template -struct index_sequence -{ - using type = index_sequence; - using value_type = std::size_t; - static constexpr std::size_t size() noexcept - { - return sizeof...(Ints); - } -}; - -template -struct merge_and_renumber; - -template -struct merge_and_renumber, index_sequence> - : index_sequence < I1..., (sizeof...(I1) + I2)... > - { }; - -template -struct make_index_sequence - : merge_and_renumber < typename make_index_sequence < N / 2 >::type, - typename make_index_sequence < N - N / 2 >::type > -{ }; - -template<> struct make_index_sequence<0> : index_sequence<> { }; -template<> struct make_index_sequence<1> : index_sequence<0> { }; - -template -using index_sequence_for = make_index_sequence; - -/* -Implementation of two C++17 constructs: conjunction, negation. This is needed -to avoid evaluating all the traits in a condition - -For example: not std::is_same::value and has_value_type::value -will not compile when T = void (on MSVC at least). Whereas -conjunction>, has_value_type>::value will -stop evaluating if negation<...>::value == false - -Please note that those constructs must be used with caution, since symbols can -become very long quickly (which can slow down compilation and cause MSVC -internal compiler errors). Only use it when you have to (see example ahead). -*/ -template struct conjunction : std::true_type {}; -template struct conjunction : B1 {}; -template -struct conjunction : std::conditional, B1>::type {}; - -template struct negation : std::integral_constant < bool, !B::value > {}; - -// dispatch utility (taken from ranges-v3) -template struct priority_tag : priority_tag < N - 1 > {}; -template<> struct priority_tag<0> {}; - - -////////////////// -// constructors // -////////////////// - -template struct external_constructor; - -template<> -struct external_constructor -{ - template - static void construct(BasicJsonType& j, typename BasicJsonType::boolean_t b) noexcept - { - j.m_type = value_t::boolean; - j.m_value = b; - j.assert_invariant(); - } -}; - -template<> -struct external_constructor -{ - template - static void construct(BasicJsonType& j, const typename BasicJsonType::string_t& s) - { - j.m_type = value_t::string; - j.m_value = s; - j.assert_invariant(); - } -}; - -template<> -struct external_constructor -{ - template - static void construct(BasicJsonType& j, typename BasicJsonType::number_float_t val) noexcept - { - j.m_type = value_t::number_float; - j.m_value = val; - j.assert_invariant(); - } -}; - -template<> -struct external_constructor -{ - template - static void construct(BasicJsonType& j, typename BasicJsonType::number_unsigned_t val) noexcept - { - j.m_type = value_t::number_unsigned; - j.m_value = val; - j.assert_invariant(); - } -}; - -template<> -struct external_constructor -{ - template - static void construct(BasicJsonType& j, typename BasicJsonType::number_integer_t val) noexcept - { - j.m_type = value_t::number_integer; - j.m_value = val; - j.assert_invariant(); - } -}; - -template<> -struct external_constructor -{ - template - static void construct(BasicJsonType& j, const typename BasicJsonType::array_t& arr) - { - j.m_type = value_t::array; - j.m_value = arr; - j.assert_invariant(); - } - - template::value, - int> = 0> - static void construct(BasicJsonType& j, const CompatibleArrayType& arr) - { - using std::begin; - using std::end; - j.m_type = value_t::array; - j.m_value.array = j.template create(begin(arr), end(arr)); - j.assert_invariant(); - } - - template - static void construct(BasicJsonType& j, const std::vector& arr) - { - j.m_type = value_t::array; - j.m_value = value_t::array; - j.m_value.array->reserve(arr.size()); - for (bool x : arr) - { - j.m_value.array->push_back(x); - } - j.assert_invariant(); - } -}; - -template<> -struct external_constructor -{ - template - static void construct(BasicJsonType& j, const typename BasicJsonType::object_t& obj) - { - j.m_type = value_t::object; - j.m_value = obj; - j.assert_invariant(); - } - - template::value, - int> = 0> - static void construct(BasicJsonType& j, const CompatibleObjectType& obj) - { - using std::begin; - using std::end; - - j.m_type = value_t::object; - j.m_value.object = j.template create(begin(obj), end(obj)); - j.assert_invariant(); - } -}; - - -//////////////////////// -// has_/is_ functions // -//////////////////////// - -/*! -@brief Helper to determine whether there's a key_type for T. - -This helper is used to tell associative containers apart from other containers -such as sequence containers. For instance, `std::map` passes the test as it -contains a `mapped_type`, whereas `std::vector` fails the test. - -@sa http://stackoverflow.com/a/7728728/266378 -@since version 1.0.0, overworked in version 2.0.6 -*/ -#define NLOHMANN_JSON_HAS_HELPER(type) \ - template struct has_##type { \ - private: \ - template \ - static int detect(U &&); \ - static void detect(...); \ - public: \ - static constexpr bool value = \ - std::is_integral()))>::value; \ - } - -NLOHMANN_JSON_HAS_HELPER(mapped_type); -NLOHMANN_JSON_HAS_HELPER(key_type); -NLOHMANN_JSON_HAS_HELPER(value_type); -NLOHMANN_JSON_HAS_HELPER(iterator); - -#undef NLOHMANN_JSON_HAS_HELPER - - -template -struct is_compatible_object_type_impl : std::false_type {}; - -template -struct is_compatible_object_type_impl -{ - static constexpr auto value = - std::is_constructible::value and - std::is_constructible::value; -}; - -template -struct is_compatible_object_type -{ - static auto constexpr value = is_compatible_object_type_impl < - conjunction>, - has_mapped_type, - has_key_type>::value, - typename BasicJsonType::object_t, CompatibleObjectType >::value; -}; - -template -struct is_basic_json_nested_type -{ - static auto constexpr value = std::is_same::value or - std::is_same::value or - std::is_same::value or - std::is_same::value or - std::is_same::value; -}; - -template -struct is_compatible_array_type -{ - static auto constexpr value = - conjunction>, - negation>, - negation>, - negation>, - has_value_type, - has_iterator>::value; -}; - -template -struct is_compatible_integer_type_impl : std::false_type {}; - -template -struct is_compatible_integer_type_impl -{ - // is there an assert somewhere on overflows? - using RealLimits = std::numeric_limits; - using CompatibleLimits = std::numeric_limits; - - static constexpr auto value = - std::is_constructible::value and - CompatibleLimits::is_integer and - RealLimits::is_signed == CompatibleLimits::is_signed; -}; - -template -struct is_compatible_integer_type -{ - static constexpr auto value = - is_compatible_integer_type_impl < - std::is_integral::value and - not std::is_same::value, - RealIntegerType, CompatibleNumberIntegerType > ::value; -}; - - -// trait checking if JSONSerializer::from_json(json const&, udt&) exists -template -struct has_from_json -{ - private: - // also check the return type of from_json - template::from_json( - std::declval(), std::declval()))>::value>> - static int detect(U&&); - static void detect(...); - - public: - static constexpr bool value = std::is_integral>()))>::value; -}; - -// This trait checks if JSONSerializer::from_json(json const&) exists -// this overload is used for non-default-constructible user-defined-types -template -struct has_non_default_from_json -{ - private: - template < - typename U, - typename = enable_if_t::from_json(std::declval()))>::value >> - static int detect(U&&); - static void detect(...); - - public: - static constexpr bool value = std::is_integral>()))>::value; -}; - -// This trait checks if BasicJsonType::json_serializer::to_json exists -template -struct has_to_json -{ - private: - template::to_json( - std::declval(), std::declval()))> - static int detect(U&&); - static void detect(...); - - public: - static constexpr bool value = std::is_integral>()))>::value; -}; - - -///////////// -// to_json // -///////////// - -template::value, int> = 0> -void to_json(BasicJsonType& j, T b) noexcept -{ - external_constructor::construct(j, b); -} - -template::value, int> = 0> -void to_json(BasicJsonType& j, const CompatibleString& s) -{ - external_constructor::construct(j, s); -} - -template::value, int> = 0> -void to_json(BasicJsonType& j, FloatType val) noexcept -{ - external_constructor::construct(j, static_cast(val)); -} - -template < - typename BasicJsonType, typename CompatibleNumberUnsignedType, - enable_if_t::value, int> = 0 > -void to_json(BasicJsonType& j, CompatibleNumberUnsignedType val) noexcept -{ - external_constructor::construct(j, static_cast(val)); -} - -template < - typename BasicJsonType, typename CompatibleNumberIntegerType, - enable_if_t::value, int> = 0 > -void to_json(BasicJsonType& j, CompatibleNumberIntegerType val) noexcept -{ - external_constructor::construct(j, static_cast(val)); -} - -template::value, int> = 0> -void to_json(BasicJsonType& j, EnumType e) noexcept -{ - using underlying_type = typename std::underlying_type::type; - external_constructor::construct(j, static_cast(e)); -} - -template -void to_json(BasicJsonType& j, const std::vector& e) -{ - external_constructor::construct(j, e); -} - -template < - typename BasicJsonType, typename CompatibleArrayType, - enable_if_t < - is_compatible_array_type::value or - std::is_same::value, - int > = 0 > -void to_json(BasicJsonType& j, const CompatibleArrayType& arr) -{ - external_constructor::construct(j, arr); -} - -template < - typename BasicJsonType, typename CompatibleObjectType, - enable_if_t::value, - int> = 0 > -void to_json(BasicJsonType& j, const CompatibleObjectType& arr) -{ - external_constructor::construct(j, arr); -} - -template ::value, - int> = 0> -void to_json(BasicJsonType& j, T (&arr)[N]) -{ - external_constructor::construct(j, arr); -} - -template -void to_json(BasicJsonType& j, const std::pair& p) -{ - j = {p.first, p.second}; -} - -template -void to_json_tuple_impl(BasicJsonType& j, const Tuple& t, index_sequence) -{ - j = {std::get(t)...}; -} - -template -void to_json(BasicJsonType& j, const std::tuple& t) -{ - to_json_tuple_impl(j, t, index_sequence_for {}); -} - -/////////////// -// from_json // -/////////////// - -// overloads for basic_json template parameters -template::value and - not std::is_same::value, - int> = 0> -void get_arithmetic_value(const BasicJsonType& j, ArithmeticType& val) -{ - switch (static_cast(j)) - { - case value_t::number_unsigned: - { - val = static_cast( - *j.template get_ptr()); - break; - } - case value_t::number_integer: - { - val = static_cast( - *j.template get_ptr()); - break; - } - case value_t::number_float: - { - val = static_cast( - *j.template get_ptr()); - break; - } - default: - { - JSON_THROW(type_error::create(302, "type must be number, but is " + j.type_name())); - } - } -} - -template -void from_json(const BasicJsonType& j, typename BasicJsonType::boolean_t& b) -{ - if (not j.is_boolean()) - { - JSON_THROW(type_error::create(302, "type must be boolean, but is " + j.type_name())); - } - b = *j.template get_ptr(); -} - -template -void from_json(const BasicJsonType& j, typename BasicJsonType::string_t& s) -{ - if (not j.is_string()) - { - JSON_THROW(type_error::create(302, "type must be string, but is " + j.type_name())); - } - s = *j.template get_ptr(); -} - -template -void from_json(const BasicJsonType& j, typename BasicJsonType::number_float_t& val) -{ - get_arithmetic_value(j, val); -} - -template -void from_json(const BasicJsonType& j, typename BasicJsonType::number_unsigned_t& val) -{ - get_arithmetic_value(j, val); -} - -template -void from_json(const BasicJsonType& j, typename BasicJsonType::number_integer_t& val) -{ - get_arithmetic_value(j, val); -} - -template::value, int> = 0> -void from_json(const BasicJsonType& j, EnumType& e) -{ - typename std::underlying_type::type val; - get_arithmetic_value(j, val); - e = static_cast(val); -} - -template -void from_json(const BasicJsonType& j, typename BasicJsonType::array_t& arr) -{ - if (not j.is_array()) - { - JSON_THROW(type_error::create(302, "type must be array, but is " + j.type_name())); - } - arr = *j.template get_ptr(); -} - -// forward_list doesn't have an insert method -template::value, int> = 0> -void from_json(const BasicJsonType& j, std::forward_list& l) -{ - if (not j.is_array()) - { - JSON_THROW(type_error::create(302, "type must be array, but is " + j.type_name())); - } - - for (auto it = j.rbegin(), end = j.rend(); it != end; ++it) - { - l.push_front(it->template get()); - } -} - -template -void from_json_array_impl(const BasicJsonType& j, CompatibleArrayType& arr, priority_tag<0>) -{ - using std::begin; - using std::end; - - std::transform(j.begin(), j.end(), - std::inserter(arr, end(arr)), [](const BasicJsonType & i) - { - // get() returns *this, this won't call a from_json - // method when value_type is BasicJsonType - return i.template get(); - }); -} - -template -auto from_json_array_impl(const BasicJsonType& j, CompatibleArrayType& arr, priority_tag<1>) --> decltype( - arr.reserve(std::declval()), - void()) -{ - using std::begin; - using std::end; - - arr.reserve(j.size()); - std::transform(j.begin(), j.end(), - std::inserter(arr, end(arr)), [](const BasicJsonType & i) - { - // get() returns *this, this won't call a from_json - // method when value_type is BasicJsonType - return i.template get(); - }); -} - -template -void from_json_array_impl(const BasicJsonType& j, std::array& arr, priority_tag<2>) -{ - for (std::size_t i = 0; i < N; ++i) - { - arr[i] = j.at(i).template get(); - } -} - -template::value and - std::is_convertible::value and - not std::is_same::value, int> = 0> -void from_json(const BasicJsonType& j, CompatibleArrayType& arr) -{ - if (not j.is_array()) - { - JSON_THROW(type_error::create(302, "type must be array, but is " + j.type_name())); - } - - from_json_array_impl(j, arr, priority_tag<2> {}); -} - -template::value, int> = 0> -void from_json(const BasicJsonType& j, CompatibleObjectType& obj) -{ - if (not j.is_object()) - { - JSON_THROW(type_error::create(302, "type must be object, but is " + j.type_name())); - } - - auto inner_object = j.template get_ptr(); - using std::begin; - using std::end; - using value_type = typename CompatibleObjectType::value_type; - std::transform( - inner_object->begin(), inner_object->end(), - std::inserter(obj, obj.begin()), - [](typename BasicJsonType::object_t::value_type const & p) - { - return value_type( - p.first, - p.second - .template get()); - }); -} - -// overload for arithmetic types, not chosen for basic_json template arguments -// (BooleanType, etc..); note: Is it really necessary to provide explicit -// overloads for boolean_t etc. in case of a custom BooleanType which is not -// an arithmetic type? -template::value and - not std::is_same::value and - not std::is_same::value and - not std::is_same::value and - not std::is_same::value, - int> = 0> -void from_json(const BasicJsonType& j, ArithmeticType& val) -{ - switch (static_cast(j)) - { - case value_t::number_unsigned: - { - val = static_cast(*j.template get_ptr()); - break; - } - case value_t::number_integer: - { - val = static_cast(*j.template get_ptr()); - break; - } - case value_t::number_float: - { - val = static_cast(*j.template get_ptr()); - break; - } - case value_t::boolean: - { - val = static_cast(*j.template get_ptr()); - break; - } - default: - { - JSON_THROW(type_error::create(302, "type must be number, but is " + j.type_name())); - } - } -} - -template -void from_json(const BasicJsonType& j, std::pair& p) -{ - p = {j.at(0), j.at(1)}; -} - -template -void from_json_tuple_impl(const BasicJsonType& j, Tuple& t, index_sequence) -{ - t = std::make_tuple(j.at(Idx)...); -} - -template -void from_json(const BasicJsonType& j, std::tuple& t) -{ - from_json_tuple_impl(j, t, index_sequence_for {}); -} - -struct to_json_fn -{ - private: - template - auto call(BasicJsonType& j, T&& val, priority_tag<1>) const noexcept(noexcept(to_json(j, std::forward(val)))) - -> decltype(to_json(j, std::forward(val)), void()) - { - return to_json(j, std::forward(val)); - } - - template - void call(BasicJsonType&, T&&, priority_tag<0>) const noexcept - { - static_assert(sizeof(BasicJsonType) == 0, - "could not find to_json() method in T's namespace"); - } - - public: - template - void operator()(BasicJsonType& j, T&& val) const - noexcept(noexcept(std::declval().call(j, std::forward(val), priority_tag<1> {}))) - { - return call(j, std::forward(val), priority_tag<1> {}); - } -}; - -struct from_json_fn -{ - private: - template - auto call(const BasicJsonType& j, T& val, priority_tag<1>) const - noexcept(noexcept(from_json(j, val))) - -> decltype(from_json(j, val), void()) - { - return from_json(j, val); - } - - template - void call(const BasicJsonType&, T&, priority_tag<0>) const noexcept - { - static_assert(sizeof(BasicJsonType) == 0, - "could not find from_json() method in T's namespace"); - } - - public: - template - void operator()(const BasicJsonType& j, T& val) const - noexcept(noexcept(std::declval().call(j, val, priority_tag<1> {}))) - { - return call(j, val, priority_tag<1> {}); - } -}; - -// taken from ranges-v3 -template -struct static_const -{ - static constexpr T value{}; -}; - -template -constexpr T static_const::value; -} // namespace detail - - -/// namespace to hold default `to_json` / `from_json` functions -namespace -{ -constexpr const auto& to_json = detail::static_const::value; -constexpr const auto& from_json = detail::static_const::value; -} - - -/*! -@brief default JSONSerializer template argument - -This serializer ignores the template arguments and uses ADL -([argument-dependent lookup](http://en.cppreference.com/w/cpp/language/adl)) -for serialization. -*/ -template -struct adl_serializer -{ - /*! - @brief convert a JSON value to any value type - - This function is usually called by the `get()` function of the - @ref basic_json class (either explicit or via conversion operators). - - @param[in] j JSON value to read from - @param[in,out] val value to write to - */ - template - static void from_json(BasicJsonType&& j, ValueType& val) noexcept( - noexcept(::nlohmann::from_json(std::forward(j), val))) - { - ::nlohmann::from_json(std::forward(j), val); - } - - /*! - @brief convert any value type to a JSON value - - This function is usually called by the constructors of the @ref basic_json - class. - - @param[in,out] j JSON value to write to - @param[in] val value to read from - */ - template - static void to_json(BasicJsonType& j, ValueType&& val) noexcept( - noexcept(::nlohmann::to_json(j, std::forward(val)))) - { - ::nlohmann::to_json(j, std::forward(val)); - } -}; - - -/*! -@brief a class to store JSON values - -@tparam ObjectType type for JSON objects (`std::map` by default; will be used -in @ref object_t) -@tparam ArrayType type for JSON arrays (`std::vector` by default; will be used -in @ref array_t) -@tparam StringType type for JSON strings and object keys (`std::string` by -default; will be used in @ref string_t) -@tparam BooleanType type for JSON booleans (`bool` by default; will be used -in @ref boolean_t) -@tparam NumberIntegerType type for JSON integer numbers (`int64_t` by -default; will be used in @ref number_integer_t) -@tparam NumberUnsignedType type for JSON unsigned integer numbers (@c -`uint64_t` by default; will be used in @ref number_unsigned_t) -@tparam NumberFloatType type for JSON floating-point numbers (`double` by -default; will be used in @ref number_float_t) -@tparam AllocatorType type of the allocator to use (`std::allocator` by -default) -@tparam JSONSerializer the serializer to resolve internal calls to `to_json()` -and `from_json()` (@ref adl_serializer by default) - -@requirement The class satisfies the following concept requirements: -- Basic - - [DefaultConstructible](http://en.cppreference.com/w/cpp/concept/DefaultConstructible): - JSON values can be default constructed. The result will be a JSON null - value. - - [MoveConstructible](http://en.cppreference.com/w/cpp/concept/MoveConstructible): - A JSON value can be constructed from an rvalue argument. - - [CopyConstructible](http://en.cppreference.com/w/cpp/concept/CopyConstructible): - A JSON value can be copy-constructed from an lvalue expression. - - [MoveAssignable](http://en.cppreference.com/w/cpp/concept/MoveAssignable): - A JSON value van be assigned from an rvalue argument. - - [CopyAssignable](http://en.cppreference.com/w/cpp/concept/CopyAssignable): - A JSON value can be copy-assigned from an lvalue expression. - - [Destructible](http://en.cppreference.com/w/cpp/concept/Destructible): - JSON values can be destructed. -- Layout - - [StandardLayoutType](http://en.cppreference.com/w/cpp/concept/StandardLayoutType): - JSON values have - [standard layout](http://en.cppreference.com/w/cpp/language/data_members#Standard_layout): - All non-static data members are private and standard layout types, the - class has no virtual functions or (virtual) base classes. -- Library-wide - - [EqualityComparable](http://en.cppreference.com/w/cpp/concept/EqualityComparable): - JSON values can be compared with `==`, see @ref - operator==(const_reference,const_reference). - - [LessThanComparable](http://en.cppreference.com/w/cpp/concept/LessThanComparable): - JSON values can be compared with `<`, see @ref - operator<(const_reference,const_reference). - - [Swappable](http://en.cppreference.com/w/cpp/concept/Swappable): - Any JSON lvalue or rvalue of can be swapped with any lvalue or rvalue of - other compatible types, using unqualified function call @ref swap(). - - [NullablePointer](http://en.cppreference.com/w/cpp/concept/NullablePointer): - JSON values can be compared against `std::nullptr_t` objects which are used - to model the `null` value. -- Container - - [Container](http://en.cppreference.com/w/cpp/concept/Container): - JSON values can be used like STL containers and provide iterator access. - - [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer); - JSON values can be used like STL containers and provide reverse iterator - access. - -@invariant The member variables @a m_value and @a m_type have the following -relationship: -- If `m_type == value_t::object`, then `m_value.object != nullptr`. -- If `m_type == value_t::array`, then `m_value.array != nullptr`. -- If `m_type == value_t::string`, then `m_value.string != nullptr`. -The invariants are checked by member function assert_invariant(). - -@internal -@note ObjectType trick from http://stackoverflow.com/a/9860911 -@endinternal - -@see [RFC 7159: The JavaScript Object Notation (JSON) Data Interchange -Format](http://rfc7159.net/rfc7159) - -@since version 1.0.0 - -@nosubgrouping -*/ -template < - template class ObjectType = std::map, - template class ArrayType = std::vector, - class StringType = std::string, - class BooleanType = bool, - class NumberIntegerType = std::int64_t, - class NumberUnsignedType = std::uint64_t, - class NumberFloatType = double, - template class AllocatorType = std::allocator, - template class JSONSerializer = adl_serializer - > -class basic_json -{ - private: - template friend struct detail::external_constructor; - /// workaround type for MSVC - using basic_json_t = basic_json; - - public: - using value_t = detail::value_t; - // forward declarations - template class iter_impl; - template class json_reverse_iterator; - class json_pointer; - template - using json_serializer = JSONSerializer; - - - //////////////// - // exceptions // - //////////////// - - /// @name exceptions - /// Classes to implement user-defined exceptions. - /// @{ - - /// @copydoc detail::exception - using exception = detail::exception; - /// @copydoc detail::parse_error - using parse_error = detail::parse_error; - /// @copydoc detail::invalid_iterator - using invalid_iterator = detail::invalid_iterator; - /// @copydoc detail::type_error - using type_error = detail::type_error; - /// @copydoc detail::out_of_range - using out_of_range = detail::out_of_range; - /// @copydoc detail::other_error - using other_error = detail::other_error; - - /// @} - - - ///////////////////// - // container types // - ///////////////////// - - /// @name container types - /// The canonic container types to use @ref basic_json like any other STL - /// container. - /// @{ - - /// the type of elements in a basic_json container - using value_type = basic_json; - - /// the type of an element reference - using reference = value_type&; - /// the type of an element const reference - using const_reference = const value_type&; - - /// a type to represent differences between iterators - using difference_type = std::ptrdiff_t; - /// a type to represent container sizes - using size_type = std::size_t; - - /// the allocator type - using allocator_type = AllocatorType; - - /// the type of an element pointer - using pointer = typename std::allocator_traits::pointer; - /// the type of an element const pointer - using const_pointer = typename std::allocator_traits::const_pointer; - - /// an iterator for a basic_json container - using iterator = iter_impl; - /// a const iterator for a basic_json container - using const_iterator = iter_impl; - /// a reverse iterator for a basic_json container - using reverse_iterator = json_reverse_iterator; - /// a const reverse iterator for a basic_json container - using const_reverse_iterator = json_reverse_iterator; - - /// @} - - - /*! - @brief returns the allocator associated with the container - */ - static allocator_type get_allocator() - { - return allocator_type(); - } - - /*! - @brief returns version information on the library - - This function returns a JSON object with information about the library, - including the version number and information on the platform and compiler. - - @return JSON object holding version information - key | description - ----------- | --------------- - `compiler` | Information on the used compiler. It is an object with the following keys: `c++` (the used C++ standard), `family` (the compiler family; possible values are `clang`, `icc`, `gcc`, `ilecpp`, `msvc`, `pgcpp`, `sunpro`, and `unknown`), and `version` (the compiler version). - `copyright` | The copyright line for the library as string. - `name` | The name of the library as string. - `platform` | The used platform as string. Possible values are `win32`, `linux`, `apple`, `unix`, and `unknown`. - `url` | The URL of the project as string. - `version` | The version of the library. It is an object with the following keys: `major`, `minor`, and `patch` as defined by [Semantic Versioning](http://semver.org), and `string` (the version string). - - @liveexample{The following code shows an example output of the `meta()` - function.,meta} - - @complexity Constant. - - @since 2.1.0 - */ - static basic_json meta() - { - basic_json result; - - result["copyright"] = "(C) 2013-2017 Niels Lohmann"; - result["name"] = "JSON for Modern C++"; - result["url"] = "https://github.com/nlohmann/json"; - result["version"] = - { - {"string", "2.1.1"}, {"major", 2}, {"minor", 1}, {"patch", 1} - }; - -#ifdef _WIN32 - result["platform"] = "win32"; -#elif defined __linux__ - result["platform"] = "linux"; -#elif defined __APPLE__ - result["platform"] = "apple"; -#elif defined __unix__ - result["platform"] = "unix"; -#else - result["platform"] = "unknown"; -#endif - -#if defined(__clang__) - result["compiler"] = {{"family", "clang"}, {"version", __clang_version__}}; -#elif defined(__ICC) || defined(__INTEL_COMPILER) - result["compiler"] = {{"family", "icc"}, {"version", __INTEL_COMPILER}}; -#elif defined(__GNUC__) || defined(__GNUG__) - result["compiler"] = {{"family", "gcc"}, {"version", std::to_string(__GNUC__) + "." + std::to_string(__GNUC_MINOR__) + "." + std::to_string(__GNUC_PATCHLEVEL__)}}; -#elif defined(__HP_cc) || defined(__HP_aCC) - result["compiler"] = "hp" -#elif defined(__IBMCPP__) - result["compiler"] = {{"family", "ilecpp"}, {"version", __IBMCPP__}}; -#elif defined(_MSC_VER) - result["compiler"] = {{"family", "msvc"}, {"version", _MSC_VER}}; -#elif defined(__PGI) - result["compiler"] = {{"family", "pgcpp"}, {"version", __PGI}}; -#elif defined(__SUNPRO_CC) - result["compiler"] = {{"family", "sunpro"}, {"version", __SUNPRO_CC}}; -#else - result["compiler"] = {{"family", "unknown"}, {"version", "unknown"}}; -#endif - -#ifdef __cplusplus - result["compiler"]["c++"] = std::to_string(__cplusplus); -#else - result["compiler"]["c++"] = "unknown"; -#endif - return result; - } - - - /////////////////////////// - // JSON value data types // - /////////////////////////// - - /// @name JSON value data types - /// The data types to store a JSON value. These types are derived from - /// the template arguments passed to class @ref basic_json. - /// @{ - - /*! - @brief a type for an object - - [RFC 7159](http://rfc7159.net/rfc7159) describes JSON objects as follows: - > An object is an unordered collection of zero or more name/value pairs, - > where a name is a string and a value is a string, number, boolean, null, - > object, or array. - - To store objects in C++, a type is defined by the template parameters - described below. - - @tparam ObjectType the container to store objects (e.g., `std::map` or - `std::unordered_map`) - @tparam StringType the type of the keys or names (e.g., `std::string`). - The comparison function `std::less` is used to order elements - inside the container. - @tparam AllocatorType the allocator to use for objects (e.g., - `std::allocator`) - - #### Default type - - With the default values for @a ObjectType (`std::map`), @a StringType - (`std::string`), and @a AllocatorType (`std::allocator`), the default - value for @a object_t is: - - @code {.cpp} - std::map< - std::string, // key_type - basic_json, // value_type - std::less, // key_compare - std::allocator> // allocator_type - > - @endcode - - #### Behavior - - The choice of @a object_t influences the behavior of the JSON class. With - the default type, objects have the following behavior: - - - When all names are unique, objects will be interoperable in the sense - that all software implementations receiving that object will agree on - the name-value mappings. - - When the names within an object are not unique, later stored name/value - pairs overwrite previously stored name/value pairs, leaving the used - names unique. For instance, `{"key": 1}` and `{"key": 2, "key": 1}` will - be treated as equal and both stored as `{"key": 1}`. - - Internally, name/value pairs are stored in lexicographical order of the - names. Objects will also be serialized (see @ref dump) in this order. - For instance, `{"b": 1, "a": 2}` and `{"a": 2, "b": 1}` will be stored - and serialized as `{"a": 2, "b": 1}`. - - When comparing objects, the order of the name/value pairs is irrelevant. - This makes objects interoperable in the sense that they will not be - affected by these differences. For instance, `{"b": 1, "a": 2}` and - `{"a": 2, "b": 1}` will be treated as equal. - - #### Limits - - [RFC 7159](http://rfc7159.net/rfc7159) specifies: - > An implementation may set limits on the maximum depth of nesting. - - In this class, the object's limit of nesting is not constraint explicitly. - However, a maximum depth of nesting may be introduced by the compiler or - runtime environment. A theoretical limit can be queried by calling the - @ref max_size function of a JSON object. - - #### Storage - - Objects are stored as pointers in a @ref basic_json type. That is, for any - access to object values, a pointer of type `object_t*` must be - dereferenced. - - @sa @ref array_t -- type for an array value - - @since version 1.0.0 - - @note The order name/value pairs are added to the object is *not* - preserved by the library. Therefore, iterating an object may return - name/value pairs in a different order than they were originally stored. In - fact, keys will be traversed in alphabetical order as `std::map` with - `std::less` is used by default. Please note this behavior conforms to [RFC - 7159](http://rfc7159.net/rfc7159), because any order implements the - specified "unordered" nature of JSON objects. - */ - using object_t = ObjectType, - AllocatorType>>; - - /*! - @brief a type for an array - - [RFC 7159](http://rfc7159.net/rfc7159) describes JSON arrays as follows: - > An array is an ordered sequence of zero or more values. - - To store objects in C++, a type is defined by the template parameters - explained below. - - @tparam ArrayType container type to store arrays (e.g., `std::vector` or - `std::list`) - @tparam AllocatorType allocator to use for arrays (e.g., `std::allocator`) - - #### Default type - - With the default values for @a ArrayType (`std::vector`) and @a - AllocatorType (`std::allocator`), the default value for @a array_t is: - - @code {.cpp} - std::vector< - basic_json, // value_type - std::allocator // allocator_type - > - @endcode - - #### Limits - - [RFC 7159](http://rfc7159.net/rfc7159) specifies: - > An implementation may set limits on the maximum depth of nesting. - - In this class, the array's limit of nesting is not constraint explicitly. - However, a maximum depth of nesting may be introduced by the compiler or - runtime environment. A theoretical limit can be queried by calling the - @ref max_size function of a JSON array. - - #### Storage - - Arrays are stored as pointers in a @ref basic_json type. That is, for any - access to array values, a pointer of type `array_t*` must be dereferenced. - - @sa @ref object_t -- type for an object value - - @since version 1.0.0 - */ - using array_t = ArrayType>; - - /*! - @brief a type for a string - - [RFC 7159](http://rfc7159.net/rfc7159) describes JSON strings as follows: - > A string is a sequence of zero or more Unicode characters. - - To store objects in C++, a type is defined by the template parameter - described below. Unicode values are split by the JSON class into - byte-sized characters during deserialization. - - @tparam StringType the container to store strings (e.g., `std::string`). - Note this container is used for keys/names in objects, see @ref object_t. - - #### Default type - - With the default values for @a StringType (`std::string`), the default - value for @a string_t is: - - @code {.cpp} - std::string - @endcode - - #### Encoding - - Strings are stored in UTF-8 encoding. Therefore, functions like - `std::string::size()` or `std::string::length()` return the number of - bytes in the string rather than the number of characters or glyphs. - - #### String comparison - - [RFC 7159](http://rfc7159.net/rfc7159) states: - > Software implementations are typically required to test names of object - > members for equality. Implementations that transform the textual - > representation into sequences of Unicode code units and then perform the - > comparison numerically, code unit by code unit, are interoperable in the - > sense that implementations will agree in all cases on equality or - > inequality of two strings. For example, implementations that compare - > strings with escaped characters unconverted may incorrectly find that - > `"a\\b"` and `"a\u005Cb"` are not equal. - - This implementation is interoperable as it does compare strings code unit - by code unit. - - #### Storage - - String values are stored as pointers in a @ref basic_json type. That is, - for any access to string values, a pointer of type `string_t*` must be - dereferenced. - - @since version 1.0.0 - */ - using string_t = StringType; - - /*! - @brief a type for a boolean - - [RFC 7159](http://rfc7159.net/rfc7159) implicitly describes a boolean as a - type which differentiates the two literals `true` and `false`. - - To store objects in C++, a type is defined by the template parameter @a - BooleanType which chooses the type to use. - - #### Default type - - With the default values for @a BooleanType (`bool`), the default value for - @a boolean_t is: - - @code {.cpp} - bool - @endcode - - #### Storage - - Boolean values are stored directly inside a @ref basic_json type. - - @since version 1.0.0 - */ - using boolean_t = BooleanType; - - /*! - @brief a type for a number (integer) - - [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows: - > The representation of numbers is similar to that used in most - > programming languages. A number is represented in base 10 using decimal - > digits. It contains an integer component that may be prefixed with an - > optional minus sign, which may be followed by a fraction part and/or an - > exponent part. Leading zeros are not allowed. (...) Numeric values that - > cannot be represented in the grammar below (such as Infinity and NaN) - > are not permitted. - - This description includes both integer and floating-point numbers. - However, C++ allows more precise storage if it is known whether the number - is a signed integer, an unsigned integer or a floating-point number. - Therefore, three different types, @ref number_integer_t, @ref - number_unsigned_t and @ref number_float_t are used. - - To store integer numbers in C++, a type is defined by the template - parameter @a NumberIntegerType which chooses the type to use. - - #### Default type - - With the default values for @a NumberIntegerType (`int64_t`), the default - value for @a number_integer_t is: - - @code {.cpp} - int64_t - @endcode - - #### Default behavior - - - The restrictions about leading zeros is not enforced in C++. Instead, - leading zeros in integer literals lead to an interpretation as octal - number. Internally, the value will be stored as decimal number. For - instance, the C++ integer literal `010` will be serialized to `8`. - During deserialization, leading zeros yield an error. - - Not-a-number (NaN) values will be serialized to `null`. - - #### Limits - - [RFC 7159](http://rfc7159.net/rfc7159) specifies: - > An implementation may set limits on the range and precision of numbers. - - When the default type is used, the maximal integer number that can be - stored is `9223372036854775807` (INT64_MAX) and the minimal integer number - that can be stored is `-9223372036854775808` (INT64_MIN). Integer numbers - that are out of range will yield over/underflow when used in a - constructor. During deserialization, too large or small integer numbers - will be automatically be stored as @ref number_unsigned_t or @ref - number_float_t. - - [RFC 7159](http://rfc7159.net/rfc7159) further states: - > Note that when such software is used, numbers that are integers and are - > in the range \f$[-2^{53}+1, 2^{53}-1]\f$ are interoperable in the sense - > that implementations will agree exactly on their numeric values. - - As this range is a subrange of the exactly supported range [INT64_MIN, - INT64_MAX], this class's integer type is interoperable. - - #### Storage - - Integer number values are stored directly inside a @ref basic_json type. - - @sa @ref number_float_t -- type for number values (floating-point) - - @sa @ref number_unsigned_t -- type for number values (unsigned integer) - - @since version 1.0.0 - */ - using number_integer_t = NumberIntegerType; - - /*! - @brief a type for a number (unsigned) - - [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows: - > The representation of numbers is similar to that used in most - > programming languages. A number is represented in base 10 using decimal - > digits. It contains an integer component that may be prefixed with an - > optional minus sign, which may be followed by a fraction part and/or an - > exponent part. Leading zeros are not allowed. (...) Numeric values that - > cannot be represented in the grammar below (such as Infinity and NaN) - > are not permitted. - - This description includes both integer and floating-point numbers. - However, C++ allows more precise storage if it is known whether the number - is a signed integer, an unsigned integer or a floating-point number. - Therefore, three different types, @ref number_integer_t, @ref - number_unsigned_t and @ref number_float_t are used. - - To store unsigned integer numbers in C++, a type is defined by the - template parameter @a NumberUnsignedType which chooses the type to use. - - #### Default type - - With the default values for @a NumberUnsignedType (`uint64_t`), the - default value for @a number_unsigned_t is: - - @code {.cpp} - uint64_t - @endcode - - #### Default behavior - - - The restrictions about leading zeros is not enforced in C++. Instead, - leading zeros in integer literals lead to an interpretation as octal - number. Internally, the value will be stored as decimal number. For - instance, the C++ integer literal `010` will be serialized to `8`. - During deserialization, leading zeros yield an error. - - Not-a-number (NaN) values will be serialized to `null`. - - #### Limits - - [RFC 7159](http://rfc7159.net/rfc7159) specifies: - > An implementation may set limits on the range and precision of numbers. - - When the default type is used, the maximal integer number that can be - stored is `18446744073709551615` (UINT64_MAX) and the minimal integer - number that can be stored is `0`. Integer numbers that are out of range - will yield over/underflow when used in a constructor. During - deserialization, too large or small integer numbers will be automatically - be stored as @ref number_integer_t or @ref number_float_t. - - [RFC 7159](http://rfc7159.net/rfc7159) further states: - > Note that when such software is used, numbers that are integers and are - > in the range \f$[-2^{53}+1, 2^{53}-1]\f$ are interoperable in the sense - > that implementations will agree exactly on their numeric values. - - As this range is a subrange (when considered in conjunction with the - number_integer_t type) of the exactly supported range [0, UINT64_MAX], - this class's integer type is interoperable. - - #### Storage - - Integer number values are stored directly inside a @ref basic_json type. - - @sa @ref number_float_t -- type for number values (floating-point) - @sa @ref number_integer_t -- type for number values (integer) - - @since version 2.0.0 - */ - using number_unsigned_t = NumberUnsignedType; - - /*! - @brief a type for a number (floating-point) - - [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows: - > The representation of numbers is similar to that used in most - > programming languages. A number is represented in base 10 using decimal - > digits. It contains an integer component that may be prefixed with an - > optional minus sign, which may be followed by a fraction part and/or an - > exponent part. Leading zeros are not allowed. (...) Numeric values that - > cannot be represented in the grammar below (such as Infinity and NaN) - > are not permitted. - - This description includes both integer and floating-point numbers. - However, C++ allows more precise storage if it is known whether the number - is a signed integer, an unsigned integer or a floating-point number. - Therefore, three different types, @ref number_integer_t, @ref - number_unsigned_t and @ref number_float_t are used. - - To store floating-point numbers in C++, a type is defined by the template - parameter @a NumberFloatType which chooses the type to use. - - #### Default type - - With the default values for @a NumberFloatType (`double`), the default - value for @a number_float_t is: - - @code {.cpp} - double - @endcode - - #### Default behavior - - - The restrictions about leading zeros is not enforced in C++. Instead, - leading zeros in floating-point literals will be ignored. Internally, - the value will be stored as decimal number. For instance, the C++ - floating-point literal `01.2` will be serialized to `1.2`. During - deserialization, leading zeros yield an error. - - Not-a-number (NaN) values will be serialized to `null`. - - #### Limits - - [RFC 7159](http://rfc7159.net/rfc7159) states: - > This specification allows implementations to set limits on the range and - > precision of numbers accepted. Since software that implements IEEE - > 754-2008 binary64 (double precision) numbers is generally available and - > widely used, good interoperability can be achieved by implementations - > that expect no more precision or range than these provide, in the sense - > that implementations will approximate JSON numbers within the expected - > precision. - - This implementation does exactly follow this approach, as it uses double - precision floating-point numbers. Note values smaller than - `-1.79769313486232e+308` and values greater than `1.79769313486232e+308` - will be stored as NaN internally and be serialized to `null`. - - #### Storage - - Floating-point number values are stored directly inside a @ref basic_json - type. - - @sa @ref number_integer_t -- type for number values (integer) - - @sa @ref number_unsigned_t -- type for number values (unsigned integer) - - @since version 1.0.0 - */ - using number_float_t = NumberFloatType; - - /// @} - - private: - - /// helper for exception-safe object creation - template - static T* create(Args&& ... args) - { - AllocatorType alloc; - auto deleter = [&](T * object) - { - alloc.deallocate(object, 1); - }; - std::unique_ptr object(alloc.allocate(1), deleter); - alloc.construct(object.get(), std::forward(args)...); - assert(object != nullptr); - return object.release(); - } - - //////////////////////// - // JSON value storage // - //////////////////////// - - /*! - @brief a JSON value - - The actual storage for a JSON value of the @ref basic_json class. This - union combines the different storage types for the JSON value types - defined in @ref value_t. - - JSON type | value_t type | used type - --------- | --------------- | ------------------------ - object | object | pointer to @ref object_t - array | array | pointer to @ref array_t - string | string | pointer to @ref string_t - boolean | boolean | @ref boolean_t - number | number_integer | @ref number_integer_t - number | number_unsigned | @ref number_unsigned_t - number | number_float | @ref number_float_t - null | null | *no value is stored* - - @note Variable-length types (objects, arrays, and strings) are stored as - pointers. The size of the union should not exceed 64 bits if the default - value types are used. - - @since version 1.0.0 - */ - union json_value - { - /// object (stored with pointer to save storage) - object_t* object; - /// array (stored with pointer to save storage) - array_t* array; - /// string (stored with pointer to save storage) - string_t* string; - /// boolean - boolean_t boolean; - /// number (integer) - number_integer_t number_integer; - /// number (unsigned integer) - number_unsigned_t number_unsigned; - /// number (floating-point) - number_float_t number_float; - - /// default constructor (for null values) - json_value() = default; - /// constructor for booleans - json_value(boolean_t v) noexcept : boolean(v) {} - /// constructor for numbers (integer) - json_value(number_integer_t v) noexcept : number_integer(v) {} - /// constructor for numbers (unsigned) - json_value(number_unsigned_t v) noexcept : number_unsigned(v) {} - /// constructor for numbers (floating-point) - json_value(number_float_t v) noexcept : number_float(v) {} - /// constructor for empty values of a given type - json_value(value_t t) - { - switch (t) - { - case value_t::object: - { - object = create(); - break; - } - - case value_t::array: - { - array = create(); - break; - } - - case value_t::string: - { - string = create(""); - break; - } - - case value_t::boolean: - { - boolean = boolean_t(false); - break; - } - - case value_t::number_integer: - { - number_integer = number_integer_t(0); - break; - } - - case value_t::number_unsigned: - { - number_unsigned = number_unsigned_t(0); - break; - } - - case value_t::number_float: - { - number_float = number_float_t(0.0); - break; - } - - case value_t::null: - { - break; - } - - default: - { - if (JSON_UNLIKELY(t == value_t::null)) - { - JSON_THROW(other_error::create(500, "961c151d2e87f2686a955a9be24d316f1362bf21 2.1.1")); // LCOV_EXCL_LINE - } - break; - } - } - } - - /// constructor for strings - json_value(const string_t& value) - { - string = create(value); - } - - /// constructor for objects - json_value(const object_t& value) - { - object = create(value); - } - - /// constructor for arrays - json_value(const array_t& value) - { - array = create(value); - } - }; - - /*! - @brief checks the class invariants - - This function asserts the class invariants. It needs to be called at the - end of every constructor to make sure that created objects respect the - invariant. Furthermore, it has to be called each time the type of a JSON - value is changed, because the invariant expresses a relationship between - @a m_type and @a m_value. - */ - void assert_invariant() const - { - assert(m_type != value_t::object or m_value.object != nullptr); - assert(m_type != value_t::array or m_value.array != nullptr); - assert(m_type != value_t::string or m_value.string != nullptr); - } - - public: - ////////////////////////// - // JSON parser callback // - ////////////////////////// - - /*! - @brief JSON callback events - - This enumeration lists the parser events that can trigger calling a - callback function of type @ref parser_callback_t during parsing. - - @image html callback_events.png "Example when certain parse events are triggered" - - @since version 1.0.0 - */ - enum class parse_event_t : uint8_t - { - /// the parser read `{` and started to process a JSON object - object_start, - /// the parser read `}` and finished processing a JSON object - object_end, - /// the parser read `[` and started to process a JSON array - array_start, - /// the parser read `]` and finished processing a JSON array - array_end, - /// the parser read a key of a value in an object - key, - /// the parser finished reading a JSON value - value - }; - - /*! - @brief per-element parser callback type - - With a parser callback function, the result of parsing a JSON text can be - influenced. When passed to @ref parse(std::istream&, const - parser_callback_t) or @ref parse(const CharT, const parser_callback_t), - it is called on certain events (passed as @ref parse_event_t via parameter - @a event) with a set recursion depth @a depth and context JSON value - @a parsed. The return value of the callback function is a boolean - indicating whether the element that emitted the callback shall be kept or - not. - - We distinguish six scenarios (determined by the event type) in which the - callback function can be called. The following table describes the values - of the parameters @a depth, @a event, and @a parsed. - - parameter @a event | description | parameter @a depth | parameter @a parsed - ------------------ | ----------- | ------------------ | ------------------- - parse_event_t::object_start | the parser read `{` and started to process a JSON object | depth of the parent of the JSON object | a JSON value with type discarded - parse_event_t::key | the parser read a key of a value in an object | depth of the currently parsed JSON object | a JSON string containing the key - parse_event_t::object_end | the parser read `}` and finished processing a JSON object | depth of the parent of the JSON object | the parsed JSON object - parse_event_t::array_start | the parser read `[` and started to process a JSON array | depth of the parent of the JSON array | a JSON value with type discarded - parse_event_t::array_end | the parser read `]` and finished processing a JSON array | depth of the parent of the JSON array | the parsed JSON array - parse_event_t::value | the parser finished reading a JSON value | depth of the value | the parsed JSON value - - @image html callback_events.png "Example when certain parse events are triggered" - - Discarding a value (i.e., returning `false`) has different effects - depending on the context in which function was called: - - - Discarded values in structured types are skipped. That is, the parser - will behave as if the discarded value was never read. - - In case a value outside a structured type is skipped, it is replaced - with `null`. This case happens if the top-level element is skipped. - - @param[in] depth the depth of the recursion during parsing - - @param[in] event an event of type parse_event_t indicating the context in - the callback function has been called - - @param[in,out] parsed the current intermediate parse result; note that - writing to this value has no effect for parse_event_t::key events - - @return Whether the JSON value which called the function during parsing - should be kept (`true`) or not (`false`). In the latter case, it is either - skipped completely or replaced by an empty discarded object. - - @sa @ref parse(std::istream&, parser_callback_t) or - @ref parse(const CharT, const parser_callback_t) for examples - - @since version 1.0.0 - */ - using parser_callback_t = std::function; - - - ////////////////// - // constructors // - ////////////////// - - /// @name constructors and destructors - /// Constructors of class @ref basic_json, copy/move constructor, copy - /// assignment, static functions creating objects, and the destructor. - /// @{ - - /*! - @brief create an empty value with a given type - - Create an empty JSON value with a given type. The value will be default - initialized with an empty value which depends on the type: - - Value type | initial value - ----------- | ------------- - null | `null` - boolean | `false` - string | `""` - number | `0` - object | `{}` - array | `[]` - - @param[in] v the type of the value to create - - @complexity Constant. - - @liveexample{The following code shows the constructor for different @ref - value_t values,basic_json__value_t} - - @since version 1.0.0 - */ - basic_json(const value_t v) - : m_type(v), m_value(v) - { - assert_invariant(); - } - - /*! - @brief create a null object - - Create a `null` JSON value. It either takes a null pointer as parameter - (explicitly creating `null`) or no parameter (implicitly creating `null`). - The passed null pointer itself is not read -- it is only used to choose - the right constructor. - - @complexity Constant. - - @exceptionsafety No-throw guarantee: this constructor never throws - exceptions. - - @liveexample{The following code shows the constructor with and without a - null pointer parameter.,basic_json__nullptr_t} - - @since version 1.0.0 - */ - basic_json(std::nullptr_t = nullptr) noexcept - : basic_json(value_t::null) - { - assert_invariant(); - } - - /*! - @brief create a JSON value - - This is a "catch all" constructor for all compatible JSON types; that is, - types for which a `to_json()` method exsits. The constructor forwards the - parameter @a val to that method (to `json_serializer::to_json` method - with `U = uncvref_t`, to be exact). - - Template type @a CompatibleType includes, but is not limited to, the - following types: - - **arrays**: @ref array_t and all kinds of compatible containers such as - `std::vector`, `std::deque`, `std::list`, `std::forward_list`, - `std::array`, `std::set`, `std::unordered_set`, `std::multiset`, and - `unordered_multiset` with a `value_type` from which a @ref basic_json - value can be constructed. - - **objects**: @ref object_t and all kinds of compatible associative - containers such as `std::map`, `std::unordered_map`, `std::multimap`, - and `std::unordered_multimap` with a `key_type` compatible to - @ref string_t and a `value_type` from which a @ref basic_json value can - be constructed. - - **strings**: @ref string_t, string literals, and all compatible string - containers can be used. - - **numbers**: @ref number_integer_t, @ref number_unsigned_t, - @ref number_float_t, and all convertible number types such as `int`, - `size_t`, `int64_t`, `float` or `double` can be used. - - **boolean**: @ref boolean_t / `bool` can be used. - - See the examples below. - - @tparam CompatibleType a type such that: - - @a CompatibleType is not derived from `std::istream`, - - @a CompatibleType is not @ref basic_json (to avoid hijacking copy/move - constructors), - - @a CompatibleType is not a @ref basic_json nested type (e.g., - @ref json_pointer, @ref iterator, etc ...) - - @ref @ref json_serializer has a - `to_json(basic_json_t&, CompatibleType&&)` method - - @tparam U = `uncvref_t` - - @param[in] val the value to be forwarded - - @complexity Usually linear in the size of the passed @a val, also - depending on the implementation of the called `to_json()` - method. - - @throw what `json_serializer::to_json()` throws - - @liveexample{The following code shows the constructor with several - compatible types.,basic_json__CompatibleType} - - @since version 2.1.0 - */ - template, - detail::enable_if_t::value and - not std::is_same::value and - not detail::is_basic_json_nested_type< - basic_json_t, U>::value and - detail::has_to_json::value, - int> = 0> - basic_json(CompatibleType && val) noexcept(noexcept(JSONSerializer::to_json( - std::declval(), std::forward(val)))) - { - JSONSerializer::to_json(*this, std::forward(val)); - assert_invariant(); - } - - /*! - @brief create a container (array or object) from an initializer list - - Creates a JSON value of type array or object from the passed initializer - list @a init. In case @a type_deduction is `true` (default), the type of - the JSON value to be created is deducted from the initializer list @a init - according to the following rules: - - 1. If the list is empty, an empty JSON object value `{}` is created. - 2. If the list consists of pairs whose first element is a string, a JSON - object value is created where the first elements of the pairs are - treated as keys and the second elements are as values. - 3. In all other cases, an array is created. - - The rules aim to create the best fit between a C++ initializer list and - JSON values. The rationale is as follows: - - 1. The empty initializer list is written as `{}` which is exactly an empty - JSON object. - 2. C++ has now way of describing mapped types other than to list a list of - pairs. As JSON requires that keys must be of type string, rule 2 is the - weakest constraint one can pose on initializer lists to interpret them - as an object. - 3. In all other cases, the initializer list could not be interpreted as - JSON object type, so interpreting it as JSON array type is safe. - - With the rules described above, the following JSON values cannot be - expressed by an initializer list: - - - the empty array (`[]`): use @ref array(std::initializer_list) - with an empty initializer list in this case - - arrays whose elements satisfy rule 2: use @ref - array(std::initializer_list) with the same initializer list - in this case - - @note When used without parentheses around an empty initializer list, @ref - basic_json() is called instead of this function, yielding the JSON null - value. - - @param[in] init initializer list with JSON values - - @param[in] type_deduction internal parameter; when set to `true`, the type - of the JSON value is deducted from the initializer list @a init; when set - to `false`, the type provided via @a manual_type is forced. This mode is - used by the functions @ref array(std::initializer_list) and - @ref object(std::initializer_list). - - @param[in] manual_type internal parameter; when @a type_deduction is set - to `false`, the created JSON value will use the provided type (only @ref - value_t::array and @ref value_t::object are valid); when @a type_deduction - is set to `true`, this parameter has no effect - - @throw type_error.301 if @a type_deduction is `false`, @a manual_type is - `value_t::object`, but @a init contains an element which is not a pair - whose first element is a string. In this case, the constructor could not - create an object. If @a type_deduction would have be `true`, an array - would have been created. See @ref object(std::initializer_list) - for an example. - - @complexity Linear in the size of the initializer list @a init. - - @liveexample{The example below shows how JSON values are created from - initializer lists.,basic_json__list_init_t} - - @sa @ref array(std::initializer_list) -- create a JSON array - value from an initializer list - @sa @ref object(std::initializer_list) -- create a JSON object - value from an initializer list - - @since version 1.0.0 - */ - basic_json(std::initializer_list init, - bool type_deduction = true, - value_t manual_type = value_t::array) - { - // check if each element is an array with two elements whose first - // element is a string - bool is_an_object = std::all_of(init.begin(), init.end(), - [](const basic_json & element) - { - return element.is_array() and element.size() == 2 and element[0].is_string(); - }); - - // adjust type if type deduction is not wanted - if (not type_deduction) - { - // if array is wanted, do not create an object though possible - if (manual_type == value_t::array) - { - is_an_object = false; - } - - // if object is wanted but impossible, throw an exception - if (manual_type == value_t::object and not is_an_object) - { - JSON_THROW(type_error::create(301, "cannot create object from initializer list")); - } - } - - if (is_an_object) - { - // the initializer list is a list of pairs -> create object - m_type = value_t::object; - m_value = value_t::object; - - std::for_each(init.begin(), init.end(), [this](const basic_json & element) - { - m_value.object->emplace(*(element[0].m_value.string), element[1]); - }); - } - else - { - // the initializer list describes an array -> create array - m_type = value_t::array; - m_value.array = create(init); - } - - assert_invariant(); - } - - /*! - @brief explicitly create an array from an initializer list - - Creates a JSON array value from a given initializer list. That is, given a - list of values `a, b, c`, creates the JSON value `[a, b, c]`. If the - initializer list is empty, the empty array `[]` is created. - - @note This function is only needed to express two edge cases that cannot - be realized with the initializer list constructor (@ref - basic_json(std::initializer_list, bool, value_t)). These cases - are: - 1. creating an array whose elements are all pairs whose first element is a - string -- in this case, the initializer list constructor would create an - object, taking the first elements as keys - 2. creating an empty array -- passing the empty initializer list to the - initializer list constructor yields an empty object - - @param[in] init initializer list with JSON values to create an array from - (optional) - - @return JSON array value - - @complexity Linear in the size of @a init. - - @liveexample{The following code shows an example for the `array` - function.,array} - - @sa @ref basic_json(std::initializer_list, bool, value_t) -- - create a JSON value from an initializer list - @sa @ref object(std::initializer_list) -- create a JSON object - value from an initializer list - - @since version 1.0.0 - */ - static basic_json array(std::initializer_list init = - std::initializer_list()) - { - return basic_json(init, false, value_t::array); - } - - /*! - @brief explicitly create an object from an initializer list - - Creates a JSON object value from a given initializer list. The initializer - lists elements must be pairs, and their first elements must be strings. If - the initializer list is empty, the empty object `{}` is created. - - @note This function is only added for symmetry reasons. In contrast to the - related function @ref array(std::initializer_list), there are - no cases which can only be expressed by this function. That is, any - initializer list @a init can also be passed to the initializer list - constructor @ref basic_json(std::initializer_list, bool, value_t). - - @param[in] init initializer list to create an object from (optional) - - @return JSON object value - - @throw type_error.301 if @a init is not a list of pairs whose first - elements are strings. In this case, no object can be created. When such a - value is passed to @ref basic_json(std::initializer_list, bool, value_t), - an array would have been created from the passed initializer list @a init. - See example below. - - @complexity Linear in the size of @a init. - - @liveexample{The following code shows an example for the `object` - function.,object} - - @sa @ref basic_json(std::initializer_list, bool, value_t) -- - create a JSON value from an initializer list - @sa @ref array(std::initializer_list) -- create a JSON array - value from an initializer list - - @since version 1.0.0 - */ - static basic_json object(std::initializer_list init = - std::initializer_list()) - { - return basic_json(init, false, value_t::object); - } - - /*! - @brief construct an array with count copies of given value - - Constructs a JSON array value by creating @a cnt copies of a passed value. - In case @a cnt is `0`, an empty array is created. As postcondition, - `std::distance(begin(),end()) == cnt` holds. - - @param[in] cnt the number of JSON copies of @a val to create - @param[in] val the JSON value to copy - - @complexity Linear in @a cnt. - - @liveexample{The following code shows examples for the @ref - basic_json(size_type\, const basic_json&) - constructor.,basic_json__size_type_basic_json} - - @since version 1.0.0 - */ - basic_json(size_type cnt, const basic_json& val) - : m_type(value_t::array) - { - m_value.array = create(cnt, val); - assert_invariant(); - } - - /*! - @brief construct a JSON container given an iterator range - - Constructs the JSON value with the contents of the range `[first, last)`. - The semantics depends on the different types a JSON value can have: - - In case of primitive types (number, boolean, or string), @a first must - be `begin()` and @a last must be `end()`. In this case, the value is - copied. Otherwise, invalid_iterator.204 is thrown. - - In case of structured types (array, object), the constructor behaves as - similar versions for `std::vector`. - - In case of a null type, invalid_iterator.206 is thrown. - - @tparam InputIT an input iterator type (@ref iterator or @ref - const_iterator) - - @param[in] first begin of the range to copy from (included) - @param[in] last end of the range to copy from (excluded) - - @pre Iterators @a first and @a last must be initialized. **This - precondition is enforced with an assertion.** - - @pre Range `[first, last)` is valid. Usually, this precondition cannot be - checked efficiently. Only certain edge cases are detected; see the - description of the exceptions below. - - @throw invalid_iterator.201 if iterators @a first and @a last are not - compatible (i.e., do not belong to the same JSON value). In this case, - the range `[first, last)` is undefined. - @throw invalid_iterator.204 if iterators @a first and @a last belong to a - primitive type (number, boolean, or string), but @a first does not point - to the first element any more. In this case, the range `[first, last)` is - undefined. See example code below. - @throw invalid_iterator.206 if iterators @a first and @a last belong to a - null value. In this case, the range `[first, last)` is undefined. - - @complexity Linear in distance between @a first and @a last. - - @liveexample{The example below shows several ways to create JSON values by - specifying a subrange with iterators.,basic_json__InputIt_InputIt} - - @since version 1.0.0 - */ - template::value or - std::is_same::value, int>::type = 0> - basic_json(InputIT first, InputIT last) - { - assert(first.m_object != nullptr); - assert(last.m_object != nullptr); - - // make sure iterator fits the current value - if (first.m_object != last.m_object) - { - JSON_THROW(invalid_iterator::create(201, "iterators are not compatible")); - } - - // copy type from first iterator - m_type = first.m_object->m_type; - - // check if iterator range is complete for primitive values - switch (m_type) - { - case value_t::boolean: - case value_t::number_float: - case value_t::number_integer: - case value_t::number_unsigned: - case value_t::string: - { - if (not first.m_it.primitive_iterator.is_begin() or not last.m_it.primitive_iterator.is_end()) - { - JSON_THROW(invalid_iterator::create(204, "iterators out of range")); - } - break; - } - - default: - { - break; - } - } - - switch (m_type) - { - case value_t::number_integer: - { - m_value.number_integer = first.m_object->m_value.number_integer; - break; - } - - case value_t::number_unsigned: - { - m_value.number_unsigned = first.m_object->m_value.number_unsigned; - break; - } - - case value_t::number_float: - { - m_value.number_float = first.m_object->m_value.number_float; - break; - } - - case value_t::boolean: - { - m_value.boolean = first.m_object->m_value.boolean; - break; - } - - case value_t::string: - { - m_value = *first.m_object->m_value.string; - break; - } - - case value_t::object: - { - m_value.object = create(first.m_it.object_iterator, - last.m_it.object_iterator); - break; - } - - case value_t::array: - { - m_value.array = create(first.m_it.array_iterator, - last.m_it.array_iterator); - break; - } - - default: - { - JSON_THROW(invalid_iterator::create(206, "cannot construct with iterators from " + - first.m_object->type_name())); - } - } - - assert_invariant(); - } - - - /////////////////////////////////////// - // other constructors and destructor // - /////////////////////////////////////// - - /*! - @brief copy constructor - - Creates a copy of a given JSON value. - - @param[in] other the JSON value to copy - - @complexity Linear in the size of @a other. - - @requirement This function helps `basic_json` satisfying the - [Container](http://en.cppreference.com/w/cpp/concept/Container) - requirements: - - The complexity is linear. - - As postcondition, it holds: `other == basic_json(other)`. - - @liveexample{The following code shows an example for the copy - constructor.,basic_json__basic_json} - - @since version 1.0.0 - */ - basic_json(const basic_json& other) - : m_type(other.m_type) - { - // check of passed value is valid - other.assert_invariant(); - - switch (m_type) - { - case value_t::object: - { - m_value = *other.m_value.object; - break; - } - - case value_t::array: - { - m_value = *other.m_value.array; - break; - } - - case value_t::string: - { - m_value = *other.m_value.string; - break; - } - - case value_t::boolean: - { - m_value = other.m_value.boolean; - break; - } - - case value_t::number_integer: - { - m_value = other.m_value.number_integer; - break; - } - - case value_t::number_unsigned: - { - m_value = other.m_value.number_unsigned; - break; - } - - case value_t::number_float: - { - m_value = other.m_value.number_float; - break; - } - - default: - { - break; - } - } - - assert_invariant(); - } - - /*! - @brief move constructor - - Move constructor. Constructs a JSON value with the contents of the given - value @a other using move semantics. It "steals" the resources from @a - other and leaves it as JSON null value. - - @param[in,out] other value to move to this object - - @post @a other is a JSON null value - - @complexity Constant. - - @liveexample{The code below shows the move constructor explicitly called - via std::move.,basic_json__moveconstructor} - - @since version 1.0.0 - */ - basic_json(basic_json&& other) noexcept - : m_type(std::move(other.m_type)), - m_value(std::move(other.m_value)) - { - // check that passed value is valid - other.assert_invariant(); - - // invalidate payload - other.m_type = value_t::null; - other.m_value = {}; - - assert_invariant(); - } - - /*! - @brief copy assignment - - Copy assignment operator. Copies a JSON value via the "copy and swap" - strategy: It is expressed in terms of the copy constructor, destructor, - and the swap() member function. - - @param[in] other value to copy from - - @complexity Linear. - - @requirement This function helps `basic_json` satisfying the - [Container](http://en.cppreference.com/w/cpp/concept/Container) - requirements: - - The complexity is linear. - - @liveexample{The code below shows and example for the copy assignment. It - creates a copy of value `a` which is then swapped with `b`. Finally\, the - copy of `a` (which is the null value after the swap) is - destroyed.,basic_json__copyassignment} - - @since version 1.0.0 - */ - reference& operator=(basic_json other) noexcept ( - std::is_nothrow_move_constructible::value and - std::is_nothrow_move_assignable::value and - std::is_nothrow_move_constructible::value and - std::is_nothrow_move_assignable::value - ) - { - // check that passed value is valid - other.assert_invariant(); - - using std::swap; - swap(m_type, other.m_type); - swap(m_value, other.m_value); - - assert_invariant(); - return *this; - } - - /*! - @brief destructor - - Destroys the JSON value and frees all allocated memory. - - @complexity Linear. - - @requirement This function helps `basic_json` satisfying the - [Container](http://en.cppreference.com/w/cpp/concept/Container) - requirements: - - The complexity is linear. - - All stored elements are destroyed and all memory is freed. - - @since version 1.0.0 - */ - ~basic_json() - { - assert_invariant(); - - switch (m_type) - { - case value_t::object: - { - AllocatorType alloc; - alloc.destroy(m_value.object); - alloc.deallocate(m_value.object, 1); - break; - } - - case value_t::array: - { - AllocatorType alloc; - alloc.destroy(m_value.array); - alloc.deallocate(m_value.array, 1); - break; - } - - case value_t::string: - { - AllocatorType alloc; - alloc.destroy(m_value.string); - alloc.deallocate(m_value.string, 1); - break; - } - - default: - { - // all other types need no specific destructor - break; - } - } - } - - /// @} - - public: - /////////////////////// - // object inspection // - /////////////////////// - - /// @name object inspection - /// Functions to inspect the type of a JSON value. - /// @{ - - /*! - @brief serialization - - Serialization function for JSON values. The function tries to mimic - Python's `json.dumps()` function, and currently supports its @a indent - parameter. - - @param[in] indent If indent is nonnegative, then array elements and object - members will be pretty-printed with that indent level. An indent level of - `0` will only insert newlines. `-1` (the default) selects the most compact - representation. - @param[in] indent_char The character to use for indentation if @a indent is - greater than `0`. The default is ` ` (space). - - @return string containing the serialization of the JSON value - - @complexity Linear. - - @liveexample{The following example shows the effect of different @a indent - parameters to the result of the serialization.,dump} - - @see https://docs.python.org/2/library/json.html#json.dump - - @since version 1.0.0; indentation character added in version 3.0.0 - */ - string_t dump(const int indent = -1, const char indent_char = ' ') const - { - string_t result; - serializer s(output_adapter::create(result), indent_char); - - if (indent >= 0) - { - s.dump(*this, true, static_cast(indent)); - } - else - { - s.dump(*this, false, 0); - } - - return result; - } - - /*! - @brief return the type of the JSON value (explicit) - - Return the type of the JSON value as a value from the @ref value_t - enumeration. - - @return the type of the JSON value - - @complexity Constant. - - @exceptionsafety No-throw guarantee: this member function never throws - exceptions. - - @liveexample{The following code exemplifies `type()` for all JSON - types.,type} - - @since version 1.0.0 - */ - constexpr value_t type() const noexcept - { - return m_type; - } - - /*! - @brief return whether type is primitive - - This function returns true iff the JSON type is primitive (string, number, - boolean, or null). - - @return `true` if type is primitive (string, number, boolean, or null), - `false` otherwise. - - @complexity Constant. - - @exceptionsafety No-throw guarantee: this member function never throws - exceptions. - - @liveexample{The following code exemplifies `is_primitive()` for all JSON - types.,is_primitive} - - @sa @ref is_structured() -- returns whether JSON value is structured - @sa @ref is_null() -- returns whether JSON value is `null` - @sa @ref is_string() -- returns whether JSON value is a string - @sa @ref is_boolean() -- returns whether JSON value is a boolean - @sa @ref is_number() -- returns whether JSON value is a number - - @since version 1.0.0 - */ - constexpr bool is_primitive() const noexcept - { - return is_null() or is_string() or is_boolean() or is_number(); - } - - /*! - @brief return whether type is structured - - This function returns true iff the JSON type is structured (array or - object). - - @return `true` if type is structured (array or object), `false` otherwise. - - @complexity Constant. - - @exceptionsafety No-throw guarantee: this member function never throws - exceptions. - - @liveexample{The following code exemplifies `is_structured()` for all JSON - types.,is_structured} - - @sa @ref is_primitive() -- returns whether value is primitive - @sa @ref is_array() -- returns whether value is an array - @sa @ref is_object() -- returns whether value is an object - - @since version 1.0.0 - */ - constexpr bool is_structured() const noexcept - { - return is_array() or is_object(); - } - - /*! - @brief return whether value is null - - This function returns true iff the JSON value is null. - - @return `true` if type is null, `false` otherwise. - - @complexity Constant. - - @exceptionsafety No-throw guarantee: this member function never throws - exceptions. - - @liveexample{The following code exemplifies `is_null()` for all JSON - types.,is_null} - - @since version 1.0.0 - */ - constexpr bool is_null() const noexcept - { - return m_type == value_t::null; - } - - /*! - @brief return whether value is a boolean - - This function returns true iff the JSON value is a boolean. - - @return `true` if type is boolean, `false` otherwise. - - @complexity Constant. - - @exceptionsafety No-throw guarantee: this member function never throws - exceptions. - - @liveexample{The following code exemplifies `is_boolean()` for all JSON - types.,is_boolean} - - @since version 1.0.0 - */ - constexpr bool is_boolean() const noexcept - { - return m_type == value_t::boolean; - } - - /*! - @brief return whether value is a number - - This function returns true iff the JSON value is a number. This includes - both integer and floating-point values. - - @return `true` if type is number (regardless whether integer, unsigned - integer or floating-type), `false` otherwise. - - @complexity Constant. - - @exceptionsafety No-throw guarantee: this member function never throws - exceptions. - - @liveexample{The following code exemplifies `is_number()` for all JSON - types.,is_number} - - @sa @ref is_number_integer() -- check if value is an integer or unsigned - integer number - @sa @ref is_number_unsigned() -- check if value is an unsigned integer - number - @sa @ref is_number_float() -- check if value is a floating-point number - - @since version 1.0.0 - */ - constexpr bool is_number() const noexcept - { - return is_number_integer() or is_number_float(); - } - - /*! - @brief return whether value is an integer number - - This function returns true iff the JSON value is an integer or unsigned - integer number. This excludes floating-point values. - - @return `true` if type is an integer or unsigned integer number, `false` - otherwise. - - @complexity Constant. - - @exceptionsafety No-throw guarantee: this member function never throws - exceptions. - - @liveexample{The following code exemplifies `is_number_integer()` for all - JSON types.,is_number_integer} - - @sa @ref is_number() -- check if value is a number - @sa @ref is_number_unsigned() -- check if value is an unsigned integer - number - @sa @ref is_number_float() -- check if value is a floating-point number - - @since version 1.0.0 - */ - constexpr bool is_number_integer() const noexcept - { - return m_type == value_t::number_integer or m_type == value_t::number_unsigned; - } - - /*! - @brief return whether value is an unsigned integer number - - This function returns true iff the JSON value is an unsigned integer - number. This excludes floating-point and (signed) integer values. - - @return `true` if type is an unsigned integer number, `false` otherwise. - - @complexity Constant. - - @exceptionsafety No-throw guarantee: this member function never throws - exceptions. - - @liveexample{The following code exemplifies `is_number_unsigned()` for all - JSON types.,is_number_unsigned} - - @sa @ref is_number() -- check if value is a number - @sa @ref is_number_integer() -- check if value is an integer or unsigned - integer number - @sa @ref is_number_float() -- check if value is a floating-point number - - @since version 2.0.0 - */ - constexpr bool is_number_unsigned() const noexcept - { - return m_type == value_t::number_unsigned; - } - - /*! - @brief return whether value is a floating-point number - - This function returns true iff the JSON value is a floating-point number. - This excludes integer and unsigned integer values. - - @return `true` if type is a floating-point number, `false` otherwise. - - @complexity Constant. - - @exceptionsafety No-throw guarantee: this member function never throws - exceptions. - - @liveexample{The following code exemplifies `is_number_float()` for all - JSON types.,is_number_float} - - @sa @ref is_number() -- check if value is number - @sa @ref is_number_integer() -- check if value is an integer number - @sa @ref is_number_unsigned() -- check if value is an unsigned integer - number - - @since version 1.0.0 - */ - constexpr bool is_number_float() const noexcept - { - return m_type == value_t::number_float; - } - - /*! - @brief return whether value is an object - - This function returns true iff the JSON value is an object. - - @return `true` if type is object, `false` otherwise. - - @complexity Constant. - - @exceptionsafety No-throw guarantee: this member function never throws - exceptions. - - @liveexample{The following code exemplifies `is_object()` for all JSON - types.,is_object} - - @since version 1.0.0 - */ - constexpr bool is_object() const noexcept - { - return m_type == value_t::object; - } - - /*! - @brief return whether value is an array - - This function returns true iff the JSON value is an array. - - @return `true` if type is array, `false` otherwise. - - @complexity Constant. - - @exceptionsafety No-throw guarantee: this member function never throws - exceptions. - - @liveexample{The following code exemplifies `is_array()` for all JSON - types.,is_array} - - @since version 1.0.0 - */ - constexpr bool is_array() const noexcept - { - return m_type == value_t::array; - } - - /*! - @brief return whether value is a string - - This function returns true iff the JSON value is a string. - - @return `true` if type is string, `false` otherwise. - - @complexity Constant. - - @exceptionsafety No-throw guarantee: this member function never throws - exceptions. - - @liveexample{The following code exemplifies `is_string()` for all JSON - types.,is_string} - - @since version 1.0.0 - */ - constexpr bool is_string() const noexcept - { - return m_type == value_t::string; - } - - /*! - @brief return whether value is discarded - - This function returns true iff the JSON value was discarded during parsing - with a callback function (see @ref parser_callback_t). - - @note This function will always be `false` for JSON values after parsing. - That is, discarded values can only occur during parsing, but will be - removed when inside a structured value or replaced by null in other cases. - - @return `true` if type is discarded, `false` otherwise. - - @complexity Constant. - - @exceptionsafety No-throw guarantee: this member function never throws - exceptions. - - @liveexample{The following code exemplifies `is_discarded()` for all JSON - types.,is_discarded} - - @since version 1.0.0 - */ - constexpr bool is_discarded() const noexcept - { - return m_type == value_t::discarded; - } - - /*! - @brief return the type of the JSON value (implicit) - - Implicitly return the type of the JSON value as a value from the @ref - value_t enumeration. - - @return the type of the JSON value - - @complexity Constant. - - @exceptionsafety No-throw guarantee: this member function never throws - exceptions. - - @liveexample{The following code exemplifies the @ref value_t operator for - all JSON types.,operator__value_t} - - @since version 1.0.0 - */ - constexpr operator value_t() const noexcept - { - return m_type; - } - - /// @} - - private: - ////////////////// - // value access // - ////////////////// - - /// get a boolean (explicit) - boolean_t get_impl(boolean_t* /*unused*/) const - { - if (is_boolean()) - { - return m_value.boolean; - } - - JSON_THROW(type_error::create(302, "type must be boolean, but is " + type_name())); - } - - /// get a pointer to the value (object) - object_t* get_impl_ptr(object_t* /*unused*/) noexcept - { - return is_object() ? m_value.object : nullptr; - } - - /// get a pointer to the value (object) - constexpr const object_t* get_impl_ptr(const object_t* /*unused*/) const noexcept - { - return is_object() ? m_value.object : nullptr; - } - - /// get a pointer to the value (array) - array_t* get_impl_ptr(array_t* /*unused*/) noexcept - { - return is_array() ? m_value.array : nullptr; - } - - /// get a pointer to the value (array) - constexpr const array_t* get_impl_ptr(const array_t* /*unused*/) const noexcept - { - return is_array() ? m_value.array : nullptr; - } - - /// get a pointer to the value (string) - string_t* get_impl_ptr(string_t* /*unused*/) noexcept - { - return is_string() ? m_value.string : nullptr; - } - - /// get a pointer to the value (string) - constexpr const string_t* get_impl_ptr(const string_t* /*unused*/) const noexcept - { - return is_string() ? m_value.string : nullptr; - } - - /// get a pointer to the value (boolean) - boolean_t* get_impl_ptr(boolean_t* /*unused*/) noexcept - { - return is_boolean() ? &m_value.boolean : nullptr; - } - - /// get a pointer to the value (boolean) - constexpr const boolean_t* get_impl_ptr(const boolean_t* /*unused*/) const noexcept - { - return is_boolean() ? &m_value.boolean : nullptr; - } - - /// get a pointer to the value (integer number) - number_integer_t* get_impl_ptr(number_integer_t* /*unused*/) noexcept - { - return is_number_integer() ? &m_value.number_integer : nullptr; - } - - /// get a pointer to the value (integer number) - constexpr const number_integer_t* get_impl_ptr(const number_integer_t* /*unused*/) const noexcept - { - return is_number_integer() ? &m_value.number_integer : nullptr; - } - - /// get a pointer to the value (unsigned number) - number_unsigned_t* get_impl_ptr(number_unsigned_t* /*unused*/) noexcept - { - return is_number_unsigned() ? &m_value.number_unsigned : nullptr; - } - - /// get a pointer to the value (unsigned number) - constexpr const number_unsigned_t* get_impl_ptr(const number_unsigned_t* /*unused*/) const noexcept - { - return is_number_unsigned() ? &m_value.number_unsigned : nullptr; - } - - /// get a pointer to the value (floating-point number) - number_float_t* get_impl_ptr(number_float_t* /*unused*/) noexcept - { - return is_number_float() ? &m_value.number_float : nullptr; - } - - /// get a pointer to the value (floating-point number) - constexpr const number_float_t* get_impl_ptr(const number_float_t* /*unused*/) const noexcept - { - return is_number_float() ? &m_value.number_float : nullptr; - } - - /*! - @brief helper function to implement get_ref() - - This function helps to implement get_ref() without code duplication for - const and non-const overloads - - @tparam ThisType will be deduced as `basic_json` or `const basic_json` - - @throw type_error.303 if ReferenceType does not match underlying value - type of the current JSON - */ - template - static ReferenceType get_ref_impl(ThisType& obj) - { - // helper type - using PointerType = typename std::add_pointer::type; - - // delegate the call to get_ptr<>() - auto ptr = obj.template get_ptr(); - - if (ptr != nullptr) - { - return *ptr; - } - - JSON_THROW(type_error::create(303, "incompatible ReferenceType for get_ref, actual type is " + obj.type_name())); - } - - public: - /// @name value access - /// Direct access to the stored value of a JSON value. - /// @{ - - /*! - @brief get special-case overload - - This overloads avoids a lot of template boilerplate, it can be seen as the - identity method - - @tparam BasicJsonType == @ref basic_json - - @return a copy of *this - - @complexity Constant. - - @since version 2.1.0 - */ - template < - typename BasicJsonType, - detail::enable_if_t::type, - basic_json_t>::value, - int> = 0 > - basic_json get() const - { - return *this; - } - - /*! - @brief get a value (explicit) - - Explicit type conversion between the JSON value and a compatible value - which is [CopyConstructible](http://en.cppreference.com/w/cpp/concept/CopyConstructible) - and [DefaultConstructible](http://en.cppreference.com/w/cpp/concept/DefaultConstructible). - The value is converted by calling the @ref json_serializer - `from_json()` method. - - The function is equivalent to executing - @code {.cpp} - ValueType ret; - JSONSerializer::from_json(*this, ret); - return ret; - @endcode - - This overloads is chosen if: - - @a ValueType is not @ref basic_json, - - @ref json_serializer has a `from_json()` method of the form - `void from_json(const basic_json&, ValueType&)`, and - - @ref json_serializer does not have a `from_json()` method of - the form `ValueType from_json(const basic_json&)` - - @tparam ValueTypeCV the provided value type - @tparam ValueType the returned value type - - @return copy of the JSON value, converted to @a ValueType - - @throw what @ref json_serializer `from_json()` method throws - - @liveexample{The example below shows several conversions from JSON values - to other types. There a few things to note: (1) Floating-point numbers can - be converted to integers\, (2) A JSON array can be converted to a standard - `std::vector`\, (3) A JSON object can be converted to C++ - associative containers such as `std::unordered_map`.,get__ValueType_const} - - @since version 2.1.0 - */ - template < - typename ValueTypeCV, - typename ValueType = detail::uncvref_t, - detail::enable_if_t < - not std::is_same::value and - detail::has_from_json::value and - not detail::has_non_default_from_json::value, - int > = 0 > - ValueType get() const noexcept(noexcept( - JSONSerializer::from_json(std::declval(), std::declval()))) - { - // we cannot static_assert on ValueTypeCV being non-const, because - // there is support for get(), which is why we - // still need the uncvref - static_assert(not std::is_reference::value, - "get() cannot be used with reference types, you might want to use get_ref()"); - static_assert(std::is_default_constructible::value, - "types must be DefaultConstructible when used with get()"); - - ValueType ret; - JSONSerializer::from_json(*this, ret); - return ret; - } - - /*! - @brief get a value (explicit); special case - - Explicit type conversion between the JSON value and a compatible value - which is **not** [CopyConstructible](http://en.cppreference.com/w/cpp/concept/CopyConstructible) - and **not** [DefaultConstructible](http://en.cppreference.com/w/cpp/concept/DefaultConstructible). - The value is converted by calling the @ref json_serializer - `from_json()` method. - - The function is equivalent to executing - @code {.cpp} - return JSONSerializer::from_json(*this); - @endcode - - This overloads is chosen if: - - @a ValueType is not @ref basic_json and - - @ref json_serializer has a `from_json()` method of the form - `ValueType from_json(const basic_json&)` - - @note If @ref json_serializer has both overloads of - `from_json()`, this one is chosen. - - @tparam ValueTypeCV the provided value type - @tparam ValueType the returned value type - - @return copy of the JSON value, converted to @a ValueType - - @throw what @ref json_serializer `from_json()` method throws - - @since version 2.1.0 - */ - template < - typename ValueTypeCV, - typename ValueType = detail::uncvref_t, - detail::enable_if_t::value and - detail::has_non_default_from_json::value, int> = 0 > - ValueType get() const noexcept(noexcept( - JSONSerializer::from_json(std::declval()))) - { - static_assert(not std::is_reference::value, - "get() cannot be used with reference types, you might want to use get_ref()"); - return JSONSerializer::from_json(*this); - } - - /*! - @brief get a pointer value (explicit) - - Explicit pointer access to the internally stored JSON value. No copies are - made. - - @warning The pointer becomes invalid if the underlying JSON object - changes. - - @tparam PointerType pointer type; must be a pointer to @ref array_t, @ref - object_t, @ref string_t, @ref boolean_t, @ref number_integer_t, - @ref number_unsigned_t, or @ref number_float_t. - - @return pointer to the internally stored JSON value if the requested - pointer type @a PointerType fits to the JSON value; `nullptr` otherwise - - @complexity Constant. - - @liveexample{The example below shows how pointers to internal values of a - JSON value can be requested. Note that no type conversions are made and a - `nullptr` is returned if the value and the requested pointer type does not - match.,get__PointerType} - - @sa @ref get_ptr() for explicit pointer-member access - - @since version 1.0.0 - */ - template::value, int>::type = 0> - PointerType get() noexcept - { - // delegate the call to get_ptr - return get_ptr(); - } - - /*! - @brief get a pointer value (explicit) - @copydoc get() - */ - template::value, int>::type = 0> - constexpr const PointerType get() const noexcept - { - // delegate the call to get_ptr - return get_ptr(); - } - - /*! - @brief get a pointer value (implicit) - - Implicit pointer access to the internally stored JSON value. No copies are - made. - - @warning Writing data to the pointee of the result yields an undefined - state. - - @tparam PointerType pointer type; must be a pointer to @ref array_t, @ref - object_t, @ref string_t, @ref boolean_t, @ref number_integer_t, - @ref number_unsigned_t, or @ref number_float_t. Enforced by a static - assertion. - - @return pointer to the internally stored JSON value if the requested - pointer type @a PointerType fits to the JSON value; `nullptr` otherwise - - @complexity Constant. - - @liveexample{The example below shows how pointers to internal values of a - JSON value can be requested. Note that no type conversions are made and a - `nullptr` is returned if the value and the requested pointer type does not - match.,get_ptr} - - @since version 1.0.0 - */ - template::value, int>::type = 0> - PointerType get_ptr() noexcept - { - // get the type of the PointerType (remove pointer and const) - using pointee_t = typename std::remove_const::type>::type>::type; - // make sure the type matches the allowed types - static_assert( - std::is_same::value - or std::is_same::value - or std::is_same::value - or std::is_same::value - or std::is_same::value - or std::is_same::value - or std::is_same::value - , "incompatible pointer type"); - - // delegate the call to get_impl_ptr<>() - return get_impl_ptr(static_cast(nullptr)); - } - - /*! - @brief get a pointer value (implicit) - @copydoc get_ptr() - */ - template::value and - std::is_const::type>::value, int>::type = 0> - constexpr const PointerType get_ptr() const noexcept - { - // get the type of the PointerType (remove pointer and const) - using pointee_t = typename std::remove_const::type>::type>::type; - // make sure the type matches the allowed types - static_assert( - std::is_same::value - or std::is_same::value - or std::is_same::value - or std::is_same::value - or std::is_same::value - or std::is_same::value - or std::is_same::value - , "incompatible pointer type"); - - // delegate the call to get_impl_ptr<>() const - return get_impl_ptr(static_cast(nullptr)); - } - - /*! - @brief get a reference value (implicit) - - Implicit reference access to the internally stored JSON value. No copies - are made. - - @warning Writing data to the referee of the result yields an undefined - state. - - @tparam ReferenceType reference type; must be a reference to @ref array_t, - @ref object_t, @ref string_t, @ref boolean_t, @ref number_integer_t, or - @ref number_float_t. Enforced by static assertion. - - @return reference to the internally stored JSON value if the requested - reference type @a ReferenceType fits to the JSON value; throws - type_error.303 otherwise - - @throw type_error.303 in case passed type @a ReferenceType is incompatible - with the stored JSON value; see example below - - @complexity Constant. - - @liveexample{The example shows several calls to `get_ref()`.,get_ref} - - @since version 1.1.0 - */ - template::value, int>::type = 0> - ReferenceType get_ref() - { - // delegate call to get_ref_impl - return get_ref_impl(*this); - } - - /*! - @brief get a reference value (implicit) - @copydoc get_ref() - */ - template::value and - std::is_const::type>::value, int>::type = 0> - ReferenceType get_ref() const - { - // delegate call to get_ref_impl - return get_ref_impl(*this); - } - - /*! - @brief get a value (implicit) - - Implicit type conversion between the JSON value and a compatible value. - The call is realized by calling @ref get() const. - - @tparam ValueType non-pointer type compatible to the JSON value, for - instance `int` for JSON integer numbers, `bool` for JSON booleans, or - `std::vector` types for JSON arrays. The character type of @ref string_t - as well as an initializer list of this type is excluded to avoid - ambiguities as these types implicitly convert to `std::string`. - - @return copy of the JSON value, converted to type @a ValueType - - @throw type_error.302 in case passed type @a ValueType is incompatible - to the JSON value type (e.g., the JSON value is of type boolean, but a - string is requested); see example below - - @complexity Linear in the size of the JSON value. - - @liveexample{The example below shows several conversions from JSON values - to other types. There a few things to note: (1) Floating-point numbers can - be converted to integers\, (2) A JSON array can be converted to a standard - `std::vector`\, (3) A JSON object can be converted to C++ - associative containers such as `std::unordered_map`.,operator__ValueType} - - @since version 1.0.0 - */ - template < typename ValueType, typename std::enable_if < - not std::is_pointer::value and - not std::is_same::value -#ifndef _MSC_VER // fix for issue #167 operator<< ambiguity under VS2015 - and not std::is_same>::value -#endif -#if (defined(__cplusplus) && __cplusplus >= 201703L) || (defined(_MSC_VER) && _MSC_VER >1900 && defined(_HAS_CXX17) && _HAS_CXX17 == 1) // fix for issue #464 - and not std::is_same::value -#endif - , int >::type = 0 > - operator ValueType() const - { - // delegate the call to get<>() const - return get(); - } - - /// @} - - - //////////////////// - // element access // - //////////////////// - - /// @name element access - /// Access to the JSON value. - /// @{ - - /*! - @brief access specified array element with bounds checking - - Returns a reference to the element at specified location @a idx, with - bounds checking. - - @param[in] idx index of the element to access - - @return reference to the element at index @a idx - - @throw type_error.304 if the JSON value is not an array; in this case, - calling `at` with an index makes no sense. See example below. - @throw out_of_range.401 if the index @a idx is out of range of the array; - that is, `idx >= size()`. See example below. - - @exceptionsafety Strong guarantee: if an exception is thrown, there are no - changes in the JSON value. - - @complexity Constant. - - @since version 1.0.0 - - @liveexample{The example below shows how array elements can be read and - written using `at()`. It also demonstrates the different exceptions that - can be thrown.,at__size_type} - */ - reference at(size_type idx) - { - // at only works for arrays - if (is_array()) - { - JSON_TRY - { - return m_value.array->at(idx); - } - JSON_CATCH (std::out_of_range&) - { - // create better exception explanation - JSON_THROW(out_of_range::create(401, "array index " + std::to_string(idx) + " is out of range")); - } - } - else - { - JSON_THROW(type_error::create(304, "cannot use at() with " + type_name())); - } - } - - /*! - @brief access specified array element with bounds checking - - Returns a const reference to the element at specified location @a idx, - with bounds checking. - - @param[in] idx index of the element to access - - @return const reference to the element at index @a idx - - @throw type_error.304 if the JSON value is not an array; in this case, - calling `at` with an index makes no sense. See example below. - @throw out_of_range.401 if the index @a idx is out of range of the array; - that is, `idx >= size()`. See example below. - - @exceptionsafety Strong guarantee: if an exception is thrown, there are no - changes in the JSON value. - - @complexity Constant. - - @since version 1.0.0 - - @liveexample{The example below shows how array elements can be read using - `at()`. It also demonstrates the different exceptions that can be thrown., - at__size_type_const} - */ - const_reference at(size_type idx) const - { - // at only works for arrays - if (is_array()) - { - JSON_TRY - { - return m_value.array->at(idx); - } - JSON_CATCH (std::out_of_range&) - { - // create better exception explanation - JSON_THROW(out_of_range::create(401, "array index " + std::to_string(idx) + " is out of range")); - } - } - else - { - JSON_THROW(type_error::create(304, "cannot use at() with " + type_name())); - } - } - - /*! - @brief access specified object element with bounds checking - - Returns a reference to the element at with specified key @a key, with - bounds checking. - - @param[in] key key of the element to access - - @return reference to the element at key @a key - - @throw type_error.304 if the JSON value is not an object; in this case, - calling `at` with a key makes no sense. See example below. - @throw out_of_range.403 if the key @a key is is not stored in the object; - that is, `find(key) == end()`. See example below. - - @exceptionsafety Strong guarantee: if an exception is thrown, there are no - changes in the JSON value. - - @complexity Logarithmic in the size of the container. - - @sa @ref operator[](const typename object_t::key_type&) for unchecked - access by reference - @sa @ref value() for access by value with a default value - - @since version 1.0.0 - - @liveexample{The example below shows how object elements can be read and - written using `at()`. It also demonstrates the different exceptions that - can be thrown.,at__object_t_key_type} - */ - reference at(const typename object_t::key_type& key) - { - // at only works for objects - if (is_object()) - { - JSON_TRY - { - return m_value.object->at(key); - } - JSON_CATCH (std::out_of_range&) - { - // create better exception explanation - JSON_THROW(out_of_range::create(403, "key '" + key + "' not found")); - } - } - else - { - JSON_THROW(type_error::create(304, "cannot use at() with " + type_name())); - } - } - - /*! - @brief access specified object element with bounds checking - - Returns a const reference to the element at with specified key @a key, - with bounds checking. - - @param[in] key key of the element to access - - @return const reference to the element at key @a key - - @throw type_error.304 if the JSON value is not an object; in this case, - calling `at` with a key makes no sense. See example below. - @throw out_of_range.403 if the key @a key is is not stored in the object; - that is, `find(key) == end()`. See example below. - - @exceptionsafety Strong guarantee: if an exception is thrown, there are no - changes in the JSON value. - - @complexity Logarithmic in the size of the container. - - @sa @ref operator[](const typename object_t::key_type&) for unchecked - access by reference - @sa @ref value() for access by value with a default value - - @since version 1.0.0 - - @liveexample{The example below shows how object elements can be read using - `at()`. It also demonstrates the different exceptions that can be thrown., - at__object_t_key_type_const} - */ - const_reference at(const typename object_t::key_type& key) const - { - // at only works for objects - if (is_object()) - { - JSON_TRY - { - return m_value.object->at(key); - } - JSON_CATCH (std::out_of_range&) - { - // create better exception explanation - JSON_THROW(out_of_range::create(403, "key '" + key + "' not found")); - } - } - else - { - JSON_THROW(type_error::create(304, "cannot use at() with " + type_name())); - } - } - - /*! - @brief access specified array element - - Returns a reference to the element at specified location @a idx. - - @note If @a idx is beyond the range of the array (i.e., `idx >= size()`), - then the array is silently filled up with `null` values to make `idx` a - valid reference to the last stored element. - - @param[in] idx index of the element to access - - @return reference to the element at index @a idx - - @throw type_error.305 if the JSON value is not an array or null; in that - cases, using the [] operator with an index makes no sense. - - @complexity Constant if @a idx is in the range of the array. Otherwise - linear in `idx - size()`. - - @liveexample{The example below shows how array elements can be read and - written using `[]` operator. Note the addition of `null` - values.,operatorarray__size_type} - - @since version 1.0.0 - */ - reference operator[](size_type idx) - { - // implicitly convert null value to an empty array - if (is_null()) - { - m_type = value_t::array; - m_value.array = create(); - assert_invariant(); - } - - // operator[] only works for arrays - if (is_array()) - { - // fill up array with null values if given idx is outside range - if (idx >= m_value.array->size()) - { - m_value.array->insert(m_value.array->end(), - idx - m_value.array->size() + 1, - basic_json()); - } - - return m_value.array->operator[](idx); - } - - JSON_THROW(type_error::create(305, "cannot use operator[] with " + type_name())); - } - - /*! - @brief access specified array element - - Returns a const reference to the element at specified location @a idx. - - @param[in] idx index of the element to access - - @return const reference to the element at index @a idx - - @throw type_error.305 if the JSON value is not an array; in that cases, - using the [] operator with an index makes no sense. - - @complexity Constant. - - @liveexample{The example below shows how array elements can be read using - the `[]` operator.,operatorarray__size_type_const} - - @since version 1.0.0 - */ - const_reference operator[](size_type idx) const - { - // const operator[] only works for arrays - if (is_array()) - { - return m_value.array->operator[](idx); - } - - JSON_THROW(type_error::create(305, "cannot use operator[] with " + type_name())); - } - - /*! - @brief access specified object element - - Returns a reference to the element at with specified key @a key. - - @note If @a key is not found in the object, then it is silently added to - the object and filled with a `null` value to make `key` a valid reference. - In case the value was `null` before, it is converted to an object. - - @param[in] key key of the element to access - - @return reference to the element at key @a key - - @throw type_error.305 if the JSON value is not an object or null; in that - cases, using the [] operator with a key makes no sense. - - @complexity Logarithmic in the size of the container. - - @liveexample{The example below shows how object elements can be read and - written using the `[]` operator.,operatorarray__key_type} - - @sa @ref at(const typename object_t::key_type&) for access by reference - with range checking - @sa @ref value() for access by value with a default value - - @since version 1.0.0 - */ - reference operator[](const typename object_t::key_type& key) - { - // implicitly convert null value to an empty object - if (is_null()) - { - m_type = value_t::object; - m_value.object = create(); - assert_invariant(); - } - - // operator[] only works for objects - if (is_object()) - { - return m_value.object->operator[](key); - } - - JSON_THROW(type_error::create(305, "cannot use operator[] with " + type_name())); - } - - /*! - @brief read-only access specified object element - - Returns a const reference to the element at with specified key @a key. No - bounds checking is performed. - - @warning If the element with key @a key does not exist, the behavior is - undefined. - - @param[in] key key of the element to access - - @return const reference to the element at key @a key - - @pre The element with key @a key must exist. **This precondition is - enforced with an assertion.** - - @throw type_error.305 if the JSON value is not an object; in that cases, - using the [] operator with a key makes no sense. - - @complexity Logarithmic in the size of the container. - - @liveexample{The example below shows how object elements can be read using - the `[]` operator.,operatorarray__key_type_const} - - @sa @ref at(const typename object_t::key_type&) for access by reference - with range checking - @sa @ref value() for access by value with a default value - - @since version 1.0.0 - */ - const_reference operator[](const typename object_t::key_type& key) const - { - // const operator[] only works for objects - if (is_object()) - { - assert(m_value.object->find(key) != m_value.object->end()); - return m_value.object->find(key)->second; - } - - JSON_THROW(type_error::create(305, "cannot use operator[] with " + type_name())); - } - - /*! - @brief access specified object element - - Returns a reference to the element at with specified key @a key. - - @note If @a key is not found in the object, then it is silently added to - the object and filled with a `null` value to make `key` a valid reference. - In case the value was `null` before, it is converted to an object. - - @param[in] key key of the element to access - - @return reference to the element at key @a key - - @throw type_error.305 if the JSON value is not an object or null; in that - cases, using the [] operator with a key makes no sense. - - @complexity Logarithmic in the size of the container. - - @liveexample{The example below shows how object elements can be read and - written using the `[]` operator.,operatorarray__key_type} - - @sa @ref at(const typename object_t::key_type&) for access by reference - with range checking - @sa @ref value() for access by value with a default value - - @since version 1.1.0 - */ - template - reference operator[](T* key) - { - // implicitly convert null to object - if (is_null()) - { - m_type = value_t::object; - m_value = value_t::object; - assert_invariant(); - } - - // at only works for objects - if (is_object()) - { - return m_value.object->operator[](key); - } - - JSON_THROW(type_error::create(305, "cannot use operator[] with " + type_name())); - } - - /*! - @brief read-only access specified object element - - Returns a const reference to the element at with specified key @a key. No - bounds checking is performed. - - @warning If the element with key @a key does not exist, the behavior is - undefined. - - @param[in] key key of the element to access - - @return const reference to the element at key @a key - - @pre The element with key @a key must exist. **This precondition is - enforced with an assertion.** - - @throw type_error.305 if the JSON value is not an object; in that cases, - using the [] operator with a key makes no sense. - - @complexity Logarithmic in the size of the container. - - @liveexample{The example below shows how object elements can be read using - the `[]` operator.,operatorarray__key_type_const} - - @sa @ref at(const typename object_t::key_type&) for access by reference - with range checking - @sa @ref value() for access by value with a default value - - @since version 1.1.0 - */ - template - const_reference operator[](T* key) const - { - // at only works for objects - if (is_object()) - { - assert(m_value.object->find(key) != m_value.object->end()); - return m_value.object->find(key)->second; - } - - JSON_THROW(type_error::create(305, "cannot use operator[] with " + type_name())); - } - - /*! - @brief access specified object element with default value - - Returns either a copy of an object's element at the specified key @a key - or a given default value if no element with key @a key exists. - - The function is basically equivalent to executing - @code {.cpp} - try { - return at(key); - } catch(out_of_range) { - return default_value; - } - @endcode - - @note Unlike @ref at(const typename object_t::key_type&), this function - does not throw if the given key @a key was not found. - - @note Unlike @ref operator[](const typename object_t::key_type& key), this - function does not implicitly add an element to the position defined by @a - key. This function is furthermore also applicable to const objects. - - @param[in] key key of the element to access - @param[in] default_value the value to return if @a key is not found - - @tparam ValueType type compatible to JSON values, for instance `int` for - JSON integer numbers, `bool` for JSON booleans, or `std::vector` types for - JSON arrays. Note the type of the expected value at @a key and the default - value @a default_value must be compatible. - - @return copy of the element at key @a key or @a default_value if @a key - is not found - - @throw type_error.306 if the JSON value is not an objec; in that cases, - using `value()` with a key makes no sense. - - @complexity Logarithmic in the size of the container. - - @liveexample{The example below shows how object elements can be queried - with a default value.,basic_json__value} - - @sa @ref at(const typename object_t::key_type&) for access by reference - with range checking - @sa @ref operator[](const typename object_t::key_type&) for unchecked - access by reference - - @since version 1.0.0 - */ - template::value, int>::type = 0> - ValueType value(const typename object_t::key_type& key, ValueType default_value) const - { - // at only works for objects - if (is_object()) - { - // if key is found, return value and given default value otherwise - const auto it = find(key); - if (it != end()) - { - return *it; - } - - return default_value; - } - else - { - JSON_THROW(type_error::create(306, "cannot use value() with " + type_name())); - } - } - - /*! - @brief overload for a default value of type const char* - @copydoc basic_json::value(const typename object_t::key_type&, ValueType) const - */ - string_t value(const typename object_t::key_type& key, const char* default_value) const - { - return value(key, string_t(default_value)); - } - - /*! - @brief access specified object element via JSON Pointer with default value - - Returns either a copy of an object's element at the specified key @a key - or a given default value if no element with key @a key exists. - - The function is basically equivalent to executing - @code {.cpp} - try { - return at(ptr); - } catch(out_of_range) { - return default_value; - } - @endcode - - @note Unlike @ref at(const json_pointer&), this function does not throw - if the given key @a key was not found. - - @param[in] ptr a JSON pointer to the element to access - @param[in] default_value the value to return if @a ptr found no value - - @tparam ValueType type compatible to JSON values, for instance `int` for - JSON integer numbers, `bool` for JSON booleans, or `std::vector` types for - JSON arrays. Note the type of the expected value at @a key and the default - value @a default_value must be compatible. - - @return copy of the element at key @a key or @a default_value if @a key - is not found - - @throw type_error.306 if the JSON value is not an objec; in that cases, - using `value()` with a key makes no sense. - - @complexity Logarithmic in the size of the container. - - @liveexample{The example below shows how object elements can be queried - with a default value.,basic_json__value_ptr} - - @sa @ref operator[](const json_pointer&) for unchecked access by reference - - @since version 2.0.2 - */ - template::value, int>::type = 0> - ValueType value(const json_pointer& ptr, ValueType default_value) const - { - // at only works for objects - if (is_object()) - { - // if pointer resolves a value, return it or use default value - JSON_TRY - { - return ptr.get_checked(this); - } - JSON_CATCH (out_of_range&) - { - return default_value; - } - } - - JSON_THROW(type_error::create(306, "cannot use value() with " + type_name())); - } - - /*! - @brief overload for a default value of type const char* - @copydoc basic_json::value(const json_pointer&, ValueType) const - */ - string_t value(const json_pointer& ptr, const char* default_value) const - { - return value(ptr, string_t(default_value)); - } - - /*! - @brief access the first element - - Returns a reference to the first element in the container. For a JSON - container `c`, the expression `c.front()` is equivalent to `*c.begin()`. - - @return In case of a structured type (array or object), a reference to the - first element is returned. In case of number, string, or boolean values, a - reference to the value is returned. - - @complexity Constant. - - @pre The JSON value must not be `null` (would throw `std::out_of_range`) - or an empty array or object (undefined behavior, **guarded by - assertions**). - @post The JSON value remains unchanged. - - @throw invalid_iterator.214 when called on `null` value - - @liveexample{The following code shows an example for `front()`.,front} - - @sa @ref back() -- access the last element - - @since version 1.0.0 - */ - reference front() - { - return *begin(); - } - - /*! - @copydoc basic_json::front() - */ - const_reference front() const - { - return *cbegin(); - } - - /*! - @brief access the last element - - Returns a reference to the last element in the container. For a JSON - container `c`, the expression `c.back()` is equivalent to - @code {.cpp} - auto tmp = c.end(); - --tmp; - return *tmp; - @endcode - - @return In case of a structured type (array or object), a reference to the - last element is returned. In case of number, string, or boolean values, a - reference to the value is returned. - - @complexity Constant. - - @pre The JSON value must not be `null` (would throw `std::out_of_range`) - or an empty array or object (undefined behavior, **guarded by - assertions**). - @post The JSON value remains unchanged. - - @throw invalid_iterator.214 when called on a `null` value. See example - below. - - @liveexample{The following code shows an example for `back()`.,back} - - @sa @ref front() -- access the first element - - @since version 1.0.0 - */ - reference back() - { - auto tmp = end(); - --tmp; - return *tmp; - } - - /*! - @copydoc basic_json::back() - */ - const_reference back() const - { - auto tmp = cend(); - --tmp; - return *tmp; - } - - /*! - @brief remove element given an iterator - - Removes the element specified by iterator @a pos. The iterator @a pos must - be valid and dereferenceable. Thus the `end()` iterator (which is valid, - but is not dereferenceable) cannot be used as a value for @a pos. - - If called on a primitive type other than `null`, the resulting JSON value - will be `null`. - - @param[in] pos iterator to the element to remove - @return Iterator following the last removed element. If the iterator @a - pos refers to the last element, the `end()` iterator is returned. - - @tparam IteratorType an @ref iterator or @ref const_iterator - - @post Invalidates iterators and references at or after the point of the - erase, including the `end()` iterator. - - @throw type_error.307 if called on a `null` value; example: `"cannot use - erase() with null"` - @throw invalid_iterator.202 if called on an iterator which does not belong - to the current JSON value; example: `"iterator does not fit current - value"` - @throw invalid_iterator.205 if called on a primitive type with invalid - iterator (i.e., any iterator which is not `begin()`); example: `"iterator - out of range"` - - @complexity The complexity depends on the type: - - objects: amortized constant - - arrays: linear in distance between @a pos and the end of the container - - strings: linear in the length of the string - - other types: constant - - @liveexample{The example shows the result of `erase()` for different JSON - types.,erase__IteratorType} - - @sa @ref erase(IteratorType, IteratorType) -- removes the elements in - the given range - @sa @ref erase(const typename object_t::key_type&) -- removes the element - from an object at the given key - @sa @ref erase(const size_type) -- removes the element from an array at - the given index - - @since version 1.0.0 - */ - template::value or - std::is_same::value, int>::type - = 0> - IteratorType erase(IteratorType pos) - { - // make sure iterator fits the current value - if (this != pos.m_object) - { - JSON_THROW(invalid_iterator::create(202, "iterator does not fit current value")); - } - - IteratorType result = end(); - - switch (m_type) - { - case value_t::boolean: - case value_t::number_float: - case value_t::number_integer: - case value_t::number_unsigned: - case value_t::string: - { - if (not pos.m_it.primitive_iterator.is_begin()) - { - JSON_THROW(invalid_iterator::create(205, "iterator out of range")); - } - - if (is_string()) - { - AllocatorType alloc; - alloc.destroy(m_value.string); - alloc.deallocate(m_value.string, 1); - m_value.string = nullptr; - } - - m_type = value_t::null; - assert_invariant(); - break; - } - - case value_t::object: - { - result.m_it.object_iterator = m_value.object->erase(pos.m_it.object_iterator); - break; - } - - case value_t::array: - { - result.m_it.array_iterator = m_value.array->erase(pos.m_it.array_iterator); - break; - } - - default: - { - JSON_THROW(type_error::create(307, "cannot use erase() with " + type_name())); - } - } - - return result; - } - - /*! - @brief remove elements given an iterator range - - Removes the element specified by the range `[first; last)`. The iterator - @a first does not need to be dereferenceable if `first == last`: erasing - an empty range is a no-op. - - If called on a primitive type other than `null`, the resulting JSON value - will be `null`. - - @param[in] first iterator to the beginning of the range to remove - @param[in] last iterator past the end of the range to remove - @return Iterator following the last removed element. If the iterator @a - second refers to the last element, the `end()` iterator is returned. - - @tparam IteratorType an @ref iterator or @ref const_iterator - - @post Invalidates iterators and references at or after the point of the - erase, including the `end()` iterator. - - @throw type_error.307 if called on a `null` value; example: `"cannot use - erase() with null"` - @throw invalid_iterator.203 if called on iterators which does not belong - to the current JSON value; example: `"iterators do not fit current value"` - @throw invalid_iterator.204 if called on a primitive type with invalid - iterators (i.e., if `first != begin()` and `last != end()`); example: - `"iterators out of range"` - - @complexity The complexity depends on the type: - - objects: `log(size()) + std::distance(first, last)` - - arrays: linear in the distance between @a first and @a last, plus linear - in the distance between @a last and end of the container - - strings: linear in the length of the string - - other types: constant - - @liveexample{The example shows the result of `erase()` for different JSON - types.,erase__IteratorType_IteratorType} - - @sa @ref erase(IteratorType) -- removes the element at a given position - @sa @ref erase(const typename object_t::key_type&) -- removes the element - from an object at the given key - @sa @ref erase(const size_type) -- removes the element from an array at - the given index - - @since version 1.0.0 - */ - template::value or - std::is_same::value, int>::type - = 0> - IteratorType erase(IteratorType first, IteratorType last) - { - // make sure iterator fits the current value - if (this != first.m_object or this != last.m_object) - { - JSON_THROW(invalid_iterator::create(203, "iterators do not fit current value")); - } - - IteratorType result = end(); - - switch (m_type) - { - case value_t::boolean: - case value_t::number_float: - case value_t::number_integer: - case value_t::number_unsigned: - case value_t::string: - { - if (not first.m_it.primitive_iterator.is_begin() or not last.m_it.primitive_iterator.is_end()) - { - JSON_THROW(invalid_iterator::create(204, "iterators out of range")); - } - - if (is_string()) - { - AllocatorType alloc; - alloc.destroy(m_value.string); - alloc.deallocate(m_value.string, 1); - m_value.string = nullptr; - } - - m_type = value_t::null; - assert_invariant(); - break; - } - - case value_t::object: - { - result.m_it.object_iterator = m_value.object->erase(first.m_it.object_iterator, - last.m_it.object_iterator); - break; - } - - case value_t::array: - { - result.m_it.array_iterator = m_value.array->erase(first.m_it.array_iterator, - last.m_it.array_iterator); - break; - } - - default: - { - JSON_THROW(type_error::create(307, "cannot use erase() with " + type_name())); - } - } - - return result; - } - - /*! - @brief remove element from a JSON object given a key - - Removes elements from a JSON object with the key value @a key. - - @param[in] key value of the elements to remove - - @return Number of elements removed. If @a ObjectType is the default - `std::map` type, the return value will always be `0` (@a key was not - found) or `1` (@a key was found). - - @post References and iterators to the erased elements are invalidated. - Other references and iterators are not affected. - - @throw type_error.307 when called on a type other than JSON object; - example: `"cannot use erase() with null"` - - @complexity `log(size()) + count(key)` - - @liveexample{The example shows the effect of `erase()`.,erase__key_type} - - @sa @ref erase(IteratorType) -- removes the element at a given position - @sa @ref erase(IteratorType, IteratorType) -- removes the elements in - the given range - @sa @ref erase(const size_type) -- removes the element from an array at - the given index - - @since version 1.0.0 - */ - size_type erase(const typename object_t::key_type& key) - { - // this erase only works for objects - if (is_object()) - { - return m_value.object->erase(key); - } - - JSON_THROW(type_error::create(307, "cannot use erase() with " + type_name())); - } - - /*! - @brief remove element from a JSON array given an index - - Removes element from a JSON array at the index @a idx. - - @param[in] idx index of the element to remove - - @throw type_error.307 when called on a type other than JSON object; - example: `"cannot use erase() with null"` - @throw out_of_range.401 when `idx >= size()`; example: `"array index 17 - is out of range"` - - @complexity Linear in distance between @a idx and the end of the container. - - @liveexample{The example shows the effect of `erase()`.,erase__size_type} - - @sa @ref erase(IteratorType) -- removes the element at a given position - @sa @ref erase(IteratorType, IteratorType) -- removes the elements in - the given range - @sa @ref erase(const typename object_t::key_type&) -- removes the element - from an object at the given key - - @since version 1.0.0 - */ - void erase(const size_type idx) - { - // this erase only works for arrays - if (is_array()) - { - if (idx >= size()) - { - JSON_THROW(out_of_range::create(401, "array index " + std::to_string(idx) + " is out of range")); - } - - m_value.array->erase(m_value.array->begin() + static_cast(idx)); - } - else - { - JSON_THROW(type_error::create(307, "cannot use erase() with " + type_name())); - } - } - - /// @} - - - //////////// - // lookup // - //////////// - - /// @name lookup - /// @{ - - /*! - @brief find an element in a JSON object - - Finds an element in a JSON object with key equivalent to @a key. If the - element is not found or the JSON value is not an object, end() is - returned. - - @note This method always returns @ref end() when executed on a JSON type - that is not an object. - - @param[in] key key value of the element to search for - - @return Iterator to an element with key equivalent to @a key. If no such - element is found or the JSON value is not an object, past-the-end (see - @ref end()) iterator is returned. - - @complexity Logarithmic in the size of the JSON object. - - @liveexample{The example shows how `find()` is used.,find__key_type} - - @since version 1.0.0 - */ - iterator find(typename object_t::key_type key) - { - auto result = end(); - - if (is_object()) - { - result.m_it.object_iterator = m_value.object->find(key); - } - - return result; - } - - /*! - @brief find an element in a JSON object - @copydoc find(typename object_t::key_type) - */ - const_iterator find(typename object_t::key_type key) const - { - auto result = cend(); - - if (is_object()) - { - result.m_it.object_iterator = m_value.object->find(key); - } - - return result; - } - - /*! - @brief returns the number of occurrences of a key in a JSON object - - Returns the number of elements with key @a key. If ObjectType is the - default `std::map` type, the return value will always be `0` (@a key was - not found) or `1` (@a key was found). - - @note This method always returns `0` when executed on a JSON type that is - not an object. - - @param[in] key key value of the element to count - - @return Number of elements with key @a key. If the JSON value is not an - object, the return value will be `0`. - - @complexity Logarithmic in the size of the JSON object. - - @liveexample{The example shows how `count()` is used.,count} - - @since version 1.0.0 - */ - size_type count(typename object_t::key_type key) const - { - // return 0 for all nonobject types - return is_object() ? m_value.object->count(key) : 0; - } - - /// @} - - - /////////////// - // iterators // - /////////////// - - /// @name iterators - /// @{ - - /*! - @brief returns an iterator to the first element - - Returns an iterator to the first element. - - @image html range-begin-end.svg "Illustration from cppreference.com" - - @return iterator to the first element - - @complexity Constant. - - @requirement This function helps `basic_json` satisfying the - [Container](http://en.cppreference.com/w/cpp/concept/Container) - requirements: - - The complexity is constant. - - @liveexample{The following code shows an example for `begin()`.,begin} - - @sa @ref cbegin() -- returns a const iterator to the beginning - @sa @ref end() -- returns an iterator to the end - @sa @ref cend() -- returns a const iterator to the end - - @since version 1.0.0 - */ - iterator begin() noexcept - { - iterator result(this); - result.set_begin(); - return result; - } - - /*! - @copydoc basic_json::cbegin() - */ - const_iterator begin() const noexcept - { - return cbegin(); - } - - /*! - @brief returns a const iterator to the first element - - Returns a const iterator to the first element. - - @image html range-begin-end.svg "Illustration from cppreference.com" - - @return const iterator to the first element - - @complexity Constant. - - @requirement This function helps `basic_json` satisfying the - [Container](http://en.cppreference.com/w/cpp/concept/Container) - requirements: - - The complexity is constant. - - Has the semantics of `const_cast(*this).begin()`. - - @liveexample{The following code shows an example for `cbegin()`.,cbegin} - - @sa @ref begin() -- returns an iterator to the beginning - @sa @ref end() -- returns an iterator to the end - @sa @ref cend() -- returns a const iterator to the end - - @since version 1.0.0 - */ - const_iterator cbegin() const noexcept - { - const_iterator result(this); - result.set_begin(); - return result; - } - - /*! - @brief returns an iterator to one past the last element - - Returns an iterator to one past the last element. - - @image html range-begin-end.svg "Illustration from cppreference.com" - - @return iterator one past the last element - - @complexity Constant. - - @requirement This function helps `basic_json` satisfying the - [Container](http://en.cppreference.com/w/cpp/concept/Container) - requirements: - - The complexity is constant. - - @liveexample{The following code shows an example for `end()`.,end} - - @sa @ref cend() -- returns a const iterator to the end - @sa @ref begin() -- returns an iterator to the beginning - @sa @ref cbegin() -- returns a const iterator to the beginning - - @since version 1.0.0 - */ - iterator end() noexcept - { - iterator result(this); - result.set_end(); - return result; - } - - /*! - @copydoc basic_json::cend() - */ - const_iterator end() const noexcept - { - return cend(); - } - - /*! - @brief returns a const iterator to one past the last element - - Returns a const iterator to one past the last element. - - @image html range-begin-end.svg "Illustration from cppreference.com" - - @return const iterator one past the last element - - @complexity Constant. - - @requirement This function helps `basic_json` satisfying the - [Container](http://en.cppreference.com/w/cpp/concept/Container) - requirements: - - The complexity is constant. - - Has the semantics of `const_cast(*this).end()`. - - @liveexample{The following code shows an example for `cend()`.,cend} - - @sa @ref end() -- returns an iterator to the end - @sa @ref begin() -- returns an iterator to the beginning - @sa @ref cbegin() -- returns a const iterator to the beginning - - @since version 1.0.0 - */ - const_iterator cend() const noexcept - { - const_iterator result(this); - result.set_end(); - return result; - } - - /*! - @brief returns an iterator to the reverse-beginning - - Returns an iterator to the reverse-beginning; that is, the last element. - - @image html range-rbegin-rend.svg "Illustration from cppreference.com" - - @complexity Constant. - - @requirement This function helps `basic_json` satisfying the - [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer) - requirements: - - The complexity is constant. - - Has the semantics of `reverse_iterator(end())`. - - @liveexample{The following code shows an example for `rbegin()`.,rbegin} - - @sa @ref crbegin() -- returns a const reverse iterator to the beginning - @sa @ref rend() -- returns a reverse iterator to the end - @sa @ref crend() -- returns a const reverse iterator to the end - - @since version 1.0.0 - */ - reverse_iterator rbegin() noexcept - { - return reverse_iterator(end()); - } - - /*! - @copydoc basic_json::crbegin() - */ - const_reverse_iterator rbegin() const noexcept - { - return crbegin(); - } - - /*! - @brief returns an iterator to the reverse-end - - Returns an iterator to the reverse-end; that is, one before the first - element. - - @image html range-rbegin-rend.svg "Illustration from cppreference.com" - - @complexity Constant. - - @requirement This function helps `basic_json` satisfying the - [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer) - requirements: - - The complexity is constant. - - Has the semantics of `reverse_iterator(begin())`. - - @liveexample{The following code shows an example for `rend()`.,rend} - - @sa @ref crend() -- returns a const reverse iterator to the end - @sa @ref rbegin() -- returns a reverse iterator to the beginning - @sa @ref crbegin() -- returns a const reverse iterator to the beginning - - @since version 1.0.0 - */ - reverse_iterator rend() noexcept - { - return reverse_iterator(begin()); - } - - /*! - @copydoc basic_json::crend() - */ - const_reverse_iterator rend() const noexcept - { - return crend(); - } - - /*! - @brief returns a const reverse iterator to the last element - - Returns a const iterator to the reverse-beginning; that is, the last - element. - - @image html range-rbegin-rend.svg "Illustration from cppreference.com" - - @complexity Constant. - - @requirement This function helps `basic_json` satisfying the - [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer) - requirements: - - The complexity is constant. - - Has the semantics of `const_cast(*this).rbegin()`. - - @liveexample{The following code shows an example for `crbegin()`.,crbegin} - - @sa @ref rbegin() -- returns a reverse iterator to the beginning - @sa @ref rend() -- returns a reverse iterator to the end - @sa @ref crend() -- returns a const reverse iterator to the end - - @since version 1.0.0 - */ - const_reverse_iterator crbegin() const noexcept - { - return const_reverse_iterator(cend()); - } - - /*! - @brief returns a const reverse iterator to one before the first - - Returns a const reverse iterator to the reverse-end; that is, one before - the first element. - - @image html range-rbegin-rend.svg "Illustration from cppreference.com" - - @complexity Constant. - - @requirement This function helps `basic_json` satisfying the - [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer) - requirements: - - The complexity is constant. - - Has the semantics of `const_cast(*this).rend()`. - - @liveexample{The following code shows an example for `crend()`.,crend} - - @sa @ref rend() -- returns a reverse iterator to the end - @sa @ref rbegin() -- returns a reverse iterator to the beginning - @sa @ref crbegin() -- returns a const reverse iterator to the beginning - - @since version 1.0.0 - */ - const_reverse_iterator crend() const noexcept - { - return const_reverse_iterator(cbegin()); - } - - private: - // forward declaration - template class iteration_proxy; - - public: - /*! - @brief wrapper to access iterator member functions in range-based for - - This function allows to access @ref iterator::key() and @ref - iterator::value() during range-based for loops. In these loops, a - reference to the JSON values is returned, so there is no access to the - underlying iterator. - - @liveexample{The following code shows how the wrapper is used,iterator_wrapper} - - @note The name of this function is not yet final and may change in the - future. - */ - static iteration_proxy iterator_wrapper(reference cont) - { - return iteration_proxy(cont); - } - - /*! - @copydoc iterator_wrapper(reference) - */ - static iteration_proxy iterator_wrapper(const_reference cont) - { - return iteration_proxy(cont); - } - - /// @} - - - ////////////// - // capacity // - ////////////// - - /// @name capacity - /// @{ - - /*! - @brief checks whether the container is empty - - Checks if a JSON value has no elements. - - @return The return value depends on the different types and is - defined as follows: - Value type | return value - ----------- | ------------- - null | `true` - boolean | `false` - string | `false` - number | `false` - object | result of function `object_t::empty()` - array | result of function `array_t::empty()` - - @note This function does not return whether a string stored as JSON value - is empty - it returns whether the JSON container itself is empty which is - false in the case of a string. - - @complexity Constant, as long as @ref array_t and @ref object_t satisfy - the Container concept; that is, their `empty()` functions have constant - complexity. - - @requirement This function helps `basic_json` satisfying the - [Container](http://en.cppreference.com/w/cpp/concept/Container) - requirements: - - The complexity is constant. - - Has the semantics of `begin() == end()`. - - @liveexample{The following code uses `empty()` to check if a JSON - object contains any elements.,empty} - - @sa @ref size() -- returns the number of elements - - @since version 1.0.0 - */ - bool empty() const noexcept - { - switch (m_type) - { - case value_t::null: - { - // null values are empty - return true; - } - - case value_t::array: - { - // delegate call to array_t::empty() - return m_value.array->empty(); - } - - case value_t::object: - { - // delegate call to object_t::empty() - return m_value.object->empty(); - } - - default: - { - // all other types are nonempty - return false; - } - } - } - - /*! - @brief returns the number of elements - - Returns the number of elements in a JSON value. - - @return The return value depends on the different types and is - defined as follows: - Value type | return value - ----------- | ------------- - null | `0` - boolean | `1` - string | `1` - number | `1` - object | result of function object_t::size() - array | result of function array_t::size() - - @note This function does not return the length of a string stored as JSON - value - it returns the number of elements in the JSON value which is 1 in - the case of a string. - - @complexity Constant, as long as @ref array_t and @ref object_t satisfy - the Container concept; that is, their size() functions have constant - complexity. - - @requirement This function helps `basic_json` satisfying the - [Container](http://en.cppreference.com/w/cpp/concept/Container) - requirements: - - The complexity is constant. - - Has the semantics of `std::distance(begin(), end())`. - - @liveexample{The following code calls `size()` on the different value - types.,size} - - @sa @ref empty() -- checks whether the container is empty - @sa @ref max_size() -- returns the maximal number of elements - - @since version 1.0.0 - */ - size_type size() const noexcept - { - switch (m_type) - { - case value_t::null: - { - // null values are empty - return 0; - } - - case value_t::array: - { - // delegate call to array_t::size() - return m_value.array->size(); - } - - case value_t::object: - { - // delegate call to object_t::size() - return m_value.object->size(); - } - - default: - { - // all other types have size 1 - return 1; - } - } - } - - /*! - @brief returns the maximum possible number of elements - - Returns the maximum number of elements a JSON value is able to hold due to - system or library implementation limitations, i.e. `std::distance(begin(), - end())` for the JSON value. - - @return The return value depends on the different types and is - defined as follows: - Value type | return value - ----------- | ------------- - null | `0` (same as `size()`) - boolean | `1` (same as `size()`) - string | `1` (same as `size()`) - number | `1` (same as `size()`) - object | result of function `object_t::max_size()` - array | result of function `array_t::max_size()` - - @complexity Constant, as long as @ref array_t and @ref object_t satisfy - the Container concept; that is, their `max_size()` functions have constant - complexity. - - @requirement This function helps `basic_json` satisfying the - [Container](http://en.cppreference.com/w/cpp/concept/Container) - requirements: - - The complexity is constant. - - Has the semantics of returning `b.size()` where `b` is the largest - possible JSON value. - - @liveexample{The following code calls `max_size()` on the different value - types. Note the output is implementation specific.,max_size} - - @sa @ref size() -- returns the number of elements - - @since version 1.0.0 - */ - size_type max_size() const noexcept - { - switch (m_type) - { - case value_t::array: - { - // delegate call to array_t::max_size() - return m_value.array->max_size(); - } - - case value_t::object: - { - // delegate call to object_t::max_size() - return m_value.object->max_size(); - } - - default: - { - // all other types have max_size() == size() - return size(); - } - } - } - - /// @} - - - /////////////// - // modifiers // - /////////////// - - /// @name modifiers - /// @{ - - /*! - @brief clears the contents - - Clears the content of a JSON value and resets it to the default value as - if @ref basic_json(value_t) would have been called: - - Value type | initial value - ----------- | ------------- - null | `null` - boolean | `false` - string | `""` - number | `0` - object | `{}` - array | `[]` - - @complexity Linear in the size of the JSON value. - - @liveexample{The example below shows the effect of `clear()` to different - JSON types.,clear} - - @since version 1.0.0 - */ - void clear() noexcept - { - switch (m_type) - { - case value_t::number_integer: - { - m_value.number_integer = 0; - break; - } - - case value_t::number_unsigned: - { - m_value.number_unsigned = 0; - break; - } - - case value_t::number_float: - { - m_value.number_float = 0.0; - break; - } - - case value_t::boolean: - { - m_value.boolean = false; - break; - } - - case value_t::string: - { - m_value.string->clear(); - break; - } - - case value_t::array: - { - m_value.array->clear(); - break; - } - - case value_t::object: - { - m_value.object->clear(); - break; - } - - default: - { - break; - } - } - } - - /*! - @brief add an object to an array - - Appends the given element @a val to the end of the JSON value. If the - function is called on a JSON null value, an empty array is created before - appending @a val. - - @param[in] val the value to add to the JSON array - - @throw type_error.308 when called on a type other than JSON array or - null; example: `"cannot use push_back() with number"` - - @complexity Amortized constant. - - @liveexample{The example shows how `push_back()` and `+=` can be used to - add elements to a JSON array. Note how the `null` value was silently - converted to a JSON array.,push_back} - - @since version 1.0.0 - */ - void push_back(basic_json&& val) - { - // push_back only works for null objects or arrays - if (not(is_null() or is_array())) - { - JSON_THROW(type_error::create(308, "cannot use push_back() with " + type_name())); - } - - // transform null object into an array - if (is_null()) - { - m_type = value_t::array; - m_value = value_t::array; - assert_invariant(); - } - - // add element to array (move semantics) - m_value.array->push_back(std::move(val)); - // invalidate object - val.m_type = value_t::null; - } - - /*! - @brief add an object to an array - @copydoc push_back(basic_json&&) - */ - reference operator+=(basic_json&& val) - { - push_back(std::move(val)); - return *this; - } - - /*! - @brief add an object to an array - @copydoc push_back(basic_json&&) - */ - void push_back(const basic_json& val) - { - // push_back only works for null objects or arrays - if (not(is_null() or is_array())) - { - JSON_THROW(type_error::create(308, "cannot use push_back() with " + type_name())); - } - - // transform null object into an array - if (is_null()) - { - m_type = value_t::array; - m_value = value_t::array; - assert_invariant(); - } - - // add element to array - m_value.array->push_back(val); - } - - /*! - @brief add an object to an array - @copydoc push_back(basic_json&&) - */ - reference operator+=(const basic_json& val) - { - push_back(val); - return *this; - } - - /*! - @brief add an object to an object - - Inserts the given element @a val to the JSON object. If the function is - called on a JSON null value, an empty object is created before inserting - @a val. - - @param[in] val the value to add to the JSON object - - @throw type_error.308 when called on a type other than JSON object or - null; example: `"cannot use push_back() with number"` - - @complexity Logarithmic in the size of the container, O(log(`size()`)). - - @liveexample{The example shows how `push_back()` and `+=` can be used to - add elements to a JSON object. Note how the `null` value was silently - converted to a JSON object.,push_back__object_t__value} - - @since version 1.0.0 - */ - void push_back(const typename object_t::value_type& val) - { - // push_back only works for null objects or objects - if (not(is_null() or is_object())) - { - JSON_THROW(type_error::create(308, "cannot use push_back() with " + type_name())); - } - - // transform null object into an object - if (is_null()) - { - m_type = value_t::object; - m_value = value_t::object; - assert_invariant(); - } - - // add element to array - m_value.object->insert(val); - } - - /*! - @brief add an object to an object - @copydoc push_back(const typename object_t::value_type&) - */ - reference operator+=(const typename object_t::value_type& val) - { - push_back(val); - return *this; - } - - /*! - @brief add an object to an object - - This function allows to use `push_back` with an initializer list. In case - - 1. the current value is an object, - 2. the initializer list @a init contains only two elements, and - 3. the first element of @a init is a string, - - @a init is converted into an object element and added using - @ref push_back(const typename object_t::value_type&). Otherwise, @a init - is converted to a JSON value and added using @ref push_back(basic_json&&). - - @param[in] init an initializer list - - @complexity Linear in the size of the initializer list @a init. - - @note This function is required to resolve an ambiguous overload error, - because pairs like `{"key", "value"}` can be both interpreted as - `object_t::value_type` or `std::initializer_list`, see - https://github.com/nlohmann/json/issues/235 for more information. - - @liveexample{The example shows how initializer lists are treated as - objects when possible.,push_back__initializer_list} - */ - void push_back(std::initializer_list init) - { - if (is_object() and init.size() == 2 and init.begin()->is_string()) - { - const string_t key = *init.begin(); - push_back(typename object_t::value_type(key, *(init.begin() + 1))); - } - else - { - push_back(basic_json(init)); - } - } - - /*! - @brief add an object to an object - @copydoc push_back(std::initializer_list) - */ - reference operator+=(std::initializer_list init) - { - push_back(init); - return *this; - } - - /*! - @brief add an object to an array - - Creates a JSON value from the passed parameters @a args to the end of the - JSON value. If the function is called on a JSON null value, an empty array - is created before appending the value created from @a args. - - @param[in] args arguments to forward to a constructor of @ref basic_json - @tparam Args compatible types to create a @ref basic_json object - - @throw type_error.311 when called on a type other than JSON array or - null; example: `"cannot use emplace_back() with number"` - - @complexity Amortized constant. - - @liveexample{The example shows how `push_back()` can be used to add - elements to a JSON array. Note how the `null` value was silently converted - to a JSON array.,emplace_back} - - @since version 2.0.8 - */ - template - void emplace_back(Args&& ... args) - { - // emplace_back only works for null objects or arrays - if (not(is_null() or is_array())) - { - JSON_THROW(type_error::create(311, "cannot use emplace_back() with " + type_name())); - } - - // transform null object into an array - if (is_null()) - { - m_type = value_t::array; - m_value = value_t::array; - assert_invariant(); - } - - // add element to array (perfect forwarding) - m_value.array->emplace_back(std::forward(args)...); - } - - /*! - @brief add an object to an object if key does not exist - - Inserts a new element into a JSON object constructed in-place with the - given @a args if there is no element with the key in the container. If the - function is called on a JSON null value, an empty object is created before - appending the value created from @a args. - - @param[in] args arguments to forward to a constructor of @ref basic_json - @tparam Args compatible types to create a @ref basic_json object - - @return a pair consisting of an iterator to the inserted element, or the - already-existing element if no insertion happened, and a bool - denoting whether the insertion took place. - - @throw type_error.311 when called on a type other than JSON object or - null; example: `"cannot use emplace() with number"` - - @complexity Logarithmic in the size of the container, O(log(`size()`)). - - @liveexample{The example shows how `emplace()` can be used to add elements - to a JSON object. Note how the `null` value was silently converted to a - JSON object. Further note how no value is added if there was already one - value stored with the same key.,emplace} - - @since version 2.0.8 - */ - template - std::pair emplace(Args&& ... args) - { - // emplace only works for null objects or arrays - if (not(is_null() or is_object())) - { - JSON_THROW(type_error::create(311, "cannot use emplace() with " + type_name())); - } - - // transform null object into an object - if (is_null()) - { - m_type = value_t::object; - m_value = value_t::object; - assert_invariant(); - } - - // add element to array (perfect forwarding) - auto res = m_value.object->emplace(std::forward(args)...); - // create result iterator and set iterator to the result of emplace - auto it = begin(); - it.m_it.object_iterator = res.first; - - // return pair of iterator and boolean - return {it, res.second}; - } - - /*! - @brief inserts element - - Inserts element @a val before iterator @a pos. - - @param[in] pos iterator before which the content will be inserted; may be - the end() iterator - @param[in] val element to insert - @return iterator pointing to the inserted @a val. - - @throw type_error.309 if called on JSON values other than arrays; - example: `"cannot use insert() with string"` - @throw invalid_iterator.202 if @a pos is not an iterator of *this; - example: `"iterator does not fit current value"` - - @complexity Constant plus linear in the distance between @a pos and end of - the container. - - @liveexample{The example shows how `insert()` is used.,insert} - - @since version 1.0.0 - */ - iterator insert(const_iterator pos, const basic_json& val) - { - // insert only works for arrays - if (is_array()) - { - // check if iterator pos fits to this JSON value - if (pos.m_object != this) - { - JSON_THROW(invalid_iterator::create(202, "iterator does not fit current value")); - } - - // insert to array and return iterator - iterator result(this); - result.m_it.array_iterator = m_value.array->insert(pos.m_it.array_iterator, val); - return result; - } - - JSON_THROW(type_error::create(309, "cannot use insert() with " + type_name())); - } - - /*! - @brief inserts element - @copydoc insert(const_iterator, const basic_json&) - */ - iterator insert(const_iterator pos, basic_json&& val) - { - return insert(pos, val); - } - - /*! - @brief inserts elements - - Inserts @a cnt copies of @a val before iterator @a pos. - - @param[in] pos iterator before which the content will be inserted; may be - the end() iterator - @param[in] cnt number of copies of @a val to insert - @param[in] val element to insert - @return iterator pointing to the first element inserted, or @a pos if - `cnt==0` - - @throw type_error.309 if called on JSON values other than arrays; example: - `"cannot use insert() with string"` - @throw invalid_iterator.202 if @a pos is not an iterator of *this; - example: `"iterator does not fit current value"` - - @complexity Linear in @a cnt plus linear in the distance between @a pos - and end of the container. - - @liveexample{The example shows how `insert()` is used.,insert__count} - - @since version 1.0.0 - */ - iterator insert(const_iterator pos, size_type cnt, const basic_json& val) - { - // insert only works for arrays - if (is_array()) - { - // check if iterator pos fits to this JSON value - if (pos.m_object != this) - { - JSON_THROW(invalid_iterator::create(202, "iterator does not fit current value")); - } - - // insert to array and return iterator - iterator result(this); - result.m_it.array_iterator = m_value.array->insert(pos.m_it.array_iterator, cnt, val); - return result; - } - - JSON_THROW(type_error::create(309, "cannot use insert() with " + type_name())); - } - - /*! - @brief inserts elements - - Inserts elements from range `[first, last)` before iterator @a pos. - - @param[in] pos iterator before which the content will be inserted; may be - the end() iterator - @param[in] first begin of the range of elements to insert - @param[in] last end of the range of elements to insert - - @throw type_error.309 if called on JSON values other than arrays; example: - `"cannot use insert() with string"` - @throw invalid_iterator.202 if @a pos is not an iterator of *this; - example: `"iterator does not fit current value"` - @throw invalid_iterator.210 if @a first and @a last do not belong to the - same JSON value; example: `"iterators do not fit"` - @throw invalid_iterator.211 if @a first or @a last are iterators into - container for which insert is called; example: `"passed iterators may not - belong to container"` - - @return iterator pointing to the first element inserted, or @a pos if - `first==last` - - @complexity Linear in `std::distance(first, last)` plus linear in the - distance between @a pos and end of the container. - - @liveexample{The example shows how `insert()` is used.,insert__range} - - @since version 1.0.0 - */ - iterator insert(const_iterator pos, const_iterator first, const_iterator last) - { - // insert only works for arrays - if (not is_array()) - { - JSON_THROW(type_error::create(309, "cannot use insert() with " + type_name())); - } - - // check if iterator pos fits to this JSON value - if (pos.m_object != this) - { - JSON_THROW(invalid_iterator::create(202, "iterator does not fit current value")); - } - - // check if range iterators belong to the same JSON object - if (first.m_object != last.m_object) - { - JSON_THROW(invalid_iterator::create(210, "iterators do not fit")); - } - - if (first.m_object == this or last.m_object == this) - { - JSON_THROW(invalid_iterator::create(211, "passed iterators may not belong to container")); - } - - // insert to array and return iterator - iterator result(this); - result.m_it.array_iterator = m_value.array->insert( - pos.m_it.array_iterator, - first.m_it.array_iterator, - last.m_it.array_iterator); - return result; - } - - /*! - @brief inserts elements - - Inserts elements from initializer list @a ilist before iterator @a pos. - - @param[in] pos iterator before which the content will be inserted; may be - the end() iterator - @param[in] ilist initializer list to insert the values from - - @throw type_error.309 if called on JSON values other than arrays; example: - `"cannot use insert() with string"` - @throw invalid_iterator.202 if @a pos is not an iterator of *this; - example: `"iterator does not fit current value"` - - @return iterator pointing to the first element inserted, or @a pos if - `ilist` is empty - - @complexity Linear in `ilist.size()` plus linear in the distance between - @a pos and end of the container. - - @liveexample{The example shows how `insert()` is used.,insert__ilist} - - @since version 1.0.0 - */ - iterator insert(const_iterator pos, std::initializer_list ilist) - { - // insert only works for arrays - if (not is_array()) - { - JSON_THROW(type_error::create(309, "cannot use insert() with " + type_name())); - } - - // check if iterator pos fits to this JSON value - if (pos.m_object != this) - { - JSON_THROW(invalid_iterator::create(202, "iterator does not fit current value")); - } - - // insert to array and return iterator - iterator result(this); - result.m_it.array_iterator = m_value.array->insert(pos.m_it.array_iterator, ilist); - return result; - } - - /*! - @brief inserts elements - - Inserts elements from range `[first, last)`. - - @param[in] first begin of the range of elements to insert - @param[in] last end of the range of elements to insert - - @throw type_error.309 if called on JSON values other than objects; example: - `"cannot use insert() with string"` - @throw invalid_iterator.202 if iterator @a first or @a last does does not - point to an object; example: `"iterators first and last must point to - objects"` - @throw invalid_iterator.210 if @a first and @a last do not belong to the - same JSON value; example: `"iterators do not fit"` - - @complexity Logarithmic: `O(N*log(size() + N))`, where `N` is the number - of elements to insert. - - @liveexample{The example shows how `insert()` is used.,insert__range_object} - - @since version 3.0.0 - */ - void insert(const_iterator first, const_iterator last) - { - // insert only works for objects - if (not is_object()) - { - JSON_THROW(type_error::create(309, "cannot use insert() with " + type_name())); - } - - // check if range iterators belong to the same JSON object - if (first.m_object != last.m_object) - { - JSON_THROW(invalid_iterator::create(210, "iterators do not fit")); - } - - // passed iterators must belong to objects - if (not first.m_object->is_object() or not first.m_object->is_object()) - { - JSON_THROW(invalid_iterator::create(202, "iterators first and last must point to objects")); - } - - m_value.object->insert(first.m_it.object_iterator, last.m_it.object_iterator); - } - - /*! - @brief exchanges the values - - Exchanges the contents of the JSON value with those of @a other. Does not - invoke any move, copy, or swap operations on individual elements. All - iterators and references remain valid. The past-the-end iterator is - invalidated. - - @param[in,out] other JSON value to exchange the contents with - - @complexity Constant. - - @liveexample{The example below shows how JSON values can be swapped with - `swap()`.,swap__reference} - - @since version 1.0.0 - */ - void swap(reference other) noexcept ( - std::is_nothrow_move_constructible::value and - std::is_nothrow_move_assignable::value and - std::is_nothrow_move_constructible::value and - std::is_nothrow_move_assignable::value - ) - { - std::swap(m_type, other.m_type); - std::swap(m_value, other.m_value); - assert_invariant(); - } - - /*! - @brief exchanges the values - - Exchanges the contents of a JSON array with those of @a other. Does not - invoke any move, copy, or swap operations on individual elements. All - iterators and references remain valid. The past-the-end iterator is - invalidated. - - @param[in,out] other array to exchange the contents with - - @throw type_error.310 when JSON value is not an array; example: `"cannot - use swap() with string"` - - @complexity Constant. - - @liveexample{The example below shows how arrays can be swapped with - `swap()`.,swap__array_t} - - @since version 1.0.0 - */ - void swap(array_t& other) - { - // swap only works for arrays - if (is_array()) - { - std::swap(*(m_value.array), other); - } - else - { - JSON_THROW(type_error::create(310, "cannot use swap() with " + type_name())); - } - } - - /*! - @brief exchanges the values - - Exchanges the contents of a JSON object with those of @a other. Does not - invoke any move, copy, or swap operations on individual elements. All - iterators and references remain valid. The past-the-end iterator is - invalidated. - - @param[in,out] other object to exchange the contents with - - @throw type_error.310 when JSON value is not an object; example: - `"cannot use swap() with string"` - - @complexity Constant. - - @liveexample{The example below shows how objects can be swapped with - `swap()`.,swap__object_t} - - @since version 1.0.0 - */ - void swap(object_t& other) - { - // swap only works for objects - if (is_object()) - { - std::swap(*(m_value.object), other); - } - else - { - JSON_THROW(type_error::create(310, "cannot use swap() with " + type_name())); - } - } - - /*! - @brief exchanges the values - - Exchanges the contents of a JSON string with those of @a other. Does not - invoke any move, copy, or swap operations on individual elements. All - iterators and references remain valid. The past-the-end iterator is - invalidated. - - @param[in,out] other string to exchange the contents with - - @throw type_error.310 when JSON value is not a string; example: `"cannot - use swap() with boolean"` - - @complexity Constant. - - @liveexample{The example below shows how strings can be swapped with - `swap()`.,swap__string_t} - - @since version 1.0.0 - */ - void swap(string_t& other) - { - // swap only works for strings - if (is_string()) - { - std::swap(*(m_value.string), other); - } - else - { - JSON_THROW(type_error::create(310, "cannot use swap() with " + type_name())); - } - } - - /// @} - - public: - ////////////////////////////////////////// - // lexicographical comparison operators // - ////////////////////////////////////////// - - /// @name lexicographical comparison operators - /// @{ - - /*! - @brief comparison: equal - - Compares two JSON values for equality according to the following rules: - - Two JSON values are equal if (1) they are from the same type and (2) - their stored values are the same according to their respective - `operator==`. - - Integer and floating-point numbers are automatically converted before - comparison. Note than two NaN values are always treated as unequal. - - Two JSON null values are equal. - - @note NaN values never compare equal to themselves or to other NaN values. - - @param[in] lhs first JSON value to consider - @param[in] rhs second JSON value to consider - @return whether the values @a lhs and @a rhs are equal - - @complexity Linear. - - @liveexample{The example demonstrates comparing several JSON - types.,operator__equal} - - @since version 1.0.0 - */ - friend bool operator==(const_reference lhs, const_reference rhs) noexcept - { - const auto lhs_type = lhs.type(); - const auto rhs_type = rhs.type(); - - if (lhs_type == rhs_type) - { - switch (lhs_type) - { - case value_t::array: - { - return *lhs.m_value.array == *rhs.m_value.array; - } - case value_t::object: - { - return *lhs.m_value.object == *rhs.m_value.object; - } - case value_t::null: - { - return true; - } - case value_t::string: - { - return *lhs.m_value.string == *rhs.m_value.string; - } - case value_t::boolean: - { - return lhs.m_value.boolean == rhs.m_value.boolean; - } - case value_t::number_integer: - { - return lhs.m_value.number_integer == rhs.m_value.number_integer; - } - case value_t::number_unsigned: - { - return lhs.m_value.number_unsigned == rhs.m_value.number_unsigned; - } - case value_t::number_float: - { - return lhs.m_value.number_float == rhs.m_value.number_float; - } - default: - { - return false; - } - } - } - else if (lhs_type == value_t::number_integer and rhs_type == value_t::number_float) - { - return static_cast(lhs.m_value.number_integer) == rhs.m_value.number_float; - } - else if (lhs_type == value_t::number_float and rhs_type == value_t::number_integer) - { - return lhs.m_value.number_float == static_cast(rhs.m_value.number_integer); - } - else if (lhs_type == value_t::number_unsigned and rhs_type == value_t::number_float) - { - return static_cast(lhs.m_value.number_unsigned) == rhs.m_value.number_float; - } - else if (lhs_type == value_t::number_float and rhs_type == value_t::number_unsigned) - { - return lhs.m_value.number_float == static_cast(rhs.m_value.number_unsigned); - } - else if (lhs_type == value_t::number_unsigned and rhs_type == value_t::number_integer) - { - return static_cast(lhs.m_value.number_unsigned) == rhs.m_value.number_integer; - } - else if (lhs_type == value_t::number_integer and rhs_type == value_t::number_unsigned) - { - return lhs.m_value.number_integer == static_cast(rhs.m_value.number_unsigned); - } - - return false; - } - - /*! - @brief comparison: equal - @copydoc operator==(const_reference, const_reference) - */ - template::value, int>::type = 0> - friend bool operator==(const_reference lhs, const ScalarType rhs) noexcept - { - return (lhs == basic_json(rhs)); - } - - /*! - @brief comparison: equal - @copydoc operator==(const_reference, const_reference) - */ - template::value, int>::type = 0> - friend bool operator==(const ScalarType lhs, const_reference rhs) noexcept - { - return (basic_json(lhs) == rhs); - } - - /*! - @brief comparison: not equal - - Compares two JSON values for inequality by calculating `not (lhs == rhs)`. - - @param[in] lhs first JSON value to consider - @param[in] rhs second JSON value to consider - @return whether the values @a lhs and @a rhs are not equal - - @complexity Linear. - - @liveexample{The example demonstrates comparing several JSON - types.,operator__notequal} - - @since version 1.0.0 - */ - friend bool operator!=(const_reference lhs, const_reference rhs) noexcept - { - return not (lhs == rhs); - } - - /*! - @brief comparison: not equal - @copydoc operator!=(const_reference, const_reference) - */ - template::value, int>::type = 0> - friend bool operator!=(const_reference lhs, const ScalarType rhs) noexcept - { - return (lhs != basic_json(rhs)); - } - - /*! - @brief comparison: not equal - @copydoc operator!=(const_reference, const_reference) - */ - template::value, int>::type = 0> - friend bool operator!=(const ScalarType lhs, const_reference rhs) noexcept - { - return (basic_json(lhs) != rhs); - } - - /*! - @brief comparison: less than - - Compares whether one JSON value @a lhs is less than another JSON value @a - rhs according to the following rules: - - If @a lhs and @a rhs have the same type, the values are compared using - the default `<` operator. - - Integer and floating-point numbers are automatically converted before - comparison - - In case @a lhs and @a rhs have different types, the values are ignored - and the order of the types is considered, see - @ref operator<(const value_t, const value_t). - - @param[in] lhs first JSON value to consider - @param[in] rhs second JSON value to consider - @return whether @a lhs is less than @a rhs - - @complexity Linear. - - @liveexample{The example demonstrates comparing several JSON - types.,operator__less} - - @since version 1.0.0 - */ - friend bool operator<(const_reference lhs, const_reference rhs) noexcept - { - const auto lhs_type = lhs.type(); - const auto rhs_type = rhs.type(); - - if (lhs_type == rhs_type) - { - switch (lhs_type) - { - case value_t::array: - { - return (*lhs.m_value.array) < (*rhs.m_value.array); - } - case value_t::object: - { - return *lhs.m_value.object < *rhs.m_value.object; - } - case value_t::null: - { - return false; - } - case value_t::string: - { - return *lhs.m_value.string < *rhs.m_value.string; - } - case value_t::boolean: - { - return lhs.m_value.boolean < rhs.m_value.boolean; - } - case value_t::number_integer: - { - return lhs.m_value.number_integer < rhs.m_value.number_integer; - } - case value_t::number_unsigned: - { - return lhs.m_value.number_unsigned < rhs.m_value.number_unsigned; - } - case value_t::number_float: - { - return lhs.m_value.number_float < rhs.m_value.number_float; - } - default: - { - return false; - } - } - } - else if (lhs_type == value_t::number_integer and rhs_type == value_t::number_float) - { - return static_cast(lhs.m_value.number_integer) < rhs.m_value.number_float; - } - else if (lhs_type == value_t::number_float and rhs_type == value_t::number_integer) - { - return lhs.m_value.number_float < static_cast(rhs.m_value.number_integer); - } - else if (lhs_type == value_t::number_unsigned and rhs_type == value_t::number_float) - { - return static_cast(lhs.m_value.number_unsigned) < rhs.m_value.number_float; - } - else if (lhs_type == value_t::number_float and rhs_type == value_t::number_unsigned) - { - return lhs.m_value.number_float < static_cast(rhs.m_value.number_unsigned); - } - else if (lhs_type == value_t::number_integer and rhs_type == value_t::number_unsigned) - { - return lhs.m_value.number_integer < static_cast(rhs.m_value.number_unsigned); - } - else if (lhs_type == value_t::number_unsigned and rhs_type == value_t::number_integer) - { - return static_cast(lhs.m_value.number_unsigned) < rhs.m_value.number_integer; - } - - // We only reach this line if we cannot compare values. In that case, - // we compare types. Note we have to call the operator explicitly, - // because MSVC has problems otherwise. - return operator<(lhs_type, rhs_type); - } - - /*! - @brief comparison: less than - @copydoc operator<(const_reference, const_reference) - */ - template::value, int>::type = 0> - friend bool operator<(const_reference lhs, const ScalarType rhs) noexcept - { - return (lhs < basic_json(rhs)); - } - - /*! - @brief comparison: less than - @copydoc operator<(const_reference, const_reference) - */ - template::value, int>::type = 0> - friend bool operator<(const ScalarType lhs, const_reference rhs) noexcept - { - return (basic_json(lhs) < rhs); - } - - /*! - @brief comparison: less than or equal - - Compares whether one JSON value @a lhs is less than or equal to another - JSON value by calculating `not (rhs < lhs)`. - - @param[in] lhs first JSON value to consider - @param[in] rhs second JSON value to consider - @return whether @a lhs is less than or equal to @a rhs - - @complexity Linear. - - @liveexample{The example demonstrates comparing several JSON - types.,operator__greater} - - @since version 1.0.0 - */ - friend bool operator<=(const_reference lhs, const_reference rhs) noexcept - { - return not (rhs < lhs); - } - - /*! - @brief comparison: less than or equal - @copydoc operator<=(const_reference, const_reference) - */ - template::value, int>::type = 0> - friend bool operator<=(const_reference lhs, const ScalarType rhs) noexcept - { - return (lhs <= basic_json(rhs)); - } - - /*! - @brief comparison: less than or equal - @copydoc operator<=(const_reference, const_reference) - */ - template::value, int>::type = 0> - friend bool operator<=(const ScalarType lhs, const_reference rhs) noexcept - { - return (basic_json(lhs) <= rhs); - } - - /*! - @brief comparison: greater than - - Compares whether one JSON value @a lhs is greater than another - JSON value by calculating `not (lhs <= rhs)`. - - @param[in] lhs first JSON value to consider - @param[in] rhs second JSON value to consider - @return whether @a lhs is greater than to @a rhs - - @complexity Linear. - - @liveexample{The example demonstrates comparing several JSON - types.,operator__lessequal} - - @since version 1.0.0 - */ - friend bool operator>(const_reference lhs, const_reference rhs) noexcept - { - return not (lhs <= rhs); - } - - /*! - @brief comparison: greater than - @copydoc operator>(const_reference, const_reference) - */ - template::value, int>::type = 0> - friend bool operator>(const_reference lhs, const ScalarType rhs) noexcept - { - return (lhs > basic_json(rhs)); - } - - /*! - @brief comparison: greater than - @copydoc operator>(const_reference, const_reference) - */ - template::value, int>::type = 0> - friend bool operator>(const ScalarType lhs, const_reference rhs) noexcept - { - return (basic_json(lhs) > rhs); - } - - /*! - @brief comparison: greater than or equal - - Compares whether one JSON value @a lhs is greater than or equal to another - JSON value by calculating `not (lhs < rhs)`. - - @param[in] lhs first JSON value to consider - @param[in] rhs second JSON value to consider - @return whether @a lhs is greater than or equal to @a rhs - - @complexity Linear. - - @liveexample{The example demonstrates comparing several JSON - types.,operator__greaterequal} - - @since version 1.0.0 - */ - friend bool operator>=(const_reference lhs, const_reference rhs) noexcept - { - return not (lhs < rhs); - } - - /*! - @brief comparison: greater than or equal - @copydoc operator>=(const_reference, const_reference) - */ - template::value, int>::type = 0> - friend bool operator>=(const_reference lhs, const ScalarType rhs) noexcept - { - return (lhs >= basic_json(rhs)); - } - - /*! - @brief comparison: greater than or equal - @copydoc operator>=(const_reference, const_reference) - */ - template::value, int>::type = 0> - friend bool operator>=(const ScalarType lhs, const_reference rhs) noexcept - { - return (basic_json(lhs) >= rhs); - } - - /// @} - - private: - ///////////////////// - // output adapters // - ///////////////////// - - /// abstract output adapter interface - template - class output_adapter - { - public: - virtual void write_character(CharType c) = 0; - virtual void write_characters(const CharType* s, size_t length) = 0; - virtual ~output_adapter() {} - - static std::shared_ptr> create(std::vector& vec) - { - return std::make_shared>(vec); - } - - static std::shared_ptr> create(std::ostream& s) - { - return std::make_shared>(s); - } - - static std::shared_ptr> create(std::string& s) - { - return std::make_shared>(s); - } - }; - - /// a type to simplify interfaces - template - using output_adapter_t = std::shared_ptr>; - - /// output adapter for byte vectors - template - class output_vector_adapter : public output_adapter - { - public: - output_vector_adapter(std::vector& vec) - : v(vec) - {} - - void write_character(CharType c) override - { - v.push_back(c); - } - - void write_characters(const CharType* s, size_t length) override - { - std::copy(s, s + length, std::back_inserter(v)); - } - - private: - std::vector& v; - }; - - /// output adapter for output streams - template - class output_stream_adapter : public output_adapter - { - public: - output_stream_adapter(std::basic_ostream& s) - : stream(s) - {} - - void write_character(CharType c) override - { - stream.put(c); - } - - void write_characters(const CharType* s, size_t length) override - { - stream.write(s, static_cast(length)); - } - - private: - std::basic_ostream& stream; - }; - - /// output adapter for basic_string - template - class output_string_adapter : public output_adapter - { - public: - output_string_adapter(std::string& s) - : str(s) - {} - - void write_character(CharType c) override - { - str.push_back(c); - } - - void write_characters(const CharType* s, size_t length) override - { - str.append(s, length); - } - - private: - std::basic_string& str; - }; - - - /////////////////// - // serialization // - /////////////////// - - /// @name serialization - /// @{ - - private: - /*! - @brief wrapper around the serialization functions - */ - class serializer - { - public: - /*! - @param[in] s output stream to serialize to - @param[in] ichar indentation character to use - */ - serializer(output_adapter_t s, const char ichar) - : o(s), loc(std::localeconv()), - thousands_sep(!loc->thousands_sep ? '\0' : loc->thousands_sep[0]), - decimal_point(!loc->decimal_point ? '\0' : loc->decimal_point[0]), - indent_char(ichar), indent_string(512, indent_char) - {} - - // delete because of pointer members - serializer(const serializer&) = delete; - serializer& operator=(const serializer&) = delete; - - /*! - @brief internal implementation of the serialization function - - This function is called by the public member function dump and - organizes the serialization internally. The indentation level is - propagated as additional parameter. In case of arrays and objects, the - function is called recursively. - - - strings and object keys are escaped using `escape_string()` - - integer numbers are converted implicitly via `operator<<` - - floating-point numbers are converted to a string using `"%g"` format - - @param[in] val value to serialize - @param[in] pretty_print whether the output shall be pretty-printed - @param[in] indent_step the indent level - @param[in] current_indent the current indent level (only used internally) - */ - void dump(const basic_json& val, - const bool pretty_print, - const unsigned int indent_step, - const unsigned int current_indent = 0) - { - switch (val.m_type) - { - case value_t::object: - { - if (val.m_value.object->empty()) - { - o->write_characters("{}", 2); - return; - } - - if (pretty_print) - { - o->write_characters("{\n", 2); - - // variable to hold indentation for recursive calls - const auto new_indent = current_indent + indent_step; - if (JSON_UNLIKELY(indent_string.size() < new_indent)) - { - indent_string.resize(indent_string.size() * 2, ' '); - } - - // first n-1 elements - auto i = val.m_value.object->cbegin(); - for (size_t cnt = 0; cnt < val.m_value.object->size() - 1; ++cnt, ++i) - { - o->write_characters(indent_string.c_str(), new_indent); - o->write_character('\"'); - dump_escaped(i->first); - o->write_characters("\": ", 3); - dump(i->second, true, indent_step, new_indent); - o->write_characters(",\n", 2); - } - - // last element - assert(i != val.m_value.object->cend()); - o->write_characters(indent_string.c_str(), new_indent); - o->write_character('\"'); - dump_escaped(i->first); - o->write_characters("\": ", 3); - dump(i->second, true, indent_step, new_indent); - - o->write_character('\n'); - o->write_characters(indent_string.c_str(), current_indent); - o->write_character('}'); - } - else - { - o->write_character('{'); - - // first n-1 elements - auto i = val.m_value.object->cbegin(); - for (size_t cnt = 0; cnt < val.m_value.object->size() - 1; ++cnt, ++i) - { - o->write_character('\"'); - dump_escaped(i->first); - o->write_characters("\":", 2); - dump(i->second, false, indent_step, current_indent); - o->write_character(','); - } - - // last element - assert(i != val.m_value.object->cend()); - o->write_character('\"'); - dump_escaped(i->first); - o->write_characters("\":", 2); - dump(i->second, false, indent_step, current_indent); - - o->write_character('}'); - } - - return; - } - - case value_t::array: - { - if (val.m_value.array->empty()) - { - o->write_characters("[]", 2); - return; - } - - if (pretty_print) - { - o->write_characters("[\n", 2); - - // variable to hold indentation for recursive calls - const auto new_indent = current_indent + indent_step; - if (indent_string.size() < new_indent) - { - indent_string.resize(new_indent, ' '); - } - - // first n-1 elements - for (auto i = val.m_value.array->cbegin(); i != val.m_value.array->cend() - 1; ++i) - { - o->write_characters(indent_string.c_str(), new_indent); - dump(*i, true, indent_step, new_indent); - o->write_characters(",\n", 2); - } - - // last element - assert(not val.m_value.array->empty()); - o->write_characters(indent_string.c_str(), new_indent); - dump(val.m_value.array->back(), true, indent_step, new_indent); - - o->write_character('\n'); - o->write_characters(indent_string.c_str(), current_indent); - o->write_character(']'); - } - else - { - o->write_character('['); - - // first n-1 elements - for (auto i = val.m_value.array->cbegin(); i != val.m_value.array->cend() - 1; ++i) - { - dump(*i, false, indent_step, current_indent); - o->write_character(','); - } - - // last element - assert(not val.m_value.array->empty()); - dump(val.m_value.array->back(), false, indent_step, current_indent); - - o->write_character(']'); - } - - return; - } - - case value_t::string: - { - o->write_character('\"'); - dump_escaped(*val.m_value.string); - o->write_character('\"'); - return; - } - - case value_t::boolean: - { - if (val.m_value.boolean) - { - o->write_characters("true", 4); - } - else - { - o->write_characters("false", 5); - } - return; - } - - case value_t::number_integer: - { - dump_integer(val.m_value.number_integer); - return; - } - - case value_t::number_unsigned: - { - dump_integer(val.m_value.number_unsigned); - return; - } - - case value_t::number_float: - { - dump_float(val.m_value.number_float); - return; - } - - case value_t::discarded: - { - o->write_characters("", 11); - return; - } - - case value_t::null: - { - o->write_characters("null", 4); - return; - } - } - } - - private: - /*! - @brief calculates the extra space to escape a JSON string - - @param[in] s the string to escape - @return the number of characters required to escape string @a s - - @complexity Linear in the length of string @a s. - */ - static std::size_t extra_space(const string_t& s) noexcept - { - return std::accumulate(s.begin(), s.end(), size_t{}, - [](size_t res, typename string_t::value_type c) - { - switch (c) - { - case '"': - case '\\': - case '\b': - case '\f': - case '\n': - case '\r': - case '\t': - { - // from c (1 byte) to \x (2 bytes) - return res + 1; - } - - case 0x00: - case 0x01: - case 0x02: - case 0x03: - case 0x04: - case 0x05: - case 0x06: - case 0x07: - case 0x0b: - case 0x0e: - case 0x0f: - case 0x10: - case 0x11: - case 0x12: - case 0x13: - case 0x14: - case 0x15: - case 0x16: - case 0x17: - case 0x18: - case 0x19: - case 0x1a: - case 0x1b: - case 0x1c: - case 0x1d: - case 0x1e: - case 0x1f: - { - // from c (1 byte) to \uxxxx (6 bytes) - return res + 5; - } - - default: - { - return res; - } - } - }); - } - - /*! - @brief dump escaped string - - Escape a string by replacing certain special characters by a sequence - of an escape character (backslash) and another character and other - control characters by a sequence of "\u" followed by a four-digit hex - representation. The escaped string is written to output stream @a o. - - @param[in] s the string to escape - - @complexity Linear in the length of string @a s. - */ - void dump_escaped(const string_t& s) const - { - const auto space = extra_space(s); - if (space == 0) - { - o->write_characters(s.c_str(), s.size()); - return; - } - - // create a result string of necessary size - string_t result(s.size() + space, '\\'); - std::size_t pos = 0; - - for (const auto& c : s) - { - switch (c) - { - // quotation mark (0x22) - case '"': - { - result[pos + 1] = '"'; - pos += 2; - break; - } - - // reverse solidus (0x5c) - case '\\': - { - // nothing to change - pos += 2; - break; - } - - // backspace (0x08) - case '\b': - { - result[pos + 1] = 'b'; - pos += 2; - break; - } - - // formfeed (0x0c) - case '\f': - { - result[pos + 1] = 'f'; - pos += 2; - break; - } - - // newline (0x0a) - case '\n': - { - result[pos + 1] = 'n'; - pos += 2; - break; - } - - // carriage return (0x0d) - case '\r': - { - result[pos + 1] = 'r'; - pos += 2; - break; - } - - // horizontal tab (0x09) - case '\t': - { - result[pos + 1] = 't'; - pos += 2; - break; - } - - case 0x00: - case 0x01: - case 0x02: - case 0x03: - case 0x04: - case 0x05: - case 0x06: - case 0x07: - case 0x0b: - case 0x0e: - case 0x0f: - case 0x10: - case 0x11: - case 0x12: - case 0x13: - case 0x14: - case 0x15: - case 0x16: - case 0x17: - case 0x18: - case 0x19: - case 0x1a: - case 0x1b: - case 0x1c: - case 0x1d: - case 0x1e: - case 0x1f: - { - // convert a number 0..15 to its hex representation - // (0..f) - static const char hexify[16] = - { - '0', '1', '2', '3', '4', '5', '6', '7', - '8', '9', 'a', 'b', 'c', 'd', 'e', 'f' - }; - - // print character c as \uxxxx - for (const char m : - { 'u', '0', '0', hexify[c >> 4], hexify[c & 0x0f] - }) - { - result[++pos] = m; - } - - ++pos; - break; - } - - default: - { - // all other characters are added as-is - result[pos++] = c; - break; - } - } - } - - assert(pos == s.size() + space); - o->write_characters(result.c_str(), result.size()); - } - - /*! - @brief dump an integer - - Dump a given integer to output stream @a o. Works internally with - @a number_buffer. - - @param[in] x integer number (signed or unsigned) to dump - @tparam NumberType either @a number_integer_t or @a number_unsigned_t - */ - template::value or - std::is_same::value, int> = 0> - void dump_integer(NumberType x) - { - // special case for "0" - if (x == 0) - { - o->write_character('0'); - return; - } - - const bool is_negative = x < 0; - size_t i = 0; - - // spare 1 byte for '\0' - while (x != 0 and i < number_buffer.size() - 1) - { - const auto digit = std::labs(static_cast(x % 10)); - number_buffer[i++] = static_cast('0' + digit); - x /= 10; - } - - // make sure the number has been processed completely - assert(x == 0); - - if (is_negative) - { - // make sure there is capacity for the '-' - assert(i < number_buffer.size() - 2); - number_buffer[i++] = '-'; - } - - std::reverse(number_buffer.begin(), number_buffer.begin() + i); - o->write_characters(number_buffer.data(), i); - } - - /*! - @brief dump a floating-point number - - Dump a given floating-point number to output stream @a o. Works - internally with @a number_buffer. - - @param[in] x floating-point number to dump - */ - void dump_float(number_float_t x) - { - // NaN / inf - if (not std::isfinite(x) or std::isnan(x)) - { - o->write_characters("null", 4); - return; - } - - // special case for 0.0 and -0.0 - if (x == 0) - { - if (std::signbit(x)) - { - o->write_characters("-0.0", 4); - } - else - { - o->write_characters("0.0", 3); - } - return; - } - - // get number of digits for a text -> float -> text round-trip - static constexpr auto d = std::numeric_limits::digits10; - - // the actual conversion - std::ptrdiff_t len = snprintf(number_buffer.data(), number_buffer.size(), - "%.*g", d, x); - - // negative value indicates an error - assert(len > 0); - // check if buffer was large enough - assert(static_cast(len) < number_buffer.size()); - - // erase thousands separator - if (thousands_sep != '\0') - { - const auto end = std::remove(number_buffer.begin(), - number_buffer.begin() + len, - thousands_sep); - std::fill(end, number_buffer.end(), '\0'); - assert((end - number_buffer.begin()) <= len); - len = (end - number_buffer.begin()); - } - - // convert decimal point to '.' - if (decimal_point != '\0' and decimal_point != '.') - { - for (auto& c : number_buffer) - { - if (c == decimal_point) - { - c = '.'; - break; - } - } - } - - o->write_characters(number_buffer.data(), static_cast(len)); - - // determine if need to append ".0" - const bool value_is_int_like = std::none_of(number_buffer.begin(), - number_buffer.begin() + len + 1, - [](char c) - { - return c == '.' or c == 'e'; - }); - - if (value_is_int_like) - { - o->write_characters(".0", 2); - } - } - - private: - /// the output of the serializer - output_adapter_t o = nullptr; - - /// a (hopefully) large enough character buffer - std::array number_buffer{{}}; - - /// the locale - const std::lconv* loc = nullptr; - /// the locale's thousand separator character - const char thousands_sep = '\0'; - /// the locale's decimal point character - const char decimal_point = '\0'; - - /// the indentation character - const char indent_char; - - /// the indentation string - string_t indent_string; - }; - - public: - /*! - @brief serialize to stream - - Serialize the given JSON value @a j to the output stream @a o. The JSON - value will be serialized using the @ref dump member function. - - - The indentation of the output can be controlled with the member variable - `width` of the output stream @a o. For instance, using the manipulator - `std::setw(4)` on @a o sets the indentation level to `4` and the - serialization result is the same as calling `dump(4)`. - - - The indentation characrer can be controlled with the member variable - `fill` of the output stream @a o. For instance, the manipulator - `std::setfill('\\t')` sets indentation to use a tab character rather than - the default space character. - - @param[in,out] o stream to serialize to - @param[in] j JSON value to serialize - - @return the stream @a o - - @complexity Linear. - - @liveexample{The example below shows the serialization with different - parameters to `width` to adjust the indentation level.,operator_serialize} - - @since version 1.0.0; indentaction character added in version 3.0.0 - */ - friend std::ostream& operator<<(std::ostream& o, const basic_json& j) - { - // read width member and use it as indentation parameter if nonzero - const bool pretty_print = (o.width() > 0); - const auto indentation = (pretty_print ? o.width() : 0); - - // reset width to 0 for subsequent calls to this stream - o.width(0); - - // do the actual serialization - serializer s(output_adapter::create(o), o.fill()); - s.dump(j, pretty_print, static_cast(indentation)); - return o; - } - - /*! - @brief serialize to stream - @deprecated This stream operator is deprecated and will be removed in a - future version of the library. Please use - @ref std::ostream& operator<<(std::ostream&, const basic_json&) - instead; that is, replace calls like `j >> o;` with `o << j;`. - */ - JSON_DEPRECATED - friend std::ostream& operator>>(const basic_json& j, std::ostream& o) - { - return o << j; - } - - /// @} - - - ///////////////////// - // deserialization // - ///////////////////// - - /// @name deserialization - /// @{ - - /*! - @brief deserialize from an array - - This function reads from an array of 1-byte values. - - @pre Each element of the container has a size of 1 byte. Violating this - precondition yields undefined behavior. **This precondition is enforced - with a static assertion.** - - @param[in] array array to read from - @param[in] cb a parser callback function of type @ref parser_callback_t - which is used to control the deserialization by filtering unwanted values - (optional) - - @return result of the deserialization - - @throw parse_error.101 if a parse error occurs; example: `""unexpected end - of input; expected string literal""` - @throw parse_error.102 if to_unicode fails or surrogate error - @throw parse_error.103 if to_unicode fails - - @complexity Linear in the length of the input. The parser is a predictive - LL(1) parser. The complexity can be higher if the parser callback function - @a cb has a super-linear complexity. - - @note A UTF-8 byte order mark is silently ignored. - - @liveexample{The example below demonstrates the `parse()` function reading - from an array.,parse__array__parser_callback_t} - - @since version 2.0.3 - */ - template - static basic_json parse(T (&array)[N], - const parser_callback_t cb = nullptr) - { - // delegate the call to the iterator-range parse overload - return parse(std::begin(array), std::end(array), cb); - } - - template - static bool accept(T (&array)[N]) - { - // delegate the call to the iterator-range accept overload - return accept(std::begin(array), std::end(array)); - } - - /*! - @brief deserialize from string literal - - @tparam CharT character/literal type with size of 1 byte - @param[in] s string literal to read a serialized JSON value from - @param[in] cb a parser callback function of type @ref parser_callback_t - which is used to control the deserialization by filtering unwanted values - (optional) - - @return result of the deserialization - - @throw parse_error.101 in case of an unexpected token - @throw parse_error.102 if to_unicode fails or surrogate error - @throw parse_error.103 if to_unicode fails - - @complexity Linear in the length of the input. The parser is a predictive - LL(1) parser. The complexity can be higher if the parser callback function - @a cb has a super-linear complexity. - - @note A UTF-8 byte order mark is silently ignored. - @note String containers like `std::string` or @ref string_t can be parsed - with @ref parse(const ContiguousContainer&, const parser_callback_t) - - @liveexample{The example below demonstrates the `parse()` function with - and without callback function.,parse__string__parser_callback_t} - - @sa @ref parse(std::istream&, const parser_callback_t) for a version that - reads from an input stream - - @since version 1.0.0 (originally for @ref string_t) - */ - template::value and - std::is_integral::type>::value and - sizeof(typename std::remove_pointer::type) == 1, int>::type = 0> - static basic_json parse(const CharT s, - const parser_callback_t cb = nullptr) - { - return parser(input_adapter::create(s), cb).parse(true); - } - - template::value and - std::is_integral::type>::value and - sizeof(typename std::remove_pointer::type) == 1, int>::type = 0> - static bool accept(const CharT s) - { - return parser(input_adapter::create(s)).accept(true); - } - - /*! - @brief deserialize from stream - - @param[in,out] i stream to read a serialized JSON value from - @param[in] cb a parser callback function of type @ref parser_callback_t - which is used to control the deserialization by filtering unwanted values - (optional) - - @return result of the deserialization - - @throw parse_error.101 in case of an unexpected token - @throw parse_error.102 if to_unicode fails or surrogate error - @throw parse_error.103 if to_unicode fails - - @complexity Linear in the length of the input. The parser is a predictive - LL(1) parser. The complexity can be higher if the parser callback function - @a cb has a super-linear complexity. - - @note A UTF-8 byte order mark is silently ignored. - - @liveexample{The example below demonstrates the `parse()` function with - and without callback function.,parse__istream__parser_callback_t} - - @sa @ref parse(const CharT, const parser_callback_t) for a version - that reads from a string - - @since version 1.0.0 - */ - static basic_json parse(std::istream& i, - const parser_callback_t cb = nullptr) - { - return parser(input_adapter::create(i), cb).parse(true); - } - - static bool accept(std::istream& i) - { - return parser(input_adapter::create(i)).accept(true); - } - - /*! - @copydoc parse(std::istream&, const parser_callback_t) - */ - static basic_json parse(std::istream&& i, - const parser_callback_t cb = nullptr) - { - return parser(input_adapter::create(i), cb).parse(true); - } - - static bool accept(std::istream&& i) - { - return parser(input_adapter::create(i)).accept(true); - } - - /*! - @brief deserialize from an iterator range with contiguous storage - - This function reads from an iterator range of a container with contiguous - storage of 1-byte values. Compatible container types include - `std::vector`, `std::string`, `std::array`, `std::valarray`, and - `std::initializer_list`. Furthermore, C-style arrays can be used with - `std::begin()`/`std::end()`. User-defined containers can be used as long - as they implement random-access iterators and a contiguous storage. - - @pre The iterator range is contiguous. Violating this precondition yields - undefined behavior. **This precondition is enforced with an assertion.** - @pre Each element in the range has a size of 1 byte. Violating this - precondition yields undefined behavior. **This precondition is enforced - with a static assertion.** - - @warning There is no way to enforce all preconditions at compile-time. If - the function is called with noncompliant iterators and with - assertions switched off, the behavior is undefined and will most - likely yield segmentation violation. - - @tparam IteratorType iterator of container with contiguous storage - @param[in] first begin of the range to parse (included) - @param[in] last end of the range to parse (excluded) - @param[in] cb a parser callback function of type @ref parser_callback_t - which is used to control the deserialization by filtering unwanted values - (optional) - - @return result of the deserialization - - @throw parse_error.101 in case of an unexpected token - @throw parse_error.102 if to_unicode fails or surrogate error - @throw parse_error.103 if to_unicode fails - - @complexity Linear in the length of the input. The parser is a predictive - LL(1) parser. The complexity can be higher if the parser callback function - @a cb has a super-linear complexity. - - @note A UTF-8 byte order mark is silently ignored. - - @liveexample{The example below demonstrates the `parse()` function reading - from an iterator range.,parse__iteratortype__parser_callback_t} - - @since version 2.0.3 - */ - template::iterator_category>::value, int>::type = 0> - static basic_json parse(IteratorType first, IteratorType last, - const parser_callback_t cb = nullptr) - { - return parser(input_adapter::create(first, last), cb).parse(true); - } - - template::iterator_category>::value, int>::type = 0> - static bool accept(IteratorType first, IteratorType last) - { - return parser(input_adapter::create(first, last)).accept(true); - } - - /*! - @brief deserialize from a container with contiguous storage - - This function reads from a container with contiguous storage of 1-byte - values. Compatible container types include `std::vector`, `std::string`, - `std::array`, and `std::initializer_list`. User-defined containers can be - used as long as they implement random-access iterators and a contiguous - storage. - - @pre The container storage is contiguous. Violating this precondition - yields undefined behavior. **This precondition is enforced with an - assertion.** - @pre Each element of the container has a size of 1 byte. Violating this - precondition yields undefined behavior. **This precondition is enforced - with a static assertion.** - - @warning There is no way to enforce all preconditions at compile-time. If - the function is called with a noncompliant container and with - assertions switched off, the behavior is undefined and will most - likely yield segmentation violation. - - @tparam ContiguousContainer container type with contiguous storage - @param[in] c container to read from - @param[in] cb a parser callback function of type @ref parser_callback_t - which is used to control the deserialization by filtering unwanted values - (optional) - - @return result of the deserialization - - @throw parse_error.101 in case of an unexpected token - @throw parse_error.102 if to_unicode fails or surrogate error - @throw parse_error.103 if to_unicode fails - - @complexity Linear in the length of the input. The parser is a predictive - LL(1) parser. The complexity can be higher if the parser callback function - @a cb has a super-linear complexity. - - @note A UTF-8 byte order mark is silently ignored. - - @liveexample{The example below demonstrates the `parse()` function reading - from a contiguous container.,parse__contiguouscontainer__parser_callback_t} - - @since version 2.0.3 - */ - template::value and - std::is_base_of< - std::random_access_iterator_tag, - typename std::iterator_traits()))>::iterator_category>::value - , int>::type = 0> - static basic_json parse(const ContiguousContainer& c, - const parser_callback_t cb = nullptr) - { - // delegate the call to the iterator-range parse overload - return parse(std::begin(c), std::end(c), cb); - } - - template::value and - std::is_base_of< - std::random_access_iterator_tag, - typename std::iterator_traits()))>::iterator_category>::value - , int>::type = 0> - static bool accept(const ContiguousContainer& c) - { - // delegate the call to the iterator-range accept overload - return accept(std::begin(c), std::end(c)); - } - - /*! - @brief deserialize from stream - @deprecated This stream operator is deprecated and will be removed in a - future version of the library. Please use - @ref std::istream& operator>>(std::istream&, basic_json&) - instead; that is, replace calls like `j << i;` with `i >> j;`. - */ - JSON_DEPRECATED - friend std::istream& operator<<(basic_json& j, std::istream& i) - { - j = parser(input_adapter::create(i)).parse(false); - return i; - } - - /*! - @brief deserialize from stream - - Deserializes an input stream to a JSON value. - - @param[in,out] i input stream to read a serialized JSON value from - @param[in,out] j JSON value to write the deserialized input to - - @throw parse_error.101 in case of an unexpected token - @throw parse_error.102 if to_unicode fails or surrogate error - @throw parse_error.103 if to_unicode fails - - @complexity Linear in the length of the input. The parser is a predictive - LL(1) parser. - - @note A UTF-8 byte order mark is silently ignored. - - @liveexample{The example below shows how a JSON value is constructed by - reading a serialization from a stream.,operator_deserialize} - - @sa parse(std::istream&, const parser_callback_t) for a variant with a - parser callback function to filter values while parsing - - @since version 1.0.0 - */ - friend std::istream& operator>>(std::istream& i, basic_json& j) - { - j = parser(input_adapter::create(i)).parse(false); - return i; - } - - /// @} - - /////////////////////////// - // convenience functions // - /////////////////////////// - - /*! - @brief return the type as string - - Returns the type name as string to be used in error messages - usually to - indicate that a function was called on a wrong JSON type. - - @return basically a string representation of a the @a m_type member - - @complexity Constant. - - @liveexample{The following code exemplifies `type_name()` for all JSON - types.,type_name} - - @since version 1.0.0, public since 2.1.0 - */ - std::string type_name() const - { - { - switch (m_type) - { - case value_t::null: - return "null"; - case value_t::object: - return "object"; - case value_t::array: - return "array"; - case value_t::string: - return "string"; - case value_t::boolean: - return "boolean"; - case value_t::discarded: - return "discarded"; - default: - return "number"; - } - } - } - - - private: - ////////////////////// - // member variables // - ////////////////////// - - /// the type of the current element - value_t m_type = value_t::null; - - /// the value of the current element - json_value m_value = {}; - - - private: - /////////////// - // iterators // - /////////////// - - /*! - @brief an iterator for primitive JSON types - - This class models an iterator for primitive JSON types (boolean, number, - string). It's only purpose is to allow the iterator/const_iterator classes - to "iterate" over primitive values. Internally, the iterator is modeled by - a `difference_type` variable. Value begin_value (`0`) models the begin, - end_value (`1`) models past the end. - */ - class primitive_iterator_t - { - public: - - difference_type get_value() const noexcept - { - return m_it; - } - /// set iterator to a defined beginning - void set_begin() noexcept - { - m_it = begin_value; - } - - /// set iterator to a defined past the end - void set_end() noexcept - { - m_it = end_value; - } - - /// return whether the iterator can be dereferenced - constexpr bool is_begin() const noexcept - { - return (m_it == begin_value); - } - - /// return whether the iterator is at end - constexpr bool is_end() const noexcept - { - return (m_it == end_value); - } - - friend constexpr bool operator==(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept - { - return lhs.m_it == rhs.m_it; - } - - friend constexpr bool operator!=(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept - { - return !(lhs == rhs); - } - - friend constexpr bool operator<(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept - { - return lhs.m_it < rhs.m_it; - } - - friend constexpr bool operator<=(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept - { - return lhs.m_it <= rhs.m_it; - } - - friend constexpr bool operator>(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept - { - return lhs.m_it > rhs.m_it; - } - - friend constexpr bool operator>=(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept - { - return lhs.m_it >= rhs.m_it; - } - - primitive_iterator_t operator+(difference_type i) - { - auto result = *this; - result += i; - return result; - } - - friend constexpr difference_type operator-(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept - { - return lhs.m_it - rhs.m_it; - } - - friend std::ostream& operator<<(std::ostream& os, primitive_iterator_t it) - { - return os << it.m_it; - } - - primitive_iterator_t& operator++() - { - ++m_it; - return *this; - } - - primitive_iterator_t operator++(int) - { - auto result = *this; - m_it++; - return result; - } - - primitive_iterator_t& operator--() - { - --m_it; - return *this; - } - - primitive_iterator_t operator--(int) - { - auto result = *this; - m_it--; - return result; - } - - primitive_iterator_t& operator+=(difference_type n) - { - m_it += n; - return *this; - } - - primitive_iterator_t& operator-=(difference_type n) - { - m_it -= n; - return *this; - } - - private: - static constexpr difference_type begin_value = 0; - static constexpr difference_type end_value = begin_value + 1; - - /// iterator as signed integer type - difference_type m_it = std::numeric_limits::denorm_min(); - }; - - /*! - @brief an iterator value - - @note This structure could easily be a union, but MSVC currently does not - allow unions members with complex constructors, see - https://github.com/nlohmann/json/pull/105. - */ - struct internal_iterator - { - /// iterator for JSON objects - typename object_t::iterator object_iterator; - /// iterator for JSON arrays - typename array_t::iterator array_iterator; - /// generic iterator for all other types - primitive_iterator_t primitive_iterator; - - /// create an uninitialized internal_iterator - internal_iterator() noexcept - : object_iterator(), array_iterator(), primitive_iterator() - {} - }; - - /// proxy class for the iterator_wrapper functions - template - class iteration_proxy - { - private: - /// helper class for iteration - class iteration_proxy_internal - { - private: - /// the iterator - IteratorType anchor; - /// an index for arrays (used to create key names) - size_t array_index = 0; - - public: - explicit iteration_proxy_internal(IteratorType it) noexcept - : anchor(it) - {} - - /// dereference operator (needed for range-based for) - iteration_proxy_internal& operator*() - { - return *this; - } - - /// increment operator (needed for range-based for) - iteration_proxy_internal& operator++() - { - ++anchor; - ++array_index; - - return *this; - } - - /// inequality operator (needed for range-based for) - bool operator!= (const iteration_proxy_internal& o) const - { - return anchor != o.anchor; - } - - /// return key of the iterator - typename basic_json::string_t key() const - { - assert(anchor.m_object != nullptr); - - switch (anchor.m_object->type()) - { - // use integer array index as key - case value_t::array: - { - return std::to_string(array_index); - } - - // use key from the object - case value_t::object: - { - return anchor.key(); - } - - // use an empty key for all primitive types - default: - { - return ""; - } - } - } - - /// return value of the iterator - typename IteratorType::reference value() const - { - return anchor.value(); - } - }; - - /// the container to iterate - typename IteratorType::reference container; - - public: - /// construct iteration proxy from a container - explicit iteration_proxy(typename IteratorType::reference cont) - : container(cont) - {} - - /// return iterator begin (needed for range-based for) - iteration_proxy_internal begin() noexcept - { - return iteration_proxy_internal(container.begin()); - } - - /// return iterator end (needed for range-based for) - iteration_proxy_internal end() noexcept - { - return iteration_proxy_internal(container.end()); - } - }; - - public: - /*! - @brief a template for a random access iterator for the @ref basic_json class - - This class implements a both iterators (iterator and const_iterator) for the - @ref basic_json class. - - @note An iterator is called *initialized* when a pointer to a JSON value - has been set (e.g., by a constructor or a copy assignment). If the - iterator is default-constructed, it is *uninitialized* and most - methods are undefined. **The library uses assertions to detect calls - on uninitialized iterators.** - - @requirement The class satisfies the following concept requirements: - - [RandomAccessIterator](http://en.cppreference.com/w/cpp/concept/RandomAccessIterator): - The iterator that can be moved to point (forward and backward) to any - element in constant time. - - @since version 1.0.0, simplified in version 2.0.9 - */ - template - class iter_impl : public std::iterator - { - /// allow basic_json to access private members - friend class basic_json; - - // make sure U is basic_json or const basic_json - static_assert(std::is_same::value - or std::is_same::value, - "iter_impl only accepts (const) basic_json"); - - public: - /// the type of the values when the iterator is dereferenced - using value_type = typename basic_json::value_type; - /// a type to represent differences between iterators - using difference_type = typename basic_json::difference_type; - /// defines a pointer to the type iterated over (value_type) - using pointer = typename std::conditional::value, - typename basic_json::const_pointer, - typename basic_json::pointer>::type; - /// defines a reference to the type iterated over (value_type) - using reference = typename std::conditional::value, - typename basic_json::const_reference, - typename basic_json::reference>::type; - /// the category of the iterator - using iterator_category = std::bidirectional_iterator_tag; - - /// default constructor - iter_impl() = default; - - /*! - @brief constructor for a given JSON instance - @param[in] object pointer to a JSON object for this iterator - @pre object != nullptr - @post The iterator is initialized; i.e. `m_object != nullptr`. - */ - explicit iter_impl(pointer object) noexcept - : m_object(object) - { - assert(m_object != nullptr); - - switch (m_object->m_type) - { - case basic_json::value_t::object: - { - m_it.object_iterator = typename object_t::iterator(); - break; - } - - case basic_json::value_t::array: - { - m_it.array_iterator = typename array_t::iterator(); - break; - } - - default: - { - m_it.primitive_iterator = primitive_iterator_t(); - break; - } - } - } - - /*! - @note The conventional copy constructor and copy assignment are - implicitly defined. - Combined with the following converting constructor and assignment, - they support: copy from iterator to iterator, - copy from const iterator to const iterator, - and conversion from iterator to const iterator. - However conversion from const iterator to iterator is not defined. - */ - - /*! - @brief converting constructor - @param[in] other non-const iterator to copy from - @note It is not checked whether @a other is initialized. - */ - iter_impl(const iter_impl& other) noexcept - : m_object(other.m_object), m_it(other.m_it) - {} - - /*! - @brief converting assignment - @param[in,out] other non-const iterator to copy from - @return const/non-const iterator - @note It is not checked whether @a other is initialized. - */ - iter_impl& operator=(const iter_impl& other) noexcept - { - m_object = other.m_object; - m_it = other.m_it; - return *this; - } - - private: - /*! - @brief set the iterator to the first value - @pre The iterator is initialized; i.e. `m_object != nullptr`. - */ - void set_begin() noexcept - { - assert(m_object != nullptr); - - switch (m_object->m_type) - { - case basic_json::value_t::object: - { - m_it.object_iterator = m_object->m_value.object->begin(); - break; - } - - case basic_json::value_t::array: - { - m_it.array_iterator = m_object->m_value.array->begin(); - break; - } - - case basic_json::value_t::null: - { - // set to end so begin()==end() is true: null is empty - m_it.primitive_iterator.set_end(); - break; - } - - default: - { - m_it.primitive_iterator.set_begin(); - break; - } - } - } - - /*! - @brief set the iterator past the last value - @pre The iterator is initialized; i.e. `m_object != nullptr`. - */ - void set_end() noexcept - { - assert(m_object != nullptr); - - switch (m_object->m_type) - { - case basic_json::value_t::object: - { - m_it.object_iterator = m_object->m_value.object->end(); - break; - } - - case basic_json::value_t::array: - { - m_it.array_iterator = m_object->m_value.array->end(); - break; - } - - default: - { - m_it.primitive_iterator.set_end(); - break; - } - } - } - - public: - /*! - @brief return a reference to the value pointed to by the iterator - @pre The iterator is initialized; i.e. `m_object != nullptr`. - */ - reference operator*() const - { - assert(m_object != nullptr); - - switch (m_object->m_type) - { - case basic_json::value_t::object: - { - assert(m_it.object_iterator != m_object->m_value.object->end()); - return m_it.object_iterator->second; - } - - case basic_json::value_t::array: - { - assert(m_it.array_iterator != m_object->m_value.array->end()); - return *m_it.array_iterator; - } - - case basic_json::value_t::null: - { - JSON_THROW(invalid_iterator::create(214, "cannot get value")); - } - - default: - { - if (m_it.primitive_iterator.is_begin()) - { - return *m_object; - } - - JSON_THROW(invalid_iterator::create(214, "cannot get value")); - } - } - } - - /*! - @brief dereference the iterator - @pre The iterator is initialized; i.e. `m_object != nullptr`. - */ - pointer operator->() const - { - assert(m_object != nullptr); - - switch (m_object->m_type) - { - case basic_json::value_t::object: - { - assert(m_it.object_iterator != m_object->m_value.object->end()); - return &(m_it.object_iterator->second); - } - - case basic_json::value_t::array: - { - assert(m_it.array_iterator != m_object->m_value.array->end()); - return &*m_it.array_iterator; - } - - default: - { - if (m_it.primitive_iterator.is_begin()) - { - return m_object; - } - - JSON_THROW(invalid_iterator::create(214, "cannot get value")); - } - } - } - - /*! - @brief post-increment (it++) - @pre The iterator is initialized; i.e. `m_object != nullptr`. - */ - iter_impl operator++(int) - { - auto result = *this; - ++(*this); - return result; - } - - /*! - @brief pre-increment (++it) - @pre The iterator is initialized; i.e. `m_object != nullptr`. - */ - iter_impl& operator++() - { - assert(m_object != nullptr); - - switch (m_object->m_type) - { - case basic_json::value_t::object: - { - std::advance(m_it.object_iterator, 1); - break; - } - - case basic_json::value_t::array: - { - std::advance(m_it.array_iterator, 1); - break; - } - - default: - { - ++m_it.primitive_iterator; - break; - } - } - - return *this; - } - - /*! - @brief post-decrement (it--) - @pre The iterator is initialized; i.e. `m_object != nullptr`. - */ - iter_impl operator--(int) - { - auto result = *this; - --(*this); - return result; - } - - /*! - @brief pre-decrement (--it) - @pre The iterator is initialized; i.e. `m_object != nullptr`. - */ - iter_impl& operator--() - { - assert(m_object != nullptr); - - switch (m_object->m_type) - { - case basic_json::value_t::object: - { - std::advance(m_it.object_iterator, -1); - break; - } - - case basic_json::value_t::array: - { - std::advance(m_it.array_iterator, -1); - break; - } - - default: - { - --m_it.primitive_iterator; - break; - } - } - - return *this; - } - - /*! - @brief comparison: equal - @pre The iterator is initialized; i.e. `m_object != nullptr`. - */ - bool operator==(const iter_impl& other) const - { - // if objects are not the same, the comparison is undefined - if (m_object != other.m_object) - { - JSON_THROW(invalid_iterator::create(212, "cannot compare iterators of different containers")); - } - - assert(m_object != nullptr); - - switch (m_object->m_type) - { - case basic_json::value_t::object: - { - return (m_it.object_iterator == other.m_it.object_iterator); - } - - case basic_json::value_t::array: - { - return (m_it.array_iterator == other.m_it.array_iterator); - } - - default: - { - return (m_it.primitive_iterator == other.m_it.primitive_iterator); - } - } - } - - /*! - @brief comparison: not equal - @pre The iterator is initialized; i.e. `m_object != nullptr`. - */ - bool operator!=(const iter_impl& other) const - { - return not operator==(other); - } - - /*! - @brief comparison: smaller - @pre The iterator is initialized; i.e. `m_object != nullptr`. - */ - bool operator<(const iter_impl& other) const - { - // if objects are not the same, the comparison is undefined - if (m_object != other.m_object) - { - JSON_THROW(invalid_iterator::create(212, "cannot compare iterators of different containers")); - } - - assert(m_object != nullptr); - - switch (m_object->m_type) - { - case basic_json::value_t::object: - { - JSON_THROW(invalid_iterator::create(213, "cannot compare order of object iterators")); - } - - case basic_json::value_t::array: - { - return (m_it.array_iterator < other.m_it.array_iterator); - } - - default: - { - return (m_it.primitive_iterator < other.m_it.primitive_iterator); - } - } - } - - /*! - @brief comparison: less than or equal - @pre The iterator is initialized; i.e. `m_object != nullptr`. - */ - bool operator<=(const iter_impl& other) const - { - return not other.operator < (*this); - } - - /*! - @brief comparison: greater than - @pre The iterator is initialized; i.e. `m_object != nullptr`. - */ - bool operator>(const iter_impl& other) const - { - return not operator<=(other); - } - - /*! - @brief comparison: greater than or equal - @pre The iterator is initialized; i.e. `m_object != nullptr`. - */ - bool operator>=(const iter_impl& other) const - { - return not operator<(other); - } - - /*! - @brief add to iterator - @pre The iterator is initialized; i.e. `m_object != nullptr`. - */ - iter_impl& operator+=(difference_type i) - { - assert(m_object != nullptr); - - switch (m_object->m_type) - { - case basic_json::value_t::object: - { - JSON_THROW(invalid_iterator::create(209, "cannot use offsets with object iterators")); - } - - case basic_json::value_t::array: - { - std::advance(m_it.array_iterator, i); - break; - } - - default: - { - m_it.primitive_iterator += i; - break; - } - } - - return *this; - } - - /*! - @brief subtract from iterator - @pre The iterator is initialized; i.e. `m_object != nullptr`. - */ - iter_impl& operator-=(difference_type i) - { - return operator+=(-i); - } - - /*! - @brief add to iterator - @pre The iterator is initialized; i.e. `m_object != nullptr`. - */ - iter_impl operator+(difference_type i) const - { - auto result = *this; - result += i; - return result; - } - - /*! - @brief addition of distance and iterator - @pre The iterator is initialized; i.e. `m_object != nullptr`. - */ - friend iter_impl operator+(difference_type i, const iter_impl& it) - { - auto result = it; - result += i; - return result; - } - - /*! - @brief subtract from iterator - @pre The iterator is initialized; i.e. `m_object != nullptr`. - */ - iter_impl operator-(difference_type i) const - { - auto result = *this; - result -= i; - return result; - } - - /*! - @brief return difference - @pre The iterator is initialized; i.e. `m_object != nullptr`. - */ - difference_type operator-(const iter_impl& other) const - { - assert(m_object != nullptr); - - switch (m_object->m_type) - { - case basic_json::value_t::object: - { - JSON_THROW(invalid_iterator::create(209, "cannot use offsets with object iterators")); - } - - case basic_json::value_t::array: - { - return m_it.array_iterator - other.m_it.array_iterator; - } - - default: - { - return m_it.primitive_iterator - other.m_it.primitive_iterator; - } - } - } - - /*! - @brief access to successor - @pre The iterator is initialized; i.e. `m_object != nullptr`. - */ - reference operator[](difference_type n) const - { - assert(m_object != nullptr); - - switch (m_object->m_type) - { - case basic_json::value_t::object: - { - JSON_THROW(invalid_iterator::create(208, "cannot use operator[] for object iterators")); - } - - case basic_json::value_t::array: - { - return *std::next(m_it.array_iterator, n); - } - - case basic_json::value_t::null: - { - JSON_THROW(invalid_iterator::create(214, "cannot get value")); - } - - default: - { - if (m_it.primitive_iterator.get_value() == -n) - { - return *m_object; - } - - JSON_THROW(invalid_iterator::create(214, "cannot get value")); - } - } - } - - /*! - @brief return the key of an object iterator - @pre The iterator is initialized; i.e. `m_object != nullptr`. - */ - typename object_t::key_type key() const - { - assert(m_object != nullptr); - - if (m_object->is_object()) - { - return m_it.object_iterator->first; - } - - JSON_THROW(invalid_iterator::create(207, "cannot use key() for non-object iterators")); - } - - /*! - @brief return the value of an iterator - @pre The iterator is initialized; i.e. `m_object != nullptr`. - */ - reference value() const - { - return operator*(); - } - - private: - /// associated JSON instance - pointer m_object = nullptr; - /// the actual iterator of the associated instance - struct internal_iterator m_it = internal_iterator(); - }; - - /*! - @brief a template for a reverse iterator class - - @tparam Base the base iterator type to reverse. Valid types are @ref - iterator (to create @ref reverse_iterator) and @ref const_iterator (to - create @ref const_reverse_iterator). - - @requirement The class satisfies the following concept requirements: - - [RandomAccessIterator](http://en.cppreference.com/w/cpp/concept/RandomAccessIterator): - The iterator that can be moved to point (forward and backward) to any - element in constant time. - - [OutputIterator](http://en.cppreference.com/w/cpp/concept/OutputIterator): - It is possible to write to the pointed-to element (only if @a Base is - @ref iterator). - - @since version 1.0.0 - */ - template - class json_reverse_iterator : public std::reverse_iterator - { - public: - /// shortcut to the reverse iterator adaptor - using base_iterator = std::reverse_iterator; - /// the reference type for the pointed-to element - using reference = typename Base::reference; - - /// create reverse iterator from iterator - json_reverse_iterator(const typename base_iterator::iterator_type& it) noexcept - : base_iterator(it) - {} - - /// create reverse iterator from base class - json_reverse_iterator(const base_iterator& it) noexcept - : base_iterator(it) - {} - - /// post-increment (it++) - json_reverse_iterator operator++(int) - { - return static_cast(base_iterator::operator++(1)); - } - - /// pre-increment (++it) - json_reverse_iterator& operator++() - { - return static_cast(base_iterator::operator++()); - } - - /// post-decrement (it--) - json_reverse_iterator operator--(int) - { - return static_cast(base_iterator::operator--(1)); - } - - /// pre-decrement (--it) - json_reverse_iterator& operator--() - { - return static_cast(base_iterator::operator--()); - } - - /// add to iterator - json_reverse_iterator& operator+=(difference_type i) - { - return static_cast(base_iterator::operator+=(i)); - } - - /// add to iterator - json_reverse_iterator operator+(difference_type i) const - { - return static_cast(base_iterator::operator+(i)); - } - - /// subtract from iterator - json_reverse_iterator operator-(difference_type i) const - { - return static_cast(base_iterator::operator-(i)); - } - - /// return difference - difference_type operator-(const json_reverse_iterator& other) const - { - return base_iterator(*this) - base_iterator(other); - } - - /// access to successor - reference operator[](difference_type n) const - { - return *(this->operator+(n)); - } - - /// return the key of an object iterator - typename object_t::key_type key() const - { - auto it = --this->base(); - return it.key(); - } - - /// return the value of an iterator - reference value() const - { - auto it = --this->base(); - return it.operator * (); - } - }; - - - private: - //////////////////// - // input adapters // - //////////////////// - - /// abstract input adapter interface - class input_adapter - { - public: - virtual int get_character() = 0; - virtual std::string read(size_t offset, size_t length) = 0; - virtual ~input_adapter() {} - - // native support - - /// input adapter for input stream - static std::shared_ptr create(std::istream& i) - { - return std::make_shared> (i); - } - - /// input adapter for input stream - static std::shared_ptr create(std::istream&& i) - { - return std::make_shared>(i); - } - - /// input adapter for buffer - static std::shared_ptr create(const char* b, size_t l) - { - return std::make_shared(b, l); - } - - // derived support - - /// input adapter for string literal - template::value and - std::is_integral::type>::value and - sizeof(typename std::remove_pointer::type) == 1, int>::type = 0> - static std::shared_ptr create(CharT b) - { - return create(reinterpret_cast(b), - std::strlen(reinterpret_cast(b))); - } - - /// input adapter for iterator range with contiguous storage - template::iterator_category, std::random_access_iterator_tag>::value - , int>::type - = 0> - static std::shared_ptr create(IteratorType first, IteratorType last) - { - // assertion to check that the iterator range is indeed contiguous, - // see http://stackoverflow.com/a/35008842/266378 for more discussion - assert(std::accumulate(first, last, std::pair(true, 0), - [&first](std::pair res, decltype(*first) val) - { - res.first &= (val == *(std::next(std::addressof(*first), res.second++))); - return res; - }).first); - - // assertion to check that each element is 1 byte long - static_assert(sizeof(typename std::iterator_traits::value_type) == 1, - "each element in the iterator range must have the size of 1 byte"); - - const auto len = static_cast(std::distance(first, last)); - if (JSON_LIKELY(len > 0)) - { - // there is at least one element: use the address of first - return create(reinterpret_cast(&(*first)), len); - } - else - { - // the address of first cannot be used - use nullptr - return create(nullptr, len); - } - } - - /// input adapter for array - template - static std::shared_ptr create(T (&array)[N]) - { - // delegate the call to the iterator-range overload - return create(std::begin(array), std::end(array)); - } - - /// input adapter for contiguous container - template::value and - std::is_base_of< - std::random_access_iterator_tag, - typename std::iterator_traits()))>::iterator_category>::value - , int>::type = 0> - static std::shared_ptr create(const ContiguousContainer& c) - { - // delegate the call to the iterator-range overload - return create(std::begin(c), std::end(c)); - } - }; - - /// a type to simplify interfaces - using input_adapter_t = std::shared_ptr; - - /// input adapter for cached stream input - template - class cached_input_stream_adapter : public input_adapter - { - public: - cached_input_stream_adapter(std::istream& i) - : is(i), start_position(is.tellg()) - { - fill_buffer(); - - // skip byte order mark - if (fill_size >= 3 and buffer[0] == '\xEF' and buffer[1] == '\xBB' and buffer[2] == '\xBF') - { - buffer_pos += 3; - processed_chars += 3; - } - } - - ~cached_input_stream_adapter() override - { - // clear stream flags - is.clear(); - // We initially read a lot of characters into the buffer, and we - // may not have processed all of them. Therefore, we need to - // "rewind" the stream after the last processed char. - is.seekg(start_position); - is.ignore(static_cast(processed_chars)); - // clear stream flags - is.clear(); - } - - int get_character() override - { - // check if refilling is necessary and possible - if (buffer_pos == fill_size and not eof) - { - fill_buffer(); - - // check and remember that filling did not yield new input - if (fill_size == 0) - { - eof = true; - return std::char_traits::eof(); - } - - // the buffer is ready - buffer_pos = 0; - } - - ++processed_chars; - assert(buffer_pos < buffer.size()); - return buffer[buffer_pos++] & 0xFF; - } - - std::string read(size_t offset, size_t length) override - { - // create buffer - std::string result(length, '\0'); - - // save stream position - const auto current_pos = is.tellg(); - // save stream flags - const auto flags = is.rdstate(); - - // clear stream flags - is.clear(); - // set stream position - is.seekg(static_cast(offset)); - // read bytes - is.read(&result[0], static_cast(length)); - - // reset stream position - is.seekg(current_pos); - // reset stream flags - is.setstate(flags); - - return result; - } - - private: - void fill_buffer() - { - // fill - is.read(buffer.data(), static_cast(buffer.size())); - // store number of bytes in the buffer - fill_size = static_cast(is.gcount()); - } - - /// the associated input stream - std::istream& is; - - /// chars returned via get_character() - size_t processed_chars = 0; - /// chars processed in the current buffer - size_t buffer_pos = 0; - - /// whether stream reached eof - bool eof = false; - /// how many chars have been copied to the buffer by last (re)fill - size_t fill_size = 0; - - /// position of the stream when we started - const std::streampos start_position; - - /// internal buffer - std::array buffer{{}}; - }; - - /// input adapter for buffer input - class input_buffer_adapter : public input_adapter - { - public: - input_buffer_adapter(const char* b, size_t l) - : input_adapter(), cursor(b), limit(b + l), start(b) - { - // skip byte order mark - if (l >= 3 and b[0] == '\xEF' and b[1] == '\xBB' and b[2] == '\xBF') - { - cursor += 3; - } - } - - // delete because of pointer members - input_buffer_adapter(const input_buffer_adapter&) = delete; - input_buffer_adapter& operator=(input_buffer_adapter&) = delete; - - int get_character() noexcept override - { - if (JSON_LIKELY(cursor < limit)) - { - return *(cursor++) & 0xFF; - } - else - { - return std::char_traits::eof(); - } - } - - std::string read(size_t offset, size_t length) override - { - // avoid reading too many characters - const size_t max_length = static_cast(limit - start); - return std::string(start + offset, (std::min)(length, max_length - offset)); - } - - private: - /// pointer to the current character - const char* cursor; - /// pointer past the last character - const char* limit; - /// pointer to the first character - const char* start; - }; - - ////////////////////////////////////////// - // binary serialization/deserialization // - ////////////////////////////////////////// - - /// @name binary serialization/deserialization support - /// @{ - - private: - /*! - @brief deserialization of CBOR and MessagePack values - */ - class binary_reader - { - public: - /*! - @brief create a binary reader - - @param[in] adapter input adapter to read from - */ - explicit binary_reader(input_adapter_t adapter) - : ia(adapter), is_little_endian(little_endianess()) - { - assert(ia); - } - - /*! - @brief create a JSON value from CBOR input - - @param[in] get_char whether a new character should be retrieved from - the input (true, default) or whether the last - read character should be considered instead - - @return JSON value created from CBOR input - - @throw parse_error.110 if input ended unexpectedly - @throw parse_error.112 if unsupported byte was read - */ - basic_json parse_cbor(const bool get_char = true) - { - switch (get_char ? get() : current) - { - // EOF - case std::char_traits::eof(): - { - JSON_THROW(parse_error::create(110, chars_read, "unexpected end of input")); - } - - // Integer 0x00..0x17 (0..23) - case 0x00: - case 0x01: - case 0x02: - case 0x03: - case 0x04: - case 0x05: - case 0x06: - case 0x07: - case 0x08: - case 0x09: - case 0x0a: - case 0x0b: - case 0x0c: - case 0x0d: - case 0x0e: - case 0x0f: - case 0x10: - case 0x11: - case 0x12: - case 0x13: - case 0x14: - case 0x15: - case 0x16: - case 0x17: - { - return static_cast(current); - } - - case 0x18: // Unsigned integer (one-byte uint8_t follows) - { - return get_number(); - } - - case 0x19: // Unsigned integer (two-byte uint16_t follows) - { - return get_number(); - } - - case 0x1a: // Unsigned integer (four-byte uint32_t follows) - { - return get_number(); - } - - case 0x1b: // Unsigned integer (eight-byte uint64_t follows) - { - return get_number(); - } - - // Negative integer -1-0x00..-1-0x17 (-1..-24) - case 0x20: - case 0x21: - case 0x22: - case 0x23: - case 0x24: - case 0x25: - case 0x26: - case 0x27: - case 0x28: - case 0x29: - case 0x2a: - case 0x2b: - case 0x2c: - case 0x2d: - case 0x2e: - case 0x2f: - case 0x30: - case 0x31: - case 0x32: - case 0x33: - case 0x34: - case 0x35: - case 0x36: - case 0x37: - { - return static_cast(0x20 - 1 - current); - } - - case 0x38: // Negative integer (one-byte uint8_t follows) - { - // must be uint8_t ! - return static_cast(-1) - get_number(); - } - - case 0x39: // Negative integer -1-n (two-byte uint16_t follows) - { - return static_cast(-1) - get_number(); - } - - case 0x3a: // Negative integer -1-n (four-byte uint32_t follows) - { - return static_cast(-1) - get_number(); - } - - case 0x3b: // Negative integer -1-n (eight-byte uint64_t follows) - { - return static_cast(-1) - static_cast(get_number()); - } - - // UTF-8 string (0x00..0x17 bytes follow) - case 0x60: - case 0x61: - case 0x62: - case 0x63: - case 0x64: - case 0x65: - case 0x66: - case 0x67: - case 0x68: - case 0x69: - case 0x6a: - case 0x6b: - case 0x6c: - case 0x6d: - case 0x6e: - case 0x6f: - case 0x70: - case 0x71: - case 0x72: - case 0x73: - case 0x74: - case 0x75: - case 0x76: - case 0x77: - case 0x78: // UTF-8 string (one-byte uint8_t for n follows) - case 0x79: // UTF-8 string (two-byte uint16_t for n follow) - case 0x7a: // UTF-8 string (four-byte uint32_t for n follow) - case 0x7b: // UTF-8 string (eight-byte uint64_t for n follow) - case 0x7f: // UTF-8 string (indefinite length) - { - return get_cbor_string(); - } - - // array (0x00..0x17 data items follow) - case 0x80: - case 0x81: - case 0x82: - case 0x83: - case 0x84: - case 0x85: - case 0x86: - case 0x87: - case 0x88: - case 0x89: - case 0x8a: - case 0x8b: - case 0x8c: - case 0x8d: - case 0x8e: - case 0x8f: - case 0x90: - case 0x91: - case 0x92: - case 0x93: - case 0x94: - case 0x95: - case 0x96: - case 0x97: - { - basic_json result = value_t::array; - const auto len = static_cast(current & 0x1f); - for (size_t i = 0; i < len; ++i) - { - result.push_back(parse_cbor()); - } - return result; - } - - case 0x98: // array (one-byte uint8_t for n follows) - { - basic_json result = value_t::array; - const auto len = static_cast(get_number()); - for (size_t i = 0; i < len; ++i) - { - result.push_back(parse_cbor()); - } - return result; - } - - case 0x99: // array (two-byte uint16_t for n follow) - { - basic_json result = value_t::array; - const auto len = static_cast(get_number()); - for (size_t i = 0; i < len; ++i) - { - result.push_back(parse_cbor()); - } - return result; - } - - case 0x9a: // array (four-byte uint32_t for n follow) - { - basic_json result = value_t::array; - const auto len = static_cast(get_number()); - for (size_t i = 0; i < len; ++i) - { - result.push_back(parse_cbor()); - } - return result; - } - - case 0x9b: // array (eight-byte uint64_t for n follow) - { - basic_json result = value_t::array; - const auto len = static_cast(get_number()); - for (size_t i = 0; i < len; ++i) - { - result.push_back(parse_cbor()); - } - return result; - } - - case 0x9f: // array (indefinite length) - { - basic_json result = value_t::array; - while (get() != 0xff) - { - result.push_back(parse_cbor(false)); - } - return result; - } - - // map (0x00..0x17 pairs of data items follow) - case 0xa0: - case 0xa1: - case 0xa2: - case 0xa3: - case 0xa4: - case 0xa5: - case 0xa6: - case 0xa7: - case 0xa8: - case 0xa9: - case 0xaa: - case 0xab: - case 0xac: - case 0xad: - case 0xae: - case 0xaf: - case 0xb0: - case 0xb1: - case 0xb2: - case 0xb3: - case 0xb4: - case 0xb5: - case 0xb6: - case 0xb7: - { - basic_json result = value_t::object; - const auto len = static_cast(current & 0x1f); - for (size_t i = 0; i < len; ++i) - { - get(); - auto key = get_cbor_string(); - result[key] = parse_cbor(); - } - return result; - } - - case 0xb8: // map (one-byte uint8_t for n follows) - { - basic_json result = value_t::object; - const auto len = static_cast(get_number()); - for (size_t i = 0; i < len; ++i) - { - get(); - auto key = get_cbor_string(); - result[key] = parse_cbor(); - } - return result; - } - - case 0xb9: // map (two-byte uint16_t for n follow) - { - basic_json result = value_t::object; - const auto len = static_cast(get_number()); - for (size_t i = 0; i < len; ++i) - { - get(); - auto key = get_cbor_string(); - result[key] = parse_cbor(); - } - return result; - } - - case 0xba: // map (four-byte uint32_t for n follow) - { - basic_json result = value_t::object; - const auto len = static_cast(get_number()); - for (size_t i = 0; i < len; ++i) - { - get(); - auto key = get_cbor_string(); - result[key] = parse_cbor(); - } - return result; - } - - case 0xbb: // map (eight-byte uint64_t for n follow) - { - basic_json result = value_t::object; - const auto len = static_cast(get_number()); - for (size_t i = 0; i < len; ++i) - { - get(); - auto key = get_cbor_string(); - result[key] = parse_cbor(); - } - return result; - } - - case 0xbf: // map (indefinite length) - { - basic_json result = value_t::object; - while (get() != 0xff) - { - auto key = get_cbor_string(); - result[key] = parse_cbor(); - } - return result; - } - - case 0xf4: // false - { - return false; - } - - case 0xf5: // true - { - return true; - } - - case 0xf6: // null - { - return value_t::null; - } - - case 0xf9: // Half-Precision Float (two-byte IEEE 754) - { - const int byte1 = get(); - check_eof(); - const int byte2 = get(); - check_eof(); - - // code from RFC 7049, Appendix D, Figure 3: - // As half-precision floating-point numbers were only added - // to IEEE 754 in 2008, today's programming platforms often - // still only have limited support for them. It is very - // easy to include at least decoding support for them even - // without such support. An example of a small decoder for - // half-precision floating-point numbers in the C language - // is shown in Fig. 3. - const int half = (byte1 << 8) + byte2; - const int exp = (half >> 10) & 0x1f; - const int mant = half & 0x3ff; - double val; - if (exp == 0) - { - val = std::ldexp(mant, -24); - } - else if (exp != 31) - { - val = std::ldexp(mant + 1024, exp - 25); - } - else - { - val = (mant == 0) - ? std::numeric_limits::infinity() - : std::numeric_limits::quiet_NaN(); - } - return (half & 0x8000) != 0 ? -val : val; - } - - case 0xfa: // Single-Precision Float (four-byte IEEE 754) - { - return get_number(); - } - - case 0xfb: // Double-Precision Float (eight-byte IEEE 754) - { - return get_number(); - } - - default: // anything else (0xFF is handled inside the other types) - { - std::stringstream ss; - ss << std::setw(2) << std::setfill('0') << std::hex << current; - JSON_THROW(parse_error::create(112, chars_read, "error reading CBOR; last byte: 0x" + ss.str())); - } - } - } - - /*! - @brief create a JSON value from MessagePack input - - @return JSON value created from MessagePack input - - @throw parse_error.110 if input ended unexpectedly - @throw parse_error.112 if unsupported byte was read - */ - basic_json parse_msgpack() - { - switch (get()) - { - // EOF - case std::char_traits::eof(): - { - JSON_THROW(parse_error::create(110, chars_read, "unexpected end of input")); - } - - // positive fixint - case 0x00: - case 0x01: - case 0x02: - case 0x03: - case 0x04: - case 0x05: - case 0x06: - case 0x07: - case 0x08: - case 0x09: - case 0x0a: - case 0x0b: - case 0x0c: - case 0x0d: - case 0x0e: - case 0x0f: - case 0x10: - case 0x11: - case 0x12: - case 0x13: - case 0x14: - case 0x15: - case 0x16: - case 0x17: - case 0x18: - case 0x19: - case 0x1a: - case 0x1b: - case 0x1c: - case 0x1d: - case 0x1e: - case 0x1f: - case 0x20: - case 0x21: - case 0x22: - case 0x23: - case 0x24: - case 0x25: - case 0x26: - case 0x27: - case 0x28: - case 0x29: - case 0x2a: - case 0x2b: - case 0x2c: - case 0x2d: - case 0x2e: - case 0x2f: - case 0x30: - case 0x31: - case 0x32: - case 0x33: - case 0x34: - case 0x35: - case 0x36: - case 0x37: - case 0x38: - case 0x39: - case 0x3a: - case 0x3b: - case 0x3c: - case 0x3d: - case 0x3e: - case 0x3f: - case 0x40: - case 0x41: - case 0x42: - case 0x43: - case 0x44: - case 0x45: - case 0x46: - case 0x47: - case 0x48: - case 0x49: - case 0x4a: - case 0x4b: - case 0x4c: - case 0x4d: - case 0x4e: - case 0x4f: - case 0x50: - case 0x51: - case 0x52: - case 0x53: - case 0x54: - case 0x55: - case 0x56: - case 0x57: - case 0x58: - case 0x59: - case 0x5a: - case 0x5b: - case 0x5c: - case 0x5d: - case 0x5e: - case 0x5f: - case 0x60: - case 0x61: - case 0x62: - case 0x63: - case 0x64: - case 0x65: - case 0x66: - case 0x67: - case 0x68: - case 0x69: - case 0x6a: - case 0x6b: - case 0x6c: - case 0x6d: - case 0x6e: - case 0x6f: - case 0x70: - case 0x71: - case 0x72: - case 0x73: - case 0x74: - case 0x75: - case 0x76: - case 0x77: - case 0x78: - case 0x79: - case 0x7a: - case 0x7b: - case 0x7c: - case 0x7d: - case 0x7e: - case 0x7f: - { - return static_cast(current); - } - - // fixmap - case 0x80: - case 0x81: - case 0x82: - case 0x83: - case 0x84: - case 0x85: - case 0x86: - case 0x87: - case 0x88: - case 0x89: - case 0x8a: - case 0x8b: - case 0x8c: - case 0x8d: - case 0x8e: - case 0x8f: - { - basic_json result = value_t::object; - const auto len = static_cast(current & 0x0f); - for (size_t i = 0; i < len; ++i) - { - get(); - auto key = get_msgpack_string(); - result[key] = parse_msgpack(); - } - return result; - } - - // fixarray - case 0x90: - case 0x91: - case 0x92: - case 0x93: - case 0x94: - case 0x95: - case 0x96: - case 0x97: - case 0x98: - case 0x99: - case 0x9a: - case 0x9b: - case 0x9c: - case 0x9d: - case 0x9e: - case 0x9f: - { - basic_json result = value_t::array; - const auto len = static_cast(current & 0x0f); - for (size_t i = 0; i < len; ++i) - { - result.push_back(parse_msgpack()); - } - return result; - } - - // fixstr - case 0xa0: - case 0xa1: - case 0xa2: - case 0xa3: - case 0xa4: - case 0xa5: - case 0xa6: - case 0xa7: - case 0xa8: - case 0xa9: - case 0xaa: - case 0xab: - case 0xac: - case 0xad: - case 0xae: - case 0xaf: - case 0xb0: - case 0xb1: - case 0xb2: - case 0xb3: - case 0xb4: - case 0xb5: - case 0xb6: - case 0xb7: - case 0xb8: - case 0xb9: - case 0xba: - case 0xbb: - case 0xbc: - case 0xbd: - case 0xbe: - case 0xbf: - { - return get_msgpack_string(); - } - - case 0xc0: // nil - { - return value_t::null; - } - - case 0xc2: // false - { - return false; - } - - case 0xc3: // true - { - return true; - } - - case 0xca: // float 32 - { - return get_number(); - } - - case 0xcb: // float 64 - { - return get_number(); - } - - case 0xcc: // uint 8 - { - return get_number(); - } - - case 0xcd: // uint 16 - { - return get_number(); - } - - case 0xce: // uint 32 - { - return get_number(); - } - - case 0xcf: // uint 64 - { - return get_number(); - } - - case 0xd0: // int 8 - { - return get_number(); - } - - case 0xd1: // int 16 - { - return get_number(); - } - - case 0xd2: // int 32 - { - return get_number(); - } - - case 0xd3: // int 64 - { - return get_number(); - } - - case 0xd9: // str 8 - case 0xda: // str 16 - case 0xdb: // str 32 - { - return get_msgpack_string(); - } - - case 0xdc: // array 16 - { - basic_json result = value_t::array; - const auto len = static_cast(get_number()); - for (size_t i = 0; i < len; ++i) - { - result.push_back(parse_msgpack()); - } - return result; - } - - case 0xdd: // array 32 - { - basic_json result = value_t::array; - const auto len = static_cast(get_number()); - for (size_t i = 0; i < len; ++i) - { - result.push_back(parse_msgpack()); - } - return result; - } - - case 0xde: // map 16 - { - basic_json result = value_t::object; - const auto len = static_cast(get_number()); - for (size_t i = 0; i < len; ++i) - { - get(); - auto key = get_msgpack_string(); - result[key] = parse_msgpack(); - } - return result; - } - - case 0xdf: // map 32 - { - basic_json result = value_t::object; - const auto len = static_cast(get_number()); - for (size_t i = 0; i < len; ++i) - { - get(); - auto key = get_msgpack_string(); - result[key] = parse_msgpack(); - } - return result; - } - - // positive fixint - case 0xe0: - case 0xe1: - case 0xe2: - case 0xe3: - case 0xe4: - case 0xe5: - case 0xe6: - case 0xe7: - case 0xe8: - case 0xe9: - case 0xea: - case 0xeb: - case 0xec: - case 0xed: - case 0xee: - case 0xef: - case 0xf0: - case 0xf1: - case 0xf2: - case 0xf3: - case 0xf4: - case 0xf5: - case 0xf6: - case 0xf7: - case 0xf8: - case 0xf9: - case 0xfa: - case 0xfb: - case 0xfc: - case 0xfd: - case 0xfe: - case 0xff: - { - return static_cast(current); - } - - default: // anything else - { - std::stringstream ss; - ss << std::setw(2) << std::setfill('0') << std::hex << current; - JSON_THROW(parse_error::create(112, chars_read, "error reading MessagePack; last byte: 0x" + ss.str())); - } - } - } - - /*! - @brief determine system byte order - - @return true iff system's byte order is little endian - - @note from http://stackoverflow.com/a/1001328/266378 - */ - static bool little_endianess() noexcept - { - int num = 1; - return (*reinterpret_cast(&num) == 1); - } - - private: - /*! - @brief get next character from the input - - This function provides the interface to the used input adapter. It does - not throw in case the input reached EOF, but returns - `std::char_traits::eof()` in that case. - - @return character read from the input - */ - int get() - { - ++chars_read; - return (current = ia->get_character()); - } - - /* - @brief read a number from the input - - @tparam NumberType the type of the number - - @return number of type @a NumberType - - @note This function needs to respect the system's endianess, because - bytes in CBOR and MessagePack are stored in network order (big - endian) and therefore need reordering on little endian systems. - - @throw parse_error.110 if input has less than `sizeof(NumberType)` - bytes - */ - template - NumberType get_number() - { - // step 1: read input into array with system's byte order - std::array vec; - for (size_t i = 0; i < sizeof(NumberType); ++i) - { - get(); - check_eof(); - - // reverse byte order prior to conversion if necessary - if (is_little_endian) - { - vec[sizeof(NumberType) - i - 1] = static_cast(current); - } - else - { - vec[i] = static_cast(current); // LCOV_EXCL_LINE - } - } - - // step 2: convert array into number of type T and return - NumberType result; - std::memcpy(&result, vec.data(), sizeof(NumberType)); - return result; - } - - /*! - @brief create a string by reading characters from the input - - @param[in] len number of bytes to read - - @note We can not reserve @a len bytes for the result, because @a len - may be too large. Usually, @ref check_eof() detects the end of - the input before we run out of string memory. - - @return string created by reading @a len bytes - - @throw parse_error.110 if input has less than @a len bytes - */ - std::string get_string(const size_t len) - { - std::string result; - for (size_t i = 0; i < len; ++i) - { - get(); - check_eof(); - result.append(1, static_cast(current)); - } - return result; - } - - /*! - @brief reads a CBOR string - - This function first reads starting bytes to determine the expected - string length and then copies this number of bytes into a string. - Additionally, CBOR's strings with indefinite lengths are supported. - - @return string - - @throw parse_error.110 if input ended - @throw parse_error.113 if an unexpected byte is read - */ - std::string get_cbor_string() - { - check_eof(); - - switch (current) - { - // UTF-8 string (0x00..0x17 bytes follow) - case 0x60: - case 0x61: - case 0x62: - case 0x63: - case 0x64: - case 0x65: - case 0x66: - case 0x67: - case 0x68: - case 0x69: - case 0x6a: - case 0x6b: - case 0x6c: - case 0x6d: - case 0x6e: - case 0x6f: - case 0x70: - case 0x71: - case 0x72: - case 0x73: - case 0x74: - case 0x75: - case 0x76: - case 0x77: - { - const auto len = static_cast(current & 0x1f); - return get_string(len); - } - - case 0x78: // UTF-8 string (one-byte uint8_t for n follows) - { - const auto len = static_cast(get_number()); - return get_string(len); - } - - case 0x79: // UTF-8 string (two-byte uint16_t for n follow) - { - const auto len = static_cast(get_number()); - return get_string(len); - } - - case 0x7a: // UTF-8 string (four-byte uint32_t for n follow) - { - const auto len = static_cast(get_number()); - return get_string(len); - } - - case 0x7b: // UTF-8 string (eight-byte uint64_t for n follow) - { - const auto len = static_cast(get_number()); - return get_string(len); - } - - case 0x7f: // UTF-8 string (indefinite length) - { - std::string result; - while (get() != 0xff) - { - check_eof(); - result.append(1, static_cast(current)); - } - return result; - } - - default: - { - std::stringstream ss; - ss << std::setw(2) << std::setfill('0') << std::hex << current; - JSON_THROW(parse_error::create(113, chars_read, "expected a CBOR string; last byte: 0x" + ss.str())); - } - } - } - - /*! - @brief reads a MessagePack string - - This function first reads starting bytes to determine the expected - string length and then copies this number of bytes into a string. - - @return string - - @throw parse_error.110 if input ended - @throw parse_error.113 if an unexpected byte is read - */ - std::string get_msgpack_string() - { - check_eof(); - - switch (current) - { - // fixstr - case 0xa0: - case 0xa1: - case 0xa2: - case 0xa3: - case 0xa4: - case 0xa5: - case 0xa6: - case 0xa7: - case 0xa8: - case 0xa9: - case 0xaa: - case 0xab: - case 0xac: - case 0xad: - case 0xae: - case 0xaf: - case 0xb0: - case 0xb1: - case 0xb2: - case 0xb3: - case 0xb4: - case 0xb5: - case 0xb6: - case 0xb7: - case 0xb8: - case 0xb9: - case 0xba: - case 0xbb: - case 0xbc: - case 0xbd: - case 0xbe: - case 0xbf: - { - const auto len = static_cast(current & 0x1f); - return get_string(len); - } - - case 0xd9: // str 8 - { - const auto len = static_cast(get_number()); - return get_string(len); - } - - case 0xda: // str 16 - { - const auto len = static_cast(get_number()); - return get_string(len); - } - - case 0xdb: // str 32 - { - const auto len = static_cast(get_number()); - return get_string(len); - } - - default: - { - std::stringstream ss; - ss << std::setw(2) << std::setfill('0') << std::hex << current; - JSON_THROW(parse_error::create(113, chars_read, "expected a MessagePack string; last byte: 0x" + ss.str())); - } - } - } - - /*! - @brief check if input ended - @throw parse_error.110 if input ended - */ - void check_eof() const - { - if (JSON_UNLIKELY(current == std::char_traits::eof())) - { - JSON_THROW(parse_error::create(110, chars_read, "unexpected end of input")); - } - } - - private: - /// input adapter - input_adapter_t ia = nullptr; - - /// the current character - int current = std::char_traits::eof(); - - /// the number of characters read - size_t chars_read = 0; - - /// whether we can assume little endianess - const bool is_little_endian = true; - }; - - /*! - @brief serialization to CBOR and MessagePack values - */ - class binary_writer - { - public: - /*! - @brief create a binary writer - - @param[in] adapter output adapter to write to - */ - explicit binary_writer(output_adapter_t adapter) - : is_little_endian(binary_reader::little_endianess()), oa(adapter) - { - assert(oa); - } - - /*! - @brief[in] j JSON value to serialize - */ - void write_cbor(const basic_json& j) - { - switch (j.type()) - { - case value_t::null: - { - oa->write_character(0xf6); - break; - } - - case value_t::boolean: - { - oa->write_character(j.m_value.boolean ? 0xf5 : 0xf4); - break; - } - - case value_t::number_integer: - { - if (j.m_value.number_integer >= 0) - { - // CBOR does not differentiate between positive signed - // integers and unsigned integers. Therefore, we used the - // code from the value_t::number_unsigned case here. - if (j.m_value.number_integer <= 0x17) - { - write_number(static_cast(j.m_value.number_integer)); - } - else if (j.m_value.number_integer <= (std::numeric_limits::max)()) - { - oa->write_character(0x18); - write_number(static_cast(j.m_value.number_integer)); - } - else if (j.m_value.number_integer <= (std::numeric_limits::max)()) - { - oa->write_character(0x19); - write_number(static_cast(j.m_value.number_integer)); - } - else if (j.m_value.number_integer <= (std::numeric_limits::max)()) - { - oa->write_character(0x1a); - write_number(static_cast(j.m_value.number_integer)); - } - else - { - oa->write_character(0x1b); - write_number(static_cast(j.m_value.number_integer)); - } - } - else - { - // The conversions below encode the sign in the first - // byte, and the value is converted to a positive number. - const auto positive_number = -1 - j.m_value.number_integer; - if (j.m_value.number_integer >= -24) - { - write_number(static_cast(0x20 + positive_number)); - } - else if (positive_number <= (std::numeric_limits::max)()) - { - oa->write_character(0x38); - write_number(static_cast(positive_number)); - } - else if (positive_number <= (std::numeric_limits::max)()) - { - oa->write_character(0x39); - write_number(static_cast(positive_number)); - } - else if (positive_number <= (std::numeric_limits::max)()) - { - oa->write_character(0x3a); - write_number(static_cast(positive_number)); - } - else - { - oa->write_character(0x3b); - write_number(static_cast(positive_number)); - } - } - break; - } - - case value_t::number_unsigned: - { - if (j.m_value.number_unsigned <= 0x17) - { - write_number(static_cast(j.m_value.number_unsigned)); - } - else if (j.m_value.number_unsigned <= (std::numeric_limits::max)()) - { - oa->write_character(0x18); - write_number(static_cast(j.m_value.number_unsigned)); - } - else if (j.m_value.number_unsigned <= (std::numeric_limits::max)()) - { - oa->write_character(0x19); - write_number(static_cast(j.m_value.number_unsigned)); - } - else if (j.m_value.number_unsigned <= (std::numeric_limits::max)()) - { - oa->write_character(0x1a); - write_number(static_cast(j.m_value.number_unsigned)); - } - else - { - oa->write_character(0x1b); - write_number(static_cast(j.m_value.number_unsigned)); - } - break; - } - - case value_t::number_float: - { - // Double-Precision Float - oa->write_character(0xfb); - write_number(j.m_value.number_float); - break; - } - - case value_t::string: - { - // step 1: write control byte and the string length - const auto N = j.m_value.string->size(); - if (N <= 0x17) - { - write_number(static_cast(0x60 + N)); - } - else if (N <= 0xff) - { - oa->write_character(0x78); - write_number(static_cast(N)); - } - else if (N <= 0xffff) - { - oa->write_character(0x79); - write_number(static_cast(N)); - } - else if (N <= 0xffffffff) - { - oa->write_character(0x7a); - write_number(static_cast(N)); - } - // LCOV_EXCL_START - else if (N <= 0xffffffffffffffff) - { - oa->write_character(0x7b); - write_number(static_cast(N)); - } - // LCOV_EXCL_STOP - - // step 2: write the string - oa->write_characters(reinterpret_cast(j.m_value.string->c_str()), - j.m_value.string->size()); - break; - } - - case value_t::array: - { - // step 1: write control byte and the array size - const auto N = j.m_value.array->size(); - if (N <= 0x17) - { - write_number(static_cast(0x80 + N)); - } - else if (N <= 0xff) - { - oa->write_character(0x98); - write_number(static_cast(N)); - } - else if (N <= 0xffff) - { - oa->write_character(0x99); - write_number(static_cast(N)); - } - else if (N <= 0xffffffff) - { - oa->write_character(0x9a); - write_number(static_cast(N)); - } - // LCOV_EXCL_START - else if (N <= 0xffffffffffffffff) - { - oa->write_character(0x9b); - write_number(static_cast(N)); - } - // LCOV_EXCL_STOP - - // step 2: write each element - for (const auto& el : *j.m_value.array) - { - write_cbor(el); - } - break; - } - - case value_t::object: - { - // step 1: write control byte and the object size - const auto N = j.m_value.object->size(); - if (N <= 0x17) - { - write_number(static_cast(0xa0 + N)); - } - else if (N <= 0xff) - { - oa->write_character(0xb8); - write_number(static_cast(N)); - } - else if (N <= 0xffff) - { - oa->write_character(0xb9); - write_number(static_cast(N)); - } - else if (N <= 0xffffffff) - { - oa->write_character(0xba); - write_number(static_cast(N)); - } - // LCOV_EXCL_START - else if (N <= 0xffffffffffffffff) - { - oa->write_character(0xbb); - write_number(static_cast(N)); - } - // LCOV_EXCL_STOP - - // step 2: write each element - for (const auto& el : *j.m_value.object) - { - write_cbor(el.first); - write_cbor(el.second); - } - break; - } - - default: - { - break; - } - } - } - - /*! - @brief[in] j JSON value to serialize - */ - void write_msgpack(const basic_json& j) - { - switch (j.type()) - { - case value_t::null: - { - // nil - oa->write_character(0xc0); - break; - } - - case value_t::boolean: - { - // true and false - oa->write_character(j.m_value.boolean ? 0xc3 : 0xc2); - break; - } - - case value_t::number_integer: - { - if (j.m_value.number_integer >= 0) - { - // MessagePack does not differentiate between positive - // signed integers and unsigned integers. Therefore, we - // used the code from the value_t::number_unsigned case - // here. - if (j.m_value.number_unsigned < 128) - { - // positive fixnum - write_number(static_cast(j.m_value.number_integer)); - } - else if (j.m_value.number_unsigned <= (std::numeric_limits::max)()) - { - // uint 8 - oa->write_character(0xcc); - write_number(static_cast(j.m_value.number_integer)); - } - else if (j.m_value.number_unsigned <= (std::numeric_limits::max)()) - { - // uint 16 - oa->write_character(0xcd); - write_number(static_cast(j.m_value.number_integer)); - } - else if (j.m_value.number_unsigned <= (std::numeric_limits::max)()) - { - // uint 32 - oa->write_character(0xce); - write_number(static_cast(j.m_value.number_integer)); - } - else if (j.m_value.number_unsigned <= (std::numeric_limits::max)()) - { - // uint 64 - oa->write_character(0xcf); - write_number(static_cast(j.m_value.number_integer)); - } - } - else - { - if (j.m_value.number_integer >= -32) - { - // negative fixnum - write_number(static_cast(j.m_value.number_integer)); - } - else if (j.m_value.number_integer >= (std::numeric_limits::min)() and j.m_value.number_integer <= (std::numeric_limits::max)()) - { - // int 8 - oa->write_character(0xd0); - write_number(static_cast(j.m_value.number_integer)); - } - else if (j.m_value.number_integer >= (std::numeric_limits::min)() and j.m_value.number_integer <= (std::numeric_limits::max)()) - { - // int 16 - oa->write_character(0xd1); - write_number(static_cast(j.m_value.number_integer)); - } - else if (j.m_value.number_integer >= (std::numeric_limits::min)() and j.m_value.number_integer <= (std::numeric_limits::max)()) - { - // int 32 - oa->write_character(0xd2); - write_number(static_cast(j.m_value.number_integer)); - } - else if (j.m_value.number_integer >= (std::numeric_limits::min)() and j.m_value.number_integer <= (std::numeric_limits::max)()) - { - // int 64 - oa->write_character(0xd3); - write_number(static_cast(j.m_value.number_integer)); - } - } - break; - } - - case value_t::number_unsigned: - { - if (j.m_value.number_unsigned < 128) - { - // positive fixnum - write_number(static_cast(j.m_value.number_integer)); - } - else if (j.m_value.number_unsigned <= (std::numeric_limits::max)()) - { - // uint 8 - oa->write_character(0xcc); - write_number(static_cast(j.m_value.number_integer)); - } - else if (j.m_value.number_unsigned <= (std::numeric_limits::max)()) - { - // uint 16 - oa->write_character(0xcd); - write_number(static_cast(j.m_value.number_integer)); - } - else if (j.m_value.number_unsigned <= (std::numeric_limits::max)()) - { - // uint 32 - oa->write_character(0xce); - write_number(static_cast(j.m_value.number_integer)); - } - else if (j.m_value.number_unsigned <= (std::numeric_limits::max)()) - { - // uint 64 - oa->write_character(0xcf); - write_number(static_cast(j.m_value.number_integer)); - } - break; - } - - case value_t::number_float: - { - // float 64 - oa->write_character(0xcb); - write_number(j.m_value.number_float); - break; - } - - case value_t::string: - { - // step 1: write control byte and the string length - const auto N = j.m_value.string->size(); - if (N <= 31) - { - // fixstr - write_number(static_cast(0xa0 | N)); - } - else if (N <= 255) - { - // str 8 - oa->write_character(0xd9); - write_number(static_cast(N)); - } - else if (N <= 65535) - { - // str 16 - oa->write_character(0xda); - write_number(static_cast(N)); - } - else if (N <= 4294967295) - { - // str 32 - oa->write_character(0xdb); - write_number(static_cast(N)); - } - - // step 2: write the string - oa->write_characters(reinterpret_cast(j.m_value.string->c_str()), - j.m_value.string->size()); - break; - } - - case value_t::array: - { - // step 1: write control byte and the array size - const auto N = j.m_value.array->size(); - if (N <= 15) - { - // fixarray - write_number(static_cast(0x90 | N)); - } - else if (N <= 0xffff) - { - // array 16 - oa->write_character(0xdc); - write_number(static_cast(N)); - } - else if (N <= 0xffffffff) - { - // array 32 - oa->write_character(0xdd); - write_number(static_cast(N)); - } - - // step 2: write each element - for (const auto& el : *j.m_value.array) - { - write_msgpack(el); - } - break; - } - - case value_t::object: - { - // step 1: write control byte and the object size - const auto N = j.m_value.object->size(); - if (N <= 15) - { - // fixmap - write_number(static_cast(0x80 | (N & 0xf))); - } - else if (N <= 65535) - { - // map 16 - oa->write_character(0xde); - write_number(static_cast(N)); - } - else if (N <= 4294967295) - { - // map 32 - oa->write_character(0xdf); - write_number(static_cast(N)); - } - - // step 2: write each element - for (const auto& el : *j.m_value.object) - { - write_msgpack(el.first); - write_msgpack(el.second); - } - break; - } - - default: - { - break; - } - } - } - - private: - /* - @brief write a number to output input - - @param[in] n number of type @a NumberType - @tparam NumberType the type of the number - - @note This function needs to respect the system's endianess, because - bytes in CBOR and MessagePack are stored in network order (big - endian) and therefore need reordering on little endian systems. - */ - template - void write_number(NumberType n) - { - // step 1: write number to array of length NumberType - std::array vec; - std::memcpy(vec.data(), &n, sizeof(NumberType)); - - // step 2: write array to output (with possible reordering) - if (is_little_endian) - { - // reverse byte order prior to conversion if necessary - std::reverse(vec.begin(), vec.end()); - } - - oa->write_characters(vec.data(), sizeof(NumberType)); - } - - private: - /// whether we can assume little endianess - const bool is_little_endian = true; - - /// the output - output_adapter_t oa = nullptr; - }; - - public: - /*! - @brief create a CBOR serialization of a given JSON value - - Serializes a given JSON value @a j to a byte vector using the CBOR (Concise - Binary Object Representation) serialization format. CBOR is a binary - serialization format which aims to be more compact than JSON itself, yet - more efficient to parse. - - The library uses the following mapping from JSON values types to - CBOR types according to the CBOR specification (RFC 7049): - - JSON value type | value/range | CBOR type | first byte - --------------- | ------------------------------------------ | ---------------------------------- | --------------- - null | `null` | Null | 0xf6 - boolean | `true` | True | 0xf5 - boolean | `false` | False | 0xf4 - number_integer | -9223372036854775808..-2147483649 | Negative integer (8 bytes follow) | 0x3b - number_integer | -2147483648..-32769 | Negative integer (4 bytes follow) | 0x3a - number_integer | -32768..-129 | Negative integer (2 bytes follow) | 0x39 - number_integer | -128..-25 | Negative integer (1 byte follow) | 0x38 - number_integer | -24..-1 | Negative integer | 0x20..0x37 - number_integer | 0..23 | Integer | 0x00..0x17 - number_integer | 24..255 | Unsigned integer (1 byte follow) | 0x18 - number_integer | 256..65535 | Unsigned integer (2 bytes follow) | 0x19 - number_integer | 65536..4294967295 | Unsigned integer (4 bytes follow) | 0x1a - number_integer | 4294967296..18446744073709551615 | Unsigned integer (8 bytes follow) | 0x1b - number_unsigned | 0..23 | Integer | 0x00..0x17 - number_unsigned | 24..255 | Unsigned integer (1 byte follow) | 0x18 - number_unsigned | 256..65535 | Unsigned integer (2 bytes follow) | 0x19 - number_unsigned | 65536..4294967295 | Unsigned integer (4 bytes follow) | 0x1a - number_unsigned | 4294967296..18446744073709551615 | Unsigned integer (8 bytes follow) | 0x1b - number_float | *any value* | Double-Precision Float | 0xfb - string | *length*: 0..23 | UTF-8 string | 0x60..0x77 - string | *length*: 23..255 | UTF-8 string (1 byte follow) | 0x78 - string | *length*: 256..65535 | UTF-8 string (2 bytes follow) | 0x79 - string | *length*: 65536..4294967295 | UTF-8 string (4 bytes follow) | 0x7a - string | *length*: 4294967296..18446744073709551615 | UTF-8 string (8 bytes follow) | 0x7b - array | *size*: 0..23 | array | 0x80..0x97 - array | *size*: 23..255 | array (1 byte follow) | 0x98 - array | *size*: 256..65535 | array (2 bytes follow) | 0x99 - array | *size*: 65536..4294967295 | array (4 bytes follow) | 0x9a - array | *size*: 4294967296..18446744073709551615 | array (8 bytes follow) | 0x9b - object | *size*: 0..23 | map | 0xa0..0xb7 - object | *size*: 23..255 | map (1 byte follow) | 0xb8 - object | *size*: 256..65535 | map (2 bytes follow) | 0xb9 - object | *size*: 65536..4294967295 | map (4 bytes follow) | 0xba - object | *size*: 4294967296..18446744073709551615 | map (8 bytes follow) | 0xbb - - @note The mapping is **complete** in the sense that any JSON value type - can be converted to a CBOR value. - - @note The following CBOR types are not used in the conversion: - - byte strings (0x40..0x5f) - - UTF-8 strings terminated by "break" (0x7f) - - arrays terminated by "break" (0x9f) - - maps terminated by "break" (0xbf) - - date/time (0xc0..0xc1) - - bignum (0xc2..0xc3) - - decimal fraction (0xc4) - - bigfloat (0xc5) - - tagged items (0xc6..0xd4, 0xd8..0xdb) - - expected conversions (0xd5..0xd7) - - simple values (0xe0..0xf3, 0xf8) - - undefined (0xf7) - - half and single-precision floats (0xf9-0xfa) - - break (0xff) - - @param[in] j JSON value to serialize - @return MessagePack serialization as byte vector - - @complexity Linear in the size of the JSON value @a j. - - @liveexample{The example shows the serialization of a JSON value to a byte - vector in CBOR format.,to_cbor} - - @sa http://cbor.io - @sa @ref from_cbor(const std::vector&, const size_t) for the - analogous deserialization - @sa @ref to_msgpack(const basic_json& for the related MessagePack format - - @since version 2.0.9 - */ - static std::vector to_cbor(const basic_json& j) - { - std::vector result; - binary_writer bw(output_adapter::create(result)); - bw.write_cbor(j); - return result; - } - - /*! - @brief create a MessagePack serialization of a given JSON value - - Serializes a given JSON value @a j to a byte vector using the MessagePack - serialization format. MessagePack is a binary serialization format which - aims to be more compact than JSON itself, yet more efficient to parse. - - The library uses the following mapping from JSON values types to - MessagePack types according to the MessagePack specification: - - JSON value type | value/range | MessagePack type | first byte - --------------- | --------------------------------- | ---------------- | ---------- - null | `null` | nil | 0xc0 - boolean | `true` | true | 0xc3 - boolean | `false` | false | 0xc2 - number_integer | -9223372036854775808..-2147483649 | int64 | 0xd3 - number_integer | -2147483648..-32769 | int32 | 0xd2 - number_integer | -32768..-129 | int16 | 0xd1 - number_integer | -128..-33 | int8 | 0xd0 - number_integer | -32..-1 | negative fixint | 0xe0..0xff - number_integer | 0..127 | positive fixint | 0x00..0x7f - number_integer | 128..255 | uint 8 | 0xcc - number_integer | 256..65535 | uint 16 | 0xcd - number_integer | 65536..4294967295 | uint 32 | 0xce - number_integer | 4294967296..18446744073709551615 | uint 64 | 0xcf - number_unsigned | 0..127 | positive fixint | 0x00..0x7f - number_unsigned | 128..255 | uint 8 | 0xcc - number_unsigned | 256..65535 | uint 16 | 0xcd - number_unsigned | 65536..4294967295 | uint 32 | 0xce - number_unsigned | 4294967296..18446744073709551615 | uint 64 | 0xcf - number_float | *any value* | float 64 | 0xcb - string | *length*: 0..31 | fixstr | 0xa0..0xbf - string | *length*: 32..255 | str 8 | 0xd9 - string | *length*: 256..65535 | str 16 | 0xda - string | *length*: 65536..4294967295 | str 32 | 0xdb - array | *size*: 0..15 | fixarray | 0x90..0x9f - array | *size*: 16..65535 | array 16 | 0xdc - array | *size*: 65536..4294967295 | array 32 | 0xdd - object | *size*: 0..15 | fix map | 0x80..0x8f - object | *size*: 16..65535 | map 16 | 0xde - object | *size*: 65536..4294967295 | map 32 | 0xdf - - @note The mapping is **complete** in the sense that any JSON value type - can be converted to a MessagePack value. - - @note The following values can **not** be converted to a MessagePack value: - - strings with more than 4294967295 bytes - - arrays with more than 4294967295 elements - - objects with more than 4294967295 elements - - @note The following MessagePack types are not used in the conversion: - - bin 8 - bin 32 (0xc4..0xc6) - - ext 8 - ext 32 (0xc7..0xc9) - - float 32 (0xca) - - fixext 1 - fixext 16 (0xd4..0xd8) - - @note Any MessagePack output created @ref to_msgpack can be successfully - parsed by @ref from_msgpack. - - @param[in] j JSON value to serialize - @return MessagePack serialization as byte vector - - @complexity Linear in the size of the JSON value @a j. - - @liveexample{The example shows the serialization of a JSON value to a byte - vector in MessagePack format.,to_msgpack} - - @sa http://msgpack.org - @sa @ref from_msgpack(const std::vector&, const size_t) for the - analogous deserialization - @sa @ref to_cbor(const basic_json& for the related CBOR format - - @since version 2.0.9 - */ - static std::vector to_msgpack(const basic_json& j) - { - std::vector result; - binary_writer bw(output_adapter::create(result)); - bw.write_msgpack(j); - return result; - } - - /*! - @brief create a JSON value from a byte vector in CBOR format - - Deserializes a given byte vector @a v to a JSON value using the CBOR - (Concise Binary Object Representation) serialization format. - - The library maps CBOR types to JSON value types as follows: - - CBOR type | JSON value type | first byte - ---------------------- | --------------- | ---------- - Integer | number_unsigned | 0x00..0x17 - Unsigned integer | number_unsigned | 0x18 - Unsigned integer | number_unsigned | 0x19 - Unsigned integer | number_unsigned | 0x1a - Unsigned integer | number_unsigned | 0x1b - Negative integer | number_integer | 0x20..0x37 - Negative integer | number_integer | 0x38 - Negative integer | number_integer | 0x39 - Negative integer | number_integer | 0x3a - Negative integer | number_integer | 0x3b - Negative integer | number_integer | 0x40..0x57 - UTF-8 string | string | 0x60..0x77 - UTF-8 string | string | 0x78 - UTF-8 string | string | 0x79 - UTF-8 string | string | 0x7a - UTF-8 string | string | 0x7b - UTF-8 string | string | 0x7f - array | array | 0x80..0x97 - array | array | 0x98 - array | array | 0x99 - array | array | 0x9a - array | array | 0x9b - array | array | 0x9f - map | object | 0xa0..0xb7 - map | object | 0xb8 - map | object | 0xb9 - map | object | 0xba - map | object | 0xbb - map | object | 0xbf - False | `false` | 0xf4 - True | `true` | 0xf5 - Nill | `null` | 0xf6 - Half-Precision Float | number_float | 0xf9 - Single-Precision Float | number_float | 0xfa - Double-Precision Float | number_float | 0xfb - - @warning The mapping is **incomplete** in the sense that not all CBOR - types can be converted to a JSON value. The following CBOR types - are not supported and will yield parse errors (parse_error.112): - - byte strings (0x40..0x5f) - - date/time (0xc0..0xc1) - - bignum (0xc2..0xc3) - - decimal fraction (0xc4) - - bigfloat (0xc5) - - tagged items (0xc6..0xd4, 0xd8..0xdb) - - expected conversions (0xd5..0xd7) - - simple values (0xe0..0xf3, 0xf8) - - undefined (0xf7) - - @warning CBOR allows map keys of any type, whereas JSON only allows - strings as keys in object values. Therefore, CBOR maps with keys - other than UTF-8 strings are rejected (parse_error.113). - - @note Any CBOR output created @ref to_cbor can be successfully parsed by - @ref from_cbor. - - @param[in] v a byte vector in CBOR format - @param[in] start_index the index to start reading from @a v (0 by default) - @return deserialized JSON value - - @throw parse_error.110 if the given vector ends prematurely - @throw parse_error.112 if unsupported features from CBOR were - used in the given vector @a v or if the input is not valid CBOR - @throw parse_error.113 if a string was expected as map key, but not found - - @complexity Linear in the size of the byte vector @a v. - - @liveexample{The example shows the deserialization of a byte vector in CBOR - format to a JSON value.,from_cbor} - - @sa http://cbor.io - @sa @ref to_cbor(const basic_json&) for the analogous serialization - @sa @ref from_msgpack(const std::vector&, const size_t) for the - related MessagePack format - - @since version 2.0.9, parameter @a start_index since 2.1.1 - */ - static basic_json from_cbor(const std::vector& v, - const size_t start_index = 0) - { - binary_reader br(input_adapter::create(v.begin() + static_cast(start_index), v.end())); - return br.parse_cbor(); - } - - - /*! - @brief create a JSON value from a byte vector in MessagePack format - - Deserializes a given byte vector @a v to a JSON value using the MessagePack - serialization format. - - The library maps MessagePack types to JSON value types as follows: - - MessagePack type | JSON value type | first byte - ---------------- | --------------- | ---------- - positive fixint | number_unsigned | 0x00..0x7f - fixmap | object | 0x80..0x8f - fixarray | array | 0x90..0x9f - fixstr | string | 0xa0..0xbf - nil | `null` | 0xc0 - false | `false` | 0xc2 - true | `true` | 0xc3 - float 32 | number_float | 0xca - float 64 | number_float | 0xcb - uint 8 | number_unsigned | 0xcc - uint 16 | number_unsigned | 0xcd - uint 32 | number_unsigned | 0xce - uint 64 | number_unsigned | 0xcf - int 8 | number_integer | 0xd0 - int 16 | number_integer | 0xd1 - int 32 | number_integer | 0xd2 - int 64 | number_integer | 0xd3 - str 8 | string | 0xd9 - str 16 | string | 0xda - str 32 | string | 0xdb - array 16 | array | 0xdc - array 32 | array | 0xdd - map 16 | object | 0xde - map 32 | object | 0xdf - negative fixint | number_integer | 0xe0-0xff - - @warning The mapping is **incomplete** in the sense that not all - MessagePack types can be converted to a JSON value. The following - MessagePack types are not supported and will yield parse errors: - - bin 8 - bin 32 (0xc4..0xc6) - - ext 8 - ext 32 (0xc7..0xc9) - - fixext 1 - fixext 16 (0xd4..0xd8) - - @note Any MessagePack output created @ref to_msgpack can be successfully - parsed by @ref from_msgpack. - - @param[in] v a byte vector in MessagePack format - @param[in] start_index the index to start reading from @a v (0 by default) - @return deserialized JSON value - - @throw parse_error.110 if the given vector ends prematurely - @throw parse_error.112 if unsupported features from MessagePack were - used in the given vector @a v or if the input is not valid MessagePack - @throw parse_error.113 if a string was expected as map key, but not found - - @complexity Linear in the size of the byte vector @a v. - - @liveexample{The example shows the deserialization of a byte vector in - MessagePack format to a JSON value.,from_msgpack} - - @sa http://msgpack.org - @sa @ref to_msgpack(const basic_json&) for the analogous serialization - @sa @ref from_cbor(const std::vector&, const size_t) for the - related CBOR format - - @since version 2.0.9, parameter @a start_index since 2.1.1 - */ - static basic_json from_msgpack(const std::vector& v, - const size_t start_index = 0) - { - binary_reader br(input_adapter::create(v.begin() + static_cast(start_index), v.end())); - return br.parse_msgpack(); - } - - /// @} - - ////////////////////// - // lexer and parser // - ////////////////////// - - private: - /*! - @brief lexical analysis - - This class organizes the lexical analysis during JSON deserialization. - */ - class lexer - { - public: - /// token types for the parser - enum class token_type - { - uninitialized, ///< indicating the scanner is uninitialized - literal_true, ///< the `true` literal - literal_false, ///< the `false` literal - literal_null, ///< the `null` literal - value_string, ///< a string -- use get_string() for actual value - value_unsigned, ///< an unsigned integer -- use get_number_unsigned() for actual value - value_integer, ///< a signed integer -- use get_number_integer() for actual value - value_float, ///< an floating point number -- use get_number_float() for actual value - begin_array, ///< the character for array begin `[` - begin_object, ///< the character for object begin `{` - end_array, ///< the character for array end `]` - end_object, ///< the character for object end `}` - name_separator, ///< the name separator `:` - value_separator, ///< the value separator `,` - parse_error, ///< indicating a parse error - end_of_input, ///< indicating the end of the input buffer - literal_or_value ///< a literal or the begin of a value (only for diagnostics) - }; - - /// return name of values of type token_type (only used for errors) - static const char* token_type_name(const token_type t) noexcept - { - switch (t) - { - case token_type::uninitialized: - return ""; - case token_type::literal_true: - return "true literal"; - case token_type::literal_false: - return "false literal"; - case token_type::literal_null: - return "null literal"; - case token_type::value_string: - return "string literal"; - case lexer::token_type::value_unsigned: - case lexer::token_type::value_integer: - case lexer::token_type::value_float: - return "number literal"; - case token_type::begin_array: - return "'['"; - case token_type::begin_object: - return "'{'"; - case token_type::end_array: - return "']'"; - case token_type::end_object: - return "'}'"; - case token_type::name_separator: - return "':'"; - case token_type::value_separator: - return "','"; - case token_type::parse_error: - return ""; - case token_type::end_of_input: - return "end of input"; - case token_type::literal_or_value: - return "'[', '{', or a literal"; - default: - { - // catch non-enum values - return "unknown token"; // LCOV_EXCL_LINE - } - } - } - - explicit lexer(input_adapter_t adapter) - : ia(adapter), decimal_point_char(get_decimal_point()) - {} - - // delete because of pointer members - lexer(const lexer&) = delete; - lexer& operator=(lexer&) = delete; - - private: - ///////////////////// - // locales - ///////////////////// - - /// return the locale-dependent decimal point - static char get_decimal_point() noexcept - { - const auto loc = localeconv(); - assert(loc != nullptr); - return (loc->decimal_point == nullptr) ? '.' : loc->decimal_point[0]; - } - - ///////////////////// - // scan functions - ///////////////////// - - /*! - @brief get codepoint from 4 hex characters following `\u` - - @return codepoint or -1 in case of an error (e.g. EOF or non-hex - character) - */ - int get_codepoint() - { - // this function only makes sense after reading `\u` - assert(current == 'u'); - int codepoint = 0; - - // byte 1: \uXxxx - switch (get()) - { - case '0': - break; - case '1': - codepoint += 0x1000; - break; - case '2': - codepoint += 0x2000; - break; - case '3': - codepoint += 0x3000; - break; - case '4': - codepoint += 0x4000; - break; - case '5': - codepoint += 0x5000; - break; - case '6': - codepoint += 0x6000; - break; - case '7': - codepoint += 0x7000; - break; - case '8': - codepoint += 0x8000; - break; - case '9': - codepoint += 0x9000; - break; - case 'A': - case 'a': - codepoint += 0xa000; - break; - case 'B': - case 'b': - codepoint += 0xb000; - break; - case 'C': - case 'c': - codepoint += 0xc000; - break; - case 'D': - case 'd': - codepoint += 0xd000; - break; - case 'E': - case 'e': - codepoint += 0xe000; - break; - case 'F': - case 'f': - codepoint += 0xf000; - break; - default: - return -1; - } - - // byte 2: \uxXxx - switch (get()) - { - case '0': - break; - case '1': - codepoint += 0x0100; - break; - case '2': - codepoint += 0x0200; - break; - case '3': - codepoint += 0x0300; - break; - case '4': - codepoint += 0x0400; - break; - case '5': - codepoint += 0x0500; - break; - case '6': - codepoint += 0x0600; - break; - case '7': - codepoint += 0x0700; - break; - case '8': - codepoint += 0x0800; - break; - case '9': - codepoint += 0x0900; - break; - case 'A': - case 'a': - codepoint += 0x0a00; - break; - case 'B': - case 'b': - codepoint += 0x0b00; - break; - case 'C': - case 'c': - codepoint += 0x0c00; - break; - case 'D': - case 'd': - codepoint += 0x0d00; - break; - case 'E': - case 'e': - codepoint += 0x0e00; - break; - case 'F': - case 'f': - codepoint += 0x0f00; - break; - default: - return -1; - } - - // byte 3: \uxxXx - switch (get()) - { - case '0': - break; - case '1': - codepoint += 0x0010; - break; - case '2': - codepoint += 0x0020; - break; - case '3': - codepoint += 0x0030; - break; - case '4': - codepoint += 0x0040; - break; - case '5': - codepoint += 0x0050; - break; - case '6': - codepoint += 0x0060; - break; - case '7': - codepoint += 0x0070; - break; - case '8': - codepoint += 0x0080; - break; - case '9': - codepoint += 0x0090; - break; - case 'A': - case 'a': - codepoint += 0x00a0; - break; - case 'B': - case 'b': - codepoint += 0x00b0; - break; - case 'C': - case 'c': - codepoint += 0x00c0; - break; - case 'D': - case 'd': - codepoint += 0x00d0; - break; - case 'E': - case 'e': - codepoint += 0x00e0; - break; - case 'F': - case 'f': - codepoint += 0x00f0; - break; - default: - return -1; - } - - // byte 4: \uxxxX - switch (get()) - { - case '0': - break; - case '1': - codepoint += 0x0001; - break; - case '2': - codepoint += 0x0002; - break; - case '3': - codepoint += 0x0003; - break; - case '4': - codepoint += 0x0004; - break; - case '5': - codepoint += 0x0005; - break; - case '6': - codepoint += 0x0006; - break; - case '7': - codepoint += 0x0007; - break; - case '8': - codepoint += 0x0008; - break; - case '9': - codepoint += 0x0009; - break; - case 'A': - case 'a': - codepoint += 0x000a; - break; - case 'B': - case 'b': - codepoint += 0x000b; - break; - case 'C': - case 'c': - codepoint += 0x000c; - break; - case 'D': - case 'd': - codepoint += 0x000d; - break; - case 'E': - case 'e': - codepoint += 0x000e; - break; - case 'F': - case 'f': - codepoint += 0x000f; - break; - default: - return -1; - } - - return codepoint; - } - - /*! - @brief scan a string literal - - This function scans a string according to Sect. 7 of RFC 7159. While - scanning, bytes are escaped and copied into buffer yytext. Then the - function returns successfully, yytext is null-terminated and yylen - contains the number of bytes in the string. - - @return token_type::value_string if string could be successfully - scanned, token_type::parse_error otherwise - - @note In case of errors, variable error_message contains a textual - description. - */ - token_type scan_string() - { - // reset yytext (ignore opening quote) - reset(); - - // we entered the function by reading an open quote - assert(current == '\"'); - - while (true) - { - // get next character - switch (get()) - { - // end of file while parsing string - case std::char_traits::eof(): - { - error_message = "invalid string: missing closing quote"; - return token_type::parse_error; - } - - // closing quote - case '\"': - { - // terminate yytext - add('\0'); - --yylen; - return token_type::value_string; - } - - // escapes - case '\\': - { - switch (get()) - { - // quotation mark - case '\"': - add('\"'); - break; - // reverse solidus - case '\\': - add('\\'); - break; - // solidus - case '/': - add('/'); - break; - // backspace - case 'b': - add('\b'); - break; - // form feed - case 'f': - add('\f'); - break; - // line feed - case 'n': - add('\n'); - break; - // carriage return - case 'r': - add('\r'); - break; - // tab - case 't': - add('\t'); - break; - - // unicode escapes - case 'u': - { - int codepoint; - int codepoint1 = get_codepoint(); - - if (JSON_UNLIKELY(codepoint1 == -1)) - { - error_message = "invalid string: '\\u' must be followed by 4 hex digits"; - return token_type::parse_error; - } - - // check if code point is a high surrogate - if (0xD800 <= codepoint1 and codepoint1 <= 0xDBFF) - { - // expect next \uxxxx entry - if (JSON_LIKELY(get() == '\\' and get() == 'u')) - { - const int codepoint2 = get_codepoint(); - - if (JSON_UNLIKELY(codepoint2 == -1)) - { - error_message = "invalid string: '\\u' must be followed by 4 hex digits"; - return token_type::parse_error; - } - - // check if codepoint2 is a low surrogate - if (JSON_LIKELY(0xDC00 <= codepoint2 and codepoint2 <= 0xDFFF)) - { - codepoint = - // high surrogate occupies the most significant 22 bits - (codepoint1 << 10) - // low surrogate occupies the least significant 15 bits - + codepoint2 - // there is still the 0xD800, 0xDC00 and 0x10000 noise - // in the result so we have to subtract with: - // (0xD800 << 10) + DC00 - 0x10000 = 0x35FDC00 - - 0x35FDC00; - } - else - { - error_message = "invalid string: surrogate U+DC00..U+DFFF must be followed by U+DC00..U+DFFF"; - return token_type::parse_error; - } - } - else - { - error_message = "invalid string: surrogate U+DC00..U+DFFF must be followed by U+DC00..U+DFFF"; - return token_type::parse_error; - } - } - else - { - if (JSON_UNLIKELY(0xDC00 <= codepoint1 and codepoint1 <= 0xDFFF)) - { - error_message = "invalid string: surrogate U+DC00..U+DFFF must follow U+D800..U+DBFF"; - return token_type::parse_error; - } - - // only work with first code point - codepoint = codepoint1; - } - - // result of the above calculation yields a proper codepoint - assert(0x00 <= codepoint and codepoint <= 0x10FFFF); - - // translate code point to bytes - if (codepoint < 0x80) - { - // 1-byte characters: 0xxxxxxx (ASCII) - add(codepoint); - } - else if (codepoint <= 0x7ff) - { - // 2-byte characters: 110xxxxx 10xxxxxx - add(0xC0 | (codepoint >> 6)); - add(0x80 | (codepoint & 0x3F)); - } - else if (codepoint <= 0xffff) - { - // 3-byte characters: 1110xxxx 10xxxxxx 10xxxxxx - add(0xE0 | (codepoint >> 12)); - add(0x80 | ((codepoint >> 6) & 0x3F)); - add(0x80 | (codepoint & 0x3F)); - } - else - { - // 4-byte characters: 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx - add(0xF0 | (codepoint >> 18)); - add(0x80 | ((codepoint >> 12) & 0x3F)); - add(0x80 | ((codepoint >> 6) & 0x3F)); - add(0x80 | (codepoint & 0x3F)); - } - - break; - } - - // other characters after escape - default: - error_message = "invalid string: forbidden character after backslash"; - return token_type::parse_error; - } - - break; - } - - // invalid control characters - case 0x00: - case 0x01: - case 0x02: - case 0x03: - case 0x04: - case 0x05: - case 0x06: - case 0x07: - case 0x08: - case 0x09: - case 0x0a: - case 0x0b: - case 0x0c: - case 0x0d: - case 0x0e: - case 0x0f: - case 0x10: - case 0x11: - case 0x12: - case 0x13: - case 0x14: - case 0x15: - case 0x16: - case 0x17: - case 0x18: - case 0x19: - case 0x1a: - case 0x1b: - case 0x1c: - case 0x1d: - case 0x1e: - case 0x1f: - { - error_message = "invalid string: control character must be escaped"; - return token_type::parse_error; - } - - // U+0020..U+007F (except U+0022 (quote) and U+005C (backspace)) - case 0x20: - case 0x21: - case 0x23: - case 0x24: - case 0x25: - case 0x26: - case 0x27: - case 0x28: - case 0x29: - case 0x2a: - case 0x2b: - case 0x2c: - case 0x2d: - case 0x2e: - case 0x2f: - case 0x30: - case 0x31: - case 0x32: - case 0x33: - case 0x34: - case 0x35: - case 0x36: - case 0x37: - case 0x38: - case 0x39: - case 0x3a: - case 0x3b: - case 0x3c: - case 0x3d: - case 0x3e: - case 0x3f: - case 0x40: - case 0x41: - case 0x42: - case 0x43: - case 0x44: - case 0x45: - case 0x46: - case 0x47: - case 0x48: - case 0x49: - case 0x4a: - case 0x4b: - case 0x4c: - case 0x4d: - case 0x4e: - case 0x4f: - case 0x50: - case 0x51: - case 0x52: - case 0x53: - case 0x54: - case 0x55: - case 0x56: - case 0x57: - case 0x58: - case 0x59: - case 0x5a: - case 0x5b: - case 0x5d: - case 0x5e: - case 0x5f: - case 0x60: - case 0x61: - case 0x62: - case 0x63: - case 0x64: - case 0x65: - case 0x66: - case 0x67: - case 0x68: - case 0x69: - case 0x6a: - case 0x6b: - case 0x6c: - case 0x6d: - case 0x6e: - case 0x6f: - case 0x70: - case 0x71: - case 0x72: - case 0x73: - case 0x74: - case 0x75: - case 0x76: - case 0x77: - case 0x78: - case 0x79: - case 0x7a: - case 0x7b: - case 0x7c: - case 0x7d: - case 0x7e: - case 0x7f: - { - add(current); - break; - } - - // U+0080..U+07FF: bytes C2..DF 80..BF - case 0xc2: - case 0xc3: - case 0xc4: - case 0xc5: - case 0xc6: - case 0xc7: - case 0xc8: - case 0xc9: - case 0xca: - case 0xcb: - case 0xcc: - case 0xcd: - case 0xce: - case 0xcf: - case 0xd0: - case 0xd1: - case 0xd2: - case 0xd3: - case 0xd4: - case 0xd5: - case 0xd6: - case 0xd7: - case 0xd8: - case 0xd9: - case 0xda: - case 0xdb: - case 0xdc: - case 0xdd: - case 0xde: - case 0xdf: - { - add(current); - get(); - if (JSON_LIKELY(0x80 <= current and current <= 0xbf)) - { - add(current); - continue; - } - - error_message = "invalid string: ill-formed UTF-8 byte"; - return token_type::parse_error; - } - - // U+0800..U+0FFF: bytes E0 A0..BF 80..BF - case 0xe0: - { - add(current); - get(); - if (JSON_LIKELY(0xa0 <= current and current <= 0xbf)) - { - add(current); - get(); - if (JSON_LIKELY(0x80 <= current and current <= 0xbf)) - { - add(current); - continue; - } - } - - error_message = "invalid string: ill-formed UTF-8 byte"; - return token_type::parse_error; - } - - // U+1000..U+CFFF: bytes E1..EC 80..BF 80..BF - // U+E000..U+FFFF: bytes EE..EF 80..BF 80..BF - case 0xe1: - case 0xe2: - case 0xe3: - case 0xe4: - case 0xe5: - case 0xe6: - case 0xe7: - case 0xe8: - case 0xe9: - case 0xea: - case 0xeb: - case 0xec: - case 0xee: - case 0xef: - { - add(current); - get(); - if (JSON_LIKELY(0x80 <= current and current <= 0xbf)) - { - add(current); - get(); - if (JSON_LIKELY(0x80 <= current and current <= 0xbf)) - { - add(current); - continue; - } - } - - error_message = "invalid string: ill-formed UTF-8 byte"; - return token_type::parse_error; - } - - // U+D000..U+D7FF: bytes ED 80..9F 80..BF - case 0xed: - { - add(current); - get(); - if (JSON_LIKELY(0x80 <= current and current <= 0x9f)) - { - add(current); - get(); - if (JSON_LIKELY(0x80 <= current and current <= 0xbf)) - { - add(current); - continue; - } - } - - error_message = "invalid string: ill-formed UTF-8 byte"; - return token_type::parse_error; - } - - // U+10000..U+3FFFF F0 90..BF 80..BF 80..BF - case 0xf0: - { - add(current); - get(); - if (JSON_LIKELY(0x90 <= current and current <= 0xbf)) - { - add(current); - get(); - if (JSON_LIKELY(0x80 <= current and current <= 0xbf)) - { - add(current); - get(); - if (JSON_LIKELY(0x80 <= current and current <= 0xbf)) - { - add(current); - continue; - } - } - } - - error_message = "invalid string: ill-formed UTF-8 byte"; - return token_type::parse_error; - } - - // U+40000..U+FFFFF F1..F3 80..BF 80..BF 80..BF - case 0xf1: - case 0xf2: - case 0xf3: - { - add(current); - get(); - if (JSON_LIKELY(0x80 <= current and current <= 0xbf)) - { - add(current); - get(); - if (JSON_LIKELY(0x80 <= current and current <= 0xbf)) - { - add(current); - get(); - if (JSON_LIKELY(0x80 <= current and current <= 0xbf)) - { - add(current); - continue; - } - } - } - - error_message = "invalid string: ill-formed UTF-8 byte"; - return token_type::parse_error; - } - - // U+100000..U+10FFFF F4 80..8F 80..BF 80..BF - case 0xf4: - { - add(current); - get(); - if (JSON_LIKELY(0x80 <= current and current <= 0x8f)) - { - add(current); - get(); - if (JSON_LIKELY(0x80 <= current and current <= 0xbf)) - { - add(current); - get(); - if (JSON_LIKELY(0x80 <= current and current <= 0xbf)) - { - add(current); - continue; - } - } - } - - error_message = "invalid string: ill-formed UTF-8 byte"; - return token_type::parse_error; - } - - // remaining bytes (80..C1 and F5..FF) are ill-formed - default: - { - error_message = "invalid string: ill-formed UTF-8 byte"; - return token_type::parse_error; - } - } - } - } - - static void strtof(float& f, const char* str, char** endptr) noexcept - { - f = std::strtof(str, endptr); - } - - static void strtof(double& f, const char* str, char** endptr) noexcept - { - f = std::strtod(str, endptr); - } - - static void strtof(long double& f, const char* str, char** endptr) noexcept - { - f = std::strtold(str, endptr); - } - - /*! - @brief scan a number literal - - This function scans a string according to Sect. 6 of RFC 7159. - - The function is realized with a deterministic finite state machine - derived from the grammar described in RFC 7159. Starting in state - "init", the input is read and used to determined the next state. Only - state "done" accepts the number. State "error" is a trap state to model - errors. In the table below, "anything" means any character but the ones - listed before. - - state | 0 | 1-9 | e E | + | - | . | anything - ---------|----------|----------|----------|---------|---------|----------|----------- - init | zero | any1 | [error] | [error] | minus | [error] | [error] - minus | zero | any1 | [error] | [error] | [error] | [error] | [error] - zero | done | done | exponent | done | done | decimal1 | done - any1 | any1 | any1 | exponent | done | done | decimal1 | done - decimal1 | decimal2 | [error] | [error] | [error] | [error] | [error] | [error] - decimal2 | decimal2 | decimal2 | exponent | done | done | done | done - exponent | any2 | any2 | [error] | sign | sign | [error] | [error] - sign | any2 | any2 | [error] | [error] | [error] | [error] | [error] - any2 | any2 | any2 | done | done | done | done | done - - The state machine is realized with one label per state (prefixed with - "scan_number_") and `goto` statements between them. The state machine - contains cycles, but any cycle can be left when EOF is read. Therefore, - the function is guaranteed to terminate. - - During scanning, the read bytes are stored in yytext. This string is - then converted to a signed integer, an unsigned integer, or a - floating-point number. - - @return token_type::value_unsigned, token_type::value_integer, or - token_type::value_float if number could be successfully scanned, - token_type::parse_error otherwise - - @note The scanner is independent of the current locale. Internally, the - locale's decimal point is used instead of `.` to work with the - locale-dependent converters. - */ - token_type scan_number() - { - // reset yytext to store the number's bytes - reset(); - - // the type of the parsed number; initially set to unsigned; will be - // changed if minus sign, decimal point or exponent is read - token_type number_type = token_type::value_unsigned; - - // state (init): we just found out we need to scan a number - switch (current) - { - case '-': - { - add(current); - goto scan_number_minus; - } - - case '0': - { - add(current); - goto scan_number_zero; - } - - case '1': - case '2': - case '3': - case '4': - case '5': - case '6': - case '7': - case '8': - case '9': - { - add(current); - goto scan_number_any1; - } - - default: - { - // all other characters are rejected outside scan_number() - assert(false); // LCOV_EXCL_LINE - } - } - -scan_number_minus: - // state: we just parsed a leading minus sign - number_type = token_type::value_integer; - switch (get()) - { - case '0': - { - add(current); - goto scan_number_zero; - } - - case '1': - case '2': - case '3': - case '4': - case '5': - case '6': - case '7': - case '8': - case '9': - { - add(current); - goto scan_number_any1; - } - - default: - { - error_message = "invalid number; expected digit after '-'"; - return token_type::parse_error; - } - } - -scan_number_zero: - // state: we just parse a zero (maybe with a leading minus sign) - switch (get()) - { - case '.': - { - add(decimal_point_char); - goto scan_number_decimal1; - } - - case 'e': - case 'E': - { - add(current); - goto scan_number_exponent; - } - - default: - { - goto scan_number_done; - } - } - -scan_number_any1: - // state: we just parsed a number 0-9 (maybe with a leading minus sign) - switch (get()) - { - case '0': - case '1': - case '2': - case '3': - case '4': - case '5': - case '6': - case '7': - case '8': - case '9': - { - add(current); - goto scan_number_any1; - } - - case '.': - { - add(decimal_point_char); - goto scan_number_decimal1; - } - - case 'e': - case 'E': - { - add(current); - goto scan_number_exponent; - } - - default: - { - goto scan_number_done; - } - } - -scan_number_decimal1: - // state: we just parsed a decimal point - number_type = token_type::value_float; - switch (get()) - { - case '0': - case '1': - case '2': - case '3': - case '4': - case '5': - case '6': - case '7': - case '8': - case '9': - { - add(current); - goto scan_number_decimal2; - } - - default: - { - error_message = "invalid number; expected digit after '.'"; - return token_type::parse_error; - } - } - -scan_number_decimal2: - // we just parsed at least one number after a decimal point - switch (get()) - { - case '0': - case '1': - case '2': - case '3': - case '4': - case '5': - case '6': - case '7': - case '8': - case '9': - { - add(current); - goto scan_number_decimal2; - } - - case 'e': - case 'E': - { - add(current); - goto scan_number_exponent; - } - - default: - { - goto scan_number_done; - } - } - -scan_number_exponent: - // we just parsed an exponent - number_type = token_type::value_float; - switch (get()) - { - case '+': - case '-': - { - add(current); - goto scan_number_sign; - } - - case '0': - case '1': - case '2': - case '3': - case '4': - case '5': - case '6': - case '7': - case '8': - case '9': - { - add(current); - goto scan_number_any2; - } - - default: - { - error_message = "invalid number; expected '+', '-', or digit after exponent"; - return token_type::parse_error; - } - } - -scan_number_sign: - // we just parsed an exponent sign - switch (get()) - { - case '0': - case '1': - case '2': - case '3': - case '4': - case '5': - case '6': - case '7': - case '8': - case '9': - { - add(current); - goto scan_number_any2; - } - - default: - { - error_message = "invalid number; expected digit after exponent sign"; - return token_type::parse_error; - } - } - -scan_number_any2: - // we just parsed a number after the exponent or exponent sign - switch (get()) - { - case '0': - case '1': - case '2': - case '3': - case '4': - case '5': - case '6': - case '7': - case '8': - case '9': - { - add(current); - goto scan_number_any2; - } - - default: - { - goto scan_number_done; - } - } - -scan_number_done: - // unget the character after the number (we only read it to know - // that we are done scanning a number) - --chars_read; - next_unget = true; - - // terminate token - add('\0'); - --yylen; - - // try to parse integers first and fall back to floats - if (number_type == token_type::value_unsigned) - { - char* endptr = nullptr; - errno = 0; - const auto x = std::strtoull(yytext.data(), &endptr, 10); - - // we checked the number format before - assert(endptr == yytext.data() + yylen); - - if (errno == 0) - { - value_unsigned = static_cast(x); - if (value_unsigned == x) - { - return token_type::value_unsigned; - } - } - } - else if (number_type == token_type::value_integer) - { - char* endptr = nullptr; - errno = 0; - const auto x = std::strtoll(yytext.data(), &endptr, 10); - - // we checked the number format before - assert(endptr == yytext.data() + yylen); - - if (errno == 0) - { - value_integer = static_cast(x); - if (value_integer == x) - { - return token_type::value_integer; - } - } - } - - // this code is reached if we parse a floating-point number or if - // an integer conversion above failed - strtof(value_float, yytext.data(), nullptr); - return token_type::value_float; - } - - /*! - @param[in] literal_text the literal text to expect - @param[in] length the length of the passed literal text - @param[in] return_type the token type to return on success - */ - token_type scan_literal(const char* literal_text, const size_t length, - token_type return_type) - { - assert(current == literal_text[0]); - for (size_t i = 1; i < length; ++i) - { - if (JSON_UNLIKELY(get() != literal_text[i])) - { - error_message = "invalid literal"; - return token_type::parse_error; - } - } - return return_type; - } - - ///////////////////// - // input management - ///////////////////// - - /// reset yytext - void reset() noexcept - { - yylen = 0; - start_pos = chars_read - 1; - } - - /// get a character from the input - int get() - { - ++chars_read; - return next_unget - ? (next_unget = false, current) - : (current = ia->get_character()); - } - - /// add a character to yytext - void add(int c) - { - // resize yytext if necessary; this condition is deemed unlikely, - // because we start with a 1024-byte buffer - if (JSON_UNLIKELY((yylen + 1 > yytext.capacity()))) - { - yytext.resize(2 * yytext.capacity(), '\0'); - } - assert(yylen < yytext.size()); - yytext[yylen++] = static_cast(c); - } - - public: - ///////////////////// - // value getters - ///////////////////// - - /// return integer value - constexpr number_integer_t get_number_integer() const noexcept - { - return value_integer; - } - - /// return unsigned integer value - constexpr number_unsigned_t get_number_unsigned() const noexcept - { - return value_unsigned; - } - - /// return floating-point value - constexpr number_float_t get_number_float() const noexcept - { - return value_float; - } - - /// return string value - const std::string get_string() - { - // yytext cannot be returned as char*, because it may contain a - // null byte (parsed as "\u0000") - return std::string(yytext.data(), yylen); - } - - ///////////////////// - // diagnostics - ///////////////////// - - /// return position of last read token - constexpr size_t get_position() const noexcept - { - return chars_read; - } - - /// return the last read token (for errors only) - std::string get_token_string() const - { - // get the raw byte sequence of the last token - std::string s = ia->read(start_pos, chars_read - start_pos); - - // escape control characters - std::string result; - for (auto c : s) - { - if (c == '\0' or c == std::char_traits::eof()) - { - // ignore EOF - continue; - } - else if ('\x00' <= c and c <= '\x1f') - { - // escape control characters - std::stringstream ss; - ss << "(c) << ">"; - result += ss.str(); - } - else - { - // add character as is - result.append(1, c); - } - } - - return result; - } - - /// return syntax error message - constexpr const char* get_error_message() const noexcept - { - return error_message; - } - - ///////////////////// - // actual scanner - ///////////////////// - - token_type scan() - { - // read next character and ignore whitespace - do - { - get(); - } - while (current == ' ' or current == '\t' or current == '\n' or current == '\r'); - - switch (current) - { - // structural characters - case '[': - return token_type::begin_array; - case ']': - return token_type::end_array; - case '{': - return token_type::begin_object; - case '}': - return token_type::end_object; - case ':': - return token_type::name_separator; - case ',': - return token_type::value_separator; - - // literals - case 't': - return scan_literal("true", 4, token_type::literal_true); - case 'f': - return scan_literal("false", 5, token_type::literal_false); - case 'n': - return scan_literal("null", 4, token_type::literal_null); - - // string - case '\"': - return scan_string(); - - // number - case '-': - case '0': - case '1': - case '2': - case '3': - case '4': - case '5': - case '6': - case '7': - case '8': - case '9': - return scan_number(); - - // end of input (the null byte is needed when parsing from - // string literals) - case '\0': - case std::char_traits::eof(): - return token_type::end_of_input; - - // error - default: - error_message = "invalid literal"; - return token_type::parse_error; - } - } - - private: - /// input adapter - input_adapter_t ia = nullptr; - - /// the current character - int current = std::char_traits::eof(); - - /// whether get() should return the last character again - bool next_unget = false; - - /// the number of characters read - size_t chars_read = 0; - /// the start position of the current token - size_t start_pos = 0; - - /// buffer for variable-length tokens (numbers, strings) - std::vector yytext = std::vector(1024, '\0'); - /// current index in yytext - size_t yylen = 0; - - /// a description of occurred lexer errors - const char* error_message = ""; - - // number values - number_integer_t value_integer = 0; - number_unsigned_t value_unsigned = 0; - number_float_t value_float = 0; - - /// the decimal point - const char decimal_point_char = '.'; - }; - - /*! - @brief syntax analysis - - This class implements a recursive decent parser. - */ - class parser - { - public: - /// a parser reading from an input adapter - explicit parser(input_adapter_t adapter, - const parser_callback_t cb = nullptr) - : callback(cb), m_lexer(adapter) - {} - - /*! - @brief public parser interface - - @param[in] strict whether to expect the last token to be EOF - @return parsed JSON value - - @throw parse_error.101 in case of an unexpected token - @throw parse_error.102 if to_unicode fails or surrogate error - @throw parse_error.103 if to_unicode fails - */ - basic_json parse(const bool strict = true) - { - // read first token - get_token(); - - basic_json result = parse_internal(true); - result.assert_invariant(); - - if (strict) - { - get_token(); - expect(lexer::token_type::end_of_input); - } - - // return parser result and replace it with null in case the - // top-level value was discarded by the callback function - return result.is_discarded() ? basic_json() : std::move(result); - } - - /*! - @brief public accept interface - - @param[in] strict whether to expect the last token to be EOF - @return whether the input is a proper JSON text - */ - bool accept(const bool strict = true) - { - // read first token - get_token(); - - if (not accept_internal()) - { - return false; - } - - if (strict and get_token() != lexer::token_type::end_of_input) - { - return false; - } - - return true; - } - - private: - /*! - @brief the actual parser - @throw parse_error.101 in case of an unexpected token - @throw parse_error.102 if to_unicode fails or surrogate error - @throw parse_error.103 if to_unicode fails - */ - basic_json parse_internal(bool keep) - { - auto result = basic_json(value_t::discarded); - - switch (last_token) - { - case lexer::token_type::begin_object: - { - if (keep and (not callback - or ((keep = callback(depth++, parse_event_t::object_start, result)) != 0))) - { - // explicitly set result to object to cope with {} - result.m_type = value_t::object; - result.m_value = value_t::object; - } - - // read next token - get_token(); - - // closing } -> we are done - if (last_token == lexer::token_type::end_object) - { - if (keep and callback and not callback(--depth, parse_event_t::object_end, result)) - { - result = basic_json(value_t::discarded); - } - return result; - } - - // parse values - while (true) - { - // store key - expect(lexer::token_type::value_string); - const auto key = m_lexer.get_string(); - - bool keep_tag = false; - if (keep) - { - if (callback) - { - basic_json k(key); - keep_tag = callback(depth, parse_event_t::key, k); - } - else - { - keep_tag = true; - } - } - - // parse separator (:) - get_token(); - expect(lexer::token_type::name_separator); - - // parse and add value - get_token(); - auto value = parse_internal(keep); - if (keep and keep_tag and not value.is_discarded()) - { - result[key] = std::move(value); - } - - // comma -> next value - get_token(); - if (last_token == lexer::token_type::value_separator) - { - get_token(); - continue; - } - - // closing } - expect(lexer::token_type::end_object); - break; - } - - if (keep and callback and not callback(--depth, parse_event_t::object_end, result)) - { - result = basic_json(value_t::discarded); - } - - return result; - } - - case lexer::token_type::begin_array: - { - if (keep and (not callback - or ((keep = callback(depth++, parse_event_t::array_start, result)) != 0))) - { - // explicitly set result to object to cope with [] - result.m_type = value_t::array; - result.m_value = value_t::array; - } - - // read next token - get_token(); - - // closing ] -> we are done - if (last_token == lexer::token_type::end_array) - { - if (callback and not callback(--depth, parse_event_t::array_end, result)) - { - result = basic_json(value_t::discarded); - } - return result; - } - - // parse values - while (true) - { - // parse value - auto value = parse_internal(keep); - if (keep and not value.is_discarded()) - { - result.push_back(std::move(value)); - } - - // comma -> next value - get_token(); - if (last_token == lexer::token_type::value_separator) - { - get_token(); - continue; - } - - // closing ] - expect(lexer::token_type::end_array); - break; - } - - if (keep and callback and not callback(--depth, parse_event_t::array_end, result)) - { - result = basic_json(value_t::discarded); - } - - return result; - } - - case lexer::token_type::literal_null: - { - result.m_type = value_t::null; - break; - } - - case lexer::token_type::value_string: - { - result = basic_json(m_lexer.get_string()); - break; - } - - case lexer::token_type::literal_true: - { - result.m_type = value_t::boolean; - result.m_value = true; - break; - } - - case lexer::token_type::literal_false: - { - result.m_type = value_t::boolean; - result.m_value = false; - break; - } - - case lexer::token_type::value_unsigned: - { - result.m_type = value_t::number_unsigned; - result.m_value = m_lexer.get_number_unsigned(); - break; - } - - case lexer::token_type::value_integer: - { - result.m_type = value_t::number_integer; - result.m_value = m_lexer.get_number_integer(); - break; - } - - case lexer::token_type::value_float: - { - result.m_type = value_t::number_float; - result.m_value = m_lexer.get_number_float(); - - // throw in case of infinity or NAN - if (JSON_UNLIKELY(not std::isfinite(result.m_value.number_float))) - { - JSON_THROW(out_of_range::create(406, "number overflow parsing '" + m_lexer.get_token_string() + "'")); - } - - break; - } - - case lexer::token_type::parse_error: - { - // using "uninitialized" to avoid "expected" message - expect(lexer::token_type::uninitialized); - break; // LCOV_EXCL_LINE - } - - default: - { - // the last token was unexpected; we expected a value - expect(lexer::token_type::literal_or_value); - break; // LCOV_EXCL_LINE - } - } - - if (keep and callback and not callback(depth, parse_event_t::value, result)) - { - result = basic_json(value_t::discarded); - } - return result; - } - - /*! - @brief the acutal acceptor - - @invariant 1. The last token is not yet processed. Therefore, the - caller of this function must make sure a token has - been read. - 2. When this function returns, the last token is processed. - That is, the last read character was already considered. - - This invariant makes sure that no token needs to be "unput". - */ - bool accept_internal() - { - switch (last_token) - { - case lexer::token_type::begin_object: - { - // read next token - get_token(); - - // closing } -> we are done - if (last_token == lexer::token_type::end_object) - { - return true; - } - - // parse values - while (true) - { - // parse key - if (last_token != lexer::token_type::value_string) - { - return false; - } - - // parse separator (:) - get_token(); - if (last_token != lexer::token_type::name_separator) - { - return false; - } - - // parse value - get_token(); - if (not accept_internal()) - { - return false; - } - - // comma -> next value - get_token(); - if (last_token == lexer::token_type::value_separator) - { - get_token(); - continue; - } - - // closing } - if (last_token != lexer::token_type::end_object) - { - return false; - } - - return true; - } - } - - case lexer::token_type::begin_array: - { - // read next token - get_token(); - - // closing ] -> we are done - if (last_token == lexer::token_type::end_array) - { - return true; - } - - // parse values - while (true) - { - // parse value - if (not accept_internal()) - { - return false; - } - - // comma -> next value - get_token(); - if (last_token == lexer::token_type::value_separator) - { - get_token(); - continue; - } - - // closing ] - if (last_token != lexer::token_type::end_array) - { - return false; - } - - return true; - } - } - - case lexer::token_type::literal_false: - case lexer::token_type::literal_null: - case lexer::token_type::literal_true: - case lexer::token_type::value_float: - case lexer::token_type::value_integer: - case lexer::token_type::value_string: - case lexer::token_type::value_unsigned: - { - return true; - } - - default: - { - // the last token was unexpected - return false; - } - } - } - - /// get next token from lexer - typename lexer::token_type get_token() - { - return (last_token = m_lexer.scan()); - } - - /*! - @throw parse_error.101 if expected token did not occur - */ - void expect(typename lexer::token_type t) - { - if (JSON_UNLIKELY(t != last_token)) - { - errored = true; - expected = t; - throw_exception(); - } - } - - [[noreturn]] void throw_exception() const - { - std::string error_msg = "syntax error - "; - if (last_token == lexer::token_type::parse_error) - { - error_msg += std::string(m_lexer.get_error_message()) + "; last read: '" + m_lexer.get_token_string() + "'"; - } - else - { - error_msg += "unexpected " + std::string(lexer::token_type_name(last_token)); - } - - if (expected != lexer::token_type::uninitialized) - { - error_msg += "; expected " + std::string(lexer::token_type_name(expected)); - } - - JSON_THROW(parse_error::create(101, m_lexer.get_position(), error_msg)); - } - - private: - /// current level of recursion - int depth = 0; - /// callback function - const parser_callback_t callback = nullptr; - /// the type of the last read token - typename lexer::token_type last_token = lexer::token_type::uninitialized; - /// the lexer - lexer m_lexer; - /// whether a syntax error occurred - bool errored = false; - /// possible reason for the syntax error - typename lexer::token_type expected = lexer::token_type::uninitialized; - }; - - public: - /*! - @brief JSON Pointer - - A JSON pointer defines a string syntax for identifying a specific value - within a JSON document. It can be used with functions `at` and - `operator[]`. Furthermore, JSON pointers are the base for JSON patches. - - @sa [RFC 6901](https://tools.ietf.org/html/rfc6901) - - @since version 2.0.0 - */ - class json_pointer - { - /// allow basic_json to access private members - friend class basic_json; - - public: - /*! - @brief create JSON pointer - - Create a JSON pointer according to the syntax described in - [Section 3 of RFC6901](https://tools.ietf.org/html/rfc6901#section-3). - - @param[in] s string representing the JSON pointer; if omitted, the - empty string is assumed which references the whole JSON - value - - @throw parse_error.107 if the given JSON pointer @a s is nonempty and - does not begin with a slash (`/`); see example below - - @throw parse_error.108 if a tilde (`~`) in the given JSON pointer @a s - is not followed by `0` (representing `~`) or `1` (representing `/`); - see example below - - @liveexample{The example shows the construction several valid JSON - pointers as well as the exceptional behavior.,json_pointer} - - @since version 2.0.0 - */ - explicit json_pointer(const std::string& s = "") - : reference_tokens(split(s)) - {} - - /*! - @brief return a string representation of the JSON pointer - - @invariant For each JSON pointer `ptr`, it holds: - @code {.cpp} - ptr == json_pointer(ptr.to_string()); - @endcode - - @return a string representation of the JSON pointer - - @liveexample{The example shows the result of `to_string`., - json_pointer__to_string} - - @since version 2.0.0 - */ - std::string to_string() const noexcept - { - return std::accumulate(reference_tokens.begin(), - reference_tokens.end(), std::string{}, - [](const std::string & a, const std::string & b) - { - return a + "/" + escape(b); - }); - } - - /// @copydoc to_string() - operator std::string() const - { - return to_string(); - } - - private: - /*! - @brief remove and return last reference pointer - @throw out_of_range.405 if JSON pointer has no parent - */ - std::string pop_back() - { - if (is_root()) - { - JSON_THROW(out_of_range::create(405, "JSON pointer has no parent")); - } - - auto last = reference_tokens.back(); - reference_tokens.pop_back(); - return last; - } - - /// return whether pointer points to the root document - bool is_root() const - { - return reference_tokens.empty(); - } - - json_pointer top() const - { - if (is_root()) - { - JSON_THROW(out_of_range::create(405, "JSON pointer has no parent")); - } - - json_pointer result = *this; - result.reference_tokens = {reference_tokens[0]}; - return result; - } - - /*! - @brief create and return a reference to the pointed to value - - @complexity Linear in the number of reference tokens. - - @throw parse_error.109 if array index is not a number - @throw type_error.313 if value cannot be unflattened - */ - reference get_and_create(reference j) const - { - pointer result = &j; - - // in case no reference tokens exist, return a reference to the - // JSON value j which will be overwritten by a primitive value - for (const auto& reference_token : reference_tokens) - { - switch (result->m_type) - { - case value_t::null: - { - if (reference_token == "0") - { - // start a new array if reference token is 0 - result = &result->operator[](0); - } - else - { - // start a new object otherwise - result = &result->operator[](reference_token); - } - break; - } - - case value_t::object: - { - // create an entry in the object - result = &result->operator[](reference_token); - break; - } - - case value_t::array: - { - // create an entry in the array - JSON_TRY - { - result = &result->operator[](static_cast(std::stoi(reference_token))); - } - JSON_CATCH (std::invalid_argument&) - { - JSON_THROW(parse_error::create(109, 0, "array index '" + reference_token + "' is not a number")); - } - break; - } - - /* - The following code is only reached if there exists a - reference token _and_ the current value is primitive. In - this case, we have an error situation, because primitive - values may only occur as single value; that is, with an - empty list of reference tokens. - */ - default: - { - JSON_THROW(type_error::create(313, "invalid value to unflatten")); - } - } - } - - return *result; - } - - /*! - @brief return a reference to the pointed to value - - @note This version does not throw if a value is not present, but tries - to create nested values instead. For instance, calling this function - with pointer `"/this/that"` on a null value is equivalent to calling - `operator[]("this").operator[]("that")` on that value, effectively - changing the null value to an object. - - @param[in] ptr a JSON value - - @return reference to the JSON value pointed to by the JSON pointer - - @complexity Linear in the length of the JSON pointer. - - @throw parse_error.106 if an array index begins with '0' - @throw parse_error.109 if an array index was not a number - @throw out_of_range.404 if the JSON pointer can not be resolved - */ - reference get_unchecked(pointer ptr) const - { - for (const auto& reference_token : reference_tokens) - { - // convert null values to arrays or objects before continuing - if (ptr->m_type == value_t::null) - { - // check if reference token is a number - const bool nums = std::all_of(reference_token.begin(), - reference_token.end(), - [](const char x) - { - return (x >= '0' and x <= '9'); - }); - - // change value to array for numbers or "-" or to object - // otherwise - if (nums or reference_token == "-") - { - *ptr = value_t::array; - } - else - { - *ptr = value_t::object; - } - } - - switch (ptr->m_type) - { - case value_t::object: - { - // use unchecked object access - ptr = &ptr->operator[](reference_token); - break; - } - - case value_t::array: - { - // error condition (cf. RFC 6901, Sect. 4) - if (reference_token.size() > 1 and reference_token[0] == '0') - { - JSON_THROW(parse_error::create(106, 0, "array index '" + reference_token + "' must not begin with '0'")); - } - - if (reference_token == "-") - { - // explicitly treat "-" as index beyond the end - ptr = &ptr->operator[](ptr->m_value.array->size()); - } - else - { - // convert array index to number; unchecked access - JSON_TRY - { - ptr = &ptr->operator[](static_cast(std::stoi(reference_token))); - } - JSON_CATCH (std::invalid_argument&) - { - JSON_THROW(parse_error::create(109, 0, "array index '" + reference_token + "' is not a number")); - } - } - break; - } - - default: - { - JSON_THROW(out_of_range::create(404, "unresolved reference token '" + reference_token + "'")); - } - } - } - - return *ptr; - } - - /*! - @throw parse_error.106 if an array index begins with '0' - @throw parse_error.109 if an array index was not a number - @throw out_of_range.402 if the array index '-' is used - @throw out_of_range.404 if the JSON pointer can not be resolved - */ - reference get_checked(pointer ptr) const - { - for (const auto& reference_token : reference_tokens) - { - switch (ptr->m_type) - { - case value_t::object: - { - // note: at performs range check - ptr = &ptr->at(reference_token); - break; - } - - case value_t::array: - { - if (reference_token == "-") - { - // "-" always fails the range check - JSON_THROW(out_of_range::create(402, "array index '-' (" + - std::to_string(ptr->m_value.array->size()) + - ") is out of range")); - } - - // error condition (cf. RFC 6901, Sect. 4) - if (reference_token.size() > 1 and reference_token[0] == '0') - { - JSON_THROW(parse_error::create(106, 0, "array index '" + reference_token + "' must not begin with '0'")); - } - - // note: at performs range check - JSON_TRY - { - ptr = &ptr->at(static_cast(std::stoi(reference_token))); - } - JSON_CATCH (std::invalid_argument&) - { - JSON_THROW(parse_error::create(109, 0, "array index '" + reference_token + "' is not a number")); - } - break; - } - - default: - { - JSON_THROW(out_of_range::create(404, "unresolved reference token '" + reference_token + "'")); - } - } - } - - return *ptr; - } - - /*! - @brief return a const reference to the pointed to value - - @param[in] ptr a JSON value - - @return const reference to the JSON value pointed to by the JSON - pointer - - @throw parse_error.106 if an array index begins with '0' - @throw parse_error.109 if an array index was not a number - @throw out_of_range.402 if the array index '-' is used - @throw out_of_range.404 if the JSON pointer can not be resolved - */ - const_reference get_unchecked(const_pointer ptr) const - { - for (const auto& reference_token : reference_tokens) - { - switch (ptr->m_type) - { - case value_t::object: - { - // use unchecked object access - ptr = &ptr->operator[](reference_token); - break; - } - - case value_t::array: - { - if (reference_token == "-") - { - // "-" cannot be used for const access - JSON_THROW(out_of_range::create(402, "array index '-' (" + - std::to_string(ptr->m_value.array->size()) + - ") is out of range")); - } - - // error condition (cf. RFC 6901, Sect. 4) - if (reference_token.size() > 1 and reference_token[0] == '0') - { - JSON_THROW(parse_error::create(106, 0, "array index '" + reference_token + "' must not begin with '0'")); - } - - // use unchecked array access - JSON_TRY - { - ptr = &ptr->operator[](static_cast(std::stoi(reference_token))); - } - JSON_CATCH (std::invalid_argument&) - { - JSON_THROW(parse_error::create(109, 0, "array index '" + reference_token + "' is not a number")); - } - break; - } - - default: - { - JSON_THROW(out_of_range::create(404, "unresolved reference token '" + reference_token + "'")); - } - } - } - - return *ptr; - } - - /*! - @throw parse_error.106 if an array index begins with '0' - @throw parse_error.109 if an array index was not a number - @throw out_of_range.402 if the array index '-' is used - @throw out_of_range.404 if the JSON pointer can not be resolved - */ - const_reference get_checked(const_pointer ptr) const - { - for (const auto& reference_token : reference_tokens) - { - switch (ptr->m_type) - { - case value_t::object: - { - // note: at performs range check - ptr = &ptr->at(reference_token); - break; - } - - case value_t::array: - { - if (reference_token == "-") - { - // "-" always fails the range check - JSON_THROW(out_of_range::create(402, "array index '-' (" + - std::to_string(ptr->m_value.array->size()) + - ") is out of range")); - } - - // error condition (cf. RFC 6901, Sect. 4) - if (reference_token.size() > 1 and reference_token[0] == '0') - { - JSON_THROW(parse_error::create(106, 0, "array index '" + reference_token + "' must not begin with '0'")); - } - - // note: at performs range check - JSON_TRY - { - ptr = &ptr->at(static_cast(std::stoi(reference_token))); - } - JSON_CATCH (std::invalid_argument&) - { - JSON_THROW(parse_error::create(109, 0, "array index '" + reference_token + "' is not a number")); - } - break; - } - - default: - { - JSON_THROW(out_of_range::create(404, "unresolved reference token '" + reference_token + "'")); - } - } - } - - return *ptr; - } - - /*! - @brief split the string input to reference tokens - - @note This function is only called by the json_pointer constructor. - All exceptions below are documented there. - - @throw parse_error.107 if the pointer is not empty or begins with '/' - @throw parse_error.108 if character '~' is not followed by '0' or '1' - */ - static std::vector split(const std::string& reference_string) - { - std::vector result; - - // special case: empty reference string -> no reference tokens - if (reference_string.empty()) - { - return result; - } - - // check if nonempty reference string begins with slash - if (reference_string[0] != '/') - { - JSON_THROW(parse_error::create(107, 1, "JSON pointer must be empty or begin with '/' - was: '" + reference_string + "'")); - } - - // extract the reference tokens: - // - slash: position of the last read slash (or end of string) - // - start: position after the previous slash - for ( - // search for the first slash after the first character - size_t slash = reference_string.find_first_of('/', 1), - // set the beginning of the first reference token - start = 1; - // we can stop if start == string::npos+1 = 0 - start != 0; - // set the beginning of the next reference token - // (will eventually be 0 if slash == std::string::npos) - start = slash + 1, - // find next slash - slash = reference_string.find_first_of('/', start)) - { - // use the text between the beginning of the reference token - // (start) and the last slash (slash). - auto reference_token = reference_string.substr(start, slash - start); - - // check reference tokens are properly escaped - for (size_t pos = reference_token.find_first_of('~'); - pos != std::string::npos; - pos = reference_token.find_first_of('~', pos + 1)) - { - assert(reference_token[pos] == '~'); - - // ~ must be followed by 0 or 1 - if (pos == reference_token.size() - 1 or - (reference_token[pos + 1] != '0' and - reference_token[pos + 1] != '1')) - { - JSON_THROW(parse_error::create(108, 0, "escape character '~' must be followed with '0' or '1'")); - } - } - - // finally, store the reference token - unescape(reference_token); - result.push_back(reference_token); - } - - return result; - } - - /*! - @brief replace all occurrences of a substring by another string - - @param[in,out] s the string to manipulate; changed so that all - occurrences of @a f are replaced with @a t - @param[in] f the substring to replace with @a t - @param[in] t the string to replace @a f - - @pre The search string @a f must not be empty. **This precondition is - enforced with an assertion.** - - @since version 2.0.0 - */ - static void replace_substring(std::string& s, - const std::string& f, - const std::string& t) - { - assert(not f.empty()); - - for ( - size_t pos = s.find(f); // find first occurrence of f - pos != std::string::npos; // make sure f was found - s.replace(pos, f.size(), t), // replace with t - pos = s.find(f, pos + t.size()) // find next occurrence of f - ); - } - - /// escape tilde and slash - static std::string escape(std::string s) - { - // escape "~"" to "~0" and "/" to "~1" - replace_substring(s, "~", "~0"); - replace_substring(s, "/", "~1"); - return s; - } - - /// unescape tilde and slash - static void unescape(std::string& s) - { - // first transform any occurrence of the sequence '~1' to '/' - replace_substring(s, "~1", "/"); - // then transform any occurrence of the sequence '~0' to '~' - replace_substring(s, "~0", "~"); - } - - /*! - @param[in] reference_string the reference string to the current value - @param[in] value the value to consider - @param[in,out] result the result object to insert values to - - @note Empty objects or arrays are flattened to `null`. - */ - static void flatten(const std::string& reference_string, - const basic_json& value, - basic_json& result) - { - switch (value.m_type) - { - case value_t::array: - { - if (value.m_value.array->empty()) - { - // flatten empty array as null - result[reference_string] = nullptr; - } - else - { - // iterate array and use index as reference string - for (size_t i = 0; i < value.m_value.array->size(); ++i) - { - flatten(reference_string + "/" + std::to_string(i), - value.m_value.array->operator[](i), result); - } - } - break; - } - - case value_t::object: - { - if (value.m_value.object->empty()) - { - // flatten empty object as null - result[reference_string] = nullptr; - } - else - { - // iterate object and use keys as reference string - for (const auto& element : *value.m_value.object) - { - flatten(reference_string + "/" + escape(element.first), - element.second, result); - } - } - break; - } - - default: - { - // add primitive value with its reference string - result[reference_string] = value; - break; - } - } - } - - /*! - @param[in] value flattened JSON - - @return unflattened JSON - - @throw parse_error.109 if array index is not a number - @throw type_error.314 if value is not an object - @throw type_error.315 if object values are not primitive - @throw type_error.313 if value cannot be unflattened - */ - static basic_json unflatten(const basic_json& value) - { - if (not value.is_object()) - { - JSON_THROW(type_error::create(314, "only objects can be unflattened")); - } - - basic_json result; - - // iterate the JSON object values - for (const auto& element : *value.m_value.object) - { - if (not element.second.is_primitive()) - { - JSON_THROW(type_error::create(315, "values in object must be primitive")); - } - - // assign value to reference pointed to by JSON pointer; Note - // that if the JSON pointer is "" (i.e., points to the whole - // value), function get_and_create returns a reference to - // result itself. An assignment will then create a primitive - // value. - json_pointer(element.first).get_and_create(result) = element.second; - } - - return result; - } - - friend bool operator==(json_pointer const& lhs, - json_pointer const& rhs) noexcept - { - return lhs.reference_tokens == rhs.reference_tokens; - } - - friend bool operator!=(json_pointer const& lhs, - json_pointer const& rhs) noexcept - { - return !(lhs == rhs); - } - - /// the reference tokens - std::vector reference_tokens {}; - }; - - ////////////////////////// - // JSON Pointer support // - ////////////////////////// - - /// @name JSON Pointer functions - /// @{ - - /*! - @brief access specified element via JSON Pointer - - Uses a JSON pointer to retrieve a reference to the respective JSON value. - No bound checking is performed. Similar to @ref operator[](const typename - object_t::key_type&), `null` values are created in arrays and objects if - necessary. - - In particular: - - If the JSON pointer points to an object key that does not exist, it - is created an filled with a `null` value before a reference to it - is returned. - - If the JSON pointer points to an array index that does not exist, it - is created an filled with a `null` value before a reference to it - is returned. All indices between the current maximum and the given - index are also filled with `null`. - - The special value `-` is treated as a synonym for the index past the - end. - - @param[in] ptr a JSON pointer - - @return reference to the element pointed to by @a ptr - - @complexity Constant. - - @throw parse_error.106 if an array index begins with '0' - @throw parse_error.109 if an array index was not a number - @throw out_of_range.404 if the JSON pointer can not be resolved - - @liveexample{The behavior is shown in the example.,operatorjson_pointer} - - @since version 2.0.0 - */ - reference operator[](const json_pointer& ptr) - { - return ptr.get_unchecked(this); - } - - /*! - @brief access specified element via JSON Pointer - - Uses a JSON pointer to retrieve a reference to the respective JSON value. - No bound checking is performed. The function does not change the JSON - value; no `null` values are created. In particular, the the special value - `-` yields an exception. - - @param[in] ptr JSON pointer to the desired element - - @return const reference to the element pointed to by @a ptr - - @complexity Constant. - - @throw parse_error.106 if an array index begins with '0' - @throw parse_error.109 if an array index was not a number - @throw out_of_range.402 if the array index '-' is used - @throw out_of_range.404 if the JSON pointer can not be resolved - - @liveexample{The behavior is shown in the example.,operatorjson_pointer_const} - - @since version 2.0.0 - */ - const_reference operator[](const json_pointer& ptr) const - { - return ptr.get_unchecked(this); - } - - /*! - @brief access specified element via JSON Pointer - - Returns a reference to the element at with specified JSON pointer @a ptr, - with bounds checking. - - @param[in] ptr JSON pointer to the desired element - - @return reference to the element pointed to by @a ptr - - @throw parse_error.106 if an array index in the passed JSON pointer @a ptr - begins with '0'. See example below. - - @throw parse_error.109 if an array index in the passed JSON pointer @a ptr - is not a number. See example below. - - @throw out_of_range.401 if an array index in the passed JSON pointer @a ptr - is out of range. See example below. - - @throw out_of_range.402 if the array index '-' is used in the passed JSON - pointer @a ptr. As `at` provides checked access (and no elements are - implicitly inserted), the index '-' is always invalid. See example below. - - @throw out_of_range.404 if the JSON pointer @a ptr can not be resolved. - See example below. - - @exceptionsafety Strong guarantee: if an exception is thrown, there are no - changes in the JSON value. - - @complexity Constant. - - @since version 2.0.0 - - @liveexample{The behavior is shown in the example.,at_json_pointer} - */ - reference at(const json_pointer& ptr) - { - return ptr.get_checked(this); - } - - /*! - @brief access specified element via JSON Pointer - - Returns a const reference to the element at with specified JSON pointer @a - ptr, with bounds checking. - - @param[in] ptr JSON pointer to the desired element - - @return reference to the element pointed to by @a ptr - - @throw parse_error.106 if an array index in the passed JSON pointer @a ptr - begins with '0'. See example below. - - @throw parse_error.109 if an array index in the passed JSON pointer @a ptr - is not a number. See example below. - - @throw out_of_range.401 if an array index in the passed JSON pointer @a ptr - is out of range. See example below. - - @throw out_of_range.402 if the array index '-' is used in the passed JSON - pointer @a ptr. As `at` provides checked access (and no elements are - implicitly inserted), the index '-' is always invalid. See example below. - - @throw out_of_range.404 if the JSON pointer @a ptr can not be resolved. - See example below. - - @exceptionsafety Strong guarantee: if an exception is thrown, there are no - changes in the JSON value. - - @complexity Constant. - - @since version 2.0.0 - - @liveexample{The behavior is shown in the example.,at_json_pointer_const} - */ - const_reference at(const json_pointer& ptr) const - { - return ptr.get_checked(this); - } - - /*! - @brief return flattened JSON value - - The function creates a JSON object whose keys are JSON pointers (see [RFC - 6901](https://tools.ietf.org/html/rfc6901)) and whose values are all - primitive. The original JSON value can be restored using the @ref - unflatten() function. - - @return an object that maps JSON pointers to primitive values - - @note Empty objects and arrays are flattened to `null` and will not be - reconstructed correctly by the @ref unflatten() function. - - @complexity Linear in the size the JSON value. - - @liveexample{The following code shows how a JSON object is flattened to an - object whose keys consist of JSON pointers.,flatten} - - @sa @ref unflatten() for the reverse function - - @since version 2.0.0 - */ - basic_json flatten() const - { - basic_json result(value_t::object); - json_pointer::flatten("", *this, result); - return result; - } - - /*! - @brief unflatten a previously flattened JSON value - - The function restores the arbitrary nesting of a JSON value that has been - flattened before using the @ref flatten() function. The JSON value must - meet certain constraints: - 1. The value must be an object. - 2. The keys must be JSON pointers (see - [RFC 6901](https://tools.ietf.org/html/rfc6901)) - 3. The mapped values must be primitive JSON types. - - @return the original JSON from a flattened version - - @note Empty objects and arrays are flattened by @ref flatten() to `null` - values and can not unflattened to their original type. Apart from - this example, for a JSON value `j`, the following is always true: - `j == j.flatten().unflatten()`. - - @complexity Linear in the size the JSON value. - - @throw type_error.314 if value is not an object - @throw type_error.315 if object values are not primitive - - @liveexample{The following code shows how a flattened JSON object is - unflattened into the original nested JSON object.,unflatten} - - @sa @ref flatten() for the reverse function - - @since version 2.0.0 - */ - basic_json unflatten() const - { - return json_pointer::unflatten(*this); - } - - /// @} - - ////////////////////////// - // JSON Patch functions // - ////////////////////////// - - /// @name JSON Patch functions - /// @{ - - /*! - @brief applies a JSON patch - - [JSON Patch](http://jsonpatch.com) defines a JSON document structure for - expressing a sequence of operations to apply to a JSON) document. With - this function, a JSON Patch is applied to the current JSON value by - executing all operations from the patch. - - @param[in] json_patch JSON patch document - @return patched document - - @note The application of a patch is atomic: Either all operations succeed - and the patched document is returned or an exception is thrown. In - any case, the original value is not changed: the patch is applied - to a copy of the value. - - @throw parse_error.104 if the JSON patch does not consist of an array of - objects - - @throw parse_error.105 if the JSON patch is malformed (e.g., mandatory - attributes are missing); example: `"operation add must have member path"` - - @throw out_of_range.401 if an array index is out of range. - - @throw out_of_range.403 if a JSON pointer inside the patch could not be - resolved successfully in the current JSON value; example: `"key baz not - found"` - - @throw out_of_range.405 if JSON pointer has no parent ("add", "remove", - "move") - - @throw other_error.501 if "test" operation was unsuccessful - - @complexity Linear in the size of the JSON value and the length of the - JSON patch. As usually only a fraction of the JSON value is affected by - the patch, the complexity can usually be neglected. - - @liveexample{The following code shows how a JSON patch is applied to a - value.,patch} - - @sa @ref diff -- create a JSON patch by comparing two JSON values - - @sa [RFC 6902 (JSON Patch)](https://tools.ietf.org/html/rfc6902) - @sa [RFC 6901 (JSON Pointer)](https://tools.ietf.org/html/rfc6901) - - @since version 2.0.0 - */ - basic_json patch(const basic_json& json_patch) const - { - // make a working copy to apply the patch to - basic_json result = *this; - - // the valid JSON Patch operations - enum class patch_operations {add, remove, replace, move, copy, test, invalid}; - - const auto get_op = [](const std::string & op) - { - if (op == "add") - { - return patch_operations::add; - } - if (op == "remove") - { - return patch_operations::remove; - } - if (op == "replace") - { - return patch_operations::replace; - } - if (op == "move") - { - return patch_operations::move; - } - if (op == "copy") - { - return patch_operations::copy; - } - if (op == "test") - { - return patch_operations::test; - } - - return patch_operations::invalid; - }; - - // wrapper for "add" operation; add value at ptr - const auto operation_add = [&result](json_pointer & ptr, basic_json val) - { - // adding to the root of the target document means replacing it - if (ptr.is_root()) - { - result = val; - } - else - { - // make sure the top element of the pointer exists - json_pointer top_pointer = ptr.top(); - if (top_pointer != ptr) - { - result.at(top_pointer); - } - - // get reference to parent of JSON pointer ptr - const auto last_path = ptr.pop_back(); - basic_json& parent = result[ptr]; - - switch (parent.m_type) - { - case value_t::null: - case value_t::object: - { - // use operator[] to add value - parent[last_path] = val; - break; - } - - case value_t::array: - { - if (last_path == "-") - { - // special case: append to back - parent.push_back(val); - } - else - { - const auto idx = std::stoi(last_path); - if (static_cast(idx) > parent.size()) - { - // avoid undefined behavior - JSON_THROW(out_of_range::create(401, "array index " + std::to_string(idx) + " is out of range")); - } - else - { - // default case: insert add offset - parent.insert(parent.begin() + static_cast(idx), val); - } - } - break; - } - - default: - { - // if there exists a parent it cannot be primitive - assert(false); // LCOV_EXCL_LINE - } - } - } - }; - - // wrapper for "remove" operation; remove value at ptr - const auto operation_remove = [&result](json_pointer & ptr) - { - // get reference to parent of JSON pointer ptr - const auto last_path = ptr.pop_back(); - basic_json& parent = result.at(ptr); - - // remove child - if (parent.is_object()) - { - // perform range check - auto it = parent.find(last_path); - if (it != parent.end()) - { - parent.erase(it); - } - else - { - JSON_THROW(out_of_range::create(403, "key '" + last_path + "' not found")); - } - } - else if (parent.is_array()) - { - // note erase performs range check - parent.erase(static_cast(std::stoi(last_path))); - } - }; - - // type check: top level value must be an array - if (not json_patch.is_array()) - { - JSON_THROW(parse_error::create(104, 0, "JSON patch must be an array of objects")); - } - - // iterate and apply the operations - for (const auto& val : json_patch) - { - // wrapper to get a value for an operation - const auto get_value = [&val](const std::string & op, - const std::string & member, - bool string_type) -> basic_json& - { - // find value - auto it = val.m_value.object->find(member); - - // context-sensitive error message - const auto error_msg = (op == "op") ? "operation" : "operation '" + op + "'"; - - // check if desired value is present - if (it == val.m_value.object->end()) - { - JSON_THROW(parse_error::create(105, 0, error_msg + " must have member '" + member + "'")); - } - - // check if result is of type string - if (string_type and not it->second.is_string()) - { - JSON_THROW(parse_error::create(105, 0, error_msg + " must have string member '" + member + "'")); - } - - // no error: return value - return it->second; - }; - - // type check: every element of the array must be an object - if (not val.is_object()) - { - JSON_THROW(parse_error::create(104, 0, "JSON patch must be an array of objects")); - } - - // collect mandatory members - const std::string op = get_value("op", "op", true); - const std::string path = get_value(op, "path", true); - json_pointer ptr(path); - - switch (get_op(op)) - { - case patch_operations::add: - { - operation_add(ptr, get_value("add", "value", false)); - break; - } - - case patch_operations::remove: - { - operation_remove(ptr); - break; - } - - case patch_operations::replace: - { - // the "path" location must exist - use at() - result.at(ptr) = get_value("replace", "value", false); - break; - } - - case patch_operations::move: - { - const std::string from_path = get_value("move", "from", true); - json_pointer from_ptr(from_path); - - // the "from" location must exist - use at() - basic_json v = result.at(from_ptr); - - // The move operation is functionally identical to a - // "remove" operation on the "from" location, followed - // immediately by an "add" operation at the target - // location with the value that was just removed. - operation_remove(from_ptr); - operation_add(ptr, v); - break; - } - - case patch_operations::copy: - { - const std::string from_path = get_value("copy", "from", true); - const json_pointer from_ptr(from_path); - - // the "from" location must exist - use at() - result[ptr] = result.at(from_ptr); - break; - } - - case patch_operations::test: - { - bool success = false; - JSON_TRY - { - // check if "value" matches the one at "path" - // the "path" location must exist - use at() - success = (result.at(ptr) == get_value("test", "value", false)); - } - JSON_CATCH (out_of_range&) - { - // ignore out of range errors: success remains false - } - - // throw an exception if test fails - if (not success) - { - JSON_THROW(other_error::create(501, "unsuccessful: " + val.dump())); - } - - break; - } - - case patch_operations::invalid: - { - // op must be "add", "remove", "replace", "move", "copy", or - // "test" - JSON_THROW(parse_error::create(105, 0, "operation value '" + op + "' is invalid")); - } - } - } - - return result; - } - - /*! - @brief creates a diff as a JSON patch - - Creates a [JSON Patch](http://jsonpatch.com) so that value @a source can - be changed into the value @a target by calling @ref patch function. - - @invariant For two JSON values @a source and @a target, the following code - yields always `true`: - @code {.cpp} - source.patch(diff(source, target)) == target; - @endcode - - @note Currently, only `remove`, `add`, and `replace` operations are - generated. - - @param[in] source JSON value to compare from - @param[in] target JSON value to compare against - @param[in] path helper value to create JSON pointers - - @return a JSON patch to convert the @a source to @a target - - @complexity Linear in the lengths of @a source and @a target. - - @liveexample{The following code shows how a JSON patch is created as a - diff for two JSON values.,diff} - - @sa @ref patch -- apply a JSON patch - - @sa [RFC 6902 (JSON Patch)](https://tools.ietf.org/html/rfc6902) - - @since version 2.0.0 - */ - static basic_json diff(const basic_json& source, - const basic_json& target, - const std::string& path = "") - { - // the patch - basic_json result(value_t::array); - - // if the values are the same, return empty patch - if (source == target) - { - return result; - } - - if (source.type() != target.type()) - { - // different types: replace value - result.push_back( - { - {"op", "replace"}, - {"path", path}, - {"value", target} - }); - } - else - { - switch (source.type()) - { - case value_t::array: - { - // first pass: traverse common elements - size_t i = 0; - while (i < source.size() and i < target.size()) - { - // recursive call to compare array values at index i - auto temp_diff = diff(source[i], target[i], path + "/" + std::to_string(i)); - result.insert(result.end(), temp_diff.begin(), temp_diff.end()); - ++i; - } - - // i now reached the end of at least one array - // in a second pass, traverse the remaining elements - - // remove my remaining elements - const auto end_index = static_cast(result.size()); - while (i < source.size()) - { - // add operations in reverse order to avoid invalid - // indices - result.insert(result.begin() + end_index, object( - { - {"op", "remove"}, - {"path", path + "/" + std::to_string(i)} - })); - ++i; - } - - // add other remaining elements - while (i < target.size()) - { - result.push_back( - { - {"op", "add"}, - {"path", path + "/" + std::to_string(i)}, - {"value", target[i]} - }); - ++i; - } - - break; - } - - case value_t::object: - { - // first pass: traverse this object's elements - for (auto it = source.begin(); it != source.end(); ++it) - { - // escape the key name to be used in a JSON patch - const auto key = json_pointer::escape(it.key()); - - if (target.find(it.key()) != target.end()) - { - // recursive call to compare object values at key it - auto temp_diff = diff(it.value(), target[it.key()], path + "/" + key); - result.insert(result.end(), temp_diff.begin(), temp_diff.end()); - } - else - { - // found a key that is not in o -> remove it - result.push_back(object( - { - {"op", "remove"}, - {"path", path + "/" + key} - })); - } - } - - // second pass: traverse other object's elements - for (auto it = target.begin(); it != target.end(); ++it) - { - if (source.find(it.key()) == source.end()) - { - // found a key that is not in this -> add it - const auto key = json_pointer::escape(it.key()); - result.push_back( - { - {"op", "add"}, - {"path", path + "/" + key}, - {"value", it.value()} - }); - } - } - - break; - } - - default: - { - // both primitive type: replace value - result.push_back( - { - {"op", "replace"}, - {"path", path}, - {"value", target} - }); - break; - } - } - } - - return result; - } - - /// @} -}; - -///////////// -// presets // -///////////// - -/*! -@brief default JSON class - -This type is the default specialization of the @ref basic_json class which -uses the standard template types. - -@since version 1.0.0 -*/ -using json = basic_json<>; -} // namespace nlohmann - - -/////////////////////// -// nonmember support // -/////////////////////// - -// specialization of std::swap, and std::hash -namespace std -{ -/*! -@brief exchanges the values of two JSON objects - -@since version 1.0.0 -*/ -template<> -inline void swap(nlohmann::json& j1, - nlohmann::json& j2) noexcept( - is_nothrow_move_constructible::value and - is_nothrow_move_assignable::value - ) -{ - j1.swap(j2); -} - -/// hash value for JSON objects -template<> -struct hash -{ - /*! - @brief return a hash value for a JSON object - - @since version 1.0.0 - */ - std::size_t operator()(const nlohmann::json& j) const - { - // a naive hashing via the string representation - const auto& h = hash(); - return h(j.dump()); - } -}; - -/// specialization for std::less -template <> -struct less<::nlohmann::detail::value_t> -{ - /*! - @brief compare two value_t enum values - @since version 3.0.0 - */ - bool operator()(nlohmann::detail::value_t lhs, - nlohmann::detail::value_t rhs) const noexcept - { - return nlohmann::detail::operator<(lhs, rhs); - } -}; - -} // namespace std - -/*! -@brief user-defined string literal for JSON values - -This operator implements a user-defined string literal for JSON objects. It -can be used by adding `"_json"` to a string literal and returns a JSON object -if no parse error occurred. - -@param[in] s a string representation of a JSON object -@param[in] n the length of string @a s -@return a JSON object - -@since version 1.0.0 -*/ -inline nlohmann::json operator "" _json(const char* s, std::size_t n) -{ - return nlohmann::json::parse(s, s + n); -} - -/*! -@brief user-defined string literal for JSON pointer - -This operator implements a user-defined string literal for JSON Pointers. It -can be used by adding `"_json_pointer"` to a string literal and returns a JSON pointer -object if no parse error occurred. - -@param[in] s a string representation of a JSON Pointer -@param[in] n the length of string @a s -@return a JSON pointer object - -@since version 2.0.0 -*/ -inline nlohmann::json::json_pointer operator "" _json_pointer(const char* s, std::size_t n) -{ - return nlohmann::json::json_pointer(std::string(s, n)); -} - -// restore GCC/clang diagnostic settings -#if defined(__clang__) || defined(__GNUC__) || defined(__GNUG__) - #pragma GCC diagnostic pop -#endif -#if defined(__clang__) - #pragma GCC diagnostic pop -#endif - -// clean up -#undef JSON_CATCH -#undef JSON_THROW -#undef JSON_TRY -#undef JSON_LIKELY -#undef JSON_UNLIKELY -#undef JSON_DEPRECATED - -#endif diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index e11940f59..85354f43e 100644 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -4,16 +4,11 @@ include_directories(.) add_subdirectory(common) add_subdirectory(core) add_subdirectory(video_core) -add_subdirectory(audio_core) -add_subdirectory(network) add_subdirectory(input_common) add_subdirectory(tests) if (ENABLE_SDL2) - add_subdirectory(citra) + add_subdirectory(yuzu_cmd) endif() if (ENABLE_QT) - add_subdirectory(citra_qt) -endif() -if (ENABLE_WEB_SERVICE) - add_subdirectory(web_service) + add_subdirectory(yuzu) endif() diff --git a/src/audio_core/CMakeLists.txt b/src/audio_core/CMakeLists.txt deleted file mode 100644 index 0ad86bb7a..000000000 --- a/src/audio_core/CMakeLists.txt +++ /dev/null @@ -1,44 +0,0 @@ -set(SRCS - audio_core.cpp - codec.cpp - hle/dsp.cpp - hle/filter.cpp - hle/mixers.cpp - hle/pipe.cpp - hle/source.cpp - interpolate.cpp - sink_details.cpp - time_stretch.cpp - ) - -set(HEADERS - audio_core.h - codec.h - hle/common.h - hle/dsp.h - hle/filter.h - hle/mixers.h - hle/pipe.h - hle/source.h - interpolate.h - null_sink.h - sink.h - sink_details.h - time_stretch.h - ) - -if(SDL2_FOUND) - set(SRCS ${SRCS} sdl2_sink.cpp) - set(HEADERS ${HEADERS} sdl2_sink.h) -endif() - -create_directory_groups(${SRCS} ${HEADERS}) - -add_library(audio_core STATIC ${SRCS} ${HEADERS}) -target_link_libraries(audio_core PUBLIC common core) -target_link_libraries(audio_core PRIVATE SoundTouch) - -if(SDL2_FOUND) - target_link_libraries(audio_core PRIVATE SDL2) - target_compile_definitions(audio_core PRIVATE HAVE_SDL2) -endif() diff --git a/src/audio_core/audio_core.cpp b/src/audio_core/audio_core.cpp deleted file mode 100644 index ae2b68f9c..000000000 --- a/src/audio_core/audio_core.cpp +++ /dev/null @@ -1,61 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#include -#include -#include -#include "audio_core/audio_core.h" -#include "audio_core/hle/dsp.h" -#include "audio_core/hle/pipe.h" -#include "audio_core/null_sink.h" -#include "audio_core/sink.h" -#include "audio_core/sink_details.h" -#include "common/common_types.h" -#include "core/core_timing.h" -#include "core/hle/service/dsp_dsp.h" - -namespace AudioCore { - -// Audio Ticks occur about every 5 miliseconds. -static CoreTiming::EventType* tick_event; ///< CoreTiming event -static constexpr u64 audio_frame_ticks = 1310252ull; ///< Units: ARM11 cycles - -static void AudioTickCallback(u64 /*userdata*/, int cycles_late) { - if (DSP::HLE::Tick()) { - // TODO(merry): Signal all the other interrupts as appropriate. - Service::DSP_DSP::SignalPipeInterrupt(DSP::HLE::DspPipe::Audio); - // HACK(merry): Added to prevent regressions. Will remove soon. - Service::DSP_DSP::SignalPipeInterrupt(DSP::HLE::DspPipe::Binary); - } - - // Reschedule recurrent event - CoreTiming::ScheduleEvent(audio_frame_ticks - cycles_late, tick_event); -} - -void Init() { - DSP::HLE::Init(); - - tick_event = CoreTiming::RegisterEvent("AudioCore::tick_event", AudioTickCallback); - CoreTiming::ScheduleEvent(audio_frame_ticks, tick_event); -} - -std::array& GetDspMemory() { - return DSP::HLE::g_dsp_memory.raw_memory; -} - -void SelectSink(std::string sink_id) { - const SinkDetails& sink_details = GetSinkDetails(sink_id); - DSP::HLE::SetSink(sink_details.factory()); -} - -void EnableStretching(bool enable) { - DSP::HLE::EnableStretching(enable); -} - -void Shutdown() { - CoreTiming::UnscheduleEvent(tick_event, 0); - DSP::HLE::Shutdown(); -} - -} // namespace AudioCore diff --git a/src/audio_core/audio_core.h b/src/audio_core/audio_core.h deleted file mode 100644 index ab323ce1f..000000000 --- a/src/audio_core/audio_core.h +++ /dev/null @@ -1,31 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include -#include "common/common_types.h" -#include "core/memory.h" - -namespace AudioCore { - -constexpr int native_sample_rate = 32728; ///< 32kHz - -/// Initialise Audio Core -void Init(); - -/// Returns a reference to the array backing DSP memory -std::array& GetDspMemory(); - -/// Select the sink to use based on sink id. -void SelectSink(std::string sink_id); - -/// Enable/Disable stretching. -void EnableStretching(bool enable); - -/// Shutdown Audio Core -void Shutdown(); - -} // namespace AudioCore diff --git a/src/audio_core/codec.cpp b/src/audio_core/codec.cpp deleted file mode 100644 index 6fba9fdae..000000000 --- a/src/audio_core/codec.cpp +++ /dev/null @@ -1,127 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#include -#include -#include -#include -#include "audio_core/codec.h" -#include "common/assert.h" -#include "common/common_types.h" -#include "common/math_util.h" - -namespace Codec { - -StereoBuffer16 DecodeADPCM(const u8* const data, const size_t sample_count, - const std::array& adpcm_coeff, ADPCMState& state) { - // GC-ADPCM with scale factor and variable coefficients. - // Frames are 8 bytes long containing 14 samples each. - // Samples are 4 bits (one nibble) long. - - constexpr size_t FRAME_LEN = 8; - constexpr size_t SAMPLES_PER_FRAME = 14; - constexpr std::array SIGNED_NIBBLES = { - {0, 1, 2, 3, 4, 5, 6, 7, -8, -7, -6, -5, -4, -3, -2, -1}}; - - const size_t ret_size = - sample_count % 2 == 0 ? sample_count : sample_count + 1; // Ensure multiple of two. - StereoBuffer16 ret(ret_size); - - int yn1 = state.yn1, yn2 = state.yn2; - - const size_t NUM_FRAMES = - (sample_count + (SAMPLES_PER_FRAME - 1)) / SAMPLES_PER_FRAME; // Round up. - for (size_t framei = 0; framei < NUM_FRAMES; framei++) { - const int frame_header = data[framei * FRAME_LEN]; - const int scale = 1 << (frame_header & 0xF); - const int idx = (frame_header >> 4) & 0x7; - - // Coefficients are fixed point with 11 bits fractional part. - const int coef1 = adpcm_coeff[idx * 2 + 0]; - const int coef2 = adpcm_coeff[idx * 2 + 1]; - - // Decodes an audio sample. One nibble produces one sample. - const auto decode_sample = [&](const int nibble) -> s16 { - const int xn = nibble * scale; - // We first transform everything into 11 bit fixed point, perform the second order - // digital filter, then transform back. - // 0x400 == 0.5 in 11 bit fixed point. - // Filter: y[n] = x[n] + 0.5 + c1 * y[n-1] + c2 * y[n-2] - int val = ((xn << 11) + 0x400 + coef1 * yn1 + coef2 * yn2) >> 11; - // Clamp to output range. - val = MathUtil::Clamp(val, -32768, 32767); - // Advance output feedback. - yn2 = yn1; - yn1 = val; - return (s16)val; - }; - - size_t outputi = framei * SAMPLES_PER_FRAME; - size_t datai = framei * FRAME_LEN + 1; - for (size_t i = 0; i < SAMPLES_PER_FRAME && outputi < sample_count; i += 2) { - const s16 sample1 = decode_sample(SIGNED_NIBBLES[data[datai] >> 4]); - ret[outputi].fill(sample1); - outputi++; - - const s16 sample2 = decode_sample(SIGNED_NIBBLES[data[datai] & 0xF]); - ret[outputi].fill(sample2); - outputi++; - - datai++; - } - } - - state.yn1 = yn1; - state.yn2 = yn2; - - return ret; -} - -static s16 SignExtendS8(u8 x) { - // The data is actually signed PCM8. - // We sign extend this to signed PCM16. - return static_cast(static_cast(x)); -} - -StereoBuffer16 DecodePCM8(const unsigned num_channels, const u8* const data, - const size_t sample_count) { - ASSERT(num_channels == 1 || num_channels == 2); - - StereoBuffer16 ret(sample_count); - - if (num_channels == 1) { - for (size_t i = 0; i < sample_count; i++) { - ret[i].fill(SignExtendS8(data[i])); - } - } else { - for (size_t i = 0; i < sample_count; i++) { - ret[i][0] = SignExtendS8(data[i * 2 + 0]); - ret[i][1] = SignExtendS8(data[i * 2 + 1]); - } - } - - return ret; -} - -StereoBuffer16 DecodePCM16(const unsigned num_channels, const u8* const data, - const size_t sample_count) { - ASSERT(num_channels == 1 || num_channels == 2); - - StereoBuffer16 ret(sample_count); - - if (num_channels == 1) { - for (size_t i = 0; i < sample_count; i++) { - s16 sample; - std::memcpy(&sample, data + i * sizeof(s16), sizeof(s16)); - ret[i].fill(sample); - } - } else { - for (size_t i = 0; i < sample_count; ++i) { - std::memcpy(&ret[i], data + i * sizeof(s16) * 2, 2 * sizeof(s16)); - } - } - - return ret; -} -}; diff --git a/src/audio_core/codec.h b/src/audio_core/codec.h deleted file mode 100644 index 877b2202d..000000000 --- a/src/audio_core/codec.h +++ /dev/null @@ -1,51 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include -#include "common/common_types.h" - -namespace Codec { - -/// A variable length buffer of signed PCM16 stereo samples. -using StereoBuffer16 = std::deque>; - -/// See: Codec::DecodeADPCM -struct ADPCMState { - // Two historical samples from previous processed buffer, - // required for ADPCM decoding - s16 yn1; ///< y[n-1] - s16 yn2; ///< y[n-2] -}; - -/** - * @param data Pointer to buffer that contains ADPCM data to decode - * @param sample_count Length of buffer in terms of number of samples - * @param adpcm_coeff ADPCM coefficients - * @param state ADPCM state, this is updated with new state - * @return Decoded stereo signed PCM16 data, sample_count in length - */ -StereoBuffer16 DecodeADPCM(const u8* const data, const size_t sample_count, - const std::array& adpcm_coeff, ADPCMState& state); - -/** - * @param num_channels Number of channels - * @param data Pointer to buffer that contains PCM8 data to decode - * @param sample_count Length of buffer in terms of number of samples - * @return Decoded stereo signed PCM16 data, sample_count in length - */ -StereoBuffer16 DecodePCM8(const unsigned num_channels, const u8* const data, - const size_t sample_count); - -/** - * @param num_channels Number of channels - * @param data Pointer to buffer that contains PCM16 data to decode - * @param sample_count Length of buffer in terms of number of samples - * @return Decoded stereo signed PCM16 data, sample_count in length - */ -StereoBuffer16 DecodePCM16(const unsigned num_channels, const u8* const data, - const size_t sample_count); -}; diff --git a/src/audio_core/hle/common.h b/src/audio_core/hle/common.h deleted file mode 100644 index 7fbc3ad9a..000000000 --- a/src/audio_core/hle/common.h +++ /dev/null @@ -1,34 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include -#include "common/common_types.h" - -namespace DSP { -namespace HLE { - -constexpr int num_sources = 24; -constexpr int samples_per_frame = 160; ///< Samples per audio frame at native sample rate - -/// The final output to the speakers is stereo. Preprocessing output in Source is also stereo. -using StereoFrame16 = std::array, samples_per_frame>; - -/// The DSP is quadraphonic internally. -using QuadFrame32 = std::array, samples_per_frame>; - -/** - * This performs the filter operation defined by FilterT::ProcessSample on the frame in-place. - * FilterT::ProcessSample is called sequentially on the samples. - */ -template -void FilterFrame(FrameT& frame, FilterT& filter) { - std::transform(frame.begin(), frame.end(), frame.begin(), - [&filter](const auto& sample) { return filter.ProcessSample(sample); }); -} - -} // namespace HLE -} // namespace DSP diff --git a/src/audio_core/hle/dsp.cpp b/src/audio_core/hle/dsp.cpp deleted file mode 100644 index 260b182ed..000000000 --- a/src/audio_core/hle/dsp.cpp +++ /dev/null @@ -1,172 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#include -#include -#include "audio_core/hle/dsp.h" -#include "audio_core/hle/mixers.h" -#include "audio_core/hle/pipe.h" -#include "audio_core/hle/source.h" -#include "audio_core/sink.h" -#include "audio_core/time_stretch.h" - -namespace DSP { -namespace HLE { - -// Region management - -DspMemory g_dsp_memory; - -static size_t CurrentRegionIndex() { - // The region with the higher frame counter is chosen unless there is wraparound. - // This function only returns a 0 or 1. - u16 frame_counter_0 = g_dsp_memory.region_0.frame_counter; - u16 frame_counter_1 = g_dsp_memory.region_1.frame_counter; - - if (frame_counter_0 == 0xFFFFu && frame_counter_1 != 0xFFFEu) { - // Wraparound has occurred. - return 1; - } - - if (frame_counter_1 == 0xFFFFu && frame_counter_0 != 0xFFFEu) { - // Wraparound has occurred. - return 0; - } - - return (frame_counter_0 > frame_counter_1) ? 0 : 1; -} - -static SharedMemory& ReadRegion() { - return CurrentRegionIndex() == 0 ? g_dsp_memory.region_0 : g_dsp_memory.region_1; -} - -static SharedMemory& WriteRegion() { - return CurrentRegionIndex() != 0 ? g_dsp_memory.region_0 : g_dsp_memory.region_1; -} - -// Audio processing and mixing - -static std::array sources = { - Source(0), Source(1), Source(2), Source(3), Source(4), Source(5), Source(6), Source(7), - Source(8), Source(9), Source(10), Source(11), Source(12), Source(13), Source(14), Source(15), - Source(16), Source(17), Source(18), Source(19), Source(20), Source(21), Source(22), Source(23), -}; -static Mixers mixers; - -static StereoFrame16 GenerateCurrentFrame() { - SharedMemory& read = ReadRegion(); - SharedMemory& write = WriteRegion(); - - std::array intermediate_mixes = {}; - - // Generate intermediate mixes - for (size_t i = 0; i < num_sources; i++) { - write.source_statuses.status[i] = - sources[i].Tick(read.source_configurations.config[i], read.adpcm_coefficients.coeff[i]); - for (size_t mix = 0; mix < 3; mix++) { - sources[i].MixInto(intermediate_mixes[mix], mix); - } - } - - // Generate final mix - write.dsp_status = mixers.Tick(read.dsp_configuration, read.intermediate_mix_samples, - write.intermediate_mix_samples, intermediate_mixes); - - StereoFrame16 output_frame = mixers.GetOutput(); - - // Write current output frame to the shared memory region - for (size_t samplei = 0; samplei < output_frame.size(); samplei++) { - for (size_t channeli = 0; channeli < output_frame[0].size(); channeli++) { - write.final_samples.pcm16[samplei][channeli] = s16_le(output_frame[samplei][channeli]); - } - } - - return output_frame; -} - -// Audio output - -static bool perform_time_stretching = true; -static std::unique_ptr sink; -static AudioCore::TimeStretcher time_stretcher; - -static void FlushResidualStretcherAudio() { - time_stretcher.Flush(); - while (true) { - std::vector residual_audio = time_stretcher.Process(sink->SamplesInQueue()); - if (residual_audio.empty()) - break; - sink->EnqueueSamples(residual_audio.data(), residual_audio.size() / 2); - } -} - -static void OutputCurrentFrame(const StereoFrame16& frame) { - if (perform_time_stretching) { - time_stretcher.AddSamples(&frame[0][0], frame.size()); - std::vector stretched_samples = time_stretcher.Process(sink->SamplesInQueue()); - sink->EnqueueSamples(stretched_samples.data(), stretched_samples.size() / 2); - } else { - constexpr size_t maximum_sample_latency = 2048; // about 64 miliseconds - if (sink->SamplesInQueue() > maximum_sample_latency) { - // This can occur if we're running too fast and samples are starting to back up. - // Just drop the samples. - return; - } - - sink->EnqueueSamples(&frame[0][0], frame.size()); - } -} - -void EnableStretching(bool enable) { - if (perform_time_stretching == enable) - return; - - if (!enable) { - FlushResidualStretcherAudio(); - } - perform_time_stretching = enable; -} - -// Public Interface - -void Init() { - DSP::HLE::ResetPipes(); - - for (auto& source : sources) { - source.Reset(); - } - - mixers.Reset(); - - time_stretcher.Reset(); - if (sink) { - time_stretcher.SetOutputSampleRate(sink->GetNativeSampleRate()); - } -} - -void Shutdown() { - if (perform_time_stretching) { - FlushResidualStretcherAudio(); - } -} - -bool Tick() { - StereoFrame16 current_frame = {}; - - // TODO: Check dsp::DSP semaphore (which indicates emulated application has finished writing to - // shared memory region) - current_frame = GenerateCurrentFrame(); - - OutputCurrentFrame(current_frame); - - return true; -} - -void SetSink(std::unique_ptr sink_) { - sink = std::move(sink_); - time_stretcher.SetOutputSampleRate(sink->GetNativeSampleRate()); -} - -} // namespace HLE -} // namespace DSP diff --git a/src/audio_core/hle/dsp.h b/src/audio_core/hle/dsp.h deleted file mode 100644 index 94ce48863..000000000 --- a/src/audio_core/hle/dsp.h +++ /dev/null @@ -1,595 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include -#include -#include -#include "audio_core/hle/common.h" -#include "common/bit_field.h" -#include "common/common_funcs.h" -#include "common/common_types.h" -#include "common/swap.h" - -namespace AudioCore { -class Sink; -} - -namespace DSP { -namespace HLE { - -// The application-accessible region of DSP memory consists of two parts. Both are marked as IO and -// have Read/Write permissions. -// -// First Region: 0x1FF50000 (Size: 0x8000) -// Second Region: 0x1FF70000 (Size: 0x8000) -// -// The DSP reads from each region alternately based on the frame counter for each region much like a -// double-buffer. The frame counter is located as the very last u16 of each region and is -// incremented each audio tick. - -constexpr u32 region0_offset = 0x50000; -constexpr u32 region1_offset = 0x70000; - -/** - * The DSP is native 16-bit. The DSP also appears to be big-endian. When reading 32-bit numbers from - * its memory regions, the higher and lower 16-bit halves are swapped compared to the little-endian - * layout of the ARM11. Hence from the ARM11's point of view the memory space appears to be - * middle-endian. - * - * Unusually this does not appear to be an issue for floating point numbers. The DSP makes the more - * sensible choice of keeping that little-endian. There are also some exceptions such as the - * IntermediateMixSamples structure, which is little-endian. - * - * This struct implements the conversion to and from this middle-endianness. - */ -struct u32_dsp { - u32_dsp() = default; - operator u32() const { - return Convert(storage); - } - void operator=(u32 new_value) { - storage = Convert(new_value); - } - -private: - static constexpr u32 Convert(u32 value) { - return (value << 16) | (value >> 16); - } - u32_le storage; -}; -#if (__GNUC__ >= 5) || defined(__clang__) || defined(_MSC_VER) -static_assert(std::is_trivially_copyable::value, "u32_dsp isn't trivially copyable"); -#endif - -// There are 15 structures in each memory region. A table of them in the order they appear in memory -// is presented below: -// -// # First Region DSP Address Purpose Control -// 5 0x8400 DSP Status DSP -// 9 0x8410 DSP Debug Info DSP -// 6 0x8540 Final Mix Samples DSP -// 2 0x8680 Source Status [24] DSP -// 8 0x8710 Compressor Table Application -// 4 0x9430 DSP Configuration Application -// 7 0x9492 Intermediate Mix Samples DSP + App -// 1 0x9E92 Source Configuration [24] Application -// 3 0xA792 Source ADPCM Coefficients [24] Application -// 10 0xA912 Surround Sound Related -// 11 0xAA12 Surround Sound Related -// 12 0xAAD2 Surround Sound Related -// 13 0xAC52 Surround Sound Related -// 14 0xAC5C Surround Sound Related -// 0 0xBFFF Frame Counter Application -// -// #: This refers to the order in which they appear in the DspPipe::Audio DSP pipe. -// See also: DSP::HLE::PipeRead. -// -// Note that the above addresses do vary slightly between audio firmwares observed; the addresses -// are not fixed in stone. The addresses above are only an examplar; they're what this -// implementation does and provides to applications. -// -// Application requests the DSP service to convert DSP addresses into ARM11 virtual addresses using -// the ConvertProcessAddressFromDspDram service call. Applications seem to derive the addresses for -// the second region via: -// second_region_dsp_addr = first_region_dsp_addr | 0x10000 -// -// Applications maintain most of its own audio state, the memory region is used mainly for -// communication and not storage of state. -// -// In the documentation below, filter and effect transfer functions are specified in the z domain. -// (If you are more familiar with the Laplace transform, z = exp(sT). The z domain is the digital -// frequency domain, just like how the s domain is the analog frequency domain.) - -#define INSERT_PADDING_DSPWORDS(num_words) INSERT_PADDING_BYTES(2 * (num_words)) - -// GCC versions < 5.0 do not implement std::is_trivially_copyable. -// Excluding MSVC because it has weird behaviour for std::is_trivially_copyable. -#if (__GNUC__ >= 5) || defined(__clang__) -#define ASSERT_DSP_STRUCT(name, size) \ - static_assert(std::is_standard_layout::value, \ - "DSP structure " #name " doesn't use standard layout"); \ - static_assert(std::is_trivially_copyable::value, \ - "DSP structure " #name " isn't trivially copyable"); \ - static_assert(sizeof(name) == (size), "Unexpected struct size for DSP structure " #name) -#else -#define ASSERT_DSP_STRUCT(name, size) \ - static_assert(std::is_standard_layout::value, \ - "DSP structure " #name " doesn't use standard layout"); \ - static_assert(sizeof(name) == (size), "Unexpected struct size for DSP structure " #name) -#endif - -struct SourceConfiguration { - struct Configuration { - /// These dirty flags are set by the application when it updates the fields in this struct. - /// The DSP clears these each audio frame. - union { - u32_le dirty_raw; - - BitField<0, 1, u32_le> format_dirty; - BitField<1, 1, u32_le> mono_or_stereo_dirty; - BitField<2, 1, u32_le> adpcm_coefficients_dirty; - /// Tends to be set when a looped buffer is queued. - BitField<3, 1, u32_le> partial_embedded_buffer_dirty; - BitField<4, 1, u32_le> partial_reset_flag; - - BitField<16, 1, u32_le> enable_dirty; - BitField<17, 1, u32_le> interpolation_dirty; - BitField<18, 1, u32_le> rate_multiplier_dirty; - BitField<19, 1, u32_le> buffer_queue_dirty; - BitField<20, 1, u32_le> loop_related_dirty; - /// Tends to also be set when embedded buffer is updated. - BitField<21, 1, u32_le> play_position_dirty; - BitField<22, 1, u32_le> filters_enabled_dirty; - BitField<23, 1, u32_le> simple_filter_dirty; - BitField<24, 1, u32_le> biquad_filter_dirty; - BitField<25, 1, u32_le> gain_0_dirty; - BitField<26, 1, u32_le> gain_1_dirty; - BitField<27, 1, u32_le> gain_2_dirty; - BitField<28, 1, u32_le> sync_dirty; - BitField<29, 1, u32_le> reset_flag; - BitField<30, 1, u32_le> embedded_buffer_dirty; - }; - - // Gain control - - /** - * Gain is between 0.0-1.0. This determines how much will this source appear on each of the - * 12 channels that feed into the intermediate mixers. Each of the three intermediate mixers - * is fed two left and two right channels. - */ - float_le gain[3][4]; - - // Interpolation - - /// Multiplier for sample rate. Resampling occurs with the selected interpolation method. - float_le rate_multiplier; - - enum class InterpolationMode : u8 { - Polyphase = 0, - Linear = 1, - None = 2, - }; - - InterpolationMode interpolation_mode; - INSERT_PADDING_BYTES(1); ///< Interpolation related - - // Filters - - /** - * This is the simplest normalized first-order digital recursive filter. - * The transfer function of this filter is: - * H(z) = b0 / (1 - a1 z^-1) - * Note the feedbackward coefficient is negated. - * Values are signed fixed point with 15 fractional bits. - */ - struct SimpleFilter { - s16_le b0; - s16_le a1; - }; - - /** - * This is a normalised biquad filter (second-order). - * The transfer function of this filter is: - * H(z) = (b0 + b1 z^-1 + b2 z^-2) / (1 - a1 z^-1 - a2 z^-2) - * Nintendo chose to negate the feedbackward coefficients. This differs from standard - * notation as in: https://ccrma.stanford.edu/~jos/filters/Direct_Form_I.html - * Values are signed fixed point with 14 fractional bits. - */ - struct BiquadFilter { - s16_le a2; - s16_le a1; - s16_le b2; - s16_le b1; - s16_le b0; - }; - - union { - u16_le filters_enabled; - BitField<0, 1, u16_le> simple_filter_enabled; - BitField<1, 1, u16_le> biquad_filter_enabled; - }; - - SimpleFilter simple_filter; - BiquadFilter biquad_filter; - - // Buffer Queue - - /// A buffer of audio data from the application, along with metadata about it. - struct Buffer { - /// Physical memory address of the start of the buffer - u32_dsp physical_address; - - /// This is length in terms of samples. - /// Note that in different buffer formats a sample takes up different number of bytes. - u32_dsp length; - - /// ADPCM Predictor (4 bits) and Scale (4 bits) - union { - u16_le adpcm_ps; - BitField<0, 4, u16_le> adpcm_scale; - BitField<4, 4, u16_le> adpcm_predictor; - }; - - /// ADPCM Historical Samples (y[n-1] and y[n-2]) - u16_le adpcm_yn[2]; - - /// This is non-zero when the ADPCM values above are to be updated. - u8 adpcm_dirty; - - /// Is a looping buffer. - u8 is_looping; - - /// This value is shown in SourceStatus::previous_buffer_id when this buffer has - /// finished. This allows the emulated application to tell what buffer is currently - /// playing. - u16_le buffer_id; - - INSERT_PADDING_DSPWORDS(1); - }; - - u16_le buffers_dirty; ///< Bitmap indicating which buffers are dirty (bit i -> buffers[i]) - Buffer buffers[4]; ///< Queued Buffers - - // Playback controls - - u32_dsp loop_related; - u8 enable; - INSERT_PADDING_BYTES(1); - u16_le sync; ///< Application-side sync (See also: SourceStatus::sync) - u32_dsp play_position; ///< Position. (Units: number of samples) - INSERT_PADDING_DSPWORDS(2); - - // Embedded Buffer - // This buffer is often the first buffer to be used when initiating audio playback, - // after which the buffer queue is used. - - u32_dsp physical_address; - - /// This is length in terms of samples. - /// Note a sample takes up different number of bytes in different buffer formats. - u32_dsp length; - - enum class MonoOrStereo : u16_le { - Mono = 1, - Stereo = 2, - }; - - enum class Format : u16_le { - PCM8 = 0, - PCM16 = 1, - ADPCM = 2, - }; - - union { - u16_le flags1_raw; - BitField<0, 2, MonoOrStereo> mono_or_stereo; - BitField<2, 2, Format> format; - BitField<5, 1, u16_le> fade_in; - }; - - /// ADPCM Predictor (4 bit) and Scale (4 bit) - union { - u16_le adpcm_ps; - BitField<0, 4, u16_le> adpcm_scale; - BitField<4, 4, u16_le> adpcm_predictor; - }; - - /// ADPCM Historical Samples (y[n-1] and y[n-2]) - u16_le adpcm_yn[2]; - - union { - u16_le flags2_raw; - BitField<0, 1, u16_le> adpcm_dirty; ///< Has the ADPCM info above been changed? - BitField<1, 1, u16_le> is_looping; ///< Is this a looping buffer? - }; - - /// Buffer id of embedded buffer (used as a buffer id in SourceStatus to reference this - /// buffer). - u16_le buffer_id; - }; - - Configuration config[num_sources]; -}; -ASSERT_DSP_STRUCT(SourceConfiguration::Configuration, 192); -ASSERT_DSP_STRUCT(SourceConfiguration::Configuration::Buffer, 20); - -struct SourceStatus { - struct Status { - u8 is_enabled; ///< Is this channel enabled? (Doesn't have to be playing anything.) - u8 current_buffer_id_dirty; ///< Non-zero when current_buffer_id changes - u16_le sync; ///< Is set by the DSP to the value of SourceConfiguration::sync - u32_dsp buffer_position; ///< Number of samples into the current buffer - u16_le current_buffer_id; ///< Updated when a buffer finishes playing - INSERT_PADDING_DSPWORDS(1); - }; - - Status status[num_sources]; -}; -ASSERT_DSP_STRUCT(SourceStatus::Status, 12); - -struct DspConfiguration { - /// These dirty flags are set by the application when it updates the fields in this struct. - /// The DSP clears these each audio frame. - union { - u32_le dirty_raw; - - BitField<8, 1, u32_le> mixer1_enabled_dirty; - BitField<9, 1, u32_le> mixer2_enabled_dirty; - BitField<10, 1, u32_le> delay_effect_0_dirty; - BitField<11, 1, u32_le> delay_effect_1_dirty; - BitField<12, 1, u32_le> reverb_effect_0_dirty; - BitField<13, 1, u32_le> reverb_effect_1_dirty; - - BitField<16, 1, u32_le> volume_0_dirty; - - BitField<24, 1, u32_le> volume_1_dirty; - BitField<25, 1, u32_le> volume_2_dirty; - BitField<26, 1, u32_le> output_format_dirty; - BitField<27, 1, u32_le> limiter_enabled_dirty; - BitField<28, 1, u32_le> headphones_connected_dirty; - }; - - /// The DSP has three intermediate audio mixers. This controls the volume level (0.0-1.0) for - /// each at the final mixer. - float_le volume[3]; - - INSERT_PADDING_DSPWORDS(3); - - enum class OutputFormat : u16_le { - Mono = 0, - Stereo = 1, - Surround = 2, - }; - - OutputFormat output_format; - - u16_le limiter_enabled; ///< Not sure of the exact gain equation for the limiter. - u16_le headphones_connected; ///< Application updates the DSP on headphone status. - INSERT_PADDING_DSPWORDS(4); ///< TODO: Surround sound related - INSERT_PADDING_DSPWORDS(2); ///< TODO: Intermediate mixer 1/2 related - u16_le mixer1_enabled; - u16_le mixer2_enabled; - - /** - * This is delay with feedback. - * Transfer function: - * H(z) = a z^-N / (1 - b z^-1 + a g z^-N) - * where - * N = frame_count * samples_per_frame - * g, a and b are fixed point with 7 fractional bits - */ - struct DelayEffect { - /// These dirty flags are set by the application when it updates the fields in this struct. - /// The DSP clears these each audio frame. - union { - u16_le dirty_raw; - BitField<0, 1, u16_le> enable_dirty; - BitField<1, 1, u16_le> work_buffer_address_dirty; - BitField<2, 1, u16_le> other_dirty; ///< Set when anything else has been changed - }; - - u16_le enable; - INSERT_PADDING_DSPWORDS(1); - u16_le outputs; - /// The application allocates a block of memory for the DSP to use as a work buffer. - u32_dsp work_buffer_address; - /// Frames to delay by - u16_le frame_count; - - // Coefficients - s16_le g; ///< Fixed point with 7 fractional bits - s16_le a; ///< Fixed point with 7 fractional bits - s16_le b; ///< Fixed point with 7 fractional bits - }; - - DelayEffect delay_effect[2]; - - struct ReverbEffect { - INSERT_PADDING_DSPWORDS(26); ///< TODO - }; - - ReverbEffect reverb_effect[2]; - - INSERT_PADDING_DSPWORDS(4); -}; -ASSERT_DSP_STRUCT(DspConfiguration, 196); -ASSERT_DSP_STRUCT(DspConfiguration::DelayEffect, 20); -ASSERT_DSP_STRUCT(DspConfiguration::ReverbEffect, 52); - -struct AdpcmCoefficients { - /// Coefficients are signed fixed point with 11 fractional bits. - /// Each source has 16 coefficients associated with it. - s16_le coeff[num_sources][16]; -}; -ASSERT_DSP_STRUCT(AdpcmCoefficients, 768); - -struct DspStatus { - u16_le unknown; - u16_le dropped_frames; - INSERT_PADDING_DSPWORDS(0xE); -}; -ASSERT_DSP_STRUCT(DspStatus, 32); - -/// Final mixed output in PCM16 stereo format, what you hear out of the speakers. -/// When the application writes to this region it has no effect. -struct FinalMixSamples { - s16_le pcm16[samples_per_frame][2]; -}; -ASSERT_DSP_STRUCT(FinalMixSamples, 640); - -/// DSP writes output of intermediate mixers 1 and 2 here. -/// Writes to this region by the application edits the output of the intermediate mixers. -/// This seems to be intended to allow the application to do custom effects on the ARM11. -/// Values that exceed s16 range will be clipped by the DSP after further processing. -struct IntermediateMixSamples { - struct Samples { - s32_le pcm32[4][samples_per_frame]; ///< Little-endian as opposed to DSP middle-endian. - }; - - Samples mix1; - Samples mix2; -}; -ASSERT_DSP_STRUCT(IntermediateMixSamples, 5120); - -/// Compressor table -struct Compressor { - INSERT_PADDING_DSPWORDS(0xD20); ///< TODO -}; - -/// There is no easy way to implement this in a HLE implementation. -struct DspDebug { - INSERT_PADDING_DSPWORDS(0x130); -}; -ASSERT_DSP_STRUCT(DspDebug, 0x260); - -struct SharedMemory { - /// Padding - INSERT_PADDING_DSPWORDS(0x400); - - DspStatus dsp_status; - - DspDebug dsp_debug; - - FinalMixSamples final_samples; - - SourceStatus source_statuses; - - Compressor compressor; - - DspConfiguration dsp_configuration; - - IntermediateMixSamples intermediate_mix_samples; - - SourceConfiguration source_configurations; - - AdpcmCoefficients adpcm_coefficients; - - struct { - INSERT_PADDING_DSPWORDS(0x100); - } unknown10; - - struct { - INSERT_PADDING_DSPWORDS(0xC0); - } unknown11; - - struct { - INSERT_PADDING_DSPWORDS(0x180); - } unknown12; - - struct { - INSERT_PADDING_DSPWORDS(0xA); - } unknown13; - - struct { - INSERT_PADDING_DSPWORDS(0x13A3); - } unknown14; - - u16_le frame_counter; -}; -ASSERT_DSP_STRUCT(SharedMemory, 0x8000); - -union DspMemory { - std::array raw_memory; - struct { - u8 unused_0[0x50000]; - SharedMemory region_0; - u8 unused_1[0x18000]; - SharedMemory region_1; - u8 unused_2[0x8000]; - }; -}; -static_assert(offsetof(DspMemory, region_0) == region0_offset, - "DSP region 0 is at the wrong offset"); -static_assert(offsetof(DspMemory, region_1) == region1_offset, - "DSP region 1 is at the wrong offset"); - -extern DspMemory g_dsp_memory; - -// Structures must have an offset that is a multiple of two. -static_assert(offsetof(SharedMemory, frame_counter) % 2 == 0, - "Structures in DSP::HLE::SharedMemory must be 2-byte aligned"); -static_assert(offsetof(SharedMemory, source_configurations) % 2 == 0, - "Structures in DSP::HLE::SharedMemory must be 2-byte aligned"); -static_assert(offsetof(SharedMemory, source_statuses) % 2 == 0, - "Structures in DSP::HLE::SharedMemory must be 2-byte aligned"); -static_assert(offsetof(SharedMemory, adpcm_coefficients) % 2 == 0, - "Structures in DSP::HLE::SharedMemory must be 2-byte aligned"); -static_assert(offsetof(SharedMemory, dsp_configuration) % 2 == 0, - "Structures in DSP::HLE::SharedMemory must be 2-byte aligned"); -static_assert(offsetof(SharedMemory, dsp_status) % 2 == 0, - "Structures in DSP::HLE::SharedMemory must be 2-byte aligned"); -static_assert(offsetof(SharedMemory, final_samples) % 2 == 0, - "Structures in DSP::HLE::SharedMemory must be 2-byte aligned"); -static_assert(offsetof(SharedMemory, intermediate_mix_samples) % 2 == 0, - "Structures in DSP::HLE::SharedMemory must be 2-byte aligned"); -static_assert(offsetof(SharedMemory, compressor) % 2 == 0, - "Structures in DSP::HLE::SharedMemory must be 2-byte aligned"); -static_assert(offsetof(SharedMemory, dsp_debug) % 2 == 0, - "Structures in DSP::HLE::SharedMemory must be 2-byte aligned"); -static_assert(offsetof(SharedMemory, unknown10) % 2 == 0, - "Structures in DSP::HLE::SharedMemory must be 2-byte aligned"); -static_assert(offsetof(SharedMemory, unknown11) % 2 == 0, - "Structures in DSP::HLE::SharedMemory must be 2-byte aligned"); -static_assert(offsetof(SharedMemory, unknown12) % 2 == 0, - "Structures in DSP::HLE::SharedMemory must be 2-byte aligned"); -static_assert(offsetof(SharedMemory, unknown13) % 2 == 0, - "Structures in DSP::HLE::SharedMemory must be 2-byte aligned"); -static_assert(offsetof(SharedMemory, unknown14) % 2 == 0, - "Structures in DSP::HLE::SharedMemory must be 2-byte aligned"); - -#undef INSERT_PADDING_DSPWORDS -#undef ASSERT_DSP_STRUCT - -/// Initialize DSP hardware -void Init(); - -/// Shutdown DSP hardware -void Shutdown(); - -/** - * Perform processing and updates state of current shared memory buffer. - * This function is called every audio tick before triggering the audio interrupt. - * @return Whether an audio interrupt should be triggered this frame. - */ -bool Tick(); - -/** - * Set the output sink. This must be called before calling Tick(). - * @param sink The sink to which audio will be output to. - */ -void SetSink(std::unique_ptr sink); - -/** - * Enables/Disables audio-stretching. - * Audio stretching is an enhancement that stretches audio to match emulation - * speed to prevent stuttering at the cost of some audio latency. - * @param enable true to enable, false to disable. - */ -void EnableStretching(bool enable); - -} // namespace HLE -} // namespace DSP diff --git a/src/audio_core/hle/filter.cpp b/src/audio_core/hle/filter.cpp deleted file mode 100644 index b24a79b89..000000000 --- a/src/audio_core/hle/filter.cpp +++ /dev/null @@ -1,117 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#include -#include -#include "audio_core/hle/common.h" -#include "audio_core/hle/dsp.h" -#include "audio_core/hle/filter.h" -#include "common/common_types.h" -#include "common/math_util.h" - -namespace DSP { -namespace HLE { - -void SourceFilters::Reset() { - Enable(false, false); -} - -void SourceFilters::Enable(bool simple, bool biquad) { - simple_filter_enabled = simple; - biquad_filter_enabled = biquad; - - if (!simple) - simple_filter.Reset(); - if (!biquad) - biquad_filter.Reset(); -} - -void SourceFilters::Configure(SourceConfiguration::Configuration::SimpleFilter config) { - simple_filter.Configure(config); -} - -void SourceFilters::Configure(SourceConfiguration::Configuration::BiquadFilter config) { - biquad_filter.Configure(config); -} - -void SourceFilters::ProcessFrame(StereoFrame16& frame) { - if (!simple_filter_enabled && !biquad_filter_enabled) - return; - - if (simple_filter_enabled) { - FilterFrame(frame, simple_filter); - } - - if (biquad_filter_enabled) { - FilterFrame(frame, biquad_filter); - } -} - -// SimpleFilter - -void SourceFilters::SimpleFilter::Reset() { - y1.fill(0); - // Configure as passthrough. - a1 = 0; - b0 = 1 << 15; -} - -void SourceFilters::SimpleFilter::Configure( - SourceConfiguration::Configuration::SimpleFilter config) { - - a1 = config.a1; - b0 = config.b0; -} - -std::array SourceFilters::SimpleFilter::ProcessSample(const std::array& x0) { - std::array y0; - for (size_t i = 0; i < 2; i++) { - const s32 tmp = (b0 * x0[i] + a1 * y1[i]) >> 15; - y0[i] = MathUtil::Clamp(tmp, -32768, 32767); - } - - y1 = y0; - - return y0; -} - -// BiquadFilter - -void SourceFilters::BiquadFilter::Reset() { - x1.fill(0); - x2.fill(0); - y1.fill(0); - y2.fill(0); - // Configure as passthrough. - a1 = a2 = b1 = b2 = 0; - b0 = 1 << 14; -} - -void SourceFilters::BiquadFilter::Configure( - SourceConfiguration::Configuration::BiquadFilter config) { - - a1 = config.a1; - a2 = config.a2; - b0 = config.b0; - b1 = config.b1; - b2 = config.b2; -} - -std::array SourceFilters::BiquadFilter::ProcessSample(const std::array& x0) { - std::array y0; - for (size_t i = 0; i < 2; i++) { - const s32 tmp = (b0 * x0[i] + b1 * x1[i] + b2 * x2[i] + a1 * y1[i] + a2 * y2[i]) >> 14; - y0[i] = MathUtil::Clamp(tmp, -32768, 32767); - } - - x2 = x1; - x1 = x0; - y2 = y1; - y1 = y0; - - return y0; -} - -} // namespace HLE -} // namespace DSP diff --git a/src/audio_core/hle/filter.h b/src/audio_core/hle/filter.h deleted file mode 100644 index 5350e2857..000000000 --- a/src/audio_core/hle/filter.h +++ /dev/null @@ -1,117 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include "audio_core/hle/common.h" -#include "audio_core/hle/dsp.h" -#include "common/common_types.h" - -namespace DSP { -namespace HLE { - -/// Preprocessing filters. There is an independent set of filters for each Source. -class SourceFilters final { -public: - SourceFilters() { - Reset(); - } - - /// Reset internal state. - void Reset(); - - /** - * Enable/Disable filters - * See also: SourceConfiguration::Configuration::simple_filter_enabled, - * SourceConfiguration::Configuration::biquad_filter_enabled. - * @param simple If true, enables the simple filter. If false, disables it. - * @param biquad If true, enables the biquad filter. If false, disables it. - */ - void Enable(bool simple, bool biquad); - - /** - * Configure simple filter. - * @param config Configuration from DSP shared memory. - */ - void Configure(SourceConfiguration::Configuration::SimpleFilter config); - - /** - * Configure biquad filter. - * @param config Configuration from DSP shared memory. - */ - void Configure(SourceConfiguration::Configuration::BiquadFilter config); - - /** - * Processes a frame in-place. - * @param frame Audio samples to process. Modified in-place. - */ - void ProcessFrame(StereoFrame16& frame); - -private: - bool simple_filter_enabled; - bool biquad_filter_enabled; - - struct SimpleFilter { - SimpleFilter() { - Reset(); - } - - /// Resets internal state. - void Reset(); - - /** - * Configures this filter with application settings. - * @param config Configuration from DSP shared memory. - */ - void Configure(SourceConfiguration::Configuration::SimpleFilter config); - - /** - * Processes a single stereo PCM16 sample. - * @param x0 Input sample - * @return Output sample - */ - std::array ProcessSample(const std::array& x0); - - private: - // Configuration - s32 a1, b0; - // Internal state - std::array y1; - } simple_filter; - - struct BiquadFilter { - BiquadFilter() { - Reset(); - } - - /// Resets internal state. - void Reset(); - - /** - * Configures this filter with application settings. - * @param config Configuration from DSP shared memory. - */ - void Configure(SourceConfiguration::Configuration::BiquadFilter config); - - /** - * Processes a single stereo PCM16 sample. - * @param x0 Input sample - * @return Output sample - */ - std::array ProcessSample(const std::array& x0); - - private: - // Configuration - s32 a1, a2, b0, b1, b2; - // Internal state - std::array x1; - std::array x2; - std::array y1; - std::array y2; - } biquad_filter; -}; - -} // namespace HLE -} // namespace DSP diff --git a/src/audio_core/hle/mixers.cpp b/src/audio_core/hle/mixers.cpp deleted file mode 100644 index 6cc81dfca..000000000 --- a/src/audio_core/hle/mixers.cpp +++ /dev/null @@ -1,210 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#include - -#include "audio_core/hle/common.h" -#include "audio_core/hle/dsp.h" -#include "audio_core/hle/mixers.h" -#include "common/assert.h" -#include "common/logging/log.h" -#include "common/math_util.h" - -namespace DSP { -namespace HLE { - -void Mixers::Reset() { - current_frame.fill({}); - state = {}; -} - -DspStatus Mixers::Tick(DspConfiguration& config, const IntermediateMixSamples& read_samples, - IntermediateMixSamples& write_samples, - const std::array& input) { - ParseConfig(config); - - AuxReturn(read_samples); - AuxSend(write_samples, input); - - MixCurrentFrame(); - - return GetCurrentStatus(); -} - -void Mixers::ParseConfig(DspConfiguration& config) { - if (!config.dirty_raw) { - return; - } - - if (config.mixer1_enabled_dirty) { - config.mixer1_enabled_dirty.Assign(0); - state.mixer1_enabled = config.mixer1_enabled != 0; - LOG_TRACE(Audio_DSP, "mixers mixer1_enabled = %hu", config.mixer1_enabled); - } - - if (config.mixer2_enabled_dirty) { - config.mixer2_enabled_dirty.Assign(0); - state.mixer2_enabled = config.mixer2_enabled != 0; - LOG_TRACE(Audio_DSP, "mixers mixer2_enabled = %hu", config.mixer2_enabled); - } - - if (config.volume_0_dirty) { - config.volume_0_dirty.Assign(0); - state.intermediate_mixer_volume[0] = config.volume[0]; - LOG_TRACE(Audio_DSP, "mixers volume[0] = %f", config.volume[0]); - } - - if (config.volume_1_dirty) { - config.volume_1_dirty.Assign(0); - state.intermediate_mixer_volume[1] = config.volume[1]; - LOG_TRACE(Audio_DSP, "mixers volume[1] = %f", config.volume[1]); - } - - if (config.volume_2_dirty) { - config.volume_2_dirty.Assign(0); - state.intermediate_mixer_volume[2] = config.volume[2]; - LOG_TRACE(Audio_DSP, "mixers volume[2] = %f", config.volume[2]); - } - - if (config.output_format_dirty) { - config.output_format_dirty.Assign(0); - state.output_format = config.output_format; - LOG_TRACE(Audio_DSP, "mixers output_format = %zu", - static_cast(config.output_format)); - } - - if (config.headphones_connected_dirty) { - config.headphones_connected_dirty.Assign(0); - // Do nothing. (Note: Whether headphones are connected does affect coefficients used for - // surround sound.) - LOG_TRACE(Audio_DSP, "mixers headphones_connected=%hu", config.headphones_connected); - } - - if (config.dirty_raw) { - LOG_DEBUG(Audio_DSP, "mixers remaining_dirty=%x", config.dirty_raw); - } - - config.dirty_raw = 0; -} - -static s16 ClampToS16(s32 value) { - return static_cast(MathUtil::Clamp(value, -32768, 32767)); -} - -static std::array AddAndClampToS16(const std::array& a, - const std::array& b) { - return {ClampToS16(static_cast(a[0]) + static_cast(b[0])), - ClampToS16(static_cast(a[1]) + static_cast(b[1]))}; -} - -void Mixers::DownmixAndMixIntoCurrentFrame(float gain, const QuadFrame32& samples) { - // TODO(merry): Limiter. (Currently we're performing final mixing assuming a disabled limiter.) - - switch (state.output_format) { - case OutputFormat::Mono: - std::transform( - current_frame.begin(), current_frame.end(), samples.begin(), current_frame.begin(), - [gain](const std::array& accumulator, - const std::array& sample) -> std::array { - // Downmix to mono - s16 mono = ClampToS16(static_cast( - (gain * sample[0] + gain * sample[1] + gain * sample[2] + gain * sample[3]) / - 2)); - // Mix into current frame - return AddAndClampToS16(accumulator, {mono, mono}); - }); - return; - - case OutputFormat::Surround: - // TODO(merry): Implement surround sound. - // fallthrough - - case OutputFormat::Stereo: - std::transform( - current_frame.begin(), current_frame.end(), samples.begin(), current_frame.begin(), - [gain](const std::array& accumulator, - const std::array& sample) -> std::array { - // Downmix to stereo - s16 left = ClampToS16(static_cast(gain * sample[0] + gain * sample[2])); - s16 right = ClampToS16(static_cast(gain * sample[1] + gain * sample[3])); - // Mix into current frame - return AddAndClampToS16(accumulator, {left, right}); - }); - return; - } - - UNREACHABLE_MSG("Invalid output_format %zu", static_cast(state.output_format)); -} - -void Mixers::AuxReturn(const IntermediateMixSamples& read_samples) { - // NOTE: read_samples.mix{1,2}.pcm32 annoyingly have their dimensions in reverse order to - // QuadFrame32. - - if (state.mixer1_enabled) { - for (size_t sample = 0; sample < samples_per_frame; sample++) { - for (size_t channel = 0; channel < 4; channel++) { - state.intermediate_mix_buffer[1][sample][channel] = - read_samples.mix1.pcm32[channel][sample]; - } - } - } - - if (state.mixer2_enabled) { - for (size_t sample = 0; sample < samples_per_frame; sample++) { - for (size_t channel = 0; channel < 4; channel++) { - state.intermediate_mix_buffer[2][sample][channel] = - read_samples.mix2.pcm32[channel][sample]; - } - } - } -} - -void Mixers::AuxSend(IntermediateMixSamples& write_samples, - const std::array& input) { - // NOTE: read_samples.mix{1,2}.pcm32 annoyingly have their dimensions in reverse order to - // QuadFrame32. - - state.intermediate_mix_buffer[0] = input[0]; - - if (state.mixer1_enabled) { - for (size_t sample = 0; sample < samples_per_frame; sample++) { - for (size_t channel = 0; channel < 4; channel++) { - write_samples.mix1.pcm32[channel][sample] = input[1][sample][channel]; - } - } - } else { - state.intermediate_mix_buffer[1] = input[1]; - } - - if (state.mixer2_enabled) { - for (size_t sample = 0; sample < samples_per_frame; sample++) { - for (size_t channel = 0; channel < 4; channel++) { - write_samples.mix2.pcm32[channel][sample] = input[2][sample][channel]; - } - } - } else { - state.intermediate_mix_buffer[2] = input[2]; - } -} - -void Mixers::MixCurrentFrame() { - current_frame.fill({}); - - for (size_t mix = 0; mix < 3; mix++) { - DownmixAndMixIntoCurrentFrame(state.intermediate_mixer_volume[mix], - state.intermediate_mix_buffer[mix]); - } - - // TODO(merry): Compressor. (We currently assume a disabled compressor.) -} - -DspStatus Mixers::GetCurrentStatus() const { - DspStatus status; - status.unknown = 0; - status.dropped_frames = 0; - return status; -} - -} // namespace HLE -} // namespace DSP diff --git a/src/audio_core/hle/mixers.h b/src/audio_core/hle/mixers.h deleted file mode 100644 index bf4e865ae..000000000 --- a/src/audio_core/hle/mixers.h +++ /dev/null @@ -1,61 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include "audio_core/hle/common.h" -#include "audio_core/hle/dsp.h" - -namespace DSP { -namespace HLE { - -class Mixers final { -public: - Mixers() { - Reset(); - } - - void Reset(); - - DspStatus Tick(DspConfiguration& config, const IntermediateMixSamples& read_samples, - IntermediateMixSamples& write_samples, const std::array& input); - - StereoFrame16 GetOutput() const { - return current_frame; - } - -private: - StereoFrame16 current_frame = {}; - - using OutputFormat = DspConfiguration::OutputFormat; - - struct { - std::array intermediate_mixer_volume = {}; - - bool mixer1_enabled = false; - bool mixer2_enabled = false; - std::array intermediate_mix_buffer = {}; - - OutputFormat output_format = OutputFormat::Stereo; - - } state; - - /// INTERNAL: Update our internal state based on the current config. - void ParseConfig(DspConfiguration& config); - /// INTERNAL: Read samples from shared memory that have been modified by the ARM11. - void AuxReturn(const IntermediateMixSamples& read_samples); - /// INTERNAL: Write samples to shared memory for the ARM11 to modify. - void AuxSend(IntermediateMixSamples& write_samples, const std::array& input); - /// INTERNAL: Mix current_frame. - void MixCurrentFrame(); - /// INTERNAL: Downmix from quadraphonic to stereo based on status.output_format and accumulate - /// into current_frame. - void DownmixAndMixIntoCurrentFrame(float gain, const QuadFrame32& samples); - /// INTERNAL: Generate DspStatus based on internal state. - DspStatus GetCurrentStatus() const; -}; - -} // namespace HLE -} // namespace DSP diff --git a/src/audio_core/hle/pipe.cpp b/src/audio_core/hle/pipe.cpp deleted file mode 100644 index 24074a514..000000000 --- a/src/audio_core/hle/pipe.cpp +++ /dev/null @@ -1,177 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#include -#include -#include "audio_core/hle/dsp.h" -#include "audio_core/hle/pipe.h" -#include "common/assert.h" -#include "common/common_types.h" -#include "common/logging/log.h" -#include "core/hle/service/dsp_dsp.h" - -namespace DSP { -namespace HLE { - -static DspState dsp_state = DspState::Off; - -static std::array, NUM_DSP_PIPE> pipe_data; - -void ResetPipes() { - for (auto& data : pipe_data) { - data.clear(); - } - dsp_state = DspState::Off; -} - -std::vector PipeRead(DspPipe pipe_number, u32 length) { - const size_t pipe_index = static_cast(pipe_number); - - if (pipe_index >= NUM_DSP_PIPE) { - LOG_ERROR(Audio_DSP, "pipe_number = %zu invalid", pipe_index); - return {}; - } - - if (length > UINT16_MAX) { // Can only read at most UINT16_MAX from the pipe - LOG_ERROR(Audio_DSP, "length of %u greater than max of %u", length, UINT16_MAX); - return {}; - } - - std::vector& data = pipe_data[pipe_index]; - - if (length > data.size()) { - LOG_WARNING( - Audio_DSP, - "pipe_number = %zu is out of data, application requested read of %u but %zu remain", - pipe_index, length, data.size()); - length = static_cast(data.size()); - } - - if (length == 0) - return {}; - - std::vector ret(data.begin(), data.begin() + length); - data.erase(data.begin(), data.begin() + length); - return ret; -} - -size_t GetPipeReadableSize(DspPipe pipe_number) { - const size_t pipe_index = static_cast(pipe_number); - - if (pipe_index >= NUM_DSP_PIPE) { - LOG_ERROR(Audio_DSP, "pipe_number = %zu invalid", pipe_index); - return 0; - } - - return pipe_data[pipe_index].size(); -} - -static void WriteU16(DspPipe pipe_number, u16 value) { - const size_t pipe_index = static_cast(pipe_number); - - std::vector& data = pipe_data.at(pipe_index); - // Little endian - data.emplace_back(value & 0xFF); - data.emplace_back(value >> 8); -} - -static void AudioPipeWriteStructAddresses() { - // These struct addresses are DSP dram addresses. - // See also: DSP_DSP::ConvertProcessAddressFromDspDram - static const std::array struct_addresses = { - 0x8000 + offsetof(SharedMemory, frame_counter) / 2, - 0x8000 + offsetof(SharedMemory, source_configurations) / 2, - 0x8000 + offsetof(SharedMemory, source_statuses) / 2, - 0x8000 + offsetof(SharedMemory, adpcm_coefficients) / 2, - 0x8000 + offsetof(SharedMemory, dsp_configuration) / 2, - 0x8000 + offsetof(SharedMemory, dsp_status) / 2, - 0x8000 + offsetof(SharedMemory, final_samples) / 2, - 0x8000 + offsetof(SharedMemory, intermediate_mix_samples) / 2, - 0x8000 + offsetof(SharedMemory, compressor) / 2, - 0x8000 + offsetof(SharedMemory, dsp_debug) / 2, - 0x8000 + offsetof(SharedMemory, unknown10) / 2, - 0x8000 + offsetof(SharedMemory, unknown11) / 2, - 0x8000 + offsetof(SharedMemory, unknown12) / 2, - 0x8000 + offsetof(SharedMemory, unknown13) / 2, - 0x8000 + offsetof(SharedMemory, unknown14) / 2, - }; - - // Begin with a u16 denoting the number of structs. - WriteU16(DspPipe::Audio, static_cast(struct_addresses.size())); - // Then write the struct addresses. - for (u16 addr : struct_addresses) { - WriteU16(DspPipe::Audio, addr); - } - // Signal that we have data on this pipe. - Service::DSP_DSP::SignalPipeInterrupt(DspPipe::Audio); -} - -void PipeWrite(DspPipe pipe_number, const std::vector& buffer) { - switch (pipe_number) { - case DspPipe::Audio: { - if (buffer.size() != 4) { - LOG_ERROR(Audio_DSP, "DspPipe::Audio: Unexpected buffer length %zu was written", - buffer.size()); - return; - } - - enum class StateChange { - Initialize = 0, - Shutdown = 1, - Wakeup = 2, - Sleep = 3, - }; - - // The difference between Initialize and Wakeup is that Input state is maintained - // when sleeping but isn't when turning it off and on again. (TODO: Implement this.) - // Waking up from sleep garbles some of the structs in the memory region. (TODO: - // Implement this.) Applications store away the state of these structs before - // sleeping and reset it back after wakeup on behalf of the DSP. - - switch (static_cast(buffer[0])) { - case StateChange::Initialize: - LOG_INFO(Audio_DSP, "Application has requested initialization of DSP hardware"); - ResetPipes(); - AudioPipeWriteStructAddresses(); - dsp_state = DspState::On; - break; - case StateChange::Shutdown: - LOG_INFO(Audio_DSP, "Application has requested shutdown of DSP hardware"); - dsp_state = DspState::Off; - break; - case StateChange::Wakeup: - LOG_INFO(Audio_DSP, "Application has requested wakeup of DSP hardware"); - ResetPipes(); - AudioPipeWriteStructAddresses(); - dsp_state = DspState::On; - break; - case StateChange::Sleep: - LOG_INFO(Audio_DSP, "Application has requested sleep of DSP hardware"); - UNIMPLEMENTED(); - dsp_state = DspState::Sleeping; - break; - default: - LOG_ERROR(Audio_DSP, - "Application has requested unknown state transition of DSP hardware %hhu", - buffer[0]); - dsp_state = DspState::Off; - break; - } - - return; - } - default: - LOG_CRITICAL(Audio_DSP, "pipe_number = %zu unimplemented", - static_cast(pipe_number)); - UNIMPLEMENTED(); - return; - } -} - -DspState GetDspState() { - return dsp_state; -} - -} // namespace HLE -} // namespace DSP diff --git a/src/audio_core/hle/pipe.h b/src/audio_core/hle/pipe.h deleted file mode 100644 index ac053c029..000000000 --- a/src/audio_core/hle/pipe.h +++ /dev/null @@ -1,63 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include -#include "common/common_types.h" - -namespace DSP { -namespace HLE { - -/// Reset the pipes by setting pipe positions back to the beginning. -void ResetPipes(); - -enum class DspPipe { - Debug = 0, - Dma = 1, - Audio = 2, - Binary = 3, -}; -constexpr size_t NUM_DSP_PIPE = 8; - -/** - * Reads `length` bytes from the DSP pipe identified with `pipe_number`. - * @note Can read up to the maximum value of a u16 in bytes (65,535). - * @note IF an error is encoutered with either an invalid `pipe_number` or `length` value, an empty - * vector will be returned. - * @note IF `length` is set to 0, an empty vector will be returned. - * @note IF `length` is greater than the amount of data available, this function will only read the - * available amount. - * @param pipe_number a `DspPipe` - * @param length the number of bytes to read. The max is 65,535 (max of u16). - * @returns a vector of bytes from the specified pipe. On error, will be empty. - */ -std::vector PipeRead(DspPipe pipe_number, u32 length); - -/** - * How much data is left in pipe - * @param pipe_number The Pipe ID - * @return The amount of data remaning in the pipe. This is the maximum length PipeRead will return. - */ -size_t GetPipeReadableSize(DspPipe pipe_number); - -/** - * Write to a DSP pipe. - * @param pipe_number The Pipe ID - * @param buffer The data to write to the pipe. - */ -void PipeWrite(DspPipe pipe_number, const std::vector& buffer); - -enum class DspState { - Off, - On, - Sleeping, -}; - -/// Get the state of the DSP -DspState GetDspState(); - -} // namespace HLE -} // namespace DSP diff --git a/src/audio_core/hle/source.cpp b/src/audio_core/hle/source.cpp deleted file mode 100644 index c12287700..000000000 --- a/src/audio_core/hle/source.cpp +++ /dev/null @@ -1,349 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#include -#include -#include "audio_core/codec.h" -#include "audio_core/hle/common.h" -#include "audio_core/hle/source.h" -#include "audio_core/interpolate.h" -#include "common/assert.h" -#include "common/logging/log.h" -#include "core/memory.h" - -namespace DSP { -namespace HLE { - -SourceStatus::Status Source::Tick(SourceConfiguration::Configuration& config, - const s16_le (&adpcm_coeffs)[16]) { - ParseConfig(config, adpcm_coeffs); - - if (state.enabled) { - GenerateFrame(); - } - - return GetCurrentStatus(); -} - -void Source::MixInto(QuadFrame32& dest, size_t intermediate_mix_id) const { - if (!state.enabled) - return; - - const std::array& gains = state.gain.at(intermediate_mix_id); - for (size_t samplei = 0; samplei < samples_per_frame; samplei++) { - // Conversion from stereo (current_frame) to quadraphonic (dest) occurs here. - dest[samplei][0] += static_cast(gains[0] * current_frame[samplei][0]); - dest[samplei][1] += static_cast(gains[1] * current_frame[samplei][1]); - dest[samplei][2] += static_cast(gains[2] * current_frame[samplei][0]); - dest[samplei][3] += static_cast(gains[3] * current_frame[samplei][1]); - } -} - -void Source::Reset() { - current_frame.fill({}); - state = {}; -} - -void Source::ParseConfig(SourceConfiguration::Configuration& config, - const s16_le (&adpcm_coeffs)[16]) { - if (!config.dirty_raw) { - return; - } - - if (config.reset_flag) { - config.reset_flag.Assign(0); - Reset(); - LOG_TRACE(Audio_DSP, "source_id=%zu reset", source_id); - } - - if (config.partial_reset_flag) { - config.partial_reset_flag.Assign(0); - state.input_queue = std::priority_queue, BufferOrder>{}; - LOG_TRACE(Audio_DSP, "source_id=%zu partial_reset", source_id); - } - - if (config.enable_dirty) { - config.enable_dirty.Assign(0); - state.enabled = config.enable != 0; - LOG_TRACE(Audio_DSP, "source_id=%zu enable=%d", source_id, state.enabled); - } - - if (config.sync_dirty) { - config.sync_dirty.Assign(0); - state.sync = config.sync; - LOG_TRACE(Audio_DSP, "source_id=%zu sync=%u", source_id, state.sync); - } - - if (config.rate_multiplier_dirty) { - config.rate_multiplier_dirty.Assign(0); - state.rate_multiplier = config.rate_multiplier; - LOG_TRACE(Audio_DSP, "source_id=%zu rate=%f", source_id, state.rate_multiplier); - - if (state.rate_multiplier <= 0) { - LOG_ERROR(Audio_DSP, "Was given an invalid rate multiplier: source_id=%zu rate=%f", - source_id, state.rate_multiplier); - state.rate_multiplier = 1.0f; - // Note: Actual firmware starts producing garbage if this occurs. - } - } - - if (config.adpcm_coefficients_dirty) { - config.adpcm_coefficients_dirty.Assign(0); - std::transform(adpcm_coeffs, adpcm_coeffs + state.adpcm_coeffs.size(), - state.adpcm_coeffs.begin(), - [](const auto& coeff) { return static_cast(coeff); }); - LOG_TRACE(Audio_DSP, "source_id=%zu adpcm update", source_id); - } - - if (config.gain_0_dirty) { - config.gain_0_dirty.Assign(0); - std::transform(config.gain[0], config.gain[0] + state.gain[0].size(), state.gain[0].begin(), - [](const auto& coeff) { return static_cast(coeff); }); - LOG_TRACE(Audio_DSP, "source_id=%zu gain 0 update", source_id); - } - - if (config.gain_1_dirty) { - config.gain_1_dirty.Assign(0); - std::transform(config.gain[1], config.gain[1] + state.gain[1].size(), state.gain[1].begin(), - [](const auto& coeff) { return static_cast(coeff); }); - LOG_TRACE(Audio_DSP, "source_id=%zu gain 1 update", source_id); - } - - if (config.gain_2_dirty) { - config.gain_2_dirty.Assign(0); - std::transform(config.gain[2], config.gain[2] + state.gain[2].size(), state.gain[2].begin(), - [](const auto& coeff) { return static_cast(coeff); }); - LOG_TRACE(Audio_DSP, "source_id=%zu gain 2 update", source_id); - } - - if (config.filters_enabled_dirty) { - config.filters_enabled_dirty.Assign(0); - state.filters.Enable(config.simple_filter_enabled.ToBool(), - config.biquad_filter_enabled.ToBool()); - LOG_TRACE(Audio_DSP, "source_id=%zu enable_simple=%hu enable_biquad=%hu", source_id, - config.simple_filter_enabled.Value(), config.biquad_filter_enabled.Value()); - } - - if (config.simple_filter_dirty) { - config.simple_filter_dirty.Assign(0); - state.filters.Configure(config.simple_filter); - LOG_TRACE(Audio_DSP, "source_id=%zu simple filter update", source_id); - } - - if (config.biquad_filter_dirty) { - config.biquad_filter_dirty.Assign(0); - state.filters.Configure(config.biquad_filter); - LOG_TRACE(Audio_DSP, "source_id=%zu biquad filter update", source_id); - } - - if (config.interpolation_dirty) { - config.interpolation_dirty.Assign(0); - state.interpolation_mode = config.interpolation_mode; - LOG_TRACE(Audio_DSP, "source_id=%zu interpolation_mode=%zu", source_id, - static_cast(state.interpolation_mode)); - } - - if (config.format_dirty || config.embedded_buffer_dirty) { - config.format_dirty.Assign(0); - state.format = config.format; - LOG_TRACE(Audio_DSP, "source_id=%zu format=%zu", source_id, - static_cast(state.format)); - } - - if (config.mono_or_stereo_dirty || config.embedded_buffer_dirty) { - config.mono_or_stereo_dirty.Assign(0); - state.mono_or_stereo = config.mono_or_stereo; - LOG_TRACE(Audio_DSP, "source_id=%zu mono_or_stereo=%zu", source_id, - static_cast(state.mono_or_stereo)); - } - - u32_dsp play_position = {}; - if (config.play_position_dirty && config.play_position != 0) { - config.play_position_dirty.Assign(0); - play_position = config.play_position; - // play_position applies only to the embedded buffer, and defaults to 0 w/o a dirty bit - // This will be the starting sample for the first time the buffer is played. - } - - if (config.embedded_buffer_dirty) { - config.embedded_buffer_dirty.Assign(0); - state.input_queue.emplace(Buffer{ - config.physical_address, - config.length, - static_cast(config.adpcm_ps), - {config.adpcm_yn[0], config.adpcm_yn[1]}, - config.adpcm_dirty.ToBool(), - config.is_looping.ToBool(), - config.buffer_id, - state.mono_or_stereo, - state.format, - false, - play_position, - false, - }); - LOG_TRACE(Audio_DSP, "enqueuing embedded addr=0x%08x len=%u id=%hu start=%u", - config.physical_address, config.length, config.buffer_id, - static_cast(config.play_position)); - } - - if (config.loop_related_dirty && config.loop_related != 0) { - config.loop_related_dirty.Assign(0); - LOG_WARNING(Audio_DSP, "Unhandled complex loop with loop_related=0x%08x", - static_cast(config.loop_related)); - } - - if (config.buffer_queue_dirty) { - config.buffer_queue_dirty.Assign(0); - for (size_t i = 0; i < 4; i++) { - if (config.buffers_dirty & (1 << i)) { - const auto& b = config.buffers[i]; - state.input_queue.emplace(Buffer{ - b.physical_address, - b.length, - static_cast(b.adpcm_ps), - {b.adpcm_yn[0], b.adpcm_yn[1]}, - b.adpcm_dirty != 0, - b.is_looping != 0, - b.buffer_id, - state.mono_or_stereo, - state.format, - true, - {}, // 0 in u32_dsp - false, - }); - LOG_TRACE(Audio_DSP, "enqueuing queued %zu addr=0x%08x len=%u id=%hu", i, - b.physical_address, b.length, b.buffer_id); - } - } - config.buffers_dirty = 0; - } - - if (config.dirty_raw) { - LOG_DEBUG(Audio_DSP, "source_id=%zu remaining_dirty=%x", source_id, config.dirty_raw); - } - - config.dirty_raw = 0; -} - -void Source::GenerateFrame() { - current_frame.fill({}); - - if (state.current_buffer.empty() && !DequeueBuffer()) { - state.enabled = false; - state.buffer_update = true; - state.current_buffer_id = 0; - return; - } - - size_t frame_position = 0; - - state.current_sample_number = state.next_sample_number; - while (frame_position < current_frame.size()) { - if (state.current_buffer.empty() && !DequeueBuffer()) { - break; - } - - switch (state.interpolation_mode) { - case InterpolationMode::None: - AudioInterp::None(state.interp_state, state.current_buffer, state.rate_multiplier, - current_frame, frame_position); - break; - case InterpolationMode::Linear: - AudioInterp::Linear(state.interp_state, state.current_buffer, state.rate_multiplier, - current_frame, frame_position); - break; - case InterpolationMode::Polyphase: - // TODO(merry): Implement polyphase interpolation - LOG_DEBUG(Audio_DSP, "Polyphase interpolation unimplemented; falling back to linear"); - AudioInterp::Linear(state.interp_state, state.current_buffer, state.rate_multiplier, - current_frame, frame_position); - break; - default: - UNIMPLEMENTED(); - break; - } - } - state.next_sample_number += static_cast(frame_position); - - state.filters.ProcessFrame(current_frame); -} - -bool Source::DequeueBuffer() { - ASSERT_MSG(state.current_buffer.empty(), - "Shouldn't dequeue; we still have data in current_buffer"); - - if (state.input_queue.empty()) - return false; - - Buffer buf = state.input_queue.top(); - - // if we're in a loop, the current sound keeps playing afterwards, so leave the queue alone - if (!buf.is_looping) { - state.input_queue.pop(); - } - - if (buf.adpcm_dirty) { - state.adpcm_state.yn1 = buf.adpcm_yn[0]; - state.adpcm_state.yn2 = buf.adpcm_yn[1]; - } - - const u8* const memory = Memory::GetPhysicalPointer(buf.physical_address); - if (memory) { - const unsigned num_channels = buf.mono_or_stereo == MonoOrStereo::Stereo ? 2 : 1; - switch (buf.format) { - case Format::PCM8: - state.current_buffer = Codec::DecodePCM8(num_channels, memory, buf.length); - break; - case Format::PCM16: - state.current_buffer = Codec::DecodePCM16(num_channels, memory, buf.length); - break; - case Format::ADPCM: - DEBUG_ASSERT(num_channels == 1); - state.current_buffer = - Codec::DecodeADPCM(memory, buf.length, state.adpcm_coeffs, state.adpcm_state); - break; - default: - UNIMPLEMENTED(); - break; - } - } else { - LOG_WARNING(Audio_DSP, - "source_id=%zu buffer_id=%hu length=%u: Invalid physical address 0x%08X", - source_id, buf.buffer_id, buf.length, buf.physical_address); - state.current_buffer.clear(); - return true; - } - - // the first playthrough starts at play_position, loops start at the beginning of the buffer - state.current_sample_number = (!buf.has_played) ? buf.play_position : 0; - state.next_sample_number = state.current_sample_number; - state.current_buffer_id = buf.buffer_id; - state.buffer_update = buf.from_queue && !buf.has_played; - - buf.has_played = true; - - LOG_TRACE(Audio_DSP, "source_id=%zu buffer_id=%hu from_queue=%s current_buffer.size()=%zu", - source_id, buf.buffer_id, buf.from_queue ? "true" : "false", - state.current_buffer.size()); - return true; -} - -SourceStatus::Status Source::GetCurrentStatus() { - SourceStatus::Status ret; - - // Applications depend on the correct emulation of - // current_buffer_id_dirty and current_buffer_id to synchronise - // audio with video. - ret.is_enabled = state.enabled; - ret.current_buffer_id_dirty = state.buffer_update ? 1 : 0; - state.buffer_update = false; - ret.current_buffer_id = state.current_buffer_id; - ret.buffer_position = state.current_sample_number; - ret.sync = state.sync; - - return ret; -} - -} // namespace HLE -} // namespace DSP diff --git a/src/audio_core/hle/source.h b/src/audio_core/hle/source.h deleted file mode 100644 index c4d2debc2..000000000 --- a/src/audio_core/hle/source.h +++ /dev/null @@ -1,149 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include -#include -#include "audio_core/codec.h" -#include "audio_core/hle/common.h" -#include "audio_core/hle/dsp.h" -#include "audio_core/hle/filter.h" -#include "audio_core/interpolate.h" -#include "common/common_types.h" - -namespace DSP { -namespace HLE { - -/** - * This module performs: - * - Buffer management - * - Decoding of buffers - * - Buffer resampling and interpolation - * - Per-source filtering (SimpleFilter, BiquadFilter) - * - Per-source gain - * - Other per-source processing - */ -class Source final { -public: - explicit Source(size_t source_id_) : source_id(source_id_) { - Reset(); - } - - /// Resets internal state. - void Reset(); - - /** - * This is called once every audio frame. This performs per-source processing every frame. - * @param config The new configuration we've got for this Source from the application. - * @param adpcm_coeffs ADPCM coefficients to use if config tells us to use them (may contain - * invalid values otherwise). - * @return The current status of this Source. This is given back to the emulated application via - * SharedMemory. - */ - SourceStatus::Status Tick(SourceConfiguration::Configuration& config, - const s16_le (&adpcm_coeffs)[16]); - - /** - * Mix this source's output into dest, using the gains for the `intermediate_mix_id`-th - * intermediate mixer. - * @param dest The QuadFrame32 to mix into. - * @param intermediate_mix_id The id of the intermediate mix whose gains we are using. - */ - void MixInto(QuadFrame32& dest, size_t intermediate_mix_id) const; - -private: - const size_t source_id; - StereoFrame16 current_frame; - - using Format = SourceConfiguration::Configuration::Format; - using InterpolationMode = SourceConfiguration::Configuration::InterpolationMode; - using MonoOrStereo = SourceConfiguration::Configuration::MonoOrStereo; - - /// Internal representation of a buffer for our buffer queue - struct Buffer { - PAddr physical_address; - u32 length; - u8 adpcm_ps; - std::array adpcm_yn; - bool adpcm_dirty; - bool is_looping; - u16 buffer_id; - - MonoOrStereo mono_or_stereo; - Format format; - - bool from_queue; - u32_dsp play_position; // = 0; - bool has_played; // = false; - }; - - struct BufferOrder { - bool operator()(const Buffer& a, const Buffer& b) const { - // Lower buffer_id comes first. - return a.buffer_id > b.buffer_id; - } - }; - - struct { - - // State variables - - bool enabled = false; - u16 sync = 0; - - // Mixing - - std::array, 3> gain = {}; - - // Buffer queue - - std::priority_queue, BufferOrder> input_queue; - MonoOrStereo mono_or_stereo = MonoOrStereo::Mono; - Format format = Format::ADPCM; - - // Current buffer - - u32 current_sample_number = 0; - u32 next_sample_number = 0; - AudioInterp::StereoBuffer16 current_buffer; - - // buffer_id state - - bool buffer_update = false; - u32 current_buffer_id = 0; - - // Decoding state - - std::array adpcm_coeffs = {}; - Codec::ADPCMState adpcm_state = {}; - - // Resampling state - - float rate_multiplier = 1.0; - InterpolationMode interpolation_mode = InterpolationMode::Polyphase; - AudioInterp::State interp_state = {}; - - // Filter state - - SourceFilters filters; - - } state; - - // Internal functions - - /// INTERNAL: Update our internal state based on the current config. - void ParseConfig(SourceConfiguration::Configuration& config, const s16_le (&adpcm_coeffs)[16]); - /// INTERNAL: Generate the current audio output for this frame based on our internal state. - void GenerateFrame(); - /// INTERNAL: Dequeues a buffer and does preprocessing on it (decoding, resampling). Puts it - /// into current_buffer. - bool DequeueBuffer(); - /// INTERNAL: Generates a SourceStatus::Status based on our internal state. - SourceStatus::Status GetCurrentStatus(); -}; - -} // namespace HLE -} // namespace DSP diff --git a/src/audio_core/interpolate.cpp b/src/audio_core/interpolate.cpp deleted file mode 100644 index 83573d772..000000000 --- a/src/audio_core/interpolate.cpp +++ /dev/null @@ -1,76 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#include "audio_core/interpolate.h" -#include "common/assert.h" -#include "common/math_util.h" - -namespace AudioInterp { - -// Calculations are done in fixed point with 24 fractional bits. -// (This is not verified. This was chosen for minimal error.) -constexpr u64 scale_factor = 1 << 24; -constexpr u64 scale_mask = scale_factor - 1; - -/// Here we step over the input in steps of rate, until we consume all of the input. -/// Three adjacent samples are passed to fn each step. -template -static void StepOverSamples(State& state, StereoBuffer16& input, float rate, - DSP::HLE::StereoFrame16& output, size_t& outputi, Function fn) { - ASSERT(rate > 0); - - if (input.empty()) - return; - - input.insert(input.begin(), {state.xn2, state.xn1}); - - const u64 step_size = static_cast(rate * scale_factor); - u64 fposition = state.fposition; - size_t inputi = 0; - - while (outputi < output.size()) { - inputi = static_cast(fposition / scale_factor); - - if (inputi + 2 >= input.size()) { - inputi = input.size() - 2; - break; - } - - u64 fraction = fposition & scale_mask; - output[outputi++] = fn(fraction, input[inputi], input[inputi + 1], input[inputi + 2]); - - fposition += step_size; - } - - state.xn2 = input[inputi]; - state.xn1 = input[inputi + 1]; - state.fposition = fposition - inputi * scale_factor; - - input.erase(input.begin(), std::next(input.begin(), inputi + 2)); -} - -void None(State& state, StereoBuffer16& input, float rate, DSP::HLE::StereoFrame16& output, - size_t& outputi) { - StepOverSamples( - state, input, rate, output, outputi, - [](u64 fraction, const auto& x0, const auto& x1, const auto& x2) { return x0; }); -} - -void Linear(State& state, StereoBuffer16& input, float rate, DSP::HLE::StereoFrame16& output, - size_t& outputi) { - // Note on accuracy: Some values that this produces are +/- 1 from the actual firmware. - StepOverSamples(state, input, rate, output, outputi, - [](u64 fraction, const auto& x0, const auto& x1, const auto& x2) { - // This is a saturated subtraction. (Verified by black-box fuzzing.) - s64 delta0 = MathUtil::Clamp(x1[0] - x0[0], -32768, 32767); - s64 delta1 = MathUtil::Clamp(x1[1] - x0[1], -32768, 32767); - - return std::array{ - static_cast(x0[0] + fraction * delta0 / scale_factor), - static_cast(x0[1] + fraction * delta1 / scale_factor), - }; - }); -} - -} // namespace AudioInterp diff --git a/src/audio_core/interpolate.h b/src/audio_core/interpolate.h deleted file mode 100644 index 8dff6111a..000000000 --- a/src/audio_core/interpolate.h +++ /dev/null @@ -1,49 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include -#include "audio_core/hle/common.h" -#include "common/common_types.h" - -namespace AudioInterp { - -/// A variable length buffer of signed PCM16 stereo samples. -using StereoBuffer16 = std::deque>; - -struct State { - /// Two historical samples. - std::array xn1 = {}; ///< x[n-1] - std::array xn2 = {}; ///< x[n-2] - /// Current fractional position. - u64 fposition = 0; -}; - -/** - * No interpolation. This is equivalent to a zero-order hold. There is a two-sample predelay. - * @param state Interpolation state. - * @param input Input buffer. - * @param rate Stretch factor. Must be a positive non-zero value. - * rate > 1.0 performs decimation and rate < 1.0 performs upsampling. - * @param output The resampled audio buffer. - * @param outputi The index of output to start writing to. - */ -void None(State& state, StereoBuffer16& input, float rate, DSP::HLE::StereoFrame16& output, - size_t& outputi); - -/** - * Linear interpolation. This is equivalent to a first-order hold. There is a two-sample predelay. - * @param state Interpolation state. - * @param input Input buffer. - * @param rate Stretch factor. Must be a positive non-zero value. - * rate > 1.0 performs decimation and rate < 1.0 performs upsampling. - * @param output The resampled audio buffer. - * @param outputi The index of output to start writing to. - */ -void Linear(State& state, StereoBuffer16& input, float rate, DSP::HLE::StereoFrame16& output, - size_t& outputi); - -} // namespace AudioInterp diff --git a/src/audio_core/null_sink.h b/src/audio_core/null_sink.h deleted file mode 100644 index c732926a2..000000000 --- a/src/audio_core/null_sink.h +++ /dev/null @@ -1,34 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include "audio_core/audio_core.h" -#include "audio_core/sink.h" - -namespace AudioCore { - -class NullSink final : public Sink { -public: - ~NullSink() override = default; - - unsigned int GetNativeSampleRate() const override { - return native_sample_rate; - } - - void EnqueueSamples(const s16*, size_t) override {} - - size_t SamplesInQueue() const override { - return 0; - } - - void SetDevice(int device_id) override {} - - std::vector GetDeviceList() const override { - return {}; - } -}; - -} // namespace AudioCore diff --git a/src/audio_core/sdl2_sink.cpp b/src/audio_core/sdl2_sink.cpp deleted file mode 100644 index 933c5f16d..000000000 --- a/src/audio_core/sdl2_sink.cpp +++ /dev/null @@ -1,147 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#include -#include -#include -#include "audio_core/audio_core.h" -#include "audio_core/sdl2_sink.h" -#include "common/assert.h" -#include "common/logging/log.h" -#include "core/settings.h" - -namespace AudioCore { - -struct SDL2Sink::Impl { - unsigned int sample_rate = 0; - - SDL_AudioDeviceID audio_device_id = 0; - - std::list> queue; - - static void Callback(void* impl_, u8* buffer, int buffer_size_in_bytes); -}; - -SDL2Sink::SDL2Sink() : impl(std::make_unique()) { - if (SDL_Init(SDL_INIT_AUDIO) < 0) { - LOG_CRITICAL(Audio_Sink, "SDL_Init(SDL_INIT_AUDIO) failed with: %s", SDL_GetError()); - impl->audio_device_id = 0; - return; - } - - SDL_AudioSpec desired_audiospec; - SDL_zero(desired_audiospec); - desired_audiospec.format = AUDIO_S16; - desired_audiospec.channels = 2; - desired_audiospec.freq = native_sample_rate; - desired_audiospec.samples = 512; - desired_audiospec.userdata = impl.get(); - desired_audiospec.callback = &Impl::Callback; - - SDL_AudioSpec obtained_audiospec; - SDL_zero(obtained_audiospec); - - int device_count = SDL_GetNumAudioDevices(0); - device_list.clear(); - for (int i = 0; i < device_count; ++i) { - device_list.push_back(SDL_GetAudioDeviceName(i, 0)); - } - - const char* device = nullptr; - - if (device_count >= 1 && Settings::values.audio_device_id != "auto" && - !Settings::values.audio_device_id.empty()) { - device = Settings::values.audio_device_id.c_str(); - } - - impl->audio_device_id = SDL_OpenAudioDevice(device, false, &desired_audiospec, - &obtained_audiospec, SDL_AUDIO_ALLOW_ANY_CHANGE); - if (impl->audio_device_id <= 0) { - LOG_CRITICAL(Audio_Sink, "SDL_OpenAudioDevice failed with code %d for device \"%s\"", - impl->audio_device_id, Settings::values.audio_device_id.c_str()); - return; - } - - impl->sample_rate = obtained_audiospec.freq; - - // SDL2 audio devices start out paused, unpause it: - SDL_PauseAudioDevice(impl->audio_device_id, 0); -} - -SDL2Sink::~SDL2Sink() { - if (impl->audio_device_id <= 0) - return; - - SDL_CloseAudioDevice(impl->audio_device_id); -} - -unsigned int SDL2Sink::GetNativeSampleRate() const { - if (impl->audio_device_id <= 0) - return native_sample_rate; - - return impl->sample_rate; -} - -std::vector SDL2Sink::GetDeviceList() const { - return device_list; -} - -void SDL2Sink::EnqueueSamples(const s16* samples, size_t sample_count) { - if (impl->audio_device_id <= 0) - return; - - SDL_LockAudioDevice(impl->audio_device_id); - impl->queue.emplace_back(samples, samples + sample_count * 2); - SDL_UnlockAudioDevice(impl->audio_device_id); -} - -size_t SDL2Sink::SamplesInQueue() const { - if (impl->audio_device_id <= 0) - return 0; - - SDL_LockAudioDevice(impl->audio_device_id); - - size_t total_size = std::accumulate(impl->queue.begin(), impl->queue.end(), - static_cast(0), [](size_t sum, const auto& buffer) { - // Division by two because each stereo sample is made of - // two s16. - return sum + buffer.size() / 2; - }); - - SDL_UnlockAudioDevice(impl->audio_device_id); - - return total_size; -} - -void SDL2Sink::SetDevice(int device_id) { - this->device_id = device_id; -} - -void SDL2Sink::Impl::Callback(void* impl_, u8* buffer, int buffer_size_in_bytes) { - Impl* impl = reinterpret_cast(impl_); - - size_t remaining_size = static_cast(buffer_size_in_bytes) / - sizeof(s16); // Keep track of size in 16-bit increments. - - while (remaining_size > 0 && !impl->queue.empty()) { - if (impl->queue.front().size() <= remaining_size) { - memcpy(buffer, impl->queue.front().data(), impl->queue.front().size() * sizeof(s16)); - buffer += impl->queue.front().size() * sizeof(s16); - remaining_size -= impl->queue.front().size(); - impl->queue.pop_front(); - } else { - memcpy(buffer, impl->queue.front().data(), remaining_size * sizeof(s16)); - buffer += remaining_size * sizeof(s16); - impl->queue.front().erase(impl->queue.front().begin(), - impl->queue.front().begin() + remaining_size); - remaining_size = 0; - } - } - - if (remaining_size > 0) { - memset(buffer, 0, remaining_size * sizeof(s16)); - } -} - -} // namespace AudioCore diff --git a/src/audio_core/sdl2_sink.h b/src/audio_core/sdl2_sink.h deleted file mode 100644 index bcc725369..000000000 --- a/src/audio_core/sdl2_sink.h +++ /dev/null @@ -1,34 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include -#include "audio_core/sink.h" - -namespace AudioCore { - -class SDL2Sink final : public Sink { -public: - SDL2Sink(); - ~SDL2Sink() override; - - unsigned int GetNativeSampleRate() const override; - - void EnqueueSamples(const s16* samples, size_t sample_count) override; - - size_t SamplesInQueue() const override; - - std::vector GetDeviceList() const override; - void SetDevice(int device_id) override; - -private: - struct Impl; - std::unique_ptr impl; - int device_id; - std::vector device_list; -}; - -} // namespace AudioCore diff --git a/src/audio_core/sink.h b/src/audio_core/sink.h deleted file mode 100644 index c69cb2c74..000000000 --- a/src/audio_core/sink.h +++ /dev/null @@ -1,45 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include "common/common_types.h" - -namespace AudioCore { - -/** - * This class is an interface for an audio sink. An audio sink accepts samples in stereo signed - * PCM16 format to be output. Sinks *do not* handle resampling and expect the correct sample rate. - * They are dumb outputs. - */ -class Sink { -public: - virtual ~Sink() = default; - - /// The native rate of this sink. The sink expects to be fed samples that respect this. (Units: - /// samples/sec) - virtual unsigned int GetNativeSampleRate() const = 0; - - /** - * Feed stereo samples to sink. - * @param samples Samples in interleaved stereo PCM16 format. - * @param sample_count Number of samples. - */ - virtual void EnqueueSamples(const s16* samples, size_t sample_count) = 0; - - /// Samples enqueued that have not been played yet. - virtual std::size_t SamplesInQueue() const = 0; - - /** - * Sets the desired output device. - * @param device_id ID of the desired device. - */ - virtual void SetDevice(int device_id) = 0; - - /// Returns the list of available devices. - virtual std::vector GetDeviceList() const = 0; -}; - -} // namespace diff --git a/src/audio_core/sink_details.cpp b/src/audio_core/sink_details.cpp deleted file mode 100644 index 6972395af..000000000 --- a/src/audio_core/sink_details.cpp +++ /dev/null @@ -1,42 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#include -#include -#include -#include "audio_core/null_sink.h" -#include "audio_core/sink_details.h" -#ifdef HAVE_SDL2 -#include "audio_core/sdl2_sink.h" -#endif -#include "common/logging/log.h" - -namespace AudioCore { - -// g_sink_details is ordered in terms of desirability, with the best choice at the top. -const std::vector g_sink_details = { -#ifdef HAVE_SDL2 - {"sdl2", []() { return std::make_unique(); }}, -#endif - {"null", []() { return std::make_unique(); }}, -}; - -const SinkDetails& GetSinkDetails(std::string sink_id) { - auto iter = - std::find_if(g_sink_details.begin(), g_sink_details.end(), - [sink_id](const auto& sink_detail) { return sink_detail.id == sink_id; }); - - if (sink_id == "auto" || iter == g_sink_details.end()) { - if (sink_id != "auto") { - LOG_ERROR(Audio, "AudioCore::SelectSink given invalid sink_id %s", sink_id.c_str()); - } - // Auto-select. - // g_sink_details is ordered in terms of desirability, with the best choice at the front. - iter = g_sink_details.begin(); - } - - return *iter; -} - -} // namespace AudioCore diff --git a/src/audio_core/sink_details.h b/src/audio_core/sink_details.h deleted file mode 100644 index 9d3735171..000000000 --- a/src/audio_core/sink_details.h +++ /dev/null @@ -1,29 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include -#include - -namespace AudioCore { - -class Sink; - -struct SinkDetails { - SinkDetails(const char* id_, std::function()> factory_) - : id(id_), factory(factory_) {} - - /// Name for this sink. - const char* id; - /// A method to call to construct an instance of this type of sink. - std::function()> factory; -}; - -extern const std::vector g_sink_details; - -const SinkDetails& GetSinkDetails(std::string sink_id); - -} // namespace AudioCore diff --git a/src/audio_core/time_stretch.cpp b/src/audio_core/time_stretch.cpp deleted file mode 100644 index 437cf9752..000000000 --- a/src/audio_core/time_stretch.cpp +++ /dev/null @@ -1,143 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#include -#include -#include -#include -#include "audio_core/audio_core.h" -#include "audio_core/time_stretch.h" -#include "common/common_types.h" -#include "common/logging/log.h" -#include "common/math_util.h" - -using steady_clock = std::chrono::steady_clock; - -namespace AudioCore { - -constexpr double MIN_RATIO = 0.1; -constexpr double MAX_RATIO = 100.0; - -static double ClampRatio(double ratio) { - return MathUtil::Clamp(ratio, MIN_RATIO, MAX_RATIO); -} - -constexpr double MIN_DELAY_TIME = 0.05; // Units: seconds -constexpr double MAX_DELAY_TIME = 0.25; // Units: seconds -constexpr size_t DROP_FRAMES_SAMPLE_DELAY = 16000; // Units: samples - -constexpr double SMOOTHING_FACTOR = 0.007; - -struct TimeStretcher::Impl { - soundtouch::SoundTouch soundtouch; - - steady_clock::time_point frame_timer = steady_clock::now(); - size_t samples_queued = 0; - - double smoothed_ratio = 1.0; - - double sample_rate = static_cast(native_sample_rate); -}; - -std::vector TimeStretcher::Process(size_t samples_in_queue) { - // This is a very simple algorithm without any fancy control theory. It works and is stable. - - double ratio = CalculateCurrentRatio(); - ratio = CorrectForUnderAndOverflow(ratio, samples_in_queue); - impl->smoothed_ratio = - (1.0 - SMOOTHING_FACTOR) * impl->smoothed_ratio + SMOOTHING_FACTOR * ratio; - impl->smoothed_ratio = ClampRatio(impl->smoothed_ratio); - - // SoundTouch's tempo definition the inverse of our ratio definition. - impl->soundtouch.setTempo(1.0 / impl->smoothed_ratio); - - std::vector samples = GetSamples(); - if (samples_in_queue >= DROP_FRAMES_SAMPLE_DELAY) { - samples.clear(); - LOG_TRACE(Audio, "Dropping frames!"); - } - return samples; -} - -TimeStretcher::TimeStretcher() : impl(std::make_unique()) { - impl->soundtouch.setPitch(1.0); - impl->soundtouch.setChannels(2); - impl->soundtouch.setSampleRate(native_sample_rate); - Reset(); -} - -TimeStretcher::~TimeStretcher() { - impl->soundtouch.clear(); -} - -void TimeStretcher::SetOutputSampleRate(unsigned int sample_rate) { - impl->sample_rate = static_cast(sample_rate); - impl->soundtouch.setRate(static_cast(native_sample_rate) / impl->sample_rate); -} - -void TimeStretcher::AddSamples(const s16* buffer, size_t num_samples) { - impl->soundtouch.putSamples(buffer, static_cast(num_samples)); - impl->samples_queued += num_samples; -} - -void TimeStretcher::Flush() { - impl->soundtouch.flush(); -} - -void TimeStretcher::Reset() { - impl->soundtouch.setTempo(1.0); - impl->soundtouch.clear(); - impl->smoothed_ratio = 1.0; - impl->frame_timer = steady_clock::now(); - impl->samples_queued = 0; - SetOutputSampleRate(native_sample_rate); -} - -double TimeStretcher::CalculateCurrentRatio() { - const steady_clock::time_point now = steady_clock::now(); - const std::chrono::duration duration = now - impl->frame_timer; - - const double expected_time = - static_cast(impl->samples_queued) / static_cast(native_sample_rate); - const double actual_time = duration.count(); - - double ratio; - if (expected_time != 0) { - ratio = ClampRatio(actual_time / expected_time); - } else { - ratio = impl->smoothed_ratio; - } - - impl->frame_timer = now; - impl->samples_queued = 0; - - return ratio; -} - -double TimeStretcher::CorrectForUnderAndOverflow(double ratio, size_t sample_delay) const { - const size_t min_sample_delay = static_cast(MIN_DELAY_TIME * impl->sample_rate); - const size_t max_sample_delay = static_cast(MAX_DELAY_TIME * impl->sample_rate); - - if (sample_delay < min_sample_delay) { - // Make the ratio bigger. - ratio = ratio > 1.0 ? ratio * ratio : sqrt(ratio); - } else if (sample_delay > max_sample_delay) { - // Make the ratio smaller. - ratio = ratio > 1.0 ? sqrt(ratio) : ratio * ratio; - } - - return ClampRatio(ratio); -} - -std::vector TimeStretcher::GetSamples() { - uint available = impl->soundtouch.numSamples(); - - std::vector output(static_cast(available) * 2); - - impl->soundtouch.receiveSamples(output.data(), available); - - return output; -} - -} // namespace AudioCore diff --git a/src/audio_core/time_stretch.h b/src/audio_core/time_stretch.h deleted file mode 100644 index c98b16705..000000000 --- a/src/audio_core/time_stretch.h +++ /dev/null @@ -1,60 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include -#include -#include "common/common_types.h" - -namespace AudioCore { - -class TimeStretcher final { -public: - TimeStretcher(); - ~TimeStretcher(); - - /** - * Set sample rate for the samples that Process returns. - * @param sample_rate The sample rate. - */ - void SetOutputSampleRate(unsigned int sample_rate); - - /** - * Add samples to be processed. - * @param sample_buffer Buffer of samples in interleaved stereo PCM16 format. - * @param num_samples Number of samples. - */ - void AddSamples(const s16* sample_buffer, size_t num_samples); - - /// Flush audio remaining in internal buffers. - void Flush(); - - /// Resets internal state and clears buffers. - void Reset(); - - /** - * Does audio stretching and produces the time-stretched samples. - * Timer calculations use sample_delay to determine how much of a margin we have. - * @param sample_delay How many samples are buffered downstream of this module and haven't been - * played yet. - * @return Samples to play in interleaved stereo PCM16 format. - */ - std::vector Process(size_t sample_delay); - -private: - struct Impl; - std::unique_ptr impl; - - /// INTERNAL: ratio = wallclock time / emulated time - double CalculateCurrentRatio(); - /// INTERNAL: If we have too many or too few samples downstream, nudge ratio in the appropriate - /// direction. - double CorrectForUnderAndOverflow(double ratio, size_t sample_delay) const; - /// INTERNAL: Gets the time-stretched samples from SoundTouch. - std::vector GetSamples(); -}; - -} // namespace AudioCore diff --git a/src/citra/CMakeLists.txt b/src/citra/CMakeLists.txt deleted file mode 100644 index ed92a6ae2..000000000 --- a/src/citra/CMakeLists.txt +++ /dev/null @@ -1,35 +0,0 @@ -set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} ${PROJECT_SOURCE_DIR}/CMakeModules) - -set(SRCS - emu_window/emu_window_sdl2.cpp - citra.cpp - config.cpp - citra.rc - ) -set(HEADERS - emu_window/emu_window_sdl2.h - config.h - default_ini.h - resource.h - ) - -create_directory_groups(${SRCS} ${HEADERS}) - -add_executable(citra ${SRCS} ${HEADERS}) -target_link_libraries(citra PRIVATE common core input_common network) -target_link_libraries(citra PRIVATE inih glad) -if (MSVC) - target_link_libraries(citra PRIVATE getopt) -endif() -target_link_libraries(citra PRIVATE ${PLATFORM_LIBRARIES} SDL2 Threads::Threads) - -if(UNIX AND NOT APPLE) - install(TARGETS citra RUNTIME DESTINATION "${CMAKE_INSTALL_PREFIX}/bin") -endif() - -if (MSVC) - include(CopyCitraSDLDeps) - include(CopyYuzuUnicornDeps) - copy_citra_SDL_deps(citra) - copy_yuzu_unicorn_deps(citra) -endif() diff --git a/src/citra/citra.cpp b/src/citra/citra.cpp deleted file mode 100644 index e524c5535..000000000 --- a/src/citra/citra.cpp +++ /dev/null @@ -1,175 +0,0 @@ -// Copyright 2014 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#include -#include -#include -#include - -// This needs to be included before getopt.h because the latter #defines symbols used by it -#include "common/microprofile.h" - -#ifdef _MSC_VER -#include -#else -#include -#include -#endif - -#ifdef _WIN32 -// windows.h needs to be included before shellapi.h -#include - -#include -#endif - -#include "citra/config.h" -#include "citra/emu_window/emu_window_sdl2.h" -#include "common/logging/backend.h" -#include "common/logging/filter.h" -#include "common/logging/log.h" -#include "common/scm_rev.h" -#include "common/scope_exit.h" -#include "common/string_util.h" -#include "core/core.h" -#include "core/gdbstub/gdbstub.h" -#include "core/loader/loader.h" -#include "core/settings.h" - -static void PrintHelp(const char* argv0) { - std::cout << "Usage: " << argv0 - << " [options] \n" - "-g, --gdbport=NUMBER Enable gdb stub on port NUMBER\n" - "-h, --help Display this help and exit\n" - "-v, --version Output version information and exit\n"; -} - -static void PrintVersion() { - std::cout << "Citra " << Common::g_scm_branch << " " << Common::g_scm_desc << std::endl; -} - -/// Application entry point -int main(int argc, char** argv) { - Config config; - int option_index = 0; - bool use_gdbstub = Settings::values.use_gdbstub; - u32 gdb_port = static_cast(Settings::values.gdbstub_port); - char* endarg; -#ifdef _WIN32 - int argc_w; - auto argv_w = CommandLineToArgvW(GetCommandLineW(), &argc_w); - - if (argv_w == nullptr) { - LOG_CRITICAL(Frontend, "Failed to get command line arguments"); - return -1; - } -#endif - std::string filepath; - - static struct option long_options[] = { - {"gdbport", required_argument, 0, 'g'}, - {"help", no_argument, 0, 'h'}, - {"version", no_argument, 0, 'v'}, - {0, 0, 0, 0}, - }; - - while (optind < argc) { - char arg = getopt_long(argc, argv, "g:hv", long_options, &option_index); - if (arg != -1) { - switch (arg) { - case 'g': - errno = 0; - gdb_port = strtoul(optarg, &endarg, 0); - use_gdbstub = true; - if (endarg == optarg) - errno = EINVAL; - if (errno != 0) { - perror("--gdbport"); - exit(1); - } - break; - case 'h': - PrintHelp(argv[0]); - return 0; - case 'v': - PrintVersion(); - return 0; - } - } else { -#ifdef _WIN32 - filepath = Common::UTF16ToUTF8(argv_w[optind]); -#else - filepath = argv[optind]; -#endif - optind++; - } - } - -#ifdef _WIN32 - LocalFree(argv_w); -#endif - - Log::Filter log_filter(Log::Level::Debug); - Log::SetFilter(&log_filter); - - MicroProfileOnThreadCreate("EmuThread"); - SCOPE_EXIT({ MicroProfileShutdown(); }); - - if (filepath.empty()) { - LOG_CRITICAL(Frontend, "Failed to load ROM: No ROM specified"); - return -1; - } - - log_filter.ParseFilterString(Settings::values.log_filter); - - // Apply the command line arguments - Settings::values.gdbstub_port = gdb_port; - Settings::values.use_gdbstub = use_gdbstub; - Settings::Apply(); - - std::unique_ptr emu_window{std::make_unique()}; - - Core::System& system{Core::System::GetInstance()}; - - SCOPE_EXIT({ system.Shutdown(); }); - - const Core::System::ResultStatus load_result{system.Load(emu_window.get(), filepath)}; - - switch (load_result) { - case Core::System::ResultStatus::ErrorGetLoader: - LOG_CRITICAL(Frontend, "Failed to obtain loader for %s!", filepath.c_str()); - return -1; - case Core::System::ResultStatus::ErrorLoader: - LOG_CRITICAL(Frontend, "Failed to load ROM!"); - return -1; - case Core::System::ResultStatus::ErrorLoader_ErrorEncrypted: - LOG_CRITICAL(Frontend, "The game that you are trying to load must be decrypted before " - "being used with Citra. \n\n For more information on dumping and " - "decrypting games, please refer to: " - "https://citra-emu.org/wiki/dumping-game-cartridges/"); - return -1; - case Core::System::ResultStatus::ErrorLoader_ErrorInvalidFormat: - LOG_CRITICAL(Frontend, "Error while loading ROM: The ROM format is not supported."); - return -1; - case Core::System::ResultStatus::ErrorNotInitialized: - LOG_CRITICAL(Frontend, "CPUCore not initialized"); - return -1; - case Core::System::ResultStatus::ErrorSystemMode: - LOG_CRITICAL(Frontend, "Failed to determine system mode!"); - return -1; - case Core::System::ResultStatus::ErrorVideoCore: - LOG_CRITICAL(Frontend, "VideoCore not initialized"); - return -1; - case Core::System::ResultStatus::Success: - break; // Expected case - } - - Core::Telemetry().AddField(Telemetry::FieldType::App, "Frontend", "SDL"); - - while (emu_window->IsOpen()) { - system.RunLoop(); - } - - return 0; -} diff --git a/src/citra/citra.rc b/src/citra/citra.rc deleted file mode 100644 index c490ef302..000000000 --- a/src/citra/citra.rc +++ /dev/null @@ -1,17 +0,0 @@ -#include "winresrc.h" -///////////////////////////////////////////////////////////////////////////// -// -// Icon -// - -// Icon with lowest ID value placed first to ensure application icon -// remains consistent on all systems. -CITRA_ICON ICON "../../dist/citra.ico" - - -///////////////////////////////////////////////////////////////////////////// -// -// RT_MANIFEST -// - -1 RT_MANIFEST "../../dist/citra.manifest" diff --git a/src/citra/config.cpp b/src/citra/config.cpp deleted file mode 100644 index 94d1a9f1c..000000000 --- a/src/citra/config.cpp +++ /dev/null @@ -1,160 +0,0 @@ -// Copyright 2014 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#include -#include -#include -#include "citra/config.h" -#include "citra/default_ini.h" -#include "common/file_util.h" -#include "common/logging/log.h" -#include "common/param_package.h" -#include "core/settings.h" -#include "input_common/main.h" - -Config::Config() { - // TODO: Don't hardcode the path; let the frontend decide where to put the config files. - sdl2_config_loc = FileUtil::GetUserPath(D_CONFIG_IDX) + "sdl2-config.ini"; - sdl2_config = std::make_unique(sdl2_config_loc); - - Reload(); -} - -Config::~Config() = default; - -bool Config::LoadINI(const std::string& default_contents, bool retry) { - const char* location = this->sdl2_config_loc.c_str(); - if (sdl2_config->ParseError() < 0) { - if (retry) { - LOG_WARNING(Config, "Failed to load %s. Creating file from defaults...", location); - FileUtil::CreateFullPath(location); - FileUtil::WriteStringToFile(true, default_contents, location); - sdl2_config = std::make_unique(location); // Reopen file - - return LoadINI(default_contents, false); - } - LOG_ERROR(Config, "Failed."); - return false; - } - LOG_INFO(Config, "Successfully loaded %s", location); - return true; -} - -static const std::array default_buttons = { - SDL_SCANCODE_A, SDL_SCANCODE_S, SDL_SCANCODE_Z, SDL_SCANCODE_X, SDL_SCANCODE_T, - SDL_SCANCODE_G, SDL_SCANCODE_F, SDL_SCANCODE_H, SDL_SCANCODE_Q, SDL_SCANCODE_W, - SDL_SCANCODE_M, SDL_SCANCODE_N, SDL_SCANCODE_1, SDL_SCANCODE_2, SDL_SCANCODE_B, -}; - -static const std::array, Settings::NativeAnalog::NumAnalogs> default_analogs{{ - { - SDL_SCANCODE_UP, SDL_SCANCODE_DOWN, SDL_SCANCODE_LEFT, SDL_SCANCODE_RIGHT, SDL_SCANCODE_D, - }, - { - SDL_SCANCODE_I, SDL_SCANCODE_K, SDL_SCANCODE_J, SDL_SCANCODE_L, SDL_SCANCODE_D, - }, -}}; - -void Config::ReadValues() { - // Controls - for (int i = 0; i < Settings::NativeButton::NumButtons; ++i) { - std::string default_param = InputCommon::GenerateKeyboardParam(default_buttons[i]); - Settings::values.buttons[i] = - sdl2_config->Get("Controls", Settings::NativeButton::mapping[i], default_param); - if (Settings::values.buttons[i].empty()) - Settings::values.buttons[i] = default_param; - } - - for (int i = 0; i < Settings::NativeAnalog::NumAnalogs; ++i) { - std::string default_param = InputCommon::GenerateAnalogParamFromKeys( - default_analogs[i][0], default_analogs[i][1], default_analogs[i][2], - default_analogs[i][3], default_analogs[i][4], 0.5f); - Settings::values.analogs[i] = - sdl2_config->Get("Controls", Settings::NativeAnalog::mapping[i], default_param); - if (Settings::values.analogs[i].empty()) - Settings::values.analogs[i] = default_param; - } - - Settings::values.motion_device = sdl2_config->Get( - "Controls", "motion_device", "engine:motion_emu,update_period:100,sensitivity:0.01"); - Settings::values.touch_device = - sdl2_config->Get("Controls", "touch_device", "engine:emu_window"); - - // Core - Settings::values.cpu_core = - static_cast(sdl2_config->GetInteger("Core", "cpu_core", 0)); - - // Renderer - Settings::values.use_hw_renderer = sdl2_config->GetBoolean("Renderer", "use_hw_renderer", true); - Settings::values.use_shader_jit = sdl2_config->GetBoolean("Renderer", "use_shader_jit", true); - Settings::values.resolution_factor = - (float)sdl2_config->GetReal("Renderer", "resolution_factor", 1.0); - Settings::values.use_vsync = sdl2_config->GetBoolean("Renderer", "use_vsync", false); - Settings::values.toggle_framelimit = - sdl2_config->GetBoolean("Renderer", "toggle_framelimit", true); - - Settings::values.bg_red = (float)sdl2_config->GetReal("Renderer", "bg_red", 0.0); - Settings::values.bg_green = (float)sdl2_config->GetReal("Renderer", "bg_green", 0.0); - Settings::values.bg_blue = (float)sdl2_config->GetReal("Renderer", "bg_blue", 0.0); - - // Layout - Settings::values.layout_option = - static_cast(sdl2_config->GetInteger("Layout", "layout_option", 0)); - Settings::values.swap_screen = sdl2_config->GetBoolean("Layout", "swap_screen", false); - Settings::values.custom_layout = sdl2_config->GetBoolean("Layout", "custom_layout", false); - Settings::values.custom_top_left = - static_cast(sdl2_config->GetInteger("Layout", "custom_top_left", 0)); - Settings::values.custom_top_top = - static_cast(sdl2_config->GetInteger("Layout", "custom_top_top", 0)); - Settings::values.custom_top_right = - static_cast(sdl2_config->GetInteger("Layout", "custom_top_right", 400)); - Settings::values.custom_top_bottom = - static_cast(sdl2_config->GetInteger("Layout", "custom_top_bottom", 240)); - Settings::values.custom_bottom_left = - static_cast(sdl2_config->GetInteger("Layout", "custom_bottom_left", 40)); - Settings::values.custom_bottom_top = - static_cast(sdl2_config->GetInteger("Layout", "custom_bottom_top", 240)); - Settings::values.custom_bottom_right = - static_cast(sdl2_config->GetInteger("Layout", "custom_bottom_right", 360)); - Settings::values.custom_bottom_bottom = - static_cast(sdl2_config->GetInteger("Layout", "custom_bottom_bottom", 480)); - - // Audio - Settings::values.sink_id = sdl2_config->Get("Audio", "output_engine", "auto"); - Settings::values.enable_audio_stretching = - sdl2_config->GetBoolean("Audio", "enable_audio_stretching", true); - Settings::values.audio_device_id = sdl2_config->Get("Audio", "output_device", "auto"); - - // Data Storage - Settings::values.use_virtual_sd = - sdl2_config->GetBoolean("Data Storage", "use_virtual_sd", true); - - // System - Settings::values.is_new_3ds = sdl2_config->GetBoolean("System", "is_new_3ds", false); - Settings::values.region_value = - sdl2_config->GetInteger("System", "region_value", Settings::REGION_VALUE_AUTO_SELECT); - - // Miscellaneous - Settings::values.log_filter = sdl2_config->Get("Miscellaneous", "log_filter", "*:Info"); - - // Debugging - Settings::values.use_gdbstub = sdl2_config->GetBoolean("Debugging", "use_gdbstub", false); - Settings::values.gdbstub_port = - static_cast(sdl2_config->GetInteger("Debugging", "gdbstub_port", 24689)); - - // Web Service - Settings::values.enable_telemetry = - sdl2_config->GetBoolean("WebService", "enable_telemetry", true); - Settings::values.telemetry_endpoint_url = sdl2_config->Get( - "WebService", "telemetry_endpoint_url", "https://services.citra-emu.org/api/telemetry"); - Settings::values.verify_endpoint_url = sdl2_config->Get( - "WebService", "verify_endpoint_url", "https://services.citra-emu.org/api/profile"); - Settings::values.citra_username = sdl2_config->Get("WebService", "citra_username", ""); - Settings::values.citra_token = sdl2_config->Get("WebService", "citra_token", ""); -} - -void Config::Reload() { - LoadINI(DefaultINI::sdl2_config_file); - ReadValues(); -} diff --git a/src/citra/config.h b/src/citra/config.h deleted file mode 100644 index abc90f642..000000000 --- a/src/citra/config.h +++ /dev/null @@ -1,24 +0,0 @@ -// Copyright 2014 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include - -class INIReader; - -class Config { - std::unique_ptr sdl2_config; - std::string sdl2_config_loc; - - bool LoadINI(const std::string& default_contents = "", bool retry = true); - void ReadValues(); - -public: - Config(); - ~Config(); - - void Reload(); -}; diff --git a/src/citra/default_ini.h b/src/citra/default_ini.h deleted file mode 100644 index b7b8abe1e..000000000 --- a/src/citra/default_ini.h +++ /dev/null @@ -1,179 +0,0 @@ -// Copyright 2014 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -namespace DefaultINI { - -const char* sdl2_config_file = R"( -[Controls] -# The input devices and parameters for each 3DS native input -# It should be in the format of "engine:[engine_name],[param1]:[value1],[param2]:[value2]..." -# Escape characters $0 (for ':'), $1 (for ',') and $2 (for '$') can be used in values - -# for button input, the following devices are available: -# - "keyboard" (default) for keyboard input. Required parameters: -# - "code": the code of the key to bind -# - "sdl" for joystick input using SDL. Required parameters: -# - "joystick": the index of the joystick to bind -# - "button"(optional): the index of the button to bind -# - "hat"(optional): the index of the hat to bind as direction buttons -# - "axis"(optional): the index of the axis to bind -# - "direction"(only used for hat): the direction name of the hat to bind. Can be "up", "down", "left" or "right" -# - "threshold"(only used for axis): a float value in (-1.0, 1.0) which the button is -# triggered if the axis value crosses -# - "direction"(only used for axis): "+" means the button is triggered when the axis value -# is greater than the threshold; "-" means the button is triggered when the axis value -# is smaller than the threshold -button_a= -button_b= -button_x= -button_y= -button_up= -button_down= -button_left= -button_right= -button_l= -button_r= -button_start= -button_select= -button_zl= -button_zr= -button_home= - -# for analog input, the following devices are available: -# - "analog_from_button" (default) for emulating analog input from direction buttons. Required parameters: -# - "up", "down", "left", "right": sub-devices for each direction. -# Should be in the format as a button input devices using escape characters, for example, "engine$0keyboard$1code$00" -# - "modifier": sub-devices as a modifier. -# - "modifier_scale": a float number representing the applied modifier scale to the analog input. -# Must be in range of 0.0-1.0. Defaults to 0.5 -# - "sdl" for joystick input using SDL. Required parameters: -# - "joystick": the index of the joystick to bind -# - "axis_x": the index of the axis to bind as x-axis (default to 0) -# - "axis_y": the index of the axis to bind as y-axis (default to 1) -circle_pad= -c_stick= - -# for motion input, the following devices are available: -# - "motion_emu" (default) for emulating motion input from mouse input. Required parameters: -# - "update_period": update period in milliseconds (default to 100) -# - "sensitivity": the coefficient converting mouse movement to tilting angle (default to 0.01) -motion_device= - -# for touch input, the following devices are available: -# - "emu_window" (default) for emulating touch input from mouse input to the emulation window. No parameters required -touch_device= - -[Core] -# Which CPU core to use for CPU emulation -# 0 (default): Unicorn (slow), 1: Dynarmic (faster) -cpu_core = - -[Renderer] -# Whether to use software or hardware rendering. -# 0: Software, 1 (default): Hardware -use_hw_renderer = - -# Whether to use the Just-In-Time (JIT) compiler for shader emulation -# 0: Interpreter (slow), 1 (default): JIT (fast) -use_shader_jit = - -# Resolution scale factor -# 0: Auto (scales resolution to window size), 1: Native 3DS screen resolution, Otherwise a scale -# factor for the 3DS resolution -resolution_factor = - -# Whether to enable V-Sync (caps the framerate at 60FPS) or not. -# 0 (default): Off, 1: On -use_vsync = - -# The clear color for the renderer. What shows up on the sides of the bottom screen. -# Must be in range of 0.0-1.0. Defaults to 1.0 for all. -bg_red = -bg_blue = -bg_green = - -[Layout] -# Layout for the screen inside the render window. -# 0 (default): Default Top Bottom Screen, 1: Single Screen Only, 2: Large Screen Small Screen -layout_option = - -# Toggle custom layout (using the settings below) on or off. -# 0 (default): Off , 1: On -custom_layout = - -# Screen placement when using Custom layout option -# 0x, 0y is the top left corner of the render window. -custom_top_left = -custom_top_top = -custom_top_right = -custom_top_bottom = -custom_bottom_left = -custom_bottom_top = -custom_bottom_right = -custom_bottom_bottom = - -#Whether to toggle frame limiter on or off. -# 0: Off , 1 (default): On -toggle_framelimit = - -# Swaps the prominent screen with the other screen. -# For example, if Single Screen is chosen, setting this to 1 will display the bottom screen instead of the top screen. -# 0 (default): Top Screen is prominent, 1: Bottom Screen is prominent -swap_screen = - -[Audio] -# Which audio output engine to use. -# auto (default): Auto-select, null: No audio output, sdl2: SDL2 (if available) -output_engine = - -# Whether or not to enable the audio-stretching post-processing effect. -# This effect adjusts audio speed to match emulation speed and helps prevent audio stutter, -# at the cost of increasing audio latency. -# 0: No, 1 (default): Yes -enable_audio_stretching = - -# Which audio device to use. -# auto (default): Auto-select -output_device = - -[Data Storage] -# Whether to create a virtual SD card. -# 1 (default): Yes, 0: No -use_virtual_sd = - -[System] -# The system model that Citra will try to emulate -# 0: Old 3DS (default), 1: New 3DS -is_new_3ds = - -# The system region that Citra will use during emulation -# -1: Auto-select (default), 0: Japan, 1: USA, 2: Europe, 3: Australia, 4: China, 5: Korea, 6: Taiwan -region_value = - -[Miscellaneous] -# A filter which removes logs below a certain logging level. -# Examples: *:Debug Kernel.SVC:Trace Service.*:Critical -log_filter = *:Info - -[Debugging] -# Port for listening to GDB connections. -use_gdbstub=false -gdbstub_port=24689 - -[WebService] -# Whether or not to enable telemetry -# 0: No, 1 (default): Yes -enable_telemetry = -# Endpoint URL for submitting telemetry data -telemetry_endpoint_url = https://services.citra-emu.org/api/telemetry -# Endpoint URL to verify the username and token -verify_endpoint_url = https://services.citra-emu.org/api/profile -# Username and token for Citra Web Service -# See https://services.citra-emu.org/ for more info -citra_username = -citra_token = -)"; -} diff --git a/src/citra/emu_window/emu_window_sdl2.cpp b/src/citra/emu_window/emu_window_sdl2.cpp deleted file mode 100644 index e65b04e4b..000000000 --- a/src/citra/emu_window/emu_window_sdl2.cpp +++ /dev/null @@ -1,177 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#include -#include -#include -#define SDL_MAIN_HANDLED -#include -#include -#include "citra/emu_window/emu_window_sdl2.h" -#include "common/logging/log.h" -#include "common/scm_rev.h" -#include "common/string_util.h" -#include "core/settings.h" -#include "input_common/keyboard.h" -#include "input_common/main.h" -#include "input_common/motion_emu.h" -#include "network/network.h" - -void EmuWindow_SDL2::OnMouseMotion(s32 x, s32 y) { - TouchMoved((unsigned)std::max(x, 0), (unsigned)std::max(y, 0)); - InputCommon::GetMotionEmu()->Tilt(x, y); -} - -void EmuWindow_SDL2::OnMouseButton(u32 button, u8 state, s32 x, s32 y) { - if (button == SDL_BUTTON_LEFT) { - if (state == SDL_PRESSED) { - TouchPressed((unsigned)std::max(x, 0), (unsigned)std::max(y, 0)); - } else { - TouchReleased(); - } - } else if (button == SDL_BUTTON_RIGHT) { - if (state == SDL_PRESSED) { - InputCommon::GetMotionEmu()->BeginTilt(x, y); - } else { - InputCommon::GetMotionEmu()->EndTilt(); - } - } -} - -void EmuWindow_SDL2::OnKeyEvent(int key, u8 state) { - if (state == SDL_PRESSED) { - InputCommon::GetKeyboard()->PressKey(key); - } else if (state == SDL_RELEASED) { - InputCommon::GetKeyboard()->ReleaseKey(key); - } -} - -bool EmuWindow_SDL2::IsOpen() const { - return is_open; -} - -void EmuWindow_SDL2::OnResize() { - int width, height; - SDL_GetWindowSize(render_window, &width, &height); - UpdateCurrentFramebufferLayout(width, height); -} - -EmuWindow_SDL2::EmuWindow_SDL2() { - InputCommon::Init(); - Network::Init(); - - SDL_SetMainReady(); - - // Initialize the window - if (SDL_Init(SDL_INIT_VIDEO) < 0) { - LOG_CRITICAL(Frontend, "Failed to initialize SDL2! Exiting..."); - exit(1); - } - - SDL_GL_SetAttribute(SDL_GL_CONTEXT_MAJOR_VERSION, 3); - SDL_GL_SetAttribute(SDL_GL_CONTEXT_MINOR_VERSION, 3); - SDL_GL_SetAttribute(SDL_GL_CONTEXT_PROFILE_MASK, SDL_GL_CONTEXT_PROFILE_CORE); - SDL_GL_SetAttribute(SDL_GL_DOUBLEBUFFER, 1); - SDL_GL_SetAttribute(SDL_GL_RED_SIZE, 8); - SDL_GL_SetAttribute(SDL_GL_GREEN_SIZE, 8); - SDL_GL_SetAttribute(SDL_GL_BLUE_SIZE, 8); - SDL_GL_SetAttribute(SDL_GL_ALPHA_SIZE, 0); - - std::string window_title = Common::StringFromFormat("yuzu %s| %s-%s ", Common::g_build_name, - Common::g_scm_branch, Common::g_scm_desc); - render_window = - SDL_CreateWindow(window_title.c_str(), - SDL_WINDOWPOS_UNDEFINED, // x position - SDL_WINDOWPOS_UNDEFINED, // y position - Layout::ScreenUndocked::Width, Layout::ScreenUndocked::Height, - SDL_WINDOW_OPENGL | SDL_WINDOW_RESIZABLE | SDL_WINDOW_ALLOW_HIGHDPI); - - if (render_window == nullptr) { - LOG_CRITICAL(Frontend, "Failed to create SDL2 window! Exiting..."); - exit(1); - } - - gl_context = SDL_GL_CreateContext(render_window); - - if (gl_context == nullptr) { - LOG_CRITICAL(Frontend, "Failed to create SDL2 GL context! Exiting..."); - exit(1); - } - - if (!gladLoadGLLoader(static_cast(SDL_GL_GetProcAddress))) { - LOG_CRITICAL(Frontend, "Failed to initialize GL functions! Exiting..."); - exit(1); - } - - OnResize(); - OnMinimalClientAreaChangeRequest(GetActiveConfig().min_client_area_size); - SDL_PumpEvents(); - SDL_GL_SetSwapInterval(Settings::values.use_vsync); - - DoneCurrent(); -} - -EmuWindow_SDL2::~EmuWindow_SDL2() { - SDL_GL_DeleteContext(gl_context); - SDL_Quit(); - - Network::Shutdown(); - InputCommon::Shutdown(); -} - -void EmuWindow_SDL2::SwapBuffers() { - SDL_GL_SwapWindow(render_window); -} - -void EmuWindow_SDL2::PollEvents() { - SDL_Event event; - - // SDL_PollEvent returns 0 when there are no more events in the event queue - while (SDL_PollEvent(&event)) { - switch (event.type) { - case SDL_WINDOWEVENT: - switch (event.window.event) { - case SDL_WINDOWEVENT_SIZE_CHANGED: - case SDL_WINDOWEVENT_RESIZED: - case SDL_WINDOWEVENT_MAXIMIZED: - case SDL_WINDOWEVENT_RESTORED: - case SDL_WINDOWEVENT_MINIMIZED: - OnResize(); - break; - case SDL_WINDOWEVENT_CLOSE: - is_open = false; - break; - } - break; - case SDL_KEYDOWN: - case SDL_KEYUP: - OnKeyEvent(static_cast(event.key.keysym.scancode), event.key.state); - break; - case SDL_MOUSEMOTION: - OnMouseMotion(event.motion.x, event.motion.y); - break; - case SDL_MOUSEBUTTONDOWN: - case SDL_MOUSEBUTTONUP: - OnMouseButton(event.button.button, event.button.state, event.button.x, event.button.y); - break; - case SDL_QUIT: - is_open = false; - break; - } - } -} - -void EmuWindow_SDL2::MakeCurrent() { - SDL_GL_MakeCurrent(render_window, gl_context); -} - -void EmuWindow_SDL2::DoneCurrent() { - SDL_GL_MakeCurrent(render_window, nullptr); -} - -void EmuWindow_SDL2::OnMinimalClientAreaChangeRequest( - const std::pair& minimal_size) { - - SDL_SetWindowMinimumSize(render_window, minimal_size.first, minimal_size.second); -} diff --git a/src/citra/emu_window/emu_window_sdl2.h b/src/citra/emu_window/emu_window_sdl2.h deleted file mode 100644 index 3664d2fbe..000000000 --- a/src/citra/emu_window/emu_window_sdl2.h +++ /dev/null @@ -1,59 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include -#include "core/frontend/emu_window.h" - -struct SDL_Window; - -class EmuWindow_SDL2 : public EmuWindow { -public: - EmuWindow_SDL2(); - ~EmuWindow_SDL2(); - - /// Swap buffers to display the next frame - void SwapBuffers() override; - - /// Polls window events - void PollEvents() override; - - /// Makes the graphics context current for the caller thread - void MakeCurrent() override; - - /// Releases the GL context from the caller thread - void DoneCurrent() override; - - /// Whether the window is still open, and a close request hasn't yet been sent - bool IsOpen() const; - -private: - /// Called by PollEvents when a key is pressed or released. - void OnKeyEvent(int key, u8 state); - - /// Called by PollEvents when the mouse moves. - void OnMouseMotion(s32 x, s32 y); - - /// Called by PollEvents when a mouse button is pressed or released - void OnMouseButton(u32 button, u8 state, s32 x, s32 y); - - /// Called by PollEvents when any event that may cause the window to be resized occurs - void OnResize(); - - /// Called when a configuration change affects the minimal size of the window - void OnMinimalClientAreaChangeRequest( - const std::pair& minimal_size) override; - - /// Is the window still open? - bool is_open = true; - - /// Internal SDL2 render window - SDL_Window* render_window; - - using SDL_GLContext = void*; - /// The OpenGL context associated with the window - SDL_GLContext gl_context; -}; diff --git a/src/citra/resource.h b/src/citra/resource.h deleted file mode 100644 index df8e459e4..000000000 --- a/src/citra/resource.h +++ /dev/null @@ -1,16 +0,0 @@ -//{{NO_DEPENDENCIES}} -// Microsoft Visual C++ generated include file. -// Used by pcafe.rc -// -#define IDI_ICON3 103 - -// Next default values for new objects -// -#ifdef APSTUDIO_INVOKED -#ifndef APSTUDIO_READONLY_SYMBOLS -#define _APS_NEXT_RESOURCE_VALUE 105 -#define _APS_NEXT_COMMAND_VALUE 40001 -#define _APS_NEXT_CONTROL_VALUE 1001 -#define _APS_NEXT_SYMED_VALUE 101 -#endif -#endif diff --git a/src/citra_qt/CMakeLists.txt b/src/citra_qt/CMakeLists.txt deleted file mode 100644 index e2fa33081..000000000 --- a/src/citra_qt/CMakeLists.txt +++ /dev/null @@ -1,116 +0,0 @@ -set(CMAKE_AUTOMOC ON) -set(CMAKE_AUTORCC ON) -set(CMAKE_INCLUDE_CURRENT_DIR ON) -set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} ${PROJECT_SOURCE_DIR}/CMakeModules) - -set(SRCS - configuration/config.cpp - configuration/configure_audio.cpp - configuration/configure_debug.cpp - configuration/configure_dialog.cpp - configuration/configure_general.cpp - configuration/configure_graphics.cpp - configuration/configure_input.cpp - configuration/configure_system.cpp - configuration/configure_web.cpp - debugger/graphics/graphics.cpp - debugger/graphics/graphics_breakpoint_observer.cpp - debugger/graphics/graphics_breakpoints.cpp - debugger/graphics/graphics_cmdlists.cpp - debugger/graphics/graphics_surface.cpp - debugger/graphics/graphics_tracing.cpp - debugger/graphics/graphics_vertex_shader.cpp - debugger/profiler.cpp - debugger/registers.cpp - debugger/wait_tree.cpp - util/spinbox.cpp - util/util.cpp - bootmanager.cpp - game_list.cpp - hotkeys.cpp - main.cpp - ui_settings.cpp - citra-qt.rc - Info.plist - ) - -set(HEADERS - configuration/config.h - configuration/configure_audio.h - configuration/configure_debug.h - configuration/configure_dialog.h - configuration/configure_general.h - configuration/configure_graphics.h - configuration/configure_input.h - configuration/configure_system.h - configuration/configure_web.h - debugger/graphics/graphics.h - debugger/graphics/graphics_breakpoint_observer.h - debugger/graphics/graphics_breakpoints.h - debugger/graphics/graphics_breakpoints_p.h - debugger/graphics/graphics_cmdlists.h - debugger/graphics/graphics_surface.h - debugger/graphics/graphics_tracing.h - debugger/graphics/graphics_vertex_shader.h - debugger/profiler.h - debugger/registers.h - debugger/wait_tree.h - util/spinbox.h - util/util.h - bootmanager.h - game_list.h - game_list_p.h - hotkeys.h - main.h - ui_settings.h - ) - -set(UIS - configuration/configure.ui - configuration/configure_audio.ui - configuration/configure_debug.ui - configuration/configure_general.ui - configuration/configure_graphics.ui - configuration/configure_input.ui - configuration/configure_system.ui - configuration/configure_web.ui - debugger/registers.ui - hotkeys.ui - main.ui - ) - -file(GLOB_RECURSE ICONS ${CMAKE_SOURCE_DIR}/dist/icons/*) -file(GLOB_RECURSE THEMES ${CMAKE_SOURCE_DIR}/dist/qt_themes/*) - -create_directory_groups(${SRCS} ${HEADERS} ${UIS}) - -if (Qt5_FOUND) - qt5_wrap_ui(UI_HDRS ${UIS}) -else() - qt4_wrap_ui(UI_HDRS ${UIS}) -endif() - -if (APPLE) - set(MACOSX_ICON "../../dist/citra.icns") - set_source_files_properties(${MACOSX_ICON} PROPERTIES MACOSX_PACKAGE_LOCATION Resources) - add_executable(citra-qt MACOSX_BUNDLE ${SRCS} ${HEADERS} ${UI_HDRS} ${ICONS} ${THEMES} ${MACOSX_ICON}) - set_target_properties(citra-qt PROPERTIES MACOSX_BUNDLE_INFO_PLIST ${CMAKE_CURRENT_SOURCE_DIR}/Info.plist) -else() - add_executable(citra-qt ${SRCS} ${HEADERS} ${UI_HDRS} ${ICONS} ${THEMES}) -endif() -target_link_libraries(citra-qt PRIVATE audio_core common core input_common network video_core) -target_link_libraries(citra-qt PRIVATE Boost::boost glad nihstro-headers Qt5::OpenGL Qt5::Widgets) -target_link_libraries(citra-qt PRIVATE ${PLATFORM_LIBRARIES} Threads::Threads) - -if(UNIX AND NOT APPLE) - install(TARGETS citra-qt RUNTIME DESTINATION "${CMAKE_INSTALL_PREFIX}/bin") -endif() - -if (MSVC) - include(CopyCitraQt5Deps) - include(CopyCitraSDLDeps) - include(CopyYuzuUnicornDeps) - copy_citra_Qt5_deps(citra-qt) - copy_citra_SDL_deps(citra-qt) - copy_yuzu_unicorn_deps(citra-qt) -endif() diff --git a/src/citra_qt/Info.plist b/src/citra_qt/Info.plist deleted file mode 100644 index 7d46b39d1..000000000 --- a/src/citra_qt/Info.plist +++ /dev/null @@ -1,40 +0,0 @@ - - - - - CFBundleDevelopmentRegion - English - CFBundleExecutable - ${EXECUTABLE_NAME} - CFBundleGetInfoString - - CFBundleIconFile - citra.icns - CFBundleIdentifier - com.citra-emu.citra - CFBundleInfoDictionaryVersion - 6.0 - CFBundleLongVersionString - - CFBundleName - Citra - CFBundlePackageType - APPL - CFBundleShortVersionString - - CFBundleSignature - ???? - CFBundleVersion - - CSResourcesFileMapped - - LSRequiresCarbon - - NSHumanReadableCopyright - - NSPrincipalClass - NSApplication - NSHighResolutionCapable - True - - diff --git a/src/citra_qt/bootmanager.cpp b/src/citra_qt/bootmanager.cpp deleted file mode 100644 index eb542ad4e..000000000 --- a/src/citra_qt/bootmanager.cpp +++ /dev/null @@ -1,310 +0,0 @@ -#include -#include -#include - -#if QT_VERSION >= QT_VERSION_CHECK(5, 0, 0) -// Required for screen DPI information -#include -#include -#endif - -#include "citra_qt/bootmanager.h" -#include "common/microprofile.h" -#include "common/scm_rev.h" -#include "common/string_util.h" -#include "core/core.h" -#include "core/frontend/framebuffer_layout.h" -#include "core/settings.h" -#include "input_common/keyboard.h" -#include "input_common/main.h" -#include "input_common/motion_emu.h" -#include "network/network.h" - -EmuThread::EmuThread(GRenderWindow* render_window) - : exec_step(false), running(false), stop_run(false), render_window(render_window) {} - -void EmuThread::run() { - render_window->MakeCurrent(); - - MicroProfileOnThreadCreate("EmuThread"); - - stop_run = false; - - // holds whether the cpu was running during the last iteration, - // so that the DebugModeLeft signal can be emitted before the - // next execution step - bool was_active = false; - while (!stop_run) { - if (running) { - if (!was_active) - emit DebugModeLeft(); - - Core::System::ResultStatus result = Core::System::GetInstance().RunLoop(); - if (result != Core::System::ResultStatus::Success) { - emit ErrorThrown(result, Core::System::GetInstance().GetStatusDetails()); - } - - was_active = running || exec_step; - if (!was_active && !stop_run) - emit DebugModeEntered(); - } else if (exec_step) { - if (!was_active) - emit DebugModeLeft(); - - exec_step = false; - Core::System::GetInstance().SingleStep(); - emit DebugModeEntered(); - yieldCurrentThread(); - - was_active = false; - } else { - std::unique_lock lock(running_mutex); - running_cv.wait(lock, [this] { return IsRunning() || exec_step || stop_run; }); - } - } - - // Shutdown the core emulation - Core::System::GetInstance().Shutdown(); - -#if MICROPROFILE_ENABLED - MicroProfileOnThreadExit(); -#endif - - render_window->moveContext(); -} - -// This class overrides paintEvent and resizeEvent to prevent the GUI thread from stealing GL -// context. -// The corresponding functionality is handled in EmuThread instead -class GGLWidgetInternal : public QGLWidget { -public: - GGLWidgetInternal(QGLFormat fmt, GRenderWindow* parent) - : QGLWidget(fmt, parent), parent(parent) {} - - void paintEvent(QPaintEvent* ev) override { - if (do_painting) { - QPainter painter(this); - } - } - - void resizeEvent(QResizeEvent* ev) override { - parent->OnClientAreaResized(ev->size().width(), ev->size().height()); - parent->OnFramebufferSizeChanged(); - } - - void DisablePainting() { - do_painting = false; - } - void EnablePainting() { - do_painting = true; - } - -private: - GRenderWindow* parent; - bool do_painting; -}; - -GRenderWindow::GRenderWindow(QWidget* parent, EmuThread* emu_thread) - : QWidget(parent), child(nullptr), emu_thread(emu_thread) { - - std::string window_title = Common::StringFromFormat("Citra %s| %s-%s", Common::g_build_name, - Common::g_scm_branch, Common::g_scm_desc); - setWindowTitle(QString::fromStdString(window_title)); - - InputCommon::Init(); - Network::Init(); -} - -GRenderWindow::~GRenderWindow() { - InputCommon::Shutdown(); - Network::Shutdown(); -} - -void GRenderWindow::moveContext() { - DoneCurrent(); -// We need to move GL context to the swapping thread in Qt5 -#if QT_VERSION > QT_VERSION_CHECK(5, 0, 0) - // If the thread started running, move the GL Context to the new thread. Otherwise, move it - // back. - auto thread = (QThread::currentThread() == qApp->thread() && emu_thread != nullptr) - ? emu_thread - : qApp->thread(); - child->context()->moveToThread(thread); -#endif -} - -void GRenderWindow::SwapBuffers() { -#if !defined(QT_NO_DEBUG) - // Qt debug runtime prints a bogus warning on the console if you haven't called makeCurrent - // since the last time you called swapBuffers. This presumably means something if you're using - // QGLWidget the "regular" way, but in our multi-threaded use case is harmless since we never - // call doneCurrent in this thread. - child->makeCurrent(); -#endif - child->swapBuffers(); -} - -void GRenderWindow::MakeCurrent() { - child->makeCurrent(); -} - -void GRenderWindow::DoneCurrent() { - child->doneCurrent(); -} - -void GRenderWindow::PollEvents() {} - -// On Qt 5.0+, this correctly gets the size of the framebuffer (pixels). -// -// Older versions get the window size (density independent pixels), -// and hence, do not support DPI scaling ("retina" displays). -// The result will be a viewport that is smaller than the extent of the window. -void GRenderWindow::OnFramebufferSizeChanged() { - // Screen changes potentially incur a change in screen DPI, hence we should update the - // framebuffer size - qreal pixelRatio = windowPixelRatio(); - unsigned width = child->QPaintDevice::width() * pixelRatio; - unsigned height = child->QPaintDevice::height() * pixelRatio; - UpdateCurrentFramebufferLayout(width, height); -} - -void GRenderWindow::BackupGeometry() { - geometry = ((QGLWidget*)this)->saveGeometry(); -} - -void GRenderWindow::RestoreGeometry() { - // We don't want to back up the geometry here (obviously) - QWidget::restoreGeometry(geometry); -} - -void GRenderWindow::restoreGeometry(const QByteArray& geometry) { - // Make sure users of this class don't need to deal with backing up the geometry themselves - QWidget::restoreGeometry(geometry); - BackupGeometry(); -} - -QByteArray GRenderWindow::saveGeometry() { - // If we are a top-level widget, store the current geometry - // otherwise, store the last backup - if (parent() == nullptr) - return ((QGLWidget*)this)->saveGeometry(); - else - return geometry; -} - -qreal GRenderWindow::windowPixelRatio() { -#if QT_VERSION >= QT_VERSION_CHECK(5, 0, 0) - // windowHandle() might not be accessible until the window is displayed to screen. - return windowHandle() ? windowHandle()->screen()->devicePixelRatio() : 1.0f; -#else - return 1.0f; -#endif -} - -void GRenderWindow::closeEvent(QCloseEvent* event) { - emit Closed(); - QWidget::closeEvent(event); -} - -void GRenderWindow::keyPressEvent(QKeyEvent* event) { - InputCommon::GetKeyboard()->PressKey(event->key()); -} - -void GRenderWindow::keyReleaseEvent(QKeyEvent* event) { - InputCommon::GetKeyboard()->ReleaseKey(event->key()); -} - -void GRenderWindow::mousePressEvent(QMouseEvent* event) { - auto pos = event->pos(); - if (event->button() == Qt::LeftButton) { - qreal pixelRatio = windowPixelRatio(); - this->TouchPressed(static_cast(pos.x() * pixelRatio), - static_cast(pos.y() * pixelRatio)); - } else if (event->button() == Qt::RightButton) { - InputCommon::GetMotionEmu()->BeginTilt(pos.x(), pos.y()); - } -} - -void GRenderWindow::mouseMoveEvent(QMouseEvent* event) { - auto pos = event->pos(); - qreal pixelRatio = windowPixelRatio(); - this->TouchMoved(std::max(static_cast(pos.x() * pixelRatio), 0u), - std::max(static_cast(pos.y() * pixelRatio), 0u)); - InputCommon::GetMotionEmu()->Tilt(pos.x(), pos.y()); -} - -void GRenderWindow::mouseReleaseEvent(QMouseEvent* event) { - if (event->button() == Qt::LeftButton) - this->TouchReleased(); - else if (event->button() == Qt::RightButton) - InputCommon::GetMotionEmu()->EndTilt(); -} - -void GRenderWindow::focusOutEvent(QFocusEvent* event) { - QWidget::focusOutEvent(event); - InputCommon::GetKeyboard()->ReleaseAllKeys(); -} - -void GRenderWindow::OnClientAreaResized(unsigned width, unsigned height) { - NotifyClientAreaSizeChanged(std::make_pair(width, height)); -} - -void GRenderWindow::InitRenderTarget() { - if (child) { - delete child; - } - - if (layout()) { - delete layout(); - } - - // TODO: One of these flags might be interesting: WA_OpaquePaintEvent, WA_NoBackground, - // WA_DontShowOnScreen, WA_DeleteOnClose - QGLFormat fmt; - fmt.setVersion(3, 3); - fmt.setProfile(QGLFormat::CoreProfile); - fmt.setSwapInterval(Settings::values.use_vsync); - - // Requests a forward-compatible context, which is required to get a 3.2+ context on OS X - fmt.setOption(QGL::NoDeprecatedFunctions); - - child = new GGLWidgetInternal(fmt, this); - QBoxLayout* layout = new QHBoxLayout(this); - - resize(Layout::ScreenUndocked::Width, Layout::ScreenUndocked::Height); - layout->addWidget(child); - layout->setMargin(0); - setLayout(layout); - - OnMinimalClientAreaChangeRequest(GetActiveConfig().min_client_area_size); - - OnFramebufferSizeChanged(); - NotifyClientAreaSizeChanged(std::pair(child->width(), child->height())); - - BackupGeometry(); -} - -void GRenderWindow::OnMinimalClientAreaChangeRequest( - const std::pair& minimal_size) { - setMinimumSize(minimal_size.first, minimal_size.second); -} - -void GRenderWindow::OnEmulationStarting(EmuThread* emu_thread) { - this->emu_thread = emu_thread; - child->DisablePainting(); -} - -void GRenderWindow::OnEmulationStopping() { - emu_thread = nullptr; - child->EnablePainting(); -} - -void GRenderWindow::showEvent(QShowEvent* event) { - QWidget::showEvent(event); - -#if QT_VERSION >= QT_VERSION_CHECK(5, 0, 0) - // windowHandle() is not initialized until the Window is shown, so we connect it here. - connect(this->windowHandle(), SIGNAL(screenChanged(QScreen*)), this, - SLOT(OnFramebufferSizeChanged()), Qt::UniqueConnection); -#endif -} diff --git a/src/citra_qt/bootmanager.h b/src/citra_qt/bootmanager.h deleted file mode 100644 index 6974edcbb..000000000 --- a/src/citra_qt/bootmanager.h +++ /dev/null @@ -1,162 +0,0 @@ -// Copyright 2014 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include -#include -#include -#include -#include "common/thread.h" -#include "core/core.h" -#include "core/frontend/emu_window.h" - -class QKeyEvent; -class QScreen; - -class GGLWidgetInternal; -class GMainWindow; -class GRenderWindow; - -class EmuThread : public QThread { - Q_OBJECT - -public: - explicit EmuThread(GRenderWindow* render_window); - - /** - * Start emulation (on new thread) - * @warning Only call when not running! - */ - void run() override; - - /** - * Steps the emulation thread by a single CPU instruction (if the CPU is not already running) - * @note This function is thread-safe - */ - void ExecStep() { - exec_step = true; - running_cv.notify_all(); - } - - /** - * Sets whether the emulation thread is running or not - * @param running Boolean value, set the emulation thread to running if true - * @note This function is thread-safe - */ - void SetRunning(bool running) { - std::unique_lock lock(running_mutex); - this->running = running; - lock.unlock(); - running_cv.notify_all(); - } - - /** - * Check if the emulation thread is running or not - * @return True if the emulation thread is running, otherwise false - * @note This function is thread-safe - */ - bool IsRunning() { - return running; - } - - /** - * Requests for the emulation thread to stop running - */ - void RequestStop() { - stop_run = true; - SetRunning(false); - }; - -private: - bool exec_step; - bool running; - std::atomic stop_run; - std::mutex running_mutex; - std::condition_variable running_cv; - - GRenderWindow* render_window; - -signals: - /** - * Emitted when the CPU has halted execution - * - * @warning When connecting to this signal from other threads, make sure to specify either - * Qt::QueuedConnection (invoke slot within the destination object's message thread) or even - * Qt::BlockingQueuedConnection (additionally block source thread until slot returns) - */ - void DebugModeEntered(); - - /** - * Emitted right before the CPU continues execution - * - * @warning When connecting to this signal from other threads, make sure to specify either - * Qt::QueuedConnection (invoke slot within the destination object's message thread) or even - * Qt::BlockingQueuedConnection (additionally block source thread until slot returns) - */ - void DebugModeLeft(); - - void ErrorThrown(Core::System::ResultStatus, std::string); -}; - -class GRenderWindow : public QWidget, public EmuWindow { - Q_OBJECT - -public: - GRenderWindow(QWidget* parent, EmuThread* emu_thread); - ~GRenderWindow(); - - // EmuWindow implementation - void SwapBuffers() override; - void MakeCurrent() override; - void DoneCurrent() override; - void PollEvents() override; - - void BackupGeometry(); - void RestoreGeometry(); - void restoreGeometry(const QByteArray& geometry); // overridden - QByteArray saveGeometry(); // overridden - - qreal windowPixelRatio(); - - void closeEvent(QCloseEvent* event) override; - - void keyPressEvent(QKeyEvent* event) override; - void keyReleaseEvent(QKeyEvent* event) override; - - void mousePressEvent(QMouseEvent* event) override; - void mouseMoveEvent(QMouseEvent* event) override; - void mouseReleaseEvent(QMouseEvent* event) override; - - void focusOutEvent(QFocusEvent* event) override; - - void OnClientAreaResized(unsigned width, unsigned height); - - void InitRenderTarget(); - -public slots: - void moveContext(); // overridden - - void OnEmulationStarting(EmuThread* emu_thread); - void OnEmulationStopping(); - void OnFramebufferSizeChanged(); - -signals: - /// Emitted when the window is closed - void Closed(); - -private: - void OnMinimalClientAreaChangeRequest( - const std::pair& minimal_size) override; - - GGLWidgetInternal* child; - - QByteArray geometry; - - EmuThread* emu_thread; - -protected: - void showEvent(QShowEvent* event) override; -}; diff --git a/src/citra_qt/citra-qt.rc b/src/citra_qt/citra-qt.rc deleted file mode 100644 index a48a9440d..000000000 --- a/src/citra_qt/citra-qt.rc +++ /dev/null @@ -1,19 +0,0 @@ -#include "winresrc.h" -///////////////////////////////////////////////////////////////////////////// -// -// Icon -// - -// Icon with lowest ID value placed first to ensure application icon -// remains consistent on all systems. -// QT requires that the default application icon is named IDI_ICON1 - -IDI_ICON1 ICON "../../dist/citra.ico" - - -///////////////////////////////////////////////////////////////////////////// -// -// RT_MANIFEST -// - -1 RT_MANIFEST "../../dist/citra.manifest" diff --git a/src/citra_qt/configuration/config.cpp b/src/citra_qt/configuration/config.cpp deleted file mode 100644 index fd884db7a..000000000 --- a/src/citra_qt/configuration/config.cpp +++ /dev/null @@ -1,326 +0,0 @@ -// Copyright 2014 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#include -#include "citra_qt/configuration/config.h" -#include "citra_qt/ui_settings.h" -#include "common/file_util.h" -#include "input_common/main.h" - -Config::Config() { - // TODO: Don't hardcode the path; let the frontend decide where to put the config files. - qt_config_loc = FileUtil::GetUserPath(D_CONFIG_IDX) + "qt-config.ini"; - FileUtil::CreateFullPath(qt_config_loc); - qt_config = new QSettings(QString::fromStdString(qt_config_loc), QSettings::IniFormat); - - Reload(); -} - -const std::array Config::default_buttons = { - Qt::Key_A, Qt::Key_S, Qt::Key_Z, Qt::Key_X, Qt::Key_T, Qt::Key_G, Qt::Key_F, Qt::Key_H, - Qt::Key_Q, Qt::Key_W, Qt::Key_M, Qt::Key_N, Qt::Key_1, Qt::Key_2, Qt::Key_B, -}; - -const std::array, Settings::NativeAnalog::NumAnalogs> Config::default_analogs{{ - { - Qt::Key_Up, Qt::Key_Down, Qt::Key_Left, Qt::Key_Right, Qt::Key_D, - }, - { - Qt::Key_I, Qt::Key_K, Qt::Key_J, Qt::Key_L, Qt::Key_D, - }, -}}; - -void Config::ReadValues() { - qt_config->beginGroup("Controls"); - for (int i = 0; i < Settings::NativeButton::NumButtons; ++i) { - std::string default_param = InputCommon::GenerateKeyboardParam(default_buttons[i]); - Settings::values.buttons[i] = - qt_config - ->value(Settings::NativeButton::mapping[i], QString::fromStdString(default_param)) - .toString() - .toStdString(); - if (Settings::values.buttons[i].empty()) - Settings::values.buttons[i] = default_param; - } - - for (int i = 0; i < Settings::NativeAnalog::NumAnalogs; ++i) { - std::string default_param = InputCommon::GenerateAnalogParamFromKeys( - default_analogs[i][0], default_analogs[i][1], default_analogs[i][2], - default_analogs[i][3], default_analogs[i][4], 0.5f); - Settings::values.analogs[i] = - qt_config - ->value(Settings::NativeAnalog::mapping[i], QString::fromStdString(default_param)) - .toString() - .toStdString(); - if (Settings::values.analogs[i].empty()) - Settings::values.analogs[i] = default_param; - } - - Settings::values.motion_device = - qt_config->value("motion_device", "engine:motion_emu,update_period:100,sensitivity:0.01") - .toString() - .toStdString(); - Settings::values.touch_device = - qt_config->value("touch_device", "engine:emu_window").toString().toStdString(); - - qt_config->endGroup(); - - qt_config->beginGroup("Core"); - Settings::values.cpu_core = - static_cast(qt_config->value("cpu_core", 0).toInt()); - qt_config->endGroup(); - - qt_config->beginGroup("Renderer"); - Settings::values.use_hw_renderer = qt_config->value("use_hw_renderer", true).toBool(); - Settings::values.use_shader_jit = qt_config->value("use_shader_jit", true).toBool(); - Settings::values.resolution_factor = qt_config->value("resolution_factor", 1.0).toFloat(); - Settings::values.use_vsync = qt_config->value("use_vsync", false).toBool(); - Settings::values.toggle_framelimit = qt_config->value("toggle_framelimit", true).toBool(); - - Settings::values.bg_red = qt_config->value("bg_red", 0.0).toFloat(); - Settings::values.bg_green = qt_config->value("bg_green", 0.0).toFloat(); - Settings::values.bg_blue = qt_config->value("bg_blue", 0.0).toFloat(); - qt_config->endGroup(); - - qt_config->beginGroup("Layout"); - Settings::values.layout_option = - static_cast(qt_config->value("layout_option").toInt()); - Settings::values.swap_screen = qt_config->value("swap_screen", false).toBool(); - Settings::values.custom_layout = qt_config->value("custom_layout", false).toBool(); - Settings::values.custom_top_left = qt_config->value("custom_top_left", 0).toInt(); - Settings::values.custom_top_top = qt_config->value("custom_top_top", 0).toInt(); - Settings::values.custom_top_right = qt_config->value("custom_top_right", 400).toInt(); - Settings::values.custom_top_bottom = qt_config->value("custom_top_bottom", 240).toInt(); - Settings::values.custom_bottom_left = qt_config->value("custom_bottom_left", 40).toInt(); - Settings::values.custom_bottom_top = qt_config->value("custom_bottom_top", 240).toInt(); - Settings::values.custom_bottom_right = qt_config->value("custom_bottom_right", 360).toInt(); - Settings::values.custom_bottom_bottom = qt_config->value("custom_bottom_bottom", 480).toInt(); - qt_config->endGroup(); - - qt_config->beginGroup("Audio"); - Settings::values.sink_id = qt_config->value("output_engine", "auto").toString().toStdString(); - Settings::values.enable_audio_stretching = - qt_config->value("enable_audio_stretching", true).toBool(); - Settings::values.audio_device_id = - qt_config->value("output_device", "auto").toString().toStdString(); - qt_config->endGroup(); - - qt_config->beginGroup("Data Storage"); - Settings::values.use_virtual_sd = qt_config->value("use_virtual_sd", true).toBool(); - qt_config->endGroup(); - - qt_config->beginGroup("System"); - Settings::values.is_new_3ds = qt_config->value("is_new_3ds", false).toBool(); - Settings::values.region_value = - qt_config->value("region_value", Settings::REGION_VALUE_AUTO_SELECT).toInt(); - qt_config->endGroup(); - - qt_config->beginGroup("Miscellaneous"); - Settings::values.log_filter = qt_config->value("log_filter", "*:Info").toString().toStdString(); - qt_config->endGroup(); - - qt_config->beginGroup("Debugging"); - Settings::values.use_gdbstub = qt_config->value("use_gdbstub", false).toBool(); - Settings::values.gdbstub_port = qt_config->value("gdbstub_port", 24689).toInt(); - qt_config->endGroup(); - - qt_config->beginGroup("WebService"); - Settings::values.enable_telemetry = qt_config->value("enable_telemetry", true).toBool(); - Settings::values.telemetry_endpoint_url = - qt_config->value("telemetry_endpoint_url", "https://services.citra-emu.org/api/telemetry") - .toString() - .toStdString(); - Settings::values.verify_endpoint_url = - qt_config->value("verify_endpoint_url", "https://services.citra-emu.org/api/profile") - .toString() - .toStdString(); - Settings::values.citra_username = qt_config->value("citra_username").toString().toStdString(); - Settings::values.citra_token = qt_config->value("citra_token").toString().toStdString(); - qt_config->endGroup(); - - qt_config->beginGroup("UI"); - UISettings::values.theme = qt_config->value("theme", UISettings::themes[0].second).toString(); - - qt_config->beginGroup("UILayout"); - UISettings::values.geometry = qt_config->value("geometry").toByteArray(); - UISettings::values.state = qt_config->value("state").toByteArray(); - UISettings::values.renderwindow_geometry = - qt_config->value("geometryRenderWindow").toByteArray(); - UISettings::values.gamelist_header_state = - qt_config->value("gameListHeaderState").toByteArray(); - UISettings::values.microprofile_geometry = - qt_config->value("microProfileDialogGeometry").toByteArray(); - UISettings::values.microprofile_visible = - qt_config->value("microProfileDialogVisible", false).toBool(); - qt_config->endGroup(); - - qt_config->beginGroup("Paths"); - UISettings::values.roms_path = qt_config->value("romsPath").toString(); - UISettings::values.symbols_path = qt_config->value("symbolsPath").toString(); - UISettings::values.gamedir = qt_config->value("gameListRootDir", ".").toString(); - UISettings::values.gamedir_deepscan = qt_config->value("gameListDeepScan", false).toBool(); - UISettings::values.recent_files = qt_config->value("recentFiles").toStringList(); - qt_config->endGroup(); - - qt_config->beginGroup("Shortcuts"); - QStringList groups = qt_config->childGroups(); - for (auto group : groups) { - qt_config->beginGroup(group); - - QStringList hotkeys = qt_config->childGroups(); - for (auto hotkey : hotkeys) { - qt_config->beginGroup(hotkey); - UISettings::values.shortcuts.emplace_back(UISettings::Shortcut( - group + "/" + hotkey, - UISettings::ContextualShortcut(qt_config->value("KeySeq").toString(), - qt_config->value("Context").toInt()))); - qt_config->endGroup(); - } - - qt_config->endGroup(); - } - qt_config->endGroup(); - - UISettings::values.single_window_mode = qt_config->value("singleWindowMode", true).toBool(); - UISettings::values.display_titlebar = qt_config->value("displayTitleBars", true).toBool(); - UISettings::values.show_filter_bar = qt_config->value("showFilterBar", true).toBool(); - UISettings::values.show_status_bar = qt_config->value("showStatusBar", true).toBool(); - UISettings::values.confirm_before_closing = qt_config->value("confirmClose", true).toBool(); - UISettings::values.first_start = qt_config->value("firstStart", true).toBool(); - UISettings::values.callout_flags = qt_config->value("calloutFlags", 0).toUInt(); - - qt_config->endGroup(); -} - -void Config::SaveValues() { - qt_config->beginGroup("Controls"); - for (int i = 0; i < Settings::NativeButton::NumButtons; ++i) { - qt_config->setValue(QString::fromStdString(Settings::NativeButton::mapping[i]), - QString::fromStdString(Settings::values.buttons[i])); - } - for (int i = 0; i < Settings::NativeAnalog::NumAnalogs; ++i) { - qt_config->setValue(QString::fromStdString(Settings::NativeAnalog::mapping[i]), - QString::fromStdString(Settings::values.analogs[i])); - } - qt_config->setValue("motion_device", QString::fromStdString(Settings::values.motion_device)); - qt_config->setValue("touch_device", QString::fromStdString(Settings::values.touch_device)); - qt_config->endGroup(); - - qt_config->beginGroup("Core"); - qt_config->setValue("cpu_core", static_cast(Settings::values.cpu_core)); - qt_config->endGroup(); - - qt_config->beginGroup("Renderer"); - qt_config->setValue("use_hw_renderer", Settings::values.use_hw_renderer); - qt_config->setValue("use_shader_jit", Settings::values.use_shader_jit); - qt_config->setValue("resolution_factor", (double)Settings::values.resolution_factor); - qt_config->setValue("use_vsync", Settings::values.use_vsync); - qt_config->setValue("toggle_framelimit", Settings::values.toggle_framelimit); - - // Cast to double because Qt's written float values are not human-readable - qt_config->setValue("bg_red", (double)Settings::values.bg_red); - qt_config->setValue("bg_green", (double)Settings::values.bg_green); - qt_config->setValue("bg_blue", (double)Settings::values.bg_blue); - qt_config->endGroup(); - - qt_config->beginGroup("Layout"); - qt_config->setValue("layout_option", static_cast(Settings::values.layout_option)); - qt_config->setValue("swap_screen", Settings::values.swap_screen); - qt_config->setValue("custom_layout", Settings::values.custom_layout); - qt_config->setValue("custom_top_left", Settings::values.custom_top_left); - qt_config->setValue("custom_top_top", Settings::values.custom_top_top); - qt_config->setValue("custom_top_right", Settings::values.custom_top_right); - qt_config->setValue("custom_top_bottom", Settings::values.custom_top_bottom); - qt_config->setValue("custom_bottom_left", Settings::values.custom_bottom_left); - qt_config->setValue("custom_bottom_top", Settings::values.custom_bottom_top); - qt_config->setValue("custom_bottom_right", Settings::values.custom_bottom_right); - qt_config->setValue("custom_bottom_bottom", Settings::values.custom_bottom_bottom); - qt_config->endGroup(); - - qt_config->beginGroup("Audio"); - qt_config->setValue("output_engine", QString::fromStdString(Settings::values.sink_id)); - qt_config->setValue("enable_audio_stretching", Settings::values.enable_audio_stretching); - qt_config->setValue("output_device", QString::fromStdString(Settings::values.audio_device_id)); - qt_config->endGroup(); - - qt_config->beginGroup("Data Storage"); - qt_config->setValue("use_virtual_sd", Settings::values.use_virtual_sd); - qt_config->endGroup(); - - qt_config->beginGroup("System"); - qt_config->setValue("is_new_3ds", Settings::values.is_new_3ds); - qt_config->setValue("region_value", Settings::values.region_value); - qt_config->endGroup(); - - qt_config->beginGroup("Miscellaneous"); - qt_config->setValue("log_filter", QString::fromStdString(Settings::values.log_filter)); - qt_config->endGroup(); - - qt_config->beginGroup("Debugging"); - qt_config->setValue("use_gdbstub", Settings::values.use_gdbstub); - qt_config->setValue("gdbstub_port", Settings::values.gdbstub_port); - qt_config->endGroup(); - - qt_config->beginGroup("WebService"); - qt_config->setValue("enable_telemetry", Settings::values.enable_telemetry); - qt_config->setValue("telemetry_endpoint_url", - QString::fromStdString(Settings::values.telemetry_endpoint_url)); - qt_config->setValue("verify_endpoint_url", - QString::fromStdString(Settings::values.verify_endpoint_url)); - qt_config->setValue("citra_username", QString::fromStdString(Settings::values.citra_username)); - qt_config->setValue("citra_token", QString::fromStdString(Settings::values.citra_token)); - qt_config->endGroup(); - - qt_config->beginGroup("UI"); - qt_config->setValue("theme", UISettings::values.theme); - - qt_config->beginGroup("UILayout"); - qt_config->setValue("geometry", UISettings::values.geometry); - qt_config->setValue("state", UISettings::values.state); - qt_config->setValue("geometryRenderWindow", UISettings::values.renderwindow_geometry); - qt_config->setValue("gameListHeaderState", UISettings::values.gamelist_header_state); - qt_config->setValue("microProfileDialogGeometry", UISettings::values.microprofile_geometry); - qt_config->setValue("microProfileDialogVisible", UISettings::values.microprofile_visible); - qt_config->endGroup(); - - qt_config->beginGroup("Paths"); - qt_config->setValue("romsPath", UISettings::values.roms_path); - qt_config->setValue("symbolsPath", UISettings::values.symbols_path); - qt_config->setValue("gameListRootDir", UISettings::values.gamedir); - qt_config->setValue("gameListDeepScan", UISettings::values.gamedir_deepscan); - qt_config->setValue("recentFiles", UISettings::values.recent_files); - qt_config->endGroup(); - - qt_config->beginGroup("Shortcuts"); - for (auto shortcut : UISettings::values.shortcuts) { - qt_config->setValue(shortcut.first + "/KeySeq", shortcut.second.first); - qt_config->setValue(shortcut.first + "/Context", shortcut.second.second); - } - qt_config->endGroup(); - - qt_config->setValue("singleWindowMode", UISettings::values.single_window_mode); - qt_config->setValue("displayTitleBars", UISettings::values.display_titlebar); - qt_config->setValue("showFilterBar", UISettings::values.show_filter_bar); - qt_config->setValue("showStatusBar", UISettings::values.show_status_bar); - qt_config->setValue("confirmClose", UISettings::values.confirm_before_closing); - qt_config->setValue("firstStart", UISettings::values.first_start); - qt_config->setValue("calloutFlags", UISettings::values.callout_flags); - - qt_config->endGroup(); -} - -void Config::Reload() { - ReadValues(); - Settings::Apply(); -} - -void Config::Save() { - SaveValues(); -} - -Config::~Config() { - Save(); - - delete qt_config; -} diff --git a/src/citra_qt/configuration/config.h b/src/citra_qt/configuration/config.h deleted file mode 100644 index cbf745ea2..000000000 --- a/src/citra_qt/configuration/config.h +++ /dev/null @@ -1,30 +0,0 @@ -// Copyright 2014 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include -#include -#include "core/settings.h" - -class QSettings; - -class Config { - QSettings* qt_config; - std::string qt_config_loc; - - void ReadValues(); - void SaveValues(); - -public: - Config(); - ~Config(); - - void Reload(); - void Save(); - - static const std::array default_buttons; - static const std::array, Settings::NativeAnalog::NumAnalogs> default_analogs; -}; diff --git a/src/citra_qt/configuration/configure.ui b/src/citra_qt/configuration/configure.ui deleted file mode 100644 index 6abd1917e..000000000 --- a/src/citra_qt/configuration/configure.ui +++ /dev/null @@ -1,147 +0,0 @@ - - - ConfigureDialog - - - - 0 - 0 - 740 - 500 - - - - Citra Configuration - - - - - - 0 - - - - General - - - - - System - - - - - Input - - - - - Graphics - - - - - Audio - - - - - Debug - - - - - Web - - - - - - - - QDialogButtonBox::Cancel|QDialogButtonBox::Ok - - - - - - - - ConfigureGeneral - QWidget -
configuration/configure_general.h
- 1 - - - ConfigureSystem - QWidget -
configuration/configure_system.h
- 1 - - - ConfigureAudio - QWidget -
configuration/configure_audio.h
- 1 - - - ConfigureDebug - QWidget -
configuration/configure_debug.h
- 1 - - - ConfigureInput - QWidget -
configuration/configure_input.h
- 1 - - - ConfigureGraphics - QWidget -
configuration/configure_graphics.h
- 1 - - - ConfigureWeb - QWidget -
configuration/configure_web.h
- 1 - - - - - - buttonBox - accepted() - ConfigureDialog - accept() - - - 220 - 380 - - - 220 - 200 - - - - - buttonBox - rejected() - ConfigureDialog - reject() - - - 220 - 380 - - - 220 - 200 - - - - - diff --git a/src/citra_qt/configuration/configure_audio.cpp b/src/citra_qt/configuration/configure_audio.cpp deleted file mode 100644 index 3fd1d127a..000000000 --- a/src/citra_qt/configuration/configure_audio.cpp +++ /dev/null @@ -1,77 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#include -#include "audio_core/audio_core.h" -#include "audio_core/sink.h" -#include "audio_core/sink_details.h" -#include "citra_qt/configuration/configure_audio.h" -#include "core/settings.h" -#include "ui_configure_audio.h" - -ConfigureAudio::ConfigureAudio(QWidget* parent) - : QWidget(parent), ui(std::make_unique()) { - ui->setupUi(this); - - ui->output_sink_combo_box->clear(); - ui->output_sink_combo_box->addItem("auto"); - for (const auto& sink_detail : AudioCore::g_sink_details) { - ui->output_sink_combo_box->addItem(sink_detail.id); - } - - this->setConfiguration(); - connect(ui->output_sink_combo_box, SIGNAL(currentIndexChanged(int)), this, - SLOT(updateAudioDevices(int))); -} - -ConfigureAudio::~ConfigureAudio() {} - -void ConfigureAudio::setConfiguration() { - int new_sink_index = 0; - for (int index = 0; index < ui->output_sink_combo_box->count(); index++) { - if (ui->output_sink_combo_box->itemText(index).toStdString() == Settings::values.sink_id) { - new_sink_index = index; - break; - } - } - ui->output_sink_combo_box->setCurrentIndex(new_sink_index); - - ui->toggle_audio_stretching->setChecked(Settings::values.enable_audio_stretching); - - // The device list cannot be pre-populated (nor listed) until the output sink is known. - updateAudioDevices(new_sink_index); - - int new_device_index = -1; - for (int index = 0; index < ui->audio_device_combo_box->count(); index++) { - if (ui->audio_device_combo_box->itemText(index).toStdString() == - Settings::values.audio_device_id) { - new_device_index = index; - break; - } - } - ui->audio_device_combo_box->setCurrentIndex(new_device_index); -} - -void ConfigureAudio::applyConfiguration() { - Settings::values.sink_id = - ui->output_sink_combo_box->itemText(ui->output_sink_combo_box->currentIndex()) - .toStdString(); - Settings::values.enable_audio_stretching = ui->toggle_audio_stretching->isChecked(); - Settings::values.audio_device_id = - ui->audio_device_combo_box->itemText(ui->audio_device_combo_box->currentIndex()) - .toStdString(); - Settings::Apply(); -} - -void ConfigureAudio::updateAudioDevices(int sink_index) { - ui->audio_device_combo_box->clear(); - ui->audio_device_combo_box->addItem("auto"); - - std::string sink_id = ui->output_sink_combo_box->itemText(sink_index).toStdString(); - std::vector device_list = - AudioCore::GetSinkDetails(sink_id).factory()->GetDeviceList(); - for (const auto& device : device_list) { - ui->audio_device_combo_box->addItem(device.c_str()); - } -} diff --git a/src/citra_qt/configuration/configure_audio.h b/src/citra_qt/configuration/configure_audio.h deleted file mode 100644 index 8190e694f..000000000 --- a/src/citra_qt/configuration/configure_audio.h +++ /dev/null @@ -1,30 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include - -namespace Ui { -class ConfigureAudio; -} - -class ConfigureAudio : public QWidget { - Q_OBJECT - -public: - explicit ConfigureAudio(QWidget* parent = nullptr); - ~ConfigureAudio(); - - void applyConfiguration(); - -public slots: - void updateAudioDevices(int sink_index); - -private: - void setConfiguration(); - - std::unique_ptr ui; -}; diff --git a/src/citra_qt/configuration/configure_audio.ui b/src/citra_qt/configuration/configure_audio.ui deleted file mode 100644 index dd870eb61..000000000 --- a/src/citra_qt/configuration/configure_audio.ui +++ /dev/null @@ -1,73 +0,0 @@ - - - - ConfigureAudio - - - - - - Audio - - - - - - - - Output Engine: - - - - - - - - - - - - - Enable audio stretching - - - This post-processing effect adjusts audio speed to match emulation speed and helps prevent audio stutter. This however increases audio latency. - - - - - - - - - Audio Device: - - - - - - - - - - - - - - - - Qt::Vertical - - - - 20 - 40 - - - - - - - - - diff --git a/src/citra_qt/configuration/configure_debug.cpp b/src/citra_qt/configuration/configure_debug.cpp deleted file mode 100644 index 263f73f38..000000000 --- a/src/citra_qt/configuration/configure_debug.cpp +++ /dev/null @@ -1,26 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#include "citra_qt/configuration/configure_debug.h" -#include "core/settings.h" -#include "ui_configure_debug.h" - -ConfigureDebug::ConfigureDebug(QWidget* parent) : QWidget(parent), ui(new Ui::ConfigureDebug) { - ui->setupUi(this); - this->setConfiguration(); -} - -ConfigureDebug::~ConfigureDebug() {} - -void ConfigureDebug::setConfiguration() { - ui->toggle_gdbstub->setChecked(Settings::values.use_gdbstub); - ui->gdbport_spinbox->setEnabled(Settings::values.use_gdbstub); - ui->gdbport_spinbox->setValue(Settings::values.gdbstub_port); -} - -void ConfigureDebug::applyConfiguration() { - Settings::values.use_gdbstub = ui->toggle_gdbstub->isChecked(); - Settings::values.gdbstub_port = ui->gdbport_spinbox->value(); - Settings::Apply(); -} diff --git a/src/citra_qt/configuration/configure_debug.h b/src/citra_qt/configuration/configure_debug.h deleted file mode 100644 index d167eb996..000000000 --- a/src/citra_qt/configuration/configure_debug.h +++ /dev/null @@ -1,28 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include - -namespace Ui { -class ConfigureDebug; -} - -class ConfigureDebug : public QWidget { - Q_OBJECT - -public: - explicit ConfigureDebug(QWidget* parent = nullptr); - ~ConfigureDebug(); - - void applyConfiguration(); - -private: - void setConfiguration(); - -private: - std::unique_ptr ui; -}; diff --git a/src/citra_qt/configuration/configure_debug.ui b/src/citra_qt/configuration/configure_debug.ui deleted file mode 100644 index 96638ebdb..000000000 --- a/src/citra_qt/configuration/configure_debug.ui +++ /dev/null @@ -1,109 +0,0 @@ - - - ConfigureDebug - - - - 0 - 0 - 400 - 300 - - - - Form - - - - - - - - GDB - - - - - - The GDB Stub only works correctly when the CPU JIT is off. - - - - - - - - - Enable GDB Stub - - - - - - - Qt::Horizontal - - - - 40 - 20 - - - - - - - - Port: - - - - - - - 65536 - - - - - - - - - - - - - - Qt::Vertical - - - - 20 - 40 - - - - - - - - - - toggle_gdbstub - toggled(bool) - gdbport_spinbox - setEnabled(bool) - - - 84 - 157 - - - 342 - 158 - - - - - diff --git a/src/citra_qt/configuration/configure_dialog.cpp b/src/citra_qt/configuration/configure_dialog.cpp deleted file mode 100644 index b87dc0e6c..000000000 --- a/src/citra_qt/configuration/configure_dialog.cpp +++ /dev/null @@ -1,28 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#include "citra_qt/configuration/config.h" -#include "citra_qt/configuration/configure_dialog.h" -#include "core/settings.h" -#include "ui_configure.h" - -ConfigureDialog::ConfigureDialog(QWidget* parent) : QDialog(parent), ui(new Ui::ConfigureDialog) { - ui->setupUi(this); - this->setConfiguration(); -} - -ConfigureDialog::~ConfigureDialog() {} - -void ConfigureDialog::setConfiguration() {} - -void ConfigureDialog::applyConfiguration() { - ui->generalTab->applyConfiguration(); - ui->systemTab->applyConfiguration(); - ui->inputTab->applyConfiguration(); - ui->graphicsTab->applyConfiguration(); - ui->audioTab->applyConfiguration(); - ui->debugTab->applyConfiguration(); - ui->webTab->applyConfiguration(); - Settings::Apply(); -} diff --git a/src/citra_qt/configuration/configure_dialog.h b/src/citra_qt/configuration/configure_dialog.h deleted file mode 100644 index 21fa1f501..000000000 --- a/src/citra_qt/configuration/configure_dialog.h +++ /dev/null @@ -1,28 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include - -namespace Ui { -class ConfigureDialog; -} - -class ConfigureDialog : public QDialog { - Q_OBJECT - -public: - explicit ConfigureDialog(QWidget* parent); - ~ConfigureDialog(); - - void applyConfiguration(); - -private: - void setConfiguration(); - -private: - std::unique_ptr ui; -}; diff --git a/src/citra_qt/configuration/configure_general.cpp b/src/citra_qt/configuration/configure_general.cpp deleted file mode 100644 index 0de27aa8b..000000000 --- a/src/citra_qt/configuration/configure_general.cpp +++ /dev/null @@ -1,47 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#include "citra_qt/configuration/configure_general.h" -#include "citra_qt/ui_settings.h" -#include "core/core.h" -#include "core/settings.h" -#include "ui_configure_general.h" - -ConfigureGeneral::ConfigureGeneral(QWidget* parent) - : QWidget(parent), ui(new Ui::ConfigureGeneral) { - - ui->setupUi(this); - - for (auto theme : UISettings::themes) { - ui->theme_combobox->addItem(theme.first, theme.second); - } - - this->setConfiguration(); - - ui->cpu_core_combobox->setEnabled(!Core::System::GetInstance().IsPoweredOn()); -} - -ConfigureGeneral::~ConfigureGeneral() {} - -void ConfigureGeneral::setConfiguration() { - ui->toggle_deepscan->setChecked(UISettings::values.gamedir_deepscan); - ui->toggle_check_exit->setChecked(UISettings::values.confirm_before_closing); - - // The first item is "auto-select" with actual value -1, so plus one here will do the trick - ui->region_combobox->setCurrentIndex(Settings::values.region_value + 1); - - ui->theme_combobox->setCurrentIndex(ui->theme_combobox->findData(UISettings::values.theme)); - ui->cpu_core_combobox->setCurrentIndex(static_cast(Settings::values.cpu_core)); -} - -void ConfigureGeneral::applyConfiguration() { - UISettings::values.gamedir_deepscan = ui->toggle_deepscan->isChecked(); - UISettings::values.confirm_before_closing = ui->toggle_check_exit->isChecked(); - UISettings::values.theme = - ui->theme_combobox->itemData(ui->theme_combobox->currentIndex()).toString(); - Settings::values.region_value = ui->region_combobox->currentIndex() - 1; - Settings::values.cpu_core = - static_cast(ui->cpu_core_combobox->currentIndex()); - Settings::Apply(); -} diff --git a/src/citra_qt/configuration/configure_general.h b/src/citra_qt/configuration/configure_general.h deleted file mode 100644 index 447552d8c..000000000 --- a/src/citra_qt/configuration/configure_general.h +++ /dev/null @@ -1,28 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include - -namespace Ui { -class ConfigureGeneral; -} - -class ConfigureGeneral : public QWidget { - Q_OBJECT - -public: - explicit ConfigureGeneral(QWidget* parent = nullptr); - ~ConfigureGeneral(); - - void applyConfiguration(); - -private: - void setConfiguration(); - -private: - std::unique_ptr ui; -}; diff --git a/src/citra_qt/configuration/configure_general.ui b/src/citra_qt/configuration/configure_general.ui deleted file mode 100644 index e88c37936..000000000 --- a/src/citra_qt/configuration/configure_general.ui +++ /dev/null @@ -1,199 +0,0 @@ - - - ConfigureGeneral - - - - 0 - 0 - 300 - 377 - - - - Form - - - - - - - - General - - - - - - - - Search sub-directories for games - - - - - - - Confirm exit while emulation is running - - - - - - - - - - - - CPU Core - - - - - - - - - Unicorn - - - - - Dynarmic - - - - - - - - - - - - - Emulation - - - - - - - - - - Region: - - - - - - - - Auto-select - - - - - JPN - - - - - USA - - - - - EUR - - - - - AUS - - - - - CHN - - - - - KOR - - - - - TWN - - - - - - - - - - - - - - - Theme - - - - - - - - - - Theme: - - - - - - - - - - - - - - - - - - Hotkeys - - - - - - - - - - - - - - - - - - - GHotkeysDialog - QWidget -
hotkeys.h
- 1 - - - - - diff --git a/src/citra_qt/configuration/configure_graphics.cpp b/src/citra_qt/configuration/configure_graphics.cpp deleted file mode 100644 index b5a5ab1e1..000000000 --- a/src/citra_qt/configuration/configure_graphics.cpp +++ /dev/null @@ -1,115 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#include "citra_qt/configuration/configure_graphics.h" -#include "core/core.h" -#include "core/settings.h" -#include "ui_configure_graphics.h" - -ConfigureGraphics::ConfigureGraphics(QWidget* parent) - : QWidget(parent), ui(new Ui::ConfigureGraphics) { - - ui->setupUi(this); - this->setConfiguration(); - - ui->toggle_vsync->setEnabled(!Core::System::GetInstance().IsPoweredOn()); - - ui->layoutBox->setEnabled(!Settings::values.custom_layout); -} - -ConfigureGraphics::~ConfigureGraphics() {} - -enum class Resolution : int { - Auto, - Scale1x, - Scale2x, - Scale3x, - Scale4x, - Scale5x, - Scale6x, - Scale7x, - Scale8x, - Scale9x, - Scale10x, -}; - -float ToResolutionFactor(Resolution option) { - switch (option) { - case Resolution::Auto: - return 0.f; - case Resolution::Scale1x: - return 1.f; - case Resolution::Scale2x: - return 2.f; - case Resolution::Scale3x: - return 3.f; - case Resolution::Scale4x: - return 4.f; - case Resolution::Scale5x: - return 5.f; - case Resolution::Scale6x: - return 6.f; - case Resolution::Scale7x: - return 7.f; - case Resolution::Scale8x: - return 8.f; - case Resolution::Scale9x: - return 9.f; - case Resolution::Scale10x: - return 10.f; - } - return 0.f; -} - -Resolution FromResolutionFactor(float factor) { - if (factor == 0.f) { - return Resolution::Auto; - } else if (factor == 1.f) { - return Resolution::Scale1x; - } else if (factor == 2.f) { - return Resolution::Scale2x; - } else if (factor == 3.f) { - return Resolution::Scale3x; - } else if (factor == 4.f) { - return Resolution::Scale4x; - } else if (factor == 5.f) { - return Resolution::Scale5x; - } else if (factor == 6.f) { - return Resolution::Scale6x; - } else if (factor == 7.f) { - return Resolution::Scale7x; - } else if (factor == 8.f) { - return Resolution::Scale8x; - } else if (factor == 9.f) { - return Resolution::Scale9x; - } else if (factor == 10.f) { - return Resolution::Scale10x; - } - return Resolution::Auto; -} - -void ConfigureGraphics::setConfiguration() { - ui->toggle_hw_renderer->setChecked(Settings::values.use_hw_renderer); - ui->resolution_factor_combobox->setEnabled(Settings::values.use_hw_renderer); - ui->toggle_shader_jit->setChecked(Settings::values.use_shader_jit); - ui->resolution_factor_combobox->setCurrentIndex( - static_cast(FromResolutionFactor(Settings::values.resolution_factor))); - ui->toggle_vsync->setChecked(Settings::values.use_vsync); - ui->toggle_framelimit->setChecked(Settings::values.toggle_framelimit); - ui->layout_combobox->setCurrentIndex(static_cast(Settings::values.layout_option)); - ui->swap_screen->setChecked(Settings::values.swap_screen); -} - -void ConfigureGraphics::applyConfiguration() { - Settings::values.use_hw_renderer = ui->toggle_hw_renderer->isChecked(); - Settings::values.use_shader_jit = ui->toggle_shader_jit->isChecked(); - Settings::values.resolution_factor = - ToResolutionFactor(static_cast(ui->resolution_factor_combobox->currentIndex())); - Settings::values.use_vsync = ui->toggle_vsync->isChecked(); - Settings::values.toggle_framelimit = ui->toggle_framelimit->isChecked(); - Settings::values.layout_option = - static_cast(ui->layout_combobox->currentIndex()); - Settings::values.swap_screen = ui->swap_screen->isChecked(); - Settings::Apply(); -} diff --git a/src/citra_qt/configuration/configure_graphics.h b/src/citra_qt/configuration/configure_graphics.h deleted file mode 100644 index 5497a55f7..000000000 --- a/src/citra_qt/configuration/configure_graphics.h +++ /dev/null @@ -1,28 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include - -namespace Ui { -class ConfigureGraphics; -} - -class ConfigureGraphics : public QWidget { - Q_OBJECT - -public: - explicit ConfigureGraphics(QWidget* parent = nullptr); - ~ConfigureGraphics(); - - void applyConfiguration(); - -private: - void setConfiguration(); - -private: - std::unique_ptr ui; -}; diff --git a/src/citra_qt/configuration/configure_graphics.ui b/src/citra_qt/configuration/configure_graphics.ui deleted file mode 100644 index 5667b14b6..000000000 --- a/src/citra_qt/configuration/configure_graphics.ui +++ /dev/null @@ -1,207 +0,0 @@ - - - ConfigureGraphics - - - - 0 - 0 - 400 - 300 - - - - Form - - - - - - - - Graphics - - - - - - Enable hardware renderer - - - - - - - Enable shader JIT - - - - - - - Enable V-Sync - - - - - - - Limit framerate - - - - - - - - - Internal Resolution: - - - - - - - - Auto (Window Size) - - - - - Native (400x240) - - - - - 2x Native (800x480) - - - - - 3x Native (1200x720) - - - - - 4x Native (1600x960) - - - - - 5x Native (2000x1200) - - - - - 6x Native (2400x1440) - - - - - 7x Native (2800x1680) - - - - - 8x Native (3200x1920) - - - - - 9x Native (3600x2160) - - - - - 10x Native (4000x2400) - - - - - - - - - - - - - - - Layout - - - - - - - - - - Screen Layout: - - - - - - - - Default - - - - - Single Screen - - - - - Large Screen - - - - - Side by Side - - - - - - - - - - Swap Screens - - - - - - - - - - - - Qt::Vertical - - - - 20 - 40 - - - - - - - - - - toggle_hw_renderer - toggled(bool) - resolution_factor_combobox - setEnabled(bool) - - - diff --git a/src/citra_qt/configuration/configure_input.cpp b/src/citra_qt/configuration/configure_input.cpp deleted file mode 100644 index 116a6330f..000000000 --- a/src/citra_qt/configuration/configure_input.cpp +++ /dev/null @@ -1,199 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#include -#include -#include -#include -#include "citra_qt/configuration/config.h" -#include "citra_qt/configuration/configure_input.h" -#include "common/param_package.h" -#include "input_common/main.h" - -const std::array - ConfigureInput::analog_sub_buttons{{ - "up", "down", "left", "right", "modifier", - }}; - -static QString getKeyName(int key_code) { - switch (key_code) { - case Qt::Key_Shift: - return QObject::tr("Shift"); - case Qt::Key_Control: - return QObject::tr("Ctrl"); - case Qt::Key_Alt: - return QObject::tr("Alt"); - case Qt::Key_Meta: - return ""; - default: - return QKeySequence(key_code).toString(); - } -} - -static void SetButtonKey(int key, Common::ParamPackage& button_param) { - button_param = Common::ParamPackage{InputCommon::GenerateKeyboardParam(key)}; -} - -static void SetAnalogKey(int key, Common::ParamPackage& analog_param, - const std::string& button_name) { - if (analog_param.Get("engine", "") != "analog_from_button") { - analog_param = { - {"engine", "analog_from_button"}, {"modifier_scale", "0.5"}, - }; - } - analog_param.Set(button_name, InputCommon::GenerateKeyboardParam(key)); -} - -ConfigureInput::ConfigureInput(QWidget* parent) - : QWidget(parent), ui(std::make_unique()), - timer(std::make_unique()) { - - ui->setupUi(this); - setFocusPolicy(Qt::ClickFocus); - - button_map = { - ui->buttonA, ui->buttonB, ui->buttonX, ui->buttonY, ui->buttonDpadUp, - ui->buttonDpadDown, ui->buttonDpadLeft, ui->buttonDpadRight, ui->buttonL, ui->buttonR, - ui->buttonStart, ui->buttonSelect, ui->buttonZL, ui->buttonZR, ui->buttonHome, - }; - - analog_map = {{ - { - ui->buttonCircleUp, ui->buttonCircleDown, ui->buttonCircleLeft, ui->buttonCircleRight, - ui->buttonCircleMod, - }, - { - ui->buttonCStickUp, ui->buttonCStickDown, ui->buttonCStickLeft, ui->buttonCStickRight, - nullptr, - }, - }}; - - for (int button_id = 0; button_id < Settings::NativeButton::NumButtons; button_id++) { - if (button_map[button_id]) - connect(button_map[button_id], &QPushButton::released, [=]() { - handleClick(button_map[button_id], - [=](int key) { SetButtonKey(key, buttons_param[button_id]); }); - }); - } - - for (int analog_id = 0; analog_id < Settings::NativeAnalog::NumAnalogs; analog_id++) { - for (int sub_button_id = 0; sub_button_id < ANALOG_SUB_BUTTONS_NUM; sub_button_id++) { - if (analog_map[analog_id][sub_button_id] != nullptr) { - connect(analog_map[analog_id][sub_button_id], &QPushButton::released, [=]() { - handleClick(analog_map[analog_id][sub_button_id], [=](int key) { - SetAnalogKey(key, analogs_param[analog_id], - analog_sub_buttons[sub_button_id]); - }); - }); - } - } - } - - connect(ui->buttonRestoreDefaults, &QPushButton::released, [this]() { restoreDefaults(); }); - - timer->setSingleShot(true); - connect(timer.get(), &QTimer::timeout, [this]() { - releaseKeyboard(); - releaseMouse(); - key_setter = boost::none; - updateButtonLabels(); - }); - - this->loadConfiguration(); - - // TODO(wwylele): enable this when we actually emulate it - ui->buttonHome->setEnabled(false); -} - -void ConfigureInput::applyConfiguration() { - std::transform(buttons_param.begin(), buttons_param.end(), Settings::values.buttons.begin(), - [](const Common::ParamPackage& param) { return param.Serialize(); }); - std::transform(analogs_param.begin(), analogs_param.end(), Settings::values.analogs.begin(), - [](const Common::ParamPackage& param) { return param.Serialize(); }); - - Settings::Apply(); -} - -void ConfigureInput::loadConfiguration() { - std::transform(Settings::values.buttons.begin(), Settings::values.buttons.end(), - buttons_param.begin(), - [](const std::string& str) { return Common::ParamPackage(str); }); - std::transform(Settings::values.analogs.begin(), Settings::values.analogs.end(), - analogs_param.begin(), - [](const std::string& str) { return Common::ParamPackage(str); }); - updateButtonLabels(); -} - -void ConfigureInput::restoreDefaults() { - for (int button_id = 0; button_id < Settings::NativeButton::NumButtons; button_id++) { - SetButtonKey(Config::default_buttons[button_id], buttons_param[button_id]); - } - - for (int analog_id = 0; analog_id < Settings::NativeAnalog::NumAnalogs; analog_id++) { - for (int sub_button_id = 0; sub_button_id < ANALOG_SUB_BUTTONS_NUM; sub_button_id++) { - SetAnalogKey(Config::default_analogs[analog_id][sub_button_id], - analogs_param[analog_id], analog_sub_buttons[sub_button_id]); - } - } - updateButtonLabels(); - applyConfiguration(); -} - -void ConfigureInput::updateButtonLabels() { - QString non_keyboard(tr("[non-keyboard]")); - - auto KeyToText = [&non_keyboard](const Common::ParamPackage& param) { - if (param.Get("engine", "") != "keyboard") { - return non_keyboard; - } else { - return getKeyName(param.Get("code", 0)); - } - }; - - for (int button = 0; button < Settings::NativeButton::NumButtons; button++) { - button_map[button]->setText(KeyToText(buttons_param[button])); - } - - for (int analog_id = 0; analog_id < Settings::NativeAnalog::NumAnalogs; analog_id++) { - if (analogs_param[analog_id].Get("engine", "") != "analog_from_button") { - for (QPushButton* button : analog_map[analog_id]) { - if (button) - button->setText(non_keyboard); - } - } else { - for (int sub_button_id = 0; sub_button_id < ANALOG_SUB_BUTTONS_NUM; sub_button_id++) { - Common::ParamPackage param( - analogs_param[analog_id].Get(analog_sub_buttons[sub_button_id], "")); - if (analog_map[analog_id][sub_button_id]) - analog_map[analog_id][sub_button_id]->setText(KeyToText(param)); - } - } - } -} - -void ConfigureInput::handleClick(QPushButton* button, std::function new_key_setter) { - button->setText(tr("[press key]")); - button->setFocus(); - - key_setter = new_key_setter; - - grabKeyboard(); - grabMouse(); - timer->start(5000); // Cancel after 5 seconds -} - -void ConfigureInput::keyPressEvent(QKeyEvent* event) { - releaseKeyboard(); - releaseMouse(); - - if (!key_setter || !event) - return; - - if (event->key() != Qt::Key_Escape) - (*key_setter)(event->key()); - - updateButtonLabels(); - key_setter = boost::none; - timer->stop(); -} diff --git a/src/citra_qt/configuration/configure_input.h b/src/citra_qt/configuration/configure_input.h deleted file mode 100644 index c950fbcb4..000000000 --- a/src/citra_qt/configuration/configure_input.h +++ /dev/null @@ -1,69 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include -#include -#include -#include -#include -#include -#include "common/param_package.h" -#include "core/settings.h" -#include "ui_configure_input.h" - -class QPushButton; -class QString; -class QTimer; - -namespace Ui { -class ConfigureInput; -} - -class ConfigureInput : public QWidget { - Q_OBJECT - -public: - explicit ConfigureInput(QWidget* parent = nullptr); - - /// Save all button configurations to settings file - void applyConfiguration(); - -private: - std::unique_ptr ui; - - std::unique_ptr timer; - - /// This will be the the setting function when an input is awaiting configuration. - boost::optional> key_setter; - - std::array buttons_param; - std::array analogs_param; - - static constexpr int ANALOG_SUB_BUTTONS_NUM = 5; - - /// Each button input is represented by a QPushButton. - std::array button_map; - - /// Each analog input is represented by five QPushButtons which represents up, down, left, right - /// and modifier - std::array, Settings::NativeAnalog::NumAnalogs> - analog_map; - - static const std::array analog_sub_buttons; - - /// Load configuration settings. - void loadConfiguration(); - /// Restore all buttons to their default values. - void restoreDefaults(); - /// Update UI to reflect current configuration. - void updateButtonLabels(); - - /// Called when the button was pressed. - void handleClick(QPushButton* button, std::function new_key_setter); - /// Handle key press events. - void keyPressEvent(QKeyEvent* event) override; -}; diff --git a/src/citra_qt/configuration/configure_input.ui b/src/citra_qt/configuration/configure_input.ui deleted file mode 100644 index 2760787e5..000000000 --- a/src/citra_qt/configuration/configure_input.ui +++ /dev/null @@ -1,592 +0,0 @@ - - - ConfigureInput - - - - 0 - 0 - 370 - 534 - - - - ConfigureInput - - - - - - - - Face Buttons - - - false - - - false - - - - - - - - A: - - - - - - - - - - - - - - - - - - B: - - - - - - - - - - - - - - - - - - X: - - - - - - - - - - - - - - - - - - Y: - - - - - - - - - - - - - - - - - - - Directional Pad - - - false - - - false - - - - - - - - Up: - - - - - - - - - - - - - - - - - - Down: - - - - - - - - - - - - - - - - - - Left: - - - - - - - - - - - - - - - - - - Right: - - - - - - - - - - - - - - - - - - - Shoulder Buttons - - - false - - - false - - - - - - - - L: - - - - - - - - - - - - - - - - - - R: - - - - - - - - - - - - - - - - - - ZL: - - - - - - - - - - - - - - - - - - ZR: - - - - - - - - - - - - - - - - - - - Circle Pad - - - false - - - false - - - - - - - - Left: - - - - - - - - - - - - - - - - - - Right: - - - - - - - - - - - - - - - - - - Up: - - - - - - - - - - - - - - - - - - Down: - - - - - - - - - - - - - - - - - - - C-Stick - - - false - - - false - - - - - - - - Left: - - - - - - - - - - - - - - - - - - Right: - - - - - - - - - - - - - - - - - - Up: - - - - - - - - - - - - - - - - - - Down: - - - - - - - - - - - - - - - - - - - Misc. - - - false - - - false - - - - - - - - Start: - - - - - - - - - - - - - - - - - - Select: - - - - - - - - - - - - - - - - - - Home: - - - - - - - - - - - - - - - - - - Circle Mod: - - - - - - - - - - - - - - - - - - - - - - - Qt::Horizontal - - - - 40 - 20 - - - - - - - - - 0 - 0 - - - - - 0 - 0 - - - - - 0 - 0 - - - - Qt::LeftToRight - - - Restore Defaults - - - - - - - - - - diff --git a/src/citra_qt/configuration/configure_system.cpp b/src/citra_qt/configuration/configure_system.cpp deleted file mode 100644 index d83c2db23..000000000 --- a/src/citra_qt/configuration/configure_system.cpp +++ /dev/null @@ -1,77 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#include -#include "citra_qt/configuration/configure_system.h" -#include "citra_qt/ui_settings.h" -#include "core/core.h" -#include "ui_configure_system.h" - -static const std::array days_in_month = {{ - 31, 29, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31, -}}; - -ConfigureSystem::ConfigureSystem(QWidget* parent) : QWidget(parent), ui(new Ui::ConfigureSystem) { - ui->setupUi(this); - connect(ui->combo_birthmonth, - static_cast(&QComboBox::currentIndexChanged), this, - &ConfigureSystem::updateBirthdayComboBox); - connect(ui->button_regenerate_console_id, &QPushButton::clicked, this, - &ConfigureSystem::refreshConsoleID); - - this->setConfiguration(); -} - -ConfigureSystem::~ConfigureSystem() {} - -void ConfigureSystem::setConfiguration() { - enabled = !Core::System::GetInstance().IsPoweredOn(); -} - -void ConfigureSystem::ReadSystemSettings() { -} - -void ConfigureSystem::applyConfiguration() { - if (!enabled) - return; -} - -void ConfigureSystem::updateBirthdayComboBox(int birthmonth_index) { - if (birthmonth_index < 0 || birthmonth_index >= 12) - return; - - // store current day selection - int birthday_index = ui->combo_birthday->currentIndex(); - - // get number of days in the new selected month - int days = days_in_month[birthmonth_index]; - - // if the selected day is out of range, - // reset it to 1st - if (birthday_index < 0 || birthday_index >= days) - birthday_index = 0; - - // update the day combo box - ui->combo_birthday->clear(); - for (int i = 1; i <= days; ++i) { - ui->combo_birthday->addItem(QString::number(i)); - } - - // restore the day selection - ui->combo_birthday->setCurrentIndex(birthday_index); -} - -void ConfigureSystem::refreshConsoleID() { - QMessageBox::StandardButton reply; - QString warning_text = tr("This will replace your current virtual 3DS with a new one. " - "Your current virtual 3DS will not be recoverable. " - "This might have unexpected effects in games. This might fail, " - "if you use an outdated config savegame. Continue?"); - reply = QMessageBox::critical(this, tr("Warning"), warning_text, - QMessageBox::No | QMessageBox::Yes); - if (reply == QMessageBox::No) - return; - u64 console_id{}; - ui->label_console_id->setText("Console ID: 0x" + QString::number(console_id, 16).toUpper()); -} diff --git a/src/citra_qt/configuration/configure_system.h b/src/citra_qt/configuration/configure_system.h deleted file mode 100644 index f13de17d4..000000000 --- a/src/citra_qt/configuration/configure_system.h +++ /dev/null @@ -1,38 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include - -namespace Ui { -class ConfigureSystem; -} - -class ConfigureSystem : public QWidget { - Q_OBJECT - -public: - explicit ConfigureSystem(QWidget* parent = nullptr); - ~ConfigureSystem(); - - void applyConfiguration(); - void setConfiguration(); - -public slots: - void updateBirthdayComboBox(int birthmonth_index); - void refreshConsoleID(); - -private: - void ReadSystemSettings(); - - std::unique_ptr ui; - bool enabled; - - std::u16string username; - int birthmonth, birthday; - int language_index; - int sound_index; -}; diff --git a/src/citra_qt/configuration/configure_system.ui b/src/citra_qt/configuration/configure_system.ui deleted file mode 100644 index 8caf49623..000000000 --- a/src/citra_qt/configuration/configure_system.ui +++ /dev/null @@ -1,278 +0,0 @@ - - - ConfigureSystem - - - - 0 - 0 - 360 - 377 - - - - Form - - - - - - - - System Settings - - - - - - Username - - - - - - - - 0 - 0 - - - - 10 - - - - - - - Birthday - - - - - - - - - - January - - - - - February - - - - - March - - - - - April - - - - - May - - - - - June - - - - - July - - - - - August - - - - - September - - - - - October - - - - - November - - - - - December - - - - - - - - - - - - - Language - - - - - - - Note: this can be overridden when region setting is auto-select - - - - Japanese (日本語) - - - - - English - - - - - French (français) - - - - - German (Deutsch) - - - - - Italian (italiano) - - - - - Spanish (español) - - - - - Simplified Chinese (简体中文) - - - - - Korean (한국어) - - - - - Dutch (Nederlands) - - - - - Portuguese (português) - - - - - Russian (Русский) - - - - - Traditional Chinese (正體中文) - - - - - - - - Sound output mode - - - - - - - - Mono - - - - - Stereo - - - - - Surround - - - - - - - - Console ID: - - - - - - - - 0 - 0 - - - - Qt::RightToLeft - - - Regenerate - - - - - - - - - - System settings are available only when game is not running. - - - true - - - - - - - Qt::Vertical - - - - 20 - 40 - - - - - - - - - - - diff --git a/src/citra_qt/configuration/configure_web.cpp b/src/citra_qt/configuration/configure_web.cpp deleted file mode 100644 index bf8c21ac7..000000000 --- a/src/citra_qt/configuration/configure_web.cpp +++ /dev/null @@ -1,102 +0,0 @@ -// Copyright 2017 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#include -#include "citra_qt/configuration/configure_web.h" -#include "core/settings.h" -#include "core/telemetry_session.h" -#include "ui_configure_web.h" - -ConfigureWeb::ConfigureWeb(QWidget* parent) - : QWidget(parent), ui(std::make_unique()) { - ui->setupUi(this); - connect(ui->button_regenerate_telemetry_id, &QPushButton::clicked, this, - &ConfigureWeb::RefreshTelemetryID); - connect(ui->button_verify_login, &QPushButton::clicked, this, &ConfigureWeb::VerifyLogin); - connect(this, &ConfigureWeb::LoginVerified, this, &ConfigureWeb::OnLoginVerified); - - this->setConfiguration(); -} - -ConfigureWeb::~ConfigureWeb() {} - -void ConfigureWeb::setConfiguration() { - ui->web_credentials_disclaimer->setWordWrap(true); - ui->telemetry_learn_more->setOpenExternalLinks(true); - ui->telemetry_learn_more->setText(tr("Learn more")); - - ui->web_signup_link->setOpenExternalLinks(true); - ui->web_signup_link->setText(tr("Sign up")); - ui->web_token_info_link->setOpenExternalLinks(true); - ui->web_token_info_link->setText( - tr("What is my token?")); - - ui->toggle_telemetry->setChecked(Settings::values.enable_telemetry); - ui->edit_username->setText(QString::fromStdString(Settings::values.citra_username)); - ui->edit_token->setText(QString::fromStdString(Settings::values.citra_token)); - // Connect after setting the values, to avoid calling OnLoginChanged now - connect(ui->edit_token, &QLineEdit::textChanged, this, &ConfigureWeb::OnLoginChanged); - connect(ui->edit_username, &QLineEdit::textChanged, this, &ConfigureWeb::OnLoginChanged); - ui->label_telemetry_id->setText( - tr("Telemetry ID: 0x%1").arg(QString::number(Core::GetTelemetryId(), 16).toUpper())); - user_verified = true; -} - -void ConfigureWeb::applyConfiguration() { - Settings::values.enable_telemetry = ui->toggle_telemetry->isChecked(); - if (user_verified) { - Settings::values.citra_username = ui->edit_username->text().toStdString(); - Settings::values.citra_token = ui->edit_token->text().toStdString(); - } else { - QMessageBox::warning(this, tr("Username and token not verfied"), - tr("Username and token were not verified. The changes to your " - "username and/or token have not been saved.")); - } - Settings::Apply(); -} - -void ConfigureWeb::RefreshTelemetryID() { - const u64 new_telemetry_id{Core::RegenerateTelemetryId()}; - ui->label_telemetry_id->setText( - tr("Telemetry ID: 0x%1").arg(QString::number(new_telemetry_id, 16).toUpper())); -} - -void ConfigureWeb::OnLoginChanged() { - if (ui->edit_username->text().isEmpty() && ui->edit_token->text().isEmpty()) { - user_verified = true; - ui->label_username_verified->setPixmap(QPixmap(":/icons/checked.png")); - ui->label_token_verified->setPixmap(QPixmap(":/icons/checked.png")); - } else { - user_verified = false; - ui->label_username_verified->setPixmap(QPixmap(":/icons/failed.png")); - ui->label_token_verified->setPixmap(QPixmap(":/icons/failed.png")); - } -} - -void ConfigureWeb::VerifyLogin() { - verified = - Core::VerifyLogin(ui->edit_username->text().toStdString(), - ui->edit_token->text().toStdString(), [&]() { emit LoginVerified(); }); - ui->button_verify_login->setDisabled(true); - ui->button_verify_login->setText(tr("Verifying")); -} - -void ConfigureWeb::OnLoginVerified() { - ui->button_verify_login->setEnabled(true); - ui->button_verify_login->setText(tr("Verify")); - if (verified.get()) { - user_verified = true; - ui->label_username_verified->setPixmap(QPixmap(":/icons/checked.png")); - ui->label_token_verified->setPixmap(QPixmap(":/icons/checked.png")); - } else { - ui->label_username_verified->setPixmap(QPixmap(":/icons/failed.png")); - ui->label_token_verified->setPixmap(QPixmap(":/icons/failed.png")); - QMessageBox::critical( - this, tr("Verification failed"), - tr("Verification failed. Check that you have entered your username and token " - "correctly, and that your internet connection is working.")); - } -} diff --git a/src/citra_qt/configuration/configure_web.h b/src/citra_qt/configuration/configure_web.h deleted file mode 100644 index ad2d58f6e..000000000 --- a/src/citra_qt/configuration/configure_web.h +++ /dev/null @@ -1,40 +0,0 @@ -// Copyright 2017 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include -#include - -namespace Ui { -class ConfigureWeb; -} - -class ConfigureWeb : public QWidget { - Q_OBJECT - -public: - explicit ConfigureWeb(QWidget* parent = nullptr); - ~ConfigureWeb(); - - void applyConfiguration(); - -public slots: - void RefreshTelemetryID(); - void OnLoginChanged(); - void VerifyLogin(); - void OnLoginVerified(); - -signals: - void LoginVerified(); - -private: - void setConfiguration(); - - bool user_verified = true; - std::future verified; - - std::unique_ptr ui; -}; diff --git a/src/citra_qt/configuration/configure_web.ui b/src/citra_qt/configuration/configure_web.ui deleted file mode 100644 index dd996ab62..000000000 --- a/src/citra_qt/configuration/configure_web.ui +++ /dev/null @@ -1,190 +0,0 @@ - - - ConfigureWeb - - - - 0 - 0 - 926 - 561 - - - - Form - - - - - - - - Citra Web Service - - - - - - By providing your username and token, you agree to allow Citra to collect additional usage data, which may include user identifying information. - - - - - - - - - - 0 - 0 - - - - Qt::RightToLeft - - - Verify - - - - - - - Sign up - - - - - - - 36 - - - - - - - Token: - - - - - - - - - - - Username: - - - - - - - - - - - 36 - - - QLineEdit::Password - - - - - - - What is my token? - - - - - - - Qt::Horizontal - - - - 40 - 20 - - - - - - - - - - - - - Telemetry - - - - - - Share anonymous usage data with the Citra team - - - - - - - Learn more - - - - - - - - - Telemetry ID: - - - - - - - - 0 - 0 - - - - Qt::RightToLeft - - - Regenerate - - - - - - - - - - - - - - Qt::Vertical - - - - 20 - 40 - - - - - - - - - diff --git a/src/citra_qt/debugger/graphics/graphics.cpp b/src/citra_qt/debugger/graphics/graphics.cpp deleted file mode 100644 index 8154363a2..000000000 --- a/src/citra_qt/debugger/graphics/graphics.cpp +++ /dev/null @@ -1,77 +0,0 @@ -// Copyright 2014 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#include -#include "citra_qt/debugger/graphics/graphics.h" -#include "citra_qt/util/util.h" - -GraphicsDebugger g_debugger; - -GPUCommandStreamItemModel::GPUCommandStreamItemModel(QObject* parent) - : QAbstractListModel(parent), command_count(0) { - connect(this, SIGNAL(GXCommandFinished(int)), this, SLOT(OnGXCommandFinishedInternal(int))); -} - -int GPUCommandStreamItemModel::rowCount(const QModelIndex& parent) const { - return command_count; -} - -QVariant GPUCommandStreamItemModel::data(const QModelIndex& index, int role) const { - if (!index.isValid()) - return QVariant(); - - int command_index = index.row(); - const Service::GSP::Command& command = GetDebugger()->ReadGXCommandHistory(command_index); - if (role == Qt::DisplayRole) { - std::map command_names = { - {Service::GSP::CommandId::REQUEST_DMA, "REQUEST_DMA"}, - {Service::GSP::CommandId::SUBMIT_GPU_CMDLIST, "SUBMIT_GPU_CMDLIST"}, - {Service::GSP::CommandId::SET_MEMORY_FILL, "SET_MEMORY_FILL"}, - {Service::GSP::CommandId::SET_DISPLAY_TRANSFER, "SET_DISPLAY_TRANSFER"}, - {Service::GSP::CommandId::SET_TEXTURE_COPY, "SET_TEXTURE_COPY"}, - {Service::GSP::CommandId::CACHE_FLUSH, "CACHE_FLUSH"}, - }; - const u32* command_data = reinterpret_cast(&command); - QString str = QString("%1 %2 %3 %4 %5 %6 %7 %8 %9") - .arg(command_names[command.id]) - .arg(command_data[0], 8, 16, QLatin1Char('0')) - .arg(command_data[1], 8, 16, QLatin1Char('0')) - .arg(command_data[2], 8, 16, QLatin1Char('0')) - .arg(command_data[3], 8, 16, QLatin1Char('0')) - .arg(command_data[4], 8, 16, QLatin1Char('0')) - .arg(command_data[5], 8, 16, QLatin1Char('0')) - .arg(command_data[6], 8, 16, QLatin1Char('0')) - .arg(command_data[7], 8, 16, QLatin1Char('0')); - return QVariant(str); - } else { - return QVariant(); - } -} - -void GPUCommandStreamItemModel::GXCommandProcessed(int total_command_count) { - emit GXCommandFinished(total_command_count); -} - -void GPUCommandStreamItemModel::OnGXCommandFinishedInternal(int total_command_count) { - if (total_command_count == 0) - return; - - int prev_command_count = command_count; - command_count = total_command_count; - emit dataChanged(index(prev_command_count, 0), index(total_command_count - 1, 0)); -} - -GPUCommandStreamWidget::GPUCommandStreamWidget(QWidget* parent) - : QDockWidget(tr("Graphics Debugger"), parent) { - setObjectName("GraphicsDebugger"); - - GPUCommandStreamItemModel* command_model = new GPUCommandStreamItemModel(this); - g_debugger.RegisterObserver(command_model); - - QListView* command_list = new QListView; - command_list->setModel(command_model); - command_list->setFont(GetMonospaceFont()); - - setWidget(command_list); -} diff --git a/src/citra_qt/debugger/graphics/graphics.h b/src/citra_qt/debugger/graphics/graphics.h deleted file mode 100644 index 8837fb792..000000000 --- a/src/citra_qt/debugger/graphics/graphics.h +++ /dev/null @@ -1,41 +0,0 @@ -// Copyright 2014 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include -#include "video_core/gpu_debugger.h" - -class GPUCommandStreamItemModel : public QAbstractListModel, - public GraphicsDebugger::DebuggerObserver { - Q_OBJECT - -public: - explicit GPUCommandStreamItemModel(QObject* parent); - - int rowCount(const QModelIndex& parent = QModelIndex()) const override; - QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const override; - -public: - void GXCommandProcessed(int total_command_count) override; - -public slots: - void OnGXCommandFinishedInternal(int total_command_count); - -signals: - void GXCommandFinished(int total_command_count); - -private: - int command_count; -}; - -class GPUCommandStreamWidget : public QDockWidget { - Q_OBJECT - -public: - GPUCommandStreamWidget(QWidget* parent = nullptr); - -private: -}; diff --git a/src/citra_qt/debugger/graphics/graphics_breakpoint_observer.cpp b/src/citra_qt/debugger/graphics/graphics_breakpoint_observer.cpp deleted file mode 100644 index dc6070dea..000000000 --- a/src/citra_qt/debugger/graphics/graphics_breakpoint_observer.cpp +++ /dev/null @@ -1,27 +0,0 @@ -// Copyright 2014 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#include -#include "citra_qt/debugger/graphics/graphics_breakpoint_observer.h" - -BreakPointObserverDock::BreakPointObserverDock(std::shared_ptr debug_context, - const QString& title, QWidget* parent) - : QDockWidget(title, parent), BreakPointObserver(debug_context) { - qRegisterMetaType("Pica::DebugContext::Event"); - - connect(this, SIGNAL(Resumed()), this, SLOT(OnResumed())); - - // NOTE: This signal is emitted from a non-GUI thread, but connect() takes - // care of delaying its handling to the GUI thread. - connect(this, SIGNAL(BreakPointHit(Pica::DebugContext::Event, void*)), this, - SLOT(OnBreakPointHit(Pica::DebugContext::Event, void*)), Qt::BlockingQueuedConnection); -} - -void BreakPointObserverDock::OnPicaBreakPointHit(Pica::DebugContext::Event event, void* data) { - emit BreakPointHit(event, data); -} - -void BreakPointObserverDock::OnPicaResume() { - emit Resumed(); -} diff --git a/src/citra_qt/debugger/graphics/graphics_breakpoint_observer.h b/src/citra_qt/debugger/graphics/graphics_breakpoint_observer.h deleted file mode 100644 index e77df4f5b..000000000 --- a/src/citra_qt/debugger/graphics/graphics_breakpoint_observer.h +++ /dev/null @@ -1,33 +0,0 @@ -// Copyright 2014 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include "video_core/debug_utils/debug_utils.h" - -/** - * Utility class which forwards calls to OnPicaBreakPointHit and OnPicaResume to public slots. - * This is because the Pica breakpoint callbacks are called from a non-GUI thread, while - * the widget usually wants to perform reactions in the GUI thread. - */ -class BreakPointObserverDock : public QDockWidget, - protected Pica::DebugContext::BreakPointObserver { - Q_OBJECT - -public: - BreakPointObserverDock(std::shared_ptr debug_context, const QString& title, - QWidget* parent = nullptr); - - void OnPicaBreakPointHit(Pica::DebugContext::Event event, void* data) override; - void OnPicaResume() override; - -private slots: - virtual void OnBreakPointHit(Pica::DebugContext::Event event, void* data) = 0; - virtual void OnResumed() = 0; - -signals: - void Resumed(); - void BreakPointHit(Pica::DebugContext::Event event, void* data); -}; diff --git a/src/citra_qt/debugger/graphics/graphics_breakpoints.cpp b/src/citra_qt/debugger/graphics/graphics_breakpoints.cpp deleted file mode 100644 index 030828ba8..000000000 --- a/src/citra_qt/debugger/graphics/graphics_breakpoints.cpp +++ /dev/null @@ -1,213 +0,0 @@ -// Copyright 2014 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#include -#include -#include -#include -#include -#include "citra_qt/debugger/graphics/graphics_breakpoints.h" -#include "citra_qt/debugger/graphics/graphics_breakpoints_p.h" -#include "common/assert.h" - -BreakPointModel::BreakPointModel(std::shared_ptr debug_context, QObject* parent) - : QAbstractListModel(parent), context_weak(debug_context), - at_breakpoint(debug_context->at_breakpoint), - active_breakpoint(debug_context->active_breakpoint) {} - -int BreakPointModel::columnCount(const QModelIndex& parent) const { - return 1; -} - -int BreakPointModel::rowCount(const QModelIndex& parent) const { - return static_cast(Pica::DebugContext::Event::NumEvents); -} - -QVariant BreakPointModel::data(const QModelIndex& index, int role) const { - const auto event = static_cast(index.row()); - - switch (role) { - case Qt::DisplayRole: { - if (index.column() == 0) { - static const std::map map = { - {Pica::DebugContext::Event::PicaCommandLoaded, tr("Pica command loaded")}, - {Pica::DebugContext::Event::PicaCommandProcessed, tr("Pica command processed")}, - {Pica::DebugContext::Event::IncomingPrimitiveBatch, tr("Incoming primitive batch")}, - {Pica::DebugContext::Event::FinishedPrimitiveBatch, tr("Finished primitive batch")}, - {Pica::DebugContext::Event::VertexShaderInvocation, tr("Vertex shader invocation")}, - {Pica::DebugContext::Event::IncomingDisplayTransfer, - tr("Incoming display transfer")}, - {Pica::DebugContext::Event::GSPCommandProcessed, tr("GSP command processed")}, - {Pica::DebugContext::Event::BufferSwapped, tr("Buffers swapped")}, - }; - - DEBUG_ASSERT(map.size() == static_cast(Pica::DebugContext::Event::NumEvents)); - return (map.find(event) != map.end()) ? map.at(event) : QString(); - } - - break; - } - - case Qt::CheckStateRole: { - if (index.column() == 0) - return data(index, Role_IsEnabled).toBool() ? Qt::Checked : Qt::Unchecked; - break; - } - - case Qt::BackgroundRole: { - if (at_breakpoint && index.row() == static_cast(active_breakpoint)) { - return QBrush(QColor(0xE0, 0xE0, 0x10)); - } - break; - } - - case Role_IsEnabled: { - auto context = context_weak.lock(); - return context && context->breakpoints[(int)event].enabled; - } - - default: - break; - } - return QVariant(); -} - -Qt::ItemFlags BreakPointModel::flags(const QModelIndex& index) const { - if (!index.isValid()) - return 0; - - Qt::ItemFlags flags = Qt::ItemIsEnabled; - if (index.column() == 0) - flags |= Qt::ItemIsUserCheckable; - return flags; -} - -bool BreakPointModel::setData(const QModelIndex& index, const QVariant& value, int role) { - const auto event = static_cast(index.row()); - - switch (role) { - case Qt::CheckStateRole: { - if (index.column() != 0) - return false; - - auto context = context_weak.lock(); - if (!context) - return false; - - context->breakpoints[(int)event].enabled = value == Qt::Checked; - QModelIndex changed_index = createIndex(index.row(), 0); - emit dataChanged(changed_index, changed_index); - return true; - } - } - - return false; -} - -void BreakPointModel::OnBreakPointHit(Pica::DebugContext::Event event) { - auto context = context_weak.lock(); - if (!context) - return; - - active_breakpoint = context->active_breakpoint; - at_breakpoint = context->at_breakpoint; - emit dataChanged(createIndex(static_cast(event), 0), - createIndex(static_cast(event), 0)); -} - -void BreakPointModel::OnResumed() { - auto context = context_weak.lock(); - if (!context) - return; - - at_breakpoint = context->at_breakpoint; - emit dataChanged(createIndex(static_cast(active_breakpoint), 0), - createIndex(static_cast(active_breakpoint), 0)); - active_breakpoint = context->active_breakpoint; -} - -GraphicsBreakPointsWidget::GraphicsBreakPointsWidget( - std::shared_ptr debug_context, QWidget* parent) - : QDockWidget(tr("Pica Breakpoints"), parent), - Pica::DebugContext::BreakPointObserver(debug_context) { - setObjectName("PicaBreakPointsWidget"); - - status_text = new QLabel(tr("Emulation running")); - resume_button = new QPushButton(tr("Resume")); - resume_button->setEnabled(false); - - breakpoint_model = new BreakPointModel(debug_context, this); - breakpoint_list = new QTreeView; - breakpoint_list->setRootIsDecorated(false); - breakpoint_list->setHeaderHidden(true); - breakpoint_list->setModel(breakpoint_model); - - qRegisterMetaType("Pica::DebugContext::Event"); - - connect(breakpoint_list, SIGNAL(doubleClicked(const QModelIndex&)), this, - SLOT(OnItemDoubleClicked(const QModelIndex&))); - - connect(resume_button, SIGNAL(clicked()), this, SLOT(OnResumeRequested())); - - connect(this, SIGNAL(BreakPointHit(Pica::DebugContext::Event, void*)), this, - SLOT(OnBreakPointHit(Pica::DebugContext::Event, void*)), Qt::BlockingQueuedConnection); - connect(this, SIGNAL(Resumed()), this, SLOT(OnResumed())); - - connect(this, SIGNAL(BreakPointHit(Pica::DebugContext::Event, void*)), breakpoint_model, - SLOT(OnBreakPointHit(Pica::DebugContext::Event)), Qt::BlockingQueuedConnection); - connect(this, SIGNAL(Resumed()), breakpoint_model, SLOT(OnResumed())); - - connect(this, SIGNAL(BreakPointsChanged(const QModelIndex&, const QModelIndex&)), - breakpoint_model, SIGNAL(dataChanged(const QModelIndex&, const QModelIndex&))); - - QWidget* main_widget = new QWidget; - auto main_layout = new QVBoxLayout; - { - auto sub_layout = new QHBoxLayout; - sub_layout->addWidget(status_text); - sub_layout->addWidget(resume_button); - main_layout->addLayout(sub_layout); - } - main_layout->addWidget(breakpoint_list); - main_widget->setLayout(main_layout); - - setWidget(main_widget); -} - -void GraphicsBreakPointsWidget::OnPicaBreakPointHit(Event event, void* data) { - // Process in GUI thread - emit BreakPointHit(event, data); -} - -void GraphicsBreakPointsWidget::OnBreakPointHit(Pica::DebugContext::Event event, void* data) { - status_text->setText(tr("Emulation halted at breakpoint")); - resume_button->setEnabled(true); -} - -void GraphicsBreakPointsWidget::OnPicaResume() { - // Process in GUI thread - emit Resumed(); -} - -void GraphicsBreakPointsWidget::OnResumed() { - status_text->setText(tr("Emulation running")); - resume_button->setEnabled(false); -} - -void GraphicsBreakPointsWidget::OnResumeRequested() { - if (auto context = context_weak.lock()) - context->Resume(); -} - -void GraphicsBreakPointsWidget::OnItemDoubleClicked(const QModelIndex& index) { - if (!index.isValid()) - return; - - QModelIndex check_index = breakpoint_list->model()->index(index.row(), 0); - QVariant enabled = breakpoint_list->model()->data(check_index, Qt::CheckStateRole); - QVariant new_state = Qt::Unchecked; - if (enabled == Qt::Unchecked) - new_state = Qt::Checked; - breakpoint_list->model()->setData(check_index, new_state, Qt::CheckStateRole); -} diff --git a/src/citra_qt/debugger/graphics/graphics_breakpoints.h b/src/citra_qt/debugger/graphics/graphics_breakpoints.h deleted file mode 100644 index bec72a2db..000000000 --- a/src/citra_qt/debugger/graphics/graphics_breakpoints.h +++ /dev/null @@ -1,46 +0,0 @@ -// Copyright 2014 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include -#include "video_core/debug_utils/debug_utils.h" - -class QLabel; -class QPushButton; -class QTreeView; - -class BreakPointModel; - -class GraphicsBreakPointsWidget : public QDockWidget, Pica::DebugContext::BreakPointObserver { - Q_OBJECT - - using Event = Pica::DebugContext::Event; - -public: - explicit GraphicsBreakPointsWidget(std::shared_ptr debug_context, - QWidget* parent = nullptr); - - void OnPicaBreakPointHit(Pica::DebugContext::Event event, void* data) override; - void OnPicaResume() override; - -public slots: - void OnBreakPointHit(Pica::DebugContext::Event event, void* data); - void OnItemDoubleClicked(const QModelIndex&); - void OnResumeRequested(); - void OnResumed(); - -signals: - void Resumed(); - void BreakPointHit(Pica::DebugContext::Event event, void* data); - void BreakPointsChanged(const QModelIndex& topLeft, const QModelIndex& bottomRight); - -private: - QLabel* status_text; - QPushButton* resume_button; - - BreakPointModel* breakpoint_model; - QTreeView* breakpoint_list; -}; diff --git a/src/citra_qt/debugger/graphics/graphics_breakpoints_p.h b/src/citra_qt/debugger/graphics/graphics_breakpoints_p.h deleted file mode 100644 index dc64706bd..000000000 --- a/src/citra_qt/debugger/graphics/graphics_breakpoints_p.h +++ /dev/null @@ -1,36 +0,0 @@ -// Copyright 2014 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include -#include "video_core/debug_utils/debug_utils.h" - -class BreakPointModel : public QAbstractListModel { - Q_OBJECT - -public: - enum { - Role_IsEnabled = Qt::UserRole, - }; - - BreakPointModel(std::shared_ptr context, QObject* parent); - - int columnCount(const QModelIndex& parent = QModelIndex()) const override; - int rowCount(const QModelIndex& parent = QModelIndex()) const override; - QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const override; - Qt::ItemFlags flags(const QModelIndex& index) const override; - - bool setData(const QModelIndex& index, const QVariant& value, int role = Qt::EditRole) override; - -public slots: - void OnBreakPointHit(Pica::DebugContext::Event event); - void OnResumed(); - -private: - std::weak_ptr context_weak; - bool at_breakpoint; - Pica::DebugContext::Event active_breakpoint; -}; diff --git a/src/citra_qt/debugger/graphics/graphics_cmdlists.cpp b/src/citra_qt/debugger/graphics/graphics_cmdlists.cpp deleted file mode 100644 index ce2b9fa50..000000000 --- a/src/citra_qt/debugger/graphics/graphics_cmdlists.cpp +++ /dev/null @@ -1,259 +0,0 @@ -// Copyright 2014 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include "citra_qt/debugger/graphics/graphics_cmdlists.h" -#include "citra_qt/util/spinbox.h" -#include "citra_qt/util/util.h" -#include "common/vector_math.h" -#include "core/memory.h" -#include "video_core/debug_utils/debug_utils.h" -#include "video_core/pica_state.h" -#include "video_core/regs.h" -#include "video_core/texture/texture_decode.h" - -namespace { -QImage LoadTexture(const u8* src, const Pica::Texture::TextureInfo& info) { - QImage decoded_image(info.width, info.height, QImage::Format_ARGB32); - for (u32 y = 0; y < info.height; ++y) { - for (u32 x = 0; x < info.width; ++x) { - Math::Vec4 color = Pica::Texture::LookupTexture(src, x, y, info, true); - decoded_image.setPixel(x, y, qRgba(color.r(), color.g(), color.b(), color.a())); - } - } - - return decoded_image; -} - -class TextureInfoWidget : public QWidget { -public: - TextureInfoWidget(const u8* src, const Pica::Texture::TextureInfo& info, - QWidget* parent = nullptr) - : QWidget(parent) { - - QLabel* image_widget = new QLabel; - QPixmap image_pixmap = QPixmap::fromImage(LoadTexture(src, info)); - image_pixmap = image_pixmap.scaled(200, 100, Qt::KeepAspectRatio, Qt::SmoothTransformation); - image_widget->setPixmap(image_pixmap); - - QVBoxLayout* layout = new QVBoxLayout; - layout->addWidget(image_widget); - setLayout(layout); - } -}; -} // Anonymous namespace - -GPUCommandListModel::GPUCommandListModel(QObject* parent) : QAbstractListModel(parent) {} - -int GPUCommandListModel::rowCount(const QModelIndex& parent) const { - return static_cast(pica_trace.writes.size()); -} - -int GPUCommandListModel::columnCount(const QModelIndex& parent) const { - return 4; -} - -QVariant GPUCommandListModel::data(const QModelIndex& index, int role) const { - if (!index.isValid()) - return QVariant(); - - const auto& write = pica_trace.writes[index.row()]; - - if (role == Qt::DisplayRole) { - switch (index.column()) { - case 0: - return QString::fromLatin1(Pica::Regs::GetRegisterName(write.cmd_id)); - case 1: - return QString("%1").arg(write.cmd_id, 3, 16, QLatin1Char('0')); - case 2: - return QString("%1").arg(write.mask, 4, 2, QLatin1Char('0')); - case 3: - return QString("%1").arg(write.value, 8, 16, QLatin1Char('0')); - } - } else if (role == CommandIdRole) { - return QVariant::fromValue(write.cmd_id); - } - - return QVariant(); -} - -QVariant GPUCommandListModel::headerData(int section, Qt::Orientation orientation, int role) const { - switch (role) { - case Qt::DisplayRole: { - switch (section) { - case 0: - return tr("Command Name"); - case 1: - return tr("Register"); - case 2: - return tr("Mask"); - case 3: - return tr("New Value"); - } - - break; - } - } - - return QVariant(); -} - -void GPUCommandListModel::OnPicaTraceFinished(const Pica::DebugUtils::PicaTrace& trace) { - beginResetModel(); - - pica_trace = trace; - - endResetModel(); -} - -#define COMMAND_IN_RANGE(cmd_id, reg_name) \ - (cmd_id >= PICA_REG_INDEX(reg_name) && \ - cmd_id < PICA_REG_INDEX(reg_name) + sizeof(decltype(Pica::g_state.regs.reg_name)) / 4) - -void GPUCommandListWidget::OnCommandDoubleClicked(const QModelIndex& index) { - const unsigned int command_id = - list_widget->model()->data(index, GPUCommandListModel::CommandIdRole).toUInt(); - if (COMMAND_IN_RANGE(command_id, texturing.texture0) || - COMMAND_IN_RANGE(command_id, texturing.texture1) || - COMMAND_IN_RANGE(command_id, texturing.texture2)) { - - unsigned texture_index; - if (COMMAND_IN_RANGE(command_id, texturing.texture0)) { - texture_index = 0; - } else if (COMMAND_IN_RANGE(command_id, texturing.texture1)) { - texture_index = 1; - } else if (COMMAND_IN_RANGE(command_id, texturing.texture2)) { - texture_index = 2; - } else { - UNREACHABLE_MSG("Unknown texture command"); - } - - // TODO: Open a surface debugger - } -} - -void GPUCommandListWidget::SetCommandInfo(const QModelIndex& index) { - QWidget* new_info_widget = nullptr; - - const unsigned int command_id = - list_widget->model()->data(index, GPUCommandListModel::CommandIdRole).toUInt(); - if (COMMAND_IN_RANGE(command_id, texturing.texture0) || - COMMAND_IN_RANGE(command_id, texturing.texture1) || - COMMAND_IN_RANGE(command_id, texturing.texture2)) { - - unsigned texture_index; - if (COMMAND_IN_RANGE(command_id, texturing.texture0)) { - texture_index = 0; - } else if (COMMAND_IN_RANGE(command_id, texturing.texture1)) { - texture_index = 1; - } else { - texture_index = 2; - } - - const auto texture = Pica::g_state.regs.texturing.GetTextures()[texture_index]; - const auto config = texture.config; - const auto format = texture.format; - - const auto info = Pica::Texture::TextureInfo::FromPicaRegister(config, format); - const u8* src = Memory::GetPhysicalPointer(config.GetPhysicalAddress()); - new_info_widget = new TextureInfoWidget(src, info); - } - if (command_info_widget) { - delete command_info_widget; - command_info_widget = nullptr; - } - if (new_info_widget) { - widget()->layout()->addWidget(new_info_widget); - command_info_widget = new_info_widget; - } -} -#undef COMMAND_IN_RANGE - -GPUCommandListWidget::GPUCommandListWidget(QWidget* parent) - : QDockWidget(tr("Pica Command List"), parent) { - setObjectName("Pica Command List"); - GPUCommandListModel* model = new GPUCommandListModel(this); - - QWidget* main_widget = new QWidget; - - list_widget = new QTreeView; - list_widget->setModel(model); - list_widget->setFont(GetMonospaceFont()); - list_widget->setRootIsDecorated(false); - list_widget->setUniformRowHeights(true); - -#if QT_VERSION >= QT_VERSION_CHECK(5, 0, 0) - list_widget->header()->setSectionResizeMode(QHeaderView::ResizeToContents); -#else - list_widget->header()->setResizeMode(QHeaderView::ResizeToContents); -#endif - - connect(list_widget->selectionModel(), - SIGNAL(currentChanged(const QModelIndex&, const QModelIndex&)), this, - SLOT(SetCommandInfo(const QModelIndex&))); - connect(list_widget, SIGNAL(doubleClicked(const QModelIndex&)), this, - SLOT(OnCommandDoubleClicked(const QModelIndex&))); - - toggle_tracing = new QPushButton(tr("Start Tracing")); - QPushButton* copy_all = new QPushButton(tr("Copy All")); - - connect(toggle_tracing, SIGNAL(clicked()), this, SLOT(OnToggleTracing())); - connect(this, SIGNAL(TracingFinished(const Pica::DebugUtils::PicaTrace&)), model, - SLOT(OnPicaTraceFinished(const Pica::DebugUtils::PicaTrace&))); - - connect(copy_all, SIGNAL(clicked()), this, SLOT(CopyAllToClipboard())); - - command_info_widget = nullptr; - - QVBoxLayout* main_layout = new QVBoxLayout; - main_layout->addWidget(list_widget); - { - QHBoxLayout* sub_layout = new QHBoxLayout; - sub_layout->addWidget(toggle_tracing); - sub_layout->addWidget(copy_all); - main_layout->addLayout(sub_layout); - } - main_widget->setLayout(main_layout); - - setWidget(main_widget); -} - -void GPUCommandListWidget::OnToggleTracing() { - if (!Pica::DebugUtils::IsPicaTracing()) { - Pica::DebugUtils::StartPicaTracing(); - toggle_tracing->setText(tr("Finish Tracing")); - } else { - pica_trace = Pica::DebugUtils::FinishPicaTracing(); - emit TracingFinished(*pica_trace); - toggle_tracing->setText(tr("Start Tracing")); - } -} - -void GPUCommandListWidget::CopyAllToClipboard() { - QClipboard* clipboard = QApplication::clipboard(); - QString text; - - QAbstractItemModel* model = static_cast(list_widget->model()); - - for (int row = 0; row < model->rowCount({}); ++row) { - for (int col = 0; col < model->columnCount({}); ++col) { - QModelIndex index = model->index(row, col); - text += model->data(index).value(); - text += '\t'; - } - text += '\n'; - } - - clipboard->setText(text); -} diff --git a/src/citra_qt/debugger/graphics/graphics_cmdlists.h b/src/citra_qt/debugger/graphics/graphics_cmdlists.h deleted file mode 100644 index 8f40b94c5..000000000 --- a/src/citra_qt/debugger/graphics/graphics_cmdlists.h +++ /dev/null @@ -1,61 +0,0 @@ -// Copyright 2014 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include -#include "video_core/debug_utils/debug_utils.h" -#include "video_core/gpu_debugger.h" - -class QPushButton; -class QTreeView; - -class GPUCommandListModel : public QAbstractListModel { - Q_OBJECT - -public: - enum { - CommandIdRole = Qt::UserRole, - }; - - explicit GPUCommandListModel(QObject* parent); - - int columnCount(const QModelIndex& parent = QModelIndex()) const override; - int rowCount(const QModelIndex& parent = QModelIndex()) const override; - QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const override; - QVariant headerData(int section, Qt::Orientation orientation, - int role = Qt::DisplayRole) const override; - -public slots: - void OnPicaTraceFinished(const Pica::DebugUtils::PicaTrace& trace); - -private: - Pica::DebugUtils::PicaTrace pica_trace; -}; - -class GPUCommandListWidget : public QDockWidget { - Q_OBJECT - -public: - explicit GPUCommandListWidget(QWidget* parent = nullptr); - -public slots: - void OnToggleTracing(); - void OnCommandDoubleClicked(const QModelIndex&); - - void SetCommandInfo(const QModelIndex&); - - void CopyAllToClipboard(); - -signals: - void TracingFinished(const Pica::DebugUtils::PicaTrace&); - -private: - std::unique_ptr pica_trace; - - QTreeView* list_widget; - QWidget* command_info_widget; - QPushButton* toggle_tracing; -}; diff --git a/src/citra_qt/debugger/graphics/graphics_surface.cpp b/src/citra_qt/debugger/graphics/graphics_surface.cpp deleted file mode 100644 index c974545ef..000000000 --- a/src/citra_qt/debugger/graphics/graphics_surface.cpp +++ /dev/null @@ -1,713 +0,0 @@ -// Copyright 2014 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include "citra_qt/debugger/graphics/graphics_surface.h" -#include "citra_qt/util/spinbox.h" -#include "common/color.h" -#include "core/hw/gpu.h" -#include "core/memory.h" -#include "video_core/pica_state.h" -#include "video_core/regs_framebuffer.h" -#include "video_core/regs_texturing.h" -#include "video_core/texture/texture_decode.h" -#include "video_core/utils.h" - -SurfacePicture::SurfacePicture(QWidget* parent, GraphicsSurfaceWidget* surface_widget_) - : QLabel(parent), surface_widget(surface_widget_) {} -SurfacePicture::~SurfacePicture() {} - -void SurfacePicture::mousePressEvent(QMouseEvent* event) { - // Only do something while the left mouse button is held down - if (!(event->buttons() & Qt::LeftButton)) - return; - - if (pixmap() == nullptr) - return; - - if (surface_widget) - surface_widget->Pick(event->x() * pixmap()->width() / width(), - event->y() * pixmap()->height() / height()); -} - -void SurfacePicture::mouseMoveEvent(QMouseEvent* event) { - // We also want to handle the event if the user moves the mouse while holding down the LMB - mousePressEvent(event); -} - -GraphicsSurfaceWidget::GraphicsSurfaceWidget(std::shared_ptr debug_context, - QWidget* parent) - : BreakPointObserverDock(debug_context, tr("Pica Surface Viewer"), parent), - surface_source(Source::ColorBuffer) { - setObjectName("PicaSurface"); - - surface_source_list = new QComboBox; - surface_source_list->addItem(tr("Color Buffer")); - surface_source_list->addItem(tr("Depth Buffer")); - surface_source_list->addItem(tr("Stencil Buffer")); - surface_source_list->addItem(tr("Texture 0")); - surface_source_list->addItem(tr("Texture 1")); - surface_source_list->addItem(tr("Texture 2")); - surface_source_list->addItem(tr("Custom")); - surface_source_list->setCurrentIndex(static_cast(surface_source)); - - surface_address_control = new CSpinBox; - surface_address_control->SetBase(16); - surface_address_control->SetRange(0, 0xFFFFFFFF); - surface_address_control->SetPrefix("0x"); - - unsigned max_dimension = 16384; // TODO: Find actual maximum - - surface_width_control = new QSpinBox; - surface_width_control->setRange(0, max_dimension); - - surface_height_control = new QSpinBox; - surface_height_control->setRange(0, max_dimension); - - surface_picker_x_control = new QSpinBox; - surface_picker_x_control->setRange(0, max_dimension - 1); - - surface_picker_y_control = new QSpinBox; - surface_picker_y_control->setRange(0, max_dimension - 1); - - surface_format_control = new QComboBox; - - // Color formats sorted by Pica texture format index - surface_format_control->addItem(tr("RGBA8")); - surface_format_control->addItem(tr("RGB8")); - surface_format_control->addItem(tr("RGB5A1")); - surface_format_control->addItem(tr("RGB565")); - surface_format_control->addItem(tr("RGBA4")); - surface_format_control->addItem(tr("IA8")); - surface_format_control->addItem(tr("RG8")); - surface_format_control->addItem(tr("I8")); - surface_format_control->addItem(tr("A8")); - surface_format_control->addItem(tr("IA4")); - surface_format_control->addItem(tr("I4")); - surface_format_control->addItem(tr("A4")); - surface_format_control->addItem(tr("ETC1")); - surface_format_control->addItem(tr("ETC1A4")); - surface_format_control->addItem(tr("D16")); - surface_format_control->addItem(tr("D24")); - surface_format_control->addItem(tr("D24X8")); - surface_format_control->addItem(tr("X24S8")); - surface_format_control->addItem(tr("Unknown")); - - surface_info_label = new QLabel(); - surface_info_label->setWordWrap(true); - - surface_picture_label = new SurfacePicture(0, this); - surface_picture_label->setSizePolicy(QSizePolicy::Fixed, QSizePolicy::Fixed); - surface_picture_label->setAlignment(Qt::AlignLeft | Qt::AlignTop); - surface_picture_label->setScaledContents(false); - - auto scroll_area = new QScrollArea(); - scroll_area->setBackgroundRole(QPalette::Dark); - scroll_area->setWidgetResizable(false); - scroll_area->setWidget(surface_picture_label); - - save_surface = new QPushButton(QIcon::fromTheme("document-save"), tr("Save")); - - // Connections - connect(this, SIGNAL(Update()), this, SLOT(OnUpdate())); - connect(surface_source_list, SIGNAL(currentIndexChanged(int)), this, - SLOT(OnSurfaceSourceChanged(int))); - connect(surface_address_control, SIGNAL(ValueChanged(qint64)), this, - SLOT(OnSurfaceAddressChanged(qint64))); - connect(surface_width_control, SIGNAL(valueChanged(int)), this, - SLOT(OnSurfaceWidthChanged(int))); - connect(surface_height_control, SIGNAL(valueChanged(int)), this, - SLOT(OnSurfaceHeightChanged(int))); - connect(surface_format_control, SIGNAL(currentIndexChanged(int)), this, - SLOT(OnSurfaceFormatChanged(int))); - connect(surface_picker_x_control, SIGNAL(valueChanged(int)), this, - SLOT(OnSurfacePickerXChanged(int))); - connect(surface_picker_y_control, SIGNAL(valueChanged(int)), this, - SLOT(OnSurfacePickerYChanged(int))); - connect(save_surface, SIGNAL(clicked()), this, SLOT(SaveSurface())); - - auto main_widget = new QWidget; - auto main_layout = new QVBoxLayout; - { - auto sub_layout = new QHBoxLayout; - sub_layout->addWidget(new QLabel(tr("Source:"))); - sub_layout->addWidget(surface_source_list); - main_layout->addLayout(sub_layout); - } - { - auto sub_layout = new QHBoxLayout; - sub_layout->addWidget(new QLabel(tr("Physical Address:"))); - sub_layout->addWidget(surface_address_control); - main_layout->addLayout(sub_layout); - } - { - auto sub_layout = new QHBoxLayout; - sub_layout->addWidget(new QLabel(tr("Width:"))); - sub_layout->addWidget(surface_width_control); - main_layout->addLayout(sub_layout); - } - { - auto sub_layout = new QHBoxLayout; - sub_layout->addWidget(new QLabel(tr("Height:"))); - sub_layout->addWidget(surface_height_control); - main_layout->addLayout(sub_layout); - } - { - auto sub_layout = new QHBoxLayout; - sub_layout->addWidget(new QLabel(tr("Format:"))); - sub_layout->addWidget(surface_format_control); - main_layout->addLayout(sub_layout); - } - main_layout->addWidget(scroll_area); - - auto info_layout = new QHBoxLayout; - { - auto xy_layout = new QVBoxLayout; - { - { - auto sub_layout = new QHBoxLayout; - sub_layout->addWidget(new QLabel(tr("X:"))); - sub_layout->addWidget(surface_picker_x_control); - xy_layout->addLayout(sub_layout); - } - { - auto sub_layout = new QHBoxLayout; - sub_layout->addWidget(new QLabel(tr("Y:"))); - sub_layout->addWidget(surface_picker_y_control); - xy_layout->addLayout(sub_layout); - } - } - info_layout->addLayout(xy_layout); - surface_info_label->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Minimum); - info_layout->addWidget(surface_info_label); - } - main_layout->addLayout(info_layout); - - main_layout->addWidget(save_surface); - main_widget->setLayout(main_layout); - setWidget(main_widget); - - // Load current data - TODO: Make sure this works when emulation is not running - if (debug_context && debug_context->at_breakpoint) { - emit Update(); - widget()->setEnabled(debug_context->at_breakpoint); - } else { - widget()->setEnabled(false); - } -} - -void GraphicsSurfaceWidget::OnBreakPointHit(Pica::DebugContext::Event event, void* data) { - emit Update(); - widget()->setEnabled(true); -} - -void GraphicsSurfaceWidget::OnResumed() { - widget()->setEnabled(false); -} - -void GraphicsSurfaceWidget::OnSurfaceSourceChanged(int new_value) { - surface_source = static_cast(new_value); - emit Update(); -} - -void GraphicsSurfaceWidget::OnSurfaceAddressChanged(qint64 new_value) { - if (surface_address != new_value) { - surface_address = static_cast(new_value); - - surface_source_list->setCurrentIndex(static_cast(Source::Custom)); - emit Update(); - } -} - -void GraphicsSurfaceWidget::OnSurfaceWidthChanged(int new_value) { - if (surface_width != static_cast(new_value)) { - surface_width = static_cast(new_value); - - surface_source_list->setCurrentIndex(static_cast(Source::Custom)); - emit Update(); - } -} - -void GraphicsSurfaceWidget::OnSurfaceHeightChanged(int new_value) { - if (surface_height != static_cast(new_value)) { - surface_height = static_cast(new_value); - - surface_source_list->setCurrentIndex(static_cast(Source::Custom)); - emit Update(); - } -} - -void GraphicsSurfaceWidget::OnSurfaceFormatChanged(int new_value) { - if (surface_format != static_cast(new_value)) { - surface_format = static_cast(new_value); - - surface_source_list->setCurrentIndex(static_cast(Source::Custom)); - emit Update(); - } -} - -void GraphicsSurfaceWidget::OnSurfacePickerXChanged(int new_value) { - if (surface_picker_x != new_value) { - surface_picker_x = new_value; - Pick(surface_picker_x, surface_picker_y); - } -} - -void GraphicsSurfaceWidget::OnSurfacePickerYChanged(int new_value) { - if (surface_picker_y != new_value) { - surface_picker_y = new_value; - Pick(surface_picker_x, surface_picker_y); - } -} - -void GraphicsSurfaceWidget::Pick(int x, int y) { - surface_picker_x_control->setValue(x); - surface_picker_y_control->setValue(y); - - if (x < 0 || x >= static_cast(surface_width) || y < 0 || - y >= static_cast(surface_height)) { - surface_info_label->setText(tr("Pixel out of bounds")); - surface_info_label->setAlignment(Qt::AlignLeft | Qt::AlignVCenter); - return; - } - - u8* buffer = Memory::GetPhysicalPointer(surface_address); - if (buffer == nullptr) { - surface_info_label->setText(tr("(unable to access pixel data)")); - surface_info_label->setAlignment(Qt::AlignCenter); - return; - } - - unsigned nibbles_per_pixel = GraphicsSurfaceWidget::NibblesPerPixel(surface_format); - unsigned stride = nibbles_per_pixel * surface_width / 2; - - unsigned bytes_per_pixel; - bool nibble_mode = (nibbles_per_pixel == 1); - if (nibble_mode) { - // As nibbles are contained in a byte we still need to access one byte per nibble - bytes_per_pixel = 1; - } else { - bytes_per_pixel = nibbles_per_pixel / 2; - } - - const u32 coarse_y = y & ~7; - u32 offset = VideoCore::GetMortonOffset(x, y, bytes_per_pixel) + coarse_y * stride; - const u8* pixel = buffer + (nibble_mode ? (offset / 2) : offset); - - auto GetText = [offset](Format format, const u8* pixel) { - switch (format) { - case Format::RGBA8: { - auto value = Color::DecodeRGBA8(pixel) / 255.0f; - return QString("Red: %1, Green: %2, Blue: %3, Alpha: %4") - .arg(QString::number(value.r(), 'f', 2)) - .arg(QString::number(value.g(), 'f', 2)) - .arg(QString::number(value.b(), 'f', 2)) - .arg(QString::number(value.a(), 'f', 2)); - } - case Format::RGB8: { - auto value = Color::DecodeRGB8(pixel) / 255.0f; - return QString("Red: %1, Green: %2, Blue: %3") - .arg(QString::number(value.r(), 'f', 2)) - .arg(QString::number(value.g(), 'f', 2)) - .arg(QString::number(value.b(), 'f', 2)); - } - case Format::RGB5A1: { - auto value = Color::DecodeRGB5A1(pixel) / 255.0f; - return QString("Red: %1, Green: %2, Blue: %3, Alpha: %4") - .arg(QString::number(value.r(), 'f', 2)) - .arg(QString::number(value.g(), 'f', 2)) - .arg(QString::number(value.b(), 'f', 2)) - .arg(QString::number(value.a(), 'f', 2)); - } - case Format::RGB565: { - auto value = Color::DecodeRGB565(pixel) / 255.0f; - return QString("Red: %1, Green: %2, Blue: %3") - .arg(QString::number(value.r(), 'f', 2)) - .arg(QString::number(value.g(), 'f', 2)) - .arg(QString::number(value.b(), 'f', 2)); - } - case Format::RGBA4: { - auto value = Color::DecodeRGBA4(pixel) / 255.0f; - return QString("Red: %1, Green: %2, Blue: %3, Alpha: %4") - .arg(QString::number(value.r(), 'f', 2)) - .arg(QString::number(value.g(), 'f', 2)) - .arg(QString::number(value.b(), 'f', 2)) - .arg(QString::number(value.a(), 'f', 2)); - } - case Format::IA8: - return QString("Index: %1, Alpha: %2").arg(pixel[0]).arg(pixel[1]); - case Format::RG8: { - auto value = Color::DecodeRG8(pixel) / 255.0f; - return QString("Red: %1, Green: %2") - .arg(QString::number(value.r(), 'f', 2)) - .arg(QString::number(value.g(), 'f', 2)); - } - case Format::I8: - return QString("Index: %1").arg(*pixel); - case Format::A8: - return QString("Alpha: %1").arg(QString::number(*pixel / 255.0f, 'f', 2)); - case Format::IA4: - return QString("Index: %1, Alpha: %2").arg(*pixel & 0xF).arg((*pixel & 0xF0) >> 4); - case Format::I4: { - u8 i = (*pixel >> ((offset % 2) ? 4 : 0)) & 0xF; - return QString("Index: %1").arg(i); - } - case Format::A4: { - u8 a = (*pixel >> ((offset % 2) ? 4 : 0)) & 0xF; - return QString("Alpha: %1").arg(QString::number(a / 15.0f, 'f', 2)); - } - case Format::ETC1: - case Format::ETC1A4: - // TODO: Display block information or channel values? - return QString("Compressed data"); - case Format::D16: { - auto value = Color::DecodeD16(pixel); - return QString("Depth: %1").arg(QString::number(value / (float)0xFFFF, 'f', 4)); - } - case Format::D24: { - auto value = Color::DecodeD24(pixel); - return QString("Depth: %1").arg(QString::number(value / (float)0xFFFFFF, 'f', 4)); - } - case Format::D24X8: - case Format::X24S8: { - auto values = Color::DecodeD24S8(pixel); - return QString("Depth: %1, Stencil: %2") - .arg(QString::number(values[0] / (float)0xFFFFFF, 'f', 4)) - .arg(values[1]); - } - case Format::Unknown: - return QString("Unknown format"); - default: - return QString("Unhandled format"); - } - return QString(""); - }; - - QString nibbles = ""; - for (unsigned i = 0; i < nibbles_per_pixel; i++) { - unsigned nibble_index = i; - if (nibble_mode) { - nibble_index += (offset % 2) ? 0 : 1; - } - u8 byte = pixel[nibble_index / 2]; - u8 nibble = (byte >> ((nibble_index % 2) ? 0 : 4)) & 0xF; - nibbles.append(QString::number(nibble, 16).toUpper()); - } - - surface_info_label->setText( - QString("Raw: 0x%3\n(%4)").arg(nibbles).arg(GetText(surface_format, pixel))); - surface_info_label->setAlignment(Qt::AlignLeft | Qt::AlignVCenter); -} - -void GraphicsSurfaceWidget::OnUpdate() { - QPixmap pixmap; - - switch (surface_source) { - case Source::ColorBuffer: { - // TODO: Store a reference to the registers in the debug context instead of accessing them - // directly... - - const auto& framebuffer = Pica::g_state.regs.framebuffer.framebuffer; - - surface_address = framebuffer.GetColorBufferPhysicalAddress(); - surface_width = framebuffer.GetWidth(); - surface_height = framebuffer.GetHeight(); - - switch (framebuffer.color_format) { - case Pica::FramebufferRegs::ColorFormat::RGBA8: - surface_format = Format::RGBA8; - break; - - case Pica::FramebufferRegs::ColorFormat::RGB8: - surface_format = Format::RGB8; - break; - - case Pica::FramebufferRegs::ColorFormat::RGB5A1: - surface_format = Format::RGB5A1; - break; - - case Pica::FramebufferRegs::ColorFormat::RGB565: - surface_format = Format::RGB565; - break; - - case Pica::FramebufferRegs::ColorFormat::RGBA4: - surface_format = Format::RGBA4; - break; - - default: - surface_format = Format::Unknown; - break; - } - - break; - } - - case Source::DepthBuffer: { - const auto& framebuffer = Pica::g_state.regs.framebuffer.framebuffer; - - surface_address = framebuffer.GetDepthBufferPhysicalAddress(); - surface_width = framebuffer.GetWidth(); - surface_height = framebuffer.GetHeight(); - - switch (framebuffer.depth_format) { - case Pica::FramebufferRegs::DepthFormat::D16: - surface_format = Format::D16; - break; - - case Pica::FramebufferRegs::DepthFormat::D24: - surface_format = Format::D24; - break; - - case Pica::FramebufferRegs::DepthFormat::D24S8: - surface_format = Format::D24X8; - break; - - default: - surface_format = Format::Unknown; - break; - } - - break; - } - - case Source::StencilBuffer: { - const auto& framebuffer = Pica::g_state.regs.framebuffer.framebuffer; - - surface_address = framebuffer.GetDepthBufferPhysicalAddress(); - surface_width = framebuffer.GetWidth(); - surface_height = framebuffer.GetHeight(); - - switch (framebuffer.depth_format) { - case Pica::FramebufferRegs::DepthFormat::D24S8: - surface_format = Format::X24S8; - break; - - default: - surface_format = Format::Unknown; - break; - } - - break; - } - - case Source::Texture0: - case Source::Texture1: - case Source::Texture2: { - unsigned texture_index; - if (surface_source == Source::Texture0) - texture_index = 0; - else if (surface_source == Source::Texture1) - texture_index = 1; - else if (surface_source == Source::Texture2) - texture_index = 2; - else { - qDebug() << "Unknown texture source " << static_cast(surface_source); - break; - } - - const auto texture = Pica::g_state.regs.texturing.GetTextures()[texture_index]; - auto info = Pica::Texture::TextureInfo::FromPicaRegister(texture.config, texture.format); - - surface_address = info.physical_address; - surface_width = info.width; - surface_height = info.height; - surface_format = static_cast(info.format); - - if (surface_format > Format::MaxTextureFormat) { - qDebug() << "Unknown texture format " << static_cast(info.format); - } - break; - } - - case Source::Custom: { - // Keep user-specified values - break; - } - - default: - qDebug() << "Unknown surface source " << static_cast(surface_source); - break; - } - - surface_address_control->SetValue(surface_address); - surface_width_control->setValue(surface_width); - surface_height_control->setValue(surface_height); - surface_format_control->setCurrentIndex(static_cast(surface_format)); - - // TODO: Implement a good way to visualize alpha components! - - QImage decoded_image(surface_width, surface_height, QImage::Format_ARGB32); - u8* buffer = Memory::GetPhysicalPointer(surface_address); - - if (buffer == nullptr) { - surface_picture_label->hide(); - surface_info_label->setText(tr("(invalid surface address)")); - surface_info_label->setAlignment(Qt::AlignCenter); - surface_picker_x_control->setEnabled(false); - surface_picker_y_control->setEnabled(false); - save_surface->setEnabled(false); - return; - } - - if (surface_format == Format::Unknown) { - surface_picture_label->hide(); - surface_info_label->setText(tr("(unknown surface format)")); - surface_info_label->setAlignment(Qt::AlignCenter); - surface_picker_x_control->setEnabled(false); - surface_picker_y_control->setEnabled(false); - save_surface->setEnabled(false); - return; - } - - surface_picture_label->show(); - - if (surface_format <= Format::MaxTextureFormat) { - // Generate a virtual texture - Pica::Texture::TextureInfo info; - info.physical_address = surface_address; - info.width = surface_width; - info.height = surface_height; - info.format = static_cast(surface_format); - info.SetDefaultStride(); - - for (unsigned int y = 0; y < surface_height; ++y) { - for (unsigned int x = 0; x < surface_width; ++x) { - Math::Vec4 color = Pica::Texture::LookupTexture(buffer, x, y, info, true); - decoded_image.setPixel(x, y, qRgba(color.r(), color.g(), color.b(), color.a())); - } - } - } else { - // We handle depth formats here because DebugUtils only supports TextureFormats - - // TODO(yuriks): Convert to newer tile-based addressing - unsigned nibbles_per_pixel = GraphicsSurfaceWidget::NibblesPerPixel(surface_format); - unsigned stride = nibbles_per_pixel * surface_width / 2; - - ASSERT_MSG(nibbles_per_pixel >= 2, - "Depth decoder only supports formats with at least one byte per pixel"); - unsigned bytes_per_pixel = nibbles_per_pixel / 2; - - for (unsigned int y = 0; y < surface_height; ++y) { - for (unsigned int x = 0; x < surface_width; ++x) { - const u32 coarse_y = y & ~7; - u32 offset = VideoCore::GetMortonOffset(x, y, bytes_per_pixel) + coarse_y * stride; - const u8* pixel = buffer + offset; - Math::Vec4 color = {0, 0, 0, 0}; - - switch (surface_format) { - case Format::D16: { - u32 data = Color::DecodeD16(pixel); - color.r() = data & 0xFF; - color.g() = (data >> 8) & 0xFF; - break; - } - case Format::D24: { - u32 data = Color::DecodeD24(pixel); - color.r() = data & 0xFF; - color.g() = (data >> 8) & 0xFF; - color.b() = (data >> 16) & 0xFF; - break; - } - case Format::D24X8: { - Math::Vec2 data = Color::DecodeD24S8(pixel); - color.r() = data.x & 0xFF; - color.g() = (data.x >> 8) & 0xFF; - color.b() = (data.x >> 16) & 0xFF; - break; - } - case Format::X24S8: { - Math::Vec2 data = Color::DecodeD24S8(pixel); - color.r() = color.g() = color.b() = data.y; - break; - } - default: - qDebug() << "Unknown surface format " << static_cast(surface_format); - break; - } - - decoded_image.setPixel(x, y, qRgba(color.r(), color.g(), color.b(), 255)); - } - } - } - - pixmap = QPixmap::fromImage(decoded_image); - surface_picture_label->setPixmap(pixmap); - surface_picture_label->resize(pixmap.size()); - - // Update the info with pixel data - surface_picker_x_control->setEnabled(true); - surface_picker_y_control->setEnabled(true); - Pick(surface_picker_x, surface_picker_y); - - // Enable saving the converted pixmap to file - save_surface->setEnabled(true); -} - -void GraphicsSurfaceWidget::SaveSurface() { - QString png_filter = tr("Portable Network Graphic (*.png)"); - QString bin_filter = tr("Binary data (*.bin)"); - - QString selectedFilter; - QString filename = QFileDialog::getSaveFileName( - this, tr("Save Surface"), - QString("texture-0x%1.png").arg(QString::number(surface_address, 16)), - QString("%1;;%2").arg(png_filter, bin_filter), &selectedFilter); - - if (filename.isEmpty()) { - // If the user canceled the dialog, don't save anything. - return; - } - - if (selectedFilter == png_filter) { - const QPixmap* pixmap = surface_picture_label->pixmap(); - ASSERT_MSG(pixmap != nullptr, "No pixmap set"); - - QFile file(filename); - file.open(QIODevice::WriteOnly); - if (pixmap) - pixmap->save(&file, "PNG"); - } else if (selectedFilter == bin_filter) { - const u8* buffer = Memory::GetPhysicalPointer(surface_address); - ASSERT_MSG(buffer != nullptr, "Memory not accessible"); - - QFile file(filename); - file.open(QIODevice::WriteOnly); - int size = surface_width * surface_height * NibblesPerPixel(surface_format) / 2; - QByteArray data(reinterpret_cast(buffer), size); - file.write(data); - } else { - UNREACHABLE_MSG("Unhandled filter selected"); - } -} - -unsigned int GraphicsSurfaceWidget::NibblesPerPixel(GraphicsSurfaceWidget::Format format) { - if (format <= Format::MaxTextureFormat) { - return Pica::TexturingRegs::NibblesPerPixel( - static_cast(format)); - } - - switch (format) { - case Format::D24X8: - case Format::X24S8: - return 4 * 2; - case Format::D24: - return 3 * 2; - case Format::D16: - return 2 * 2; - default: - UNREACHABLE_MSG("GraphicsSurfaceWidget::BytesPerPixel: this should not be reached as this " - "function should be given a format which is in " - "GraphicsSurfaceWidget::Format. Instead got %i", - static_cast(format)); - return 0; - } -} diff --git a/src/citra_qt/debugger/graphics/graphics_surface.h b/src/citra_qt/debugger/graphics/graphics_surface.h deleted file mode 100644 index 28f5650a7..000000000 --- a/src/citra_qt/debugger/graphics/graphics_surface.h +++ /dev/null @@ -1,118 +0,0 @@ -// Copyright 2014 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include -#include "citra_qt/debugger/graphics/graphics_breakpoint_observer.h" - -class QComboBox; -class QSpinBox; -class CSpinBox; - -class GraphicsSurfaceWidget; - -class SurfacePicture : public QLabel { - Q_OBJECT - -public: - explicit SurfacePicture(QWidget* parent = nullptr, - GraphicsSurfaceWidget* surface_widget = nullptr); - ~SurfacePicture(); - -protected slots: - virtual void mouseMoveEvent(QMouseEvent* event); - virtual void mousePressEvent(QMouseEvent* event); - -private: - GraphicsSurfaceWidget* surface_widget; -}; - -class GraphicsSurfaceWidget : public BreakPointObserverDock { - Q_OBJECT - - using Event = Pica::DebugContext::Event; - - enum class Source { - ColorBuffer = 0, - DepthBuffer = 1, - StencilBuffer = 2, - Texture0 = 3, - Texture1 = 4, - Texture2 = 5, - Custom = 6, - }; - - enum class Format { - // These must match the TextureFormat type! - RGBA8 = 0, - RGB8 = 1, - RGB5A1 = 2, - RGB565 = 3, - RGBA4 = 4, - IA8 = 5, - RG8 = 6, ///< @note Also called HILO8 in 3DBrew. - I8 = 7, - A8 = 8, - IA4 = 9, - I4 = 10, - A4 = 11, - ETC1 = 12, // compressed - ETC1A4 = 13, - MaxTextureFormat = 13, - D16 = 14, - D24 = 15, - D24X8 = 16, - X24S8 = 17, - Unknown = 18, - }; - - static unsigned int NibblesPerPixel(Format format); - -public: - explicit GraphicsSurfaceWidget(std::shared_ptr debug_context, - QWidget* parent = nullptr); - void Pick(int x, int y); - -public slots: - void OnSurfaceSourceChanged(int new_value); - void OnSurfaceAddressChanged(qint64 new_value); - void OnSurfaceWidthChanged(int new_value); - void OnSurfaceHeightChanged(int new_value); - void OnSurfaceFormatChanged(int new_value); - void OnSurfacePickerXChanged(int new_value); - void OnSurfacePickerYChanged(int new_value); - void OnUpdate(); - -private slots: - void OnBreakPointHit(Pica::DebugContext::Event event, void* data) override; - void OnResumed() override; - - void SaveSurface(); - -signals: - void Update(); - -private: - QComboBox* surface_source_list; - CSpinBox* surface_address_control; - QSpinBox* surface_width_control; - QSpinBox* surface_height_control; - QComboBox* surface_format_control; - - SurfacePicture* surface_picture_label; - QSpinBox* surface_picker_x_control; - QSpinBox* surface_picker_y_control; - QLabel* surface_info_label; - QPushButton* save_surface; - - Source surface_source; - unsigned surface_address; - unsigned surface_width; - unsigned surface_height; - Format surface_format; - int surface_picker_x = 0; - int surface_picker_y = 0; -}; diff --git a/src/citra_qt/debugger/graphics/graphics_tracing.cpp b/src/citra_qt/debugger/graphics/graphics_tracing.cpp deleted file mode 100644 index 40d5bed51..000000000 --- a/src/citra_qt/debugger/graphics/graphics_tracing.cpp +++ /dev/null @@ -1,177 +0,0 @@ -// Copyright 2015 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include "citra_qt/debugger/graphics/graphics_tracing.h" -#include "common/common_types.h" -#include "core/hw/gpu.h" -#include "core/hw/lcd.h" -#include "core/tracer/recorder.h" -#include "nihstro/float24.h" -#include "video_core/pica_state.h" - -GraphicsTracingWidget::GraphicsTracingWidget(std::shared_ptr debug_context, - QWidget* parent) - : BreakPointObserverDock(debug_context, tr("CiTrace Recorder"), parent) { - - setObjectName("CiTracing"); - - QPushButton* start_recording = new QPushButton(tr("Start Recording")); - QPushButton* stop_recording = - new QPushButton(QIcon::fromTheme("document-save"), tr("Stop and Save")); - QPushButton* abort_recording = new QPushButton(tr("Abort Recording")); - - connect(this, SIGNAL(SetStartTracingButtonEnabled(bool)), start_recording, - SLOT(setVisible(bool))); - connect(this, SIGNAL(SetStopTracingButtonEnabled(bool)), stop_recording, - SLOT(setVisible(bool))); - connect(this, SIGNAL(SetAbortTracingButtonEnabled(bool)), abort_recording, - SLOT(setVisible(bool))); - connect(start_recording, SIGNAL(clicked()), this, SLOT(StartRecording())); - connect(stop_recording, SIGNAL(clicked()), this, SLOT(StopRecording())); - connect(abort_recording, SIGNAL(clicked()), this, SLOT(AbortRecording())); - - stop_recording->setVisible(false); - abort_recording->setVisible(false); - - auto main_widget = new QWidget; - auto main_layout = new QVBoxLayout; - { - auto sub_layout = new QHBoxLayout; - sub_layout->addWidget(start_recording); - sub_layout->addWidget(stop_recording); - sub_layout->addWidget(abort_recording); - main_layout->addLayout(sub_layout); - } - main_widget->setLayout(main_layout); - setWidget(main_widget); -} - -void GraphicsTracingWidget::StartRecording() { - auto context = context_weak.lock(); - if (!context) - return; - - auto shader_binary = Pica::g_state.vs.program_code; - auto swizzle_data = Pica::g_state.vs.swizzle_data; - - // Encode floating point numbers to 24-bit values - // TODO: Drop this explicit conversion once we store float24 values bit-correctly internally. - std::array default_attributes; - for (unsigned i = 0; i < 16; ++i) { - for (unsigned comp = 0; comp < 3; ++comp) { - default_attributes[4 * i + comp] = nihstro::to_float24( - Pica::g_state.input_default_attributes.attr[i][comp].ToFloat32()); - } - } - - std::array vs_float_uniforms; - for (unsigned i = 0; i < 96; ++i) - for (unsigned comp = 0; comp < 3; ++comp) - vs_float_uniforms[4 * i + comp] = - nihstro::to_float24(Pica::g_state.vs.uniforms.f[i][comp].ToFloat32()); - - CiTrace::Recorder::InitialState state; - std::copy_n((u32*)&GPU::g_regs, sizeof(GPU::g_regs) / sizeof(u32), - std::back_inserter(state.gpu_registers)); - std::copy_n((u32*)&LCD::g_regs, sizeof(LCD::g_regs) / sizeof(u32), - std::back_inserter(state.lcd_registers)); - std::copy_n((u32*)&Pica::g_state.regs, sizeof(Pica::g_state.regs) / sizeof(u32), - std::back_inserter(state.pica_registers)); - boost::copy(default_attributes, std::back_inserter(state.default_attributes)); - boost::copy(shader_binary, std::back_inserter(state.vs_program_binary)); - boost::copy(swizzle_data, std::back_inserter(state.vs_swizzle_data)); - boost::copy(vs_float_uniforms, std::back_inserter(state.vs_float_uniforms)); - // boost::copy(TODO: Not implemented, std::back_inserter(state.gs_program_binary)); - // boost::copy(TODO: Not implemented, std::back_inserter(state.gs_swizzle_data)); - // boost::copy(TODO: Not implemented, std::back_inserter(state.gs_float_uniforms)); - - auto recorder = new CiTrace::Recorder(state); - context->recorder = std::shared_ptr(recorder); - - emit SetStartTracingButtonEnabled(false); - emit SetStopTracingButtonEnabled(true); - emit SetAbortTracingButtonEnabled(true); -} - -void GraphicsTracingWidget::StopRecording() { - auto context = context_weak.lock(); - if (!context) - return; - - QString filename = QFileDialog::getSaveFileName(this, tr("Save CiTrace"), "citrace.ctf", - tr("CiTrace File (*.ctf)")); - - if (filename.isEmpty()) { - // If the user canceled the dialog, keep recording - return; - } - - context->recorder->Finish(filename.toStdString()); - context->recorder = nullptr; - - emit SetStopTracingButtonEnabled(false); - emit SetAbortTracingButtonEnabled(false); - emit SetStartTracingButtonEnabled(true); -} - -void GraphicsTracingWidget::AbortRecording() { - auto context = context_weak.lock(); - if (!context) - return; - - context->recorder = nullptr; - - emit SetStopTracingButtonEnabled(false); - emit SetAbortTracingButtonEnabled(false); - emit SetStartTracingButtonEnabled(true); -} - -void GraphicsTracingWidget::OnBreakPointHit(Pica::DebugContext::Event event, void* data) { - widget()->setEnabled(true); -} - -void GraphicsTracingWidget::OnResumed() { - widget()->setEnabled(false); -} - -void GraphicsTracingWidget::OnEmulationStarting(EmuThread* emu_thread) { - // Disable tracing starting/stopping until a GPU breakpoint is reached - widget()->setEnabled(false); -} - -void GraphicsTracingWidget::OnEmulationStopping() { - // TODO: Is it safe to access the context here? - - auto context = context_weak.lock(); - if (!context) - return; - - if (context->recorder) { - auto reply = - QMessageBox::question(this, tr("CiTracing still active"), - tr("A CiTrace is still being recorded. Do you want to save it? " - "If not, all recorded data will be discarded."), - QMessageBox::Yes | QMessageBox::No, QMessageBox::Yes); - - if (reply == QMessageBox::Yes) { - StopRecording(); - } else { - AbortRecording(); - } - } - - // If the widget was disabled before, enable it now to allow starting - // tracing before starting the next emulation session - widget()->setEnabled(true); -} diff --git a/src/citra_qt/debugger/graphics/graphics_tracing.h b/src/citra_qt/debugger/graphics/graphics_tracing.h deleted file mode 100644 index eb1292c29..000000000 --- a/src/citra_qt/debugger/graphics/graphics_tracing.h +++ /dev/null @@ -1,33 +0,0 @@ -// Copyright 2015 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include "citra_qt/debugger/graphics/graphics_breakpoint_observer.h" - -class EmuThread; - -class GraphicsTracingWidget : public BreakPointObserverDock { - Q_OBJECT - -public: - explicit GraphicsTracingWidget(std::shared_ptr debug_context, - QWidget* parent = nullptr); - - void OnEmulationStarting(EmuThread* emu_thread); - void OnEmulationStopping(); - -private slots: - void StartRecording(); - void StopRecording(); - void AbortRecording(); - - void OnBreakPointHit(Pica::DebugContext::Event event, void* data) override; - void OnResumed() override; - -signals: - void SetStartTracingButtonEnabled(bool enable); - void SetStopTracingButtonEnabled(bool enable); - void SetAbortTracingButtonEnabled(bool enable); -}; diff --git a/src/citra_qt/debugger/graphics/graphics_vertex_shader.cpp b/src/citra_qt/debugger/graphics/graphics_vertex_shader.cpp deleted file mode 100644 index 7f4ec0c52..000000000 --- a/src/citra_qt/debugger/graphics/graphics_vertex_shader.cpp +++ /dev/null @@ -1,622 +0,0 @@ -// Copyright 2014 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include "citra_qt/debugger/graphics/graphics_vertex_shader.h" -#include "citra_qt/util/util.h" -#include "video_core/pica_state.h" -#include "video_core/shader/debug_data.h" -#include "video_core/shader/shader.h" -#include "video_core/shader/shader_interpreter.h" - -using nihstro::OpCode; -using nihstro::Instruction; -using nihstro::SourceRegister; -using nihstro::SwizzlePattern; - -GraphicsVertexShaderModel::GraphicsVertexShaderModel(GraphicsVertexShaderWidget* parent) - : QAbstractTableModel(parent), par(parent) {} - -int GraphicsVertexShaderModel::columnCount(const QModelIndex& parent) const { - return 3; -} - -int GraphicsVertexShaderModel::rowCount(const QModelIndex& parent) const { - return static_cast(par->info.code.size()); -} - -QVariant GraphicsVertexShaderModel::headerData(int section, Qt::Orientation orientation, - int role) const { - switch (role) { - case Qt::DisplayRole: { - if (section == 0) { - return tr("Offset"); - } else if (section == 1) { - return tr("Raw"); - } else if (section == 2) { - return tr("Disassembly"); - } - - break; - } - } - - return QVariant(); -} - -static std::string SelectorToString(u32 selector) { - std::string ret; - for (int i = 0; i < 4; ++i) { - int component = (selector >> ((3 - i) * 2)) & 3; - ret += "xyzw"[component]; - } - return ret; -} - -// e.g. "-c92[a0.x].xyzw" -static void print_input(std::ostringstream& output, const SourceRegister& input, bool negate, - const std::string& swizzle_mask, bool align = true, - const std::string& address_register_name = std::string()) { - if (align) - output << std::setw(4) << std::right; - output << ((negate ? "-" : "") + input.GetName()); - - if (!address_register_name.empty()) - output << '[' << address_register_name << ']'; - output << '.' << swizzle_mask; -}; - -QVariant GraphicsVertexShaderModel::data(const QModelIndex& index, int role) const { - switch (role) { - case Qt::DisplayRole: { - switch (index.column()) { - case 0: - if (par->info.HasLabel(index.row())) - return QString::fromStdString(par->info.GetLabel(index.row())); - - return QString("%1").arg(4 * index.row(), 4, 16, QLatin1Char('0')); - - case 1: - return QString("%1").arg(par->info.code[index.row()].hex, 8, 16, QLatin1Char('0')); - - case 2: { - std::ostringstream output; - output.flags(std::ios::uppercase); - - // To make the code aligning columns of assembly easier to keep track of, this function - // keeps track of the start of the start of the previous column, allowing alignment - // based on desired field widths. - int current_column = 0; - auto AlignToColumn = [&](int col_width) { - // Prints spaces to the output to pad previous column to size and advances the - // column marker. - current_column += col_width; - int to_add = std::max(1, current_column - (int)output.tellp()); - for (int i = 0; i < to_add; ++i) { - output << ' '; - } - }; - - const Instruction instr = par->info.code[index.row()]; - const OpCode opcode = instr.opcode; - const OpCode::Info opcode_info = opcode.GetInfo(); - const u32 operand_desc_id = opcode_info.type == OpCode::Type::MultiplyAdd - ? instr.mad.operand_desc_id.Value() - : instr.common.operand_desc_id.Value(); - const SwizzlePattern swizzle = par->info.swizzle_info[operand_desc_id].pattern; - - // longest known instruction name: "setemit " - int kOpcodeColumnWidth = 8; - // "rXX.xyzw " - int kOutputColumnWidth = 10; - // "-rXX.xyzw ", no attempt is made to align indexed inputs - int kInputOperandColumnWidth = 11; - - output << opcode_info.name; - - switch (opcode_info.type) { - case OpCode::Type::Trivial: - // Nothing to do here - break; - - case OpCode::Type::Arithmetic: - case OpCode::Type::MultiplyAdd: { - // Use custom code for special instructions - switch (opcode.EffectiveOpCode()) { - case OpCode::Id::CMP: { - AlignToColumn(kOpcodeColumnWidth); - - // NOTE: CMP always writes both cc components, so we do not consider the dest - // mask here. - output << " cc.xy"; - AlignToColumn(kOutputColumnWidth); - - SourceRegister src1 = instr.common.GetSrc1(false); - SourceRegister src2 = instr.common.GetSrc2(false); - - output << ' '; - print_input(output, src1, swizzle.negate_src1, - swizzle.SelectorToString(false).substr(0, 1), false, - instr.common.AddressRegisterName()); - output << ' ' << instr.common.compare_op.ToString(instr.common.compare_op.x) - << ' '; - print_input(output, src2, swizzle.negate_src2, - swizzle.SelectorToString(true).substr(0, 1), false); - - output << ", "; - - print_input(output, src1, swizzle.negate_src1, - swizzle.SelectorToString(false).substr(1, 1), false, - instr.common.AddressRegisterName()); - output << ' ' << instr.common.compare_op.ToString(instr.common.compare_op.y) - << ' '; - print_input(output, src2, swizzle.negate_src2, - swizzle.SelectorToString(true).substr(1, 1), false); - - break; - } - - case OpCode::Id::MAD: - case OpCode::Id::MADI: { - AlignToColumn(kOpcodeColumnWidth); - - bool src_is_inverted = 0 != (opcode_info.subtype & OpCode::Info::SrcInversed); - SourceRegister src1 = instr.mad.GetSrc1(src_is_inverted); - SourceRegister src2 = instr.mad.GetSrc2(src_is_inverted); - SourceRegister src3 = instr.mad.GetSrc3(src_is_inverted); - - output << std::setw(3) << std::right << instr.mad.dest.Value().GetName() << '.' - << swizzle.DestMaskToString(); - AlignToColumn(kOutputColumnWidth); - print_input(output, src1, swizzle.negate_src1, - SelectorToString(swizzle.src1_selector)); - AlignToColumn(kInputOperandColumnWidth); - print_input(output, src2, swizzle.negate_src2, - SelectorToString(swizzle.src2_selector), true, - src_is_inverted ? "" : instr.mad.AddressRegisterName()); - AlignToColumn(kInputOperandColumnWidth); - print_input(output, src3, swizzle.negate_src3, - SelectorToString(swizzle.src3_selector), true, - src_is_inverted ? instr.mad.AddressRegisterName() : ""); - AlignToColumn(kInputOperandColumnWidth); - break; - } - - default: { - AlignToColumn(kOpcodeColumnWidth); - - bool src_is_inverted = 0 != (opcode_info.subtype & OpCode::Info::SrcInversed); - - if (opcode_info.subtype & OpCode::Info::Dest) { - // e.g. "r12.xy__" - output << std::setw(3) << std::right << instr.common.dest.Value().GetName() - << '.' << swizzle.DestMaskToString(); - } else if (opcode_info.subtype == OpCode::Info::MOVA) { - output << " a0." << swizzle.DestMaskToString(); - } - AlignToColumn(kOutputColumnWidth); - - if (opcode_info.subtype & OpCode::Info::Src1) { - SourceRegister src1 = instr.common.GetSrc1(src_is_inverted); - print_input(output, src1, swizzle.negate_src1, - swizzle.SelectorToString(false), true, - src_is_inverted ? "" : instr.common.AddressRegisterName()); - AlignToColumn(kInputOperandColumnWidth); - } - - if (opcode_info.subtype & OpCode::Info::Src2) { - SourceRegister src2 = instr.common.GetSrc2(src_is_inverted); - print_input(output, src2, swizzle.negate_src2, - swizzle.SelectorToString(true), true, - src_is_inverted ? instr.common.AddressRegisterName() : ""); - AlignToColumn(kInputOperandColumnWidth); - } - break; - } - } - - break; - } - - case OpCode::Type::Conditional: - case OpCode::Type::UniformFlowControl: { - output << ' '; - - switch (opcode.EffectiveOpCode()) { - case OpCode::Id::LOOP: - output << 'i' << instr.flow_control.int_uniform_id << " (end on 0x" - << std::setw(4) << std::right << std::setfill('0') << std::hex - << (4 * instr.flow_control.dest_offset) << ")"; - break; - - default: - if (opcode_info.subtype & OpCode::Info::HasCondition) { - output << '('; - - if (instr.flow_control.op != instr.flow_control.JustY) { - if (!instr.flow_control.refx) - output << '!'; - output << "cc.x"; - } - - if (instr.flow_control.op == instr.flow_control.Or) { - output << " || "; - } else if (instr.flow_control.op == instr.flow_control.And) { - output << " && "; - } - - if (instr.flow_control.op != instr.flow_control.JustX) { - if (!instr.flow_control.refy) - output << '!'; - output << "cc.y"; - } - - output << ") "; - } else if (opcode_info.subtype & OpCode::Info::HasUniformIndex) { - if (opcode.EffectiveOpCode() == OpCode::Id::JMPU && - (instr.flow_control.num_instructions & 1) == 1) { - output << '!'; - } - output << 'b' << instr.flow_control.bool_uniform_id << ' '; - } - - if (opcode_info.subtype & OpCode::Info::HasAlternative) { - output << "else jump to 0x" << std::setw(4) << std::right - << std::setfill('0') << std::hex - << (4 * instr.flow_control.dest_offset); - } else if (opcode_info.subtype & OpCode::Info::HasExplicitDest) { - output << "jump to 0x" << std::setw(4) << std::right << std::setfill('0') - << std::hex << (4 * instr.flow_control.dest_offset); - } else { - // TODO: Handle other cases - output << "(unknown destination)"; - } - - if (opcode_info.subtype & OpCode::Info::HasFinishPoint) { - output << " (return on 0x" << std::setw(4) << std::right - << std::setfill('0') << std::hex - << (4 * instr.flow_control.dest_offset + - 4 * instr.flow_control.num_instructions) - << ')'; - } - - break; - } - break; - } - - default: - output << " (unknown instruction format)"; - break; - } - - return QString::fromLatin1(output.str().c_str()); - } - - default: - break; - } - } - - case Qt::FontRole: - return GetMonospaceFont(); - - case Qt::BackgroundRole: { - // Highlight current instruction - int current_record_index = par->cycle_index->value(); - if (current_record_index < static_cast(par->debug_data.records.size())) { - const auto& current_record = par->debug_data.records[current_record_index]; - if (index.row() == static_cast(current_record.instruction_offset)) { - return QColor(255, 255, 63); - } - } - - // Use a grey background for instructions which have no debug data associated to them - for (const auto& record : par->debug_data.records) - if (index.row() == static_cast(record.instruction_offset)) - return QVariant(); - - return QBrush(QColor(192, 192, 192)); - } - - // TODO: Draw arrows for each "reachable" instruction to visualize control flow - - default: - break; - } - - return QVariant(); -} - -void GraphicsVertexShaderWidget::DumpShader() { - QString filename = QFileDialog::getSaveFileName( - this, tr("Save Shader Dump"), "shader_dump.shbin", tr("Shader Binary (*.shbin)")); - - if (filename.isEmpty()) { - // If the user canceled the dialog, don't dump anything. - return; - } - - auto& setup = Pica::g_state.vs; - auto& config = Pica::g_state.regs.vs; - - Pica::DebugUtils::DumpShader(filename.toStdString(), config, setup, - Pica::g_state.regs.rasterizer.vs_output_attributes); -} - -GraphicsVertexShaderWidget::GraphicsVertexShaderWidget( - std::shared_ptr debug_context, QWidget* parent) - : BreakPointObserverDock(debug_context, "Pica Vertex Shader", parent) { - setObjectName("PicaVertexShader"); - - // Clear input vertex data so that it contains valid float values in case a debug shader - // execution happens before the first Vertex Loaded breakpoint. - // TODO: This makes a crash in the interpreter much less likely, but not impossible. The - // interpreter should guard against out-of-bounds accesses to ensure crashes in it aren't - // possible. - std::memset(&input_vertex, 0, sizeof(input_vertex)); - - auto input_data_mapper = new QSignalMapper(this); - - // TODO: Support inputting data in hexadecimal raw format - for (unsigned i = 0; i < ARRAY_SIZE(input_data); ++i) { - input_data[i] = new QLineEdit; - input_data[i]->setValidator(new QDoubleValidator(input_data[i])); - } - - breakpoint_warning = - new QLabel(tr("(data only available at vertex shader invocation breakpoints)")); - - // TODO: Add some button for jumping to the shader entry point - - model = new GraphicsVertexShaderModel(this); - binary_list = new QTreeView; - binary_list->setModel(model); - binary_list->setRootIsDecorated(false); - binary_list->setAlternatingRowColors(true); - - auto dump_shader = new QPushButton(QIcon::fromTheme("document-save"), tr("Dump")); - - instruction_description = new QLabel; - - cycle_index = new QSpinBox; - - connect(dump_shader, SIGNAL(clicked()), this, SLOT(DumpShader())); - - connect(cycle_index, SIGNAL(valueChanged(int)), this, SLOT(OnCycleIndexChanged(int))); - - for (unsigned i = 0; i < ARRAY_SIZE(input_data); ++i) { - connect(input_data[i], SIGNAL(textEdited(const QString&)), input_data_mapper, SLOT(map())); - input_data_mapper->setMapping(input_data[i], i); - } - connect(input_data_mapper, SIGNAL(mapped(int)), this, SLOT(OnInputAttributeChanged(int))); - - auto main_widget = new QWidget; - auto main_layout = new QVBoxLayout; - { - auto input_data_group = new QGroupBox(tr("Input Data")); - - // For each vertex attribute, add a QHBoxLayout consisting of: - // - A QLabel denoting the source attribute index - // - Four QLineEdits for showing and manipulating attribute data - // - A QLabel denoting the shader input attribute index - auto sub_layout = new QVBoxLayout; - for (unsigned i = 0; i < 16; ++i) { - // Create an HBoxLayout to store the widgets used to specify a particular attribute - // and store it in a QWidget to allow for easy hiding and unhiding. - auto row_layout = new QHBoxLayout; - // Remove unnecessary padding between rows - row_layout->setContentsMargins(0, 0, 0, 0); - - row_layout->addWidget(new QLabel(tr("Attribute %1").arg(i, 2))); - for (unsigned comp = 0; comp < 4; ++comp) - row_layout->addWidget(input_data[4 * i + comp]); - - row_layout->addWidget(input_data_mapping[i] = new QLabel); - - input_data_container[i] = new QWidget; - input_data_container[i]->setLayout(row_layout); - input_data_container[i]->hide(); - - sub_layout->addWidget(input_data_container[i]); - } - - sub_layout->addWidget(breakpoint_warning); - breakpoint_warning->hide(); - - input_data_group->setLayout(sub_layout); - main_layout->addWidget(input_data_group); - } - - // Make program listing expand to fill available space in the dialog - binary_list->setSizePolicy(QSizePolicy::Preferred, QSizePolicy::MinimumExpanding); - main_layout->addWidget(binary_list); - - main_layout->addWidget(dump_shader); - { - auto sub_layout = new QFormLayout; - sub_layout->addRow(tr("Cycle Index:"), cycle_index); - - main_layout->addLayout(sub_layout); - } - - // Set a minimum height so that the size of this label doesn't cause the rest of the bottom - // part of the UI to keep jumping up and down when cycling through instructions. - instruction_description->setMinimumHeight(instruction_description->fontMetrics().lineSpacing() * - 6); - instruction_description->setAlignment(Qt::AlignLeft | Qt::AlignTop); - main_layout->addWidget(instruction_description); - - main_widget->setLayout(main_layout); - setWidget(main_widget); - - widget()->setEnabled(false); -} - -void GraphicsVertexShaderWidget::OnBreakPointHit(Pica::DebugContext::Event event, void* data) { - if (event == Pica::DebugContext::Event::VertexShaderInvocation) { - Reload(true, data); - } else { - // No vertex data is retrievable => invalidate currently stored vertex data - Reload(true, nullptr); - } - widget()->setEnabled(true); -} - -void GraphicsVertexShaderWidget::Reload(bool replace_vertex_data, void* vertex_data) { - model->beginResetModel(); - - if (replace_vertex_data) { - if (vertex_data) { - memcpy(&input_vertex, vertex_data, sizeof(input_vertex)); - for (unsigned attr = 0; attr < 16; ++attr) { - for (unsigned comp = 0; comp < 4; ++comp) { - input_data[4 * attr + comp]->setText( - QString("%1").arg(input_vertex.attr[attr][comp].ToFloat32())); - } - } - breakpoint_warning->hide(); - } else { - for (unsigned attr = 0; attr < 16; ++attr) { - for (unsigned comp = 0; comp < 4; ++comp) { - input_data[4 * attr + comp]->setText(QString("???")); - } - } - breakpoint_warning->show(); - } - } - - // Reload shader code - info.Clear(); - - auto& shader_setup = Pica::g_state.vs; - auto& shader_config = Pica::g_state.regs.vs; - for (auto instr : shader_setup.program_code) - info.code.push_back({instr}); - int num_attributes = shader_config.max_input_attribute_index + 1; - - for (auto pattern : shader_setup.swizzle_data) - info.swizzle_info.push_back({pattern}); - - u32 entry_point = Pica::g_state.regs.vs.main_offset; - info.labels.insert({entry_point, "main"}); - - // Generate debug information - Pica::Shader::InterpreterEngine shader_engine; - shader_engine.SetupBatch(shader_setup, entry_point); - debug_data = shader_engine.ProduceDebugInfo(shader_setup, input_vertex, shader_config); - - // Reload widget state - for (int attr = 0; attr < num_attributes; ++attr) { - unsigned source_attr = shader_config.GetRegisterForAttribute(attr); - input_data_mapping[attr]->setText(QString("-> v%1").arg(source_attr)); - input_data_container[attr]->setVisible(true); - } - // Only show input attributes which are used as input to the shader - for (unsigned int attr = num_attributes; attr < 16; ++attr) { - input_data_container[attr]->setVisible(false); - } - - // Initialize debug info text for current cycle count - cycle_index->setMaximum(static_cast(debug_data.records.size() - 1)); - OnCycleIndexChanged(cycle_index->value()); - - model->endResetModel(); -} - -void GraphicsVertexShaderWidget::OnResumed() { - widget()->setEnabled(false); -} - -void GraphicsVertexShaderWidget::OnInputAttributeChanged(int index) { - float value = input_data[index]->text().toFloat(); - input_vertex.attr[index / 4][index % 4] = Pica::float24::FromFloat32(value); - // Re-execute shader with updated value - Reload(); -} - -void GraphicsVertexShaderWidget::OnCycleIndexChanged(int index) { - QString text; - - auto& record = debug_data.records[index]; - if (record.mask & Pica::Shader::DebugDataRecord::SRC1) - text += tr("SRC1: %1, %2, %3, %4\n") - .arg(record.src1.x.ToFloat32()) - .arg(record.src1.y.ToFloat32()) - .arg(record.src1.z.ToFloat32()) - .arg(record.src1.w.ToFloat32()); - if (record.mask & Pica::Shader::DebugDataRecord::SRC2) - text += tr("SRC2: %1, %2, %3, %4\n") - .arg(record.src2.x.ToFloat32()) - .arg(record.src2.y.ToFloat32()) - .arg(record.src2.z.ToFloat32()) - .arg(record.src2.w.ToFloat32()); - if (record.mask & Pica::Shader::DebugDataRecord::SRC3) - text += tr("SRC3: %1, %2, %3, %4\n") - .arg(record.src3.x.ToFloat32()) - .arg(record.src3.y.ToFloat32()) - .arg(record.src3.z.ToFloat32()) - .arg(record.src3.w.ToFloat32()); - if (record.mask & Pica::Shader::DebugDataRecord::DEST_IN) - text += tr("DEST_IN: %1, %2, %3, %4\n") - .arg(record.dest_in.x.ToFloat32()) - .arg(record.dest_in.y.ToFloat32()) - .arg(record.dest_in.z.ToFloat32()) - .arg(record.dest_in.w.ToFloat32()); - if (record.mask & Pica::Shader::DebugDataRecord::DEST_OUT) - text += tr("DEST_OUT: %1, %2, %3, %4\n") - .arg(record.dest_out.x.ToFloat32()) - .arg(record.dest_out.y.ToFloat32()) - .arg(record.dest_out.z.ToFloat32()) - .arg(record.dest_out.w.ToFloat32()); - - if (record.mask & Pica::Shader::DebugDataRecord::ADDR_REG_OUT) - text += tr("Address Registers: %1, %2\n") - .arg(record.address_registers[0]) - .arg(record.address_registers[1]); - if (record.mask & Pica::Shader::DebugDataRecord::CMP_RESULT) - text += tr("Compare Result: %1, %2\n") - .arg(record.conditional_code[0] ? "true" : "false") - .arg(record.conditional_code[1] ? "true" : "false"); - - if (record.mask & Pica::Shader::DebugDataRecord::COND_BOOL_IN) - text += tr("Static Condition: %1\n").arg(record.cond_bool ? "true" : "false"); - if (record.mask & Pica::Shader::DebugDataRecord::COND_CMP_IN) - text += tr("Dynamic Conditions: %1, %2\n") - .arg(record.cond_cmp[0] ? "true" : "false") - .arg(record.cond_cmp[1] ? "true" : "false"); - if (record.mask & Pica::Shader::DebugDataRecord::LOOP_INT_IN) - text += tr("Loop Parameters: %1 (repeats), %2 (initializer), %3 (increment), %4\n") - .arg(record.loop_int.x) - .arg(record.loop_int.y) - .arg(record.loop_int.z) - .arg(record.loop_int.w); - - text += - tr("Instruction offset: 0x%1").arg(4 * record.instruction_offset, 4, 16, QLatin1Char('0')); - if (record.mask & Pica::Shader::DebugDataRecord::NEXT_INSTR) { - text += tr(" -> 0x%2").arg(4 * record.next_instruction, 4, 16, QLatin1Char('0')); - } else { - text += tr(" (last instruction)"); - } - - instruction_description->setText(text); - - // Emit model update notification and scroll to current instruction - QModelIndex instr_index = model->index(record.instruction_offset, 0); - emit model->dataChanged(instr_index, - model->index(record.instruction_offset, model->columnCount())); - binary_list->scrollTo(instr_index, QAbstractItemView::EnsureVisible); -} diff --git a/src/citra_qt/debugger/graphics/graphics_vertex_shader.h b/src/citra_qt/debugger/graphics/graphics_vertex_shader.h deleted file mode 100644 index c249a2ff8..000000000 --- a/src/citra_qt/debugger/graphics/graphics_vertex_shader.h +++ /dev/null @@ -1,88 +0,0 @@ -// Copyright 2014 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include -#include "citra_qt/debugger/graphics/graphics_breakpoint_observer.h" -#include "nihstro/parser_shbin.h" -#include "video_core/shader/debug_data.h" -#include "video_core/shader/shader.h" - -class QLabel; -class QSpinBox; - -class GraphicsVertexShaderWidget; - -class GraphicsVertexShaderModel : public QAbstractTableModel { - Q_OBJECT - -public: - explicit GraphicsVertexShaderModel(GraphicsVertexShaderWidget* parent); - - int columnCount(const QModelIndex& parent = QModelIndex()) const override; - int rowCount(const QModelIndex& parent = QModelIndex()) const override; - QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const override; - QVariant headerData(int section, Qt::Orientation orientation, - int role = Qt::DisplayRole) const override; - -private: - GraphicsVertexShaderWidget* par; - - friend class GraphicsVertexShaderWidget; -}; - -class GraphicsVertexShaderWidget : public BreakPointObserverDock { - Q_OBJECT - - using Event = Pica::DebugContext::Event; - -public: - GraphicsVertexShaderWidget(std::shared_ptr debug_context, - QWidget* parent = nullptr); - -private slots: - void OnBreakPointHit(Pica::DebugContext::Event event, void* data) override; - void OnResumed() override; - - void OnInputAttributeChanged(int index); - - void OnCycleIndexChanged(int index); - - void DumpShader(); - - /** - * Reload widget based on the current PICA200 state - * @param replace_vertex_data If true, invalidate all current vertex data - * @param vertex_data New vertex data to use, as passed to OnBreakPointHit. May be nullptr to - * specify that no valid vertex data can be retrieved currently. Only used if - * replace_vertex_data is true. - */ - void Reload(bool replace_vertex_data = false, void* vertex_data = nullptr); - -private: - QLabel* instruction_description; - QTreeView* binary_list; - GraphicsVertexShaderModel* model; - - /// TODO: Move these into a single struct - std::array - input_data; // A text box for each of the 4 components of up to 16 vertex attributes - std::array - input_data_container; // QWidget containing the QLayout containing each vertex attribute - std::array input_data_mapping; // A QLabel denoting the shader input attribute - // which the vertex attribute maps to - - // Text to be shown when input vertex data is not retrievable - QLabel* breakpoint_warning; - - QSpinBox* cycle_index; - - nihstro::ShaderInfo info; - Pica::Shader::DebugData debug_data; - Pica::Shader::AttributeBuffer input_vertex; - - friend class GraphicsVertexShaderModel; -}; diff --git a/src/citra_qt/debugger/profiler.cpp b/src/citra_qt/debugger/profiler.cpp deleted file mode 100644 index f060bbe08..000000000 --- a/src/citra_qt/debugger/profiler.cpp +++ /dev/null @@ -1,224 +0,0 @@ -// Copyright 2015 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#include -#include -#include -#include -#include -#include "citra_qt/debugger/profiler.h" -#include "citra_qt/util/util.h" -#include "common/common_types.h" -#include "common/microprofile.h" - -// Include the implementation of the UI in this file. This isn't in microprofile.cpp because the -// non-Qt frontends don't need it (and don't implement the UI drawing hooks either). -#if MICROPROFILE_ENABLED -#define MICROPROFILEUI_IMPL 1 -#include "common/microprofileui.h" - -class MicroProfileWidget : public QWidget { -public: - MicroProfileWidget(QWidget* parent = nullptr); - -protected: - void paintEvent(QPaintEvent* ev) override; - void showEvent(QShowEvent* ev) override; - void hideEvent(QHideEvent* ev) override; - - void mouseMoveEvent(QMouseEvent* ev) override; - void mousePressEvent(QMouseEvent* ev) override; - void mouseReleaseEvent(QMouseEvent* ev) override; - void wheelEvent(QWheelEvent* ev) override; - - void keyPressEvent(QKeyEvent* ev) override; - void keyReleaseEvent(QKeyEvent* ev) override; - -private: - /// This timer is used to redraw the widget's contents continuously. To save resources, it only - /// runs while the widget is visible. - QTimer update_timer; - /// Scale the coordinate system appropriately when dpi != 96. - qreal x_scale = 1.0, y_scale = 1.0; -}; - -#endif - -MicroProfileDialog::MicroProfileDialog(QWidget* parent) : QWidget(parent, Qt::Dialog) { - setObjectName("MicroProfile"); - setWindowTitle(tr("MicroProfile")); - resize(1000, 600); - // Remove the "?" button from the titlebar and enable the maximize button - setWindowFlags(windowFlags() & ~Qt::WindowContextHelpButtonHint | Qt::WindowMaximizeButtonHint); - -#if MICROPROFILE_ENABLED - - MicroProfileWidget* widget = new MicroProfileWidget(this); - - QLayout* layout = new QVBoxLayout(this); - layout->setContentsMargins(0, 0, 0, 0); - layout->addWidget(widget); - setLayout(layout); - - // Configure focus so that widget is focusable and the dialog automatically forwards focus to - // it. - setFocusProxy(widget); - widget->setFocusPolicy(Qt::StrongFocus); - widget->setFocus(); -#endif -} - -QAction* MicroProfileDialog::toggleViewAction() { - if (toggle_view_action == nullptr) { - toggle_view_action = new QAction(windowTitle(), this); - toggle_view_action->setCheckable(true); - toggle_view_action->setChecked(isVisible()); - connect(toggle_view_action, SIGNAL(toggled(bool)), SLOT(setVisible(bool))); - } - - return toggle_view_action; -} - -void MicroProfileDialog::showEvent(QShowEvent* ev) { - if (toggle_view_action) { - toggle_view_action->setChecked(isVisible()); - } - QWidget::showEvent(ev); -} - -void MicroProfileDialog::hideEvent(QHideEvent* ev) { - if (toggle_view_action) { - toggle_view_action->setChecked(isVisible()); - } - QWidget::hideEvent(ev); -} - -#if MICROPROFILE_ENABLED - -/// There's no way to pass a user pointer to MicroProfile, so this variable is used to make the -/// QPainter available inside the drawing callbacks. -static QPainter* mp_painter = nullptr; - -MicroProfileWidget::MicroProfileWidget(QWidget* parent) : QWidget(parent) { - // Send mouse motion events even when not dragging. - setMouseTracking(true); - - MicroProfileSetDisplayMode(1); // Timers screen - MicroProfileInitUI(); - - connect(&update_timer, SIGNAL(timeout()), SLOT(update())); -} - -void MicroProfileWidget::paintEvent(QPaintEvent* ev) { - QPainter painter(this); - - // The units used by Microprofile for drawing are based in pixels on a 96 dpi display. - x_scale = qreal(painter.device()->logicalDpiX()) / 96.0; - y_scale = qreal(painter.device()->logicalDpiY()) / 96.0; - painter.scale(x_scale, y_scale); - - painter.setBackground(Qt::black); - painter.eraseRect(rect()); - - QFont font = GetMonospaceFont(); - font.setPixelSize(MICROPROFILE_TEXT_HEIGHT); - painter.setFont(font); - - mp_painter = &painter; - MicroProfileDraw(rect().width() / x_scale, rect().height() / y_scale); - mp_painter = nullptr; -} - -void MicroProfileWidget::showEvent(QShowEvent* ev) { - update_timer.start(15); // ~60 Hz - QWidget::showEvent(ev); -} - -void MicroProfileWidget::hideEvent(QHideEvent* ev) { - update_timer.stop(); - QWidget::hideEvent(ev); -} - -void MicroProfileWidget::mouseMoveEvent(QMouseEvent* ev) { - MicroProfileMousePosition(ev->x() / x_scale, ev->y() / y_scale, 0); - ev->accept(); -} - -void MicroProfileWidget::mousePressEvent(QMouseEvent* ev) { - MicroProfileMousePosition(ev->x() / x_scale, ev->y() / y_scale, 0); - MicroProfileMouseButton(ev->buttons() & Qt::LeftButton, ev->buttons() & Qt::RightButton); - ev->accept(); -} - -void MicroProfileWidget::mouseReleaseEvent(QMouseEvent* ev) { - MicroProfileMousePosition(ev->x() / x_scale, ev->y() / y_scale, 0); - MicroProfileMouseButton(ev->buttons() & Qt::LeftButton, ev->buttons() & Qt::RightButton); - ev->accept(); -} - -void MicroProfileWidget::wheelEvent(QWheelEvent* ev) { - MicroProfileMousePosition(ev->x() / x_scale, ev->y() / y_scale, ev->delta() / 120); - ev->accept(); -} - -void MicroProfileWidget::keyPressEvent(QKeyEvent* ev) { - if (ev->key() == Qt::Key_Control) { - // Inform MicroProfile that the user is holding Ctrl. - MicroProfileModKey(1); - } - QWidget::keyPressEvent(ev); -} - -void MicroProfileWidget::keyReleaseEvent(QKeyEvent* ev) { - if (ev->key() == Qt::Key_Control) { - MicroProfileModKey(0); - } - QWidget::keyReleaseEvent(ev); -} - -// These functions are called by MicroProfileDraw to draw the interface elements on the screen. - -void MicroProfileDrawText(int x, int y, u32 hex_color, const char* text, u32 text_length) { - // hex_color does not include an alpha, so it must be assumed to be 255 - mp_painter->setPen(QColor::fromRgb(hex_color)); - - // It's impossible to draw a string using a monospaced font with a fixed width per cell in a - // way that's reliable across different platforms and fonts as far as I (yuriks) can tell, so - // draw each character individually in order to precisely control the text advance. - for (u32 i = 0; i < text_length; ++i) { - // Position the text baseline 1 pixel above the bottom of the text cell, this gives nice - // vertical alignment of text for a wide range of tested fonts. - mp_painter->drawText(x, y + MICROPROFILE_TEXT_HEIGHT - 2, QChar(text[i])); - x += MICROPROFILE_TEXT_WIDTH + 1; - } -} - -void MicroProfileDrawBox(int left, int top, int right, int bottom, u32 hex_color, - MicroProfileBoxType type) { - QColor color = QColor::fromRgba(hex_color); - QBrush brush = color; - if (type == MicroProfileBoxTypeBar) { - QLinearGradient gradient(left, top, left, bottom); - gradient.setColorAt(0.f, color.lighter(125)); - gradient.setColorAt(1.f, color.darker(125)); - brush = gradient; - } - mp_painter->fillRect(left, top, right - left, bottom - top, brush); -} - -void MicroProfileDrawLine2D(u32 vertices_length, float* vertices, u32 hex_color) { - // Temporary vector used to convert between the float array and QPointF. Marked static to reuse - // the allocation across calls. - static std::vector point_buf; - - for (u32 i = 0; i < vertices_length; ++i) { - point_buf.emplace_back(vertices[i * 2 + 0], vertices[i * 2 + 1]); - } - - // hex_color does not include an alpha, so it must be assumed to be 255 - mp_painter->setPen(QColor::fromRgb(hex_color)); - mp_painter->drawPolyline(point_buf.data(), vertices_length); - point_buf.clear(); -} -#endif diff --git a/src/citra_qt/debugger/profiler.h b/src/citra_qt/debugger/profiler.h deleted file mode 100644 index eae1e9e3c..000000000 --- a/src/citra_qt/debugger/profiler.h +++ /dev/null @@ -1,27 +0,0 @@ -// Copyright 2015 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include -#include -#include "common/microprofile.h" - -class MicroProfileDialog : public QWidget { - Q_OBJECT - -public: - explicit MicroProfileDialog(QWidget* parent = nullptr); - - /// Returns a QAction that can be used to toggle visibility of this dialog. - QAction* toggleViewAction(); - -protected: - void showEvent(QShowEvent* ev) override; - void hideEvent(QHideEvent* ev) override; - -private: - QAction* toggle_view_action = nullptr; -}; diff --git a/src/citra_qt/debugger/registers.cpp b/src/citra_qt/debugger/registers.cpp deleted file mode 100644 index f9345c9f6..000000000 --- a/src/citra_qt/debugger/registers.cpp +++ /dev/null @@ -1,190 +0,0 @@ -// Copyright 2014 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#include -#include "citra_qt/debugger/registers.h" -#include "citra_qt/util/util.h" -#include "core/arm/arm_interface.h" -#include "core/core.h" - -RegistersWidget::RegistersWidget(QWidget* parent) : QDockWidget(parent) { - cpu_regs_ui.setupUi(this); - - tree = cpu_regs_ui.treeWidget; - tree->addTopLevelItem(core_registers = new QTreeWidgetItem(QStringList(tr("Registers")))); - tree->addTopLevelItem(vfp_registers = new QTreeWidgetItem(QStringList(tr("VFP Registers")))); - tree->addTopLevelItem(vfp_system_registers = - new QTreeWidgetItem(QStringList(tr("VFP System Registers")))); - tree->addTopLevelItem(cpsr = new QTreeWidgetItem(QStringList("CPSR"))); - - for (int i = 0; i < 16; ++i) { - QTreeWidgetItem* child = new QTreeWidgetItem(QStringList(QString("R[%1]").arg(i))); - core_registers->addChild(child); - } - - for (int i = 0; i < 32; ++i) { - QTreeWidgetItem* child = new QTreeWidgetItem(QStringList(QString("S[%1]").arg(i))); - vfp_registers->addChild(child); - } - - QFont font = GetMonospaceFont(); - - CreateCPSRChildren(); - CreateVFPSystemRegisterChildren(); - - // Set Registers to display in monospace font - for (int i = 0; i < core_registers->childCount(); ++i) - core_registers->child(i)->setFont(1, font); - - for (int i = 0; i < vfp_registers->childCount(); ++i) - vfp_registers->child(i)->setFont(1, font); - - for (int i = 0; i < vfp_system_registers->childCount(); ++i) { - vfp_system_registers->child(i)->setFont(1, font); - for (int x = 0; x < vfp_system_registers->child(i)->childCount(); ++x) { - vfp_system_registers->child(i)->child(x)->setFont(1, font); - } - } - // Set CSPR to display in monospace font - cpsr->setFont(1, font); - for (int i = 0; i < cpsr->childCount(); ++i) { - cpsr->child(i)->setFont(1, font); - for (int x = 0; x < cpsr->child(i)->childCount(); ++x) { - cpsr->child(i)->child(x)->setFont(1, font); - } - } - setEnabled(false); -} - -void RegistersWidget::OnDebugModeEntered() { - if (!Core::System::GetInstance().IsPoweredOn()) - return; - - for (int i = 0; i < core_registers->childCount(); ++i) - core_registers->child(i)->setText( - 1, QString("0x%1").arg(Core::CPU().GetReg(i), 8, 16, QLatin1Char('0'))); - - UpdateCPSRValues(); -} - -void RegistersWidget::OnDebugModeLeft() {} - -void RegistersWidget::OnEmulationStarting(EmuThread* emu_thread) { - setEnabled(true); -} - -void RegistersWidget::OnEmulationStopping() { - // Reset widget text - for (int i = 0; i < core_registers->childCount(); ++i) - core_registers->child(i)->setText(1, QString("")); - - for (int i = 0; i < vfp_registers->childCount(); ++i) - vfp_registers->child(i)->setText(1, QString("")); - - for (int i = 0; i < cpsr->childCount(); ++i) - cpsr->child(i)->setText(1, QString("")); - - cpsr->setText(1, QString("")); - - // FPSCR - for (int i = 0; i < vfp_system_registers->child(0)->childCount(); ++i) - vfp_system_registers->child(0)->child(i)->setText(1, QString("")); - - // FPEXC - for (int i = 0; i < vfp_system_registers->child(1)->childCount(); ++i) - vfp_system_registers->child(1)->child(i)->setText(1, QString("")); - - vfp_system_registers->child(0)->setText(1, QString("")); - vfp_system_registers->child(1)->setText(1, QString("")); - vfp_system_registers->child(2)->setText(1, QString("")); - vfp_system_registers->child(3)->setText(1, QString("")); - - setEnabled(false); -} - -void RegistersWidget::CreateCPSRChildren() { - cpsr->addChild(new QTreeWidgetItem(QStringList("M"))); - cpsr->addChild(new QTreeWidgetItem(QStringList("T"))); - cpsr->addChild(new QTreeWidgetItem(QStringList("F"))); - cpsr->addChild(new QTreeWidgetItem(QStringList("I"))); - cpsr->addChild(new QTreeWidgetItem(QStringList("A"))); - cpsr->addChild(new QTreeWidgetItem(QStringList("E"))); - cpsr->addChild(new QTreeWidgetItem(QStringList("IT"))); - cpsr->addChild(new QTreeWidgetItem(QStringList("GE"))); - cpsr->addChild(new QTreeWidgetItem(QStringList("DNM"))); - cpsr->addChild(new QTreeWidgetItem(QStringList("J"))); - cpsr->addChild(new QTreeWidgetItem(QStringList("Q"))); - cpsr->addChild(new QTreeWidgetItem(QStringList("V"))); - cpsr->addChild(new QTreeWidgetItem(QStringList("C"))); - cpsr->addChild(new QTreeWidgetItem(QStringList("Z"))); - cpsr->addChild(new QTreeWidgetItem(QStringList("N"))); -} - -void RegistersWidget::UpdateCPSRValues() { - const u32 cpsr_val = Core::CPU().GetCPSR(); - - cpsr->setText(1, QString("0x%1").arg(cpsr_val, 8, 16, QLatin1Char('0'))); - cpsr->child(0)->setText( - 1, QString("b%1").arg(cpsr_val & 0x1F, 5, 2, QLatin1Char('0'))); // M - Mode - cpsr->child(1)->setText(1, QString::number((cpsr_val >> 5) & 1)); // T - State - cpsr->child(2)->setText(1, QString::number((cpsr_val >> 6) & 1)); // F - FIQ disable - cpsr->child(3)->setText(1, QString::number((cpsr_val >> 7) & 1)); // I - IRQ disable - cpsr->child(4)->setText(1, QString::number((cpsr_val >> 8) & 1)); // A - Imprecise abort - cpsr->child(5)->setText(1, QString::number((cpsr_val >> 9) & 1)); // E - Data endianness - cpsr->child(6)->setText(1, - QString::number((cpsr_val >> 10) & 0x3F)); // IT - If-Then state (DNM) - cpsr->child(7)->setText(1, - QString::number((cpsr_val >> 16) & 0xF)); // GE - Greater-than-or-Equal - cpsr->child(8)->setText(1, QString::number((cpsr_val >> 20) & 0xF)); // DNM - Do not modify - cpsr->child(9)->setText(1, QString::number((cpsr_val >> 24) & 1)); // J - Jazelle - cpsr->child(10)->setText(1, QString::number((cpsr_val >> 27) & 1)); // Q - Saturation - cpsr->child(11)->setText(1, QString::number((cpsr_val >> 28) & 1)); // V - Overflow - cpsr->child(12)->setText(1, QString::number((cpsr_val >> 29) & 1)); // C - Carry/Borrow/Extend - cpsr->child(13)->setText(1, QString::number((cpsr_val >> 30) & 1)); // Z - Zero - cpsr->child(14)->setText(1, QString::number((cpsr_val >> 31) & 1)); // N - Negative/Less than -} - -void RegistersWidget::CreateVFPSystemRegisterChildren() { - QTreeWidgetItem* const fpscr = new QTreeWidgetItem(QStringList("FPSCR")); - fpscr->addChild(new QTreeWidgetItem(QStringList("IOC"))); - fpscr->addChild(new QTreeWidgetItem(QStringList("DZC"))); - fpscr->addChild(new QTreeWidgetItem(QStringList("OFC"))); - fpscr->addChild(new QTreeWidgetItem(QStringList("UFC"))); - fpscr->addChild(new QTreeWidgetItem(QStringList("IXC"))); - fpscr->addChild(new QTreeWidgetItem(QStringList("IDC"))); - fpscr->addChild(new QTreeWidgetItem(QStringList("IOE"))); - fpscr->addChild(new QTreeWidgetItem(QStringList("DZE"))); - fpscr->addChild(new QTreeWidgetItem(QStringList("OFE"))); - fpscr->addChild(new QTreeWidgetItem(QStringList("UFE"))); - fpscr->addChild(new QTreeWidgetItem(QStringList("IXE"))); - fpscr->addChild(new QTreeWidgetItem(QStringList("IDE"))); - fpscr->addChild(new QTreeWidgetItem(QStringList(tr("Vector Length")))); - fpscr->addChild(new QTreeWidgetItem(QStringList(tr("Vector Stride")))); - fpscr->addChild(new QTreeWidgetItem(QStringList(tr("Rounding Mode")))); - fpscr->addChild(new QTreeWidgetItem(QStringList("FZ"))); - fpscr->addChild(new QTreeWidgetItem(QStringList("DN"))); - fpscr->addChild(new QTreeWidgetItem(QStringList("V"))); - fpscr->addChild(new QTreeWidgetItem(QStringList("C"))); - fpscr->addChild(new QTreeWidgetItem(QStringList("Z"))); - fpscr->addChild(new QTreeWidgetItem(QStringList("N"))); - - QTreeWidgetItem* const fpexc = new QTreeWidgetItem(QStringList("FPEXC")); - fpexc->addChild(new QTreeWidgetItem(QStringList("IOC"))); - fpexc->addChild(new QTreeWidgetItem(QStringList("OFC"))); - fpexc->addChild(new QTreeWidgetItem(QStringList("UFC"))); - fpexc->addChild(new QTreeWidgetItem(QStringList("INV"))); - fpexc->addChild(new QTreeWidgetItem(QStringList(tr("Vector Iteration Count")))); - fpexc->addChild(new QTreeWidgetItem(QStringList("FP2V"))); - fpexc->addChild(new QTreeWidgetItem(QStringList("EN"))); - fpexc->addChild(new QTreeWidgetItem(QStringList("EX"))); - - vfp_system_registers->addChild(fpscr); - vfp_system_registers->addChild(fpexc); - vfp_system_registers->addChild(new QTreeWidgetItem(QStringList("FPINST"))); - vfp_system_registers->addChild(new QTreeWidgetItem(QStringList("FPINST2"))); -} - -void RegistersWidget::UpdateVFPSystemRegisterValues() { - UNIMPLEMENTED(); -} diff --git a/src/citra_qt/debugger/registers.h b/src/citra_qt/debugger/registers.h deleted file mode 100644 index 55bda5b59..000000000 --- a/src/citra_qt/debugger/registers.h +++ /dev/null @@ -1,42 +0,0 @@ -// Copyright 2014 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include "ui_registers.h" - -class QTreeWidget; -class QTreeWidgetItem; -class EmuThread; - -class RegistersWidget : public QDockWidget { - Q_OBJECT - -public: - explicit RegistersWidget(QWidget* parent = nullptr); - -public slots: - void OnDebugModeEntered(); - void OnDebugModeLeft(); - - void OnEmulationStarting(EmuThread* emu_thread); - void OnEmulationStopping(); - -private: - void CreateCPSRChildren(); - void UpdateCPSRValues(); - - void CreateVFPSystemRegisterChildren(); - void UpdateVFPSystemRegisterValues(); - - Ui::ARMRegisters cpu_regs_ui; - - QTreeWidget* tree; - - QTreeWidgetItem* core_registers; - QTreeWidgetItem* vfp_registers; - QTreeWidgetItem* vfp_system_registers; - QTreeWidgetItem* cpsr; -}; diff --git a/src/citra_qt/debugger/registers.ui b/src/citra_qt/debugger/registers.ui deleted file mode 100644 index c81ae03f9..000000000 --- a/src/citra_qt/debugger/registers.ui +++ /dev/null @@ -1,40 +0,0 @@ - - - ARMRegisters - - - - 0 - 0 - 400 - 300 - - - - ARM Registers - - - - - - - true - - - - Register - - - - - Value - - - - - - - - - - diff --git a/src/citra_qt/debugger/wait_tree.cpp b/src/citra_qt/debugger/wait_tree.cpp deleted file mode 100644 index eefbcb9f1..000000000 --- a/src/citra_qt/debugger/wait_tree.cpp +++ /dev/null @@ -1,417 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#include "citra_qt/debugger/wait_tree.h" -#include "citra_qt/util/util.h" - -#include "core/hle/kernel/condition_variable.h" -#include "core/hle/kernel/event.h" -#include "core/hle/kernel/mutex.h" -#include "core/hle/kernel/thread.h" -#include "core/hle/kernel/timer.h" -#include "core/hle/kernel/wait_object.h" - -WaitTreeItem::~WaitTreeItem() {} - -QColor WaitTreeItem::GetColor() const { - return QColor(Qt::GlobalColor::black); -} - -std::vector> WaitTreeItem::GetChildren() const { - return {}; -} - -void WaitTreeItem::Expand() { - if (IsExpandable() && !expanded) { - children = GetChildren(); - for (std::size_t i = 0; i < children.size(); ++i) { - children[i]->parent = this; - children[i]->row = i; - } - expanded = true; - } -} - -WaitTreeItem* WaitTreeItem::Parent() const { - return parent; -} - -const std::vector>& WaitTreeItem::Children() const { - return children; -} - -bool WaitTreeItem::IsExpandable() const { - return false; -} - -std::size_t WaitTreeItem::Row() const { - return row; -} - -std::vector> WaitTreeItem::MakeThreadItemList() { - const auto& threads = Kernel::GetThreadList(); - std::vector> item_list; - item_list.reserve(threads.size()); - for (std::size_t i = 0; i < threads.size(); ++i) { - item_list.push_back(std::make_unique(*threads[i])); - item_list.back()->row = i; - } - return item_list; -} - -WaitTreeText::WaitTreeText(const QString& t) : text(t) {} - -QString WaitTreeText::GetText() const { - return text; -} - -WaitTreeWaitObject::WaitTreeWaitObject(const Kernel::WaitObject& o) : object(o) {} - -bool WaitTreeExpandableItem::IsExpandable() const { - return true; -} - -QString WaitTreeWaitObject::GetText() const { - return tr("[%1]%2 %3") - .arg(object.GetObjectId()) - .arg(QString::fromStdString(object.GetTypeName()), - QString::fromStdString(object.GetName())); -} - -std::unique_ptr WaitTreeWaitObject::make(const Kernel::WaitObject& object) { - switch (object.GetHandleType()) { - case Kernel::HandleType::Event: - return std::make_unique(static_cast(object)); - case Kernel::HandleType::Mutex: - return std::make_unique(static_cast(object)); - case Kernel::HandleType::ConditionVariable: - return std::make_unique( - static_cast(object)); - case Kernel::HandleType::Timer: - return std::make_unique(static_cast(object)); - case Kernel::HandleType::Thread: - return std::make_unique(static_cast(object)); - default: - return std::make_unique(object); - } -} - -std::vector> WaitTreeWaitObject::GetChildren() const { - std::vector> list; - - const auto& threads = object.GetWaitingThreads(); - if (threads.empty()) { - list.push_back(std::make_unique(tr("waited by no thread"))); - } else { - list.push_back(std::make_unique(threads)); - } - return list; -} - -QString WaitTreeWaitObject::GetResetTypeQString(Kernel::ResetType reset_type) { - switch (reset_type) { - case Kernel::ResetType::OneShot: - return tr("one shot"); - case Kernel::ResetType::Sticky: - return tr("sticky"); - case Kernel::ResetType::Pulse: - return tr("pulse"); - } -} - -WaitTreeObjectList::WaitTreeObjectList( - const std::vector>& list, bool w_all) - : object_list(list), wait_all(w_all) {} - -QString WaitTreeObjectList::GetText() const { - if (wait_all) - return tr("waiting for all objects"); - return tr("waiting for one of the following objects"); -} - -std::vector> WaitTreeObjectList::GetChildren() const { - std::vector> list(object_list.size()); - std::transform(object_list.begin(), object_list.end(), list.begin(), - [](const auto& t) { return WaitTreeWaitObject::make(*t); }); - return list; -} - -WaitTreeThread::WaitTreeThread(const Kernel::Thread& thread) : WaitTreeWaitObject(thread) {} - -QString WaitTreeThread::GetText() const { - const auto& thread = static_cast(object); - QString status; - switch (thread.status) { - case THREADSTATUS_RUNNING: - status = tr("running"); - break; - case THREADSTATUS_READY: - status = tr("ready"); - break; - case THREADSTATUS_WAIT_ARB: - status = tr("waiting for address 0x%1").arg(thread.wait_address, 8, 16, QLatin1Char('0')); - break; - case THREADSTATUS_WAIT_SLEEP: - status = tr("sleeping"); - break; - case THREADSTATUS_WAIT_SYNCH_ALL: - case THREADSTATUS_WAIT_SYNCH_ANY: - status = tr("waiting for objects"); - break; - case THREADSTATUS_DORMANT: - status = tr("dormant"); - break; - case THREADSTATUS_DEAD: - status = tr("dead"); - break; - } - QString pc_info = tr(" PC = 0x%1 LR = 0x%2") - .arg(thread.context.pc, 8, 16, QLatin1Char('0')) - .arg(thread.context.cpu_registers[31], 8, 16, QLatin1Char('0')); - return WaitTreeWaitObject::GetText() + pc_info + " (" + status + ") "; -} - -QColor WaitTreeThread::GetColor() const { - const auto& thread = static_cast(object); - switch (thread.status) { - case THREADSTATUS_RUNNING: - return QColor(Qt::GlobalColor::darkGreen); - case THREADSTATUS_READY: - return QColor(Qt::GlobalColor::darkBlue); - case THREADSTATUS_WAIT_ARB: - return QColor(Qt::GlobalColor::darkRed); - case THREADSTATUS_WAIT_SLEEP: - return QColor(Qt::GlobalColor::darkYellow); - case THREADSTATUS_WAIT_SYNCH_ALL: - case THREADSTATUS_WAIT_SYNCH_ANY: - return QColor(Qt::GlobalColor::red); - case THREADSTATUS_DORMANT: - return QColor(Qt::GlobalColor::darkCyan); - case THREADSTATUS_DEAD: - return QColor(Qt::GlobalColor::gray); - default: - return WaitTreeItem::GetColor(); - } -} - -std::vector> WaitTreeThread::GetChildren() const { - std::vector> list(WaitTreeWaitObject::GetChildren()); - - const auto& thread = static_cast(object); - - QString processor; - switch (thread.processor_id) { - case ThreadProcessorId::THREADPROCESSORID_DEFAULT: - processor = tr("default"); - break; - case ThreadProcessorId::THREADPROCESSORID_0: - case ThreadProcessorId::THREADPROCESSORID_1: - case ThreadProcessorId::THREADPROCESSORID_2: - case ThreadProcessorId::THREADPROCESSORID_3: - processor = tr("core %1").arg(thread.processor_id); - break; - default: - processor = tr("Unknown processor %1").arg(thread.processor_id); - break; - } - - list.push_back(std::make_unique(tr("processor = %1").arg(processor))); - list.push_back(std::make_unique(tr("thread id = %1").arg(thread.GetThreadId()))); - list.push_back(std::make_unique(tr("priority = %1(current) / %2(normal)") - .arg(thread.current_priority) - .arg(thread.nominal_priority))); - list.push_back(std::make_unique( - tr("last running ticks = %1").arg(thread.last_running_ticks))); - - if (thread.held_mutexes.empty()) { - list.push_back(std::make_unique(tr("not holding mutex"))); - } else { - list.push_back(std::make_unique(thread.held_mutexes)); - } - if (thread.status == THREADSTATUS_WAIT_SYNCH_ANY || - thread.status == THREADSTATUS_WAIT_SYNCH_ALL) { - list.push_back(std::make_unique(thread.wait_objects, - thread.IsSleepingOnWaitAll())); - } - - return list; -} - -WaitTreeEvent::WaitTreeEvent(const Kernel::Event& object) : WaitTreeWaitObject(object) {} - -std::vector> WaitTreeEvent::GetChildren() const { - std::vector> list(WaitTreeWaitObject::GetChildren()); - - list.push_back(std::make_unique( - tr("reset type = %1") - .arg(GetResetTypeQString(static_cast(object).reset_type)))); - return list; -} - -WaitTreeMutex::WaitTreeMutex(const Kernel::Mutex& object) : WaitTreeWaitObject(object) {} - -std::vector> WaitTreeMutex::GetChildren() const { - std::vector> list(WaitTreeWaitObject::GetChildren()); - - const auto& mutex = static_cast(object); - if (mutex.GetHasWaiters()) { - list.push_back(std::make_unique(tr("locked by thread:"))); - list.push_back(std::make_unique(*mutex.GetHoldingThread())); - } else { - list.push_back(std::make_unique(tr("free"))); - } - return list; -} - -WaitTreeConditionVariable::WaitTreeConditionVariable(const Kernel::ConditionVariable& object) - : WaitTreeWaitObject(object) {} - -std::vector> WaitTreeConditionVariable::GetChildren() const { - std::vector> list(WaitTreeWaitObject::GetChildren()); - - const auto& condition_variable = static_cast(object); - list.push_back(std::make_unique( - tr("available count = %1").arg(condition_variable.GetAvailableCount()))); - return list; -} - -WaitTreeTimer::WaitTreeTimer(const Kernel::Timer& object) : WaitTreeWaitObject(object) {} - -std::vector> WaitTreeTimer::GetChildren() const { - std::vector> list(WaitTreeWaitObject::GetChildren()); - - const auto& timer = static_cast(object); - - list.push_back(std::make_unique( - tr("reset type = %1").arg(GetResetTypeQString(timer.reset_type)))); - list.push_back( - std::make_unique(tr("initial delay = %1").arg(timer.initial_delay))); - list.push_back( - std::make_unique(tr("interval delay = %1").arg(timer.interval_delay))); - return list; -} - -WaitTreeMutexList::WaitTreeMutexList( - const boost::container::flat_set>& list) - : mutex_list(list) {} - -QString WaitTreeMutexList::GetText() const { - return tr("holding mutexes"); -} - -std::vector> WaitTreeMutexList::GetChildren() const { - std::vector> list(mutex_list.size()); - std::transform(mutex_list.begin(), mutex_list.end(), list.begin(), - [](const auto& t) { return std::make_unique(*t); }); - return list; -} - -WaitTreeThreadList::WaitTreeThreadList(const std::vector>& list) - : thread_list(list) {} - -QString WaitTreeThreadList::GetText() const { - return tr("waited by thread"); -} - -std::vector> WaitTreeThreadList::GetChildren() const { - std::vector> list(thread_list.size()); - std::transform(thread_list.begin(), thread_list.end(), list.begin(), - [](const auto& t) { return std::make_unique(*t); }); - return list; -} - -WaitTreeModel::WaitTreeModel(QObject* parent) : QAbstractItemModel(parent) {} - -QModelIndex WaitTreeModel::index(int row, int column, const QModelIndex& parent) const { - if (!hasIndex(row, column, parent)) - return {}; - - if (parent.isValid()) { - WaitTreeItem* parent_item = static_cast(parent.internalPointer()); - parent_item->Expand(); - return createIndex(row, column, parent_item->Children()[row].get()); - } - - return createIndex(row, column, thread_items[row].get()); -} - -QModelIndex WaitTreeModel::parent(const QModelIndex& index) const { - if (!index.isValid()) - return {}; - - WaitTreeItem* parent_item = static_cast(index.internalPointer())->Parent(); - if (!parent_item) { - return QModelIndex(); - } - return createIndex(static_cast(parent_item->Row()), 0, parent_item); -} - -int WaitTreeModel::rowCount(const QModelIndex& parent) const { - if (!parent.isValid()) - return static_cast(thread_items.size()); - - WaitTreeItem* parent_item = static_cast(parent.internalPointer()); - parent_item->Expand(); - return static_cast(parent_item->Children().size()); -} - -int WaitTreeModel::columnCount(const QModelIndex&) const { - return 1; -} - -QVariant WaitTreeModel::data(const QModelIndex& index, int role) const { - if (!index.isValid()) - return {}; - - switch (role) { - case Qt::DisplayRole: - return static_cast(index.internalPointer())->GetText(); - case Qt::ForegroundRole: - return static_cast(index.internalPointer())->GetColor(); - default: - return {}; - } -} - -void WaitTreeModel::ClearItems() { - thread_items.clear(); -} - -void WaitTreeModel::InitItems() { - thread_items = WaitTreeItem::MakeThreadItemList(); -} - -WaitTreeWidget::WaitTreeWidget(QWidget* parent) : QDockWidget(tr("Wait Tree"), parent) { - setObjectName("WaitTreeWidget"); - view = new QTreeView(this); - view->setHeaderHidden(true); - setWidget(view); - setEnabled(false); -} - -void WaitTreeWidget::OnDebugModeEntered() { - if (!Core::System::GetInstance().IsPoweredOn()) - return; - model->InitItems(); - view->setModel(model); - setEnabled(true); -} - -void WaitTreeWidget::OnDebugModeLeft() { - setEnabled(false); - view->setModel(nullptr); - model->ClearItems(); -} - -void WaitTreeWidget::OnEmulationStarting(EmuThread* emu_thread) { - model = new WaitTreeModel(this); - view->setModel(model); - setEnabled(false); -} - -void WaitTreeWidget::OnEmulationStopping() { - view->setModel(nullptr); - delete model; - setEnabled(false); -} diff --git a/src/citra_qt/debugger/wait_tree.h b/src/citra_qt/debugger/wait_tree.h deleted file mode 100644 index 4034e909b..000000000 --- a/src/citra_qt/debugger/wait_tree.h +++ /dev/null @@ -1,187 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include -#include -#include -#include "core/core.h" -#include "core/hle/kernel/kernel.h" - -class EmuThread; - -namespace Kernel { -class WaitObject; -class Event; -class Mutex; -class ConditionVariable; -class Thread; -class Timer; -} - -class WaitTreeThread; - -class WaitTreeItem : public QObject { - Q_OBJECT -public: - virtual bool IsExpandable() const; - virtual std::vector> GetChildren() const; - virtual QString GetText() const = 0; - virtual QColor GetColor() const; - virtual ~WaitTreeItem(); - void Expand(); - WaitTreeItem* Parent() const; - const std::vector>& Children() const; - std::size_t Row() const; - static std::vector> MakeThreadItemList(); - -private: - std::size_t row; - bool expanded = false; - WaitTreeItem* parent = nullptr; - std::vector> children; -}; - -class WaitTreeText : public WaitTreeItem { - Q_OBJECT -public: - explicit WaitTreeText(const QString& text); - QString GetText() const override; - -private: - QString text; -}; - -class WaitTreeExpandableItem : public WaitTreeItem { - Q_OBJECT -public: - bool IsExpandable() const override; -}; - -class WaitTreeWaitObject : public WaitTreeExpandableItem { - Q_OBJECT -public: - explicit WaitTreeWaitObject(const Kernel::WaitObject& object); - static std::unique_ptr make(const Kernel::WaitObject& object); - QString GetText() const override; - std::vector> GetChildren() const override; - -protected: - const Kernel::WaitObject& object; - - static QString GetResetTypeQString(Kernel::ResetType reset_type); -}; - -class WaitTreeObjectList : public WaitTreeExpandableItem { - Q_OBJECT -public: - WaitTreeObjectList(const std::vector>& list, - bool wait_all); - QString GetText() const override; - std::vector> GetChildren() const override; - -private: - const std::vector>& object_list; - bool wait_all; -}; - -class WaitTreeThread : public WaitTreeWaitObject { - Q_OBJECT -public: - explicit WaitTreeThread(const Kernel::Thread& thread); - QString GetText() const override; - QColor GetColor() const override; - std::vector> GetChildren() const override; -}; - -class WaitTreeEvent : public WaitTreeWaitObject { - Q_OBJECT -public: - explicit WaitTreeEvent(const Kernel::Event& object); - std::vector> GetChildren() const override; -}; - -class WaitTreeMutex : public WaitTreeWaitObject { - Q_OBJECT -public: - explicit WaitTreeMutex(const Kernel::Mutex& object); - std::vector> GetChildren() const override; -}; - -class WaitTreeConditionVariable : public WaitTreeWaitObject { - Q_OBJECT -public: - explicit WaitTreeConditionVariable(const Kernel::ConditionVariable& object); - std::vector> GetChildren() const override; -}; - -class WaitTreeTimer : public WaitTreeWaitObject { - Q_OBJECT -public: - explicit WaitTreeTimer(const Kernel::Timer& object); - std::vector> GetChildren() const override; -}; - -class WaitTreeMutexList : public WaitTreeExpandableItem { - Q_OBJECT -public: - explicit WaitTreeMutexList( - const boost::container::flat_set>& list); - - QString GetText() const override; - std::vector> GetChildren() const override; - -private: - const boost::container::flat_set>& mutex_list; -}; - -class WaitTreeThreadList : public WaitTreeExpandableItem { - Q_OBJECT -public: - explicit WaitTreeThreadList(const std::vector>& list); - QString GetText() const override; - std::vector> GetChildren() const override; - -private: - const std::vector>& thread_list; -}; - -class WaitTreeModel : public QAbstractItemModel { - Q_OBJECT - -public: - explicit WaitTreeModel(QObject* parent = nullptr); - - QVariant data(const QModelIndex& index, int role) const override; - QModelIndex index(int row, int column, const QModelIndex& parent) const override; - QModelIndex parent(const QModelIndex& index) const override; - int rowCount(const QModelIndex& parent) const override; - int columnCount(const QModelIndex& parent) const override; - - void ClearItems(); - void InitItems(); - -private: - std::vector> thread_items; -}; - -class WaitTreeWidget : public QDockWidget { - Q_OBJECT - -public: - explicit WaitTreeWidget(QWidget* parent = nullptr); - -public slots: - void OnDebugModeEntered(); - void OnDebugModeLeft(); - - void OnEmulationStarting(EmuThread* emu_thread); - void OnEmulationStopping(); - -private: - QTreeView* view; - WaitTreeModel* model; -}; diff --git a/src/citra_qt/game_list.cpp b/src/citra_qt/game_list.cpp deleted file mode 100644 index a8e3541cd..000000000 --- a/src/citra_qt/game_list.cpp +++ /dev/null @@ -1,422 +0,0 @@ -// Copyright 2015 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#include -#include -#include -#include -#include -#include -#include "common/common_paths.h" -#include "common/logging/log.h" -#include "common/string_util.h" -#include "core/loader/loader.h" -#include "game_list.h" -#include "game_list_p.h" -#include "ui_settings.h" - -GameList::SearchField::KeyReleaseEater::KeyReleaseEater(GameList* gamelist) { - this->gamelist = gamelist; - edit_filter_text_old = ""; -} - -// EventFilter in order to process systemkeys while editing the searchfield -bool GameList::SearchField::KeyReleaseEater::eventFilter(QObject* obj, QEvent* event) { - // If it isn't a KeyRelease event then continue with standard event processing - if (event->type() != QEvent::KeyRelease) - return QObject::eventFilter(obj, event); - - QKeyEvent* keyEvent = static_cast(event); - int rowCount = gamelist->tree_view->model()->rowCount(); - QString edit_filter_text = gamelist->search_field->edit_filter->text().toLower(); - - // If the searchfield's text hasn't changed special function keys get checked - // If no function key changes the searchfield's text the filter doesn't need to get reloaded - if (edit_filter_text == edit_filter_text_old) { - switch (keyEvent->key()) { - // Escape: Resets the searchfield - case Qt::Key_Escape: { - if (edit_filter_text_old.isEmpty()) { - return QObject::eventFilter(obj, event); - } else { - gamelist->search_field->edit_filter->clear(); - edit_filter_text = ""; - } - break; - } - // Return and Enter - // If the enter key gets pressed first checks how many and which entry is visible - // If there is only one result launch this game - case Qt::Key_Return: - case Qt::Key_Enter: { - QStandardItemModel* item_model = new QStandardItemModel(gamelist->tree_view); - QModelIndex root_index = item_model->invisibleRootItem()->index(); - QStandardItem* child_file; - QString file_path; - int resultCount = 0; - for (int i = 0; i < rowCount; ++i) { - if (!gamelist->tree_view->isRowHidden(i, root_index)) { - ++resultCount; - child_file = gamelist->item_model->item(i, 0); - file_path = child_file->data(GameListItemPath::FullPathRole).toString(); - } - } - if (resultCount == 1) { - // To avoid loading error dialog loops while confirming them using enter - // Also users usually want to run a diffrent game after closing one - gamelist->search_field->edit_filter->setText(""); - edit_filter_text = ""; - emit gamelist->GameChosen(file_path); - } else { - return QObject::eventFilter(obj, event); - } - break; - } - default: - return QObject::eventFilter(obj, event); - } - } - edit_filter_text_old = edit_filter_text; - return QObject::eventFilter(obj, event); -} - -void GameList::SearchField::setFilterResult(int visible, int total) { - QString result_of_text = tr("of"); - QString result_text; - if (total == 1) { - result_text = tr("result"); - } else { - result_text = tr("results"); - } - label_filter_result->setText( - QString("%1 %2 %3 %4").arg(visible).arg(result_of_text).arg(total).arg(result_text)); -} - -void GameList::SearchField::clear() { - edit_filter->setText(""); -} - -void GameList::SearchField::setFocus() { - if (edit_filter->isVisible()) { - edit_filter->setFocus(); - } -} - -GameList::SearchField::SearchField(GameList* parent) : QWidget{parent} { - KeyReleaseEater* keyReleaseEater = new KeyReleaseEater(parent); - layout_filter = new QHBoxLayout; - layout_filter->setMargin(8); - label_filter = new QLabel; - label_filter->setText(tr("Filter:")); - edit_filter = new QLineEdit; - edit_filter->setText(""); - edit_filter->setPlaceholderText(tr("Enter pattern to filter")); - edit_filter->installEventFilter(keyReleaseEater); - edit_filter->setClearButtonEnabled(true); - connect(edit_filter, SIGNAL(textChanged(const QString&)), parent, - SLOT(onTextChanged(const QString&))); - label_filter_result = new QLabel; - button_filter_close = new QToolButton(this); - button_filter_close->setText("X"); - button_filter_close->setCursor(Qt::ArrowCursor); - button_filter_close->setStyleSheet("QToolButton{ border: none; padding: 0px; color: " - "#000000; font-weight: bold; background: #F0F0F0; }" - "QToolButton:hover{ border: none; padding: 0px; color: " - "#EEEEEE; font-weight: bold; background: #E81123}"); - connect(button_filter_close, SIGNAL(clicked()), parent, SLOT(onFilterCloseClicked())); - layout_filter->setSpacing(10); - layout_filter->addWidget(label_filter); - layout_filter->addWidget(edit_filter); - layout_filter->addWidget(label_filter_result); - layout_filter->addWidget(button_filter_close); - setLayout(layout_filter); -} - -/** - * Checks if all words separated by spaces are contained in another string - * This offers a word order insensitive search function - * - * @param String that gets checked if it contains all words of the userinput string - * @param String containing all words getting checked - * @return true if the haystack contains all words of userinput - */ -bool GameList::containsAllWords(QString haystack, QString userinput) { - QStringList userinput_split = userinput.split(" ", QString::SplitBehavior::SkipEmptyParts); - return std::all_of(userinput_split.begin(), userinput_split.end(), - [haystack](QString s) { return haystack.contains(s); }); -} - -// Event in order to filter the gamelist after editing the searchfield -void GameList::onTextChanged(const QString& newText) { - int rowCount = tree_view->model()->rowCount(); - QString edit_filter_text = newText.toLower(); - - QModelIndex root_index = item_model->invisibleRootItem()->index(); - - // If the searchfield is empty every item is visible - // Otherwise the filter gets applied - if (edit_filter_text.isEmpty()) { - for (int i = 0; i < rowCount; ++i) { - tree_view->setRowHidden(i, root_index, false); - } - search_field->setFilterResult(rowCount, rowCount); - } else { - QStandardItem* child_file; - QString file_path, file_name, file_title, file_programmid; - int result_count = 0; - for (int i = 0; i < rowCount; ++i) { - child_file = item_model->item(i, 0); - file_path = child_file->data(GameListItemPath::FullPathRole).toString().toLower(); - file_name = file_path.mid(file_path.lastIndexOf("/") + 1); - file_title = child_file->data(GameListItemPath::TitleRole).toString().toLower(); - file_programmid = - child_file->data(GameListItemPath::ProgramIdRole).toString().toLower(); - - // Only items which filename in combination with its title contains all words - // that are in the searchfiel will be visible in the gamelist - // The search is case insensitive because of toLower() - // I decided not to use Qt::CaseInsensitive in containsAllWords to prevent - // multiple conversions of edit_filter_text for each game in the gamelist - if (containsAllWords(file_name.append(" ").append(file_title), edit_filter_text) || - (file_programmid.count() == 16 && edit_filter_text.contains(file_programmid))) { - tree_view->setRowHidden(i, root_index, false); - ++result_count; - } else { - tree_view->setRowHidden(i, root_index, true); - } - search_field->setFilterResult(result_count, rowCount); - } - } -} - -void GameList::onFilterCloseClicked() { - main_window->filterBarSetChecked(false); -} - -GameList::GameList(GMainWindow* parent) : QWidget{parent} { - watcher = new QFileSystemWatcher(this); - connect(watcher, &QFileSystemWatcher::directoryChanged, this, &GameList::RefreshGameDirectory); - - this->main_window = parent; - layout = new QVBoxLayout; - tree_view = new QTreeView; - search_field = new SearchField(this); - item_model = new QStandardItemModel(tree_view); - tree_view->setModel(item_model); - - tree_view->setAlternatingRowColors(true); - tree_view->setSelectionMode(QHeaderView::SingleSelection); - tree_view->setSelectionBehavior(QHeaderView::SelectRows); - tree_view->setVerticalScrollMode(QHeaderView::ScrollPerPixel); - tree_view->setHorizontalScrollMode(QHeaderView::ScrollPerPixel); - tree_view->setSortingEnabled(true); - tree_view->setEditTriggers(QHeaderView::NoEditTriggers); - tree_view->setUniformRowHeights(true); - tree_view->setContextMenuPolicy(Qt::CustomContextMenu); - - item_model->insertColumns(0, COLUMN_COUNT); - item_model->setHeaderData(COLUMN_NAME, Qt::Horizontal, "Name"); - item_model->setHeaderData(COLUMN_FILE_TYPE, Qt::Horizontal, "File type"); - item_model->setHeaderData(COLUMN_SIZE, Qt::Horizontal, "Size"); - - connect(tree_view, &QTreeView::activated, this, &GameList::ValidateEntry); - connect(tree_view, &QTreeView::customContextMenuRequested, this, &GameList::PopupContextMenu); - - // We must register all custom types with the Qt Automoc system so that we are able to use it - // with signals/slots. In this case, QList falls under the umbrells of custom types. - qRegisterMetaType>("QList"); - - layout->setContentsMargins(0, 0, 0, 0); - layout->setSpacing(0); - layout->addWidget(tree_view); - layout->addWidget(search_field); - setLayout(layout); -} - -GameList::~GameList() { - emit ShouldCancelWorker(); -} - -void GameList::setFilterFocus() { - if (tree_view->model()->rowCount() > 0) { - search_field->setFocus(); - } -} - -void GameList::setFilterVisible(bool visibility) { - search_field->setVisible(visibility); -} - -void GameList::clearFilter() { - search_field->clear(); -} - -void GameList::AddEntry(const QList& entry_items) { - item_model->invisibleRootItem()->appendRow(entry_items); -} - -void GameList::ValidateEntry(const QModelIndex& item) { - // We don't care about the individual QStandardItem that was selected, but its row. - int row = item_model->itemFromIndex(item)->row(); - QStandardItem* child_file = item_model->invisibleRootItem()->child(row, COLUMN_NAME); - QString file_path = child_file->data(GameListItemPath::FullPathRole).toString(); - - if (file_path.isEmpty()) - return; - std::string std_file_path(file_path.toStdString()); - if (!FileUtil::Exists(std_file_path) || FileUtil::IsDirectory(std_file_path)) - return; - // Users usually want to run a diffrent game after closing one - search_field->clear(); - emit GameChosen(file_path); -} - -void GameList::DonePopulating(QStringList watch_list) { - // Clear out the old directories to watch for changes and add the new ones - auto watch_dirs = watcher->directories(); - if (!watch_dirs.isEmpty()) { - watcher->removePaths(watch_dirs); - } - // Workaround: Add the watch paths in chunks to allow the gui to refresh - // This prevents the UI from stalling when a large number of watch paths are added - // Also artificially caps the watcher to a certain number of directories - constexpr int LIMIT_WATCH_DIRECTORIES = 5000; - constexpr int SLICE_SIZE = 25; - int len = std::min(watch_list.length(), LIMIT_WATCH_DIRECTORIES); - for (int i = 0; i < len; i += SLICE_SIZE) { - watcher->addPaths(watch_list.mid(i, i + SLICE_SIZE)); - QCoreApplication::processEvents(); - } - tree_view->setEnabled(true); - int rowCount = tree_view->model()->rowCount(); - search_field->setFilterResult(rowCount, rowCount); - if (rowCount > 0) { - search_field->setFocus(); - } -} - -void GameList::PopupContextMenu(const QPoint& menu_location) { - QModelIndex item = tree_view->indexAt(menu_location); - if (!item.isValid()) - return; - - int row = item_model->itemFromIndex(item)->row(); - QStandardItem* child_file = item_model->invisibleRootItem()->child(row, COLUMN_NAME); - u64 program_id = child_file->data(GameListItemPath::ProgramIdRole).toULongLong(); - - QMenu context_menu; - QAction* open_save_location = context_menu.addAction(tr("Open Save Data Location")); - open_save_location->setEnabled(program_id != 0); - connect(open_save_location, &QAction::triggered, - [&]() { emit OpenSaveFolderRequested(program_id); }); - context_menu.exec(tree_view->viewport()->mapToGlobal(menu_location)); -} - -void GameList::PopulateAsync(const QString& dir_path, bool deep_scan) { - if (!FileUtil::Exists(dir_path.toStdString()) || - !FileUtil::IsDirectory(dir_path.toStdString())) { - LOG_ERROR(Frontend, "Could not find game list folder at %s", dir_path.toLocal8Bit().data()); - search_field->setFilterResult(0, 0); - return; - } - - tree_view->setEnabled(false); - // Delete any rows that might already exist if we're repopulating - item_model->removeRows(0, item_model->rowCount()); - - emit ShouldCancelWorker(); - - GameListWorker* worker = new GameListWorker(dir_path, deep_scan); - - connect(worker, &GameListWorker::EntryReady, this, &GameList::AddEntry, Qt::QueuedConnection); - connect(worker, &GameListWorker::Finished, this, &GameList::DonePopulating, - Qt::QueuedConnection); - // Use DirectConnection here because worker->Cancel() is thread-safe and we want it to cancel - // without delay. - connect(this, &GameList::ShouldCancelWorker, worker, &GameListWorker::Cancel, - Qt::DirectConnection); - - QThreadPool::globalInstance()->start(worker); - current_worker = std::move(worker); -} - -void GameList::SaveInterfaceLayout() { - UISettings::values.gamelist_header_state = tree_view->header()->saveState(); -} - -void GameList::LoadInterfaceLayout() { - auto header = tree_view->header(); - if (!header->restoreState(UISettings::values.gamelist_header_state)) { - // We are using the name column to display icons and titles - // so make it as large as possible as default. - header->resizeSection(COLUMN_NAME, header->width()); - } - - item_model->sort(header->sortIndicatorSection(), header->sortIndicatorOrder()); -} - -const QStringList GameList::supported_file_extensions = {"3ds", "3dsx", "elf", "axf", - "cci", "cxi", "app"}; - -static bool HasSupportedFileExtension(const std::string& file_name) { - QFileInfo file = QFileInfo(file_name.c_str()); - return GameList::supported_file_extensions.contains(file.suffix(), Qt::CaseInsensitive); -} - -void GameList::RefreshGameDirectory() { - if (!UISettings::values.gamedir.isEmpty() && current_worker != nullptr) { - LOG_INFO(Frontend, "Change detected in the games directory. Reloading game list."); - search_field->clear(); - PopulateAsync(UISettings::values.gamedir, UISettings::values.gamedir_deepscan); - } -} - -void GameListWorker::AddFstEntriesToGameList(const std::string& dir_path, unsigned int recursion) { - const auto callback = [this, recursion](unsigned* num_entries_out, const std::string& directory, - const std::string& virtual_name) -> bool { - std::string physical_name = directory + DIR_SEP + virtual_name; - - if (stop_processing) - return false; // Breaks the callback loop. - - bool is_dir = FileUtil::IsDirectory(physical_name); - if (!is_dir && HasSupportedFileExtension(physical_name)) { - std::unique_ptr loader = Loader::GetLoader(physical_name); - if (!loader) - return true; - - std::vector smdh; - loader->ReadIcon(smdh); - - u64 program_id = 0; - loader->ReadProgramId(program_id); - - emit EntryReady({ - new GameListItemPath(QString::fromStdString(physical_name), smdh, program_id), - new GameListItem( - QString::fromStdString(Loader::GetFileTypeString(loader->GetFileType()))), - new GameListItemSize(FileUtil::GetSize(physical_name)), - }); - } else if (is_dir && recursion > 0) { - watch_list.append(QString::fromStdString(physical_name)); - AddFstEntriesToGameList(physical_name, recursion - 1); - } - - return true; - }; - - FileUtil::ForeachDirectoryEntry(nullptr, dir_path, callback); -} - -void GameListWorker::run() { - stop_processing = false; - watch_list.append(dir_path); - AddFstEntriesToGameList(dir_path.toStdString(), deep_scan ? 256 : 0); - emit Finished(watch_list); -} - -void GameListWorker::Cancel() { - this->disconnect(); - stop_processing = true; -} diff --git a/src/citra_qt/game_list.h b/src/citra_qt/game_list.h deleted file mode 100644 index 4823a1296..000000000 --- a/src/citra_qt/game_list.h +++ /dev/null @@ -1,101 +0,0 @@ -// Copyright 2015 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include "main.h" - -class GameListWorker; - -class GameList : public QWidget { - Q_OBJECT - -public: - enum { - COLUMN_NAME, - COLUMN_FILE_TYPE, - COLUMN_SIZE, - COLUMN_COUNT, // Number of columns - }; - - class SearchField : public QWidget { - public: - void setFilterResult(int visible, int total); - void clear(); - void setFocus(); - explicit SearchField(GameList* parent = nullptr); - - private: - class KeyReleaseEater : public QObject { - public: - explicit KeyReleaseEater(GameList* gamelist); - - private: - GameList* gamelist = nullptr; - QString edit_filter_text_old; - - protected: - bool eventFilter(QObject* obj, QEvent* event); - }; - QHBoxLayout* layout_filter = nullptr; - QTreeView* tree_view = nullptr; - QLabel* label_filter = nullptr; - QLineEdit* edit_filter = nullptr; - QLabel* label_filter_result = nullptr; - QToolButton* button_filter_close = nullptr; - }; - - explicit GameList(GMainWindow* parent = nullptr); - ~GameList() override; - - void clearFilter(); - void setFilterFocus(); - void setFilterVisible(bool visibility); - - void PopulateAsync(const QString& dir_path, bool deep_scan); - - void SaveInterfaceLayout(); - void LoadInterfaceLayout(); - - static const QStringList supported_file_extensions; - -signals: - void GameChosen(QString game_path); - void ShouldCancelWorker(); - void OpenSaveFolderRequested(u64 program_id); - -private slots: - void onTextChanged(const QString& newText); - void onFilterCloseClicked(); - -private: - void AddEntry(const QList& entry_items); - void ValidateEntry(const QModelIndex& item); - void DonePopulating(QStringList watch_list); - - void PopupContextMenu(const QPoint& menu_location); - void RefreshGameDirectory(); - bool containsAllWords(QString haystack, QString userinput); - - SearchField* search_field; - GMainWindow* main_window = nullptr; - QVBoxLayout* layout = nullptr; - QTreeView* tree_view = nullptr; - QStandardItemModel* item_model = nullptr; - GameListWorker* current_worker = nullptr; - QFileSystemWatcher* watcher = nullptr; -}; diff --git a/src/citra_qt/game_list_p.h b/src/citra_qt/game_list_p.h deleted file mode 100644 index 9881296d9..000000000 --- a/src/citra_qt/game_list_p.h +++ /dev/null @@ -1,143 +0,0 @@ -// Copyright 2015 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include -#include -#include -#include -#include "citra_qt/util/util.h" -#include "common/string_util.h" - -/** - * Gets the default icon (for games without valid SMDH) - * @param large If true, returns large icon (48x48), otherwise returns small icon (24x24) - * @return QPixmap default icon - */ -static QPixmap GetDefaultIcon(bool large) { - int size = large ? 48 : 24; - QPixmap icon(size, size); - icon.fill(Qt::transparent); - return icon; -} - -class GameListItem : public QStandardItem { - -public: - GameListItem() : QStandardItem() {} - GameListItem(const QString& string) : QStandardItem(string) {} - virtual ~GameListItem() override {} -}; - -/** - * A specialization of GameListItem for path values. - * This class ensures that for every full path value it holds, a correct string representation - * of just the filename (with no extension) will be displayed to the user. - * If this class receives valid SMDH data, it will also display game icons and titles. - */ -class GameListItemPath : public GameListItem { - -public: - static const int FullPathRole = Qt::UserRole + 1; - static const int TitleRole = Qt::UserRole + 2; - static const int ProgramIdRole = Qt::UserRole + 3; - - GameListItemPath() : GameListItem() {} - GameListItemPath(const QString& game_path, const std::vector& smdh_data, u64 program_id) - : GameListItem() { - setData(game_path, FullPathRole); - setData(qulonglong(program_id), ProgramIdRole); - } - - QVariant data(int role) const override { - if (role == Qt::DisplayRole) { - std::string filename; - Common::SplitPath(data(FullPathRole).toString().toStdString(), nullptr, &filename, - nullptr); - QString title = data(TitleRole).toString(); - return QString::fromStdString(filename) + (title.isEmpty() ? "" : "\n " + title); - } else { - return GameListItem::data(role); - } - } -}; - -/** - * A specialization of GameListItem for size values. - * This class ensures that for every numerical size value it holds (in bytes), a correct - * human-readable string representation will be displayed to the user. - */ -class GameListItemSize : public GameListItem { - -public: - static const int SizeRole = Qt::UserRole + 1; - - GameListItemSize() : GameListItem() {} - GameListItemSize(const qulonglong size_bytes) : GameListItem() { - setData(size_bytes, SizeRole); - } - - void setData(const QVariant& value, int role) override { - // By specializing setData for SizeRole, we can ensure that the numerical and string - // representations of the data are always accurate and in the correct format. - if (role == SizeRole) { - qulonglong size_bytes = value.toULongLong(); - GameListItem::setData(ReadableByteSize(size_bytes), Qt::DisplayRole); - GameListItem::setData(value, SizeRole); - } else { - GameListItem::setData(value, role); - } - } - - /** - * This operator is, in practice, only used by the TreeView sorting systems. - * Override it so that it will correctly sort by numerical value instead of by string - * representation. - */ - bool operator<(const QStandardItem& other) const override { - return data(SizeRole).toULongLong() < other.data(SizeRole).toULongLong(); - } -}; - -/** - * Asynchronous worker object for populating the game list. - * Communicates with other threads through Qt's signal/slot system. - */ -class GameListWorker : public QObject, public QRunnable { - Q_OBJECT - -public: - GameListWorker(QString dir_path, bool deep_scan) - : QObject(), QRunnable(), dir_path(dir_path), deep_scan(deep_scan) {} - -public slots: - /// Starts the processing of directory tree information. - void run() override; - /// Tells the worker that it should no longer continue processing. Thread-safe. - void Cancel(); - -signals: - /** - * The `EntryReady` signal is emitted once an entry has been prepared and is ready - * to be added to the game list. - * @param entry_items a list with `QStandardItem`s that make up the columns of the new entry. - */ - void EntryReady(QList entry_items); - - /** - * After the worker has traversed the game directory looking for entries, this signal is emmited - * with a list of folders that should be watched for changes as well. - */ - void Finished(QStringList watch_list); - -private: - QStringList watch_list; - QString dir_path; - bool deep_scan; - std::atomic_bool stop_processing; - - void AddFstEntriesToGameList(const std::string& dir_path, unsigned int recursion = 0); -}; diff --git a/src/citra_qt/hotkeys.cpp b/src/citra_qt/hotkeys.cpp deleted file mode 100644 index 158ed506f..000000000 --- a/src/citra_qt/hotkeys.cpp +++ /dev/null @@ -1,90 +0,0 @@ -// Copyright 2014 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#include -#include -#include -#include -#include "citra_qt/hotkeys.h" -#include "citra_qt/ui_settings.h" - -struct Hotkey { - Hotkey() : shortcut(nullptr), context(Qt::WindowShortcut) {} - - QKeySequence keyseq; - QShortcut* shortcut; - Qt::ShortcutContext context; -}; - -typedef std::map HotkeyMap; -typedef std::map HotkeyGroupMap; - -HotkeyGroupMap hotkey_groups; - -void SaveHotkeys() { - UISettings::values.shortcuts.clear(); - for (auto group : hotkey_groups) { - for (auto hotkey : group.second) { - UISettings::values.shortcuts.emplace_back( - UISettings::Shortcut(group.first + "/" + hotkey.first, - UISettings::ContextualShortcut(hotkey.second.keyseq.toString(), - hotkey.second.context))); - } - } -} - -void LoadHotkeys() { - // Make sure NOT to use a reference here because it would become invalid once we call - // beginGroup() - for (auto shortcut : UISettings::values.shortcuts) { - QStringList cat = shortcut.first.split("/"); - Q_ASSERT(cat.size() >= 2); - - // RegisterHotkey assigns default keybindings, so use old values as default parameters - Hotkey& hk = hotkey_groups[cat[0]][cat[1]]; - if (!shortcut.second.first.isEmpty()) { - hk.keyseq = QKeySequence::fromString(shortcut.second.first); - hk.context = (Qt::ShortcutContext)shortcut.second.second; - } - if (hk.shortcut) - hk.shortcut->setKey(hk.keyseq); - } -} - -void RegisterHotkey(const QString& group, const QString& action, const QKeySequence& default_keyseq, - Qt::ShortcutContext default_context) { - if (hotkey_groups[group].find(action) == hotkey_groups[group].end()) { - hotkey_groups[group][action].keyseq = default_keyseq; - hotkey_groups[group][action].context = default_context; - } -} - -QShortcut* GetHotkey(const QString& group, const QString& action, QWidget* widget) { - Hotkey& hk = hotkey_groups[group][action]; - - if (!hk.shortcut) - hk.shortcut = new QShortcut(hk.keyseq, widget, nullptr, nullptr, hk.context); - - return hk.shortcut; -} - -GHotkeysDialog::GHotkeysDialog(QWidget* parent) : QWidget(parent) { - ui.setupUi(this); - - for (auto group : hotkey_groups) { - QTreeWidgetItem* toplevel_item = new QTreeWidgetItem(QStringList(group.first)); - for (auto hotkey : group.second) { - QStringList columns; - columns << hotkey.first << hotkey.second.keyseq.toString(); - QTreeWidgetItem* item = new QTreeWidgetItem(columns); - toplevel_item->addChild(item); - } - ui.treeWidget->addTopLevelItem(toplevel_item); - } - // TODO: Make context configurable as well (hiding the column for now) - ui.treeWidget->setColumnCount(2); - - ui.treeWidget->resizeColumnToContents(0); - ui.treeWidget->resizeColumnToContents(1); -} diff --git a/src/citra_qt/hotkeys.h b/src/citra_qt/hotkeys.h deleted file mode 100644 index a4ccc193b..000000000 --- a/src/citra_qt/hotkeys.h +++ /dev/null @@ -1,64 +0,0 @@ -// Copyright 2014 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include "ui_hotkeys.h" - -class QDialog; -class QKeySequence; -class QSettings; -class QShortcut; - -/** - * Register a hotkey. - * - * @param group General group this hotkey belongs to (e.g. "Main Window", "Debugger") - * @param action Name of the action (e.g. "Start Emulation", "Load Image") - * @param default_keyseq Default key sequence to assign if the hotkey wasn't present in the settings - * file before - * @param default_context Default context to assign if the hotkey wasn't present in the settings - * file before - * @warning Both the group and action strings will be displayed in the hotkey settings dialog - */ -void RegisterHotkey(const QString& group, const QString& action, - const QKeySequence& default_keyseq = QKeySequence(), - Qt::ShortcutContext default_context = Qt::WindowShortcut); - -/** - * Returns a QShortcut object whose activated() signal can be connected to other QObjects' slots. - * - * @param group General group this hotkey belongs to (e.g. "Main Window", "Debugger"). - * @param action Name of the action (e.g. "Start Emulation", "Load Image"). - * @param widget Parent widget of the returned QShortcut. - * @warning If multiple QWidgets' call this function for the same action, the returned QShortcut - * will be the same. Thus, you shouldn't rely on the caller really being the QShortcut's parent. - */ -QShortcut* GetHotkey(const QString& group, const QString& action, QWidget* widget); - -/** - * Saves all registered hotkeys to the settings file. - * - * @note Each hotkey group will be stored a settings group; For each hotkey inside that group, a - * settings group will be created to store the key sequence and the hotkey context. - */ -void SaveHotkeys(); - -/** - * Loads hotkeys from the settings file. - * - * @note Yet unregistered hotkeys which are present in the settings will automatically be - * registered. - */ -void LoadHotkeys(); - -class GHotkeysDialog : public QWidget { - Q_OBJECT - -public: - explicit GHotkeysDialog(QWidget* parent = nullptr); - -private: - Ui::hotkeys ui; -}; diff --git a/src/citra_qt/hotkeys.ui b/src/citra_qt/hotkeys.ui deleted file mode 100644 index 050fe064e..000000000 --- a/src/citra_qt/hotkeys.ui +++ /dev/null @@ -1,46 +0,0 @@ - - - hotkeys - - - - 0 - 0 - 363 - 388 - - - - Hotkey Settings - - - - - - QAbstractItemView::SelectItems - - - false - - - - Action - - - - - Hotkey - - - - - Context - - - - - - - - - diff --git a/src/citra_qt/main.cpp b/src/citra_qt/main.cpp deleted file mode 100644 index 943aee30d..000000000 --- a/src/citra_qt/main.cpp +++ /dev/null @@ -1,877 +0,0 @@ -// Copyright 2014 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#include -#include -#include -#include -#include -#define QT_NO_OPENGL -#include -#include -#include -#include -#include -#include "citra_qt/bootmanager.h" -#include "citra_qt/configuration/config.h" -#include "citra_qt/configuration/configure_dialog.h" -#include "citra_qt/debugger/graphics/graphics.h" -#include "citra_qt/debugger/graphics/graphics_breakpoints.h" -#include "citra_qt/debugger/graphics/graphics_cmdlists.h" -#include "citra_qt/debugger/graphics/graphics_surface.h" -#include "citra_qt/debugger/graphics/graphics_tracing.h" -#include "citra_qt/debugger/graphics/graphics_vertex_shader.h" -#include "citra_qt/debugger/profiler.h" -#include "citra_qt/debugger/registers.h" -#include "citra_qt/debugger/wait_tree.h" -#include "citra_qt/game_list.h" -#include "citra_qt/hotkeys.h" -#include "citra_qt/main.h" -#include "citra_qt/ui_settings.h" -#include "common/logging/backend.h" -#include "common/logging/filter.h" -#include "common/logging/log.h" -#include "common/logging/text_formatter.h" -#include "common/microprofile.h" -#include "common/platform.h" -#include "common/scm_rev.h" -#include "common/scope_exit.h" -#include "common/string_util.h" -#include "core/core.h" -#include "core/gdbstub/gdbstub.h" -#include "core/loader/loader.h" -#include "core/settings.h" - -#ifdef QT_STATICPLUGIN -Q_IMPORT_PLUGIN(QWindowsIntegrationPlugin); -#endif - -/** - * "Callouts" are one-time instructional messages shown to the user. In the config settings, there - * is a bitfield "callout_flags" options, used to track if a message has already been shown to the - * user. This is 32-bits - if we have more than 32 callouts, we should retire and recyle old ones. - */ -enum class CalloutFlag : uint32_t { - Telemetry = 0x1, -}; - -static void ShowCalloutMessage(const QString& message, CalloutFlag flag) { - if (UISettings::values.callout_flags & static_cast(flag)) { - return; - } - - UISettings::values.callout_flags |= static_cast(flag); - - QMessageBox msg; - msg.setText(message); - msg.setStandardButtons(QMessageBox::Ok); - msg.setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding); - msg.setStyleSheet("QLabel{min-width: 900px;}"); - msg.exec(); -} - -void GMainWindow::ShowCallouts() { - static const QString telemetry_message = - tr("To help improve Citra, the Citra Team collects anonymous usage data. No private or " - "personally identifying information is collected. This data helps us to understand how " - "people use Citra and prioritize our efforts. Furthermore, it helps us to more easily " - "identify emulation bugs and performance issues. This data includes:
  • Information" - " about the version of Citra you are using
  • Performance data about the games you " - "play
  • Your configuration settings
  • Information about your computer " - "hardware
  • Emulation errors and crash information
By default, this " - "feature is enabled. To disable this feature, click 'Emulation' from the menu and then " - "select 'Configure...'. Then, on the 'Web' tab, uncheck 'Share anonymous usage data with" - " the Citra team'.

By using this software, you agree to the above terms.
" - "
Learn " - "more"); - ShowCalloutMessage(telemetry_message, CalloutFlag::Telemetry); -} - -GMainWindow::GMainWindow() : config(new Config()), emu_thread(nullptr) { - Pica::g_debug_context = Pica::DebugContext::Construct(); - setAcceptDrops(true); - ui.setupUi(this); - statusBar()->hide(); - - InitializeWidgets(); - InitializeDebugWidgets(); - InitializeRecentFileMenuActions(); - InitializeHotkeys(); - - SetDefaultUIGeometry(); - RestoreUIState(); - - ConnectMenuEvents(); - ConnectWidgetEvents(); - - setWindowTitle(QString("Citra %1| %2-%3") - .arg(Common::g_build_name, Common::g_scm_branch, Common::g_scm_desc)); - show(); - - game_list->PopulateAsync(UISettings::values.gamedir, UISettings::values.gamedir_deepscan); - - UpdateUITheme(); - - // Show one-time "callout" messages to the user - ShowCallouts(); - - QStringList args = QApplication::arguments(); - if (args.length() >= 2) { - BootGame(args[1]); - } -} - -GMainWindow::~GMainWindow() { - // will get automatically deleted otherwise - if (render_window->parent() == nullptr) - delete render_window; - - Pica::g_debug_context.reset(); -} - -void GMainWindow::InitializeWidgets() { - render_window = new GRenderWindow(this, emu_thread.get()); - render_window->hide(); - - game_list = new GameList(this); - ui.horizontalLayout->addWidget(game_list); - - // Create status bar - message_label = new QLabel(); - // Configured separately for left alignment - message_label->setVisible(false); - message_label->setFrameStyle(QFrame::NoFrame); - message_label->setContentsMargins(4, 0, 4, 0); - message_label->setAlignment(Qt::AlignLeft); - statusBar()->addPermanentWidget(message_label, 1); - - emu_speed_label = new QLabel(); - emu_speed_label->setToolTip(tr("Current emulation speed. Values higher or lower than 100% " - "indicate emulation is running faster or slower than a 3DS.")); - game_fps_label = new QLabel(); - game_fps_label->setToolTip(tr("How many frames per second the game is currently displaying. " - "This will vary from game to game and scene to scene.")); - emu_frametime_label = new QLabel(); - emu_frametime_label->setToolTip( - tr("Time taken to emulate a 3DS frame, not counting framelimiting or v-sync. For " - "full-speed emulation this should be at most 16.67 ms.")); - - for (auto& label : {emu_speed_label, game_fps_label, emu_frametime_label}) { - label->setVisible(false); - label->setFrameStyle(QFrame::NoFrame); - label->setContentsMargins(4, 0, 4, 0); - statusBar()->addPermanentWidget(label, 0); - } - statusBar()->setVisible(true); - setStyleSheet("QStatusBar::item{border: none;}"); -} - -void GMainWindow::InitializeDebugWidgets() { - connect(ui.action_Create_Pica_Surface_Viewer, &QAction::triggered, this, - &GMainWindow::OnCreateGraphicsSurfaceViewer); - - QMenu* debug_menu = ui.menu_View_Debugging; - -#if MICROPROFILE_ENABLED - microProfileDialog = new MicroProfileDialog(this); - microProfileDialog->hide(); - debug_menu->addAction(microProfileDialog->toggleViewAction()); -#endif - - registersWidget = new RegistersWidget(this); - addDockWidget(Qt::RightDockWidgetArea, registersWidget); - registersWidget->hide(); - debug_menu->addAction(registersWidget->toggleViewAction()); - connect(this, &GMainWindow::EmulationStarting, registersWidget, - &RegistersWidget::OnEmulationStarting); - connect(this, &GMainWindow::EmulationStopping, registersWidget, - &RegistersWidget::OnEmulationStopping); - - graphicsWidget = new GPUCommandStreamWidget(this); - addDockWidget(Qt::RightDockWidgetArea, graphicsWidget); - graphicsWidget->hide(); - debug_menu->addAction(graphicsWidget->toggleViewAction()); - - graphicsCommandsWidget = new GPUCommandListWidget(this); - addDockWidget(Qt::RightDockWidgetArea, graphicsCommandsWidget); - graphicsCommandsWidget->hide(); - debug_menu->addAction(graphicsCommandsWidget->toggleViewAction()); - - graphicsBreakpointsWidget = new GraphicsBreakPointsWidget(Pica::g_debug_context, this); - addDockWidget(Qt::RightDockWidgetArea, graphicsBreakpointsWidget); - graphicsBreakpointsWidget->hide(); - debug_menu->addAction(graphicsBreakpointsWidget->toggleViewAction()); - - graphicsVertexShaderWidget = new GraphicsVertexShaderWidget(Pica::g_debug_context, this); - addDockWidget(Qt::RightDockWidgetArea, graphicsVertexShaderWidget); - graphicsVertexShaderWidget->hide(); - debug_menu->addAction(graphicsVertexShaderWidget->toggleViewAction()); - - graphicsTracingWidget = new GraphicsTracingWidget(Pica::g_debug_context, this); - addDockWidget(Qt::RightDockWidgetArea, graphicsTracingWidget); - graphicsTracingWidget->hide(); - debug_menu->addAction(graphicsTracingWidget->toggleViewAction()); - connect(this, &GMainWindow::EmulationStarting, graphicsTracingWidget, - &GraphicsTracingWidget::OnEmulationStarting); - connect(this, &GMainWindow::EmulationStopping, graphicsTracingWidget, - &GraphicsTracingWidget::OnEmulationStopping); - - waitTreeWidget = new WaitTreeWidget(this); - addDockWidget(Qt::LeftDockWidgetArea, waitTreeWidget); - waitTreeWidget->hide(); - debug_menu->addAction(waitTreeWidget->toggleViewAction()); - connect(this, &GMainWindow::EmulationStarting, waitTreeWidget, - &WaitTreeWidget::OnEmulationStarting); - connect(this, &GMainWindow::EmulationStopping, waitTreeWidget, - &WaitTreeWidget::OnEmulationStopping); -} - -void GMainWindow::InitializeRecentFileMenuActions() { - for (int i = 0; i < max_recent_files_item; ++i) { - actions_recent_files[i] = new QAction(this); - actions_recent_files[i]->setVisible(false); - connect(actions_recent_files[i], SIGNAL(triggered()), this, SLOT(OnMenuRecentFile())); - - ui.menu_recent_files->addAction(actions_recent_files[i]); - } - - UpdateRecentFiles(); -} - -void GMainWindow::InitializeHotkeys() { - RegisterHotkey("Main Window", "Load File", QKeySequence::Open); - RegisterHotkey("Main Window", "Swap Screens", QKeySequence::NextChild); - RegisterHotkey("Main Window", "Start Emulation"); - LoadHotkeys(); - - connect(GetHotkey("Main Window", "Load File", this), SIGNAL(activated()), this, - SLOT(OnMenuLoadFile())); - connect(GetHotkey("Main Window", "Start Emulation", this), SIGNAL(activated()), this, - SLOT(OnStartGame())); - connect(GetHotkey("Main Window", "Swap Screens", render_window), SIGNAL(activated()), this, - SLOT(OnSwapScreens())); -} - -void GMainWindow::SetDefaultUIGeometry() { - // geometry: 55% of the window contents are in the upper screen half, 45% in the lower half - const QRect screenRect = QApplication::desktop()->screenGeometry(this); - - const int w = screenRect.width() * 2 / 3; - const int h = screenRect.height() / 2; - const int x = (screenRect.x() + screenRect.width()) / 2 - w / 2; - const int y = (screenRect.y() + screenRect.height()) / 2 - h * 55 / 100; - - setGeometry(x, y, w, h); -} - -void GMainWindow::RestoreUIState() { - restoreGeometry(UISettings::values.geometry); - restoreState(UISettings::values.state); - render_window->restoreGeometry(UISettings::values.renderwindow_geometry); -#if MICROPROFILE_ENABLED - microProfileDialog->restoreGeometry(UISettings::values.microprofile_geometry); - microProfileDialog->setVisible(UISettings::values.microprofile_visible); -#endif - - game_list->LoadInterfaceLayout(); - - ui.action_Single_Window_Mode->setChecked(UISettings::values.single_window_mode); - ToggleWindowMode(); - - ui.action_Display_Dock_Widget_Headers->setChecked(UISettings::values.display_titlebar); - OnDisplayTitleBars(ui.action_Display_Dock_Widget_Headers->isChecked()); - - ui.action_Show_Filter_Bar->setChecked(UISettings::values.show_filter_bar); - game_list->setFilterVisible(ui.action_Show_Filter_Bar->isChecked()); - - ui.action_Show_Status_Bar->setChecked(UISettings::values.show_status_bar); - statusBar()->setVisible(ui.action_Show_Status_Bar->isChecked()); -} - -void GMainWindow::ConnectWidgetEvents() { - connect(game_list, SIGNAL(GameChosen(QString)), this, SLOT(OnGameListLoadFile(QString))); - connect(game_list, SIGNAL(OpenSaveFolderRequested(u64)), this, - SLOT(OnGameListOpenSaveFolder(u64))); - - connect(this, SIGNAL(EmulationStarting(EmuThread*)), render_window, - SLOT(OnEmulationStarting(EmuThread*))); - connect(this, SIGNAL(EmulationStopping()), render_window, SLOT(OnEmulationStopping())); - - connect(&status_bar_update_timer, &QTimer::timeout, this, &GMainWindow::UpdateStatusBar); -} - -void GMainWindow::ConnectMenuEvents() { - // File - connect(ui.action_Load_File, &QAction::triggered, this, &GMainWindow::OnMenuLoadFile); - connect(ui.action_Select_Game_List_Root, &QAction::triggered, this, - &GMainWindow::OnMenuSelectGameListRoot); - connect(ui.action_Exit, &QAction::triggered, this, &QMainWindow::close); - - // Emulation - connect(ui.action_Start, &QAction::triggered, this, &GMainWindow::OnStartGame); - connect(ui.action_Pause, &QAction::triggered, this, &GMainWindow::OnPauseGame); - connect(ui.action_Stop, &QAction::triggered, this, &GMainWindow::OnStopGame); - connect(ui.action_Configure, &QAction::triggered, this, &GMainWindow::OnConfigure); - - // View - connect(ui.action_Single_Window_Mode, &QAction::triggered, this, - &GMainWindow::ToggleWindowMode); - connect(ui.action_Display_Dock_Widget_Headers, &QAction::triggered, this, - &GMainWindow::OnDisplayTitleBars); - ui.action_Show_Filter_Bar->setShortcut(tr("CTRL+F")); - connect(ui.action_Show_Filter_Bar, &QAction::triggered, this, &GMainWindow::OnToggleFilterBar); - connect(ui.action_Show_Status_Bar, &QAction::triggered, statusBar(), &QStatusBar::setVisible); -} - -void GMainWindow::OnDisplayTitleBars(bool show) { - QList widgets = findChildren(); - - if (show) { - for (QDockWidget* widget : widgets) { - QWidget* old = widget->titleBarWidget(); - widget->setTitleBarWidget(nullptr); - if (old != nullptr) - delete old; - } - } else { - for (QDockWidget* widget : widgets) { - QWidget* old = widget->titleBarWidget(); - widget->setTitleBarWidget(new QWidget()); - if (old != nullptr) - delete old; - } - } -} - -bool GMainWindow::LoadROM(const QString& filename) { - // Shutdown previous session if the emu thread is still active... - if (emu_thread != nullptr) - ShutdownGame(); - - render_window->InitRenderTarget(); - render_window->MakeCurrent(); - - if (!gladLoadGL()) { - QMessageBox::critical(this, tr("Error while initializing OpenGL 3.3 Core!"), - tr("Your GPU may not support OpenGL 3.3, or you do not " - "have the latest graphics driver.")); - return false; - } - - Core::System& system{Core::System::GetInstance()}; - - const Core::System::ResultStatus result{system.Load(render_window, filename.toStdString())}; - - Core::Telemetry().AddField(Telemetry::FieldType::App, "Frontend", "Qt"); - - if (result != Core::System::ResultStatus::Success) { - switch (result) { - case Core::System::ResultStatus::ErrorGetLoader: - LOG_CRITICAL(Frontend, "Failed to obtain loader for %s!", - filename.toStdString().c_str()); - QMessageBox::critical(this, tr("Error while loading ROM!"), - tr("The ROM format is not supported.")); - break; - - case Core::System::ResultStatus::ErrorSystemMode: - LOG_CRITICAL(Frontend, "Failed to load ROM!"); - QMessageBox::critical(this, tr("Error while loading ROM!"), - tr("Could not determine the system mode.")); - break; - - case Core::System::ResultStatus::ErrorLoader_ErrorEncrypted: { - QMessageBox::critical( - this, tr("Error while loading ROM!"), - tr("The game that you are trying to load must be decrypted before being used with " - "Citra. A real 3DS is required.

" - "For more information on dumping and decrypting games, please see the following " - "wiki pages: ")); - break; - } - case Core::System::ResultStatus::ErrorLoader_ErrorInvalidFormat: - QMessageBox::critical(this, tr("Error while loading ROM!"), - tr("The ROM format is not supported.")); - break; - - case Core::System::ResultStatus::ErrorVideoCore: - QMessageBox::critical( - this, tr("An error occured in the video core."), - tr("Citra has encountered an error while running the video core, please see the " - "log for more details." - "For more information on accessing the log, please see the following page: " - "How " - "to " - "Upload the Log File." - "Ensure that you have the latest graphics drivers for your GPU.")); - - break; - - default: - QMessageBox::critical( - this, tr("Error while loading ROM!"), - tr("An unknown error occured. Please see the log for more details.")); - break; - } - return false; - } - return true; -} - -void GMainWindow::BootGame(const QString& filename) { - LOG_INFO(Frontend, "Citra starting..."); - StoreRecentFile(filename); // Put the filename on top of the list - - if (!LoadROM(filename)) - return; - - // Create and start the emulation thread - emu_thread = std::make_unique(render_window); - emit EmulationStarting(emu_thread.get()); - render_window->moveContext(); - emu_thread->start(); - - connect(render_window, SIGNAL(Closed()), this, SLOT(OnStopGame())); - // BlockingQueuedConnection is important here, it makes sure we've finished refreshing our views - // before the CPU continues - connect(emu_thread.get(), SIGNAL(DebugModeEntered()), registersWidget, - SLOT(OnDebugModeEntered()), Qt::BlockingQueuedConnection); - connect(emu_thread.get(), SIGNAL(DebugModeEntered()), waitTreeWidget, - SLOT(OnDebugModeEntered()), Qt::BlockingQueuedConnection); - connect(emu_thread.get(), SIGNAL(DebugModeLeft()), registersWidget, SLOT(OnDebugModeLeft()), - Qt::BlockingQueuedConnection); - connect(emu_thread.get(), SIGNAL(DebugModeLeft()), waitTreeWidget, SLOT(OnDebugModeLeft()), - Qt::BlockingQueuedConnection); - - // Update the GUI - registersWidget->OnDebugModeEntered(); - if (ui.action_Single_Window_Mode->isChecked()) { - game_list->hide(); - } - status_bar_update_timer.start(2000); - - render_window->show(); - render_window->setFocus(); - - emulation_running = true; - OnStartGame(); -} - -void GMainWindow::ShutdownGame() { - emu_thread->RequestStop(); - - // Release emu threads from any breakpoints - // This belongs after RequestStop() and before wait() because if emulation stops on a GPU - // breakpoint after (or before) RequestStop() is called, the emulation would never be able - // to continue out to the main loop and terminate. Thus wait() would hang forever. - // TODO(bunnei): This function is not thread safe, but it's being used as if it were - Pica::g_debug_context->ClearBreakpoints(); - - emit EmulationStopping(); - - // Wait for emulation thread to complete and delete it - emu_thread->wait(); - emu_thread = nullptr; - - // The emulation is stopped, so closing the window or not does not matter anymore - disconnect(render_window, SIGNAL(Closed()), this, SLOT(OnStopGame())); - - // Update the GUI - ui.action_Start->setEnabled(false); - ui.action_Start->setText(tr("Start")); - ui.action_Pause->setEnabled(false); - ui.action_Stop->setEnabled(false); - render_window->hide(); - game_list->show(); - game_list->setFilterFocus(); - - // Disable status bar updates - status_bar_update_timer.stop(); - message_label->setVisible(false); - emu_speed_label->setVisible(false); - game_fps_label->setVisible(false); - emu_frametime_label->setVisible(false); - - emulation_running = false; -} - -void GMainWindow::StoreRecentFile(const QString& filename) { - UISettings::values.recent_files.prepend(filename); - UISettings::values.recent_files.removeDuplicates(); - while (UISettings::values.recent_files.size() > max_recent_files_item) { - UISettings::values.recent_files.removeLast(); - } - - UpdateRecentFiles(); -} - -void GMainWindow::UpdateRecentFiles() { - unsigned int num_recent_files = - std::min(UISettings::values.recent_files.size(), static_cast(max_recent_files_item)); - - for (unsigned int i = 0; i < num_recent_files; i++) { - QString text = QString("&%1. %2").arg(i + 1).arg( - QFileInfo(UISettings::values.recent_files[i]).fileName()); - actions_recent_files[i]->setText(text); - actions_recent_files[i]->setData(UISettings::values.recent_files[i]); - actions_recent_files[i]->setToolTip(UISettings::values.recent_files[i]); - actions_recent_files[i]->setVisible(true); - } - - for (int j = num_recent_files; j < max_recent_files_item; ++j) { - actions_recent_files[j]->setVisible(false); - } - - // Grey out the recent files menu if the list is empty - if (num_recent_files == 0) { - ui.menu_recent_files->setEnabled(false); - } else { - ui.menu_recent_files->setEnabled(true); - } -} - -void GMainWindow::OnGameListLoadFile(QString game_path) { - BootGame(game_path); -} - -void GMainWindow::OnGameListOpenSaveFolder(u64 program_id) { - UNIMPLEMENTED(); -} - -void GMainWindow::OnMenuLoadFile() { - QString extensions; - for (const auto& piece : game_list->supported_file_extensions) - extensions += "*." + piece + " "; - - QString file_filter = tr("3DS Executable") + " (" + extensions + ")"; - file_filter += ";;" + tr("All Files (*.*)"); - - QString filename = QFileDialog::getOpenFileName(this, tr("Load File"), - UISettings::values.roms_path, file_filter); - if (!filename.isEmpty()) { - UISettings::values.roms_path = QFileInfo(filename).path(); - - BootGame(filename); - } -} - -void GMainWindow::OnMenuSelectGameListRoot() { - QString dir_path = QFileDialog::getExistingDirectory(this, tr("Select Directory")); - if (!dir_path.isEmpty()) { - UISettings::values.gamedir = dir_path; - game_list->PopulateAsync(dir_path, UISettings::values.gamedir_deepscan); - } -} - -void GMainWindow::OnMenuRecentFile() { - QAction* action = qobject_cast(sender()); - assert(action); - - QString filename = action->data().toString(); - QFileInfo file_info(filename); - if (file_info.exists()) { - BootGame(filename); - } else { - // Display an error message and remove the file from the list. - QMessageBox::information(this, tr("File not found"), - tr("File \"%1\" not found").arg(filename)); - - UISettings::values.recent_files.removeOne(filename); - UpdateRecentFiles(); - } -} - -void GMainWindow::OnStartGame() { - emu_thread->SetRunning(true); - qRegisterMetaType("Core::System::ResultStatus"); - qRegisterMetaType("std::string"); - connect(emu_thread.get(), SIGNAL(ErrorThrown(Core::System::ResultStatus, std::string)), this, - SLOT(OnCoreError(Core::System::ResultStatus, std::string))); - - ui.action_Start->setEnabled(false); - ui.action_Start->setText(tr("Continue")); - - ui.action_Pause->setEnabled(true); - ui.action_Stop->setEnabled(true); -} - -void GMainWindow::OnPauseGame() { - emu_thread->SetRunning(false); - - ui.action_Start->setEnabled(true); - ui.action_Pause->setEnabled(false); - ui.action_Stop->setEnabled(true); -} - -void GMainWindow::OnStopGame() { - ShutdownGame(); -} - -void GMainWindow::ToggleWindowMode() { - if (ui.action_Single_Window_Mode->isChecked()) { - // Render in the main window... - render_window->BackupGeometry(); - ui.horizontalLayout->addWidget(render_window); - render_window->setFocusPolicy(Qt::ClickFocus); - if (emulation_running) { - render_window->setVisible(true); - render_window->setFocus(); - game_list->hide(); - } - - } else { - // Render in a separate window... - ui.horizontalLayout->removeWidget(render_window); - render_window->setParent(nullptr); - render_window->setFocusPolicy(Qt::NoFocus); - if (emulation_running) { - render_window->setVisible(true); - render_window->RestoreGeometry(); - game_list->show(); - } - } -} - -void GMainWindow::OnConfigure() { - ConfigureDialog configureDialog(this); - auto result = configureDialog.exec(); - if (result == QDialog::Accepted) { - configureDialog.applyConfiguration(); - UpdateUITheme(); - config->Save(); - } -} - -void GMainWindow::OnToggleFilterBar() { - game_list->setFilterVisible(ui.action_Show_Filter_Bar->isChecked()); - if (ui.action_Show_Filter_Bar->isChecked()) { - game_list->setFilterFocus(); - } else { - game_list->clearFilter(); - } -} - -void GMainWindow::OnSwapScreens() { - Settings::values.swap_screen = !Settings::values.swap_screen; - Settings::Apply(); -} - -void GMainWindow::OnCreateGraphicsSurfaceViewer() { - auto graphicsSurfaceViewerWidget = new GraphicsSurfaceWidget(Pica::g_debug_context, this); - addDockWidget(Qt::RightDockWidgetArea, graphicsSurfaceViewerWidget); - // TODO: Maybe graphicsSurfaceViewerWidget->setFloating(true); - graphicsSurfaceViewerWidget->show(); -} - -void GMainWindow::UpdateStatusBar() { - if (emu_thread == nullptr) { - status_bar_update_timer.stop(); - return; - } - - auto results = Core::System::GetInstance().GetAndResetPerfStats(); - - emu_speed_label->setText(tr("Speed: %1%").arg(results.emulation_speed * 100.0, 0, 'f', 0)); - game_fps_label->setText(tr("Game: %1 FPS").arg(results.game_fps, 0, 'f', 0)); - emu_frametime_label->setText(tr("Frame: %1 ms").arg(results.frametime * 1000.0, 0, 'f', 2)); - - emu_speed_label->setVisible(true); - game_fps_label->setVisible(true); - emu_frametime_label->setVisible(true); -} - -void GMainWindow::OnCoreError(Core::System::ResultStatus result, std::string details) { - QMessageBox::StandardButton answer; - QString status_message; - const QString common_message = - tr("The game you are trying to load requires additional files from your 3DS to be dumped " - "before playing.

For more information on dumping these files, please see the " - "following wiki page: Dumping System " - "Archives and the Shared Fonts from a 3DS Console.

Would you like to quit " - "back to the game list? Continuing emulation may result in crashes, corrupted save " - "data, or other bugs."); - switch (result) { - case Core::System::ResultStatus::ErrorSystemFiles: { - QString message = "Citra was unable to locate a 3DS system archive"; - if (!details.empty()) { - message.append(tr(": %1. ").arg(details.c_str())); - } else { - message.append(". "); - } - message.append(common_message); - - answer = QMessageBox::question(this, tr("System Archive Not Found"), message, - QMessageBox::Yes | QMessageBox::No, QMessageBox::No); - status_message = "System Archive Missing"; - break; - } - - case Core::System::ResultStatus::ErrorSharedFont: { - QString message = tr("Citra was unable to locate the 3DS shared fonts. "); - message.append(common_message); - answer = QMessageBox::question(this, tr("Shared Fonts Not Found"), message, - QMessageBox::Yes | QMessageBox::No, QMessageBox::No); - status_message = "Shared Font Missing"; - break; - } - - default: - answer = QMessageBox::question( - this, tr("Fatal Error"), - tr("Citra has encountered a fatal error, please see the log for more details. " - "For more information on accessing the log, please see the following page: " - "How to " - "Upload the Log File.

Would you like to quit back to the game list? " - "Continuing emulation may result in crashes, corrupted save data, or other bugs."), - QMessageBox::Yes | QMessageBox::No, QMessageBox::No); - status_message = "Fatal Error encountered"; - break; - } - - if (answer == QMessageBox::Yes) { - if (emu_thread) { - ShutdownGame(); - } - } else { - // Only show the message if the game is still running. - if (emu_thread) { - message_label->setText(status_message); - message_label->setVisible(true); - } - } -} - -bool GMainWindow::ConfirmClose() { - if (emu_thread == nullptr || !UISettings::values.confirm_before_closing) - return true; - - QMessageBox::StandardButton answer = - QMessageBox::question(this, tr("Citra"), tr("Are you sure you want to close Citra?"), - QMessageBox::Yes | QMessageBox::No, QMessageBox::No); - return answer != QMessageBox::No; -} - -void GMainWindow::closeEvent(QCloseEvent* event) { - if (!ConfirmClose()) { - event->ignore(); - return; - } - - UISettings::values.geometry = saveGeometry(); - UISettings::values.state = saveState(); - UISettings::values.renderwindow_geometry = render_window->saveGeometry(); -#if MICROPROFILE_ENABLED - UISettings::values.microprofile_geometry = microProfileDialog->saveGeometry(); - UISettings::values.microprofile_visible = microProfileDialog->isVisible(); -#endif - UISettings::values.single_window_mode = ui.action_Single_Window_Mode->isChecked(); - UISettings::values.display_titlebar = ui.action_Display_Dock_Widget_Headers->isChecked(); - UISettings::values.show_filter_bar = ui.action_Show_Filter_Bar->isChecked(); - UISettings::values.show_status_bar = ui.action_Show_Status_Bar->isChecked(); - UISettings::values.first_start = false; - - game_list->SaveInterfaceLayout(); - SaveHotkeys(); - - // Shutdown session if the emu thread is active... - if (emu_thread != nullptr) - ShutdownGame(); - - render_window->close(); - - QWidget::closeEvent(event); -} - -static bool IsSingleFileDropEvent(QDropEvent* event) { - const QMimeData* mimeData = event->mimeData(); - return mimeData->hasUrls() && mimeData->urls().length() == 1; -} - -void GMainWindow::dropEvent(QDropEvent* event) { - if (IsSingleFileDropEvent(event) && ConfirmChangeGame()) { - const QMimeData* mimeData = event->mimeData(); - QString filename = mimeData->urls().at(0).toLocalFile(); - BootGame(filename); - } -} - -void GMainWindow::dragEnterEvent(QDragEnterEvent* event) { - if (IsSingleFileDropEvent(event)) { - event->acceptProposedAction(); - } -} - -void GMainWindow::dragMoveEvent(QDragMoveEvent* event) { - event->acceptProposedAction(); -} - -bool GMainWindow::ConfirmChangeGame() { - if (emu_thread == nullptr) - return true; - - auto answer = QMessageBox::question( - this, tr("Citra"), - tr("Are you sure you want to stop the emulation? Any unsaved progress will be lost."), - QMessageBox::Yes | QMessageBox::No, QMessageBox::No); - return answer != QMessageBox::No; -} - -void GMainWindow::filterBarSetChecked(bool state) { - ui.action_Show_Filter_Bar->setChecked(state); - emit(OnToggleFilterBar()); -} - -void GMainWindow::UpdateUITheme() { - if (UISettings::values.theme != UISettings::themes[0].second) { - QString theme_uri(":" + UISettings::values.theme + "/style.qss"); - QFile f(theme_uri); - if (!f.exists()) { - LOG_ERROR(Frontend, "Unable to set style, stylesheet file not found"); - } else { - f.open(QFile::ReadOnly | QFile::Text); - QTextStream ts(&f); - qApp->setStyleSheet(ts.readAll()); - GMainWindow::setStyleSheet(ts.readAll()); - } - } else { - qApp->setStyleSheet(""); - GMainWindow::setStyleSheet(""); - } -} - -#ifdef main -#undef main -#endif - -int main(int argc, char* argv[]) { - Log::Filter log_filter(Log::Level::Info); - Log::SetFilter(&log_filter); - - MicroProfileOnThreadCreate("Frontend"); - SCOPE_EXIT({ MicroProfileShutdown(); }); - - // Init settings params - QCoreApplication::setOrganizationName("Citra team"); - QCoreApplication::setApplicationName("Citra"); - - QApplication::setAttribute(Qt::AA_X11InitThreads); - QApplication app(argc, argv); - - // Qt changes the locale and causes issues in float conversion using std::to_string() when - // generating shaders - setlocale(LC_ALL, "C"); - - GMainWindow main_window; - // After settings have been loaded by GMainWindow, apply the filter - log_filter.ParseFilterString(Settings::values.log_filter); - - main_window.show(); - return app.exec(); -} diff --git a/src/citra_qt/main.h b/src/citra_qt/main.h deleted file mode 100644 index d59a6d67d..000000000 --- a/src/citra_qt/main.h +++ /dev/null @@ -1,174 +0,0 @@ -// Copyright 2014 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#ifndef _CITRA_QT_MAIN_HXX_ -#define _CITRA_QT_MAIN_HXX_ - -#include -#include -#include -#include "core/core.h" -#include "ui_main.h" - -class Config; -class EmuThread; -class GameList; -class GImageInfo; -class GPUCommandStreamWidget; -class GPUCommandListWidget; -class GraphicsBreakPointsWidget; -class GraphicsTracingWidget; -class GraphicsVertexShaderWidget; -class GRenderWindow; -class MicroProfileDialog; -class ProfilerWidget; -class RegistersWidget; -class WaitTreeWidget; - -class GMainWindow : public QMainWindow { - Q_OBJECT - - /// Max number of recently loaded items to keep track of - static const int max_recent_files_item = 10; - - // TODO: Make use of this! - enum { - UI_IDLE, - UI_EMU_BOOTING, - UI_EMU_RUNNING, - UI_EMU_STOPPING, - }; - -public: - void filterBarSetChecked(bool state); - void UpdateUITheme(); - GMainWindow(); - ~GMainWindow(); - -signals: - - /** - * Signal that is emitted when a new EmuThread has been created and an emulation session is - * about to start. At this time, the core system emulation has been initialized, and all - * emulation handles and memory should be valid. - * - * @param emu_thread Pointer to the newly created EmuThread (to be used by widgets that need to - * access/change emulation state). - */ - void EmulationStarting(EmuThread* emu_thread); - - /** - * Signal that is emitted when emulation is about to stop. At this time, the EmuThread and core - * system emulation handles and memory are still valid, but are about become invalid. - */ - void EmulationStopping(); - -private: - void InitializeWidgets(); - void InitializeDebugWidgets(); - void InitializeRecentFileMenuActions(); - void InitializeHotkeys(); - - void SetDefaultUIGeometry(); - void RestoreUIState(); - - void ConnectWidgetEvents(); - void ConnectMenuEvents(); - - bool LoadROM(const QString& filename); - void BootGame(const QString& filename); - void ShutdownGame(); - - void ShowCallouts(); - - /** - * Stores the filename in the recently loaded files list. - * The new filename is stored at the beginning of the recently loaded files list. - * After inserting the new entry, duplicates are removed meaning that if - * this was inserted from \a OnMenuRecentFile(), the entry will be put on top - * and remove from its previous position. - * - * Finally, this function calls \a UpdateRecentFiles() to update the UI. - * - * @param filename the filename to store - */ - void StoreRecentFile(const QString& filename); - - /** - * Updates the recent files menu. - * Menu entries are rebuilt from the configuration file. - * If there is no entry in the menu, the menu is greyed out. - */ - void UpdateRecentFiles(); - - /** - * If the emulation is running, - * asks the user if he really want to close the emulator - * - * @return true if the user confirmed - */ - bool ConfirmClose(); - bool ConfirmChangeGame(); - void closeEvent(QCloseEvent* event) override; - -private slots: - void OnStartGame(); - void OnPauseGame(); - void OnStopGame(); - /// Called whenever a user selects a game in the game list widget. - void OnGameListLoadFile(QString game_path); - void OnGameListOpenSaveFolder(u64 program_id); - void OnMenuLoadFile(); - /// Called whenever a user selects the "File->Select Game List Root" menu item - void OnMenuSelectGameListRoot(); - void OnMenuRecentFile(); - void OnSwapScreens(); - void OnConfigure(); - void OnToggleFilterBar(); - void OnDisplayTitleBars(bool); - void ToggleWindowMode(); - void OnCreateGraphicsSurfaceViewer(); - void OnCoreError(Core::System::ResultStatus, std::string); - -private: - void UpdateStatusBar(); - - Ui::MainWindow ui; - - GRenderWindow* render_window; - GameList* game_list; - - // Status bar elements - QLabel* message_label = nullptr; - QLabel* emu_speed_label = nullptr; - QLabel* game_fps_label = nullptr; - QLabel* emu_frametime_label = nullptr; - QTimer status_bar_update_timer; - - std::unique_ptr config; - - // Whether emulation is currently running in Citra. - bool emulation_running = false; - std::unique_ptr emu_thread; - - // Debugger panes - ProfilerWidget* profilerWidget; - MicroProfileDialog* microProfileDialog; - RegistersWidget* registersWidget; - GPUCommandStreamWidget* graphicsWidget; - GPUCommandListWidget* graphicsCommandsWidget; - GraphicsBreakPointsWidget* graphicsBreakpointsWidget; - GraphicsVertexShaderWidget* graphicsVertexShaderWidget; - GraphicsTracingWidget* graphicsTracingWidget; - WaitTreeWidget* waitTreeWidget; - - QAction* actions_recent_files[max_recent_files_item]; - -protected: - void dropEvent(QDropEvent* event) override; - void dragEnterEvent(QDragEnterEvent* event) override; - void dragMoveEvent(QDragMoveEvent* event) override; -}; - -#endif // _CITRA_QT_MAIN_HXX_ diff --git a/src/citra_qt/main.ui b/src/citra_qt/main.ui deleted file mode 100644 index b13d578f5..000000000 --- a/src/citra_qt/main.ui +++ /dev/null @@ -1,201 +0,0 @@ - - - MainWindow - - - - 0 - 0 - 1081 - 730 - - - - Citra - - - - src/pcafe/res/icon3_64x64.icosrc/pcafe/res/icon3_64x64.ico - - - QTabWidget::Rounded - - - true - - - - - 0 - - - 0 - - - 0 - - - 0 - - - - - - - 0 - 0 - 1081 - 19 - - - - - &File - - - - Recent Files - - - - - - - - - - - - &Emulation - - - - - - - - - - &View - - - - Debugging - - - - - - - - - - - - - &Help - - - - - - - - - - - Load File... - - - - - Load Symbol Map... - - - - - E&xit - - - - - false - - - &Start - - - - - false - - - &Pause - - - - - false - - - &Stop - - - - - About Citra - - - - - true - - - Single Window Mode - - - - - Configure... - - - - - true - - - Display Dock Widget Headers - - - - - true - - - Show Filter Bar - - - - - true - - - Show Status Bar - - - - - Select Game Directory... - - - Selects a folder to display in the game list - - - - - Create Pica Surface Viewer - - - - - diff --git a/src/citra_qt/ui_settings.cpp b/src/citra_qt/ui_settings.cpp deleted file mode 100644 index 120b34990..000000000 --- a/src/citra_qt/ui_settings.cpp +++ /dev/null @@ -1,10 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#include "ui_settings.h" - -namespace UISettings { - -Values values = {}; -} diff --git a/src/citra_qt/ui_settings.h b/src/citra_qt/ui_settings.h deleted file mode 100644 index d85c92765..000000000 --- a/src/citra_qt/ui_settings.h +++ /dev/null @@ -1,56 +0,0 @@ -// Copyright 2016 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include -#include -#include -#include - -namespace UISettings { - -using ContextualShortcut = std::pair; -using Shortcut = std::pair; - -static const std::array, 2> themes = { - {std::make_pair(QString("Default"), QString("default")), - std::make_pair(QString("Dark"), QString("qdarkstyle"))}}; - -struct Values { - QByteArray geometry; - QByteArray state; - - QByteArray renderwindow_geometry; - - QByteArray gamelist_header_state; - - QByteArray microprofile_geometry; - bool microprofile_visible; - - bool single_window_mode; - bool display_titlebar; - bool show_filter_bar; - bool show_status_bar; - - bool confirm_before_closing; - bool first_start; - - QString roms_path; - QString symbols_path; - QString gamedir; - bool gamedir_deepscan; - QStringList recent_files; - - QString theme; - - // Shortcut name - std::vector shortcuts; - - uint32_t callout_flags; -}; - -extern Values values; -} diff --git a/src/citra_qt/util/spinbox.cpp b/src/citra_qt/util/spinbox.cpp deleted file mode 100644 index 212709007..000000000 --- a/src/citra_qt/util/spinbox.cpp +++ /dev/null @@ -1,278 +0,0 @@ -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -// Copyright 2014 Tony Wasserka -// All rights reserved. -// -// Redistribution and use in source and binary forms, with or without -// modification, are permitted provided that the following conditions are met: -// -// * Redistributions of source code must retain the above copyright -// notice, this list of conditions and the following disclaimer. -// * Redistributions in binary form must reproduce the above copyright -// notice, this list of conditions and the following disclaimer in the -// documentation and/or other materials provided with the distribution. -// * Neither the name of the owner nor the names of its contributors may -// be used to endorse or promote products derived from this software -// without specific prior written permission. -// -// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - -#include -#include -#include -#include "citra_qt/util/spinbox.h" -#include "common/assert.h" - -CSpinBox::CSpinBox(QWidget* parent) - : QAbstractSpinBox(parent), min_value(-100), max_value(100), value(0), base(10), num_digits(0) { - // TODO: Might be nice to not immediately call the slot. - // Think of an address that is being replaced by a different one, in which case a lot - // invalid intermediate addresses would be read from during editing. - connect(lineEdit(), SIGNAL(textEdited(QString)), this, SLOT(OnEditingFinished())); - - UpdateText(); -} - -void CSpinBox::SetValue(qint64 val) { - auto old_value = value; - value = std::max(std::min(val, max_value), min_value); - - if (old_value != value) { - UpdateText(); - emit ValueChanged(value); - } -} - -void CSpinBox::SetRange(qint64 min, qint64 max) { - min_value = min; - max_value = max; - - SetValue(value); - UpdateText(); -} - -void CSpinBox::stepBy(int steps) { - auto new_value = value; - // Scale number of steps by the currently selected digit - // TODO: Move this code elsewhere and enable it. - // TODO: Support for num_digits==0, too - // TODO: Support base!=16, too - // TODO: Make the cursor not jump back to the end of the line... - /*if (base == 16 && num_digits > 0) { - int digit = num_digits - (lineEdit()->cursorPosition() - prefix.length()) - 1; - digit = std::max(0, std::min(digit, num_digits - 1)); - steps <<= digit * 4; - }*/ - - // Increment "new_value" by "steps", and perform annoying overflow checks, too. - if (steps < 0 && new_value + steps > new_value) { - new_value = std::numeric_limits::min(); - } else if (steps > 0 && new_value + steps < new_value) { - new_value = std::numeric_limits::max(); - } else { - new_value += steps; - } - - SetValue(new_value); - UpdateText(); -} - -QAbstractSpinBox::StepEnabled CSpinBox::stepEnabled() const { - StepEnabled ret = StepNone; - - if (value > min_value) - ret |= StepDownEnabled; - - if (value < max_value) - ret |= StepUpEnabled; - - return ret; -} - -void CSpinBox::SetBase(int base) { - this->base = base; - - UpdateText(); -} - -void CSpinBox::SetNumDigits(int num_digits) { - this->num_digits = num_digits; - - UpdateText(); -} - -void CSpinBox::SetPrefix(const QString& prefix) { - this->prefix = prefix; - - UpdateText(); -} - -void CSpinBox::SetSuffix(const QString& suffix) { - this->suffix = suffix; - - UpdateText(); -} - -static QString StringToInputMask(const QString& input) { - QString mask = input; - - // ... replace any special characters by their escaped counterparts ... - mask.replace("\\", "\\\\"); - mask.replace("A", "\\A"); - mask.replace("a", "\\a"); - mask.replace("N", "\\N"); - mask.replace("n", "\\n"); - mask.replace("X", "\\X"); - mask.replace("x", "\\x"); - mask.replace("9", "\\9"); - mask.replace("0", "\\0"); - mask.replace("D", "\\D"); - mask.replace("d", "\\d"); - mask.replace("#", "\\#"); - mask.replace("H", "\\H"); - mask.replace("h", "\\h"); - mask.replace("B", "\\B"); - mask.replace("b", "\\b"); - mask.replace(">", "\\>"); - mask.replace("<", "\\<"); - mask.replace("!", "\\!"); - - return mask; -} - -void CSpinBox::UpdateText() { - // If a fixed number of digits is used, we put the line edit in insertion mode by setting an - // input mask. - QString mask; - if (num_digits != 0) { - mask += StringToInputMask(prefix); - - // For base 10 and negative range, demand a single sign character - if (HasSign()) - mask += "X"; // identified as "-" or "+" in the validator - - // Uppercase digits greater than 9. - mask += ">"; - - // Match num_digits digits - // Digits irrelevant to the chosen number base are filtered in the validator - mask += QString("H").repeated(std::max(num_digits, 1)); - - // Switch off case conversion - mask += "!"; - - mask += StringToInputMask(suffix); - } - lineEdit()->setInputMask(mask); - - // Set new text without changing the cursor position. This will cause the cursor to briefly - // appear at the end of the line and then to jump back to its original position. That's - // a bit ugly, but better than having setText() move the cursor permanently all the time. - int cursor_position = lineEdit()->cursorPosition(); - lineEdit()->setText(TextFromValue()); - lineEdit()->setCursorPosition(cursor_position); -} - -QString CSpinBox::TextFromValue() { - return prefix + QString(HasSign() ? ((value < 0) ? "-" : "+") : "") + - QString("%1").arg(std::abs(value), num_digits, base, QLatin1Char('0')).toUpper() + - suffix; -} - -qint64 CSpinBox::ValueFromText() { - unsigned strpos = prefix.length(); - - QString num_string = text().mid(strpos, text().length() - strpos - suffix.length()); - return num_string.toLongLong(nullptr, base); -} - -bool CSpinBox::HasSign() const { - return base == 10 && min_value < 0; -} - -void CSpinBox::OnEditingFinished() { - // Only update for valid input - QString input = lineEdit()->text(); - int pos = 0; - if (QValidator::Acceptable == validate(input, pos)) - SetValue(ValueFromText()); -} - -QValidator::State CSpinBox::validate(QString& input, int& pos) const { - if (!prefix.isEmpty() && input.left(prefix.length()) != prefix) - return QValidator::Invalid; - - int strpos = prefix.length(); - - // Empty "numbers" allowed as intermediate values - if (strpos >= input.length() - HasSign() - suffix.length()) - return QValidator::Intermediate; - - DEBUG_ASSERT(base <= 10 || base == 16); - QString regexp; - - // Demand sign character for negative ranges - if (HasSign()) - regexp += "[+\\-]"; - - // Match digits corresponding to the chosen number base. - regexp += QString("[0-%1").arg(std::min(base, 9)); - if (base == 16) { - regexp += "a-fA-F"; - } - regexp += "]"; - - // Specify number of digits - if (num_digits > 0) { - regexp += QString("{%1}").arg(num_digits); - } else { - regexp += "+"; - } - - // Match string - QRegExp num_regexp(regexp); - int num_pos = strpos; - QString sub_input = input.mid(strpos, input.length() - strpos - suffix.length()); - - if (!num_regexp.exactMatch(sub_input) && num_regexp.matchedLength() == 0) - return QValidator::Invalid; - - sub_input = sub_input.left(num_regexp.matchedLength()); - bool ok; - qint64 val = sub_input.toLongLong(&ok, base); - - if (!ok) - return QValidator::Invalid; - - // Outside boundaries => don't accept - if (val < min_value || val > max_value) - return QValidator::Invalid; - - // Make sure we are actually at the end of this string... - strpos += num_regexp.matchedLength(); - - if (!suffix.isEmpty() && input.mid(strpos) != suffix) { - return QValidator::Invalid; - } else { - strpos += suffix.length(); - } - - if (strpos != input.length()) - return QValidator::Invalid; - - // At this point we can say for sure that the input is fine. Let's fix it up a bit though - input.replace(num_pos, sub_input.length(), sub_input.toUpper()); - - return QValidator::Acceptable; -} diff --git a/src/citra_qt/util/spinbox.h b/src/citra_qt/util/spinbox.h deleted file mode 100644 index 2fa1db3a4..000000000 --- a/src/citra_qt/util/spinbox.h +++ /dev/null @@ -1,86 +0,0 @@ -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -// Copyright 2014 Tony Wasserka -// All rights reserved. -// -// Redistribution and use in source and binary forms, with or without -// modification, are permitted provided that the following conditions are met: -// -// * Redistributions of source code must retain the above copyright -// notice, this list of conditions and the following disclaimer. -// * Redistributions in binary form must reproduce the above copyright -// notice, this list of conditions and the following disclaimer in the -// documentation and/or other materials provided with the distribution. -// * Neither the name of the owner nor the names of its contributors may -// be used to endorse or promote products derived from this software -// without specific prior written permission. -// -// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - -#pragma once - -#include -#include - -class QVariant; - -/** - * A custom spin box widget with enhanced functionality over Qt's QSpinBox - */ -class CSpinBox : public QAbstractSpinBox { - Q_OBJECT - -public: - explicit CSpinBox(QWidget* parent = nullptr); - - void stepBy(int steps) override; - StepEnabled stepEnabled() const override; - - void SetValue(qint64 val); - - void SetRange(qint64 min, qint64 max); - - void SetBase(int base); - - void SetPrefix(const QString& prefix); - void SetSuffix(const QString& suffix); - - void SetNumDigits(int num_digits); - - QValidator::State validate(QString& input, int& pos) const override; - -signals: - void ValueChanged(qint64 val); - -private slots: - void OnEditingFinished(); - -private: - void UpdateText(); - - bool HasSign() const; - - QString TextFromValue(); - qint64 ValueFromText(); - - qint64 min_value, max_value; - - qint64 value; - - QString prefix, suffix; - - int base; - - int num_digits; -}; diff --git a/src/citra_qt/util/util.cpp b/src/citra_qt/util/util.cpp deleted file mode 100644 index 02be92bbd..000000000 --- a/src/citra_qt/util/util.cpp +++ /dev/null @@ -1,26 +0,0 @@ -// Copyright 2015 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#include -#include -#include "citra_qt/util/util.h" - -QFont GetMonospaceFont() { - QFont font("monospace"); - // Automatic fallback to a monospace font on on platforms without a font called "monospace" - font.setStyleHint(QFont::Monospace); - font.setFixedPitch(true); - return font; -} - -QString ReadableByteSize(qulonglong size) { - static const std::array units = {"B", "KiB", "MiB", "GiB", "TiB", "PiB"}; - if (size == 0) - return "0"; - int digit_groups = std::min(static_cast(std::log10(size) / std::log10(1024)), - static_cast(units.size())); - return QString("%L1 %2") - .arg(size / std::pow(1024, digit_groups), 0, 'f', 1) - .arg(units[digit_groups]); -} diff --git a/src/citra_qt/util/util.h b/src/citra_qt/util/util.h deleted file mode 100644 index ab443ef9b..000000000 --- a/src/citra_qt/util/util.h +++ /dev/null @@ -1,14 +0,0 @@ -// Copyright 2015 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include - -/// Returns a QFont object appropriate to use as a monospace font for debugging widgets, etc. -QFont GetMonospaceFont(); - -/// Convert a size in bytes into a readable format (KiB, MiB, etc.) -QString ReadableByteSize(qulonglong size); diff --git a/src/network/CMakeLists.txt b/src/network/CMakeLists.txt deleted file mode 100644 index ac9d028da..000000000 --- a/src/network/CMakeLists.txt +++ /dev/null @@ -1,18 +0,0 @@ -set(SRCS - network.cpp - packet.cpp - room.cpp - room_member.cpp - ) - -set(HEADERS - network.h - packet.h - room.h - room_member.h - ) - -create_directory_groups(${SRCS} ${HEADERS}) - -add_library(network STATIC ${SRCS} ${HEADERS}) -target_link_libraries(network PRIVATE common enet) diff --git a/src/network/network.cpp b/src/network/network.cpp deleted file mode 100644 index 51b5d6a9f..000000000 --- a/src/network/network.cpp +++ /dev/null @@ -1,50 +0,0 @@ -// Copyright 2017 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#include "common/assert.h" -#include "common/logging/log.h" -#include "enet/enet.h" -#include "network/network.h" - -namespace Network { - -static std::shared_ptr g_room_member; ///< RoomMember (Client) for network games -static std::shared_ptr g_room; ///< Room (Server) for network games -// TODO(B3N30): Put these globals into a networking class - -bool Init() { - if (enet_initialize() != 0) { - LOG_ERROR(Network, "Error initalizing ENet"); - return false; - } - g_room = std::make_shared(); - g_room_member = std::make_shared(); - LOG_DEBUG(Network, "initialized OK"); - return true; -} - -std::weak_ptr GetRoom() { - return g_room; -} - -std::weak_ptr GetRoomMember() { - return g_room_member; -} - -void Shutdown() { - if (g_room_member) { - if (g_room_member->IsConnected()) - g_room_member->Leave(); - g_room_member.reset(); - } - if (g_room) { - if (g_room->GetState() == Room::State::Open) - g_room->Destroy(); - g_room.reset(); - } - enet_deinitialize(); - LOG_DEBUG(Network, "shutdown OK"); -} - -} // namespace Network diff --git a/src/network/network.h b/src/network/network.h deleted file mode 100644 index 6d002d693..000000000 --- a/src/network/network.h +++ /dev/null @@ -1,25 +0,0 @@ -// Copyright 2017 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include "network/room.h" -#include "network/room_member.h" - -namespace Network { - -/// Initializes and registers the network device, the room, and the room member. -bool Init(); - -/// Returns a pointer to the room handle -std::weak_ptr GetRoom(); - -/// Returns a pointer to the room member handle -std::weak_ptr GetRoomMember(); - -/// Unregisters the network device, the room, and the room member and shut them down. -void Shutdown(); - -} // namespace Network diff --git a/src/network/packet.cpp b/src/network/packet.cpp deleted file mode 100644 index 7e1a812f3..000000000 --- a/src/network/packet.cpp +++ /dev/null @@ -1,263 +0,0 @@ -// Copyright 2017 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#ifdef _WIN32 -#include -#else -#include -#endif -#include -#include -#include "network/packet.h" - -namespace Network { - -#ifndef htonll -u64 htonll(u64 x) { - return ((1 == htonl(1)) ? (x) : ((uint64_t)htonl((x)&0xFFFFFFFF) << 32) | htonl((x) >> 32)); -} -#endif - -#ifndef ntohll -u64 ntohll(u64 x) { - return ((1 == ntohl(1)) ? (x) : ((uint64_t)ntohl((x)&0xFFFFFFFF) << 32) | ntohl((x) >> 32)); -} -#endif - -void Packet::Append(const void* in_data, std::size_t size_in_bytes) { - if (in_data && (size_in_bytes > 0)) { - std::size_t start = data.size(); - data.resize(start + size_in_bytes); - std::memcpy(&data[start], in_data, size_in_bytes); - } -} - -void Packet::Read(void* out_data, std::size_t size_in_bytes) { - if (out_data && CheckSize(size_in_bytes)) { - std::memcpy(out_data, &data[read_pos], size_in_bytes); - read_pos += size_in_bytes; - } -} - -void Packet::Clear() { - data.clear(); - read_pos = 0; - is_valid = true; -} - -const void* Packet::GetData() const { - return !data.empty() ? &data[0] : nullptr; -} - -void Packet::IgnoreBytes(u32 length) { - read_pos += length; -} - -std::size_t Packet::GetDataSize() const { - return data.size(); -} - -bool Packet::EndOfPacket() const { - return read_pos >= data.size(); -} - -Packet::operator bool() const { - return is_valid ? &Packet::CheckSize : nullptr; -} - -Packet& Packet::operator>>(bool& out_data) { - u8 value; - if (*this >> value) { - out_data = (value != 0); - } - return *this; -} - -Packet& Packet::operator>>(s8& out_data) { - Read(&out_data, sizeof(out_data)); - return *this; -} - -Packet& Packet::operator>>(u8& out_data) { - Read(&out_data, sizeof(out_data)); - return *this; -} - -Packet& Packet::operator>>(s16& out_data) { - s16 value; - Read(&value, sizeof(value)); - out_data = ntohs(value); - return *this; -} - -Packet& Packet::operator>>(u16& out_data) { - u16 value; - Read(&value, sizeof(value)); - out_data = ntohs(value); - return *this; -} - -Packet& Packet::operator>>(s32& out_data) { - s32 value; - Read(&value, sizeof(value)); - out_data = ntohl(value); - return *this; -} - -Packet& Packet::operator>>(u32& out_data) { - u32 value; - Read(&value, sizeof(value)); - out_data = ntohl(value); - return *this; -} - -Packet& Packet::operator>>(s64& out_data) { - s64 value; - Read(&value, sizeof(value)); - out_data = ntohll(value); - return *this; -} - -Packet& Packet::operator>>(u64& out_data) { - u64 value; - Read(&value, sizeof(value)); - out_data = ntohll(value); - return *this; -} - -Packet& Packet::operator>>(float& out_data) { - Read(&out_data, sizeof(out_data)); - return *this; -} - -Packet& Packet::operator>>(double& out_data) { - Read(&out_data, sizeof(out_data)); - return *this; -} - -Packet& Packet::operator>>(char* out_data) { - // First extract string length - u32 length = 0; - *this >> length; - - if ((length > 0) && CheckSize(length)) { - // Then extract characters - std::memcpy(out_data, &data[read_pos], length); - out_data[length] = '\0'; - - // Update reading position - read_pos += length; - } - - return *this; -} - -Packet& Packet::operator>>(std::string& out_data) { - // First extract string length - u32 length = 0; - *this >> length; - - out_data.clear(); - if ((length > 0) && CheckSize(length)) { - // Then extract characters - out_data.assign(&data[read_pos], length); - - // Update reading position - read_pos += length; - } - - return *this; -} - -Packet& Packet::operator<<(bool in_data) { - *this << static_cast(in_data); - return *this; -} - -Packet& Packet::operator<<(s8 in_data) { - Append(&in_data, sizeof(in_data)); - return *this; -} - -Packet& Packet::operator<<(u8 in_data) { - Append(&in_data, sizeof(in_data)); - return *this; -} - -Packet& Packet::operator<<(s16 in_data) { - s16 toWrite = htons(in_data); - Append(&toWrite, sizeof(toWrite)); - return *this; -} - -Packet& Packet::operator<<(u16 in_data) { - u16 toWrite = htons(in_data); - Append(&toWrite, sizeof(toWrite)); - return *this; -} - -Packet& Packet::operator<<(s32 in_data) { - s32 toWrite = htonl(in_data); - Append(&toWrite, sizeof(toWrite)); - return *this; -} - -Packet& Packet::operator<<(u32 in_data) { - u32 toWrite = htonl(in_data); - Append(&toWrite, sizeof(toWrite)); - return *this; -} - -Packet& Packet::operator<<(s64 in_data) { - s64 toWrite = htonll(in_data); - Append(&toWrite, sizeof(toWrite)); - return *this; -} - -Packet& Packet::operator<<(u64 in_data) { - u64 toWrite = htonll(in_data); - Append(&toWrite, sizeof(toWrite)); - return *this; -} - -Packet& Packet::operator<<(float in_data) { - Append(&in_data, sizeof(in_data)); - return *this; -} - -Packet& Packet::operator<<(double in_data) { - Append(&in_data, sizeof(in_data)); - return *this; -} - -Packet& Packet::operator<<(const char* in_data) { - // First insert string length - u32 length = static_cast(std::strlen(in_data)); - *this << length; - - // Then insert characters - Append(in_data, length * sizeof(char)); - - return *this; -} - -Packet& Packet::operator<<(const std::string& in_data) { - // First insert string length - u32 length = static_cast(in_data.size()); - *this << length; - - // Then insert characters - if (length > 0) - Append(in_data.c_str(), length * sizeof(std::string::value_type)); - - return *this; -} - -bool Packet::CheckSize(std::size_t size) { - is_valid = is_valid && (read_pos + size <= data.size()); - - return is_valid; -} - -} // namespace Network diff --git a/src/network/packet.h b/src/network/packet.h deleted file mode 100644 index 5a2e58dc2..000000000 --- a/src/network/packet.h +++ /dev/null @@ -1,166 +0,0 @@ -// Copyright 2017 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include -#include "common/common_types.h" - -namespace Network { - -/// A class that serializes data for network transfer. It also handles endianess -class Packet { -public: - Packet() = default; - ~Packet() = default; - - /** - * Append data to the end of the packet - * @param data Pointer to the sequence of bytes to append - * @param size_in_bytes Number of bytes to append - */ - void Append(const void* data, std::size_t size_in_bytes); - - /** - * Reads data from the current read position of the packet - * @param out_data Pointer where the data should get written to - * @param size_in_bytes Number of bytes to read - */ - void Read(void* out_data, std::size_t size_in_bytes); - - /** - * Clear the packet - * After calling Clear, the packet is empty. - */ - void Clear(); - - /** - * Ignores bytes while reading - * @param length THe number of bytes to ignore - */ - void IgnoreBytes(u32 length); - - /** - * Get a pointer to the data contained in the packet - * @return Pointer to the data - */ - const void* GetData() const; - - /** - * This function returns the number of bytes pointed to by - * what getData returns. - * @return Data size, in bytes - */ - std::size_t GetDataSize() const; - - /** - * This function is useful to know if there is some data - * left to be read, without actually reading it. - * @return True if all data was read, false otherwise - */ - bool EndOfPacket() const; - - explicit operator bool() const; - - /// Overloads of operator >> to read data from the packet - Packet& operator>>(bool& out_data); - Packet& operator>>(s8& out_data); - Packet& operator>>(u8& out_data); - Packet& operator>>(s16& out_data); - Packet& operator>>(u16& out_data); - Packet& operator>>(s32& out_data); - Packet& operator>>(u32& out_data); - Packet& operator>>(s64& out_data); - Packet& operator>>(u64& out_data); - Packet& operator>>(float& out_data); - Packet& operator>>(double& out_data); - Packet& operator>>(char* out_data); - Packet& operator>>(std::string& out_data); - template - Packet& operator>>(std::vector& out_data); - template - Packet& operator>>(std::array& out_data); - - /// Overloads of operator << to write data into the packet - Packet& operator<<(bool in_data); - Packet& operator<<(s8 in_data); - Packet& operator<<(u8 in_data); - Packet& operator<<(s16 in_data); - Packet& operator<<(u16 in_data); - Packet& operator<<(s32 in_data); - Packet& operator<<(u32 in_data); - Packet& operator<<(s64 in_data); - Packet& operator<<(u64 in_data); - Packet& operator<<(float in_data); - Packet& operator<<(double in_data); - Packet& operator<<(const char* in_data); - Packet& operator<<(const std::string& in_data); - template - Packet& operator<<(const std::vector& in_data); - template - Packet& operator<<(const std::array& data); - -private: - /** - * Check if the packet can extract a given number of bytes - * This function updates accordingly the state of the packet. - * @param size Size to check - * @return True if size bytes can be read from the packet - */ - bool CheckSize(std::size_t size); - - // Member data - std::vector data; ///< Data stored in the packet - std::size_t read_pos = 0; ///< Current reading position in the packet - bool is_valid = true; ///< Reading state of the packet -}; - -template -Packet& Packet::operator>>(std::vector& out_data) { - // First extract the size - u32 size = 0; - *this >> size; - out_data.resize(size); - - // Then extract the data - for (std::size_t i = 0; i < out_data.size(); ++i) { - T character = 0; - *this >> character; - out_data[i] = character; - } - return *this; -} - -template -Packet& Packet::operator>>(std::array& out_data) { - for (std::size_t i = 0; i < out_data.size(); ++i) { - T character = 0; - *this >> character; - out_data[i] = character; - } - return *this; -} - -template -Packet& Packet::operator<<(const std::vector& in_data) { - // First insert the size - *this << static_cast(in_data.size()); - - // Then insert the data - for (std::size_t i = 0; i < in_data.size(); ++i) { - *this << in_data[i]; - } - return *this; -} - -template -Packet& Packet::operator<<(const std::array& in_data) { - for (std::size_t i = 0; i < in_data.size(); ++i) { - *this << in_data[i]; - } - return *this; -} - -} // namespace Network diff --git a/src/network/room.cpp b/src/network/room.cpp deleted file mode 100644 index 261049ab0..000000000 --- a/src/network/room.cpp +++ /dev/null @@ -1,497 +0,0 @@ -// Copyright 2017 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#include -#include -#include -#include -#include -#include "enet/enet.h" -#include "network/packet.h" -#include "network/room.h" - -namespace Network { - -/// Maximum number of concurrent connections allowed to this room. -static constexpr u32 MaxConcurrentConnections = 10; - -class Room::RoomImpl { -public: - // This MAC address is used to generate a 'Nintendo' like Mac address. - const MacAddress NintendoOUI; - std::mt19937 random_gen; ///< Random number generator. Used for GenerateMacAddress - - ENetHost* server = nullptr; ///< Network interface. - - std::atomic state{State::Closed}; ///< Current state of the room. - RoomInformation room_information; ///< Information about this room. - - struct Member { - std::string nickname; ///< The nickname of the member. - GameInfo game_info; ///< The current game of the member - MacAddress mac_address; ///< The assigned mac address of the member. - ENetPeer* peer; ///< The remote peer. - }; - using MemberList = std::vector; - MemberList members; ///< Information about the members of this room - mutable std::mutex member_mutex; ///< Mutex for locking the members list - /// This should be a std::shared_mutex as soon as C++17 is supported - - RoomImpl() - : random_gen(std::random_device()()), NintendoOUI{0x00, 0x1F, 0x32, 0x00, 0x00, 0x00} {} - - /// Thread that receives and dispatches network packets - std::unique_ptr room_thread; - - /// Thread function that will receive and dispatch messages until the room is destroyed. - void ServerLoop(); - void StartLoop(); - - /** - * Parses and answers a room join request from a client. - * Validates the uniqueness of the username and assigns the MAC address - * that the client will use for the remainder of the connection. - */ - void HandleJoinRequest(const ENetEvent* event); - - /** - * Returns whether the nickname is valid, ie. isn't already taken by someone else in the room. - */ - bool IsValidNickname(const std::string& nickname) const; - - /** - * Returns whether the MAC address is valid, ie. isn't already taken by someone else in the - * room. - */ - bool IsValidMacAddress(const MacAddress& address) const; - - /** - * Sends a ID_ROOM_NAME_COLLISION message telling the client that the name is invalid. - */ - void SendNameCollision(ENetPeer* client); - - /** - * Sends a ID_ROOM_MAC_COLLISION message telling the client that the MAC is invalid. - */ - void SendMacCollision(ENetPeer* client); - - /** - * Sends a ID_ROOM_VERSION_MISMATCH message telling the client that the version is invalid. - */ - void SendVersionMismatch(ENetPeer* client); - - /** - * Notifies the member that its connection attempt was successful, - * and it is now part of the room. - */ - void SendJoinSuccess(ENetPeer* client, MacAddress mac_address); - - /** - * Notifies the members that the room is closed, - */ - void SendCloseMessage(); - - /** - * Sends the information about the room, along with the list of members - * to every connected client in the room. - * The packet has the structure: - * ID_ROOM_INFORMATION - * room_name - * member_slots: The max number of clients allowed in this room - * num_members: the number of currently joined clients - * This is followed by the following three values for each member: - * nickname of that member - * mac_address of that member - * game_name of that member - */ - void BroadcastRoomInformation(); - - /** - * Generates a free MAC address to assign to a new client. - * The first 3 bytes are the NintendoOUI 0x00, 0x1F, 0x32 - */ - MacAddress GenerateMacAddress(); - - /** - * Broadcasts this packet to all members except the sender. - * @param event The ENet event containing the data - */ - void HandleWifiPacket(const ENetEvent* event); - - /** - * Extracts a chat entry from a received ENet packet and adds it to the chat queue. - * @param event The ENet event that was received. - */ - void HandleChatPacket(const ENetEvent* event); - - /** - * Extracts the game name from a received ENet packet and broadcasts it. - * @param event The ENet event that was received. - */ - void HandleGameNamePacket(const ENetEvent* event); - - /** - * Removes the client from the members list if it was in it and announces the change - * to all other clients. - */ - void HandleClientDisconnection(ENetPeer* client); -}; - -// RoomImpl -void Room::RoomImpl::ServerLoop() { - while (state != State::Closed) { - ENetEvent event; - if (enet_host_service(server, &event, 100) > 0) { - switch (event.type) { - case ENET_EVENT_TYPE_RECEIVE: - switch (event.packet->data[0]) { - case IdJoinRequest: - HandleJoinRequest(&event); - break; - case IdSetGameInfo: - HandleGameNamePacket(&event); - break; - case IdWifiPacket: - HandleWifiPacket(&event); - break; - case IdChatMessage: - HandleChatPacket(&event); - break; - } - enet_packet_destroy(event.packet); - break; - case ENET_EVENT_TYPE_DISCONNECT: - HandleClientDisconnection(event.peer); - break; - } - } - } - // Close the connection to all members: - SendCloseMessage(); -} - -void Room::RoomImpl::StartLoop() { - room_thread = std::make_unique(&Room::RoomImpl::ServerLoop, this); -} - -void Room::RoomImpl::HandleJoinRequest(const ENetEvent* event) { - Packet packet; - packet.Append(event->packet->data, event->packet->dataLength); - packet.IgnoreBytes(sizeof(u8)); // Igonore the message type - std::string nickname; - packet >> nickname; - - MacAddress preferred_mac; - packet >> preferred_mac; - - u32 client_version; - packet >> client_version; - - if (!IsValidNickname(nickname)) { - SendNameCollision(event->peer); - return; - } - - if (preferred_mac != NoPreferredMac) { - // Verify if the preferred mac is available - if (!IsValidMacAddress(preferred_mac)) { - SendMacCollision(event->peer); - return; - } - } else { - // Assign a MAC address of this client automatically - preferred_mac = GenerateMacAddress(); - } - - if (client_version != network_version) { - SendVersionMismatch(event->peer); - return; - } - - // At this point the client is ready to be added to the room. - Member member{}; - member.mac_address = preferred_mac; - member.nickname = nickname; - member.peer = event->peer; - - { - std::lock_guard lock(member_mutex); - members.push_back(std::move(member)); - } - - // Notify everyone that the room information has changed. - BroadcastRoomInformation(); - SendJoinSuccess(event->peer, preferred_mac); -} - -bool Room::RoomImpl::IsValidNickname(const std::string& nickname) const { - // A nickname is valid if it is not already taken by anybody else in the room. - // TODO(B3N30): Check for empty names, spaces, etc. - std::lock_guard lock(member_mutex); - return std::all_of(members.begin(), members.end(), - [&nickname](const auto& member) { return member.nickname != nickname; }); -} - -bool Room::RoomImpl::IsValidMacAddress(const MacAddress& address) const { - // A MAC address is valid if it is not already taken by anybody else in the room. - std::lock_guard lock(member_mutex); - return std::all_of(members.begin(), members.end(), - [&address](const auto& member) { return member.mac_address != address; }); -} - -void Room::RoomImpl::SendNameCollision(ENetPeer* client) { - Packet packet; - packet << static_cast(IdNameCollision); - - ENetPacket* enet_packet = - enet_packet_create(packet.GetData(), packet.GetDataSize(), ENET_PACKET_FLAG_RELIABLE); - enet_peer_send(client, 0, enet_packet); - enet_host_flush(server); -} - -void Room::RoomImpl::SendMacCollision(ENetPeer* client) { - Packet packet; - packet << static_cast(IdMacCollision); - - ENetPacket* enet_packet = - enet_packet_create(packet.GetData(), packet.GetDataSize(), ENET_PACKET_FLAG_RELIABLE); - enet_peer_send(client, 0, enet_packet); - enet_host_flush(server); -} - -void Room::RoomImpl::SendVersionMismatch(ENetPeer* client) { - Packet packet; - packet << static_cast(IdVersionMismatch); - packet << network_version; - - ENetPacket* enet_packet = - enet_packet_create(packet.GetData(), packet.GetDataSize(), ENET_PACKET_FLAG_RELIABLE); - enet_peer_send(client, 0, enet_packet); - enet_host_flush(server); -} - -void Room::RoomImpl::SendJoinSuccess(ENetPeer* client, MacAddress mac_address) { - Packet packet; - packet << static_cast(IdJoinSuccess); - packet << mac_address; - ENetPacket* enet_packet = - enet_packet_create(packet.GetData(), packet.GetDataSize(), ENET_PACKET_FLAG_RELIABLE); - enet_peer_send(client, 0, enet_packet); - enet_host_flush(server); -} - -void Room::RoomImpl::SendCloseMessage() { - Packet packet; - packet << static_cast(IdCloseRoom); - ENetPacket* enet_packet = - enet_packet_create(packet.GetData(), packet.GetDataSize(), ENET_PACKET_FLAG_RELIABLE); - std::lock_guard lock(member_mutex); - for (auto& member : members) { - enet_peer_send(member.peer, 0, enet_packet); - } - enet_host_flush(server); - for (auto& member : members) { - enet_peer_disconnect(member.peer, 0); - } -} - -void Room::RoomImpl::BroadcastRoomInformation() { - Packet packet; - packet << static_cast(IdRoomInformation); - packet << room_information.name; - packet << room_information.member_slots; - - packet << static_cast(members.size()); - { - std::lock_guard lock(member_mutex); - for (const auto& member : members) { - packet << member.nickname; - packet << member.mac_address; - packet << member.game_info.name; - packet << member.game_info.id; - } - } - - ENetPacket* enet_packet = - enet_packet_create(packet.GetData(), packet.GetDataSize(), ENET_PACKET_FLAG_RELIABLE); - enet_host_broadcast(server, 0, enet_packet); - enet_host_flush(server); -} - -MacAddress Room::RoomImpl::GenerateMacAddress() { - MacAddress result_mac = - NintendoOUI; // The first three bytes of each MAC address will be the NintendoOUI - std::uniform_int_distribution<> dis(0x00, 0xFF); // Random byte between 0 and 0xFF - do { - for (size_t i = 3; i < result_mac.size(); ++i) { - result_mac[i] = dis(random_gen); - } - } while (!IsValidMacAddress(result_mac)); - return result_mac; -} - -void Room::RoomImpl::HandleWifiPacket(const ENetEvent* event) { - Packet in_packet; - in_packet.Append(event->packet->data, event->packet->dataLength); - in_packet.IgnoreBytes(sizeof(u8)); // Message type - in_packet.IgnoreBytes(sizeof(u8)); // WifiPacket Type - in_packet.IgnoreBytes(sizeof(u8)); // WifiPacket Channel - in_packet.IgnoreBytes(sizeof(MacAddress)); // WifiPacket Transmitter Address - MacAddress destination_address; - in_packet >> destination_address; - - Packet out_packet; - out_packet.Append(event->packet->data, event->packet->dataLength); - ENetPacket* enet_packet = enet_packet_create(out_packet.GetData(), out_packet.GetDataSize(), - ENET_PACKET_FLAG_RELIABLE); - - if (destination_address == BroadcastMac) { // Send the data to everyone except the sender - std::lock_guard lock(member_mutex); - for (const auto& member : members) { - if (member.peer != event->peer) - enet_peer_send(member.peer, 0, enet_packet); - } - } else { // Send the data only to the destination client - std::lock_guard lock(member_mutex); - auto member = std::find_if(members.begin(), members.end(), - [destination_address](const Member& member) -> bool { - return member.mac_address == destination_address; - }); - if (member != members.end()) { - enet_peer_send(member->peer, 0, enet_packet); - } - } - enet_host_flush(server); -} - -void Room::RoomImpl::HandleChatPacket(const ENetEvent* event) { - Packet in_packet; - in_packet.Append(event->packet->data, event->packet->dataLength); - - in_packet.IgnoreBytes(sizeof(u8)); // Igonore the message type - std::string message; - in_packet >> message; - auto CompareNetworkAddress = [event](const Member member) -> bool { - return member.peer == event->peer; - }; - - std::lock_guard lock(member_mutex); - const auto sending_member = std::find_if(members.begin(), members.end(), CompareNetworkAddress); - if (sending_member == members.end()) { - return; // Received a chat message from a unknown sender - } - - Packet out_packet; - out_packet << static_cast(IdChatMessage); - out_packet << sending_member->nickname; - out_packet << message; - - ENetPacket* enet_packet = enet_packet_create(out_packet.GetData(), out_packet.GetDataSize(), - ENET_PACKET_FLAG_RELIABLE); - for (const auto& member : members) { - if (member.peer != event->peer) - enet_peer_send(member.peer, 0, enet_packet); - } - enet_host_flush(server); -} - -void Room::RoomImpl::HandleGameNamePacket(const ENetEvent* event) { - Packet in_packet; - in_packet.Append(event->packet->data, event->packet->dataLength); - - in_packet.IgnoreBytes(sizeof(u8)); // Igonore the message type - GameInfo game_info; - in_packet >> game_info.name; - in_packet >> game_info.id; - - { - std::lock_guard lock(member_mutex); - auto member = - std::find_if(members.begin(), members.end(), [event](const Member& member) -> bool { - return member.peer == event->peer; - }); - if (member != members.end()) { - member->game_info = game_info; - } - } - BroadcastRoomInformation(); -} - -void Room::RoomImpl::HandleClientDisconnection(ENetPeer* client) { - // Remove the client from the members list. - { - std::lock_guard lock(member_mutex); - members.erase( - std::remove_if(members.begin(), members.end(), - [client](const Member& member) { return member.peer == client; }), - members.end()); - } - - // Announce the change to all clients. - enet_peer_disconnect(client, 0); - BroadcastRoomInformation(); -} - -// Room -Room::Room() : room_impl{std::make_unique()} {} - -Room::~Room() = default; - -void Room::Create(const std::string& name, const std::string& server_address, u16 server_port) { - ENetAddress address; - address.host = ENET_HOST_ANY; - if (!server_address.empty()) { - enet_address_set_host(&address, server_address.c_str()); - } - address.port = server_port; - - room_impl->server = enet_host_create(&address, MaxConcurrentConnections, NumChannels, 0, 0); - // TODO(B3N30): Allow specifying the maximum number of concurrent connections. - room_impl->state = State::Open; - - room_impl->room_information.name = name; - room_impl->room_information.member_slots = MaxConcurrentConnections; - room_impl->StartLoop(); -} - -Room::State Room::GetState() const { - return room_impl->state; -} - -const RoomInformation& Room::GetRoomInformation() const { - return room_impl->room_information; -} - -std::vector Room::GetRoomMemberList() const { - std::vector member_list; - std::lock_guard lock(room_impl->member_mutex); - for (const auto& member_impl : room_impl->members) { - Member member; - member.nickname = member_impl.nickname; - member.mac_address = member_impl.mac_address; - member.game_info = member_impl.game_info; - member_list.push_back(member); - } - return member_list; -}; - -void Room::Destroy() { - room_impl->state = State::Closed; - room_impl->room_thread->join(); - room_impl->room_thread.reset(); - - if (room_impl->server) { - enet_host_destroy(room_impl->server); - } - room_impl->room_information = {}; - room_impl->server = nullptr; - { - std::lock_guard lock(room_impl->member_mutex); - room_impl->members.clear(); - } - room_impl->room_information.member_slots = 0; - room_impl->room_information.name.clear(); -} - -} // namespace Network diff --git a/src/network/room.h b/src/network/room.h deleted file mode 100644 index 8285a4d0c..000000000 --- a/src/network/room.h +++ /dev/null @@ -1,101 +0,0 @@ -// Copyright 2017 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include -#include -#include -#include "common/common_types.h" - -namespace Network { - -constexpr u32 network_version = 1; ///< The version of this Room and RoomMember - -constexpr u16 DefaultRoomPort = 1234; -constexpr size_t NumChannels = 1; // Number of channels used for the connection - -struct RoomInformation { - std::string name; ///< Name of the server - u32 member_slots; ///< Maximum number of members in this room -}; - -struct GameInfo { - std::string name{""}; - u64 id{0}; -}; - -using MacAddress = std::array; -/// A special MAC address that tells the room we're joining to assign us a MAC address -/// automatically. -constexpr MacAddress NoPreferredMac = {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF}; - -// 802.11 broadcast MAC address -constexpr MacAddress BroadcastMac = {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF}; - -// The different types of messages that can be sent. The first byte of each packet defines the type -enum RoomMessageTypes : u8 { - IdJoinRequest = 1, - IdJoinSuccess, - IdRoomInformation, - IdSetGameInfo, - IdWifiPacket, - IdChatMessage, - IdNameCollision, - IdMacCollision, - IdVersionMismatch, - IdCloseRoom -}; - -/// This is what a server [person creating a server] would use. -class Room final { -public: - enum class State : u8 { - Open, ///< The room is open and ready to accept connections. - Closed, ///< The room is not opened and can not accept connections. - }; - - struct Member { - std::string nickname; ///< The nickname of the member. - GameInfo game_info; ///< The current game of the member - MacAddress mac_address; ///< The assigned mac address of the member. - }; - - Room(); - ~Room(); - - /** - * Gets the current state of the room. - */ - State GetState() const; - - /** - * Gets the room information of the room. - */ - const RoomInformation& GetRoomInformation() const; - - /** - * Gets a list of the mbmers connected to the room. - */ - std::vector GetRoomMemberList() const; - - /** - * Creates the socket for this room. Will bind to default address if - * server is empty string. - */ - void Create(const std::string& name, const std::string& server = "", - u16 server_port = DefaultRoomPort); - - /** - * Destroys the socket - */ - void Destroy(); - -private: - class RoomImpl; - std::unique_ptr room_impl; -}; - -} // namespace Network diff --git a/src/network/room_member.cpp b/src/network/room_member.cpp deleted file mode 100644 index f229ec6fd..000000000 --- a/src/network/room_member.cpp +++ /dev/null @@ -1,490 +0,0 @@ -// Copyright 2017 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#include -#include -#include -#include -#include -#include "common/assert.h" -#include "enet/enet.h" -#include "network/packet.h" -#include "network/room_member.h" - -namespace Network { - -constexpr u32 ConnectionTimeoutMs = 5000; - -class RoomMember::RoomMemberImpl { -public: - ENetHost* client = nullptr; ///< ENet network interface. - ENetPeer* server = nullptr; ///< The server peer the client is connected to - - /// Information about the clients connected to the same room as us. - MemberList member_information; - /// Information about the room we're connected to. - RoomInformation room_information; - - /// The current game name, id and version - GameInfo current_game_info; - - std::atomic state{State::Idle}; ///< Current state of the RoomMember. - void SetState(const State new_state); - bool IsConnected() const; - - std::string nickname; ///< The nickname of this member. - MacAddress mac_address; ///< The mac_address of this member. - - std::mutex network_mutex; ///< Mutex that controls access to the `client` variable. - /// Thread that receives and dispatches network packets - std::unique_ptr loop_thread; - std::mutex send_list_mutex; ///< Mutex that controls access to the `send_list` variable. - std::list send_list; ///< A list that stores all packets to send the async - - template - using CallbackSet = std::set>; - std::mutex callback_mutex; ///< The mutex used for handling callbacks - - class Callbacks { - public: - template - CallbackSet& Get(); - - private: - CallbackSet callback_set_wifi_packet; - CallbackSet callback_set_chat_messages; - CallbackSet callback_set_room_information; - CallbackSet callback_set_state; - }; - Callbacks callbacks; ///< All CallbackSets to all events - - void MemberLoop(); - - void StartLoop(); - - /** - * Sends data to the room. It will be send on channel 0 with flag RELIABLE - * @param packet The data to send - */ - void Send(Packet&& packet); - - /** - * Sends a request to the server, asking for permission to join a room with the specified - * nickname and preferred mac. - * @params nickname The desired nickname. - * @params preferred_mac The preferred MAC address to use in the room, the NoPreferredMac tells - * the server to assign one for us. - */ - void SendJoinRequest(const std::string& nickname, - const MacAddress& preferred_mac = NoPreferredMac); - - /** - * Extracts a MAC Address from a received ENet packet. - * @param event The ENet event that was received. - */ - void HandleJoinPacket(const ENetEvent* event); - /** - * Extracts RoomInformation and MemberInformation from a received RakNet packet. - * @param event The ENet event that was received. - */ - void HandleRoomInformationPacket(const ENetEvent* event); - - /** - * Extracts a WifiPacket from a received ENet packet. - * @param event The ENet event that was received. - */ - void HandleWifiPackets(const ENetEvent* event); - - /** - * Extracts a chat entry from a received ENet packet and adds it to the chat queue. - * @param event The ENet event that was received. - */ - void HandleChatPacket(const ENetEvent* event); - - /** - * Disconnects the RoomMember from the Room - */ - void Disconnect(); - - template - void Invoke(const T& data); - - template - CallbackHandle Bind(std::function callback); -}; - -// RoomMemberImpl -void RoomMember::RoomMemberImpl::SetState(const State new_state) { - if (state != new_state) { - state = new_state; - Invoke(state); - } -} - -bool RoomMember::RoomMemberImpl::IsConnected() const { - return state == State::Joining || state == State::Joined; -} - -void RoomMember::RoomMemberImpl::MemberLoop() { - // Receive packets while the connection is open - while (IsConnected()) { - std::lock_guard lock(network_mutex); - ENetEvent event; - if (enet_host_service(client, &event, 100) > 0) { - switch (event.type) { - case ENET_EVENT_TYPE_RECEIVE: - switch (event.packet->data[0]) { - case IdWifiPacket: - HandleWifiPackets(&event); - break; - case IdChatMessage: - HandleChatPacket(&event); - break; - case IdRoomInformation: - HandleRoomInformationPacket(&event); - break; - case IdJoinSuccess: - // The join request was successful, we are now in the room. - // If we joined successfully, there must be at least one client in the room: us. - ASSERT_MSG(member_information.size() > 0, - "We have not yet received member information."); - HandleJoinPacket(&event); // Get the MAC Address for the client - SetState(State::Joined); - break; - case IdNameCollision: - SetState(State::NameCollision); - break; - case IdMacCollision: - SetState(State::MacCollision); - break; - case IdVersionMismatch: - SetState(State::WrongVersion); - break; - case IdCloseRoom: - SetState(State::LostConnection); - break; - } - enet_packet_destroy(event.packet); - break; - case ENET_EVENT_TYPE_DISCONNECT: - SetState(State::LostConnection); - break; - } - } - { - std::lock_guard lock(send_list_mutex); - for (const auto& packet : send_list) { - ENetPacket* enetPacket = enet_packet_create(packet.GetData(), packet.GetDataSize(), - ENET_PACKET_FLAG_RELIABLE); - enet_peer_send(server, 0, enetPacket); - } - enet_host_flush(client); - send_list.clear(); - } - } - Disconnect(); -}; - -void RoomMember::RoomMemberImpl::StartLoop() { - loop_thread = std::make_unique(&RoomMember::RoomMemberImpl::MemberLoop, this); -} - -void RoomMember::RoomMemberImpl::Send(Packet&& packet) { - std::lock_guard lock(send_list_mutex); - send_list.push_back(std::move(packet)); -} - -void RoomMember::RoomMemberImpl::SendJoinRequest(const std::string& nickname, - const MacAddress& preferred_mac) { - Packet packet; - packet << static_cast(IdJoinRequest); - packet << nickname; - packet << preferred_mac; - packet << network_version; - Send(std::move(packet)); -} - -void RoomMember::RoomMemberImpl::HandleRoomInformationPacket(const ENetEvent* event) { - Packet packet; - packet.Append(event->packet->data, event->packet->dataLength); - - // Ignore the first byte, which is the message id. - packet.IgnoreBytes(sizeof(u8)); // Igonore the message type - - RoomInformation info{}; - packet >> info.name; - packet >> info.member_slots; - room_information.name = info.name; - room_information.member_slots = info.member_slots; - - u32 num_members; - packet >> num_members; - member_information.resize(num_members); - - for (auto& member : member_information) { - packet >> member.nickname; - packet >> member.mac_address; - packet >> member.game_info.name; - packet >> member.game_info.id; - } - Invoke(room_information); -} - -void RoomMember::RoomMemberImpl::HandleJoinPacket(const ENetEvent* event) { - Packet packet; - packet.Append(event->packet->data, event->packet->dataLength); - - // Ignore the first byte, which is the message id. - packet.IgnoreBytes(sizeof(u8)); // Igonore the message type - - // Parse the MAC Address from the packet - packet >> mac_address; - SetState(State::Joined); -} - -void RoomMember::RoomMemberImpl::HandleWifiPackets(const ENetEvent* event) { - WifiPacket wifi_packet{}; - Packet packet; - packet.Append(event->packet->data, event->packet->dataLength); - - // Ignore the first byte, which is the message id. - packet.IgnoreBytes(sizeof(u8)); // Igonore the message type - - // Parse the WifiPacket from the packet - u8 frame_type; - packet >> frame_type; - WifiPacket::PacketType type = static_cast(frame_type); - - wifi_packet.type = type; - packet >> wifi_packet.channel; - packet >> wifi_packet.transmitter_address; - packet >> wifi_packet.destination_address; - - u32 data_length; - packet >> data_length; - - packet >> wifi_packet.data; - - Invoke(wifi_packet); -} - -void RoomMember::RoomMemberImpl::HandleChatPacket(const ENetEvent* event) { - Packet packet; - packet.Append(event->packet->data, event->packet->dataLength); - - // Ignore the first byte, which is the message id. - packet.IgnoreBytes(sizeof(u8)); - - ChatEntry chat_entry{}; - packet >> chat_entry.nickname; - packet >> chat_entry.message; - Invoke(chat_entry); -} - -void RoomMember::RoomMemberImpl::Disconnect() { - member_information.clear(); - room_information.member_slots = 0; - room_information.name.clear(); - - if (!server) - return; - enet_peer_disconnect(server, 0); - - ENetEvent event; - while (enet_host_service(client, &event, ConnectionTimeoutMs) > 0) { - switch (event.type) { - case ENET_EVENT_TYPE_RECEIVE: - enet_packet_destroy(event.packet); // Ignore all incoming data - break; - case ENET_EVENT_TYPE_DISCONNECT: - server = nullptr; - return; - } - } - // didn't disconnect gracefully force disconnect - enet_peer_reset(server); - server = nullptr; -} - -template <> -RoomMember::RoomMemberImpl::CallbackSet& RoomMember::RoomMemberImpl::Callbacks::Get() { - return callback_set_wifi_packet; -} - -template <> -RoomMember::RoomMemberImpl::CallbackSet& -RoomMember::RoomMemberImpl::Callbacks::Get() { - return callback_set_state; -} - -template <> -RoomMember::RoomMemberImpl::CallbackSet& -RoomMember::RoomMemberImpl::Callbacks::Get() { - return callback_set_room_information; -} - -template <> -RoomMember::RoomMemberImpl::CallbackSet& RoomMember::RoomMemberImpl::Callbacks::Get() { - return callback_set_chat_messages; -} - -template -void RoomMember::RoomMemberImpl::Invoke(const T& data) { - std::lock_guard lock(callback_mutex); - CallbackSet callback_set = callbacks.Get(); - for (auto const& callback : callback_set) - (*callback)(data); -} - -template -RoomMember::CallbackHandle RoomMember::RoomMemberImpl::Bind( - std::function callback) { - std::lock_guard lock(callback_mutex); - CallbackHandle handle; - handle = std::make_shared>(callback); - callbacks.Get().insert(handle); - return handle; -} - -// RoomMember -RoomMember::RoomMember() : room_member_impl{std::make_unique()} { - room_member_impl->client = enet_host_create(nullptr, 1, NumChannels, 0, 0); - ASSERT_MSG(room_member_impl->client != nullptr, "Could not create client"); -} - -RoomMember::~RoomMember() { - ASSERT_MSG(!IsConnected(), "RoomMember is being destroyed while connected"); - enet_host_destroy(room_member_impl->client); -} - -RoomMember::State RoomMember::GetState() const { - return room_member_impl->state; -} - -const RoomMember::MemberList& RoomMember::GetMemberInformation() const { - return room_member_impl->member_information; -} - -const std::string& RoomMember::GetNickname() const { - return room_member_impl->nickname; -} - -const MacAddress& RoomMember::GetMacAddress() const { - ASSERT_MSG(IsConnected(), "Tried to get MAC address while not connected"); - return room_member_impl->mac_address; -} - -RoomInformation RoomMember::GetRoomInformation() const { - return room_member_impl->room_information; -} - -void RoomMember::Join(const std::string& nick, const char* server_addr, u16 server_port, - u16 client_port, const MacAddress& preferred_mac) { - // If the member is connected, kill the connection first - if (room_member_impl->loop_thread && room_member_impl->loop_thread->joinable()) { - room_member_impl->SetState(State::Error); - room_member_impl->loop_thread->join(); - room_member_impl->loop_thread.reset(); - } - // If the thread isn't running but the ptr still exists, reset it - else if (room_member_impl->loop_thread) { - room_member_impl->loop_thread.reset(); - } - - ENetAddress address{}; - enet_address_set_host(&address, server_addr); - address.port = server_port; - room_member_impl->server = - enet_host_connect(room_member_impl->client, &address, NumChannels, 0); - - if (!room_member_impl->server) { - room_member_impl->SetState(State::Error); - return; - } - - ENetEvent event{}; - int net = enet_host_service(room_member_impl->client, &event, ConnectionTimeoutMs); - if (net > 0 && event.type == ENET_EVENT_TYPE_CONNECT) { - room_member_impl->nickname = nick; - room_member_impl->SetState(State::Joining); - room_member_impl->StartLoop(); - room_member_impl->SendJoinRequest(nick, preferred_mac); - SendGameInfo(room_member_impl->current_game_info); - } else { - room_member_impl->SetState(State::CouldNotConnect); - } -} - -bool RoomMember::IsConnected() const { - return room_member_impl->IsConnected(); -} - -void RoomMember::SendWifiPacket(const WifiPacket& wifi_packet) { - Packet packet; - packet << static_cast(IdWifiPacket); - packet << static_cast(wifi_packet.type); - packet << wifi_packet.channel; - packet << wifi_packet.transmitter_address; - packet << wifi_packet.destination_address; - packet << wifi_packet.data; - room_member_impl->Send(std::move(packet)); -} - -void RoomMember::SendChatMessage(const std::string& message) { - Packet packet; - packet << static_cast(IdChatMessage); - packet << message; - room_member_impl->Send(std::move(packet)); -} - -void RoomMember::SendGameInfo(const GameInfo& game_info) { - room_member_impl->current_game_info = game_info; - if (!IsConnected()) - return; - - Packet packet; - packet << static_cast(IdSetGameInfo); - packet << game_info.name; - packet << game_info.id; - room_member_impl->Send(std::move(packet)); -} - -RoomMember::CallbackHandle RoomMember::BindOnStateChanged( - std::function callback) { - return room_member_impl->Bind(callback); -} - -RoomMember::CallbackHandle RoomMember::BindOnWifiPacketReceived( - std::function callback) { - return room_member_impl->Bind(callback); -} - -RoomMember::CallbackHandle RoomMember::BindOnRoomInformationChanged( - std::function callback) { - return room_member_impl->Bind(callback); -} - -RoomMember::CallbackHandle RoomMember::BindOnChatMessageRecieved( - std::function callback) { - return room_member_impl->Bind(callback); -} - -template -void RoomMember::Unbind(CallbackHandle handle) { - std::lock_guard lock(room_member_impl->callback_mutex); - room_member_impl->callbacks.Get().erase(handle); -} - -void RoomMember::Leave() { - room_member_impl->SetState(State::Idle); - room_member_impl->loop_thread->join(); - room_member_impl->loop_thread.reset(); -} - -template void RoomMember::Unbind(CallbackHandle); -template void RoomMember::Unbind(CallbackHandle); -template void RoomMember::Unbind(CallbackHandle); -template void RoomMember::Unbind(CallbackHandle); - -} // namespace Network diff --git a/src/network/room_member.h b/src/network/room_member.h deleted file mode 100644 index 98770a234..000000000 --- a/src/network/room_member.h +++ /dev/null @@ -1,182 +0,0 @@ -// Copyright 2017 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include -#include -#include -#include "common/common_types.h" -#include "network/room.h" - -namespace Network { - -/// Information about the received WiFi packets. -/// Acts as our own 802.11 header. -struct WifiPacket { - enum class PacketType : u8 { Beacon, Data, Authentication, AssociationResponse }; - PacketType type; ///< The type of 802.11 frame. - std::vector data; ///< Raw 802.11 frame data, starting at the management frame header - /// for management frames. - MacAddress transmitter_address; ///< Mac address of the transmitter. - MacAddress destination_address; ///< Mac address of the receiver. - u8 channel; ///< WiFi channel where this frame was transmitted. -}; - -/// Represents a chat message. -struct ChatEntry { - std::string nickname; ///< Nickname of the client who sent this message. - std::string message; ///< Body of the message. -}; - -/** - * This is what a client [person joining a server] would use. - * It also has to be used if you host a game yourself (You'd create both, a Room and a - * RoomMembership for yourself) - */ -class RoomMember final { -public: - enum class State : u8 { - Idle, ///< Default state - Error, ///< Some error [permissions to network device missing or something] - Joining, ///< The client is attempting to join a room. - Joined, ///< The client is connected to the room and is ready to send/receive packets. - LostConnection, ///< Connection closed - - // Reasons why connection was rejected - NameCollision, ///< Somebody is already using this name - MacCollision, ///< Somebody is already using that mac-address - WrongVersion, ///< The room version is not the same as for this RoomMember - CouldNotConnect ///< The room is not responding to a connection attempt - }; - - struct MemberInformation { - std::string nickname; ///< Nickname of the member. - GameInfo game_info; ///< Name of the game they're currently playing, or empty if they're - /// not playing anything. - MacAddress mac_address; ///< MAC address associated with this member. - }; - using MemberList = std::vector; - - // The handle for the callback functions - template - using CallbackHandle = std::shared_ptr>; - - /** - * Unbinds a callback function from the events. - * @param handle The connection handle to disconnect - */ - template - void Unbind(CallbackHandle handle); - - RoomMember(); - ~RoomMember(); - - /** - * Returns the status of our connection to the room. - */ - State GetState() const; - - /** - * Returns information about the members in the room we're currently connected to. - */ - const MemberList& GetMemberInformation() const; - - /** - * Returns the nickname of the RoomMember. - */ - const std::string& GetNickname() const; - - /** - * Returns the MAC address of the RoomMember. - */ - const MacAddress& GetMacAddress() const; - - /** - * Returns information about the room we're currently connected to. - */ - RoomInformation GetRoomInformation() const; - - /** - * Returns whether we're connected to a server or not. - */ - bool IsConnected() const; - - /** - * Attempts to join a room at the specified address and port, using the specified nickname. - * This may fail if the username is already taken. - */ - void Join(const std::string& nickname, const char* server_addr = "127.0.0.1", - const u16 serverPort = DefaultRoomPort, const u16 clientPort = 0, - const MacAddress& preferred_mac = NoPreferredMac); - - /** - * Sends a WiFi packet to the room. - * @param packet The WiFi packet to send. - */ - void SendWifiPacket(const WifiPacket& packet); - - /** - * Sends a chat message to the room. - * @param message The contents of the message. - */ - void SendChatMessage(const std::string& message); - - /** - * Sends the current game info to the room. - * @param game_info The game information. - */ - void SendGameInfo(const GameInfo& game_info); - - /** - * Binds a function to an event that will be triggered every time the State of the member - * changed. The function wil be called every time the event is triggered. The callback function - * must not bind or unbind a function. Doing so will cause a deadlock - * @param callback The function to call - * @return A handle used for removing the function from the registered list - */ - CallbackHandle BindOnStateChanged(std::function callback); - - /** - * Binds a function to an event that will be triggered every time a WifiPacket is received. - * The function wil be called everytime the event is triggered. - * The callback function must not bind or unbind a function. Doing so will cause a deadlock - * @param callback The function to call - * @return A handle used for removing the function from the registered list - */ - CallbackHandle BindOnWifiPacketReceived( - std::function callback); - - /** - * Binds a function to an event that will be triggered every time the RoomInformation changes. - * The function wil be called every time the event is triggered. - * The callback function must not bind or unbind a function. Doing so will cause a deadlock - * @param callback The function to call - * @return A handle used for removing the function from the registered list - */ - CallbackHandle BindOnRoomInformationChanged( - std::function callback); - - /** - * Binds a function to an event that will be triggered every time a ChatMessage is received. - * The function wil be called every time the event is triggered. - * The callback function must not bind or unbind a function. Doing so will cause a deadlock - * @param callback The function to call - * @return A handle used for removing the function from the registered list - */ - CallbackHandle BindOnChatMessageRecieved( - std::function callback); - - /** - * Leaves the current room. - */ - void Leave(); - -private: - class RoomMemberImpl; - std::unique_ptr room_member_impl; -}; - -} // namespace Network diff --git a/src/web_service/CMakeLists.txt b/src/web_service/CMakeLists.txt deleted file mode 100644 index c93811892..000000000 --- a/src/web_service/CMakeLists.txt +++ /dev/null @@ -1,16 +0,0 @@ -set(SRCS - telemetry_json.cpp - verify_login.cpp - web_backend.cpp - ) - -set(HEADERS - telemetry_json.h - verify_login.h - web_backend.h - ) - -create_directory_groups(${SRCS} ${HEADERS}) - -add_library(web_service STATIC ${SRCS} ${HEADERS}) -target_link_libraries(web_service PUBLIC common cpr json-headers) diff --git a/src/web_service/telemetry_json.cpp b/src/web_service/telemetry_json.cpp deleted file mode 100644 index 6ad2ffcd4..000000000 --- a/src/web_service/telemetry_json.cpp +++ /dev/null @@ -1,86 +0,0 @@ -// Copyright 2017 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#include "common/assert.h" -#include "web_service/telemetry_json.h" -#include "web_service/web_backend.h" - -namespace WebService { - -template -void TelemetryJson::Serialize(Telemetry::FieldType type, const std::string& name, T value) { - sections[static_cast(type)][name] = value; -} - -void TelemetryJson::SerializeSection(Telemetry::FieldType type, const std::string& name) { - TopSection()[name] = sections[static_cast(type)]; -} - -void TelemetryJson::Visit(const Telemetry::Field& field) { - Serialize(field.GetType(), field.GetName(), field.GetValue()); -} - -void TelemetryJson::Visit(const Telemetry::Field& field) { - Serialize(field.GetType(), field.GetName(), field.GetValue()); -} - -void TelemetryJson::Visit(const Telemetry::Field& field) { - Serialize(field.GetType(), field.GetName(), field.GetValue()); -} - -void TelemetryJson::Visit(const Telemetry::Field& field) { - Serialize(field.GetType(), field.GetName(), field.GetValue()); -} - -void TelemetryJson::Visit(const Telemetry::Field& field) { - Serialize(field.GetType(), field.GetName(), field.GetValue()); -} - -void TelemetryJson::Visit(const Telemetry::Field& field) { - Serialize(field.GetType(), field.GetName(), field.GetValue()); -} - -void TelemetryJson::Visit(const Telemetry::Field& field) { - Serialize(field.GetType(), field.GetName(), field.GetValue()); -} - -void TelemetryJson::Visit(const Telemetry::Field& field) { - Serialize(field.GetType(), field.GetName(), field.GetValue()); -} - -void TelemetryJson::Visit(const Telemetry::Field& field) { - Serialize(field.GetType(), field.GetName(), field.GetValue()); -} - -void TelemetryJson::Visit(const Telemetry::Field& field) { - Serialize(field.GetType(), field.GetName(), field.GetValue()); -} - -void TelemetryJson::Visit(const Telemetry::Field& field) { - Serialize(field.GetType(), field.GetName(), field.GetValue()); -} - -void TelemetryJson::Visit(const Telemetry::Field& field) { - Serialize(field.GetType(), field.GetName(), field.GetValue()); -} - -void TelemetryJson::Visit(const Telemetry::Field& field) { - Serialize(field.GetType(), field.GetName(), std::string(field.GetValue())); -} - -void TelemetryJson::Visit(const Telemetry::Field& field) { - Serialize(field.GetType(), field.GetName(), field.GetValue().count()); -} - -void TelemetryJson::Complete() { - SerializeSection(Telemetry::FieldType::App, "App"); - SerializeSection(Telemetry::FieldType::Session, "Session"); - SerializeSection(Telemetry::FieldType::Performance, "Performance"); - SerializeSection(Telemetry::FieldType::UserFeedback, "UserFeedback"); - SerializeSection(Telemetry::FieldType::UserConfig, "UserConfig"); - SerializeSection(Telemetry::FieldType::UserSystem, "UserSystem"); - PostJson(endpoint_url, TopSection().dump(), true, username, token); -} - -} // namespace WebService diff --git a/src/web_service/telemetry_json.h b/src/web_service/telemetry_json.h deleted file mode 100644 index 9e78c6803..000000000 --- a/src/web_service/telemetry_json.h +++ /dev/null @@ -1,59 +0,0 @@ -// Copyright 2017 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include -#include -#include "common/telemetry.h" - -namespace WebService { - -/** - * Implementation of VisitorInterface that serialized telemetry into JSON, and submits it to the - * Citra web service - */ -class TelemetryJson : public Telemetry::VisitorInterface { -public: - TelemetryJson(const std::string& endpoint_url, const std::string& username, - const std::string& token) - : endpoint_url(endpoint_url), username(username), token(token) {} - ~TelemetryJson() = default; - - void Visit(const Telemetry::Field& field) override; - void Visit(const Telemetry::Field& field) override; - void Visit(const Telemetry::Field& field) override; - void Visit(const Telemetry::Field& field) override; - void Visit(const Telemetry::Field& field) override; - void Visit(const Telemetry::Field& field) override; - void Visit(const Telemetry::Field& field) override; - void Visit(const Telemetry::Field& field) override; - void Visit(const Telemetry::Field& field) override; - void Visit(const Telemetry::Field& field) override; - void Visit(const Telemetry::Field& field) override; - void Visit(const Telemetry::Field& field) override; - void Visit(const Telemetry::Field& field) override; - void Visit(const Telemetry::Field& field) override; - - void Complete() override; - -private: - nlohmann::json& TopSection() { - return sections[static_cast(Telemetry::FieldType::None)]; - } - - template - void Serialize(Telemetry::FieldType type, const std::string& name, T value); - - void SerializeSection(Telemetry::FieldType type, const std::string& name); - - nlohmann::json output; - std::array sections; - std::string endpoint_url; - std::string username; - std::string token; -}; - -} // namespace WebService diff --git a/src/web_service/verify_login.cpp b/src/web_service/verify_login.cpp deleted file mode 100644 index 1bc3b5afe..000000000 --- a/src/web_service/verify_login.cpp +++ /dev/null @@ -1,28 +0,0 @@ -// Copyright 2017 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#include -#include "web_service/verify_login.h" -#include "web_service/web_backend.h" - -namespace WebService { - -std::future VerifyLogin(std::string& username, std::string& token, - const std::string& endpoint_url, std::function func) { - auto get_func = [func, username](const std::string& reply) -> bool { - func(); - if (reply.empty()) - return false; - nlohmann::json json = nlohmann::json::parse(reply); - std::string result; - try { - result = json["username"]; - } catch (const nlohmann::detail::out_of_range&) { - } - return result == username; - }; - return GetJson(get_func, endpoint_url, false, username, token); -} - -} // namespace WebService diff --git a/src/web_service/verify_login.h b/src/web_service/verify_login.h deleted file mode 100644 index 303f5dbbc..000000000 --- a/src/web_service/verify_login.h +++ /dev/null @@ -1,24 +0,0 @@ -// Copyright 2017 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include -#include - -namespace WebService { - -/** - * Checks if username and token is valid - * @param username Citra username to use for authentication. - * @param token Citra token to use for authentication. - * @param endpoint_url URL of the services.citra-emu.org endpoint. - * @param func A function that gets exectued when the verification is finished - * @returns Future with bool indicating whether the verification succeeded - */ -std::future VerifyLogin(std::string& username, std::string& token, - const std::string& endpoint_url, std::function func); - -} // namespace WebService diff --git a/src/web_service/web_backend.cpp b/src/web_service/web_backend.cpp deleted file mode 100644 index b17d82f9c..000000000 --- a/src/web_service/web_backend.cpp +++ /dev/null @@ -1,140 +0,0 @@ -// Copyright 2017 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#ifdef _WIN32 -#include -#endif - -#include -#include -#include -#include "common/logging/log.h" -#include "web_service/web_backend.h" - -namespace WebService { - -static constexpr char API_VERSION[]{"1"}; - -static std::unique_ptr g_session; - -void Win32WSAStartup() { -#ifdef _WIN32 - // On Windows, CPR/libcurl does not properly initialize Winsock. The below code is used to - // initialize Winsock globally, which fixes this problem. Without this, only the first CPR - // session will properly be created, and subsequent ones will fail. - WSADATA wsa_data; - const int wsa_result{WSAStartup(MAKEWORD(2, 2), &wsa_data)}; - if (wsa_result) { - LOG_CRITICAL(WebService, "WSAStartup failed: %d", wsa_result); - } -#endif -} - -void PostJson(const std::string& url, const std::string& data, bool allow_anonymous, - const std::string& username, const std::string& token) { - if (url.empty()) { - LOG_ERROR(WebService, "URL is invalid"); - return; - } - - const bool are_credentials_provided{!token.empty() && !username.empty()}; - if (!allow_anonymous && !are_credentials_provided) { - LOG_ERROR(WebService, "Credentials must be provided for authenticated requests"); - return; - } - - Win32WSAStartup(); - - // Built request header - cpr::Header header; - if (are_credentials_provided) { - // Authenticated request if credentials are provided - header = {{"Content-Type", "application/json"}, - {"x-username", username.c_str()}, - {"x-token", token.c_str()}, - {"api-version", API_VERSION}}; - } else { - // Otherwise, anonymous request - header = cpr::Header{{"Content-Type", "application/json"}, {"api-version", API_VERSION}}; - } - - // Post JSON asynchronously - static std::future future; - future = cpr::PostCallback( - [](cpr::Response r) { - if (r.error) { - LOG_ERROR(WebService, "POST returned cpr error: %u:%s", - static_cast(r.error.code), r.error.message.c_str()); - return; - } - if (r.status_code >= 400) { - LOG_ERROR(WebService, "POST returned error status code: %u", r.status_code); - return; - } - if (r.header["content-type"].find("application/json") == std::string::npos) { - LOG_ERROR(WebService, "POST returned wrong content: %s", - r.header["content-type"].c_str()); - return; - } - }, - cpr::Url{url}, cpr::Body{data}, header); -} - -template -std::future GetJson(std::function func, const std::string& url, - bool allow_anonymous, const std::string& username, - const std::string& token) { - if (url.empty()) { - LOG_ERROR(WebService, "URL is invalid"); - return std::async(std::launch::async, [func{std::move(func)}]() { return func(""); }); - } - - const bool are_credentials_provided{!token.empty() && !username.empty()}; - if (!allow_anonymous && !are_credentials_provided) { - LOG_ERROR(WebService, "Credentials must be provided for authenticated requests"); - return std::async(std::launch::async, [func{std::move(func)}]() { return func(""); }); - } - - Win32WSAStartup(); - - // Built request header - cpr::Header header; - if (are_credentials_provided) { - // Authenticated request if credentials are provided - header = {{"Content-Type", "application/json"}, - {"x-username", username.c_str()}, - {"x-token", token.c_str()}, - {"api-version", API_VERSION}}; - } else { - // Otherwise, anonymous request - header = cpr::Header{{"Content-Type", "application/json"}, {"api-version", API_VERSION}}; - } - - // Get JSON asynchronously - return cpr::GetCallback( - [func{std::move(func)}](cpr::Response r) { - if (r.error) { - LOG_ERROR(WebService, "GET returned cpr error: %u:%s", - static_cast(r.error.code), r.error.message.c_str()); - return func(""); - } - if (r.status_code >= 400) { - LOG_ERROR(WebService, "GET returned error code: %u", r.status_code); - return func(""); - } - if (r.header["content-type"].find("application/json") == std::string::npos) { - LOG_ERROR(WebService, "GET returned wrong content: %s", - r.header["content-type"].c_str()); - return func(""); - } - return func(r.text); - }, - cpr::Url{url}, header); -} - -template std::future GetJson(std::function func, - const std::string& url, bool allow_anonymous, - const std::string& username, const std::string& token); - -} // namespace WebService diff --git a/src/web_service/web_backend.h b/src/web_service/web_backend.h deleted file mode 100644 index a63c75d13..000000000 --- a/src/web_service/web_backend.h +++ /dev/null @@ -1,39 +0,0 @@ -// Copyright 2017 Citra Emulator Project -// Licensed under GPLv2 or any later version -// Refer to the license.txt file included. - -#pragma once - -#include -#include -#include -#include "common/common_types.h" - -namespace WebService { - -/** - * Posts JSON to services.citra-emu.org. - * @param url URL of the services.citra-emu.org endpoint to post data to. - * @param data String of JSON data to use for the body of the POST request. - * @param allow_anonymous If true, allow anonymous unauthenticated requests. - * @param username Citra username to use for authentication. - * @param token Citra token to use for authentication. - */ -void PostJson(const std::string& url, const std::string& data, bool allow_anonymous, - const std::string& username = {}, const std::string& token = {}); - -/** - * Gets JSON from services.citra-emu.org. - * @param func A function that gets exectued when the json as a string is received - * @param url URL of the services.citra-emu.org endpoint to post data to. - * @param allow_anonymous If true, allow anonymous unauthenticated requests. - * @param username Citra username to use for authentication. - * @param token Citra token to use for authentication. - * @return future that holds the return value T of the func - */ -template -std::future GetJson(std::function func, const std::string& url, - bool allow_anonymous, const std::string& username = {}, - const std::string& token = {}); - -} // namespace WebService diff --git a/src/yuzu/CMakeLists.txt b/src/yuzu/CMakeLists.txt new file mode 100644 index 000000000..38bbc0043 --- /dev/null +++ b/src/yuzu/CMakeLists.txt @@ -0,0 +1,116 @@ +set(CMAKE_AUTOMOC ON) +set(CMAKE_AUTORCC ON) +set(CMAKE_INCLUDE_CURRENT_DIR ON) +set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} ${PROJECT_SOURCE_DIR}/CMakeModules) + +set(SRCS + configuration/config.cpp + configuration/configure_audio.cpp + configuration/configure_debug.cpp + configuration/configure_dialog.cpp + configuration/configure_general.cpp + configuration/configure_graphics.cpp + configuration/configure_input.cpp + configuration/configure_system.cpp + configuration/configure_web.cpp + debugger/graphics/graphics.cpp + debugger/graphics/graphics_breakpoint_observer.cpp + debugger/graphics/graphics_breakpoints.cpp + debugger/graphics/graphics_cmdlists.cpp + debugger/graphics/graphics_surface.cpp + debugger/graphics/graphics_tracing.cpp + debugger/graphics/graphics_vertex_shader.cpp + debugger/profiler.cpp + debugger/registers.cpp + debugger/wait_tree.cpp + util/spinbox.cpp + util/util.cpp + bootmanager.cpp + game_list.cpp + hotkeys.cpp + main.cpp + ui_settings.cpp + citra-qt.rc + Info.plist + ) + +set(HEADERS + configuration/config.h + configuration/configure_audio.h + configuration/configure_debug.h + configuration/configure_dialog.h + configuration/configure_general.h + configuration/configure_graphics.h + configuration/configure_input.h + configuration/configure_system.h + configuration/configure_web.h + debugger/graphics/graphics.h + debugger/graphics/graphics_breakpoint_observer.h + debugger/graphics/graphics_breakpoints.h + debugger/graphics/graphics_breakpoints_p.h + debugger/graphics/graphics_cmdlists.h + debugger/graphics/graphics_surface.h + debugger/graphics/graphics_tracing.h + debugger/graphics/graphics_vertex_shader.h + debugger/profiler.h + debugger/registers.h + debugger/wait_tree.h + util/spinbox.h + util/util.h + bootmanager.h + game_list.h + game_list_p.h + hotkeys.h + main.h + ui_settings.h + ) + +set(UIS + configuration/configure.ui + configuration/configure_audio.ui + configuration/configure_debug.ui + configuration/configure_general.ui + configuration/configure_graphics.ui + configuration/configure_input.ui + configuration/configure_system.ui + configuration/configure_web.ui + debugger/registers.ui + hotkeys.ui + main.ui + ) + +# file(GLOB_RECURSE ICONS ${CMAKE_SOURCE_DIR}/dist/icons/*) +file(GLOB_RECURSE THEMES ${CMAKE_SOURCE_DIR}/dist/qt_themes/*) + +create_directory_groups(${SRCS} ${HEADERS} ${UIS}) + +if (Qt5_FOUND) + qt5_wrap_ui(UI_HDRS ${UIS}) +else() + qt4_wrap_ui(UI_HDRS ${UIS}) +endif() + +if (APPLE) + set(MACOSX_ICON "../../dist/citra.icns") + set_source_files_properties(${MACOSX_ICON} PROPERTIES MACOSX_PACKAGE_LOCATION Resources) + add_executable(yuzu MACOSX_BUNDLE ${SRCS} ${HEADERS} ${UI_HDRS} ${MACOSX_ICON}) + set_target_properties(yuzu PROPERTIES MACOSX_BUNDLE_INFO_PLIST ${CMAKE_CURRENT_SOURCE_DIR}/Info.plist) +else() + add_executable(yuzu ${SRCS} ${HEADERS} ${UI_HDRS}) +endif() +target_link_libraries(yuzu PRIVATE common core input_common video_core) +target_link_libraries(yuzu PRIVATE Boost::boost glad Qt5::OpenGL Qt5::Widgets) +target_link_libraries(yuzu PRIVATE ${PLATFORM_LIBRARIES} Threads::Threads) + +if(UNIX AND NOT APPLE) + install(TARGETS yuzu RUNTIME DESTINATION "${CMAKE_INSTALL_PREFIX}/bin") +endif() + +if (MSVC) + include(CopyCitraQt5Deps) + include(CopyCitraSDLDeps) + include(CopyYuzuUnicornDeps) + copy_citra_Qt5_deps(yuzu) + copy_citra_SDL_deps(yuzu) + copy_yuzu_unicorn_deps(yuzu) +endif() diff --git a/src/yuzu/Info.plist b/src/yuzu/Info.plist new file mode 100644 index 000000000..7d46b39d1 --- /dev/null +++ b/src/yuzu/Info.plist @@ -0,0 +1,40 @@ + + + + + CFBundleDevelopmentRegion + English + CFBundleExecutable + ${EXECUTABLE_NAME} + CFBundleGetInfoString + + CFBundleIconFile + citra.icns + CFBundleIdentifier + com.citra-emu.citra + CFBundleInfoDictionaryVersion + 6.0 + CFBundleLongVersionString + + CFBundleName + Citra + CFBundlePackageType + APPL + CFBundleShortVersionString + + CFBundleSignature + ???? + CFBundleVersion + + CSResourcesFileMapped + + LSRequiresCarbon + + NSHumanReadableCopyright + + NSPrincipalClass + NSApplication + NSHighResolutionCapable + True + + diff --git a/src/yuzu/bootmanager.cpp b/src/yuzu/bootmanager.cpp new file mode 100644 index 000000000..eb542ad4e --- /dev/null +++ b/src/yuzu/bootmanager.cpp @@ -0,0 +1,310 @@ +#include +#include +#include + +#if QT_VERSION >= QT_VERSION_CHECK(5, 0, 0) +// Required for screen DPI information +#include +#include +#endif + +#include "citra_qt/bootmanager.h" +#include "common/microprofile.h" +#include "common/scm_rev.h" +#include "common/string_util.h" +#include "core/core.h" +#include "core/frontend/framebuffer_layout.h" +#include "core/settings.h" +#include "input_common/keyboard.h" +#include "input_common/main.h" +#include "input_common/motion_emu.h" +#include "network/network.h" + +EmuThread::EmuThread(GRenderWindow* render_window) + : exec_step(false), running(false), stop_run(false), render_window(render_window) {} + +void EmuThread::run() { + render_window->MakeCurrent(); + + MicroProfileOnThreadCreate("EmuThread"); + + stop_run = false; + + // holds whether the cpu was running during the last iteration, + // so that the DebugModeLeft signal can be emitted before the + // next execution step + bool was_active = false; + while (!stop_run) { + if (running) { + if (!was_active) + emit DebugModeLeft(); + + Core::System::ResultStatus result = Core::System::GetInstance().RunLoop(); + if (result != Core::System::ResultStatus::Success) { + emit ErrorThrown(result, Core::System::GetInstance().GetStatusDetails()); + } + + was_active = running || exec_step; + if (!was_active && !stop_run) + emit DebugModeEntered(); + } else if (exec_step) { + if (!was_active) + emit DebugModeLeft(); + + exec_step = false; + Core::System::GetInstance().SingleStep(); + emit DebugModeEntered(); + yieldCurrentThread(); + + was_active = false; + } else { + std::unique_lock lock(running_mutex); + running_cv.wait(lock, [this] { return IsRunning() || exec_step || stop_run; }); + } + } + + // Shutdown the core emulation + Core::System::GetInstance().Shutdown(); + +#if MICROPROFILE_ENABLED + MicroProfileOnThreadExit(); +#endif + + render_window->moveContext(); +} + +// This class overrides paintEvent and resizeEvent to prevent the GUI thread from stealing GL +// context. +// The corresponding functionality is handled in EmuThread instead +class GGLWidgetInternal : public QGLWidget { +public: + GGLWidgetInternal(QGLFormat fmt, GRenderWindow* parent) + : QGLWidget(fmt, parent), parent(parent) {} + + void paintEvent(QPaintEvent* ev) override { + if (do_painting) { + QPainter painter(this); + } + } + + void resizeEvent(QResizeEvent* ev) override { + parent->OnClientAreaResized(ev->size().width(), ev->size().height()); + parent->OnFramebufferSizeChanged(); + } + + void DisablePainting() { + do_painting = false; + } + void EnablePainting() { + do_painting = true; + } + +private: + GRenderWindow* parent; + bool do_painting; +}; + +GRenderWindow::GRenderWindow(QWidget* parent, EmuThread* emu_thread) + : QWidget(parent), child(nullptr), emu_thread(emu_thread) { + + std::string window_title = Common::StringFromFormat("Citra %s| %s-%s", Common::g_build_name, + Common::g_scm_branch, Common::g_scm_desc); + setWindowTitle(QString::fromStdString(window_title)); + + InputCommon::Init(); + Network::Init(); +} + +GRenderWindow::~GRenderWindow() { + InputCommon::Shutdown(); + Network::Shutdown(); +} + +void GRenderWindow::moveContext() { + DoneCurrent(); +// We need to move GL context to the swapping thread in Qt5 +#if QT_VERSION > QT_VERSION_CHECK(5, 0, 0) + // If the thread started running, move the GL Context to the new thread. Otherwise, move it + // back. + auto thread = (QThread::currentThread() == qApp->thread() && emu_thread != nullptr) + ? emu_thread + : qApp->thread(); + child->context()->moveToThread(thread); +#endif +} + +void GRenderWindow::SwapBuffers() { +#if !defined(QT_NO_DEBUG) + // Qt debug runtime prints a bogus warning on the console if you haven't called makeCurrent + // since the last time you called swapBuffers. This presumably means something if you're using + // QGLWidget the "regular" way, but in our multi-threaded use case is harmless since we never + // call doneCurrent in this thread. + child->makeCurrent(); +#endif + child->swapBuffers(); +} + +void GRenderWindow::MakeCurrent() { + child->makeCurrent(); +} + +void GRenderWindow::DoneCurrent() { + child->doneCurrent(); +} + +void GRenderWindow::PollEvents() {} + +// On Qt 5.0+, this correctly gets the size of the framebuffer (pixels). +// +// Older versions get the window size (density independent pixels), +// and hence, do not support DPI scaling ("retina" displays). +// The result will be a viewport that is smaller than the extent of the window. +void GRenderWindow::OnFramebufferSizeChanged() { + // Screen changes potentially incur a change in screen DPI, hence we should update the + // framebuffer size + qreal pixelRatio = windowPixelRatio(); + unsigned width = child->QPaintDevice::width() * pixelRatio; + unsigned height = child->QPaintDevice::height() * pixelRatio; + UpdateCurrentFramebufferLayout(width, height); +} + +void GRenderWindow::BackupGeometry() { + geometry = ((QGLWidget*)this)->saveGeometry(); +} + +void GRenderWindow::RestoreGeometry() { + // We don't want to back up the geometry here (obviously) + QWidget::restoreGeometry(geometry); +} + +void GRenderWindow::restoreGeometry(const QByteArray& geometry) { + // Make sure users of this class don't need to deal with backing up the geometry themselves + QWidget::restoreGeometry(geometry); + BackupGeometry(); +} + +QByteArray GRenderWindow::saveGeometry() { + // If we are a top-level widget, store the current geometry + // otherwise, store the last backup + if (parent() == nullptr) + return ((QGLWidget*)this)->saveGeometry(); + else + return geometry; +} + +qreal GRenderWindow::windowPixelRatio() { +#if QT_VERSION >= QT_VERSION_CHECK(5, 0, 0) + // windowHandle() might not be accessible until the window is displayed to screen. + return windowHandle() ? windowHandle()->screen()->devicePixelRatio() : 1.0f; +#else + return 1.0f; +#endif +} + +void GRenderWindow::closeEvent(QCloseEvent* event) { + emit Closed(); + QWidget::closeEvent(event); +} + +void GRenderWindow::keyPressEvent(QKeyEvent* event) { + InputCommon::GetKeyboard()->PressKey(event->key()); +} + +void GRenderWindow::keyReleaseEvent(QKeyEvent* event) { + InputCommon::GetKeyboard()->ReleaseKey(event->key()); +} + +void GRenderWindow::mousePressEvent(QMouseEvent* event) { + auto pos = event->pos(); + if (event->button() == Qt::LeftButton) { + qreal pixelRatio = windowPixelRatio(); + this->TouchPressed(static_cast(pos.x() * pixelRatio), + static_cast(pos.y() * pixelRatio)); + } else if (event->button() == Qt::RightButton) { + InputCommon::GetMotionEmu()->BeginTilt(pos.x(), pos.y()); + } +} + +void GRenderWindow::mouseMoveEvent(QMouseEvent* event) { + auto pos = event->pos(); + qreal pixelRatio = windowPixelRatio(); + this->TouchMoved(std::max(static_cast(pos.x() * pixelRatio), 0u), + std::max(static_cast(pos.y() * pixelRatio), 0u)); + InputCommon::GetMotionEmu()->Tilt(pos.x(), pos.y()); +} + +void GRenderWindow::mouseReleaseEvent(QMouseEvent* event) { + if (event->button() == Qt::LeftButton) + this->TouchReleased(); + else if (event->button() == Qt::RightButton) + InputCommon::GetMotionEmu()->EndTilt(); +} + +void GRenderWindow::focusOutEvent(QFocusEvent* event) { + QWidget::focusOutEvent(event); + InputCommon::GetKeyboard()->ReleaseAllKeys(); +} + +void GRenderWindow::OnClientAreaResized(unsigned width, unsigned height) { + NotifyClientAreaSizeChanged(std::make_pair(width, height)); +} + +void GRenderWindow::InitRenderTarget() { + if (child) { + delete child; + } + + if (layout()) { + delete layout(); + } + + // TODO: One of these flags might be interesting: WA_OpaquePaintEvent, WA_NoBackground, + // WA_DontShowOnScreen, WA_DeleteOnClose + QGLFormat fmt; + fmt.setVersion(3, 3); + fmt.setProfile(QGLFormat::CoreProfile); + fmt.setSwapInterval(Settings::values.use_vsync); + + // Requests a forward-compatible context, which is required to get a 3.2+ context on OS X + fmt.setOption(QGL::NoDeprecatedFunctions); + + child = new GGLWidgetInternal(fmt, this); + QBoxLayout* layout = new QHBoxLayout(this); + + resize(Layout::ScreenUndocked::Width, Layout::ScreenUndocked::Height); + layout->addWidget(child); + layout->setMargin(0); + setLayout(layout); + + OnMinimalClientAreaChangeRequest(GetActiveConfig().min_client_area_size); + + OnFramebufferSizeChanged(); + NotifyClientAreaSizeChanged(std::pair(child->width(), child->height())); + + BackupGeometry(); +} + +void GRenderWindow::OnMinimalClientAreaChangeRequest( + const std::pair& minimal_size) { + setMinimumSize(minimal_size.first, minimal_size.second); +} + +void GRenderWindow::OnEmulationStarting(EmuThread* emu_thread) { + this->emu_thread = emu_thread; + child->DisablePainting(); +} + +void GRenderWindow::OnEmulationStopping() { + emu_thread = nullptr; + child->EnablePainting(); +} + +void GRenderWindow::showEvent(QShowEvent* event) { + QWidget::showEvent(event); + +#if QT_VERSION >= QT_VERSION_CHECK(5, 0, 0) + // windowHandle() is not initialized until the Window is shown, so we connect it here. + connect(this->windowHandle(), SIGNAL(screenChanged(QScreen*)), this, + SLOT(OnFramebufferSizeChanged()), Qt::UniqueConnection); +#endif +} diff --git a/src/yuzu/bootmanager.h b/src/yuzu/bootmanager.h new file mode 100644 index 000000000..6974edcbb --- /dev/null +++ b/src/yuzu/bootmanager.h @@ -0,0 +1,162 @@ +// Copyright 2014 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#pragma once + +#include +#include +#include +#include +#include +#include "common/thread.h" +#include "core/core.h" +#include "core/frontend/emu_window.h" + +class QKeyEvent; +class QScreen; + +class GGLWidgetInternal; +class GMainWindow; +class GRenderWindow; + +class EmuThread : public QThread { + Q_OBJECT + +public: + explicit EmuThread(GRenderWindow* render_window); + + /** + * Start emulation (on new thread) + * @warning Only call when not running! + */ + void run() override; + + /** + * Steps the emulation thread by a single CPU instruction (if the CPU is not already running) + * @note This function is thread-safe + */ + void ExecStep() { + exec_step = true; + running_cv.notify_all(); + } + + /** + * Sets whether the emulation thread is running or not + * @param running Boolean value, set the emulation thread to running if true + * @note This function is thread-safe + */ + void SetRunning(bool running) { + std::unique_lock lock(running_mutex); + this->running = running; + lock.unlock(); + running_cv.notify_all(); + } + + /** + * Check if the emulation thread is running or not + * @return True if the emulation thread is running, otherwise false + * @note This function is thread-safe + */ + bool IsRunning() { + return running; + } + + /** + * Requests for the emulation thread to stop running + */ + void RequestStop() { + stop_run = true; + SetRunning(false); + }; + +private: + bool exec_step; + bool running; + std::atomic stop_run; + std::mutex running_mutex; + std::condition_variable running_cv; + + GRenderWindow* render_window; + +signals: + /** + * Emitted when the CPU has halted execution + * + * @warning When connecting to this signal from other threads, make sure to specify either + * Qt::QueuedConnection (invoke slot within the destination object's message thread) or even + * Qt::BlockingQueuedConnection (additionally block source thread until slot returns) + */ + void DebugModeEntered(); + + /** + * Emitted right before the CPU continues execution + * + * @warning When connecting to this signal from other threads, make sure to specify either + * Qt::QueuedConnection (invoke slot within the destination object's message thread) or even + * Qt::BlockingQueuedConnection (additionally block source thread until slot returns) + */ + void DebugModeLeft(); + + void ErrorThrown(Core::System::ResultStatus, std::string); +}; + +class GRenderWindow : public QWidget, public EmuWindow { + Q_OBJECT + +public: + GRenderWindow(QWidget* parent, EmuThread* emu_thread); + ~GRenderWindow(); + + // EmuWindow implementation + void SwapBuffers() override; + void MakeCurrent() override; + void DoneCurrent() override; + void PollEvents() override; + + void BackupGeometry(); + void RestoreGeometry(); + void restoreGeometry(const QByteArray& geometry); // overridden + QByteArray saveGeometry(); // overridden + + qreal windowPixelRatio(); + + void closeEvent(QCloseEvent* event) override; + + void keyPressEvent(QKeyEvent* event) override; + void keyReleaseEvent(QKeyEvent* event) override; + + void mousePressEvent(QMouseEvent* event) override; + void mouseMoveEvent(QMouseEvent* event) override; + void mouseReleaseEvent(QMouseEvent* event) override; + + void focusOutEvent(QFocusEvent* event) override; + + void OnClientAreaResized(unsigned width, unsigned height); + + void InitRenderTarget(); + +public slots: + void moveContext(); // overridden + + void OnEmulationStarting(EmuThread* emu_thread); + void OnEmulationStopping(); + void OnFramebufferSizeChanged(); + +signals: + /// Emitted when the window is closed + void Closed(); + +private: + void OnMinimalClientAreaChangeRequest( + const std::pair& minimal_size) override; + + GGLWidgetInternal* child; + + QByteArray geometry; + + EmuThread* emu_thread; + +protected: + void showEvent(QShowEvent* event) override; +}; diff --git a/src/yuzu/citra-qt.rc b/src/yuzu/citra-qt.rc new file mode 100644 index 000000000..a48a9440d --- /dev/null +++ b/src/yuzu/citra-qt.rc @@ -0,0 +1,19 @@ +#include "winresrc.h" +///////////////////////////////////////////////////////////////////////////// +// +// Icon +// + +// Icon with lowest ID value placed first to ensure application icon +// remains consistent on all systems. +// QT requires that the default application icon is named IDI_ICON1 + +IDI_ICON1 ICON "../../dist/citra.ico" + + +///////////////////////////////////////////////////////////////////////////// +// +// RT_MANIFEST +// + +1 RT_MANIFEST "../../dist/citra.manifest" diff --git a/src/yuzu/configuration/config.cpp b/src/yuzu/configuration/config.cpp new file mode 100644 index 000000000..fd884db7a --- /dev/null +++ b/src/yuzu/configuration/config.cpp @@ -0,0 +1,326 @@ +// Copyright 2014 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include +#include "citra_qt/configuration/config.h" +#include "citra_qt/ui_settings.h" +#include "common/file_util.h" +#include "input_common/main.h" + +Config::Config() { + // TODO: Don't hardcode the path; let the frontend decide where to put the config files. + qt_config_loc = FileUtil::GetUserPath(D_CONFIG_IDX) + "qt-config.ini"; + FileUtil::CreateFullPath(qt_config_loc); + qt_config = new QSettings(QString::fromStdString(qt_config_loc), QSettings::IniFormat); + + Reload(); +} + +const std::array Config::default_buttons = { + Qt::Key_A, Qt::Key_S, Qt::Key_Z, Qt::Key_X, Qt::Key_T, Qt::Key_G, Qt::Key_F, Qt::Key_H, + Qt::Key_Q, Qt::Key_W, Qt::Key_M, Qt::Key_N, Qt::Key_1, Qt::Key_2, Qt::Key_B, +}; + +const std::array, Settings::NativeAnalog::NumAnalogs> Config::default_analogs{{ + { + Qt::Key_Up, Qt::Key_Down, Qt::Key_Left, Qt::Key_Right, Qt::Key_D, + }, + { + Qt::Key_I, Qt::Key_K, Qt::Key_J, Qt::Key_L, Qt::Key_D, + }, +}}; + +void Config::ReadValues() { + qt_config->beginGroup("Controls"); + for (int i = 0; i < Settings::NativeButton::NumButtons; ++i) { + std::string default_param = InputCommon::GenerateKeyboardParam(default_buttons[i]); + Settings::values.buttons[i] = + qt_config + ->value(Settings::NativeButton::mapping[i], QString::fromStdString(default_param)) + .toString() + .toStdString(); + if (Settings::values.buttons[i].empty()) + Settings::values.buttons[i] = default_param; + } + + for (int i = 0; i < Settings::NativeAnalog::NumAnalogs; ++i) { + std::string default_param = InputCommon::GenerateAnalogParamFromKeys( + default_analogs[i][0], default_analogs[i][1], default_analogs[i][2], + default_analogs[i][3], default_analogs[i][4], 0.5f); + Settings::values.analogs[i] = + qt_config + ->value(Settings::NativeAnalog::mapping[i], QString::fromStdString(default_param)) + .toString() + .toStdString(); + if (Settings::values.analogs[i].empty()) + Settings::values.analogs[i] = default_param; + } + + Settings::values.motion_device = + qt_config->value("motion_device", "engine:motion_emu,update_period:100,sensitivity:0.01") + .toString() + .toStdString(); + Settings::values.touch_device = + qt_config->value("touch_device", "engine:emu_window").toString().toStdString(); + + qt_config->endGroup(); + + qt_config->beginGroup("Core"); + Settings::values.cpu_core = + static_cast(qt_config->value("cpu_core", 0).toInt()); + qt_config->endGroup(); + + qt_config->beginGroup("Renderer"); + Settings::values.use_hw_renderer = qt_config->value("use_hw_renderer", true).toBool(); + Settings::values.use_shader_jit = qt_config->value("use_shader_jit", true).toBool(); + Settings::values.resolution_factor = qt_config->value("resolution_factor", 1.0).toFloat(); + Settings::values.use_vsync = qt_config->value("use_vsync", false).toBool(); + Settings::values.toggle_framelimit = qt_config->value("toggle_framelimit", true).toBool(); + + Settings::values.bg_red = qt_config->value("bg_red", 0.0).toFloat(); + Settings::values.bg_green = qt_config->value("bg_green", 0.0).toFloat(); + Settings::values.bg_blue = qt_config->value("bg_blue", 0.0).toFloat(); + qt_config->endGroup(); + + qt_config->beginGroup("Layout"); + Settings::values.layout_option = + static_cast(qt_config->value("layout_option").toInt()); + Settings::values.swap_screen = qt_config->value("swap_screen", false).toBool(); + Settings::values.custom_layout = qt_config->value("custom_layout", false).toBool(); + Settings::values.custom_top_left = qt_config->value("custom_top_left", 0).toInt(); + Settings::values.custom_top_top = qt_config->value("custom_top_top", 0).toInt(); + Settings::values.custom_top_right = qt_config->value("custom_top_right", 400).toInt(); + Settings::values.custom_top_bottom = qt_config->value("custom_top_bottom", 240).toInt(); + Settings::values.custom_bottom_left = qt_config->value("custom_bottom_left", 40).toInt(); + Settings::values.custom_bottom_top = qt_config->value("custom_bottom_top", 240).toInt(); + Settings::values.custom_bottom_right = qt_config->value("custom_bottom_right", 360).toInt(); + Settings::values.custom_bottom_bottom = qt_config->value("custom_bottom_bottom", 480).toInt(); + qt_config->endGroup(); + + qt_config->beginGroup("Audio"); + Settings::values.sink_id = qt_config->value("output_engine", "auto").toString().toStdString(); + Settings::values.enable_audio_stretching = + qt_config->value("enable_audio_stretching", true).toBool(); + Settings::values.audio_device_id = + qt_config->value("output_device", "auto").toString().toStdString(); + qt_config->endGroup(); + + qt_config->beginGroup("Data Storage"); + Settings::values.use_virtual_sd = qt_config->value("use_virtual_sd", true).toBool(); + qt_config->endGroup(); + + qt_config->beginGroup("System"); + Settings::values.is_new_3ds = qt_config->value("is_new_3ds", false).toBool(); + Settings::values.region_value = + qt_config->value("region_value", Settings::REGION_VALUE_AUTO_SELECT).toInt(); + qt_config->endGroup(); + + qt_config->beginGroup("Miscellaneous"); + Settings::values.log_filter = qt_config->value("log_filter", "*:Info").toString().toStdString(); + qt_config->endGroup(); + + qt_config->beginGroup("Debugging"); + Settings::values.use_gdbstub = qt_config->value("use_gdbstub", false).toBool(); + Settings::values.gdbstub_port = qt_config->value("gdbstub_port", 24689).toInt(); + qt_config->endGroup(); + + qt_config->beginGroup("WebService"); + Settings::values.enable_telemetry = qt_config->value("enable_telemetry", true).toBool(); + Settings::values.telemetry_endpoint_url = + qt_config->value("telemetry_endpoint_url", "https://services.citra-emu.org/api/telemetry") + .toString() + .toStdString(); + Settings::values.verify_endpoint_url = + qt_config->value("verify_endpoint_url", "https://services.citra-emu.org/api/profile") + .toString() + .toStdString(); + Settings::values.citra_username = qt_config->value("citra_username").toString().toStdString(); + Settings::values.citra_token = qt_config->value("citra_token").toString().toStdString(); + qt_config->endGroup(); + + qt_config->beginGroup("UI"); + UISettings::values.theme = qt_config->value("theme", UISettings::themes[0].second).toString(); + + qt_config->beginGroup("UILayout"); + UISettings::values.geometry = qt_config->value("geometry").toByteArray(); + UISettings::values.state = qt_config->value("state").toByteArray(); + UISettings::values.renderwindow_geometry = + qt_config->value("geometryRenderWindow").toByteArray(); + UISettings::values.gamelist_header_state = + qt_config->value("gameListHeaderState").toByteArray(); + UISettings::values.microprofile_geometry = + qt_config->value("microProfileDialogGeometry").toByteArray(); + UISettings::values.microprofile_visible = + qt_config->value("microProfileDialogVisible", false).toBool(); + qt_config->endGroup(); + + qt_config->beginGroup("Paths"); + UISettings::values.roms_path = qt_config->value("romsPath").toString(); + UISettings::values.symbols_path = qt_config->value("symbolsPath").toString(); + UISettings::values.gamedir = qt_config->value("gameListRootDir", ".").toString(); + UISettings::values.gamedir_deepscan = qt_config->value("gameListDeepScan", false).toBool(); + UISettings::values.recent_files = qt_config->value("recentFiles").toStringList(); + qt_config->endGroup(); + + qt_config->beginGroup("Shortcuts"); + QStringList groups = qt_config->childGroups(); + for (auto group : groups) { + qt_config->beginGroup(group); + + QStringList hotkeys = qt_config->childGroups(); + for (auto hotkey : hotkeys) { + qt_config->beginGroup(hotkey); + UISettings::values.shortcuts.emplace_back(UISettings::Shortcut( + group + "/" + hotkey, + UISettings::ContextualShortcut(qt_config->value("KeySeq").toString(), + qt_config->value("Context").toInt()))); + qt_config->endGroup(); + } + + qt_config->endGroup(); + } + qt_config->endGroup(); + + UISettings::values.single_window_mode = qt_config->value("singleWindowMode", true).toBool(); + UISettings::values.display_titlebar = qt_config->value("displayTitleBars", true).toBool(); + UISettings::values.show_filter_bar = qt_config->value("showFilterBar", true).toBool(); + UISettings::values.show_status_bar = qt_config->value("showStatusBar", true).toBool(); + UISettings::values.confirm_before_closing = qt_config->value("confirmClose", true).toBool(); + UISettings::values.first_start = qt_config->value("firstStart", true).toBool(); + UISettings::values.callout_flags = qt_config->value("calloutFlags", 0).toUInt(); + + qt_config->endGroup(); +} + +void Config::SaveValues() { + qt_config->beginGroup("Controls"); + for (int i = 0; i < Settings::NativeButton::NumButtons; ++i) { + qt_config->setValue(QString::fromStdString(Settings::NativeButton::mapping[i]), + QString::fromStdString(Settings::values.buttons[i])); + } + for (int i = 0; i < Settings::NativeAnalog::NumAnalogs; ++i) { + qt_config->setValue(QString::fromStdString(Settings::NativeAnalog::mapping[i]), + QString::fromStdString(Settings::values.analogs[i])); + } + qt_config->setValue("motion_device", QString::fromStdString(Settings::values.motion_device)); + qt_config->setValue("touch_device", QString::fromStdString(Settings::values.touch_device)); + qt_config->endGroup(); + + qt_config->beginGroup("Core"); + qt_config->setValue("cpu_core", static_cast(Settings::values.cpu_core)); + qt_config->endGroup(); + + qt_config->beginGroup("Renderer"); + qt_config->setValue("use_hw_renderer", Settings::values.use_hw_renderer); + qt_config->setValue("use_shader_jit", Settings::values.use_shader_jit); + qt_config->setValue("resolution_factor", (double)Settings::values.resolution_factor); + qt_config->setValue("use_vsync", Settings::values.use_vsync); + qt_config->setValue("toggle_framelimit", Settings::values.toggle_framelimit); + + // Cast to double because Qt's written float values are not human-readable + qt_config->setValue("bg_red", (double)Settings::values.bg_red); + qt_config->setValue("bg_green", (double)Settings::values.bg_green); + qt_config->setValue("bg_blue", (double)Settings::values.bg_blue); + qt_config->endGroup(); + + qt_config->beginGroup("Layout"); + qt_config->setValue("layout_option", static_cast(Settings::values.layout_option)); + qt_config->setValue("swap_screen", Settings::values.swap_screen); + qt_config->setValue("custom_layout", Settings::values.custom_layout); + qt_config->setValue("custom_top_left", Settings::values.custom_top_left); + qt_config->setValue("custom_top_top", Settings::values.custom_top_top); + qt_config->setValue("custom_top_right", Settings::values.custom_top_right); + qt_config->setValue("custom_top_bottom", Settings::values.custom_top_bottom); + qt_config->setValue("custom_bottom_left", Settings::values.custom_bottom_left); + qt_config->setValue("custom_bottom_top", Settings::values.custom_bottom_top); + qt_config->setValue("custom_bottom_right", Settings::values.custom_bottom_right); + qt_config->setValue("custom_bottom_bottom", Settings::values.custom_bottom_bottom); + qt_config->endGroup(); + + qt_config->beginGroup("Audio"); + qt_config->setValue("output_engine", QString::fromStdString(Settings::values.sink_id)); + qt_config->setValue("enable_audio_stretching", Settings::values.enable_audio_stretching); + qt_config->setValue("output_device", QString::fromStdString(Settings::values.audio_device_id)); + qt_config->endGroup(); + + qt_config->beginGroup("Data Storage"); + qt_config->setValue("use_virtual_sd", Settings::values.use_virtual_sd); + qt_config->endGroup(); + + qt_config->beginGroup("System"); + qt_config->setValue("is_new_3ds", Settings::values.is_new_3ds); + qt_config->setValue("region_value", Settings::values.region_value); + qt_config->endGroup(); + + qt_config->beginGroup("Miscellaneous"); + qt_config->setValue("log_filter", QString::fromStdString(Settings::values.log_filter)); + qt_config->endGroup(); + + qt_config->beginGroup("Debugging"); + qt_config->setValue("use_gdbstub", Settings::values.use_gdbstub); + qt_config->setValue("gdbstub_port", Settings::values.gdbstub_port); + qt_config->endGroup(); + + qt_config->beginGroup("WebService"); + qt_config->setValue("enable_telemetry", Settings::values.enable_telemetry); + qt_config->setValue("telemetry_endpoint_url", + QString::fromStdString(Settings::values.telemetry_endpoint_url)); + qt_config->setValue("verify_endpoint_url", + QString::fromStdString(Settings::values.verify_endpoint_url)); + qt_config->setValue("citra_username", QString::fromStdString(Settings::values.citra_username)); + qt_config->setValue("citra_token", QString::fromStdString(Settings::values.citra_token)); + qt_config->endGroup(); + + qt_config->beginGroup("UI"); + qt_config->setValue("theme", UISettings::values.theme); + + qt_config->beginGroup("UILayout"); + qt_config->setValue("geometry", UISettings::values.geometry); + qt_config->setValue("state", UISettings::values.state); + qt_config->setValue("geometryRenderWindow", UISettings::values.renderwindow_geometry); + qt_config->setValue("gameListHeaderState", UISettings::values.gamelist_header_state); + qt_config->setValue("microProfileDialogGeometry", UISettings::values.microprofile_geometry); + qt_config->setValue("microProfileDialogVisible", UISettings::values.microprofile_visible); + qt_config->endGroup(); + + qt_config->beginGroup("Paths"); + qt_config->setValue("romsPath", UISettings::values.roms_path); + qt_config->setValue("symbolsPath", UISettings::values.symbols_path); + qt_config->setValue("gameListRootDir", UISettings::values.gamedir); + qt_config->setValue("gameListDeepScan", UISettings::values.gamedir_deepscan); + qt_config->setValue("recentFiles", UISettings::values.recent_files); + qt_config->endGroup(); + + qt_config->beginGroup("Shortcuts"); + for (auto shortcut : UISettings::values.shortcuts) { + qt_config->setValue(shortcut.first + "/KeySeq", shortcut.second.first); + qt_config->setValue(shortcut.first + "/Context", shortcut.second.second); + } + qt_config->endGroup(); + + qt_config->setValue("singleWindowMode", UISettings::values.single_window_mode); + qt_config->setValue("displayTitleBars", UISettings::values.display_titlebar); + qt_config->setValue("showFilterBar", UISettings::values.show_filter_bar); + qt_config->setValue("showStatusBar", UISettings::values.show_status_bar); + qt_config->setValue("confirmClose", UISettings::values.confirm_before_closing); + qt_config->setValue("firstStart", UISettings::values.first_start); + qt_config->setValue("calloutFlags", UISettings::values.callout_flags); + + qt_config->endGroup(); +} + +void Config::Reload() { + ReadValues(); + Settings::Apply(); +} + +void Config::Save() { + SaveValues(); +} + +Config::~Config() { + Save(); + + delete qt_config; +} diff --git a/src/yuzu/configuration/config.h b/src/yuzu/configuration/config.h new file mode 100644 index 000000000..cbf745ea2 --- /dev/null +++ b/src/yuzu/configuration/config.h @@ -0,0 +1,30 @@ +// Copyright 2014 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#pragma once + +#include +#include +#include +#include "core/settings.h" + +class QSettings; + +class Config { + QSettings* qt_config; + std::string qt_config_loc; + + void ReadValues(); + void SaveValues(); + +public: + Config(); + ~Config(); + + void Reload(); + void Save(); + + static const std::array default_buttons; + static const std::array, Settings::NativeAnalog::NumAnalogs> default_analogs; +}; diff --git a/src/yuzu/configuration/configure.ui b/src/yuzu/configuration/configure.ui new file mode 100644 index 000000000..6abd1917e --- /dev/null +++ b/src/yuzu/configuration/configure.ui @@ -0,0 +1,147 @@ + + + ConfigureDialog + + + + 0 + 0 + 740 + 500 + + + + Citra Configuration + + + + + + 0 + + + + General + + + + + System + + + + + Input + + + + + Graphics + + + + + Audio + + + + + Debug + + + + + Web + + + + + + + + QDialogButtonBox::Cancel|QDialogButtonBox::Ok + + + + + + + + ConfigureGeneral + QWidget +
configuration/configure_general.h
+ 1 + + + ConfigureSystem + QWidget +
configuration/configure_system.h
+ 1 + + + ConfigureAudio + QWidget +
configuration/configure_audio.h
+ 1 + + + ConfigureDebug + QWidget +
configuration/configure_debug.h
+ 1 + + + ConfigureInput + QWidget +
configuration/configure_input.h
+ 1 + + + ConfigureGraphics + QWidget +
configuration/configure_graphics.h
+ 1 + + + ConfigureWeb + QWidget +
configuration/configure_web.h
+ 1 + + + + + + buttonBox + accepted() + ConfigureDialog + accept() + + + 220 + 380 + + + 220 + 200 + + + + + buttonBox + rejected() + ConfigureDialog + reject() + + + 220 + 380 + + + 220 + 200 + + + + + diff --git a/src/yuzu/configuration/configure_audio.cpp b/src/yuzu/configuration/configure_audio.cpp new file mode 100644 index 000000000..3fd1d127a --- /dev/null +++ b/src/yuzu/configuration/configure_audio.cpp @@ -0,0 +1,77 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include +#include "audio_core/audio_core.h" +#include "audio_core/sink.h" +#include "audio_core/sink_details.h" +#include "citra_qt/configuration/configure_audio.h" +#include "core/settings.h" +#include "ui_configure_audio.h" + +ConfigureAudio::ConfigureAudio(QWidget* parent) + : QWidget(parent), ui(std::make_unique()) { + ui->setupUi(this); + + ui->output_sink_combo_box->clear(); + ui->output_sink_combo_box->addItem("auto"); + for (const auto& sink_detail : AudioCore::g_sink_details) { + ui->output_sink_combo_box->addItem(sink_detail.id); + } + + this->setConfiguration(); + connect(ui->output_sink_combo_box, SIGNAL(currentIndexChanged(int)), this, + SLOT(updateAudioDevices(int))); +} + +ConfigureAudio::~ConfigureAudio() {} + +void ConfigureAudio::setConfiguration() { + int new_sink_index = 0; + for (int index = 0; index < ui->output_sink_combo_box->count(); index++) { + if (ui->output_sink_combo_box->itemText(index).toStdString() == Settings::values.sink_id) { + new_sink_index = index; + break; + } + } + ui->output_sink_combo_box->setCurrentIndex(new_sink_index); + + ui->toggle_audio_stretching->setChecked(Settings::values.enable_audio_stretching); + + // The device list cannot be pre-populated (nor listed) until the output sink is known. + updateAudioDevices(new_sink_index); + + int new_device_index = -1; + for (int index = 0; index < ui->audio_device_combo_box->count(); index++) { + if (ui->audio_device_combo_box->itemText(index).toStdString() == + Settings::values.audio_device_id) { + new_device_index = index; + break; + } + } + ui->audio_device_combo_box->setCurrentIndex(new_device_index); +} + +void ConfigureAudio::applyConfiguration() { + Settings::values.sink_id = + ui->output_sink_combo_box->itemText(ui->output_sink_combo_box->currentIndex()) + .toStdString(); + Settings::values.enable_audio_stretching = ui->toggle_audio_stretching->isChecked(); + Settings::values.audio_device_id = + ui->audio_device_combo_box->itemText(ui->audio_device_combo_box->currentIndex()) + .toStdString(); + Settings::Apply(); +} + +void ConfigureAudio::updateAudioDevices(int sink_index) { + ui->audio_device_combo_box->clear(); + ui->audio_device_combo_box->addItem("auto"); + + std::string sink_id = ui->output_sink_combo_box->itemText(sink_index).toStdString(); + std::vector device_list = + AudioCore::GetSinkDetails(sink_id).factory()->GetDeviceList(); + for (const auto& device : device_list) { + ui->audio_device_combo_box->addItem(device.c_str()); + } +} diff --git a/src/yuzu/configuration/configure_audio.h b/src/yuzu/configuration/configure_audio.h new file mode 100644 index 000000000..8190e694f --- /dev/null +++ b/src/yuzu/configuration/configure_audio.h @@ -0,0 +1,30 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#pragma once + +#include +#include + +namespace Ui { +class ConfigureAudio; +} + +class ConfigureAudio : public QWidget { + Q_OBJECT + +public: + explicit ConfigureAudio(QWidget* parent = nullptr); + ~ConfigureAudio(); + + void applyConfiguration(); + +public slots: + void updateAudioDevices(int sink_index); + +private: + void setConfiguration(); + + std::unique_ptr ui; +}; diff --git a/src/yuzu/configuration/configure_audio.ui b/src/yuzu/configuration/configure_audio.ui new file mode 100644 index 000000000..dd870eb61 --- /dev/null +++ b/src/yuzu/configuration/configure_audio.ui @@ -0,0 +1,73 @@ + + + + ConfigureAudio + + + + + + Audio + + + + + + + + Output Engine: + + + + + + + + + + + + + Enable audio stretching + + + This post-processing effect adjusts audio speed to match emulation speed and helps prevent audio stutter. This however increases audio latency. + + + + + + + + + Audio Device: + + + + + + + + + + + + + + + + Qt::Vertical + + + + 20 + 40 + + + + + + + + + diff --git a/src/yuzu/configuration/configure_debug.cpp b/src/yuzu/configuration/configure_debug.cpp new file mode 100644 index 000000000..263f73f38 --- /dev/null +++ b/src/yuzu/configuration/configure_debug.cpp @@ -0,0 +1,26 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include "citra_qt/configuration/configure_debug.h" +#include "core/settings.h" +#include "ui_configure_debug.h" + +ConfigureDebug::ConfigureDebug(QWidget* parent) : QWidget(parent), ui(new Ui::ConfigureDebug) { + ui->setupUi(this); + this->setConfiguration(); +} + +ConfigureDebug::~ConfigureDebug() {} + +void ConfigureDebug::setConfiguration() { + ui->toggle_gdbstub->setChecked(Settings::values.use_gdbstub); + ui->gdbport_spinbox->setEnabled(Settings::values.use_gdbstub); + ui->gdbport_spinbox->setValue(Settings::values.gdbstub_port); +} + +void ConfigureDebug::applyConfiguration() { + Settings::values.use_gdbstub = ui->toggle_gdbstub->isChecked(); + Settings::values.gdbstub_port = ui->gdbport_spinbox->value(); + Settings::Apply(); +} diff --git a/src/yuzu/configuration/configure_debug.h b/src/yuzu/configuration/configure_debug.h new file mode 100644 index 000000000..d167eb996 --- /dev/null +++ b/src/yuzu/configuration/configure_debug.h @@ -0,0 +1,28 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#pragma once + +#include +#include + +namespace Ui { +class ConfigureDebug; +} + +class ConfigureDebug : public QWidget { + Q_OBJECT + +public: + explicit ConfigureDebug(QWidget* parent = nullptr); + ~ConfigureDebug(); + + void applyConfiguration(); + +private: + void setConfiguration(); + +private: + std::unique_ptr ui; +}; diff --git a/src/yuzu/configuration/configure_debug.ui b/src/yuzu/configuration/configure_debug.ui new file mode 100644 index 000000000..96638ebdb --- /dev/null +++ b/src/yuzu/configuration/configure_debug.ui @@ -0,0 +1,109 @@ + + + ConfigureDebug + + + + 0 + 0 + 400 + 300 + + + + Form + + + + + + + + GDB + + + + + + The GDB Stub only works correctly when the CPU JIT is off. + + + + + + + + + Enable GDB Stub + + + + + + + Qt::Horizontal + + + + 40 + 20 + + + + + + + + Port: + + + + + + + 65536 + + + + + + + + + + + + + + Qt::Vertical + + + + 20 + 40 + + + + + + + + + + toggle_gdbstub + toggled(bool) + gdbport_spinbox + setEnabled(bool) + + + 84 + 157 + + + 342 + 158 + + + + + diff --git a/src/yuzu/configuration/configure_dialog.cpp b/src/yuzu/configuration/configure_dialog.cpp new file mode 100644 index 000000000..b87dc0e6c --- /dev/null +++ b/src/yuzu/configuration/configure_dialog.cpp @@ -0,0 +1,28 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include "citra_qt/configuration/config.h" +#include "citra_qt/configuration/configure_dialog.h" +#include "core/settings.h" +#include "ui_configure.h" + +ConfigureDialog::ConfigureDialog(QWidget* parent) : QDialog(parent), ui(new Ui::ConfigureDialog) { + ui->setupUi(this); + this->setConfiguration(); +} + +ConfigureDialog::~ConfigureDialog() {} + +void ConfigureDialog::setConfiguration() {} + +void ConfigureDialog::applyConfiguration() { + ui->generalTab->applyConfiguration(); + ui->systemTab->applyConfiguration(); + ui->inputTab->applyConfiguration(); + ui->graphicsTab->applyConfiguration(); + ui->audioTab->applyConfiguration(); + ui->debugTab->applyConfiguration(); + ui->webTab->applyConfiguration(); + Settings::Apply(); +} diff --git a/src/yuzu/configuration/configure_dialog.h b/src/yuzu/configuration/configure_dialog.h new file mode 100644 index 000000000..21fa1f501 --- /dev/null +++ b/src/yuzu/configuration/configure_dialog.h @@ -0,0 +1,28 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#pragma once + +#include +#include + +namespace Ui { +class ConfigureDialog; +} + +class ConfigureDialog : public QDialog { + Q_OBJECT + +public: + explicit ConfigureDialog(QWidget* parent); + ~ConfigureDialog(); + + void applyConfiguration(); + +private: + void setConfiguration(); + +private: + std::unique_ptr ui; +}; diff --git a/src/yuzu/configuration/configure_general.cpp b/src/yuzu/configuration/configure_general.cpp new file mode 100644 index 000000000..0de27aa8b --- /dev/null +++ b/src/yuzu/configuration/configure_general.cpp @@ -0,0 +1,47 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include "citra_qt/configuration/configure_general.h" +#include "citra_qt/ui_settings.h" +#include "core/core.h" +#include "core/settings.h" +#include "ui_configure_general.h" + +ConfigureGeneral::ConfigureGeneral(QWidget* parent) + : QWidget(parent), ui(new Ui::ConfigureGeneral) { + + ui->setupUi(this); + + for (auto theme : UISettings::themes) { + ui->theme_combobox->addItem(theme.first, theme.second); + } + + this->setConfiguration(); + + ui->cpu_core_combobox->setEnabled(!Core::System::GetInstance().IsPoweredOn()); +} + +ConfigureGeneral::~ConfigureGeneral() {} + +void ConfigureGeneral::setConfiguration() { + ui->toggle_deepscan->setChecked(UISettings::values.gamedir_deepscan); + ui->toggle_check_exit->setChecked(UISettings::values.confirm_before_closing); + + // The first item is "auto-select" with actual value -1, so plus one here will do the trick + ui->region_combobox->setCurrentIndex(Settings::values.region_value + 1); + + ui->theme_combobox->setCurrentIndex(ui->theme_combobox->findData(UISettings::values.theme)); + ui->cpu_core_combobox->setCurrentIndex(static_cast(Settings::values.cpu_core)); +} + +void ConfigureGeneral::applyConfiguration() { + UISettings::values.gamedir_deepscan = ui->toggle_deepscan->isChecked(); + UISettings::values.confirm_before_closing = ui->toggle_check_exit->isChecked(); + UISettings::values.theme = + ui->theme_combobox->itemData(ui->theme_combobox->currentIndex()).toString(); + Settings::values.region_value = ui->region_combobox->currentIndex() - 1; + Settings::values.cpu_core = + static_cast(ui->cpu_core_combobox->currentIndex()); + Settings::Apply(); +} diff --git a/src/yuzu/configuration/configure_general.h b/src/yuzu/configuration/configure_general.h new file mode 100644 index 000000000..447552d8c --- /dev/null +++ b/src/yuzu/configuration/configure_general.h @@ -0,0 +1,28 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#pragma once + +#include +#include + +namespace Ui { +class ConfigureGeneral; +} + +class ConfigureGeneral : public QWidget { + Q_OBJECT + +public: + explicit ConfigureGeneral(QWidget* parent = nullptr); + ~ConfigureGeneral(); + + void applyConfiguration(); + +private: + void setConfiguration(); + +private: + std::unique_ptr ui; +}; diff --git a/src/yuzu/configuration/configure_general.ui b/src/yuzu/configuration/configure_general.ui new file mode 100644 index 000000000..e88c37936 --- /dev/null +++ b/src/yuzu/configuration/configure_general.ui @@ -0,0 +1,199 @@ + + + ConfigureGeneral + + + + 0 + 0 + 300 + 377 + + + + Form + + + + + + + + General + + + + + + + + Search sub-directories for games + + + + + + + Confirm exit while emulation is running + + + + + + + + + + + + CPU Core + + + + + + + + + Unicorn + + + + + Dynarmic + + + + + + + + + + + + + Emulation + + + + + + + + + + Region: + + + + + + + + Auto-select + + + + + JPN + + + + + USA + + + + + EUR + + + + + AUS + + + + + CHN + + + + + KOR + + + + + TWN + + + + + + + + + + + + + + + Theme + + + + + + + + + + Theme: + + + + + + + + + + + + + + + + + + Hotkeys + + + + + + + + + + + + + + + + + + + GHotkeysDialog + QWidget +
hotkeys.h
+ 1 + + + + + diff --git a/src/yuzu/configuration/configure_graphics.cpp b/src/yuzu/configuration/configure_graphics.cpp new file mode 100644 index 000000000..b5a5ab1e1 --- /dev/null +++ b/src/yuzu/configuration/configure_graphics.cpp @@ -0,0 +1,115 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include "citra_qt/configuration/configure_graphics.h" +#include "core/core.h" +#include "core/settings.h" +#include "ui_configure_graphics.h" + +ConfigureGraphics::ConfigureGraphics(QWidget* parent) + : QWidget(parent), ui(new Ui::ConfigureGraphics) { + + ui->setupUi(this); + this->setConfiguration(); + + ui->toggle_vsync->setEnabled(!Core::System::GetInstance().IsPoweredOn()); + + ui->layoutBox->setEnabled(!Settings::values.custom_layout); +} + +ConfigureGraphics::~ConfigureGraphics() {} + +enum class Resolution : int { + Auto, + Scale1x, + Scale2x, + Scale3x, + Scale4x, + Scale5x, + Scale6x, + Scale7x, + Scale8x, + Scale9x, + Scale10x, +}; + +float ToResolutionFactor(Resolution option) { + switch (option) { + case Resolution::Auto: + return 0.f; + case Resolution::Scale1x: + return 1.f; + case Resolution::Scale2x: + return 2.f; + case Resolution::Scale3x: + return 3.f; + case Resolution::Scale4x: + return 4.f; + case Resolution::Scale5x: + return 5.f; + case Resolution::Scale6x: + return 6.f; + case Resolution::Scale7x: + return 7.f; + case Resolution::Scale8x: + return 8.f; + case Resolution::Scale9x: + return 9.f; + case Resolution::Scale10x: + return 10.f; + } + return 0.f; +} + +Resolution FromResolutionFactor(float factor) { + if (factor == 0.f) { + return Resolution::Auto; + } else if (factor == 1.f) { + return Resolution::Scale1x; + } else if (factor == 2.f) { + return Resolution::Scale2x; + } else if (factor == 3.f) { + return Resolution::Scale3x; + } else if (factor == 4.f) { + return Resolution::Scale4x; + } else if (factor == 5.f) { + return Resolution::Scale5x; + } else if (factor == 6.f) { + return Resolution::Scale6x; + } else if (factor == 7.f) { + return Resolution::Scale7x; + } else if (factor == 8.f) { + return Resolution::Scale8x; + } else if (factor == 9.f) { + return Resolution::Scale9x; + } else if (factor == 10.f) { + return Resolution::Scale10x; + } + return Resolution::Auto; +} + +void ConfigureGraphics::setConfiguration() { + ui->toggle_hw_renderer->setChecked(Settings::values.use_hw_renderer); + ui->resolution_factor_combobox->setEnabled(Settings::values.use_hw_renderer); + ui->toggle_shader_jit->setChecked(Settings::values.use_shader_jit); + ui->resolution_factor_combobox->setCurrentIndex( + static_cast(FromResolutionFactor(Settings::values.resolution_factor))); + ui->toggle_vsync->setChecked(Settings::values.use_vsync); + ui->toggle_framelimit->setChecked(Settings::values.toggle_framelimit); + ui->layout_combobox->setCurrentIndex(static_cast(Settings::values.layout_option)); + ui->swap_screen->setChecked(Settings::values.swap_screen); +} + +void ConfigureGraphics::applyConfiguration() { + Settings::values.use_hw_renderer = ui->toggle_hw_renderer->isChecked(); + Settings::values.use_shader_jit = ui->toggle_shader_jit->isChecked(); + Settings::values.resolution_factor = + ToResolutionFactor(static_cast(ui->resolution_factor_combobox->currentIndex())); + Settings::values.use_vsync = ui->toggle_vsync->isChecked(); + Settings::values.toggle_framelimit = ui->toggle_framelimit->isChecked(); + Settings::values.layout_option = + static_cast(ui->layout_combobox->currentIndex()); + Settings::values.swap_screen = ui->swap_screen->isChecked(); + Settings::Apply(); +} diff --git a/src/yuzu/configuration/configure_graphics.h b/src/yuzu/configuration/configure_graphics.h new file mode 100644 index 000000000..5497a55f7 --- /dev/null +++ b/src/yuzu/configuration/configure_graphics.h @@ -0,0 +1,28 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#pragma once + +#include +#include + +namespace Ui { +class ConfigureGraphics; +} + +class ConfigureGraphics : public QWidget { + Q_OBJECT + +public: + explicit ConfigureGraphics(QWidget* parent = nullptr); + ~ConfigureGraphics(); + + void applyConfiguration(); + +private: + void setConfiguration(); + +private: + std::unique_ptr ui; +}; diff --git a/src/yuzu/configuration/configure_graphics.ui b/src/yuzu/configuration/configure_graphics.ui new file mode 100644 index 000000000..5667b14b6 --- /dev/null +++ b/src/yuzu/configuration/configure_graphics.ui @@ -0,0 +1,207 @@ + + + ConfigureGraphics + + + + 0 + 0 + 400 + 300 + + + + Form + + + + + + + + Graphics + + + + + + Enable hardware renderer + + + + + + + Enable shader JIT + + + + + + + Enable V-Sync + + + + + + + Limit framerate + + + + + + + + + Internal Resolution: + + + + + + + + Auto (Window Size) + + + + + Native (400x240) + + + + + 2x Native (800x480) + + + + + 3x Native (1200x720) + + + + + 4x Native (1600x960) + + + + + 5x Native (2000x1200) + + + + + 6x Native (2400x1440) + + + + + 7x Native (2800x1680) + + + + + 8x Native (3200x1920) + + + + + 9x Native (3600x2160) + + + + + 10x Native (4000x2400) + + + + + + + + + + + + + + + Layout + + + + + + + + + + Screen Layout: + + + + + + + + Default + + + + + Single Screen + + + + + Large Screen + + + + + Side by Side + + + + + + + + + + Swap Screens + + + + + + + + + + + + Qt::Vertical + + + + 20 + 40 + + + + + + + + + + toggle_hw_renderer + toggled(bool) + resolution_factor_combobox + setEnabled(bool) + + + diff --git a/src/yuzu/configuration/configure_input.cpp b/src/yuzu/configuration/configure_input.cpp new file mode 100644 index 000000000..116a6330f --- /dev/null +++ b/src/yuzu/configuration/configure_input.cpp @@ -0,0 +1,199 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include +#include +#include +#include +#include "citra_qt/configuration/config.h" +#include "citra_qt/configuration/configure_input.h" +#include "common/param_package.h" +#include "input_common/main.h" + +const std::array + ConfigureInput::analog_sub_buttons{{ + "up", "down", "left", "right", "modifier", + }}; + +static QString getKeyName(int key_code) { + switch (key_code) { + case Qt::Key_Shift: + return QObject::tr("Shift"); + case Qt::Key_Control: + return QObject::tr("Ctrl"); + case Qt::Key_Alt: + return QObject::tr("Alt"); + case Qt::Key_Meta: + return ""; + default: + return QKeySequence(key_code).toString(); + } +} + +static void SetButtonKey(int key, Common::ParamPackage& button_param) { + button_param = Common::ParamPackage{InputCommon::GenerateKeyboardParam(key)}; +} + +static void SetAnalogKey(int key, Common::ParamPackage& analog_param, + const std::string& button_name) { + if (analog_param.Get("engine", "") != "analog_from_button") { + analog_param = { + {"engine", "analog_from_button"}, {"modifier_scale", "0.5"}, + }; + } + analog_param.Set(button_name, InputCommon::GenerateKeyboardParam(key)); +} + +ConfigureInput::ConfigureInput(QWidget* parent) + : QWidget(parent), ui(std::make_unique()), + timer(std::make_unique()) { + + ui->setupUi(this); + setFocusPolicy(Qt::ClickFocus); + + button_map = { + ui->buttonA, ui->buttonB, ui->buttonX, ui->buttonY, ui->buttonDpadUp, + ui->buttonDpadDown, ui->buttonDpadLeft, ui->buttonDpadRight, ui->buttonL, ui->buttonR, + ui->buttonStart, ui->buttonSelect, ui->buttonZL, ui->buttonZR, ui->buttonHome, + }; + + analog_map = {{ + { + ui->buttonCircleUp, ui->buttonCircleDown, ui->buttonCircleLeft, ui->buttonCircleRight, + ui->buttonCircleMod, + }, + { + ui->buttonCStickUp, ui->buttonCStickDown, ui->buttonCStickLeft, ui->buttonCStickRight, + nullptr, + }, + }}; + + for (int button_id = 0; button_id < Settings::NativeButton::NumButtons; button_id++) { + if (button_map[button_id]) + connect(button_map[button_id], &QPushButton::released, [=]() { + handleClick(button_map[button_id], + [=](int key) { SetButtonKey(key, buttons_param[button_id]); }); + }); + } + + for (int analog_id = 0; analog_id < Settings::NativeAnalog::NumAnalogs; analog_id++) { + for (int sub_button_id = 0; sub_button_id < ANALOG_SUB_BUTTONS_NUM; sub_button_id++) { + if (analog_map[analog_id][sub_button_id] != nullptr) { + connect(analog_map[analog_id][sub_button_id], &QPushButton::released, [=]() { + handleClick(analog_map[analog_id][sub_button_id], [=](int key) { + SetAnalogKey(key, analogs_param[analog_id], + analog_sub_buttons[sub_button_id]); + }); + }); + } + } + } + + connect(ui->buttonRestoreDefaults, &QPushButton::released, [this]() { restoreDefaults(); }); + + timer->setSingleShot(true); + connect(timer.get(), &QTimer::timeout, [this]() { + releaseKeyboard(); + releaseMouse(); + key_setter = boost::none; + updateButtonLabels(); + }); + + this->loadConfiguration(); + + // TODO(wwylele): enable this when we actually emulate it + ui->buttonHome->setEnabled(false); +} + +void ConfigureInput::applyConfiguration() { + std::transform(buttons_param.begin(), buttons_param.end(), Settings::values.buttons.begin(), + [](const Common::ParamPackage& param) { return param.Serialize(); }); + std::transform(analogs_param.begin(), analogs_param.end(), Settings::values.analogs.begin(), + [](const Common::ParamPackage& param) { return param.Serialize(); }); + + Settings::Apply(); +} + +void ConfigureInput::loadConfiguration() { + std::transform(Settings::values.buttons.begin(), Settings::values.buttons.end(), + buttons_param.begin(), + [](const std::string& str) { return Common::ParamPackage(str); }); + std::transform(Settings::values.analogs.begin(), Settings::values.analogs.end(), + analogs_param.begin(), + [](const std::string& str) { return Common::ParamPackage(str); }); + updateButtonLabels(); +} + +void ConfigureInput::restoreDefaults() { + for (int button_id = 0; button_id < Settings::NativeButton::NumButtons; button_id++) { + SetButtonKey(Config::default_buttons[button_id], buttons_param[button_id]); + } + + for (int analog_id = 0; analog_id < Settings::NativeAnalog::NumAnalogs; analog_id++) { + for (int sub_button_id = 0; sub_button_id < ANALOG_SUB_BUTTONS_NUM; sub_button_id++) { + SetAnalogKey(Config::default_analogs[analog_id][sub_button_id], + analogs_param[analog_id], analog_sub_buttons[sub_button_id]); + } + } + updateButtonLabels(); + applyConfiguration(); +} + +void ConfigureInput::updateButtonLabels() { + QString non_keyboard(tr("[non-keyboard]")); + + auto KeyToText = [&non_keyboard](const Common::ParamPackage& param) { + if (param.Get("engine", "") != "keyboard") { + return non_keyboard; + } else { + return getKeyName(param.Get("code", 0)); + } + }; + + for (int button = 0; button < Settings::NativeButton::NumButtons; button++) { + button_map[button]->setText(KeyToText(buttons_param[button])); + } + + for (int analog_id = 0; analog_id < Settings::NativeAnalog::NumAnalogs; analog_id++) { + if (analogs_param[analog_id].Get("engine", "") != "analog_from_button") { + for (QPushButton* button : analog_map[analog_id]) { + if (button) + button->setText(non_keyboard); + } + } else { + for (int sub_button_id = 0; sub_button_id < ANALOG_SUB_BUTTONS_NUM; sub_button_id++) { + Common::ParamPackage param( + analogs_param[analog_id].Get(analog_sub_buttons[sub_button_id], "")); + if (analog_map[analog_id][sub_button_id]) + analog_map[analog_id][sub_button_id]->setText(KeyToText(param)); + } + } + } +} + +void ConfigureInput::handleClick(QPushButton* button, std::function new_key_setter) { + button->setText(tr("[press key]")); + button->setFocus(); + + key_setter = new_key_setter; + + grabKeyboard(); + grabMouse(); + timer->start(5000); // Cancel after 5 seconds +} + +void ConfigureInput::keyPressEvent(QKeyEvent* event) { + releaseKeyboard(); + releaseMouse(); + + if (!key_setter || !event) + return; + + if (event->key() != Qt::Key_Escape) + (*key_setter)(event->key()); + + updateButtonLabels(); + key_setter = boost::none; + timer->stop(); +} diff --git a/src/yuzu/configuration/configure_input.h b/src/yuzu/configuration/configure_input.h new file mode 100644 index 000000000..c950fbcb4 --- /dev/null +++ b/src/yuzu/configuration/configure_input.h @@ -0,0 +1,69 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#pragma once + +#include +#include +#include +#include +#include +#include +#include +#include "common/param_package.h" +#include "core/settings.h" +#include "ui_configure_input.h" + +class QPushButton; +class QString; +class QTimer; + +namespace Ui { +class ConfigureInput; +} + +class ConfigureInput : public QWidget { + Q_OBJECT + +public: + explicit ConfigureInput(QWidget* parent = nullptr); + + /// Save all button configurations to settings file + void applyConfiguration(); + +private: + std::unique_ptr ui; + + std::unique_ptr timer; + + /// This will be the the setting function when an input is awaiting configuration. + boost::optional> key_setter; + + std::array buttons_param; + std::array analogs_param; + + static constexpr int ANALOG_SUB_BUTTONS_NUM = 5; + + /// Each button input is represented by a QPushButton. + std::array button_map; + + /// Each analog input is represented by five QPushButtons which represents up, down, left, right + /// and modifier + std::array, Settings::NativeAnalog::NumAnalogs> + analog_map; + + static const std::array analog_sub_buttons; + + /// Load configuration settings. + void loadConfiguration(); + /// Restore all buttons to their default values. + void restoreDefaults(); + /// Update UI to reflect current configuration. + void updateButtonLabels(); + + /// Called when the button was pressed. + void handleClick(QPushButton* button, std::function new_key_setter); + /// Handle key press events. + void keyPressEvent(QKeyEvent* event) override; +}; diff --git a/src/yuzu/configuration/configure_input.ui b/src/yuzu/configuration/configure_input.ui new file mode 100644 index 000000000..2760787e5 --- /dev/null +++ b/src/yuzu/configuration/configure_input.ui @@ -0,0 +1,592 @@ + + + ConfigureInput + + + + 0 + 0 + 370 + 534 + + + + ConfigureInput + + + + + + + + Face Buttons + + + false + + + false + + + + + + + + A: + + + + + + + + + + + + + + + + + + B: + + + + + + + + + + + + + + + + + + X: + + + + + + + + + + + + + + + + + + Y: + + + + + + + + + + + + + + + + + + + Directional Pad + + + false + + + false + + + + + + + + Up: + + + + + + + + + + + + + + + + + + Down: + + + + + + + + + + + + + + + + + + Left: + + + + + + + + + + + + + + + + + + Right: + + + + + + + + + + + + + + + + + + + Shoulder Buttons + + + false + + + false + + + + + + + + L: + + + + + + + + + + + + + + + + + + R: + + + + + + + + + + + + + + + + + + ZL: + + + + + + + + + + + + + + + + + + ZR: + + + + + + + + + + + + + + + + + + + Circle Pad + + + false + + + false + + + + + + + + Left: + + + + + + + + + + + + + + + + + + Right: + + + + + + + + + + + + + + + + + + Up: + + + + + + + + + + + + + + + + + + Down: + + + + + + + + + + + + + + + + + + + C-Stick + + + false + + + false + + + + + + + + Left: + + + + + + + + + + + + + + + + + + Right: + + + + + + + + + + + + + + + + + + Up: + + + + + + + + + + + + + + + + + + Down: + + + + + + + + + + + + + + + + + + + Misc. + + + false + + + false + + + + + + + + Start: + + + + + + + + + + + + + + + + + + Select: + + + + + + + + + + + + + + + + + + Home: + + + + + + + + + + + + + + + + + + Circle Mod: + + + + + + + + + + + + + + + + + + + + + + + Qt::Horizontal + + + + 40 + 20 + + + + + + + + + 0 + 0 + + + + + 0 + 0 + + + + + 0 + 0 + + + + Qt::LeftToRight + + + Restore Defaults + + + + + + + + + + diff --git a/src/yuzu/configuration/configure_system.cpp b/src/yuzu/configuration/configure_system.cpp new file mode 100644 index 000000000..d83c2db23 --- /dev/null +++ b/src/yuzu/configuration/configure_system.cpp @@ -0,0 +1,77 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include +#include "citra_qt/configuration/configure_system.h" +#include "citra_qt/ui_settings.h" +#include "core/core.h" +#include "ui_configure_system.h" + +static const std::array days_in_month = {{ + 31, 29, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31, +}}; + +ConfigureSystem::ConfigureSystem(QWidget* parent) : QWidget(parent), ui(new Ui::ConfigureSystem) { + ui->setupUi(this); + connect(ui->combo_birthmonth, + static_cast(&QComboBox::currentIndexChanged), this, + &ConfigureSystem::updateBirthdayComboBox); + connect(ui->button_regenerate_console_id, &QPushButton::clicked, this, + &ConfigureSystem::refreshConsoleID); + + this->setConfiguration(); +} + +ConfigureSystem::~ConfigureSystem() {} + +void ConfigureSystem::setConfiguration() { + enabled = !Core::System::GetInstance().IsPoweredOn(); +} + +void ConfigureSystem::ReadSystemSettings() { +} + +void ConfigureSystem::applyConfiguration() { + if (!enabled) + return; +} + +void ConfigureSystem::updateBirthdayComboBox(int birthmonth_index) { + if (birthmonth_index < 0 || birthmonth_index >= 12) + return; + + // store current day selection + int birthday_index = ui->combo_birthday->currentIndex(); + + // get number of days in the new selected month + int days = days_in_month[birthmonth_index]; + + // if the selected day is out of range, + // reset it to 1st + if (birthday_index < 0 || birthday_index >= days) + birthday_index = 0; + + // update the day combo box + ui->combo_birthday->clear(); + for (int i = 1; i <= days; ++i) { + ui->combo_birthday->addItem(QString::number(i)); + } + + // restore the day selection + ui->combo_birthday->setCurrentIndex(birthday_index); +} + +void ConfigureSystem::refreshConsoleID() { + QMessageBox::StandardButton reply; + QString warning_text = tr("This will replace your current virtual 3DS with a new one. " + "Your current virtual 3DS will not be recoverable. " + "This might have unexpected effects in games. This might fail, " + "if you use an outdated config savegame. Continue?"); + reply = QMessageBox::critical(this, tr("Warning"), warning_text, + QMessageBox::No | QMessageBox::Yes); + if (reply == QMessageBox::No) + return; + u64 console_id{}; + ui->label_console_id->setText("Console ID: 0x" + QString::number(console_id, 16).toUpper()); +} diff --git a/src/yuzu/configuration/configure_system.h b/src/yuzu/configuration/configure_system.h new file mode 100644 index 000000000..f13de17d4 --- /dev/null +++ b/src/yuzu/configuration/configure_system.h @@ -0,0 +1,38 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#pragma once + +#include +#include + +namespace Ui { +class ConfigureSystem; +} + +class ConfigureSystem : public QWidget { + Q_OBJECT + +public: + explicit ConfigureSystem(QWidget* parent = nullptr); + ~ConfigureSystem(); + + void applyConfiguration(); + void setConfiguration(); + +public slots: + void updateBirthdayComboBox(int birthmonth_index); + void refreshConsoleID(); + +private: + void ReadSystemSettings(); + + std::unique_ptr ui; + bool enabled; + + std::u16string username; + int birthmonth, birthday; + int language_index; + int sound_index; +}; diff --git a/src/yuzu/configuration/configure_system.ui b/src/yuzu/configuration/configure_system.ui new file mode 100644 index 000000000..8caf49623 --- /dev/null +++ b/src/yuzu/configuration/configure_system.ui @@ -0,0 +1,278 @@ + + + ConfigureSystem + + + + 0 + 0 + 360 + 377 + + + + Form + + + + + + + + System Settings + + + + + + Username + + + + + + + + 0 + 0 + + + + 10 + + + + + + + Birthday + + + + + + + + + + January + + + + + February + + + + + March + + + + + April + + + + + May + + + + + June + + + + + July + + + + + August + + + + + September + + + + + October + + + + + November + + + + + December + + + + + + + + + + + + + Language + + + + + + + Note: this can be overridden when region setting is auto-select + + + + Japanese (日本語) + + + + + English + + + + + French (français) + + + + + German (Deutsch) + + + + + Italian (italiano) + + + + + Spanish (español) + + + + + Simplified Chinese (简体中文) + + + + + Korean (한국어) + + + + + Dutch (Nederlands) + + + + + Portuguese (português) + + + + + Russian (Русский) + + + + + Traditional Chinese (正體中文) + + + + + + + + Sound output mode + + + + + + + + Mono + + + + + Stereo + + + + + Surround + + + + + + + + Console ID: + + + + + + + + 0 + 0 + + + + Qt::RightToLeft + + + Regenerate + + + + + + + + + + System settings are available only when game is not running. + + + true + + + + + + + Qt::Vertical + + + + 20 + 40 + + + + + + + + + + + diff --git a/src/yuzu/configuration/configure_web.cpp b/src/yuzu/configuration/configure_web.cpp new file mode 100644 index 000000000..bf8c21ac7 --- /dev/null +++ b/src/yuzu/configuration/configure_web.cpp @@ -0,0 +1,102 @@ +// Copyright 2017 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include +#include "citra_qt/configuration/configure_web.h" +#include "core/settings.h" +#include "core/telemetry_session.h" +#include "ui_configure_web.h" + +ConfigureWeb::ConfigureWeb(QWidget* parent) + : QWidget(parent), ui(std::make_unique()) { + ui->setupUi(this); + connect(ui->button_regenerate_telemetry_id, &QPushButton::clicked, this, + &ConfigureWeb::RefreshTelemetryID); + connect(ui->button_verify_login, &QPushButton::clicked, this, &ConfigureWeb::VerifyLogin); + connect(this, &ConfigureWeb::LoginVerified, this, &ConfigureWeb::OnLoginVerified); + + this->setConfiguration(); +} + +ConfigureWeb::~ConfigureWeb() {} + +void ConfigureWeb::setConfiguration() { + ui->web_credentials_disclaimer->setWordWrap(true); + ui->telemetry_learn_more->setOpenExternalLinks(true); + ui->telemetry_learn_more->setText(tr("Learn more")); + + ui->web_signup_link->setOpenExternalLinks(true); + ui->web_signup_link->setText(tr("Sign up")); + ui->web_token_info_link->setOpenExternalLinks(true); + ui->web_token_info_link->setText( + tr("What is my token?")); + + ui->toggle_telemetry->setChecked(Settings::values.enable_telemetry); + ui->edit_username->setText(QString::fromStdString(Settings::values.citra_username)); + ui->edit_token->setText(QString::fromStdString(Settings::values.citra_token)); + // Connect after setting the values, to avoid calling OnLoginChanged now + connect(ui->edit_token, &QLineEdit::textChanged, this, &ConfigureWeb::OnLoginChanged); + connect(ui->edit_username, &QLineEdit::textChanged, this, &ConfigureWeb::OnLoginChanged); + ui->label_telemetry_id->setText( + tr("Telemetry ID: 0x%1").arg(QString::number(Core::GetTelemetryId(), 16).toUpper())); + user_verified = true; +} + +void ConfigureWeb::applyConfiguration() { + Settings::values.enable_telemetry = ui->toggle_telemetry->isChecked(); + if (user_verified) { + Settings::values.citra_username = ui->edit_username->text().toStdString(); + Settings::values.citra_token = ui->edit_token->text().toStdString(); + } else { + QMessageBox::warning(this, tr("Username and token not verfied"), + tr("Username and token were not verified. The changes to your " + "username and/or token have not been saved.")); + } + Settings::Apply(); +} + +void ConfigureWeb::RefreshTelemetryID() { + const u64 new_telemetry_id{Core::RegenerateTelemetryId()}; + ui->label_telemetry_id->setText( + tr("Telemetry ID: 0x%1").arg(QString::number(new_telemetry_id, 16).toUpper())); +} + +void ConfigureWeb::OnLoginChanged() { + if (ui->edit_username->text().isEmpty() && ui->edit_token->text().isEmpty()) { + user_verified = true; + ui->label_username_verified->setPixmap(QPixmap(":/icons/checked.png")); + ui->label_token_verified->setPixmap(QPixmap(":/icons/checked.png")); + } else { + user_verified = false; + ui->label_username_verified->setPixmap(QPixmap(":/icons/failed.png")); + ui->label_token_verified->setPixmap(QPixmap(":/icons/failed.png")); + } +} + +void ConfigureWeb::VerifyLogin() { + verified = + Core::VerifyLogin(ui->edit_username->text().toStdString(), + ui->edit_token->text().toStdString(), [&]() { emit LoginVerified(); }); + ui->button_verify_login->setDisabled(true); + ui->button_verify_login->setText(tr("Verifying")); +} + +void ConfigureWeb::OnLoginVerified() { + ui->button_verify_login->setEnabled(true); + ui->button_verify_login->setText(tr("Verify")); + if (verified.get()) { + user_verified = true; + ui->label_username_verified->setPixmap(QPixmap(":/icons/checked.png")); + ui->label_token_verified->setPixmap(QPixmap(":/icons/checked.png")); + } else { + ui->label_username_verified->setPixmap(QPixmap(":/icons/failed.png")); + ui->label_token_verified->setPixmap(QPixmap(":/icons/failed.png")); + QMessageBox::critical( + this, tr("Verification failed"), + tr("Verification failed. Check that you have entered your username and token " + "correctly, and that your internet connection is working.")); + } +} diff --git a/src/yuzu/configuration/configure_web.h b/src/yuzu/configuration/configure_web.h new file mode 100644 index 000000000..ad2d58f6e --- /dev/null +++ b/src/yuzu/configuration/configure_web.h @@ -0,0 +1,40 @@ +// Copyright 2017 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#pragma once + +#include +#include +#include + +namespace Ui { +class ConfigureWeb; +} + +class ConfigureWeb : public QWidget { + Q_OBJECT + +public: + explicit ConfigureWeb(QWidget* parent = nullptr); + ~ConfigureWeb(); + + void applyConfiguration(); + +public slots: + void RefreshTelemetryID(); + void OnLoginChanged(); + void VerifyLogin(); + void OnLoginVerified(); + +signals: + void LoginVerified(); + +private: + void setConfiguration(); + + bool user_verified = true; + std::future verified; + + std::unique_ptr ui; +}; diff --git a/src/yuzu/configuration/configure_web.ui b/src/yuzu/configuration/configure_web.ui new file mode 100644 index 000000000..dd996ab62 --- /dev/null +++ b/src/yuzu/configuration/configure_web.ui @@ -0,0 +1,190 @@ + + + ConfigureWeb + + + + 0 + 0 + 926 + 561 + + + + Form + + + + + + + + Citra Web Service + + + + + + By providing your username and token, you agree to allow Citra to collect additional usage data, which may include user identifying information. + + + + + + + + + + 0 + 0 + + + + Qt::RightToLeft + + + Verify + + + + + + + Sign up + + + + + + + 36 + + + + + + + Token: + + + + + + + + + + + Username: + + + + + + + + + + + 36 + + + QLineEdit::Password + + + + + + + What is my token? + + + + + + + Qt::Horizontal + + + + 40 + 20 + + + + + + + + + + + + + Telemetry + + + + + + Share anonymous usage data with the Citra team + + + + + + + Learn more + + + + + + + + + Telemetry ID: + + + + + + + + 0 + 0 + + + + Qt::RightToLeft + + + Regenerate + + + + + + + + + + + + + + Qt::Vertical + + + + 20 + 40 + + + + + + + + + diff --git a/src/yuzu/debugger/graphics/graphics.cpp b/src/yuzu/debugger/graphics/graphics.cpp new file mode 100644 index 000000000..8154363a2 --- /dev/null +++ b/src/yuzu/debugger/graphics/graphics.cpp @@ -0,0 +1,77 @@ +// Copyright 2014 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include +#include "citra_qt/debugger/graphics/graphics.h" +#include "citra_qt/util/util.h" + +GraphicsDebugger g_debugger; + +GPUCommandStreamItemModel::GPUCommandStreamItemModel(QObject* parent) + : QAbstractListModel(parent), command_count(0) { + connect(this, SIGNAL(GXCommandFinished(int)), this, SLOT(OnGXCommandFinishedInternal(int))); +} + +int GPUCommandStreamItemModel::rowCount(const QModelIndex& parent) const { + return command_count; +} + +QVariant GPUCommandStreamItemModel::data(const QModelIndex& index, int role) const { + if (!index.isValid()) + return QVariant(); + + int command_index = index.row(); + const Service::GSP::Command& command = GetDebugger()->ReadGXCommandHistory(command_index); + if (role == Qt::DisplayRole) { + std::map command_names = { + {Service::GSP::CommandId::REQUEST_DMA, "REQUEST_DMA"}, + {Service::GSP::CommandId::SUBMIT_GPU_CMDLIST, "SUBMIT_GPU_CMDLIST"}, + {Service::GSP::CommandId::SET_MEMORY_FILL, "SET_MEMORY_FILL"}, + {Service::GSP::CommandId::SET_DISPLAY_TRANSFER, "SET_DISPLAY_TRANSFER"}, + {Service::GSP::CommandId::SET_TEXTURE_COPY, "SET_TEXTURE_COPY"}, + {Service::GSP::CommandId::CACHE_FLUSH, "CACHE_FLUSH"}, + }; + const u32* command_data = reinterpret_cast(&command); + QString str = QString("%1 %2 %3 %4 %5 %6 %7 %8 %9") + .arg(command_names[command.id]) + .arg(command_data[0], 8, 16, QLatin1Char('0')) + .arg(command_data[1], 8, 16, QLatin1Char('0')) + .arg(command_data[2], 8, 16, QLatin1Char('0')) + .arg(command_data[3], 8, 16, QLatin1Char('0')) + .arg(command_data[4], 8, 16, QLatin1Char('0')) + .arg(command_data[5], 8, 16, QLatin1Char('0')) + .arg(command_data[6], 8, 16, QLatin1Char('0')) + .arg(command_data[7], 8, 16, QLatin1Char('0')); + return QVariant(str); + } else { + return QVariant(); + } +} + +void GPUCommandStreamItemModel::GXCommandProcessed(int total_command_count) { + emit GXCommandFinished(total_command_count); +} + +void GPUCommandStreamItemModel::OnGXCommandFinishedInternal(int total_command_count) { + if (total_command_count == 0) + return; + + int prev_command_count = command_count; + command_count = total_command_count; + emit dataChanged(index(prev_command_count, 0), index(total_command_count - 1, 0)); +} + +GPUCommandStreamWidget::GPUCommandStreamWidget(QWidget* parent) + : QDockWidget(tr("Graphics Debugger"), parent) { + setObjectName("GraphicsDebugger"); + + GPUCommandStreamItemModel* command_model = new GPUCommandStreamItemModel(this); + g_debugger.RegisterObserver(command_model); + + QListView* command_list = new QListView; + command_list->setModel(command_model); + command_list->setFont(GetMonospaceFont()); + + setWidget(command_list); +} diff --git a/src/yuzu/debugger/graphics/graphics.h b/src/yuzu/debugger/graphics/graphics.h new file mode 100644 index 000000000..8837fb792 --- /dev/null +++ b/src/yuzu/debugger/graphics/graphics.h @@ -0,0 +1,41 @@ +// Copyright 2014 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#pragma once + +#include +#include +#include "video_core/gpu_debugger.h" + +class GPUCommandStreamItemModel : public QAbstractListModel, + public GraphicsDebugger::DebuggerObserver { + Q_OBJECT + +public: + explicit GPUCommandStreamItemModel(QObject* parent); + + int rowCount(const QModelIndex& parent = QModelIndex()) const override; + QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const override; + +public: + void GXCommandProcessed(int total_command_count) override; + +public slots: + void OnGXCommandFinishedInternal(int total_command_count); + +signals: + void GXCommandFinished(int total_command_count); + +private: + int command_count; +}; + +class GPUCommandStreamWidget : public QDockWidget { + Q_OBJECT + +public: + GPUCommandStreamWidget(QWidget* parent = nullptr); + +private: +}; diff --git a/src/yuzu/debugger/graphics/graphics_breakpoint_observer.cpp b/src/yuzu/debugger/graphics/graphics_breakpoint_observer.cpp new file mode 100644 index 000000000..dc6070dea --- /dev/null +++ b/src/yuzu/debugger/graphics/graphics_breakpoint_observer.cpp @@ -0,0 +1,27 @@ +// Copyright 2014 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include +#include "citra_qt/debugger/graphics/graphics_breakpoint_observer.h" + +BreakPointObserverDock::BreakPointObserverDock(std::shared_ptr debug_context, + const QString& title, QWidget* parent) + : QDockWidget(title, parent), BreakPointObserver(debug_context) { + qRegisterMetaType("Pica::DebugContext::Event"); + + connect(this, SIGNAL(Resumed()), this, SLOT(OnResumed())); + + // NOTE: This signal is emitted from a non-GUI thread, but connect() takes + // care of delaying its handling to the GUI thread. + connect(this, SIGNAL(BreakPointHit(Pica::DebugContext::Event, void*)), this, + SLOT(OnBreakPointHit(Pica::DebugContext::Event, void*)), Qt::BlockingQueuedConnection); +} + +void BreakPointObserverDock::OnPicaBreakPointHit(Pica::DebugContext::Event event, void* data) { + emit BreakPointHit(event, data); +} + +void BreakPointObserverDock::OnPicaResume() { + emit Resumed(); +} diff --git a/src/yuzu/debugger/graphics/graphics_breakpoint_observer.h b/src/yuzu/debugger/graphics/graphics_breakpoint_observer.h new file mode 100644 index 000000000..e77df4f5b --- /dev/null +++ b/src/yuzu/debugger/graphics/graphics_breakpoint_observer.h @@ -0,0 +1,33 @@ +// Copyright 2014 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#pragma once + +#include +#include "video_core/debug_utils/debug_utils.h" + +/** + * Utility class which forwards calls to OnPicaBreakPointHit and OnPicaResume to public slots. + * This is because the Pica breakpoint callbacks are called from a non-GUI thread, while + * the widget usually wants to perform reactions in the GUI thread. + */ +class BreakPointObserverDock : public QDockWidget, + protected Pica::DebugContext::BreakPointObserver { + Q_OBJECT + +public: + BreakPointObserverDock(std::shared_ptr debug_context, const QString& title, + QWidget* parent = nullptr); + + void OnPicaBreakPointHit(Pica::DebugContext::Event event, void* data) override; + void OnPicaResume() override; + +private slots: + virtual void OnBreakPointHit(Pica::DebugContext::Event event, void* data) = 0; + virtual void OnResumed() = 0; + +signals: + void Resumed(); + void BreakPointHit(Pica::DebugContext::Event event, void* data); +}; diff --git a/src/yuzu/debugger/graphics/graphics_breakpoints.cpp b/src/yuzu/debugger/graphics/graphics_breakpoints.cpp new file mode 100644 index 000000000..030828ba8 --- /dev/null +++ b/src/yuzu/debugger/graphics/graphics_breakpoints.cpp @@ -0,0 +1,213 @@ +// Copyright 2014 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include +#include +#include +#include +#include +#include "citra_qt/debugger/graphics/graphics_breakpoints.h" +#include "citra_qt/debugger/graphics/graphics_breakpoints_p.h" +#include "common/assert.h" + +BreakPointModel::BreakPointModel(std::shared_ptr debug_context, QObject* parent) + : QAbstractListModel(parent), context_weak(debug_context), + at_breakpoint(debug_context->at_breakpoint), + active_breakpoint(debug_context->active_breakpoint) {} + +int BreakPointModel::columnCount(const QModelIndex& parent) const { + return 1; +} + +int BreakPointModel::rowCount(const QModelIndex& parent) const { + return static_cast(Pica::DebugContext::Event::NumEvents); +} + +QVariant BreakPointModel::data(const QModelIndex& index, int role) const { + const auto event = static_cast(index.row()); + + switch (role) { + case Qt::DisplayRole: { + if (index.column() == 0) { + static const std::map map = { + {Pica::DebugContext::Event::PicaCommandLoaded, tr("Pica command loaded")}, + {Pica::DebugContext::Event::PicaCommandProcessed, tr("Pica command processed")}, + {Pica::DebugContext::Event::IncomingPrimitiveBatch, tr("Incoming primitive batch")}, + {Pica::DebugContext::Event::FinishedPrimitiveBatch, tr("Finished primitive batch")}, + {Pica::DebugContext::Event::VertexShaderInvocation, tr("Vertex shader invocation")}, + {Pica::DebugContext::Event::IncomingDisplayTransfer, + tr("Incoming display transfer")}, + {Pica::DebugContext::Event::GSPCommandProcessed, tr("GSP command processed")}, + {Pica::DebugContext::Event::BufferSwapped, tr("Buffers swapped")}, + }; + + DEBUG_ASSERT(map.size() == static_cast(Pica::DebugContext::Event::NumEvents)); + return (map.find(event) != map.end()) ? map.at(event) : QString(); + } + + break; + } + + case Qt::CheckStateRole: { + if (index.column() == 0) + return data(index, Role_IsEnabled).toBool() ? Qt::Checked : Qt::Unchecked; + break; + } + + case Qt::BackgroundRole: { + if (at_breakpoint && index.row() == static_cast(active_breakpoint)) { + return QBrush(QColor(0xE0, 0xE0, 0x10)); + } + break; + } + + case Role_IsEnabled: { + auto context = context_weak.lock(); + return context && context->breakpoints[(int)event].enabled; + } + + default: + break; + } + return QVariant(); +} + +Qt::ItemFlags BreakPointModel::flags(const QModelIndex& index) const { + if (!index.isValid()) + return 0; + + Qt::ItemFlags flags = Qt::ItemIsEnabled; + if (index.column() == 0) + flags |= Qt::ItemIsUserCheckable; + return flags; +} + +bool BreakPointModel::setData(const QModelIndex& index, const QVariant& value, int role) { + const auto event = static_cast(index.row()); + + switch (role) { + case Qt::CheckStateRole: { + if (index.column() != 0) + return false; + + auto context = context_weak.lock(); + if (!context) + return false; + + context->breakpoints[(int)event].enabled = value == Qt::Checked; + QModelIndex changed_index = createIndex(index.row(), 0); + emit dataChanged(changed_index, changed_index); + return true; + } + } + + return false; +} + +void BreakPointModel::OnBreakPointHit(Pica::DebugContext::Event event) { + auto context = context_weak.lock(); + if (!context) + return; + + active_breakpoint = context->active_breakpoint; + at_breakpoint = context->at_breakpoint; + emit dataChanged(createIndex(static_cast(event), 0), + createIndex(static_cast(event), 0)); +} + +void BreakPointModel::OnResumed() { + auto context = context_weak.lock(); + if (!context) + return; + + at_breakpoint = context->at_breakpoint; + emit dataChanged(createIndex(static_cast(active_breakpoint), 0), + createIndex(static_cast(active_breakpoint), 0)); + active_breakpoint = context->active_breakpoint; +} + +GraphicsBreakPointsWidget::GraphicsBreakPointsWidget( + std::shared_ptr debug_context, QWidget* parent) + : QDockWidget(tr("Pica Breakpoints"), parent), + Pica::DebugContext::BreakPointObserver(debug_context) { + setObjectName("PicaBreakPointsWidget"); + + status_text = new QLabel(tr("Emulation running")); + resume_button = new QPushButton(tr("Resume")); + resume_button->setEnabled(false); + + breakpoint_model = new BreakPointModel(debug_context, this); + breakpoint_list = new QTreeView; + breakpoint_list->setRootIsDecorated(false); + breakpoint_list->setHeaderHidden(true); + breakpoint_list->setModel(breakpoint_model); + + qRegisterMetaType("Pica::DebugContext::Event"); + + connect(breakpoint_list, SIGNAL(doubleClicked(const QModelIndex&)), this, + SLOT(OnItemDoubleClicked(const QModelIndex&))); + + connect(resume_button, SIGNAL(clicked()), this, SLOT(OnResumeRequested())); + + connect(this, SIGNAL(BreakPointHit(Pica::DebugContext::Event, void*)), this, + SLOT(OnBreakPointHit(Pica::DebugContext::Event, void*)), Qt::BlockingQueuedConnection); + connect(this, SIGNAL(Resumed()), this, SLOT(OnResumed())); + + connect(this, SIGNAL(BreakPointHit(Pica::DebugContext::Event, void*)), breakpoint_model, + SLOT(OnBreakPointHit(Pica::DebugContext::Event)), Qt::BlockingQueuedConnection); + connect(this, SIGNAL(Resumed()), breakpoint_model, SLOT(OnResumed())); + + connect(this, SIGNAL(BreakPointsChanged(const QModelIndex&, const QModelIndex&)), + breakpoint_model, SIGNAL(dataChanged(const QModelIndex&, const QModelIndex&))); + + QWidget* main_widget = new QWidget; + auto main_layout = new QVBoxLayout; + { + auto sub_layout = new QHBoxLayout; + sub_layout->addWidget(status_text); + sub_layout->addWidget(resume_button); + main_layout->addLayout(sub_layout); + } + main_layout->addWidget(breakpoint_list); + main_widget->setLayout(main_layout); + + setWidget(main_widget); +} + +void GraphicsBreakPointsWidget::OnPicaBreakPointHit(Event event, void* data) { + // Process in GUI thread + emit BreakPointHit(event, data); +} + +void GraphicsBreakPointsWidget::OnBreakPointHit(Pica::DebugContext::Event event, void* data) { + status_text->setText(tr("Emulation halted at breakpoint")); + resume_button->setEnabled(true); +} + +void GraphicsBreakPointsWidget::OnPicaResume() { + // Process in GUI thread + emit Resumed(); +} + +void GraphicsBreakPointsWidget::OnResumed() { + status_text->setText(tr("Emulation running")); + resume_button->setEnabled(false); +} + +void GraphicsBreakPointsWidget::OnResumeRequested() { + if (auto context = context_weak.lock()) + context->Resume(); +} + +void GraphicsBreakPointsWidget::OnItemDoubleClicked(const QModelIndex& index) { + if (!index.isValid()) + return; + + QModelIndex check_index = breakpoint_list->model()->index(index.row(), 0); + QVariant enabled = breakpoint_list->model()->data(check_index, Qt::CheckStateRole); + QVariant new_state = Qt::Unchecked; + if (enabled == Qt::Unchecked) + new_state = Qt::Checked; + breakpoint_list->model()->setData(check_index, new_state, Qt::CheckStateRole); +} diff --git a/src/yuzu/debugger/graphics/graphics_breakpoints.h b/src/yuzu/debugger/graphics/graphics_breakpoints.h new file mode 100644 index 000000000..bec72a2db --- /dev/null +++ b/src/yuzu/debugger/graphics/graphics_breakpoints.h @@ -0,0 +1,46 @@ +// Copyright 2014 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#pragma once + +#include +#include +#include "video_core/debug_utils/debug_utils.h" + +class QLabel; +class QPushButton; +class QTreeView; + +class BreakPointModel; + +class GraphicsBreakPointsWidget : public QDockWidget, Pica::DebugContext::BreakPointObserver { + Q_OBJECT + + using Event = Pica::DebugContext::Event; + +public: + explicit GraphicsBreakPointsWidget(std::shared_ptr debug_context, + QWidget* parent = nullptr); + + void OnPicaBreakPointHit(Pica::DebugContext::Event event, void* data) override; + void OnPicaResume() override; + +public slots: + void OnBreakPointHit(Pica::DebugContext::Event event, void* data); + void OnItemDoubleClicked(const QModelIndex&); + void OnResumeRequested(); + void OnResumed(); + +signals: + void Resumed(); + void BreakPointHit(Pica::DebugContext::Event event, void* data); + void BreakPointsChanged(const QModelIndex& topLeft, const QModelIndex& bottomRight); + +private: + QLabel* status_text; + QPushButton* resume_button; + + BreakPointModel* breakpoint_model; + QTreeView* breakpoint_list; +}; diff --git a/src/yuzu/debugger/graphics/graphics_breakpoints_p.h b/src/yuzu/debugger/graphics/graphics_breakpoints_p.h new file mode 100644 index 000000000..dc64706bd --- /dev/null +++ b/src/yuzu/debugger/graphics/graphics_breakpoints_p.h @@ -0,0 +1,36 @@ +// Copyright 2014 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#pragma once + +#include +#include +#include "video_core/debug_utils/debug_utils.h" + +class BreakPointModel : public QAbstractListModel { + Q_OBJECT + +public: + enum { + Role_IsEnabled = Qt::UserRole, + }; + + BreakPointModel(std::shared_ptr context, QObject* parent); + + int columnCount(const QModelIndex& parent = QModelIndex()) const override; + int rowCount(const QModelIndex& parent = QModelIndex()) const override; + QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const override; + Qt::ItemFlags flags(const QModelIndex& index) const override; + + bool setData(const QModelIndex& index, const QVariant& value, int role = Qt::EditRole) override; + +public slots: + void OnBreakPointHit(Pica::DebugContext::Event event); + void OnResumed(); + +private: + std::weak_ptr context_weak; + bool at_breakpoint; + Pica::DebugContext::Event active_breakpoint; +}; diff --git a/src/yuzu/debugger/graphics/graphics_cmdlists.cpp b/src/yuzu/debugger/graphics/graphics_cmdlists.cpp new file mode 100644 index 000000000..ce2b9fa50 --- /dev/null +++ b/src/yuzu/debugger/graphics/graphics_cmdlists.cpp @@ -0,0 +1,259 @@ +// Copyright 2014 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include "citra_qt/debugger/graphics/graphics_cmdlists.h" +#include "citra_qt/util/spinbox.h" +#include "citra_qt/util/util.h" +#include "common/vector_math.h" +#include "core/memory.h" +#include "video_core/debug_utils/debug_utils.h" +#include "video_core/pica_state.h" +#include "video_core/regs.h" +#include "video_core/texture/texture_decode.h" + +namespace { +QImage LoadTexture(const u8* src, const Pica::Texture::TextureInfo& info) { + QImage decoded_image(info.width, info.height, QImage::Format_ARGB32); + for (u32 y = 0; y < info.height; ++y) { + for (u32 x = 0; x < info.width; ++x) { + Math::Vec4 color = Pica::Texture::LookupTexture(src, x, y, info, true); + decoded_image.setPixel(x, y, qRgba(color.r(), color.g(), color.b(), color.a())); + } + } + + return decoded_image; +} + +class TextureInfoWidget : public QWidget { +public: + TextureInfoWidget(const u8* src, const Pica::Texture::TextureInfo& info, + QWidget* parent = nullptr) + : QWidget(parent) { + + QLabel* image_widget = new QLabel; + QPixmap image_pixmap = QPixmap::fromImage(LoadTexture(src, info)); + image_pixmap = image_pixmap.scaled(200, 100, Qt::KeepAspectRatio, Qt::SmoothTransformation); + image_widget->setPixmap(image_pixmap); + + QVBoxLayout* layout = new QVBoxLayout; + layout->addWidget(image_widget); + setLayout(layout); + } +}; +} // Anonymous namespace + +GPUCommandListModel::GPUCommandListModel(QObject* parent) : QAbstractListModel(parent) {} + +int GPUCommandListModel::rowCount(const QModelIndex& parent) const { + return static_cast(pica_trace.writes.size()); +} + +int GPUCommandListModel::columnCount(const QModelIndex& parent) const { + return 4; +} + +QVariant GPUCommandListModel::data(const QModelIndex& index, int role) const { + if (!index.isValid()) + return QVariant(); + + const auto& write = pica_trace.writes[index.row()]; + + if (role == Qt::DisplayRole) { + switch (index.column()) { + case 0: + return QString::fromLatin1(Pica::Regs::GetRegisterName(write.cmd_id)); + case 1: + return QString("%1").arg(write.cmd_id, 3, 16, QLatin1Char('0')); + case 2: + return QString("%1").arg(write.mask, 4, 2, QLatin1Char('0')); + case 3: + return QString("%1").arg(write.value, 8, 16, QLatin1Char('0')); + } + } else if (role == CommandIdRole) { + return QVariant::fromValue(write.cmd_id); + } + + return QVariant(); +} + +QVariant GPUCommandListModel::headerData(int section, Qt::Orientation orientation, int role) const { + switch (role) { + case Qt::DisplayRole: { + switch (section) { + case 0: + return tr("Command Name"); + case 1: + return tr("Register"); + case 2: + return tr("Mask"); + case 3: + return tr("New Value"); + } + + break; + } + } + + return QVariant(); +} + +void GPUCommandListModel::OnPicaTraceFinished(const Pica::DebugUtils::PicaTrace& trace) { + beginResetModel(); + + pica_trace = trace; + + endResetModel(); +} + +#define COMMAND_IN_RANGE(cmd_id, reg_name) \ + (cmd_id >= PICA_REG_INDEX(reg_name) && \ + cmd_id < PICA_REG_INDEX(reg_name) + sizeof(decltype(Pica::g_state.regs.reg_name)) / 4) + +void GPUCommandListWidget::OnCommandDoubleClicked(const QModelIndex& index) { + const unsigned int command_id = + list_widget->model()->data(index, GPUCommandListModel::CommandIdRole).toUInt(); + if (COMMAND_IN_RANGE(command_id, texturing.texture0) || + COMMAND_IN_RANGE(command_id, texturing.texture1) || + COMMAND_IN_RANGE(command_id, texturing.texture2)) { + + unsigned texture_index; + if (COMMAND_IN_RANGE(command_id, texturing.texture0)) { + texture_index = 0; + } else if (COMMAND_IN_RANGE(command_id, texturing.texture1)) { + texture_index = 1; + } else if (COMMAND_IN_RANGE(command_id, texturing.texture2)) { + texture_index = 2; + } else { + UNREACHABLE_MSG("Unknown texture command"); + } + + // TODO: Open a surface debugger + } +} + +void GPUCommandListWidget::SetCommandInfo(const QModelIndex& index) { + QWidget* new_info_widget = nullptr; + + const unsigned int command_id = + list_widget->model()->data(index, GPUCommandListModel::CommandIdRole).toUInt(); + if (COMMAND_IN_RANGE(command_id, texturing.texture0) || + COMMAND_IN_RANGE(command_id, texturing.texture1) || + COMMAND_IN_RANGE(command_id, texturing.texture2)) { + + unsigned texture_index; + if (COMMAND_IN_RANGE(command_id, texturing.texture0)) { + texture_index = 0; + } else if (COMMAND_IN_RANGE(command_id, texturing.texture1)) { + texture_index = 1; + } else { + texture_index = 2; + } + + const auto texture = Pica::g_state.regs.texturing.GetTextures()[texture_index]; + const auto config = texture.config; + const auto format = texture.format; + + const auto info = Pica::Texture::TextureInfo::FromPicaRegister(config, format); + const u8* src = Memory::GetPhysicalPointer(config.GetPhysicalAddress()); + new_info_widget = new TextureInfoWidget(src, info); + } + if (command_info_widget) { + delete command_info_widget; + command_info_widget = nullptr; + } + if (new_info_widget) { + widget()->layout()->addWidget(new_info_widget); + command_info_widget = new_info_widget; + } +} +#undef COMMAND_IN_RANGE + +GPUCommandListWidget::GPUCommandListWidget(QWidget* parent) + : QDockWidget(tr("Pica Command List"), parent) { + setObjectName("Pica Command List"); + GPUCommandListModel* model = new GPUCommandListModel(this); + + QWidget* main_widget = new QWidget; + + list_widget = new QTreeView; + list_widget->setModel(model); + list_widget->setFont(GetMonospaceFont()); + list_widget->setRootIsDecorated(false); + list_widget->setUniformRowHeights(true); + +#if QT_VERSION >= QT_VERSION_CHECK(5, 0, 0) + list_widget->header()->setSectionResizeMode(QHeaderView::ResizeToContents); +#else + list_widget->header()->setResizeMode(QHeaderView::ResizeToContents); +#endif + + connect(list_widget->selectionModel(), + SIGNAL(currentChanged(const QModelIndex&, const QModelIndex&)), this, + SLOT(SetCommandInfo(const QModelIndex&))); + connect(list_widget, SIGNAL(doubleClicked(const QModelIndex&)), this, + SLOT(OnCommandDoubleClicked(const QModelIndex&))); + + toggle_tracing = new QPushButton(tr("Start Tracing")); + QPushButton* copy_all = new QPushButton(tr("Copy All")); + + connect(toggle_tracing, SIGNAL(clicked()), this, SLOT(OnToggleTracing())); + connect(this, SIGNAL(TracingFinished(const Pica::DebugUtils::PicaTrace&)), model, + SLOT(OnPicaTraceFinished(const Pica::DebugUtils::PicaTrace&))); + + connect(copy_all, SIGNAL(clicked()), this, SLOT(CopyAllToClipboard())); + + command_info_widget = nullptr; + + QVBoxLayout* main_layout = new QVBoxLayout; + main_layout->addWidget(list_widget); + { + QHBoxLayout* sub_layout = new QHBoxLayout; + sub_layout->addWidget(toggle_tracing); + sub_layout->addWidget(copy_all); + main_layout->addLayout(sub_layout); + } + main_widget->setLayout(main_layout); + + setWidget(main_widget); +} + +void GPUCommandListWidget::OnToggleTracing() { + if (!Pica::DebugUtils::IsPicaTracing()) { + Pica::DebugUtils::StartPicaTracing(); + toggle_tracing->setText(tr("Finish Tracing")); + } else { + pica_trace = Pica::DebugUtils::FinishPicaTracing(); + emit TracingFinished(*pica_trace); + toggle_tracing->setText(tr("Start Tracing")); + } +} + +void GPUCommandListWidget::CopyAllToClipboard() { + QClipboard* clipboard = QApplication::clipboard(); + QString text; + + QAbstractItemModel* model = static_cast(list_widget->model()); + + for (int row = 0; row < model->rowCount({}); ++row) { + for (int col = 0; col < model->columnCount({}); ++col) { + QModelIndex index = model->index(row, col); + text += model->data(index).value(); + text += '\t'; + } + text += '\n'; + } + + clipboard->setText(text); +} diff --git a/src/yuzu/debugger/graphics/graphics_cmdlists.h b/src/yuzu/debugger/graphics/graphics_cmdlists.h new file mode 100644 index 000000000..8f40b94c5 --- /dev/null +++ b/src/yuzu/debugger/graphics/graphics_cmdlists.h @@ -0,0 +1,61 @@ +// Copyright 2014 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#pragma once + +#include +#include +#include "video_core/debug_utils/debug_utils.h" +#include "video_core/gpu_debugger.h" + +class QPushButton; +class QTreeView; + +class GPUCommandListModel : public QAbstractListModel { + Q_OBJECT + +public: + enum { + CommandIdRole = Qt::UserRole, + }; + + explicit GPUCommandListModel(QObject* parent); + + int columnCount(const QModelIndex& parent = QModelIndex()) const override; + int rowCount(const QModelIndex& parent = QModelIndex()) const override; + QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const override; + QVariant headerData(int section, Qt::Orientation orientation, + int role = Qt::DisplayRole) const override; + +public slots: + void OnPicaTraceFinished(const Pica::DebugUtils::PicaTrace& trace); + +private: + Pica::DebugUtils::PicaTrace pica_trace; +}; + +class GPUCommandListWidget : public QDockWidget { + Q_OBJECT + +public: + explicit GPUCommandListWidget(QWidget* parent = nullptr); + +public slots: + void OnToggleTracing(); + void OnCommandDoubleClicked(const QModelIndex&); + + void SetCommandInfo(const QModelIndex&); + + void CopyAllToClipboard(); + +signals: + void TracingFinished(const Pica::DebugUtils::PicaTrace&); + +private: + std::unique_ptr pica_trace; + + QTreeView* list_widget; + QWidget* command_info_widget; + QPushButton* toggle_tracing; +}; diff --git a/src/yuzu/debugger/graphics/graphics_surface.cpp b/src/yuzu/debugger/graphics/graphics_surface.cpp new file mode 100644 index 000000000..c974545ef --- /dev/null +++ b/src/yuzu/debugger/graphics/graphics_surface.cpp @@ -0,0 +1,713 @@ +// Copyright 2014 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include "citra_qt/debugger/graphics/graphics_surface.h" +#include "citra_qt/util/spinbox.h" +#include "common/color.h" +#include "core/hw/gpu.h" +#include "core/memory.h" +#include "video_core/pica_state.h" +#include "video_core/regs_framebuffer.h" +#include "video_core/regs_texturing.h" +#include "video_core/texture/texture_decode.h" +#include "video_core/utils.h" + +SurfacePicture::SurfacePicture(QWidget* parent, GraphicsSurfaceWidget* surface_widget_) + : QLabel(parent), surface_widget(surface_widget_) {} +SurfacePicture::~SurfacePicture() {} + +void SurfacePicture::mousePressEvent(QMouseEvent* event) { + // Only do something while the left mouse button is held down + if (!(event->buttons() & Qt::LeftButton)) + return; + + if (pixmap() == nullptr) + return; + + if (surface_widget) + surface_widget->Pick(event->x() * pixmap()->width() / width(), + event->y() * pixmap()->height() / height()); +} + +void SurfacePicture::mouseMoveEvent(QMouseEvent* event) { + // We also want to handle the event if the user moves the mouse while holding down the LMB + mousePressEvent(event); +} + +GraphicsSurfaceWidget::GraphicsSurfaceWidget(std::shared_ptr debug_context, + QWidget* parent) + : BreakPointObserverDock(debug_context, tr("Pica Surface Viewer"), parent), + surface_source(Source::ColorBuffer) { + setObjectName("PicaSurface"); + + surface_source_list = new QComboBox; + surface_source_list->addItem(tr("Color Buffer")); + surface_source_list->addItem(tr("Depth Buffer")); + surface_source_list->addItem(tr("Stencil Buffer")); + surface_source_list->addItem(tr("Texture 0")); + surface_source_list->addItem(tr("Texture 1")); + surface_source_list->addItem(tr("Texture 2")); + surface_source_list->addItem(tr("Custom")); + surface_source_list->setCurrentIndex(static_cast(surface_source)); + + surface_address_control = new CSpinBox; + surface_address_control->SetBase(16); + surface_address_control->SetRange(0, 0xFFFFFFFF); + surface_address_control->SetPrefix("0x"); + + unsigned max_dimension = 16384; // TODO: Find actual maximum + + surface_width_control = new QSpinBox; + surface_width_control->setRange(0, max_dimension); + + surface_height_control = new QSpinBox; + surface_height_control->setRange(0, max_dimension); + + surface_picker_x_control = new QSpinBox; + surface_picker_x_control->setRange(0, max_dimension - 1); + + surface_picker_y_control = new QSpinBox; + surface_picker_y_control->setRange(0, max_dimension - 1); + + surface_format_control = new QComboBox; + + // Color formats sorted by Pica texture format index + surface_format_control->addItem(tr("RGBA8")); + surface_format_control->addItem(tr("RGB8")); + surface_format_control->addItem(tr("RGB5A1")); + surface_format_control->addItem(tr("RGB565")); + surface_format_control->addItem(tr("RGBA4")); + surface_format_control->addItem(tr("IA8")); + surface_format_control->addItem(tr("RG8")); + surface_format_control->addItem(tr("I8")); + surface_format_control->addItem(tr("A8")); + surface_format_control->addItem(tr("IA4")); + surface_format_control->addItem(tr("I4")); + surface_format_control->addItem(tr("A4")); + surface_format_control->addItem(tr("ETC1")); + surface_format_control->addItem(tr("ETC1A4")); + surface_format_control->addItem(tr("D16")); + surface_format_control->addItem(tr("D24")); + surface_format_control->addItem(tr("D24X8")); + surface_format_control->addItem(tr("X24S8")); + surface_format_control->addItem(tr("Unknown")); + + surface_info_label = new QLabel(); + surface_info_label->setWordWrap(true); + + surface_picture_label = new SurfacePicture(0, this); + surface_picture_label->setSizePolicy(QSizePolicy::Fixed, QSizePolicy::Fixed); + surface_picture_label->setAlignment(Qt::AlignLeft | Qt::AlignTop); + surface_picture_label->setScaledContents(false); + + auto scroll_area = new QScrollArea(); + scroll_area->setBackgroundRole(QPalette::Dark); + scroll_area->setWidgetResizable(false); + scroll_area->setWidget(surface_picture_label); + + save_surface = new QPushButton(QIcon::fromTheme("document-save"), tr("Save")); + + // Connections + connect(this, SIGNAL(Update()), this, SLOT(OnUpdate())); + connect(surface_source_list, SIGNAL(currentIndexChanged(int)), this, + SLOT(OnSurfaceSourceChanged(int))); + connect(surface_address_control, SIGNAL(ValueChanged(qint64)), this, + SLOT(OnSurfaceAddressChanged(qint64))); + connect(surface_width_control, SIGNAL(valueChanged(int)), this, + SLOT(OnSurfaceWidthChanged(int))); + connect(surface_height_control, SIGNAL(valueChanged(int)), this, + SLOT(OnSurfaceHeightChanged(int))); + connect(surface_format_control, SIGNAL(currentIndexChanged(int)), this, + SLOT(OnSurfaceFormatChanged(int))); + connect(surface_picker_x_control, SIGNAL(valueChanged(int)), this, + SLOT(OnSurfacePickerXChanged(int))); + connect(surface_picker_y_control, SIGNAL(valueChanged(int)), this, + SLOT(OnSurfacePickerYChanged(int))); + connect(save_surface, SIGNAL(clicked()), this, SLOT(SaveSurface())); + + auto main_widget = new QWidget; + auto main_layout = new QVBoxLayout; + { + auto sub_layout = new QHBoxLayout; + sub_layout->addWidget(new QLabel(tr("Source:"))); + sub_layout->addWidget(surface_source_list); + main_layout->addLayout(sub_layout); + } + { + auto sub_layout = new QHBoxLayout; + sub_layout->addWidget(new QLabel(tr("Physical Address:"))); + sub_layout->addWidget(surface_address_control); + main_layout->addLayout(sub_layout); + } + { + auto sub_layout = new QHBoxLayout; + sub_layout->addWidget(new QLabel(tr("Width:"))); + sub_layout->addWidget(surface_width_control); + main_layout->addLayout(sub_layout); + } + { + auto sub_layout = new QHBoxLayout; + sub_layout->addWidget(new QLabel(tr("Height:"))); + sub_layout->addWidget(surface_height_control); + main_layout->addLayout(sub_layout); + } + { + auto sub_layout = new QHBoxLayout; + sub_layout->addWidget(new QLabel(tr("Format:"))); + sub_layout->addWidget(surface_format_control); + main_layout->addLayout(sub_layout); + } + main_layout->addWidget(scroll_area); + + auto info_layout = new QHBoxLayout; + { + auto xy_layout = new QVBoxLayout; + { + { + auto sub_layout = new QHBoxLayout; + sub_layout->addWidget(new QLabel(tr("X:"))); + sub_layout->addWidget(surface_picker_x_control); + xy_layout->addLayout(sub_layout); + } + { + auto sub_layout = new QHBoxLayout; + sub_layout->addWidget(new QLabel(tr("Y:"))); + sub_layout->addWidget(surface_picker_y_control); + xy_layout->addLayout(sub_layout); + } + } + info_layout->addLayout(xy_layout); + surface_info_label->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Minimum); + info_layout->addWidget(surface_info_label); + } + main_layout->addLayout(info_layout); + + main_layout->addWidget(save_surface); + main_widget->setLayout(main_layout); + setWidget(main_widget); + + // Load current data - TODO: Make sure this works when emulation is not running + if (debug_context && debug_context->at_breakpoint) { + emit Update(); + widget()->setEnabled(debug_context->at_breakpoint); + } else { + widget()->setEnabled(false); + } +} + +void GraphicsSurfaceWidget::OnBreakPointHit(Pica::DebugContext::Event event, void* data) { + emit Update(); + widget()->setEnabled(true); +} + +void GraphicsSurfaceWidget::OnResumed() { + widget()->setEnabled(false); +} + +void GraphicsSurfaceWidget::OnSurfaceSourceChanged(int new_value) { + surface_source = static_cast(new_value); + emit Update(); +} + +void GraphicsSurfaceWidget::OnSurfaceAddressChanged(qint64 new_value) { + if (surface_address != new_value) { + surface_address = static_cast(new_value); + + surface_source_list->setCurrentIndex(static_cast(Source::Custom)); + emit Update(); + } +} + +void GraphicsSurfaceWidget::OnSurfaceWidthChanged(int new_value) { + if (surface_width != static_cast(new_value)) { + surface_width = static_cast(new_value); + + surface_source_list->setCurrentIndex(static_cast(Source::Custom)); + emit Update(); + } +} + +void GraphicsSurfaceWidget::OnSurfaceHeightChanged(int new_value) { + if (surface_height != static_cast(new_value)) { + surface_height = static_cast(new_value); + + surface_source_list->setCurrentIndex(static_cast(Source::Custom)); + emit Update(); + } +} + +void GraphicsSurfaceWidget::OnSurfaceFormatChanged(int new_value) { + if (surface_format != static_cast(new_value)) { + surface_format = static_cast(new_value); + + surface_source_list->setCurrentIndex(static_cast(Source::Custom)); + emit Update(); + } +} + +void GraphicsSurfaceWidget::OnSurfacePickerXChanged(int new_value) { + if (surface_picker_x != new_value) { + surface_picker_x = new_value; + Pick(surface_picker_x, surface_picker_y); + } +} + +void GraphicsSurfaceWidget::OnSurfacePickerYChanged(int new_value) { + if (surface_picker_y != new_value) { + surface_picker_y = new_value; + Pick(surface_picker_x, surface_picker_y); + } +} + +void GraphicsSurfaceWidget::Pick(int x, int y) { + surface_picker_x_control->setValue(x); + surface_picker_y_control->setValue(y); + + if (x < 0 || x >= static_cast(surface_width) || y < 0 || + y >= static_cast(surface_height)) { + surface_info_label->setText(tr("Pixel out of bounds")); + surface_info_label->setAlignment(Qt::AlignLeft | Qt::AlignVCenter); + return; + } + + u8* buffer = Memory::GetPhysicalPointer(surface_address); + if (buffer == nullptr) { + surface_info_label->setText(tr("(unable to access pixel data)")); + surface_info_label->setAlignment(Qt::AlignCenter); + return; + } + + unsigned nibbles_per_pixel = GraphicsSurfaceWidget::NibblesPerPixel(surface_format); + unsigned stride = nibbles_per_pixel * surface_width / 2; + + unsigned bytes_per_pixel; + bool nibble_mode = (nibbles_per_pixel == 1); + if (nibble_mode) { + // As nibbles are contained in a byte we still need to access one byte per nibble + bytes_per_pixel = 1; + } else { + bytes_per_pixel = nibbles_per_pixel / 2; + } + + const u32 coarse_y = y & ~7; + u32 offset = VideoCore::GetMortonOffset(x, y, bytes_per_pixel) + coarse_y * stride; + const u8* pixel = buffer + (nibble_mode ? (offset / 2) : offset); + + auto GetText = [offset](Format format, const u8* pixel) { + switch (format) { + case Format::RGBA8: { + auto value = Color::DecodeRGBA8(pixel) / 255.0f; + return QString("Red: %1, Green: %2, Blue: %3, Alpha: %4") + .arg(QString::number(value.r(), 'f', 2)) + .arg(QString::number(value.g(), 'f', 2)) + .arg(QString::number(value.b(), 'f', 2)) + .arg(QString::number(value.a(), 'f', 2)); + } + case Format::RGB8: { + auto value = Color::DecodeRGB8(pixel) / 255.0f; + return QString("Red: %1, Green: %2, Blue: %3") + .arg(QString::number(value.r(), 'f', 2)) + .arg(QString::number(value.g(), 'f', 2)) + .arg(QString::number(value.b(), 'f', 2)); + } + case Format::RGB5A1: { + auto value = Color::DecodeRGB5A1(pixel) / 255.0f; + return QString("Red: %1, Green: %2, Blue: %3, Alpha: %4") + .arg(QString::number(value.r(), 'f', 2)) + .arg(QString::number(value.g(), 'f', 2)) + .arg(QString::number(value.b(), 'f', 2)) + .arg(QString::number(value.a(), 'f', 2)); + } + case Format::RGB565: { + auto value = Color::DecodeRGB565(pixel) / 255.0f; + return QString("Red: %1, Green: %2, Blue: %3") + .arg(QString::number(value.r(), 'f', 2)) + .arg(QString::number(value.g(), 'f', 2)) + .arg(QString::number(value.b(), 'f', 2)); + } + case Format::RGBA4: { + auto value = Color::DecodeRGBA4(pixel) / 255.0f; + return QString("Red: %1, Green: %2, Blue: %3, Alpha: %4") + .arg(QString::number(value.r(), 'f', 2)) + .arg(QString::number(value.g(), 'f', 2)) + .arg(QString::number(value.b(), 'f', 2)) + .arg(QString::number(value.a(), 'f', 2)); + } + case Format::IA8: + return QString("Index: %1, Alpha: %2").arg(pixel[0]).arg(pixel[1]); + case Format::RG8: { + auto value = Color::DecodeRG8(pixel) / 255.0f; + return QString("Red: %1, Green: %2") + .arg(QString::number(value.r(), 'f', 2)) + .arg(QString::number(value.g(), 'f', 2)); + } + case Format::I8: + return QString("Index: %1").arg(*pixel); + case Format::A8: + return QString("Alpha: %1").arg(QString::number(*pixel / 255.0f, 'f', 2)); + case Format::IA4: + return QString("Index: %1, Alpha: %2").arg(*pixel & 0xF).arg((*pixel & 0xF0) >> 4); + case Format::I4: { + u8 i = (*pixel >> ((offset % 2) ? 4 : 0)) & 0xF; + return QString("Index: %1").arg(i); + } + case Format::A4: { + u8 a = (*pixel >> ((offset % 2) ? 4 : 0)) & 0xF; + return QString("Alpha: %1").arg(QString::number(a / 15.0f, 'f', 2)); + } + case Format::ETC1: + case Format::ETC1A4: + // TODO: Display block information or channel values? + return QString("Compressed data"); + case Format::D16: { + auto value = Color::DecodeD16(pixel); + return QString("Depth: %1").arg(QString::number(value / (float)0xFFFF, 'f', 4)); + } + case Format::D24: { + auto value = Color::DecodeD24(pixel); + return QString("Depth: %1").arg(QString::number(value / (float)0xFFFFFF, 'f', 4)); + } + case Format::D24X8: + case Format::X24S8: { + auto values = Color::DecodeD24S8(pixel); + return QString("Depth: %1, Stencil: %2") + .arg(QString::number(values[0] / (float)0xFFFFFF, 'f', 4)) + .arg(values[1]); + } + case Format::Unknown: + return QString("Unknown format"); + default: + return QString("Unhandled format"); + } + return QString(""); + }; + + QString nibbles = ""; + for (unsigned i = 0; i < nibbles_per_pixel; i++) { + unsigned nibble_index = i; + if (nibble_mode) { + nibble_index += (offset % 2) ? 0 : 1; + } + u8 byte = pixel[nibble_index / 2]; + u8 nibble = (byte >> ((nibble_index % 2) ? 0 : 4)) & 0xF; + nibbles.append(QString::number(nibble, 16).toUpper()); + } + + surface_info_label->setText( + QString("Raw: 0x%3\n(%4)").arg(nibbles).arg(GetText(surface_format, pixel))); + surface_info_label->setAlignment(Qt::AlignLeft | Qt::AlignVCenter); +} + +void GraphicsSurfaceWidget::OnUpdate() { + QPixmap pixmap; + + switch (surface_source) { + case Source::ColorBuffer: { + // TODO: Store a reference to the registers in the debug context instead of accessing them + // directly... + + const auto& framebuffer = Pica::g_state.regs.framebuffer.framebuffer; + + surface_address = framebuffer.GetColorBufferPhysicalAddress(); + surface_width = framebuffer.GetWidth(); + surface_height = framebuffer.GetHeight(); + + switch (framebuffer.color_format) { + case Pica::FramebufferRegs::ColorFormat::RGBA8: + surface_format = Format::RGBA8; + break; + + case Pica::FramebufferRegs::ColorFormat::RGB8: + surface_format = Format::RGB8; + break; + + case Pica::FramebufferRegs::ColorFormat::RGB5A1: + surface_format = Format::RGB5A1; + break; + + case Pica::FramebufferRegs::ColorFormat::RGB565: + surface_format = Format::RGB565; + break; + + case Pica::FramebufferRegs::ColorFormat::RGBA4: + surface_format = Format::RGBA4; + break; + + default: + surface_format = Format::Unknown; + break; + } + + break; + } + + case Source::DepthBuffer: { + const auto& framebuffer = Pica::g_state.regs.framebuffer.framebuffer; + + surface_address = framebuffer.GetDepthBufferPhysicalAddress(); + surface_width = framebuffer.GetWidth(); + surface_height = framebuffer.GetHeight(); + + switch (framebuffer.depth_format) { + case Pica::FramebufferRegs::DepthFormat::D16: + surface_format = Format::D16; + break; + + case Pica::FramebufferRegs::DepthFormat::D24: + surface_format = Format::D24; + break; + + case Pica::FramebufferRegs::DepthFormat::D24S8: + surface_format = Format::D24X8; + break; + + default: + surface_format = Format::Unknown; + break; + } + + break; + } + + case Source::StencilBuffer: { + const auto& framebuffer = Pica::g_state.regs.framebuffer.framebuffer; + + surface_address = framebuffer.GetDepthBufferPhysicalAddress(); + surface_width = framebuffer.GetWidth(); + surface_height = framebuffer.GetHeight(); + + switch (framebuffer.depth_format) { + case Pica::FramebufferRegs::DepthFormat::D24S8: + surface_format = Format::X24S8; + break; + + default: + surface_format = Format::Unknown; + break; + } + + break; + } + + case Source::Texture0: + case Source::Texture1: + case Source::Texture2: { + unsigned texture_index; + if (surface_source == Source::Texture0) + texture_index = 0; + else if (surface_source == Source::Texture1) + texture_index = 1; + else if (surface_source == Source::Texture2) + texture_index = 2; + else { + qDebug() << "Unknown texture source " << static_cast(surface_source); + break; + } + + const auto texture = Pica::g_state.regs.texturing.GetTextures()[texture_index]; + auto info = Pica::Texture::TextureInfo::FromPicaRegister(texture.config, texture.format); + + surface_address = info.physical_address; + surface_width = info.width; + surface_height = info.height; + surface_format = static_cast(info.format); + + if (surface_format > Format::MaxTextureFormat) { + qDebug() << "Unknown texture format " << static_cast(info.format); + } + break; + } + + case Source::Custom: { + // Keep user-specified values + break; + } + + default: + qDebug() << "Unknown surface source " << static_cast(surface_source); + break; + } + + surface_address_control->SetValue(surface_address); + surface_width_control->setValue(surface_width); + surface_height_control->setValue(surface_height); + surface_format_control->setCurrentIndex(static_cast(surface_format)); + + // TODO: Implement a good way to visualize alpha components! + + QImage decoded_image(surface_width, surface_height, QImage::Format_ARGB32); + u8* buffer = Memory::GetPhysicalPointer(surface_address); + + if (buffer == nullptr) { + surface_picture_label->hide(); + surface_info_label->setText(tr("(invalid surface address)")); + surface_info_label->setAlignment(Qt::AlignCenter); + surface_picker_x_control->setEnabled(false); + surface_picker_y_control->setEnabled(false); + save_surface->setEnabled(false); + return; + } + + if (surface_format == Format::Unknown) { + surface_picture_label->hide(); + surface_info_label->setText(tr("(unknown surface format)")); + surface_info_label->setAlignment(Qt::AlignCenter); + surface_picker_x_control->setEnabled(false); + surface_picker_y_control->setEnabled(false); + save_surface->setEnabled(false); + return; + } + + surface_picture_label->show(); + + if (surface_format <= Format::MaxTextureFormat) { + // Generate a virtual texture + Pica::Texture::TextureInfo info; + info.physical_address = surface_address; + info.width = surface_width; + info.height = surface_height; + info.format = static_cast(surface_format); + info.SetDefaultStride(); + + for (unsigned int y = 0; y < surface_height; ++y) { + for (unsigned int x = 0; x < surface_width; ++x) { + Math::Vec4 color = Pica::Texture::LookupTexture(buffer, x, y, info, true); + decoded_image.setPixel(x, y, qRgba(color.r(), color.g(), color.b(), color.a())); + } + } + } else { + // We handle depth formats here because DebugUtils only supports TextureFormats + + // TODO(yuriks): Convert to newer tile-based addressing + unsigned nibbles_per_pixel = GraphicsSurfaceWidget::NibblesPerPixel(surface_format); + unsigned stride = nibbles_per_pixel * surface_width / 2; + + ASSERT_MSG(nibbles_per_pixel >= 2, + "Depth decoder only supports formats with at least one byte per pixel"); + unsigned bytes_per_pixel = nibbles_per_pixel / 2; + + for (unsigned int y = 0; y < surface_height; ++y) { + for (unsigned int x = 0; x < surface_width; ++x) { + const u32 coarse_y = y & ~7; + u32 offset = VideoCore::GetMortonOffset(x, y, bytes_per_pixel) + coarse_y * stride; + const u8* pixel = buffer + offset; + Math::Vec4 color = {0, 0, 0, 0}; + + switch (surface_format) { + case Format::D16: { + u32 data = Color::DecodeD16(pixel); + color.r() = data & 0xFF; + color.g() = (data >> 8) & 0xFF; + break; + } + case Format::D24: { + u32 data = Color::DecodeD24(pixel); + color.r() = data & 0xFF; + color.g() = (data >> 8) & 0xFF; + color.b() = (data >> 16) & 0xFF; + break; + } + case Format::D24X8: { + Math::Vec2 data = Color::DecodeD24S8(pixel); + color.r() = data.x & 0xFF; + color.g() = (data.x >> 8) & 0xFF; + color.b() = (data.x >> 16) & 0xFF; + break; + } + case Format::X24S8: { + Math::Vec2 data = Color::DecodeD24S8(pixel); + color.r() = color.g() = color.b() = data.y; + break; + } + default: + qDebug() << "Unknown surface format " << static_cast(surface_format); + break; + } + + decoded_image.setPixel(x, y, qRgba(color.r(), color.g(), color.b(), 255)); + } + } + } + + pixmap = QPixmap::fromImage(decoded_image); + surface_picture_label->setPixmap(pixmap); + surface_picture_label->resize(pixmap.size()); + + // Update the info with pixel data + surface_picker_x_control->setEnabled(true); + surface_picker_y_control->setEnabled(true); + Pick(surface_picker_x, surface_picker_y); + + // Enable saving the converted pixmap to file + save_surface->setEnabled(true); +} + +void GraphicsSurfaceWidget::SaveSurface() { + QString png_filter = tr("Portable Network Graphic (*.png)"); + QString bin_filter = tr("Binary data (*.bin)"); + + QString selectedFilter; + QString filename = QFileDialog::getSaveFileName( + this, tr("Save Surface"), + QString("texture-0x%1.png").arg(QString::number(surface_address, 16)), + QString("%1;;%2").arg(png_filter, bin_filter), &selectedFilter); + + if (filename.isEmpty()) { + // If the user canceled the dialog, don't save anything. + return; + } + + if (selectedFilter == png_filter) { + const QPixmap* pixmap = surface_picture_label->pixmap(); + ASSERT_MSG(pixmap != nullptr, "No pixmap set"); + + QFile file(filename); + file.open(QIODevice::WriteOnly); + if (pixmap) + pixmap->save(&file, "PNG"); + } else if (selectedFilter == bin_filter) { + const u8* buffer = Memory::GetPhysicalPointer(surface_address); + ASSERT_MSG(buffer != nullptr, "Memory not accessible"); + + QFile file(filename); + file.open(QIODevice::WriteOnly); + int size = surface_width * surface_height * NibblesPerPixel(surface_format) / 2; + QByteArray data(reinterpret_cast(buffer), size); + file.write(data); + } else { + UNREACHABLE_MSG("Unhandled filter selected"); + } +} + +unsigned int GraphicsSurfaceWidget::NibblesPerPixel(GraphicsSurfaceWidget::Format format) { + if (format <= Format::MaxTextureFormat) { + return Pica::TexturingRegs::NibblesPerPixel( + static_cast(format)); + } + + switch (format) { + case Format::D24X8: + case Format::X24S8: + return 4 * 2; + case Format::D24: + return 3 * 2; + case Format::D16: + return 2 * 2; + default: + UNREACHABLE_MSG("GraphicsSurfaceWidget::BytesPerPixel: this should not be reached as this " + "function should be given a format which is in " + "GraphicsSurfaceWidget::Format. Instead got %i", + static_cast(format)); + return 0; + } +} diff --git a/src/yuzu/debugger/graphics/graphics_surface.h b/src/yuzu/debugger/graphics/graphics_surface.h new file mode 100644 index 000000000..28f5650a7 --- /dev/null +++ b/src/yuzu/debugger/graphics/graphics_surface.h @@ -0,0 +1,118 @@ +// Copyright 2014 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#pragma once + +#include +#include +#include "citra_qt/debugger/graphics/graphics_breakpoint_observer.h" + +class QComboBox; +class QSpinBox; +class CSpinBox; + +class GraphicsSurfaceWidget; + +class SurfacePicture : public QLabel { + Q_OBJECT + +public: + explicit SurfacePicture(QWidget* parent = nullptr, + GraphicsSurfaceWidget* surface_widget = nullptr); + ~SurfacePicture(); + +protected slots: + virtual void mouseMoveEvent(QMouseEvent* event); + virtual void mousePressEvent(QMouseEvent* event); + +private: + GraphicsSurfaceWidget* surface_widget; +}; + +class GraphicsSurfaceWidget : public BreakPointObserverDock { + Q_OBJECT + + using Event = Pica::DebugContext::Event; + + enum class Source { + ColorBuffer = 0, + DepthBuffer = 1, + StencilBuffer = 2, + Texture0 = 3, + Texture1 = 4, + Texture2 = 5, + Custom = 6, + }; + + enum class Format { + // These must match the TextureFormat type! + RGBA8 = 0, + RGB8 = 1, + RGB5A1 = 2, + RGB565 = 3, + RGBA4 = 4, + IA8 = 5, + RG8 = 6, ///< @note Also called HILO8 in 3DBrew. + I8 = 7, + A8 = 8, + IA4 = 9, + I4 = 10, + A4 = 11, + ETC1 = 12, // compressed + ETC1A4 = 13, + MaxTextureFormat = 13, + D16 = 14, + D24 = 15, + D24X8 = 16, + X24S8 = 17, + Unknown = 18, + }; + + static unsigned int NibblesPerPixel(Format format); + +public: + explicit GraphicsSurfaceWidget(std::shared_ptr debug_context, + QWidget* parent = nullptr); + void Pick(int x, int y); + +public slots: + void OnSurfaceSourceChanged(int new_value); + void OnSurfaceAddressChanged(qint64 new_value); + void OnSurfaceWidthChanged(int new_value); + void OnSurfaceHeightChanged(int new_value); + void OnSurfaceFormatChanged(int new_value); + void OnSurfacePickerXChanged(int new_value); + void OnSurfacePickerYChanged(int new_value); + void OnUpdate(); + +private slots: + void OnBreakPointHit(Pica::DebugContext::Event event, void* data) override; + void OnResumed() override; + + void SaveSurface(); + +signals: + void Update(); + +private: + QComboBox* surface_source_list; + CSpinBox* surface_address_control; + QSpinBox* surface_width_control; + QSpinBox* surface_height_control; + QComboBox* surface_format_control; + + SurfacePicture* surface_picture_label; + QSpinBox* surface_picker_x_control; + QSpinBox* surface_picker_y_control; + QLabel* surface_info_label; + QPushButton* save_surface; + + Source surface_source; + unsigned surface_address; + unsigned surface_width; + unsigned surface_height; + Format surface_format; + int surface_picker_x = 0; + int surface_picker_y = 0; +}; diff --git a/src/yuzu/debugger/graphics/graphics_tracing.cpp b/src/yuzu/debugger/graphics/graphics_tracing.cpp new file mode 100644 index 000000000..40d5bed51 --- /dev/null +++ b/src/yuzu/debugger/graphics/graphics_tracing.cpp @@ -0,0 +1,177 @@ +// Copyright 2015 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include "citra_qt/debugger/graphics/graphics_tracing.h" +#include "common/common_types.h" +#include "core/hw/gpu.h" +#include "core/hw/lcd.h" +#include "core/tracer/recorder.h" +#include "nihstro/float24.h" +#include "video_core/pica_state.h" + +GraphicsTracingWidget::GraphicsTracingWidget(std::shared_ptr debug_context, + QWidget* parent) + : BreakPointObserverDock(debug_context, tr("CiTrace Recorder"), parent) { + + setObjectName("CiTracing"); + + QPushButton* start_recording = new QPushButton(tr("Start Recording")); + QPushButton* stop_recording = + new QPushButton(QIcon::fromTheme("document-save"), tr("Stop and Save")); + QPushButton* abort_recording = new QPushButton(tr("Abort Recording")); + + connect(this, SIGNAL(SetStartTracingButtonEnabled(bool)), start_recording, + SLOT(setVisible(bool))); + connect(this, SIGNAL(SetStopTracingButtonEnabled(bool)), stop_recording, + SLOT(setVisible(bool))); + connect(this, SIGNAL(SetAbortTracingButtonEnabled(bool)), abort_recording, + SLOT(setVisible(bool))); + connect(start_recording, SIGNAL(clicked()), this, SLOT(StartRecording())); + connect(stop_recording, SIGNAL(clicked()), this, SLOT(StopRecording())); + connect(abort_recording, SIGNAL(clicked()), this, SLOT(AbortRecording())); + + stop_recording->setVisible(false); + abort_recording->setVisible(false); + + auto main_widget = new QWidget; + auto main_layout = new QVBoxLayout; + { + auto sub_layout = new QHBoxLayout; + sub_layout->addWidget(start_recording); + sub_layout->addWidget(stop_recording); + sub_layout->addWidget(abort_recording); + main_layout->addLayout(sub_layout); + } + main_widget->setLayout(main_layout); + setWidget(main_widget); +} + +void GraphicsTracingWidget::StartRecording() { + auto context = context_weak.lock(); + if (!context) + return; + + auto shader_binary = Pica::g_state.vs.program_code; + auto swizzle_data = Pica::g_state.vs.swizzle_data; + + // Encode floating point numbers to 24-bit values + // TODO: Drop this explicit conversion once we store float24 values bit-correctly internally. + std::array default_attributes; + for (unsigned i = 0; i < 16; ++i) { + for (unsigned comp = 0; comp < 3; ++comp) { + default_attributes[4 * i + comp] = nihstro::to_float24( + Pica::g_state.input_default_attributes.attr[i][comp].ToFloat32()); + } + } + + std::array vs_float_uniforms; + for (unsigned i = 0; i < 96; ++i) + for (unsigned comp = 0; comp < 3; ++comp) + vs_float_uniforms[4 * i + comp] = + nihstro::to_float24(Pica::g_state.vs.uniforms.f[i][comp].ToFloat32()); + + CiTrace::Recorder::InitialState state; + std::copy_n((u32*)&GPU::g_regs, sizeof(GPU::g_regs) / sizeof(u32), + std::back_inserter(state.gpu_registers)); + std::copy_n((u32*)&LCD::g_regs, sizeof(LCD::g_regs) / sizeof(u32), + std::back_inserter(state.lcd_registers)); + std::copy_n((u32*)&Pica::g_state.regs, sizeof(Pica::g_state.regs) / sizeof(u32), + std::back_inserter(state.pica_registers)); + boost::copy(default_attributes, std::back_inserter(state.default_attributes)); + boost::copy(shader_binary, std::back_inserter(state.vs_program_binary)); + boost::copy(swizzle_data, std::back_inserter(state.vs_swizzle_data)); + boost::copy(vs_float_uniforms, std::back_inserter(state.vs_float_uniforms)); + // boost::copy(TODO: Not implemented, std::back_inserter(state.gs_program_binary)); + // boost::copy(TODO: Not implemented, std::back_inserter(state.gs_swizzle_data)); + // boost::copy(TODO: Not implemented, std::back_inserter(state.gs_float_uniforms)); + + auto recorder = new CiTrace::Recorder(state); + context->recorder = std::shared_ptr(recorder); + + emit SetStartTracingButtonEnabled(false); + emit SetStopTracingButtonEnabled(true); + emit SetAbortTracingButtonEnabled(true); +} + +void GraphicsTracingWidget::StopRecording() { + auto context = context_weak.lock(); + if (!context) + return; + + QString filename = QFileDialog::getSaveFileName(this, tr("Save CiTrace"), "citrace.ctf", + tr("CiTrace File (*.ctf)")); + + if (filename.isEmpty()) { + // If the user canceled the dialog, keep recording + return; + } + + context->recorder->Finish(filename.toStdString()); + context->recorder = nullptr; + + emit SetStopTracingButtonEnabled(false); + emit SetAbortTracingButtonEnabled(false); + emit SetStartTracingButtonEnabled(true); +} + +void GraphicsTracingWidget::AbortRecording() { + auto context = context_weak.lock(); + if (!context) + return; + + context->recorder = nullptr; + + emit SetStopTracingButtonEnabled(false); + emit SetAbortTracingButtonEnabled(false); + emit SetStartTracingButtonEnabled(true); +} + +void GraphicsTracingWidget::OnBreakPointHit(Pica::DebugContext::Event event, void* data) { + widget()->setEnabled(true); +} + +void GraphicsTracingWidget::OnResumed() { + widget()->setEnabled(false); +} + +void GraphicsTracingWidget::OnEmulationStarting(EmuThread* emu_thread) { + // Disable tracing starting/stopping until a GPU breakpoint is reached + widget()->setEnabled(false); +} + +void GraphicsTracingWidget::OnEmulationStopping() { + // TODO: Is it safe to access the context here? + + auto context = context_weak.lock(); + if (!context) + return; + + if (context->recorder) { + auto reply = + QMessageBox::question(this, tr("CiTracing still active"), + tr("A CiTrace is still being recorded. Do you want to save it? " + "If not, all recorded data will be discarded."), + QMessageBox::Yes | QMessageBox::No, QMessageBox::Yes); + + if (reply == QMessageBox::Yes) { + StopRecording(); + } else { + AbortRecording(); + } + } + + // If the widget was disabled before, enable it now to allow starting + // tracing before starting the next emulation session + widget()->setEnabled(true); +} diff --git a/src/yuzu/debugger/graphics/graphics_tracing.h b/src/yuzu/debugger/graphics/graphics_tracing.h new file mode 100644 index 000000000..eb1292c29 --- /dev/null +++ b/src/yuzu/debugger/graphics/graphics_tracing.h @@ -0,0 +1,33 @@ +// Copyright 2015 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#pragma once + +#include "citra_qt/debugger/graphics/graphics_breakpoint_observer.h" + +class EmuThread; + +class GraphicsTracingWidget : public BreakPointObserverDock { + Q_OBJECT + +public: + explicit GraphicsTracingWidget(std::shared_ptr debug_context, + QWidget* parent = nullptr); + + void OnEmulationStarting(EmuThread* emu_thread); + void OnEmulationStopping(); + +private slots: + void StartRecording(); + void StopRecording(); + void AbortRecording(); + + void OnBreakPointHit(Pica::DebugContext::Event event, void* data) override; + void OnResumed() override; + +signals: + void SetStartTracingButtonEnabled(bool enable); + void SetStopTracingButtonEnabled(bool enable); + void SetAbortTracingButtonEnabled(bool enable); +}; diff --git a/src/yuzu/debugger/graphics/graphics_vertex_shader.cpp b/src/yuzu/debugger/graphics/graphics_vertex_shader.cpp new file mode 100644 index 000000000..7f4ec0c52 --- /dev/null +++ b/src/yuzu/debugger/graphics/graphics_vertex_shader.cpp @@ -0,0 +1,622 @@ +// Copyright 2014 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include "citra_qt/debugger/graphics/graphics_vertex_shader.h" +#include "citra_qt/util/util.h" +#include "video_core/pica_state.h" +#include "video_core/shader/debug_data.h" +#include "video_core/shader/shader.h" +#include "video_core/shader/shader_interpreter.h" + +using nihstro::OpCode; +using nihstro::Instruction; +using nihstro::SourceRegister; +using nihstro::SwizzlePattern; + +GraphicsVertexShaderModel::GraphicsVertexShaderModel(GraphicsVertexShaderWidget* parent) + : QAbstractTableModel(parent), par(parent) {} + +int GraphicsVertexShaderModel::columnCount(const QModelIndex& parent) const { + return 3; +} + +int GraphicsVertexShaderModel::rowCount(const QModelIndex& parent) const { + return static_cast(par->info.code.size()); +} + +QVariant GraphicsVertexShaderModel::headerData(int section, Qt::Orientation orientation, + int role) const { + switch (role) { + case Qt::DisplayRole: { + if (section == 0) { + return tr("Offset"); + } else if (section == 1) { + return tr("Raw"); + } else if (section == 2) { + return tr("Disassembly"); + } + + break; + } + } + + return QVariant(); +} + +static std::string SelectorToString(u32 selector) { + std::string ret; + for (int i = 0; i < 4; ++i) { + int component = (selector >> ((3 - i) * 2)) & 3; + ret += "xyzw"[component]; + } + return ret; +} + +// e.g. "-c92[a0.x].xyzw" +static void print_input(std::ostringstream& output, const SourceRegister& input, bool negate, + const std::string& swizzle_mask, bool align = true, + const std::string& address_register_name = std::string()) { + if (align) + output << std::setw(4) << std::right; + output << ((negate ? "-" : "") + input.GetName()); + + if (!address_register_name.empty()) + output << '[' << address_register_name << ']'; + output << '.' << swizzle_mask; +}; + +QVariant GraphicsVertexShaderModel::data(const QModelIndex& index, int role) const { + switch (role) { + case Qt::DisplayRole: { + switch (index.column()) { + case 0: + if (par->info.HasLabel(index.row())) + return QString::fromStdString(par->info.GetLabel(index.row())); + + return QString("%1").arg(4 * index.row(), 4, 16, QLatin1Char('0')); + + case 1: + return QString("%1").arg(par->info.code[index.row()].hex, 8, 16, QLatin1Char('0')); + + case 2: { + std::ostringstream output; + output.flags(std::ios::uppercase); + + // To make the code aligning columns of assembly easier to keep track of, this function + // keeps track of the start of the start of the previous column, allowing alignment + // based on desired field widths. + int current_column = 0; + auto AlignToColumn = [&](int col_width) { + // Prints spaces to the output to pad previous column to size and advances the + // column marker. + current_column += col_width; + int to_add = std::max(1, current_column - (int)output.tellp()); + for (int i = 0; i < to_add; ++i) { + output << ' '; + } + }; + + const Instruction instr = par->info.code[index.row()]; + const OpCode opcode = instr.opcode; + const OpCode::Info opcode_info = opcode.GetInfo(); + const u32 operand_desc_id = opcode_info.type == OpCode::Type::MultiplyAdd + ? instr.mad.operand_desc_id.Value() + : instr.common.operand_desc_id.Value(); + const SwizzlePattern swizzle = par->info.swizzle_info[operand_desc_id].pattern; + + // longest known instruction name: "setemit " + int kOpcodeColumnWidth = 8; + // "rXX.xyzw " + int kOutputColumnWidth = 10; + // "-rXX.xyzw ", no attempt is made to align indexed inputs + int kInputOperandColumnWidth = 11; + + output << opcode_info.name; + + switch (opcode_info.type) { + case OpCode::Type::Trivial: + // Nothing to do here + break; + + case OpCode::Type::Arithmetic: + case OpCode::Type::MultiplyAdd: { + // Use custom code for special instructions + switch (opcode.EffectiveOpCode()) { + case OpCode::Id::CMP: { + AlignToColumn(kOpcodeColumnWidth); + + // NOTE: CMP always writes both cc components, so we do not consider the dest + // mask here. + output << " cc.xy"; + AlignToColumn(kOutputColumnWidth); + + SourceRegister src1 = instr.common.GetSrc1(false); + SourceRegister src2 = instr.common.GetSrc2(false); + + output << ' '; + print_input(output, src1, swizzle.negate_src1, + swizzle.SelectorToString(false).substr(0, 1), false, + instr.common.AddressRegisterName()); + output << ' ' << instr.common.compare_op.ToString(instr.common.compare_op.x) + << ' '; + print_input(output, src2, swizzle.negate_src2, + swizzle.SelectorToString(true).substr(0, 1), false); + + output << ", "; + + print_input(output, src1, swizzle.negate_src1, + swizzle.SelectorToString(false).substr(1, 1), false, + instr.common.AddressRegisterName()); + output << ' ' << instr.common.compare_op.ToString(instr.common.compare_op.y) + << ' '; + print_input(output, src2, swizzle.negate_src2, + swizzle.SelectorToString(true).substr(1, 1), false); + + break; + } + + case OpCode::Id::MAD: + case OpCode::Id::MADI: { + AlignToColumn(kOpcodeColumnWidth); + + bool src_is_inverted = 0 != (opcode_info.subtype & OpCode::Info::SrcInversed); + SourceRegister src1 = instr.mad.GetSrc1(src_is_inverted); + SourceRegister src2 = instr.mad.GetSrc2(src_is_inverted); + SourceRegister src3 = instr.mad.GetSrc3(src_is_inverted); + + output << std::setw(3) << std::right << instr.mad.dest.Value().GetName() << '.' + << swizzle.DestMaskToString(); + AlignToColumn(kOutputColumnWidth); + print_input(output, src1, swizzle.negate_src1, + SelectorToString(swizzle.src1_selector)); + AlignToColumn(kInputOperandColumnWidth); + print_input(output, src2, swizzle.negate_src2, + SelectorToString(swizzle.src2_selector), true, + src_is_inverted ? "" : instr.mad.AddressRegisterName()); + AlignToColumn(kInputOperandColumnWidth); + print_input(output, src3, swizzle.negate_src3, + SelectorToString(swizzle.src3_selector), true, + src_is_inverted ? instr.mad.AddressRegisterName() : ""); + AlignToColumn(kInputOperandColumnWidth); + break; + } + + default: { + AlignToColumn(kOpcodeColumnWidth); + + bool src_is_inverted = 0 != (opcode_info.subtype & OpCode::Info::SrcInversed); + + if (opcode_info.subtype & OpCode::Info::Dest) { + // e.g. "r12.xy__" + output << std::setw(3) << std::right << instr.common.dest.Value().GetName() + << '.' << swizzle.DestMaskToString(); + } else if (opcode_info.subtype == OpCode::Info::MOVA) { + output << " a0." << swizzle.DestMaskToString(); + } + AlignToColumn(kOutputColumnWidth); + + if (opcode_info.subtype & OpCode::Info::Src1) { + SourceRegister src1 = instr.common.GetSrc1(src_is_inverted); + print_input(output, src1, swizzle.negate_src1, + swizzle.SelectorToString(false), true, + src_is_inverted ? "" : instr.common.AddressRegisterName()); + AlignToColumn(kInputOperandColumnWidth); + } + + if (opcode_info.subtype & OpCode::Info::Src2) { + SourceRegister src2 = instr.common.GetSrc2(src_is_inverted); + print_input(output, src2, swizzle.negate_src2, + swizzle.SelectorToString(true), true, + src_is_inverted ? instr.common.AddressRegisterName() : ""); + AlignToColumn(kInputOperandColumnWidth); + } + break; + } + } + + break; + } + + case OpCode::Type::Conditional: + case OpCode::Type::UniformFlowControl: { + output << ' '; + + switch (opcode.EffectiveOpCode()) { + case OpCode::Id::LOOP: + output << 'i' << instr.flow_control.int_uniform_id << " (end on 0x" + << std::setw(4) << std::right << std::setfill('0') << std::hex + << (4 * instr.flow_control.dest_offset) << ")"; + break; + + default: + if (opcode_info.subtype & OpCode::Info::HasCondition) { + output << '('; + + if (instr.flow_control.op != instr.flow_control.JustY) { + if (!instr.flow_control.refx) + output << '!'; + output << "cc.x"; + } + + if (instr.flow_control.op == instr.flow_control.Or) { + output << " || "; + } else if (instr.flow_control.op == instr.flow_control.And) { + output << " && "; + } + + if (instr.flow_control.op != instr.flow_control.JustX) { + if (!instr.flow_control.refy) + output << '!'; + output << "cc.y"; + } + + output << ") "; + } else if (opcode_info.subtype & OpCode::Info::HasUniformIndex) { + if (opcode.EffectiveOpCode() == OpCode::Id::JMPU && + (instr.flow_control.num_instructions & 1) == 1) { + output << '!'; + } + output << 'b' << instr.flow_control.bool_uniform_id << ' '; + } + + if (opcode_info.subtype & OpCode::Info::HasAlternative) { + output << "else jump to 0x" << std::setw(4) << std::right + << std::setfill('0') << std::hex + << (4 * instr.flow_control.dest_offset); + } else if (opcode_info.subtype & OpCode::Info::HasExplicitDest) { + output << "jump to 0x" << std::setw(4) << std::right << std::setfill('0') + << std::hex << (4 * instr.flow_control.dest_offset); + } else { + // TODO: Handle other cases + output << "(unknown destination)"; + } + + if (opcode_info.subtype & OpCode::Info::HasFinishPoint) { + output << " (return on 0x" << std::setw(4) << std::right + << std::setfill('0') << std::hex + << (4 * instr.flow_control.dest_offset + + 4 * instr.flow_control.num_instructions) + << ')'; + } + + break; + } + break; + } + + default: + output << " (unknown instruction format)"; + break; + } + + return QString::fromLatin1(output.str().c_str()); + } + + default: + break; + } + } + + case Qt::FontRole: + return GetMonospaceFont(); + + case Qt::BackgroundRole: { + // Highlight current instruction + int current_record_index = par->cycle_index->value(); + if (current_record_index < static_cast(par->debug_data.records.size())) { + const auto& current_record = par->debug_data.records[current_record_index]; + if (index.row() == static_cast(current_record.instruction_offset)) { + return QColor(255, 255, 63); + } + } + + // Use a grey background for instructions which have no debug data associated to them + for (const auto& record : par->debug_data.records) + if (index.row() == static_cast(record.instruction_offset)) + return QVariant(); + + return QBrush(QColor(192, 192, 192)); + } + + // TODO: Draw arrows for each "reachable" instruction to visualize control flow + + default: + break; + } + + return QVariant(); +} + +void GraphicsVertexShaderWidget::DumpShader() { + QString filename = QFileDialog::getSaveFileName( + this, tr("Save Shader Dump"), "shader_dump.shbin", tr("Shader Binary (*.shbin)")); + + if (filename.isEmpty()) { + // If the user canceled the dialog, don't dump anything. + return; + } + + auto& setup = Pica::g_state.vs; + auto& config = Pica::g_state.regs.vs; + + Pica::DebugUtils::DumpShader(filename.toStdString(), config, setup, + Pica::g_state.regs.rasterizer.vs_output_attributes); +} + +GraphicsVertexShaderWidget::GraphicsVertexShaderWidget( + std::shared_ptr debug_context, QWidget* parent) + : BreakPointObserverDock(debug_context, "Pica Vertex Shader", parent) { + setObjectName("PicaVertexShader"); + + // Clear input vertex data so that it contains valid float values in case a debug shader + // execution happens before the first Vertex Loaded breakpoint. + // TODO: This makes a crash in the interpreter much less likely, but not impossible. The + // interpreter should guard against out-of-bounds accesses to ensure crashes in it aren't + // possible. + std::memset(&input_vertex, 0, sizeof(input_vertex)); + + auto input_data_mapper = new QSignalMapper(this); + + // TODO: Support inputting data in hexadecimal raw format + for (unsigned i = 0; i < ARRAY_SIZE(input_data); ++i) { + input_data[i] = new QLineEdit; + input_data[i]->setValidator(new QDoubleValidator(input_data[i])); + } + + breakpoint_warning = + new QLabel(tr("(data only available at vertex shader invocation breakpoints)")); + + // TODO: Add some button for jumping to the shader entry point + + model = new GraphicsVertexShaderModel(this); + binary_list = new QTreeView; + binary_list->setModel(model); + binary_list->setRootIsDecorated(false); + binary_list->setAlternatingRowColors(true); + + auto dump_shader = new QPushButton(QIcon::fromTheme("document-save"), tr("Dump")); + + instruction_description = new QLabel; + + cycle_index = new QSpinBox; + + connect(dump_shader, SIGNAL(clicked()), this, SLOT(DumpShader())); + + connect(cycle_index, SIGNAL(valueChanged(int)), this, SLOT(OnCycleIndexChanged(int))); + + for (unsigned i = 0; i < ARRAY_SIZE(input_data); ++i) { + connect(input_data[i], SIGNAL(textEdited(const QString&)), input_data_mapper, SLOT(map())); + input_data_mapper->setMapping(input_data[i], i); + } + connect(input_data_mapper, SIGNAL(mapped(int)), this, SLOT(OnInputAttributeChanged(int))); + + auto main_widget = new QWidget; + auto main_layout = new QVBoxLayout; + { + auto input_data_group = new QGroupBox(tr("Input Data")); + + // For each vertex attribute, add a QHBoxLayout consisting of: + // - A QLabel denoting the source attribute index + // - Four QLineEdits for showing and manipulating attribute data + // - A QLabel denoting the shader input attribute index + auto sub_layout = new QVBoxLayout; + for (unsigned i = 0; i < 16; ++i) { + // Create an HBoxLayout to store the widgets used to specify a particular attribute + // and store it in a QWidget to allow for easy hiding and unhiding. + auto row_layout = new QHBoxLayout; + // Remove unnecessary padding between rows + row_layout->setContentsMargins(0, 0, 0, 0); + + row_layout->addWidget(new QLabel(tr("Attribute %1").arg(i, 2))); + for (unsigned comp = 0; comp < 4; ++comp) + row_layout->addWidget(input_data[4 * i + comp]); + + row_layout->addWidget(input_data_mapping[i] = new QLabel); + + input_data_container[i] = new QWidget; + input_data_container[i]->setLayout(row_layout); + input_data_container[i]->hide(); + + sub_layout->addWidget(input_data_container[i]); + } + + sub_layout->addWidget(breakpoint_warning); + breakpoint_warning->hide(); + + input_data_group->setLayout(sub_layout); + main_layout->addWidget(input_data_group); + } + + // Make program listing expand to fill available space in the dialog + binary_list->setSizePolicy(QSizePolicy::Preferred, QSizePolicy::MinimumExpanding); + main_layout->addWidget(binary_list); + + main_layout->addWidget(dump_shader); + { + auto sub_layout = new QFormLayout; + sub_layout->addRow(tr("Cycle Index:"), cycle_index); + + main_layout->addLayout(sub_layout); + } + + // Set a minimum height so that the size of this label doesn't cause the rest of the bottom + // part of the UI to keep jumping up and down when cycling through instructions. + instruction_description->setMinimumHeight(instruction_description->fontMetrics().lineSpacing() * + 6); + instruction_description->setAlignment(Qt::AlignLeft | Qt::AlignTop); + main_layout->addWidget(instruction_description); + + main_widget->setLayout(main_layout); + setWidget(main_widget); + + widget()->setEnabled(false); +} + +void GraphicsVertexShaderWidget::OnBreakPointHit(Pica::DebugContext::Event event, void* data) { + if (event == Pica::DebugContext::Event::VertexShaderInvocation) { + Reload(true, data); + } else { + // No vertex data is retrievable => invalidate currently stored vertex data + Reload(true, nullptr); + } + widget()->setEnabled(true); +} + +void GraphicsVertexShaderWidget::Reload(bool replace_vertex_data, void* vertex_data) { + model->beginResetModel(); + + if (replace_vertex_data) { + if (vertex_data) { + memcpy(&input_vertex, vertex_data, sizeof(input_vertex)); + for (unsigned attr = 0; attr < 16; ++attr) { + for (unsigned comp = 0; comp < 4; ++comp) { + input_data[4 * attr + comp]->setText( + QString("%1").arg(input_vertex.attr[attr][comp].ToFloat32())); + } + } + breakpoint_warning->hide(); + } else { + for (unsigned attr = 0; attr < 16; ++attr) { + for (unsigned comp = 0; comp < 4; ++comp) { + input_data[4 * attr + comp]->setText(QString("???")); + } + } + breakpoint_warning->show(); + } + } + + // Reload shader code + info.Clear(); + + auto& shader_setup = Pica::g_state.vs; + auto& shader_config = Pica::g_state.regs.vs; + for (auto instr : shader_setup.program_code) + info.code.push_back({instr}); + int num_attributes = shader_config.max_input_attribute_index + 1; + + for (auto pattern : shader_setup.swizzle_data) + info.swizzle_info.push_back({pattern}); + + u32 entry_point = Pica::g_state.regs.vs.main_offset; + info.labels.insert({entry_point, "main"}); + + // Generate debug information + Pica::Shader::InterpreterEngine shader_engine; + shader_engine.SetupBatch(shader_setup, entry_point); + debug_data = shader_engine.ProduceDebugInfo(shader_setup, input_vertex, shader_config); + + // Reload widget state + for (int attr = 0; attr < num_attributes; ++attr) { + unsigned source_attr = shader_config.GetRegisterForAttribute(attr); + input_data_mapping[attr]->setText(QString("-> v%1").arg(source_attr)); + input_data_container[attr]->setVisible(true); + } + // Only show input attributes which are used as input to the shader + for (unsigned int attr = num_attributes; attr < 16; ++attr) { + input_data_container[attr]->setVisible(false); + } + + // Initialize debug info text for current cycle count + cycle_index->setMaximum(static_cast(debug_data.records.size() - 1)); + OnCycleIndexChanged(cycle_index->value()); + + model->endResetModel(); +} + +void GraphicsVertexShaderWidget::OnResumed() { + widget()->setEnabled(false); +} + +void GraphicsVertexShaderWidget::OnInputAttributeChanged(int index) { + float value = input_data[index]->text().toFloat(); + input_vertex.attr[index / 4][index % 4] = Pica::float24::FromFloat32(value); + // Re-execute shader with updated value + Reload(); +} + +void GraphicsVertexShaderWidget::OnCycleIndexChanged(int index) { + QString text; + + auto& record = debug_data.records[index]; + if (record.mask & Pica::Shader::DebugDataRecord::SRC1) + text += tr("SRC1: %1, %2, %3, %4\n") + .arg(record.src1.x.ToFloat32()) + .arg(record.src1.y.ToFloat32()) + .arg(record.src1.z.ToFloat32()) + .arg(record.src1.w.ToFloat32()); + if (record.mask & Pica::Shader::DebugDataRecord::SRC2) + text += tr("SRC2: %1, %2, %3, %4\n") + .arg(record.src2.x.ToFloat32()) + .arg(record.src2.y.ToFloat32()) + .arg(record.src2.z.ToFloat32()) + .arg(record.src2.w.ToFloat32()); + if (record.mask & Pica::Shader::DebugDataRecord::SRC3) + text += tr("SRC3: %1, %2, %3, %4\n") + .arg(record.src3.x.ToFloat32()) + .arg(record.src3.y.ToFloat32()) + .arg(record.src3.z.ToFloat32()) + .arg(record.src3.w.ToFloat32()); + if (record.mask & Pica::Shader::DebugDataRecord::DEST_IN) + text += tr("DEST_IN: %1, %2, %3, %4\n") + .arg(record.dest_in.x.ToFloat32()) + .arg(record.dest_in.y.ToFloat32()) + .arg(record.dest_in.z.ToFloat32()) + .arg(record.dest_in.w.ToFloat32()); + if (record.mask & Pica::Shader::DebugDataRecord::DEST_OUT) + text += tr("DEST_OUT: %1, %2, %3, %4\n") + .arg(record.dest_out.x.ToFloat32()) + .arg(record.dest_out.y.ToFloat32()) + .arg(record.dest_out.z.ToFloat32()) + .arg(record.dest_out.w.ToFloat32()); + + if (record.mask & Pica::Shader::DebugDataRecord::ADDR_REG_OUT) + text += tr("Address Registers: %1, %2\n") + .arg(record.address_registers[0]) + .arg(record.address_registers[1]); + if (record.mask & Pica::Shader::DebugDataRecord::CMP_RESULT) + text += tr("Compare Result: %1, %2\n") + .arg(record.conditional_code[0] ? "true" : "false") + .arg(record.conditional_code[1] ? "true" : "false"); + + if (record.mask & Pica::Shader::DebugDataRecord::COND_BOOL_IN) + text += tr("Static Condition: %1\n").arg(record.cond_bool ? "true" : "false"); + if (record.mask & Pica::Shader::DebugDataRecord::COND_CMP_IN) + text += tr("Dynamic Conditions: %1, %2\n") + .arg(record.cond_cmp[0] ? "true" : "false") + .arg(record.cond_cmp[1] ? "true" : "false"); + if (record.mask & Pica::Shader::DebugDataRecord::LOOP_INT_IN) + text += tr("Loop Parameters: %1 (repeats), %2 (initializer), %3 (increment), %4\n") + .arg(record.loop_int.x) + .arg(record.loop_int.y) + .arg(record.loop_int.z) + .arg(record.loop_int.w); + + text += + tr("Instruction offset: 0x%1").arg(4 * record.instruction_offset, 4, 16, QLatin1Char('0')); + if (record.mask & Pica::Shader::DebugDataRecord::NEXT_INSTR) { + text += tr(" -> 0x%2").arg(4 * record.next_instruction, 4, 16, QLatin1Char('0')); + } else { + text += tr(" (last instruction)"); + } + + instruction_description->setText(text); + + // Emit model update notification and scroll to current instruction + QModelIndex instr_index = model->index(record.instruction_offset, 0); + emit model->dataChanged(instr_index, + model->index(record.instruction_offset, model->columnCount())); + binary_list->scrollTo(instr_index, QAbstractItemView::EnsureVisible); +} diff --git a/src/yuzu/debugger/graphics/graphics_vertex_shader.h b/src/yuzu/debugger/graphics/graphics_vertex_shader.h new file mode 100644 index 000000000..c249a2ff8 --- /dev/null +++ b/src/yuzu/debugger/graphics/graphics_vertex_shader.h @@ -0,0 +1,88 @@ +// Copyright 2014 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#pragma once + +#include +#include +#include "citra_qt/debugger/graphics/graphics_breakpoint_observer.h" +#include "nihstro/parser_shbin.h" +#include "video_core/shader/debug_data.h" +#include "video_core/shader/shader.h" + +class QLabel; +class QSpinBox; + +class GraphicsVertexShaderWidget; + +class GraphicsVertexShaderModel : public QAbstractTableModel { + Q_OBJECT + +public: + explicit GraphicsVertexShaderModel(GraphicsVertexShaderWidget* parent); + + int columnCount(const QModelIndex& parent = QModelIndex()) const override; + int rowCount(const QModelIndex& parent = QModelIndex()) const override; + QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const override; + QVariant headerData(int section, Qt::Orientation orientation, + int role = Qt::DisplayRole) const override; + +private: + GraphicsVertexShaderWidget* par; + + friend class GraphicsVertexShaderWidget; +}; + +class GraphicsVertexShaderWidget : public BreakPointObserverDock { + Q_OBJECT + + using Event = Pica::DebugContext::Event; + +public: + GraphicsVertexShaderWidget(std::shared_ptr debug_context, + QWidget* parent = nullptr); + +private slots: + void OnBreakPointHit(Pica::DebugContext::Event event, void* data) override; + void OnResumed() override; + + void OnInputAttributeChanged(int index); + + void OnCycleIndexChanged(int index); + + void DumpShader(); + + /** + * Reload widget based on the current PICA200 state + * @param replace_vertex_data If true, invalidate all current vertex data + * @param vertex_data New vertex data to use, as passed to OnBreakPointHit. May be nullptr to + * specify that no valid vertex data can be retrieved currently. Only used if + * replace_vertex_data is true. + */ + void Reload(bool replace_vertex_data = false, void* vertex_data = nullptr); + +private: + QLabel* instruction_description; + QTreeView* binary_list; + GraphicsVertexShaderModel* model; + + /// TODO: Move these into a single struct + std::array + input_data; // A text box for each of the 4 components of up to 16 vertex attributes + std::array + input_data_container; // QWidget containing the QLayout containing each vertex attribute + std::array input_data_mapping; // A QLabel denoting the shader input attribute + // which the vertex attribute maps to + + // Text to be shown when input vertex data is not retrievable + QLabel* breakpoint_warning; + + QSpinBox* cycle_index; + + nihstro::ShaderInfo info; + Pica::Shader::DebugData debug_data; + Pica::Shader::AttributeBuffer input_vertex; + + friend class GraphicsVertexShaderModel; +}; diff --git a/src/yuzu/debugger/profiler.cpp b/src/yuzu/debugger/profiler.cpp new file mode 100644 index 000000000..f060bbe08 --- /dev/null +++ b/src/yuzu/debugger/profiler.cpp @@ -0,0 +1,224 @@ +// Copyright 2015 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include +#include +#include +#include +#include +#include "citra_qt/debugger/profiler.h" +#include "citra_qt/util/util.h" +#include "common/common_types.h" +#include "common/microprofile.h" + +// Include the implementation of the UI in this file. This isn't in microprofile.cpp because the +// non-Qt frontends don't need it (and don't implement the UI drawing hooks either). +#if MICROPROFILE_ENABLED +#define MICROPROFILEUI_IMPL 1 +#include "common/microprofileui.h" + +class MicroProfileWidget : public QWidget { +public: + MicroProfileWidget(QWidget* parent = nullptr); + +protected: + void paintEvent(QPaintEvent* ev) override; + void showEvent(QShowEvent* ev) override; + void hideEvent(QHideEvent* ev) override; + + void mouseMoveEvent(QMouseEvent* ev) override; + void mousePressEvent(QMouseEvent* ev) override; + void mouseReleaseEvent(QMouseEvent* ev) override; + void wheelEvent(QWheelEvent* ev) override; + + void keyPressEvent(QKeyEvent* ev) override; + void keyReleaseEvent(QKeyEvent* ev) override; + +private: + /// This timer is used to redraw the widget's contents continuously. To save resources, it only + /// runs while the widget is visible. + QTimer update_timer; + /// Scale the coordinate system appropriately when dpi != 96. + qreal x_scale = 1.0, y_scale = 1.0; +}; + +#endif + +MicroProfileDialog::MicroProfileDialog(QWidget* parent) : QWidget(parent, Qt::Dialog) { + setObjectName("MicroProfile"); + setWindowTitle(tr("MicroProfile")); + resize(1000, 600); + // Remove the "?" button from the titlebar and enable the maximize button + setWindowFlags(windowFlags() & ~Qt::WindowContextHelpButtonHint | Qt::WindowMaximizeButtonHint); + +#if MICROPROFILE_ENABLED + + MicroProfileWidget* widget = new MicroProfileWidget(this); + + QLayout* layout = new QVBoxLayout(this); + layout->setContentsMargins(0, 0, 0, 0); + layout->addWidget(widget); + setLayout(layout); + + // Configure focus so that widget is focusable and the dialog automatically forwards focus to + // it. + setFocusProxy(widget); + widget->setFocusPolicy(Qt::StrongFocus); + widget->setFocus(); +#endif +} + +QAction* MicroProfileDialog::toggleViewAction() { + if (toggle_view_action == nullptr) { + toggle_view_action = new QAction(windowTitle(), this); + toggle_view_action->setCheckable(true); + toggle_view_action->setChecked(isVisible()); + connect(toggle_view_action, SIGNAL(toggled(bool)), SLOT(setVisible(bool))); + } + + return toggle_view_action; +} + +void MicroProfileDialog::showEvent(QShowEvent* ev) { + if (toggle_view_action) { + toggle_view_action->setChecked(isVisible()); + } + QWidget::showEvent(ev); +} + +void MicroProfileDialog::hideEvent(QHideEvent* ev) { + if (toggle_view_action) { + toggle_view_action->setChecked(isVisible()); + } + QWidget::hideEvent(ev); +} + +#if MICROPROFILE_ENABLED + +/// There's no way to pass a user pointer to MicroProfile, so this variable is used to make the +/// QPainter available inside the drawing callbacks. +static QPainter* mp_painter = nullptr; + +MicroProfileWidget::MicroProfileWidget(QWidget* parent) : QWidget(parent) { + // Send mouse motion events even when not dragging. + setMouseTracking(true); + + MicroProfileSetDisplayMode(1); // Timers screen + MicroProfileInitUI(); + + connect(&update_timer, SIGNAL(timeout()), SLOT(update())); +} + +void MicroProfileWidget::paintEvent(QPaintEvent* ev) { + QPainter painter(this); + + // The units used by Microprofile for drawing are based in pixels on a 96 dpi display. + x_scale = qreal(painter.device()->logicalDpiX()) / 96.0; + y_scale = qreal(painter.device()->logicalDpiY()) / 96.0; + painter.scale(x_scale, y_scale); + + painter.setBackground(Qt::black); + painter.eraseRect(rect()); + + QFont font = GetMonospaceFont(); + font.setPixelSize(MICROPROFILE_TEXT_HEIGHT); + painter.setFont(font); + + mp_painter = &painter; + MicroProfileDraw(rect().width() / x_scale, rect().height() / y_scale); + mp_painter = nullptr; +} + +void MicroProfileWidget::showEvent(QShowEvent* ev) { + update_timer.start(15); // ~60 Hz + QWidget::showEvent(ev); +} + +void MicroProfileWidget::hideEvent(QHideEvent* ev) { + update_timer.stop(); + QWidget::hideEvent(ev); +} + +void MicroProfileWidget::mouseMoveEvent(QMouseEvent* ev) { + MicroProfileMousePosition(ev->x() / x_scale, ev->y() / y_scale, 0); + ev->accept(); +} + +void MicroProfileWidget::mousePressEvent(QMouseEvent* ev) { + MicroProfileMousePosition(ev->x() / x_scale, ev->y() / y_scale, 0); + MicroProfileMouseButton(ev->buttons() & Qt::LeftButton, ev->buttons() & Qt::RightButton); + ev->accept(); +} + +void MicroProfileWidget::mouseReleaseEvent(QMouseEvent* ev) { + MicroProfileMousePosition(ev->x() / x_scale, ev->y() / y_scale, 0); + MicroProfileMouseButton(ev->buttons() & Qt::LeftButton, ev->buttons() & Qt::RightButton); + ev->accept(); +} + +void MicroProfileWidget::wheelEvent(QWheelEvent* ev) { + MicroProfileMousePosition(ev->x() / x_scale, ev->y() / y_scale, ev->delta() / 120); + ev->accept(); +} + +void MicroProfileWidget::keyPressEvent(QKeyEvent* ev) { + if (ev->key() == Qt::Key_Control) { + // Inform MicroProfile that the user is holding Ctrl. + MicroProfileModKey(1); + } + QWidget::keyPressEvent(ev); +} + +void MicroProfileWidget::keyReleaseEvent(QKeyEvent* ev) { + if (ev->key() == Qt::Key_Control) { + MicroProfileModKey(0); + } + QWidget::keyReleaseEvent(ev); +} + +// These functions are called by MicroProfileDraw to draw the interface elements on the screen. + +void MicroProfileDrawText(int x, int y, u32 hex_color, const char* text, u32 text_length) { + // hex_color does not include an alpha, so it must be assumed to be 255 + mp_painter->setPen(QColor::fromRgb(hex_color)); + + // It's impossible to draw a string using a monospaced font with a fixed width per cell in a + // way that's reliable across different platforms and fonts as far as I (yuriks) can tell, so + // draw each character individually in order to precisely control the text advance. + for (u32 i = 0; i < text_length; ++i) { + // Position the text baseline 1 pixel above the bottom of the text cell, this gives nice + // vertical alignment of text for a wide range of tested fonts. + mp_painter->drawText(x, y + MICROPROFILE_TEXT_HEIGHT - 2, QChar(text[i])); + x += MICROPROFILE_TEXT_WIDTH + 1; + } +} + +void MicroProfileDrawBox(int left, int top, int right, int bottom, u32 hex_color, + MicroProfileBoxType type) { + QColor color = QColor::fromRgba(hex_color); + QBrush brush = color; + if (type == MicroProfileBoxTypeBar) { + QLinearGradient gradient(left, top, left, bottom); + gradient.setColorAt(0.f, color.lighter(125)); + gradient.setColorAt(1.f, color.darker(125)); + brush = gradient; + } + mp_painter->fillRect(left, top, right - left, bottom - top, brush); +} + +void MicroProfileDrawLine2D(u32 vertices_length, float* vertices, u32 hex_color) { + // Temporary vector used to convert between the float array and QPointF. Marked static to reuse + // the allocation across calls. + static std::vector point_buf; + + for (u32 i = 0; i < vertices_length; ++i) { + point_buf.emplace_back(vertices[i * 2 + 0], vertices[i * 2 + 1]); + } + + // hex_color does not include an alpha, so it must be assumed to be 255 + mp_painter->setPen(QColor::fromRgb(hex_color)); + mp_painter->drawPolyline(point_buf.data(), vertices_length); + point_buf.clear(); +} +#endif diff --git a/src/yuzu/debugger/profiler.h b/src/yuzu/debugger/profiler.h new file mode 100644 index 000000000..eae1e9e3c --- /dev/null +++ b/src/yuzu/debugger/profiler.h @@ -0,0 +1,27 @@ +// Copyright 2015 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#pragma once + +#include +#include +#include +#include "common/microprofile.h" + +class MicroProfileDialog : public QWidget { + Q_OBJECT + +public: + explicit MicroProfileDialog(QWidget* parent = nullptr); + + /// Returns a QAction that can be used to toggle visibility of this dialog. + QAction* toggleViewAction(); + +protected: + void showEvent(QShowEvent* ev) override; + void hideEvent(QHideEvent* ev) override; + +private: + QAction* toggle_view_action = nullptr; +}; diff --git a/src/yuzu/debugger/registers.cpp b/src/yuzu/debugger/registers.cpp new file mode 100644 index 000000000..f9345c9f6 --- /dev/null +++ b/src/yuzu/debugger/registers.cpp @@ -0,0 +1,190 @@ +// Copyright 2014 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include +#include "citra_qt/debugger/registers.h" +#include "citra_qt/util/util.h" +#include "core/arm/arm_interface.h" +#include "core/core.h" + +RegistersWidget::RegistersWidget(QWidget* parent) : QDockWidget(parent) { + cpu_regs_ui.setupUi(this); + + tree = cpu_regs_ui.treeWidget; + tree->addTopLevelItem(core_registers = new QTreeWidgetItem(QStringList(tr("Registers")))); + tree->addTopLevelItem(vfp_registers = new QTreeWidgetItem(QStringList(tr("VFP Registers")))); + tree->addTopLevelItem(vfp_system_registers = + new QTreeWidgetItem(QStringList(tr("VFP System Registers")))); + tree->addTopLevelItem(cpsr = new QTreeWidgetItem(QStringList("CPSR"))); + + for (int i = 0; i < 16; ++i) { + QTreeWidgetItem* child = new QTreeWidgetItem(QStringList(QString("R[%1]").arg(i))); + core_registers->addChild(child); + } + + for (int i = 0; i < 32; ++i) { + QTreeWidgetItem* child = new QTreeWidgetItem(QStringList(QString("S[%1]").arg(i))); + vfp_registers->addChild(child); + } + + QFont font = GetMonospaceFont(); + + CreateCPSRChildren(); + CreateVFPSystemRegisterChildren(); + + // Set Registers to display in monospace font + for (int i = 0; i < core_registers->childCount(); ++i) + core_registers->child(i)->setFont(1, font); + + for (int i = 0; i < vfp_registers->childCount(); ++i) + vfp_registers->child(i)->setFont(1, font); + + for (int i = 0; i < vfp_system_registers->childCount(); ++i) { + vfp_system_registers->child(i)->setFont(1, font); + for (int x = 0; x < vfp_system_registers->child(i)->childCount(); ++x) { + vfp_system_registers->child(i)->child(x)->setFont(1, font); + } + } + // Set CSPR to display in monospace font + cpsr->setFont(1, font); + for (int i = 0; i < cpsr->childCount(); ++i) { + cpsr->child(i)->setFont(1, font); + for (int x = 0; x < cpsr->child(i)->childCount(); ++x) { + cpsr->child(i)->child(x)->setFont(1, font); + } + } + setEnabled(false); +} + +void RegistersWidget::OnDebugModeEntered() { + if (!Core::System::GetInstance().IsPoweredOn()) + return; + + for (int i = 0; i < core_registers->childCount(); ++i) + core_registers->child(i)->setText( + 1, QString("0x%1").arg(Core::CPU().GetReg(i), 8, 16, QLatin1Char('0'))); + + UpdateCPSRValues(); +} + +void RegistersWidget::OnDebugModeLeft() {} + +void RegistersWidget::OnEmulationStarting(EmuThread* emu_thread) { + setEnabled(true); +} + +void RegistersWidget::OnEmulationStopping() { + // Reset widget text + for (int i = 0; i < core_registers->childCount(); ++i) + core_registers->child(i)->setText(1, QString("")); + + for (int i = 0; i < vfp_registers->childCount(); ++i) + vfp_registers->child(i)->setText(1, QString("")); + + for (int i = 0; i < cpsr->childCount(); ++i) + cpsr->child(i)->setText(1, QString("")); + + cpsr->setText(1, QString("")); + + // FPSCR + for (int i = 0; i < vfp_system_registers->child(0)->childCount(); ++i) + vfp_system_registers->child(0)->child(i)->setText(1, QString("")); + + // FPEXC + for (int i = 0; i < vfp_system_registers->child(1)->childCount(); ++i) + vfp_system_registers->child(1)->child(i)->setText(1, QString("")); + + vfp_system_registers->child(0)->setText(1, QString("")); + vfp_system_registers->child(1)->setText(1, QString("")); + vfp_system_registers->child(2)->setText(1, QString("")); + vfp_system_registers->child(3)->setText(1, QString("")); + + setEnabled(false); +} + +void RegistersWidget::CreateCPSRChildren() { + cpsr->addChild(new QTreeWidgetItem(QStringList("M"))); + cpsr->addChild(new QTreeWidgetItem(QStringList("T"))); + cpsr->addChild(new QTreeWidgetItem(QStringList("F"))); + cpsr->addChild(new QTreeWidgetItem(QStringList("I"))); + cpsr->addChild(new QTreeWidgetItem(QStringList("A"))); + cpsr->addChild(new QTreeWidgetItem(QStringList("E"))); + cpsr->addChild(new QTreeWidgetItem(QStringList("IT"))); + cpsr->addChild(new QTreeWidgetItem(QStringList("GE"))); + cpsr->addChild(new QTreeWidgetItem(QStringList("DNM"))); + cpsr->addChild(new QTreeWidgetItem(QStringList("J"))); + cpsr->addChild(new QTreeWidgetItem(QStringList("Q"))); + cpsr->addChild(new QTreeWidgetItem(QStringList("V"))); + cpsr->addChild(new QTreeWidgetItem(QStringList("C"))); + cpsr->addChild(new QTreeWidgetItem(QStringList("Z"))); + cpsr->addChild(new QTreeWidgetItem(QStringList("N"))); +} + +void RegistersWidget::UpdateCPSRValues() { + const u32 cpsr_val = Core::CPU().GetCPSR(); + + cpsr->setText(1, QString("0x%1").arg(cpsr_val, 8, 16, QLatin1Char('0'))); + cpsr->child(0)->setText( + 1, QString("b%1").arg(cpsr_val & 0x1F, 5, 2, QLatin1Char('0'))); // M - Mode + cpsr->child(1)->setText(1, QString::number((cpsr_val >> 5) & 1)); // T - State + cpsr->child(2)->setText(1, QString::number((cpsr_val >> 6) & 1)); // F - FIQ disable + cpsr->child(3)->setText(1, QString::number((cpsr_val >> 7) & 1)); // I - IRQ disable + cpsr->child(4)->setText(1, QString::number((cpsr_val >> 8) & 1)); // A - Imprecise abort + cpsr->child(5)->setText(1, QString::number((cpsr_val >> 9) & 1)); // E - Data endianness + cpsr->child(6)->setText(1, + QString::number((cpsr_val >> 10) & 0x3F)); // IT - If-Then state (DNM) + cpsr->child(7)->setText(1, + QString::number((cpsr_val >> 16) & 0xF)); // GE - Greater-than-or-Equal + cpsr->child(8)->setText(1, QString::number((cpsr_val >> 20) & 0xF)); // DNM - Do not modify + cpsr->child(9)->setText(1, QString::number((cpsr_val >> 24) & 1)); // J - Jazelle + cpsr->child(10)->setText(1, QString::number((cpsr_val >> 27) & 1)); // Q - Saturation + cpsr->child(11)->setText(1, QString::number((cpsr_val >> 28) & 1)); // V - Overflow + cpsr->child(12)->setText(1, QString::number((cpsr_val >> 29) & 1)); // C - Carry/Borrow/Extend + cpsr->child(13)->setText(1, QString::number((cpsr_val >> 30) & 1)); // Z - Zero + cpsr->child(14)->setText(1, QString::number((cpsr_val >> 31) & 1)); // N - Negative/Less than +} + +void RegistersWidget::CreateVFPSystemRegisterChildren() { + QTreeWidgetItem* const fpscr = new QTreeWidgetItem(QStringList("FPSCR")); + fpscr->addChild(new QTreeWidgetItem(QStringList("IOC"))); + fpscr->addChild(new QTreeWidgetItem(QStringList("DZC"))); + fpscr->addChild(new QTreeWidgetItem(QStringList("OFC"))); + fpscr->addChild(new QTreeWidgetItem(QStringList("UFC"))); + fpscr->addChild(new QTreeWidgetItem(QStringList("IXC"))); + fpscr->addChild(new QTreeWidgetItem(QStringList("IDC"))); + fpscr->addChild(new QTreeWidgetItem(QStringList("IOE"))); + fpscr->addChild(new QTreeWidgetItem(QStringList("DZE"))); + fpscr->addChild(new QTreeWidgetItem(QStringList("OFE"))); + fpscr->addChild(new QTreeWidgetItem(QStringList("UFE"))); + fpscr->addChild(new QTreeWidgetItem(QStringList("IXE"))); + fpscr->addChild(new QTreeWidgetItem(QStringList("IDE"))); + fpscr->addChild(new QTreeWidgetItem(QStringList(tr("Vector Length")))); + fpscr->addChild(new QTreeWidgetItem(QStringList(tr("Vector Stride")))); + fpscr->addChild(new QTreeWidgetItem(QStringList(tr("Rounding Mode")))); + fpscr->addChild(new QTreeWidgetItem(QStringList("FZ"))); + fpscr->addChild(new QTreeWidgetItem(QStringList("DN"))); + fpscr->addChild(new QTreeWidgetItem(QStringList("V"))); + fpscr->addChild(new QTreeWidgetItem(QStringList("C"))); + fpscr->addChild(new QTreeWidgetItem(QStringList("Z"))); + fpscr->addChild(new QTreeWidgetItem(QStringList("N"))); + + QTreeWidgetItem* const fpexc = new QTreeWidgetItem(QStringList("FPEXC")); + fpexc->addChild(new QTreeWidgetItem(QStringList("IOC"))); + fpexc->addChild(new QTreeWidgetItem(QStringList("OFC"))); + fpexc->addChild(new QTreeWidgetItem(QStringList("UFC"))); + fpexc->addChild(new QTreeWidgetItem(QStringList("INV"))); + fpexc->addChild(new QTreeWidgetItem(QStringList(tr("Vector Iteration Count")))); + fpexc->addChild(new QTreeWidgetItem(QStringList("FP2V"))); + fpexc->addChild(new QTreeWidgetItem(QStringList("EN"))); + fpexc->addChild(new QTreeWidgetItem(QStringList("EX"))); + + vfp_system_registers->addChild(fpscr); + vfp_system_registers->addChild(fpexc); + vfp_system_registers->addChild(new QTreeWidgetItem(QStringList("FPINST"))); + vfp_system_registers->addChild(new QTreeWidgetItem(QStringList("FPINST2"))); +} + +void RegistersWidget::UpdateVFPSystemRegisterValues() { + UNIMPLEMENTED(); +} diff --git a/src/yuzu/debugger/registers.h b/src/yuzu/debugger/registers.h new file mode 100644 index 000000000..55bda5b59 --- /dev/null +++ b/src/yuzu/debugger/registers.h @@ -0,0 +1,42 @@ +// Copyright 2014 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#pragma once + +#include +#include "ui_registers.h" + +class QTreeWidget; +class QTreeWidgetItem; +class EmuThread; + +class RegistersWidget : public QDockWidget { + Q_OBJECT + +public: + explicit RegistersWidget(QWidget* parent = nullptr); + +public slots: + void OnDebugModeEntered(); + void OnDebugModeLeft(); + + void OnEmulationStarting(EmuThread* emu_thread); + void OnEmulationStopping(); + +private: + void CreateCPSRChildren(); + void UpdateCPSRValues(); + + void CreateVFPSystemRegisterChildren(); + void UpdateVFPSystemRegisterValues(); + + Ui::ARMRegisters cpu_regs_ui; + + QTreeWidget* tree; + + QTreeWidgetItem* core_registers; + QTreeWidgetItem* vfp_registers; + QTreeWidgetItem* vfp_system_registers; + QTreeWidgetItem* cpsr; +}; diff --git a/src/yuzu/debugger/registers.ui b/src/yuzu/debugger/registers.ui new file mode 100644 index 000000000..c81ae03f9 --- /dev/null +++ b/src/yuzu/debugger/registers.ui @@ -0,0 +1,40 @@ + + + ARMRegisters + + + + 0 + 0 + 400 + 300 + + + + ARM Registers + + + + + + + true + + + + Register + + + + + Value + + + + + + + + + + diff --git a/src/yuzu/debugger/wait_tree.cpp b/src/yuzu/debugger/wait_tree.cpp new file mode 100644 index 000000000..eefbcb9f1 --- /dev/null +++ b/src/yuzu/debugger/wait_tree.cpp @@ -0,0 +1,417 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include "citra_qt/debugger/wait_tree.h" +#include "citra_qt/util/util.h" + +#include "core/hle/kernel/condition_variable.h" +#include "core/hle/kernel/event.h" +#include "core/hle/kernel/mutex.h" +#include "core/hle/kernel/thread.h" +#include "core/hle/kernel/timer.h" +#include "core/hle/kernel/wait_object.h" + +WaitTreeItem::~WaitTreeItem() {} + +QColor WaitTreeItem::GetColor() const { + return QColor(Qt::GlobalColor::black); +} + +std::vector> WaitTreeItem::GetChildren() const { + return {}; +} + +void WaitTreeItem::Expand() { + if (IsExpandable() && !expanded) { + children = GetChildren(); + for (std::size_t i = 0; i < children.size(); ++i) { + children[i]->parent = this; + children[i]->row = i; + } + expanded = true; + } +} + +WaitTreeItem* WaitTreeItem::Parent() const { + return parent; +} + +const std::vector>& WaitTreeItem::Children() const { + return children; +} + +bool WaitTreeItem::IsExpandable() const { + return false; +} + +std::size_t WaitTreeItem::Row() const { + return row; +} + +std::vector> WaitTreeItem::MakeThreadItemList() { + const auto& threads = Kernel::GetThreadList(); + std::vector> item_list; + item_list.reserve(threads.size()); + for (std::size_t i = 0; i < threads.size(); ++i) { + item_list.push_back(std::make_unique(*threads[i])); + item_list.back()->row = i; + } + return item_list; +} + +WaitTreeText::WaitTreeText(const QString& t) : text(t) {} + +QString WaitTreeText::GetText() const { + return text; +} + +WaitTreeWaitObject::WaitTreeWaitObject(const Kernel::WaitObject& o) : object(o) {} + +bool WaitTreeExpandableItem::IsExpandable() const { + return true; +} + +QString WaitTreeWaitObject::GetText() const { + return tr("[%1]%2 %3") + .arg(object.GetObjectId()) + .arg(QString::fromStdString(object.GetTypeName()), + QString::fromStdString(object.GetName())); +} + +std::unique_ptr WaitTreeWaitObject::make(const Kernel::WaitObject& object) { + switch (object.GetHandleType()) { + case Kernel::HandleType::Event: + return std::make_unique(static_cast(object)); + case Kernel::HandleType::Mutex: + return std::make_unique(static_cast(object)); + case Kernel::HandleType::ConditionVariable: + return std::make_unique( + static_cast(object)); + case Kernel::HandleType::Timer: + return std::make_unique(static_cast(object)); + case Kernel::HandleType::Thread: + return std::make_unique(static_cast(object)); + default: + return std::make_unique(object); + } +} + +std::vector> WaitTreeWaitObject::GetChildren() const { + std::vector> list; + + const auto& threads = object.GetWaitingThreads(); + if (threads.empty()) { + list.push_back(std::make_unique(tr("waited by no thread"))); + } else { + list.push_back(std::make_unique(threads)); + } + return list; +} + +QString WaitTreeWaitObject::GetResetTypeQString(Kernel::ResetType reset_type) { + switch (reset_type) { + case Kernel::ResetType::OneShot: + return tr("one shot"); + case Kernel::ResetType::Sticky: + return tr("sticky"); + case Kernel::ResetType::Pulse: + return tr("pulse"); + } +} + +WaitTreeObjectList::WaitTreeObjectList( + const std::vector>& list, bool w_all) + : object_list(list), wait_all(w_all) {} + +QString WaitTreeObjectList::GetText() const { + if (wait_all) + return tr("waiting for all objects"); + return tr("waiting for one of the following objects"); +} + +std::vector> WaitTreeObjectList::GetChildren() const { + std::vector> list(object_list.size()); + std::transform(object_list.begin(), object_list.end(), list.begin(), + [](const auto& t) { return WaitTreeWaitObject::make(*t); }); + return list; +} + +WaitTreeThread::WaitTreeThread(const Kernel::Thread& thread) : WaitTreeWaitObject(thread) {} + +QString WaitTreeThread::GetText() const { + const auto& thread = static_cast(object); + QString status; + switch (thread.status) { + case THREADSTATUS_RUNNING: + status = tr("running"); + break; + case THREADSTATUS_READY: + status = tr("ready"); + break; + case THREADSTATUS_WAIT_ARB: + status = tr("waiting for address 0x%1").arg(thread.wait_address, 8, 16, QLatin1Char('0')); + break; + case THREADSTATUS_WAIT_SLEEP: + status = tr("sleeping"); + break; + case THREADSTATUS_WAIT_SYNCH_ALL: + case THREADSTATUS_WAIT_SYNCH_ANY: + status = tr("waiting for objects"); + break; + case THREADSTATUS_DORMANT: + status = tr("dormant"); + break; + case THREADSTATUS_DEAD: + status = tr("dead"); + break; + } + QString pc_info = tr(" PC = 0x%1 LR = 0x%2") + .arg(thread.context.pc, 8, 16, QLatin1Char('0')) + .arg(thread.context.cpu_registers[31], 8, 16, QLatin1Char('0')); + return WaitTreeWaitObject::GetText() + pc_info + " (" + status + ") "; +} + +QColor WaitTreeThread::GetColor() const { + const auto& thread = static_cast(object); + switch (thread.status) { + case THREADSTATUS_RUNNING: + return QColor(Qt::GlobalColor::darkGreen); + case THREADSTATUS_READY: + return QColor(Qt::GlobalColor::darkBlue); + case THREADSTATUS_WAIT_ARB: + return QColor(Qt::GlobalColor::darkRed); + case THREADSTATUS_WAIT_SLEEP: + return QColor(Qt::GlobalColor::darkYellow); + case THREADSTATUS_WAIT_SYNCH_ALL: + case THREADSTATUS_WAIT_SYNCH_ANY: + return QColor(Qt::GlobalColor::red); + case THREADSTATUS_DORMANT: + return QColor(Qt::GlobalColor::darkCyan); + case THREADSTATUS_DEAD: + return QColor(Qt::GlobalColor::gray); + default: + return WaitTreeItem::GetColor(); + } +} + +std::vector> WaitTreeThread::GetChildren() const { + std::vector> list(WaitTreeWaitObject::GetChildren()); + + const auto& thread = static_cast(object); + + QString processor; + switch (thread.processor_id) { + case ThreadProcessorId::THREADPROCESSORID_DEFAULT: + processor = tr("default"); + break; + case ThreadProcessorId::THREADPROCESSORID_0: + case ThreadProcessorId::THREADPROCESSORID_1: + case ThreadProcessorId::THREADPROCESSORID_2: + case ThreadProcessorId::THREADPROCESSORID_3: + processor = tr("core %1").arg(thread.processor_id); + break; + default: + processor = tr("Unknown processor %1").arg(thread.processor_id); + break; + } + + list.push_back(std::make_unique(tr("processor = %1").arg(processor))); + list.push_back(std::make_unique(tr("thread id = %1").arg(thread.GetThreadId()))); + list.push_back(std::make_unique(tr("priority = %1(current) / %2(normal)") + .arg(thread.current_priority) + .arg(thread.nominal_priority))); + list.push_back(std::make_unique( + tr("last running ticks = %1").arg(thread.last_running_ticks))); + + if (thread.held_mutexes.empty()) { + list.push_back(std::make_unique(tr("not holding mutex"))); + } else { + list.push_back(std::make_unique(thread.held_mutexes)); + } + if (thread.status == THREADSTATUS_WAIT_SYNCH_ANY || + thread.status == THREADSTATUS_WAIT_SYNCH_ALL) { + list.push_back(std::make_unique(thread.wait_objects, + thread.IsSleepingOnWaitAll())); + } + + return list; +} + +WaitTreeEvent::WaitTreeEvent(const Kernel::Event& object) : WaitTreeWaitObject(object) {} + +std::vector> WaitTreeEvent::GetChildren() const { + std::vector> list(WaitTreeWaitObject::GetChildren()); + + list.push_back(std::make_unique( + tr("reset type = %1") + .arg(GetResetTypeQString(static_cast(object).reset_type)))); + return list; +} + +WaitTreeMutex::WaitTreeMutex(const Kernel::Mutex& object) : WaitTreeWaitObject(object) {} + +std::vector> WaitTreeMutex::GetChildren() const { + std::vector> list(WaitTreeWaitObject::GetChildren()); + + const auto& mutex = static_cast(object); + if (mutex.GetHasWaiters()) { + list.push_back(std::make_unique(tr("locked by thread:"))); + list.push_back(std::make_unique(*mutex.GetHoldingThread())); + } else { + list.push_back(std::make_unique(tr("free"))); + } + return list; +} + +WaitTreeConditionVariable::WaitTreeConditionVariable(const Kernel::ConditionVariable& object) + : WaitTreeWaitObject(object) {} + +std::vector> WaitTreeConditionVariable::GetChildren() const { + std::vector> list(WaitTreeWaitObject::GetChildren()); + + const auto& condition_variable = static_cast(object); + list.push_back(std::make_unique( + tr("available count = %1").arg(condition_variable.GetAvailableCount()))); + return list; +} + +WaitTreeTimer::WaitTreeTimer(const Kernel::Timer& object) : WaitTreeWaitObject(object) {} + +std::vector> WaitTreeTimer::GetChildren() const { + std::vector> list(WaitTreeWaitObject::GetChildren()); + + const auto& timer = static_cast(object); + + list.push_back(std::make_unique( + tr("reset type = %1").arg(GetResetTypeQString(timer.reset_type)))); + list.push_back( + std::make_unique(tr("initial delay = %1").arg(timer.initial_delay))); + list.push_back( + std::make_unique(tr("interval delay = %1").arg(timer.interval_delay))); + return list; +} + +WaitTreeMutexList::WaitTreeMutexList( + const boost::container::flat_set>& list) + : mutex_list(list) {} + +QString WaitTreeMutexList::GetText() const { + return tr("holding mutexes"); +} + +std::vector> WaitTreeMutexList::GetChildren() const { + std::vector> list(mutex_list.size()); + std::transform(mutex_list.begin(), mutex_list.end(), list.begin(), + [](const auto& t) { return std::make_unique(*t); }); + return list; +} + +WaitTreeThreadList::WaitTreeThreadList(const std::vector>& list) + : thread_list(list) {} + +QString WaitTreeThreadList::GetText() const { + return tr("waited by thread"); +} + +std::vector> WaitTreeThreadList::GetChildren() const { + std::vector> list(thread_list.size()); + std::transform(thread_list.begin(), thread_list.end(), list.begin(), + [](const auto& t) { return std::make_unique(*t); }); + return list; +} + +WaitTreeModel::WaitTreeModel(QObject* parent) : QAbstractItemModel(parent) {} + +QModelIndex WaitTreeModel::index(int row, int column, const QModelIndex& parent) const { + if (!hasIndex(row, column, parent)) + return {}; + + if (parent.isValid()) { + WaitTreeItem* parent_item = static_cast(parent.internalPointer()); + parent_item->Expand(); + return createIndex(row, column, parent_item->Children()[row].get()); + } + + return createIndex(row, column, thread_items[row].get()); +} + +QModelIndex WaitTreeModel::parent(const QModelIndex& index) const { + if (!index.isValid()) + return {}; + + WaitTreeItem* parent_item = static_cast(index.internalPointer())->Parent(); + if (!parent_item) { + return QModelIndex(); + } + return createIndex(static_cast(parent_item->Row()), 0, parent_item); +} + +int WaitTreeModel::rowCount(const QModelIndex& parent) const { + if (!parent.isValid()) + return static_cast(thread_items.size()); + + WaitTreeItem* parent_item = static_cast(parent.internalPointer()); + parent_item->Expand(); + return static_cast(parent_item->Children().size()); +} + +int WaitTreeModel::columnCount(const QModelIndex&) const { + return 1; +} + +QVariant WaitTreeModel::data(const QModelIndex& index, int role) const { + if (!index.isValid()) + return {}; + + switch (role) { + case Qt::DisplayRole: + return static_cast(index.internalPointer())->GetText(); + case Qt::ForegroundRole: + return static_cast(index.internalPointer())->GetColor(); + default: + return {}; + } +} + +void WaitTreeModel::ClearItems() { + thread_items.clear(); +} + +void WaitTreeModel::InitItems() { + thread_items = WaitTreeItem::MakeThreadItemList(); +} + +WaitTreeWidget::WaitTreeWidget(QWidget* parent) : QDockWidget(tr("Wait Tree"), parent) { + setObjectName("WaitTreeWidget"); + view = new QTreeView(this); + view->setHeaderHidden(true); + setWidget(view); + setEnabled(false); +} + +void WaitTreeWidget::OnDebugModeEntered() { + if (!Core::System::GetInstance().IsPoweredOn()) + return; + model->InitItems(); + view->setModel(model); + setEnabled(true); +} + +void WaitTreeWidget::OnDebugModeLeft() { + setEnabled(false); + view->setModel(nullptr); + model->ClearItems(); +} + +void WaitTreeWidget::OnEmulationStarting(EmuThread* emu_thread) { + model = new WaitTreeModel(this); + view->setModel(model); + setEnabled(false); +} + +void WaitTreeWidget::OnEmulationStopping() { + view->setModel(nullptr); + delete model; + setEnabled(false); +} diff --git a/src/yuzu/debugger/wait_tree.h b/src/yuzu/debugger/wait_tree.h new file mode 100644 index 000000000..4034e909b --- /dev/null +++ b/src/yuzu/debugger/wait_tree.h @@ -0,0 +1,187 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#pragma once + +#include +#include +#include +#include +#include "core/core.h" +#include "core/hle/kernel/kernel.h" + +class EmuThread; + +namespace Kernel { +class WaitObject; +class Event; +class Mutex; +class ConditionVariable; +class Thread; +class Timer; +} + +class WaitTreeThread; + +class WaitTreeItem : public QObject { + Q_OBJECT +public: + virtual bool IsExpandable() const; + virtual std::vector> GetChildren() const; + virtual QString GetText() const = 0; + virtual QColor GetColor() const; + virtual ~WaitTreeItem(); + void Expand(); + WaitTreeItem* Parent() const; + const std::vector>& Children() const; + std::size_t Row() const; + static std::vector> MakeThreadItemList(); + +private: + std::size_t row; + bool expanded = false; + WaitTreeItem* parent = nullptr; + std::vector> children; +}; + +class WaitTreeText : public WaitTreeItem { + Q_OBJECT +public: + explicit WaitTreeText(const QString& text); + QString GetText() const override; + +private: + QString text; +}; + +class WaitTreeExpandableItem : public WaitTreeItem { + Q_OBJECT +public: + bool IsExpandable() const override; +}; + +class WaitTreeWaitObject : public WaitTreeExpandableItem { + Q_OBJECT +public: + explicit WaitTreeWaitObject(const Kernel::WaitObject& object); + static std::unique_ptr make(const Kernel::WaitObject& object); + QString GetText() const override; + std::vector> GetChildren() const override; + +protected: + const Kernel::WaitObject& object; + + static QString GetResetTypeQString(Kernel::ResetType reset_type); +}; + +class WaitTreeObjectList : public WaitTreeExpandableItem { + Q_OBJECT +public: + WaitTreeObjectList(const std::vector>& list, + bool wait_all); + QString GetText() const override; + std::vector> GetChildren() const override; + +private: + const std::vector>& object_list; + bool wait_all; +}; + +class WaitTreeThread : public WaitTreeWaitObject { + Q_OBJECT +public: + explicit WaitTreeThread(const Kernel::Thread& thread); + QString GetText() const override; + QColor GetColor() const override; + std::vector> GetChildren() const override; +}; + +class WaitTreeEvent : public WaitTreeWaitObject { + Q_OBJECT +public: + explicit WaitTreeEvent(const Kernel::Event& object); + std::vector> GetChildren() const override; +}; + +class WaitTreeMutex : public WaitTreeWaitObject { + Q_OBJECT +public: + explicit WaitTreeMutex(const Kernel::Mutex& object); + std::vector> GetChildren() const override; +}; + +class WaitTreeConditionVariable : public WaitTreeWaitObject { + Q_OBJECT +public: + explicit WaitTreeConditionVariable(const Kernel::ConditionVariable& object); + std::vector> GetChildren() const override; +}; + +class WaitTreeTimer : public WaitTreeWaitObject { + Q_OBJECT +public: + explicit WaitTreeTimer(const Kernel::Timer& object); + std::vector> GetChildren() const override; +}; + +class WaitTreeMutexList : public WaitTreeExpandableItem { + Q_OBJECT +public: + explicit WaitTreeMutexList( + const boost::container::flat_set>& list); + + QString GetText() const override; + std::vector> GetChildren() const override; + +private: + const boost::container::flat_set>& mutex_list; +}; + +class WaitTreeThreadList : public WaitTreeExpandableItem { + Q_OBJECT +public: + explicit WaitTreeThreadList(const std::vector>& list); + QString GetText() const override; + std::vector> GetChildren() const override; + +private: + const std::vector>& thread_list; +}; + +class WaitTreeModel : public QAbstractItemModel { + Q_OBJECT + +public: + explicit WaitTreeModel(QObject* parent = nullptr); + + QVariant data(const QModelIndex& index, int role) const override; + QModelIndex index(int row, int column, const QModelIndex& parent) const override; + QModelIndex parent(const QModelIndex& index) const override; + int rowCount(const QModelIndex& parent) const override; + int columnCount(const QModelIndex& parent) const override; + + void ClearItems(); + void InitItems(); + +private: + std::vector> thread_items; +}; + +class WaitTreeWidget : public QDockWidget { + Q_OBJECT + +public: + explicit WaitTreeWidget(QWidget* parent = nullptr); + +public slots: + void OnDebugModeEntered(); + void OnDebugModeLeft(); + + void OnEmulationStarting(EmuThread* emu_thread); + void OnEmulationStopping(); + +private: + QTreeView* view; + WaitTreeModel* model; +}; diff --git a/src/yuzu/game_list.cpp b/src/yuzu/game_list.cpp new file mode 100644 index 000000000..a8e3541cd --- /dev/null +++ b/src/yuzu/game_list.cpp @@ -0,0 +1,422 @@ +// Copyright 2015 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include +#include +#include +#include +#include +#include +#include "common/common_paths.h" +#include "common/logging/log.h" +#include "common/string_util.h" +#include "core/loader/loader.h" +#include "game_list.h" +#include "game_list_p.h" +#include "ui_settings.h" + +GameList::SearchField::KeyReleaseEater::KeyReleaseEater(GameList* gamelist) { + this->gamelist = gamelist; + edit_filter_text_old = ""; +} + +// EventFilter in order to process systemkeys while editing the searchfield +bool GameList::SearchField::KeyReleaseEater::eventFilter(QObject* obj, QEvent* event) { + // If it isn't a KeyRelease event then continue with standard event processing + if (event->type() != QEvent::KeyRelease) + return QObject::eventFilter(obj, event); + + QKeyEvent* keyEvent = static_cast(event); + int rowCount = gamelist->tree_view->model()->rowCount(); + QString edit_filter_text = gamelist->search_field->edit_filter->text().toLower(); + + // If the searchfield's text hasn't changed special function keys get checked + // If no function key changes the searchfield's text the filter doesn't need to get reloaded + if (edit_filter_text == edit_filter_text_old) { + switch (keyEvent->key()) { + // Escape: Resets the searchfield + case Qt::Key_Escape: { + if (edit_filter_text_old.isEmpty()) { + return QObject::eventFilter(obj, event); + } else { + gamelist->search_field->edit_filter->clear(); + edit_filter_text = ""; + } + break; + } + // Return and Enter + // If the enter key gets pressed first checks how many and which entry is visible + // If there is only one result launch this game + case Qt::Key_Return: + case Qt::Key_Enter: { + QStandardItemModel* item_model = new QStandardItemModel(gamelist->tree_view); + QModelIndex root_index = item_model->invisibleRootItem()->index(); + QStandardItem* child_file; + QString file_path; + int resultCount = 0; + for (int i = 0; i < rowCount; ++i) { + if (!gamelist->tree_view->isRowHidden(i, root_index)) { + ++resultCount; + child_file = gamelist->item_model->item(i, 0); + file_path = child_file->data(GameListItemPath::FullPathRole).toString(); + } + } + if (resultCount == 1) { + // To avoid loading error dialog loops while confirming them using enter + // Also users usually want to run a diffrent game after closing one + gamelist->search_field->edit_filter->setText(""); + edit_filter_text = ""; + emit gamelist->GameChosen(file_path); + } else { + return QObject::eventFilter(obj, event); + } + break; + } + default: + return QObject::eventFilter(obj, event); + } + } + edit_filter_text_old = edit_filter_text; + return QObject::eventFilter(obj, event); +} + +void GameList::SearchField::setFilterResult(int visible, int total) { + QString result_of_text = tr("of"); + QString result_text; + if (total == 1) { + result_text = tr("result"); + } else { + result_text = tr("results"); + } + label_filter_result->setText( + QString("%1 %2 %3 %4").arg(visible).arg(result_of_text).arg(total).arg(result_text)); +} + +void GameList::SearchField::clear() { + edit_filter->setText(""); +} + +void GameList::SearchField::setFocus() { + if (edit_filter->isVisible()) { + edit_filter->setFocus(); + } +} + +GameList::SearchField::SearchField(GameList* parent) : QWidget{parent} { + KeyReleaseEater* keyReleaseEater = new KeyReleaseEater(parent); + layout_filter = new QHBoxLayout; + layout_filter->setMargin(8); + label_filter = new QLabel; + label_filter->setText(tr("Filter:")); + edit_filter = new QLineEdit; + edit_filter->setText(""); + edit_filter->setPlaceholderText(tr("Enter pattern to filter")); + edit_filter->installEventFilter(keyReleaseEater); + edit_filter->setClearButtonEnabled(true); + connect(edit_filter, SIGNAL(textChanged(const QString&)), parent, + SLOT(onTextChanged(const QString&))); + label_filter_result = new QLabel; + button_filter_close = new QToolButton(this); + button_filter_close->setText("X"); + button_filter_close->setCursor(Qt::ArrowCursor); + button_filter_close->setStyleSheet("QToolButton{ border: none; padding: 0px; color: " + "#000000; font-weight: bold; background: #F0F0F0; }" + "QToolButton:hover{ border: none; padding: 0px; color: " + "#EEEEEE; font-weight: bold; background: #E81123}"); + connect(button_filter_close, SIGNAL(clicked()), parent, SLOT(onFilterCloseClicked())); + layout_filter->setSpacing(10); + layout_filter->addWidget(label_filter); + layout_filter->addWidget(edit_filter); + layout_filter->addWidget(label_filter_result); + layout_filter->addWidget(button_filter_close); + setLayout(layout_filter); +} + +/** + * Checks if all words separated by spaces are contained in another string + * This offers a word order insensitive search function + * + * @param String that gets checked if it contains all words of the userinput string + * @param String containing all words getting checked + * @return true if the haystack contains all words of userinput + */ +bool GameList::containsAllWords(QString haystack, QString userinput) { + QStringList userinput_split = userinput.split(" ", QString::SplitBehavior::SkipEmptyParts); + return std::all_of(userinput_split.begin(), userinput_split.end(), + [haystack](QString s) { return haystack.contains(s); }); +} + +// Event in order to filter the gamelist after editing the searchfield +void GameList::onTextChanged(const QString& newText) { + int rowCount = tree_view->model()->rowCount(); + QString edit_filter_text = newText.toLower(); + + QModelIndex root_index = item_model->invisibleRootItem()->index(); + + // If the searchfield is empty every item is visible + // Otherwise the filter gets applied + if (edit_filter_text.isEmpty()) { + for (int i = 0; i < rowCount; ++i) { + tree_view->setRowHidden(i, root_index, false); + } + search_field->setFilterResult(rowCount, rowCount); + } else { + QStandardItem* child_file; + QString file_path, file_name, file_title, file_programmid; + int result_count = 0; + for (int i = 0; i < rowCount; ++i) { + child_file = item_model->item(i, 0); + file_path = child_file->data(GameListItemPath::FullPathRole).toString().toLower(); + file_name = file_path.mid(file_path.lastIndexOf("/") + 1); + file_title = child_file->data(GameListItemPath::TitleRole).toString().toLower(); + file_programmid = + child_file->data(GameListItemPath::ProgramIdRole).toString().toLower(); + + // Only items which filename in combination with its title contains all words + // that are in the searchfiel will be visible in the gamelist + // The search is case insensitive because of toLower() + // I decided not to use Qt::CaseInsensitive in containsAllWords to prevent + // multiple conversions of edit_filter_text for each game in the gamelist + if (containsAllWords(file_name.append(" ").append(file_title), edit_filter_text) || + (file_programmid.count() == 16 && edit_filter_text.contains(file_programmid))) { + tree_view->setRowHidden(i, root_index, false); + ++result_count; + } else { + tree_view->setRowHidden(i, root_index, true); + } + search_field->setFilterResult(result_count, rowCount); + } + } +} + +void GameList::onFilterCloseClicked() { + main_window->filterBarSetChecked(false); +} + +GameList::GameList(GMainWindow* parent) : QWidget{parent} { + watcher = new QFileSystemWatcher(this); + connect(watcher, &QFileSystemWatcher::directoryChanged, this, &GameList::RefreshGameDirectory); + + this->main_window = parent; + layout = new QVBoxLayout; + tree_view = new QTreeView; + search_field = new SearchField(this); + item_model = new QStandardItemModel(tree_view); + tree_view->setModel(item_model); + + tree_view->setAlternatingRowColors(true); + tree_view->setSelectionMode(QHeaderView::SingleSelection); + tree_view->setSelectionBehavior(QHeaderView::SelectRows); + tree_view->setVerticalScrollMode(QHeaderView::ScrollPerPixel); + tree_view->setHorizontalScrollMode(QHeaderView::ScrollPerPixel); + tree_view->setSortingEnabled(true); + tree_view->setEditTriggers(QHeaderView::NoEditTriggers); + tree_view->setUniformRowHeights(true); + tree_view->setContextMenuPolicy(Qt::CustomContextMenu); + + item_model->insertColumns(0, COLUMN_COUNT); + item_model->setHeaderData(COLUMN_NAME, Qt::Horizontal, "Name"); + item_model->setHeaderData(COLUMN_FILE_TYPE, Qt::Horizontal, "File type"); + item_model->setHeaderData(COLUMN_SIZE, Qt::Horizontal, "Size"); + + connect(tree_view, &QTreeView::activated, this, &GameList::ValidateEntry); + connect(tree_view, &QTreeView::customContextMenuRequested, this, &GameList::PopupContextMenu); + + // We must register all custom types with the Qt Automoc system so that we are able to use it + // with signals/slots. In this case, QList falls under the umbrells of custom types. + qRegisterMetaType>("QList"); + + layout->setContentsMargins(0, 0, 0, 0); + layout->setSpacing(0); + layout->addWidget(tree_view); + layout->addWidget(search_field); + setLayout(layout); +} + +GameList::~GameList() { + emit ShouldCancelWorker(); +} + +void GameList::setFilterFocus() { + if (tree_view->model()->rowCount() > 0) { + search_field->setFocus(); + } +} + +void GameList::setFilterVisible(bool visibility) { + search_field->setVisible(visibility); +} + +void GameList::clearFilter() { + search_field->clear(); +} + +void GameList::AddEntry(const QList& entry_items) { + item_model->invisibleRootItem()->appendRow(entry_items); +} + +void GameList::ValidateEntry(const QModelIndex& item) { + // We don't care about the individual QStandardItem that was selected, but its row. + int row = item_model->itemFromIndex(item)->row(); + QStandardItem* child_file = item_model->invisibleRootItem()->child(row, COLUMN_NAME); + QString file_path = child_file->data(GameListItemPath::FullPathRole).toString(); + + if (file_path.isEmpty()) + return; + std::string std_file_path(file_path.toStdString()); + if (!FileUtil::Exists(std_file_path) || FileUtil::IsDirectory(std_file_path)) + return; + // Users usually want to run a diffrent game after closing one + search_field->clear(); + emit GameChosen(file_path); +} + +void GameList::DonePopulating(QStringList watch_list) { + // Clear out the old directories to watch for changes and add the new ones + auto watch_dirs = watcher->directories(); + if (!watch_dirs.isEmpty()) { + watcher->removePaths(watch_dirs); + } + // Workaround: Add the watch paths in chunks to allow the gui to refresh + // This prevents the UI from stalling when a large number of watch paths are added + // Also artificially caps the watcher to a certain number of directories + constexpr int LIMIT_WATCH_DIRECTORIES = 5000; + constexpr int SLICE_SIZE = 25; + int len = std::min(watch_list.length(), LIMIT_WATCH_DIRECTORIES); + for (int i = 0; i < len; i += SLICE_SIZE) { + watcher->addPaths(watch_list.mid(i, i + SLICE_SIZE)); + QCoreApplication::processEvents(); + } + tree_view->setEnabled(true); + int rowCount = tree_view->model()->rowCount(); + search_field->setFilterResult(rowCount, rowCount); + if (rowCount > 0) { + search_field->setFocus(); + } +} + +void GameList::PopupContextMenu(const QPoint& menu_location) { + QModelIndex item = tree_view->indexAt(menu_location); + if (!item.isValid()) + return; + + int row = item_model->itemFromIndex(item)->row(); + QStandardItem* child_file = item_model->invisibleRootItem()->child(row, COLUMN_NAME); + u64 program_id = child_file->data(GameListItemPath::ProgramIdRole).toULongLong(); + + QMenu context_menu; + QAction* open_save_location = context_menu.addAction(tr("Open Save Data Location")); + open_save_location->setEnabled(program_id != 0); + connect(open_save_location, &QAction::triggered, + [&]() { emit OpenSaveFolderRequested(program_id); }); + context_menu.exec(tree_view->viewport()->mapToGlobal(menu_location)); +} + +void GameList::PopulateAsync(const QString& dir_path, bool deep_scan) { + if (!FileUtil::Exists(dir_path.toStdString()) || + !FileUtil::IsDirectory(dir_path.toStdString())) { + LOG_ERROR(Frontend, "Could not find game list folder at %s", dir_path.toLocal8Bit().data()); + search_field->setFilterResult(0, 0); + return; + } + + tree_view->setEnabled(false); + // Delete any rows that might already exist if we're repopulating + item_model->removeRows(0, item_model->rowCount()); + + emit ShouldCancelWorker(); + + GameListWorker* worker = new GameListWorker(dir_path, deep_scan); + + connect(worker, &GameListWorker::EntryReady, this, &GameList::AddEntry, Qt::QueuedConnection); + connect(worker, &GameListWorker::Finished, this, &GameList::DonePopulating, + Qt::QueuedConnection); + // Use DirectConnection here because worker->Cancel() is thread-safe and we want it to cancel + // without delay. + connect(this, &GameList::ShouldCancelWorker, worker, &GameListWorker::Cancel, + Qt::DirectConnection); + + QThreadPool::globalInstance()->start(worker); + current_worker = std::move(worker); +} + +void GameList::SaveInterfaceLayout() { + UISettings::values.gamelist_header_state = tree_view->header()->saveState(); +} + +void GameList::LoadInterfaceLayout() { + auto header = tree_view->header(); + if (!header->restoreState(UISettings::values.gamelist_header_state)) { + // We are using the name column to display icons and titles + // so make it as large as possible as default. + header->resizeSection(COLUMN_NAME, header->width()); + } + + item_model->sort(header->sortIndicatorSection(), header->sortIndicatorOrder()); +} + +const QStringList GameList::supported_file_extensions = {"3ds", "3dsx", "elf", "axf", + "cci", "cxi", "app"}; + +static bool HasSupportedFileExtension(const std::string& file_name) { + QFileInfo file = QFileInfo(file_name.c_str()); + return GameList::supported_file_extensions.contains(file.suffix(), Qt::CaseInsensitive); +} + +void GameList::RefreshGameDirectory() { + if (!UISettings::values.gamedir.isEmpty() && current_worker != nullptr) { + LOG_INFO(Frontend, "Change detected in the games directory. Reloading game list."); + search_field->clear(); + PopulateAsync(UISettings::values.gamedir, UISettings::values.gamedir_deepscan); + } +} + +void GameListWorker::AddFstEntriesToGameList(const std::string& dir_path, unsigned int recursion) { + const auto callback = [this, recursion](unsigned* num_entries_out, const std::string& directory, + const std::string& virtual_name) -> bool { + std::string physical_name = directory + DIR_SEP + virtual_name; + + if (stop_processing) + return false; // Breaks the callback loop. + + bool is_dir = FileUtil::IsDirectory(physical_name); + if (!is_dir && HasSupportedFileExtension(physical_name)) { + std::unique_ptr loader = Loader::GetLoader(physical_name); + if (!loader) + return true; + + std::vector smdh; + loader->ReadIcon(smdh); + + u64 program_id = 0; + loader->ReadProgramId(program_id); + + emit EntryReady({ + new GameListItemPath(QString::fromStdString(physical_name), smdh, program_id), + new GameListItem( + QString::fromStdString(Loader::GetFileTypeString(loader->GetFileType()))), + new GameListItemSize(FileUtil::GetSize(physical_name)), + }); + } else if (is_dir && recursion > 0) { + watch_list.append(QString::fromStdString(physical_name)); + AddFstEntriesToGameList(physical_name, recursion - 1); + } + + return true; + }; + + FileUtil::ForeachDirectoryEntry(nullptr, dir_path, callback); +} + +void GameListWorker::run() { + stop_processing = false; + watch_list.append(dir_path); + AddFstEntriesToGameList(dir_path.toStdString(), deep_scan ? 256 : 0); + emit Finished(watch_list); +} + +void GameListWorker::Cancel() { + this->disconnect(); + stop_processing = true; +} diff --git a/src/yuzu/game_list.h b/src/yuzu/game_list.h new file mode 100644 index 000000000..4823a1296 --- /dev/null +++ b/src/yuzu/game_list.h @@ -0,0 +1,101 @@ +// Copyright 2015 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#pragma once + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include "main.h" + +class GameListWorker; + +class GameList : public QWidget { + Q_OBJECT + +public: + enum { + COLUMN_NAME, + COLUMN_FILE_TYPE, + COLUMN_SIZE, + COLUMN_COUNT, // Number of columns + }; + + class SearchField : public QWidget { + public: + void setFilterResult(int visible, int total); + void clear(); + void setFocus(); + explicit SearchField(GameList* parent = nullptr); + + private: + class KeyReleaseEater : public QObject { + public: + explicit KeyReleaseEater(GameList* gamelist); + + private: + GameList* gamelist = nullptr; + QString edit_filter_text_old; + + protected: + bool eventFilter(QObject* obj, QEvent* event); + }; + QHBoxLayout* layout_filter = nullptr; + QTreeView* tree_view = nullptr; + QLabel* label_filter = nullptr; + QLineEdit* edit_filter = nullptr; + QLabel* label_filter_result = nullptr; + QToolButton* button_filter_close = nullptr; + }; + + explicit GameList(GMainWindow* parent = nullptr); + ~GameList() override; + + void clearFilter(); + void setFilterFocus(); + void setFilterVisible(bool visibility); + + void PopulateAsync(const QString& dir_path, bool deep_scan); + + void SaveInterfaceLayout(); + void LoadInterfaceLayout(); + + static const QStringList supported_file_extensions; + +signals: + void GameChosen(QString game_path); + void ShouldCancelWorker(); + void OpenSaveFolderRequested(u64 program_id); + +private slots: + void onTextChanged(const QString& newText); + void onFilterCloseClicked(); + +private: + void AddEntry(const QList& entry_items); + void ValidateEntry(const QModelIndex& item); + void DonePopulating(QStringList watch_list); + + void PopupContextMenu(const QPoint& menu_location); + void RefreshGameDirectory(); + bool containsAllWords(QString haystack, QString userinput); + + SearchField* search_field; + GMainWindow* main_window = nullptr; + QVBoxLayout* layout = nullptr; + QTreeView* tree_view = nullptr; + QStandardItemModel* item_model = nullptr; + GameListWorker* current_worker = nullptr; + QFileSystemWatcher* watcher = nullptr; +}; diff --git a/src/yuzu/game_list_p.h b/src/yuzu/game_list_p.h new file mode 100644 index 000000000..9881296d9 --- /dev/null +++ b/src/yuzu/game_list_p.h @@ -0,0 +1,143 @@ +// Copyright 2015 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#pragma once + +#include +#include +#include +#include +#include +#include "citra_qt/util/util.h" +#include "common/string_util.h" + +/** + * Gets the default icon (for games without valid SMDH) + * @param large If true, returns large icon (48x48), otherwise returns small icon (24x24) + * @return QPixmap default icon + */ +static QPixmap GetDefaultIcon(bool large) { + int size = large ? 48 : 24; + QPixmap icon(size, size); + icon.fill(Qt::transparent); + return icon; +} + +class GameListItem : public QStandardItem { + +public: + GameListItem() : QStandardItem() {} + GameListItem(const QString& string) : QStandardItem(string) {} + virtual ~GameListItem() override {} +}; + +/** + * A specialization of GameListItem for path values. + * This class ensures that for every full path value it holds, a correct string representation + * of just the filename (with no extension) will be displayed to the user. + * If this class receives valid SMDH data, it will also display game icons and titles. + */ +class GameListItemPath : public GameListItem { + +public: + static const int FullPathRole = Qt::UserRole + 1; + static const int TitleRole = Qt::UserRole + 2; + static const int ProgramIdRole = Qt::UserRole + 3; + + GameListItemPath() : GameListItem() {} + GameListItemPath(const QString& game_path, const std::vector& smdh_data, u64 program_id) + : GameListItem() { + setData(game_path, FullPathRole); + setData(qulonglong(program_id), ProgramIdRole); + } + + QVariant data(int role) const override { + if (role == Qt::DisplayRole) { + std::string filename; + Common::SplitPath(data(FullPathRole).toString().toStdString(), nullptr, &filename, + nullptr); + QString title = data(TitleRole).toString(); + return QString::fromStdString(filename) + (title.isEmpty() ? "" : "\n " + title); + } else { + return GameListItem::data(role); + } + } +}; + +/** + * A specialization of GameListItem for size values. + * This class ensures that for every numerical size value it holds (in bytes), a correct + * human-readable string representation will be displayed to the user. + */ +class GameListItemSize : public GameListItem { + +public: + static const int SizeRole = Qt::UserRole + 1; + + GameListItemSize() : GameListItem() {} + GameListItemSize(const qulonglong size_bytes) : GameListItem() { + setData(size_bytes, SizeRole); + } + + void setData(const QVariant& value, int role) override { + // By specializing setData for SizeRole, we can ensure that the numerical and string + // representations of the data are always accurate and in the correct format. + if (role == SizeRole) { + qulonglong size_bytes = value.toULongLong(); + GameListItem::setData(ReadableByteSize(size_bytes), Qt::DisplayRole); + GameListItem::setData(value, SizeRole); + } else { + GameListItem::setData(value, role); + } + } + + /** + * This operator is, in practice, only used by the TreeView sorting systems. + * Override it so that it will correctly sort by numerical value instead of by string + * representation. + */ + bool operator<(const QStandardItem& other) const override { + return data(SizeRole).toULongLong() < other.data(SizeRole).toULongLong(); + } +}; + +/** + * Asynchronous worker object for populating the game list. + * Communicates with other threads through Qt's signal/slot system. + */ +class GameListWorker : public QObject, public QRunnable { + Q_OBJECT + +public: + GameListWorker(QString dir_path, bool deep_scan) + : QObject(), QRunnable(), dir_path(dir_path), deep_scan(deep_scan) {} + +public slots: + /// Starts the processing of directory tree information. + void run() override; + /// Tells the worker that it should no longer continue processing. Thread-safe. + void Cancel(); + +signals: + /** + * The `EntryReady` signal is emitted once an entry has been prepared and is ready + * to be added to the game list. + * @param entry_items a list with `QStandardItem`s that make up the columns of the new entry. + */ + void EntryReady(QList entry_items); + + /** + * After the worker has traversed the game directory looking for entries, this signal is emmited + * with a list of folders that should be watched for changes as well. + */ + void Finished(QStringList watch_list); + +private: + QStringList watch_list; + QString dir_path; + bool deep_scan; + std::atomic_bool stop_processing; + + void AddFstEntriesToGameList(const std::string& dir_path, unsigned int recursion = 0); +}; diff --git a/src/yuzu/hotkeys.cpp b/src/yuzu/hotkeys.cpp new file mode 100644 index 000000000..158ed506f --- /dev/null +++ b/src/yuzu/hotkeys.cpp @@ -0,0 +1,90 @@ +// Copyright 2014 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include +#include +#include +#include +#include "citra_qt/hotkeys.h" +#include "citra_qt/ui_settings.h" + +struct Hotkey { + Hotkey() : shortcut(nullptr), context(Qt::WindowShortcut) {} + + QKeySequence keyseq; + QShortcut* shortcut; + Qt::ShortcutContext context; +}; + +typedef std::map HotkeyMap; +typedef std::map HotkeyGroupMap; + +HotkeyGroupMap hotkey_groups; + +void SaveHotkeys() { + UISettings::values.shortcuts.clear(); + for (auto group : hotkey_groups) { + for (auto hotkey : group.second) { + UISettings::values.shortcuts.emplace_back( + UISettings::Shortcut(group.first + "/" + hotkey.first, + UISettings::ContextualShortcut(hotkey.second.keyseq.toString(), + hotkey.second.context))); + } + } +} + +void LoadHotkeys() { + // Make sure NOT to use a reference here because it would become invalid once we call + // beginGroup() + for (auto shortcut : UISettings::values.shortcuts) { + QStringList cat = shortcut.first.split("/"); + Q_ASSERT(cat.size() >= 2); + + // RegisterHotkey assigns default keybindings, so use old values as default parameters + Hotkey& hk = hotkey_groups[cat[0]][cat[1]]; + if (!shortcut.second.first.isEmpty()) { + hk.keyseq = QKeySequence::fromString(shortcut.second.first); + hk.context = (Qt::ShortcutContext)shortcut.second.second; + } + if (hk.shortcut) + hk.shortcut->setKey(hk.keyseq); + } +} + +void RegisterHotkey(const QString& group, const QString& action, const QKeySequence& default_keyseq, + Qt::ShortcutContext default_context) { + if (hotkey_groups[group].find(action) == hotkey_groups[group].end()) { + hotkey_groups[group][action].keyseq = default_keyseq; + hotkey_groups[group][action].context = default_context; + } +} + +QShortcut* GetHotkey(const QString& group, const QString& action, QWidget* widget) { + Hotkey& hk = hotkey_groups[group][action]; + + if (!hk.shortcut) + hk.shortcut = new QShortcut(hk.keyseq, widget, nullptr, nullptr, hk.context); + + return hk.shortcut; +} + +GHotkeysDialog::GHotkeysDialog(QWidget* parent) : QWidget(parent) { + ui.setupUi(this); + + for (auto group : hotkey_groups) { + QTreeWidgetItem* toplevel_item = new QTreeWidgetItem(QStringList(group.first)); + for (auto hotkey : group.second) { + QStringList columns; + columns << hotkey.first << hotkey.second.keyseq.toString(); + QTreeWidgetItem* item = new QTreeWidgetItem(columns); + toplevel_item->addChild(item); + } + ui.treeWidget->addTopLevelItem(toplevel_item); + } + // TODO: Make context configurable as well (hiding the column for now) + ui.treeWidget->setColumnCount(2); + + ui.treeWidget->resizeColumnToContents(0); + ui.treeWidget->resizeColumnToContents(1); +} diff --git a/src/yuzu/hotkeys.h b/src/yuzu/hotkeys.h new file mode 100644 index 000000000..a4ccc193b --- /dev/null +++ b/src/yuzu/hotkeys.h @@ -0,0 +1,64 @@ +// Copyright 2014 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#pragma once + +#include "ui_hotkeys.h" + +class QDialog; +class QKeySequence; +class QSettings; +class QShortcut; + +/** + * Register a hotkey. + * + * @param group General group this hotkey belongs to (e.g. "Main Window", "Debugger") + * @param action Name of the action (e.g. "Start Emulation", "Load Image") + * @param default_keyseq Default key sequence to assign if the hotkey wasn't present in the settings + * file before + * @param default_context Default context to assign if the hotkey wasn't present in the settings + * file before + * @warning Both the group and action strings will be displayed in the hotkey settings dialog + */ +void RegisterHotkey(const QString& group, const QString& action, + const QKeySequence& default_keyseq = QKeySequence(), + Qt::ShortcutContext default_context = Qt::WindowShortcut); + +/** + * Returns a QShortcut object whose activated() signal can be connected to other QObjects' slots. + * + * @param group General group this hotkey belongs to (e.g. "Main Window", "Debugger"). + * @param action Name of the action (e.g. "Start Emulation", "Load Image"). + * @param widget Parent widget of the returned QShortcut. + * @warning If multiple QWidgets' call this function for the same action, the returned QShortcut + * will be the same. Thus, you shouldn't rely on the caller really being the QShortcut's parent. + */ +QShortcut* GetHotkey(const QString& group, const QString& action, QWidget* widget); + +/** + * Saves all registered hotkeys to the settings file. + * + * @note Each hotkey group will be stored a settings group; For each hotkey inside that group, a + * settings group will be created to store the key sequence and the hotkey context. + */ +void SaveHotkeys(); + +/** + * Loads hotkeys from the settings file. + * + * @note Yet unregistered hotkeys which are present in the settings will automatically be + * registered. + */ +void LoadHotkeys(); + +class GHotkeysDialog : public QWidget { + Q_OBJECT + +public: + explicit GHotkeysDialog(QWidget* parent = nullptr); + +private: + Ui::hotkeys ui; +}; diff --git a/src/yuzu/hotkeys.ui b/src/yuzu/hotkeys.ui new file mode 100644 index 000000000..050fe064e --- /dev/null +++ b/src/yuzu/hotkeys.ui @@ -0,0 +1,46 @@ + + + hotkeys + + + + 0 + 0 + 363 + 388 + + + + Hotkey Settings + + + + + + QAbstractItemView::SelectItems + + + false + + + + Action + + + + + Hotkey + + + + + Context + + + + + + + + + diff --git a/src/yuzu/main.cpp b/src/yuzu/main.cpp new file mode 100644 index 000000000..943aee30d --- /dev/null +++ b/src/yuzu/main.cpp @@ -0,0 +1,877 @@ +// Copyright 2014 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include +#include +#include +#include +#include +#define QT_NO_OPENGL +#include +#include +#include +#include +#include +#include "citra_qt/bootmanager.h" +#include "citra_qt/configuration/config.h" +#include "citra_qt/configuration/configure_dialog.h" +#include "citra_qt/debugger/graphics/graphics.h" +#include "citra_qt/debugger/graphics/graphics_breakpoints.h" +#include "citra_qt/debugger/graphics/graphics_cmdlists.h" +#include "citra_qt/debugger/graphics/graphics_surface.h" +#include "citra_qt/debugger/graphics/graphics_tracing.h" +#include "citra_qt/debugger/graphics/graphics_vertex_shader.h" +#include "citra_qt/debugger/profiler.h" +#include "citra_qt/debugger/registers.h" +#include "citra_qt/debugger/wait_tree.h" +#include "citra_qt/game_list.h" +#include "citra_qt/hotkeys.h" +#include "citra_qt/main.h" +#include "citra_qt/ui_settings.h" +#include "common/logging/backend.h" +#include "common/logging/filter.h" +#include "common/logging/log.h" +#include "common/logging/text_formatter.h" +#include "common/microprofile.h" +#include "common/platform.h" +#include "common/scm_rev.h" +#include "common/scope_exit.h" +#include "common/string_util.h" +#include "core/core.h" +#include "core/gdbstub/gdbstub.h" +#include "core/loader/loader.h" +#include "core/settings.h" + +#ifdef QT_STATICPLUGIN +Q_IMPORT_PLUGIN(QWindowsIntegrationPlugin); +#endif + +/** + * "Callouts" are one-time instructional messages shown to the user. In the config settings, there + * is a bitfield "callout_flags" options, used to track if a message has already been shown to the + * user. This is 32-bits - if we have more than 32 callouts, we should retire and recyle old ones. + */ +enum class CalloutFlag : uint32_t { + Telemetry = 0x1, +}; + +static void ShowCalloutMessage(const QString& message, CalloutFlag flag) { + if (UISettings::values.callout_flags & static_cast(flag)) { + return; + } + + UISettings::values.callout_flags |= static_cast(flag); + + QMessageBox msg; + msg.setText(message); + msg.setStandardButtons(QMessageBox::Ok); + msg.setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding); + msg.setStyleSheet("QLabel{min-width: 900px;}"); + msg.exec(); +} + +void GMainWindow::ShowCallouts() { + static const QString telemetry_message = + tr("To help improve Citra, the Citra Team collects anonymous usage data. No private or " + "personally identifying information is collected. This data helps us to understand how " + "people use Citra and prioritize our efforts. Furthermore, it helps us to more easily " + "identify emulation bugs and performance issues. This data includes:
  • Information" + " about the version of Citra you are using
  • Performance data about the games you " + "play
  • Your configuration settings
  • Information about your computer " + "hardware
  • Emulation errors and crash information
By default, this " + "feature is enabled. To disable this feature, click 'Emulation' from the menu and then " + "select 'Configure...'. Then, on the 'Web' tab, uncheck 'Share anonymous usage data with" + " the Citra team'.

By using this software, you agree to the above terms.
" + "
Learn " + "more"); + ShowCalloutMessage(telemetry_message, CalloutFlag::Telemetry); +} + +GMainWindow::GMainWindow() : config(new Config()), emu_thread(nullptr) { + Pica::g_debug_context = Pica::DebugContext::Construct(); + setAcceptDrops(true); + ui.setupUi(this); + statusBar()->hide(); + + InitializeWidgets(); + InitializeDebugWidgets(); + InitializeRecentFileMenuActions(); + InitializeHotkeys(); + + SetDefaultUIGeometry(); + RestoreUIState(); + + ConnectMenuEvents(); + ConnectWidgetEvents(); + + setWindowTitle(QString("Citra %1| %2-%3") + .arg(Common::g_build_name, Common::g_scm_branch, Common::g_scm_desc)); + show(); + + game_list->PopulateAsync(UISettings::values.gamedir, UISettings::values.gamedir_deepscan); + + UpdateUITheme(); + + // Show one-time "callout" messages to the user + ShowCallouts(); + + QStringList args = QApplication::arguments(); + if (args.length() >= 2) { + BootGame(args[1]); + } +} + +GMainWindow::~GMainWindow() { + // will get automatically deleted otherwise + if (render_window->parent() == nullptr) + delete render_window; + + Pica::g_debug_context.reset(); +} + +void GMainWindow::InitializeWidgets() { + render_window = new GRenderWindow(this, emu_thread.get()); + render_window->hide(); + + game_list = new GameList(this); + ui.horizontalLayout->addWidget(game_list); + + // Create status bar + message_label = new QLabel(); + // Configured separately for left alignment + message_label->setVisible(false); + message_label->setFrameStyle(QFrame::NoFrame); + message_label->setContentsMargins(4, 0, 4, 0); + message_label->setAlignment(Qt::AlignLeft); + statusBar()->addPermanentWidget(message_label, 1); + + emu_speed_label = new QLabel(); + emu_speed_label->setToolTip(tr("Current emulation speed. Values higher or lower than 100% " + "indicate emulation is running faster or slower than a 3DS.")); + game_fps_label = new QLabel(); + game_fps_label->setToolTip(tr("How many frames per second the game is currently displaying. " + "This will vary from game to game and scene to scene.")); + emu_frametime_label = new QLabel(); + emu_frametime_label->setToolTip( + tr("Time taken to emulate a 3DS frame, not counting framelimiting or v-sync. For " + "full-speed emulation this should be at most 16.67 ms.")); + + for (auto& label : {emu_speed_label, game_fps_label, emu_frametime_label}) { + label->setVisible(false); + label->setFrameStyle(QFrame::NoFrame); + label->setContentsMargins(4, 0, 4, 0); + statusBar()->addPermanentWidget(label, 0); + } + statusBar()->setVisible(true); + setStyleSheet("QStatusBar::item{border: none;}"); +} + +void GMainWindow::InitializeDebugWidgets() { + connect(ui.action_Create_Pica_Surface_Viewer, &QAction::triggered, this, + &GMainWindow::OnCreateGraphicsSurfaceViewer); + + QMenu* debug_menu = ui.menu_View_Debugging; + +#if MICROPROFILE_ENABLED + microProfileDialog = new MicroProfileDialog(this); + microProfileDialog->hide(); + debug_menu->addAction(microProfileDialog->toggleViewAction()); +#endif + + registersWidget = new RegistersWidget(this); + addDockWidget(Qt::RightDockWidgetArea, registersWidget); + registersWidget->hide(); + debug_menu->addAction(registersWidget->toggleViewAction()); + connect(this, &GMainWindow::EmulationStarting, registersWidget, + &RegistersWidget::OnEmulationStarting); + connect(this, &GMainWindow::EmulationStopping, registersWidget, + &RegistersWidget::OnEmulationStopping); + + graphicsWidget = new GPUCommandStreamWidget(this); + addDockWidget(Qt::RightDockWidgetArea, graphicsWidget); + graphicsWidget->hide(); + debug_menu->addAction(graphicsWidget->toggleViewAction()); + + graphicsCommandsWidget = new GPUCommandListWidget(this); + addDockWidget(Qt::RightDockWidgetArea, graphicsCommandsWidget); + graphicsCommandsWidget->hide(); + debug_menu->addAction(graphicsCommandsWidget->toggleViewAction()); + + graphicsBreakpointsWidget = new GraphicsBreakPointsWidget(Pica::g_debug_context, this); + addDockWidget(Qt::RightDockWidgetArea, graphicsBreakpointsWidget); + graphicsBreakpointsWidget->hide(); + debug_menu->addAction(graphicsBreakpointsWidget->toggleViewAction()); + + graphicsVertexShaderWidget = new GraphicsVertexShaderWidget(Pica::g_debug_context, this); + addDockWidget(Qt::RightDockWidgetArea, graphicsVertexShaderWidget); + graphicsVertexShaderWidget->hide(); + debug_menu->addAction(graphicsVertexShaderWidget->toggleViewAction()); + + graphicsTracingWidget = new GraphicsTracingWidget(Pica::g_debug_context, this); + addDockWidget(Qt::RightDockWidgetArea, graphicsTracingWidget); + graphicsTracingWidget->hide(); + debug_menu->addAction(graphicsTracingWidget->toggleViewAction()); + connect(this, &GMainWindow::EmulationStarting, graphicsTracingWidget, + &GraphicsTracingWidget::OnEmulationStarting); + connect(this, &GMainWindow::EmulationStopping, graphicsTracingWidget, + &GraphicsTracingWidget::OnEmulationStopping); + + waitTreeWidget = new WaitTreeWidget(this); + addDockWidget(Qt::LeftDockWidgetArea, waitTreeWidget); + waitTreeWidget->hide(); + debug_menu->addAction(waitTreeWidget->toggleViewAction()); + connect(this, &GMainWindow::EmulationStarting, waitTreeWidget, + &WaitTreeWidget::OnEmulationStarting); + connect(this, &GMainWindow::EmulationStopping, waitTreeWidget, + &WaitTreeWidget::OnEmulationStopping); +} + +void GMainWindow::InitializeRecentFileMenuActions() { + for (int i = 0; i < max_recent_files_item; ++i) { + actions_recent_files[i] = new QAction(this); + actions_recent_files[i]->setVisible(false); + connect(actions_recent_files[i], SIGNAL(triggered()), this, SLOT(OnMenuRecentFile())); + + ui.menu_recent_files->addAction(actions_recent_files[i]); + } + + UpdateRecentFiles(); +} + +void GMainWindow::InitializeHotkeys() { + RegisterHotkey("Main Window", "Load File", QKeySequence::Open); + RegisterHotkey("Main Window", "Swap Screens", QKeySequence::NextChild); + RegisterHotkey("Main Window", "Start Emulation"); + LoadHotkeys(); + + connect(GetHotkey("Main Window", "Load File", this), SIGNAL(activated()), this, + SLOT(OnMenuLoadFile())); + connect(GetHotkey("Main Window", "Start Emulation", this), SIGNAL(activated()), this, + SLOT(OnStartGame())); + connect(GetHotkey("Main Window", "Swap Screens", render_window), SIGNAL(activated()), this, + SLOT(OnSwapScreens())); +} + +void GMainWindow::SetDefaultUIGeometry() { + // geometry: 55% of the window contents are in the upper screen half, 45% in the lower half + const QRect screenRect = QApplication::desktop()->screenGeometry(this); + + const int w = screenRect.width() * 2 / 3; + const int h = screenRect.height() / 2; + const int x = (screenRect.x() + screenRect.width()) / 2 - w / 2; + const int y = (screenRect.y() + screenRect.height()) / 2 - h * 55 / 100; + + setGeometry(x, y, w, h); +} + +void GMainWindow::RestoreUIState() { + restoreGeometry(UISettings::values.geometry); + restoreState(UISettings::values.state); + render_window->restoreGeometry(UISettings::values.renderwindow_geometry); +#if MICROPROFILE_ENABLED + microProfileDialog->restoreGeometry(UISettings::values.microprofile_geometry); + microProfileDialog->setVisible(UISettings::values.microprofile_visible); +#endif + + game_list->LoadInterfaceLayout(); + + ui.action_Single_Window_Mode->setChecked(UISettings::values.single_window_mode); + ToggleWindowMode(); + + ui.action_Display_Dock_Widget_Headers->setChecked(UISettings::values.display_titlebar); + OnDisplayTitleBars(ui.action_Display_Dock_Widget_Headers->isChecked()); + + ui.action_Show_Filter_Bar->setChecked(UISettings::values.show_filter_bar); + game_list->setFilterVisible(ui.action_Show_Filter_Bar->isChecked()); + + ui.action_Show_Status_Bar->setChecked(UISettings::values.show_status_bar); + statusBar()->setVisible(ui.action_Show_Status_Bar->isChecked()); +} + +void GMainWindow::ConnectWidgetEvents() { + connect(game_list, SIGNAL(GameChosen(QString)), this, SLOT(OnGameListLoadFile(QString))); + connect(game_list, SIGNAL(OpenSaveFolderRequested(u64)), this, + SLOT(OnGameListOpenSaveFolder(u64))); + + connect(this, SIGNAL(EmulationStarting(EmuThread*)), render_window, + SLOT(OnEmulationStarting(EmuThread*))); + connect(this, SIGNAL(EmulationStopping()), render_window, SLOT(OnEmulationStopping())); + + connect(&status_bar_update_timer, &QTimer::timeout, this, &GMainWindow::UpdateStatusBar); +} + +void GMainWindow::ConnectMenuEvents() { + // File + connect(ui.action_Load_File, &QAction::triggered, this, &GMainWindow::OnMenuLoadFile); + connect(ui.action_Select_Game_List_Root, &QAction::triggered, this, + &GMainWindow::OnMenuSelectGameListRoot); + connect(ui.action_Exit, &QAction::triggered, this, &QMainWindow::close); + + // Emulation + connect(ui.action_Start, &QAction::triggered, this, &GMainWindow::OnStartGame); + connect(ui.action_Pause, &QAction::triggered, this, &GMainWindow::OnPauseGame); + connect(ui.action_Stop, &QAction::triggered, this, &GMainWindow::OnStopGame); + connect(ui.action_Configure, &QAction::triggered, this, &GMainWindow::OnConfigure); + + // View + connect(ui.action_Single_Window_Mode, &QAction::triggered, this, + &GMainWindow::ToggleWindowMode); + connect(ui.action_Display_Dock_Widget_Headers, &QAction::triggered, this, + &GMainWindow::OnDisplayTitleBars); + ui.action_Show_Filter_Bar->setShortcut(tr("CTRL+F")); + connect(ui.action_Show_Filter_Bar, &QAction::triggered, this, &GMainWindow::OnToggleFilterBar); + connect(ui.action_Show_Status_Bar, &QAction::triggered, statusBar(), &QStatusBar::setVisible); +} + +void GMainWindow::OnDisplayTitleBars(bool show) { + QList widgets = findChildren(); + + if (show) { + for (QDockWidget* widget : widgets) { + QWidget* old = widget->titleBarWidget(); + widget->setTitleBarWidget(nullptr); + if (old != nullptr) + delete old; + } + } else { + for (QDockWidget* widget : widgets) { + QWidget* old = widget->titleBarWidget(); + widget->setTitleBarWidget(new QWidget()); + if (old != nullptr) + delete old; + } + } +} + +bool GMainWindow::LoadROM(const QString& filename) { + // Shutdown previous session if the emu thread is still active... + if (emu_thread != nullptr) + ShutdownGame(); + + render_window->InitRenderTarget(); + render_window->MakeCurrent(); + + if (!gladLoadGL()) { + QMessageBox::critical(this, tr("Error while initializing OpenGL 3.3 Core!"), + tr("Your GPU may not support OpenGL 3.3, or you do not " + "have the latest graphics driver.")); + return false; + } + + Core::System& system{Core::System::GetInstance()}; + + const Core::System::ResultStatus result{system.Load(render_window, filename.toStdString())}; + + Core::Telemetry().AddField(Telemetry::FieldType::App, "Frontend", "Qt"); + + if (result != Core::System::ResultStatus::Success) { + switch (result) { + case Core::System::ResultStatus::ErrorGetLoader: + LOG_CRITICAL(Frontend, "Failed to obtain loader for %s!", + filename.toStdString().c_str()); + QMessageBox::critical(this, tr("Error while loading ROM!"), + tr("The ROM format is not supported.")); + break; + + case Core::System::ResultStatus::ErrorSystemMode: + LOG_CRITICAL(Frontend, "Failed to load ROM!"); + QMessageBox::critical(this, tr("Error while loading ROM!"), + tr("Could not determine the system mode.")); + break; + + case Core::System::ResultStatus::ErrorLoader_ErrorEncrypted: { + QMessageBox::critical( + this, tr("Error while loading ROM!"), + tr("The game that you are trying to load must be decrypted before being used with " + "Citra. A real 3DS is required.

" + "For more information on dumping and decrypting games, please see the following " + "wiki pages: ")); + break; + } + case Core::System::ResultStatus::ErrorLoader_ErrorInvalidFormat: + QMessageBox::critical(this, tr("Error while loading ROM!"), + tr("The ROM format is not supported.")); + break; + + case Core::System::ResultStatus::ErrorVideoCore: + QMessageBox::critical( + this, tr("An error occured in the video core."), + tr("Citra has encountered an error while running the video core, please see the " + "log for more details." + "For more information on accessing the log, please see the following page: " + "How " + "to " + "Upload the Log File." + "Ensure that you have the latest graphics drivers for your GPU.")); + + break; + + default: + QMessageBox::critical( + this, tr("Error while loading ROM!"), + tr("An unknown error occured. Please see the log for more details.")); + break; + } + return false; + } + return true; +} + +void GMainWindow::BootGame(const QString& filename) { + LOG_INFO(Frontend, "Citra starting..."); + StoreRecentFile(filename); // Put the filename on top of the list + + if (!LoadROM(filename)) + return; + + // Create and start the emulation thread + emu_thread = std::make_unique(render_window); + emit EmulationStarting(emu_thread.get()); + render_window->moveContext(); + emu_thread->start(); + + connect(render_window, SIGNAL(Closed()), this, SLOT(OnStopGame())); + // BlockingQueuedConnection is important here, it makes sure we've finished refreshing our views + // before the CPU continues + connect(emu_thread.get(), SIGNAL(DebugModeEntered()), registersWidget, + SLOT(OnDebugModeEntered()), Qt::BlockingQueuedConnection); + connect(emu_thread.get(), SIGNAL(DebugModeEntered()), waitTreeWidget, + SLOT(OnDebugModeEntered()), Qt::BlockingQueuedConnection); + connect(emu_thread.get(), SIGNAL(DebugModeLeft()), registersWidget, SLOT(OnDebugModeLeft()), + Qt::BlockingQueuedConnection); + connect(emu_thread.get(), SIGNAL(DebugModeLeft()), waitTreeWidget, SLOT(OnDebugModeLeft()), + Qt::BlockingQueuedConnection); + + // Update the GUI + registersWidget->OnDebugModeEntered(); + if (ui.action_Single_Window_Mode->isChecked()) { + game_list->hide(); + } + status_bar_update_timer.start(2000); + + render_window->show(); + render_window->setFocus(); + + emulation_running = true; + OnStartGame(); +} + +void GMainWindow::ShutdownGame() { + emu_thread->RequestStop(); + + // Release emu threads from any breakpoints + // This belongs after RequestStop() and before wait() because if emulation stops on a GPU + // breakpoint after (or before) RequestStop() is called, the emulation would never be able + // to continue out to the main loop and terminate. Thus wait() would hang forever. + // TODO(bunnei): This function is not thread safe, but it's being used as if it were + Pica::g_debug_context->ClearBreakpoints(); + + emit EmulationStopping(); + + // Wait for emulation thread to complete and delete it + emu_thread->wait(); + emu_thread = nullptr; + + // The emulation is stopped, so closing the window or not does not matter anymore + disconnect(render_window, SIGNAL(Closed()), this, SLOT(OnStopGame())); + + // Update the GUI + ui.action_Start->setEnabled(false); + ui.action_Start->setText(tr("Start")); + ui.action_Pause->setEnabled(false); + ui.action_Stop->setEnabled(false); + render_window->hide(); + game_list->show(); + game_list->setFilterFocus(); + + // Disable status bar updates + status_bar_update_timer.stop(); + message_label->setVisible(false); + emu_speed_label->setVisible(false); + game_fps_label->setVisible(false); + emu_frametime_label->setVisible(false); + + emulation_running = false; +} + +void GMainWindow::StoreRecentFile(const QString& filename) { + UISettings::values.recent_files.prepend(filename); + UISettings::values.recent_files.removeDuplicates(); + while (UISettings::values.recent_files.size() > max_recent_files_item) { + UISettings::values.recent_files.removeLast(); + } + + UpdateRecentFiles(); +} + +void GMainWindow::UpdateRecentFiles() { + unsigned int num_recent_files = + std::min(UISettings::values.recent_files.size(), static_cast(max_recent_files_item)); + + for (unsigned int i = 0; i < num_recent_files; i++) { + QString text = QString("&%1. %2").arg(i + 1).arg( + QFileInfo(UISettings::values.recent_files[i]).fileName()); + actions_recent_files[i]->setText(text); + actions_recent_files[i]->setData(UISettings::values.recent_files[i]); + actions_recent_files[i]->setToolTip(UISettings::values.recent_files[i]); + actions_recent_files[i]->setVisible(true); + } + + for (int j = num_recent_files; j < max_recent_files_item; ++j) { + actions_recent_files[j]->setVisible(false); + } + + // Grey out the recent files menu if the list is empty + if (num_recent_files == 0) { + ui.menu_recent_files->setEnabled(false); + } else { + ui.menu_recent_files->setEnabled(true); + } +} + +void GMainWindow::OnGameListLoadFile(QString game_path) { + BootGame(game_path); +} + +void GMainWindow::OnGameListOpenSaveFolder(u64 program_id) { + UNIMPLEMENTED(); +} + +void GMainWindow::OnMenuLoadFile() { + QString extensions; + for (const auto& piece : game_list->supported_file_extensions) + extensions += "*." + piece + " "; + + QString file_filter = tr("3DS Executable") + " (" + extensions + ")"; + file_filter += ";;" + tr("All Files (*.*)"); + + QString filename = QFileDialog::getOpenFileName(this, tr("Load File"), + UISettings::values.roms_path, file_filter); + if (!filename.isEmpty()) { + UISettings::values.roms_path = QFileInfo(filename).path(); + + BootGame(filename); + } +} + +void GMainWindow::OnMenuSelectGameListRoot() { + QString dir_path = QFileDialog::getExistingDirectory(this, tr("Select Directory")); + if (!dir_path.isEmpty()) { + UISettings::values.gamedir = dir_path; + game_list->PopulateAsync(dir_path, UISettings::values.gamedir_deepscan); + } +} + +void GMainWindow::OnMenuRecentFile() { + QAction* action = qobject_cast(sender()); + assert(action); + + QString filename = action->data().toString(); + QFileInfo file_info(filename); + if (file_info.exists()) { + BootGame(filename); + } else { + // Display an error message and remove the file from the list. + QMessageBox::information(this, tr("File not found"), + tr("File \"%1\" not found").arg(filename)); + + UISettings::values.recent_files.removeOne(filename); + UpdateRecentFiles(); + } +} + +void GMainWindow::OnStartGame() { + emu_thread->SetRunning(true); + qRegisterMetaType("Core::System::ResultStatus"); + qRegisterMetaType("std::string"); + connect(emu_thread.get(), SIGNAL(ErrorThrown(Core::System::ResultStatus, std::string)), this, + SLOT(OnCoreError(Core::System::ResultStatus, std::string))); + + ui.action_Start->setEnabled(false); + ui.action_Start->setText(tr("Continue")); + + ui.action_Pause->setEnabled(true); + ui.action_Stop->setEnabled(true); +} + +void GMainWindow::OnPauseGame() { + emu_thread->SetRunning(false); + + ui.action_Start->setEnabled(true); + ui.action_Pause->setEnabled(false); + ui.action_Stop->setEnabled(true); +} + +void GMainWindow::OnStopGame() { + ShutdownGame(); +} + +void GMainWindow::ToggleWindowMode() { + if (ui.action_Single_Window_Mode->isChecked()) { + // Render in the main window... + render_window->BackupGeometry(); + ui.horizontalLayout->addWidget(render_window); + render_window->setFocusPolicy(Qt::ClickFocus); + if (emulation_running) { + render_window->setVisible(true); + render_window->setFocus(); + game_list->hide(); + } + + } else { + // Render in a separate window... + ui.horizontalLayout->removeWidget(render_window); + render_window->setParent(nullptr); + render_window->setFocusPolicy(Qt::NoFocus); + if (emulation_running) { + render_window->setVisible(true); + render_window->RestoreGeometry(); + game_list->show(); + } + } +} + +void GMainWindow::OnConfigure() { + ConfigureDialog configureDialog(this); + auto result = configureDialog.exec(); + if (result == QDialog::Accepted) { + configureDialog.applyConfiguration(); + UpdateUITheme(); + config->Save(); + } +} + +void GMainWindow::OnToggleFilterBar() { + game_list->setFilterVisible(ui.action_Show_Filter_Bar->isChecked()); + if (ui.action_Show_Filter_Bar->isChecked()) { + game_list->setFilterFocus(); + } else { + game_list->clearFilter(); + } +} + +void GMainWindow::OnSwapScreens() { + Settings::values.swap_screen = !Settings::values.swap_screen; + Settings::Apply(); +} + +void GMainWindow::OnCreateGraphicsSurfaceViewer() { + auto graphicsSurfaceViewerWidget = new GraphicsSurfaceWidget(Pica::g_debug_context, this); + addDockWidget(Qt::RightDockWidgetArea, graphicsSurfaceViewerWidget); + // TODO: Maybe graphicsSurfaceViewerWidget->setFloating(true); + graphicsSurfaceViewerWidget->show(); +} + +void GMainWindow::UpdateStatusBar() { + if (emu_thread == nullptr) { + status_bar_update_timer.stop(); + return; + } + + auto results = Core::System::GetInstance().GetAndResetPerfStats(); + + emu_speed_label->setText(tr("Speed: %1%").arg(results.emulation_speed * 100.0, 0, 'f', 0)); + game_fps_label->setText(tr("Game: %1 FPS").arg(results.game_fps, 0, 'f', 0)); + emu_frametime_label->setText(tr("Frame: %1 ms").arg(results.frametime * 1000.0, 0, 'f', 2)); + + emu_speed_label->setVisible(true); + game_fps_label->setVisible(true); + emu_frametime_label->setVisible(true); +} + +void GMainWindow::OnCoreError(Core::System::ResultStatus result, std::string details) { + QMessageBox::StandardButton answer; + QString status_message; + const QString common_message = + tr("The game you are trying to load requires additional files from your 3DS to be dumped " + "before playing.

For more information on dumping these files, please see the " + "following wiki page: Dumping System " + "Archives and the Shared Fonts from a 3DS Console.

Would you like to quit " + "back to the game list? Continuing emulation may result in crashes, corrupted save " + "data, or other bugs."); + switch (result) { + case Core::System::ResultStatus::ErrorSystemFiles: { + QString message = "Citra was unable to locate a 3DS system archive"; + if (!details.empty()) { + message.append(tr(": %1. ").arg(details.c_str())); + } else { + message.append(". "); + } + message.append(common_message); + + answer = QMessageBox::question(this, tr("System Archive Not Found"), message, + QMessageBox::Yes | QMessageBox::No, QMessageBox::No); + status_message = "System Archive Missing"; + break; + } + + case Core::System::ResultStatus::ErrorSharedFont: { + QString message = tr("Citra was unable to locate the 3DS shared fonts. "); + message.append(common_message); + answer = QMessageBox::question(this, tr("Shared Fonts Not Found"), message, + QMessageBox::Yes | QMessageBox::No, QMessageBox::No); + status_message = "Shared Font Missing"; + break; + } + + default: + answer = QMessageBox::question( + this, tr("Fatal Error"), + tr("Citra has encountered a fatal error, please see the log for more details. " + "For more information on accessing the log, please see the following page: " + "How to " + "Upload the Log File.

Would you like to quit back to the game list? " + "Continuing emulation may result in crashes, corrupted save data, or other bugs."), + QMessageBox::Yes | QMessageBox::No, QMessageBox::No); + status_message = "Fatal Error encountered"; + break; + } + + if (answer == QMessageBox::Yes) { + if (emu_thread) { + ShutdownGame(); + } + } else { + // Only show the message if the game is still running. + if (emu_thread) { + message_label->setText(status_message); + message_label->setVisible(true); + } + } +} + +bool GMainWindow::ConfirmClose() { + if (emu_thread == nullptr || !UISettings::values.confirm_before_closing) + return true; + + QMessageBox::StandardButton answer = + QMessageBox::question(this, tr("Citra"), tr("Are you sure you want to close Citra?"), + QMessageBox::Yes | QMessageBox::No, QMessageBox::No); + return answer != QMessageBox::No; +} + +void GMainWindow::closeEvent(QCloseEvent* event) { + if (!ConfirmClose()) { + event->ignore(); + return; + } + + UISettings::values.geometry = saveGeometry(); + UISettings::values.state = saveState(); + UISettings::values.renderwindow_geometry = render_window->saveGeometry(); +#if MICROPROFILE_ENABLED + UISettings::values.microprofile_geometry = microProfileDialog->saveGeometry(); + UISettings::values.microprofile_visible = microProfileDialog->isVisible(); +#endif + UISettings::values.single_window_mode = ui.action_Single_Window_Mode->isChecked(); + UISettings::values.display_titlebar = ui.action_Display_Dock_Widget_Headers->isChecked(); + UISettings::values.show_filter_bar = ui.action_Show_Filter_Bar->isChecked(); + UISettings::values.show_status_bar = ui.action_Show_Status_Bar->isChecked(); + UISettings::values.first_start = false; + + game_list->SaveInterfaceLayout(); + SaveHotkeys(); + + // Shutdown session if the emu thread is active... + if (emu_thread != nullptr) + ShutdownGame(); + + render_window->close(); + + QWidget::closeEvent(event); +} + +static bool IsSingleFileDropEvent(QDropEvent* event) { + const QMimeData* mimeData = event->mimeData(); + return mimeData->hasUrls() && mimeData->urls().length() == 1; +} + +void GMainWindow::dropEvent(QDropEvent* event) { + if (IsSingleFileDropEvent(event) && ConfirmChangeGame()) { + const QMimeData* mimeData = event->mimeData(); + QString filename = mimeData->urls().at(0).toLocalFile(); + BootGame(filename); + } +} + +void GMainWindow::dragEnterEvent(QDragEnterEvent* event) { + if (IsSingleFileDropEvent(event)) { + event->acceptProposedAction(); + } +} + +void GMainWindow::dragMoveEvent(QDragMoveEvent* event) { + event->acceptProposedAction(); +} + +bool GMainWindow::ConfirmChangeGame() { + if (emu_thread == nullptr) + return true; + + auto answer = QMessageBox::question( + this, tr("Citra"), + tr("Are you sure you want to stop the emulation? Any unsaved progress will be lost."), + QMessageBox::Yes | QMessageBox::No, QMessageBox::No); + return answer != QMessageBox::No; +} + +void GMainWindow::filterBarSetChecked(bool state) { + ui.action_Show_Filter_Bar->setChecked(state); + emit(OnToggleFilterBar()); +} + +void GMainWindow::UpdateUITheme() { + if (UISettings::values.theme != UISettings::themes[0].second) { + QString theme_uri(":" + UISettings::values.theme + "/style.qss"); + QFile f(theme_uri); + if (!f.exists()) { + LOG_ERROR(Frontend, "Unable to set style, stylesheet file not found"); + } else { + f.open(QFile::ReadOnly | QFile::Text); + QTextStream ts(&f); + qApp->setStyleSheet(ts.readAll()); + GMainWindow::setStyleSheet(ts.readAll()); + } + } else { + qApp->setStyleSheet(""); + GMainWindow::setStyleSheet(""); + } +} + +#ifdef main +#undef main +#endif + +int main(int argc, char* argv[]) { + Log::Filter log_filter(Log::Level::Info); + Log::SetFilter(&log_filter); + + MicroProfileOnThreadCreate("Frontend"); + SCOPE_EXIT({ MicroProfileShutdown(); }); + + // Init settings params + QCoreApplication::setOrganizationName("Citra team"); + QCoreApplication::setApplicationName("Citra"); + + QApplication::setAttribute(Qt::AA_X11InitThreads); + QApplication app(argc, argv); + + // Qt changes the locale and causes issues in float conversion using std::to_string() when + // generating shaders + setlocale(LC_ALL, "C"); + + GMainWindow main_window; + // After settings have been loaded by GMainWindow, apply the filter + log_filter.ParseFilterString(Settings::values.log_filter); + + main_window.show(); + return app.exec(); +} diff --git a/src/yuzu/main.h b/src/yuzu/main.h new file mode 100644 index 000000000..d59a6d67d --- /dev/null +++ b/src/yuzu/main.h @@ -0,0 +1,174 @@ +// Copyright 2014 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#ifndef _CITRA_QT_MAIN_HXX_ +#define _CITRA_QT_MAIN_HXX_ + +#include +#include +#include +#include "core/core.h" +#include "ui_main.h" + +class Config; +class EmuThread; +class GameList; +class GImageInfo; +class GPUCommandStreamWidget; +class GPUCommandListWidget; +class GraphicsBreakPointsWidget; +class GraphicsTracingWidget; +class GraphicsVertexShaderWidget; +class GRenderWindow; +class MicroProfileDialog; +class ProfilerWidget; +class RegistersWidget; +class WaitTreeWidget; + +class GMainWindow : public QMainWindow { + Q_OBJECT + + /// Max number of recently loaded items to keep track of + static const int max_recent_files_item = 10; + + // TODO: Make use of this! + enum { + UI_IDLE, + UI_EMU_BOOTING, + UI_EMU_RUNNING, + UI_EMU_STOPPING, + }; + +public: + void filterBarSetChecked(bool state); + void UpdateUITheme(); + GMainWindow(); + ~GMainWindow(); + +signals: + + /** + * Signal that is emitted when a new EmuThread has been created and an emulation session is + * about to start. At this time, the core system emulation has been initialized, and all + * emulation handles and memory should be valid. + * + * @param emu_thread Pointer to the newly created EmuThread (to be used by widgets that need to + * access/change emulation state). + */ + void EmulationStarting(EmuThread* emu_thread); + + /** + * Signal that is emitted when emulation is about to stop. At this time, the EmuThread and core + * system emulation handles and memory are still valid, but are about become invalid. + */ + void EmulationStopping(); + +private: + void InitializeWidgets(); + void InitializeDebugWidgets(); + void InitializeRecentFileMenuActions(); + void InitializeHotkeys(); + + void SetDefaultUIGeometry(); + void RestoreUIState(); + + void ConnectWidgetEvents(); + void ConnectMenuEvents(); + + bool LoadROM(const QString& filename); + void BootGame(const QString& filename); + void ShutdownGame(); + + void ShowCallouts(); + + /** + * Stores the filename in the recently loaded files list. + * The new filename is stored at the beginning of the recently loaded files list. + * After inserting the new entry, duplicates are removed meaning that if + * this was inserted from \a OnMenuRecentFile(), the entry will be put on top + * and remove from its previous position. + * + * Finally, this function calls \a UpdateRecentFiles() to update the UI. + * + * @param filename the filename to store + */ + void StoreRecentFile(const QString& filename); + + /** + * Updates the recent files menu. + * Menu entries are rebuilt from the configuration file. + * If there is no entry in the menu, the menu is greyed out. + */ + void UpdateRecentFiles(); + + /** + * If the emulation is running, + * asks the user if he really want to close the emulator + * + * @return true if the user confirmed + */ + bool ConfirmClose(); + bool ConfirmChangeGame(); + void closeEvent(QCloseEvent* event) override; + +private slots: + void OnStartGame(); + void OnPauseGame(); + void OnStopGame(); + /// Called whenever a user selects a game in the game list widget. + void OnGameListLoadFile(QString game_path); + void OnGameListOpenSaveFolder(u64 program_id); + void OnMenuLoadFile(); + /// Called whenever a user selects the "File->Select Game List Root" menu item + void OnMenuSelectGameListRoot(); + void OnMenuRecentFile(); + void OnSwapScreens(); + void OnConfigure(); + void OnToggleFilterBar(); + void OnDisplayTitleBars(bool); + void ToggleWindowMode(); + void OnCreateGraphicsSurfaceViewer(); + void OnCoreError(Core::System::ResultStatus, std::string); + +private: + void UpdateStatusBar(); + + Ui::MainWindow ui; + + GRenderWindow* render_window; + GameList* game_list; + + // Status bar elements + QLabel* message_label = nullptr; + QLabel* emu_speed_label = nullptr; + QLabel* game_fps_label = nullptr; + QLabel* emu_frametime_label = nullptr; + QTimer status_bar_update_timer; + + std::unique_ptr config; + + // Whether emulation is currently running in Citra. + bool emulation_running = false; + std::unique_ptr emu_thread; + + // Debugger panes + ProfilerWidget* profilerWidget; + MicroProfileDialog* microProfileDialog; + RegistersWidget* registersWidget; + GPUCommandStreamWidget* graphicsWidget; + GPUCommandListWidget* graphicsCommandsWidget; + GraphicsBreakPointsWidget* graphicsBreakpointsWidget; + GraphicsVertexShaderWidget* graphicsVertexShaderWidget; + GraphicsTracingWidget* graphicsTracingWidget; + WaitTreeWidget* waitTreeWidget; + + QAction* actions_recent_files[max_recent_files_item]; + +protected: + void dropEvent(QDropEvent* event) override; + void dragEnterEvent(QDragEnterEvent* event) override; + void dragMoveEvent(QDragMoveEvent* event) override; +}; + +#endif // _CITRA_QT_MAIN_HXX_ diff --git a/src/yuzu/main.ui b/src/yuzu/main.ui new file mode 100644 index 000000000..b13d578f5 --- /dev/null +++ b/src/yuzu/main.ui @@ -0,0 +1,201 @@ + + + MainWindow + + + + 0 + 0 + 1081 + 730 + + + + Citra + + + + src/pcafe/res/icon3_64x64.icosrc/pcafe/res/icon3_64x64.ico + + + QTabWidget::Rounded + + + true + + + + + 0 + + + 0 + + + 0 + + + 0 + + + + + + + 0 + 0 + 1081 + 19 + + + + + &File + + + + Recent Files + + + + + + + + + + + + &Emulation + + + + + + + + + + &View + + + + Debugging + + + + + + + + + + + + + &Help + + + + + + + + + + + Load File... + + + + + Load Symbol Map... + + + + + E&xit + + + + + false + + + &Start + + + + + false + + + &Pause + + + + + false + + + &Stop + + + + + About Citra + + + + + true + + + Single Window Mode + + + + + Configure... + + + + + true + + + Display Dock Widget Headers + + + + + true + + + Show Filter Bar + + + + + true + + + Show Status Bar + + + + + Select Game Directory... + + + Selects a folder to display in the game list + + + + + Create Pica Surface Viewer + + + + + diff --git a/src/yuzu/ui_settings.cpp b/src/yuzu/ui_settings.cpp new file mode 100644 index 000000000..120b34990 --- /dev/null +++ b/src/yuzu/ui_settings.cpp @@ -0,0 +1,10 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include "ui_settings.h" + +namespace UISettings { + +Values values = {}; +} diff --git a/src/yuzu/ui_settings.h b/src/yuzu/ui_settings.h new file mode 100644 index 000000000..d85c92765 --- /dev/null +++ b/src/yuzu/ui_settings.h @@ -0,0 +1,56 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#pragma once + +#include +#include +#include +#include +#include + +namespace UISettings { + +using ContextualShortcut = std::pair; +using Shortcut = std::pair; + +static const std::array, 2> themes = { + {std::make_pair(QString("Default"), QString("default")), + std::make_pair(QString("Dark"), QString("qdarkstyle"))}}; + +struct Values { + QByteArray geometry; + QByteArray state; + + QByteArray renderwindow_geometry; + + QByteArray gamelist_header_state; + + QByteArray microprofile_geometry; + bool microprofile_visible; + + bool single_window_mode; + bool display_titlebar; + bool show_filter_bar; + bool show_status_bar; + + bool confirm_before_closing; + bool first_start; + + QString roms_path; + QString symbols_path; + QString gamedir; + bool gamedir_deepscan; + QStringList recent_files; + + QString theme; + + // Shortcut name + std::vector shortcuts; + + uint32_t callout_flags; +}; + +extern Values values; +} diff --git a/src/yuzu/util/spinbox.cpp b/src/yuzu/util/spinbox.cpp new file mode 100644 index 000000000..212709007 --- /dev/null +++ b/src/yuzu/util/spinbox.cpp @@ -0,0 +1,278 @@ +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +// Copyright 2014 Tony Wasserka +// All rights reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above copyright +// notice, this list of conditions and the following disclaimer in the +// documentation and/or other materials provided with the distribution. +// * Neither the name of the owner nor the names of its contributors may +// be used to endorse or promote products derived from this software +// without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +#include +#include +#include +#include "citra_qt/util/spinbox.h" +#include "common/assert.h" + +CSpinBox::CSpinBox(QWidget* parent) + : QAbstractSpinBox(parent), min_value(-100), max_value(100), value(0), base(10), num_digits(0) { + // TODO: Might be nice to not immediately call the slot. + // Think of an address that is being replaced by a different one, in which case a lot + // invalid intermediate addresses would be read from during editing. + connect(lineEdit(), SIGNAL(textEdited(QString)), this, SLOT(OnEditingFinished())); + + UpdateText(); +} + +void CSpinBox::SetValue(qint64 val) { + auto old_value = value; + value = std::max(std::min(val, max_value), min_value); + + if (old_value != value) { + UpdateText(); + emit ValueChanged(value); + } +} + +void CSpinBox::SetRange(qint64 min, qint64 max) { + min_value = min; + max_value = max; + + SetValue(value); + UpdateText(); +} + +void CSpinBox::stepBy(int steps) { + auto new_value = value; + // Scale number of steps by the currently selected digit + // TODO: Move this code elsewhere and enable it. + // TODO: Support for num_digits==0, too + // TODO: Support base!=16, too + // TODO: Make the cursor not jump back to the end of the line... + /*if (base == 16 && num_digits > 0) { + int digit = num_digits - (lineEdit()->cursorPosition() - prefix.length()) - 1; + digit = std::max(0, std::min(digit, num_digits - 1)); + steps <<= digit * 4; + }*/ + + // Increment "new_value" by "steps", and perform annoying overflow checks, too. + if (steps < 0 && new_value + steps > new_value) { + new_value = std::numeric_limits::min(); + } else if (steps > 0 && new_value + steps < new_value) { + new_value = std::numeric_limits::max(); + } else { + new_value += steps; + } + + SetValue(new_value); + UpdateText(); +} + +QAbstractSpinBox::StepEnabled CSpinBox::stepEnabled() const { + StepEnabled ret = StepNone; + + if (value > min_value) + ret |= StepDownEnabled; + + if (value < max_value) + ret |= StepUpEnabled; + + return ret; +} + +void CSpinBox::SetBase(int base) { + this->base = base; + + UpdateText(); +} + +void CSpinBox::SetNumDigits(int num_digits) { + this->num_digits = num_digits; + + UpdateText(); +} + +void CSpinBox::SetPrefix(const QString& prefix) { + this->prefix = prefix; + + UpdateText(); +} + +void CSpinBox::SetSuffix(const QString& suffix) { + this->suffix = suffix; + + UpdateText(); +} + +static QString StringToInputMask(const QString& input) { + QString mask = input; + + // ... replace any special characters by their escaped counterparts ... + mask.replace("\\", "\\\\"); + mask.replace("A", "\\A"); + mask.replace("a", "\\a"); + mask.replace("N", "\\N"); + mask.replace("n", "\\n"); + mask.replace("X", "\\X"); + mask.replace("x", "\\x"); + mask.replace("9", "\\9"); + mask.replace("0", "\\0"); + mask.replace("D", "\\D"); + mask.replace("d", "\\d"); + mask.replace("#", "\\#"); + mask.replace("H", "\\H"); + mask.replace("h", "\\h"); + mask.replace("B", "\\B"); + mask.replace("b", "\\b"); + mask.replace(">", "\\>"); + mask.replace("<", "\\<"); + mask.replace("!", "\\!"); + + return mask; +} + +void CSpinBox::UpdateText() { + // If a fixed number of digits is used, we put the line edit in insertion mode by setting an + // input mask. + QString mask; + if (num_digits != 0) { + mask += StringToInputMask(prefix); + + // For base 10 and negative range, demand a single sign character + if (HasSign()) + mask += "X"; // identified as "-" or "+" in the validator + + // Uppercase digits greater than 9. + mask += ">"; + + // Match num_digits digits + // Digits irrelevant to the chosen number base are filtered in the validator + mask += QString("H").repeated(std::max(num_digits, 1)); + + // Switch off case conversion + mask += "!"; + + mask += StringToInputMask(suffix); + } + lineEdit()->setInputMask(mask); + + // Set new text without changing the cursor position. This will cause the cursor to briefly + // appear at the end of the line and then to jump back to its original position. That's + // a bit ugly, but better than having setText() move the cursor permanently all the time. + int cursor_position = lineEdit()->cursorPosition(); + lineEdit()->setText(TextFromValue()); + lineEdit()->setCursorPosition(cursor_position); +} + +QString CSpinBox::TextFromValue() { + return prefix + QString(HasSign() ? ((value < 0) ? "-" : "+") : "") + + QString("%1").arg(std::abs(value), num_digits, base, QLatin1Char('0')).toUpper() + + suffix; +} + +qint64 CSpinBox::ValueFromText() { + unsigned strpos = prefix.length(); + + QString num_string = text().mid(strpos, text().length() - strpos - suffix.length()); + return num_string.toLongLong(nullptr, base); +} + +bool CSpinBox::HasSign() const { + return base == 10 && min_value < 0; +} + +void CSpinBox::OnEditingFinished() { + // Only update for valid input + QString input = lineEdit()->text(); + int pos = 0; + if (QValidator::Acceptable == validate(input, pos)) + SetValue(ValueFromText()); +} + +QValidator::State CSpinBox::validate(QString& input, int& pos) const { + if (!prefix.isEmpty() && input.left(prefix.length()) != prefix) + return QValidator::Invalid; + + int strpos = prefix.length(); + + // Empty "numbers" allowed as intermediate values + if (strpos >= input.length() - HasSign() - suffix.length()) + return QValidator::Intermediate; + + DEBUG_ASSERT(base <= 10 || base == 16); + QString regexp; + + // Demand sign character for negative ranges + if (HasSign()) + regexp += "[+\\-]"; + + // Match digits corresponding to the chosen number base. + regexp += QString("[0-%1").arg(std::min(base, 9)); + if (base == 16) { + regexp += "a-fA-F"; + } + regexp += "]"; + + // Specify number of digits + if (num_digits > 0) { + regexp += QString("{%1}").arg(num_digits); + } else { + regexp += "+"; + } + + // Match string + QRegExp num_regexp(regexp); + int num_pos = strpos; + QString sub_input = input.mid(strpos, input.length() - strpos - suffix.length()); + + if (!num_regexp.exactMatch(sub_input) && num_regexp.matchedLength() == 0) + return QValidator::Invalid; + + sub_input = sub_input.left(num_regexp.matchedLength()); + bool ok; + qint64 val = sub_input.toLongLong(&ok, base); + + if (!ok) + return QValidator::Invalid; + + // Outside boundaries => don't accept + if (val < min_value || val > max_value) + return QValidator::Invalid; + + // Make sure we are actually at the end of this string... + strpos += num_regexp.matchedLength(); + + if (!suffix.isEmpty() && input.mid(strpos) != suffix) { + return QValidator::Invalid; + } else { + strpos += suffix.length(); + } + + if (strpos != input.length()) + return QValidator::Invalid; + + // At this point we can say for sure that the input is fine. Let's fix it up a bit though + input.replace(num_pos, sub_input.length(), sub_input.toUpper()); + + return QValidator::Acceptable; +} diff --git a/src/yuzu/util/spinbox.h b/src/yuzu/util/spinbox.h new file mode 100644 index 000000000..2fa1db3a4 --- /dev/null +++ b/src/yuzu/util/spinbox.h @@ -0,0 +1,86 @@ +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +// Copyright 2014 Tony Wasserka +// All rights reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above copyright +// notice, this list of conditions and the following disclaimer in the +// documentation and/or other materials provided with the distribution. +// * Neither the name of the owner nor the names of its contributors may +// be used to endorse or promote products derived from this software +// without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +#pragma once + +#include +#include + +class QVariant; + +/** + * A custom spin box widget with enhanced functionality over Qt's QSpinBox + */ +class CSpinBox : public QAbstractSpinBox { + Q_OBJECT + +public: + explicit CSpinBox(QWidget* parent = nullptr); + + void stepBy(int steps) override; + StepEnabled stepEnabled() const override; + + void SetValue(qint64 val); + + void SetRange(qint64 min, qint64 max); + + void SetBase(int base); + + void SetPrefix(const QString& prefix); + void SetSuffix(const QString& suffix); + + void SetNumDigits(int num_digits); + + QValidator::State validate(QString& input, int& pos) const override; + +signals: + void ValueChanged(qint64 val); + +private slots: + void OnEditingFinished(); + +private: + void UpdateText(); + + bool HasSign() const; + + QString TextFromValue(); + qint64 ValueFromText(); + + qint64 min_value, max_value; + + qint64 value; + + QString prefix, suffix; + + int base; + + int num_digits; +}; diff --git a/src/yuzu/util/util.cpp b/src/yuzu/util/util.cpp new file mode 100644 index 000000000..02be92bbd --- /dev/null +++ b/src/yuzu/util/util.cpp @@ -0,0 +1,26 @@ +// Copyright 2015 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include +#include +#include "citra_qt/util/util.h" + +QFont GetMonospaceFont() { + QFont font("monospace"); + // Automatic fallback to a monospace font on on platforms without a font called "monospace" + font.setStyleHint(QFont::Monospace); + font.setFixedPitch(true); + return font; +} + +QString ReadableByteSize(qulonglong size) { + static const std::array units = {"B", "KiB", "MiB", "GiB", "TiB", "PiB"}; + if (size == 0) + return "0"; + int digit_groups = std::min(static_cast(std::log10(size) / std::log10(1024)), + static_cast(units.size())); + return QString("%L1 %2") + .arg(size / std::pow(1024, digit_groups), 0, 'f', 1) + .arg(units[digit_groups]); +} diff --git a/src/yuzu/util/util.h b/src/yuzu/util/util.h new file mode 100644 index 000000000..ab443ef9b --- /dev/null +++ b/src/yuzu/util/util.h @@ -0,0 +1,14 @@ +// Copyright 2015 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#pragma once + +#include +#include + +/// Returns a QFont object appropriate to use as a monospace font for debugging widgets, etc. +QFont GetMonospaceFont(); + +/// Convert a size in bytes into a readable format (KiB, MiB, etc.) +QString ReadableByteSize(qulonglong size); diff --git a/src/yuzu_cmd/CMakeLists.txt b/src/yuzu_cmd/CMakeLists.txt new file mode 100644 index 000000000..c6c527eb6 --- /dev/null +++ b/src/yuzu_cmd/CMakeLists.txt @@ -0,0 +1,35 @@ +set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} ${PROJECT_SOURCE_DIR}/CMakeModules) + +set(SRCS + emu_window/emu_window_sdl2.cpp + citra.cpp + config.cpp + citra.rc + ) +set(HEADERS + emu_window/emu_window_sdl2.h + config.h + default_ini.h + resource.h + ) + +create_directory_groups(${SRCS} ${HEADERS}) + +add_executable(yuzu-cmd ${SRCS} ${HEADERS}) +target_link_libraries(yuzu-cmd PRIVATE common core input_common) +target_link_libraries(yuzu-cmd PRIVATE inih glad) +if (MSVC) + target_link_libraries(yuzu-cmd PRIVATE getopt) +endif() +target_link_libraries(yuzu-cmd PRIVATE ${PLATFORM_LIBRARIES} SDL2 Threads::Threads) + +if(UNIX AND NOT APPLE) + install(TARGETS yuzu-cmd RUNTIME DESTINATION "${CMAKE_INSTALL_PREFIX}/bin") +endif() + +if (MSVC) + include(CopyCitraSDLDeps) + include(CopyYuzuUnicornDeps) + copy_citra_SDL_deps(yuzu-cmd) + copy_yuzu_unicorn_deps(yuzu-cmd) +endif() diff --git a/src/yuzu_cmd/citra.cpp b/src/yuzu_cmd/citra.cpp new file mode 100644 index 000000000..e524c5535 --- /dev/null +++ b/src/yuzu_cmd/citra.cpp @@ -0,0 +1,175 @@ +// Copyright 2014 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include +#include +#include +#include + +// This needs to be included before getopt.h because the latter #defines symbols used by it +#include "common/microprofile.h" + +#ifdef _MSC_VER +#include +#else +#include +#include +#endif + +#ifdef _WIN32 +// windows.h needs to be included before shellapi.h +#include + +#include +#endif + +#include "citra/config.h" +#include "citra/emu_window/emu_window_sdl2.h" +#include "common/logging/backend.h" +#include "common/logging/filter.h" +#include "common/logging/log.h" +#include "common/scm_rev.h" +#include "common/scope_exit.h" +#include "common/string_util.h" +#include "core/core.h" +#include "core/gdbstub/gdbstub.h" +#include "core/loader/loader.h" +#include "core/settings.h" + +static void PrintHelp(const char* argv0) { + std::cout << "Usage: " << argv0 + << " [options] \n" + "-g, --gdbport=NUMBER Enable gdb stub on port NUMBER\n" + "-h, --help Display this help and exit\n" + "-v, --version Output version information and exit\n"; +} + +static void PrintVersion() { + std::cout << "Citra " << Common::g_scm_branch << " " << Common::g_scm_desc << std::endl; +} + +/// Application entry point +int main(int argc, char** argv) { + Config config; + int option_index = 0; + bool use_gdbstub = Settings::values.use_gdbstub; + u32 gdb_port = static_cast(Settings::values.gdbstub_port); + char* endarg; +#ifdef _WIN32 + int argc_w; + auto argv_w = CommandLineToArgvW(GetCommandLineW(), &argc_w); + + if (argv_w == nullptr) { + LOG_CRITICAL(Frontend, "Failed to get command line arguments"); + return -1; + } +#endif + std::string filepath; + + static struct option long_options[] = { + {"gdbport", required_argument, 0, 'g'}, + {"help", no_argument, 0, 'h'}, + {"version", no_argument, 0, 'v'}, + {0, 0, 0, 0}, + }; + + while (optind < argc) { + char arg = getopt_long(argc, argv, "g:hv", long_options, &option_index); + if (arg != -1) { + switch (arg) { + case 'g': + errno = 0; + gdb_port = strtoul(optarg, &endarg, 0); + use_gdbstub = true; + if (endarg == optarg) + errno = EINVAL; + if (errno != 0) { + perror("--gdbport"); + exit(1); + } + break; + case 'h': + PrintHelp(argv[0]); + return 0; + case 'v': + PrintVersion(); + return 0; + } + } else { +#ifdef _WIN32 + filepath = Common::UTF16ToUTF8(argv_w[optind]); +#else + filepath = argv[optind]; +#endif + optind++; + } + } + +#ifdef _WIN32 + LocalFree(argv_w); +#endif + + Log::Filter log_filter(Log::Level::Debug); + Log::SetFilter(&log_filter); + + MicroProfileOnThreadCreate("EmuThread"); + SCOPE_EXIT({ MicroProfileShutdown(); }); + + if (filepath.empty()) { + LOG_CRITICAL(Frontend, "Failed to load ROM: No ROM specified"); + return -1; + } + + log_filter.ParseFilterString(Settings::values.log_filter); + + // Apply the command line arguments + Settings::values.gdbstub_port = gdb_port; + Settings::values.use_gdbstub = use_gdbstub; + Settings::Apply(); + + std::unique_ptr emu_window{std::make_unique()}; + + Core::System& system{Core::System::GetInstance()}; + + SCOPE_EXIT({ system.Shutdown(); }); + + const Core::System::ResultStatus load_result{system.Load(emu_window.get(), filepath)}; + + switch (load_result) { + case Core::System::ResultStatus::ErrorGetLoader: + LOG_CRITICAL(Frontend, "Failed to obtain loader for %s!", filepath.c_str()); + return -1; + case Core::System::ResultStatus::ErrorLoader: + LOG_CRITICAL(Frontend, "Failed to load ROM!"); + return -1; + case Core::System::ResultStatus::ErrorLoader_ErrorEncrypted: + LOG_CRITICAL(Frontend, "The game that you are trying to load must be decrypted before " + "being used with Citra. \n\n For more information on dumping and " + "decrypting games, please refer to: " + "https://citra-emu.org/wiki/dumping-game-cartridges/"); + return -1; + case Core::System::ResultStatus::ErrorLoader_ErrorInvalidFormat: + LOG_CRITICAL(Frontend, "Error while loading ROM: The ROM format is not supported."); + return -1; + case Core::System::ResultStatus::ErrorNotInitialized: + LOG_CRITICAL(Frontend, "CPUCore not initialized"); + return -1; + case Core::System::ResultStatus::ErrorSystemMode: + LOG_CRITICAL(Frontend, "Failed to determine system mode!"); + return -1; + case Core::System::ResultStatus::ErrorVideoCore: + LOG_CRITICAL(Frontend, "VideoCore not initialized"); + return -1; + case Core::System::ResultStatus::Success: + break; // Expected case + } + + Core::Telemetry().AddField(Telemetry::FieldType::App, "Frontend", "SDL"); + + while (emu_window->IsOpen()) { + system.RunLoop(); + } + + return 0; +} diff --git a/src/yuzu_cmd/citra.rc b/src/yuzu_cmd/citra.rc new file mode 100644 index 000000000..c490ef302 --- /dev/null +++ b/src/yuzu_cmd/citra.rc @@ -0,0 +1,17 @@ +#include "winresrc.h" +///////////////////////////////////////////////////////////////////////////// +// +// Icon +// + +// Icon with lowest ID value placed first to ensure application icon +// remains consistent on all systems. +CITRA_ICON ICON "../../dist/citra.ico" + + +///////////////////////////////////////////////////////////////////////////// +// +// RT_MANIFEST +// + +1 RT_MANIFEST "../../dist/citra.manifest" diff --git a/src/yuzu_cmd/config.cpp b/src/yuzu_cmd/config.cpp new file mode 100644 index 000000000..94d1a9f1c --- /dev/null +++ b/src/yuzu_cmd/config.cpp @@ -0,0 +1,160 @@ +// Copyright 2014 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include +#include +#include +#include "citra/config.h" +#include "citra/default_ini.h" +#include "common/file_util.h" +#include "common/logging/log.h" +#include "common/param_package.h" +#include "core/settings.h" +#include "input_common/main.h" + +Config::Config() { + // TODO: Don't hardcode the path; let the frontend decide where to put the config files. + sdl2_config_loc = FileUtil::GetUserPath(D_CONFIG_IDX) + "sdl2-config.ini"; + sdl2_config = std::make_unique(sdl2_config_loc); + + Reload(); +} + +Config::~Config() = default; + +bool Config::LoadINI(const std::string& default_contents, bool retry) { + const char* location = this->sdl2_config_loc.c_str(); + if (sdl2_config->ParseError() < 0) { + if (retry) { + LOG_WARNING(Config, "Failed to load %s. Creating file from defaults...", location); + FileUtil::CreateFullPath(location); + FileUtil::WriteStringToFile(true, default_contents, location); + sdl2_config = std::make_unique(location); // Reopen file + + return LoadINI(default_contents, false); + } + LOG_ERROR(Config, "Failed."); + return false; + } + LOG_INFO(Config, "Successfully loaded %s", location); + return true; +} + +static const std::array default_buttons = { + SDL_SCANCODE_A, SDL_SCANCODE_S, SDL_SCANCODE_Z, SDL_SCANCODE_X, SDL_SCANCODE_T, + SDL_SCANCODE_G, SDL_SCANCODE_F, SDL_SCANCODE_H, SDL_SCANCODE_Q, SDL_SCANCODE_W, + SDL_SCANCODE_M, SDL_SCANCODE_N, SDL_SCANCODE_1, SDL_SCANCODE_2, SDL_SCANCODE_B, +}; + +static const std::array, Settings::NativeAnalog::NumAnalogs> default_analogs{{ + { + SDL_SCANCODE_UP, SDL_SCANCODE_DOWN, SDL_SCANCODE_LEFT, SDL_SCANCODE_RIGHT, SDL_SCANCODE_D, + }, + { + SDL_SCANCODE_I, SDL_SCANCODE_K, SDL_SCANCODE_J, SDL_SCANCODE_L, SDL_SCANCODE_D, + }, +}}; + +void Config::ReadValues() { + // Controls + for (int i = 0; i < Settings::NativeButton::NumButtons; ++i) { + std::string default_param = InputCommon::GenerateKeyboardParam(default_buttons[i]); + Settings::values.buttons[i] = + sdl2_config->Get("Controls", Settings::NativeButton::mapping[i], default_param); + if (Settings::values.buttons[i].empty()) + Settings::values.buttons[i] = default_param; + } + + for (int i = 0; i < Settings::NativeAnalog::NumAnalogs; ++i) { + std::string default_param = InputCommon::GenerateAnalogParamFromKeys( + default_analogs[i][0], default_analogs[i][1], default_analogs[i][2], + default_analogs[i][3], default_analogs[i][4], 0.5f); + Settings::values.analogs[i] = + sdl2_config->Get("Controls", Settings::NativeAnalog::mapping[i], default_param); + if (Settings::values.analogs[i].empty()) + Settings::values.analogs[i] = default_param; + } + + Settings::values.motion_device = sdl2_config->Get( + "Controls", "motion_device", "engine:motion_emu,update_period:100,sensitivity:0.01"); + Settings::values.touch_device = + sdl2_config->Get("Controls", "touch_device", "engine:emu_window"); + + // Core + Settings::values.cpu_core = + static_cast(sdl2_config->GetInteger("Core", "cpu_core", 0)); + + // Renderer + Settings::values.use_hw_renderer = sdl2_config->GetBoolean("Renderer", "use_hw_renderer", true); + Settings::values.use_shader_jit = sdl2_config->GetBoolean("Renderer", "use_shader_jit", true); + Settings::values.resolution_factor = + (float)sdl2_config->GetReal("Renderer", "resolution_factor", 1.0); + Settings::values.use_vsync = sdl2_config->GetBoolean("Renderer", "use_vsync", false); + Settings::values.toggle_framelimit = + sdl2_config->GetBoolean("Renderer", "toggle_framelimit", true); + + Settings::values.bg_red = (float)sdl2_config->GetReal("Renderer", "bg_red", 0.0); + Settings::values.bg_green = (float)sdl2_config->GetReal("Renderer", "bg_green", 0.0); + Settings::values.bg_blue = (float)sdl2_config->GetReal("Renderer", "bg_blue", 0.0); + + // Layout + Settings::values.layout_option = + static_cast(sdl2_config->GetInteger("Layout", "layout_option", 0)); + Settings::values.swap_screen = sdl2_config->GetBoolean("Layout", "swap_screen", false); + Settings::values.custom_layout = sdl2_config->GetBoolean("Layout", "custom_layout", false); + Settings::values.custom_top_left = + static_cast(sdl2_config->GetInteger("Layout", "custom_top_left", 0)); + Settings::values.custom_top_top = + static_cast(sdl2_config->GetInteger("Layout", "custom_top_top", 0)); + Settings::values.custom_top_right = + static_cast(sdl2_config->GetInteger("Layout", "custom_top_right", 400)); + Settings::values.custom_top_bottom = + static_cast(sdl2_config->GetInteger("Layout", "custom_top_bottom", 240)); + Settings::values.custom_bottom_left = + static_cast(sdl2_config->GetInteger("Layout", "custom_bottom_left", 40)); + Settings::values.custom_bottom_top = + static_cast(sdl2_config->GetInteger("Layout", "custom_bottom_top", 240)); + Settings::values.custom_bottom_right = + static_cast(sdl2_config->GetInteger("Layout", "custom_bottom_right", 360)); + Settings::values.custom_bottom_bottom = + static_cast(sdl2_config->GetInteger("Layout", "custom_bottom_bottom", 480)); + + // Audio + Settings::values.sink_id = sdl2_config->Get("Audio", "output_engine", "auto"); + Settings::values.enable_audio_stretching = + sdl2_config->GetBoolean("Audio", "enable_audio_stretching", true); + Settings::values.audio_device_id = sdl2_config->Get("Audio", "output_device", "auto"); + + // Data Storage + Settings::values.use_virtual_sd = + sdl2_config->GetBoolean("Data Storage", "use_virtual_sd", true); + + // System + Settings::values.is_new_3ds = sdl2_config->GetBoolean("System", "is_new_3ds", false); + Settings::values.region_value = + sdl2_config->GetInteger("System", "region_value", Settings::REGION_VALUE_AUTO_SELECT); + + // Miscellaneous + Settings::values.log_filter = sdl2_config->Get("Miscellaneous", "log_filter", "*:Info"); + + // Debugging + Settings::values.use_gdbstub = sdl2_config->GetBoolean("Debugging", "use_gdbstub", false); + Settings::values.gdbstub_port = + static_cast(sdl2_config->GetInteger("Debugging", "gdbstub_port", 24689)); + + // Web Service + Settings::values.enable_telemetry = + sdl2_config->GetBoolean("WebService", "enable_telemetry", true); + Settings::values.telemetry_endpoint_url = sdl2_config->Get( + "WebService", "telemetry_endpoint_url", "https://services.citra-emu.org/api/telemetry"); + Settings::values.verify_endpoint_url = sdl2_config->Get( + "WebService", "verify_endpoint_url", "https://services.citra-emu.org/api/profile"); + Settings::values.citra_username = sdl2_config->Get("WebService", "citra_username", ""); + Settings::values.citra_token = sdl2_config->Get("WebService", "citra_token", ""); +} + +void Config::Reload() { + LoadINI(DefaultINI::sdl2_config_file); + ReadValues(); +} diff --git a/src/yuzu_cmd/config.h b/src/yuzu_cmd/config.h new file mode 100644 index 000000000..abc90f642 --- /dev/null +++ b/src/yuzu_cmd/config.h @@ -0,0 +1,24 @@ +// Copyright 2014 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#pragma once + +#include +#include + +class INIReader; + +class Config { + std::unique_ptr sdl2_config; + std::string sdl2_config_loc; + + bool LoadINI(const std::string& default_contents = "", bool retry = true); + void ReadValues(); + +public: + Config(); + ~Config(); + + void Reload(); +}; diff --git a/src/yuzu_cmd/default_ini.h b/src/yuzu_cmd/default_ini.h new file mode 100644 index 000000000..b7b8abe1e --- /dev/null +++ b/src/yuzu_cmd/default_ini.h @@ -0,0 +1,179 @@ +// Copyright 2014 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#pragma once + +namespace DefaultINI { + +const char* sdl2_config_file = R"( +[Controls] +# The input devices and parameters for each 3DS native input +# It should be in the format of "engine:[engine_name],[param1]:[value1],[param2]:[value2]..." +# Escape characters $0 (for ':'), $1 (for ',') and $2 (for '$') can be used in values + +# for button input, the following devices are available: +# - "keyboard" (default) for keyboard input. Required parameters: +# - "code": the code of the key to bind +# - "sdl" for joystick input using SDL. Required parameters: +# - "joystick": the index of the joystick to bind +# - "button"(optional): the index of the button to bind +# - "hat"(optional): the index of the hat to bind as direction buttons +# - "axis"(optional): the index of the axis to bind +# - "direction"(only used for hat): the direction name of the hat to bind. Can be "up", "down", "left" or "right" +# - "threshold"(only used for axis): a float value in (-1.0, 1.0) which the button is +# triggered if the axis value crosses +# - "direction"(only used for axis): "+" means the button is triggered when the axis value +# is greater than the threshold; "-" means the button is triggered when the axis value +# is smaller than the threshold +button_a= +button_b= +button_x= +button_y= +button_up= +button_down= +button_left= +button_right= +button_l= +button_r= +button_start= +button_select= +button_zl= +button_zr= +button_home= + +# for analog input, the following devices are available: +# - "analog_from_button" (default) for emulating analog input from direction buttons. Required parameters: +# - "up", "down", "left", "right": sub-devices for each direction. +# Should be in the format as a button input devices using escape characters, for example, "engine$0keyboard$1code$00" +# - "modifier": sub-devices as a modifier. +# - "modifier_scale": a float number representing the applied modifier scale to the analog input. +# Must be in range of 0.0-1.0. Defaults to 0.5 +# - "sdl" for joystick input using SDL. Required parameters: +# - "joystick": the index of the joystick to bind +# - "axis_x": the index of the axis to bind as x-axis (default to 0) +# - "axis_y": the index of the axis to bind as y-axis (default to 1) +circle_pad= +c_stick= + +# for motion input, the following devices are available: +# - "motion_emu" (default) for emulating motion input from mouse input. Required parameters: +# - "update_period": update period in milliseconds (default to 100) +# - "sensitivity": the coefficient converting mouse movement to tilting angle (default to 0.01) +motion_device= + +# for touch input, the following devices are available: +# - "emu_window" (default) for emulating touch input from mouse input to the emulation window. No parameters required +touch_device= + +[Core] +# Which CPU core to use for CPU emulation +# 0 (default): Unicorn (slow), 1: Dynarmic (faster) +cpu_core = + +[Renderer] +# Whether to use software or hardware rendering. +# 0: Software, 1 (default): Hardware +use_hw_renderer = + +# Whether to use the Just-In-Time (JIT) compiler for shader emulation +# 0: Interpreter (slow), 1 (default): JIT (fast) +use_shader_jit = + +# Resolution scale factor +# 0: Auto (scales resolution to window size), 1: Native 3DS screen resolution, Otherwise a scale +# factor for the 3DS resolution +resolution_factor = + +# Whether to enable V-Sync (caps the framerate at 60FPS) or not. +# 0 (default): Off, 1: On +use_vsync = + +# The clear color for the renderer. What shows up on the sides of the bottom screen. +# Must be in range of 0.0-1.0. Defaults to 1.0 for all. +bg_red = +bg_blue = +bg_green = + +[Layout] +# Layout for the screen inside the render window. +# 0 (default): Default Top Bottom Screen, 1: Single Screen Only, 2: Large Screen Small Screen +layout_option = + +# Toggle custom layout (using the settings below) on or off. +# 0 (default): Off , 1: On +custom_layout = + +# Screen placement when using Custom layout option +# 0x, 0y is the top left corner of the render window. +custom_top_left = +custom_top_top = +custom_top_right = +custom_top_bottom = +custom_bottom_left = +custom_bottom_top = +custom_bottom_right = +custom_bottom_bottom = + +#Whether to toggle frame limiter on or off. +# 0: Off , 1 (default): On +toggle_framelimit = + +# Swaps the prominent screen with the other screen. +# For example, if Single Screen is chosen, setting this to 1 will display the bottom screen instead of the top screen. +# 0 (default): Top Screen is prominent, 1: Bottom Screen is prominent +swap_screen = + +[Audio] +# Which audio output engine to use. +# auto (default): Auto-select, null: No audio output, sdl2: SDL2 (if available) +output_engine = + +# Whether or not to enable the audio-stretching post-processing effect. +# This effect adjusts audio speed to match emulation speed and helps prevent audio stutter, +# at the cost of increasing audio latency. +# 0: No, 1 (default): Yes +enable_audio_stretching = + +# Which audio device to use. +# auto (default): Auto-select +output_device = + +[Data Storage] +# Whether to create a virtual SD card. +# 1 (default): Yes, 0: No +use_virtual_sd = + +[System] +# The system model that Citra will try to emulate +# 0: Old 3DS (default), 1: New 3DS +is_new_3ds = + +# The system region that Citra will use during emulation +# -1: Auto-select (default), 0: Japan, 1: USA, 2: Europe, 3: Australia, 4: China, 5: Korea, 6: Taiwan +region_value = + +[Miscellaneous] +# A filter which removes logs below a certain logging level. +# Examples: *:Debug Kernel.SVC:Trace Service.*:Critical +log_filter = *:Info + +[Debugging] +# Port for listening to GDB connections. +use_gdbstub=false +gdbstub_port=24689 + +[WebService] +# Whether or not to enable telemetry +# 0: No, 1 (default): Yes +enable_telemetry = +# Endpoint URL for submitting telemetry data +telemetry_endpoint_url = https://services.citra-emu.org/api/telemetry +# Endpoint URL to verify the username and token +verify_endpoint_url = https://services.citra-emu.org/api/profile +# Username and token for Citra Web Service +# See https://services.citra-emu.org/ for more info +citra_username = +citra_token = +)"; +} diff --git a/src/yuzu_cmd/emu_window/emu_window_sdl2.cpp b/src/yuzu_cmd/emu_window/emu_window_sdl2.cpp new file mode 100644 index 000000000..e65b04e4b --- /dev/null +++ b/src/yuzu_cmd/emu_window/emu_window_sdl2.cpp @@ -0,0 +1,177 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include +#include +#include +#define SDL_MAIN_HANDLED +#include +#include +#include "citra/emu_window/emu_window_sdl2.h" +#include "common/logging/log.h" +#include "common/scm_rev.h" +#include "common/string_util.h" +#include "core/settings.h" +#include "input_common/keyboard.h" +#include "input_common/main.h" +#include "input_common/motion_emu.h" +#include "network/network.h" + +void EmuWindow_SDL2::OnMouseMotion(s32 x, s32 y) { + TouchMoved((unsigned)std::max(x, 0), (unsigned)std::max(y, 0)); + InputCommon::GetMotionEmu()->Tilt(x, y); +} + +void EmuWindow_SDL2::OnMouseButton(u32 button, u8 state, s32 x, s32 y) { + if (button == SDL_BUTTON_LEFT) { + if (state == SDL_PRESSED) { + TouchPressed((unsigned)std::max(x, 0), (unsigned)std::max(y, 0)); + } else { + TouchReleased(); + } + } else if (button == SDL_BUTTON_RIGHT) { + if (state == SDL_PRESSED) { + InputCommon::GetMotionEmu()->BeginTilt(x, y); + } else { + InputCommon::GetMotionEmu()->EndTilt(); + } + } +} + +void EmuWindow_SDL2::OnKeyEvent(int key, u8 state) { + if (state == SDL_PRESSED) { + InputCommon::GetKeyboard()->PressKey(key); + } else if (state == SDL_RELEASED) { + InputCommon::GetKeyboard()->ReleaseKey(key); + } +} + +bool EmuWindow_SDL2::IsOpen() const { + return is_open; +} + +void EmuWindow_SDL2::OnResize() { + int width, height; + SDL_GetWindowSize(render_window, &width, &height); + UpdateCurrentFramebufferLayout(width, height); +} + +EmuWindow_SDL2::EmuWindow_SDL2() { + InputCommon::Init(); + Network::Init(); + + SDL_SetMainReady(); + + // Initialize the window + if (SDL_Init(SDL_INIT_VIDEO) < 0) { + LOG_CRITICAL(Frontend, "Failed to initialize SDL2! Exiting..."); + exit(1); + } + + SDL_GL_SetAttribute(SDL_GL_CONTEXT_MAJOR_VERSION, 3); + SDL_GL_SetAttribute(SDL_GL_CONTEXT_MINOR_VERSION, 3); + SDL_GL_SetAttribute(SDL_GL_CONTEXT_PROFILE_MASK, SDL_GL_CONTEXT_PROFILE_CORE); + SDL_GL_SetAttribute(SDL_GL_DOUBLEBUFFER, 1); + SDL_GL_SetAttribute(SDL_GL_RED_SIZE, 8); + SDL_GL_SetAttribute(SDL_GL_GREEN_SIZE, 8); + SDL_GL_SetAttribute(SDL_GL_BLUE_SIZE, 8); + SDL_GL_SetAttribute(SDL_GL_ALPHA_SIZE, 0); + + std::string window_title = Common::StringFromFormat("yuzu %s| %s-%s ", Common::g_build_name, + Common::g_scm_branch, Common::g_scm_desc); + render_window = + SDL_CreateWindow(window_title.c_str(), + SDL_WINDOWPOS_UNDEFINED, // x position + SDL_WINDOWPOS_UNDEFINED, // y position + Layout::ScreenUndocked::Width, Layout::ScreenUndocked::Height, + SDL_WINDOW_OPENGL | SDL_WINDOW_RESIZABLE | SDL_WINDOW_ALLOW_HIGHDPI); + + if (render_window == nullptr) { + LOG_CRITICAL(Frontend, "Failed to create SDL2 window! Exiting..."); + exit(1); + } + + gl_context = SDL_GL_CreateContext(render_window); + + if (gl_context == nullptr) { + LOG_CRITICAL(Frontend, "Failed to create SDL2 GL context! Exiting..."); + exit(1); + } + + if (!gladLoadGLLoader(static_cast(SDL_GL_GetProcAddress))) { + LOG_CRITICAL(Frontend, "Failed to initialize GL functions! Exiting..."); + exit(1); + } + + OnResize(); + OnMinimalClientAreaChangeRequest(GetActiveConfig().min_client_area_size); + SDL_PumpEvents(); + SDL_GL_SetSwapInterval(Settings::values.use_vsync); + + DoneCurrent(); +} + +EmuWindow_SDL2::~EmuWindow_SDL2() { + SDL_GL_DeleteContext(gl_context); + SDL_Quit(); + + Network::Shutdown(); + InputCommon::Shutdown(); +} + +void EmuWindow_SDL2::SwapBuffers() { + SDL_GL_SwapWindow(render_window); +} + +void EmuWindow_SDL2::PollEvents() { + SDL_Event event; + + // SDL_PollEvent returns 0 when there are no more events in the event queue + while (SDL_PollEvent(&event)) { + switch (event.type) { + case SDL_WINDOWEVENT: + switch (event.window.event) { + case SDL_WINDOWEVENT_SIZE_CHANGED: + case SDL_WINDOWEVENT_RESIZED: + case SDL_WINDOWEVENT_MAXIMIZED: + case SDL_WINDOWEVENT_RESTORED: + case SDL_WINDOWEVENT_MINIMIZED: + OnResize(); + break; + case SDL_WINDOWEVENT_CLOSE: + is_open = false; + break; + } + break; + case SDL_KEYDOWN: + case SDL_KEYUP: + OnKeyEvent(static_cast(event.key.keysym.scancode), event.key.state); + break; + case SDL_MOUSEMOTION: + OnMouseMotion(event.motion.x, event.motion.y); + break; + case SDL_MOUSEBUTTONDOWN: + case SDL_MOUSEBUTTONUP: + OnMouseButton(event.button.button, event.button.state, event.button.x, event.button.y); + break; + case SDL_QUIT: + is_open = false; + break; + } + } +} + +void EmuWindow_SDL2::MakeCurrent() { + SDL_GL_MakeCurrent(render_window, gl_context); +} + +void EmuWindow_SDL2::DoneCurrent() { + SDL_GL_MakeCurrent(render_window, nullptr); +} + +void EmuWindow_SDL2::OnMinimalClientAreaChangeRequest( + const std::pair& minimal_size) { + + SDL_SetWindowMinimumSize(render_window, minimal_size.first, minimal_size.second); +} diff --git a/src/yuzu_cmd/emu_window/emu_window_sdl2.h b/src/yuzu_cmd/emu_window/emu_window_sdl2.h new file mode 100644 index 000000000..3664d2fbe --- /dev/null +++ b/src/yuzu_cmd/emu_window/emu_window_sdl2.h @@ -0,0 +1,59 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#pragma once + +#include +#include +#include "core/frontend/emu_window.h" + +struct SDL_Window; + +class EmuWindow_SDL2 : public EmuWindow { +public: + EmuWindow_SDL2(); + ~EmuWindow_SDL2(); + + /// Swap buffers to display the next frame + void SwapBuffers() override; + + /// Polls window events + void PollEvents() override; + + /// Makes the graphics context current for the caller thread + void MakeCurrent() override; + + /// Releases the GL context from the caller thread + void DoneCurrent() override; + + /// Whether the window is still open, and a close request hasn't yet been sent + bool IsOpen() const; + +private: + /// Called by PollEvents when a key is pressed or released. + void OnKeyEvent(int key, u8 state); + + /// Called by PollEvents when the mouse moves. + void OnMouseMotion(s32 x, s32 y); + + /// Called by PollEvents when a mouse button is pressed or released + void OnMouseButton(u32 button, u8 state, s32 x, s32 y); + + /// Called by PollEvents when any event that may cause the window to be resized occurs + void OnResize(); + + /// Called when a configuration change affects the minimal size of the window + void OnMinimalClientAreaChangeRequest( + const std::pair& minimal_size) override; + + /// Is the window still open? + bool is_open = true; + + /// Internal SDL2 render window + SDL_Window* render_window; + + using SDL_GLContext = void*; + /// The OpenGL context associated with the window + SDL_GLContext gl_context; +}; diff --git a/src/yuzu_cmd/resource.h b/src/yuzu_cmd/resource.h new file mode 100644 index 000000000..df8e459e4 --- /dev/null +++ b/src/yuzu_cmd/resource.h @@ -0,0 +1,16 @@ +//{{NO_DEPENDENCIES}} +// Microsoft Visual C++ generated include file. +// Used by pcafe.rc +// +#define IDI_ICON3 103 + +// Next default values for new objects +// +#ifdef APSTUDIO_INVOKED +#ifndef APSTUDIO_READONLY_SYMBOLS +#define _APS_NEXT_RESOURCE_VALUE 105 +#define _APS_NEXT_COMMAND_VALUE 40001 +#define _APS_NEXT_CONTROL_VALUE 1001 +#define _APS_NEXT_SYMED_VALUE 101 +#endif +#endif -- cgit v1.2.3