path: root/comm/mailnews/db/mork/morkAtomMap.h

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-  */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef _MORKATOMMAP_
#define _MORKATOMMAP_ 1

#ifndef _MORK_
#  include "mork.h"
#endif

#ifndef _MORKNODE_
#  include "morkNode.h"
#endif

#ifndef _MORKMAP_
#  include "morkMap.h"
#endif

#ifndef _MORKPROBEMAP_
#  include "morkProbeMap.h"
#endif

#ifndef _MORKINTMAP_
#  include "morkIntMap.h"
#endif

// 456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789

#define morkDerived_kAtomAidMap /*i*/ 0x6141 /* ascii 'aA' */

#define morkAtomAidMap_kStartSlotCount 23

/*| morkAtomAidMap: keys of morkBookAtom organized by atom ID
|*/
#ifdef MORK_ENABLE_PROBE_MAPS
class morkAtomAidMap : public morkProbeMap {  // for mapping tokens to maps
#else                                         /*MORK_ENABLE_PROBE_MAPS*/
class morkAtomAidMap : public morkMap {  // for mapping tokens to maps
#endif                                        /*MORK_ENABLE_PROBE_MAPS*/

  // { ===== begin morkNode interface =====
 public:  // morkNode virtual methods
  virtual void CloseMorkNode(
      morkEnv* ev) override;  // CloseAtomAidMap() only if open
  virtual ~morkAtomAidMap();  // assert that CloseAtomAidMap() executed earlier

 public:  // morkMap construction & destruction
  morkAtomAidMap(morkEnv* ev, const morkUsage& inUsage, nsIMdbHeap* ioHeap,
                 nsIMdbHeap* ioSlotHeap);
  void CloseAtomAidMap(morkEnv* ev);  // called by CloseMorkNode();

 public:  // dynamic type identification
  mork_bool IsAtomAidMap() const {
    return IsNode() && mNode_Derived == morkDerived_kAtomAidMap;
  }
  // } ===== end morkNode methods =====

 public:
#ifdef MORK_ENABLE_PROBE_MAPS
  // { ===== begin morkProbeMap methods =====
  virtual mork_test  // hit(a,b) implies hash(a) == hash(b)
  MapTest(morkEnv* ev, const void* inMapKey,
          const void* inAppKey) const override;

  virtual mork_u4  // hit(a,b) implies hash(a) == hash(b)
  MapHash(morkEnv* ev, const void* inAppKey) const override;

  virtual mork_u4 ProbeMapHashMapKey(morkEnv* ev,
                                     const void* inMapKey) const override;

  // virtual mork_bool ProbeMapIsKeyNil(morkEnv* ev, void* ioMapKey);

  // virtual void ProbeMapClearKey(morkEnv* ev, // put 'nil' into all keys
  // inside map
  //   void* ioMapKey, mork_count inKeyCount); // array of keys inside map

  // virtual void ProbeMapPushIn(morkEnv* ev, // move (key,val) into the map
  //   const void* inAppKey, const void* inAppVal, // (key,val) outside map
  //   void* outMapKey, void* outMapVal);      // (key,val) inside map

  // virtual void ProbeMapPullOut(morkEnv* ev, // move (key,val) out from the
  // map
  //   const void* inMapKey, const void* inMapVal, // (key,val) inside map
  //   void* outAppKey, void* outAppVal) const;    // (key,val) outside map
  // } ===== end morkProbeMap methods =====
#else  /*MORK_ENABLE_PROBE_MAPS*/
  // { ===== begin morkMap poly interface =====
  virtual mork_bool  // note: equal(a,b) implies hash(a) == hash(b)
  Equal(morkEnv* ev, const void* inKeyA, const void* inKeyB) const override;
  // implemented using morkBookAtom::HashAid()

  virtual mork_u4  // note: equal(a,b) implies hash(a) == hash(b)
  Hash(morkEnv* ev, const void* inKey) const override;
  // implemented using morkBookAtom::EqualAid()
// } ===== end morkMap poly interface =====
#endif /*MORK_ENABLE_PROBE_MAPS*/

 public:  // other map methods
  mork_bool AddAtom(morkEnv* ev, morkBookAtom* ioAtom);
  // AddAtom() returns ev->Good()

  morkBookAtom* CutAtom(morkEnv* ev, const morkBookAtom* inAtom);
  // CutAtom() returns the atom removed equal to inAtom, if there was one

  morkBookAtom* GetAtom(morkEnv* ev, const morkBookAtom* inAtom);
  // GetAtom() returns the atom equal to inAtom, or else nil

  morkBookAtom* GetAid(morkEnv* ev, mork_aid inAid);
  // GetAid() returns the atom equal to inAid, or else nil

  // note the atoms are owned elsewhere, usually by morkAtomSpace

 public:  // typesafe refcounting inlines calling inherited morkNode methods
  static void SlotWeakAtomAidMap(morkAtomAidMap* me, morkEnv* ev,
                                 morkAtomAidMap** ioSlot) {
    morkNode::SlotWeakNode((morkNode*)me, ev, (morkNode**)ioSlot);
  }

  static void SlotStrongAtomAidMap(morkAtomAidMap* me, morkEnv* ev,
                                   morkAtomAidMap** ioSlot) {
    morkNode::SlotStrongNode((morkNode*)me, ev, (morkNode**)ioSlot);
  }
};

#ifdef MORK_ENABLE_PROBE_MAPS
class morkAtomAidMapIter : public morkProbeMapIter {  // typesafe wrapper class
#else                                                 /*MORK_ENABLE_PROBE_MAPS*/
class morkAtomAidMapIter : public morkMapIter {  // typesafe wrapper class
#endif                                                /*MORK_ENABLE_PROBE_MAPS*/

 public:
#ifdef MORK_ENABLE_PROBE_MAPS
  morkAtomAidMapIter(morkEnv* ev, morkAtomAidMap* ioMap)
      : morkProbeMapIter(ev, ioMap) {}

  morkAtomAidMapIter() : morkProbeMapIter() {}
#else  /*MORK_ENABLE_PROBE_MAPS*/
  morkAtomAidMapIter(morkEnv* ev, morkAtomAidMap* ioMap)
      : morkMapIter(ev, ioMap) {}

  morkAtomAidMapIter() : morkMapIter() {}
#endif /*MORK_ENABLE_PROBE_MAPS*/

  void InitAtomAidMapIter(morkEnv* ev, morkAtomAidMap* ioMap) {
    this->InitMapIter(ev, ioMap);
  }

  mork_change* FirstAtom(morkEnv* ev, morkBookAtom** outAtomPtr) {
    return this->First(ev, outAtomPtr, /*val*/ (void*)0);
  }

  mork_change* NextAtom(morkEnv* ev, morkBookAtom** outAtomPtr) {
    return this->Next(ev, outAtomPtr, /*val*/ (void*)0);
  }

  mork_change* HereAtom(morkEnv* ev, morkBookAtom** outAtomPtr) {
    return this->Here(ev, outAtomPtr, /*val*/ (void*)0);
  }

  mork_change* CutHereAtom(morkEnv* ev, morkBookAtom** outAtomPtr) {
    return this->CutHere(ev, outAtomPtr, /*val*/ (void*)0);
  }
};

// 456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789

// 456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789

#define morkDerived_kAtomBodyMap /*i*/ 0x6142 /* ascii 'aB' */

#define morkAtomBodyMap_kStartSlotCount 23

/*| morkAtomBodyMap: keys of morkBookAtom organized by body bytes
|*/
#ifdef MORK_ENABLE_PROBE_MAPS
class morkAtomBodyMap : public morkProbeMap {  // for mapping tokens to maps
#else                                          /*MORK_ENABLE_PROBE_MAPS*/
class morkAtomBodyMap : public morkMap {  // for mapping tokens to maps
#endif                                         /*MORK_ENABLE_PROBE_MAPS*/

  // { ===== begin morkNode interface =====
 public:  // morkNode virtual methods
  virtual void CloseMorkNode(
      morkEnv* ev) override;   // CloseAtomBodyMap() only if open
  virtual ~morkAtomBodyMap();  // assert CloseAtomBodyMap() executed earlier

 public:  // morkMap construction & destruction
  morkAtomBodyMap(morkEnv* ev, const morkUsage& inUsage, nsIMdbHeap* ioHeap,
                  nsIMdbHeap* ioSlotHeap);
  void CloseAtomBodyMap(morkEnv* ev);  // called by CloseMorkNode();

 public:  // dynamic type identification
  mork_bool IsAtomBodyMap() const {
    return IsNode() && mNode_Derived == morkDerived_kAtomBodyMap;
  }
  // } ===== end morkNode methods =====

 public:
#ifdef MORK_ENABLE_PROBE_MAPS
  // { ===== begin morkProbeMap methods =====
  virtual mork_test  // hit(a,b) implies hash(a) == hash(b)
  MapTest(morkEnv* ev, const void* inMapKey,
          const void* inAppKey) const override;

  virtual mork_u4  // hit(a,b) implies hash(a) == hash(b)
  MapHash(morkEnv* ev, const void* inAppKey) const override;

  virtual mork_u4 ProbeMapHashMapKey(morkEnv* ev,
                                     const void* inMapKey) const override;

  // virtual mork_bool ProbeMapIsKeyNil(morkEnv* ev, void* ioMapKey);

  // virtual void ProbeMapClearKey(morkEnv* ev, // put 'nil' into all keys
  // inside map
  //   void* ioMapKey, mork_count inKeyCount); // array of keys inside map

  // virtual void ProbeMapPushIn(morkEnv* ev, // move (key,val) into the map
  //   const void* inAppKey, const void* inAppVal, // (key,val) outside map
  //   void* outMapKey, void* outMapVal);      // (key,val) inside map

  // virtual void ProbeMapPullOut(morkEnv* ev, // move (key,val) out from the
  // map
  //   const void* inMapKey, const void* inMapVal, // (key,val) inside map
  //   void* outAppKey, void* outAppVal) const;    // (key,val) outside map
  // } ===== end morkProbeMap methods =====
#else  /*MORK_ENABLE_PROBE_MAPS*/
  // { ===== begin morkMap poly interface =====
  virtual mork_bool  // note: equal(a,b) implies hash(a) == hash(b)
  Equal(morkEnv* ev, const void* inKeyA, const void* inKeyB) const override;
  // implemented using morkBookAtom::EqualFormAndBody()

  virtual mork_u4  // note: equal(a,b) implies hash(a) == hash(b)
  Hash(morkEnv* ev, const void* inKey) const override;
  // implemented using morkBookAtom::HashFormAndBody()
// } ===== end morkMap poly interface =====
#endif /*MORK_ENABLE_PROBE_MAPS*/

 public:  // other map methods
  mork_bool AddAtom(morkEnv* ev, morkBookAtom* ioAtom);
  // AddAtom() returns ev->Good()

  morkBookAtom* CutAtom(morkEnv* ev, const morkBookAtom* inAtom);
  // CutAtom() returns the atom removed equal to inAtom, if there was one

  morkBookAtom* GetAtom(morkEnv* ev, const morkBookAtom* inAtom);
  // GetAtom() returns the atom equal to inAtom, or else nil

  // note the atoms are owned elsewhere, usually by morkAtomSpace

 public:  // typesafe refcounting inlines calling inherited morkNode methods
  static void SlotWeakAtomBodyMap(morkAtomBodyMap* me, morkEnv* ev,
                                  morkAtomBodyMap** ioSlot) {
    morkNode::SlotWeakNode((morkNode*)me, ev, (morkNode**)ioSlot);
  }

  static void SlotStrongAtomBodyMap(morkAtomBodyMap* me, morkEnv* ev,
                                    morkAtomBodyMap** ioSlot) {
    morkNode::SlotStrongNode((morkNode*)me, ev, (morkNode**)ioSlot);
  }
};

#ifdef MORK_ENABLE_PROBE_MAPS
class morkAtomBodyMapIter : public morkProbeMapIter {  // typesafe wrapper class
#else  /*MORK_ENABLE_PROBE_MAPS*/
class morkAtomBodyMapIter : public morkMapIter {  // typesafe wrapper class
#endif /*MORK_ENABLE_PROBE_MAPS*/

 public:
#ifdef MORK_ENABLE_PROBE_MAPS
  morkAtomBodyMapIter(morkEnv* ev, morkAtomBodyMap* ioMap)
      : morkProbeMapIter(ev, ioMap) {}

  morkAtomBodyMapIter() : morkProbeMapIter() {}
#else  /*MORK_ENABLE_PROBE_MAPS*/
  morkAtomBodyMapIter(morkEnv* ev, morkAtomBodyMap* ioMap)
      : morkMapIter(ev, ioMap) {}

  morkAtomBodyMapIter() : morkMapIter() {}
#endif /*MORK_ENABLE_PROBE_MAPS*/

  void InitAtomBodyMapIter(morkEnv* ev, morkAtomBodyMap* ioMap) {
    this->InitMapIter(ev, ioMap);
  }

  mork_change* FirstAtom(morkEnv* ev, morkBookAtom** outAtomPtr) {
    return this->First(ev, outAtomPtr, /*val*/ (void*)0);
  }

  mork_change* NextAtom(morkEnv* ev, morkBookAtom** outAtomPtr) {
    return this->Next(ev, outAtomPtr, /*val*/ (void*)0);
  }

  mork_change* HereAtom(morkEnv* ev, morkBookAtom** outAtomPtr) {
    return this->Here(ev, outAtomPtr, /*val*/ (void*)0);
  }

  mork_change* CutHereAtom(morkEnv* ev, morkBookAtom** outAtomPtr) {
    return this->CutHere(ev, outAtomPtr, /*val*/ (void*)0);
  }
};

// 456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789

#define morkDerived_kAtomRowMap /*i*/ 0x6152 /* ascii 'aR' */

/*| morkAtomRowMap: maps morkAtom* -> morkRow*
|*/
class morkAtomRowMap : public morkIntMap {  // for mapping atoms to rows

 public:
  mork_column mAtomRowMap_IndexColumn;  // row column being indexed

 public:
  virtual ~morkAtomRowMap();
  morkAtomRowMap(morkEnv* ev, const morkUsage& inUsage, nsIMdbHeap* ioHeap,
                 nsIMdbHeap* ioSlotHeap, mork_column inIndexColumn);

 public:  // adding and cutting from morkRow instance candidate
  void AddRow(morkEnv* ev, morkRow* ioRow);
  // add ioRow only if it contains a cell in mAtomRowMap_IndexColumn.

  void CutRow(morkEnv* ev, morkRow* ioRow);
  // cut ioRow only if it contains a cell in mAtomRowMap_IndexColumn.

 public:  // other map methods
  mork_bool AddAid(morkEnv* ev, mork_aid inAid, morkRow* ioRow) {
    return this->AddInt(ev, inAid, ioRow);
  }
  // the AddAid() boolean return equals ev->Good().

  mork_bool CutAid(morkEnv* ev, mork_aid inAid) {
    return this->CutInt(ev, inAid);
  }
  // The CutAid() boolean return indicates whether removal happened.

  morkRow* GetAid(morkEnv* ev, mork_aid inAid) {
    return (morkRow*)this->GetInt(ev, inAid);
  }
  // Note the returned space does NOT have an increase in refcount for this.

 public:  // dynamic type identification
  mork_bool IsAtomRowMap() const {
    return IsNode() && mNode_Derived == morkDerived_kAtomRowMap;
  }

 public:  // typesafe refcounting inlines calling inherited morkNode methods
  static void SlotWeakAtomRowMap(morkAtomRowMap* me, morkEnv* ev,
                                 morkAtomRowMap** ioSlot) {
    morkNode::SlotWeakNode((morkNode*)me, ev, (morkNode**)ioSlot);
  }

  static void SlotStrongAtomRowMap(morkAtomRowMap* me, morkEnv* ev,
                                   morkAtomRowMap** ioSlot) {
    morkNode::SlotStrongNode((morkNode*)me, ev, (morkNode**)ioSlot);
  }
};

class morkAtomRowMapIter : public morkMapIter {  // typesafe wrapper class

 public:
  morkAtomRowMapIter(morkEnv* ev, morkAtomRowMap* ioMap)
      : morkMapIter(ev, ioMap) {}

  morkAtomRowMapIter() : morkMapIter() {}
  void InitAtomRowMapIter(morkEnv* ev, morkAtomRowMap* ioMap) {
    this->InitMapIter(ev, ioMap);
  }

  mork_change* FirstAtomAndRow(morkEnv* ev, morkAtom** outAtom,
                               morkRow** outRow) {
    return this->First(ev, outAtom, outRow);
  }

  mork_change* NextAtomAndRow(morkEnv* ev, morkAtom** outAtom,
                              morkRow** outRow) {
    return this->Next(ev, outAtom, outRow);
  }

  mork_change* HereAtomAndRow(morkEnv* ev, morkAtom** outAtom,
                              morkRow** outRow) {
    return this->Here(ev, outAtom, outRow);
  }

  mork_change* CutHereAtomAndRow(morkEnv* ev, morkAtom** outAtom,
                                 morkRow** outRow) {
    return this->CutHere(ev, outAtom, outRow);
  }
};

// 456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789

#endif /* _MORKATOMMAP_ */