examples/xmlpatterns/filetree/filetree.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the examples of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:BSD$
   9 ** You may use this file under the terms of the BSD license as follows:
  10 **
  11 ** "Redistribution and use in source and binary forms, with or without
  12 ** modification, are permitted provided that the following conditions are
  13 ** met:
  14 **   * Redistributions of source code must retain the above copyright
  15 **     notice, this list of conditions and the following disclaimer.
  16 **   * Redistributions in binary form must reproduce the above copyright
  17 **     notice, this list of conditions and the following disclaimer in
  18 **     the documentation and/or other materials provided with the
  19 **     distribution.
  20 **   * Neither the name of Nokia Corporation and its Subsidiary(-ies) nor
  21 **     the names of its contributors may be used to endorse or promote
  22 **     products derived from this software without specific prior written
  23 **     permission.
  24 **
  25 ** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  26 ** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  27 ** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  28 ** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  29 ** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  30 ** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  31 ** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  32 ** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  33 ** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  34 ** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  35 ** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
  36 **
  37 ** $QT_END_LICENSE$
  38 **
  39 ****************************************************************************/
  40
  41 #include <QtCore/QFileInfo>
  42 #include <QtCore/QDir>
  43 #include <QtCore/QVector>
  44 #include <QtXmlPatterns/QSimpleXmlNodeModel>
  45
  46 class FileTree : public QSimpleXmlNodeModel
  47 {
  48  public:
  49     FileTree(const QXmlNamePool &namePool);
  50
  51     QXmlNodeModelIndex nodeFor(const QString &fileName) const;
  52
  53     //! [0]
  54     virtual QXmlNodeModelIndex::DocumentOrder compareOrder(const QXmlNodeModelIndex&, const QXmlNodeModelIndex&) const;
  55     virtual QXmlName name(const QXmlNodeModelIndex &node) const;
  56     virtual QUrl documentUri(const QXmlNodeModelIndex &node) const;
  57     virtual QXmlNodeModelIndex::NodeKind kind(const QXmlNodeModelIndex &node) const;
  58     virtual QXmlNodeModelIndex root(const QXmlNodeModelIndex &node) const;
  59     virtual QVariant typedValue(const QXmlNodeModelIndex &node) const;
  60     //! [0]
  61  protected:
  62     //! [1]
  63     virtual QVector<QXmlNodeModelIndex> attributes(const QXmlNodeModelIndex &element) const;
  64     virtual QXmlNodeModelIndex nextFromSimpleAxis(SimpleAxis, const QXmlNodeModelIndex&) const;
  65     //! [1]
  66
  67  private:
  68     //! [4]
  69     enum Type {
  70         File,
  71         Directory,
  72         AttributeFileName,
  73         AttributeFilePath,
  74         AttributeSize,
  75         AttributeMIMEType,
  76         AttributeSuffix
  77     };
  78     //! [4]
  79
  80     inline QXmlNodeModelIndex nextSibling(const QXmlNodeModelIndex &nodeIndex,
  81                                           const QFileInfo &from,
  82                                           qint8 offset) const;
  83     inline const QFileInfo &toFileInfo(const QXmlNodeModelIndex &index) const;
  84     inline QXmlNodeModelIndex toNodeIndex(const QFileInfo &index,
  85                                           Type attributeName) const;
  86     inline QXmlNodeModelIndex toNodeIndex(const QFileInfo &index) const;
  87
  88     /*
  89      One possible improvement is to use a hash, and use the &*&value()
  90      trick to get a pointer, which would be stored in data() instead
  91      of the index.
  92     */
  93     //! [2]
  94     mutable QVector<QFileInfo>  m_fileInfos;
  95     const QDir::Filters         m_filterAllowAll;
  96     const QDir::SortFlags       m_sortFlags;
  97     QVector<QXmlName>           m_names;
  98     //! [2]
  99 };
 100
 101     //! [3]
 102     //! [3]