/* Copyright (C) 2001-2023 Artifex Software, Inc.
   All Rights Reserved.

   This software is provided AS-IS with no warranty, either express or
   implied.

   This software is distributed under license and may not be copied,
   modified or distributed except as expressly authorized under the terms
   of the license contained in the file LICENSE in this distribution.

   Refer to licensing information at http://www.artifex.com or contact
   Artifex Software, Inc.,  39 Mesa Street, Suite 108A, San Francisco,
   CA 94129, USA, for further information.
*/

/* Debugging machinery definitions */

#ifndef gdebug_INCLUDED
#  define gdebug_INCLUDED

#include "std.h"

/*
 * The compile-time DEBUG symbol determines whether debugging/tracing
 * code is included in the compiled code.  DEBUG may be set or not set
 * independently for every compilation; however, a small amount of support
 * machinery in gsmisc.c is always included in the executable, just
 * in case *some* file was compiled with DEBUG set.
 *
 * When DEBUG is set, it does not cause debugging/tracing printout to occur.
 * Rather, it includes code that produces such printout *if* (a) given
 * one(s) of 128 debugging flags is set.  In this way, one can selectively
 * turn printout on and off during debugging.  (In fact, we even provide a
 * PostScript operator, .setdebug, that does this.)
 *
 * The debugging flags are normally indexed by character code.  Originally
 * this was more than a convention: gs_debug_c, which tests whether a given
 * flag is set, considers that if a flag named by a given upper-case letter
 * is set, the flag named by the corresponding lower-case letter is also
 * set.
 *
 * The new code uses a 'implication' table that allows us to be more general;
 * any debug flag can now 'imply' another one. By default this is setup
 * to give the same behaviour as before, but newly added flags are not
 * constrained in the same way - we can have A -> B -> C etc or can have
 * upper case flags that don't imply lower case ones.
 *
 * If the output selected by a given flag can be printed by a single
 * printf, the conventional way to produce the output is
 *      if_debugN('x', "...format...", v1, ..., vN);
 * Usually the flag appears in the output explicitly:
 *      if_debugN('x', "[x]...format...", v1, ..., vN);
 * If the output is more complex, the conventional way to produce the
 * output is
 *      if ( gs_debug_c('x') ) {
 *        ... start each line with dlprintfN(...)
 *        ... produce additional output within a line with dprintfN(...)
 * } */


typedef enum {
#define FLAG(a,b,c,d) gs_debug_flag_ ## a = b
#define UNUSED(a)
#include "gdbflags.h"
#undef FLAG
#undef UNUSED
} gs_debug_flag;

typedef struct {
    int used;
    char short_desc[20];
    char long_desc[80];
} gs_debug_flag_details;

#define gs_debug_flags_max 127
extern const byte gs_debug_flag_implied_by[gs_debug_flags_max];
extern const gs_debug_flag_details gs_debug_flags[gs_debug_flags_max];


int gs_debug_flags_parse(gs_memory_t *heap, const char *arg);
void gs_debug_flags_list(gs_memory_t *heap);

/* Define the array of debugging flags, indexed by character code. */
extern char gs_debug[128];
bool gs_debug_c(int /*char */ );

/*
 * Define an alias for a specialized debugging flag
 * that used to be a separate variable.
 */
#define gs_log_errors gs_debug['#']

/* If debugging, direct all error output to gs_debug_out. */
extern gp_file *gs_debug_out;

/* Debugging printout macros. */
#if defined(DEBUG)
#  define if_debug0(c,s)\
    BEGIN if (gs_debug_c(c)) dlprintf(s); END
#  define if_debug1(c,s,a1)\
    BEGIN if (gs_debug_c(c)) dlprintf1(s,a1); END
#  define if_debug2(c,s,a1,a2)\
    BEGIN if (gs_debug_c(c)) dlprintf2(s,a1,a2); END
#  define if_debug3(c,s,a1,a2,a3)\
    BEGIN if (gs_debug_c(c)) dlprintf3(s,a1,a2,a3); END
#  define if_debug4(c,s,a1,a2,a3,a4)\
    BEGIN if (gs_debug_c(c)) dlprintf4(s,a1,a2,a3,a4); END
#  define if_debug5(c,s,a1,a2,a3,a4,a5)\
    BEGIN if (gs_debug_c(c)) dlprintf5(s,a1,a2,a3,a4,a5); END
#  define if_debug6(c,s,a1,a2,a3,a4,a5,a6)\
    BEGIN if (gs_debug_c(c)) dlprintf6(s,a1,a2,a3,a4,a5,a6); END
#  define if_debug7(c,s,a1,a2,a3,a4,a5,a6,a7)\
    BEGIN if (gs_debug_c(c)) dlprintf7(s,a1,a2,a3,a4,a5,a6,a7); END
#  define if_debug8(c,s,a1,a2,a3,a4,a5,a6,a7,a8)\
    BEGIN if (gs_debug_c(c)) dlprintf8(s,a1,a2,a3,a4,a5,a6,a7,a8); END
#  define if_debug9(c,s,a1,a2,a3,a4,a5,a6,a7,a8,a9)\
    BEGIN if (gs_debug_c(c)) dlprintf9(s,a1,a2,a3,a4,a5,a6,a7,a8,a9); END
#  define if_debug10(c,s,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10)\
    BEGIN if (gs_debug_c(c)) dlprintf10(s,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10); END
#  define if_debug11(c,s,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11)\
    BEGIN if (gs_debug_c(c)) dlprintf11(s,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11); END
#  define if_debug12(c,s,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12)\
    BEGIN if (gs_debug_c(c)) dlprintf12(s,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12); END

#  define dbgprintf(s)\
    BEGIN dlprintf(s); END
#  define dbgprintf1(s,a1)\
    BEGIN dlprintf1(s,a1); END
#  define dbgprintf2(s,a1,a2)\
    BEGIN dlprintf2(s,a1,a2); END
#  define dbgprintf3(s,a1,a2,a3)\
    BEGIN dlprintf3(s,a1,a2,a3); END
#  define dbgprintf4(s,a1,a2,a3,a4)\
    BEGIN dlprintf4(s,a1,a2,a3,a4); END
#  define dbgprintf5(s,a1,a2,a3,a4,a5)\
    BEGIN dlprintf5(s,a1,a2,a3,a4,a5); END
#  define dbgprintf6(s,a1,a2,a3,a4,a5,a6)\
    BEGIN dlprintf6(s,a1,a2,a3,a4,a5,a6); END
#  define dbgprintf7(s,a1,a2,a3,a4,a5,a6,a7)\
    BEGIN dlprintf7(s,a1,a2,a3,a4,a5,a6,a7); END
#  define dbgprintf8(s,a1,a2,a3,a4,a5,a6,a7,a8)\
    BEGIN dlprintf8(s,a1,a2,a3,a4,a5,a6,a7,a8); END
#  define dbgprintf9(s,a1,a2,a3,a4,a5,a6,a7,a8,a9)\
    BEGIN dlprintf9(s,a1,a2,a3,a4,a5,a6,a7,a8,a9); END
#  define dbgprintf10(s,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10)\
    BEGIN dlprintf10(s,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10); END
#  define dbgprintf11(s,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11)\
    BEGIN dlprintf11(s,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11); END
#  define dbgprintf12(s,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12)\
    BEGIN dlprintf12(s,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12); END

#else
#  define if_debug0(c,s) DO_NOTHING
#  define if_debug1(c,s,a1) DO_NOTHING
#  define if_debug2(c,s,a1,a2) DO_NOTHING
#  define if_debug3(c,s,a1,a2,a3) DO_NOTHING
#  define if_debug4(c,s,a1,a2,a3,a4) DO_NOTHING
#  define if_debug5(c,s,a1,a2,a3,a4,a5) DO_NOTHING
#  define if_debug6(c,s,a1,a2,a3,a4,a5,a6) DO_NOTHING
#  define if_debug7(c,s,a1,a2,a3,a4,a5,a6,a7) DO_NOTHING
#  define if_debug8(c,s,a1,a2,a3,a4,a5,a6,a7,a8) DO_NOTHING
#  define if_debug9(c,s,a1,a2,a3,a4,a5,a6,a7,a8,a9) DO_NOTHING
#  define if_debug10(c,s,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10) DO_NOTHING
#  define if_debug11(c,s,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11) DO_NOTHING
#  define if_debug12(c,s,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12) DO_NOTHING

#  define dbgprintf(s) DO_NOTHING
#  define dbgprintf1(s,a1) DO_NOTHING
#  define dbgprintf2(s,a1,a2) DO_NOTHING
#  define dbgprintf3(s,a1,a2,a3) DO_NOTHING
#  define dbgprintf4(s,a1,a2,a3,a4) DO_NOTHING
#  define dbgprintf5(s,a1,a2,a3,a4,a5) DO_NOTHING
#  define dbgprintf6(s,a1,a2,a3,a4,a5,a6) DO_NOTHING
#  define dbgprintf7(s,a1,a2,a3,a4,a5,a6,a7) DO_NOTHING
#  define dbgprintf8(s,a1,a2,a3,a4,a5,a6,a7,a8) DO_NOTHING
#  define dbgprintf9(s,a1,a2,a3,a4,a5,a6,a7,a8,a9) DO_NOTHING
#  define dbgprintf10(s,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10) DO_NOTHING
#  define dbgprintf11(s,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11) DO_NOTHING
#  define dbgprintf12(s,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12) DO_NOTHING
#endif

#ifdef DEBUG
#  define if_debug0m(c,m,s)\
    BEGIN if (gs_debug_c(c)) dmlprintf(m,s); END
#  define if_debug1m(c,m,s,a1)\
    BEGIN if (gs_debug_c(c)) dmlprintf1(m,s,a1); END
#  define if_debug2m(c,m,s,a1,a2)\
    BEGIN if (gs_debug_c(c)) dmlprintf2(m,s,a1,a2); END
#  define if_debug3m(c,m,s,a1,a2,a3)\
    BEGIN if (gs_debug_c(c)) dmlprintf3(m,s,a1,a2,a3); END
#  define if_debug4m(c,m,s,a1,a2,a3,a4)\
    BEGIN if (gs_debug_c(c)) dmlprintf4(m,s,a1,a2,a3,a4); END
#  define if_debug5m(c,m,s,a1,a2,a3,a4,a5)\
    BEGIN if (gs_debug_c(c)) dmlprintf5(m,s,a1,a2,a3,a4,a5); END
#  define if_debug6m(c,m,s,a1,a2,a3,a4,a5,a6)\
    BEGIN if (gs_debug_c(c)) dmlprintf6(m,s,a1,a2,a3,a4,a5,a6); END
#  define if_debug7m(c,m,s,a1,a2,a3,a4,a5,a6,a7)\
    BEGIN if (gs_debug_c(c)) dmlprintf7(m,s,a1,a2,a3,a4,a5,a6,a7); END
#  define if_debug8m(c,m,s,a1,a2,a3,a4,a5,a6,a7,a8)\
    BEGIN if (gs_debug_c(c)) dmlprintf8(m,s,a1,a2,a3,a4,a5,a6,a7,a8); END
#  define if_debug9m(c,m,s,a1,a2,a3,a4,a5,a6,a7,a8,a9)\
    BEGIN if (gs_debug_c(c)) dmlprintf9(m,s,a1,a2,a3,a4,a5,a6,a7,a8,a9); END
#  define if_debug10m(c,m,s,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10)\
    BEGIN if (gs_debug_c(c)) dmlprintf10(m,s,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10); END
#  define if_debug11m(c,m,s,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11)\
    BEGIN if (gs_debug_c(c)) dmlprintf11(m,s,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11); END
#  define if_debug12m(c,m,s,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12)\
    BEGIN if (gs_debug_c(c)) dmlprintf12(m,s,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12); END

#  define dbgmprintf(m,s)\
    BEGIN dmlprintf(m,s); END
#  define dbgmprintf1(m,s,a1)\
    BEGIN dmlprintf1(m,s,a1); END
#  define dbgmprintf2(m,s,a1,a2)\
    BEGIN dmlprintf2(m,s,a1,a2); END
#  define dbgmprintf3(m,s,a1,a2,a3)\
    BEGIN dmlprintf3(m,s,a1,a2,a3); END
#  define dbgmprintf4(m,s,a1,a2,a3,a4)\
    BEGIN dmlprintf4(m,s,a1,a2,a3,a4); END
#  define dbgmprintf5(m,s,a1,a2,a3,a4,a5)\
    BEGIN dmlprintf5(m,s,a1,a2,a3,a4,a5); END
#  define dbgmprintf6(m,s,a1,a2,a3,a4,a5,a6)\
    BEGIN dmlprintf6(m,s,a1,a2,a3,a4,a5,a6); END
#  define dbgmprintf7(m,s,a1,a2,a3,a4,a5,a6,a7)\
    BEGIN dmlprintf7(m,s,a1,a2,a3,a4,a5,a6,a7); END
#  define dbgmprintf8(m,s,a1,a2,a3,a4,a5,a6,a7,a8)\
    BEGIN dmlprintf8(m,s,a1,a2,a3,a4,a5,a6,a7,a8); END
#  define dbgmprintf9(m,s,a1,a2,a3,a4,a5,a6,a7,a8,a9)\
    BEGIN dmlprintf9(m,s,a1,a2,a3,a4,a5,a6,a7,a8,a9); END
#  define dbgmprintf10(m,s,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10)\
    BEGIN dmlprintf10(m,s,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10); END
#  define dbgmprintf11(m,s,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11)\
    BEGIN dmlprintf11(m,s,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11); END
#  define dbgmprintf12(m,s,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12)\
    BEGIN dmlprintf12(m,s,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12); END

#else
#  define if_debug0m(c,m,s) DO_NOTHING
#  define if_debug1m(c,m,s,a1) DO_NOTHING
#  define if_debug2m(c,m,s,a1,a2) DO_NOTHING
#  define if_debug3m(c,m,s,a1,a2,a3) DO_NOTHING
#  define if_debug4m(c,m,s,a1,a2,a3,a4) DO_NOTHING
#  define if_debug5m(c,m,s,a1,a2,a3,a4,a5) DO_NOTHING
#  define if_debug6m(c,m,s,a1,a2,a3,a4,a5,a6) DO_NOTHING
#  define if_debug7m(c,m,s,a1,a2,a3,a4,a5,a6,a7) DO_NOTHING
#  define if_debug8m(c,m,s,a1,a2,a3,a4,a5,a6,a7,a8) DO_NOTHING
#  define if_debug9m(c,m,s,a1,a2,a3,a4,a5,a6,a7,a8,a9) DO_NOTHING
#  define if_debug10m(c,m,s,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10) DO_NOTHING
#  define if_debug11m(c,m,s,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11) DO_NOTHING
#  define if_debug12m(c,m,s,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12) DO_NOTHING

#  define dbgmprintf(m,s) DO_NOTHING
#  define dbgmprintf1(m,s,a1) DO_NOTHING
#  define dbgmprintf2(m,s,a1,a2) DO_NOTHING
#  define dbgmprintf3(m,s,a1,a2,a3) DO_NOTHING
#  define dbgmprintf4(m,s,a1,a2,a3,a4) DO_NOTHING
#  define dbgmprintf5(m,s,a1,a2,a3,a4,a5) DO_NOTHING
#  define dbgmprintf6(m,s,a1,a2,a3,a4,a5,a6) DO_NOTHING
#  define dbgmprintf7(m,s,a1,a2,a3,a4,a5,a6,a7) DO_NOTHING
#  define dbgmprintf8(m,s,a1,a2,a3,a4,a5,a6,a7,a8) DO_NOTHING
#  define dbgmprintf9(m,s,a1,a2,a3,a4,a5,a6,a7,a8,a9) DO_NOTHING
#  define dbgmprintf10(m,s,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10) DO_NOTHING
#  define dbgmprintf11(m,s,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11) DO_NOTHING
#  define dbgmprintf12(m,s,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12) DO_NOTHING
#endif

/* Debugging support procedures in gsmisc.c */
void debug_print_string(const gs_memory_t *mem, const byte * str, uint len);
void debug_dump_bytes(const gs_memory_t *mem,
                      const byte * from, const byte * to,
                      const char *msg);
void debug_dump_bitmap(const gs_memory_t *mem,
                       const byte * from, uint raster, uint height,
                       const char *msg);
void debug_print_string_hex_nomem(const byte * str, uint len);
void debug_print_string_hex(const gs_memory_t *mem, const byte * str, uint len);

#endif /* gdebug_INCLUDED */
