GUIMessageWindow.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2003-2026 German Aerospace Center (DLR) and others.
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0/
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License 2.0 are satisfied: GNU General Public License, version 2
// or later which is available at
// https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
/****************************************************************************/
// A logging window for the gui
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <string>
#include <utils/foxtools/fxheader.h>
#include <utils/gui/events/GUIEvent.h>
#include <utils/gui/windows/GUIMainWindow.h>
#include <utils/iodevices/OutputDevice.h>
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class GUIGlObject;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class GUIMessageWindow : public FXText {
    FXDECLARE(GUIMessageWindow)
public:
    GUIMessageWindow(FXComposite* parent, GUIMainWindow* mainWindow);
 
    ~GUIMessageWindow();
 
    virtual void setCursorPos(FXint pos, FXbool notify = FALSE);
 
    void appendMsg(GUIEventType eType, const std::string& msg);
 
    void addSeparator();
 
    void clear();
 
    void registerMsgHandlers();
 
    void unregisterMsgHandlers();
 
    static void enableLocateLinks(const bool val) {
        myLocateLinks = val;
    }
 
    static bool locateLinksEnabled() {
        return myLocateLinks;
    }
 
    static void setBreakPointOffset(SUMOTime val) {
        myBreakPointOffset = val;
    }
 
    static SUMOTime getBreakPointOffset() {
        return myBreakPointOffset;
    }
 
    long onKeyPress(FXObject* o, FXSelector sel, void* data);
 
    long onRightBtnRelease(FXObject* o, FXSelector sel, void* data);
 
    long onCmdClear(FXObject*, FXSelector, void*);
 
    long onUpdClear(FXObject* sender, FXSelector, void* data);
 
    static FXHiliteStyle* getStyles();
 
protected:
    FOX_CONSTRUCTOR(GUIMessageWindow)
 
private:
    class MsgOutputDevice : public OutputDevice {
 
    public:
        MsgOutputDevice(GUIMessageWindow* msgWindow, GUIEventType type) :
            myMsgWindow(msgWindow),
            myType(type) { }
 
        ~MsgOutputDevice() { }
 
    protected:
        std::ostream& getOStream() {
            return myStream;
        }
        void postWriteHook() {
            myMsgWindow->appendMsg(myType, myStream.str());
            myStream.str("");
        }
 
    private:
        GUIMessageWindow* myMsgWindow;
 
        std::ostringstream myStream;
 
        GUIEventType myType;
    };
 
    static bool findObjectTypeID(const FXString& text, const FXint pos, const FXint lineS, const FXint lineE, std::string& id, std::string& type);
    const GUIGlObject* getActiveStringObject(const FXString& text, const FXint pos, const FXint lineS, const FXint lineE) const;
    bool hasActiveStringObject(const FXString& text, const FXint pos) const;
 
    SUMOTime getTimeString(const FXString& text, const FXint pos) const;
 
    void fillStyles();
 
    GUIMainWindow* myMainWindow;
 
    static bool myLocateLinks;
 
    static SUMOTime myBreakPointOffset;
 
    static FXHiliteStyle* myStyles;
 
    static std::string myTimeText;
 
    static std::map<std::string, std::string> myTypeStrings;
 
    OutputDevice* myErrorRetriever, *myMessageRetriever, *myWarningRetriever;
};