defines.h

Go to the documentation of this file.

/* gEDA - GPL Electronic Design Automation
 * libgeda - gEDA's Library
 * Copyright (C) 1998-2010 Ales Hvezda
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library 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
 * Library 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 02111-1301 USA.
 */

#ifndef _DEFINES_H_INCL
#define _DEFINES_H_INCL

/* Current schematic/symbol file format */
#define FILEFORMAT_VERSION     2

/* release version which had file format changes */
/* New file format changes after 20030921 use the above version */
/* and not these #defines anymore. */
#define VERSION_20000220 20000220
#define VERSION_20000704 20000704
#define VERSION_20020825 20020825
#define VERSION_20030921 20030921
/* 20030921 wasn't a real version, just a MinGW test version, but it is */
/* out there */

/* Set this string to something interesting to create a custom */
/* version of gEDA/gaf.  This string is prepended to all messages that */
/* output the program's version output.  You would set this if you are */
/* creating a specific custom version of gEDA/gaf.  */
/* For example, if you set this string to "FIX-", the resulting output is:  */
/* FIX-1.0.0.20060906. */
#define PREPEND_VERSION_STRING ""

/* for color mechanism used in gschem */
#define MAX_COLORS 25

/* X's obsession with *64 */
#define FULL_CIRCLE 360*64

/* for show_name_value in st_objects */
#define SHOW_NAME_VALUE         0
#define SHOW_VALUE              1
#define SHOW_NAME               2
#define LEAVE_NAME_VALUE_ALONE  -1

/* for visibility in st_objects */
#define INVISIBLE               0
#define VISIBLE                 1
#define LEAVE_VISIBILITY_ALONE  -1

/* For pin and net styles */
#define THIN            0     
#define THICK           1

/* various thicknesses (in mils) */
#define LINE_WIDTH  10
#define NET_WIDTH   10
#define PIN_WIDTH_NET   10
#define BUS_WIDTH   30
#define PIN_WIDTH_BUS   30

/* various visual cue sizes (in mils) */
#define CUE_BOX_SIZE        30
#define JUNCTION_CUE_SIZE_NET   50
#define JUNCTION_CUE_SIZE_BUS   30
#define PIN_CUE_SIZE_NET    30
#define PIN_CUE_SIZE_BUS    50

/* For text location on component not found graphics */
#define NOT_FOUND_TEXT_X    100
#define NOT_FOUND_TEXT_Y    100

#undef max
#define max(a,b) ((a) > (b) ? (a) : (b))

#undef min
#define min(a,b) ((a) < (b) ? (a) : (b)) 

/* for s_clib_getfilename() */
#define OPEN_DIR    0
#define READ_DIR    1
#define CLOSE_DIR   2
#define SET_COUNT   3

/* for s_slib_search() */
#define SLIB_SEARCH_START   0
#define SLIB_SEARCH_NEXT    1
#define SLIB_SEARCH_DONE    2

/* for text alignment */
/*   2 -- 5 -- 8  */
/*   |    |    |  */
/*   1 -- 4 -- 7  */
/*   |    |    |  */
/*   0 -- 3 -- 6  */
#define LOWER_LEFT  0
#define MIDDLE_LEFT 1
#define UPPER_LEFT  2
#define LOWER_MIDDLE    3
#define MIDDLE_MIDDLE   4
#define UPPER_MIDDLE    5
#define LOWER_RIGHT 6
#define MIDDLE_RIGHT    7
#define UPPER_RIGHT 8

/* one character string used to calculate tab's width */
/* Warning: it MUST be a string. */
#define TAB_CHAR_MODEL "b"

/* The conn modes for type */
#define CONN_NULL               0
#define CONN_ENDPOINT       1
#define CONN_MIDPOINT       2

/* used by world_tiles to set the size of the array */
#define MAX_TILES_X     10
#define MAX_TILES_Y     10

/* used for undo_savestate flag */
#define UNDO_ALL        0
#define UNDO_VIEWPORT_ONLY  1

/* These are for where status information goes */
#define LOG_WINDOW      0
#define STDOUT_TTY      1
#define BOTH_LOGWIN_STDOUT  2

/* list copying flags */
#define NORMAL_FLAG     0
#define SELECTION_FLAG      1

/* hierarchy loading flags */
#define HIERARCHY_NORMAL_LOAD   0
#define HIERARCHY_FORCE_LOAD    1

/* hierarchy traversing flags */
#define HIERARCHY_NODUPS (1<<0)
#define HIERARCHY_POSTORDER (1<<1)
#define HIERARCHY_INNERLOOP (1<<7)

#define MILS_PER_INCH       1000 

/* for text_output */
#define VECTOR_FONTS        0
#define PS_FONTS        1

/* for print dialog box */
#define EXTENTS         0
#define WINDOW          1
#define EXTENTS_NOMARGINS   2

/* for output-capstyle */ 
#define BUTT_CAP        0
#define ROUND_CAP       1
#define SQUARE_CAP      2

/* for print dialog box */
#define LANDSCAPE       0
#define PORTRAIT        1

/* for type to s_cue_output_all */
#define POSTSCRIPT      0
#define PNG         1

/* for o_net_orientation */
#define NEITHER         0
#define HORIZONTAL      1
#define VERTICAL        2
#define HORIZONTAL_ABOVE    3
#define HORIZONTAL_BELOW    4
#define VERTICAL_LEFT       5
#define VERTICAL_RIGHT      6

/* for pin_type */
#define PIN_TYPE_NET        0
#define PIN_TYPE_BUS        1

/* gnetlist: hierarchy_*_order */
#define APPEND          0
#define PREPEND         1

/* gnetlist: netlist_mode */
#define gEDA            0
#define SPICE           1
#define TANGO           2

/* gnetlist: net-naming-priority */
#define NETATTRIB_ATTRIBUTE 0
#define NETNAME_ATTRIBUTE   1

/* gschcheck: Error types */
#define NO_ERR                  0
#define FLOAT_NET               1
#define FLOAT_PIN               2
#define DUP_NET_NAME            4

/* Max level of symlinks */
#define MAX_LINK_LEVEL 256

#if defined(__MINGW32__) && !defined(M_PI)
#define M_PI  3.14159265358979323846
#endif

/* Logs a normal message. */
#define s_log_message g_message

/* Backup filename creation string */
#define AUTOSAVE_BACKUP_FILENAME_STRING "#%s#"

/* These permission bits are absent on MinGW */
#ifndef S_IWGRP
# define S_IWGRP 0
#endif
#ifndef S_IWOTH
# define S_IWOTH 0
#endif
#ifndef S_IXGRP
# define S_IXGRP 0
#endif
#ifndef S_IXOTH
# define S_IXOTH 0
#endif
#ifndef S_IRWXG
# define S_IRWXG 0
#endif


/* Used by the rc loading mechanism */
#define RETURN_G_RC_MODE(rc, var, size) \
  return g_rc_mode_general(mode,        \
                           (rc),        \
                           &(var),      \
                           mode_table,  \
                           size)


#endif /* !_DEFINES_H_INCL */