/*
 * $Id: util.h,v 1.28 2007/05/10 22:49:37 sfeam Exp $
 */

/* GNUPLOT - util.h */

/*[
 * Copyright 1986 - 1993, 1998, 2004   Thomas Williams, Colin Kelley
 *
 * Permission to use, copy, and distribute this software and its
 * documentation for any purpose with or without fee is hereby granted,
 * provided that the above copyright notice appear in all copies and
 * that both that copyright notice and this permission notice appear
 * in supporting documentation.
 *
 * Permission to modify the software is granted, but not the right to
 * distribute the complete modified source code.  Modifications are to
 * be distributed as patches to the released version.  Permission to
 * distribute binaries produced by compiling modified sources is granted,
 * provided you
 *   1. distribute the corresponding source modifications from the
 *    released version in the form of a patch file along with the binaries,
 *   2. add special version identification to distinguish your version
 *    in addition to the base release version number,
 *   3. provide your name and address as the primary contact for the
 *    support of your modified version, and
 *   4. retain our contact information in regard to use of the base
 *    software.
 * Permission to distribute the released version of the source code along
 * with corresponding source modifications in the form of a patch file is
 * granted with same provisions 2 through 4 for binary distributions.
 *
 * This software is provided "as is" without express or implied warranty
 * to the extent permitted by applicable law.
]*/

#ifndef GNUPLOT_UTIL_H
# define GNUPLOT_UTIL_H

#include "gp_types.h"
#include "stdfn.h"		/* for size_t */

/* special token number meaning 'do not draw the "caret"', for
 * int_error and friends: */
#define NO_CARET (-1)

/* token number meaning 'the error was in the datafile, not the
   command line' */
#define DATAFILE (-2)

/* TRUE if command just typed; becomes FALSE whenever we
 * send some other output to screen.  If FALSE, the command line
 * will be echoed to the screen before the ^ error message.
 */
extern TBOOLEAN screen_ok;

/* decimal sign */
extern char *decimalsign;
extern char *numeric_locale;

extern const char *current_prompt; /* needed by is_error() and friends */

/* Functions exported by util.c: */

/* Command parsing helpers: */
#if 0 /* UNUSED */
int chr_in_str (int, int);
#endif
int equals (int, const char *);
int almost_equals (int, const char *);
int isstring (int);
int isanumber (int);
int isletter (int);
int is_definition (int);
void copy_str (char *, int, int);
size_t token_len (int);
void quote_str (char *, int, int);
void capture (char *, int, int, int);
void m_capture (char **, int, int);
void m_quote_capture (char **, int, int);
char *try_to_get_string (void);
void parse_esc (char *);
int type_udv (int);

#ifdef GP_STRING_VARS
char *gp_stradd (const char *, const char *);
#define isstringvalue(c_token) (isstring(c_token) || type_udv(c_token)==STRING)
#else
#define isstringvalue(c_token) isstring(c_token)
#endif

/* HBB 20010726: IMHO this one belongs into alloc.c: */
char *gp_strdup (const char *);

/* HBB 20020405: moved this here, from axis.[ch] */
void gprintf (char *, size_t, char *, double, double);

/* Error message handling */
void os_error (int, const char *, ...);
void int_error (int, const char *, ...);
void int_warn (int, const char *, ...);
void graph_error (const char *, ...);


/* Helper functions for help_command() */
/* FIXME HBB 20010726: should be moved to where help_comamnd() is, and
 * made static. Currently, that's command.c, but it should probably
 * move to help.c, instead. */
void lower_case (char *);
void squash_spaces (char *);

TBOOLEAN existdir (const char *);

char *getusername (void);

#endif /* GNUPLOT_UTIL_H */
