SwiftFormatters.h

//===-- SwiftFormatters.h ---------------------------------------*- C++ -*-===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2016 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//

#ifndef liblldb_SwiftFormatters_h_
#define liblldb_SwiftFormatters_h_

#include "lldb/lldb-forward.h"
#include <stdint.h>

#include "lldb/Utility/ConstString.h"
#include "lldb/DataFormatters/FormatClasses.h"
#include "lldb/DataFormatters/StringPrinter.h"
#include "lldb/Target/Target.h"

#include "FoundationValueTypes.h"
#include "SwiftArray.h"
#include "SwiftBasicTypes.h"
#include "SwiftDictionary.h"
#include "SwiftMetatype.h"
#include "SwiftOptionSet.h"
#include "SwiftOptional.h"
#include "SwiftSet.h"
#include "SwiftUnsafeTypes.h"

namespace lldb_private {
namespace formatters {
namespace swift {
bool Character_SummaryProvider(ValueObject &valobj, Stream &stream,
                               const TypeSummaryOptions &options);

bool UnicodeScalar_SummaryProvider(ValueObject &valobj, Stream &stream,
                                   const TypeSummaryOptions &options);

bool StringGuts_SummaryProvider(ValueObject &valobj, Stream &stream,
                                const TypeSummaryOptions &options);

bool StringGuts_SummaryProvider(
    ValueObject &valobj, Stream &stream, const TypeSummaryOptions &,
    StringPrinter::ReadStringAndDumpToStreamOptions);

bool String_SummaryProvider(ValueObject &valobj, Stream &stream,
                            const TypeSummaryOptions &options);

bool String_SummaryProvider(ValueObject &valobj, Stream &stream,
                            const TypeSummaryOptions &,
                            StringPrinter::ReadStringAndDumpToStreamOptions);

bool Substring_SummaryProvider(ValueObject &, Stream &,
                               const TypeSummaryOptions &);

bool StringIndex_SummaryProvider(ValueObject &valobj, Stream &stream,
                                 const TypeSummaryOptions &options);

bool StaticString_SummaryProvider(ValueObject &valobj, Stream &stream,
                                  const TypeSummaryOptions &options);

bool SwiftSharedString_SummaryProvider(ValueObject &valobj, Stream &stream,
                                       const TypeSummaryOptions &options);
bool SwiftSharedString_SummaryProvider_2(
    ValueObject &valobj, Stream &stream, const TypeSummaryOptions &,
    StringPrinter::ReadStringAndDumpToStreamOptions);

bool SwiftStringStorage_SummaryProvider(ValueObject &valobj, Stream &stream,
                                        const TypeSummaryOptions &);

bool Bool_SummaryProvider(ValueObject &valobj, Stream &stream,
                          const TypeSummaryOptions &options);

bool DarwinBoolean_SummaryProvider(ValueObject &valobj, Stream &stream,
                                   const TypeSummaryOptions &options);

bool Range_SummaryProvider(ValueObject &valobj, Stream &stream,
                           const TypeSummaryOptions &options);

bool CountableRange_SummaryProvider(ValueObject &valobj, Stream &stream,
                                    const TypeSummaryOptions &options);

bool ClosedRange_SummaryProvider(ValueObject &valobj, Stream &stream,
                                 const TypeSummaryOptions &options);

bool CountableClosedRange_SummaryProvider(ValueObject &valobj, Stream &stream,
                                          const TypeSummaryOptions &options);

bool SIMDVector_SummaryProvider(ValueObject &valobj, Stream &stream,
                                const TypeSummaryOptions &options);

bool LegacySIMD_SummaryProvider(ValueObject &valobj, Stream &stream,
                                const TypeSummaryOptions &options);

bool GLKit_SummaryProvider(ValueObject &valobj, Stream &stream,
                           const TypeSummaryOptions &options);

// TODO: this is a transient workaround for the fact that
// ObjC types are totally opaque in Swift for LLDB
bool BuiltinObjC_SummaryProvider(ValueObject &valobj, Stream &stream,
                                 const TypeSummaryOptions &options);

bool ObjC_Selector_SummaryProvider(ValueObject &valobj, Stream &stream,
                                   const TypeSummaryOptions &options);

bool TypePreservingNSNumber_SummaryProvider(ValueObject &valobj, Stream &stream,
                                            const TypeSummaryOptions &options);

bool TaskPriority_SummaryProvider(ValueObject &valobj, Stream &stream,
                                  const TypeSummaryOptions &options);

SyntheticChildrenFrontEnd *EnumSyntheticFrontEndCreator(CXXSyntheticChildren *,
                                                        lldb::ValueObjectSP);

SyntheticChildrenFrontEnd *TaskSyntheticFrontEndCreator(CXXSyntheticChildren *,
                                                        lldb::ValueObjectSP);

SyntheticChildrenFrontEnd *
UnsafeContinuationSyntheticFrontEndCreator(CXXSyntheticChildren *,
                                           lldb::ValueObjectSP);

SyntheticChildrenFrontEnd *
CheckedContinuationSyntheticFrontEndCreator(CXXSyntheticChildren *,
                                            lldb::ValueObjectSP);

SyntheticChildrenFrontEnd *
TaskGroupSyntheticFrontEndCreator(CXXSyntheticChildren *, lldb::ValueObjectSP);
}
}
}

#endif // liblldb_SwiftFormatters_h_