aboutsummaryrefslogtreecommitdiff
path: root/src/google/protobuf/text_format.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/google/protobuf/text_format.h')
-rw-r--r--src/google/protobuf/text_format.h111
1 files changed, 62 insertions, 49 deletions
diff --git a/src/google/protobuf/text_format.h b/src/google/protobuf/text_format.h
index d6f3e16b..d185bfd9 100644
--- a/src/google/protobuf/text_format.h
+++ b/src/google/protobuf/text_format.h
@@ -47,6 +47,13 @@
#include <google/protobuf/descriptor.h>
#include <google/protobuf/message.h>
#include <google/protobuf/message_lite.h>
+#include <google/protobuf/port.h>
+
+#include <google/protobuf/port_def.inc>
+
+#ifdef SWIG
+#error "You cannot SWIG proto headers"
+#endif
namespace google {
namespace protobuf {
@@ -60,7 +67,7 @@ namespace io {
// of messages.
//
// This class is really a namespace that contains only static methods.
-class LIBPROTOBUF_EXPORT TextFormat {
+class PROTOBUF_EXPORT TextFormat {
public:
// Outputs a textual representation of the given message to the given
// output stream. Returns false if printing fails.
@@ -75,12 +82,12 @@ class LIBPROTOBUF_EXPORT TextFormat {
// Like Print(), but outputs directly to a string.
// Note: output will be cleared prior to printing, and will be left empty
// even if printing fails. Returns false if printing fails.
- static bool PrintToString(const Message& message, string* output);
+ static bool PrintToString(const Message& message, std::string* output);
// Like PrintUnknownFields(), but outputs directly to a string. Returns false
// if printing fails.
static bool PrintUnknownFieldsToString(const UnknownFieldSet& unknown_fields,
- string* output);
+ std::string* output);
// Outputs a textual representation of the value of the field supplied on
// the message supplied. For non-repeated fields, an index of -1 must
@@ -89,9 +96,9 @@ class LIBPROTOBUF_EXPORT TextFormat {
static void PrintFieldValueToString(const Message& message,
const FieldDescriptor* field,
int index,
- string* output);
+ std::string* output);
- class LIBPROTOBUF_EXPORT BaseTextGenerator {
+ class PROTOBUF_EXPORT BaseTextGenerator {
public:
virtual ~BaseTextGenerator();
@@ -101,7 +108,7 @@ class LIBPROTOBUF_EXPORT TextFormat {
// Print text to the output stream.
virtual void Print(const char* text, size_t size) = 0;
- void PrintString(const string& str) { Print(str.data(), str.size()); }
+ void PrintString(const std::string& str) { Print(str.data(), str.size()); }
template <size_t n>
void PrintLiteral(const char (&text)[n]) {
@@ -113,7 +120,7 @@ class LIBPROTOBUF_EXPORT TextFormat {
// string representation.
// You can derive from this FastFieldValuePrinter if you want to have fields
// to be printed in a different way and register it at the Printer.
- class LIBPROTOBUF_EXPORT FastFieldValuePrinter {
+ class PROTOBUF_EXPORT FastFieldValuePrinter {
public:
FastFieldValuePrinter();
virtual ~FastFieldValuePrinter();
@@ -124,11 +131,11 @@ class LIBPROTOBUF_EXPORT TextFormat {
virtual void PrintUInt64(uint64 val, BaseTextGenerator* generator) const;
virtual void PrintFloat(float val, BaseTextGenerator* generator) const;
virtual void PrintDouble(double val, BaseTextGenerator* generator) const;
- virtual void PrintString(const string& val,
+ virtual void PrintString(const std::string& val,
BaseTextGenerator* generator) const;
- virtual void PrintBytes(const string& val,
+ virtual void PrintBytes(const std::string& val,
BaseTextGenerator* generator) const;
- virtual void PrintEnum(int32 val, const string& name,
+ virtual void PrintEnum(int32 val, const std::string& name,
BaseTextGenerator* generator) const;
virtual void PrintFieldName(const Message& message, int field_index,
int field_count, const Reflection* reflection,
@@ -149,29 +156,29 @@ class LIBPROTOBUF_EXPORT TextFormat {
GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(FastFieldValuePrinter);
};
- class LIBPROTOBUF_EXPORT PROTOBUF_RUNTIME_DEPRECATED("Please use FastFieldValuePrinter")
- FieldValuePrinter {
+ class PROTOBUF_EXPORT PROTOBUF_DEPRECATED_MSG(
+ "Please use FastFieldValuePrinter") FieldValuePrinter {
public:
FieldValuePrinter();
virtual ~FieldValuePrinter();
- virtual string PrintBool(bool val) const;
- virtual string PrintInt32(int32 val) const;
- virtual string PrintUInt32(uint32 val) const;
- virtual string PrintInt64(int64 val) const;
- virtual string PrintUInt64(uint64 val) const;
- virtual string PrintFloat(float val) const;
- virtual string PrintDouble(double val) const;
- virtual string PrintString(const string& val) const;
- virtual string PrintBytes(const string& val) const;
- virtual string PrintEnum(int32 val, const string& name) const;
- virtual string PrintFieldName(const Message& message,
+ virtual std::string PrintBool(bool val) const;
+ virtual std::string PrintInt32(int32 val) const;
+ virtual std::string PrintUInt32(uint32 val) const;
+ virtual std::string PrintInt64(int64 val) const;
+ virtual std::string PrintUInt64(uint64 val) const;
+ virtual std::string PrintFloat(float val) const;
+ virtual std::string PrintDouble(double val) const;
+ virtual std::string PrintString(const std::string& val) const;
+ virtual std::string PrintBytes(const std::string& val) const;
+ virtual std::string PrintEnum(int32 val, const std::string& name) const;
+ virtual std::string PrintFieldName(const Message& message,
const Reflection* reflection,
const FieldDescriptor* field) const;
- virtual string PrintMessageStart(const Message& message,
+ virtual std::string PrintMessageStart(const Message& message,
int field_index,
int field_count,
bool single_line_mode) const;
- virtual string PrintMessageEnd(const Message& message,
+ virtual std::string PrintMessageEnd(const Message& message,
int field_index,
int field_count,
bool single_line_mode) const;
@@ -181,7 +188,7 @@ class LIBPROTOBUF_EXPORT TextFormat {
GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(FieldValuePrinter);
};
- class LIBPROTOBUF_EXPORT MessagePrinter {
+ class PROTOBUF_EXPORT MessagePrinter {
public:
MessagePrinter() {}
virtual ~MessagePrinter() {}
@@ -194,7 +201,7 @@ class LIBPROTOBUF_EXPORT TextFormat {
// Interface that Printers or Parsers can use to find extensions, or types
// referenced in Any messages.
- class LIBPROTOBUF_EXPORT Finder {
+ class PROTOBUF_EXPORT Finder {
public:
virtual ~Finder();
@@ -203,7 +210,7 @@ class LIBPROTOBUF_EXPORT TextFormat {
// The base implementation uses the extensions already known by the message.
virtual const FieldDescriptor* FindExtension(
Message* message,
- const string& name) const;
+ const std::string& name) const;
// Find the message type for an Any proto.
// Returns NULL if no message is known for this name.
@@ -211,13 +218,13 @@ class LIBPROTOBUF_EXPORT TextFormat {
// type.googleapis.com/, and searches the DescriptorPool of the parent
// message.
virtual const Descriptor* FindAnyType(const Message& message,
- const string& prefix,
- const string& name) const;
+ const std::string& prefix,
+ const std::string& name) const;
};
// Class for those users which require more fine-grained control over how
// a protobuffer message is printed out.
- class LIBPROTOBUF_EXPORT Printer {
+ class PROTOBUF_EXPORT Printer {
public:
Printer();
~Printer();
@@ -228,15 +235,15 @@ class LIBPROTOBUF_EXPORT TextFormat {
bool PrintUnknownFields(const UnknownFieldSet& unknown_fields,
io::ZeroCopyOutputStream* output) const;
// Like TextFormat::PrintToString
- bool PrintToString(const Message& message, string* output) const;
+ bool PrintToString(const Message& message, std::string* output) const;
// Like TextFormat::PrintUnknownFieldsToString
bool PrintUnknownFieldsToString(const UnknownFieldSet& unknown_fields,
- string* output) const;
+ std::string* output) const;
// Like TextFormat::PrintFieldValueToString
void PrintFieldValueToString(const Message& message,
const FieldDescriptor* field,
int index,
- string* output) const;
+ std::string* output) const;
// Adjust the initial indent level of all output. Each indent level is
// equal to two spaces.
@@ -313,9 +320,7 @@ class LIBPROTOBUF_EXPORT TextFormat {
}
// Set how parser finds message for Any payloads.
- void SetFinder(Finder* finder) {
- finder_ = finder;
- }
+ void SetFinder(const Finder* finder) { finder_ = finder; }
// If non-zero, we truncate all string fields that are longer than this
// threshold. This is useful when the proto message has very long strings,
@@ -432,18 +437,18 @@ class LIBPROTOBUF_EXPORT TextFormat {
// google::protobuf::MessageLite::ParseFromString().
static bool Parse(io::ZeroCopyInputStream* input, Message* output);
// Like Parse(), but reads directly from a string.
- static bool ParseFromString(const string& input, Message* output);
+ static bool ParseFromString(const std::string& input, Message* output);
// Like Parse(), but the data is merged into the given message, as if
// using Message::MergeFrom().
static bool Merge(io::ZeroCopyInputStream* input, Message* output);
// Like Merge(), but reads directly from a string.
- static bool MergeFromString(const string& input, Message* output);
+ static bool MergeFromString(const std::string& input, Message* output);
// Parse the given text as a single field value and store it into the
// given field of the given message. If the field is a repeated field,
// the new value will be added to the end
- static bool ParseFieldValueFromString(const string& input,
+ static bool ParseFieldValueFromString(const std::string& input,
const FieldDescriptor* field,
Message* message);
@@ -459,7 +464,7 @@ class LIBPROTOBUF_EXPORT TextFormat {
// Data structure which is populated with the locations of each field
// value parsed from the text.
- class LIBPROTOBUF_EXPORT ParseInfoTree {
+ class PROTOBUF_EXPORT ParseInfoTree {
public:
ParseInfoTree();
~ParseInfoTree();
@@ -501,7 +506,7 @@ class LIBPROTOBUF_EXPORT TextFormat {
};
// For more control over parsing, use this class.
- class LIBPROTOBUF_EXPORT Parser {
+ class PROTOBUF_EXPORT Parser {
public:
Parser();
~Parser();
@@ -509,11 +514,11 @@ class LIBPROTOBUF_EXPORT TextFormat {
// Like TextFormat::Parse().
bool Parse(io::ZeroCopyInputStream* input, Message* output);
// Like TextFormat::ParseFromString().
- bool ParseFromString(const string& input, Message* output);
+ bool ParseFromString(const std::string& input, Message* output);
// Like TextFormat::Merge().
bool Merge(io::ZeroCopyInputStream* input, Message* output);
// Like TextFormat::MergeFromString().
- bool MergeFromString(const string& input, Message* output);
+ bool MergeFromString(const std::string& input, Message* output);
// Set where to report parse errors. If NULL (the default), errors will
// be printed to stderr.
@@ -524,9 +529,7 @@ class LIBPROTOBUF_EXPORT TextFormat {
// Set how parser finds extensions. If NULL (the default), the
// parser will use the standard Reflection object associated with
// the message being parsed.
- void SetFinder(Finder* finder) {
- finder_ = finder;
- }
+ void SetFinder(const Finder* finder) { finder_ = finder; }
// Sets where location information about the parse will be written. If NULL
// (the default), then no location will be written.
@@ -549,10 +552,17 @@ class LIBPROTOBUF_EXPORT TextFormat {
}
// Like TextFormat::ParseFieldValueFromString
- bool ParseFieldValueFromString(const string& input,
+ bool ParseFieldValueFromString(const std::string& input,
const FieldDescriptor* field,
Message* output);
+ // When an unknown extension is met, parsing will fail if this option is set
+ // to false (the default). If true, unknown extensions will be ignored and
+ // a warning message will be generated.
+ void AllowUnknownExtension(bool allow) {
+ allow_unknown_extension_ = allow;
+ }
+
void AllowFieldNumber(bool allow) {
allow_field_number_ = allow;
@@ -575,6 +585,7 @@ class LIBPROTOBUF_EXPORT TextFormat {
bool allow_partial_;
bool allow_case_insensitive_field_;
bool allow_unknown_field_;
+ bool allow_unknown_extension_;
bool allow_unknown_enum_;
bool allow_field_number_;
bool allow_relaxed_whitespace_;
@@ -609,6 +620,8 @@ inline TextFormat::ParseInfoTree* TextFormat::CreateNested(
}
} // namespace protobuf
-
} // namespace google
+
+#include <google/protobuf/port_undef.inc>
+
#endif // GOOGLE_PROTOBUF_TEXT_FORMAT_H__
generated by cgit v1.2.3 (git 2.39.1) at 2024-04-29 17:07:26 +0000