/* This file is part of the KDE Project
   Copyright (c) 2008 Sebastian Trueg <trueg@kde.org>

   Based on CollectionSetup.h from the Amarok project
   (C) 2003 Scott Wheeler <wheeler@kde.org>
   (C) 2004 Max Howell <max.howell@methylblue.com>
   (C) 2004 Mark Kretschmann <markey@web.de>
   (C) 2008 Seb Ruiz <ruiz@kde.org>
   (C) 2008-2009 Sebastian Trueg <trueg@kde.org>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License version 2 as published by the Free Software Foundation.

   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
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
*/

#ifndef _FOLDER_SELECTION_MODEL_H_
#define _FOLDER_SELECTION_MODEL_H_

#include <QFileSystemModel>
#include <QtCore/QSet>


class FolderSelectionModel : public QFileSystemModel
{
    Q_OBJECT

public:
    FolderSelectionModel( QObject* parent = 0 );
    virtual ~FolderSelectionModel();

    enum IncludeState {
        StateNone,
        StateInclude,
        StateExclude,
        StateIncludeInherited,
        StateExcludeInherited
    };

    enum CustomRoles {
        IncludeStateRole = 7777
    };
    
    Qt::ItemFlags flags( const QModelIndex &index ) const;
    QVariant data( const QModelIndex& index, int role = Qt::DisplayRole ) const;
    bool setData( const QModelIndex& index, const QVariant& value, int role = Qt::EditRole );

    void setFolders( const QStringList& includeDirs, const QStringList& exclude );
    QStringList includeFolders() const;
    QStringList excludeFolders() const;

    /**
     * Include the specified path. All subdirs will be reset.
     */
    void includePath( const QString& );

    /**
     * Exclude the specified path. All subdirs will be reset.
     */
    void excludePath( const QString& );

    int columnCount( const QModelIndex& ) const { return 1; }

    IncludeState includeState( const QModelIndex& ) const;
    IncludeState includeState( const QString& path ) const;

public Q_SLOTS:
    void setHiddenFoldersShown( bool shown );

private:
    bool isForbiddenPath( const QString& path ) const;

    /**
     * Returns true if any of the parent directories (direct or indirect) of the path is a symbolic link.
    */
    bool isInsideSymLinkToDirectory( const QString& path ) const;

    QSet<QString> m_included;
    QSet<QString> m_excluded;
};

#endif
