Files
react-native/ReactCommon/fabric/debug/DebugStringConvertible.h
Valentin Shergin cabc9d1ab3 Fabric: toString methods were moved into DebugStringConvertible with an implementation in .cpp file
Summary:
They need to be in DebugStringConvertible because it depends on they (and because `debugStringConvertibleUtils` depends on `DebugStringConvertible`).
We also moved they implementation to cpp file to avoid leaking Folly's features to consumer namespace.

Reviewed By: mdvacca

Differential Revision: D14715080

fbshipit-source-id: 7277e17b39a14a2d7ba7e5a9b44a70178feb1045
2019-04-04 12:38:21 -07:00

99 lines
2.9 KiB
C++

/**
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/
#pragma once
#include <climits>
#include <memory>
#include <string>
#include <vector>
namespace facebook {
namespace react {
#ifndef NDEBUG
#define RN_DEBUG_STRING_CONVERTIBLE 1
#endif
#if RN_DEBUG_STRING_CONVERTIBLE
class DebugStringConvertible;
using SharedDebugStringConvertible =
std::shared_ptr<const DebugStringConvertible>;
using SharedDebugStringConvertibleList =
std::vector<SharedDebugStringConvertible>;
struct DebugStringConvertibleOptions {
bool format{true};
int depth{0};
int maximumDepth{INT_MAX};
};
// Abstract class describes conformance to DebugStringConvertible concept
// and implements basic recursive debug string assembly algorithm.
// Use this as a base class for providing a debugging textual representation
// of your class.
class DebugStringConvertible {
public:
virtual ~DebugStringConvertible() = default;
// Returns a name of the object.
// Default implementation returns "Node".
virtual std::string getDebugName() const;
// Returns a value assosiate with the object.
// Default implementation returns an empty string.
virtual std::string getDebugValue() const;
// Returns a list of `DebugStringConvertible` objects which can be considered
// as *children* of the object.
// Default implementation returns an empty list.
virtual SharedDebugStringConvertibleList getDebugChildren() const;
// Returns a list of `DebugStringConvertible` objects which can be considered
// as *properties* of the object.
// Default implementation returns an empty list.
virtual SharedDebugStringConvertibleList getDebugProps() const;
// Returns a string which represents the object in a human-readable way.
// Default implementation returns a description of the subtree
// rooted at this node, represented in XML-like format.
virtual std::string getDebugDescription(
DebugStringConvertibleOptions options = {}) const;
// Do same as `getDebugDescription` but return only *children* and
// *properties* parts (which are used in `getDebugDescription`).
virtual std::string getDebugPropsDescription(
DebugStringConvertibleOptions options = {}) const;
virtual std::string getDebugChildrenDescription(
DebugStringConvertibleOptions options = {}) const;
};
#else
class DebugStringConvertible {};
#endif
#if RN_DEBUG_STRING_CONVERTIBLE
/*
* Set of particular-format-opinionated functions that convert base types to `std::string`; practically incapsulate `folly:to<>` and `folly::format`.
*/
std::string toString(std::string const &value);
std::string toString(int const &value);
std::string toString(bool const &value);
std::string toString(float const &value);
std::string toString(double const &value);
std::string toString(void const *value);
#endif
} // namespace react
} // namespace facebook