MemoryMaps
==========

.. java:package:: fr.inria.tapenade.representation
   :noindex:

.. java:type:: public final class MemoryMaps

   Memory map manager. Deals with the relative layout of variables in memory. In particular, accepts the declaration of a new COMMON block, or the declaration that some variables are EQUIVALENCEd, DATA, or SAVEd.

Fields
------
mapAccesses
^^^^^^^^^^^

.. java:field:: public TapList<VarStartBoundary> mapAccesses
   :outertype: MemoryMaps

   Fast access from a VariableDecl to its start AlignmentBoundary in one of the maps. This is a hatted list for easy add/remove of entries

maps
^^^^

.. java:field:: public TapList<MemMap> maps
   :outertype: MemoryMaps

   The (hatted) list of memory maps built so far

Methods
-------
addRegistration
^^^^^^^^^^^^^^^

.. java:method:: public void addRegistration(VarStartBoundary entry)
   :outertype: MemoryMaps

   Adds the new "entry" into this MemoryMap's mapAccesses

allocateZones
^^^^^^^^^^^^^

.. java:method:: public void allocateZones(ZoneAllocator zoneAllocator, Unit declarationUnit)
   :outertype: MemoryMaps

delRegistration
^^^^^^^^^^^^^^^

.. java:method:: public VarStartBoundary delRegistration(SymbolDecl symbolDecl)
   :outertype: MemoryMaps

   Retrieves the (first) entry associated to the given "symbolDecl" in this MemoryMap's mapAccesses. If the entry is found, remove it from this MemoryMap's mapAccesses

getMemMap
^^^^^^^^^

.. java:method:: public MemMap getMemMap(String commonName)
   :outertype: MemoryMaps

getRegistration
^^^^^^^^^^^^^^^

.. java:method:: public VarStartBoundary getRegistration(SymbolDecl symbolDecl)
   :outertype: MemoryMaps

   Retrieves the (first) entry associated to the given "symbolDecl" in this MemoryMap's mapAccesses

getSetMemMap
^^^^^^^^^^^^

.. java:method:: public MemMap getSetMemMap(String commonName)
   :outertype: MemoryMaps

   Finds or creates the MemMap with name "commonName" in the current maps. When commonName is given null, always creates a new MemMap, even if maps already contains other MemMap's with a null name.

placeCAccessIntoFortranMap
^^^^^^^^^^^^^^^^^^^^^^^^^^

.. java:method:: public static void placeCAccessIntoFortranMap(ZoneInfoAccessElements cAccess, MemMap receivingMap, String bindName, int receivingOffset, MemoryMaps globalFortranMaps)
   :outertype: MemoryMaps

placeCEDSIntoMemoryMaps
^^^^^^^^^^^^^^^^^^^^^^^

.. java:method:: public static void placeCEDSIntoMemoryMaps(Tree declaration, SymbolTable declSymbolTable, Unit declUnit, MemoryMaps unitMaps, CallGraph callGraph)
   :outertype: MemoryMaps

   Place into the MemoryMaps the given memory layout "declaration", which appeared in the context of the given "declSymbolTable". "declaration" may be a COMMON, EQUIVALENCE, SAVE, or DATA declaration. The info may end up into this Unit's local maps (if it is purely an EQUIVALENCE) or into the CallGraph's global maps (if it is a COMMON, SAVE, DATA, or BIND(C) declaration.

toString
^^^^^^^^

.. java:method:: public String toString()
   :outertype: MemoryMaps