tools/qdoc3/polyarchiveextractor.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 /*
       
    43   polyarchiveextractor.cpp
       
    44 */
       
    45 
       
    46 #include "command.h"
       
    47 #include "polyarchiveextractor.h"
       
    48 
       
    49 QT_BEGIN_NAMESPACE
       
    50 
       
    51 /*!
       
    52   \class PolyArchiveExtractor
       
    53   
       
    54   \brief The PolyArchiveExtractor class is a class for unpacking
       
    55   archive files.
       
    56 
       
    57   This subclass of ArchiveExtractor contains a parameterized
       
    58   command for doing the archive extraction.
       
    59 
       
    60   It has an extractArchive() function you call to do the
       
    61   actual archive extraction.
       
    62  */
       
    63 
       
    64 /*!
       
    65   The constructor takes the list of filename \a extensions,
       
    66   which it passes to the base class, and the \a commandFormat,
       
    67   which it stores locally. The \a commandFormat is a command
       
    68   template string.
       
    69  */
       
    70 PolyArchiveExtractor::PolyArchiveExtractor( const QStringList& extensions,
       
    71 					    const QString& commandFormat )
       
    72     : ArchiveExtractor( extensions ), cmd( commandFormat )
       
    73 {
       
    74 }
       
    75 
       
    76 /*!
       
    77   The destructor doesn't have to do anything.
       
    78  */
       
    79 PolyArchiveExtractor::~PolyArchiveExtractor()
       
    80 {
       
    81 }
       
    82 
       
    83 /*!
       
    84   Call this function to do the actual archive extraction. It calls
       
    85   the executeCommand() function to do the work. That's all it does.
       
    86  */
       
    87 void PolyArchiveExtractor::extractArchive( const Location& location,
       
    88 					   const QString& filePath,
       
    89 					   const QString& outputDir )
       
    90 {
       
    91     executeCommand( location, cmd, QStringList() << filePath << outputDir );
       
    92 }
       
    93 
       
    94 QT_END_NAMESPACE