msys.h

Go to the documentation of this file.

/**
 * \file msys.h <mi32/msys.h>
 * \brief System functions
 *
 * \if NODOC
 * $Id: msys.h_v 1.13 2003/09/15 13:49:56 fileserver!dwilliss Exp $
 *
 * $Log: msys.h_v $
 * Revision 1.13  2003/09/15 13:49:56  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.12  2003/06/12 15:31:19  dwilliss
 * Added CHILDPROCESS_XXX defines.  These used to be in mbfdefns.h, but that
 * file no longer exists
 *
 * Revision 1.11  2003/04/01 15:14:11  mju
 * Add MsysAppGetProductInfo.
 *
 * Revision 1.10  2003/02/11 15:30:01  scowan
 * Changed C linkage run process name.
 *
 * Revision 1.9  2002/04/10 14:43:28  dwilliss
 * Fixed so that it can still be included even if not compiling for C++
 * Yes, this is still an issue with 3rd party libs that we've patched.
 *
 * Revision 1.8  2002/01/21 15:03:46  mju
 * Add 'procname' to MsysAppInitialize().
 *
 * Revision 1.7  2002/01/17 23:51:34  mju
 * Add MsysAppInitialize.
 *
 * Revision 1.6  2002/01/10 15:47:33  mju
 * Add MsysAppOnExitFuncAdd/Remove.
 *
 * Revision 1.5  2002/01/10 14:26:20  mju
 * Use const in RunProcess.
 *
 * Revision 1.4  2002/01/09 22:04:14  mju
 * Add MsysAppCleanup.
 * Rename Get/SetAppName as AppGet/SetName.
 *
 * Revision 1.3  2002/01/09 14:19:28  mju
 * Add RunProcess prototype.
 *
 * Revision 1.2  2002/01/08 23:11:13  mju
 * Add MsysOpenReferenceDocument and MsysRunAssocApp.
 *
 * Revision 1.1  2002/01/08 18:52:03  mju
 * Initial revision
 * \endif
**/

#ifndef  INC_MI32_MSYS_H
#define  INC_MI32_MSYS_H

#ifndef INC_MI32_STDDEFNS_H
#include <mi32/stddefns.h>
#endif

#ifdef __cplusplus
class MISTRING;
#endif


//! Perform application cleanup prior to exit.
//! Calls registered OnExit functions, disconnects from RVC, etc.
void MsysAppCleanup (
   );

//! Get application name.
//! @return Pointer to application name.
//! Do NOT free the pointer returned.
const char* MsysAppGetName (
   );

#ifdef __cplusplus
//! Get descriptive information about product for use in 'Help About' dialogs.
void MsysAppGetProductInfo (
   MISTRING& string                 //!< String returned.
   );
#endif

#ifdef __cplusplus
//! Initialize application.
void MsysAppInitialize (
   const char *procname,            //!< Process name for default INI and msgfile group, NULL to not set
   UINT32 ProductCode = 0           //!< ID of product, 0 for TNTmips
   );
#else
#ifndef GENERATING_DOXYGEN_OUTPUT
//!  version without default args for things that don't compile for C++
void MsysAppInitialize (
   const char *procname,
   UINT32 ProductCode
   );
#endif //!< GENERATING_DOXYGEN_OUTPUT
#endif

#ifdef __cplusplus
//! Add function to be called on application exit during MsysAppCleanup().
//! Functions are called starting with the most recently added.
void MsysAppOnExitFuncAdd (
   void (*pfunc)(void*),            //! Pointer to function to call
   void *pdata = 0                  //!< Optional data to passe to function
   );
#else
#ifndef GENERATING_DOXYGEN_OUTPUT
//!  version without default args for things that don't compile for C++
//! Add function to be called on application exit during MsysAppCleanup().
//! Functions are called starting with the most recently added.
void MsysAppOnExitFuncAdd (
   void (*pfunc)(void*),
   void *pdata
   );
#endif //!< GENERATING_DOXYGEN_OUTPUT
#endif

#ifdef __cplusplus
//! Remove previously added OnExit function.
void MsysAppOnExitFuncRemove (
   void (*pfunc)(void*),            //! Pointer to function to remove
   void *pdata = 0                  //!< Optional data, must match value used in MsysAppOnExitFuncAdd
   );
#else
#ifndef GENERATING_DOXYGEN_OUTPUT
//!  version without default args for things that don't compile for C++
void MsysAppOnExitFuncRemove (
   void (*pfunc)(void*),
   void *pdata
   );
#endif //!< GENERATING_DOXYGEN_OUTPUT
#endif

//! Set application "name" for later retrieval by MsysAppGetName().
void MsysAppSetName (
   const char *newname                 //!< New application name to set
   );

//! Get IP address of local machine.
//! Returns 'true' if X server and client are on same machine (or if not X platform).
bool MsysGetLocalIP (
   UINT8 ip[6]                         //!< IP address returned if available
   );

//! Open 'reference' document using specified tag.
//! @return Error < 0, FALSE if unrecognized tag, TRUE if valid tag.
//! Tag must be in one of the forms:
//!      'TNT:refman/file.pdf#NamedDestination'
//!      'TNT:getstart/file.pdf?page=XXX'
//!      'GETSTART:file.pdf'
//!      'FILE:filename'
int MsysOpenReferenceDocument (
   const char *doctag
   );

//! Run application "associated" with given file and pass file as parameter to it.
//! On systems where there is no operating system-defined association system, the associations are
//!   specified by extension in the "AppAssoc" section of tnthost.ini.
ERRVALUE MsysRunAssocApp (
   const UNICODE *docname              //!< Name of document file
   );

//! Possible "result" values passed to the EndCB of MsysRunProcess
//! These used to be in mbfdefns.h, but that include file is no more.
//! Apparently Windows only uses CHILDPROCESS_Finished.  The Unix
//! platforms can get the other values
#define CHILDPROCESS_Finished          0
#define CHILDPROCESS_ExitError         1
#define CHILDPROCESS_ExternalStop      2
#define CHILDPROCESS_DiedCoreDump      3
#define CHILDPROCESS_DiedNoCoreDump    4

#ifdef __cplusplus
//! Function to execute another program.
int MsysRunProcess (
   const UNICODE *progstr, 
   void (*EndCB)(int pid, int result, void* udata) = 0,
   void *udata = 0
   );
#else
#ifndef GENERATING_DOXYGEN_OUTPUT
//!  version without default args for things that don't compile for C++
int MsysRunProcessC (
   const UNICODE *progstr, 
   void (*EndCB)(int pid, int result, void* udata),
   void *udata
   );
#endif //!< GENERATING_DOXYGEN_OUTPUT
#endif


#endif   //!< INC_MI32_MSYS_H

---