libgeda/src/s_cue.c

/* gEDA - GPL Electronic Design Automation
 * libgeda - gEDA's library
 * Copyright (C) 1998-2010 Ales Hvezda
 * Copyright (C) 1998-2010 gEDA Contributors (see ChangeLog for details)
 *
 * 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>
#include <ctype.h>
#ifdef HAVE_STDLIB_H
#include <stdlib.h>
#endif

#include <math.h>

#include "libgeda_priv.h"

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

/*! \todo Finish function documentation!!!
 *  \brief
 *  \par Function Description
 *
 */
void s_cue_postscript_fillbox(TOPLEVEL * toplevel, FILE * fp, int x,
			      int y)
{
  int offset;
  int offset2;

  /* hard coded values */
  offset = CUE_BOX_SIZE;
  offset2 = offset*2;

  f_print_set_color(toplevel, fp, NET_ENDPOINT_COLOR);

  fprintf(fp, "%d %d %d %d fbox\n",
	   offset2, offset2, x-offset, y-offset);
}

/*! \todo Finish function documentation!!!
 *  \brief
 *  \par Function Description
 *
 */
void s_cue_postscript_junction (TOPLEVEL * toplevel, FILE * fp,
                                int x, int y, int bus_involved)
{
  int offset2;

  if (bus_involved) {
    offset2 = JUNCTION_CUE_SIZE_BUS;
  } else {
    offset2 = JUNCTION_CUE_SIZE_NET;
  }

  f_print_set_color(toplevel, fp, JUNCTION_COLOR);

  fprintf(fp, "newpath\n");
  fprintf(fp, "%d %d\n", x, y);
  fprintf(fp, "%d\n", offset2 / 2);
  fprintf(fp, "0 360 arc\n");
  fprintf(fp, "fill\n");
}

/*! \brief Draw an arrow at the end of a net.
 */
void
s_cue_postscript_arrow (TOPLEVEL *toplevel, FILE *fp,
                        int x, int y, int dx, int dy)
{
  int offset = CUE_BOX_SIZE;

  f_print_set_color (toplevel, fp, JUNCTION_COLOR);

  fprintf (fp, "gsave\n");

  /* We compute a transformation so that the arrowhead is aligned with
   * the net segment. */
  double len = hypot (dx, dy);
  if (len != 0) {
    double c = dx / len;
    double s = dy / len;
    fprintf (fp, "[ %.2f %.2f %.2f %.2f %d %d ] concat\n", c, -s, s, c, x, y);
  } else {
    fprintf (fp, "%d %d translate\n", x, y); /* Translate to centre point of the arrow */
  }

  /* Now draw a simple arrowhead */
  fprintf (fp, "newpath\n");
  fprintf (fp, "%d %d moveto\n", -offset, -offset);
  fprintf (fp, "%d %d lineto\n", -offset, offset);
  fprintf (fp, "%d %d lineto\n", offset, 0);
  fprintf (fp, "closepath\n"
               "fill\n"
               "grestore\n");
}

/*! \todo Finish function documentation!!!
 *  \brief
 *  \par Function Description
 *
 */
void s_cue_output_all (TOPLEVEL * toplevel, const GList *obj_list, FILE * fp,
                       int type)
{
  OBJECT *o_current;
  const GList *iter;

  iter = obj_list;
  while (iter != NULL) {
    o_current = (OBJECT *)iter->data;
    switch (o_current->type) {
      case (OBJ_NET):
      case (OBJ_BUS):
      case (OBJ_PIN):
        s_cue_output_single(toplevel, o_current, fp, type);
        break;

      case (OBJ_COMPLEX):
      case (OBJ_PLACEHOLDER):
        s_cue_output_all(toplevel, o_current->complex->prim_objs, fp,
                         type);
        break;

    }
    iter = g_list_next (iter);
  }
}

/*! \todo Finish function documentation!!!
 *  \brief
 *  \par Function Description
 *
 */
void s_cue_output_lowlevel(TOPLEVEL * toplevel, OBJECT * object, int whichone,
			   FILE * fp, int output_type)
{
  int x, y;
  GList *cl_current;
  CONN *conn;
  int type, count = 0;
  int done = FALSE;
  int bus_involved = FALSE;

  x = object->line->x[whichone];
  y = object->line->y[whichone];

  type = CONN_ENDPOINT;

  if (object->type == OBJ_BUS ||
       (object->type == OBJ_PIN && object->pin_type == PIN_TYPE_BUS))
    bus_involved = TRUE;

  cl_current = object->conn_list;
  while (cl_current != NULL && !done) {
    conn = (CONN *) cl_current->data;

    if (conn->x == x && conn->y == y) {

      if (conn->other_object &&
           (conn->other_object->type == OBJ_BUS ||
             (conn->other_object->type == OBJ_PIN &&
              conn->other_object->pin_type == PIN_TYPE_BUS)))
        bus_involved=TRUE;

      switch (conn->type) {

        case (CONN_ENDPOINT):
          count++;
          break;

        case (CONN_MIDPOINT):
          type = CONN_MIDPOINT;
          done = TRUE;
          count = 0;
          break;
      }
    }

    cl_current = g_list_next(cl_current);
  }

#if DEBUG
  printf("type: %d count: %d\n", type, count);
#endif

  switch (type) {

    case (CONN_ENDPOINT):
      if (object->type == OBJ_NET || object->type == OBJ_PIN) {
        if (count < 1) {	/* Didn't find anything connected there */
          if ((object->type == OBJ_NET)
              && o_net_is_fully_connected (toplevel, object)) {
            /* Probably connected, so draw friendly arrowhead. The
             * additional parameters are needed to allow the arrowhead
             * to be pointed in the direction of the net. */
            if (output_type == POSTSCRIPT) {
              s_cue_postscript_arrow (toplevel, fp, x, y,
                                      object->line->x[whichone] - object->line->x[!whichone],
                                      object->line->y[whichone] - object->line->y[!whichone]);
            }
          } else {
            s_cue_postscript_fillbox (toplevel, fp, x, y);
          }
        } else if (count >= 2) {
          if (output_type == POSTSCRIPT)
            s_cue_postscript_junction (toplevel, fp, x, y, bus_involved);
        }
      }
      break;

    case (CONN_MIDPOINT):
      if (output_type == POSTSCRIPT)
        s_cue_postscript_junction (toplevel, fp, x, y, bus_involved);
      break;
  }

}

/*! \todo Finish function documentation!!!
 *  \brief
 *  \par Function Description
 *
 */
void s_cue_output_lowlevel_midpoints(TOPLEVEL * toplevel, OBJECT * object,
				     FILE * fp, int output_type)
{
  int x, y;
  GList *cl_current;
  CONN *conn;
  int bus_involved = FALSE;

  if (object->type == OBJ_BUS)
    bus_involved = TRUE;

  cl_current = object->conn_list;
  while (cl_current != NULL) {
    conn = (CONN *) cl_current->data;

    switch (conn->type) {
      case (CONN_MIDPOINT):

        x = conn->x;
        y = conn->y;

        if (conn->other_object && conn->other_object->type == OBJ_BUS)
          bus_involved = TRUE;

        if (output_type == POSTSCRIPT) {
          s_cue_postscript_junction (toplevel, fp, x, y, bus_involved);
        }
        break;
    }


    cl_current = g_list_next(cl_current);
  }
}

/*! \brief Output cues for a single object
 *
 *  \par Function Description
 *  Cues are drawn on pins, nets and buses.
 *  Two types of cues are drawn:
 *   - endpoint cues (identifying unconnected ends of objects)
 *   - junction cues (identifying net/pin/bus junctions)
 *
 *  \param [in] toplevel   The TOPLEVEL object
 *  \param [in] object     The OBJECT to output cues for
 *  \param [in] fp         The file handle to output to
 *  \param [in] type       The type of output being produced
 */
void s_cue_output_single(TOPLEVEL * toplevel, OBJECT * object, FILE * fp,
			 int type)
{
  g_return_if_fail (object != NULL);

  switch (object->type) {
    case (OBJ_NET):
      s_cue_output_lowlevel(toplevel, object, 0, fp, type);
      s_cue_output_lowlevel(toplevel, object, 1, fp, type);
      break;
    case (OBJ_BUS):
      s_cue_output_lowlevel(toplevel, object, 0, fp, type);
      s_cue_output_lowlevel(toplevel, object, 1, fp, type);
      break;
    case (OBJ_PIN):
      s_cue_output_lowlevel(toplevel, object, object->whichend, fp, type);
      break;
    default:
      return;
  }
  s_cue_output_lowlevel_midpoints(toplevel, object, fp, type);
}