YiCrashHandler.h

Go to the documentation of this file.

#ifndef _YI_CRASH_HANDLER_H_
#define _YI_CRASH_HANDLER_H_

#include "signal/YiSignal.h"
#include "utility/YiRapidJSONUtility.h"
#include "utility/YiString.h"

class CYIRenderingSurfaceInfo;

class CYICrashHandler
{
public:
    class PostData
    {
    public:
        void SetUrl(CYIString postUrl);

        const CYIString &GetUrl() const;

        void AddHeaders(const std::vector<std::pair<CYIString, CYIString>> &headers);

        void AddHeader(const CYIString &name, const CYIString &value);

        void RemoveHeader(const CYIString &name);

        void RemoveAllHeaders();

        const std::vector<std::pair<CYIString, CYIString>> &GetHeaders() const;

    private:
        CYIString m_url;
        std::vector<std::pair<CYIString, CYIString>> m_headers;
    };

    static const CYIStringView s_quotedUnixTimestampMsPlaceholder;

    static void AddAppDataValue(const CYIString &key, const CYIString &value);

    static CYIString GetAppDataValue(const CYIString &key);

    static void ClearAppData();

    static void PreallocateMinidumpFilenameStorage();

    static void ReplacePlaceholderWithMinidumpFilename(CYIStringView filename, CYIString *pJSON);

    static void ReplacePlaceholderWithTimestamp(CYIString *pJSON);

    static void ReplacePlaceholders(CYIStringView minidumpFilename, CYIString *pJSON);

    static const CYIString &GetCrashReport();

    static void ReportFatalError(const CYIString &callStack);

    static CYIString GetCallStack();

    /*
     \details Sets PostData POST request data. \a data is available as #CYICrashHandler::GetCrashReportPostData

     Example usage:
     \code{.cpp}
     auto postData = CYICrashHandler::GetCrashReportPostData();
     postData.SetUrl("www.example.com");
     postData.AddHeader("name", "value");
     CYICrashHandler::SetCrashReportPostData(postData);
     \endcode

     \note Calling this function will trigger #CYICrashHandler::MinidumpPostDataChanged signal after changing the data.
     \sa #CYICrashHandler::GetCrashReportPostData
     */
    static void SetCrashReportPostData(const PostData &data);

    static const PostData &GetCrashReportPostData();

    static void SetMinidumpPostData(const PostData &data);

    static const PostData &GetMinidumpPostData();

    static void SetEngineInformation();

    static void SetDeviceInformation();

    static void UpdateRenderingSurfaceData(const CYIRenderingSurfaceInfo &surface);

    static CYISignal<> CrashReportChanged;

    static CYISignal<> CrashReportPostDataChanged;

    static CYISignal<> MinidumpPostDataChanged;

    static CYISignal<> FatalErrorOccurred;

protected:
    friend class CYICrashHandlerPlatform;

    static const CYIStringView s_quotedUnixTimestampMsForReplacement;

    static constexpr const char *s_pMinidumpFilenameKey = "minidump_filename";
    static void ResetCrashReportForTesting();

private:
    static CYIString s_crashReport;

    static PostData s_crashReportPostData;

    static PostData s_minidumpPostData;

    static void RemoveCrashReportValue(const char *pKey);

    template<typename T>
    static void SetCrashReportValue(const char *pKey, T jsonValue);
};

#endif