Home | History | Annotate | Download | only in protobuf
      1 // Protocol Buffers - Google's data interchange format
      2 // Copyright 2008 Google Inc.  All rights reserved.
      3 // https://developers.google.com/protocol-buffers/
      4 //
      5 // Redistribution and use in source and binary forms, with or without
      6 // modification, are permitted provided that the following conditions are
      7 // met:
      8 //
      9 //     * Redistributions of source code must retain the above copyright
     10 // notice, this list of conditions and the following disclaimer.
     11 //     * Redistributions in binary form must reproduce the above
     12 // copyright notice, this list of conditions and the following disclaimer
     13 // in the documentation and/or other materials provided with the
     14 // distribution.
     15 //     * Neither the name of Google Inc. nor the names of its
     16 // contributors may be used to endorse or promote products derived from
     17 // this software without specific prior written permission.
     18 //
     19 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     20 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     21 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     22 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     23 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     24 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
     25 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     26 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     27 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     28 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     29 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     30 
     31 // Author: kenton (at) google.com (Kenton Varda)
     32 //  Based on original Protocol Buffers design by
     33 //  Sanjay Ghemawat, Jeff Dean, and others.
     34 //
     35 // This header is logically internal, but is made public because it is used
     36 // from protocol-compiler-generated code, which may reside in other components.
     37 
     38 #ifndef GOOGLE_PROTOBUF_REFLECTION_OPS_H__
     39 #define GOOGLE_PROTOBUF_REFLECTION_OPS_H__
     40 
     41 #include <google/protobuf/stubs/common.h>
     42 #include <google/protobuf/message.h>
     43 
     44 namespace google {
     45 namespace protobuf {
     46 namespace internal {
     47 
     48 // Basic operations that can be performed using reflection.
     49 // These can be used as a cheap way to implement the corresponding
     50 // methods of the Message interface, though they are likely to be
     51 // slower than implementations tailored for the specific message type.
     52 //
     53 // This class should stay limited to operations needed to implement
     54 // the Message interface.
     55 //
     56 // This class is really a namespace that contains only static methods.
     57 class LIBPROTOBUF_EXPORT ReflectionOps {
     58  public:
     59   static void Copy(const Message& from, Message* to);
     60   static void Merge(const Message& from, Message* to);
     61   static void Clear(Message* message);
     62   static bool IsInitialized(const Message& message);
     63   static void DiscardUnknownFields(Message* message);
     64 
     65   // Finds all unset required fields in the message and adds their full
     66   // paths (e.g. "foo.bar[5].baz") to *names.  "prefix" will be attached to
     67   // the front of each name.
     68   static void FindInitializationErrors(const Message& message,
     69                                        const string& prefix,
     70                                        vector<string>* errors);
     71 
     72  private:
     73   // All methods are static.  No need to construct.
     74   GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(ReflectionOps);
     75 };
     76 
     77 }  // namespace internal
     78 }  // namespace protobuf
     79 
     80 }  // namespace google
     81 #endif  // GOOGLE_PROTOBUF_REFLECTION_OPS_H__
     82