Registry.cpp

Go to the documentation of this file.

#include "Registry.hh"

Registry::item_P
Registry::lookup(const uint8_t* path, size_t count)
{
  // Check for root path
  item_P item = (item_P) m_root;
  if (UNLIKELY(path == NULL)) return (item);

  // Paths should not exceed the maximum length
  if (UNLIKELY(count > PATH_MAX)) return (NULL);
  for (uint8_t i = 0; i < count; i++) {
    // Check that the current item is a list
    uint8_t ix = path[i];
    uint8_t nx = i + 1;
    type_t type = (type_t) pgm_read_byte(&item->type);
    if ((nx < count) && (type != ITEM_LIST)) return (NULL);

    // Check that the current index is within the list length
    item_list_P items = (item_list_P) item;
    uint8_t len = pgm_read_byte(&items->length);
    if (ix >= len) return (NULL);

    // Read the item and step to the next path index
    item_vec_P vec = (item_vec_P) pgm_read_word(&items->list);
    item = (item_P) pgm_read_word(&vec[ix]);
  }

  // Return path indexed item
  return (item);
}

void
Registry::print(IOStream& outs, const uint8_t* path, size_t count)
{
  // Check for root path
  item_P item = (item_P) m_root;
  if (UNLIKELY(path == NULL)) return;

  // Paths should not exceed the maximum length
  if (UNLIKELY(count > PATH_MAX)) return;
  for (uint8_t i = 0; i < count; i++) {
    // Check that the current item is a list
    uint8_t ix = path[i];
    uint8_t nx = i + 1;
    type_t type = (type_t) pgm_read_byte(&item->type);
    if ((nx < count) && (type != ITEM_LIST)) return;

    // Check that the current index is within the list length
    item_list_P items = (item_list_P) item;
    uint8_t len = pgm_read_byte(&items->length);
    if (ix >= len) return;

    // Read the item and step to the next path index
    item_vec_P vec = (item_vec_P) pgm_read_word(&items->list);
    item = (item_P) pgm_read_word(&vec[ix]);
    outs << '/' << get_name(item);
  }
}

int
Registry::run(action_P action, void* buf, size_t size)
{
  // Sanity check the parameters
  if (UNLIKELY(action == NULL)) return (EINVAL);
  if (UNLIKELY(pgm_read_byte(&action->item.type) != ACTION)) return (EINVAL);

  // Access the action object
  Action* obj = (Action*) pgm_read_word(&action->obj);
  if (UNLIKELY(obj == NULL)) return (EINVAL);

  // And run the member function
  return (obj->run(buf, size));
}

int
Registry::get_value(blob_P blob, void* buf, size_t len)
{
  // Sanity check the parameters
  if (UNLIKELY(len == 0)) return (0);
  if (UNLIKELY((blob == NULL) || (buf == NULL))) return (EINVAL);
  if (UNLIKELY(pgm_read_byte(&blob->item.type) < BLOB)) return (EINVAL);

  // Check size of blob
  size_t size = (size_t) pgm_read_word(&blob->size);
  if (UNLIKELY(size == 0)) return (0);
  if (UNLIKELY(size > len)) return (E2BIG);

  // Check where the value is stored and copy into buffer
  storage_t storage = get_storage(&blob->item);
  if (storage == IN_PROGMEM)
    memcpy_P(buf, (const void*) pgm_read_word(&blob->value), size);
  else if (storage == IN_SRAM)
    memcpy(buf, (const void*) pgm_read_word(&blob->value), size);
  else if (storage == IN_EEMEM && m_eeprom != NULL)
    m_eeprom->read(buf, (const void*) pgm_read_word(&blob->value), size);
  else return (EINVAL);

  // Return the number of bytes read
  return (size);
}

int
Registry::set_value(blob_P blob, const void* buf, size_t len)
{
  // Sanity check the parameters
  if (UNLIKELY(len == 0)) return (0);
  if (UNLIKELY((blob == NULL) || (buf == NULL))) return (EINVAL);
  if (UNLIKELY(pgm_read_byte(&blob->item.type) < BLOB)) return (EINVAL);
  if (UNLIKELY(is_readonly(&blob->item))) return (EACCES);

  // Check size of blob against given value in buffer
  size_t size = (size_t) pgm_read_word(&blob->size);
  if (UNLIKELY(size == 0)) return (0);
  if (UNLIKELY(size != len)) return (E2BIG);

  // Check where the value is stored and copy into buffer
  storage_t storage = get_storage(&blob->item);
  if (storage == IN_SRAM)
    memcpy((void*) pgm_read_word(&blob->value), buf, size);
  else if (storage == IN_EEMEM && m_eeprom != NULL)
    m_eeprom->write((void*) pgm_read_word(&blob->value), buf, size);
  else return (EINVAL);

  // Return the number of bytes written
  return (size);
}

IOStream& operator<<(IOStream& outs, Registry::item_P item)
{
  outs << PSTR("item@") << (void*) item;
  if (item == NULL) {
    outs << PSTR("(NULL)");
    return (outs);
  }
  outs << PSTR("(type = ");
  uint8_t type = Registry::get_type(item);
  switch (type) {
  case Registry::ITEM:
    outs << PSTR("ITEM");
    break;
  case Registry::ITEM_LIST:
    outs << PSTR("ITEM_LIST");
    break;
  case Registry::ACTION:
    outs << PSTR("ACTION");
    break;
  case Registry::BLOB:
    outs << PSTR("BLOB");
    break;
  default:
    outs << PSTR("APPL(") << type << ')';
  }
  outs << PSTR(", name = ") << Registry::get_name(item);
  outs << PSTR(", storage = ");
  switch (Registry::get_storage(item)) {
  case Registry::IN_SRAM:
    outs << PSTR("SRAM");
    break;
  case Registry::IN_PROGMEM:
    outs << PSTR("PROGMEM");
    break;
  case Registry::IN_EEMEM:
    outs << PSTR("EEMEM");
    break;
  default:
    outs << PSTR("???");
  }
  if (Registry::is_readonly(item)) outs << PSTR(", readonly");
  outs << PSTR(")");
  return (outs);
}

IOStream& operator<<(IOStream& outs, Registry::item_list_P list)
{
  outs << (Registry::item_P) list << endl;
  if (list == NULL) return (outs);
  Registry::Iterator iter(list);
  Registry::item_P item;
  while ((item = iter.next()) != NULL)
    outs << item << endl;
  return (outs);
}