nspr/file.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2008 by Rick L. Vinyard, Jr.                            *
 *   rvinyard@cs.nmsu.edu                                                  *
 *                                                                         *
 *   This file is part of the conexus library.                             *
 *                                                                         *
 *   The conexus library is free software; you can redistribute it and/or  *
 *   modify it under the terms of the GNU General Public License           *
 *   version 3 as published by the Free Software Foundation.               *
 *                                                                         *
 *   The conexus library 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 this software. If not see <http://www.gnu.org/licenses/>.  *
 ***************************************************************************/
#ifndef CONEXUS_NSPRFILE_H
#define CONEXUS_NSPRFILE_H

#include <conexus/enums.h>
#include <conexus-nspr/filedescriptor.h>

namespace Conexus
{

  namespace NSPR
  {

    class File : public FileDescriptor
    {
      protected:

        File ( const std::string& filename,
               long unsigned mode );

      public:

        typedef ConexusPointer<File> pointer;

        CONEXUS_ENDPOINT_GENERIC_CREATE();

        static File::pointer create ( const std::string& filename = std::string(),
                                      long unsigned mode = 0 );

        virtual ~File();

        virtual void open ( const std::string name,
                            long unsigned mode = FILE_UNCHANGED )
        throw ( open_exception );

        virtual void open() throw ( open_exception );

        std::string filename();

        long unsigned mode();

        bool eof();

        bool throw_eof();

        void set_throw_eof ( bool teof = true );

        bool is_file() const;

        bool is_directory() const;

        bool is_other_file_type() const;

        size_t size() const;

        void set_filename ( std::string d, long unsigned mode = FILE_UNCHANGED ) throw ( open_exception );

        sigc::signal<void> signal_filename_changed();

      protected:
        std::string m_filename;
        long unsigned m_mode;
        bool m_eof;
        bool m_throw_eof;

        sigc::signal<void> m_signal_filename_changed;

        virtual Data read_data ( long int timeout, size_t s = 0 ) throw ( read_exception );

    };

  }

}

#endif