getPropertyAssignedValue.h File Reference

#include "machine.h"

Include dependency graph for getPropertyAssignedValue.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	AssignedList
Functions
BOOL	isParameterHandle (int type)
BOOL	isParameterDoubleMatrix (int type)
BOOL	isParameterTlist (int type)
BOOL	isParameterStringMatrix (int type)
double	getDoubleFromStack (int stackPointer)
double *	getDoubleMatrixFromStack (int stackPointer)
void	copyDoubleVectorFromStack (int stackPointer, double dest[], int nbElement)
void	copyDoubleVectorToIntFromStack (int stackPointer, int dest[], int nbElement)
double *	createCopyDoubleVectorFromStack (int stackPointer, int nbElement)
char *	getStringFromStack (int stackPointer)
char **	getStringMatrixFromStack (int stackPointer)
char **	createCopyStringMatrixFromStack (int stackPointer, int nbElement)
unsigned long	getHandleFromStack (int stackPointer)
BOOL	isStringParamEqual (int stackPointer, const char *str)
int	getStackListNbElement (int paramNum)
AssignedList *	createAssignedList (int paramNum, int nbElement)
void	destroyAssignedList (AssignedList *list)
int	getAssignedListNbElement (AssignedList *list)
void	rewindAssignedList (AssignedList *list)
BOOL	isListCurrentElementDoubleMatrix (AssignedList *list)
BOOL	isListCurrentElementStringMatrix (AssignedList *list)
BOOL	isListCurrentElementEmptyMatrix (AssignedList *list)
double *	getDoubleMatrixFromList (AssignedList *list, int rank, int *nbRow, int *nbCol)
char **	getStringMatrixFromList (AssignedList *list, int rank, int *nbRow, int *nbCol)
double *	getCurrentDoubleMatrixFromList (AssignedList *list, int *nbRow, int *nbCol)
char **	getCurrentStringMatrixFromList (AssignedList *list, int *nbRow, int *nbCol)
double *	createCopyDoubleMatrixFromList (AssignedList *list, int *nbRow, int *nbCol)
char **	createCopyStringMatrixFromList (AssignedList *list, int *nbRow, int *nbCol)

---

Function Documentation

void copyDoubleVectorFromStack	(	int	stackPointer,
		double	dest[],
		int	nbElement
	)

copy a double vector from the scilab stack

Definition at line 47 of file getPropertyAssignedValue.c.

References doubleArrayCopy(), and getDoubleMatrixFromStack().

Referenced by createCopyDoubleVectorFromStack(), set_axes_bounds_property(), set_data_bounds_property(), set_margins_property(), set_surface_color_property(), and set_triangles_property().

{ 
  doubleArrayCopy( dest, getDoubleMatrixFromStack( stackPointer ), nbElement ) ;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void copyDoubleVectorToIntFromStack	(	int	stackPointer,
		int	dest[],
		int	nbElement
	)

copy a double vector from the scilab stack to an int array with int cast for each parameter.

Definition at line 52 of file getPropertyAssignedValue.c.

References getDoubleMatrixFromStack(), and i.

Referenced by set_interp_color_vector_property(), and set_segs_color_property().

{ 
  int i ;
  double * values = getDoubleMatrixFromStack( stackPointer ) ;
  for ( i = 0 ; i < nbElement ; i++ )
  {
    dest[i] = (int) values[i] ;
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

AssignedList* createAssignedList	(	int	paramNum,
		int	nbElement
	)

create a new instance of an object used to retrieve fields of a tlist stored on the stack

Parameters:

	paramNum	rank of the list within the Rhs parameters
	nbElement	number of element in the list

Definition at line 149 of file getPropertyAssignedValue.c.

References AssignedList::curElement, GetRhsVar, MALLOC, AssignedList::nbElement, NULL, AssignedList::paramNumber, sciprint(), and AssignedList::stackPointer.

Referenced by createTlistForTicks(), and set_data_property().

{
  AssignedList * newList = NULL ;
  int nbRow = 0 ;
  int nbCol = 0 ;

  newList = MALLOC( sizeof(AssignedList) ) ;

  if ( newList == NULL )
  {
    return NULL ;
  }

  newList->nbElement   = nbElement + 1 ;
  newList->curElement  = 2 ; /* begin with 1 and 1 are the names */
  newList->paramNumber = paramNum ;

  /* get the stack pointer */
  GetRhsVar( paramNum, "t", &nbRow, &nbCol, &(newList->stackPointer) ) ;

  /* check the size */
  if ( nbRow != newList->nbElement || nbCol != 1 )
  {
    sciprint( "Wrong size for tlist.\n" ) ;
    return NULL ;
  }
  return newList ;
}

Here is the call graph for this function:

Here is the caller graph for this function:

double* createCopyDoubleMatrixFromList	(	AssignedList *	list,
		int *	nbRow,
		int *	nbCol
	)

create a copy of the current matrix in the tlist

Parameters:

	in/out]	list object used to retrieve elements
[out]	nbRow	number of row of the returned matrix or -1 if an error occurred
[out]	nbCol	number of column of the returned matrix or -1 if an error occurred

Returns:

the created array or NULL if the matrix is empty or an error occured

Definition at line 272 of file getPropertyAssignedValue.c.

References doubleArrayCopy(), getCurrentDoubleMatrixFromList(), MALLOC, and NULL.

Referenced by set3ddata(), set_x_ticks_property(), set_y_ticks_property(), set_z_ticks_property(), setchampdata(), and setgrayplotdata().

{
  /* get the matrix */
  double * stackValues = getCurrentDoubleMatrixFromList( list, nbRow, nbCol ) ;
  int nbElement = (*nbRow) * (*nbCol) ;

  double * copyMatrix = NULL ;

  if ( nbElement == 0 )
  {
    return NULL ;
  }

  /* copy */

  copyMatrix = MALLOC( (*nbRow) * (*nbCol) * sizeof( double ) ) ;

  if ( copyMatrix == NULL )
  { 
    *nbRow = -1 ;
    *nbCol = -1 ;
    return NULL ;
  }

  doubleArrayCopy( copyMatrix, stackValues, nbElement ) ;

  return copyMatrix ;

}

Here is the call graph for this function:

Here is the caller graph for this function:

double* createCopyDoubleVectorFromStack	(	int	stackPointer,
		int	nbElement
	)

create a copy of a vector (or Matrix) of double stored in the stack

Definition at line 62 of file getPropertyAssignedValue.c.

References copyDoubleVectorFromStack(), MALLOC, NULL, and res.

Referenced by set_triangles_property(), set_x_shift_property(), set_xtics_coord_property(), set_y_shift_property(), set_ytics_coord_property(), and set_z_shift_property().

{
  double * res = MALLOC( nbElement * sizeof(double) ) ;
  if ( res == NULL )
  {
    return NULL ;
  }
  copyDoubleVectorFromStack( stackPointer, res, nbElement ) ;
  return res ;
}

Here is the call graph for this function:

Here is the caller graph for this function:

char** createCopyStringMatrixFromList	(	AssignedList *	list,
		int *	nbRow,
		int *	nbCol
	)

create a copy of the current matrix in the tlist

Parameters:

	in/out]	list object used to retrieve elements
[out]	nbRow	number of row of the returned matrix
[out]	nbCol	number of column of the returned matrix

Definition at line 302 of file getPropertyAssignedValue.c.

References createStringArrayCopy(), getCurrentStringMatrixFromList(), and NULL.

Referenced by set_x_ticks_property(), set_y_ticks_property(), and set_z_ticks_property().

{
  /* get the matrix */
  char ** stackValues = getCurrentStringMatrixFromList( list, nbRow, nbCol ) ;
  int nbElement = (*nbRow) * (*nbCol) ;

  if ( nbElement == 0 )
  {
    return NULL ;
  }

  return createStringArrayCopy( stackValues, nbElement ) ;
}

Here is the call graph for this function:

Here is the caller graph for this function:

char** createCopyStringMatrixFromStack	(	int	stackPointer,
		int	nbElement
	)

create a copy of a stringMatrix which is in the stack

Definition at line 84 of file getPropertyAssignedValue.c.

References FREE, getStringMatrixFromStack(), i, j, MALLOC, NULL, res, and size.

Referenced by set_tics_labels_property().

{
  int i ;
  char ** res    = MALLOC( nbElement * sizeof(char *) ) ;
  char ** values = getStringMatrixFromStack( stackPointer ) ;
  
  if ( res == NULL )
  {
    return NULL ;
  }

  for ( i = 0 ; i < nbElement ; i++ )
  {
    int size = strlen( values[i] ) + 1 ;
    res[i] = MALLOC( size * sizeof(char) ) ;

    if ( res[i] == NULL )
    {
      /* deallocate what have been allocated */
      int j ;
      for ( j = 0 ; j < i ; j++ )
      {
        FREE( res[j] ) ;
      }
      FREE( res ) ;
      return NULL ;
    }

    strcpy( res[i], values[i] ) ;
  }

  return res ;

}

Here is the call graph for this function:

Here is the caller graph for this function:

void destroyAssignedList

(

AssignedList *

list

)

destroy the object used to glance through a tlist

Definition at line 178 of file getPropertyAssignedValue.c.

References FREE.

Referenced by set_data_property(), set_x_ticks_property(), set_y_ticks_property(), and set_z_ticks_property().

{
  FREE( list ) ;
}

Here is the caller graph for this function:

int getAssignedListNbElement

(

AssignedList *

list

)

return the number of element of a tlist

Definition at line 183 of file getPropertyAssignedValue.c.

References AssignedList::nbElement.

Referenced by set3ddata().

{
  return list->nbElement - 1 ;
}

Here is the caller graph for this function:

double* getCurrentDoubleMatrixFromList	(	AssignedList *	list,
		int *	nbRow,
		int *	nbCol
	)

retrieve the current property of a tlist and move to the next

Parameters:

	in/out]	list object used to retrieve elements
[out]	nbRow	number of row of the returned matrix
[out]	nbCol	number of column of the returned matrix

Definition at line 241 of file getPropertyAssignedValue.c.

References AssignedList::curElement, getDoubleMatrixFromList(), AssignedList::nbElement, NULL, and res.

Referenced by createCopyDoubleMatrixFromList(), createTlistForTicks(), and set3ddata().

{
  double * res = NULL ;
  if ( list->curElement > list->nbElement )
  {
    *nbRow = 0 ;
    *nbCol = 0 ;
    return NULL ;
  }

  res = getDoubleMatrixFromList( list, list->curElement, nbRow, nbCol ) ;
  list->curElement++ ;
  return res ;
}

Here is the call graph for this function:

Here is the caller graph for this function:

char** getCurrentStringMatrixFromList	(	AssignedList *	list,
		int *	nbRow,
		int *	nbCol
	)

retrieve the current property of a tlist and move to the next

Parameters:

	in/out]	list object used to retrieve elements
[out]	nbRow	number of row of the returned matrix
[out]	nbCol	number of column of the returned matrix

Definition at line 256 of file getPropertyAssignedValue.c.

References AssignedList::curElement, getStringMatrixFromList(), AssignedList::nbElement, NULL, and res.

Referenced by createCopyStringMatrixFromList(), and createTlistForTicks().

{
  char ** res = NULL ;
  if ( list->curElement > list->nbElement )
  {
    *nbRow = 0 ;
    *nbCol = 0 ;
    return NULL ;
  }

  res = getStringMatrixFromList( list, list->curElement, nbRow, nbCol ) ;
  list->curElement++ ;
  return res ;

}

Here is the call graph for this function:

Here is the caller graph for this function:

double getDoubleFromStack

(

int

stackPointer

)

retrieve a single double from the stack

Definition at line 37 of file getPropertyAssignedValue.c.

References stk.

Referenced by sci_show_window(), set_arrow_size_factor_property(), set_arrow_size_property(), set_background_property(), set_bar_width_property(), set_callbackmevent_property(), set_color_flag_property(), set_color_mode_property(), set_current_figure_property(), set_default_values_property(), set_figure_id_property(), set_font_angle_property(), set_font_color_property(), set_font_foreground_property(), set_font_size_property(), set_font_style_property(), set_foreground_property(), set_hidden_axis_color_property(), set_hidden_color_property(), set_labels_font_color_property(), set_labels_font_size_property(), set_labels_font_style_property(), set_line_style_property(), set_mark_background_property(), set_mark_foreground_property(), set_mark_size_property(), set_mark_style_property(), set_polyline_style_property(), set_position_property(), set_segs_color_property(), set_sub_tics_property(), set_thickness_property(), and set_tics_color_property().

{
  return *(stk( stackPointer ));
}

Here is the caller graph for this function:

double* getDoubleMatrixFromList	(	AssignedList *	list,
		int	rank,
		int *	nbRow,
		int *	nbCol
	)

retrieve a field of a tlist

Parameters:

[in]	list	object used to retrieve elements
	rank	position of the element in the list ( first, second, ...) Note that is it not possible to get the properties names with this function
[out]	nbRow	number of row of the returned matrix
[out]	nbCol	number of column of the returned matrix

Definition at line 225 of file getPropertyAssignedValue.c.

References getDoubleMatrixFromStack(), GetListRhsVar, and AssignedList::paramNumber.

Referenced by getCurrentDoubleMatrixFromList(), and isListCurrentElementEmptyMatrix().

{
  int valueStackPointer = 0 ;
  GetListRhsVar( list->paramNumber, rank, "d", nbRow, nbCol, &valueStackPointer ) ;
  
  return getDoubleMatrixFromStack( valueStackPointer ) ;
}

Here is the call graph for this function:

Here is the caller graph for this function:

double* getDoubleMatrixFromStack

(

int

stackPointer

)

retrieve a double matrix from the scilab stack

Definition at line 42 of file getPropertyAssignedValue.c.

References stk.

Referenced by copyDoubleVectorFromStack(), copyDoubleVectorToIntFromStack(), getdDataBoundsFromStack(), getDoubleMatrixFromList(), set_axes_size_property(), set_clip_box_property(), set_color_map_property(), set_data_property(), set_figure_position_property(), set_figure_size_property(), set_grid_property(), set_interp_color_vector_property(), set_position_property(), set_rotation_angles_property(), set_sub_tics_property(), set_text_box_property(), set_viewport_property(), set_z_bounds_property(), and set_zoom_box_property().

{
  return stk( stackPointer ) ;
}

Here is the caller graph for this function:

unsigned long getHandleFromStack

(

int

stackPointer

)

retireve a string on from the scilab stack

Definition at line 119 of file getPropertyAssignedValue.c.

References hstk.

Referenced by sci_show_window(), set_current_axes_property(), set_current_entity_property(), and set_current_figure_property().

{
  return (unsigned long) *(hstk( stackPointer )) ;
}

Here is the caller graph for this function:

int getStackListNbElement

(

int

paramNum

)

get the number of element of a tlist stored in the rhs

Parameters:

paramNum

rank of the list within the Rhs parameters

Definition at line 137 of file getPropertyAssignedValue.c.

References GetRhsVar.

Referenced by set_data_property().

{
  int nbRow        = 0 ;
  int nbCol        = 0 ;
  int stackPointer = 0 ;

  GetRhsVar( paramNum, "t", &nbRow, &nbCol, &stackPointer ) ;

  return nbRow - 1 ;

 }

Here is the caller graph for this function:

char* getStringFromStack

(

int

stackPointer

)

retrieve a string on from the scilab stack

Definition at line 73 of file getPropertyAssignedValue.c.

References cstk.

Referenced by isStringParamEqual(), set_callback_property(), set_data_mapping_property(), set_figure_name_property(), set_font_name_property(), set_format_n_property(), set_info_message_property(), set_log_flags_property(), set_old_style_property(), set_pixel_drawing_mode_property(), set_rotation_style_property(), set_tics_style_property(), and set_visible_property().

{
  return cstk( stackPointer ) ;
}

Here is the caller graph for this function:

char** getStringMatrixFromList	(	AssignedList *	list,
		int	rank,
		int *	nbRow,
		int *	nbCol
	)

retrieve a field of a tlist

Parameters:

[in]	list	object used to retrieve elements
	rank	position of the element in the list ( first, second, ...) Note that is it not possible to get the properties names with this function
[out]	nbRow	number of row of the returned matrix
[out]	nbCol	number of column of the returned matrix

Definition at line 233 of file getPropertyAssignedValue.c.

References GetListRhsVar, getStringMatrixFromStack(), and AssignedList::paramNumber.

Referenced by getCurrentStringMatrixFromList().

{
  int valueStackPointer = 0 ;
  GetListRhsVar( list->paramNumber, rank, "S", nbRow, nbCol, &valueStackPointer ) ;

  return getStringMatrixFromStack( valueStackPointer ) ;
}

Here is the call graph for this function:

Here is the caller graph for this function:

char** getStringMatrixFromStack

(

int

stackPointer

)

retrieve a string matrix on from the scilab stack

Definition at line 78 of file getPropertyAssignedValue.c.

Referenced by createCopyStringMatrixFromStack(), getStringMatrixFromList(), set_auto_ticks_property(), set_axes_reverse_property(), set_axes_visible_property(), and set_text_property().

{
  /* strange but it was taken from sci_set */
  return (char **) stackPointer ;
}

Here is the caller graph for this function:

BOOL isListCurrentElementDoubleMatrix

(

AssignedList *

list

)

Return whether the current element of the list is a double matrix or not.

Definition at line 193 of file getPropertyAssignedValue.c.

References AssignedList::curElement, ElementType, and AssignedList::paramNumber.

Referenced by createTlistForTicks(), and isListCurrentElementEmptyMatrix().

{
  return ( ElementType( list->paramNumber, list->curElement ) == 1 ) ;
}

Here is the caller graph for this function:

BOOL isListCurrentElementEmptyMatrix

(

AssignedList *

list

)

Return whether the current element of the list is an empty matrix or not.

Definition at line 203 of file getPropertyAssignedValue.c.

References AssignedList::curElement, FALSE, getDoubleMatrixFromList(), isListCurrentElementDoubleMatrix(), and TRUE.

Referenced by createTlistForTicks().

{
  int nbRow = 0 ;
  int nbCol = 0 ;

  if ( !isListCurrentElementDoubleMatrix( list ) )
  {
    /* empty matrix is a double matrix */
    return FALSE ;
  }

  getDoubleMatrixFromList( list, list->curElement, &nbRow, &nbCol ) ;

  if ( nbRow * nbCol == 0 )
  {
    return TRUE ;
  }

  return FALSE ;

}

Here is the call graph for this function:

Here is the caller graph for this function:

BOOL isListCurrentElementStringMatrix

(

AssignedList *

list

)

Return whether the current element of the list is a string matrix or not.

Definition at line 198 of file getPropertyAssignedValue.c.

References AssignedList::curElement, ElementType, and AssignedList::paramNumber.

Referenced by createTlistForTicks().

{
  return ( ElementType( list->paramNumber, list->curElement ) == 10 ) ;
}

Here is the caller graph for this function:

BOOL isParameterDoubleMatrix

(

int

type

)

return if a stack parameter is a Handle

Parameters:

type

type of the parameter

Definition at line 22 of file getPropertyAssignedValue.c.

Referenced by sci_show_window(), set_arrow_size_factor_property(), set_arrow_size_property(), set_axes_bounds_property(), set_axes_size_property(), set_background_property(), set_bar_width_property(), set_callbackmevent_property(), set_clip_box_property(), set_color_flag_property(), set_color_map_property(), set_color_mode_property(), set_current_figure_property(), set_data_bounds_property(), set_data_property(), set_default_values_property(), set_figure_id_property(), set_figure_position_property(), set_figure_size_property(), set_font_angle_property(), set_font_color_property(), set_font_foreground_property(), set_font_size_property(), set_font_style_property(), set_foreground_property(), set_grid_property(), set_hidden_axis_color_property(), set_hidden_color_property(), set_interp_color_vector_property(), set_labels_font_color_property(), set_labels_font_size_property(), set_labels_font_style_property(), set_line_style_property(), set_margins_property(), set_mark_background_property(), set_mark_foreground_property(), set_mark_size_property(), set_mark_style_property(), set_polyline_style_property(), set_position_property(), set_rotation_angles_property(), set_segs_color_property(), set_sub_tics_property(), set_surface_color_property(), set_text_box_property(), set_thickness_property(), set_tics_color_property(), set_triangles_property(), set_viewport_property(), set_x_shift_property(), set_xtics_coord_property(), set_y_shift_property(), set_z_bounds_property(), set_z_shift_property(), set_zoom_box_property(), and set_zoom_state_property().

{
  return ( type == 1 ) ;
}

Here is the caller graph for this function:

BOOL isParameterHandle

(

int

type

)

return if a stack parameter is a Handle

Parameters:

type

type of the parameter

Definition at line 17 of file getPropertyAssignedValue.c.

Referenced by sci_show_window(), set_current_axes_property(), set_current_entity_property(), and set_current_figure_property().

{
  return ( type == 9 ) ;
}

Here is the caller graph for this function:

BOOL isParameterStringMatrix

(

int

type

)

return if a stack parameter is a string matrix

Parameters:

type

type of the parameter

Definition at line 32 of file getPropertyAssignedValue.c.

Referenced by set_alignment_property(), set_auto_clear_property(), set_auto_dimensionning_property(), set_auto_position_property(), set_auto_resize_property(), set_auto_rotation_property(), set_auto_scale_property(), set_auto_ticks_property(), set_axes_reverse_property(), set_axes_visible_property(), set_bar_layout_property(), set_box_property(), set_callback_property(), set_callback_type_property(), set_cdata_mapping_property(), set_clip_state_property(), set_closed_property(), set_colored_property(), set_cube_scaling_property(), set_data_mapping_property(), set_figure_name_property(), set_figure_style_property(), set_fill_mode_property(), set_font_name_property(), set_format_n_property(), set_handle_visible_property(), set_immediate_drawing_property(), set_info_message_property(), set_interp_color_mode_property(), set_isoview_property(), set_line_mode_property(), set_log_flags_property(), set_mark_mode_property(), set_mark_size_unit_property(), set_menu_enable_property(), set_old_style_property(), set_pixel_drawing_mode_property(), set_rotation_style_property(), set_surface_mode_property(), set_text_box_mode_property(), set_text_property(), set_tics_direction_property(), set_tics_labels_property(), set_tics_segment_property(), set_tics_style_property(), set_tight_limits_property(), set_view_property(), set_visible_property(), set_x_location_property(), and set_y_location_property().

{
  return ( type == 10 ) ;
}

Here is the caller graph for this function:

BOOL isParameterTlist

(

int

type

)

return if a stack parameter is a tlist

Parameters:

type

type of the parameter

Definition at line 27 of file getPropertyAssignedValue.c.

Referenced by set_data_property(), set_x_ticks_property(), set_y_ticks_property(), and set_z_ticks_property().

{
  return ( type == 16 ) ;
}

Here is the caller graph for this function:

BOOL isStringParamEqual	(	int	stackPointer,
		const char *	str
	)

compare the string stored in the stack with str

Returns:

TRUE is the string are equal (using strcmp) FALSE otherwise

Definition at line 124 of file getPropertyAssignedValue.c.

References FALSE, getStringFromStack(), and TRUE.

Referenced by set_alignment_property(), set_auto_clear_property(), set_auto_dimensionning_property(), set_auto_position_property(), set_auto_resize_property(), set_auto_rotation_property(), set_auto_scale_property(), set_bar_layout_property(), set_box_property(), set_callback_type_property(), set_cdata_mapping_property(), set_clip_state_property(), set_closed_property(), set_colored_property(), set_cube_scaling_property(), set_data_mapping_property(), set_figure_style_property(), set_fill_mode_property(), set_handle_visible_property(), set_immediate_drawing_property(), set_interp_color_mode_property(), set_isoview_property(), set_line_mode_property(), set_mark_mode_property(), set_mark_size_unit_property(), set_menu_enable_property(), set_old_style_property(), set_pixmap_property(), set_rotation_style_property(), set_surface_mode_property(), set_text_box_mode_property(), set_tics_direction_property(), set_tics_segment_property(), set_tics_style_property(), set_tight_limits_property(), set_view_property(), set_visible_property(), set_x_location_property(), set_y_location_property(), and set_zoom_state_property().

{
  if ( strcmp( getStringFromStack( stackPointer ), str ) == 0 )
  {
    return TRUE ;
  }
  else
  {
    return FALSE ;
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void rewindAssignedList

(

AssignedList *

list

)

set the current element to the first

Definition at line 188 of file getPropertyAssignedValue.c.

References AssignedList::curElement.

Referenced by createTlistForTicks(), and set3ddata().

{
  list->curElement = 2 ;
}

Here is the caller graph for this function:

---