third_party/llvm-project/lldb/scripts/interface/SBCommandReturnObject.i

//===-- SWIG Interface for SBCommandReturnObject ----------------*- C++ -*-===//
//
//                     The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//

namespace lldb {

%feature("docstring",
"Represents a container which holds the result from command execution.
It works with SBCommandInterpreter.HandleCommand() to encapsulate the result
of command execution.

See SBCommandInterpreter for example usage of SBCommandReturnObject."
) SBCommandReturnObject;
class SBCommandReturnObject
{
public:

    SBCommandReturnObject ();

    SBCommandReturnObject (const lldb::SBCommandReturnObject &rhs);

    ~SBCommandReturnObject ();

    bool
    IsValid() const;

    const char *
    GetOutput ();

    const char *
    GetError ();

    size_t
    GetOutputSize ();

    size_t
    GetErrorSize ();

    const char *
    GetOutput (bool only_if_no_immediate);
    
    const char *
    GetError (bool if_no_immediate);
    
    size_t
    PutOutput (FILE *fh);
    
    size_t
    PutError (FILE *fh);

    void
    Clear();

    void
    SetStatus (lldb::ReturnStatus status);
    
    void
    SetError (lldb::SBError &error,
              const char *fallback_error_cstr = NULL);
    
    void
    SetError (const char *error_cstr);

    lldb::ReturnStatus
    GetStatus();

    bool
    Succeeded ();

    bool
    HasResult ();

    void
    AppendMessage (const char *message);

    void
    AppendWarning (const char *message);

    bool
    GetDescription (lldb::SBStream &description);
    

    // wrapping here so that lldb takes ownership of the 
    // new FILE* created inside of the swig interface
    %extend {
        void SetImmediateOutputFile(FILE *fh) {
            self->SetImmediateOutputFile(fh, true);
        }
        void SetImmediateErrorFile(FILE *fh) {
            self->SetImmediateErrorFile(fh, true);
        }
    }

	void
	PutCString(const char* string, int len);

    // wrapping the variadic Printf() with a plain Print()
    // because it is hard to support varargs in SWIG bridgings
    %extend {
        void Print (const char* str)
        {
            self->Printf("%s", str);
        }
    }

};

} // namespace lldb