| Index: third_party/protobuf/python/google/protobuf/pyext/message.h
|
| diff --git a/third_party/protobuf/python/google/protobuf/pyext/message.h b/third_party/protobuf/python/google/protobuf/pyext/message.h
|
| new file mode 100644
|
| index 0000000000000000000000000000000000000000..cc0012e95e86d4cb415fb9d7b1381a38f14cff80
|
| --- /dev/null
|
| +++ b/third_party/protobuf/python/google/protobuf/pyext/message.h
|
| @@ -0,0 +1,330 @@
|
| +// Protocol Buffers - Google's data interchange format
|
| +// Copyright 2008 Google Inc. All rights reserved.
|
| +// https://developers.google.com/protocol-buffers/
|
| +//
|
| +// Redistribution and use in source and binary forms, with or without
|
| +// modification, are permitted provided that the following conditions are
|
| +// met:
|
| +//
|
| +// * Redistributions of source code must retain the above copyright
|
| +// notice, this list of conditions and the following disclaimer.
|
| +// * Redistributions in binary form must reproduce the above
|
| +// copyright notice, this list of conditions and the following disclaimer
|
| +// in the documentation and/or other materials provided with the
|
| +// distribution.
|
| +// * Neither the name of Google Inc. nor the names of its
|
| +// contributors may be used to endorse or promote products derived from
|
| +// this software without specific prior written permission.
|
| +//
|
| +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
| +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
| +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
| +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
| +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
| +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
| +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
| +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
| +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
| +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
| +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
| +
|
| +// Author: anuraag@google.com (Anuraag Agrawal)
|
| +// Author: tibell@google.com (Johan Tibell)
|
| +
|
| +#ifndef GOOGLE_PROTOBUF_PYTHON_CPP_MESSAGE_H__
|
| +#define GOOGLE_PROTOBUF_PYTHON_CPP_MESSAGE_H__
|
| +
|
| +#include <Python.h>
|
| +
|
| +#include <memory>
|
| +#ifndef _SHARED_PTR_H
|
| +#include <google/protobuf/stubs/shared_ptr.h>
|
| +#endif
|
| +#include <string>
|
| +
|
| +namespace google {
|
| +namespace protobuf {
|
| +
|
| +class Message;
|
| +class Reflection;
|
| +class FieldDescriptor;
|
| +class Descriptor;
|
| +class DescriptorPool;
|
| +class MessageFactory;
|
| +
|
| +#ifdef _SHARED_PTR_H
|
| +using std::shared_ptr;
|
| +using std::string;
|
| +#else
|
| +using internal::shared_ptr;
|
| +#endif
|
| +
|
| +namespace python {
|
| +
|
| +struct ExtensionDict;
|
| +struct PyDescriptorPool;
|
| +
|
| +typedef struct CMessage {
|
| + PyObject_HEAD;
|
| +
|
| + // This is the top-level C++ Message object that owns the whole
|
| + // proto tree. Every Python CMessage holds a reference to it in
|
| + // order to keep it alive as long as there's a Python object that
|
| + // references any part of the tree.
|
| + shared_ptr<Message> owner;
|
| +
|
| + // Weak reference to a parent CMessage object. This is NULL for any top-level
|
| + // message and is set for any child message (i.e. a child submessage or a
|
| + // part of a repeated composite field).
|
| + //
|
| + // Used to make sure all ancestors are also mutable when first modifying
|
| + // a child submessage (in other words, turning a default message instance
|
| + // into a mutable one).
|
| + //
|
| + // If a submessage is released (becomes a new top-level message), this field
|
| + // MUST be set to NULL. The parent may get deallocated and further attempts
|
| + // to use this pointer will result in a crash.
|
| + struct CMessage* parent;
|
| +
|
| + // Pointer to the parent's descriptor that describes this submessage.
|
| + // Used together with the parent's message when making a default message
|
| + // instance mutable.
|
| + // The pointer is owned by the global DescriptorPool.
|
| + const FieldDescriptor* parent_field_descriptor;
|
| +
|
| + // Pointer to the C++ Message object for this CMessage. The
|
| + // CMessage does not own this pointer.
|
| + Message* message;
|
| +
|
| + // Indicates this submessage is pointing to a default instance of a message.
|
| + // Submessages are always first created as read only messages and are then
|
| + // made writable, at which point this field is set to false.
|
| + bool read_only;
|
| +
|
| + // A reference to a Python dictionary containing CMessage,
|
| + // RepeatedCompositeContainer, and RepeatedScalarContainer
|
| + // objects. Used as a cache to make sure we don't have to make a
|
| + // Python wrapper for the C++ Message objects on every access, or
|
| + // deal with the synchronization nightmare that could create.
|
| + PyObject* composite_fields;
|
| +
|
| + // A reference to the dictionary containing the message's extensions.
|
| + // Similar to composite_fields, acting as a cache, but also contains the
|
| + // required extension dict logic.
|
| + ExtensionDict* extensions;
|
| +} CMessage;
|
| +
|
| +extern PyTypeObject CMessage_Type;
|
| +
|
| +namespace cmessage {
|
| +
|
| +// Internal function to create a new empty Message Python object, but with empty
|
| +// pointers to the C++ objects.
|
| +// The caller must fill self->message, self->owner and eventually self->parent.
|
| +CMessage* NewEmptyMessage(PyObject* type, const Descriptor* descriptor);
|
| +
|
| +// Release a submessage from its proto tree, making it a new top-level messgae.
|
| +// A new message will be created if this is a read-only default instance.
|
| +//
|
| +// Corresponds to reflection api method ReleaseMessage.
|
| +int ReleaseSubMessage(CMessage* self,
|
| + const FieldDescriptor* field_descriptor,
|
| + CMessage* child_cmessage);
|
| +
|
| +// Retrieves the C++ descriptor of a Python Extension descriptor.
|
| +// On error, return NULL with an exception set.
|
| +const FieldDescriptor* GetExtensionDescriptor(PyObject* extension);
|
| +
|
| +// Initializes a new CMessage instance for a submessage. Only called once per
|
| +// submessage as the result is cached in composite_fields.
|
| +//
|
| +// Corresponds to reflection api method GetMessage.
|
| +PyObject* InternalGetSubMessage(
|
| + CMessage* self, const FieldDescriptor* field_descriptor);
|
| +
|
| +// Deletes a range of C++ submessages in a repeated field (following a
|
| +// removal in a RepeatedCompositeContainer).
|
| +//
|
| +// Releases messages to the provided cmessage_list if it is not NULL rather
|
| +// than just removing them from the underlying proto. This cmessage_list must
|
| +// have a CMessage for each underlying submessage. The CMessages referred to
|
| +// by slice will be removed from cmessage_list by this function.
|
| +//
|
| +// Corresponds to reflection api method RemoveLast.
|
| +int InternalDeleteRepeatedField(CMessage* self,
|
| + const FieldDescriptor* field_descriptor,
|
| + PyObject* slice, PyObject* cmessage_list);
|
| +
|
| +// Sets the specified scalar value to the message.
|
| +int InternalSetScalar(CMessage* self,
|
| + const FieldDescriptor* field_descriptor,
|
| + PyObject* value);
|
| +
|
| +// Sets the specified scalar value to the message. Requires it is not a Oneof.
|
| +int InternalSetNonOneofScalar(Message* message,
|
| + const FieldDescriptor* field_descriptor,
|
| + PyObject* arg);
|
| +
|
| +// Retrieves the specified scalar value from the message.
|
| +//
|
| +// Returns a new python reference.
|
| +PyObject* InternalGetScalar(const Message* message,
|
| + const FieldDescriptor* field_descriptor);
|
| +
|
| +// Clears the message, removing all contained data. Extension dictionary and
|
| +// submessages are released first if there are remaining external references.
|
| +//
|
| +// Corresponds to message api method Clear.
|
| +PyObject* Clear(CMessage* self);
|
| +
|
| +// Clears the data described by the given descriptor. Used to clear extensions
|
| +// (which don't have names). Extension release is handled by ExtensionDict
|
| +// class, not this function.
|
| +// TODO(anuraag): Try to make this discrepancy in release semantics with
|
| +// ClearField less confusing.
|
| +//
|
| +// Corresponds to reflection api method ClearField.
|
| +PyObject* ClearFieldByDescriptor(
|
| + CMessage* self, const FieldDescriptor* descriptor);
|
| +
|
| +// Clears the data for the given field name. The message is released if there
|
| +// are any external references.
|
| +//
|
| +// Corresponds to reflection api method ClearField.
|
| +PyObject* ClearField(CMessage* self, PyObject* arg);
|
| +
|
| +// Checks if the message has the field described by the descriptor. Used for
|
| +// extensions (which have no name).
|
| +//
|
| +// Corresponds to reflection api method HasField
|
| +PyObject* HasFieldByDescriptor(
|
| + CMessage* self, const FieldDescriptor* field_descriptor);
|
| +
|
| +// Checks if the message has the named field.
|
| +//
|
| +// Corresponds to reflection api method HasField.
|
| +PyObject* HasField(CMessage* self, PyObject* arg);
|
| +
|
| +// Initializes values of fields on a newly constructed message.
|
| +int InitAttributes(CMessage* self, PyObject* kwargs);
|
| +
|
| +PyObject* MergeFrom(CMessage* self, PyObject* arg);
|
| +
|
| +// Retrieves an attribute named 'name' from CMessage 'self'. Returns
|
| +// the attribute value on success, or NULL on failure.
|
| +//
|
| +// Returns a new reference.
|
| +PyObject* GetAttr(CMessage* self, PyObject* name);
|
| +
|
| +// Set the value of the attribute named 'name', for CMessage 'self',
|
| +// to the value 'value'. Returns -1 on failure.
|
| +int SetAttr(CMessage* self, PyObject* name, PyObject* value);
|
| +
|
| +PyObject* FindInitializationErrors(CMessage* self);
|
| +
|
| +// Set the owner field of self and any children of self, recursively.
|
| +// Used when self is being released and thus has a new owner (the
|
| +// released Message.)
|
| +int SetOwner(CMessage* self, const shared_ptr<Message>& new_owner);
|
| +
|
| +int AssureWritable(CMessage* self);
|
| +
|
| +// Returns the "best" DescriptorPool for the given message.
|
| +// This is often equivalent to message.DESCRIPTOR.pool, but not always, when
|
| +// the message class was created from a MessageFactory using a custom pool which
|
| +// uses the generated pool as an underlay.
|
| +//
|
| +// The returned pool is suitable for finding fields and building submessages,
|
| +// even in the case of extensions.
|
| +PyDescriptorPool* GetDescriptorPoolForMessage(CMessage* message);
|
| +
|
| +} // namespace cmessage
|
| +
|
| +
|
| +/* Is 64bit */
|
| +#define IS_64BIT (SIZEOF_LONG == 8)
|
| +
|
| +#define FIELD_IS_REPEATED(field_descriptor) \
|
| + ((field_descriptor)->label() == FieldDescriptor::LABEL_REPEATED)
|
| +
|
| +#define GOOGLE_CHECK_GET_INT32(arg, value, err) \
|
| + int32 value; \
|
| + if (!CheckAndGetInteger(arg, &value, kint32min_py, kint32max_py)) { \
|
| + return err; \
|
| + }
|
| +
|
| +#define GOOGLE_CHECK_GET_INT64(arg, value, err) \
|
| + int64 value; \
|
| + if (!CheckAndGetInteger(arg, &value, kint64min_py, kint64max_py)) { \
|
| + return err; \
|
| + }
|
| +
|
| +#define GOOGLE_CHECK_GET_UINT32(arg, value, err) \
|
| + uint32 value; \
|
| + if (!CheckAndGetInteger(arg, &value, kPythonZero, kuint32max_py)) { \
|
| + return err; \
|
| + }
|
| +
|
| +#define GOOGLE_CHECK_GET_UINT64(arg, value, err) \
|
| + uint64 value; \
|
| + if (!CheckAndGetInteger(arg, &value, kPythonZero, kuint64max_py)) { \
|
| + return err; \
|
| + }
|
| +
|
| +#define GOOGLE_CHECK_GET_FLOAT(arg, value, err) \
|
| + float value; \
|
| + if (!CheckAndGetFloat(arg, &value)) { \
|
| + return err; \
|
| + } \
|
| +
|
| +#define GOOGLE_CHECK_GET_DOUBLE(arg, value, err) \
|
| + double value; \
|
| + if (!CheckAndGetDouble(arg, &value)) { \
|
| + return err; \
|
| + }
|
| +
|
| +#define GOOGLE_CHECK_GET_BOOL(arg, value, err) \
|
| + bool value; \
|
| + if (!CheckAndGetBool(arg, &value)) { \
|
| + return err; \
|
| + }
|
| +
|
| +
|
| +extern PyObject* kPythonZero;
|
| +extern PyObject* kint32min_py;
|
| +extern PyObject* kint32max_py;
|
| +extern PyObject* kuint32max_py;
|
| +extern PyObject* kint64min_py;
|
| +extern PyObject* kint64max_py;
|
| +extern PyObject* kuint64max_py;
|
| +
|
| +#define FULL_MODULE_NAME "google.protobuf.pyext._message"
|
| +
|
| +void FormatTypeError(PyObject* arg, char* expected_types);
|
| +template<class T>
|
| +bool CheckAndGetInteger(
|
| + PyObject* arg, T* value, PyObject* min, PyObject* max);
|
| +bool CheckAndGetDouble(PyObject* arg, double* value);
|
| +bool CheckAndGetFloat(PyObject* arg, float* value);
|
| +bool CheckAndGetBool(PyObject* arg, bool* value);
|
| +PyObject* CheckString(PyObject* arg, const FieldDescriptor* descriptor);
|
| +bool CheckAndSetString(
|
| + PyObject* arg, Message* message,
|
| + const FieldDescriptor* descriptor,
|
| + const Reflection* reflection,
|
| + bool append,
|
| + int index);
|
| +PyObject* ToStringObject(const FieldDescriptor* descriptor, string value);
|
| +
|
| +// Check if the passed field descriptor belongs to the given message.
|
| +// If not, return false and set a Python exception (a KeyError)
|
| +bool CheckFieldBelongsToMessage(const FieldDescriptor* field_descriptor,
|
| + const Message* message);
|
| +
|
| +extern PyObject* PickleError_class;
|
| +
|
| +} // namespace python
|
| +} // namespace protobuf
|
| +
|
| +} // namespace google
|
| +#endif // GOOGLE_PROTOBUF_PYTHON_CPP_MESSAGE_H__
|
|
|