Filename.h

Go to the documentation of this file.

/*
 * Filename.h
 *
 * Smalltalk like class library for C++
 * File name handler and tools. Header.
 *
 * Copyright (c) 2004 Milan Cermak
 */
/*
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This 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 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
#ifndef __FILENAME_H
#define __FILENAME_H

#include <stlib/Object.h>

#include <stlib/ByteArray.h>
#include <stlib/ExternalReadStream.h>
#include <stlib/ExternalReadAppendStream.h>
#include <stlib/ExternalWriteStream.h>
#include <stlib/FileAccessor.h>
#include <stlib/OrderedCollection.h>
#include <stlib/Stream.h>
#include <stlib/String.h>

namespace Tools {

class FileEncodedStreamFactory;

class Filename : public Core::Object
{
  protected:
    String *public_name;
    char *local_name;

  public:
    Filename(String *name);
    Filename(const char *name);
    virtual ~Filename(void);

    /* Class-accessing protocol */
    virtual String *className(void) const;

    /* Instance creation protocol */
    virtual Filename *construct(String *extra);
    virtual Filename *construct(const char *extra);
    virtual Filename *construct(Filename *extra);
    virtual String *constructString(String *extra);

    /* Class-constants protocol */
    static Character *separator(void);

    /* Class-defaults protocol */
    static Filename *currentDirectory(void);
    static String *currentDirectoryString(void);

    /* Class-utilities protocol */
    static OrderedCollection *filesMatching(String *pattern);

    /* Class-testing protocol */
    static bool isCaseSensitive(void);

    /* Accessing protocol */
    virtual const char *localName(void) const;

    /* Comparing protocol */
    virtual long hash(void) const;
    virtual bool isEqual(const Object *) const;
    virtual bool isEqual(const Object &object) const
      { return Object::isEqual(object); }

    /* Converting protocol */
    virtual Filename *asFilename(void);
    virtual String *asString(void) const;

    /* File utilities protocol */
    virtual void beCurrentDirectory(void);
    virtual void copyTo(Filename *destName);
    virtual void copyTo(String *destName);
    virtual OrderedCollection *directoryContents(void);
    virtual void erase(void);
    virtual long fileSize(void);
    virtual void makeDirectory(void);
    virtual void moveTo(Filename *destName);
    virtual void moveTo(String *destName);
    virtual void renameTo(Filename *destName);
    virtual void renameTo(String *destName);

    /* Parsing protocol */
    static Filename *baseDirectoryForList(OrderedCollection *list);
    static String *readBaseLocationFromStream(PositionableStream *stream);
    virtual OrderedCollection *components(void);
    static OrderedCollection *components(String *name);
    virtual Filename *directory(void);
    virtual String *extension(void);
    virtual String *head(void);
    virtual String *tail(void);

    /* Printing protocol */
    virtual void printOn(Stream *stream);

    /* Stream creation protocol */
    virtual FileEncodedStreamFactory *withEncoding(String *encoding);
    virtual FileEncodedStreamFactory *withEncoding(const char *encoding);
    virtual ExternalWriteStream *appendStream(void);
    virtual ExternalReadStream *readStream(void);
    virtual ExternalReadAppendStream *readAppendStream(void);
    virtual ExternalWriteStream *writeStream(void);

    /* Testing protocol */
    virtual bool exists(void);
    virtual bool isAbsolute(void);
    virtual bool isDirectory(void);
    virtual bool isReadable(void);
    virtual bool isRelative(void);
    virtual bool isWritable(void);

    /* Utilities protocol */
    virtual ByteArray *contentOfEntireFile(void);

    /* Private protocol */
    virtual OrderedCollection *filesMatchingAccessList(OrderedCollection *list,
                                                       OrderedCollection *result);
    virtual long lastSeparatorIndex(void);
    virtual void privateCopy(FileAccessor *read, FileAccessor *write);
    virtual OrderedCollection *privFilesMatchingAccessList(OrderedCollection *list,
                                                           OrderedCollection *result);
    static void setCurrentDirectory(Filename *directory);
};

};

#endif /* __FILENAME_H */

---