Pattern.h

Go to the documentation of this file.

/***************************************************************************
 *
 * Copyright (C) 2009-2011 Cassio Neri Moreira
 *
 * This file is part of the KeyValue library.
 *
 * The KeyValue library 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 3 of the License, or (at
 * your option) any later version.
 *
 * The KeyValue library 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 KeyValue. If not, see <http://www.gnu.org/licenses/>.
 *
 * If you modify this library, or any covered work, by linking or combining
 * it with Excel (or a modified version of that program), containing parts
 * covered by the terms of End-User License Agreement for Microsoft
 * Software, the licensors of KeyValue grant you additional permission to
 * convey the resulting work.
 *
 **************************************************************************/

#ifndef KEYVALUE_PATTERN_PATTERN_H_
#define KEYVALUE_PATTERN_PATTERN_H_

#include <utility>

#include <boost/utility.hpp>

#include "keyvalue/extern/String.h"
#include "keyvalue/value/Value.h"

namespace keyvalue {

// Forward declarations

namespace frontend {
  class Queue;
}

namespace pattern {

class Pattern : private ::boost::noncopyable {

public:

  virtual bool
  parse(frontend::Queue& queue) = 0;

  virtual ::std::pair<string, value::Value>
  pop() = 0;

  virtual bool
  isEmpty() const = 0;

protected:

  class QueueRaii {

  public:

    QueueRaii(frontend::Queue& queue);
    ~QueueRaii();

  private:

    frontend::Queue& queue_;

  }; // class QueueRaii

}; // class Pattern

bool
isKey(const value::Variant& variant);

string
getKey(const value::Variant& variant);

} // namespace pattern
} // namespace keyvalue

#endif // KEYVALUE_PATTERN_PATTERN_H_