blob: c2082f983f337d5f50171e9a5de0a8e0ef2618c5 [file] [log] [blame]
/*
* Copyright (C) 2019 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef SRC_TRACE_PROCESSOR_UTIL_PROTOZERO_TO_TEXT_H_
#define SRC_TRACE_PROCESSOR_UTIL_PROTOZERO_TO_TEXT_H_
#include <string>
#include "perfetto/protozero/field.h"
namespace perfetto {
namespace trace_processor {
class DescriptorPool;
namespace protozero_to_text {
enum NewLinesMode {
kIncludeNewLines = 0,
kSkipNewLines,
};
// Given a protozero message |protobytes| which is of fully qualified name
// |type| within TrackEvent proto messages, we will convert this into a text
// proto format string.
//
// DebugTrackEventProtozeroToText will use new lines between fields, and
// ShortDebugTrackEventProtozeroToText will use only a single space.
std::string DebugTrackEventProtozeroToText(const std::string& type,
protozero::ConstBytes protobytes);
std::string ShortDebugTrackEventProtozeroToText(
const std::string& type,
protozero::ConstBytes protobytes);
// Given a protozero message |protobytes| which is of fully qualified name
// |type|, convert this into a text proto format string. All types used in
// message definition of |type| must be available in |pool|. If
// |new_lines_modes| == kIncludeNewLines, new lines will be used between fields,
// otherwise only a space will be used.
std::string ProtozeroToText(const DescriptorPool& pool,
const std::string& type,
protozero::ConstBytes protobytes,
NewLinesMode new_lines_mode);
std::string ProtozeroToText(const DescriptorPool& pool,
const std::string& type,
const std::vector<uint8_t>& protobytes,
NewLinesMode new_lines_mode);
// Allow the conversion from a protozero enum to a string. The template is just
// to allow easy enum passing since we will do the explicit cast to a int32_t
// for the user.
std::string ProtozeroEnumToText(const std::string& type, int32_t enum_value);
template <typename Enum>
std::string ProtozeroEnumToText(const std::string& type, Enum enum_value) {
return ProtozeroEnumToText(type, static_cast<int32_t>(enum_value));
}
std::string BytesToHexEncodedStringForTesting(const std::string&);
} // namespace protozero_to_text
} // namespace trace_processor
} // namespace perfetto
#endif // SRC_TRACE_PROCESSOR_UTIL_PROTOZERO_TO_TEXT_H_