hid.h

Go to the documentation of this file.

#ifndef PCB_HID_H
#define PCB_HID_H

#include <stdarg.h>

#if defined(__cplusplus) && __cplusplus
extern "C"
{
#endif

  typedef enum
  {
    Trace_Cap, 
    Square_Cap, 
    Round_Cap, 
    Beveled_Cap 
  } EndCapStyle;

  typedef union
  {
    long lval;
    void *ptr;
  } hidval;

  typedef struct hid_gc_struct *hidGC;

#define HIDCONCAT(a,b) a##b

  typedef struct
  {
    char *name;
    const char *need_coord_msg;
    int (*trigger_cb) (int argc, char **argv, Coord x, Coord y);
    const char *description;
    const char *syntax;
  } HID_Action;

  extern void hid_register_action (HID_Action *);

  extern void hid_register_actions (HID_Action *, int);
#define REGISTER_ACTIONS(a) HIDCONCAT(void register_,a) ()\
{ hid_register_actions(a, sizeof(a)/sizeof(a[0])); }

  /* Note that PCB expects the gui to provide the following actions:

     PCBChanged();
     RouteStylesChanged()
     NetlistChanged()  (but core should call "void NetlistChanged(int);" in netlist.c)
     LayersChanged()
     LibraryChanged()
     Busy()
   */

  extern const char pcbchanged_help[];
  extern const char pcbchanged_syntax[];
  extern const char routestyleschanged_help[];
  extern const char routestyleschanged_syntax[];
  extern const char netlistchanged_help[];
  extern const char netlistchanged_syntax[];
  extern const char layerschanged_help[];
  extern const char layerschanged_syntax[];
  extern const char librarychanged_help[];
  extern const char librarychanged_syntax[];

  int hid_action (const char *action_);
  int hid_actionl (const char *action_, ...);   /* NULL terminated */
  int hid_actionv (const char *action_, int argc_, char **argv_);
  void hid_save_settings (int);
  void hid_load_settings (void);

  int hid_parse_command (const char *str_);

  int hid_parse_actions (const char *str_);

  typedef struct
  {
    char *name; 
    int (*function) (void *);
    void *parm;
  } HID_Flag;

  extern void hid_register_flags (HID_Flag *, int);
#define REGISTER_FLAGS(a) HIDCONCAT(void register_,a) ()\
{ hid_register_flags(a, sizeof(a)/sizeof(a[0])); }

  int hid_get_flag (const char *name_);

  typedef struct
  {
    int int_value;
    const char *str_value;
    double real_value;
    Coord coord_value;
  } HID_Attr_Val;

  enum hids
    { HID_Label, HID_Integer, HID_Real, HID_String,
      HID_Boolean, HID_Enum, HID_Mixed, HID_Path,
      HID_Unit, HID_Coord
    };

  typedef struct
  {
    char *name;
#define ATTR_UNDOCUMENTED ((char *)(1))
    char *help_text;
    enum hids type;
    int min_val; 
    int max_val; 
    HID_Attr_Val default_val; 
    const char **enumerations;
    void *value;
    int hash; 
  } HID_Attribute;

  extern void hid_register_attributes (HID_Attribute *, int);

#define REGISTER_ATTRIBUTES(a) HIDCONCAT(void register_,a) ()\
{ hid_register_attributes(a, sizeof(a)/sizeof(a[0])); }

/* These three are set by hid_parse_command_line().  */
  extern char *program_name;
  extern char *program_directory;
  extern char *program_basename;

/* These are used for set_layer(). */
#define SL_0_SIDE       0x0000
#define SL_TOP_SIDE     0x0001
#define SL_BOTTOM_SIDE  0x0002
#define SL_INNER_SIDE   0x0004

/*
 * These are types of "layers" without direct physical representation.
 * Their content can be derived from other layers and element data.
 *
 * These values are used by DrawEverything() in draw.c to ask the active
 * GUI or exporter to act on these layers. Depending on the GUI/exporter
 * they result in a per-layer file, in some additional graphics or just
 * nothing.
 */
#define SL_SILK         0x0010 
#define SL_MASK         0x0020
#define SL_PDRILL       0x0030
#define SL_UDRILL       0x0040
#define SL_PASTE        0x0050
#define SL_INVISIBLE    0x0060
#define SL_FAB          0x0070
#define SL_ASSY         0x0080
#define SL_RATS         0x0090

/* Callers should use this.  */
#define SL(type,side) (~0xfff | SL_##type | SL_##side##_SIDE)

typedef enum
{
  LT_COPPER = 0,
  LT_SILK,
  LT_MASK,           
  LT_PASTE,          
  LT_OUTLINE,        
  LT_ROUTE,
  LT_KEEPOUT,
  LT_FAB,            
  LT_ASSY,           
  LT_NOTES,
  LT_NUM_LAYERTYPES  
} LayertypeType;

typedef enum
{
  PCB_WATCH_READABLE = 1 << 0, 
  PCB_WATCH_WRITABLE = 1 << 1, 
  PCB_WATCH_ERROR    = 1 << 2, 
  PCB_WATCH_HANGUP   = 1 << 3  
} PCBWatchFlags;

  typedef struct
  {
    int log_drc_overview;
    int log_drc_violations;
    void (*reset_drc_dialog_message) (void);
    void (*append_drc_violation) (DrcViolationType *violation);
    int (*throw_drc_dialog) (void);
  } HID_DRC_GUI;

  typedef struct hid_st HID;
  typedef struct hid_draw_st HID_DRAW;

  struct hid_st
  {
    int struct_size;
    const char *name;
    const char *description;
    char gui:1;
    char printer:1;
    char exporter:1;
    char poly_before:1;
    char poly_after:1;
    HID_Attribute *(*get_export_options) (int *n_ret_);
    void (*do_export) (HID_Attr_Val * options_);
    void (*uninit) (HID *hid);
    void (*do_exit) (HID *hid);
    void (*parse_arguments) (int *argc_, char ***argv_);
    void (*invalidate_lr) (Coord left_, Coord right_,
                           Coord top_, Coord bottom_);
    void (*invalidate_all) (void);

    void (*notify_crosshair_change) (bool changes_complete);

    void (*notify_mark_change) (bool changes_complete);

    int (*set_layer) (const char *name_, int group_, int _empty);
    void (*end_layer) (void);
    HID_DRAW *graphics;

    void (*calibrate) (double xval_, double yval_);
    /* GUI layout functions.  Not used or defined for print/export
       HIDs.  */

    /* Temporary */
    int (*shift_is_pressed) (void);

    int (*control_is_pressed) (void);
    int (*mod1_is_pressed) (void);

    void (*get_coords) (const char *msg_, Coord *x_, Coord *y_);

    void (*set_crosshair) (int x_, int y_, int cursor_action_);
#define HID_SC_DO_NOTHING                          0

#define HID_SC_WARP_POINTER                            1

#define HID_SC_PAN_VIEWPORT                        2

#define HID_SC_CENTER_IN_VIEWPORT                  3

#define HID_SC_CENTER_IN_VIEWPORT_AND_WARP_POINTER 4

      hidval (*add_timer) (void (*func) (hidval user_data_),
                           unsigned long milliseconds_, hidval user_data_);
    void (*stop_timer) (hidval timer_);
    hidval (*watch_file) (int fd_, unsigned int condition_, void (*func_) (hidval watch_, int fd_, unsigned int condition_, hidval user_data_),
            hidval user_data);
    void (*unwatch_file) (hidval watch_);
    hidval (*add_block_hook) (void (*func_) (hidval data_), hidval data_);
    void (*stop_block_hook) (hidval block_hook_);
    /* Various dialogs */

    void (*log) (const char *fmt_, ...);
    void (*logv) (const char *fmt_, va_list args_);
    int (*confirm_dialog) (char *msg_, ...);
    int (*close_confirm_dialog) ();
#define HID_CLOSE_CONFIRM_CANCEL 0

#define HID_CLOSE_CONFIRM_OK     1

    void (*report_dialog) (char *title_, char *msg_);
    char *(*prompt_for) (const char *msg_, const char *default_string_);
#define HID_FILESELECT_READ  0x01

#define HID_FILESELECT_MAY_NOT_EXIST 0x02

#define HID_FILESELECT_IS_TEMPLATE 0x04

    char *(*fileselect) (const char *title_, const char *descr_,
                         char *default_file_, char *default_ext_,
                         const char *history_tag_, int flags_);
    int (*attribute_dialog) (HID_Attribute * attrs_,
                             int n_attrs_, HID_Attr_Val * results_,
                             const char * title_, const char * descr_);
    void (*show_item) (void *item_);
    void (*beep) (void);
    int (*progress) (int so_far_, int total_, const char *message_);
    HID_DRC_GUI *drc_gui;

    void (*edit_attributes) (char *owner, AttributeListType *attrlist_);

    /* Debug drawing support. These APIs must be implemented (non NULL),
     * but they do not have to be functional. request_debug_draw can
     * return NULL to indicate debug drawing is not permitted.
     *
     * Debug drawing is not guaranteed to be re-entrant.
     * The caller must not nest requests for debug drawing.
     */

    HID_DRAW *(*request_debug_draw) (void);
    void (*flush_debug_draw)   (void);
    void (*finish_debug_draw)  (void);
    void (*notify_save_pcb) (const char *filename, bool done);
    void (*notify_filename_changed) (void);
  };

  void hid_init (void);

  void hid_uninit (void);

  HID *hid_find_gui ();

  HID *hid_find_printer (void);

  HID *hid_find_exporter (const char *);

  HID **hid_enumerate (void);

  void hid_expose_callback (HID * hid_, struct BoxType *region_, void *item_);

  extern HID *gui;
  extern HID *exporter;
  extern HID_Action *current_action;
  extern int pixel_slop;
#if defined(__cplusplus) && __cplusplus
}
#endif

#endif