tools/qdoc3/dcfsection.cpp
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 #include <qfile.h>
       
    43 #include <qfileinfo.h>
       
    44 #include <qtextstream.h>
       
    45 
       
    46 #include "dcfsection.h"
       
    47 #include "htmlgenerator.h"
       
    48 
       
    49 QT_BEGIN_NAMESPACE
       
    50 
       
    51 void appendDcfSubSection( DcfSection *dcfSect, const DcfSection& sub )
       
    52 {
       
    53     dcfSect->subsections.append( sub );
       
    54 }
       
    55 
       
    56 void appendDcfSubSections( DcfSection *dcfSect, const QList<DcfSection>& subs )
       
    57 {
       
    58     dcfSect->subsections += subs;
       
    59 }
       
    60 
       
    61 void generateDcfSubSections( QString indent, QTextStream& out, const DcfSection& sect )
       
    62 {
       
    63     QList<DcfSection>::const_iterator ss = sect.subsections.constBegin();
       
    64     while ( ss != sect.subsections.constEnd() ) {
       
    65 	out << indent << "<section ref=\"" << HtmlGenerator::cleanRef(HtmlGenerator::protect((*ss).ref))
       
    66             << "\" title=\"" << HtmlGenerator::protect((*ss).title) << "\"";
       
    67 	if ((*ss).keywords.isEmpty() && (*ss).subsections.isEmpty()) {
       
    68 	    out << "/>\n";
       
    69 	} else {
       
    70 	    out << ">\n";
       
    71 	    QString indentIndent = indent + "    ";
       
    72 	    QList<QPair<QString, QString> >::const_iterator k = (*ss).keywords.constBegin();
       
    73 	    while ( k != (*ss).keywords.constEnd() ) {
       
    74 		out << indentIndent << "<keyword ref=\"" << HtmlGenerator::cleanRef((*k).second) << "\">"
       
    75                     << HtmlGenerator::protect((*k).first) << "</keyword>\n";
       
    76 		++k;
       
    77 	    }
       
    78 
       
    79             generateDcfSubSections( indentIndent, out, *ss );
       
    80 	    out << indent << "</section>\n";
       
    81 	}
       
    82 	++ss;
       
    83     }
       
    84     out.flush();
       
    85 }
       
    86 
       
    87 void generateDcfSections( const DcfSection& rootSect, const QString& fileName,
       
    88 			  const QString& /* category */ )
       
    89 {
       
    90     QFile file(fileName);
       
    91     if (!file.open(QFile::WriteOnly | QFile::Text))
       
    92         return ;
       
    93 
       
    94     QTextStream out(&file);
       
    95 
       
    96     QString icon = QFileInfo(fileName).baseName() + ".png";
       
    97 
       
    98     out << "<!DOCTYPE DCF>\n";
       
    99     out << "<DCF ref=\"" << HtmlGenerator::cleanRef(HtmlGenerator::protect(rootSect.ref));
       
   100     if (icon != "qmake.png")
       
   101 	out << "\" icon=\"" << HtmlGenerator::protect(icon);
       
   102     out << "\" imagedir=\"../../gif\" title=\"" << HtmlGenerator::protect(rootSect.title) +
       
   103 	      "\">\n";
       
   104 
       
   105     generateDcfSubSections( "", out, rootSect );
       
   106 
       
   107     out << "</DCF>\n";
       
   108     out.flush();
       
   109 }
       
   110 
       
   111 QT_END_NAMESPACE