OSDLEmbeddedDirectory.h

Go to the documentation of this file.

/* 
 * Copyright (C) 2003-2009 Olivier Boudeville
 *
 * This file is part of the OSDL library.
 *
 * The OSDL library is free software: you can redistribute it and/or modify
 * it under the terms of either the GNU Lesser General Public License or
 * the GNU General Public License, as they are published by the Free Software
 * Foundation, either version 3 of these Licenses, or (at your option) 
 * any later version.
 *
 * The OSDL 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 Lesser General Public License and the GNU General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License and of the GNU General Public License along with the OSDL library.
 * If not, see <http://www.gnu.org/licenses/>.
 *
 * Author: Olivier Boudeville (olivier.boudeville@esperide.com)
 *
 */


#ifndef OSDL_EMBEDDED_DIRECTORY_H_
#define OSDL_EMBEDDED_DIRECTORY_H_


#include "Ceylan.h"  // for inheritance and FileSystemManagerException


#include <list>
#include <string>




namespace OSDL
{



    /*
     * Each Directory child class is linked to a corresponding filesystem
     * manager child class, here it is the embedded one.
     *
     */
    class EmbeddedFileSystemManager ;
    

    
    class OSDL_DLL EmbeddedDirectory: public Ceylan::System::Directory
    {


        public:



            virtual ~EmbeddedDirectory() throw() ;



            // Instance methods.
            
            
            
            // Directory content subsection.
            
            
            
            virtual bool hasDirectory( 
                const std::string & subdirectoryName ) const ;



            virtual bool hasFile( const std::string & fileName ) const ;



            virtual bool hasEntry( const std::string & entryName ) const ;



            virtual void getSubdirectories( 
                std::list<std::string> & subDirectories ) const ;



            virtual void getFiles( std::list<std::string> & files ) const ;



            virtual void getEntries( std::list<std::string> & entries ) const ;



            virtual void getSortedEntries( 
                std::list<std::string> & subDirectories,
                std::list<std::string> & files,
                std::list<std::string> & otherEntries ) const ;




            // Other instance methods.
            


            // goDown, isValid, getPath, removeLeadingSeparator inherited.



            virtual const std::string toString( 
                Ceylan::VerbosityLevels level = Ceylan::high ) const ;





            // Factory section.



            static EmbeddedDirectory & Create( 
                const std::string & newDirectoryName ) ;

            
            
            static EmbeddedDirectory & Open( 
                const std::string & directoryName = "" ) ;
                
                

            explicit EmbeddedDirectory( const std::string & directoryName,
                bool create = true ) ;

            
            
                
        protected:



            virtual Ceylan::System::FileSystemManager &
                getCorrespondingFileSystemManager() const ;



            static const std::string RootDirectoryPrefix ;



            static const std::string CurrentDirectoryAlias ;



            static const std::string UpperDirectoryAlias ;



            static const char Separator ;




        private:



            EmbeddedDirectory( const EmbeddedDirectory & source ) ;



            EmbeddedDirectory & operator = ( 
                const EmbeddedDirectory & source ) ;



    } ;


}



#endif // OSDL_EMBEDDED_DIRECTORY_H_

---