countedref.cc File Reference

#include "kernel/mod2.h"
#include "ipid.h"
#include "countedref.h"
#include "blackbox.h"
#include "newstruct.h"
#include "ipshell.h"

Go to the source code of this file.

Data Structures
class	CountedRefData
	This class stores a reference counter as well as a Singular interpreter object. More...
class	CountedRef
class	CountedRefShared

Functions
void	CountedRefPtr_kill (ring r)
	Overloading ring destruction. More...
void	CountedRefPtr_kill (CountedRefData *data)
	Supporting smart pointer CountedRefPtr. More...
void *	countedref_Init (blackbox *)
	blackbox support - initialization More...
BOOLEAN	countedref_CheckAssign (blackbox *, leftv, leftv)
	We use the function pointer as a marker of reference types for CountedRef::is_ref(leftv), see the latter for details. More...
void	countedref_Print (blackbox *, void *ptr)
	blackbox support - convert to string representation More...
char *	countedref_String (blackbox *, void *ptr)
	blackbox support - convert to string representation More...
void *	countedref_Copy (blackbox *, void *ptr)
	blackbox support - copy element More...
BOOLEAN	countedref_Assign (leftv result, leftv arg)
	blackbox support - assign element More...
BOOLEAN	countedref_CheckInit (leftv res, leftv arg)
BOOLEAN	countedref_Op1 (int op, leftv res, leftv head)
	blackbox support - unary operations More...
static BOOLEAN	countedref_Op2_ (int op, leftv res, leftv head, leftv arg)
	blackbox support - binary operations (resolve seocnd argument) More...
BOOLEAN	countedref_Op2 (int op, leftv res, leftv head, leftv arg)
static BOOLEAN	countedref_Op3__ (int op, leftv res, leftv head, leftv arg1, leftv arg2)
static BOOLEAN	countedref_Op3_ (int op, leftv res, leftv head, leftv arg1, leftv arg2)
BOOLEAN	countedref_Op3 (int op, leftv res, leftv head, leftv arg1, leftv arg2)
	blackbox support - ternary operations More...
void	countedref_destroy (blackbox *, void *ptr)
	blackbox support - destruction More...
void *	countedref_InitShared (blackbox *)
	Blackbox support - generate initialized, but all-zero - shared data. More...
BOOLEAN	countedref_Op1Shared (int op, leftv res, leftv head)
	Blackbox support - unary operation for shared data. More...
BOOLEAN	countedref_Op2Shared (int op, leftv res, leftv head, leftv arg)
	blackbox support - binary operations More...
BOOLEAN	countedref_OpM (int op, leftv res, leftv args)
	blackbox support - n-ary operations More...
BOOLEAN	countedref_AssignShared (leftv result, leftv arg)
	blackbox support - assign element More...
void	countedref_destroyShared (blackbox *, void *ptr)
	blackbox support - destruction More...
BOOLEAN	countedref_serialize (blackbox *, void *d, si_link f)
BOOLEAN	countedref_deserialize (blackbox **, void **d, si_link f)
void	countedref_reference_load ()
	Initialize blackbox types 'reference' and 'shared', or both. More...
void	countedref_shared_load ()

Detailed Description

Author

Alexander Dreyer

Date

2012-08-15

This file defines reference countes interpreter objects and adds the blackbox operations for high-level types 'reference' and 'shared'.

Note

This works was supported by the "Industrial Algebra" project.

Copyright:

(c) 2012 by The Singular Team, see LICENSE file

Definition in file countedref.cc.

Function Documentation

countedref_Assign()

BOOLEAN countedref_Assign	(	leftv	result,
		leftv	arg
	)

blackbox support - assign element

Definition at line 377 of file countedref.cc.

{
  // Case: replace assignment behind reference
  if (result->Data() != NULL) {
    CountedRef ref = CountedRef::cast(result);
    return CountedRef::resolve(arg) || ref.assign(result, arg);
  }
 
  // Case: copy reference
  if (result->Typ() == arg->Typ())
    return CountedRef::cast(arg).outcast(result);
 
  // Case: new reference
  if ((arg->rtyp == IDHDL) || CountedRef::is_ref(arg))
    return CountedRef(arg).outcast(result);
 
  WerrorS("Can only take reference from identifier");
  return TRUE;
}

countedref_AssignShared()

BOOLEAN countedref_AssignShared	(	leftv	result,
		leftv	arg
	)

blackbox support - assign element

Case: replace assignment behind reference

Case: new reference to already shared data

Case: new shared data

Definition at line 648 of file countedref.cc.

{
  /// Case: replace assignment behind reference
  if ((result->Data() != NULL)  && !CountedRefShared::cast(result).unassigned()) {
    CountedRef ref = CountedRef::cast(result);
    return CountedRef::resolve(arg) || ref.assign(result, arg);
  }
 
  /// Case: new reference to already shared data
  if (result->Typ() == arg->Typ())
  {
    if (result->Data() != NULL)
      CountedRefShared::cast(result).destruct();
    return CountedRefShared::cast(arg).outcast(result);
  }
  if(CountedRefShared::cast(result).unassigned())
  {
    return CountedRefShared::cast(result).assign(result, arg);
  }
 
  /// Case: new shared data
  return CountedRefShared(arg).outcast(result);
}

countedref_CheckAssign()

BOOLEAN countedref_CheckAssign	(	blackbox *	,
		leftv	,
		leftv
	)

We use the function pointer as a marker of reference types for CountedRef::is_ref(leftv), see the latter for details.

Definition at line 193 of file countedref.cc.

{
  return FALSE;
}

countedref_CheckInit()

BOOLEAN countedref_CheckInit	(	leftv	res,
		leftv	arg
	)

Definition at line 397 of file countedref.cc.

{
  if (arg->Data() != NULL) return FALSE;
  res->rtyp = NONE;
  WerrorS("Noninitialized access");
  return TRUE;
}

countedref_Copy()

void * countedref_Copy	(	blackbox *	,
		void *	ptr
	)

blackbox support - copy element

Definition at line 370 of file countedref.cc.

{
  if (ptr) return CountedRef::cast(ptr).outcast();
  return NULL;
}

countedref_deserialize()

BOOLEAN countedref_deserialize	(	blackbox **	,
		void **	d,
		si_link	f
	)

Definition at line 691 of file countedref.cc.

{
  // rtyp must be set correctly (to the blackbox id) by routine calling
  leftv data=f->m->Read(f);
  CountedRefShared sh(data);
  *d = sh.outcast();
  return FALSE;
}

countedref_destroy()

void countedref_destroy	(	blackbox *	,
		void *	ptr
	)

blackbox support - destruction

Definition at line 484 of file countedref.cc.

{
  if (ptr) CountedRef::cast(ptr).destruct();
}

countedref_destroyShared()

void countedref_destroyShared	(	blackbox *	,
		void *	ptr
	)

blackbox support - destruction

Definition at line 673 of file countedref.cc.

{
  if (ptr) CountedRefShared::cast(ptr).destruct();
}

countedref_Init()

void * countedref_Init

(

blackbox *

)

blackbox support - initialization

Definition at line 186 of file countedref.cc.

{
  return NULL;
}

countedref_InitShared()

void * countedref_InitShared

(

blackbox *

)

Blackbox support - generate initialized, but all-zero - shared data.

Definition at line 540 of file countedref.cc.

{
  return CountedRefShared().outcast();
}

countedref_Op1()

BOOLEAN countedref_Op1	(	int	op,
		leftv	res,
		leftv	head
	)

blackbox support - unary operations

Definition at line 406 of file countedref.cc.

{
  if(op == TYPEOF_CMD)
    return blackboxDefaultOp1(op, res, head);
 
  if (countedref_CheckInit(res, head)) return TRUE;
 
  if ((op == DEF_CMD) || (op == head->Typ()))
  {
    res->rtyp = head->Typ();
    return iiAssign(res, head);
  }
 
  CountedRef ref = CountedRef::cast(head);
  return ref.dereference(head) ||
    iiExprArith1(res, head, op == LINK_CMD? head->Typ(): op);
}

countedref_Op1Shared()

BOOLEAN countedref_Op1Shared	(	int	op,
		leftv	res,
		leftv	head
	)

Blackbox support - unary operation for shared data.

Definition at line 546 of file countedref.cc.

{
  if(op == TYPEOF_CMD)
    return blackboxDefaultOp1(op, res, head);
 
  if (countedref_CheckInit(res, head)) return TRUE;
 
  if ((op == DEF_CMD) || (op == head->Typ()))
  {
    res->rtyp = head->Typ();
    return iiAssign(res, head);
  }
 
  CountedRefShared ref = CountedRefShared::cast(head);
 
  if (op == LINK_CMD)
  {
    if (ref.dereference(head)) return TRUE;
    res->Copy(head);
    return (res->Typ() == NONE);
  }
 
  CountedRefShared wrap = ref.wrapid();
  int typ = head->Typ();
  return wrap.dereference(head) || iiExprArith1(res, head, op) ||
    wrap.retrieve(res, typ);
}

countedref_Op2()

BOOLEAN countedref_Op2	(	int	op,
		leftv	res,
		leftv	head,
		leftv	arg
	)

Definition at line 437 of file countedref.cc.

{
  if (countedref_CheckInit(res, head)) return TRUE;
  if (CountedRef::is_ref(head))
  {
    CountedRef ref = CountedRef::cast(head);
    return ref.dereference(head) || countedref_Op2_(op, res, head, arg);
  }
  return countedref_Op2_(op, res, head, arg);
}

countedref_Op2_()

static BOOLEAN countedref_Op2_ ( int  op, leftv  res, leftv  head, leftv  arg  )

static

blackbox support - binary operations (resolve seocnd argument)

Definition at line 427 of file countedref.cc.

{
  if (CountedRef::is_ref(arg))
  {
    CountedRef ref = CountedRef::cast(arg);
    return ref.dereference(arg) || iiExprArith2(res, head, op, arg);
  }
  return  iiExprArith2(res, head, op, arg);
}

countedref_Op2Shared()

BOOLEAN countedref_Op2Shared	(	int	op,
		leftv	res,
		leftv	head,
		leftv	arg
	)

blackbox support - binary operations

Definition at line 576 of file countedref.cc.

{
  if (countedref_CheckInit(res, head))  return TRUE;
 
  if (CountedRefShared::is_ref(head))
  {
    CountedRefShared wrap = CountedRefShared::cast(head).wrapid();
    int typ = head->Typ();
    return wrap.dereference(head) || countedref_Op2_(op, res, head, arg) ||
      wrap.retrieve(res, typ);
  }
 
  return countedref_Op2_(op, res, head, arg);
}

countedref_Op3()

BOOLEAN countedref_Op3	(	int	op,
		leftv	res,
		leftv	head,
		leftv	arg1,
		leftv	arg2
	)

blackbox support - ternary operations

Definition at line 471 of file countedref.cc.

{
  if (countedref_CheckInit(res, head)) return TRUE;
  if (CountedRef::is_ref(head))
  {
    CountedRef ref = CountedRef::cast(head);
    return ref.dereference(head) || countedref_Op3_(op, res, head, arg1, arg2);
  }
  return countedref_Op3_(op, res, head, arg1, arg2);
}

countedref_Op3_()

static BOOLEAN countedref_Op3_ ( int  op, leftv  res, leftv  head, leftv  arg1, leftv  arg2  )

static

Definition at line 459 of file countedref.cc.

{
  if (CountedRef::is_ref(arg1))
  {
    CountedRef ref = CountedRef::cast(arg1);
    return ref.dereference(arg1) || countedref_Op3__(op, res, head, arg1, arg2);
  }
  return countedref_Op3__(op, res, head, arg1, arg2);
}

countedref_Op3__()

static BOOLEAN countedref_Op3__ ( int  op, leftv  res, leftv  head, leftv  arg1, leftv  arg2  )

static

Definition at line 448 of file countedref.cc.

{
 
  if (CountedRef::is_ref(arg2))
  {
    CountedRef ref = CountedRef::cast(arg2);
    return ref.dereference(arg2) || iiExprArith3(res, op, head, arg1, arg2);
  }
  return iiExprArith3(res, op, head, arg1, arg2);
}

countedref_OpM()

BOOLEAN countedref_OpM	(	int	op,
		leftv	res,
		leftv	args
	)

blackbox support - n-ary operations

Definition at line 592 of file countedref.cc.

{
  if (args->Data() == NULL) return FALSE;
 
  if(op == SYSTEM_CMD)
  {
    if (args->next)
    {
      leftv next = args->next;
      args->next = NULL;
 
      char* name = (next->Typ() == STRING_CMD?
                    (char*) next->Data(): (char*)next->Name());
      next = next->next;
 
      if (strcmp(name, "help") == 0)
      {
        PrintS("system(<ref>, ...): extended functionality for reference/shared data <ref>\n");
        PrintS("  system(<ref>, count)         - number of references pointing to <ref>\n");
        PrintS("  system(<ref>, enumerate)     - unique number for identifying <ref>\n");
        PrintS("  system(<ref>, undefined)     - checks whether <ref> had been assigned\n");
        PrintS("  system(<ref>, \"help\")        - prints this information message\n");
        PrintS("  system(<ref>, \"typeof\")      - actual type referenced by <ref>\n");
        PrintS("  system(<ref1>, same, <ref2>) - tests for identic reference objects\n");
        return CountedRef::construct(res);
      }
      if (strncmp(name, "undef", 5) == 0)
      {
        return CountedRef::construct(res, args->Data()?
                          (CountedRef::cast(args).unassigned()? 1: 2): 0);
      }
 
      CountedRef obj = CountedRef::cast(args);
      if (next)
      {
        if (strcmp(name, "same") == 0) return obj.same(res, next);
        // likewise may be hard to interprete, so we not not document it above
        if (strncmp(name, "like", 4) == 0) return obj.likewise(res, next);
      }
      if (strncmp(name, "count", 5) == 0) return obj.count(res);
      if (strncmp(name, "enum", 4) == 0) return obj.enumerate(res);
      if (strcmp(name, "name") == 0) return obj.name(res); // undecumented
      if (strncmp(name, "typ", 3) == 0) return obj.type(res);
    }
    return TRUE;
  }
  if (op == LIST_CMD)
  {
    res->rtyp = op;
    return jjLIST_PL(res, args);
  }
  CountedRef ref = CountedRef::cast(args);
  return ref.dereference(args) || iiExprArithM(res, args, op);
}

countedref_Print()

void countedref_Print	(	blackbox *	,
		void *	ptr
	)

blackbox support - convert to string representation

Definition at line 356 of file countedref.cc.

{
  if (ptr) (*CountedRef::cast(ptr))->Print();
  else PrintS("<unassigned reference or shared memory>");
}

countedref_reference_load()

void countedref_reference_load

(

)

Initialize blackbox types 'reference' and 'shared', or both.

Definition at line 700 of file countedref.cc.

{
  int tok;
  if (blackboxIsCmd("reference", tok) == ROOT_DECL)
    return;
 
  blackbox *bbx = (blackbox*)omAlloc0(sizeof(blackbox));
  bbx->blackbox_CheckAssign = countedref_CheckAssign;
  bbx->blackbox_destroy = countedref_destroy;
  bbx->blackbox_String  = countedref_String;
  bbx->blackbox_Print  = countedref_Print;
  bbx->blackbox_Init    = countedref_Init;
  bbx->blackbox_Copy    = countedref_Copy;
  bbx->blackbox_Assign  = countedref_Assign;
  bbx->blackbox_Op1     = countedref_Op1;
  bbx->blackbox_Op2     = countedref_Op2;
  bbx->blackbox_Op3     = countedref_Op3;
  bbx->blackbox_OpM     = countedref_OpM;
  bbx->blackbox_serialize   = countedref_serialize;
  bbx->blackbox_deserialize = countedref_deserialize;
  bbx->data             = omAlloc0(newstruct_desc_size());
  setBlackboxStuff(bbx, "reference");
}

countedref_serialize()

BOOLEAN countedref_serialize	(	blackbox *	,
		void *	d,
		si_link	f
	)

Definition at line 679 of file countedref.cc.

{
  sleftv l;
  memset(&l,0,sizeof(l));
  l.rtyp = STRING_CMD;
  l.data = (void*)omStrDup("shared"); // references are converted
  f->m->Write(f, &l);
  CountedRefShared::cast(d).dereference(&l);
  f->m->Write(f, &l);
  return FALSE;
}

countedref_shared_load()

void countedref_shared_load

(

)

Definition at line 724 of file countedref.cc.

{
  int tok;
  if (blackboxIsCmd("shared", tok) == ROOT_DECL)
    return;
 
  blackbox *bbxshared = (blackbox*)omAlloc0(sizeof(blackbox));
  bbxshared->blackbox_String  = countedref_String;
  bbxshared->blackbox_Print  = countedref_Print;
  bbxshared->blackbox_Copy    = countedref_Copy;
  bbxshared->blackbox_Op3     = countedref_Op3;
  bbxshared->blackbox_OpM     = countedref_OpM;
  bbxshared->blackbox_serialize   = countedref_serialize;
  bbxshared->blackbox_deserialize = countedref_deserialize;
 
  bbxshared->blackbox_CheckAssign = countedref_CheckAssign;
  bbxshared->blackbox_Assign  = countedref_AssignShared;
  bbxshared->blackbox_destroy = countedref_destroyShared;
  bbxshared->blackbox_Op1     = countedref_Op1Shared;
  bbxshared->blackbox_Op2     = countedref_Op2Shared;
  bbxshared->blackbox_Init    = countedref_InitShared;
  bbxshared->data             = omAlloc0(newstruct_desc_size());
  setBlackboxStuff(bbxshared, "shared");
}

countedref_String()

char * countedref_String	(	blackbox *	,
		void *	ptr
	)

blackbox support - convert to string representation

Definition at line 363 of file countedref.cc.

{
  if (ptr == NULL) return omStrDup(sNoName_fe);
  return (*CountedRef::cast(ptr))->String();
}

CountedRefPtr_kill() [1/2]

void CountedRefPtr_kill ( CountedRefData *  data )

inline

Supporting smart pointer CountedRefPtr.

Definition at line 182 of file countedref.cc.

{ delete data; }

CountedRefPtr_kill() [2/2]

void CountedRefPtr_kill ( ring  r )

inline

Overloading ring destruction.

Definition at line 34 of file countedref.cc.

{ rKill(r); }