firebird-mirror/src/qli/err.cpp

/*
 *	PROGRAM:	JRD Command Oriented Query Language
 *	MODULE:		err.c
 *	DESCRIPTION:	Error handlers
 *
 * The contents of this file are subject to the Interbase Public
 * License Version 1.0 (the "License"); you may not use this file
 * except in compliance with the License. You may obtain a copy
 * of the License at http://www.Inprise.com/IPL.html
 *
 * Software distributed under the License is distributed on an
 * "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express
 * or implied. See the License for the specific language governing
 * rights and limitations under the License.
 *
 * The Original Code was created by Inprise Corporation
 * and its predecessors. Portions created by Inprise Corporation are
 * Copyright (C) Inprise Corporation.
 *
 * All Rights Reserved.
 * Contributor(s): ______________________________________.
 */

#include "firebird.h"
#include "../jrd/ib_stdio.h"
#include <setjmp.h>
#include <stdlib.h>
#include <string.h>
#include "../qli/dtr.h"
#include "../qli/parse.h"
#include "../qli/err_proto.h"
#include "../qli/help_proto.h"
#include "../qli/lex_proto.h"
#include "../jrd/gds_proto.h"

extern TEXT *QLI_error;
extern jmp_buf QLI_env;

static TEXT ERRQ_message[256];

#ifndef gds__io_error
#define gds__io_error            	335544344
#endif


void ERRQ_bugcheck( USHORT number)
{
/**************************************
 *
 *	E R R Q _ b u g c h e c k
 *
 **************************************
 *
 * Functional description
 *	Somebody has screwed up.  Bugcheck.
 *
 **************************************/
	TEXT s[256];

	ERRQ_msg_format(number, sizeof(s), s, NULL, NULL, NULL, NULL, NULL);
	ERRQ_error(9, s, NULL, NULL, NULL, NULL);	/* Msg9 INTERNAL: %s */
}


void ERRQ_database_error( DBB dbb, ISC_STATUS * status_vector)
{
/**************************************
 *
 *	E R R Q _ d a t a b a s e _ e r r o r
 *
 **************************************
 *
 * Functional description
 *	Print message from database error and unwind.
 *
 **************************************/

	if (dbb) {
		ERRQ_msg_put(10, dbb->dbb_filename, NULL, NULL, NULL, NULL);	/* Msg10 ** QLI error from database %s ** */
		gds__print_status(status_vector);
	}
	else {
		ERRQ_msg_put(11, NULL, NULL, NULL, NULL, NULL);	/* Msg11 ** QLI error from database ** */
		gds__print_status(status_vector);
	}

	QLI_skip_line = TRUE;

/* if we've really got the database open and get an I/O error,
   close up neatly.  If we get an I/O error trying to open the
   database, somebody else will clean up */

	if (dbb && dbb->dbb_handle && status_vector[1] == gds__io_error)
		ERRQ_msg_put(458, dbb->dbb_filename, NULL, NULL, NULL, NULL);	/* Msg458 ** connection to database %s lost ** */

	if (QLI_env) {
		Firebird::status_exception::raise(-1);
	}
}


void ERRQ_error(
				USHORT number,
				TEXT * arg1,
				TEXT * arg2, TEXT * arg3, TEXT * arg4, TEXT * arg5)
{
/**************************************
 *
 *	E R R Q _ e r r o r
 *
 **************************************
 *
 * Functional description
 *	An error has occurred.  Put out an error message and
 *	unwind.  If this was called before the unwind path
 *	was established, don't unwind just print error and exit.
 *
 **************************************/

	ERRQ_pending();
	ERRQ_error_format(number, arg1, arg2, arg3, arg4, arg5);

	if (QLI_env)
		Firebird::status_exception::raise(-1);
	else {
		ERRQ_pending();
		ERRQ_exit(FINI_ERROR);
	}
}


void ERRQ_error_format(
					   USHORT number,
					   TEXT * arg1,
					   TEXT * arg2, TEXT * arg3, TEXT * arg4, TEXT * arg5)
{
/**************************************
 *
 *	E R R Q _ e r r o r _ f o  r m a t
 *
 **************************************
 *
 * Functional description
 *	Retrieve a message from the error file and format it
 *      in the standard qli error format, put it where
 *      ERRQ_pending expects to find it.
 **************************************/
	TEXT s[256];

	gds__msg_format(0, QLI_MSG_FAC, number, sizeof(s), s,
					arg1, arg2, arg3, arg4, arg5);
	gds__msg_format(0, QLI_MSG_FAC, 12, sizeof(ERRQ_message),
					ERRQ_message, s, NULL, NULL, NULL, NULL);	/* Msg12 ** QLI error: %s ** */
	QLI_error = (TEXT*) ERRQ_message;
	QLI_skip_line = TRUE;
}


void ERRQ_exit( int status)
{
/**************************************
 *
 *	E R R Q _ e x i t
 *
 **************************************
 *
 * Functional description
 *	Exit after shutting down a bit.
 *
 **************************************/

	HELP_fini();
	LEX_fini();
	exit(status);
}


void ERRQ_msg_format(
					 USHORT number,
					 USHORT length,
					 TEXT * string,
					 TEXT * arg1,
					 TEXT * arg2, TEXT * arg3, TEXT * arg4, TEXT * arg5)
{
/**************************************
 *
 *	E R R Q _ m s g _ f o r m a t
 *
 **************************************
 *
 * Functional description
 *	Retrieve a message from the error file and format it
 *
 **************************************/

	gds__msg_format(0, QLI_MSG_FAC, number, length, string, arg1, arg2, arg3,
					arg4, arg5);
}


void ERRQ_msg_partial(
					  USHORT number,
					  const TEXT * arg1,
					  const TEXT * arg2,
					  const TEXT * arg3,
					  const TEXT * arg4,
					  const TEXT * arg5)
{
/**************************************
 *
 *	E R R Q _ m s g _ p a r t i a l
 *
 **************************************
 *
 * Functional description
 *	Retrieve a message from the error file, format it, and print it
 *
 **************************************/

	gds__msg_format(0, QLI_MSG_FAC, number, sizeof(ERRQ_message),
					ERRQ_message, arg1, arg2, arg3, arg4, arg5);
	ib_printf("%s", ERRQ_message);
}


void ERRQ_msg_put(
				  USHORT number,
				  const TEXT * arg1,
				  const TEXT * arg2,
				  const TEXT * arg3,
				  const TEXT * arg4,
				  const TEXT * arg5)
{
/**************************************
 *
 *	E R R Q _ m s g _ p u t
 *
 **************************************
 *
 * Functional description
 *	Retrieve a message from the error file, format it, and print it
 * It's same outcome than ERRQ_msg_partial but with a newline at the end.
 *
 **************************************/

	gds__msg_format(0, QLI_MSG_FAC, number, sizeof(ERRQ_message),
					ERRQ_message, arg1, arg2, arg3, arg4, arg5);
	ib_printf("%s\n", ERRQ_message);
}


int ERRQ_msg_get( USHORT number, TEXT * msg)
{
/**************************************
 *
 *	E R R Q _ m s g _ g e t
 *
 **************************************
 *
 * Functional description
 *	Retrieve a message from the error file
 *
 **************************************/
	SSHORT l;
	TEXT buffer[128];

	l = gds__msg_format(0, QLI_MSG_FAC, number, sizeof(buffer), buffer,
						NULL, NULL, NULL, NULL, NULL);
	strcpy(msg, buffer);

	return (l >= 0);
}


void ERRQ_pending(void)
{
/**************************************
 *
 *	E R R Q _ p e n d i n g
 *
 **************************************
 *
 * Functional description
 *	Print out an error message if one is pending.
 *
 **************************************/

	if (QLI_error) {
		ib_printf("%s\n", (const char*)QLI_error);
		QLI_error = NULL;
	}
}


void ERRQ_print_error(
					  USHORT number,
					  TEXT * arg1,
					  TEXT * arg2, TEXT * arg3, TEXT * arg4, TEXT * arg5)
{
/**************************************
 *
 *	E R R Q _ p r i n t _ e r r o r
 *
 **************************************
 *
 * Functional description
 *	An error has occurred.  Put out an error message and
 *	unwind.
 *
 **************************************/

	ERRQ_error(number, arg1, arg2, arg3, arg4, arg5);
}


void ERRQ_syntax( USHORT number)
{
/**************************************
 *
 *	E R R Q _ s y n t a x
 *
 **************************************
 *
 * Functional description
 *	Syntax error has occurred.  Give some hint of what went
 *	wrong.
 *
 **************************************/
	TEXT s[256];

	ERRQ_msg_format(number, sizeof(s), s, NULL, NULL, NULL, NULL, NULL);
	ERRQ_error(13, s, QLI_token->tok_string, NULL, NULL, NULL);	/* Msg13 expected %s, encountered %s */
}