/****************************** Module Header *******************************
*
* Module Name: nepmdlib.e
*
* .e wrapper routines to access the NEPMD library DLL.
* Counterpart to this .e/.ex file is nepmdlib.dll
*
* Copyright (c) Netlabs EPM Distribution Project 2002
*
* $Id$
*
* ===========================================================================
*
* This file is part of the netlabs.org EPM Distribution package and is free
* software. You can redistribute it and/or modify it under the terms of the
* GNU General Public License as published by the Free Software Foundation,
* in version 2 as it comes in the "netlabs\help\COPYING" file of the
* netlabs.org EPM Distribution. This library 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 General Public License for more details.
*
****************************************************************************/

const
-------- Start of configuration constants for MYCNF.E --------
compile if not defined(NEPMD_LIB_TEST)
   NEPMD_LIB_TEST = 1   -- Include test and demo commands?
compile endif
compile if not defined(NEPMD_LIB_DEBUG)
   NEPMD_LIB_DEBUG = 0  -- Activate debug for this package?
compile endif
-------- End of configuration constants for MYCNF.E ----------

compile if 0
   -- STDCONST.E is also required for GETNEXT_CREATE_NEW_HANDLE
   include 'STDCONST.E'
compile else
   tryinclude 'STDCONST.E'
   -- Avoid include of stdconst.e if compiled separately
 compile if not defined( EPMINFO_EDITCLIENT)
   EPMINFO_EDITCLIENT = 5
 compile endif
 compile if not defined( EPMINFO_EDITFRAME)
   EPMINFO_EDITFRAME  = 6
 compile endif
 compile if not defined( GETNEXT_CREATE_NEW_HANDLE)
   GETNEXT_CREATE_NEW_HANDLE = \xff\xff\xff\xff
 compile endif
 compile if not defined( HINI_NEPMDPROFILE)
   HINI_NEPMDPROFILE  = -3
 compile endif
 compile if not defined( MAXCOL)
   MAXCOL = 1600  -- The last col is reserved for the (virtual) line end
 compile endif
compile endif

   NEPMD_MAXLEN_ESTRING    = MAXCOL - 1

   NEPMD_INI_APPNAME       = 'NEPMD'
   NEPMD_INI_KEY_ROOTDIR   = 'RootDir'

   NEPMD_LIBRARY_BASENAME  = 'nepmdlib'
   NEPMD_SUBPATH_BINDLLDIR = 'netlabs\dll'

   ERRMSG_ERROR_TITLE      = 'Netlabs EPM Distribution'
   ERRMSG_CANNOT_LOAD      = 'Error: cannot load NEPMD library file NEPMDLIB.DLL.'
   ERRMSG_BOXSTYLE         = 16454  -- CANCEL + ICONHAND + MOVEABLE

compile if NEPMD_LIB_TEST
   NEPMD_TEST_EANAME       = 'NEPMD._TestStringEa'
   NEPMD_TEST_EAVALUE      = 'This is a test value for the NepmdWriteStringEa API.'

   NEPMD_TEST_CONFIGPATH   = '\NEPMD\Test\Nepmdlib\TestKey'
   NEPMD_TEST_CONFIGVALUE  = 'This is a test value for the Nepmd*Config* APIs.'
compile endif

/* ------------------------------------------------------------- */
/*   Generic routines for library file and string handling       */
/* ------------------------------------------------------------- */

defproc HelperNepmdGetLibFile
   -- For loading of concurrent DLL versions via LIBPATHSTRICT=T,
   -- it is required to specify the DLL name without extension or
   -- with extension ".dll": Specifying mixed or uppercase
   -- variants for the extension wont load another DLL, if one
   -- with the same basename is already loaded.
compile if 0
   universal nepmdlibfile
   if nepmdlibfile > '' then  -- search only once
      LibFile = nepmdlibfile  -- get LibFile from universal var
   else
      -- use default
      LibFile = NEPMD_LIBRARY_BASENAME
      -- check if DLL is available in NEPMD subdirectory
      InstallPath = queryprofile( '', NEPMD_INI_APPNAME, NEPMD_INI_KEY_ROOTDIR)
      if (InstallPath <> '') then
         CheckFile = InstallPath'\'NEPMD_SUBPATH_BINDLLDIR'\'NEPMD_LIBRARY_BASENAME'.dll'
         if Exist( CheckFile) then
            LibFile = CheckFile
            nepmdlibfile = LibFile  -- save LibFile to a universal var
         endif
      endif
   endif
compile else
   -- nepmdlib.dll must be accessable via LIBPATH or extended LIBPATH
   LibFile = NEPMD_LIBRARY_BASENAME
compile endif

   return LibFile

/* --------------------------------- */

defproc HelperNepmdCheckLibError( LibFile, ret)
   -- Never use rc as standard var!

   if ret < 0 then
      ErrorText = ERRMSG_CANNOT_LOAD
      sayerror ErrorText' ('sayerrortext( ret)')'
   endif

   -- allow easy debugging - release DLL instantly
   if (NEPMD_LIB_DEBUG) then
      -- use different rc  - don't overwrite rc from dynalink32 call
      rcx = dynafree( LibFile)
   endif

   -- Restore rc of the calling proc
   rc = ret
   return

/* --------------------------------- */

defproc HelperNepmdGetConfigHandle
   universal nepmd_hini

   return nepmd_hini

/* --------------------------------- */
compile if NEPMD_LIB_TEST

defproc HelperNepmdCreateDumpFile( FunctionName, Parms)

   SavedRc = rc
   TestcaseTitle = strip( FunctionName Parms)
   Separator     = copies( '-', length( TestcaseTitle))

   'xcom e /c .TEST_'translate( FunctionName)
   .autosave = 0
   insertline ''
   insertline TestcaseTitle
   insertline Separator
   insertline ''

   rc = SavedRc
   return

compile endif
/* --------------------------------- */

defproc MakeRexxString( AsciiZString)
   p = pos( \0, AsciiZString)
   if p then
      RexxString = leftstr( AsciiZString, p - 1)
   else
      RexxString = AsciiZString
   endif
   return RexxString

/* ------------------------------------------------------------- */
/*   Include functions                                           */
/* ------------------------------------------------------------- */

include 'activatehighlight.e'
include 'alarm.e'
include 'closeconfig.e'
include 'deleteconfigtree.e'
include 'deleteconfigvalue.e'
include 'deletefile.e'
include 'deletetree.e'
include 'deleterexxea.e'
include 'deletestringea.e'
include 'direxists.e'
include 'errormsgbox.e'
include 'fileexists.e'
include 'getnextclose.e'
include 'getnextconfigkey.e'
include 'getnextprofileapp.e'
include 'getnextprofilekey.e'
include 'getnextdir.e'
include 'getnextfile.e'
include 'gettextmessage.e'
include 'info.e'
include 'importuserconfig.e'
include 'initconfig.e'
include 'libversion.e'
include 'md5.e'
include 'openconfig.e'
include 'pmprintf.e'
include 'queryconfigvalue.e'
include 'queryfullname.e'
include 'queryinstvalue.e'
include 'querymodelist.e'
include 'querypathinfo.e'
include 'queryprocessinfo.e'
include 'querystringea.e'
include 'querysysinfo.e'
include 'querywindowpos.e'
include 'readfilepart.e'
include 'saveold.e'
include 'scanenv.e'
include 'searchpath.e'
include 'searchtree.e'
include 'setframewindowpos.e'
include 'writeconfigvalue.e'
include 'writestringea.e'