GUIMessageWindow.cpp

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
/****************************************************************************/
#include <config.h>
 
#include <cassert>
#include <utils/common/MsgHandler.h>
#include <utils/gui/globjects/GUIGlObjectStorage.h>
#include <utils/gui/windows/GUIGlChildWindow.h>
#include <utils/gui/windows/GUIMainWindow.h>
#include <utils/gui/windows/GUIAppEnum.h>
#include <utils/gui/div/GUIDesigns.h>
#include <utils/gui/div/GUIGlobalSelection.h>
#include <utils/gui/images/GUIIconSubSys.h>
#include <fxkeys.h>
#include "GUIMessageWindow.h"
 
 
// ===========================================================================
// static members
// ===========================================================================
 
bool GUIMessageWindow::myLocateLinks = true;
SUMOTime GUIMessageWindow::myBreakPointOffset = TIME2STEPS(-5);
FXHiliteStyle* GUIMessageWindow::myStyles = new FXHiliteStyle[8];
std::string GUIMessageWindow::myTimeText;
std::map<std::string, std::string> GUIMessageWindow::myTypeStrings;
 
// ===========================================================================
// FOX callback mapping
// ===========================================================================
 
FXDEFMAP(GUIMessageWindow) GUIMessageWindowMap[] = {
    FXMAPFUNC(SEL_KEYPRESS,           0,                      GUIMessageWindow::onKeyPress),
    FXMAPFUNC(SEL_RIGHTBUTTONRELEASE, 0,                      GUIMessageWindow::onRightBtnRelease),
    FXMAPFUNC(SEL_COMMAND,            MID_CLEARMESSAGEWINDOW, GUIMessageWindow::onCmdClear),
    FXMAPFUNC(SEL_UPDATE,             MID_CLEARMESSAGEWINDOW, GUIMessageWindow::onUpdClear),
};
 
FXIMPLEMENT_ABSTRACT(GUIMessageWindow, FXText, GUIMessageWindowMap, ARRAYNUMBER(GUIMessageWindowMap))
 
// ===========================================================================
// method definitions
// ===========================================================================
GUIMessageWindow::GUIMessageWindow(FXComposite* parent, GUIMainWindow* mainWindow) :
    FXText(parent, nullptr, 0, 0, 0, 0, 0, 50),
    myMainWindow(mainWindow),
    myErrorRetriever(nullptr),
    myMessageRetriever(nullptr),
    myWarningRetriever(nullptr) {
    setStyled(true);
    setEditable(false);
    // fill styles
    fillStyles();
    // set styles
    setHiliteStyles(myStyles);
    myTimeText = TL(" time");
    // see GUIGlObject.cpp
    myTypeStrings[StringUtils::to_lower_case(TL("edge"))] = "edge";
    myTypeStrings[StringUtils::to_lower_case(TL("lane"))] = "lane";
    myTypeStrings[StringUtils::to_lower_case(TL("junction"))] = "junction";
    myTypeStrings[StringUtils::to_lower_case(TL("vehicle"))] = "vehicle";
    myTypeStrings[StringUtils::to_lower_case(TL("person"))] = "person";
    myTypeStrings[StringUtils::to_lower_case(TL("tlLogic"))] = "tlLogic";
    myTypeStrings[StringUtils::to_lower_case(TL("busStop"))] = "busStop";
    myTypeStrings[StringUtils::to_lower_case(TL("trainStop"))] = "busStop";
    myTypeStrings[StringUtils::to_lower_case(TL("containerStop"))] = "containerStop";
    myTypeStrings[StringUtils::to_lower_case(TL("chargingStation"))] = "chargingStation";
    myTypeStrings[StringUtils::to_lower_case(TL("overheadWireSegment"))] = "overheadWireSegment";
    myTypeStrings[StringUtils::to_lower_case(TL("parkingArea"))] = "parkingArea";
}
 
 
GUIMessageWindow::~GUIMessageWindow() {
    delete[] myStyles;
    delete myMessageRetriever;
    delete myErrorRetriever;
    delete myWarningRetriever;
}
 
 
bool
GUIMessageWindow::findObjectTypeID(const FXString& text, const FXint pos, const FXint lineS, const FXint lineE, std::string& id, std::string& type) {
    const FXint idS = MAX2(text.rfind(" '", pos), text.rfind("='", pos));
    const FXint idE = text.find("'", pos);
    if (idS >= 0 && idE >= 0 && idS >= lineS && idE <= lineE) {
        FXint typeS = text.rfind(" ", idS - 1);
        if (typeS >= 0) {
            if (text.at(typeS + 1) == '(') {
                typeS++;
            }
            type = std::string(text.mid(typeS + 1, idS - typeS - 1).lower().text());
            const auto& tsIt = myTypeStrings.find(type);
            if (tsIt != myTypeStrings.end()) {
                type = tsIt->second;
            }
            id = std::string(text.mid(idS + 2, idE - idS - 2).text());
            return true;
        }
    }
    return false;
}
 
 
const GUIGlObject*
GUIMessageWindow::getActiveStringObject(const FXString& text, const FXint pos, const FXint lineS, const FXint lineE) const {
    std::string id, type;
    if (findObjectTypeID(text, pos, lineS, lineE, id, type)) {
        const std::string typedID = type + ":" + id;
        const GUIGlObject* o = GUIGlObjectStorage::gIDStorage.getObjectBlocking(typedID);
        //std::cout << " getActiveStringObject '" << typedID << "' o=" << (o == nullptr ? "NULL" : o->getMicrosimID()) << "\n";
        return o;
    }
    return nullptr;
}
 
 
bool
GUIMessageWindow::hasActiveStringObject(const FXString& text, const FXint pos) const {
    std::string id, type;
    if (findObjectTypeID(text, pos, 0, text.length(), id, type)) {
        const std::string typedID = type + ":" + id;
        const GUIGlObject* o = GUIGlObjectStorage::gIDStorage.getObjectBlocking(typedID);
        if (o != nullptr) {
            GUIGlObjectStorage::gIDStorage.unblockObject(o->getGlID());
            return true;
        } else if (type == "junction") {
            // some messages may occur before junction GUIGlObjects are built
            return true;
        }
    }
    return false;
}
 
 
SUMOTime
GUIMessageWindow::getTimeString(const FXString& text, const FXint pos) const {
    const FXint end = text.find_first_of(" ,", pos + 1);
    std::string time;
    if (end >= 0) {
        time = text.mid(pos, end - pos).text();
    } else {
        time = text.mid(pos, text.length() - pos).text();
        if (time.empty()) {
            return -1;
        }
        if (time.back() == '\n') {
            time.pop_back();
        }
        if (time.empty()) {
            return -1;
        }
        if (time.back() == '.') {
            time.pop_back();
        }
    }
    if (time.empty()) {
        return -1;
    }
    if (time.front() == ' ') {
        time = time.substr(1);
    }
    //std::cout << "text='" << text.text() << "' pos=" << pos << " time='" << time << "'\n";
    try {
        //std::cout << "  SUMOTime=" << string2time(time) << "\n";
        return string2time(time);
    } catch (...) {
        return -1;
    }
}
 
 
void
GUIMessageWindow::setCursorPos(FXint pos, FXbool notify) {
    FXText::setCursorPos(pos, notify);
    if (myLocateLinks) {
        std::vector<std::string> viewIDs = myMainWindow->getViewIDs();
        if (viewIDs.empty()) {
            return;
        }
        GUIGlChildWindow* const child = myMainWindow->getViewByID(viewIDs[0]);
        const FXString text = getText();
        const GUIGlObject* const glObj = getActiveStringObject(text, pos, lineStart(pos), lineEnd(pos));
        if (glObj != nullptr) {
            child->setView(glObj->getGlID());
            GUIGlObjectStorage::gIDStorage.unblockObject(glObj->getGlID());
            if (getApp()->getKeyState(KEY_Control_L)) {
                gSelected.toggleSelection(glObj->getGlID());
            }
        } else if (gSimulation) {
            const int lookback = MIN2(pos, 20);
            const int start = MAX2(lineStart(pos), pos - lookback);
            const FXString candidate = text.mid(start, lineEnd(pos) - start);
            FXint timePos = candidate.find(myTimeText.c_str());
            if (timePos > -1) {
                timePos += (int)myTimeText.size() + 1;
                if (pos >= 0 && pos > start + timePos) {
                    const SUMOTime t = getTimeString(candidate, timePos);
                    if (t >= 0) {
                        myMainWindow->addBreakpoint(t + myBreakPointOffset);
                    }
                }
            }
        }
    }
}
 
 
void
GUIMessageWindow::appendMsg(GUIEventType eType, const std::string& msg) {
    if (!isEnabled()) {
        show();
    }
    // build the styled message
    FXint style = 1;
    switch (eType) {
        case GUIEventType::DEBUG_OCCURRED:
            // color: blue
            style = 0;
            break;
        case GUIEventType::GLDEBUG_OCCURRED:
            // color: fuchsia
            style = 7;
            break;
        case GUIEventType::ERROR_OCCURRED:
            // color: red
            style = 2;
            break;
        case GUIEventType::WARNING_OCCURRED:
            // color: yellow
            style = 3;
            break;
        case GUIEventType::MESSAGE_OCCURRED:
            // color: green
            style = 1;
            break;
        default:
            assert(false);
    }
    FXString text(msg.c_str());
    if (myLocateLinks) {
        FXint pos = text.find("'");
        while (pos >= 0) {
            if (hasActiveStringObject(text, pos + 1)) {
                FXString insText = text.left(pos + 1);
                FXText::appendStyledText(insText, style + 1);
                text.erase(0, pos + 1);
                pos = text.find("'");
                insText = text.left(pos);
                FXText::appendStyledText(insText, style + 4);
                text.erase(0, pos);
            }
            pos = text.find("'", pos + 1);
        }
        // find time links
        pos = text.find(myTimeText.c_str());
        const int timeTerm = (int)myTimeText.size() + 1;
        SUMOTime t = -1;
        if (pos >= 0) {
            t = getTimeString(text, pos + timeTerm);
        }
        if (t >= 0) {
            FXString insText = text.left(pos + timeTerm);
            FXText::appendStyledText(insText, style + 1);
            text.erase(0, pos + timeTerm);
            pos = text.find(" ");
            if (pos < 0) {
                pos = text.rfind(".");
            }
            insText = text.left(pos);
            FXText::appendStyledText(insText, style + 4);
            text.erase(0, pos);
        }
    }
    // insert rest of the message
    FXText::appendStyledText(text, style + 1, true);
    FXText::setCursorPos(getLength() - 1);
    FXText::setBottomLine(getLength() - 1);
    if (isEnabled()) {
        layout();
        update();
    }
}
 
 
void
GUIMessageWindow::addSeparator() {
    std::string msg = std::string(100, '-') + "\n";
    FXText::appendStyledText(msg.c_str(), (FXint) msg.length(), 1, true);
    FXText::setCursorPos(getLength() - 1);
    FXText::setBottomLine(getLength() - 1);
    if (isEnabled()) {
        layout();
        update();
    }
}
 
 
void
GUIMessageWindow::clear() {
    if (getLength() == 0) {
        return;
    }
    FXText::removeText(0, getLength(), true);
    if (isEnabled()) {
        layout();
        update();
    }
}
 
 
void
GUIMessageWindow::registerMsgHandlers() {
    if (myMessageRetriever == nullptr) {
        // initialize only if registration is requested
        myMessageRetriever = new MsgOutputDevice(this, GUIEventType::MESSAGE_OCCURRED);
        myErrorRetriever = new MsgOutputDevice(this, GUIEventType::ERROR_OCCURRED);
        myWarningRetriever = new MsgOutputDevice(this, GUIEventType::WARNING_OCCURRED);
    }
    MsgHandler::getMessageInstance()->addRetriever(myMessageRetriever);
    MsgHandler::getErrorInstance()->addRetriever(myErrorRetriever);
    MsgHandler::getWarningInstance()->addRetriever(myWarningRetriever);
}
 
 
void
GUIMessageWindow::unregisterMsgHandlers() {
    MsgHandler::getMessageInstance()->removeRetriever(myMessageRetriever);
    MsgHandler::getErrorInstance()->removeRetriever(myErrorRetriever);
    MsgHandler::getWarningInstance()->removeRetriever(myWarningRetriever);
}
 
 
long
GUIMessageWindow::onKeyPress(FXObject* o, FXSelector sel, void* ptr) {
    FXEvent* e = (FXEvent*) ptr;
    // permit ctrl+a, ctrl+c
    if (e->state & CONTROLMASK) {
        return FXText::onKeyPress(o, sel, ptr);
    }
    return 0;
}
 
 
long
GUIMessageWindow::onRightBtnRelease(FXObject* o, FXSelector sel, void* ptr) {
    FXText::onRightBtnRelease(o, sel, ptr);
    if (!isEnabled()) {
        return 0;
    }
    FXEvent* event = (FXEvent*)ptr;
    if (event->moved) {
        return 1;
    }
    setFocus();
    FXMenuPane contextMenu(this);
    FXMenuCommand* copyCmd = GUIDesigns::buildFXMenuCommandShortcut(&contextMenu, TL("Copy"), "Ctrl+C", TL("Copy selection to clipboard"),
                             GUIIconSubSys::getIcon(GUIIcon::COPY), this, FXText::ID_COPY_SEL);
    FXMenuCommand* selAllCmd = GUIDesigns::buildFXMenuCommandShortcut(&contextMenu, TL("Select all"), "Ctrl+A", TL("Select all text"),
                               nullptr, this, FXText::ID_SELECT_ALL);
    if (getSelStartPos() >= getSelEndPos()) {
        copyCmd->disable();
    }
    if (getLength() == 0) {
        selAllCmd->disable();
    }
    new FXMenuSeparator(&contextMenu);
    FXMenuCommand* clearCmd = GUIDesigns::buildFXMenuCommand(&contextMenu, TL("Clear"), TL("Clear message window"),
                              GUIIconSubSys::getIcon(GUIIcon::CLEARMESSAGEWINDOW), this, MID_CLEARMESSAGEWINDOW);
    if (getLength() == 0) {
        clearCmd->disable();
    }
    contextMenu.create();
    contextMenu.popup(nullptr, event->root_x, event->root_y);
    getApp()->runModalWhileShown(&contextMenu);
    return 1;
}
 
 
long
GUIMessageWindow::onCmdClear(FXObject*, FXSelector, void*) {
    clear();
    return 1;
}
 
 
long
GUIMessageWindow::onUpdClear(FXObject* sender, FXSelector, void* ptr) {
    sender->handle(this, getLength() > 0 ? FXSEL(SEL_COMMAND, ID_ENABLE) : FXSEL(SEL_COMMAND, ID_DISABLE), ptr);
    return 1;
}
 
 
FXHiliteStyle*
GUIMessageWindow::getStyles() {
    return myStyles;
}
 
 
void
GUIMessageWindow::fillStyles() {
    const FXColor white   = FXRGB(0xff, 0xff, 0xff);
    const FXColor blue    = FXRGB(0x00, 0x00, 0x88);
    const FXColor green   = FXRGB(0x00, 0x88, 0x00);
    const FXColor red     = FXRGB(0x88, 0x00, 0x00);
    const FXColor yellow  = FXRGB(0xe6, 0x98, 0x00);
    const FXColor fuchsia = FXRGB(0x88, 0x00, 0x88);
    // set separator style
    myStyles[0].normalForeColor = blue;
    myStyles[0].normalBackColor = white;
    myStyles[0].selectForeColor = white;
    myStyles[0].selectBackColor = blue;
    myStyles[0].hiliteForeColor = blue;
    myStyles[0].hiliteBackColor = white;
    myStyles[0].activeBackColor = white;
    myStyles[0].style = 0;
    // set message text style
    myStyles[1] = myStyles[0];
    myStyles[1].normalForeColor = green;
    myStyles[1].selectBackColor = green;
    myStyles[1].hiliteForeColor = green;
    myStyles[4] = myStyles[1];
    myStyles[4].style = STYLE_UNDERLINE;
    // set error text style
    myStyles[2] = myStyles[0];
    myStyles[2].normalForeColor = red;
    myStyles[2].selectBackColor = red;
    myStyles[2].hiliteForeColor = red;
    myStyles[5] = myStyles[2];
    myStyles[5].style = STYLE_UNDERLINE;
    // set warning text style
    myStyles[3] = myStyles[0];
    myStyles[3].normalForeColor = yellow;
    myStyles[3].selectBackColor = yellow;
    myStyles[3].hiliteForeColor = yellow;
    myStyles[6] = myStyles[3];
    myStyles[6].style = STYLE_UNDERLINE;
    // set GLDebug text style
    myStyles[7] = myStyles[0];
    myStyles[7].normalForeColor = fuchsia;
    myStyles[7].selectBackColor = fuchsia;
    myStyles[7].hiliteForeColor = fuchsia;
}
 
/****************************************************************************/