lldb/bindings/interface/SBTypeSummary.i

//===-- SWIG Interface for SBTypeSummary---------------------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//

namespace lldb {
    class SBTypeSummaryOptions
    {
    public:
        SBTypeSummaryOptions();

        SBTypeSummaryOptions (const lldb::SBTypeSummaryOptions &rhs);

        ~SBTypeSummaryOptions ();

        bool
        IsValid ();

        explicit operator bool() const;

        lldb::LanguageType
        GetLanguage ();

        lldb::TypeSummaryCapping
        GetCapping ();

        void
        SetLanguage (lldb::LanguageType);

        void
        SetCapping (lldb::TypeSummaryCapping);
    };

    %feature("docstring",
    "Represents a summary that can be associated to one or more types.") SBTypeSummary;

    class SBTypeSummary
    {
    public:

        SBTypeSummary();

        static SBTypeSummary
        CreateWithSummaryString (const char* data, uint32_t options = 0);

        static SBTypeSummary
        CreateWithFunctionName (const char* data, uint32_t options = 0);

        static SBTypeSummary
        CreateWithScriptCode (const char* data, uint32_t options = 0);

        SBTypeSummary (const lldb::SBTypeSummary &rhs);

        ~SBTypeSummary ();

        bool
        IsValid() const;

        explicit operator bool() const;

        bool
        IsEqualTo (lldb::SBTypeSummary &rhs);

        bool
        IsFunctionCode();

        bool
        IsFunctionName();

        bool
        IsSummaryString();

        const char*
        GetData ();

        void
        SetSummaryString (const char* data);

        void
        SetFunctionName (const char* data);

        void
        SetFunctionCode (const char* data);

        uint32_t
        GetOptions ();

        void
        SetOptions (uint32_t);

        bool
        GetDescription (lldb::SBStream &description,
                        lldb::DescriptionLevel description_level);

        bool
        operator == (lldb::SBTypeSummary &rhs);

        bool
        operator != (lldb::SBTypeSummary &rhs);

        STRING_EXTENSION_LEVEL(SBTypeSummary, lldb::eDescriptionLevelBrief)

#ifdef SWIGPYTHON
        %pythoncode %{
            options = property(GetOptions, SetOptions)
            is_summary_string = property(IsSummaryString)
            is_function_name = property(IsFunctionName)
            is_function_name = property(IsFunctionCode)
            summary_data = property(GetData)
        %}
#endif

    };

} // namespace lldb