src/gerb_image.h

   1 /*
   2  * gEDA - GNU Electronic Design Automation
   3  * This files is a part of gerbv.
   4  *
   5  *   Copyright (C) 2000-2001 Stefan Petersen (spe@stacken.kth.se)
   6  *
   7  * $Id$
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111 USA
  22  */
  23
  24 /** \file gerb_image.h
  25     \brief Header info for the image editing and support functions
  26     \ingroup libgerbv
  27 */
  28
  29 #ifndef GERB_IMAGE_H
  30 #define GERB_IMAGE_H
  31
  32 #include "gerb_stats.h"
  33 #include "drill_stats.h"
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif
  38
  39 /*
  40  * Function prototypes
  41  */
  42
  43 /*
  44  * Check that the parsed gerber image is complete.
  45  * Returned errorcodes are:
  46  * 0: No problems
  47  * 1: Missing netlist
  48  * 2: Missing format
  49  * 4: Missing apertures
  50  * 8: Missing info
  51  * It could be any of above or'ed together
  52  */
  53 typedef enum {
  54     GERB_IMAGE_OK = 0,
  55     GERB_IMAGE_MISSING_NETLIST = 1,
  56     GERB_IMAGE_MISSING_FORMAT = 2,
  57     GERB_IMAGE_MISSING_APERTURES = 4,
  58     GERB_IMAGE_MISSING_INFO = 8,
  59 } gerb_verify_error_t;
  60
  61 gerb_verify_error_t gerbv_image_verify(gerbv_image_t const* image);
  62
  63 /* Dumps a written version of image to stdout */
  64 void gerbv_image_dump(gerbv_image_t const* image);
  65
  66 gerbv_layer_t *
  67 gerbv_image_return_new_layer (gerbv_layer_t *previousLayer);
  68
  69 gerbv_netstate_t *
  70 gerbv_image_return_new_netstate (gerbv_netstate_t *previousState);
  71
  72
  73 #ifdef __cplusplus
  74 }
  75 #endif
  76
  77 #endif /* GERB_IMAGE_H */