Err.H

Go to the documentation of this file.

// Copyright (C) 2001, Compaq Computer Corporation
// 
// This file is part of Vesta.
// 
// Vesta is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
// 
// Vesta 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
// Lesser General Public License for more details.
// 
// You should have received a copy of the GNU Lesser General Public
// License along with Vesta; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

/* File: Err.H                                                 */
/* Last Modified On Mon May 23 23:18:24 EDT 2005 by ken@xorian.net */
/*      Modified On Fri Jul 14 21:04:45 PDT 2000 by mann       */
/*      Modified On Wed Apr 12 18:08:00 PDT 2000 by yuanyu     */
/*      Modified On Sun Nov  2 18:11:16 PST 1997 by heydon     */
/*      Modified On Fri Jan 19 18:36:50 PST 1996 by horning    */
/*      Modified On Mon Oct 18 14:38:29 PDT 1993 by hanna      */

#ifndef Err_H
#define Err_H

#include <VestaSource.H>

#include "ValExpr.H"
#include "Location.H"
#include "ModelState.H"

// The mutex protects output to cout, cerr, and the error counter.
extern Basics::mutex outputMu;

// Count an error:
void Error();

// Return error count:
int ErrorCount();

// Print and count an error, with location, if available:
void Error(const Text &msg, SrcLoc *loc = noLoc);

// Append msg as part of the current error message:
void ErrorDetail(const Text &msg);

// Append the text form of v as part of the current error message:
void ErrorVal(const Val v);

// Append the text form of e as part of the current error message:
void ErrorExpr(const Expr e);

// Append the text form of args as part of the current error message:
void ErrorArgs(const Vals &args);

// Report "impossible" state encountered in procedure procName.
// It is used to indicate implementation errors.
void InternalError(const Text &procName);

// Print the number of errors encounted since the last ErrInit().
// Return true iff there is an error.
bool ErrorSummary(std::ostream *out);

// Record the error of evaluating expression expr on the stack:
Val RecordErrorOnStack(Expr expr);

void ErrInit();

/* Return a string representation of the VestaSource errorCode "err"
   suitable for use in human-readable error messsages. This function
   returns a pointer to static storage. */
const Text VestaSourceErrorMsg(VestaSource::errorCode err) throw ();

#endif // Err_H

---