VscDebugAdapter.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
 
/*  VscDebugAdapter.qm Copyright 2013 - 2024 Qore Technologies, s.r.o.
 
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:
 
    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.
 
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
*/
 
// minimum required Qore version
 
 
 
namespace VscDebugAdapter {
class VscDebugLogger : public Logger {
 
public:
        VscDebugAdapter debugAdapter;
 
private:
        bool m_logging = True;
 
public:
 
    constructor(*string filename, bool appendToLog);
 
};
 
class VscLoggerAppender : public LoggerAppenderFile {
 
public:
protected:
        VscDebugLogger logger;
 
public:
 
    constructor(VscDebugLogger logger, string name, string filename) ;
 
 
    processEventImpl(int type, auto params);
 
};
 
 
class VscDebugAdapter : public DebugCommandLine {
 
public:
private:
        const START_LAUNCH = 1;
        const START_ATTACH = 2;
        const START_ATTACH_SUSPENDED = 3;
        const DEBUGVAR_PREFIX = "$";
 
        bool m_running = True;
 
        hash m_initializeArgs;
 
        hash m_programState;
 
        Queue m_queue();
 
        Queue m_outputQueue();
 
        Sequence m_sequence(1);
 
        Sequence m_source(1);
 
        int m_currentPgmId;
 
 
public:
 
        *string defaultProgram;
 
    constructor(*Logger::LoggerInterface logger) ;
 
 
     *hash doCommand(hash data);
 
     nothing pushEvent(auto event);
 
     printfImpl(string fmt, ...);
 
     run();
 
     execute(string cmd);
 
private:
     auto resolveValue(string name, *string val, hash strings, auto defVal);
public:
 
 
private:
     processDebugEvent(hash event);
public:
 
 
private:
     refuseInterrupt(hash event);
public:
 
 
private:
     detach(hash event);
public:
 
 
private:
     hash parseVscRequest(string msg);
public:
 
 
private:
     sendVscMessage(hash msg);
public:
 
 
private:
     sendVscEvent(string event, auto payload);
public:
 
 
private:
     string getLoadedSourceName(string file, *string source);
public:
 
 
private:
     updateProgramCache(*hash response);
public:
 
 
private:
     setThreadFrame(int threadId, int frameId);
public:
 
 
private:
     auto getVariable(int threadId, int frameId, string name);
public:
 
 
private:
     deleteBreakpoints(*hash bkpts);
public:
 
 
private:
     list setBreakpoints(*list bkptRefs);
public:
 
 
private:
     string printValue(auto value, *hash format);
public:
 
 
private:
     auto vscParseValue(string val);
public:
 
 
private:
     hash getModule(softint pgmId);
public:
 
 
private:
     hash getSource(hash ls);
public:
 
 
    // get threads provided to vsc
private:
     list getThreads();
public:
 
 
protected:
     hash<auto> getCommands();
public:
 
 
    // methods implementing commands "public" is needed bacause of hasCallableMethod()
     hash vsc_initialize(hash args);
 
     nothing vsc_launch(hash args);
 
     nothing vsc_attach(hash args);
 
     nothing vsc_configurationDone();
 
     hash vsc_threads();
 
     vsc_pause(hash args);
 
     hash vsc_continue(hash args);
 
     vsc_next(hash args);
 
     vsc_stepIn(hash args);
 
     vsc_stepOut(hash args);
 
     hash vsc_stackTrace(hash args);
 
     hash vsc_exceptionInfo(hash args);
 
     hash vsc_scopes(hash args);
 
     hash vsc_variables(hash args);
 
     hash vsc_setVariable(hash args);
 
     hash vsc_evaluate(hash args);
 
     hash vsc_completions(hash args);
 
     hash vsc_setBreakpoints(hash args);
 
     hash vsc_setFunctionBreakpoints(hash args);
 
     vsc_setExceptionBreakpoints(hash args);
 
     hash vsc_modules(hash args);
 
     hash vsc_loadedSources();
 
     hash vsc_source(hash args);
 
     vsc_disconnect(*hash args);
 
private:
     hash getCapabilities();
public:
 
 
};
};