File.h

Go to the documentation of this file.

/********************************************************************
**                Image Component Library (ICL)                    **
**                                                                 **
** Copyright (C) 2006-2013 CITEC, University of Bielefeld          **
**                         Neuroinformatics Group                  **
** Website: www.iclcv.org and                                      **
**          http://opensource.cit-ec.de/projects/icl               **
**                                                                 **
** File   : ICLUtils/src/ICLUtils/File.h                           **
** Module : ICLUtils                                               **
** Authors: Christof Elbrechter                                    **
**                                                                 **
**                                                                 **
** GNU LESSER GENERAL PUBLIC LICENSE                               **
** This file may be used under the terms of the GNU Lesser General **
** Public License version 3.0 as published by the                  **
**                                                                 **
** Free Software Foundation and appearing in the file LICENSE.LGPL **
** included in the packaging of this file.  Please review the      **
** following information to ensure the license requirements will   **
** be met: http://www.gnu.org/licenses/lgpl-3.0.txt                **
**                                                                 **
** The development of this software was supported by the           **
** Excellence Cluster EXC 277 Cognitive Interaction Technology.    **
** The Excellence Cluster EXC 277 is a grant of the Deutsche       **
** Forschungsgemeinschaft (DFG) in the context of the German       **
** Excellence Initiative.                                          **
**                                                                 **
********************************************************************/

#pragma once

#include <ICLUtils/CompatMacros.h>
#include <ICLUtils/ShallowCopyable.h>
#include <ICLUtils/BasicTypes.h>
#include <string>
#include <vector>


namespace icl{
  namespace utils{
    
    class FileImpl;
    struct ICLUtils_API FileImplDelOp { static void delete_func(FileImpl *i); };


    class ICLUtils_API File : public utils::ShallowCopyable<FileImpl, FileImplDelOp>{
      public:
      
      enum OpenMode{
        readBinary = 0,  
        readText = 1,    
        writeBinary = 2, 
        writeText = 3,   
        notOpen = 4      
      };

      static std::string read_file(const std::string &filename, bool textMode=true);

      static std::vector<std::string> read_lines(const std::string &filename);

      static void write_file(const std::string &filename, const std::string &text, 
                             bool textMode=true);

      static void write_lines(const std::string &filename, const std::vector<std::string> &lines);


      File();
      
      File(const std::string &name);
      
      File(const std::string &name, OpenMode om);
  
      ~File();
      
      bool exists() const;
  
      bool isDirectory() const;
      
      bool isOpen() const;
      
      bool isBinary() const;
      
      std::string getDir() const;
      
      std::string getBaseName() const;
  
      std::string getSuffix() const;
  
      std::string getName() const;
      
      void write(const void *data, int len);
      

      void writeLine(const void *data, int len);
      
      void write(const std::string &text);
      
      void setPrecision(const std::string &p="%8f");
  
      File &operator<<(char c);
  
      File &operator<<(unsigned char uc); 
  
      File &operator<<(int i);
  
      File &operator<<(unsigned int ui);
      
      File &operator<<(float f);
  
      File &operator<<(double d);
  
      File &operator<<(const std::string &s);
      

      std::string readLine() const;
      

      std::string &readLine(std::string &dst) const;
  
      const std::vector<icl8u> &readAll() const;
  
      const icl8u* getCurrentDataPointer() const;
      
      const icl8u* getFileDataPointer() const;
  

      std::vector<icl8u> read(int len) const;
      

      int read(int len, void *dst) const;
  
      bool hasMoreLines() const;
  
      int bytesAvailable() const;
      
      int getFileSize() const;
      

      void open(OpenMode om);
  

      void reopen(OpenMode om);
  
      void close();
      
      void erase();
      
      void reset();
  
      void *getHandle() const;
  
      bool canRead() const;
      
      bool canWrite() const;
      
      OpenMode getOpenMode() const;
    
    };
  } // namespace utils
}