src/OpenFOAM/memory for holding all the memory management bits

src/OpenFOAM/memory/tmp/tmp.H

@@ -0,0 +1,150 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 1991-2008 OpenCFD Ltd.
+     \\/     M anipulation  |
+-------------------------------------------------------------------------------
+License
+    This file is part of OpenFOAM.
+
+    OpenFOAM is free software; you can redistribute it and/or modify it
+    under the terms of the GNU General Public License as published by the
+    Free Software Foundation; either version 2 of the License, or (at your
+    option) any later version.
+
+    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
+    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+    for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with OpenFOAM; if not, write to the Free Software Foundation,
+    Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
+Class
+    Foam::tmp
+
+Description
+    A class for managing temporary objects
+
+SourceFiles
+    tmpI.H
+
+\*---------------------------------------------------------------------------*/
+
+#ifndef tmp_H
+#define tmp_H
+
+#include "refCount.H"
+#include <cstddef>
+
+#if defined(__GNUC__) && !defined(__INTEL_COMPILER)
+#   define ConstructFromTmp
+#endif
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+namespace Foam
+{
+
+/*---------------------------------------------------------------------------*\
+                           Class tmp Declaration
+\*---------------------------------------------------------------------------*/
+
+template<class T>
+class tmp
+{
+    // Private data
+
+        //- Flag for whether object is a temporary or a constant object
+        bool isTmp_;
+
+        //- Pointer to temporary object
+        mutable T* ptr_;
+
+        // Const reference to constant object
+        const T& ref_;
+
+
+public:
+
+    // Constructors
+
+        //- Store object pointer
+        inline explicit tmp(T* = 0);
+
+        //- Store object const reference
+        inline tmp(const T&);
+
+        //- Construct copy and increment reference count
+        inline tmp(const tmp<T>&);
+
+
+    // Destructor
+
+        //- Delete object when reference count == 0
+        inline ~tmp();
+
+
+    // Member Functions
+
+        // Access
+
+            //- Is this really a temporary object
+            inline bool isTmp() const;
+
+            //- Is this temporary object valid, i.e. is it a reference
+            //  or a temporary that has been allocated
+            inline bool valid() const;
+
+
+        // Edit
+
+            //- Return tmp pointer for reuse
+            inline T* ptr() const;
+
+            //- If object pointer points to valid object:
+            //  delete object and set pointer to NULL
+            inline void clear();
+
+            //- If object pointer points to valid object:
+            //  delete object and set pointer to NULL
+            inline void clear() const;
+
+
+    // Member operators
+
+        //- Dereference operator
+        inline T& operator()();
+
+        //- Const dereference operator
+        inline const T& operator()() const;
+
+        //- Const cast to the underlying type reference
+        inline operator const T&() const;
+
+        //- Return object pointer
+        inline T* operator->();
+
+        //- Return const object pointer
+        inline const T* operator->() const;
+
+        //- Assignment operator
+        inline void operator=(const tmp<T>&);
+};
+
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+} // End namespace Foam
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+#include "tmpI.H"
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+#endif
+
+// ************************************************************************* //