DebugCmdLine.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
 
/*  DebugCmdLine.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 DebugCmdLine {
 
class WrapperGetOpt : public GetOpt {
 
public:
        constructor(hash options) ;
 
 
 
         split(list<string> args, reference<list<string>> wrp_args, reference<*string> pgm_name, reference<list<string>> pgm_args);
    };
 
class DebugCommandLine : public AbstractDebugControl {
 
public:
            hash cx;
            const defaultIndent = "  ";
 
protected:
            const fcHelp = 0x01;
            const fcExpandUniqueCmd = 0x02;
            const fcValidate = 0x04;
            const fcFallback = 0x08;
            *string historyFileName;
 
            Qore::Thread::RWLock rwlContext();
 
public:
 
        constructor(*LoggerInterface logger) ;
 
 
protected:
         hash<auto> getCommands();
public:
 
 
        // to implement print to terminal
        abstract  printfImpl(string fmt, ...);
 
        abstract  *hash doCommandImpl(hash data);
         *hash doCommand(hash data, bool print);
 
         showFileNames(*hash<auto> fn);
 
         showPrograms(hash ph, bool show_interrupted);
 
         string formatBreakpoint(hash b);
 
         string formatStatement(hash stmt);
 
         showBreakpoints(*list bkpts);
 
         string getThreadStackStr(hash lh);
 
         showThreadStack(softint tid, list stack);
 
        // src keys: code, [startLine], [currentLine]
         *string formatSource(*hash src);
         processGetSource(string type, list path, list args);
 
           static validateInt(DebugCommandLine dcl, softlist path, softlist val);
 
         auto parseValue();
 
         auto getContextValue(string key);
 
         setContextValue(string key, auto value);
 
         hash getStatementValue(list args);
 
protected:
         hash splitCmd(string line);
public:
 
 
protected:
         string escapeArg(softstring s);
public:
 
 
         string listVariantCmds(hash v);
 
         *hash findCmd(list args, int opts = 0, *reference<int> last_param) {  /*  because it is needed from closure */            hash result;
            result.path = ();
            hash<auto> c = getCommands();
            last_param = 0;
            while (args);
 
            result.args = args;
            return result;
        }
 
         list getLineCompletions(string line);
 
         bool processCmdLine(string line);
protected:
         bool isOneLineArray(list x);
public:
 
 
         printVar(string name, hash value);
 
         printHuman(hash x, string indent = defaultIndent);
 
         printHuman(list x, string indent = defaultIndent);
 
         printHuman(string x, string indent = defaultIndent);
         printHuman(any x, string indent = defaultIndent);
 
         printData(auto data);
 
         int checkProgramId();
 
         int checkThreadId();
 
           static softlist enumBreakpointId(DebugCommandLine dcl, softlist path, softlist args);
 
         loadSession(*string fn);
 
         init(hash opt);
 
    };
};