Merge branch 'grumpycoders:main' into main

Author: johnbaumann

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+redux@grumpycoder.net.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,52 @@
+# Introduction
+
+## Acknowledgements
+
+Thank you for considering contributing to PCSX-Redux. The main aim of the project is to
+be a useful development, debugging, and reverse engineering tool, but any sort of help is greatly
+appreciated. There are various areas of the project that can be improved, and lots
+of work is still required. Feel free to open a discussion if there's anything
+you'd like to talk about.
+
+## Licensing your contribution
+
+By submitting a pull request, you represent that you have the right to license your contribution 
+to the PCSX-Redux authors and the community, and agree by submitting the patch that 
+your contributions are licensed under the project's license.
+
+## Why should you read this guideline?
+
+Following this guideline will help you to keep contact with the PCSX-Redux team.
+This will result in shorter time to process your bug reports, suggestions and pull requests.
+
+## Ways of contributing to PCSX-Redux
+
+You may contribute in a number of ways, including:
+
+* Contributing new features or bugfixes.
+* Filing detailed bug reports.
+* Suggesting new features.
+* Contributing to the [documentation](https://pcsx-redux.consoledev.net/) in the [docs](https://github.com/grumpycoders/pcsx-redux/tree/docs) branch.
+* Contributing unit test cases.
+
+# Contributing to PCSX-Redux
+
+## Code of conduct
+
+Please read and follow the [Code of Conduct](CODE_OF_CONDUCT.md) before contributing.
+
+## Contributing documentation
+
+* Provide improvements as small as possible, as pull requests.
+* If a change in documentation structure is needed, we prefer that you file a suggestion.
+
+## Contributing code
+
+* For non-trivial issues or changes, please file an issue where we can discuss the course of action.
+* Software pull requests should be as small as possible and providing only one feature per pull request.
+* The codebase is using C++-20, so all features from there are fair game, provided it builds on all of the supported platforms. Submitting a pull request should trigger builds for all supported platforms.
+* Please try and follow the codestyle, which is enforced by the [clang-format](https://github.com/grumpycoders/pcsx-redux/blob/main/src/.clang-format) rules. Worst case scenario, a bot will issue another PR to fix the codestyle however, so no need to sweat it too much.
+
+## Filing a bug report
+
+If you find a bug, please as much as possible try to file a detailed bug report using the [issue template](https://github.com/grumpycoders/pcsx-redux/issues/new?assignees=&labels=&template=bug_report.yml).

src/gui/gui.cc

@@ -912,6 +912,7 @@ in Configuration->Emulation, restart PCSX-Redux, then try again.)"));
                     m_biosEditor.MenuItem();
                     ImGui::EndMenu();
                 }
+                ImGui::MenuItem(_("Show Memory Observer"), nullptr, &m_memoryObserver.m_show);
                 ImGui::MenuItem(_("Show Interrupts Scaler"), nullptr, &m_showInterruptsScaler);
                 ImGui::MenuItem(_("Kernel Events"), nullptr, &m_events.m_show);
                 ImGui::MenuItem(_("Kernel Calls"), nullptr, &m_kernelLog.m_show);
@@ -1108,6 +1109,10 @@ in Configuration->Emulation, restart PCSX-Redux, then try again.)"));
         m_breakpoints.draw(_("Breakpoints"));
     }
 
+    if (m_memoryObserver.m_show) {
+        m_memoryObserver.draw(_("Memory Observer"));
+    }
+
     changed |= about();
     interruptsScaler();
 

src/gui/gui.h

@@ -50,6 +50,7 @@
 #include "magic_enum/include/magic_enum.hpp"
 #include "support/eventbus.h"
 #include "support/settings.h"
+#include "widgets/memory_observer.h"
 
 #if defined(__APPLE__)
 #define GL_SHADER_VERSION "#version 410\n"
@@ -247,6 +248,7 @@ class GUI final {
     MemoryEditorWrapper m_scratchPadEditor;
     MemoryEditorWrapper m_hwrEditor;
     MemoryEditorWrapper m_biosEditor;
+    Widgets::MemoryObserver m_memoryObserver;
     Widgets::MemcardManager m_memcardManager;
     Widgets::Registers m_registers;
     Widgets::Assembly m_assembly;