Public Types
typedef int	id_type
	name type for identifiers More...

typedef CountedRefData	data_type
	Name type for handling referenced data. More...

typedef CountedRefPtr< CountedRefData * >	data_ptr
	Fix smart pointer type to referenced data. More...

Public Member Functions
	CountedRef (leftv arg)
	Reference given Singular data. More...

	CountedRef (const self &rhs)
	Construct copy. More...

self &	operator= (const self &rhs)
	Replace reference. More...

BOOLEAN	assign (leftv result, leftv arg)

LeftvShallow	operator* ()
	Extract (shallow) copy of stored data. More...

BOOLEAN	outcast (leftv res, int typ)
	Construct reference data object marked by given identifier number. More...

BOOLEAN	outcast (leftv res)
	Construct reference data object from *this. More...

data_type *	outcast ()
	Construct raw reference data. More...

void	destruct ()
	Kills a link to the referenced object. More...

	~CountedRef ()
	Kills the link to the referenced object. More...

BOOLEAN	dereference (leftv arg)
	Replaces argument by a shallow copy of the references data. More...

BOOLEAN	broken ()
	Check whether object in valid in current context. More...

BOOLEAN	unassigned () const
	Check whether (shared) data was initialized but not assigned yet. More...

BOOLEAN	count (leftv res)
	Get number of references pointing here, too. More...

BOOLEAN	enumerate (leftv res)

BOOLEAN	likewise (leftv res, leftv arg)
	Check for likewise identifiers. More...

BOOLEAN	same (leftv res, leftv arg)
	Check for identical reference objects. More...

BOOLEAN	type (leftv res)
	Get type of references data. More...

BOOLEAN	name (leftv res)
	Get (possibly) internal identifier name. More...

Static Public Member Functions
static BOOLEAN	is_ref (leftv arg)
	Check whether argument is already a reference type. More...

static self	cast (void *data)
	Recover the actual object from raw Singular data. More...

static self	cast (leftv arg)
	Recover the actual object from Singular interpreter object. More...

static BOOLEAN	resolve (leftv arg)
	If necessary dereference. More...

static BOOLEAN	construct (leftv res, long data)
	Construct integer value. More...

static BOOLEAN	construct (leftv res, const char *data)
	Construct string. More...

static BOOLEAN	construct (leftv res)
	Construct void-style object. More...

Protected Member Functions
	CountedRef (data_ptr arg)
	Recover previously constructed reference. More...

Protected Attributes
data_ptr	m_data
	Store pointer to actual data. More...

Private Types
typedef CountedRef	self

Detailed Description

Definition at line 199 of file countedref.cc.

Member Typedef Documentation

◆ data_ptr

typedef CountedRefPtr<CountedRefData*> CountedRef::data_ptr

Fix smart pointer type to referenced data.

Definition at line 210 of file countedref.cc.

◆ data_type

typedef CountedRefData CountedRef::data_type

Name type for handling referenced data.

Definition at line 207 of file countedref.cc.

◆ id_type

typedef int CountedRef::id_type

name type for identifiers

Definition at line 204 of file countedref.cc.

◆ self

typedef CountedRef CountedRef::self

private

Definition at line 200 of file countedref.cc.

Constructor & Destructor Documentation

◆ CountedRef() [1/3]

CountedRef::CountedRef ( leftv arg )

inlineexplicit

Reference given Singular data.

Definition at line 223 of file countedref.cc.

223: m_data(new data_type(arg)) { }

CountedRef::m_data

data_ptr m_data

Store pointer to actual data.

Definition: countedref.cc:352

CountedRef::data_type

CountedRefData data_type

Name type for handling referenced data.

Definition: countedref.cc:207

◆ CountedRef() [2/3]

CountedRef::CountedRef ( data_ptr arg )

inlineprotected

Recover previously constructed reference.

Definition at line 227 of file countedref.cc.

227: m_data(arg) { assume(arg); }

assume

#define assume(x)

Definition: mod2.h:389

◆ CountedRef() [3/3]

CountedRef::CountedRef ( const self & rhs )

inline

Construct copy.

Definition at line 231 of file countedref.cc.

231: m_data(rhs.m_data) { }

◆ ~CountedRef()

CountedRef::~CountedRef ( )

inline

Kills the link to the referenced object.

Definition at line 271 of file countedref.cc.

271{ }

Member Function Documentation

◆ assign()

BOOLEAN CountedRef::assign	(	leftv	result,
		leftv	arg
	)

inline

Definition at line 239 of file countedref.cc.

                                          {
    return m_data->assign(result,arg);
  }

◆ broken()

BOOLEAN CountedRef::broken ( )

inline

Check whether object in valid in current context.

Definition at line 282 of file countedref.cc.

282{return m_data->broken(); }

CountedRefData::broken

BOOLEAN broken() const

Check whether identifier became invalid.

Definition: countedref.cc:123

◆ cast() [1/2]

static self CountedRef::cast ( leftv arg )

inlinestatic

Recover the actual object from Singular interpreter object.

Definition at line 318 of file countedref.cc.

                              {
    assume(arg != NULL); assume(is_ref(arg));
    return self::cast(arg->Data());
  }

◆ cast() [2/2]

static self CountedRef::cast ( void * data )

inlinestatic

Recover the actual object from raw Singular data.

Definition at line 312 of file countedref.cc.

                               {
    assume(data != NULL);
    return self(static_cast<data_type*>(data));
  }

◆ construct() [1/3]

static BOOLEAN CountedRef::construct ( leftv res )

inlinestatic

Construct void-style object.

Definition at line 344 of file countedref.cc.

                                      {
    res->data = NULL;
    res->rtyp = NONE;
    return FALSE;
  }

◆ construct() [2/3]

static BOOLEAN CountedRef::construct	(	leftv	res,
		const char *	data
	)

inlinestatic

Construct string.

Definition at line 338 of file countedref.cc.

                                                        {
    res->data = (void*)omStrDup(data);
    res->rtyp = STRING_CMD;
    return FALSE;
  }

◆ construct() [3/3]

static BOOLEAN CountedRef::construct	(	leftv	res,
		long	data
	)

inlinestatic

Construct integer value.

Definition at line 331 of file countedref.cc.

                                                 {
    res->data = (void*) data;
    res->rtyp = INT_CMD;
    return FALSE;
  }

◆ count()

BOOLEAN CountedRef::count ( leftv res )

inline

Get number of references pointing here, too.

Definition at line 288 of file countedref.cc.

288{ return construct(res, m_data.count() - 1); }

CountedRefPtr::count

count_type count() const

Store actual pointer.

Definition: countedref.h:95

CountedRef::construct

static BOOLEAN construct(leftv res, long data)

Construct integer value.

Definition: countedref.cc:331

◆ dereference()

BOOLEAN CountedRef::dereference ( leftv arg )

inline

Replaces argument by a shallow copy of the references data.

Definition at line 274 of file countedref.cc.

                                 {
    m_data.reclaim();
    BOOLEAN b= m_data->put(arg) || ((arg->next != NULL) && resolve(arg->next));
    m_data.release();
    return b;
  }

◆ destruct()

void CountedRef::destruct ( )

inline

Kills a link to the referenced object.

Definition at line 268 of file countedref.cc.

268{ m_data.release(); }

◆ enumerate()

BOOLEAN CountedRef::enumerate ( leftv res )

inline

Definition at line 291 of file countedref.cc.

291{ return construct(res, (long)(data_type*)m_data); }

◆ is_ref()

static BOOLEAN CountedRef::is_ref ( leftv arg )

inlinestatic

Check whether argument is already a reference type.

Note: We check for the function pointer countedref_CheckAssign here, that we (ab-)use as a unique marker. This avoids to check a bunch of of runtime-varying typ IDs for identifying reference-like types.

Definition at line 216 of file countedref.cc.

                                   {
    int typ = arg->Typ();
    return ((typ > MAX_TOK) &&
            (getBlackboxStuff(typ)->blackbox_CheckAssign == countedref_CheckAssign));
  }

◆ likewise()

BOOLEAN CountedRef::likewise	(	leftv	res,
		leftv	arg
	)

inline

Check for likewise identifiers.

Definition at line 294 of file countedref.cc.

                                         {
    return resolve(arg) || construct(res, operator*()->data == arg->data);
  }

◆ name()

BOOLEAN CountedRef::name ( leftv res )

inline

Get (possibly) internal identifier name.

Definition at line 309 of file countedref.cc.

309{ return construct(res, operator*()->Name()); }

◆ operator*()

LeftvShallow CountedRef::operator* ( )

inline

Extract (shallow) copy of stored data.

Definition at line 244 of file countedref.cc.

244{ return m_data->operator*(); }

◆ operator=()

self & CountedRef::operator= ( const self & rhs )

inline

Replace reference.

Definition at line 234 of file countedref.cc.

                                   {
    m_data = rhs.m_data;
    return *this;
  }

◆ outcast() [1/3]

data_type * CountedRef::outcast ( )

inline

Construct raw reference data.

Definition at line 262 of file countedref.cc.

                       {
    m_data.reclaim();
    return m_data;
  }

◆ outcast() [2/3]

BOOLEAN CountedRef::outcast ( leftv res )

inline

Construct reference data object from *this.

Definition at line 253 of file countedref.cc.

                             {
    if (res->rtyp == IDHDL)
      IDDATA((idhdl)res->data) = (char *)outcast();
    else
      res->data = (void *)outcast();
    return FALSE;
  }

◆ outcast() [3/3]

BOOLEAN CountedRef::outcast	(	leftv	res,
		int	typ
	)

inline

Construct reference data object marked by given identifier number.

Definition at line 247 of file countedref.cc.

                                      {
    res->rtyp = typ;
    return outcast(res);
  }

◆ resolve()

static BOOLEAN CountedRef::resolve ( leftv arg )

inlinestatic

If necessary dereference.

Definition at line 324 of file countedref.cc.

                                    {
    assume(arg != NULL);
    while (is_ref(arg)) { if(CountedRef::cast(arg).dereference(arg)) return TRUE; };
    return (arg->next != NULL) && resolve(arg->next);
  }

◆ same()

BOOLEAN CountedRef::same	(	leftv	res,
		leftv	arg
	)

inline

Check for identical reference objects.

Definition at line 299 of file countedref.cc.

                                     {
    return construct(res, m_data == arg->Data());
  }

◆ type()

BOOLEAN CountedRef::type ( leftv res )

inline

Get type of references data.

Definition at line 304 of file countedref.cc.

                          {
    return construct(res, Tok2Cmdname(operator*()->Typ()));
  };

◆ unassigned()

BOOLEAN CountedRef::unassigned ( ) const

inline

Check whether (shared) data was initialized but not assigned yet.

Definition at line 285 of file countedref.cc.

285{ return m_data->unassigned(); }

CountedRefData::unassigned

BOOLEAN unassigned() const

Check whether data is all-zero.

Definition: countedref.cc:154

Field Documentation

◆ m_data

data_ptr CountedRef::m_data

protected

Store pointer to actual data.

Definition at line 352 of file countedref.cc.

The documentation for this class was generated from the following file:

Singular/countedref.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Detailed Description

Member Typedef Documentation

◆ data_ptr

◆ data_type

◆ id_type

◆ self

Constructor & Destructor Documentation

◆ CountedRef() [1/3]

◆ CountedRef() [2/3]

◆ CountedRef() [3/3]

◆ ~CountedRef()

Member Function Documentation

◆ assign()

◆ broken()

◆ cast() [1/2]

◆ cast() [2/2]

◆ construct() [1/3]

◆ construct() [2/3]

◆ construct() [3/3]

◆ count()

◆ dereference()

◆ destruct()

◆ enumerate()

◆ is_ref()

◆ likewise()

◆ name()

◆ operator*()

◆ operator=()

◆ outcast() [1/3]

◆ outcast() [2/3]

◆ outcast() [3/3]

◆ resolve()

◆ same()

◆ type()

◆ unassigned()

Field Documentation

◆ m_data