Bpp/Standard
Stream
C++
 
 
DESCRIPTION
 

This module provides facilities to manage streams, files and folders.

 
SOURCE FILES
 

This section allows you to access the C++ source files of the module.

 
PARENT MODULE
 

This module is part of Bpp/Standard.

 
INCLUDED FILES
 

The files listed below are included in the interface part of the module. So any module dependent of this module is also dependent of the files listed here.

  • <bpp/dependency.hpp>

  • DIR_HEADER_1

  • DIR_HEADER_2

  • <dirent.h>

  • <bpp/standard/error.hpp>

  • <contribution/string.hpp>

 
NEEDED FILES
 

The files listed below are needed by the implementation part of the module. But a module dependent of this module is not necessary dependent of the files listed here.

  • <cstdio>

  • <set>

  • <bpp/file_name.hpp>

  • <bpp/modules.hpp>

 
INTEGRATED NAMESPACES
 

The namespaces listed below are integrated in this module. That means any element declared in one of those namespaces can now be directly used by or from this module.

  • standardBasicString

  • standardError

 
TYPES
 

Here are listed the types defined in the module. To use one of them, you have to specify the namespace of the module.

  • type std::ifstream clInFile
    Input file.

  • type std::ofstream clOutFile
    Output file.

  • type std::istream clInStream
    Input stream.

  • type std::ostream clOutStream
    Output stream.

  • type std::iostream clStream
    Input and output stream.

  • type std_vector(clString) clFileNameS
    List of file names.

  • type DIR * tyFolder
    Represents a folder (in the case that the DIR structure exists).

  • type FILE_OPENING_MODE_TYPE tyFileMode
    Opening mode of a file.

  • type std::streamoff tyStreamOffset
    Relative position in a stream.

  • type std::streampos tyStreamPosition
    Absolute position in a stream.

  • type std::streamsize tyStreamSize
    Size in a stream.

  • enumeration { unknownEntity, fileEntity, folderEntity, referenceEntity } tyDiskEntityKind
    Symbolic constants for the kinds of entity in a folder.

 
ERRORS
 

Here are listed the errors that are supported or generated by the module. To use one of them, you do not have to specify the namespace of the module.

  • erEntityIdentification
    Can not identify an entity in the folder.

  • erFileNotRegistered
    The file is not registered.

  • erFileOpening
    Can not open the file.

  • erFileReading
    Can not read from the file.

  • erFileWriting
    Can not write into the file.

  • erStreamReading
    Can not read from the stream.

  • erStreamWriting
    Can not write into the stream.

  • erFindFileSize
    Can not find the file's size.

  • erFileAlreadyExists
    The file already exists.

  • erFileFolderRenaming
    Can not rename the file or the folder.

  • erFileRemoving
    Can not remove the file.

  • erFolderClosing
    Can not close the folder.

  • erFolderCreation
    Can not create the folder.

  • erFolderOpening
    Can not open the folder.

  • erFolderRemoving
    Can not remove the folder.

 
CONSTANTS
 

Here are listed the constants provided by the module. To use one of them, you have to specify the namespace of the module.

  • tcString fileNameSeparator()
    Symbol that separates file names in a path.

  • tcString pathSeparator()
    Symbol that separates paths in an environment variable.

  • tyCardinal streamBufferSize()
    Size of the buffer for stream readings and writings.

  • tyCardinal maximumPathLength()
    Maximum possible length of a string representing a path.

 
FUNCTIONS
 

Here are listed the functions provided by the module. To use one of them, you have to specify the namespace of the module.

 
CLASSES
 

Here are listed the classes provided by the module. To use one of them, you have to specify the namespace of the module.

 
clFolderProcessing
 
 
Declaration

class clFolderProcessing

 
Description

Used by scanFolder to perform a process upon the entities found during the scanning of a folder. It is an abstract class. The methods of this class must be implemented.

 
Methods
 
 
Copyright (c) 1999-2016 - Bruno Bachelet - bruno@nawouak.net - http://www.nawouak.net
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation. See this license for more details (http://www.gnu.org).