/****************************************************************************
**
** Copyright (C) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the Qt Script Generator project on Qt Labs.
**
** $QT_BEGIN_LICENSE:LGPL$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights.  These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
**
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef GENERATOR_H
#define GENERATOR_H

#include "abstractmetalang.h"

#include <QObject>
#include <QFile>

class Generator : public QObject
{
  Q_OBJECT

  Q_PROPERTY(QString outputDirectory READ outputDirectory WRITE setOutputDirectory)

public:
  enum Option : uint32_t {
    NoOption = 0x00000000,
    BoxedPrimitive = 0x00000001,
    ExcludeConst = 0x00000002,
    ExcludeReference = 0x00000004,
    UseNativeIds = 0x00000008,

    EnumAsInts = 0x00000010,
    SkipName = 0x00000020,
    NoCasts = 0x00000040,
    SkipReturnType = 0x00000080,
    OriginalName = 0x00000100,
    ShowStatic = 0x00000200,
    UnderscoreSpaces = 0x00000400,
    ForceEnumCast = 0x00000800,
    ArrayAsPointer = 0x00001000,
    VirtualCall = 0x00002000,
    SkipTemplateParameters = 0x00004000,
    SkipAttributes = 0x00008000,
    OriginalTypeDescription = 0x00010000,
    SkipRemovedArguments = 0x00020000,
    IncludeDefaultExpression = 0x00040000,
    NoReturnStatement = 0x00080000,
    NoBlockedSlot = 0x00100000,

    SuperCall = 0x00200000,
    // The following options have been added for PythonQt:
    FirstArgIsWrappedObject = 0x00400000,
    ConvertReferenceToPtr = 0x00800000,
    UseIndexedName = 0x01000000,
    ProtectedEnumAsInts = 0x02000000,
    AddOwnershipTemplates = 0x04000000,

    ForceValueType = ExcludeReference | ExcludeConst
  };

  Generator();

  void setClasses(const AbstractMetaClassList& classes) { m_classes = classes; }
  AbstractMetaClassList classes() const { return m_classes; }

  QString outputDirectory() const { return m_out_dir; }
  void setOutputDirectory(const QString& outDir) { m_out_dir = outDir; }
  virtual void generate();
  void printClasses();

  int numGenerated() { return m_num_generated; }
  int numGeneratedAndWritten() { return m_num_generated_written; }

  virtual bool shouldGenerate(const AbstractMetaClass*) const { return true; }
  virtual QString subDirectoryForClass(const AbstractMetaClass* java_class) const;
  virtual QString fileNameForClass(const AbstractMetaClass* java_class) const;
  virtual void write(QTextStream& s, const AbstractMetaClass* java_class);

  bool hasDefaultConstructor(const AbstractMetaType* type);

  // QtScript
  void setQtMetaTypeDeclaredTypeNames(const QSet<QString>& names) { m_qmetatype_declared_typenames = names; }
  QSet<QString> qtMetaTypeDeclaredTypeNames() const { return m_qmetatype_declared_typenames; }

protected:

  void verifyDirectoryFor(const QFile& file);

  AbstractMetaClassList m_classes;
  int m_num_generated;
  int m_num_generated_written;
  QString m_out_dir;

  // QtScript
  QSet<QString> m_qmetatype_declared_typenames;
};

class Indentor
{
public:
  Indentor()
    : indent(0)
  {
  }
  int indent;
};

class Indentation
{
public:
  Indentation(Indentor& indentor)
    : indentor(indentor)
  {
    indentor.indent++;
  }
  ~Indentation() { indentor.indent--; }

private:
  Indentor& indentor;
};

inline QTextStream& operator<<(QTextStream& s, const Indentor& indentor)
{
  for (int i = 0; i < indentor.indent; ++i)
    s << "    ";
  return s;
}

#endif // GENERATOR_H
