flags.h

Go to the documentation of this file.

#ifndef TOC_TABLE_FLAGS_H_INCLUDED
#define TOC_TABLE_FLAGS_H_INCLUDED
/**********************************************************************/
/*
 * Copyright (c) 2014-2015, Jetro AS
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 3. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONRIBUTORS ``AS IS'' AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
 * OF SUCH DAMAGE.
 *
 * This file is part of the EVE platform.
 */

/**
 * \file
 * @brief A part of TOC table compile-time generator
 *
 * @author DT, Jetro AS
 */ /******************************************************************/

#include <stdint.h>
#include <toc/toc-app.h>

/***********************************************************************
 * Interface
***********************************************************************/

/** Common base for the flags */
struct CTocFlagsBase
{
  static constexpr bool ble = false;
  static constexpr uint16_t set   = 0;
  static constexpr uint16_t reset = 0;
};

/** READ ONLY flag */
struct RO
 : public CTocFlagsBase
{
  static constexpr uint16_t set   = TOC_FLAG_READ;
  static constexpr uint16_t reset = TOC_FLAG_WRITE | TOC_FLAG_WRITE_POLICY_MASK;
};

/** READ/WRITE flag */
struct RW
 : public CTocFlagsBase
{
  static constexpr uint16_t set   = TOC_FLAG_READ | TOC_FLAG_WRITE;
};

/** WRITE ONLY flag */
struct WO
 : public CTocFlagsBase
{
  static constexpr uint16_t set   = TOC_FLAG_WRITE;
  static constexpr uint16_t reset = TOC_FLAG_READ | TOC_FLAG_READ_POLICY_MASK;
};

/** VIRTUALL ARRAY flag */
struct VIRT
 : public CTocFlagsBase
{
  static constexpr uint16_t set   = TOC_FLAG_VIRTUAL;
  static constexpr uint16_t reset = TOC_FLAG_WRITE | TOC_FLAG_WRITE_POLICY_MASK;
};

/** VARIABLE SIZE flag */
struct VLEN
 : public CTocFlagsBase
{
  static constexpr uint16_t set   = TOC_FLAG_V_SIZE;
};

/** BLE BROADCAST flag */
struct BCAST
 : public CTocFlagsBase
{
  static constexpr bool ble = true;
  static constexpr uint16_t set   = TOC_FLAG_BLE_BROADCAST;
};

/** BLE NOTIFICATION flag */
struct NOTIF
 : public CTocFlagsBase
{
  static constexpr bool ble = true;
  static constexpr uint16_t set   = TOC_FLAG_BLE_NOTIFICATION;
};

/** BLE INDICATION flag */
struct IND
 : public CTocFlagsBase
{
  static constexpr bool ble = true;
  static constexpr uint16_t set   = TOC_FLAG_BLE_INDICATION;
};

/** PRE-READ CALLBACK flag */
struct cbR
 : public CTocFlagsBase
{
  static constexpr uint16_t set   = TOC_FLAG_READ_POLICY(TOC_POLICY_PRE_CB);
  static constexpr uint16_t reset = TOC_FLAG_READ_POLICY_MASK ^ TOC_FLAG_READ_POLICY(TOC_POLICY_PRE_CB);
};

/** PRE/POST-READ CALLBACK flag */
struct cbRcb
 : public CTocFlagsBase
{
  static constexpr uint16_t set   = TOC_FLAG_READ_POLICY(TOC_POLICY_PRE_CB | TOC_POLICY_POST_CB);
};

/** POST-READ CALLBACK flag */
struct Rcb
 : public CTocFlagsBase
{
  static constexpr uint16_t set   = TOC_FLAG_READ_POLICY(TOC_POLICY_POST_CB);
  static constexpr uint16_t reset = TOC_FLAG_READ_POLICY_MASK ^ TOC_FLAG_READ_POLICY(TOC_POLICY_POST_CB);
};

/** PRE-WRITE CALLBACK flag */
struct cbW
 : public CTocFlagsBase
{
  static constexpr uint16_t set   = TOC_FLAG_WRITE_POLICY(TOC_POLICY_PRE_CB);
  static constexpr uint16_t reset = TOC_FLAG_WRITE_POLICY_MASK ^ TOC_FLAG_WRITE_POLICY(TOC_POLICY_PRE_CB);
};

/** PRE/POST-WRITE CALLBACK flag */
struct cbWcb
 : public CTocFlagsBase
{
  static constexpr uint16_t set   = TOC_FLAG_WRITE_POLICY(TOC_POLICY_PRE_CB | TOC_POLICY_POST_CB);
};

/** POST-WRITE CALLBACK FLAG */
struct Wcb
 : public CTocFlagsBase
{
  static constexpr uint16_t set   = TOC_FLAG_WRITE_POLICY(TOC_POLICY_POST_CB);
  static constexpr uint16_t reset = TOC_FLAG_WRITE_POLICY_MASK ^ TOC_FLAG_WRITE_POLICY(TOC_POLICY_POST_CB);
};

/** SUPERUSER flag */
struct SU
 : public CTocFlagsBase
{
  static constexpr uint16_t set   = TOC_FLAG_ACL(TOC_ACL_PROTECTED);
  static constexpr uint16_t reset = TOC_FLAG_ACL_MASK ^ TOC_FLAG_ACL(TOC_ACL_PROTECTED);
};

/** DBG flag */
struct DBG
 : public CTocFlagsBase
{
  static constexpr uint16_t set   = TOC_FLAG_ACL(TOC_ACL_PRIVATE);
  static constexpr uint16_t reset = TOC_FLAG_ACL_MASK ^ TOC_FLAG_ACL(TOC_ACL_PRIVATE);
};

/** HIDDEN flag */
struct HIDDEN
 : public CTocFlagsBase
{
  static constexpr uint16_t set   = TOC_FLAG_ACL(TOC_ACL_DENIED);
  static constexpr uint16_t reset = TOC_FLAG_ACL_MASK ^ TOC_FLAG_ACL(TOC_ACL_DENIED);
};

/** DUMMY flag */
struct __
 : public CTocFlagsBase
{
  static constexpr uint16_t reset = 0xFFFF;
};

/** 
 * The class can be used to specify non-standard traits set for the specific property.
 *
 * Usage:
 \code
  template<class U>
  struct CExtraTraits<CVar_RAM_SomeVar>
    : public U
  {
    // Redefine flags:
    static const uint16_t m_flags = U::m_flags | SOME_FLAG;
    // Redefine location:
    static constexpr uint8_t m_segment = 4;
    static constexpr size_t m_offset = 16;
    static constexpr size_t m_size = U::m_size + 2;
    static constexpr size_t m_count = U::m_count * 99;
    // Please note that BINARY flag can not be changed by traits.
};
 \endcode
 */
template<class T, class U>
struct CExtraTraits
 : public U
{};

/***********************************************************************
 * Implementation
***********************************************************************/

/** Location flags (internal) */
template <int count>
struct CLocFlags
 : public CTocFlagsBase
{
  /* Virtual arrays can not have an array som en underlaying type */
  static constexpr uint16_t reset = (count == 1) ? 0 : TOC_FLAG_VIRTUAL;
};

/** Roll out the flags pack */
template<class Flag, class... Flags>
struct CRollFlagsTraits
{
  static constexpr bool ble       = Flag::ble  || CRollFlagsTraits<Flags...>::ble;
  static constexpr uint16_t set   = Flag::set   | CRollFlagsTraits<Flags...>::set;
  static constexpr uint16_t reset = Flag::reset | CRollFlagsTraits<Flags...>::reset;
};

/** Stop recursion */
template<class Flag>
struct CRollFlagsTraits<Flag>
{
  static constexpr bool ble       = Flag::ble;
  static constexpr uint16_t set   = Flag::set;
  static constexpr uint16_t reset = Flag::reset;
};

/** Build a flag bit set from the flag literal pack */
template<class Loc, class... Flags>
struct CFlagsTraits
  : public Loc
{
private:
  typedef CRollFlagsTraits<CLocFlags<Loc::m_count>, Flags...> traits;
  static constexpr uint16_t set   = traits::set;
  static constexpr uint16_t reset = traits::reset | TOC_FLAG_EXTERN_LIMITS;
  static_assert((set & reset) == 0,  "TOC: Invalid combination of flags");

public:
  static const uint16_t m_flags = set;
  static const uint16_t m_ble = traits::ble;
};

#endif /* TOC_TABLE_FLAGS_H_INCLUDED */