gcc const fix, converted linefeeds
[shibboleth/cpp-xmltooling.git] / xmltooling / Lockable.h
index 0047a94..42d4b47 100644 (file)
-/*\r
- *  Copyright 2001-2006 Internet2\r
- * \r
- * Licensed under the Apache License, Version 2.0 (the "License");\r
- * you may not use this file except in compliance with the License.\r
- * You may obtain a copy of the License at\r
- *\r
- *     http://www.apache.org/licenses/LICENSE-2.0\r
- *\r
- * Unless required by applicable law or agreed to in writing, software\r
- * distributed under the License is distributed on an "AS IS" BASIS,\r
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
- * See the License for the specific language governing permissions and\r
- * limitations under the License.\r
- */\r
-\r
-/**\r
- * @file Lockable.h\r
- * \r
- * Locking abstraction \r
- */\r
-\r
-#ifndef __xmltooling_lockable_h__\r
-#define __xmltooling_lockable_h__\r
-\r
-#include <xmltooling/base.h>\r
-\r
-namespace xmltooling {\r
-\r
-    /**\r
-     * Abstract mixin interface for interfaces that support locking\r
-     */\r
-    struct XMLTOOL_API Lockable\r
-    {\r
-        virtual ~Lockable() {}\r
-        \r
-        /**\r
-         * Lock the associated object for exclusive access.\r
-         * \r
-         * @return a pointer to the object being locked\r
-         */\r
-        virtual Lockable* lock()=0;\r
-\r
-        /**\r
-         * Unlock the associated object from exclusive access.\r
-         */\r
-        virtual void unlock()=0;\r
-    };\r
-\r
-    /**\r
-     * RAII wrapper for lockable objects to ensure lock release\r
-     */\r
-    class XMLTOOL_API Locker\r
-    {\r
-    MAKE_NONCOPYABLE(Locker);\r
-    public:\r
-        /**\r
-         * Optionally locks an object and stores it for later release.\r
-         * \r
-         * @param lockee    pointer to an object to hold, and optionally lock\r
-         * @param lock      true iff object is not yet locked\r
-         */\r
-        Locker(Lockable* lockee=NULL, bool lock=true) {\r
-            if (lockee && lock)\r
-                m_lockee=lockee->lock();\r
-            else\r
-                m_lockee=lockee;\r
-        }\r
-\r
-        /**\r
-         * Optionally locks an object and stores it for later release.\r
-         * If an object is already held, it is unlocked and detached.\r
-         * \r
-         * @param lockee    pointer to an object to hold, and optionally lock\r
-         * @param lock      true iff object is not yet locked\r
-         */\r
-        void assign(Lockable* lockee=NULL, bool lock=true) {\r
-            if (m_lockee)\r
-                m_lockee->unlock();\r
-            m_lockee=NULL;\r
-            if (lockee && lock)\r
-                m_lockee=lockee->lock();\r
-            else\r
-                m_lockee=lockee;\r
-        }\r
-        \r
-        /**\r
-         * Destructor releases lock on held pointer, if any.\r
-         */\r
-        ~Locker() {\r
-            if (m_lockee)\r
-                m_lockee->unlock();\r
-         }\r
-        \r
-    private:\r
-        Lockable* m_lockee;\r
-    };\r
-\r
-};\r
-\r
-#endif /* __xmltooling_lockable_h__ */\r
+/*
+ *  Copyright 2001-2006 Internet2
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * @file Lockable.h
+ * 
+ * Locking abstraction 
+ */
+
+#ifndef __xmltooling_lockable_h__
+#define __xmltooling_lockable_h__
+
+#include <xmltooling/base.h>
+
+namespace xmltooling {
+
+    /**
+     * Abstract mixin interface for interfaces that support locking
+     */
+    struct XMLTOOL_API Lockable
+    {
+        virtual ~Lockable() {}
+        
+        /**
+         * Lock the associated object for exclusive access.
+         * 
+         * @return a pointer to the object being locked
+         */
+        virtual Lockable* lock()=0;
+
+        /**
+         * Unlock the associated object from exclusive access.
+         */
+        virtual void unlock()=0;
+    };
+
+    /**
+     * RAII wrapper for lockable objects to ensure lock release
+     */
+    class XMLTOOL_API Locker
+    {
+    MAKE_NONCOPYABLE(Locker);
+    public:
+        /**
+         * Optionally locks an object and stores it for later release.
+         * 
+         * @param lockee    pointer to an object to hold, and optionally lock
+         * @param lock      true iff object is not yet locked
+         */
+        Locker(Lockable* lockee=NULL, bool lock=true) {
+            if (lockee && lock)
+                m_lockee=lockee->lock();
+            else
+                m_lockee=lockee;
+        }
+
+        /**
+         * Optionally locks an object and stores it for later release.
+         * If an object is already held, it is unlocked and detached.
+         * 
+         * @param lockee    pointer to an object to hold, and optionally lock
+         * @param lock      true iff object is not yet locked
+         */
+        void assign(Lockable* lockee=NULL, bool lock=true) {
+            if (m_lockee)
+                m_lockee->unlock();
+            m_lockee=NULL;
+            if (lockee && lock)
+                m_lockee=lockee->lock();
+            else
+                m_lockee=lockee;
+        }
+        
+        /**
+         * Destructor releases lock on held pointer, if any.
+         */
+        ~Locker() {
+            if (m_lockee)
+                m_lockee->unlock();
+         }
+        
+    private:
+        Lockable* m_lockee;
+    };
+
+};
+
+#endif /* __xmltooling_lockable_h__ */