/ src / processor / simple_serializer.h
simple_serializer.h
 1  // Copyright 2010 Google LLC
 2  //
 3  // Redistribution and use in source and binary forms, with or without
 4  // modification, are permitted provided that the following conditions are
 5  // met:
 6  //
 7  //     * Redistributions of source code must retain the above copyright
 8  // notice, this list of conditions and the following disclaimer.
 9  //     * Redistributions in binary form must reproduce the above
10  // copyright notice, this list of conditions and the following disclaimer
11  // in the documentation and/or other materials provided with the
12  // distribution.
13  //     * Neither the name of Google LLC nor the names of its
14  // contributors may be used to endorse or promote products derived from
15  // this software without specific prior written permission.
16  //
17  // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18  // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19  // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20  // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21  // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22  // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23  // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24  // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25  // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27  // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  //
29  // simple_serializer.h: SimpleSerializer is a template for calculating size and
30  // writing to specific memory location for objects of primitive types, C-style
31  // string, string, breakpad types/structs etc.
32  // All specializations of SimpleSerializer template are defined in the
33  // "simple_serializer-inl.h" file.
34  //
35  // Author: Siyang Xie (lambxsy@google.com)
36  
37  #ifndef PROCESSOR_SIMPLE_SERIALIZER_H__
38  #define PROCESSOR_SIMPLE_SERIALIZER_H__
39  
40  #include <stddef.h>
41  
42  #include "google_breakpad/common/breakpad_types.h"
43  
44  namespace google_breakpad {
45  
46  typedef uint64_t MemAddr;
47  
48  // Default implementation of SimpleSerializer template.
49  // Specializations are defined in "simple_serializer-inl.h".
50  template<class Type> class SimpleSerializer {
51   public:
52    // Calculate and return the size of the 'item'.
53    static size_t SizeOf(const Type& item) { return sizeof(item); }
54    // Write 'item' to memory location 'dest', and return to the "end" address of
55    // data written, i.e., the address after the final byte written.
56    static char* Write(const Type& item, char* dest) {
57      new (dest) Type(item);
58      return dest + SizeOf(item);
59    }
60  };
61  
62  }  // namespace google_breakpad
63  
64  #endif  // PROCESSOR_SIMPLE_SERIALIZER_H__