/*******************************************************/
   /*      "C" Language Integrated Production System      */
   /*                                                     */
   /*             CLIPS Version 6.40  01/29/18            */
   /*                                                     */
   /*              PRINT UTILITY HEADER FILE              */
   /*******************************************************/

/*************************************************************/
/* Purpose: Utility routines for printing various items      */
/*   and messages.                                           */
/*                                                           */
/* Principal Programmer(s):                                  */
/*      Gary D. Riley                                        */
/*                                                           */
/* Contributing Programmer(s):                               */
/*                                                           */
/* Revision History:                                         */
/*                                                           */
/*      6.24: Link error occurs for the SlotExistError       */
/*            function when OBJECT_SYSTEM is set to 0 in     */
/*            setup.h. DR0865                                */
/*                                                           */
/*            Added DataObjectToString function.             */
/*                                                           */
/*            Added SlotExistError function.                 */
/*                                                           */
/*      6.30: Support for long long integers.                */
/*                                                           */
/*            Support for DATA_OBJECT_ARRAY primitive.       */
/*                                                           */
/*            Support for typed EXTERNAL_ADDRESS_TYPE.       */
/*                                                           */
/*            Used gensprintf and genstrcat instead of       */
/*            sprintf and strcat.                            */
/*                                                           */
/*            Changed integer type/precision.                */
/*                                                           */
/*            Added code for capturing errors/warnings.      */
/*                                                           */
/*            Added const qualifiers to remove C++           */
/*            deprecation warnings.                          */
/*                                                           */
/*            Fixed linkage issue when BLOAD_ONLY compiler   */
/*            flag is set to 1.                              */
/*                                                           */
/*      6.31: Added additional error messages for retracted  */
/*            facts, deleted instances, and invalid slots.   */
/*                                                           */
/*            Added under/overflow error message.            */
/*                                                           */
/*      6.40: Removed LOCALE definition.                     */
/*                                                           */
/*            Pragma once and other inclusion changes.       */
/*                                                           */
/*            Added support for booleans with <stdbool.h>.   */
/*                                                           */
/*            Removed use of void pointers for specific      */
/*            data structures.                               */
/*                                                           */
/*            UDF redesign.                                  */
/*                                                           */
/*            Removed DATA_OBJECT_ARRAY primitive type.      */
/*                                                           */
/*************************************************************/

#ifndef _H_prntutil

#pragma once

#define _H_prntutil

#include <stdio.h>

#include "entities.h"

#define PRINT_UTILITY_DATA 53

struct printUtilityData
  {
   bool PreserveEscapedCharacters;
   bool AddressesToStrings;
   bool InstanceAddressesToNames;
  };

#define PrintUtilityData(theEnv) ((struct printUtilityData *) GetEnvironmentData(theEnv,PRINT_UTILITY_DATA))

   void                           InitializePrintUtilityData(Environment *);
   void                           WriteFloat(Environment *,const char *,double);
   void                           WriteInteger(Environment *,const char *,long long);
   void                           PrintUnsignedInteger(Environment *,const char *,unsigned long long);
   void                           PrintAtom(Environment *,const char *,unsigned short,void *);
   void                           PrintTally(Environment *,const char *,unsigned long long,const char *,const char *);
   const char                    *FloatToString(Environment *,double);
   const char                    *LongIntegerToString(Environment *,long long);
   const char                    *DataObjectToString(Environment *,UDFValue *);
   void                           SyntaxErrorMessage(Environment *,const char *);
   void                           SystemError(Environment *,const char *,int);
   void                           PrintErrorID(Environment *,const char *,int,bool);
   void                           PrintWarningID(Environment *,const char *,int,bool);
   void                           CantFindItemErrorMessage(Environment *,const char *,const char *,bool);
   void                           CantDeleteItemErrorMessage(Environment *,const char *,const char *);
   void                           AlreadyParsedErrorMessage(Environment *,const char *,const char *);
   void                           LocalVariableErrorMessage(Environment *,const char *);
   void                           DivideByZeroErrorMessage(Environment *,const char *);
   void                           SalienceInformationError(Environment *,const char *,const char *);
   void                           SalienceRangeError(Environment *,int,int);
   void                           SalienceNonIntegerError(Environment *);
   void                           CantFindItemInFunctionErrorMessage(Environment *,const char *,const char *,const char *,bool);
   void                           SlotExistError(Environment *,const char *,const char *);
   void                           FactRetractedErrorMessage(Environment *,Fact *);
   void                           FactVarSlotErrorMessage1(Environment *,Fact *,const char *);
   void                           FactVarSlotErrorMessage2(Environment *,Fact *,const char *);
   void                           InvalidVarSlotErrorMessage(Environment *,const char *);
   void                           InstanceVarSlotErrorMessage1(Environment *,Instance *,const char *);
   void                           InstanceVarSlotErrorMessage2(Environment *,Instance *,const char *);
   void                           ArgumentOverUnderflowErrorMessage(Environment *,const char *,bool);

#endif /* _H_prntutil */