config.h

Go to the documentation of this file.

/*
 * Copyright (c) 2012, Willow Garage, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the Willow Garage, Inc. nor the names of its
 *       contributors may be used to endorse or promote products derived from
 *       this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef CONFIG_H
#define CONFIG_H

#include <stdio.h>

#include <string>

#include <boost/shared_ptr.hpp>

#include <QMap>
#include <QString>
#include <QVariant>

namespace rviz
{

class Config
{
private:
  class Node;
  typedef boost::shared_ptr<Node> NodePtr;

public:
  Config();
  Config( const Config& source );
  Config( QVariant value );

  void copy( const Config& source );

  enum Type { Map, List, Value, Empty, Invalid };

  Type getType() const;

  void setType( Type new_type );

  bool isValid() const;

  void mapSetValue( const QString& key, QVariant value );

  Config mapMakeChild( const QString& key );

  Config mapGetChild( const QString& key ) const;

  bool mapGetValue( const QString& key, QVariant *value_out ) const;

  bool mapGetInt( const QString& key, int *value_out ) const;

  bool mapGetFloat( const QString& key, float *value_out ) const;

  bool mapGetBool( const QString& key, bool *value_out ) const;

  bool mapGetString( const QString& key, QString *value_out ) const;

  void setValue( const QVariant& value );

  QVariant getValue() const;

  int listLength() const;

  Config listChildAt( int i ) const;

  Config listAppendNew();

  class MapIterator
  {
  public:
    void advance();

    bool isValid();
  
    void start();

    QString currentKey();

    Config currentChild();

  private:
    MapIterator();

    Config::NodePtr node_;
    QMap<QString, Config::NodePtr>::const_iterator iterator_;
    bool iterator_valid_;
    friend class Config;
  };

  MapIterator mapIterator() const;

private:
  Config( NodePtr node );
  static Config invalidConfig();

  void makeValid();

  NodePtr node_;

  friend class MapIterator;
};

} // end namespace rviz

#endif // CONFIG_H