filepath.h

Go to the documentation of this file.

/*
 * filepath.h
 *
 * File system path string abstraction class.
 *
 * Portable Windows Library
 *
 * Copyright (c) 1993-1998 Equivalence Pty. Ltd.
 *
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 *
 * The Original Code is Portable Windows Library.
 *
 * The Initial Developer of the Original Code is Equivalence Pty. Ltd.
 *
 * Portions are Copyright (C) 1993 Free Software Foundation, Inc.
 * All Rights Reserved.
 *
 * Contributor(s): ______________________________________.
 */

#ifndef PTLIB_FILEPATH_H
#define PTLIB_FILEPATH_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif


#ifdef DOC_PLUS_PLUS

class PFilePathString : public PString { };
#endif


// File Specification

class PFilePath : public PFilePathString
{
  PCLASSINFO(PFilePath, PFilePathString);

  public:
    PFilePath();

    PFilePath(
      const char * cstr   
    );

    PFilePath(
      const PString & str 
    );

    PFilePath(
      const PFilePath & path 
    );

    PFilePath(
      const char * prefix,  
      const char * dir,     
      const char * suffix = NULL 
    );

    PFilePath & operator=(
      const PFilePath & path 
    );
    PFilePath & operator=(
      const PString & str 
    );
    PFilePath & operator=(
      const char * cstr 
    );

    PFilePath & operator+=(
      const PString & str   
    );

    PFilePath & operator+=(
      const char * cstr  
    );

    PFilePath & operator+=(
      char ch   // Character to concatenate.
    );

    PFilePathString GetVolume() const;
      
    PFilePathString GetPath() const;

    PFilePathString GetTitle() const;

    PFilePathString GetType() const;

    PFilePathString GetFileName() const;

    PDirectory GetDirectory() const;

    void SetType(
      const PFilePathString & type  
    );

    static bool IsValid(
      char c    
    );

    static bool IsValid(
      const PString & str   
    );

    static PFilePathString Sanitise(
      const PString & str,    
      const PString & extra = PString::Empty(), 
      char substitute = '_'   
    );

    static bool IsAbsolutePath(
      const PString & path   
    );

    // Internal function to take partial path and make a full canonical path from it.
    static PFilePathString Canonicalise(const PFilePathString & path, bool isDirectory);

  protected:
    virtual void AssignContents(const PContainer & cont);


// Include platform dependent part of class
#ifdef _WIN32
#include "msos/ptlib/filepath.h"
#else
#include "unix/ptlib/filepath.h"
#endif
};


#endif // PTLIB_FILEPATH_H


// End Of File ///////////////////////////////////////////////////////////////