Element.h

Go to the documentation of this file.

/*                                              -*- mode:C++ -*-
  Element.h Base of all MFM elemental types
  Copyright (C) 2014 The Regents of the University of New Mexico.  All rights reserved.

  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 General Public License
  along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
  USA
*/

#ifndef ELEMENT_H
#define ELEMENT_H

#include "Atom.h"
#include "Parameter.h"
#include "itype.h"
#include "StaticLoader.h"
#include "EventWindow.h"
#include "UUID.h"
#include "Dirs.h"
#include "Logger.h"
#include "BitField.h"

namespace MFM
{
  typedef u32 ElementType;

  template <class CC> class Atom; // FORWARD

  template <class CC>
  class Element
  {
   private:
    typedef typename CC::ATOM_TYPE T;
    typedef typename CC::PARAM_CONFIG P;
    enum { R = P::EVENT_WINDOW_RADIUS };

    ElementParameters<CC> m_elementParameters;

    AtomicParameters<CC> m_atomicParameters;

    const UUID m_UUID;

    u32 m_type;

    bool m_hasType;

    bool m_renderLowlight;

    T m_defaultAtom;

    const char* m_atomicSymbol;

    const char* m_name;

   protected:

    virtual T BuildDefaultAtom() const
    {
      T defaultAtom(this->GetType(), 0, 0, 0);
      return defaultAtom;
    }

    const BitVector<P::BITS_PER_ATOM> & GetBits(const T & atom) const
    {
      return atom.m_bits;
    }

    BitVector<P::BITS_PER_ATOM> & GetBits(T & atom) const
    {
      return atom.m_bits;
    }

    bool IsValidAtomicSymbol(const char* symbol)
    {
      MFM_API_ASSERT_NONNULL(symbol);

      switch (strlen(symbol))
      {
      case 2:
        if (!(symbol[1] >= 'a' && symbol[1] <= 'z'))
        {
          return false;
        }
        // FALL THROUGH

      case 1:
        if (symbol[0] >= 'A' && symbol[0] <= 'Z')
        {
          return true;
        }
        // FALL THROUGH

      default:
        return false;
      }
    }

    void SetAtomicSymbol(const char* symbol)
    {
      if(!IsValidAtomicSymbol(symbol))
      {
        /* Single or double letters only, like the periodic table. */
        FAIL(ILLEGAL_ARGUMENT);
      }
      m_atomicSymbol = symbol;
    }

    void SetName(const char* name)
    {
      m_name = name;
    }

    void Diffuse(EventWindow<CC>& window) const;


    virtual u32 PercentMovable(const T& you,
                               const T& me, const SPoint& offset) const = 0;

   public:

    Element(const UUID & uuid) : m_UUID(uuid), m_type(0),
                                 m_hasType(false),
                                 m_renderLowlight(false),
                                 m_atomicSymbol("!!"),
                                 m_name("UNNAMED")
    {
      LOG.Debug("Constructed %@",&m_UUID);
    }

    /*
    // For use by Element_Empty only!
    Element(const UUID & uuid, u32 type) : m_UUID(uuid), m_type(type),
                                           m_hasType(true),
                                           m_renderLowlight(false),
                                           m_atomicSymbol("!!")
    { }
    */

    void AllocateType()
    {
      if (!m_hasType)
      {
        m_type = StaticLoader<CC,16>::AllocateType(m_UUID);
        m_hasType = true;
        m_defaultAtom = BuildDefaultAtom();
      }
    }

    u32 GetType() const
    {
      if (!m_hasType)
      {
        FAIL(ILLEGAL_STATE);
      }
      return m_type;
    }

    const char* GetAtomicSymbol() const
    {
      return m_atomicSymbol;
    }

    const char* GetName() const
    {
      return m_name;
    }

    virtual void AppendDescription(const T* atom, OString64& desc) const
    {
      /* Default to no description */
    }

    bool IsType(u32 type) const
    {
      return GetType() == type;
    }

    const UUID & GetUUID() const
    {
      return m_UUID;
    }

    virtual void Behavior(EventWindow<CC>& window) const = 0;

    virtual const T & GetDefaultAtom() const
    {
      if (!m_hasType)
      {
        FAIL(ILLEGAL_STATE);
      }
      return m_defaultAtom;
    }

    virtual u32 PhysicsColor() const
    {
      if(m_renderLowlight)
      {
        return DefaultLowlightColor();
      }
      else
      {
        return DefaultPhysicsColor();
      }
    }

    virtual const char* GetDescription() const
    {
      return "NO DESCRIPTION";
    }

    virtual u32 DefaultPhysicsColor() const = 0;

    virtual u32 DefaultLowlightColor() const
    {
      u8 r, g, b;
      u32 oc = DefaultPhysicsColor();

      /* Shift them one more to divide by 2 */
      r = (oc & 0x00ff0000) >> 17;
      g = (oc & 0x0000ff00) >> 9;
      b = (oc & 0x000000ff) >> 1;

      return 0xff000000 | (r << 16) | (g << 8) | b;
    }

    void ToggleLowlightPhysicsColor()
    {
      m_renderLowlight = !m_renderLowlight;
    }

    virtual u32 LocalPhysicsColor(const T& atom, u32 selector) const
    {
      return PhysicsColor();
    }

    virtual u32 Diffusability(EventWindow<CC> & ew, SPoint nowAt, SPoint maybeAt) const
    {
      return COMPLETE_DIFFUSABILITY;
    }

    u32 NoDiffusability(EventWindow<CC> & ew, SPoint nowAt, SPoint maybeAt) const
    {
      return (nowAt == maybeAt)? COMPLETE_DIFFUSABILITY : 0;
    }

    static const u32 COMPLETE_DIFFUSABILITY = 1000;

    const ElementParameters<CC> & GetElementParameters() const
    {
      return m_elementParameters;
    }

    ElementParameters<CC> & GetElementParameters()
    {
      return m_elementParameters;
    }

    const AtomicParameters<CC> & GetAtomicParameters() const
    {
      return m_atomicParameters;
    }

    AtomicParameters<CC> & GetAtomicParameters()
    {
      return m_atomicParameters;
    }
#if 0
<<<<<<< Updated upstream

  };

  template <class CC, u32 R>
  struct ElementParameterNeighborhood : public Parameters::Neighborhood<R>
  {
    ElementParameterNeighborhood(Element<CC> * elt,
                                 const char * tag,
                                 const char * name,
                                 const char * description)
      : Parameters::Neighborhood<R>(elt->GetElementParameters(), tag, name, description)
    {
    }
  };

  template <class CC>
  struct ElementParameterS32 : public Parameters::S32
  {
    ElementParameterS32(Element<CC> * elt,
                        const char * tag,
                        const char * name,
                        const char * description,
                        s32 min, s32 initial, s32 max, s32 snap)
      : Parameters::S32(elt->GetElementParameters(), tag, name, description, min, initial, max, snap)
    {
    }
=======
>>>>>>> Stashed changes
#endif
  };
}

#include "Element.tcc"

#endif /* ELEMENT_H */