tools/qdoc3/dcfsection.h
changeset 0 1918ee327afb
child 4 3b1da2848fc7
equal deleted inserted replaced
-1:000000000000 0:1918ee327afb
       
     1 /****************************************************************************
       
     2 **
       
     3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
       
     4 ** All rights reserved.
       
     5 ** Contact: Nokia Corporation (qt-info@nokia.com)
       
     6 **
       
     7 ** This file is part of the tools applications of the Qt Toolkit.
       
     8 **
       
     9 ** $QT_BEGIN_LICENSE:LGPL$
       
    10 ** No Commercial Usage
       
    11 ** This file contains pre-release code and may not be distributed.
       
    12 ** You may use this file in accordance with the terms and conditions
       
    13 ** contained in the Technology Preview License Agreement accompanying
       
    14 ** this package.
       
    15 **
       
    16 ** GNU Lesser General Public License Usage
       
    17 ** Alternatively, this file may be used under the terms of the GNU Lesser
       
    18 ** General Public License version 2.1 as published by the Free Software
       
    19 ** Foundation and appearing in the file LICENSE.LGPL included in the
       
    20 ** packaging of this file.  Please review the following information to
       
    21 ** ensure the GNU Lesser General Public License version 2.1 requirements
       
    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
       
    23 **
       
    24 ** In addition, as a special exception, Nokia gives you certain additional
       
    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
       
    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
       
    27 **
       
    28 ** If you have questions regarding the use of this file, please contact
       
    29 ** Nokia at qt-info@nokia.com.
       
    30 **
       
    31 **
       
    32 **
       
    33 **
       
    34 **
       
    35 **
       
    36 **
       
    37 **
       
    38 ** $QT_END_LICENSE$
       
    39 **
       
    40 ****************************************************************************/
       
    41 
       
    42 #ifndef DCFSECTION_H
       
    43 #define DCFSECTION_H
       
    44 
       
    45 #include <qlist.h>
       
    46 #include <qpair.h>
       
    47 #include <qstring.h>
       
    48 
       
    49 QT_BEGIN_NAMESPACE
       
    50 
       
    51 class QTextStream;
       
    52 
       
    53 struct DcfSection
       
    54 {
       
    55     QString title;
       
    56     QString ref;
       
    57     QList<QPair<QString, QString> > keywords;
       
    58     QList<DcfSection> subsections;
       
    59 };
       
    60 
       
    61 inline bool operator<( const DcfSection& s1, const DcfSection& s2 ) {
       
    62     QString title1 = s1.title;
       
    63     QString title2 = s2.title;
       
    64 
       
    65     // cheat with Q3 classes
       
    66     if (title1.startsWith("Q3"))
       
    67         title1.insert(1, '~');
       
    68     if (title2.startsWith("Q3"))
       
    69         title2.insert(1, '~');
       
    70 
       
    71     int delta = title1.toLower().compare( title2.toLower() );
       
    72     if ( delta == 0 ) {
       
    73 	delta = title1.compare( title2 );
       
    74 	if ( delta == 0 )
       
    75 	    delta = s1.ref.localeAwareCompare( s2.ref );
       
    76     }
       
    77     return delta < 0;
       
    78 }
       
    79 
       
    80 inline bool operator>( const DcfSection& s1, const DcfSection& s2 ) { return s2 < s1; }
       
    81 inline bool operator<=( const DcfSection& s1, const DcfSection& s2 ) { return !( s2 < s1 ); }
       
    82 inline bool operator>=( const DcfSection& s1, const DcfSection& s2 ) { return !( s1 < s2 ); }
       
    83 inline bool operator==( const DcfSection& s1, const DcfSection& s2 ) { return &s1 == &s2; }
       
    84 inline bool operator!=( const DcfSection& s1, const DcfSection& s2 ) { return !( s1 == s2 ); }
       
    85 
       
    86 void appendDcfSubSection(DcfSection *dcfSect, const DcfSection &sub);
       
    87 void appendDcfSubSections(DcfSection *dcfSect, const QList<DcfSection> &subs);
       
    88 void generateDcfSubSections(QString indent, QTextStream &out, const DcfSection &sect);
       
    89 void generateDcfSections(const DcfSection &rootSect, const QString& fileName,
       
    90                          const QString& category );
       
    91 
       
    92 QT_END_NAMESPACE
       
    93 
       
    94 #endif