src/breakpad/src/google_breakpad/processor/dump_object.h

   1 // Copyright (c) 2014 Google Inc.
   2 // All rights reserved.
   3 //
   4 // Redistribution and use in source and binary forms, with or without
   5 // modification, are permitted provided that the following conditions are
   6 // met:
   7 //
   8 //     * Redistributions of source code must retain the above copyright
   9 // notice, this list of conditions and the following disclaimer.
  10 //     * Redistributions in binary form must reproduce the above
  11 // copyright notice, this list of conditions and the following disclaimer
  12 // in the documentation and/or other materials provided with the
  13 // distribution.
  14 //     * Neither the name of Google Inc. nor the names of its
  15 // contributors may be used to endorse or promote products derived from
  16 // this software without specific prior written permission.
  17 //
  18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29
  30 // dump_object.h: A base class for all mini/micro dump object.
  31
  32 #ifndef GOOGLE_BREAKPAD_PROCESSOR_DUMP_OBJECT_H__
  33 #define GOOGLE_BREAKPAD_PROCESSOR_DUMP_OBJECT_H__
  34
  35 namespace google_breakpad {
  36
  37 // DumpObject is the base of various mini/micro dump's objects.
  38 class DumpObject {
  39  public:
  40   DumpObject();
  41
  42   bool valid() const { return valid_; }
  43
  44  protected:
  45   // DumpObjects are not valid when created.  When a subclass populates its own
  46   // fields, it can set valid_ to true.  Accessors and mutators may wish to
  47   // consider or alter the valid_ state as they interact with objects.
  48   bool valid_;
  49 };
  50
  51 }  // namespace google_breakpad
  52
  53 #endif  // GOOGLE_BREAKPAD_PROCESSOR_DUMP_OBJECT_H__