/*=============================================================================

  Library: CTK

  Copyright (c) German Cancer Research Center,
    Division of Medical and Biological Informatics

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

=============================================================================*/

#ifndef CTKCMDLINEMODULEOBJECTTREEWALKER_H
#define CTKCMDLINEMODULEOBJECTTREEWALKER_H

#include <QStack>
#include <QString>

class QObject;
class QVariant;

/**
 * \class ctkCmdLineModuleObjectTreeWalker
 * \brief Non-exported helper class to iterate through GUI widgets.
 * \ingroup CommandLineModulesFrontendQtGui
 */
class ctkCmdLineModuleObjectTreeWalker
{

public:

  enum TokenType {
    NoToken,
    Executable,
    ParameterGroup,
    ParameterContainer,
    Parameter
  };

  ctkCmdLineModuleObjectTreeWalker(QObject* root = 0);
  ~ctkCmdLineModuleObjectTreeWalker();

  void setRootObject(QObject* root);
  void clear();

  bool atEnd() const;

  bool isParameterGroup() const;
  bool isParameterContainer() const;
  bool isParameter() const;

  QString name() const;
  QString label() const;
  QVariant value(const QString& propertyName = QString()) const;

  void setValue(const QVariant& value, const QString& propertyName = QString());

  QString flag() const;
  QString longFlag() const;
  int index() const;

  bool isMultiple() const;


  QVariant property(const QString& propName) const;

  TokenType readNext();
  bool readNextExecutable();
  bool readNextParameterGroup();
  bool readNextParameterContainer();
  bool readNextParameter();

  TokenType tokenType() const;

private:

  TokenType token(QObject* obj);
  bool setCurrent(QObject* obj);
  QVariant prefixedProperty(const QString& propName) const;

  QObject* RootObject;
  QObject* CurrentObject;

  TokenType CurrentToken;
  bool AtEnd;

  QStack<QObject*> ObjectStack;

};

#endif // CTKCMDLINEMODULEOBJECTTREEWALKER_H
