JsonPointer.h

Go to the documentation of this file.

/*
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 *
 * JsonPointer.h
 * An implementation of RFC 6901.
 * Copyright (C) 2014 Simon Newton
 */

#ifndef INCLUDE_OLA_WEB_JSONPOINTER_H_
#define INCLUDE_OLA_WEB_JSONPOINTER_H_

#include <ola/base/Macro.h>
#include <sstream>
#include <string>
#include <vector>

namespace ola {
namespace web {

class JsonPointer {
 public:
  class Iterator {
   public:
     explicit Iterator(const JsonPointer *pointer)
        : m_pointer(pointer),
          m_index(0) {
     }

     bool IsValid() const {
       return m_index < m_pointer->TokenCount();
     }

     bool AtEnd() const {
      return m_index + 1 == m_pointer->TokenCount();
     }

     Iterator& operator++() {
        m_index++;
        return *this;
     }

     Iterator& operator++(int) {
        m_index++;
        return *this;
     }

     std::string operator*() const {
       return m_pointer->TokenAt(m_index);
     }

   private:
    const JsonPointer *m_pointer;
    unsigned int m_index;
  };

  JsonPointer();
  JsonPointer(const JsonPointer &other);

  explicit JsonPointer(const std::string &path);

  bool operator==(const JsonPointer &other) const;

  bool IsValid() const { return m_is_valid; }

  Iterator begin() const {
    return Iterator(this);
  }

  unsigned int TokenCount() const {
    return m_tokens.size() + 1;
  }

  std::string TokenAt(unsigned int i) const {
    if (i >= m_tokens.size()) {
      return "";
    } else {
      return m_tokens[i];
    }
  }

  void Push(const std::string &token);

  void Pop();

  std::string ToString() const;

  bool IsPrefixOf(const JsonPointer &other) const;

 private:
  typedef std::vector<std::string> Tokens;

  bool m_is_valid;
  Tokens m_tokens;

  static std::string EscapeString(const std::string &input);
  static std::string UnEscapeString(const std::string &input);

  void operator=(const JsonPointer&);
};
}  // namespace web
}  // namespace ola
#endif  // INCLUDE_OLA_WEB_JSONPOINTER_H_