CrashHandler.h 2.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  1. /*
  2. * Copyright (c) Contributors to the Open 3D Engine Project.
  3. * For complete copyright and license terms please see the LICENSE at the root of this distribution.
  4. *
  5. * SPDX-License-Identifier: Apache-2.0 OR MIT
  6. *
  7. */
  8. // LY Crashpad Hook
  9. #pragma once
  10. #include <map>
  11. #include <string>
  12. #include <vector>
  13. namespace CrashHandler
  14. {
  15. static const char* defaultCrashFolder = "CrashDB/";
  16. static const char* O3DEProductName = "O3DE";
  17. static const char* manualReportToken = "manual";
  18. static const char* manualReportUrl = "https://manual";
  19. using CrashHandlerAnnotations = std::map<std::string, std::string>;
  20. using CrashHandlerArguments = std::vector<std::string>;
  21. class CrashHandlerBase
  22. {
  23. public:
  24. CrashHandlerBase() = default;
  25. virtual ~CrashHandlerBase() = default;
  26. static void InitCrashHandler(const std::string& moduleTag, const std::string& devRoot, const std::string& crashUrl = {}, const std::string& crashToken = {}, const std::string& handlerFolder = {}, const CrashHandlerAnnotations& baseAnnotations = CrashHandlerAnnotations(), const CrashHandlerArguments& argumentVec = CrashHandlerArguments());
  27. void Initialize(const std::string& moduleTag, const std::string& devRoot);
  28. void Initialize(const std::string& moduleTag, const std::string& devRoot, const std::string& crashUrl, const std::string& crashToken, const std::string& handlerFolder = {}, const CrashHandlerAnnotations& baseAnnotations = CrashHandlerAnnotations(), const CrashHandlerArguments& argumentVec = CrashHandlerArguments());
  29. // Helper to add an annotation after initialization - must have already called InitCrashHandler
  30. static void AddAnnotation(const std::string& keyName, const std::string& valueStr);
  31. protected:
  32. virtual std::string GetCrashReportFolder(const std::string& lyAppRoot) const;
  33. virtual const char* GetDefaultCrashFolder() const { return defaultCrashFolder; }
  34. virtual std::string GetCrashHandlerPath(const std::string& lyAppRoot = {}) const;
  35. virtual const char* GetCrashHandlerExecutableName() const;
  36. virtual std::string DetermineAppPath() const;
  37. virtual const char* GetProductName() const { return O3DEProductName; }
  38. virtual bool CreateCrashHandlerDB(const std::string& reportPath) const;
  39. virtual std::string GetCrashSubmissionURL() const { return{}; }
  40. virtual std::string GetCrashSubmissionToken() const { return{}; }
  41. static void AppendSep(std::string& lyAppRoot);
  42. virtual void GetBuildAnnotations(CrashHandlerAnnotations& annotations) const;
  43. virtual void GetUserAnnotations(CrashHandlerAnnotations& ) const {};
  44. // OS Dependent
  45. virtual std::string GetAppRootFromCWD() const;
  46. virtual void GetOSAnnotations(CrashHandlerAnnotations& annotations) const;
  47. const std::string& GetConfigSubmissionToken() const;
  48. private:
  49. void ReadConfigFile();
  50. std::string m_submissionToken;
  51. };
  52. }