lt_utilStatusData.h

Go to the documentation of this file.

/* $Id$ */
/* //////////////////////////////////////////////////////////////////////////
//                                                                         //
// This code is Copyright (c) 2004 LizardTech, Inc, 1008 Western Avenue,   //
// Suite 200, Seattle, WA 98104.  Unauthorized use or distribution         //
// prohibited.  Access to and use of this code is permitted only under     //
// license from LizardTech, Inc.  Portions of the code are protected by    //
// US and foreign patents and other filings. All Rights Reserved.          //
//                                                                         //
/* PUBLIC */

#ifndef LT_UTILSTATUSDATA_H
#define LT_UTILSTATUSDATA_H

// lt_lib_base
#include "lt_base.h"

// system
#include <stdlib.h>


#if defined(LT_COMPILER_MS)
   #pragma warning(push,4) 
#endif


LT_BEGIN_NAMESPACE(LizardTech)

class LTFileSpec;


class LTUtilStatusData
{
public:
   static LT_STATUS initialize();

   static LT_STATUS terminate();

   // returns true iff initialize() was called, e.g. system is being used
   static bool isActive();

   // push data associated with an error onto the error frame stack
   // do begin(), data..., end()
   static void pushBegin(LT_STATUS);
   static void pushUint32(lt_uint32);
   static void pushInt32(lt_int32);
   static void pushString(const char*);
   static void pushDouble(double);
   static void pushFileSpec(const LTFileSpec&);
   static void pushEnd();

   // get the top data item off the error frame stack
   // returns failure if the data itemis not of the specified type
   static LT_STATUS popBegin(LT_STATUS&);
   static LT_STATUS popUint32(lt_uint32&);
   static LT_STATUS popInt32(lt_int32&);
   static LT_STATUS popString(char*&);         // caller takes ownership of string
   static LT_STATUS popDouble(double&);
   static LT_STATUS popFileSpec(LTFileSpec&);
   static LT_STATUS popEnd();

   // pop off all data items from current frame
   // used in an emergency, when the top frame is not the one you want
   //   (and you have no way of knowing how many data items need to be
   //   popped off)
   static LT_STATUS popRemainder();

   // remove the current error frame, if any (this is like doing the pop
   // begin/end sequence, if there is an active frame)
   static void clear();
};


LT_END_NAMESPACE(LizardTech)

#if defined(LT_COMPILER_MS)
   #pragma warning(pop) 
#endif

#endif // LT_UTILSTATUSDATA_H

---

LizardTech