KeyValueDirectory.h

Go to the documentation of this file.

// this is for emacs file handling -*- mode: c++; indent-tabs-mode: nil -*-

// -- BEGIN LICENSE BLOCK ----------------------------------------------
// This file is part of FZIs ic_workspace.
//
// This program is free software licensed under the LGPL
// (GNU LESSER GENERAL PUBLIC LICENSE Version 3).
// You can find a copy of this license in LICENSE folder in the top
// directory of the source code.
//
// © Copyright 2014 FZI Forschungszentrum Informatik, Karlsruhe, Germany
//
// -- END LICENSE BLOCK ------------------------------------------------

//----------------------------------------------------------------------
//----------------------------------------------------------------------
#ifndef ICL_CORE_KEY_VALUE_DIRECTORY_H_INCLUDED
#define ICL_CORE_KEY_VALUE_DIRECTORY_H_INCLUDED

#include <boost/regex.hpp>

#include "icl_core/BaseTypes.h"
#include "icl_core/Map.h"
#include "icl_core/TemplateHelper.h"

#ifdef _IC_BUILDER_DEPRECATED_STYLE_
# include "icl_core/Deprecate.h"
#endif

namespace icl_core {

template <typename T>
class KeyValueDirectoryIterator;

template <typename T>
class KeyValueDirectory
{
  friend class KeyValueDirectoryIterator<T>;
public:

  KeyValueDirectoryIterator<T> find(const String& query) const;

  bool get(const String& key, typename ConvertToRef<T>::ToRef value) const;

  bool hasKey(const String& key) const;

  bool insert(const String& key, typename ConvertToRef<T>::ToConstRef value);

#ifdef _IC_BUILDER_DEPRECATED_STYLE_

  KeyValueDirectoryIterator<T> ICL_CORE_VC_DEPRECATE_STYLE
  Find(const String& query) const ICL_CORE_GCC_DEPRECATE_STYLE;

  bool ICL_CORE_VC_DEPRECATE_STYLE
  Get(const String& key, typename ConvertToRef<T>::ToRef value) const ICL_CORE_GCC_DEPRECATE_STYLE;

  bool ICL_CORE_VC_DEPRECATE_STYLE HasKey(const String& key) const ICL_CORE_GCC_DEPRECATE_STYLE;

  bool ICL_CORE_VC_DEPRECATE_STYLE
  Insert(const String& key, typename ConvertToRef<T>::ToConstRef value) ICL_CORE_GCC_DEPRECATE_STYLE;

#endif


private:
  typedef Map<String, T> KeyValueMap;
  KeyValueMap m_items;
};

template <typename T>
class KeyValueDirectoryIterator
{
public:
  KeyValueDirectoryIterator(const String& query, const KeyValueDirectory<T> *directory);

  String key() const;

  String matchGroup(size_t index) const;

  bool next();

  void reset();

  typename ConvertToRef<T>::ToConstRef value() const;

#ifdef _IC_BUILDER_DEPRECATED_STYLE_

  ICL_CORE_VC_DEPRECATE_STYLE String Key() const ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE String MatchGroup(size_t index) const ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE bool Next() ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void Reset() ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE typename ConvertToRef<T>::ToConstRef Value() const ICL_CORE_GCC_DEPRECATE_STYLE;

#endif


private:
  const KeyValueDirectory<T> *m_directory;
  boost::regex m_query;
  boost::match_results<icl_core::String::const_iterator> m_current_results;

  typename KeyValueDirectory<T>::KeyValueMap::const_iterator m_current_entry;
  bool m_reset;
};

}

#include "icl_core/KeyValueDirectory.hpp"

#endif