name-component.h

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil -*- */
/*
 * Copyright (c) 2013, Regents of the University of California
 *                     Alexander Afanasyev
 *
 * BSD license, See the LICENSE file for more information
 *
 * Author: Alexander Afanasyev <alexander.afanasyev@ucla.edu>
 */

#ifndef NDN_NAME_COMPONENT_H
#define NDN_NAME_COMPONENT_H

#include "blob.h"

NDN_NAMESPACE_BEGIN

namespace name {

class Component : public Blob
{
public:
  Component ();

  Component (const std::string &uri);

  Component (std::string::const_iterator begin, std::string::const_iterator end);
  
  Component (const void *buf, size_t length);

  int
  compare (const Component &other) const;
  
  inline bool
  operator <= (const Component &other) const;

  inline bool
  operator < (const Component &other) const;

  inline bool
  operator >= (const Component &other) const;

  inline bool
  operator > (const Component &other) const;

  // Component construction helpers //

  Component &
  fromUri (const std::string &uri);

  Component &
  fromUri (std::string::const_iterator begin, std::string::const_iterator end);
  
  Component &
  fromNumber (uint64_t number);

  Component &
  fromNumberWithMarker (uint64_t number, unsigned char marker);
  
  // helpers
  
  std::string
  toBlob () const;

  void
  toBlob (std::ostream &os) const;

  std::string
  toUri () const;

  void
  toUri (std::ostream &os) const;
  
  uint64_t
  toNumber () const;

  uint64_t
  toNumberWithMarker (unsigned char marker) const;

  inline uint64_t
  toSeqNum () const;
  
  inline uint64_t
  toControlNum () const;

  inline uint64_t
  toBlkId () const;

  inline uint64_t
  toVersion () const;
};

bool
Component::operator <= (const Component &other) const
{
  return (compare (other) <= 0);
}

bool
Component::operator < (const Component &other) const
{
  return (compare (other) < 0);
}

bool
Component::operator >= (const Component &other) const
{
  return (compare (other) >= 0);
}

bool
Component::operator > (const Component &other) const
{
  return (compare (other) > 0);
}

inline uint64_t
Component::toSeqNum () const
{
  return toNumberWithMarker (0x00);
}
  
inline uint64_t
Component::toControlNum () const
{
  return toNumberWithMarker (0xC1);
}

inline uint64_t
Component::toBlkId () const
{
  return toNumberWithMarker (0xFB);
}

inline uint64_t
Component::toVersion () const
{
  return toNumberWithMarker (0xFD);
}

inline std::ostream&
operator <<(std::ostream &os, const Component &name)
{
  name.toUri (os);
  return os;
}

} // name

NDN_NAMESPACE_END

#endif // NDN_NAME_COMPONENT_H