osbfileutil.h

Go to the documentation of this file.

// OSB library ********************************************* -*- C++ -*-
/*
  AUTHOR(S): Stephan Broennimann (vb)

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.17 $

  License
   OSB rating and billing library for communication networks
   Copyright (C) 2004, 2005, 2006  OSB systems

   This file may be distributed and/or modify under the terms of the
   GNU General Public License (GPL) as published by the Free Software
   Foundation which is provided in the file LICENSE.GPL included in the
   packaging of this file.

   The file 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.

   Holders of a OSB Commercial License may use this file under the terms
   and conditions of this commercial license.
 */
#ifndef _OSBFILEUTIL_H_
#define _OSBFILEUTIL_H_

// *********************************************************************
// included header files
// + standard includes
#include <string>
#include <list>
#include <dirent.h>                     // struct dirent
#include <ios>

// + local headers

// *********************************************************************
// namespace extensions
namespace OSB_LIB {

// *********************************************************************
// class definitions

    class CloseFile {
    public:
        CloseFile(
            FILE* file,
            bool  doClose = true
        );
    private:
        CloseFile(const CloseFile&);
    public:
        ~CloseFile();
        bool release();
        bool doClose() const { return doClose_ && file_ != 0; }
    private:
        bool  doClose_;
        FILE* file_;
    };

    class ScanDir {
    public:
        // Base class to select directory entries.
        class Select;
        typedef std::list<std::string> Result;

    public:
        ScanDir(const std::string& dirPath);
        ~ScanDir();
    private:
        ScanDir(const ScanDir&);
        ScanDir& operator=(const ScanDir&);

    public:
        const std::string& dirPath() const;
        Result result_;
        void setPath(const std::string& dirPath);
        size_t scan(Select& select);

    private:
        std::string dirPath_;
        dirent*     curEntry_;
        size_t      entrySize_;

    private:
        dirent* mkEntry(size_t s) const;
        void delEntry(dirent*& entry) const;
        void mkCurEntry();
    };                                  // class ScanDir

    class ScanDir::Select {
    public:
        virtual ~Select() {}
        virtual int operator()(
            const std::string& dir,
            const std::string& name
        ) = 0;
    };                                  // class ScanDir::Select

// *********************************************************************
// free functions
    std::string dirName(const std::string& path);
    std::string baseName(const std::string& path);
    int mkDir(
        const std::string& path,
              bool         mkParents = false
    );

    bool fileExists(
        const std::string& path,
              bool         ct = false
    );

    bool dirExists(
        const std::string& path,
              bool         ct = false
    );

    bool openStream(
              std::fstream&           stream,
        const std::string&            path,
              std::ios_base::openmode openMode
    );

    int fileOpenError(
        const std::string& path,
        const std::string& mode
    );
}                                       // namespace OSB_LIB
#endif                                  // #ifndef _OSBFILEUTIL_H_

---