VirtualDirectory.hpp

Go to the documentation of this file.

/**************************************************************************************/
/*                                                                                    */
/*  Visualization Library                                                             */
/*  http://visualizationlibrary.org                                                   */
/*                                                                                    */
/*  Copyright (c) 2005-2020, Michele Bosi                                             */
/*  All rights reserved.                                                              */
/*                                                                                    */
/*  Redistribution and use in source and binary forms, with or without modification,  */
/*  are permitted provided that the following conditions are met:                     */
/*                                                                                    */
/*  - Redistributions of source code must retain the above copyright notice, this     */
/*  list of conditions and the following disclaimer.                                  */
/*                                                                                    */
/*  - Redistributions in binary form must reproduce the above copyright notice, this  */
/*  list of conditions and the following disclaimer in the documentation and/or       */
/*  other materials provided with the distribution.                                   */
/*                                                                                    */
/*  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND   */
/*  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED     */
/*  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE            */
/*  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR  */
/*  ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES    */
/*  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;      */
/*  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON    */
/*  ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT           */
/*  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS     */
/*  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.                      */
/*                                                                                    */
/**************************************************************************************/

#ifndef VirtualDirectory_INCUDE_ONCE
#define VirtualDirectory_INCUDE_ONCE

#include <vlCore/Object.hpp>
#include <vlCore/String.hpp>
#include <vlCore/Log.hpp>
#include <vlCore/Say.hpp>
#include <vlCore/VirtualFile.hpp>

namespace vl
{
//---------------------------------------------------------------------------
// VirtualDirectory
//---------------------------------------------------------------------------
  class VLCORE_EXPORT VirtualDirectory: public Object
  {
    VL_INSTRUMENT_ABSTRACT_CLASS(vl::VirtualDirectory, Object)

  public:
    VirtualDirectory(): mPath("/") {}

    VirtualDirectory( const String& path ): mPath(path) {}

    virtual bool setPath(const String& path);

    virtual const String& path() const { return mPath; }

    bool fileExists(const String& name) const { return file(name).get() != NULL; }

    virtual ref<VirtualFile> file(const String& name) const = 0;

    virtual void listFilesRecursive(std::vector<String>& file_list) const = 0;

    virtual void listFilesRecursive(std::vector<String>& file_list, const String& match) const
    {
      listFilesRecursive(file_list);
      if (match != "*")
        String::filterStrings(file_list, match);
    }

    virtual void listFiles(std::vector<String>& file_list, bool append=false) const = 0;

    virtual void listSubDirs(std::vector<String>& dirs, bool append=false) const = 0;

    virtual ref<VirtualDirectory> subDir(const String& subdir_name) const  = 0;

  protected:
    String translatePath(const String& p) const;

  protected:
    String mPath;
  };
}

#endif