Added headers
[tpot/pegasus/.git] / src / Pegasus / Common / Dir.h
index 4edb8497ed5476793dcde10c5793489e86cc570e..d0523ed273d9f48776ec517c26eee283d2bd1187 100644 (file)
@@ -1,89 +1,90 @@
-//%/////////////////////////////////////////////////////////////////////////////
-//
-// Copyright (c) 2000 The Open Group, BMC Software, Tivoli Systems, IBM
-//
-// Permission is hereby granted, free of charge, to any person obtaining a
-// copy of this software and associated documentation files (the "Software"),
-// to deal in the Software without restriction, including without limitation
-// the rights to use, copy, modify, merge, publish, distribute, sublicense,
-// and/or sell copies of the Software, and to permit persons to whom the
-// Software is furnished to do so, subject to the following conditions:
-//
-// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
-// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
-// DEALINGS IN THE SOFTWARE.
-//
-//==============================================================================
-//
-// Author: Mike Brasher (mbrasher@bmc.com)
-//
-// Modified By:
-//
-//%/////////////////////////////////////////////////////////////////////////////
-
-#ifndef Pegasus_Dir_h
-#define Pegasus_Dir_h
-
-#include <Pegasus/Common/Config.h>
-#include <Pegasus/Common/String.h>
-#include <Pegasus/Common/Exception.h>
-
-PEGASUS_NAMESPACE_BEGIN
-
-struct DirRep;
-
-/** The Dir class provides a platform independent way of iterating the
-    files in a directory.
-*/
-class PEGASUS_COMMON_LINKAGE Dir
-{
-public:
-
-    /** Starts this iterator class on the given path.
-       @param String path is the path to the target directory 
-       @return
-       @exception throws CannotOpenDirectory if invalid directory.
-
-       <pre>
-       char* path = "."
-       try
-       { 
-          for (Dir dir(path); dir.more(); dir.next())
-          {
-              cout << "name: " << dir.getName() << endl;
-          }
-       }
-       catch(CannotOpenDirectory&)
-       {
-          // Error!
-       }
-       </pre>
-    */
-    Dir(const String& path);
-
-    /** Release any iterator resources. */
-    ~Dir();
-
-    /** Return true if there are more file names to iterator. */
-    Boolean more() const { return _more; }
-
-    /** Returns the current file name. */
-    const char* getName() const;
-
-    /** Advance to next file in directory. */
-    void next();
-
-private:
-
-    Boolean _more;
-    Boolean _isValid;
-    DirRep* _rep;
-};
-
-PEGASUS_NAMESPACE_END
-
-#endif /* Pegasus_Dir_h */
+//%/////////////////////////////////////////////////////////////////////////////\r
+//\r
+// Copyright (c) 2000, 2001 The Open group, BMC Software, Tivoli Systems, IBM\r
+//\r
+// Permission is hereby granted, free of charge, to any person obtaining a copy\r
+// of this software and associated documentation files (the "Software"), to \r
+// deal in the Software without restriction, including without limitation the \r
+// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or \r
+// sell copies of the Software, and to permit persons to whom the Software is\r
+// furnished to do so, subject to the following conditions:\r
+// \r
+// THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN \r
+// ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED\r
+// "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT\r
+// LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR \r
+// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT \r
+// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN \r
+// ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION\r
+// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
+//\r
+//==============================================================================\r
+//\r
+// Author: Mike Brasher (mbrasher@bmc.com)\r
+//\r
+// Modified By:\r
+//\r
+//%/////////////////////////////////////////////////////////////////////////////\r
+\r
+#ifndef Pegasus_Dir_h\r
+#define Pegasus_Dir_h\r
+\r
+#include <Pegasus/Common/Config.h>\r
+#include <Pegasus/Common/String.h>\r
+#include <Pegasus/Common/Exception.h>\r
+\r
+PEGASUS_NAMESPACE_BEGIN\r
+\r
+struct DirRep;\r
+\r
+/** The Dir class provides a platform independent way of iterating the\r
+    files in a directory.\r
+*/\r
+class PEGASUS_COMMON_LINKAGE Dir\r
+{\r
+public:\r
+\r
+    /** Starts this iterator class on the given path.\r
+       @param String path is the path to the target directory \r
+       @return\r
+       @exception throws CannotOpenDirectory if invalid directory.\r
+\r
+       <pre>\r
+       char* path = "."\r
+       try\r
+       { \r
+          for (Dir dir(path); dir.more(); dir.next())\r
+          {\r
+              cout << "name: " << dir.getName() << endl;\r
+          }\r
+       }\r
+       catch(CannotOpenDirectory&)\r
+       {\r
+          // Error!\r
+       }\r
+       </pre>\r
+    */\r
+    Dir(const String& path);\r
+\r
+    /** Release any iterator resources. */\r
+    ~Dir();\r
+\r
+    /** Return true if there are more file names to iterator. */\r
+    Boolean more() const { return _more; }\r
+\r
+    /** Returns the current file name. */\r
+    const char* getName() const;\r
+\r
+    /** Advance to next file in directory. */\r
+    void next();\r
+\r
+private:\r
+\r
+    Boolean _more;\r
+    Boolean _isValid;\r
+    DirRep* _rep;\r
+};\r
+\r
+PEGASUS_NAMESPACE_END\r
+\r
+#endif /* Pegasus_Dir_h */\r