wmail/src/common.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // common.h
   3 // common defines and typedefs, part of wmail
   4 //
   5 // Copyright 2000-2002, Sven Geisenhainer <sveng@informatik.uni-jena.de>.
   6 // Copyright 2016-2017, Doug Torrance <dtorrance@piedmont.edu>.
   7 // Copyright 2019, Jeremy Sowden <jeremy@azazel.net>.
   8 //
   9 // Redistribution and use in source and binary forms, with or without
  10 // modification, are permitted provided that the following conditions
  11 // are met:
  12 // 1. Redistributions of source code must retain the above copyright
  13 //    notice, this list of conditions, and the following disclaimer.
  14 // 2. Redistributions in binary form must reproduce the above copyright
  15 //    notice, this list of conditions, and the following disclaimer in the
  16 //    documentation and/or other materials provided with the distribution.
  17 // 3. The name of the author may not be used to endorse or promote products
  18 //    derived from this software without specific prior written permission.
  19 //
  20 // THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  21 // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  22 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  23 // IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  24 // INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  25 // NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  29 // THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30
  31
  32 #ifndef _COMMON_H_fdda99de15ce3f21ce7faf607a5b4985_
  33 #define _COMMON_H_fdda99de15ce3f21ce7faf607a5b4985_
  34
  35
  36 ///////////////////////////////////////////////////////////////////////////////
  37 // defines
  38
  39 // X display to open
  40 #define WMAIL_DISPLAY        ""
  41
  42 // ticker scroll frame rate per seconds
  43 #define WMAIL_FPS            60
  44
  45 // default mail check interval in seconds
  46 #define WMAIL_CHECK_INTERVAL 1
  47
  48 // default client-button command
  49 #define WMAIL_CLIENT_CMD     "xterm -e mail"
  50
  51 // filename of the checksum-file
  52 #define WMAIL_CHECKSUM_FILE  ".wmail-cksums"
  53
  54 // filename of the config-file
  55 #define WMAIL_RC_FILE        ".wmailrc"
  56
  57 #define WMAIL_READSTATUS     "O"
  58
  59 ///////////////////////////////////////////////////////////////////////////////
  60 // typedefs
  61
  62 #if !defined(__cplusplus) && !defined(c_plusplus)
  63 typedef enum {
  64     false = 0,
  65     true = 1
  66 } bool;
  67 #endif
  68
  69
  70 ///////////////////////////////////////////////////////////////////////////////
  71 // prototypes
  72
  73 void ABORT( const char *fmt, ... );
  74 void WARNING( const char *fmt, ... );
  75 char *MakePathName( const char *dir, const char *file );
  76
  77 #ifdef DEBUG
  78
  79 void TRACE( const char *fmt, ... );
  80 #define ASSERT( EXPR ) ((void)(EXPR ? 0 : ABORT( "%s(%i): Assertion failed: \"%s\"\n", __FILE__, __LINE__, #EXPR )))
  81 #define VERIFY( EXPR ) ASSERT( EXPR )
  82
  83 #else
  84
  85 #define TRACE( fmt... )
  86 #define ASSERT( EXPR )
  87 #define VERIFY( EXPR )
  88
  89 #endif
  90
  91 #endif