wenv.h

/* wenv.h */
/* $Id: wenv.h,v 1.30 2004/11/29 12:03:27 vlad Exp $ */

/*********************************************************************
 *
 * UNIVERS
 * (C) ¾¾¾ "³µ¾²µÀÁ", 2001
 *
 * ²áÕ ßàÐÒÐ ×ÐéØéÕÝë *
 * ¸áßÞÛì×ÞÒÐÝØÕ, ÚÞßØàÞÒÐÝØÕ ØÛØ ßÕàÕÔÐçÐ àÕÓãÛØàãîâáï ×ÐÚÞÝÐÜØ
 * ÀÞááØÙáÚÞÙ ÄÕÔÕàÐæØØ "¾Ñ ÐÒâÞàáÚÞÜ ßàÐÒÕ Ø áÜÕÖÝëå ßàÐÒÐå", "¾
 * ßàÐÒÞÒÞÙ ÞåàÐÝÕ ßàÞÓàÐÜÜ ÔÛï íÛÕÚâàÞÝÝëå ÒëçØáÛØâÕÛìÝëå ÜÐèØÝ Ø ÑÐ×
 * ÔÐÝÝëå"
 *
 * Encoding: ISO-8859-5 (GOST)
 *
 *********************************************************************/

#ifndef __wenv_h
#define __wenv_h


/*************************************************************
 *
 *     Working environment of UNIVERS processing system.
 *
 *************************************************************/

#include <time.h>
#include <sys/types.h>

#ifndef __wenv_internal
#include <ldb/wenv_stubs.h>
#endif /* __wenv_internal */


/* Emergency level used in wePutMsg()/weFormatMsg() functions. */
#define EL_FATAL    0
#define EL_ERROR    1
#define EL_WARNING  2
#define EL_INFO     3
#define EL_HINT     4
#define EL_DEBUG    5

/* Environment name for data, jobs, logs and locks location */
#define WE_DATA_ENV     "DATA"
#define WE_JOBS_ENV     "JOB"
#define WE_LOGS_ENV     "LOG"
#define WE_LOCKS_ENV        "LOCKS"
#define WE_HCOPIES_ENV      "HCOPIES"
#define WE_REPORT_ENV       "REPORT"
#define WE_ARCHIVE_ENV      "ARCHIVE"

/** JOBS/JOB and LOGS/LOG pairs are not mistakes but SDS-5 backward
    compatibility features */

/** Prefix for the name of env.variable which used for job number
    delivering. */
#define WE_DELIVER_JOBNUM_PREFIX    "DELIVER_JOBNUM_"


#ifdef VERSION_NUMBER
/** Version of a program is an integer number. */
#define weVersion() VERSION_NUMBER
#else
#define weVersion() (-1)
#endif /* VERSION */


/** Maximum length for names (application, workplace, user,
    PEP-protocol, etc) without ending EOS. */
#define WE_NAME_LEN     99

/** Maximum length of message string (without ending EOS) */
#define WE_MSG_LEN      2047

/** The longest allowed path PATH_MAX.  Please, don't use this value;
    try BuildFilePath() from mix/PortableDirs.h to allocate path
    dynamically. */
#ifndef _POSIX_SOURCE
#define _POSIX_SOURCE
#endif /* _POSIX_SOURCE */
#include <limits.h>

#ifndef PATH_MAX
#define PATH_MAX    1024
#endif /* PATH_MAX */


/** Lenght of a moment format: "YYYY/MM/DD HH:MM:SS"
    Date format: "YYYY/MM/DD"
    Time format: "HH:MM:SS" */
#define MOMENT_LEN  20


/* Language symbolic codes */
#define WE_LANG_ENGLISH     "en"
#define WE_LANG_RUSSIAN     "ru"
#define WE_LANG_CHINESE     "cn"

/* Name of file in weUserLoc() directory where the only string with
   preferred language is stored. */
#define WE_LANG_FILENAME    "language"



#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */


  /*
   * Initialization and self-identification features
   */

  /** Setup packet id in case of it does not equal to default one */
  void  weSetProduct (int);

  /** The environment initialization procedure.  Can abort program if
      its environment can't be successfully built. */
  void  weInitialize ();

  /** Assign name for the program.  Name must be unique among other of
      the system UNIVERS. */
  void  weSetAppName (const char* szAppName);

  /** Get name of the program. */
  const char*   weAppName ();

  /** Get host name (for specifying processor/OS instance). */
  const char*   weHostName ();

  /** Get instance identifier of the running application.  Use it in
      conjunction with weHostName. */
  pid_t     weAppInstance ();

  /** Get name of the workplace.  Workplace name begins with HOSTNAME
      and then after separator may follow TERMINAL specification.
      Separator is one of chars :;,/\|!?<>(){}[] */
  const char*   weWorkplaceName ();

  /** Get name of the user. */
  const char*   weUserName ();

  /** Program identification:

     - running item:
     AppName AppInstance WorkplaceName UserName StartMoment Project

     - historical item:
     AppName WorkplaceName UserName StartMoment FinishMoment Project
  */


  /*
   * Common processing environment
   * All paths without final slash
   */


  /** Get path to system files: $VSPHOME */
  const char*   weSystemLoc ();

  /** Get path to user configuration: $HOME/.vsp */
  const char*   weUserLoc ();

  /** Checking for expected environment settings.  If some settings are
      bad then warning is printed.  Returns count of warnings (0 means
      OK). */
  int       weCheckStdAppEnv ();

  /** Pass job number to the szApplication by setting this value to
      env.variable strcat(WE_DELIVER_JOBNUM_PREFIX, szApplication).
      weJobNumber() call in the nearest exec*() call of szApplication
      will return delivered number.  Return 0 on error and job number
      on success. */
  int       weDeliverJobNumber (const char* szApplication, int nJob);

  /** Constructs name of the job number delivering variable. */
  void      weDeliverJobNumberName (const char* szApplication,
                    char* szVarName);


  /*
   * Actions at exit of a program.
   */

  /** This proc is called from atexit(3) function.  Do not call it
      directly! */
  void  weSystemAtExitHandler ();

  /** Prototype of at-exit handler. */
  typedef void  (*weAtExitHandlerProc)(void);

  /** Register given at-exit procedure. */
  void  weRegisterAtExitHandler (weAtExitHandlerProc proc);

  /** Unregister given at-exit procedure.  If not found do not trouble
      a programmer. */
  void  weUnregisterAtExitHandler (weAtExitHandlerProc proc);



  /*
   * Log messages handling
   */

  /** Put message of pointed elevel into log */
  void  wePutMsg (int elevel, const char* msg);

  /** Put formatted message of pointed elevel into log */
  void  weFormatMsg (int elevel, const char* format, ...);

  /** Prototype of message handler.  Must return non-zero if wants to
      dispatch message to earlier registered handler. */
  typedef int (*weMsgHandlerProc)(int elevel, const char* msg);

  /** Register handler of messages.  Passed NULL cleans list of
      handlers. */
  void  weRegisterMsgHandler (weMsgHandlerProc proc);

  /** Message handler procedure with extended information about
      program.  For messages of level ERROR and FATAL composes special
      prefix with app identification and puts them to original stderr
      (general message log). */
  int   weExtendedMsgHandlerProc (int elevel, const char* msg);


  /*
   * Time and date format
   * for internal representation is used POSIX struct tm, but
   * fields tm_wday, tm_yday, tm_isdst are not used.
   */

  /** Returns pointer at string contains current time and date.  With
      NULL argument returns pointer at static area. */
  char* weMoment (char* place);

  /** Returns pointer at string contains pointed time in format
      "HH:MM:SS".  With NULL place returns pointer at static area.
      With NULL tm_ptr returns current time. */
  char* weFormatTime (char* place, struct tm* tm_ptr);

  /** Returns pointer at string contains pointed date in format
      "YYYY/MM/DD".  With NULL argument returns pointer at static
      area.  With NULL tm_ptr returns current date. */
  char* weFormatDate (char* place, struct tm* tm_ptr);

  /* Parses moment string and its parts and fills fields of *tm_ptr.
     Returns 0 if all is OK and !0 otherwise. */
  int   weParseMoment (const char* szMoment, struct tm* tm_ptr);
  int   weParseDate (const char* szDate, struct tm* tm_ptr);
  int   weParseTime (const char* szTime, struct tm* tm_ptr);


  /*
   * User-preferred language
   */

  /** Get preferred language string in dynamically allocated (by
      malloc) string. */
  char* weGetPrefLanguage ();

  /** Set preferred language string. */
  void  weSetPrefLanguage (const char* szLang);


  /*
   * Miscelaneous
   */

  /** Return level of debugging that is set by UDEBUG environment
      variable.  (DEBUG variable is used by 'setup').
      If UDEBUG is empty, 0 is returned;
      if UDEBUG=<number>, number is returned;
      if UDEBUG=<text>, -1 is returned. */
  int   weDebugLevel ();

  /** Return level of development facilities that is set by UDEVELOP
      environment variable.
      If UDEVELOP is empty, 0 is returned;
      if UDEVELOP=<number>, number is returned;
      if UDEVELOP=<text>, -1 is returned. */
  int   weDevelopLevel ();


#ifdef __cplusplus
};
#endif /* __cplusplus */

#endif /* wenv.h */

 *
 * ¸áßÞÛì×ÞÒÐÝØÕ, ÚÞßØàÞÒÐÝØÕ ØÛØ ßÕàÕÔÐçÐ àÕÓãÛØàãîâáï ×ÐÚÞÝÐÜØ
 * ÀÞááØÙáÚÞÙ ÄÕÔÕàÐæØØ "¾Ñ ÐÒâÞàáÚÞÜ ßàÐÒÕ Ø áÜÕÖÝëå ßàÐÒÐå", "¾ * ßàÐÒÞÒÞÙ ÞåàÐÝÕ ßàÞÓàÐÜÜ ÔÛï íÛÕÚâàÞÝÝëå ÒëçØáÛØâÕÛìÝëå ÜÐèØÝ Ø ÑÐ×
 * ÔÐÝÝëå"
 *
 * Encoding: ISO-8859-5 (GOST)
 *
 *********************************************************************/

#ifndef __wenv_h
#define __wenv_h


/*************************************************************
 *
 *     Working environment of UNIVERS processing system.
 *
 *************************************************************/

#include <time.h>
#include <sys/types.h>

#ifndef __wenv_internal
#include <ldb/wenv_stubs.h>
#endif /* __wenv_internal */


/* Emergency level used in wePutMsg()/weFormatMsg() functions. */
#define EL_FATAL    0
#define EL_ERROR    1
#define EL_WARNING  2
#define EL_INFO     3
#define EL_HINT     4
#define EL_DEBUG    5

/* Environment name for data, jobs, logs and locks location */
#define WE_DATA_ENV     "DATA"
#define WE_JOBS_ENV     "JOB"
#define WE_LOGS_ENV     "LOG"
#define WE_LOCKS_ENV        "LOCKS"
#define WE_HCOPIES_ENV      "HCOPIES"
#define WE_REPORT_ENV       "REPORT"
#define WE_ARCHIVE_ENV      "ARCHIVE"

/** JOBS/JOB and LOGS/LOG pairs are not mistakes but SDS-5 backward
    compatibility features */

/** Prefix for the name of env.variable which used for job number
    delivering. */
#define WE_DELIVER_JOBNUM_PREFIX    "DELIVER_JOBNUM_"


#ifdef VERSION_NUMBER
/** Version of a program is an integer number. */
#define weVersion() VERSION_NUMBER
#else
#define weVersion() (-1)
#endif /* VERSION */


/** Maximum length for names (application, workplace, user,
    PEP-protocol, etc) without ending EOS. */
#define WE_NAME_LEN     99

/** Maximum length of message string (without ending EOS) */
#define WE_MSG_LEN      2047

/** The longest allowed path PATH_MAX.  Please, don't use this value;
    try BuildFilePath() from mix/PortableDirs.h to allocate path
    dynamically. */
#ifndef _POSIX_SOURCE
#define _POSIX_SOURCE
#endif /* _POSIX_SOURCE */
#include <limits.h>

#ifndef PATH_MAX
#define PATH_MAX    1024
#endif /* PATH_MAX */


/** Lenght of a moment format: "YYYY/MM/DD HH:MM:SS"
    Date format: "YYYY/MM/DD"
    Time format: "HH:MM:SS" */
#define MOMENT_LEN  20


/* Language symbolic codes */
#define WE_LANG_ENGLISH     "en"
#define WE_LANG_RUSSIAN     "ru"
#define WE_LANG_CHINESE     "cn"

/* Name of file in weUserLoc() directory where the only string with
   preferred language is stored. */
#define WE_LANG_FILENAME    "language"



#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */


  /*
   * Initialization and self-identification features
   */

  /** Setup packet id in case of it does not equal to default one */
  void  weSetProduct (int);

  /** The environment initialization procedure.  Can abort program if
      its environment can't be successfully built. */
  void  weInitialize ();

  /** Assign name for the program.  Name must be unique among other of
      the system UNIVERS. */
  void  weSetAppName (const char* szAppName);

  /** Get name of the program. */
  const char*   weAppName ();

  /** Get host name (for specifying processor/OS instance). */
  const char*   weHostName ();

  /** Get instance identifier of the running application.  Use it in
      conjunction with weHostName. */
  pid_t     weAppInstance ();

  /** Get name of the workplace.  Workplace name begins with HOSTNAME
      and then after separator may follow TERMINAL specification.
      Separator is one of chars :;,/\|!?<>(){}[] */
  const char*   weWorkplaceName ();

  /** Get name of the user. */
  const char*   weUserName ();

  /** Program identification:

     - running item:
     AppName AppInstance WorkplaceName UserName StartMoment Project

     - historical item:
     AppName WorkplaceName UserName StartMoment FinishMoment Project
  */


  /*
   * Common processing environment
   * All paths without final slash
   */


  /** Get path to system files: $VSPHOME */
  const char*   weSystemLoc ();

  /** Get path to user configuration: $HOME/.vsp */
  const char*   weUserLoc ();

  /** Checking for expected environment settings.  If some settings are
      bad then warning is printed.  Returns count of warnings (0 means
      OK). */
  int       weCheckStdAppEnv ();

  /** Pass job number to the szApplication by setting this value to
      env.variable strcat(WE_DELIVER_JOBNUM_PREFIX, szApplication).
      weJobNumber() call in the nearest exec*() call of szApplication
      will return delivered number.  Return 0 on error and job number
      on success. */
  int       weDeliverJobNumber (const char* szApplication, int nJob);

  /** Constructs name of the job number delivering variable. */
  void      weDeliverJobNumberName (const char* szApplication,
                    char* szVarName);


  /*
   * Actions at exit of a program.
   */

  /** This proc is called from atexit(3) function.  Do not call it
      directly! */
  void  weSystemAtExitHandler ();

  /** Prototype of at-exit handler. */
  typedef void  (*weAtExitHandlerProc)(void);

  /** Register given at-exit procedure. */
  void  weRegisterAtExitHandler (weAtExitHandlerProc proc);

  /** Unregister given at-exit procedure.  If not found do not trouble
      a programmer. */
  void  weUnregisterAtExitHandler (weAtExitHandlerProc proc);



  /*
   * Log messages handling
   */

  /** Put message of pointed elevel into log */
  void  wePutMsg (int elevel, const char* msg);

  /** Put formatted message of pointed elevel into log */
  void  weFormatMsg (int elevel, const char* format, ...);

  /** Prototype of message handler.  Must return non-zero if wants to
      dispatch message to earlier registered handler. */
  typedef int (*weMsgHandlerProc)(int elevel, const char* msg);

  /** Register handler of messages.  Passed NULL cleans list of
      handlers. */
  void  weRegisterMsgHandler (weMsgHandlerProc proc);

  /** Message handler procedure with extended information about
      program.  For messages of level ERROR and FATAL composes special
      prefix with app identification and puts them to original stderr
      (general message log). */
  int   weExtendedMsgHandlerProc (int elevel, const char* msg);


  /*
   * Time and date format
   * for internal representation is used POSIX struct tm, but
   * fields tm_wday, tm_yday, tm_isdst are not used.
   */

  /** Returns pointer at string contains current time and date.  With
      NULL argument returns pointer at static area. */
  char* weMoment (char* place);

  /** Returns pointer at string contains pointed time in format
      "HH:MM:SS".  With NULL place returns pointer at static area.
      With NULL tm_ptr returns current time. */
  char* weFormatTime (char* place, struct tm* tm_ptr);

  /** Returns pointer at string contains pointed date in format
      "YYYY/MM/DD".  With NULL argument returns pointer at static
      area.  With NULL tm_ptr returns current date. */
  char* weFormatDate (char* place, struct tm* tm_ptr);

  /* Parses moment string and its parts and fills fields of *tm_ptr.
     Returns 0 if all is OK and !0 otherwise. */
  int   weParseMoment (const char* szMoment, struct tm* tm_ptr);
  int   weParseDate (const char* szDate, struct tm* tm_ptr);
  int   weParseTime (const char* szTime, struct tm* tm_ptr);


  /*
   * User-preferred language
   */

  /** Get preferred language string in dynamically allocated (by
      malloc) string. */
  char* weGetPrefLanguage ();

  /** Set preferred language string. */
  void  weSetPrefLanguage (const char* szLang);


  /*
   * Miscelaneous
   */

  /** Return level of debugging that is set by UDEBUG environment
      variable.  (DEBUG variable is used by 'setup').
      If UDEBUG is empty, 0 is returned;
      if UDEBUG=<number>, number is returned;
      if UDEBUG=<text>, -1 is returned. */
  int   weDebugLevel ();

  /** Return level of development facilities that is set by UDEVELOP
      environment variable.
      If UDEVELOP is empty, 0 is returned;
      if UDEVELOP=<number>, number is returned;
      if UDEVELOP=<text>, -1 is returned. */
  int   weDevelopLevel ();


#ifdef __cplusplus
};
#endif /* __cplusplus */

#endif /* wenv.h */

 * ßàÐÒÞÒÞÙ ÞåàÐÝÕ ßàÞÓàÐÜÜ ÔÛï íÛÕÚâàÞÝÝëå ÒëçØáÛØâÕÛìÝëå ÜÐèØÝ Ø ÑÐ× * ÔÐÝÝëå"
 *
 * Encoding: ISO-8859-5 (GOST)
 *
 *********************************************************************/

#ifndef __wenv_h
#define __wenv_h


/*************************************************************
 *
 *     Working environment of UNIVERS processing system.
 *
 *************************************************************/

#include <time.h>
#include <sys/types.h>

#ifndef __wenv_internal
#include <ldb/wenv_stubs.h>
#endif /* __wenv_internal */


/* Emergency level used in wePutMsg()/weFormatMsg() functions. */
#define EL_FATAL    0
#define EL_ERROR    1
#define EL_WARNING  2
#define EL_INFO     3
#define EL_HINT     4
#define EL_DEBUG    5

/* Environment name for data, jobs, logs and locks location */
#define WE_DATA_ENV     "DATA"
#define WE_JOBS_ENV     "JOB"
#define WE_LOGS_ENV     "LOG"
#define WE_LOCKS_ENV        "LOCKS"
#define WE_HCOPIES_ENV      "HCOPIES"
#define WE_REPORT_ENV       "REPORT"
#define WE_ARCHIVE_ENV      "ARCHIVE"

/** JOBS/JOB and LOGS/LOG pairs are not mistakes but SDS-5 backward
    compatibility features */

/** Prefix for the name of env.variable which used for job number
    delivering. */
#define WE_DELIVER_JOBNUM_PREFIX    "DELIVER_JOBNUM_"


#ifdef VERSION_NUMBER
/** Version of a program is an integer number. */
#define weVersion() VERSION_NUMBER
#else
#define weVersion() (-1)
#endif /* VERSION */


/** Maximum length for names (application, workplace, user,
    PEP-protocol, etc) without ending EOS. */
#define WE_NAME_LEN     99

/** Maximum length of message string (without ending EOS) */
#define WE_MSG_LEN      2047

/** The longest allowed path PATH_MAX.  Please, don't use this value;
    try BuildFilePath() from mix/PortableDirs.h to allocate path
    dynamically. */
#ifndef _POSIX_SOURCE
#define _POSIX_SOURCE
#endif /* _POSIX_SOURCE */
#include <limits.h>

#ifndef PATH_MAX
#define PATH_MAX    1024
#endif /* PATH_MAX */


/** Lenght of a moment format: "YYYY/MM/DD HH:MM:SS"
    Date format: "YYYY/MM/DD"
    Time format: "HH:MM:SS" */
#define MOMENT_LEN  20


/* Language symbolic codes */
#define WE_LANG_ENGLISH     "en"
#define WE_LANG_RUSSIAN     "ru"
#define WE_LANG_CHINESE     "cn"

/* Name of file in weUserLoc() directory where the only string with
   preferred language is stored. */
#define WE_LANG_FILENAME    "language"



#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */


  /*
   * Initialization and self-identification features
   */

  /** Setup packet id in case of it does not equal to default one */
  void  weSetProduct (int);

  /** The environment initialization procedure.  Can abort program if
      its environment can't be successfully built. */
  void  weInitialize ();

  /** Assign name for the program.  Name must be unique among other of
      the system UNIVERS. */
  void  weSetAppName (const char* szAppName);

  /** Get name of the program. */
  const char*   weAppName ();

  /** Get host name (for specifying processor/OS instance). */
  const char*   weHostName ();

  /** Get instance identifier of the running application.  Use it in
      conjunction with weHostName. */
  pid_t     weAppInstance ();

  /** Get name of the workplace.  Workplace name begins with HOSTNAME
      and then after separator may follow TERMINAL specification.
      Separator is one of chars :;,/\|!?<>(){}[] */
  const char*   weWorkplaceName ();

  /** Get name of the user. */
  const char*   weUserName ();

  /** Program identification:

     - running item:
     AppName AppInstance WorkplaceName UserName StartMoment Project

     - historical item:
     AppName WorkplaceName UserName StartMoment FinishMoment Project
  */


  /*
   * Common processing environment
   * All paths without final slash
   */


  /** Get path to system files: $VSPHOME */
  const char*   weSystemLoc ();

  /** Get path to user configuration: $HOME/.vsp */
  const char*   weUserLoc ();

  /** Checking for expected environment settings.  If some settings are
      bad then warning is printed.  Returns count of warnings (0 means
      OK). */
  int       weCheckStdAppEnv ();

  /** Pass job number to the szApplication by setting this value to
      env.variable strcat(WE_DELIVER_JOBNUM_PREFIX, szApplication).
      weJobNumber() call in the nearest exec*() call of szApplication
      will return delivered number.  Return 0 on error and job number
      on success. */
  int       weDeliverJobNumber (const char* szApplication, int nJob);

  /** Constructs name of the job number delivering variable. */
  void      weDeliverJobNumberName (const char* szApplication,
                    char* szVarName);


  /*
   * Actions at exit of a program.
   */

  /** This proc is called from atexit(3) function.  Do not call it
      directly! */
  void  weSystemAtExitHandler ();

  /** Prototype of at-exit handler. */
  typedef void  (*weAtExitHandlerProc)(void);

  /** Register given at-exit procedure. */
  void  weRegisterAtExitHandler (weAtExitHandlerProc proc);

  /** Unregister given at-exit procedure.  If not found do not trouble
      a programmer. */
  void  weUnregisterAtExitHandler (weAtExitHandlerProc proc);



  /*
   * Log messages handling
   */

  /** Put message of pointed elevel into log */
  void  wePutMsg (int elevel, const char* msg);

  /** Put formatted message of pointed elevel into log */
  void  weFormatMsg (int elevel, const char* format, ...);

  /** Prototype of message handler.  Must return non-zero if wants to
      dispatch message to earlier registered handler. */
  typedef int (*weMsgHandlerProc)(int elevel, const char* msg);

  /** Register handler of messages.  Passed NULL cleans list of
      handlers. */
  void  weRegisterMsgHandler (weMsgHandlerProc proc);

  /** Message handler procedure with extended information about
      program.  For messages of level ERROR and FATAL composes special
      prefix with app identification and puts them to original stderr
      (general message log). */
  int   weExtendedMsgHandlerProc (int elevel, const char* msg);


  /*
   * Time and date format
   * for internal representation is used POSIX struct tm, but
   * fields tm_wday, tm_yday, tm_isdst are not used.
   */

  /** Returns pointer at string contains current time and date.  With
      NULL argument returns pointer at static area. */
  char* weMoment (char* place);

  /** Returns pointer at string contains pointed time in format
      "HH:MM:SS".  With NULL place returns pointer at static area.
      With NULL tm_ptr returns current time. */
  char* weFormatTime (char* place, struct tm* tm_ptr);

  /** Returns pointer at string contains pointed date in format
      "YYYY/MM/DD".  With NULL argument returns pointer at static
      area.  With NULL tm_ptr returns current date. */
  char* weFormatDate (char* place, struct tm* tm_ptr);

  /* Parses moment string and its parts and fills fields of *tm_ptr.
     Returns 0 if all is OK and !0 otherwise. */
  int   weParseMoment (const char* szMoment, struct tm* tm_ptr);
  int   weParseDate (const char* szDate, struct tm* tm_ptr);
  int   weParseTime (const char* szTime, struct tm* tm_ptr);


  /*
   * User-preferred language
   */

  /** Get preferred language string in dynamically allocated (by
      malloc) string. */
  char* weGetPrefLanguage ();

  /** Set preferred language string. */
  void  weSetPrefLanguage (const char* szLang);


  /*
   * Miscelaneous
   */

  /** Return level of debugging that is set by UDEBUG environment
      variable.  (DEBUG variable is used by 'setup').
      If UDEBUG is empty, 0 is returned;
      if UDEBUG=<number>, number is returned;
      if UDEBUG=<text>, -1 is returned. */
  int   weDebugLevel ();

  /** Return level of development facilities that is set by UDEVELOP
      environment variable.
      If UDEVELOP is empty, 0 is returned;
      if UDEVELOP=<number>, number is returned;
      if UDEVELOP=<text>, -1 is returned. */
  int   weDevelopLevel ();


#ifdef __cplusplus
};
#endif /* __cplusplus */

#endif /* wenv.h */

 * ÔÐÝÝëå"
 *
 * Encoding: ISO-8859-5 (GOST)
 *
 *********************************************************************/

#ifndef __wenv_h
#define __wenv_h


/*************************************************************
 *
 *     Working environment of UNIVERS processing system.
 *
 *************************************************************/

#include <time.h>
#include <sys/types.h>

#ifndef __wenv_internal
#include <ldb/wenv_stubs.h>
#endif /* __wenv_internal */


/* Emergency level used in wePutMsg()/weFormatMsg() functions. */
#define EL_FATAL    0
#define EL_ERROR    1
#define EL_WARNING  2
#define EL_INFO     3
#define EL_HINT     4
#define EL_DEBUG    5

/* Environment name for data, jobs, logs and locks location */
#define WE_DATA_ENV     "DATA"
#define WE_JOBS_ENV     "JOB"
#define WE_LOGS_ENV     "LOG"
#define WE_LOCKS_ENV        "LOCKS"
#define WE_HCOPIES_ENV      "HCOPIES"
#define WE_REPORT_ENV       "REPORT"
#define WE_ARCHIVE_ENV      "ARCHIVE"

#define WE_DELIVER_JOBNUM_PREFIX    "DELIVER_JOBNUM_"


#ifdef VERSION_NUMBER

#define weVersion() VERSION_NUMBER
#else
#define weVersion() (-1)
#endif /* VERSION */


#define WE_NAME_LEN     99

#define WE_MSG_LEN      2047

#ifndef _POSIX_SOURCE
#define _POSIX_SOURCE
#endif /* _POSIX_SOURCE */
#include <limits.h>

#ifndef PATH_MAX
#define PATH_MAX    1024
#endif /* PATH_MAX */


#define MOMENT_LEN  20


/* Language symbolic codes */
#define WE_LANG_ENGLISH     "en"
#define WE_LANG_RUSSIAN     "ru"
#define WE_LANG_CHINESE     "cn"

/* Name of file in weUserLoc() directory where the only string with
   preferred language is stored. */
#define WE_LANG_FILENAME    "language"



#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */


  /*
   * Initialization and self-identification features
   */

  void  weSetProduct (int);

  void  weInitialize ();

  void  weSetAppName (const char* szAppName);

  const char*   weAppName ();

  const char*   weHostName ();

  pid_t     weAppInstance ();

  const char*   weWorkplaceName ();

  const char*   weUserName ();

  /*
   * Common processing environment
   * All paths without final slash
   */


  const char*   weSystemLoc ();

  const char*   weUserLoc ();

  int       weCheckStdAppEnv ();

  int       weDeliverJobNumber (const char* szApplication, int nJob);

  void      weDeliverJobNumberName (const char* szApplication,
                    char* szVarName);


  /*
   * Actions at exit of a program.
   */

  void  weSystemAtExitHandler ();

  typedef void  (*weAtExitHandlerProc)(void);

  void  weRegisterAtExitHandler (weAtExitHandlerProc proc);

  void  weUnregisterAtExitHandler (weAtExitHandlerProc proc);



  /*
   * Log messages handling
   */

  void  wePutMsg (int elevel, const char* msg);

  void  weFormatMsg (int elevel, const char* format, ...);

  typedef int (*weMsgHandlerProc)(int elevel, const char* msg);

  void  weRegisterMsgHandler (weMsgHandlerProc proc);

  int   weExtendedMsgHandlerProc (int elevel, const char* msg);


  /*
   * Time and date format
   * for internal representation is used POSIX struct tm, but
   * fields tm_wday, tm_yday, tm_isdst are not used.
   */

  char* weMoment (char* place);

  char* weFormatTime (char* place, struct tm* tm_ptr);

  char* weFormatDate (char* place, struct tm* tm_ptr);

  /* Parses moment string and its parts and fills fields of *tm_ptr.
     Returns 0 if all is OK and !0 otherwise. */
  int   weParseMoment (const char* szMoment, struct tm* tm_ptr);
  int   weParseDate (const char* szDate, struct tm* tm_ptr);
  int   weParseTime (const char* szTime, struct tm* tm_ptr);


  /*
   * User-preferred language
   */

  char* weGetPrefLanguage ();

  void  weSetPrefLanguage (const char* szLang);


  /*
   * Miscelaneous
   */

  int   weDebugLevel ();

  int   weDevelopLevel ();


#ifdef __cplusplus
};
#endif /* __cplusplus */

#endif /* wenv.h */