juce/source/src/utilities/juce_DeletedAtShutdown.h

   1 /*
   2   ==============================================================================
   3
   4    This file is part of the JUCE library - "Jules' Utility Class Extensions"
   5    Copyright 2004-11 by Raw Material Software Ltd.
   6
   7   ------------------------------------------------------------------------------
   8
   9    JUCE can be redistributed and/or modified under the terms of the GNU General
  10    Public License (Version 2), as published by the Free Software Foundation.
  11    A copy of the license is included in the JUCE distribution, or can be found
  12    online at www.gnu.org/licenses.
  13
  14    JUCE is distributed in the hope that it will be useful, but WITHOUT ANY
  15    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  16    A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  17
  18   ------------------------------------------------------------------------------
  19
  20    To release a closed-source product which uses JUCE, commercial licenses are
  21    available: visit www.rawmaterialsoftware.com/juce for more information.
  22
  23   ==============================================================================
  24 */
  25
  26 #ifndef __JUCE_DELETEDATSHUTDOWN_JUCEHEADER__
  27 #define __JUCE_DELETEDATSHUTDOWN_JUCEHEADER__
  28
  29 #include "../containers/juce_Array.h"
  30
  31
  32 //==============================================================================
  33 /**
  34     Classes derived from this will be automatically deleted when the application exits.
  35
  36     After JUCEApplication::shutdown() has been called, any objects derived from
  37     DeletedAtShutdown which are still in existence will be deleted in the reverse
  38     order to that in which they were created.
  39
  40     So if you've got a singleton and don't want to have to explicitly delete it, just
  41     inherit from this and it'll be taken care of.
  42 */
  43 class JUCE_API  DeletedAtShutdown
  44 {
  45 protected:
  46     /** Creates a DeletedAtShutdown object. */
  47     DeletedAtShutdown();
  48
  49     /** Destructor.
  50
  51         It's ok to delete these objects explicitly - it's only the ones left
  52         dangling at the end that will be deleted automatically.
  53     */
  54     virtual ~DeletedAtShutdown();
  55
  56
  57 public:
  58     /** Deletes all extant objects.
  59
  60         This shouldn't be used by applications, as it's called automatically
  61         in the shutdown code of the JUCEApplication class.
  62     */
  63     static void deleteAll();
  64
  65 private:
  66     static Array <DeletedAtShutdown*>& getObjects();
  67
  68     JUCE_DECLARE_NON_COPYABLE (DeletedAtShutdown);
  69 };
  70
  71 #endif   // __JUCE_DELETEDATSHUTDOWN_JUCEHEADER__