---

lib/gobj/object.h

Go to the documentation of this file.

/* lib/object.h - common object type implementation
   Copyright (C) 1999, 2000, 2001 Thomas Uehlinger

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2, or (at your option)
   any later version.

   This program 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 General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */

#include <gobjconfig.h>

#ifndef gobj_lib_object_h
#define gobj_lib_object_h

#include <gobj/decls.h>
#include <gobj/id.h>
#include <gobj/context.h>
#include <gobj/nativetypes.h>

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
#if 0
}
#endif


Gj_Object* Gj_object_new(Gj_Ctx* ctx, Gj_Id* type, char* name);


Gj_Object* Gj_object_duplicate(Gj_Ctx* ctx, Gj_Object* obj);


/*
   @brief Create a new object as a copy of existing object, but do not copy the native data (for convert copy).
   
   @param c
 * Error: returns the poindter to the new object on success, 0 otherwise
 *
 */
/*Gj_Object* gj_object_duplicateInternal(Gj_Ctx* ctx, Gj_Object* obj);*/


Gj_Object* Gj_object_create(Gj_Ctx* ctx, Gj_Stream* stream, Gj_Object* update);


int Gj_object_delete(Gj_Ctx* ctx, Gj_Object* ptr);


int Gj_object_deleteLocal(Gj_Ctx* ctx, Gj_Object* ptr);


int Gj_object_write(Gj_Ctx* ctx, Gj_Object* obj, Gj_Stream* stream);


#ifdef GJ_LOCKING
void gj_object_initLocks(Gj_Object* obj);
#else
#define gj_object_initLocks(a)
#endif


#ifdef GJ_LOCKING
void gj_object_finalizeLocks(Gj_Object* obj);
#else
#define gj_object_finalizeLocks(a)
#endif


/*
 * Aquire a "delete lock" for the object (aquire a exclusive lock even if there is one shared lock aquired)
 *
 */
/*void gj_object_lockDelete(Gj_Object* obj);*/


#ifdef GJ_LOCKING
void gj_object_lockShared(Gj_Object* obj);
#else
#define gj_object_lockShared(a)
#endif


#ifdef GJ_LOCKING
void Gj_object_unlockShared(Gj_Object* obj);
#else
#define Gj_object_unlockShared(a)
#endif


int Gj_object_release(Gj_Ctx* ctx, Gj_Object* obj);

 
#ifdef GJ_LOCKING
void Gj_object_lockExcl(Gj_Object* obj);
#else
#define Gj_object_lockExcl(a)
#endif


#ifdef GJ_LOCKING
void Gj_object_unlockExcl(Gj_Object* obj);
#else
#define Gj_object_unlockExcl(a)
#endif


/*
   @brief Activate the "follow link" mode for this object.
 * Error: returns 0 on success, -1 otherwise
 *
 */
/*int Gj_object_followLinksOn(Gj_Ctx* ctx, Gj_Object* obj);*/


/*
 * Disactivate the "follow link" mode for this object
 * set links to the number of links the function should follow at most (-1 means as many as possible)
 * Error: returns 0 on success, -1 otherwise
 * 
 */
/*int Gj_object_followLinksOff(Gj_Ctx* ctx, Gj_Object* obj, int links);*/


Gj_Id* Gj_object_assignId(Gj_Ctx* ctx, Gj_Object* obj);


void Gj_object_markTemp(Gj_Object* obj);


Gj_Bool Gj_object_isTemp(Gj_Object* obj);


int Gj_object_getName(Gj_Ctx* ctx, Gj_Object* obj, char** name);


/*
 * Set the name of the object
 * the name is being DUPLICATED
 * name may be 0
 * Error: returns 0 on success, -1 otherwise
 *
 */
int Gj_object_setName(Gj_Ctx* ctx, Gj_Object* obj, char* name);


/*
 * Get the native type of the object
 * Error: returns the nativetype on success, GJ_NTYPES_NONE (=0) on error
 *
 */
Gj_Nativetype Gj_object_getNativetype(Gj_Ctx* ctx, Gj_Object* obj);

 
/*
 * Set the value of a property given by name (only used for instances of models with fixed properties)
 * the value object is NOT duplicated
 * Error: returns 0 on success, -1 otherwise
 *
 */
int Gj_object_setByName(Gj_Ctx* ctx, Gj_Object* obj, char* name, Gj_Object* value);


/*
 * Set the value of a property/child given by its number
 * the value object is NOT duplicated
 * Error: returns 0 on success, -1 otherwise
 *
 */
int Gj_object_setByNumber(Gj_Ctx* ctx, Gj_Object* obj, int index, Gj_Object* value);


/*
 * Get the value of a property given by its name (only used for instances of models with fixed properties)
 * the *value object is STILL OWNED by the object
 * *value == 0 means that this property has no value
 * Error: returns 0 on success, -1 otherwise
 *
 */
int Gj_object_getByName(Gj_Ctx* ctx, Gj_Object* obj, char* name, Gj_Object** value, Gj_Bool convert);
 

/*
 * Get the value of a property/child given by its number
 * the *value object is STILL OWNED by the object
 * *value == 0 means that this property has no value
 * Error: returns 0 on success, -1 otherwise
 *
 */
int Gj_object_getByNumber(Gj_Ctx* ctx, Gj_Object* obj, int index, Gj_Object** value, Gj_Bool convert);


/*
 * Set *last to the next element of the child walkthrough (only used for instances of models with non-fixed properties) 
 * if *last is 0, the first element is set
 * the returned child is STILL OWNED by the object
 * a null pointer is set if the last element was already reached
 * if the object is a link, DO NOT change the followLinks flag and/or the link itself during calls to this function
 * Error: returns 0 on success, -1 otherwise
 *
 */
int Gj_object_nextChild(Gj_Ctx* ctx, Gj_Object* obj, Gj_Object** last, Gj_Bool convert);


/*
 * Get the child count of the object (only used for instances of models with non-fixed properties)
 * Error: returns the child count on success, -1 otherwise
 *
 */
int Gj_object_getChildCount(Gj_Ctx* ctx, Gj_Object* obj);


/*
 * Add a child (only used for types with non-fixed properties)
 * the value object is NOT DUPLICATED
 * Error: returns the number of the new add child on success, -1 otherwise
 *
 */
int Gj_object_add(Gj_Ctx* ctx, Gj_Object* obj, Gj_Object* value);


/* INTERNAL (no link following and native function calls are made)
 * Add a child (only used for types with non-fixed properties)
 * the value object is NOT DUPLICATED
 * Error: returns the number of the new add child on success, -1 otherwise
 *
 */
int gj_object_add(Gj_Ctx* ctx, Gj_Object* obj, Gj_Object* value);


/*
 * Remove a child given by name (only used for types with non-fixed properties)
 * the value object is deleted
 * Error: returns 0 on success, -1 otherwise
 *
 */
/*int Gj_object_removeByName(Gj_Ctx* ctx, Gj_Object* obj, char* name);*/


/*
 * Remove a child given by its number (only used for types with non-fixed properties)
 * the value object is deleted
 * Error: returns 0 on success, -1 otherwise
 *
 */
int Gj_object_removeByNumber(Gj_Ctx* ctx, Gj_Object* obj, int index);


/*
 * Pass the object them through the viewers and convert it to a given type
 * if type == 0 no final type conversion is done
 * if the resulting pointer is != obj, delete the resulting object afterwards via Gj_object_deleteTemp()
 * Error: returns the pointer to the resulting object on success, 0 otherwise
 *
 */
Gj_Object* Gj_object_convert(Gj_Ctx* ctx, Gj_Object* obj, Gj_Id* type);


/*
 * Add a viewer to the object
 * the viewer is NOT DUPLICATED
 * Error: returns 0 on success, -1 otherwise
 *
 */
int Gj_object_addViewer(Gj_Ctx* ctx, Gj_Object* obj, Gj_Viewer* viewer);


/*
 * Delete all viewers of the object
 * Error: returns 0 on success, -1 otherwise
 *
 */
int Gj_object_deleteViewers(Gj_Ctx* ctx, Gj_Object* obj);


#ifdef GJ_STDIO
#include <stdio.h>
/*
 * Dump the object onto the given stream
 * if you call this function yourself *indent should be 0
 *
 */
void Gj_object_dump(Gj_Ctx* ctx, Gj_Object* obj, FILE* s, int* indent);
#endif


struct Gj_Object_struct {
  
  char* name;

  Gj_Model* model;

  Gj_Object* parent;
  Gj_Object* update;

  Gj_Viewer* viewers;

  Gj_Bool fixedProperties;
  Gj_Bool vaccess;
  Gj_Bool temp;
  Gj_Bool link;

#ifdef GJ_LOCKING
  Gj_Bool exclLock;
  int sharedLocks;
#endif

  union {
    Gj_Object** fix;
    
    struct {
      Gj_Object* first;
      Gj_Object* last;
    } notfix;
  } children;

  Gj_Object* next;

};


/* INTERNAL
 * the linkrecord structure
 *
 */
struct gj_Linkrecord_struct {

  Gj_Object* obj;

  Gj_Viewer* viewer;

};


#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* !gobj_lib_object_h */

---