OsMessageInterceptor.h

Go to the documentation of this file.

/****
 * Sming Framework Project - Open Source framework for high efficiency native ESP8266 development.
 * Created 2015 by Skurydin Alexey
 * http://github.com/SmingHub/Sming
 * All files of the Sming Core are provided under the LGPL v3 license.
 *
 * OsMessageInterceptor.h -  * Support for intercepting OS debug output (calls to os_printf, etc.)
 *
 * author mikee47 <mike@sillyhouse.net> Feb 2019
 *
 * Provided to assist with tracking down the origin of error messages output by SDK.
 * This is usually done in conjunction with the debugger or by performing a stack dump
 * to establish the origin of the problem code.
 *
 * Example usage:
 
    static OsMessageInterceptor osMessageInterceptor;
 
    void handleOsMessage(OsMessage& msg)
    {
        debug_w("[OS] %s", msg.getBuffer());
        if(msg.startsWith("E:M ")) {
            // Handle memory error
        } else if(msg.contains(" assert ")) {
            // Handle 'assert' message
        }
    }
 
    void init()
    {
        ...
 
        osMessageInterceptor.begin(handleOsMessage);
 
        // Example of 'bad' system call, generates "E:M 0" message
        os_malloc(0);
 
        ...
    }
 
 *
 *
 ****/
 
#pragma once
 
#include "Data/Buffer/LineBuffer.h"
 
using OsMessage = LineBuffer<128>;
 
using OsMessageCallback = void (*)(OsMessage& message);
 
class OsMessageInterceptor
{
public:
    ~OsMessageInterceptor()
    {
        end();
    }
 
    void begin(OsMessageCallback callback);
 
    void end();
 
protected:
    void putch(char c);
 
    static void static_putc(char c)
    {
        self->putch(c);
    }
 
private:
    OsMessage message;
    OsMessageCallback callback = nullptr; 
    static OsMessageInterceptor* self;
};