include/lldb/API/SBCommandReturnObject.h


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

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

#ifndef LLDB_SBCommandReturnObject_h_
#define LLDB_SBCommandReturnObject_h_

// C Includes
#include <stdio.h>

// C++ Includes
#include <memory>

// Other libraries and framework includes
// Project includes
#include "lldb/API/SBDefines.h"

namespace lldb {

class LLDB_API SBCommandReturnObject
{
public:
    SBCommandReturnObject ();

    SBCommandReturnObject (const lldb::SBCommandReturnObject &rhs);

    ~SBCommandReturnObject ();

    const lldb::SBCommandReturnObject &
    operator = (const lldb::SBCommandReturnObject &rhs);

    SBCommandReturnObject (lldb_private::CommandReturnObject *ptr);
    
    lldb_private::CommandReturnObject *
    Release ();

    bool
    IsValid() const;

    const char *
    GetOutput ();

    const char *
    GetError ();

    size_t
    PutOutput (FILE *fh);

    size_t
    GetOutputSize ();

    size_t
    GetErrorSize ();

    size_t
    PutError (FILE *fh);

    void
    Clear();

    lldb::ReturnStatus
    GetStatus();
    
    void
    SetStatus (lldb::ReturnStatus status);

    bool
    Succeeded ();

    bool
    HasResult ();

    void
    AppendMessage (const char *message);

    void
    AppendWarning (const char *message);
    
    bool
    GetDescription (lldb::SBStream &description);
   
    // deprecated, these two functions do not take
    // ownership of file handle
    void
    SetImmediateOutputFile (FILE *fh);
    
    void
    SetImmediateErrorFile (FILE *fh);
    
    void
    SetImmediateOutputFile (FILE *fh, bool transfer_ownership);
    
    void
    SetImmediateErrorFile (FILE *fh, bool transfer_ownership);
    
    void
    PutCString(const char* string, int len = -1);
    
    size_t
    Printf(const char* format, ...)  __attribute__ ((format (printf, 2, 3)));
    
    const char *
    GetOutput (bool only_if_no_immediate);
    
    const char *
    GetError (bool only_if_no_immediate);
    
    void
    SetError(lldb::SBError &error,
             const char *fallback_error_cstr = nullptr);
    
    void
    SetError (const char* error_cstr);
    
protected:
    friend class SBCommandInterpreter;
    friend class SBOptions;

    lldb_private::CommandReturnObject *
    operator->() const;

    lldb_private::CommandReturnObject *
    get() const;

    lldb_private::CommandReturnObject &
    operator*() const;

    lldb_private::CommandReturnObject &
    ref() const;

    void
    SetLLDBObjectPtr (lldb_private::CommandReturnObject *ptr);

private:
    std::unique_ptr<lldb_private::CommandReturnObject> m_opaque_ap;
};

} // namespace lldb

#endif // LLDB_SBCommandReturnObject_h_