include/tdbutil/utils.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2003 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: utils.h,v $ $Revision: 1.1 $ $State: Exp $
*******************************************************************************/

#ifndef utils_H_
#define utils_H_

#include "tdbutil/tdbUtilDefines.h"
#include <stdio.h>

/*
 * Utility functions.
 */
DT_DLL_tdbutil void ps(int indent_level);


/*
 * These callback function types are defined so this library
 * doesn't have to know about the GUI system but can still call
 * GUI functions which update a ProgressMeterDialogBoxClass
 */
typedef void MyProgressCallbackStartFunction(char *label, int range);
typedef void MyProgressCallbackSetValueFunction(int value);
typedef void MyProgressCallbackIncrementalProgressFunction(int increment);
typedef void MyProgressCallbackEndFunction(void);


/*
 * The calling GUI code does this:
 *
 * static ProgressMeterDialogBoxClass* p = 0;
 * static wxFrame* me = 0;
 * void prog_start_fcn(char *label, int range) { p = new ProgressMeterDialogBoxClass(me, "label", range); }
 * void prog_incremental_fcn(int increment) { p->DidSomeMore(increment); }
 * void prog_set_value_fcn(int value) { p->SetValue(value); }
 * void prog_end_fcn(void) { delete(p); }
 *
 *
 * The called, time-intensive prototdb functions call these like:
 *
 * void load_db(MyProgressCallbackStartFunction *prog_start_fcnp,
 *      MyProgressCallbackSetValueFunction *prog_set_value_fcnp,
 *      MyProgressCallbackIncrementalProgressFunction *prog_incremental_fcnp,
 *           MyProgressCallbackEndFunction *prog_end_fcnp)
 * {
 *    (*prog_start_fcnp)("Loading database", 10000);
 *
 *    for (int i=0; i<10000; i++)
 *      {
 *   (*prog_set_value_fcnp)(i); // This, or...
 *        (*prog_incremental_fcnp)(1); // this. 
 *      }
 *    (*prog_end_fcnp)();
 * }  
 *
 * Or, if you can live with the restrictions, inherit CanPopUpProgressMeter class.
 */



/****************************************************************
 * File I/O
 ****************************************************************/
DT_DLL_tdbutil size_t DtFileLength(const char *pathname);

DT_DLL_tdbutil size_t DtFileLength(FILE *fp);

DT_DLL_tdbutil FILE*  DtFileOpenForReading(const char *pathname);
DT_DLL_tdbutil FILE*  DtFileOpenForWriting(const char *pathname);

// Closes the specified file pointer, but unlike DtFileClose(),
// this function will check that the file closed successfully, and
// print out warnings otherwise.  
// @note This function will  
// @returns True if the file closed successfully, false otherwise.
DT_DLL_tdbutil bool   DtFileCloseVerbose(FILE *fp);

DT_DLL_tdbutil size_t DtReadBytes(void *where, size_t size, FILE *fp);

DT_DLL_tdbutil size_t DtReadMod4Bytes(void *where, size_t size, FILE *fp);

// fgets with the newline (if any) stripped from the result
DT_DLL_tdbutil char* DtReadLine(char *buf, int bufSize, FILE *fp );

//void DtSkipBytes(FILE *fp, size_t amount_to_skip);

#endif