//----------------------------------------------------------------------
//  This software is part of the OpenBeOS distribution and is covered 
//  by the OpenBeOS license.
//
//  File Name: SymLink.h
//---------------------------------------------------------------------
/*!
	\file SymLink.h
	BSymLink interface declaration.
*/

#ifndef __sk_sym_link_h__
#define __sk_sym_link_h__

#include <Node.h>
#include <StorageDefs.h>
#include "kernel_interface.h"

#ifdef USE_OPENBEOS_NAMESPACE
namespace OpenBeOS {
#endif

/*!
	\class BSymLink
	\brief A symbolic link in the filesystem
	
	Provides an interface for manipulating symbolic links.

	\author <a href='mailto:bonefish@users.sf.net'>Ingo Weinhold</a>
	
	\version 0.0.0
*/
class BSymLink : public BNode {
public:
	BSymLink();
	BSymLink(const BSymLink &link);
	BSymLink(const entry_ref *ref);
	BSymLink(const BEntry *entry);
	BSymLink(const char *path);
	BSymLink(const BDirectory *dir, const char *path);
	virtual ~BSymLink();

	// WORKAROUND
	// SetTo() methods: Part of a work around until someone has an idea how to
	// get StorageKit::read_link(FileDescriptor,...) to work.
	status_t SetTo(const entry_ref *ref);
	status_t SetTo(const BEntry *entry);
	status_t SetTo(const char *path);
	status_t SetTo(const BDirectory *dir, const char *path);
	void Unset();

	ssize_t ReadLink(char *buf, size_t size);

	ssize_t MakeLinkedPath(const char *dirPath, BPath *path);
	ssize_t MakeLinkedPath(const BDirectory *dir, BPath *path);

	bool IsAbsolute();

	// WORKAROUND
	// operator=(): Part of a work around until someone has an idea how to
	// get StorageKit::read_link(FileDescriptor,...) to work.
	BSymLink &operator=(const BSymLink &link);

private:
	virtual void _ReservedSymLink1();
	virtual void _ReservedSymLink2();
	virtual void _ReservedSymLink3();
	virtual void _ReservedSymLink4();
	virtual void _ReservedSymLink5();
	virtual void _ReservedSymLink6();

	// WORKAROUND
	// fSecretEntry: Part of a work around until someone has an idea how to
	// get StorageKit::read_link(FileDescriptor,...) to work.
//	uint32 _reservedData[4];
	uint32 _reservedData[3];
	BEntry *fSecretEntry;

private:
	StorageKit::FileDescriptor get_fd() const;
};

#ifdef USE_OPENBEOS_NAMESPACE
};		// namespace OpenBeOS
#endif

#endif	// __sk_sym_link_h__