farsamiscutilities.h

Go to the documentation of this file.

/********************************************************************************
 *  FARSA Utilities Library                                                     *
 *  Copyright (C) 2007-2012                                                     *
 *  Gianluca Massera <emmegian@yahoo.it>                                        *
 *  Stefano Nolfi <stefano.nolfi@istc.cnr.it>                                   *
 *  Tomassino Ferrauto <tomassino.ferrauto@istc.cnr.it>                         *
 *                                                                              *
 *  This program is free software; you can redistribute it and/or modify        *
 *  it under the terms of the GNU General Public License as published by        *
 *  the Free Software Foundation; either version 2 of the License, or           *
 *  (at your option) any later version.                                         *
 *                                                                              *
 *  This program is distributed in the hope that it will be useful,             *
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of              *
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               *
 *  GNU General Public License for more details.                                *
 *                                                                              *
 *  You should have received a copy of the GNU General Public License           *
 *  along with this program; if not, write to the Free Software                 *
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA  *
 ********************************************************************************/

#ifndef FARSAMISCUTILITIES_H
#define FARSAMISCUTILITIES_H

#include "utilitiesconfig.h"
#include <QString>
#include <QList>

#if defined(__GNUC__) || defined(__clang__)
    #define FARSA_DEPRECATED __attribute__((deprecated))
#elif defined(_MSC_VER)
    #define FARSA_DEPRECATED __declspec(deprecated)
#endif

namespace farsa {
    struct FARSA_UTIL_TEMPLATE CommentPosition
    {
        enum CommentType {
            CComment, 
            CppComment 
        };

        CommentPosition() :
            originalStart(0),
            originalEnd(0),
            parsedPosition(0),
            type(CComment)
        {
        }

        CommentPosition(unsigned int s, unsigned int e, unsigned int p, CommentType t) :
            originalStart(s),
            originalEnd(e),
            parsedPosition(p),
            type(t)
        {
        }

        unsigned int originalStart;

        unsigned int originalEnd;

        unsigned int parsedPosition;

        CommentType type;
    };

    typedef QList<CommentPosition> CommentsPositions;

    struct FARSA_UTIL_TEMPLATE StringPosition
    {
        enum Type {
            String, 
            Character 
        };

        StringPosition() :
            originalStart(0),
            originalEnd(0),
            parsedStart(0),
            parsedEnd(0),
            type(String)
        {
        }

        StringPosition(unsigned int os, unsigned int oe, unsigned int ps, unsigned int pe, Type t) :
            originalStart(os),
            originalEnd(oe),
            parsedStart(ps),
            parsedEnd(pe),
            type(t)
        {
        }

        unsigned int originalStart;

        unsigned int originalEnd;

        unsigned int parsedStart;

        unsigned int parsedEnd;

        Type type;
    };

    typedef QList<StringPosition> StringsPositions;

    QString FARSA_UTIL_API removeComments(const QString& program, CommentsPositions* commentsPos = NULL, StringsPositions* stringsPos = NULL);
}

#endif