xref: /aosp_15_r20/external/google-breakpad/src/google_breakpad/processor/dump_object.h (revision 9712c20fc9bbfbac4935993a2ca0b3958c5adad2)
1 // Copyright 2014 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 // dump_object.h: A base class for all mini/micro dump object.
30 
31 #ifndef GOOGLE_BREAKPAD_PROCESSOR_DUMP_OBJECT_H__
32 #define GOOGLE_BREAKPAD_PROCESSOR_DUMP_OBJECT_H__
33 
34 namespace google_breakpad {
35 
36 // DumpObject is the base of various mini/micro dump's objects.
37 class DumpObject {
38  public:
39   DumpObject();
40 
valid()41   bool valid() const { return valid_; }
42 
43  protected:
44   // DumpObjects are not valid when created.  When a subclass populates its own
45   // fields, it can set valid_ to true.  Accessors and mutators may wish to
46   // consider or alter the valid_ state as they interact with objects.
47   bool valid_;
48 };
49 
50 }  // namespace google_breakpad
51 
52 #endif  // GOOGLE_BREAKPAD_PROCESSOR_DUMP_OBJECT_H__
53