ground/gcs/src/libs/utils/codegeneration.h

   1 /**
   2  ******************************************************************************
   3  *
   4  * @file       codegeneration.h
   5  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
   6  *             Parts by Nokia Corporation (qt-info@nokia.com) Copyright (C) 2009.
   7  * @brief
   8  * @see        The GNU Public License (GPL) Version 3
   9  * @defgroup
  10  * @{
  11  *
  12  *****************************************************************************/
  13 /*
  14  * This program is free software; you can redistribute it and/or modify
  15  * it under the terms of the GNU General Public License as published by
  16  * the Free Software Foundation; either version 3 of the License, or
  17  * (at your option) any later version.
  18  *
  19  * This program is distributed in the hope that it will be useful, but
  20  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  21  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
  22  * for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License along
  25  * with this program; if not, write to the Free Software Foundation, Inc.,
  26  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  27  */
  28
  29 #ifndef CODEGENERATION_H
  30 #define CODEGENERATION_H
  31
  32 #include "utils_global.h"
  33 #include <QtCore/QString>
  34
  35 QT_BEGIN_NAMESPACE
  36 class QTextStream;
  37 class QStringList;
  38 QT_END_NAMESPACE
  39
  40 namespace Utils {
  41 // Convert a file name to a Cpp identifier (stripping invalid characters
  42 // or replacing them by an underscore).
  43 QTCREATOR_UTILS_EXPORT QString fileNameToCppIdentifier(const QString &s);
  44
  45 QTCREATOR_UTILS_EXPORT QString headerGuard(const QString &file);
  46
  47 QTCREATOR_UTILS_EXPORT
  48 void writeIncludeFileDirective(const QString &file,
  49                                bool globalInclude,
  50                                QTextStream &str);
  51
  52 // Write opening namespaces and return an indentation string to be used
  53 // in the following code if there are any.
  54 QTCREATOR_UTILS_EXPORT
  55 QString writeOpeningNameSpaces(const QStringList &namespaces,
  56                                const QString &indent,
  57                                QTextStream &str);
  58
  59 // Close namespacesnamespaces
  60 QTCREATOR_UTILS_EXPORT
  61 void writeClosingNameSpaces(const QStringList &namespaces,
  62                             const QString &indent,
  63                             QTextStream &str);
  64 } // namespace Utils
  65
  66 #endif // CODEGENERATION_H