s_sheet_data.c

Go to the documentation of this file.

/* gEDA - GPL Electronic Design Automation
 * gattrib -- gEDA component and net attribute manipulation using spreadsheet.
 * Copyright (C) 2003-2010 Stuart D. Brorson.
 *
 * 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 of the License, 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

/*--------------------------------------------------------------*/
#include <config.h>

#include <stdio.h>
#ifdef HAVE_STRING_H
#include <string.h>
#endif
#include <math.h>

/*------------------------------------------------------------------
 * Gattrib specific includes
 *------------------------------------------------------------------*/
#include <libgeda/libgeda.h>       /* geda library fcns  */
#include "../include/struct.h"     /* typdef and struct declarations */
#include "../include/prototype.h"  /* function prototypes */
#include "../include/globals.h"

#ifdef HAVE_LIBDMALLOC
#include <dmalloc.h>
#endif


/*------------------------------------------------------------------*/
SHEET_DATA *s_sheet_data_new()
{
  SHEET_DATA *new_sheet;

  new_sheet = (SHEET_DATA *) g_malloc(sizeof(SHEET_DATA));

  /* We will malloc and fill out the comp table later. */
  new_sheet->component_table = NULL;

  /* We will malloc and fill out the net table later. */
  new_sheet->net_table = NULL;

  /* We will malloc and fill out the pin table later. */
  new_sheet->pin_table = NULL;

  /* Now we create the first cell in each master list. */
  new_sheet->master_comp_list_head = (STRING_LIST *) s_string_list_new();
  new_sheet->master_comp_attrib_list_head = (STRING_LIST *) s_string_list_new();
  new_sheet->comp_count = 0;
  new_sheet->comp_attrib_count = 0;

  new_sheet->master_net_list_head = (STRING_LIST *) s_string_list_new();
  new_sheet->master_net_attrib_list_head = (STRING_LIST *) s_string_list_new();
  new_sheet->net_count = 0;
  new_sheet->net_attrib_count = 0;

  new_sheet->master_pin_list_head = (STRING_LIST *) s_string_list_new();
  new_sheet->master_pin_attrib_list_head = (STRING_LIST *) s_string_list_new();
  new_sheet->pin_count = 0;
  new_sheet->pin_attrib_count = 0;

  new_sheet->CHANGED = FALSE;

  return (new_sheet);

}



/*------------------------------------------------------------------*/
void s_sheet_data_add_master_comp_list_items (const GList *obj_list) {
  char *temp_uref;
  const GList *iter;
  
#ifdef DEBUG
  printf("=========== Just entered  s_sheet_data_add_master_comp_list_items!  ==============\n");
#endif

  if (verbose_mode) {
    printf("- Starting master comp list creation.\n");
  }

  /* -----  Iterate through all objects found on page looking for components  ----- */
  for (iter = obj_list;
       iter != NULL;
       iter = g_list_next (iter)) {
    OBJECT *o_current = iter->data;

#ifdef DEBUG
      printf("In s_sheet_data_add_master_comp_list_items, examining o_current->name = %s\n", o_current->name);
#endif

      /*-----  only process if this is a component with attributes ----*/
      if (o_current->type == OBJ_COMPLEX &&
          o_current->attribs != NULL) {

#if DEBUG
    printf("      In s_sheet_data_add_master_comp_list_items; found component on page\n");
    printf(". . . . complex_basename = %s.\n", o_current->complex_basename);
#endif
    verbose_print(" C");
      
    temp_uref = s_attrib_get_refdes(o_current);
    
    /* Now that we have refdes, store refdes and attach attrib list to component */
    if (temp_uref) {
#if DEBUG
      printf("       In s_sheet_add_master_comp_list, about to add to master list refdes = %s\n", temp_uref);
#endif
      s_string_list_add_item(sheet_head->master_comp_list_head, 
                  &(sheet_head->comp_count), temp_uref);
      g_free(temp_uref);
    }
    
      } /*  if (o_current->type == OBJ_COMPLEX . . . . .) */
      
  }
  
  return;
}


/*------------------------------------------------------------------*/
void s_sheet_data_add_master_comp_attrib_list_items (const GList *obj_list) {
  char *attrib_text;
  char *attrib_name;
  const GList *o_iter;
  GList *a_iter;
  OBJECT *a_current;
  
#ifdef DEBUG
  fflush(stderr);
  fflush(stdout);
  printf("=========== Just entered  s_sheet_data_add_master_comp_attrib_list_items!  ==============\n");
#endif

  if (verbose_mode) {
    printf("- Starting master comp attrib list creation.\n");
  }

  /* -----  Iterate through all objects found on page looking for components (OBJ_COMPLEX) ----- */
  for (o_iter = obj_list; o_iter != NULL; o_iter = g_list_next (o_iter)) {
    OBJECT *o_current = o_iter->data;

#ifdef DEBUG
      printf("In s_sheet_data_add_master_comp_attrib_list_items, examining o_current->name = %s\n", o_current->name);
#endif

      /*-----  only process if this is a component with attributes ----*/
      if (o_current->type == OBJ_COMPLEX &&
          o_current->attribs != NULL) {

    verbose_print(" C");
    
    /*------ Iterate through all attribs found on component -----*/
    a_iter = o_current->attribs; /* This has a side effect.  Why? */
    while (a_iter != NULL) {
      a_current = a_iter->data;
      if (a_current->type == OBJ_TEXT
          && a_current->text != NULL) {  /* found an attribute */
        attrib_text = g_strdup(a_current->text->string);
        attrib_name = u_basic_breakup_string(attrib_text, '=', 0);

          /* Don't include "refdes" or "slot" because they form the row name */
          /* Also don't include "net" per bug found by Steve W. -- 4.3.2007, SDB */
        if ( (strcmp(attrib_name, "refdes") != 0) &&
         (strcmp(attrib_name, "net") != 0) &&
         (strcmp(attrib_name, "slot") != 0) ) {  
#if DEBUG
          printf(" . . . from this component, about to add to master comp attrib list attrib = %s\n", attrib_name);
#endif
          s_string_list_add_item(sheet_head->master_comp_attrib_list_head, 
                     &(sheet_head->comp_attrib_count), attrib_name);
        }   /* if (strcmp(attrib_name, "refdes") != 0) */ 
        g_free(attrib_name);
        g_free(attrib_text);
      }
      a_iter = g_list_next (a_iter);
    }   /*  while  */
    
      }   /* if (o_current->type == OBJ_COMPLEX) */
      
  }
  
  /* -----  Now sort component list into alphabetical order  ----- */
  
  return;
}



/*------------------------------------------------------------------*/
void s_sheet_data_add_master_net_list_items (const GList *obj_start) {
  return;
}


/*------------------------------------------------------------------*/
void s_sheet_data_add_master_net_attrib_list_items (const GList *obj_start) {
  return;
}


/*------------------------------------------------------------------*/
void s_sheet_data_add_master_pin_list_items (const GList *obj_list) {
  char *temp_uref;
  char *temp_pinnumber;
  char *row_label;
  const GList *o_iter;
  GList *o_lower_iter;

#ifdef DEBUG
  fflush(stderr);
  fflush(stdout);
  printf("=========== Just entered  s_sheet_data_add_master_pin_list_items!  ==============\n");
#endif

  if (verbose_mode) {
    printf("- Starting master pin list creation.\n");
  }

  /* -----  Iterate through all objects found on page looking for components  ----- */
  for (o_iter = obj_list; o_iter != NULL; o_iter = g_list_next (o_iter)) {
    OBJECT *o_current = o_iter->data;

#ifdef DEBUG
    printf ("In s_sheet_data_add_master_pin_list_items, examining o_current->name = %s\n", o_current->name);
#endif

    if (o_current->type == OBJ_COMPLEX) {
      temp_uref = s_attrib_get_refdes (o_current);
      if (temp_uref != NULL) {      /* make sure object complex has a refdes  */

        /* -----  Now iterate through lower level objects looking for pins.  ----- */
        for (o_lower_iter = o_current->complex->prim_objs;
             o_lower_iter != NULL;
             o_lower_iter = g_list_next (o_lower_iter)) {
          OBJECT *o_lower_current = o_lower_iter->data;
#if DEBUG
          printf ("In s_sheet_data_add_master_pin_list_items, examining object name %s\n", o_lower_current->name);
#endif
          if (o_lower_current->type == OBJ_PIN) {
            temp_pinnumber = o_attrib_search_object_attribs_by_name (o_lower_current, "pinnumber", 0);

            if (temp_pinnumber != NULL) {
              row_label = g_strconcat (temp_uref, ":", temp_pinnumber, NULL);
#if DEBUG
              printf ("In s_sheet_data_add_master_pin_list_items, about to add to master pin list row_label = %s\n", row_label);
#endif
              s_string_list_add_item (sheet_head->master_pin_list_head, &(sheet_head->pin_count), row_label);

            } else {      /* didn't find pinnumber.  Report error to log. */
              fprintf (stderr, "In s_sheet_data_add_master_pin_list_items, found component pin with no pinnumber.\n");
#ifdef DEBUG
              fprintf (stderr, ". . . . refdes = %s.\n", temp_uref);
#endif
            }
            g_free (temp_pinnumber);

          }
        }

      } else {          /* didn't find refdes.  Report error to log. */
#ifdef DEBUG
        fprintf (stderr, "In s_sheet_data_add_master_pin_list_items, found component with no refdes.\n");
        fprintf (stderr, ". . . . complex_basename = %s.\n", o_current->complex_basename);
#endif
      }
      g_free (temp_uref);

    }  /*  if (o_current->type == OBJ_COMPLEX)  */
  }
      
  return;
}


/*------------------------------------------------------------------*/
void s_sheet_data_add_master_pin_attrib_list_items (const GList *obj_list) {
  char *temp_uref;
  char *attrib_text;
  char *attrib_name;
  char *attrib_value;
  const GList *o_iter;
  GList *o_lower_iter, *a_iter;
  OBJECT *pin_attrib;
  
#ifdef DEBUG
  fflush(stderr);
  fflush(stdout);
  printf("=========== Just entered  s_sheet_data_add_master_pin_attrib_list_items!  ==============\n");
#endif

  if (verbose_mode) {
    printf("- Starting master pin attrib list creation.\n");
  }

  /* -----  Iterate through all objects found on page looking for components  ----- */
  for (o_iter = obj_list; o_iter != NULL; o_iter = g_list_next (o_iter)) {
    OBJECT *o_current = o_iter->data;

#ifdef DEBUG
      printf("In s_sheet_data_add_master_pin_attrib_list_items, examining o_current->name = %s\n", o_current->name);
#endif

      if (o_current->type == OBJ_COMPLEX) {
    temp_uref = s_attrib_get_refdes(o_current);
    if (temp_uref != NULL) {      /* make sure object complex has a refdes  */
      
      /* -----  Now iterate through lower level objects looking for pins.  ----- */
          for (o_lower_iter = o_current->complex->prim_objs;
               o_lower_iter != NULL;
               o_lower_iter = g_list_next (o_lower_iter)) {
            OBJECT *o_lower_current = o_lower_iter->data;
#if DEBUG
        printf("In s_sheet_data_add_master_pin_attrib_list_items, examining component refdes =  %s\n", temp_uref);
#endif
        if (o_lower_current->type == OBJ_PIN) {
          /* -----  Found a pin.  Now get attrib head and loop on attribs.  ----- */
          a_iter = o_lower_current->attribs;
          while (a_iter != NULL) {
        pin_attrib = a_iter->data;
        if (pin_attrib->type == OBJ_TEXT
            && pin_attrib->text != NULL) {  /* found an attribute */
          attrib_text = g_strdup(pin_attrib->text->string);
          attrib_name = u_basic_breakup_string(attrib_text, '=', 0);
          attrib_value = s_misc_remaining_string(attrib_text, '=', 1);
          if ( (strcmp(attrib_name, "pinnumber") != 0) 
               && (attrib_value != NULL) ) {  
            /* Don't include "pinnumber" because it is already in other master list.
             * Also guard against pathalogical symbols which have non-attrib text inside pins. */

#if DEBUG
        printf("In s_sheet_data_add_master_pin_attrib_list_items, found pin attrib =  %s\n", attrib_name);
        printf(". . . . . adding it to master_pin_attrib_list\n");
#endif

            s_string_list_add_item(sheet_head->master_pin_attrib_list_head, 
                       &(sheet_head->pin_attrib_count), attrib_name);
          }   /* if (strcmp(attrib_name, "pinnumber") != 0) */ 
          g_free(attrib_value);
          g_free(attrib_name);
          g_free(attrib_text);
        }
        a_iter = g_list_next (a_iter);
          }   /*   while (pin_attrib != NULL)  */
        }
      }

      g_free(temp_uref);
    }  /*  if (temp_uref != NULL )  */
    
      }  /* if (o_current->type == OBJ_COMPLEX)  */
  }
  return;

}




/*------------------------------------------------------------------*/
void s_sheet_data_gtksheet_to_sheetdata() {
  s_table_gtksheet_to_all_tables();
  /* do I need to do anything else here? */

  return;
}