boxes/src/boxes.h.in

/*
 *  File:             boxes.h
 *  Date created:     March 18, 1999 (Thursday, 15:09h)
 *  Author:           Copyright (C) 1999 Thomas Jensen <boxes@thomasjensen.com>
 *  Version:          $Id: boxes.h.in,v 1.21 2006/07/12 05:44:12 tsjensen Exp tsjensen $
 *  Language:         ANSI C
 *  World Wide Web:   http://boxes.thomasjensen.com/
 *  Purpose:          Project-wide globals and data structures
 *
 *  Remarks: o 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.
 *           o 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.
 *           o 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., 59 Temple Place, Suite 330, Boston,
 *             MA 02111-1307  USA
 *
 *  Revision History:
 *
 *    $Log: boxes.h.in,v $
 *    Revision 1.21  2006/07/12 05:44:12  tsjensen
 *    Updated email and web addresses in comment header
 *    Added new member 'mend' to opt_t (for option -m, mend box)
 *
 *    Revision 1.20  2000-04-01 10:28:18-08  tsjensen
 *    Added cld member to command line option struct (-c option)
 *
 *    Revision 1.19  2000/03/17 23:43:13  tsjensen
 *    Added vim autocommand to set syntax highlighting to C
 *
 *    Revision 1.18  1999/08/21 23:37:23  tsjensen
 *    Renamed file from boxes.h to boxes.h.in
 *    VERSION and GLOBALCONF values are now put in by top level Makefile
 *
 *    Revision 1.17  1999/08/14 19:31:23  tsjensen
 *    Incremented beta version number to 5
 *    Added maxshapeheight member to design_t struct
 *
 *    Revision 1.16  1999/07/20 18:48:46  tsjensen
 *    Added GNU GPL disclaimer
 *    Updated beta version number :-)
 *    Added killblank member to global options
 *
 *    Revision 1.15  1999/06/30 12:19:12  tsjensen
 *    Removed DEF_DESIGN macro, because it now defaults to first design
 *    Removed some porting code, hoping for autoconf future
 *    Added PARSER_DEBUG and LEXER_DEBUG macros
 *
 *    Revision 1.14  1999/06/25 18:51:04  tsjensen
 *    Removed empty_side() prototype (now in shape.h)
 *    Added indentmode and justify members to command line options struct
 *
 *    Revision 1.13  1999/06/23 19:21:15  tsjensen
 *    Now exporting anz_designs, input, and empty_side()
 *    Added #include regexp.h back
 *
 *    Revision 1.12  1999/06/23 12:33:49  tsjensen
 *    Moved some data structures and macros related to shapes to shape.h
 *    Added #ifdef DEBUG around __TJ() macro for convenience
 *
 *    Revision 1.11  1999/06/22 12:01:24  tsjensen
 *    Added DEF_DESIGN (default design name)
 *    Added opt_t and opt global variable from boxes.c
 *    Moved BFREE macro and yyerror() and empty_line() prototypes to tools.h
 *    Added LINE_MAX and MAX_TABSTOP macros from boxes.c
 *    Added #define DEBUG and REGEXP_DEBUG. This will centrally activate
 *    debugging.
 *
 *    Revision 1.10  1999/06/20 14:19:31  tsjensen
 *    Added padding member to design struct
 *
 *    Revision 1.9  1999/06/17 19:08:50  tsjensen
 *    Removed #pragma ident "string"
 *    Changed VERSION to 1.0 beta
 *    Added line_t and empty_line() prototype
 *
 *    Revision 1.8  1999/06/14 12:11:54  tsjensen
 *    Added struct members for regexp reversion code
 *    Renamed current_reprule to current_rule, now used for both directions
 *
 *    Revision 1.6  1999/04/09 13:32:55  tsjensen
 *    Removed code related to OFFSET blocks (obsolete)
 *
 *    Revision 1.5  1999/04/04 16:10:51  tsjensen
 *    Added some flags to design structure
 *    Move default settings here from boxes.c
 *
 *    Revision 1.4  1999/03/31 17:34:43  tsjensen
 *    ... still programming ...
 *    Added minwidth and minheight to design structure
 *
 *    Revision 1.3  1999/03/30 09:36:58  tsjensen
 *    ... still programming ...
 *    It drew a correct box for the first time!
 *
 *    Revision 1.1  1999/03/18 15:09:34  tsjensen
 *    Initial revision
 *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 */

#ifndef BOXES_H
#define BOXES_H

/* #define DEBUG */
/* #define REGEXP_DEBUG */
/* #define PARSER_DEBUG */
/* #define LEXER_DEBUG */

#include "regexp.h"



#define PROJECT "boxes"                  /* name of program */
#define VERSION "--BVERSION--"           /* current release of project */
#define GLOBALCONF "--GLOBALCONF--"      /* name of system-wide config file */


/*
 *  default settings of all kinds (THIS PARAGRAPH MAY BE EDITED)
 */
#define DEF_TABSTOP     8                /* default tab stop distance (part of -t) */
#define DEF_INDENTMODE  'b'              /* indent box, not text by default */

/*
 *  max. allowed tab stop distance
 */
#define MAX_TABSTOP     16

/*
 *  max. supported line length
 *  This is how many characters of a line will be read. Anything beyond
 *  will be discarded. The line feed character at the end does not count.
 *  (This should have been done via sysconf(), but I didn't do it in order
 *  to ease porting to non-unix platforms.)
 */
#if defined(LINE_MAX) && (LINE_MAX < 1024)
#undef LINE_MAX
#endif
#ifndef LINE_MAX
#define LINE_MAX        2048
#endif


#ifdef DEBUG
    #define __TJ(s) fprintf (stderr, s);
#else
    #define __TJ(s) /**/
#endif


#define BTOP 0                           /* for use with sides */
#define BRIG 1
#define BBOT 2
#define BLEF 3


typedef struct {
    char   *search;
    char   *repstr;
    regexp *prog;                        /* compiled search pattern */
    int     line;                        /* line of definition in config file */
    char    mode;                        /* 'g' or 'o' */
} reprule_t;


typedef struct {
    char      *name;
    char      *author;
    char      *created;                  /* date created, free format */
    char      *revision;                 /* revision number of design */
    char      *revdate;                  /* date of current revision */
    char      *sample;
    char       indentmode;               /* 'b', 't', or 'n' */
    sentry_t   shape[ANZ_SHAPES];
    size_t     maxshapeheight;           /* height of highest shape in design */
    size_t     minwidth;
    size_t     minheight;
    int        padding[ANZ_SIDES];

    reprule_t *current_rule;
    reprule_t *reprules;                 /* applied when drawing a box */
    size_t     anz_reprules;
    reprule_t *revrules;                 /* applied upon removal of a box */
    size_t     anz_revrules;
} design_t;

extern design_t *designs;
extern int anz_designs;
extern int design_idx;


extern int tjlineno;                     /* config file line counter */
extern char *yyfilename;                 /* name of config file */


typedef struct {                         /* Command line options: */
    int       l;                         /* list available designs */
    int       mend;                      /* 1 if -m is given, 2 in 2nd loop */
    int       r;                         /* remove box from input */
    int       tabstop;                   /* tab stop distance */
    char      tabexp;                    /* tab expansion mode (for leading tabs) */
    int       padding[ANZ_SIDES];        /* in spaces or lines resp. */
    design_t *design;                    /* currently used box design */
    int       design_choice_by_user;     /* true if design was chosen by user */
    char     *cld;                       /* commandline design definition, -c */
    long      reqwidth;                  /* requested box width (-s) */
    long      reqheight;                 /* requested box height (-s) */
    char      valign;                    /* text position inside box */
    char      halign;                    /* ( h[lcr]v[tcb] )         */
    char      indentmode;                /* 'b', 't', 'n', or '\0' */
    char      justify;                   /* 'l', 'c', 'r', or '\0' */
    int       killblank;                 /* -1 if not set */
    FILE     *infile;                    /* where we get our input */
    FILE     *outfile;                   /* where we put our output */
} opt_t;

extern opt_t opt;


typedef struct {
    size_t  len;                         /* length of text in characters */
    char   *text;                        /* line content, tabs expanded */
    size_t *tabpos;                      /* tab positions in expanded work strings */
    size_t  tabpos_len;                  /* number of tabs in a line */
} line_t;

#ifndef FILE_LEXER_L
typedef struct {
    line_t *lines;
    size_t anz_lines;                    /* number of entries in input */
    size_t maxline;                      /* length of longest input line */
    size_t indent;                       /* number of leading spaces found */
} input_t;

#define INPUT_INITIALIZER {NULL, 0, 0, LINE_MAX}

extern input_t input;
#endif /*!FILE_LEXER_L*/


#endif /* BOXES_H */

/*EOF*/                                  /* vim: set cindent sw=4 syntax=c: */